2bf336caf213c8d056a6ada58df02364857d1049
[sip-router] / src / core / sr_module.c
1 /*
2  * Copyright (C) 2001-2003 FhG Fokus
3  *
4  * This file is part of Kamailio, a free SIP server.
5  *
6  * Kamailio is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version
10  *
11  * Kamailio is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
19  */
20
21 /**
22  * @file
23  * @brief Kamailio core :: modules loading, structures declarations and utilities
24  * @ingroup core
25  * Module: \ref core
26  */
27
28
29 #include "sr_module.h"
30 #include "mod_fix.h"
31 #include "dprint.h"
32 #include "error.h"
33 #include "mem/mem.h"
34 #include "core_cmd.h"
35 #include "ut.h"
36 #include "re.h"
37 #include "route_struct.h"
38 #include "flags.h"
39 #include "trim.h"
40 #include "pvapi.h"
41 #include "globals.h"
42 #include "rpc_lookup.h"
43 #include "sr_compat.h"
44 #include "ppcfg.h"
45 #include "async_task.h"
46
47 #include <sys/stat.h>
48 #include <regex.h>
49 #include <dlfcn.h>
50 #include <strings.h>
51 #include <stdlib.h>
52 #include <string.h>
53 #include <stddef.h> /* for offsetof */
54
55
56 struct sr_module* modules=0;
57
58 /*We need to define this symbol on Solaris becuase libcurl relies on libnspr which looks for this symbol.
59   If it is not defined, dynamic module loading (dlsym) fails */
60 #ifdef __OS_solaris
61         int nspr_use_zone_allocator = 0;
62 #endif
63
64
65 #ifdef STATIC_EXEC
66         extern struct module_exports exec_exports;
67 #endif
68 #ifdef STATIC_TM
69         extern struct module_exports tm_exports;
70 #endif
71
72 #ifdef STATIC_MAXFWD
73         extern struct module_exports maxfwd_exports;
74 #endif
75
76 #ifdef STATIC_AUTH
77         extern struct module_exports auth_exports;
78 #endif
79
80 #ifdef STATIC_RR
81         extern struct module_exports rr_exports;
82 #endif
83
84 #ifdef STATIC_USRLOC
85         extern struct module_exports usrloc_exports;
86 #endif
87
88 #ifdef STATIC_SL
89         extern struct module_exports sl_exports;
90 #endif
91
92 #ifndef offsetof
93 #warning "use null pointer dereference for offsetof"
94 #define offsetof(st, m) \
95                 ((size_t) ( (char *)&((st *)(0))->m - (char *)0 ))
96 #endif
97
98 int mod_response_cbk_no=0;
99 response_function* mod_response_cbks=0;
100
101 /* number of usec to wait before initializing a module */
102 static unsigned int modinit_delay = 0;
103
104 unsigned int set_modinit_delay(unsigned int v)
105 {
106         unsigned int r;
107         r =  modinit_delay;
108         modinit_delay = v;
109         return r;
110 }
111
112 /* keep state if server is in destroy modules phase */
113 static int _sr_destroy_modules_phase = 0;
114
115 /**
116  * return destroy modules phase state
117  */
118 int destroy_modules_phase(void)
119 {
120         return _sr_destroy_modules_phase;
121 }
122
123 /**
124  * if bit 1 set, SIP worker processes handle RPC commands as well
125  * if bit 2 set, RPC worker processes handle SIP commands as well
126  */
127 static int child_sip_rpc_mode = 0;
128
129 #define CHILD_SIP_RPC   1<<0
130 #define CHILD_RPC_SIP   1<<1
131
132 void set_child_sip_rpc_mode(void)
133 {
134         child_sip_rpc_mode |= CHILD_SIP_RPC;
135 }
136
137 void set_child_rpc_sip_mode(void)
138 {
139         child_sip_rpc_mode |= CHILD_RPC_SIP;
140 }
141
142 int is_rpc_worker(int rank)
143 {
144         if(rank==PROC_RPC
145                         || (rank>PROC_MAIN && (child_sip_rpc_mode&CHILD_SIP_RPC)!=0))
146                 return 1;
147         return 0;
148 }
149
150 int is_sip_worker(int rank)
151 {
152         if(rank>PROC_MAIN
153                         || ((rank==PROC_RPC || rank==PROC_NOCHLDINIT)
154                                         && (child_sip_rpc_mode&CHILD_RPC_SIP)!=0))
155                 return 1;
156         return 0;
157 }
158
159 /* initializes statically built (compiled in) modules*/
160 int register_builtin_modules()
161 {
162         int ret;
163
164         ret=0;
165 #ifdef STATIC_TM
166         ret=register_module(MODULE_INTERFACE_VER, &tm_exports,"built-in", 0);
167         if (ret<0) return ret;
168 #endif
169
170 #ifdef STATIC_EXEC
171         ret=register_module(MODULE_INTERFACE_VER, &exec_exports,"built-in", 0);
172         if (ret<0) return ret;
173 #endif
174
175 #ifdef STATIC_MAXFWD
176         ret=register_module(MODULE_INTERFACE_VER, &maxfwd_exports, "built-in", 0);
177         if (ret<0) return ret;
178 #endif
179
180 #ifdef STATIC_AUTH
181         ret=register_module(MODULE_INTERFACE_VER, &auth_exports, "built-in", 0);
182         if (ret<0) return ret;
183 #endif
184
185 #ifdef STATIC_RR
186         ret=register_module(MODULE_INTERFACE_VER, &rr_exports, "built-in", 0);
187         if (ret<0) return ret;
188 #endif
189
190 #ifdef STATIC_USRLOC
191         ret=register_module(MODULE_INTERFACE_VER, &usrloc_exports, "built-in", 0);
192         if (ret<0) return ret;
193 #endif
194
195 #ifdef STATIC_SL
196         ret=register_module(MODULE_INTERFACE_VER, &sl_exports, "built-in", 0);
197         if (ret<0) return ret;
198 #endif
199
200         return ret;
201 }
202
203
204
205 /** convert cmd exports to current format.
206  * @param ver - module interface versions (0 == ser, 1 == kam).
207  * @param src - null terminated array of cmd exports
208  *              (either ser_cmd_export_t or kam_cmd_export_t, depending
209  *               on ver).
210  * @param mod - pointer to module exports structure.
211  * @return - pkg_malloc'ed null terminated sr_cmd_export_v31_t array with
212  *           the converted cmd exports  or 0 on error.
213  */
214 static sr31_cmd_export_t* sr_cmd_exports_convert(unsigned ver,
215                                                                                                         void* src, void* mod)
216 {
217         int i, n;
218         ser_cmd_export_t* ser_cmd;
219         kam_cmd_export_t* kam_cmd;
220         sr31_cmd_export_t* ret;
221
222         ser_cmd = 0;
223         kam_cmd = 0;
224         ret = 0;
225         n = 0;
226         /* count the number of elements */
227         if (ver == 0) {
228                 ser_cmd = src;
229                 for (; ser_cmd[n].name; n++);
230         } else if (ver == 1) {
231                 kam_cmd = src;
232                 for (; kam_cmd[n].name; n++);
233         } else goto error; /* unknown interface version */
234         /* alloc & init new array */
235         ret = pkg_malloc(sizeof(*ret)*(n+1));
236         memset(ret, 0, sizeof(*ret)*(n+1));
237         /* convert/copy */
238         for (i=0; i < n; i++) {
239                 if (ver == 0) {
240                         ret[i].name = ser_cmd[i].name;
241                         ret[i].function = ser_cmd[i].function;
242                         ret[i].param_no = ser_cmd[i].param_no;
243                         ret[i].fixup = ser_cmd[i].fixup;
244                         ret[i].free_fixup = 0; /* no present in ser  <= 2.1 */
245                         ret[i].flags = ser_cmd[i].flags;
246                 } else {
247                         ret[i].name = kam_cmd[i].name;
248                         ret[i].function = kam_cmd[i].function;
249                         ret[i].param_no = kam_cmd[i].param_no;
250                         ret[i].fixup = kam_cmd[i].fixup;
251                         ret[i].free_fixup = kam_cmd[i].free_fixup;
252                         ret[i].flags = kam_cmd[i].flags;
253                 }
254                 /* 3.1+ specific stuff */
255                 ret[i].fixup_flags = 0;
256                 ret[i].module_exports = mod;
257                 /* fill known free fixups */
258                 if (ret[i].fixup && ret[i].free_fixup == 0)
259                         ret[i].free_fixup = get_fixup_free(ret[i].fixup);
260         }
261         return ret;
262 error:
263         return 0;
264 }
265
266
267
268 /* registers a module,  register_f= module register  functions
269  * returns <0 on error, 0 on success */
270 static int register_module(unsigned ver, union module_exports_u* e,
271                                         char* path, void* handle)
272 {
273         int ret, i;
274         struct sr_module* mod;
275         char defmod[64];
276
277         ret=-1;
278
279         /* add module to the list */
280         if ((mod=pkg_malloc(sizeof(struct sr_module)))==0){
281                 LM_ERR("memory allocation failure\n");
282                 ret=E_OUT_OF_MEM;
283                 goto error;
284         }
285         memset(mod,0, sizeof(struct sr_module));
286         mod->path=path;
287         mod->handle=handle;
288         mod->orig_mod_interface_ver=ver;
289         /* convert exports to sr31 format */
290         if (ver == 0) {
291                 /* ser <= 3.0 */
292                 mod->exports.name = e->v0.name;
293                 if (e->v0.cmds) {
294                         mod->exports.cmds = sr_cmd_exports_convert(ver, e->v0.cmds, mod);
295                         if (mod->exports.cmds == 0) {
296                                 LM_ERR("failed to convert module command exports to 3.1 format"
297                                                 " for module \"%s\" (%s), interface version %d\n",
298                                                 mod->exports.name, mod->path, ver);
299                                 ret = E_UNSPEC;
300                                 goto error;
301                         }
302                 }
303                 mod->exports.params = e->v0.params;
304                 mod->exports.init_f = e->v0.init_f;
305                 mod->exports.response_f = e->v0.response_f;
306                 mod->exports.destroy_f = e->v0.destroy_f;
307                 mod->exports.onbreak_f = e->v0.onbreak_f;
308                 mod->exports.init_child_f = e->v0.init_child_f;
309                 mod->exports.dlflags = 0; /* not used in ser <= 3.0 */
310                 mod->exports.rpc_methods = e->v0.rpc_methods;
311                 /* the rest are 0, not used in ser */
312         } else if (ver == 1) {
313                 /* kamailio <= 3.0 */
314                 mod->exports.name = e->v1.name;
315                 if (e->v1.cmds) {
316                         mod->exports.cmds = sr_cmd_exports_convert(ver, e->v1.cmds, mod);
317                         if (mod->exports.cmds == 0) {
318                                 LM_ERR("failed to convert module command exports to 3.1 format"
319                                                 " for module \"%s\" (%s), interface version %d\n",
320                                                 mod->exports.name, mod->path, ver);
321                                 ret = E_UNSPEC;
322                                 goto error;
323                         }
324                 }
325                 mod->exports.params = e->v1.params;
326                 mod->exports.init_f = e->v1.init_f;
327                 mod->exports.response_f = e->v1.response_f;
328                 mod->exports.destroy_f = e->v1.destroy_f;
329                 mod->exports.onbreak_f = 0; /* not used in k <= 3.0 */
330                 mod->exports.init_child_f = e->v1.init_child_f;
331                 mod->exports.dlflags = e->v1.dlflags;
332                 mod->exports.rpc_methods = 0; /* not used in k <= 3.0 */
333                 mod->exports.stats = e->v1.stats;
334                 mod->exports.nn_cmds = e->v1.nn_cmds;
335                 mod->exports.items = e->v1.items;
336                 mod->exports.procs = e->v1.procs;
337         } else {
338                 LM_ERR("unsupported module interface version %d\n", ver);
339                 ret = E_UNSPEC;
340                 goto error;
341         }
342
343         if (mod->exports.items) {
344                 /* register module pseudo-variables for kamailio modules */
345                 LM_DBG("register PV from: %s\n", mod->exports.name);
346                 if (register_pvars_mod(mod->exports.name, mod->exports.items)!=0) {
347                         LM_ERR("failed to register pseudo-variables for module %s (%s)\n",
348                                 mod->exports.name, path);
349                         ret = E_UNSPEC;
350                         goto error;
351                 }
352         }
353         if (mod->exports.rpc_methods){
354                 /* register rpcs for ser modules */
355                 i=rpc_register_array(mod->exports.rpc_methods);
356                 if (i<0){
357                         LM_ERR("failed to register RPCs for module %s (%s)\n",
358                                         mod->exports.name, path);
359                         ret = E_UNSPEC;
360                         goto error;
361                 }else if (i>0){
362                         LM_ERR("%d duplicate RPCs name detected while registering RPCs"
363                                         " declared in module %s (%s)\n",
364                                         i, mod->exports.name, path);
365                         ret = E_UNSPEC;
366                         goto error;
367                 }
368                 /* i==0 => success */
369         }
370
371         /* add cfg define for each module: MOD_modulename */
372         if(strlen(mod->exports.name)>=60) {
373                 LM_ERR("too long module name: %s\n", mod->exports.name);
374                 goto error;
375         }
376         strcpy(defmod, "MOD_");
377         strcat(defmod, mod->exports.name);
378         pp_define_set_type(0);
379         if(pp_define(strlen(defmod), defmod)<0) {
380                 LM_ERR("unable to set cfg define for module: %s\n",
381                                 mod->exports.name);
382                 goto error;
383         }
384
385         /* link module in the list */
386         mod->next=modules;
387         modules=mod;
388         return 0;
389 error:
390         if (mod)
391                 pkg_free(mod);
392         return ret;
393 }
394
395 static inline int version_control(void *handle, char *path)
396 {
397         char **m_ver;
398         char **m_flags;
399         char* error;
400
401         m_ver=(char **)dlsym(handle, "module_version");
402         if ((error=(char *)dlerror())!=0) {
403                 LM_ERR("no version info in module <%s>: %s\n", path, error);
404                 return 0;
405         }
406         m_flags=(char **)dlsym(handle, "module_flags");
407         if ((error=(char *)dlerror())!=0) {
408                 LM_ERR("no compile flags info in module <%s>: %s\n", path, error);
409                 return 0;
410         }
411         if (!m_ver || !(*m_ver)) {
412                 LM_ERR("no version in module <%s>\n", path );
413                 return 0;
414         }
415         if (!m_flags || !(*m_flags)) {
416                 LM_ERR("no compile flags in module <%s>\n", path );
417                 return 0;
418         }
419
420         if (strcmp(SER_FULL_VERSION, *m_ver)==0){
421                 if (strcmp(SER_COMPILE_FLAGS, *m_flags)==0)
422                         return 1;
423                 else {
424                         LM_ERR("module compile flags mismatch for %s "
425                                                 " \ncore: %s \nmodule: %s\n",
426                                                 path, SER_COMPILE_FLAGS, *m_flags);
427                         return 0;
428                 }
429         }
430         LM_ERR("module version mismatch for %s; "
431                 "core: %s; module: %s\n", path, SER_FULL_VERSION, *m_ver );
432         return 0;
433 }
434
435 /**
436  * \brief load a sr module
437  *
438  * tries to load the module specified by mod_path.
439  * If mod_path is 'modname' or 'modname.so' then
440  *  \<MODS_DIR\>/\<modname\>.so will be tried and if this fails
441  *  \<MODS_DIR\>/\<modname\>/\<modname\>.so
442  * If mod_path contain a '/' it is assumed to be the
443  * path to the module and tried first. If fails and mod_path is not
444  * absolute path (not starting with '/') then will try:
445  * \<MODS_DIR\>/mod_path
446  * @param mod_path path or module name
447  * @return 0 on success , <0 on error
448  */
449 int load_module(char* mod_path)
450 {
451         void* handle;
452         char* error;
453         mod_register_function mr;
454         union module_exports_u* exp;
455         unsigned* mod_if_ver;
456         struct sr_module* t;
457         struct stat stat_buf;
458         str modname;
459         char* mdir;
460         char* nxt_mdir;
461         char* path;
462         int mdir_len;
463         int len;
464         int dlflags;
465         int new_dlflags;
466         int retries;
467         int path_type;
468         str expref;
469         char exbuf[64];
470
471 #ifndef RTLD_NOW
472 /* for openbsd */
473 #define RTLD_NOW DL_LAZY
474 #endif
475         path=mod_path;
476         path_type = 0;
477         modname.s = path;
478         modname.len = strlen(mod_path);
479         if(modname.len>3 && strcmp(modname.s+modname.len-3, ".so")==0) {
480                 path_type = 1;
481                 modname.len -= 3;
482         }
483         if (!strchr(path, '/'))
484                 path_type |= 2;
485         if((path_type&2) || path[0] != '/') {
486                 /* module name was given, we try to construct the path */
487                 mdir=mods_dir; /* search path */
488                 do{
489                         nxt_mdir=strchr(mdir, ':');
490                         if (nxt_mdir) mdir_len=(int)(nxt_mdir-mdir);
491                         else mdir_len=strlen(mdir);
492
493                         if(path_type&2) {
494                                 /* try path <MODS_DIR>/<modname>.so */
495                                 path = (char*)pkg_malloc(mdir_len + 1 /* "/" */ +
496                                                                         modname.len + 3 /* ".so" */ + 1);
497                                 if (path==0) goto error;
498                                 memcpy(path, mdir, mdir_len);
499                                 len = mdir_len;
500                                 if (len != 0 && path[len - 1] != '/'){
501                                         path[len]='/';
502                                         len++;
503                                 }
504                                 path[len]=0;
505                                 strcat(path, modname.s);
506                                 if(!(path_type&1))
507                                         strcat(path, ".so");
508
509                                 if (stat(path, &stat_buf) == -1) {
510                                         LM_DBG("module file not found <%s>\n", path);
511                                         pkg_free(path);
512
513                                         /* try path <MODS_DIR>/<modname>/<modname>.so */
514                                         path = (char*)pkg_malloc(
515                                                 mdir_len + 1 /* "/" */ +
516                                                 modname.len + 1 /* "/" */ +
517                                                 modname.len + 3 /* ".so" */ + 1);
518                                         if (path==0) goto error;
519                                         memcpy(path, mdir, mdir_len);
520                                         len = mdir_len;
521                                         if (len != 0 && path[len - 1] != '/') {
522                                                 path[len]='/';
523                                                 len++;
524                                         }
525                                         path[len]=0;
526                                         strncat(path, modname.s, modname.len);
527                                         strcat(path, "/");
528                                         strcat(path, modname.s);
529                                         if(!(path_type&1))
530                                                 strcat(path, ".so");
531
532                                         if (stat(path, &stat_buf) == -1) {
533                                                 LM_DBG("module file not found <%s>\n", path);
534                                                 pkg_free(path);
535                                                 path=0;
536                                         }
537                                 }
538                         } else {
539                                 /* try mod_path - S compat */
540                                 if(path==mod_path) {
541                                         if (stat(path, &stat_buf) == -1) {
542                                                 LM_DBG("module file not found <%s>\n", path);
543                                                 path=0;
544                                         }
545                                 }
546                                 if(path==0) {
547                                         /* try path <MODS_DIR>/mod_path - K compat */
548                                         path = (char*)pkg_malloc(mdir_len + 1 /* "/" */ +
549                                                                         strlen(mod_path) + 1);
550                                         if (path==0) goto error;
551                                         memcpy(path, mdir, mdir_len);
552                                         len = mdir_len;
553                                         if (len != 0 && path[len - 1] != '/'){
554                                                 path[len]='/';
555                                                 len++;
556                                         }
557                                         path[len]=0;
558                                         strcat(path, mod_path);
559
560                                         if (stat(path, &stat_buf) == -1) {
561                                                 LM_DBG("module file not found <%s>\n", path);
562                                                 pkg_free(path);
563                                                 path=0;
564                                         }
565                                 }
566                         }
567                         mdir=nxt_mdir?nxt_mdir+1:0;
568                 }while(path==0 && mdir);
569                 if (path==0){
570                         LM_ERR("could not find module <%.*s> in <%s>\n",
571                                                 modname.len, modname.s, mods_dir);
572                         goto error;
573                 }
574         }
575         LM_DBG("trying to load <%s>\n", path);
576
577         retries=2;
578         dlflags=RTLD_NOW;
579 reload:
580         handle=dlopen(path, dlflags); /* resolve all symbols now */
581         if (handle==0){
582                 LM_ERR("could not open module <%s>: %s\n", path, dlerror());
583                 goto error;
584         }
585
586         for(t=modules;t; t=t->next){
587                 if (t->handle==handle){
588                         LM_WARN("attempting to load the same module twice (%s)\n", path);
589                         goto skip;
590                 }
591         }
592         /* version control */
593         if (!version_control(handle, path)) {
594                 exit(-1);
595         }
596         mod_if_ver = (unsigned *)dlsym(handle, "module_interface_ver");
597         if ( (error =(char*)dlerror())!=0 ){
598                 LM_ERR("no module interface version in module <%s>\n", path );
599                 goto error1;
600         }
601         /* launch register */
602         mr = (mod_register_function)dlsym(handle, "mod_register");
603         if (((error =(char*)dlerror())==0) && mr) {
604                 /* no error call it */
605                 new_dlflags=dlflags;
606                 if (mr(path, &new_dlflags, 0, 0)!=0) {
607                         LM_ERR("%s: mod_register failed\n", path);
608                         goto error1;
609                 }
610                 if (new_dlflags!=dlflags && new_dlflags!=0) {
611                         /* we have to reload the module */
612                         dlclose(handle);
613                         dlflags=new_dlflags;
614                         retries--;
615                         if (retries>0) goto reload;
616                         LM_ERR("%s: cannot agree on the dlflags\n", path);
617                         goto error;
618                 }
619         }
620         exp = (union module_exports_u*)dlsym(handle, "exports");
621         if(exp==NULL) {
622                 /* 'exports' structure not found, look up for '_modulename_exports' */
623                 mdir = strrchr(mod_path, '/');
624                 if (!mdir) {
625                         expref.s = mod_path;
626                 } else {
627                         expref.s = mdir+1;
628                 }
629                 expref.len = strlen(expref.s);
630                 if(expref.len>3 && strcmp(expref.s+expref.len-3, ".so")==0)
631                         expref.len -= 3;
632                 snprintf(exbuf, 62, "_%.*s_exports", expref.len, expref.s);
633                 exp = (union module_exports_u*)dlsym(handle, exbuf);
634                 LM_DBG("looking up exports with name: %s\n", exbuf);
635                 if ( (error =(char*)dlerror())!=0 ){
636                         LM_ERR("%s\n", error);
637                         goto error1;
638                 }
639         }
640         /* hack to allow for kamailio style dlflags inside exports */
641         if (*mod_if_ver == 1) {
642                 new_dlflags = exp->v1.dlflags;
643                 if (new_dlflags!=dlflags && new_dlflags!=DEFAULT_DLFLAGS) {
644                         /* we have to reload the module */
645                         dlclose(handle);
646                         DEBUG("%s: exports dlflags interface is deprecated and it will not"
647                                         " be supported in newer versions; consider using"
648                                         " mod_register() instead\n", path);
649                         dlflags=new_dlflags;
650                         retries--;
651                         if (retries>0) goto reload;
652                         LM_ERR("%s: cannot agree on the dlflags\n", path);
653                         goto error;
654                 }
655         }
656         if (register_module(*mod_if_ver, exp, path, handle)<0) goto error1;
657         return 0;
658
659 error1:
660         dlclose(handle);
661 error:
662 skip:
663         if (path && path!=mod_path)
664                 pkg_free(path);
665         return -1;
666 }
667
668
669
670 /* searches the module list for function name in module mod and returns
671  *  a pointer to the "name" function record union or 0 if not found
672  * sets also *mod_if_ver to the original module interface version.
673  * mod==0 is a wildcard matching all modules
674  * flags parameter is OR value of all flags that must match
675  */
676 sr31_cmd_export_t* find_mod_export_record(char* mod, char* name,
677                                                                                         int param_no, int flags,
678                                                                                         unsigned* mod_if_ver)
679 {
680         struct sr_module* t;
681         sr31_cmd_export_t* cmd;
682
683         for(t=modules;t;t=t->next){
684                 if (mod!=0 && (strcmp(t->exports.name, mod) !=0))
685                         continue;
686                 if (t->exports.cmds)
687                         for(cmd=&t->exports.cmds[0]; cmd->name; cmd++) {
688                                 if((strcmp(name, cmd->name) == 0) &&
689                                         ((cmd->param_no == param_no) ||
690                                         (cmd->param_no==VAR_PARAM_NO)) &&
691                                         ((cmd->flags & flags) == flags)
692                                 ){
693                                         LM_DBG("find_export_record: found <%s> in module %s [%s]\n",
694                                                 name, t->exports.name, t->path);
695                                         *mod_if_ver=t->orig_mod_interface_ver;
696                                         return cmd;
697                                 }
698                         }
699         }
700         LM_DBG("find_export_record: <%s> not found \n", name);
701         return 0;
702 }
703
704
705
706 /* searches the module list for function name and returns
707  *  a pointer to the "name" function record union or 0 if not found
708  * sets also *mod_if_ver to the module interface version (needed to know
709  * which member of the union should be accessed v0 or v1)
710  * mod==0 is a wildcard matching all modules
711  * flags parameter is OR value of all flags that must match
712  */
713 sr31_cmd_export_t* find_export_record(char* name,
714                                                                                         int param_no, int flags,
715                                                                                         unsigned* mod_if_ver)
716 {
717         return find_mod_export_record(0, name, param_no, flags, mod_if_ver);
718 }
719
720
721
722 cmd_function find_export(char* name, int param_no, int flags)
723 {
724         sr31_cmd_export_t* cmd;
725         unsigned mver;
726
727         cmd = find_export_record(name, param_no, flags, &mver);
728         return cmd?cmd->function:0;
729 }
730
731
732 rpc_export_t* find_rpc_export(char* name, int flags)
733 {
734         return rpc_lookup((char*)name, strlen(name));
735 }
736
737
738 /*
739  * searches the module list and returns pointer to "name" function in module
740  * "mod"
741  * 0 if not found
742  * flags parameter is OR value of all flags that must match
743  */
744 cmd_function find_mod_export(char* mod, char* name, int param_no, int flags)
745 {
746         sr31_cmd_export_t* cmd;
747         unsigned mver;
748
749         cmd=find_mod_export_record(mod, name, param_no, flags, &mver);
750         if (cmd)
751                 return cmd->function;
752
753         LM_DBG("<%s> in module <%s> not found\n", name, mod);
754         return 0;
755 }
756
757
758 struct sr_module* find_module_by_name(char* mod) {
759         struct sr_module* t;
760
761         for(t = modules; t; t = t->next) {
762                 if (strcmp(mod, t->exports.name) == 0) {
763                         return t;
764                 }
765         }
766         LM_DBG("module <%s> not found\n", mod);
767         return 0;
768 }
769
770
771 /*!
772  * \brief Find a parameter with given type
773  * \param mod module
774  * \param name parameter name
775  * \param type_mask parameter mask
776  * \param param_type parameter type
777  * \return parameter address in memory, if there is no such parameter, NULL is returned
778  */
779 void* find_param_export(struct sr_module* mod, char* name,
780                                                 modparam_t type_mask, modparam_t *param_type)
781 {
782         param_export_t* param;
783
784         if (!mod)
785                 return 0;
786         for(param = mod->exports.params ;param && param->name ; param++) {
787                 if ((strcmp(name, param->name) == 0) &&
788                         ((param->type & PARAM_TYPE_MASK(type_mask)) != 0)) {
789                         LM_DBG("found <%s> in module %s [%s]\n",
790                                 name, mod->exports.name, mod->path);
791                         *param_type = param->type;
792                         return param->param_pointer;
793                 }
794         }
795         LM_DBG("parameter <%s> not found in module <%s>\n",
796                         name, mod->exports.name);
797         return 0;
798 }
799
800
801 void destroy_modules()
802 {
803         struct sr_module* t, *foo;
804
805         _sr_destroy_modules_phase = 1;
806         /* call first destroy function from each module */
807         t=modules;
808         while(t) {
809                 foo=t->next;
810                 if (t->exports.destroy_f){
811                         t->exports.destroy_f();
812                 }
813                 t=foo;
814         }
815         /* free module exports structures */
816         t=modules;
817         while(t) {
818                 foo=t->next;
819                 pkg_free(t);
820                 t=foo;
821         }
822         modules=0;
823         if (mod_response_cbks){
824                 pkg_free(mod_response_cbks);
825                 mod_response_cbks=0;
826         }
827 }
828
829 #ifdef NO_REVERSE_INIT
830
831 /*
832  * Initialize all loaded modules, the initialization
833  * is done *AFTER* the configuration file is parsed
834  */
835 int init_modules(void)
836 {
837         struct sr_module* t;
838
839         if(async_task_init()<0)
840                 return -1;
841
842         for(t = modules; t; t = t->next) {
843                 if (t->exports.init_f) {
844                         if (t->exports.init_f() != 0) {
845                                 LM_ERR("Error while initializing module %s\n", t->exports.name);
846                                 return -1;
847                         }
848                         /* delay next module init, if configured */
849                         if(unlikely(modinit_delay>0))
850                                 sleep_us(modinit_delay);
851                 }
852                 if (t->exports.response_f)
853                         mod_response_cbk_no++;
854         }
855         mod_response_cbks=pkg_malloc(mod_response_cbk_no *
856                                                                         sizeof(response_function));
857         if (mod_response_cbks==0){
858                 LM_ERR("memory allocation failure for %d response_f callbacks\n",
859                                         mod_response_cbk_no);
860                 return -1;
861         }
862         for (t=modules, i=0; t && (i<mod_response_cbk_no); t=t->next) {
863                 if (t->exports.response_f) {
864                         mod_response_cbks[i]=t->exports.response_f;
865                         i++;
866                 }
867         }
868         return 0;
869 }
870
871
872
873 /*
874  * per-child initialization
875  */
876 int init_child(int rank)
877 {
878         struct sr_module* t;
879         char* type;
880
881         switch(rank) {
882         case PROC_MAIN:     type = "PROC_MAIN";     break;
883         case PROC_TIMER:    type = "PROC_TIMER";    break;
884         case PROC_FIFO:     type = "PROC_FIFO";     break;
885         case PROC_TCP_MAIN: type = "PROC_TCP_MAIN"; break;
886         default:            type = "CHILD";         break;
887         }
888         LM_DBG("initializing %s with rank %d\n", type, rank);
889
890         if(async_task_child_init(rank)<0)
891                 return -1;
892
893         for(t = modules; t; t = t->next) {
894                 if (t->exports.init_child_f) {
895                         if ((t->exports.init_child_f(rank)) < 0) {
896                                 LM_ERR("Initialization of child %d failed\n", rank);
897                                 return -1;
898                         }
899                 }
900         }
901         return 0;
902 }
903
904 #else
905
906
907 /* recursive module child initialization; (recursion is used to
908  * process the module linear list in the same order in
909  * which modules are loaded in config file
910  */
911
912 static int init_mod_child( struct sr_module* m, int rank )
913 {
914         if (m) {
915                 /* iterate through the list; if error occurs,
916                  * propagate it up the stack
917                  */
918                 if (init_mod_child(m->next, rank)!=0) return -1;
919                 if (m->exports.init_child_f) {
920                         LM_DBG("rank %d: %s\n", rank, m->exports.name);
921                         if (m->exports.init_child_f(rank)<0) {
922                                 LM_ERR("Error while initializing module %s (%s)\n",
923                                                         m->exports.name, m->path);
924                                 return -1;
925                         } else {
926                                 /* module correctly initialized */
927                                 return 0;
928                         }
929                 }
930                 /* no init function -- proceed with success */
931                 return 0;
932         } else {
933                 /* end of list */
934                 return 0;
935         }
936 }
937
938
939 /*
940  * per-child initialization
941  */
942 int init_child(int rank)
943 {
944         if(async_task_child_init(rank)<0)
945                 return -1;
946
947         return init_mod_child(modules, rank);
948 }
949
950
951
952 /* recursive module initialization; (recursion is used to
953  * process the module linear list in the same order in
954  * which modules are loaded in config file
955 */
956
957 static int init_mod( struct sr_module* m )
958 {
959         if (m) {
960                 /* iterate through the list; if error occurs,
961                  * propagate it up the stack
962                  */
963                 if (init_mod(m->next)!=0) return -1;
964                         if (m->exports.init_f) {
965                                 LM_DBG("%s\n", m->exports.name);
966                                 if (m->exports.init_f()!=0) {
967                                         LM_ERR("Error while initializing module %s (%s)\n",
968                                                                 m->exports.name, m->path);
969                                         return -1;
970                                 } else {
971                                         /* module correctly initialized */
972                                         return 0;
973                                 }
974                         }
975                         /* no init function -- proceed with success */
976                         return 0;
977         } else {
978                 /* end of list */
979                 return 0;
980         }
981 }
982
983 /*
984  * Initialize all loaded modules, the initialization
985  * is done *AFTER* the configuration file is parsed
986  */
987 int init_modules(void)
988 {
989         struct sr_module* t;
990         int i;
991
992         if(async_task_init()<0)
993                 return -1;
994
995         i = init_mod(modules);
996         if(i!=0)
997                 return i;
998
999         for(t = modules; t; t = t->next)
1000                 if (t->exports.response_f)
1001                         mod_response_cbk_no++;
1002         mod_response_cbks=pkg_malloc(mod_response_cbk_no *
1003                                                                         sizeof(response_function));
1004         if (mod_response_cbks==0){
1005                 LM_ERR("memory allocation failure for %d response_f callbacks\n", mod_response_cbk_no);
1006                 return -1;
1007         }
1008         for (t=modules, i=0; t && (i<mod_response_cbk_no); t=t->next)
1009                 if (t->exports.response_f) {
1010                         mod_response_cbks[i]=t->exports.response_f;
1011                         i++;
1012                 }
1013
1014         return 0;
1015 }
1016
1017 #endif
1018
1019
1020 action_u_t *fixup_get_param(void **cur_param, int cur_param_no,
1021                                                         int required_param_no)
1022 {
1023         action_u_t *a;
1024         /* cur_param points to a->u.string, get pointer to a */
1025         a = (void*) ((char *)cur_param - offsetof(action_u_t, u.string));
1026         return a + required_param_no - cur_param_no;
1027 }
1028
1029 int fixup_get_param_count(void **cur_param, int cur_param_no)
1030 {
1031         action_u_t *a;
1032         a = fixup_get_param(cur_param, cur_param_no, 0);
1033         if (a)
1034                 return a->u.number;
1035         else
1036                 return -1;
1037 }
1038
1039
1040
1041 /** get a pointer to a parameter internal type.
1042  * @param param
1043  * @return pointer to the parameter internal type.
1044  */
1045 action_param_type* fixup_get_param_ptype(void** param)
1046 {
1047         action_u_t* a;
1048         a = (void*)((char*)param - offsetof(action_u_t, u.string));
1049         return &a->type;
1050 }
1051
1052
1053 /** get a parameter internal type.
1054  * @see fixup_get_param_ptype().
1055  * @return paramter internal type.
1056  */
1057 action_param_type fixup_get_param_type(void** param)
1058 {
1059         return *fixup_get_param_ptype(param);
1060 }
1061
1062
1063
1064 /* fixes flag params (resolves possible named flags)
1065  * use PARAM_USE_FUNC|PARAM_STRING as a param. type and create
1066  * a wrapper function that does just:
1067  * return fix_flag(type, val, "my_module", "my_param", &flag_var)
1068  * see also param_func_t.
1069  */
1070 int fix_flag( modparam_t type, void* val,
1071                                         char* mod_name, char* param_name, int* flag)
1072 {
1073         int num;
1074         int err;
1075         int f, len;
1076         char* s;
1077         char *p;
1078
1079         if ((type & PARAM_STRING)==0){
1080                 LM_CRIT("%s: fix_flag(%s): bad parameter type\n",
1081                                         mod_name, param_name);
1082                 return -1;
1083         }
1084         s=(char*)val;
1085         len=strlen(s);
1086         f=-1;
1087         /* try to see if it's a number */
1088         num = str2s(s, len, &err);
1089         if (err != 0) {
1090                 /* see if it's in the name:<no> format */
1091                 p=strchr(s, ':');
1092                 if (p){
1093                         f= str2s(p+1, strlen(p+1), &err);
1094                         if (err!=0){
1095                                 LM_ERR("%s: invalid %s format: \"%s\"",
1096                                                 mod_name, param_name, s);
1097                                 return -1;
1098                         }
1099                         *p=0;
1100                 }
1101                 if ((num=get_flag_no(s, len))<0){
1102                         /* not declared yet, declare it */
1103                         num=register_flag(s, f);
1104                 }
1105                 if (num<0){
1106                         LM_ERR("%s: bad %s %s\n", mod_name, param_name, s);
1107                         return -1;
1108                 } else if ((f>0) && (num!=f)){
1109                         LM_ERR("%s: flag %s already defined"
1110                                         " as %d (and not %d), using %s:%d\n",
1111                                         mod_name, s, num, f, s, num);
1112                 }
1113         }
1114         *flag=num;
1115         return 0;
1116 }
1117
1118 /*
1119  * Common function parameter fixups
1120  */
1121
1122 /** Generic parameter fixup function.
1123  *  Creates a fparam_t structure.
1124  *  @param type  contains allowed parameter types
1125  *  @param param is the parameter that will be fixed-up
1126  *
1127  * @return
1128  *    0 on success,
1129  *    1 if the param doesn't match the specified type
1130  *    <0 on failure
1131  */
1132 int fix_param(int type, void** param)
1133 {
1134         fparam_t* p;
1135         str name, s;
1136         int num;
1137         int err;
1138
1139         p = (fparam_t*)pkg_malloc(sizeof(fparam_t));
1140         if (!p) {
1141                 LM_ERR("No memory left\n");
1142                 return E_OUT_OF_MEM;
1143         }
1144         memset(p, 0, sizeof(fparam_t));
1145         p->orig = *param;
1146
1147         switch(type) {
1148                 case FPARAM_UNSPEC:
1149                         LM_ERR("Invalid type value\n");
1150                         goto error;
1151                 case FPARAM_STRING:
1152                         p->v.asciiz = *param;
1153                         /* no break */
1154                 case FPARAM_STR:
1155                         p->v.str.s = (char*)*param;
1156                         p->v.str.len = strlen(p->v.str.s);
1157                         p->fixed = &p->v;
1158                         break;
1159                 case FPARAM_INT:
1160                         s.s = (char*)*param;
1161                         s.len = strlen(s.s);
1162                         err = str2sint(&s, &num);
1163                         if (err == 0) {
1164                                 p->v.i = (int)num;
1165                         } else {
1166                                 /* Not a number */
1167                                 pkg_free(p);
1168                                 return 1;
1169                         }
1170                         p->fixed = (void*)(long)num;
1171                         break;
1172                 case FPARAM_REGEX:
1173                         if ((p->v.regex = pkg_malloc(sizeof(regex_t))) == 0) {
1174                                 LM_ERR("No memory left\n");
1175                                 goto error;
1176                         }
1177                         if (regcomp(p->v.regex, *param,
1178                                                 REG_EXTENDED|REG_ICASE|REG_NEWLINE)) {
1179                                 pkg_free(p->v.regex);
1180                                 p->v.regex=0;
1181                                 /* not a valid regex */
1182                                 goto no_match;
1183                         }
1184                         p->fixed = p->v.regex;
1185                         break;
1186                 case FPARAM_AVP:
1187                         name.s = (char*)*param;
1188                         name.len = strlen(name.s);
1189                         trim(&name);
1190                         if (!name.len || name.s[0] != '$') {
1191                                 /* Not an AVP identifier */
1192                                 goto no_match;
1193                         }
1194                         name.s++;
1195                         name.len--;
1196                         if (parse_avp_ident(&name, &p->v.avp) < 0) {
1197                                 /* invalid avp identifier (=> no match) */
1198                                 goto no_match;
1199                         }
1200                         p->fixed = &p->v;
1201                         break;
1202                 case FPARAM_SELECT:
1203                         name.s = (char*)*param;
1204                         name.len = strlen(name.s);
1205                         trim(&name);
1206                         if (!name.len || name.s[0] != '@') {
1207                                 /* Not a select identifier */
1208                                 goto no_match;
1209                         }
1210                         if (parse_select(&name.s, &p->v.select) < 0) {
1211                                 LM_ERR("Error while parsing select identifier\n");
1212                                 goto error;
1213                         }
1214                         p->fixed = &p->v;
1215                         break;
1216                 case FPARAM_SUBST:
1217                         s.s = *param;
1218                         s.len = strlen(s.s);
1219                         p->v.subst = subst_parser(&s);
1220                         if (!p->v.subst) {
1221                                 LM_ERR("Error while parsing regex substitution\n");
1222                                 goto error;
1223                         }
1224                         p->fixed = &p->v;
1225                         break;
1226                 case FPARAM_PVS:
1227                         name.s = (char*)*param;
1228                         name.len = strlen(name.s);
1229                         trim(&name);
1230                         if (!name.len || name.s[0] != '$'){
1231                                 /* not a pvs identifier */
1232                                 goto no_match;
1233                         }
1234                         p->v.pvs=pkg_malloc(sizeof(pv_spec_t));
1235                         if (p->v.pvs==0){
1236                                 LM_ERR("out of memory while parsing pv_spec_t\n");
1237                                 goto error;
1238                         }
1239                         if (pv_parse_spec2(&name, p->v.pvs, 1)==0){
1240                                 /* not a valid pvs identifier (but it might be an avp) */
1241                                 pkg_free(p->v.pvs);
1242                                 p->v.pvs=0;
1243                                 goto no_match;
1244                         }
1245                         p->fixed = p->v.pvs;
1246                         break;
1247                 case FPARAM_PVE:
1248                         name.s = (char*)*param;
1249                         name.len = strlen(name.s);
1250                         if (pv_parse_format(&name, &p->v.pve)<0){
1251                                 LM_ERR("bad PVE format: \"%.*s\"\n", name.len, name.s);
1252                                 goto error;
1253                         }
1254                         p->fixed = &p->v;
1255                         break;
1256         }
1257
1258         p->type = type;
1259         *param = (void*)p;
1260         return 0;
1261
1262 no_match:
1263         pkg_free(p);
1264         return 1;
1265 error:
1266         pkg_free(p);
1267         return E_UNSPEC;
1268 }
1269
1270
1271
1272 /** fparam_t free function.
1273  *  Frees the "content" of a fparam, but not the fparam itself.
1274  *  Note: it doesn't free fp->orig!
1275  *  Assumes pkg_malloc'ed content.
1276  *  @param fp -  fparam to be freed
1277  *
1278  */
1279 void fparam_free_contents(fparam_t* fp)
1280 {
1281
1282         if (fp==0)
1283                 return;
1284         switch(fp->type) {
1285                 case FPARAM_UNSPEC:
1286                 case FPARAM_STRING: /* asciiz string, not str */
1287                 case FPARAM_INT:
1288                 case FPARAM_STR:
1289                         /* nothing to do */
1290                         break;
1291                 case FPARAM_REGEX:
1292                         if (fp->v.regex){
1293                                 regfree(fp->v.regex);
1294                                 pkg_free(fp->v.regex);
1295                                 fp->v.regex=0;
1296                         }
1297                         break;
1298                 case FPARAM_AVP:
1299                         free_avp_name(&fp->v.avp.flags, &fp->v.avp.name);
1300                         break;
1301                 case FPARAM_SELECT:
1302                         if (fp->v.select){
1303                                 free_select(fp->v.select);
1304                                 fp->v.select=0;
1305                         }
1306                         break;
1307                 case FPARAM_SUBST:
1308                         if (fp->v.subst){
1309                                 subst_expr_free(fp->v.subst);
1310                                 fp->v.subst=0;
1311                         }
1312                         break;
1313                 case FPARAM_PVS:
1314                         if (fp->v.pvs){
1315                                 pv_spec_free(fp->v.pvs);
1316                                 fp->v.pvs=0;
1317                         }
1318                         break;
1319                 case FPARAM_PVE:
1320                         if (fp->v.pve){
1321                                 pv_elem_free_all(fp->v.pve);
1322                                 fp->v.pve=0;
1323                         }
1324                         break;
1325         }
1326 }
1327
1328
1329 /**
1330  * @brief Generic free fixup type function for a fixed fparam
1331  *
1332  * Generic free fixup type function for a fixed fparam. It will free whatever
1333  * was allocated during the initial fparam fixup and restore the original param
1334  * value.
1335  * @param param freed parameters
1336  */
1337 void fparam_free_restore(void** param)
1338 {
1339         fparam_t *fp;
1340         void *orig;
1341
1342         fp = *param;
1343         orig = fp->orig;
1344         fp->orig = 0;
1345         fparam_free_contents(fp);
1346         pkg_free(fp);
1347         *param = orig;
1348 }
1349
1350
1351
1352 /** fix a param to one of the given types (mask).
1353  *
1354  * @param types - bitmap of the allowed types (e.g. FPARAM_INT|FPARAM_STR)
1355  * @param param - value/result
1356  * @return - 0 on success, -1 on error, 1 if param doesn't
1357  *           match any of the types
1358  */
1359 int fix_param_types(int types, void** param)
1360 {
1361         int ret;
1362         int t;
1363
1364         if (fixup_get_param_type(param) == STRING_RVE_ST &&
1365                         (types & (FPARAM_INT|FPARAM_STR|FPARAM_STRING))) {
1366                 /* if called with a RVE already converted to string =>
1367                  * don't try AVP, PVAR or SELECT (to avoid double
1368                  * deref., e.g.: $foo="$bar"; f($foo) ) */
1369                 types &= ~ (FPARAM_AVP|FPARAM_PVS|FPARAM_SELECT|FPARAM_PVE);
1370         }
1371         for (t=types & ~(types-1); types; types&=(types-1), t=types & ~(types-1)){
1372                 if ((ret=fix_param(t, param))<=0) return ret;
1373         }
1374         return E_UNSPEC;
1375 }
1376
1377
1378
1379 /*
1380  * Fixup variable string, the parameter can be
1381  * AVP, SELECT, or ordinary string. AVP and select
1382  * identifiers will be resolved to their values during
1383  * runtime
1384  *
1385  * The parameter value will be converted to fparam structure
1386  * This function returns -1 on an error
1387  */
1388 int fixup_var_str_12(void** param, int param_no)
1389 {
1390         int ret;
1391         if (fixup_get_param_type(param) != STRING_RVE_ST) {
1392                 /* if called with a RVE already converted to string =>
1393                  * don't try AVP, PVAR or SELECT (to avoid double
1394                  * deref., e.g.: $foo="$bar"; f($foo) ) */
1395                 if ((ret = fix_param(FPARAM_PVS, param)) <= 0) return ret;
1396                 if ((ret = fix_param(FPARAM_AVP, param)) <= 0) return ret;
1397                 if ((ret = fix_param(FPARAM_SELECT, param)) <= 0) return ret;
1398         }
1399         if ((ret = fix_param(FPARAM_STR, param)) <= 0) return ret;
1400         LM_ERR("Error while fixing parameter, PV, AVP, SELECT, and str conversions"
1401                         " failed\n");
1402         return -1;
1403 }
1404
1405 /* Same as fixup_var_str_12 but applies to the 1st parameter only */
1406 int fixup_var_str_1(void** param, int param_no)
1407 {
1408         if (param_no == 1) return fixup_var_str_12(param, param_no);
1409         else return 0;
1410 }
1411
1412 /* Same as fixup_var_str_12 but applies to the 2nd parameter only */
1413 int fixup_var_str_2(void** param, int param_no)
1414 {
1415         if (param_no == 2) return fixup_var_str_12(param, param_no);
1416         else return 0;
1417 }
1418
1419 /** fixup variable-pve-only-string.
1420  * The parameter can be a PVE (pv based format string)
1421  * or string.
1422  * non-static PVEs  identifiers will be resolved to
1423  * their values during runtime.
1424  * The parameter value will be converted to fparam structure
1425  * @param  param - double pointer to param, as for normal fixup functions.
1426  * @param  param_no - parameter number, ignored.
1427  * @return -1 on an error, 0 on success.
1428  */
1429 int fixup_var_pve_12(void** param, int param_no)
1430 {
1431         int ret;
1432         fparam_t* fp;
1433         if (fixup_get_param_type(param) != STRING_RVE_ST) {
1434                 /* if called with a RVE already converted to string =>
1435                  * don't try PVE again (to avoid double
1436                  * deref., e.g.: $foo="$bar"; f($foo) ) */
1437                 if ((ret = fix_param(FPARAM_PVE, param)) <= 0) {
1438                         if (ret < 0)
1439                                 return ret;
1440                         /* check if it resolved to a dynamic or "static" PVE.
1441                          * If the resulting PVE is static (normal string), discard
1442                          * it and use the normal string fixup (faster at runtime) */
1443                         fp = (fparam_t*)*param;
1444                         if (fp->v.pve->spec == 0 || fp->v.pve->spec->getf == 0)
1445                                 fparam_free_restore(param); /* fallback to STR below */
1446                         else
1447                                 return ret; /* dynamic PVE => return */
1448                 }
1449
1450         }
1451         if ((ret = fix_param(FPARAM_STR, param)) <= 0) return ret;
1452         LM_ERR("Error while fixing parameter - PVE or str conversions failed\n");
1453         return -1;
1454 }
1455
1456
1457
1458 /** fixup variable-pve-string.
1459  * The parameter can be a PVAR, AVP, SELECT, PVE (pv based format string)
1460  * or string.
1461  * PVAR, AVP and select and non-static PVEs  identifiers will be resolved to
1462  * their values during runtime.
1463  * The parameter value will be converted to fparam structure
1464  * @param  param - double pointer to param, as for normal fixup functions.
1465  * @param  param_no - parameter number, ignored.
1466  * @return -1 on an error, 0 on success.
1467  */
1468 int fixup_var_pve_str_12(void** param, int param_no)
1469 {
1470         int ret;
1471         fparam_t* fp;
1472         if (fixup_get_param_type(param) != STRING_RVE_ST) {
1473                 /* if called with a RVE already converted to string =>
1474                  * don't try AVP, PVAR, SELECT or PVE again (to avoid double
1475                  * deref., e.g.: $foo="$bar"; f($foo) ) */
1476                 if ((ret = fix_param(FPARAM_PVS, param)) <= 0) return ret;
1477                 if ((ret = fix_param(FPARAM_AVP, param)) <= 0) return ret;
1478                 if ((ret = fix_param(FPARAM_SELECT, param)) <= 0) return ret;
1479                 if ((ret = fix_param(FPARAM_PVE, param)) <= 0) {
1480                         if (ret < 0)
1481                                 return ret;
1482                         /* check if it resolved to a dynamic or "static" PVE.
1483                          * If the resulting PVE is static (normal string), discard
1484                          * it and use the normal string fixup (faster at runtime) */
1485                         fp = (fparam_t*)*param;
1486                         if (fp->v.pve->spec == 0 || fp->v.pve->spec->getf == 0)
1487                                 fparam_free_restore(param); /* fallback to STR below */
1488                         else
1489                                 return ret; /* dynamic PVE => return */
1490                 }
1491
1492         }
1493         if ((ret = fix_param(FPARAM_STR, param)) <= 0) return ret;
1494         LM_ERR("Error while fixing parameter, PV, AVP, SELECT, and str conversions"
1495                         " failed\n");
1496         return -1;
1497 }
1498
1499 /* Same as fixup_var_pve_str_12 but applies to the 1st parameter only */
1500 int fixup_var_pve_str_1(void** param, int param_no)
1501 {
1502         if (param_no == 1) return fixup_var_pve_str_12(param, param_no);
1503         else return 0;
1504 }
1505
1506 /* Same as fixup_var_pve_str_12 but applies to the 2nd parameter only */
1507 int fixup_var_pve_str_2(void** param, int param_no)
1508 {
1509         if (param_no == 2) return fixup_var_pve_str_12(param, param_no);
1510         else return 0;
1511 }
1512
1513
1514
1515 /*
1516  * Fixup variable integer, the parameter can be
1517  * AVP, SELECT, or ordinary integer. AVP and select
1518  * identifiers will be resolved to their values and
1519  * converted to int if necessary during runtime
1520  *
1521  * The parameter value will be converted to fparam structure
1522  * This function returns -1 on an error
1523  */
1524 int fixup_var_int_12(void** param, int param_no)
1525 {
1526         int ret;
1527         if (fixup_get_param_type(param) != STRING_RVE_ST) {
1528                 /* if called with a RVE already converted to string =>
1529                  * don't try AVP, PVAR or SELECT (to avoid double
1530                  * deref., e.g.: $foo="$bar"; f($foo) ) */
1531                 if ((ret = fix_param(FPARAM_PVS, param)) <= 0) return ret;
1532                 if ((ret = fix_param(FPARAM_AVP, param)) <= 0) return ret;
1533                 if ((ret = fix_param(FPARAM_SELECT, param)) <= 0) return ret;
1534         }
1535         if ((ret = fix_param(FPARAM_INT, param)) <= 0) return ret;
1536         LM_ERR("Error while fixing parameter, PV, AVP, SELECT, and int conversions"
1537                         " failed\n");
1538         return -1;
1539 }
1540
1541 /* Same as fixup_var_int_12 but applies to the 1st parameter only */
1542 int fixup_var_int_1(void** param, int param_no)
1543 {
1544         if (param_no == 1) return fixup_var_int_12(param, param_no);
1545         else return 0;
1546 }
1547
1548 /* Same as fixup_var_int_12 but applies to the 2nd parameter only */
1549 int fixup_var_int_2(void** param, int param_no)
1550 {
1551         if (param_no == 2) return fixup_var_int_12(param, param_no);
1552         else return 0;
1553 }
1554
1555
1556 /*
1557  * The parameter must be a regular expression which must compile, the
1558  * parameter will be converted to compiled regex
1559  */
1560 int fixup_regex_12(void** param, int param_no)
1561 {
1562         int ret;
1563
1564         if ((ret = fix_param(FPARAM_REGEX, param)) <= 0) return ret;
1565         LM_ERR("Error while compiling regex in function parameter\n");
1566         return -1;
1567 }
1568
1569 /* Same as fixup_regex_12 but applies to the 1st parameter only */
1570 int fixup_regex_1(void** param, int param_no)
1571 {
1572         if (param_no == 1) return fixup_regex_12(param, param_no);
1573         else return 0;
1574 }
1575
1576 /* Same as fixup_regex_12 but applies to the 2nd parameter only */
1577 int fixup_regex_2(void** param, int param_no)
1578 {
1579         if (param_no == 2) return fixup_regex_12(param, param_no);
1580         else return 0;
1581 }
1582
1583 /*
1584  * The string parameter will be converted to integer
1585  */
1586 int fixup_int_12(void** param, int param_no)
1587 {
1588         int ret;
1589
1590         if ((ret = fix_param(FPARAM_INT, param)) <= 0) return ret;
1591         LM_ERR("Cannot function parameter to integer\n");
1592         return -1;
1593
1594 }
1595
1596 /* Same as fixup_int_12 but applies to the 1st parameter only */
1597 int fixup_int_1(void** param, int param_no)
1598 {
1599         if (param_no == 1) return fixup_int_12(param, param_no);
1600         else return 0;
1601 }
1602
1603 /* Same as fixup_int_12 but applies to the 2nd parameter only */
1604 int fixup_int_2(void** param, int param_no)
1605 {
1606         if (param_no == 2) return fixup_int_12(param, param_no);
1607         else return 0;
1608 }
1609
1610 /*
1611  * Parse the parameter as static string, do not resolve
1612  * AVPs or selects, convert the parameter to str structure
1613  */
1614 int fixup_str_12(void** param, int param_no)
1615 {
1616         int ret;
1617
1618         if ((ret = fix_param(FPARAM_STR, param)) <= 0) return ret;
1619         LM_ERR("Cannot function parameter to string\n");
1620         return -1;
1621 }
1622
1623 /* Same as fixup_str_12 but applies to the 1st parameter only */
1624 int fixup_str_1(void** param, int param_no)
1625 {
1626         if (param_no == 1) return fixup_str_12(param, param_no);
1627         else return 0;
1628 }
1629
1630 /* Same as fixup_str_12 but applies to the 2nd parameter only */
1631 int fixup_str_2(void** param, int param_no)
1632 {
1633         if (param_no == 2) return fixup_str_12(param, param_no);
1634         else return 0;
1635 }
1636
1637
1638
1639 /** Get the function parameter value as string.
1640  *  @return  0 - Success
1641  *          -1 - Cannot get value
1642  */
1643 int get_str_fparam(str* dst, struct sip_msg* msg, fparam_t* param)
1644 {
1645         int_str val;
1646         int ret;
1647         avp_t* avp;
1648         pv_value_t pv_val;
1649
1650         switch(param->type) {
1651                 case FPARAM_REGEX:
1652                 case FPARAM_UNSPEC:
1653                 case FPARAM_INT:
1654                         return -1;
1655                 case FPARAM_STRING:
1656                         dst->s = param->v.asciiz;
1657                         dst->len = strlen(param->v.asciiz);
1658                         break;
1659                 case FPARAM_STR:
1660                         *dst = param->v.str;
1661                         break;
1662                 case FPARAM_AVP:
1663                         avp = search_first_avp(param->v.avp.flags, param->v.avp.name,
1664                                                                         &val, 0);
1665                         if (unlikely(!avp)) {
1666                                 LM_DBG("Could not find AVP from function parameter '%s'\n",
1667                                                 param->orig);
1668                                 return -1;
1669                         }
1670                         if (likely(avp->flags & AVP_VAL_STR)) {
1671                                 *dst = val.s;
1672                         } else {
1673                                 /* The caller does not know of what type the AVP will be so
1674                                  * convert int AVPs into string here
1675                                  */
1676                                 dst->s = int2str(val.n, &dst->len);
1677                         }
1678                         break;
1679                 case FPARAM_SELECT:
1680                         ret = run_select(dst, param->v.select, msg);
1681                         if (unlikely(ret < 0 || ret > 0)) return -1;
1682                         break;
1683                 case FPARAM_PVS:
1684                         if (likely((pv_get_spec_value(msg, param->v.pvs, &pv_val)==0) &&
1685                                                 ((pv_val.flags&(PV_VAL_NULL|PV_VAL_STR))==PV_VAL_STR))){
1686                                         *dst=pv_val.rs;
1687                         }else{
1688                                 LM_ERR("Could not convert PV to str\n");
1689                                 return -1;
1690                         }
1691                         break;
1692                 case FPARAM_PVE:
1693                         dst->s=pv_get_buffer();
1694                         dst->len=pv_get_buffer_size();
1695                         if (unlikely(pv_printf(msg, param->v.pve, dst->s, &dst->len)!=0)){
1696                                 LM_ERR("Could not convert the PV-formated string to str\n");
1697                                 dst->len=0;
1698                                 return -1;
1699                         };
1700                         break;
1701         }
1702         return 0;
1703 }
1704
1705
1706 /** Get the function parameter value as integer.
1707  *  @return  0 - Success
1708  *          -1 - Cannot get value
1709  */
1710 int get_int_fparam(int* dst, struct sip_msg* msg, fparam_t* param)
1711 {
1712         int_str val;
1713         int ret;
1714         avp_t* avp;
1715         str tmp;
1716         pv_value_t pv_val;
1717
1718         switch(param->type) {
1719                 case FPARAM_INT:
1720                         *dst = param->v.i;
1721                         return 0;
1722                 case FPARAM_REGEX:
1723                 case FPARAM_UNSPEC:
1724                 case FPARAM_STRING:
1725                 case FPARAM_STR:
1726                         LM_ERR("Unsupported param type for int value: %d\n", param->type);
1727                         return -1;
1728                 case FPARAM_AVP:
1729                         avp = search_first_avp(param->v.avp.flags, param->v.avp.name,
1730                                                                         &val, 0);
1731                         if (unlikely(!avp)) {
1732                                 LM_DBG("Could not find AVP from function parameter '%s'\n",
1733                                                 param->orig);
1734                                 return -1;
1735                         }
1736                         if (avp->flags & AVP_VAL_STR) {
1737                                 if (str2int(&val.s, (unsigned int*)dst) < 0) {
1738                                         LM_ERR("Could not convert AVP string value to int\n");
1739                                         return -1;
1740                                 }
1741                         } else {
1742                                 *dst = val.n;
1743                         }
1744                         break;
1745                 case FPARAM_SELECT:
1746                         ret = run_select(&tmp, param->v.select, msg);
1747                         if (unlikely(ret < 0 || ret > 0)) return -1;
1748                         if (unlikely(str2int(&tmp, (unsigned int*)dst) < 0)) {
1749                                 LM_ERR("Could not convert select result to int\n");
1750                                 return -1;
1751                         }
1752                         break;
1753                 case FPARAM_PVS:
1754                         if (likely((pv_get_spec_value(msg, param->v.pvs, &pv_val)==0) &&
1755                                                 ((pv_val.flags&(PV_VAL_NULL|PV_VAL_INT))==PV_VAL_INT))){
1756                                         *dst=pv_val.ri;
1757                         }else{
1758                                 LM_ERR("Could not convert PV to int\n");
1759                                 return -1;
1760                         }
1761                         break;
1762                 case FPARAM_PVE:
1763                         LM_ERR("Unsupported param type for int value: %d\n", param->type);
1764                         return -1;
1765                 default:
1766                         LM_ERR("Unexpected param type: %d\n", param->type);
1767                         return -1;
1768         }
1769         return 0;
1770 }
1771
1772 /** Get the function parameter value as string or/and integer (if possible).
1773  *  @return  0 - Success
1774  *          -1 - Cannot get value
1775  */
1776 int get_is_fparam(int* i_dst, str* s_dst, struct sip_msg* msg, fparam_t* param, unsigned int *flags)
1777 {
1778         int_str val;
1779         int ret;
1780         avp_t* avp;
1781         str tmp;
1782         pv_value_t pv_val;
1783
1784         *flags = 0;
1785         switch(param->type) {
1786                 case FPARAM_INT:
1787                         *i_dst = param->v.i;
1788                         *flags |= PARAM_INT;
1789                         return 0;
1790                 case FPARAM_REGEX:
1791                 case FPARAM_UNSPEC:
1792                 case FPARAM_STRING:
1793                         s_dst->s = param->v.asciiz;
1794                         s_dst->len = strlen(param->v.asciiz);
1795                         *flags |= PARAM_STR;
1796                         break;
1797                 case FPARAM_STR:
1798                         *s_dst = param->v.str;
1799                         *flags |= PARAM_STR;
1800                         break;
1801                 case FPARAM_AVP:
1802                         avp = search_first_avp(param->v.avp.flags, param->v.avp.name,
1803                                                                         &val, 0);
1804                         if (unlikely(!avp)) {
1805                                 LM_DBG("Could not find AVP from function parameter '%s'\n",
1806                                                 param->orig);
1807                                 return -1;
1808                         }
1809                         if (avp->flags & AVP_VAL_STR) {
1810                                 *s_dst = val.s;
1811                                 *flags |= PARAM_STR;
1812                                 if (str2int(&val.s, (unsigned int*)i_dst) < 0) {
1813                                         LM_ERR("Could not convert AVP string value to int\n");
1814                                         return -1;
1815                                 }
1816                         } else {
1817                                 *i_dst = val.n;
1818                                 *flags |= PARAM_INT;
1819                         }
1820                         break;
1821                 case FPARAM_SELECT:
1822                         ret = run_select(&tmp, param->v.select, msg);
1823                         if (unlikely(ret < 0 || ret > 0)) return -1;
1824                         if (unlikely(str2int(&tmp, (unsigned int*)i_dst) < 0)) {
1825                                 LM_ERR("Could not convert select result to int\n");
1826                                 return -1;
1827                         }
1828                         *flags |= PARAM_INT;
1829                         break;
1830                 case FPARAM_PVS:
1831                         if (likely(pv_get_spec_value(msg, param->v.pvs, &pv_val)==0)) {
1832                                 if ((pv_val.flags&(PV_VAL_NULL|PV_VAL_INT))==PV_VAL_INT){
1833                                         *i_dst=pv_val.ri;
1834                                         *flags |= PARAM_INT;
1835                                 }
1836                                 if ((pv_val.flags&(PV_VAL_NULL|PV_VAL_STR))==PV_VAL_STR){
1837                                         *s_dst=pv_val.rs;
1838                                         *flags |= PARAM_STR;
1839                                 }
1840                         }else{
1841                                 LM_ERR("Could not get PV\n");
1842                                 return -1;
1843                         }
1844                         break;
1845                 case FPARAM_PVE:
1846                         s_dst->s=pv_get_buffer();
1847                         s_dst->len=pv_get_buffer_size();
1848                         if (unlikely(pv_printf(msg, param->v.pve, s_dst->s, &s_dst->len)!=0)){
1849                                 LM_ERR("Could not convert the PV-formated string to str\n");
1850                                 s_dst->len=0;
1851                                 return -1;
1852                         }
1853                         *flags |= PARAM_STR;
1854                         break;
1855         }
1856
1857         /* Let's convert to int, if possible */
1858         if (!(*flags & PARAM_INT) && (*flags & PARAM_STR) && str2sint(s_dst, i_dst) == 0)
1859                 *flags |= PARAM_INT;
1860
1861         if (!*flags) return -1;
1862
1863         return 0;
1864 }
1865
1866 /**
1867  * Retrieve the compiled RegExp.
1868  * @return: 0 for success, negative on error.
1869  */
1870 int get_regex_fparam(regex_t *dst, struct sip_msg* msg, fparam_t* param)
1871 {
1872         switch (param->type) {
1873                 case FPARAM_REGEX:
1874                         *dst = *param->v.regex;
1875                         return 0;
1876                 default:
1877                         LM_ERR("unexpected parameter type (%d), instead of regexp.\n",
1878                                         param->type);
1879         }
1880         return -1;
1881 }
1882
1883
1884
1885 /** generic free fixup function for "pure" fparam type fixups.
1886  * @param  param - double pointer to param, as for normal fixup functions.
1887  * @param  param_no - parameter number, ignored.
1888  * @return 0 on success (always).
1889  */
1890 int fixup_free_fparam_all(void** param, int param_no)
1891 {
1892         fparam_free_restore(param);
1893         return 0;
1894 }
1895
1896
1897
1898 /** generic free fixup function for "pure"  first parameter fparam type fixups.
1899  * @param  param - double pointer to param, as for normal fixup functions.
1900  * @param  param_no - parameter number: the function will work only for
1901  *                     param_no == 1 (first parameter).
1902  * @return 0 on success (always).
1903  */
1904 int fixup_free_fparam_1(void** param, int param_no)
1905 {
1906         if (param_no == 1)
1907                 fparam_free_restore(param);
1908         return 0;
1909 }
1910
1911
1912
1913 /** generic free fixup function for "pure"  2nd parameter fparam type fixups.
1914  * @param  param - double pointer to param, as for normal fixup functions.
1915  * @param  param_no - parameter number: the function will work only for
1916  *                     param_no == 2 (2nd parameter).
1917  * @return 0 on success (always).
1918  */
1919 int fixup_free_fparam_2(void** param, int param_no)
1920 {
1921         if (param_no == 2)
1922                 fparam_free_restore(param);
1923         return 0;
1924 }
1925
1926
1927
1928 /** returns true if a fixup is a fparam_t* one.
1929  * Used to automatically detect "pure" fparam fixups that can be used with non
1930  * contant RVEs.
1931  * @param f - function pointer
1932  * @return 1 for fparam fixups, 0 for others.
1933  */
1934 int is_fparam_rve_fixup(fixup_function f)
1935 {
1936         if (f == fixup_var_str_12 ||
1937                 f == fixup_var_str_1 ||
1938                 f == fixup_var_str_2 ||
1939                 f == fixup_var_pve_str_12 ||
1940                 f == fixup_var_pve_str_1 ||
1941                 f == fixup_var_pve_str_2 ||
1942                 f == fixup_var_int_12 ||
1943                 f == fixup_var_int_1 ||
1944                 f == fixup_var_int_2 ||
1945                 f == fixup_int_12 ||
1946                 f == fixup_int_1 ||
1947                 f == fixup_int_2 ||
1948                 f == fixup_str_12 ||
1949                 f == fixup_str_1 ||
1950                 f == fixup_str_2 ||
1951                 f == fixup_regex_12 ||
1952                 f == fixup_regex_1 ||
1953                 f == fixup_regex_2
1954                 )
1955                 return 1;
1956         return 0;
1957 }
1958
1959
1960 /**
1961  * @brief returns the corresponding fixup_free* for various known fixup types
1962  *
1963  * Returns the corresponding fixup_free* for various known fixup types.
1964  * Used to automatically fill in free_fixup* functions.
1965  * @param f fixup function pointer
1966  * @return free fixup function pointer on success, 0 on failure (unknown
1967  * fixup or no free fixup function).
1968  */
1969 free_fixup_function get_fixup_free(fixup_function f)
1970 {
1971         free_fixup_function ret;
1972         /* "pure" fparam, all parameters */
1973         if (f == fixup_var_str_12 ||
1974                 f == fixup_var_pve_str_12 ||
1975                 f == fixup_var_int_12 ||
1976                 f == fixup_int_12 ||
1977                 f == fixup_str_12 ||
1978                 f == fixup_regex_12)
1979                 return fixup_free_fparam_all;
1980
1981         /* "pure" fparam, 1st parameter */
1982         if (f == fixup_var_str_1 ||
1983                 f == fixup_var_pve_str_1 ||
1984                 f == fixup_var_int_1 ||
1985                 f == fixup_int_1 ||
1986                 f == fixup_str_1 ||
1987                 f == fixup_regex_1)
1988                 return fixup_free_fparam_1;
1989
1990         /* "pure" fparam, 2nd parameters */
1991         if (f == fixup_var_str_2 ||
1992                 f == fixup_var_pve_str_2 ||
1993                 f == fixup_var_int_2 ||
1994                 f == fixup_int_2 ||
1995                 f == fixup_str_2 ||
1996                 f == fixup_regex_2)
1997                 return fixup_free_fparam_2;
1998
1999         /* mod_fix.h kamailio style fixups */
2000         if ((ret = mod_fix_get_fixup_free(f)) != 0)
2001                 return ret;
2002
2003         /* unknown */
2004         return 0;
2005 }