sr_module.c
3bf76e49
 /* $Id$
7dd0b342
  *
53c7e0f1
  * Copyright (C) 2001-2003 FhG Fokus
7dd0b342
  *
  * This file is part of ser, a free SIP server.
  *
  * ser is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version
  *
  * For a license to use the ser software under conditions
  * other than those described here, or to purchase support for this
  * software, please contact iptel.org by e-mail at the following addresses:
  *    info@iptel.org
  *
  * ser is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  *
fb851d7e
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, write to the Free Software
7dd0b342
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
3bf76e49
  */
6419a43f
 /*
  * History:
  * --------
  *  2003-03-10  switched to new module_exports format: updated find_export,
  *               find_export_param, find_module (andrei)
e3dccdc9
  *  2003-03-19  replaced all mallocs/frees w/ pkg_malloc/pkg_free (andrei)
51c38611
  *  2003-03-19  Support for flags in find_export (janakj)
3c8bd369
  *  2003-03-29  cleaning pkg_mallocs introduced (jiri)
2dcb8b67
  *  2003-04-24  module version checking introduced (jiri)
dd0e65a8
  *  2004-09-19  compile flags are checked too (andrei)
f4194f69
  *  2005-01-07  removed find_module-overloading problems, added
6d35d70e
  *               find_export_record
  *  2006-02-07  added fix_flag (andrei)
55faef7d
  *  2008-02-29  store all the reponse callbacks in their own array (andrei)
2873d384
  *  2008-11-17  support dual module interface: ser & kamailio (andrei)
bf9d1c43
  *  2008-11-26  added fparam_free_contents() and fix_param_types (andrei)
6419a43f
  */
3bf76e49
 
7dd0b342
 
3bf76e49
 #include "sr_module.h"
 #include "dprint.h"
404073d3
 #include "error.h"
e3dccdc9
 #include "mem/mem.h"
300b0f50
 #include "core_cmd.h"
bb6575cd
 #include "ut.h"
d0ce0ebd
 #include "re.h"
f141bc93
 #include "route_struct.h"
6d35d70e
 #include "flags.h"
b91364c6
 #include "trim.h"
f4194f69
 #include "globals.h"
5099fd64
 #include "rpc_lookup.h"
b25e31aa
 #include "sr_compat.h"
3bf76e49
 
f4194f69
 #include <sys/stat.h>
f6712967
 #include <regex.h>
3bf76e49
 #include <dlfcn.h>
 #include <strings.h>
 #include <stdlib.h>
e22bbdb8
 #include <string.h>
3bf76e49
 
 
031e278e
 struct sr_module* modules=0;
3bf76e49
 
30449150
 #ifdef STATIC_EXEC
2873d384
 	extern struct module_exports exec_exports;
30449150
 #endif
404073d3
 #ifdef STATIC_TM
2873d384
 	extern struct module_exports tm_exports;
404073d3
 #endif
57c9e572
 
6eb22d94
 #ifdef STATIC_MAXFWD
2873d384
 	extern struct module_exports maxfwd_exports;
6eb22d94
 #endif
57c9e572
 
192ac55b
 #ifdef STATIC_AUTH
2873d384
 	extern struct module_exports auth_exports;
192ac55b
 #endif
57c9e572
 
192ac55b
 #ifdef STATIC_RR
2873d384
 	extern struct module_exports rr_exports;
192ac55b
 #endif
57c9e572
 
192ac55b
 #ifdef STATIC_USRLOC
2873d384
 	extern struct module_exports usrloc_exports;
192ac55b
 #endif
404073d3
 
a50f3f89
 #ifdef STATIC_SL
2873d384
 	extern struct module_exports sl_exports;
a50f3f89
 #endif
 
404073d3
 
55faef7d
 int mod_response_cbk_no=0;
 response_function* mod_response_cbks=0;
 
 
404073d3
 /* initializes statically built (compiled in) modules*/
31309a3a
 int register_builtin_modules()
404073d3
 {
e22bbdb8
 	int ret;
 
 	ret=0;
57c9e572
 #ifdef STATIC_TM
2873d384
 	ret=register_module(MODULE_INTERFACE_VER, &tm_exports,"built-in", 0);
57c9e572
 	if (ret<0) return ret;
 #endif
192ac55b
 
e8df4b11
 #ifdef STATIC_EXEC
2873d384
 	ret=register_module(MODULE_INTERFACE_VER, &exec_exports,"built-in", 0);
30449150
 	if (ret<0) return ret;
 #endif
 
57c9e572
 #ifdef STATIC_MAXFWD
2873d384
 	ret=register_module(MODULE_INTERFACE_VER, &maxfwd_exports, "built-in", 0);
57c9e572
 	if (ret<0) return ret;
192ac55b
 #endif
 
57c9e572
 #ifdef STATIC_AUTH
2873d384
 	ret=register_module(MODULE_INTERFACE_VER, &auth_exports, "built-in", 0);
57c9e572
 	if (ret<0) return ret;
 #endif
fb851d7e
 
192ac55b
 #ifdef STATIC_RR
2873d384
 	ret=register_module(MODULE_INTERFACE_VER, &rr_exports, "built-in", 0);
57c9e572
 	if (ret<0) return ret;
192ac55b
 #endif
fb851d7e
 
192ac55b
 #ifdef STATIC_USRLOC
2873d384
 	ret=register_module(MODULE_INTERFACE_VER, &usrloc_exports, "built-in", 0);
57c9e572
 	if (ret<0) return ret;
192ac55b
 #endif
a50f3f89
 
 #ifdef STATIC_SL
2873d384
 	ret=register_module(MODULE_INTERFACE_VER, &sl_exports, "built-in", 0);
a50f3f89
 	if (ret<0) return ret;
 #endif
fb851d7e
 
e22bbdb8
 	return ret;
404073d3
 }
 
 
 
 /* registers a module,  register_f= module register  functions
  * returns <0 on error, 0 on success */
2873d384
 static int register_module(unsigned ver, union module_exports_u* e,
 					char* path, void* handle)
404073d3
 {
5099fd64
 	int ret, i;
e22bbdb8
 	struct sr_module* mod;
fb851d7e
 
404073d3
 	ret=-1;
31309a3a
 
404073d3
 	/* add module to the list */
e3dccdc9
 	if ((mod=pkg_malloc(sizeof(struct sr_module)))==0){
404073d3
 		LOG(L_ERR, "load_module: memory allocation failure\n");
 		ret=E_OUT_OF_MEM;
 		goto error;
 	}
 	memset(mod,0, sizeof(struct sr_module));
 	mod->path=path;
 	mod->handle=handle;
2873d384
 	mod->mod_interface_ver=ver;
404073d3
 	mod->exports=e;
 	mod->next=modules;
 	modules=mod;
d79388b3
 
 	if (ver==1 && e->v1.items) {
5099fd64
 		/* register module pseudo-variables for kamailio modules */
d79388b3
 		LM_DBG("register PV from: %s\n", e->c.name);
 		if (register_pvars_mod(e->c.name, e->v1.items)!=0) {
 			LM_ERR("failed to register pseudo-variables for module %s\n",
 				e->c.name);
 			pkg_free(mod);
 			return -1;
 		}
5099fd64
 	}else if (ver==0 && e->v0.rpc_methods){
 		/* register rpcs for ser modules */
 		i=rpc_register_array(e->v0.rpc_methods);
 		if (i<0){
 			ERR("failed to register RPCs for module %s\n", e->c.name);
 			goto error;
 		}else if (i>0){
 			ERR("%d duplicate RPCs name detected while registering RPCs"
 					" declared in modules %s\n", i, e->c.name);
 			goto error;
 		}
 		/* i==0 => success */
d79388b3
 	}
 
404073d3
 	return 0;
 error:
 	return ret;
 }
 
