Streaming Buffer API. More...

#include "suricata-common.h"
#include "util-streaming-buffer.h"
#include "util-unittest.h"
#include "util-print.h"
#include "util-validate.h"
#include "util-debug.h"
#include "util-error.h"

Include dependency graph for util-streaming-buffer.c:

Go to the source code of this file.

Macros
#define	DUMP_REGIONS 0

#define	CALLOC(cfg, n, s) (cfg)->Calloc ? (cfg)->Calloc((n), (s)) : CallocFunc((n), (s))

#define	REALLOC(cfg, ptr, orig_s, s) (cfg)->Realloc ? (cfg)->Realloc((ptr), (orig_s), (s)) : ReallocFunc((ptr), (s))

#define	FREE(cfg, ptr, s) (cfg)->Free ? (cfg)->Free((ptr), (s)) : SCFree((ptr))

Functions
	RB_GENERATE (SBB, StreamingBufferBlock, rb, SBBCompare)

int	SBBCompare (struct StreamingBufferBlock a, struct StreamingBufferBlock b)

StreamingBufferBlock *	SBB_RB_FIND_INCLUSIVE (struct SBB head, StreamingBufferBlock elm)

StreamingBuffer *	StreamingBufferInit (const StreamingBufferConfig *cfg)

void	StreamingBufferClear (StreamingBuffer sb, const StreamingBufferConfig cfg)

void	StreamingBufferFree (StreamingBuffer sb, const StreamingBufferConfig cfg)

void	StreamingBufferSlideToOffset (StreamingBuffer sb, const StreamingBufferConfig cfg, uint64_t offset)
	slide to absolute offset More...

int	StreamingBufferAppend (StreamingBuffer sb, const StreamingBufferConfig cfg, StreamingBufferSegment seg, const uint8_t data, uint32_t data_len)

int	StreamingBufferAppendNoTrack (StreamingBuffer sb, const StreamingBufferConfig cfg, const uint8_t *data, uint32_t data_len)
	add data w/o tracking a segment More...

int	StreamingBufferInsertAt (StreamingBuffer sb, const StreamingBufferConfig cfg, StreamingBufferSegment seg, const uint8_t data, uint32_t data_len, uint64_t offset)

int	StreamingBufferSegmentIsBeforeWindow (const StreamingBuffer sb, const StreamingBufferSegment seg)

void	StreamingBufferSBBGetData (const StreamingBuffer sb, const StreamingBufferBlock sbb, const uint8_t *data, uint32_t data_len)
	get the data for one SBB More...

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 More...

void	StreamingBufferSegmentGetData (const StreamingBuffer sb, const StreamingBufferSegment seg, const uint8_t *data, uint32_t data_len)

int	StreamingBufferSegmentCompareRawData (const StreamingBuffer sb, const StreamingBufferSegment seg, const uint8_t *rawdata, uint32_t rawdata_len)

int	StreamingBufferGetData (const StreamingBuffer sb, const uint8_t data, uint32_t data_len, uint64_t *stream_offset)

int	StreamingBufferGetDataAtOffset (const StreamingBuffer sb, const uint8_t data, uint32_t data_len, uint64_t offset)

int	StreamingBufferCompareRawData (const StreamingBuffer sb, const uint8_t rawdata, uint32_t rawdata_len)

void	StreamingBufferRegisterTests (void)

Detailed Description

Streaming Buffer API.

Author: Victor Julien victo.nosp@m.r@in.nosp@m.linia.nosp@m.c.ne.nosp@m.t

Definition in file util-streaming-buffer.c.

Macro Definition Documentation

◆ CALLOC

#define CALLOC	(	cfg,
		n,
		s
	)	(cfg)->Calloc ? (cfg)->Calloc((n), (s)) : CallocFunc((n), (s))

Definition at line 60 of file util-streaming-buffer.c.

◆ DUMP_REGIONS

#define DUMP_REGIONS 0

Definition at line 29 of file util-streaming-buffer.c.

◆ FREE

#define FREE	(	cfg,
		ptr,
		s
	)	(cfg)->Free ? (cfg)->Free((ptr), (s)) : SCFree((ptr))

Definition at line 63 of file util-streaming-buffer.c.

◆ REALLOC

#define REALLOC	(	cfg,
		ptr,
		orig_s,
		s
	)	(cfg)->Realloc ? (cfg)->Realloc((ptr), (orig_s), (s)) : ReallocFunc((ptr), (s))

