1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743
|
/*
* $Id: t_reply.c,v 1.28 2006/06/27 14:58:33 bogdan_iancu Exp $
*
* 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-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, updated 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)
* 2003-09-11 updates to new build_res_buf_from_sip_req() interface (bogdan)
* 2003-09-11 t_reply_with_body() reshaped to use reply_lumps +
* build_res_buf_from_sip_req() instead of
* build_res_buf_with_body_from_sip_req() (bogdan)
* 2003-11-05 flag context updated from failure/reply handlers back
* to transaction context (jiri)
* 2003-11-11: build_lump_rpl() removed, add_lump_rpl() has flags (bogdan)
* 2003-12-04 global TM callbacks switched to per transaction callbacks
* (bogdan)
* 2004-02-06: support for user pref. added - destroy_avps (bogdan)
* 2003-11-05 flag context updated from failure/reply handlers back
* to transaction context (jiri)
* 2003-11-11: build_lump_rpl() removed, add_lump_rpl() has flags (bogdan)
* 2004-02-13: t->is_invite and t->local replaced with flags (bogdan)
* 2004-02-18 fifo_t_reply imported from vm module (bogdan)
* 2004-08-23 avp list is available from failure/on_reply routes (bogdan)
* 2004-10-01 added a new param.: restart_fr_on_each_reply (andrei)
* 2005-03-01 force for statefull replies the incoming interface of
* the request (bogdan)
* 2005-03-01 local ACK sent to same address as INVITE ->
* all [build|send]_[local]_ack functions merged into
* send_ack() (bogdan)
*/
#include "../../hash_func.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 "../../data_lump_rpl.h"
#include "../../usr_avp.h"
#include "../../fifo_server.h"
#include "../../unixsock_server.h"
#include "h_table.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"
#include "uac.h"
/* restart fr timer on each provisional reply, default yes */
int restart_fr_on_each_reply=1;
/* private place where we create to-tags for replies */
char tm_tags[TOTAG_VALUE_LEN];
static str tm_tag = {tm_tags,TOTAG_VALUE_LEN};
char *tm_tag_suffix;
static int picked_branch=-1;
/* 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;
/* returns the picked branch */
int t_get_picked_branch()
{
return picked_branch;
}
/* 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_relay is called
*/
void t_on_negative( unsigned int go_to )
{
struct cell *t = get_t();
/* in MODE_REPLY and MODE_ONFAILURE T will be set to current transaction;
* in MODE_REQUEST T will be set only if the transaction was already
* created; if not -> use the static variable */
if (!t || t==T_UNDEFINED )
goto_on_negative=go_to;
else
t->on_negative = go_to;
}
void t_on_reply( unsigned int go_to )
{
struct cell *t = get_t();
/* in MODE_REPLY and MODE_ONFAILURE T will be set to current transaction;
* in MODE_REQUEST T will be set only if the transaction was already
* created; if not -> use the static variable */
if (!t || t==T_UNDEFINED )
goto_on_reply=go_to;
else
t->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,
"OpenSER-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_F,0)==-1 ||
!ack->to ) {
LOG(L_ERR, "ERROR: unmatched_totag: 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) {
DBG("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 retransmission\n");
#else
DBG("DEBUG: update_totag_set: totag retransmission\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;
}
/*
* Build and send an ACK to a negative reply
*/
static int send_ack(struct sip_msg* rpl, struct cell *trans, int branch)
{
str to;
char *ack_p;
unsigned int ack_len;
if (parse_headers( rpl, is_local(trans)?HDR_EOH_F:HDR_TO_F, 0)==-1
|| !rpl->to ) {
LOG(L_ERR, "ERROR:tm:send_ack: "
"cannot generate a HBH ACK if key HFs in reply missing\n");
goto error;
}
to.s=rpl->to->name.s;
to.len=rpl->to->len;
ack_p = is_local(trans)?
build_dlg_ack(rpl, trans, branch, &to, &ack_len):
build_local( trans, branch, &ack_len, ACK, ACK_LEN, &to );
if (ack_p==0) {
LOG(L_ERR, "ERROR:tm:send_ack: failed to build ACK\n");
goto error;
}
SEND_PR_BUFFER(&trans->uac[branch].request, ack_p, ack_len);
shm_free(ack_p);
return 0;
error:
return -1;
}
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:tm:_reply_light: response building failed\n");
/* determine if there are some branches to be canceled */
if ( is_invite(trans) ) {
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 ( is_invite(trans) ) which_cancel(trans, &cancel_bitmap );
if (trans->uas.status>=200) {
LOG( L_ERR, "ERROR:tm: _reply_light: 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.s ? len : len + REPLY_OVERBUFFER_LEN;
rb->buffer.s = (char*)shm_resize( rb->buffer.s, buf_len );
/* puts the reply's buffer to uas.response */
if (! rb->buffer.s ) {
LOG(L_ERR,"ERROR:tm:_reply_light: cannot allocate shmem buffer\n");
goto error3;
}
update_local_tags(trans, bm, rb->buffer.s, buf);
rb->buffer.len = len ;
memcpy( rb->buffer.s , buf , len );
/* needs to be protected too because what timers are set depends
on current transactions status */
/* t_update_timers_after_sending_reply( rb ); */
trans->relaied_reply_branch=-2;
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 ( is_local(trans) ) {
DBG("DEBUG:tm:_reply_light: local transaction completed\n");
if ( has_tran_tmcbs(trans, TMCB_LOCAL_COMPLETED) ) {
run_trans_callbacks( TMCB_LOCAL_COMPLETED, trans,
0, FAKED_REPLY, code);
}
} else {
if ( has_tran_tmcbs(trans, TMCB_RESPONSE_OUT) ) {
set_extra_tmcb_params( &rb->buffer, &rb->dst);
run_trans_callbacks( TMCB_RESPONSE_OUT, trans,
trans->uas.request, FAKED_REPLY, code);
}
}
if (!is_hopbyhop_cancel(trans)) {
cleanup_uac_timers( trans );
if (is_invite(trans)) cancel_uacs( trans, cancel_bitmap );
set_final_timer( trans );
}
}
/* send it out : response.dst.send_sock is valid all the time now,
* as it's taken from original request -bogdan */
if (!trans->uas.response.dst.send_sock) {
LOG(L_CRIT,"BUG:tm:_reply_light: send_sock is NULL\n");
}
SEND_PR_BUFFER( rb, buf, len );
DBG("DEBUG:tm:_reply_light: reply sent out. buf=%p: %.9s..., "
"shmem=%p: %.9s\n", buf, buf, rb->buffer.s, rb->buffer.s );
pkg_free( buf ) ;
stats_trans_rpl( code, 1 /*local*/ );
DBG("DEBUG:tm:_reply_light: finished\n");
return 1;
error3:
error2:
if (lock) UNLOCK_REPLIES( trans );
pkg_free ( buf );
error:
/* do UAC cleanup */
cleanup_uac_timers( trans );
if ( is_invite(trans) ) 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, *dset;
struct bookmark bm;
int dset_len;
if (code>=200) set_kr(REQ_RPLD);
/* compute the buffer in private memory prior to entering lock;
* create to-tag if needed */
/* if that is a redirection message, dump current message set to it */
if (code>=300 && code<400) {
dset=print_dset(p_msg, &dset_len);
if (dset) {
add_lump_rpl(p_msg, dset, dset_len, LUMP_RPL_HDR);
}
}
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_tag, p_msg, &len, &bm);
return _reply_light( trans, buf, len, code, text,
tm_tag.s, TOTAG_VALUE_LEN, lock, &bm);
} else {
buf = build_res_buf_from_sip_req(code,text, 0 /*no to-tag*/,
p_msg, &len, &bm);
return _reply_light(trans,buf,len,code,text,
0, 0, /* no to-tag */lock, &bm);
}
}
/*if msg is set -> it will fake the env. vars conforming with the msg; if NULL
* the env. will be restore to original */
static inline void faked_env( struct cell *t,struct sip_msg *msg)
{
static struct cell *backup_t;
static unsigned int backup_msgid;
static struct usr_avp **backup_list;
static struct socket_info* backup_si;
static int backup_route_type;
if (msg) {
swap_route_type( backup_route_type, FAILURE_ROUTE);
/* tm actions look in beginning whether transaction 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 = msg->id;
set_t(t);
/* make available the avp list from transaction */
backup_list = set_avp_list( &t->user_avps );
/* set default send address to the saved value */
backup_si = bind_address;
bind_address = t->uac[0].request.dst.send_sock;
} else {
/* restore original environment */
set_t(backup_t);
global_msg_id = backup_msgid;
set_route_type( backup_route_type );
/* restore original avp list */
set_avp_list( backup_list );
bind_address = backup_si;
}
}
static inline int fake_req(struct sip_msg *faked_req, struct sip_msg *shm_msg,
struct ua_server *uas, struct ua_client *uac)
{
/* 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( faked_req, shm_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 */
faked_req->id=shm_msg->id-1;
/* msg->parsed_uri_ok must be reset since msg_parsed_uri is
* not cloned (and cannot be cloned) */
faked_req->parsed_uri_ok = 0;
/* new_uri can change -- make a private copy */
faked_req->new_uri.s=pkg_malloc( uac->uri.len+1 );
if (!faked_req->new_uri.s) {
LOG(L_ERR, "ERROR:tm:fake_req: no uri/pkg mem\n");
goto error;
}
faked_req->new_uri.len = uac->uri.len;
memcpy( faked_req->new_uri.s, uac->uri.s, uac->uri.len);
faked_req->new_uri.s[faked_req->new_uri.len]=0;
/* dst_set is imposible to restore (since it's not saved),
* so let it set to NULL */
/* set as flags the global flags and the flags from the elected branch */
faked_req->flags = uas->request->flags | uac->br_flags;
return 1;
error:
return 0;
}
void inline static free_faked_req(struct sip_msg *faked_req, struct cell *t)
{
struct hdr_field *hdr;
if (faked_req->new_uri.s) {
pkg_free(faked_req->new_uri.s);
faked_req->new_uri.s = 0;
}
/* free all types of lump that were added in failure handlers */
del_notflaged_lumps( &(faked_req->add_rm), LUMPFLAG_SHMEM );
del_notflaged_lumps( &(faked_req->body_lumps), LUMPFLAG_SHMEM );
del_nonshm_lump_rpl( &(faked_req->reply_lump) );
/* free header's parsed structures that were added by failure handlers */
for( hdr=faked_req->headers ; hdr ; hdr=hdr->next ) {
if ( hdr->parsed && hdr_allocs_parse(hdr) &&
(hdr->parsed<(void*)t->uas.request ||
hdr->parsed>=(void*)t->uas.end_request)) {
/* header parsed filed doesn't point inside uas.request memory
* chunck -> it was added by failure funcs.-> free it as pkg */
DBG("DBG:free_faked_req: removing hdr->parsed %d\n",
hdr->type);
clean_hdr_field(hdr);
hdr->parsed = 0;
}
}
}
/* return 1 if a failure_route processes */
static inline int run_failure_handlers(struct cell *t)
{
static struct sip_msg faked_req;
struct sip_msg *shmem_msg;
struct ua_client *uac;
int on_failure;
shmem_msg = t->uas.request;
uac = &t->uac[picked_branch];
/* failure_route for a local UAC? */
if (!shmem_msg || REQ_LINE(shmem_msg).method_value==METHOD_CANCEL ) {
LOG(L_WARN,"WARNING:tm:run_failure_handlers: no UAC or CANCEL "
"support (%d, %d) \n", t->on_negative, t->tmcb_hl.reg_types);
return 0;
}
/* don't start faking anything if we don't have to */
if ( !has_tran_tmcbs( t, TMCB_ON_FAILURE) && !t->on_negative ) {
LOG(L_WARN,
"Warning: run_failure_handlers: no negative handler (%d, %d)\n",
t->on_negative,
t->tmcb_hl.reg_types);
return 1;
}
if (!fake_req(&faked_req, shmem_msg, &t->uas, uac)) {
LOG(L_ERR, "ERROR: run_failure_handlers: fake_req failed\n");
return 0;
}
/* fake also the env. conforming to the fake msg */
faked_env( t, &faked_req);
/* DONE with faking ;-) -> run the failure handlers */
if ( has_tran_tmcbs( t, TMCB_ON_FAILURE) ) {
run_trans_callbacks( TMCB_ON_FAILURE, t, &faked_req,
uac->reply, uac->last_received);
}
if (t->on_negative) {
/* avoid recursion -- if failure_route forwards, and does not
* set next failure route, failure_route will not be reentered
* on failure */
on_failure = t->on_negative;
t->on_negative=0;
/* run a reply_route action if some was marked */
run_top_route(failure_rlist[on_failure], &faked_req);
}
/* restore original environment and free the fake msg */
faked_env( t, 0);
free_faked_req(&faked_req,t);
/* if failure handler changed flag, update transaction context */
shmem_msg->flags = faked_req.flags & gflags_mask;
return 1;
}
/* select a branch for forwarding; returns:
* 0..X ... branch number
* -1 ... error
* -2 ... can't decide yet -- incomplete branches present
*/
static inline int t_pick_branch( struct cell *t, int *res_code)
{
int lowest_b, lowest_s, b;
int cancelled;
lowest_b=-1; lowest_s=999;
cancelled = (t->flags&T_WAS_CANCELLED_FLAG);
for ( b=t->first_branch; b<t->nr_of_outgoings ; b++ ) {
/* skip 'empty branches' */
if (!t->uac[b].request.buffer.s) continue;
/* there is still an unfinished UAC transaction; wait now! */
if ( t->uac[b].last_received<200 )
return -2;
/* replyes to cancel has max priority */
if ( (cancelled && t->uac[b].last_received==487) ||
(t->uac[b].last_received<lowest_s && (lowest_s!=487 || !cancelled))) {
lowest_b =b;
lowest_s = t->uac[b].last_received;
}
} /* find lowest branch */
DBG("DEBUG:tm:t_pick_branch: picked branch %d, code %d\n",
lowest_b,lowest_s);
*res_code=lowest_s;
return lowest_b;
}
/* This is the neurological 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
* transaction 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_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("DEBUG:tm:t_should_relay_response: T_code=%d, new_code=%d\n",
Trans->uas.status,new_code);
inv_through=new_code>=200 && new_code<300 && is_invite(Trans);
/* if final response sent out, allow only INVITE 2xx */
if ( Trans->uas.status >= 200 ) {
if (inv_through) {
DBG("DEBUG:tm:t_should_relay_response: 200 OK for INVITE "
"after final sent\n");
*should_store=0;
Trans->uac[branch].last_received=new_code;
*should_relay=branch;
return RPS_PUSHED_AFTER_COMPLETION;
}
if ( is_hopbyhop_cancel(Trans) && new_code>=200) {
*should_store=0;
*should_relay=-1;
picked_branch=-1;
return RPS_COMPLETED;
}
/* 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)) {
#ifdef EXTRA_DEBUG
/* don't report on retransmissions */
if (Trans->uac[branch].last_received==new_code) {
DBG("DEBUG:tm:t_should_relay_response: final reply "
"retransmission\n");
} else
/* if you FR-timed-out, faked a local 408 and 487 came, don't
* report on it either */
if (Trans->uac[branch].last_received==408 && new_code==487) {
DBG("DEBUG:tm:t_should_relay_response: 487 reply came for a "
"timed-out branch\n");
} else {
/* this looks however how a very strange status rewrite attempt;
* report on it */
DBG("DEBUG:tm:t_should_relay_response: status rewrite by UAS: "
"stored: %d, received: %d\n",
Trans->uac[branch].last_received, new_code );
}
#endif
goto discard;
}
/* no final response sent yet */
/* negative replies subject to fork picking */
if (new_code >=300 ) {
Trans->uac[branch].last_received=new_code;
/* also append the current reply to the transaction to
* make it available in failure routes - a kind of "fake"
* save of the final reply per branch */
Trans->uac[branch].reply = reply;
/* if all_final return lowest */
picked_branch = t_pick_branch( Trans, &picked_code);
if (picked_branch==-2) { /* branches open yet */
*should_store=1;
*should_relay=-1;
picked_branch=-1;
return RPS_STORE;
}
if (picked_branch==-1) {
LOG(L_CRIT, "ERROR:tm:t_should_relay_response: pick_branch failed "
"(lowest==-1) for code %d\n",new_code);
goto discard;
}
/* no more pending branches -- try if that changes after
* a callback; save branch count to be able to determine
* later if new branches were initiated */
branch_cnt=Trans->nr_of_outgoings;
/* run ON_FAILURE handlers ( route and callbacks) */
if ( has_tran_tmcbs( Trans, TMCB_ON_FAILURE) || Trans->on_negative ) {
run_failure_handlers( Trans );
}
/* now reset it; after the failure logic, the reply may
* not be stored any more and we don't want to keep into
* transaction some broken reference */
Trans->uac[branch].reply = 0;
/* 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
*/
picked_branch=-1;
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;
picked_branch=-1;
return RPS_STORE;
}
/* really no more pending branches -- return selected code */
*should_store=0;
*should_relay=picked_branch;
picked_branch=-1;
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;
}
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;
/* we need to lock the transaction as messages from
upstream may change it continuously */
LOCK_REPLIES( t );
if (!t->uas.response.buffer.s) {
DBG("DEBUG:tm:t_retransmit_reply: nothing to retransmit\n");
goto error;
}
/* response.dst.send_sock should be valid all the time now, as it's taken
from original request -bogdan */
if (t->uas.response.dst.send_sock==0) {
LOG(L_CRIT,"BUG:tm:t_retransmit_reply: something to retransmit, but"
"send_sock is NULL\n");
goto error;
}
len=t->uas.response.buffer.len;
if ( len==0 || len>BUF_SIZE ) {
DBG("DEBUG:tm:t_retransmit_reply: zero length or too big "
"to retransmit: %d\n", len);
goto error;
}
memcpy( b, t->uas.response.buffer.s, len );
UNLOCK_REPLIES( t );
SEND_PR_BUFFER( & t->uas.response, b, len );
DBG("DEBUG:tm:t_retransmit_reply: buf=%p: %.9s..., shmem=%p: %.9s\n",
b, b, t->uas.response.buffer.s, t->uas.response.buffer.s );
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 ( !is_local(t) && 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=t->first_branch; 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_uac_timers: 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 conserve
it in shared memory; -jiri
*/
if (rpl==FAKED_REPLY)
trans->uac[branch].reply=FAKED_REPLY;
else
trans->uac[branch].reply = sip_msg_cloner( rpl, 0 );
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:tm: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
&& has_tran_tmcbs(t,TMCB_RESPONSE_FWDED) ) {
run_trans_callbacks( TMCB_RESPONSE_FWDED, t, t->uas.request,
p_msg, msg_status );
}
/* try building 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) {
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_tag,
t->uas.request, &res_len, &bm );
} else {
buf = build_res_buf_from_sip_req( relayed_code,
error_text(relayed_code), 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_clen_lump(&relayed_msg->add_rm);
}
}
if (!buf) {
LOG(L_ERR, "ERROR:tm: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 provisional as
larger messages are likely to follow and we will be
able to reuse the memory frag
*/
uas_rb->buffer.s = (char*)shm_resize( uas_rb->buffer.s, res_len +
(msg_status<200 ? REPLY_OVERBUFFER_LEN : 0));
if (!uas_rb->buffer.s) {
LOG(L_ERR, "ERROR:tm:relay_reply: cannot alloc reply shmem\n");
goto error03;
}
uas_rb->buffer.len = res_len;
memcpy( uas_rb->buffer.s, buf, res_len );
if (relayed_msg==FAKED_REPLY) { /* to-tags for local replies */
update_local_tags(t, &bm, uas_rb->buffer.s, buf);
}
stats_trans_rpl( relayed_code, (relayed_msg==FAKED_REPLY)?1:0 );
/* update the status ... */
t->uas.status = relayed_code;
t->relaied_reply_branch = relay;
if (is_invite(t) && relayed_msg!=FAKED_REPLY
&& relayed_code>=200 && relayed_code < 300
&& has_tran_tmcbs( t, TMCB_RESPONSE_OUT|TMCB_E2EACK_IN) ) {
totag_retr=update_totag_set(t, relayed_msg);
}
}; /* if relay ... */
UNLOCK_REPLIES( t );
/* Setup retransmission timer _before_ the reply is sent
* to avoid race conditions
*/
if (reply_status == RPS_COMPLETED) {
set_final_timer(t);
}
/* send it now (from the private buffer) */
if (relay >= 0) {
SEND_PR_BUFFER( uas_rb, buf, res_len );
DBG("DEBUG:tm:relay_reply: sent buf=%p: %.9s..., shmem=%p: %.9s\n",
buf, buf, uas_rb->buffer.s, uas_rb->buffer.s );
if (!totag_retr && has_tran_tmcbs(t, TMCB_RESPONSE_OUT) ) {
set_extra_tmcb_params( &uas_rb->buffer, &uas_rb->dst);
run_trans_callbacks( TMCB_RESPONSE_OUT, t, t->uas.request,
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 (is_invite(t)) cancel_uacs( t, *cancel_bitmap );
/* a serious error occurred -- 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:tm: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) {
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;
stats_trans_rpl( winning_code, (winning_msg==FAKED_REPLY)?1:0 );
if (is_invite(t) && winning_msg!=FAKED_REPLY
&& winning_code>=200 && winning_code <300
&& has_tran_tmcbs(t,TMCB_RESPONSE_OUT|TMCB_E2EACK_IN) ) {
totag_retr=update_totag_set(t, winning_msg);
}
}
UNLOCK_REPLIES(t);
if ( local_winner >= 0 ) {
if (winning_code < 200) {
if ( pass_provisional_replies ) {
if (!totag_retr && has_tran_tmcbs(t,TMCB_LOCAL_RESPONSE_OUT)) {
DBG("DEBUG: Passing provisional reply %d to FIFO "
"application\n", winning_code);
run_trans_callbacks( TMCB_LOCAL_RESPONSE_OUT, t, 0,
winning_msg, winning_code);
}
}
} else {
DBG("DEBUG:tm:local_reply: local transaction completed\n");
if (!totag_retr && has_tran_tmcbs(t,TMCB_LOCAL_COMPLETED) ) {
run_trans_callbacks( TMCB_LOCAL_COMPLETED, t, 0,
winning_msg, winning_code );
}
}
}
return reply_status;
error:
which_cancel(t, cancel_bitmap);
UNLOCK_REPLIES(t);
cleanup_uac_timers(t);
if ( get_cseq(p_msg)->method_id==METHOD_INVITE )
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;
int last_uac_status;
int branch;
int reply_status;
unsigned int timer;
/* has the transaction completed now and we need to clean-up? */
branch_bm_t cancel_bitmap;
struct ua_client *uac;
struct cell *t;
struct usr_avp **backup_list;
/* make sure we know the associated 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:tm:reply_received: org. status uas=%d, "
"uac[%d]=%d local=%d is_invite=%d)\n",
t->uas.status, branch, uac->last_received,
is_local(t), is_invite(t));
last_uac_status=uac->last_received;
if_update_stat( tm_enable_stats, tm_rcv_rpls , 1);
/* it's a cancel which is not e2e ? */
if ( get_cseq(p_msg)->method_id==METHOD_CANCEL && is_invite(t) ) {
/* ... then just stop timers */
reset_timer( &uac->local_cancel.retr_timer);
if ( msg_status >= 200 ) {
reset_timer( &uac->local_cancel.fr_timer);
}
DBG("DEBUG:tm:reply_received: 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 (is_invite(t) &&
((msg_status >= 300) || (is_local(t) && msg_status >= 200) )) {
if (send_ack(p_msg, t, branch)!=0)
LOG(L_ERR, "ERROR:tm:reply_received: failed to send ACK (local=%s)\n",
is_local(t)?"yes":"no");
}
/* processing of on_reply block */
if (t->on_reply) {
/* transfer transaction flag to branch context */
p_msg->flags = ((p_msg->flags | t->uas.request->flags) & gflags_mask) |
t->uac[branch].br_flags;
/* set the as avp_list the one from transaction */
backup_list = set_avp_list(&t->user_avps);
/* run block */
if ( (run_top_route(onreply_rlist[t->on_reply], p_msg)&ACT_FL_DROP) &&
(msg_status<200) ) {
DBG("DEBUG:tm:reply_received: dropping provisional reply %d\n",
msg_status);
goto done;
}
/* transfer current message context back to t */
t->uac[branch].br_flags = p_msg->flags & (~gflags_mask);
t->uas.request->flags = p_msg->flags & gflags_mask;
/* restore original avp list */
set_avp_list( backup_list );
}
/* lock the reply*/
LOCK_REPLIES( t );
/* mark that the UAC received replies */
uac->flags |= T_UAC_HAS_RECV_REPLY;
if (t->uac[branch].flags&T_UAC_TO_CANCEL_FLAG) {
/* reply for an UAC with a pending cancel -> do cancel now */
cancel_branch(t, branch);
/* reset flag */
t->uac[branch].flags &= ~(T_UAC_TO_CANCEL_FLAG);
}
if (is_local(t)) {
reply_status = local_reply(t,p_msg, branch,msg_status,&cancel_bitmap);
if (reply_status == RPS_COMPLETED) {
cleanup_uac_timers(t);
if (is_invite(t)) cancel_uacs(t, cancel_bitmap);
/* There is no need to call set_final_timer because we know
* that the transaction is local */
put_on_wait(t);
}
} else {
reply_status = relay_reply(t,p_msg,branch,msg_status,&cancel_bitmap);
/* 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 (is_invite(t)) cancel_uacs(t, cancel_bitmap);
/* FR for negative INVITES, WAIT anything else */
/* set_final_timer(t); */
}
}
if (reply_status == RPS_ERROR)
goto done;
/* update FR/RETR timers on provisional replies */
if (msg_status < 200 && (restart_fr_on_each_reply ||
((last_uac_status<msg_status) &&
((msg_status >= 180) || (last_uac_status == 0)))
) ) { /* provisional now */
if (is_invite(t)) {
/* invite: change FR to longer FR_INV, do not
* attempt to restart retransmission any more
*/
backup_list = set_avp_list(&t->user_avps);
if (!fr_inv_avp2timer(&timer)) {
DBG("DEBUG:tm:reply_received: FR_INV_TIMER = %d\n", timer);
set_timer(&uac->request.fr_timer,
FR_INV_TIMER_LIST, &timer);
t->flags |= T_NOISY_CTIMER_FLAG;
} else {
set_timer(& uac->request.fr_timer, FR_INV_TIMER_LIST, 0);
}
set_avp_list(backup_list);
} else {
/* non-invite: restart retransmissions (slow now) */
uac->request.retr_list = RT_T2;
set_timer(&uac->request.retr_timer, RT_T2, 0);
}
} /* provisional replies */
done:
/* we are done with the transaction, so unref it - the reference
* was incremented by t_check() function -bogdan*/
t_unref(p_msg);
/* don't try to relay statelessly neither on success
* (we forwarded statefully) 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 )
{
struct lump_rpl *hdr_lump;
struct lump_rpl *body_lump;
str s_to_tag;
str rpl;
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);
/* add the lumps for new_header and for body (by bogdan) */
if (new_header && strlen(new_header)) {
hdr_lump = add_lump_rpl( trans->uas.request, new_header,
strlen(new_header), LUMP_RPL_HDR );
if ( !hdr_lump ) {
LOG(L_ERR,"ERROR:tm:t_reply_with_body: cannot add hdr lump\n");
goto error;
}
} else {
hdr_lump = 0;
}
/* body lump */
if(body && strlen(body)) {
body_lump = add_lump_rpl( trans->uas.request, body, strlen(body),
LUMP_RPL_BODY );
if (body_lump==0) {
LOG(L_ERR,"ERROR:tm:t_reply_with_body: cannot add body lump\n");
goto error_1;
}
} else {
body_lump = 0;
}
rpl.s = build_res_buf_from_sip_req(
code, text, &s_to_tag,
trans->uas.request, (unsigned int*)&rpl.len, &bm);
/* since the msg (trans->uas.request) is a clone into shm memory, to avoid
* memory leak or crashing (lumps are create in private memory) I will
* remove the lumps by myself here (bogdan) */
if ( hdr_lump ) {
unlink_lump_rpl( trans->uas.request, hdr_lump);
free_lump_rpl( hdr_lump );
}
if( body_lump ) {
unlink_lump_rpl( trans->uas.request, body_lump);
free_lump_rpl( body_lump );
}
if (rpl.s==0) {
LOG(L_ERR,"ERROR:tm:t_reply_with_body: failed in doing "
"build_res_buf_from_sip_req()\n");
goto error;
}
DBG("DEBUG:tm:t_reply_with_body: buffer computed\n");
ret=_reply_light( trans, rpl.s, rpl.len, code, text,
s_to_tag.s, s_to_tag.len, 1 /* lock replies */, &bm );
/* unref since this it's used only internaly */
UNREF(trans);
return ret;
error_1:
if ( hdr_lump ) {
unlink_lump_rpl( trans->uas.request, hdr_lump);
free_lump_rpl( hdr_lump );
}
error:
return -1;
}
/*
Syntax:
":t_reply:[response file]\n
code\n
reason\n
trans_id\n
to_tag\n
[new headers]\n
\n
[Body]\n
.\n
\n"
*/
int fifo_t_reply( FILE *stream, char *response_file )
{
int ret;
struct cell *trans;
char code[16];
char reason[128];
char trans_id[128];
char new_headers[MAX_HEADER];
char body[MAX_BODY];
char to_tag[128];
str sc; /* code */
str sr; /* reason */
str sti; /* trans_id */
str snh; /* new_headers */
str sb; /* body */
str sttag; /* to-tag */
unsigned int hash_index,label,icode;
sc.s=code;
sr.s=reason;
sti.s=trans_id;
snh.s=new_headers; sb.s=body;
sttag.s=to_tag; sttag.len=0;
/* get the infos from FIFO server */
DBG("DEBUG: fifo_t_reply: ############### begin ##############\n");
if (!read_line(sc.s, 16, stream, &sc.len)||sc.len==0) {
LOG(L_ERR, "ERROR: fifo_t_reply: code expected\n");
fifo_reply(response_file, "400 fifo_t_reply: code expected");
return -1;
}
icode = str2s(sc.s,sc.len,&ret);
if(ret){
LOG(L_ERR, "ERROR: fifo_t_reply: code(int) has wrong format\n");
fifo_reply(response_file, "400 fifo_t_reply: code(int) has"
" wrong format");
return -1;
}
if(!read_line(sr.s, 128, stream, &sr.len)||sr.len==0){
LOG(L_ERR, "ERROR: fifo_t_reply: reason expected\n");
fifo_reply(response_file, "400 fifo_t_reply: reason expected");
return -1;
}
sr.s[sr.len]='\0';
if (!read_line(sti.s, 128, stream, &sti.len)||sti.len==0) {
LOG(L_ERR, "ERROR: fifo_t_reply: trans_id expected\n");
fifo_reply(response_file, "400 fifo_t_reply: trans_id expected");
return -1;
}
sti.s[sti.len]='\0';
DBG("DEBUG: fifo_t_reply: trans_id=%.*s\n",sti.len,sti.s);
if(sscanf(sti.s,"%u:%u", &hash_index, &label) != 2){
LOG(L_ERR, "ERROR: fifo_t_reply: invalid trans_id (%s)\n",sti.s);
fifo_reply(response_file, "400 fifo_t_reply: invalid trans_id");
return -1;
}
DBG("DEBUG: fifo_t_reply: hash_index=%u label=%u\n",hash_index,label);
if( !read_line(sttag.s,64,stream,&sttag.len) || sttag.len==0 ){
LOG(L_ERR, "ERROR: fifo_t_reply: to-tag expected\n");
fifo_reply(response_file, "400 fifo_t_reply: to-ta expected");
return -1;
}
sttag.s[sttag.len]='\0';
DBG("DEBUG: fifo_t_reply: to-tag: %.*s\n",sttag.len,sttag.s);
/* read the new headers */
if (!read_line_set(snh.s, MAX_HEADER, stream, &snh.len)) {
LOG(L_ERR, "ERROR: fifo_t_reply: while reading new headers\n");
fifo_reply(response_file, "400 fifo_t_reply: while reading "
"new headers");
return -1;
}
snh.s[snh.len]='\0';
DBG("DEBUG: fifo_t_reply: new headers: %.*s\n", snh.len, snh.s);
/* body can be empty ... */
read_body(sb.s, MAX_BODY, stream, &sb.len);
sb.s[sb.len]='\0';
DBG("DEBUG: fifo_t_reply: body: <%.*s>\n", sb.len, sb.s);
if( t_lookup_ident(&trans,hash_index,label)<0 ) {
LOG(L_ERR,"ERROR: fifo_t_reply: lookup failed\n");
fifo_reply(response_file, "481 fifo_t_reply: no such transaction");
return -1;
}
/* it's refcounted now, t_reply_with body unrefs for me -- I can
* continue but may not use T anymore */
ret = t_reply_with_body(trans,icode,reason,body,new_headers,to_tag);
if (ret<0) {
LOG(L_ERR, "ERROR: fifo_t_reply: reply failed\n");
fifo_reply(response_file, "500 fifo_t_reply: reply failed");
return -1;
}
fifo_reply(response_file, "200 fifo_t_reply succeeded\n");
DBG("DEBUG: fifo_t_reply: ################ end ##############\n");
return 1;
}
static int parse_transid(str* s, unsigned int* index, unsigned int* label)
{
char* buf;
if (!s || !index || !label) {
LOG(L_ERR, "ERROR:tm:parse_transid: Invalid parameter value\n");
return -1;
}
buf = (char*)pkg_malloc(s->len + 1);
if (!buf) {
LOG(L_ERR, "ERROR:tm:parse_transid: No memory left\n");
return -1;
}
memcpy(buf, s->s, s->len + 1);
buf[s->len] = '\0';
if (sscanf(buf, "%u:%u", index, label) != 2) {
LOG(L_ERR, "ERROR:tm:parse_transid: Invalid trans_id (%s)\n", buf);
pkg_free(buf);
return -1;
}
DBG("DEBUG:tm:parse_transid: hash_index=%u label=%u\n", *index, *label);
pkg_free(buf);
return 0;
}
static int send_reply(struct cell *trans, unsigned int code, str* text, str* body,
str* headers, str* to_tag)
{
struct lump_rpl *hdr_lump, *body_lump;
str rpl;
int ret;
struct bookmark bm;
/* mark the transaction as replied */
if (code >= 200) set_kr(REQ_RPLD);
/* add the lumps for new_header and for body (by bogdan) */
if (headers && headers->len) {
hdr_lump = add_lump_rpl(trans->uas.request, headers->s, headers->len,
LUMP_RPL_HDR);
if (!hdr_lump) {
LOG(L_ERR, "ERROR:tm:send_reply: cannot add hdr lump\n");
goto sr_error;
}
} else {
hdr_lump = 0;
}
/* body lump */
if (body && body->len) {
body_lump = add_lump_rpl(trans->uas.request, body->s, body->len,
LUMP_RPL_BODY);
if (body_lump == 0) {
LOG(L_ERR,"ERROR:tm:send_reply: cannot add body lump\n");
goto sr_error_1;
}
} else {
body_lump = 0;
}
/* We can safely zero-terminate the text here, because it is followed
* by next line in the received message */
text->s[text->len] = '\0';
rpl.s = build_res_buf_from_sip_req(code, text->s, to_tag,
trans->uas.request, (unsigned int*)&rpl.len, &bm);
/* since the msg (trans->uas.request) is a clone into shm memory, to avoid
* memory leak or crashing (lumps are create in private memory) I will
* remove the lumps by myself here (bogdan) */
if (hdr_lump) {
unlink_lump_rpl(trans->uas.request, hdr_lump);
free_lump_rpl(hdr_lump);
}
if (body_lump) {
unlink_lump_rpl(trans->uas.request, body_lump);
free_lump_rpl(body_lump);
}
if (rpl.s == 0) {
LOG(L_ERR,"ERROR:tm:send_reply: failed in build_res_buf_from_sip_req\n");
goto sr_error;
}
ret = _reply_light(trans, rpl.s, rpl.len, code, text->s,
to_tag->s, to_tag->len, 1 /* lock replies */, &bm);
/* unref since this it's used only internaly */
UNREF(trans);
return ret;
sr_error_1:
if (hdr_lump) {
unlink_lump_rpl(trans->uas.request, hdr_lump);
free_lump_rpl(hdr_lump);
}
sr_error:
return -1;
}
int unixsock_t_reply(str* msg)
{
int ret;
struct cell *trans;
static char new_headers[MAX_HEADER];
str code, reason, transid, headers, body, to_tag;
unsigned int hash_index, label, icode;
headers.s = new_headers;
headers.len = MAX_HEADER;
if (unixsock_read_line(&code, msg) != 0) {
unixsock_reply_asciiz("400 Reason code expected\n");
goto err;
}
icode = str2s(code.s, code.len, &ret);
if (ret) {
unixsock_reply_printf("400 Reason code has wrong format\n");
goto err;
}
if (unixsock_read_line(&reason, msg) != 0) {
unixsock_reply_asciiz("400 Reason phrase expected\n");
goto err;
}
if (unixsock_read_line(&transid, msg) != 0) {
unixsock_reply_asciiz("400 Transaction ID expected\n");
goto err;
}
if (parse_transid(&transid, &hash_index, &label) < 0) {
unixsock_reply_asciiz("400 Error while parsing transaction ID\n");
goto err;
}
if (unixsock_read_line(&to_tag, msg) != 0) {
unixsock_reply_asciiz("400 To tag expected\n");
goto err;
}
/* read the new headers */
if (unixsock_read_lineset(&headers, msg) < 0) {
unixsock_reply_asciiz("400 Error while reading new headers\n");
goto err;
}
DBG("lineset: %.*s\n", headers.len, headers.s);
/* body can be empty ... */
if (unixsock_read_body(&body, msg) < 0) {
unixsock_reply_asciiz("400 Error while reading body\n");
goto err;
}
DBG("body: %.*s\n", body.len, body.s);
if (t_lookup_ident(&trans, hash_index, label) < 0) {
LOG(L_ERR,"ERROR:tm:unixsock_t_reply: lookup failed\n");
unixsock_reply_asciiz("481 No such transaction\n");
goto err;
}
/* it's refcounted now, t_reply_with body unrefs for me -- I can
* continue but may not use T anymore
*/
ret = send_reply(trans, icode, &reason, &body, &headers, &to_tag);
if (ret < 0) {
LOG(L_ERR, "ERROR:tm:unixsock_t_reply: reply failed\n");
unixsock_reply_asciiz("500 Reply failed\n");
goto err;
}
unixsock_reply_asciiz("200 Succeeded\n");
unixsock_reply_send();
return 1;
err:
unixsock_reply_send();
return -1;
}
|