2dcb8b67
 #ifndef DLSYM_PREFIX
 /* define it to null */
 #define DLSYM_PREFIX
 #endif
 
 static inline int version_control(void *handle, char *path)
 {
 	char **m_ver;
dd0e65a8
 	char **m_flags;
2dcb8b67
 	char* error;
 
 	m_ver=(char **)dlsym(handle, DLSYM_PREFIX "module_version");
 	if ((error=(char *)dlerror())!=0) {
bae7e884
 		LOG(L_ERR, "ERROR: no version info in module <%s>: %s\n",
2dcb8b67
 			path, error );
 		return 0;
 	}
dd0e65a8
 	m_flags=(char **)dlsym(handle, DLSYM_PREFIX "module_flags");
 	if ((error=(char *)dlerror())!=0) {
 		LOG(L_ERR, "ERROR: no compile flags info in module <%s>: %s\n",
 			path, error );
 		return 0;
 	}
2dcb8b67
 	if (!m_ver || !(*m_ver)) {
bae7e884
 		LOG(L_ERR, "ERROR: no version in module <%s>\n", path );
2dcb8b67
 		return 0;
 	}
dd0e65a8
 	if (!m_flags || !(*m_flags)) {
 		LOG(L_ERR, "ERROR: no compile flags in module <%s>\n", path );
 		return 0;
 	}
fb851d7e
 
dd0e65a8
 	if (strcmp(SER_FULL_VERSION, *m_ver)==0){
 		if (strcmp(SER_COMPILE_FLAGS, *m_flags)==0)
 			return 1;
 		else {
 			LOG(L_ERR, "ERROR: module compile flags mismatch for %s "
 						" \ncore: %s \nmodule: %s\n",
 						path, SER_COMPILE_FLAGS, *m_flags);
 			return 0;
 		}
 	}
627b66ef
 	LOG(L_ERR, "ERROR: module version mismatch for %s; "
dd0e65a8
 		"core: %s; module: %s\n", path, SER_FULL_VERSION, *m_ver );
2dcb8b67
 	return 0;
 }
3bf76e49
 
ea31876f
 /** load a sr module.
c9c181f8
  * 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
ea31876f
  *  <MODS_DIR>/<modname>/<modname>.so
c9c181f8
  * 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
ea31876f
  * @param modname - path or module name
  * @return 0 on success , <0 on error
  */
fdbb341c
 int load_module(char* mod_path)
