Pool are an effective way to maintain a set of ready to use structures. More...

Files
file	util-pool-thread.c

file	util-pool-thread.h

file	util-pool.c

file	util-pool.h

Data Structures
struct	PoolThreadTestData

Functions
PoolThread *	PoolThreadInit (int threads, uint32_t size, uint32_t prealloc_size, uint32_t elt_size, void (Alloc)(void), int(Init)(void , void ), void InitData, void(Cleanup)(void ), void(Free)(void ))
	per thread Pool, initialization function More...

int	PoolThreadExpand (PoolThread *pt)
	expand pool by one for a new thread More...

int	PoolThreadSize (PoolThread *pt)
	get size of PoolThread (number of 'threads', so array elements) More...

void	PoolThreadFree (PoolThread *pt)
	destroy the thread pool More...

void *	PoolThreadGetById (PoolThread *pt, uint16_t id)
	get data from thread pool by thread id More...

void	PoolThreadReturn (PoolThread pt, void data)
	return data to thread pool More...

void	PoolThreadLock (PoolThread *pt, PoolThreadId id)

void	PoolThreadReturnRaw (PoolThread pt, PoolThreadId id, void data)

void	PoolThreadUnlock (PoolThread *pt, PoolThreadId id)

void	PoolThreadRegisterTests (void)

Pool *	PoolInit (uint32_t size, uint32_t prealloc_size, uint32_t elt_size, void (Alloc)(void), int(Init)(void , void ), void InitData, void(Cleanup)(void ), void(Free)(void ))
	Init a Pool. More...

void	PoolFree (Pool *p)

void *	PoolGet (Pool *p)

void	PoolReturn (Pool p, void data)

void	PoolRegisterTests (void)

Detailed Description

Pool are an effective way to maintain a set of ready to use structures.

To create a Pool, you need to use PoolInit(). You can get an item from the Pool by using PoolGet(). When you're done with it call PoolReturn(). To destroy the Pool, call PoolFree(), it will free all used memory.

Function Documentation

◆ PoolFree()

void PoolFree ( Pool * p )

Definition at line 223 of file util-pool.c.

References Pool_::alloc_stack, Pool_::Cleanup, PoolBucket_::data, and PoolBucket_::next.

Referenced by PoolThreadFree().

Here is the caller graph for this function:

◆ PoolGet()

void* PoolGet ( Pool * p )

Definition at line 271 of file util-pool.c.

References Pool_::Alloc, Pool_::alloc_stack, Pool_::alloc_stack_size, Pool_::allocated, PoolBucket_::data, Pool_::elt_size, Pool_::empty_stack, Pool_::empty_stack_size, Pool_::Free, Pool_::Init, Pool_::InitData, Pool_::max_buckets, PoolBucket_::next, Pool_::outstanding, SCEnter, SCFree, SCLogDebug, SCMalloc, and SCReturnPtr.

Referenced by PoolThreadGetById().

Here is the caller graph for this function:

◆ PoolInit()

Pool* PoolInit	(	uint32_t	size,
		uint32_t	prealloc_size,
		uint32_t	elt_size,
		void ()(void)	Alloc,
		int()(void , void *)	Init,
		void *	InitData,
		void()(void )	Cleanup,
		void()(void )	Free
	)

Init a Pool.

PoolInit() creates a Pool. The Alloc function must only do allocation stuff. The Cleanup function must not try to free the PoolBucket::data. This is done by the Pool management system.

Parameters

size
prealloc_size
elt_size	Memory size of an element
Alloc	An allocation function or NULL to use a standard SCMalloc
Init	An init function or NULL to use a standard memset to 0
InitData	Init data
Cleanup	a free function or NULL if no special treatment is needed
Free	free func

Return values

the	allocated Pool

Definition at line 84 of file util-pool.c.

Referenced by PoolThreadExpand().

Here is the caller graph for this function:

◆ PoolRegisterTests()

void PoolRegisterTests ( void )

Definition at line 705 of file util-pool.c.

References UtRegisterTest().

Here is the call graph for this function:

◆ PoolReturn()

void PoolReturn	(	Pool *	p,
		void *	data
	)

Definition at line 329 of file util-pool.c.

References Pool_::allocated, Pool_::Cleanup, Pool_::empty_stack, Pool_::outstanding, SCEnter, and SCLogDebug.

Referenced by PoolThreadReturn(), and PoolThreadReturnRaw().

Here is the caller graph for this function:

◆ PoolThreadExpand()

int PoolThreadExpand ( PoolThread * pt )

expand pool by one for a new thread

grow a thread pool by one

Return values

-1	or pool thread id

Definition at line 97 of file util-pool-thread.c.

References Pool_::Alloc, PoolThread_::array, Pool_::Cleanup, Pool_::elt_size, Pool_::Free, Pool_::Init, Pool_::InitData, PoolThreadElement_::lock, Pool_::max_buckets, PoolThreadElement_::pool, PoolInit(), Pool_::preallocated, SCFree, SCLogDebug, SCLogError, SCMutexInit, SCMutexLock, SCMutexUnlock, SCRealloc, and PoolThread_::size.

Here is the call graph for this function:

◆ PoolThreadFree()

void PoolThreadFree ( PoolThread * pt )

destroy the thread pool

Note: wrapper around PoolFree()

Parameters

pt	thread pool

Definition at line 155 of file util-pool-thread.c.

References PoolThread_::array, PoolThreadElement_::lock, PoolThreadElement_::pool, PoolFree(), SCFree, SCMutexDestroy, SCMutexLock, SCMutexUnlock, and PoolThread_::size.

Here is the call graph for this function:

◆ PoolThreadGetById()

void* PoolThreadGetById	(	PoolThread *	pt,
		uint16_t	id
	)

get data from thread pool by thread id

Note: wrapper around PoolGet()

Parameters

pt	thread pool
id	thread id

Return values

ptr	data or NULL

Definition at line 173 of file util-pool-thread.c.

References PoolThread_::array, PoolThreadElement_::lock, PoolThreadElement_::pool, PoolGet(), SCMutexLock, SCMutexUnlock, and PoolThread_::size.

Referenced by StreamTcpGetSegment().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PoolThreadInit()

PoolThread* PoolThreadInit	(	int	threads,
		uint32_t	size,
		uint32_t	prealloc_size,
		uint32_t	elt_size,
		void ()(void)	Alloc,
		int()(void , void *)	Init,
		void *	InitData,
		void()(void )	Cleanup,
		void()(void )	Free
	)