/*
* $Id: t_funcs.c 1739 2007-03-03 19:24:11Z miconda $
*
* transaction maintenance functions
*
* Copyright (C) 2001-2003 FhG Fokus
*
* This file is part of openser, a free SIP server.
*
* openser 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
*
* openser 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* History:
* -------
* 2003-03-31 200 for INVITE/UAS resent even for UDP (jiri)
* info only if compiling w/ -DEXTRA_DEBUG (andrei)
* 2003-03-19 replaced all mallocs/frees w/ pkg_malloc/pkg_free (andrei)
* 2003-03-13 send_pr_buffer is called w/ file/function/line debugging
* 2003-03-01 start_retr changed to retransmit only for UDP
* 2003-02-13 modified send_pr_buffer to use msg_send & rb->dst (andrei)
* 2003-04-14 use protocol from uri (jiri)
* 2003-04-25 do it (^) really everywhere (jiri)
* 2003-04-26 do it (^) really really really everywhere (jiri)
* 2003-07-07 added get_proto calls when proxy!=0 (andrei)
* 2004-02-13 t->is_invite and t->local replaced with flags (bogdan)
* 2005-02-16 fr_*_timer acceps full AVP specifications; empty AVP
* desable variable timer feature (bogdan)
* 2007-01-25 DNS failover at transaction level added (bogdan)
*/
#include <limits.h>
#include <string.h>
#include <stdio.h>
#include <errno.h>
#include <stdlib.h>
#include "../../dprint.h"
#include "../../hash_func.h"
#include "../../dset.h"
#include "../../mem/mem.h"
#include "t_funcs.h"
#include "t_fwd.h"
#include "t_msgbuilder.h"
#include "t_lookup.h"
#include "config.h"
/* fr_timer AVP specs */
static int fr_timer_avp_type;
static int_str fr_timer_avp;
static int fr_inv_timer_avp_type;
static int_str fr_inv_timer_avp;
static str relay_reason_100 = str_init("Giving a try");
/* ----------------------------------------------------- */
int send_pr_buffer( struct retr_buf *rb, void *buf, int len
#ifdef EXTRA_DEBUG
, char* file, const char *function, int line
#endif
)
{
if (buf && len && rb )
return msg_send( rb->dst.send_sock, rb->dst.proto, &rb->dst.to,
rb->dst.proto_reserved1, buf, len);
else {
#ifdef EXTRA_DEBUG
LOG(L_CRIT, "ERROR: send_pr_buffer: sending an empty buffer"
"from %s: %s (%d)\n", file, function, line );
#else
LOG(L_CRIT, "ERROR: send_pr_buffer: attempt to send an "
"empty buffer\n");
#endif
return -1;
}
}
void tm_shutdown()
{
DBG("DEBUG: tm_shutdown : start\n");
unlink_timer_lists();
/* destroy the hash table */
DBG("DEBUG: tm_shutdown : emptying hash table\n");
free_hash_table( );
DBG("DEBUG: tm_shutdown : releasing timers\n");
free_timer_table();
DBG("DEBUG: tm_shutdown : removing semaphores\n");
lock_cleanup();
DBG("DEBUG: tm_shutdown : destroying tmcb lists\n");
destroy_tmcb_lists();
DBG("DEBUG: tm_shutdown : done\n");
}
/* returns 1 if everything was OK or -1 for error
*/
int t_release_transaction( struct cell *trans )
{
set_kr(REQ_RLSD);
reset_timer( & trans->uas.response.fr_timer );
reset_timer( & trans->uas.response.retr_timer );
cleanup_uac_timers( trans );
put_on_wait( trans );
return 1;
}
/* -----------------------HELPER FUNCTIONS----------------------- */
/*
*/
void put_on_wait( struct cell *Trans )
{
#ifdef EXTRA_DEBUG
DBG("DEBUG: put on WAIT \n");
#endif
/* we put the transaction on wait timer; we do it only once
in transaction's timelife because putting it multiple-times
might result in a second instance of a wait timer to be
set after the first one fired; on expiration of the second
instance, the transaction would be re-deleted
PROCESS1 PROCESS2 TIMER PROCESS
0. 200/INVITE rx;
put_on_wait
1. 200/INVITE rx;
2. WAIT fires; transaction
about to be deleted
3. avoid putting
on WAIT again
4. WAIT timer executed,
transaction deleted
*/
set_1timer( &Trans->wait_tl, WT_TIMER_LIST, 0 );
}
static int kill_transaction( struct cell *trans )
{
char err_buffer[128];
int sip_err;
int reply_ret;
int ret;
str reason;
/* we reply statefully and enter WAIT state since error might
have occurred in middle of forking and we do not
want to put the forking burden on upstream client;
however, it may fail too due to lack of memory */
ret=err2reason_phrase( ser_error, &sip_err,
err_buffer, sizeof(err_buffer), "TM" );
if (ret>0) {
reason.s = err_buffer;
reason.len = ret;
reply_ret=t_reply( trans, trans->uas.request, sip_err, &reason);
/* t_release_transaction( T ); */
return reply_ret;
} else {
LOG(L_ERR, "ERROR: kill_transaction: err2reason failed\n");
return -1;
}
}
int t_relay_to( struct sip_msg *p_msg , struct proxy_l *proxy, int flags)
{
int ret;
int new_tran;
str *uri;
int reply_ret;
struct cell *t;
ret=0;
new_tran = t_newtran( p_msg );
/* parsing error, memory alloc, whatever ... if via is bad
and we are forced to reply there, return with 0 (->break),
pass error status otherwise
*/
if (new_tran<0) {
ret = (ser_error==E_BAD_VIA && reply_to_via) ? 0 : new_tran;
goto done;
}
/* if that was a retransmission, break from script */
if (new_tran==0) {
goto done;
}
/* new transaction */
/* ACKs do not establish a transaction and are fwd-ed statelessly */
if ( p_msg->REQ_METHOD==METHOD_ACK) {
DBG("DEBUG:tm:t_relay: forwarding ACK\n");
/* send it out */
if (proxy==0) {
uri = GET_RURI(p_msg);
proxy=uri2proxy(GET_NEXT_HOP(p_msg), PROTO_NONE);
if (proxy==0) {
ret=E_BAD_ADDRESS;
goto done;
}
ret=forward_request( p_msg , proxy);
if (ret>=0) ret=1;
free_proxy( proxy );
pkg_free( proxy );
} else {
ret=forward_request( p_msg , proxy);
if (ret>=0) ret=1;
}
goto done;
}
/* if replication flag is set, mark the transaction as local
so that replies will not be relaied */
t=get_t();
if (flags&TM_T_REPLY_repl_FLAG) t->flags|=T_IS_LOCAL_FLAG;
if (flags&TM_T_REPLY_nodnsfo_FLAG) t->flags|=T_NO_DNS_FAILOVER_FLAG;
/* INVITE processing might take long, particularly because of DNS
look-ups -- let upstream know we're working on it */
if ( p_msg->REQ_METHOD==METHOD_INVITE &&
!(flags&(TM_T_REPLY_no100_FLAG|TM_T_REPLY_repl_FLAG)) )
t_reply( t, p_msg , 100 , &relay_reason_100);
/* now go ahead and forward ... */
ret=t_forward_nonack( t, p_msg, proxy);
if (ret<=0) {
DBG( "ERROR:tm:t_relay_to: t_forward_nonack returned error \n");
/* we don't want to pass upstream any reply regarding replicating
* a request; replicated branch must stop at us*/
if (!(flags&(TM_T_REPLY_repl_FLAG|TM_T_REPLY_noerr_FLAG))) {
reply_ret = kill_transaction( t );
if (reply_ret>0) {
/* we have taken care of all -- do nothing in
script */
DBG("ERROR: generation of a stateful reply "
"on error succeeded\n");
ret=0;
} else {
DBG("ERROR: generation of a stateful reply "
"on error failed\n");
}
}
} else {
DBG( "DEBUG:tm:t_relay_to: new transaction fwd'ed\n");
}
done:
return ret;
}
/*
* Initialize parameters containing the ID of
* AVPs with variable timers
*/
int init_avp_params(char *fr_timer_param, char *fr_inv_timer_param)
{
xl_spec_t avp_spec;
unsigned short avp_flags;
if (fr_timer_param && *fr_timer_param) {
if (xl_parse_spec(fr_timer_param, &avp_spec,
XL_THROW_ERROR|XL_DISABLE_MULTI|XL_DISABLE_COLORS)==0
|| avp_spec.type!=XL_AVP) {
LOG(L_ERR, "ERROR:tm:init_avp_params: malformed or non AVP %s "
"AVP definition\n", fr_timer_param);
return -1;
}
if(xl_get_avp_name(0, &avp_spec, &fr_timer_avp, &avp_flags)!=0)
{
LOG(L_ERR, "ERROR:tm:init_avp_params: [%s]- invalid "
"AVP definition\n", fr_timer_param);
return -1;
}
fr_timer_avp_type = avp_flags;
} else {
fr_timer_avp.n = 0;
fr_timer_avp_type = 0;
}
if (fr_inv_timer_param && *fr_inv_timer_param) {
if (xl_parse_spec(fr_inv_timer_param, &avp_spec,
XL_THROW_ERROR|XL_DISABLE_MULTI|XL_DISABLE_COLORS)==0
|| avp_spec.type!=XL_AVP) {
LOG(L_ERR, "ERROR:tm:init_avp_params: malformed or non AVP %s "
"AVP definition\n", fr_inv_timer_param);
return -1;
}
if(xl_get_avp_name(0, &avp_spec, &fr_inv_timer_avp, &avp_flags)!=0)
{
LOG(L_ERR, "ERROR:tm:init_avp_params: [%s]- invalid "
"AVP definition\n", fr_inv_timer_param);
return -1;
}
fr_inv_timer_avp_type = avp_flags;
} else {
fr_inv_timer_avp.n = 0;
fr_inv_timer_avp_type = 0;
}
return 0;
}
/*
* Get the FR_{INV}_TIMER from corresponding AVP
*/
static inline int avp2timer(utime_t *timer, int type, int_str name)
{
struct usr_avp *avp;
int_str val_istr;
int err;
avp = search_first_avp( type, name, &val_istr, 0);
if (!avp)
return 1;
if (avp->flags & AVP_VAL_STR) {
*timer = str2s(val_istr.s.s, val_istr.s.len, &err);
if (err) {
LOG(L_ERR,"avp2timer: Error while converting string to integer\n");
return -1;
}
} else {
*timer = val_istr.n;
}
return 0;
}
int fr_avp2timer(utime_t* timer)
{
if (fr_timer_avp.n!=0)
return avp2timer( timer, fr_timer_avp_type, fr_timer_avp);
else
return 1;
}
int fr_inv_avp2timer(utime_t* timer)
{
if (fr_inv_timer_avp.n!=0)
return avp2timer( timer, fr_inv_timer_avp_type, fr_inv_timer_avp);
else
return 1;
}
syntax highlighted by Code2HTML, v. 0.9.1