3bf76e49
 {
 	void* handle;
 	char* error;
ea31876f
 	mod_register_function mr;
2873d384
 	union module_exports_u* exp;
 	unsigned* mod_if_ver;
404073d3
 	struct sr_module* t;
f4194f69
 	struct stat stat_buf;
b27dfba5
 	str modname;
fdbb341c
 	char* mdir;
 	char* nxt_mdir;
 	char* path;
 	int mdir_len;
f4194f69
 	int len;
ea31876f
 	int dlflags;
 	int new_dlflags;
 	int retries;
b27dfba5
 	int path_type;
fb851d7e
 
087d0976
 #ifndef RTLD_NOW
e61f4ba3
 /* for openbsd */
087d0976
 #define RTLD_NOW DL_LAZY
 #endif
fdbb341c
 	path=mod_path;
b27dfba5
 	path_type = 0;
 	modname.s = path;
 	modname.len = strlen(mod_path);
 	if(modname.len>3 && strcmp(modname.s+modname.len-3, ".so")==0) {
 		path_type = 1;
 		modname.len -= 3;
 	}
 	if (!strchr(path, '/'))
 		path_type |= 2;
 	if((path_type&2) || path[0] != '/') {
f4194f69
 		/* module name was given, we try to construct the path */
fdbb341c
 		mdir=mods_dir; /* search path */
 		do{
 			nxt_mdir=strchr(mdir, ':');
 			if (nxt_mdir) mdir_len=(int)(nxt_mdir-mdir);
 			else mdir_len=strlen(mdir);
 			
b27dfba5
 			if(path_type&2) {
 				/* try path <MODS_DIR>/<modname>.so */
 				path = (char*)pkg_malloc(mdir_len + 1 /* "/" */ +
 									modname.len + 3 /* ".so" */ + 1);
fdbb341c
 				if (path==0) goto error;
 				memcpy(path, mdir, mdir_len);
 				len = mdir_len;
b27dfba5
 				if (len != 0 && path[len - 1] != '/'){
fdbb341c
 					path[len]='/';
 					len++;
 				}
 				path[len]=0;
b27dfba5
 				strcat(path, modname.s);
 				if(!(path_type&1))
 					strcat(path, ".so");
fdbb341c
 
 				if (stat(path, &stat_buf) == -1) {
 					DBG("load_module: module file not found <%s>\n", path);
 					pkg_free(path);
b27dfba5
 
 					/* try path <MODS_DIR>/<modname>/<modname>.so */
 					path = (char*)pkg_malloc(
 						mdir_len + 1 /* "/" */ +
 						modname.len + 1 /* "/" */ +
 						modname.len + 3 /* ".so" */ + 1);
 					if (path==0) goto error;
 					memcpy(path, mdir, mdir_len);
 					len = mdir_len;
 					if (len != 0 && path[len - 1] != '/') {
 						path[len]='/';
 						len++;
 					}
 					path[len]=0;
 					strncat(path, modname.s, modname.len);
 					strcat(path, "/");
 					strcat(path, modname.s);
 					if(!(path_type&1))
 						strcat(path, ".so");
 
 					if (stat(path, &stat_buf) == -1) {
 						DBG("load_module: module file not found <%s>\n", path);
 						pkg_free(path);
 						path=0;
 					}
 				}
 			} else {
 				/* try mod_path - S compat */
 				if(path==mod_path) {
 					if (stat(path, &stat_buf) == -1) {
 						DBG("load_module: module file not found <%s>\n", path);
 						path=0;
 					}
 				}
 				if(path==0) {
 					/* try path <MODS_DIR>/mod_path - K compat */
 					path = (char*)pkg_malloc(mdir_len + 1 /* "/" */ +
 									strlen(mod_path) + 1);
 					if (path==0) goto error;
 					memcpy(path, mdir, mdir_len);
 					len = mdir_len;
 					if (len != 0 && path[len - 1] != '/'){
 						path[len]='/';
 						len++;
 					}
 					path[len]=0;
 					strcat(path, mod_path);
 
 					if (stat(path, &stat_buf) == -1) {
 						DBG("load_module: module file not found <%s>\n", path);
 						pkg_free(path);
 						path=0;
 					}
fdbb341c
 				}
f4194f69
 			}
fdbb341c
 			mdir=nxt_mdir?nxt_mdir+1:0;
 		}while(path==0 && mdir);
 		if (path==0){
b27dfba5
 			LOG(L_ERR, "ERROR: load_module: could not find module <%.*s> in"
 						" <%s>\n", modname.len, modname.s, mods_dir);
fdbb341c
 			goto error;
f4194f69
 		}
 	}
b27dfba5
 	DBG("load_module: trying to load <%s>\n", path);
 
ea31876f
 	retries=2;
 	dlflags=RTLD_NOW;
 reload:
9148ad98
 	handle=dlopen(path, RTLD_NOW); /* resolve all symbols now */
3bf76e49
 	if (handle==0){
 		LOG(L_ERR, "ERROR: load_module: could not open module <%s>: %s\n",
f4194f69
 			path, dlerror());
3bf76e49
 		goto error;
 	}
fb851d7e
 
3bf76e49
 	for(t=modules;t; t=t->next){
 		if (t->handle==handle){
 			LOG(L_WARN, "WARNING: load_module: attempting to load the same"
 						" module twice (%s)\n", path);
 			goto skip;
 		}
 	}
2dcb8b67
 	/* version control */
bae7e884
 	if (!version_control(handle, path)) {
 		exit(0);
 	}
2873d384
 	mod_if_ver = (unsigned *)dlsym(handle,
 									DLSYM_PREFIX "module_interface_ver");
 	if ( (error =(char*)dlerror())!=0 ){
 		LOG(L_ERR, "ERROR: no module interface version in module <%s>\n",
 					path );
 		goto error1;
 	}
3bf76e49
 	/* launch register */
ea31876f
 	mr = (mod_register_function)dlsym(handle, DLSYM_PREFIX "mod_register");
 	if (((error =(char*)dlerror())==0) && mr) {
 		/* no error call it */
 		new_dlflags=dlflags;
 		if (mr(path, &dlflags, 0, 0)!=0) {
 			LOG(L_ERR, "ERROR: load_module: %s: mod_register failed\n", path);
 			goto error1;
 		}
 		if (new_dlflags!=dlflags && new_dlflags!=0) {
 			/* we have to reload the module */
 			dlclose(handle);
 			dlflags=new_dlflags;
 			retries--;
 			if (retries>0) goto reload;
 			LOG(L_ERR, "ERROR: load_module: %s: cannot agree"
 					" on the dlflags\n", path);
 			goto error;
 		}
 	}
2873d384
 	exp = (union module_exports_u*)dlsym(handle, DLSYM_PREFIX "exports");
381659ac
 	if ( (error =(char*)dlerror())!=0 ){
3bf76e49
 		LOG(L_ERR, "ERROR: load_module: %s\n", error);
 		goto error1;
 	}
ea31876f
 	/* hack to allow for kamailio style dlflags inside exports */
 	if (*mod_if_ver == 1) {
 		new_dlflags = exp->v1.dlflags;
 		if (new_dlflags!=dlflags && new_dlflags!=DEFAULT_DLFLAGS) {
 			/* we have to reload the module */
 			dlclose(handle);
 			WARN("%s: exports dlflags interface is deprecated and it will not"
 					"be supported in newer versions; consider using"
 					" mod_register() instead", path);
 			dlflags=new_dlflags;
 			retries--;
 			if (retries>0) goto reload;
 			LOG(L_ERR, "ERROR: load_module: %s: cannot agree"
 					" on the dlflags\n", path);
 			goto error;
 		}
 	}
2873d384
 	if (register_module(*mod_if_ver, exp, path, handle)<0) goto error1;
3bf76e49
 	return 0;
 
 error1:
 	dlclose(handle);
 error:
 skip:
fdbb341c
 	if (path && path!=mod_path)
 		pkg_free(path);
3bf76e49
 	return -1;
 }
 
 
 
2873d384
 /* searches the module list for function name in module mod and returns 
  *  a pointer to the "name" function record union or 0 if not found
  * sets also *mod_if_ver to the module interface version (needed to know
  * which member of the union should be accessed v0 or v1)
  * mod==0 is a wildcard matching all modules
49b28ea4
  * flags parameter is OR value of all flags that must match
51c38611
  */
2873d384
 union cmd_export_u* find_mod_export_record(char* mod, char* name,
 											int param_no, int flags,
 											unsigned* mod_if_ver)
3bf76e49
 {
 	struct sr_module* t;
2873d384
 	union cmd_export_u* cmd;
 	int i;
 	unsigned mver;
 
 #define FIND_EXPORT_IN_MOD(VER) \
 		if (t->exports->VER.cmds) \
 			for(i=0, cmd=(void*)&t->exports->VER.cmds[0]; cmd->VER.name; \
 					i++, cmd=(void*)&t->exports->VER.cmds[i]){\
 				if((strcmp(name, cmd->VER.name)==0)&& \
a2da0c58
 					((cmd->VER.param_no==param_no) || \
 					 (cmd->VER.param_no==VAR_PARAM_NO)) && \
2873d384
 					((cmd->VER.flags & flags) == flags) \
 				){ \
 					DBG("find_export_record: found <%s> in module %s [%s]\n", \
 						name, t->exports->VER.name, t->path); \
 					*mod_if_ver=mver; \
 					return cmd; \
 				} \
 			}
3bf76e49
 
 	for(t=modules;t;t=t->next){
2873d384
 		if (mod!=0 && (strcmp(t->exports->c.name, mod) !=0))
 			continue;
 		mver=t->mod_interface_ver;
 		switch (mver){
 			case 0:
 				FIND_EXPORT_IN_MOD(v0);
 				break;
 			case 1:
 				FIND_EXPORT_IN_MOD(v1);
 				break;
 			default:
 				BUG("invalid module interface version %d for modules %s\n",
 						t->mod_interface_ver, t->path);
3bf76e49
 		}
 	}
f141bc93
 	DBG("find_export_record: <%s> not found \n", name);
3bf76e49
 	return 0;
 }
 
34fd2612
 
2873d384
 
 /* searches the module list for function name and returns 
  *  a pointer to the "name" function record union or 0 if not found
  * sets also *mod_if_ver to the module interface version (needed to know
  * which member of the union should be accessed v0 or v1)
  * mod==0 is a wildcard matching all modules
  * flags parameter is OR value of all flags that must match
  */
 union cmd_export_u* find_export_record(char* name,
 											int param_no, int flags,
 											unsigned* mod_if_ver)
 {
 	return find_mod_export_record(0, name, param_no, flags, mod_if_ver);
 }
 
 
 
