SIP-Router core :: modules loading, structures declarations and utilitiesModule: SIP-router core. More...

#include <dlfcn.h>
#include "parser/msg_parser.h"
#include "ver_defs.h"
#include "rpc.h"
#include "route_struct.h"
#include "route.h"
#include "str.h"
#include "kstats_types.h"
#include "mi/mi_types.h"
#include "pvar.h"

Include dependency graph for sr_module.h:

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

Go to the source code of this file.

Data Structures

struct cmd_export_common_
members situated at the same place in memory in both ser & kamailio cmd_export More...
struct fparam
Function parameter. More...
struct kam_cmd_export_
kamailo/openser version More...
struct kam_module_exports
kamailio/openser module exports version More...
struct module_exports_common
module exports in the same place in memory in both ser & kamailio More...
struct ser_cmd_export_
ser version More...
struct ser_module_exports
ser module exports version More...
struct sr31_cmd_export_
sip-router version More...
struct sr31_module_exports
sr/ser 3.1+ module exports version More...

Defines

#define DEFAULT_DLFLAGS 0
value that signals to module loader to use default dlopen flags in Kamailio
#define FIXUP_F_FPARAM_RVE (unsigned long)1
special fixup function flags fparam fixup, rve ready, they are kept in the first 2 bits inside the pointer
#define NO_SCRIPT -1
export not usable from scripts
#define PARAM_INT (1U<<1)
Integer parameter type.
#define PARAM_STR (1U<<2)
struct str parameter type
#define PARAM_STRING (1U<<0)
String (char *) parameter type.
#define PROC_ATTENDANT -10
main "attendant process
#define PROC_FIFO PROC_RPC
FIFO attendant process.
#define PROC_INIT -127
special rank, the context is the main ser process, but this is guaranteed to be executed before any process is forked, so it can be used to setup shared variables that depend on some after mod_init available information (e.g.
#define PROC_MAIN 0
Main ser process.
#define PROC_MIN PROC_NOCHLDINIT
Minimum process rank.
#define PROC_NOCHLDINIT -128
no child init functions will be called if this rank is used in fork_process()
#define PROC_RPC -2
RPC type process.
#define PROC_SIPINIT 1
First SIP worker - some modules do special processing in this child, like loading db data.
#define PROC_SIPRPC 127
Used to init RPC worker as SIP commands handler.
#define PROC_TCP_MAIN -4
TCP main process.
#define PROC_TIMER -1
Timer attendant process.
#define PROC_UNIXSOCK -5
Unix socket server.
#define VAR_PARAM_NO -128
function has variable number of parameters (see cmd_function_var for the prototype)

Typedefs

typedef int(* cmd_function )(struct sip_msg *, char *param1, char *param2)
main two parameter module function
typedef int(* cmd_function_var )(struct sip_msg *, int no, action_u_t *vals)
variable number of parameter module function
typedef struct fparam fparam_t
Function parameter.
typedef void(* mod_proc )(int no)
kamailio/openser proc_export (missing from ser)
typedef int(* mod_register_function )(char *path, int *dlflags, void *reserved1, void *reserved2)
type used for the mod_register function export
typedef int(* response_function )(struct sip_msg *)
response module function prototype

Functions

struct sr_module * find_module_by_name (char *mod)
true if the module with name 'mod_name' is loaded
void * find_param_export (struct sr_module *mod, char *name, modparam_t type_mask, modparam_t *param_type)
Find a parameter with given type.
int fix_param (int type, void **param)
Generic parameter fixup function.
int fix_param_types (int types, void **param)
fix a param to one of the given types (mask).
int fixup_free_fparam_1 (void **param, int param_no)
generic free fixup function for "pure" first parameter fparam type fixups.
int fixup_free_fparam_2 (void **param, int param_no)
generic free fixup function for "pure" 2nd parameter fparam type fixups.
int fixup_free_fparam_all (void **param, int param_no)
generic free fixup function for "pure" fparam type fixups.
action_u_t * fixup_get_param (void **cur_param, int cur_param_no, int required_param_no)
API function to get other parameters from fixup.
int fixup_int_1 (void **param, int param_no)
Same as fixup_int_12 but applies to the 1st parameter only.
int fixup_int_12 (void **param, int param_no)
The string parameter will be converted to integer.
int fixup_int_2 (void **param, int param_no)
Same as fixup_int_12 but applies to the 2nd parameter only.
int fixup_regex_1 (void **param, int param_no)
Same as fixup_regex_12 but applies to the 1st parameter only.
int fixup_regex_12 (void **param, int param_no)
The parameter must be a regular expression which must compile, the parameter will be converted to compiled regex.
int fixup_regex_2 (void **param, int param_no)
Same as fixup_regex_12 but applies to the 2nd parameter only.
int fixup_str_1 (void **param, int param_no)
Same as fixup_str_12 but applies to the 1st parameter only.
int fixup_str_12 (void **param, int param_no)
Parse the parameter as static string, do not resolve AVPs or selects, convert the parameter to str structure.
int fixup_str_2 (void **param, int param_no)
Same as fixup_str_12 but applies to the 2nd parameter only.
int fixup_var_int_1 (void **param, int param_no)
Same as fixup_var_int_12 but applies to the 1st parameter only.
int fixup_var_int_12 (void **param, int param_no)
Fixup variable integer.
int fixup_var_int_2 (void **param, int param_no)
Same as fixup_var_int_12 but applies to the 2nd parameter only.
int fixup_var_pve_12 (void **param, int param_no)
fixup variable-pve-only-string.
int fixup_var_pve_str_1 (void **param, int param_no)
same as fixup_var_pve_str_12 but applies to the 1st parameter only
int fixup_var_pve_str_12 (void **param, int param_no)
fixup variable-pve-string.
int fixup_var_pve_str_2 (void **param, int param_no)
same as fixup_var_pve_str_12 but applies to the 2nd parameter only
int fixup_var_str_1 (void **param, int param_no)
Same as fixup_var_str_12 but applies to the 1st parameter only.
int fixup_var_str_12 (void **param, int param_no)
Fixup variable string,.
int fixup_var_str_2 (void **param, int param_no)
Same as fixup_var_str_12 but applies to the 2nd parameter only.
void fparam_free_contents (fparam_t *fp)
fparam_t free function.
void fparam_free_restore (void **param)
Generic free fixup type function for a fixed fparam.
free_fixup_function get_fixup_free (fixup_function f)
returns the corresponding fixup_free* for various known fixup types
int get_int_fparam (int *dst, struct sip_msg *msg, fparam_t *param)
Get the function parameter value as integer.
int get_regex_fparam (regex_t *dst, struct sip_msg *msg, fparam_t *param)
Get the function parameter value as compiled regular expression.
int get_str_fparam (str *dst, struct sip_msg *msg, fparam_t *param)
Get the function parameter value as string.
int is_fparam_rve_fixup (fixup_function f)
returns true if a fixup is a fparam_t* one.
int load_module (char *path)
load a sr module

Variables

int mod_response_cbk_no
size of reponse callbacks array
response_function * mod_response_cbks
response callback array
struct sr_module * modules
global module list

Detailed Description

Definition in file sr_module.h.

Define Documentation

#define PROC_INIT -127

total number of processes).

