interpret.c File Reference

Execute compiled unlang structures using an iterative interpret. More...

#include <freeradius-devel/server/base.h>
#include <freeradius-devel/server/modpriv.h>
#include <freeradius-devel/unlang/xlat_func.h>
#include "interpret_priv.h"
#include "module_priv.h"
#include "parallel_priv.h"

Include dependency graph for interpret.c:

Go to the source code of this file.

Data Structures
struct	unlang_variable_ref_t

Macros
#define	DUMP_STACK   if (DEBUG_ENABLED5) stack_dump(request)
#define	UNWIND_FLAG_DUMP(attrib)    if (unwind & attrib) strcat(buf, #attrib" ")

Functions
static int	_local_variables_free (unlang_variable_ref_t *ref)
static void	frame_dump (request_t *request, unlang_stack_frame_t *frame)
static unlang_frame_action_t	frame_eval (request_t *request, unlang_stack_frame_t *frame, rlm_rcode_t *result, int *priority)
	Evaluates all the unlang nodes in a section.
static void	instruction_dump (request_t *request, unlang_t const *instruction)
static void	instruction_retry_handler (UNUSED fr_timer_list_t *tl, UNUSED fr_time_t now, void *ctx)
static void	instruction_timeout_handler (UNUSED fr_timer_list_t *tl, UNUSED fr_time_t now, void *ctx)
static unlang_frame_action_t	result_calculate (request_t *request, unlang_stack_frame_t *frame, rlm_rcode_t *result, int *priority)
	Update the current result after each instruction, and after popping each stack frame.
static void	stack_dump (request_t *request)
static char *	stack_unwind_flag_dump (uint8_t unwind)
static void	unlang_cancel_event (UNUSED fr_timer_list_t *tl, UNUSED fr_time_t now, void *uctx)
	Signal the request to stop executing.
static xlat_action_t	unlang_cancel_never_run (UNUSED TALLOC_CTX *ctx, UNUSED fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, UNUSED request_t *request, UNUSED fr_value_box_list_t *in)
static xlat_action_t	unlang_cancel_xlat (TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *args)
	Allows a request to dynamically alter its own lifetime.
void	unlang_frame_signal (request_t *request, fr_signal_t action, int limit)
	Send a signal (usually stop) to a request.
void	unlang_interpet_frame_discard (request_t *request)
	Discard the bottom most frame on the request's stack.
rlm_rcode_t	unlang_interpret (request_t *request, bool running)
	Run the interpreter for a current request.
fr_event_list_t *	unlang_interpret_event_list (request_t *request)
	Get the event list for the current interpreter.
TALLOC_CTX *	unlang_interpret_frame_talloc_ctx (request_t *request)
	Get a talloc_ctx which is valid only for this frame.
unlang_interpret_t *	unlang_interpret_get (request_t *request)
	Get the interpreter set for a request.
unlang_interpret_t *	unlang_interpret_get_thread_default (void)
	Get the default interpreter for this thread.
unlang_interpret_t *	unlang_interpret_init (TALLOC_CTX *ctx, fr_event_list_t *el, unlang_request_func_t *funcs, void *uctx)
	Initialize a unlang compiler / interpret.
int	unlang_interpret_init_global (TALLOC_CTX *ctx)
bool	unlang_interpret_is_resumable (request_t *request)
	Check if a request as resumable.
void	unlang_interpret_mark_runnable (request_t *request)
	Mark a request as resumable.
int	unlang_interpret_push (request_t *request, unlang_t const *instruction, rlm_rcode_t default_rcode, bool do_next_sibling, bool top_frame)
	Push a new frame onto the stack.
unlang_action_t	unlang_interpret_push_children (rlm_rcode_t *p_result, request_t *request, rlm_rcode_t default_rcode, bool do_next_sibling)
	Push the children of the current frame onto a new frame onto the stack.
int	unlang_interpret_push_instruction (request_t *request, void *instruction, rlm_rcode_t default_rcode, bool top_frame)
	Push an instruction onto the request stack for later interpretation.
int	unlang_interpret_push_section (request_t *request, CONF_SECTION *cs, rlm_rcode_t default_rcode, bool top_frame)
	Push a configuration section onto the request stack for later interpretation.
