suricata
tmqh-packetpool.c File Reference
#include "suricata.h"
#include "packet-queue.h"
#include "decode.h"
#include "detect.h"
#include "detect-uricontent.h"
#include "threads.h"
#include "threadvars.h"
#include "flow.h"
#include "flow-util.h"
#include "host.h"
#include "stream.h"
#include "stream-tcp-reassemble.h"
#include "tm-queuehandlers.h"
#include "tm-threads.h"
#include "tm-modules.h"
#include "pkt-var.h"
#include "tmqh-packetpool.h"
#include "util-debug.h"
#include "util-error.h"
#include "util-profiling.h"
#include "util-device.h"
Include dependency graph for tmqh-packetpool.c:

Go to the source code of this file.

Macros

#define MAX_PENDING_RETURN_PACKETS   32
 
#define RESERVED_PACKETS   10
 

Functions

void TmqhPacketpoolRegister (void)
 TmqhPacketpoolRegister . More...
 
void PacketPoolWait (void)
 
void PacketPoolWaitForN (int n)
 Wait until we have the requested amount of packets in the pool. More...
 
PacketPacketPoolGetPacket (void)
 Get a new packet from the packet pool. More...
 
void PacketPoolReturnPacket (Packet *p)
 Return packet to Packet pool. More...
 
void PacketPoolInitEmpty (void)
 
void PacketPoolInit (void)
 
void PacketPoolDestroy (void)
 
PacketTmqhInputPacketpool (ThreadVars *tv)
 
void TmqhOutputPacketpool (ThreadVars *t, Packet *p)
 
void TmqhReleasePacketsToPacketPool (PacketQueue *pq)
 Release all the packets in the queue back to the packetpool. Mainly used by threads that have failed, and wants to return the packets back to the packetpool. More...
 
void PacketPoolPostRunmodes (void)
 Set the max_pending_return_packets value. More...
 

Detailed Description

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

Packetpool queue handlers. Packet pool is implemented as a stack.

Definition in file tmqh-packetpool.c.

Macro Definition Documentation

#define MAX_PENDING_RETURN_PACKETS   32

Definition at line 54 of file tmqh-packetpool.c.

#define RESERVED_PACKETS   10

number of packets to keep reserved when calculating the the pending return packets count. This assumes we need at max 10 packets in one PacketPoolWaitForN call. The actual number is 9 now, so this has a bit of margin.

Definition at line 571 of file tmqh-packetpool.c.

Referenced by PacketPoolPostRunmodes().

Function Documentation

void PacketPoolDestroy ( void  )

Definition at line 407 of file tmqh-packetpool.c.

References BUG_ON, Packet_::next, PacketFree(), PacketPoolGetPacket(), PktPool_::pending_count, PktPool_::pending_head, PktPool_::pending_pool, PktPool_::pending_tail, PktPool_::return_stack, and SC_ATOMIC_DESTROY.

Referenced by PostRunDeinit(), RunUnittests(), and TmThreadsSlotVarRun().

Here is the call graph for this function:

Here is the caller graph for this function:

Packet* PacketPoolGetPacket ( void  )

Get a new packet from the packet pool.

Only allocates from the thread's local stack, or mallocs new packets. If the local stack is empty, first move all the return stack packets to the local stack.

Return values
Packetpointer, or NULL on failure.

Definition at line 249 of file tmqh-packetpool.c.

References BUG_ON, PktPool_::head, Packet_::next, PACKET_REINIT, and Packet_::pool.

Referenced by PacketGetFromQueueOrAlloc(), PacketPoolDestroy(), StreamTcpPseudoSetup(), TmModuleDecodeNetmapRegister(), and TmqhInputPacketpool().

Here is the caller graph for this function:

void PacketPoolInit ( void  )

Definition at line 370 of file tmqh-packetpool.c.

References BUG_ON, max_pending_packets, PacketGetFromAlloc(), PktPool_::return_stack, SC_ATOMIC_INIT, SC_ERR_FATAL, SCCondInit, SCLogDebug, SCLogError, SCMutexInit, SIZE_OF_PACKET, and unlikely.

Referenced by PostRunDeinit(), RunUnittests(), and TmThreadsSlotVarRun().

Here is the call graph for this function:

Here is the caller graph for this function:

