/*
* $Id$
*
*
* Copyright (C) 2001-2003 Fhg Fokus
*
* This file is part of ser, a free SIP server.
*
* ser 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
*
* For a license to use the ser software under conditions
* other than those described here, or to purchase support for this
* software, please contact iptel.org by e-mail at the following addresses:
* info@iptel.org
*
* ser 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-01-19 faked lump list created in on_reply handlers
* 2003-01-27 next baby-step to removing ZT - PRESERVE_ZT (jiri)
* 2003-02-13 updated to use rb->dst (andrei)
* 2003-02-18 replaced TOTAG_LEN w/ TOTAG_VALUE_LEN (TOTAG_LEN was defined
* twice with different values!) (andrei)
* 2003-02-28 scratchpad compatibility abandoned (jiri)
* 2003-03-01 kr set through a function now (jiri)
* 2003-03-06 saving of to-tags for ACK/200 matching introduced,
* voicemail changes accepted, udpated to new callback
* names (jiri)
* 2003-03-10 fixed new to tag bug/typo (if w/o {}) (andrei)
* 2003-03-16 removed _TOTAG (jiri)
* 2003-03-31 200 for INVITE/UAS resent even for UDP (jiri)
* 2003-03-31 removed msg->repl_add_rm (andrei)
* 2003-04-05 s/reply_route/failure_route, onreply_route introduced (jiri)
* 2003-04-14 local acks generated before reply processing to avoid
* delays in length reply processing (like opening TCP
* connection to an unavailable destination) (jiri)
*/
#include <assert.h>
#include "defs.h"
#include "../../comp_defs.h"
#include "../../hash_func.h"
#include "t_funcs.h"
#include "h_table.h"
#include "../../dprint.h"
#include "../../config.h"
#include "../../parser/parser_f.h"
#include "../../ut.h"
#include "../../timer.h"
#include "../../error.h"
#include "../../action.h"
#include "../../dset.h"
#include "../../tags.h"
#include "../../data_lump.h"
#include "t_hooks.h"
#include "t_funcs.h"
#include "t_reply.h"
#include "t_cancel.h"
#include "t_msgbuilder.h"
#include "t_lookup.h"
#include "t_fwd.h"
#include "fix_lumps.h"
#include "t_stats.h"
/* are we processing original or shmemed request ? */
enum route_mode rmode=MODE_REQUEST;
/* private place where we create to-tags for replies */
/* janakj: made public, I need to access this value to store it in dialogs */
char tm_tags[TOTAG_VALUE_LEN];
char *tm_tag_suffix;
/* where to go if there is no positive reply */
static int goto_on_negative=0;
/* where to go on receipt of reply */
static int goto_on_reply=0;
/* we store the reply_route # in private memory which is
then processed during t_relay; we cannot set this value
before t_relay creates transaction context or after
t_relay when a reply may arrive after we set this
value; that's why we do it how we do it, i.e.,
*inside* t_relay using hints stored in private memory
before t_reay is called
*/
void t_on_negative( unsigned int go_to )
{
goto_on_negative=go_to;
}
void t_on_reply( unsigned int go_to )
{
goto_on_reply=go_to;
}
unsigned int get_on_negative()
{
return goto_on_negative;
}
unsigned int get_on_reply()
{
return goto_on_reply;
}
void tm_init_tags()
{
init_tags(tm_tags, &tm_tag_suffix,
"SER-TM/tags", TM_TAG_SEPARATOR );
}
/* returns 0 if the message was previously acknowledged
* (i.e., no E2EACK callback is needed) and one if the
* callback shall be executed */
int unmatched_totag(struct cell *t, struct sip_msg *ack)
{
struct totag_elem *i;
str *tag;
if (parse_headers(ack, HDR_TO,0)==-1 ||
!ack->to ) {
LOG(L_ERR, "ERROR: ack_totag_set: To invalid\n");
return 1;
}
tag=&get_to(ack)->tag_value;
for (i=t->fwded_totags; i; i=i->next) {
if (i->tag.len==tag->len
&& memcmp(i->tag.s, tag->s, tag->len)==0) {
DBG("DEBUG: totag for e2e ACK found: %d\n", i->acked);
/* to-tag recorded, and an ACK has been received for it */
if (i->acked) return 0;
/* to-tag recorded, but this ACK came for the first time */
i->acked=1;
return 1;
}
}
/* surprising: to-tag never sighted before */
return 1;
}
static inline void update_local_tags(struct cell *trans,
struct bookmark *bm, char *dst_buffer,
char *src_buffer /* to which bm refers */)
{
if (bm->to_tag_val.s) {
trans->uas.local_totag.s=bm->to_tag_val.s-src_buffer+dst_buffer;
trans->uas.local_totag.len=bm->to_tag_val.len;
}
}
/* append a newly received tag from a 200/INVITE to
* transaction's set; (only safe if called from within
* a REPLY_LOCK); it returns 1 if such a to tag already
* exists
*/
inline static int update_totag_set(struct cell *t, struct sip_msg *ok)
{
struct totag_elem *i, *n;
str *tag;
char *s;
if (!ok->to || !ok->to->parsed) {
LOG(L_ERR, "ERROR: update_totag_set: to not parsed\n");
return 0;
}
tag=&get_to(ok)->tag_value;
if (!tag->s) {
LOG(L_ERR, "ERROR: update_totag_set: no tag in to\n");
return 0;
}
for (i=t->fwded_totags; i; i=i->next) {
if (i->tag.len==tag->len
&& memcmp(i->tag.s, tag->s, tag->len) ==0 ){
/* to tag already recorded */
#ifdef XL_DEBUG
LOG(L_CRIT, "DEBUG: update_totag_set: totag retranmission\n");
#else
DBG("DEBUG: update_totag_set: totag retranmission\n");
#endif
return 1;
}
}
/* that's a new to-tag -- record it */
shm_lock();
n=(struct totag_elem*) shm_malloc_unsafe(sizeof(struct totag_elem));
s=(char *)shm_malloc_unsafe(tag->len);
shm_unlock();
if (!s || !n) {
LOG(L_ERR, "ERROR: update_totag_set: no memory \n");
if (n) shm_free(n);
if (s) shm_free(s);
return 0;
}
memset(n, 0, sizeof(struct totag_elem));
memcpy(s, tag->s, tag->len );
n->tag.s=s;n->tag.len=tag->len;
n->next=t->fwded_totags;
t->fwded_totags=n;
DBG("DEBUG: update_totag_set: new totag \n");
return 0;
}
static char *build_ack(struct sip_msg* rpl,struct cell *trans,int branch,
unsigned int *ret_len)
{
str to;
if ( parse_headers(rpl,HDR_TO, 0)==-1 || !rpl->to )
{
LOG(L_ERR, "ERROR: t_build_ACK: "
"cannot generate a HBH ACK if key HFs in reply missing\n");
return NULL;
}
to.s=rpl->to->name.s;
to.len=rpl->to->len;
return build_local( trans, branch, ret_len,
ACK, ACK_LEN, &to );
}
static int _reply_light( struct cell *trans, char* buf, unsigned int len,
unsigned int code, char * text,
char *to_tag, unsigned int to_tag_len, int lock,
struct bookmark *bm )
{
struct retr_buf *rb;
unsigned int buf_len;
branch_bm_t cancel_bitmap;
if (!buf)
{
DBG("DEBUG: t_reply: response building failed\n");
/* determine if there are some branches to be cancelled */
if (trans->is_invite) {
if (lock) LOCK_REPLIES( trans );
which_cancel(trans, &cancel_bitmap );
if (lock) UNLOCK_REPLIES( trans );
}
/* and clean-up, including cancellations, if needed */
goto error;
}
cancel_bitmap=0;
if (lock) LOCK_REPLIES( trans );
if (trans->is_invite) which_cancel(trans, &cancel_bitmap );
if (trans->uas.status>=200) {
LOG( L_ERR, "ERROR: t_reply: can't generate %d reply"
" when a final %d was sent out\n", code, trans->uas.status);
goto error2;
}
rb = & trans->uas.response;
rb->activ_type=code;
trans->uas.status = code;
buf_len = rb->buffer ? len : len + REPLY_OVERBUFFER_LEN;
rb->buffer = (char*)shm_resize( rb->buffer, buf_len );
/* puts the reply's buffer to uas.response */
if (! rb->buffer ) {
LOG(L_ERR, "ERROR: t_reply: cannot allocate shmem buffer\n");
goto error3;
}
update_local_tags(trans, bm, rb->buffer, buf);
rb->buffer_len = len ;
memcpy( rb->buffer , buf , len );
/* needs to be protected too because what timers are set depends
on current transactions status */
/* t_update_timers_after_sending_reply( rb ); */
update_reply_stats( code );
trans->relaied_reply_branch=-2;
tm_stats->replied_localy++;
if (lock) UNLOCK_REPLIES( trans );
/* do UAC cleanup procedures in case we generated
a final answer whereas there are pending UACs */
if (code>=200) {
if (trans->local) {
DBG("DEBUG: local transaction completed from _reply\n");
callback_event( TMCB_LOCAL_COMPLETED, trans, FAKED_REPLY, code );
if (trans->completion_cb)
trans->completion_cb( trans, FAKED_REPLY, code, 0 /* empty param */);
} else {
callback_event( TMCB_RESPONSE_OUT, trans, FAKED_REPLY, code );
}
cleanup_uac_timers( trans );
if (trans->is_invite) cancel_uacs( trans, cancel_bitmap );
set_final_timer( trans );
}
/* send it out */
/* first check if we managed to resolve topmost Via -- if
not yet, don't try to retransmit
*/
if (!trans->uas.response.dst.send_sock) {
LOG(L_ERR, "ERROR: _reply: no resolved dst to send reply to\n");
} else {
SEND_PR_BUFFER( rb, buf, len );
DBG("DEBUG: reply sent out. buf=%p: %.9s..., shmem=%p: %.9s\n",
buf, buf, rb->buffer, rb->buffer );
}
pkg_free( buf ) ;
DBG("DEBUG: t_reply: finished\n");
return 1;
error3:
error2:
if (lock) UNLOCK_REPLIES( trans );
pkg_free ( buf );
error:
/* do UAC cleanup */
cleanup_uac_timers( trans );
if (trans->is_invite) cancel_uacs( trans, cancel_bitmap );
/* we did not succeed -- put the transaction on wait */
put_on_wait(trans);
return -1;
}
/* send a UAS reply
* returns 1 if everything was OK or -1 for error
*/
static int _reply( struct cell *trans, struct sip_msg* p_msg,
unsigned int code, char * text, int lock )
{
unsigned int len;
char * buf;
struct bookmark bm;
if (code>=200) set_kr(REQ_RPLD);
/* compute the buffer in private memory prior to entering lock;
* create to-tag if needed */
if (code>=180 && p_msg->to
&& (get_to(p_msg)->tag_value.s==0
|| get_to(p_msg)->tag_value.len==0)) {
calc_crc_suffix( p_msg, tm_tag_suffix );
buf = build_res_buf_from_sip_req(code,text,
tm_tags, TOTAG_VALUE_LEN,
p_msg,&len, &bm);
return _reply_light(trans,buf,len,code,text,
tm_tags, TOTAG_VALUE_LEN,
lock, &bm);
} else {
buf = build_res_buf_from_sip_req(code,text, 0,0, /* no to-tag */
p_msg,&len, &bm);
return _reply_light(trans,buf,len,code,text,
0,0, /* no to-tag */
lock, &bm);
}
}
/* create a temporary faked message environment in which a conserved
* t->uas.request in shmem is partially duplicated to pkgmem
* to allow pkg-based actions to use it;
*
* if restore parameter is set, the environment is restored to the
* original setting and return value is unsignificant (always 0);
* otherwise a faked environment if created; if that fails,
* false is returned
*/
static int faked_env(struct sip_msg *fake,
struct cell *_t,
struct sip_msg *shmem_msg,
int _restore )
{
static enum route_mode backup_mode;
static struct cell *backup_t;
static unsigned int backup_msgid;
if (_restore) goto restore;
/*
on_negative_reply faked msg now copied from shmem msg (as opposed
to zero-ing) -- more "read-only" actions (exec in particular) will
work from reply_route as they will see msg->from, etc.; caution,
rw actions may append some pkg stuff to msg, which will possibly be
never released (shmem is released in a single block)
*/
memcpy( fake, shmem_msg, sizeof(struct sip_msg));
/* if we set msg_id to something different from current's message
id, the first t_fork will properly clean new branch URIs
*/
fake->id=shmem_msg->id-1;
/* set items, which will be duped to pkg_mem, to zero, so that
* "restore" called on error does not free the original items */
fake->add_rm=0;
fake->new_uri.s=0; fake->new_uri.len=0;
/* remember we are back in request processing, but process
* a shmem-ed replica of the request; advertise it in rmode;
* for example t_reply needs to know that
*/
backup_mode=rmode;
rmode=MODE_ONFAILURE;
/* also, tm actions look in beginning whether tranaction is
* set -- whether we are called from a reply-processing
* or a timer process, we need to set current transaction;
* otherwise the actions would attempt to look the transaction
* up (unnecessary overhead, refcounting)
*/
/* backup */
backup_t=get_t();
backup_msgid=global_msg_id;
/* fake transaction and message id */
global_msg_id=fake->id;
set_t(_t);
/* environment is set up now, try to fake the message */
/* new_uri can change -- make a private copy */
if (shmem_msg->new_uri.s!=0 && shmem_msg->new_uri.len!=0) {
fake->new_uri.s=pkg_malloc(shmem_msg->new_uri.len+1);
if (!fake->new_uri.s) {
LOG(L_ERR, "ERROR: faked_env: no uri/pkg mem\n");
goto restore;
}
fake->new_uri.len=shmem_msg->new_uri.len;
memcpy( fake->new_uri.s, shmem_msg->new_uri.s,
fake->new_uri.len);
fake->new_uri.s[fake->new_uri.len]=0;
}
/* create a duplicated lump list to which actions can add
* new pkg items
*/
if (shmem_msg->add_rm) {
fake->add_rm=dup_lump_list(shmem_msg->add_rm);
if (!fake->add_rm) { /* non_emty->empty ... failure */
LOG(L_ERR, "ERROR: on_negative_reply: lump dup failed\n");
goto restore;
}
}
/* success */
return 1;
restore:
/* restore original environment and destroy faked message */
free_duped_lump_list(fake->add_rm);
if (fake->new_uri.s) pkg_free(fake->new_uri.s);
set_t(backup_t);
global_msg_id=backup_msgid;
rmode=backup_mode;
return 0;
}
/* return 1 if a failure_route processes */
int failure_route(struct cell *t)
{
struct sip_msg faked_msg;
/* don't do anything if we don't have to */
if (!t->on_negative) return 0;
/* if fake message creation failes, return error too */
if (!faked_env(&faked_msg, t, t->uas.request, 0 /* create fake */ )) {
LOG(L_ERR, "ERROR: on_negative_reply: faked_env failed\n");
return 0;
}
/* avoid recursion -- if failure_route forwards, and does not
* set next failure route, failure_route will not be rentered
* on failure */
t_on_negative(0);
/* run a reply_route action if some was marked */
if (run_actions(failure_rlist[t->on_negative], &faked_msg)<0)
LOG(L_ERR, "ERROR: on_negative_reply: "
"Error in do_action\n");
/* restore original environment */
faked_env(&faked_msg, 0, 0, 1 );
return 1;
}
/* select a branch for forwarding; returns:
* 0..X ... branch number
* -1 ... error
* -2 ... can't decide yet -- incomplete branches present
*/
static int pick_branch( int inc_branch, int inc_code,
struct cell *t, int *res_code)
{
int lowest_b, lowest_s, b;
lowest_b=-1; lowest_s=999;
for ( b=0; b<t->nr_of_outgoings ; b++ ) {
/* "fake" for the currently processed branch */
if (b==inc_branch) {
if (inc_code<lowest_s) {
lowest_b=b;
lowest_s=inc_code;
}
continue;
}
/* skip 'empty branches' */
if (!t->uac[b].request.buffer) continue;
/* there is still an unfinished UAC transaction; wait now! */
if ( t->uac[b].last_received<200 )
return -2;
if ( t->uac[b].last_received<lowest_s ) {
lowest_b =b;
lowest_s = t->uac[b].last_received;
}
} /* find lowest branch */
*res_code=lowest_s;
return lowest_b;
}
/* This is the neuralgical point of reply processing -- called
* from within a REPLY_LOCK, t_should_relay_response decides
* how a reply shall be processed and how transaction state is
* affected.
*
* Checks if the new reply (with new_code status) should be sent or not
* based on the current
* transactin status.
* Returns - branch number (0,1,...) which should be relayed
* -1 if nothing to be relayed
*/
static enum rps t_should_relay_response( struct cell *Trans , int new_code,
int branch , int *should_store, int *should_relay,
branch_bm_t *cancel_bitmap, struct sip_msg *reply )
{
int branch_cnt;
int picked_branch;
int picked_code;
int inv_through;
/* note: this code never lets replies to CANCEL go through;
we generate always a local 200 for CANCEL; 200s are
not relayed because it's not an INVITE transaction;
>= 300 are not relayed because 200 was already sent
out
*/
DBG("->>>>>>>>> T_code=%d, new_code=%d\n",Trans->uas.status,new_code);
inv_through=new_code>=200 && new_code<300 && Trans->is_invite;
/* if final response sent out, allow only INVITE 2xx */
if ( Trans->uas.status >= 200 ) {
if (inv_through) {
DBG("DBG: t_should_relay: 200 INV after final sent\n");
*should_store=0;
Trans->uac[branch].last_received=new_code;
*should_relay=branch;
return RPS_PUSHED_AFTER_COMPLETION;
}
/* except the exception above, too late messages will
be discarded */
goto discard;
}
/* if final response received at this branch, allow only INVITE 2xx */
if (Trans->uac[branch].last_received>=200
&& !(inv_through && Trans->uac[branch].last_received<300)) {
LOG(L_ERR, "ERROR: t_should_relay: status rewrite by UAS: "
"stored: %d, received: %d\n",
Trans->uac[branch].last_received, new_code );
goto discard;
}
/* no final response sent yet */
/* negative replies subject to fork picking */
if (new_code >=300 ) {
Trans->uac[branch].last_received=new_code;
/* if all_final return lowest */
picked_branch=pick_branch(branch,new_code, Trans, &picked_code);
if (picked_branch==-2) { /* branches open yet */
*should_store=1;
*should_relay=-1;
return RPS_STORE;
}
if (picked_branch==-1) {
LOG(L_CRIT, "ERROR: t_should_relay_response: lowest==-1\n");
goto error;
}
/* no more pending branches -- try if that changes after
a callback; save banch count to be able to determine
later if new branches were initiated
*/
branch_cnt=Trans->nr_of_outgoings;
callback_event( TMCB_ON_FAILURE, Trans,
picked_branch==branch?reply:Trans->uac[picked_branch].reply,
picked_code);
/* here, we create a faked environment, from which we
* return to request processing, if marked to do so */
failure_route(Trans);
/* look if the callback perhaps replied transaction; it also
covers the case in which a transaction is replied localy
on CANCEL -- then it would make no sense to proceed to
new branches bellow
*/
if (Trans->uas.status >= 200) {
*should_store=0;
*should_relay=-1;
/* this might deserve an improvement -- if something
was already replied, it was put on wait and then,
returning RPS_COMPLETED will make t_on_reply
put it on wait again; perhaps splitting put_on_wait
from send_reply or a new RPS_ code would be healthy
*/
return RPS_COMPLETED;
}
/* look if the callback/failure_route introduced new branches ... */
if (branch_cnt<Trans->nr_of_outgoings) {
/* await then result of new branches */
*should_store=1;
*should_relay=-1;
return RPS_STORE;
}
/* really no more pending branches -- return lowest code */
*should_store=0;
*should_relay=picked_branch;
/* we dont need 'which_cancel' here -- all branches
known to have completed */
/* which_cancel( Trans, cancel_bitmap ); */
return RPS_COMPLETED;
}
/* not >=300 ... it must be 2xx or provisional 1xx */
if (new_code>=100) {
/* 1xx and 2xx except 100 will be relayed */
Trans->uac[branch].last_received=new_code;
*should_store=0;
*should_relay= new_code==100? -1 : branch;
if (new_code>=200 ) {
which_cancel( Trans, cancel_bitmap );
return RPS_COMPLETED;
} else return RPS_PROVISIONAL;
}
error:
/* reply_status didn't match -- it must be something weird */
LOG(L_CRIT, "ERROR: Oh my gooosh! We don't know whether to relay %d\n",
new_code);
discard:
*should_store=0;
*should_relay=-1;
return RPS_DISCARDED;
}
/* Retransmits the last sent inbound reply.
* input: p_msg==request for which I want to retransmit an associated reply
* Returns -1 - error
* 1 - OK
*/
int t_retransmit_reply( struct cell *t )
{
static char b[BUF_SIZE];
int len;
/* first check if we managed to resolve topmost Via -- if
not yet, don't try to retransmit
*/
if (!t->uas.response.dst.send_sock) {
LOG(L_WARN, "WARNING: t_retransmit_reply: "
"no resolved dst to retransmit\n");
return -1;
}
/* we need to lock the transaction as messages from
upstream may change it continuously
*/
LOCK_REPLIES( t );
if (!t->uas.response.buffer) {
DBG("DBG: t_retransmit_reply: nothing to retransmit\n");
goto error;
}
len=t->uas.response.buffer_len;
if ( len==0 || len>BUF_SIZE ) {
DBG("DBG: t_retransmit_reply: "
"zero length or too big to retransmit: %d\n", len);
goto error;
}
memcpy( b, t->uas.response.buffer, len );
UNLOCK_REPLIES( t );
SEND_PR_BUFFER( & t->uas.response, b, len );
DBG("DEBUG: reply retransmitted. buf=%p: %.9s..., shmem=%p: %.9s\n",
b, b, t->uas.response.buffer, t->uas.response.buffer );
return 1;
error:
UNLOCK_REPLIES(t);
return -1;
}
int t_reply( struct cell *t, struct sip_msg* p_msg, unsigned int code,
char * text )
{
return _reply( t, p_msg, code, text, 1 /* lock replies */ );
}
int t_reply_unsafe( struct cell *t, struct sip_msg* p_msg, unsigned int code,
char * text )
{
return _reply( t, p_msg, code, text, 0 /* don't lock replies */ );
}
void set_final_timer( /* struct s_table *h_table, */ struct cell *t )
{
if ( !t->local && t->uas.request->REQ_METHOD==METHOD_INVITE ) {
/* crank timers for negative replies */
if (t->uas.status>=300) {
start_retr(&t->uas.response);
return;
}
/* local UAS retransmits too */
if (t->relaied_reply_branch==-2 && t->uas.status>=200) {
/* we retransmit 200/INVs regardless of transport --
even if TCP used, UDP could be used upstream and
loose the 200, which is not retransmitted by proxies
*/
force_retr( &t->uas.response );
return;
}
}
put_on_wait(t);
}
void cleanup_uac_timers( struct cell *t )
{
int i;
/* reset FR/retransmission timers */
for (i=0; i<t->nr_of_outgoings; i++ ) {
reset_timer( &t->uac[i].request.retr_timer );
reset_timer( &t->uac[i].request.fr_timer );
}
DBG("DEBUG: cleanup_uacs: RETR/FR timers reset\n");
}
static int store_reply( struct cell *trans, int branch, struct sip_msg *rpl)
{
# ifdef EXTRA_DEBUG
if (trans->uac[branch].reply) {
LOG(L_ERR, "ERROR: replacing stored reply; aborting\n");
abort();
}
# endif
/* when we later do things such as challenge aggregation,
we should parse the message here before we conservate
it in shared memory; -jiri
*/
if (rpl==FAKED_REPLY)
trans->uac[branch].reply=FAKED_REPLY;
else
trans->uac[branch].reply = sip_msg_cloner( rpl );
if (! trans->uac[branch].reply ) {
LOG(L_ERR, "ERROR: store_reply: can't alloc' clone memory\n");
return 0;
}
return 1;
}
/* this is the code which decides what and when shall be relayed
upstream; note well -- it assumes it is entered locked with
REPLY_LOCK and it returns unlocked!
*/
enum rps relay_reply( struct cell *t, struct sip_msg *p_msg, int branch,
unsigned int msg_status, branch_bm_t *cancel_bitmap )
{
int relay;
int save_clone;
char *buf;
/* length of outbound reply */
unsigned int res_len;
int relayed_code;
struct sip_msg *relayed_msg;
struct bookmark bm;
int totag_retr;
enum rps reply_status;
/* retransmission structure of outbound reply and request */
struct retr_buf *uas_rb;
/* keep compiler warnings about use of uninit vars silent */
res_len=0;
buf=0;
relayed_msg=0;
relayed_code=0;
totag_retr=0;
/* remember, what was sent upstream to know whether we are
forwarding a first final reply or not */
/* *** store and relay message as needed *** */
reply_status = t_should_relay_response(t, msg_status, branch,
&save_clone, &relay, cancel_bitmap, p_msg );
DBG("DEBUG: relay_reply: branch=%d, save=%d, relay=%d\n",
branch, save_clone, relay );
/* store the message if needed */
if (save_clone) /* save for later use, typically branch picking */
{
if (!store_reply( t, branch, p_msg ))
goto error01;
}
uas_rb = & t->uas.response;
if (relay >= 0 ) {
/* initialize sockets for outbound reply */
uas_rb->activ_type=msg_status;
/* only messages known to be relayed immediately will be
be called on; we do not evoke this callback on messages
stored in shmem -- they are fixed and one cannot change them
anyway
*/
if (msg_status<300 && branch==relay) {
callback_event( TMCB_RESPONSE_FWDED, t, p_msg, msg_status );
}
/* try bulding the outbound reply from either the current
or a stored message */
relayed_msg = branch==relay ? p_msg : t->uac[relay].reply;
if (relayed_msg==FAKED_REPLY) {
tm_stats->replied_localy++;
relayed_code = branch==relay
? msg_status : t->uac[relay].last_received;
if (relayed_code>=180 && t->uas.request->to
&& (get_to(t->uas.request)->tag_value.s==0
|| get_to(t->uas.request)->tag_value.len==0)) {
calc_crc_suffix( t->uas.request, tm_tag_suffix );
buf = build_res_buf_from_sip_req(
relayed_code,
error_text(relayed_code),
tm_tags, TOTAG_VALUE_LEN,
t->uas.request, &res_len, &bm );
} else {
buf = build_res_buf_from_sip_req( relayed_code,
error_text(relayed_code), 0,0, /* no to-tag */
t->uas.request, &res_len, &bm );
}
} else {
relayed_code=relayed_msg->REPLY_STATUS;
buf = build_res_buf_from_sip_res( relayed_msg, &res_len );
/* if we build a message from shmem, we need to remove
via delete lumps which are now stirred in the shmem-ed
structure
*/
if (branch!=relay) {
free_via_lump(&relayed_msg->add_rm);
}
}
update_reply_stats( relayed_code );
if (!buf) {
LOG(L_ERR, "ERROR: relay_reply: "
"no mem for outbound reply buffer\n");
goto error02;
}
/* attempt to copy the message to UAS's shmem:
- copy to-tag for ACK matching as well
- allocate little a bit more for provisionals as
larger messages are likely to follow and we will be
able to reuse the memory frag
*/
uas_rb->buffer = (char*)shm_resize( uas_rb->buffer, res_len +
(msg_status<200 ? REPLY_OVERBUFFER_LEN : 0));
if (!uas_rb->buffer) {
LOG(L_ERR, "ERROR: relay_reply: cannot alloc reply shmem\n");
goto error03;
}
uas_rb->buffer_len = res_len;
memcpy( uas_rb->buffer, buf, res_len );
if (relayed_msg==FAKED_REPLY) { /* to-tags for local replies */
update_local_tags(t, &bm, uas_rb->buffer, buf);
}
tm_stats->replied_localy++;
/* update the status ... */
t->uas.status = relayed_code;
t->relaied_reply_branch = relay;
if (t->is_invite && relayed_msg!=FAKED_REPLY
&& relayed_code>=200 && relayed_code < 300
&& (callback_array[TMCB_RESPONSE_OUT] ||
callback_array[TMCB_E2EACK_IN])) {
totag_retr=update_totag_set(t, relayed_msg);
}
}; /* if relay ... */
UNLOCK_REPLIES( t );
/* send it now (from the private buffer) */
if (relay >= 0) {
SEND_PR_BUFFER( uas_rb, buf, res_len );
DBG("DEBUG: reply relayed. buf=%p: %.9s..., shmem=%p: %.9s\n",
buf, buf, uas_rb->buffer, uas_rb->buffer );
if (!totag_retr)
callback_event( TMCB_RESPONSE_OUT, t, relayed_msg, relayed_code );
pkg_free( buf );
}
/* success */
return reply_status;
error03:
pkg_free( buf );
error02:
if (save_clone) {
if (t->uac[branch].reply!=FAKED_REPLY)
sip_msg_free( t->uac[branch].reply );
t->uac[branch].reply = NULL;
}
error01:
t_reply_unsafe( t, t->uas.request, 500, "Reply processing error" );
UNLOCK_REPLIES(t);
if (t->is_invite) cancel_uacs( t, *cancel_bitmap );
/* a serious error occured -- attempt to send an error reply;
it will take care of clean-ups
*/
/* failure */
return RPS_ERROR;
}
/* this is the "UAC" above transaction layer; if a final reply
is received, it triggers a callback; note well -- it assumes
it is entered locked with REPLY_LOCK and it returns unlocked!
*/
enum rps local_reply( struct cell *t, struct sip_msg *p_msg, int branch,
unsigned int msg_status, branch_bm_t *cancel_bitmap)
{
/* how to deal with replies for local transaction */
int local_store, local_winner;
enum rps reply_status;
struct sip_msg *winning_msg;
int winning_code;
int totag_retr;
/* branch_bm_t cancel_bitmap; */
/* keep warning 'var might be used un-inited' silent */
winning_msg=0;
winning_code=0;
totag_retr=0;
*cancel_bitmap=0;
reply_status=t_should_relay_response( t, msg_status, branch,
&local_store, &local_winner, cancel_bitmap, p_msg );
DBG("DEBUG: local_reply: branch=%d, save=%d, winner=%d\n",
branch, local_store, local_winner );
if (local_store) {
if (!store_reply(t, branch, p_msg))
goto error;
}
if (local_winner>=0) {
winning_msg= branch==local_winner
? p_msg : t->uac[local_winner].reply;
if (winning_msg==FAKED_REPLY) {
tm_stats->replied_localy++;
winning_code = branch==local_winner
? msg_status : t->uac[local_winner].last_received;
} else {
winning_code=winning_msg->REPLY_STATUS;
}
t->uas.status = winning_code;
update_reply_stats( winning_code );
if (t->is_invite && winning_msg!=FAKED_REPLY
&& winning_code>=200 && winning_code <300
&& (callback_array[TMCB_RESPONSE_OUT] ||
callback_array[TMCB_E2EACK_IN])) {
totag_retr=update_totag_set(t, winning_msg);
}
}
UNLOCK_REPLIES(t);
if (local_winner>=0 && winning_code>=200 ) {
DBG("DEBUG: local transaction completed\n");
if (!totag_retr) {
callback_event( TMCB_LOCAL_COMPLETED, t, winning_msg,
winning_code );
if (t->completion_cb) t->completion_cb( t, winning_msg,
winning_code, 0 /* empty param */);
}
}
return reply_status;
error:
which_cancel(t, cancel_bitmap);
UNLOCK_REPLIES(t);
cleanup_uac_timers(t);
if ( get_cseq(p_msg)->method.len==INVITE_LEN
&& memcmp( get_cseq(p_msg)->method.s, INVITE, INVITE_LEN)==0)
cancel_uacs( t, *cancel_bitmap );
put_on_wait(t);
return RPS_ERROR;
}
/* This function is called whenever a reply for our module is received;
* we need to register this function on module initialization;
* Returns : 0 - core router stops
* 1 - core router relay statelessly
*/
int reply_received( struct sip_msg *p_msg )
{
int msg_status;
char *ack;
unsigned int ack_len;
int branch;
/* has the transaction completed now and we need to clean-up? */
int reply_status;
branch_bm_t cancel_bitmap;
struct ua_client *uac;
struct cell *t;
/* make sure we know the assosociated transaction ... */
if (t_check( p_msg , &branch )==-1)
return 1;
/*... if there is none, tell the core router to fwd statelessly */
t=get_t();
if ( (t==0)||(t==T_UNDEFINED)) return 1;
cancel_bitmap=0;
msg_status=p_msg->REPLY_STATUS;
uac=&t->uac[branch];
DBG("DEBUG: t_on_reply: org. status uas=%d, "
"uac[%d]=%d local=%d is_invite=%d)\n",
t->uas.status, branch, uac->last_received,
t->local, t->is_invite);
/* it's a cancel ... ? */
if (get_cseq(p_msg)->method.len==CANCEL_LEN
&& memcmp( get_cseq(p_msg)->method.s, CANCEL, CANCEL_LEN)==0
/* .. which is not e2e ? ... */
&& t->is_invite ) {
/* ... then just stop timers */
reset_timer( &uac->local_cancel.retr_timer);
if ( msg_status >= 200 )
reset_timer( &uac->local_cancel.fr_timer);
DBG("DEBUG: reply to local CANCEL processed\n");
goto done;
}
/* *** stop timers *** */
/* stop retransmission */
reset_timer( &uac->request.retr_timer);
/* stop final response timer only if I got a final response */
if ( msg_status >= 200 )
reset_timer( &uac->request.fr_timer);
/* acknowledge negative INVITE replies (do it before detailed
on_reply processing, which may take very long, like if it
is attempted to establish a TCP connection to a fail-over dst
*/
if (t->is_invite && (msg_status>=300 || (t->local && msg_status>=200))) {
ack = build_ack( p_msg, t, branch, &ack_len);
if (ack) {
SEND_PR_BUFFER( &uac->request, ack, ack_len );
shm_free(ack);
}
} /* ack-ing negative INVITE replies */
/* processing of on_reply block */
if (t->on_reply) {
rmode=MODE_ONREPLY;
if (run_actions(onreply_rlist[t->on_reply], p_msg)<0)
LOG(L_ERR, "ERROR: on_reply processing failed\n");
}
LOCK_REPLIES( t );
if (t->local) {
reply_status=local_reply( t, p_msg, branch, msg_status, &cancel_bitmap );
} else {
reply_status=relay_reply( t, p_msg, branch, msg_status,
&cancel_bitmap );
}
if (reply_status==RPS_ERROR)
goto done;
/* clean-up the transaction when transaction completed */
if (reply_status==RPS_COMPLETED) {
/* no more UAC FR/RETR (if I received a 2xx, there may
be still pending branches ...
*/
cleanup_uac_timers( t );
if (t->is_invite) cancel_uacs( t, cancel_bitmap );
/* FR for negative INVITES, WAIT anything else */
set_final_timer( t );
}
/* update FR/RETR timers on provisional replies */
if (msg_status<200) { /* provisional now */
if (t->is_invite) {
/* invite: change FR to longer FR_INV, do not
attempt to restart retransmission any more
*/
set_timer( & uac->request.fr_timer,
FR_INV_TIMER_LIST );
} else {
/* non-invite: restart retransmisssions (slow now) */
uac->request.retr_list=RT_T2;
set_timer( & uac->request.retr_timer, RT_T2 );
}
} /* provisional replies */
done:
/* don't try to relay statelessly neither on success
(we forwarded statefuly) nor on error; on troubles,
simply do nothing; that will make the other party to
retransmit; hopefuly, we'll then be better off */
return 0;
}
int t_reply_with_body( struct cell *trans, unsigned int code,
char * text, char * body, char * new_header, char * to_tag )
{
str s_to_tag,sb,snh;
char* res_buf;
unsigned int res_len;
int ret;
struct bookmark bm;
s_to_tag.s = to_tag;
if(to_tag)
s_to_tag.len = strlen(to_tag);
/* mark the transaction as replied */
if (code>=200) set_kr(REQ_RPLD);
/* compute the response */
sb.s = body;
sb.len = strlen(body);
snh.s = new_header;
snh.len = strlen(new_header);
res_buf = build_res_buf_with_body_from_sip_req(
code,text, s_to_tag.s, s_to_tag.len,
sb.s,sb.len,
snh.s,snh.len,
trans->uas.request,&res_len, &bm);
DBG("t_reply_with_body: buffer computed\n");
// frees 'res_buf' ... no panic !
ret=_reply_light( trans, res_buf, res_len, code, text,
s_to_tag.s, s_to_tag.len, 1 /* lock replies */, &bm );
/* this is ugly hack -- the function caller may wish to continue with
* transction and I unref; however, there is now only one use from
* vm/fifo_vm_reply and I'm currently to lazy to export UNREF; -jiri
*/
UNREF(trans);
return ret;
}