static void	unlang_interpret_request_detach (request_t *request)
void	unlang_interpret_request_done (request_t *request)
	Indicate to the caller of the interpreter that this request is complete.
static void	unlang_interpret_request_stop (request_t *request)
void	unlang_interpret_set (request_t *request, unlang_interpret_t *intp)
	Set a specific interpreter for a request.
void	unlang_interpret_set_thread_default (unlang_interpret_t *intp)
	Set the default interpreter for this thread.
int	unlang_interpret_set_timeout (request_t *request, fr_time_delta_t timeout)
	Set a timeout for a request.
void	unlang_interpret_signal (request_t *request, fr_signal_t action)
	Send a signal (usually stop) to a request.
void *	unlang_interpret_stack_alloc (TALLOC_CTX *ctx)
	Allocate a new unlang stack.
int	unlang_interpret_stack_depth (request_t *request)
	Return the depth of the request's stack.
rlm_rcode_t	unlang_interpret_stack_result (request_t *request)
	Get the current rcode for the frame.
void	unlang_interpret_stack_result_set (request_t *request, rlm_rcode_t rcode)
	Overwrite the current stack rcode.
static xlat_action_t	unlang_interpret_xlat (TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *in)
	Get information about the interpreter state.
bool	unlang_request_is_cancelled (request_t const *request)
	Return whether a request has been cancelled.
bool	unlang_request_is_done (request_t const *request)
	Return whether a request has been marked done.
bool	unlang_request_is_scheduled (request_t const *request)
	Return whether a request is currently scheduled.

Variables
static unlang_group_t	empty_group
static _Thread_local unlang_interpret_t *	intp_thread_default
	The default interpreter instance for this thread.
static fr_table_num_ordered_t const	unlang_action_table []
static size_t	unlang_action_table_len = NUM_ELEMENTS(unlang_action_table)
static xlat_arg_parser_t const	unlang_cancel_xlat_args []
static fr_table_num_ordered_t const	unlang_frame_action_table []
static size_t	unlang_frame_action_table_len = NUM_ELEMENTS(unlang_frame_action_table)
static xlat_arg_parser_t const	unlang_interpret_xlat_args []

Detailed Description

Execute compiled unlang structures using an iterative interpret.

Id

9e6ce1db6aa50fa277b24c4aaa324b92343ed9dd

Copyright

2006-2016 The FreeRADIUS server project

Definition in file interpret.c.

---

Data Structure Documentation

unlang_variable_ref_t

struct unlang_variable_ref_t

Definition at line 214 of file interpret.c.

Collaboration diagram for unlang_variable_ref_t:

Data Fields
fr_dict_t const *	old_dict	the previous dictionary for the request
request_t *	request	the request

Macro Definition Documentation

DUMP_STACK

#define DUMP_STACK   if (DEBUG_ENABLED5) stack_dump(request)

Definition at line 141 of file interpret.c.

UNWIND_FLAG_DUMP

#define UNWIND_FLAG_DUMP

(

attrib

)

