Functions which we wish were included in the standard talloc distribution. More...

#include <freeradius-devel/util/atexit.h>
#include <freeradius-devel/util/debug.h>
#include <freeradius-devel/util/dlist.h>
#include <freeradius-devel/util/sbuff.h>
#include <freeradius-devel/util/strerror.h>

Include dependency graph for talloc.c:

Go to the source code of this file.

Data Structures
struct	talloc_child_ctx_s

Functions
static int	_autofree_global_destructor (TALLOC_CTX *af)
	Ensures in the autofree ctx is manually freed, things don't explode atexit. More...

static int	_autofree_on_exit (void *af)
	Callback to free the autofree ctx on global exit. More...

static int	_autofree_thread_local_destructor (TALLOC_CTX *af)
	Ensures in the autofree ctx is manually freed, things don't explode atexit. More...

static int	_child_ctx_free (TALLOC_CHILD_CTX *list)

static int	_talloc_destructor_disarm (fr_talloc_destructor_disarm_t *ds)
	Called when the disarm_ctx ctx is freed. More...

static int	_talloc_destructor_fire (fr_talloc_destructor_t *d)
	Called with the fire_ctx is freed. More...

static int	_talloc_link_ctx_free (UNUSED void parent, void child)

TALLOC_CTX *	talloc_aligned_array (TALLOC_CTX ctx, void *start, size_t alignment, size_t size)
	Return a page aligned talloc memory array. More...

fr_slen_t	talloc_array_concat (fr_sbuff_t out, char const const array, char const sep)
	Concat an array of strings (not NULL terminated), with a string separator. More...

void **	talloc_array_null_strip (void **array)
	Remove a NULL termination pointer from an array of pointers. More...

void **	talloc_array_null_terminate (void **array)
	Add a NULL pointer to an array of pointers. More...

TALLOC_CTX *	talloc_autofree_context_global (void)

TALLOC_CTX *	talloc_autofree_context_thread_local (void)
	Get a thread-safe autofreed ctx that will be freed when the thread or process exits. More...

char *	talloc_bstr_append (TALLOC_CTX ctx, char to, char const *from, size_t from_len)
	Append a bstr to a bstr. More...

char *	talloc_bstr_realloc (TALLOC_CTX ctx, char in, size_t inlen)
	Trim a bstr (char) buffer. More...

char *	talloc_bstrdup (TALLOC_CTX ctx, char const in)
	Binary safe strdup function. More...

char *	talloc_bstrndup (TALLOC_CTX ctx, char const in, size_t inlen)
	Binary safe strndup function. More...

char *	talloc_buffer_append_buffer (TALLOC_CTX ctx, char to, char const *from)
	Concatenate to + from. More...

char *	talloc_buffer_append_variadic_buffer (TALLOC_CTX ctx, char to, int argc,...)
	Concatenate to + ... More...

TALLOC_CHILD_CTX *	talloc_child_ctx_alloc (TALLOC_CHILD_CTX *parent)
	Allocate a TALLOC_CHILD_CTX from a parent. More...

TALLOC_CHILD_CTX *	talloc_child_ctx_init (TALLOC_CTX *ctx)
	Allocate and initialize a TALLOC_CHILD_CTX. More...

int	talloc_decrease_ref_count (void const *ptr)
	Decrease the reference count on a ptr. More...

fr_talloc_destructor_t *	talloc_destructor_add (TALLOC_CTX fire_ctx, TALLOC_CTX disarm_ctx, fr_talloc_free_func_t func, void const *uctx)
	Add an additional destructor to a talloc chunk. More...

void	talloc_destructor_disarm (fr_talloc_destructor_t *d)
	Disarm a destructor and free all memory allocated in the trigger ctxs. More...

void	talloc_free_data (void *data)
	A wrapper that can be passed to tree or hash alloc functions that take a fr_free_t. More...

int	talloc_link_ctx (TALLOC_CTX parent, TALLOC_CTX child)
	Link two different parent and child contexts, so the child is freed before the parent. More...