f141bc93
 cmd_function find_export(char* name, int param_no, int flags)
 {
2873d384
 	union cmd_export_u* cmd;
 	unsigned mver;
 	
 	cmd = find_export_record(name, param_no, flags, &mver);
 	return cmd?cmd->c.function:0;
f141bc93
 }
 
 
300b0f50
 rpc_export_t* find_rpc_export(char* name, int flags)
 {
5099fd64
 	return rpc_lookup((char*)name, strlen(name));
300b0f50
 }
 
49b28ea4
 
 /*
2873d384
  * searches the module list and returns pointer to "name" function in module
  * "mod"
49b28ea4
  * 0 if not found
  * flags parameter is OR value of all flags that must match
  */
 cmd_function find_mod_export(char* mod, char* name, int param_no, int flags)
 {
2873d384
 	union cmd_export_u* cmd;
 	unsigned mver;
49b28ea4
 
2873d384
 	cmd=find_mod_export_record(mod, name, param_no, flags, &mver);
 	if (cmd)
 		return cmd->c.function;
 	
fb851d7e
 	DBG("find_mod_export: <%s> in module <%s> not found\n", name, mod);
49b28ea4
 	return 0;
 }
 
 
fb851d7e
 struct sr_module* find_module_by_name(char* mod) {
 	struct sr_module* t;
 
 	for(t = modules; t; t = t->next) {
2873d384
 		if (strcmp(mod, t->exports->c.name) == 0) {
fb851d7e
 			return t;
 		}
 	}
 	DBG("find_module_by_name: module <%s> not found\n", mod);
 	return 0;
 }
49b28ea4
 
 
2873d384
 void* find_param_export(struct sr_module* mod, char* name,
 						modparam_t type_mask, modparam_t *param_type)
31309a3a
 {
6419a43f
 	param_export_t* param;
31309a3a
 
fb851d7e
 	if (!mod)
 		return 0;
2873d384
 	param=0;
 	switch(mod->mod_interface_ver){
 		case 0:
 			param=mod->exports->v0.params;
 			break;
 		case 1:
 			param=mod->exports->v1.params;
 			break;
 		default:
 			BUG("bad module interface version %d in module %s [%s]\n",
 					mod->mod_interface_ver, mod->exports->c.name, mod->path);
 			return 0;
 	}
 	for(;param && param->name ; param++) {
fb851d7e
 		if ((strcmp(name, param->name) == 0) &&
 			((param->type & PARAM_TYPE_MASK(type_mask)) != 0)) {
 			DBG("find_param_export: found <%s> in module %s [%s]\n",
2873d384
 				name, mod->exports->c.name, mod->path);
fb851d7e
 			*param_type = param->type;
 			return param->param_pointer;
31309a3a
 		}
 	}
fb851d7e
 	DBG("find_param_export: parameter <%s> not found in module <%s>\n",
2873d384
 			name, mod->exports->c.name);
31309a3a
 	return 0;
 }
 
 
bf08223a
 void destroy_modules()
 {
3c8bd369
 	struct sr_module* t, *foo;
 
 	t=modules;
 	while(t) {
 		foo=t->next;
2873d384
 		if (t->exports){
 			switch(t->mod_interface_ver){
 				case 0:
 					if ((t->exports->v0.destroy_f)) t->exports->v0.destroy_f();
 					break;
 				case 1:
 					if ((t->exports->v1.destroy_f)) t->exports->v1.destroy_f();
 					break;
 				default:
 					BUG("bad module interface version %d in module %s [%s]\n",
 						t->mod_interface_ver, t->exports->c.name,
 						t->path);
 			}
 		}
3c8bd369
 		pkg_free(t);
 		t=foo;
 	}
8aeb47e2
 	modules=0;
55faef7d
 	if (mod_response_cbks){
 		pkg_free(mod_response_cbks);
 		mod_response_cbks=0;
 	}
bf08223a
 }
31309a3a
 
9243edb9
 #ifdef NO_REVERSE_INIT
31309a3a
 
 /*
  * Initialize all loaded modules, the initialization
  * is done *AFTER* the configuration file is parsed
  */
 int init_modules(void)
 {
 	struct sr_module* t;
fb851d7e
 
31309a3a
 	for(t = modules; t; t = t->next) {
2873d384
 		if (t->exports){
 			switch(t->mod_interface_ver){
 				case 0:
 					if (t->exports->v0.init_f)
 						if (t->exports->v0.init_f() != 0) {
 							LOG(L_ERR, "init_modules(): Error while"
 										" initializing module %s\n",
 										t->exports->v0.name);
 							return -1;
 						}
 					if (t->exports->v0.response_f)
 						mod_response_cbk_no++;
 					break;
 				case 1:
 					if (t->exports->v1.init_f)
 						if (t->exports->v1.init_f() != 0) {
 							LOG(L_ERR, "init_modules(): Error while"
 										" initializing module %s\n",
 										t->exports->v1.name);
 							return -1;
 						}
 					if (t->exports->v1.response_f)
 						mod_response_cbk_no++;
 					break;
 				default:
 					BUG("bad module interface version %d in module %s [%s]\n",
 						t->exports->c.name, t->path);
 					return -1;
31309a3a
 			}
2873d384
 		}
55faef7d
 	}
 	mod_response_cbks=pkg_malloc(mod_response_cbk_no * 
 									sizeof(response_function));
 	if (mod_response_cbks==0){
 		LOG(L_ERR, "init_modules(): memory allocation failure"
 					" for %d response_f callbacks\n", mod_response_cbk_no);
 		return -1;
 	}
 	for (t=modules, i=0; t && (i<mod_response_cbk_no); t=t->next){
2873d384
 		if (t->exports){
 			switch(t->mod_interface_ver){
 				case 0:
 					if (t->exports->v0.response_f){
 						mod_response_cbks[i]=t->exports->v0.response_f;
 						i++;
 					}
 					break;
 				case 1:
 					if (t->exports->v1.response_f){
 						mod_response_cbks[i]=t->exports->v1.response_f;
 						i++;
 					}
 					break;
 			}
55faef7d
 		}
31309a3a
 	}
 	return 0;
 }
