#include "tree.h"

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

This graph shows which files directly or indirectly include this file:

Data Structures
struct	StreamingBufferConfig_

struct	StreamingBufferBlock
	block of continues data More...

struct	StreamingBuffer_

struct	StreamingBufferSegment_

Macros
#define	STREAMING_BUFFER_NOFLAGS 0

#define	STREAMING_BUFFER_AUTOSLIDE (1<<0)

#define	STREAMING_BUFFER_CONFIG_INITIALIZER { 0, 0, 0, NULL, NULL, NULL, NULL, }

#define	STREAMING_BUFFER_INITIALIZER(cfg) { (cfg), 0, NULL, 0, 0, { NULL }, NULL, };

Typedefs
typedef struct StreamingBufferConfig_	StreamingBufferConfig

typedef struct StreamingBuffer_	StreamingBuffer

Functions
struct StreamingBufferBlock	__attribute__ ((__packed__)) StreamingBufferBlock
	block of continues data More...

	RB_ENTRY (StreamingBufferBlock) rb

int	SBBCompare (struct StreamingBufferBlock a, struct StreamingBufferBlock b)

	RB_HEAD (SBB, StreamingBufferBlock)

	RB_PROTOTYPE (SBB, StreamingBufferBlock, rb, SBBCompare)

StreamingBufferBlock *	SBB_RB_FIND_INCLUSIVE (struct SBB head, StreamingBufferBlock elm)

StreamingBuffer *	StreamingBufferInit (const StreamingBufferConfig *cfg)

void	StreamingBufferClear (StreamingBuffer *sb)

void	StreamingBufferFree (StreamingBuffer *sb)

void	StreamingBufferSlide (StreamingBuffer *sb, uint32_t slide)

void	StreamingBufferSlideToOffset (StreamingBuffer *sb, uint64_t offset)
	slide to absolute offset More...

StreamingBufferSegment *	StreamingBufferAppendRaw (StreamingBuffer sb, const uint8_t data, uint32_t data_len) __attribute__((warn_unused_result))

int	StreamingBufferAppend (StreamingBuffer sb, StreamingBufferSegment seg, const uint8_t *data, uint32_t data_len) __attribute__((warn_unused_result))

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

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

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

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

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