Warning:: child_init(PROC_MAIN) is again called in the same process (main), but latter (before tcp), so make sure you don't init things twice, bot in PROC_MAIN and PROC_INT

Definition at line 194 of file sr_module.h.

Referenced by child_init().

#define PROC_SIPRPC 127

Don't do any special processing in the child init with this rank - just bare child initialization

Definition at line 209 of file sr_module.h.

Referenced by init_mi_child().

Typedef Documentation

typedef int(* cmd_function)(struct sip_msg *, char *param1, char *param2)

Main two parameter module function, default and oldest version.

Parameters:

	sip_msg	SIP message
	param1	first parameter
	param2	second parameter

Returns:: positive on success, negative on error, 0 to stop processing (drop message)

Definition at line 122 of file sr_module.h.

typedef int(* cmd_function_var)(struct sip_msg *, int no, action_u_t *vals)

Variable number of parameter module function, takes as param the sip_msg, extra parameters number and a pointer to an array of parameters

Parameters:

	sip_msg	SIP message
	no	extra parameters number
	vals	extra parameters

Returns:: positive on success, negative on error, 0 to stop processing (drop message)

Definition at line 139 of file sr_module.h.

typedef int(* mod_register_function)(char *path, int *dlflags, void *reserved1, void *reserved2)