int	talloc_memcmp_array (uint8_t const a, uint8_t const b)
	Compares two talloced uint8_t arrays with memcmp. More...

int	talloc_memcmp_bstr (char const a, char const b)
	Compares two talloced char arrays with memcmp. More...

void *	talloc_null_ctx (void)
	Retrieve the current talloc NULL ctx. More...

TALLOC_CTX *	talloc_page_aligned_pool (TALLOC_CTX ctx, void start, void *end, size_t size)
	Return a page aligned talloc memory pool. More...

char *	talloc_typed_asprintf (TALLOC_CTX ctx, char const fmt,...)
	Call talloc vasprintf, setting the type on the new chunk correctly. More...

uint8_t *	talloc_typed_memdup (TALLOC_CTX ctx, uint8_t const in, size_t inlen)
	Call talloc_memdup, setting the type on the new chunk correctly. More...

char *	talloc_typed_strdup (TALLOC_CTX ctx, char const p)
	Call talloc_strdup, setting the type on the new chunk correctly. More...

char *	talloc_typed_strdup_buffer (TALLOC_CTX ctx, char const p)
	Call talloc_strndup, setting the type on the new chunk correctly. More...

char *	talloc_typed_vasprintf (TALLOC_CTX ctx, char const fmt, va_list ap)
	Call talloc vasprintf, setting the type on the new chunk correctly. More...

Variables
static TALLOC_CTX *	global_ctx

static _Thread_local TALLOC_CTX *	thread_local_ctx

Detailed Description

Functions which we wish were included in the standard talloc distribution.

Copyright: 2017 The FreeRADIUS server project; 2017 Arran Cudbard-Bell (a.cud.nosp@m.bard.nosp@m.b@fre.nosp@m.erad.nosp@m.ius.o.nosp@m.rg)

Definition in file talloc.c.

Data Structure Documentation

◆ talloc_child_ctx_s

struct talloc_child_ctx_s

Definition at line 892 of file talloc.c.

Collaboration diagram for talloc_child_ctx_s:

Data Fields
struct talloc_child_ctx_s *	next

Function Documentation

◆ _autofree_global_destructor()

static int _autofree_global_destructor ( TALLOC_CTX * af )

static

Ensures in the autofree ctx is manually freed, things don't explode atexit.

Definition at line 840 of file talloc.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _autofree_on_exit()

static int _autofree_on_exit ( void * af )

static

Callback to free the autofree ctx on global exit.

Definition at line 831 of file talloc.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _autofree_thread_local_destructor()

static int _autofree_thread_local_destructor ( TALLOC_CTX * af )

static

Ensures in the autofree ctx is manually freed, things don't explode atexit.

Definition at line 864 of file talloc.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _child_ctx_free()

static int _child_ctx_free ( TALLOC_CHILD_CTX * list )

static

Definition at line 896 of file talloc.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _talloc_destructor_disarm()

static int _talloc_destructor_disarm ( fr_talloc_destructor_disarm_t * ds )

static

Called when the disarm_ctx ctx is freed.

Definition at line 77 of file talloc.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _talloc_destructor_fire()

static int _talloc_destructor_fire ( fr_talloc_destructor_t * d )

static

Called with the fire_ctx is freed.

Definition at line 64 of file talloc.c.

Here is the caller graph for this function:

◆ _talloc_link_ctx_free()

static int _talloc_link_ctx_free	(	UNUSED void *	parent,
		void *	child
	)

static

Definition at line 149 of file talloc.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ talloc_aligned_array()

TALLOC_CTX* talloc_aligned_array	(	TALLOC_CTX *	ctx,
		void **	start,
		size_t	alignment,
		size_t	size
	)

Return a page aligned talloc memory array.

Because we can't intercept talloc's malloc() calls, we need to do some tricks in order to get the first allocation in the array page aligned, and to limit the size of the array to a multiple of the page size.

The reason for wanting a page aligned talloc array, is it allows us to mprotect() the pages that belong to the array.

