The FreeRADIUS server  $Id: 15bac2a4c627c01d1aa2047687b3418955ac7f00 $
Data Structures | Macros | Typedefs | Enumerations | Functions
module.h File Reference

Interface to the FreeRADIUS module system. More...

#include <freeradius-devel/server/module_ctx.h>
#include <freeradius-devel/server/rcode.h>
#include <freeradius-devel/server/request.h>
#include <freeradius-devel/features.h>
#include <freeradius-devel/io/schedule.h>
#include <freeradius-devel/server/cf_util.h>
#include <freeradius-devel/server/dl_module.h>
#include <freeradius-devel/server/exfile.h>
#include <freeradius-devel/server/pool.h>
#include <freeradius-devel/server/section.h>
#include <freeradius-devel/unlang/action.h>
#include <freeradius-devel/unlang/call_env.h>
#include <freeradius-devel/unlang/mod_action.h>
#include <freeradius-devel/util/event.h>
+ Include dependency graph for module.h:

Go to the source code of this file.

Data Structures

struct  module_data_pool_t
 
struct  module_instance_s
 Per instance data. More...
 
struct  module_list_s
 A list of modules. More...
 
struct  module_method_binding_s
 Named methods exported by a module. More...
 
struct  module_s
 Struct exported by a rlm_* module. More...
 
struct  module_state_func_table_s
 Map string values to module state method. More...
 
struct  module_thread_instance_s
 Per thread per instance data. More...
 

Macros

#define MODULE_BINDING_TERMINATOR   { .section = NULL }
 Terminate a module binding list. More...
 
#define MODULE_INSTANCE_LEN_MAX   256
 The maximum size of a module instance. More...
 

Typedefs

typedef int(* module_detach_t) (module_detach_ctx_t const *inst)
 Module detach callback. More...
 
typedef struct module_instance_s module_instance_t
 
typedef int(* module_instantiate_t) (module_inst_ctx_t const *mctx)
 Module instantiation callback. More...
 
typedef struct module_list_s module_list_t
 
typedef module_thread_instance_t *(* module_list_thread_data_get_t) (module_instance_t const *mi)
 Callback to retrieve thread-local data for a module. More...
 
typedef struct module_list_type_s module_list_type_t
 
typedef struct module_method_binding_s module_method_binding_t
 
typedef unlang_action_t(* module_method_t) (rlm_rcode_t *p_result, module_ctx_t const *mctx, request_t *request)
 Module section callback. More...
 
typedef struct module_state_func_table_s module_state_func_table_t
 
typedef struct module_s module_t
 
typedef int(* module_thread_detach_t) (module_thread_inst_ctx_t const *mctx)
 Module thread destruction callback. More...
 
typedef struct module_thread_instance_s module_thread_instance_t
 
typedef int(* module_thread_instantiate_t) (module_thread_inst_ctx_t const *mctx)
 Module thread creation callback. More...
 

Enumerations

enum  module_flags_t {
  MODULE_TYPE_THREAD_UNSAFE = (1 << 0) ,
  MODULE_TYPE_RETRY = (1 << 2) ,
  MODULE_TYPE_DYNAMIC_UNSAFE = (1 << 3)
}
 
enum  module_instance_state_t {
  MODULE_INSTANCE_BOOTSTRAPPED = (1 << 1) ,
  MODULE_INSTANCE_INSTANTIATED = (1 << 2) ,
  MODULE_INSTANCE_NO_THREAD_INSTANTIATE = (1 << 3)
}
 What state the module instance is currently in. More...
 

Functions

module_list_tmodule_list_alloc (TALLOC_CTX *ctx, module_list_type_t const *type, char const *name, bool write_protect))
 Allocate a new module list. More...
 
void modules_init (char const *lib_dir)
 Perform global initialisation for modules. More...
 

Module and module thread initialisation and instantiation

int module_bootstrap (module_instance_t *mi)
 Manually complete module bootstrap by calling its instantiate function. More...
 