mod_register is a function called when loading a module (if present), prior to registering the module exports.

Parameters:

	path	path to the module, including file name
	dlflags	pointer to the dlflags used when loading the module. If the value is changed to a different and non-zero value, the module will be reloaded with the new flags.
	reserved1	- reserved for future use.
	reserved2	- reserved for future use

Returns:: 0 on success, -1 on error, all the other values are reserved for future use (<0 meaning error and >0 success)

Definition at line 109 of file sr_module.h.

typedef int(* response_function)(struct sip_msg *)

Parameters:

sip_msg

SIP message

Returns:: positive if ok, 0 to stop processing

Definition at line 148 of file sr_module.h.

Function Documentation

void* find_param_export	(	struct sr_module *	mod,
		char *	name,
		modparam_t	type_mask,
		modparam_t *	param_type
	)

Parameters:

	mod	module
	name	parameter name
	type_mask	parameter mask
	param_type	parameter type

Returns:: parameter address in memory, if there is no such parameter, NULL is returned

Parameters:

	mod	module
	name	parameter name
	type_mask	parameter mask
	param_type	parameter type

Returns:: parameter address in memory, if there is no such parameter, NULL is returned

Definition at line 759 of file sr_module.c.

int fix_param	(	int	type,
		void **	param
	)

Generic parameter fixup function which creates fparam_t structure. Type parameter contains allowed parameter types.

Parameters:

	type	parameter type
	param	fixed parameter

Returns:: 0 on success, -1 on error

Creates a fparam_t structure.

Parameters:

	type	contains allowed parameter types
	param	is the parameter that will be fixed-up

Returns:: 0 on success, 1 if the param doesn't match the specified type <0 on failure

Definition at line 1101 of file sr_module.c.

References fparam::asciiz, fparam::avp, fparam::i, _str::len, fparam::orig, parse_avp_ident(), parse_select(), fparam::pve, fparam::pvs, fparam::regex, _str::s, fparam::select, fparam::str, fparam::subst, and fparam::type.

Referenced by fix_param_types(), fixup_int_12(), fixup_regex_12(), fixup_str_12(), fixup_var_int_12(), fixup_var_pve_12(), fixup_var_pve_str_12(), and fixup_var_str_12().

Here is the call graph for this function:

Here is the caller graph for this function:

int fix_param_types	(	int	types,
		void **	param
	)

Parameters:

	types	- bitmap of the allowed types (e.g. FPARAM_INT\|FPARAM_STR)
	param	- value/result

Returns:: - 0 on success, -1 on error, 1 if param doesn't match any of the types

Definition at line 1328 of file sr_module.c.

References fix_param(), and fixup_get_param_type().

Here is the call graph for this function:

int fixup_free_fparam_1	(	void **	param,
		int	param_no
	)

Parameters:

	param	- double pointer to param, as for normal fixup functions.
	param_no	- parameter number: the function will work only for param_no == 1 (first parameter).

Returns:: 0 on success (always).

Definition at line 1774 of file sr_module.c.

References fparam_free_restore().

Here is the call graph for this function:

int fixup_free_fparam_2	(	void **	param,
		int	param_no
	)

Parameters:

	param	- double pointer to param, as for normal fixup functions.
	param_no	- parameter number: the function will work only for param_no == 2 (2nd parameter).

Returns:: 0 on success (always).

Definition at line 1789 of file sr_module.c.

References fparam_free_restore().

Here is the call graph for this function:

int fixup_free_fparam_all	(	void **	param,
		int	param_no
	)

Parameters:

	param	- double pointer to param, as for normal fixup functions.
	param_no	- parameter number, ignored.

Returns:: 0 on success (always).

Definition at line 1760 of file sr_module.c.

