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
|
// SPDX-License-Identifier: GPL-2.0-or-later
/*
* Copyright (C) 2018 NetDEF, Inc.
* Renato Westphal
*/
#include <zebra.h>
#include "libfrr.h"
#include "log.h"
#include "lib_errors.h"
#include "hash.h"
#include "command.h"
#include "debug.h"
#include "db.h"
#include "frr_pthread.h"
#include "northbound.h"
#include "northbound_cli.h"
#include "northbound_db.h"
#include "frrstr.h"
DEFINE_MTYPE_STATIC(LIB, NB_NODE, "Northbound Node");
DEFINE_MTYPE_STATIC(LIB, NB_CONFIG, "Northbound Configuration");
DEFINE_MTYPE_STATIC(LIB, NB_CONFIG_ENTRY, "Northbound Configuration Entry");
/* Running configuration - shouldn't be modified directly. */
struct nb_config *running_config;
/* Hash table of user pointers associated with configuration entries. */
static struct hash *running_config_entries;
/* Management lock for the running configuration. */
static struct {
/* Mutex protecting this structure. */
pthread_mutex_t mtx;
/* Actual lock. */
bool locked;
/* Northbound client who owns this lock. */
enum nb_client owner_client;
/* Northbound user who owns this lock. */
const void *owner_user;
} running_config_mgmt_lock;
/* Knob to record config transaction */
static bool nb_db_enabled;
/*
* Global lock used to prevent multiple configuration transactions from
* happening concurrently.
*/
static bool transaction_in_progress;
static int nb_callback_pre_validate(struct nb_context *context,
const struct nb_node *nb_node,
const struct lyd_node *dnode, char *errmsg,
size_t errmsg_len);
static int nb_callback_configuration(struct nb_context *context,
const enum nb_event event,
struct nb_config_change *change,
char *errmsg, size_t errmsg_len);
static struct nb_transaction *
nb_transaction_new(struct nb_context context, struct nb_config *config,
struct nb_config_cbs *changes, const char *comment,
char *errmsg, size_t errmsg_len);
static void nb_transaction_free(struct nb_transaction *transaction);
static int nb_transaction_process(enum nb_event event,
struct nb_transaction *transaction,
char *errmsg, size_t errmsg_len);
static void nb_transaction_apply_finish(struct nb_transaction *transaction,
char *errmsg, size_t errmsg_len);
static int nb_oper_data_iter_node(const struct lysc_node *snode,
const char *xpath, const void *list_entry,
const struct yang_list_keys *list_keys,
struct yang_translator *translator,
bool first, uint32_t flags,
nb_oper_data_cb cb, void *arg);
static int nb_node_check_config_only(const struct lysc_node *snode, void *arg)
{
bool *config_only = arg;
if (CHECK_FLAG(snode->flags, LYS_CONFIG_R)) {
*config_only = false;
return YANG_ITER_STOP;
}
return YANG_ITER_CONTINUE;
}
static int nb_node_new_cb(const struct lysc_node *snode, void *arg)
{
struct nb_node *nb_node;
struct lysc_node *sparent, *sparent_list;
struct frr_yang_module_info *module;
module = (struct frr_yang_module_info *)arg;
nb_node = XCALLOC(MTYPE_NB_NODE, sizeof(*nb_node));
yang_snode_get_path(snode, YANG_PATH_DATA, nb_node->xpath,
sizeof(nb_node->xpath));
nb_node->priority = NB_DFLT_PRIORITY;
sparent = yang_snode_real_parent(snode);
if (sparent)
nb_node->parent = sparent->priv;
sparent_list = yang_snode_parent_list(snode);
if (sparent_list)
nb_node->parent_list = sparent_list->priv;
/* Set flags. */
if (CHECK_FLAG(snode->nodetype, LYS_CONTAINER | LYS_LIST)) {
bool config_only = true;
(void)yang_snodes_iterate_subtree(snode, NULL,
nb_node_check_config_only, 0,
&config_only);
if (config_only)
SET_FLAG(nb_node->flags, F_NB_NODE_CONFIG_ONLY);
}
if (CHECK_FLAG(snode->nodetype, LYS_LIST)) {
if (yang_snode_num_keys(snode) == 0)
SET_FLAG(nb_node->flags, F_NB_NODE_KEYLESS_LIST);
}
/*
* Link the northbound node and the libyang schema node with one
* another.
*/
nb_node->snode = snode;
assert(snode->priv == NULL);
((struct lysc_node *)snode)->priv = nb_node;
if (module && module->ignore_cbs)
SET_FLAG(nb_node->flags, F_NB_NODE_IGNORE_CBS);
return YANG_ITER_CONTINUE;
}
static int nb_node_del_cb(const struct lysc_node *snode, void *arg)
{
struct nb_node *nb_node;
nb_node = snode->priv;
if (nb_node) {
((struct lysc_node *)snode)->priv = NULL;
XFREE(MTYPE_NB_NODE, nb_node);
}
return YANG_ITER_CONTINUE;
}
void nb_nodes_create(void)
{
yang_snodes_iterate(NULL, nb_node_new_cb, 0, NULL);
}
void nb_nodes_delete(void)
{
yang_snodes_iterate(NULL, nb_node_del_cb, 0, NULL);
}
struct nb_node *nb_node_find(const char *path)
{
const struct lysc_node *snode;
/*
* Use libyang to find the schema node associated to the path and get
* the northbound node from there (snode private pointer).
*/
snode = lys_find_path(ly_native_ctx, NULL, path, 0);
if (!snode)
return NULL;
return snode->priv;
}
void nb_node_set_dependency_cbs(const char *dependency_xpath,
const char *dependant_xpath,
struct nb_dependency_callbacks *cbs)
{
struct nb_node *dependency = nb_node_find(dependency_xpath);
struct nb_node *dependant = nb_node_find(dependant_xpath);
if (!dependency || !dependant)
return;
dependency->dep_cbs.get_dependant_xpath = cbs->get_dependant_xpath;
dependant->dep_cbs.get_dependency_xpath = cbs->get_dependency_xpath;
}
bool nb_node_has_dependency(struct nb_node *node)
{
return node->dep_cbs.get_dependency_xpath != NULL;
}
static int nb_node_validate_cb(const struct nb_node *nb_node,
enum nb_operation operation,
int callback_implemented, bool optional)
{
bool valid;
valid = nb_operation_is_valid(operation, nb_node->snode);
/*
* Add an exception for operational data callbacks. A rw list usually
* doesn't need any associated operational data callbacks. But if this
* rw list is augmented by another module which adds state nodes under
* it, then this list will need to have the 'get_next()', 'get_keys()'
* and 'lookup_entry()' callbacks. As such, never log a warning when
* these callbacks are implemented when they are not needed, since this
* depends on context (e.g. some daemons might augment "frr-interface"
* while others don't).
*/
if (!valid && callback_implemented && operation != NB_OP_GET_NEXT
&& operation != NB_OP_GET_KEYS && operation != NB_OP_LOOKUP_ENTRY)
flog_warn(EC_LIB_NB_CB_UNNEEDED,
"unneeded '%s' callback for '%s'",
nb_operation_name(operation), nb_node->xpath);
if (!optional && valid && !callback_implemented) {
flog_err(EC_LIB_NB_CB_MISSING, "missing '%s' callback for '%s'",
nb_operation_name(operation), nb_node->xpath);
return 1;
}
return 0;
}
/*
* Check if the required callbacks were implemented for the given northbound
* node.
*/
static unsigned int nb_node_validate_cbs(const struct nb_node *nb_node)
{
unsigned int error = 0;
if (CHECK_FLAG(nb_node->flags, F_NB_NODE_IGNORE_CBS))
return error;
error += nb_node_validate_cb(nb_node, NB_OP_CREATE,
!!nb_node->cbs.create, false);
error += nb_node_validate_cb(nb_node, NB_OP_MODIFY,
!!nb_node->cbs.modify, false);
error += nb_node_validate_cb(nb_node, NB_OP_DESTROY,
!!nb_node->cbs.destroy, false);
error += nb_node_validate_cb(nb_node, NB_OP_MOVE, !!nb_node->cbs.move,
false);
error += nb_node_validate_cb(nb_node, NB_OP_PRE_VALIDATE,
!!nb_node->cbs.pre_validate, true);
error += nb_node_validate_cb(nb_node, NB_OP_APPLY_FINISH,
!!nb_node->cbs.apply_finish, true);
error += nb_node_validate_cb(nb_node, NB_OP_GET_ELEM,
!!nb_node->cbs.get_elem, false);
error += nb_node_validate_cb(nb_node, NB_OP_GET_NEXT,
!!nb_node->cbs.get_next, false);
error += nb_node_validate_cb(nb_node, NB_OP_GET_KEYS,
!!nb_node->cbs.get_keys, false);
error += nb_node_validate_cb(nb_node, NB_OP_LOOKUP_ENTRY,
!!nb_node->cbs.lookup_entry, false);
error += nb_node_validate_cb(nb_node, NB_OP_RPC, !!nb_node->cbs.rpc,
false);
return error;
}
static unsigned int nb_node_validate_priority(const struct nb_node *nb_node)
{
/* Top-level nodes can have any priority. */
if (!nb_node->parent)
return 0;
if (nb_node->priority < nb_node->parent->priority) {
flog_err(EC_LIB_NB_CB_INVALID_PRIO,
"node has higher priority than its parent [xpath %s]",
nb_node->xpath);
return 1;
}
return 0;
}
static int nb_node_validate(const struct lysc_node *snode, void *arg)
{
struct nb_node *nb_node = snode->priv;
unsigned int *errors = arg;
/* Validate callbacks and priority. */
if (nb_node) {
*errors += nb_node_validate_cbs(nb_node);
*errors += nb_node_validate_priority(nb_node);
}
return YANG_ITER_CONTINUE;
}
struct nb_config *nb_config_new(struct lyd_node *dnode)
{
struct nb_config *config;
config = XCALLOC(MTYPE_NB_CONFIG, sizeof(*config));
if (dnode)
config->dnode = dnode;
else
config->dnode = yang_dnode_new(ly_native_ctx, true);
config->version = 0;
RB_INIT(nb_config_cbs, &config->cfg_chgs);
return config;
}
void nb_config_free(struct nb_config *config)
{
if (config->dnode)
yang_dnode_free(config->dnode);
nb_config_diff_del_changes(&config->cfg_chgs);
XFREE(MTYPE_NB_CONFIG, config);
}
struct nb_config *nb_config_dup(const struct nb_config *config)
{
struct nb_config *dup;
dup = XCALLOC(MTYPE_NB_CONFIG, sizeof(*dup));
dup->dnode = yang_dnode_dup(config->dnode);
dup->version = config->version;
RB_INIT(nb_config_cbs, &dup->cfg_chgs);
return dup;
}
int nb_config_merge(struct nb_config *config_dst, struct nb_config *config_src,
bool preserve_source)
{
int ret;
ret = lyd_merge_siblings(&config_dst->dnode, config_src->dnode, 0);
if (ret != 0)
flog_warn(EC_LIB_LIBYANG, "%s: lyd_merge() failed", __func__);
if (!preserve_source)
nb_config_free(config_src);
return (ret == 0) ? NB_OK : NB_ERR;
}
void nb_config_replace(struct nb_config *config_dst,
struct nb_config *config_src, bool preserve_source)
{
/* Update version. */
if (config_src->version != 0)
config_dst->version = config_src->version;
/* Update dnode. */
if (config_dst->dnode)
yang_dnode_free(config_dst->dnode);
if (preserve_source) {
config_dst->dnode = yang_dnode_dup(config_src->dnode);
} else {
config_dst->dnode = config_src->dnode;
config_src->dnode = NULL;
nb_config_free(config_src);
}
}
/* Generate the nb_config_cbs tree. */
static inline int nb_config_cb_compare(const struct nb_config_cb *a,
const struct nb_config_cb *b)
{
/* Sort by priority first. */
if (a->nb_node->priority < b->nb_node->priority)
return -1;
if (a->nb_node->priority > b->nb_node->priority)
return 1;
/*
* Preserve the order of the configuration changes as told by libyang.
*/
if (a->seq < b->seq)
return -1;
if (a->seq > b->seq)
return 1;
/*
* All 'apply_finish' callbacks have their sequence number set to zero.
* In this case, compare them using their dnode pointers (the order
* doesn't matter for callbacks that have the same priority).
*/
if (a->dnode < b->dnode)
return -1;
if (a->dnode > b->dnode)
return 1;
return 0;
}
RB_GENERATE(nb_config_cbs, nb_config_cb, entry, nb_config_cb_compare);
static void nb_config_diff_add_change(struct nb_config_cbs *changes,
enum nb_operation operation,
uint32_t *seq,
const struct lyd_node *dnode)
{
struct nb_config_change *change;
/* Ignore unimplemented nodes. */
if (!dnode->schema->priv)
return;
change = XCALLOC(MTYPE_TMP, sizeof(*change));
change->cb.operation = operation;
change->cb.seq = *seq;
*seq = *seq + 1;
change->cb.nb_node = dnode->schema->priv;
change->cb.dnode = dnode;
RB_INSERT(nb_config_cbs, changes, &change->cb);
}
void nb_config_diff_del_changes(struct nb_config_cbs *changes)
{
while (!RB_EMPTY(nb_config_cbs, changes)) {
struct nb_config_change *change;
change = (struct nb_config_change *)RB_ROOT(nb_config_cbs,
changes);
RB_REMOVE(nb_config_cbs, changes, &change->cb);
XFREE(MTYPE_TMP, change);
}
}
/*
* Helper function used when calculating the delta between two different
* configurations. Given a new subtree, calculate all new YANG data nodes,
* excluding default leafs and leaf-lists. This is a recursive function.
*/
void nb_config_diff_created(const struct lyd_node *dnode, uint32_t *seq,
struct nb_config_cbs *changes)
{
enum nb_operation operation;
struct lyd_node *child;
/* Ignore unimplemented nodes. */
if (!dnode->schema->priv)
return;
switch (dnode->schema->nodetype) {
case LYS_LEAF:
case LYS_LEAFLIST:
if (lyd_is_default(dnode))
break;
if (nb_operation_is_valid(NB_OP_CREATE, dnode->schema))
operation = NB_OP_CREATE;
else if (nb_operation_is_valid(NB_OP_MODIFY, dnode->schema))
operation = NB_OP_MODIFY;
else
return;
nb_config_diff_add_change(changes, operation, seq, dnode);
break;
case LYS_CONTAINER:
case LYS_LIST:
if (nb_operation_is_valid(NB_OP_CREATE, dnode->schema))
nb_config_diff_add_change(changes, NB_OP_CREATE, seq,
dnode);
/* Process child nodes recursively. */
LY_LIST_FOR (lyd_child(dnode), child) {
nb_config_diff_created(child, seq, changes);
}
break;
default:
break;
}
}
static void nb_config_diff_deleted(const struct lyd_node *dnode, uint32_t *seq,
struct nb_config_cbs *changes)
{
/* Ignore unimplemented nodes. */
if (!dnode->schema->priv)
return;
if (nb_operation_is_valid(NB_OP_DESTROY, dnode->schema))
nb_config_diff_add_change(changes, NB_OP_DESTROY, seq, dnode);
else if (CHECK_FLAG(dnode->schema->nodetype, LYS_CONTAINER)) {
struct lyd_node *child;
/*
* Non-presence containers need special handling since they
* don't have "destroy" callbacks. In this case, what we need to
* do is to call the "destroy" callbacks of their child nodes
* when applicable (i.e. optional nodes).
*/
LY_LIST_FOR (lyd_child(dnode), child) {
nb_config_diff_deleted(child, seq, changes);
}
}
}
static int nb_lyd_diff_get_op(const struct lyd_node *dnode)
{
const struct lyd_meta *meta;
LY_LIST_FOR (dnode->meta, meta) {
if (strcmp(meta->name, "operation")
|| strcmp(meta->annotation->module->name, "yang"))
continue;
return lyd_get_meta_value(meta)[0];
}
return 'n';
}
#if 0 /* Used below in nb_config_diff inside normally disabled code */
static inline void nb_config_diff_dnode_log_path(const char *context,
const char *path,
const struct lyd_node *dnode)
{
if (dnode->schema->nodetype & LYD_NODE_TERM)
zlog_debug("nb_config_diff: %s: %s: %s", context, path,
lyd_get_value(dnode));
else
zlog_debug("nb_config_diff: %s: %s", context, path);
}
static inline void nb_config_diff_dnode_log(const char *context,
const struct lyd_node *dnode)
{
if (!dnode) {
zlog_debug("nb_config_diff: %s: NULL", context);
return;
}
char *path = lyd_path(dnode, LYD_PATH_STD, NULL, 0);
nb_config_diff_dnode_log_path(context, path, dnode);
free(path);
}
#endif
/*
* Calculate the delta between two different configurations.
*
* NOTE: 'config1' is the reference DB, while 'config2' is
* the DB being compared against 'config1'. Typically 'config1'
* should be the Running DB and 'config2' is the Candidate DB.
*/
void nb_config_diff(const struct nb_config *config1,
const struct nb_config *config2,
struct nb_config_cbs *changes)
{
struct lyd_node *diff = NULL;
const struct lyd_node *root, *dnode;
struct lyd_node *target;
int op;
LY_ERR err;
char *path;
#if 0 /* Useful (noisy) when debugging diff code, and for improving later */
if (DEBUG_MODE_CHECK(&nb_dbg_cbs_config, DEBUG_MODE_ALL)) {
LY_LIST_FOR(config1->dnode, root) {
LYD_TREE_DFS_BEGIN(root, dnode) {
nb_config_diff_dnode_log("from", dnode);
LYD_TREE_DFS_END(root, dnode);
}
}
LY_LIST_FOR(config2->dnode, root) {
LYD_TREE_DFS_BEGIN(root, dnode) {
nb_config_diff_dnode_log("to", dnode);
LYD_TREE_DFS_END(root, dnode);
}
}
}
#endif
err = lyd_diff_siblings(config1->dnode, config2->dnode,
LYD_DIFF_DEFAULTS, &diff);
assert(!err);
if (diff && DEBUG_MODE_CHECK(&nb_dbg_cbs_config, DEBUG_MODE_ALL)) {
char *s;
if (!lyd_print_mem(&s, diff, LYD_JSON,
LYD_PRINT_WITHSIBLINGS | LYD_PRINT_WD_ALL)) {
zlog_debug("%s: %s", __func__, s);
free(s);
}
}
uint32_t seq = 0;
LY_LIST_FOR (diff, root) {
LYD_TREE_DFS_BEGIN (root, dnode) {
op = nb_lyd_diff_get_op(dnode);
path = lyd_path(dnode, LYD_PATH_STD, NULL, 0);
#if 0 /* Useful (noisy) when debugging diff code, and for improving later */
if (DEBUG_MODE_CHECK(&nb_dbg_cbs_config, DEBUG_MODE_ALL)) {
char context[80];
snprintf(context, sizeof(context),
"iterating diff: oper: %c seq: %u", op, seq);
nb_config_diff_dnode_log_path(context, path, dnode);
}
#endif
switch (op) {
case 'c': /* create */
/*
* This is rather inefficient, but when we use
* dnode from the diff instead of the
* candidate config node we get failures when
* looking up default values, etc, based on
* the diff tree.
*/
target = yang_dnode_get(config2->dnode, path);
assert(target);
nb_config_diff_created(target, &seq, changes);
/* Skip rest of sub-tree, move to next sibling
*/
LYD_TREE_DFS_continue = 1;
break;
case 'd': /* delete */
target = yang_dnode_get(config1->dnode, path);
assert(target);
nb_config_diff_deleted(target, &seq, changes);
/* Skip rest of sub-tree, move to next sibling
*/
LYD_TREE_DFS_continue = 1;
break;
case 'r': /* replace */
/* either moving an entry or changing a value */
target = yang_dnode_get(config2->dnode, path);
assert(target);
nb_config_diff_add_change(changes, NB_OP_MODIFY,
&seq, target);
break;
case 'n': /* none */
default:
break;
}
free(path);
LYD_TREE_DFS_END(root, dnode);
}
}
lyd_free_all(diff);
}
int nb_candidate_edit(struct nb_config *candidate,
const struct nb_node *nb_node,
enum nb_operation operation, const char *xpath,
const struct yang_data *previous,
const struct yang_data *data)
{
struct lyd_node *dnode, *dep_dnode;
char xpath_edit[XPATH_MAXLEN];
char dep_xpath[XPATH_MAXLEN];
LY_ERR err;
/* Use special notation for leaf-lists (RFC 6020, section 9.13.5). */
if (nb_node->snode->nodetype == LYS_LEAFLIST)
snprintf(xpath_edit, sizeof(xpath_edit), "%s[.='%s']", xpath,
data->value);
else
strlcpy(xpath_edit, xpath, sizeof(xpath_edit));
switch (operation) {
case NB_OP_CREATE:
case NB_OP_MODIFY:
err = lyd_new_path(candidate->dnode, ly_native_ctx, xpath_edit,
(void *)data->value, LYD_NEW_PATH_UPDATE,
&dnode);
if (err) {
flog_warn(EC_LIB_LIBYANG,
"%s: lyd_new_path(%s) failed: %d", __func__,
xpath_edit, err);
return NB_ERR;
} else if (dnode) {
/* Create default nodes */
LY_ERR err = lyd_new_implicit_tree(
dnode, LYD_IMPLICIT_NO_STATE, NULL);
if (err) {
flog_warn(EC_LIB_LIBYANG,
"%s: lyd_new_implicit_all failed: %d",
__func__, err);
}
/*
* create dependency
*
* dnode returned by the lyd_new_path may be from a
* different schema, so we need to update the nb_node
*/
nb_node = dnode->schema->priv;
if (nb_node->dep_cbs.get_dependency_xpath) {
nb_node->dep_cbs.get_dependency_xpath(
dnode, dep_xpath);
err = lyd_new_path(candidate->dnode,
ly_native_ctx, dep_xpath,
NULL, LYD_NEW_PATH_UPDATE,
&dep_dnode);
/* Create default nodes */
if (!err && dep_dnode)
err = lyd_new_implicit_tree(
dep_dnode,
LYD_IMPLICIT_NO_STATE, NULL);
if (err) {
flog_warn(
EC_LIB_LIBYANG,
"%s: dependency: lyd_new_path(%s) failed: %d",
__func__, dep_xpath, err);
return NB_ERR;
}
}
}
break;
case NB_OP_DESTROY:
dnode = yang_dnode_get(candidate->dnode, xpath_edit);
if (!dnode)
/*
* Return a special error code so the caller can choose
* whether to ignore it or not.
*/
return NB_ERR_NOT_FOUND;
/* destroy dependant */
if (nb_node->dep_cbs.get_dependant_xpath) {
nb_node->dep_cbs.get_dependant_xpath(dnode, dep_xpath);
dep_dnode = yang_dnode_get(candidate->dnode, dep_xpath);
if (dep_dnode)
lyd_free_tree(dep_dnode);
}
lyd_free_tree(dnode);
break;
case NB_OP_MOVE:
/* TODO: update configuration. */
break;
case NB_OP_PRE_VALIDATE:
case NB_OP_APPLY_FINISH:
case NB_OP_GET_ELEM:
case NB_OP_GET_NEXT:
case NB_OP_GET_KEYS:
case NB_OP_LOOKUP_ENTRY:
case NB_OP_RPC:
flog_warn(EC_LIB_DEVELOPMENT,
"%s: unknown operation (%u) [xpath %s]", __func__,
operation, xpath_edit);
return NB_ERR;
}
return NB_OK;
}
static void nb_update_candidate_changes(struct nb_config *candidate,
struct nb_cfg_change *change,
uint32_t *seq)
{
enum nb_operation oper = change->operation;
char *xpath = change->xpath;
struct lyd_node *root = NULL;
struct lyd_node *dnode;
struct nb_config_cbs *cfg_chgs = &candidate->cfg_chgs;
int op;
switch (oper) {
case NB_OP_CREATE:
case NB_OP_MODIFY:
root = yang_dnode_get(candidate->dnode, xpath);
break;
case NB_OP_DESTROY:
root = yang_dnode_get(running_config->dnode, xpath);
/* code */
break;
case NB_OP_MOVE:
case NB_OP_PRE_VALIDATE:
case NB_OP_APPLY_FINISH:
case NB_OP_GET_ELEM:
case NB_OP_GET_NEXT:
case NB_OP_GET_KEYS:
case NB_OP_LOOKUP_ENTRY:
case NB_OP_RPC:
break;
default:
assert(!"non-enum value, invalid");
}
if (!root)
return;
LYD_TREE_DFS_BEGIN (root, dnode) {
op = nb_lyd_diff_get_op(dnode);
switch (op) {
case 'c':
nb_config_diff_created(dnode, seq, cfg_chgs);
LYD_TREE_DFS_continue = 1;
break;
case 'd':
nb_config_diff_deleted(dnode, seq, cfg_chgs);
LYD_TREE_DFS_continue = 1;
break;
case 'r':
nb_config_diff_add_change(cfg_chgs, NB_OP_MODIFY, seq,
dnode);
break;
default:
break;
}
LYD_TREE_DFS_END(root, dnode);
}
}
static bool nb_is_operation_allowed(struct nb_node *nb_node,
struct nb_cfg_change *change)
{
enum nb_operation oper = change->operation;
if (lysc_is_key(nb_node->snode)) {
if (oper == NB_OP_MODIFY || oper == NB_OP_DESTROY)
return false;
}
return true;
}
void nb_candidate_edit_config_changes(
struct nb_config *candidate_config, struct nb_cfg_change cfg_changes[],
size_t num_cfg_changes, const char *xpath_base, const char *curr_xpath,
int xpath_index, char *err_buf, int err_bufsize, bool *error)
{
uint32_t seq = 0;
if (error)
*error = false;
if (xpath_base == NULL)
xpath_base = "";
/* Edit candidate configuration. */
for (size_t i = 0; i < num_cfg_changes; i++) {
struct nb_cfg_change *change = &cfg_changes[i];
struct nb_node *nb_node;
char xpath[XPATH_MAXLEN];
struct yang_data *data;
int ret;
/* Handle relative XPaths. */
memset(xpath, 0, sizeof(xpath));
if (xpath_index > 0 &&
(xpath_base[0] == '.' || change->xpath[0] == '.'))
strlcpy(xpath, curr_xpath, sizeof(xpath));
if (xpath_base[0]) {
if (xpath_base[0] == '.')
strlcat(xpath, xpath_base + 1, sizeof(xpath));
else
strlcat(xpath, xpath_base, sizeof(xpath));
}
if (change->xpath[0] == '.')
strlcat(xpath, change->xpath + 1, sizeof(xpath));
else
strlcpy(xpath, change->xpath, sizeof(xpath));
/* Find the northbound node associated to the data path. */
nb_node = nb_node_find(xpath);
if (!nb_node) {
flog_warn(EC_LIB_YANG_UNKNOWN_DATA_PATH,
"%s: unknown data path: %s", __func__, xpath);
if (error)
*error = true;
continue;
}
/* Find if the node to be edited is not a key node */
if (!nb_is_operation_allowed(nb_node, change)) {
zlog_err(" Xpath %s points to key node", xpath);
if (error)
*error = true;
break;
}
/* If the value is not set, get the default if it exists. */
if (change->value == NULL)
change->value = yang_snode_get_default(nb_node->snode);
data = yang_data_new(xpath, change->value);
/*
* Ignore "not found" errors when editing the candidate
* configuration.
*/
ret = nb_candidate_edit(candidate_config, nb_node,
change->operation, xpath, NULL, data);
yang_data_free(data);
if (ret != NB_OK && ret != NB_ERR_NOT_FOUND) {
flog_warn(
EC_LIB_NB_CANDIDATE_EDIT_ERROR,
"%s: failed to edit candidate configuration: operation [%s] xpath [%s]",
__func__, nb_operation_name(change->operation),
xpath);
if (error)
*error = true;
continue;
}
nb_update_candidate_changes(candidate_config, change, &seq);
}
if (error && *error) {
char buf[BUFSIZ];
/*
* Failure to edit the candidate configuration should never
* happen in practice, unless there's a bug in the code. When
* that happens, log the error but otherwise ignore it.
*/
snprintf(err_buf, err_bufsize,
"%% Failed to edit configuration.\n\n%s",
yang_print_errors(ly_native_ctx, buf, sizeof(buf)));
}
}
bool nb_candidate_needs_update(const struct nb_config *candidate)
{
if (candidate->version < running_config->version)
return true;
return false;
}
int nb_candidate_update(struct nb_config *candidate)
{
struct nb_config *updated_config;
updated_config = nb_config_dup(running_config);
if (nb_config_merge(updated_config, candidate, true) != NB_OK)
return NB_ERR;
nb_config_replace(candidate, updated_config, false);
return NB_OK;
}
/*
* Perform YANG syntactic and semantic validation.
*
* WARNING: lyd_validate() can change the configuration as part of the
* validation process.
*/
int nb_candidate_validate_yang(struct nb_config *candidate, bool no_state,
char *errmsg, size_t errmsg_len)
{
if (lyd_validate_all(&candidate->dnode, ly_native_ctx,
no_state ? LYD_VALIDATE_NO_STATE
: LYD_VALIDATE_PRESENT,
NULL) != 0) {
yang_print_errors(ly_native_ctx, errmsg, errmsg_len);
return NB_ERR_VALIDATION;
}
return NB_OK;
}
/* Perform code-level validation using the northbound callbacks. */
int nb_candidate_validate_code(struct nb_context *context,
struct nb_config *candidate,
struct nb_config_cbs *changes, char *errmsg,
size_t errmsg_len)
{
struct nb_config_cb *cb;
struct lyd_node *root, *child;
int ret;
/* First validate the candidate as a whole. */
LY_LIST_FOR (candidate->dnode, root) {
LYD_TREE_DFS_BEGIN (root, child) {
struct nb_node *nb_node;
nb_node = child->schema->priv;
if (!nb_node || !nb_node->cbs.pre_validate)
goto next;
ret = nb_callback_pre_validate(context, nb_node, child,
errmsg, errmsg_len);
if (ret != NB_OK)
return NB_ERR_VALIDATION;
next:
LYD_TREE_DFS_END(root, child);
}
}
/* Now validate the configuration changes. */
RB_FOREACH (cb, nb_config_cbs, changes) {
struct nb_config_change *change = (struct nb_config_change *)cb;
ret = nb_callback_configuration(context, NB_EV_VALIDATE, change,
errmsg, errmsg_len);
if (ret != NB_OK)
return NB_ERR_VALIDATION;
}
return NB_OK;
}
int nb_candidate_diff_and_validate_yang(struct nb_context *context,
struct nb_config *candidate,
struct nb_config_cbs *changes,
char *errmsg, size_t errmsg_len)
{
if (nb_candidate_validate_yang(candidate, true, errmsg,
sizeof(errmsg_len)) != NB_OK)
return NB_ERR_VALIDATION;
RB_INIT(nb_config_cbs, changes);
nb_config_diff(running_config, candidate, changes);
return NB_OK;
}
int nb_candidate_validate(struct nb_context *context,
struct nb_config *candidate, char *errmsg,
size_t errmsg_len)
{
struct nb_config_cbs changes;
int ret;
ret = nb_candidate_diff_and_validate_yang(context, candidate, &changes,
errmsg, errmsg_len);
if (ret != NB_OK)
return ret;
ret = nb_candidate_validate_code(context, candidate, &changes, errmsg,
errmsg_len);
nb_config_diff_del_changes(&changes);
return ret;
}
int nb_candidate_commit_prepare(struct nb_context context,
struct nb_config *candidate,
const char *comment,
struct nb_transaction **transaction,
bool skip_validate, bool ignore_zero_change,
char *errmsg, size_t errmsg_len)
{
struct nb_config_cbs changes;
if (!skip_validate &&
nb_candidate_validate_yang(candidate, true, errmsg, errmsg_len) !=
NB_OK) {
flog_warn(EC_LIB_NB_CANDIDATE_INVALID,
"%s: failed to validate candidate configuration",
__func__);
return NB_ERR_VALIDATION;
}
RB_INIT(nb_config_cbs, &changes);
nb_config_diff(running_config, candidate, &changes);
if (!ignore_zero_change && RB_EMPTY(nb_config_cbs, &changes)) {
snprintf(
errmsg, errmsg_len,
"No changes to apply were found during preparation phase");
return NB_ERR_NO_CHANGES;
}
if (!skip_validate &&
nb_candidate_validate_code(&context, candidate, &changes, errmsg,
errmsg_len) != NB_OK) {
flog_warn(EC_LIB_NB_CANDIDATE_INVALID,
"%s: failed to validate candidate configuration",
__func__);
nb_config_diff_del_changes(&changes);
return NB_ERR_VALIDATION;
}
/*
* Re-use an existing transaction if provided. Else allocate a new one.
*/
if (!*transaction)
*transaction = nb_transaction_new(context, candidate, &changes,
comment, errmsg, errmsg_len);
if (*transaction == NULL) {
flog_warn(EC_LIB_NB_TRANSACTION_CREATION_FAILED,
"%s: failed to create transaction: %s", __func__,
errmsg);
nb_config_diff_del_changes(&changes);
return NB_ERR_LOCKED;
}
return nb_transaction_process(NB_EV_PREPARE, *transaction, errmsg,
errmsg_len);
}
void nb_candidate_commit_abort(struct nb_transaction *transaction, char *errmsg,
size_t errmsg_len)
{
(void)nb_transaction_process(NB_EV_ABORT, transaction, errmsg,
errmsg_len);
nb_transaction_free(transaction);
}
void nb_candidate_commit_apply(struct nb_transaction *transaction,
bool save_transaction, uint32_t *transaction_id,
char *errmsg, size_t errmsg_len)
{
(void)nb_transaction_process(NB_EV_APPLY, transaction, errmsg,
errmsg_len);
nb_transaction_apply_finish(transaction, errmsg, errmsg_len);
/* Replace running by candidate. */
transaction->config->version++;
nb_config_replace(running_config, transaction->config, true);
/* Record transaction. */
if (save_transaction && nb_db_enabled
&& nb_db_transaction_save(transaction, transaction_id) != NB_OK)
flog_warn(EC_LIB_NB_TRANSACTION_RECORD_FAILED,
"%s: failed to record transaction", __func__);
nb_transaction_free(transaction);
}
int nb_candidate_commit(struct nb_context context, struct nb_config *candidate,
bool save_transaction, const char *comment,
uint32_t *transaction_id, char *errmsg,
size_t errmsg_len)
{
struct nb_transaction *transaction = NULL;
int ret;
ret = nb_candidate_commit_prepare(context, candidate, comment,
&transaction, false, false, errmsg,
errmsg_len);
/*
* Apply the changes if the preparation phase succeeded. Otherwise abort
* the transaction.
*/
if (ret == NB_OK)
nb_candidate_commit_apply(transaction, save_transaction,
transaction_id, errmsg, errmsg_len);
else if (transaction != NULL)
nb_candidate_commit_abort(transaction, errmsg, errmsg_len);
return ret;
}
int nb_running_lock(enum nb_client client, const void *user)
{
int ret = -1;
frr_with_mutex (&running_config_mgmt_lock.mtx) {
if (!running_config_mgmt_lock.locked) {
running_config_mgmt_lock.locked = true;
running_config_mgmt_lock.owner_client = client;
running_config_mgmt_lock.owner_user = user;
ret = 0;
}
}
return ret;
}
int nb_running_unlock(enum nb_client client, const void *user)
{
int ret = -1;
frr_with_mutex (&running_config_mgmt_lock.mtx) {
if (running_config_mgmt_lock.locked
&& running_config_mgmt_lock.owner_client == client
&& running_config_mgmt_lock.owner_user == user) {
running_config_mgmt_lock.locked = false;
running_config_mgmt_lock.owner_client = NB_CLIENT_NONE;
running_config_mgmt_lock.owner_user = NULL;
ret = 0;
}
}
return ret;
}
int nb_running_lock_check(enum nb_client client, const void *user)
{
int ret = -1;
frr_with_mutex (&running_config_mgmt_lock.mtx) {
if (!running_config_mgmt_lock.locked
|| (running_config_mgmt_lock.owner_client == client
&& running_config_mgmt_lock.owner_user == user))
ret = 0;
}
return ret;
}
static void nb_log_config_callback(const enum nb_event event,
enum nb_operation operation,
const struct lyd_node *dnode)
{
const char *value;
char xpath[XPATH_MAXLEN];
if (!DEBUG_MODE_CHECK(&nb_dbg_cbs_config, DEBUG_MODE_ALL))
return;
yang_dnode_get_path(dnode, xpath, sizeof(xpath));
if (yang_snode_is_typeless_data(dnode->schema))
value = "(none)";
else
value = yang_dnode_get_string(dnode, NULL);
zlog_debug(
"northbound callback: event [%s] op [%s] xpath [%s] value [%s]",
nb_event_name(event), nb_operation_name(operation), xpath,
value);
}
static int nb_callback_create(struct nb_context *context,
const struct nb_node *nb_node,
enum nb_event event, const struct lyd_node *dnode,
union nb_resource *resource, char *errmsg,
size_t errmsg_len)
{
struct nb_cb_create_args args = {};
bool unexpected_error = false;
int ret;
assert(!CHECK_FLAG(nb_node->flags, F_NB_NODE_IGNORE_CBS));
nb_log_config_callback(event, NB_OP_CREATE, dnode);
args.context = context;
args.event = event;
args.dnode = dnode;
args.resource = resource;
args.errmsg = errmsg;
args.errmsg_len = errmsg_len;
ret = nb_node->cbs.create(&args);
/* Detect and log unexpected errors. */
switch (ret) {
case NB_OK:
case NB_ERR:
break;
case NB_ERR_VALIDATION:
if (event != NB_EV_VALIDATE)
unexpected_error = true;
break;
case NB_ERR_RESOURCE:
if (event != NB_EV_PREPARE)
unexpected_error = true;
break;
case NB_ERR_INCONSISTENCY:
if (event == NB_EV_VALIDATE)
unexpected_error = true;
break;
default:
unexpected_error = true;
break;
}
if (unexpected_error)
DEBUGD(&nb_dbg_cbs_config,
"northbound callback: unexpected return value: %s",
nb_err_name(ret));
return ret;
}
static int nb_callback_modify(struct nb_context *context,
const struct nb_node *nb_node,
enum nb_event event, const struct lyd_node *dnode,
union nb_resource *resource, char *errmsg,
size_t errmsg_len)
{
struct nb_cb_modify_args args = {};
bool unexpected_error = false;
int ret;
assert(!CHECK_FLAG(nb_node->flags, F_NB_NODE_IGNORE_CBS));
nb_log_config_callback(event, NB_OP_MODIFY, dnode);
args.context = context;
args.event = event;
args.dnode = dnode;
args.resource = resource;
args.errmsg = errmsg;
args.errmsg_len = errmsg_len;
ret = nb_node->cbs.modify(&args);
/* Detect and log unexpected errors. */
switch (ret) {
case NB_OK:
case NB_ERR:
break;
case NB_ERR_VALIDATION:
if (event != NB_EV_VALIDATE)
unexpected_error = true;
break;
case NB_ERR_RESOURCE:
if (event != NB_EV_PREPARE)
unexpected_error = true;
break;
case NB_ERR_INCONSISTENCY:
if (event == NB_EV_VALIDATE)
unexpected_error = true;
break;
default:
unexpected_error = true;
break;
}
if (unexpected_error)
DEBUGD(&nb_dbg_cbs_config,
"northbound callback: unexpected return value: %s",
nb_err_name(ret));
return ret;
}
static int nb_callback_destroy(struct nb_context *context,
const struct nb_node *nb_node,
enum nb_event event,
const struct lyd_node *dnode, char *errmsg,
size_t errmsg_len)
{
struct nb_cb_destroy_args args = {};
bool unexpected_error = false;
int ret;
assert(!CHECK_FLAG(nb_node->flags, F_NB_NODE_IGNORE_CBS));
nb_log_config_callback(event, NB_OP_DESTROY, dnode);
args.context = context;
args.event = event;
args.dnode = dnode;
args.errmsg = errmsg;
args.errmsg_len = errmsg_len;
ret = nb_node->cbs.destroy(&args);
/* Detect and log unexpected errors. */
switch (ret) {
case NB_OK:
case NB_ERR:
break;
case NB_ERR_VALIDATION:
if (event != NB_EV_VALIDATE)
unexpected_error = true;
break;
case NB_ERR_INCONSISTENCY:
if (event == NB_EV_VALIDATE)
unexpected_error = true;
break;
default:
unexpected_error = true;
break;
}
if (unexpected_error)
DEBUGD(&nb_dbg_cbs_config,
"northbound callback: unexpected return value: %s",
nb_err_name(ret));
return ret;
}
static int nb_callback_move(struct nb_context *context,
const struct nb_node *nb_node, enum nb_event event,
const struct lyd_node *dnode, char *errmsg,
size_t errmsg_len)
{
struct nb_cb_move_args args = {};
bool unexpected_error = false;
int ret;
assert(!CHECK_FLAG(nb_node->flags, F_NB_NODE_IGNORE_CBS));
nb_log_config_callback(event, NB_OP_MOVE, dnode);
args.context = context;
args.event = event;
args.dnode = dnode;
args.errmsg = errmsg;
args.errmsg_len = errmsg_len;
ret = nb_node->cbs.move(&args);
/* Detect and log unexpected errors. */
switch (ret) {
case NB_OK:
case NB_ERR:
break;
case NB_ERR_VALIDATION:
if (event != NB_EV_VALIDATE)
unexpected_error = true;
break;
case NB_ERR_INCONSISTENCY:
if (event == NB_EV_VALIDATE)
unexpected_error = true;
break;
default:
unexpected_error = true;
break;
}
if (unexpected_error)
DEBUGD(&nb_dbg_cbs_config,
"northbound callback: unexpected return value: %s",
nb_err_name(ret));
return ret;
}
static int nb_callback_pre_validate(struct nb_context *context,
const struct nb_node *nb_node,
const struct lyd_node *dnode, char *errmsg,
size_t errmsg_len)
{
struct nb_cb_pre_validate_args args = {};
bool unexpected_error = false;
int ret;
if (CHECK_FLAG(nb_node->flags, F_NB_NODE_IGNORE_CBS))
return 0;
nb_log_config_callback(NB_EV_VALIDATE, NB_OP_PRE_VALIDATE, dnode);
args.dnode = dnode;
args.errmsg = errmsg;
args.errmsg_len = errmsg_len;
ret = nb_node->cbs.pre_validate(&args);
/* Detect and log unexpected errors. */
switch (ret) {
case NB_OK:
case NB_ERR_VALIDATION:
break;
default:
unexpected_error = true;
break;
}
if (unexpected_error)
DEBUGD(&nb_dbg_cbs_config,
"northbound callback: unexpected return value: %s",
nb_err_name(ret));
return ret;
}
static void nb_callback_apply_finish(struct nb_context *context,
const struct nb_node *nb_node,
const struct lyd_node *dnode, char *errmsg,
size_t errmsg_len)
{
struct nb_cb_apply_finish_args args = {};
if (CHECK_FLAG(nb_node->flags, F_NB_NODE_IGNORE_CBS))
return;
nb_log_config_callback(NB_EV_APPLY, NB_OP_APPLY_FINISH, dnode);
args.context = context;
args.dnode = dnode;
args.errmsg = errmsg;
args.errmsg_len = errmsg_len;
nb_node->cbs.apply_finish(&args);
}
struct yang_data *nb_callback_get_elem(const struct nb_node *nb_node,
const char *xpath,
const void *list_entry)
{
struct nb_cb_get_elem_args args = {};
if (CHECK_FLAG(nb_node->flags, F_NB_NODE_IGNORE_CBS))
return NULL;
DEBUGD(&nb_dbg_cbs_state,
"northbound callback (get_elem): xpath [%s] list_entry [%p]",
xpath, list_entry);
args.xpath = xpath;
args.list_entry = list_entry;
return nb_node->cbs.get_elem(&args);
}
const void *nb_callback_get_next(const struct nb_node *nb_node,
const void *parent_list_entry,
const void *list_entry)
{
struct nb_cb_get_next_args args = {};
if (CHECK_FLAG(nb_node->flags, F_NB_NODE_IGNORE_CBS))
return NULL;
DEBUGD(&nb_dbg_cbs_state,
"northbound callback (get_next): node [%s] parent_list_entry [%p] list_entry [%p]",
nb_node->xpath, parent_list_entry, list_entry);
args.parent_list_entry = parent_list_entry;
args.list_entry = list_entry;
return nb_node->cbs.get_next(&args);
}
int nb_callback_get_keys(const struct nb_node *nb_node, const void *list_entry,
struct yang_list_keys *keys)
{
struct nb_cb_get_keys_args args = {};
if (CHECK_FLAG(nb_node->flags, F_NB_NODE_IGNORE_CBS))
return 0;
DEBUGD(&nb_dbg_cbs_state,
"northbound callback (get_keys): node [%s] list_entry [%p]",
nb_node->xpath, list_entry);
args.list_entry = list_entry;
args.keys = keys;
return nb_node->cbs.get_keys(&args);
}
const void *nb_callback_lookup_entry(const struct nb_node *nb_node,
const void *parent_list_entry,
const struct yang_list_keys *keys)
{
struct nb_cb_lookup_entry_args args = {};
if (CHECK_FLAG(nb_node->flags, F_NB_NODE_IGNORE_CBS))
return NULL;
DEBUGD(&nb_dbg_cbs_state,
"northbound callback (lookup_entry): node [%s] parent_list_entry [%p]",
nb_node->xpath, parent_list_entry);
args.parent_list_entry = parent_list_entry;
args.keys = keys;
return nb_node->cbs.lookup_entry(&args);
}
int nb_callback_rpc(const struct nb_node *nb_node, const char *xpath,
const struct list *input, struct list *output, char *errmsg,
size_t errmsg_len)
{
struct nb_cb_rpc_args args = {};
if (CHECK_FLAG(nb_node->flags, F_NB_NODE_IGNORE_CBS))
return 0;
DEBUGD(&nb_dbg_cbs_rpc, "northbound RPC: %s", xpath);
args.xpath = xpath;
args.input = input;
args.output = output;
args.errmsg = errmsg;
args.errmsg_len = errmsg_len;
return nb_node->cbs.rpc(&args);
}
/*
* Call the northbound configuration callback associated to a given
* configuration change.
*/
static int nb_callback_configuration(struct nb_context *context,
const enum nb_event event,
struct nb_config_change *change,
char *errmsg, size_t errmsg_len)
{
enum nb_operation operation = change->cb.operation;
char xpath[XPATH_MAXLEN];
const struct nb_node *nb_node = change->cb.nb_node;
const struct lyd_node *dnode = change->cb.dnode;
union nb_resource *resource;
int ret = NB_ERR;
if (CHECK_FLAG(nb_node->flags, F_NB_NODE_IGNORE_CBS))
return NB_OK;
if (event == NB_EV_VALIDATE)
resource = NULL;
else
resource = &change->resource;
switch (operation) {
case NB_OP_CREATE:
ret = nb_callback_create(context, nb_node, event, dnode,
resource, errmsg, errmsg_len);
break;
case NB_OP_MODIFY:
ret = nb_callback_modify(context, nb_node, event, dnode,
resource, errmsg, errmsg_len);
break;
case NB_OP_DESTROY:
ret = nb_callback_destroy(context, nb_node, event, dnode,
errmsg, errmsg_len);
break;
case NB_OP_MOVE:
ret = nb_callback_move(context, nb_node, event, dnode, errmsg,
errmsg_len);
break;
case NB_OP_PRE_VALIDATE:
case NB_OP_APPLY_FINISH:
case NB_OP_GET_ELEM:
case NB_OP_GET_NEXT:
case NB_OP_GET_KEYS:
case NB_OP_LOOKUP_ENTRY:
case NB_OP_RPC:
yang_dnode_get_path(dnode, xpath, sizeof(xpath));
flog_err(EC_LIB_DEVELOPMENT,
"%s: unknown operation (%u) [xpath %s]", __func__,
operation, xpath);
exit(1);
}
if (ret != NB_OK) {
yang_dnode_get_path(dnode, xpath, sizeof(xpath));
switch (event) {
case NB_EV_VALIDATE:
flog_warn(EC_LIB_NB_CB_CONFIG_VALIDATE,
"error processing configuration change: error [%s] event [%s] operation [%s] xpath [%s]%s%s",
nb_err_name(ret), nb_event_name(event),
nb_operation_name(operation), xpath,
errmsg[0] ? " message: " : "", errmsg);
break;
case NB_EV_PREPARE:
flog_warn(EC_LIB_NB_CB_CONFIG_PREPARE,
"error processing configuration change: error [%s] event [%s] operation [%s] xpath [%s]%s%s",
nb_err_name(ret), nb_event_name(event),
nb_operation_name(operation), xpath,
errmsg[0] ? " message: " : "", errmsg);
break;
case NB_EV_ABORT:
flog_warn(EC_LIB_NB_CB_CONFIG_ABORT,
"error processing configuration change: error [%s] event [%s] operation [%s] xpath [%s]%s%s",
nb_err_name(ret), nb_event_name(event),
nb_operation_name(operation), xpath,
errmsg[0] ? " message: " : "", errmsg);
break;
case NB_EV_APPLY:
flog_err(EC_LIB_NB_CB_CONFIG_APPLY,
"error processing configuration change: error [%s] event [%s] operation [%s] xpath [%s]%s%s",
nb_err_name(ret), nb_event_name(event),
nb_operation_name(operation), xpath,
errmsg[0] ? " message: " : "", errmsg);
break;
default:
flog_err(EC_LIB_DEVELOPMENT,
"%s: unknown event (%u) [xpath %s]", __func__,
event, xpath);
exit(1);
}
}
return ret;
}
static struct nb_transaction *
nb_transaction_new(struct nb_context context, struct nb_config *config,
struct nb_config_cbs *changes, const char *comment,
char *errmsg, size_t errmsg_len)
{
struct nb_transaction *transaction;
if (nb_running_lock_check(context.client, context.user)) {
strlcpy(errmsg,
"running configuration is locked by another client",
errmsg_len);
return NULL;
}
if (transaction_in_progress) {
strlcpy(errmsg,
"there's already another transaction in progress",
errmsg_len);
return NULL;
}
transaction_in_progress = true;
transaction = XCALLOC(MTYPE_TMP, sizeof(*transaction));
transaction->context = context;
if (comment)
strlcpy(transaction->comment, comment,
sizeof(transaction->comment));
transaction->config = config;
transaction->changes = *changes;
return transaction;
}
static void nb_transaction_free(struct nb_transaction *transaction)
{
nb_config_diff_del_changes(&transaction->changes);
XFREE(MTYPE_TMP, transaction);
transaction_in_progress = false;
}
/* Process all configuration changes associated to a transaction. */
static int nb_transaction_process(enum nb_event event,
struct nb_transaction *transaction,
char *errmsg, size_t errmsg_len)
{
struct nb_config_cb *cb;
RB_FOREACH (cb, nb_config_cbs, &transaction->changes) {
struct nb_config_change *change = (struct nb_config_change *)cb;
int ret;
/*
* Only try to release resources that were allocated
* successfully.
*/
if (event == NB_EV_ABORT && !change->prepare_ok)
break;
/* Call the appropriate callback. */
ret = nb_callback_configuration(&transaction->context, event,
change, errmsg, errmsg_len);
switch (event) {
case NB_EV_PREPARE:
if (ret != NB_OK)
return ret;
change->prepare_ok = true;
break;
case NB_EV_ABORT:
case NB_EV_APPLY:
/*
* At this point it's not possible to reject the
* transaction anymore, so any failure here can lead to
* inconsistencies and should be treated as a bug.
* Operations prone to errors, like validations and
* resource allocations, should be performed during the
* 'prepare' phase.
*/
break;
case NB_EV_VALIDATE:
break;
}
}
return NB_OK;
}
static struct nb_config_cb *
nb_apply_finish_cb_new(struct nb_config_cbs *cbs, const struct nb_node *nb_node,
const struct lyd_node *dnode)
{
struct nb_config_cb *cb;
cb = XCALLOC(MTYPE_TMP, sizeof(*cb));
cb->nb_node = nb_node;
cb->dnode = dnode;
RB_INSERT(nb_config_cbs, cbs, cb);
return cb;
}
static struct nb_config_cb *
nb_apply_finish_cb_find(struct nb_config_cbs *cbs,
const struct nb_node *nb_node,
const struct lyd_node *dnode)
{
struct nb_config_cb s;
s.seq = 0;
s.nb_node = nb_node;
s.dnode = dnode;
return RB_FIND(nb_config_cbs, cbs, &s);
}
/* Call the 'apply_finish' callbacks. */
static void nb_transaction_apply_finish(struct nb_transaction *transaction,
char *errmsg, size_t errmsg_len)
{
struct nb_config_cbs cbs;
struct nb_config_cb *cb;
/* Initialize tree of 'apply_finish' callbacks. */
RB_INIT(nb_config_cbs, &cbs);
/* Identify the 'apply_finish' callbacks that need to be called. */
RB_FOREACH (cb, nb_config_cbs, &transaction->changes) {
struct nb_config_change *change = (struct nb_config_change *)cb;
const struct lyd_node *dnode = change->cb.dnode;
/*
* Iterate up to the root of the data tree. When a node is being
* deleted, skip its 'apply_finish' callback if one is defined
* (the 'apply_finish' callbacks from the node ancestors should
* be called though).
*/
if (change->cb.operation == NB_OP_DESTROY) {
char xpath[XPATH_MAXLEN];
dnode = lyd_parent(dnode);
if (!dnode)
break;
/*
* The dnode from 'delete' callbacks point to elements
* from the running configuration. Use yang_dnode_get()
* to get the corresponding dnode from the candidate
* configuration that is being committed.
*/
yang_dnode_get_path(dnode, xpath, sizeof(xpath));
dnode = yang_dnode_get(transaction->config->dnode,
xpath);
}
while (dnode) {
struct nb_node *nb_node;
nb_node = dnode->schema->priv;
if (!nb_node || !nb_node->cbs.apply_finish)
goto next;
/*
* Don't call the callback more than once for the same
* data node.
*/
if (nb_apply_finish_cb_find(&cbs, nb_node, dnode))
goto next;
nb_apply_finish_cb_new(&cbs, nb_node, dnode);
next:
dnode = lyd_parent(dnode);
}
}
/* Call the 'apply_finish' callbacks, sorted by their priorities. */
RB_FOREACH (cb, nb_config_cbs, &cbs)
nb_callback_apply_finish(&transaction->context, cb->nb_node,
cb->dnode, errmsg, errmsg_len);
/* Release memory. */
while (!RB_EMPTY(nb_config_cbs, &cbs)) {
cb = RB_ROOT(nb_config_cbs, &cbs);
RB_REMOVE(nb_config_cbs, &cbs, cb);
XFREE(MTYPE_TMP, cb);
}
}
static int nb_oper_data_iter_children(const struct lysc_node *snode,
const char *xpath, const void *list_entry,
const struct yang_list_keys *list_keys,
struct yang_translator *translator,
bool first, uint32_t flags,
nb_oper_data_cb cb, void *arg)
{
const struct lysc_node *child;
LY_LIST_FOR (lysc_node_child(snode), child) {
int ret;
ret = nb_oper_data_iter_node(child, xpath, list_entry,
list_keys, translator, false,
flags, cb, arg);
if (ret != NB_OK)
return ret;
}
return NB_OK;
}
static int nb_oper_data_iter_leaf(const struct nb_node *nb_node,
const char *xpath, const void *list_entry,
const struct yang_list_keys *list_keys,
struct yang_translator *translator,
uint32_t flags, nb_oper_data_cb cb, void *arg)
{
struct yang_data *data;
if (CHECK_FLAG(nb_node->snode->flags, LYS_CONFIG_W))
return NB_OK;
/* Ignore list keys. */
if (lysc_is_key(nb_node->snode))
return NB_OK;
data = nb_callback_get_elem(nb_node, xpath, list_entry);
if (data == NULL)
/* Leaf of type "empty" is not present. */
return NB_OK;
return (*cb)(nb_node->snode, translator, data, arg);
}
static int nb_oper_data_iter_container(const struct nb_node *nb_node,
const char *xpath,
const void *list_entry,
const struct yang_list_keys *list_keys,
struct yang_translator *translator,
uint32_t flags, nb_oper_data_cb cb,
void *arg)
{
const struct lysc_node *snode = nb_node->snode;
if (CHECK_FLAG(nb_node->flags, F_NB_NODE_CONFIG_ONLY))
return NB_OK;
/* Read-only presence containers. */
if (nb_node->cbs.get_elem) {
struct yang_data *data;
int ret;
data = nb_callback_get_elem(nb_node, xpath, list_entry);
if (data == NULL)
/* Presence container is not present. */
return NB_OK;
ret = (*cb)(snode, translator, data, arg);
if (ret != NB_OK)
return ret;
}
/* Read-write presence containers. */
if (CHECK_FLAG(snode->flags, LYS_CONFIG_W)) {
struct lysc_node_container *scontainer;
scontainer = (struct lysc_node_container *)snode;
if (CHECK_FLAG(scontainer->flags, LYS_PRESENCE)
&& !yang_dnode_get(running_config->dnode, xpath))
return NB_OK;
}
/* Iterate over the child nodes. */
return nb_oper_data_iter_children(snode, xpath, list_entry, list_keys,
translator, false, flags, cb, arg);
}
static int
nb_oper_data_iter_leaflist(const struct nb_node *nb_node, const char *xpath,
const void *parent_list_entry,
const struct yang_list_keys *parent_list_keys,
struct yang_translator *translator, uint32_t flags,
nb_oper_data_cb cb, void *arg)
{
const void *list_entry = NULL;
if (CHECK_FLAG(nb_node->snode->flags, LYS_CONFIG_W))
return NB_OK;
do {
struct yang_data *data;
int ret;
list_entry = nb_callback_get_next(nb_node, parent_list_entry,
list_entry);
if (!list_entry)
/* End of the list. */
break;
data = nb_callback_get_elem(nb_node, xpath, list_entry);
if (data == NULL)
continue;
ret = (*cb)(nb_node->snode, translator, data, arg);
if (ret != NB_OK)
return ret;
} while (list_entry);
return NB_OK;
}
static int nb_oper_data_iter_list(const struct nb_node *nb_node,
const char *xpath_list,
const void *parent_list_entry,
const struct yang_list_keys *parent_list_keys,
struct yang_translator *translator,
uint32_t flags, nb_oper_data_cb cb, void *arg)
{
const struct lysc_node *snode = nb_node->snode;
const void *list_entry = NULL;
uint32_t position = 1;
if (CHECK_FLAG(nb_node->flags, F_NB_NODE_CONFIG_ONLY))
return NB_OK;
/* Iterate over all list entries. */
do {
const struct lysc_node_leaf *skey;
struct yang_list_keys list_keys = {};
char xpath[XPATH_MAXLEN * 2];
int ret;
/* Obtain list entry. */
list_entry = nb_callback_get_next(nb_node, parent_list_entry,
list_entry);
if (!list_entry)
/* End of the list. */
break;
if (!CHECK_FLAG(nb_node->flags, F_NB_NODE_KEYLESS_LIST)) {
/* Obtain the list entry keys. */
if (nb_callback_get_keys(nb_node, list_entry,
&list_keys)
!= NB_OK) {
flog_warn(EC_LIB_NB_CB_STATE,
"%s: failed to get list keys",
__func__);
return NB_ERR;
}
/* Build XPath of the list entry. */
strlcpy(xpath, xpath_list, sizeof(xpath));
unsigned int i = 0;
LY_FOR_KEYS (snode, skey) {
assert(i < list_keys.num);
snprintf(xpath + strlen(xpath),
sizeof(xpath) - strlen(xpath),
"[%s='%s']", skey->name,
list_keys.key[i]);
i++;
}
assert(i == list_keys.num);
} else {
/*
* Keyless list - build XPath using a positional index.
*/
snprintf(xpath, sizeof(xpath), "%s[%u]", xpath_list,
position);
position++;
}
/* Iterate over the child nodes. */
ret = nb_oper_data_iter_children(
nb_node->snode, xpath, list_entry, &list_keys,
translator, false, flags, cb, arg);
if (ret != NB_OK)
return ret;
} while (list_entry);
return NB_OK;
}
static int nb_oper_data_iter_node(const struct lysc_node *snode,
const char *xpath_parent,
const void *list_entry,
const struct yang_list_keys *list_keys,
struct yang_translator *translator,
bool first, uint32_t flags,
nb_oper_data_cb cb, void *arg)
{
struct nb_node *nb_node;
char xpath[XPATH_MAXLEN];
int ret = NB_OK;
if (!first && CHECK_FLAG(flags, NB_OPER_DATA_ITER_NORECURSE)
&& CHECK_FLAG(snode->nodetype, LYS_CONTAINER | LYS_LIST))
return NB_OK;
/* Update XPath. */
strlcpy(xpath, xpath_parent, sizeof(xpath));
if (!first && snode->nodetype != LYS_USES) {
struct lysc_node *parent;
/* Get the real parent. */
parent = snode->parent;
/*
* When necessary, include the namespace of the augmenting
* module.
*/
if (parent && parent->module != snode->module)
snprintf(xpath + strlen(xpath),
sizeof(xpath) - strlen(xpath), "/%s:%s",
snode->module->name, snode->name);
else
snprintf(xpath + strlen(xpath),
sizeof(xpath) - strlen(xpath), "/%s",
snode->name);
}
nb_node = snode->priv;
switch (snode->nodetype) {
case LYS_CONTAINER:
ret = nb_oper_data_iter_container(nb_node, xpath, list_entry,
list_keys, translator, flags,
cb, arg);
break;
case LYS_LEAF:
ret = nb_oper_data_iter_leaf(nb_node, xpath, list_entry,
list_keys, translator, flags, cb,
arg);
break;
case LYS_LEAFLIST:
ret = nb_oper_data_iter_leaflist(nb_node, xpath, list_entry,
list_keys, translator, flags,
cb, arg);
break;
case LYS_LIST:
ret = nb_oper_data_iter_list(nb_node, xpath, list_entry,
list_keys, translator, flags, cb,
arg);
break;
case LYS_USES:
ret = nb_oper_data_iter_children(snode, xpath, list_entry,
list_keys, translator, false,
flags, cb, arg);
break;
default:
break;
}
return ret;
}
int nb_oper_data_iterate(const char *xpath, struct yang_translator *translator,
uint32_t flags, nb_oper_data_cb cb, void *arg)
{
struct nb_node *nb_node;
const void *list_entry = NULL;
struct yang_list_keys list_keys;
struct list *list_dnodes;
struct lyd_node *dnode, *dn;
struct listnode *ln;
int ret;
nb_node = nb_node_find(xpath);
if (!nb_node) {
flog_warn(EC_LIB_YANG_UNKNOWN_DATA_PATH,
"%s: unknown data path: %s", __func__, xpath);
return NB_ERR;
}
/* For now this function works only with containers and lists. */
if (!CHECK_FLAG(nb_node->snode->nodetype, LYS_CONTAINER | LYS_LIST)) {
flog_warn(
EC_LIB_NB_OPERATIONAL_DATA,
"%s: can't iterate over YANG leaf or leaf-list [xpath %s]",
__func__, xpath);
return NB_ERR;
}
/*
* Create a data tree from the XPath so that we can parse the keys of
* all YANG lists (if any).
*/
LY_ERR err = lyd_new_path(NULL, ly_native_ctx, xpath, NULL,
LYD_NEW_PATH_UPDATE, &dnode);
if (err || !dnode) {
const char *errmsg =
err ? ly_errmsg(ly_native_ctx) : "node not found";
flog_warn(EC_LIB_LIBYANG, "%s: lyd_new_path() failed %s",
__func__, errmsg);
return NB_ERR;
}
/*
* Create a linked list to sort the data nodes starting from the root.
*/
list_dnodes = list_new();
for (dn = dnode; dn; dn = lyd_parent(dn)) {
if (dn->schema->nodetype != LYS_LIST || !lyd_child(dn))
continue;
listnode_add_head(list_dnodes, dn);
}
/*
* Use the northbound callbacks to find list entry pointer corresponding
* to the given XPath.
*/
for (ALL_LIST_ELEMENTS_RO(list_dnodes, ln, dn)) {
struct lyd_node *child;
struct nb_node *nn;
unsigned int n = 0;
/* Obtain the list entry keys. */
memset(&list_keys, 0, sizeof(list_keys));
LY_LIST_FOR (lyd_child(dn), child) {
if (!lysc_is_key(child->schema))
break;
strlcpy(list_keys.key[n],
yang_dnode_get_string(child, NULL),
sizeof(list_keys.key[n]));
n++;
}
list_keys.num = n;
if (list_keys.num != yang_snode_num_keys(dn->schema)) {
list_delete(&list_dnodes);
yang_dnode_free(dnode);
return NB_ERR_NOT_FOUND;
}
/* Find the list entry pointer. */
nn = dn->schema->priv;
if (!nn->cbs.lookup_entry) {
flog_warn(
EC_LIB_NB_OPERATIONAL_DATA,
"%s: data path doesn't support iteration over operational data: %s",
__func__, xpath);
list_delete(&list_dnodes);
yang_dnode_free(dnode);
return NB_ERR;
}
list_entry =
nb_callback_lookup_entry(nn, list_entry, &list_keys);
if (list_entry == NULL) {
list_delete(&list_dnodes);
yang_dnode_free(dnode);
return NB_ERR_NOT_FOUND;
}
}
/* If a list entry was given, iterate over that list entry only. */
if (dnode->schema->nodetype == LYS_LIST && lyd_child(dnode))
ret = nb_oper_data_iter_children(
nb_node->snode, xpath, list_entry, &list_keys,
translator, true, flags, cb, arg);
else
ret = nb_oper_data_iter_node(nb_node->snode, xpath, list_entry,
&list_keys, translator, true,
flags, cb, arg);
list_delete(&list_dnodes);
yang_dnode_free(dnode);
return ret;
}
bool nb_operation_is_valid(enum nb_operation operation,
const struct lysc_node *snode)
{
struct nb_node *nb_node = snode->priv;
struct lysc_node_container *scontainer;
struct lysc_node_leaf *sleaf;
switch (operation) {
case NB_OP_CREATE:
if (!CHECK_FLAG(snode->flags, LYS_CONFIG_W))
return false;
switch (snode->nodetype) {
case LYS_LEAF:
sleaf = (struct lysc_node_leaf *)snode;
if (sleaf->type->basetype != LY_TYPE_EMPTY)
return false;
break;
case LYS_CONTAINER:
scontainer = (struct lysc_node_container *)snode;
if (!CHECK_FLAG(scontainer->flags, LYS_PRESENCE))
return false;
break;
case LYS_LIST:
case LYS_LEAFLIST:
break;
default:
return false;
}
return true;
case NB_OP_MODIFY:
if (!CHECK_FLAG(snode->flags, LYS_CONFIG_W))
return false;
switch (snode->nodetype) {
case LYS_LEAF:
sleaf = (struct lysc_node_leaf *)snode;
if (sleaf->type->basetype == LY_TYPE_EMPTY)
return false;
/* List keys can't be modified. */
if (lysc_is_key(sleaf))
return false;
break;
default:
return false;
}
return true;
case NB_OP_DESTROY:
if (!CHECK_FLAG(snode->flags, LYS_CONFIG_W))
return false;
switch (snode->nodetype) {
case LYS_LEAF:
sleaf = (struct lysc_node_leaf *)snode;
/* List keys can't be deleted. */
if (lysc_is_key(sleaf))
return false;
/*
* Only optional leafs can be deleted, or leafs whose
* parent is a case statement.
*/
if (snode->parent->nodetype == LYS_CASE)
return true;
if (sleaf->when)
return true;
if (CHECK_FLAG(sleaf->flags, LYS_MAND_TRUE)
|| sleaf->dflt)
return false;
break;
case LYS_CONTAINER:
scontainer = (struct lysc_node_container *)snode;
if (!CHECK_FLAG(scontainer->flags, LYS_PRESENCE))
return false;
break;
case LYS_LIST:
case LYS_LEAFLIST:
break;
default:
return false;
}
return true;
case NB_OP_MOVE:
if (!CHECK_FLAG(snode->flags, LYS_CONFIG_W))
return false;
switch (snode->nodetype) {
case LYS_LIST:
case LYS_LEAFLIST:
if (!CHECK_FLAG(snode->flags, LYS_ORDBY_USER))
return false;
break;
default:
return false;
}
return true;
case NB_OP_PRE_VALIDATE:
case NB_OP_APPLY_FINISH:
if (!CHECK_FLAG(snode->flags, LYS_CONFIG_W))
return false;
return true;
case NB_OP_GET_ELEM:
if (!CHECK_FLAG(snode->flags, LYS_CONFIG_R))
return false;
switch (snode->nodetype) {
case LYS_LEAF:
case LYS_LEAFLIST:
break;
case LYS_CONTAINER:
scontainer = (struct lysc_node_container *)snode;
if (!CHECK_FLAG(scontainer->flags, LYS_PRESENCE))
return false;
break;
default:
return false;
}
return true;
case NB_OP_GET_NEXT:
switch (snode->nodetype) {
case LYS_LIST:
if (CHECK_FLAG(nb_node->flags, F_NB_NODE_CONFIG_ONLY))
return false;
break;
case LYS_LEAFLIST:
if (CHECK_FLAG(snode->flags, LYS_CONFIG_W))
return false;
break;
default:
return false;
}
return true;
case NB_OP_GET_KEYS:
case NB_OP_LOOKUP_ENTRY:
switch (snode->nodetype) {
case LYS_LIST:
if (CHECK_FLAG(nb_node->flags, F_NB_NODE_CONFIG_ONLY))
return false;
if (CHECK_FLAG(nb_node->flags, F_NB_NODE_KEYLESS_LIST))
return false;
break;
default:
return false;
}
return true;
case NB_OP_RPC:
if (CHECK_FLAG(snode->flags, LYS_CONFIG_W | LYS_CONFIG_R))
return false;
switch (snode->nodetype) {
case LYS_RPC:
case LYS_ACTION:
break;
default:
return false;
}
return true;
default:
return false;
}
}
DEFINE_HOOK(nb_notification_send, (const char *xpath, struct list *arguments),
(xpath, arguments));
int nb_notification_send(const char *xpath, struct list *arguments)
{
int ret;
DEBUGD(&nb_dbg_notif, "northbound notification: %s", xpath);
ret = hook_call(nb_notification_send, xpath, arguments);
if (arguments)
list_delete(&arguments);
return ret;
}
/* Running configuration user pointers management. */
struct nb_config_entry {
char xpath[XPATH_MAXLEN];
void *entry;
};
static bool running_config_entry_cmp(const void *value1, const void *value2)
{
const struct nb_config_entry *c1 = value1;
const struct nb_config_entry *c2 = value2;
return strmatch(c1->xpath, c2->xpath);
}
static unsigned int running_config_entry_key_make(const void *value)
{
return string_hash_make(value);
}
static void *running_config_entry_alloc(void *p)
{
struct nb_config_entry *new, *key = p;
new = XCALLOC(MTYPE_NB_CONFIG_ENTRY, sizeof(*new));
strlcpy(new->xpath, key->xpath, sizeof(new->xpath));
return new;
}
static void running_config_entry_free(void *arg)
{
XFREE(MTYPE_NB_CONFIG_ENTRY, arg);
}
void nb_running_set_entry(const struct lyd_node *dnode, void *entry)
{
struct nb_config_entry *config, s;
yang_dnode_get_path(dnode, s.xpath, sizeof(s.xpath));
config = hash_get(running_config_entries, &s,
running_config_entry_alloc);
config->entry = entry;
}
void nb_running_move_tree(const char *xpath_from, const char *xpath_to)
{
struct nb_config_entry *entry;
struct list *entries = hash_to_list(running_config_entries);
struct listnode *ln;
for (ALL_LIST_ELEMENTS_RO(entries, ln, entry)) {
if (!frrstr_startswith(entry->xpath, xpath_from))
continue;
hash_release(running_config_entries, entry);
char *newpath =
frrstr_replace(entry->xpath, xpath_from, xpath_to);
strlcpy(entry->xpath, newpath, sizeof(entry->xpath));
XFREE(MTYPE_TMP, newpath);
(void)hash_get(running_config_entries, entry,
hash_alloc_intern);
}
list_delete(&entries);
}
static void *nb_running_unset_entry_helper(const struct lyd_node *dnode)
{
struct nb_config_entry *config, s;
struct lyd_node *child;
void *entry = NULL;
yang_dnode_get_path(dnode, s.xpath, sizeof(s.xpath));
config = hash_release(running_config_entries, &s);
if (config) {
entry = config->entry;
running_config_entry_free(config);
}
/* Unset user pointers from the child nodes. */
if (CHECK_FLAG(dnode->schema->nodetype, LYS_LIST | LYS_CONTAINER)) {
LY_LIST_FOR (lyd_child(dnode), child) {
(void)nb_running_unset_entry_helper(child);
}
}
return entry;
}
void *nb_running_unset_entry(const struct lyd_node *dnode)
{
void *entry;
entry = nb_running_unset_entry_helper(dnode);
assert(entry);
return entry;
}
static void *nb_running_get_entry_worker(const struct lyd_node *dnode,
const char *xpath,
bool abort_if_not_found,
bool rec_search)
{
const struct lyd_node *orig_dnode = dnode;
char xpath_buf[XPATH_MAXLEN];
bool rec_flag = true;
assert(dnode || xpath);
if (!dnode)
dnode = yang_dnode_get(running_config->dnode, xpath);
while (rec_flag && dnode) {
struct nb_config_entry *config, s;
yang_dnode_get_path(dnode, s.xpath, sizeof(s.xpath));
config = hash_lookup(running_config_entries, &s);
if (config)
return config->entry;
rec_flag = rec_search;
dnode = lyd_parent(dnode);
}
if (!abort_if_not_found)
return NULL;
yang_dnode_get_path(orig_dnode, xpath_buf, sizeof(xpath_buf));
flog_err(EC_LIB_YANG_DNODE_NOT_FOUND,
"%s: failed to find entry [xpath %s]", __func__, xpath_buf);
zlog_backtrace(LOG_ERR);
abort();
}
void *nb_running_get_entry(const struct lyd_node *dnode, const char *xpath,
bool abort_if_not_found)
{
return nb_running_get_entry_worker(dnode, xpath, abort_if_not_found,
true);
}
void *nb_running_get_entry_non_rec(const struct lyd_node *dnode,
const char *xpath, bool abort_if_not_found)
{
return nb_running_get_entry_worker(dnode, xpath, abort_if_not_found,
false);
}
/* Logging functions. */
const char *nb_event_name(enum nb_event event)
{
switch (event) {
case NB_EV_VALIDATE:
return "validate";
case NB_EV_PREPARE:
return "prepare";
case NB_EV_ABORT:
return "abort";
case NB_EV_APPLY:
return "apply";
}
assert(!"Reached end of function we should never hit");
}
const char *nb_operation_name(enum nb_operation operation)
{
switch (operation) {
case NB_OP_CREATE:
return "create";
case NB_OP_MODIFY:
return "modify";
case NB_OP_DESTROY:
return "destroy";
case NB_OP_MOVE:
return "move";
case NB_OP_PRE_VALIDATE:
return "pre_validate";
case NB_OP_APPLY_FINISH:
return "apply_finish";
case NB_OP_GET_ELEM:
return "get_elem";
case NB_OP_GET_NEXT:
return "get_next";
case NB_OP_GET_KEYS:
return "get_keys";
case NB_OP_LOOKUP_ENTRY:
return "lookup_entry";
case NB_OP_RPC:
return "rpc";
}
assert(!"Reached end of function we should never hit");
}
const char *nb_err_name(enum nb_error error)
{
switch (error) {
case NB_OK:
return "ok";
case NB_ERR:
return "generic error";
case NB_ERR_NO_CHANGES:
return "no changes";
case NB_ERR_NOT_FOUND:
return "element not found";
case NB_ERR_LOCKED:
return "resource is locked";
case NB_ERR_VALIDATION:
return "validation";
case NB_ERR_RESOURCE:
return "failed to allocate resource";
case NB_ERR_INCONSISTENCY:
return "internal inconsistency";
}
assert(!"Reached end of function we should never hit");
}
const char *nb_client_name(enum nb_client client)
{
switch (client) {
case NB_CLIENT_CLI:
return "CLI";
case NB_CLIENT_CONFD:
return "ConfD";
case NB_CLIENT_SYSREPO:
return "Sysrepo";
case NB_CLIENT_GRPC:
return "gRPC";
case NB_CLIENT_PCEP:
return "Pcep";
case NB_CLIENT_MGMTD_SERVER:
return "MGMTD Server";
case NB_CLIENT_MGMTD_BE:
return "MGMT Backend";
case NB_CLIENT_NONE:
return "None";
}
assert(!"Reached end of function we should never hit");
}
static void nb_load_callbacks(const struct frr_yang_module_info *module)
{
if (module->ignore_cbs)
return;
for (size_t i = 0; module->nodes[i].xpath; i++) {
struct nb_node *nb_node;
uint32_t priority;
if (i > YANG_MODULE_MAX_NODES) {
zlog_err(
"%s: %s.yang has more than %u nodes. Please increase YANG_MODULE_MAX_NODES to fix this problem.",
__func__, module->name, YANG_MODULE_MAX_NODES);
exit(1);
}
nb_node = nb_node_find(module->nodes[i].xpath);
if (!nb_node) {
flog_warn(EC_LIB_YANG_UNKNOWN_DATA_PATH,
"%s: unknown data path: %s", __func__,
module->nodes[i].xpath);
continue;
}
nb_node->cbs = module->nodes[i].cbs;
priority = module->nodes[i].priority;
if (priority != 0)
nb_node->priority = priority;
}
}
void nb_validate_callbacks(void)
{
unsigned int errors = 0;
yang_snodes_iterate(NULL, nb_node_validate, 0, &errors);
if (errors > 0) {
flog_err(
EC_LIB_NB_CBS_VALIDATION,
"%s: failed to validate northbound callbacks: %u error(s)",
__func__, errors);
exit(1);
}
}
void nb_init(struct event_loop *tm,
const struct frr_yang_module_info *const modules[],
size_t nmodules, bool db_enabled)
{
struct yang_module *loaded[nmodules], **loadedp = loaded;
bool explicit_compile;
/*
* Currently using this explicit compile feature in libyang2 leads to
* incorrect behavior in FRR. The functionality suppresses the compiling
* of modules until they have all been loaded into the context. This
* avoids multiple recompiles of the same modules as they are
* imported/augmented etc.
*/
explicit_compile = false;
nb_db_enabled = db_enabled;
yang_init(true, explicit_compile);
/* Load YANG modules and their corresponding northbound callbacks. */
for (size_t i = 0; i < nmodules; i++) {
DEBUGD(&nb_dbg_events, "northbound: loading %s.yang",
modules[i]->name);
*loadedp++ = yang_module_load(modules[i]->name);
}
if (explicit_compile)
yang_init_loading_complete();
/* Initialize the compiled nodes with northbound data */
for (size_t i = 0; i < nmodules; i++) {
yang_snodes_iterate(loaded[i]->info, nb_node_new_cb, 0,
(void *)modules[i]);
nb_load_callbacks(modules[i]);
}
/* Validate northbound callbacks. */
nb_validate_callbacks();
/* Create an empty running configuration. */
running_config = nb_config_new(NULL);
running_config_entries = hash_create(running_config_entry_key_make,
running_config_entry_cmp,
"Running Configuration Entries");
pthread_mutex_init(&running_config_mgmt_lock.mtx, NULL);
/* Initialize the northbound CLI. */
nb_cli_init(tm);
}
void nb_terminate(void)
{
/* Terminate the northbound CLI. */
nb_cli_terminate();
/* Delete all nb_node's from all YANG modules. */
nb_nodes_delete();
/* Delete the running configuration. */
hash_clean_and_free(&running_config_entries, running_config_entry_free);
nb_config_free(running_config);
pthread_mutex_destroy(&running_config_mgmt_lock.mtx);
}
|