/* Serval Daemon Copyright (C) 2012 Serval Project Inc. This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ #ifndef __SERVAL_DNA___OVERLAY_BUFFER_H #define __SERVAL_DNA___OVERLAY_BUFFER_H #include <sys/types.h> // for size_t #include <stdint.h> #include "whence.h" struct overlay_buffer { unsigned char *bytes; // remembered position for rewinding size_t checkpointLength; // position of data read / written size_t position; // maximum allowed bytes for reading / writing size_t sizeLimit; // size of buffer size_t allocSize; // is this an allocated buffer? can it be resized? Should it be freed? unsigned char * allocated; }; struct overlay_buffer *_ob_new(struct __sourceloc __whence); struct overlay_buffer *_ob_static(struct __sourceloc __whence, unsigned char *bytes, size_t size); struct overlay_buffer *_ob_slice(struct __sourceloc __whence, struct overlay_buffer *b, size_t offset, size_t length); struct overlay_buffer *_ob_dup(struct __sourceloc __whence, struct overlay_buffer *b); void _ob_free(struct __sourceloc __whence, struct overlay_buffer *b); int _ob_checkpoint(struct __sourceloc __whence, struct overlay_buffer *b); int _ob_rewind(struct __sourceloc __whence, struct overlay_buffer *b); void _ob_limitsize(struct __sourceloc __whence, struct overlay_buffer *b, size_t bytes); void _ob_flip(struct __sourceloc __whence, struct overlay_buffer *b); void _ob_clear(struct __sourceloc __whence, struct overlay_buffer *b); void _ob_unlimitsize(struct __sourceloc __whence, struct overlay_buffer *b); ssize_t _ob_makespace(struct __sourceloc whence, struct overlay_buffer *b, size_t bytes); void _ob_set(struct __sourceloc __whence, struct overlay_buffer *b, size_t ofs, unsigned char byte); void _ob_set_ui16(struct __sourceloc __whence, struct overlay_buffer *b, size_t offset, uint16_t v); void _ob_append_byte(struct __sourceloc whence, struct overlay_buffer *b,unsigned char byte); void _ob_append_bytes(struct __sourceloc whence, struct overlay_buffer *b,const unsigned char *bytes, size_t count); unsigned char *_ob_append_space(struct __sourceloc whence, struct overlay_buffer *b, size_t count); void _ob_append_ui16(struct __sourceloc whence, struct overlay_buffer *b, uint16_t v); void _ob_append_ui32(struct __sourceloc whence, struct overlay_buffer *b, uint32_t v); void _ob_append_ui64(struct __sourceloc whence, struct overlay_buffer *b, uint64_t v); void _ob_append_ui16_rv(struct __sourceloc whence, struct overlay_buffer *b, uint16_t v); void _ob_append_ui32_rv(struct __sourceloc whence, struct overlay_buffer *b, uint32_t v); void _ob_append_ui64_rv(struct __sourceloc whence, struct overlay_buffer *b, uint64_t v); void _ob_append_packed_ui32(struct __sourceloc whence, struct overlay_buffer *b, uint32_t v); void _ob_append_packed_ui64(struct __sourceloc whence, struct overlay_buffer *b, uint64_t v); void _ob_append_str(struct __sourceloc whence, struct overlay_buffer *b, const char *str); void _ob_append_strn(struct __sourceloc whence, struct overlay_buffer *b, const char *str, size_t max_len); #define ob_new() _ob_new(__WHENCE__) #define ob_static(bytes, size) _ob_static(__WHENCE__, bytes, size) #define ob_slice(b, off, len) _ob_slice(__WHENCE__, b, off, len) #define ob_dup(b) _ob_dup(__WHENCE__, b) #define ob_free(b) _ob_free(__WHENCE__, b) #define ob_checkpoint(b) _ob_checkpoint(__WHENCE__, b) #define ob_rewind(b) _ob_rewind(__WHENCE__, b) #define ob_limitsize(b, size) _ob_limitsize(__WHENCE__, b, size) #define ob_flip(b) _ob_flip(__WHENCE__, b) #define ob_clear(b) _ob_clear(__WHENCE__, b) #define ob_unlimitsize(b) _ob_unlimitsize(__WHENCE__, b) #define ob_makespace(b, bytes) _ob_makespace(__WHENCE__, b, bytes) #define ob_set(b, off, byte) _ob_set(__WHENCE__, b, off, byte) #define ob_set_ui16(b, off, v) _ob_set_ui16(__WHENCE__, b, off, v) #define ob_append_byte(b, byte) _ob_append_byte(__WHENCE__, b, byte) #define ob_append_bytes(b, bytes, count) _ob_append_bytes(__WHENCE__, b, bytes, count) #define ob_append_space(b, count) _ob_append_space(__WHENCE__, b, count) #define ob_append_ui16(b, v) _ob_append_ui16(__WHENCE__, b, v) #define ob_append_ui32(b, v) _ob_append_ui32(__WHENCE__, b, v) #define ob_append_ui64(b, v) _ob_append_ui64(__WHENCE__, b, v) #define ob_append_ui16_rv(b, v) _ob_append_ui16_rv(__WHENCE__, b, v) #define ob_append_ui32_rv(b, v) _ob_append_ui32_rv(__WHENCE__, b, v) #define ob_append_ui64_rv(b, v) _ob_append_ui64_rv(__WHENCE__, b, v) #define ob_append_packed_ui32(b, v) _ob_append_packed_ui32(__WHENCE__, b, v) #define ob_append_packed_ui64(b, v) _ob_append_packed_ui64(__WHENCE__, b, v) #define ob_append_str(b, s) _ob_append_str(__WHENCE__, b, s) #define ob_append_strn(b, s, count) _ob_append_strn(__WHENCE__, b, s, count) // get one byte, -ve number indicates failure int ob_peek(struct overlay_buffer *b); void ob_skip(struct overlay_buffer *b, unsigned n); // get one byte from the current position, -ve number indicates failure int ob_get(struct overlay_buffer *b); int ob_get_bytes(struct overlay_buffer *b, unsigned char *buff, size_t len); unsigned char * ob_get_bytes_ptr(struct overlay_buffer *b, size_t len); const char *ob_get_str_ptr(struct overlay_buffer *b); uint64_t ob_get_ui64(struct overlay_buffer *b); uint32_t ob_get_ui32(struct overlay_buffer *b); uint16_t ob_get_ui16(struct overlay_buffer *b); uint64_t ob_get_ui64_rv(struct overlay_buffer *b); uint32_t ob_get_ui32_rv(struct overlay_buffer *b); uint16_t ob_get_ui16_rv(struct overlay_buffer *b); int ob_dump(struct overlay_buffer *b,char *desc); uint32_t ob_get_packed_ui32(struct overlay_buffer *b); uint64_t ob_get_packed_ui64(struct overlay_buffer *b); // information routines size_t ob_position(struct overlay_buffer *b); size_t ob_limit(struct overlay_buffer *b); size_t ob_remaining(struct overlay_buffer *b); size_t ob_mark(struct overlay_buffer *b); int _ob_overrun(struct __sourceloc, struct overlay_buffer *b); // get the raw pointer of the whole buffer unsigned char* ob_ptr(struct overlay_buffer *b); // get the raw pointer of the current position unsigned char* ob_current_ptr(struct overlay_buffer *b); #define ob_overrun(b) _ob_overrun(__WHENCE__, b) #endif //__SERVAL_DNA___OVERLAY_BUFFER_H