9243edb9
 
 /*
  * per-child initialization
  */
 int init_child(int rank)
 {
 	struct sr_module* t;
cb87691a
 	char* type;
 
 	switch(rank) {
 	case PROC_MAIN:     type = "PROC_MAIN";     break;
 	case PROC_TIMER:    type = "PROC_TIMER";    break;
 	case PROC_FIFO:     type = "PROC_FIFO";     break;
 	case PROC_TCP_MAIN: type = "PROC_TCP_MAIN"; break;
 	default:            type = "CHILD";         break;
 	}
 	DBG("init_child: initializing %s with rank %d\n", type, rank);
fb851d7e
 
9243edb9
 
 	for(t = modules; t; t = t->next) {
2873d384
 		switch(t->mod_interface_ver){
 			case 0:
 				if (t->exports->v0.init_child_f) {
 					if ((t->exports->v0.init_child_f(rank)) < 0) {
 						LOG(L_ERR, "init_child(): Initialization of child"
 									" %d failed\n", rank);
 						return -1;
 					}
 				}
 				break;
 			case 1:
 				if (t->exports->v1.init_child_f) {
 					if ((t->exports->v1.init_child_f(rank)) < 0) {
 						LOG(L_ERR, "init_child(): Initialization of child"
 									" %d failed\n", rank);
 						return -1;
 					}
 				}
 				break;
 			default:
 				BUG("bad module interface version %d in module %s [%s]\n",
 						t->mod_interface_ver, t->exports->c.name,
 						t->path);
9243edb9
 				return -1;
 		}
 	}
 	return 0;
 }
 
 #else
 
 
 /* recursive module child initialization; (recursion is used to
    process the module linear list in the same order in
    which modules are loaded in config file
 */
 
 static int init_mod_child( struct sr_module* m, int rank )
 {
 	if (m) {
 		/* iterate through the list; if error occurs,
 		   propagate it up the stack
 		 */
 		if (init_mod_child(m->next, rank)!=0) return -1;
2873d384
 		if (m->exports){
 			switch(m->mod_interface_ver){
 				case 0:
 					if (m->exports->v0.init_child_f) {
 						DBG("DEBUG: init_mod_child (%d): %s\n",
 								rank, m->exports->v0.name);
 						if (m->exports->v0.init_child_f(rank)<0) {
 							LOG(L_ERR, "init_mod_child(): Error while"
 										" initializing module %s\n",
 										m->exports->v0.name);
 							return -1;
 						} else {
 							/* module correctly initialized */
 							return 0;
 						}
 					}
 					/* no init function -- proceed with success */
 					return 0;
 				case 1:
 					if (m->exports->v1.init_child_f) {
 						DBG("DEBUG: init_mod_child (%d): %s\n",
 								rank, m->exports->v1.name);
 						if (m->exports->v1.init_child_f(rank)<0) {
 							LOG(L_ERR, "init_mod_child(): Error while"
 										" initializing module %s\n",
 										m->exports->v1.name);
 							return -1;
 						} else {
 							/* module correctly initialized */
 							return 0;
 						}
 					}
 					/* no init function -- proceed with success */
 					return 0;
9243edb9
 			}
 		}
2873d384
 		/* no exports -- proceed with success */
9243edb9
 		return 0;
 	} else {
 		/* end of list */
 		return 0;
 	}
 }
 
 
 /*
  * per-child initialization
  */
 int init_child(int rank)
 {
 	return init_mod_child(modules, rank);
 }
 
 
 
 /* recursive module initialization; (recursion is used to
    process the module linear list in the same order in
    which modules are loaded in config file
 */
 
 static int init_mod( struct sr_module* m )
 {
 	if (m) {
 		/* iterate through the list; if error occurs,
 		   propagate it up the stack
 		 */
 		if (init_mod(m->next)!=0) return -1;
2873d384
 		if (m->exports){
 			switch(m->mod_interface_ver){
 				case 0:
 					if ( m->exports->v0.init_f) {
 						DBG("DEBUG: init_mod: %s\n", m->exports->v0.name);
 						if (m->exports->v0.init_f()!=0) {
 							LOG(L_ERR, "init_mod(): Error while initializing"
 										" module %s\n", m->exports->v0.name);
 							return -1;
 						} else {
 							/* module correctly initialized */
 							return 0;
 						}
 					}
 					/* no init function -- proceed with success */
 					return 0;
 				case 1:
 					if ( m->exports->v1.init_f) {
 						DBG("DEBUG: init_mod: %s\n", m->exports->v1.name);
 						if (m->exports->v1.init_f()!=0) {
 							LOG(L_ERR, "init_mod(): Error while initializing"
 										" module %s\n", m->exports->v1.name);
 							return -1;
 						} else {
 							/* module correctly initialized */
 							return 0;
 						}
 					}
 					/* no init function -- proceed with success */
 					return 0;
9243edb9
 			}
 		}
2873d384
 		/* no exports -- proceed with success */
9243edb9
 		return 0;
 	} else {
 		/* end of list */
 		return 0;
 	}
 }
 
 /*
  * Initialize all loaded modules, the initialization
  * is done *AFTER* the configuration file is parsed
  */
 int init_modules(void)
 {
55faef7d
 	struct sr_module* t;
 	int i;
 	
 	for(t = modules; t; t = t->next)
2873d384
 		if (t->exports){
 			switch(t->mod_interface_ver){
 				case 0:
 					if (t->exports->v0.response_f)
 						mod_response_cbk_no++;
 					break;
 				case 1:
 					if (t->exports->v1.response_f)
 						mod_response_cbk_no++;
 					break;
 			}
 		}
55faef7d
 	mod_response_cbks=pkg_malloc(mod_response_cbk_no * 
 									sizeof(response_function));
 	if (mod_response_cbks==0){
 		LOG(L_ERR, "init_modules(): memory allocation failure"
 					" for %d response_f callbacks\n", mod_response_cbk_no);
 		return -1;
 	}
 	for (t=modules, i=0; t && (i<mod_response_cbk_no); t=t->next){
2873d384
 		if (t->exports){
 			switch(t->mod_interface_ver){
 				case 0:
 					if (t->exports->v0.response_f){
 						mod_response_cbks[i]=t->exports->v0.response_f;
 						i++;
 					}
 					break;
 				case 1:
 					if (t->exports->v1.response_f){
 						mod_response_cbks[i]=t->exports->v1.response_f;
 						i++;
 					}
 					break;
 			}
55faef7d
 		}
 	}
 	
9243edb9
 	return init_mod(modules);
 }
 
 #endif
bb6575cd
 
 
f2f12966
 action_u_t *fixup_get_param(void **cur_param, int cur_param_no,
 							int required_param_no)
 {
f141bc93
 	action_u_t *a, a2;
f4194f69
 	/* cur_param points to a->u.string, get pointer to a */
f141bc93
 	a = (void*) ((char *)cur_param - ((char *)&a2.u.string-(char *)&a2));
 	return a + required_param_no - cur_param_no;
 }
 
f2f12966
 int fixup_get_param_count(void **cur_param, int cur_param_no)
 {
f141bc93
 	action_u_t *a;
 	a = fixup_get_param(cur_param, cur_param_no, 0);
 	if (a)
 		return a->u.number;
 	else
 		return -1;
 }