Talloc chunks appear to be allocated within the protected region, so this should catch frees too.

Parameters

[in]	ctx	to allocate array memory in.
[out]	start	The first aligned address in the array.
[in]	alignment	What alignment the memory chunk should have.
[in]	size	How big to make the array. Will be corrected to a multiple of the page size. The actual array size will be size rounded to a multiple of the (page_size), + page_size

Returns

A talloc chunk on success.
NULL on failure.

Definition at line 196 of file talloc.c.

Here is the caller graph for this function:

◆ talloc_array_concat()

fr_slen_t talloc_array_concat	(	fr_sbuff_t *	out,
		char const const	array,
		char const *	sep
	)

Concat an array of strings (not NULL terminated), with a string separator.

Parameters

[out]	out	Where to write the resulting string.
[in]	array	of strings to concat.
[in]	sep	to insert between elements. May be NULL.

Returns

>= 0 on success - length of the string created.
<0 on failure. How many bytes we would need.

Definition at line 802 of file talloc.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ talloc_array_null_strip()

void** talloc_array_null_strip ( void ** array )

Remove a NULL termination pointer from an array of pointers.

If the end of the array is not NULL, NULL will be returned (error).

Parameters

[in] array to null strip. Will be invalidated (realloced).

Returns

NULL if array is NULL, if terminating element is not NULL, or reallocation fails.
A realloced version of array without the terminating NULL element.

Definition at line 770 of file talloc.c.

◆ talloc_array_null_terminate()

void** talloc_array_null_terminate ( void ** array )

Add a NULL pointer to an array of pointers.

This is needed by some 3rd party libraries which take NULL terminated arrays for arguments.

If allocation fails, NULL will be returned and the original array will not be touched.

Parameters

[in] array to null terminate. Will be invalidated (realloced).

Returns

NULL if array is NULL, or if reallocation fails.
A realloced version of array with an additional NULL element.

Definition at line 740 of file talloc.c.

Here is the caller graph for this function:

◆ talloc_autofree_context_global()

TALLOC_CTX* talloc_autofree_context_global ( void )

Definition at line 845 of file talloc.c.

Here is the call graph for this function:

◆ talloc_autofree_context_thread_local()

TALLOC_CTX* talloc_autofree_context_thread_local ( void )

Get a thread-safe autofreed ctx that will be freed when the thread or process exits.

Note: This should be used in place of talloc_autofree_context (which is now deprecated); Will not be thread-safe if NULL tracking is enabled.

Returns: A talloc ctx which will be freed when the thread or process exits.

Definition at line 876 of file talloc.c.

Here is the call graph for this function:

◆ talloc_bstr_append()

char* talloc_bstr_append	(	TALLOC_CTX *	ctx,
		char *	to,
		char const *	from,
		size_t	from_len
	)

Append a bstr to a bstr.

Parameters

[in]	ctx	to allocated.
[in]	to	string to append to.
[in]	from	string to append from.
[in]	from_len	Length of from.

Returns

Realloced buffer containing both to and from.
NULL on failure. To will still be valid.

Definition at line 480 of file talloc.c.

Here is the caller graph for this function:

◆ talloc_bstr_realloc()

char* talloc_bstr_realloc	(	TALLOC_CTX *	ctx,
		char *	in,
		size_t	inlen
	)

Trim a bstr (char) buffer.

Reallocs to inlen + 1 and '\0' terminates the string buffer.

Parameters

[in]	ctx	to realloc buffer into.
[in]	in	string to trim. Will be invalid after this function returns. If NULL a new zero terminated buffer of inlen bytes will be allocated.
[in]	inlen	Length to trim string to.

Returns

The realloced string on success. in then points to invalid memory.
NULL on failure. In will still be valid.

Definition at line 516 of file talloc.c.

Here is the caller graph for this function:

◆ talloc_bstrdup()

char* talloc_bstrdup	(	TALLOC_CTX *	ctx,
		char const *	in
	)

Binary safe strdup function.

Parameters