module_instance_tmodule_instance_alloc (module_list_t *ml, module_instance_t const *parent, dl_module_type_t type, char const *mod_name, char const *inst_name, module_instance_state_t init_state))
 Allocate a new module and add it to a module list for later bootstrap/instantiation. More...
 
bool const module_instance_allowed_chars [UINT8_MAX+1]
 Chars that are allowed in a module instance name. More...
 
module_instance_tmodule_instance_copy (module_list_t *dst, module_instance_t const *src, char const *inst_name))
 Duplicate a module instance, placing it in a new module list. More...
 
fr_slen_t module_instance_name_valid (char const *inst_name)
 Check to see if a module instance name is valid. More...
 
int module_instantiate (module_instance_t *mi)
 Manually complete module setup by calling its instantiate function. More...
 
int module_thread_instantiate (TALLOC_CTX *ctx, module_instance_t *mi, fr_event_list_t *el)
 Allocate thread-local instance data for a module. More...
 
int modules_bootstrap (module_list_t const *ml)
 Bootstrap any modules which have not been bootstrapped already. More...
 
int modules_instantiate (module_list_t const *ml)
 Completes instantiation of modules. More...
 
void modules_thread_detach (module_list_t *ml)
 Remove thread-specific data for a given module list. More...
 
int modules_thread_instantiate (TALLOC_CTX *ctx, module_list_t const *ml, fr_event_list_t *el)
 Creates per-thread instance data for modules which need it. More...
 

Module list variants

These are passed to the module_list_alloc function to allocate lists of different types

Global module lists are used for backend modules, listeners, and process state machines.

Thread-local lists are usually runtime instantiated variants of modules, or modules that represent client connections.

One major difference (from the module's perspective) is that bootstrap is not called for thread-local modules.

module_list_type_t const module_list_type_global
 Initialise a global module, with thread-specific data. More...
 
module_list_type_t const module_list_type_thread_local
 Initialise a thread-local module, which is only used in a single thread. More...
 

Callbacks for the conf_parser_t

int module_submodule_parse (UNUSED TALLOC_CTX *ctx, void *out, void *parent, CONF_ITEM *ci, UNUSED conf_parser_t const *rule)
 

Debugging functions

void module_instance_debug (module_instance_t const *mi)
 Print debugging information for a module. More...
 
void module_list_debug (module_list_t const *ml)
 Print the contents of a module list. More...
 

Toggle protection on module instance data

This is used for module lists which implement additional instantiation phases (like li->open).

It should NOT be used by modules to hack around instance data being read-only after instantiation completes.

int module_instance_data_protect (module_instance_t const *mi)
 Mark module data as read only. More...
 
int module_instance_data_unprotect (module_instance_t const *mi)
 Mark module data as read/write. More...
 

Module and module thread lookup

module_instance_tmodule_instance_by_data (module_list_t const *ml, void const *data)
 Find an existing module instance by its private instance data. More...
 
module_instance_tmodule_instance_by_name (module_list_t const *ml, module_instance_t const *parent, char const *asked_name))
 Find an existing module instance by its name and parent. More...
 
int module_instance_conf_parse (module_instance_t *mi, CONF_SECTION *conf)
 Covert a CONF_SECTION into parsed module instance data. More...
 
fr_slen_t module_instance_name_from_conf (char const **name, CONF_SECTION *conf)
 Avoid boilerplate when setting the module instance name. More...
 
module_instance_tmodule_instance_root (module_instance_t const *child)
 Find the module's shallowest parent. More...
 
char const * module_instance_root_prefix_str (module_instance_t const *mi)
 Return the prefix string for the deepest module. More...
 
static module_thread_instance_tmodule_thread (module_instance_t const *mi)
 Retrieve module/thread specific instance for a module. More...
 
