subrequest.h File Reference

#include <freeradius-devel/server/request.h>
#include <freeradius-devel/server/rcode.h>
#include <freeradius-devel/unlang/interpret.h>
#include <stdbool.h>

Include dependency graph for subrequest.h:

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

Go to the source code of this file.

Data Structures
struct	unlang_subrequest_session_t

Functions
request_t *	unlang_subrequest_alloc (request_t *parent, fr_dict_t const *namespace)
	Allocate a subrequest to run through a virtual server at some point in the future.
int	unlang_subrequest_child_push (unlang_result_t *p_result, request_t *child, void const *unique_session_ptr, bool free_child, bool top_frame)
	Push a pre-existing child back onto the stack as a subrequest.
int	unlang_subrequest_child_push_and_detach (request_t *child)
	Add a child request to the runnable queue.
void	unlang_subrequest_detach_and_free (request_t **child)
	Free a child request, detaching it from its parent and freeing allocated memory.

Detailed Description

Id

0c671b4630eccc3ff93e48832eaf33700eb7a69f

Copyright

2019 The FreeRADIUS server project

2021 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 subrequest.h.

---

Data Structure Documentation

unlang_subrequest_session_t

struct unlang_subrequest_session_t

Definition at line 36 of file subrequest.h.

Data Fields
bool	enable	Whether we should store/restore sessions.
int	unique_int	Session unique int identifier.
void const *	unique_ptr	Session unique ptr identifier.

Function Documentation

unlang_subrequest_alloc()

request_t * unlang_subrequest_alloc	(	request_t *	parent,
		fr_dict_t const *	namespace
	)

Allocate a subrequest to run through a virtual server at some point in the future.

Parameters

[in]	parent	to hang sub request off of.
[in]	namespace	the child will operate in.

Returns

• A new child request.
• NULL on failure.

Definition at line 304 of file subrequest.c.

Here is the call graph for this function:

Here is the caller graph for this function:

unlang_subrequest_child_push()

int unlang_subrequest_child_push	(	unlang_result_t *	p_result,
		request_t *	child,
		void const *	unique_session_ptr,
		bool	free_child,
		bool	top_frame
	)

Push a pre-existing child back onto the stack as a subrequest.

The child MUST have been allocated with unlang_io_subrequest_alloc, or something that calls it.

After the child is no longer required it MUST be freed with unlang_subrequest_detach_and_free. It's not enough to free it with talloc_free.

This function should be called before pushing any additional frames onto the child's stack for it to execute.

The parent should return UNLANG_ACTION_PUSHED_CHILD, when it's done setting up the child request. It should NOT return UNLANG_ACTION_YIELD.

Parameters

[in]	p_result	Where to write the result of the subrequest.
[in]	child	to push.
[in]	unique_session_ptr	Unique identifier for child's session data.
[in]	free_child	automatically free the child when it's finished executing. This is useful if extracting the result from the child is done using the child's stack, and so the parent never needs to access it.
[in]	top_frame	Set to UNLANG_TOP_FRAME if the interpreter should return. Set to UNLANG_SUB_FRAME if the interprer should continue.

Returns

• 0 on success.
• -1 on failure.

Definition at line 428 of file subrequest.c.

Here is the call graph for this function:

Here is the caller graph for this function:

unlang_subrequest_child_push_and_detach()

int unlang_subrequest_child_push_and_detach

(

request_t *

request

)

Add a child request to the runnable queue.

Parameters

[in]

request

to add to the runnable queue.

Returns

• 0 on success.
• -1 on failure.

Definition at line 501 of file subrequest.c.

Here is the call graph for this function:

unlang_subrequest_detach_and_free()

void unlang_subrequest_detach_and_free

(

request_t **

child

)

Free a child request, detaching it from its parent and freeing allocated memory.

Parameters

[in]

child

to free.

Definition at line 289 of file subrequest.c.

Here is the call graph for this function:

Here is the caller graph for this function: