function.c File Reference

Unlang "function" keyword evaluation. More...

#include "unlang_priv.h"
#include "function.h"

Include dependency graph for function.c:

Go to the source code of this file.

Data Structures
struct	unlang_frame_state_func_t

Functions
static unlang_action_t	unlang_function_call (rlm_rcode_t *p_result, request_t *request, unlang_stack_frame_t *frame)
	Call a generic function. More...
static unlang_action_t	unlang_function_call_repeat (rlm_rcode_t *p_result, request_t *request, unlang_stack_frame_t *frame)
int	unlang_function_clear (request_t *request)
	Clear pending repeat function calls, and remove the signal handler. More...
static void	unlang_function_dump (request_t *request, unlang_stack_frame_t *frame)
	Custom frame state dumper. More...
void	unlang_function_init (void)
static void	unlang_function_signal (request_t *request, unlang_stack_frame_t *frame, fr_signal_t action)
	Generic signal handler. More...

Variables
static unlang_t	function_instruction
	Static instruction for allowing modules/xlats to call functions within themselves, or submodules. More...

Detailed Description

Unlang "function" keyword evaluation.

Id

4477a947db040f398f29b21d866e4493e7dfbbbd

Copyright

2018,2021 The FreeRADIUS server project

2018,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 function.c.

---

Data Structure Documentation

unlang_frame_state_func_t

struct unlang_frame_state_func_t

Definition at line 34 of file function.c.

Collaboration diagram for unlang_frame_state_func_t:

Data Fields
unlang_function_t	func	To call when going down the stack.
char const *	func_name	Debug name for the function.
unlang_function_t	repeat	To call when going back up the stack.
char const *	repeat_name	Debug name for the repeat function.
fr_signal_t	sigmask	Signals to block.
unlang_function_signal_t	signal	Signal function to call.
char const *	signal_name	Debug name for the signal function.
void *	uctx	Uctx to pass to function.

Function Documentation

unlang_function_call()

static unlang_action_t unlang_function_call ( rlm_rcode_t *  p_result, request_t *  request, unlang_stack_frame_t *  frame  )

static

Call a generic function.

Parameters

[out]	p_result	The frame result.
[in]	request	The current request.
[in]	frame	The current frame.

Definition at line 109 of file function.c.

Here is the call graph for this function:

Here is the caller graph for this function:

unlang_function_call_repeat()

static unlang_action_t unlang_function_call_repeat ( rlm_rcode_t *  p_result, request_t *  request, unlang_stack_frame_t *  frame  )

static

Definition at line 84 of file function.c.

Here is the caller graph for this function:

unlang_function_clear()

int unlang_function_clear

(

request_t *

request

)

Clear pending repeat function calls, and remove the signal handler.

The function frame being modified must be at the top of the stack.

Parameters

[in]

request

The current request.

Returns

• 0 on success.
• -1 on failure.

Definition at line 160 of file function.c.

Here is the call graph for this function:

unlang_function_dump()

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

static

Custom frame state dumper.

Definition at line 327 of file function.c.

Here is the caller graph for this function:

unlang_function_init()

void unlang_function_init

(

void

)

Definition at line 337 of file function.c.

Here is the call graph for this function:

Here is the caller graph for this function:

unlang_function_signal()

static void unlang_function_signal ( request_t *  request, unlang_stack_frame_t *  frame, fr_signal_t  action  )

static

Generic signal handler.

Parameters

[in]	request	being signalled.
[in]	frame	being signalled.
[in]	action	Type of signal.

Definition at line 74 of file function.c.

Here is the caller graph for this function:

Variable Documentation

function_instruction

unlang_t function_instruction

static

Initial value:

= {
        .type = UNLANG_TYPE_FUNCTION,
        .name = "function",
        .debug_name = "function",
        .actions = {
                .actions = {
                        [RLM_MODULE_REJECT]     = 0,
                        [RLM_MODULE_FAIL]       = 0,
                        [RLM_MODULE_OK]         = 0,
                        [RLM_MODULE_HANDLED]    = 0,
                        [RLM_MODULE_INVALID]    = 0,
                        [RLM_MODULE_DISALLOW]   = 0,
                        [RLM_MODULE_NOTFOUND]   = 0,
                        [RLM_MODULE_NOOP]       = 0,
                        [RLM_MODULE_UPDATED]    = 0
                },
                .retry = RETRY_INIT,
        },
}

Static instruction for allowing modules/xlats to call functions within themselves, or submodules.

Definition at line 48 of file function.c.