t_funcs.h

Go to the documentation of this file.

/*
 * $Id: t_funcs.h 5101 2008-10-22 08:03:56Z juhe $
 *
 * 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * History:
 * --------
 *  2003-02-18  updated various function prototypes (andrei)
 *  2003-03-10  removed ifdef _OBSO & made redefined all the *UNREF* macros
 *               in a non-gcc specific way (andrei)
 *  2003-03-13  now send_pr_buffer will be called w/ function/line info
 *               only when compiling w/ -DEXTRA_DEBUG (andrei)
 *  2003-03-31  200 for INVITE/UAS resent even for UDP (jiri) 
 *  2007-01-25  DNS failover at transaction level added (bogdan) 
 */

/*! \file
 * \brief TM :: Transaction maintenance functions
 *
 * \ingroup tm
 * - Module: \ref tm
 */


#ifndef _T_FUNCS_H
#define _T_FUNCS_H

#include <errno.h>
#include <netdb.h>

#include "../../mem/shm_mem.h"
#include "../../parser/msg_parser.h"
#include "../../globals.h"
#include "../../udp_server.h"
#include "../../msg_translator.h"
#include "../../timer.h"
#include "../../forward.h"
#include "../../mem/mem.h"
#include "../../md5utils.h"
#include "../../ip_addr.h"
#include "../../parser/parse_uri.h"
#include "../../usr_avp.h"

#include "config.h"
#include "lock.h"
#include "timer.h"
#include "sip_msg.h"
#include "h_table.h"
#include "ut.h"

struct s_table;
struct timer;
struct entry;
struct cell;

extern int noisy_ctimer;


/* t_reply_to flags */
#define TM_T_REPLY_repl_FLAG     (1<<0)
#define TM_T_REPLY_no100_FLAG    (1<<1)
#define TM_T_REPLY_noerr_FLAG    (1<<2)
#define TM_T_REPLY_nodnsfo_FLAG  (1<<3)


/* send a private buffer: utilize a retransmission structure
   but take a separate buffer not referred by it; healthy
   for reducing time spend in REPLIES locks
*/

/* send a buffer -- 'PR' means private, i.e., it is assumed noone
   else can affect the buffer during sending time
*/
#ifdef EXTRA_DEBUG
int send_pr_buffer( struct retr_buf *rb,
   void *buf, int len, char* file, const char *function, int line );
#define SEND_PR_BUFFER(_rb,_bf,_le ) \
   send_pr_buffer( (_rb), (_bf), (_le), __FILE__,  __FUNCTION__, __LINE__ )
#else
int send_pr_buffer( struct retr_buf *rb, void *buf, int len);
#define SEND_PR_BUFFER(_rb,_bf,_le ) \
   send_pr_buffer( (_rb), (_bf), (_le))
#endif

#define SEND_BUFFER( _rb ) \
   SEND_PR_BUFFER( (_rb) , (_rb)->buffer.s , (_rb)->buffer.len )


#define UNREF_UNSAFE(_T_cell) do { \
   ((_T_cell)->ref_count--);\
   LM_DBG("UNREF_UNSAFE: after is %d\n",(_T_cell)->ref_count);\
   }while(0)
#define UNREF(_T_cell) do{ \
   LOCK_HASH( (_T_cell)->hash_index ); \
   UNREF_UNSAFE(_T_cell); \
   UNLOCK_HASH( (_T_cell)->hash_index ); }while(0)
#define REF_UNSAFE(_T_cell) do {\
   ((_T_cell)->ref_count++);\
   LM_DBG("REF_UNSAFE: after is %d\n",(_T_cell)->ref_count);\
   }while(0)
#define INIT_REF_UNSAFE(_T_cell) ((_T_cell)->ref_count=1)
#define IS_REFFED_UNSAFE(_T_cell) ((_T_cell)->ref_count!=0)

/*! \brief
 * Parse and fixup the fr_*_timer AVP specs
 */
int init_avp_params(char *fr_timer_param, char *fr_inv_timer_param,
          char *contacts_avp_param);

/*! \brief
 * FR_INV_TIMER AVP and SERIAL AVP variables needed by next_branches() function
 */
extern int     fr_inv_timer_avp_type;
extern int_str fr_inv_timer_avp;
extern int     contacts_avp_type;
extern int_str contacts_avp;

/*! \brief
 * Get the FR_{INV}_TIMER from corresponding AVP
 */
int fr_avp2timer( utime_t* timer);
int fr_inv_avp2timer( utime_t* timer);


inline static void _set_fr_retr( struct retr_buf *rb, int retr )
{
   utime_t timer;

   if (retr) {
      rb->retr_list=RT_T1_TO_1;
      set_timer( &rb->retr_timer, RT_T1_TO_1, 0 );
   }

   if (!fr_avp2timer(&timer)) {
      LM_DBG("FR_TIMER = %llu\n", timer);
      set_timer(&rb->fr_timer, FR_TIMER_LIST, &timer);
   } else {
      set_timer(&rb->fr_timer, FR_TIMER_LIST, 0);
   }
}


inline static void start_retr(struct retr_buf *rb)
{
   _set_fr_retr(rb, rb->dst.proto==PROTO_UDP);
}


inline static void force_retr(struct retr_buf *rb)
{
   _set_fr_retr(rb, 1);
}


void tm_shutdown(void);


/* function returns:
 *       1 - a new transaction was created
 *      -1 - error, including retransmission
 */
int  t_add_transaction( struct sip_msg* p_msg  );


/* returns 1 if everything was OK or -1 for error */
int t_release_transaction( struct cell *trans );


int get_ip_and_port_from_uri( str* uri , unsigned int *param_ip,
   unsigned int *param_port);


void put_on_wait(  struct cell  *Trans  );


void cleanup_localcancel_timers( struct cell *t );


int t_relay_to( struct sip_msg  *p_msg, struct proxy_l *proxy, int replicate);


#endif