References fparam_free_restore().

Here is the call graph for this function:

int fixup_var_int_12	(	void **	param,
		int	param_no
	)

Fixup variable integer, the parameter can be AVP, SELECT, or ordinary integer. AVP and select identifiers will be resolved to their values and converted to int if necessary during runtime. The parameter value will be converted to fparam structure

Parameters:

	param	fixed parameter value
	param_no	number of parameter

Returns:: 0 on success, -1 on an error

Definition at line 1493 of file sr_module.c.

References fix_param(), and fixup_get_param_type().

Referenced by fixup_sl_reply(), fixup_var_int_1(), fixup_var_int_2(), get_fixup_free(), and is_fparam_rve_fixup().

Here is the call graph for this function:

Here is the caller graph for this function:

int fixup_var_pve_12	(	void **	param,
		int	param_no
	)

The parameter can be a PVE (pv based format string) or string. non-static PVEs identifiers will be resolved to their values during runtime. The parameter value will be converted to fparam structure

Parameters:

	param	- double pointer to param, as for normal fixup functions.
	param_no	- parameter number, ignored.

Returns:: -1 on an error, 0 on success.

Definition at line 1398 of file sr_module.c.

References fix_param(), fixup_get_param_type(), fparam_free_restore(), and fparam::pve.

Here is the call graph for this function:

int fixup_var_pve_str_12	(	void **	param,
		int	param_no
	)

The parameter can be a PVAR, AVP, SELECT, PVE (pv based format string) or string.

The parameter can be a PVAR, AVP, SELECT, PVE (pv based format string) or string. PVAR, AVP and select and non-static PVEs identifiers will be resolved to their values during runtime. The parameter value will be converted to fparam structure

Parameters:

	param	- double pointer to param, as for normal fixup functions.
	param_no	- parameter number, ignored.

Returns:: -1 on an error, 0 on success.

Definition at line 1437 of file sr_module.c.

References fix_param(), fixup_get_param_type(), fparam_free_restore(), and fparam::pve.

Referenced by fixup_sl_reply(), fixup_var_pve_str_1(), fixup_var_pve_str_2(), get_fixup_free(), and is_fparam_rve_fixup().

Here is the call graph for this function:

Here is the caller graph for this function:

int fixup_var_str_12	(	void **	param,
		int	param_no
	)

Fixup variable string, the parameter can be AVP, SELECT, or ordinary string. AVP and select identifiers will be resolved to their values during runtime. The parameter value will be converted to fparam structure.

Parameters:

	param	fixed parameter value
	param_no	number of parameter

Returns:: 0 on success, -1 on an error

Definition at line 1357 of file sr_module.c.

References fix_param(), and fixup_get_param_type().

Referenced by fixup_var_str_1(), fixup_var_str_2(), get_fixup_free(), and is_fparam_rve_fixup().

Here is the call graph for this function:

Here is the caller graph for this function:

void fparam_free_contents ( fparam_t * fp )

Frees the "content" of a fparam, but not the fparam itself. Note: it doesn't free fp->orig! Assumes pkg_malloc'ed content.

Parameters:

fp

- fparam to be freed

Definition at line 1248 of file sr_module.c.

References fparam::avp, free_select(), pv_spec_free(), fparam::pve, fparam::pvs, fparam::regex, fparam::select, fparam::subst, and fparam::type.

Referenced by fparam_free_restore().

Here is the call graph for this function:

Here is the caller graph for this function:

void fparam_free_restore ( void ** param )

Generic free fixup type function for a fixed fparam. It will free whatever was allocated during the initial fparam fixup and restore the original param value.

Parameters:

param

freed parameters

Definition at line 1306 of file sr_module.c.

References fparam_free_contents(), and fparam::orig.

Referenced by fixup_free_fparam_1(), fixup_free_fparam_2(), fixup_free_fparam_all(), fixup_var_pve_12(), and fixup_var_pve_str_12().

Here is the call graph for this function:

Here is the caller graph for this function:

free_fixup_function get_fixup_free ( fixup_function f )

Returns the corresponding fixup_free* for various known fixup types. Used to automatically fill in free_fixup* functions.

