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 dependency graph for util-streaming-buffer.c:

Go to the source code of this file.

Macros
#define	MALLOC(cfg, s) (cfg)->Malloc ? (cfg)->Malloc((s)) : SCMalloc((s))

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

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

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

#define	DATA_FITS(sb, len) ((sb)->buf_offset + (len) <= (sb)->buf_size)

#define	DATA_FITS_AT_OFFSET(sb, len, offset) ((offset) + (len) <= (sb)->buf_size)

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)

void	StreamingBufferFree (StreamingBuffer *sb)

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

void	StreamingBufferSlide (StreamingBuffer *sb, uint32_t slide)

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

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

int	StreamingBufferAppendNoTrack (StreamingBuffer sb, const uint8_t data, uint32_t data_len)
	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)

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)) : SCCalloc((n), (s))

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

◆ DATA_FITS

#define DATA_FITS	(	sb,
		len
	)	((sb)->buf_offset + (len) <= (sb)->buf_size)

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

◆ DATA_FITS_AT_OFFSET

#define DATA_FITS_AT_OFFSET	(	sb,
		len,
		offset
	)	((offset) + (len) <= (sb)->buf_size)

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

◆ FREE

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

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

◆ MALLOC

#define MALLOC	(	cfg,
		s
	)	(cfg)->Malloc ? (cfg)->Malloc((s)) : SCMalloc((s))

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

◆ REALLOC

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

Definition at line 39 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 79 of file util-streaming-buffer.c.

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

◆ SBBCompare()

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

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

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

◆ StreamingBufferAppend()

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

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

References StreamingBuffer_::buf, and BUG_ON.

Referenced by UTHAddStreamToFlow().

Here is the caller graph for this function:

◆ StreamingBufferAppendNoTrack()

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

add data w/o tracking a segment

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

References StreamingBuffer_::buf.

◆ StreamingBufferAppendRaw()

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

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

References StreamingBuffer_::buf.

◆ StreamingBufferClear()

void StreamingBufferClear ( StreamingBuffer * sb )

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

References StreamingBuffer_::buf_size, 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 907 of file util-streaming-buffer.c.

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

Referenced by StreamTcpCheckStreamContents().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ StreamingBufferFree()

void StreamingBufferFree ( StreamingBuffer * sb )

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

References StreamingBuffer_::cfg, 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 867 of file util-streaming-buffer.c.

References StreamingBuffer_::buf, StreamingBuffer_::buf_offset, stream_offset, and StreamingBuffer_::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 884 of file util-streaming-buffer.c.

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

◆ StreamingBufferInit()

StreamingBuffer* StreamingBufferInit ( const StreamingBufferConfig * cfg )

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

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

◆ StreamingBufferInsertAt()

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

Returns: 0 in case of success; -1 on memory allocation errors; negative value on other errors

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

References StreamingBuffer_::buf, BUG_ON, and stream_offset.

◆ StreamingBufferRegisterTests()

void StreamingBufferRegisterTests ( void )

Definition at line 1562 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 761 of file util-streaming-buffer.c.

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

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

References StreamingBuffer_::buf, StreamingBuffer_::buf_size, BUG_ON, StreamingBufferBlock::len, offset, StreamingBufferBlock::offset, and StreamingBuffer_::stream_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 851 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 820 of file util-streaming-buffer.c.

References StreamingBuffer_::buf, StreamingBuffer_::buf_size, likely, offset, segment_len, and StreamingBuffer_::stream_offset.

Referenced by HtpBodyPrint(), StreamingBufferSegmentCompareRawData(), StreamTcpInlineSegmentCompare(), and StreamTcpInlineSegmentReplacePacket().

Here is the caller graph for this function:

◆ StreamingBufferSegmentIsBeforeWindow()

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

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

References StreamingBuffer_::stream_offset.

Referenced by HtpBodyPrune().

Here is the caller graph for this function:

◆ StreamingBufferSlide()

void StreamingBufferSlide	(	StreamingBuffer *	sb,
		uint32_t	slide
	)

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

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

◆ StreamingBufferSlideToOffset()

void StreamingBufferSlideToOffset	(	StreamingBuffer *	sb,
		uint64_t	offset
	)

slide to absolute offset

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

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

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

Referenced by HtpBodyPrune().

Here is the caller graph for this function:

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ CALLOC

◆ DATA_FITS

◆ DATA_FITS_AT_OFFSET

◆ FREE

◆ MALLOC

◆ REALLOC

Function Documentation

◆ RB_GENERATE()

◆ SBB_RB_FIND_INCLUSIVE()

◆ SBBCompare()

◆ StreamingBufferAppend()

◆ StreamingBufferAppendNoTrack()

◆ StreamingBufferAppendRaw()

◆ StreamingBufferClear()

◆ StreamingBufferCompareRawData()

◆ StreamingBufferFree()

◆ StreamingBufferGetData()

◆ StreamingBufferGetDataAtOffset()

◆ StreamingBufferInit()

◆ StreamingBufferInsertAt()

◆ StreamingBufferRegisterTests()

◆ StreamingBufferSBBGetData()

◆ StreamingBufferSBBGetDataAtOffset()

◆ StreamingBufferSegmentCompareRawData()

◆ StreamingBufferSegmentGetData()

◆ StreamingBufferSegmentIsBeforeWindow()

◆ StreamingBufferSlide()

◆ StreamingBufferSlideToOffset()