6d35d70e
 
 
 /* fixes flag params (resolves possible named flags)
  * use PARAM_USE_FUNC|PARAM_STRING as a param. type and create
  * a wrapper function that does just:
  * return fix_flag(type, val, "my_module", "my_param", &flag_var)
  * see also param_func_t.
  */
 int fix_flag( modparam_t type, void* val,
 					char* mod_name, char* param_name, int* flag)
 {
 	int num;
 	int err;
 	int f, len;
 	char* s;
 	char *p;
f4194f69
 
6d35d70e
 	if ((type & PARAM_STRING)==0){
 		LOG(L_CRIT, "BUG: %s: fix_flag(%s): bad parameter type\n",
 					mod_name, param_name);
 		return -1;
 	}
 	s=(char*)val;
 	len=strlen(s);
 	f=-1;
 	/* try to see if it's a number */
 	num = str2s(s, len, &err);
 	if (err != 0) {
 		/* see if it's in the name:<no> format */
 		p=strchr(s, ':');
 		if (p){
 			f= str2s(p+1, strlen(p+1), &err);
 			if (err!=0){
 				LOG(L_ERR, "ERROR: %s: invalid %s format:"
 						" \"%s\"", mod_name, param_name, s);
 				return -1;
 			}
 			*p=0;
 		}
 		if ((num=get_flag_no(s, len))<0){
 			/* not declared yet, declare it */
 			num=register_flag(s, f);
 		}
 		if (num<0){
 			LOG(L_ERR, "ERROR: %s: bad %s %s\n", mod_name, param_name, s);
 			return -1;
 		} else if ((f>0) && (num!=f)){
 			LOG(L_ERR, "WARNING: %s: flag %s already defined"
 					" as %d (and not %d), using %s:%d\n",
 					mod_name, s, num, f, s, num);
 		}
 	}
 	*flag=num;
 	return 0;
 }
b91364c6
 
d0ce0ebd
 /*
  * Common function parameter fixups
  */
b91364c6
 
f2f12966
 /** Generic parameter fixup function.
  *  Creates a fparam_t structure.
  *  @param type  contains allowed parameter types
  *  @param param is the parameter that will be fixed-up
cd892e69
  *
f2f12966
  * @return
cd892e69
  *    0 on success, 
  *    1 if the param doesn't match the specified type
  *    <0 on failure
b91364c6
  */
 int fix_param(int type, void** param)
f4194f69
 {
f2f12966
 	fparam_t* p;
 	str name, s;
 	unsigned int num;
 	int err;
f4194f69
 
f2f12966
 	p = (fparam_t*)pkg_malloc(sizeof(fparam_t));
 	if (!p) {
 		ERR("No memory left\n");
 		return E_OUT_OF_MEM;
d0ce0ebd
 	}
f2f12966
 	memset(p, 0, sizeof(fparam_t));
 	p->orig = *param;
 	
 	switch(type) {
 		case FPARAM_UNSPEC:
 			ERR("Invalid type value\n");
 			goto error;
 		case FPARAM_STRING:
 			p->v.asciiz = *param;
b25e31aa
 			/* no break */
f2f12966
 		case FPARAM_STR:
 			p->v.str.s = (char*)*param;
 			p->v.str.len = strlen(p->v.str.s);
235a9c07
 			p->fixed = &p->v;
f2f12966
 			break;
 		case FPARAM_INT:
 			s.s = (char*)*param;
 			s.len = strlen(s.s);
 			err = str2int(&s, &num);
 			if (err == 0) {
 				p->v.i = (int)num;
 			} else {
 				/* Not a number */
 				pkg_free(p);
 				return 1;
 			}
235a9c07
 			p->fixed = (void*)(long)num;
f2f12966
 			break;
 		case FPARAM_REGEX:
 			if ((p->v.regex = pkg_malloc(sizeof(regex_t))) == 0) {
 				ERR("No memory left\n");
235a9c07
 				goto error;
f2f12966
 			}
 			if (regcomp(p->v.regex, *param,
 						REG_EXTENDED|REG_ICASE|REG_NEWLINE)) {
 				pkg_free(p->v.regex);
ad4f08c9
 				p->v.regex=0;
b25e31aa
 				/* not a valid regex */
 				goto no_match;
f2f12966
 			}
15d47d5c
 			p->fixed = p->v.regex;
f2f12966
 			break;
 		case FPARAM_AVP:
 			name.s = (char*)*param;
 			name.len = strlen(name.s);
 			trim(&name);
 			if (!name.len || name.s[0] != '$') {
 				/* Not an AVP identifier */
b25e31aa
 				goto no_match;
f2f12966
 			}
 			name.s++;
 			name.len--;
 			if (parse_avp_ident(&name, &p->v.avp) < 0) {
b25e31aa
 				/* invalid avp identifier (=> no match) */
 				goto no_match;
f2f12966
 			}
235a9c07
 			p->fixed = &p->v;
f2f12966
 			break;
 		case FPARAM_SELECT:
 			name.s = (char*)*param;
 			name.len = strlen(name.s);
 			trim(&name);
 			if (!name.len || name.s[0] != '@') {
 				/* Not a select identifier */
b25e31aa
 				goto no_match;
f2f12966
 			}
 			if (parse_select(&name.s, &p->v.select) < 0) {
 				ERR("Error while parsing select identifier\n");
 				goto error;
 			}
235a9c07
 			p->fixed = &p->v;
f2f12966
 			break;
 		case FPARAM_SUBST:
 			s.s = *param;
 			s.len = strlen(s.s);
 			p->v.subst = subst_parser(&s);
 			if (!p->v.subst) {
 				ERR("Error while parsing regex substitution\n");
ad4f08c9
 				goto error;
 			}
235a9c07
 			p->fixed = &p->v;
ad4f08c9
 			break;
 		case FPARAM_PVS:
 			name.s = (char*)*param;
 			name.len = strlen(name.s);
 			trim(&name);
 			if (!name.len || name.s[0] != '$'){
 				/* not a pvs identifier */
b25e31aa
 				goto no_match;
ad4f08c9
 			}
 			p->v.pvs=pkg_malloc(sizeof(pv_spec_t));
 			if (p->v.pvs==0){
 				ERR("out of memory while parsing pv_spec_t\n");
 				goto error;
 			}
b25e31aa
 			if (pv_parse_spec2(&name, p->v.pvs, 1)==0){
 				/* not a valid pvs identifier (but it might be an avp) */
ad4f08c9
 				pkg_free(p->v.pvs);
 				p->v.pvs=0;
b25e31aa
 				goto no_match;
ad4f08c9
 			}
d64c1c71
 			p->fixed = p->v.pvs;
ad4f08c9
 			break;
 		case FPARAM_PVE:
 			name.s = (char*)*param;
 			name.len = strlen(name.s);
 			if (pv_parse_format(&name, &p->v.pve)<0){
 				ERR("bad PVE format: \"%.*s\"\n", name.len, name.s);
 				goto error;
f2f12966
 			}
235a9c07
 			p->fixed = &p->v;
f2f12966
 			break;
b91364c6
 	}
f2f12966
 	
 	p->type = type;
 	*param = (void*)p;
 	return 0;
 	
b25e31aa
 no_match:
 	pkg_free(p);
 	return 1;
f2f12966
 error:
 	pkg_free(p);
 	return E_UNSPEC;
d0ce0ebd
 }
