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
|
/*
* Copyright (c) 2015-2016 Cisco and/or its affiliates.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/** \file
This file defines vpe control-plane API messages which are generally
called through a shared memory interface.
*/
/*
* Note: API placement cleanup in progress
* If you're looking for interface APIs, please
* see .../vnet/vnet/{interface.api,interface_api.c}
* IP APIs: see .../vnet/vnet/ip/{ip.api, ip_api.c}
* TAP APIs: see .../vnet/vnet/unix/{tap.api, tap_api.c}
*/
/** \brief Create a new subinterface with the given vlan id
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param sw_if_index - software index of the new vlan's parent interface
@param vlan_id - vlan tag of the new interface
*/
define create_vlan_subif
{
u32 client_index;
u32 context;
u32 sw_if_index;
u32 vlan_id;
};
/** \brief Reply for the vlan subinterface create request
@param context - returned sender context, to match reply w/ request
@param retval - return code
@param sw_if_index - software index allocated for the new subinterface
*/
define create_vlan_subif_reply
{
u32 context;
i32 retval;
u32 sw_if_index;
};
/** \brief Enable or Disable MPLS on and interface
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param sw_if_index - index of the interface
@param enable - if non-zero enable, else disable
*/
define sw_interface_set_mpls_enable
{
u32 client_index;
u32 context;
u32 sw_if_index;
u8 enable;
};
/** \brief Reply for MPLS state on an interface
@param context - returned sender context, to match reply w/ request
@param retval - return code
*/
define sw_interface_set_mpls_enable_reply
{
u32 context;
i32 retval;
};
/** \brief MPLS Route Add / del route
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param mr_label - The MPLS label value
@param mr_eos - The End of stack bit
@param mr_table_id - The MPLS table-id the route is added in
@param mr_classify_table_index - If this is a classify route,
this is the classify table index
@param mr_create_table_if_needed - If the MPLS or IP tables do not exist,
create them
@param mr_is_add - Is this a route add or delete
@param mr_is_classify - Is this route result a classify
@param mr_is_multipath - Is this route update a multipath - i.e. is this
a path addition to an existing route
@param mr_is_resolve_host - Recurse resolution constraint via a host prefix
@param mr_is_resolve_attached - Recurse resolution constraint via attached prefix
@param mr_next_hop_proto_is_ip4 - The next-hop is IPV4
@param mr_next_hop_weight - The weight, for UCMP
@param mr_next_hop[16] - the nextop address
@param mr_next_hop_sw_if_index - the next-hop SW interface
@param mr_next_hop_table_id - the next-hop table-id (if appropriate)
@param mr_next_hop_n_out_labels - the number of labels in the label stack
@param mr_next_hop_out_label_stack - the next-hop output label stack, outer most first
@param next_hop_via_label - The next-hop is a resolved via a local label
*/
define mpls_route_add_del
{
u32 client_index;
u32 context;
u32 mr_label;
u8 mr_eos;
u32 mr_table_id;
u32 mr_classify_table_index;
u8 mr_create_table_if_needed;
u8 mr_is_add;
u8 mr_is_classify;
u8 mr_is_multipath;
u8 mr_is_resolve_host;
u8 mr_is_resolve_attached;
u8 mr_next_hop_proto_is_ip4;
u8 mr_next_hop_weight;
u8 mr_next_hop[16];
u8 mr_next_hop_n_out_labels;
u32 mr_next_hop_sw_if_index;
u32 mr_next_hop_table_id;
u32 mr_next_hop_via_label;
u32 mr_next_hop_out_label_stack[mr_next_hop_n_out_labels];
};
/** \brief Reply for MPLS route add / del request
@param context - returned sender context, to match reply w/ request
@param retval - return code
*/
define mpls_route_add_del_reply
{
u32 context;
i32 retval;
};
/** \brief Dump MPLS fib table
@param client_index - opaque cookie to identify the sender
*/
define mpls_fib_dump
{
u32 client_index;
u32 context;
};
/** \brief FIB path
@param sw_if_index - index of the interface
@param weight - The weight, for UCMP
@param is_local - local if non-zero, else remote
@param is_drop - Drop the packet
@param is_unreach - Drop the packet and rate limit send ICMP unreachable
@param is_prohibit - Drop the packet and rate limit send ICMP prohibited
@param afi - the afi of the next hop, IP46_TYPE_IP4=1, IP46_TYPE_IP6=2
@param next_hop[16] - the next hop address
WARNING: this type is replicated, pending cleanup completion
*/
typeonly manual_print manual_endian define fib_path2
{
u32 sw_if_index;
u32 weight;
u8 is_local;
u8 is_drop;
u8 is_unreach;
u8 is_prohibit;
u8 afi;
u8 next_hop[16];
};
/** \brief mpls FIB table response
@param table_id - MPLS fib table id
@param s_bit - End-of-stack bit
@param label - MPLS label value
@param count - the number of fib_path in path
@param path - array of of fib_path structures
*/
manual_endian manual_print define mpls_fib_details
{
u32 context;
u32 table_id;
u8 eos_bit;
u32 label;
u32 count;
vl_api_fib_path2_t path[count];
};
/** \brief Bind/Unbind an MPLS local label to an IP prefix. i.e. create
a per-prefix label entry.
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param mb_mpls_table_id - The MPLS table-id the MPLS entry will be added in
@param mb_label - The MPLS label value to bind
@param mb_ip_table_id - The IP table-id of the IP prefix to bind to.
@param mb_create_table_if_needed - Create either/both tables if required.
@param mb_is_bind - Bind or unbind
@param mb_is_ip4 - The prefix to bind to is IPv4
@param mb_address_length - Length of IP prefix
@param mb_address[16] - IP prefix/
*/
define mpls_ip_bind_unbind
{
u32 client_index;
u32 context;
u32 mb_mpls_table_id;
u32 mb_label;
u32 mb_ip_table_id;
u8 mb_create_table_if_needed;
u8 mb_is_bind;
u8 mb_is_ip4;
u8 mb_address_length;
u8 mb_address[16];
};
/** \brief Reply for MPLS IP bind/unbind request
@param context - returned sender context, to match reply w/ request
@param retval - return code
*/
define mpls_ip_bind_unbind_reply
{
u32 context;
i32 retval;
};
/** \brief MPLS tunnel Add / del route
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param mt_is_add - Is this a route add or delete
@param mt_sw_if_index - The SW interface index of the tunnel to delete
@param mt_next_hop_proto_is_ip4 - The next-hop is IPV4
@param mt_next_hop_weight - The weight, for UCMP
@param mt_next_hop[16] - the nextop address
@param mt_next_hop_sw_if_index - the next-hop SW interface
@param mt_next_hop_table_id - the next-hop table-id (if appropriate)
@param mt_next_hop_n_out_labels - the number of next-hop output labels
@param mt_next_hop_out_label_stack - the next-hop output label stack, outer most first
*/
define mpls_tunnel_add_del
{
u32 client_index;
u32 context;
u32 mt_sw_if_index;
u8 mt_is_add;
u8 mt_l2_only;
u8 mt_next_hop_proto_is_ip4;
u8 mt_next_hop_weight;
u8 mt_next_hop[16];
u8 mt_next_hop_n_out_labels;
u32 mt_next_hop_sw_if_index;
u32 mt_next_hop_table_id;
u32 mt_next_hop_out_label_stack[mt_next_hop_n_out_labels];
};
/** \brief Reply for MPLS tunnel add / del request
@param context - returned sender context, to match reply w/ request
@param retval - return code
@param sw_if_index - SW interface index of the tunnel created
*/
define mpls_tunnel_add_del_reply
{
u32 context;
i32 retval;
u32 sw_if_index;
};
/** \brief Dump mpls eth tunnel table
@param client_index - opaque cookie to identify the sender
@param tunnel_index - eth tunnel identifier or -1 in case of all tunnels
*/
define mpls_tunnel_dump
{
u32 client_index;
u32 context;
i32 tunnel_index;
};
/** \brief mpls eth tunnel operational state response
@param tunnel_index - eth tunnel identifier
@param intfc_address - interface ipv4 addr
@param mask_width - interface ipv4 addr mask
@param hw_if_index - interface id
@param l2_only -
@param tunnel_dst_mac -
@param tx_sw_if_index -
@param encap_index - reference to mpls label table
@param nlabels - number of resolved labels
@param labels - resolved labels
*/
define mpls_tunnel_details
{
u32 context;
u32 tunnel_index;
u8 mt_l2_only;
u8 mt_sw_if_index;
u8 mt_next_hop_proto_is_ip4;
u8 mt_next_hop[16];
u32 mt_next_hop_sw_if_index;
u32 mt_next_hop_table_id;
u32 mt_next_hop_n_labels;
u32 mt_next_hop_out_labels[mt_next_hop_n_labels];
};
/** \brief Proxy ARP add / del request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param vrf_id - VRF / Fib table ID
@param is_add - 1 if adding the Proxy ARP range, 0 if deleting
@param low_address[4] - Low address of the Proxy ARP range
@param hi_address[4] - High address of the Proxy ARP range
*/
define proxy_arp_add_del
{
u32 client_index;
u32 context;
u32 vrf_id;
u8 is_add;
u8 low_address[4];
u8 hi_address[4];
};
/** \brief Reply for proxy arp add / del request
@param context - returned sender context, to match reply w/ request
@param retval - return code
*/
define proxy_arp_add_del_reply
{
u32 context;
i32 retval;
};
/** \brief Proxy ARP add / del request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param sw_if_index - Which interface to enable / disable Proxy Arp on
@param enable_disable - 1 to enable Proxy ARP on interface, 0 to disable
*/
define proxy_arp_intfc_enable_disable
{
u32 client_index;
u32 context;
u32 sw_if_index;
/* 1 = on, 0 = off */
u8 enable_disable;
};
/** \brief Reply for Proxy ARP interface enable / disable request
@param context - returned sender context, to match reply w/ request
@param retval - return code
*/
define proxy_arp_intfc_enable_disable_reply
{
u32 context;
i32 retval;
};
/** \brief Reset VRF (remove all routes etc) request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
@param vrf_id - ID of th FIB table / VRF to reset
*/
define reset_vrf
{
u32 client_index;
u32 context;
u8 is_ipv6;
u32 vrf_id;
};
/** \brief Reply for Reset VRF request
@param context - returned sender context, to match reply w/ request
@param retval - return code
*/
define reset_vrf_reply
{
u32 context;
i32 retval;
};
/** \brief Is Address Reachable request - DISABLED
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param next_hop_sw_if_index - index of interface used to get to next hop
@param is_ipv6 - 1 for IPv6, 0 for IPv4
@param is_error - address not found or does not match intf
@param address[] - Address in question
*/
define is_address_reachable
{
u32 client_index; /* (api_main_t *) am->my_client_index */
u32 context;
u32 next_hop_sw_if_index;
u8 is_known; /* on reply, this is the answer */
u8 is_ipv6;
u8 is_error; /* address not found or does not match intf */
u8 address[16];
};
/** \brief Want Stats, register for stats updates
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param enable_disable - 1 = enable stats, 0 = disable
@param pid - pid of process requesting stats updates
*/
define want_stats
{
u32 client_index;
u32 context;
u32 enable_disable;
u32 pid;
};
/** \brief Reply for Want Stats request
@param context - returned sender context, to match reply w/ request
@param retval - return code
*/
define want_stats_reply
{
u32 context;
i32 retval;
};
typeonly manual_print manual_endian define ip4_fib_counter
{
u32 address;
u8 address_length;
u64 packets;
u64 bytes;
};
manual_print manual_endian define vnet_ip4_fib_counters
{
u32 vrf_id;
u32 count;
vl_api_ip4_fib_counter_t c[count];
};
typeonly manual_print manual_endian define ip6_fib_counter
{
u64 address[2];
u8 address_length;
u64 packets;
u64 bytes;
};
manual_print manual_endian define vnet_ip6_fib_counters
{
u32 vrf_id;
u32 count;
vl_api_ip6_fib_counter_t c[count];
};
/** \brief Request for a single block of summary stats
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
*/
define vnet_get_summary_stats
{
u32 client_index;
u32 context;
};
/** \brief Reply for vnet_get_summary_stats request
@param context - sender context, to match reply w/ request
@param retval - return code for request
@param total_pkts -
@param total_bytes -
@param vector_rate -
*/
define vnet_summary_stats_reply
{
u32 context;
i32 retval;
u64 total_pkts[2];
u64 total_bytes[2];
f64 vector_rate;
};
/** \brief OAM event structure
@param dst_address[] -
@param state
*/
define oam_event
{
u8 dst_address[4];
u8 state;
};
/** \brief Want OAM events request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param enable_disable- enable if non-zero, else disable
@param pid - pid of the requesting process
*/
define want_oam_events
{
u32 client_index;
u32 context;
u32 enable_disable;
u32 pid;
};
/** \brief Want OAM events response
@param context - sender context, to match reply w/ request
@param retval - return code for the want oam stats request
*/
define want_oam_events_reply
{
u32 context;
i32 retval;
};
/** \brief OAM add / del target request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param vrf_id - vrf_id of the target
@param src_address[] - source address to use for the updates
@param dst_address[] - destination address of the target
@param is_add - add target if non-zero, else delete
*/
define oam_add_del
{
u32 client_index;
u32 context;
u32 vrf_id;
u8 src_address[4];
u8 dst_address[4];
u8 is_add;
};
/** \brief OAM add / del target response
@param context - sender context, to match reply w/ request
@param retval - return code of the request
*/
define oam_add_del_reply
{
u32 context;
i32 retval;
};
/** \brief Reset fib table request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param vrf_id - vrf/table id of the fib table to reset
@param is_ipv6 - an ipv6 fib to reset if non-zero, else ipv4
*/
define reset_fib
{
u32 client_index;
u32 context;
u32 vrf_id;
u8 is_ipv6;
};
/** \brief Reset fib response
@param context - sender context, to match reply w/ request
@param retval - return code for the reset bfib request
*/
define reset_fib_reply
{
u32 context;
i32 retval;
};
/** \brief DHCP Proxy config add / del request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param vrf_id - vrf id
@param if_ipv6 - ipv6 if non-zero, else ipv4
@param is_add - add the config if non-zero, else delete
@param insert_circuit_id - option82 suboption 1 fib number
@param dhcp_server[] - server address
@param dhcp_src_address[] - <fix this, need details>
*/
define dhcp_proxy_config
{
u32 client_index;
u32 context;
u32 vrf_id;
u8 is_ipv6;
u8 is_add;
u8 insert_circuit_id;
u8 dhcp_server[16];
u8 dhcp_src_address[16];
};
/** \brief DHCP Proxy config response
@param context - sender context, to match reply w/ request
@param retval - return code for the request
*/
define dhcp_proxy_config_reply
{
u32 context;
i32 retval;
};
/** \brief DHCP Proxy set / unset vss request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param tbl_id - table id
@param oui - first part of vpn id
@param fib_id - second part of vpn id
@param is_ipv6 - ip6 if non-zero, else ip4
@param is_add - set vss if non-zero, else delete
*/
define dhcp_proxy_set_vss
{
u32 client_index;
u32 context;
u32 tbl_id;
u32 oui;
u32 fib_id;
u8 is_ipv6;
u8 is_add;
};
/** \brief DHCP proxy set / unset vss response
@param context - sender context, to match reply w/ request
@param retval - return code for the request
*/
define dhcp_proxy_set_vss_reply
{
u32 context;
i32 retval;
};
/** \brief Create loopback interface request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param mac_address - mac addr to assign to the interface if none-zero
*/
define create_loopback
{
u32 client_index;
u32 context;
u8 mac_address[6];
};
/** \brief Create loopback interface response
@param context - sender context, to match reply w/ request
@param sw_if_index - sw index of the interface that was created
@param retval - return code for the request
*/
define create_loopback_reply
{
u32 context;
i32 retval;
u32 sw_if_index;
};
/** \brief Delete loopback interface request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param sw_if_index - sw index of the interface that was created
*/
define delete_loopback
{
u32 client_index;
u32 context;
u32 sw_if_index;
};
/** \brief Delete loopback interface response
@param context - sender context, to match reply w/ request
@param retval - return code for the request
*/
define delete_loopback_reply
{
u32 context;
i32 retval;
};
/** \brief Control ping from client to api server request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
*/
define control_ping
{
u32 client_index;
u32 context;
};
/** \brief Control ping from the client to the server response
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param retval - return code for the request
@param vpe_pid - the pid of the vpe, returned by the server
*/
define control_ping_reply
{
u32 context;
i32 retval;
u32 client_index;
u32 vpe_pid;
};
/** \brief Process a vpe parser cli string request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param cmd_in_shmem - pointer to cli command string
*/
define cli_request
{
u32 client_index;
u32 context;
u64 cmd_in_shmem;
};
define cli_inband
{
u32 client_index;
u32 context;
u32 length;
u8 cmd[length];
};
/** \brief vpe parser cli string response
@param context - sender context, to match reply w/ request
@param retval - return code for request
@param reply_in_shmem - Reply string from cli processing if any
*/
define cli_reply
{
u32 context;
i32 retval;
u64 reply_in_shmem;
};
define cli_inband_reply
{
u32 context;
i32 retval;
u32 length;
u8 reply[length];
};
/** \brief Set max allowed ARP or ip6 neighbor entries request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param is_ipv6 - neighbor limit if non-zero, else ARP limit
@param arp_neighbor_limit - the new limit, defaults are ~ 50k
*/
define set_arp_neighbor_limit
{
u32 client_index;
u32 context;
u8 is_ipv6;
u32 arp_neighbor_limit;
};
/** \brief Set max allowed ARP or ip6 neighbor entries response
@param context - sender context, to match reply w/ request
@param retval - return code for request
*/
define set_arp_neighbor_limit_reply
{
u32 context;
i32 retval;
};
/** \brief L2 interface patch add / del request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param rx_sw_if_index - receive side interface
@param tx_sw_if_index - transmit side interface
@param is_add - if non-zero set up the interface patch, else remove it
*/
define l2_patch_add_del
{
u32 client_index;
u32 context;
u32 rx_sw_if_index;
u32 tx_sw_if_index;
u8 is_add;
};
/** \brief L2 interface patch add / del response
@param context - sender context, to match reply w/ request
@param retval - return code for the request
*/
define l2_patch_add_del_reply
{
u32 context;
i32 retval;
};
/** \brief IPv6 segment routing tunnel add / del request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param is_add - add the tunnel if non-zero, else delete it
@param name[] - tunnel name (len. 64)
@param src_address[] -
@param dst_address[] -
@param dst_mask_width -
@param inner_vrf_id -
@param outer_vrf_id -
@param flags_net_byte_order -
@param n_segments -
@param n_tags -
@param segs_and_tags[] -
@param policy_name[] - name of policy to associate this tunnel to (len. 64)
*/
define sr_tunnel_add_del
{
u32 client_index;
u32 context;
u8 is_add;
u8 name[64];
u8 src_address[16];
u8 dst_address[16];
u8 dst_mask_width;
u32 inner_vrf_id;
u32 outer_vrf_id;
u16 flags_net_byte_order;
u8 n_segments;
u8 n_tags;
u8 policy_name[64];
u8 segs_and_tags[0];
};
/** \brief IPv6 segment routing tunnel add / del response
@param context - sender context, to match reply w/ request
@param retval - return value for request
*/
define sr_tunnel_add_del_reply
{
u32 context;
i32 retval;
};
/** \brief IPv6 segment routing policy add / del request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param is_add - add the tunnel if non-zero, else delete it
@param name[] - policy name (len. 64)
@param tunnel_names[] -
*/
define sr_policy_add_del
{
u32 client_index;
u32 context;
u8 is_add;
u8 name[64];
u8 tunnel_names[0];
};
/** \brief IPv6 segment routing policy add / del response
@param context - sender context, to match reply w/ request
@param retval - return value for request
*/
define sr_policy_add_del_reply
{
u32 context;
i32 retval;
};
/** \brief IPv6 segment routing multicast map to policy add / del request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param is_add - add the tunnel if non-zero, else delete it
@param multicast_address[] - IP6 multicast address
@param policy_name[] = policy name (len.64)
*/
define sr_multicast_map_add_del
{
u32 client_index;
u32 context;
u8 is_add;
u8 multicast_address[16];
u8 policy_name[64];
};
/** \brief IPv6 segment routing multicast map to policy add / del response
@param context - sender context, to match reply w/ request
@param retval - return value for request
*/
define sr_multicast_map_add_del_reply
{
u32 context;
i32 retval;
};
/** \brief Interface set vpath request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param sw_if_index - interface used to reach neighbor
@param enable - if non-zero enable, else disable
*/
define sw_interface_set_vpath
{
u32 client_index;
u32 context;
u32 sw_if_index;
u8 enable;
};
/** \brief Interface set vpath response
@param context - sender context, to match reply w/ request
@param retval - return code for the request
*/
define sw_interface_set_vpath_reply
{
u32 context;
i32 retval;
};
/** \brief Interface set vxlan-bypass request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param sw_if_index - interface used to reach neighbor
@param is_ipv6 - if non-zero, enable ipv6-vxlan-bypass, else ipv4-vxlan-bypass
@param enable - if non-zero enable, else disable
*/
define sw_interface_set_vxlan_bypass
{
u32 client_index;
u32 context;
u32 sw_if_index;
u8 is_ipv6;
u8 enable;
};
/** \brief Interface set vxlan-bypass response
@param context - sender context, to match reply w/ request
@param retval - return code for the request
*/
define sw_interface_set_vxlan_bypass_reply
{
u32 context;
i32 retval;
};
/** \brief Set L2 XConnect between two interfaces request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param rx_sw_if_index - Receive interface index
@param tx_sw_if_index - Transmit interface index
@param enable - enable xconnect if not 0, else set to L3 mode
*/
define sw_interface_set_l2_xconnect
{
u32 client_index;
u32 context;
u32 rx_sw_if_index;
u32 tx_sw_if_index;
u8 enable;
};
/** \brief Set L2 XConnect response
@param context - sender context, to match reply w/ request
@param retval - L2 XConnect request return code
*/
define sw_interface_set_l2_xconnect_reply
{
u32 context;
i32 retval;
};
/** \brief Interface bridge mode request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param rx_sw_if_index - the interface
@param bd_id - bridge domain id
@param bvi - Setup interface as a bvi, bridge mode only
@param shg - Shared horizon group, for bridge mode only
@param enable - Enable beige mode if not 0, else set to L3 mode
*/
define sw_interface_set_l2_bridge
{
u32 client_index;
u32 context;
u32 rx_sw_if_index;
u32 bd_id;
u8 shg;
u8 bvi;
u8 enable;
};
/** \brief Interface bridge mode response
@param context - sender context, to match reply w/ request
@param retval - Bridge mode request return code
*/
define sw_interface_set_l2_bridge_reply
{
u32 context;
i32 retval;
};
/** \brief L2 FIB add entry request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param mac - the entry's mac address
@param bd_id - the entry's bridge domain id
@param sw_if_index - the interface
@param is_add - If non zero add the entry, else delete it
@param static_mac -
@param filter_mac -
*/
define l2fib_add_del
{
u32 client_index;
u32 context;
u64 mac;
u32 bd_id;
u32 sw_if_index;
u8 is_add;
u8 static_mac;
u8 filter_mac;
u8 bvi_mac;
};
/** \brief L2 FIB add entry response
@param context - sender context, to match reply w/ request
@param retval - return code for the add l2fib entry request
*/
define l2fib_add_del_reply
{
u32 context;
i32 retval;
};
/** \brief Set L2 flags request !!! TODO - need more info, feature bits in l2_input.h
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param sw_if_index - interface
@param is_set - if non-zero, set the bits, else clear them
@param feature_bitmap - non-zero bits to set or clear
*/
define l2_flags
{
u32 client_index;
u32 context;
u32 sw_if_index;
u8 is_set;
u32 feature_bitmap;
};
/** \brief Set L2 bits response
@param context - sender context, to match reply w/ request
@param retval - return code for the set l2 bits request
*/
define l2_flags_reply
{
u32 context;
i32 retval;
u32 resulting_feature_bitmap;
};
/** \brief Set bridge flags (such as L2_LEARN, L2_FWD, L2_FLOOD,
L2_UU_FLOOD, or L2_ARP_TERM) request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param bd_id - the bridge domain to set the flags for
@param is_set - if non-zero, set the flags, else clear them
@param feature_bitmap - bits that are non-zero to set or clear
*/
define bridge_flags
{
u32 client_index;
u32 context;
u32 bd_id;
u8 is_set;
u32 feature_bitmap;
};
/** \brief Set bridge flags response
@param context - sender context, to match reply w/ request
@param retval - return code for the set bridge flags request
@param resulting_feature_bitmap - the feature bitmap value after the request is implemented
*/
define bridge_flags_reply
{
u32 context;
i32 retval;
u32 resulting_feature_bitmap;
};
/** \brief Set bridge domain ip to mac entry request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param bd_id - the bridge domain to set the flags for
@param is_add - if non-zero, add the entry, else clear it
@param is_ipv6 - if non-zero, ipv6 address, else ipv4 address
@param mac_address - MAC address
@param
*/
define bd_ip_mac_add_del
{
u32 client_index;
u32 context;
u32 bd_id;
u8 is_add;
u8 is_ipv6;
u8 ip_address[16];
u8 mac_address[6];
};
/** \brief Set bridge domain ip to mac entry response
@param context - sender context, to match reply w/ request
@param retval - return code for the set bridge flags request
*/
define bd_ip_mac_add_del_reply
{
u32 context;
i32 retval;
};
/** \brief Add/Delete classification table request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param is_add- if non-zero add the table, else delete it
@param del_chain - if non-zero delete the whole chain of tables
@param table_index - if add, reuturns index of the created table, else specifies the table to delete
@param nbuckets - number of buckets when adding a table
@param memory_size - memory size when adding a table
@param match_n_vectors - number of match vectors
@param next_table_index - index of next table
@param miss_next_index - index of miss table
@param current_data_flag - option to use current node's packet payload
as the starting point from where packets are classified,
This option is only valid for L2/L3 input ACL for now.
0: by default, classify data from the buffer's start location
1: classify packets from VPP node’s current data pointer
@param current_data_offset - a signed value to shift the start location of
the packet to be classified
For example, if input IP ACL node is used, L2 header’s first byte
can be accessible by configuring current_data_offset to -14
if there is no vlan tag.
This is valid only if current_data_flag is set to 1.
@param mask[] - match mask
*/
define classify_add_del_table
{
u32 client_index;
u32 context;
u8 is_add;
u8 del_chain;
u32 table_index;
u32 nbuckets;
u32 memory_size;
u32 skip_n_vectors;
u32 match_n_vectors;
u32 next_table_index;
u32 miss_next_index;
u32 current_data_flag;
i32 current_data_offset;
u8 mask[0];
};
/** \brief Add/Delete classification table response
@param context - sender context, to match reply w/ request
@param retval - return code for the table add/del requst
@param new_table_index - for add, returned index of the new table
@param skip_n_vectors - for add, returned value of skip_n_vectors in table
@param match_n_vectors -for add, returned value of match_n_vectors in table
*/
define classify_add_del_table_reply
{
u32 context;
i32 retval;
u32 new_table_index;
u32 skip_n_vectors;
u32 match_n_vectors;
};
/** \brief Classify add / del session request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param is_add - add session if non-zero, else delete
@param table_index - index of the table to add/del the session, required
@param hit_next_index - for add, hit_next_index of new session, required
@param opaque_index - for add, opaque_index of new session
@param advance -for add, advance value for session
@param action -
0: no action (by default)
metadata is not used.
1: Classified IP packets will be looked up from the
specified ipv4 fib table (configured by metadata as VRF id).
Only valid for L3 input ACL node
2: Classified IP packets will be looked up from the
specified ipv6 fib table (configured by metadata as VRF id).
Only valid for L3 input ACL node
@param metadata - valid only if action != 0
VRF id if action is 1 or 2.
@param match[] - for add, match value for session, required
*/
define classify_add_del_session
{
u32 client_index;
u32 context;
u8 is_add;
u32 table_index;
u32 hit_next_index;
u32 opaque_index;
i32 advance;
u8 action;
u32 metadata;
u8 match[0];
};
/** \brief Classify add / del session response
@param context - sender context, to match reply w/ request
@param retval - return code for the add/del session request
*/
define classify_add_del_session_reply
{
u32 context;
i32 retval;
};
/** \brief Set/unset the classification table for an interface request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param is_ipv6 - ipv6 if non-zero, else ipv4
@param sw_if_index - interface to associate with the table
@param table_index - index of the table, if ~0 unset the table
*/
define classify_set_interface_ip_table
{
u32 client_index;
u32 context;
u8 is_ipv6;
u32 sw_if_index;
u32 table_index; /* ~0 => off */
};
/** \brief Set/unset interface classification table response
@param context - sender context, to match reply w/ request
@param retval - return code
*/
define classify_set_interface_ip_table_reply
{
u32 context;
i32 retval;
};
/** \brief Set/unset l2 classification tables for an interface request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param sw_if_index - interface to set/unset tables for
@param ip4_table_index - ip4 index, use ~0 for all 3 indexes to unset
@param ip6_table_index - ip6 index
@param other_table_index - other index
*/
define classify_set_interface_l2_tables
{
u32 client_index;
u32 context;
u32 sw_if_index;
/* 3 x ~0 => off */
u32 ip4_table_index;
u32 ip6_table_index;
u32 other_table_index;
u8 is_input;
};
/** \brief Set/unset l2 classification tables for an interface response
@param context - sender context, to match reply w/ request
@param retval - return code for the request
*/
define classify_set_interface_l2_tables_reply
{
u32 context;
i32 retval;
};
/** \brief Get node index using name request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param node_name[] - name of the node
*/
define get_node_index
{
u32 client_index;
u32 context;
u8 node_name[64];
};
/** \brief Get node index using name request
@param context - sender context, to match reply w/ request
@param retval - return code for the request
@param node_index - index of the desired node if found, else ~0
*/
define get_node_index_reply
{
u32 context;
i32 retval;
u32 node_index;
};
/** \brief Set the next node for a given node request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param node_name[] - node to add the next node to
@param next_name[] - node to add as the next node
*/
define add_node_next
{
u32 client_index;
u32 context;
u8 node_name[64];
u8 next_name[64];
};
/** \brief IP Set the next node for a given node response
@param context - sender context, to match reply w/ request
@param retval - return code for the add next node request
@param next_index - the index of the next node if success, else ~0
*/
define add_node_next_reply
{
u32 context;
i32 retval;
u32 next_index;
};
/** \brief DHCP Proxy config 2 add / del request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param rx_vrf_id - receive vrf id
@param server_vrf_id - server vrf id
@param if_ipv6 - ipv6 if non-zero, else ipv4
@param is_add - add the config if non-zero, else delete
@param insert_circuit_id - option82 suboption 1 fib number
@param dhcp_server[] - server address
@param dhcp_src_address[] - <fix this, need details>
*/
define dhcp_proxy_config_2
{
u32 client_index;
u32 context;
u32 rx_vrf_id;
u32 server_vrf_id;
u8 is_ipv6;
u8 is_add;
u8 insert_circuit_id;
u8 dhcp_server[16];
u8 dhcp_src_address[16];
};
/** \brief DHCP Proxy config 2 add / del response
@param context - sender context, to match reply w/ request
@param retval - return code for request
*/
define dhcp_proxy_config_2_reply
{
u32 context;
i32 retval;
};
/** \brief l2tpv3 tunnel interface create request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param client_address - remote client tunnel ip address
@param client_address - local tunnel ip address
@param is_ipv6 - ipv6 if non-zero, else ipv4
@param local_session_id - local tunnel session id
@param remote_session_id - remote tunnel session id
@param local_cookie - local tunnel cookie
@param l2_sublayer_present - l2 sublayer is present in packets if non-zero
@param encap_vrf_id - fib identifier used for outgoing encapsulated packets
*/
define l2tpv3_create_tunnel
{
u32 client_index;
u32 context;
u8 client_address[16];
u8 our_address[16];
u8 is_ipv6;
u32 local_session_id;
u32 remote_session_id;
u64 local_cookie;
u64 remote_cookie;
u8 l2_sublayer_present;
u32 encap_vrf_id;
};
/** \brief l2tpv3 tunnel interface create response
@param context - sender context, to match reply w/ request
@param retval - return code for the request
@param sw_if_index - index of the new tunnel interface
*/
define l2tpv3_create_tunnel_reply
{
u32 context;
i32 retval;
u32 sw_if_index;
};
define l2tpv3_set_tunnel_cookies
{
u32 client_index;
u32 context;
u32 sw_if_index;
u64 new_local_cookie;
u64 new_remote_cookie;
};
/** \brief L2TP tunnel set cookies response
@param context - sender context, to match reply w/ request
@param retval - return code for the request
*/
define l2tpv3_set_tunnel_cookies_reply
{
u32 context;
i32 retval;
};
define sw_if_l2tpv3_tunnel_details
{
u32 context;
u32 sw_if_index;
u8 interface_name[64];
u8 client_address[16];
u8 our_address[16];
u32 local_session_id;
u32 remote_session_id;
u64 local_cookie[2];
u64 remote_cookie;
u8 l2_sublayer_present;
};
define sw_if_l2tpv3_tunnel_dump
{
u32 client_index;
u32 context;
};
/** \brief L2 fib clear table request, clear all mac entries in the l2 fib
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
*/
define l2_fib_clear_table
{
u32 client_index;
u32 context;
};
/** \brief L2 fib clear table response
@param context - sender context, to match reply w/ request
@param retval - return code for the request
*/
define l2_fib_clear_table_reply
{
u32 context;
i32 retval;
};
/** \brief L2 interface ethernet flow point filtering enable/disable request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param sw_if_index - interface to enable/disable filtering on
@param enable_disable - if non-zero enable filtering, else disable
*/
define l2_interface_efp_filter
{
u32 client_index;
u32 context;
u32 sw_if_index;
u32 enable_disable;
};
/** \brief L2 interface ethernet flow point filtering response
@param context - sender context, to match reply w/ request
@param retval - return code for the request
*/
define l2_interface_efp_filter_reply
{
u32 context;
i32 retval;
};
define l2tpv3_interface_enable_disable
{
u32 client_index;
u32 context;
u8 enable_disable;
u32 sw_if_index;
};
define l2tpv3_interface_enable_disable_reply
{
u32 context;
i32 retval;
};
define l2tpv3_set_lookup_key
{
u32 client_index;
u32 context;
/* 0 = ip6 src_address, 1 = ip6 dst_address, 2 = session_id */
u8 key;
};
define l2tpv3_set_lookup_key_reply
{
u32 context;
i32 retval;
};
define vxlan_add_del_tunnel
{
u32 client_index;
u32 context;
u8 is_add;
u8 is_ipv6;
u8 src_address[16];
u8 dst_address[16];
u32 mcast_sw_if_index;
u32 encap_vrf_id;
u32 decap_next_index;
u32 vni;
};
define vxlan_add_del_tunnel_reply
{
u32 context;
i32 retval;
u32 sw_if_index;
};
define vxlan_tunnel_dump
{
u32 client_index;
u32 context;
u32 sw_if_index;
};
define vxlan_tunnel_details
{
u32 context;
u32 sw_if_index;
u8 src_address[16];
u8 dst_address[16];
u32 mcast_sw_if_index;
u32 encap_vrf_id;
u32 decap_next_index;
u32 vni;
u8 is_ipv6;
};
define gre_add_del_tunnel
{
u32 client_index;
u32 context;
u8 is_add;
u8 is_ipv6;
u8 teb;
u8 src_address[16];
u8 dst_address[16];
u32 outer_fib_id;
};
define gre_add_del_tunnel_reply
{
u32 context;
i32 retval;
u32 sw_if_index;
};
define gre_tunnel_dump
{
u32 client_index;
u32 context;
u32 sw_if_index;
};
define gre_tunnel_details
{
u32 context;
u32 sw_if_index;
u8 is_ipv6;
u8 teb;
u8 src_address[16];
u8 dst_address[16];
u32 outer_fib_id;
};
/** \brief L2 interface vlan tag rewrite configure request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param sw_if_index - interface the operation is applied to
@param vtr_op - Choose from l2_vtr_op_t enum values
@param push_dot1q - first pushed flag dot1q id set, else dot1ad
@param tag1 - Needed for any push or translate vtr op
@param tag2 - Needed for any push 2 or translate x-2 vtr ops
*/
define l2_interface_vlan_tag_rewrite
{
u32 client_index;
u32 context;
u32 sw_if_index;
u32 vtr_op;
u32 push_dot1q; // ethertype of first pushed tag is dot1q/dot1ad
u32 tag1; // first pushed tag
u32 tag2; // second pushed tag
};
/** \brief L2 interface vlan tag rewrite response
@param context - sender context, to match reply w/ request
@param retval - return code for the request
*/
define l2_interface_vlan_tag_rewrite_reply
{
u32 context;
i32 retval;
};
/** \brief vhost-user interface create request
@param client_index - opaque cookie to identify the sender
@param is_server - our side is socket server
@param sock_filename - unix socket filename, used to speak with frontend
@param use_custom_mac - enable or disable the use of the provided hardware address
@param mac_address - hardware address to use if 'use_custom_mac' is set
*/
define create_vhost_user_if
{
u32 client_index;
u32 context;
u8 is_server;
u8 sock_filename[256];
u8 renumber;
u32 custom_dev_instance;
u8 use_custom_mac;
u8 mac_address[6];
u8 tag[64];
};
/** \brief vhost-user interface create response
@param context - sender context, to match reply w/ request
@param retval - return code for the request
@param sw_if_index - interface the operation is applied to
*/
define create_vhost_user_if_reply
{
u32 context;
i32 retval;
u32 sw_if_index;
};
/** \brief vhost-user interface modify request
@param client_index - opaque cookie to identify the sender
@param is_server - our side is socket server
@param sock_filename - unix socket filename, used to speak with frontend
*/
define modify_vhost_user_if
{
u32 client_index;
u32 context;
u32 sw_if_index;
u8 is_server;
u8 sock_filename[256];
u8 renumber;
u32 custom_dev_instance;
};
/** \brief vhost-user interface modify response
@param context - sender context, to match reply w/ request
@param retval - return code for the request
*/
define modify_vhost_user_if_reply
{
u32 context;
i32 retval;
};
/** \brief vhost-user interface delete request
@param client_index - opaque cookie to identify the sender
*/
define delete_vhost_user_if
{
u32 client_index;
u32 context;
u32 sw_if_index;
};
/** \brief vhost-user interface delete response
@param context - sender context, to match reply w/ request
@param retval - return code for the request
*/
define delete_vhost_user_if_reply
{
u32 context;
i32 retval;
};
define create_subif
{
u32 client_index;
u32 context;
u32 sw_if_index;
u32 sub_id;
/* These fields map directly onto the subif template */
u8 no_tags;
u8 one_tag;
u8 two_tags;
u8 dot1ad; // 0 = dot1q, 1=dot1ad
u8 exact_match;
u8 default_sub;
u8 outer_vlan_id_any;
u8 inner_vlan_id_any;
u16 outer_vlan_id;
u16 inner_vlan_id;
};
define create_subif_reply
{
u32 context;
i32 retval;
u32 sw_if_index;
};
/** \brief show version
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
*/
define show_version
{
u32 client_index;
u32 context;
};
/** \brief show version response
@param context - sender context, to match reply w/ request
@param retval - return code for the request
@param program - name of the program (vpe)
@param version - version of the program
@param build_directory - root of the workspace where the program was built
*/
define show_version_reply
{
u32 context;
i32 retval;
u8 program[32];
u8 version[32];
u8 build_date[32];
u8 build_directory[256];
};
/** \brief Vhost-user interface details structure (fix this)
@param sw_if_index - index of the interface
@param interface_name - name of interface
@param virtio_net_hdr_sz - net header size
@param features - interface features
@param is_server - vhost-user server socket
@param sock_filename - socket filename
@param num_regions - number of used memory regions
*/
define sw_interface_vhost_user_details
{
u32 context;
u32 sw_if_index;
u8 interface_name[64];
u32 virtio_net_hdr_sz;
u64 features;
u8 is_server;
u8 sock_filename[256];
u32 num_regions;
i32 sock_errno;
};
/* works */
define sw_interface_vhost_user_dump
{
u32 client_index;
u32 context;
};
/** \brief l2 fib table entry structure
@param bd_id - the l2 fib / bridge domain table id
@param mac - the entry's mac address
@param sw_if_index - index of the interface
@param static_mac - the entry is statically configured.
@param filter_mac - the entry is a mac filter entry.
@param bvi_mac - the mac address is a bridge virtual interface
*/
define l2_fib_table_entry
{
u32 context;
u32 bd_id;
u64 mac;
u32 sw_if_index;
u8 static_mac;
u8 filter_mac;
u8 bvi_mac;
};
/** \brief Dump l2 fib (aka bridge domain) table
@param client_index - opaque cookie to identify the sender
@param bd_id - the l2 fib / bridge domain table identifier
*/
define l2_fib_table_dump
{
u32 client_index;
u32 context;
u32 bd_id;
};
define vxlan_gpe_add_del_tunnel
{
u32 client_index;
u32 context;
u8 is_ipv6;
u8 local[16];
u8 remote[16];
u32 encap_vrf_id;
u32 decap_vrf_id;
u8 protocol;
u32 vni;
u8 is_add;
};
define vxlan_gpe_add_del_tunnel_reply
{
u32 context;
i32 retval;
u32 sw_if_index;
};
define vxlan_gpe_tunnel_dump
{
u32 client_index;
u32 context;
u32 sw_if_index;
};
define vxlan_gpe_tunnel_details
{
u32 context;
u32 sw_if_index;
u8 local[16];
u8 remote[16];
u32 vni;
u8 protocol;
u32 encap_vrf_id;
u32 decap_vrf_id;
u8 is_ipv6;
};
/** \brief add or delete locator_set
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param is_add - add address if non-zero, else delete
@param locator_set_name - locator name
@param locator_num - number of locators
@param locators - LISP locator records
Structure of one locator record is as follows:
define locator_t {
u32 sw_if_index;
u8 priority;
u8 weight;
}
*/
define lisp_add_del_locator_set
{
u32 client_index;
u32 context;
u8 is_add;
u8 locator_set_name[64];
u32 locator_num;
u8 locators[0];
};
/** \brief Reply for locator_set add/del
@param context - returned sender context, to match reply w/ request
@param retval - return code
@param ls_index - locator set index
*/
define lisp_add_del_locator_set_reply
{
u32 context;
i32 retval;
u32 ls_index;
};
/** \brief add or delete locator for locator_set
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param is_add - add address if non-zero, else delete
@param locator_set_name - name of locator_set to add/del locator
@param sw_if_index - index of the interface
@param priority - priority of the lisp locator
@param weight - weight of the lisp locator
*/
define lisp_add_del_locator
{
u32 client_index;
u32 context;
u8 is_add;
u8 locator_set_name[64];
u32 sw_if_index;
u8 priority;
u8 weight;
};
/** \brief Reply for locator add/del
@param context - returned sender context, to match reply w/ request
@param retval - return code
*/
define lisp_add_del_locator_reply
{
u32 context;
i32 retval;
};
/** \brief add or delete lisp eid-table
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param is_add - add address if non-zero, else delete
@param eid_type:
0 : ipv4
1 : ipv6
2 : mac
@param eid - EID can be ip4, ip6 or mac
@param prefix_len - prefix len
@param locator_set_name - name of locator_set to add/del eid-table
@param vni - virtual network instance
@param key_id
HMAC_NO_KEY 0
HMAC_SHA_1_96 1
HMAC_SHA_256_128 2
@param key - secret key
*/
define lisp_add_del_local_eid
{
u32 client_index;
u32 context;
u8 is_add;
u8 eid_type;
u8 eid[16];
u8 prefix_len;
u8 locator_set_name[64];
u32 vni;
u16 key_id;
u8 key[64];
};
/** \brief Reply for local_eid add/del
@param context - returned sender context, to match reply w/ request
@param retval - return code
*/
define lisp_add_del_local_eid_reply
{
u32 context;
i32 retval;
};
/** \brief add or delete lisp gpe tunnel
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param is_add - add address if non-zero, else delete
@param eid_type -
0 : ipv4
1 : ipv6
2 : mac
@param rmt_eid - remote eid
@param lcl_eid - local eid
@param rmt_len - remote prefix len
@param lcl_len - local prefix len
@param vni - virtual network identifier
@param dp_table - vrf/bridge domain id
@param loc_num - number of locators
@param lcl_locs - array of local locators
@param rmt_locs - array of remote locators
@param action - negative action when 0 locators configured
*/
define lisp_gpe_add_del_fwd_entry
{
u32 client_index;
u32 context;
u8 is_add;
u8 eid_type;
u8 rmt_eid[16];
u8 lcl_eid[16];
u8 rmt_len;
u8 lcl_len;
u32 vni;
u32 dp_table;
u32 loc_num;
u8 lcl_locs[loc_num];
u8 rmt_locs[loc_num];
u8 action;
};
/** \brief Reply for gpe_fwd_entry add/del
@param context - returned sender context, to match reply w/ request
@param retval - return code
*/
define lisp_gpe_add_del_fwd_entry_reply
{
u32 context;
i32 retval;
};
/** \brief Add/delete map server
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param is_add - add address if non-zero; delete otherwise
@param is_ipv6 - if non-zero the address is ipv6, else ipv4
@param ip_address - map server IP address
*/
define lisp_add_del_map_server
{
u32 client_index;
u32 context;
u8 is_add;
u8 is_ipv6;
u8 ip_address[16];
};
/** \brief Reply for lisp_add_del_map_server
@param context - returned sender context, to match reply w/ request
@param retval - return code
*/
define lisp_add_del_map_server_reply
{
u32 context;
i32 retval;
};
/** \brief add or delete map-resolver
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param is_add - add address if non-zero, else delete
@param is_ipv6 - if non-zero the address is ipv6, else ipv4
@param ip_address - array of address bytes
*/
define lisp_add_del_map_resolver
{
u32 client_index;
u32 context;
u8 is_add;
u8 is_ipv6;
u8 ip_address[16];
};
/** \brief Reply for map_resolver add/del
@param context - returned sender context, to match reply w/ request
@param retval - return code
*/
define lisp_add_del_map_resolver_reply
{
u32 context;
i32 retval;
};
/** \brief enable or disable lisp-gpe protocol
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param is_en - enable protocol if non-zero, else disable
*/
define lisp_gpe_enable_disable
{
u32 client_index;
u32 context;
u8 is_en;
};
/** \brief Reply for gpe enable/disable
@param context - returned sender context, to match reply w/ request
@param retval - return code
*/
define lisp_gpe_enable_disable_reply
{
u32 context;
i32 retval;
};
/** \brief enable or disable LISP feature
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param is_en - enable protocol if non-zero, else disable
*/
define lisp_enable_disable
{
u32 client_index;
u32 context;
u8 is_en;
};
/** \brief Reply for gpe enable/disable
@param context - returned sender context, to match reply w/ request
@param retval - return code
*/
define lisp_enable_disable_reply
{
u32 context;
i32 retval;
};
/** \brief add or delete gpe_iface
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param is_add - add address if non-zero, else delete
*/
define lisp_gpe_add_del_iface
{
u32 client_index;
u32 context;
u8 is_add;
u8 is_l2;
u32 dp_table;
u32 vni;
};
/** \brief Reply for gpe_iface add/del
@param context - returned sender context, to match reply w/ request
@param retval - return code
*/
define lisp_gpe_add_del_iface_reply
{
u32 context;
i32 retval;
};
/** \brief configure or disable LISP PITR node
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param ls_name - locator set name
@param is_add - add locator set if non-zero, else disable pitr
*/
define lisp_pitr_set_locator_set
{
u32 client_index;
u32 context;
u8 is_add;
u8 ls_name[64];
};
/** \brief Reply for lisp_pitr_set_locator_set
@param context - returned sender context, to match reply w/ request
@param retval - return code
*/
define lisp_pitr_set_locator_set_reply
{
u32 context;
i32 retval;
};
/** \brief Get state of LISP RLOC probing
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
*/
define show_lisp_rloc_probe_state
{
u32 client_index;
u32 context;
};
/** \brief Reply for show_lisp_rloc_probe_state
@param context - returned sender context, to match reply w/ request
@param retval - return code
@param is_enabled - state of RLOC probing
*/
define show_lisp_rloc_probe_state_reply
{
u32 context;
i32 retval;
u8 is_enabled;
};
/** \brief enable/disable LISP RLOC probing
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param is_enable - enable if non-zero; disable otherwise
*/
define lisp_rloc_probe_enable_disable
{
u32 client_index;
u32 context;
u8 is_enabled;
};
/** \brief Reply for lisp_rloc_probe_enable_disable
@param context - returned sender context, to match reply w/ request
@param retval - return code
*/
define lisp_rloc_probe_enable_disable_reply
{
u32 context;
i32 retval;
};
/** \brief enable/disable LISP map-register
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param is_enable - enable if non-zero; disable otherwise
*/
define lisp_map_register_enable_disable
{
u32 client_index;
u32 context;
u8 is_enabled;
};
/** \brief Reply for lisp_map_register_enable_disable
@param context - returned sender context, to match reply w/ request
@param retval - return code
*/
define lisp_map_register_enable_disable_reply
{
u32 context;
i32 retval;
};
/** \brief Get state of LISP map-register
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
*/
define show_lisp_map_register_state
{
u32 client_index;
u32 context;
};
/** \brief Reply for show_lisp_map_register_state
@param context - returned sender context, to match reply w/ request
@param retval - return code
*/
define show_lisp_map_register_state_reply
{
u32 context;
i32 retval;
u8 is_enabled;
};
/** \brief set LISP map-request mode. Based on configuration VPP will send
src/dest or just normal destination map requests.
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param mode - new map-request mode. Supported values are:
0 - destination only
1 - source/destaination
*/
define lisp_map_request_mode
{
u32 client_index;
u32 context;
u8 mode;
};
/** \brief Reply for lisp_map_request_mode
@param context - returned sender context, to match reply w/ request
@param retval - return code
*/
define lisp_map_request_mode_reply
{
u32 context;
i32 retval;
};
/** \brief Request for LISP map-request mode
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
*/
define show_lisp_map_request_mode
{
u32 client_index;
u32 context;
};
/** \brief Reply for show_lisp_map_request_mode
@param context - returned sender context, to match reply w/ request
@param retval - return code
@param mode - map-request mode
*/
define show_lisp_map_request_mode_reply
{
u32 context;
i32 retval;
u8 mode;
};
/** \brief add or delete remote static mapping
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param is_add - add address if non-zero, else delete
@param is_src_dst - flag indicating src/dst based routing policy
@param del_all - if set, delete all remote mappings
@param vni - virtual network instance
@param action - negative map-reply action
@param eid_type -
0 : ipv4
1 : ipv6
2 : mac
@param deid - dst EID
@param seid - src EID, valid only if is_src_dst is enabled
@param rloc_num - number of remote locators
@param rlocs - remote locator records
Structure of remote locator:
define rloc_t {
u8 is_ip4;
u8 priority;
u8 weight;
u8 addr[16];
}
*/
define lisp_add_del_remote_mapping
{
u32 client_index;
u32 context;
u8 is_add;
u8 is_src_dst;
u8 del_all;
u32 vni;
u8 action;
u8 eid_type;
u8 eid[16];
u8 eid_len;
u8 seid[16];
u8 seid_len;
u32 rloc_num;
u8 rlocs[0];
};
/** \brief Reply for lisp_add_del_remote_mapping
@param context - returned sender context, to match reply w/ request
@param retval - return code
*/
define lisp_add_del_remote_mapping_reply
{
u32 context;
i32 retval;
};
/** \brief add or delete LISP adjacency adjacency
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param is_add - add address if non-zero, else delete
@param vni - virtual network instance
@param eid_type -
0 : ipv4
1 : ipv6
2 : mac
@param reid - remote EID
@param leid - local EID
*/
define lisp_add_del_adjacency
{
u32 client_index;
u32 context;
u8 is_add;
u32 vni;
u8 eid_type;
u8 reid[16];
u8 leid[16];
u8 reid_len;
u8 leid_len;
};
/** \brief Reply for lisp_add_del_adjacency
@param context - returned sender context, to match reply w/ request
@param retval - return code
*/
define lisp_add_del_adjacency_reply
{
u32 context;
i32 retval;
};
/** \brief add or delete map request itr rlocs
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param is_add - add address if non-zero, else delete
@param locator_set_name - locator set name
*/
define lisp_add_del_map_request_itr_rlocs
{
u32 client_index;
u32 context;
u8 is_add;
u8 locator_set_name[64];
};
/** \brief Reply for lisp_add_del_map_request_itr_rlocs
@param context - returned sender context, to match reply w/ request
@param retval - return code
*/
define lisp_add_del_map_request_itr_rlocs_reply
{
u32 context;
i32 retval;
};
/** \brief map/unmap vni/bd_index to vrf
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param is_add - add or delete mapping
@param dp_table - virtual network id/bridge domain index
@param vrf - vrf
*/
define lisp_eid_table_add_del_map
{
u32 client_index;
u32 context;
u8 is_add;
u32 vni;
u32 dp_table;
u8 is_l2;
};
/** \brief Reply for lisp_eid_table_add_del_map
@param context - returned sender context, to match reply w/ request
@param retval - return code
*/
define lisp_eid_table_add_del_map_reply
{
u32 context;
i32 retval;
};
/** \brief Request for map lisp locator status
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param locator_set_index - index of locator_set
@param ls_name - locator set name
@param is_index_set - flag indicating whether ls_name or ls_index is set
*/
define lisp_locator_dump
{
u32 client_index;
u32 context;
u32 ls_index;
u8 ls_name[64];
u8 is_index_set;
};
/** \brief LISP locator_set status
@param local - if is set, then locator is local
@param locator_set_name - name of the locator_set
@param sw_if_index - sw_if_index of the locator
@param priority - locator priority
@param weight - locator weight
*/
define lisp_locator_details
{
u32 context;
u8 local;
u32 sw_if_index;
u8 is_ipv6;
u8 ip_address[16];
u8 priority;
u8 weight;
};
/** \brief LISP locator_set status
@param context - sender context, to match reply w/ request
@param ls_index - locator set index
@param ls_name - name of the locator set
*/
define lisp_locator_set_details
{
u32 context;
u32 ls_index;
u8 ls_name[64];
};
/** \brief Request for locator_set summary status
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param filter - filter type
Supported values:
0: all locator sets
1: local locator sets
2: remote locator sets
*/
define lisp_locator_set_dump
{
u32 client_index;
u32 context;
u8 filter;
};
/** \brief Dump lisp eid-table
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param locator_set_index - index of locator_set, if ~0 then the mapping
is negative
@param action - negative map request action
@param is_local - local if non-zero, else remote
@param eid_type:
0 : ipv4
1 : ipv6
2 : mac
@param is_src_dst - EID is type of source/destination
@param eid - EID can be ip4, ip6 or mac
@param eid_prefix_len - prefix length
@param seid - source EID can be ip4, ip6 or mac
@param seid_prefix_len - source prefix length
@param vni - virtual network instance
@param ttl - time to live
@param authoritative - authoritative
@param key_id
HMAC_NO_KEY 0
HMAC_SHA_1_96 1
HMAC_SHA_256_128 2
@param key - secret key
*/
define lisp_eid_table_details
{
u32 context;
u32 locator_set_index;
u8 action;
u8 is_local;
u8 eid_type;
u8 is_src_dst;
u32 vni;
u8 eid[16];
u8 eid_prefix_len;
u8 seid[16];
u8 seid_prefix_len;
u32 ttl;
u8 authoritative;
u16 key_id;
u8 key[64];
};
/** \brief Request for eid table summary status
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param eid_set - if non-zero request info about specific mapping
@param vni - virtual network instance; valid only if eid_set != 0
@param prefix_length - prefix length if EID is IP address;
valid only if eid_set != 0
@param eid_type - EID type; valid only if eid_set != 0
Supported values:
0: EID is IPv4
1: EID is IPv6
2: EID is ethernet address
@param eid - endpoint identifier
@param filter - filter type;
Support values:
0: all eid
1: local eid
2: remote eid
*/
define lisp_eid_table_dump
{
u32 client_index;
u32 context;
u8 eid_set;
u8 prefix_length;
u32 vni;
u8 eid_type;
u8 eid[16];
u8 filter;
};
/** \brief LISP adjacency
@param eid_type -
0 : ipv4
1 : ipv6
2 : mac
@param reid - remote EID
@param leid - local EID
@param reid_prefix_len - remote EID IP prefix length
@param leid_prefix_len - local EID IP prefix length
*/
typeonly manual_print manual_endian define lisp_adjacency
{
u8 eid_type;
u8 reid[16];
u8 leid[16];
u8 reid_prefix_len;
u8 leid_prefix_len;
};
/** \brief LISP adjacency reply
@param count - number of adjacencies
@param adjacencies - array of adjacencies
*/
manual_endian manual_print define lisp_adjacencies_get_reply
{
u32 context;
i32 retval;
u32 count;
vl_api_lisp_adjacency_t adjacencies[count];
};
/** \brief Request for LISP adjacencies
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param vni - filter adjacencies by VNI
*/
define lisp_adjacencies_get
{
u32 client_index;
u32 context;
u32 vni;
};
/** \brief Shows relationship between vni and vrf/bd
@param dp_table - VRF index or bridge domain index
@param vni - vitual network instance
*/
define lisp_eid_table_map_details
{
u32 context;
u32 vni;
u32 dp_table;
};
/** \brief Request for lisp_eid_table_map_details
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param is_l2 - if set dump vni/bd mappings else vni/vrf
*/
define lisp_eid_table_map_dump
{
u32 client_index;
u32 context;
u8 is_l2;
};
/** \brief Dumps all VNIs used in mappings
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
*/
define lisp_eid_table_vni_dump
{
u32 client_index;
u32 context;
};
/** \brief reply to lisp_eid_table_vni_dump
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param vni - virtual network instance
*/
define lisp_eid_table_vni_details
{
u32 client_index;
u32 context;
u32 vni;
};
define lisp_gpe_tunnel_details
{
u32 context;
u32 tunnels;
u8 is_ipv6;
u8 source_ip[16];
u8 destination_ip[16];
u32 encap_fib_id;
u32 decap_fib_id;
u32 dcap_next;
u8 lisp_ver;
u8 next_protocol;
u8 flags;
u8 ver_res;
u8 res;
u32 iid;
};
/** \brief Request for gpe tunnel summary status
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
*/
define lisp_gpe_tunnel_dump
{
u32 client_index;
u32 context;
};
/** \brief LISP map resolver status
@param is_ipv6 - if non-zero the address is ipv6, else ipv4
@param ip_address - array of address bytes
*/
define lisp_map_resolver_details
{
u32 context;
u8 is_ipv6;
u8 ip_address[16];
};
/** \brief Request for map resolver summary status
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
*/
define lisp_map_resolver_dump
{
u32 client_index;
u32 context;
};
/** \brief LISP map server details
@param is_ipv6 - if non-zero the address is ipv6, else ipv4
@param ip_address - array of address bytes
*/
define lisp_map_server_details
{
u32 context;
u8 is_ipv6;
u8 ip_address[16];
};
/** \brief Request for map server summary status
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
*/
define lisp_map_server_dump
{
u32 client_index;
u32 context;
};
/** \brief Request for lisp-gpe protocol status
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
*/
define show_lisp_status
{
u32 client_index;
u32 context;
};
/** \brief Status of lisp, enable or disable
@param context - sender context, to match reply w/ request
@param feature_status - lisp enable if non-zero, else disable
@param gpe_status - lisp enable if non-zero, else disable
*/
define show_lisp_status_reply
{
u32 context;
i32 retval;
u8 feature_status;
u8 gpe_status;
};
/** \brief Get LISP map request itr rlocs status
@param context - sender context, to match reply w/ request
@param locator_set_name - name of the locator_set
*/
define lisp_get_map_request_itr_rlocs
{
u32 client_index;
u32 context;
};
/** \brief Request for map request itr rlocs summary status
*/
define lisp_get_map_request_itr_rlocs_reply
{
u32 context;
i32 retval;
u8 locator_set_name[64];
};
/** \brief Request for lisp pitr status
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
*/
define show_lisp_pitr
{
u32 client_index;
u32 context;
};
/** \brief Status of lisp pitr, enable or disable
@param context - sender context, to match reply w/ request
@param status - lisp pitr enable if non-zero, else disable
@param locator_set_name - name of the locator_set
*/
define show_lisp_pitr_reply
{
u32 context;
i32 retval;
u8 status;
u8 locator_set_name[64];
};
/* Gross kludge, DGMS */
define interface_name_renumber
{
u32 client_index;
u32 context;
u32 sw_if_index;
u32 new_show_dev_instance;
};
define interface_name_renumber_reply
{
u32 context;
i32 retval;
};
/** \brief Register for ip4 arp resolution events
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param enable_disable - 1 => register for events, 0 => cancel registration
@param pid - sender's pid
@param address - the exact ip4 address of interest
*/
define want_ip4_arp_events
{
u32 client_index;
u32 context;
u8 enable_disable;
u32 pid;
u32 address;
};
/** \brief Reply for interface events registration
@param context - returned sender context, to match reply w/ request
@param retval - return code
*/
define want_ip4_arp_events_reply
{
u32 context;
i32 retval;
};
/** \brief Tell client about an ip4 arp resolution event
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param address - the exact ip4 address of interest
@param pid - client pid registered to receive notification
@param sw_if_index - interface which received ARP packet
@param new_mac - the new mac address
@param mac_ip - 0: resolution event, 1: mac/ip binding in bd
*/
define ip4_arp_event
{
u32 client_index;
u32 context;
u32 address;
u32 pid;
u32 sw_if_index;
u8 new_mac[6];
u8 mac_ip;
};
/** \brief Register for ip6 nd resolution events
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param enable_disable - 1 => register for events, 0 => cancel registration
@param pid - sender's pid
@param address - the exact ip6 address of interest
*/
define want_ip6_nd_events
{
u32 client_index;
u32 context;
u8 enable_disable;
u32 pid;
u8 address[16];
};
/** \brief Reply for ip6 nd resolution events registration
@param context - returned sender context, to match reply w/ request
@param retval - return code
*/
define want_ip6_nd_events_reply
{
u32 context;
i32 retval;
};
/** \brief Tell client about an ip6 nd resolution or mac/ip event
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param pid - client pid registered to receive notification
@param sw_if_index - interface which received ARP packet
@param address - the exact ip6 address of interest
@param new_mac - the new mac address
@param mac_ip - 0: resolution event, 1: mac/ip binding in bd
*/
define ip6_nd_event
{
u32 client_index;
u32 context;
u32 pid;
u32 sw_if_index;
u8 address[16];
u8 new_mac[6];
u8 mac_ip;
};
/** \brief L2 bridge domain add or delete request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param bd_id - the bridge domain to create
@param flood - enable/disable bcast/mcast flooding in the bd
@param uu_flood - enable/disable uknown unicast flood in the bd
@param forward - enable/disable forwarding on all interfaces in the bd
@param learn - enable/disable learning on all interfaces in the bd
@param arp_term - enable/disable arp termination in the bd
@param mac_age - mac aging time in min, 0 for disabled
@param is_add - add or delete flag
*/
define bridge_domain_add_del
{
u32 client_index;
u32 context;
u32 bd_id;
u8 flood;
u8 uu_flood;
u8 forward;
u8 learn;
u8 arp_term;
u8 mac_age;
u8 is_add;
};
/** \brief L2 bridge domain add or delete response
@param context - sender context, to match reply w/ request
@param retval - return code for the set bridge flags request
*/
define bridge_domain_add_del_reply
{
u32 context;
i32 retval;
};
/** \brief L2 bridge domain request operational state details
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param bd_id - the bridge domain id desired or ~0 to request all bds
*/
define bridge_domain_dump
{
u32 client_index;
u32 context;
u32 bd_id;
};
/** \brief L2 bridge domain operational state response
@param bd_id - the bridge domain id
@param flood - bcast/mcast flooding state on all interfaces in the bd
@param uu_flood - uknown unicast flooding state on all interfaces in the bd
@param forward - forwarding state on all interfaces in the bd
@param learn - learning state on all interfaces in the bd
@param arp_term - arp termination state on all interfaces in the bd
@param mac_age - mac aging time in min, 0 for disabled
@param n_sw_ifs - number of sw_if_index's in the domain
*/
define bridge_domain_details
{
u32 context;
u32 bd_id;
u8 flood;
u8 uu_flood;
u8 forward;
u8 learn;
u8 arp_term;
u8 mac_age;
u32 bvi_sw_if_index;
u32 n_sw_ifs;
};
/** \brief L2 bridge domain sw interface operational state response
@param bd_id - the bridge domain id
@param sw_if_index - sw_if_index in the domain
@param shg - split horizon group for the interface
*/
define bridge_domain_sw_if_details
{
u32 context;
u32 bd_id;
u32 sw_if_index;
u8 shg;
};
/** \brief DHCP Client config add / del request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param sw_if_index - index of the interface for DHCP client
@param hostname - hostname
@param is_add - add the config if non-zero, else delete
@param want_dhcp_event - DHCP event sent to the sender
via dhcp_compl_event API message if non-zero
@param pid - sender's pid
*/
define dhcp_client_config
{
u32 client_index;
u32 context;
u32 sw_if_index;
u8 hostname[64];
u8 is_add;
u8 want_dhcp_event;
u32 pid;
};
/** \brief DHCP Client config response
@param context - sender context, to match reply w/ request
@param retval - return code for the request
*/
define dhcp_client_config_reply
{
u32 context;
i32 retval;
};
/** \brief Set/unset input ACL interface
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param sw_if_index - interface to set/unset input ACL
@param ip4_table_index - ip4 classify table index (~0 for skip)
@param ip6_table_index - ip6 classify table index (~0 for skip)
@param l2_table_index - l2 classify table index (~0 for skip)
@param is_add - Set input ACL if non-zero, else unset
Note: User is recommeneded to use just one valid table_index per call.
(ip4_table_index, ip6_table_index, or l2_table_index)
*/
define input_acl_set_interface
{
u32 client_index;
u32 context;
u32 sw_if_index;
u32 ip4_table_index;
u32 ip6_table_index;
u32 l2_table_index;
u8 is_add;
};
/** \brief Set/unset input ACL interface response
@param context - sender context, to match reply w/ request
@param retval - return code for the request
*/
define input_acl_set_interface_reply
{
u32 context;
i32 retval;
};
/** \brief IPsec: Add/delete Security Policy Database
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param is_add - add SPD if non-zero, else delete
@param spd_id - SPD instance id (control plane allocated)
*/
define ipsec_spd_add_del
{
u32 client_index;
u32 context;
u8 is_add;
u32 spd_id;
};
/** \brief Reply for IPsec: Add/delete Security Policy Database entry
@param context - returned sender context, to match reply w/ request
@param retval - return code
*/
define ipsec_spd_add_del_reply
{
u32 context;
i32 retval;
};
/** \brief IPsec: Add/delete SPD from interface
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param is_add - add security mode if non-zero, else delete
@param sw_if_index - index of the interface
@param spd_id - SPD instance id to use for lookups
*/
define ipsec_interface_add_del_spd
{
u32 client_index;
u32 context;
u8 is_add;
u32 sw_if_index;
u32 spd_id;
};
/** \brief Reply for IPsec: Add/delete SPD from interface
@param context - returned sender context, to match reply w/ request
@param retval - return code
*/
define ipsec_interface_add_del_spd_reply
{
u32 context;
i32 retval;
};
/** \brief IPsec: Add/delete Security Policy Database entry
See RFC 4301, 4.4.1.1 on how to match packet to selectors
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param is_add - add SPD if non-zero, else delete
@param spd_id - SPD instance id (control plane allocated)
@param priority - priority of SPD entry (non-unique value). Used to order SPD matching - higher priorities match before lower
@param is_outbound - entry applies to outbound traffic if non-zero, otherwise applies to inbound traffic
@param is_ipv6 - remote/local address are IPv6 if non-zero, else IPv4
@param remote_address_start - start of remote address range to match
@param remote_address_stop - end of remote address range to match
@param local_address_start - start of local address range to match
@param local_address_stop - end of local address range to match
@param protocol - protocol type to match [0 means any]
@param remote_port_start - start of remote port range to match ...
@param remote_port_stop - end of remote port range to match [0 to 65535 means ANY, 65535 to 0 means OPAQUE]
@param local_port_start - start of local port range to match ...
@param local_port_stop - end of remote port range to match [0 to 65535 means ANY, 65535 to 0 means OPAQUE]
@param policy - 0 = bypass (no IPsec processing), 1 = discard (discard packet with ICMP processing), 2 = resolve (send request to control plane for SA resolving, and discard without ICMP processing), 3 = protect (apply IPsec policy using following parameters)
@param sa_id - SAD instance id (control plane allocated)
*/
define ipsec_spd_add_del_entry
{
u32 client_index;
u32 context;
u8 is_add;
u32 spd_id;
i32 priority;
u8 is_outbound;
// Selector
u8 is_ipv6;
u8 is_ip_any;
u8 remote_address_start[16];
u8 remote_address_stop[16];
u8 local_address_start[16];
u8 local_address_stop[16];
u8 protocol;
u16 remote_port_start;
u16 remote_port_stop;
u16 local_port_start;
u16 local_port_stop;
// Policy
u8 policy;
u32 sa_id;
};
/** \brief Reply for IPsec: Add/delete Security Policy Database entry
@param context - returned sender context, to match reply w/ request
@param retval - return code
*/
define ipsec_spd_add_del_entry_reply
{
u32 context;
i32 retval;
};
/** \brief IPsec: Add/delete Security Association Database entry
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param is_add - add SAD entry if non-zero, else delete
@param sad_id - sad id
@param spi - security parameter index
@param protocol - 0 = AH, 1 = ESP
@param crypto_algorithm - 0 = Null, 1 = AES-CBC-128, 2 = AES-CBC-192, 3 = AES-CBC-256, 4 = 3DES-CBC
@param crypto_key_length - length of crypto_key in bytes
@param crypto_key - crypto keying material
@param integrity_algorithm - 0 = None, 1 = MD5-96, 2 = SHA1-96, 3 = SHA-256, 4 = SHA-384, 5=SHA-512
@param integrity_key_length - length of integrity_key in bytes
@param integrity_key - integrity keying material
@param use_extended_sequence_number - use ESN when non-zero
@param is_tunnel - IPsec tunnel mode if non-zero, else transport mode
@param is_tunnel_ipv6 - IPsec tunnel mode is IPv6 if non-zero, else IPv4 tunnel only valid if is_tunnel is non-zero
@param tunnel_src_address - IPsec tunnel source address IPv6 if is_tunnel_ipv6 is non-zero, else IPv4. Only valid if is_tunnel is non-zero
@param tunnel_dst_address - IPsec tunnel destination address IPv6 if is_tunnel_ipv6 is non-zero, else IPv4. Only valid if is_tunnel is non-zero
To be added:
Anti-replay
IPsec tunnel address copy mode (to support GDOI)
*/
define ipsec_sad_add_del_entry
{
u32 client_index;
u32 context;
u8 is_add;
u32 sad_id;
u32 spi;
u8 protocol;
u8 crypto_algorithm;
u8 crypto_key_length;
u8 crypto_key[128];
u8 integrity_algorithm;
u8 integrity_key_length;
u8 integrity_key[128];
u8 use_extended_sequence_number;
u8 is_tunnel;
u8 is_tunnel_ipv6;
u8 tunnel_src_address[16];
u8 tunnel_dst_address[16];
};
/** \brief Reply for IPsec: Add/delete Security Association Database entry
@param context - returned sender context, to match reply w/ request
@param retval - return code
*/
define ipsec_sad_add_del_entry_reply
{
u32 context;
i32 retval;
};
/** \brief IPsec: Update Security Association keys
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param sa_id - sa id
@param crypto_key_length - length of crypto_key in bytes
@param crypto_key - crypto keying material
@param integrity_key_length - length of integrity_key in bytes
@param integrity_key - integrity keying material
*/
define ipsec_sa_set_key
{
u32 client_index;
u32 context;
u32 sa_id;
u8 crypto_key_length;
u8 crypto_key[128];
u8 integrity_key_length;
u8 integrity_key[128];
};
/** \brief Reply for IPsec: Update Security Association keys
@param context - returned sender context, to match reply w/ request
@param retval - return code
*/
define ipsec_sa_set_key_reply
{
u32 context;
i32 retval;
};
/** \brief IKEv2: Add/delete profile
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param name - IKEv2 profile name
@param is_add - Add IKEv2 profile if non-zero, else delete
*/
define ikev2_profile_add_del
{
u32 client_index;
u32 context;
u8 name[64];
u8 is_add;
};
/** \brief Reply for IKEv2: Add/delete profile
@param context - returned sender context, to match reply w/ request
@param retval - return code
*/
define ikev2_profile_add_del_reply
{
u32 context;
i32 retval;
};
/** \brief IKEv2: Set IKEv2 profile authentication method
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param name - IKEv2 profile name
@param auth_method - IKEv2 authentication method (shared-key-mic/rsa-sig)
@param is_hex - Authentication data in hex format if non-zero, else string
@param data_len - Authentication data length
@param data - Authentication data (for rsa-sig cert file path)
*/
define ikev2_profile_set_auth
{
u32 client_index;
u32 context;
u8 name[64];
u8 auth_method;
u8 is_hex;
u32 data_len;
u8 data[0];
};
/** \brief Reply for IKEv2: Set IKEv2 profile authentication method
@param context - returned sender context, to match reply w/ request
@param retval - return code
*/
define ikev2_profile_set_auth_reply
{
u32 context;
i32 retval;
};
/** \brief IKEv2: Set IKEv2 profile local/remote identification
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param name - IKEv2 profile name
@param is_local - Identification is local if non-zero, else remote
@param id_type - Identification type
@param data_len - Identification data length
@param data - Identification data
*/
define ikev2_profile_set_id
{
u32 client_index;
u32 context;
u8 name[64];
u8 is_local;
u8 id_type;
u32 data_len;
u8 data[0];
};
/** \brief Reply for IKEv2:
@param context - returned sender context, to match reply w/ request
@param retval - return code
*/
define ikev2_profile_set_id_reply
{
u32 context;
i32 retval;
};
/** \brief IKEv2: Set IKEv2 profile traffic selector parameters
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param name - IKEv2 profile name
@param is_local - Traffic selector is local if non-zero, else remote
@param proto - Traffic selector IP protocol (if zero not relevant)
@param start_port - The smallest port number allowed by traffic selector
@param end_port - The largest port number allowed by traffic selector
@param start_addr - The smallest address included in traffic selector
@param end_addr - The largest address included in traffic selector
*/
define ikev2_profile_set_ts
{
u32 client_index;
u32 context;
u8 name[64];
u8 is_local;
u8 proto;
u16 start_port;
u16 end_port;
u32 start_addr;
u32 end_addr;
};
/** \brief Reply for IKEv2: Set IKEv2 profile traffic selector parameters
@param context - returned sender context, to match reply w/ request
@param retval - return code
*/
define ikev2_profile_set_ts_reply
{
u32 context;
i32 retval;
};
/** \brief IKEv2: Set IKEv2 local RSA private key
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param key_file - Key file absolute path
*/
define ikev2_set_local_key
{
u32 client_index;
u32 context;
u8 key_file[256];
};
/** \brief Reply for IKEv2: Set IKEv2 local key
@param context - returned sender context, to match reply w/ request
@param retval - return code
*/
define ikev2_set_local_key_reply
{
u32 context;
i32 retval;
};
/** \brief Tell client about a DHCP completion event
@param client_index - opaque cookie to identify the sender
@param pid - client pid registered to receive notification
@param is_ipv6 - if non-zero the address is ipv6, else ipv4
@param host_address - Host IP address
@param router_address - Router IP address
@param host_mac - Host MAC address
*/
define dhcp_compl_event
{
u32 client_index;
u32 pid;
u8 hostname[64];
u8 is_ipv6;
u8 host_address[16];
u8 router_address[16];
u8 host_mac[6];
};
/** \brief cop: enable/disable junk filtration features on an interface
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param sw_if_inded - desired interface
@param enable_disable - 1 => enable, 0 => disable
*/
define cop_interface_enable_disable
{
u32 client_index;
u32 context;
u32 sw_if_index;
u8 enable_disable;
};
/** \brief cop: interface enable/disable junk filtration reply
@param context - returned sender context, to match reply w/ request
@param retval - return code
*/
define cop_interface_enable_disable_reply
{
u32 context;
i32 retval;
};
/** \brief cop: enable/disable whitelist filtration features on an interface
Note: the supplied fib_id must match in order to remove the feature!
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param sw_if_index - interface handle, physical interfaces only
@param fib_id - fib identifier for the whitelist / blacklist fib
@param ip4 - 1 => enable ip4 filtration, 0=> disable ip4 filtration
@param ip6 - 1 => enable ip6 filtration, 0=> disable ip6 filtration
@param default_cop - 1 => enable non-ip4, non-ip6 filtration 0=> disable it
*/
define cop_whitelist_enable_disable
{
u32 client_index;
u32 context;
u32 sw_if_index;
u32 fib_id;
u8 ip4;
u8 ip6;
u8 default_cop;
};
/** \brief cop: interface enable/disable junk filtration reply
@param context - returned sender context, to match reply w/ request
@param retval - return code
*/
define cop_whitelist_enable_disable_reply
{
u32 context;
i32 retval;
};
/** \brief get_node_graph - get a copy of the vpp node graph
including the current set of graph arcs.
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
*/
define get_node_graph
{
u32 client_index;
u32 context;
};
/** \brief get_node_graph_reply
@param context - returned sender context, to match reply w/ request
@param retval - return code
@param reply_in_shmem - result from vlib_node_serialize, in shared
memory. Process with vlib_node_unserialize, remember to switch
heaps and free the result.
*/
define get_node_graph_reply
{
u32 context;
i32 retval;
u64 reply_in_shmem;
};
/** \brief IOAM enable : Enable in-band OAM
@param id - profile id
@param seqno - To enable Seqno Processing
@param analyse - Enabling analysis of iOAM at decap node
@param pow_enable - Proof of Work enabled or not flag
@param trace_enable - iOAM Trace enabled or not flag
*/
define ioam_enable
{
u32 client_index;
u32 context;
u16 id;
u8 seqno;
u8 analyse;
u8 pot_enable;
u8 trace_enable;
u32 node_id;
};
/** \brief iOAM Trace profile add / del response
@param context - sender context, to match reply w/ request
@param retval - return value for request
*/
define ioam_enable_reply
{
u32 context;
i32 retval;
};
/** \brief iOAM disable
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param index - MAP Domain index
*/
define ioam_disable
{
u32 client_index;
u32 context;
u16 id;
};
/** \brief iOAM disable response
@param context - sender context, to match reply w/ request
@param retval - return value for request
*/
define ioam_disable_reply
{
u32 context;
i32 retval;
};
/** \brief Create host-interface
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param host_if_name - interface name
@param hw_addr - interface MAC
@param use_random_hw_addr - use random generated MAC
*/
define af_packet_create
{
u32 client_index;
u32 context;
u8 host_if_name[64];
u8 hw_addr[6];
u8 use_random_hw_addr;
};
/** \brief Create host-interface response
@param context - sender context, to match reply w/ request
@param retval - return value for request
*/
define af_packet_create_reply
{
u32 context;
i32 retval;
u32 sw_if_index;
};
/** \brief Delete host-interface
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param host_if_name - interface name
*/
define af_packet_delete
{
u32 client_index;
u32 context;
u8 host_if_name[64];
};
/** \brief Delete host-interface response
@param context - sender context, to match reply w/ request
@param retval - return value for request
*/
define af_packet_delete_reply
{
u32 context;
i32 retval;
};
/** \brief Add/del policer
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param is_add - add policer if non-zero, else delete
@param name - policer name
@param cir - CIR
@param eir - EIR
@param cb - Committed Burst
@param eb - Excess or Peak Burst
@param rate_type - rate type
@param round_type - rounding type
@param type - policer algorithm
@param color_aware - 0=color-blind, 1=color-aware
@param conform_action_type - conform action type
@param conform_dscp - DSCP for conform mar-and-transmit action
@param exceed_action_type - exceed action type
@param exceed_dscp - DSCP for exceed mar-and-transmit action
@param violate_action_type - violate action type
@param violate_dscp - DSCP for violate mar-and-transmit action
*/
define policer_add_del
{
u32 client_index;
u32 context;
u8 is_add;
u8 name[64];
u32 cir;
u32 eir;
u64 cb;
u64 eb;
u8 rate_type;
u8 round_type;
u8 type;
u8 color_aware;
u8 conform_action_type;
u8 conform_dscp;
u8 exceed_action_type;
u8 exceed_dscp;
u8 violate_action_type;
u8 violate_dscp;
};
/** \brief Add/del policer response
@param context - sender context, to match reply w/ request
@param retval - return value for request
@param policer_index - for add, returned index of the new policer
*/
define policer_add_del_reply
{
u32 context;
i32 retval;
u32 policer_index;
};
/** \brief Get list of policers
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param match_name_valid - if 0 request all policers otherwise use match_name
@param match_name - policer name
*/
define policer_dump
{
u32 client_index;
u32 context;
u8 match_name_valid;
u8 match_name[64];
};
/** \brief Policer operational state response.
@param context - sender context, to match reply w/ request
@param name - policer name
@param cir - CIR
@param eir - EIR
@param cb - Committed Burst
@param eb - Excess or Peak Burst
@param rate_type - rate type
@param round_type - rounding type
@param type - policer algorithm
@param conform_action_type - conform action type
@param conform_dscp - DSCP for conform mar-and-transmit action
@param exceed_action_type - exceed action type
@param exceed_dscp - DSCP for exceed mar-and-transmit action
@param violate_action_type - violate action type
@param violate_dscp - DSCP for violate mar-and-transmit action
@param single_rate - 1 = single rate policer, 0 = two rate policer
@param color_aware - for hierarchical policing
@param scale - power-of-2 shift amount for lower rates
@param cir_tokens_per_period - number of tokens for each period
@param pir_tokens_per_period - number of tokens for each period for 2-rate policer
@param current_limit - current limit
@param current_bucket - current bucket
@param extended_limit - extended limit
@param extended_bucket - extended bucket
@param last_update_time - last update time
*/
define policer_details
{
u32 context;
u8 name[64];
u32 cir;
u32 eir;
u64 cb;
u64 eb;
u8 rate_type;
u8 round_type;
u8 type;
u8 conform_action_type;
u8 conform_dscp;
u8 exceed_action_type;
u8 exceed_dscp;
u8 violate_action_type;
u8 violate_dscp;
u8 single_rate;
u8 color_aware;
u32 scale;
u32 cir_tokens_per_period;
u32 pir_tokens_per_period;
u32 current_limit;
u32 current_bucket;
u32 extended_limit;
u32 extended_bucket;
u64 last_update_time;
};
/** \brief Set/unset policer classify interface
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param sw_if_index - interface to set/unset policer classify
@param ip4_table_index - ip4 classify table index (~0 for skip)
@param ip6_table_index - ip6 classify table index (~0 for skip)
@param l2_table_index - l2 classify table index (~0 for skip)
@param is_add - Set if non-zero, else unset
Note: User is recommeneded to use just one valid table_index per call.
(ip4_table_index, ip6_table_index, or l2_table_index)
*/
define policer_classify_set_interface
{
u32 client_index;
u32 context;
u32 sw_if_index;
u32 ip4_table_index;
u32 ip6_table_index;
u32 l2_table_index;
u8 is_add;
};
/** \brief Set/unset policer classify interface response
@param context - sender context, to match reply w/ request
@param retval - return value for request
*/
define policer_classify_set_interface_reply
{
u32 context;
i32 retval;
};
/** \brief Get list of policer classify interfaces and tables
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param type - classify table type
*/
define policer_classify_dump
{
u32 client_index;
u32 context;
u8 type;
};
/** \brief Policer iclassify operational state response.
@param context - sender context, to match reply w/ request
@param sw_if_index - software interface index
@param table_index - classify table index
*/
define policer_classify_details
{
u32 context;
u32 sw_if_index;
u32 table_index;
};
/** \brief Create netmap
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param netmap_if_name - interface name
@param hw_addr - interface MAC
@param use_random_hw_addr - use random generated MAC
@param is_pipe - is pipe
@param is_master - 0=slave, 1=master
*/
define netmap_create
{
u32 client_index;
u32 context;
u8 netmap_if_name[64];
u8 hw_addr[6];
u8 use_random_hw_addr;
u8 is_pipe;
u8 is_master;
};
/** \brief Create netmap response
@param context - sender context, to match reply w/ request
@param retval - return value for request
*/
define netmap_create_reply
{
u32 context;
i32 retval;
};
/** \brief Delete netmap
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param netmap_if_name - interface name
*/
define netmap_delete
{
u32 client_index;
u32 context;
u8 netmap_if_name[64];
};
/** \brief Delete netmap response
@param context - sender context, to match reply w/ request
@param retval - return value for request
*/
define netmap_delete_reply
{
u32 context;
i32 retval;
};
/** \brief Classify get table IDs request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
*/
define classify_table_ids
{
u32 client_index;
u32 context;
};
/** \brief Reply for classify get table IDs request
@param context - sender context which was passed in the request
@param count - number of ids returned in response
@param ids - array of classify table ids
*/
define classify_table_ids_reply
{
u32 context;
i32 retval;
u32 count;
u32 ids[count];
};
/** \brief Classify table ids by interface index request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param sw_if_index - index of the interface
*/
define classify_table_by_interface
{
u32 client_index;
u32 context;
u32 sw_if_index;
};
/** \brief Reply for classify table id by interface index request
@param context - sender context which was passed in the request
@param count - number of ids returned in response
@param sw_if_index - index of the interface
@param l2_table_id - l2 classify table index
@param ip4_table_id - ip4 classify table index
@param ip6_table_id - ip6 classify table index
*/
define classify_table_by_interface_reply
{
u32 context;
i32 retval;
u32 sw_if_index;
u32 l2_table_id;
u32 ip4_table_id;
u32 ip6_table_id;
};
/** \brief Classify table info
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param table_id - classify table index
*/
define classify_table_info
{
u32 client_index;
u32 context;
u32 table_id;
};
/** \brief Reply for classify table info request
@param context - sender context which was passed in the request
@param count - number of ids returned in response
@param table_id - classify table index
@param nbuckets - number of buckets when adding a table
@param match_n_vectors - number of match vectors
@param skip_n_vectors - number of skip_n_vectors
@param active_sessions - number of sessions (active entries)
@param next_table_index - index of next table
@param miss_next_index - index of miss table
@param mask[] - match mask
*/
define classify_table_info_reply
{
u32 context;
i32 retval;
u32 table_id;
u32 nbuckets;
u32 match_n_vectors;
u32 skip_n_vectors;
u32 active_sessions;
u32 next_table_index;
u32 miss_next_index;
u32 mask_length;
u8 mask[mask_length];
};
/** \brief Classify sessions dump request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param table_id - classify table index
*/
define classify_session_dump
{
u32 client_index;
u32 context;
u32 table_id;
};
/** \brief Reply for classify table session dump request
@param context - sender context which was passed in the request
@param count - number of ids returned in response
@param table_id - classify table index
@param hit_next_index - hit_next_index of session
@param opaque_index - for add, opaque_index of session
@param advance - advance value of session
@param match[] - match value for session
*/
define classify_session_details
{
u32 context;
i32 retval;
u32 table_id;
u32 hit_next_index;
i32 advance;
u32 opaque_index;
u32 match_length;
u8 match[match_length];
};
/** \brief Configure IPFIX exporter process request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param collector_address - address of IPFIX collector
@param collector_port - port of IPFIX collector
@param src_address - address of IPFIX exporter
@param vrf_id - VRF / fib table ID
@param path_mtu - Path MTU between exporter and collector
@param template_interval - number of seconds after which to resend template
@param udp_checksum - UDP checksum calculation enable flag
*/
define set_ipfix_exporter
{
u32 client_index;
u32 context;
u8 collector_address[16];
u16 collector_port;
u8 src_address[16];
u32 vrf_id;
u32 path_mtu;
u32 template_interval;
u8 udp_checksum;
};
/** \brief Reply to IPFIX exporter configure request
@param context - sender context which was passed in the request
*/
define set_ipfix_exporter_reply
{
u32 context;
i32 retval;
};
/** \brief IPFIX exporter dump request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
*/
define ipfix_exporter_dump
{
u32 client_index;
u32 context;
};
/** \brief Reply to IPFIX exporter dump request
@param context - sender context which was passed in the request
@param collector_address - address of IPFIX collector
@param collector_port - port of IPFIX collector
@param src_address - address of IPFIX exporter
@param fib_index - fib table index
@param path_mtu - Path MTU between exporter and collector
@param template_interval - number of seconds after which to resend template
@param udp_checksum - UDP checksum calculation enable flag
*/
define ipfix_exporter_details
{
u32 context;
u8 collector_address[16];
u16 collector_port;
u8 src_address[16];
u32 vrf_id;
u32 path_mtu;
u32 template_interval;
u8 udp_checksum;
};
/** \brief IPFIX classify stream configure request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param domain_id - domain ID reported in IPFIX messages for classify stream
@param src_port - source port of UDP session for classify stream
*/
define set_ipfix_classify_stream {
u32 client_index;
u32 context;
u32 domain_id;
u16 src_port;
};
/** \brief IPFIX classify stream configure response
@param context - sender context, to match reply w/ request
@param retval - return value for request
*/
define set_ipfix_classify_stream_reply {
u32 context;
i32 retval;
};
/** \brief IPFIX classify stream dump request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
*/
define ipfix_classify_stream_dump {
u32 client_index;
u32 context;
};
/** \brief Reply to IPFIX classify stream dump request
@param context - sender context, to match reply w/ request
@param domain_id - domain ID reported in IPFIX messages for classify stream
@param src_port - source port of UDP session for classify stream
*/
define ipfix_classify_stream_details {
u32 context;
u32 domain_id;
u16 src_port;
};
/** \brief IPFIX add or delete classifier table request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param table_id - classifier table ID
@param ip_version - version of IP used in the classifier table
@param transport_protocol - transport protocol used in the classifier table or 255 for unspecified
*/
define ipfix_classify_table_add_del {
u32 client_index;
u32 context;
u32 table_id;
u8 ip_version;
u8 transport_protocol;
u8 is_add;
};
/** \brief IPFIX add classifier table response
@param context - sender context which was passed in the request
*/
define ipfix_classify_table_add_del_reply {
u32 context;
i32 retval;
};
/** \brief IPFIX classify tables dump request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
*/
define ipfix_classify_table_dump {
u32 client_index;
u32 context;
};
/** \brief Reply to IPFIX classify tables dump request
@param context - sender context, to match reply w/ request
@param table_id - classifier table ID
@param ip_version - version of IP used in the classifier table
@param transport_protocol - transport protocol used in the classifier table or 255 for unspecified
*/
define ipfix_classify_table_details {
u32 context;
u32 table_id;
u8 ip_version;
u8 transport_protocol;
};
/** \brief Set/unset flow classify interface
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param sw_if_index - interface to set/unset flow classify
@param ip4_table_index - ip4 classify table index (~0 for skip)
@param ip6_table_index - ip6 classify table index (~0 for skip)
@param l2_table_index - l2 classify table index (~0 for skip)
@param is_add - Set if non-zero, else unset
Note: User is recommeneded to use just one valid table_index per call.
(ip4_table_index, ip6_table_index, or l2_table_index)
*/
define flow_classify_set_interface {
u32 client_index;
u32 context;
u32 sw_if_index;
u32 ip4_table_index;
u32 ip6_table_index;
u8 is_add;
};
/** \brief Set/unset flow classify interface response
@param context - sender context, to match reply w/ request
@param retval - return value for request
*/
define flow_classify_set_interface_reply {
u32 context;
i32 retval;
};
/** \brief Get list of flow classify interfaces and tables
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param type - classify table type
*/
define flow_classify_dump {
u32 client_index;
u32 context;
u8 type;
};
/** \brief Flow classify operational state response.
@param context - sender context, to match reply w/ request
@param sw_if_index - software interface index
@param table_index - classify table index
*/
define flow_classify_details {
u32 context;
u32 sw_if_index;
u32 table_index;
};
/** \brief Query relative index via node names
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param node_name - name of node to find relative index from
@param next_name - next node from node_name to find relative index of
*/
define get_next_index
{
u32 client_index;
u32 context;
u8 node_name[64];
u8 next_name[64];
};
/** \brief Reply for get next node index
@param context - sender context which was passed in the request
@param retval - return value
@param next_index - index of the next_node
*/
define get_next_index_reply
{
u32 context;
i32 retval;
u32 next_index;
};
/** \brief PacketGenerator create interface request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param interface_id - interface index
*/
define pg_create_interface
{
u32 client_index;
u32 context;
u32 interface_id;
};
/** \brief PacketGenerator create interface response
@param context - sender context, to match reply w/ request
@param retval - return value for request
*/
define pg_create_interface_reply
{
u32 context;
i32 retval;
u32 sw_if_index;
};
/** \brief PacketGenerator capture packets on given interface request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param interface_id - pg interface index
@param is_enabled - 1 if enabling streams, 0 if disabling
@param count - number of packets to be captured
@param pcap_file - pacp file name to store captured packets
*/
define pg_capture
{
u32 client_index;
u32 context;
u32 interface_id;
u8 is_enabled;
u32 count;
u32 pcap_name_length;
u8 pcap_file_name[pcap_name_length];
};
/** \brief PacketGenerator capture packets response
@param context - sender context, to match reply w/ request
@param retval - return value for request
*/
define pg_capture_reply
{
u32 context;
i32 retval;
};
/** \brief Enable / disable packet generator request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param is_enabled - 1 if enabling streams, 0 if disabling
@param stream - stream name to be enable/disabled, if not specified handle all streams
*/
define pg_enable_disable
{
u32 client_index;
u32 context;
u8 is_enabled;
u32 stream_name_length;
u8 stream_name[stream_name_length];
};
/** \brief Reply for enable / disable packet generator
@param context - returned sender context, to match reply w/ request
@param retval - return code
*/
define pg_enable_disable_reply
{
u32 context;
i32 retval;
};
/** \brief Configure IP source and L4 port-range check
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param is_ip6 - 1 if source address type is IPv6
@param is_add - 1 if add, 0 if delete
@param mask_length - mask length for address entry
@param address - array of address bytes
@param number_of_ranges - length of low_port and high_port arrays (must match)
@param low_ports[32] - up to 32 low end of port range entries (must have corresponding high_ports entry)
@param high_ports[32] - up to 32 high end of port range entries (must have corresponding low_ports entry)
@param vrf_id - fib table/vrf id to associate the source and port-range check with
@note To specify a single port set low_port and high_port entry the same
*/
define ip_source_and_port_range_check_add_del
{
u32 client_index;
u32 context;
u8 is_ipv6;
u8 is_add;
u8 mask_length;
u8 address[16];
u8 number_of_ranges;
u16 low_ports[32];
u16 high_ports[32];
u32 vrf_id;
};
/** \brief Configure IP source and L4 port-range check reply
@param context - returned sender context, to match reply w/ request
@param retval - return code
*/
define ip_source_and_port_range_check_add_del_reply
{
u32 context;
i32 retval;
};
/** \brief Set interface source and L4 port-range request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param interface_id - interface index
@param tcp_vrf_id - VRF associated with source and TCP port-range check
@param udp_vrf_id - VRF associated with source and TCP port-range check
*/
define ip_source_and_port_range_check_interface_add_del
{
u32 client_index;
u32 context;
u8 is_add;
u32 sw_if_index;
u32 tcp_in_vrf_id;
u32 tcp_out_vrf_id;
u32 udp_in_vrf_id;
u32 udp_out_vrf_id;
};
/** \brief Set interface source and L4 port-range response
@param context - sender context, to match reply w/ request
@param retval - return value for request
*/
define ip_source_and_port_range_check_interface_add_del_reply
{
u32 context;
i32 retval;
};
/** \brief Add / del ipsec gre tunnel request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param local_sa_id - local SA id
@param remote_sa_id - remote SA id
@param is_add - 1 if adding the tunnel, 0 if deleting
@param src_address - tunnel source address
@param dst_address - tunnel destination address
*/
define ipsec_gre_add_del_tunnel {
u32 client_index;
u32 context;
u32 local_sa_id;
u32 remote_sa_id;
u8 is_add;
u8 src_address[4];
u8 dst_address[4];
};
/** \brief Reply for add / del ipsec gre tunnel request
@param context - returned sender context, to match reply w/ request
@param retval - return code
@param sw_if_index - software index of the new ipsec gre tunnel
*/
define ipsec_gre_add_del_tunnel_reply {
u32 context;
i32 retval;
u32 sw_if_index;
};
/** \brief Dump ipsec gre tunnel table
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param tunnel_index - gre tunnel identifier or -1 in case of all tunnels
*/
define ipsec_gre_tunnel_dump {
u32 client_index;
u32 context;
u32 sw_if_index;
};
/** \brief mpls gre tunnel operational state response
@param context - returned sender context, to match reply w/ request
@param sw_if_index - software index of the ipsec gre tunnel
@param local_sa_id - local SA id
@param remote_sa_id - remote SA id
@param src_address - tunnel source address
@param dst_address - tunnel destination address
*/
define ipsec_gre_tunnel_details {
u32 context;
u32 sw_if_index;
u32 local_sa_id;
u32 remote_sa_id;
u8 src_address[4];
u8 dst_address[4];
};
/** \brief Delete sub interface request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param sw_if_index - sw index of the interface that was created by create_subif
*/
define delete_subif {
u32 client_index;
u32 context;
u32 sw_if_index;
};
/** \brief Delete sub interface response
@param context - sender context, to match reply w/ request
@param retval - return code for the request
*/
define delete_subif_reply {
u32 context;
i32 retval;
};
/** \brief DPDK interface HQoS pipe profile set request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param sw_if_index - the interface
@param subport - subport ID
@param pipe - pipe ID within its subport
@param profile - pipe profile ID
*/
define sw_interface_set_dpdk_hqos_pipe {
u32 client_index;
u32 context;
u32 sw_if_index;
u32 subport;
u32 pipe;
u32 profile;
};
/** \brief DPDK interface HQoS pipe profile set reply
@param context - sender context, to match reply w/ request
@param retval - request return code
*/
define sw_interface_set_dpdk_hqos_pipe_reply {
u32 context;
i32 retval;
};
/** \brief DPDK interface HQoS subport parameters set request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param sw_if_index - the interface
@param subport - subport ID
@param tb_rate - subport token bucket rate (measured in bytes/second)
@param tb_size - subport token bucket size (measured in credits)
@param tc_rate - subport traffic class 0 .. 3 rates (measured in bytes/second)
@param tc_period - enforcement period for rates (measured in milliseconds)
*/
define sw_interface_set_dpdk_hqos_subport {
u32 client_index;
u32 context;
u32 sw_if_index;
u32 subport;
u32 tb_rate;
u32 tb_size;
u32 tc_rate[4];
u32 tc_period;
};
/** \brief DPDK interface HQoS subport parameters set reply
@param context - sender context, to match reply w/ request
@param retval - request return code
*/
define sw_interface_set_dpdk_hqos_subport_reply {
u32 context;
i32 retval;
};
/** \brief DPDK interface HQoS tctbl entry set request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param sw_if_index - the interface
@param entry - entry index ID
@param tc - traffic class (0 .. 3)
@param queue - traffic class queue (0 .. 3)
*/
define sw_interface_set_dpdk_hqos_tctbl {
u32 client_index;
u32 context;
u32 sw_if_index;
u32 entry;
u32 tc;
u32 queue;
};
/** \brief DPDK interface HQoS tctbl entry set reply
@param context - sender context, to match reply w/ request
@param retval - request return code
*/
define sw_interface_set_dpdk_hqos_tctbl_reply {
u32 context;
i32 retval;
};
/** \brief L2 interface pbb tag rewrite configure request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param sw_if_index - interface the operation is applied to
@param vtr_op - Choose from l2_vtr_op_t enum values
@param inner_tag - needed for translate_qinq vtr op only
@param outer_tag - needed for translate_qinq vtr op only
@param b_dmac - B-tag remote mac address, needed for any push or translate_qinq vtr op
@param b_smac - B-tag local mac address, needed for any push or translate qinq vtr op
@param b_vlanid - B-tag vlanid, needed for any push or translate qinq vtr op
@param i_sid - I-tag service id, needed for any push or translate qinq vtr op
*/
define l2_interface_pbb_tag_rewrite
{
u32 client_index;
u32 context;
u32 sw_if_index;
u32 vtr_op;
u16 outer_tag;
u8 b_dmac[6];
u8 b_smac[6];
u16 b_vlanid;
u32 i_sid;
};
/** \brief L2 interface pbb tag rewrite response
@param context - sender context, to match reply w/ request
@param retval - return code for the request
*/
define l2_interface_pbb_tag_rewrite_reply
{
u32 context;
i32 retval;
};
/** \brief Punt traffic to the host
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param is_add - add punt if non-zero, else delete
@param ipv - L3 protocol 4 - IPv4, 6 - IPv6, ~0 - All
@param l4_protocol - L4 protocol to be punted, only UDP (0x11) is supported
@param l4_port - TCP/UDP port to be punted
*/
define punt {
u32 client_index;
u32 context;
u8 is_add;
u8 ipv;
u8 l4_protocol;
u16 l4_port;
};
/** \brief Reply to the punt request
@param context - sender context which was passed in the request
@param retval - return code of punt request
*/
define punt_reply
{
u32 context;
i32 retval;
};
/** \brief Dump ipsec policy database data
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param spd_id - SPD instance id
@param sa_id - SA id, optional, set to ~0 to see all policies in SPD
*/
define ipsec_spd_dump {
u32 client_index;
u32 context;
u32 spd_id;
u32 sa_id;
};
/** \brief IPsec policy database response
@param context - sender context which was passed in the request
@param spd_id - SPD instance id
@param priority - numeric value to control policy evaluation order
@param is_outbound - [1|0] to indicate if direction is [out|in]bound
@param is_ipv6 - [1|0] to indicate if address family is ipv[6|4]
@param local_start_addr - first address in local traffic selector range
@param local_stop_addr - last address in local traffic selector range
@param local_start_port - first port in local traffic selector range
@param local_stop_port - last port in local traffic selector range
@param remote_start_addr - first address in remote traffic selector range
@param remote_stop_addr - last address in remote traffic selector range
@param remote_start_port - first port in remote traffic selector range
@param remote_stop_port - last port in remote traffic selector range
@param protocol - traffic selector protocol
@param policy - policy action
@param sa_id - SA id
@param bytes - byte count of packets matching this policy
@param packets - count of packets matching this policy
*/
define ipsec_spd_details {
u32 context;
u32 spd_id;
i32 priority;
u8 is_outbound;
u8 is_ipv6;
u8 local_start_addr[16];
u8 local_stop_addr[16];
u16 local_start_port;
u16 local_stop_port;
u8 remote_start_addr[16];
u8 remote_stop_addr[16];
u16 remote_start_port;
u16 remote_stop_port;
u8 protocol;
u8 policy;
u32 sa_id;
u64 bytes;
u64 packets;
};
/** \brief Feature path enable/disable request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param sw_if_index - the interface
@param enable - 1 = on, 0 = off
*/
define feature_enable_disable {
u32 client_index;
u32 context;
u32 sw_if_index;
u8 enable;
u8 arc_name[64];
u8 feature_name[64];
};
/** \brief Reply to the eature path enable/disable request
@param context - sender context which was passed in the request
@param retval - return code for the request
*/
define feature_enable_disable_reply
{
u32 context;
i32 retval;
};
/** \brief Configure BFD feature
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param slow_timer - slow timer (seconds)
@param min_tx - desired min tx interval
@param min_rx - desired min rx interval
@param detect_mult - desired detection multiplier
*/
define bfd_set_config {
u32 client_index;
u32 context;
u32 slow_timer;
u32 min_tx;
u32 min_rx;
u8 detect_mult;
};
/** \brief Configure BFD feature response
@param context - sender context, to match reply w/ request
@param retval - return code for the request
*/
define bfd_set_config_reply {
u32 context;
i32 retval;
};
/** \brief Get BFD configuration
*/
define bfd_get_config {
u32 client_index;
u32 context;
};
/** \brief Get BFD configuration response
@param context - sender context, to match reply w/ request
@param retval - return code for the request
@param slow_timer - slow timer (seconds)
@param min_tx - desired min tx interval
@param min_rx - desired min rx interval
@param detect_mult - desired detection multiplier
*/
define bfd_get_config_reply {
u32 client_index;
u32 context;
u32 slow_timer;
u32 min_tx;
u32 min_rx;
u8 detect_mult;
};
/** \brief Add UDP BFD session on interface
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param sw_if_index - sw index of the interface
@param desired_min_tx - desired min transmit interval (microseconds)
@param required_min_rx - required min receive interval (microseconds)
@param detect_mult - detect multiplier (# of packets missed between connection goes down)
@param local_addr - local address
@param peer_addr - peer address
@param is_ipv6 - local_addr, peer_addr are IPv6 if non-zero, otherwise IPv4
*/
define bfd_udp_add {
u32 client_index;
u32 context;
u32 sw_if_index;
u32 desired_min_tx;
u32 required_min_rx;
u8 local_addr[16];
u8 peer_addr[16];
u8 is_ipv6;
u8 detect_mult;
};
/** \brief Add UDP BFD session response
@param context - sender context, to match reply w/ request
@param retval - return code for the request
@param bs_index - index of the session created
*/
define bfd_udp_add_reply {
u32 context;
i32 retval;
u32 bs_index;
};
/** \brief Delete UDP BFD session on interface
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param sw_if_index - sw index of the interface
@param local_addr - local address
@param peer_addr - peer address
@param is_ipv6 - local_addr, peer_addr are IPv6 if non-zero, otherwise IPv4
*/
define bfd_udp_del {
u32 client_index;
u32 context;
u32 sw_if_index;
u8 local_addr[16];
u8 peer_addr[16];
u8 is_ipv6;
};
/** \brief Delete UDP BFD session response
@param context - sender context, to match reply w/ request
@param retval - return code for the request
*/
define bfd_udp_del_reply {
u32 context;
i32 retval;
};
/** \brief Get all BFD sessions
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
*/
define bfd_udp_session_dump {
u32 client_index;
u32 context;
};
/** \brief BFD session details structure
@param context - sender context, to match reply w/ request
@param bs_index - index of the session
@param sw_if_index - sw index of the interface
@param local_addr - local address
@param peer_addr - peer address
@param is_ipv6 - local_addr, peer_addr are IPv6 if non-zero, otherwise IPv4
@param state - session state
*/
define bfd_udp_session_details {
u32 context;
u32 bs_index;
u32 sw_if_index;
u8 local_addr[16];
u8 peer_addr[16];
u8 is_ipv6;
u8 state;
};
/** \brief Set flags of BFD session
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param bs_index - index of the bfd session to set flags on
@param admin_up_down - set the admin state, 1 = up, 0 = down
*/
define bfd_session_set_flags {
u32 client_index;
u32 context;
u32 bs_index;
u8 admin_up_down;
};
/** \brief Reply to bfd_session_set_flags
@param context - sender context which was passed in the request
@param retval - return code of the set flags request
*/
define bfd_session_set_flags_reply
{
u32 context;
i32 retval;
};
/** \brief Register for BFD events
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param enable_disable - 1 => register for events, 0 => cancel registration
@param pid - sender's pid
*/
define want_bfd_events
{
u32 client_index;
u32 context;
u32 enable_disable;
u32 pid;
};
/** \brief Reply for BFD events registration
@param context - returned sender context, to match reply w/ request
@param retval - return code
*/
define want_bfd_events_reply
{
u32 context;
i32 retval;
};
/*
* Local Variables:
* eval: (c-set-style "gnu")
* End:
*/
|