28 #define DUMP_REGIONS 0 // set to 1 to dump a visual representation of the regions list and sbb tree.
38 static void *ReallocFunc(
void *ptr,
const size_t size)
47 static void *CallocFunc(
const size_t nm,
const size_t sz)
59 #define CALLOC(cfg, n, s) (cfg)->Calloc ? (cfg)->Calloc((n), (s)) : CallocFunc((n), (s))
60 #define REALLOC(cfg, ptr, orig_s, s) \
61 (cfg)->Realloc ? (cfg)->Realloc((ptr), (orig_s), (s)) : ReallocFunc((ptr), (s))
62 #define FREE(cfg, ptr, s) \
63 (cfg)->Free ? (cfg)->Free((ptr), (s)) : SCFree((ptr))
90 const uint64_t lre = lookup->
offset + lookup->
len;
91 const uint64_t tre = intree->
offset + intree->
len;
94 else if (lookup->
offset < tre && lre <= tre)
108 const int comp = InclusiveCompare(elm, tmp);
113 }
else if (comp > 0) {
130 const uint64_t reg_o =
140 if (re >= reg_o && re <= reg_re) {
141 SCLogDebug(
"r %p is in-scope: %" PRIu64
" >= %" PRIu64
" && %" PRIu64
" <= %" PRIu64, r, re,
157 SCLogDebug(
"looking for first region matching %" PRIu64
"/%" PRIu64,
offset, data_re);
160 for (; r != NULL; r = r->
next) {
161 if (RegionsIntersect(cfg, r,
offset, data_re) ==
true) {
176 SCLogDebug(
"starting at %p/%" PRIu64
", offset %" PRIu64
", data_re %" PRIu64, r,
179 for (; r != NULL; r = r->
next) {
182 SCLogDebug(
"checking: %p/%" PRIu64
"/%" PRIu64
", offset %" PRIu64
"/%" PRIu64, r,
185 if (!RegionsIntersect(cfg, r,
offset, data_re))
202 for (; r != NULL; r = r->
next) {
203 if (!RegionsIntersect(cfg, r,
offset, data_re)) {
229 if (aux_r->
buf == NULL) {
230 FREE(cfg, aux_r,
sizeof(*aux_r));
263 int r = InitBuffer(sb, cfg);
287 FREE(cfg, r,
sizeof(*r));
337 (void)SBB_RB_INSERT(&sb->
sbb_tree, sbb);
346 sbb2->
len = data_len;
352 if (SBB_RB_INSERT(&sb->
sbb_tree, sbb2) != NULL) {
353 FREE(cfg, sbb2,
sizeof(*sbb2));
381 (void)SBB_RB_INSERT(&sb->
sbb_tree, sbb);
399 const uint64_t tr_re = tr->
offset + tr->
len;
420 SCLogDebug(
"-> (fwd) tr %p %" PRIu64
"/%u REMOVED ECLIPSED (sa overlapped by tr)", tr,
422 SBB_RB_REMOVE(tree, tr);
432 }
else if (sa->
offset <= tr->
offset && sa_re >= tr_re) {
433 SCLogDebug(
"-> (fwd) tr %p %" PRIu64
"/%u REMOVED ECLIPSED (tr overlapped by sa)", tr,
435 SBB_RB_REMOVE(tree, tr);
439 SCLogDebug(
"-> (fwd) tr %p %" PRIu64
"/%u region %p so %" PRIu64
" bo %u sz %u", sa,
446 SCLogDebug(
"-> (fwd) tr %p %" PRIu64
"/%u region %p so %" PRIu64
447 " bo %u sz %u BUF_OFFSET UPDATED",
458 sa_re >= tr->
offset && sa_re < tr_re)
461 uint32_t combined_len = sa->
len + tr->
len;
465 SBB_RB_REMOVE(tree, tr);
469 SCLogDebug(
"-> (fwd) tr %p %" PRIu64
"/%u region %p so %" PRIu64
" bo %u sz %u", sa,
476 SCLogDebug(
"-> (fwd) tr %p %" PRIu64
"/%u region %p so %" PRIu64
477 " bo %u sz %u BUF_OFFSET UPDATED",
493 const uint64_t tr_re = tr->
offset + tr->
len;
512 SCLogDebug(
"-> (bwd) tr %p %" PRIu64
"/%u REMOVED ECLIPSED (sa overlapped by tr)", tr,
516 SBB_RB_REMOVE(tree, tr);
526 }
else if (sa->
offset <= tr->
offset && sa_re >= tr_re) {
527 SCLogDebug(
"-> (bwd) tr %p %" PRIu64
"/%u REMOVED ECLIPSED (tr overlapped by sa)", tr,
531 SBB_RB_REMOVE(tree, tr);
535 SCLogDebug(
"-> (bwd) tr %p %" PRIu64
"/%u region %p so %" PRIu64
" bo %u sz %u", sa,
543 SCLogDebug(
"-> (bwd) tr %p %" PRIu64
"/%u region %p so %" PRIu64
544 " bo %u sz %u BUF_OFFSET UPDATED",
557 uint32_t combined_len = sa->
len + tr->
len;
564 SBB_RB_REMOVE(tree, tr);
568 SCLogDebug(
"-> (bwd) tr %p %" PRIu64
"/%u region %p so %" PRIu64
" bo %u sz %u", sa,
575 SCLogDebug(
"-> (bwd) tr %p %" PRIu64
"/%u region %p so %" PRIu64
576 " bo %u sz %u BUF_OFFSET UPDATED",
603 SCLogDebug(
"* insert failed: exact match in tree with %p %" PRIu64
"/%u", res, res->
offset,
611 if (SBB_RB_PREV(sbb) == NULL) {
614 ConsolidateBackward(sb, cfg, region, tree, sbb);
616 ConsolidateFwd(sb, cfg, region, tree, sbb);
662 if (sbb->
len >= shrink_by) {
663 sbb->
len -= shrink_by;
690 static inline uint32_t ToNextMultipleOf(
const uint32_t in,
const uint32_t
m)
694 const uint32_t x = in %
m;
702 static thread_local
bool g2s_warn_once =
false;
709 if (!g2s_warn_once) {
710 SCLogWarning(
"StreamingBuffer::GrowRegionToSize() tried to alloc %u bytes, exceeds "
713 g2s_warn_once =
true;
719 const uint32_t grow = ToNextMultipleOf(size, cfg->
buf_size);
728 size_t diff = grow - region->
buf_size;
729 void *new_mem = ((
char *)ptr) + region->
buf_size;
730 memset(new_mem, 0, diff);
736 if (region->
buf_size > sb->buf_size_max) {
737 sb->buf_size_max = region->
buf_size;
746 return GrowRegionToSize(sb, cfg, &sb->
region, size);
786 static inline void StreamingBufferSlideToOffsetWithRegions(
792 SCLogDebug(
"slide_offset %" PRIu64, slide_offset);
797 const bool main_is_oow = RegionBeforeOffset(&sb->
region, slide_offset);
818 if (RegionBeforeOffset(r, slide_offset)) {
825 FREE(cfg, r,
sizeof(*r));
828 }
else if (RegionContainsOffset(r, slide_offset)) {
847 if (to_shift && to_shift != &sb->
region) {
859 FREE(cfg, to_shift,
sizeof(*to_shift));
867 SCLogDebug(
"shift start region %p", to_shift);
876 const uint32_t new_data_size = to_shift->
buf_size - s;
877 uint32_t new_mem_size = ToNextMultipleOf(new_data_size, cfg->
buf_size);
888 const uint64_t next_re =
next->stream_offset +
next->buf_size;
889 const uint32_t mem_size = ToNextMultipleOf(next_re - slide_offset, cfg->
buf_size);
893 SCLogDebug(
"replace main with the next bigger region");
895 const uint32_t next_data_offset =
next->stream_offset - slide_offset;
896 const uint32_t prev_buf_size =
next->buf_size;
897 const uint32_t start_data_offset = slide_offset - start->
stream_offset;
899 if (start_data_offset > start->
buf_size) {
900 new_mem_size = new_data_size;
904 if (GrowRegionToSize(sb, cfg,
next, mem_size) != 0) {
905 new_mem_size = new_data_size;
914 memmove(
next->buf + next_data_offset,
next->buf, prev_buf_size);
921 const uint32_t start_data_size = start->
buf_size - start_data_offset;
922 memcpy(
next->buf, start->
buf + start_data_offset, start_data_size);
940 if (GrowRegionToSize(sb, cfg, start, mem_size) != 0) {
941 new_mem_size = new_data_size;
944 SCLogDebug(
"start->buf now size %u", mem_size);
949 SCLogDebug(
"s %u new_data_size %u", s, new_data_size);
950 memmove(start->
buf, start->
buf + s, new_data_size);
956 SCLogDebug(
"copy next->buf %p/%u to start->buf offset %u",
next->buf,
957 next->buf_size, new_data_size);
958 memcpy(start->
buf + new_data_size,
next->buf,
next->buf_size);
973 SCLogDebug(
"s %u new_data_size %u", s, new_data_size);
974 memmove(to_shift->
buf, to_shift->
buf + s, new_data_size);
982 if (s < to_shift->buf_offset)
1010 StreamingBufferSlideToOffsetWithRegions(sb, cfg,
offset);
1028 if (sb->
head != NULL) {
1032 SCLogDebug(
"sliding %u forward, size of original buffer left after slide %u", slide,
1048 SCLogDebug(
"sliding %u forward, size of original buffer left after slide %u", slide,
1067 #define DATA_FITS(sb, len) ((sb)->region.buf_offset + (len) <= (sb)->region.buf_size)
1070 StreamingBufferSegment *seg,
const uint8_t *data, uint32_t data_len)
1075 if (InitBuffer(sb, cfg) == -1)
1081 if (GrowToSize(sb, cfg, data_len) !=
SC_OK)
1092 seg->segment_len = data_len;
1097 return SBBUpdate(sb, cfg, &sb->
region, rel_offset, data_len);
1107 const uint8_t *data, uint32_t data_len)
1110 if (InitBuffer(sb, cfg) == -1)
1116 if (GrowToSize(sb, cfg, data_len) !=
SC_OK)
1130 return SBBUpdate(sb, cfg, &sb->
region, rel_offset, data_len);
1136 #define DATA_FITS_AT_OFFSET(region, len, offset) ((offset) + (len) <= (region)->buf_size)
1138 #if defined(DEBUG) || defined(DEBUG_VALIDATION)
1171 #if defined(DEBUG) && DUMP_REGIONS == 1
1177 snprintf(gap,
sizeof(gap),
"[ gap:%" PRIu64
" ]",
1181 printf(
"[ %s offset:%" PRIu64
" size:%u offset:%u ]%s", r == &sb->
region ?
"main" :
"aux",
1185 bool at_least_one =
false;
1190 if (last_re != sbb->
offset) {
1191 printf(
"[ gap:%" PRIu64
" ]", sbb->
offset - last_re);
1193 printf(
"[ sbb offset:%" PRIu64
" len:%u ]", sbb->
offset, sbb->
len);
1194 at_least_one =
true;
1200 #if defined(DEBUG) || defined(DEBUG_VALIDATION)
1204 const uint8_t *_data = NULL;
1205 uint32_t _data_len = 0;
1220 uint32_t dst_buf_size)
1224 const uint64_t data_re = data_offset + data_len;
1225 SCLogDebug(
"sb %p dst %p src_start %p src_end %p data_offset %" PRIu64
1226 "/data_len %u/data_re %" PRIu64,
1227 sb,
dst, src_start, src_end, data_offset, data_len, data_re);
1233 const uint32_t dst_size = dst_buf_size;
1237 const uint32_t old_size =
dst->buf_size;
1238 const uint32_t dst_copy_offset =
dst->stream_offset - dst_offset;
1240 const uint32_t old_offset =
dst->buf_offset;
1241 SCLogDebug(
"old_size %u, old_offset %u, dst_copy_offset %u", old_size, old_offset,
1244 if ((retval = GrowRegionToSize(sb, cfg,
dst, dst_size)) !=
SC_OK) {
1251 if (dst_copy_offset != 0)
1252 memmove(
dst->buf + dst_copy_offset,
dst->buf, old_size);
1253 if (dst_offset !=
dst->stream_offset) {
1254 dst->stream_offset = dst_offset;
1256 dst->buf_offset = 0;
1261 new_offset += data_len;
1264 bool start_is_main =
false;
1265 if (src_start == &sb->
region) {
1268 start_is_main =
true;
1270 if (src_start !=
dst)
1272 if (src_start == src_end) {
1273 SCLogDebug(
"src_start == src_end == main, we're done");
1278 src_start = src_start->
next;
1288 SCLogDebug(
"skipping r %p as it is 'dst'", r);
1295 const uint32_t target_offset = r->
stream_offset - dst_offset;
1296 SCLogDebug(
"r %p: target_offset %u", r, target_offset);
1303 FREE(cfg, r,
sizeof(*r));
1323 if (start_is_main &&
dst != &sb->
region) {
1325 SCLogDebug(
"start_is_main && dst != main region");
1340 SCLogDebug(
"returning dst %p stream_offset %" PRIu64
" buf_offset %u buf_size %u",
dst,
1341 dst->stream_offset,
dst->buf_offset,
dst->buf_size);
1352 FindFirstRegionForOffset(sb, cfg, &sb->
region,
offset,
len, &start_prev);
1354 const uint64_t insert_re =
offset +
len;
1356 uint64_t insert_adjusted_re = insert_re;
1374 uint32_t new_buf_size =
1375 ToNextMultipleOf(insert_adjusted_re - insert_start_offset, cfg->
buf_size);
1385 ToNextMultipleOf(insert_adjusted_re - insert_start_offset, cfg->
buf_size);
1392 sb, cfg, big, start, end,
offset,
len, start_prev, new_buf_size);
1405 SCLogDebug(
"no matching region found, append to %p (%s)", append,
1406 append == &sb->
region ?
"main" :
"aux");
1430 const uint64_t data_offset)
1432 SCLogDebug(
"data_offset %" PRIu64
", data_len %u, re %" PRIu64, data_offset, data_len,
1433 data_offset + data_len);
1436 if (RegionsIntersect(cfg, &sb->
region, data_offset, data_offset + data_len)) {
1437 SCLogDebug(
"data_offset %" PRIu64
", data_len %u intersects with main region (next %p)",
1440 !RegionsIntersect(cfg, sb->
region.
next, data_offset, data_offset + data_len)) {
1442 "data_offset %" PRIu64
1443 ", data_len %u intersects with main region, no next or way before next region",
1444 data_offset, data_len);
1447 if ((r = InitBuffer(sb, cfg)) !=
SC_OK) {
1461 SCLogDebug(
"created new region %p with offset %" PRIu64
", size %u", aux_r,
1478 StreamingBufferSegment *seg,
const uint8_t *data, uint32_t data_len, uint64_t
offset)
1489 if (region == NULL) {
1493 const bool region_is_main = region == &sb->
region;
1495 SCLogDebug(
"inserting %" PRIu64
"/%u using %s region %p",
offset, data_len,
1496 region == &sb->
region ?
"main" :
"aux", region);
1500 if ((r = GrowToSize(sb, cfg, (rel_offset + data_len))) !=
SC_OK)
1505 SCLogDebug(
"offset %" PRIu64
" data_len %u, rel_offset %u into region offset %" PRIu64
1506 ", buf_offset %u, buf_size %u",
1509 memcpy(region->
buf + rel_offset, data, data_len);
1510 seg->stream_offset =
offset;
1511 seg->segment_len = data_len;
1513 SCLogDebug(
"rel_offset %u region->stream_offset %" PRIu64
", buf_offset %u", rel_offset,
1519 if (region_is_main) {
1521 SCLogDebug(
"empty sbb list: block exactly what was expected, fall through");
1527 SCLogDebug(
"empty sbb list: block is within existing main data region");
1534 }
else if (rel_offset < sb->region.
buf_offset) {
1537 SCLogDebug(
"before expected offset: %u < sb->region.buf_offset %u", rel_offset,
1540 SCLogDebug(
"before expected offset, ends after: %u < sb->region.buf_offset "
1548 SCLogDebug(
"beyond expected offset: SBBInit");
1550 if ((r = SBBInit(sb, cfg, region, rel_offset, data_len)) !=
SC_OK)
1554 SCLogDebug(
"empty sbb list: invoking SBBInitLeadingGap");
1555 if ((r = SBBInitLeadingGap(sb, cfg, region,
offset, data_len)) !=
SC_OK)
1562 SCLogDebug(
"empty sbb list, no data in main: use SBBInit");
1563 if ((r = SBBInit(sb, cfg, region, rel_offset, data_len)) !=
SC_OK)
1567 SCLogDebug(
"empty sbb list: invoking SBBInitLeadingGap");
1568 if ((r = SBBInitLeadingGap(sb, cfg, region,
offset, data_len)) !=
SC_OK)
1580 if ((r = SBBUpdate(sb, cfg, region, rel_offset, data_len)) !=
SC_OK)
1594 const StreamingBufferSegment *seg)
1617 if (
offset >= r->stream_offset &&
offset < (r->stream_offset + r->buf_size)) {
1627 const uint8_t **data, uint32_t *data_len)
1630 SCLogDebug(
"first find our region (offset %" PRIu64
") -> %p", sbb->
offset, region);
1643 *data_len = sbb->
len;
1648 if (offset < sbb->
len) {
1649 *data = region->
buf;
1664 const uint8_t **data, uint32_t *data_len,
1681 *data = region->
buf + data_offset;
1682 if (data_offset + sbblen > region->
buf_size)
1683 *data_len = region->
buf_size - data_offset;
1690 if (data_offset < sbblen) {
1691 *data = region->
buf;
1692 *data_len = sbblen - data_offset;
1705 const StreamingBufferSegment *seg,
1706 const uint8_t **data, uint32_t *data_len)
1716 *data_len = seg->segment_len;
1722 *data = region->
buf;
1723 *data_len = seg->segment_len -
offset;
1739 const StreamingBufferSegment *seg,
1740 const uint8_t *rawdata, uint32_t rawdata_len)
1742 const uint8_t *segdata = NULL;
1743 uint32_t segdata_len = 0;
1745 if (segdata && segdata_len &&
1746 segdata_len == rawdata_len &&
1747 memcmp(segdata, rawdata, segdata_len) == 0)
1755 const uint8_t **data, uint32_t *data_len,
1758 if (sb != NULL && sb->
region.
buf != NULL) {
1772 const uint8_t **data, uint32_t *data_len,
1779 *data = region->
buf + skip;
1794 const uint8_t *rawdata, uint32_t rawdata_len)
1796 const uint8_t *sbdata = NULL;
1797 uint32_t sbdata_len = 0;
1801 sbdata && sbdata_len &&
1802 sbdata_len == rawdata_len &&
1803 memcmp(sbdata, rawdata, sbdata_len) == 0)
1810 printf(
"wanted:\n");
1821 static void DumpSegment(
StreamingBuffer *sb, StreamingBufferSegment *seg)
1823 const uint8_t *data = NULL;
1824 uint32_t data_len = 0;
1826 if (data && data_len) {
1831 static int StreamingBufferTest02(
void)
1837 StreamingBufferSegment seg1;
1839 StreamingBufferSegment seg2;
1843 FAIL_IF(seg1.stream_offset != 0);
1844 FAIL_IF(seg2.stream_offset != 8);
1848 DumpSegment(sb, &seg1);
1849 DumpSegment(sb, &seg2);
1857 StreamingBufferSegment seg3;
1861 FAIL_IF(seg3.stream_offset != 16);
1866 DumpSegment(sb, &seg1);
1867 DumpSegment(sb, &seg2);
1868 DumpSegment(sb, &seg3);
1877 DumpSegment(sb, &seg1);
1878 DumpSegment(sb, &seg2);
1879 DumpSegment(sb, &seg3);
1887 static int StreamingBufferTest03(
void)
1893 StreamingBufferSegment seg1;
1895 StreamingBufferSegment seg2;
1899 FAIL_IF(seg1.stream_offset != 0);
1900 FAIL_IF(seg2.stream_offset != 14);
1904 DumpSegment(sb, &seg1);
1905 DumpSegment(sb, &seg2);
1910 StreamingBufferSegment seg3;
1914 FAIL_IF(seg3.stream_offset != 8);
1919 DumpSegment(sb, &seg1);
1920 DumpSegment(sb, &seg2);
1921 DumpSegment(sb, &seg3);
1931 DumpSegment(sb, &seg1);
1932 DumpSegment(sb, &seg2);
1933 DumpSegment(sb, &seg3);
1942 static int StreamingBufferTest04(
void)
1948 StreamingBufferSegment seg1;
1951 StreamingBufferSegment seg2;
1955 FAIL_IF(seg1.stream_offset != 0);
1956 FAIL_IF(seg2.stream_offset != 14);
1971 DumpSegment(sb, &seg1);
1972 DumpSegment(sb, &seg2);
1975 StreamingBufferSegment seg3;
1979 FAIL_IF(seg3.stream_offset != 8);
1990 DumpSegment(sb, &seg1);
1991 DumpSegment(sb, &seg2);
1992 DumpSegment(sb, &seg3);
1998 StreamingBufferSegment seg4;
2003 FAIL_IF(seg4.stream_offset != 124);
2015 DumpSegment(sb, &seg1);
2016 DumpSegment(sb, &seg2);
2017 DumpSegment(sb, &seg3);
2018 DumpSegment(sb, &seg4);
2033 static int StreamingBufferTest06(
void)
2039 StreamingBufferSegment seg1;
2041 StreamingBufferSegment seg2;
2048 StreamingBufferSegment seg3;
2055 StreamingBufferSegment seg4;
2062 StreamingBufferSegment seg5;
2074 StreamingBufferSegment seg6;
2091 static int StreamingBufferTest07(
void)
2097 StreamingBufferSegment seg1;
2099 StreamingBufferSegment seg2;
2106 StreamingBufferSegment seg3;
2113 StreamingBufferSegment seg4;
2120 StreamingBufferSegment seg5;
2132 StreamingBufferSegment seg6;
2149 static int StreamingBufferTest08(
void)
2155 StreamingBufferSegment seg1;
2157 StreamingBufferSegment seg2;
2164 StreamingBufferSegment seg3;
2171 StreamingBufferSegment seg4;
2178 StreamingBufferSegment seg5;
2190 StreamingBufferSegment seg6;
2207 static int StreamingBufferTest09(
void)
2213 StreamingBufferSegment seg1;
2215 StreamingBufferSegment seg2;
2222 StreamingBufferSegment seg3;
2229 StreamingBufferSegment seg4;
2236 StreamingBufferSegment seg5;
2248 StreamingBufferSegment seg6;
2265 static int StreamingBufferTest10(
void)
2271 StreamingBufferSegment seg1;
2274 StreamingBufferSegment seg2;
2277 StreamingBufferSegment seg3;
2283 StreamingBufferSegment seg4;
2286 StreamingBufferSegment seg5;
2289 StreamingBufferSegment seg6;
2296 StreamingBufferSegment seg7;
2307 StreamingBufferSegment seg8;