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
|
/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#include <aws/mqtt/request-response/request_response_client.h>
#include <aws/common/clock.h>
#include <aws/common/json.h>
#include <aws/common/ref_count.h>
#include <aws/common/task_scheduler.h>
#include <aws/io/event_loop.h>
#include <aws/mqtt/private/client_impl_shared.h>
#include <aws/mqtt/private/request-response/protocol_adapter.h>
#include <aws/mqtt/private/request-response/subscription_manager.h>
#include <aws/mqtt/private/v5/mqtt5_client_impl.h>
#include <inttypes.h>
#define MQTT_RR_CLIENT_OPERATION_TABLE_DEFAULT_SIZE 50
#define MQTT_RR_CLIENT_RESPONSE_TABLE_DEFAULT_SIZE 50
struct aws_mqtt_request_operation_storage {
struct aws_mqtt_request_operation_options options;
struct aws_array_list operation_response_paths;
struct aws_array_list subscription_topic_filters;
struct aws_byte_buf operation_data;
};
struct aws_mqtt_streaming_operation_storage {
struct aws_mqtt_streaming_operation_options options;
struct aws_byte_buf operation_data;
struct aws_atomic_var activated;
};
enum aws_mqtt_request_response_operation_type {
AWS_MRROT_REQUEST,
AWS_MRROT_STREAMING,
};
enum aws_mqtt_request_response_operation_state {
/* creation -> in event loop enqueue */
AWS_MRROS_NONE,
/* in event loop queue -> non blocked response from subscription manager */
AWS_MRROS_QUEUED,
/* subscribing response from sub manager -> subscription success/failure event */
AWS_MRROS_PENDING_SUBSCRIPTION,
/* (request only) subscription success -> (publish failure OR correlated response received) */
AWS_MRROS_PENDING_RESPONSE,
/* (request only) the operation's destroy task has been scheduled but not yet executed */
AWS_MRROS_PENDING_DESTROY,
/* (streaming only) subscription success -> (operation finished OR subscription ended event) */
AWS_MRROS_SUBSCRIBED,
/* (streaming only) (subscription failure OR subscription ended) -> operation close/terminate */
AWS_MRROS_TERMINAL,
};
const char *s_aws_mqtt_request_response_operation_state_to_c_str(enum aws_mqtt_request_response_operation_state state) {
switch (state) {
case AWS_MRROS_NONE:
return "NONE";
case AWS_MRROS_QUEUED:
return "QUEUED";
case AWS_MRROS_PENDING_SUBSCRIPTION:
return "PENDING_SUBSCRIPTION";
case AWS_MRROS_PENDING_RESPONSE:
return "PENDING_RESPONSE";
case AWS_MRROS_SUBSCRIBED:
return "SUBSCRIBED";
case AWS_MRROS_TERMINAL:
return "TERMINAL";
case AWS_MRROS_PENDING_DESTROY:
return "PENDING_DESTROY";
default:
return "Unknown";
}
}
const char *s_aws_acquire_subscription_result_type(enum aws_acquire_subscription_result_type result) {
switch (result) {
case AASRT_SUBSCRIBED:
return "SUBSCRIBED";
case AASRT_SUBSCRIBING:
return "SUBSCRIBING";
case AASRT_BLOCKED:
return "BLOCKED";
case AASRT_NO_CAPACITY:
return "NO_CAPACITY";
case AASRT_FAILURE:
return "FAILURE";
default:
return "Unknown";
}
}
/*
Client Tables/Lookups
(operations: authoritative operation container)
1. &operation.id -> &operation // added on in-thread enqueue, removed on operation completion/destruction
(request_response_paths: response path topic -> Correlation token extraction info)
2. &topic -> &{topic, topic_buffer, correlation token json path buffer} // ref-counted, per-message-path add on
request dequeue into subscribing/subscribed state, decref/removed on operation completion/destruction
(operations_by_correlation_tokens: correlationToken -> request operation)
3. &operation.correlation token -> (request) &operation // added on request dequeue into subscribing/subscribed
state, removed on operation completion/destruction
(streaming_operation_subscription_lists: streaming subscription filter -> list of all operations using that filter)
4. &topic_filter -> &{topic_filter, linked_list} // added on request dequeue into subscribing/subscribed state,
removed from list on operation completion/destruction also checked for empty and removed from table
*/
/*
* This is the (key and) value in hash table (4) above.
*/
struct aws_rr_operation_list_topic_filter_entry {
struct aws_allocator *allocator;
struct aws_byte_cursor topic_filter_cursor;
struct aws_byte_buf topic_filter;
struct aws_linked_list operations;
};
static struct aws_rr_operation_list_topic_filter_entry *s_aws_rr_operation_list_topic_filter_entry_new(
struct aws_allocator *allocator,
struct aws_byte_cursor topic_filter) {
struct aws_rr_operation_list_topic_filter_entry *entry =
aws_mem_calloc(allocator, 1, sizeof(struct aws_rr_operation_list_topic_filter_entry));
entry->allocator = allocator;
aws_byte_buf_init_copy_from_cursor(&entry->topic_filter, allocator, topic_filter);
entry->topic_filter_cursor = aws_byte_cursor_from_buf(&entry->topic_filter);
aws_linked_list_init(&entry->operations);
return entry;
}
static void s_aws_rr_operation_list_topic_filter_entry_destroy(struct aws_rr_operation_list_topic_filter_entry *entry) {
if (entry == NULL) {
return;
}
aws_byte_buf_clean_up(&entry->topic_filter);
aws_mem_release(entry->allocator, entry);
}
static void s_aws_rr_operation_list_topic_filter_entry_hash_element_destroy(void *value) {
s_aws_rr_operation_list_topic_filter_entry_destroy(value);
}
struct aws_rr_response_path_entry {
struct aws_allocator *allocator;
size_t ref_count;
struct aws_byte_cursor topic_cursor;
struct aws_byte_buf topic;
struct aws_byte_buf correlation_token_json_path;
};
static struct aws_rr_response_path_entry *s_aws_rr_response_path_entry_new(
struct aws_allocator *allocator,
struct aws_byte_cursor topic,
struct aws_byte_cursor correlation_token_json_path) {
struct aws_rr_response_path_entry *entry = aws_mem_calloc(allocator, 1, sizeof(struct aws_rr_response_path_entry));
entry->allocator = allocator;
entry->ref_count = 1;
aws_byte_buf_init_copy_from_cursor(&entry->topic, allocator, topic);
entry->topic_cursor = aws_byte_cursor_from_buf(&entry->topic);
aws_byte_buf_init_copy_from_cursor(&entry->correlation_token_json_path, allocator, correlation_token_json_path);
return entry;
}
static void s_aws_rr_response_path_entry_destroy(struct aws_rr_response_path_entry *entry) {
if (entry == NULL) {
return;
}
aws_byte_buf_clean_up(&entry->topic);
aws_byte_buf_clean_up(&entry->correlation_token_json_path);
aws_mem_release(entry->allocator, entry);
}
static void s_aws_rr_response_path_table_hash_element_destroy(void *value) {
s_aws_rr_response_path_entry_destroy(value);
}
struct aws_mqtt_rr_client_operation {
struct aws_allocator *allocator;
/*
* Operation ref-counting is a bit tricky and un-intuitive because it differs based on the type of operation.
*
* Streaming operations are managed by the user, and so the ref count is their responsibility to drop to zero.
* Dropping a streaming operation's ref count to zero schedules a task on the client event loop to destroy the
* operation. It is expected that the binding client will track (with proper synchronization) all unclosed
* streaming operations and safely close them for the user when close is called on the binding client.
*
* Request operations are managed by the client, and so the ref count is dropped to zero when either the
* operation completes normally (success or failure) or when the client is shutdown due to its external ref
* count dropping to zero. In all cases, this event happens naturally on the client event loop.
*
* So the summary is:
*
* (1) Streaming operation clean up is initiated by the user calling dec ref on the streaming operation
* (2) Request operation clean up is initiated by normal completion or client shutdown invoking dec ref.
*
* The upshot is that client shutdown dec-refs request operations but not streaming operations.
*/
struct aws_ref_count ref_count;
struct aws_mqtt_request_response_client *client_internal_ref;
uint64_t id;
enum aws_mqtt_request_response_operation_type type;
union {
struct aws_mqtt_streaming_operation_storage streaming_storage;
struct aws_mqtt_request_operation_storage request_storage;
} storage;
uint64_t timeout_timepoint_ns;
struct aws_priority_queue_node priority_queue_node;
/* Sometimes this is client->operation_queue, other times it is an entry in the client's topic_filter table */
struct aws_linked_list_node node;
enum aws_mqtt_request_response_operation_state state;
size_t pending_subscriptions;
bool in_client_tables;
struct aws_task submit_task;
struct aws_task destroy_task;
};
/*******************************************************************************************/
/* Tracks the current state of the request-response client */
enum aws_request_response_client_state {
/* cross-thread initialization has not completed and all protocol adapter callbacks are ignored */
AWS_RRCS_UNINITIALIZED,
/* Normal operating state for the client. */
AWS_RRCS_ACTIVE,
/* asynchronously shutting down, no more servicing will be done and all protocol adapter callbacks are ignored */
AWS_RRCS_SHUTTING_DOWN,
};
/*
* Request-Response Client Notes
*
* Ref-counting/Shutdown
*
* The request-response client uses a double ref-count pattern.
*
* External references represent user references. When the external reference reaches zero, the client's asynchronous
* shutdown process is started.
*
* Internal references block final destruction. Asynchronous shutdown will not complete until all internal references
* are dropped. In addition to one long-lived internal reference (the protocol client adapter's back reference to
* the request-response client), all event loop tasks that target the request-response client hold an internal
* reference between task submission and task completion. This ensures that the task always has a valid reference
* to the client, even if we're trying to shut down at the same time.
*
*
* Initialization
*
* Initialization is complicated by the fact that the subscription manager needs to be initialized from the
* event loop thread that the client/protocol adapter/protocol client are all seated on. To do this safely,
* we add an uninitialized state that ignores all callbacks and we schedule a task on initial construction to do
* the event-loop-only initialization. Once that initialization completes on the event loop thread, we move
* the client into an active state where it will process operations and protocol adapter callbacks.
*/
struct aws_mqtt_request_response_client {
struct aws_allocator *allocator;
struct aws_ref_count external_ref_count;
struct aws_ref_count internal_ref_count;
struct aws_mqtt_request_response_client_options config;
struct aws_mqtt_protocol_adapter *client_adapter;
struct aws_rr_subscription_manager subscription_manager;
struct aws_event_loop *loop;
struct aws_task initialize_task;
struct aws_task external_shutdown_task;
struct aws_task internal_shutdown_task;
uint64_t scheduled_service_timepoint_ns;
struct aws_task service_task;
enum aws_request_response_client_state state;
struct aws_atomic_var next_id;
struct aws_linked_list operation_queue;
/* &operation->id -> &operation */
struct aws_hash_table operations;
/*
* heap of operation pointers where the timeout is the sort value. Elements are added to this on operation
* submission and removed on operation timeout/completion/termination. Request-response operations have actual
* timeouts, while streaming operations have UINT64_MAX timeouts.
*/
struct aws_priority_queue operations_by_timeout;
/*
* Map from cursor (topic filter) -> list of streaming operations using that filter
*/
struct aws_hash_table streaming_operation_subscription_lists;
/*
* Map from cursor (topic) -> request response path (topic, correlation token json path)
*
* We don't garbage collect this table over the course of normal client operation. We only clean it up
* when the client is shutting down.
*/
struct aws_hash_table request_response_paths;
/*
* Map from cursor (correlation token) -> request operation
*/
struct aws_hash_table operations_by_correlation_tokens;
};
struct aws_mqtt_request_response_client *aws_mqtt_request_response_client_acquire_internal(
struct aws_mqtt_request_response_client *client) {
if (client != NULL) {
aws_ref_count_acquire(&client->internal_ref_count);
}
return client;
}
struct aws_mqtt_request_response_client *aws_mqtt_request_response_client_release_internal(
struct aws_mqtt_request_response_client *client) {
if (client != NULL) {
aws_ref_count_release(&client->internal_ref_count);
}
return NULL;
}
static void s_aws_rr_client_on_zero_internal_ref_count(void *context) {
struct aws_mqtt_request_response_client *client = context;
/* Both ref counts are zero, but it's still safest to schedule final destruction, not invoke it directly */
aws_event_loop_schedule_task_now(client->loop, &client->internal_shutdown_task);
}
static void s_aws_rr_client_on_zero_external_ref_count(void *context) {
struct aws_mqtt_request_response_client *client = context;
/* Start the asynchronous shutdown process */
aws_event_loop_schedule_task_now(client->loop, &client->external_shutdown_task);
}
static void s_mqtt_request_response_client_final_destroy(struct aws_mqtt_request_response_client *client) {
aws_mqtt_request_response_client_terminated_callback_fn *terminate_callback = client->config.terminated_callback;
void *user_data = client->config.user_data;
AWS_FATAL_ASSERT(aws_hash_table_get_entry_count(&client->operations) == 0);
aws_hash_table_clean_up(&client->operations);
aws_priority_queue_clean_up(&client->operations_by_timeout);
aws_hash_table_clean_up(&client->streaming_operation_subscription_lists);
aws_hash_table_clean_up(&client->request_response_paths);
aws_hash_table_clean_up(&client->operations_by_correlation_tokens);
aws_mem_release(client->allocator, client);
if (terminate_callback != NULL) {
(*terminate_callback)(user_data);
}
}
static void s_mqtt_request_response_client_internal_shutdown_task_fn(
struct aws_task *task,
void *arg,
enum aws_task_status task_status) {
(void)task;
(void)task_status;
struct aws_mqtt_request_response_client *client = arg;
/* All internal and external refs are gone; it is safe to clean up synchronously. */
s_mqtt_request_response_client_final_destroy(client);
}
static void s_remove_operation_from_timeout_queue(struct aws_mqtt_rr_client_operation *operation) {
struct aws_mqtt_request_response_client *client = operation->client_internal_ref;
if (aws_priority_queue_node_is_in_queue(&operation->priority_queue_node)) {
struct aws_mqtt_rr_client_operation *queued_operation = NULL;
aws_priority_queue_remove(&client->operations_by_timeout, &queued_operation, &operation->priority_queue_node);
}
}
static void s_change_operation_state(
struct aws_mqtt_rr_client_operation *operation,
enum aws_mqtt_request_response_operation_state new_state) {
enum aws_mqtt_request_response_operation_state old_state = operation->state;
if (old_state == new_state) {
return;
}
operation->state = new_state;
AWS_LOGF_DEBUG(
AWS_LS_MQTT_REQUEST_RESPONSE,
"id=%p: request-response operation %" PRIu64 " changing state from %s to %s",
(void *)operation->client_internal_ref,
operation->id,
s_aws_mqtt_request_response_operation_state_to_c_str(old_state),
s_aws_mqtt_request_response_operation_state_to_c_str(new_state));
}
static void s_complete_request_operation_with_failure(struct aws_mqtt_rr_client_operation *operation, int error_code) {
AWS_FATAL_ASSERT(operation->type == AWS_MRROT_REQUEST);
AWS_FATAL_ASSERT(error_code != AWS_ERROR_SUCCESS);
if (operation->state == AWS_MRROS_PENDING_DESTROY) {
return;
}
AWS_LOGF_DEBUG(
AWS_LS_MQTT_REQUEST_RESPONSE,
"id=%p: request-response operation %" PRIu64 " failed with error code %d(%s)",
(void *)operation->client_internal_ref,
operation->id,
error_code,
aws_error_debug_str(error_code));
aws_mqtt_request_operation_completion_fn *completion_callback =
operation->storage.request_storage.options.completion_callback;
void *user_data = operation->storage.request_storage.options.user_data;
if (completion_callback != NULL) {
(*completion_callback)(NULL, NULL, error_code, user_data);
}
s_change_operation_state(operation, AWS_MRROS_PENDING_DESTROY);
aws_mqtt_rr_client_operation_release(operation);
}
static void s_streaming_operation_emit_streaming_subscription_event(
struct aws_mqtt_rr_client_operation *operation,
enum aws_rr_streaming_subscription_event_type event_type,
int error_code) {
aws_mqtt_streaming_operation_subscription_status_fn *subscription_status_callback =
operation->storage.streaming_storage.options.subscription_status_callback;
if (subscription_status_callback != NULL) {
void *user_data = operation->storage.streaming_storage.options.user_data;
(*subscription_status_callback)(event_type, error_code, user_data);
}
}
static void s_halt_streaming_operation_with_failure(struct aws_mqtt_rr_client_operation *operation, int error_code) {
AWS_FATAL_ASSERT(operation->type == AWS_MRROT_STREAMING);
AWS_FATAL_ASSERT(error_code != AWS_ERROR_SUCCESS);
if (operation->state == AWS_MRROS_PENDING_DESTROY || operation->state == AWS_MRROS_TERMINAL) {
return;
}
AWS_LOGF_DEBUG(
AWS_LS_MQTT_REQUEST_RESPONSE,
"id=%p: streaming operation %" PRIu64 " halted with error code %d(%s)",
(void *)operation->client_internal_ref,
operation->id,
error_code,
aws_error_debug_str(error_code));
s_streaming_operation_emit_streaming_subscription_event(operation, ARRSSET_SUBSCRIPTION_HALTED, error_code);
s_change_operation_state(operation, AWS_MRROS_TERMINAL);
}
static void s_request_response_fail_operation(struct aws_mqtt_rr_client_operation *operation, int error_code) {
if (operation->type == AWS_MRROT_STREAMING) {
s_halt_streaming_operation_with_failure(operation, error_code);
} else {
s_complete_request_operation_with_failure(operation, error_code);
}
}
static int s_rr_client_clean_up_operation(void *context, struct aws_hash_element *elem) {
(void)context;
struct aws_mqtt_rr_client_operation *operation = elem->value;
s_request_response_fail_operation(operation, AWS_ERROR_MQTT_REQUEST_RESPONSE_CLIENT_SHUT_DOWN);
return AWS_COMMON_HASH_TABLE_ITER_CONTINUE;
}
static void s_mqtt_request_response_client_external_shutdown_task_fn(
struct aws_task *task,
void *arg,
enum aws_task_status task_status) {
(void)task;
AWS_FATAL_ASSERT(task_status != AWS_TASK_STATUS_CANCELED);
struct aws_mqtt_request_response_client *client = arg;
/* stop handling adapter event callbacks */
client->state = AWS_RRCS_SHUTTING_DOWN;
if (client->scheduled_service_timepoint_ns != 0) {
aws_event_loop_cancel_task(client->loop, &client->service_task);
client->scheduled_service_timepoint_ns = 0;
}
aws_rr_subscription_manager_clean_up(&client->subscription_manager);
if (client->client_adapter != NULL) {
aws_mqtt_protocol_adapter_destroy(client->client_adapter);
}
/*
* It is a client invariant that when external shutdown starts, it must be the case that there are no in-flight
* operations with un-executed submit tasks. This means it safe to assume that all tracked request operations are
* either in the process of cleaning up already (state == AWS_MRROS_PENDING_DESTROY) or can be
* completed now (state != AWS_MRROS_PENDING_DESTROY). Non-terminal streaming operations are moved into
* a terminal state and emit an appropriate failure/ended event.
*
* Actual operation destruction and client ref-count release is done by a scheduled task
* on the operation that is triggered by dec-refing it (assuming streaming operations get closed by the binding
* client).
*/
aws_hash_table_foreach(&client->operations, s_rr_client_clean_up_operation, NULL);
aws_ref_count_release(&client->internal_ref_count);
}
static void s_mqtt_request_response_client_wake_service(struct aws_mqtt_request_response_client *client) {
uint64_t now = 0;
aws_high_res_clock_get_ticks(&now);
AWS_FATAL_ASSERT(aws_event_loop_thread_is_callers_thread(client->loop));
if (client->state != AWS_RRCS_ACTIVE) {
return;
}
if (client->scheduled_service_timepoint_ns == 0 || now < client->scheduled_service_timepoint_ns) {
if (now < client->scheduled_service_timepoint_ns) {
aws_event_loop_cancel_task(client->loop, &client->service_task);
}
client->scheduled_service_timepoint_ns = now;
aws_event_loop_schedule_task_now(client->loop, &client->service_task);
AWS_LOGF_DEBUG(
AWS_LS_MQTT_REQUEST_RESPONSE, "id=%p: request-response client service task woke", (void *)client);
}
}
struct aws_rrc_incomplete_publish {
struct aws_allocator *allocator;
struct aws_mqtt_request_response_client *rr_client;
uint64_t operation_id;
};
static void s_aws_rrc_incomplete_publish_destroy(struct aws_rrc_incomplete_publish *user_data) {
if (user_data == NULL) {
return;
}
aws_mqtt_request_response_client_release_internal(user_data->rr_client);
aws_mem_release(user_data->allocator, user_data);
}
static void s_on_request_publish_completion(int error_code, void *userdata) {
struct aws_rrc_incomplete_publish *publish_user_data = userdata;
if (error_code != AWS_ERROR_SUCCESS) {
AWS_LOGF_ERROR(
AWS_LS_MQTT_REQUEST_RESPONSE,
"id=%p: request-response operation %" PRIu64 " failed publish step due to error %d(%s)",
(void *)publish_user_data->rr_client,
publish_user_data->operation_id,
error_code,
aws_error_debug_str(error_code));
struct aws_hash_element *element = NULL;
if (aws_hash_table_find(
&publish_user_data->rr_client->operations, &publish_user_data->operation_id, &element) ==
AWS_OP_SUCCESS &&
element != NULL) {
struct aws_mqtt_rr_client_operation *operation = element->value;
s_complete_request_operation_with_failure(operation, AWS_ERROR_MQTT_REQUEST_RESPONSE_PUBLISH_FAILURE);
}
}
s_aws_rrc_incomplete_publish_destroy(publish_user_data);
}
static void s_make_mqtt_request(
struct aws_mqtt_request_response_client *client,
struct aws_mqtt_rr_client_operation *operation) {
(void)client;
AWS_FATAL_ASSERT(operation->type == AWS_MRROT_REQUEST);
struct aws_mqtt_request_operation_options *request_options = &operation->storage.request_storage.options;
struct aws_rrc_incomplete_publish *publish_user_data =
aws_mem_calloc(client->allocator, 1, sizeof(struct aws_rrc_incomplete_publish));
publish_user_data->allocator = client->allocator;
publish_user_data->rr_client = aws_mqtt_request_response_client_acquire_internal(client);
publish_user_data->operation_id = operation->id;
struct aws_protocol_adapter_publish_options publish_options = {
.topic = request_options->publish_topic,
.payload = request_options->serialized_request,
.ack_timeout_seconds = client->config.operation_timeout_seconds,
.completion_callback_fn = s_on_request_publish_completion,
.user_data = publish_user_data,
};
if (aws_mqtt_protocol_adapter_publish(client->client_adapter, &publish_options)) {
int error_code = aws_last_error();
AWS_LOGF_ERROR(
AWS_LS_MQTT_REQUEST_RESPONSE,
"id=%p: request-response operation %" PRIu64 " synchronously failed publish step due to error %d(%s)",
(void *)publish_user_data->rr_client,
publish_user_data->operation_id,
error_code,
aws_error_debug_str(error_code));
s_complete_request_operation_with_failure(operation, AWS_ERROR_MQTT_REQUEST_RESPONSE_PUBLISH_FAILURE);
goto error;
}
return;
error:
s_aws_rrc_incomplete_publish_destroy(publish_user_data);
}
struct aws_rr_subscription_status_event_task {
struct aws_allocator *allocator;
struct aws_task task;
struct aws_mqtt_request_response_client *rr_client;
enum aws_rr_subscription_event_type type;
struct aws_byte_buf topic_filter;
uint64_t operation_id;
};
static void s_aws_rr_subscription_status_event_task_delete(struct aws_rr_subscription_status_event_task *task) {
if (task == NULL) {
return;
}
aws_byte_buf_clean_up(&task->topic_filter);
aws_mqtt_request_response_client_release_internal(task->rr_client);
aws_mem_release(task->allocator, task);
}
static void s_on_request_operation_subscription_status_event(
struct aws_mqtt_rr_client_operation *operation,
struct aws_byte_cursor topic_filter,
enum aws_rr_subscription_event_type event_type) {
(void)topic_filter;
switch (event_type) {
case ARRSET_REQUEST_SUBSCRIBE_FAILURE:
case ARRSET_REQUEST_SUBSCRIPTION_ENDED:
s_complete_request_operation_with_failure(operation, AWS_ERROR_MQTT_REQUEST_RESPONSE_SUBSCRIBE_FAILURE);
break;
case ARRSET_REQUEST_SUBSCRIBE_SUCCESS:
if (operation->state == AWS_MRROS_PENDING_SUBSCRIPTION) {
--operation->pending_subscriptions;
if (operation->pending_subscriptions == 0) {
s_change_operation_state(operation, AWS_MRROS_PENDING_RESPONSE);
s_make_mqtt_request(operation->client_internal_ref, operation);
}
}
break;
default:
AWS_FATAL_ASSERT(false);
}
}
static void s_on_streaming_operation_subscription_status_event(
struct aws_mqtt_rr_client_operation *operation,
struct aws_byte_cursor topic_filter,
enum aws_rr_subscription_event_type event_type) {
(void)topic_filter;
switch (event_type) {
case ARRSET_STREAMING_SUBSCRIPTION_ESTABLISHED:
if (operation->state == AWS_MRROS_PENDING_SUBSCRIPTION) {
s_change_operation_state(operation, AWS_MRROS_SUBSCRIBED);
}
s_streaming_operation_emit_streaming_subscription_event(
operation, ARRSSET_SUBSCRIPTION_ESTABLISHED, AWS_ERROR_SUCCESS);
break;
case ARRSET_STREAMING_SUBSCRIPTION_LOST:
s_streaming_operation_emit_streaming_subscription_event(
operation, ARRSSET_SUBSCRIPTION_LOST, AWS_ERROR_SUCCESS);
break;
case ARRSET_STREAMING_SUBSCRIPTION_HALTED:
s_halt_streaming_operation_with_failure(operation, AWS_ERROR_MQTT_REQUEST_RESPONSE_SUBSCRIBE_FAILURE);
break;
default:
AWS_FATAL_ASSERT(false);
}
}
static void s_handle_subscription_status_event_task(struct aws_task *task, void *arg, enum aws_task_status status) {
(void)task;
struct aws_rr_subscription_status_event_task *event_task = arg;
if (status == AWS_TASK_STATUS_CANCELED) {
goto done;
}
if (event_task->type == ARRSET_UNSUBSCRIBE_COMPLETE || event_task->type == ARRSET_SUBSCRIPTION_EMPTY) {
s_mqtt_request_response_client_wake_service(event_task->rr_client);
goto done;
}
struct aws_hash_element *element = NULL;
if (aws_hash_table_find(&event_task->rr_client->operations, &event_task->operation_id, &element) ||
element == NULL) {
goto done;
}
struct aws_mqtt_rr_client_operation *operation = element->value;
switch (event_task->type) {
case ARRSET_REQUEST_SUBSCRIBE_SUCCESS:
case ARRSET_REQUEST_SUBSCRIBE_FAILURE:
case ARRSET_REQUEST_SUBSCRIPTION_ENDED:
s_on_request_operation_subscription_status_event(
operation, aws_byte_cursor_from_buf(&event_task->topic_filter), event_task->type);
break;
case ARRSET_STREAMING_SUBSCRIPTION_ESTABLISHED:
case ARRSET_STREAMING_SUBSCRIPTION_LOST:
case ARRSET_STREAMING_SUBSCRIPTION_HALTED:
s_on_streaming_operation_subscription_status_event(
operation, aws_byte_cursor_from_buf(&event_task->topic_filter), event_task->type);
break;
default:
break;
}
done:
s_aws_rr_subscription_status_event_task_delete(event_task);
}
static struct aws_rr_subscription_status_event_task *s_aws_rr_subscription_status_event_task_new(
struct aws_allocator *allocator,
struct aws_mqtt_request_response_client *rr_client,
const struct aws_rr_subscription_status_event *event) {
struct aws_rr_subscription_status_event_task *task =
aws_mem_calloc(allocator, 1, sizeof(struct aws_rr_subscription_status_event_task));
task->allocator = allocator;
task->type = event->type;
task->operation_id = event->operation_id;
task->rr_client = aws_mqtt_request_response_client_acquire_internal(rr_client);
aws_byte_buf_init_copy_from_cursor(&task->topic_filter, allocator, event->topic_filter);
aws_task_init(&task->task, s_handle_subscription_status_event_task, task, "SubscriptionStatusEventTask");
return task;
}
static void s_aws_rr_client_subscription_status_event_callback(
const struct aws_rr_subscription_status_event *event,
void *userdata) {
(void)event;
(void)userdata;
/*
* We must be on the event loop, but it's safer overall to process this event as a top-level event loop task. The
* subscription manager assumes that we won't call APIs on it while iterating subscription records and listeners.
*
* These tasks hold an internal reference while they exist.
*/
struct aws_mqtt_request_response_client *rr_client = userdata;
AWS_FATAL_ASSERT(aws_event_loop_thread_is_callers_thread(rr_client->loop));
AWS_FATAL_ASSERT(rr_client->state != AWS_RRCS_SHUTTING_DOWN);
struct aws_rr_subscription_status_event_task *task =
s_aws_rr_subscription_status_event_task_new(rr_client->allocator, rr_client, event);
aws_event_loop_schedule_task_now(rr_client->loop, &task->task);
}
static void s_aws_rr_client_protocol_adapter_subscription_event_callback(
const struct aws_protocol_adapter_subscription_event *event,
void *user_data) {
struct aws_mqtt_request_response_client *rr_client = user_data;
AWS_FATAL_ASSERT(aws_event_loop_thread_is_callers_thread(rr_client->loop));
if (rr_client->state != AWS_RRCS_ACTIVE) {
return;
}
aws_rr_subscription_manager_on_protocol_adapter_subscription_event(&rr_client->subscription_manager, event);
}
static void s_apply_publish_to_streaming_operation_list(
struct aws_rr_operation_list_topic_filter_entry *entry,
const struct aws_protocol_adapter_incoming_publish_event *publish_event) {
AWS_FATAL_ASSERT(entry != NULL);
struct aws_linked_list_node *node = aws_linked_list_begin(&entry->operations);
while (node != aws_linked_list_end(&entry->operations)) {
struct aws_mqtt_rr_client_operation *operation =
AWS_CONTAINER_OF(node, struct aws_mqtt_rr_client_operation, node);
node = aws_linked_list_next(node);
if (operation->type != AWS_MRROT_STREAMING) {
continue;
}
if (operation->state == AWS_MRROS_PENDING_DESTROY || operation->state == AWS_MRROS_TERMINAL) {
continue;
}
aws_mqtt_streaming_operation_incoming_publish_fn *incoming_publish_callback =
operation->storage.streaming_storage.options.incoming_publish_callback;
if (!incoming_publish_callback) {
continue;
}
void *user_data = operation->storage.streaming_storage.options.user_data;
(*incoming_publish_callback)(publish_event->payload, publish_event->topic, user_data);
AWS_LOGF_DEBUG(
AWS_LS_MQTT_REQUEST_RESPONSE,
"id=%p: request-response client incoming publish on topic '" PRInSTR
"' routed to streaming operation %" PRIu64,
(void *)operation->client_internal_ref,
AWS_BYTE_CURSOR_PRI(publish_event->topic),
operation->id);
}
}
static void s_complete_operation_with_correlation_token(
struct aws_mqtt_request_response_client *rr_client,
struct aws_byte_cursor correlation_token,
const struct aws_protocol_adapter_incoming_publish_event *publish_event) {
struct aws_hash_element *hash_element = NULL;
if (aws_hash_table_find(&rr_client->operations_by_correlation_tokens, &correlation_token, &hash_element)) {
return;
}
if (hash_element == NULL) {
AWS_LOGF_DEBUG(
AWS_LS_MQTT_REQUEST_RESPONSE,
"id=%p: request-response client incoming publish on response path topic '" PRInSTR
"' and correlation token '" PRInSTR "' does not have an originating request entry",
(void *)rr_client,
AWS_BYTE_CURSOR_PRI(publish_event->topic),
AWS_BYTE_CURSOR_PRI(correlation_token));
return;
}
struct aws_mqtt_rr_client_operation *operation = hash_element->value;
AWS_FATAL_ASSERT(operation->type == AWS_MRROT_REQUEST);
if (operation->state == AWS_MRROS_PENDING_DESTROY) {
AWS_LOGF_DEBUG(
AWS_LS_MQTT_REQUEST_RESPONSE,
"id=%p: request-response operation %" PRIu64 " cannot be completed, already in pending destruction state",
(void *)operation->client_internal_ref,
operation->id);
return;
}
AWS_LOGF_DEBUG(
AWS_LS_MQTT_REQUEST_RESPONSE,
"id=%p: request-response operation %" PRIu64 " completed successfully",
(void *)operation->client_internal_ref,
operation->id);
aws_mqtt_request_operation_completion_fn *completion_callback =
operation->storage.request_storage.options.completion_callback;
void *user_data = operation->storage.request_storage.options.user_data;
if (completion_callback != NULL) {
(*completion_callback)(&publish_event->topic, &publish_event->payload, AWS_ERROR_SUCCESS, user_data);
}
s_change_operation_state(operation, AWS_MRROS_PENDING_DESTROY);
aws_mqtt_rr_client_operation_release(operation);
}
static void s_apply_publish_to_response_path_entry(
struct aws_mqtt_request_response_client *rr_client,
struct aws_rr_response_path_entry *entry,
const struct aws_protocol_adapter_incoming_publish_event *publish_event) {
struct aws_json_value *json_payload = NULL;
struct aws_byte_cursor correlation_token;
AWS_ZERO_STRUCT(correlation_token);
struct aws_byte_cursor correlation_token_json_path = aws_byte_cursor_from_buf(&entry->correlation_token_json_path);
if (correlation_token_json_path.len > 0) {
json_payload = aws_json_value_new_from_string(rr_client->allocator, publish_event->payload);
if (json_payload == NULL) {
AWS_LOGF_ERROR(
AWS_LS_MQTT_REQUEST_RESPONSE,
"id=%p: request-response client incoming publish on response path topic '" PRInSTR
"' could not be deserialized into JSON",
(void *)rr_client,
AWS_BYTE_CURSOR_PRI(publish_event->topic));
return;
}
struct aws_byte_cursor segment;
AWS_ZERO_STRUCT(segment);
struct aws_json_value *correlation_token_entry = json_payload;
while (aws_byte_cursor_next_split(&correlation_token_json_path, '.', &segment)) {
if (!aws_json_value_is_object(correlation_token_entry)) {
AWS_LOGF_ERROR(
AWS_LS_MQTT_REQUEST_RESPONSE,
"id=%p: request-response client incoming publish on response path topic '" PRInSTR
"' unable to walk correlation token path '" PRInSTR "'",
(void *)rr_client,
AWS_BYTE_CURSOR_PRI(publish_event->topic),
AWS_BYTE_CURSOR_PRI(correlation_token_json_path));
goto done;
}
correlation_token_entry = aws_json_value_get_from_object(correlation_token_entry, segment);
if (correlation_token_entry == NULL) {
AWS_LOGF_ERROR(
AWS_LS_MQTT_REQUEST_RESPONSE,
"id=%p: request-response client incoming publish on response path topic '" PRInSTR
"' could not find path segment '" PRInSTR "'",
(void *)rr_client,
AWS_BYTE_CURSOR_PRI(publish_event->topic),
AWS_BYTE_CURSOR_PRI(segment));
goto done;
}
}
if (!aws_json_value_is_string(correlation_token_entry)) {
AWS_LOGF_ERROR(
AWS_LS_MQTT_REQUEST_RESPONSE,
"id=%p: request-response client incoming publish on response path topic '" PRInSTR
"' token entry is not a string",
(void *)rr_client,
AWS_BYTE_CURSOR_PRI(publish_event->topic));
goto done;
}
if (aws_json_value_get_string(correlation_token_entry, &correlation_token)) {
AWS_LOGF_ERROR(
AWS_LS_MQTT_REQUEST_RESPONSE,
"id=%p: request-response client incoming publish on response path topic '" PRInSTR
"' failed to extract string from token entry",
(void *)rr_client,
AWS_BYTE_CURSOR_PRI(publish_event->topic));
goto done;
}
}
s_complete_operation_with_correlation_token(rr_client, correlation_token, publish_event);
done:
if (json_payload != NULL) {
aws_json_value_destroy(json_payload);
}
}
static void s_aws_rr_client_protocol_adapter_incoming_publish_callback(
const struct aws_protocol_adapter_incoming_publish_event *publish_event,
void *user_data) {
struct aws_mqtt_request_response_client *rr_client = user_data;
AWS_FATAL_ASSERT(aws_event_loop_thread_is_callers_thread(rr_client->loop));
if (rr_client->state != AWS_RRCS_ACTIVE) {
return;
}
/* Streaming operation handling */
struct aws_hash_element *subscription_filter_element = NULL;
if (aws_hash_table_find(
&rr_client->streaming_operation_subscription_lists, &publish_event->topic, &subscription_filter_element) ==
AWS_OP_SUCCESS &&
subscription_filter_element != NULL) {
AWS_LOGF_DEBUG(
AWS_LS_MQTT_REQUEST_RESPONSE,
"id=%p: request-response client incoming publish on topic '" PRInSTR "' matches streaming topic",
(void *)rr_client,
AWS_BYTE_CURSOR_PRI(publish_event->topic));
s_apply_publish_to_streaming_operation_list(subscription_filter_element->value, publish_event);
}
/* Request-Response handling */
struct aws_hash_element *response_path_element = NULL;
if (aws_hash_table_find(&rr_client->request_response_paths, &publish_event->topic, &response_path_element) ==
AWS_OP_SUCCESS &&
response_path_element != NULL) {
AWS_LOGF_DEBUG(
AWS_LS_MQTT_REQUEST_RESPONSE,
"id=%p: request-response client incoming publish on topic '" PRInSTR "' matches response path",
(void *)rr_client,
AWS_BYTE_CURSOR_PRI(publish_event->topic));
s_apply_publish_to_response_path_entry(rr_client, response_path_element->value, publish_event);
}
}
static void s_aws_rr_client_protocol_adapter_terminate_callback(void *user_data) {
struct aws_mqtt_request_response_client *rr_client = user_data;
/* release the internal ref count "held" by the protocol adapter's existence */
aws_ref_count_release(&rr_client->internal_ref_count);
}
static void s_aws_rr_client_protocol_adapter_connection_event_callback(
const struct aws_protocol_adapter_connection_event *event,
void *user_data) {
struct aws_mqtt_request_response_client *rr_client = user_data;
AWS_FATAL_ASSERT(aws_event_loop_thread_is_callers_thread(rr_client->loop));
if (rr_client->state != AWS_RRCS_ACTIVE) {
return;
}
AWS_LOGF_DEBUG(
AWS_LS_MQTT_REQUEST_RESPONSE,
"id=%p: request-response client applying connection event to subscription manager",
(void *)rr_client);
aws_rr_subscription_manager_on_protocol_adapter_connection_event(&rr_client->subscription_manager, event);
}
static int s_compare_rr_operation_timeouts(const void *a, const void *b) {
const struct aws_mqtt_rr_client_operation **operation_a_ptr = (void *)a;
const struct aws_mqtt_rr_client_operation *operation_a = *operation_a_ptr;
const struct aws_mqtt_rr_client_operation **operation_b_ptr = (void *)b;
const struct aws_mqtt_rr_client_operation *operation_b = *operation_b_ptr;
if (operation_a->timeout_timepoint_ns < operation_b->timeout_timepoint_ns) {
return -1;
} else if (operation_a->timeout_timepoint_ns > operation_b->timeout_timepoint_ns) {
return 1;
} else {
return 0;
}
}
static struct aws_mqtt_request_response_client *s_aws_mqtt_request_response_client_new(
struct aws_allocator *allocator,
const struct aws_mqtt_request_response_client_options *options,
struct aws_event_loop *loop) {
struct aws_rr_subscription_manager_options sm_options = {
.max_request_response_subscriptions = options->max_request_response_subscriptions,
.max_streaming_subscriptions = options->max_streaming_subscriptions,
.operation_timeout_seconds = options->operation_timeout_seconds,
};
/*
* We can't initialize the subscription manager until we're running on the event loop, so make sure that
* initialize can't fail by checking its options for validity now.
*/
if (!aws_rr_subscription_manager_are_options_valid(&sm_options)) {
AWS_LOGF_ERROR(
AWS_LS_MQTT_REQUEST_RESPONSE, "(static) request response client creation failed - invalid client options");
aws_raise_error(AWS_ERROR_INVALID_ARGUMENT);
return NULL;
}
struct aws_mqtt_request_response_client *rr_client =
aws_mem_calloc(allocator, 1, sizeof(struct aws_mqtt_request_response_client));
rr_client->allocator = allocator;
rr_client->config = *options;
rr_client->loop = loop;
rr_client->state = AWS_RRCS_UNINITIALIZED;
aws_hash_table_init(
&rr_client->operations,
allocator,
MQTT_RR_CLIENT_OPERATION_TABLE_DEFAULT_SIZE,
aws_hash_uint64_t_by_identity,
aws_hash_compare_uint64_t_eq,
NULL,
NULL);
aws_priority_queue_init_dynamic(
&rr_client->operations_by_timeout,
allocator,
100,
sizeof(struct aws_mqtt_rr_client_operation *),
s_compare_rr_operation_timeouts);
aws_hash_table_init(
&rr_client->streaming_operation_subscription_lists,
allocator,
MQTT_RR_CLIENT_OPERATION_TABLE_DEFAULT_SIZE,
aws_hash_byte_cursor_ptr,
aws_mqtt_byte_cursor_hash_equality,
NULL,
s_aws_rr_operation_list_topic_filter_entry_hash_element_destroy);
aws_hash_table_init(
&rr_client->request_response_paths,
allocator,
MQTT_RR_CLIENT_RESPONSE_TABLE_DEFAULT_SIZE,
aws_hash_byte_cursor_ptr,
aws_mqtt_byte_cursor_hash_equality,
NULL,
s_aws_rr_response_path_table_hash_element_destroy);
aws_hash_table_init(
&rr_client->operations_by_correlation_tokens,
allocator,
MQTT_RR_CLIENT_OPERATION_TABLE_DEFAULT_SIZE,
aws_hash_byte_cursor_ptr,
aws_mqtt_byte_cursor_hash_equality,
NULL,
NULL);
aws_linked_list_init(&rr_client->operation_queue);
aws_task_init(
&rr_client->external_shutdown_task,
s_mqtt_request_response_client_external_shutdown_task_fn,
rr_client,
"mqtt_rr_client_external_shutdown");
aws_task_init(
&rr_client->internal_shutdown_task,
s_mqtt_request_response_client_internal_shutdown_task_fn,
rr_client,
"mqtt_rr_client_internal_shutdown");
/* The initial external ref belongs to the caller */
aws_ref_count_init(&rr_client->external_ref_count, rr_client, s_aws_rr_client_on_zero_external_ref_count);
/* The initial internal ref belongs to ourselves (the external ref count shutdown task) */
aws_ref_count_init(&rr_client->internal_ref_count, rr_client, s_aws_rr_client_on_zero_internal_ref_count);
aws_atomic_store_int(&rr_client->next_id, 1);
return rr_client;
}
static void s_aws_rr_client_init_subscription_manager(
struct aws_mqtt_request_response_client *rr_client,
struct aws_allocator *allocator) {
AWS_FATAL_ASSERT(aws_event_loop_thread_is_callers_thread(rr_client->loop));
struct aws_rr_subscription_manager_options subscription_manager_options = {
.operation_timeout_seconds = rr_client->config.operation_timeout_seconds,
.max_request_response_subscriptions = rr_client->config.max_request_response_subscriptions,
.max_streaming_subscriptions = rr_client->config.max_streaming_subscriptions,
.subscription_status_callback = s_aws_rr_client_subscription_status_event_callback,
.userdata = rr_client,
};
aws_rr_subscription_manager_init(
&rr_client->subscription_manager, allocator, rr_client->client_adapter, &subscription_manager_options);
}
static void s_check_for_operation_timeouts(struct aws_mqtt_request_response_client *client) {
uint64_t now = 0;
aws_high_res_clock_get_ticks(&now);
struct aws_priority_queue *timeout_queue = &client->operations_by_timeout;
bool done = aws_priority_queue_size(timeout_queue) == 0;
while (!done) {
struct aws_mqtt_rr_client_operation **next_operation_by_timeout_ptr = NULL;
aws_priority_queue_top(timeout_queue, (void **)&next_operation_by_timeout_ptr);
AWS_FATAL_ASSERT(next_operation_by_timeout_ptr != NULL);
struct aws_mqtt_rr_client_operation *next_operation_by_timeout = *next_operation_by_timeout_ptr;
AWS_FATAL_ASSERT(next_operation_by_timeout != NULL);
// If the current top of the heap hasn't timed out than nothing has
if (next_operation_by_timeout->timeout_timepoint_ns > now) {
break;
}
/* Ack timeout for this operation has been reached */
aws_priority_queue_pop(timeout_queue, &next_operation_by_timeout);
s_request_response_fail_operation(next_operation_by_timeout, AWS_ERROR_MQTT_REQUEST_RESPONSE_TIMEOUT);
done = aws_priority_queue_size(timeout_queue) == 0;
}
}
static uint64_t s_mqtt_request_response_client_get_next_service_time(struct aws_mqtt_request_response_client *client) {
if (aws_priority_queue_size(&client->operations_by_timeout) > 0) {
struct aws_mqtt_rr_client_operation **next_operation_by_timeout_ptr = NULL;
aws_priority_queue_top(&client->operations_by_timeout, (void **)&next_operation_by_timeout_ptr);
AWS_FATAL_ASSERT(next_operation_by_timeout_ptr != NULL);
struct aws_mqtt_rr_client_operation *next_operation_by_timeout = *next_operation_by_timeout_ptr;
AWS_FATAL_ASSERT(next_operation_by_timeout != NULL);
return next_operation_by_timeout->timeout_timepoint_ns;
}
return UINT64_MAX;
}
static int s_add_streaming_operation_to_subscription_topic_filter_table(
struct aws_mqtt_request_response_client *client,
struct aws_mqtt_rr_client_operation *operation) {
struct aws_byte_cursor topic_filter_cursor = operation->storage.streaming_storage.options.topic_filter;
struct aws_hash_element *element = NULL;
if (aws_hash_table_find(&client->streaming_operation_subscription_lists, &topic_filter_cursor, &element)) {
return aws_raise_error(AWS_ERROR_MQTT_REQUEST_RESPONSE_INTERNAL_ERROR);
}
struct aws_rr_operation_list_topic_filter_entry *entry = NULL;
if (element == NULL) {
entry = s_aws_rr_operation_list_topic_filter_entry_new(client->allocator, topic_filter_cursor);
aws_hash_table_put(&client->streaming_operation_subscription_lists, &entry->topic_filter_cursor, entry, NULL);
AWS_LOGF_DEBUG(
AWS_LS_MQTT_REQUEST_RESPONSE,
"id=%p: request-response client adding topic filter '" PRInSTR "' to streaming subscriptions table",
(void *)client,
AWS_BYTE_CURSOR_PRI(topic_filter_cursor));
} else {
entry = element->value;
}
AWS_FATAL_ASSERT(entry != NULL);
if (aws_linked_list_node_is_in_list(&operation->node)) {
aws_linked_list_remove(&operation->node);
}
AWS_LOGF_DEBUG(
AWS_LS_MQTT_REQUEST_RESPONSE,
"id=%p: request-response client adding streaming operation %" PRIu64
" to streaming subscription table with topic_filter '" PRInSTR "'",
(void *)client,
operation->id,
AWS_BYTE_CURSOR_PRI(topic_filter_cursor));
aws_linked_list_push_back(&entry->operations, &operation->node);
return AWS_OP_SUCCESS;
}
static int s_add_request_operation_to_response_path_table(
struct aws_mqtt_request_response_client *client,
struct aws_mqtt_rr_client_operation *operation) {
struct aws_array_list *paths = &operation->storage.request_storage.operation_response_paths;
size_t path_count = aws_array_list_length(paths);
for (size_t i = 0; i < path_count; ++i) {
struct aws_mqtt_request_operation_response_path path;
aws_array_list_get_at(paths, &path, i);
struct aws_hash_element *element = NULL;
if (aws_hash_table_find(&client->request_response_paths, &path.topic, &element)) {
return aws_raise_error(AWS_ERROR_MQTT_REQUEST_RESPONSE_INTERNAL_ERROR);
}
if (element != NULL) {
struct aws_rr_response_path_entry *entry = element->value;
++entry->ref_count;
continue;
}
struct aws_rr_response_path_entry *entry =
s_aws_rr_response_path_entry_new(client->allocator, path.topic, path.correlation_token_json_path);
if (aws_hash_table_put(&client->request_response_paths, &entry->topic_cursor, entry, NULL)) {
return aws_raise_error(AWS_ERROR_MQTT_REQUEST_RESPONSE_INTERNAL_ERROR);
}
}
return AWS_OP_SUCCESS;
}
static int s_add_request_operation_to_correlation_token_table(
struct aws_mqtt_request_response_client *client,
struct aws_mqtt_rr_client_operation *operation) {
return aws_hash_table_put(
&client->operations_by_correlation_tokens,
&operation->storage.request_storage.options.correlation_token,
operation,
NULL);
}
static int s_add_in_progress_operation_to_tracking_tables(
struct aws_mqtt_request_response_client *client,
struct aws_mqtt_rr_client_operation *operation) {
if (operation->type == AWS_MRROT_STREAMING) {
if (s_add_streaming_operation_to_subscription_topic_filter_table(client, operation)) {
return AWS_OP_ERR;
}
} else {
if (s_add_request_operation_to_response_path_table(client, operation)) {
return AWS_OP_ERR;
}
if (s_add_request_operation_to_correlation_token_table(client, operation)) {
return AWS_OP_ERR;
}
}
operation->in_client_tables = true;
return AWS_OP_SUCCESS;
}
static void s_handle_operation_subscribe_result(
struct aws_mqtt_request_response_client *client,
struct aws_mqtt_rr_client_operation *operation,
enum aws_acquire_subscription_result_type subscribe_result) {
if (subscribe_result == AASRT_FAILURE || subscribe_result == AASRT_NO_CAPACITY) {
int error_code = (subscribe_result == AASRT_NO_CAPACITY)
? AWS_ERROR_MQTT_REQUEST_RESPONSE_NO_SUBSCRIPTION_CAPACITY
: AWS_ERROR_MQTT_REQUEST_RESPONSE_SUBSCRIBE_FAILURE;
s_request_response_fail_operation(operation, error_code);
return;
}
if (s_add_in_progress_operation_to_tracking_tables(client, operation)) {
s_request_response_fail_operation(operation, AWS_ERROR_MQTT_REQUEST_RESPONSE_INTERNAL_ERROR);
return;
}
if (subscribe_result == AASRT_SUBSCRIBING) {
s_change_operation_state(operation, AWS_MRROS_PENDING_SUBSCRIPTION);
return;
}
if (operation->type == AWS_MRROT_STREAMING) {
s_change_operation_state(operation, AWS_MRROS_SUBSCRIBED);
s_streaming_operation_emit_streaming_subscription_event(
operation, ARRSSET_SUBSCRIPTION_ESTABLISHED, AWS_ERROR_SUCCESS);
} else {
s_make_mqtt_request(client, operation);
}
}
static enum aws_rr_subscription_type s_rr_operation_type_to_subscription_type(
enum aws_mqtt_request_response_operation_type type) {
if (type == AWS_MRROT_REQUEST) {
return ARRST_REQUEST_RESPONSE;
}
return ARRST_EVENT_STREAM;
}
static bool s_can_operation_dequeue(
struct aws_mqtt_request_response_client *client,
struct aws_mqtt_rr_client_operation *operation) {
if (operation->type != AWS_MRROT_REQUEST) {
return true;
}
struct aws_hash_element *token_element = NULL;
if (aws_hash_table_find(
&client->operations_by_correlation_tokens,
&operation->storage.request_storage.options.correlation_token,
&token_element)) {
return false;
}
return token_element == NULL;
}
static struct aws_byte_cursor *s_aws_mqtt_rr_operation_get_subscription_topic_filters(
struct aws_mqtt_rr_client_operation *operation) {
if (operation->type == AWS_MRROT_STREAMING) {
return &operation->storage.streaming_storage.options.topic_filter;
} else {
return operation->storage.request_storage.options.subscription_topic_filters;
}
}
static size_t s_aws_mqtt_rr_operation_get_subscription_topic_filter_count(
struct aws_mqtt_rr_client_operation *operation) {
if (operation->type == AWS_MRROT_STREAMING) {
return 1;
} else {
return operation->storage.request_storage.options.subscription_topic_filter_count;
}
}
static void s_process_queued_operations(struct aws_mqtt_request_response_client *client) {
aws_rr_subscription_manager_purge_unused(&client->subscription_manager);
while (!aws_linked_list_empty(&client->operation_queue)) {
struct aws_linked_list_node *head = aws_linked_list_front(&client->operation_queue);
struct aws_mqtt_rr_client_operation *head_operation =
AWS_CONTAINER_OF(head, struct aws_mqtt_rr_client_operation, node);
if (!s_can_operation_dequeue(client, head_operation)) {
break;
}
struct aws_rr_acquire_subscription_options subscribe_options = {
.topic_filters = s_aws_mqtt_rr_operation_get_subscription_topic_filters(head_operation),
.topic_filter_count = s_aws_mqtt_rr_operation_get_subscription_topic_filter_count(head_operation),
.operation_id = head_operation->id,
.type = s_rr_operation_type_to_subscription_type(head_operation->type),
};
enum aws_acquire_subscription_result_type subscribe_result =
aws_rr_subscription_manager_acquire_subscription(&client->subscription_manager, &subscribe_options);
AWS_LOGF_DEBUG(
AWS_LS_MQTT_REQUEST_RESPONSE,
"id=%p: request-response client intake, queued operation %" PRIu64
" yielded acquire subscription result: %s",
(void *)client,
head_operation->id,
s_aws_acquire_subscription_result_type(subscribe_result));
if (subscribe_result == AASRT_BLOCKED) {
break;
}
aws_linked_list_pop_front(&client->operation_queue);
s_handle_operation_subscribe_result(client, head_operation, subscribe_result);
}
}
static void s_mqtt_request_response_service_task_fn(
struct aws_task *task,
void *arg,
enum aws_task_status task_status) {
(void)task;
if (task_status == AWS_TASK_STATUS_CANCELED) {
return;
}
struct aws_mqtt_request_response_client *client = arg;
client->scheduled_service_timepoint_ns = 0;
if (client->state == AWS_RRCS_ACTIVE) {
// timeouts
s_check_for_operation_timeouts(client);
// operation queue
s_process_queued_operations(client);
// schedule next service
client->scheduled_service_timepoint_ns = s_mqtt_request_response_client_get_next_service_time(client);
aws_event_loop_schedule_task_future(
client->loop, &client->service_task, client->scheduled_service_timepoint_ns);
AWS_LOGF_DEBUG(
AWS_LS_MQTT_REQUEST_RESPONSE,
"id=%p: request-response client service, next timepoint: %" PRIu64,
(void *)client,
client->scheduled_service_timepoint_ns);
}
}
static void s_mqtt_request_response_client_initialize_task_fn(
struct aws_task *task,
void *arg,
enum aws_task_status task_status) {
(void)task;
AWS_FATAL_ASSERT(task_status != AWS_TASK_STATUS_CANCELED);
struct aws_mqtt_request_response_client *client = arg;
if (client->state == AWS_RRCS_UNINITIALIZED) {
s_aws_rr_client_init_subscription_manager(client, client->allocator);
client->state = AWS_RRCS_ACTIVE;
aws_task_init(&client->service_task, s_mqtt_request_response_service_task_fn, client, "mqtt_rr_client_service");
aws_event_loop_schedule_task_future(client->loop, &client->service_task, UINT64_MAX);
client->scheduled_service_timepoint_ns = UINT64_MAX;
}
if (client->config.initialized_callback != NULL) {
(*client->config.initialized_callback)(client->config.user_data);
}
/* give up the internal ref we held while the task was pending */
aws_ref_count_release(&client->internal_ref_count);
}
static void s_setup_cross_thread_initialization(struct aws_mqtt_request_response_client *rr_client) {
/* now that it exists, 1 internal ref belongs to protocol adapter termination */
aws_ref_count_acquire(&rr_client->internal_ref_count);
/* 1 internal ref belongs to the initialize task until it runs */
aws_ref_count_acquire(&rr_client->internal_ref_count);
aws_task_init(
&rr_client->initialize_task,
s_mqtt_request_response_client_initialize_task_fn,
rr_client,
"mqtt_rr_client_initialize");
aws_event_loop_schedule_task_now(rr_client->loop, &rr_client->initialize_task);
}
struct aws_mqtt_request_response_client *aws_mqtt_request_response_client_new_from_mqtt311_client(
struct aws_allocator *allocator,
struct aws_mqtt_client_connection *client,
const struct aws_mqtt_request_response_client_options *options) {
struct aws_mqtt_request_response_client *rr_client =
s_aws_mqtt_request_response_client_new(allocator, options, aws_mqtt_client_connection_get_event_loop(client));
if (rr_client == NULL) {
return NULL;
}
struct aws_mqtt_protocol_adapter_options adapter_options = {
.subscription_event_callback = s_aws_rr_client_protocol_adapter_subscription_event_callback,
.incoming_publish_callback = s_aws_rr_client_protocol_adapter_incoming_publish_callback,
.terminate_callback = s_aws_rr_client_protocol_adapter_terminate_callback,
.connection_event_callback = s_aws_rr_client_protocol_adapter_connection_event_callback,
.user_data = rr_client,
};
rr_client->client_adapter = aws_mqtt_protocol_adapter_new_from_311(rr_client->allocator, &adapter_options, client);
if (rr_client->client_adapter == NULL) {
goto error;
}
s_setup_cross_thread_initialization(rr_client);
return rr_client;
error:
/* even on construction failures we still need to walk through the async shutdown process */
aws_mqtt_request_response_client_release(rr_client);
return NULL;
}
struct aws_mqtt_request_response_client *aws_mqtt_request_response_client_new_from_mqtt5_client(
struct aws_allocator *allocator,
struct aws_mqtt5_client *client,
const struct aws_mqtt_request_response_client_options *options) {
struct aws_mqtt_request_response_client *rr_client =
s_aws_mqtt_request_response_client_new(allocator, options, client->loop);
if (rr_client == NULL) {
return NULL;
}
struct aws_mqtt_protocol_adapter_options adapter_options = {
.subscription_event_callback = s_aws_rr_client_protocol_adapter_subscription_event_callback,
.incoming_publish_callback = s_aws_rr_client_protocol_adapter_incoming_publish_callback,
.terminate_callback = s_aws_rr_client_protocol_adapter_terminate_callback,
.connection_event_callback = s_aws_rr_client_protocol_adapter_connection_event_callback,
.user_data = rr_client,
};
rr_client->client_adapter = aws_mqtt_protocol_adapter_new_from_5(rr_client->allocator, &adapter_options, client);
if (rr_client->client_adapter == NULL) {
goto error;
}
s_setup_cross_thread_initialization(rr_client);
return rr_client;
error:
/* even on construction failures we still need to walk through the async shutdown process */
aws_mqtt_request_response_client_release(rr_client);
return NULL;
}
struct aws_mqtt_request_response_client *aws_mqtt_request_response_client_acquire(
struct aws_mqtt_request_response_client *client) {
if (client != NULL) {
aws_ref_count_acquire(&client->external_ref_count);
}
return client;
}
struct aws_mqtt_request_response_client *aws_mqtt_request_response_client_release(
struct aws_mqtt_request_response_client *client) {
if (client != NULL) {
aws_ref_count_release(&client->external_ref_count);
}
return NULL;
}
/////////////////////////////////////////////////
static bool s_are_request_operation_options_valid(
const struct aws_mqtt_request_response_client *client,
const struct aws_mqtt_request_operation_options *request_options) {
if (request_options == NULL) {
AWS_LOGF_ERROR(AWS_LS_MQTT_REQUEST_RESPONSE, "(%p) rr client - NULL request options", (void *)client);
return false;
}
if (request_options->response_path_count == 0) {
AWS_LOGF_ERROR(
AWS_LS_MQTT_REQUEST_RESPONSE,
"(%p) rr client request options - no response paths supplied",
(void *)client);
return false;
}
for (size_t i = 0; i < request_options->response_path_count; ++i) {
const struct aws_mqtt_request_operation_response_path *path = &request_options->response_paths[i];
if (!aws_mqtt_is_valid_topic(&path->topic)) {
AWS_LOGF_ERROR(
AWS_LS_MQTT_REQUEST_RESPONSE,
"(%p) rr client request options - " PRInSTR " is not a valid topic",
(void *)client,
AWS_BYTE_CURSOR_PRI(path->topic));
return false;
}
}
if (!aws_mqtt_is_valid_topic(&request_options->publish_topic)) {
AWS_LOGF_ERROR(
AWS_LS_MQTT_REQUEST_RESPONSE,
"(%p) rr client request options - " PRInSTR " is not a valid topic",
(void *)client,
AWS_BYTE_CURSOR_PRI(request_options->publish_topic));
return false;
}
if (request_options->subscription_topic_filter_count == 0) {
AWS_LOGF_ERROR(
AWS_LS_MQTT_REQUEST_RESPONSE,
"(%p) rr client request options - no subscription topic filters supplied",
(void *)client);
return false;
}
for (size_t i = 0; i < request_options->subscription_topic_filter_count; ++i) {
const struct aws_byte_cursor subscription_topic_filter = request_options->subscription_topic_filters[i];
if (!aws_mqtt_is_valid_topic_filter(&subscription_topic_filter)) {
AWS_LOGF_ERROR(
AWS_LS_MQTT_REQUEST_RESPONSE,
"(%p) rr client request options - " PRInSTR " is not a valid subscription topic filter",
(void *)client,
AWS_BYTE_CURSOR_PRI(subscription_topic_filter));
return false;
}
}
if (request_options->serialized_request.len == 0) {
AWS_LOGF_ERROR(
AWS_LS_MQTT_REQUEST_RESPONSE, "(%p) rr client request options - empty request payload", (void *)client);
return false;
}
return true;
}
static bool s_are_streaming_operation_options_valid(
struct aws_mqtt_request_response_client *client,
const struct aws_mqtt_streaming_operation_options *streaming_options) {
if (streaming_options == NULL) {
AWS_LOGF_ERROR(AWS_LS_MQTT_REQUEST_RESPONSE, "(%p) rr client - NULL streaming options", (void *)client);
return false;
}
if (!aws_mqtt_is_valid_topic_filter(&streaming_options->topic_filter)) {
AWS_LOGF_ERROR(
AWS_LS_MQTT_REQUEST_RESPONSE,
"(%p) rr client streaming options - " PRInSTR " is not a valid topic filter",
(void *)client,
AWS_BYTE_CURSOR_PRI(streaming_options->topic_filter));
return false;
}
return true;
}
static uint64_t s_aws_mqtt_request_response_client_allocate_operation_id(
struct aws_mqtt_request_response_client *client) {
return aws_atomic_fetch_add(&client->next_id, 1);
}
static void s_mqtt_rr_client_submit_operation(struct aws_task *task, void *arg, enum aws_task_status status) {
(void)task;
struct aws_mqtt_rr_client_operation *operation = arg;
struct aws_mqtt_request_response_client *client = operation->client_internal_ref;
if (status == AWS_TASK_STATUS_CANCELED) {
goto done;
}
AWS_LOGF_DEBUG(
AWS_LS_MQTT_REQUEST_RESPONSE,
"id=%p: request-response client, queuing operation %" PRIu64,
(void *)client,
operation->id);
// add appropriate client table entries
aws_hash_table_put(&client->operations, &operation->id, operation, NULL);
// add to timeout priority queue
if (operation->type == AWS_MRROT_REQUEST) {
aws_priority_queue_push_ref(
&client->operations_by_timeout, (void *)&operation, &operation->priority_queue_node);
}
// enqueue
aws_linked_list_push_back(&operation->client_internal_ref->operation_queue, &operation->node);
s_change_operation_state(operation, AWS_MRROS_QUEUED);
s_mqtt_request_response_client_wake_service(operation->client_internal_ref);
done:
/*
* We hold a second reference to the operation during submission. This ensures that even if a streaming operation
* is immediately dec-refed by the creator (before submission completes), the operation will not get destroyed.
*
* It is now safe and correct to release that reference.
*
* After this, streaming operation lifetime is completely user-driven, while request operation lifetime is
* completely client-internal.
*/
aws_mqtt_rr_client_operation_release(operation);
}
static void s_aws_mqtt_streaming_operation_storage_clean_up(struct aws_mqtt_streaming_operation_storage *storage) {
aws_byte_buf_clean_up(&storage->operation_data);
}
static void s_aws_mqtt_request_operation_storage_clean_up(struct aws_mqtt_request_operation_storage *storage) {
aws_array_list_clean_up(&storage->operation_response_paths);
aws_array_list_clean_up(&storage->subscription_topic_filters);
aws_byte_buf_clean_up(&storage->operation_data);
}
static void s_remove_operation_from_client_tables(struct aws_mqtt_rr_client_operation *operation) {
if (operation->type != AWS_MRROT_REQUEST) {
return;
}
if (!operation->in_client_tables) {
return;
}
struct aws_mqtt_request_response_client *client = operation->client_internal_ref;
aws_hash_table_remove(
&client->operations_by_correlation_tokens,
&operation->storage.request_storage.options.correlation_token,
NULL,
NULL);
struct aws_array_list *paths = &operation->storage.request_storage.operation_response_paths;
size_t path_count = aws_array_list_length(paths);
for (size_t i = 0; i < path_count; ++i) {
struct aws_mqtt_request_operation_response_path path;
aws_array_list_get_at(paths, &path, i);
struct aws_hash_element *element = NULL;
if (aws_hash_table_find(&client->request_response_paths, &path.topic, &element) || element == NULL) {
AWS_LOGF_ERROR(
AWS_LS_MQTT_REQUEST_RESPONSE,
"id=%p: internal state error removing reference to response path for topic " PRInSTR,
(void *)client,
AWS_BYTE_CURSOR_PRI(path.topic));
continue;
}
struct aws_rr_response_path_entry *entry = element->value;
--entry->ref_count;
if (entry->ref_count == 0) {
AWS_LOGF_DEBUG(
AWS_LS_MQTT_REQUEST_RESPONSE,
"id=%p: removing last reference to response path for topic " PRInSTR,
(void *)client,
AWS_BYTE_CURSOR_PRI(path.topic));
aws_hash_table_remove(&client->request_response_paths, &path.topic, NULL, NULL);
} else {
AWS_LOGF_DEBUG(
AWS_LS_MQTT_REQUEST_RESPONSE,
"id=%p: removing reference to response path for topic " PRInSTR ", %zu references remain",
(void *)client,
AWS_BYTE_CURSOR_PRI(path.topic),
entry->ref_count);
}
}
}
static void s_mqtt_rr_client_destroy_operation(struct aws_task *task, void *arg, enum aws_task_status status) {
(void)task;
(void)status;
struct aws_mqtt_rr_client_operation *operation = arg;
struct aws_mqtt_request_response_client *client = operation->client_internal_ref;
aws_hash_table_remove(&client->operations, &operation->id, NULL, NULL);
s_remove_operation_from_timeout_queue(operation);
if (aws_linked_list_node_is_in_list(&operation->node)) {
aws_linked_list_remove(&operation->node);
}
if (client->state != AWS_RRCS_SHUTTING_DOWN) {
struct aws_rr_release_subscription_options release_options = {
.topic_filters = s_aws_mqtt_rr_operation_get_subscription_topic_filters(operation),
.topic_filter_count = s_aws_mqtt_rr_operation_get_subscription_topic_filter_count(operation),
.operation_id = operation->id,
};
aws_rr_subscription_manager_release_subscription(&client->subscription_manager, &release_options);
}
s_remove_operation_from_client_tables(operation);
aws_mqtt_request_response_client_release_internal(operation->client_internal_ref);
if (operation->type == AWS_MRROT_STREAMING) {
s_aws_mqtt_streaming_operation_storage_clean_up(&operation->storage.streaming_storage);
} else {
s_aws_mqtt_request_operation_storage_clean_up(&operation->storage.request_storage);
}
aws_mqtt_streaming_operation_terminated_fn *terminated_callback = NULL;
void *terminated_user_data = NULL;
if (operation->type == AWS_MRROT_STREAMING) {
terminated_callback = operation->storage.streaming_storage.options.terminated_callback;
terminated_user_data = operation->storage.streaming_storage.options.user_data;
}
aws_mem_release(operation->allocator, operation);
if (terminated_callback != NULL) {
(*terminated_callback)(terminated_user_data);
}
}
static void s_on_mqtt_rr_client_operation_zero_ref_count(void *context) {
struct aws_mqtt_rr_client_operation *operation = context;
aws_event_loop_schedule_task_now(operation->client_internal_ref->loop, &operation->destroy_task);
}
static void s_aws_mqtt_rr_client_operation_init_shared(
struct aws_mqtt_rr_client_operation *operation,
struct aws_mqtt_request_response_client *client) {
operation->allocator = client->allocator;
aws_ref_count_init(&operation->ref_count, operation, s_on_mqtt_rr_client_operation_zero_ref_count);
operation->client_internal_ref = aws_mqtt_request_response_client_acquire_internal(client);
operation->id = s_aws_mqtt_request_response_client_allocate_operation_id(client);
s_change_operation_state(operation, AWS_MRROS_NONE);
aws_task_init(
&operation->submit_task,
s_mqtt_rr_client_submit_operation,
operation,
"MQTTRequestResponseClientOperationSubmit");
aws_task_init(
&operation->destroy_task,
s_mqtt_rr_client_destroy_operation,
operation,
"MQTTRequestResponseClientOperationDestroy");
}
void s_aws_mqtt_request_operation_storage_init_from_options(
struct aws_mqtt_request_operation_storage *storage,
struct aws_allocator *allocator,
const struct aws_mqtt_request_operation_options *request_options) {
size_t bytes_needed = 0;
bytes_needed += request_options->publish_topic.len;
bytes_needed += request_options->serialized_request.len;
bytes_needed += request_options->correlation_token.len;
for (size_t i = 0; i < request_options->subscription_topic_filter_count; ++i) {
const struct aws_byte_cursor *subscription_topic_filter = &request_options->subscription_topic_filters[i];
bytes_needed += subscription_topic_filter->len;
}
for (size_t i = 0; i < request_options->response_path_count; ++i) {
const struct aws_mqtt_request_operation_response_path *response_path = &request_options->response_paths[i];
bytes_needed += response_path->topic.len;
bytes_needed += response_path->correlation_token_json_path.len;
}
storage->options = *request_options;
aws_byte_buf_init(&storage->operation_data, allocator, bytes_needed);
aws_array_list_init_dynamic(
&storage->operation_response_paths,
allocator,
request_options->response_path_count,
sizeof(struct aws_mqtt_request_operation_response_path));
aws_array_list_init_dynamic(
&storage->subscription_topic_filters,
allocator,
request_options->subscription_topic_filter_count,
sizeof(struct aws_byte_cursor));
AWS_FATAL_ASSERT(
aws_byte_buf_append_and_update(&storage->operation_data, &storage->options.publish_topic) == AWS_OP_SUCCESS);
AWS_FATAL_ASSERT(
aws_byte_buf_append_and_update(&storage->operation_data, &storage->options.serialized_request) ==
AWS_OP_SUCCESS);
AWS_FATAL_ASSERT(
aws_byte_buf_append_and_update(&storage->operation_data, &storage->options.correlation_token) ==
AWS_OP_SUCCESS);
for (size_t i = 0; i < request_options->subscription_topic_filter_count; ++i) {
struct aws_byte_cursor subscription_topic_filter = request_options->subscription_topic_filters[i];
AWS_FATAL_ASSERT(
aws_byte_buf_append_and_update(&storage->operation_data, &subscription_topic_filter) == AWS_OP_SUCCESS);
aws_array_list_push_back(&storage->subscription_topic_filters, &subscription_topic_filter);
}
storage->options.subscription_topic_filters = storage->subscription_topic_filters.data;
for (size_t i = 0; i < request_options->response_path_count; ++i) {
struct aws_mqtt_request_operation_response_path response_path = request_options->response_paths[i];
AWS_FATAL_ASSERT(
aws_byte_buf_append_and_update(&storage->operation_data, &response_path.topic) == AWS_OP_SUCCESS);
AWS_FATAL_ASSERT(
aws_byte_buf_append_and_update(&storage->operation_data, &response_path.correlation_token_json_path) ==
AWS_OP_SUCCESS);
aws_array_list_push_back(&storage->operation_response_paths, &response_path);
}
storage->options.response_paths = storage->operation_response_paths.data;
}
static void s_log_request_response_operation(
struct aws_mqtt_rr_client_operation *operation,
struct aws_mqtt_request_response_client *client) {
struct aws_logger *log_handle = aws_logger_get_conditional(AWS_LS_MQTT_REQUEST_RESPONSE, AWS_LL_DEBUG);
if (log_handle == NULL) {
return;
}
struct aws_mqtt_request_operation_options *options = &operation->storage.request_storage.options;
for (size_t i = 0; i < options->subscription_topic_filter_count; ++i) {
struct aws_byte_cursor subscription_topic_filter = options->subscription_topic_filters[i];
AWS_LOGUF(
log_handle,
AWS_LL_DEBUG,
AWS_LS_MQTT_REQUEST_RESPONSE,
"id=%p: request-response client operation %" PRIu64 " - subscription topic filter %zu topic '" PRInSTR "'",
(void *)client,
operation->id,
i,
AWS_BYTE_CURSOR_PRI(subscription_topic_filter));
}
AWS_LOGUF(
log_handle,
AWS_LL_DEBUG,
AWS_LS_MQTT_REQUEST_RESPONSE,
"id=%p: request-response client operation %" PRIu64 " - correlation token: '" PRInSTR "'",
(void *)client,
operation->id,
AWS_BYTE_CURSOR_PRI(options->correlation_token));
AWS_LOGUF(
log_handle,
AWS_LL_DEBUG,
AWS_LS_MQTT_REQUEST_RESPONSE,
"id=%p: request-response client operation %" PRIu64 " - publish topic: '" PRInSTR "'",
(void *)client,
operation->id,
AWS_BYTE_CURSOR_PRI(options->publish_topic));
AWS_LOGUF(
log_handle,
AWS_LL_DEBUG,
AWS_LS_MQTT_REQUEST_RESPONSE,
"id=%p: request-response client operation %" PRIu64 " - %zu response paths:",
(void *)client,
operation->id,
options->response_path_count);
for (size_t i = 0; i < options->response_path_count; ++i) {
struct aws_mqtt_request_operation_response_path *response_path = &options->response_paths[i];
AWS_LOGUF(
log_handle,
AWS_LL_DEBUG,
AWS_LS_MQTT_REQUEST_RESPONSE,
"id=%p: request-response client operation %" PRIu64 " - response path %zu topic '" PRInSTR "'",
(void *)client,
operation->id,
i,
AWS_BYTE_CURSOR_PRI(response_path->topic));
AWS_LOGUF(
log_handle,
AWS_LL_DEBUG,
AWS_LS_MQTT_REQUEST_RESPONSE,
"id=%p: request-response client operation %" PRIu64 " - response path %zu correlation token path '" PRInSTR
"'",
(void *)client,
operation->id,
i,
AWS_BYTE_CURSOR_PRI(response_path->correlation_token_json_path));
}
}
int aws_mqtt_request_response_client_submit_request(
struct aws_mqtt_request_response_client *client,
const struct aws_mqtt_request_operation_options *request_options) {
if (client == NULL) {
return aws_raise_error(AWS_ERROR_INVALID_ARGUMENT);
}
if (!s_are_request_operation_options_valid(client, request_options)) {
/* all failure cases have logged the problem already */
return aws_raise_error(AWS_ERROR_INVALID_ARGUMENT);
}
uint64_t now = 0;
if (aws_high_res_clock_get_ticks(&now)) {
return aws_raise_error(AWS_ERROR_CLOCK_FAILURE);
}
struct aws_allocator *allocator = client->allocator;
struct aws_mqtt_rr_client_operation *operation =
aws_mem_calloc(allocator, 1, sizeof(struct aws_mqtt_rr_client_operation));
operation->allocator = allocator;
operation->type = AWS_MRROT_REQUEST;
operation->timeout_timepoint_ns =
now +
aws_timestamp_convert(client->config.operation_timeout_seconds, AWS_TIMESTAMP_SECS, AWS_TIMESTAMP_NANOS, NULL);
operation->pending_subscriptions = request_options->subscription_topic_filter_count;
s_aws_mqtt_request_operation_storage_init_from_options(
&operation->storage.request_storage, allocator, request_options);
s_aws_mqtt_rr_client_operation_init_shared(operation, client);
AWS_LOGF_INFO(
AWS_LS_MQTT_REQUEST_RESPONSE,
"id=%p: request-response client - submitting request-response operation with id %" PRIu64,
(void *)client,
operation->id);
s_log_request_response_operation(operation, client);
/*
* We hold a second reference to the operation during submission. This ensures that even if a streaming operation
* is immediately dec-refed by the creator (before submission runs), the operation will not get destroyed.
*/
aws_mqtt_rr_client_operation_acquire(operation);
aws_event_loop_schedule_task_now(client->loop, &operation->submit_task);
return AWS_OP_SUCCESS;
}
void s_aws_mqtt_streaming_operation_storage_init_from_options(
struct aws_mqtt_streaming_operation_storage *storage,
struct aws_allocator *allocator,
const struct aws_mqtt_streaming_operation_options *streaming_options) {
size_t bytes_needed = streaming_options->topic_filter.len;
storage->options = *streaming_options;
aws_byte_buf_init(&storage->operation_data, allocator, bytes_needed);
AWS_FATAL_ASSERT(
aws_byte_buf_append_and_update(&storage->operation_data, &storage->options.topic_filter) == AWS_OP_SUCCESS);
aws_atomic_init_int(&storage->activated, 0);
}
static void s_log_streaming_operation(
struct aws_mqtt_rr_client_operation *operation,
struct aws_mqtt_request_response_client *client) {
struct aws_logger *log_handle = aws_logger_get_conditional(AWS_LS_MQTT_REQUEST_RESPONSE, AWS_LL_DEBUG);
if (log_handle == NULL) {
return;
}
struct aws_mqtt_streaming_operation_options *options = &operation->storage.streaming_storage.options;
AWS_LOGUF(
log_handle,
AWS_LL_DEBUG,
AWS_LS_MQTT_REQUEST_RESPONSE,
"id=%p: request-response client streaming operation %" PRIu64 ": topic filter: '" PRInSTR "'",
(void *)client,
operation->id,
AWS_BYTE_CURSOR_PRI(options->topic_filter));
}
struct aws_mqtt_rr_client_operation *aws_mqtt_request_response_client_create_streaming_operation(
struct aws_mqtt_request_response_client *client,
const struct aws_mqtt_streaming_operation_options *streaming_options) {
if (client == NULL) {
aws_raise_error(AWS_ERROR_INVALID_ARGUMENT);
return NULL;
}
if (!s_are_streaming_operation_options_valid(client, streaming_options)) {
/* all failure cases have logged the problem already */
aws_raise_error(AWS_ERROR_INVALID_ARGUMENT);
return NULL;
}
struct aws_allocator *allocator = client->allocator;
struct aws_mqtt_rr_client_operation *operation =
aws_mem_calloc(allocator, 1, sizeof(struct aws_mqtt_rr_client_operation));
operation->allocator = allocator;
operation->type = AWS_MRROT_STREAMING;
operation->timeout_timepoint_ns = UINT64_MAX;
operation->pending_subscriptions = 1;
s_aws_mqtt_streaming_operation_storage_init_from_options(
&operation->storage.streaming_storage, allocator, streaming_options);
s_aws_mqtt_rr_client_operation_init_shared(operation, client);
AWS_LOGF_INFO(
AWS_LS_MQTT_REQUEST_RESPONSE,
"id=%p: request-response client - submitting streaming operation with id %" PRIu64,
(void *)client,
operation->id);
s_log_streaming_operation(operation, client);
return operation;
}
int aws_mqtt_rr_client_operation_activate(struct aws_mqtt_rr_client_operation *operation) {
struct aws_atomic_var *activated = &operation->storage.streaming_storage.activated;
size_t unactivated = 0;
if (!aws_atomic_compare_exchange_int(activated, &unactivated, 1)) {
return aws_raise_error(AWS_ERROR_MQTT_REUQEST_RESPONSE_STREAM_ALREADY_ACTIVATED);
}
struct aws_mqtt_request_response_client *rr_client = operation->client_internal_ref;
AWS_LOGF_DEBUG(
AWS_LS_MQTT_REQUEST_RESPONSE,
"id=%p: request-response client - activating streaming operation with id %" PRIu64,
(void *)rr_client,
operation->id);
/*
* We hold a second reference to the operation during submission. This ensures that even if a streaming operation
* is immediately dec-refed by the creator (before submission runs), the operation will not get destroyed.
*/
aws_mqtt_rr_client_operation_acquire(operation);
aws_event_loop_schedule_task_now(rr_client->loop, &operation->submit_task);
return AWS_OP_SUCCESS;
}
struct aws_mqtt_rr_client_operation *aws_mqtt_rr_client_operation_acquire(
struct aws_mqtt_rr_client_operation *operation) {
if (operation != NULL) {
aws_ref_count_acquire(&operation->ref_count);
}
return operation;
}
struct aws_mqtt_rr_client_operation *aws_mqtt_rr_client_operation_release(
struct aws_mqtt_rr_client_operation *operation) {
if (operation != NULL) {
aws_ref_count_release(&operation->ref_count);
}
return NULL;
}
struct aws_event_loop *aws_mqtt_request_response_client_get_event_loop(
struct aws_mqtt_request_response_client *client) {
return aws_mqtt_protocol_adapter_get_event_loop(client->client_adapter);
}
|