Definition at line 61 of file util-streaming-buffer.c.

Function Documentation

◆ RB_GENERATE()

RB_GENERATE	(	SBB	,
		StreamingBufferBlock	,
		rb	,
		SBBCompare
	)

◆ SBB_RB_FIND_INCLUSIVE()

StreamingBufferBlock* SBB_RB_FIND_INCLUSIVE	(	struct SBB *	head,
		StreamingBufferBlock *	elm
	)

Definition at line 100 of file util-streaming-buffer.c.

References head, StreamingBufferBlock::len, StreamingBufferBlock::offset, RB_ROOT, and SCLogDebug.

◆ SBBCompare()

int SBBCompare	(	struct StreamingBufferBlock *	a,
		struct StreamingBufferBlock *	b
	)

Definition at line 69 of file util-streaming-buffer.c.

References StreamingBufferBlock::len, StreamingBufferBlock::offset, SCLogDebug, and SCReturnInt.

◆ StreamingBufferAppend()

int StreamingBufferAppend	(	StreamingBuffer *	sb,
		const StreamingBufferConfig *	cfg,
		StreamingBufferSegment *	seg,
		const uint8_t *	data,
		uint32_t	data_len
	)

Definition at line 1077 of file util-streaming-buffer.c.

References BIT_U32, StreamingBufferRegion_::buf, DEBUG_VALIDATE_BUG_ON, and StreamingBuffer_::region.

Referenced by HtpBodyAppendChunk(), and UTHAddStreamToFlow().

Here is the caller graph for this function:

◆ StreamingBufferAppendNoTrack()

int StreamingBufferAppendNoTrack	(	StreamingBuffer *	sb,
		const StreamingBufferConfig *	cfg,
		const uint8_t *	data,
		uint32_t	data_len
	)

add data w/o tracking a segment

Definition at line 1119 of file util-streaming-buffer.c.

References BIT_U32, StreamingBufferRegion_::buf, DEBUG_VALIDATE_BUG_ON, and StreamingBuffer_::region.

◆ StreamingBufferClear()

void StreamingBufferClear	(	StreamingBuffer *	sb,
		const StreamingBufferConfig *	cfg
	)

Definition at line 272 of file util-streaming-buffer.c.

References StreamingBufferRegion_::buf_size, StreamingBuffer_::region, and SCLogDebug.

Referenced by StreamingBufferFree(), StreamTcpPruneSession(), and StreamTcpStreamCleanup().

Here is the caller graph for this function:

◆ StreamingBufferCompareRawData()

int StreamingBufferCompareRawData	(	const StreamingBuffer *	sb,
		const uint8_t *	rawdata,
		uint32_t	rawdata_len
	)

Return values

1	data is the same
0	data is different

Definition at line 1823 of file util-streaming-buffer.c.

References offset, PrintRawDataFp(), SCLogDebug, and StreamingBufferGetData().

Here is the call graph for this function:

◆ StreamingBufferFree()

void StreamingBufferFree	(	StreamingBuffer *	sb,
		const StreamingBufferConfig *	cfg
	)

Definition at line 295 of file util-streaming-buffer.c.

References FREE, and StreamingBufferClear().

Referenced by HtpBodyFree().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ StreamingBufferGetData()

int StreamingBufferGetData	(	const StreamingBuffer *	sb,
		const uint8_t **	data,
		uint32_t *	data_len,
		uint64_t *	stream_offset
	)

Definition at line 1784 of file util-streaming-buffer.c.

References StreamingBufferRegion_::buf, StreamingBufferRegion_::buf_offset, StreamingBuffer_::region, stream_offset, and StreamingBufferRegion_::stream_offset.

Referenced by StreamingBufferCompareRawData().

Here is the caller graph for this function:

◆ StreamingBufferGetDataAtOffset()

int StreamingBufferGetDataAtOffset	(	const StreamingBuffer *	sb,
		const uint8_t **	data,
		uint32_t *	data_len,
		uint64_t	offset
	)

Definition at line 1801 of file util-streaming-buffer.c.

◆ StreamingBufferInit()

StreamingBuffer* StreamingBufferInit ( const StreamingBufferConfig * cfg )

Definition at line 249 of file util-streaming-buffer.c.

References StreamingBufferConfig_::buf_size, StreamingBufferRegion_::buf_size, CALLOC, StreamingBuffer_::max_regions, StreamingBuffer_::region, and StreamingBuffer_::regions.