int	StreamingBufferCompareRawData (const StreamingBuffer sb, 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	StreamingBufferSegmentIsBeforeWindow (const StreamingBuffer sb, const StreamingBufferSegment seg)

void	StreamingBufferRegisterTests (void)

Variables
uint64_t	offset

uint32_t	len

uint32_t	segment_len

uint64_t	stream_offset

Macro Definition Documentation

#define STREAMING_BUFFER_AUTOSLIDE (1<<0)

Definition at line 65 of file util-streaming-buffer.h.

Referenced by StreamingBufferAppend(), StreamingBufferAppendNoTrack(), StreamingBufferAppendRaw(), StreamingBufferCompareRawData(), and StreamingBufferInsertAt().

#define STREAMING_BUFFER_CONFIG_INITIALIZER { 0, 0, 0, NULL, NULL, NULL, NULL, }

Definition at line 77 of file util-streaming-buffer.h.

#define STREAMING_BUFFER_INITIALIZER ( cfg ) { (cfg), 0, NULL, 0, 0, { NULL }, NULL, };

Definition at line 111 of file util-streaming-buffer.h.

Referenced by StreamingBufferCompareRawData(), StreamTcpFreeConfig(), StreamTcpUTSetupSession(), StreamTcpUTSetupStream(), and UTHAddSessionToFlow().

#define STREAMING_BUFFER_NOFLAGS 0

Definition at line 64 of file util-streaming-buffer.h.

Referenced by StreamTcpAppLayerIsDisabled().

Typedef Documentation

typedef struct StreamingBuffer_ StreamingBuffer

typedef struct StreamingBufferConfig_ StreamingBufferConfig

Function Documentation

__attribute__::RB_ENTRY ( StreamingBufferBlock )

RB_HEAD	(	SBB	,
		StreamingBufferBlock
	)

RB_PROTOTYPE	(	SBB	,
		StreamingBufferBlock	,
		rb	,
		SBBCompare
	)

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

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

References StreamingBuffer_::buf, StreamingBufferConfig_::buf_size, StreamingBuffer_::buf_size, CALLOC, StreamingBuffer_::cfg, StreamingBufferBlock::len, StreamingBufferBlock::offset, RB_LEFT, RB_RIGHT, RB_ROOT, res, and SCLogDebug.

Referenced by StreamReassembleRawUpdateProgress(), and StreamTcpReassembleAppLayer().

Here is the caller graph for this function:

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

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

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

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

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

References StreamingBuffer_::buf, StreamingBuffer_::buf_offset, StreamingBuffer_::buf_size, BUG_ON, StreamingBuffer_::cfg, DATA_FITS, StreamingBufferConfig_::flags, RB_EMPTY, StreamingBuffer_::sbb_tree, StreamingBuffer_::stream_offset, and STREAMING_BUFFER_AUTOSLIDE.

Referenced by HtpBodyAppendChunk(), StreamingBufferCompareRawData(), and UTHAddStreamToFlow().

Here is the caller graph for this function:

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

add data w/o tracking a segment

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

References StreamingBuffer_::buf, StreamingBuffer_::buf_offset, StreamingBuffer_::buf_size, StreamingBuffer_::cfg, DATA_FITS, StreamingBufferConfig_::flags, RB_EMPTY, StreamingBuffer_::sbb_tree, and STREAMING_BUFFER_AUTOSLIDE.

Referenced by FileContainerSetTx().

Here is the caller graph for this function:

StreamingBufferSegment* StreamingBufferAppendRaw	(	StreamingBuffer *	sb,
		const uint8_t *	data,
		uint32_t	data_len
	)

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

References StreamingBuffer_::buf, StreamingBuffer_::buf_offset, StreamingBuffer_::buf_size, CALLOC, StreamingBuffer_::cfg, DATA_FITS, StreamingBufferConfig_::flags, RB_EMPTY, StreamingBuffer_::sbb_tree, StreamingBuffer_::stream_offset, and STREAMING_BUFFER_AUTOSLIDE.

Referenced by StreamingBufferCompareRawData().

Here is the caller graph for this function:

void StreamingBufferClear ( StreamingBuffer * sb )

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

References StreamingBuffer_::buf, StreamingBuffer_::buf_size, StreamingBuffer_::cfg, FREE, and SCLogDebug.

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

Here is the caller graph for this function:

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 889 of file util-streaming-buffer.c.

References StreamingBuffer_::buf, StreamingBuffer_::buf_offset, StreamingBuffer_::buf_size, FAIL_IF, FAIL_IF_NOT, FAIL_IF_NULL, StreamingBuffer_::head, StreamingBufferBlock::len, StreamingBufferBlock::offset, offset, PASS, PrintRawDataFp(), RB_EMPTY, RB_MIN, StreamingBuffer_::sbb_tree, SCFree, SCLogDebug, StreamingBuffer_::stream_offset, STREAMING_BUFFER_AUTOSLIDE, STREAMING_BUFFER_INITIALIZER, StreamingBufferAppend(), StreamingBufferAppendRaw(), StreamingBufferClear(), StreamingBufferFree(), StreamingBufferGetData(), StreamingBufferInit(), StreamingBufferInsertAt(), StreamingBufferSegmentCompareRawData(), StreamingBufferSegmentGetData(), StreamingBufferSegmentIsBeforeWindow(), and StreamingBufferSlide().

Referenced by HTPFileClose(), SMTPParserCleanup(), and StreamTcpCheckStreamContents().

Here is the call graph for this function:

Here is the caller graph for this function:

void StreamingBufferFree ( StreamingBuffer * sb )

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

References __attribute__, StreamingBuffer_::buf, StreamingBuffer_::buf_offset, StreamingBufferConfig_::buf_size, StreamingBuffer_::buf_size, StreamingBufferConfig_::buf_slide, BUG_ON, CALLOC, StreamingBuffer_::cfg, DEBUG_VALIDATE_BUG_ON, FREE, StreamingBuffer_::head, StreamingBufferBlock::len, len, next, StreamingBufferBlock::offset, offset, RB_EMPTY, RB_FOREACH, RB_FOREACH_FROM, RB_FOREACH_REVERSE_FROM, RB_FOREACH_SAFE, REALLOC, res, StreamingBuffer_::sbb_tree, SCLogDebug, StreamingBuffer_::stream_offset, and StreamingBufferClear().

Referenced by FileContainerFree(), HtpBodyFree(), and StreamingBufferCompareRawData().

Here is the call graph for this function:

Here is the caller graph for this function:

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

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

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

Referenced by DetectFilemagicRegister(), JsonHttpLogJSONBodyPrintable(), StreamingBufferCompareRawData(), StreamReassembleRawUpdateProgress(), StreamTcpReassembleAppLayer(), and TcpSegmentCompare().

Here is the caller graph for this function:

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

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

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

Referenced by DetectHttpClientBodyRegister(), OutputRegisterFiledataLogger(), StreamNeedsReassembly(), and StreamTcpReassembleAppLayer().

Here is the caller graph for this function:

StreamingBuffer* StreamingBufferInit ( const StreamingBufferConfig * cfg )

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

References StreamingBufferConfig_::buf_size, StreamingBuffer_::buf_size, CALLOC, StreamingBuffer_::cfg, and FREE.

Referenced by FileSetRange(), HtpBodyAppendChunk(), and StreamingBufferCompareRawData().

Here is the caller graph for this function:

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

Parameters

offset offset relative to StreamingBuffer::stream_offset

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

References StreamingBuffer_::buf, StreamingBuffer_::buf_offset, BUG_ON, StreamingBuffer_::cfg, DATA_FITS_AT_OFFSET, StreamingBufferConfig_::flags, offset, RB_EMPTY, StreamingBuffer_::sbb_tree, SCLogDebug, stream_offset, StreamingBuffer_::stream_offset, and STREAMING_BUFFER_AUTOSLIDE.

Referenced by StreamingBufferCompareRawData(), and TcpSegmentCompare().

Here is the caller graph for this function:

void StreamingBufferRegisterTests ( void )

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

References UtRegisterTest().

Here is the call graph for this function:

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 743 of file util-streaming-buffer.c.

References StreamingBuffer_::buf, StreamingBuffer_::buf_offset, StreamingBufferBlock::len, len, StreamingBufferBlock::offset, offset, and StreamingBuffer_::stream_offset.

Referenced by StreamNeedsReassembly(), StreamReassembleRawUpdateProgress(), and StreamTcpReassembleAppLayer().

Here is the caller graph for this function:

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 769 of file util-streaming-buffer.c.

References StreamingBuffer_::buf, StreamingBuffer_::buf_size, BUG_ON, StreamingBufferBlock::len, StreamingBufferBlock::offset, and StreamingBuffer_::stream_offset.

Referenced by StreamNeedsReassembly().

Here is the caller graph for this function:

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