void PacketPoolInitEmpty ( void  )

Definition at line 351 of file tmqh-packetpool.c.

References BUG_ON, PktPool_::return_stack, SC_ATOMIC_INIT, SCCondInit, and SCMutexInit.

Referenced by TmThreadsSlotVarRun().

Here is the caller graph for this function:

void PacketPoolPostRunmodes ( void  )

Set the max_pending_return_packets value.

Set it to the max pending packets value, devided by the number of lister threads. Normally, in autofp these are the stream/detect/log worker threads.

The max_pending_return_packets value needs to stay below the packet pool size of the 'producers' (normally pkt capture threads but also flow timeout injection ) to avoid a deadlock where all the 'workers' keep packets in their return pools, while the capture thread can't continue because its pool is empty.

Definition at line 586 of file tmqh-packetpool.c.

References FatalError, max_pending_packets, RESERVED_PACKETS, SC_ERR_INVALID_ARGUMENT, SCLogDebug, TM_FLAG_DETECT_TM, and TmThreadCountThreadsByTmmFlags().

Referenced by main(), and RunModeUnixSocketGetDefaultMode().

Here is the call graph for this function:

Here is the caller graph for this function:

void PacketPoolReturnPacket ( Packet p)

Return packet to Packet pool.

Definition at line 289 of file tmqh-packetpool.c.

References BUG_ON, PktPool_::head, Packet_::next, PACKET_RELEASE_REFS, PacketFree(), PktPool_::pending_count, PktPool_::pending_head, PktPool_::pending_pool, PktPool_::pending_tail, Packet_::pool, PktPool_::return_stack, SC_ATOMIC_GET, SC_ATOMIC_RESET, SCCondSignal, SCMutexLock, and SCMutexUnlock.

Referenced by PacketFreeOrRelease(), and PacketPoolWaitForN().

Here is the call graph for this function:

Here is the caller graph for this function:

void PacketPoolWaitForN ( int  n)

Wait until we have the requested amount of packets in the pool.

In some cases waiting for packets is undesirable. Especially when a wait would happen under a lock of some kind, other parts of the engine could have to wait.

This function only returns when at least N packets are in our pool.

If counting in our pool's main stack didn't give us the number we are seeking, we check if the return stack is filled and add those to our main stack. Then we retry.

Parameters
nnumber of packets needed

Definition at line 177 of file tmqh-packetpool.c.

References Packet_::flags, PktPool_::head, Packet_::next, PacketPoolReturnPacket(), PacketPoolWait(), PKT_ALLOC, Packet_::pool, Packet_::ReleasePacket, PktPool_::return_stack, SC_ATOMIC_ADD, SC_ATOMIC_RESET, SCCondWait, SCMutexLock, and SCMutexUnlock.

Referenced by FlowDisableFlowManagerThread(), and FlowForceReassemblyForFlow().

Here is the call graph for this function:

Here is the caller graph for this function:

Packet* TmqhInputPacketpool ( ThreadVars tv)

Definition at line 444 of file tmqh-packetpool.c.

References PacketPoolGetPacket().

Referenced by TmqhPacketpoolRegister().

Here is the call graph for this function:

Here is the caller graph for this function:

void TmqhPacketpoolRegister ( void  )

TmqhPacketpoolRegister .

Definition at line 132 of file tmqh-packetpool.c.

References PktPool_::head, Tmqh_::InHandler, Tmqh_::name, Tmqh_::OutHandler, PktPool_::return_stack, TMQH_PACKETPOOL, tmqh_table, TmqhInputPacketpool(), and TmqhOutputPacketpool().

Referenced by TmqhSetup().

Here is the call graph for this function:

Here is the caller graph for this function:

void TmqhReleasePacketsToPacketPool ( PacketQueue pq)

Release all the packets in the queue back to the packetpool. Mainly used by threads that have failed, and wants to return the packets back to the packetpool.

Parameters
pqPointer to the packetqueue from which the packets have to be returned back to the packetpool
Warning
this function assumes that the pq does not use locking

Definition at line 554 of file tmqh-packetpool.c.

References PacketDequeue(), and TmqhOutputPacketpool().

Referenced by TmThreadsSlotVarRun().

Here is the call graph for this function:

Here is the caller graph for this function: