/
tm.c
2502 lines (2197 loc) · 69.7 KB
/
tm.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
/*
* TM (transaction management) module
*
* 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
*/
/** TM :: Module API (core).
* @file
* @ingroup tm
*/
/**
* @defgroup tm TM :: Transaction stateful proxy support
*
* The TM module enables stateful processing of SIP transactions. The main use
* of stateful logic, which is costly in terms of memory and CPU, is some
* services that inherently need state.
*
* For example, transaction-based accounting (module acc) needs to process
* transaction state as opposed to individual messages, and any kinds of
* forking must be implemented statefully. Other use of stateful processing
* is it trading CPU caused by retransmission processing for memory.
* That however only makes sense if CPU consumption per request is huge.
* For example, if you want to avoid costly DNS resolution for every
* retransmission of a request to an unresolvable destination, use stateful
* mode. Then, only the initial message burdens server by DNS queries,
* subsequent retransmissions will be dropped and will not result in more
* processes blocked by DNS resolution. The price is more memory consumption
* and higher processing latency.
*/
#include "defs.h"
#include <stdio.h>
#include <string.h>
#include <netdb.h>
#include "../../sr_module.h"
#include "../../dprint.h"
#include "../../error.h"
#include "../../ut.h"
#include "../../script_cb.h"
#include "../../usr_avp.h"
#include "../../mem/mem.h"
#include "../../route_struct.h"
#include "../../route.h"
#include "../../cfg/cfg.h"
#include "../../globals.h"
#include "../../timer_ticks.h"
#include "../../mod_fix.h"
#include "../../kemi.h"
#include "config.h"
#include "sip_msg.h"
#include "h_table.h"
#include "t_hooks.h"
#include "tm_load.h"
#include "ut.h"
#include "t_reply.h"
#include "uac.h"
#include "t_fwd.h"
#include "t_lookup.h"
#include "t_stats.h"
#include "callid.h"
#include "t_cancel.h"
#include "t_fifo.h"
#include "timer.h"
#include "t_msgbuilder.h"
#include "select.h"
#include "t_serial.h"
#include "rpc_uac.h"
MODULE_VERSION
/* fixup functions */
static int fixup_hostport2proxy(void** param, int param_no);
static int fixup_proto_hostport2proxy(void** param, int param_no);
static int fixup_on_failure(void** param, int param_no);
static int fixup_on_branch_failure(void** param, int param_no);
static int fixup_on_reply(void** param, int param_no);
static int fixup_on_branch(void** param, int param_no);
static int fixup_t_reply(void** param, int param_no);
static int fixup_on_sl_reply(modparam_t type, void* val);
static int fixup_t_relay_to(void** param, int param_no);
static int fixup_t_is_set(void** param, int param_no);
/* init functions */
static int mod_init(void);
static int child_init(int rank);
/* exported functions */
inline static int w_t_check(struct sip_msg* msg, char* str, char* str2);
inline static int w_t_lookup_cancel(struct sip_msg* msg, char* str, char* str2);
inline static int w_t_reply(struct sip_msg* msg, char* str, char* str2);
inline static int w_t_release(struct sip_msg* msg, char* str, char* str2);
inline static int w_t_retransmit_reply(struct sip_msg* p_msg, char* foo,
char* bar );
inline static int w_t_newtran(struct sip_msg* p_msg, char* foo, char* bar );
inline static int w_t_relay( struct sip_msg *p_msg , char *_foo, char *_bar);
inline static int w_t_relay2( struct sip_msg *p_msg , char *proxy, char*);
inline static int w_t_relay_to_udp( struct sip_msg *p_msg , char *proxy,
char *);
inline static int w_t_relay_to_udp_uri( struct sip_msg *p_msg , char*, char*);
#ifdef USE_TCP
inline static int w_t_relay_to_tcp( struct sip_msg *p_msg , char *proxy,
char *);
inline static int w_t_relay_to_tcp_uri( struct sip_msg *p_msg , char*, char*);
#endif
#ifdef USE_TLS
inline static int w_t_relay_to_tls( struct sip_msg *p_msg , char *proxy,
char *);
inline static int w_t_relay_to_tls_uri( struct sip_msg *p_msg , char*, char*);
#endif
#ifdef USE_SCTP
inline static int w_t_relay_to_sctp( struct sip_msg *p_msg , char *proxy,
char *);
inline static int w_t_relay_to_sctp_uri( struct sip_msg*, char*, char*);
#endif
inline static int w_t_relay_to_avp(struct sip_msg* msg, char* str,char*);
inline static int w_t_relay_to(struct sip_msg* msg, char* str,char*);
inline static int w_t_replicate_uri( struct sip_msg *p_msg ,
char *uri, /* sip uri as string or variable */
char *_foo /* nothing expected */ );
inline static int w_t_replicate( struct sip_msg *p_msg ,
char *proxy, /* struct proxy_l *proxy expected */
char *_foo /* nothing expected */ );
inline static int w_t_replicate_udp( struct sip_msg *p_msg ,
char *proxy, /* struct proxy_l *proxy expected */
char *_foo /* nothing expected */ );
#ifdef USE_TCP
inline static int w_t_replicate_tcp( struct sip_msg *p_msg ,
char *proxy, /* struct proxy_l *proxy expected */
char *_foo /* nothing expected */ );
#endif
#ifdef USE_TLS
inline static int w_t_replicate_tls( struct sip_msg *p_msg ,
char *proxy, /* struct proxy_l *proxy expected */
char *_foo /* nothing expected */ );
#endif
#ifdef USE_SCTP
inline static int w_t_replicate_sctp( struct sip_msg *p_msg ,
char *proxy, /* struct proxy_l *proxy expected */
char *_foo /* nothing expected */ );
#endif
inline static int w_t_replicate_to(struct sip_msg* msg, char* str,char*);
inline static int w_t_forward_nonack(struct sip_msg* msg, char* str, char* );
inline static int w_t_forward_nonack_uri(struct sip_msg* msg, char* str,char*);
inline static int w_t_forward_nonack_udp(struct sip_msg* msg, char* str,char*);
#ifdef USE_TCP
inline static int w_t_forward_nonack_tcp(struct sip_msg*, char* str,char*);
#endif
#ifdef USE_TLS
inline static int w_t_forward_nonack_tls(struct sip_msg*, char* str,char*);
#endif
#ifdef USE_SCTP
inline static int w_t_forward_nonack_sctp(struct sip_msg*, char* str,char*);
#endif
inline static int w_t_forward_nonack_to(struct sip_msg* msg, char* str,char*);
inline static int w_t_relay_cancel(struct sip_msg *p_msg, char *_foo, char *_bar);
inline static int w_t_on_failure(struct sip_msg* msg, char *go_to, char *foo);
inline static int w_t_on_branch_failure(struct sip_msg* msg, char *go_to, char *foo);
inline static int w_t_on_branch(struct sip_msg* msg, char *go_to, char *foo);
inline static int w_t_on_reply(struct sip_msg* msg, char *go_to, char *foo );
inline static int t_check_status(struct sip_msg* msg, char *match, char *foo);
static int t_set_fr_inv(struct sip_msg* msg, char* fr_inv, char* foo);
static int t_set_fr_all(struct sip_msg* msg, char* fr_inv, char* fr);
static int w_t_reset_fr(struct sip_msg* msg, char* foo, char* bar);
static int w_t_set_retr(struct sip_msg* msg, char* retr_t1, char* retr_t2);
static int w_t_reset_retr(struct sip_msg* msg, char* foo, char* bar);
static int w_t_set_max_lifetime(struct sip_msg* msg, char* inv, char* noninv);
static int w_t_reset_max_lifetime(struct sip_msg* msg, char* foo, char* bar);
static int t_set_auto_inv_100(struct sip_msg* msg, char* on_off, char* foo);
static int t_set_disable_6xx(struct sip_msg* msg, char* on_off, char* foo);
static int t_set_disable_failover(struct sip_msg* msg, char* on_off, char* f);
#ifdef CANCEL_REASON_SUPPORT
static int t_set_no_e2e_cancel_reason(struct sip_msg* msg, char* on_off,
char* f);
#endif /* CANCEL_REASON_SUPPORT */
static int t_set_disable_internal_reply(struct sip_msg* msg, char* on_off, char* f);
static int t_branch_timeout(struct sip_msg* msg, char*, char*);
static int t_branch_replied(struct sip_msg* msg, char*, char*);
static int t_any_timeout(struct sip_msg* msg, char*, char*);
static int t_any_replied(struct sip_msg* msg, char*, char*);
static int w_t_is_canceled(struct sip_msg* msg, char*, char*);
static int t_is_expired(struct sip_msg* msg, char*, char*);
static int w_t_is_retr_async_reply(struct sip_msg* msg, char*, char*);
static int t_grep_status(struct sip_msg* msg, char*, char*);
static int w_t_drop_replies(struct sip_msg* msg, char* foo, char* bar);
static int w_t_save_lumps(struct sip_msg* msg, char* foo, char* bar);
static int w_t_check_trans(struct sip_msg* msg, char* foo, char* bar);
static int w_t_is_set(struct sip_msg* msg, char* target, char* bar);
static int w_t_use_uac_headers(sip_msg_t* msg, char* foo, char* bar);
/* by default the fr timers avps are not set, so that the avps won't be
* searched for nothing each time a new transaction is created */
static char *fr_timer_param = 0 /*FR_TIMER_AVP*/;
static char *fr_inv_timer_param = 0 /*FR_INV_TIMER_AVP*/;
str contacts_avp = {0, 0};
str contact_flows_avp = {0, 0};
str ulattrs_xavp_name = {NULL, 0};
int tm_remap_503_500 = 1;
int tm_failure_exec_mode = 0;
int tm_dns_reuse_rcv_socket = 0;
static rpc_export_t tm_rpc[];
static int fixup_t_check_status(void** param, int param_no);
static cmd_export_t cmds[]={
{"t_newtran", w_t_newtran, 0, 0,
REQUEST_ROUTE},
{"t_lookup_request", w_t_check, 0, 0,
REQUEST_ROUTE},
{"t_lookup_cancel", w_t_lookup_cancel, 0, 0,
REQUEST_ROUTE},
{"t_lookup_cancel", w_t_lookup_cancel, 1, fixup_int_1,
REQUEST_ROUTE},
{"t_reply", w_t_reply, 2, fixup_t_reply,
REQUEST_ROUTE | ONREPLY_ROUTE | FAILURE_ROUTE },
{"t_retransmit_reply", w_t_retransmit_reply, 0, 0,
REQUEST_ROUTE},
{"t_release", w_t_release, 0, 0,
REQUEST_ROUTE},
{"t_relay_to_udp", w_t_relay_to_udp, 2, fixup_hostport2proxy,
REQUEST_ROUTE|FAILURE_ROUTE},
{"t_relay_to_udp", w_t_relay_to_udp_uri, 0, 0,
REQUEST_ROUTE|FAILURE_ROUTE},
#ifdef USE_TCP
{"t_relay_to_tcp", w_t_relay_to_tcp, 2, fixup_hostport2proxy,
REQUEST_ROUTE|FAILURE_ROUTE},
{"t_relay_to_tcp", w_t_relay_to_tcp_uri, 0, 0,
REQUEST_ROUTE|FAILURE_ROUTE},
#endif
#ifdef USE_TLS
{"t_relay_to_tls", w_t_relay_to_tls, 2, fixup_hostport2proxy,
REQUEST_ROUTE|FAILURE_ROUTE},
{"t_relay_to_tls", w_t_relay_to_tls_uri, 0, 0,
REQUEST_ROUTE|FAILURE_ROUTE},
#endif
#ifdef USE_SCTP
{"t_relay_to_sctp", w_t_relay_to_sctp, 2, fixup_hostport2proxy,
REQUEST_ROUTE|FAILURE_ROUTE},
{"t_relay_to_sctp", w_t_relay_to_sctp_uri, 0, 0,
REQUEST_ROUTE|FAILURE_ROUTE},
#endif
{"t_replicate", w_t_replicate_uri, 0, 0,
REQUEST_ROUTE},
{"t_replicate", w_t_replicate_uri, 1, fixup_spve_null,
REQUEST_ROUTE},
{"t_replicate", w_t_replicate, 2, fixup_hostport2proxy,
REQUEST_ROUTE},
{"t_replicate_udp", w_t_replicate_udp, 2, fixup_hostport2proxy,
REQUEST_ROUTE},
#ifdef USE_TCP
{"t_replicate_tcp", w_t_replicate_tcp, 2, fixup_hostport2proxy,
REQUEST_ROUTE},
#endif
#ifdef USE_TLS
{"t_replicate_tls", w_t_replicate_tls, 2, fixup_hostport2proxy,
REQUEST_ROUTE},
#endif
#ifdef USE_SCTP
{"t_replicate_sctp", w_t_replicate_sctp, 2, fixup_hostport2proxy,
REQUEST_ROUTE},
#endif
{"t_replicate_to", w_t_replicate_to, 2, fixup_proto_hostport2proxy,
REQUEST_ROUTE},
{"t_relay", w_t_relay, 0, 0,
REQUEST_ROUTE | FAILURE_ROUTE },
{"t_relay", w_t_relay2, 2, fixup_hostport2proxy,
REQUEST_ROUTE | FAILURE_ROUTE },
{"t_relay_to_avp", w_t_relay_to_avp, 2, fixup_proto_hostport2proxy,
REQUEST_ROUTE},
{"t_relay_to", w_t_relay_to, 0, 0,
REQUEST_ROUTE | FAILURE_ROUTE },
{"t_relay_to", w_t_relay_to, 1, fixup_t_relay_to,
REQUEST_ROUTE | FAILURE_ROUTE },
{"t_relay_to", w_t_relay_to, 2, fixup_t_relay_to,
REQUEST_ROUTE | FAILURE_ROUTE },
{"t_forward_nonack", w_t_forward_nonack, 2, fixup_hostport2proxy,
REQUEST_ROUTE},
{"t_forward_nonack_uri", w_t_forward_nonack_uri, 0, 0,
REQUEST_ROUTE},
{"t_forward_nonack_udp", w_t_forward_nonack_udp, 2, fixup_hostport2proxy,
REQUEST_ROUTE},
#ifdef USE_TCP
{"t_forward_nonack_tcp", w_t_forward_nonack_tcp, 2, fixup_hostport2proxy,
REQUEST_ROUTE},
#endif
#ifdef USE_TLS
{"t_forward_nonack_tls", w_t_forward_nonack_tls, 2, fixup_hostport2proxy,
REQUEST_ROUTE},
#endif
#ifdef USE_SCTP
{"t_forward_nonack_sctp", w_t_forward_nonack_sctp, 2, fixup_hostport2proxy,
REQUEST_ROUTE},
#endif
{"t_forward_nonack_to", w_t_forward_nonack_to, 2, fixup_proto_hostport2proxy,
REQUEST_ROUTE},
{"t_relay_cancel", w_t_relay_cancel, 0, 0,
REQUEST_ROUTE},
{"t_on_failure", w_t_on_failure, 1, fixup_on_failure,
REQUEST_ROUTE | FAILURE_ROUTE | TM_ONREPLY_ROUTE | BRANCH_ROUTE },
{"t_on_branch_failure",w_t_on_branch_failure, 1, fixup_on_branch_failure,
REQUEST_ROUTE | FAILURE_ROUTE | TM_ONREPLY_ROUTE | BRANCH_ROUTE },
{"t_on_reply", w_t_on_reply, 1, fixup_on_reply,
REQUEST_ROUTE | FAILURE_ROUTE | TM_ONREPLY_ROUTE | BRANCH_ROUTE },
{"t_on_branch", w_t_on_branch, 1, fixup_on_branch,
REQUEST_ROUTE | FAILURE_ROUTE },
{"t_check_status", t_check_status, 1, fixup_t_check_status,
REQUEST_ROUTE | FAILURE_ROUTE | ONREPLY_ROUTE},
{"t_write_req", t_write_req, 2, fixup_t_write,
REQUEST_ROUTE | FAILURE_ROUTE },
{"t_write_unix", t_write_unix, 2, fixup_t_write,
REQUEST_ROUTE | FAILURE_ROUTE },
{"t_set_fr", t_set_fr_inv, 1, fixup_var_int_1,
REQUEST_ROUTE|TM_ONREPLY_ROUTE|FAILURE_ROUTE|BRANCH_ROUTE },
{"t_set_fr", t_set_fr_all, 2, fixup_var_int_12,
REQUEST_ROUTE|TM_ONREPLY_ROUTE|FAILURE_ROUTE|BRANCH_ROUTE },
{"t_reset_fr", w_t_reset_fr, 0, 0,
REQUEST_ROUTE|TM_ONREPLY_ROUTE|FAILURE_ROUTE|BRANCH_ROUTE },
{"t_set_retr", w_t_set_retr, 2, fixup_var_int_12,
REQUEST_ROUTE|TM_ONREPLY_ROUTE|FAILURE_ROUTE|BRANCH_ROUTE },
{"t_reset_retr", w_t_reset_retr, 0, 0,
REQUEST_ROUTE|TM_ONREPLY_ROUTE|FAILURE_ROUTE|BRANCH_ROUTE },
{"t_set_max_lifetime", w_t_set_max_lifetime, 2, fixup_var_int_12,
REQUEST_ROUTE|TM_ONREPLY_ROUTE|FAILURE_ROUTE|BRANCH_ROUTE },
{"t_reset_max_lifetime", w_t_reset_max_lifetime, 0, 0,
REQUEST_ROUTE|TM_ONREPLY_ROUTE|FAILURE_ROUTE|BRANCH_ROUTE },
{"t_set_auto_inv_100", t_set_auto_inv_100, 1, fixup_var_int_1,
REQUEST_ROUTE},
{"t_set_disable_6xx", t_set_disable_6xx, 1, fixup_var_int_1,
REQUEST_ROUTE|TM_ONREPLY_ROUTE|FAILURE_ROUTE|BRANCH_ROUTE },
{"t_set_disable_failover", t_set_disable_failover, 1, fixup_var_int_1,
REQUEST_ROUTE|TM_ONREPLY_ROUTE|FAILURE_ROUTE|BRANCH_ROUTE },
#ifdef CANCEL_REASON_SUPPORT
{"t_set_no_e2e_cancel_reason", t_set_no_e2e_cancel_reason, 1,
fixup_var_int_1,
REQUEST_ROUTE|TM_ONREPLY_ROUTE|FAILURE_ROUTE|BRANCH_ROUTE },
/* alias for t_set_no_e2e_cancel_reason */
{"t_disable_e2e_cancel_reason", t_set_no_e2e_cancel_reason, 1,
fixup_var_int_1,
REQUEST_ROUTE|TM_ONREPLY_ROUTE|FAILURE_ROUTE|BRANCH_ROUTE },
#endif /* CANCEL_REASON_SUPPORT */
{"t_set_disable_internal_reply", t_set_disable_internal_reply, 1, fixup_var_int_1,
REQUEST_ROUTE|TM_ONREPLY_ROUTE|FAILURE_ROUTE|BRANCH_ROUTE },
{"t_branch_timeout", t_branch_timeout, 0, 0,
FAILURE_ROUTE|EVENT_ROUTE},
{"t_branch_replied", t_branch_replied, 0, 0,
FAILURE_ROUTE|EVENT_ROUTE},
{"t_any_timeout", t_any_timeout, 0, 0,
REQUEST_ROUTE|TM_ONREPLY_ROUTE|FAILURE_ROUTE|BRANCH_ROUTE },
{"t_any_replied", t_any_replied, 0, 0,
REQUEST_ROUTE|TM_ONREPLY_ROUTE|FAILURE_ROUTE|BRANCH_ROUTE },
{"t_is_canceled", w_t_is_canceled, 0, 0,
REQUEST_ROUTE|TM_ONREPLY_ROUTE|FAILURE_ROUTE|BRANCH_ROUTE },
{"t_is_retr_async_reply", w_t_is_retr_async_reply, 0, 0,
TM_ONREPLY_ROUTE},
{"t_is_expired", t_is_expired, 0, 0,
REQUEST_ROUTE|TM_ONREPLY_ROUTE|FAILURE_ROUTE|BRANCH_ROUTE },
{"t_grep_status", t_grep_status, 1, fixup_var_int_1,
REQUEST_ROUTE|TM_ONREPLY_ROUTE|FAILURE_ROUTE|BRANCH_ROUTE },
{"t_drop_replies", w_t_drop_replies, 0, 0,
FAILURE_ROUTE},
{"t_drop_replies", w_t_drop_replies, 1, 0,
FAILURE_ROUTE},
{"t_save_lumps", w_t_save_lumps, 0, 0,
REQUEST_ROUTE},
{"t_check_trans", w_t_check_trans, 0, 0,
REQUEST_ROUTE|ONREPLY_ROUTE|BRANCH_ROUTE },
{"t_is_set", w_t_is_set, 1, fixup_t_is_set,
ANY_ROUTE },
{"t_use_uac_headers", w_t_use_uac_headers, 0, 0,
ANY_ROUTE },
{"t_load_contacts", t_load_contacts, 0, 0,
REQUEST_ROUTE | FAILURE_ROUTE},
{"t_next_contacts", t_next_contacts, 0, 0,
REQUEST_ROUTE | FAILURE_ROUTE},
{"t_next_contact_flow", t_next_contact_flow, 0, 0,
REQUEST_ROUTE },
/* not applicable from the script */
{"load_tm", (cmd_function)load_tm, NO_SCRIPT, 0, 0},
{"load_xtm", (cmd_function)load_xtm, NO_SCRIPT, 0, 0},
{0,0,0,0,0}
};
static param_export_t params[]={
{"ruri_matching", PARAM_INT, &default_tm_cfg.ruri_matching },
{"via1_matching", PARAM_INT, &default_tm_cfg.via1_matching },
{"callid_matching", PARAM_INT, &default_tm_cfg.callid_matching },
{"fr_timer", PARAM_INT, &default_tm_cfg.fr_timeout },
{"fr_inv_timer", PARAM_INT, &default_tm_cfg.fr_inv_timeout },
{"wt_timer", PARAM_INT, &default_tm_cfg.wait_timeout },
{"delete_timer", PARAM_INT, &default_tm_cfg.delete_timeout },
{"retr_timer1", PARAM_INT, &default_tm_cfg.rt_t1_timeout_ms },
{"retr_timer2" , PARAM_INT, &default_tm_cfg.rt_t2_timeout_ms },
{"max_inv_lifetime", PARAM_INT, &default_tm_cfg.tm_max_inv_lifetime },
{"max_noninv_lifetime", PARAM_INT, &default_tm_cfg.tm_max_noninv_lifetime},
{"noisy_ctimer", PARAM_INT, &default_tm_cfg.noisy_ctimer },
{"auto_inv_100", PARAM_INT, &default_tm_cfg.tm_auto_inv_100 },
{"auto_inv_100_reason", PARAM_STRING, &default_tm_cfg.tm_auto_inv_100_r },
{"unix_tx_timeout", PARAM_INT, &default_tm_cfg.tm_unix_tx_timeout },
{"restart_fr_on_each_reply", PARAM_INT,
&default_tm_cfg.restart_fr_on_each_reply},
{"fr_timer_avp", PARAM_STRING, &fr_timer_param },
{"fr_inv_timer_avp", PARAM_STRING, &fr_inv_timer_param },
{"tw_append", PARAM_STRING|PARAM_USE_FUNC,
(void*)parse_tw_append },
{"pass_provisional_replies", PARAM_INT,
&default_tm_cfg.pass_provisional_replies },
{"aggregate_challenges", PARAM_INT, &default_tm_cfg.tm_aggregate_auth },
{"unmatched_cancel", PARAM_INT, &default_tm_cfg.unmatched_cancel },
{"default_code", PARAM_INT, &default_tm_cfg.default_code },
{"default_reason", PARAM_STRING, &default_tm_cfg.default_reason },
{"reparse_invite", PARAM_INT, &default_tm_cfg.reparse_invite },
{"ac_extra_hdrs", PARAM_STR, &default_tm_cfg.ac_extra_hdrs },
{"blst_503", PARAM_INT, &default_tm_cfg.tm_blst_503 },
{"blst_503_def_timeout",PARAM_INT, &default_tm_cfg.tm_blst_503_default },
{"blst_503_min_timeout",PARAM_INT, &default_tm_cfg.tm_blst_503_min },
{"blst_503_max_timeout",PARAM_INT, &default_tm_cfg.tm_blst_503_max },
{"blst_methods_add", PARAM_INT, &default_tm_cfg.tm_blst_methods_add },
{"blst_methods_lookup", PARAM_INT, &default_tm_cfg.tm_blst_methods_lookup},
{"cancel_b_method", PARAM_INT, &default_tm_cfg.cancel_b_flags},
{"reparse_on_dns_failover", PARAM_INT, &default_tm_cfg.reparse_on_dns_failover},
{"on_sl_reply", PARAM_STRING|PARAM_USE_FUNC, fixup_on_sl_reply },
{"contacts_avp", PARAM_STR, &contacts_avp },
{"contact_flows_avp", PARAM_STR, &contact_flows_avp },
{"disable_6xx_block", PARAM_INT, &default_tm_cfg.disable_6xx },
{"local_ack_mode", PARAM_INT, &default_tm_cfg.local_ack_mode },
{"failure_reply_mode", PARAM_INT, &failure_reply_mode },
{"faked_reply_prio", PARAM_INT, &faked_reply_prio },
{"remap_503_500", PARAM_INT, &tm_remap_503_500 },
{"failure_exec_mode", PARAM_INT, &tm_failure_exec_mode },
{"dns_reuse_rcv_socket",PARAM_INT, &tm_dns_reuse_rcv_socket },
#ifdef CANCEL_REASON_SUPPORT
{"local_cancel_reason", PARAM_INT, &default_tm_cfg.local_cancel_reason },
{"e2e_cancel_reason", PARAM_INT, &default_tm_cfg.e2e_cancel_reason },
#endif /* CANCEL_REASON_SUPPORT */
{"xavp_contact", PARAM_STR, &ulattrs_xavp_name },
{0,0,0}
};
#ifdef STATIC_TM
struct module_exports tm_exports = {
#else
struct module_exports exports= {
#endif
"tm",
/* -------- exported functions ----------- */
cmds,
tm_rpc, /* RPC methods */
/* ------------ exported variables ---------- */
params,
mod_init, /* module initialization function */
(response_function) reply_received,
(destroy_function) tm_shutdown,
0, /* w_onbreak, */
child_init /* per-child init function */
};
/* helper for fixup_on_* */
static int fixup_routes(char* r_type, struct route_list* rt, void** param)
{
int i;
i=route_get(rt, (char*)*param);
if (i==-1){
LOG(L_ERR, "ERROR: tm: fixup_routes: route_get failed\n");
return E_UNSPEC;
}
if (r_type && rt->rlist[i]==0){
LOG(L_WARN, "WARNING: %s(\"%s\"): empty/non existing route\n",
r_type, (char*)*param);
}
*param=(void*)(long)i;
return 0;
}
static int fixup_t_reply(void** param, int param_no)
{
if (param_no == 1) {
if (fixup_var_int_12(param, 1) != 0) return -1;
} else if (param_no == 2) {
return fixup_var_str_12(param, 2);
}
return 0;
}
static int fixup_on_failure(void** param, int param_no)
{
if (param_no==1){
if(strlen((char*)*param)<=1
&& (*(char*)(*param)==0 || *(char*)(*param)=='0')) {
*param = (void*)0;
return 0;
}
return fixup_routes("t_on_failure", &failure_rt, param);
}
return 0;
}
#define BRANCH_FAILURE_ROUTE_PREFIX "tm:branch-failure"
static int fixup_on_branch_failure(void** param, int param_no)
{
char *full_route_name = NULL;
int len;
int ret = 0;
if (param_no==1){
if((len = strlen((char*)*param))<=1
&& (*(char*)(*param)==0 || *(char*)(*param)=='0')) {
*param = (void*)0;
return 0;
}
len += strlen(BRANCH_FAILURE_ROUTE_PREFIX) + 1;
if ((full_route_name = pkg_malloc(len+1)) == NULL)
{
LM_ERR("No memory left in branch_failure fixup\n");
return -1;
}
sprintf(full_route_name, "%s:%s", BRANCH_FAILURE_ROUTE_PREFIX, (char*)*param);
*param=(void*)full_route_name;
ret = fixup_routes("t_on_branch_failure", &event_rt, param);
pkg_free(full_route_name);
}
return ret;
}
static int fixup_on_reply(void** param, int param_no)
{
if (param_no==1){
if(strlen((char*)*param)<=1
&& (*(char*)(*param)==0 || *(char*)(*param)=='0')) {
*param = (void*)0;
return 0;
}
return fixup_routes("t_on_reply", &onreply_rt, param);
}
return 0;
}
static int fixup_on_branch(void** param, int param_no)
{
if (param_no==1){
if(strlen((char*)*param)<=1
&& (*(char*)(*param)==0 || *(char*)(*param)=='0')) {
*param = (void*)0;
return 0;
}
return fixup_routes("t_on_branch", &branch_rt, param);
}
return 0;
}
static int fixup_on_sl_reply(modparam_t type, void* val)
{
if ((type & PARAM_STRING) == 0) {
LOG(L_ERR, "ERROR: tm: fixup_on_sl_reply: not a string parameter\n");
return -1;
}
if (fixup_routes(0, &onreply_rt, &val))
return -1;
goto_on_sl_reply = (int)(long)val;
return 0;
}
/* (char *hostname, char *port_nr) ==> (struct proxy_l *, -) */
static int fixup_hostport2proxy(void** param, int param_no)
{
unsigned int port;
char *host;
int err;
struct proxy_l *proxy;
action_u_t *a;
str s;
DBG("TM module: fixup_hostport2proxy(%s, %d)\n", (char*)*param, param_no);
if (param_no==1){
return 0;
} else if (param_no==2) {
a = fixup_get_param(param, param_no, 1);
host= a->u.string;
port=str2s(*param, strlen(*param), &err);
if (err!=0) {
LOG(L_ERR, "TM module:fixup_hostport2proxy: bad port number <%s>\n",
(char*)(*param));
return E_UNSPEC;
}
s.s = host;
s.len = strlen(host);
proxy=mk_proxy(&s, port, 0); /* FIXME: udp or tcp? */
if (proxy==0) {
LOG(L_ERR, "ERROR: fixup_hostport2proxy: bad host name in URI <%s>\n",
host );
return E_BAD_ADDRESS;
}
/* success -- fix the first parameter to proxy now ! */
a->u.data=proxy;
return 0;
} else {
LOG(L_ERR,"ERROR: fixup_hostport2proxy called with parameter #<>{1,2}\n");
return E_BUG;
}
}
/* (char *$proto, char *$host:port) ==> (fparam, fparam) */
static int fixup_proto_hostport2proxy(void** param, int param_no) {
int ret;
ret = fix_param(FPARAM_AVP, param);
if (ret <= 0) return ret;
/* if (param_no = 1) { FIXME: param_str currently does not offer INT/STR overloading
ret = fix_param(FPARAM_INT, param);
if (ret <= 0) return ret;
} */
if (fix_param(FPARAM_STRING, param) != 0) return -1;
return 0;
}
static int fixup_t_check_status(void** param, int param_no)
{
int ret;
ret = fix_param(FPARAM_AVP, param);
if (ret <= 0) return ret;
ret = fix_param(FPARAM_SELECT, param);
if (ret <= 0) return ret;
if (fix_param(FPARAM_REGEX, param) != 0) return -1;
return 0;
}
/***************************** init functions *****************************/
static int w_t_unref( struct sip_msg *foo, unsigned int flags, void *bar)
{
return t_unref(foo);
}
static int script_init( struct sip_msg *foo, unsigned int flags, void *bar)
{
/* we primarily reset all private memory here to make sure
* private values left over from previous message will
* not be used again */
/* make sure the new message will not inherit previous
message's t_on_failure value
*/
t_on_failure( 0 );
t_on_branch_failure(0);
t_on_reply(0);
t_on_branch(0);
/* reset the kr status */
reset_kr();
/* set request mode so that multiple-mode actions know
* how to behave */
set_route_type(REQUEST_ROUTE);
lumps_are_cloned = 0;
return 1;
}
static int mod_init(void)
{
DBG( "TM - (sizeof cell=%ld, sip_msg=%ld) initializing...\n",
(long)sizeof(struct cell), (long)sizeof(struct sip_msg));
/* checking if we have sufficient bitmap capacity for given
* maximum number of branches */
if (sr_dst_max_branches+1>31) {
LOG(L_CRIT, "Too many max UACs for UAC branch_bm_t bitmap: %d\n",
sr_dst_max_branches );
return -1;
}
if (init_callid() < 0) {
LOG(L_CRIT, "Error while initializing Call-ID generator\n");
return -1;
}
/* building the hash table*/
if (!init_hash_table()) {
LOG(L_ERR, "ERROR: mod_init: initializing hash_table failed\n");
return -1;
}
/* init static hidden values */
init_t();
if (tm_init_selects()==-1) {
LOG(L_ERR, "ERROR: mod_init: select init failed\n");
return -1;
}
/* the default timer values must be fixed-up before
* declaring the configuration (Miklos) */
if (tm_init_timers()==-1) {
LOG(L_ERR, "ERROR: mod_init: timer init failed\n");
return -1;
}
/* the cancel branch flags must be fixed before declaring the
* configuration */
if (cancel_b_flags_get(&default_tm_cfg.cancel_b_flags,
default_tm_cfg.cancel_b_flags)<0){
LOG(L_ERR, "ERROR: mod_init: bad cancel branch method\n");
return -1;
}
#ifdef USE_DNS_FAILOVER
if (default_tm_cfg.reparse_on_dns_failover && mhomed) {
LOG(L_WARN, "WARNING: mod_init: "
"reparse_on_dns_failover is enabled on a "
"multihomed host -- check the readme of tm module!\n");
}
#endif
/* declare the configuration */
if (cfg_declare("tm", tm_cfg_def, &default_tm_cfg, cfg_sizeof(tm),
&tm_cfg)) {
LOG(L_ERR, "ERROR: mod_init: failed to declare the configuration\n");
return -1;
}
/* First tm_stat initialization function only allocates the top level stat
* structure in shared memory, the initialization will complete in child
* init with init_tm_stats_child when the final value of estimated_process_count is
* known
*/
if (init_tm_stats() < 0) {
LOG(L_CRIT, "ERROR: mod_init: failed to init stats\n");
return -1;
}
if (uac_init()==-1) {
LOG(L_ERR, "ERROR: mod_init: uac_init failed\n");
return -1;
}
if (init_tmcb_lists()!=1) {
LOG(L_CRIT, "ERROR:tm:mod_init: failed to init tmcb lists\n");
return -1;
}
tm_init_tags();
init_twrite_lines();
if (init_twrite_sock() < 0) {
LOG(L_ERR, "ERROR:tm:mod_init: Unable to create socket\n");
return -1;
}
/* register post-script clean-up function */
if (register_script_cb( w_t_unref, POST_SCRIPT_CB|REQUEST_CB, 0)<0 ) {
LOG(L_ERR,"ERROR:tm:mod_init: failed to register POST request "
"callback\n");
return -1;
}
if (register_script_cb( script_init, PRE_SCRIPT_CB|REQUEST_CB , 0)<0 ) {
LOG(L_ERR,"ERROR:tm:mod_init: failed to register PRE request "
"callback\n");
return -1;
}
if (init_avp_params(fr_timer_param, fr_inv_timer_param) < 0) {
LOG(L_ERR,"ERROR:tm:mod_init: failed to process AVP params\n");
return -1;
}
if ((contacts_avp.len > 0) && (contact_flows_avp.len == 0)) {
LOG(L_ERR,"ERROR:tm:mod_init: contact_flows_avp param has not been defined\n");
return -1;
}
#ifdef WITH_EVENT_LOCAL_REQUEST
goto_on_local_req=route_lookup(&event_rt, "tm:local-request");
if (goto_on_local_req>=0 && event_rt.rlist[goto_on_local_req]==0)
goto_on_local_req=-1; /* disable */
if (goto_on_local_req>=0)
set_child_rpc_sip_mode();
#endif /* WITH_EVENT_LOCAL_REQUEST */
if (goto_on_sl_reply && onreply_rt.rlist[goto_on_sl_reply]==0)
WARN("empty/non existing on_sl_reply route\n");
#ifdef WITH_TM_CTX
tm_ctx_init();
#endif
tm_init = 1;
return 0;
}
static int child_init(int rank)
{
if (rank == PROC_INIT) {
/* we must init stats when rank==PROC_INIT: after mod_init we know
* the exact number of processes and we must init the shared structure
* before any other process is starting (or else some new process
* might try to use the stats before the stats array is allocated) */
if (init_tm_stats_child() < 0) {
ERR("Error while initializing tm statistics structures\n");
return -1;
}
}else if (child_init_callid(rank) < 0) {
/* don't init callid for PROC_INIT*/
LOG(L_ERR, "ERROR: child_init: Error while initializing Call-ID"
" generator\n");
return -2;
}
return 0;
}
/**************************** wrapper functions ***************************/
static int t_check_status(struct sip_msg* msg, char *p1, char *foo)
{
regmatch_t pmatch;
struct cell *t;
char *status, *s = NULL;
char backup;
int lowest_status, n, ret;
fparam_t* fp;
regex_t* re = NULL;
str tmp;
fp = (fparam_t*)p1;
t = 0;
/* first get the transaction */
if (t_check(msg, 0 ) == -1) return -1;
if ((t = get_t()) == 0) {
LOG(L_ERR, "ERROR: t_check_status: cannot check status for a reply "
"which has no T-state established\n");
goto error;
}
backup = 0;
switch(fp->type) {
case FPARAM_REGEX:
re = fp->v.regex;
break;
default:
/* AVP or select, get the value and compile the regex */
if (get_str_fparam(&tmp, msg, fp) < 0) goto error;
s = pkg_malloc(tmp.len + 1);
if (s == NULL) {
ERR("Out of memory\n");
goto error;
}
memcpy(s, tmp.s, tmp.len);
s[tmp.len] = '\0';
if ((re = pkg_malloc(sizeof(regex_t))) == 0) {
ERR("No memory left\n");
goto error;
}
if (regcomp(re, s, REG_EXTENDED|REG_ICASE|REG_NEWLINE)) {
ERR("Bad regular expression '%s'\n", s);
pkg_free(re);
re = NULL;
goto error;
}
break;
}
switch(get_route_type()) {
case REQUEST_ROUTE:
/* use the status of the last sent reply */
status = int2str( t->uas.status, 0);
break;
case TM_ONREPLY_ROUTE:
case CORE_ONREPLY_ROUTE:
/* use the status of the current reply */
status = msg->first_line.u.reply.status.s;
backup = status[msg->first_line.u.reply.status.len];
status[msg->first_line.u.reply.status.len] = 0;
break;
case FAILURE_ROUTE:
/* use the status of the winning reply */
ret = t_pick_branch( -1, 0, t, &lowest_status);
if (ret == -1) {
/* t_pick_branch() retuns error also when there are only
* blind UACs. Let us give it another chance including the
* blind branches. */
LOG(L_DBG, "DEBUG: t_check_status: t_pick_branch returned error, "
"trying t_pick_branch_blind\n");
ret = t_pick_branch_blind(t, &lowest_status);
}
if (ret < 0) {
LOG(L_CRIT,"BUG:t_check_status: t_pick_branch failed to get "
" a final response in FAILURE_ROUTE\n");
goto error;
}
status = int2str( lowest_status , 0);
break;
case BRANCH_FAILURE_ROUTE:
status = int2str(t->uac[get_t_branch()].last_received, 0);
break;
default:
LOG(L_ERR,"ERROR:t_check_status: unsupported route type %d\n",
get_route_type());
goto error;
}
DBG("DEBUG:t_check_status: checked status is <%s>\n",status);
/* do the checking */
n = regexec(re, status, 1, &pmatch, 0);
if (backup) status[msg->first_line.u.reply.status.len] = backup;
if (s) pkg_free(s);
if ((fp->type != FPARAM_REGEX) && re) {
regfree(re);
pkg_free(re);
}
if (unlikely(t && is_route_type(CORE_ONREPLY_ROUTE))){
/* t_check() above has the side effect of setting T and
* REFerencing T => we must unref and unset it. */
UNREF( t );
set_t(T_UNDEFINED, T_BR_UNDEFINED);
}
if (n!=0) return -1;
return 1;
error:
if (unlikely(t && is_route_type(CORE_ONREPLY_ROUTE))){
/* t_check() above has the side effect of setting T and
* REFerencing T => we must unref and unset it. */
UNREF( t );
set_t(T_UNDEFINED, T_BR_UNDEFINED);
}
if (s) pkg_free(s);
if ((fp->type != FPARAM_REGEX) && re) {
regfree(re);
pkg_free(re);
}
return -1;
}
inline static int w_t_check(struct sip_msg* msg, char* str, char* str2)
{
return (t_check_msg( msg , 0 )==1) ? 1 : -1;
}
inline static int w_t_lookup_cancel(struct sip_msg* msg, char* str, char* str2)
{
struct cell *ret;
int i=0;
if (msg->REQ_METHOD==METHOD_CANCEL) {
ret = t_lookupOriginalT( msg );
DBG("lookup_original: t_lookupOriginalT returned: %p\n", ret);
if (ret != T_NULL_CELL) {
/* If the parameter is set to 1, overwrite the message flags of
* the CANCEL with the flags of the INVITE */
if (str && (get_int_fparam(&i, msg, (fparam_t*)str)==0) && i)
msg->flags = ret->uas.request->flags;
/* The cell is reffed by t_lookupOriginalT, but T is not set.