request.c File Reference

Functions for allocating requests and storing internal data in them. More...

#include <freeradius-devel/server/request.h>
#include <freeradius-devel/server/request_data.h>
#include <freeradius-devel/unlang/interpret.h>
#include <freeradius-devel/util/debug.h>
#include <freeradius-devel/util/atexit.h>

Include dependency graph for request.c:

Go to the source code of this file.

Macros
#define	list_init(_ctx, _list)

Functions
request_t *	_request_alloc (char const *file, int line, TALLOC_CTX *ctx, request_type_t type, request_init_args_t const *args)
	Create a new request_t data structure.
static int	_request_free (request_t *request)
	Callback for freeing a request struct.
static int	_request_free_list_free_on_exit (void *arg)
	Free any free requests when the thread is joined.
static int	_request_global_free (UNUSED void *uctx)
static int	_request_global_init (UNUSED void *uctx)
request_t *	_request_local_alloc (char const *file, int line, TALLOC_CTX *ctx, request_type_t type, request_init_args_t const *args)
	Allocate a request that's not in the free list.
static int	_request_local_free (request_t *request)
static int	_state_ctx_free (fr_pair_t *state)
static request_t *	request_alloc_pool (TALLOC_CTX *ctx)
static int	request_child_init (request_t *child, request_t *parent)
int	request_detach (request_t *child)
	Unlink a subrequest from its parent.
static int	request_detachable_init (request_t *child, request_t *parent)
int	request_global_init (void)
static int	request_init (char const *file, int line, request_t *request, request_type_t type, request_init_args_t const *args)
	Setup logging and other fields for a request.
static void	request_log_init_child (request_t *child, request_t const *parent)
static void	request_log_init_detachable (request_t *child, request_t const *parent)
static void	request_log_init_orphan (request_t *request)
void	request_log_prepend (request_t *request, fr_log_t *log_dst, fr_log_lvl_t lvl)
	Prepend another logging destination to the list.
fr_pair_t *	request_state_replace (request_t *request, fr_pair_t *new_state)
	Replace the session_state_ctx with a new one.

Variables
static request_init_args_t	default_args
static fr_dict_t const *	dict_freeradius
fr_dict_attr_t const *	request_attr_control
fr_dict_attr_t const *	request_attr_local
fr_dict_attr_t const *	request_attr_reply
fr_dict_attr_t const *	request_attr_request
fr_dict_attr_t const *	request_attr_root
fr_dict_attr_t const *	request_attr_state
fr_dict_autoload_t	request_dict []
fr_dict_attr_autoload_t	request_dict_attr []
static _Thread_local fr_dlist_head_t *	request_free_list
	The thread local free list.

Detailed Description

Functions for allocating requests and storing internal data in them.

Id

91cfebee5ad5df016cc62e07cc05f50d46f556a1

Copyright

2015 The FreeRADIUS server project

Definition in file request.c.

Macro Definition Documentation

list_init

#define list_init	(		_ctx,
			_list
	)