[in]	ctx	the talloc context to allocate new buffer in.
[in]	in	String to dup, may contain embedded '\0'.

Returns: duped string.

Definition at line 424 of file talloc.c.

Here is the caller graph for this function:

◆ talloc_bstrndup()

char* talloc_bstrndup	(	TALLOC_CTX *	ctx,
		char const *	in,
		size_t	inlen
	)

Binary safe strndup function.

Parameters

[in]	ctx	he talloc context to allocate new buffer in.
[in]	in	String to dup, may contain embedded '\0'.
[in]	inlen	Number of bytes to dup.

Returns: duped string.

Definition at line 452 of file talloc.c.

Here is the caller graph for this function:

◆ talloc_buffer_append_buffer()

char* talloc_buffer_append_buffer	(	TALLOC_CTX *	ctx,
		char *	to,
		char const *	from
	)

Concatenate to + from.

Parameters

[in]	ctx	to allocate realloced buffer in.
[in]	to	talloc string buffer to append to.
[in]	from	talloc string buffer to append.

Returns

NULL if to or from are NULL or if the realloc fails. Note: You'll still need to free to if this function returns NULL.
The concatenation of to + from. After this function returns to may point to invalid memory and should not be used.

Definition at line 548 of file talloc.c.

Here is the caller graph for this function:

◆ talloc_buffer_append_variadic_buffer()

char* talloc_buffer_append_variadic_buffer	(	TALLOC_CTX *	ctx,
		char *	to,
		int	argc,
			...
	)

Concatenate to + ...

Parameters

[in]	ctx	to allocate realloced buffer in.
[in]	to	talloc string buffer to append to.
[in]	argc	how many variadic arguments were passed.
[in]	...	talloc string buffer(s) to append. Arguments can be NULL to simplify calling logic.

Returns

NULL if to or from are NULL or if the realloc fails. Note: You'll still need to free to if this function returns NULL.
The concatenation of to + from. After this function returns to may point to invalid memory and should not be used.

Definition at line 584 of file talloc.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ talloc_child_ctx_alloc()

TALLOC_CHILD_CTX* talloc_child_ctx_alloc ( TALLOC_CHILD_CTX * parent )

Allocate a TALLOC_CHILD_CTX from a parent.

Definition at line 940 of file talloc.c.

◆ talloc_child_ctx_init()

TALLOC_CHILD_CTX* talloc_child_ctx_init ( TALLOC_CTX * ctx )

Allocate and initialize a TALLOC_CHILD_CTX.

The TALLOC_CHILD_CTX ensures ordering for allocators and destructors. When a TALLOC_CHILD_CTX is created, it is added to parent, in LIFO order. In contrast, the basic talloc operations do not guarantee any kind of order.

When the TALLOC_CHILD_CTX is freed, the children are freed in FILO order. That process ensures that the children are freed before the parent, and that the younger siblings are freed before the older siblings.

The idea is that if we have an initializer for A, which in turn initializes B and C. When the memory is freed, we should do the operations in the reverse order.

Definition at line 926 of file talloc.c.

Here is the call graph for this function:

◆ talloc_decrease_ref_count()

int talloc_decrease_ref_count ( void const * ptr )

Decrease the reference count on a ptr.

Ptr will be freed if count reaches zero.

This is equivalent to talloc 1.0 behaviour of talloc_free.

Parameters

ptr	to decrement ref count for.

Returns

0 The memory was freed.
>0 How many references remain.

Definition at line 708 of file talloc.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ talloc_destructor_add()

fr_talloc_destructor_t* talloc_destructor_add	(	TALLOC_CTX *	fire_ctx,
		TALLOC_CTX *	disarm_ctx,
		fr_talloc_free_func_t	func,
		void const *	uctx
	)

Add an additional destructor to a talloc chunk.

Parameters

[in]	fire_ctx	When this ctx is freed the destructor function will be called.
[in]	disarm_ctx	When this ctx is freed the destructor will be disarmed. May be NULL. talloc_destructor_disarm may be used to disarm the destructor too.
[in]	func	to call when the fire_ctx is freed.
[in]	uctx	data to pass to the above function.

