inline static int w_t_reply(struct sip_msg* msg, char* str, char* str2)
{
struct cell *t;
if (msg->REQ_METHOD==METHOD_ACK) {
LOG(L_WARN, "WARNING: t_reply: ACKs are not replied\n");
return -1;
}
if (t_check( msg , 0 )==-1) return -1;
t=get_t();
if (!t) {
LOG(L_ERR, "ERROR: t_reply: cannot send a t_reply to a message "
"for which no T-state has been established\n");
return -1;
}
/* if called from reply_route, make sure that unsafe version
* is called; we are already in a mutex and another mutex in
* the safe version would lead to a deadlock
*/
if (rmode==MODE_ONFAILURE) {
DBG("DEBUG: t_reply_unsafe called from w_t_reply\n");
return t_reply_unsafe(t, msg, (unsigned int)(long) str, str2);
} else if (rmode==MODE_REQUEST) {
return t_reply( t, msg, (unsigned int)(long) str, str2);
} else {
LOG(L_CRIT, "BUG: w_t_reply entered in unsupported mode\n");
return -1;
}
}
inline static int w_t_reply(struct sip_msg* msg, char* str, char* str2)
{
struct cell *t;
if (msg->REQ_METHOD==METHOD_ACK) {
LOG(L_WARN, "WARNING: t_reply: ACKs are not replied\n");
return -1;
}
if (t_check( msg , 0 )==-1) return -1;
t=get_t();
if (!t) {
LOG(L_ERR, "ERROR: t_reply: cannot send a t_reply to a message "
"for which no T-state has been established\n");
return -1;
}
/* if called from reply_route, make sure that unsafe version
* is called; we are already in a mutex and another mutex in
* the safe version would lead to a deadlock
*/
switch (route_type) {
case FAILURE_ROUTE:
DBG("DEBUG: t_reply_unsafe called from w_t_reply\n");
return t_reply_unsafe(t, msg, (unsigned int)(long) str, str2);
case REQUEST_ROUTE:
return t_reply( t, msg, (unsigned int)(long) str, str2);
default:
LOG(L_CRIT, "BUG:tm:w_t_reply: unsupported route_type (%d)\n",
route_type);
return -1;
}
}
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 {
LM_ERR("err2reason failed\n");
return -1;
}
}
void cancel_invite(struct sip_msg *cancel_msg,
struct cell *t_cancel, struct cell *t_invite )
{
#define CANCEL_REASON_SIP_487 \
"Reason: SIP;cause=487;text=\"ORIGINATOR_CANCEL\"" CRLF
branch_bm_t cancel_bitmap;
branch_bm_t dummy_bm;
str reason;
unsigned int i;
struct hdr_field *hdr;
cancel_bitmap=0;
/* send back 200 OK as per RFC3261 */
reason.s = CANCELING;
reason.len = sizeof(CANCELING)-1;
t_reply( t_cancel, cancel_msg, 200, &reason );
reason.s = NULL;
reason.len = 0;
/* propagate the REASON flag ? */
if ( t_cancel->flags&T_CANCEL_REASON_FLAG ) {
/* look for the Reason header */
if (parse_headers(cancel_msg, HDR_EOH_F, 0)<0) {
LM_ERR("failed to parse all hdrs - ignoring Reason hdr\n");
} else {
hdr = get_header_by_static_name(cancel_msg, "Reason");
if (hdr!=NULL) {
reason.s = hdr->name.s;
reason.len = hdr->len;
}
}
}
/* if no reason, use NORMAL CLEARING */
if (reason.s == NULL) {
reason.s = CANCEL_REASON_SIP_487;
reason.len = sizeof(CANCEL_REASON_SIP_487) - 1;
}
/* generate local cancels for all branches */
which_cancel(t_invite, &cancel_bitmap );
set_cancel_extra_hdrs( reason.s, reason.len);
cancel_uacs(t_invite, cancel_bitmap );
set_cancel_extra_hdrs( NULL, 0);
/* internally cancel branches with no received reply */
for (i=t_invite->first_branch; i<t_invite->nr_of_outgoings; i++) {
if (t_invite->uac[i].last_received==0){
/* reset the "request" timers */
reset_timer(&t_invite->uac[i].request.retr_timer);
reset_timer(&t_invite->uac[i].request.fr_timer);
LOCK_REPLIES( t_invite );
relay_reply(t_invite,FAKED_REPLY,i,487,&dummy_bm);
}
}
}
inline static int w_t_reply(struct sip_msg* msg, char* p1, char* p2)
{
struct cell *t;
int code, ret = -1;
str reason;
char* r;
if (msg->REQ_METHOD==METHOD_ACK) {
LOG(L_WARN, "WARNING: t_reply: ACKs are not replied\n");
return -1;
}
if (t_check( msg , 0 )==-1) return -1;
t=get_t();
if (!t) {
LOG(L_ERR, "ERROR: t_reply: cannot send a t_reply to a message "
"for which no T-state has been established\n");
return -1;
}
if (get_int_fparam(&code, msg, (fparam_t*)p1) < 0) {
code = default_code;
}
if (get_str_fparam(&reason, msg, (fparam_t*)p2) < 0) {
reason = default_reason;
}
r = as_asciiz(&reason);
if (r == NULL) r = default_reason.s;
/* if called from reply_route, make sure that unsafe version
* is called; we are already in a mutex and another mutex in
* the safe version would lead to a deadlock
*/
if (rmode==MODE_ONFAILURE) {
DBG("DEBUG: t_reply_unsafe called from w_t_reply\n");
ret = t_reply_unsafe(t, msg, code, r);
} else if (rmode==MODE_REQUEST) {
ret = t_reply( t, msg, code, r);
} else {
LOG(L_CRIT, "BUG: w_t_reply entered in unsupported mode\n");
ret = -1;
}
if (r) pkg_free(r);
return ret;
}
void cancel_invite(struct sip_msg *cancel_msg,
struct cell *t_cancel, struct cell *t_invite, int locked)
{
branch_bm_t cancel_bitmap;
str reason;
cancel_bitmap=0;
/* send back 200 OK as per RFC3261 */
reason.s = CANCELING;
reason.len = sizeof(CANCELING)-1;
if (locked)
t_reply_unsafe( t_cancel, cancel_msg, 200, &reason );
else
t_reply( t_cancel, cancel_msg, 200, &reason );
get_cancel_reason(cancel_msg, t_cancel->flags, &reason);
/* generate local cancels for all branches */
which_cancel(t_invite, &cancel_bitmap );
set_cancel_extra_hdrs( reason.s, reason.len);
cancel_uacs(t_invite, cancel_bitmap );
set_cancel_extra_hdrs( NULL, 0);
/* Do not do anything about branches with no received reply;
* continue the retransmission hoping to get something back;
* if still not, we will generate the 408 Timeout based on FR
* timer; this helps with better coping with missed/lated provisional
* replies in the context of cancelling the transaction
*/
#if 0
/* internally cancel branches with no received reply */
for (i=t_invite->first_branch; i<t_invite->nr_of_outgoings; i++) {
if (t_invite->uac[i].last_received==0){
/* reset the "request" timers */
reset_timer(&t_invite->uac[i].request.retr_timer);
reset_timer(&t_invite->uac[i].request.fr_timer);
LOCK_REPLIES( t_invite );
relay_reply(t_invite,FAKED_REPLY,i,487,&dummy_bm);
}
}
#endif
}
inline static int w_t_reply(struct sip_msg* msg, char* code, char* text)
{
struct cell *t;
int r;
if (msg->REQ_METHOD==METHOD_ACK) {
LM_DBG("ACKs are not replied\n");
return 0;
}
switch (route_type) {
case FAILURE_ROUTE:
/* if called from reply_route, make sure that unsafe version
* is called; we are already in a mutex and another mutex in
* the safe version would lead to a deadlock */
t=get_t();
if ( t==0 || t==T_UNDEFINED ) {
LM_ERR("BUG - no transaction found in Failure Route\n");
return -1;
}
return t_reply_unsafe(t, msg, (unsigned int)(long)code,(str*)text);
case REQUEST_ROUTE:
t=get_t();
if ( t==0 || t==T_UNDEFINED ) {
r = t_newtran( msg , 0/*no full UAS cloning*/ );
if (r==0) {
/* retransmission -> break the script */
return 0;
} else if (r<0) {
LM_ERR("could not create a new transaction\n");
return -1;
}
t=get_t();
}
return t_reply( t, msg, (unsigned int)(long)code, (str*)text);
default:
LM_CRIT("unsupported route_type (%d)\n", route_type);
return -1;
}
}
void e2e_cancel( struct sip_msg *cancel_msg,
struct cell *t_cancel, struct cell *t_invite )
{
branch_bm_t cancel_bm;
int i;
int lowest_error;
str backup_uri;
int ret;
cancel_bm=0;
lowest_error=0;
backup_uri=cancel_msg->new_uri;
/* determine which branches to cancel ... */
which_cancel( t_invite, &cancel_bm );
t_cancel->nr_of_outgoings=t_invite->nr_of_outgoings;
/* fix label -- it must be same for reply matching */
t_cancel->label=t_invite->label;
/* ... and install CANCEL UACs */
for (i=0; i<t_invite->nr_of_outgoings; i++)
if (cancel_bm & (1<<i)) {
ret=e2e_cancel_branch(cancel_msg, t_cancel, t_invite, i);
if (ret<0) cancel_bm &= ~(1<<i);
if (ret<lowest_error) lowest_error=ret;
}
cancel_msg->new_uri=backup_uri;
/* send them out */
for (i=0; i<t_cancel->nr_of_outgoings; i++) {
if (cancel_bm & (1<<i)) {
if (SEND_BUFFER( &t_cancel->uac[i].request)==-1) {
LOG(L_ERR, "ERROR: e2e_cancel: send failed\n");
}
start_retr( &t_cancel->uac[i].request );
}
}
/* if error occured, let it know upstream (final reply
will also move the transaction on wait state
*/
if (lowest_error<0) {
LOG(L_ERR, "ERROR: cancel error\n");
t_reply( t_cancel, cancel_msg, 500, "cancel error");
/* if there are pending branches, let upstream know we
are working on it
*/
} else if (cancel_bm) {
DBG("DEBUG: e2e_cancel: e2e cancel proceeding\n");
t_reply( t_cancel, cancel_msg, 200, CANCELLING );
/* if the transaction exists, but there is no more pending
branch, tell usptream we're done
*/
} else {
DBG("DEBUG: e2e_cancel: e2e cancel -- no more pending branches\n");
t_reply( t_cancel, cancel_msg, 200, CANCEL_DONE );
}
/* we could await downstream UAS's 487 replies; however,
if some of the branches does not do that, we could wait
long time and annoy upstream UAC which wants to see
a result of CANCEL quickly
*/
DBG("DEBUG: e2e_cancel: sending 487\n");
/* in case that something in the meantime has been sent upstream
(like if FR hit at the same time), don't try to send */
if (t_invite->uas.status>=200) return;
/* there is still a race-condition -- the FR can hit now; that's
not too bad -- we take care in t_reply's REPLY_LOCK; in
the worst case, both this t_reply and other replier will
try, and the later one will result in error message
"can't reply twice"
*/
t_reply(t_invite, t_invite->uas.request, 487, CANCELLED );
}
/* function returns:
* 1 - forward successful
* -1 - error during forward
*/
int t_forward_nonack( struct cell *t, struct sip_msg* p_msg ,
struct proxy_l * proxy, int reset_bcounter, int locked)
{
str reply_reason_487 = str_init("Request Terminated");
str backup_uri;
str backup_dst;
int branch_ret, lowest_ret;
str current_uri;
branch_bm_t added_branches;
int i, q;
struct cell *t_invite;
int success_branch;
str dst_uri;
struct socket_info *bk_sock;
unsigned int br_flags, bk_bflags;
int idx;
str path;
str bk_path;
/* make -Wall happy */
current_uri.s=0;
/* before doing enything, update the t flags from msg */
t->uas.request->flags = p_msg->flags;
if (p_msg->REQ_METHOD==METHOD_CANCEL) {
t_invite=t_lookupOriginalT( p_msg );
if (t_invite!=T_NULL_CELL) {
t_invite->flags |= T_WAS_CANCELLED_FLAG;
cancel_invite( p_msg, t, t_invite, locked );
return 1;
}
}
/* do not forward requests which were already cancelled*/
if (no_new_branches(t)) {
LM_INFO("discarding fwd for a 6xx transaction\n");
ser_error = E_NO_DESTINATION;
return -1;
}
if (was_cancelled(t)) {
/* is this the first attempt of sending a branch out ? */
if (t->nr_of_outgoings==0) {
/* if no other signalling was performed on the transaction
* and the transaction was already canceled, better
* internally generate the 487 reply here */
if (locked)
t_reply_unsafe( t, p_msg , 487 , &reply_reason_487);
else
t_reply( t, p_msg , 487 , &reply_reason_487);
}
LM_INFO("discarding fwd for a cancelled transaction\n");
ser_error = E_NO_DESTINATION;
return -1;
}
/* backup current uri, sock and flags... add_uac changes it */
backup_uri = p_msg->new_uri;
backup_dst = p_msg->dst_uri;
bk_sock = p_msg->force_send_socket;
bk_path = p_msg->path_vec;
bk_bflags = p_msg->ruri_bflags;
/* advertised address/port are not changed */
/* check if the UAS retranmission port needs to be updated */
if ( (p_msg->msg_flags ^ t->uas.request->msg_flags) & FL_FORCE_RPORT )
su_setport( &t->uas.response.dst.to, p_msg->rcv.src_port );
/* if no more specific error code is known, use this */
lowest_ret=E_BUG;
/* branches added */
added_branches=0;
/* branch to begin with */
if (reset_bcounter) {
t->first_branch=t->nr_of_outgoings;
/* check if the previous branch is a PHONY one and if yes
* keep it in the set of active branches; that means the
* transaction had a t_wait_for_new_branches() call prior to relay() */
if ( t->first_branch>0 &&
(t->uac[t->first_branch-1].flags & T_UAC_IS_PHONY) )
t->first_branch--;
}
/* as first branch, use current uri */
current_uri = *GET_RURI(p_msg);
branch_ret = add_uac( t, p_msg, ¤t_uri, &backup_dst,
getb0flags(p_msg), &p_msg->path_vec, proxy);
if (branch_ret>=0)
added_branches |= 1<<branch_ret;
else
lowest_ret=branch_ret;
/* ....and now add the remaining additional branches */
for( idx=0; (current_uri.s=get_branch( idx, ¤t_uri.len, &q,
&dst_uri, &path, &br_flags, &p_msg->force_send_socket))!=0 ; idx++ ) {
branch_ret = add_uac( t, p_msg, ¤t_uri, &dst_uri,
br_flags, &path, proxy);
/* pick some of the errors in case things go wrong;
note that picking lowest error is just as good as
any other algorithm which picks any other negative
branch result */
if (branch_ret>=0)
added_branches |= 1<<branch_ret;
else
lowest_ret=branch_ret;
}
/* consume processed branches */
clear_branches();
/* restore original stuff */
p_msg->new_uri=backup_uri;
p_msg->parsed_uri_ok = 0;/* just to be sure; add_uac may parse other uris*/
p_msg->dst_uri = backup_dst;
p_msg->force_send_socket = bk_sock;
p_msg->path_vec = bk_path;
p_msg->ruri_bflags = bk_bflags;
/* update on_branch, _only_ if modified, otherwise it overwrites
* whatever it is already in the transaction */
if (get_on_branch())
t->on_branch = get_on_branch();
/* update flags, if changed in branch route */
t->uas.request->flags = p_msg->flags;
/* things went wrong ... no new branch has been fwd-ed at all */
if (added_branches==0) {
LM_ERR("failure to add branches\n");
ser_error = lowest_ret;
return lowest_ret;
}
/* send them out now */
success_branch=0;
for (i=t->first_branch; i<t->nr_of_outgoings; i++) {
if (added_branches & (1<<i)) {
if (t->uac[i].br_flags & tcp_no_new_conn_bflag)
tcp_no_new_conn = 1;
do {
if (check_blacklists( t->uac[i].request.dst.proto,
&t->uac[i].request.dst.to,
t->uac[i].request.buffer.s,
t->uac[i].request.buffer.len)) {
LM_DBG("blocked by blacklists\n");
ser_error=E_IP_BLOCKED;
} else {
run_trans_callbacks(TMCB_PRE_SEND_BUFFER, t, p_msg, 0, i);
if (SEND_BUFFER( &t->uac[i].request)==0) {
ser_error = 0;
break;
}
LM_ERR("sending request failed\n");
ser_error=E_SEND;
}
/* get next dns entry */
if ( t->uac[i].proxy==0 ||
get_next_su( t->uac[i].proxy, &t->uac[i].request.dst.to,
(ser_error==E_IP_BLOCKED)?0:1)!=0 )
break;
t->uac[i].request.dst.proto = t->uac[i].proxy->proto;
/* update branch */
if ( update_uac_dst( p_msg, &t->uac[i] )!=0)
break;
}while(1);
tcp_no_new_conn = 0;
if (ser_error) {
shm_free(t->uac[i].request.buffer.s);
t->uac[i].request.buffer.s = NULL;
t->uac[i].request.buffer.len = 0;
continue;
}
success_branch++;
start_retr( &t->uac[i].request );
set_kr(REQ_FWDED);
/* successfully sent out -> run callbacks */
if ( has_tran_tmcbs( t, TMCB_REQUEST_BUILT|TMCB_MSG_SENT_OUT) ) {
set_extra_tmcb_params( &t->uac[i].request.buffer,
&t->uac[i].request.dst);
run_trans_callbacks( TMCB_REQUEST_BUILT|TMCB_MSG_SENT_OUT, t,
p_msg, 0, 0);
}
}
}
return (success_branch>0)?1:-1;
}
/* WARNING: doesn't work from failure route (deadlock, uses t_reply => tries
* to get the reply lock again */
int t_relay_to( struct sip_msg *p_msg , struct proxy_l *proxy, int proto,
int replicate)
{
int ret;
int new_tran;
/* struct hdr_field *hdr; */
struct cell *t;
struct dest_info dst;
unsigned short port;
str host;
short comp;
#ifndef TM_DELAYED_REPLY
int reply_ret;
#endif
ret=0;
/* special case for CANCEL */
if ( p_msg->REQ_METHOD==METHOD_CANCEL){
ret=t_forward_cancel(p_msg, proxy, proto, &t);
if (t) goto handle_ret;
goto done;
}
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
MMA: return value E_SCRIPT means that transaction was already started
from the script so continue with that transaction
*/
if (likely(new_tran!=E_SCRIPT)) {
if (new_tran<0) {
ret = (ser_error==E_BAD_VIA && reply_to_via) ? 0 : new_tran;
goto done;
}
/* if that was a retransmission, return we are happily done */
if (new_tran==0) {
ret = 1;
goto done;
}
}else if (unlikely(p_msg->REQ_METHOD==METHOD_ACK)) {
/* transaction previously found (E_SCRIPT) and msg==ACK
=> ack to neg. reply or ack to local trans.
=> process it and exit */
/* FIXME: there's no way to distinguish here between acks to
local trans. and neg. acks */
/* in normal operation we should never reach this point, if we
do WARN(), it might hide some real bug (apart from possibly
hiding a bug the most harm done is calling the TMCB_ACK_NEG
callbacks twice) */
WARN("negative or local ACK caught, please report\n");
t=get_t();
if (unlikely(has_tran_tmcbs(t, TMCB_ACK_NEG_IN)))
run_trans_callbacks(TMCB_ACK_NEG_IN, t, p_msg, 0,
p_msg->REQ_METHOD);
t_release_transaction(t);
ret=1;
goto done;
}
/* new transaction */
/* at this point if the msg is an ACK it is an e2e ACK and
e2e ACKs do not establish a transaction and are fwd-ed statelessly */
if ( p_msg->REQ_METHOD==METHOD_ACK) {
DBG( "SER: forwarding ACK statelessly \n");
if (proxy==0) {
init_dest_info(&dst);
dst.proto=proto;
if (get_uri_send_info(GET_NEXT_HOP(p_msg), &host, &port,
&dst.proto, &comp)!=0){
ret=E_BAD_ADDRESS;
goto done;
}
#ifdef USE_COMP
dst.comp=comp;
#endif
/* dst->send_sock not set, but forward_request will take care
* of it */
ret=forward_request(p_msg, &host, port, &dst);
} else {
init_dest_info(&dst);
dst.proto=get_proto(proto, proxy->proto);
proxy2su(&dst.to, proxy);
/* dst->send_sock not set, but forward_request will take care
* of it */
ret=forward_request( p_msg , 0, 0, &dst) ;
}
goto done;
}
/* if replication flag is set, mark the transaction as local
so that replies will not be relayed */
t=get_t();
if (replicate) t->flags|=T_IS_LOCAL_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 && (t->flags&T_AUTO_INV_100)
&& (t->uas.status < 100)
) {
DBG( "SER: new INVITE\n");
if (!t_reply( t, p_msg , 100 ,
cfg_get(tm, tm_cfg, tm_auto_inv_100_r)))
DBG("SER: ERROR: t_reply (100)\n");
}
/* now go ahead and forward ... */
ret=t_forward_nonack(t, p_msg, proxy, proto);
handle_ret:
if (ret<=0) {
DBG( "t_forward_nonack returned error %d (%d)\n", ret, ser_error);
/* we don't want to pass upstream any reply regarding replicating
* a request; replicated branch must stop at us*/
if (likely(!replicate)) {
if(t->flags&T_DISABLE_INTERNAL_REPLY) {
/* flag set to don't generate the internal negative reply
* - let the transaction live further, processing should
* continue in config */
DBG("not generating immediate reply for error %d\n", ser_error);
tm_error=ser_error;
ret = -4;
goto done;
}
#ifdef TM_DELAYED_REPLY
/* current error in tm_error */
tm_error=ser_error;
set_kr(REQ_ERR_DELAYED);
DBG("%d error reply generation delayed \n", ser_error);
#else
reply_ret=kill_transaction( t, ser_error );
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; -- we don't want to stop the script */
} else {
DBG("ERROR: generation of a stateful reply "
"on error failed\n");
t_release_transaction(t);
}
#endif /* TM_DELAYED_REPLY */
}else{
t_release_transaction(t); /* kill it silently */
}
} else {
DBG( "SER: new transaction fwd'ed\n");
}
done:
return ret;
}
/* atomic "new_tran" construct; it returns:
<0 on error
+1 if a request did not match a transaction
- it that was an ack, the calling function
shall forward statelessly
- otherwise it means, a new transaction was
introduced and the calling function
shall reply/relay/whatever_appropriate
0 on retransmission
*/
int t_newtran( struct sip_msg* p_msg, int full_uas )
{
int lret, my_err;
context_p ctx_backup;
/* is T still up-to-date ? */
LM_DBG("transaction on entrance=%p\n",T);
if ( T && T!=T_UNDEFINED ) {
LM_DBG("transaction already in process %p\n", T );
return E_SCRIPT;
}
T = T_UNDEFINED;
/* first of all, parse everything -- we will store in shared memory
and need to have all headers ready for generating potential replies
later; parsing later on demand is not an option since the request
will be in shmem and applying parse_headers to it would intermix
shmem with pkg_mem
*/
if (parse_headers(p_msg, HDR_EOH_F, 0 )<0) {
LM_ERR("parse_headers failed\n");
return E_BAD_REQ;
}
if ((p_msg->parsed_flag & HDR_EOH_F)!=HDR_EOH_F) {
LM_ERR("EoH not parsed\n");
return E_OUT_OF_MEM;
}
/* t_lookup_requests attempts to find the transaction;
it also calls check_transaction_quadruple -> it is
safe to assume we have from/callid/cseq/to
*/
lret = t_lookup_request( p_msg, 1 /* leave locked if not found */ );
/* on error, pass the error in the stack ... nothing is locked yet
if 0 is returned */
if (lret==0) return E_BAD_TUPEL;
/* transaction found, it's a retransmission */
if (lret>0) {
if (p_msg->REQ_METHOD==METHOD_ACK) {
t_release_transaction(T);
} else {
t_retransmit_reply(T);
}
/* hide the transaction from the upper layer */
t_unref( p_msg );
/* things are done -- return from script */
return 0;
}
/* from now on, be careful -- hash table is locked */
if (lret==-2) { /* was it an e2e ACK ? if so, trigger a callback */
if (e2eack_T->relaied_reply_branch==-2) {
/* if a ACK for a local replied transaction, release the
INVITE transaction and break the script -> simply absorb
the ACK request */
t_release_transaction(e2eack_T);
return 0;
}
LM_DBG("building branch for end2end ACK - flags=%X\n",e2eack_T->flags);
/* to ensure unigueness acros time and space, compute the ACK
* branch in the same maner as for INVITE, but put a t->branch
* value that cannot exist for that INVITE - as it is compute as
* an INVITE, it will not overlapp with other INVITEs or requests.
* But the faked value for t->branch guarantee no overalap with
* corresponding INVITE --bogdan */
if (!t_calc_branch(e2eack_T, e2eack_T->nr_of_outgoings+1,
p_msg->add_to_branch_s, &p_msg->add_to_branch_len )) {
LM_ERR("ACK branch computation failed\n");
}
return 1;
}
/* transaction not found, it's a new request (lret<0, lret!=-2);
establish a new transaction ... */
if (p_msg->REQ_METHOD==METHOD_ACK) /* ... unless it is in ACK */
return 1;
my_err=new_t(p_msg, full_uas);
if (my_err<0) {
LM_ERR("new_t failed\n");
goto new_err;
}
UNLOCK_HASH(p_msg->hash_index);
/* now, when the transaction state exists, check if
there is a meaningful Via and calculate it; better
do it now than later: state is established so that
subsequent retransmissions will be absorbed and will
not possibly block during Via DNS resolution; doing
it later would only burn more CPU as if there is an
error, we cannot relay later whatever comes out of the
the transaction
*/
if (!init_rb( &T->uas.response, p_msg)) {
LM_ERR("unresolvable via1\n");
put_on_wait( T );
t_unref(p_msg);
return E_BAD_VIA;
}
if (auto_100trying && p_msg->REQ_METHOD==METHOD_INVITE) {
ctx_backup = current_processing_ctx;
current_processing_ctx = NULL;
t_reply( T, p_msg , 100 , &relay_reason_100);
current_processing_ctx = ctx_backup;
}
return 1;
new_err:
UNLOCK_HASH(p_msg->hash_index);
return my_err;
}
void e2e_cancel( struct sip_msg *cancel_msg,
struct cell *t_cancel, struct cell *t_invite )
{
branch_bm_t cancel_bm, tmp_bm;
int i;
int lowest_error;
str backup_uri;
int ret;
cancel_bm=0;
lowest_error=0;
backup_uri=cancel_msg->new_uri;
/* determine which branches to cancel ... */
which_cancel( t_invite, &cancel_bm );
t_cancel->nr_of_outgoings=t_invite->nr_of_outgoings;
/* fix label -- it must be same for reply matching */
t_cancel->label=t_invite->label;
/* ... and install CANCEL UACs */
for (i=0; i<t_invite->nr_of_outgoings; i++)
if (cancel_bm & (1<<i)) {
ret=e2e_cancel_branch(cancel_msg, t_cancel, t_invite, i);
if (ret<0) cancel_bm &= ~(1<<i);
if (ret<lowest_error) lowest_error=ret;
}
cancel_msg->new_uri=backup_uri;
/* send them out */
for (i=0; i<t_cancel->nr_of_outgoings; i++) {
if (cancel_bm & (1<<i)) {
/* Provisional reply received on this branch, send CANCEL */
/* No need to stop timers as they have already been stopped by the reply */
if (SEND_BUFFER( &t_cancel->uac[i].request)==-1) {
LOG(L_ERR, "ERROR: e2e_cancel: send failed\n");
}
start_retr( &t_cancel->uac[i].request );
} else {
if (t_invite->uac[i].last_received < 100) {
/* No provisional response received, stop
* retransmission timers
*/
reset_timer(&t_invite->uac[i].request.retr_timer);
reset_timer(&t_invite->uac[i].request.fr_timer);
/* Generate faked reply */
LOCK_REPLIES(t_invite);
if (relay_reply(t_invite, FAKED_REPLY, i, 487, &tmp_bm) == RPS_ERROR) {
lowest_error = -1;
}
}
}
}
/* if error occurred, let it know upstream (final reply
will also move the transaction on wait state
*/
if (lowest_error<0) {
LOG(L_ERR, "ERROR: cancel error\n");
t_reply( t_cancel, cancel_msg, 500, "cancel error");
/* if there are pending branches, let upstream know we
are working on it
*/
} else if (cancel_bm) {
DBG("DEBUG: e2e_cancel: e2e cancel proceeding\n");
t_reply( t_cancel, cancel_msg, 200, CANCELING );
/* if the transaction exists, but there is no more pending
branch, tell upstream we're done
*/
} else {
DBG("DEBUG: e2e_cancel: e2e cancel -- no more pending branches\n");
t_reply( t_cancel, cancel_msg, 200, CANCEL_DONE );
}
#ifdef LOCAL_487
/* local 487s have been deprecated -- it better handles
* race conditions (UAS sending 200); hopefully there are
* no longer UACs who go crazy waiting for the 487 whose
* forwarding is being blocked by other unresponsive branch
*/
/* we could await downstream UAS's 487 replies; however,
if some of the branches does not do that, we could wait
long time and annoy upstream UAC which wants to see
a result of CANCEL quickly
*/
DBG("DEBUG: e2e_cancel: sending 487\n");
/* in case that something in the meantime has been sent upstream
(like if FR hit at the same time), don't try to send */
if (t_invite->uas.status>=200) return;
/* there is still a race-condition -- the FR can hit now; that's
not too bad -- we take care in t_reply's REPLY_LOCK; in
the worst case, both this t_reply and other replier will
try, and the later one will result in error message
"can't reply twice"
*/
t_reply(t_invite, t_invite->uas.request, 487, CANCELED );
#endif
}
/* Suspends the transaction for later use.
* Save the returned hash_index and label to get
* back to the SIP request processing, see the readme.
*
* Return value:
* 0 - success
* <0 - failure
*/
int t_suspend(struct sip_msg *msg,
unsigned int *hash_index, unsigned int *label)
{
struct cell *t;
int branch;
int sip_msg_len;
t = get_t();
if (!t || t == T_UNDEFINED) {
LM_ERR("transaction has not been created yet\n");
return -1;
}
if (t->flags & T_CANCELED) {
/* The transaction has already been canceled */
LM_DBG("trying to suspend an already canceled transaction\n");
ser_error = E_CANCELED;
return 1;
}
if (t->uas.status >= 200) {
LM_DBG("trasaction sent out a final response already - %d\n",
t->uas.status);
return -3;
}
if (msg->first_line.type != SIP_REPLY) {
/* send a 100 Trying reply, because the INVITE processing
will probably take a long time */
if (msg->REQ_METHOD==METHOD_INVITE && (t->flags&T_AUTO_INV_100)
&& (t->uas.status < 100)
) {
if (!t_reply( t, msg , 100 ,
cfg_get(tm, tm_cfg, tm_auto_inv_100_r)))
LM_DBG("suspending request processing - sending 100 reply\n");
}
if ((t->nr_of_outgoings==0) && /* if there had already been
an UAC created, then the lumps were
saved as well */
save_msg_lumps(t->uas.request, msg)
) {
LM_ERR("failed to save the message lumps\n");
return -1;
}
/* save the message flags */
t->uas.request->flags = msg->flags;
/* add a blind UAC to let the fr timer running */
if (add_blind_uac() < 0) {
LM_ERR("failed to add the blind UAC\n");
return -1;
}
/* propagate failure route to new branch
* - failure route to be executed if the branch is not continued
* before timeout */
t->uac[t->async_backup.blind_uac].on_failure = t->on_failure;
t->flags |= T_ASYNC_SUSPENDED;
} else {
LM_DBG("this is a suspend on reply - setting msg flag to SUSPEND\n");
msg->msg_flags |= FL_RPL_SUSPENDED;
/* this is a reply suspend find which branch */
if (t_check( msg , &branch )==-1){
LOG(L_ERR, "ERROR: t_suspend_reply: " \
"failed find UAC branch\n");
return -1;
}
LM_DBG("found a a match with branch id [%d] - "
"cloning reply message to t->uac[branch].reply\n", branch);
sip_msg_len = 0;
t->uac[branch].reply = sip_msg_cloner( msg, &sip_msg_len );
if (! t->uac[branch].reply ) {
LOG(L_ERR, "can't alloc' clone memory\n");
return -1;
}
t->uac[branch].end_reply = ((char*)t->uac[branch].reply) + sip_msg_len;
LM_DBG("saving transaction data\n");
t->uac[branch].reply->flags = msg->flags;
t->flags |= T_ASYNC_SUSPENDED;
}
*hash_index = t->hash_index;
*label = t->label;
/* backup some extra info that can be used in continuation logic */
t->async_backup.backup_route = get_route_type();
t->async_backup.backup_branch = get_t_branch();
t->async_backup.ruri_new = ruri_get_forking_state();
return 0;
}
int t_relay_to( struct sip_msg *p_msg , struct proxy_l *proxy, int flags)
{
int ret;
int new_tran;
int reply_ret;
struct cell *t;
context_p ctx_backup;
ret=0;
new_tran = t_newtran( p_msg, 1/*full UAS cloning*/ );
/* parsing error, memory alloc, whatever ... */
if (new_tran<0) {
ret = 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) {
LM_DBG("forwarding ACK\n");
/* send it out */
if (proxy==0) {
proxy=uri2proxy(GET_NEXT_HOP(p_msg),
p_msg->force_send_socket ?
p_msg->force_send_socket->proto : 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;
if (flags&TM_T_REPLY_reason_FLAG) t->flags|=T_CANCEL_REASON_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)) ) {
ctx_backup = current_processing_ctx;
current_processing_ctx = NULL;
t_reply( t, p_msg , 100 , &relay_reason_100);
current_processing_ctx = ctx_backup;
}
/* now go ahead and forward ... */
ret=t_forward_nonack( t, p_msg, proxy);
if (ret<=0) {
LM_DBG("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 */
LM_DBG("generation of a stateful reply on error succeeded\n");
ret=0;
} else {
LM_DBG("generation of a stateful reply on error failed\n");
}
}
} else {
LM_DBG("new transaction fwd'ed\n");
}
done:
return ret;
}
void e2e_cancel( struct sip_msg *cancel_msg,
struct cell *t_cancel, struct cell *t_invite )
{
branch_bm_t cancel_bm;
branch_bm_t dummy_bm;
int i;
int lowest_error;
str backup_uri;
int rurib_flags;
int ret;
cancel_bm=0;
lowest_error=0;
/* e2e_cancel_branch() makes no RURI parsing, so no need to
* save the ->parse_uri_ok */
backup_uri = cancel_msg->new_uri;
/* branch flags specific to RURI */
rurib_flags = cancel_msg->flags&(~gflags_mask);
/* determine which branches to cancel ... */
which_cancel( t_invite, &cancel_bm );
t_cancel->nr_of_outgoings=t_invite->nr_of_outgoings;
t_cancel->first_branch=t_invite->first_branch;
/* fix label -- it must be same for reply matching */
t_cancel->label=t_invite->label;
/* ... and install CANCEL UACs */
for (i=t_invite->first_branch; i<t_invite->nr_of_outgoings; i++) {
if (cancel_bm & (1<<i)) {
ret=e2e_cancel_branch(cancel_msg, t_cancel, t_invite, i);
if (ret<0) cancel_bm &= ~(1<<i);
if (ret<lowest_error) lowest_error=ret;
}
}
/* restore new_uri */
cancel_msg->new_uri = backup_uri;
cancel_msg->parsed_uri_ok = 0;
/* set flags */
cancel_msg->flags = (cancel_msg->flags&gflags_mask)|rurib_flags;
t_cancel->uas.request->flags = cancel_msg->flags&gflags_mask;
/* send them out */
for (i=t_cancel->first_branch; i<t_cancel->nr_of_outgoings; i++) {
if (cancel_bm & (1<<i)) {
if (SEND_BUFFER( &t_cancel->uac[i].request)==-1) {
LOG(L_ERR, "ERROR: e2e_cancel: send failed\n");
}
start_retr( &t_cancel->uac[i].request );
}
}
/* internally cancel branches with no received reply */
for (i=t_invite->first_branch; i<t_invite->nr_of_outgoings; i++) {
if (t_invite->uac[i].last_received==0){
/* mark as cancelled */
t_invite->uac[i].flags |= T_UAC_TO_CANCEL_FLAG;
/* reset the "request" timers */
reset_timer(&t_invite->uac[i].request.retr_timer);
reset_timer(&t_invite->uac[i].request.fr_timer);
LOCK_REPLIES( t_invite );
if (RPS_ERROR==relay_reply(t_invite,FAKED_REPLY,i,487,&dummy_bm))
lowest_error = -1; /* force sending 500 error */
}
}
/* do not attmpt to send reply for CANCEL if we already did it once;
* to work arround the race between receiveing reply and generating
* local reply, we better check if we are in failure route (which means that
* the reply to UAC is /to be/ sent) or if was actually sent out */
/* calling here t_relay from within failure route will lead to dead lock
* on the transaction's reply lock -bogdan */
if (route_type==FAILURE_ROUTE || t_cancel->uas.status>=200)
return;
/* if error occurred, let it know upstream (final reply
will also move the transaction on wait state
*/
if (lowest_error<0) {
LOG(L_ERR, "ERROR: cancel error\n");
t_reply( t_cancel, cancel_msg, 500, "cancel error");
/* if there are pending branches, let upstream know we
are working on it
*/
} else if (cancel_bm) {
DBG("DEBUG: e2e_cancel: e2e cancel proceeding\n");
t_reply( t_cancel, cancel_msg, 200, CANCELING );
/* if the transaction exists, but there is no more pending
branch, tell upstream we're done
*/
} else {
DBG("DEBUG: e2e_cancel: e2e cancel -- no more pending branches\n");
t_reply( t_cancel, cancel_msg, 200, CANCEL_DONE );
}
#ifdef LOCAL_487
/* local 487s have been deprecated -- it better handles
* race conditions (UAS sending 200); hopefully there are
* no longer UACs who go crazy waiting for the 487 whose
* forwarding is being blocked by other unresponsive branch
*/
/* we could await downstream UAS's 487 replies; however,
if some of the branches does not do that, we could wait
long time and annoy upstream UAC which wants to see
a result of CANCEL quickly
*/
DBG("DEBUG: e2e_cancel: sending 487\n");
/* in case that something in the meantime has been sent upstream
(like if FR hit at the same time), don't try to send */
if (t_invite->uas.status>=200) return;
/* there is still a race-condition -- the FR can hit now; that's
not too bad -- we take care in t_reply's REPLY_LOCK; in
the worst case, both this t_reply and other replier will
try, and the later one will result in error message
"can't reply twice"
*/
t_reply(t_invite, t_invite->uas.request, 487, CANCELED );
#endif
}
/* WARNING: doesn't work from failure route (deadlock, uses t_reply => tries
* to get the reply lock again */
int t_relay_to( struct sip_msg *p_msg , struct proxy_l *proxy, int proto,
int replicate)
{
int ret;
int new_tran;
int reply_ret;
/* struct hdr_field *hdr; */
struct cell *t;
struct dest_info dst;
unsigned short port;
str host;
short comp;
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
MMA: return value E_SCRIPT means that transaction was already started from the script
so continue with that transaction
*/
if (new_tran!=E_SCRIPT) {
if (new_tran<0) {
ret = (ser_error==E_BAD_VIA && reply_to_via) ? 0 : new_tran;
goto done;
}
/* if that was a retransmission, return we are happily done */
if (new_tran==0) {
ret = 1;
goto done;
}
}
/* new transaction */
/* ACKs do not establish a transaction and are fwd-ed statelessly */
if ( p_msg->REQ_METHOD==METHOD_ACK) {
DBG( "SER: forwarding ACK statelessly \n");
if (proxy==0) {
init_dest_info(&dst);
dst.proto=proto;
if (get_uri_send_info(GET_NEXT_HOP(p_msg), &host, &port,
&dst.proto, &comp)!=0){
ret=E_BAD_ADDRESS;
goto done;
}
#ifdef USE_COMP
dst.comp=comp;
#endif
/* dst->send_sock not set, but forward_request will take care
* of it */
ret=forward_request(p_msg, &host, port, &dst);
} else {
init_dest_info(&dst);
dst.proto=get_proto(proto, proxy->proto);
proxy2su(&dst.to, proxy);
/* dst->send_sock not set, but forward_request will take care
* of it */
ret=forward_request( p_msg , 0, 0, &dst) ;
}
goto done;
}
/* if replication flag is set, mark the transaction as local
so that replies will not be relayed */
t=get_t();
if (replicate) t->flags|=T_IS_LOCAL_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 )
{
DBG( "SER: new INVITE\n");
if (!t_reply( t, p_msg , 100 ,
"trying -- your call is important to us"))
DBG("SER: ERROR: t_reply (100)\n");
}
/* now go ahead and forward ... */
ret=t_forward_nonack(t, p_msg, proxy, proto);
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 (!replicate) {
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; -- we don't want to stop the script */
} else {
DBG("ERROR: generation of a stateful reply "
"on error failed\n");
t_release_transaction(t);
}
}else{
t_release_transaction(t); /* kill it silently */
}
} else {
DBG( "SER: new transaction fwd'ed\n");
}
done:
return ret;
}
int t_relay_to( struct sip_msg *p_msg , struct proxy_l *proxy, int proto,
int replicate)
{
int ret;
int new_tran;
str *uri;
int reply_ret;
/* struct hdr_field *hdr; */
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, return we are happily done */
if (new_tran==0) {
ret = 1;
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 statelessly \n");
if (proxy==0) {
uri = GET_RURI(p_msg);
proxy=uri2proxy(GET_NEXT_HOP(p_msg), proto);
if (proxy==0) {
ret=E_BAD_ADDRESS;
goto done;
}
proto=proxy->proto; /* uri2proxy set it correctly */
ret=forward_request( p_msg , proxy, proto) ;
free_proxy( proxy );
pkg_free( proxy );
} else {
proto=get_proto(proto, proxy->proto);
ret=forward_request( p_msg , proxy, proto ) ;
}
goto done;
}
/* if replication flag is set, mark the transaction as local
so that replies will not be relaied */
t=get_t();
if (replicate) t->flags|=T_IS_LOCAL_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 )
{
DBG("DEBUG:tm:t_relay: new INVITE\n");
if (!t_reply( t, p_msg , 100 ,
"trying -- your call is important to us"))
DBG("SER: ERROR: t_reply (100)\n");
}
/* now go ahead and forward ... */
ret=t_forward_nonack(t, p_msg, proxy, proto);
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 (!replicate) {
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( "SER: new transaction fwd'ed\n");
}
done:
return ret;
}