Value:

        do { \
                vp = fr_pair_afrom_da(_ctx, request_attr_##_list); \
                if (unlikely(!vp)) { \
                        talloc_free(pair_root); \
                        memset(&request->pair_list, 0, sizeof(request->pair_list)); \
                        return -1; \
                } \
                fr_pair_append(&pair_root->children, vp); \
                request->pair_list._list = vp; \
        } while(0)

Function Documentation

_request_alloc()

request_t * _request_alloc	(	char const *	file,
		int	line,
		TALLOC_CTX *	ctx,
		request_type_t	type,
		request_init_args_t const *	args
	)

Create a new request_t data structure.

Parameters

[in]	file	where the request was allocated.
[in]	line	where the request was allocated.
[in]	ctx	to bind the request to.
[in]	type	what type of request to alloc.
[in]	args	Optional arguments.

Returns

• A request on success.
• NULL on error.

Definition at line 501 of file request.c.

Here is the call graph for this function:

_request_free()

static int _request_free ( request_t *  request )

static

Callback for freeing a request struct.

Parameters

[in]

request

to free or return to the free list.

Returns

• 0 in the request was freed.
• -1 if the request was inserted into the free list.

Definition at line 362 of file request.c.

Here is the call graph for this function:

Here is the caller graph for this function:

_request_free_list_free_on_exit()

static int _request_free_list_free_on_exit ( void *  arg )

static

Free any free requests when the thread is joined.

Definition at line 450 of file request.c.

Here is the call graph for this function:

Here is the caller graph for this function:

_request_global_free()

static int _request_global_free ( UNUSED void *  uctx )

static

Definition at line 702 of file request.c.

Here is the caller graph for this function:

_request_global_init()

static int _request_global_init ( UNUSED void *  uctx )

static

Definition at line 708 of file request.c.

Here is the call graph for this function:

Here is the caller graph for this function:

_request_local_alloc()

request_t * _request_local_alloc	(	char const *	file,
		int	line,
		TALLOC_CTX *	ctx,
		request_type_t	type,
		request_init_args_t const *	args
	)

Allocate a request that's not in the free list.

This can be useful if modules need a persistent request for their own purposes which needs to be outside of the normal free list, so that it can be freed when the module requires, not when the thread destructor runs.

Definition at line 608 of file request.c.

Here is the call graph for this function:

_request_local_free()

static int _request_local_free ( request_t *  request )

static

Definition at line 564 of file request.c.

Here is the call graph for this function:

Here is the caller graph for this function:

_state_ctx_free()

static int _state_ctx_free ( fr_pair_t *  state )

static

Definition at line 69 of file request.c.

Here is the caller graph for this function:

request_alloc_pool()

static request_t * request_alloc_pool ( TALLOC_CTX *  ctx )

inlinestatic

Definition at line 462 of file request.c.

Here is the caller graph for this function:

request_child_init()

static int request_child_init ( request_t *  child, request_t *  parent  )

inlinestatic

Definition at line 198 of file request.c.

Here is the call graph for this function:

Here is the caller graph for this function:

request_detach()

int request_detach

(

request_t *

child

)

Unlink a subrequest from its parent.

Note

This should be used for requests in preparation for freeing them.

Parameters

[in]

child

request to unlink.

Returns

• 0 on success.
• -1 on failure.

Definition at line 668 of file request.c.

Here is the call graph for this function:

Here is the caller graph for this function:

request_detachable_init()

static int request_detachable_init ( request_t *  child, request_t *  parent  )

inlinestatic

Definition at line 185 of file request.c.

Here is the caller graph for this function:

request_global_init()

int request_global_init

(

void

)

Definition at line 722 of file request.c.

Here is the call graph for this function:

Here is the caller graph for this function:

request_init()

static int request_init ( char const *  file, int  line, request_t *  request, request_type_t  type, request_init_args_t const *  args  )

inlinestatic

Setup logging and other fields for a request.

Parameters

[in]	file	the request was allocated in.
[in]	line	the request was allocated on.
[in]	request	to (re)-initialise.
[in]	type	of request to initialise.
[in]	args	Other optional arguments.

Definition at line 242 of file request.c.

Here is the call graph for this function:

Here is the caller graph for this function:

request_log_init_child()

static void request_log_init_child ( request_t *  child, request_t const *  parent  )

inlinestatic

Definition at line 162 of file request.c.

Here is the caller graph for this function:

request_log_init_detachable()

static void request_log_init_detachable ( request_t *  child, request_t const *  parent  )

inlinestatic

Definition at line 173 of file request.c.

Here is the call graph for this function:

Here is the caller graph for this function:

request_log_init_orphan()

static void request_log_init_orphan ( request_t *  request )

inlinestatic

Definition at line 77 of file request.c.

Here is the call graph for this function:

Here is the caller graph for this function:

request_log_prepend()

void request_log_prepend	(	request_t *	request,
		fr_log_t *	log_dst,
		fr_log_lvl_t	lvl
	)

Prepend another logging destination to the list.

Parameters

request	the request
log_dst	the logging destination
lvl	the new request debug lvl

Definition at line 100 of file request.c.

Here is the call graph for this function:

Here is the caller graph for this function:

request_state_replace()

fr_pair_t * request_state_replace	(	request_t *	request,
		fr_pair_t *	new_state
	)

Replace the session_state_ctx with a new one.

NOTHING should rewrite request->session_state_ctx.

It's now a pair, and is stored in request->pair_root. So it's wrong for anyone other than this function to play games with it.

Parameters

[in]	request	to replace the state of.
[in]	new_state	state to assign to the request. May be NULL in which case a new_state state will be alloced and assigned.

Returns

the fr_pair_t containing the old state list.

Definition at line 637 of file request.c.

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

default_args

request_init_args_t default_args

static

Definition at line 34 of file request.c.

dict_freeradius

fr_dict_t const* dict_freeradius

static

Definition at line 36 of file request.c.

request_attr_control

fr_dict_attr_t const* request_attr_control

Definition at line 47 of file request.c.

request_attr_local

fr_dict_attr_t const* request_attr_local

Definition at line 49 of file request.c.

request_attr_reply

fr_dict_attr_t const* request_attr_reply

Definition at line 46 of file request.c.

request_attr_request

fr_dict_attr_t const* request_attr_request

Definition at line 45 of file request.c.

request_attr_root

fr_dict_attr_t const* request_attr_root

Definition at line 44 of file request.c.

request_attr_state

fr_dict_attr_t const* request_attr_state

Definition at line 48 of file request.c.

request_dict

fr_dict_autoload_t request_dict

Initial value:

= {
        { .out = &dict_freeradius, .proto = "freeradius" },
        { NULL }
}

Definition at line 39 of file request.c.

request_dict_attr

fr_dict_attr_autoload_t request_dict_attr

Initial value:

= {
        { .out = &request_attr_root, .name = "root", .type = FR_TYPE_GROUP, .dict = &dict_freeradius },
        { .out = &request_attr_request, .name = "request", .type = FR_TYPE_GROUP, .dict = &dict_freeradius },
        { .out = &request_attr_reply, .name = "reply", .type = FR_TYPE_GROUP, .dict = &dict_freeradius },
        { .out = &request_attr_control, .name = "control", .type = FR_TYPE_GROUP, .dict = &dict_freeradius },
        { .out = &request_attr_state, .name = "session-state", .type = FR_TYPE_GROUP, .dict = &dict_freeradius },
        { .out = &request_attr_local, .name = "local-variables", .type = FR_TYPE_GROUP, .dict = &dict_freeradius },
        { NULL }
}

Definition at line 52 of file request.c.

request_free_list

_Thread_local fr_dlist_head_t* request_free_list

static

The thread local free list.

Any entries remaining in the list will be freed when the thread is joined

Definition at line 66 of file request.c.