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
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
|
/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#include <aws/mqtt/client.h>
#include <aws/mqtt/private/client_impl.h>
#include <aws/mqtt/private/mqtt_client_test_helper.h>
#include <aws/mqtt/private/packets.h>
#include <aws/mqtt/private/shared_constants.h>
#include <aws/mqtt/private/topic_tree.h>
#include <aws/http/proxy.h>
#include <aws/io/channel_bootstrap.h>
#include <aws/io/event_loop.h>
#include <aws/io/socket.h>
#include <aws/io/tls_channel_handler.h>
#include <aws/io/uri.h>
#include <aws/common/clock.h>
#include <aws/common/task_scheduler.h>
#include <inttypes.h>
#ifdef AWS_MQTT_WITH_WEBSOCKETS
# include <aws/http/request_response.h>
# include <aws/http/websocket.h>
#endif
#ifdef _MSC_VER
# pragma warning(disable : 4204)
#endif
/* 3 seconds */
static const uint64_t s_default_ping_timeout_ns = 3000000000;
/* 20 minutes - This is the default (and max) for AWS IoT as of 2020.02.18 */
static const uint16_t s_default_keep_alive_sec = 1200;
static int s_mqtt_client_connect(
struct aws_mqtt_client_connection *connection,
aws_mqtt_client_on_connection_complete_fn *on_connection_complete,
void *userdata);
/*******************************************************************************
* Helper functions
******************************************************************************/
void mqtt_connection_lock_synced_data(struct aws_mqtt_client_connection *connection) {
int err = aws_mutex_lock(&connection->synced_data.lock);
AWS_ASSERT(!err);
(void)err;
}
void mqtt_connection_unlock_synced_data(struct aws_mqtt_client_connection *connection) {
ASSERT_SYNCED_DATA_LOCK_HELD(connection);
int err = aws_mutex_unlock(&connection->synced_data.lock);
AWS_ASSERT(!err);
(void)err;
}
static void s_aws_mqtt_schedule_reconnect_task(struct aws_mqtt_client_connection *connection) {
uint64_t next_attempt_ns = 0;
aws_high_res_clock_get_ticks(&next_attempt_ns);
next_attempt_ns += aws_timestamp_convert(
connection->reconnect_timeouts.current_sec, AWS_TIMESTAMP_SECS, AWS_TIMESTAMP_NANOS, NULL);
aws_event_loop_schedule_task_future(connection->loop, &connection->reconnect_task->task, next_attempt_ns);
AWS_LOGF_TRACE(
AWS_LS_MQTT_CLIENT,
"id=%p: Scheduling reconnect, for %" PRIu64 " on event-loop %p",
(void *)connection,
next_attempt_ns,
(void *)connection->loop);
}
static void s_aws_mqtt_client_destroy(struct aws_mqtt_client *client) {
AWS_LOGF_DEBUG(AWS_LS_MQTT_CLIENT, "client=%p: Cleaning up MQTT client", (void *)client);
aws_client_bootstrap_release(client->bootstrap);
aws_mem_release(client->allocator, client);
}
void mqtt_connection_set_state(
struct aws_mqtt_client_connection *connection,
enum aws_mqtt_client_connection_state state) {
ASSERT_SYNCED_DATA_LOCK_HELD(connection);
if (connection->synced_data.state == state) {
AWS_LOGF_DEBUG(AWS_LS_MQTT_CLIENT, "id=%p: MQTT connection already in state %d", (void *)connection, state);
return;
}
connection->synced_data.state = state;
}
struct request_timeout_wrapper;
/* used for timeout task */
struct request_timeout_task_arg {
uint16_t packet_id;
struct aws_mqtt_client_connection *connection;
struct request_timeout_wrapper *task_arg_wrapper;
};
/*
* We want the timeout task to be able to destroy the forward reference from the operation's task arg structure
* to the timeout task. But the operation task arg structures don't have any data structure in common. So to allow
* the timeout to refer back to a zero-able forward pointer, we wrap a pointer to the timeout task and embed it
* in every operation's task arg that needs to create a timeout.
*/
struct request_timeout_wrapper {
struct request_timeout_task_arg *timeout_task_arg;
};
static void s_request_timeout(struct aws_channel_task *channel_task, void *arg, enum aws_task_status status) {
(void)channel_task;
struct request_timeout_task_arg *timeout_task_arg = arg;
struct aws_mqtt_client_connection *connection = timeout_task_arg->connection;
if (status == AWS_TASK_STATUS_RUN_READY) {
if (timeout_task_arg->task_arg_wrapper != NULL) {
mqtt_request_complete(connection, AWS_ERROR_MQTT_TIMEOUT, timeout_task_arg->packet_id);
}
}
/*
* Whether cancelled or run, if we have a back pointer to the operation's task arg, we must zero it out
* so that when it completes it does not try to cancel us, because we will already be freed.
*
* If we don't have a back pointer to the operation's task arg, that means it already ran and completed.
*/
if (timeout_task_arg->task_arg_wrapper != NULL) {
timeout_task_arg->task_arg_wrapper->timeout_task_arg = NULL;
timeout_task_arg->task_arg_wrapper = NULL;
}
aws_mem_release(connection->allocator, timeout_task_arg);
}
static struct request_timeout_task_arg *s_schedule_timeout_task(
struct aws_mqtt_client_connection *connection,
uint16_t packet_id) {
/* schedule a timeout task to run, in case server consider the publish is not received */
struct aws_channel_task *request_timeout_task = NULL;
struct request_timeout_task_arg *timeout_task_arg = NULL;
if (!aws_mem_acquire_many(
connection->allocator,
2,
&timeout_task_arg,
sizeof(struct request_timeout_task_arg),
&request_timeout_task,
sizeof(struct aws_channel_task))) {
return NULL;
}
aws_channel_task_init(request_timeout_task, s_request_timeout, timeout_task_arg, "mqtt_request_timeout");
AWS_ZERO_STRUCT(*timeout_task_arg);
timeout_task_arg->connection = connection;
timeout_task_arg->packet_id = packet_id;
uint64_t timestamp = 0;
if (aws_channel_current_clock_time(connection->slot->channel, ×tamp)) {
aws_mem_release(connection->allocator, timeout_task_arg);
return NULL;
}
timestamp = aws_add_u64_saturating(timestamp, connection->operation_timeout_ns);
aws_channel_schedule_task_future(connection->slot->channel, request_timeout_task, timestamp);
return timeout_task_arg;
}
static void s_init_statistics(struct aws_mqtt_connection_operation_statistics_impl *stats) {
aws_atomic_store_int(&stats->incomplete_operation_count_atomic, 0);
aws_atomic_store_int(&stats->incomplete_operation_size_atomic, 0);
aws_atomic_store_int(&stats->unacked_operation_count_atomic, 0);
aws_atomic_store_int(&stats->unacked_operation_size_atomic, 0);
}
/*******************************************************************************
* Client Init
******************************************************************************/
struct aws_mqtt_client *aws_mqtt_client_new(struct aws_allocator *allocator, struct aws_client_bootstrap *bootstrap) {
aws_mqtt_fatal_assert_library_initialized();
struct aws_mqtt_client *client = aws_mem_calloc(allocator, 1, sizeof(struct aws_mqtt_client));
if (client == NULL) {
return NULL;
}
AWS_LOGF_DEBUG(AWS_LS_MQTT_CLIENT, "client=%p: Initalizing MQTT client", (void *)client);
client->allocator = allocator;
client->bootstrap = aws_client_bootstrap_acquire(bootstrap);
aws_ref_count_init(&client->ref_count, client, (aws_simple_completion_callback *)s_aws_mqtt_client_destroy);
return client;
}
struct aws_mqtt_client *aws_mqtt_client_acquire(struct aws_mqtt_client *client) {
if (client != NULL) {
aws_ref_count_acquire(&client->ref_count);
}
return client;
}
void aws_mqtt_client_release(struct aws_mqtt_client *client) {
if (client != NULL) {
aws_ref_count_release(&client->ref_count);
}
}
#define AWS_RESET_RECONNECT_BACKOFF_DELAY_SECONDS 10
/* At this point, the channel for the MQTT connection has completed its shutdown */
static void s_mqtt_client_shutdown(
struct aws_client_bootstrap *bootstrap,
int error_code,
struct aws_channel *channel,
void *user_data) {
(void)bootstrap;
(void)channel;
struct aws_mqtt_client_connection *connection = user_data;
AWS_LOGF_TRACE(
AWS_LS_MQTT_CLIENT, "id=%p: Channel has been shutdown with error code %d", (void *)connection, error_code);
enum aws_mqtt_client_connection_state prev_state;
struct aws_linked_list cancelling_requests;
aws_linked_list_init(&cancelling_requests);
bool disconnected_state = false;
{ /* BEGIN CRITICAL SECTION */
mqtt_connection_lock_synced_data(connection);
/*
* On a channel that represents a valid connection (successful connack received),
* channel_successful_connack_timestamp_ns will be the time the connack was received. Otherwise it will be
* zero.
*
* Use that fact to determine whether or not we should reset the current reconnect backoff delay.
*
* We reset the reconnect backoff if either of:
* 1) the user called disconnect()
* 2) a successful connection had lasted longer than our minimum reset time (10s at the moment)
*/
uint64_t now = 0;
aws_high_res_clock_get_ticks(&now);
uint64_t time_diff = now - connection->reconnect_timeouts.channel_successful_connack_timestamp_ns;
bool was_user_disconnect = connection->synced_data.state == AWS_MQTT_CLIENT_STATE_DISCONNECTING;
bool was_sufficiently_long_connection =
(connection->reconnect_timeouts.channel_successful_connack_timestamp_ns != 0) &&
(time_diff >=
aws_timestamp_convert(
AWS_RESET_RECONNECT_BACKOFF_DELAY_SECONDS, AWS_TIMESTAMP_SECS, AWS_TIMESTAMP_NANOS, NULL));
if (was_user_disconnect || was_sufficiently_long_connection) {
connection->reconnect_timeouts.current_sec = connection->reconnect_timeouts.min_sec;
}
connection->reconnect_timeouts.channel_successful_connack_timestamp_ns = 0;
/* Move all the ongoing requests to the pending requests list, because the response they are waiting for will
* never arrives. Sad. But, we will retry. */
if (connection->clean_session) {
/* For a clean session, the Session lasts as long as the Network Connection. Thus, discard the previous
* session */
AWS_LOGF_TRACE(
AWS_LS_MQTT_CLIENT,
"id=%p: Discard ongoing requests and pending requests when a clean session connection lost.",
(void *)connection);
aws_linked_list_move_all_back(&cancelling_requests, &connection->thread_data.ongoing_requests_list);
aws_linked_list_move_all_back(&cancelling_requests, &connection->synced_data.pending_requests_list);
} else {
aws_linked_list_move_all_back(
&connection->synced_data.pending_requests_list, &connection->thread_data.ongoing_requests_list);
AWS_LOGF_TRACE(
AWS_LS_MQTT_CLIENT,
"id=%p: All subscribe/unsubscribe and publish QoS>0 have been move to pending list",
(void *)connection);
}
prev_state = connection->synced_data.state;
switch (connection->synced_data.state) {
case AWS_MQTT_CLIENT_STATE_CONNECTED:
/* unexpected hangup from broker, try to reconnect */
mqtt_connection_set_state(connection, AWS_MQTT_CLIENT_STATE_RECONNECTING);
AWS_LOGF_DEBUG(
AWS_LS_MQTT_CLIENT,
"id=%p: connection was unexpected interrupted, switch state to RECONNECTING.",
(void *)connection);
break;
case AWS_MQTT_CLIENT_STATE_DISCONNECTING:
/* disconnect requested by user */
/* Successfully shutdown, if cleansession is set, ongoing and pending requests will be cleared */
disconnected_state = true;
AWS_LOGF_DEBUG(
AWS_LS_MQTT_CLIENT,
"id=%p: disconnect finished, switch state to DISCONNECTED.",
(void *)connection);
break;
case AWS_MQTT_CLIENT_STATE_CONNECTING:
/* failed to connect */
disconnected_state = true;
break;
case AWS_MQTT_CLIENT_STATE_RECONNECTING:
/* reconnect failed, schedule the next attempt later, no need to change the state. */
break;
default:
/* AWS_MQTT_CLIENT_STATE_DISCONNECTED */
break;
}
AWS_LOGF_TRACE(
AWS_LS_MQTT_CLIENT, "id=%p: current state is %d", (void *)connection, (int)connection->synced_data.state);
/* Always clear slot, as that's what's been shutdown */
if (connection->slot) {
aws_channel_slot_remove(connection->slot);
AWS_LOGF_TRACE(AWS_LS_MQTT_CLIENT, "id=%p: slot is removed successfully", (void *)connection);
connection->slot = NULL;
}
mqtt_connection_unlock_synced_data(connection);
} /* END CRITICAL SECTION */
if (!aws_linked_list_empty(&cancelling_requests)) {
struct aws_linked_list_node *current = aws_linked_list_front(&cancelling_requests);
const struct aws_linked_list_node *end = aws_linked_list_end(&cancelling_requests);
while (current != end) {
struct aws_mqtt_request *request = AWS_CONTAINER_OF(current, struct aws_mqtt_request, list_node);
if (request->on_complete) {
request->on_complete(
connection,
request->packet_id,
AWS_ERROR_MQTT_CANCELLED_FOR_CLEAN_SESSION,
request->on_complete_ud);
}
current = current->next;
}
{ /* BEGIN CRITICAL SECTION */
mqtt_connection_lock_synced_data(connection);
while (!aws_linked_list_empty(&cancelling_requests)) {
struct aws_linked_list_node *node = aws_linked_list_pop_front(&cancelling_requests);
struct aws_mqtt_request *request = AWS_CONTAINER_OF(node, struct aws_mqtt_request, list_node);
aws_hash_table_remove(
&connection->synced_data.outstanding_requests_table, &request->packet_id, NULL, NULL);
aws_memory_pool_release(&connection->synced_data.requests_pool, request);
}
mqtt_connection_unlock_synced_data(connection);
} /* END CRITICAL SECTION */
}
/* If there's no error code and this wasn't user-requested, set the error code to something useful */
if (error_code == AWS_ERROR_SUCCESS) {
if (prev_state != AWS_MQTT_CLIENT_STATE_DISCONNECTING && prev_state != AWS_MQTT_CLIENT_STATE_DISCONNECTED) {
error_code = AWS_ERROR_MQTT_UNEXPECTED_HANGUP;
}
}
switch (prev_state) {
case AWS_MQTT_CLIENT_STATE_RECONNECTING: {
/* If reconnect attempt failed, schedule the next attempt */
AWS_LOGF_TRACE(AWS_LS_MQTT_CLIENT, "id=%p: Reconnect failed, retrying", (void *)connection);
s_aws_mqtt_schedule_reconnect_task(connection);
break;
}
case AWS_MQTT_CLIENT_STATE_CONNECTED: {
AWS_LOGF_DEBUG(
AWS_LS_MQTT_CLIENT,
"id=%p: Connection interrupted, calling callback and attempting reconnect",
(void *)connection);
MQTT_CLIENT_CALL_CALLBACK_ARGS(connection, on_interrupted, error_code);
/* In case user called disconnect from the on_interrupted callback */
bool stop_reconnect;
{ /* BEGIN CRITICAL SECTION */
mqtt_connection_lock_synced_data(connection);
stop_reconnect = connection->synced_data.state == AWS_MQTT_CLIENT_STATE_DISCONNECTING;
if (stop_reconnect) {
disconnected_state = true;
AWS_LOGF_DEBUG(
AWS_LS_MQTT_CLIENT,
"id=%p: disconnect finished, switch state to DISCONNECTED.",
(void *)connection);
}
mqtt_connection_unlock_synced_data(connection);
} /* END CRITICAL SECTION */
if (!stop_reconnect) {
s_aws_mqtt_schedule_reconnect_task(connection);
}
break;
}
default:
break;
}
if (disconnected_state) {
{ /* BEGIN CRITICAL SECTION */
mqtt_connection_lock_synced_data(connection);
mqtt_connection_set_state(connection, AWS_MQTT_CLIENT_STATE_DISCONNECTED);
mqtt_connection_unlock_synced_data(connection);
} /* END CRITICAL SECTION */
switch (prev_state) {
case AWS_MQTT_CLIENT_STATE_CONNECTED:
AWS_LOGF_TRACE(
AWS_LS_MQTT_CLIENT,
"id=%p: Caller requested disconnect from on_interrupted callback, aborting reconnect",
(void *)connection);
MQTT_CLIENT_CALL_CALLBACK(connection, on_disconnect);
MQTT_CLIENT_CALL_CALLBACK_ARGS(connection, on_closed, NULL);
break;
case AWS_MQTT_CLIENT_STATE_DISCONNECTING:
AWS_LOGF_DEBUG(
AWS_LS_MQTT_CLIENT,
"id=%p: Disconnect completed, clearing request queue and calling callback",
(void *)connection);
MQTT_CLIENT_CALL_CALLBACK(connection, on_disconnect);
MQTT_CLIENT_CALL_CALLBACK_ARGS(connection, on_closed, NULL);
break;
case AWS_MQTT_CLIENT_STATE_CONNECTING:
AWS_LOGF_TRACE(
AWS_LS_MQTT_CLIENT,
"id=%p: Initial connection attempt failed, calling callback",
(void *)connection);
MQTT_CLIENT_CALL_CALLBACK_ARGS(connection, on_connection_complete, error_code, 0, false);
break;
default:
break;
}
/* The connection can die now. Release the refcount */
aws_mqtt_client_connection_release(connection);
}
}
/*******************************************************************************
* Connection New
******************************************************************************/
/* The assumption here is that a connection always outlives its channels, and the channel this task was scheduled on
* always outlives this task, so all we need to do is check the connection state. If we are in a state that waits
* for a CONNACK, kill it off. In the case that the connection died between scheduling this task and it being executed
* the status will always be CANCELED because this task will be canceled when the owning channel goes away. */
static void s_connack_received_timeout(struct aws_channel_task *channel_task, void *arg, enum aws_task_status status) {
struct aws_mqtt_client_connection *connection = arg;
if (status == AWS_TASK_STATUS_RUN_READY) {
bool time_out = false;
{ /* BEGIN CRITICAL SECTION */
mqtt_connection_lock_synced_data(connection);
time_out =
(connection->synced_data.state == AWS_MQTT_CLIENT_STATE_CONNECTING ||
connection->synced_data.state == AWS_MQTT_CLIENT_STATE_RECONNECTING);
mqtt_connection_unlock_synced_data(connection);
} /* END CRITICAL SECTION */
if (time_out) {
AWS_LOGF_ERROR(AWS_LS_MQTT_CLIENT, "id=%p: mqtt CONNACK response timeout detected", (void *)connection);
aws_channel_shutdown(connection->slot->channel, AWS_ERROR_MQTT_TIMEOUT);
}
}
aws_mem_release(connection->allocator, channel_task);
}
/**
* Channel has been initialized callback. Sets up channel handler and sends out CONNECT packet.
* The on_connack callback is called with the CONNACK packet is received from the server.
*/
static void s_mqtt_client_init(
struct aws_client_bootstrap *bootstrap,
int error_code,
struct aws_channel *channel,
void *user_data) {
(void)bootstrap;
struct aws_io_message *message = NULL;
/* Setup callback contract is: if error_code is non-zero then channel is NULL. */
AWS_FATAL_ASSERT((error_code != 0) == (channel == NULL));
struct aws_mqtt_client_connection *connection = user_data;
if (error_code != AWS_OP_SUCCESS) {
/* client shutdown already handles this case, so just call that. */
s_mqtt_client_shutdown(bootstrap, error_code, channel, user_data);
return;
}
AWS_FATAL_ASSERT(aws_channel_get_event_loop(channel) == connection->loop);
/* user requested disconnect before the channel has been set up. Stop installing the slot and sending CONNECT. */
bool failed_create_slot = false;
{ /* BEGIN CRITICAL SECTION */
mqtt_connection_lock_synced_data(connection);
if (connection->synced_data.state == AWS_MQTT_CLIENT_STATE_DISCONNECTING) {
/* It only happens when the user request disconnect during reconnecting, we don't need to fire any callback.
* The on_disconnect will be invoked as channel finish shutting down. */
mqtt_connection_unlock_synced_data(connection);
aws_channel_shutdown(channel, AWS_ERROR_SUCCESS);
return;
}
/* Create the slot */
connection->slot = aws_channel_slot_new(channel);
if (!connection->slot) {
failed_create_slot = true;
}
mqtt_connection_unlock_synced_data(connection);
} /* END CRITICAL SECTION */
/* intall the slot and handler */
if (failed_create_slot) {
AWS_LOGF_ERROR(
AWS_LS_MQTT_CLIENT,
"id=%p: Failed to create new slot, something has gone horribly wrong, error %d (%s).",
(void *)connection,
aws_last_error(),
aws_error_name(aws_last_error()));
goto handle_error;
}
if (aws_channel_slot_insert_end(channel, connection->slot)) {
AWS_LOGF_ERROR(
AWS_LS_MQTT_CLIENT,
"id=%p: Failed to insert slot into channel %p, error %d (%s).",
(void *)connection,
(void *)channel,
aws_last_error(),
aws_error_name(aws_last_error()));
goto handle_error;
}
if (aws_channel_slot_set_handler(connection->slot, &connection->handler)) {
AWS_LOGF_ERROR(
AWS_LS_MQTT_CLIENT,
"id=%p: Failed to set MQTT handler into slot on channel %p, error %d (%s).",
(void *)connection,
(void *)channel,
aws_last_error(),
aws_error_name(aws_last_error()));
goto handle_error;
}
AWS_LOGF_DEBUG(
AWS_LS_MQTT_CLIENT, "id=%p: Connection successfully opened, sending CONNECT packet", (void *)connection);
struct aws_channel_task *connack_task = aws_mem_calloc(connection->allocator, 1, sizeof(struct aws_channel_task));
if (!connack_task) {
AWS_LOGF_ERROR(AWS_LS_MQTT_CLIENT, "id=%p: Failed to allocate timeout task.", (void *)connection);
goto handle_error;
}
aws_channel_task_init(connack_task, s_connack_received_timeout, connection, "mqtt_connack_timeout");
uint64_t now = 0;
if (aws_channel_current_clock_time(channel, &now)) {
AWS_LOGF_ERROR(
AWS_LS_MQTT_CLIENT,
"static: Failed to setting MQTT handler into slot on channel %p, error %d (%s).",
(void *)channel,
aws_last_error(),
aws_error_name(aws_last_error()));
goto handle_error;
}
now += connection->ping_timeout_ns;
aws_channel_schedule_task_future(channel, connack_task, now);
struct aws_byte_cursor client_id_cursor = aws_byte_cursor_from_buf(&connection->client_id);
AWS_LOGF_DEBUG(
AWS_LS_MQTT_CLIENT,
"id=%p: MQTT Connection initializing CONNECT packet for client-id '" PRInSTR "'",
(void *)connection,
AWS_BYTE_CURSOR_PRI(client_id_cursor));
/* Send the connect packet */
struct aws_mqtt_packet_connect connect;
aws_mqtt_packet_connect_init(
&connect, client_id_cursor, connection->clean_session, connection->keep_alive_time_secs);
if (connection->will.topic.buffer) {
/* Add will if present */
struct aws_byte_cursor topic_cur = aws_byte_cursor_from_buf(&connection->will.topic);
struct aws_byte_cursor payload_cur = aws_byte_cursor_from_buf(&connection->will.payload);
AWS_LOGF_DEBUG(
AWS_LS_MQTT_CLIENT,
"id=%p: Adding will to connection on " PRInSTR " with payload " PRInSTR,
(void *)connection,
AWS_BYTE_CURSOR_PRI(topic_cur),
AWS_BYTE_CURSOR_PRI(payload_cur));
aws_mqtt_packet_connect_add_will(
&connect, topic_cur, connection->will.qos, connection->will.retain, payload_cur);
}
if (connection->username) {
struct aws_byte_cursor username_cur = aws_byte_cursor_from_string(connection->username);
AWS_LOGF_DEBUG(
AWS_LS_MQTT_CLIENT,
"id=%p: Adding username " PRInSTR " to connection",
(void *)connection,
AWS_BYTE_CURSOR_PRI(username_cur));
struct aws_byte_cursor password_cur = {
.ptr = NULL,
.len = 0,
};
if (connection->password) {
password_cur = aws_byte_cursor_from_string(connection->password);
}
aws_mqtt_packet_connect_add_credentials(&connect, username_cur, password_cur);
}
message = mqtt_get_message_for_packet(connection, &connect.fixed_header);
if (!message) {
AWS_LOGF_ERROR(AWS_LS_MQTT_CLIENT, "id=%p: Failed to get message from pool", (void *)connection);
goto handle_error;
}
if (aws_mqtt_packet_connect_encode(&message->message_data, &connect)) {
AWS_LOGF_ERROR(AWS_LS_MQTT_CLIENT, "id=%p: Failed to encode CONNECT packet", (void *)connection);
goto handle_error;
}
if (aws_channel_slot_send_message(connection->slot, message, AWS_CHANNEL_DIR_WRITE)) {
AWS_LOGF_ERROR(AWS_LS_MQTT_CLIENT, "id=%p: Failed to send encoded CONNECT packet upstream", (void *)connection);
goto handle_error;
}
return;
handle_error:
MQTT_CLIENT_CALL_CALLBACK_ARGS(connection, on_connection_complete, aws_last_error(), 0, false);
aws_channel_shutdown(channel, aws_last_error());
if (message) {
aws_mem_release(message->allocator, message);
}
}
static void s_attempt_reconnect(struct aws_task *task, void *userdata, enum aws_task_status status) {
(void)task;
struct aws_mqtt_reconnect_task *reconnect = userdata;
struct aws_mqtt_client_connection *connection = aws_atomic_load_ptr(&reconnect->connection_ptr);
if (status == AWS_TASK_STATUS_RUN_READY && connection) {
/* If the task is not cancelled and a connection has not succeeded, attempt reconnect */
mqtt_connection_lock_synced_data(connection);
/* Check before multiplying to avoid potential overflow */
if (connection->reconnect_timeouts.current_sec > connection->reconnect_timeouts.max_sec / 2) {
connection->reconnect_timeouts.current_sec = connection->reconnect_timeouts.max_sec;
} else {
connection->reconnect_timeouts.current_sec *= 2;
}
AWS_LOGF_TRACE(
AWS_LS_MQTT_CLIENT,
"id=%p: Attempting reconnect, if it fails next attempt will be in %" PRIu64 " seconds",
(void *)connection,
connection->reconnect_timeouts.current_sec);
mqtt_connection_unlock_synced_data(connection);
if (s_mqtt_client_connect(
connection, connection->on_connection_complete, connection->on_connection_complete_ud)) {
/* If reconnect attempt failed, schedule the next attempt */
s_aws_mqtt_schedule_reconnect_task(connection);
} else {
/* Ideally, it would be nice to move this inside the lock, but I'm unsure of the correctness */
connection->reconnect_task->task.timestamp = 0;
}
} else {
aws_mem_release(reconnect->allocator, reconnect);
}
}
void aws_create_reconnect_task(struct aws_mqtt_client_connection *connection) {
if (connection->reconnect_task == NULL) {
connection->reconnect_task = aws_mem_calloc(connection->allocator, 1, sizeof(struct aws_mqtt_reconnect_task));
AWS_FATAL_ASSERT(connection->reconnect_task != NULL);
aws_atomic_init_ptr(&connection->reconnect_task->connection_ptr, connection);
connection->reconnect_task->allocator = connection->allocator;
aws_task_init(
&connection->reconnect_task->task, s_attempt_reconnect, connection->reconnect_task, "mqtt_reconnect");
}
}
static uint64_t s_hash_uint16_t(const void *item) {
return *(uint16_t *)item;
}
static bool s_uint16_t_eq(const void *a, const void *b) {
return *(uint16_t *)a == *(uint16_t *)b;
}
static void s_mqtt_client_connection_destroy_final(struct aws_mqtt_client_connection *connection) {
AWS_PRECONDITION(!connection || connection->allocator);
if (!connection) {
return;
}
/* If the slot is not NULL, the connection is still connected, which should be prevented from calling this function
*/
AWS_ASSERT(!connection->slot);
AWS_LOGF_DEBUG(AWS_LS_MQTT_CLIENT, "id=%p: Destroying connection", (void *)connection);
/* If the reconnect_task isn't freed, free it */
if (connection->reconnect_task) {
aws_mem_release(connection->reconnect_task->allocator, connection->reconnect_task);
}
aws_string_destroy(connection->host_name);
/* Clear the credentials */
if (connection->username) {
aws_string_destroy_secure(connection->username);
}
if (connection->password) {
aws_string_destroy_secure(connection->password);
}
/* Clean up the will */
aws_byte_buf_clean_up(&connection->will.topic);
aws_byte_buf_clean_up(&connection->will.payload);
/* Clear the client_id */
aws_byte_buf_clean_up(&connection->client_id);
/* Free all of the active subscriptions */
aws_mqtt_topic_tree_clean_up(&connection->thread_data.subscriptions);
aws_hash_table_clean_up(&connection->synced_data.outstanding_requests_table);
/* clean up the pending_requests if it's not empty */
while (!aws_linked_list_empty(&connection->synced_data.pending_requests_list)) {
struct aws_linked_list_node *node = aws_linked_list_pop_front(&connection->synced_data.pending_requests_list);
struct aws_mqtt_request *request = AWS_CONTAINER_OF(node, struct aws_mqtt_request, list_node);
/* Fire the callback and clean up the memory, as the connection get destroyed. */
if (request->on_complete) {
request->on_complete(
connection, request->packet_id, AWS_ERROR_MQTT_CONNECTION_DESTROYED, request->on_complete_ud);
}
aws_memory_pool_release(&connection->synced_data.requests_pool, request);
}
aws_memory_pool_clean_up(&connection->synced_data.requests_pool);
aws_mutex_clean_up(&connection->synced_data.lock);
aws_tls_connection_options_clean_up(&connection->tls_options);
/* Clean up the websocket proxy options */
if (connection->http_proxy_config) {
aws_http_proxy_config_destroy(connection->http_proxy_config);
connection->http_proxy_config = NULL;
}
aws_mqtt_client_release(connection->client);
/* Frees all allocated memory */
aws_mem_release(connection->allocator, connection);
}
static void s_on_final_disconnect(struct aws_mqtt_client_connection *connection, void *userdata) {
(void)userdata;
s_mqtt_client_connection_destroy_final(connection);
}
static void s_mqtt_client_connection_start_destroy(struct aws_mqtt_client_connection *connection) {
bool call_destroy_final = false;
AWS_LOGF_DEBUG(
AWS_LS_MQTT_CLIENT,
"id=%p: Last refcount on connection has been released, start destroying the connection.",
(void *)connection);
{ /* BEGIN CRITICAL SECTION */
mqtt_connection_lock_synced_data(connection);
if (connection->synced_data.state != AWS_MQTT_CLIENT_STATE_DISCONNECTED) {
/*
* We don't call the on_disconnect callback until we've transitioned to the DISCONNECTED state. So it's
* safe to change it now while we hold the lock since we know we're not DISCONNECTED yet.
*/
connection->on_disconnect = s_on_final_disconnect;
if (connection->synced_data.state != AWS_MQTT_CLIENT_STATE_DISCONNECTING) {
mqtt_disconnect_impl(connection, AWS_ERROR_SUCCESS);
AWS_LOGF_DEBUG(
AWS_LS_MQTT_CLIENT,
"id=%p: final refcount has been released, switch state to DISCONNECTING.",
(void *)connection);
mqtt_connection_set_state(connection, AWS_MQTT_CLIENT_STATE_DISCONNECTING);
}
} else {
call_destroy_final = true;
}
mqtt_connection_unlock_synced_data(connection);
} /* END CRITICAL SECTION */
if (call_destroy_final) {
s_mqtt_client_connection_destroy_final(connection);
}
}
struct aws_mqtt_client_connection *aws_mqtt_client_connection_new(struct aws_mqtt_client *client) {
AWS_PRECONDITION(client);
struct aws_mqtt_client_connection *connection =
aws_mem_calloc(client->allocator, 1, sizeof(struct aws_mqtt_client_connection));
if (!connection) {
return NULL;
}
AWS_LOGF_DEBUG(AWS_LS_MQTT_CLIENT, "id=%p: Creating new connection", (void *)connection);
/* Initialize the client */
connection->allocator = client->allocator;
aws_ref_count_init(
&connection->ref_count, connection, (aws_simple_completion_callback *)s_mqtt_client_connection_start_destroy);
connection->client = aws_mqtt_client_acquire(client);
AWS_ZERO_STRUCT(connection->synced_data);
connection->synced_data.state = AWS_MQTT_CLIENT_STATE_DISCONNECTED;
connection->reconnect_timeouts.min_sec = 1;
connection->reconnect_timeouts.current_sec = 1;
connection->reconnect_timeouts.max_sec = 128;
aws_linked_list_init(&connection->synced_data.pending_requests_list);
aws_linked_list_init(&connection->thread_data.ongoing_requests_list);
s_init_statistics(&connection->operation_statistics_impl);
if (aws_mutex_init(&connection->synced_data.lock)) {
AWS_LOGF_ERROR(
AWS_LS_MQTT_CLIENT,
"id=%p: Failed to initialize mutex, error %d (%s)",
(void *)connection,
aws_last_error(),
aws_error_name(aws_last_error()));
goto failed_init_mutex;
}
if (aws_mqtt_topic_tree_init(&connection->thread_data.subscriptions, connection->allocator)) {
AWS_LOGF_ERROR(
AWS_LS_MQTT_CLIENT,
"id=%p: Failed to initialize subscriptions topic_tree, error %d (%s)",
(void *)connection,
aws_last_error(),
aws_error_name(aws_last_error()));
goto failed_init_subscriptions;
}
if (aws_memory_pool_init(
&connection->synced_data.requests_pool, connection->allocator, 32, sizeof(struct aws_mqtt_request))) {
AWS_LOGF_ERROR(
AWS_LS_MQTT_CLIENT,
"id=%p: Failed to initialize request pool, error %d (%s)",
(void *)connection,
aws_last_error(),
aws_error_name(aws_last_error()));
goto failed_init_requests_pool;
}
if (aws_hash_table_init(
&connection->synced_data.outstanding_requests_table,
connection->allocator,
sizeof(struct aws_mqtt_request *),
s_hash_uint16_t,
s_uint16_t_eq,
NULL,
NULL)) {
AWS_LOGF_ERROR(
AWS_LS_MQTT_CLIENT,
"id=%p: Failed to initialize outstanding requests table, error %d (%s)",
(void *)connection,
aws_last_error(),
aws_error_name(aws_last_error()));
goto failed_init_outstanding_requests_table;
}
connection->loop = aws_event_loop_group_get_next_loop(client->bootstrap->event_loop_group);
/* Initialize the handler */
connection->handler.alloc = connection->allocator;
connection->handler.vtable = aws_mqtt_get_client_channel_vtable();
connection->handler.impl = connection;
return connection;
failed_init_outstanding_requests_table:
aws_memory_pool_clean_up(&connection->synced_data.requests_pool);
failed_init_requests_pool:
aws_mqtt_topic_tree_clean_up(&connection->thread_data.subscriptions);
failed_init_subscriptions:
aws_mutex_clean_up(&connection->synced_data.lock);
failed_init_mutex:
aws_mem_release(client->allocator, connection);
return NULL;
}
struct aws_mqtt_client_connection *aws_mqtt_client_connection_acquire(struct aws_mqtt_client_connection *connection) {
if (connection != NULL) {
aws_ref_count_acquire(&connection->ref_count);
}
return connection;
}
void aws_mqtt_client_connection_release(struct aws_mqtt_client_connection *connection) {
if (connection != NULL) {
aws_ref_count_release(&connection->ref_count);
}
}
/*******************************************************************************
* Connection Configuration
******************************************************************************/
/* To configure the connection, ensure the state is DISCONNECTED or CONNECTED */
static int s_check_connection_state_for_configuration(struct aws_mqtt_client_connection *connection) {
int result = AWS_OP_SUCCESS;
{ /* BEGIN CRITICAL SECTION */
mqtt_connection_lock_synced_data(connection);
if (connection->synced_data.state != AWS_MQTT_CLIENT_STATE_DISCONNECTED &&
connection->synced_data.state != AWS_MQTT_CLIENT_STATE_CONNECTED) {
AWS_LOGF_ERROR(
AWS_LS_MQTT_CLIENT,
"id=%p: Connection is currently pending connect/disconnect. Unable to make configuration changes until "
"pending operation completes.",
(void *)connection);
result = AWS_OP_ERR;
}
mqtt_connection_unlock_synced_data(connection);
} /* END CRITICAL SECTION */
return result;
}
int aws_mqtt_client_connection_set_will(
struct aws_mqtt_client_connection *connection,
const struct aws_byte_cursor *topic,
enum aws_mqtt_qos qos,
bool retain,
const struct aws_byte_cursor *payload) {
AWS_PRECONDITION(connection);
AWS_PRECONDITION(topic);
if (s_check_connection_state_for_configuration(connection)) {
return aws_raise_error(AWS_ERROR_INVALID_STATE);
}
int result = AWS_OP_ERR;
AWS_LOGF_TRACE(
AWS_LS_MQTT_CLIENT,
"id=%p: Setting last will with topic \"" PRInSTR "\"",
(void *)connection,
AWS_BYTE_CURSOR_PRI(*topic));
if (!aws_mqtt_is_valid_topic(topic)) {
AWS_LOGF_ERROR(AWS_LS_MQTT_CLIENT, "id=%p: Will topic is invalid", (void *)connection);
return aws_raise_error(AWS_ERROR_MQTT_INVALID_TOPIC);
}
struct aws_byte_buf local_topic_buf;
struct aws_byte_buf local_payload_buf;
AWS_ZERO_STRUCT(local_topic_buf);
AWS_ZERO_STRUCT(local_payload_buf);
struct aws_byte_buf topic_buf = aws_byte_buf_from_array(topic->ptr, topic->len);
if (aws_byte_buf_init_copy(&local_topic_buf, connection->allocator, &topic_buf)) {
AWS_LOGF_ERROR(AWS_LS_MQTT_CLIENT, "id=%p: Failed to copy will topic", (void *)connection);
goto cleanup;
}
connection->will.qos = qos;
connection->will.retain = retain;
struct aws_byte_buf payload_buf = aws_byte_buf_from_array(payload->ptr, payload->len);
if (aws_byte_buf_init_copy(&local_payload_buf, connection->allocator, &payload_buf)) {
AWS_LOGF_ERROR(AWS_LS_MQTT_CLIENT, "id=%p: Failed to copy will body", (void *)connection);
goto cleanup;
}
if (connection->will.topic.len) {
AWS_LOGF_TRACE(AWS_LS_MQTT_CLIENT, "id=%p: Will has been set before, resetting it.", (void *)connection);
}
/* Succeed. */
result = AWS_OP_SUCCESS;
/* swap the local buffer with connection */
struct aws_byte_buf temp = local_topic_buf;
local_topic_buf = connection->will.topic;
connection->will.topic = temp;
temp = local_payload_buf;
local_payload_buf = connection->will.payload;
connection->will.payload = temp;
cleanup:
aws_byte_buf_clean_up(&local_topic_buf);
aws_byte_buf_clean_up(&local_payload_buf);
return result;
}
int aws_mqtt_client_connection_set_login(
struct aws_mqtt_client_connection *connection,
const struct aws_byte_cursor *username,
const struct aws_byte_cursor *password) {
AWS_PRECONDITION(connection);
AWS_PRECONDITION(username);
if (s_check_connection_state_for_configuration(connection)) {
return aws_raise_error(AWS_ERROR_INVALID_STATE);
}
int result = AWS_OP_ERR;
AWS_LOGF_TRACE(AWS_LS_MQTT_CLIENT, "id=%p: Setting username and password", (void *)connection);
struct aws_string *username_string = NULL;
struct aws_string *password_string = NULL;
username_string = aws_string_new_from_array(connection->allocator, username->ptr, username->len);
if (!username_string) {
AWS_LOGF_ERROR(AWS_LS_MQTT_CLIENT, "id=%p: Failed to copy username", (void *)connection);
goto cleanup;
}
if (password) {
password_string = aws_string_new_from_array(connection->allocator, password->ptr, password->len);
if (!password_string) {
AWS_LOGF_ERROR(AWS_LS_MQTT_CLIENT, "id=%p: Failed to copy password", (void *)connection);
goto cleanup;
}
}
if (connection->username) {
AWS_LOGF_TRACE(
AWS_LS_MQTT_CLIENT, "id=%p: Login information has been set before, resetting it.", (void *)connection);
}
/* Succeed. */
result = AWS_OP_SUCCESS;
/* swap the local string with connection */
struct aws_string *temp = username_string;
username_string = connection->username;
connection->username = temp;
temp = password_string;
password_string = connection->password;
connection->password = temp;
cleanup:
aws_string_destroy_secure(username_string);
aws_string_destroy_secure(password_string);
return result;
}
int aws_mqtt_client_connection_set_reconnect_timeout(
struct aws_mqtt_client_connection *connection,
uint64_t min_timeout,
uint64_t max_timeout) {
AWS_PRECONDITION(connection);
if (s_check_connection_state_for_configuration(connection)) {
return aws_raise_error(AWS_ERROR_INVALID_STATE);
}
AWS_LOGF_TRACE(
AWS_LS_MQTT_CLIENT,
"id=%p: Setting reconnect timeouts min: %" PRIu64 " max: %" PRIu64,
(void *)connection,
min_timeout,
max_timeout);
connection->reconnect_timeouts.min_sec = min_timeout;
connection->reconnect_timeouts.max_sec = max_timeout;
connection->reconnect_timeouts.current_sec = min_timeout;
return AWS_OP_SUCCESS;
}
int aws_mqtt_client_connection_set_connection_interruption_handlers(
struct aws_mqtt_client_connection *connection,
aws_mqtt_client_on_connection_interrupted_fn *on_interrupted,
void *on_interrupted_ud,
aws_mqtt_client_on_connection_resumed_fn *on_resumed,
void *on_resumed_ud) {
AWS_PRECONDITION(connection);
if (s_check_connection_state_for_configuration(connection)) {
return aws_raise_error(AWS_ERROR_INVALID_STATE);
}
AWS_LOGF_TRACE(
AWS_LS_MQTT_CLIENT, "id=%p: Setting connection interrupted and resumed handlers", (void *)connection);
connection->on_interrupted = on_interrupted;
connection->on_interrupted_ud = on_interrupted_ud;
connection->on_resumed = on_resumed;
connection->on_resumed_ud = on_resumed_ud;
return AWS_OP_SUCCESS;
}
int aws_mqtt_client_connection_set_connection_closed_handler(
struct aws_mqtt_client_connection *connection,
aws_mqtt_client_on_connection_closed_fn *on_closed,
void *on_closed_ud) {
AWS_PRECONDITION(connection);
if (s_check_connection_state_for_configuration(connection)) {
return aws_raise_error(AWS_ERROR_INVALID_STATE);
}
AWS_LOGF_TRACE(AWS_LS_MQTT_CLIENT, "id=%p: Setting connection closed handler", (void *)connection);
connection->on_closed = on_closed;
connection->on_closed_ud = on_closed_ud;
return AWS_OP_SUCCESS;
}
int aws_mqtt_client_connection_set_on_any_publish_handler(
struct aws_mqtt_client_connection *connection,
aws_mqtt_client_publish_received_fn *on_any_publish,
void *on_any_publish_ud) {
AWS_PRECONDITION(connection);
{ /* BEGIN CRITICAL SECTION */
mqtt_connection_lock_synced_data(connection);
if (connection->synced_data.state == AWS_MQTT_CLIENT_STATE_CONNECTED) {
mqtt_connection_unlock_synced_data(connection);
AWS_LOGF_ERROR(
AWS_LS_MQTT_CLIENT,
"id=%p: Connection is connected, publishes may arrive anytime. Unable to set publish handler until "
"offline.",
(void *)connection);
return aws_raise_error(AWS_ERROR_INVALID_STATE);
}
mqtt_connection_unlock_synced_data(connection);
} /* END CRITICAL SECTION */
AWS_LOGF_TRACE(AWS_LS_MQTT_CLIENT, "id=%p: Setting on_any_publish handler", (void *)connection);
connection->on_any_publish = on_any_publish;
connection->on_any_publish_ud = on_any_publish_ud;
return AWS_OP_SUCCESS;
}
/*******************************************************************************
* Websockets
******************************************************************************/
#ifdef AWS_MQTT_WITH_WEBSOCKETS
int aws_mqtt_client_connection_use_websockets(
struct aws_mqtt_client_connection *connection,
aws_mqtt_transform_websocket_handshake_fn *transformer,
void *transformer_ud,
aws_mqtt_validate_websocket_handshake_fn *validator,
void *validator_ud) {
connection->websocket.handshake_transformer = transformer;
connection->websocket.handshake_transformer_ud = transformer_ud;
connection->websocket.handshake_validator = validator;
connection->websocket.handshake_validator_ud = validator_ud;
connection->websocket.enabled = true;
AWS_LOGF_TRACE(AWS_LS_MQTT_CLIENT, "id=%p: Using websockets", (void *)connection);
return AWS_OP_SUCCESS;
}
int aws_mqtt_client_connection_set_http_proxy_options(
struct aws_mqtt_client_connection *connection,
struct aws_http_proxy_options *proxy_options) {
/* If there is existing proxy options, nuke em */
if (connection->http_proxy_config) {
aws_http_proxy_config_destroy(connection->http_proxy_config);
connection->http_proxy_config = NULL;
}
connection->http_proxy_config =
aws_http_proxy_config_new_tunneling_from_proxy_options(connection->allocator, proxy_options);
return connection->http_proxy_config != NULL ? AWS_OP_SUCCESS : AWS_OP_ERR;
}
static void s_on_websocket_shutdown(struct aws_websocket *websocket, int error_code, void *user_data) {
struct aws_mqtt_client_connection *connection = user_data;
struct aws_channel *channel = connection->slot ? connection->slot->channel : NULL;
s_mqtt_client_shutdown(connection->client->bootstrap, error_code, channel, connection);
if (websocket) {
aws_websocket_release(websocket);
}
}
static void s_on_websocket_setup(const struct aws_websocket_on_connection_setup_data *setup, void *user_data) {
/* Setup callback contract is: if error_code is non-zero then websocket is NULL. */
AWS_FATAL_ASSERT((setup->error_code != 0) == (setup->websocket == NULL));
struct aws_mqtt_client_connection *connection = user_data;
struct aws_channel *channel = NULL;
if (connection->websocket.handshake_request) {
aws_http_message_release(connection->websocket.handshake_request);
connection->websocket.handshake_request = NULL;
}
if (setup->websocket) {
channel = aws_websocket_get_channel(setup->websocket);
AWS_FATAL_ASSERT(channel);
AWS_FATAL_ASSERT(aws_channel_get_event_loop(channel) == connection->loop);
/* Websocket must be "converted" before the MQTT handler can be installed next to it. */
if (aws_websocket_convert_to_midchannel_handler(setup->websocket)) {
AWS_LOGF_ERROR(
AWS_LS_MQTT_CLIENT,
"id=%p: Failed converting websocket, error %d (%s)",
(void *)connection,
aws_last_error(),
aws_error_name(aws_last_error()));
aws_channel_shutdown(channel, aws_last_error());
return;
}
/* If validation callback is set, let the user accept/reject the handshake */
if (connection->websocket.handshake_validator) {
AWS_LOGF_TRACE(AWS_LS_MQTT_CLIENT, "id=%p: Validating websocket handshake response.", (void *)connection);
if (connection->websocket.handshake_validator(
connection,
setup->handshake_response_header_array,
setup->num_handshake_response_headers,
connection->websocket.handshake_validator_ud)) {
AWS_LOGF_ERROR(
AWS_LS_MQTT_CLIENT,
"id=%p: Failure reported by websocket handshake validator callback, error %d (%s)",
(void *)connection,
aws_last_error(),
aws_error_name(aws_last_error()));
aws_channel_shutdown(channel, aws_last_error());
return;
}
AWS_LOGF_TRACE(
AWS_LS_MQTT_CLIENT, "id=%p: Done validating websocket handshake response.", (void *)connection);
}
}
/* Call into the channel-setup callback, the rest of the logic is the same. */
s_mqtt_client_init(connection->client->bootstrap, setup->error_code, channel, connection);
}
static aws_mqtt_transform_websocket_handshake_complete_fn s_websocket_handshake_transform_complete; /* fwd declare */
static int s_websocket_connect(struct aws_mqtt_client_connection *connection) {
AWS_ASSERT(connection->websocket.enabled);
/* Build websocket handshake request */
connection->websocket.handshake_request = aws_http_message_new_websocket_handshake_request(
connection->allocator, *g_websocket_handshake_default_path, aws_byte_cursor_from_string(connection->host_name));
if (!connection->websocket.handshake_request) {
AWS_LOGF_ERROR(AWS_LS_MQTT_CLIENT, "id=%p: Failed to generate websocket handshake request", (void *)connection);
goto error;
}
if (aws_http_message_add_header(
connection->websocket.handshake_request, *g_websocket_handshake_default_protocol_header)) {
AWS_LOGF_ERROR(AWS_LS_MQTT_CLIENT, "id=%p: Failed to generate websocket handshake request", (void *)connection);
goto error;
}
/* If user registered a transform callback, call it and wait for transform_complete() to be called.
* If no callback registered, call the transform_complete() function ourselves. */
if (connection->websocket.handshake_transformer) {
AWS_LOGF_TRACE(AWS_LS_MQTT_CLIENT, "id=%p: Transforming websocket handshake request.", (void *)connection);
connection->websocket.handshake_transformer(
connection->websocket.handshake_request,
connection->websocket.handshake_transformer_ud,
s_websocket_handshake_transform_complete,
connection);
} else {
s_websocket_handshake_transform_complete(
connection->websocket.handshake_request, AWS_ERROR_SUCCESS, connection);
}
return AWS_OP_SUCCESS;
error:
aws_http_message_release(connection->websocket.handshake_request);
connection->websocket.handshake_request = NULL;
return AWS_OP_ERR;
}
static void s_websocket_handshake_transform_complete(
struct aws_http_message *handshake_request,
int error_code,
void *complete_ctx) {
struct aws_mqtt_client_connection *connection = complete_ctx;
if (error_code) {
AWS_LOGF_ERROR(
AWS_LS_MQTT_CLIENT,
"id=%p: Failure reported by websocket handshake transform callback.",
(void *)connection);
goto error;
}
if (connection->websocket.handshake_transformer) {
AWS_LOGF_TRACE(AWS_LS_MQTT_CLIENT, "id=%p: Done transforming websocket handshake request.", (void *)connection);
}
/* Call websocket connect() */
struct aws_websocket_client_connection_options websocket_options = {
.allocator = connection->allocator,
.bootstrap = connection->client->bootstrap,
.socket_options = &connection->socket_options,
.tls_options = connection->tls_options.ctx ? &connection->tls_options : NULL,
.host = aws_byte_cursor_from_string(connection->host_name),
.port = connection->port,
.handshake_request = handshake_request,
.initial_window_size = 0, /* Prevent websocket data from arriving before the MQTT handler is installed */
.user_data = connection,
.on_connection_setup = s_on_websocket_setup,
.on_connection_shutdown = s_on_websocket_shutdown,
.requested_event_loop = connection->loop,
};
struct aws_http_proxy_options proxy_options;
AWS_ZERO_STRUCT(proxy_options);
if (connection->http_proxy_config != NULL) {
aws_http_proxy_options_init_from_config(&proxy_options, connection->http_proxy_config);
websocket_options.proxy_options = &proxy_options;
}
if (aws_websocket_client_connect(&websocket_options)) {
AWS_LOGF_ERROR(AWS_LS_MQTT_CLIENT, "id=%p: Failed to initiate websocket connection.", (void *)connection);
error_code = aws_last_error();
goto error;
}
/* Success */
return;
error:;
/* Proceed to next step, telling it that we failed. */
struct aws_websocket_on_connection_setup_data websocket_setup = {.error_code = error_code};
s_on_websocket_setup(&websocket_setup, connection);
}
#else /* AWS_MQTT_WITH_WEBSOCKETS */
int aws_mqtt_client_connection_use_websockets(
struct aws_mqtt_client_connection *connection,
aws_mqtt_transform_websocket_handshake_fn *transformer,
void *transformer_ud,
aws_mqtt_validate_websocket_handshake_fn *validator,
void *validator_ud) {
(void)connection;
(void)transformer;
(void)transformer_ud;
(void)validator;
(void)validator_ud;
AWS_LOGF_ERROR(
AWS_LS_MQTT_CLIENT,
"id=%p: Cannot use websockets unless library is built with MQTT_WITH_WEBSOCKETS option.",
(void *)connection);
return aws_raise_error(AWS_ERROR_MQTT_BUILT_WITHOUT_WEBSOCKETS);
}
int aws_mqtt_client_connection_set_websocket_proxy_options(
struct aws_mqtt_client_connection *connection,
struct aws_http_proxy_options *proxy_options) {
(void)connection;
(void)proxy_options;
AWS_LOGF_ERROR(
AWS_LS_MQTT_CLIENT,
"id=%p: Cannot use websockets unless library is built with MQTT_WITH_WEBSOCKETS option.",
(void *)connection);
return aws_raise_error(AWS_ERROR_MQTT_BUILT_WITHOUT_WEBSOCKETS);
}
#endif /* AWS_MQTT_WITH_WEBSOCKETS */
/*******************************************************************************
* Connect
******************************************************************************/
int aws_mqtt_client_connection_connect(
struct aws_mqtt_client_connection *connection,
const struct aws_mqtt_connection_options *connection_options) {
/* TODO: Do we need to support resuming the connection if user connect to the same connection & endpoint and the
* clean_session is false?
* If not, the broker will resume the connection in this case, and we pretend we are making a new connection, which
* may cause some confusing behavior. This is basically what we have now. NOTE: The topic_tree is living with the
* connection right now, which is really confusing.
* If yes, an edge case will be: User disconnected from the connection with clean_session
* being false, then connect to another endpoint with the same connection object, we probably need to clear all
* those states from last connection and create a new "connection". Problem is what if user finish the second
* connection and reconnect to the first endpoint. There is no way for us to resume the connection in this case. */
AWS_LOGF_TRACE(AWS_LS_MQTT_CLIENT, "id=%p: Opening connection", (void *)connection);
{ /* BEGIN CRITICAL SECTION */
mqtt_connection_lock_synced_data(connection);
if (connection->synced_data.state != AWS_MQTT_CLIENT_STATE_DISCONNECTED) {
mqtt_connection_unlock_synced_data(connection);
return aws_raise_error(AWS_ERROR_MQTT_ALREADY_CONNECTED);
}
mqtt_connection_set_state(connection, AWS_MQTT_CLIENT_STATE_CONNECTING);
AWS_LOGF_DEBUG(
AWS_LS_MQTT_CLIENT, "id=%p: Begin connecting process, switch state to CONNECTING.", (void *)connection);
mqtt_connection_unlock_synced_data(connection);
} /* END CRITICAL SECTION */
if (connection->host_name) {
aws_string_destroy(connection->host_name);
}
connection->host_name = aws_string_new_from_array(
connection->allocator, connection_options->host_name.ptr, connection_options->host_name.len);
connection->port = connection_options->port;
connection->socket_options = *connection_options->socket_options;
connection->clean_session = connection_options->clean_session;
connection->keep_alive_time_secs = connection_options->keep_alive_time_secs;
connection->connection_count = 0;
if (!connection->keep_alive_time_secs) {
connection->keep_alive_time_secs = s_default_keep_alive_sec;
}
if (!connection_options->protocol_operation_timeout_ms) {
connection->operation_timeout_ns = UINT64_MAX;
} else {
connection->operation_timeout_ns = aws_timestamp_convert(
(uint64_t)connection_options->protocol_operation_timeout_ms,
AWS_TIMESTAMP_MILLIS,
AWS_TIMESTAMP_NANOS,
NULL);
}
if (!connection_options->ping_timeout_ms) {
connection->ping_timeout_ns = s_default_ping_timeout_ns;
} else {
connection->ping_timeout_ns = aws_timestamp_convert(
(uint64_t)connection_options->ping_timeout_ms, AWS_TIMESTAMP_MILLIS, AWS_TIMESTAMP_NANOS, NULL);
}
/* Keep alive time should always be greater than the timeouts. */
if (AWS_UNLIKELY(connection->keep_alive_time_secs * (uint64_t)AWS_TIMESTAMP_NANOS <= connection->ping_timeout_ns)) {
AWS_LOGF_FATAL(
AWS_LS_MQTT_CLIENT,
"id=%p: Illegal configuration, Connection keep alive %" PRIu64
"ns must be greater than the request timeouts %" PRIu64 "ns.",
(void *)connection,
(uint64_t)connection->keep_alive_time_secs * (uint64_t)AWS_TIMESTAMP_NANOS,
connection->ping_timeout_ns);
AWS_FATAL_ASSERT(
connection->keep_alive_time_secs * (uint64_t)AWS_TIMESTAMP_NANOS > connection->ping_timeout_ns);
}
AWS_LOGF_INFO(
AWS_LS_MQTT_CLIENT,
"id=%p: using ping timeout of %" PRIu64 " ns",
(void *)connection,
connection->ping_timeout_ns);
/* Cheat and set the tls_options host_name to our copy if they're the same */
if (connection_options->tls_options) {
connection->use_tls = true;
if (aws_tls_connection_options_copy(&connection->tls_options, connection_options->tls_options)) {
AWS_LOGF_ERROR(
AWS_LS_MQTT_CLIENT, "id=%p: Failed to copy TLS Connection Options into connection", (void *)connection);
return AWS_OP_ERR;
}
if (!connection_options->tls_options->server_name) {
struct aws_byte_cursor host_name_cur = aws_byte_cursor_from_string(connection->host_name);
if (aws_tls_connection_options_set_server_name(
&connection->tls_options, connection->allocator, &host_name_cur)) {
AWS_LOGF_ERROR(
AWS_LS_MQTT_CLIENT, "id=%p: Failed to set TLS Connection Options server name", (void *)connection);
goto error;
}
}
} else {
AWS_ZERO_STRUCT(connection->tls_options);
}
/* Clean up old client_id */
if (connection->client_id.buffer) {
aws_byte_buf_clean_up(&connection->client_id);
}
/* Only set connection->client_id if a new one was provided */
struct aws_byte_buf client_id_buf =
aws_byte_buf_from_array(connection_options->client_id.ptr, connection_options->client_id.len);
if (aws_byte_buf_init_copy(&connection->client_id, connection->allocator, &client_id_buf)) {
AWS_LOGF_ERROR(AWS_LS_MQTT_CLIENT, "id=%p: Failed to copy client_id into connection", (void *)connection);
goto error;
}
struct aws_linked_list cancelling_requests;
aws_linked_list_init(&cancelling_requests);
{ /* BEGIN CRITICAL SECTION */
mqtt_connection_lock_synced_data(connection);
if (connection->clean_session) {
AWS_LOGF_TRACE(
AWS_LS_MQTT_CLIENT,
"id=%p: a clean session connection requested, all the previous requests will fail",
(void *)connection);
aws_linked_list_swap_contents(&connection->synced_data.pending_requests_list, &cancelling_requests);
}
mqtt_connection_unlock_synced_data(connection);
} /* END CRITICAL SECTION */
if (!aws_linked_list_empty(&cancelling_requests)) {
struct aws_linked_list_node *current = aws_linked_list_front(&cancelling_requests);
const struct aws_linked_list_node *end = aws_linked_list_end(&cancelling_requests);
/* invoke all the complete callback for requests from previous session */
while (current != end) {
struct aws_mqtt_request *request = AWS_CONTAINER_OF(current, struct aws_mqtt_request, list_node);
AWS_LOGF_TRACE(
AWS_LS_MQTT_CLIENT,
"id=%p: Establishing a new clean session connection, discard the previous request %" PRIu16,
(void *)connection,
request->packet_id);
if (request->on_complete) {
request->on_complete(
connection,
request->packet_id,
AWS_ERROR_MQTT_CANCELLED_FOR_CLEAN_SESSION,
request->on_complete_ud);
}
current = current->next;
}
/* free the resource */
{ /* BEGIN CRITICAL SECTION */
mqtt_connection_lock_synced_data(connection);
while (!aws_linked_list_empty(&cancelling_requests)) {
struct aws_linked_list_node *node = aws_linked_list_pop_front(&cancelling_requests);
struct aws_mqtt_request *request = AWS_CONTAINER_OF(node, struct aws_mqtt_request, list_node);
aws_hash_table_remove(
&connection->synced_data.outstanding_requests_table, &request->packet_id, NULL, NULL);
aws_memory_pool_release(&connection->synced_data.requests_pool, request);
}
mqtt_connection_unlock_synced_data(connection);
} /* END CRITICAL SECTION */
}
/* Begin the connecting process, acquire the connection to keep it alive until we disconnected */
aws_mqtt_client_connection_acquire(connection);
if (s_mqtt_client_connect(connection, connection_options->on_connection_complete, connection_options->user_data)) {
/*
* An error calling s_mqtt_client_connect should (must) be mutually exclusive with s_mqtt_client_shutdown().
* So it should be safe and correct to call release now to undo the pinning we did a few lines above.
*/
aws_mqtt_client_connection_release(connection);
/* client_id has been updated with something but it will get cleaned up when the connection gets cleaned up
* so we don't need to worry about it here*/
if (connection->clean_session) {
AWS_LOGF_WARN(
AWS_LS_MQTT_CLIENT, "id=%p: The previous session has been cleaned up and losted!", (void *)connection);
}
goto error;
}
return AWS_OP_SUCCESS;
error:
aws_tls_connection_options_clean_up(&connection->tls_options);
AWS_ZERO_STRUCT(connection->tls_options);
{ /* BEGIN CRITICAL SECTION */
mqtt_connection_lock_synced_data(connection);
mqtt_connection_set_state(connection, AWS_MQTT_CLIENT_STATE_DISCONNECTED);
mqtt_connection_unlock_synced_data(connection);
} /* END CRITICAL SECTION */
return AWS_OP_ERR;
}
static int s_mqtt_client_connect(
struct aws_mqtt_client_connection *connection,
aws_mqtt_client_on_connection_complete_fn *on_connection_complete,
void *userdata) {
connection->on_connection_complete = on_connection_complete;
connection->on_connection_complete_ud = userdata;
int result = 0;
#ifdef AWS_MQTT_WITH_WEBSOCKETS
if (connection->websocket.enabled) {
result = s_websocket_connect(connection);
} else
#endif /* AWS_MQTT_WITH_WEBSOCKETS */
{
struct aws_socket_channel_bootstrap_options channel_options;
AWS_ZERO_STRUCT(channel_options);
channel_options.bootstrap = connection->client->bootstrap;
channel_options.host_name = aws_string_c_str(connection->host_name);
channel_options.port = connection->port;
channel_options.socket_options = &connection->socket_options;
channel_options.tls_options = connection->use_tls ? &connection->tls_options : NULL;
channel_options.setup_callback = &s_mqtt_client_init;
channel_options.shutdown_callback = &s_mqtt_client_shutdown;
channel_options.user_data = connection;
channel_options.requested_event_loop = connection->loop;
if (connection->http_proxy_config == NULL) {
result = aws_client_bootstrap_new_socket_channel(&channel_options);
} else {
struct aws_http_proxy_options proxy_options;
AWS_ZERO_STRUCT(proxy_options);
aws_http_proxy_options_init_from_config(&proxy_options, connection->http_proxy_config);
result = aws_http_proxy_new_socket_channel(&channel_options, &proxy_options);
}
}
if (result) {
/* Connection attempt failed */
AWS_LOGF_ERROR(
AWS_LS_MQTT_CLIENT,
"id=%p: Failed to begin connection routine, error %d (%s).",
(void *)connection,
aws_last_error(),
aws_error_name(aws_last_error()));
return AWS_OP_ERR;
}
return AWS_OP_SUCCESS;
}
/*******************************************************************************
* Reconnect DEPRECATED
******************************************************************************/
int aws_mqtt_client_connection_reconnect(
struct aws_mqtt_client_connection *connection,
aws_mqtt_client_on_connection_complete_fn *on_connection_complete,
void *userdata) {
(void)connection;
(void)on_connection_complete;
(void)userdata;
/* DEPRECATED, connection will reconnect automatically now. */
AWS_LOGF_ERROR(AWS_LS_MQTT_CLIENT, "aws_mqtt_client_connection_reconnect has been DEPRECATED.");
return aws_raise_error(AWS_ERROR_UNSUPPORTED_OPERATION);
}
/*******************************************************************************
* Disconnect
******************************************************************************/
int aws_mqtt_client_connection_disconnect(
struct aws_mqtt_client_connection *connection,
aws_mqtt_client_on_disconnect_fn *on_disconnect,
void *userdata) {
AWS_LOGF_DEBUG(AWS_LS_MQTT_CLIENT, "id=%p: user called disconnect.", (void *)connection);
{ /* BEGIN CRITICAL SECTION */
mqtt_connection_lock_synced_data(connection);
if (connection->synced_data.state != AWS_MQTT_CLIENT_STATE_CONNECTED &&
connection->synced_data.state != AWS_MQTT_CLIENT_STATE_RECONNECTING) {
mqtt_connection_unlock_synced_data(connection);
AWS_LOGF_ERROR(
AWS_LS_MQTT_CLIENT, "id=%p: Connection is not open, and may not be closed", (void *)connection);
aws_raise_error(AWS_ERROR_MQTT_NOT_CONNECTED);
return AWS_OP_ERR;
}
mqtt_connection_set_state(connection, AWS_MQTT_CLIENT_STATE_DISCONNECTING);
AWS_LOGF_DEBUG(
AWS_LS_MQTT_CLIENT,
"id=%p: User requests disconnecting, switch state to DISCONNECTING.",
(void *)connection);
connection->on_disconnect = on_disconnect;
connection->on_disconnect_ud = userdata;
mqtt_connection_unlock_synced_data(connection);
} /* END CRITICAL SECTION */
AWS_LOGF_DEBUG(AWS_LS_MQTT_CLIENT, "id=%p: Closing connection", (void *)connection);
mqtt_disconnect_impl(connection, AWS_OP_SUCCESS);
return AWS_OP_SUCCESS;
}
/*******************************************************************************
* Subscribe
******************************************************************************/
static void s_on_publish_client_wrapper(
const struct aws_byte_cursor *topic,
const struct aws_byte_cursor *payload,
bool dup,
enum aws_mqtt_qos qos,
bool retain,
void *userdata) {
struct subscribe_task_topic *task_topic = userdata;
/* Call out to the user callback */
if (task_topic->request.on_publish) {
task_topic->request.on_publish(
task_topic->connection, topic, payload, dup, qos, retain, task_topic->request.on_publish_ud);
}
}
static void s_task_topic_release(void *userdata) {
struct subscribe_task_topic *task_topic = userdata;
if (task_topic != NULL) {
aws_ref_count_release(&task_topic->ref_count);
}
}
static void s_task_topic_clean_up(void *userdata) {
struct subscribe_task_topic *task_topic = userdata;
if (task_topic->request.on_cleanup) {
task_topic->request.on_cleanup(task_topic->request.on_publish_ud);
}
aws_string_destroy(task_topic->filter);
aws_mem_release(task_topic->connection->allocator, task_topic);
}
static enum aws_mqtt_client_request_state s_subscribe_send(uint16_t packet_id, bool is_first_attempt, void *userdata) {
(void)is_first_attempt;
struct subscribe_task_arg *task_arg = userdata;
bool initing_packet = task_arg->subscribe.fixed_header.packet_type == 0;
struct aws_io_message *message = NULL;
AWS_LOGF_TRACE(
AWS_LS_MQTT_CLIENT,
"id=%p: Attempting send of subscribe %" PRIu16 " (%s)",
(void *)task_arg->connection,
packet_id,
is_first_attempt ? "first attempt" : "resend");
if (initing_packet) {
/* Init the subscribe packet */
if (aws_mqtt_packet_subscribe_init(&task_arg->subscribe, task_arg->connection->allocator, packet_id)) {
return AWS_MQTT_CLIENT_REQUEST_ERROR;
}
}
const size_t num_topics = aws_array_list_length(&task_arg->topics);
if (num_topics <= 0) {
aws_raise_error(AWS_ERROR_MQTT_INVALID_TOPIC);
return AWS_MQTT_CLIENT_REQUEST_ERROR;
}
AWS_VARIABLE_LENGTH_ARRAY(uint8_t, transaction_buf, num_topics * aws_mqtt_topic_tree_action_size);
struct aws_array_list transaction;
aws_array_list_init_static(&transaction, transaction_buf, num_topics, aws_mqtt_topic_tree_action_size);
for (size_t i = 0; i < num_topics; ++i) {
struct subscribe_task_topic *topic = NULL;
aws_array_list_get_at(&task_arg->topics, &topic, i);
AWS_ASSUME(topic); /* We know we're within bounds */
if (initing_packet) {
if (aws_mqtt_packet_subscribe_add_topic(&task_arg->subscribe, topic->request.topic, topic->request.qos)) {
goto handle_error;
}
}
if (!task_arg->tree_updated) {
if (aws_mqtt_topic_tree_transaction_insert(
&task_arg->connection->thread_data.subscriptions,
&transaction,
topic->filter,
topic->request.qos,
s_on_publish_client_wrapper,
s_task_topic_release,
topic)) {
goto handle_error;
}
/* If insert succeed, acquire the refcount */
aws_ref_count_acquire(&topic->ref_count);
}
}
message = mqtt_get_message_for_packet(task_arg->connection, &task_arg->subscribe.fixed_header);
if (!message) {
goto handle_error;
}
if (aws_mqtt_packet_subscribe_encode(&message->message_data, &task_arg->subscribe)) {
goto handle_error;
}
/* This is not necessarily a fatal error; if the subscribe fails, it'll just retry. Still need to clean up though.
*/
if (aws_channel_slot_send_message(task_arg->connection->slot, message, AWS_CHANNEL_DIR_WRITE)) {
aws_mem_release(message->allocator, message);
}
if (!task_arg->tree_updated) {
aws_mqtt_topic_tree_transaction_commit(&task_arg->connection->thread_data.subscriptions, &transaction);
task_arg->tree_updated = true;
}
aws_array_list_clean_up(&transaction);
return AWS_MQTT_CLIENT_REQUEST_ONGOING;
handle_error:
if (message) {
aws_mem_release(message->allocator, message);
}
if (!task_arg->tree_updated) {
aws_mqtt_topic_tree_transaction_roll_back(&task_arg->connection->thread_data.subscriptions, &transaction);
}
aws_array_list_clean_up(&transaction);
return AWS_MQTT_CLIENT_REQUEST_ERROR;
}
static void s_subscribe_complete(
struct aws_mqtt_client_connection *connection,
uint16_t packet_id,
int error_code,
void *userdata) {
struct subscribe_task_arg *task_arg = userdata;
struct subscribe_task_topic *topic = NULL;
aws_array_list_get_at(&task_arg->topics, &topic, 0);
AWS_ASSUME(topic);
AWS_LOGF_DEBUG(
AWS_LS_MQTT_CLIENT,
"id=%p: Subscribe %" PRIu16 " completed with error_code %d",
(void *)connection,
packet_id,
error_code);
size_t list_len = aws_array_list_length(&task_arg->topics);
if (task_arg->on_suback.multi) {
/* create a list of aws_mqtt_topic_subscription pointers from topics for the callback */
AWS_VARIABLE_LENGTH_ARRAY(uint8_t, cb_list_buf, list_len * sizeof(void *));
struct aws_array_list cb_list;
aws_array_list_init_static(&cb_list, cb_list_buf, list_len, sizeof(void *));
int err = 0;
for (size_t i = 0; i < list_len; i++) {
err |= aws_array_list_get_at(&task_arg->topics, &topic, i);
struct aws_mqtt_topic_subscription *subscription = &topic->request;
err |= aws_array_list_push_back(&cb_list, &subscription);
}
AWS_ASSUME(!err);
task_arg->on_suback.multi(connection, packet_id, &cb_list, error_code, task_arg->on_suback_ud);
aws_array_list_clean_up(&cb_list);
} else if (task_arg->on_suback.single) {
task_arg->on_suback.single(
connection, packet_id, &topic->request.topic, topic->request.qos, error_code, task_arg->on_suback_ud);
}
for (size_t i = 0; i < list_len; i++) {
aws_array_list_get_at(&task_arg->topics, &topic, i);
s_task_topic_release(topic);
}
aws_array_list_clean_up(&task_arg->topics);
aws_mqtt_packet_subscribe_clean_up(&task_arg->subscribe);
aws_mem_release(task_arg->connection->allocator, task_arg);
}
uint16_t aws_mqtt_client_connection_subscribe_multiple(
struct aws_mqtt_client_connection *connection,
const struct aws_array_list *topic_filters,
aws_mqtt_suback_multi_fn *on_suback,
void *on_suback_ud) {
AWS_PRECONDITION(connection);
struct subscribe_task_arg *task_arg = aws_mem_calloc(connection->allocator, 1, sizeof(struct subscribe_task_arg));
if (!task_arg) {
return 0;
}
task_arg->connection = connection;
task_arg->on_suback.multi = on_suback;
task_arg->on_suback_ud = on_suback_ud;
const size_t num_topics = aws_array_list_length(topic_filters);
if (aws_array_list_init_dynamic(&task_arg->topics, connection->allocator, num_topics, sizeof(void *))) {
goto handle_error;
}
AWS_LOGF_DEBUG(AWS_LS_MQTT_CLIENT, "id=%p: Starting multi-topic subscribe", (void *)connection);
/* Calculate the size of the subscribe packet
* The fixed header is 2 bytes and the packet ID is 2 bytes.
* Note: The size of the topic filter(s) are calculated in the loop below */
uint64_t subscribe_packet_size = 4;
for (size_t i = 0; i < num_topics; ++i) {
struct aws_mqtt_topic_subscription *request = NULL;
aws_array_list_get_at_ptr(topic_filters, (void **)&request, i);
if (!aws_mqtt_is_valid_topic_filter(&request->topic)) {
aws_raise_error(AWS_ERROR_MQTT_INVALID_TOPIC);
goto handle_error;
}
struct subscribe_task_topic *task_topic =
aws_mem_calloc(connection->allocator, 1, sizeof(struct subscribe_task_topic));
if (!task_topic) {
goto handle_error;
}
aws_ref_count_init(&task_topic->ref_count, task_topic, (aws_simple_completion_callback *)s_task_topic_clean_up);
task_topic->connection = connection;
task_topic->request = *request;
task_topic->filter = aws_string_new_from_array(
connection->allocator, task_topic->request.topic.ptr, task_topic->request.topic.len);
if (!task_topic->filter) {
aws_mem_release(connection->allocator, task_topic);
goto handle_error;
}
/* Update request topic cursor to refer to owned string */
task_topic->request.topic = aws_byte_cursor_from_string(task_topic->filter);
AWS_LOGF_DEBUG(
AWS_LS_MQTT_CLIENT,
"id=%p: Adding topic \"" PRInSTR "\"",
(void *)connection,
AWS_BYTE_CURSOR_PRI(task_topic->request.topic));
/* Push into the list */
aws_array_list_push_back(&task_arg->topics, &task_topic);
/* Subscribe topic filter is: always 3 bytes (1 for QoS, 2 for Length MSB/LSB) + the size of the topic filter */
subscribe_packet_size += 3 + task_topic->request.topic.len;
}
uint16_t packet_id = mqtt_create_request(
task_arg->connection,
&s_subscribe_send,
task_arg,
&s_subscribe_complete,
task_arg,
false, /* noRetry */
subscribe_packet_size);
if (packet_id == 0) {
AWS_LOGF_ERROR(
AWS_LS_MQTT_CLIENT,
"id=%p: Failed to kick off multi-topic subscribe, with error %s",
(void *)connection,
aws_error_debug_str(aws_last_error()));
goto handle_error;
}
AWS_LOGF_DEBUG(AWS_LS_MQTT_CLIENT, "id=%p: Sending multi-topic subscribe %" PRIu16, (void *)connection, packet_id);
return packet_id;
handle_error:
if (task_arg) {
if (task_arg->topics.data) {
const size_t num_added_topics = aws_array_list_length(&task_arg->topics);
for (size_t i = 0; i < num_added_topics; ++i) {
struct subscribe_task_topic *task_topic = NULL;
aws_array_list_get_at(&task_arg->topics, (void **)&task_topic, i);
AWS_ASSUME(task_topic);
aws_string_destroy(task_topic->filter);
aws_mem_release(connection->allocator, task_topic);
}
aws_array_list_clean_up(&task_arg->topics);
}
aws_mem_release(connection->allocator, task_arg);
}
return 0;
}
/*******************************************************************************
* Subscribe Single
******************************************************************************/
static void s_subscribe_single_complete(
struct aws_mqtt_client_connection *connection,
uint16_t packet_id,
int error_code,
void *userdata) {
struct subscribe_task_arg *task_arg = userdata;
AWS_LOGF_DEBUG(
AWS_LS_MQTT_CLIENT,
"id=%p: Subscribe %" PRIu16 " completed with error code %d",
(void *)connection,
packet_id,
error_code);
AWS_ASSERT(aws_array_list_length(&task_arg->topics) == 1);
struct subscribe_task_topic *topic = NULL;
aws_array_list_get_at(&task_arg->topics, &topic, 0);
AWS_ASSUME(topic); /* There needs to be exactly 1 topic in this list */
if (task_arg->on_suback.single) {
AWS_ASSUME(aws_string_is_valid(topic->filter));
aws_mqtt_suback_fn *suback = task_arg->on_suback.single;
suback(connection, packet_id, &topic->request.topic, topic->request.qos, error_code, task_arg->on_suback_ud);
}
s_task_topic_release(topic);
aws_array_list_clean_up(&task_arg->topics);
aws_mqtt_packet_subscribe_clean_up(&task_arg->subscribe);
aws_mem_release(task_arg->connection->allocator, task_arg);
}
uint16_t aws_mqtt_client_connection_subscribe(
struct aws_mqtt_client_connection *connection,
const struct aws_byte_cursor *topic_filter,
enum aws_mqtt_qos qos,
aws_mqtt_client_publish_received_fn *on_publish,
void *on_publish_ud,
aws_mqtt_userdata_cleanup_fn *on_ud_cleanup,
aws_mqtt_suback_fn *on_suback,
void *on_suback_ud) {
AWS_PRECONDITION(connection);
if (!aws_mqtt_is_valid_topic_filter(topic_filter)) {
aws_raise_error(AWS_ERROR_MQTT_INVALID_TOPIC);
return 0;
}
/* Because we know we're only going to have 1 topic, we can cheat and allocate the array_list in the same block as
* the task argument. */
void *task_topic_storage = NULL;
struct subscribe_task_topic *task_topic = NULL;
struct subscribe_task_arg *task_arg = aws_mem_acquire_many(
connection->allocator,
2,
&task_arg,
sizeof(struct subscribe_task_arg),
&task_topic_storage,
sizeof(struct subscribe_task_topic *));
if (!task_arg) {
goto handle_error;
}
AWS_ZERO_STRUCT(*task_arg);
task_arg->connection = connection;
task_arg->on_suback.single = on_suback;
task_arg->on_suback_ud = on_suback_ud;
/* It stores the pointer */
aws_array_list_init_static(&task_arg->topics, task_topic_storage, 1, sizeof(void *));
/* Allocate the topic and push into the list */
task_topic = aws_mem_calloc(connection->allocator, 1, sizeof(struct subscribe_task_topic));
if (!task_topic) {
goto handle_error;
}
aws_ref_count_init(&task_topic->ref_count, task_topic, (aws_simple_completion_callback *)s_task_topic_clean_up);
aws_array_list_push_back(&task_arg->topics, &task_topic);
task_topic->filter = aws_string_new_from_array(connection->allocator, topic_filter->ptr, topic_filter->len);
if (!task_topic->filter) {
goto handle_error;
}
task_topic->connection = connection;
task_topic->request.topic = aws_byte_cursor_from_string(task_topic->filter);
task_topic->request.qos = qos;
task_topic->request.on_publish = on_publish;
task_topic->request.on_cleanup = on_ud_cleanup;
task_topic->request.on_publish_ud = on_publish_ud;
/* Calculate the size of the (single) subscribe packet
* The fixed header is 2 bytes,
* the topic filter is always at least 3 bytes (1 for QoS, 2 for Length MSB/LSB)
* - plus the size of the topic filter
* and finally the packet ID is 2 bytes */
uint64_t subscribe_packet_size = 7 + topic_filter->len;
uint16_t packet_id = mqtt_create_request(
task_arg->connection,
&s_subscribe_send,
task_arg,
&s_subscribe_single_complete,
task_arg,
false, /* noRetry */
subscribe_packet_size);
if (packet_id == 0) {
AWS_LOGF_ERROR(
AWS_LS_MQTT_CLIENT,
"id=%p: Failed to start subscribe on topic " PRInSTR " with error %s",
(void *)connection,
AWS_BYTE_CURSOR_PRI(task_topic->request.topic),
aws_error_debug_str(aws_last_error()));
goto handle_error;
}
AWS_LOGF_DEBUG(
AWS_LS_MQTT_CLIENT,
"id=%p: Starting subscribe %" PRIu16 " on topic " PRInSTR,
(void *)connection,
packet_id,
AWS_BYTE_CURSOR_PRI(task_topic->request.topic));
return packet_id;
handle_error:
if (task_topic) {
if (task_topic->filter) {
aws_string_destroy(task_topic->filter);
}
aws_mem_release(connection->allocator, task_topic);
}
if (task_arg) {
aws_mem_release(connection->allocator, task_arg);
}
return 0;
}
/*******************************************************************************
* Subscribe Local
******************************************************************************/
/* The lifetime of this struct is from subscribe -> suback */
struct subscribe_local_task_arg {
struct aws_mqtt_client_connection *connection;
struct subscribe_task_topic *task_topic;
aws_mqtt_suback_fn *on_suback;
void *on_suback_ud;
};
static enum aws_mqtt_client_request_state s_subscribe_local_send(
uint16_t packet_id,
bool is_first_attempt,
void *userdata) {
(void)is_first_attempt;
struct subscribe_local_task_arg *task_arg = userdata;
AWS_LOGF_TRACE(
AWS_LS_MQTT_CLIENT,
"id=%p: Attempting save of local subscribe %" PRIu16 " (%s)",
(void *)task_arg->connection,
packet_id,
is_first_attempt ? "first attempt" : "redo");
struct subscribe_task_topic *topic = task_arg->task_topic;
if (aws_mqtt_topic_tree_insert(
&task_arg->connection->thread_data.subscriptions,
topic->filter,
topic->request.qos,
s_on_publish_client_wrapper,
s_task_topic_release,
topic)) {
return AWS_MQTT_CLIENT_REQUEST_ERROR;
}
aws_ref_count_acquire(&topic->ref_count);
return AWS_MQTT_CLIENT_REQUEST_COMPLETE;
}
static void s_subscribe_local_complete(
struct aws_mqtt_client_connection *connection,
uint16_t packet_id,
int error_code,
void *userdata) {
struct subscribe_local_task_arg *task_arg = userdata;
AWS_LOGF_DEBUG(
AWS_LS_MQTT_CLIENT,
"id=%p: Local subscribe %" PRIu16 " completed with error code %d",
(void *)connection,
packet_id,
error_code);
struct subscribe_task_topic *topic = task_arg->task_topic;
if (task_arg->on_suback) {
aws_mqtt_suback_fn *suback = task_arg->on_suback;
suback(connection, packet_id, &topic->request.topic, topic->request.qos, error_code, task_arg->on_suback_ud);
}
s_task_topic_release(topic);
aws_mem_release(task_arg->connection->allocator, task_arg);
}
uint16_t aws_mqtt_client_connection_subscribe_local(
struct aws_mqtt_client_connection *connection,
const struct aws_byte_cursor *topic_filter,
aws_mqtt_client_publish_received_fn *on_publish,
void *on_publish_ud,
aws_mqtt_userdata_cleanup_fn *on_ud_cleanup,
aws_mqtt_suback_fn *on_suback,
void *on_suback_ud) {
AWS_PRECONDITION(connection);
if (!aws_mqtt_is_valid_topic_filter(topic_filter)) {
aws_raise_error(AWS_ERROR_MQTT_INVALID_TOPIC);
return 0;
}
struct subscribe_task_topic *task_topic = NULL;
struct subscribe_local_task_arg *task_arg =
aws_mem_calloc(connection->allocator, 1, sizeof(struct subscribe_local_task_arg));
if (!task_arg) {
goto handle_error;
}
AWS_ZERO_STRUCT(*task_arg);
task_arg->connection = connection;
task_arg->on_suback = on_suback;
task_arg->on_suback_ud = on_suback_ud;
task_topic = aws_mem_calloc(connection->allocator, 1, sizeof(struct subscribe_task_topic));
if (!task_topic) {
goto handle_error;
}
aws_ref_count_init(&task_topic->ref_count, task_topic, (aws_simple_completion_callback *)s_task_topic_clean_up);
task_arg->task_topic = task_topic;
task_topic->filter = aws_string_new_from_array(connection->allocator, topic_filter->ptr, topic_filter->len);
if (!task_topic->filter) {
goto handle_error;
}
task_topic->connection = connection;
task_topic->is_local = true;
task_topic->request.topic = aws_byte_cursor_from_string(task_topic->filter);
task_topic->request.on_publish = on_publish;
task_topic->request.on_cleanup = on_ud_cleanup;
task_topic->request.on_publish_ud = on_publish_ud;
/* Calculate the size of the (local) subscribe packet
* The fixed header is 2 bytes, the packet ID is 2 bytes
* the topic filter is always 3 bytes (1 for QoS, 2 for Length MSB/LSB)
* - plus the size of the topic filter */
uint64_t subscribe_packet_size = 7 + topic_filter->len;
uint16_t packet_id = mqtt_create_request(
task_arg->connection,
s_subscribe_local_send,
task_arg,
&s_subscribe_local_complete,
task_arg,
false, /* noRetry */
subscribe_packet_size);
if (packet_id == 0) {
AWS_LOGF_ERROR(
AWS_LS_MQTT_CLIENT,
"id=%p: Failed to start local subscribe on topic " PRInSTR " with error %s",
(void *)connection,
AWS_BYTE_CURSOR_PRI(task_topic->request.topic),
aws_error_debug_str(aws_last_error()));
goto handle_error;
}
AWS_LOGF_DEBUG(
AWS_LS_MQTT_CLIENT,
"id=%p: Starting local subscribe %" PRIu16 " on topic " PRInSTR,
(void *)connection,
packet_id,
AWS_BYTE_CURSOR_PRI(task_topic->request.topic));
return packet_id;
handle_error:
if (task_topic) {
if (task_topic->filter) {
aws_string_destroy(task_topic->filter);
}
aws_mem_release(connection->allocator, task_topic);
}
if (task_arg) {
aws_mem_release(connection->allocator, task_arg);
}
return 0;
}
/*******************************************************************************
* Resubscribe
******************************************************************************/
static bool s_reconnect_resub_iterator(const struct aws_byte_cursor *topic, enum aws_mqtt_qos qos, void *user_data) {
struct subscribe_task_arg *task_arg = user_data;
struct subscribe_task_topic *task_topic =
aws_mem_calloc(task_arg->connection->allocator, 1, sizeof(struct subscribe_task_topic));
struct aws_mqtt_topic_subscription sub;
AWS_ZERO_STRUCT(sub);
sub.topic = *topic;
sub.qos = qos;
task_topic->request = sub;
task_topic->connection = task_arg->connection;
aws_array_list_push_back(&task_arg->topics, &task_topic);
aws_ref_count_init(&task_topic->ref_count, task_topic, (aws_simple_completion_callback *)s_task_topic_clean_up);
return true;
}
static bool s_reconnect_resub_operation_statistics_iterator(
const struct aws_byte_cursor *topic,
enum aws_mqtt_qos qos,
void *user_data) {
(void)qos;
uint64_t *packet_size = user_data;
/* Always 3 bytes (1 for QoS, 2 for length MSB and LSB respectively) */
*packet_size += 3;
/* The size of the topic filter */
*packet_size += topic->len;
return true;
}
static enum aws_mqtt_client_request_state s_resubscribe_send(
uint16_t packet_id,
bool is_first_attempt,
void *userdata) {
struct subscribe_task_arg *task_arg = userdata;
bool initing_packet = task_arg->subscribe.fixed_header.packet_type == 0;
struct aws_io_message *message = NULL;
const size_t sub_count = aws_mqtt_topic_tree_get_sub_count(&task_arg->connection->thread_data.subscriptions);
/* Init the topics list even if there are no topics because the s_resubscribe_complete callback will always run. */
if (aws_array_list_init_dynamic(&task_arg->topics, task_arg->connection->allocator, sub_count, sizeof(void *))) {
goto handle_error;
}
if (sub_count == 0) {
AWS_LOGF_TRACE(
AWS_LS_MQTT_CLIENT,
"id=%p: Not subscribed to any topics. Resubscribe is unnecessary, no packet will be sent.",
(void *)task_arg->connection);
return AWS_MQTT_CLIENT_REQUEST_COMPLETE;
}
aws_mqtt_topic_tree_iterate(&task_arg->connection->thread_data.subscriptions, s_reconnect_resub_iterator, task_arg);
AWS_LOGF_TRACE(
AWS_LS_MQTT_CLIENT,
"id=%p: Attempting send of resubscribe %" PRIu16 " (%s)",
(void *)task_arg->connection,
packet_id,
is_first_attempt ? "first attempt" : "resend");
if (initing_packet) {
/* Init the subscribe packet */
if (aws_mqtt_packet_subscribe_init(&task_arg->subscribe, task_arg->connection->allocator, packet_id)) {
return AWS_MQTT_CLIENT_REQUEST_ERROR;
}
const size_t num_topics = aws_array_list_length(&task_arg->topics);
if (num_topics <= 0) {
aws_raise_error(AWS_ERROR_MQTT_INVALID_TOPIC);
return AWS_MQTT_CLIENT_REQUEST_ERROR;
}
for (size_t i = 0; i < num_topics; ++i) {
struct subscribe_task_topic *topic = NULL;
aws_array_list_get_at(&task_arg->topics, &topic, i);
AWS_ASSUME(topic); /* We know we're within bounds */
if (aws_mqtt_packet_subscribe_add_topic(&task_arg->subscribe, topic->request.topic, topic->request.qos)) {
goto handle_error;
}
}
}
message = mqtt_get_message_for_packet(task_arg->connection, &task_arg->subscribe.fixed_header);
if (!message) {
goto handle_error;
}
if (aws_mqtt_packet_subscribe_encode(&message->message_data, &task_arg->subscribe)) {
goto handle_error;
}
/* This is not necessarily a fatal error; if the send fails, it'll just retry. Still need to clean up though. */
if (aws_channel_slot_send_message(task_arg->connection->slot, message, AWS_CHANNEL_DIR_WRITE)) {
aws_mem_release(message->allocator, message);
}
return AWS_MQTT_CLIENT_REQUEST_ONGOING;
handle_error:
if (message) {
aws_mem_release(message->allocator, message);
}
return AWS_MQTT_CLIENT_REQUEST_ERROR;
}
static void s_resubscribe_complete(
struct aws_mqtt_client_connection *connection,
uint16_t packet_id,
int error_code,
void *userdata) {
struct subscribe_task_arg *task_arg = userdata;
const size_t list_len = aws_array_list_length(&task_arg->topics);
if (list_len <= 0) {
goto clean_up;
}
struct subscribe_task_topic *topic = NULL;
aws_array_list_get_at(&task_arg->topics, &topic, 0);
AWS_ASSUME(topic);
AWS_LOGF_DEBUG(
AWS_LS_MQTT_CLIENT,
"id=%p: Subscribe %" PRIu16 " completed with error_code %d",
(void *)connection,
packet_id,
error_code);
if (task_arg->on_suback.multi) {
/* create a list of aws_mqtt_topic_subscription pointers from topics for the callback */
AWS_VARIABLE_LENGTH_ARRAY(uint8_t, cb_list_buf, list_len * sizeof(void *));
struct aws_array_list cb_list;
aws_array_list_init_static(&cb_list, cb_list_buf, list_len, sizeof(void *));
int err = 0;
for (size_t i = 0; i < list_len; i++) {
err |= aws_array_list_get_at(&task_arg->topics, &topic, i);
struct aws_mqtt_topic_subscription *subscription = &topic->request;
err |= aws_array_list_push_back(&cb_list, &subscription);
}
AWS_ASSUME(!err);
task_arg->on_suback.multi(connection, packet_id, &cb_list, error_code, task_arg->on_suback_ud);
aws_array_list_clean_up(&cb_list);
} else if (task_arg->on_suback.single) {
task_arg->on_suback.single(
connection, packet_id, &topic->request.topic, topic->request.qos, error_code, task_arg->on_suback_ud);
}
clean_up:
/* We need to cleanup the subscribe_task_topics, since they are not inserted into the topic tree by resubscribe. We
* take the ownership to clean it up */
for (size_t i = 0; i < list_len; i++) {
aws_array_list_get_at(&task_arg->topics, &topic, i);
s_task_topic_release(topic);
}
aws_array_list_clean_up(&task_arg->topics);
aws_mqtt_packet_subscribe_clean_up(&task_arg->subscribe);
aws_mem_release(task_arg->connection->allocator, task_arg);
}
uint16_t aws_mqtt_resubscribe_existing_topics(
struct aws_mqtt_client_connection *connection,
aws_mqtt_suback_multi_fn *on_suback,
void *on_suback_ud) {
struct subscribe_task_arg *task_arg = aws_mem_calloc(connection->allocator, 1, sizeof(struct subscribe_task_arg));
if (!task_arg) {
AWS_LOGF_ERROR(
AWS_LS_MQTT_CLIENT, "id=%p: failed to allocate storage for resubscribe arguments", (void *)connection);
return 0;
}
AWS_ZERO_STRUCT(*task_arg);
task_arg->connection = connection;
task_arg->on_suback.multi = on_suback;
task_arg->on_suback_ud = on_suback_ud;
/* Calculate the size of the packet.
* The fixed header is 2 bytes and the packet ID is 2 bytes
* plus the size of each topic in the topic tree */
uint64_t resubscribe_packet_size = 4;
/* Get the length of each subscription we are going to resubscribe with */
aws_mqtt_topic_tree_iterate(
&connection->thread_data.subscriptions,
s_reconnect_resub_operation_statistics_iterator,
&resubscribe_packet_size);
uint16_t packet_id = mqtt_create_request(
task_arg->connection,
&s_resubscribe_send,
task_arg,
&s_resubscribe_complete,
task_arg,
false, /* noRetry */
resubscribe_packet_size);
if (packet_id == 0) {
AWS_LOGF_ERROR(
AWS_LS_MQTT_CLIENT,
"id=%p: Failed to send multi-topic resubscribe with error %s",
(void *)connection,
aws_error_name(aws_last_error()));
goto handle_error;
}
AWS_LOGF_DEBUG(
AWS_LS_MQTT_CLIENT, "id=%p: Sending multi-topic resubscribe %" PRIu16, (void *)connection, packet_id);
return packet_id;
handle_error:
aws_mem_release(connection->allocator, task_arg);
return 0;
}
/*******************************************************************************
* Unsubscribe
******************************************************************************/
struct unsubscribe_task_arg {
struct aws_mqtt_client_connection *connection;
struct aws_string *filter_string;
struct aws_byte_cursor filter;
bool is_local;
/* Packet to populate */
struct aws_mqtt_packet_unsubscribe unsubscribe;
/* true if transaction was committed to the topic tree, false requires a retry */
bool tree_updated;
aws_mqtt_op_complete_fn *on_unsuback;
void *on_unsuback_ud;
struct request_timeout_wrapper timeout_wrapper;
};
static enum aws_mqtt_client_request_state s_unsubscribe_send(
uint16_t packet_id,
bool is_first_attempt,
void *userdata) {
(void)is_first_attempt;
struct unsubscribe_task_arg *task_arg = userdata;
struct aws_io_message *message = NULL;
AWS_LOGF_TRACE(
AWS_LS_MQTT_CLIENT,
"id=%p: Attempting send of unsubscribe %" PRIu16 " %s",
(void *)task_arg->connection,
packet_id,
is_first_attempt ? "first attempt" : "resend");
static const size_t num_topics = 1;
AWS_VARIABLE_LENGTH_ARRAY(uint8_t, transaction_buf, num_topics * aws_mqtt_topic_tree_action_size);
struct aws_array_list transaction;
aws_array_list_init_static(&transaction, transaction_buf, num_topics, aws_mqtt_topic_tree_action_size);
if (!task_arg->tree_updated) {
struct subscribe_task_topic *topic;
if (aws_mqtt_topic_tree_transaction_remove(
&task_arg->connection->thread_data.subscriptions, &transaction, &task_arg->filter, (void **)&topic)) {
goto handle_error;
}
task_arg->is_local = topic ? topic->is_local : false;
}
if (!task_arg->is_local) {
if (task_arg->unsubscribe.fixed_header.packet_type == 0) {
/* If unsubscribe packet is uninitialized, init it */
if (aws_mqtt_packet_unsubscribe_init(&task_arg->unsubscribe, task_arg->connection->allocator, packet_id)) {
goto handle_error;
}
if (aws_mqtt_packet_unsubscribe_add_topic(&task_arg->unsubscribe, task_arg->filter)) {
goto handle_error;
}
}
message = mqtt_get_message_for_packet(task_arg->connection, &task_arg->unsubscribe.fixed_header);
if (!message) {
goto handle_error;
}
if (aws_mqtt_packet_unsubscribe_encode(&message->message_data, &task_arg->unsubscribe)) {
goto handle_error;
}
if (aws_channel_slot_send_message(task_arg->connection->slot, message, AWS_CHANNEL_DIR_WRITE)) {
goto handle_error;
}
/* TODO: timing should start from the message written into the socket, which is aws_io_message->on_completion
* invoked, but there are bugs in the websocket handler (and maybe also the h1 handler?) where we don't properly
* fire the on_completion callbacks. */
struct request_timeout_task_arg *timeout_task_arg = s_schedule_timeout_task(task_arg->connection, packet_id);
if (!timeout_task_arg) {
return AWS_MQTT_CLIENT_REQUEST_ERROR;
}
/*
* Set up mutual references between the operation task args and the timeout task args. Whoever runs first
* "wins", does its logic, and then breaks the connection between the two.
*/
task_arg->timeout_wrapper.timeout_task_arg = timeout_task_arg;
timeout_task_arg->task_arg_wrapper = &task_arg->timeout_wrapper;
}
if (!task_arg->tree_updated) {
aws_mqtt_topic_tree_transaction_commit(&task_arg->connection->thread_data.subscriptions, &transaction);
task_arg->tree_updated = true;
}
aws_array_list_clean_up(&transaction);
/* If the subscribe is local-only, don't wait for a SUBACK to come back. */
return task_arg->is_local ? AWS_MQTT_CLIENT_REQUEST_COMPLETE : AWS_MQTT_CLIENT_REQUEST_ONGOING;
handle_error:
if (message) {
aws_mem_release(message->allocator, message);
}
if (!task_arg->tree_updated) {
aws_mqtt_topic_tree_transaction_roll_back(&task_arg->connection->thread_data.subscriptions, &transaction);
}
aws_array_list_clean_up(&transaction);
return AWS_MQTT_CLIENT_REQUEST_ERROR;
}
static void s_unsubscribe_complete(
struct aws_mqtt_client_connection *connection,
uint16_t packet_id,
int error_code,
void *userdata) {
struct unsubscribe_task_arg *task_arg = userdata;
AWS_LOGF_DEBUG(AWS_LS_MQTT_CLIENT, "id=%p: Unsubscribe %" PRIu16 " complete", (void *)connection, packet_id);
/*
* If we have a forward pointer to a timeout task, then that means the timeout task has not run yet. So we should
* follow it and zero out the back pointer to us, because we're going away now. The timeout task will run later
* and be harmless (even vs. future operations with the same packet id) because it only cancels if it has a back
* pointer.
*/
if (task_arg->timeout_wrapper.timeout_task_arg) {
task_arg->timeout_wrapper.timeout_task_arg->task_arg_wrapper = NULL;
task_arg->timeout_wrapper.timeout_task_arg = NULL;
}
if (task_arg->on_unsuback) {
task_arg->on_unsuback(connection, packet_id, error_code, task_arg->on_unsuback_ud);
}
aws_string_destroy(task_arg->filter_string);
aws_mqtt_packet_unsubscribe_clean_up(&task_arg->unsubscribe);
aws_mem_release(task_arg->connection->allocator, task_arg);
}
uint16_t aws_mqtt_client_connection_unsubscribe(
struct aws_mqtt_client_connection *connection,
const struct aws_byte_cursor *topic_filter,
aws_mqtt_op_complete_fn *on_unsuback,
void *on_unsuback_ud) {
AWS_PRECONDITION(connection);
if (!aws_mqtt_is_valid_topic_filter(topic_filter)) {
aws_raise_error(AWS_ERROR_MQTT_INVALID_TOPIC);
return 0;
}
struct unsubscribe_task_arg *task_arg =
aws_mem_calloc(connection->allocator, 1, sizeof(struct unsubscribe_task_arg));
if (!task_arg) {
return 0;
}
task_arg->connection = connection;
task_arg->filter_string = aws_string_new_from_array(connection->allocator, topic_filter->ptr, topic_filter->len);
task_arg->filter = aws_byte_cursor_from_string(task_arg->filter_string);
task_arg->on_unsuback = on_unsuback;
task_arg->on_unsuback_ud = on_unsuback_ud;
/* Calculate the size of the unsubscribe packet.
* The fixed header is always 2 bytes, the packet ID is always 2 bytes
* plus the size of the topic filter */
uint64_t unsubscribe_packet_size = 4 + task_arg->filter.len;
uint16_t packet_id = mqtt_create_request(
connection,
&s_unsubscribe_send,
task_arg,
s_unsubscribe_complete,
task_arg,
false, /* noRetry */
unsubscribe_packet_size);
if (packet_id == 0) {
AWS_LOGF_DEBUG(
AWS_LS_MQTT_CLIENT,
"id=%p: Failed to start unsubscribe, with error %s",
(void *)connection,
aws_error_debug_str(aws_last_error()));
goto handle_error;
}
AWS_LOGF_DEBUG(AWS_LS_MQTT_CLIENT, "id=%p: Starting unsubscribe %" PRIu16, (void *)connection, packet_id);
return packet_id;
handle_error:
aws_string_destroy(task_arg->filter_string);
aws_mem_release(connection->allocator, task_arg);
return 0;
}
/*******************************************************************************
* Publish
******************************************************************************/
struct publish_task_arg {
struct aws_mqtt_client_connection *connection;
struct aws_string *topic_string;
struct aws_byte_cursor topic;
enum aws_mqtt_qos qos;
bool retain;
struct aws_byte_cursor payload;
struct aws_byte_buf payload_buf;
/* Packet to populate */
struct aws_mqtt_packet_publish publish;
aws_mqtt_op_complete_fn *on_complete;
void *userdata;
struct request_timeout_wrapper timeout_wrapper;
};
/* should only be called by tests */
static int s_get_stuff_from_outstanding_requests_table(
struct aws_mqtt_client_connection *connection,
uint16_t packet_id,
struct aws_allocator *allocator,
struct aws_byte_buf *result_buf,
struct aws_string **result_string) {
int err = AWS_OP_SUCCESS;
aws_mutex_lock(&connection->synced_data.lock);
struct aws_hash_element *elem = NULL;
aws_hash_table_find(&connection->synced_data.outstanding_requests_table, &packet_id, &elem);
if (elem) {
struct aws_mqtt_request *request = elem->value;
struct publish_task_arg *pub = (struct publish_task_arg *)request->send_request_ud;
if (result_buf != NULL) {
if (aws_byte_buf_init_copy(result_buf, allocator, &pub->payload_buf)) {
err = AWS_OP_ERR;
}
} else if (result_string != NULL) {
*result_string = aws_string_new_from_string(allocator, pub->topic_string);
if (*result_string == NULL) {
err = AWS_OP_ERR;
}
}
} else {
/* So lovely that this error is defined, but hashtable never actually raises it */
err = aws_raise_error(AWS_ERROR_HASHTBL_ITEM_NOT_FOUND);
}
aws_mutex_unlock(&connection->synced_data.lock);
return err;
}
/* should only be called by tests */
int aws_mqtt_client_get_payload_for_outstanding_publish_packet(
struct aws_mqtt_client_connection *connection,
uint16_t packet_id,
struct aws_allocator *allocator,
struct aws_byte_buf *result) {
AWS_ZERO_STRUCT(*result);
return s_get_stuff_from_outstanding_requests_table(connection, packet_id, allocator, result, NULL);
}
/* should only be called by tests */
int aws_mqtt_client_get_topic_for_outstanding_publish_packet(
struct aws_mqtt_client_connection *connection,
uint16_t packet_id,
struct aws_allocator *allocator,
struct aws_string **result) {
*result = NULL;
return s_get_stuff_from_outstanding_requests_table(connection, packet_id, allocator, NULL, result);
}
static enum aws_mqtt_client_request_state s_publish_send(uint16_t packet_id, bool is_first_attempt, void *userdata) {
struct publish_task_arg *task_arg = userdata;
struct aws_mqtt_client_connection *connection = task_arg->connection;
AWS_LOGF_TRACE(
AWS_LS_MQTT_CLIENT,
"id=%p: Attempting send of publish %" PRIu16 " %s",
(void *)task_arg->connection,
packet_id,
is_first_attempt ? "first attempt" : "resend");
bool is_qos_0 = task_arg->qos == AWS_MQTT_QOS_AT_MOST_ONCE;
if (is_qos_0) {
packet_id = 0;
}
if (is_first_attempt) {
if (aws_mqtt_packet_publish_init(
&task_arg->publish,
task_arg->retain,
task_arg->qos,
!is_first_attempt,
task_arg->topic,
packet_id,
task_arg->payload)) {
return AWS_MQTT_CLIENT_REQUEST_ERROR;
}
}
struct aws_io_message *message = mqtt_get_message_for_packet(task_arg->connection, &task_arg->publish.fixed_header);
if (!message) {
return AWS_MQTT_CLIENT_REQUEST_ERROR;
}
/* Encode the headers, and everything but the payload */
if (aws_mqtt_packet_publish_encode_headers(&message->message_data, &task_arg->publish)) {
return AWS_MQTT_CLIENT_REQUEST_ERROR;
}
struct aws_byte_cursor payload_cur = task_arg->payload;
{
write_payload_chunk:
(void)NULL;
const size_t left_in_message = message->message_data.capacity - message->message_data.len;
const size_t to_write = payload_cur.len < left_in_message ? payload_cur.len : left_in_message;
if (to_write) {
/* Write this chunk */
struct aws_byte_cursor to_write_cur = aws_byte_cursor_advance(&payload_cur, to_write);
AWS_ASSERT(to_write_cur.ptr); /* to_write is guaranteed to be inside the bounds of payload_cur */
if (!aws_byte_buf_write_from_whole_cursor(&message->message_data, to_write_cur)) {
aws_mem_release(message->allocator, message);
return AWS_MQTT_CLIENT_REQUEST_ERROR;
}
}
if (aws_channel_slot_send_message(task_arg->connection->slot, message, AWS_CHANNEL_DIR_WRITE)) {
aws_mem_release(message->allocator, message);
/* If it's QoS 0, telling user that the message haven't been sent, else, the message will be resent once the
* connection is back */
return is_qos_0 ? AWS_MQTT_CLIENT_REQUEST_ERROR : AWS_MQTT_CLIENT_REQUEST_ONGOING;
}
/* If there's still payload left, get a new message and start again. */
if (payload_cur.len) {
message = mqtt_get_message_for_packet(task_arg->connection, &task_arg->publish.fixed_header);
goto write_payload_chunk;
}
}
if (!is_qos_0 && connection->operation_timeout_ns != UINT64_MAX) {
/* TODO: timing should start from the message written into the socket, which is aws_io_message->on_completion
* invoked, but there are bugs in the websocket handler (and maybe also the h1 handler?) where we don't properly
* fire fire the on_completion callbacks. */
struct request_timeout_task_arg *timeout_task_arg = s_schedule_timeout_task(connection, packet_id);
if (!timeout_task_arg) {
return AWS_MQTT_CLIENT_REQUEST_ERROR;
}
/*
* Set up mutual references between the operation task args and the timeout task args. Whoever runs first
* "wins", does its logic, and then breaks the connection between the two.
*/
task_arg->timeout_wrapper.timeout_task_arg = timeout_task_arg;
timeout_task_arg->task_arg_wrapper = &task_arg->timeout_wrapper;
}
/* If QoS == 0, there will be no ack, so consider the request done now. */
return is_qos_0 ? AWS_MQTT_CLIENT_REQUEST_COMPLETE : AWS_MQTT_CLIENT_REQUEST_ONGOING;
}
static void s_publish_complete(
struct aws_mqtt_client_connection *connection,
uint16_t packet_id,
int error_code,
void *userdata) {
struct publish_task_arg *task_arg = userdata;
AWS_LOGF_DEBUG(AWS_LS_MQTT_CLIENT, "id=%p: Publish %" PRIu16 " complete", (void *)connection, packet_id);
if (task_arg->on_complete) {
task_arg->on_complete(connection, packet_id, error_code, task_arg->userdata);
}
/*
* If we have a forward pointer to a timeout task, then that means the timeout task has not run yet. So we should
* follow it and zero out the back pointer to us, because we're going away now. The timeout task will run later
* and be harmless (even vs. future operations with the same packet id) because it only cancels if it has a back
* pointer.
*/
if (task_arg->timeout_wrapper.timeout_task_arg != NULL) {
task_arg->timeout_wrapper.timeout_task_arg->task_arg_wrapper = NULL;
task_arg->timeout_wrapper.timeout_task_arg = NULL;
}
aws_byte_buf_clean_up(&task_arg->payload_buf);
aws_string_destroy(task_arg->topic_string);
aws_mem_release(connection->allocator, task_arg);
}
uint16_t aws_mqtt_client_connection_publish(
struct aws_mqtt_client_connection *connection,
const struct aws_byte_cursor *topic,
enum aws_mqtt_qos qos,
bool retain,
const struct aws_byte_cursor *payload,
aws_mqtt_op_complete_fn *on_complete,
void *userdata) {
AWS_PRECONDITION(connection);
if (!aws_mqtt_is_valid_topic(topic)) {
aws_raise_error(AWS_ERROR_MQTT_INVALID_TOPIC);
return 0;
}
struct publish_task_arg *arg = aws_mem_calloc(connection->allocator, 1, sizeof(struct publish_task_arg));
if (!arg) {
return 0;
}
arg->connection = connection;
arg->topic_string = aws_string_new_from_array(connection->allocator, topic->ptr, topic->len);
arg->topic = aws_byte_cursor_from_string(arg->topic_string);
arg->qos = qos;
arg->retain = retain;
if (aws_byte_buf_init_copy_from_cursor(&arg->payload_buf, connection->allocator, *payload)) {
goto handle_error;
}
arg->payload = aws_byte_cursor_from_buf(&arg->payload_buf);
arg->on_complete = on_complete;
arg->userdata = userdata;
/* Calculate the size of the publish packet.
* The fixed header size is 2 bytes, the packet ID is 2 bytes,
* plus the size of both the topic name and payload */
uint64_t publish_packet_size = 4 + arg->topic.len + arg->payload.len;
bool retry = qos == AWS_MQTT_QOS_AT_MOST_ONCE;
uint16_t packet_id =
mqtt_create_request(connection, &s_publish_send, arg, &s_publish_complete, arg, retry, publish_packet_size);
if (packet_id == 0) {
/* bummer, we failed to make a new request */
AWS_LOGF_ERROR(
AWS_LS_MQTT_CLIENT,
"id=%p: Failed starting publish to topic " PRInSTR ",error %d (%s)",
(void *)connection,
AWS_BYTE_CURSOR_PRI(*topic),
aws_last_error(),
aws_error_name(aws_last_error()));
goto handle_error;
}
AWS_LOGF_DEBUG(
AWS_LS_MQTT_CLIENT,
"id=%p: Starting publish %" PRIu16 " to topic " PRInSTR,
(void *)connection,
packet_id,
AWS_BYTE_CURSOR_PRI(*topic));
return packet_id;
handle_error:
/* we know arg is valid, topic_string may or may not be valid */
if (arg->topic_string) {
aws_string_destroy(arg->topic_string);
}
aws_byte_buf_clean_up(&arg->payload_buf);
aws_mem_release(connection->allocator, arg);
return 0;
}
/*******************************************************************************
* Ping
******************************************************************************/
static void s_pingresp_received_timeout(struct aws_channel_task *channel_task, void *arg, enum aws_task_status status) {
struct aws_mqtt_client_connection *connection = arg;
if (status == AWS_TASK_STATUS_RUN_READY) {
/* Check that a pingresp has been received since pingreq was sent */
if (connection->thread_data.waiting_on_ping_response) {
connection->thread_data.waiting_on_ping_response = false;
/* It's been too long since the last ping, close the connection */
AWS_LOGF_ERROR(AWS_LS_MQTT_CLIENT, "id=%p: ping timeout detected", (void *)connection);
aws_channel_shutdown(connection->slot->channel, AWS_ERROR_MQTT_TIMEOUT);
}
}
aws_mem_release(connection->allocator, channel_task);
}
static enum aws_mqtt_client_request_state s_pingreq_send(uint16_t packet_id, bool is_first_attempt, void *userdata) {
(void)packet_id;
(void)is_first_attempt;
AWS_PRECONDITION(is_first_attempt);
struct aws_mqtt_client_connection *connection = userdata;
AWS_LOGF_TRACE(AWS_LS_MQTT_CLIENT, "id=%p: pingreq send", (void *)connection);
struct aws_mqtt_packet_connection pingreq;
aws_mqtt_packet_pingreq_init(&pingreq);
struct aws_io_message *message = mqtt_get_message_for_packet(connection, &pingreq.fixed_header);
if (!message) {
return AWS_MQTT_CLIENT_REQUEST_ERROR;
}
if (aws_mqtt_packet_connection_encode(&message->message_data, &pingreq)) {
aws_mem_release(message->allocator, message);
return AWS_MQTT_CLIENT_REQUEST_ERROR;
}
if (aws_channel_slot_send_message(connection->slot, message, AWS_CHANNEL_DIR_WRITE)) {
aws_mem_release(message->allocator, message);
return AWS_MQTT_CLIENT_REQUEST_ERROR;
}
/* Mark down that now is when the last pingreq was sent */
connection->thread_data.waiting_on_ping_response = true;
struct aws_channel_task *ping_timeout_task =
aws_mem_calloc(connection->allocator, 1, sizeof(struct aws_channel_task));
if (!ping_timeout_task) {
/* allocation failed, no log, just return error. */
goto error;
}
aws_channel_task_init(ping_timeout_task, s_pingresp_received_timeout, connection, "mqtt_pingresp_timeout");
uint64_t now = 0;
if (aws_channel_current_clock_time(connection->slot->channel, &now)) {
goto error;
}
now += connection->ping_timeout_ns;
aws_channel_schedule_task_future(connection->slot->channel, ping_timeout_task, now);
return AWS_MQTT_CLIENT_REQUEST_COMPLETE;
error:
return AWS_MQTT_CLIENT_REQUEST_ERROR;
}
int aws_mqtt_client_connection_ping(struct aws_mqtt_client_connection *connection) {
AWS_LOGF_DEBUG(AWS_LS_MQTT_CLIENT, "id=%p: Starting ping", (void *)connection);
uint16_t packet_id =
mqtt_create_request(connection, &s_pingreq_send, connection, NULL, NULL, true, /* noRetry */ 0);
AWS_LOGF_DEBUG(AWS_LS_MQTT_CLIENT, "id=%p: Starting ping with packet id %" PRIu16, (void *)connection, packet_id);
return (packet_id > 0) ? AWS_OP_SUCCESS : AWS_OP_ERR;
}
/*******************************************************************************
* Operation Statistics
******************************************************************************/
void aws_mqtt_connection_statistics_change_operation_statistic_state(
struct aws_mqtt_client_connection *connection,
struct aws_mqtt_request *request,
enum aws_mqtt_operation_statistic_state_flags new_state_flags) {
// Error checking
if (!connection) {
AWS_LOGF_ERROR(
AWS_LS_MQTT_CLIENT, "Invalid MQTT311 connection used when trying to change operation statistic state");
return;
}
if (!request) {
AWS_LOGF_ERROR(
AWS_LS_MQTT_CLIENT, "Invalid MQTT311 request used when trying to change operation statistic state");
return;
}
uint64_t packet_size = request->packet_size;
/**
* If the packet size is zero, then just skip it as we only want to track packets we have intentially
* calculated the size of and therefore it will be non-zero (zero packets will be ACKs, Pings, etc)
*/
if (packet_size <= 0) {
return;
}
enum aws_mqtt_operation_statistic_state_flags old_state_flags = request->statistic_state_flags;
if (new_state_flags == old_state_flags) {
return;
}
struct aws_mqtt_connection_operation_statistics_impl *stats = &connection->operation_statistics_impl;
if ((old_state_flags & AWS_MQTT_OSS_INCOMPLETE) != (new_state_flags & AWS_MQTT_OSS_INCOMPLETE)) {
if ((new_state_flags & AWS_MQTT_OSS_INCOMPLETE) != 0) {
aws_atomic_fetch_add(&stats->incomplete_operation_count_atomic, 1);
aws_atomic_fetch_add(&stats->incomplete_operation_size_atomic, (size_t)packet_size);
} else {
aws_atomic_fetch_sub(&stats->incomplete_operation_count_atomic, 1);
aws_atomic_fetch_sub(&stats->incomplete_operation_size_atomic, (size_t)packet_size);
}
}
if ((old_state_flags & AWS_MQTT_OSS_UNACKED) != (new_state_flags & AWS_MQTT_OSS_UNACKED)) {
if ((new_state_flags & AWS_MQTT_OSS_UNACKED) != 0) {
aws_atomic_fetch_add(&stats->unacked_operation_count_atomic, 1);
aws_atomic_fetch_add(&stats->unacked_operation_size_atomic, (size_t)packet_size);
} else {
aws_atomic_fetch_sub(&stats->unacked_operation_count_atomic, 1);
aws_atomic_fetch_sub(&stats->unacked_operation_size_atomic, (size_t)packet_size);
}
}
request->statistic_state_flags = new_state_flags;
// If the callback is defined, then call it
if (connection && connection->on_any_operation_statistics && connection->on_any_operation_statistics_ud) {
(*connection->on_any_operation_statistics)(connection, connection->on_any_operation_statistics_ud);
}
}
int aws_mqtt_client_connection_get_stats(
struct aws_mqtt_client_connection *connection,
struct aws_mqtt_connection_operation_statistics *stats) {
// Error checking
if (!connection) {
AWS_LOGF_ERROR(AWS_LS_MQTT_CLIENT, "Invalid MQTT311 connection used when trying to get operation statistics");
return aws_raise_error(AWS_ERROR_INVALID_ARGUMENT);
}
if (!stats) {
AWS_LOGF_ERROR(
AWS_LS_MQTT_CLIENT,
"id=%p: Invalid MQTT311 connection statistics struct used when trying to get operation statistics",
(void *)connection);
return aws_raise_error(AWS_ERROR_INVALID_ARGUMENT);
}
stats->incomplete_operation_count =
(uint64_t)aws_atomic_load_int(&connection->operation_statistics_impl.incomplete_operation_count_atomic);
stats->incomplete_operation_size =
(uint64_t)aws_atomic_load_int(&connection->operation_statistics_impl.incomplete_operation_size_atomic);
stats->unacked_operation_count =
(uint64_t)aws_atomic_load_int(&connection->operation_statistics_impl.unacked_operation_count_atomic);
stats->unacked_operation_size =
(uint64_t)aws_atomic_load_int(&connection->operation_statistics_impl.unacked_operation_size_atomic);
return AWS_OP_SUCCESS;
}
int aws_mqtt_client_connection_set_on_operation_statistics_handler(
struct aws_mqtt_client_connection *connection,
aws_mqtt_on_operation_statistics_fn *on_operation_statistics,
void *on_operation_statistics_ud) {
AWS_LOGF_TRACE(AWS_LS_MQTT_CLIENT, "id=%p: Setting on_operation_statistics handler", (void *)connection);
connection->on_any_operation_statistics = on_operation_statistics;
connection->on_any_operation_statistics_ud = on_operation_statistics_ud;
return AWS_OP_SUCCESS;
}
|