if (unwind & attrib) strcat(buf, #attrib" ")

Function Documentation

_local_variables_free()

static int _local_variables_free ( unlang_variable_ref_t *  ref )

static

Definition at line 219 of file interpret.c.

Here is the call graph for this function:

Here is the caller graph for this function:

frame_dump()

static void frame_dump ( request_t *  request, unlang_stack_frame_t *  frame  )

static

Definition at line 73 of file interpret.c.

Here is the call graph for this function:

Here is the caller graph for this function:

frame_eval()

static unlang_frame_action_t frame_eval ( request_t *  request, unlang_stack_frame_t *  frame, rlm_rcode_t *  result, int *  priority  )

inlinestatic

Evaluates all the unlang nodes in a section.

Parameters

[in]	request	The current request.
[in]	frame	The current stack frame.
[in,out]	result	The current section result.
[in,out]	priority	The current section priority.

Returns

• UNLANG_FRAME_ACTION_NEXT evaluate more instructions in the current stack frame which may not be the same frame as when this function was called.
• UNLANG_FRAME_ACTION_POP the final result has been calculated for this frame.

Definition at line 539 of file interpret.c.

Here is the call graph for this function:

Here is the caller graph for this function:

instruction_dump()

static void instruction_dump ( request_t *  request, unlang_t const *  instruction  )

static

Definition at line 58 of file interpret.c.

Here is the caller graph for this function:

instruction_retry_handler()

static void instruction_retry_handler ( UNUSED fr_timer_list_t *  tl, UNUSED fr_time_t  now, void *  ctx  )

static

Definition at line 1272 of file interpret.c.

Here is the call graph for this function:

Here is the caller graph for this function:

instruction_timeout_handler()

static void instruction_timeout_handler ( UNUSED fr_timer_list_t *  tl, UNUSED fr_time_t  now, void *  ctx  )

static

Definition at line 1288 of file interpret.c.

Here is the call graph for this function:

Here is the caller graph for this function:

result_calculate()

static unlang_frame_action_t result_calculate ( request_t *  request, unlang_stack_frame_t *  frame, rlm_rcode_t *  result, int *  priority  )

inlinestatic

Update the current result after each instruction, and after popping each stack frame.

Parameters

[in]	request	The current request.
[in]	frame	The current stack frame.
[in,out]	result	The current section result.
[in,out]	priority	The current section priority.

Returns

• UNLANG_FRAME_ACTION_NEXT evaluate more instructions.
• UNLANG_FRAME_ACTION_POP the final result has been calculated for this frame.

Definition at line 320 of file interpret.c.

Here is the call graph for this function:

Here is the caller graph for this function:

stack_dump()

static void stack_dump ( request_t *  request )

static

Definition at line 127 of file interpret.c.

Here is the call graph for this function:

stack_unwind_flag_dump()

static char * stack_unwind_flag_dump ( uint8_t  unwind )

static

Definition at line 104 of file interpret.c.

Here is the call graph for this function:

Here is the caller graph for this function:

unlang_cancel_event()

static void unlang_cancel_event ( UNUSED fr_timer_list_t *  tl, UNUSED fr_time_t  now, void *  uctx  )

static

Signal the request to stop executing.

The request can't be running at this point because we're in the event loop. This means the request is always in a consistent state when the timeout event fires, even if that's state is waiting on I/O.

Definition at line 1492 of file interpret.c.

Here is the call graph for this function:

Here is the caller graph for this function:

unlang_cancel_never_run()

static xlat_action_t unlang_cancel_never_run ( UNUSED TALLOC_CTX *  ctx, UNUSED fr_dcursor_t *  out, UNUSED xlat_ctx_t const *  xctx, UNUSED request_t *  request, UNUSED fr_value_box_list_t *  in  )

static

Definition at line 1506 of file interpret.c.

Here is the caller graph for this function:

unlang_cancel_xlat()

static xlat_action_t unlang_cancel_xlat ( TALLOC_CTX *  ctx, fr_dcursor_t *  out, UNUSED xlat_ctx_t const *  xctx, request_t *  request, fr_value_box_list_t *  args  )

static

Allows a request to dynamically alter its own lifetime.

cancel(<timeout>)

If timeout is 0, then the request is immediately cancelled.

Definition at line 1520 of file interpret.c.

Here is the call graph for this function:

Here is the caller graph for this function:

unlang_frame_signal()

void unlang_frame_signal	(	request_t *	request,
		fr_signal_t	action,
		int	limit
	)

Send a signal (usually stop) to a request.

This is typically called via an "async" action, i.e. an action outside of the normal processing of the request.

If there is no unlang_module_signal_t callback defined, the action is ignored.

The signaling stops at the "limit" frame. This is so that keywords such as "timeout" and "limit" can signal frames lower than theirs to stop, but then continue with their own work.

Parameters

[in]	request	The current request.
[in]	action	to signal.
[in]	limit	the frame at which to stop signaling.

Definition at line 1158 of file interpret.c.

Here is the call graph for this function:

Here is the caller graph for this function:

unlang_interpet_frame_discard()

void unlang_interpet_frame_discard

(

request_t *

request

)

Discard the bottom most frame on the request's stack.

This is used for cleaning up after errors. i.e. the caller uses a push function, and experiences an error and needs to remove the frame that was just pushed.

Definition at line 1795 of file interpret.c.

Here is the call graph for this function:

Here is the caller graph for this function:

unlang_interpret()

rlm_rcode_t unlang_interpret	(	request_t *	request,
		bool	running
	)

Run the interpreter for a current request.

Parameters

[in]	request	to run. If this is an internal request the request may be freed by the interpreter.
[in]	running	Is the interpreter already running.

Returns

The final request rcode.

Definition at line 784 of file interpret.c.

Here is the call graph for this function:

Here is the caller graph for this function:

unlang_interpret_event_list()

fr_event_list_t * unlang_interpret_event_list

(

request_t *

request

)

Get the event list for the current interpreter.

Definition at line 1822 of file interpret.c.

Here is the caller graph for this function:

unlang_interpret_frame_talloc_ctx()

TALLOC_CTX * unlang_interpret_frame_talloc_ctx

(

request_t *

request

)

Get a talloc_ctx which is valid only for this frame.

Parameters

[in]

request

The current request.

Returns

• a TALLOC_CTX which is valid only for this stack frame

Definition at line 1462 of file interpret.c.

Here is the caller graph for this function:

unlang_interpret_get()

unlang_interpret_t * unlang_interpret_get

(

request_t *

request

)

Get the interpreter set for a request.

Definition at line 1812 of file interpret.c.

Here is the caller graph for this function:

unlang_interpret_get_thread_default()

unlang_interpret_t * unlang_interpret_get_thread_default

(

void

)

Get the default interpreter for this thread.

This allows detached requests to be executed asynchronously

Definition at line 1845 of file interpret.c.

Here is the caller graph for this function:

unlang_interpret_init()

unlang_interpret_t * unlang_interpret_init	(	TALLOC_CTX *	ctx,
		fr_event_list_t *	el,
		unlang_request_func_t *	funcs,
		void *	uctx
	)

Initialize a unlang compiler / interpret.

Parameters

[in]	ctx	to bind lifetime of the interpret to. Shouldn't be any free order issues here as the interpret itself has no state. But event loop should be stopped before freeing the interpret.
[in]	el	for any timer or I/O events.
[in]	funcs	Callbacks to used to communicate request state to our owner.
[in]	uctx	Data to pass to callbacks.

Definition at line 1761 of file interpret.c.

Here is the caller graph for this function:

unlang_interpret_init_global()

int unlang_interpret_init_global

(

TALLOC_CTX *

ctx

)

Definition at line 1852 of file interpret.c.

Here is the call graph for this function:

Here is the caller graph for this function:

unlang_interpret_is_resumable()

bool unlang_interpret_is_resumable

(

request_t *

request

)

Check if a request as resumable.

Parameters

[in]

request

The current request.

Returns

• true if the request is resumable (i.e. has yielded)
• false if the request is not resumable (i.e. has not yielded)

Definition at line 1400 of file interpret.c.

Here is the call graph for this function:

Here is the caller graph for this function:

unlang_interpret_mark_runnable()

void unlang_interpret_mark_runnable

(

request_t *

request

)

Mark a request as resumable.

It's not called "unlang_interpret", because it doesn't actually resume the request, it just schedules it for resumption.

Note

that this schedules the request for resumption. It does not immediately start running the request.

Parameters

[in]

request

The current request.

Definition at line 1418 of file interpret.c.

Here is the call graph for this function:

Here is the caller graph for this function:

unlang_interpret_push()

int unlang_interpret_push	(	request_t *	request,
		unlang_t const *	instruction,
		rlm_rcode_t	default_rcode,
		bool	do_next_sibling,
		bool	top_frame
	)

Push a new frame onto the stack.

Parameters

[in]	request	to push the frame onto.
[in]	instruction	One or more unlang_t nodes describing the operations to execute.
[in]	default_rcode	The default result.
[in]	do_next_sibling	Whether to only execute the first node in the unlang_t program or to execute subsequent nodes.
[in]	top_frame	Return out of the unlang interpret when popping this frame. Hands execution back to whatever called the interpret.

Returns

• 0 on success.
• -1 on call stack too deep.

Definition at line 159 of file interpret.c.

Here is the call graph for this function:

Here is the caller graph for this function:

unlang_interpret_push_children()

unlang_action_t unlang_interpret_push_children	(	rlm_rcode_t *	p_result,
		request_t *	request,
		rlm_rcode_t	default_rcode,
		bool	do_next_sibling
	)

Push the children of the current frame onto a new frame onto the stack.

Parameters

[out]	p_result	set to RLM_MOULDE_FAIL if pushing the children fails
[in]	request	to push the frame onto.
[in]	default_rcode	The default result.
[in]	do_next_sibling	Whether to only execute the first node in the unlang_t program or to execute subsequent nodes.

Returns

• UNLANG_ACTION_PUSHED_CHILD on success.
• UNLANG_ACTION_EXECUTE_NEXT do nothing, but just go to the next sibling instruction
• UNLANG_ACTION_STOP_PROCESSING, fatal error, usually stack overflow.

Definition at line 255 of file interpret.c.

Here is the call graph for this function:

Here is the caller graph for this function:

unlang_interpret_push_instruction()

int unlang_interpret_push_instruction	(	request_t *	request,
		void *	instruction,
		rlm_rcode_t	default_rcode,
		bool	top_frame
	)

Push an instruction onto the request stack for later interpretation.

Definition at line 1032 of file interpret.c.

Here is the call graph for this function:

Here is the caller graph for this function:

unlang_interpret_push_section()

int unlang_interpret_push_section	(	request_t *	request,
		CONF_SECTION *	cs,
		rlm_rcode_t	default_rcode,
		bool	top_frame
	)

Push a configuration section onto the request stack for later interpretation.

Definition at line 1009 of file interpret.c.

Here is the call graph for this function:

Here is the caller graph for this function:

unlang_interpret_request_detach()

static void unlang_interpret_request_detach ( request_t *  request )

inlinestatic

Definition at line 1129 of file interpret.c.

Here is the caller graph for this function:

unlang_interpret_request_done()

void unlang_interpret_request_done

(

request_t *

request

)

Indicate to the caller of the interpreter that this request is complete.

Definition at line 1089 of file interpret.c.

Here is the caller graph for this function:

unlang_interpret_request_stop()

static void unlang_interpret_request_stop ( request_t *  request )

inlinestatic

Definition at line 1115 of file interpret.c.

Here is the caller graph for this function:

unlang_interpret_set()

void unlang_interpret_set	(	request_t *	request,
		unlang_interpret_t *	intp
	)

Set a specific interpreter for a request.

Definition at line 1803 of file interpret.c.

Here is the caller graph for this function:

unlang_interpret_set_thread_default()

void unlang_interpret_set_thread_default

(

unlang_interpret_t *

intp

)

Set the default interpreter for this thread.

Definition at line 1834 of file interpret.c.

Here is the caller graph for this function:

unlang_interpret_set_timeout()

int unlang_interpret_set_timeout	(	request_t *	request,
		fr_time_delta_t	timeout
	)

Set a timeout for a request.

The timeout is associated with the current stack frame.

Definition at line 1307 of file interpret.c.

Here is the call graph for this function:

unlang_interpret_signal()

void unlang_interpret_signal	(	request_t *	request,
		fr_signal_t	action
	)

Send a signal (usually stop) to a request.

This is typically called via an "async" action, i.e. an action outside of the normal processing of the request.

If there is no unlang_module_signal_t callback defined, the action is ignored.

Parameters

[in]	request	The current request.
[in]	action	to signal.

Definition at line 1212 of file interpret.c.

Here is the call graph for this function:

Here is the caller graph for this function:

unlang_interpret_stack_alloc()

void * unlang_interpret_stack_alloc

(

TALLOC_CTX *

ctx

)

Allocate a new unlang stack.

Parameters

[in]

ctx

to allocate stack in.

Returns

• A new stack on success.
• NULL on OOM.

Definition at line 1063 of file interpret.c.

Here is the caller graph for this function:

unlang_interpret_stack_depth()

int unlang_interpret_stack_depth

(

request_t *

request

)

Return the depth of the request's stack.

Definition at line 1334 of file interpret.c.

Here is the caller graph for this function:

unlang_interpret_stack_result()

rlm_rcode_t unlang_interpret_stack_result

(

request_t *

request

)

Get the current rcode for the frame.

This can be useful for getting the result of unlang_function_t pushed onto the stack for evaluation.

Parameters

[in]

request

The current request.

Returns

the current rcode for the frame.

Definition at line 1349 of file interpret.c.

Here is the caller graph for this function:

unlang_interpret_stack_result_set()

void unlang_interpret_stack_result_set	(	request_t *	request,
		rlm_rcode_t	rcode
	)

Overwrite the current stack rcode.

Parameters

[in]	request	The current request.
[in]	rcode	to set.

Definition at line 1361 of file interpret.c.

Here is the caller graph for this function:

unlang_request_is_cancelled()

bool unlang_request_is_cancelled

(

request_t const *

request

)

Return whether a request has been cancelled.

Definition at line 1381 of file interpret.c.

unlang_request_is_done()

bool unlang_request_is_done

(

request_t const *

request

)

Return whether a request has been marked done.

Definition at line 1388 of file interpret.c.

Here is the caller graph for this function:

unlang_request_is_scheduled()

bool unlang_request_is_scheduled

(

request_t const *

request

)

Return whether a request is currently scheduled.

Definition at line 1371 of file interpret.c.

Here is the caller graph for this function:

Variable Documentation

empty_group

unlang_group_t empty_group

static

Initial value:

= {
        .self = {
                .type = UNLANG_TYPE_GROUP,
                .debug_name = "empty-group",
                .actions = {
                        .actions = {
                                MOD_ACTION_RETURN,
                                MOD_ACTION_RETURN,
                                MOD_ACTION_RETURN,
                                MOD_ACTION_RETURN,
                                MOD_ACTION_RETURN,
                                MOD_ACTION_RETURN,
                                MOD_ACTION_RETURN,
                                MOD_ACTION_RETURN,
                                MOD_ACTION_RETURN
                        },
                        .retry = RETRY_INIT,
                },
        },
}

Definition at line 985 of file interpret.c.

intp_thread_default

_Thread_local unlang_interpret_t* intp_thread_default

static

The default interpreter instance for this thread.

Definition at line 38 of file interpret.c.

unlang_action_table

fr_table_num_ordered_t const unlang_action_table[]

static

Initial value:

= {
        { L("unwind"),                  UNLANG_ACTION_UNWIND },
        { L("calculate-result"),        UNLANG_ACTION_CALCULATE_RESULT },
        { L("next"),                    UNLANG_ACTION_EXECUTE_NEXT },
        { L("pushed-child"),            UNLANG_ACTION_PUSHED_CHILD },
        { L("stop"),                    UNLANG_ACTION_STOP_PROCESSING },
        { L("yield"),                   UNLANG_ACTION_YIELD }
}

Definition at line 40 of file interpret.c.

unlang_action_table_len

size_t unlang_action_table_len = NUM_ELEMENTS(unlang_action_table)

static

Definition at line 48 of file interpret.c.

unlang_cancel_xlat_args

xlat_arg_parser_t const unlang_cancel_xlat_args[]

static

Initial value:

= {
        { .required = false, .single = true, .type = FR_TYPE_TIME_DELTA },
        XLAT_ARG_PARSER_TERMINATOR
}

Definition at line 1477 of file interpret.c.

unlang_frame_action_table

fr_table_num_ordered_t const unlang_frame_action_table[]

static

Initial value:

= {
        { L("pop"),                     UNLANG_FRAME_ACTION_POP         },
        { L("next"),                    UNLANG_FRAME_ACTION_NEXT        },
        { L("yield"),                   UNLANG_FRAME_ACTION_YIELD       }
}

Definition at line 50 of file interpret.c.

unlang_frame_action_table_len

size_t unlang_frame_action_table_len = NUM_ELEMENTS(unlang_frame_action_table)

static

Definition at line 55 of file interpret.c.

unlang_interpret_xlat_args

xlat_arg_parser_t const unlang_interpret_xlat_args[]

static

Initial value:

= {
        { .required = true, .single = true, .type = FR_TYPE_STRING },
        XLAT_ARG_PARSER_TERMINATOR
}

Definition at line 1593 of file interpret.c.