Returns

A handle to access the destructor on success.
NULL on failure.

Definition at line 96 of file talloc.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ talloc_destructor_disarm()

void talloc_destructor_disarm ( fr_talloc_destructor_t * d )

Disarm a destructor and free all memory allocated in the trigger ctxs.

Definition at line 138 of file talloc.c.

Here is the call graph for this function:

◆ talloc_free_data()

void talloc_free_data ( void * data )

A wrapper that can be passed to tree or hash alloc functions that take a fr_free_t.

Definition at line 37 of file talloc.c.

Here is the call graph for this function:

◆ talloc_link_ctx()

int talloc_link_ctx	(	TALLOC_CTX *	parent,
		TALLOC_CTX *	child
	)

Link two different parent and child contexts, so the child is freed before the parent.

Note: This is not thread safe. Do not free parent before threads are joined, do not call from a child thread.

Parameters

parent	who's fate the child should share.
child	bound to parent's lifecycle.

Returns

0 on success.
-1 on failure.

Definition at line 167 of file talloc.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ talloc_memcmp_array()

int talloc_memcmp_array	(	uint8_t const *	a,
		uint8_t const *	b
	)

Compares two talloced uint8_t arrays with memcmp.

Talloc arrays carry their length as part of the structure, so can be passed to a generic comparison function.

Parameters

a	Pointer to first array.
b	Pointer to second array.

Returns

0 if the arrays match.
a positive or negative integer otherwise.

Definition at line 660 of file talloc.c.

◆ talloc_memcmp_bstr()

int talloc_memcmp_bstr	(	char const *	a,
		char const *	b
	)

Compares two talloced char arrays with memcmp.

Talloc arrays carry their length as part of the structure, so can be passed to a generic comparison function.

Parameters

a	Pointer to first array.
b	Pointer to second array.

Returns

0 if the arrays match.
a positive or negative integer otherwise.

Definition at line 684 of file talloc.c.

Here is the caller graph for this function:

◆ talloc_null_ctx()

void* talloc_null_ctx ( void )

Retrieve the current talloc NULL ctx.

Talloc doesn't provide a function to retrieve the top level memory tracking context. This function does that...

Returns: the current talloc NULL context or NULL if memory tracking is not enabled.

Definition at line 49 of file talloc.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ talloc_page_aligned_pool()

TALLOC_CTX* talloc_page_aligned_pool	(	TALLOC_CTX *	ctx,
		void **	start,
		void **	end,
		size_t	size
	)

Return a page aligned talloc memory pool.

Because we can't intercept talloc's malloc() calls, we need to do some tricks in order to get the first allocation in the pool page aligned, and to limit the size of the pool to a multiple of the page size.

The reason for wanting a page aligned talloc pool, is it allows us to mprotect() the pages that belong to the pool.

Talloc chunks appear to be allocated within the protected region, so this should catch frees too.

Parameters

[in]	ctx	to allocate pool memory in.
[out]	start	A page aligned address within the pool. This can be passed to mprotect().
[out]	end	of the pages that should be protected.
[in]	size	How big to make the pool. Will be corrected to a multiple of the page size. The actual pool size will be size rounded to a multiple of the (page_size), + page_size

Definition at line 239 of file talloc.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ talloc_typed_asprintf()

char* talloc_typed_asprintf	(	TALLOC_CTX *	ctx,
		char const *	fmt,
			...
	)

Call talloc vasprintf, setting the type on the new chunk correctly.

For some bizarre reason the talloc string functions don't set the memory chunk type to char, which causes all kinds of issues with verifying fr_pair_ts.

Parameters

[in]	ctx	The talloc context to hang the result off.
[in]	fmt	The format string.

Returns

Formatted string.
NULL on error.

Definition at line 380 of file talloc.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ talloc_typed_memdup()

