#include "threads.h"

Include dependency graph for counters.h:

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

Data Structures
struct	StatsCounterId

struct	StatsCounterAvgId

struct	StatsCounterMaxId

struct	StatsCounterGlobalId

struct	StatsCounterDeriveId

struct	StatsCounter_
	Container to hold the counter variable. More...

struct	StatsLocalCounter_
	counter type for local (private) increments. For AVG counters we use 2 to track values and updates. More...

struct	StatsPublicThreadContext_
	Stats Context for a ThreadVars instance. More...

struct	StatsPrivateThreadContext_
	used to hold the private version of the counters registered More...

struct	StatsThreadContext_

Typedefs
typedef struct StatsCounterId	StatsCounterId

typedef struct StatsCounterAvgId	StatsCounterAvgId

typedef struct StatsCounterMaxId	StatsCounterMaxId

typedef struct StatsCounterGlobalId	StatsCounterGlobalId

typedef struct StatsCounterDeriveId	StatsCounterDeriveId

typedef struct StatsCounter_	StatsCounter
	Container to hold the counter variable. More...

typedef struct StatsLocalCounter_	StatsLocalCounter
	counter type for local (private) increments. For AVG counters we use 2 to track values and updates. More...

typedef struct StatsPublicThreadContext_	StatsPublicThreadContext
	Stats Context for a ThreadVars instance. More...

typedef struct StatsPrivateThreadContext_	StatsPrivateThreadContext
	used to hold the private version of the counters registered More...

typedef struct StatsThreadContext_	StatsThreadContext

Functions
void	StatsInit (void)
	Initializes the perf counter api. Things are hard coded currently. More work to be done when we implement multiple interfaces. More...

void	StatsSetupPostConfigPreOutput (void)

void	StatsSetupPostConfigPostOutput (void)

void	StatsSpawnThreads (void)
	Spawns the wakeup, and the management thread used by the stats api. More...

void	StatsRegisterTests (void)

bool	StatsEnabled (void)

void	StatsReleaseResources (void)
	Releases the resources allotted by the Stats API. More...

StatsCounterId	StatsRegisterCounter (const char , StatsThreadContext )
	Registers a normal, unqualified counter. More...

StatsCounterAvgId	StatsRegisterAvgCounter (const char , StatsThreadContext )
	Registers a counter, whose value holds the average of all the values assigned to it. More...

StatsCounterMaxId	StatsRegisterMaxCounter (const char , StatsThreadContext )
	Registers a counter, whose value holds the maximum of all the values assigned to it. More...

StatsCounterGlobalId	StatsRegisterGlobalCounter (const char cname, uint64_t(Func)(void))
	Registers a counter, which represents a global value. More...

StatsCounterDeriveId	StatsRegisterDeriveDivCounter (const char cname, const char dname1, const char dname2, StatsThreadContext )
	Registers a counter which tracks the result of the calculating the value of counter dname1 divided by the value of the counter dname2. More...

void	StatsCounterAddI64 (StatsThreadContext *, StatsCounterId, int64_t)
	Adds a value of type uint64_t to the local counter. More...

void	StatsCounterSetI64 (StatsThreadContext *, StatsCounterId, int64_t)
	set, so overwrite, the value of the local counter More...

void	StatsCounterIncr (StatsThreadContext *, StatsCounterId)
	Increments the local counter. More...

void	StatsCounterDecr (StatsThreadContext *, StatsCounterId)
	Decrements the local counter. More...

void	StatsCounterMaxUpdateI64 (StatsThreadContext *, StatsCounterMaxId id, int64_t x)
	update the value of the localmax counter More...

void	StatsCounterAvgAddI64 (StatsThreadContext *, StatsCounterAvgId id, int64_t x)

int64_t	StatsCounterGetLocalValue (StatsThreadContext *, StatsCounterId)
	Get the value of the local copy of the counter that hold this id. More...

void	StatsThreadInit (StatsThreadContext *)

int	StatsSetupPrivate (StatsThreadContext , const char )

void	StatsThreadCleanup (StatsThreadContext *)

void	StatsSyncCounters (StatsThreadContext *)

void	StatsSyncCountersIfSignalled (StatsThreadContext *)

Detailed Description

Author: Anoop Saldanha anoop.nosp@m.sald.nosp@m.anha@.nosp@m.gmai.nosp@m.l.com; Victor Julien victo.nosp@m.r@in.nosp@m.linia.nosp@m.c.ne.nosp@m.t

Definition in file counters.h.

Typedef Documentation

◆ StatsCounter