module_thread_instance_tmodule_thread_by_data (module_list_t const *ml, void const *data)
 Retrieve module/thread specific instance data for a module. More...
 

Control which phases are skipped (if any)

bool module_instance_skip_bootstrap (module_instance_t *mi)
 Should we bootstrap this module instance? More...
 
bool module_instance_skip_instantiate (module_instance_t *mi)
 Should we instantiate this module instance? More...
 
bool module_instance_skip_thread_instantiate (module_instance_t *mi)
 Should we instantiate this module instance in a new thread? More...
 
void module_list_mask_set (module_list_t *ml, module_instance_state_t mask)
 Set a new bootstrap/instantiate state for a list. More...
 

Detailed Description

Interface to the FreeRADIUS module system.

Id
48d29ab28de96646a68855fbf143cb1557ce930e

Definition in file module.h.


Data Structure Documentation

◆ module_data_pool_t

struct module_data_pool_t

Definition at line 235 of file module.h.

Data Fields
TALLOC_CTX * ctx ctx data is allocated in.
size_t len How much data we need mprotect to protect.
void * start Start address which may be passed to mprotect.

◆ module_instance_s

struct module_instance_s

Per instance data.

Per-instance data structure, to correlate the modules with the instance names (may NOT be the module names!), and the per-instance data structures.

Definition at line 247 of file module.h.

+ Collaboration diagram for module_instance_s:
Data Fields
unlang_mod_actions_t actions default actions and retries.
void * boot Data allocated during the boostrap phase.
module_data_pool_t boot_pool Data to allow mprotect state toggling for bootstrap data.
rlm_rcode_t code Code module will return when 'force' has has been set to true.
CONF_SECTION * conf Module's instance configuration.
void * data Module's instance data.

This is most frequently access comes first.

fr_rb_node_t data_node Entry in the data tree.
module_t const * exported Public module structure.

Cached for convenience. This exports module methods, i.e. the functions which allow the module to perform actions. This is an identical address to dl_module->common, but with a different type, containing additional instance callbacks to make it easier to use.

bool force Force the module to return a specific code.

Usually set via an administrative interface.

module_data_pool_t inst_pool Data to allow mprotect state toggling for instance data.
module_list_t * ml Module list this instance belongs to.
dl_module_t * module dynamic loader handle.

Contains the module's dlhandle, and the functions it exports. The dl_module is reference counted so that it can be freed automatically when the last instance is freed. This will also (usually) unload the .so or .dylib.

pthread_mutex_t mutex Used prevent multiple threads entering a thread unsafe module simultaneously.
char const * name Instance name e.g. user_database.
fr_rb_node_t name_node Entry in the name tree.
uint32_t number Unique module number.

Used to assign a stable number to each module instance.

module_instance_t const * parent Parent module's instance (if any).
module_instance_state_t state What's been done with this module so far.

◆ module_list_s

struct module_list_s

A list of modules.

This used to be a global structure, but was move to a struct.

Module lists allow collections of modules to be created. The module lists themselves can be configured to be thread-local or global, with optional runtime write protection.

Thread-local module lists are used for dynamic modules, i.e. those created at runtime, where as the global module lists are used for backend modules, listeners, and process state machines.

Definition at line 361 of file module.h.

+ Collaboration diagram for module_list_s:
Data Fields
fr_rb_tree_t * data_tree Modules indexed by data.
fr_heap_t * inst_heap Heap of module instances.
uint32_t last_number Last identifier assigned to a module instance.
module_instance_state_t mask Prevent phases from being executed.
char const * name Friendly list identifier.
fr_rb_tree_t * name_tree Modules indexed by name.
module_list_thread_data_get_t thread_data_get Callback to get thread-specific data.

Copy of type->thread_data_get.

module_list_type_t const * type Type of module list.
bool write_protect If true, pages containing module boot or instance data will be write protected after bootstrapping and instantiation is complete, to prevent accidental modification.

◆ module_method_binding_s

struct module_method_binding_s