uint8_t* talloc_typed_memdup	(	TALLOC_CTX *	ctx,
		uint8_t const *	in,
		size_t	inlen
	)

Call talloc_memdup, setting the type on the new chunk correctly.

Parameters

[in]	ctx	The talloc context to hang the result off.
[in]	in	The data you want to duplicate.
[in]	inlen	the length of the data to be duplicated.

Returns

Duplicated data.
NULL on error.

Definition at line 308 of file talloc.c.

◆ talloc_typed_strdup()

char* talloc_typed_strdup	(	TALLOC_CTX *	ctx,
		char const *	p
	)

Call talloc_strdup, setting the type on the new chunk correctly.

For some bizarre reason the talloc string functions don't set the memory chunk type to char, which causes all kinds of issues with verifying fr_pair_ts.

Parameters

[in]	ctx	The talloc context to hang the result off.
[in]	p	The string you want to duplicate.

Returns

Duplicated string.
NULL on error.

Definition at line 333 of file talloc.c.

◆ talloc_typed_strdup_buffer()

char* talloc_typed_strdup_buffer	(	TALLOC_CTX *	ctx,
		char const *	p
	)

Call talloc_strndup, setting the type on the new chunk correctly.

This function is similar to talloc_typed_strdup but gets the chunk length using talloc functions.

Parameters

[in]	ctx	The talloc context to hang the result off.
[in]	p	The string you want to duplicate.

Returns

Duplicated string.
NULL on error.

Definition at line 357 of file talloc.c.

Here is the caller graph for this function:

◆ talloc_typed_vasprintf()

char* talloc_typed_vasprintf	(	TALLOC_CTX *	ctx,
		char const *	fmt,
		va_list	ap
	)

Call talloc vasprintf, setting the type on the new chunk correctly.

For some bizarre reason the talloc string functions don't set the memory chunk type to char, which causes all kinds of issues with verifying fr_pair_ts.

Parameters

[in]	ctx	The talloc context to hang the result off.
[in]	fmt	The format string.
[in]	ap	varadic arguments.

Returns

Formatted string.
NULL on error.

Definition at line 407 of file talloc.c.

Here is the caller graph for this function:

Variable Documentation

◆ global_ctx

TALLOC_CTX* global_ctx

static

Definition at line 32 of file talloc.c.

◆ thread_local_ctx

_Thread_local TALLOC_CTX* thread_local_ctx

static

Definition at line 33 of file talloc.c.

Data Structures

Functions

Variables

Detailed Description

Data Structure Documentation

◆ talloc_child_ctx_s

Function Documentation

◆ _autofree_global_destructor()

◆ _autofree_on_exit()

◆ _autofree_thread_local_destructor()

◆ _child_ctx_free()

◆ _talloc_destructor_disarm()

◆ _talloc_destructor_fire()

◆ _talloc_link_ctx_free()

◆ talloc_aligned_array()

◆ talloc_array_concat()

◆ talloc_array_null_strip()

◆ talloc_array_null_terminate()

◆ talloc_autofree_context_global()

◆ talloc_autofree_context_thread_local()

◆ talloc_bstr_append()

◆ talloc_bstr_realloc()

◆ talloc_bstrdup()

◆ talloc_bstrndup()

◆ talloc_buffer_append_buffer()

◆ talloc_buffer_append_variadic_buffer()

◆ talloc_child_ctx_alloc()

◆ talloc_child_ctx_init()

◆ talloc_decrease_ref_count()

◆ talloc_destructor_add()

◆ talloc_destructor_disarm()

◆ talloc_free_data()

◆ talloc_link_ctx()

◆ talloc_memcmp_array()

◆ talloc_memcmp_bstr()

◆ talloc_null_ctx()

◆ talloc_page_aligned_pool()

◆ talloc_typed_asprintf()

◆ talloc_typed_memdup()

◆ talloc_typed_strdup()

◆ talloc_typed_strdup_buffer()

◆ talloc_typed_vasprintf()

Variable Documentation

◆ global_ctx

◆ thread_local_ctx