typedef struct StatsCounter_ StatsCounter

Container to hold the counter variable.

◆ StatsCounterAvgId

typedef struct StatsCounterAvgId StatsCounterAvgId

◆ StatsCounterDeriveId

typedef struct StatsCounterDeriveId StatsCounterDeriveId

◆ StatsCounterGlobalId

typedef struct StatsCounterGlobalId StatsCounterGlobalId

◆ StatsCounterId

typedef struct StatsCounterId StatsCounterId

◆ StatsCounterMaxId

typedef struct StatsCounterMaxId StatsCounterMaxId

◆ StatsLocalCounter

typedef struct StatsLocalCounter_ StatsLocalCounter

counter type for local (private) increments. For AVG counters we use 2 to track values and updates.

◆ StatsPrivateThreadContext

typedef struct StatsPrivateThreadContext_ StatsPrivateThreadContext

used to hold the private version of the counters registered

◆ StatsPublicThreadContext

typedef struct StatsPublicThreadContext_ StatsPublicThreadContext

Stats Context for a ThreadVars instance.

◆ StatsThreadContext

typedef struct StatsThreadContext_ StatsThreadContext

Function Documentation

◆ StatsCounterAddI64()

void StatsCounterAddI64	(	StatsThreadContext *	stats,
		StatsCounterId	id,
		int64_t	x
	)

Adds a value of type uint64_t to the local counter.

Parameters

id	ID of the counter as set by the API
pca	Counter array that holds the local counter for this TM
x	Value to add to this local counter

Definition at line 147 of file counters.c.

References BUG_ON, StatsPrivateThreadContext_::head, StatsPrivateThreadContext_::initialized, StatsThreadContext_::priv, StatsPrivateThreadContext_::size, and StatsLocalCounter_::v.

Referenced by AppLayerIncTxCounter(), and DecodeUpdatePacketCounters().

Here is the caller graph for this function:

◆ StatsCounterAvgAddI64()

void StatsCounterAvgAddI64	(	StatsThreadContext *	,
		StatsCounterAvgId	id,
		int64_t	x
	)

Definition at line 241 of file counters.c.

References BUG_ON, StatsPrivateThreadContext_::head, StatsPrivateThreadContext_::initialized, StatsThreadContext_::priv, StatsPrivateThreadContext_::size, and StatsLocalCounter_::v.

◆ StatsCounterDecr()

void StatsCounterDecr	(	StatsThreadContext *	stats,
		StatsCounterId	id
	)

Decrements the local counter.

Parameters

stats	per thread counter structure
id	Index of the counter in the counter array

Definition at line 185 of file counters.c.

References BUG_ON, StatsPrivateThreadContext_::head, StatsPrivateThreadContext_::initialized, StatsThreadContext_::priv, StatsPrivateThreadContext_::size, and StatsLocalCounter_::v.

◆ StatsCounterGetLocalValue()

int64_t StatsCounterGetLocalValue	(	StatsThreadContext *	stats,
		StatsCounterId	id
	)

Get the value of the local copy of the counter that hold this id.

Parameters

tv	threadvars
id	The counter id.

Return values

0	on success.
-1	on error.

Definition at line 1376 of file counters.c.

References BUG_ON, StatsPrivateThreadContext_::head, StatsThreadContext_::priv, StatsPrivateThreadContext_::size, and StatsLocalCounter_::v.

Referenced by ReceiveErfDagThreadExitStats().

Here is the caller graph for this function:

◆ StatsCounterIncr()

void StatsCounterIncr	(	StatsThreadContext *	stats,
		StatsCounterId	id
	)

Increments the local counter.

Parameters

id	Index of the counter in the counter array
pca	Counter array that holds the local counters for this TM

Definition at line 166 of file counters.c.

References BUG_ON, StatsPrivateThreadContext_::head, StatsPrivateThreadContext_::initialized, StatsThreadContext_::priv, StatsPrivateThreadContext_::size, and StatsLocalCounter_::v.

Referenced by AppLayerIncAllocErrorCounter(), AppLayerIncGapErrorCounter(), AppLayerIncInternalErrorCounter(), AppLayerIncParserErrorCounter(), CaptureStatsUpdate(), DecodeARP(), DecodeCHDLC(), DecodeERSPAN(), DecodeERSPANTypeI(), DecodeESP(), DecodeETag(), DecodeEthernet(), DecodeGRE(), DecodeICMPV4(), DecodeIPV4(), DecodeIPV6(), DecodeMPLS(), DecodeNSH(), DecodeNull(), DecodePPP(), DecodePPPOEDiscovery(), DecodePPPOESession(), DecodeRaw(), DecodeSCTP(), DecodeSll(), DecodeSll2(), DecodeTCP(), DecodeUDP(), DecodeUpdatePacketCounters(), DecodeVLAN(), DecodeVNTag(), PacketDecodeFinalize(), PacketUpdateEngineEventCounters(), and StreamTcpGetSegment().