b91364c6
 
 
ad4f08c9
 
 /** fparam_t free function.
  *  Frees the "content" of a fparam, but not the fparam itself.
  *  Assumes pkg_malloc'ed content.
  *  @param fp -  fparam to be freed
  *
  */
 void fparam_free_contents(fparam_t* fp)
 {
 
 	if (fp==0)
 		return;
 	switch(fp->type) {
 		case FPARAM_UNSPEC:
 		case FPARAM_STRING: /* asciiz string, not str */
 		case FPARAM_INT:
 		case FPARAM_STR:
 			/* nothing to do */
 			return;
 		case FPARAM_REGEX:
 			if (fp->v.regex){
 				regfree(fp->v.regex);
 				pkg_free(fp->v.regex);
 				fp->v.regex=0;
 			}
 			break;
 		case FPARAM_AVP:
 			free_avp_name(&fp->v.avp.flags, &fp->v.avp.name);
 			break;
 		case FPARAM_SELECT:
 			if (fp->v.select){
 				free_select(fp->v.select);
 				fp->v.select=0;
 			}
 			break;
 		case FPARAM_SUBST:
 			if (fp->v.subst){
 				subst_expr_free(fp->v.subst);
 				fp->v.subst=0;
 			}
 			break;
 		case FPARAM_PVS:
 			if (fp->v.pvs){
 				pv_spec_free(fp->v.pvs);
 				fp->v.pvs=0;
 			}
 			break;
 		case FPARAM_PVE:
 			if (fp->v.pve){
 				pv_elem_free_all(fp->v.pve);
 				fp->v.pve=0;
 			}
 			break;
 	}
 }
 
 
bf9d1c43
 
 /** fix a param to one of the given types (mask).
   *
   * @param types - bitmap of the allowed types (e.g. FPARAM_INT|FPARAM_STR)
   * @param param - value/result
   * @return - 0 on success, -1 on error, 1 if param doesn't
   *           match any of the types
   */
 int fix_param_types(int types, void** param)
 {
 	int ret;
 	int t;
 	
 	for (t=types & ~(types-1); types; types&=(types-1), t=types & ~(types-1)){
 		if ((ret=fix_param(t, param))<=0) return ret;
 	}
 	return E_UNSPEC;
 }
 
 
 
d0ce0ebd
 /*
  * 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
  * This function returns -1 on an error
  */
 int fixup_var_str_12(void** param, int param_no)
 {
f2f12966
 	int ret;
b25e31aa
 	if ((sr_cfg_compat!=SR_COMPAT_SER) &&
 		((ret = fix_param(FPARAM_PVS, param)) <= 0)) return ret;
f2f12966
 	if ((ret = fix_param(FPARAM_AVP, param)) <= 0) return ret;
 	if ((ret = fix_param(FPARAM_SELECT, param)) <= 0) return ret;
 	if ((ret = fix_param(FPARAM_STR, param)) <= 0) return ret;
 	ERR("Error while fixing parameter, AVP, SELECT, and str conversions"
 			" failed\n");
 	return -1;
d0ce0ebd
 }
b91364c6
 
d0ce0ebd
 /* Same as fixup_var_str_12 but applies to the 1st parameter only */
 int fixup_var_str_1(void** param, int param_no)
 {
f2f12966
 	if (param_no == 1) return fixup_var_str_12(param, param_no);
 	else return 0;
d0ce0ebd
 }
c16e9887
 
d0ce0ebd
 /* Same as fixup_var_str_12 but applies to the 2nd parameter only */
 int fixup_var_str_2(void** param, int param_no)
 {
f2f12966
 	if (param_no == 2) return fixup_var_str_12(param, param_no);
 	else return 0;
d0ce0ebd
 }
b91364c6
 
 
d0ce0ebd
 /*
  * Fixup variable integer, the parameter can be
  * AVP, SELECT, or ordinary integer. AVP and select
f4194f69
  * identifiers will be resolved to their values and
d0ce0ebd
  * converted to int if necessary during runtime
  *
  * The parameter value will be converted to fparam structure
  * This function returns -1 on an error
  */
 int fixup_var_int_12(void** param, int param_no)
 {
f2f12966
 	int ret;
b25e31aa
 	if ((sr_cfg_compat!=SR_COMPAT_SER) &&
 		((ret = fix_param(FPARAM_PVS, param)) <= 0)) return ret;
f2f12966
 	if ((ret = fix_param(FPARAM_AVP, param)) <= 0) return ret;
 	if ((ret = fix_param(FPARAM_SELECT, param)) <= 0) return ret;
 	if ((ret = fix_param(FPARAM_INT, param)) <= 0) return ret;
 	ERR("Error while fixing parameter, AVP, SELECT, and int conversions"
 			" failed\n");
 	return -1;
d0ce0ebd
 }
 
 /* Same as fixup_var_int_12 but applies to the 1st parameter only */
 int fixup_var_int_1(void** param, int param_no)
 {
f2f12966
 	if (param_no == 1) return fixup_var_int_12(param, param_no);
 	else return 0;
d0ce0ebd
 }
 
 /* Same as fixup_var_int_12 but applies to the 2nd parameter only */
 int fixup_var_int_2(void** param, int param_no)
 {
f2f12966
 	if (param_no == 2) return fixup_var_int_12(param, param_no);
 	else return 0;
d0ce0ebd
 }
 
 
 /*
  * The parameter must be a regular expression which must compile, the
  * parameter will be converted to compiled regex
  */
 int fixup_regex_12(void** param, int param_no)
 {
f2f12966
 	int ret;
d0ce0ebd
 
f2f12966
 	if ((ret = fix_param(FPARAM_REGEX, param)) <= 0) return ret;
 	ERR("Error while compiling regex in function parameter\n");
 	return -1;
d0ce0ebd
 }
 
 /* Same as fixup_regex_12 but applies to the 1st parameter only */
 int fixup_regex_1(void** param, int param_no)
 {
f2f12966
 	if (param_no == 1) return fixup_regex_12(param, param_no);
 	else return 0;
d0ce0ebd
 }
 
 /* Same as fixup_regex_12 but applies to the 2nd parameter only */
 int fixup_regex_2(void** param, int param_no)
 {
f2f12966
 	if (param_no == 2) return fixup_regex_12(param, param_no);
 	else return 0;
d0ce0ebd
 }
 
 /*
  * The string parameter will be converted to integer
  */
 int fixup_int_12(void** param, int param_no)
 {
f2f12966
 	int ret;
d0ce0ebd
 
f2f12966
 	if ((ret = fix_param(FPARAM_INT, param)) <= 0) return ret;
 	ERR("Cannot function parameter to integer\n");
 	return -1;
d0ce0ebd
 
 }
 
 /* Same as fixup_int_12 but applies to the 1st parameter only */
 int fixup_int_1(void** param, int param_no)
 {
f2f12966
 	if (param_no == 1) return fixup_int_12(param, param_no);
 	else return 0;
d0ce0ebd
 }
 
 /* Same as fixup_int_12 but applies to the 2nd parameter only */
 int fixup_int_2(void** param, int param_no)
 {
f2f12966
 	if (param_no == 2) return fixup_int_12(param, param_no);
 	else return 0;
d0ce0ebd
 }
 
 /*
  * Parse the parameter as static string, do not resolve
  * AVPs or selects, convert the parameter to str structure
  */
 int fixup_str_12(void** param, int param_no)
 {
f2f12966
 	int ret;
d0ce0ebd
 
f2f12966
 	if ((ret = fix_param(FPARAM_STR, param)) <= 0) return ret;
 	ERR("Cannot function parameter to string\n");
 	return -1;
d0ce0ebd
 }
 
 /* Same as fixup_str_12 but applies to the 1st parameter only */
 int fixup_str_1(void** param, int param_no)
 {
f2f12966
 	if (param_no == 1) return fixup_str_12(param, param_no);
 	else return 0;
d0ce0ebd
 }
 
 /* Same as fixup_str_12 but applies to the 2nd parameter only */
 int fixup_str_2(void** param, int param_no)
 {
f2f12966
 	if (param_no == 2) return fixup_str_12(param, param_no);
 	else return 0;
b91364c6
 }