Parameters:

f

fixup function pointer

Returns:: free fixup function pointer on success, 0 on failure (unknown fixup or no free fixup function).

Definition at line 1839 of file sr_module.c.

References fixup_int_1(), fixup_int_12(), fixup_int_2(), fixup_regex_1(), fixup_regex_12(), fixup_regex_2(), fixup_str_1(), fixup_str_12(), fixup_str_2(), fixup_var_int_1(), fixup_var_int_12(), fixup_var_int_2(), fixup_var_pve_str_1(), fixup_var_pve_str_12(), fixup_var_pve_str_2(), fixup_var_str_1(), fixup_var_str_12(), fixup_var_str_2(), and mod_fix_get_fixup_free().

Referenced by sr_cmd_exports_convert().

Here is the call graph for this function:

Here is the caller graph for this function:

int get_int_fparam	(	int *	dst,
		struct sip_msg *	msg,
		fparam_t *	param
	)

Parameters:

	dst	string destination
	msg	SIP message
	param	function parameters

Returns:: 0 on success, 1 on error, e.g. cannot get value; 0 - Success -1 - Cannot get value

Definition at line 1679 of file sr_module.c.

References fparam::avp, fparam::i, fparam::orig, fparam::pvs, fparam::select, and fparam::type.

Referenced by w_send_reply(), w_sl_send_reply(), and xmlrpc_reply().

Here is the caller graph for this function:

int get_regex_fparam	(	regex_t *	dst,
		struct sip_msg *	msg,
		fparam_t *	param
	)

Parameters:

	dst	string destination
	msg	SIP message
	param	function parameters

Returns:: 0 on success, 1 on error, e.g. cannot get value

Get the function parameter value as compiled regular expression.

Returns:: : 0 for success, negative on error.

Definition at line 1740 of file sr_module.c.

References fparam::regex, and fparam::type.

int get_str_fparam	(	str *	dst,
		struct sip_msg *	msg,
		fparam_t *	param
	)

Parameters:

	dst	string destination
	msg	SIP message
	param	function parameters

Returns:: 0 on success, 1 on error, e.g. cannot get value; 0 - Success -1 - Cannot get value

Definition at line 1612 of file sr_module.c.

References fparam::asciiz, fparam::avp, int2str(), _str::len, fparam::orig, fparam::pve, fparam::pvs, _str::s, fparam::select, fparam::str, and fparam::type.

Referenced by w_send_reply(), w_sl_send_reply(), and xmlrpc_reply().

Here is the call graph for this function:

Here is the caller graph for this function:

int is_fparam_rve_fixup ( fixup_function f )

Used to automatically detect "pure" fparam fixups that can be used with non contant RVEs.

Parameters:

f

- function pointer

Returns:: 1 for fparam fixups, 0 for others.

Definition at line 1804 of file sr_module.c.

References fixup_int_1(), fixup_int_12(), fixup_int_2(), fixup_regex_1(), fixup_regex_12(), fixup_regex_2(), fixup_str_1(), fixup_str_12(), fixup_str_2(), fixup_var_int_1(), fixup_var_int_12(), fixup_var_int_2(), fixup_var_pve_str_1(), fixup_var_pve_str_12(), fixup_var_pve_str_2(), fixup_var_str_1(), fixup_var_str_12(), and fixup_var_str_2().

Here is the call graph for this function:

int load_module ( char * mod_path )

tries to load the module specified by mod_path. If mod_path is 'modname' or 'modname.so' then <MODS_DIR>/<modname>.so will be tried and if this fails <MODS_DIR>/<modname>/<modname>.so If mod_path contain a '/' it is assumed to be the path to the module and tried first. If fails and mod_path is not absolute path (not starting with '/') then will try: <MODS_DIR>/mod_path

Parameters:

mod_path

path or module name

Returns:: 0 on success , <0 on error

Definition at line 440 of file sr_module.c.

References DEFAULT_DLFLAGS, and modules.

sr_module.h File Reference

Data Structures

Defines

Typedefs

Functions

Variables

Detailed Description

Define Documentation

Typedef Documentation

Function Documentation