afd9aff916e0b4677cc6d283032132f641fb3336
[sip-router] / modules / tm / t_funcs.c
1 /*
2  * $Id$
3  *
4  * transaction maintenance functions
5  *
6  * Copyright (C) 2001-2003 FhG Fokus
7  *
8  * This file is part of ser, a free SIP server.
9  *
10  * ser is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version
14  *
15  * For a license to use the ser software under conditions
16  * other than those described here, or to purchase support for this
17  * software, please contact iptel.org by e-mail at the following addresses:
18  *    info@iptel.org
19  *
20  * ser is distributed in the hope that it will be useful,
21  * but WITHOUT ANY WARRANTY; without even the implied warranty of
22  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
23  * GNU General Public License for more details.
24  *
25  * You should have received a copy of the GNU General Public License 
26  * along with this program; if not, write to the Free Software 
27  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
28  */
29 /*
30  * History:
31  * -------
32  *  2003-03-31  200 for INVITE/UAS resent even for UDP (jiri)
33  *               info only if compiling w/ -DEXTRA_DEBUG (andrei)
34  *  2003-03-19  replaced all mallocs/frees w/ pkg_malloc/pkg_free (andrei)
35  *  2003-03-13  send_pr_buffer is called w/ file/function/line debugging
36  *  2003-03-01  start_retr changed to retransmit only for UDP
37  *  2003-02-13  modified send_pr_buffer to use msg_send & rb->dst (andrei)
38  *  2003-04-14  use protocol from uri (jiri)
39  *  2003-04-25  do it (^) really everywhere (jiri)
40  *  2003-04-26  do it (^) really really really everywhere (jiri)
41  *  2003-07-07  added get_proto calls when proxy!=0 (andrei)
42  *  2004-02-13  t->is_invite and t->local replaced with flags (bogdan)
43  *  2005-02-16  fr_*_timer acceps full AVP specifications; empty AVP
44  *              desable variable timer feature (bogdan)
45  *  2005-12-11  t_relay doesn't return 0 (stop script) on send error 
46  *              anymore (andrei)
47  *  2006-08-11  updated forward_request usage (andrei)
48  *              t_relay_to releases the transaction if t_forward_non_ack
49  *              fails and t_kill fails or this is a failed replication (andrei)
50  *  2007-05-02  t_relay_to() uses now t_forward_cancel for cancels (andrei)
51  */
52
53 #include <limits.h>
54 #include <string.h>
55 #include <stdio.h>
56 #include <errno.h>
57 #include <stdlib.h>
58
59 #include "../../dprint.h"
60 #include "../../hash_func.h"
61 #include "../../dset.h"
62 #include "../../mem/mem.h"
63 #include "defs.h"
64 #include "t_funcs.h"
65 #include "t_fwd.h"
66 #include "t_lookup.h"
67 #include "config.h"
68 #include "t_stats.h"
69
70 /* fr_timer AVP specs */
71 static int     fr_timer_avp_type = 0;
72 static int_str fr_timer_avp = {0};
73 static str     fr_timer_str;
74 static int     fr_timer_index = 0;
75 static int     fr_inv_timer_avp_type = 0;
76 static int_str fr_inv_timer_avp = {0};
77 static str     fr_inv_timer_str;
78 static int     fr_inv_timer_index = 0;
79
80
81 /* ----------------------------------------------------- */
82 int send_pr_buffer(     struct retr_buf *rb, void *buf, int len
83 #ifdef EXTRA_DEBUG
84                                                 , char* file, const char *function, int line
85 #endif
86                                         )
87 {
88         if (buf && len && rb )
89                 return msg_send( &rb->dst, buf, len);
90         else {
91 #ifdef EXTRA_DEBUG
92                 LOG(L_CRIT, "ERROR: send_pr_buffer: sending an empty buffer"
93                                 "from %s: %s (%d)\n", file, function, line );
94 #else
95                 LOG(L_CRIT, "ERROR: send_pr_buffer: attempt to send an "
96                                 "empty buffer\n");
97 #endif
98                 return -1;
99         }
100 }
101
102 void tm_shutdown()
103 {
104
105         DBG("DEBUG: tm_shutdown : start\n");
106
107         /* destroy the hash table */
108         DBG("DEBUG: tm_shutdown : emptying hash table\n");
109         free_hash_table( );
110         DBG("DEBUG: tm_shutdown : removing semaphores\n");
111         lock_cleanup();
112         DBG("DEBUG: tm_shutdown : destroying tmcb lists\n");
113         destroy_tmcb_lists();
114         free_tm_stats();
115         DBG("DEBUG: tm_shutdown : done\n");
116 }
117
118
119 /*   returns 1 if everything was OK or -1 for error
120 */
121 int t_release_transaction( struct cell *trans )
122 {
123         set_kr(REQ_RLSD);
124
125         stop_rb_timers(&trans->uas.response);
126         cleanup_uac_timers( trans );
127         
128         put_on_wait( trans );
129         return 1;
130 }
131
132
133 /* -----------------------HELPER FUNCTIONS----------------------- */
134
135
136 /*
137   */
138 void put_on_wait(  struct cell  *Trans  )
139 {
140
141 #ifdef EXTRA_DEBUG
142         DBG("DEBUG: put on WAIT \n");
143 #endif
144
145
146         /* we put the transaction on wait timer; we do it only once
147            in transaction's timelife because putting it multiple-times
148            might result in a second instance of a wait timer to be
149            set after the first one fired; on expiration of the second
150            instance, the transaction would be re-deleted
151
152                         PROCESS1                PROCESS2                TIMER PROCESS
153                 0. 200/INVITE rx;
154                    put_on_wait
155                 1.                                      200/INVITE rx;
156                 2.                                                                      WAIT fires; transaction
157                                                                                         about to be deleted
158                 3.                                      avoid putting
159                                                         on WAIT again
160                 4.                                                                      WAIT timer executed,
161                                                                                         transaction deleted
162         */
163         if (timer_add(&Trans->wait_timer, wait_timeout)==0){
164                 /* sucess */
165                 t_stats_wait();
166         }else{
167                 DBG("tm: put_on_wait: transaction %p already on wait\n", Trans);
168         }
169 }
170
171
172
173 /* WARNING: doesn't work from failure route (deadlock, uses t_reply =>
174  *  tries to get the reply lock again) */
175 static int kill_transaction( struct cell *trans )
176 {
177         char err_buffer[128];
178         int sip_err;
179         int reply_ret;
180         int ret;
181
182         /*  we reply statefully and enter WAIT state since error might
183                 have occurred in middle of forking and we do not
184                 want to put the forking burden on upstream client;
185                 however, it may fail too due to lack of memory */
186
187         ret=err2reason_phrase( ser_error, &sip_err,
188                 err_buffer, sizeof(err_buffer), "TM" );
189         if (ret>0) {
190                 reply_ret=t_reply( trans, trans->uas.request, 
191                         sip_err, err_buffer);
192                 /* t_release_transaction( T ); */
193                 return reply_ret;
194         } else {
195                 LOG(L_ERR, "ERROR: kill_transaction: err2reason failed\n");
196                 return -1;
197         }
198 }
199
200
201
202 /* WARNING: doesn't work from failure route (deadlock, uses t_reply => tries
203  *  to get the reply lock again */
204 int t_relay_to( struct sip_msg  *p_msg , struct proxy_l *proxy, int proto,
205                                 int replicate)
206 {
207         int ret;
208         int new_tran;
209         int reply_ret;
210         /* struct hdr_field *hdr; */
211         struct cell *t;
212         struct dest_info dst;
213         unsigned short port;
214         str host;
215         short comp;
216
217         ret=0;
218         
219         /* special case for CANCEL */
220         if ( p_msg->REQ_METHOD==METHOD_CANCEL){
221                 ret=t_forward_cancel(p_msg, proxy, proto, &t);
222                 if (t) goto handle_ret;
223                 goto done;
224         }
225         new_tran = t_newtran( p_msg );
226         
227         /* parsing error, memory alloc, whatever ... if via is bad
228            and we are forced to reply there, return with 0 (->break),
229            pass error status otherwise
230
231        MMA: return value E_SCRIPT means that transaction was already started from the script
232            so continue with that transaction
233         */
234         if (new_tran!=E_SCRIPT) {
235                 if (new_tran<0) {
236                         ret = (ser_error==E_BAD_VIA && reply_to_via) ? 0 : new_tran;
237                         goto done;
238                 }
239                 /* if that was a retransmission, return we are happily done */
240                 if (new_tran==0) {
241                         ret = 1;
242                         goto done;
243                 }
244         }
245
246         /* new transaction */
247
248         /* ACKs do not establish a transaction and are fwd-ed statelessly */
249         if ( p_msg->REQ_METHOD==METHOD_ACK) {
250                 DBG( "SER: forwarding ACK  statelessly \n");
251                 if (proxy==0) {
252                         init_dest_info(&dst);
253                         dst.proto=proto;
254                         if (get_uri_send_info(GET_NEXT_HOP(p_msg), &host, &port,
255                                                                         &dst.proto, &comp)!=0){
256                                 ret=E_BAD_ADDRESS;
257                                 goto done;
258                         }
259 #ifdef USE_COMP
260                         dst.comp=comp;
261 #endif
262                         /* dst->send_sock not set, but forward_request will take care
263                          * of it */
264                         ret=forward_request(p_msg, &host, port, &dst);
265                 } else {
266                         init_dest_info(&dst);
267                         dst.proto=get_proto(proto, proxy->proto);
268                         proxy2su(&dst.to, proxy);
269                         /* dst->send_sock not set, but forward_request will take care
270                          * of it */
271                         ret=forward_request( p_msg , 0, 0, &dst) ;
272                 }
273                 goto done;
274         }
275
276         /* if replication flag is set, mark the transaction as local
277            so that replies will not be relayed */
278         t=get_t();
279         if (replicate) t->flags|=T_IS_LOCAL_FLAG;
280
281         /* INVITE processing might take long, particularly because of DNS
282            look-ups -- let upstream know we're working on it */
283         if (p_msg->REQ_METHOD==METHOD_INVITE )
284         {
285                 DBG( "SER: new INVITE\n");
286                 if (!t_reply( t, p_msg , 100 ,
287                         "trying -- your call is important to us"))
288                                 DBG("SER: ERROR: t_reply (100)\n");
289         } 
290
291         /* now go ahead and forward ... */
292         ret=t_forward_nonack(t, p_msg, proxy, proto);
293 handle_ret:
294         if (ret<=0) {
295                 DBG( "ERROR:tm:t_relay_to:  t_forward_nonack returned error \n");
296                 /* we don't want to pass upstream any reply regarding replicating
297                  * a request; replicated branch must stop at us*/
298                 if (!replicate) {
299                         reply_ret=kill_transaction( t );
300                         if (reply_ret>0) {
301                                 /* we have taken care of all -- do nothing in
302                                 script */
303                                 DBG("ERROR: generation of a stateful reply "
304                                         "on error succeeded\n");
305                                 /*ret=0; -- we don't want to stop the script */
306                         }  else {
307                                 DBG("ERROR: generation of a stateful reply "
308                                         "on error failed\n");
309                                 t_release_transaction(t);
310                         }
311                 }else{
312                         t_release_transaction(t); /* kill it  silently */
313                 }
314         } else {
315                 DBG( "SER: new transaction fwd'ed\n");
316         }
317
318 done:
319         return ret;
320 }
321
322
323
324 /*
325  * Initialize parameters containing the ID of
326  * AVPs with variable timers
327  */
328 int init_avp_params(char *fr_timer_param, char *fr_inv_timer_param)
329 {
330         if (fr_timer_param && *fr_timer_param) {
331                 fr_timer_str.s = fr_timer_param;
332                 fr_timer_str.len = strlen(fr_timer_str.s);
333                 if (parse_avp_spec( &fr_timer_str, &fr_timer_avp_type,
334                 &fr_timer_avp, &fr_timer_index)<0) {
335                         LOG(L_CRIT,"ERROR:tm:init_avp_params: invalid fr_timer "
336                                 "AVP specs \"%s\"\n", fr_timer_param);
337                         return -1;
338                 }
339         }
340
341         if (fr_inv_timer_param && *fr_inv_timer_param) {
342                 fr_inv_timer_str.s = fr_inv_timer_param;
343                 fr_inv_timer_str.len = strlen(fr_inv_timer_str.s);
344                 if (parse_avp_spec( &fr_inv_timer_str, &fr_inv_timer_avp_type, 
345                 &fr_inv_timer_avp, &fr_inv_timer_index)<0) {
346                         LOG(L_CRIT,"ERROR:tm:init_avp_params: invalid fr_inv_timer "
347                                 "AVP specs \"%s\"\n", fr_inv_timer_param);
348                         return -1;
349                 }
350         }
351         return 0;
352 }
353
354
355 /*
356  * Get the FR_{INV}_TIMER from corresponding AVP
357  */
358 static inline int avp2timer(unsigned int* timer, int type, int_str name)
359 {
360         struct usr_avp *avp;
361         int_str val_istr;
362         int err;
363
364         avp = search_first_avp( type | AVP_TRACK_TO, name, &val_istr, 0);
365         if (!avp) {
366                 /*
367                  DBG("avp2timer: AVP '%.*s' not found\n", param.s->len, ZSW(param.s->s));
368                  */
369                 return 1;
370         }
371         
372         if (avp->flags & AVP_VAL_STR) {
373                 *timer = str2s(val_istr.s.s, val_istr.s.len, &err);
374                 if (err) {
375                         LOG(L_ERR, "avp2timer: Error while converting string to integer\n");
376                         return -1;
377                 }
378         } else {
379                 *timer = val_istr.n;
380         }
381
382         return 0;
383 }
384
385
386 int fr_avp2timer(unsigned int* timer)
387 {
388         if (fr_timer_avp.n!=0)
389                 return avp2timer( timer, fr_timer_avp_type, fr_timer_avp);
390         else
391                 return 1;
392 }
393
394
395 int fr_inv_avp2timer(unsigned int* timer)
396 {
397         if (fr_inv_timer_avp.n!=0)
398                 return avp2timer( timer, fr_inv_timer_avp_type, fr_inv_timer_avp);
399         else
400                 return 1;
401 }
402
403