/
sr_module.c
2005 lines (1800 loc) · 49.2 KB
/
sr_module.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright (C) 2001-2003 FhG Fokus
*
* This file is part of Kamailio, a free SIP server.
*
* Kamailio 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
*
* Kamailio 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.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
/**
* @file
* @brief Kamailio core :: modules loading, structures declarations and utilities
* @ingroup core
* Module: \ref core
*/
#include "sr_module.h"
#include "mod_fix.h"
#include "dprint.h"
#include "error.h"
#include "mem/mem.h"
#include "core_cmd.h"
#include "ut.h"
#include "re.h"
#include "route_struct.h"
#include "flags.h"
#include "trim.h"
#include "pvapi.h"
#include "globals.h"
#include "rpc_lookup.h"
#include "sr_compat.h"
#include "ppcfg.h"
#include "async_task.h"
#include <sys/stat.h>
#include <regex.h>
#include <dlfcn.h>
#include <strings.h>
#include <stdlib.h>
#include <string.h>
#include <stddef.h> /* for offsetof */
struct sr_module* modules=0;
/*We need to define this symbol on Solaris becuase libcurl relies on libnspr which looks for this symbol.
If it is not defined, dynamic module loading (dlsym) fails */
#ifdef __OS_solaris
int nspr_use_zone_allocator = 0;
#endif
#ifdef STATIC_EXEC
extern struct module_exports exec_exports;
#endif
#ifdef STATIC_TM
extern struct module_exports tm_exports;
#endif
#ifdef STATIC_MAXFWD
extern struct module_exports maxfwd_exports;
#endif
#ifdef STATIC_AUTH
extern struct module_exports auth_exports;
#endif
#ifdef STATIC_RR
extern struct module_exports rr_exports;
#endif
#ifdef STATIC_USRLOC
extern struct module_exports usrloc_exports;
#endif
#ifdef STATIC_SL
extern struct module_exports sl_exports;
#endif
#ifndef offsetof
#warning "use null pointer dereference for offsetof"
#define offsetof(st, m) \
((size_t) ( (char *)&((st *)(0))->m - (char *)0 ))
#endif
int mod_response_cbk_no=0;
response_function* mod_response_cbks=0;
/* number of usec to wait before initializing a module */
static unsigned int modinit_delay = 0;
unsigned int set_modinit_delay(unsigned int v)
{
unsigned int r;
r = modinit_delay;
modinit_delay = v;
return r;
}
/* keep state if server is in destroy modules phase */
static int _sr_destroy_modules_phase = 0;
/**
* return destroy modules phase state
*/
int destroy_modules_phase(void)
{
return _sr_destroy_modules_phase;
}
/**
* if bit 1 set, SIP worker processes handle RPC commands as well
* if bit 2 set, RPC worker processes handle SIP commands as well
*/
static int child_sip_rpc_mode = 0;
#define CHILD_SIP_RPC 1<<0
#define CHILD_RPC_SIP 1<<1
void set_child_sip_rpc_mode(void)
{
child_sip_rpc_mode |= CHILD_SIP_RPC;
}
void set_child_rpc_sip_mode(void)
{
child_sip_rpc_mode |= CHILD_RPC_SIP;
}
int is_rpc_worker(int rank)
{
if(rank==PROC_RPC
|| (rank>PROC_MAIN && (child_sip_rpc_mode&CHILD_SIP_RPC)!=0))
return 1;
return 0;
}
int is_sip_worker(int rank)
{
if(rank>PROC_MAIN
|| ((rank==PROC_RPC || rank==PROC_NOCHLDINIT)
&& (child_sip_rpc_mode&CHILD_RPC_SIP)!=0))
return 1;
return 0;
}
/* initializes statically built (compiled in) modules*/
int register_builtin_modules()
{
int ret;
ret=0;
#ifdef STATIC_TM
ret=register_module(MODULE_INTERFACE_VER, &tm_exports,"built-in", 0);
if (ret<0) return ret;
#endif
#ifdef STATIC_EXEC
ret=register_module(MODULE_INTERFACE_VER, &exec_exports,"built-in", 0);
if (ret<0) return ret;
#endif
#ifdef STATIC_MAXFWD
ret=register_module(MODULE_INTERFACE_VER, &maxfwd_exports, "built-in", 0);
if (ret<0) return ret;
#endif
#ifdef STATIC_AUTH
ret=register_module(MODULE_INTERFACE_VER, &auth_exports, "built-in", 0);
if (ret<0) return ret;
#endif
#ifdef STATIC_RR
ret=register_module(MODULE_INTERFACE_VER, &rr_exports, "built-in", 0);
if (ret<0) return ret;
#endif
#ifdef STATIC_USRLOC
ret=register_module(MODULE_INTERFACE_VER, &usrloc_exports, "built-in", 0);
if (ret<0) return ret;
#endif
#ifdef STATIC_SL
ret=register_module(MODULE_INTERFACE_VER, &sl_exports, "built-in", 0);
if (ret<0) return ret;
#endif
return ret;
}
/** convert cmd exports to current format.
* @param ver - module interface versions (0 == ser, 1 == kam).
* @param src - null terminated array of cmd exports
* (either ser_cmd_export_t or kam_cmd_export_t, depending
* on ver).
* @param mod - pointer to module exports structure.
* @return - pkg_malloc'ed null terminated sr_cmd_export_v31_t array with
* the converted cmd exports or 0 on error.
*/
static sr31_cmd_export_t* sr_cmd_exports_convert(unsigned ver,
void* src, void* mod)
{
int i, n;
ser_cmd_export_t* ser_cmd;
kam_cmd_export_t* kam_cmd;
sr31_cmd_export_t* ret;
ser_cmd = 0;
kam_cmd = 0;
ret = 0;
n = 0;
/* count the number of elements */
if (ver == 0) {
ser_cmd = src;
for (; ser_cmd[n].name; n++);
} else if (ver == 1) {
kam_cmd = src;
for (; kam_cmd[n].name; n++);
} else goto error; /* unknown interface version */
/* alloc & init new array */
ret = pkg_malloc(sizeof(*ret)*(n+1));
memset(ret, 0, sizeof(*ret)*(n+1));
/* convert/copy */
for (i=0; i < n; i++) {
if (ver == 0) {
ret[i].name = ser_cmd[i].name;
ret[i].function = ser_cmd[i].function;
ret[i].param_no = ser_cmd[i].param_no;
ret[i].fixup = ser_cmd[i].fixup;
ret[i].free_fixup = 0; /* no present in ser <= 2.1 */
ret[i].flags = ser_cmd[i].flags;
} else {
ret[i].name = kam_cmd[i].name;
ret[i].function = kam_cmd[i].function;
ret[i].param_no = kam_cmd[i].param_no;
ret[i].fixup = kam_cmd[i].fixup;
ret[i].free_fixup = kam_cmd[i].free_fixup;
ret[i].flags = kam_cmd[i].flags;
}
/* 3.1+ specific stuff */
ret[i].fixup_flags = 0;
ret[i].module_exports = mod;
/* fill known free fixups */
if (ret[i].fixup && ret[i].free_fixup == 0)
ret[i].free_fixup = get_fixup_free(ret[i].fixup);
}
return ret;
error:
return 0;
}
/* registers a module, register_f= module register functions
* returns <0 on error, 0 on success */
static int register_module(unsigned ver, union module_exports_u* e,
char* path, void* handle)
{
int ret, i;
struct sr_module* mod;
char defmod[64];
ret=-1;
/* add module to the list */
if ((mod=pkg_malloc(sizeof(struct sr_module)))==0){
LM_ERR("memory allocation failure\n");
ret=E_OUT_OF_MEM;
goto error;
}
memset(mod,0, sizeof(struct sr_module));
mod->path=path;
mod->handle=handle;
mod->orig_mod_interface_ver=ver;
/* convert exports to sr31 format */
if (ver == 0) {
/* ser <= 3.0 */
mod->exports.name = e->v0.name;
if (e->v0.cmds) {
mod->exports.cmds = sr_cmd_exports_convert(ver, e->v0.cmds, mod);
if (mod->exports.cmds == 0) {
LM_ERR("failed to convert module command exports to 3.1 format"
" for module \"%s\" (%s), interface version %d\n",
mod->exports.name, mod->path, ver);
ret = E_UNSPEC;
goto error;
}
}
mod->exports.params = e->v0.params;
mod->exports.init_f = e->v0.init_f;
mod->exports.response_f = e->v0.response_f;
mod->exports.destroy_f = e->v0.destroy_f;
mod->exports.onbreak_f = e->v0.onbreak_f;
mod->exports.init_child_f = e->v0.init_child_f;
mod->exports.dlflags = 0; /* not used in ser <= 3.0 */
mod->exports.rpc_methods = e->v0.rpc_methods;
/* the rest are 0, not used in ser */
} else if (ver == 1) {
/* kamailio <= 3.0 */
mod->exports.name = e->v1.name;
if (e->v1.cmds) {
mod->exports.cmds = sr_cmd_exports_convert(ver, e->v1.cmds, mod);
if (mod->exports.cmds == 0) {
LM_ERR("failed to convert module command exports to 3.1 format"
" for module \"%s\" (%s), interface version %d\n",
mod->exports.name, mod->path, ver);
ret = E_UNSPEC;
goto error;
}
}
mod->exports.params = e->v1.params;
mod->exports.init_f = e->v1.init_f;
mod->exports.response_f = e->v1.response_f;
mod->exports.destroy_f = e->v1.destroy_f;
mod->exports.onbreak_f = 0; /* not used in k <= 3.0 */
mod->exports.init_child_f = e->v1.init_child_f;
mod->exports.dlflags = e->v1.dlflags;
mod->exports.rpc_methods = 0; /* not used in k <= 3.0 */
mod->exports.stats = e->v1.stats;
mod->exports.nn_cmds = e->v1.nn_cmds;
mod->exports.items = e->v1.items;
mod->exports.procs = e->v1.procs;
} else {
LM_ERR("unsupported module interface version %d\n", ver);
ret = E_UNSPEC;
goto error;
}
if (mod->exports.items) {
/* register module pseudo-variables for kamailio modules */
LM_DBG("register PV from: %s\n", mod->exports.name);
if (register_pvars_mod(mod->exports.name, mod->exports.items)!=0) {
LM_ERR("failed to register pseudo-variables for module %s (%s)\n",
mod->exports.name, path);
ret = E_UNSPEC;
goto error;
}
}
if (mod->exports.rpc_methods){
/* register rpcs for ser modules */
i=rpc_register_array(mod->exports.rpc_methods);
if (i<0){
LM_ERR("failed to register RPCs for module %s (%s)\n",
mod->exports.name, path);
ret = E_UNSPEC;
goto error;
}else if (i>0){
LM_ERR("%d duplicate RPCs name detected while registering RPCs"
" declared in module %s (%s)\n",
i, mod->exports.name, path);
ret = E_UNSPEC;
goto error;
}
/* i==0 => success */
}
/* add cfg define for each module: MOD_modulename */
if(strlen(mod->exports.name)>=60) {
LM_ERR("too long module name: %s\n", mod->exports.name);
goto error;
}
strcpy(defmod, "MOD_");
strcat(defmod, mod->exports.name);
pp_define_set_type(0);
if(pp_define(strlen(defmod), defmod)<0) {
LM_ERR("unable to set cfg define for module: %s\n",
mod->exports.name);
goto error;
}
/* link module in the list */
mod->next=modules;
modules=mod;
return 0;
error:
if (mod)
pkg_free(mod);
return ret;
}
static inline int version_control(void *handle, char *path)
{
char **m_ver;
char **m_flags;
char* error;
m_ver=(char **)dlsym(handle, "module_version");
if ((error=(char *)dlerror())!=0) {
LM_ERR("no version info in module <%s>: %s\n", path, error);
return 0;
}
m_flags=(char **)dlsym(handle, "module_flags");
if ((error=(char *)dlerror())!=0) {
LM_ERR("no compile flags info in module <%s>: %s\n", path, error);
return 0;
}
if (!m_ver || !(*m_ver)) {
LM_ERR("no version in module <%s>\n", path );
return 0;
}
if (!m_flags || !(*m_flags)) {
LM_ERR("no compile flags in module <%s>\n", path );
return 0;
}
if (strcmp(SER_FULL_VERSION, *m_ver)==0){
if (strcmp(SER_COMPILE_FLAGS, *m_flags)==0)
return 1;
else {
LM_ERR("module compile flags mismatch for %s "
" \ncore: %s \nmodule: %s\n",
path, SER_COMPILE_FLAGS, *m_flags);
return 0;
}
}
LM_ERR("module version mismatch for %s; "
"core: %s; module: %s\n", path, SER_FULL_VERSION, *m_ver );
return 0;
}
/**
* \brief load a sr module
*
* tries to load the module specified by mod_path.
* If mod_path is 'modname' or 'modname.so' then
* \<MODS_DIR\>/\<modname\>.so will be tried and if this fails
* \<MODS_DIR\>/\<modname\>/\<modname\>.so
* If mod_path contain a '/' it is assumed to be the
* path to the module and tried first. If fails and mod_path is not
* absolute path (not starting with '/') then will try:
* \<MODS_DIR\>/mod_path
* @param mod_path path or module name
* @return 0 on success , <0 on error
*/
int load_module(char* mod_path)
{
void* handle;
char* error;
mod_register_function mr;
union module_exports_u* exp;
unsigned* mod_if_ver;
struct sr_module* t;
struct stat stat_buf;
str modname;
char* mdir;
char* nxt_mdir;
char* path;
int mdir_len;
int len;
int dlflags;
int new_dlflags;
int retries;
int path_type;
str expref;
char exbuf[64];
#ifndef RTLD_NOW
/* for openbsd */
#define RTLD_NOW DL_LAZY
#endif
path=mod_path;
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] != '/') {
/* module name was given, we try to construct the path */
mdir=mods_dir; /* search path */
do{
nxt_mdir=strchr(mdir, ':');
if (nxt_mdir) mdir_len=(int)(nxt_mdir-mdir);
else mdir_len=strlen(mdir);
if(path_type&2) {
/* try path <MODS_DIR>/<modname>.so */
path = (char*)pkg_malloc(mdir_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;
strcat(path, modname.s);
if(!(path_type&1))
strcat(path, ".so");
if (stat(path, &stat_buf) == -1) {
LM_DBG("module file not found <%s>\n", path);
pkg_free(path);
/* 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) {
LM_DBG("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) {
LM_DBG("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) {
LM_DBG("module file not found <%s>\n", path);
pkg_free(path);
path=0;
}
}
}
mdir=nxt_mdir?nxt_mdir+1:0;
}while(path==0 && mdir);
if (path==0){
LM_ERR("could not find module <%.*s> in <%s>\n",
modname.len, modname.s, mods_dir);
goto error;
}
}
LM_DBG("trying to load <%s>\n", path);
retries=2;
dlflags=RTLD_NOW;
reload:
handle=dlopen(path, dlflags); /* resolve all symbols now */
if (handle==0){
LM_ERR("could not open module <%s>: %s\n", path, dlerror());
goto error;
}
for(t=modules;t; t=t->next){
if (t->handle==handle){
LM_WARN("attempting to load the same module twice (%s)\n", path);
goto skip;
}
}
/* version control */
if (!version_control(handle, path)) {
exit(-1);
}
mod_if_ver = (unsigned *)dlsym(handle, "module_interface_ver");
if ( (error =(char*)dlerror())!=0 ){
LM_ERR("no module interface version in module <%s>\n", path );
goto error1;
}
/* launch register */
mr = (mod_register_function)dlsym(handle, "mod_register");
if (((error =(char*)dlerror())==0) && mr) {
/* no error call it */
new_dlflags=dlflags;
if (mr(path, &new_dlflags, 0, 0)!=0) {
LM_ERR("%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;
LM_ERR("%s: cannot agree on the dlflags\n", path);
goto error;
}
}
exp = (union module_exports_u*)dlsym(handle, "exports");
if(exp==NULL) {
/* 'exports' structure not found, look up for '_modulename_exports' */
mdir = strrchr(mod_path, '/');
if (!mdir) {
expref.s = mod_path;
} else {
expref.s = mdir+1;
}
expref.len = strlen(expref.s);
if(expref.len>3 && strcmp(expref.s+expref.len-3, ".so")==0)
expref.len -= 3;
snprintf(exbuf, 62, "_%.*s_exports", expref.len, expref.s);
exp = (union module_exports_u*)dlsym(handle, exbuf);
LM_DBG("looking up exports with name: %s\n", exbuf);
if ( (error =(char*)dlerror())!=0 ){
LM_ERR("%s\n", error);
goto error1;
}
}
/* 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);
DEBUG("%s: exports dlflags interface is deprecated and it will not"
" be supported in newer versions; consider using"
" mod_register() instead\n", path);
dlflags=new_dlflags;
retries--;
if (retries>0) goto reload;
LM_ERR("%s: cannot agree on the dlflags\n", path);
goto error;
}
}
if (register_module(*mod_if_ver, exp, path, handle)<0) goto error1;
return 0;
error1:
dlclose(handle);
error:
skip:
if (path && path!=mod_path)
pkg_free(path);
return -1;
}
/* 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 original module interface version.
* mod==0 is a wildcard matching all modules
* flags parameter is OR value of all flags that must match
*/
sr31_cmd_export_t* find_mod_export_record(char* mod, char* name,
int param_no, int flags,
unsigned* mod_if_ver)
{
struct sr_module* t;
sr31_cmd_export_t* cmd;
for(t=modules;t;t=t->next){
if (mod!=0 && (strcmp(t->exports.name, mod) !=0))
continue;
if (t->exports.cmds)
for(cmd=&t->exports.cmds[0]; cmd->name; cmd++) {
if((strcmp(name, cmd->name) == 0) &&
((cmd->param_no == param_no) ||
(cmd->param_no==VAR_PARAM_NO)) &&
((cmd->flags & flags) == flags)
){
LM_DBG("find_export_record: found <%s> in module %s [%s]\n",
name, t->exports.name, t->path);
*mod_if_ver=t->orig_mod_interface_ver;
return cmd;
}
}
}
LM_DBG("find_export_record: <%s> not found \n", name);
return 0;
}
/* 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
*/
sr31_cmd_export_t* 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);
}
cmd_function find_export(char* name, int param_no, int flags)
{
sr31_cmd_export_t* cmd;
unsigned mver;
cmd = find_export_record(name, param_no, flags, &mver);
return cmd?cmd->function:0;
}
rpc_export_t* find_rpc_export(char* name, int flags)
{
return rpc_lookup((char*)name, strlen(name));
}
/*
* searches the module list and returns pointer to "name" function in module
* "mod"
* 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)
{
sr31_cmd_export_t* cmd;
unsigned mver;
cmd=find_mod_export_record(mod, name, param_no, flags, &mver);
if (cmd)
return cmd->function;
LM_DBG("<%s> in module <%s> not found\n", name, mod);
return 0;
}
struct sr_module* find_module_by_name(char* mod) {
struct sr_module* t;
for(t = modules; t; t = t->next) {
if (strcmp(mod, t->exports.name) == 0) {
return t;
}
}
LM_DBG("module <%s> not found\n", mod);
return 0;
}
/*!
* \brief Find a parameter with given type
* \param mod module
* \param name parameter name
* \param type_mask parameter mask
* \param param_type parameter type
* \return parameter address in memory, if there is no such parameter, NULL is returned
*/
void* find_param_export(struct sr_module* mod, char* name,
modparam_t type_mask, modparam_t *param_type)
{
param_export_t* param;
if (!mod)
return 0;
for(param = mod->exports.params ;param && param->name ; param++) {
if ((strcmp(name, param->name) == 0) &&
((param->type & PARAM_TYPE_MASK(type_mask)) != 0)) {
LM_DBG("found <%s> in module %s [%s]\n",
name, mod->exports.name, mod->path);
*param_type = param->type;
return param->param_pointer;
}
}
LM_DBG("parameter <%s> not found in module <%s>\n",
name, mod->exports.name);
return 0;
}
void destroy_modules()
{
struct sr_module* t, *foo;
_sr_destroy_modules_phase = 1;
/* call first destroy function from each module */
t=modules;
while(t) {
foo=t->next;
if (t->exports.destroy_f){
t->exports.destroy_f();
}
t=foo;
}
/* free module exports structures */
t=modules;
while(t) {
foo=t->next;
pkg_free(t);
t=foo;
}
modules=0;
if (mod_response_cbks){
pkg_free(mod_response_cbks);
mod_response_cbks=0;
}
}
#ifdef NO_REVERSE_INIT
/*
* Initialize all loaded modules, the initialization
* is done *AFTER* the configuration file is parsed
*/
int init_modules(void)
{
struct sr_module* t;
if(async_task_init()<0)
return -1;
for(t = modules; t; t = t->next) {
if (t->exports.init_f) {
if (t->exports.init_f() != 0) {
LM_ERR("Error while initializing module %s\n", t->exports.name);
return -1;
}
/* delay next module init, if configured */
if(unlikely(modinit_delay>0))
sleep_us(modinit_delay);
}
if (t->exports.response_f)
mod_response_cbk_no++;
}
mod_response_cbks=pkg_malloc(mod_response_cbk_no *
sizeof(response_function));
if (mod_response_cbks==0){
LM_ERR("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) {
if (t->exports.response_f) {
mod_response_cbks[i]=t->exports.response_f;
i++;
}
}
return 0;
}
/*
* per-child initialization
*/
int init_child(int rank)
{
struct sr_module* t;
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;
}
LM_DBG("initializing %s with rank %d\n", type, rank);
if(async_task_child_init(rank)<0)
return -1;
for(t = modules; t; t = t->next) {
if (t->exports.init_child_f) {
if ((t->exports.init_child_f(rank)) < 0) {
LM_ERR("Initialization of child %d failed\n", rank);
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;
if (m->exports.init_child_f) {
LM_DBG("rank %d: %s\n", rank, m->exports.name);
if (m->exports.init_child_f(rank)<0) {
LM_ERR("Error while initializing module %s (%s)\n",
m->exports.name, m->path);
return -1;
} else {
/* module correctly initialized */
return 0;
}
}
/* no init function -- proceed with success */
return 0;
} else {
/* end of list */
return 0;
}
}
/*
* per-child initialization
*/
int init_child(int rank)
{
if(async_task_child_init(rank)<0)
return -1;
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;
if (m->exports.init_f) {
LM_DBG("%s\n", m->exports.name);
if (m->exports.init_f()!=0) {
LM_ERR("Error while initializing module %s (%s)\n",
m->exports.name, m->path);
return -1;
} else {
/* module correctly initialized */
return 0;
}
}
/* no init function -- proceed with success */
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)
{
struct sr_module* t;
int i;
if(async_task_init()<0)
return -1;
i = init_mod(modules);
if(i!=0)
return i;
for(t = modules; t; t = t->next)
if (t->exports.response_f)