Named methods exported by a module.

Definition at line 155 of file module.h.

+ Collaboration diagram for module_method_binding_s:
Data Fields
module_method_t method Module method to call.
call_env_method_t const * method_env Method specific call_env.
fr_dlist_t name2_entry Linked list of bindings with the same name1.

Allows us to more quickly iterate over all name2 entries after finding a matching name1. This is also temporarily used to verify the ordering of name bindings. DO NOT INITIALISE IN THE MODULE.

fr_dlist_head_t name2_list List of bindings with the same name1.

Only initialised for the the first name1 binding. DO NOT INITIALISE IN THE MODULE.

section_name_t const * section Identifier for a section.

◆ module_s

struct module_s

Struct exported by a rlm_* module.

Determines the capabilities of the module, and maps internal functions within the module to different sections.

Definition at line 177 of file module.h.

+ Collaboration diagram for module_s:
Data Fields
size_t boot_size Size of the module's bootstrap data.
char const * boot_type talloc type to assign to bootstrap data.
module_instantiate_t bootstrap Callback to allow the module to register any global resources like xlat functions and attributes.

Instance data is read only during the bootstrap phase and MUST NOT be modified. Any attributes added during this phase that the module need to be re-resolved during the instantiation phase so that dynamic modules (which don't run bootstrap) work correctly.

Note
Not modifying the instance data is not just a suggestion, if you try, you'll generate a SIGBUS or SIGSEGV and it won't be obvious why.
conf_parser_t const * config How to convert a CONF_SECTION to a module instance.
module_detach_t detach Clean up module resources from the instantiation pahses.
DL_MODULE_COMMON Common fields for all loadable modules.
module_flags_t flags Flags that control how a module starts up and how a module is called.
size_t inst_size Size of the module's instance data.
char const * inst_type talloc type to assign to instance data.
module_instantiate_t instantiate Callback to allow the module to register any per-instance resources like sockets and file handles.

After instantiate completes the module instance data is mprotected to prevent modification.

module_thread_detach_t thread_detach Callback to free thread-specific resources associated < with a module.
size_t thread_inst_size Size of the module's thread-specific instance data.
char const * thread_inst_type talloc type to assign to thread instance data.
module_thread_instantiate_t thread_instantiate Callback to populate a new module thread instance data.

Called once per thread.

module_detach_t unstrap Clean up module resources from both the bootstrap phase.

◆ module_state_func_table_s

struct module_state_func_table_s

Map string values to module state method.

Definition at line 398 of file module.h.

+ Collaboration diagram for module_state_func_table_s:
Data Fields
module_method_t func State function.
char const * name String identifier for state.

◆ module_thread_instance_s

struct module_thread_instance_s

Per thread per instance data.

Stores module and thread specific data.

Definition at line 327 of file module.h.

+ Collaboration diagram for module_thread_instance_s:
Data Fields
uint64_t active_callers total number of times we've been called
void * data Thread specific instance data.
fr_event_list_t * el Event list associated with this thread.
fr_heap_index_t inst_idx Entry in the thread-specific bootstrap heap.

Should be an identical value to the global instance data for the same module.

module_instance_t * mi As opposed to the thread local inst.
uint64_t total_calls

Macro Definition Documentation

◆ MODULE_BINDING_TERMINATOR

#define MODULE_BINDING_TERMINATOR   { .section = NULL }

Terminate a module binding list.

Definition at line 150 of file module.h.

◆ MODULE_INSTANCE_LEN_MAX

#define MODULE_INSTANCE_LEN_MAX   256

The maximum size of a module instance.

Definition at line 146 of file module.h.

Typedef Documentation

◆ module_detach_t

typedef int(* module_detach_t) (module_detach_ctx_t const *inst)

Module detach callback.

Is called just before the server exits, and after re-instantiation on HUP, to free the old module instance.

Detach should close all handles associated with the module instance, and free any memory allocated during instantiate.

Parameters
[in]instto free.
Returns
  • 0 on success.
  • -1 if detach failed.

Definition at line 94 of file module.h.

◆ module_instance_t

Definition at line 1 of file module.h.

◆ module_instantiate_t

typedef int(* module_instantiate_t) (module_inst_ctx_t const *mctx)

Module instantiation callback.

Is called once per module instance. Is not called when new threads are spawned. See module_thread_instantiate_t for that.

Parameters
[in]mctxHolds global instance data.
Returns
  • 0 on success.
  • -1 if instantiation failed.

Definition at line 79 of file module.h.

◆ module_list_t

typedef struct module_list_s module_list_t

Definition at line 1 of file module.h.

◆ module_list_thread_data_get_t

typedef module_thread_instance_t*(* module_list_thread_data_get_t) (module_instance_t const *mi)

Callback to retrieve thread-local data for a module.

Parameters
[in]mito add data to (use mi->ml for the module list).
Returns
  • NULL if no data exists.
  • Pointer to the data on success.

Definition at line 349 of file module.h.

◆ module_list_type_t

Definition at line 1 of file module.h.

◆ module_method_binding_t

Definition at line 1 of file module.h.

◆ module_method_t

typedef unlang_action_t(* module_method_t) (rlm_rcode_t *p_result, module_ctx_t const *mctx, request_t *request)

Module section callback.

Is called when the module is listed in a particular section of a virtual server, and the request has reached the module call.

Parameters
[out]p_resultResult code of the module method.
[in]mctxHolds global instance data, thread instance data and call specific instance data.
[in]requestto process.
Returns
the appropriate rcode.

Definition at line 67 of file module.h.

◆ module_state_func_table_t

Definition at line 1 of file module.h.

◆ module_t

typedef struct module_s module_t

Definition at line 1 of file module.h.

◆ module_thread_detach_t

typedef int(* module_thread_detach_t) (module_thread_inst_ctx_t const *mctx)

Module thread destruction callback.

Destroy a module/thread instance.

Parameters
[in]mctxHolds global instance data, thread instance data, and the thread-specific event list.
Returns
  • 0 on success.
  • -1 if instantiation failed.

Definition at line 118 of file module.h.

◆ module_thread_instance_t

Definition at line 1 of file module.h.

◆ module_thread_instantiate_t

typedef int(* module_thread_instantiate_t) (module_thread_inst_ctx_t const *mctx)

Module thread creation callback.

Called whenever a new thread is created.

Parameters
[in]mctxHolds global instance data, thread instance data, and the thread-specific event list.
Returns
  • 0 on success.
  • -1 if instantiation failed.

Definition at line 106 of file module.h.

Enumeration Type Documentation

◆ module_flags_t

Enumerator
MODULE_TYPE_THREAD_UNSAFE 

Module is not threadsafe.

Server will protect calls with mutex.

MODULE_TYPE_RETRY 

can handle retries

MODULE_TYPE_DYNAMIC_UNSAFE 

Instances of this module cannot be created at runtime.

Definition at line 46 of file module.h.

◆ module_instance_state_t

What state the module instance is currently in.

Enumerator
MODULE_INSTANCE_BOOTSTRAPPED 

Module instance has been bootstrapped, but not yet instantiated.

MODULE_INSTANCE_INSTANTIATED 

Module instance has been bootstrapped and instantiated.

MODULE_INSTANCE_NO_THREAD_INSTANTIATE 

Not set internally, but can be used to prevent thread instantiation for certain modules.

Definition at line 225 of file module.h.

Function Documentation

◆ module_bootstrap()

int module_bootstrap ( module_instance_t mi)

Manually complete module bootstrap by calling its instantiate function.

  • Parse the module configuration.
  • Call the modules "bootstrap" method.
Parameters
[in]miModule instance to bootstrap.
Returns
  • 0 on success.
  • -1 on failure.

Definition at line 1308 of file module.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ module_instance_alloc()

module_instance_t* module_instance_alloc ( module_list_t ml,
module_instance_t const *  parent,
dl_module_type_t  type,
char const *  mod_name,
char const *  inst_name,
module_instance_state_t  init_state 
)

Allocate a new module and add it to a module list for later bootstrap/instantiation.

  • Load the module shared library.
  • Allocate instance data for it.
Parameters
[in]mlTo add module to.
[in]parentof the module being bootstrapped, if this is a submodule. If this is not a submodule parent must be NULL.
[in]typeWhat type of module we're loading. Determines the prefix added to the library name. Should be one of:
  • DL_MODULE_TYPE_MODULE - Standard backend module.
  • DL_MODULE_TYPE_SUBMODULE - Usually a driver for a backend module.
  • DL_MODULE_TYPE_PROTO - A module associated with a listen section.
  • DL_MODULE_TYPE_PROCESS - Protocol state machine bound to a virtual server.
[in]mod_nameThe name of this module, i.e. 'redis' for 'rlm_redis'.
[in]inst_nameInstance name for this module, i.e. "aws_redis_01". The notable exception is if this is a submodule, in which case inst_name is usually the mod_name.
[in]init_stateThe state the module "starts" in. Can be used to prevent bootstrapping, instantiation, or thread instantiation of the module, by passing one or more of the MODULE_INSTANCE_* flags. Should usually be 0, unless special behaviour is required.
Returns
  • A new module instance handle, containing the module's public interface, and private instance data.
  • NULL on error.

Definition at line 1642 of file module.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ module_instance_by_data()

module_instance_t* module_instance_by_data ( module_list_t const *  ml,
void const *  data 
)

Find an existing module instance by its private instance data.

Parameters
[in]mlto search in.
[in]datato resolve to module_instance_t.
Returns
  • Module instance matching data.
  • NULL if no such module exists.

Definition at line 957 of file module.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ module_instance_by_name()

module_instance_t* module_instance_by_name ( module_list_t const *  ml,
module_instance_t const *  parent,
char const *  asked_name 
)

Find an existing module instance by its name and parent.

Parameters
[in]mlto search in.
[in]parentto qualify search with.
[in]asked_nameThe name of the module we're attempting to find. May include '-' which indicates that it's ok for the module not to be loaded.
Returns
  • Module instance matching name.
  • NULL if no such module exists.

Definition at line 903 of file module.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ module_instance_conf_parse()

int module_instance_conf_parse ( module_instance_t mi,
CONF_SECTION conf 
)

Covert a CONF_SECTION into parsed module instance data.

Definition at line 764 of file module.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ module_instance_copy()

module_instance_t* module_instance_copy ( module_list_t dst,
module_instance_t const *  src,
char const *  inst_name 
)

Duplicate a module instance, placing it in a new module list.

Parameters
[in]dstlist to place the new module instance in.
[in]srcto duplicate.
[in]inst_namenew instance name. If null, src->name will be used.

Definition at line 1534 of file module.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ module_instance_data_protect()

int module_instance_data_protect ( module_instance_t const *  mi)

Mark module data as read only.

Parameters
[in]miInstance data to protect (mark as read only).
Returns
  • 0 on success.
  • -1 on failure.

Definition at line 699 of file module.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ module_instance_data_unprotect()

int module_instance_data_unprotect ( module_instance_t const *  mi)

Mark module data as read/write.

Parameters
[in]miInstance data to unprotect (mark as read/write).
Returns
  • 0 on success.
  • -1 on failure.

Definition at line 711 of file module.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ module_instance_debug()

void module_instance_debug ( module_instance_t const *  mi)

Print debugging information for a module.

Parameters
[in]miModule instance to print.

Definition at line 605 of file module.c.

+ Here is the caller graph for this function:

◆ module_instance_name_from_conf()

fr_slen_t module_instance_name_from_conf ( char const **  name,
CONF_SECTION conf 
)

Avoid boilerplate when setting the module instance name.

Definition at line 735 of file module.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ module_instance_name_valid()

fr_slen_t module_instance_name_valid ( char const *  inst_name)

Check to see if a module instance name is valid.

Note
On failure the error message may be retrieved with fr_strerror().
Parameters
[in]inst_nameto check.
Returns
  • 0 on success.
  • Negative value on error indicating the position of the bad char.

Definition at line 1591 of file module.c.

+ Here is the caller graph for this function:

◆ module_instance_root()

module_instance_t* module_instance_root ( module_instance_t const *  child)

Find the module's shallowest parent.

Parameters
[in]childto locate the root for.
Returns
  • The module's shallowest parent.
  • NULL on error.

Definition at line 935 of file module.c.

+ Here is the caller graph for this function:

◆ module_instance_root_prefix_str()

char const* module_instance_root_prefix_str ( module_instance_t const *  mi)

Return the prefix string for the deepest module.

This is useful for submodules which don't have a prefix of their own. In this case we need to use the prefix of the shallowest module, which will be a proto or rlm module.

Parameters
[in]miInstance to get the prefix for.
Returns
The prefix string for the shallowest module.

Definition at line 725 of file module.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ module_instance_skip_bootstrap()

bool module_instance_skip_bootstrap ( module_instance_t mi)

Should we bootstrap this module instance?

Parameters
[in]mito check.
Returns
  • true if the module instance should be bootstrapped.
  • false if the module instance has already been bootstrapped.

Definition at line 1792 of file module.c.

+ Here is the caller graph for this function:

◆ module_instance_skip_instantiate()

bool module_instance_skip_instantiate ( module_instance_t mi)

Should we instantiate this module instance?

Parameters
[in]mito check.
Returns
  • true if the module instance should be instantiated.
  • false if the module instance has already been instantiated.

Definition at line 1804 of file module.c.

+ Here is the caller graph for this function:

◆ module_instance_skip_thread_instantiate()

bool module_instance_skip_thread_instantiate ( module_instance_t mi)

Should we instantiate this module instance in a new thread?

Parameters
[in]mito check.
Returns
  • true if the module instance should be instantiated in a new thread.
  • false if the module instance has already been instantiated in a new thread.

Definition at line 1816 of file module.c.

+ Here is the caller graph for this function:

◆ module_instantiate()

int module_instantiate ( module_instance_t instance)

Manually complete module setup by calling its instantiate function.

Parameters
[in]instanceof module to complete instantiation for.
Returns
  • 0 on success.
  • -1 on failure.

Definition at line 1195 of file module.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ module_list_alloc()

module_list_t* module_list_alloc ( TALLOC_CTX *  ctx,
module_list_type_t const *  type,
char const *  name,
bool  write_protect 
)

Allocate a new module list.

This is used to instantiate and destroy modules in distinct phases for example, we may need to load all proto modules before rlm modules.

If the list is freed all module instance data will be freed. If no more instances of the module exist the module be unloaded.

Parameters
[in]ctxTo allocate the list in.
[in]typeof the list. Controls whether this is a global module list, or a per-thread list containing variants of an existing module.
[in]nameof the list. Used for debugging.
[in]write_protectWhether to write protect the module data after instantiation and bootstrapping.
Returns
A new module list.

Definition at line 1848 of file module.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ module_list_debug()

void module_list_debug ( module_list_t const *  ml)

Print the contents of a module list.

Definition at line 623 of file module.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ module_list_mask_set()

void module_list_mask_set ( module_list_t ml,
module_instance_state_t  mask 
)

Set a new bootstrap/instantiate state for a list.

Parameters
[in]mlTo set the state for.
[in]maskNew state.

Definition at line 1826 of file module.c.

+ Here is the caller graph for this function:

◆ module_submodule_parse()

int module_submodule_parse ( UNUSED TALLOC_CTX *  ctx,
void *  out,
void *  parent,
CONF_ITEM ci,
UNUSED conf_parser_t const *  rule 
)

◆ module_thread()

static module_thread_instance_t* module_thread ( module_instance_t const *  mi)
inlinestatic

Retrieve module/thread specific instance for a module.

Parameters
[in]mito find thread specific data for.
Returns
  • Thread specific instance data on success.
  • NULL if module has no thread instance data.

Definition at line 458 of file module.h.

+ Here is the caller graph for this function:

◆ module_thread_by_data()

module_thread_instance_t* module_thread_by_data ( module_list_t const *  ml,
void const *  data 
)

Retrieve module/thread specific instance data for a module.

Parameters
[in]mlModule list module belongs to.
[in]dataPrivate instance data of the module. Same as what would be provided by module_instance_by_data.
Returns
  • Thread specific instance data on success.
  • NULL if module has no thread instance data.

Definition at line 980 of file module.c.

+ Here is the call graph for this function:

◆ module_thread_instantiate()

int module_thread_instantiate ( TALLOC_CTX *  ctx,
module_instance_t mi,
fr_event_list_t el 
)

Allocate thread-local instance data for a module.

The majority of modules will have a single set of thread-specific instance data.

An exception is dynamic modules, which may have multiple sets of thread-specific instance data tied to a specific dynamic use of that module.

Parameters
[in]ctxTalloc ctx to bind thread specific data to.
[in]miModule instance to perform thread instantiation for.
[in]elEvent list serviced by this thread.
Returns
  • 0 on success.
  • -1 on failure.

Definition at line 1083 of file module.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ modules_bootstrap()

int modules_bootstrap ( module_list_t const *  ml)

Bootstrap any modules which have not been bootstrapped already.

Allows the module to initialise connection pools, and complete any registrations that depend on attributes created during the bootstrap phase.

Parameters
[in]mlcontaining modules to bootstrap.
Returns
  • 0 on success.
  • -1 on failure.

Definition at line 1372 of file module.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ modules_init()

void modules_init ( char const *  lib_dir)

Perform global initialisation for modules.

Definition at line 1901 of file module.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ modules_instantiate()

int modules_instantiate ( module_list_t const *  ml)

Completes instantiation of modules.

Allows the module to initialise connection pools, and complete any registrations that depend on attributes created during the bootstrap phase.

Parameters
[in]mlcontaining modules to instantiate.
Returns
  • 0 on success.
  • -1 on failure.

Definition at line 1281 of file module.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ modules_thread_detach()

void modules_thread_detach ( module_list_t ml)

Remove thread-specific data for a given module list.

Removes all module thread data for the

Definition at line 1009 of file module.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ modules_thread_instantiate()

int modules_thread_instantiate ( TALLOC_CTX *  ctx,
module_list_t const *  ml,
fr_event_list_t el 
)

Creates per-thread instance data for modules which need it.

Must be called by any new threads before attempting to execute unlang sections.

Parameters
[in]ctxTalloc ctx to bind thread specific data to.
[in]mlModule list to perform thread instantiation for.
[in]elEvent list serviced by this thread.
Returns
  • 0 on success.
  • -1 on failure.

Definition at line 1160 of file module.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Variable Documentation

◆ module_instance_allowed_chars

bool const module_instance_allowed_chars[UINT8_MAX+1]
extern

Chars that are allowed in a module instance name.

Definition at line 216 of file module.c.

◆ module_list_type_global

module_list_type_t const module_list_type_global
extern

Initialise a global module, with thread-specific data.

Initialise a global module, with thread-specific data.

Definition at line 536 of file module.c.

◆ module_list_type_thread_local

module_list_type_t const module_list_type_thread_local
extern

Initialise a thread-local module, which is only used in a single thread.

Initialise a thread-local module, which is only used in a single thread.

Definition at line 590 of file module.c.