suricata
util-streaming-buffer.h
Go to the documentation of this file.
1 /* Copyright (C) 2015-2016 Open Information Security Foundation
2  *
3  * You can copy, redistribute or modify this Program under the terms of
4  * the GNU General Public License version 2 as published by the Free
5  * Software Foundation.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * version 2 along with this program; if not, write to the Free Software
14  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
15  * 02110-1301, USA.
16  */
17 
18 /*
19  * This API is meant to be used with streaming data. A single memory
20  * block is used to store the data. StreamingBufferSegment points to
21  * chunk of data in the single StreamingBuffer. It points by offset
22  * and length, so no pointers. The buffer is resized on demand and
23  * slides forward, either automatically or manually.
24  *
25  * When a segment needs it's data it uses StreamingBufferSegmentGetData
26  * which takes care of checking if the segment still has a valid offset
27  * and length.
28  *
29  * The StreamingBuffer::stream_offset is an absolute offset since the
30  * start of the data streaming.
31  *
32  * Similarly, StreamingBufferSegment::stream_offset is also an absolute
33  * offset.
34  *
35  * Using the segments is optional.
36  *
37  *
38  * stream_offset buf_offset stream_offset + buf_size
39  * ^ ^ ^
40  * | | |
41  * | | |
42  * +--------------------------------------------+
43  * | data | empty |
44  * | xxxxxxxxxx | |
45  * +------^--------^--------+-------------------+
46  * | |
47  * | |
48  * | |
49  * | |
50  * | |
51  * +------+--------+-------+
52  * | StreamingBufferSegment|
53  * +-----------+-----------+
54  * | offset | len |
55  * +-----------+-----------+
56  */
57 
58 
59 #ifndef __UTIL_STREAMING_BUFFER_H__
60 #define __UTIL_STREAMING_BUFFER_H__
61 
62 #include "tree.h"
63 
64 #define STREAMING_BUFFER_NOFLAGS 0
65 #define STREAMING_BUFFER_AUTOSLIDE (1<<0)
66 
67 typedef struct StreamingBufferConfig_ {
68  uint32_t flags;
69  uint32_t buf_slide;
70  uint32_t buf_size;
71  void *(*Malloc)(size_t size);
72  void *(*Calloc)(size_t n, size_t size);
73  void *(*Realloc)(void *ptr, size_t orig_size, size_t size);
74  void (*Free)(void *ptr, size_t size);
76 
77 #define STREAMING_BUFFER_CONFIG_INITIALIZER { 0, 0, 0, NULL, NULL, NULL, NULL, }
78 
79 /**
80  * \brief block of continues data
81  */
82 typedef struct StreamingBufferBlock {
83  uint64_t offset;
85  uint32_t len;
86 } __attribute__((__packed__)) StreamingBufferBlock;
87 
88 int SBBCompare(struct StreamingBufferBlock *a, struct StreamingBufferBlock *b);
89 
90 /* red-black tree prototype for SACK records */
94 
95 typedef struct StreamingBuffer_ {
97  uint64_t stream_offset; /**< offset of the start of the memory block */
98 
99  uint8_t *buf; /**< memory block for reassembly */
100  uint32_t buf_size; /**< size of memory block */
101  uint32_t buf_offset; /**< how far we are in buf_size */
102 
103  struct SBB sbb_tree; /**< red black tree of Stream Buffer Blocks */
104  StreamingBufferBlock *head; /**< head, should always be the same as RB_MIN */
105 #ifdef DEBUG
106  uint32_t buf_size_max;
107 #endif
109 
110 #ifndef DEBUG
111 #define STREAMING_BUFFER_INITIALIZER(cfg) { (cfg), 0, NULL, 0, 0, { NULL }, NULL, };
112 #else
113 #define STREAMING_BUFFER_INITIALIZER(cfg) { (cfg), 0, NULL, 0, 0, { NULL }, NULL, 0 };
114 #endif
115 
116 typedef struct StreamingBufferSegment_ {
117  uint32_t segment_len;
118  uint64_t stream_offset;
119 } __attribute__((__packed__)) StreamingBufferSegment;
120 
124 
125 void StreamingBufferSlide(StreamingBuffer *sb, uint32_t slide);
127 
128 StreamingBufferSegment *StreamingBufferAppendRaw(StreamingBuffer *sb,
129  const uint8_t *data, uint32_t data_len) __attribute__((warn_unused_result));
130 int StreamingBufferAppend(StreamingBuffer *sb, StreamingBufferSegment *seg,
131  const uint8_t *data, uint32_t data_len) __attribute__((warn_unused_result));
133  const uint8_t *data, uint32_t data_len) __attribute__((warn_unused_result));
134 int StreamingBufferInsertAt(StreamingBuffer *sb, StreamingBufferSegment *seg,
135  const uint8_t *data, uint32_t data_len,
136  uint64_t offset) __attribute__((warn_unused_result));
137 
139  const StreamingBufferSegment *seg,
140  const uint8_t **data, uint32_t *data_len);
141 
143  const StreamingBufferBlock *sbb,
144  const uint8_t **data, uint32_t *data_len);
145 
147  const StreamingBufferBlock *sbb,
148  const uint8_t **data, uint32_t *data_len,
149  uint64_t offset);
150 
152  const StreamingBufferSegment *seg,
153  const uint8_t *rawdata, uint32_t rawdata_len);
155  const uint8_t *rawdata, uint32_t rawdata_len);
156 
158  const uint8_t **data, uint32_t *data_len,
159  uint64_t *stream_offset);
160 
162  const uint8_t **data, uint32_t *data_len,
163  uint64_t offset);
164 
166  const StreamingBufferSegment *seg);
167 
169 
170 #endif /* __UTIL_STREAMING_BUFFER_H__ */
StreamingBufferSegmentIsBeforeWindow
int StreamingBufferSegmentIsBeforeWindow(const StreamingBuffer *sb, const StreamingBufferSegment *seg)
Definition: util-streaming-buffer.c:731
RB_PROTOTYPE
RB_PROTOTYPE(SBB, StreamingBufferBlock, rb, SBBCompare)
SBB_RB_FIND_INCLUSIVE
StreamingBufferBlock * SBB_RB_FIND_INCLUSIVE(struct SBB *head, StreamingBufferBlock *elm)
Definition: util-streaming-buffer.c:79
SBBCompare
int SBBCompare(struct StreamingBufferBlock *a, struct StreamingBufferBlock *b)
Definition: util-streaming-buffer.c:47
StreamingBuffer_::stream_offset
uint64_t stream_offset
Definition: util-streaming-buffer.h:97
StreamingBuffer_::buf_offset
uint32_t buf_offset
Definition: util-streaming-buffer.h:101
StreamingBufferConfig_::buf_size
uint32_t buf_size
Definition: util-streaming-buffer.h:70
offset
uint64_t offset
Definition: util-streaming-buffer.h:2
StreamingBufferFree
void StreamingBufferFree(StreamingBuffer *sb)
Definition: util-streaming-buffer.c:145
StreamingBuffer_::head
StreamingBufferBlock * head
Definition: util-streaming-buffer.h:104
StreamingBufferSegment_::stream_offset
uint64_t stream_offset
Definition: util-streaming-buffer.h:118
StreamingBuffer_::buf
uint8_t * buf
Definition: util-streaming-buffer.h:99
StreamingBufferAppend
int StreamingBufferAppend(StreamingBuffer *sb, StreamingBufferSegment *seg, const uint8_t *data, uint32_t data_len) __attribute__((warn_unused_result))
Definition: util-streaming-buffer.c:576
StreamingBuffer_::buf_size
uint32_t buf_size
Definition: util-streaming-buffer.h:100
StreamingBufferConfig_::flags
uint32_t flags
Definition: util-streaming-buffer.h:68
StreamingBufferSegment_
Definition: util-streaming-buffer.h:116
stream_offset
uint64_t stream_offset
Definition: util-streaming-buffer.h:95
StreamingBufferGetDataAtOffset
int StreamingBufferGetDataAtOffset(const StreamingBuffer *sb, const uint8_t **data, uint32_t *data_len, uint64_t offset)
Definition: util-streaming-buffer.c:866
__attribute__
struct StreamingBufferBlock __attribute__((__packed__)) StreamingBufferBlock
block of continues data
Definition: decode-vlan.c:162
StreamingBufferInit
StreamingBuffer * StreamingBufferInit(const StreamingBufferConfig *cfg)
Definition: util-streaming-buffer.c:112
StreamingBufferSBBGetData
void StreamingBufferSBBGetData(const StreamingBuffer *sb, const StreamingBufferBlock *sbb, const uint8_t **data, uint32_t *data_len)
get the data for one SBB
Definition: util-streaming-buffer.c:743
StreamingBufferAppendRaw
StreamingBufferSegment * StreamingBufferAppendRaw(StreamingBuffer *sb, const uint8_t *data, uint32_t data_len) __attribute__((warn_unused_result))
Definition: util-streaming-buffer.c:535
StreamingBufferSBBGetDataAtOffset
void StreamingBufferSBBGetDataAtOffset(const StreamingBuffer *sb, const StreamingBufferBlock *sbb, const uint8_t **data, uint32_t *data_len, uint64_t offset)
get the data for one SBB
Definition: util-streaming-buffer.c:769
StreamingBufferRegisterTests
void StreamingBufferRegisterTests(void)
Definition: util-streaming-buffer.c:1477
StreamingBufferAppendNoTrack
int StreamingBufferAppendNoTrack(StreamingBuffer *sb, const uint8_t *data, uint32_t data_len) __attribute__((warn_unused_result))
add data w/o tracking a segment
Definition: util-streaming-buffer.c:619
StreamingBufferSegmentCompareRawData
int StreamingBufferSegmentCompareRawData(const StreamingBuffer *sb, const StreamingBufferSegment *seg, const uint8_t *rawdata, uint32_t rawdata_len)
Definition: util-streaming-buffer.c:833
tree.h
StreamingBuffer_::sbb_tree
struct SBB sbb_tree
Definition: util-streaming-buffer.h:103
StreamingBufferSlideToOffset
void StreamingBufferSlideToOffset(StreamingBuffer *sb, uint64_t offset)
slide to absolute offset
Definition: util-streaming-buffer.c:507
StreamingBuffer_
Definition: util-streaming-buffer.h:95
StreamingBufferBlock::RB_ENTRY
RB_ENTRY(StreamingBufferBlock) rb
StreamingBuffer
struct StreamingBuffer_ StreamingBuffer
StreamingBuffer_::cfg
const StreamingBufferConfig * cfg
Definition: util-streaming-buffer.h:96
StreamingBufferGetData
int StreamingBufferGetData(const StreamingBuffer *sb, const uint8_t **data, uint32_t *data_len, uint64_t *stream_offset)
Definition: util-streaming-buffer.c:849
StreamingBufferInsertAt
int StreamingBufferInsertAt(StreamingBuffer *sb, StreamingBufferSegment *seg, const uint8_t *data, uint32_t data_len, uint64_t offset) __attribute__((warn_unused_result))
Definition: util-streaming-buffer.c:661
StreamingBufferConfig
struct StreamingBufferConfig_ StreamingBufferConfig
RB_HEAD
RB_HEAD(SBB, StreamingBufferBlock)
StreamingBufferConfig_
Definition: util-streaming-buffer.h:67
StreamingBufferCompareRawData
int StreamingBufferCompareRawData(const StreamingBuffer *sb, const uint8_t *rawdata, uint32_t rawdata_len)
Definition: util-streaming-buffer.c:889
head
Flow * head
Definition: flow-hash.h:2
StreamingBufferConfig_::Free
void(* Free)(void *ptr, size_t size)
Definition: util-streaming-buffer.h:74
StreamingBufferSlide
void StreamingBufferSlide(StreamingBuffer *sb, uint32_t slide)
Definition: util-streaming-buffer.c:522
StreamingBufferSegmentGetData
void StreamingBufferSegmentGetData(const StreamingBuffer *sb, const StreamingBufferSegment *seg, const uint8_t **data, uint32_t *data_len)
Definition: util-streaming-buffer.c:802
StreamingBufferSegment_::segment_len
uint32_t segment_len
Definition: util-streaming-buffer.h:117
StreamingBufferBlock::len
uint32_t len
Definition: util-streaming-buffer.h:85
StreamingBufferBlock::offset
uint64_t offset
Definition: util-streaming-buffer.h:83
StreamingBufferClear
void StreamingBufferClear(StreamingBuffer *sb)
Definition: util-streaming-buffer.c:132
StreamingBufferBlock
block of continues data
Definition: util-streaming-buffer.h:82
StreamingBufferConfig_::buf_slide
uint32_t buf_slide
Definition: util-streaming-buffer.h:69