Here is the caller graph for this function:

◆ StatsCounterMaxUpdateI64()

void StatsCounterMaxUpdateI64	(	StatsThreadContext *	stats,
		StatsCounterMaxId	id,
		int64_t	x
	)

update the value of the localmax counter

Parameters

stats	per thread counter structure
id	Index of the local counter in the counter array
x	The value to set for the counter

Definition at line 225 of file counters.c.

References BUG_ON, StatsPrivateThreadContext_::head, StatsPrivateThreadContext_::initialized, StatsThreadContext_::priv, StatsPrivateThreadContext_::size, and StatsLocalCounter_::v.

Referenced by DecodeUpdatePacketCounters().

Here is the caller graph for this function:

◆ StatsCounterSetI64()

void StatsCounterSetI64	(	StatsThreadContext *	stats,
		StatsCounterId	id,
		int64_t	x
	)

set, so overwrite, the value of the local counter

Parameters

stats	per thread counter structure
id	Index of the local counter in the counter array
x	The value to set for the counter

Definition at line 205 of file counters.c.

References BUG_ON, StatsPrivateThreadContext_::head, StatsPrivateThreadContext_::initialized, StatsThreadContext_::priv, StatsPrivateThreadContext_::size, and StatsLocalCounter_::v.

◆ StatsEnabled()

bool StatsEnabled ( void )

Definition at line 117 of file counters.c.

◆ StatsInit()

void StatsInit ( void )

Initializes the perf counter api. Things are hard coded currently. More work to be done when we implement multiple interfaces.

Definition at line 963 of file counters.c.

References BUG_ON.

Referenced by PreRunInit().

Here is the caller graph for this function:

◆ StatsRegisterAvgCounter()

StatsCounterAvgId StatsRegisterAvgCounter	(	const char *	name,
		StatsThreadContext *	stats
	)

Registers a counter, whose value holds the average of all the values assigned to it.

Parameters

name	Name of the counter, to be registered
tv	Pointer to the ThreadVars instance for which the counter would be registered

Return values

id	Counter id for the newly registered counter, or the already present counter

Definition at line 1058 of file counters.c.

◆ StatsRegisterCounter()

StatsCounterId StatsRegisterCounter	(	const char *	name,
		StatsThreadContext *	stats
	)

Registers a normal, unqualified counter.

Parameters

name	Name of the counter, to be registered
tv	Pointer to the ThreadVars instance for which the counter would be registered

Return values

id	Counter id for the newly registered counter, or the already present counter

Definition at line 1039 of file counters.c.

Referenced by CaptureStatsSetup(), DecodeRegisterPerfCounters(), ExceptionPolicySetStatsCounters(), FlowEndCountersRegister(), ReceiveErfDagThreadInit(), and StreamTcpThreadInit().

Here is the caller graph for this function:

◆ StatsRegisterDeriveDivCounter()

StatsCounterDeriveId StatsRegisterDeriveDivCounter	(	const char *	name,
		const char *	dname1,
		const char *	dname2,
		StatsThreadContext *	stats
	)

Registers a counter which tracks the result of the calculating the value of counter dname1 divided by the value of the counter dname2.

Parameters

name	Name of the counter, to be registered
dname1	First counter name
dname2	Second counter name

Both counters need to already be registered in this thread.

Return values

id	Counter id for the newly registered counter, or the already present counter

Definition at line 1122 of file counters.c.

References StatsCounterDeriveId::id.

Referenced by DecodeRegisterPerfCounters().

Here is the caller graph for this function:

◆ StatsRegisterGlobalCounter()

StatsCounterGlobalId StatsRegisterGlobalCounter	(	const char *	name,
		uint64_t(*)(void)	Func
	)

Registers a counter, which represents a global value.

Parameters

name	Name of the counter, to be registered
Func	Function Pointer returning a uint64_t

Return values

id	Counter id for the newly registered counter, or the already present counter

Definition at line 1094 of file counters.c.

References StatsCounterGlobalId::id.

Referenced by AppLayerRegisterGlobalCounters(), OutputFilestoreRegisterGlobalCounters(), and ThresholdRegisterGlobalCounters().