Referenced by HtpBodyAppendChunk().

Here is the caller graph for this function:

◆ StreamingBufferInsertAt()

int StreamingBufferInsertAt	(	StreamingBuffer *	sb,
		const StreamingBufferConfig *	cfg,
		StreamingBufferSegment *	seg,
		const uint8_t *	data,
		uint32_t	data_len,
		uint64_t	offset
	)

Parameters

offset offset relative to StreamingBuffer::stream_offset

Returns: SC_OK in case of success; SC_E* errors otherwise

Definition at line 1504 of file util-streaming-buffer.c.

References BIT_U32, DEBUG_VALIDATE_BUG_ON, SC_EINVAL, and StreamingBufferRegion_::stream_offset.

◆ StreamingBufferRegisterTests()

void StreamingBufferRegisterTests ( void )

Definition at line 2371 of file util-streaming-buffer.c.

References UtRegisterTest().

Here is the call graph for this function:

◆ StreamingBufferSBBGetData()

void StreamingBufferSBBGetData	(	const StreamingBuffer *	sb,
		const StreamingBufferBlock *	sbb,
		const uint8_t **	data,
		uint32_t *	data_len
	)

get the data for one SBB

Definition at line 1655 of file util-streaming-buffer.c.

Referenced by UTHCheckDataAtPosition().

Here is the caller graph for this function:

◆ 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 at line 1692 of file util-streaming-buffer.c.

References DEBUG_VALIDATE_BUG_ON, StreamingBufferBlock::len, offset, and StreamingBufferBlock::offset.

◆ StreamingBufferSegmentCompareRawData()

int StreamingBufferSegmentCompareRawData	(	const StreamingBuffer *	sb,
		const StreamingBufferSegment *	seg,
		const uint8_t *	rawdata,
		uint32_t	rawdata_len
	)

Return values

1	data is the same
0	data is different

Definition at line 1768 of file util-streaming-buffer.c.

References StreamingBufferSegmentGetData().

Here is the call graph for this function:

◆ StreamingBufferSegmentGetData()

void StreamingBufferSegmentGetData	(	const StreamingBuffer *	sb,
		const StreamingBufferSegment *	seg,
		const uint8_t **	data,
		uint32_t *	data_len
	)

Definition at line 1734 of file util-streaming-buffer.c.

Referenced by StreamingBufferSegmentCompareRawData(), StreamTcpInlineSegmentCompare(), StreamTcpInlineSegmentReplacePacket(), StreamTcpSegmentForEach(), and StreamTcpSegmentForSession().

Here is the caller graph for this function:

◆ StreamingBufferSegmentIsBeforeWindow()

int StreamingBufferSegmentIsBeforeWindow	(	const StreamingBuffer *	sb,
		const StreamingBufferSegment *	seg
	)

Definition at line 1623 of file util-streaming-buffer.c.

References StreamingBuffer_::region, and StreamingBufferRegion_::stream_offset.

Referenced by HtpBodyPrune().

Here is the caller graph for this function:

◆ StreamingBufferSlideToOffset()

void StreamingBufferSlideToOffset	(	StreamingBuffer *	sb,
		const StreamingBufferConfig *	cfg,
		uint64_t	offset
	)

slide to absolute offset

Todo:: if sliding beyond window, we could perhaps reset?

Definition at line 1000 of file util-streaming-buffer.c.

References offset, and SCLogDebug.

Referenced by HtpBodyPrune().

Here is the caller graph for this function:

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ CALLOC

◆ DUMP_REGIONS

◆ FREE

◆ REALLOC

Function Documentation

◆ RB_GENERATE()

◆ SBB_RB_FIND_INCLUSIVE()

◆ SBBCompare()

◆ StreamingBufferAppend()

◆ StreamingBufferAppendNoTrack()

◆ StreamingBufferClear()

◆ StreamingBufferCompareRawData()

◆ StreamingBufferFree()

◆ StreamingBufferGetData()

◆ StreamingBufferGetDataAtOffset()

◆ StreamingBufferInit()

◆ StreamingBufferInsertAt()

◆ StreamingBufferRegisterTests()

◆ StreamingBufferSBBGetData()

◆ StreamingBufferSBBGetDataAtOffset()

◆ StreamingBufferSegmentCompareRawData()

◆ StreamingBufferSegmentGetData()

◆ StreamingBufferSegmentIsBeforeWindow()

◆ StreamingBufferSlideToOffset()