c16e9887
 
 
8f281796
 
 #define PV_PRINT_BUF_SIZE  1024
 #define PV_PRINT_BUF_NO    3
39af8f24
 /** Get the function parameter value as string.
  *  @return  0 - Success
  *          -1 - Cannot get value
c16e9887
  */
 int get_str_fparam(str* dst, struct sip_msg* msg, fparam_t* param)
 {
f2f12966
 	int_str val;
 	int ret;
 	avp_t* avp;
39af8f24
 	pv_value_t pv_val;
8f281796
 	static int buf_itr = 0; /* ugly hack needed for PVE */
 	static char pve_buf[PV_PRINT_BUF_NO][PV_PRINT_BUF_SIZE];
f2f12966
 	
 	switch(param->type) {
 		case FPARAM_REGEX:
 		case FPARAM_UNSPEC:
 		case FPARAM_INT:
 			return -1;
 		case FPARAM_STRING:
 			dst->s = param->v.asciiz;
 			dst->len = strlen(param->v.asciiz);
 			break;
 		case FPARAM_STR:
 			*dst = param->v.str;
 			break;
 		case FPARAM_AVP:
 			avp = search_first_avp(param->v.avp.flags, param->v.avp.name,
 									&val, 0);
39af8f24
 			if (unlikely(!avp)) {
f2f12966
 				DBG("Could not find AVP from function parameter '%s'\n",
 						param->orig);
 				return -1;
 			}
39af8f24
 			if (likely(avp->flags & AVP_VAL_STR)) {
f2f12966
 				*dst = val.s;
 			} else {
 		 		/* The caller does not know of what type the AVP will be so
 				 * convert int AVPs into string here
 				 */
 				dst->s = int2str(val.n, &dst->len);
 			}
 			break;
 		case FPARAM_SELECT:
 			ret = run_select(dst, param->v.select, msg);
39af8f24
 			if (unlikely(ret < 0 || ret > 0)) return -1;
 			break;
 		case FPARAM_PVS:
 			if (likely((pv_get_spec_value(msg, param->v.pvs, &pv_val)==0) &&
 					   ((pv_val.flags&(PV_VAL_NULL|PV_VAL_STR))==PV_VAL_STR))){
 					*dst=pv_val.rs;
 			}else{
 				ERR("Could not convert PV to str\n");
 				return -1;
 			}
 			break;
 		case FPARAM_PVE:
8f281796
 			dst->s=pve_buf[buf_itr];
 			dst->len=PV_PRINT_BUF_SIZE;
 			buf_itr = (buf_itr+1)%PV_PRINT_BUF_NO;
 			if (unlikely(pv_printf(msg, param->v.pve, dst->s, &dst->len)!=0)){
39af8f24
 				ERR("Could not convert the PV-formated string to str\n");
 				dst->len=0;
 				return -1;
 			};
f2f12966
 			break;
c16e9887
 	}
f2f12966
 	return 0;
c16e9887
 }
 
d0ce0ebd
 
39af8f24
 /** Get the function parameter value as integer.
  *  @return  0 - Success
  *          -1 - Cannot get value
d0ce0ebd
  */
 int get_int_fparam(int* dst, struct sip_msg* msg, fparam_t* param)
 {
f2f12966
 	int_str val;
 	int ret;
 	avp_t* avp;
 	str tmp;
39af8f24
 	pv_value_t pv_val;
f4194f69
 
f2f12966
 	switch(param->type) {
 		case FPARAM_INT:
 			*dst = param->v.i;
 			return 0;
 		case FPARAM_REGEX:
 		case FPARAM_UNSPEC:
 		case FPARAM_STRING:
 		case FPARAM_STR:
 			return -1;
 		case FPARAM_AVP:
 			avp = search_first_avp(param->v.avp.flags, param->v.avp.name,
 									&val, 0);
39af8f24
 			if (unlikely(!avp)) {
f2f12966
 				DBG("Could not find AVP from function parameter '%s'\n",
 						param->orig);
 				return -1;
 			}
 			if (avp->flags & AVP_VAL_STR) {
 				if (str2int(&val.s, (unsigned int*)dst) < 0) {
 					ERR("Could not convert AVP string value to int\n");
 					return -1;
 				}
 			} else {
 				*dst = val.n;
 			}
 			break;
 		case FPARAM_SELECT:
 			ret = run_select(&tmp, param->v.select, msg);
39af8f24
 			if (unlikely(ret < 0 || ret > 0)) return -1;
 			if (unlikely(str2int(&tmp, (unsigned int*)dst) < 0)) {
f2f12966
 				ERR("Could not convert select result to int\n");
 				return -1;
 			}
 			break;
39af8f24
 		case FPARAM_PVS:
 			if (likely((pv_get_spec_value(msg, param->v.pvs, &pv_val)==0) &&
 					   ((pv_val.flags&(PV_VAL_NULL|PV_VAL_INT))==PV_VAL_INT))){
 					*dst=pv_val.ri;
 			}else{
 				ERR("Could not convert PV to int\n");
 				return -1;
 			}
 			break;
 		case FPARAM_PVE:
 			return -1;
d0ce0ebd
 	}
f2f12966
 	return 0;
d0ce0ebd
 }
44c65404
 
 /**
  * Retrieve the compiled RegExp.
  * @return: 0 for success, negative on error.
  */
 int get_regex_fparam(regex_t *dst, struct sip_msg* msg, fparam_t* param)
 {
 	switch (param->type) {
 		case FPARAM_REGEX:
 			*dst = *param->v.regex;
 			return 0;
 		default:
 			ERR("unexpected parameter type (%d), instead of regexp.\n", 
 					param->type);
 	}
 	return -1;
 }