Here is the caller graph for this function:

◆ StatsRegisterMaxCounter()

StatsCounterMaxId StatsRegisterMaxCounter	(	const char *	name,
		StatsThreadContext *	stats
	)

Registers a counter, whose value holds the maximum of all the values assigned to it.

Parameters

name	Name of the counter, to be registered
tv	Pointer to the ThreadVars instance for which the counter would be registered

Return values

the	counter id for the newly registered counter, or the already present counter

Definition at line 1077 of file counters.c.

Referenced by DecodeRegisterPerfCounters().

Here is the caller graph for this function:

◆ StatsRegisterTests()

void StatsRegisterTests ( void )

Definition at line 1653 of file counters.c.

References UtRegisterTest().

Here is the call graph for this function:

◆ StatsReleaseResources()

void StatsReleaseResources ( void )

Releases the resources allotted by the Stats API.

Definition at line 1388 of file counters.c.

◆ StatsSetupPostConfigPostOutput()

void StatsSetupPostConfigPostOutput ( void )

Definition at line 978 of file counters.c.

Referenced by PreRunPostPrivsDropInit().

Here is the caller graph for this function:

◆ StatsSetupPostConfigPreOutput()

void StatsSetupPostConfigPreOutput ( void )

Definition at line 973 of file counters.c.

Referenced by PreRunPostPrivsDropInit().

Here is the caller graph for this function:

◆ StatsSetupPrivate()

int StatsSetupPrivate	(	StatsThreadContext *	,
		const char *
	)

Definition at line 1313 of file counters.c.

◆ StatsSpawnThreads()

void StatsSpawnThreads ( void )

Spawns the wakeup, and the management thread used by the stats api.

The threads use the condition variable in the thread vars to control their wait loops to make sure the main thread can quickly kill them.

Definition at line 990 of file counters.c.

References SCEnter.

◆ StatsSyncCounters()

void StatsSyncCounters ( StatsThreadContext * )

Definition at line 479 of file counters.c.

Referenced by SCTmThreadsSlotPacketLoopFinish().

Here is the caller graph for this function:

◆ StatsSyncCountersIfSignalled()

void StatsSyncCountersIfSignalled ( StatsThreadContext * )

Definition at line 484 of file counters.c.

References StatsThreadContext_::pub, and SC_ATOMIC_GET.

Referenced by TmqhInputFlow(), and TmqhInputSimple().

Here is the caller graph for this function:

◆ StatsThreadCleanup()

void StatsThreadCleanup ( StatsThreadContext * )

Definition at line 1429 of file counters.c.

Referenced by UTHMatchPackets(), UTHMatchPacketsWithResults(), UTHPacketMatchSig(), and UTHPacketMatchSigMpm().

Here is the caller graph for this function:

◆ StatsThreadInit()

void StatsThreadInit ( StatsThreadContext * )

Definition at line 1333 of file counters.c.

Referenced by TmThreadCreate(), UTHMatchPackets(), UTHMatchPacketsWithResults(), UTHPacketMatchSig(), and UTHPacketMatchSigMpm().

Here is the caller graph for this function:

Data Structures

Typedefs

Functions

Detailed Description

Typedef Documentation

◆ StatsCounter

◆ StatsCounterAvgId

◆ StatsCounterDeriveId

◆ StatsCounterGlobalId

◆ StatsCounterId

◆ StatsCounterMaxId

◆ StatsLocalCounter

◆ StatsPrivateThreadContext

◆ StatsPublicThreadContext

◆ StatsThreadContext

Function Documentation

◆ StatsCounterAddI64()

◆ StatsCounterAvgAddI64()

◆ StatsCounterDecr()

◆ StatsCounterGetLocalValue()

◆ StatsCounterIncr()

◆ StatsCounterMaxUpdateI64()

◆ StatsCounterSetI64()

◆ StatsEnabled()

◆ StatsInit()

◆ StatsRegisterAvgCounter()

◆ StatsRegisterCounter()

◆ StatsRegisterDeriveDivCounter()

◆ StatsRegisterGlobalCounter()

◆ StatsRegisterMaxCounter()

◆ StatsRegisterTests()

◆ StatsReleaseResources()

◆ StatsSetupPostConfigPostOutput()

◆ StatsSetupPostConfigPreOutput()

◆ StatsSetupPrivate()

◆ StatsSpawnThreads()

◆ StatsSyncCounters()

◆ StatsSyncCountersIfSignalled()

◆ StatsThreadCleanup()

◆ StatsThreadInit()