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 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438
|
/*
* SRT - Secure, Reliable, Transport
* Copyright (c) 2018 Haivision Systems Inc.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
*/
/*****************************************************************************
Copyright (c) 2001 - 2011, The Board of Trustees of the University of Illinois.
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:
* Redistributions of source code must retain the above
copyright notice, this list of conditions and the
following disclaimer.
* Redistributions in binary form must reproduce the
above copyright notice, this list of conditions
and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of the University of Illinois
nor the names of its contributors may be used to
endorse or promote products derived from this
software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*****************************************************************************/
/*****************************************************************************
written by
Yunhong Gu, last updated 03/12/2011
modified by
Haivision Systems Inc.
*****************************************************************************/
#include "platform_sys.h"
#include <cstring>
#include <cmath>
#include "buffer.h"
#include "packet.h"
#include "core.h" // provides some constants
#include "logging.h"
using namespace std;
using namespace srt_logging;
using namespace srt::sync;
// You can change this value at build config by using "ENFORCE" options.
#if !defined(SRT_MAVG_SAMPLING_RATE)
#define SRT_MAVG_SAMPLING_RATE 40
#endif
bool AvgBufSize::isTimeToUpdate(const time_point& now) const
{
const int usMAvgBasePeriod = 1000000; // 1s in microseconds
const int us2ms = 1000;
const int msMAvgPeriod = (usMAvgBasePeriod / SRT_MAVG_SAMPLING_RATE) / us2ms;
const uint64_t elapsed_ms = count_milliseconds(now - m_tsLastSamplingTime); // ms since last sampling
return (elapsed_ms >= msMAvgPeriod);
}
void AvgBufSize::update(const steady_clock::time_point& now, int pkts, int bytes, int timespan_ms)
{
const uint64_t elapsed_ms = count_milliseconds(now - m_tsLastSamplingTime); // ms since last sampling
m_tsLastSamplingTime = now;
const uint64_t one_second_in_ms = 1000;
if (elapsed_ms > one_second_in_ms)
{
// No sampling in last 1 sec, initialize average
m_dCountMAvg = pkts;
m_dBytesCountMAvg = bytes;
m_dTimespanMAvg = timespan_ms;
return;
}
//
// weight last average value between -1 sec and last sampling time (LST)
// and new value between last sampling time and now
// |elapsed_ms|
// +----------------------------------+-------+
// -1 LST 0(now)
//
m_dCountMAvg = avg_iir_w<1000, double>(m_dCountMAvg, pkts, elapsed_ms);
m_dBytesCountMAvg = avg_iir_w<1000, double>(m_dBytesCountMAvg, bytes, elapsed_ms);
m_dTimespanMAvg = avg_iir_w<1000, double>(m_dTimespanMAvg, timespan_ms, elapsed_ms);
}
int round_val(double val)
{
return static_cast<int>(round(val));
}
CSndBuffer::CSndBuffer(int size, int mss)
: m_BufLock()
, m_pBlock(NULL)
, m_pFirstBlock(NULL)
, m_pCurrBlock(NULL)
, m_pLastBlock(NULL)
, m_pBuffer(NULL)
, m_iNextMsgNo(1)
, m_iSize(size)
, m_iMSS(mss)
, m_iCount(0)
, m_iBytesCount(0)
, m_iInRatePktsCount(0)
, m_iInRateBytesCount(0)
, m_InRatePeriod(INPUTRATE_FAST_START_US) // 0.5 sec (fast start)
, m_iInRateBps(INPUTRATE_INITIAL_BYTESPS)
{
// initial physical buffer of "size"
m_pBuffer = new Buffer;
m_pBuffer->m_pcData = new char[m_iSize * m_iMSS];
m_pBuffer->m_iSize = m_iSize;
m_pBuffer->m_pNext = NULL;
// circular linked list for out bound packets
m_pBlock = new Block;
Block* pb = m_pBlock;
for (int i = 1; i < m_iSize; ++i)
{
pb->m_pNext = new Block;
pb->m_iMsgNoBitset = 0;
pb = pb->m_pNext;
}
pb->m_pNext = m_pBlock;
pb = m_pBlock;
char* pc = m_pBuffer->m_pcData;
for (int i = 0; i < m_iSize; ++i)
{
pb->m_pcData = pc;
pb = pb->m_pNext;
pc += m_iMSS;
}
m_pFirstBlock = m_pCurrBlock = m_pLastBlock = m_pBlock;
setupMutex(m_BufLock, "Buf");
}
CSndBuffer::~CSndBuffer()
{
Block* pb = m_pBlock->m_pNext;
while (pb != m_pBlock)
{
Block* temp = pb;
pb = pb->m_pNext;
delete temp;
}
delete m_pBlock;
while (m_pBuffer != NULL)
{
Buffer* temp = m_pBuffer;
m_pBuffer = m_pBuffer->m_pNext;
delete[] temp->m_pcData;
delete temp;
}
releaseMutex(m_BufLock);
}
void CSndBuffer::addBuffer(const char* data, int len, SRT_MSGCTRL& w_mctrl)
{
int32_t& w_msgno = w_mctrl.msgno;
int32_t& w_seqno = w_mctrl.pktseq;
int64_t& w_srctime = w_mctrl.srctime;
int& w_ttl = w_mctrl.msgttl;
int size = len / m_iMSS;
if ((len % m_iMSS) != 0)
size++;
HLOGC(bslog.Debug,
log << "addBuffer: size=" << m_iCount << " reserved=" << m_iSize << " needs=" << size << " buffers for "
<< len << " bytes");
// dynamically increase sender buffer
while (size + m_iCount >= m_iSize)
{
HLOGC(bslog.Debug, log << "addBuffer: ... still lacking " << (size + m_iCount - m_iSize) << " buffers...");
increase();
}
const steady_clock::time_point time = steady_clock::now();
const int32_t inorder = w_mctrl.inorder ? MSGNO_PACKET_INORDER::mask : 0;
HLOGC(bslog.Debug,
log << CONID() << "addBuffer: adding " << size << " packets (" << len << " bytes) to send, msgno="
<< (w_msgno > 0 ? w_msgno : m_iNextMsgNo) << (inorder ? "" : " NOT") << " in order");
// The sequence number passed to this function is the sequence number
// that the very first packet from the packet series should get here.
// If there's more than one packet, this function must increase it by itself
// and then return the accordingly modified sequence number in the reference.
Block* s = m_pLastBlock;
if (w_msgno == SRT_MSGNO_NONE) // DEFAULT-UNCHANGED msgno supplied
{
HLOGC(bslog.Debug, log << "addBuffer: using internally managed msgno=" << m_iNextMsgNo);
w_msgno = m_iNextMsgNo;
}
else
{
HLOGC(bslog.Debug, log << "addBuffer: OVERWRITTEN by msgno supplied by caller: msgno=" << w_msgno);
m_iNextMsgNo = w_msgno;
}
for (int i = 0; i < size; ++i)
{
int pktlen = len - i * m_iMSS;
if (pktlen > m_iMSS)
pktlen = m_iMSS;
HLOGC(bslog.Debug,
log << "addBuffer: %" << w_seqno << " #" << w_msgno << " spreading from=" << (i * m_iMSS)
<< " size=" << pktlen << " TO BUFFER:" << (void*)s->m_pcData);
memcpy((s->m_pcData), data + i * m_iMSS, pktlen);
s->m_iLength = pktlen;
s->m_iSeqNo = w_seqno;
w_seqno = CSeqNo::incseq(w_seqno);
s->m_iMsgNoBitset = m_iNextMsgNo | inorder;
if (i == 0)
s->m_iMsgNoBitset |= PacketBoundaryBits(PB_FIRST);
if (i == size - 1)
s->m_iMsgNoBitset |= PacketBoundaryBits(PB_LAST);
// NOTE: if i is neither 0 nor size-1, it resuls with PB_SUBSEQUENT.
// if i == 0 == size-1, it results with PB_SOLO.
// Packets assigned to one message can be:
// [PB_FIRST] [PB_SUBSEQUENT] [PB_SUBSEQUENT] [PB_LAST] - 4 packets per message
// [PB_FIRST] [PB_LAST] - 2 packets per message
// [PB_SOLO] - 1 packet per message
s->m_llSourceTime_us = w_srctime;
s->m_tsOriginTime = time;
s->m_tsRexmitTime = time_point();
s->m_iTTL = w_ttl;
// Rewrite the actual sending time back into w_srctime
// so that the calling facilities can reuse it
if (!w_srctime)
w_srctime = count_microseconds(s->m_tsOriginTime.time_since_epoch());
// XXX unchecked condition: s->m_pNext == NULL.
// Should never happen, as the call to increase() should ensure enough buffers.
SRT_ASSERT(s->m_pNext);
s = s->m_pNext;
}
m_pLastBlock = s;
enterCS(m_BufLock);
m_iCount += size;
m_iBytesCount += len;
m_tsLastOriginTime = time;
updateInputRate(time, size, len);
updAvgBufSize(time);
leaveCS(m_BufLock);
// MSGNO_SEQ::mask has a form: 00000011111111...
// At least it's known that it's from some index inside til the end (to bit 0).
// If this value has been reached in a step of incrementation, it means that the
// maximum value has been reached. Casting to int32_t to ensure the same sign
// in comparison, although it's far from reaching the sign bit.
const int nextmsgno = ++MsgNo(m_iNextMsgNo);
HLOGC(bslog.Debug, log << "CSndBuffer::addBuffer: updating msgno: #" << m_iNextMsgNo << " -> #" << nextmsgno);
m_iNextMsgNo = nextmsgno;
}
void CSndBuffer::setInputRateSmpPeriod(int period)
{
m_InRatePeriod = (uint64_t)period; //(usec) 0=no input rate calculation
}
void CSndBuffer::updateInputRate(const steady_clock::time_point& time, int pkts, int bytes)
{
// no input rate calculation
if (m_InRatePeriod == 0)
return;
if (is_zero(m_tsInRateStartTime))
{
m_tsInRateStartTime = time;
return;
}
m_iInRatePktsCount += pkts;
m_iInRateBytesCount += bytes;
// Trigger early update in fast start mode
const bool early_update = (m_InRatePeriod < INPUTRATE_RUNNING_US) && (m_iInRatePktsCount > INPUTRATE_MAX_PACKETS);
const uint64_t period_us = count_microseconds(time - m_tsInRateStartTime);
if (early_update || period_us > m_InRatePeriod)
{
// Required Byte/sec rate (payload + headers)
m_iInRateBytesCount += (m_iInRatePktsCount * CPacket::SRT_DATA_HDR_SIZE);
m_iInRateBps = (int)(((int64_t)m_iInRateBytesCount * 1000000) / period_us);
HLOGC(bslog.Debug,
log << "updateInputRate: pkts:" << m_iInRateBytesCount << " bytes:" << m_iInRatePktsCount
<< " rate=" << (m_iInRateBps * 8) / 1000 << "kbps interval=" << period_us);
m_iInRatePktsCount = 0;
m_iInRateBytesCount = 0;
m_tsInRateStartTime = time;
setInputRateSmpPeriod(INPUTRATE_RUNNING_US);
}
}
int CSndBuffer::addBufferFromFile(fstream& ifs, int len)
{
int size = len / m_iMSS;
if ((len % m_iMSS) != 0)
size++;
HLOGC(bslog.Debug,
log << "addBufferFromFile: size=" << m_iCount << " reserved=" << m_iSize << " needs=" << size
<< " buffers for " << len << " bytes");
// dynamically increase sender buffer
while (size + m_iCount >= m_iSize)
{
HLOGC(bslog.Debug,
log << "addBufferFromFile: ... still lacking " << (size + m_iCount - m_iSize) << " buffers...");
increase();
}
HLOGC(bslog.Debug,
log << CONID() << "addBufferFromFile: adding " << size << " packets (" << len
<< " bytes) to send, msgno=" << m_iNextMsgNo);
Block* s = m_pLastBlock;
int total = 0;
for (int i = 0; i < size; ++i)
{
if (ifs.bad() || ifs.fail() || ifs.eof())
break;
int pktlen = len - i * m_iMSS;
if (pktlen > m_iMSS)
pktlen = m_iMSS;
HLOGC(bslog.Debug,
log << "addBufferFromFile: reading from=" << (i * m_iMSS) << " size=" << pktlen
<< " TO BUFFER:" << (void*)s->m_pcData);
ifs.read(s->m_pcData, pktlen);
if ((pktlen = int(ifs.gcount())) <= 0)
break;
// currently file transfer is only available in streaming mode, message is always in order, ttl = infinite
s->m_iMsgNoBitset = m_iNextMsgNo | MSGNO_PACKET_INORDER::mask;
if (i == 0)
s->m_iMsgNoBitset |= PacketBoundaryBits(PB_FIRST);
if (i == size - 1)
s->m_iMsgNoBitset |= PacketBoundaryBits(PB_LAST);
// NOTE: PB_FIRST | PB_LAST == PB_SOLO.
// none of PB_FIRST & PB_LAST == PB_SUBSEQUENT.
s->m_iLength = pktlen;
s->m_iTTL = SRT_MSGTTL_INF;
s = s->m_pNext;
total += pktlen;
}
m_pLastBlock = s;
enterCS(m_BufLock);
m_iCount += size;
m_iBytesCount += total;
leaveCS(m_BufLock);
m_iNextMsgNo++;
if (m_iNextMsgNo == int32_t(MSGNO_SEQ::mask))
m_iNextMsgNo = 1;
return total;
}
steady_clock::time_point CSndBuffer::getSourceTime(const CSndBuffer::Block& block)
{
if (block.m_llSourceTime_us)
{
return steady_clock::time_point() + microseconds_from(block.m_llSourceTime_us);
}
return block.m_tsOriginTime;
}
int CSndBuffer::readData(CPacket& w_packet, steady_clock::time_point& w_srctime, int kflgs)
{
// No data to read
if (m_pCurrBlock == m_pLastBlock)
return 0;
// Make the packet REFLECT the data stored in the buffer.
w_packet.m_pcData = m_pCurrBlock->m_pcData;
int readlen = m_pCurrBlock->m_iLength;
w_packet.setLength(readlen);
w_packet.m_iSeqNo = m_pCurrBlock->m_iSeqNo;
// XXX This is probably done because the encryption should happen
// just once, and so this sets the encryption flags to both msgno bitset
// IN THE PACKET and IN THE BLOCK. This is probably to make the encryption
// happen at the time when scheduling a new packet to send, but the packet
// must remain in the send buffer until it's ACKed. For the case of rexmit
// the packet will be taken "as is" (that is, already encrypted).
//
// The problem is in the order of things:
// 0. When the application stores the data, some of the flags for PH_MSGNO are set.
// 1. The readData() is called to get the original data sent by the application.
// 2. The data are original and must be encrypted. They WILL BE encrypted, later.
// 3. So far we are in readData() so the encryption flags must be updated NOW because
// later we won't have access to the block's data.
// 4. After exiting from readData(), the packet is being encrypted. It's immediately
// sent, however the data must remain in the sending buffer until they are ACKed.
// 5. In case when rexmission is needed, the second overloaded version of readData
// is being called, and the buffer + PH_MSGNO value is extracted. All interesting
// flags must be present and correct at that time.
//
// The only sensible way to fix this problem is to encrypt the packet not after
// extracting from here, but when the packet is stored into CSndBuffer. The appropriate
// flags for PH_MSGNO will be applied directly there. Then here the value for setting
// PH_MSGNO will be set as is.
if (kflgs == -1)
{
HLOGC(bslog.Debug, log << CONID() << " CSndBuffer: ERROR: encryption required and not possible. NOT SENDING.");
readlen = 0;
}
else
{
m_pCurrBlock->m_iMsgNoBitset |= MSGNO_ENCKEYSPEC::wrap(kflgs);
}
w_packet.m_iMsgNo = m_pCurrBlock->m_iMsgNoBitset;
w_srctime = getSourceTime(*m_pCurrBlock);
m_pCurrBlock = m_pCurrBlock->m_pNext;
HLOGC(bslog.Debug, log << CONID() << "CSndBuffer: extracting packet size=" << readlen << " to send");
return readlen;
}
int32_t CSndBuffer::getMsgNoAt(const int offset)
{
ScopedLock bufferguard(m_BufLock);
Block* p = m_pFirstBlock;
if (p)
{
HLOGC(bslog.Debug,
log << "CSndBuffer::getMsgNoAt: FIRST MSG: size=" << p->m_iLength << " %" << p->m_iSeqNo << " #"
<< p->getMsgSeq() << " !" << BufferStamp(p->m_pcData, p->m_iLength));
}
if (offset >= m_iCount)
{
// Prevent accessing the last "marker" block
LOGC(bslog.Error,
log << "CSndBuffer::getMsgNoAt: IPE: offset=" << offset << " not found, max offset=" << m_iCount);
return SRT_MSGNO_CONTROL;
}
// XXX Suboptimal procedure to keep the blocks identifiable
// by sequence number. Consider using some circular buffer.
int i;
Block* ee SRT_ATR_UNUSED = 0;
for (i = 0; i < offset && p; ++i)
{
ee = p;
p = p->m_pNext;
}
if (!p)
{
LOGC(bslog.Error,
log << "CSndBuffer::getMsgNoAt: IPE: offset=" << offset << " not found, stopped at " << i << " with #"
<< (ee ? ee->getMsgSeq() : SRT_MSGNO_NONE));
return SRT_MSGNO_CONTROL;
}
HLOGC(bslog.Debug,
log << "CSndBuffer::getMsgNoAt: offset=" << offset << " found, size=" << p->m_iLength << " %" << p->m_iSeqNo
<< " #" << p->getMsgSeq() << " !" << BufferStamp(p->m_pcData, p->m_iLength));
return p->getMsgSeq();
}
int CSndBuffer::readData(const int offset, CPacket& w_packet, steady_clock::time_point& w_srctime, int& w_msglen)
{
int32_t& msgno_bitset = w_packet.m_iMsgNo;
ScopedLock bufferguard(m_BufLock);
Block* p = m_pFirstBlock;
// XXX Suboptimal procedure to keep the blocks identifiable
// by sequence number. Consider using some circular buffer.
for (int i = 0; i < offset; ++i)
p = p->m_pNext;
// Check if the block that is the next candidate to send (m_pCurrBlock pointing) is stale.
// If so, then inform the caller that it should first take care of the whole
// message (all blocks with that message id). Shift the m_pCurrBlock pointer
// to the position past the last of them. Then return -1 and set the
// msgno_bitset return reference to the message id that should be dropped as
// a whole.
// After taking care of that, the caller should immediately call this function again,
// this time possibly in order to find the real data to be sent.
// if found block is stale
// (This is for messages that have declared TTL - messages that fail to be sent
// before the TTL defined time comes, will be dropped).
if ((p->m_iTTL >= 0) && (count_milliseconds(steady_clock::now() - p->m_tsOriginTime) > p->m_iTTL))
{
int32_t msgno = p->getMsgSeq();
w_msglen = 1;
p = p->m_pNext;
bool move = false;
while (msgno == p->getMsgSeq())
{
if (p == m_pCurrBlock)
move = true;
p = p->m_pNext;
if (move)
m_pCurrBlock = p;
w_msglen++;
}
HLOGC(qslog.Debug,
log << "CSndBuffer::readData: due to TTL exceeded, " << w_msglen << " messages to drop, up to " << msgno);
// If readData returns -1, then msgno_bitset is understood as a Message ID to drop.
// This means that in this case it should be written by the message sequence value only
// (not the whole 4-byte bitset written at PH_MSGNO).
msgno_bitset = msgno;
return -1;
}
w_packet.m_pcData = p->m_pcData;
int readlen = p->m_iLength;
w_packet.setLength(readlen);
// XXX Here the value predicted to be applied to PH_MSGNO field is extracted.
// As this function is predicted to extract the data to send as a rexmited packet,
// the packet must be in the form ready to send - so, in case of encryption,
// encrypted, and with all ENC flags already set. So, the first call to send
// the packet originally (the other overload of this function) must set these
// flags.
w_packet.m_iMsgNo = p->m_iMsgNoBitset;
// TODO: FR #930. Use source time if it is provided.
w_srctime = getSourceTime(*p);
// This function is called when packet retransmission is triggered.
// Therefore we are setting the rexmit time.
p->m_tsRexmitTime = steady_clock::now();
HLOGC(qslog.Debug,
log << CONID() << "CSndBuffer: getting packet %" << p->m_iSeqNo << " as per %" << w_packet.m_iSeqNo
<< " size=" << readlen << " to send [REXMIT]");
return readlen;
}
srt::sync::steady_clock::time_point CSndBuffer::getPacketRexmitTime(const int offset)
{
ScopedLock bufferguard(m_BufLock);
const Block* p = m_pFirstBlock;
// XXX Suboptimal procedure to keep the blocks identifiable
// by sequence number. Consider using some circular buffer.
for (int i = 0; i < offset; ++i)
{
SRT_ASSERT(p);
p = p->m_pNext;
}
SRT_ASSERT(p);
return p->m_tsRexmitTime;
}
void CSndBuffer::ackData(int offset)
{
ScopedLock bufferguard(m_BufLock);
bool move = false;
for (int i = 0; i < offset; ++i)
{
m_iBytesCount -= m_pFirstBlock->m_iLength;
if (m_pFirstBlock == m_pCurrBlock)
move = true;
m_pFirstBlock = m_pFirstBlock->m_pNext;
}
if (move)
m_pCurrBlock = m_pFirstBlock;
m_iCount -= offset;
updAvgBufSize(steady_clock::now());
}
int CSndBuffer::getCurrBufSize() const
{
return m_iCount;
}
int CSndBuffer::getAvgBufSize(int& w_bytes, int& w_tsp)
{
ScopedLock bufferguard(m_BufLock); /* Consistency of pkts vs. bytes vs. spantime */
/* update stats in case there was no add/ack activity lately */
updAvgBufSize(steady_clock::now());
// Average number of packets and timespan could be small,
// so rounding is beneficial, while for the number of
// bytes in the buffer is a higher value, so rounding can be omitted,
// but probably better to round all three values.
w_bytes = round_val(m_mavg.bytes());
w_tsp = round_val(m_mavg.timespan_ms());
return round_val(m_mavg.pkts());
}
void CSndBuffer::updAvgBufSize(const steady_clock::time_point& now)
{
if (!m_mavg.isTimeToUpdate(now))
return;
int bytes = 0;
int timespan_ms = 0;
const int pkts = getCurrBufSize((bytes), (timespan_ms));
m_mavg.update(now, pkts, bytes, timespan_ms);
}
int CSndBuffer::getCurrBufSize(int& w_bytes, int& w_timespan)
{
w_bytes = m_iBytesCount;
/*
* Timespan can be less then 1000 us (1 ms) if few packets.
* Also, if there is only one pkt in buffer, the time difference will be 0.
* Therefore, always add 1 ms if not empty.
*/
w_timespan = 0 < m_iCount ? count_milliseconds(m_tsLastOriginTime - m_pFirstBlock->m_tsOriginTime) + 1 : 0;
return m_iCount;
}
int CSndBuffer::dropLateData(int& w_bytes, int32_t& w_first_msgno, const steady_clock::time_point& too_late_time)
{
int dpkts = 0;
int dbytes = 0;
bool move = false;
int32_t msgno = 0;
ScopedLock bufferguard(m_BufLock);
for (int i = 0; i < m_iCount && m_pFirstBlock->m_tsOriginTime < too_late_time; ++i)
{
dpkts++;
dbytes += m_pFirstBlock->m_iLength;
msgno = m_pFirstBlock->getMsgSeq();
if (m_pFirstBlock == m_pCurrBlock)
move = true;
m_pFirstBlock = m_pFirstBlock->m_pNext;
}
if (move)
{
m_pCurrBlock = m_pFirstBlock;
}
m_iCount -= dpkts;
m_iBytesCount -= dbytes;
w_bytes = dbytes;
// We report the increased number towards the last ever seen
// by the loop, as this last one is the last received. So remained
// (even if "should remain") is the first after the last removed one.
w_first_msgno = ++MsgNo(msgno);
updAvgBufSize(steady_clock::now());
return (dpkts);
}
void CSndBuffer::increase()
{
int unitsize = m_pBuffer->m_iSize;
// new physical buffer
Buffer* nbuf = NULL;
try
{
nbuf = new Buffer;
nbuf->m_pcData = new char[unitsize * m_iMSS];
}
catch (...)
{
delete nbuf;
throw CUDTException(MJ_SYSTEMRES, MN_MEMORY, 0);
}
nbuf->m_iSize = unitsize;
nbuf->m_pNext = NULL;
// insert the buffer at the end of the buffer list
Buffer* p = m_pBuffer;
while (p->m_pNext != NULL)
p = p->m_pNext;
p->m_pNext = nbuf;
// new packet blocks
Block* nblk = NULL;
try
{
nblk = new Block;
}
catch (...)
{
delete nblk;
throw CUDTException(MJ_SYSTEMRES, MN_MEMORY, 0);
}
Block* pb = nblk;
for (int i = 1; i < unitsize; ++i)
{
pb->m_pNext = new Block;
pb = pb->m_pNext;
}
// insert the new blocks onto the existing one
pb->m_pNext = m_pLastBlock->m_pNext;
m_pLastBlock->m_pNext = nblk;
pb = nblk;
char* pc = nbuf->m_pcData;
for (int i = 0; i < unitsize; ++i)
{
pb->m_pcData = pc;
pb = pb->m_pNext;
pc += m_iMSS;
}
m_iSize += unitsize;
HLOGC(bslog.Debug,
log << "CSndBuffer: BUFFER FULL - adding " << (unitsize * m_iMSS) << " bytes spread to " << unitsize
<< " blocks"
<< " (total size: " << m_iSize << " bytes)");
}
////////////////////////////////////////////////////////////////////////////////
/*
* RcvBuffer (circular buffer):
*
* |<------------------- m_iSize ----------------------------->|
* | |<--- acked pkts -->|<--- m_iMaxPos --->| |
* | | | | |
* +---+---+---+---+---+---+---+---+---+---+---+---+---+ +---+
* | 0 | 0 | 1 | 1 | 1 | 0 | 1 | 1 | 1 | 1 | 0 | 1 | 0 |...| 0 | m_pUnit[]
* +---+---+---+---+---+---+---+---+---+---+---+---+---+ +---+
* | | | |
* | | \__last pkt received
* | \___ m_iLastAckPos: last ack sent
* \___ m_iStartPos: first message to read
*
* m_pUnit[i]->m_iFlag: 0:free, 1:good, 2:passack, 3:dropped
*
* thread safety:
* m_iStartPos: CUDT::m_RecvLock
* m_iLastAckPos: CUDT::m_AckLock
* m_iMaxPos: none? (modified on add and ack
*/
// XXX Init values moved to in-class.
// const uint32_t CRcvBuffer::TSBPD_WRAP_PERIOD = (30*1000000); //30 seconds (in usec)
// const int CRcvBuffer::TSBPD_DRIFT_MAX_VALUE = 5000; // usec
// const int CRcvBuffer::TSBPD_DRIFT_MAX_SAMPLES = 1000; // ACK-ACK packets
#ifdef SRT_DEBUG_TSBPD_DRIFT
// const int CRcvBuffer::TSBPD_DRIFT_PRT_SAMPLES = 200; // ACK-ACK packets
#endif
CRcvBuffer::CRcvBuffer(CUnitQueue* queue, int bufsize_pkts)
: m_pUnit(NULL)
, m_iSize(bufsize_pkts)
, m_pUnitQueue(queue)
, m_iStartPos(0)
, m_iLastAckPos(0)
, m_iMaxPos(0)
, m_iNotch(0)
, m_BytesCountLock()
, m_iBytesCount(0)
, m_iAckedPktsCount(0)
, m_iAckedBytesCount(0)
, m_uAvgPayloadSz(7 * 188)
, m_bTsbPdMode(false)
, m_tdTsbPdDelay(0)
, m_bTsbPdWrapCheck(false)
{
m_pUnit = new CUnit*[m_iSize];
for (int i = 0; i < m_iSize; ++i)
m_pUnit[i] = NULL;
#ifdef SRT_DEBUG_TSBPD_DRIFT
memset(m_TsbPdDriftHisto100us, 0, sizeof(m_TsbPdDriftHisto100us));
memset(m_TsbPdDriftHisto1ms, 0, sizeof(m_TsbPdDriftHisto1ms));
#endif
setupMutex(m_BytesCountLock, "BytesCount");
}
CRcvBuffer::~CRcvBuffer()
{
for (int i = 0; i < m_iSize; ++i)
{
if (m_pUnit[i] != NULL)
{
m_pUnitQueue->makeUnitFree(m_pUnit[i]);
}
}
delete[] m_pUnit;
releaseMutex(m_BytesCountLock);
}
void CRcvBuffer::countBytes(int pkts, int bytes, bool acked)
{
/*
* Byte counter changes from both sides (Recv & Ack) of the buffer
* so the higher level lock is not enough for thread safe op.
*
* pkts are...
* added (bytes>0, acked=false),
* acked (bytes>0, acked=true),
* removed (bytes<0, acked=n/a)
*/
ScopedLock cg(m_BytesCountLock);
if (!acked) // adding new pkt in RcvBuffer
{
m_iBytesCount += bytes; /* added or removed bytes from rcv buffer */
if (bytes > 0) /* Assuming one pkt when adding bytes */
m_uAvgPayloadSz = ((m_uAvgPayloadSz * (100 - 1)) + bytes) / 100;
}
else // acking/removing pkts to/from buffer
{
m_iAckedPktsCount += pkts; /* acked or removed pkts from rcv buffer */
m_iAckedBytesCount += bytes; /* acked or removed bytes from rcv buffer */
if (bytes < 0)
m_iBytesCount += bytes; /* removed bytes from rcv buffer */
}
}
int CRcvBuffer::addData(CUnit* unit, int offset)
{
SRT_ASSERT(unit != NULL);
if (offset >= getAvailBufSize())
return -1;
const int pos = (m_iLastAckPos + offset) % m_iSize;
if (offset >= m_iMaxPos)
m_iMaxPos = offset + 1;
if (m_pUnit[pos] != NULL)
{
HLOGC(qrlog.Debug, log << "addData: unit %" << unit->m_Packet.m_iSeqNo << " rejected, already exists");
return -1;
}
m_pUnit[pos] = unit;
countBytes(1, (int)unit->m_Packet.getLength());
m_pUnitQueue->makeUnitGood(unit);
HLOGC(qrlog.Debug,
log << "addData: unit %" << unit->m_Packet.m_iSeqNo << " accepted, off=" << offset << " POS=" << pos);
return 0;
}
int CRcvBuffer::readBuffer(char* data, int len)
{
int p = m_iStartPos;
int lastack = m_iLastAckPos;
int rs = len;
IF_HEAVY_LOGGING(char* begin = data);
const steady_clock::time_point now = (m_bTsbPdMode ? steady_clock::now() : steady_clock::time_point());
HLOGC(brlog.Debug, log << CONID() << "readBuffer: start=" << p << " lastack=" << lastack);
while ((p != lastack) && (rs > 0))
{
if (m_pUnit[p] == NULL)
{
LOGC(brlog.Error, log << CONID() << " IPE readBuffer on null packet pointer");
return -1;
}
const CPacket& pkt = m_pUnit[p]->m_Packet;
if (m_bTsbPdMode)
{
HLOGC(brlog.Debug,
log << CONID() << "readBuffer: chk if time2play:"
<< " NOW=" << FormatTime(now)
<< " PKT TS=" << FormatTime(getPktTsbPdTime(pkt.getMsgTimeStamp())));
if ((getPktTsbPdTime(pkt.getMsgTimeStamp()) > now))
break; /* too early for this unit, return whatever was copied */
}
const int pktlen = pkt.getLength();
const int remain_pktlen = pktlen - m_iNotch;
const int unitsize = std::min(remain_pktlen, rs);
HLOGC(brlog.Debug,
log << CONID() << "readBuffer: copying buffer #" << p << " targetpos=" << int(data - begin)
<< " sourcepos=" << m_iNotch << " size=" << unitsize << " left=" << (unitsize - rs));
memcpy((data), pkt.m_pcData + m_iNotch, unitsize);
data += unitsize;
if (rs >= remain_pktlen)
{
freeUnitAt(p);
p = shiftFwd(p);
m_iNotch = 0;
}
else
m_iNotch += rs;
rs -= unitsize;
}
/* we removed acked bytes form receive buffer */
countBytes(-1, -(len - rs), true);
m_iStartPos = p;
return len - rs;
}
int CRcvBuffer::readBufferToFile(fstream& ofs, int len)
{
int p = m_iStartPos;
int lastack = m_iLastAckPos;
int rs = len;
int32_t trace_seq ATR_UNUSED = SRT_SEQNO_NONE;
int trace_shift ATR_UNUSED = -1;
while ((p != lastack) && (rs > 0))
{
#if ENABLE_LOGGING
++trace_shift;
#endif
// Skip empty units. Note that this shouldn't happen
// in case of a file transfer.
if (!m_pUnit[p])
{
p = shiftFwd(p);
LOGC(brlog.Error, log << "readBufferToFile: IPE: NULL unit found in file transmission, last good %"
<< trace_seq << " + " << trace_shift);
continue;
}
const CPacket& pkt = m_pUnit[p]->m_Packet;
#if ENABLE_LOGGING
trace_seq = pkt.getSeqNo();
#endif
const int pktlen = pkt.getLength();
const int remain_pktlen = pktlen - m_iNotch;
const int unitsize = std::min(remain_pktlen, rs);
ofs.write(pkt.m_pcData + m_iNotch, unitsize);
if (ofs.fail())
break;
if (rs >= remain_pktlen)
{
freeUnitAt(p);
p = shiftFwd(p);
m_iNotch = 0;
}
else
m_iNotch += rs;
rs -= unitsize;
}
/* we removed acked bytes form receive buffer */
countBytes(-1, -(len - rs), true);
m_iStartPos = p;
return len - rs;
}
int CRcvBuffer::ackData(int len)
{
SRT_ASSERT(len < m_iSize);
SRT_ASSERT(len > 0);
int end = shift(m_iLastAckPos, len);
{
int pkts = 0;
int bytes = 0;
for (int i = m_iLastAckPos; i != end; i = shiftFwd(i))
{
if (m_pUnit[i] == NULL)
continue;
pkts++;
bytes += (int)m_pUnit[i]->m_Packet.getLength();
}
if (pkts > 0)
countBytes(pkts, bytes, true);
}
HLOGC(brlog.Debug,
log << "ackData: shift by " << len << ", start=" << m_iStartPos << " end=" << m_iLastAckPos << " -> " << end);
m_iLastAckPos = end;
m_iMaxPos -= len;
if (m_iMaxPos < 0)
m_iMaxPos = 0;
// Returned value is the distance towards the starting
// position from m_iLastAckPos, which is in sync with CUDT::m_iRcvLastSkipAck.
// This should help determine the sequence number at first read-ready position.
const int dist = m_iLastAckPos - m_iStartPos;
if (dist < 0)
return dist + m_iSize;
return dist;
}
void CRcvBuffer::skipData(int len)
{
/*
* Caller need protect both AckLock and RecvLock
* to move both m_iStartPos and m_iLastAckPost
*/
if (m_iStartPos == m_iLastAckPos)
m_iStartPos = (m_iStartPos + len) % m_iSize;
m_iLastAckPos = (m_iLastAckPos + len) % m_iSize;
m_iMaxPos -= len;
if (m_iMaxPos < 0)
m_iMaxPos = 0;
}
size_t CRcvBuffer::dropData(int len)
{
// This function does the same as skipData, although skipData
// should work in the condition of absence of data, so no need
// to force the units in the range to be freed. This function
// works in more general condition where we don't know if there
// are any data in the given range, but want to remove these
// "sequence positions" from the buffer, whether there are data
// at them or not.
size_t stats_bytes = 0;
int p = m_iStartPos;
int past_q = shift(p, len);
while (p != past_q)
{
if (m_pUnit[p] && m_pUnit[p]->m_iFlag == CUnit::GOOD)
{
stats_bytes += m_pUnit[p]->m_Packet.getLength();
freeUnitAt(p);
}
p = shiftFwd(p);
}
m_iStartPos = past_q;
return stats_bytes;
}
bool CRcvBuffer::getRcvFirstMsg(steady_clock::time_point& w_tsbpdtime,
bool& w_passack,
int32_t& w_skipseqno,
int32_t& w_curpktseq)
{
w_skipseqno = SRT_SEQNO_NONE;
w_passack = false;
// tsbpdtime will be retrieved by the below call
// Returned values:
// - tsbpdtime: real time when the packet is ready to play (whether ready to play or not)
// - w_passack: false (the report concerns a packet with an exactly next sequence)
// - w_skipseqno == SRT_SEQNO_NONE: no packets to skip towards the first RTP
// - w_curpktseq: that exactly packet that is reported (for debugging purposes)
// - @return: whether the reported packet is ready to play
/* Check the acknowledged packets */
// getRcvReadyMsg returns true if the time to play for the first message
// (returned in w_tsbpdtime) is in the past.
if (getRcvReadyMsg((w_tsbpdtime), (w_curpktseq), -1))
{
HLOGC(brlog.Debug, log << "getRcvFirstMsg: ready CONTIG packet: %" << w_curpktseq);
return true;
}
else if (!is_zero(w_tsbpdtime))
{
HLOGC(brlog.Debug, log << "getRcvFirstMsg: packets found, but in future");
// This means that a message next to be played, has been found,
// but the time to play is in future.
return false;
}
// Falling here means that there are NO PACKETS in the ACK-ed region
// (m_iStartPos - m_iLastAckPos), but we may have something in the
// region (m_iLastAckPos - (m_iLastAckPos+m_iMaxPos)), that is, packets
// that may be separated from the last ACK-ed by lost ones.
// Below this line we have only two options:
// - m_iMaxPos == 0, which means that no more packets are in the buffer
// - returned: tsbpdtime=0, w_passack=true, w_skipseqno=SRT_SEQNO_NONE, w_curpktseq=<unchanged>, @return false
// - m_iMaxPos > 0, which means that there are packets arrived after a lost packet:
// - returned: tsbpdtime=PKT.TS, w_passack=true, w_skipseqno=PKT.SEQ, w_curpktseq=PKT, @return LOCAL(PKT.TS) <=
// NOW
/*
* No acked packets ready but caller want to know next packet to wait for
* Check the not yet acked packets that may be stuck by missing packet(s).
*/
bool haslost = false;
w_tsbpdtime = steady_clock::time_point(); // redundant, for clarity
w_passack = true;
// XXX SUSPECTED ISSUE with this algorithm:
// The above call to getRcvReadyMsg() should report as to whether:
// - there is an EXACTLY NEXT SEQUENCE packet
// - this packet is ready to play.
//
// Situations handled after the call are when:
// - there's the next sequence packet available and it is ready to play
// - there are no packets at all, ready to play or not
//
// So, the remaining situation is that THERE ARE PACKETS that follow
// the current sequence, but they are not ready to play. This includes
// packets that have the exactly next sequence and packets that jump
// over a lost packet.
//
// As the getRcvReadyMsg() function walks through the incoming units
// to see if there's anything that satisfies these conditions, it *SHOULD*
// be also capable of checking if the next available packet, if it is
// there, is the next sequence packet or not. Retrieving this exactly
// packet would be most useful, as the test for play-readiness and
// sequentiality can be done on it directly.
//
// When done so, the below loop would be completely unnecessary.
// Logical description of the below algorithm:
// 1. Check if the VERY FIRST PACKET is valid; if so then:
// - check if it's ready to play, return boolean value that marks it.
for (int i = m_iLastAckPos, n = shift(m_iLastAckPos, m_iMaxPos); i != n; i = shiftFwd(i))
{
if (!m_pUnit[i] || m_pUnit[i]->m_iFlag != CUnit::GOOD)
{
/* There are packets in the sequence not received yet */
haslost = true;
HLOGC(brlog.Debug, log << "getRcvFirstMsg: empty hole at *" << i);
}
else
{
/* We got the 1st valid packet */
w_tsbpdtime = getPktTsbPdTime(m_pUnit[i]->m_Packet.getMsgTimeStamp());
if (w_tsbpdtime <= steady_clock::now())
{
/* Packet ready to play */
if (haslost)
{
/*
* Packet stuck on non-acked side because of missing packets.
* Tell 1st valid packet seqno so caller can skip (drop) the missing packets.
*/
w_skipseqno = m_pUnit[i]->m_Packet.m_iSeqNo;
w_curpktseq = w_skipseqno;
}
HLOGC(brlog.Debug,
log << "getRcvFirstMsg: found ready packet, nSKIPPED: "
<< ((i - m_iLastAckPos + m_iSize) % m_iSize));
// NOTE: if haslost is not set, it means that this is the VERY FIRST
// packet, that is, packet currently at pos = m_iLastAckPos. There's no
// possibility that it is so otherwise because:
// - if this first good packet is ready to play, THIS HERE RETURNS NOW.
// ...
return true;
}
HLOGC(brlog.Debug,
log << "getRcvFirstMsg: found NOT READY packet, nSKIPPED: "
<< ((i - m_iLastAckPos + m_iSize) % m_iSize));
// ... and if this first good packet WASN'T ready to play, THIS HERE RETURNS NOW, TOO,
// just states that there's no ready packet to play.
// ...
return false;
}
// ... and if this first packet WASN'T GOOD, the loop continues, however since now
// the 'haslost' is set, which means that it continues only to find the first valid
// packet after stating that the very first packet isn't valid.
}
HLOGC(brlog.Debug, log << "getRcvFirstMsg: found NO PACKETS");
return false;
}
steady_clock::time_point CRcvBuffer::debugGetDeliveryTime(int offset)
{
int i;
if (offset > 0)
i = shift(m_iStartPos, offset);
else
i = m_iStartPos;
CUnit* u = m_pUnit[i];
if (!u || u->m_iFlag != CUnit::GOOD)
return steady_clock::time_point();
return getPktTsbPdTime(u->m_Packet.getMsgTimeStamp());
}
int32_t CRcvBuffer::getTopMsgno() const
{
if (m_iStartPos == m_iLastAckPos)
return SRT_MSGNO_NONE; // No message is waiting
if (!m_pUnit[m_iStartPos])
return SRT_MSGNO_NONE; // pity
return m_pUnit[m_iStartPos]->m_Packet.getMsgSeq();
}
bool CRcvBuffer::getRcvReadyMsg(steady_clock::time_point& w_tsbpdtime, int32_t& w_curpktseq, int upto)
{
const bool havelimit = upto != -1;
int end = -1, past_end = -1;
if (havelimit)
{
int stretch = (m_iSize + m_iStartPos - m_iLastAckPos) % m_iSize;
if (upto > stretch)
{
HLOGC(brlog.Debug, log << "position back " << upto << " exceeds stretch " << stretch);
// Do nothing. This position is already gone.
return false;
}
end = m_iLastAckPos - upto;
if (end < 0)
end += m_iSize;
past_end = shiftFwd(end); // For in-loop comparison
HLOGC(brlog.Debug, log << "getRcvReadyMsg: will read from position " << end);
}
// NOTE: position m_iLastAckPos in the buffer represents the sequence number of
// CUDT::m_iRcvLastSkipAck. Therefore 'upto' contains a positive value that should
// be decreased from m_iLastAckPos to get the position in the buffer that represents
// the sequence number up to which we'd like to read.
IF_HEAVY_LOGGING(const char* reason = "NOT RECEIVED");
for (int i = m_iStartPos, n = m_iLastAckPos; i != n; i = shiftFwd(i))
{
// In case when we want to read only up to given sequence number, stop
// the loop if this number was reached. This number must be extracted from
// the buffer and any following must wait here for "better times". Note
// that the unit that points to the requested sequence must remain in
// the buffer, unless there is no valid packet at that position, in which
// case it is allowed to point to the NEXT sequence towards it, however
// if it does, this cell must remain in the buffer for prospective recovery.
if (havelimit && i == past_end)
break;
bool freeunit = false;
/* Skip any invalid skipped/dropped packets */
if (m_pUnit[i] == NULL)
{
HLOGC(brlog.Debug,
log << "getRcvReadyMsg: POS=" << i << " +" << ((i - m_iStartPos + m_iSize) % m_iSize)
<< " SKIPPED - no unit there");
m_iStartPos = shiftFwd(m_iStartPos);
continue;
}
w_curpktseq = m_pUnit[i]->m_Packet.getSeqNo();
if (m_pUnit[i]->m_iFlag != CUnit::GOOD)
{
HLOGC(brlog.Debug,
log << "getRcvReadyMsg: POS=" << i << " +" << ((i - m_iStartPos + m_iSize) % m_iSize)
<< " SKIPPED - unit not good");
freeunit = true;
}
else
{
// This does:
// 1. Get the TSBPD time of the unit. Stop and return false if this unit
// is not yet ready to play.
// 2. If it's ready to play, check also if it's decrypted. If not, skip it.
// 3. If it's ready to play and decrypted, stop and return it.
if (!havelimit)
{
w_tsbpdtime = getPktTsbPdTime(m_pUnit[i]->m_Packet.getMsgTimeStamp());
const steady_clock::duration towait = (w_tsbpdtime - steady_clock::now());
if (towait.count() > 0)
{
HLOGC(brlog.Debug,
log << "getRcvReadyMsg: POS=" << i << " +" << ((i - m_iStartPos + m_iSize) % m_iSize)
<< " pkt %" << w_curpktseq << " NOT ready to play (only in " << count_milliseconds(towait)
<< "ms)");
return false;
}
if (m_pUnit[i]->m_Packet.getMsgCryptoFlags() != EK_NOENC)
{
IF_HEAVY_LOGGING(reason = "DECRYPTION FAILED");
freeunit = true; /* packet not decrypted */
}
else
{
HLOGC(brlog.Debug,
log << "getRcvReadyMsg: POS=" << i << " +" << ((i - m_iStartPos + m_iSize) % m_iSize)
<< " pkt %" << w_curpktseq << " ready to play (delayed " << count_milliseconds(towait)
<< "ms)");
return true;
}
}
// In this case:
// 1. We don't even look into the packet if this is not the requested sequence.
// All packets that are earlier than the required sequence will be dropped.
// 2. When found the packet with expected sequence number, and the condition for
// good unit is passed, we get the timestamp.
// 3. If the packet is not decrypted, we allow it to be removed
// 4. If we reached the required sequence, and the packet is good, KEEP IT in the buffer,
// and return with the pointer pointing to this very buffer. Only then return true.
else
{
// We have a limit up to which the reading will be done,
// no matter if the time has come or not - although retrieve it.
if (i == end)
{
HLOGC(brlog.Debug, log << "CAUGHT required seq position " << i);
// We have the packet we need. Extract its data.
w_tsbpdtime = getPktTsbPdTime(m_pUnit[i]->m_Packet.getMsgTimeStamp());
// If we have a decryption failure, allow the unit to be released.
if (m_pUnit[i]->m_Packet.getMsgCryptoFlags() != EK_NOENC)
{
IF_HEAVY_LOGGING(reason = "DECRYPTION FAILED");
freeunit = true; /* packet not decrypted */
}
else
{
// Stop here and keep the packet in the buffer, so it will be
// next extracted.
HLOGC(brlog.Debug,
log << "getRcvReadyMsg: packet seq=" << w_curpktseq << " ready for extraction");
return true;
}
}
else
{
HLOGC(brlog.Debug, log << "SKIPPING position " << i);
// Continue the loop and remove the current packet because
// its sequence number is too old.
freeunit = true;
}
}
}
if (freeunit)
{
HLOGC(brlog.Debug, log << "getRcvReadyMsg: POS=" << i << " FREED");
/* removed skipped, dropped, undecryptable bytes from rcv buffer */
const int rmbytes = (int)m_pUnit[i]->m_Packet.getLength();
countBytes(-1, -rmbytes, true);
freeUnitAt(i);
m_iStartPos = shiftFwd(m_iStartPos);
}
}
HLOGC(brlog.Debug, log << "getRcvReadyMsg: nothing to deliver: " << reason);
return false;
}
/*
* Return receivable data status (packet timestamp_us ready to play if TsbPd mode)
* Return playtime (tsbpdtime) of 1st packet in queue, ready to play or not
*
* Return data ready to be received (packet timestamp_us ready to play if TsbPd mode)
* Using getRcvDataSize() to know if there is something to read as it was widely
* used in the code (core.cpp) is expensive in TsbPD mode, hence this simpler function
* that only check if first packet in queue is ready.
*/
bool CRcvBuffer::isRcvDataReady(steady_clock::time_point& w_tsbpdtime, int32_t& w_curpktseq, int32_t seqdistance)
{
w_tsbpdtime = steady_clock::time_point();
if (m_bTsbPdMode)
{
const CPacket* pkt = getRcvReadyPacket(seqdistance);
if (!pkt)
{
HLOGC(brlog.Debug, log << "isRcvDataReady: packet NOT extracted.");
return false;
}
/*
* Acknowledged data is available,
* Only say ready if time to deliver.
* Report the timestamp, ready or not.
*/
w_curpktseq = pkt->getSeqNo();
w_tsbpdtime = getPktTsbPdTime(pkt->getMsgTimeStamp());
// If seqdistance was passed, then return true no matter what the
// TSBPD time states.
if (seqdistance != -1 || w_tsbpdtime <= steady_clock::now())
{
HLOGC(brlog.Debug,
log << "isRcvDataReady: packet extracted seqdistance=" << seqdistance
<< " TsbPdTime=" << FormatTime(w_tsbpdtime));
return true;
}
HLOGC(brlog.Debug, log << "isRcvDataReady: packet extracted, but NOT READY");
return false;
}
return isRcvDataAvailable();
}
// XXX This function may be called only after checking
// if m_bTsbPdMode.
CPacket* CRcvBuffer::getRcvReadyPacket(int32_t seqdistance)
{
// If asked for readiness of a packet at given sequence distance
// (that is, we need to extract the packet with given sequence number),
// only check if this cell is occupied in the buffer, and if so,
// if it's occupied with a "good" unit. That's all. It doesn't
// matter whether it's ready to play.
if (seqdistance != -1)
{
// Note: seqdistance is the value to to go BACKWARDS from m_iLastAckPos,
// which is the position that is in sync with CUDT::m_iRcvLastSkipAck. This
// position is the sequence number of a packet that is NOT received, but it's
// expected to be received as next. So the minimum value of seqdistance is 1.
// SANITY CHECK
if (seqdistance == 0)
{
LOGC(brlog.Fatal, log << "IPE: trying to extract packet past the last ACK-ed!");
return 0;
}
if (seqdistance > getRcvDataSize())
{
HLOGC(brlog.Debug,
log << "getRcvReadyPacket: Sequence offset=" << seqdistance
<< " is in the past (start=" << m_iStartPos << " end=" << m_iLastAckPos << ")");
return 0;
}
int i = shift(m_iLastAckPos, -seqdistance);
if (m_pUnit[i] && m_pUnit[i]->m_iFlag == CUnit::GOOD)
{
HLOGC(brlog.Debug, log << "getRcvReadyPacket: FOUND PACKET %" << m_pUnit[i]->m_Packet.getSeqNo());
return &m_pUnit[i]->m_Packet;
}
HLOGC(brlog.Debug, log << "getRcvReadyPacket: Sequence offset=" << seqdistance << " IS NOT RECEIVED.");
return 0;
}
IF_HEAVY_LOGGING(int nskipped = 0);
for (int i = m_iStartPos, n = m_iLastAckPos; i != n; i = shiftFwd(i))
{
/*
* Skip missing packets that did not arrive in time.
*/
if (m_pUnit[i] && m_pUnit[i]->m_iFlag == CUnit::GOOD)
{
HLOGC(brlog.Debug,
log << "getRcvReadyPacket: Found next packet seq=%" << m_pUnit[i]->m_Packet.getSeqNo() << " ("
<< nskipped << " empty cells skipped)");
return &m_pUnit[i]->m_Packet;
}
IF_HEAVY_LOGGING(++nskipped);
}
return 0;
}
#if ENABLE_HEAVY_LOGGING
// This function is for debug purposes only and it's called only
// from within HLOG* macros.
void CRcvBuffer::reportBufferStats() const
{
int nmissing = 0;
int32_t low_seq = SRT_SEQNO_NONE, high_seq = SRT_SEQNO_NONE;
int32_t low_ts = 0, high_ts = 0;
for (int i = m_iStartPos, n = m_iLastAckPos; i != n; i = (i + 1) % m_iSize)
{
if (m_pUnit[i] && m_pUnit[i]->m_iFlag == CUnit::GOOD)
{
low_seq = m_pUnit[i]->m_Packet.m_iSeqNo;
low_ts = m_pUnit[i]->m_Packet.m_iTimeStamp;
break;
}
++nmissing;
}
// Not sure if a packet MUST BE at the last ack pos position, so check, just in case.
int n = m_iLastAckPos;
if (m_pUnit[n] && m_pUnit[n]->m_iFlag == CUnit::GOOD)
{
high_ts = m_pUnit[n]->m_Packet.m_iTimeStamp;
high_seq = m_pUnit[n]->m_Packet.m_iSeqNo;
}
else
{
// Possibilities are:
// m_iStartPos == m_iLastAckPos, high_ts == low_ts, defined.
// No packet: low_ts == 0, so high_ts == 0, too.
high_ts = low_ts;
}
// The 32-bit timestamps are relative and roll over oftten; what
// we really need is the timestamp difference. The only place where
// we can ask for the time base is the upper time because when trying
// to receive the time base for the lower time we'd break the requirement
// for monotonic clock.
uint64_t upper_time = high_ts;
uint64_t lower_time = low_ts;
if (lower_time > upper_time)
upper_time += uint64_t(CPacket::MAX_TIMESTAMP) + 1;
int32_t timespan = upper_time - lower_time;
int seqspan = 0;
if (low_seq != SRT_SEQNO_NONE && high_seq != SRT_SEQNO_NONE)
{
seqspan = CSeqNo::seqoff(low_seq, high_seq);
}
LOGC(brlog.Debug,
log << "RCV BUF STATS: seqspan=%(" << low_seq << "-" << high_seq << ":" << seqspan << ") missing=" << nmissing
<< "pkts");
LOGC(brlog.Debug,
log << "RCV BUF STATS: timespan=" << timespan << "us (lo=" << lower_time << " hi=" << upper_time << ")");
}
#endif // ENABLE_HEAVY_LOGGING
bool CRcvBuffer::isRcvDataReady()
{
steady_clock::time_point tsbpdtime;
int32_t seq;
return isRcvDataReady((tsbpdtime), (seq), -1);
}
int CRcvBuffer::getAvailBufSize() const
{
// One slot must be empty in order to tell the difference between "empty buffer" and "full buffer"
return m_iSize - getRcvDataSize() - 1;
}
int CRcvBuffer::getRcvDataSize() const
{
if (m_iLastAckPos >= m_iStartPos)
return m_iLastAckPos - m_iStartPos;
return m_iSize + m_iLastAckPos - m_iStartPos;
}
int CRcvBuffer::debugGetSize() const
{
// Does exactly the same as getRcvDataSize, but
// it should be used FOR INFORMATIONAL PURPOSES ONLY.
// The source values might be changed in another thread
// during the calculation, although worst case the
// resulting value may differ to the real buffer size by 1.
int from = m_iStartPos, to = m_iLastAckPos;
int size = to - from;
if (size < 0)
size += m_iSize;
return size;
}
/* Return moving average of acked data pkts, bytes, and timespan (ms) of the receive buffer */
int CRcvBuffer::getRcvAvgDataSize(int& bytes, int& timespan)
{
// Average number of packets and timespan could be small,
// so rounding is beneficial, while for the number of
// bytes in the buffer is a higher value, so rounding can be omitted,
// but probably better to round all three values.
timespan = round_val(m_mavg.timespan_ms());
bytes = round_val(m_mavg.bytes());
return round_val(m_mavg.pkts());
}
/* Update moving average of acked data pkts, bytes, and timespan (ms) of the receive buffer */
void CRcvBuffer::updRcvAvgDataSize(const steady_clock::time_point& now)
{
if (!m_mavg.isTimeToUpdate(now))
return;
int bytes = 0;
int timespan_ms = 0;
const int pkts = getRcvDataSize(bytes, timespan_ms);
m_mavg.update(now, pkts, bytes, timespan_ms);
}
/* Return acked data pkts, bytes, and timespan (ms) of the receive buffer */
int CRcvBuffer::getRcvDataSize(int& bytes, int& timespan)
{
timespan = 0;
if (m_bTsbPdMode)
{
// Get a valid startpos.
// Skip invalid entries in the beginning, if any.
int startpos = m_iStartPos;
for (; startpos != m_iLastAckPos; startpos = shiftFwd(startpos))
{
if ((NULL != m_pUnit[startpos]) && (CUnit::GOOD == m_pUnit[startpos]->m_iFlag))
break;
}
int endpos = m_iLastAckPos;
if (m_iLastAckPos != startpos)
{
/*
* |<--- DataSpan ---->|<- m_iMaxPos ->|
* +---+---+---+---+---+---+---+---+---+---+---+---
* | | 1 | 1 | 1 | 0 | 0 | 1 | 1 | 0 | 1 | | m_pUnits[]
* +---+---+---+---+---+---+---+---+---+---+---+---
* | |
* \_ m_iStartPos \_ m_iLastAckPos
*
* m_pUnits[startpos] shall be valid (->m_iFlag==CUnit::GOOD).
* If m_pUnits[m_iLastAckPos-1] is not valid (NULL or ->m_iFlag!=CUnit::GOOD),
* it means m_pUnits[m_iLastAckPos] is valid since a valid unit is needed to skip.
* Favor m_pUnits[m_iLastAckPos] if valid over [m_iLastAckPos-1] to include the whole acked interval.
*/
if ((m_iMaxPos <= 0) || (!m_pUnit[m_iLastAckPos]) || (m_pUnit[m_iLastAckPos]->m_iFlag != CUnit::GOOD))
{
endpos = (m_iLastAckPos == 0 ? m_iSize - 1 : m_iLastAckPos - 1);
}
if ((NULL != m_pUnit[endpos]) && (NULL != m_pUnit[startpos]))
{
const steady_clock::time_point startstamp =
getPktTsbPdTime(m_pUnit[startpos]->m_Packet.getMsgTimeStamp());
const steady_clock::time_point endstamp = getPktTsbPdTime(m_pUnit[endpos]->m_Packet.getMsgTimeStamp());
/*
* There are sampling conditions where spantime is < 0 (big unsigned value).
* It has been observed after changing the SRT latency from 450 to 200 on the sender.
*
* Possible packet order corruption when dropping packet,
* cause by bad thread protection when adding packet in queue
* was later discovered and fixed. Security below kept.
*
* DateTime RecvRate LostRate DropRate AvailBw RTT RecvBufs PdDelay
* 2014-12-08T15:04:25-0500 4712 110 0 96509 33.710 393 450
* 2014-12-08T15:04:35-0500 4512 95 0 107771 33.493 1496542976 200
* 2014-12-08T15:04:40-0500 4213 106 3 107352 53.657 9499425 200
* 2014-12-08T15:04:45-0500 4575 104 0 102194 53.614 59666 200
* 2014-12-08T15:04:50-0500 4475 124 0 100543 53.526 505 200
*/
if (endstamp > startstamp)
timespan = count_milliseconds(endstamp - startstamp);
}
/*
* Timespan can be less then 1000 us (1 ms) if few packets.
* Also, if there is only one pkt in buffer, the time difference will be 0.
* Therefore, always add 1 ms if not empty.
*/
if (0 < m_iAckedPktsCount)
timespan += 1;
}
}
HLOGF(brlog.Debug, "getRcvDataSize: %6d %6d %6d ms\n", m_iAckedPktsCount, m_iAckedBytesCount, timespan);
bytes = m_iAckedBytesCount;
return m_iAckedPktsCount;
}
unsigned CRcvBuffer::getRcvAvgPayloadSize() const
{
return m_uAvgPayloadSz;
}
void CRcvBuffer::dropMsg(int32_t msgno, bool using_rexmit_flag)
{
for (int i = m_iStartPos, n = shift(m_iLastAckPos, m_iMaxPos); i != n; i = shiftFwd(i))
if ((m_pUnit[i] != NULL) && (m_pUnit[i]->m_Packet.getMsgSeq(using_rexmit_flag) == msgno))
m_pUnit[i]->m_iFlag = CUnit::DROPPED;
}
steady_clock::time_point CRcvBuffer::getTsbPdTimeBase(uint32_t timestamp_us)
{
/*
* Packet timestamps wrap around every 01h11m35s (32-bit in usec)
* When added to the peer start time (base time),
* wrapped around timestamps don't provide a valid local packet delevery time.
*
* A wrap check period starts 30 seconds before the wrap point.
* In this period, timestamps smaller than 30 seconds are considered to have wrapped around (then adjusted).
* The wrap check period ends 30 seconds after the wrap point, afterwhich time base has been adjusted.
*/
int64_t carryover = 0;
// This function should generally return the timebase for the given timestamp_us.
// It's assumed that the timestamp_us, for which this function is being called,
// is received as monotonic clock. This function then traces the changes in the
// timestamps passed as argument and catches the moment when the 64-bit timebase
// should be increased by a "segment length" (MAX_TIMESTAMP+1).
// The checks will be provided for the following split:
// [INITIAL30][FOLLOWING30]....[LAST30] <-- == CPacket::MAX_TIMESTAMP
//
// The following actions should be taken:
// 1. Check if this is [LAST30]. If so, ENTER TSBPD-wrap-check state
// 2. Then, it should turn into [INITIAL30] at some point. If so, use carryover MAX+1.
// 3. Then it should switch to [FOLLOWING30]. If this is detected,
// - EXIT TSBPD-wrap-check state
// - save the carryover as the current time base.
if (m_bTsbPdWrapCheck)
{
// Wrap check period.
if (timestamp_us < TSBPD_WRAP_PERIOD)
{
carryover = int64_t(CPacket::MAX_TIMESTAMP) + 1;
}
//
else if ((timestamp_us >= TSBPD_WRAP_PERIOD) && (timestamp_us <= (TSBPD_WRAP_PERIOD * 2)))
{
/* Exiting wrap check period (if for packet delivery head) */
m_bTsbPdWrapCheck = false;
m_tsTsbPdTimeBase += microseconds_from(int64_t(CPacket::MAX_TIMESTAMP) + 1);
LOGC(tslog.Debug,
log << "tsbpd wrap period ends with ts=" << timestamp_us << " - NEW TIME BASE: "
<< FormatTime(m_tsTsbPdTimeBase) << " drift: " << m_DriftTracer.drift() << "us");
}
}
// Check if timestamp_us is in the last 30 seconds before reaching the MAX_TIMESTAMP.
else if (timestamp_us > (CPacket::MAX_TIMESTAMP - TSBPD_WRAP_PERIOD))
{
/* Approching wrap around point, start wrap check period (if for packet delivery head) */
m_bTsbPdWrapCheck = true;
LOGC(tslog.Debug,
log << "tsbpd wrap period begins with ts=" << timestamp_us << " drift: " << m_DriftTracer.drift()
<< "us.");
}
return (m_tsTsbPdTimeBase + microseconds_from(carryover));
}
void CRcvBuffer::applyGroupTime(const steady_clock::time_point& timebase,
bool wrp,
uint32_t delay,
const steady_clock::duration& udrift)
{
// Same as setRcvTsbPdMode, but predicted to be used for group members.
// This synchronizes the time from the INTERNAL TIMEBASE of an existing
// socket's internal timebase. This is required because the initial time
// base stays always the same, whereas the internal timebase undergoes
// adjustment as the 32-bit timestamps in the sockets wrap. The socket
// newly added to the group must get EXACTLY the same internal timebase
// or otherwise the TsbPd time calculation will ship different results
// on different sockets.
m_bTsbPdMode = true;
m_tsTsbPdTimeBase = timebase;
m_bTsbPdWrapCheck = wrp;
m_tdTsbPdDelay = microseconds_from(delay);
m_DriftTracer.forceDrift(count_microseconds(udrift));
}
void CRcvBuffer::applyGroupDrift(const steady_clock::time_point& timebase,
bool wrp,
const steady_clock::duration& udrift)
{
// This is only when a drift was updated on one of the group members.
HLOGC(brlog.Debug,
log << "rcv-buffer: group synch uDRIFT: " << m_DriftTracer.drift() << " -> " << FormatDuration(udrift)
<< " TB: " << FormatTime(m_tsTsbPdTimeBase) << " -> " << FormatTime(timebase));
m_tsTsbPdTimeBase = timebase;
m_bTsbPdWrapCheck = wrp;
m_DriftTracer.forceDrift(count_microseconds(udrift));
}
bool CRcvBuffer::getInternalTimeBase(steady_clock::time_point& w_timebase, steady_clock::duration& w_udrift)
{
w_timebase = m_tsTsbPdTimeBase;
w_udrift = microseconds_from(m_DriftTracer.drift());
return m_bTsbPdWrapCheck;
}
steady_clock::time_point CRcvBuffer::getPktTsbPdTime(uint32_t timestamp)
{
const steady_clock::time_point time_base = getTsbPdTimeBase(timestamp);
// Display only ingredients, not the result, as the result will
// be displayed anyway in the next logs.
HLOGC(brlog.Debug,
log << "getPktTsbPdTime: TIMEBASE=" << FormatTime(time_base) << " + dTS=" << timestamp
<< "us + LATENCY=" << FormatDuration<DUNIT_MS>(m_tdTsbPdDelay) << " + uDRIFT=" << m_DriftTracer.drift());
return (time_base + m_tdTsbPdDelay + microseconds_from(timestamp + m_DriftTracer.drift()));
}
int CRcvBuffer::setRcvTsbPdMode(const steady_clock::time_point& timebase, const steady_clock::duration& delay)
{
m_bTsbPdMode = true;
m_bTsbPdWrapCheck = false;
// Timebase passed here comes is calculated as:
// >>> CTimer::getTime() - ctrlpkt->m_iTimeStamp
// where ctrlpkt is the packet with SRT_CMD_HSREQ message.
//
// This function is called in the HSREQ reception handler only.
m_tsTsbPdTimeBase = timebase;
// XXX Seems like this may not work correctly.
// At least this solution this way won't work with application-supplied
// timestamps. For that case the timestamps should be taken exclusively
// from the data packets because in case of application-supplied timestamps
// they come from completely different server and undergo different rules
// of network latency and drift.
m_tdTsbPdDelay = delay;
return 0;
}
#ifdef SRT_DEBUG_TSBPD_DRIFT
void CRcvBuffer::printDriftHistogram(int64_t iDrift)
{
/*
* Build histogram of drift values
* First line (ms): <=-10.0 -9.0 ... -1.0 - 0.0 + 1.0 ... 9.0 >=10.0
* Second line (ms): -0.9 ... -0.1 - 0.0 + 0.1 ... 0.9
* 0 0 0 0 0 0 0 0 0 0 - 0 + 0 0 0 1 0 0 0 0 0 0
* 0 0 0 0 0 0 0 0 0 - 0 + 0 0 0 0 0 0 0 0 0
*/
iDrift /= 100; // uSec to 100 uSec (0.1ms)
if (-10 < iDrift && iDrift < 10)
{
/* Fill 100us histogram -900 .. 900 us 100 us increments */
m_TsbPdDriftHisto100us[10 + iDrift]++;
}
else
{
/* Fill 1ms histogram <=-10.0, -9.0 .. 9.0, >=10.0 ms in 1 ms increments */
iDrift /= 10; // 100uSec to 1ms
if (-10 < iDrift && iDrift < 10)
m_TsbPdDriftHisto1ms[10 + iDrift]++;
else if (iDrift <= -10)
m_TsbPdDriftHisto1ms[0]++;
else
m_TsbPdDriftHisto1ms[20]++;
}
++m_iTsbPdDriftNbSamples;
if ((m_iTsbPdDriftNbSamples % TSBPD_DRIFT_PRT_SAMPLES) == 0)
{
int* histo = m_TsbPdDriftHisto1ms;
fprintf(stderr,
"%4d %4d %4d %4d %4d %4d %4d %4d %4d %4d - %4d + ",
histo[0],
histo[1],
histo[2],
histo[3],
histo[4],
histo[5],
histo[6],
histo[7],
histo[8],
histo[9],
histo[10]);
fprintf(stderr,
"%4d %4d %4d %4d %4d %4d %4d %4d %4d %4d\n",
histo[11],
histo[12],
histo[13],
histo[14],
histo[15],
histo[16],
histo[17],
histo[18],
histo[19],
histo[20]);
histo = m_TsbPdDriftHisto100us;
fprintf(stderr,
" %4d %4d %4d %4d %4d %4d %4d %4d %4d - %4d + ",
histo[1],
histo[2],
histo[3],
histo[4],
histo[5],
histo[6],
histo[7],
histo[8],
histo[9],
histo[10]);
fprintf(stderr,
"%4d %4d %4d %4d %4d %4d %4d %4d %4d\n",
histo[11],
histo[12],
histo[13],
histo[14],
histo[15],
histo[16],
histo[17],
histo[18],
histo[19]);
m_iTsbPdDriftNbSamples = 0;
}
}
void CRcvBuffer::printDriftOffset(int tsbPdOffset, int tsbPdDriftAvg)
{
fprintf(stderr,
"%s: tsbpd offset=%d drift=%d usec\n",
FormatTime(steady_clock::now()).c_str(),
tsbPdOffset,
tsbPdDriftAvg);
memset(m_TsbPdDriftHisto100us, 0, sizeof(m_TsbPdDriftHisto100us));
memset(m_TsbPdDriftHisto1ms, 0, sizeof(m_TsbPdDriftHisto1ms));
}
#endif /* SRT_DEBUG_TSBPD_DRIFT */
bool CRcvBuffer::addRcvTsbPdDriftSample(uint32_t timestamp_us,
Mutex& mutex_to_lock,
steady_clock::duration& w_udrift,
steady_clock::time_point& w_newtimebase)
{
if (!m_bTsbPdMode) // Not checked unless in TSBPD mode
return false;
/*
* TsbPD time drift correction
* TsbPD time slowly drift over long period depleting decoder buffer or raising latency
* Re-evaluate the time adjustment value using a receiver control packet (ACK-ACK).
* ACK-ACK timestamp is RTT/2 ago (in sender's time base)
* Data packet have origin time stamp which is older when retransmitted so not suitable for this.
*
* Every TSBPD_DRIFT_MAX_SAMPLES packets, the average drift is calculated
* if -TSBPD_DRIFT_MAX_VALUE < avgTsbPdDrift < TSBPD_DRIFT_MAX_VALUE uSec, pass drift value to RcvBuffer to adjust
* delevery time. if outside this range, adjust this->TsbPdTimeOffset and RcvBuffer->TsbPdTimeBase by
* +-TSBPD_DRIFT_MAX_VALUE uSec to maintain TsbPdDrift values in reasonable range (-5ms .. +5ms).
*/
// Note important thing: this function is being called _EXCLUSIVELY_ in the handler
// of UMSG_ACKACK command reception. This means that the timestamp used here comes
// from the CONTROL domain, not DATA domain (timestamps from DATA domain may be
// either schedule time or a time supplied by the application).
const steady_clock::duration iDrift =
steady_clock::now() - (getTsbPdTimeBase(timestamp_us) + microseconds_from(timestamp_us));
enterCS(mutex_to_lock);
bool updated = m_DriftTracer.update(count_microseconds(iDrift));
#ifdef SRT_DEBUG_TSBPD_DRIFT
printDriftHistogram(count_microseconds(iDrift));
#endif /* SRT_DEBUG_TSBPD_DRIFT */
if (updated)
{
#ifdef SRT_DEBUG_TSBPD_DRIFT
printDriftOffset(m_DriftTracer.overdrift(), m_DriftTracer.drift());
#endif /* SRT_DEBUG_TSBPD_DRIFT */
#if ENABLE_HEAVY_LOGGING
const steady_clock::time_point oldbase = m_tsTsbPdTimeBase;
#endif
steady_clock::duration overdrift = microseconds_from(m_DriftTracer.overdrift());
m_tsTsbPdTimeBase += overdrift;
HLOGC(brlog.Debug,
log << "DRIFT=" << FormatDuration(iDrift) << " AVG=" << (m_DriftTracer.drift() / 1000.0)
<< "ms, TB: " << FormatTime(oldbase) << " EXCESS: " << FormatDuration(overdrift)
<< " UPDATED TO: " << FormatTime(m_tsTsbPdTimeBase));
}
else
{
HLOGC(brlog.Debug,
log << "DRIFT=" << FormatDuration(iDrift) << " TB REMAINS: " << FormatTime(m_tsTsbPdTimeBase));
}
leaveCS(mutex_to_lock);
w_udrift = iDrift;
w_newtimebase = m_tsTsbPdTimeBase;
return updated;
}
int CRcvBuffer::readMsg(char* data, int len)
{
SRT_MSGCTRL dummy = srt_msgctrl_default;
return readMsg(data, len, (dummy), -1);
}
// NOTE: The order of ref-arguments is odd because:
// - data and len shall be close to one another
// - upto is last because it's a kind of unusual argument that has a default value
int CRcvBuffer::readMsg(char* data, int len, SRT_MSGCTRL& w_msgctl, int upto)
{
int p = -1, q = -1;
bool passack;
bool empty = accessMsg((p), (q), (passack), (w_msgctl.srctime), upto);
if (empty)
return 0;
// This should happen just once. By 'empty' condition
// we have a guarantee that m_pUnit[p] exists and is valid.
CPacket& pkt1 = m_pUnit[p]->m_Packet;
// This returns the sequence number and message number to
// the API caller.
w_msgctl.pktseq = pkt1.getSeqNo();
w_msgctl.msgno = pkt1.getMsgSeq();
return extractData((data), len, p, q, passack);
}
#ifdef SRT_DEBUG_TSBPD_OUTJITTER
void CRcvBuffer::debugTraceJitter(int64_t rplaytime)
{
uint64_t now = CTimer::getTime();
if ((now - rplaytime) / 10 < 10)
m_ulPdHisto[0][(now - rplaytime) / 10]++;
else if ((now - rplaytime) / 100 < 10)
m_ulPdHisto[1][(now - rplaytime) / 100]++;
else if ((now - rplaytime) / 1000 < 10)
m_ulPdHisto[2][(now - rplaytime) / 1000]++;
else
m_ulPdHisto[3][1]++;
}
#endif /* SRT_DEBUG_TSBPD_OUTJITTER */
bool CRcvBuffer::accessMsg(int& w_p, int& w_q, bool& w_passack, int64_t& w_playtime, int upto)
{
// This function should do the following:
// 1. Find the first packet starting the next message (or just next packet)
// 2. When found something ready for extraction, return true.
// 3. w_p and w_q point the index range for extraction
// 4. passack decides if this range shall be removed after extraction
bool empty = true;
if (m_bTsbPdMode)
{
w_passack = false;
int seq = 0;
steady_clock::time_point play_time;
const bool isReady = getRcvReadyMsg(play_time, (seq), upto);
w_playtime = count_microseconds(play_time.time_since_epoch());
if (isReady)
{
empty = false;
// In TSBPD mode you always read one message
// at a time and a message always fits in one UDP packet,
// so in one "unit".
w_p = w_q = m_iStartPos;
debugTraceJitter(w_playtime);
}
}
else
{
w_playtime = 0;
if (scanMsg((w_p), (w_q), (w_passack)))
empty = false;
}
return empty;
}
int CRcvBuffer::extractData(char* data, int len, int p, int q, bool passack)
{
SRT_ASSERT(len > 0);
int rs = len > 0 ? len : 0;
const int past_q = shiftFwd(q);
while (p != past_q)
{
const int pktlen = (int)m_pUnit[p]->m_Packet.getLength();
// When unitsize is less than pktlen, only a fragment is copied to the output 'data',
// but still the whole packet is removed from the receiver buffer.
if (pktlen > 0)
countBytes(-1, -pktlen, true);
const int unitsize = ((rs >= 0) && (pktlen > rs)) ? rs : pktlen;
HLOGC(brlog.Debug, log << "readMsg: checking unit POS=" << p);
if (unitsize > 0)
{
memcpy((data), m_pUnit[p]->m_Packet.m_pcData, unitsize);
data += unitsize;
rs -= unitsize;
IF_HEAVY_LOGGING(readMsgHeavyLogging(p));
}
else
{
HLOGC(brlog.Debug, log << CONID() << "readMsg: SKIPPED POS=" << p << " - ZERO SIZE UNIT");
}
// Note special case for live mode (one packet per message and TSBPD=on):
// - p == q (that is, this loop passes only once)
// - no passack (the unit is always removed from the buffer)
if (!passack)
{
HLOGC(brlog.Debug, log << CONID() << "readMsg: FREEING UNIT POS=" << p);
freeUnitAt(p);
}
else
{
HLOGC(brlog.Debug, log << CONID() << "readMsg: PASSACK UNIT POS=" << p);
m_pUnit[p]->m_iFlag = CUnit::PASSACK;
}
p = shiftFwd(p);
}
if (!passack)
m_iStartPos = past_q;
HLOGC(brlog.Debug,
log << "rcvBuf/extractData: begin=" << m_iStartPos << " reporting extraction size=" << (len - rs));
return len - rs;
}
string CRcvBuffer::debugTimeState(size_t first_n_pkts) const
{
stringstream ss;
int ipos = m_iStartPos;
for (size_t i = 0; i < first_n_pkts; ++i, ipos = CSeqNo::incseq(ipos))
{
const CUnit* unit = m_pUnit[ipos];
if (!unit)
{
ss << "pkt[" << i << "] missing, ";
continue;
}
const CPacket& pkt = unit->m_Packet;
ss << "pkt[" << i << "] ts=" << pkt.getMsgTimeStamp() << ", ";
}
return ss.str();
}
#if ENABLE_HEAVY_LOGGING
void CRcvBuffer::readMsgHeavyLogging(int p)
{
static steady_clock::time_point prev_now;
static steady_clock::time_point prev_srctime;
const CPacket& pkt = m_pUnit[p]->m_Packet;
const int32_t seq = pkt.m_iSeqNo;
steady_clock::time_point nowtime = steady_clock::now();
steady_clock::time_point srctime = getPktTsbPdTime(m_pUnit[p]->m_Packet.getMsgTimeStamp());
const int64_t timediff_ms = count_milliseconds(nowtime - srctime);
const int64_t nowdiff_ms = is_zero(prev_now) ? count_milliseconds(nowtime - prev_now) : 0;
const int64_t srctimediff_ms = is_zero(prev_srctime) ? count_milliseconds(srctime - prev_srctime) : 0;
const int next_p = shiftFwd(p);
CUnit* u = m_pUnit[next_p];
string next_playtime;
if (u && u->m_iFlag == CUnit::GOOD)
{
next_playtime = FormatTime(getPktTsbPdTime(u->m_Packet.getMsgTimeStamp()));
}
else
{
next_playtime = "NONE";
}
LOGC(brlog.Debug,
log << CONID() << "readMsg: DELIVERED seq=" << seq << " T=" << FormatTime(srctime) << " in " << timediff_ms
<< "ms - TIME-PREVIOUS: PKT: " << srctimediff_ms << " LOCAL: " << nowdiff_ms << " !"
<< BufferStamp(pkt.data(), pkt.size()) << " NEXT pkt T=" << next_playtime);
prev_now = nowtime;
prev_srctime = srctime;
}
#endif
bool CRcvBuffer::scanMsg(int& w_p, int& w_q, bool& w_passack)
{
// empty buffer
if ((m_iStartPos == m_iLastAckPos) && (m_iMaxPos <= 0))
{
HLOGC(brlog.Debug, log << "scanMsg: empty buffer");
return false;
}
int rmpkts = 0;
int rmbytes = 0;
// skip all bad msgs at the beginning
// This loop rolls until the "buffer is empty" (head == tail),
// in particular, there's no unit accessible for the reader.
while (m_iStartPos != m_iLastAckPos)
{
// Roll up to the first valid unit
if (!m_pUnit[m_iStartPos])
{
if (++m_iStartPos == m_iSize)
m_iStartPos = 0;
continue;
}
// Note: PB_FIRST | PB_LAST == PB_SOLO.
// testing if boundary() & PB_FIRST tests if the msg is first OR solo.
if (m_pUnit[m_iStartPos]->m_iFlag == CUnit::GOOD && m_pUnit[m_iStartPos]->m_Packet.getMsgBoundary() & PB_FIRST)
{
bool good = true;
// look ahead for the whole message
// We expect to see either of:
// [PB_FIRST] [PB_SUBSEQUENT] [PB_SUBSEQUENT] [PB_LAST]
// [PB_SOLO]
// but not:
// [PB_FIRST] NULL ...
// [PB_FIRST] FREE/PASSACK/DROPPED...
// If the message didn't look as expected, interrupt this.
// This begins with a message starting at m_iStartPos
// up to m_iLastAckPos OR until the PB_LAST message is found.
// If any of the units on this way isn't good, this OUTER loop
// will be interrupted.
for (int i = m_iStartPos; i != m_iLastAckPos;)
{
if (!m_pUnit[i] || m_pUnit[i]->m_iFlag != CUnit::GOOD)
{
good = false;
break;
}
// Likewise, boundary() & PB_LAST will be satisfied for last OR solo.
if (m_pUnit[i]->m_Packet.getMsgBoundary() & PB_LAST)
break;
if (++i == m_iSize)
i = 0;
}
if (good)
break;
}
rmpkts++;
rmbytes += freeUnitAt(m_iStartPos);
m_iStartPos = shiftFwd(m_iStartPos);
}
/* we removed bytes form receive buffer */
countBytes(-rmpkts, -rmbytes, true);
// Not sure if this is correct, but this above 'while' loop exits
// under the following conditions only:
// - m_iStartPos == m_iLastAckPos (that makes passack = true)
// - found at least GOOD unit with PB_FIRST and not all messages up to PB_LAST are good,
// in which case it returns with m_iStartPos <% m_iLastAckPos (earlier)
// Also all units that lied before m_iStartPos are removed.
w_p = -1; // message head
w_q = m_iStartPos; // message tail
w_passack = m_iStartPos == m_iLastAckPos;
bool found = false;
// looking for the first message
//>>m_pUnit[size + m_iMaxPos] is not valid
// XXX Would be nice to make some very thorough refactoring here.
// This rolls by q variable from m_iStartPos up to m_iLastAckPos,
// actually from the first message up to the one with PB_LAST
// or PB_SOLO boundary.
// The 'i' variable used in this loop is just a stub and it's
// even hard to define the unit here. It is "shift towards
// m_iStartPos", so the upper value is m_iMaxPos + size.
// m_iMaxPos is itself relative to m_iLastAckPos, so
// the upper value is m_iMaxPos + difference between
// m_iLastAckPos and m_iStartPos, so that this value is relative
// to m_iStartPos.
//
// The 'i' value isn't used anywhere, although the 'q' value rolls
// in this loop in sync with 'i', with the difference that 'q' is
// wrapped around, and 'i' is just incremented normally.
//
// This makes that this loop rolls in the range by 'q' from
// m_iStartPos to m_iStartPos + UPPER,
// where UPPER = m_iLastAckPos -% m_iStartPos + m_iMaxPos
// This embraces the range from the current reading head up to
// the last packet ever received.
//
// 'passack' is set to true when the 'q' has passed through
// the border of m_iLastAckPos and fallen into the range
// of unacknowledged packets.
for (int i = 0, n = m_iMaxPos + getRcvDataSize(); i < n; ++i)
{
if (m_pUnit[w_q] && m_pUnit[w_q]->m_iFlag == CUnit::GOOD)
{
// Equivalent pseudocode:
// PacketBoundary bound = m_pUnit[w_q]->m_Packet.getMsgBoundary();
// if ( IsSet(bound, PB_FIRST) )
// w_p = w_q;
// if ( IsSet(bound, PB_LAST) && w_p != -1 )
// found = true;
//
// Not implemented this way because it uselessly check w_p for -1
// also after setting it explicitly.
switch (m_pUnit[w_q]->m_Packet.getMsgBoundary())
{
case PB_SOLO: // 11
w_p = w_q;
found = true;
break;
case PB_FIRST: // 10
w_p = w_q;
break;
case PB_LAST: // 01
if (w_p != -1)
found = true;
break;
case PB_SUBSEQUENT:; // do nothing (caught first, rolling for last)
}
}
else
{
// a hole in this message, not valid, restart search
w_p = -1;
}
// 'found' is set when the current iteration hit a message with PB_LAST
// (including PB_SOLO since the very first message).
if (found)
{
// the msg has to be ack'ed or it is allowed to read out of order, and was not read before
if (!w_passack || !m_pUnit[w_q]->m_Packet.getMsgOrderFlag())
{
HLOGC(brlog.Debug, log << "scanMsg: found next-to-broken message, delivering OUT OF ORDER.");
break;
}
found = false;
}
if (++w_q == m_iSize)
w_q = 0;
if (w_q == m_iLastAckPos)
w_passack = true;
}
// no msg found
if (!found)
{
// NOTE:
// This situation may only happen if:
// - Found a packet with PB_FIRST, so w_p = w_q at the moment when it was found
// - Possibly found following components of that message up to shifted w_q
// - Found no terminal packet (PB_LAST) for that message.
// if the message is larger than the receiver buffer, return part of the message
if ((w_p != -1) && (shiftFwd(w_q) == w_p))
{
HLOGC(brlog.Debug, log << "scanMsg: BUFFER FULL and message is INCOMPLETE. Returning PARTIAL MESSAGE.");
found = true;
}
else
{
HLOGC(brlog.Debug, log << "scanMsg: PARTIAL or NO MESSAGE found: p=" << w_p << " q=" << w_q);
}
}
else
{
HLOGC(brlog.Debug,
log << "scanMsg: extracted message p=" << w_p << " q=" << w_q << " ("
<< ((w_q - w_p + m_iSize + 1) % m_iSize) << " packets)");
}
return found;
}
|