Outline ![]()
Files ![]()
loading (5/7)...
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
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
6946
6947
6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
7033
7034
7035
7036
7037
7038
7039
7040
7041
7042
7043
7044
7045
7046
7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
7074
7075
7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
7161
7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
7204
7205
7206
7207
7208
7209
7210
7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
7233
7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
7256
7257
7258
7259
7260
7261
7262
7263
7264
7265
7266
7267
7268
7269
7270
7271
7272
7273
7274
7275
7276
7277
7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
7332
7333
7334
7335
7336
7337
7338
7339
7340
7341
7342
7343
7344
7345
7346
7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
7425
7426
7427
7428
7429
7430
7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
7536
7537
7538
7539
7540
7541
7542
7543
7544
7545
7546
7547
7548
7549
7550
7551
7552
7553
7554
7555
7556
7557
7558
7559
7560
7561
7562
7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
7588
7589
7590
7591
7592
7593
7594
7595
7596
7597
7598
7599
7600
7601
7602
7603
7604
7605
7606
7607
7608
7609
7610
7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
7645
7646
7647
7648
7649
7650
7651
7652
7653
7654
7655
7656
7657
7658
7659
7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
7694
7695
7696
7697
7698
7699
7700
7701
7702
7703
7704
7705
7706
7707
7708
7709
7710
7711
7712
7713
7714
7715
7716
7717
7718
7719
7720
7721
7722
7723
7724
7725
7726
7727
7728
7729
7730
7731
7732
7733
7734
7735
7736
7737
7738
7739
7740
7741
7742
7743
7744
7745
7746
7747
7748
7749
7750
7751
7752
7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
7775
7776
7777
7778
7779
7780
7781
7782
7783
7784
7785
7786
7787
7788
7789
7790
7791
7792
7793
7794
7795
7796
7797
7798
7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
7828
7829
7830
7831
7832
7833
7834
7835
7836
7837
7838
7839
7840
7841
7842
7843
7844
7845
7846
7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
7858
7859
7860
7861
7862
7863
7864
7865
7866
7867
7868
7869
7870
7871
7872
7873
7874
7875
7876
7877
7878
7879
7880
7881
7882
7883
7884
7885
7886
7887
7888
7889
7890
7891
7892
7893
7894
7895
7896
7897
7898
7899
7900
7901
7902
7903
7904
7905
7906
7907
7908
7909
7910
7911
7912
7913
7914
7915
7916
7917
7918
7919
7920
7921
7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
7966
7967
7968
7969
7970
7971
7972
7973
7974
7975
7976
7977
7978
7979
7980
7981
7982
7983
7984
7985
7986
7987
7988
7989
7990
7991
7992
7993
7994
7995
7996
7997
7998
7999
8000
8001
8002
8003
8004
8005
8006
8007
8008
8009
8010
8011
8012
8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
8024
8025
8026
8027
8028
8029
8030
8031
8032
8033
8034
8035
8036
8037
8038
8039
8040
8041
8042
8043
8044
8045
8046
8047
8048
8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
8077
8078
8079
8080
8081
8082
8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
8098
8099
8100
8101
8102
8103
8104
8105
8106
8107
8108
8109
8110
8111
8112
8113
8114
8115
8116
8117
8118
8119
8120
8121
8122
8123
8124
8125
8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
8137
8138
8139
8140
8141
8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
8161
8162
8163
8164
8165
8166
8167
8168
8169
8170
8171
8172
8173
8174
8175
8176
8177
8178
8179
8180
8181
8182
8183
8184
8185
8186
8187
8188
8189
8190
8191
8192
8193
8194
8195
8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
8213
8214
8215
8216
8217
8218
8219
8220
8221
8222
8223
8224
8225
8226
8227
8228
8229
8230
8231
8232
8233
8234
8235
8236
8237
8238
8239
8240
8241
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
8260
8261
8262
8263
8264
8265
8266
8267
8268
8269
8270
8271
8272
8273
8274
8275
8276
8277
8278
8279
8280
8281
8282
8283
8284
8285
8286
8287
8288
8289
8290
8291
8292
8293
8294
8295
8296
8297
8298
8299
8300
8301
8302
8303
8304
8305
8306
8307
8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
8319
8320
8321
8322
8323
8324
8325
8326
8327
8328
8329
8330
8331
8332
8333
8334
8335
8336
8337
8338
8339
8340
8341
8342
8343
8344
8345
8346
8347
8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
8371
8372
8373
8374
8375
8376
8377
8378
8379
8380
8381
8382
8383
8384
8385
8386
8387
8388
8389
8390
8391
8392
8393
8394
8395
8396
8397
8398
8399
8400
8401
8402
8403
8404
8405
8406
8407
8408
8409
8410
8411
8412
8413
8414
8415
8416
8417
8418
8419
8420
8421
8422
8423
8424
8425
8426
8427
8428
8429
8430
8431
8432
8433
8434
8435
8436
8437
8438
8439
8440
8441
8442
8443
8444
8445
8446
8447
8448
8449
8450
8451
8452
8453
8454
8455
8456
8457
8458
8459
8460
8461
8462
8463
8464
8465
8466
8467
8468
8469
8470
8471
8472
8473
8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
8484
8485
8486
8487
8488
8489
8490
8491
8492
8493
8494
8495
8496
8497
8498
8499
8500
8501
8502
8503
8504
8505
8506
8507
8508
8509
8510
8511
8512
8513
8514
8515
8516
8517
8518
8519
8520
8521
8522
8523
8524
8525
8526
8527
8528
8529
8530
8531
8532
8533
8534
8535
8536
8537
8538
8539
8540
8541
8542
8543
8544
8545
8546
8547
8548
8549
8550
8551
8552
8553
8554
8555
8556
8557
8558
8559
8560
8561
8562
8563
8564
8565
8566
8567
8568
8569
8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
8605
8606
8607
8608
8609
8610
8611
8612
8613
8614
8615
8616
8617
8618
8619
8620
8621
8622
8623
8624
8625
8626
8627
8628
8629
8630
8631
8632
8633
8634
8635
8636
8637
8638
8639
8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
8650
8651
8652
8653
8654
8655
8656
8657
8658
8659
8660
8661
8662
8663
8664
8665
8666
8667
8668
8669
8670
8671
8672
8673
8674
8675
8676
8677
8678
8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
8692
8693
8694
8695
8696
8697
8698
8699
8700
8701
8702
8703
8704
8705
8706
8707
8708
8709
8710
8711
8712
8713
8714
8715
8716
8717
8718
8719
8720
8721
8722
8723
8724
8725
8726
8727
8728
8729
8730
8731
8732
8733
8734
8735
8736
8737
8738
8739
8740
8741
8742
8743
8744
8745
8746
8747
8748
8749
8750
8751
8752
8753
8754
8755
8756
8757
8758
8759
8760
8761
8762
8763
8764
8765
8766
8767
8768
8769
8770
8771
8772
8773
8774
8775
8776
8777
8778
8779
8780
8781
8782
8783
8784
8785
8786
8787
8788
8789
8790
8791
8792
8793
8794
8795
8796
8797
8798
8799
8800
8801
8802
8803
8804
8805
8806
8807
8808
8809
8810
8811
8812
8813
8814
8815
8816
8817
8818
8819
8820
8821
8822
8823
8824
8825
8826
8827
8828
8829
8830
8831
8832
8833
8834
8835
8836
8837
8838
8839
8840
8841
8842
8843
8844
8845
8846
8847
8848
8849
8850
8851
8852
8853
8854
8855
8856
8857
8858
8859
8860
8861
8862
8863
8864
8865
8866
8867
8868
8869
8870
8871
8872
8873
8874
8875
8876
8877
8878
8879
8880
8881
8882
8883
8884
8885
8886
8887
8888
8889
8890
8891
8892
8893
8894
8895
8896
8897
8898
8899
8900
8901
8902
8903
8904
8905
8906
8907
8908
8909
8910
8911
8912
8913
8914
8915
8916
8917
8918
8919
8920
8921
8922
8923
8924
8925
8926
8927
8928
8929
8930
8931
8932
8933
8934
8935
8936
8937
8938
8939
8940
8941
8942
8943
8944
8945
8946
8947
8948
8949
8950
8951
8952
8953
8954
8955
8956
8957
8958
8959
8960
8961
8962
8963
8964
8965
8966
8967
8968
8969
8970
8971
8972
8973
8974
8975
8976
8977
8978
8979
8980
8981
8982
8983
8984
8985
8986
8987
8988
8989
8990
8991
8992
8993
8994
8995
8996
8997
8998
8999
9000
9001
9002
9003
9004
9005
9006
9007
9008
9009
9010
9011
9012
9013
9014
9015
9016
9017
9018
9019
9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
9034
9035
9036
9037
9038
9039
9040
9041
9042
9043
9044
9045
9046
9047
9048
9049
9050
9051
9052
9053
9054
9055
9056
9057
9058
9059
9060
9061
9062
9063
9064
9065
9066
9067
9068
9069
9070
9071
9072
9073
9074
9075
9076
9077
9078
9079
9080
9081
9082
9083
9084
9085
9086
9087
9088
9089
9090
9091
9092
9093
9094
9095
9096
9097
9098
9099
9100
9101
9102
9103
9104
9105
9106
9107
9108
9109
9110
9111
9112
9113
9114
9115
9116
9117
9118
9119
9120
9121
9122
9123
9124
9125
9126
9127
9128
9129
9130
9131
9132
9133
9134
9135
9136
9137
9138
9139
9140
9141
9142
9143
9144
9145
9146
9147
9148
9149
9150
9151
9152
9153
9154
9155
9156
9157
9158
9159
9160
9161
9162
9163
9164
9165
9166
9167
9168
9169
9170
9171
9172
9173
9174
9175
9176
9177
9178
9179
9180
9181
9182
9183
9184
9185
9186
9187
9188
9189
9190
9191
9192
9193
9194
9195
9196
9197
9198
9199
9200
9201
9202
9203
9204
9205
9206
9207
9208
9209
9210
9211
9212
9213
9214
9215
9216
9217
9218
9219
9220
9221
9222
9223
9224
9225
9226
9227
9228
9229
9230
9231
9232
9233
9234
9235
9236
9237
9238
9239
9240
9241
9242
9243
9244
9245
9246
9247
9248
9249
9250
9251
9252
9253
9254
9255
9256
9257
9258
9259
9260
9261
9262
9263
9264
9265
9266
9267
9268
9269
9270
9271
9272
9273
9274
9275
9276
9277
9278
9279
9280
9281
9282
9283
9284
9285
9286
9287
9288
9289
9290
9291
9292
9293
9294
9295
9296
9297
9298
9299
9300
9301
9302
9303
9304
9305
9306
9307
9308
9309
9310
9311
9312
9313
9314
9315
9316
9317
9318
9319
9320
9321
9322
9323
9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
9371
9372
9373
9374
9375
9376
9377
9378
9379
9380
9381
9382
9383
9384
9385
9386
9387
9388
9389
9390
9391
9392
9393
9394
9395
9396
9397
9398
9399
9400
9401
9402
9403
9404
9405
9406
9407
9408
9409
9410
9411
9412
9413
9414
9415
9416
9417
9418
9419
9420
9421
9422
9423
9424
9425
9426
9427
9428
9429
9430
9431
9432
9433
9434
9435
9436
9437
9438
9439
9440
9441
9442
9443
9444
9445
9446
9447
9448
9449
9450
9451
9452
9453
9454
9455
9456
9457
9458
9459
9460
9461
9462
9463
9464
9465
9466
9467
9468
9469
9470
9471
9472
9473
9474
9475
9476
9477
9478
9479
9480
9481
9482
9483
9484
9485
9486
9487
9488
9489
9490
9491
9492
9493
9494
9495
9496
9497
9498
9499
9500
9501
9502
9503
9504
9505
9506
9507
9508
9509
9510
9511
9512
9513
9514
9515
9516
9517
9518
9519
9520
9521
9522
9523
9524
9525
9526
9527
9528
9529
9530
9531
9532
9533
9534
9535
9536
9537
9538
9539
9540
9541
9542
9543
9544
9545
9546
9547
9548
9549
9550
9551
9552
9553
9554
9555
9556
9557
9558
9559
9560
9561
9562
9563
9564
9565
9566
9567
9568
9569
9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
9580
9581
9582
9583
9584
9585
9586
9587
9588
9589
9590
9591
9592
9593
9594
9595
9596
9597
9598
9599
9600
9601
9602
9603
9604
9605
9606
9607
9608
9609
9610
9611
9612
9613
9614
9615
9616
9617
9618
9619
9620
9621
9622
9623
9624
9625
9626
9627
9628
9629
9630
9631
9632
9633
9634
9635
9636
9637
9638
9639
9640
9641
9642
9643
9644
9645
9646
9647
9648
9649
9650
9651
9652
9653
9654
9655
9656
9657
9658
9659
9660
9661
9662
9663
9664
9665
9666
9667
9668
9669
9670
9671
9672
9673
9674
9675
9676
9677
9678
9679
9680
9681
9682
9683
9684
9685
9686
9687
9688
9689
9690
9691
9692
9693
9694
9695
9696
9697
9698
9699
9700
9701
9702
9703
9704
9705
9706
9707
9708
9709
9710
9711
9712
9713
9714
9715
9716
9717
9718
9719
9720
9721
9722
9723
9724
9725
9726
9727
9728
9729
9730
9731
9732
9733
9734
9735
9736
9737
9738
9739
9740
9741
9742
9743
9744
9745
9746
9747
9748
9749
9750
9751
9752
9753
9754
9755
9756
9757
9758
9759
9760
9761
9762
9763
9764
9765
9766
9767
9768
9769
9770
9771
9772
9773
9774
9775
9776
9777
9778
9779
9780
9781
9782
9783
9784
9785
9786
9787
9788
9789
9790
9791
9792
9793
9794
9795
9796
9797
9798
9799
9800
9801
9802
9803
9804
9805
9806
9807
9808
9809
9810
9811
9812
9813
9814
9815
9816
9817
9818
9819
9820
9821
9822
9823
9824
9825
9826
9827
9828
9829
9830
9831
9832
9833
9834
9835
9836
9837
9838
9839
9840
9841
9842
9843
9844
9845
9846
9847
9848
9849
9850
9851
9852
9853
9854
9855
9856
9857
9858
9859
9860
9861
9862
9863
9864
9865
9866
9867
9868
9869
9870
9871
9872
9873
9874
9875
9876
9877
9878
9879
9880
9881
9882
9883
9884
9885
9886
9887
9888
9889
9890
9891
9892
9893
9894
9895
9896
9897
9898
9899
9900
9901
9902
9903
9904
9905
9906
9907
9908
9909
9910
9911
9912
9913
9914
9915
9916
9917
9918
9919
9920
9921
9922
9923
9924
9925
9926
9927
9928
9929
9930
9931
9932
9933
9934
9935
9936
9937
9938
9939
9940
9941
9942
9943
9944
9945
9946
9947
9948
9949
9950
9951
9952
9953
9954
9955
9956
9957
9958
9959
9960
9961
9962
9963
9964
9965
9966
9967
9968
9969
9970
9971
9972
9973
9974
9975
9976
9977
9978
9979
9980
9981
9982
9983
9984
9985
9986
9987
9988
9989
9990
9991
9992
9993
9994
9995
9996
9997
9998
9999
10000
10001
10002
10003
10004
10005
10006
10007
10008
10009
10010
10011
10012
10013
10014
10015
10016
10017
10018
10019
10020
10021
10022
10023
10024
10025
10026
10027
10028
10029
10030
10031
10032
10033
10034
10035
10036
10037
10038
10039
10040
10041
10042
10043
10044
10045
10046
10047
10048
10049
10050
10051
10052
10053
10054
10055
10056
10057
10058
10059
10060
10061
10062
10063
10064
10065
10066
10067
10068
10069
10070
10071
10072
10073
10074
10075
10076
10077
10078
10079
10080
10081
10082
10083
10084
10085
10086
10087
10088
10089
10090
10091
10092
10093
10094
10095
10096
10097
10098
10099
10100
10101
10102
10103
10104
10105
10106
10107
10108
10109
10110
10111
10112
10113
10114
10115
10116
10117
10118
10119
10120
10121
10122
10123
10124
10125
10126
10127
10128
10129
10130
10131
10132
10133
10134
10135
10136
10137
10138
10139
10140
10141
10142
10143
10144
10145
10146
10147
10148
10149
10150
10151
10152
10153
10154
10155
10156
10157
10158
10159
10160
10161
10162
10163
10164
10165
10166
10167
10168
10169
10170
10171
10172
10173
10174
10175
10176
10177
10178
10179
10180
10181
10182
10183
10184
10185
10186
10187
10188
10189
10190
10191
10192
10193
10194
10195
10196
10197
10198
10199
10200
10201
10202
10203
10204
10205
10206
10207
10208
10209
10210
10211
10212
10213
10214
10215
10216
10217
10218
10219
10220
10221
10222
10223
10224
10225
10226
10227
10228
10229
10230
10231
10232
10233
10234
10235
10236
10237
10238
10239
10240
10241
10242
10243
10244
10245
10246
10247
10248
10249
10250
10251
10252
10253
10254
10255
10256
10257
10258
10259
10260
10261
10262
10263
10264
10265
10266
10267
10268
10269
10270
10271
10272
10273
10274
10275
10276
10277
10278
10279
10280
10281
10282
10283
10284
10285
10286
10287
10288
10289
10290
10291
10292
10293
10294
10295
10296
10297
10298
10299
10300
10301
10302
10303
10304
10305
10306
10307
10308
10309
10310
10311
10312
10313
10314
10315
10316
10317
10318
10319
10320
10321
10322
10323
10324
10325
10326
10327
10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
10338
10339
10340
10341
10342
10343
10344
10345
10346
10347
10348
10349
10350
10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
10364
10365
10366
10367
10368
10369
10370
10371
10372
10373
10374
10375
10376
10377
10378
10379
10380
10381
10382
10383
10384
10385
10386
10387
10388
10389
10390
10391
10392
10393
10394
10395
10396
10397
10398
10399
10400
10401
10402
10403
10404
10405
10406
10407
10408
10409
10410
10411
10412
10413
10414
10415
10416
10417
10418
10419
10420
10421
10422
10423
10424
10425
10426
10427
10428
10429
10430
10431
10432
10433
10434
10435
10436
10437
10438
10439
10440
10441
10442
10443
10444
10445
10446
10447
10448
10449
10450
10451
10452
10453
10454
10455
10456
10457
10458
10459
10460
10461
10462
10463
10464
10465
10466
10467
10468
10469
10470
10471
10472
10473
10474
10475
10476
10477
10478
10479
10480
10481
10482
10483
10484
10485
10486
10487
10488
10489
10490
10491
10492
10493
10494
10495
10496
10497
10498
10499
10500
10501
10502
10503
10504
10505
10506
10507
10508
10509
10510
10511
10512
10513
10514
10515
10516
10517
10518
10519
10520
10521
10522
10523
10524
10525
10526
10527
10528
10529
10530
10531
10532
10533
10534
10535
10536
10537
10538
10539
10540
10541
10542
10543
10544
10545
10546
10547
10548
10549
10550
10551
10552
10553
10554
10555
10556
10557
10558
10559
10560
10561
10562
10563
10564
10565
10566
10567
10568
10569
10570
10571
10572
10573
10574
10575
10576
10577
10578
10579
10580
10581
10582
10583
10584
10585
10586
10587
10588
10589
10590
10591
10592
10593
10594
10595
10596
10597
10598
10599
10600
10601
10602
10603
10604
10605
10606
10607
10608
10609
10610
10611
10612
10613
10614
10615
10616
10617
10618
10619
10620
10621
10622
10623
10624
10625
10626
10627
10628
10629
10630
10631
10632
10633
10634
10635
10636
10637
10638
10639
10640
10641
10642
10643
10644
10645
10646
10647
10648
10649
10650
10651
10652
10653
10654
10655
10656
10657
10658
10659
10660
10661
10662
10663
10664
10665
10666
10667
10668
10669
10670
10671
10672
10673
10674
10675
10676
10677
10678
10679
10680
10681
10682
10683
10684
10685
10686
10687
10688
10689
10690
10691
10692
10693
10694
10695
10696
10697
10698
10699
10700
10701
10702
10703
10704
10705
10706
10707
10708
10709
10710
10711
10712
10713
10714
10715
10716
10717
10718
10719
10720
10721
10722
10723
10724
10725
10726
10727
10728
10729
10730
10731
10732
10733
10734
10735
10736
10737
10738
10739
10740
10741
10742
10743
10744
10745
10746
10747
10748
10749
10750
10751
10752
10753
10754
10755
10756
10757
10758
10759
10760
10761
10762
10763
10764
10765
10766
10767
10768
10769
10770
10771
10772
10773
10774
10775
10776
10777
10778
10779
10780
10781
10782
10783
10784
10785
10786
10787
10788
10789
10790
10791
10792
10793
10794
10795
10796
10797
10798
10799
10800
10801
10802
10803
10804
10805
10806
10807
10808
10809
10810
10811
10812
10813
10814
10815
10816
10817
10818
10819
10820
10821
10822
10823
10824
10825
10826
10827
10828
10829
10830
10831
10832
10833
10834
10835
10836
10837
10838
10839
10840
10841
10842
10843
10844
10845
10846
10847
10848
10849
10850
10851
10852
10853
10854
10855
10856
10857
10858
10859
10860
10861
10862
10863
10864
10865
10866
10867
10868
10869
10870
10871
10872
10873
10874
10875
10876
10877
10878
10879
10880
10881
10882
10883
10884
10885
10886
10887
10888
10889
10890
10891
10892
10893
10894
10895
10896
10897
10898
10899
10900
10901
10902
10903
10904
10905
10906
10907
10908
10909
10910
10911
10912
10913
10914
10915
10916
10917
10918
10919
10920
10921
10922
10923
10924
10925
10926
10927
10928
10929
10930
10931
10932
10933
10934
10935
10936
10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
10988
10989
10990
10991
10992
10993
10994
10995
10996
10997
10998
10999
11000
11001
11002
11003
11004
11005
11006
11007
11008
11009
11010
11011
11012
11013
11014
11015
11016
11017
11018
11019
11020
11021
11022
11023
11024
11025
11026
11027
11028
11029
11030
11031
11032
11033
11034
11035
11036
11037
11038
11039
11040
11041
11042
11043
11044
11045
11046
11047
11048
11049
11050
11051
11052
11053
11054
11055
11056
11057
11058
11059
11060
11061
11062
11063
11064
11065
11066
11067
11068
11069
11070
11071
11072
11073
11074
11075
11076
11077
11078
11079
11080
11081
11082
11083
11084
11085
11086
11087
11088
11089
11090
11091
11092
11093
11094
11095
11096
11097
11098
11099
11100
11101
11102
11103
11104
11105
11106
11107
11108
11109
11110
11111
11112
11113
11114
11115
11116
11117
11118
11119
11120
11121
11122
11123
11124
11125
11126
11127
11128
11129
11130
11131
11132
11133
11134
11135
11136
11137
11138
11139
11140
11141
11142
11143
11144
11145
11146
11147
11148
11149
11150
11151
11152
11153
11154
11155
11156
11157
11158
11159
11160
11161
11162
11163
11164
11165
11166
11167
11168
11169
11170
11171
11172
11173
11174
11175
11176
11177
11178
11179
11180
11181
11182
11183
11184
11185
11186
11187
11188
11189
11190
11191
11192
11193
11194
11195
11196
11197
11198
11199
11200
11201
11202
11203
11204
11205
11206
11207
11208
11209
11210
11211
11212
11213
11214
11215
11216
11217
11218
11219
11220
11221
11222
11223
11224
11225
11226
11227
11228
11229
11230
11231
11232
11233
11234
11235
11236
11237
11238
11239
11240
11241
11242
11243
11244
11245
11246
11247
11248
11249
11250
11251
11252
11253
11254
11255
11256
11257
11258
11259
11260
11261
11262
11263
11264
11265
11266
11267
11268
11269
11270
11271
11272
11273
11274
11275
11276
11277
11278
11279
11280
11281
11282
11283
11284
11285
11286
11287
11288
11289
11290
11291
11292
11293
11294
11295
11296
11297
11298
11299
11300
11301
11302
11303
11304
11305
11306
11307
11308
11309
11310
11311
11312
11313
11314
11315
11316
11317
11318
11319
11320
11321
11322
11323
11324
11325
11326
11327
11328
11329
11330
11331
11332
11333
11334
11335
11336
11337
11338
11339
11340
11341
11342
11343
11344
11345
11346
11347
11348
11349
11350
11351
11352
11353
11354
11355
11356
11357
11358
11359
11360
11361
11362
11363
11364
11365
11366
11367
11368
11369
11370
11371
11372
11373
11374
11375
11376
11377
11378
11379
11380
11381
11382
11383
11384
11385
11386
11387
11388
11389
11390
11391
11392
11393
11394
11395
11396
11397
11398
11399
11400
11401
11402
11403
11404
11405
11406
11407
11408
11409
11410
11411
11412
11413
11414
11415
11416
11417
11418
11419
11420
11421
11422
11423
11424
11425
11426
11427
11428
11429
11430
11431
11432
11433
11434
11435
11436
11437
11438
11439
11440
11441
11442
11443
11444
11445
11446
11447
11448
11449
11450
11451
11452
11453
11454
11455
11456
11457
11458
11459
11460
11461
11462
11463
11464
11465
11466
11467
11468
11469
11470
11471
11472
11473
11474
11475
11476
11477
11478
11479
11480
11481
11482
11483
11484
11485
11486
11487
11488
11489
11490
11491
11492
11493
11494
11495
11496
11497
11498
11499
11500
11501
11502
11503
11504
11505
11506
11507
11508
11509
11510
11511
11512
11513
11514
11515
11516
11517
11518
11519
11520
11521
11522
11523
11524
11525
11526
11527
11528
11529
11530
11531
11532
11533
11534
11535
11536
11537
11538
11539
11540
11541
11542
11543
11544
11545
11546
11547
11548
11549
11550
11551
11552
11553
11554
11555
11556
11557
11558
11559
11560
11561
11562
11563
11564
11565
11566
11567
11568
11569
11570
11571
11572
11573
11574
11575
11576
11577
11578
11579
11580
11581
11582
11583
11584
11585
11586
11587
11588
11589
11590
11591
11592
11593
11594
11595
11596
11597
11598
11599
11600
11601
11602
11603
11604
11605
11606
11607
11608
11609
11610
11611
11612
11613
11614
11615
11616
11617
11618
11619
11620
11621
11622
11623
11624
11625
11626
11627
11628
11629
11630
11631
11632
11633
11634
11635
11636
11637
11638
11639
11640
11641
11642
11643
11644
11645
11646
11647
11648
11649
11650
11651
11652
11653
11654
11655
11656
11657
11658
11659
11660
11661
11662
11663
11664
11665
11666
11667
11668
11669
11670
11671
11672
11673
11674
11675
11676
11677
11678
11679
11680
11681
11682
11683
11684
11685
11686
11687
11688
11689
11690
11691
11692
11693
11694
11695
11696
11697
11698
11699
11700
11701
11702
11703
11704
11705
11706
11707
11708
11709
11710
11711
11712
11713
11714
11715
11716
11717
11718
11719
11720
11721
11722
11723
11724
11725
11726
11727
11728
11729
11730
11731
11732
11733
11734
11735
11736
11737
11738
11739
11740
11741
11742
11743
11744
11745
11746
11747
11748
11749
11750
11751
11752
11753
11754
11755
11756
11757
11758
11759
11760
11761
11762
11763
11764
11765
11766
11767
11768
11769
11770
11771
11772
11773
11774
11775
11776
11777
11778
11779
11780
11781
11782
11783
11784
11785
11786
11787
11788
11789
11790
11791
11792
11793
11794
11795
11796
11797
11798
11799
11800
11801
11802
11803
11804
11805
11806
11807
11808
11809
11810
11811
11812
11813
11814
11815
11816
11817
11818
11819
11820
11821
11822
11823
11824
11825
11826
11827
11828
11829
11830
11831
11832
11833
11834
11835
11836
11837
11838
11839
11840
11841
11842
11843
11844
11845
11846
11847
11848
11849
11850
11851
11852
11853
11854
11855
11856
11857
11858
11859
11860
11861
11862
11863
11864
11865
11866
11867
11868
11869
11870
11871
11872
11873
11874
11875
11876
11877
11878
11879
11880
11881
11882
11883
11884
11885
11886
11887
11888
11889
11890
11891
11892
11893
11894
11895
11896
11897
11898
11899
11900
11901
11902
11903
11904
11905
11906
11907
11908
11909
11910
11911
11912
11913
11914
11915
11916
11917
11918
11919
11920
11921
11922
11923
11924
11925
11926
11927
11928
11929
11930
11931
11932
11933
11934
11935
11936
11937
11938
11939
11940
11941
11942
11943
11944
11945
11946
11947
11948
11949
11950
11951
11952
11953
11954
11955
11956
11957
11958
11959
11960
11961
11962
11963
11964
11965
11966
11967
11968
11969
11970
11971
11972
11973
11974
11975
11976
11977
11978
11979
11980
11981
11982
11983
11984
11985
11986
11987
11988
11989
11990
11991
11992
11993
11994
11995
11996
11997
11998
11999
12000
12001
12002
12003
12004
12005
12006
12007
12008
12009
12010
12011
12012
12013
12014
12015
12016
12017
12018
12019
12020
12021
12022
12023
12024
12025
12026
12027
12028
12029
12030
12031
12032
12033
12034
12035
12036
12037
12038
12039
12040
12041
12042
12043
12044
12045
12046
12047
12048
12049
12050
12051
12052
12053
12054
12055
12056
12057
12058
12059
12060
12061
12062
12063
12064
12065
12066
12067
12068
12069
12070
12071
12072
12073
12074
12075
12076
12077
12078
12079
12080
12081
12082
12083
12084
12085
12086
12087
12088
12089
12090
12091
12092
12093
12094
12095
12096
12097
12098
12099
12100
12101
12102
12103
12104
12105
12106
12107
12108
12109
12110
12111
12112
12113
12114
12115
12116
12117
12118
12119
12120
12121
12122
12123
12124
12125
12126
12127
12128
12129
12130
12131
12132
12133
12134
12135
12136
12137
12138
12139
12140
12141
12142
12143
12144
12145
12146
12147
12148
12149
12150
12151
12152
12153
12154
12155
12156
12157
12158
12159
12160
12161
12162
12163
12164
12165
12166
12167
12168
12169
12170
12171
12172
12173
12174
12175
12176
12177
12178
12179
12180
12181
12182
12183
12184
12185
12186
12187
12188
12189
12190
12191
12192
12193
12194
12195
12196
12197
12198
12199
12200
12201
12202
12203
12204
12205
12206
12207
12208
12209
12210
12211
12212
12213
12214
12215
12216
12217
12218
12219
12220
12221
12222
12223
12224
12225
12226
12227
12228
12229
12230
12231
12232
12233
12234
12235
12236
12237
12238
12239
12240
12241
12242
12243
12244
12245
12246
12247
12248
12249
12250
12251
12252
12253
12254
12255
12256
12257
12258
12259
12260
12261
12262
12263
12264
12265
12266
12267
12268
12269
12270
12271
12272
12273
12274
12275
12276
12277
12278
12279
12280
12281
12282
12283
12284
12285
12286
12287
12288
12289
12290
12291
12292
12293
12294
12295
12296
12297
12298
12299
12300
12301
12302
12303
12304
12305
12306
12307
12308
12309
12310
12311
12312
12313
12314
12315
12316
12317
12318
12319
12320
12321
12322
12323
12324
12325
12326
12327
12328
12329
12330
12331
12332
12333
12334
12335
12336
12337
12338
12339
12340
12341
12342
12343
12344
12345
12346
12347
12348
12349
12350
12351
12352
12353
12354
12355
12356
12357
12358
12359
12360
12361
12362
12363
12364
12365
12366
12367
12368
12369
12370
12371
12372
12373
12374
12375
12376
12377
12378
12379
12380
12381
12382
12383
12384
12385
12386
12387
12388
12389
12390
12391
12392
12393
12394
12395
12396
12397
12398
12399
12400
12401
12402
12403
12404
12405
12406
12407
12408
12409
12410
12411
12412
12413
12414
12415
12416
12417
12418
12419
12420
12421
12422
12423
12424
12425
12426
12427
12428
12429
12430
12431
12432
12433
12434
12435
12436
12437
12438
12439
12440
12441
12442
12443
12444
12445
12446
12447
12448
12449
12450
12451
12452
12453
12454
12455
12456
12457
12458
12459
12460
12461
12462
12463
12464
12465
12466
12467
12468
12469
12470
12471
12472
12473
12474
12475
12476
12477
12478
12479
12480
12481
12482
12483
12484
12485
12486
12487
12488
12489
12490
12491
12492
12493
12494
12495
12496
12497
12498
12499
12500
12501
12502
12503
12504
12505
12506
12507
12508
12509
12510
12511
12512
12513
12514
12515
12516
12517
12518
12519
12520
12521
12522
12523
12524
12525
12526
12527
12528
12529
12530
12531
12532
12533
12534
12535
12536
12537
12538
12539
12540
12541
12542
12543
12544
12545
12546
12547
12548
12549
12550
12551
12552
12553
/**************************************************************************/
/* */
/* Copyright (c) Microsoft Corporation. All rights reserved. */
/* */
/* This software is licensed under the Microsoft Software License */
/* Terms for Microsoft Azure RTOS. Full text of the license can be */
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */
/* and in the root directory of this software. */
/* */
/**************************************************************************/
/**************************************************************************/
/**************************************************************************/
/** */
/** NetX Component */
/** */
/** Dynamic Host Configuration Protocol over IPv6 (DHCPv6 Client) */
/** */
/**************************************************************************/
/**************************************************************************/
#define NX_DHCPV6_SOURCE_CODE
/* Force error checking to be disabled in this module */
#ifndef NX_DISABLE_ERROR_CHECKING
#define NX_DISABLE_ERROR_CHECKING
#endif
/* Include necessary system files. */
#include <stdio.h>
#include "nx_api.h"
#include "nx_system.h"
#include "nx_ip.h"
#include "nx_ipv6.h"
#include "nx_udp.h"
#include "nxd_dhcpv6_client.h"
#include "tx_timer.h"
#ifdef FEATURE_NX_IPV6
/* Bring in externs for caller checking code. */
NX_CALLER_CHECKING_EXTERNS
/* Define the address of All DHCP Relay Agents and Servers as per RFC3315. */
static NXD_ADDRESS All_DHCPv6_Relay_Servers_Address;
/* Keep the DHCPv6 instance for DAD callback notify. */
static NX_DHCPV6 *_nx_dhcpv6_DAD_ptr;
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_add_client_duid PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function adds the client DUID to the Client request packet */
/* based on the Client DUID on record, checking to make sure it does */
/* not go past the end of the packet payload. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPV6 Client instance */
/* received_buffer Pointer to server reply */
/* length Size of server reply buffer */
/* */
/* OUTPUT */
/* */
/* NX_SUCCESS Successful completion status */
/* NX_DHCPV6_INSUFFICIENT_PACKET_PAYLOAD */
/* Not enough room for the Client */
/* DUID in the packet payload */
/* CALLS */
/* */
/* memset Clears specified area of memory */
/* memcpy Copies specified area of memory */
/* */
/* CALLED BY */
/* */
/* _nx_dhcpv6_send_request Compiles and sends the Client */
/* DHCPv6 request */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), and */
/* verified memcpy use cases, */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_add_client_duid(NX_DHCPV6 *dhcpv6_ptr, UCHAR *buffer_ptr, UINT *index)
{
ULONG message_word;
ULONG available_payload;
UCHAR mac[8];
UINT i = 0;
/* Compute the available payload in the packet buffer. */
available_payload = dhcpv6_ptr -> nx_dhcpv6_pool_ptr -> nx_packet_pool_payload_size -
(ULONG)sizeof(NX_IPV6_HEADER) - (ULONG)sizeof(NX_UDP_HEADER) - *index;
/* Check if the largest possible client DUID will fit in the packet buffer. */
if ((available_payload - 4) < ((ULONG)(dhcpv6_ptr -> nx_dhcpv6_client_duid.nx_option_length)))
{
/* Hmmm... not enough! Can't do it. */
return NX_DHCPV6_INSUFFICIENT_PACKET_PAYLOAD;
}
/* Build the header from the client DUID. */
message_word = (((ULONG)(dhcpv6_ptr -> nx_dhcpv6_client_duid.nx_op_code)) << 16);
message_word |= (dhcpv6_ptr -> nx_dhcpv6_client_duid.nx_option_length);
/* Adjust for endianness. */
NX_CHANGE_ULONG_ENDIAN(message_word);
/* Copy first half of the Client DUID option to packet buffer. */
memcpy((buffer_ptr + (*index)), &message_word, sizeof(UINT)); /* Use case of memcpy is verified. */
(*index) += (ULONG)sizeof(UINT);
/* Build the DUID type and hardware type. */
message_word = (((ULONG)(dhcpv6_ptr -> nx_dhcpv6_client_duid.nx_duid_type)) << 16);
message_word |= dhcpv6_ptr -> nx_dhcpv6_client_duid.nx_hardware_type;
/* Adjust for endianness. */
NX_CHANGE_ULONG_ENDIAN(message_word);
/* Set up the DUID type and hardware type. */
memcpy((buffer_ptr + (*index)), &message_word, sizeof(UINT)); /* Use case of memcpy is verified. */
(*index) += (ULONG)sizeof(UINT);
/* Include the 'time' field if this is a Link layer time DUID type. */
if (dhcpv6_ptr -> nx_dhcpv6_client_duid.nx_duid_type == NX_DHCPV6_DUID_TYPE_LINK_TIME)
{
/* Build the time. */
message_word = dhcpv6_ptr -> nx_dhcpv6_client_duid.nx_duid_time;
/* Adjust for endianness. */
NX_CHANGE_ULONG_ENDIAN(message_word);
/* Set up the time. */
memcpy((buffer_ptr + (*index)), &message_word, sizeof(ULONG)); /* Use case of memcpy is verified. */
(*index) += (ULONG)sizeof(ULONG);
}
/* Build the link layer address. */
if (dhcpv6_ptr -> nx_dhcpv6_client_duid.nx_hardware_type == NX_DHCPV6_CLIENT_HARDWARE_TYPE_ETHERNET)
{
/* The length of link layer address is 48 bit. */
/* Build the MSW. */
mac[i++] = (UCHAR)(dhcpv6_ptr -> nx_dhcpv6_client_duid.nx_link_layer_address_msw >> 8);
mac[i++] = (UCHAR)(dhcpv6_ptr -> nx_dhcpv6_client_duid.nx_link_layer_address_msw);
}
else if(dhcpv6_ptr -> nx_dhcpv6_client_duid.nx_hardware_type == NX_DHCPV6_CLIENT_HARDWARE_TYPE_EUI_64)
{
/* The length of link layer address is 64 bits. */
/* Build the MSW. */
mac[i++] = (UCHAR)(dhcpv6_ptr -> nx_dhcpv6_client_duid.nx_link_layer_address_msw >> 24);
mac[i++] = (UCHAR)(dhcpv6_ptr -> nx_dhcpv6_client_duid.nx_link_layer_address_msw >> 16);
mac[i++] = (UCHAR)(dhcpv6_ptr -> nx_dhcpv6_client_duid.nx_link_layer_address_msw >> 8);
mac[i++] = (UCHAR)(dhcpv6_ptr -> nx_dhcpv6_client_duid.nx_link_layer_address_msw);
}
/* Build the LSW. */
mac[i++] = (UCHAR)(dhcpv6_ptr -> nx_dhcpv6_client_duid.nx_link_layer_address_lsw >> 24);
mac[i++] = (UCHAR)(dhcpv6_ptr -> nx_dhcpv6_client_duid.nx_link_layer_address_lsw >> 16);
mac[i++] = (UCHAR)(dhcpv6_ptr -> nx_dhcpv6_client_duid.nx_link_layer_address_lsw >> 8);
mac[i++] = (UCHAR)(dhcpv6_ptr -> nx_dhcpv6_client_duid.nx_link_layer_address_lsw);
/* Set up the link layer address. */
memcpy((buffer_ptr + (*index)), mac, i); /* Use case of memcpy is verified. */
(*index) += i;
return NX_SUCCESS;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_add_elapsed_time PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function adds the elapsed time option to the Client request */
/* packet using the session duration time tracked by the DHCPv6 Client */
/* thread, and checks to make sure it does not go past the end of the */
/* packet payload. */
/* */
/* Note that the elapsed time is the time from which the Client */
/* initiates the request to the time the it gets and processes a valid */
/* server reply. Its accuracy depends on the resolution of the session*/
/* timer. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPV6 Client instance */
/* buffer_ptr Pointer to request packet buffer */
/* index Location into buffer to write data*/
/* */
/* OUTPUT */
/* */
/* NX_SUCCESS Successful completion status */
/* NX_DHCPV6_INSUFFICIENT_PACKET_PAYLOAD */
/* Not enough room for the elapsed */
/* time option in the packet payload*/
/* CALLS */
/* */
/* memset Clears specified area of memory */
/* memcpy Copies specified area of memory */
/* */
/* CALLED BY */
/* */
/* _nx_dhcpv6_send_request Compiles and sends the Client */
/* DHCPv6 request */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), and */
/* verified memcpy use cases, */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_add_elapsed_time(NX_DHCPV6 *dhcpv6_ptr, UCHAR *buffer_ptr, UINT *index)
{
ULONG available_payload;
/* Compute the available payload for DHCP data in the packet buffer. */
available_payload = (dhcpv6_ptr -> nx_dhcpv6_pool_ptr -> nx_packet_pool_payload_size -
(ULONG)sizeof(NX_IPV6_HEADER) - (ULONG)sizeof(NX_UDP_HEADER) - *index);
/* Check if the data will fit in the packet buffer. */
if (available_payload < sizeof(NX_DHCPV6_ELAPSED_TIME))
{
/* Hmmm... not enough! Can't do it. */
return NX_DHCPV6_INSUFFICIENT_PACKET_PAYLOAD;
}
/* Adjust for endianness. */
NX_CHANGE_USHORT_ENDIAN(dhcpv6_ptr -> nx_dhcpv6_elapsed_time.nx_op_code);
NX_CHANGE_USHORT_ENDIAN(dhcpv6_ptr -> nx_dhcpv6_elapsed_time.nx_op_length);
NX_CHANGE_USHORT_ENDIAN(dhcpv6_ptr -> nx_dhcpv6_elapsed_time.nx_session_time);
/* Set up the elapsed time option, in hundredths of seconds. */
memcpy((buffer_ptr + (*index)), &(dhcpv6_ptr -> nx_dhcpv6_elapsed_time), sizeof(NX_DHCPV6_ELAPSED_TIME)); /* Use case of memcpy is verified. */
*index += (ULONG)sizeof(NX_DHCPV6_ELAPSED_TIME);
/* Swap bytes back. */
NX_CHANGE_USHORT_ENDIAN(dhcpv6_ptr -> nx_dhcpv6_elapsed_time.nx_op_code);
NX_CHANGE_USHORT_ENDIAN(dhcpv6_ptr -> nx_dhcpv6_elapsed_time.nx_op_length);
NX_CHANGE_USHORT_ENDIAN(dhcpv6_ptr -> nx_dhcpv6_elapsed_time.nx_session_time);
return NX_SUCCESS;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_add_ia_address PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function adds the IA address option to the Client request */
/* packet using the Client IA on record. Also checks to make sure */
/* adding the IA option does not go past the end of the packet payload.*/
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPV6 Client instance */
/* buffer_ptr Pointer to request packet buffer */
/* index Location into buffer to write data*/
/* ia_index The index of IA address */
/* */
/* OUTPUT */
/* */
/* NX_SUCCESS Successful completion status */
/* NX_DHCPV6_INVALID_IA_ADDRESS IA address on record is NULL */
/* NX_DHCPV6_OPTION_NO_DATA No IA option in client record */
/* NX_DHCPV6_INSUFFICIENT_PACKET_PAYLOAD */
/* Not enough room for the IA address*/
/* option in the packet payload */
/* CALLS */
/* */
/* memset Clears specified area of memory */
/* memcpy Copies specified area of memory */
/* */
/* CALLED BY */
/* */
/* _nx_dhcpv6_add_iana Adds the IANA and optionally the */
/* IA option to Client request */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), and */
/* verified memcpy use cases, */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_add_ia_address(NX_DHCPV6 *dhcpv6_ptr, UCHAR *buffer_ptr, UINT *index, UINT ia_index)
{
ULONG message_word;
ULONG available_payload;
/* Set the IA option length. */
dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_option_length = (6 * sizeof(ULONG));
/* Compute the available payload for DHCP data in the packet buffer. */
available_payload = (dhcpv6_ptr -> nx_dhcpv6_pool_ptr -> nx_packet_pool_payload_size -
(ULONG)sizeof(NX_IPV6_HEADER) - (ULONG)sizeof(NX_UDP_HEADER) - *index);
/* Check if the client IA address option will fit in the packet buffer. */
if (available_payload < (((ULONG)dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_option_length) + 4))
{
/* Hmmm... not enough! Can't do it. */
return NX_DHCPV6_INSUFFICIENT_PACKET_PAYLOAD;
}
/* Check that the IA address option has been created. */
if (dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_op_code != NX_DHCPV6_OP_IA_ADDRESS)
{
/* Missing or invalid IA option and/or data. */
return NX_DHCPV6_INVALID_IA_DATA;
}
/* Make sure the IA address block has a non zero IP address. */
if ((dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_global_address.nxd_ip_address.v6[0] == 0) &&
(dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_global_address.nxd_ip_address.v6[1] == 0) &&
(dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_global_address.nxd_ip_address.v6[2] == 0) &&
(dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_global_address.nxd_ip_address.v6[3] == 0))
{
return NX_DHCPV6_INVALID_IA_ADDRESS;
}
/* If the client has created an address option, apply it to the message. */
/* Clear memory to make the first word of the IA option header. */
memset(&message_word, 0, sizeof(ULONG));
/* Extract the IA data from the client record. */
message_word = (((ULONG)dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_op_code) << 16);
message_word |= dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_option_length;
/* Adjust for endianness. */
NX_CHANGE_ULONG_ENDIAN(message_word);
/* Copy IA data into the packet and update the index into the buffer. */
memcpy((buffer_ptr + (*index)), &message_word, sizeof(ULONG)); /* Use case of memcpy is verified. */
(*index) += (ULONG)sizeof(ULONG);
/* Add the IPv6 address. */
/* Adjust for endianness. */
NX_CHANGE_ULONG_ENDIAN(dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_global_address.nxd_ip_address.v6[0]);
NX_CHANGE_ULONG_ENDIAN(dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_global_address.nxd_ip_address.v6[1]);
NX_CHANGE_ULONG_ENDIAN(dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_global_address.nxd_ip_address.v6[2]);
NX_CHANGE_ULONG_ENDIAN(dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_global_address.nxd_ip_address.v6[3]);
/* Copy the Client preferred IPv6 address to the packet. */
memcpy((buffer_ptr + (*index)), &(dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_global_address.nxd_ip_address.v6[0]), sizeof(ULONG)); /* Use case of memcpy is verified. */
(*index) += (ULONG)sizeof(ULONG);
memcpy((buffer_ptr + (*index)), &(dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_global_address.nxd_ip_address.v6[1]), sizeof(ULONG)); /* Use case of memcpy is verified. */
(*index) += (ULONG)sizeof(ULONG);
memcpy((buffer_ptr + (*index)), &(dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_global_address.nxd_ip_address.v6[2]), sizeof(ULONG)); /* Use case of memcpy is verified. */
(*index) += (ULONG)sizeof(ULONG);
memcpy((buffer_ptr + (*index)), &(dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_global_address.nxd_ip_address.v6[3]), sizeof(ULONG)); /* Use case of memcpy is verified. */
(*index) += (ULONG)sizeof(ULONG);
/* Swap bytes back. */
NX_CHANGE_ULONG_ENDIAN(dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_global_address.nxd_ip_address.v6[0]);
NX_CHANGE_ULONG_ENDIAN(dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_global_address.nxd_ip_address.v6[1]);
NX_CHANGE_ULONG_ENDIAN(dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_global_address.nxd_ip_address.v6[2]);
NX_CHANGE_ULONG_ENDIAN(dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_global_address.nxd_ip_address.v6[3]);
/* Add the preferred lifetime and valid lifetime option. */
if((dhcpv6_ptr -> nx_dhcpv6_message_hdr.nx_message_type == NX_DHCPV6_MESSAGE_TYPE_SOLICIT) ||
(dhcpv6_ptr -> nx_dhcpv6_message_hdr.nx_message_type == NX_DHCPV6_MESSAGE_TYPE_CONFIRM) ||
(dhcpv6_ptr -> nx_dhcpv6_message_hdr.nx_message_type == NX_DHCPV6_MESSAGE_TYPE_DECLINE) ||
(dhcpv6_ptr -> nx_dhcpv6_message_hdr.nx_message_type == NX_DHCPV6_MESSAGE_TYPE_RELEASE))
{
/* When sending a confirm request, DHCPv6 Client should set its T1,T2,preferred-lifetime and
valid-lifetime to zero, as the server will ignore these fields, RFC3315,page41. */
memset((buffer_ptr + (*index)), 0, sizeof(ULONG));
(*index) += (ULONG)sizeof(ULONG);
memset((buffer_ptr + (*index)), 0, sizeof(ULONG));
(*index) += (ULONG)sizeof(ULONG);
}
else
{
/* Adjust for endianness. */
NX_CHANGE_ULONG_ENDIAN(dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_preferred_lifetime);
NX_CHANGE_ULONG_ENDIAN(dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_valid_lifetime);
memcpy((buffer_ptr + (*index)), &(dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_preferred_lifetime), sizeof(ULONG)); /* Use case of memcpy is verified. */
(*index) += (ULONG)sizeof(ULONG);
memcpy((buffer_ptr + (*index)), &(dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_valid_lifetime), sizeof(ULONG)); /* Use case of memcpy is verified. */
(*index) += (ULONG)sizeof(ULONG);
/* Swap bytes back. */
NX_CHANGE_ULONG_ENDIAN(dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_preferred_lifetime);
NX_CHANGE_ULONG_ENDIAN(dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_valid_lifetime);
}
return NX_SUCCESS;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_add_iana PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function adds the IANA option to the Client request packet */
/* using the Client IANA on record. Also checks to make sure adding */
/* the IANA option does not go past the end of the packet payload. If */
/* exist IA options, it will call the service to add the IA option */
/* within the IANA option data. It then updates the IANA length field */
/* for the embedded IA option. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPV6 Client instance */
/* buffer_ptr Pointer to request packet buffer */
/* index Location into buffer to write data*/
/* */
/* OUTPUT */
/* */
/* status Actual completion status */
/* NX_DHCPV6_INSUFFICIENT_PACKET_PAYLOAD */
/* Not enough room for the IANA */
/* option in the packet payload */
/* CALLS */
/* */
/* _nx_dhcpv6_add_ia_address Adds the IA option to buffer */
/* memset Clears specified area of memory */
/* memcpy Copies specified area of memory */
/* */
/* CALLED BY */
/* */
/* _nx_dhcpv6_send_request Compiles and sends the Client */
/* DHCPv6 request */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), and */
/* verified memcpy use cases, */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_add_iana(NX_DHCPV6 *dhcpv6_ptr, UCHAR *buffer_ptr, UINT *index)
{
UINT status;
UINT temp_index;
UINT ia_index;
UINT ia_length;
ULONG message_word;
ULONG available_payload;
/* Initialize the completion status variable. */
status = NX_SUCCESS;
ia_length = 0;
/* Compute the available payload in the packet buffer. */
available_payload = dhcpv6_ptr -> nx_dhcpv6_pool_ptr -> nx_packet_pool_payload_size -
(ULONG)sizeof(NX_IPV6_HEADER) - (ULONG)sizeof(NX_UDP_HEADER) - *index;
/* Check if the client IANA will fit in the packet buffer. */
if (available_payload < (((ULONG)dhcpv6_ptr -> nx_dhcpv6_iana.nx_option_length) + 4))
{
/* Hmmm... not enough! Can't do it. */
return NX_DHCPV6_INSUFFICIENT_PACKET_PAYLOAD;
}
/* Save this location in the buffer. */
temp_index = *index;
/* Skip the option code and option lenght of IA_NA, write these option after padding the all IA option. */
(*index) += (ULONG)sizeof(ULONG);
/* Add the IA_NA ID. */
NX_CHANGE_ULONG_ENDIAN(dhcpv6_ptr -> nx_dhcpv6_iana.nx_IA_NA_id);
memcpy((buffer_ptr + (*index)), &(dhcpv6_ptr -> nx_dhcpv6_iana.nx_IA_NA_id), sizeof(ULONG)); /* Use case of memcpy is verified. */
(*index) += (ULONG)sizeof(ULONG);
NX_CHANGE_ULONG_ENDIAN(dhcpv6_ptr -> nx_dhcpv6_iana.nx_IA_NA_id);
/* Add the T1 and T2 option. */
if((dhcpv6_ptr -> nx_dhcpv6_message_hdr.nx_message_type == NX_DHCPV6_MESSAGE_TYPE_SOLICIT) ||
(dhcpv6_ptr -> nx_dhcpv6_message_hdr.nx_message_type == NX_DHCPV6_MESSAGE_TYPE_CONFIRM) ||
(dhcpv6_ptr -> nx_dhcpv6_message_hdr.nx_message_type == NX_DHCPV6_MESSAGE_TYPE_DECLINE) ||
(dhcpv6_ptr -> nx_dhcpv6_message_hdr.nx_message_type == NX_DHCPV6_MESSAGE_TYPE_RELEASE))
{
/* When sending a confirm request, DHCPv6 Client should set its T1,T2,preferred-lifetime and
valid-lifetime to zero, as the server will ignore these fields, RFC3315,page41. */
memset((buffer_ptr + (*index)), 0, sizeof(ULONG)); /* Use case of memcpy is verified. */
(*index) += (ULONG)sizeof(ULONG);
memset((buffer_ptr + (*index)), 0, sizeof(ULONG)); /* Use case of memcpy is verified. */
(*index) += (ULONG)sizeof(ULONG);
}
else
{
/* Adjust the data. */
NX_CHANGE_ULONG_ENDIAN(dhcpv6_ptr -> nx_dhcpv6_iana.nx_T1);
NX_CHANGE_ULONG_ENDIAN(dhcpv6_ptr -> nx_dhcpv6_iana.nx_T2);
memcpy((buffer_ptr + (*index)), &(dhcpv6_ptr -> nx_dhcpv6_iana.nx_T1), sizeof(ULONG)); /* Use case of memcpy is verified. */
(*index) += (ULONG)sizeof(ULONG);
memcpy((buffer_ptr + (*index)), &(dhcpv6_ptr -> nx_dhcpv6_iana.nx_T2), sizeof(ULONG)); /* Use case of memcpy is verified. */
(*index) += (ULONG)sizeof(ULONG);
/* Swap bytes back. */
NX_CHANGE_ULONG_ENDIAN(dhcpv6_ptr -> nx_dhcpv6_iana.nx_T1);
NX_CHANGE_ULONG_ENDIAN(dhcpv6_ptr -> nx_dhcpv6_iana.nx_T2);
}
for(ia_index = 0; ia_index < NX_DHCPV6_MAX_IA_ADDRESS; ia_index++)
{
/* Check the IA address status. */
if(dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_address_status)
{
/* Yes, so add one...*/
status = _nx_dhcpv6_add_ia_address(dhcpv6_ptr, buffer_ptr, index, ia_index);
/* Was the IA address option get appended successfully? */
if (status == NX_SUCCESS)
{
/* Update the IA address to record the IANA option length. */
ia_length = (UINT)(ia_length + dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_option_length + 4);
}
}
}
/* Clear memory to make the first word of the IA-NA header. */
memset(&message_word, 0, sizeof(ULONG));
/* Set the IA_NA option code and option length. */
dhcpv6_ptr -> nx_dhcpv6_iana.nx_op_code = NX_DHCPV6_OP_IA_NA;
dhcpv6_ptr -> nx_dhcpv6_iana.nx_option_length = (USHORT)(ia_length + 12);
/* Write the IANA opcode and data length into one word. */
message_word = (((ULONG)(dhcpv6_ptr -> nx_dhcpv6_iana.nx_op_code)) << 16);
message_word |= dhcpv6_ptr -> nx_dhcpv6_iana.nx_option_length;
/* Adjust for endianness. */
NX_CHANGE_ULONG_ENDIAN(message_word);
/* Copy the word into the packet buffer going to the server. */
memcpy((buffer_ptr + temp_index), &message_word, sizeof(ULONG)); /* Use case of memcpy is verified. */
return NX_SUCCESS;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_add_option_request PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function adds the option request option to the Client request */
/* packet using the internal 'register' in the DHCPv6 Client instance */
/* for what DHCPv6 options have been set or cleared. Also checks to */
/* make sure it does not go past the end of the packet payload. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPV6 Client instance */
/* buffer_ptr Pointer to request packet buffer */
/* index Location into buffer to write data*/
/* */
/* OUTPUT */
/* */
/* NX_SUCCESS Successful completion status */
/* NX_DHCPV6_INSUFFICIENT_PACKET_PAYLOAD */
/* Not enough room for the option */
/* request in the packet payload */
/* CALLS */
/* */
/* memset Clears specified area of memory */
/* memcpy Copies specified area of memory */
/* */
/* CALLED BY */
/* */
/* _nx_dhcpv6_send_request Compiles and sends the Client */
/* DHCPv6 request */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), and */
/* verified memcpy use cases, */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_add_option_request(NX_DHCPV6 *dhcpv6_ptr, UCHAR *buffer_ptr, UINT *index)
{
USHORT message_word;
USHORT option_list;
USHORT option_length = 0;
UCHAR *option_length_ptr;
ULONG available_payload;
/* Compute the available payload for DHCP data in the packet buffer. */
available_payload = (dhcpv6_ptr -> nx_dhcpv6_pool_ptr -> nx_packet_pool_payload_size -
(ULONG)sizeof(NX_IPV6_HEADER) - (ULONG)sizeof(NX_UDP_HEADER) - *index);
/* Check if the option request option will fit in the packet buffer. */
if (available_payload < (((ULONG)(dhcpv6_ptr -> nx_dhcpv6_option_request.nx_option_length)) + 4))
{
/* Hmmm... not enough! Can't do it. */
return NX_DHCPV6_INSUFFICIENT_PACKET_PAYLOAD;
}
/* Set a local variable for convenience. */
option_list = dhcpv6_ptr -> nx_dhcpv6_option_request.nx_op_request;
/* Update the option code.
Adjust for endianness. */
NX_CHANGE_USHORT_ENDIAN(dhcpv6_ptr -> nx_dhcpv6_option_request.nx_op_code);
/* Copy the option code to the packet. */
memcpy((buffer_ptr + (*index)), &(dhcpv6_ptr -> nx_dhcpv6_option_request.nx_op_code), sizeof(USHORT)); /* Use case of memcpy is verified. */
*index += (ULONG)sizeof(USHORT);
/* Swap bytes back. */
NX_CHANGE_USHORT_ENDIAN(dhcpv6_ptr -> nx_dhcpv6_option_request.nx_op_code);
/* Record the option length pointer and skip it, update the option length after fill the option data. */
option_length_ptr = buffer_ptr + (*index);
*index += (ULONG)sizeof(USHORT);
/* Now check to see which options we add as option data: */
/* Is the DNS server option requested? */
if(option_list & NX_DHCPV6_DNS_SERVER_OPTION)
{
/* Yes, add this option code into the option request data. */
message_word = NX_DHCPV6_OP_DNS_SERVER;
/* Adjust for endianness. */
NX_CHANGE_USHORT_ENDIAN(message_word);
memcpy((buffer_ptr + (*index)), &message_word, sizeof(SHORT)); /* Use case of memcpy is verified. */
/* Update the location of the buffer write pointer. */
*index += (ULONG)sizeof(SHORT);
option_length = (USHORT)(option_length + sizeof(SHORT));
}
/* Is the timeS server option requested? */
if(option_list & NX_DHCPV6_SNTP_SERVER_OPTION)
{
/* Yes, add this option code into the option request data. */
message_word = NX_DHCPV6_OP_SNTP_SERVER;
/* Adjust for endianness. */
NX_CHANGE_USHORT_ENDIAN(message_word);
memcpy((buffer_ptr + (*index)), &message_word, sizeof(SHORT)); /* Use case of memcpy is verified. */
/* Update the location of the buffer write pointer. */
*index += (ULONG)sizeof(SHORT);
option_length = (USHORT)(option_length + sizeof(SHORT));
}
/* Is the time zone option requested? */
if(option_list & NX_DHCPV6_NEW_POSIX_TIMEZONE_OPTION)
{
/* Yes, add this option code into the option request data. */
message_word = NX_DHCPV6_OP_NEW_POSIX_TIMEZONE;
/* Adjust for endianness. */
NX_CHANGE_USHORT_ENDIAN(message_word);
memcpy((buffer_ptr + (*index)), &message_word, sizeof(SHORT)); /* Use case of memcpy is verified. */
/* Update the location of the buffer write pointer. */
*index += (ULONG)sizeof(SHORT);
option_length = (USHORT)(option_length + sizeof(SHORT));
}
/* Is the domain name option requested? */
if(option_list & NX_DHCPV6_DOMAIN_NAME_OPTION)
{
/* Yes, add this option code into the option request data. */
message_word = NX_DHCPV6_OP_DOMAIN_NAME;
/* Adjust for endianness. */
NX_CHANGE_USHORT_ENDIAN(message_word);
memcpy((buffer_ptr + (*index)), &message_word, sizeof(SHORT)); /* Use case of memcpy is verified. */
/* Update the location of the buffer write pointer. */
*index += (ULONG)sizeof(SHORT);
option_length = (USHORT)(option_length + sizeof(SHORT));
}
/* Is the fully qualified domain name option requested?
A client MUST only include the Client FQDN option in SOLICIT, REQUEST, RENEW, or REBIND message.
A client that sends the Client FQDN option MUST also include the option in the Option Requst option
if it expects the server to include the Client FQDN option in any responses. RFC4704, Section5, Page7. */
if(((dhcpv6_ptr -> nx_dhcpv6_message_hdr.nx_message_type == NX_DHCPV6_MESSAGE_TYPE_SOLICIT) ||
(dhcpv6_ptr -> nx_dhcpv6_message_hdr.nx_message_type == NX_DHCPV6_MESSAGE_TYPE_REQUEST) ||
(dhcpv6_ptr -> nx_dhcpv6_message_hdr.nx_message_type == NX_DHCPV6_MESSAGE_TYPE_RENEW) ||
(dhcpv6_ptr -> nx_dhcpv6_message_hdr.nx_message_type == NX_DHCPV6_MESSAGE_TYPE_REBIND)) &&
(option_list & NX_DHCPV6_CLIENT_FQDN_OPTION))
{
/* Yes, add this option code into the option request data. */
message_word = NX_DHCPV6_OP_CLIENT_FQDN;
/* Adjust for endianness. */
NX_CHANGE_USHORT_ENDIAN(message_word);
memcpy((buffer_ptr + (*index)), &message_word, sizeof(SHORT)); /* Use case of memcpy is verified. */
/* Update the location of the buffer write pointer. */
*index += (ULONG)sizeof(SHORT);
option_length = (USHORT)(option_length + sizeof(SHORT));
}
/* Now record and update the option lenght. */
dhcpv6_ptr -> nx_dhcpv6_option_request.nx_option_length = option_length;
NX_CHANGE_USHORT_ENDIAN(option_length);
memcpy(option_length_ptr, &option_length, sizeof(SHORT)); /* Use case of memcpy is verified. */
return NX_SUCCESS;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_add_server_duid PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function adds the server DUID to the Client request packet */
/* based on the server DUID on record, checking to make sure it does */
/* not go past the end of the packet payload. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPV6 Client instance */
/* received_buffer Pointer to server reply */
/* length Size of server reply buffer */
/* */
/* OUTPUT */
/* */
/* NX_SUCCESS Successful completion status */
/* NX_DHCPV6_INSUFFICIENT_PACKET_PAYLOAD */
/* Not enough room for the server */
/* DUID in the packet payload */
/* CALLS */
/* */
/* memset Clears specified area of memory */
/* memcpy Copies specified area of memory */
/* */
/* CALLED BY */
/* */
/* _nx_dhcpv6_send_request Compiles and sends the Client */
/* DHCPv6 request */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), and */
/* verified memcpy use cases, */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_add_server_duid(NX_DHCPV6 *dhcpv6_ptr, UCHAR *buffer_ptr, UINT *index)
{
ULONG message_word;
ULONG available_payload;
UCHAR mac[8];
UINT i = 0;
/* Compute the available payload for DHCP data in the packet buffer. */
available_payload = (dhcpv6_ptr -> nx_dhcpv6_pool_ptr -> nx_packet_pool_payload_size -
(ULONG)sizeof(NX_IPV6_HEADER) - (ULONG)sizeof(NX_UDP_HEADER) - *index);
/* Check if the largest possible server DUID will fit in the packet buffer. */
if (available_payload < (((ULONG)(dhcpv6_ptr -> nx_dhcpv6_server_duid.nx_option_length)) + 4))
{
/* Hmmm... not enough! Can't do it. */
return NX_DHCPV6_INSUFFICIENT_PACKET_PAYLOAD;
}
/* Make sure the Client has a valid Server DUID. */
if (dhcpv6_ptr -> nx_dhcpv6_server_duid.nx_op_code != NX_DHCPV6_OP_SERVER_ID)
{
/* Missing or invalid option data. */
return NX_DHCPV6_INVALID_SERVER_DUID;
}
/* Build the header from the client's record of its DHCPv6 Server DUID. */
message_word = (((ULONG)(dhcpv6_ptr -> nx_dhcpv6_server_duid.nx_op_code)) << 16);
message_word |= (dhcpv6_ptr -> nx_dhcpv6_server_duid.nx_option_length);
/* Adjust for endianness. */
NX_CHANGE_ULONG_ENDIAN(message_word);
/* Copy first half of the Server DUID option to packet buffer. */
memcpy((buffer_ptr + (*index)), &message_word, sizeof(ULONG)); /* Use case of memcpy is verified. */
*index += (ULONG)sizeof(ULONG);
/* Build the DUID type and hardware type. */
message_word = (((ULONG)(dhcpv6_ptr -> nx_dhcpv6_server_duid.nx_duid_type)) << 16);
message_word |= dhcpv6_ptr -> nx_dhcpv6_server_duid.nx_hardware_type;
/* Adjust for endianness. */
NX_CHANGE_ULONG_ENDIAN(message_word);
/* Set up the DUID type and hardware type. */
memcpy((buffer_ptr + (*index)), &message_word, sizeof(UINT)); /* Use case of memcpy is verified. */
*index += (ULONG)sizeof(UINT);
/* Include the 'time' field if this is a Link layer time DUID type. */
if (dhcpv6_ptr -> nx_dhcpv6_server_duid.nx_duid_type == NX_DHCPV6_DUID_TYPE_LINK_TIME)
{
/* Build the time. */
message_word = dhcpv6_ptr -> nx_dhcpv6_server_duid.nx_duid_time;
/* Adjust for endianness. */
NX_CHANGE_ULONG_ENDIAN(message_word);
/* Set up the time. */
memcpy((buffer_ptr + (*index)), &message_word, sizeof(ULONG)); /* Use case of memcpy is verified. */
(*index) += (ULONG)sizeof(ULONG);
}
/* Build the link layer address. */
if (dhcpv6_ptr -> nx_dhcpv6_server_duid.nx_hardware_type == NX_DHCPV6_CLIENT_HARDWARE_TYPE_ETHERNET)
{
/* The length of link layer address is 48 bit. */
/* Build the MSW. */
mac[i++] = (UCHAR)(dhcpv6_ptr -> nx_dhcpv6_server_duid.nx_link_layer_address_msw >> 8);
mac[i++] = (UCHAR)(dhcpv6_ptr -> nx_dhcpv6_server_duid.nx_link_layer_address_msw);
}
else if(dhcpv6_ptr -> nx_dhcpv6_server_duid.nx_hardware_type == NX_DHCPV6_CLIENT_HARDWARE_TYPE_EUI_64)
{
/* The length of link layer address is 64 bits. */
/* Build the MSW. */
mac[i++] = (UCHAR)(dhcpv6_ptr -> nx_dhcpv6_server_duid.nx_link_layer_address_msw >> 24);
mac[i++] = (UCHAR)(dhcpv6_ptr -> nx_dhcpv6_server_duid.nx_link_layer_address_msw >> 16);
mac[i++] = (UCHAR)(dhcpv6_ptr -> nx_dhcpv6_server_duid.nx_link_layer_address_msw >> 8);
mac[i++] = (UCHAR)(dhcpv6_ptr -> nx_dhcpv6_server_duid.nx_link_layer_address_msw);
}
/* Build the LSW. */
mac[i++] = (UCHAR)(dhcpv6_ptr -> nx_dhcpv6_server_duid.nx_link_layer_address_lsw >> 24);
mac[i++] = (UCHAR)(dhcpv6_ptr -> nx_dhcpv6_server_duid.nx_link_layer_address_lsw >> 16);
mac[i++] = (UCHAR)(dhcpv6_ptr -> nx_dhcpv6_server_duid.nx_link_layer_address_lsw >> 8);
mac[i++] = (UCHAR)(dhcpv6_ptr -> nx_dhcpv6_server_duid.nx_link_layer_address_lsw);
/* Set up the link layer address. */
memcpy((buffer_ptr + (*index)), mac, i); /* Use case of memcpy is verified. */
(*index) += i;
return NX_SUCCESS;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_add_client_FQDN PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function adds the DHCPv6 Client FQDN Option to the Client */
/* request packet , checking to make sure it does not go past the end */
/* of the packet payload. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPV6 Client instance */
/* received_buffer Pointer to server reply */
/* length Size of server reply buffer */
/* */
/* OUTPUT */
/* */
/* NX_SUCCESS Successful completion status */
/* NX_DHCPV6_INSUFFICIENT_PACKET_PAYLOAD */
/* Not enough room for the server */
/* DUID in the packet payload */
/* CALLS */
/* */
/* memset Clears specified area of memory */
/* memcpy Copies specified area of memory */
/* */
/* CALLED BY */
/* */
/* _nx_dhcpv6_send_request Compiles and sends the Client */
/* DHCPv6 request */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), and */
/* verified memcpy use cases, */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_add_client_FQDN(NX_DHCPV6 *dhcpv6_ptr, UCHAR *buffer_ptr, UINT *index)
{
ULONG message_word;
ULONG available_payload;
UINT domain_name_length;
/* Compute the available payload for DHCP data in the packet buffer. */
available_payload = (dhcpv6_ptr -> nx_dhcpv6_pool_ptr -> nx_packet_pool_payload_size -
(ULONG)sizeof(NX_IPV6_HEADER) - (ULONG)sizeof(NX_UDP_HEADER) - *index);
/* Check if the largest possible server DUID will fit in the packet buffer. */
if (available_payload < (((ULONG)(dhcpv6_ptr -> nx_dhcpv6_server_duid.nx_option_length)) + 4))
{
/* Hmmm... not enough! Can't do it. */
return NX_DHCPV6_INSUFFICIENT_PACKET_PAYLOAD;
}
memset(&message_word, 0, sizeof(ULONG));
/* Set the option code and option length. */
message_word = (((ULONG)(dhcpv6_ptr -> nx_dhcpv6_client_FQDN.nx_op_code)) << 16);
message_word |= (dhcpv6_ptr -> nx_dhcpv6_client_FQDN.nx_op_length);
/* Adjust for endianness. */
NX_CHANGE_ULONG_ENDIAN(message_word);
/* Add the option code and option length into packet buffer. */
memcpy((buffer_ptr + (*index)), &message_word, sizeof(ULONG)); /* Use case of memcpy is verified. */
*index += (ULONG)sizeof(ULONG);
/* Add the flags into packet buffer. */
*(buffer_ptr + (*index)) = dhcpv6_ptr -> nx_dhcpv6_client_FQDN.nx_flags;
*index += 1;
/* Encode the domain name into the packet buffer. */
domain_name_length = _nx_dhcpv6_name_string_encode(buffer_ptr + (*index), (UCHAR *)dhcpv6_ptr -> nx_dhcpv6_client_FQDN.nx_domain_name);
*index += domain_name_length;
return NX_SUCCESS;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nxe_dhcpv6_client_create PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function performs error checking on the NetX create dhcpv6 */
/* client service. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPV6 Client */
/* ip_ptr Pointer to Client IP instance */
/* name_ptr DHCPV6 name pointer */
/* packet_pool_ptr Pointer to Client packet pool */
/* stack_ptr Pointer to free memory */
/* stack_size Size of client stack memory */
/* dhcpv6_state_change_notify Client state change handler */
/* dhcpv6_server_error_handler Server error status handler */
/* */
/* OUTPUT */
/* */
/* status Completion status */
/* NX_PTR_ERROR Invalid pointer input */
/* NX_DHCPV6_PARAM_ERROR Invalid non pointer input */
/* */
/* CALLS */
/* */
/* _nx_dhcpv6_client_create Actual Client create function */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nxe_dhcpv6_client_create(NX_DHCPV6 *dhcpv6_ptr, NX_IP *ip_ptr, CHAR *name_ptr,
NX_PACKET_POOL *packet_pool_ptr, VOID *stack_ptr, ULONG stack_size,
VOID (*dhcpv6_state_change_notify)(struct NX_DHCPV6_STRUCT *dhcpv6_ptr, UINT old_state, UINT new_state),
VOID (*dhcpv6_server_error_handler)(struct NX_DHCPV6_STRUCT *dhcpv6_ptr, UINT op_code, UINT status_code, UINT message_type))
{
UINT status;
/* Check for invalid pointer input. */
if (!dhcpv6_ptr ||!ip_ptr || !packet_pool_ptr || !stack_ptr)
{
return NX_PTR_ERROR;
}
/* Check for invalid non pointer input. */
if ((ip_ptr -> nx_ip_id != NX_IP_ID) || (stack_size < TX_MINIMUM_STACK))
{
return NX_DHCPV6_PARAM_ERROR;
}
/* Call actual DHCPV6 create service. */
status = _nx_dhcpv6_client_create(dhcpv6_ptr, ip_ptr, name_ptr, packet_pool_ptr, stack_ptr, stack_size,
dhcpv6_state_change_notify, dhcpv6_server_error_handler);
/* Return status. */
return(status);
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_client_create PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function creates the DHCPv6 Client instance with a Netx packet */
/* pool, processing thread, and various flag event queues, timers and */
/* mutexes necessary for DHCPv6 Client operations. Reocrd the DHCPv6 */
/* pointer for DAD callback function process. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPV6 Client */
/* ip_ptr Pointer to Client IP instance */
/* name_ptr DHCPV6 name pointer */
/* packet_pool_ptr Pointer to Client packet pool */
/* stack_ptr Pointer to free memory */
/* stack_size Size of Client stack memory */
/* dhcpv6_state_change_notify Client state change handler */
/* dhcpv6_server_error_handler Server error status handler */
/* */
/* OUTPUT */
/* */
/* status Actual completion status */
/* NX_SUCCESS Successful completion status */
/* */
/* CALLS */
/* */
/* tx_event_flags_create Create ThreadX flag event queue*/
/* tx_mutex_create Create mutex lock on resource */
/* nx_packet_pool_delete Delete the DHCPV6 packet pool */
/* nx_udp_socket_create Create the DHCPV6 UDP socket */
/* nx_udp_socket_delete Delete the DHCPV6 UDP socket */
/* tx_mutex_create Create DHCPV6 mutex */
/* tx_mutex_delete Delete DHCPV6 mutex */
/* tx_thread_create Create DHCPV6 thread */
/* tx_timer_create Create DHCPV6 timer */
/* tx_timer_delete Delete DHCPV6 timer */
/* nxd_ipv6_address_change_notify Set the DAD callback function */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_client_create(NX_DHCPV6 *dhcpv6_ptr, NX_IP *ip_ptr, CHAR *name_ptr,
NX_PACKET_POOL *packet_pool_ptr, VOID *stack_ptr, ULONG stack_size,
VOID (*dhcpv6_state_change_notify)(struct NX_DHCPV6_STRUCT *dhcpv6_ptr, UINT old_state, UINT new_state),
VOID (*dhcpv6_server_error_handler)(struct NX_DHCPV6_STRUCT *dhcpv6_ptr, UINT op_code, UINT status_code, UINT message_type))
{
UINT status;
/* Initialize the DHCPV6 control block to zero. */
memset((void *) dhcpv6_ptr, 0, sizeof(NX_DHCPV6));
/* Initialize the DHCPV6 Server and Relay multicast address. */
memset(&All_DHCPv6_Relay_Servers_Address, 0, sizeof(NXD_ADDRESS));
All_DHCPv6_Relay_Servers_Address.nxd_ip_version = NX_IP_VERSION_V6;
All_DHCPv6_Relay_Servers_Address.nxd_ip_address.v6[0] = 0xff020000;
All_DHCPv6_Relay_Servers_Address.nxd_ip_address.v6[1] = 0x00000000;
All_DHCPv6_Relay_Servers_Address.nxd_ip_address.v6[2] = 0x00000000;
All_DHCPv6_Relay_Servers_Address.nxd_ip_address.v6[3] = 0x00010002;
/* Set the destination address. */
COPY_NXD_ADDRESS(&All_DHCPv6_Relay_Servers_Address, &(dhcpv6_ptr -> nx_dhcpv6_client_destination_address));
/* Set the DHCPv6 IP pointer. */
dhcpv6_ptr -> nx_dhcpv6_ip_ptr = ip_ptr;
/* Set the DHCPV6 name. */
dhcpv6_ptr -> nx_dhcpv6_name = name_ptr;
/* If multihome support is available, default the client DHCP network to the primary interface. */
dhcpv6_ptr -> nx_dhcpv6_client_interface_index = 0;
/* Set the Client packet pool for sending messages to the Server. */
dhcpv6_ptr -> nx_dhcpv6_pool_ptr = packet_pool_ptr;
/* Create the IP timer event flag instance. */
status = tx_event_flags_create(&(dhcpv6_ptr -> nx_dhcpv6_events), "DHCPv6 Client Timer Events Queue");
/* Check for error. */
if (status != TX_SUCCESS)
{
return status;
}
/* Create the DHCPV6 client mutex. */
status = tx_mutex_create(&(dhcpv6_ptr -> nx_dhcpv6_client_mutex), "DHCPV6 Client Process State", TX_NO_INHERIT);
/* Determine if the mutexes creation was successful. */
if (status)
{
/* Delete the flag queue. */
tx_event_flags_delete(&dhcpv6_ptr -> nx_dhcpv6_events);
/* No, return error status. */
return status;
}
/* Create the DHCPV6 timer for keeping track of the IP lease's time remaining before expiration. */
status = tx_timer_create(&(dhcpv6_ptr -> nx_dhcpv6_IP_lifetime_timer), "NetX DHCPV6 Client IP Lease timer",
_nx_dhcpv6_IP_lifetime_timeout_entry, (ULONG)(ALIGN_TYPE)dhcpv6_ptr,
(NX_DHCPV6_IP_LIFETIME_TIMER_INTERVAL * NX_DHCPV6_TICKS_PER_SECOND),
(NX_DHCPV6_IP_LIFETIME_TIMER_INTERVAL * NX_DHCPV6_TICKS_PER_SECOND),
TX_NO_ACTIVATE);
NX_TIMER_EXTENSION_PTR_SET(&(dhcpv6_ptr -> nx_dhcpv6_IP_lifetime_timer), dhcpv6_ptr)
/* Determine if the timer creation was successful. */
if (status)
{
/* Delete the mutex. */
tx_mutex_delete(&(dhcpv6_ptr -> nx_dhcpv6_client_mutex));
/* Delete all the timers, since we don't know which create call fails. */
tx_timer_delete(&(dhcpv6_ptr -> nx_dhcpv6_session_timer));
/* Delete the UDP socket. */
nx_udp_socket_delete(&(dhcpv6_ptr -> nx_dhcpv6_socket));
/* Delete the packet pool. */
/* Delete the flag queue. */
tx_event_flags_delete(&dhcpv6_ptr -> nx_dhcpv6_events);
/* No, return error status. */
return status;
}
/* Create the DHCPV6 timer for keeping track of the DHCPv6 Client session time. */
status = tx_timer_create(&(dhcpv6_ptr -> nx_dhcpv6_session_timer), "NetX DHCPV6 Client Session Duration timer",
_nx_dhcpv6_session_timeout_entry, (ULONG)(ALIGN_TYPE)dhcpv6_ptr,
(NX_DHCPV6_SESSION_TIMER_INTERVAL * NX_DHCPV6_TICKS_PER_SECOND),
(NX_DHCPV6_SESSION_TIMER_INTERVAL * NX_DHCPV6_TICKS_PER_SECOND),
TX_NO_ACTIVATE);
NX_TIMER_EXTENSION_PTR_SET(&(dhcpv6_ptr -> nx_dhcpv6_session_timer), dhcpv6_ptr)
/* Determine if the timers creation was successful. */
if (status)
{
/* Delete the mutex. */
tx_mutex_delete(&(dhcpv6_ptr -> nx_dhcpv6_client_mutex));
/* Delete all the timers, since we don't know which create call fails. */
tx_timer_delete(&(dhcpv6_ptr -> nx_dhcpv6_session_timer));
tx_timer_delete(&(dhcpv6_ptr -> nx_dhcpv6_IP_lifetime_timer));
/* Delete the UDP socket. */
nx_udp_socket_delete(&(dhcpv6_ptr -> nx_dhcpv6_socket));
/* Delete the packet pool. */
/* Delete the flag queue. */
tx_event_flags_delete(&dhcpv6_ptr -> nx_dhcpv6_events);
/* No, return error status. */
return status;
}
/* Create the DHCPV6 processing thread. */
status = tx_thread_create(&(dhcpv6_ptr -> nx_dhcpv6_thread), "NetX DHCPV6 Client", _nx_dhcpv6_thread_entry,
(ULONG)(ALIGN_TYPE)dhcpv6_ptr, stack_ptr, stack_size,
NX_DHCPV6_THREAD_PRIORITY, NX_DHCPV6_THREAD_PRIORITY, 1, TX_DONT_START);
NX_THREAD_EXTENSION_PTR_SET(&(dhcpv6_ptr -> nx_dhcpv6_thread), dhcpv6_ptr)
/* Determine if the thread creation was successful. */
if (status)
{
/* Delete the timers. */
tx_timer_delete(&(dhcpv6_ptr -> nx_dhcpv6_IP_lifetime_timer));
tx_timer_delete(&(dhcpv6_ptr -> nx_dhcpv6_session_timer));
/* Delete the mutex. */
tx_mutex_delete(&(dhcpv6_ptr -> nx_dhcpv6_client_mutex));
/* Delete the flag queue. */
tx_event_flags_delete(&dhcpv6_ptr -> nx_dhcpv6_events);
/* No, return error status. */
return status;
}
/* Create the DHCP socket. */
status = nx_udp_socket_create(dhcpv6_ptr -> nx_dhcpv6_ip_ptr, &(dhcpv6_ptr -> nx_dhcpv6_socket), "NetX DHCPV6 Client",
NX_DHCPV6_TYPE_OF_SERVICE, NX_DONT_FRAGMENT,
NX_DHCPV6_TIME_TO_LIVE, NX_DHCPV6_QUEUE_DEPTH);
/* Was the socket creation successful? */
if (status != NX_SUCCESS)
{
/* Delete the timers. */
tx_timer_delete(&(dhcpv6_ptr -> nx_dhcpv6_IP_lifetime_timer));
tx_timer_delete(&(dhcpv6_ptr -> nx_dhcpv6_session_timer));
/* Delete the mutex. */
tx_mutex_delete(&(dhcpv6_ptr -> nx_dhcpv6_client_mutex));
/* Delete the flag queue. */
tx_event_flags_delete(&dhcpv6_ptr -> nx_dhcpv6_events);
tx_thread_delete(&dhcpv6_ptr -> nx_dhcpv6_thread);
/* No, return error status. */
return status;
}
/* Set the Client in the initial state. */
dhcpv6_ptr -> nx_dhcpv6_state = NX_DHCPV6_STATE_INIT;
/* Set the 'time accrued' on the Client global IP address at zero seconds. */
dhcpv6_ptr -> nx_dhcpv6_IP_lifetime_time_accrued = 0;
/* Update the DHCPv6 Client ID. */
dhcpv6_ptr -> nx_dhcpv6_id = NX_DHCPV6_ID;
/* Save the DHCPV6 instance pointer in the socket. */
dhcpv6_ptr -> nx_dhcpv6_socket.nx_udp_socket_reserved_ptr = (void *) dhcpv6_ptr;
/* Set up the elapsed time for the anticipated message exchange with the DHCPv6 Server. */
dhcpv6_ptr -> nx_dhcpv6_elapsed_time.nx_op_code = NX_DHCPV6_OP_ELAPSED_TIME;
dhcpv6_ptr -> nx_dhcpv6_elapsed_time.nx_session_time = 0;
/* Set the elapsed time option data length, minus the option header. */
dhcpv6_ptr -> nx_dhcpv6_elapsed_time.nx_op_length = sizeof(NX_DHCPV6_ELAPSED_TIME) - 4;
/* Set the option request option code. Cannot set the data length as yet. */
dhcpv6_ptr -> nx_dhcpv6_option_request.nx_op_code = NX_DHCPV6_OP_OPTION_REQUEST;
/* Assign the various handlers (server error messages and state change). */
dhcpv6_ptr -> nx_dhcpv6_state_change_callback = dhcpv6_state_change_notify;
dhcpv6_ptr -> nx_dhcpv6_server_error_handler = dhcpv6_server_error_handler;
#if !defined (NX_DISABLE_IPV6_DAD) && defined (NX_ENABLE_IPV6_ADDRESS_CHANGE_NOTIFY)
/* Set the callback function to detect DAD process.
If DAD failure, automatically set event to send DHCP decline meessage.
Notice: other modules should not set the address change notify function again. */
status = nxd_ipv6_address_change_notify(dhcpv6_ptr -> nx_dhcpv6_ip_ptr, _nx_dhcpv6_ipv6_address_DAD_notify);
/* Was the callback notify fucntion creation successful? */
if (status != NX_SUCCESS)
{
/* Delete the timers. */
tx_timer_delete(&(dhcpv6_ptr -> nx_dhcpv6_IP_lifetime_timer));
tx_timer_delete(&(dhcpv6_ptr -> nx_dhcpv6_session_timer));
/* Delete the mutex. */
tx_mutex_delete(&(dhcpv6_ptr -> nx_dhcpv6_client_mutex));
/* Delete the flag queue. */
tx_event_flags_delete(&dhcpv6_ptr -> nx_dhcpv6_events);
/* Delete the thread. */
tx_thread_delete(&dhcpv6_ptr -> nx_dhcpv6_thread);
/* Delete the thread. */
nx_udp_socket_delete(&(dhcpv6_ptr -> nx_dhcpv6_socket));
/* No, return error status. */
return status;
}
#endif
/* Keep the DHCPv6 instance for DAD callback notify. */
_nx_dhcpv6_DAD_ptr = dhcpv6_ptr;
/* Return a successful status. */
return(NX_SUCCESS);
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nxe_dhcpv6_client_delete PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function performs error checking on the NetX delete dhcpv6 */
/* client service. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPV6 Client instance*/
/* */
/* OUTPUT */
/* */
/* OUTPUT */
/* */
/* status Completion status */
/* NX_PTR_ERROR Invalid pointer input */
/* */
/* */
/* CALLS */
/* */
/* _nx_dhcpv6_client_delete Actual DHCPV6 delete function */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nxe_dhcpv6_client_delete(NX_DHCPV6 *dhcpv6_ptr)
{
UINT status;
/* Check for invalid input pointers. */
if ((dhcpv6_ptr == NX_NULL) || (dhcpv6_ptr -> nx_dhcpv6_id != NX_DHCPV6_ID))
{
return(NX_PTR_ERROR);
}
/* Check for appropriate caller. */
NX_THREADS_ONLY_CALLER_CHECKING
/* Call actual DHCPV6 delete service. */
status = _nx_dhcpv6_client_delete(dhcpv6_ptr);
/* Return commpletion status. */
return(status);
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_client_delete PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function deletes the DHCPV6 Client instance and releases all */
/* NetX Duo and ThreadX resources. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPV6 Client instance*/
/* */
/* OUTPUT */
/* */
/* NX_SUCCESS Successful Completion status */
/* */
/* CALLS */
/* */
/* nx_udp_socket_unbind Release DHCPV6 UDP socket port*/
/* nx_udp_socket_delete Delete the DHCPV6 UDP socket */
/* tx_thread_terminate Terminate DHCPV6 thread */
/* tx_thread_delete Delete DHCPV6 thread */
/* tx_timer_delete Delete DHCPV6 timers */
/* tx_mutex_delete Delete DHCPV6 mutexes */
/* tx_event_flags_delete Delete DHCPV6 flag queue */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_client_delete(NX_DHCPV6 *dhcpv6_ptr)
{
/* Terminate the DHCPV6 processing thread. */
tx_thread_terminate(&(dhcpv6_ptr -> nx_dhcpv6_thread));
/* Delete the DHCPV6 processing thread. */
tx_thread_delete(&(dhcpv6_ptr -> nx_dhcpv6_thread));
/* Delete the flag event queue. */
tx_event_flags_delete(&dhcpv6_ptr -> nx_dhcpv6_events);
/* Delete the timers */
tx_timer_delete(&(dhcpv6_ptr->nx_dhcpv6_IP_lifetime_timer));
tx_timer_delete(&(dhcpv6_ptr->nx_dhcpv6_session_timer));
/* Delete the mutex. */
tx_mutex_delete(&(dhcpv6_ptr -> nx_dhcpv6_client_mutex));
/* Release the UDP socket port. */
nx_udp_socket_unbind(&(dhcpv6_ptr -> nx_dhcpv6_socket));
/* Delete the UDP socket. */
nx_udp_socket_delete(&(dhcpv6_ptr -> nx_dhcpv6_socket));
/* Clear the dhcpv6 structure ID. */
dhcpv6_ptr -> nx_dhcpv6_id = 0;
/* Return a successful status. */
return(NX_SUCCESS);
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nxe_dhcpv6_create_client_duid PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function performs error checking on the create Client DUID */
/* service. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPV6 Client instance */
/* duid_type Type of DUID (link layer +/- time)*/
/* hardware_type Network hardware type e.g IEEE 802*/
/* time Time stamp unique DUID identifier */
/* */
/* OUTPUT */
/* */
/* status Actual completion status */
/* NX_PTR_ERROR Invalid pointer input */
/* NX_DHCPV6_PARAM_ERROR Invalid non pointer input */
/* NX_DHCPV6_UNSUPPORTED_DUID_TYPE Unsupported DUID type */
/* NX_DHCPV6_UNSUPPORTED_DUID_HW_TYPE Unsupported DUID hardware type */
/* */
/* CALLS */
/* */
/* _nx_dhcpv6_create_client_duid Actual create client DUID service */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nxe_dhcpv6_create_client_duid(NX_DHCPV6 *dhcpv6_ptr, UINT duid_type, UINT hardware_type, ULONG time)
{
UINT status;
/* Check for invalid pointer input. */
if (!dhcpv6_ptr)
{
return NX_PTR_ERROR;
}
/* Check for valid non pointer input. */
if ((duid_type < NX_DHCPV6_DUID_TYPE_LINK_TIME) || (duid_type > NX_DHCPV6_DUID_TYPE_LINK_ONLY))
{
return NX_DHCPV6_PARAM_ERROR;
}
/* Ethernet is the only a hardware type supported by this API. */
if ((hardware_type != NX_DHCPV6_CLIENT_HARDWARE_TYPE_ETHERNET) && (hardware_type != NX_DHCPV6_CLIENT_HARDWARE_TYPE_EUI_64))
{
/* Return any other type as an error status. */
return NX_DHCPV6_UNSUPPORTED_DUID_HW_TYPE;
}
/* This DUID type is not supported by this API. */
if (duid_type == NX_DHCPV6_DUID_TYPE_VENDOR_ASSIGNED)
{
/* Return as an error status. */
return NX_DHCPV6_UNSUPPORTED_DUID_TYPE;
}
/* Call the actual service. */
status = _nx_dhcpv6_create_client_duid(dhcpv6_ptr, duid_type, hardware_type, time);
return status;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_create_client_duid PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function updates the DHCPv6 client DHCP Unique Identifier */
/* (DUID) with the input values, sets the linklocal address while the */
/* Client does not have an assigned global IP address, after waiting */
/* for the IPv6 thread task to read its MAC address. If the caller */
/* does not supply a time ID, it will generate one in place for Link */
/* Layer Plus Time DUIDs. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPV6 Client instance */
/* duid_type Type of DUID (link layer +/- time)*/
/* hardware_type Network hardware type e.g IEEE 802*/
/* time Time stamp unique DUID identifier */
/* */
/* OUTPUT */
/* */
/* NX_SUCCESS Successful completion status */
/* */
/* CALLS */
/* */
/* memset Clear specified area of memory */
/* rand Generate random number for time ID*/
/* tx_thread_sleep Relinquish thread control (sleep) */
/* nxd_ipv6_linklocal_address_set Use MAC address as temporary IP */
/* source address */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_create_client_duid(NX_DHCPV6 *dhcpv6_ptr, UINT duid_type, UINT hardware_type, ULONG time)
{
NX_INTERFACE *interface_ptr;
USHORT option_length;
/* Set the interface pointer. */
interface_ptr = &(dhcpv6_ptr -> nx_dhcpv6_ip_ptr -> nx_ip_interface[dhcpv6_ptr -> nx_dhcpv6_client_interface_index]);
/* Initialize the DUID to null. */
memset(&(dhcpv6_ptr -> nx_dhcpv6_client_duid), 0, sizeof(NX_DHCPV6_DUID));
/* Assign the DUID op code. */
dhcpv6_ptr -> nx_dhcpv6_client_duid.nx_op_code = NX_DHCPV6_OP_CLIENT_ID;
/* Assign field attributes depending on the DUID type. */
if ((duid_type == NX_DHCPV6_DUID_TYPE_LINK_TIME) || (duid_type == NX_DHCPV6_DUID_TYPE_LINK_ONLY))
{
/* Set the option data length minus the option header and size of the time field. */
dhcpv6_ptr -> nx_dhcpv6_client_duid.nx_duid_type = (USHORT)duid_type;
dhcpv6_ptr -> nx_dhcpv6_client_duid.nx_hardware_type = (USHORT)hardware_type;
option_length = 4;
/* Is the Link Layer Time DUID type? */
if (duid_type == NX_DHCPV6_DUID_TYPE_LINK_TIME)
{
/* Yes; add the size of the time field to the data length. */
option_length = (USHORT)(option_length + 4);
/* Did the caller supplied a time? */
if (!time)
{
/* No, create a time field using the defined time constant plus a randomizing factor.*/
dhcpv6_ptr -> nx_dhcpv6_client_duid.nx_duid_time = (SECONDS_SINCE_JAN_1_2000_MOD_32 + (ULONG)(NX_RAND())) & 0xFFFFFFFF;
}
else
{
/* Apply the input time. */
dhcpv6_ptr -> nx_dhcpv6_client_duid.nx_duid_time = time;
}
}
/* Set the globally unique link layer address. */
dhcpv6_ptr -> nx_dhcpv6_client_duid.nx_link_layer_address_msw = interface_ptr -> nx_interface_physical_address_msw;
dhcpv6_ptr -> nx_dhcpv6_client_duid.nx_link_layer_address_lsw = interface_ptr -> nx_interface_physical_address_lsw;
/* Check the hardware type. */
if (hardware_type == NX_DHCPV6_CLIENT_HARDWARE_TYPE_ETHERNET)
{
/* The length of link layer address is 48 bits. */
option_length = (USHORT)(option_length + 6);
}
else if (hardware_type == NX_DHCPV6_CLIENT_HARDWARE_TYPE_EUI_64)
{
/* The length of link layer address is 64 bits. */
option_length = (USHORT)(option_length + 8);
}
/* Set the option length. */
dhcpv6_ptr -> nx_dhcpv6_client_duid.nx_option_length = option_length;
}
return NX_SUCCESS;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nxe_dhcpv6_add_client_ia PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function performs error checking on the add Client IA */
/* (Identity Association) option service, including checking for invalid*/
/* preferred and valid lifetimes. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPV6 Client instance */
/* ipv6_address Requested IPv6 address */
/* preferred_lifetime Requested IP lease time before */
/* address is deprecated */
/* valid_lifetime Requested IP lease time before */
/* address is expired */
/* */
/* OUTPUT */
/* */
/* status Actual completion status */
/* NX_PTR_ERROR Invalid pointer input */
/* NX_DHCPV6_PARAM_ERROR Invalid non pointer input */
/* */
/* CALLS */
/* */
/* _nx_dhcpv6_add_client_ia Actual add client IA service */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nxe_dhcpv6_add_client_ia(NX_DHCPV6 *dhcpv6_ptr, NXD_ADDRESS *ipv6_address,
ULONG preferred_lifetime, ULONG valid_lifetime)
{
UINT status;
/* Check for invalid pointer input. */
if (!dhcpv6_ptr || !ipv6_address)
{
return NX_PTR_ERROR;
}
/* Make sure the IPv6 address valid. */
if ((ipv6_address -> nxd_ip_address.v6[0] == 0) &&
(ipv6_address -> nxd_ip_address.v6[1] == 0) &&
(ipv6_address -> nxd_ip_address.v6[2] == 0) &&
(ipv6_address -> nxd_ip_address.v6[3] == 0))
{
return NX_DHCPV6_INVALID_IA_ADDRESS;
}
/* Check for valid non pointer input. */
if (preferred_lifetime > valid_lifetime)
{
/* Client preferred time must be less than valid time or
server will reject it. */
return NX_DHCPV6_PARAM_ERROR;
}
/* Check for an empty IANA instance. */
if (!dhcpv6_ptr -> nx_dhcpv6_iana.nx_op_code)
{
return NX_DHCPV6_PARAM_ERROR;
}
/* Call the actual service. */
status = _nx_dhcpv6_add_client_ia(dhcpv6_ptr, ipv6_address, preferred_lifetime, valid_lifetime);
/* Return completion status. */
return status;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_add_client_ia PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function adds the Client Identity Association address with */
/* the input values. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPV6 Client instance */
/* ipv6_address Requested IPv6 address */
/* preferred_lifetime Requested IP lease time before */
/* address is deprecated */
/* valid_lifetime Requested IP lease time before */
/* address is expired */
/* */
/* OUTPUT */
/* */
/* NX_SUCCESS Successful completion status */
/* NX_DHCPV6_REACHED_MAX_IA_ADDRESS No space to record IA address */
/* */
/* CALLS */
/* */
/* memset Clear specified area of memory */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_add_client_ia(NX_DHCPV6 *dhcpv6_ptr, NXD_ADDRESS *ipv6_address,
ULONG preferred_lifetime, ULONG valid_lifetime)
{
UINT ia_index;
/* Perform duplicate address detection. */
for(ia_index = 0; ia_index < NX_DHCPV6_MAX_IA_ADDRESS; ia_index++)
{
if((dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_global_address.nxd_ip_address.v6[0] == ipv6_address->nxd_ip_address.v6[0]) &&
(dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_global_address.nxd_ip_address.v6[1] == ipv6_address->nxd_ip_address.v6[1]) &&
(dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_global_address.nxd_ip_address.v6[2] == ipv6_address->nxd_ip_address.v6[2]) &&
(dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_global_address.nxd_ip_address.v6[3] == ipv6_address->nxd_ip_address.v6[3]))
{
/* The IA address has already exists. */
return (NX_DHCPV6_IA_ADDRESS_ALREADY_EXIST);
}
}
/* Find one valid space to set the IA address. */
for(ia_index = 0; ia_index < NX_DHCPV6_MAX_IA_ADDRESS; ia_index++)
{
if(!dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_address_status)
{
/* Yes, got it. */
break;
}
}
if(ia_index < NX_DHCPV6_MAX_IA_ADDRESS)
{
/* Yes, get it, set the IA address. */
/* Initialize the IA-Address to null. */
memset(&(dhcpv6_ptr -> nx_dhcpv6_ia[ia_index]), 0, sizeof(NX_DHCPV6_IA_ADDRESS));
dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_op_code = NX_DHCPV6_OP_IA_ADDRESS;
/* Set the IA option length - minus the option header. */
dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_option_length = (7 * sizeof(ULONG)) - 4;
/* Set the IP address parameters as a hint to the server. */
dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_global_address.nxd_ip_version = NX_IP_VERSION_V6;
COPY_IPV6_ADDRESS(&(ipv6_address -> nxd_ip_address.v6[0]), &(dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_global_address.nxd_ip_address.v6[0]));
/* Set the life time parameters as a hint to the server. */
dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_preferred_lifetime = preferred_lifetime;
dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_valid_lifetime = valid_lifetime;
dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_address_status = NX_DHCPV6_IA_ADDRESS_STATE_INITIAL;
return NX_SUCCESS;
}
else
{
return NX_DHCPV6_REACHED_MAX_IA_ADDRESS;
}
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nxe_dhcpv6_create_client_iana PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function performs error checking on the create Client IA-NA */
/* option service, including checking for invalid T1 and T2 times. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPV6 Client instance */
/* IA_ident Interface Association ID */
/* T1 Requested lease time with server */
/* assigning IP (renew) */
/* T2 Requested lease time with any */
/* other server (rebind) */
/* */
/* OUTPUT */
/* */
/* status Actual completion status */
/* NX_PTR_ERROR Invalid pointer input */
/* NX_DHCPV6_PARAM_ERROR Invalid non pointer input */
/* */
/* CALLS */
/* */
/* _nx_dhcpv6_create_client_iana Actual create client IANA service */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nxe_dhcpv6_create_client_iana(NX_DHCPV6 *dhcpv6_ptr, UINT IA_ident, ULONG T1, ULONG T2)
{
UINT status;
/* Check for invalid pointer input. */
if (!dhcpv6_ptr || !IA_ident)
{
return NX_PTR_ERROR;
}
/* Check for valid non pointer input. */
if (T1 > T2)
{
/* Client preferred time must be less than valid time or server will reject it. */
return NX_DHCPV6_PARAM_ERROR;
}
/* Call the actual service. */
status = _nx_dhcpv6_create_client_iana(dhcpv6_ptr, IA_ident, T1, T2);
/* Return completion status. */
return status;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_create_client_iana PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function updates the Client's Identity Association for Non */
/* Temporary Address (IANA) with the input values. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPV6 Client instance */
/* IA_ident Interface Association ID */
/* T1 Requested lease time with server */
/* assigning IP (renew) */
/* T2 Requested lease time with any */
/* other server (rebind) */
/* */
/* OUTPUT */
/* */
/* NX_SUCCESS Successful completion status */
/* */
/* CALLS */
/* */
/* memset Clear specified area of memory */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_create_client_iana(NX_DHCPV6 *dhcpv6_ptr, UINT IA_ident, ULONG T1, ULONG T2)
{
/* Initialize the IANA to null. */
memset(&(dhcpv6_ptr -> nx_dhcpv6_iana), 0, sizeof(NX_DHCPV6_IA_NA));
/* Assign the IANA attributes. */
dhcpv6_ptr -> nx_dhcpv6_iana.nx_op_code = NX_DHCPV6_OP_IA_NA;
dhcpv6_ptr -> nx_dhcpv6_iana.nx_IA_NA_id = IA_ident;
/* Set the IANA option data length, minus the option header. */
dhcpv6_ptr -> nx_dhcpv6_iana.nx_option_length = 3 * sizeof(ULONG);
/* Apply the Client's preference for IP renew/rebind times. */
dhcpv6_ptr -> nx_dhcpv6_iana.nx_T1 = T1;
dhcpv6_ptr -> nx_dhcpv6_iana.nx_T2 = T2;
return NX_SUCCESS;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nxe_dhcpv6_get_client_duid_time_id PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function performs error checking on the get Client DUID time ID*/
/* service. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPv6 Client */
/* time_id Pointer to DUID time field */
/* */
/* OUTPUT */
/* */
/* status Actual completion status */
/* NX_PTR_ERROR Invalid pointer input */
/* */
/* CALLS */
/* */
/* _nx_dhcpv6_get_client_duid_time_id Actual get Client DUID time ID */
/* service */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nxe_dhcpv6_get_client_duid_time_id(NX_DHCPV6 *dhcpv6_ptr, ULONG *time_id)
{
UINT status;
/* Check for valid pointer input. */
if (!dhcpv6_ptr || !time_id)
{
return NX_PTR_ERROR;
}
/* Check for appropriate caller. */
NX_THREADS_ONLY_CALLER_CHECKING
/* Call the actual service. */
status = _nx_dhcpv6_get_client_duid_time_id(dhcpv6_ptr, time_id);
/* Return completion status. */
return status;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_get_client_duid_time_id PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function retrieves the Client DUID time ID saved to the client */
/* record. It does not check if the DUID is properly filled out. It is*/
/* up to the caller to check for a zero value (invalid) time ID. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPv6 Client */
/* time_id Pointer to DUID time field */
/* */
/* OUTPUT */
/* */
/* status Actual completion status */
/* NX_PTR_ERROR Invalid pointer input */
/* */
/* CALLS */
/* */
/* _nx_dhcpv6_get_client_duid_time_id Actual get Client DUID time ID */
/* service */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_get_client_duid_time_id(NX_DHCPV6 *dhcpv6_ptr, ULONG *time_id)
{
/* The Time field is part of the NX_DHCPV6_DUID struct in the Client record. */
*time_id = dhcpv6_ptr -> nx_dhcpv6_client_duid.nx_duid_time;
/* Return successful completion. */
return NX_SUCCESS;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_register_IP_address PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function registers the assigned IP address to the IP task, */
/* which adds the input address to the IP address table.In either case,*/
/* the address index in the IP address table is recorded to the Client */
/* record.It will require it if the DHCPv6 Client wants to clear the */
/* IPv6 address. */
/* */
/* Note: the host application should perform address verification */
/* e.g. Duplicate Address Detection to verify uniqueness of the input */
/* address. If duplicate address detection is enabled in NetX Duo this */
/* is done automatically. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPv6 Client */
/* */
/* OUTPUT */
/* */
/* status Actual completion status */
/* */
/* CALLS */
/* */
/* _nxd_ipv6_address_set Add global address to IP */
/* tx_mutex_get Get the DHCPv6 mutex */
/* tx_mutex_put Put the DHCPv6 mutex */
/* */
/* CALLED BY */
/* */
/* nx_dhcpv6_process Process received packets */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_register_IP_address(NX_DHCPV6 *dhcpv6_ptr)
{
UINT status;
UINT address_index;
UINT ia_index;
/* Set the DHCPv6 Client IPv6 addresses. */
for(ia_index = 0; ia_index < NX_DHCPV6_MAX_IA_ADDRESS; ia_index++)
{
if(dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_address_status == NX_DHCPV6_IA_ADDRESS_STATE_INITIAL)
{
/* Add the address to the IP instance address table. */
status = nxd_ipv6_address_set(dhcpv6_ptr -> nx_dhcpv6_ip_ptr, dhcpv6_ptr -> nx_dhcpv6_client_interface_index,
&dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_global_address, 64, &address_index);
/* Check for successful result. */
if (status == NX_SUCCESS)
{
/* Get the mutex protection for DHCP client. */
tx_mutex_get(&(dhcpv6_ptr -> nx_dhcpv6_client_mutex), NX_DHCPV6_MUTEX_WAIT);
#if !defined (NX_DISABLE_IPV6_DAD) && defined (NX_ENABLE_IPV6_ADDRESS_CHANGE_NOTIFY)
/* Set the IPv6 address status as DAD tentative, the status will be updated in _nx_dhcpv6_ipv6_address_DAD_notify. */
dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_address_status = NX_DHCPV6_IA_ADDRESS_STATE_DAD_TENTATIVE;
#else
/* Set the IPv6 address status as valid. */
dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_address_status = NX_DHCPV6_IA_ADDRESS_STATE_VALID;
#endif
/* Record the address index in the Client record. */
dhcpv6_ptr -> nx_dhcpv6_client_address_index[ia_index] = address_index;
/* All done! Release the mutex.*/
tx_mutex_put(&dhcpv6_ptr -> nx_dhcpv6_client_mutex);
}
}
}
/* Add the default router. */
nxd_ipv6_default_router_add(dhcpv6_ptr -> nx_dhcpv6_ip_ptr, &(dhcpv6_ptr-> nx_dhcpv6_server_address),
NX_WAIT_FOREVER, dhcpv6_ptr -> nx_dhcpv6_client_interface_index);
return NX_SUCCESS;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nxe_dhcpv6_get_IP_address PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function performs error checking on the get Client global IP */
/* address service. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPv6 Client */
/* ip_address Pointer to global IP address */
/* */
/* OUTPUT */
/* */
/* status Actual completion status */
/* NX_PTR_ERROR Invalid pointer input */
/* */
/* CALLS */
/* */
/* _nx_dhcpv6_get_IP_address Actual get Client global IP */
/* address service */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nxe_dhcpv6_get_IP_address(NX_DHCPV6 *dhcpv6_ptr, NXD_ADDRESS *ip_address)
{
UINT status;
/* Check for valid pointer input. */
if (!dhcpv6_ptr || !ip_address)
{
return NX_PTR_ERROR;
}
/* Check for appropriate caller. */
NX_THREADS_ONLY_CALLER_CHECKING
/* Call the actual service. */
status = _nx_dhcpv6_get_IP_address(dhcpv6_ptr, ip_address);
/* Return completion status. */
return status;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_get_IP_address PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function retrieves the IP address from the DHCPv6 */
/* Client record. If the client address is not valid, a null IP */
/* address is returned and an error status is set. */
/* */
/* Note that if the Client has received an IP address from the DHCPv6 */
/* server the host must register that ddress with NetX Duo by calling */
/* address with NetX Duo by calling the service nxd_ipv6_address_set. */
/* Once the address is registered, the host can confirm its address by */
/* calling nxd_ipv6_address_get. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPv6 Client */
/* ip_address Pointer to NetX Duo address */
/* */
/* OUTPUT */
/* */
/* NX_SUCCESS Returned non zero IP address */
/* NX_DHCPV6_IA_ADDRESS_NOT_VALID Client not assigned an address */
/* */
/* CALLS */
/* */
/* None */
/* */
/* CALLED BY */
/* */
/* Application */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_get_IP_address(NX_DHCPV6 *dhcpv6_ptr, NXD_ADDRESS *ip_address)
{
UINT status;
/* Clear the address buffer. */
SET_UNSPECIFIED_ADDRESS(&ip_address -> nxd_ip_address.v6[0]);
/* Initialize the outcome as no address assigned. */
status = NX_DHCPV6_IA_ADDRESS_NOT_VALID;
/* Is the client assigned a valid address? */
if (dhcpv6_ptr -> nx_dhcpv6_ia[0].nx_address_status == NX_DHCPV6_IA_ADDRESS_STATE_VALID)
{
/* Yes; return the assigned IP address from the DHCPv6 Client record. */
COPY_IPV6_ADDRESS(&(dhcpv6_ptr -> nx_dhcpv6_ia[0].nx_global_address.nxd_ip_address.v6[0]),
&(ip_address -> nxd_ip_address.v6[0]));
status = NX_SUCCESS;
}
return status;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nxe_dhcpv6_get_lease_time_data PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function performs error checking on the get Client IP lease */
/* time service. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPv6 Client */
/* T1 Pointer to T1 time */
/* T2 Pointer to T2 time */
/* preferred_lifetime Pointer to preferred lifetime */
/* valid_lifetime Pointer to valid lifetime */
/* */
/* OUTPUT */
/* */
/* status Actual completion status */
/* NX_PTR_ERROR Invalid pointer input */
/* */
/* CALLS */
/* */
/* _nx_dhcpv6_get_lease_time_data Actual get Client IP lease time */
/* service */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nxe_dhcpv6_get_lease_time_data(NX_DHCPV6 *dhcpv6_ptr, ULONG *T1, ULONG *T2, ULONG *preferred_lifetime,
ULONG *valid_lifetime)
{
UINT status;
/* Check for valid pointer input. */
if (!dhcpv6_ptr || !T1 || !T2 || !preferred_lifetime || !valid_lifetime )
{
return NX_PTR_ERROR;
}
/* Check for appropriate caller. */
NX_THREADS_ONLY_CALLER_CHECKING
/* Call the actual service. */
status = _nx_dhcpv6_get_lease_time_data(dhcpv6_ptr, T1, T2, preferred_lifetime, valid_lifetime);
/* Return completion status. */
return status;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_get_lease_time_data PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function retrieves the Client's global IP lease times T1 and T2*/
/* and valid and preferred lifetimes. The address_status input field */
/* indicates if the IP address on the Client record is valid and */
/* registered. If so the lease and valid lifetimes are also registered */
/* with the server (not merely Client preference or left over from an */
/* expired IP address). */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPv6 Client */
/* T1 Pointer to T1 time */
/* T2 Pointer to T2 time */
/* preferred_lifetime Pointer to preferred lifetime */
/* valid_lifetime Pointer to valid lifetime */
/* */
/* OUTPUT */
/* */
/* NX_SUCCESS Successful completion status */
/* */
/* CALLS */
/* */
/* None */
/* */
/* CALLED BY */
/* */
/* Application */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_get_lease_time_data(NX_DHCPV6 *dhcpv6_ptr, ULONG *T1, ULONG *T2, ULONG *preferred_lifetime,
ULONG *valid_lifetime)
{
/* Initialize data to zero. */
*T1 = 0;
*T2 = 0;
*valid_lifetime = 0;
*preferred_lifetime = 0;
/* If the client has a valid IP address status, return the actual lease time data. */
if (dhcpv6_ptr -> nx_dhcpv6_ia[0].nx_address_status == NX_DHCPV6_IA_ADDRESS_STATE_VALID)
{
/* Get the time data from the Client record IA. */
*T1 = dhcpv6_ptr -> nx_dhcpv6_iana.nx_T1;
*T2 = dhcpv6_ptr -> nx_dhcpv6_iana.nx_T2;
*preferred_lifetime = dhcpv6_ptr -> nx_dhcpv6_ia[0].nx_preferred_lifetime;
*valid_lifetime = dhcpv6_ptr -> nx_dhcpv6_ia[0].nx_valid_lifetime;
}
/* Return successful completion. */
return NX_SUCCESS;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nxe_dhcpv6_get_DNS_server_address PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPv6 Client */
/* index Index into DNS server list */
/* server_address Pointer to copy address to */
/* */
/* OUTPUT */
/* */
/* NX_SUCCESS Successful completion status */
/* NX_PTR_ERROR Invalid pointer input */
/* */
/* CALLS */
/* _nx_dhcpv6_get_DNS_server_address Actual get DNS server address */
/* service */
/* */
/* CALLED BY */
/* */
/* Application */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nxe_dhcpv6_get_DNS_server_address(NX_DHCPV6 *dhcpv6_ptr, UINT index, NXD_ADDRESS *server_address)
{
UINT status;
/* Check for valid pointer input. */
if (dhcpv6_ptr == NX_NULL)
{
return NX_PTR_ERROR;
}
/* Check for appropriate caller. */
NX_THREADS_ONLY_CALLER_CHECKING
/* Call the actual service. */
status = _nx_dhcpv6_get_DNS_server_address(dhcpv6_ptr, index, server_address);
/* Return completion status. */
return status;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_get_DNS_server_address PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function retrieves the DNS server address at the specified */
/* index in the DHCP Client DNS list. The Client DNS server list is */
/* compiled from DHCP Server messages supplying DNS server address */
/* data. */
/* */
/* Note: the DHCPv6 Client is configured to store up to */
/* NX_DHCPV6_NUM_DNS_SERVERS DNS server addresses. It is up to the */
/* caller to supply the index to get each server in the list if there */
/* is more than one stored. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPv6 Client */
/* index Index into DNS server list */
/* server_address Pointer to copy address to */
/* */
/* OUTPUT */
/* */
/* NX_SUCCESS Successful completion status */
/* NX_DHCPV6_PARAM_ERROR Invalid index supplied */
/* */
/* CALLS */
/* */
/* _nx_dhcpv6_get_DNS_server_address Actual get DNS server address */
/* service */
/* */
/* CALLED BY */
/* */
/* Application */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_get_DNS_server_address(NX_DHCPV6 *dhcpv6_ptr, UINT index, NXD_ADDRESS *server_address)
{
/* Check for a valid input. */
if (index >= NX_DHCPV6_NUM_DNS_SERVERS)
{
return NX_DHCPV6_PARAM_ERROR;
}
/* Store the specified DNS server addresses in the DHCPv6 Client list. */
COPY_NXD_ADDRESS(&(dhcpv6_ptr -> nx_dhcpv6_DNS_name_server_address[index]), server_address);
return NX_SUCCESS;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nxe_dhcpv6_get_time_server_address PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPv6 Client */
/* index Index into time server list */
/* server_address Pointer to copy address to */
/* */
/* OUTPUT */
/* */
/* NX_SUCCESS Successful completion status */
/* NX_PTR_ERROR Invalid pointer input */
/* */
/* CALLS */
/* _nx_dhcpv6_get_time_server_address Actual get time server address */
/* service */
/* */
/* CALLED BY */
/* */
/* Application */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nxe_dhcpv6_get_time_server_address(NX_DHCPV6 *dhcpv6_ptr, UINT index, NXD_ADDRESS *server_address)
{
UINT status;
/* Check for valid pointer input. */
if (dhcpv6_ptr == NX_NULL)
{
return NX_PTR_ERROR;
}
/* Check for appropriate caller. */
NX_THREADS_ONLY_CALLER_CHECKING
/* Call the actual service. */
status = _nx_dhcpv6_get_time_server_address(dhcpv6_ptr, index, server_address);
/* Return completion status. */
return status;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_get_time_server_address PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function retrieves the time server address at the specified */
/* index in the DHCP Client time list. The Client time server list is */
/* compiled from DHCP Server messages supplying time server address */
/* data. */
/* */
/* Note: the DHCPv6 Client is configured to store up to */
/* NX_DHCPV6_NUM_TIME_SERVERS TIME server addresses. It is up to the */
/* caller to supply the index to get each server in the list if there */
/* is more than one stored. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPv6 Client */
/* index Index into time server list */
/* server_address Pointer to copy address to */
/* */
/* OUTPUT */
/* */
/* NX_SUCCESS Successful completion status */
/* NX_DHCPV6_PARAM_ERROR Invalid index supplied */
/* */
/* CALLS */
/* */
/* _nx_dhcpv6_get_time_server_address Actual get time server address */
/* service */
/* */
/* CALLED BY */
/* */
/* Application */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_get_time_server_address(NX_DHCPV6 *dhcpv6_ptr, UINT index, NXD_ADDRESS *server_address)
{
/* Check for a valid input. */
if (index >= NX_DHCPV6_NUM_TIME_SERVERS)
{
return NX_DHCPV6_PARAM_ERROR;
}
/* Store the specified time server addresses in the DHCPv6 Client list. */
COPY_NXD_ADDRESS(&(dhcpv6_ptr -> nx_dhcpv6_time_server_address[index]), server_address);
return NX_SUCCESS;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nxe_dhcpv6_get_other_option_data PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPv6 Client */
/* option_code Option code of requested data */
/* buffer Buffer to copy data to */
/* buffer_length Size of buffer to copy to */
/* */
/* OUTPUT */
/* */
/* status Completion status */
/* NX_PTR_ERROR Invalid pointer input */
/* NX_DHCPV6_PARAM_ERROR Invalid non pointer input */
/* */
/* CALLS */
/* _nx_dhcpv6_get_other_option_data Actual get other option data */
/* service */
/* */
/* CALLED BY */
/* */
/* Application */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nxe_dhcpv6_get_other_option_data(NX_DHCPV6 *dhcpv6_ptr, UINT option_code, UCHAR *buffer,UINT buffer_length)
{
UINT status;
/* Check for valid pointer input. */
if (!dhcpv6_ptr || !buffer)
{
return NX_PTR_ERROR;
}
/* Check for invalid non pointer input. */
if (!option_code || !buffer_length)
{
return NX_DHCPV6_PARAM_ERROR;
}
/* Check for appropriate caller. */
NX_THREADS_ONLY_CALLER_CHECKING
/* Call the actual service. */
status = _nx_dhcpv6_get_other_option_data(dhcpv6_ptr, option_code, buffer, buffer_length);
/* Return completion status. */
return status;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_get_other_option_data PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function retrieves the option information requested in the */
/* input parameter. Note that there are only 2 options which the */
/* NetX DHCPv6 client supports. Some options have their own specific */
/* API such as _nx_dhcpv6_get_DNS_server_address. The complete list */
/* of options is not supported by the NetX Duo DHCPv6 Client. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPv6 Client */
/* option_code Option code of requested data */
/* buffer Buffer to copy data to */
/* buffer_length Size of buffer to copy to */
/* */
/* OUTPUT */
/* */
/* status Completion status */
/* NX_DHCPV6_UNKNOWN_OPTION Unknown option specified */
/* */
/* CALLS */
/* */
/* memcpy Copy specified area of memory */
/* */
/* CALLED BY */
/* */
/* Application */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), and */
/* verified memcpy use cases, */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_get_other_option_data(NX_DHCPV6 *dhcpv6_ptr, UINT option_code, UCHAR *buffer, UINT buffer_length)
{
UINT length = 0;
/* Check to see which option data is requested: */
switch (option_code)
{
case NX_DHCPV6_NEW_POSIX_TIMEZONE_OPTION:
/* Update the amount of data we are copying into the buffer. */
length += NX_DHCPV6_TIME_ZONE_BUFFER_SIZE;
/* Check that we don't overrun the buffer. */
if (length > buffer_length)
{
return NX_DHCPV6_INVALID_DATA_SIZE;
}
/* Copy the time zone data to the supplied buffer. */
memcpy(buffer, dhcpv6_ptr -> nx_dhcpv6_time_zone, NX_DHCPV6_TIME_ZONE_BUFFER_SIZE); /* Use case of memcpy is verified. */
break;
case NX_DHCPV6_DOMAIN_NAME_OPTION:
/* Update the amount of data we are copying into the buffer. */
length += NX_DHCPV6_DOMAIN_NAME_BUFFER_SIZE;
/* Check that we don't overrun the buffer. */
if (length > buffer_length)
{
return NX_DHCPV6_INVALID_DATA_SIZE;
}
/* Copy the domain name data to the supplied buffer. */
memcpy(buffer, dhcpv6_ptr -> nx_dhcpv6_domain_name, NX_DHCPV6_DOMAIN_NAME_BUFFER_SIZE); /* Use case of memcpy is verified. */
break;
/* Unknown or unsupported option*/
default:
return NX_DHCPV6_UNKNOWN_OPTION;
}
return NX_SUCCESS;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nxe_dhcpv6_get_time_accrued PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function performs error checking on the get time accrued on */
/* Client IP lease service. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPv6 Client */
/* time_accrued Pointer to time since IP lease */
/* assigned (secs) */
/* */
/* OUTPUT */
/* */
/* status Actual completion status */
/* NX_PTR_ERROR Invalid pointer input */
/* */
/* CALLS */
/* */
/* _nx_dhcpv6_get_time_accrued Actual get time accrued on Client */
/* IP address lease service */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nxe_dhcpv6_get_time_accrued(NX_DHCPV6 *dhcpv6_ptr, ULONG *time_accrued)
{
UINT status;
/* Check for valid pointer input. */
if (!dhcpv6_ptr || !time_accrued)
{
return NX_PTR_ERROR;
}
/* Check for appropriate caller. */
NX_THREADS_ONLY_CALLER_CHECKING
/* Call the actual service. */
status = _nx_dhcpv6_get_time_accrued(dhcpv6_ptr, time_accrued);
/* Return completion status. */
return status;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_get_time_accrued PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function retrieves the time accrued on the assigned global IP */
/* address lease. IP address to verify the address is still valid. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPv6 Client */
/* time_accrued Pointer to time since IP lease */
/* assigned (secs) */
/* */
/* OUTPUT */
/* */
/* NX_SUCCESS Successful completion status */
/* */
/* CALLS */
/* */
/* tx_mutex_get Obtain exclusive lock on Client */
/* time accrued variable */
/* tx_mutex_put Release exclusive lock in Client */
/* time variable */
/* */
/* CALLED BY */
/* */
/* Application */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_get_time_accrued(NX_DHCPV6 *dhcpv6_ptr, ULONG *time_accrued)
{
UINT ia_index;
UINT found_ia = 0;
/* Initialize the time accrued to zero. */
*time_accrued = 0;
/* Check if the client currently has a valid IP address assigned. */
for(ia_index = 0; ia_index < NX_DHCPV6_MAX_IA_ADDRESS; ia_index++)
{
if(dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_address_status == NX_DHCPV6_IA_ADDRESS_STATE_VALID)
{
/* Yes, got it. */
found_ia= 1;
break;
}
}
if(found_ia == 1)
{
/* Get the time accrued on the IP address lease. */
*time_accrued = dhcpv6_ptr -> nx_dhcpv6_IP_lifetime_time_accrued;
}
/* Return successful completion. */
return NX_SUCCESS;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nxe_dhcpv6_get_iana_lease_time PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function performs error checking on the get T1 and T2 value */
/* of IANA option. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPv6 Client */
/* T1 Pointer to T1 time */
/* T2 Pointer to T2 time */
/* */
/* OUTPUT */
/* */
/* status Actual completion status */
/* NX_PTR_ERROR Invalid pointer input */
/* */
/* CALLS */
/* */
/* _nx_dhcpv6_get_iana_lease_time Actual get Client IP T1/T2 time */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nxe_dhcpv6_get_iana_lease_time(NX_DHCPV6 *dhcpv6_ptr, ULONG *T1, ULONG *T2)
{
UINT status;
/* Check for valid pointer input. */
if (!dhcpv6_ptr || !T1 || !T2)
{
return NX_PTR_ERROR;
}
/* Check for appropriate caller. */
NX_THREADS_ONLY_CALLER_CHECKING
/* Call the actual service. */
status = _nx_dhcpv6_get_iana_lease_time(dhcpv6_ptr, T1, T2);
/* Return completion status. */
return status;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_get_iana_lease_time PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function retrieves the T1 and T2 of Client's global IP. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPv6 Client */
/* T1 Pointer to T1 time */
/* T2 Pointer to T2 time */
/* */
/* OUTPUT */
/* */
/* NX_SUCCESS Successful completion status */
/* */
/* CALLS */
/* */
/* None */
/* */
/* CALLED BY */
/* */
/* Application */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_get_iana_lease_time(NX_DHCPV6 *dhcpv6_ptr, ULONG *T1, ULONG *T2)
{
UINT ia_index;
UINT found_ia = 0;
/* Initialize data to zero. */
*T1 = 0;
*T2 = 0;
/* Check if the client currently has a valid IP address assigned. */
for(ia_index = 0; ia_index < NX_DHCPV6_MAX_IA_ADDRESS; ia_index++)
{
if(dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_address_status == NX_DHCPV6_IA_ADDRESS_STATE_VALID)
{
/* Yes, got it. */
found_ia= 1;
break;
}
}
if(found_ia == 1)
{
/* Get the time data from the Client record IA. */
*T1 = dhcpv6_ptr -> nx_dhcpv6_iana.nx_T1;
*T2 = dhcpv6_ptr -> nx_dhcpv6_iana.nx_T2;
}
/* Return successful completion. */
return NX_SUCCESS;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nxe_dhcpv6_get_valid_ip_address_count PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function performs error checking on the get valid IP address */
/* count. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPv6 Client */
/* address_count The count of valid IP address */
/* */
/* OUTPUT */
/* */
/* status Actual completion status */
/* NX_PTR_ERROR Invalid pointer input */
/* */
/* CALLS */
/* */
/* _nx_dhcpv6_get_valid_ip_address_count */
/* Actual get the valid IP count */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nxe_dhcpv6_get_valid_ip_address_count(NX_DHCPV6 *dhcpv6_ptr, UINT *address_count)
{
UINT status;
/* Check for valid pointer input. */
if (!dhcpv6_ptr || !address_count)
{
return NX_PTR_ERROR;
}
/* Check for appropriate caller. */
NX_THREADS_ONLY_CALLER_CHECKING
/* Call the actual service. */
status = _nx_dhcpv6_get_valid_ip_address_count(dhcpv6_ptr, address_count);
/* Return completion status. */
return status;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_get_valid_ip_address_count PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function retrieves the Client's global IP, then record the */
/* count of valid IP address */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPv6 Client */
/* address_count The count of valid IP address */
/* */
/* OUTPUT */
/* */
/* NX_SUCCESS Successful completion status */
/* */
/* CALLS */
/* */
/* None */
/* */
/* CALLED BY */
/* */
/* Application */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_get_valid_ip_address_count(NX_DHCPV6 *dhcpv6_ptr, UINT *address_count)
{
UINT ia_index;
/* Initialize data to zero. */
*address_count = 0;
/* Check if the client currently has a valid IP address assigned. */
for(ia_index = 0; ia_index < NX_DHCPV6_MAX_IA_ADDRESS; ia_index++)
{
if(dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_address_status == NX_DHCPV6_IA_ADDRESS_STATE_VALID)
{
/* Yes, get one, update the count. */
(*address_count)++;
}
}
/* Return successful completion. */
return NX_SUCCESS;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nxe_dhcpv6_get_valid_ip_address_lease_time PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function performs error checking on the get valid IP address, */
/* the preferred lifetime and the valid lifetime by the address index. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPv6 Client */
/* address_index The valid address index */
/* ip_address Pointer to IP address */
/* preferred_lifetime Pointer to preferred lifetime */
/* valid_lifetime Pointer to valid lifetime */
/* */
/* OUTPUT */
/* */
/* status Actual completion status */
/* NX_PTR_ERROR Invalid pointer input */
/* */
/* CALLS */
/* */
/* _nx_dhcpv6_get_lvalid_ip_address_lease_time */
/* Actual get Client IP valid address*/
/* and the lease time of IP */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nxe_dhcpv6_get_valid_ip_address_lease_time(NX_DHCPV6 *dhcpv6_ptr, UINT address_index, NXD_ADDRESS *ip_address,
ULONG *preferred_lifetime, ULONG *valid_lifetime)
{
UINT status;
/* Check for valid pointer input. */
if (!dhcpv6_ptr || !ip_address || !preferred_lifetime || !valid_lifetime )
{
return NX_PTR_ERROR;
}
/* Check for appropriate caller. */
NX_THREADS_ONLY_CALLER_CHECKING
/* Call the actual service. */
status = _nx_dhcpv6_get_valid_ip_address_lease_time(dhcpv6_ptr, address_index, ip_address, preferred_lifetime, valid_lifetime);
/* Return completion status. */
return status;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_get_valid_ip_address_lease_time PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function retrieves the Client's valid global IP addresses, */
/* preferred lifetime and valid lifetime by address index. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPv6 Client */
/* address_index The valid address index */
/* ip_address Pointer to IPv6 address */
/* preferred_lifetime Pointer to preferred lifetime */
/* valid_lifetime Pointer to valid lifetime */
/* */
/* OUTPUT */
/* */
/* NX_SUCCESS Successful completion status */
/* */
/* CALLS */
/* */
/* None */
/* */
/* CALLED BY */
/* */
/* Application */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_get_valid_ip_address_lease_time(NX_DHCPV6 *dhcpv6_ptr, UINT address_index, NXD_ADDRESS *ip_address,
ULONG *preferred_lifetime, ULONG *valid_lifetime)
{
UINT status;
UINT ia_index;
UINT valid_ia_count;
/* Initialize data to zero. */
valid_ia_count = 0;
*valid_lifetime = 0;
*preferred_lifetime = 0;
status = NX_DHCPV6_IA_ADDRESS_NOT_VALID;
/* Clear the address buffer. */
SET_UNSPECIFIED_ADDRESS(&ip_address -> nxd_ip_address.v6[0]);
/* Check if the client currently has a valid IP address assigned. */
for(ia_index = 0; ia_index < NX_DHCPV6_MAX_IA_ADDRESS; ia_index++)
{
/* Skip empty or invalidated addresses. */
if(dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_address_status == NX_DHCPV6_IA_ADDRESS_STATE_VALID)
{
if((valid_ia_count++) == address_index)
{
/* Yes, got it. */
break;
}
}
}
if(ia_index < NX_DHCPV6_MAX_IA_ADDRESS)
{
/* Yes; return the assigned IP address from the DHCPv6 Client record. */
COPY_IPV6_ADDRESS(&(dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_global_address.nxd_ip_address.v6[0]),
&(ip_address -> nxd_ip_address.v6[0]));
/* Set the IP version. */
ip_address -> nxd_ip_version = NX_IP_VERSION_V6;
/* Return the preferred lifetime and valid lifetime. */
*preferred_lifetime = dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_preferred_lifetime;
*valid_lifetime = dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_valid_lifetime;
status = NX_SUCCESS;
}
/* Return. */
return status;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_IP_lifetime_timeout_entry PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function is scheduled by the ThreadX scheduler on a user */
/* configurable time interval. It updates the time accrued since the */
/* Client was assigned its global IP address so that the DHCP Client */
/* knows when to renew or rebind its IP address. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr_value Pointer to the DHCPV6 Client */
/* */
/* OUTPUT */
/* */
/* None */
/* */
/* CALLS */
/* */
/* None */
/* */
/* CALLED BY */
/* */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
VOID _nx_dhcpv6_IP_lifetime_timeout_entry(ULONG dhcpv6_ptr_value)
{
NX_DHCPV6 *dhcpv6_ptr;
/* Setup DHCPv6 Client pointer. */
NX_TIMER_EXTENSION_PTR_GET(dhcpv6_ptr, NX_DHCPV6, dhcpv6_ptr_value)
/* Check if the DHCPv6 Client has valid IP address assigned and a finite IP
address lease (no point in waiting for an infinite lease to time out!) */
if ((dhcpv6_ptr -> nx_dhcpv6_iana.nx_T1 != NX_DHCPV6_INFINITE_LEASE) &&
(dhcpv6_ptr -> nx_dhcpv6_iana.nx_T1 != 0))
{
/* Update the time remaining on the Client IP address lease.
The current time expressed in units of seconds. */
dhcpv6_ptr -> nx_dhcpv6_IP_lifetime_time_accrued += NX_DHCPV6_IP_LIFETIME_TIMER_INTERVAL;
}
return;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_process PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function executes the DHCPV6 Client request. It compiles */
/* and sends the DHCPv6 request message, and updates the Client record */
/* with server data. It maintains the DHCPv6 Client state and calls */
/* the state change callback if one is registered with the DHCPv6 */
/* Client. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPV6 Client instance */
/* */
/* OUTPUT */
/* */
/* None */
/* */
/* CALLS */
/* */
/* _nx_dhcpv6_send_request Send the Client DHCPv6 request */
/* _nx_dhcpv6_waiting_on_reply Wait for valid DHCPv6 server reply*/
/* _nx_dhcpv6_request_decline Send the DHCPv6 DECLINE request */
/* _nx_dhcpv6_register_IP_address Register Client IP address */
/* _nx_dhcpv6_remove_assigned_address */
/* Remove Client global IP address */
/* _nx_dhcpv6_update_retransmit_info Update the retransmit information */
/* _nx_dhcpv6_send_solicit Send the DHCPv6 solicit message */
/* _nx_dhcpv6_flush_queue_packets Flush the queue packets */
/* tx_mutex_get Obtain lock on Client resource */
/* tx_mutex_put Release lock on Client resourse */
/* tx_timer_deactivate Deactivate the session timer */
/* */
/* CALLED BY */
/* */
/* _nx_dhcpv6_thread_entry Processing thread for DHCPv6 */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
VOID _nx_dhcpv6_process(NX_DHCPV6 *dhcpv6_ptr)
{
UINT status;
UCHAR original_state;
/* Initialize the DHCPv6 Client status as no errors. */
dhcpv6_ptr -> nx_status_code = NX_DHCPV6_SUCCESS;
/* Clear any previous messages from the DHCPv6 server. */
memset(dhcpv6_ptr -> nx_status_message, 0, NX_DHCPV6_MAX_MESSAGE_SIZE);
/* Remember the original DHCPv6 state for the changed state callback function. */
original_state = dhcpv6_ptr -> nx_dhcpv6_state;
/* Process the DHCPv6 Client for the state it is in. */
switch (dhcpv6_ptr -> nx_dhcpv6_state)
{
/* The DHCPv6 remains initial status or DHCPv6 interactive process has completed.
Just clear the timer and message ID. */
case NX_DHCPV6_STATE_INIT:
case NX_DHCPV6_STATE_BOUND_TO_ADDRESS:
{
/* Clear the message id. */
dhcpv6_ptr -> nx_dhcpv6_message_hdr.nx_message_xid = 0;
/* Deactivate the session timer of elapsed time. */
tx_timer_deactivate(&(dhcpv6_ptr -> nx_dhcpv6_session_timer));
/* Flush the queue packets. */
_nx_dhcpv6_flush_queue_packets(dhcpv6_ptr);
return;
}
/* The caller has requested to send a solicit message. */
case NX_DHCPV6_STATE_SENDING_SOLICIT:
{
dhcpv6_ptr -> nx_dhcpv6_message_hdr.nx_message_type = NX_DHCPV6_MESSAGE_TYPE_SOLICIT;
dhcpv6_ptr -> nx_dhcpv6_solicitations_sent++;
/* Send the DHCPV6 Solicit message. */
status = _nx_dhcpv6_send_request(dhcpv6_ptr);
/* Check for error. */
if (status != NX_SUCCESS)
{
/* Return. Can't do any more now. */
return;
}
/* Make sure the server DUID is cleared. Client should be accepting any server reply. */
memset(&(dhcpv6_ptr -> nx_dhcpv6_server_duid), 0, sizeof(NX_DHCPV6_DUID));
/* Wait for a reply from the server. This will also extract the
server packet information and update the DHCPv6 Client record (and state). */
status = _nx_dhcpv6_waiting_on_reply(dhcpv6_ptr);
/* Check for processing error or error code sent by server. As per RFC 3315 section 17.1.3,
the Client ignores status errors (e.g. No Addresses Available) from the server, and continues
sending Solicit messages. */
if ((status != NX_SUCCESS) || (dhcpv6_ptr -> nx_status_code != NX_DHCPV6_SUCCESS))
{
/* Update the retransmission information. */
if (_nx_dhcpv6_update_retransmit_info(dhcpv6_ptr))
{
/* The retry limit on Solicit messages is exceeded. Set the CLient back to
the INIT state and stop sending solicit messages for now. */
dhcpv6_ptr -> nx_dhcpv6_state = NX_DHCPV6_STATE_INIT;
/* Request attempt failed. The state change callback if set will be called. */
}
}
else
{
if(dhcpv6_ptr -> nx_dhcpv6_request_solicit_mode == NX_DHCPV6_SOLICIT_NORMAL)
{
/* Server has responded to and accepted the SOLICIT request with an ADVERTISE message.
Move to the next state to continue the DHCPv6 protocol. */
/* Set the DHCP Client state to Requesting. */
dhcpv6_ptr -> nx_dhcpv6_state = NX_DHCPV6_STATE_SENDING_REQUEST;
/* Reset the retransmission timeout and retry. */
dhcpv6_ptr -> nx_dhcpv6_transmission_timeout = NX_DHCPV6_INIT_REQ_TRANSMISSION_TIMEOUT;
dhcpv6_ptr -> nx_dhcpv6_retransmission_count = 0;
/* Set the initaial elasped time of DHCPv6 message. */
dhcpv6_ptr -> nx_dhcpv6_elapsed_time.nx_session_time = 0;
/* Set the retransmission information(IRT, MRC, MRT, MRD). */
dhcpv6_ptr -> nx_dhcpv6_init_retransmission_timeout = NX_DHCPV6_INIT_REQ_TRANSMISSION_TIMEOUT;
dhcpv6_ptr -> nx_dhcpv6_max_retransmission_count = NX_DHCPV6_MAX_REQ_RETRANSMISSION_COUNT;
dhcpv6_ptr -> nx_dhcpv6_max_retransmission_timeout = NX_DHCPV6_MAX_REQ_RETRANSMISSION_TIMEOUT;
dhcpv6_ptr -> nx_dhcpv6_max_retransmission_duration = NX_DHCPV6_MAX_REQ_RETRANSMISSION_DURATION;
/* The next sending packet is the new packet, so reset the message id. */
dhcpv6_ptr -> nx_dhcpv6_message_hdr.nx_message_xid = 0;
/* Increment the number of solicitation responses. */
dhcpv6_ptr -> nx_dhcpv6_solicitation_responses++;
}
else
{
/* Server sending the REPLY message responded to and accepted the SOLICIT request with Rapid Commit option,
Move to the next state to continue the DHCPv6 protocol. */
/* Set the initaial elasped time of DHCPv6 message. */
dhcpv6_ptr -> nx_dhcpv6_elapsed_time.nx_session_time = 0;
/* Increment the number of solicitation responses. */
dhcpv6_ptr -> nx_dhcpv6_solicitation_responses++;
/* Clear the message id. */
dhcpv6_ptr -> nx_dhcpv6_message_hdr.nx_message_xid = 0;
/* Deactivate the session timer of elapsed time. */
tx_timer_deactivate(&(dhcpv6_ptr -> nx_dhcpv6_session_timer));
/* Set the DHCP Client state to Requesting. */
dhcpv6_ptr -> nx_dhcpv6_state = NX_DHCPV6_STATE_BOUND_TO_ADDRESS;
/* Yes, get the IPv6 address by DHCPv6. set it. */
status = _nx_dhcpv6_register_IP_address(dhcpv6_ptr);
}
}
break;
}
/* The DHCP Client is in the REQUEST state; send the Request message till the server responds
or the number of retries exceeds the max. */
case NX_DHCPV6_STATE_SENDING_REQUEST:
{
/* Reset the initial timeout and zero out transmission count. */
dhcpv6_ptr -> nx_dhcpv6_message_hdr.nx_message_type = NX_DHCPV6_MESSAGE_TYPE_REQUEST;
/* Transmit the Request message. */
status = _nx_dhcpv6_send_request(dhcpv6_ptr);
/* Check for transmission error. */
if (status != NX_SUCCESS)
{
/* Return. Can't do any more now. */
return;
}
dhcpv6_ptr -> nx_dhcpv6_requests_sent++;
/* Send the message to the server. */
status = _nx_dhcpv6_waiting_on_reply(dhcpv6_ptr);
/* Check for socket receive error or Server error code. */
if ((status != NX_SUCCESS) || (dhcpv6_ptr -> nx_status_code != NX_DHCPV6_SUCCESS))
{
/* Check the status. */
if ((status == NX_SUCCESS) &&
((dhcpv6_ptr -> nx_status_code == NX_DHCPV6_NOT_ON_LINK) ||
(dhcpv6_ptr -> nx_status_code == NX_DHCPV6_NO_ADDRESS_AVAILABLE)))
{
/* Indicate the DHCP Client process is idle. */
dhcpv6_ptr -> nx_dhcpv6_sleep_flag = NX_TRUE;
/* The next sending packet is the new packet, so reset the message id. */
dhcpv6_ptr -> nx_dhcpv6_message_hdr.nx_message_xid = 0;
/* Clear the assigned IP address. */
_nx_dhcpv6_remove_assigned_address(dhcpv6_ptr,NX_DHCPV6_REMOVE_ALL_IA_ADDRESS);
/* When the client receives a NotOnLink status from the server in response to a Request,
the client can restart the DHCP server discovery process. RFC3315, Section18.1.8, Page48. */
_nx_dhcpv6_request_solicit(dhcpv6_ptr);
}
else
{
/* Update the retransmission information. */
if (_nx_dhcpv6_update_retransmit_info(dhcpv6_ptr))
{
/* The retry limit on Request messages is exceeded. Set the Client back to
the INIT state and stop sending request messages for now. */
dhcpv6_ptr -> nx_dhcpv6_state = NX_DHCPV6_STATE_INIT;
/* Request attempt failed. The state change callback if set will be called. */
}
}
}
else
{
/* The Server responded to and accepted the REQUEST message. The Client is now bound to assigned
IPv6 address. The Client must still register this IPv6 address with NetX Duo to verify it is
unique on the network. */
/* Clear the time accrued on the new IP lease to zero. */
dhcpv6_ptr -> nx_dhcpv6_IP_lifetime_time_accrued = 0;
/* The next sending packet is the new packet, so reset the message id. */
dhcpv6_ptr -> nx_dhcpv6_message_hdr.nx_message_xid = 0;
/* Receive the correct response, so deactivate the session timer of elapsed time. */
tx_timer_deactivate(&(dhcpv6_ptr -> nx_dhcpv6_session_timer));
/* Increment the number of Request responses received. */
dhcpv6_ptr -> nx_dhcpv6_request_responses++;
/* Indicate the Client is bound to an assigned IPv6 address. */
dhcpv6_ptr -> nx_dhcpv6_state = NX_DHCPV6_STATE_BOUND_TO_ADDRESS;
/* Yes, get the IPv6 address by DHCPv6. set it. */
status = _nx_dhcpv6_register_IP_address(dhcpv6_ptr);
}
break;
}
/* The caller has requested a RENEW request message be sent. */
case NX_DHCPV6_STATE_SENDING_RENEW:
{
dhcpv6_ptr -> nx_dhcpv6_message_hdr.nx_message_type = NX_DHCPV6_MESSAGE_TYPE_RENEW;
dhcpv6_ptr -> nx_dhcpv6_renews_sent++;
/* Send the DHCPV6 RENEW message. */
status = _nx_dhcpv6_send_request(dhcpv6_ptr);
/* Check for transmission error. */
if (status != NX_SUCCESS)
{
/* Return. Can't do any more now. */
return;
}
/* Send the message to the server. */
status = _nx_dhcpv6_waiting_on_reply(dhcpv6_ptr);
/* Check for socket receive error or Server error code. */
if ((status != NX_SUCCESS) ||
(dhcpv6_ptr -> nx_status_code != NX_DHCPV6_SUCCESS) ||
((dhcpv6_ptr -> nx_dhcpv6_reply_option_flags & NX_DHCPV6_INCLUDE_IA_ADDRESS_OPTION) == 0))
{
/* Process the NoBinding status. */
if ((status == NX_SUCCESS) && (dhcpv6_ptr -> nx_status_code == NX_DHCPV6_NO_BINDING))
{
/* When the client receives a Reply message in response to a Renew or Rebind message,
send a Request message if the IA contains a Status Code option with the NoBinding status.
RFC 3315, Sectoon 18.1.8, Page 48. */
dhcpv6_ptr -> nx_dhcpv6_state = NX_DHCPV6_STATE_SENDING_REQUEST;
/* Reset the retransmission timeout and retry. */
dhcpv6_ptr -> nx_dhcpv6_transmission_timeout = NX_DHCPV6_INIT_REQ_TRANSMISSION_TIMEOUT;
dhcpv6_ptr -> nx_dhcpv6_retransmission_count = 0;
/* Set the initaial elasped time of DHCPv6 message. */
dhcpv6_ptr -> nx_dhcpv6_elapsed_time.nx_session_time = 0;
/* Set the retransmission information(IRT, MRC, MRT, MRD). */
dhcpv6_ptr -> nx_dhcpv6_init_retransmission_timeout = NX_DHCPV6_INIT_REQ_TRANSMISSION_TIMEOUT;
dhcpv6_ptr -> nx_dhcpv6_max_retransmission_count = NX_DHCPV6_MAX_REQ_RETRANSMISSION_COUNT;
dhcpv6_ptr -> nx_dhcpv6_max_retransmission_timeout = NX_DHCPV6_MAX_REQ_RETRANSMISSION_TIMEOUT;
dhcpv6_ptr -> nx_dhcpv6_max_retransmission_duration = NX_DHCPV6_MAX_REQ_RETRANSMISSION_DURATION;
/* The next sending packet is the new packet, so reset the message id. */
dhcpv6_ptr -> nx_dhcpv6_message_hdr.nx_message_xid = 0;
}
else
{
/* Update the retransmission information. */
if (_nx_dhcpv6_update_retransmit_info(dhcpv6_ptr))
{
/* Clear the assigned IP address. */
_nx_dhcpv6_remove_assigned_address(dhcpv6_ptr, NX_DHCPV6_REMOVE_ALL_IA_ADDRESS);
/* The retry limit on Renew messages is exceeded. Set the Client back to
the INIT state and stop sending Renew messages for now. */
dhcpv6_ptr -> nx_dhcpv6_state = NX_DHCPV6_STATE_INIT;
/* Renew attempt failed. The state change callback if set will be called. */
}
}
}
else
{
/* The Server responded to and accepted our RENEW request. Update the Client to a bound
state and reset the lease timers. */
/* Indicate the Client is bound to an assigned IPv6 address. */
dhcpv6_ptr -> nx_dhcpv6_state = NX_DHCPV6_STATE_BOUND_TO_ADDRESS;
/* Reset the time keeper! */
dhcpv6_ptr -> nx_dhcpv6_IP_lifetime_time_accrued = 0;
/* The next sending packet is the new packet, so reset the message id. */
dhcpv6_ptr -> nx_dhcpv6_message_hdr.nx_message_xid = 0;
/* Receive the correct response, so deactivate the session timer of elapsed time. */
tx_timer_deactivate(&(dhcpv6_ptr -> nx_dhcpv6_session_timer));
/* Yes, get the IPv6 address by DHCPv6. set it. */
status = _nx_dhcpv6_register_IP_address(dhcpv6_ptr);
/* Increment the number of renew responses received. */
dhcpv6_ptr -> nx_dhcpv6_renew_responses++;
}
break;
}
/* The caller has requested to send a rebind request message. */
case NX_DHCPV6_STATE_SENDING_REBIND:
{
dhcpv6_ptr -> nx_dhcpv6_message_hdr.nx_message_type = NX_DHCPV6_MESSAGE_TYPE_REBIND;
/* Increase the count of retries. */
dhcpv6_ptr -> nx_dhcpv6_rebinds_sent++;
/* Send the DHCPV6 Rebind message. */
status = _nx_dhcpv6_send_request(dhcpv6_ptr);
/* Check for socket send error. */
if (status != NX_SUCCESS)
{
/* Return. Can't do any more now. */
return;
}
/* Make sure the server DUID is cleared. Client should be accepting any server reply. */
memset(&(dhcpv6_ptr -> nx_dhcpv6_server_duid), 0, sizeof(NX_DHCPV6_DUID));
/* Send the message to the server. */
status = _nx_dhcpv6_waiting_on_reply(dhcpv6_ptr);
/* Check for socket receive error or Server error code. */
if ((status != NX_SUCCESS) ||
(dhcpv6_ptr -> nx_status_code != NX_DHCPV6_SUCCESS) ||
((dhcpv6_ptr -> nx_dhcpv6_reply_option_flags & NX_DHCPV6_INCLUDE_IA_ADDRESS_OPTION) == 0))
{
/* Process the NoBinding status. */
if ((status == NX_SUCCESS) && (dhcpv6_ptr -> nx_status_code == NX_DHCPV6_NO_BINDING))
{
/* When the client receives a Reply message in response to a Renew or Rebind message,
send a Request message if the IA contains a Status Code option with the NoBinding status.
RFC 3315, Section 18.1.8, Page 48. */
dhcpv6_ptr -> nx_dhcpv6_state = NX_DHCPV6_STATE_SENDING_REQUEST;
/* Reset the retransmission timeout and retry. */
dhcpv6_ptr -> nx_dhcpv6_transmission_timeout = NX_DHCPV6_INIT_REQ_TRANSMISSION_TIMEOUT;
dhcpv6_ptr -> nx_dhcpv6_retransmission_count = 0;
/* Set the initaial elasped time of DHCPv6 message. */
dhcpv6_ptr -> nx_dhcpv6_elapsed_time.nx_session_time = 0;
/* Set the retransmission information(IRT, MRC, MRT, MRD). */
dhcpv6_ptr -> nx_dhcpv6_init_retransmission_timeout = NX_DHCPV6_INIT_REQ_TRANSMISSION_TIMEOUT;
dhcpv6_ptr -> nx_dhcpv6_max_retransmission_count = NX_DHCPV6_MAX_REQ_RETRANSMISSION_COUNT;
dhcpv6_ptr -> nx_dhcpv6_max_retransmission_timeout = NX_DHCPV6_MAX_REQ_RETRANSMISSION_TIMEOUT;
dhcpv6_ptr -> nx_dhcpv6_max_retransmission_duration = NX_DHCPV6_MAX_REQ_RETRANSMISSION_DURATION;
/* The next sending packet is the new packet, so reset the message id. */
dhcpv6_ptr -> nx_dhcpv6_message_hdr.nx_message_xid = 0;
}
else
{
/* Update the retransmission information. */
if (_nx_dhcpv6_update_retransmit_info(dhcpv6_ptr))
{
/* Clear the assigned IP address. */
_nx_dhcpv6_remove_assigned_address(dhcpv6_ptr, NX_DHCPV6_REMOVE_ALL_IA_ADDRESS);
/* The retry limit on Rebind messages is exceeded. Set the Client back to
the INIT state and stop sending Rebind messages for now. */
dhcpv6_ptr -> nx_dhcpv6_state = NX_DHCPV6_STATE_INIT;
/* Rebind attempt failed. The client state change callback if set will be called. */
}
}
}
else
{
/* Make sure the Client state is set to Bound to an assigned IPv6 address. */
dhcpv6_ptr -> nx_dhcpv6_state = NX_DHCPV6_STATE_BOUND_TO_ADDRESS;
/* Reset the time keeper! */
dhcpv6_ptr -> nx_dhcpv6_IP_lifetime_time_accrued = 0;
/* The next sending packet is the new packet, so reset the message id. */
dhcpv6_ptr -> nx_dhcpv6_message_hdr.nx_message_xid = 0;
/* Yes, get the IPv6 address by DHCPv6. set it. */
status = _nx_dhcpv6_register_IP_address(dhcpv6_ptr);
/* Increment the number of rebind responses received. */
dhcpv6_ptr -> nx_dhcpv6_rebind_responses++;
/* Receive the correct response, so deactivate the session timer of elapsed time. */
tx_timer_deactivate(&(dhcpv6_ptr -> nx_dhcpv6_session_timer));
}
break;
}
case NX_DHCPV6_STATE_SENDING_CONFIRM:
{
/* Set the message type. */
dhcpv6_ptr -> nx_dhcpv6_message_hdr.nx_message_type = NX_DHCPV6_MESSAGE_TYPE_CONFIRM;
/* Increase the count of retries. */
dhcpv6_ptr -> nx_dhcpv6_confirms_sent++;
/* Send the DHCPV6 Confirm message. */
status = _nx_dhcpv6_send_request(dhcpv6_ptr);
/* Send the message until we get a reply from the server. */
status = _nx_dhcpv6_waiting_on_reply(dhcpv6_ptr);
/* Check for socket receive error or Server error code. */
if ((status != NX_SUCCESS) || (dhcpv6_ptr -> nx_status_code != NX_DHCPV6_SUCCESS))
{
if ((status == NX_SUCCESS) && (dhcpv6_ptr -> nx_status_code == NX_DHCPV6_NOT_ON_LINK))
{
/* Indicate the DHCP Client process is idle. */
dhcpv6_ptr -> nx_dhcpv6_sleep_flag = NX_TRUE;
/* The next sending packet is the new packet, so reset the message id. */
dhcpv6_ptr -> nx_dhcpv6_message_hdr.nx_message_xid = 0;
/* Clear the assigned IP address. */
_nx_dhcpv6_remove_assigned_address(dhcpv6_ptr,NX_DHCPV6_REMOVE_ALL_IA_ADDRESS);
/* When the client receives a NotOnLink status from the server in response to a Confirm messag,
the client performs DHCP server solicitation. RFC3315, Section18.1.8, Page48. */
_nx_dhcpv6_request_solicit(dhcpv6_ptr);
}
/* Retransmit the Confirm message. */
else
{
/* Update the retransmission information. */
if (_nx_dhcpv6_update_retransmit_info(dhcpv6_ptr))
{
/* The retry limit on Confirm messages is exceeded. Set the Client back to
the INIT state and stop sending rebind messages for now. */
dhcpv6_ptr -> nx_dhcpv6_state = NX_DHCPV6_STATE_INIT;
/* Confirm request failed. The state change callback if set will be called. */
}
}
}
else
{
/* Successful confirmation. Set the assigned address status to valid (confirmed). */
/* Yes, get the IPv6 address by DHCPv6. set it. */
status = _nx_dhcpv6_register_IP_address(dhcpv6_ptr);
/* Increment the number of responses to confirm. */
dhcpv6_ptr -> nx_dhcpv6_confirm_responses++;
/* Restore the Client state depending on its IANA address status. */
dhcpv6_ptr -> nx_dhcpv6_state = NX_DHCPV6_STATE_BOUND_TO_ADDRESS;
/* The next sending packet is the new packet, so reset the message id. */
dhcpv6_ptr -> nx_dhcpv6_message_hdr.nx_message_xid = 0;
/* Receive the correct response, so deactivate the session timer of elapsed time. */
tx_timer_deactivate(&(dhcpv6_ptr -> nx_dhcpv6_session_timer));
}
break;
}
case NX_DHCPV6_STATE_SENDING_RELEASE:
{
dhcpv6_ptr -> nx_dhcpv6_message_hdr.nx_message_type = NX_DHCPV6_MESSAGE_TYPE_RELEASE;
/* Increase the count of releases. */
dhcpv6_ptr -> nx_dhcpv6_releases_sent++;
/* Send the DHCPV6 Release message. */
status = _nx_dhcpv6_send_request(dhcpv6_ptr);
/* Check for socket error. */
if (status != NX_SUCCESS)
{
/* Return. Can't do any more now. */
return;
}
/* Send the message to the server. */
status = _nx_dhcpv6_waiting_on_reply(dhcpv6_ptr);
/* Check for socket receive error. For the release message, consider the release
request completed if the server responds, regardless of Server error code. RFC 3315 Section 18.1.8 */
if (status != NX_SUCCESS)
{
/* Update the retransmission information. */
if (_nx_dhcpv6_update_retransmit_info(dhcpv6_ptr))
{
/* Clear global ip address and lifetime parameters from the Client record. */
_nx_dhcpv6_remove_assigned_address(dhcpv6_ptr, NX_DHCPV6_REMOVE_ALL_IA_ADDRESS);
/* The retry limit on release messages is exceeded. Set the Client back to
the INIT state and stop sending rebind messages for now. */
dhcpv6_ptr -> nx_dhcpv6_state = NX_DHCPV6_STATE_INIT;
/* No response to release message from server. The state change callback if set will be called. */
}
}
else
{
/* Increment the number of responses to release request. */
dhcpv6_ptr -> nx_dhcpv6_release_responses++;
/* The next sending packet is the new packet, so reset the message id. */
dhcpv6_ptr -> nx_dhcpv6_message_hdr.nx_message_xid = 0;
/* Receive the correct response, so deactivate the session timer of elapsed time. */
tx_timer_deactivate(&(dhcpv6_ptr -> nx_dhcpv6_session_timer));
/* Clear global ip address and lifetime parameters from the Client record. */
_nx_dhcpv6_remove_assigned_address(dhcpv6_ptr, NX_DHCPV6_REMOVE_ALL_IA_ADDRESS);
/* Update the Client state to not bound. */
dhcpv6_ptr -> nx_dhcpv6_state = NX_DHCPV6_STATE_INIT;
}
break;
}
case NX_DHCPV6_STATE_SENDING_DECLINE:
{
dhcpv6_ptr -> nx_dhcpv6_message_hdr.nx_message_type = NX_DHCPV6_MESSAGE_TYPE_DECLINE;
/* Increase the count of declines. */
dhcpv6_ptr -> nx_dhcpv6_declines_sent++;
/* Send the DHCPV6 Decline message. */
status = _nx_dhcpv6_send_request(dhcpv6_ptr);
/* Check for interal error. */
if (status != NX_SUCCESS)
{
/* Return. Can't do any more now. */
return;
}
/* Send the message to the server. */
status = _nx_dhcpv6_waiting_on_reply(dhcpv6_ptr);
/* Check for socket receive error. For the decline message, consider the release
request completed if the server responds, regardless of Server error code. RFC3315,Section 18.1.7 */
if (status != NX_SUCCESS)
{
/* Update the retransmission information. */
if (_nx_dhcpv6_update_retransmit_info(dhcpv6_ptr))
{
/* Clear global ip address and lifetime parameters from the Client record. */
_nx_dhcpv6_remove_assigned_address(dhcpv6_ptr, NX_DHCPV6_REMOVE_ALL_IA_ADDRESS);
/* The retry limit on decline messages is exceeded. Set the Client back to
the INIT state and stop sending rebind messages for now. */
dhcpv6_ptr -> nx_dhcpv6_state = NX_DHCPV6_STATE_INIT;
/* No response to decline message from server. The state change callback if set will be called. */
}
}
else
{
/* Increment the number of server responses to Decline request. */
dhcpv6_ptr -> nx_dhcpv6_decline_responses++;
/* The next sending packet is the new packet, so reset the message id. */
dhcpv6_ptr -> nx_dhcpv6_message_hdr.nx_message_xid = 0;
/* Receive the correct response, so deactivate the session timer of elapsed time. */
tx_timer_deactivate(&(dhcpv6_ptr -> nx_dhcpv6_session_timer));
/* Clear global ip address and lifetime parameters from the Client record. */
status = _nx_dhcpv6_remove_assigned_address(dhcpv6_ptr, NX_DHCPV6_REMOVE_ALL_IA_ADDRESS);
/* Change the DHCPv6 Client to the unbound state. */
dhcpv6_ptr -> nx_dhcpv6_state = NX_DHCPV6_STATE_INIT;
}
break;
}
case NX_DHCPV6_STATE_SENDING_INFORM_REQUEST:
{
dhcpv6_ptr -> nx_dhcpv6_message_hdr.nx_message_type = NX_DHCPV6_MESSAGE_TYPE_INFORM_REQUEST;
/* Increase the count of declines. */
dhcpv6_ptr -> nx_dhcpv6_inform_req_sent++;
/* Send the Inform Request message. */
status = _nx_dhcpv6_send_request(dhcpv6_ptr);
/* Check for transmission error. */
if (status != NX_SUCCESS)
{
/* Return. Nothing more to do. */
return;
}
/* Wait for a reply from the server. This will also extract the
server packet information and update the DHCPv6 Client state. */
status = _nx_dhcpv6_waiting_on_reply(dhcpv6_ptr);
/* Check for socket receive error or Server error code. */
if ((status != NX_SUCCESS) || (dhcpv6_ptr -> nx_status_code != NX_DHCPV6_SUCCESS))
{
/* Update the retransmission information. */
if (_nx_dhcpv6_update_retransmit_info(dhcpv6_ptr))
{
/* The retry limit on decline messages is exceeded. Set the Client back to
the INIT state and stop sending rebind messages for now. */
dhcpv6_ptr -> nx_dhcpv6_state = NX_DHCPV6_STATE_INIT;
}
}
else
{
/* Increment the number of responses to Inform Request received. */
dhcpv6_ptr -> nx_dhcpv6_inform_req_responses++;
/* The next sending packet is the new packet, so reset the message id. */
dhcpv6_ptr -> nx_dhcpv6_message_hdr.nx_message_xid = 0;
/* Receive the correct response, so deactivate the session timer of elapsed time. */
tx_timer_deactivate(&(dhcpv6_ptr -> nx_dhcpv6_session_timer));
/* Restore the Client state depending on its IANA address status. */
if (dhcpv6_ptr -> nx_dhcpv6_ia[0].nx_address_status == NX_DHCPV6_IA_ADDRESS_STATE_VALID)
{
dhcpv6_ptr -> nx_dhcpv6_state = NX_DHCPV6_STATE_BOUND_TO_ADDRESS;
}
else
{
dhcpv6_ptr -> nx_dhcpv6_state = NX_DHCPV6_STATE_INIT;
}
}
break;
}
default:
{
/* Unknown or unsupported DHCPv6 request (state). */
return;
}
}
/* Is there a state change callback registered with the Client? */
if ((dhcpv6_ptr -> nx_dhcpv6_state_change_callback) && (original_state != (dhcpv6_ptr -> nx_dhcpv6_state)))
{
/* Yes, call the the state change callback with the original and new state. */
(dhcpv6_ptr -> nx_dhcpv6_state_change_callback)(dhcpv6_ptr, original_state, dhcpv6_ptr -> nx_dhcpv6_state);
}
return;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_process_client_duid PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function extracts the client DUID from the server reply and */
/* verifies that it matches the Client DUID on record. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPV6 Client instance */
/* option_data Pointer to option data */
/* option_length Size of option data */
/* */
/* OUTPUT */
/* */
/* NX_SUCCESS Successful completion status */
/* NX_DHCPV6_INVALID_CLIENT_DUID Client DUID is missing data or */
/* does not match the DUID on record*/
/* CALLS */
/* */
/* _nx_dhcpv6_utility_get_data Parses data from specified buffer */
/* */
/* CALLED BY */
/* */
/* _nx_dhcpv6_extract_packet_information */
/* Extracts server reply from packet */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), improved */
/* packet length verification, */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_process_client_duid(NX_DHCPV6 *dhcpv6_ptr, UCHAR *option_data, UINT option_length)
{
ULONG data;
UINT index = 0;
/* The Client should already have its own DUID on record. So just parse the
data and compare each DUID field with the Client's DUID. */
/* Check option length for DUID type and hardware type. */
if (option_length < 4)
{
return(NX_DHCPV6_INVALID_CLIENT_DUID);
}
/* Extract the DUID type which should be the next 2 bytes. */
_nx_dhcpv6_utility_get_data((option_data + index), 2, &data);
/* Does this match the Client DUID type on record? */
if (data != (dhcpv6_ptr -> nx_dhcpv6_client_duid.nx_duid_type))
{
/* No, return the error status to reject this packet. */
return NX_DHCPV6_INVALID_CLIENT_DUID;
}
index += 2;
/* Extract the hardware type which should be the next 2 bytes. */
_nx_dhcpv6_utility_get_data((option_data + index), 2, &data);
/* Does this match the Client DUID hardware type on record? */
if (data != (dhcpv6_ptr -> nx_dhcpv6_client_duid.nx_hardware_type))
{
/* No, return the error status to reject this packet. */
return NX_DHCPV6_INVALID_CLIENT_DUID;
}
index += 2;
/* IS this a link layer plus time DUID type? */
if ((dhcpv6_ptr -> nx_dhcpv6_client_duid.nx_duid_type) == NX_DHCPV6_DUID_TYPE_LINK_TIME)
{
/* Check option length for time. */
if (index + 4 > option_length)
{
return(NX_DHCPV6_INVALID_CLIENT_DUID);
}
/* Yes; Extract the time which should be the next 4 bytes. */
_nx_dhcpv6_utility_get_data((option_data + index), 4, &data);
/* Does this match the Client DUID time on record? */
if (data != (dhcpv6_ptr -> nx_dhcpv6_client_duid.nx_duid_time))
{
/* No, return the error status to reject this packet. */
return NX_DHCPV6_INVALID_CLIENT_DUID;
}
index += 4;
}
/* Check the hardware type to extract the MSW. */
if (dhcpv6_ptr -> nx_dhcpv6_client_duid.nx_hardware_type == NX_DHCPV6_CLIENT_HARDWARE_TYPE_ETHERNET)
{
/* The length of link layer address is 48 bits. */
/* Check option length for 48 bits mac address. */
if (index + 6 > option_length)
{
return(NX_DHCPV6_INVALID_CLIENT_DUID);
}
/* Yes; Extract the link local address msw which should be the next 2 bytes. */
_nx_dhcpv6_utility_get_data((option_data + index), 2, &data);
index += 2;
}
else if (dhcpv6_ptr -> nx_dhcpv6_client_duid.nx_hardware_type == NX_DHCPV6_CLIENT_HARDWARE_TYPE_EUI_64)
{
/* The length of link layer address is 64 bits. */
/* Check option length for 64 bits mac address. */
if (index + 8 > option_length)
{
return(NX_DHCPV6_INVALID_CLIENT_DUID);
}
/* Yes; Extract the link local address msw which should be the next 4 bytes. */
_nx_dhcpv6_utility_get_data((option_data + index), 4, &data);
index += 4;
}
/* Does this match the Client DUID link layer most significant bytes on record? */
if (data != (dhcpv6_ptr -> nx_dhcpv6_client_duid.nx_link_layer_address_msw))
{
/* No, return the error status to reject this packet. */
return NX_DHCPV6_INVALID_CLIENT_DUID;
}
/* Yes; Extract the link local address lsw which should be the next 4 bytes. */
_nx_dhcpv6_utility_get_data((option_data + index), 4, &data);
index += 4;
/* Does this match the Client DUID link layer least significant bytes on record? */
if (data != ((dhcpv6_ptr -> nx_dhcpv6_client_duid).nx_link_layer_address_lsw))
{
/* No, return the error status to reject this packet. */
return NX_DHCPV6_INVALID_CLIENT_DUID;
}
/* Are we past the end of the buffer. */
if (index != option_length)
{
/* Yes, return the error status to reject this packet. */
return NX_DHCPV6_INVALID_CLIENT_DUID;
}
return NX_SUCCESS;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_process_domain_name PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function extracts the domain name option from the server reply.*/
/* It will save as much of the domain name that will fit in the Client */
/* domain name buffer. Buffer size is user configurable. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPV6 Client instance */
/* packet_start Pointer to packet buffer */
/* option_data Pointer to option data */
/* option_length Size of option data */
/* */
/* OUTPUT */
/* */
/* NX_SUCCESS Successful completion status */
/* */
/* CALLS */
/* */
/* _nx_dhcpv6_name_string_unencode Decode the name string */
/* */
/* CALLED BY */
/* */
/* _nx_dhcpv6_extract_packet_information */
/* Extracts DHCPv6 options from */
/* server reply */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), improved */
/* packet length verification, */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_process_domain_name(NX_DHCPV6 *dhcpv6_ptr, UCHAR *packet_start, UCHAR *option_data, UINT option_length)
{
UINT domain_name_length;
UINT temp_length;
UCHAR *domain_name_ptr;
UCHAR *buffer_prepend_ptr;
UINT buffer_size;
UINT i;
/* Initialize the value. */
domain_name_length = 0;
temp_length = 0;
domain_name_ptr = option_data;
buffer_prepend_ptr = &dhcpv6_ptr -> nx_dhcpv6_domain_name[0];
buffer_size = NX_DHCPV6_DOMAIN_NAME_BUFFER_SIZE;
/* Process the domain search list options. */
while(temp_length < option_length)
{
/* Calculate the domain name length in the Domaim Search List option,include the null flag '\0'. */
for (i = 0; (i + temp_length < option_length) && (domain_name_ptr[i] != '\0'); i++);
if (i + temp_length == option_length)
{
return(NX_DHCPV6_PROCESSING_ERROR);
}
else
{
temp_length += (i + 1);
}
/* Check buffer size. */
if (buffer_size < 1)
{
return(NX_DHCPV6_PROCESSING_ERROR);
}
/* Record the real domain name and return the length, one less for NULL termination. */
domain_name_length = _nx_dhcpv6_name_string_unencode(packet_start, (UINT)(domain_name_ptr - packet_start), buffer_prepend_ptr, (UINT)((buffer_size - 1) & 0xFFFFFFFF));
/* Check the domain name length. */
if(!domain_name_length)
{
/* Process error, return. */
return NX_DHCPV6_PROCESSING_ERROR;
}
else
{
/* Update the buffer value,include the null flag '\0'. */
domain_name_ptr += temp_length;
buffer_prepend_ptr += (domain_name_length + 1);
buffer_size -= (domain_name_length + 1);
}
}
/* Return successful completion. */
return NX_SUCCESS;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_name_string_encode PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function converts a string containing the name as a list of */
/* labels separated by dots to the encoded list of labels specified */
/* in RFC1035 for DNS servers. This conversion doesn't handle */
/* compression and doesn't check on the lengths of the labels or the */
/* entire name. */
/* */
/* INPUT */
/* */
/* ptr Pointer to destination */
/* name Source name string */
/* */
/* OUTPUT */
/* */
/* count Count of characters encoded */
/* */
/* CALLS */
/* */
/* None */
/* */
/* CALLED BY */
/* */
/* _nx_dhcpv6_add_client_FQDN Add FQDN Option to DHCPv6 packet */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_name_string_encode(UCHAR *ptr, UCHAR *name)
{
UCHAR *length;
UINT count = 1;
/* Point to the first character position in the buffer. This will point
to the length of the following name. */
length = ptr++;
/* Default the length to zero. */
*length = 0;
/* Move through string, copying bytes and updating length.
Whenever a "." is found, start a new string by updating the
pointer to the length and setting the length to zero. */
while (*name)
{
/* Is a dot been found? */
if (*name == '.')
{
/* Yes, setup a new length pointer. */
length = ptr++;
/* Default the length to zero. */
*length = 0;
name++;
}
else
{
/* Copy a character to the destination. */
*ptr++ = *name++;
/* Adjust the length of the current segment. */
(*length)++;
}
/* Increment the total count here. */
count++;
}
/* Add the final zero length, like a NULL terminator. */
*ptr = 0;
/* Increment the total count. */
count++;
/* Return the count. */
return(count);
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_name_string_unencode PORTABLE C */
/* 6.1.2 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function converts from the encoded list of labels as specified */
/* in RFC 1035 to a string containing the name as a list of labels */
/* separated by dots. */
/* */
/* INPUT */
/* */
/* data Pointer to buffer to decode */
/* start Location of start of data */
/* buffer Pointer to decoded data */
/* size Size of data buffer to decode */
/* */
/* OUTPUT */
/* */
/* Size of decoded data */
/* */
/* CALLS */
/* */
/* None */
/* */
/* CALLED BY */
/* */
/* _nx_dhcpv6_process_domain_name Process the domain name */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* 11-09-2020 Yuxin Zhou Modified comment(s), fixed */
/* domain name labelSize issue,*/
/* resulting in version 6.1.2 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_name_string_unencode(UCHAR *data, UINT start, UCHAR *buffer, UINT size)
{
UCHAR *character = data + start;
UINT length = 0;
/* As long as there is space in the buffer and we haven't
found a zero terminating label */
while ((size > length) && (*character != '\0'))
{
UINT labelSize = *character++;
/* Check labelSize. */
if (labelSize <= NX_DHCPV6_LABEL_MAX)
{
/* Simple count, check for space and copy the label. */
while ((size > length) && (labelSize > 0))
{
*buffer++ = *character++;
length++;
labelSize--;
}
/* Now add the '.' */
*buffer++ = '.';
length++;
}
else
{
/* Not defined or in compressed form. Based on section 8 of RFC 3315,
a domain name, or list of domain names, in DHCP MUST NOT be stored
in compressed form, so just fail */
return(0);
}
}
/* Validate the length. */
if (length == 0)
{
return(length);
}
/* Done copying the data, set the last . to a trailing null */
if (*(buffer - 1) == '.')
{
buffer--;
length --;
}
/* Null terminate name. */
*buffer = '\0';
/* Return name size. */
return(length);
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_process_DNS_server PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function extracts the DNS server option from the server reply. */
/* It will save as many DNS name server addresses as are in the reply */
/* for which the Client is configured to save. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPV6 Client instance */
/* option_data Pointer to option data */
/* option_length Size of option data */
/* */
/* OUTPUT */
/* */
/* NX_SUCCESS Successful completion status */
/* NX_DHCPV6_INVALID_OPTION_DATA DNS server option missing data or */
/* improperly formatted */
/* */
/* CALLS */
/* */
/* memcpy Copies specified area of memory */
/* */
/* CALLED BY */
/* */
/* _nx_dhcpv6_extract_packet_information */
/* Extracts DHCPv6 options from */
/* server reply */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), improved */
/* packet length verification, */
/* verified memcpy use cases, */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_process_DNS_server(NX_DHCPV6 *dhcpv6_ptr, UCHAR *option_data, UINT option_length)
{
UINT index = 0;
UINT w, j = 0;
/* Loop through the length of the buffer to parse. */
while ((index + 16) <= option_length)
{
/* Is the DHCPv6 Client configured to store another DNS server address? */
if (j < NX_DHCPV6_NUM_DNS_SERVERS)
{
/* Set the IP version. */
dhcpv6_ptr -> nx_dhcpv6_DNS_name_server_address[j].nxd_ip_version = NX_IP_VERSION_V6;
/* Get the next IPv6 DNS server address. */
for (w = 0; w <= 3; w++)
{
/* Yes; copy the next word into the current DNS server address. */
memcpy(&(dhcpv6_ptr -> nx_dhcpv6_DNS_name_server_address[j].nxd_ip_address.v6[w]), /* Use case of memcpy is verified. */
(option_data + index), sizeof(ULONG));
/* Adjust for endianness. */
NX_CHANGE_ULONG_ENDIAN(dhcpv6_ptr -> nx_dhcpv6_DNS_name_server_address[j].nxd_ip_address.v6[w]);
/* Move to the next IPv6 address word. */
index += 4;
}
/* Get the next DNS server address in the reply buffer. */
j++;
}
else
{
/* Move to the next IPv6 address. */
index += 16;
}
}
/* Is there any more data in the buffer? */
if (index != option_length)
{
/* Yes, not sure what is going on with this packet. Treat as an error. */
return NX_DHCPV6_INVALID_OPTION_DATA;
}
return NX_SUCCESS;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_process_ia PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function extracts the IA address option from the server reply. */
/* It also checks that the server preferred and valid lifetimes are */
/* legitamate. If the IANA option contains an IA option, that will also*/
/* be processed as well as any status code options. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPV6 Client instance */
/* option_data Pointer to option data */
/* option_length Size of option data */
/* ia_index The index of IA address */
/* */
/* OUTPUT */
/* */
/* NX_SUCCESS Successful completion status */
/* NX_DHCPV6_INVALID_IA_DATA IA option is missing data or */
/* improperly formatted */
/* NX_DHCPV6_INVALID_IA_TIME IA option lifetime data is invalid*/
/* NX_DHCPV6_UNKNOWN_OPTION Unkonw option type */
/* */
/* CALLS */
/* */
/* _nx_dhcpv6_utility_get_block_option_length */
/* Get the option code and length */
/* _nx_dhcpv6_process_status Processes STAUTS in reply buffer */
/* nx_dhcpv6_server_error_handler Pointer to error code handler */
/* memcpy Copies specified area of memory */
/* */
/* CALLED BY */
/* */
/* _nx_dhcpv6_process_iana Processes IANA in reply buffer */
/* DHCPv6 request */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), improved */
/* packet length verification, */
/* verified memcpy use cases, */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_process_ia(NX_DHCPV6 *dhcpv6_ptr, UCHAR *option_data, UINT option_length, UINT ia_index)
{
ULONG preferred_lifetime;
ULONG valid_lifetime;
UINT index = 0, w;
UINT status;
ULONG ia_option_code, ia_option_length;
/* Fill in the IA address code and length. Client might already have one on
record, but use the server's data instead. */
dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_op_code = (USHORT)NX_DHCPV6_OP_IA_ADDRESS;
dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_option_length = (USHORT)option_length;
/* Check option length for Ipv6 address (16 bytes), preferred-lifetime (4 bytes) and valid-lifetime (4 bytes). */
if (option_length < 24)
{
return(NX_DHCPV6_INVALID_IA_DATA);
}
/* Process IPv6 address. */
for (w = 0; w <= 3; w++)
{
/* Copy each IPv6 address word into the IA address. */
memcpy(&(dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_global_address.nxd_ip_address.v6[w]), /* Use case of memcpy is verified. */
(option_data + index), sizeof(ULONG));
/* Adjust for endianness. */
NX_CHANGE_ULONG_ENDIAN(dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_global_address.nxd_ip_address.v6[w]);
/* Move to the next IPv6 address word. */
index += 4;
}
dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_global_address.nxd_ip_version = NX_IP_VERSION_V6;
/* Copy the lifetime data from the reply buffer to temporary variables.*/
memcpy(&preferred_lifetime, (option_data + index), sizeof(ULONG)); /* Use case of memcpy is verified. */
index += 4;
/* Adjust for endianness. */
NX_CHANGE_ULONG_ENDIAN(preferred_lifetime);
memcpy(&valid_lifetime, (option_data + index), sizeof(ULONG)); /* Use case of memcpy is verified. */
index += 4;
/* Adjust for endianness. */
NX_CHANGE_ULONG_ENDIAN(valid_lifetime);
/* Check for invalid lifetime data. The preferred lifetime MUST be less than
the valid lifetime. Note that a zero lifetime is acceptable
(the server is letting the Client use its own preference). */
if (preferred_lifetime > valid_lifetime)
{
/* Discard this address. We cannot use it. */
return NX_DHCPV6_INVALID_IA_TIME;
}
/* OK to assign time data to the client. */
dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_preferred_lifetime = preferred_lifetime;
dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_valid_lifetime = valid_lifetime;
/* Update the address status. */
if(dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_address_status == NX_DHCPV6_IA_ADDRESS_STATE_INVALID)
{
dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_address_status = NX_DHCPV6_IA_ADDRESS_STATE_INITIAL;
}
/* Update the map status, 0xFFFFFFFF indicate the IPv6 address of IA option has been processed. */
dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_address_map = 0xFFFFFFFF;
/* Check if we're at the end of option data yet. */
if (index == option_length)
{
/* Yes, all done. */
return NX_SUCCESS;
}
/* Check option length for status code option. */
if (index + 4 > option_length)
{
return(NX_DHCPV6_INVALID_IA_DATA);
}
/* Process the status code option. */
status = _nx_dhcpv6_utility_get_block_option_length(option_data + index, &ia_option_code, &ia_option_length);
/* Check that the block data is valid. */
if (status != NX_SUCCESS)
{
/* No, return the error status. */
return status;
}
/* Skip status option code and length. */
index += 4;
/* This is a double check to verify we haven't gone off the end of the packet buffer. */
if (index + ia_option_length > option_length)
{
return (NX_DHCPV6_INVALID_IA_DATA);
}
/* Check if this is an IAaddr status option request. */
if (ia_option_code == NX_DHCPV6_OP_STATUS_CODE)
{
/* The IAaddr option returned by the DHCPv6 server includes a status option. */
/* Process the status. */
status = _nx_dhcpv6_process_status(dhcpv6_ptr, (option_data + index), ia_option_length);
/* Now check on the server status of the previous option in the DHCP message. */
if ((status == NX_SUCCESS) && (dhcpv6_ptr -> nx_status_code != NX_DHCPV6_SUCCESS))
{
/* Does the dhcpv6 client have a server error handler? */
if (dhcpv6_ptr -> nx_dhcpv6_server_error_handler)
{
/* Call the error handler with status code, option (IAaddr) and which message type it refers to. */
dhcpv6_ptr -> nx_dhcpv6_server_error_handler(dhcpv6_ptr, NX_DHCPV6_ERROR_STATUS_CODE_IN_IA_ADDRESS, dhcpv6_ptr -> nx_status_code,
dhcpv6_ptr -> nx_dhcpv6_received_message_type);
}
}
/* Check for errors processing the DHCPv6 message. */
if (status != NX_SUCCESS)
{
/* Abort further processing. Return error status. */
return status;
}
}
else
{
return NX_DHCPV6_UNKNOWN_OPTION;
}
/* Keep track of how far into the packet we have parsed. */
index += ia_option_length;
/* Check if we went past the reported size of IA address data. */
if (index != option_length)
{
/* Return an error status. Cannot accept this reply. */
return NX_DHCPV6_INVALID_IA_DATA;
}
return NX_SUCCESS;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_process_iana PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function extracts the IANA option from the server reply. It */
/* verifies the IANA option ID matches the IANA option ID on client */
/* record. It also checks that the server T1 and T2 lease times are */
/* legitamate. If the IANA option contains an IA option, that will also*/
/* be processed as well as any status code options. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPV6 Client instance */
/* option_data Pointer to option data */
/* option_length Size of option data */
/* */
/* OUTPUT */
/* */
/* status Actual completion status */
/* NX_DHCPV6_BAD_IANA_ID IANA option ID does not match IANA*/
/* option on client record */
/* NX_DHCPV6_INVALID_IANA_TIME IANA T1 and T2 values are invalid */
/* NX_DHCPV6_STATE_IP_FAILURE Indicates server rejected IANA/IA */
/* NX_DHCPV6_INVALID_IANA_DATA IANA option is missing data or */
/* improperly formatted */
/* CALLS */
/* */
/* _nx_dhcpv6_utility_get_data Parses data from reply buffer */
/* _nx_dhcpv6_utility_get_block_option_length */
/* Parses option header from buffer */
/* _nx_dhcpv6_process_ia Process IA option in reply buffer */
/* _nx_dhcpv6_process_status Process status option in buffer */
/* nx_dhcpv6_server_error_handler Pointer to server error code handler*/
/* */
/* CALLED BY */
/* */
/* _nx_dhcpv6_extract_packet_information */
/* Extracts server reply from packet */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), improved */
/* packet length verification, */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_process_iana(NX_DHCPV6 *dhcpv6_ptr, UCHAR *option_data, UINT option_length)
{
UINT status;
ULONG T1, T2, data;
UINT index = 0;
ULONG iana_option_code, iana_option_length;
UINT ia_index;
UINT ia_count = 0;
UINT ia_status;
/* Check option length for IANA ID. */
if (option_length < 4)
{
return(NX_DHCPV6_INVALID_IANA_DATA);
}
/* Get the IANA ID. */
memcpy(&data, (option_data + index), 4); /* Use case of memcpy is verified. */
/* Adjust for endianness. */
NX_CHANGE_ULONG_ENDIAN(data);
/* The server response must return the correct IANA ID; this is applicable
to clients configured with more than one IANA. */
if (data != (dhcpv6_ptr -> nx_dhcpv6_iana.nx_IA_NA_id))
{
/* IANA does not match. */
return NX_DHCPV6_BAD_IANA_ID;
}
/* Update the write location index. */
index += 4;
/* Check option length for T1 and T2. */
if (index + 8 > option_length)
{
return(NX_DHCPV6_INVALID_IANA_DATA);
}
/* Copy T1 and T2 from the buffer into temporary variables. */
memcpy(&T1, (option_data + index), 4); /* Use case of memcpy is verified. */
index += 4;
/* Adjust for endianness. */
NX_CHANGE_ULONG_ENDIAN(T1);
memcpy(&T2, (option_data + index), 4); /* Use case of memcpy is verified. */
index += 4;
/* Adjust for endianness. */
NX_CHANGE_ULONG_ENDIAN(T2);
/* Check for invalid T1/T2 lifetimes. */
if (T1 > T2)
{
/* Reject the server DHCPv6 response. */
return NX_DHCPV6_INVALID_IANA_TIME;
}
/* Record the T1 and T2. */
/* Yes, the server will let the Client use its own T1 time? */
if (T1 != 0)
{
/* Now, assign the server T1 to the client IA-NA. */
dhcpv6_ptr -> nx_dhcpv6_iana.nx_T1 = T1;
}
/* Yes,the server will let the Client use its own T2 time? */
if (T2 != 0)
{
/* Now, assign the server T2 to the client IA-NA. */
dhcpv6_ptr -> nx_dhcpv6_iana.nx_T2 = T2;
}
/* Check if we're at the end of option data yet. */
if (index == option_length)
{
/* Yes, all done. */
return NX_SUCCESS;
}
/* If the reply message includes IA address option, clear the record. */
if(dhcpv6_ptr -> nx_dhcpv6_reply_option_flags & NX_DHCPV6_INCLUDE_IA_ADDRESS_OPTION)
{
/* Clear the IA address table according to the address map value. */
for(ia_index = 0; ia_index < NX_DHCPV6_MAX_IA_ADDRESS; ia_index++)
{
/* The reply message does not include this IA option.*/
if(dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_address_map == 0)
{
/* Clear it. */
status = _nx_dhcpv6_remove_assigned_address(dhcpv6_ptr, ia_index);
}
}
}
/* Now we recurse into the options embedded in the IANA option. */
while (index + 4 <= option_length)
{
/* Get the next option code and length. */
status = _nx_dhcpv6_utility_get_block_option_length((option_data + index), &iana_option_code, &iana_option_length);
/* Check that the block data is valid. */
if (status != NX_SUCCESS)
{
/* No, return the error status. */
return status;
}
/* Skip IANA sub option code and length. */
index += 4;
/* This is a double check to verify we haven't gone off the end of the packet buffer. */
if (index + iana_option_length > option_length)
{
return (NX_DHCPV6_INVALID_IANA_DATA);
}
/* Check if this is an IA address option request. */
if (iana_option_code == NX_DHCPV6_OP_IA_ADDRESS)
{
/* Set the ia count to record the IA option of reply message. */
ia_count ++;
ia_status = 0;
/* First, find the same IPv6 address. */
for(ia_index = 0; ia_index < NX_DHCPV6_MAX_IA_ADDRESS; ia_index++)
{
/* The IPv6 address is new,so find the empty space to record it. */
if(dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_address_map == ia_count)
{
/* Yes, find it, update the IA option. */
status = _nx_dhcpv6_process_ia(dhcpv6_ptr, (option_data + index), iana_option_length, ia_index);
/* Check the process status. */
if (status != NX_SUCCESS)
{
/* No, return the error status. */
return status;
}
/* Yes, set success. */
ia_status = 1;
break;
}
}
/* Record the IA option failure. */
if(ia_status == 0)
{
/* Second, find one empty IA to record it. */
for(ia_index = 0; ia_index < NX_DHCPV6_MAX_IA_ADDRESS; ia_index++)
{
/* The IPv6 address is new,so find the empty space to record it. */
if(dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_address_map == 0)
{
/* Yes, it is available, update the IA option. */
status = _nx_dhcpv6_process_ia(dhcpv6_ptr, (option_data + index), iana_option_length, ia_index);
/* Check the process status. */
if (status != NX_SUCCESS)
{
/* No, return the error status. */
return status;
}
break;
}
}
}
}
/* Check if this is an IAaddr status option request. */
if (iana_option_code == NX_DHCPV6_OP_STATUS_CODE)
{
/* The IAaddr option returned by the DHCPv6 server includes a status option. */
/* Process the status. */
status = _nx_dhcpv6_process_status(dhcpv6_ptr, (option_data + index), iana_option_length);
/* Now check on the server status of the previous option in the DHCP message. */
if ((status == NX_SUCCESS) && (dhcpv6_ptr -> nx_status_code != NX_DHCPV6_SUCCESS))
{
/* Does the dhcpv6 client have a server error handler? */
if (dhcpv6_ptr -> nx_dhcpv6_server_error_handler)
{
/* Call the error handler with status code, option (IA_NA) and which message type it refers to. */
dhcpv6_ptr -> nx_dhcpv6_server_error_handler(dhcpv6_ptr, NX_DHCPV6_ERROR_STATUS_CODE_IN_IA_NA, dhcpv6_ptr -> nx_status_code,
dhcpv6_ptr -> nx_dhcpv6_received_message_type);
}
}
/* Check for errors processing the DHCPv6 message. */
if (status != NX_SUCCESS)
{
/* Abort further processing. Return error status. */
return status;
}
}
/* Keep track of how far into the packet we have parsed. */
index += iana_option_length;
}
return NX_SUCCESS;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_process_preference PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function extracts the preference option from the server reply. */
/* It will save as much of the time zone that will fit in the Client */
/* time zone buffer. Buffer size is user configurable. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPV6 Client instance */
/* option_data Pointer to option data */
/* option_length Size of option data */
/* */
/* OUTPUT */
/* */
/* NX_SUCCESS Successful completion status */
/* NX_DHCPV6_INVALID_PREF_DATA Preference option is missing data */
/* or improperly formatted */
/* CALLS */
/* */
/* None */
/* */
/* CALLED BY */
/* */
/* _nx_dhcpv6_extract_packet_information */
/* Extracts DHCPv6 options from */
/* server reply */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), improved */
/* packet length verification, */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_process_preference(NX_DHCPV6 *dhcpv6_ptr, UCHAR *option_data, UINT option_length)
{
/* Fill in the option code and length. */
dhcpv6_ptr -> nx_dhcpv6_preference.nx_op_code = NX_DHCPV6_OP_PREFERENCE;
dhcpv6_ptr -> nx_dhcpv6_preference.nx_option_length = (USHORT)option_length;
/* Check option length for preference value. */
if (option_length != 1)
{
return(NX_DHCPV6_INVALID_PREF_DATA);
}
/* Get the server preference field, and apply to the DHCPv6 Client. */
dhcpv6_ptr -> nx_dhcpv6_preference.nx_pref_value = (USHORT)(*option_data);
return NX_SUCCESS;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_process_server_duid PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function extracts the server DUID from the server reply and, */
/* if the Client already has a DHCPv6 server on record, verifies that */
/* it matches the Client's server DUID. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPV6 Client instance */
/* option_data Pointer to option data */
/* option_length Size of option data */
/* */
/* OUTPUT */
/* */
/* NX_SUCCESS Successful completion status */
/* NX_DHCPV6_INVALID_SERVER_DUID Server DUID is missing data or */
/* does not match the DUID on record*/
/* CALLS */
/* */
/* _nx_dhcpv6_utility_get_data Parses data from specified buffer */
/* */
/* CALLED BY */
/* */
/* _nx_dhcpv6_extract_packet_information */
/* Extracts server reply from packet */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), improved */
/* packet length verification, */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_process_server_duid(NX_DHCPV6 *dhcpv6_ptr, UCHAR *option_data, UINT option_length)
{
UINT index = 0;
ULONG temp_type;
ULONG temp_hardware_type;
ULONG temp_time = 0;
ULONG temp_msw = 0;
ULONG temp_lsw = 0;
/* Set the DHCPv6 option header fields for a Server DUID. */
dhcpv6_ptr -> nx_dhcpv6_server_duid.nx_op_code = NX_DHCPV6_OP_SERVER_ID;
dhcpv6_ptr -> nx_dhcpv6_server_duid.nx_option_length = (USHORT)option_length;
/* Check option length for DUID type and hardware type. */
if (option_length < 4)
{
return(NX_DHCPV6_INVALID_SERVER_DUID);
}
/* Extract the DUID type which should be the next 2 bytes. */
_nx_dhcpv6_utility_get_data((option_data + index), 2, &temp_type);
/* Update the index for moving the buffer pointer forward. */
index += 2;
/* Extract the hardware type which should be the next 2 bytes. */
_nx_dhcpv6_utility_get_data((option_data + index), 2, &temp_hardware_type);
/* Update the index for moving the buffer pointer forward. */
index += 2;
/* Is this a link layer plus time DUID type? */
if (temp_type == NX_DHCPV6_DUID_TYPE_LINK_TIME)
{
/* Check option length for time. */
if (index + 4 > option_length)
{
return(NX_DHCPV6_INVALID_SERVER_DUID);
}
/* Yes; Extract the time which should be the next 4 bytes. */
_nx_dhcpv6_utility_get_data((option_data + index), 4, &temp_time);
/* Update the index for moving the buffer pointer forward. */
index += 4;
}
/* Check the hardware type to extract the MSW. */
if (temp_hardware_type == NX_DHCPV6_CLIENT_HARDWARE_TYPE_ETHERNET)
{
/* The length of link layer address is 48 bits. */
/* Check option length for 48 bits mac address. */
if (index + 6 > option_length)
{
return(NX_DHCPV6_INVALID_SERVER_DUID);
}
/* Yes; Extract the link local address msw which should be the next 2 bytes. */
_nx_dhcpv6_utility_get_data((option_data + index), 2, &temp_msw);
/* Update the index for moving the buffer pointer forward. */
index += 2;
}
else if (temp_hardware_type == NX_DHCPV6_CLIENT_HARDWARE_TYPE_EUI_64)
{
/* The length of link layer address is 64 bits. */
/* Check option length for 64 bits mac address. */
if (index + 8 > option_length)
{
return(NX_DHCPV6_INVALID_SERVER_DUID);
}
/* Yes; Extract the link local address msw which should be the next 4 bytes. */
_nx_dhcpv6_utility_get_data((option_data + index), 4, &temp_msw);
/* Update the index for moving the buffer pointer forward. */
index += 4;
}
/* Yes; Extract the link local address lsw which should be the next 4 bytes. */
_nx_dhcpv6_utility_get_data((option_data + index), 4, &temp_lsw);
/* Update the index for moving the buffer pointer forward. */
index += 4;
/* Check if we are past the end of the buffer. */
if (index != option_length)
{
/* Yes, return the error status to reject the packet. */
return NX_DHCPV6_INVALID_SERVER_DUID;
}
/* If the client state in SENDING SOLICIT/CONFRIM/REBIND/INFORM_REQUEST, record the server DUID. */
if (dhcpv6_ptr -> nx_dhcpv6_state == NX_DHCPV6_STATE_SENDING_SOLICIT ||
dhcpv6_ptr -> nx_dhcpv6_state == NX_DHCPV6_STATE_SENDING_CONFIRM ||
dhcpv6_ptr -> nx_dhcpv6_state == NX_DHCPV6_STATE_SENDING_REBIND ||
dhcpv6_ptr -> nx_dhcpv6_state == NX_DHCPV6_STATE_SENDING_INFORM_REQUEST )
{
/* No previous server DUID in the Client record. Copy it over now. */
dhcpv6_ptr -> nx_dhcpv6_server_duid.nx_duid_type = (USHORT)temp_type;
/* Is this a TIME Duid type? */
if (temp_type == NX_DHCPV6_DUID_TYPE_LINK_TIME)
{
/* Yes, write in the time data. */
dhcpv6_ptr -> nx_dhcpv6_server_duid.nx_duid_time = temp_time;
}
dhcpv6_ptr -> nx_dhcpv6_server_duid.nx_hardware_type = (USHORT)temp_hardware_type;
dhcpv6_ptr -> nx_dhcpv6_server_duid.nx_link_layer_address_msw = temp_msw;
dhcpv6_ptr -> nx_dhcpv6_server_duid.nx_link_layer_address_lsw = temp_lsw;
}
else
{
/* Yes; Verify this Server DUID matches the Server DUID from the Client record. */
if ((dhcpv6_ptr -> nx_dhcpv6_server_duid.nx_duid_time != temp_time) ||
(dhcpv6_ptr -> nx_dhcpv6_server_duid.nx_link_layer_address_msw != temp_msw) ||
(dhcpv6_ptr -> nx_dhcpv6_server_duid.nx_link_layer_address_lsw != temp_lsw))
{
/* It doesn't. Return an error status to reject this packet! */
return NX_DHCPV6_INVALID_SERVER_DUID;
}
}
/* Return successful completion status. */
return NX_SUCCESS;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_process_status PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function extracts the option status option from the server */
/* reply. It also attempts to save the as much of server status message*/
/* that will fit into the status message buffer. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPV6 Client instance */
/* option_data Pointer to option data */
/* option_length Size of option data */
/* */
/* OUTPUT */
/* */
/* NX_SUCCESS Successful completion status */
/* */
/* CALLS */
/* */
/* memcpy Copies specified area of memory */
/* */
/* CALLED BY */
/* */
/* _nx_dhcpv6_process_iana Processes IANA in reply buffer */
/* DHCPv6 request */
/* _nx_dhcpv6_process_ia Processes IA in reply buffer */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), improved */
/* packet length verification, */
/* verified memcpy use cases, */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_process_status(NX_DHCPV6 *dhcpv6_ptr, UCHAR *option_data, UINT option_length)
{
UINT index = 0;
UINT message_length;
ULONG status_code;
/* Check option length for status code. */
if (option_length < 2)
{
return(NX_DHCPV6_INVALID_OPTION_DATA);
}
/* Get the status field itself. */
_nx_dhcpv6_utility_get_data((option_data + index), sizeof(USHORT), &status_code);
/* Update the index for moving the buffer pointer forward. */
index += 2;
/* Set the status code. */
dhcpv6_ptr -> nx_status_code = (USHORT)status_code;
/* Now figure out how much of the message we can save, if not all of it. */
if ((option_length - 2) > NX_DHCPV6_MAX_MESSAGE_SIZE)
{
/* Store up to this much, message is truncated but possibly still useful. */
message_length = NX_DHCPV6_MAX_MESSAGE_SIZE;
}
else
{
/* Store all of it. */
message_length = option_length - 2;
}
/* Copy the status into the Client record. */
memcpy(dhcpv6_ptr -> nx_status_message, (option_data + index), message_length); /* Use case of memcpy is verified. */
return NX_SUCCESS;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_process_time_zone PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function extracts the time zone option from the server reply. */
/* It will save as much of the time zone that will fit in the Client */
/* time zone buffer. Buffer size is user configurable. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPV6 Client instance */
/* option_data Pointer to option data */
/* option_length Size of option data */
/* */
/* OUTPUT */
/* */
/* NX_SUCCESS Successful completion status */
/* */
/* CALLS */
/* */
/* None */
/* */
/* CALLED BY */
/* */
/* _nx_dhcpv6_extract_packet_information */
/* Extracts DHCPv6 options from */
/* server reply */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), improved */
/* packet length verification, */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_process_time_zone(NX_DHCPV6 *dhcpv6_ptr, UCHAR *option_data, UINT option_length)
{
UINT i;
/* Make sure the time zone fits in the client buffer. */
if (option_length > NX_DHCPV6_TIME_ZONE_BUFFER_SIZE)
{
/* It doesn't. Fit what we can. */
option_length = NX_DHCPV6_TIME_ZONE_BUFFER_SIZE;
}
/* Copy the time zone from the buffer to the Client record. */
for (i = 0; i < option_length; i++)
{
dhcpv6_ptr -> nx_dhcpv6_time_zone[i] = *(option_data + i);
}
/* Return completion status. */
return NX_SUCCESS;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_process_time_server PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function extracts the time server option from the server reply.*/
/* It will save as many time server addresses as are in the reply for */
/* which the Client is configured to save. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPV6 Client instance */
/* option_data Pointer to option data */
/* option_length Size of option data */
/* */
/* OUTPUT */
/* */
/* NX_SUCCESS Successful completion status */
/* */
/* CALLS */
/* */
/* memcpy Copies specified area of memory */
/* */
/* CALLED BY */
/* */
/* _nx_dhcpv6_extract_packet_information */
/* Extracts DHCPv6 options from */
/* server reply */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), improved */
/* packet length verification, */
/* verified memcpy use cases, */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_process_time_server(NX_DHCPV6 *dhcpv6_ptr, UCHAR *option_data, UINT option_length)
{
UINT index = 0;
UINT w, j = 0;
/* Loop through the length of the buffer to parse. */
while (index + 16 <= option_length)
{
/* Check that the DHCPv6 Client configured to store this time server address e.g. it may
only store one address, but the server could be sending two or more. */
if (j < NX_DHCPV6_NUM_TIME_SERVERS)
{
/* Set the IP version. */
dhcpv6_ptr -> nx_dhcpv6_time_server_address[j].nxd_ip_version = NX_IP_VERSION_V6;
/* Get the next IPv6 time server address. */
for (w = 0; w <= 3; w++)
{
/* Yes; copy each IPv6 address word into the time server address. */
memcpy(&(dhcpv6_ptr -> nx_dhcpv6_time_server_address[j].nxd_ip_address.v6[w]), /* Use case of memcpy is verified. */
(option_data + index), sizeof(ULONG));
/* Adjust for endianness. */
NX_CHANGE_ULONG_ENDIAN(dhcpv6_ptr -> nx_dhcpv6_time_server_address[j].nxd_ip_address.v6[w]);
/* Move to the next IPv6 address word. */
index += 4;
}
/* Start parsing the next time server address, if there is one. */
j++;
}
else
{
/* Move to the next timer server address. */
index += 16;
}
}
/* Is there any more data in this option? */
if (index != option_length)
{
/* Yes, treat as in improperly formatted packet. */
return NX_DHCPV6_INVALID_OPTION_DATA;
}
return NX_SUCCESS;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_remove_assigned_address PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function removes the DHCPv6 Client address from the Client */
/* record and from the IP address table. IP lease lifetimes and IP */
/* addresses in the Client record are also cleared. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPV6 Client instance*/
/* */
/* OUTPUT */
/* */
/* NX_SUCCESS Successful Completion status */
/* NX_INVALID_INTERFACE Invalid index in IP address table*/
/* status Failed mutex get */
/* */
/* CALLS */
/* */
/* tx_mutex_get Get exclusive lock on time keeper*/
/* tx_mutex_put Release the lock on time keeper */
/* _nx_dhcpv6_set_IP_address_NULL Set the IP address to NULL */
/* */
/* CALLED BY */
/* */
/* nx_dhcpv6_process */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_remove_assigned_address(NX_DHCPV6 *dhcpv6_ptr, UINT ia_index)
{
UINT index;
/* Only clear one address. */
if(ia_index != NX_DHCPV6_REMOVE_ALL_IA_ADDRESS)
{
/* Check for invalid IA index. */
if (ia_index >= NX_DHCPV6_MAX_IA_ADDRESS)
{
return(NX_DHCPV6_REACHED_MAX_IA_ADDRESS);
}
if((dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_address_status) &&
(dhcpv6_ptr -> nx_dhcpv6_client_address_index[ia_index] != 0) &&
(dhcpv6_ptr -> nx_dhcpv6_client_address_index[ia_index] != 0xFFFFFFFF))
{
/* Now remove the address from the IP address table. */
nxd_ipv6_address_delete(dhcpv6_ptr -> nx_dhcpv6_ip_ptr, dhcpv6_ptr -> nx_dhcpv6_client_address_index[ia_index]);
/* Set the address index to invalid. */
dhcpv6_ptr -> nx_dhcpv6_client_address_index[ia_index] = 0xFFFFFFFF;
}
/* Clear the IA data. */
memset(&dhcpv6_ptr -> nx_dhcpv6_ia[ia_index], 0, sizeof(NX_DHCPV6_IA_ADDRESS));
}
/* Clear the all addresses. */
else
{
/* Zero out time accrued on the current lease. */
dhcpv6_ptr -> nx_dhcpv6_IP_lifetime_time_accrued = 0;
/* Set all lease lifetime and time fields to zero. */
dhcpv6_ptr -> nx_dhcpv6_iana.nx_T1 = 0;
dhcpv6_ptr -> nx_dhcpv6_iana.nx_T2 = 0;
/* Delete the IPv6 address of IP instance. */
for(index = 0; index < NX_DHCPV6_MAX_IA_ADDRESS; index++)
{
if((dhcpv6_ptr -> nx_dhcpv6_ia[index].nx_address_status) &&
(dhcpv6_ptr -> nx_dhcpv6_client_address_index[index] != 0) &&
(dhcpv6_ptr -> nx_dhcpv6_client_address_index[index] != 0xFFFFFFFF))
{
/* Now remove the address from the IP address table. */
nxd_ipv6_address_delete(dhcpv6_ptr -> nx_dhcpv6_ip_ptr, dhcpv6_ptr -> nx_dhcpv6_client_address_index[index]);
/* Set the address index to invalid. */
dhcpv6_ptr -> nx_dhcpv6_client_address_index[index] = 0xFFFFFFFF;
}
}
/* Clear the all IA data. */
memset(&dhcpv6_ptr -> nx_dhcpv6_ia[0], 0, NX_DHCPV6_MAX_IA_ADDRESS * sizeof(NX_DHCPV6_IA_ADDRESS));
/* Removed the default router. */
if (dhcpv6_ptr -> nx_dhcpv6_state >= NX_DHCPV6_STATE_SENDING_RENEW)
{
nxd_ipv6_default_router_delete(dhcpv6_ptr -> nx_dhcpv6_ip_ptr, &(dhcpv6_ptr -> nx_dhcpv6_server_address));
memset(&(dhcpv6_ptr -> nx_dhcpv6_server_address), 0, sizeof(NXD_ADDRESS));
}
}
/* Clear the all address. */
return NX_SUCCESS;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_request PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function sets the DHCPv6 Client state with the supplied state */
/* (request). The DHCP Client thread will detect a state change and */
/* process the new state. */
/* */
/* Note the return status only reflects the outcome of sending the */
/* message, it does not indicate whether the request was successfully */
/* granted. The host application is notified of "state" changes e.g. */
/* NX_DHCPV6_STATE_SUCCESS or NX_DHCPV6_STATE_IP_FAILURE in the */
/* callback function nx_dhcpv6_state_change_callback. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPV6 Client instance*/
/* dhcpv6_state State for making DHCPv6 request */
/* */
/* OUTPUT */
/* */
/* NX_SUCCESS Successful completion status */
/* NX_DHCP_NOT_STARTED DHCPv6 Client not started */
/* status Get mutex status */
/* */
/* CALLS */
/* */
/* tx_mutex_get Get DHCPv6 Client mutex */
/* tx_mutex_put Releases the Client mutex */
/* */
/* CALLED BY */
/* */
/* _nx_dhcpv6_request_solicit Submits a SOLICIT request to Client*/
/* _nx_dhcpv6_request_renew Submits a RENEW request to Client */
/* _nx_dhcpv6_request_rebind Submits a REBIND request to Client */
/* _nx_dhcpv6_request_release Submits a RELEASE request to Client*/
/* _nx_dhcpv6_request_decline Submits a DECLINE request to Client*/
/* _nx_dhcpv6_request_confirm Submits a CONFIRM request to Client*/
/* _nx_dhcpv6_request_inform_request */
/* Submits an Inform Request request */
/* to Client */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_request(NX_DHCPV6 *dhcpv6_ptr, UINT dhcpv6_state)
{
UINT status;
/* First get an exclusive lock on the DHCPv6 Client. */
status = tx_mutex_get(&(dhcpv6_ptr -> nx_dhcpv6_client_mutex), NX_DHCPV6_MUTEX_WAIT);
/* Check for error. */
if (status != TX_SUCCESS)
{
/* Return the error status. */
return status;
}
/* Determine if DHCP is started. */
if (dhcpv6_ptr -> nx_dhcpv6_started == NX_FALSE)
{
/* Release the DHCP mutex. */
tx_mutex_put(&(dhcpv6_ptr -> nx_dhcpv6_client_mutex));
/* DHCP is not started so it can't be stopped. */
return(NX_DHCPV6_NOT_STARTED);
}
/* Wait for an opportunity to stop the DHCPv6 Client thread e.g. not in the midst of
modifying the host DHCP profile! */
while (dhcpv6_ptr -> nx_dhcpv6_sleep_flag != NX_TRUE)
{
/* Release the DHCP mutex. */
tx_mutex_put(&(dhcpv6_ptr -> nx_dhcpv6_client_mutex));
/* Sleep temporarily. */
tx_thread_sleep(1);
/* Get the DHCP mutex. */
tx_mutex_get(&(dhcpv6_ptr -> nx_dhcpv6_client_mutex), NX_DHCPV6_MUTEX_WAIT);
}
/* Set the Client state to process the DHCPv6 request. */
dhcpv6_ptr -> nx_dhcpv6_state = (UCHAR)dhcpv6_state;
/* Release the Client mutex. */
tx_mutex_put(&(dhcpv6_ptr -> nx_dhcpv6_client_mutex));
return NX_SUCCESS;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nxe_dhcpv6_request_confirm PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function performs error checking on the NetX DHCPv6 Confirm */
/* request service. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPV6 Client instance*/
/* */
/* OUTPUT */
/* */
/* status Completion status */
/* NX_PTR_ERROR Invalid pointer input */
/* */
/* */
/* CALLS */
/* */
/* _nx_dhcpv6_request_confirm Actual DHCPV6 process Confirm */
/* request service */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nxe_dhcpv6_request_confirm(NX_DHCPV6 *dhcpv6_ptr)
{
UINT status;
/* Check for invalid pointer input. */
if (!dhcpv6_ptr)
{
return NX_PTR_ERROR;
}
/* Check for appropriate caller. */
NX_THREADS_ONLY_CALLER_CHECKING
/* Call the actual service. */
status = _nx_dhcpv6_request_confirm(dhcpv6_ptr);
/* Return completion status. */
return status;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_request_confirm PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function sends a confirm request to the server for the Client */
/* to know the DHCPv6 IP address already assigned to it by the server. */
/* */
/* A host application should call this service after a host has been */
/* disconnected from the network or powered down to verify its address */
/* is still valid. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPV6 Client instance*/
/* */
/* OUTPUT */
/* */
/* status Completion status */
/* */
/* CALLS */
/* */
/* _nx_dhcpv6_request Actual DHCPV6 request service */
/* tx_timer_activate Activate the session timer */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_request_confirm(NX_DHCPV6 *dhcpv6_ptr)
{
UINT status;
/* Set the initial and max retransmission timeouts, and max number of retries. */
dhcpv6_ptr -> nx_dhcpv6_transmission_timeout = NX_DHCPV6_INIT_CONFIRM_TRANSMISSION_TIMEOUT;
dhcpv6_ptr -> nx_dhcpv6_retransmission_count = 0;
/* Set the initaial elasped time of DHCPv6 message. */
dhcpv6_ptr -> nx_dhcpv6_elapsed_time.nx_session_time = 0;
/* Set the retransmission information(IRT, MRC, MRT, MRD). */
dhcpv6_ptr -> nx_dhcpv6_init_retransmission_timeout = NX_DHCPV6_INIT_CONFIRM_TRANSMISSION_TIMEOUT;
dhcpv6_ptr -> nx_dhcpv6_max_retransmission_count = NX_DHCPV6_MAX_CONFIRM_RETRANSMISSION_COUNT;
dhcpv6_ptr -> nx_dhcpv6_max_retransmission_timeout = NX_DHCPV6_MAX_CONFIRM_RETRANSMISSION_TIMEOUT;
dhcpv6_ptr -> nx_dhcpv6_max_retransmission_duration = NX_DHCPV6_MAX_CONFIRM_RETRANSMISSION_DURATION;
/* Activate the session timer to update the elapsed time. */
tx_timer_activate(&dhcpv6_ptr -> nx_dhcpv6_session_timer);
/* Call the internal function. */
status = _nx_dhcpv6_request(dhcpv6_ptr, NX_DHCPV6_STATE_SENDING_CONFIRM);
/* Return completion status. */
return status;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_request_decline PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function sends a decline request to the server for the Client */
/* to tell the server it does not accept the assigned address. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPV6 Client instance*/
/* */
/* OUTPUT */
/* */
/* status Completion status */
/* */
/* CALLS */
/* */
/* _nx_dhcpv6_request Actual DHCPV6 request service */
/* tx_timer_activate Activate the session timer */
/* */
/* CALLED BY */
/* */
/* _nx_dhcpv6_process Processes server replies to */
/* DHCPv6 Client requests */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_request_decline(NX_DHCPV6 *dhcpv6_ptr)
{
UINT status;
UINT ia_index;
/* Set the initial and max retransmission timeout and max number of retries. */
dhcpv6_ptr -> nx_dhcpv6_transmission_timeout = NX_DHCPV6_INIT_DECLINE_TRANSMISSION_TIMEOUT;
dhcpv6_ptr -> nx_dhcpv6_retransmission_count = 0;
/* Set the initaial elasped time of DHCPv6 message. */
dhcpv6_ptr -> nx_dhcpv6_elapsed_time.nx_session_time = 0;
/* Set the retransmission information(IRT, MRC, MRT, MRD). */
dhcpv6_ptr -> nx_dhcpv6_init_retransmission_timeout = NX_DHCPV6_INIT_DECLINE_TRANSMISSION_TIMEOUT;
dhcpv6_ptr -> nx_dhcpv6_max_retransmission_count = NX_DHCPV6_MAX_DECLINE_RETRANSMISSION_COUNT;
dhcpv6_ptr -> nx_dhcpv6_max_retransmission_timeout = NX_DHCPV6_MAX_DECLINE_RETRANSMISSION_TIMEOUT;
dhcpv6_ptr -> nx_dhcpv6_max_retransmission_duration = NX_DHCPV6_MAX_DECLINE_RETRANSMISSION_DURATION;
/* Activate the session timer to update the elapsed time. */
tx_timer_activate(&dhcpv6_ptr -> nx_dhcpv6_session_timer);
/* Now remove the address from the IP address table,the client MUST NOT use any of the addresses it is declining
as the source address in the Release message or in any subsequently transmitted message, RFC3315,section18.1.7.. */
/* Set the DHCPv6 Client IPv6 addresses. */
for(ia_index = 0; ia_index < NX_DHCPV6_MAX_IA_ADDRESS; ia_index++)
{
/* Now remove the address from the IP address table,the client MUST NOT use any of the addresses it is declining
as the source address in the Release message or in any subsequently transmitted message, RFC3315,section18.1.7.. */
/* Verify we have a valid address index. */
if(dhcpv6_ptr -> nx_dhcpv6_client_address_index[ia_index] >= NX_MAX_IPV6_ADDRESSES)
{
return NX_INVALID_INTERFACE;
}
if(dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_address_status == NX_DHCPV6_IA_ADDRESS_STATE_DAD_FAILURE)
{
/* Remove the address from the IP instance address table. */
nxd_ipv6_address_delete(dhcpv6_ptr -> nx_dhcpv6_ip_ptr, dhcpv6_ptr -> nx_dhcpv6_client_address_index[ia_index]);
/* Record the address index in the Client record. */
dhcpv6_ptr -> nx_dhcpv6_client_address_index[ia_index] = 0xFFFFFFFF;
}
}
/* Call the internal function and return completion status. */
status = _nx_dhcpv6_request(dhcpv6_ptr, NX_DHCPV6_STATE_SENDING_DECLINE);
/* Return completion status. */
return status;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nxe_dhcpv6_request_inform_request PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function performs error checking on the NetX DHCPv6 information*/
/* request service. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPV6 Client instance*/
/* */
/* OUTPUT */
/* */
/* status Completion status */
/* NX_PTR_ERROR Invalid pointer input */
/* */
/* */
/* CALLS */
/* */
/* _nx_dhcpv6_request_inform_request Actual DHCPV6 process Inform */
/* Request request service */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nxe_dhcpv6_request_inform_request(NX_DHCPV6 *dhcpv6_ptr)
{
UINT status;
/* Check for invalid pointer input. */
if (!dhcpv6_ptr)
{
return NX_PTR_ERROR;
}
/* Check for appropriate caller. */
NX_THREADS_ONLY_CALLER_CHECKING
/* Call the actual service. */
status = _nx_dhcpv6_request_inform_request(dhcpv6_ptr);
/* Return completion status. */
return status;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_request_inform_request PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function sends a inform request to the server for the Client */
/* to obtain network parameters from any DHCPv6 server on the network. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPV6 Client instance*/
/* */
/* OUTPUT */
/* */
/* status Completion status */
/* */
/* CALLS */
/* */
/* _nx_dhcpv6_request Actual DHCPV6 request service */
/* tx_timer_activate Activate the session timer */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_request_inform_request(NX_DHCPV6 *dhcpv6_ptr)
{
UINT status;
/* Set the initial and max retransmission timeout and max number of retries. */
dhcpv6_ptr -> nx_dhcpv6_transmission_timeout = NX_DHCPV6_INIT_INFORM_TRANSMISSION_TIMEOUT;
dhcpv6_ptr -> nx_dhcpv6_retransmission_count = 0;
/* Set the initaial elasped time of DHCPv6 message. */
dhcpv6_ptr -> nx_dhcpv6_elapsed_time.nx_session_time = 0;
/* Set the retransmission information(IRT, MRC, MRT, MRD). */
dhcpv6_ptr -> nx_dhcpv6_init_retransmission_timeout = NX_DHCPV6_INIT_INFORM_TRANSMISSION_TIMEOUT;
dhcpv6_ptr -> nx_dhcpv6_max_retransmission_count = NX_DHCPV6_MAX_INFORM_RETRANSMISSION_COUNT;
dhcpv6_ptr -> nx_dhcpv6_max_retransmission_timeout = NX_DHCPV6_MAX_INFORM_RETRANSMISSION_TIMEOUT;
dhcpv6_ptr -> nx_dhcpv6_max_retransmission_duration = NX_DHCPV6_MAX_INFORM_RETRANSMISSION_DURATION;
/* Activate the session timer to update the elapsed time. */
tx_timer_activate(&dhcpv6_ptr -> nx_dhcpv6_session_timer);
/* Call the internal function and return completion status. */
status = _nx_dhcpv6_request(dhcpv6_ptr, NX_DHCPV6_STATE_SENDING_INFORM_REQUEST);
/* Return actual completion status. */
return status;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nxe_dhcpv6_request_option_DNS_server PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function performs error checking on the NetX submit and process*/
/* the DNS server request option from the DHPCv6 Server service. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPV6 Client instance*/
/* enable Flag indicating if the DNS server*/
/* request enabled or disabled */
/* OUTPUT */
/* */
/* status Completion status */
/* NX_PTR_ERROR Invalid pointer input */
/* */
/* */
/* CALLS */
/* */
/* _nx_dhcpv6_request_option_DNS_server */
/* Actual DHCPV6 process DNS server */
/* request service */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nxe_dhcpv6_request_option_DNS_server(NX_DHCPV6 *dhcpv6_ptr, UINT enable)
{
UINT status;
/* Check for invalid pointer input. */
if (!dhcpv6_ptr)
{
return NX_PTR_ERROR;
}
/* Check for appropriate caller. */
NX_THREADS_ONLY_CALLER_CHECKING
/* Call the actual service. */
status = _nx_dhcpv6_request_option_DNS_server(dhcpv6_ptr, enable);
/* Return completion status. */
return status;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_request_option_DNS_server PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function enables or disables the DHCPv6 DNS server option. If */
/* enabled this option is added to the option list in DHCPv6 messages */
/* the Client sends to the server. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPV6 Client instance*/
/* enable Flag indicating if the DNS server*/
/* request enabled or disabled */
/* */
/* OUTPUT */
/* */
/* NX_SUCCESS Successful completion status */
/* */
/* CALLS */
/* */
/* None */
/* */
/* CALLED BY */
/* */
/* Application code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_request_option_DNS_server(NX_DHCPV6 *dhcpv6_ptr, UINT enable)
{
/* Are we enabling this feature? */
if (enable == NX_TRUE)
{
/* Yes, register this option request with the DHCPv6 Client. */
dhcpv6_ptr -> nx_dhcpv6_option_request.nx_op_request |= (USHORT)NX_DHCPV6_DNS_SERVER_OPTION;
}
else
{
/* Clear this option request with the DHCPv6 Client. */
dhcpv6_ptr -> nx_dhcpv6_option_request.nx_op_request &= (USHORT)(~NX_DHCPV6_DNS_SERVER_OPTION);
}
/* Return successful completion. */
return NX_SUCCESS;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nxe_dhcpv6_request_option_domain_name PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function performs error checking on the NetX submit and process*/
/* the domain name request option from the DHPCv6 Server service. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPV6 Client instance */
/* enable Flag indicating if the domain name*/
/* request enabled or disabled */
/* OUTPUT */
/* */
/* status Completion status */
/* NX_PTR_ERROR Invalid pointer input */
/* */
/* */
/* CALLS */
/* */
/* _nx_dhcpv6_request_option_time_server */
/* Actual DHCPV6 process domain name*/
/* request service */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nxe_dhcpv6_request_option_domain_name(NX_DHCPV6 *dhcpv6_ptr, UINT enable)
{
UINT status;
/* Check for invalid pointer input. */
if (!dhcpv6_ptr)
{
return NX_PTR_ERROR;
}
/* Check for appropriate caller. */
NX_THREADS_ONLY_CALLER_CHECKING
/* Call the actual service. */
status = _nx_dhcpv6_request_option_domain_name(dhcpv6_ptr, enable);
/* Return completion status. */
return status;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_request_option_domain_name PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function enables or disables the DHCPv6 domain name option. If*/
/* enabled this option is added to the option list in DHCPv6 messages */
/* the Client sends to the server. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPV6 Client instance */
/* enable Flag indicating if the domain name*/
/* request enabled or disabled */
/* */
/* OUTPUT */
/* */
/* NX_SUCCESS Successful completion status */
/* */
/* CALLS */
/* */
/* None */
/* */
/* CALLED BY */
/* */
/* Application code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_request_option_domain_name(NX_DHCPV6 *dhcpv6_ptr, UINT enable)
{
/* Are we enabling this feature? */
if (enable == NX_TRUE)
{
/* Yes, register this option request with the DHCPv6 Client. */
dhcpv6_ptr -> nx_dhcpv6_option_request.nx_op_request |= (USHORT)NX_DHCPV6_DOMAIN_NAME_OPTION;
}
else
{
/* Clear this option request with the DHCPv6 Client. */
dhcpv6_ptr -> nx_dhcpv6_option_request.nx_op_request &= (USHORT)(~NX_DHCPV6_DOMAIN_NAME_OPTION);
}
return NX_SUCCESS;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nxe_dhcpv6_request_option_time_server PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function performs error checking on the NetX submit and process*/
/* the time server request option from the DHPCv6 Server service. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPV6 Client instance */
/* enable Flag indicating if the time server*/
/* request enabled or disabled */
/* OUTPUT */
/* */
/* status Completion status */
/* NX_PTR_ERROR Invalid pointer input */
/* */
/* */
/* CALLS */
/* */
/* _nx_dhcpv6_request_option_time_server */
/* Actual DHCPV6 process time server*/
/* request service */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nxe_dhcpv6_request_option_time_server(NX_DHCPV6 *dhcpv6_ptr, UINT enable)
{
UINT status;
/* Check for invalid pointer input. */
if (!dhcpv6_ptr)
{
return NX_PTR_ERROR;
}
/* Check for appropriate caller. */
NX_THREADS_ONLY_CALLER_CHECKING
/* Call the actual service. */
status = _nx_dhcpv6_request_option_time_server(dhcpv6_ptr, enable);
/* Return completion status. */
return status;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_request_option_time_server PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function enables or disables the DHCPv6 time server option. If*/
/* enabled this option is added to the option list in DHCPv6 messages */
/* the Client sends to the server. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPV6 Client instance */
/* enable Flag indicating if the time server*/
/* request enabled or disabled */
/* */
/* OUTPUT */
/* */
/* status Actual completion status */
/* NX_SUCCESS Successful completion status */
/* */
/* CALLS */
/* */
/* None */
/* */
/* CALLED BY */
/* */
/* Application code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_request_option_time_server(NX_DHCPV6 *dhcpv6_ptr, UINT enable)
{
/* Is the caller requesting the time server option? */
if (enable == NX_TRUE)
{
/* Yes, register this option request with the DHCPv6 Client. */
dhcpv6_ptr -> nx_dhcpv6_option_request.nx_op_request |= (USHORT)NX_DHCPV6_SNTP_SERVER_OPTION;
}
else
{
/* Clear this option request with the DHCPv6 Client. */
dhcpv6_ptr -> nx_dhcpv6_option_request.nx_op_request &= (USHORT)(~NX_DHCPV6_SNTP_SERVER_OPTION);
}
return NX_SUCCESS;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nxe_dhcpv6_request_option_timezone PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function performs error checking on the NetX submit and process*/
/* the time zone request option from the DHPCv6 Server service. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPV6 Client instance */
/* enable Flag indicating if the time zone */
/* request enabled or disabled */
/* OUTPUT */
/* */
/* status Completion status */
/* NX_PTR_ERROR Invalid pointer input */
/* */
/* */
/* CALLS */
/* */
/* _nx_dhcpv6_request_option_time_zone Actual DHCPV6 process time zone */
/* request service */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nxe_dhcpv6_request_option_timezone(NX_DHCPV6 *dhcpv6_ptr, UINT enable)
{
UINT status;
/* Check for invalid pointer input. */
if (!dhcpv6_ptr)
{
return NX_PTR_ERROR;
}
/* Check for appropriate caller. */
NX_THREADS_ONLY_CALLER_CHECKING
/* Call the actual service. */
status = _nx_dhcpv6_request_option_timezone(dhcpv6_ptr, enable);
/* Return completion status. */
return status;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_request_option_timezone PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function enables or disables the DHCPv6 time zone option. If */
/* enabled this option is added to the option list in DHCPv6 messages */
/* the Client sends to the server. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPV6 Client instance*/
/* enable Flag indicating if the time zone */
/* request enabled or disabled */
/* */
/* OUTPUT */
/* */
/* NX_SUCCESS Successful completion status */
/* */
/* CALLS */
/* */
/* None */
/* */
/* CALLED BY */
/* */
/* Application code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_request_option_timezone(NX_DHCPV6 *dhcpv6_ptr, UINT enable)
{
/* Are we enabling this feature? */
if (enable == NX_TRUE)
{
/* Yes, register this option request with the DHCPv6 Client. */
dhcpv6_ptr -> nx_dhcpv6_option_request.nx_op_request |= NX_DHCPV6_NEW_POSIX_TIMEZONE_OPTION;
}
else
{
/* Clear this option request with the DHCPv6 Client. */
dhcpv6_ptr -> nx_dhcpv6_option_request.nx_op_request &= (USHORT)(~NX_DHCPV6_NEW_POSIX_TIMEZONE_OPTION);
}
return NX_SUCCESS;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nxe_dhcpv6_request_option_FQDN PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function performs error checking on the request fully qualified*/
/* domain name option service. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPV6 Client instance*/
/* domain_name DHCPv6 CLient domain name */
/* op DHCPv6 Client operation */
/* */
/* OUTPUT */
/* */
/* status Completion status */
/* NX_PTR_ERROR Invalid pointer input */
/* */
/* */
/* CALLS */
/* */
/* _nx_dhcpv6_request_option_FQDN Actual DHCPv6 process FQDN */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nxe_dhcpv6_request_option_FQDN(NX_DHCPV6 *dhcpv6_ptr, CHAR *domain_name, UINT op)
{
UINT status;
/* Check for invalid pointer input. */
if ((!dhcpv6_ptr) || (!domain_name))
{
return NX_PTR_ERROR;
}
/* Check for appropriate caller. */
NX_THREADS_ONLY_CALLER_CHECKING
/* Call the actual service. */
status = _nx_dhcpv6_request_option_FQDN(dhcpv6_ptr, domain_name, op);
/* Return completion status. */
return status;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_request_option_FQDN PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function processes the DHCPv6 Client fully qualified domain */
/* name. DHCPv6 Client sends this option to indicate if the server */
/* SHOULD or SHOULD NOT perform the AAAA RR or DNS updates. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPV6 Client instance*/
/* domain_name DHCPv6 CLient domain name */
/* op DHCPv6 Client operation */
/* */
/* OUTPUT */
/* */
/* NX_SUCCESS Successful completion status */
/* */
/* CALLS */
/* */
/* None */
/* */
/* CALLED BY */
/* */
/* Application code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_request_option_FQDN(NX_DHCPV6 *dhcpv6_ptr, CHAR *domain_name, UINT op)
{
UINT name_length;
/* Set the Client FQDN option code. */
dhcpv6_ptr -> nx_dhcpv6_client_FQDN.nx_op_code = NX_DHCPV6_OP_CLIENT_FQDN;
/* Check domain name lengrh. The total length of a domain name is restricted to 255 octets or less. RFC1035. */
if (_nx_utility_string_length_check(domain_name, &name_length, NX_DHCPV6_MAX_NAME_SIZE))
{
return(NX_DHCPV6_PARAM_ERROR);
}
/* Set the Client FQDN option length. 1 + length of domain name(domain name length + label + terminator) . */
dhcpv6_ptr -> nx_dhcpv6_client_FQDN.nx_op_length = (USHORT)(1 + name_length + 2);
/* Set the Client fully qualified domain name. */
dhcpv6_ptr -> nx_dhcpv6_client_FQDN.nx_domain_name = domain_name;
/* Flags Field.
0 1 2 3 4 5 6 7
+-+-+-+-+-+-+-+-+
| MBZ |N|O|S|
+-+-+-+-+-+-+-+-+
*/
/* Set the flags. */
if (op == NX_DHCPV6_CLIENT_DESIRES_UPDATE_AAAA_RR)
{
/* DHCPv6 Client chooses to update the FQDN-to-IPv6 address mapping for FQDN and address(es) used by the Cslient.
Set the "S", "O" and "N" bits as 0. */
dhcpv6_ptr -> nx_dhcpv6_client_FQDN.nx_flags = 0x00;
}
else if (op == NX_DHCPV6_CLIENT_DESIRES_SERVER_DO_DNS_UPDATE)
{
/* DHCPv6 Client chooses to update the FQDN-to-IPv6 address mapping for FQDN and address(es) used by the Client to the Server.
Set the "S" bit as 1, Set "O" and "N" bits as 0. */
dhcpv6_ptr -> nx_dhcpv6_client_FQDN.nx_flags = 0x01;
}
else
{
/* DHCPv6 Client choose to request that the Server perform no DNS updates on its behalf.
Set the "N" bit as 1, Set "O" and "S" bits as 0. */
dhcpv6_ptr -> nx_dhcpv6_client_FQDN.nx_flags = 0x04;
}
/* Yes, register this option request with the DHCPv6 Client. */
dhcpv6_ptr -> nx_dhcpv6_option_request.nx_op_request |= NX_DHCPV6_CLIENT_FQDN_OPTION;
return NX_SUCCESS;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_request_rebind PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function sends a rebind request to the server for the Client to*/
/* obtain or rebind an IP address with a DHCPv6 server on the network. */
/* */
/* Note: the Client thread task will detect when it is time to rebind */
/* the Client IP address and call the expired address handler if one is*/
/* set. The expired address handler is where the host should call this*/
/* service from. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPV6 Client instance*/
/* */
/* OUTPUT */
/* */
/* NX_SUCCESS Rebind already initiated */
/* status Completion status */
/* */
/* CALLS */
/* */
/* _nx_dhcpv6_request Actual DHCPV6 request service */
/* tx_timer_activate Activate the session timer */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* _nx_dhcpv6_thread_entry DHCPv6 Client thread task */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_request_rebind(NX_DHCPV6 *dhcpv6_ptr)
{
UINT status;
UINT ia_index;
UINT max_valid_lifetime = 0;
/* Is the Client state set to REBIND yet? */
if (dhcpv6_ptr -> nx_dhcpv6_state == NX_DHCPV6_STATE_SENDING_REBIND)
{
/* Yes, the rebind process is already started. No need to re-request it.
Also must not zero out retry count or reset timeout back to starting value. */
return NX_SUCCESS;
}
/* Set the initial and max retransmission timeouts and max number of retries. */
dhcpv6_ptr -> nx_dhcpv6_transmission_timeout = NX_DHCPV6_INIT_REBIND_TRANSMISSION_TIMEOUT;
dhcpv6_ptr -> nx_dhcpv6_retransmission_count = 0;
/* Set the initaial elasped time of DHCPv6 message. */
dhcpv6_ptr -> nx_dhcpv6_elapsed_time.nx_session_time = 0;
/* Set the retransmission information(IRT, MRC, MRT, MRD). */
dhcpv6_ptr -> nx_dhcpv6_init_retransmission_timeout = NX_DHCPV6_INIT_REBIND_TRANSMISSION_TIMEOUT;
dhcpv6_ptr -> nx_dhcpv6_max_retransmission_count = NX_DHCPV6_MAX_REBIND_RETRANSMISSION_COUNT;
dhcpv6_ptr -> nx_dhcpv6_max_retransmission_timeout = NX_DHCPV6_MAX_REBIND_RETRANSMISSION_TIMEOUT;
/* Find the max valid lifetime. */
for(ia_index = 0; ia_index < NX_DHCPV6_MAX_IA_ADDRESS; ia_index++)
{
/* Check the address status. */
if((dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_address_status == NX_DHCPV6_IA_ADDRESS_STATE_VALID) &&
(dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_valid_lifetime > max_valid_lifetime))
{
/* Find the max valid lifetime of all IAs. */
max_valid_lifetime = dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_valid_lifetime;
}
}
/* Set the max duration time.The message exchange is terminated when the valid lifetimes of all the addresses assigned to the IA expire,
RFC3315, Section18.1.4, Page43. */
dhcpv6_ptr -> nx_dhcpv6_max_retransmission_duration = max_valid_lifetime;
/* Activate the session timer to update the elapsed time. */
tx_timer_activate(&dhcpv6_ptr -> nx_dhcpv6_session_timer);
/* Call the internal function and return completion status. */
status = _nx_dhcpv6_request(dhcpv6_ptr, NX_DHCPV6_STATE_SENDING_REBIND);
/* Return the actual completion status. */
return status;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nxe_dhcpv6_request_release PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function performs error checking on the NetX DHCPv6 Release */
/* request service. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPV6 Client instance*/
/* */
/* OUTPUT */
/* */
/* status Completion status */
/* NX_PTR_ERROR Invalid pointer input */
/* */
/* */
/* CALLS */
/* */
/* _nx_dhcpv6_request_release Actual DHCPV6 process Release */
/* request service */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nxe_dhcpv6_request_release(NX_DHCPV6 *dhcpv6_ptr)
{
UINT status;
/* Check for invalid pointer input. */
if (!dhcpv6_ptr)
{
return NX_PTR_ERROR;
}
/* Check for appropriate caller. */
NX_THREADS_ONLY_CALLER_CHECKING
/* Call the actual service. */
status = _nx_dhcpv6_request_release(dhcpv6_ptr);
/* Return completion status. */
return status;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_request_release PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function sends a release request to the server for the Client */
/* to release a assigned IP address back to the DHCPv6 server who */
/* previously assigned it. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPV6 Client instance*/
/* */
/* OUTPUT */
/* */
/* status Actual completion status */
/* NX_DHCPV6_IA_ADDRESS_NOT_VALID Client not assigned an address */
/* */
/* CALLS */
/* */
/* _nx_dhcpv6_request Actual DHCPV6 request service */
/* tx_timer_activate Activate the session timer */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_request_release(NX_DHCPV6 *dhcpv6_ptr)
{
UINT status;
UINT ia_index;
/* Check if the Client is bound to an assigned address. */
if((dhcpv6_ptr -> nx_dhcpv6_state != NX_DHCPV6_STATE_BOUND_TO_ADDRESS) &&
(dhcpv6_ptr -> nx_dhcpv6_state != NX_DHCPV6_STATE_SENDING_RENEW) &&
(dhcpv6_ptr -> nx_dhcpv6_state != NX_DHCPV6_STATE_SENDING_REBIND))
{
/* It is not. The host application should use the nx_dhcpv6_stop if the DHCP Client
has simply failed to obtain an IP address from the server instead. */
/* Benign error so return successful outcome. */
return NX_DHCPV6_IA_ADDRESS_NOT_VALID;
}
/* Set the initial and max retransmission timeouts and max number of retries. */
dhcpv6_ptr -> nx_dhcpv6_transmission_timeout = NX_DHCPV6_INIT_RELEASE_TRANSMISSION_TIMEOUT;
dhcpv6_ptr -> nx_dhcpv6_retransmission_count = 0;
/* Set the initaial elasped time of DHCPv6 message. */
dhcpv6_ptr -> nx_dhcpv6_elapsed_time.nx_session_time = 0;
/* Set the retransmission information(IRT, MRC, MRT, MRD). */
dhcpv6_ptr -> nx_dhcpv6_init_retransmission_timeout = NX_DHCPV6_INIT_RELEASE_TRANSMISSION_TIMEOUT;
dhcpv6_ptr -> nx_dhcpv6_max_retransmission_count = NX_DHCPV6_MAX_RELEASE_RETRANSMISSION_COUNT;
dhcpv6_ptr -> nx_dhcpv6_max_retransmission_timeout = NX_DHCPV6_MAX_RELEASE_RETRANSMISSION_TIMEOUT;
dhcpv6_ptr -> nx_dhcpv6_max_retransmission_duration = NX_DHCPV6_MAX_RELEASE_RETRANSMISSION_DURATION;
/* Activate the session timer to update the elapsed time. */
tx_timer_activate(&dhcpv6_ptr -> nx_dhcpv6_session_timer);
/* Set the DHCPv6 Client IPv6 addresses. */
for(ia_index = 0; ia_index < NX_DHCPV6_MAX_IA_ADDRESS; ia_index++)
{
/* Now remove the address from the IP address table,the client MUST NOT use any of the addresses it is declining
as the source address in the Release message or in any subsequently transmitted message, RFC3315,section18.1.7.. */
/* Verify we have a valid address index. */
if(dhcpv6_ptr -> nx_dhcpv6_client_address_index[ia_index] >= NX_MAX_IPV6_ADDRESSES)
{
return NX_INVALID_INTERFACE;
}
if(dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_op_code)
{
/* Remove the address from the IP instance address table. */
nxd_ipv6_address_delete(dhcpv6_ptr -> nx_dhcpv6_ip_ptr, dhcpv6_ptr -> nx_dhcpv6_client_address_index[ia_index]);
/* Record the address index in the Client record. */
dhcpv6_ptr -> nx_dhcpv6_client_address_index[ia_index] = 0xFFFFFFFF;
}
}
/* Call the internal function and return completion status. */
status = _nx_dhcpv6_request(dhcpv6_ptr, NX_DHCPV6_STATE_SENDING_RELEASE);
/* Return completion status. */
return status;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_request_renew PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function calls the internal request service to renew the */
/* DHCPv6 IP address assigned to it by the server. */
/* */
/* Note: the Client thread task will detect when it is time to renew */
/* the Client IP address and call the deprecated address handler if one*/
/* is set. The deprecated address handler is where the host should */
/* call this service from. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPV6 Client instance*/
/* */
/* OUTPUT */
/* */
/* NX_SUCCESS Renew already initiated */
/* status Completion status */
/* */
/* CALLS */
/* */
/* _nx_dhcpv6_request Actual DHCPV6 request service */
/* tx_timer_activate Activate the session timer */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* _nx_dhcpv6_thread_entry DHCPv6 Client thread task */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_request_renew(NX_DHCPV6 *dhcpv6_ptr)
{
UINT status;
/* Is the Client state set to RENEW yet? */
if (dhcpv6_ptr -> nx_dhcpv6_state == NX_DHCPV6_STATE_SENDING_RENEW)
{
/* Yes, the renew process is already started. No need to re-request it.
Also must not zero out retry count or reset timeout back to starting value. */
return NX_SUCCESS;
}
/* Set initial retry and timeout values for sending the Renew request. */
dhcpv6_ptr -> nx_dhcpv6_retransmission_count = 0;
dhcpv6_ptr -> nx_dhcpv6_transmission_timeout = NX_DHCPV6_INIT_RENEW_TRANSMISSION_TIMEOUT;
/* Set the initaial elasped time of DHCPv6 message. */
dhcpv6_ptr -> nx_dhcpv6_elapsed_time.nx_session_time = 0;
/* Set the retransmission information(IRT, MRC, MRT, MRD). */
dhcpv6_ptr -> nx_dhcpv6_init_retransmission_timeout = NX_DHCPV6_INIT_RENEW_TRANSMISSION_TIMEOUT;
dhcpv6_ptr -> nx_dhcpv6_max_retransmission_count = NX_DHCPV6_MAX_RENEW_RETRANSMISSION_COUNT;
dhcpv6_ptr -> nx_dhcpv6_max_retransmission_timeout = NX_DHCPV6_MAX_RENEW_RETRANSMISSION_TIMEOUT;
dhcpv6_ptr -> nx_dhcpv6_max_retransmission_duration = dhcpv6_ptr -> nx_dhcpv6_iana.nx_T2;
/* Activate the session timer to update the elapsed time. */
tx_timer_activate(&dhcpv6_ptr -> nx_dhcpv6_session_timer);
/* Set the Client to the Renewing state for the DHCP Client thread to process. */
status = _nx_dhcpv6_request(dhcpv6_ptr, NX_DHCPV6_STATE_SENDING_RENEW);
/* Actual completion status. */
return status;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nxe_dhcpv6_request_solicit PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function performs error checking on the NetX DHCPv6 solicit */
/* request service. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPV6 Client instance*/
/* */
/* OUTPUT */
/* */
/* status Completion status */
/* NX_PTR_ERROR Invalid pointer input */
/* */
/* */
/* CALLS */
/* */
/* _nx_dhcpv6_request_solicit Actual DHCPV6 process Solicit */
/* request service */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nxe_dhcpv6_request_solicit(NX_DHCPV6 *dhcpv6_ptr)
{
UINT status;
/* Check for invalid pointer input. */
if (!dhcpv6_ptr)
{
return NX_PTR_ERROR;
}
/* Check for appropriate caller. */
NX_THREADS_ONLY_CALLER_CHECKING
/* Call the actual service. */
status = _nx_dhcpv6_request_solicit(dhcpv6_ptr);
/* Return completion status. */
return status;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_request_solicit PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function sends a solicit request for the Client to obtain an IP*/
/* address from any DHCPv6 server on the network. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPV6 Client instance*/
/* */
/* OUTPUT */
/* */
/* status Completion status */
/* */
/* CALLS */
/* */
/* _nx_dhcpv6_request Actual DHCPV6 request service */
/* tx_timer_activate Activate the session timer */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* _nx_dhcpv6_process Send the DHCPv6 solicit message */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_request_solicit(NX_DHCPV6 *dhcpv6_ptr)
{
UINT status;
/* Set the mode of sending the solicit message. Do not override a rapid option if set. */
if (dhcpv6_ptr ->nx_dhcpv6_request_solicit_mode != NX_DHCPV6_SOLICIT_RAPID)
{
/* Set the mode of sending the solicit message. */
dhcpv6_ptr -> nx_dhcpv6_request_solicit_mode = NX_DHCPV6_SOLICIT_NORMAL;
}
/* Set the initial and maximum timeout and retries. */
dhcpv6_ptr -> nx_dhcpv6_transmission_timeout = NX_DHCPV6_INIT_SOL_TRANSMISSION_TIMEOUT;
dhcpv6_ptr -> nx_dhcpv6_retransmission_count = 0;
/* Set the initaial elasped time of DHCPv6 message. */
dhcpv6_ptr -> nx_dhcpv6_elapsed_time.nx_session_time = 0;
/* Set the retransmission information(IRT, MRC, MRT, MRD). */
dhcpv6_ptr -> nx_dhcpv6_init_retransmission_timeout = NX_DHCPV6_INIT_SOL_TRANSMISSION_TIMEOUT;
dhcpv6_ptr -> nx_dhcpv6_max_retransmission_count = NX_DHCPV6_MAX_SOL_RETRANSMISSION_COUNT;
dhcpv6_ptr -> nx_dhcpv6_max_retransmission_timeout = NX_DHCPV6_MAX_SOL_RETRANSMISSION_TIMEOUT;
dhcpv6_ptr -> nx_dhcpv6_max_retransmission_duration = NX_DHCPV6_MAX_SOL_RETRANSMISSION_DURATION;
/* Reset the preference value if the Client previously accepted an Advertise message. */
dhcpv6_ptr -> nx_dhcpv6_preference.nx_pref_value = 0;
/* Activate the session timer to update the elapsed time. */
tx_timer_activate(&dhcpv6_ptr -> nx_dhcpv6_session_timer);
/* Set the Client to the Solicity state for the DHCP Client thread to process. */
status = _nx_dhcpv6_request(dhcpv6_ptr, NX_DHCPV6_STATE_SENDING_SOLICIT);
/* Return the completion status. */
return status;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nxe_dhcpv6_request_solicit_rapid PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function performs error checking on the NetX DHCPv6 solicit */
/* request service with rapid commit option. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPV6 Client instance*/
/* */
/* OUTPUT */
/* */
/* status Completion status */
/* NX_PTR_ERROR Invalid pointer input */
/* */
/* */
/* CALLS */
/* */
/* _nx_dhcpv6_request_solicit_rapid Actual DHCPV6 process Solicit */
/* request service */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nxe_dhcpv6_request_solicit_rapid(NX_DHCPV6 *dhcpv6_ptr)
{
UINT status;
/* Check for invalid pointer input. */
if (!dhcpv6_ptr)
{
return NX_PTR_ERROR;
}
/* Check for appropriate caller. */
NX_THREADS_ONLY_CALLER_CHECKING
/* Call the actual service. */
status = _nx_dhcpv6_request_solicit_rapid(dhcpv6_ptr);
/* Return completion status. */
return status;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_request_solicit_rapid PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function sends a solicit request with rapid commit option for */
/* the Client to rapidly obtain an IP address from any DHCPv6 server. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPV6 Client instance*/
/* */
/* OUTPUT */
/* */
/* status Completion status */
/* */
/* CALLS */
/* */
/* _nx_dhcpv6_request Actual DHCPV6 request service */
/* tx_timer_activate Activate the session timer */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_request_solicit_rapid(NX_DHCPV6 *dhcpv6_ptr)
{
UINT status;
/* Set the mode of sending the solicit message. */
dhcpv6_ptr ->nx_dhcpv6_request_solicit_mode = NX_DHCPV6_SOLICIT_RAPID;
/* Set the initial and maximum timeout and retries. */
dhcpv6_ptr -> nx_dhcpv6_transmission_timeout = NX_DHCPV6_INIT_SOL_TRANSMISSION_TIMEOUT;
dhcpv6_ptr -> nx_dhcpv6_retransmission_count = 0;
/* Set the initaial elasped time of DHCPv6 message. */
dhcpv6_ptr -> nx_dhcpv6_elapsed_time.nx_session_time = 0;
/* Set the retransmission information(IRT, MRC, MRT, MRD). */
dhcpv6_ptr -> nx_dhcpv6_init_retransmission_timeout = NX_DHCPV6_INIT_SOL_TRANSMISSION_TIMEOUT;
dhcpv6_ptr -> nx_dhcpv6_max_retransmission_count = NX_DHCPV6_MAX_SOL_RETRANSMISSION_COUNT;
dhcpv6_ptr -> nx_dhcpv6_max_retransmission_timeout = NX_DHCPV6_MAX_SOL_RETRANSMISSION_TIMEOUT;
dhcpv6_ptr -> nx_dhcpv6_max_retransmission_duration = NX_DHCPV6_MAX_SOL_RETRANSMISSION_DURATION;
/* Reset the preference value if the Client previously accepted an Advertise message. */
dhcpv6_ptr -> nx_dhcpv6_preference.nx_pref_value = 0;
/* Activate the session timer to update the elapsed time. */
tx_timer_activate(&dhcpv6_ptr -> nx_dhcpv6_session_timer);
/* Set the Client to the Solicity state for the DHCP Client thread to process. */
status = _nx_dhcpv6_request(dhcpv6_ptr, NX_DHCPV6_STATE_SENDING_SOLICIT);
/* Return the completion status. */
return status;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nxe_dhcpv6_resume PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function performs error checking on the resume NetX DHCPv6 */
/* client task service. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPV6 Client instance*/
/* */
/* OUTPUT */
/* */
/* OUTPUT */
/* */
/* status Completion status */
/* NX_PTR_ERROR Invalid pointer input */
/* */
/* CALLS */
/* */
/* _nx_dhcpv6_resume Actual DHCPV6 resume function */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nxe_dhcpv6_resume(NX_DHCPV6 *dhcpv6_ptr)
{
UINT status;
/* Check for invalid input pointer. */
if ((dhcpv6_ptr == NX_NULL) || (dhcpv6_ptr -> nx_dhcpv6_id != NX_DHCPV6_ID))
{
return(NX_PTR_ERROR);
}
/* Check for appropriate caller. */
NX_THREADS_ONLY_CALLER_CHECKING
/* Call actual DHCPV6 stop service. */
status = _nx_dhcpv6_resume(dhcpv6_ptr);
/* Return status. */
return(status);
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_resume PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function resumes DHCPV6 processing thread and updates the */
/* DHCPv6 client state according to nx_dhcpv6_IP_lifetime_time_accrued.*/
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPV6 Client instance*/
/* */
/* OUTPUT */
/* */
/* status Actual completion status */
/* */
/* CALLS */
/* */
/* nx_dhcpv6_start Starts DHCPV6 thread task */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_resume(NX_DHCPV6 *dhcpv6_ptr)
{
UINT status;
UCHAR original_state;
/* Get the DHCP mutex. */
tx_mutex_get(&(dhcpv6_ptr -> nx_dhcpv6_client_mutex), NX_DHCPV6_MUTEX_WAIT);
/* Determine if DHCPV6 has already been started. */
if (dhcpv6_ptr -> nx_dhcpv6_started)
{
/* Release the DHCPv6 Client mutex. */
tx_mutex_put(&(dhcpv6_ptr -> nx_dhcpv6_client_mutex));
/* Error, the DHCPV6 client has already been started. */
return(NX_DHCPV6_ALREADY_STARTED);
}
/* Determine if Client has created its DUID and IANA yet. */
if ((dhcpv6_ptr -> nx_dhcpv6_ip_ptr == NX_NULL) ||
(dhcpv6_ptr -> nx_dhcpv6_client_duid.nx_option_length == 0) ||
(dhcpv6_ptr -> nx_dhcpv6_iana.nx_option_length == 0))
{
/* Release the DHCPv6 Client mutex. */
tx_mutex_put(&(dhcpv6_ptr -> nx_dhcpv6_client_mutex));
/* No, this DHCPv6 Client is not ready to run! */
return NX_DHCPV6_MISSING_REQUIRED_OPTIONS;
}
/* Remember the original DHCPv6 state for the changed state callback function. */
original_state = dhcpv6_ptr -> nx_dhcpv6_state;
/* Bind the UDP socket to the DHCPV6 Client port. */
status = nx_udp_socket_bind(&(dhcpv6_ptr -> nx_dhcpv6_socket), NX_DHCPV6_CLIENT_UDP_PORT, TX_WAIT_FOREVER);
/* Check for success */
if (status)
{
/* Release the DHCPv6 Client mutex. */
tx_mutex_put(&(dhcpv6_ptr -> nx_dhcpv6_client_mutex));
/* Return completion status. */
return(status);
}
/* Check the DHCPv6 Client state. */
if ((dhcpv6_ptr -> nx_dhcpv6_state != NX_DHCPV6_STATE_BOUND_TO_ADDRESS) &&
(dhcpv6_ptr -> nx_dhcpv6_state != NX_DHCPV6_STATE_SENDING_RENEW) &&
(dhcpv6_ptr -> nx_dhcpv6_state != NX_DHCPV6_STATE_SENDING_REBIND))
{
/* Set the DHCPv6 Client state to Init.*/
dhcpv6_ptr -> nx_dhcpv6_state = NX_DHCPV6_STATE_INIT;
/* Clear the session time, lease lifetime, retransmission counters. */
dhcpv6_ptr -> nx_dhcpv6_elapsed_time.nx_session_time = 0;
dhcpv6_ptr -> nx_dhcpv6_IP_lifetime_time_accrued = 0;
dhcpv6_ptr -> nx_dhcpv6_transmission_timeout = 0;
dhcpv6_ptr -> nx_dhcpv6_retransmission_count = 0;
}
else
{
/* Check the accrued time to upate the state. */
if ((dhcpv6_ptr -> nx_dhcpv6_state == NX_DHCPV6_STATE_BOUND_TO_ADDRESS) && ((dhcpv6_ptr -> nx_dhcpv6_IP_lifetime_time_accrued >= dhcpv6_ptr -> nx_dhcpv6_iana.nx_T2)))
{
/* Update the status as NX_DHCPV6_STATE_SENDING_RENEW to send rebinding message in _nx_dhcpv6_thread_entry function. */
dhcpv6_ptr -> nx_dhcpv6_state = NX_DHCPV6_STATE_SENDING_RENEW;
}
}
/* Set the DHCPv6 started flag to indicate DHCPv6 Client is now running. */
dhcpv6_ptr -> nx_dhcpv6_started = NX_TRUE;
/* Activate the DHCPv6 timers. */
tx_timer_activate(&dhcpv6_ptr -> nx_dhcpv6_IP_lifetime_timer);
/* Resume the DHCPv6 processing thread. */
tx_thread_resume(&(dhcpv6_ptr -> nx_dhcpv6_thread));
/* Is there a state change callback registered with the Client? */
if ((dhcpv6_ptr -> nx_dhcpv6_state_change_callback) && (original_state != (dhcpv6_ptr -> nx_dhcpv6_state)))
{
/* Yes, call the the state change callback with the original and new state. */
(dhcpv6_ptr -> nx_dhcpv6_state_change_callback)(dhcpv6_ptr, original_state, dhcpv6_ptr -> nx_dhcpv6_state);
}
/* Release the DHCPv6 Client mutex. */
tx_mutex_put(&(dhcpv6_ptr -> nx_dhcpv6_client_mutex));
/* Return completion status. */
return(status);
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_send_request PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function sends a DHCPV6 request to the server. All options */
/* required for each Client DHCPv6 message are compiled into the Client */
/* request package. Since each message must have a unique transaction */
/* ID, it is up to the caller to set the Client transaction ID in the */
/* Client record before calling this service. The server reply must */
/* contain the matching message transaction ID for each message type the*/
/* Client sends it. This function will check for invalid message types. */
/* */
/* To send a message, the Client allocates a packet from its own packet */
/* pool. It then must set the IPv6 packet interface depending if the */
/* Client has a valid global IP address or is using its link local */
/* address till it can get a global IP address. It can send the packet */
/* either to all servers on its network or include server and relays */
/* (user configurable). */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPV6 Client */
/* */
/* OUTPUT */
/* */
/* status Actual completion status */
/* NX_DHCPV6_ILLEGAL_MESSAGE_TYPE Illegal message type to send */
/* */
/* CALLS */
/* */
/* nx_packet_allocate Allocate a DHCPV6 packet */
/* nx_packet_release Release DHCPV6 packet */
/* nx_udp_socket_send Send DHCPV6 packet */
/* _nx_dhcpv6_add_client_duid Add Client DUID to request */
/* _nx_dhcpv6_add_server_duid Add server DUID to request */
/* _nx_dhcpv6_add_elapsed_time Add elapsed time option */
/* _nx_dhcpv6_add_iana Add IANA option to request */
/* _nx_dhcpv6_add_ia_address Add IA address option */
/* _nx_dhcpv6_add_option_request Add option request option */
/* memcpy Copy specified area of memory */
/* */
/* CALLED BY */
/* */
/* _nx_dhcpv6_process Process DHCPv6 client request */
/* _nx_dhcpv6_waiting_on_reply Process replies to valid server*/
/* reply received */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), improved */
/* packet length verification, */
/* verified memcpy use cases, */
/* fixed compiler warnings, */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_send_request(NX_DHCPV6 *dhcpv6_ptr)
{
NX_PACKET *packet_ptr;
UCHAR *buffer;
UINT status;
ULONG message_word;
UINT index;
NX_INTERFACE *interface_ptr;
NXD_IPV6_ADDRESS *ipv6_address;
ULONG available_payload;
/* Initialize local variables. */
index = 0;
/* Check for invalid or illegal message type. */
if ((dhcpv6_ptr -> nx_dhcpv6_message_hdr.nx_message_type == NX_DHCPV6_MESSAGE_TYPE_ADVERTISE) ||
(dhcpv6_ptr -> nx_dhcpv6_message_hdr.nx_message_type == NX_DHCPV6_MESSAGE_TYPE_REPLY) ||
(dhcpv6_ptr -> nx_dhcpv6_message_hdr.nx_message_type == NX_DHCPV6_MESSAGE_TYPE_RECONFIGURE) ||
(dhcpv6_ptr -> nx_dhcpv6_message_hdr.nx_message_type > NX_DHCPV6_MESSAGE_TYPE_INFORM_REQUEST) ||
(dhcpv6_ptr -> nx_dhcpv6_message_hdr.nx_message_type == 0))
{
/* Return error status. */
return NX_DHCPV6_ILLEGAL_MESSAGE_TYPE;
}
/* Allocate a DHCPV6 packet. */
status = nx_packet_allocate(dhcpv6_ptr -> nx_dhcpv6_pool_ptr, &packet_ptr, NX_IPv6_UDP_PACKET, NX_DHCPV6_PACKET_TIME_OUT);
/* Was the packet allocation successful? */
if (status != NX_SUCCESS)
{
/* Return status. */
return(status);
}
/* Verify packet payload. */
if ((packet_ptr -> nx_packet_data_end - packet_ptr -> nx_packet_prepend_ptr) < 4)
{
nx_packet_release(packet_ptr);
return(NX_DHCPV6_INSUFFICIENT_PACKET_PAYLOAD);
}
/* Indicate this is an IPv6 packet. */
packet_ptr -> nx_packet_ip_version = NX_IP_VERSION_V6;
/* Setup the buffer pointer. */
buffer = packet_ptr -> nx_packet_prepend_ptr;
/* Use the message id value to judge whether the next packet is retransmit packet or not.
If the id value is 0, indicate the new dhcpv6 request, then generate a random number, else,leave the transaction ID unchanged.
A client MUST leave the transaction ID unchanged in retransmissions of a message,RFC3315,section 15.1,page 28. */
if(dhcpv6_ptr -> nx_dhcpv6_message_hdr.nx_message_xid == 0)
{
/* Generate "random" transaction ID using physical address and a random factor for each request
to the Server. The Server must include a matching transaction ID in its reply. */
dhcpv6_ptr -> nx_dhcpv6_message_hdr.nx_message_xid =
((dhcpv6_ptr -> nx_dhcpv6_ip_ptr -> nx_ip_arp_physical_address_msw) ^
(dhcpv6_ptr -> nx_dhcpv6_ip_ptr -> nx_ip_arp_physical_address_lsw) ^
(ULONG)(NX_RAND()));
/* Now reduce it to three bytes. */
dhcpv6_ptr -> nx_dhcpv6_message_hdr.nx_message_xid = (dhcpv6_ptr -> nx_dhcpv6_message_hdr.nx_message_xid & (ULONG)(0x0ffffff));
}
/* Clear memory to make the message header. */
memset(&message_word, 0, sizeof(ULONG));
/* Add the message type and transaction ID as the DHCPv6 header fields. */
message_word = (((ULONG)(dhcpv6_ptr -> nx_dhcpv6_message_hdr.nx_message_type)) << 24);
message_word |= (((ULONG)(0x0ffffff)) & (dhcpv6_ptr -> nx_dhcpv6_message_hdr.nx_message_xid));
/* Adjust for endianness. */
NX_CHANGE_ULONG_ENDIAN(message_word);
/* Copy the message header to the packet buffer. */
memcpy(buffer, &message_word, 4); /* Use case of memcpy is verified. */
/* Update the buffer 'pointer'. */
index += (ULONG)sizeof(ULONG);
/* Add the Client DUID to the packet buffer. */
status = _nx_dhcpv6_add_client_duid(dhcpv6_ptr, buffer, &index);
/* Check for error. */
if(status != NX_SUCCESS)
{
nx_packet_release(packet_ptr);
return status;
}
/* Determine if any additional options need to be added relative to the DHCPV6 message type. */
switch (dhcpv6_ptr -> nx_dhcpv6_message_hdr.nx_message_type)
{
case NX_DHCPV6_MESSAGE_TYPE_SOLICIT:
{
/* Append the IA-NA option and depending on host state. */
status = _nx_dhcpv6_add_iana(dhcpv6_ptr, buffer, &index);
/* Check for internal errors. */
if (status != NX_SUCCESS)
{
nx_packet_release(packet_ptr);
/* Return the error status and abort. */
return status;
}
/* Compute the session time so far and add an elapsed time option. */
status = _nx_dhcpv6_add_elapsed_time(dhcpv6_ptr, buffer, &index);
/* Check for internal errors. */
if (status != NX_SUCCESS)
{
nx_packet_release(packet_ptr);
/* Return the error status and abort. */
return status;
}
/* Did the Client ask for a DHCPv6 Client FQDN option ?
A client MUST only include the Client FQDN option in SOLICIT, REQUEST, RENEW, or REBIND messsage. */
if (dhcpv6_ptr ->nx_dhcpv6_client_FQDN.nx_op_code)
{
/* Add the option request. */
status = _nx_dhcpv6_add_client_FQDN(dhcpv6_ptr, buffer, &index);
/* Check for internal error. */
if (status != NX_SUCCESS)
{
nx_packet_release(packet_ptr);
/* Return the error status and abort. */
return status;
}
}
/* Did the Client ask for a requested option? */
if (dhcpv6_ptr -> nx_dhcpv6_option_request.nx_op_request)
{
/* Add the option request. */
status = _nx_dhcpv6_add_option_request(dhcpv6_ptr, buffer, &index);
/* Check for internal error. */
if (status != NX_SUCCESS)
{
nx_packet_release(packet_ptr);
/* Return the error status and abort. */
return status;
}
}
/* Did the Client ask for rapid commit option? */
if (dhcpv6_ptr -> nx_dhcpv6_request_solicit_mode == NX_DHCPV6_SOLICIT_RAPID)
{
/* Compute the available payload for DHCP data in the packet buffer. */
available_payload = (ULONG)(dhcpv6_ptr -> nx_dhcpv6_pool_ptr -> nx_packet_pool_payload_size -
sizeof(NX_IPV6_HEADER) - sizeof(NX_UDP_HEADER) - index);
/* Check if the data will fit in the packet buffer. */
if (available_payload < sizeof(ULONG))
{
/* Hmmm... not enough! Can't do it. */
return NX_DHCPV6_INSUFFICIENT_PACKET_PAYLOAD;
}
/* Add the rapid commit option request. */
/* Clear memory to make the message header, and add the message type. */
memset(&message_word, 0, sizeof(ULONG));
/* Add the message type. */
message_word = (((ULONG)NX_DHCPV6_OP_RAPID_COMMIT) << 16);
/* Adjust for endianness. */
NX_CHANGE_ULONG_ENDIAN(message_word);
/* Copy the message to the packet buffer. */
memcpy((buffer + index), &message_word, sizeof(ULONG)); /* Use case of memcpy is verified. */
/* Update the index. */
index += (ULONG)sizeof(ULONG);
}
/* Increment the number of Solicit messages sent. */
dhcpv6_ptr -> nx_dhcpv6_solicitations_sent++;
break;
}
case NX_DHCPV6_MESSAGE_TYPE_REQUEST:
{
/* Compute the session time so far and add an elapsed time option. */
status = _nx_dhcpv6_add_elapsed_time(dhcpv6_ptr, buffer, &index);
/* Check for internal error. */
if (status != NX_SUCCESS)
{
nx_packet_release(packet_ptr);
/* Return error status. */
return status;
}
/* Add the server DUID just extracted from the Server Advertise message. */
status = _nx_dhcpv6_add_server_duid(dhcpv6_ptr, buffer, &index);
/* Check for internal error. */
if (status != NX_SUCCESS)
{
nx_packet_release(packet_ptr);
/* Return error status. */
return status;
}
/* Append an IA-NA with the IA address option received from server added to the IA-NA option. */
status = _nx_dhcpv6_add_iana(dhcpv6_ptr, buffer, &index);
/* Check for internal error. */
if (status != NX_SUCCESS)
{
nx_packet_release(packet_ptr);
/* Return error status. */
return status;
}
/* Did the Client ask for a DHCPv6 Client FQDN option ?
A client MUST only include the Client FQDN option in SOLICIT, REQUEST, RENEW, or REBIND messsage. */
if (dhcpv6_ptr ->nx_dhcpv6_client_FQDN.nx_op_code)
{
/* Add the option request. */
status = _nx_dhcpv6_add_client_FQDN(dhcpv6_ptr, buffer, &index);
/* Check for internal error. */
if (status != NX_SUCCESS)
{
nx_packet_release(packet_ptr);
/* Return the error status and abort. */
return status;
}
}
/* Did the Client ask for a requested option? */
if (dhcpv6_ptr -> nx_dhcpv6_option_request.nx_op_request)
{
/* Add the server DUID just extracted from the Server Advertise message. */
status = _nx_dhcpv6_add_option_request(dhcpv6_ptr, buffer, &index);
/* Check for internal error. */
if (status != NX_SUCCESS)
{
nx_packet_release(packet_ptr);
/* Return error status. */
return status;
}
}
/* Increment the number of Request messages sent. */
dhcpv6_ptr -> nx_dhcpv6_requests_sent++;
break;
}
case NX_DHCPV6_MESSAGE_TYPE_RENEW:
{
/* Compute the session time so far and add an elapsed time option. */
status = _nx_dhcpv6_add_elapsed_time(dhcpv6_ptr, buffer, &index);
/* Check for internal error. */
if (status != NX_SUCCESS)
{
nx_packet_release(packet_ptr);
/* Return error status. */
return status;
}
/* Add the server DUID just extracted from the Server Advertise message. */
status = _nx_dhcpv6_add_server_duid(dhcpv6_ptr, buffer, &index);
/* Check for internal error. */
if (status != NX_SUCCESS)
{
nx_packet_release(packet_ptr);
/* Return error status. */
return status;
}
status = _nx_dhcpv6_add_iana(dhcpv6_ptr, buffer, &index);
/* Check for internal errors. */
if (status != NX_SUCCESS)
{
nx_packet_release(packet_ptr);
/* Return the error status and abort. */
return status;
}
/* Did the Client ask for a DHCPv6 Client FQDN option ?
A client MUST only include the Client FQDN option in SOLICIT, REQUEST, RENEW, or REBIND messsage. */
if (dhcpv6_ptr ->nx_dhcpv6_client_FQDN.nx_op_code)
{
/* Add the option request. */
status = _nx_dhcpv6_add_client_FQDN(dhcpv6_ptr, buffer, &index);
/* Check for internal error. */
if (status != NX_SUCCESS)
{
nx_packet_release(packet_ptr);
/* Return the error status and abort. */
return status;
}
}
/* A client MAY include an Option Request option in a Solicit, Request, Renew, Rebind, Confirm or Information-request
message to inform the server about options the client wants the server to send to the client. RFC3315, Section22.7, Page78.*/
if (dhcpv6_ptr -> nx_dhcpv6_option_request.nx_op_request)
{
/* Add the server DUID just extracted from the Server Advertise message. */
status = _nx_dhcpv6_add_option_request(dhcpv6_ptr, buffer, &index);
/* Check for internal error. */
if (status != NX_SUCCESS)
{
nx_packet_release(packet_ptr);
/* Return error status. */
return status;
}
}
dhcpv6_ptr -> nx_dhcpv6_renews_sent++;
break;
}
case NX_DHCPV6_MESSAGE_TYPE_REBIND:
{
/* Compute the session time so far and add an elapsed time option. */
status = _nx_dhcpv6_add_elapsed_time(dhcpv6_ptr, buffer, &index);
/* Check for internal errors. */
if (status != NX_SUCCESS)
{
nx_packet_release(packet_ptr);
/* Return the error status and abort. */
return status;
}
/* Rebind message includes the current IA/IA-NA, current IA address. */
status = _nx_dhcpv6_add_iana(dhcpv6_ptr, buffer, &index);
/* Check for internal errors. */
if (status != NX_SUCCESS)
{
nx_packet_release(packet_ptr);
/* Return the error status and abort. */
return status;
}
/* Did the Client ask for a DHCPv6 Client FQDN option ?
A client MUST only include the Client FQDN option in SOLICIT, REQUEST, RENEW, or REBIND messsage. */
if (dhcpv6_ptr ->nx_dhcpv6_client_FQDN.nx_op_code)
{
/* Add the option request. */
status = _nx_dhcpv6_add_client_FQDN(dhcpv6_ptr, buffer, &index);
/* Check for internal error. */
if (status != NX_SUCCESS)
{
nx_packet_release(packet_ptr);
/* Return the error status and abort. */
return status;
}
}
/* Did the Client ask for a requested option? */
if (dhcpv6_ptr -> nx_dhcpv6_option_request.nx_op_request)
{
/* Add the server DUID just extracted from the Server Advertise message. */
status = _nx_dhcpv6_add_option_request(dhcpv6_ptr, buffer, &index);
/* Check for internal errors. */
if (status != NX_SUCCESS)
{
nx_packet_release(packet_ptr);
/* Return the error status and abort. */
return status;
}
}
/* Increment the number of Solicit messages sent. */
dhcpv6_ptr -> nx_dhcpv6_rebinds_sent++;
break;
}
case NX_DHCPV6_MESSAGE_TYPE_CONFIRM:
{
/* Compute the session time so far and add an elapsed time option. */
status = _nx_dhcpv6_add_elapsed_time(dhcpv6_ptr, buffer, &index);
/* Check for internal errors. */
if (status != NX_SUCCESS)
{
nx_packet_release(packet_ptr);
/* Return the error status and abort. */
return status;
}
/* Rebind message includes the current IA/IA-NA, current IA address. */
status = _nx_dhcpv6_add_iana(dhcpv6_ptr, buffer, &index);
/* Check for internal errors. */
if (status != NX_SUCCESS)
{
/* Return the error status and abort. */
return status;
}
/* A client MAY include an Option Request option in a Solicit, Request, Renew, Rebind, Confirm or Information-request
message to inform the server about options the client wants the server to send to the client. RFC3315, Section22.7, Page78.*/
if (dhcpv6_ptr -> nx_dhcpv6_option_request.nx_op_request)
{
/* Add the server DUID just extracted from the Server Advertise message. */
status = _nx_dhcpv6_add_option_request(dhcpv6_ptr, buffer, &index);
/* Check for internal error. */
if (status != NX_SUCCESS)
{
nx_packet_release(packet_ptr);
/* Return error status. */
return status;
}
}
/* Increment the number of Solicit messages sent. */
dhcpv6_ptr -> nx_dhcpv6_confirms_sent++;
break;
}
case NX_DHCPV6_MESSAGE_TYPE_DECLINE:
{
/* Add the server DUID just extracted from the Server Advertise message. */
status = _nx_dhcpv6_add_server_duid(dhcpv6_ptr, buffer, &index);
/* Check for internal error. */
if (status != NX_SUCCESS)
{
nx_packet_release(packet_ptr);
/* Return error status. */
return status;
}
/* Compute the session time so far and add an elapsed time option. */
status = _nx_dhcpv6_add_elapsed_time(dhcpv6_ptr, buffer, &index);
/* Check for internal errors. */
if (status != NX_SUCCESS)
{
/* Return the error status and abort. */
return status;
}
/* Decling the message in the current IA/IA-NA, current IA address. */
status = _nx_dhcpv6_add_iana(dhcpv6_ptr, buffer, &index);
/* Check for internal errors. */
if (status != NX_SUCCESS)
{
nx_packet_release(packet_ptr);
/* Return the error status and abort. */
return status;
}
/* Increment the number of Decline messages sent. */
dhcpv6_ptr -> nx_dhcpv6_declines_sent++;
break;
}
case NX_DHCPV6_MESSAGE_TYPE_RELEASE:
{
/* Add the server DUID just extracted from the Server Advertise message. */
status = _nx_dhcpv6_add_server_duid(dhcpv6_ptr, buffer, &index);
/* Check for internal error. */
if (status != NX_SUCCESS)
{
nx_packet_release(packet_ptr);
/* Return error status. */
return status;
}
/* Compute the session time so far and add an elapsed time option. */
status = _nx_dhcpv6_add_elapsed_time(dhcpv6_ptr, buffer, &index);
/* Check for internal errors. */
if (status != NX_SUCCESS)
{
nx_packet_release(packet_ptr);
/* Return the error status and abort. */
return status;
}
/* Decling the message in the current IA/IA-NA, current IA address. */
status = _nx_dhcpv6_add_iana(dhcpv6_ptr, buffer, &index);
/* Check for internal errors. */
if (status != NX_SUCCESS)
{
nx_packet_release(packet_ptr);
/* Return the error status and abort. */
return status;
}
/* Increment the number of Releases messages sent. */
dhcpv6_ptr -> nx_dhcpv6_releases_sent++;
break;
}
case NX_DHCPV6_MESSAGE_TYPE_INFORM_REQUEST:
{
/* Did the Client ask for a requested option? */
if (!dhcpv6_ptr -> nx_dhcpv6_option_request.nx_op_request)
{
/* No, so don't bother sending out the request. */
nx_packet_release(packet_ptr);
return NX_SUCCESS;
}
/* Compute the session time so far and add an elapsed time option. */
status = _nx_dhcpv6_add_elapsed_time(dhcpv6_ptr, buffer, &index);
/* Check for internal error. */
if (status != NX_SUCCESS)
{
nx_packet_release(packet_ptr);
/* Return error status. */
return status;
}
/* Did the Client ask for a requested option? */
if (dhcpv6_ptr -> nx_dhcpv6_option_request.nx_op_request)
{
/* Add the server DUID just extracted from the Server Advertise message. */
status = _nx_dhcpv6_add_option_request(dhcpv6_ptr, buffer, &index);
/* Check for internal error. */
if (status != NX_SUCCESS)
{
nx_packet_release(packet_ptr);
/* Return error status. */
return status;
}
}
/* Increment the number of Inform Request messages sent. */
dhcpv6_ptr -> nx_dhcpv6_inform_req_sent++;
break;
}
default:
{
nx_packet_release(packet_ptr);
return NX_DHCPV6_UNKNOWN_MSG_TYPE;
}
}
/* Setup the packet pointers. */
packet_ptr -> nx_packet_length = index;
packet_ptr -> nx_packet_append_ptr = packet_ptr -> nx_packet_prepend_ptr + index;
/* Select Client Source address:
1. When a client sends a DHCP message to the All_DHCP_Relay_Agents_and_Servers address,
the client must use a link-local address assigned to the interface for which it
is requesting configuration as the source address.
2. When a client sends a DHCP message directly to a server using unicast,
the source address must be an address assigned to the interface for which the
client is interested in obtaining configuration.
RFC 3315, Section 16. Client Source Address and Interface Selection, Page 32. */
/* Set the interface pointer. */
interface_ptr = &(dhcpv6_ptr -> nx_dhcpv6_ip_ptr -> nx_ip_interface[dhcpv6_ptr ->nx_dhcpv6_client_interface_index]);
/* Check the destination address. */
if (CHECK_IPV6_ADDRESSES_SAME(dhcpv6_ptr -> nx_dhcpv6_client_destination_address.nxd_ip_address.v6, All_DHCPv6_Relay_Servers_Address.nxd_ip_address.v6))
{
/* Find the link-local address as source adress. Get first address from interface. */
ipv6_address = interface_ptr -> nxd_interface_ipv6_address_list_head;
/* Loop to check the address. */
while (ipv6_address)
{
/* Check for a valid address. */
if (ipv6_address -> nxd_ipv6_address_state != NX_IPV6_ADDR_STATE_VALID)
{
ipv6_address = ipv6_address -> nxd_ipv6_address_next;
}
/* Check for link-local address. */
else if (IPv6_Address_Type(ipv6_address -> nxd_ipv6_address) & IPV6_ADDRESS_LINKLOCAL)
{
/* Find the Link-Local Address. */
break;
}
else
{
ipv6_address = ipv6_address -> nxd_ipv6_address_next;
}
}
/* Check if found the link-local address. */
if(ipv6_address == NX_NULL)
{
/* No valid link-local address. */
nx_packet_release(packet_ptr);
return(NX_IP_ADDRESS_ERROR);
}
}
else
{
/* Find the source address. */
status = _nxd_ipv6_interface_find(dhcpv6_ptr -> nx_dhcpv6_ip_ptr, dhcpv6_ptr -> nx_dhcpv6_client_destination_address.nxd_ip_address.v6,
&ipv6_address, interface_ptr);
/* Check if found the address. */
if (status)
{
/* No valid source address. */
nx_packet_release(packet_ptr);
return(NX_IP_ADDRESS_ERROR);
}
}
/* Send the packet out! */
status = _nxd_udp_socket_source_send(&(dhcpv6_ptr -> nx_dhcpv6_socket), packet_ptr,
&dhcpv6_ptr -> nx_dhcpv6_client_destination_address, NX_DHCPV6_SERVER_UDP_PORT,
ipv6_address -> nxd_ipv6_address_index);
/* If an error is detected, the packet was not sent and we have to release the packet. */
if (status != NX_SUCCESS)
{
/* Release the packet. */
nx_packet_release(packet_ptr);
}
/* Return completion status. */
return(status);
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_session_timeout_entry PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function updates the Client session duration time with the */
/* Server. This information is used for the Elapsed Time data in DHCPv6*/
/* Client messages sends to the server as part of the DHCPv6 protocol. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr_value Pointer to the DHCPV6 Client */
/* */
/* OUTPUT */
/* */
/* None */
/* */
/* CALLS */
/* */
/* None */
/* */
/* CALLED BY */
/* */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
VOID _nx_dhcpv6_session_timeout_entry(ULONG dhcpv6_ptr_value)
{
NX_DHCPV6 *dhcpv6_ptr;
/* Setup DHCPv6 Client pointer. */
NX_TIMER_EXTENSION_PTR_GET(dhcpv6_ptr, NX_DHCPV6, dhcpv6_ptr_value)
/* Check the elapsed time, the time is expressed in hundredths of 1 second, 65500 is the largest time value. */
if(dhcpv6_ptr -> nx_dhcpv6_elapsed_time.nx_session_time < 65500)
{
/* Update the elapsed time of current DHCP session.
This time is expressed in hundredths of a second. */
dhcpv6_ptr -> nx_dhcpv6_elapsed_time.nx_session_time = (USHORT)(dhcpv6_ptr -> nx_dhcpv6_elapsed_time.nx_session_time + NX_DHCPV6_SESSION_TIMER_INTERVAL * 100);
}
else
{
/* Set the value 0xFFFF to represent any elapsed time values greater than the largest time value . */
dhcpv6_ptr -> nx_dhcpv6_elapsed_time.nx_session_time = 0xFFFF;
}
return;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nxe_dhcpv6_set_time_accrued PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function performs error checking on the set time accrued on */
/* Client IP lease service. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPv6 Client */
/* time_accrued Pointer to time since IP lease */
/* assigned (secs) */
/* */
/* OUTPUT */
/* */
/* status Actual completion status */
/* NX_PTR_ERROR Invalid pointer input */
/* */
/* CALLS */
/* */
/* _nx_dhcpv6_set_time_accrued Actual set time accrued on Client */
/* IP address lease service */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nxe_dhcpv6_set_time_accrued(NX_DHCPV6 *dhcpv6_ptr, ULONG time_accrued)
{
UINT status;
/* Check for valid pointer input. */
if (!dhcpv6_ptr)
{
return NX_PTR_ERROR;
}
/* Call the actual service. */
status = _nx_dhcpv6_set_time_accrued(dhcpv6_ptr, time_accrued);
/* Return completion status. */
return status;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_set_time_accrued PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function enables the host to set the time accrued on the */
/* Client's IP address lease. The caller must first suspend the */
/* DHCPv6 Client using the nx_dhcpv6_suspend service before using this */
/* service. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPv6 Client */
/* time_accrued Pointer to time to set the */
/* lient accrued time (secs) */
/* */
/* OUTPUT */
/* */
/* NX_SUCCESS Successful completion status */
/* */
/* CALLS */
/* */
/* None */
/* */
/* CALLED BY */
/* */
/* Application */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_set_time_accrued(NX_DHCPV6 *dhcpv6_ptr, ULONG time_accrued)
{
/* Check if the DHCPv6 Client has been started. */
if (dhcpv6_ptr -> nx_dhcpv6_started)
{
/* It has. We cannot set the time accrued if the DHCPv6 client thread is running. */
return NX_DHCPV6_ALREADY_STARTED;
}
/* Set the time accrued on the Client IP address lease. */
dhcpv6_ptr -> nx_dhcpv6_IP_lifetime_time_accrued = time_accrued;
/* Return successful completion. */
return NX_SUCCESS;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nxe_dhcpv6_client_set_interface PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function performs error checking on the set client interface */
/* service. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPv6 Client */
/* interface_index Index for DHCP network interface*/
/* */
/* OUTPUT */
/* */
/* status Actual completion status */
/* NX_PTR_ERROR Invalid pointer input */
/* NX_INVALID_INTERFACE Invalid interface index input */
/* */
/* CALLS */
/* */
/* _nx_dhcpv6_client_set_interface Actual set interface service */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nxe_dhcpv6_client_set_interface(NX_DHCPV6 *dhcpv6_ptr, UINT interface_index)
{
UINT status;
/* Check for valid pointer input. */
if (!dhcpv6_ptr)
{
return NX_PTR_ERROR;
}
/* Check for an invalid interface specified. */
if (interface_index >= NX_MAX_PHYSICAL_INTERFACES)
{
return NX_INVALID_INTERFACE;
}
/* Call the actual service. */
status = _nx_dhcpv6_client_set_interface(dhcpv6_ptr, interface_index);
/* Return completion status. */
return status;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_client_set_interface PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function specifies the physical interface for DHCP */
/* communications with the server in NetX Duo environments that support*/
/* mult-homed hosts. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPv6 Client */
/* interface_index Index for DHCP network interface*/
/* */
/* OUTPUT */
/* */
/* NX_SUCCESS Successful completion status */
/* NX_NOT_ENABLED NetXDuo version does not support*/
/* multiple network interfaces */
/* */
/* CALLS */
/* */
/* None */
/* */
/* CALLED BY */
/* */
/* Application */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_client_set_interface(NX_DHCPV6 *dhcpv6_ptr, UINT interface_index)
{
/* Set the client interface. */
dhcpv6_ptr -> nx_dhcpv6_client_interface_index = interface_index;
/* Return successful completion. */
return NX_SUCCESS;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nxe_dhcpv6_client_set_destination_address PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function performs error checking on the set destination */
/* address service. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPv6 Client */
/* destination_address Destination address */
/* */
/* OUTPUT */
/* */
/* status Actual completion status */
/* NX_PTR_ERROR Invalid pointer input */
/* */
/* CALLS */
/* */
/* _nx_dhcpv6_client_set_destination_address */
/* Actual set address service */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nxe_dhcpv6_client_set_destination_address(NX_DHCPV6 *dhcpv6_ptr, NXD_ADDRESS *destination_address)
{
UINT status;
/* Check for invalid input pointer. */
if ((dhcpv6_ptr == NX_NULL) || (dhcpv6_ptr -> nx_dhcpv6_id != NX_DHCPV6_ID))
{
return(NX_PTR_ERROR);
}
/* Check for an invalid address type. */
if (destination_address -> nxd_ip_version != NX_IP_VERSION_V6)
{
/* Invalid address type. */
return(NX_DHCPV6_PARAM_ERROR);
}
/* Check if the server address is unspecified (::). */
if(CHECK_UNSPECIFIED_ADDRESS(destination_address -> nxd_ip_address.v6))
{
/* Null address input. */
return(NX_DHCPV6_PARAM_ERROR);
}
/* Call the actual service. */
status = _nx_dhcpv6_client_set_destination_address(dhcpv6_ptr, destination_address);
/* Return completion status. */
return(status);
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_client_set_destination_address PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function set the destination address where DHCP message should */
/* be sent. By default is All_DHCP_Relay_Agents_and_Servers(FF02::1:2).*/
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPv6 Client */
/* destination_address Destination address */
/* */
/* OUTPUT */
/* */
/* NX_SUCCESS Successful completion status */
/* */
/* CALLS */
/* */
/* None */
/* */
/* CALLED BY */
/* */
/* Application */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_client_set_destination_address(NX_DHCPV6 *dhcpv6_ptr, NXD_ADDRESS *destination_address)
{
/* Get the DHCP mutex. */
tx_mutex_get(&(dhcpv6_ptr -> nx_dhcpv6_client_mutex), NX_WAIT_FOREVER);
/* Set the destination address. */
COPY_NXD_ADDRESS(destination_address, &(dhcpv6_ptr -> nx_dhcpv6_client_destination_address));
/* Release the DHCPv6 Client mutex. */
tx_mutex_put(&(dhcpv6_ptr -> nx_dhcpv6_client_mutex));
/* Return successful completion. */
return NX_SUCCESS;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nxe_dhcpv6_start PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function performs error checking on the NetX start the dhcpv6 */
/* client service. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPV6 Client instance*/
/* */
/* OUTPUT */
/* */
/* status Completion status */
/* NX_PTR_ERROR Invalid pointer input */
/* */
/* */
/* CALLS */
/* */
/* _nx_dhcpv6_start Actual DHCPV6 start function */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nxe_dhcpv6_start(NX_DHCPV6 *dhcpv6_ptr)
{
UINT status;
/* Check for invalid input pointer. */
if ((dhcpv6_ptr == NX_NULL) || (dhcpv6_ptr -> nx_dhcpv6_id != NX_DHCPV6_ID))
{
return(NX_PTR_ERROR);
}
/* Check for appropriate caller. */
NX_THREADS_ONLY_CALLER_CHECKING
/* Call actual DHCPV6 start service. */
status = _nx_dhcpv6_start(dhcpv6_ptr);
/* Return status. */
return(status);
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_start PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function starts the DHCPV6 processing thread and readies the */
/* DHCPv6 Client to initiate DHCPv6 requests. The Client state is set */
/* to INIT and awaits the host application requesting a DHCPv6 meesage */
/* sent e.g. the SOLICIT message. For hosts binding (or attempting to */
/* obtain) a IP address in a previous session, this will clear session */
/* parameters such as accrued lease time and message retry count. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPV6 Client instance*/
/* */
/* OUTPUT */
/* */
/* status Completion status */
/* NX_DHCPV6_ALREADY_STARTED DHCPv6 Client already started */
/* NX_DHCPV6_MISSING_REQUIRED_OPTIONS Client missing required options */
/* */
/* CALLS */
/* */
/* nx_udp_socket_create Create the Client UDP socket */
/* nx_udp_socket_bind Bind the Client socket */
/* nx_udp_socket_unbind Unbind the Client socket */
/* tx_timer_activate Activate Client timers */
/* tx_timer_deactivate Deactivate Client timers */
/* tx_thread_resume Resume Client thread task */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_start(NX_DHCPV6 *dhcpv6_ptr)
{
UINT status;
/* Get the DHCP mutex. */
tx_mutex_get(&(dhcpv6_ptr -> nx_dhcpv6_client_mutex), NX_DHCPV6_MUTEX_WAIT);
/* Determine if DHCPV6 has already been started. */
if (dhcpv6_ptr -> nx_dhcpv6_started)
{
/* Release the DHCPv6 Client mutex. */
tx_mutex_put(&(dhcpv6_ptr -> nx_dhcpv6_client_mutex));
/* Error, the DHCPV6 client has already been started. */
return(NX_DHCPV6_ALREADY_STARTED);
}
/* Determine if Client has created its DUID and IANA yet. */
if ((dhcpv6_ptr -> nx_dhcpv6_ip_ptr == NX_NULL) ||
(dhcpv6_ptr -> nx_dhcpv6_client_duid.nx_option_length == 0) ||
(dhcpv6_ptr -> nx_dhcpv6_iana.nx_option_length == 0))
{
/* Release the DHCPv6 Client mutex. */
tx_mutex_put(&(dhcpv6_ptr -> nx_dhcpv6_client_mutex));
/* No, this DHCPv6 Client is not ready to run! */
return NX_DHCPV6_MISSING_REQUIRED_OPTIONS;
}
/* Set the DHCPv6 Client state to Init.*/
dhcpv6_ptr -> nx_dhcpv6_state = NX_DHCPV6_STATE_INIT;
/* Clear the session time, lease lifetime, retransmission counters. */
dhcpv6_ptr -> nx_dhcpv6_elapsed_time.nx_session_time = 0;
dhcpv6_ptr -> nx_dhcpv6_IP_lifetime_time_accrued = 0;
dhcpv6_ptr -> nx_dhcpv6_transmission_timeout = 0;
dhcpv6_ptr -> nx_dhcpv6_retransmission_count = 0;
/* Bind the UDP socket to the DHCPV6 Client port. */
status = nx_udp_socket_bind(&(dhcpv6_ptr -> nx_dhcpv6_socket), NX_DHCPV6_CLIENT_UDP_PORT, TX_WAIT_FOREVER);
/* Check for success */
if (status == NX_SUCCESS)
{
/* Resume the DHCPv6 processing thread. */
status = tx_thread_resume(&(dhcpv6_ptr -> nx_dhcpv6_thread));
/* Determine if the resume was successful. */
if (status == NX_SUCCESS)
{
/* Set the DHCPv6 started flag to indicate DHCPv6 Client is now running. */
dhcpv6_ptr -> nx_dhcpv6_started = NX_TRUE;
/* Activate the DHCPv6 timers. */
tx_timer_activate(&dhcpv6_ptr -> nx_dhcpv6_IP_lifetime_timer);
}
else
{
/* Error, unbind the DHCPv6 socket. */
nx_udp_socket_unbind(&(dhcpv6_ptr -> nx_dhcpv6_socket));
}
}
/* Release the DHCPv6 Client mutex. */
tx_mutex_put(&(dhcpv6_ptr -> nx_dhcpv6_client_mutex));
/* Return completion status. */
return(status);
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nxe_dhcpv6_suspend PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function performs error checking on the suspend NetX DHCPv6 */
/* client task service. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPV6 Client instance*/
/* */
/* OUTPUT */
/* */
/* status Completion status */
/* NX_PTR_ERROR Invalid pointer input */
/* */
/* CALLS */
/* */
/* _nx_dhcpv6_suspend Actual DHCPV6 suspend function */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nxe_dhcpv6_suspend(NX_DHCPV6 *dhcpv6_ptr)
{
UINT status;
/* Check for invalid input pointer. */
if ((dhcpv6_ptr == NX_NULL) || (dhcpv6_ptr -> nx_dhcpv6_id != NX_DHCPV6_ID))
{
return(NX_PTR_ERROR);
}
/* Check for appropriate caller. */
NX_THREADS_ONLY_CALLER_CHECKING
/* Call actual DHCPV6 stop service. */
status = _nx_dhcpv6_suspend(dhcpv6_ptr);
/* Return status. */
return(status);
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_suspend PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function suspends (stops) DHCPV6 processing thread, stops the */
/* DHCP session and IP address lease timers, and clears the started */
/* status of the DHCPv6 Client. It resets the DHCPv6 Client to the */
/* INIT. The DHCP socket is unbound and the DHCP thread aborted. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPV6 Client instance */
/* */
/* OUTPUT */
/* */
/* NX_SUCCESS Successful completion status */
/* NX_DHCPV6_NOT_STARTED Task not running; can't be */
/* suspended */
/* */
/* CALLS */
/* */
/* tx_thread_suspend Suspend DHCPV6 thread task */
/* tx_timer_deactivate Deactivate timer */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_suspend(NX_DHCPV6 *dhcpv6_ptr)
{
UINT status;
status = _nx_dhcpv6_stop(dhcpv6_ptr);
return status;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_stop PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function performs error checking on the DHCPv6 Client stop */
/* service. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPV6 Client instance */
/* */
/* OUTPUT */
/* */
/* status Actual completion status */
/* */
/* CALLS */
/* */
/* _nx_dhcpv6_stop Actual stop DHCPV6 thread task */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nxe_dhcpv6_stop(NX_DHCPV6 *dhcpv6_ptr)
{
UINT status;
/* Check for invalid input pointer. */
if ((dhcpv6_ptr == NX_NULL) || (dhcpv6_ptr -> nx_dhcpv6_id != NX_DHCPV6_ID))
{
return(NX_PTR_ERROR);
}
/* Check for appropriate caller. */
NX_THREADS_ONLY_CALLER_CHECKING
/* Call actual DHCPV6 stop service. */
status = _nx_dhcpv6_stop(dhcpv6_ptr);
/* Return status. */
return(status);
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_stop PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function suspends (stops) DHCPV6 processing thread, stops the */
/* DHCP session and IP address lease timers. The DHCP socket is unbound*/
/* and the DHCP thread aborted. */
/* */
/* Stopping the DHCP Client is necessary to restart the DHCP client, */
/* example if a previously assigned address is declined or released, */
/* and the host would like to solicit an IP address again. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPV6 Client instance */
/* */
/* OUTPUT */
/* */
/* NX_SUCCESS Successful completion status */
/* NX_DHCPV6_NOT_STARTED Task not running; can't be */
/* suspended */
/* */
/* CALLS */
/* */
/* tx_thread_suspend Suspend DHCPV6 thread task */
/* tx_timer_deactivate Deactivate timer */
/* tx_mutex_get Obtain Client mutex */
/* tx_mutex_put Release Client mutex */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_stop(NX_DHCPV6 *dhcpv6_ptr)
{
UINT current_preemption;
/* Get the DHCP mutex. */
tx_mutex_get(&(dhcpv6_ptr -> nx_dhcpv6_client_mutex), NX_DHCPV6_MUTEX_WAIT);
/* Determine if DHCPV6 is started. */
if (dhcpv6_ptr -> nx_dhcpv6_started == NX_FALSE)
{
/* Release the DHCP mutex. */
tx_mutex_put(&(dhcpv6_ptr -> nx_dhcpv6_client_mutex));
/* DHCPV6 has not been started so we cannot stop it. */
return(NX_DHCPV6_NOT_STARTED);
}
/* Clear the DHCPV6 started flag to indicate DHCPV6 task is not running. */
dhcpv6_ptr -> nx_dhcpv6_started = NX_FALSE;
/* Disable preemption for critical section. */
tx_thread_preemption_change(tx_thread_identify(), 0, ¤t_preemption);
/* Loop to wait for the DHCP Client thread to be in a position to be stopped. */
while (dhcpv6_ptr -> nx_dhcpv6_sleep_flag != NX_TRUE)
{
/* Release the DHCP mutex. */
tx_mutex_put(&(dhcpv6_ptr -> nx_dhcpv6_client_mutex));
/* Sleep temporarily. */
tx_thread_sleep(1);
/* Get the DHCP mutex. */
tx_mutex_get(&(dhcpv6_ptr -> nx_dhcpv6_client_mutex), NX_DHCPV6_MUTEX_WAIT);
}
/* Clear the flag. */
dhcpv6_ptr -> nx_dhcpv6_sleep_flag = NX_FALSE;
/* Suspend the DHCP thread. */
tx_thread_suspend(&(dhcpv6_ptr -> nx_dhcpv6_thread));
/* Abort the wait on the DHCP Client thread. */
tx_thread_wait_abort(&(dhcpv6_ptr -> nx_dhcpv6_thread));
/* Unbind the port. */
nx_udp_socket_unbind(&(dhcpv6_ptr -> nx_dhcpv6_socket));
/* Stop the timers. */
tx_timer_deactivate(&(dhcpv6_ptr -> nx_dhcpv6_IP_lifetime_timer));
tx_timer_deactivate(&(dhcpv6_ptr -> nx_dhcpv6_session_timer));
/* Restore preemption. */
tx_thread_preemption_change(tx_thread_identify(), current_preemption, ¤t_preemption);
/* Release the DHCP mutex. */
tx_mutex_put(&(dhcpv6_ptr -> nx_dhcpv6_client_mutex));
/* Return completion status. */
return(NX_SUCCESS);
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nxd_dhcpv6_reinitialize PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function performs error checking for the reinitializes the */
/* DHCPv6 Client service. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPv6 Client */
/* */
/* OUTPUT */
/* */
/* status Actual completion status */
/* */
/* CALLS */
/* */
/* _nx_dhcpv6_reinitialize Actual clear address service */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nxe_dhcpv6_reinitialize(NX_DHCPV6 *dhcpv6_ptr)
{
UINT status;
if (dhcpv6_ptr == NX_NULL)
{
return NX_PTR_ERROR;
}
/* Check for appropriate caller. */
NX_THREADS_ONLY_CALLER_CHECKING
status = _nx_dhcpv6_reinitialize(dhcpv6_ptr);
return status;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_reinitialize PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function reinitializes the DHCP instance for restarting the */
/* DHCP client state machine and re-running the DHCPv6 protocol. This */
/* is not necessary if the Client has not previously obtained an */
/* IP address from the server. The IP address in both the DHCP Client */
/* data record and in the IP instance is cleared. */
/* */
/* Note: the host MUST stop the DHCPv6 client before calling this */
/* service with the nx_dhcpv6_stop service. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPv6 Client */
/* */
/* OUTPUT */
/* */
/* NX_DHCPV6_ALREADY_STARTED DHCPv6 client is running */
/* status Actual completion status */
/* */
/* CALLS */
/* */
/* _nx_dhcpv6_remove_assigned_address Clears client IP address */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_reinitialize(NX_DHCPV6 *dhcpv6_ptr)
{
UINT status;
/* Check that the DHCPv6 client is started. */
if (dhcpv6_ptr -> nx_dhcpv6_started == NX_TRUE)
{
/* Need to stop the DHCP client before we can reinitialize it. */
return NX_DHCPV6_ALREADY_STARTED;
}
/* This clears the assigned IP address from the Client record, as well as
removes the assigned IP address from the IP address table. */
status = _nx_dhcpv6_remove_assigned_address(dhcpv6_ptr, NX_DHCPV6_REMOVE_ALL_IA_ADDRESS);
return status;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_thread_entry PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function is the background processing thread for the DHCPV6 */
/* Client. It waits to be notified by ThreadX event flags when to */
/* perform certain actions. These include updating the time remaining */
/* on the Client IP address lease time, and maintaining the duration of*/
/* the current Client Server session (if Client has made a request). */
/* It will terminate if a host application handler is called and */
/* indicates the Client should abort. */
/* */
/* INPUT */
/* */
/* info Pointer to DHCPV6 Client instance*/
/* */
/* OUTPUT */
/* */
/* None */
/* */
/* CALLS */
/* */
/* tx_event_flags_get Receive notice of event flags set */
/* tx_mutex_get Obtain lock on Client resource */
/* tx_mutex_put Release lock on Client resource */
/* _nx_dhcpv6_request_renew Initiate the RENEW request */
/* _nx_dhcpv6_request_rebind Initiate the REBIND request */
/* _nx_dhcpv6_request_decline Initiate the DECLINE request */
/* _nx_dhcpv6_remove_assigned_address */
/* Remove the assigned IPv6 address */
/* */
/* CALLED BY */
/* */
/* ThreadX */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
VOID _nx_dhcpv6_thread_entry(ULONG info)
{
UINT status;
NX_DHCPV6 *dhcpv6_ptr;
UINT current_preemption;
ULONG dhcpv6_events;
UINT ia_index;
UINT original_state;
/* Setup the DHCPV6 Client pointer. */
NX_THREAD_EXTENSION_PTR_GET(dhcpv6_ptr, NX_DHCPV6, info)
/* Process periodic DHCPv6 Client tasks. */
do
{
/* Loop to get the DHCP mutex to handle error, release, and
stop requests properly. */
do
{
/* Get the DHCP mutex. */
status = tx_mutex_get(&(dhcpv6_ptr -> nx_dhcpv6_client_mutex), NX_DHCPV6_MUTEX_WAIT);
} while (status != TX_SUCCESS);
/* Check the state of the DHCP Client state for further DHCP messaging. */
_nx_dhcpv6_process(dhcpv6_ptr);
/* Release the DHCP mutex. */
tx_mutex_put(&(dhcpv6_ptr -> nx_dhcpv6_client_mutex));
/* Disable preemption for critical section. */
tx_thread_preemption_change(tx_thread_identify(), 0, ¤t_preemption);
/* Indicate the DHCP Client process is idle. */
dhcpv6_ptr -> nx_dhcpv6_sleep_flag = NX_TRUE;
/* Sleep for timer interval. */
tx_thread_sleep(NX_DHCPV6_SESSION_TIMER_INTERVAL);
/* Clear flag to indicate DHCP thread is not in a position to be stopped. */
dhcpv6_ptr -> nx_dhcpv6_sleep_flag = NX_FALSE;
/* Restore original preemption. */
tx_thread_preemption_change(tx_thread_identify(), current_preemption, ¤t_preemption);
/* Check the expiration on valid and preferred lifetimes only if the Client is in the Bound state. */
if (dhcpv6_ptr -> nx_dhcpv6_state == NX_DHCPV6_STATE_BOUND_TO_ADDRESS)
{
/* At time T1 for an IA, the client initiates a Renew message exchange to extend the lifetimes. RFC3315,page 42.*/
if (dhcpv6_ptr -> nx_dhcpv6_IP_lifetime_time_accrued >= dhcpv6_ptr -> nx_dhcpv6_iana.nx_T1)
{
/* Indicate the DHCP Client process is idle while the handler executes. */
dhcpv6_ptr -> nx_dhcpv6_sleep_flag = NX_TRUE;
/* Sending the renew message. */
_nx_dhcpv6_request_renew(dhcpv6_ptr);
/* Reset flag to indicate DHCP thread is not idle (not stoppable). */
dhcpv6_ptr -> nx_dhcpv6_sleep_flag = NX_FALSE;
}
}
/* Check the expiration on valid and preferred lifetimes only if the Client is in the sending renew state. */
if (dhcpv6_ptr -> nx_dhcpv6_state == NX_DHCPV6_STATE_SENDING_RENEW)
{
/* At time T2 for an IA, The Client initiates a Rebind message exchanges. RFC3315, page 43. */
if (dhcpv6_ptr -> nx_dhcpv6_IP_lifetime_time_accrued >= dhcpv6_ptr -> nx_dhcpv6_iana.nx_T2)
{
/* Indicate the DHCP Client process is idle while the handler executes. */
dhcpv6_ptr -> nx_dhcpv6_sleep_flag = NX_TRUE;
/* Sending the rebind message. */
_nx_dhcpv6_request_rebind(dhcpv6_ptr);
/* Reset flag to indicate DHCP thread is not idle (not stoppable). */
dhcpv6_ptr -> nx_dhcpv6_sleep_flag = NX_FALSE;
}
}
/* Check the DHCPv6 Client state. */
if ((dhcpv6_ptr -> nx_dhcpv6_state == NX_DHCPV6_STATE_BOUND_TO_ADDRESS) ||
(dhcpv6_ptr -> nx_dhcpv6_state == NX_DHCPV6_STATE_SENDING_RENEW) ||
(dhcpv6_ptr -> nx_dhcpv6_state == NX_DHCPV6_STATE_SENDING_REBIND))
{
for(ia_index = 0; ia_index < NX_DHCPV6_MAX_IA_ADDRESS; ia_index++)
{
/* Has the IP address valid lifetime expired? */
if ((dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_address_status) &&
(dhcpv6_ptr -> nx_dhcpv6_IP_lifetime_time_accrued >= dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_valid_lifetime))
{
/* Save the existing state of the DHCPv6 Client. */
original_state = dhcpv6_ptr -> nx_dhcpv6_state;
/* Clear the assigned IP address. */
_nx_dhcpv6_remove_assigned_address(dhcpv6_ptr, ia_index);
/* Indicate the DHCP Client process is idle while the handler executes. */
dhcpv6_ptr -> nx_dhcpv6_sleep_flag = NX_TRUE;
/* Restart the Client to the solicit IP address request state. */
_nx_dhcpv6_request_solicit(dhcpv6_ptr);
/* Indicate the DHCP Client process is idle while the handler executes. */
dhcpv6_ptr -> nx_dhcpv6_sleep_flag = NX_FALSE;
if (dhcpv6_ptr -> nx_dhcpv6_state_change_callback && (original_state != dhcpv6_ptr -> nx_dhcpv6_state))
{
/* Yes, call the state change callback with the original and new state. */
(dhcpv6_ptr -> nx_dhcpv6_state_change_callback)(dhcpv6_ptr, original_state, dhcpv6_ptr -> nx_dhcpv6_state);
}
}
}
}
/* Pickup IP event flags. */
status = tx_event_flags_get(&(_nx_dhcpv6_DAD_ptr -> nx_dhcpv6_events), NX_IP_ALL_EVENTS, TX_OR_CLEAR, &dhcpv6_events, TX_NO_WAIT);
/* Check for an IP receive packet event. */
if ((status == TX_SUCCESS) && (dhcpv6_events & NX_DHCPV6_DAD_FAILURE_EVENT))
{
/* Indicate the DHCP Client process is idle while the handler executes. */
dhcpv6_ptr -> nx_dhcpv6_sleep_flag = NX_TRUE;
/* The DAD process failure, send DHCPv6 DECLINE message. */
_nx_dhcpv6_request_decline(dhcpv6_ptr);
dhcpv6_events = dhcpv6_events & ~(ULONG)(NX_DHCPV6_DAD_FAILURE_EVENT);
/* Reset flag to indicate DHCP thread is not idle (not stoppable). */
dhcpv6_ptr -> nx_dhcpv6_sleep_flag = NX_FALSE;
}
} while (1);
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_utility_get_block_option_length PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function parses the input buffer (assuming to be an option */
/* block in a server reply) for option code and length. It assumes the */
/* buffer pointer is pointed to the first byte of the option buffer. */
/* */
/* INPUT */
/* */
/* dhcpv6_ Pointer to DHCPv6 Client */
/* option Option code of requested data */
/* buffer_ptr Buffer to copy data to */
/* length Size of buffer */
/* valid */
/* */
/* OUTPUT */
/* */
/* status Completion status */
/* NX_DHCPV6_INCOMPLETE_OPTION_BLOCK Unknown option specified */
/* */
/* CALLS */
/* */
/* _nx_dhcpv6_utility_get_data Parses a specific data from the */
/* DHCPv6 option */
/* */
/* CALLED BY */
/* */
/* _nx_dhcpv6_utility_get_block_option_length */
/* Parses option code and length */
/* _nx_dhcpv6_extract_packet_information */
/* Parses each option from server */
/* reply and updates Client record */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_utility_get_block_option_length(UCHAR *buffer_ptr, ULONG *option, ULONG *length)
{
/* Initialize to zero. */
*option = 0;
*length = 0;
/* First byte should be the op code. */
_nx_dhcpv6_utility_get_data(buffer_ptr, 2, option);
buffer_ptr += 2;
/* Next byte should be the option length. */
_nx_dhcpv6_utility_get_data(buffer_ptr, 2, length);
/* Buffer is now pointed at the data (past the length field). */
buffer_ptr += 2;
/* Check for null data. */
if (*option == 0)
{
return NX_DHCPV6_INCOMPLETE_OPTION_BLOCK;
}
return(NX_SUCCESS);
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_utility_get_data PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function parses the input buffer and returns numeric data */
/* specified by the size argument, up to 4 bytes long. Note that if */
/* caller is using this utility to extract bytes from a DHCPv6 packet */
/* there is no need for byte swapping, as compared to using memcpy in */
/* which case there is for little endian processors. */
/* */
/* INPUT */
/* */
/* buffer Pointer to data buffer */
/* value Pointer to data parsed from buffer*/
/* size Size of buffer */
/* */
/* OUTPUT */
/* */
/* NX_DHCPV6_INVALID_DATA_SIZE Requested data size too large */
/* NX_SUCCESS Successful completion status */
/* */
/* CALLS */
/* */
/* None */
/* */
/* CALLED BY */
/* _nx_dhcpv6_process_server_duid Process server duid in server reply*/
/* _nx_dhcpv6_process_client_duid Process server duid in server reply*/
/* _nx_dhcpv6_utility_get_block_option_length */
/* Parses option code and length */
/* _nx_dhcpv6_extract_packet_information */
/* Parses each option from server */
/* reply and updates Client record */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_utility_get_data(UCHAR *buffer, UINT size, ULONG *value)
{
/* Check that the size of the data fits in a ULONG. */
if (size > sizeof(ULONG))
{
return NX_DHCPV6_INVALID_DATA_SIZE;
}
*value = 0;
/* Process the data retrieval request. */
while (size-- > 0)
{
/* Build return value. */
*value = (((*value) << 8) | (*buffer));
buffer++;
}
/* Return value. */
return NX_SUCCESS;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_utility_time_randomize PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function returns a value of between -1 seconds and 1 second */
/* in system ticks. It is used to randomize timeouts as required by */
/* the RFC's so as to not overload a network server after power out. */
/* */
/* INPUT */
/* */
/* None */
/* */
/* OUTPUT */
/* */
/* ticks Number of ticks between 1 & -1*/
/* */
/* CALLS */
/* */
/* None */
/* */
/* CALLED BY */
/* */
/* _nx_dhcpv6_convert_delay_to_ticks Convert seconds to ticks */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
INT _nx_dhcpv6_utility_time_randomize(void)
{
UINT temp;
UINT sign;
INT temp_signed;
temp = (UINT)(NX_RAND());
temp &= (UINT)(0x001F);
sign = (temp & (UINT)(0x8));
temp_signed = (INT)temp;
/* Try for a number between 0 and 0x1F. */
if (sign)
{
temp_signed = -temp_signed;
}
return temp_signed;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_waiting_on_reply PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function waits to receive a DHCPv6 server packet for the wait */
/* time set by the DHCPv6 client previously. If a reply is received, */
/* call function to process it. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPV6 Client instance */
/* */
/* OUTPUT */
/* */
/* status Actual completion status */
/* NX_SUCCESS Valid packet received */
/* */
/* CALLS */
/* */
/* nx_udp_socket_receive Receive UDP packet */
/* nx_packet_release Release packet to packet pool */
/* _nx_dhcpv6_packet_procss Process the dhcpv6 packet */
/* _nx_dhcpv6_flush_queue_packets Flush the queue packets */
/* */
/* CALLED BY */
/* */
/* _nx_dhcpv6_process Process current client state */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* fixed compiler warnings, */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_waiting_on_reply(NX_DHCPV6 *dhcpv6_ptr)
{
UINT current_preemption;
UINT status;
NX_PACKET *packet_ptr;
ULONG start_time;
ULONG current_time;
ULONG elapsed_time;
ULONG receive_wait;
UINT time_remaining;
UINT valid_answer;
/* Initialize the parameters. */
packet_ptr = NX_NULL;
valid_answer = NX_FALSE;
time_remaining = dhcpv6_ptr -> nx_dhcpv6_transmission_timeout;
/* Wait in short intervals to receive a valid packet while continuously checking for packets not intended
for this DHCP Client to be removed from the receive queue. */
do
{
/* Release the DHCP mutex while the Client will be blocked on a receive socket call. */
tx_mutex_put(&(dhcpv6_ptr -> nx_dhcpv6_client_mutex));
/* Disable preemption for critical section. */
tx_thread_preemption_change(tx_thread_identify(), 0, ¤t_preemption);
/* Indicate the DHCP Client can be stopped. */
dhcpv6_ptr -> nx_dhcpv6_sleep_flag = NX_TRUE;
start_time = tx_time_get();
if (time_remaining < NX_DHCPV6_TIME_INTERVAL)
{
receive_wait = time_remaining;
}
else
{
receive_wait = NX_DHCPV6_TIME_INTERVAL;
}
status = nx_udp_socket_receive(&(dhcpv6_ptr -> nx_dhcpv6_socket), &packet_ptr, receive_wait);
/* Indicate the DHCP Client can not be stopped. */
dhcpv6_ptr -> nx_dhcpv6_sleep_flag = NX_FALSE;
/* Restore preemption/ end of critical section. */
tx_thread_preemption_change(tx_thread_identify(), current_preemption, ¤t_preemption);
/* Yes, receive a packet. */
if (status == NX_SUCCESS)
{
/* Get the DHCP mutex. */
while((tx_mutex_get(&(dhcpv6_ptr -> nx_dhcpv6_client_mutex), NX_NO_WAIT) != TX_SUCCESS) &&
(time_remaining > 0))
{
if (time_remaining < NX_DHCPV6_TIME_INTERVAL)
{
tx_thread_sleep(time_remaining);
time_remaining = 0;
}
else
{
tx_thread_sleep(NX_DHCPV6_TIME_INTERVAL);
time_remaining = (UINT)(time_remaining - NX_DHCPV6_TIME_INTERVAL);
}
}
/* Process the dhcpv6 packet. */
status = _nx_dhcpv6_packet_process(dhcpv6_ptr, packet_ptr);
/* Check the status. */
if(status == NX_SUCCESS)
{
/* Yes, Get a valid advertise or reply message. */
valid_answer = NX_TRUE;
/* DHCPv6 client MUST collect Advertise messages for the first RT seconds,
unless it receives an Advertise message with a preference value of 255.
RFC 3315, Section 17.1.2, Page 34. */
if((dhcpv6_ptr -> nx_dhcpv6_state == NX_DHCPV6_STATE_SENDING_SOLICIT) &&
(dhcpv6_ptr -> nx_dhcpv6_retransmission_count == 0))
{
/* Process the rapid solicit mode. */
if(dhcpv6_ptr -> nx_dhcpv6_request_solicit_mode == NX_DHCPV6_SOLICIT_RAPID)
{
/* Client terminates the waiting process as soon as a reply message
with a Rapid Commit option is received. RFC3315, Section17.1.2, Page34. */
break;
}
/* Process the normal solicit mode. */
if(dhcpv6_ptr -> nx_dhcpv6_preference.nx_pref_value == 255)
{
/* If the client receives an Advertise message that includes a Preference option with
a preference value of 255, the client can terminates the waiting. */
break;
}
}
else
{
/* Yes, Get the answer. */
break;
}
}
}
/* How much time has elapsed? */
current_time = tx_time_get();
/* Has the time wrapped? */
if (current_time >= start_time)
{
/* No, simply subtract to get the elapsed time. */
elapsed_time = current_time - start_time;
}
else
{
/* Yes it has. Time has rolled over the 32-bit boundary. */
elapsed_time = (((ULONG) 0xFFFFFFFF) - start_time) + current_time;
}
/* Update the time remaining. */
if (time_remaining > elapsed_time)
{
time_remaining -= elapsed_time;
}
else
{
/* Time is up, break out of this loop. */
time_remaining = 0;
/* But not before restoring preemption/ end of critical section! */
tx_thread_preemption_change(tx_thread_identify(), current_preemption, ¤t_preemption);
break;
}
} while(time_remaining > 0);
/* Flush the queue packets. */
_nx_dhcpv6_flush_queue_packets(dhcpv6_ptr);
/* Check the valid answer flag. */
if (valid_answer == NX_TRUE)
{
return NX_SUCCESS;
}
else
{
return NX_DHCPV6_INVALID_SERVER_PACKET;
}
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_packet_process PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function process the receive pacet. the data is copied to */
/* another packet from the DHCPv6 Client packet pool,and the original */
/* received packet is released back to the receive pool immediately. */
/* Then process the reply message. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPV6 Client instance */
/* packet_ptr Pointer to received packet */
/* */
/* OUTPUT */
/* */
/* status Actual completion status */
/* NX_SUCCESS Process correctly */
/* */
/* CALLS */
/* */
/* nx_udp_socket_extract Get the reply information */
/* nx_packet_release Release packet to packet pool */
/* nx_packet_allocate Allocate a new packet. */
/* nx_packet_data_extract_offset Store the received pacet data. */
/* _nx_dhcpv6_scan_packet_options Scan and record the reply options. */
/* _nx_dhcpv6_preprocess_packet_information */
/* Preprocess the packet according to */
/* the options record. */
/* _nx_dhcpv6_extract_packet_information */
/* Extract server reply data */
/* */
/* CALLED BY */
/* */
/* _nx_dhcpv6_waiting_on_reply Process current client message */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_packet_process(NX_DHCPV6 *dhcpv6_ptr, NX_PACKET *packet_ptr)
{
UINT status;
UINT port;
ULONG bytes_copied;
NXD_ADDRESS server_IP_Address;
NX_PACKET *new_packet_ptr;
/* Check for valid packet length (message type and ID). */
if (packet_ptr -> nx_packet_length < 4)
{
/* Release the packet. */
nx_packet_release(packet_ptr);
/* Return. */
return(NX_DHCPV6_INVALID_DATA_SIZE);
}
/* Extract the IP and port number from the packet and set the reply address. */
status = nxd_udp_source_extract(packet_ptr, &server_IP_Address, &port);
/* Check status. */
if (status != NX_SUCCESS)
{
/* Release the packet. We don't want it. */
nx_packet_release(packet_ptr);
/* Error extracting packet source information, return error status. */
return(status);
}
/* Copy the received packet into the packet allocated by the DHCPv6 Client. */
status = nx_packet_allocate(dhcpv6_ptr -> nx_dhcpv6_pool_ptr,
&new_packet_ptr, NX_IPv6_UDP_PACKET,
NX_DHCPV6_PACKET_TIME_OUT);
/* Check for errors. */
if (status != NX_SUCCESS)
{
/* Release the receive packet. We can't use it. */
nx_packet_release(packet_ptr);
return status;
}
/* Verify the incoming packet does not exceed our DHCPv6 Client packet payload. */
if ((ULONG)(new_packet_ptr -> nx_packet_data_end - new_packet_ptr -> nx_packet_prepend_ptr) < packet_ptr -> nx_packet_length)
{
/* Release the packet allocated from the Client pool*/
nx_packet_release(new_packet_ptr);
/* Release the received packet. We can't use it. */
nx_packet_release(packet_ptr);
return(NX_DHCPV6_INVALID_DATA_SIZE);
}
/* Use a packet from the DHCP Client as a buffer to store the received packet data.
Then we can release the received packet back to its packet pool. */
status = nx_packet_data_extract_offset(packet_ptr, 0,(VOID *)new_packet_ptr -> nx_packet_prepend_ptr, packet_ptr -> nx_packet_length, &bytes_copied);
/* Check status. */
if ((status != NX_SUCCESS) || (bytes_copied == 0))
{
/* Release the packet allocated from the Client pool*/
nx_packet_release(new_packet_ptr);
/* Release the received packet. We can't use it. */
nx_packet_release(packet_ptr);
/* Error extracting packet buffer, return error status. */
return(status);
}
/* Now we can release the received packet. */
nx_packet_release(packet_ptr);
/* Update the new packet with the bytes copied. For chained packets, this will reflect the total
'datagram' length. */
new_packet_ptr -> nx_packet_length = bytes_copied;
new_packet_ptr -> nx_packet_append_ptr = new_packet_ptr -> nx_packet_prepend_ptr + bytes_copied;
/* Process the DHCPv6 packet.*/
/* Scan the packet options and record it. */
status = _nx_dhcpv6_scan_packet_options(dhcpv6_ptr, new_packet_ptr);
/* Check for errors processing the packet. */
if (status != NX_SUCCESS)
{
/* Release the Client packet. We can't use it. */
nx_packet_release(new_packet_ptr);
/* Return error status. */
return status;
}
/* Preprocess the packet options. */
status = _nx_dhcpv6_preprocess_packet_information(dhcpv6_ptr, new_packet_ptr);
/* Check for errors processing the packet. */
if (status != NX_SUCCESS)
{
/* Release the Client packet. We can't use it. */
nx_packet_release(new_packet_ptr);
/* Return error status. */
return status;
}
/* Extract the info from the packet buffer into the Client record. */
status = _nx_dhcpv6_extract_packet_information(dhcpv6_ptr, new_packet_ptr);
/* Release the Client packet. We are done with it. */
nx_packet_release(new_packet_ptr);
/* Store the DHCPv6 server address. */
if ((status == NX_SUCCESS) && (dhcpv6_ptr -> nx_dhcpv6_received_message_type == NX_DHCPV6_MESSAGE_TYPE_REPLY))
{
COPY_NXD_ADDRESS(&server_IP_Address, &(dhcpv6_ptr-> nx_dhcpv6_server_address));
}
/* Successfully processed response from the server. */
return status;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_scan_packet_options PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function scan the packet options of DHCPv6 server response and */
/* record the relevant options. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPv6 Client */
/* packet_ptr Pointer to received packet */
/* */
/* OUTPUT */
/* */
/* status Actual completion status */
/* NX_SUCCESS Successful completion status */
/* NX_DHCPV6_UNKNOWN_OPTION Unknown option in message */
/* */
/* CALLS */
/* */
/* _nx_dhcpv6_utility_get_block_option_length */
/* Extract option and length data */
/* memcpy Copies specified area of memory */
/* */
/* CALLED BY */
/* */
/* _nx_dhcpv6_packet_process Process dhcpv6 packet. */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), and */
/* verified memcpy use cases, */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_scan_packet_options(NX_DHCPV6 *dhcpv6_ptr, NX_PACKET *packet_ptr)
{
UINT status;
UCHAR *dhcpv6_option_ptr;
UINT index;
ULONG option_code;
ULONG option_length;
UCHAR *dhcpv6_iana_option_ptr;
UINT iana_index;
ULONG iana_option_code;
ULONG iana_option_length;
UCHAR *dhcpv6_ia_option_ptr;
ULONG ia_option_index;
ULONG ia_option_code;
ULONG ia_option_length;
ULONG ipv6_address[4];
USHORT status_code;
UINT ia_index;
UINT w;
UINT ia_count = 0;
/* Set a pointer to the start of DHCPv6 options. */
dhcpv6_option_ptr = (packet_ptr -> nx_packet_prepend_ptr + 4);
/* Initialize local variables. */
index = 4;
dhcpv6_ptr -> nx_dhcpv6_reply_option_flags = 0;
dhcpv6_ptr -> nx_dhcpv6_reply_option_current_pref_value = 0;
/* Clear the IA address map status. */
for(ia_index = 0; ia_index < NX_DHCPV6_MAX_IA_ADDRESS; ia_index++)
{
dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_address_map = 0;
}
/* Now parse all the DHCPv6 option blocks in the packet buffer. */
/* 4 bytes is data pointer offset, and 4 bytes for option code and option length. */
while (index + 4 <= packet_ptr -> nx_packet_length)
{
/* Get the option code and length of data of the current option block. */
status = _nx_dhcpv6_utility_get_block_option_length(dhcpv6_option_ptr, &option_code, &option_length);
/* Check that the block data is valid. */
if (status != NX_SUCCESS)
{
/* No, return the error status. */
return status;
}
/* Check if option data is in the packet. */
if ((dhcpv6_option_ptr + 4 + option_length) > packet_ptr -> nx_packet_append_ptr)
{
return(NX_DHCPV6_INCOMPLETE_OPTION_BLOCK);
}
/* Process the option code with an option specific API. */
switch (option_code)
{
/* Note - these 'process' functions will not move the buffer pointer. */
case NX_DHCPV6_OP_CLIENT_ID:
{
/* Yes, The message includes the Client DUID option. */
dhcpv6_ptr -> nx_dhcpv6_reply_option_flags |= NX_DHCPV6_INCLUDE_CLIENT_ID_OPTION;
break;
}
case NX_DHCPV6_OP_SERVER_ID:
{
/* Yes, The message includes the Server DUID option. */
dhcpv6_ptr -> nx_dhcpv6_reply_option_flags |= NX_DHCPV6_INCLUDE_SERVER_ID_OPTION;
break;
}
case NX_DHCPV6_OP_IA_NA:
{
/* The minimum length of IANA option field is 12 bytes. */
if (option_length < 12)
{
return(NX_DHCPV6_INCOMPLETE_OPTION_BLOCK);
}
/* Yes, The message includes the Server DUID option. */
dhcpv6_ptr -> nx_dhcpv6_reply_option_flags |= NX_DHCPV6_INCLUDE_IA_NA_OPTION;
/* Skip the IA_NA header data (4 bytes for IANA option code and option length, 12 bytes for IANA option field). */
dhcpv6_iana_option_ptr = dhcpv6_option_ptr + 4 + 12;
iana_index = 0;
/* Process the IA and status options embedded in the IANA option. */
/* 12 bytes is IA_NA header, 4 bytes for iana sub option code and option length. */
while(iana_index + 4 <= (option_length - 12))
{
/* Get the next option code and length. */
status = _nx_dhcpv6_utility_get_block_option_length(dhcpv6_iana_option_ptr, &iana_option_code, &iana_option_length);
/* Check if the option data is in the packet. */
if ((dhcpv6_iana_option_ptr + 4 + iana_option_length) > packet_ptr -> nx_packet_append_ptr)
{
return(NX_DHCPV6_INCOMPLETE_OPTION_BLOCK);
}
/* Check the IA address option embedded in the IANA option. */
if(iana_option_code == NX_DHCPV6_OP_IA_ADDRESS)
{
/* The minimum length of IA address option is 24 bytes. */
if (iana_option_length < 24)
{
return(NX_DHCPV6_INCOMPLETE_OPTION_BLOCK);
}
/* Yes, The message includes the IA option. */
dhcpv6_ptr -> nx_dhcpv6_reply_option_flags |= NX_DHCPV6_INCLUDE_IA_ADDRESS_OPTION;
/* Increase the IA option count. */
ia_count ++;
/* Skip the IA type and length option. */
ia_option_index = 4;
/* Get the IPv6 address of IA option. */
for (w = 0; w <= 3; w++)
{
/* Copy each IPv6 address word into the IA address. */
memcpy(&ipv6_address[w], (dhcpv6_iana_option_ptr + ia_option_index), sizeof(ULONG)); /* Use case of memcpy is verified. */
/* Adjust for endianness. */
NX_CHANGE_ULONG_ENDIAN(ipv6_address[w]);
ia_option_index += 4;
}
/* Check the IA table, find the same IPv6 address. */
for(w = 0; w < NX_DHCPV6_MAX_IA_ADDRESS; w++)
{
if(!(memcmp(&(dhcpv6_ptr->nx_dhcpv6_ia[w].nx_global_address.nxd_ip_address.v6[0]), &ipv6_address[0], 16)))
{
/* Yes, it is, record the index to store the IA option, 0 means is IA address inexistence.
Then update the IA option according to the IA count in nx_dhcpv6_update_ia function. */
dhcpv6_ptr -> nx_dhcpv6_ia[w].nx_address_map = ia_count;
break;
}
}
/* Check the IA option whether include the status codes or not. */
/* 24 bytes is IA address option, 4 bytes for next option code and option length. */
if(iana_option_length >= (24 + 4))
{
/* Yes, include status codes, skip the IA header data. */
dhcpv6_ia_option_ptr = dhcpv6_iana_option_ptr + 28;
/* Get the status code and length. */
status = _nx_dhcpv6_utility_get_block_option_length(dhcpv6_ia_option_ptr, &ia_option_code, &ia_option_length);
/* Check if the option data is in the packet. */
if ((dhcpv6_ia_option_ptr + 4 + ia_option_length) > packet_ptr -> nx_packet_append_ptr)
{
return(NX_DHCPV6_INCOMPLETE_OPTION_BLOCK);
}
if(ia_option_code == NX_DHCPV6_OP_STATUS_CODE)
{
if (ia_option_length < 2)
{
return(NX_DHCPV6_INCOMPLETE_OPTION_BLOCK);
}
/* Yes, the message includes the STATUS option, get the code. */
memcpy(&status_code, (dhcpv6_ia_option_ptr + 4), sizeof(USHORT)); /* Use case of memcpy is verified. */
/* Adjust for endianness. */
NX_CHANGE_USHORT_ENDIAN(status_code);
if(status_code == 0)
{
/* Yes, The message includes the Success status option. */
dhcpv6_ptr -> nx_dhcpv6_reply_option_flags |= NX_DHCPV6_INCLUDE_STATUS_SUCCESS_OPTION;
}
else if(status_code == 1)
{
/* Yes, The message includes the UnspecFail status option. */
dhcpv6_ptr -> nx_dhcpv6_reply_option_flags |= NX_DHCPV6_INCLUDE_STATUS_UNSPEC_FAIL_OPTION;
}
else if(status_code == 2)
{
/* Yes, The message includes the NoAddrsAvail status option. */
dhcpv6_ptr -> nx_dhcpv6_reply_option_flags |= NX_DHCPV6_INCLUDE_STATUS_NO_ADDR_AVAIL_OPTION;
}
else if(status_code == 3)
{
/* Yes, The message includes the NoBinding status option. */
dhcpv6_ptr -> nx_dhcpv6_reply_option_flags |= NX_DHCPV6_INCLUDE_STATUS_NO_BIND_OPTION;
}
else if(status_code == 4)
{
/* Yes, The message includes the NotOnLink status option. */
dhcpv6_ptr -> nx_dhcpv6_reply_option_flags |= NX_DHCPV6_INCLUDE_STATUS_NOT_ONLINK_OPTION;
}
else if(status_code == 5)
{
/* Yes, The message includes the UseMulticast status option. */
dhcpv6_ptr -> nx_dhcpv6_reply_option_flags |= NX_DHCPV6_INCLUDE_STATUS_USE_MULTICAST_OPTION;
}
else
{
/* This is an unsupported or unknown option. */
return NX_DHCPV6_UNKNOWN_OPTION;
}
}
else
{
/* This is an unsupported or unknown option. */
return NX_DHCPV6_UNKNOWN_OPTION;
}
}
}
/* Check if this is an status option request. */
else if(iana_option_code == NX_DHCPV6_OP_STATUS_CODE)
{
if (iana_option_length < 2)
{
return(NX_DHCPV6_INCOMPLETE_OPTION_BLOCK);
}
/* Yes, the message includes the STATUS option, get the code. */
memcpy(&status_code, (dhcpv6_iana_option_ptr + 4), sizeof(USHORT)); /* Use case of memcpy is verified. */
/* Adjust for endianness. */
NX_CHANGE_USHORT_ENDIAN(status_code);
if(status_code == 0)
{
/* Yes, The message includes the Success status option. */
dhcpv6_ptr -> nx_dhcpv6_reply_option_flags |= NX_DHCPV6_INCLUDE_STATUS_SUCCESS_OPTION;
}
else if(status_code == 1)
{
/* Yes, The message includes the UnspecFail status option. */
dhcpv6_ptr -> nx_dhcpv6_reply_option_flags |= NX_DHCPV6_INCLUDE_STATUS_UNSPEC_FAIL_OPTION;
}
else if(status_code == 2)
{
/* Yes, The message includes the NoAddrsAvail status option. */
dhcpv6_ptr -> nx_dhcpv6_reply_option_flags |= NX_DHCPV6_INCLUDE_STATUS_NO_ADDR_AVAIL_OPTION;
}
else if(status_code == 3)
{
/* Yes, The message includes the NoBinding status option. */
dhcpv6_ptr -> nx_dhcpv6_reply_option_flags |= NX_DHCPV6_INCLUDE_STATUS_NO_BIND_OPTION;
}
else if(status_code == 4)
{
/* Yes, The message includes the NotOnLink status option. */
dhcpv6_ptr -> nx_dhcpv6_reply_option_flags |= NX_DHCPV6_INCLUDE_STATUS_NOT_ONLINK_OPTION;
}
else if(status_code == 5)
{
/* Yes, The message includes the UseMulticast status option. */
dhcpv6_ptr -> nx_dhcpv6_reply_option_flags |= NX_DHCPV6_INCLUDE_STATUS_USE_MULTICAST_OPTION;
}
else
{
/* This is an unsupported or unknown option. */
return NX_DHCPV6_UNKNOWN_OPTION;
}
}
else
{
/* This is an unsupported or unknown option. */
return NX_DHCPV6_UNKNOWN_OPTION;
}
/* Move to the next top level option. */
dhcpv6_iana_option_ptr += iana_option_length + 4;
/* Update the iana_index. */
iana_index += iana_option_length + 4;
}
break;
}
case NX_DHCPV6_OP_PREFERENCE:
{
/* The preference option length must be 1 byte. */
if (option_length != 1)
{
return(NX_DHCPV6_INCOMPLETE_OPTION_BLOCK);
}
/* Yes, The message includes the preference option. */
dhcpv6_ptr -> nx_dhcpv6_reply_option_flags |= NX_DHCPV6_INCLUDE_PREFERENCE_OPTION;
/* Record the preference option value of current advetise message. */
dhcpv6_ptr -> nx_dhcpv6_reply_option_current_pref_value = (USHORT)(*(dhcpv6_option_ptr + 4));
break;
}
case NX_DHCPV6_OP_STATUS_CODE:
{
/* The minimum length of status option is 2 bytes. */
if (option_length < 2)
{
return(NX_DHCPV6_INCOMPLETE_OPTION_BLOCK);
}
/* Yes, the message includes the STATUS option, get the code. */
memcpy(&status_code, (dhcpv6_option_ptr + 4), sizeof(USHORT)); /* Use case of memcpy is verified. */
/* Adjust for endianness. */
NX_CHANGE_USHORT_ENDIAN(status_code);
if(status_code == 0)
{
/* Yes, The message includes the Success status option. */
dhcpv6_ptr -> nx_dhcpv6_reply_option_flags |= NX_DHCPV6_INCLUDE_STATUS_SUCCESS_OPTION;
}
else if(status_code == 1)
{
/* Yes, The message includes the UnspecFail status option. */
dhcpv6_ptr -> nx_dhcpv6_reply_option_flags |= NX_DHCPV6_INCLUDE_STATUS_UNSPEC_FAIL_OPTION;
}
else if(status_code == 2)
{
/* Yes, The message includes the NoAddrsAvail status option. */
dhcpv6_ptr -> nx_dhcpv6_reply_option_flags |= NX_DHCPV6_INCLUDE_STATUS_NO_ADDR_AVAIL_OPTION;
}
else if(status_code == 3)
{
/* Yes, The message includes the NoBinding status option. */
dhcpv6_ptr -> nx_dhcpv6_reply_option_flags |= NX_DHCPV6_INCLUDE_STATUS_NO_BIND_OPTION;
}
else if(status_code == 4)
{
/* Yes, The message includes the NotOnLink status option. */
dhcpv6_ptr -> nx_dhcpv6_reply_option_flags |= NX_DHCPV6_INCLUDE_STATUS_NOT_ONLINK_OPTION;
}
else if(status_code == 5)
{
/* Yes, The message includes the UseMulticast status option. */
dhcpv6_ptr -> nx_dhcpv6_reply_option_flags |= NX_DHCPV6_INCLUDE_STATUS_USE_MULTICAST_OPTION;
}
else
{
/* This is an unsupported or unknown option. */
return NX_DHCPV6_UNKNOWN_OPTION;
}
break;
}
case NX_DHCPV6_OP_RAPID_COMMIT:
{
/* Yes, The message includes the Rapid Commit option. */
dhcpv6_ptr -> nx_dhcpv6_reply_option_flags |= NX_DHCPV6_INCLUDE_RAPID_COMMIT_OPTION;
break;
}
case NX_DHCPV6_OP_DNS_SERVER:
{
/* Yes, The message includes the DNS server option. */
dhcpv6_ptr -> nx_dhcpv6_reply_option_flags |= NX_DHCPV6_INCLUDE_DNS_SERVER_OPTION;
break;
}
case NX_DHCPV6_OP_DOMAIN_NAME:
{
/* Yes, The message includes the domain name option. */
dhcpv6_ptr -> nx_dhcpv6_reply_option_flags |= NX_DHCPV6_INCLUDE_DOMAIN_NAME_OPTION;
break;
}
case NX_DHCPV6_OP_SNTP_SERVER:
{
/* Yes, The message includes the timer server option. */
dhcpv6_ptr -> nx_dhcpv6_reply_option_flags |= NX_DHCPV6_INCLUDE_SNTP_SERVER_OPTION;
break;
}
case NX_DHCPV6_OP_CLIENT_FQDN:
{
/* Yes, The message includes the Client FQDN option. */
dhcpv6_ptr -> nx_dhcpv6_reply_option_flags |= NX_DHCPV6_INCLUDE_CLIENT_FQDN_OPTION;
break;
}
case NX_DHCPV6_OP_NEW_POSIX_TIMEZONE:
{
/* Yes, The message includes the time zone option. */
dhcpv6_ptr -> nx_dhcpv6_reply_option_flags |= NX_DHCPV6_INCLUDE_NEW_POSIX_TIIMEZONE_OPTION;
break;
}
default:
{
break;
}
}
/* Move to the next top level option. */
dhcpv6_option_ptr += option_length + 4;
/* Keep track of how far into the packet we have parsed. */
index += option_length + 4;
}
/* Yes, scan is complete, just return success. */
return NX_SUCCESS;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_preprocess_packet_information PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function preprocess packet information according to reply */
/* message option. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPv6 Client */
/* packet_ptr Pointer to received packet */
/* */
/* OUTPUT */
/* */
/* NX_DHCPv6_SUCCESS Successful completion status */
/* NX_DHCPV6_NO_DUID_OPTION Message has no DUID option */
/* NX_DHCPV6_NO_RAPID_COMMIT_OPTION Message has no rapid */
/* commit option */
/* NX_DHCPV6_IA_ADDRESS_NOT_VALID Message has no IA option */
/* NX_DHCPV6_EQUAL_OR_LESS_PREF_VALUE Preference value is equal to */
/* or less than */
/* NX_DHCPV6_UNKNOWN_MSG_TYPE Unknown message type */
/* */
/* CALLS */
/* */
/* _nx_dhcpv6_utility_get_data Get the data in reply message */
/* */
/* CALLED BY */
/* */
/* _nx_dhcpv6_packet_process Process the packet. */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_preprocess_packet_information(NX_DHCPV6 *dhcpv6_ptr, NX_PACKET *packet_ptr)
{
ULONG received_message_type;
ULONG returned_xid;
/* Preprocess the DHCPv6 packet. */
/* Extract the message type which should be the first byte. */
_nx_dhcpv6_utility_get_data(packet_ptr -> nx_packet_prepend_ptr, 1, &received_message_type);
/* Check for an illegal message type. */
if ((received_message_type != NX_DHCPV6_MESSAGE_TYPE_ADVERTISE) &&
(received_message_type != NX_DHCPV6_MESSAGE_TYPE_REPLY) &&
(received_message_type != NX_DHCPV6_MESSAGE_TYPE_RECONFIGURE))
{
/* These should only be sent to DHCPv6 servers! */
return NX_DHCPV6_ILLEGAL_MESSAGE_TYPE;
}
/* Set the received message type. */
dhcpv6_ptr -> nx_dhcpv6_received_message_type = (UCHAR)received_message_type;
/* This is a unicast packet (valid). Parse the transaction ID. */
_nx_dhcpv6_utility_get_data((packet_ptr -> nx_packet_prepend_ptr + 1), 3, &returned_xid);
/* Make sure the DHCP transaction ID matches our current session. */
if (returned_xid != (dhcpv6_ptr -> nx_dhcpv6_message_hdr.nx_message_xid))
{
/* Return the bad transmaction ID. */
return NX_DHCPV6_BAD_TRANSACTION_ID;
}
/* Check the options. */
switch (dhcpv6_ptr -> nx_dhcpv6_state)
{
/* The DHCPv6 remains initial status or DHCPv6 interactive process has been completed.
Just clear the timer and message ID. */
case NX_DHCPV6_STATE_BOUND_TO_ADDRESS:
case NX_DHCPV6_STATE_INIT:
{
/* In these state, DHCPv6 Client do not expect any packet. */
return NX_DHCPV6_ILLEGAL_MESSAGE_TYPE;
}
/* The DHCPv6 CLient has sent a solicit message and expect advertise message. */
case NX_DHCPV6_STATE_SENDING_SOLICIT:
{
/* DHCPv6 Client must discrd the received advertise messages
that meet the message does not inlcude SERVER ID or CLIENT ID. */
if(!(dhcpv6_ptr -> nx_dhcpv6_reply_option_flags & NX_DHCPV6_INCLUDE_CLIENT_ID_OPTION) ||
!(dhcpv6_ptr -> nx_dhcpv6_reply_option_flags & NX_DHCPV6_INCLUDE_SERVER_ID_OPTION))
{
/* The packet does not include DUID option.*/
return NX_DHCPV6_NO_DUID_OPTION;
}
/* DHcpv6 Client must ignore any advertise message that includes a status code option
containing the value NoAddrsAvail. */
if(dhcpv6_ptr -> nx_dhcpv6_reply_option_flags & NX_DHCPV6_INCLUDE_STATUS_NO_ADDR_AVAIL_OPTION)
{
return NX_DHCPV6_IA_ADDRESS_NOT_VALID;
}
if(dhcpv6_ptr -> nx_dhcpv6_request_solicit_mode == NX_DHCPV6_SOLICIT_RAPID)
{
if(!(dhcpv6_ptr -> nx_dhcpv6_reply_option_flags & NX_DHCPV6_INCLUDE_RAPID_COMMIT_OPTION))
{
return NX_DHCPV6_NO_RAPID_COMMIT_OPTION;
}
}
else
{
/* Check the preference value. */
if((dhcpv6_ptr -> nx_dhcpv6_preference.nx_pref_value != 0) &&
(dhcpv6_ptr -> nx_dhcpv6_reply_option_current_pref_value <= dhcpv6_ptr -> nx_dhcpv6_preference.nx_pref_value))
{
/* The current preference value is equal to or less than the recorded preference valude,
DHCPv6 Client need not process the message, return. */
return NX_DHCPV6_EQUAL_OR_LESS_PREF_VALUE;
}
}
break;
}
/* The DHCPv6 CLien has sent a request message and expect reply message. */
case NX_DHCPV6_STATE_SENDING_REQUEST:
case NX_DHCPV6_STATE_SENDING_RENEW:
case NX_DHCPV6_STATE_SENDING_REBIND:
case NX_DHCPV6_STATE_SENDING_CONFIRM:
case NX_DHCPV6_STATE_SENDING_RELEASE:
case NX_DHCPV6_STATE_SENDING_DECLINE:
case NX_DHCPV6_STATE_SENDING_INFORM_REQUEST:
{
/* DHCPv6 Client must discrd the received advertise messages
that meet the message does not inlcude SERVE ID or CLIENT ID. */
if(!(dhcpv6_ptr -> nx_dhcpv6_reply_option_flags & NX_DHCPV6_INCLUDE_CLIENT_ID_OPTION) ||
!(dhcpv6_ptr -> nx_dhcpv6_reply_option_flags & NX_DHCPV6_INCLUDE_SERVER_ID_OPTION))
{
/* The packet does not include DUID option.*/
return NX_DHCPV6_NO_DUID_OPTION;
}
break;
}
default:
{
/* Unknown or unsupported DHCPv6 request (state). */
return NX_DHCPV6_UNKNOWN_MSG_TYPE;
}
}
return NX_DHCPV6_SUCCESS;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_extract_packet_information PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function parses the DHCPv6 server response to Client requests. */
/* It checks for valid reply message types for the current Client */
/* request, and if all is well, then parses each option in sequential */
/* order and updates the server reply data to the Client record. At the*/
/* end of the data extraction, it then verifies that the server reply */
/* contained both valid Client and server DUID options. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPv6 Client */
/* packet_ptr Pointer to received packet */
/* */
/* OUTPUT */
/* */
/* status Actual completion status */
/* NX_SUCCESS Successful completion status */
/* NX_DHCPV6_ILLEGAL_MESSAGE_TYPE Packet message type illegal */
/* NX_DHCPV6_BAD_TRANSACTION_ID Message ID fails to match up */
/* NX_DHCPV6_PROCESSING_ERROR Packet length is different than */
/* expected */
/* NX_DHCPV6_UNKNOWN_OPTION Unknown option in message */
/* NX_DHCPV6_MISSING_IANA_OPTION Message has no IANA option */
/* */
/* CALLS */
/* */
/* _nx_dhcpv6_utility_get_block_option_length */
/* Extract option header data */
/* _nx_dhcpv6_process_client_duid Extract Client DUID from reply */
/* _nx_dhcpv6_process_server_duid Extract Server DUID from reply */
/* _nx_dhcpv6_process_iana Extract IANA option from reply */
/* _nx_dhcpv6_process_preference Extract server preference */
/* _nx_dhcpv6_process_DNS_server Extract DNS server from reply */
/* _nx_dhcpv6_process_time_server Extract time server from reply */
/* _nx_dhcpv6_process_time_zone Extract time zone from reply */
/* _nx_dhcpv6_process_domain_name Extract domain name from reply */
/* */
/* CALLED BY */
/* */
/* _nx_dhcpv6_packet_process Process the dhcpv6 reply message*/
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), improved */
/* packet length verification, */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_extract_packet_information(NX_DHCPV6 *dhcpv6_ptr, NX_PACKET *packet_ptr)
{
UINT status;
ULONG option_code;
ULONG option_length;
UCHAR *buffer_ptr;
UINT index;
/* The DHCPv6 header has been processed in preprocess function, so process the options. */
/* Set a pointer to the options of DHCPv6. */
buffer_ptr = packet_ptr -> nx_packet_prepend_ptr + 4;
/* Update index to the options. */
index = 4;
/* Now parse all the DHCPv6 option blocks in the packet buffer. */
while (index + 4 <= packet_ptr -> nx_packet_length)
{
/* Get the option code and length of data of the current option block. */
status = _nx_dhcpv6_utility_get_block_option_length(buffer_ptr, &option_code, &option_length);
/* Check that the block data is valid. */
if (status != NX_SUCCESS)
{
/* No, return the error status. */
return status;
}
/* Keep track of how far into the packet we have parsed. */
index += option_length + 4;
/* This is a double check to verify we haven't gone off the end of the packet buffer. */
if (index > packet_ptr -> nx_packet_length)
{
return(NX_DHCPV6_INVALID_DATA_SIZE);
}
/* Update buffer pointer to option data. */
buffer_ptr += 4;
/* Process the option code with an option specific API. */
switch (option_code)
{
/* Note - these 'process' functions will not move the buffer pointer. */
case NX_DHCPV6_OP_CLIENT_ID:
{
/* Process the Client DUID. */
status = _nx_dhcpv6_process_client_duid(dhcpv6_ptr, buffer_ptr, option_length);
break;
}
case NX_DHCPV6_OP_SERVER_ID:
{
/* Process the Server DUID. */
status = _nx_dhcpv6_process_server_duid(dhcpv6_ptr, buffer_ptr, option_length);
break;
}
case NX_DHCPV6_OP_IA_NA:
{
status = _nx_dhcpv6_process_iana(dhcpv6_ptr, buffer_ptr, option_length);
/* Note: this API directly handles any server error codes received. */
break;
}
/* This should not happen. The IA address option must be embedded in the IANA option. */
case NX_DHCPV6_OP_IA_ADDRESS:
{
/* Don't process an IA address option outside of an address association (IANA). */
status = NX_DHCPV6_MISSING_IANA_OPTION;
break;
}
/* The RFC for DHCPv6 indicates any option can have a status option applied to it. So a status
option outside of an IANA option (where it is usually found) has to be handled. */
case NX_DHCPV6_OP_STATUS_CODE:
{
status = _nx_dhcpv6_process_status(dhcpv6_ptr, buffer_ptr, option_length);
/* Now check on the server status of the previous option in the DHCP message. */
if ((status == NX_SUCCESS) && (dhcpv6_ptr -> nx_status_code != NX_DHCPV6_SUCCESS))
{
/* Does the dhcpv6 client have a server error handler? */
if (dhcpv6_ptr -> nx_dhcpv6_server_error_handler)
{
/* Send the status and which option the status is reported for to the handler. */
(dhcpv6_ptr -> nx_dhcpv6_server_error_handler)(dhcpv6_ptr, NX_DHCPV6_ERROR_STATUS_CODE_IN_OPTION_FIELD, dhcpv6_ptr -> nx_status_code,
dhcpv6_ptr -> nx_dhcpv6_received_message_type);
}
}
break;
}
/* Process the preference option. */
case NX_DHCPV6_OP_PREFERENCE:
{
status = _nx_dhcpv6_process_preference(dhcpv6_ptr, buffer_ptr, option_length);
break;
}
/* The remainder are RFC mandated option codes for specific options. Not all of these
have been finalized by IANA as of this release. */
case NX_DHCPV6_OP_DNS_SERVER:
{
status = _nx_dhcpv6_process_DNS_server(dhcpv6_ptr, buffer_ptr, option_length);
break;
}
case NX_DHCPV6_OP_DOMAIN_NAME:
{
status = _nx_dhcpv6_process_domain_name(dhcpv6_ptr, packet_ptr -> nx_packet_prepend_ptr, buffer_ptr, option_length);
break;
}
case NX_DHCPV6_OP_SNTP_SERVER:
{
status = _nx_dhcpv6_process_time_server(dhcpv6_ptr, buffer_ptr, option_length);
break;
}
case NX_DHCPV6_OP_NEW_POSIX_TIMEZONE:
{
status = _nx_dhcpv6_process_time_zone(dhcpv6_ptr, buffer_ptr, option_length);
break;
}
default:
{
break;
}
}
/* Check for errors from option block processing. */
if (status != NX_SUCCESS)
{
return status;
}
/* Move to the next top level option. */
buffer_ptr += option_length;
}
/* Now, the index should be the packet length. */
if(index != packet_ptr -> nx_packet_length)
{
return(NX_DHCPV6_INVALID_DATA_SIZE);
}
/* Yes, the packet data processing is completed. */
return NX_SUCCESS;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_flush_queue_packets PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function flush the useless queue packets. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPv6 Client */
/* */
/* OUTPUT */
/* */
/* None */
/* */
/* CALLS */
/* */
/* nx_udp_socket_receive Receive UDP packet */
/* nx_packet_release Release packet to packet pool */
/* */
/* CALLED BY */
/* */
/* _nx_dhcpv6_process Process the DHCPv6 Client request */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
VOID _nx_dhcpv6_flush_queue_packets(NX_DHCPV6 *dhcpv6_ptr)
{
UINT status = NX_SUCCESS;
NX_PACKET *packet_ptr;
/* Loop to receive the queue packets. */
while(status == NX_SUCCESS)
{
/* Receive the queue packets and release it. */
status = nx_udp_socket_receive(&(dhcpv6_ptr -> nx_dhcpv6_socket), &packet_ptr, NX_NO_WAIT);
/* Check the status. */
if (status == NX_SUCCESS)
{
/* Release the packet. */
nx_packet_release(packet_ptr);
}
}
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_update_retransmit_info PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function process the retransmission,update the retransmission */
/* count and retransmission timeout according to the RFC3315,Section14.*/
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPV6 Client instance */
/* */
/* OUTPUT */
/* */
/* status Actual completion status */
/* NX_SUCCESS Valid retransmit */
/* */
/* CALLS */
/* */
/* */
/* CALLED BY */
/* */
/* _nx_dhcpv6_process Process current client state */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_update_retransmit_info(NX_DHCPV6 *dhcpv6_ptr)
{
/* Process the retransmission according to the RFC3315, Section 14, page26. */
if((dhcpv6_ptr -> nx_dhcpv6_max_retransmission_count != 0) || (dhcpv6_ptr -> nx_dhcpv6_max_retransmission_duration != 0))
{
if((dhcpv6_ptr -> nx_dhcpv6_max_retransmission_count != 0) &&
(dhcpv6_ptr -> nx_dhcpv6_retransmission_count >= dhcpv6_ptr -> nx_dhcpv6_max_retransmission_count))
{
/* Has reached the max retransmission count, return. */
return NX_DHCPV6_REACHED_MAX_RETRANSMISSION_COUNT;
}
if((dhcpv6_ptr -> nx_dhcpv6_max_retransmission_duration != 0) &&
(dhcpv6_ptr -> nx_dhcpv6_elapsed_time.nx_session_time >= (dhcpv6_ptr -> nx_dhcpv6_max_retransmission_duration * 100)))
{
/* Has reached the max retransmission timeout, return. */
return NX_DHCPV6_REACHED_MAX_RETRANSMISSION_TIMEOUT;
}
}
/* Increase the count of retransmission. */
dhcpv6_ptr -> nx_dhcpv6_retransmission_count++;
/* Double the retransmission timeout for the next retransmit. */
dhcpv6_ptr -> nx_dhcpv6_transmission_timeout = 2 * dhcpv6_ptr -> nx_dhcpv6_transmission_timeout;
/* Is the retransmission timeout greater than the max allowable timeout, if there is one? */
if ((dhcpv6_ptr -> nx_dhcpv6_max_retransmission_timeout != 0) &&
(dhcpv6_ptr -> nx_dhcpv6_transmission_timeout > dhcpv6_ptr -> nx_dhcpv6_max_retransmission_timeout))
{
/* Limit the transmission time to the max for the next message. */
dhcpv6_ptr -> nx_dhcpv6_transmission_timeout = dhcpv6_ptr -> nx_dhcpv6_max_retransmission_timeout;
}
/* Can retransmit the request. */
return NX_SUCCESS;
}
#if !defined (NX_DISABLE_IPV6_DAD) && defined (NX_ENABLE_IPV6_ADDRESS_CHANGE_NOTIFY)
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_ipv6_address_DAD_notify PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function is the IPv6 address perform DAD notify callback. */
/* And set the DHCPv6 event to notify DHCPv6 Client thread. If this */
/* function is used in DHCPv6 function, nxd_ipv6_address_change_notify */
/* function should not be used again. */
/* */
/* INPUT */
/* */
/* ip_ptr Pointer to IP instance */
/* status DAD process status */
/* interface_index The interface index */
/* ipv6_addr_index The IPv6 address index */
/* ipv6_address Pointer to IPv6 address */
/* */
/* OUTPUT */
/* */
/* None */
/* */
/* CALLS */
/* */
/* tx_event_flags_set Set event flags to wake */
/* DHCPv6 thread to process */
/* */
/* CALLED BY */
/* */
/* UDP receive callback */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
VOID _nx_dhcpv6_ipv6_address_DAD_notify(NX_IP *ip_ptr, UINT status, UINT interface_index, UINT ipv6_addr_index, ULONG *ipv6_address)
{
UINT ia_index;
NX_PARAMETER_NOT_USED(interface_index);
/* Make sure the DHCPv6 DAD instance is normal. */
if((_nx_dhcpv6_DAD_ptr -> nx_dhcpv6_id != NX_DHCPV6_ID) ||
(!_nx_dhcpv6_DAD_ptr -> nx_dhcpv6_name) ||
(_nx_dhcpv6_DAD_ptr -> nx_dhcpv6_ip_ptr != ip_ptr) ||
(_nx_dhcpv6_DAD_ptr -> nx_dhcpv6_state != NX_DHCPV6_STATE_BOUND_TO_ADDRESS))
return;
/* Check the DAD status. */
if(status == NX_IPV6_ADDRESS_DAD_FAILURE)
{
/* Now find where this address cross references in the DHCP address list. */
for(ia_index = 0; ia_index < NX_DHCPV6_MAX_IA_ADDRESS; ia_index++)
{
if((_nx_dhcpv6_DAD_ptr -> nx_dhcpv6_client_address_index[ia_index] == ipv6_addr_index) &&
(!memcmp(&(_nx_dhcpv6_DAD_ptr -> nx_dhcpv6_ia[ia_index].nx_global_address.nxd_ip_address.v6[0]), ipv6_address, 16)))
{
/* Set the IPv6 address status DAD failure. */
_nx_dhcpv6_DAD_ptr -> nx_dhcpv6_ia[ia_index].nx_address_status = NX_DHCPV6_IA_ADDRESS_STATE_DAD_FAILURE;
/* Wakeup DHCPv6 thread for processing DAD failure event. */
tx_event_flags_set(&_nx_dhcpv6_DAD_ptr -> nx_dhcpv6_events, NX_DHCPV6_DAD_FAILURE_EVENT, TX_OR);
break;
}
}
}
/* Check the DAD status. */
if(status == NX_IPV6_ADDRESS_DAD_SUCCESSFUL)
{
for(ia_index = 0; ia_index < NX_DHCPV6_MAX_IA_ADDRESS; ia_index++)
{
if((_nx_dhcpv6_DAD_ptr -> nx_dhcpv6_client_address_index[ia_index] == ipv6_addr_index) &&
(!memcmp(&(_nx_dhcpv6_DAD_ptr -> nx_dhcpv6_ia[ia_index].nx_global_address.nxd_ip_address.v6[0]), ipv6_address, 16)))
{
/* Set the IPv6 address status valid. */
_nx_dhcpv6_DAD_ptr -> nx_dhcpv6_ia[ia_index].nx_address_status = NX_DHCPV6_IA_ADDRESS_STATE_VALID;
break;
}
}
}
return;
}
#endif
#ifdef NX_DHCPV6_CLIENT_RESTORE_STATE
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nxe_dhcpv6_client_get_record PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function performs error checking on the get DHCPv6 Client */
/* record service. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPv6 instance */
/* client_record_ptr Pointer to memory to save */
/* Client record to */
/* */
/* OUTPUT */
/* */
/* NX_PTR_ERROR Invalid pointer input */
/* status Completion status from */
/* internal DHCP calls */
/* */
/* CALLS */
/* */
/* _nx_dhcpv6_client_create_record */
/* */
/* CALLED BY */
/* */
/* Application code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nxe_dhcpv6_client_get_record(NX_DHCPV6 *dhcpv6_ptr, NX_DHCPV6_CLIENT_RECORD *client_record_ptr)
{
UINT status;
/* Check for invalid pointer input. */
if ((dhcpv6_ptr == NX_NULL) || (client_record_ptr == NX_NULL))
{
return NX_PTR_ERROR;
}
/* Call actual DHCPv6 client get record service. */
status = _nx_dhcpv6_client_get_record(dhcpv6_ptr, client_record_ptr);
return status;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_client_get_record PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function creates a DHCPv6 Client record for restoring the */
/* Client state between power cycles or idle (sleep) mode. It then */
/* copies the Client record to the supplied client record pointer. It */
/* should be that the DHCPv6 Client state be restored from the Client */
/* record saved to the input pointer client_record_ptr. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPv6 instance */
/* client_record_ptr Pointer to memory to save */
/* Client record to */
/* */
/* OUTPUT */
/* */
/* NX_SUCCESS Successful completion status */
/* NX_DHCPV6_NOT_BOUND DHCPv6 was not bound */
/* */
/* CALLS */
/* */
/* memcpy Copy specified area of memory */
/* */
/* CALLED BY */
/* */
/* Application code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), and */
/* verified memcpy use cases, */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_client_get_record(NX_DHCPV6 *dhcpv6_ptr, NX_DHCPV6_CLIENT_RECORD *client_record_ptr)
{
/* Get the DHCP mutex. */
tx_mutex_get(&(dhcpv6_ptr -> nx_dhcpv6_client_mutex), NX_DHCPV6_MUTEX_WAIT);
/* Clear memory before filling with data. */
memset(client_record_ptr, 0, sizeof(NX_DHCPV6_CLIENT_RECORD));
/* The DHCPv6 Client is not Bound to an IP address. Cannot create a record for restoring Client
state if not bound to an IP lease. */
if (dhcpv6_ptr -> nx_dhcpv6_state != NX_DHCPV6_STATE_BOUND_TO_ADDRESS)
{
return NX_DHCPV6_NOT_BOUND;
}
/* Set the DHCPv6 record. */
client_record_ptr -> nx_dhcpv6_state = dhcpv6_ptr -> nx_dhcpv6_state;
/* Set the interface and address index. */
client_record_ptr -> nx_dhcpv6_client_interface_index = dhcpv6_ptr -> nx_dhcpv6_client_interface_index;
memcpy(client_record_ptr -> nx_dhcpv6_client_address_index, dhcpv6_ptr -> nx_dhcpv6_client_address_index, sizeof(UINT) * NX_DHCPV6_MAX_IA_ADDRESS); /* Use case of memcpy is verified. */
/* Set the time since client set its IP address. */
client_record_ptr -> nx_dhcpv6_IP_lifetime_time_accrued = dhcpv6_ptr -> nx_dhcpv6_IP_lifetime_time_accrued;
/* Set the Client DUID. */
memcpy(&client_record_ptr -> nx_dhcpv6_client_duid, &dhcpv6_ptr -> nx_dhcpv6_client_duid, sizeof(NX_DHCPV6_DUID)); /* Use case of memcpy is verified. */
/* Set the Server DUID. */
memcpy(&client_record_ptr -> nx_dhcpv6_server_duid, &dhcpv6_ptr -> nx_dhcpv6_server_duid, sizeof(NX_DHCPV6_DUID)); /* Use case of memcpy is verified. */
/* Set the IANA. */
memcpy(&client_record_ptr -> nx_dhcpv6_iana, &dhcpv6_ptr -> nx_dhcpv6_iana, sizeof(NX_DHCPV6_IA_NA)); /* Use case of memcpy is verified. */
/* Set the IA Address. */
memcpy(&client_record_ptr -> nx_dhcpv6_ia, &dhcpv6_ptr -> nx_dhcpv6_ia, sizeof(NX_DHCPV6_IA_ADDRESS) * NX_DHCPV6_MAX_IA_ADDRESS); /* Use case of memcpy is verified. */
/* Set the Option request. */
memcpy(&client_record_ptr -> nx_dhcpv6_option_request, &dhcpv6_ptr -> nx_dhcpv6_option_request, sizeof(NX_DHCPV6_OPTIONREQUEST)); /* Use case of memcpy is verified. */
/* Set the Client FQDN. */
memcpy(&client_record_ptr -> nx_dhcpv6_client_FQDN, &dhcpv6_ptr -> nx_dhcpv6_client_FQDN, sizeof(NX_DHCPV6_CLIENT_FQDN)); /* Use case of memcpy is verified. */
/* Set the dns name server address. */
memcpy(&client_record_ptr -> nx_dhcpv6_DNS_name_server_address, &dhcpv6_ptr -> nx_dhcpv6_DNS_name_server_address, sizeof(NXD_ADDRESS) * NX_DHCPV6_NUM_DNS_SERVERS); /* Use case of memcpy is verified. */
/* Set the time server address. */
memcpy(&client_record_ptr -> nx_dhcpv6_time_server_address, &dhcpv6_ptr -> nx_dhcpv6_time_server_address, sizeof(NXD_ADDRESS) * NX_DHCPV6_NUM_TIME_SERVERS); /* Use case of memcpy is verified. */
/* Set the domain name. */
memcpy(client_record_ptr -> nx_dhcpv6_domain_name, dhcpv6_ptr -> nx_dhcpv6_domain_name, NX_DHCPV6_DOMAIN_NAME_BUFFER_SIZE); /* Use case of memcpy is verified. */
/* Set the time zone. */
memcpy(client_record_ptr -> nx_dhcpv6_time_zone, dhcpv6_ptr -> nx_dhcpv6_time_zone, NX_DHCPV6_TIME_ZONE_BUFFER_SIZE); /* Use case of memcpy is verified. */
/* Release the DHCPv6 Client mutex. */
tx_mutex_put(&(dhcpv6_ptr -> nx_dhcpv6_client_mutex));
return NX_SUCCESS;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nxe_dhcpv6_client_restore_record PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function performs error checking on the client restore service.*/
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPv6 instance */
/* client_record_ptr Pointer to previously saved */
/* Client record */
/* time_elapsed time input in timer ticks */
/* */
/* OUTPUT */
/* */
/* NX_PTR_ERRPR Invalid pointer input */
/* status NetX completion status */
/* */
/* CALLS */
/* */
/* _nx_dhcp_client_restore_record */
/* */
/* CALLED BY */
/* */
/* Application code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nxe_dhcpv6_client_restore_record(NX_DHCPV6 *dhcpv6_ptr, NX_DHCPV6_CLIENT_RECORD *client_record_ptr, ULONG time_elapsed)
{
UINT status;
/* Check for invalid pointer input. */
if ((dhcpv6_ptr == NX_NULL) || (client_record_ptr == NX_NULL))
{
return NX_PTR_ERROR;
}
/* Call actual DHCPv6 client get record service. */
status = _nx_dhcpv6_client_restore_record(dhcpv6_ptr, client_record_ptr, time_elapsed);
return status;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_dhcpv6_client_restore_record PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function updates the DHCPv6 CLient state with the supplied DHCP*/
/* Client record pointed to by the client_record_ptr pointer. It then */
/* updates the time out parameters of the DHCPv6 Client with the */
/* time_elapsed parameter (in timer ticks). It is intended for */
/* restoring Client state between reboots and assumes the DHCPv6 Client*/
/* state was previously obtained and stored in NVRAM before power down.*/
/* */
/* Note: after restore the DHCPv6 Client record, should call */
/* nx_dhcpv6_resume to update the DHCPv6 Client state and resume the */
/* DHCPv6 processing thread. */
/* */
/* INPUT */
/* */
/* dhcpv6_ptr Pointer to DHCPv6 instance */
/* client_record_ptr Pointer to previously saved */
/* Client record */
/* time_elapsed time input in timer ticks */
/* */
/* OUTPUT */
/* */
/* NX_SUCCESS Successful completion status */
/* status NetX completion status */
/* */
/* CALLS */
/* */
/* nx_ip_interface_address_set */
/* nx_ip_address_set */
/* _nx_dhcp_client_update_time_remaining */
/* memcpy */
/* */
/* CALLED BY */
/* */
/* Application code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), and */
/* verified memcpy use cases, */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_dhcpv6_client_restore_record(NX_DHCPV6 *dhcpv6_ptr, NX_DHCPV6_CLIENT_RECORD *client_record_ptr, ULONG time_elapsed)
{
UINT ia_index;
/* Get the DHCP mutex. */
tx_mutex_get(&(dhcpv6_ptr -> nx_dhcpv6_client_mutex), NX_DHCPV6_MUTEX_WAIT);
/* Set the DHCPv6 record. */
dhcpv6_ptr -> nx_dhcpv6_state = client_record_ptr -> nx_dhcpv6_state;
/* Set the interface and address index. */
dhcpv6_ptr -> nx_dhcpv6_client_interface_index = client_record_ptr -> nx_dhcpv6_client_interface_index;
memcpy(dhcpv6_ptr -> nx_dhcpv6_client_address_index, client_record_ptr -> nx_dhcpv6_client_address_index, sizeof(UINT) * NX_DHCPV6_MAX_IA_ADDRESS); /* Use case of memcpy is verified. */
/* Set the Client DUID. */
memcpy(&dhcpv6_ptr -> nx_dhcpv6_client_duid, &client_record_ptr -> nx_dhcpv6_client_duid, sizeof(NX_DHCPV6_DUID)); /* Use case of memcpy is verified. */
/* Set the Server DUID. */
memcpy(&dhcpv6_ptr -> nx_dhcpv6_server_duid, &client_record_ptr -> nx_dhcpv6_server_duid, sizeof(NX_DHCPV6_DUID)); /* Use case of memcpy is verified. */
/* Set the IANA. */
memcpy(&dhcpv6_ptr -> nx_dhcpv6_iana, &client_record_ptr -> nx_dhcpv6_iana, sizeof(NX_DHCPV6_IA_NA)); /* Use case of memcpy is verified. */
/* Set the IA Address. */
memcpy(&dhcpv6_ptr -> nx_dhcpv6_ia, &client_record_ptr -> nx_dhcpv6_ia, sizeof(NX_DHCPV6_IA_ADDRESS) * NX_DHCPV6_MAX_IA_ADDRESS); /* Use case of memcpy is verified. */
/* Set the Option request. */
memcpy(&dhcpv6_ptr -> nx_dhcpv6_option_request, &client_record_ptr -> nx_dhcpv6_option_request, sizeof(NX_DHCPV6_OPTIONREQUEST)); /* Use case of memcpy is verified. */
/* Set the Client FQDN. */
memcpy(&dhcpv6_ptr -> nx_dhcpv6_client_FQDN, &client_record_ptr -> nx_dhcpv6_client_FQDN, sizeof(NX_DHCPV6_CLIENT_FQDN)); /* Use case of memcpy is verified. */
/* Set the dns name server address. */
memcpy(&dhcpv6_ptr -> nx_dhcpv6_DNS_name_server_address, &client_record_ptr -> nx_dhcpv6_DNS_name_server_address, sizeof(NXD_ADDRESS) * NX_DHCPV6_NUM_DNS_SERVERS); /* Use case of memcpy is verified. */
/* Set the time server address. */
memcpy(&dhcpv6_ptr -> nx_dhcpv6_time_server_address, &client_record_ptr -> nx_dhcpv6_time_server_address, sizeof(NXD_ADDRESS) * NX_DHCPV6_NUM_TIME_SERVERS); /* Use case of memcpy is verified. */
/* Set the domain name. */
memcpy(dhcpv6_ptr -> nx_dhcpv6_domain_name, client_record_ptr -> nx_dhcpv6_domain_name, NX_DHCPV6_DOMAIN_NAME_BUFFER_SIZE); /* Use case of memcpy is verified. */
/* Set the time zone. */
memcpy(dhcpv6_ptr -> nx_dhcpv6_time_zone, client_record_ptr -> nx_dhcpv6_time_zone, NX_DHCPV6_TIME_ZONE_BUFFER_SIZE); /* Use case of memcpy is verified. */
/* Set the time since client set its IP address. */
dhcpv6_ptr -> nx_dhcpv6_IP_lifetime_time_accrued = (client_record_ptr -> nx_dhcpv6_IP_lifetime_time_accrued + time_elapsed);
/* Set the DHCPv6 Client IPv6 addresses. */
for(ia_index = 0; ia_index < NX_DHCPV6_MAX_IA_ADDRESS; ia_index++)
{
if(dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_address_status == NX_DHCPV6_IA_ADDRESS_STATE_VALID)
{
/* Add the address to the IP instance address table. */
nxd_ipv6_address_set(dhcpv6_ptr -> nx_dhcpv6_ip_ptr, dhcpv6_ptr -> nx_dhcpv6_client_interface_index,
&dhcpv6_ptr -> nx_dhcpv6_ia[ia_index].nx_global_address, 64, &dhcpv6_ptr -> nx_dhcpv6_client_address_index[ia_index]);
}
}
/* Release the DHCPv6 Client mutex. */
tx_mutex_put(&(dhcpv6_ptr -> nx_dhcpv6_client_mutex));
return NX_SUCCESS;
}
#endif /* NX_DHCPV6_CLIENT_RESTORE_STATE */
#endif /* FEATURE_NX_IPV6 */
Details ![]()
Show: from Types: Columns: ![]( "Show Project Names")
![]( "Show Locations")
![]( "Show Referring Symbols")
![]( "Show Scope")
This file uses the notable symbols shown below. Click anywhere in the file to view more details.