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
|
/**
* @file diff.c
* @author Michal Vasko <mvasko@cesnet.cz>
* @brief diff functions
*
* Copyright (c) 2020 - 2021 CESNET, z.s.p.o.
*
* This source code is licensed under BSD 3-Clause License (the "License").
* You may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://opensource.org/licenses/BSD-3-Clause
*/
#define _GNU_SOURCE /* asprintf, strdup */
#include "diff.h"
#include <assert.h>
#include <stddef.h>
#include <stdint.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "compat.h"
#include "context.h"
#include "log.h"
#include "ly_common.h"
#include "plugins_exts.h"
#include "plugins_exts/metadata.h"
#include "plugins_types.h"
#include "set.h"
#include "tree.h"
#include "tree_data.h"
#include "tree_data_internal.h"
#include "tree_edit.h"
#include "tree_schema.h"
#include "tree_schema_internal.h"
#define LOGERR_META(ctx, meta_name, node) \
{ \
char *__path = lyd_path(node, LYD_PATH_STD, NULL, 0); \
LOGERR(ctx, LY_EINVAL, "Failed to find metadata \"%s\" for node \"%s\".", meta_name, __path); \
free(__path); \
}
#define LOGERR_NOINST(ctx, node) \
{ \
char *__path = lyd_path(node, LYD_PATH_STD, NULL, 0); \
LOGERR(ctx, LY_EINVAL, "Failed to find node \"%s\" instance in data.", __path); \
free(__path); \
}
#define LOGERR_UNEXPVAL(ctx, node, data_source) \
{ \
char *__path = lyd_path(node, LYD_PATH_STD, NULL, 0); \
LOGERR(ctx, LY_EINVAL, "Unexpected value of node \"%s\" in %s.", __path, data_source); \
free(__path); \
}
#define LOGERR_MERGEOP(ctx, node, src_op, trg_op) \
{ \
char *__path = lyd_path(node, LYD_PATH_STD, NULL, 0); \
LOGERR(ctx, LY_EINVAL, "Unable to merge operation \"%s\" with \"%s\" for node \"%s\".", \
lyd_diff_op2str(trg_op), lyd_diff_op2str(src_op), __path); \
free(__path); \
}
static const char *
lyd_diff_op2str(enum lyd_diff_op op)
{
switch (op) {
case LYD_DIFF_OP_CREATE:
return "create";
case LYD_DIFF_OP_DELETE:
return "delete";
case LYD_DIFF_OP_REPLACE:
return "replace";
case LYD_DIFF_OP_NONE:
return "none";
}
LOGINT(NULL);
return NULL;
}
static enum lyd_diff_op
lyd_diff_str2op(const char *str)
{
switch (str[0]) {
case 'c':
assert(!strcmp(str, "create"));
return LYD_DIFF_OP_CREATE;
case 'd':
assert(!strcmp(str, "delete"));
return LYD_DIFF_OP_DELETE;
case 'r':
assert(!strcmp(str, "replace"));
return LYD_DIFF_OP_REPLACE;
case 'n':
assert(!strcmp(str, "none"));
return LYD_DIFF_OP_NONE;
}
LOGINT(NULL);
return 0;
}
/**
* @brief Create diff metadata for a nested user-ordered node with the effective operation "create".
*
* @param[in] node User-rodered node to update.
* @return LY_ERR value.
*/
static LY_ERR
lyd_diff_add_create_nested_userord(struct lyd_node *node)
{
LY_ERR rc = LY_SUCCESS;
const char *meta_name, *meta_val;
size_t buflen = 0, bufused = 0;
uint32_t pos;
char *dyn = NULL;
assert(lysc_is_userordered(node->schema));
/* get correct metadata name and value */
if (lysc_is_dup_inst_list(node->schema)) {
meta_name = "yang:position";
pos = lyd_list_pos(node);
if (asprintf(&dyn, "%" PRIu32, pos) == -1) {
LOGMEM(LYD_CTX(node));
rc = LY_EMEM;
goto cleanup;
}
meta_val = dyn;
} else if (node->schema->nodetype == LYS_LIST) {
meta_name = "yang:key";
if (node->prev->next && (node->prev->schema == node->schema)) {
LY_CHECK_GOTO(rc = lyd_path_list_predicate(node->prev, &dyn, &buflen, &bufused, 0), cleanup);
meta_val = dyn;
} else {
meta_val = "";
}
} else {
meta_name = "yang:value";
if (node->prev->next && (node->prev->schema == node->schema)) {
meta_val = lyd_get_value(node->prev);
} else {
meta_val = "";
}
}
/* create the metadata */
LY_CHECK_GOTO(rc = lyd_new_meta(NULL, node, NULL, meta_name, meta_val, LYD_NEW_VAL_STORE_ONLY, NULL), cleanup);
cleanup:
free(dyn);
return rc;
}
/**
* @brief Find metadata/an attribute of a node.
*
* @param[in] node Node to search.
* @param[in] name Metadata/attribute name.
* @param[out] meta Metadata found, NULL if not found.
* @param[out] attr Attribute found, NULL if not found.
*/
static void
lyd_diff_find_meta(const struct lyd_node *node, const char *name, struct lyd_meta **meta, struct lyd_attr **attr)
{
struct lyd_meta *m;
struct lyd_attr *a;
if (meta) {
*meta = NULL;
}
if (attr) {
*attr = NULL;
}
if (node->schema) {
assert(meta);
LY_LIST_FOR(node->meta, m) {
if (!strcmp(m->name, name) && !strcmp(m->annotation->module->name, "yang")) {
*meta = m;
break;
}
}
} else {
assert(attr);
LY_LIST_FOR(((struct lyd_node_opaq *)node)->attr, a) {
/* name */
if (strcmp(a->name.name, name)) {
continue;
}
/* module */
switch (a->format) {
case LY_VALUE_JSON:
if (strcmp(a->name.module_name, "yang")) {
continue;
}
break;
case LY_VALUE_XML:
if (strcmp(a->name.module_ns, "urn:ietf:params:xml:ns:yang:1")) {
continue;
}
break;
default:
LOGINT(LYD_CTX(node));
return;
}
*attr = a;
break;
}
}
}
/**
* @brief Learn operation of a diff node.
*
* @param[in] diff_node Diff node.
* @param[out] op Operation.
* @return LY_ERR value.
*/
static LY_ERR
lyd_diff_get_op(const struct lyd_node *diff_node, enum lyd_diff_op *op)
{
struct lyd_meta *meta = NULL;
struct lyd_attr *attr = NULL;
const struct lyd_node *diff_parent;
const char *str;
char *path;
for (diff_parent = diff_node; diff_parent; diff_parent = lyd_parent(diff_parent)) {
lyd_diff_find_meta(diff_parent, "operation", &meta, &attr);
if (!meta && !attr) {
continue;
}
str = meta ? lyd_get_meta_value(meta) : attr->value;
if ((str[0] == 'r') && (diff_parent != diff_node)) {
/* we do not care about this operation if it's in our parent */
continue;
}
*op = lyd_diff_str2op(str);
return LY_SUCCESS;
}
/* operation not found */
path = lyd_path(diff_node, LYD_PATH_STD, NULL, 0);
LOGERR(LYD_CTX(diff_node), LY_EINVAL, "Node \"%s\" without an operation.", path);
free(path);
return LY_EINT;
}
/**
* @brief Remove metadata/an attribute from a node.
*
* @param[in] node Node to update.
* @param[in] name Metadata/attribute name.
*/
static void
lyd_diff_del_meta(struct lyd_node *node, const char *name)
{
struct lyd_meta *meta;
struct lyd_attr *attr;
lyd_diff_find_meta(node, name, &meta, &attr);
if (meta) {
lyd_free_meta_single(meta);
} else if (attr) {
lyd_free_attr_single(LYD_CTX(node), attr);
}
}
/**
* @brief Insert a node into siblings.
*
* - if the node is part of some other tree, it is automatically unlinked.
* - difference with the lyd_insert_sibling() is that the subsequent nodes are never inserted.
* - insert ignores node ordering, which is fine since it's not desirable to sort diff nodes.
*
* @param[in] sibling Siblings to insert into, can even be NULL.
* @param[in] node Node to insert.
* @param[out] first Return the first sibling after insertion. Can be the address of @p sibling.
*/
static void
lyd_diff_insert_sibling(struct lyd_node *sibling, struct lyd_node *node, struct lyd_node **first_sibling)
{
assert(node && first_sibling);
lyd_unlink_ignore_lyds(NULL, node);
*first_sibling = lyd_first_sibling(sibling);
lyd_insert_node(NULL, first_sibling, node, LYD_INSERT_NODE_LAST_BY_SCHEMA);
}
LY_ERR
lyd_diff_add(const struct lyd_node *node, enum lyd_diff_op op, const char *orig_default, const char *orig_value,
const char *key, const char *value, const char *position, const char *orig_key, const char *orig_position,
struct lyd_node **diff)
{
struct lyd_node *dup, *siblings, *match = NULL, *diff_parent = NULL, *elem;
const struct lyd_node *parent = NULL;
enum lyd_diff_op cur_op;
struct lyd_meta *meta;
uint32_t diff_opts;
assert(diff);
/* replace leaf always needs orig-default and orig-value */
assert((node->schema->nodetype != LYS_LEAF) || (op != LYD_DIFF_OP_REPLACE) || (orig_default && orig_value));
/* create on userord needs key/value */
assert((node->schema->nodetype != LYS_LIST) || !(node->schema->flags & LYS_ORDBY_USER) || (op != LYD_DIFF_OP_CREATE) ||
(lysc_is_dup_inst_list(node->schema) && position) || key);
assert((node->schema->nodetype != LYS_LEAFLIST) || !(node->schema->flags & LYS_ORDBY_USER) ||
(op != LYD_DIFF_OP_CREATE) || (lysc_is_dup_inst_list(node->schema) && position) || value);
/* move on userord needs both key and orig-key/value and orig-value */
assert((node->schema->nodetype != LYS_LIST) || !(node->schema->flags & LYS_ORDBY_USER) || (op != LYD_DIFF_OP_REPLACE) ||
(lysc_is_dup_inst_list(node->schema) && position && orig_position) || (key && orig_key));
assert((node->schema->nodetype != LYS_LEAFLIST) || !(node->schema->flags & LYS_ORDBY_USER) ||
(op != LYD_DIFF_OP_REPLACE) || (lysc_is_dup_inst_list(node->schema) && position && orig_position) ||
(value && orig_value));
/* find the first existing parent */
siblings = *diff;
do {
/* find next node parent */
parent = node;
while (parent->parent && (!diff_parent || (parent->parent->schema != diff_parent->schema))) {
parent = lyd_parent(parent);
}
if (lysc_is_dup_inst_list(parent->schema)) {
/* assume it never exists, we are not able to distinguish whether it does or not */
match = NULL;
break;
}
/* check whether it exists in the diff */
if (lyd_find_sibling_first(siblings, parent, &match)) {
break;
}
/* another parent found */
diff_parent = match;
/* move down in the diff */
siblings = lyd_child_no_keys(match);
} while (parent != node);
if (match && (parent == node)) {
/* special case when there is already an operation on our descendant */
assert(!lyd_diff_get_op(diff_parent, &cur_op) && (cur_op == LYD_DIFF_OP_NONE));
(void)cur_op;
/* move it to the end where it is expected (matters for user-ordered lists) */
if (lysc_is_userordered(diff_parent->schema)) {
for (elem = diff_parent; elem->next && (elem->next->schema == elem->schema); elem = elem->next) {}
if (elem != diff_parent) {
LY_CHECK_RET(lyd_insert_after(elem, diff_parent));
}
}
/* will be replaced by the new operation but keep the current op for descendants */
lyd_diff_del_meta(diff_parent, "operation");
LY_LIST_FOR(lyd_child_no_keys(diff_parent), elem) {
lyd_diff_find_meta(elem, "operation", &meta, NULL);
if (meta) {
/* explicit operation, fine */
continue;
}
/* set the none operation */
LY_CHECK_RET(lyd_new_meta(NULL, elem, NULL, "yang:operation", "none", LYD_NEW_VAL_STORE_ONLY, NULL));
}
dup = diff_parent;
} else {
diff_opts = LYD_DUP_NO_META | LYD_DUP_WITH_PARENTS | LYD_DUP_WITH_FLAGS | LYD_DUP_NO_LYDS;
if ((op != LYD_DIFF_OP_REPLACE) || !lysc_is_userordered(node->schema) || (node->schema->flags & LYS_CONFIG_R)) {
/* move applies only to the user-ordered list, no descendants */
diff_opts |= LYD_DUP_RECURSIVE;
}
/* duplicate the subtree (and connect to the diff if possible) */
if (diff_parent) {
LY_CHECK_RET(lyd_dup_single_to_ctx(node, LYD_CTX(diff_parent), (struct lyd_node_inner *)diff_parent,
diff_opts, &dup));
} else {
LY_CHECK_RET(lyd_dup_single(node, NULL, diff_opts, &dup));
}
/* find the first duplicated parent */
if (!diff_parent) {
diff_parent = lyd_parent(dup);
while (diff_parent && diff_parent->parent) {
diff_parent = lyd_parent(diff_parent);
}
} else {
diff_parent = dup;
while (diff_parent->parent && (diff_parent->parent->schema == parent->schema)) {
diff_parent = lyd_parent(diff_parent);
}
}
/* no parent existed, must be manually connected */
if (!diff_parent) {
/* there actually was no parent to duplicate */
lyd_diff_insert_sibling(*diff, dup, diff);
} else if (!diff_parent->parent) {
lyd_diff_insert_sibling(*diff, diff_parent, diff);
}
/* add parent operation, if any */
if (diff_parent && (diff_parent != dup)) {
LY_CHECK_RET(lyd_new_meta(NULL, diff_parent, NULL, "yang:operation", "none", LYD_NEW_VAL_STORE_ONLY, NULL));
}
}
/* add subtree operation */
LY_CHECK_RET(lyd_new_meta(NULL, dup, NULL, "yang:operation", lyd_diff_op2str(op), LYD_NEW_VAL_STORE_ONLY, NULL));
if (op == LYD_DIFF_OP_CREATE) {
/* all nested user-ordered (leaf-)lists need special metadata for create op */
LYD_TREE_DFS_BEGIN(dup, elem) {
if ((elem != dup) && lysc_is_userordered(elem->schema)) {
LY_CHECK_RET(lyd_diff_add_create_nested_userord(elem));
}
LYD_TREE_DFS_END(dup, elem);
}
}
/* orig-default */
if (orig_default) {
LY_CHECK_RET(lyd_new_meta(NULL, dup, NULL, "yang:orig-default", orig_default, LYD_NEW_VAL_STORE_ONLY, NULL));
}
/* orig-value */
if (orig_value) {
LY_CHECK_RET(lyd_new_meta(NULL, dup, NULL, "yang:orig-value", orig_value, LYD_NEW_VAL_STORE_ONLY, NULL));
}
/* key */
if (key) {
LY_CHECK_RET(lyd_new_meta(NULL, dup, NULL, "yang:key", key, LYD_NEW_VAL_STORE_ONLY, NULL));
}
/* value */
if (value) {
LY_CHECK_RET(lyd_new_meta(NULL, dup, NULL, "yang:value", value, LYD_NEW_VAL_STORE_ONLY, NULL));
}
/* position */
if (position) {
LY_CHECK_RET(lyd_new_meta(NULL, dup, NULL, "yang:position", position, LYD_NEW_VAL_STORE_ONLY, NULL));
}
/* orig-key */
if (orig_key) {
LY_CHECK_RET(lyd_new_meta(NULL, dup, NULL, "yang:orig-key", orig_key, LYD_NEW_VAL_STORE_ONLY, NULL));
}
/* orig-position */
if (orig_position) {
LY_CHECK_RET(lyd_new_meta(NULL, dup, NULL, "yang:orig-position", orig_position, LYD_NEW_VAL_STORE_ONLY, NULL));
}
return LY_SUCCESS;
}
/**
* @brief Get a userord entry for a specific user-ordered list/leaf-list. Create if does not exist yet.
*
* @param[in] first Node from the first tree, can be NULL (on create).
* @param[in] schema Schema node of the list/leaf-list.
* @param[in,out] userord Sized array of userord items.
* @return Userord item for all the user-ordered list/leaf-list instances.
*/
static struct lyd_diff_userord *
lyd_diff_userord_get(const struct lyd_node *first, const struct lysc_node *schema, struct lyd_diff_userord **userord)
{
struct lyd_diff_userord *item;
struct lyd_node *iter;
const struct lyd_node **node;
LY_ARRAY_COUNT_TYPE u;
LY_ARRAY_FOR(*userord, u) {
if ((*userord)[u].schema == schema) {
return &(*userord)[u];
}
}
/* it was not added yet, add it now */
LY_ARRAY_NEW_RET(schema->module->ctx, *userord, item, NULL);
item->schema = schema;
item->pos = 0;
item->inst = NULL;
/* store all the instance pointers in the current order */
if (first) {
LYD_LIST_FOR_INST(lyd_first_sibling(first), first->schema, iter) {
LY_ARRAY_NEW_RET(schema->module->ctx, item->inst, node, NULL);
*node = iter;
}
}
return item;
}
/**
* @brief Get all the metadata to be stored in a diff for the 2 nodes. Can be used only for user-ordered
* lists/leaf-lists.
*
* @param[in] first Node from the first tree, can be NULL (on create).
* @param[in] second Node from the second tree, can be NULL (on delete).
* @param[in] options Diff options.
* @param[in] userord_item Userord item of @p first and/or @p second node.
* @param[out] op Operation.
* @param[out] orig_default Original default metadata.
* @param[out] value Value metadata.
* @param[out] orig_value Original value metadata
* @param[out] key Key metadata.
* @param[out] orig_key Original key metadata.
* @param[out] position Position metadata.
* @param[out] orig_position Original position metadata.
* @return LY_SUCCESS on success,
* @return LY_ENOT if there is no change to be added into diff,
* @return LY_ERR value on other errors.
*/
static LY_ERR
lyd_diff_userord_attrs(const struct lyd_node *first, const struct lyd_node *second, uint16_t options,
struct lyd_diff_userord *userord_item, enum lyd_diff_op *op, const char **orig_default, char **value,
char **orig_value, char **key, char **orig_key, char **position, char **orig_position)
{
LY_ERR rc = LY_SUCCESS;
const struct lysc_node *schema;
size_t buflen, bufused;
uint32_t first_pos, second_pos, comp_opts;
assert(first || second);
*orig_default = NULL;
*value = NULL;
*orig_value = NULL;
*key = NULL;
*orig_key = NULL;
*position = NULL;
*orig_position = NULL;
schema = first ? first->schema : second->schema;
assert(lysc_is_userordered(schema));
/* find user-ordered first position */
if (first) {
for (first_pos = 0; first_pos < LY_ARRAY_COUNT(userord_item->inst); ++first_pos) {
if (userord_item->inst[first_pos] == first) {
break;
}
}
assert(first_pos < LY_ARRAY_COUNT(userord_item->inst));
} else {
first_pos = 0;
}
/* prepare position of the next instance */
second_pos = userord_item->pos++;
/* learn operation first */
if (!second) {
*op = LYD_DIFF_OP_DELETE;
} else if (!first) {
*op = LYD_DIFF_OP_CREATE;
} else {
comp_opts = lysc_is_dup_inst_list(second->schema) ? LYD_COMPARE_FULL_RECURSION : 0;
if (lyd_compare_single(second, userord_item->inst[second_pos], comp_opts)) {
/* in first, there is a different instance on the second position, we are going to move 'first' node */
*op = LYD_DIFF_OP_REPLACE;
} else if ((options & LYD_DIFF_DEFAULTS) && ((first->flags & LYD_DEFAULT) != (second->flags & LYD_DEFAULT))) {
/* default flag change */
*op = LYD_DIFF_OP_NONE;
} else {
/* no changes */
return LY_ENOT;
}
}
/*
* set each attribute correctly based on the operation and node type
*/
/* orig-default */
if ((schema->nodetype == LYS_LEAFLIST) && ((*op == LYD_DIFF_OP_REPLACE) || (*op == LYD_DIFF_OP_NONE))) {
if (first->flags & LYD_DEFAULT) {
*orig_default = "true";
} else {
*orig_default = "false";
}
}
/* value */
if ((schema->nodetype == LYS_LEAFLIST) && !lysc_is_dup_inst_list(schema) &&
((*op == LYD_DIFF_OP_REPLACE) || (*op == LYD_DIFF_OP_CREATE))) {
if (second_pos) {
*value = strdup(lyd_get_value(userord_item->inst[second_pos - 1]));
LY_CHECK_ERR_GOTO(!*value, LOGMEM(schema->module->ctx); rc = LY_EMEM, cleanup);
} else {
*value = strdup("");
LY_CHECK_ERR_GOTO(!*value, LOGMEM(schema->module->ctx); rc = LY_EMEM, cleanup);
}
}
/* orig-value */
if ((schema->nodetype == LYS_LEAFLIST) && !lysc_is_dup_inst_list(schema) &&
((*op == LYD_DIFF_OP_REPLACE) || (*op == LYD_DIFF_OP_DELETE))) {
if (first_pos) {
*orig_value = strdup(lyd_get_value(userord_item->inst[first_pos - 1]));
LY_CHECK_ERR_GOTO(!*orig_value, LOGMEM(schema->module->ctx); rc = LY_EMEM, cleanup);
} else {
*orig_value = strdup("");
LY_CHECK_ERR_GOTO(!*orig_value, LOGMEM(schema->module->ctx); rc = LY_EMEM, cleanup);
}
}
/* key */
if ((schema->nodetype == LYS_LIST) && !lysc_is_dup_inst_list(schema) &&
((*op == LYD_DIFF_OP_REPLACE) || (*op == LYD_DIFF_OP_CREATE))) {
if (second_pos) {
buflen = bufused = 0;
LY_CHECK_GOTO(rc = lyd_path_list_predicate(userord_item->inst[second_pos - 1], key, &buflen, &bufused, 0), cleanup);
} else {
*key = strdup("");
LY_CHECK_ERR_GOTO(!*key, LOGMEM(schema->module->ctx); rc = LY_EMEM, cleanup);
}
}
/* orig-key */
if ((schema->nodetype == LYS_LIST) && !lysc_is_dup_inst_list(schema) &&
((*op == LYD_DIFF_OP_REPLACE) || (*op == LYD_DIFF_OP_DELETE))) {
if (first_pos) {
buflen = bufused = 0;
LY_CHECK_GOTO(rc = lyd_path_list_predicate(userord_item->inst[first_pos - 1], orig_key, &buflen, &bufused, 0), cleanup);
} else {
*orig_key = strdup("");
LY_CHECK_ERR_GOTO(!*orig_key, LOGMEM(schema->module->ctx); rc = LY_EMEM, cleanup);
}
}
/* position */
if (lysc_is_dup_inst_list(schema) && ((*op == LYD_DIFF_OP_REPLACE) || (*op == LYD_DIFF_OP_CREATE))) {
if (second_pos) {
if (asprintf(position, "%" PRIu32, second_pos) == -1) {
LOGMEM(schema->module->ctx);
rc = LY_EMEM;
goto cleanup;
}
} else {
*position = strdup("");
LY_CHECK_ERR_GOTO(!*position, LOGMEM(schema->module->ctx); rc = LY_EMEM, cleanup);
}
}
/* orig-position */
if (lysc_is_dup_inst_list(schema) && ((*op == LYD_DIFF_OP_REPLACE) || (*op == LYD_DIFF_OP_DELETE))) {
if (first_pos) {
if (asprintf(orig_position, "%" PRIu32, first_pos) == -1) {
LOGMEM(schema->module->ctx);
rc = LY_EMEM;
goto cleanup;
}
} else {
*orig_position = strdup("");
LY_CHECK_ERR_GOTO(!*orig_position, LOGMEM(schema->module->ctx); rc = LY_EMEM, cleanup);
}
}
/*
* update our instances - apply the change
*/
if (*op == LYD_DIFF_OP_CREATE) {
/* insert the instance */
LY_ARRAY_CREATE_GOTO(schema->module->ctx, userord_item->inst, 1, rc, cleanup);
if (second_pos < LY_ARRAY_COUNT(userord_item->inst)) {
memmove(userord_item->inst + second_pos + 1, userord_item->inst + second_pos,
(LY_ARRAY_COUNT(userord_item->inst) - second_pos) * sizeof *userord_item->inst);
}
LY_ARRAY_INCREMENT(userord_item->inst);
userord_item->inst[second_pos] = second;
} else if (*op == LYD_DIFF_OP_DELETE) {
/* remove the instance */
if (first_pos + 1 < LY_ARRAY_COUNT(userord_item->inst)) {
memmove(userord_item->inst + first_pos, userord_item->inst + first_pos + 1,
(LY_ARRAY_COUNT(userord_item->inst) - first_pos - 1) * sizeof *userord_item->inst);
}
LY_ARRAY_DECREMENT(userord_item->inst);
} else if (*op == LYD_DIFF_OP_REPLACE) {
/* move the instances */
memmove(userord_item->inst + second_pos + 1, userord_item->inst + second_pos,
(first_pos - second_pos) * sizeof *userord_item->inst);
userord_item->inst[second_pos] = first;
}
cleanup:
if (rc) {
free(*value);
*value = NULL;
free(*orig_value);
*orig_value = NULL;
free(*key);
*key = NULL;
free(*orig_key);
*orig_key = NULL;
free(*position);
*position = NULL;
free(*orig_position);
*orig_position = NULL;
}
return rc;
}
/**
* @brief Get all the metadata to be stored in a diff for the 2 nodes. Cannot be used for user-ordered
* lists/leaf-lists.
*
* @param[in] first Node from the first tree, can be NULL (on create).
* @param[in] second Node from the second tree, can be NULL (on delete).
* @param[in] options Diff options.
* @param[out] op Operation.
* @param[out] orig_default Original default metadata.
* @param[out] orig_value Original value metadata.
* @return LY_SUCCESS on success,
* @return LY_ENOT if there is no change to be added into diff,
* @return LY_ERR value on other errors.
*/
static LY_ERR
lyd_diff_attrs(const struct lyd_node *first, const struct lyd_node *second, uint16_t options, enum lyd_diff_op *op,
const char **orig_default, char **orig_value)
{
const struct lysc_node *schema;
const char *str_val;
assert(first || second);
*orig_default = NULL;
*orig_value = NULL;
schema = first ? first->schema : second->schema;
assert(!lysc_is_userordered(schema));
/* learn operation first */
if (!second) {
*op = LYD_DIFF_OP_DELETE;
} else if (!first) {
*op = LYD_DIFF_OP_CREATE;
} else {
switch (schema->nodetype) {
case LYS_CONTAINER:
case LYS_RPC:
case LYS_ACTION:
case LYS_NOTIF:
/* no changes */
return LY_ENOT;
case LYS_LIST:
case LYS_LEAFLIST:
if ((options & LYD_DIFF_DEFAULTS) && ((first->flags & LYD_DEFAULT) != (second->flags & LYD_DEFAULT))) {
/* default flag change */
*op = LYD_DIFF_OP_NONE;
} else {
/* no changes */
return LY_ENOT;
}
break;
case LYS_LEAF:
case LYS_ANYXML:
case LYS_ANYDATA:
if (lyd_compare_single(first, second, 0)) {
/* different values */
*op = LYD_DIFF_OP_REPLACE;
} else if ((options & LYD_DIFF_DEFAULTS) && ((first->flags & LYD_DEFAULT) != (second->flags & LYD_DEFAULT))) {
/* default flag change */
*op = LYD_DIFF_OP_NONE;
} else {
/* no changes */
return LY_ENOT;
}
break;
default:
LOGINT_RET(schema->module->ctx);
}
}
/*
* set each attribute correctly based on the operation and node type
*/
/* orig-default */
if ((schema->nodetype & LYD_NODE_TERM) && ((*op == LYD_DIFF_OP_REPLACE) || (*op == LYD_DIFF_OP_NONE))) {
if (first->flags & LYD_DEFAULT) {
*orig_default = "true";
} else {
*orig_default = "false";
}
}
/* orig-value */
if ((schema->nodetype & (LYS_LEAF | LYS_ANYDATA)) && (*op == LYD_DIFF_OP_REPLACE)) {
if (schema->nodetype == LYS_LEAF) {
str_val = lyd_get_value(first);
*orig_value = strdup(str_val ? str_val : "");
LY_CHECK_ERR_RET(!*orig_value, LOGMEM(schema->module->ctx), LY_EMEM);
} else {
LY_CHECK_RET(lyd_any_value_str(first, orig_value));
}
}
return LY_SUCCESS;
}
/**
* @brief Find a matching instance of a node in a data tree.
*
* @param[in] siblings Siblings to search in.
* @param[in] target Target node to search for.
* @param[in] defaults Whether to consider (or ignore) default values.
* @param[in,out] dup_inst_ht Duplicate instance cache.
* @param[out] match Found match, NULL if no matching node found.
* @return LY_ERR value.
*/
static LY_ERR
lyd_diff_find_match(const struct lyd_node *siblings, const struct lyd_node *target, ly_bool defaults,
struct ly_ht **dup_inst_ht, struct lyd_node **match)
{
LY_ERR r;
if (!target->schema) {
/* try to find the same opaque node */
r = lyd_find_sibling_opaq_next(siblings, LYD_NAME(target), match);
} else if (target->schema->nodetype & (LYS_LIST | LYS_LEAFLIST)) {
/* try to find the exact instance */
r = lyd_find_sibling_first(siblings, target, match);
} else {
/* try to simply find the node, there cannot be more instances */
r = lyd_find_sibling_val(siblings, target->schema, NULL, 0, match);
}
if (r && (r != LY_ENOTFOUND)) {
return r;
}
/* update match as needed */
LY_CHECK_RET(lyd_dup_inst_next(match, siblings, dup_inst_ht));
if (*match && ((*match)->flags & LYD_DEFAULT) && !defaults) {
/* ignore default nodes */
*match = NULL;
}
return LY_SUCCESS;
}
/**
* @brief Perform diff for all siblings at certain depth, recursively.
*
* For user-ordered lists/leaf-lists a specific structure is used for storing
* the current order. The idea is to apply all the generated diff changes
* virtually on the first tree so that we can continue to generate correct
* changes after some were already generated.
*
* The algorithm then uses second tree position-based changes with a before
* (preceding) item anchor.
*
* Example:
*
* Virtual first tree leaf-list order:
* 1 2 [3] 4 5
*
* Second tree leaf-list order:
* 1 2 [5] 3 4
*
* We are at the 3rd node now. We look at whether the nodes on the 3rd position
* match - they do not - move nodes so that the 3rd position node is final ->
* -> move node 5 to the 3rd position -> move node 5 after node 2.
*
* Required properties:
* Stored operations (move) should not be affected by later operations -
* - would cause a redundantly long list of operations, possibly inifinite.
*
* Implemenation justification:
* First, all delete operations and only then move/create operations are stored.
* Also, preceding anchor is used and after each iteration another node is
* at its final position. That results in the invariant that all preceding
* nodes are final and will not be changed by the later operations, meaning
* they can safely be used as anchors for the later operations.
*
* @param[in] first First tree first sibling.
* @param[in] second Second tree first sibling.
* @param[in] options Diff options.
* @param[in] nosiblings Whether to skip following siblings.
* @param[in,out] diff Diff to append to.
* @return LY_ERR value.
*/
static LY_ERR
lyd_diff_siblings_r(const struct lyd_node *first, const struct lyd_node *second, uint16_t options, ly_bool nosiblings,
struct lyd_node **diff)
{
LY_ERR ret = LY_SUCCESS;
const struct lyd_node *iter_first, *iter_second;
struct lyd_node *match_second, *match_first;
struct lyd_diff_userord *userord = NULL, *userord_item;
struct ly_ht *dup_inst_first = NULL, *dup_inst_second = NULL;
LY_ARRAY_COUNT_TYPE u;
enum lyd_diff_op op;
const char *orig_default;
char *orig_value, *key, *value, *position, *orig_key, *orig_position;
/* compare first tree to the second tree - delete, replace, none */
LY_LIST_FOR(first, iter_first) {
if (!iter_first->schema) {
continue;
}
assert(!(iter_first->schema->flags & LYS_KEY));
if ((iter_first->flags & LYD_DEFAULT) && !(options & LYD_DIFF_DEFAULTS)) {
/* skip default nodes */
continue;
}
/* find a match in the second tree */
LY_CHECK_GOTO(ret = lyd_diff_find_match(second, iter_first, options & LYD_DIFF_DEFAULTS, &dup_inst_second,
&match_second), cleanup);
if (lysc_is_userordered(iter_first->schema)) {
/* get (create) userord entry */
userord_item = lyd_diff_userord_get(iter_first, iter_first->schema, &userord);
LY_CHECK_ERR_GOTO(!userord_item, LOGMEM(LYD_CTX(iter_first)); ret = LY_EMEM, cleanup);
/* we are handling only user-ordered node delete now */
if (!match_second) {
/* get all the attributes */
LY_CHECK_GOTO(ret = lyd_diff_userord_attrs(iter_first, match_second, options, userord_item, &op,
&orig_default, &value, &orig_value, &key, &orig_key, &position, &orig_position), cleanup);
/* there must be changes, it is deleted */
assert(op == LYD_DIFF_OP_DELETE);
ret = lyd_diff_add(iter_first, op, orig_default, orig_value, key, value, position, orig_key,
orig_position, diff);
free(orig_value);
free(key);
free(value);
free(position);
free(orig_key);
free(orig_position);
LY_CHECK_GOTO(ret, cleanup);
}
} else {
/* get all the attributes */
ret = lyd_diff_attrs(iter_first, match_second, options, &op, &orig_default, &orig_value);
/* add into diff if there are any changes */
if (!ret) {
if (op == LYD_DIFF_OP_DELETE) {
ret = lyd_diff_add(iter_first, op, orig_default, orig_value, NULL, NULL, NULL, NULL, NULL, diff);
} else {
assert(match_second);
ret = lyd_diff_add(match_second, op, orig_default, orig_value, NULL, NULL, NULL, NULL, NULL, diff);
}
free(orig_value);
LY_CHECK_GOTO(ret, cleanup);
} else if (ret == LY_ENOT) {
ret = LY_SUCCESS;
} else {
goto cleanup;
}
}
/* check descendants, if any, recursively */
if (match_second) {
LY_CHECK_GOTO(ret = lyd_diff_siblings_r(lyd_child_no_keys(iter_first), lyd_child_no_keys(match_second),
options, 0, diff), cleanup);
}
if (nosiblings) {
break;
}
}
/* reset all cached positions */
LY_ARRAY_FOR(userord, u) {
userord[u].pos = 0;
}
/* compare second tree to the first tree - create, user-ordered move */
LY_LIST_FOR(second, iter_second) {
if (!iter_second->schema) {
continue;
}
assert(!(iter_second->schema->flags & LYS_KEY));
if ((iter_second->flags & LYD_DEFAULT) && !(options & LYD_DIFF_DEFAULTS)) {
/* skip default nodes */
continue;
}
/* find a match in the first tree */
LY_CHECK_GOTO(ret = lyd_diff_find_match(first, iter_second, options & LYD_DIFF_DEFAULTS, &dup_inst_first,
&match_first), cleanup);
if (lysc_is_userordered(iter_second->schema)) {
/* get userord entry */
userord_item = lyd_diff_userord_get(match_first, iter_second->schema, &userord);
LY_CHECK_ERR_GOTO(!userord_item, LOGMEM(LYD_CTX(iter_second)); ret = LY_EMEM, cleanup);
/* get all the attributes */
ret = lyd_diff_userord_attrs(match_first, iter_second, options, userord_item, &op, &orig_default,
&value, &orig_value, &key, &orig_key, &position, &orig_position);
/* add into diff if there are any changes */
if (!ret) {
ret = lyd_diff_add(iter_second, op, orig_default, orig_value, key, value, position, orig_key,
orig_position, diff);
free(orig_value);
free(key);
free(value);
free(position);
free(orig_key);
free(orig_position);
LY_CHECK_GOTO(ret, cleanup);
} else if (ret == LY_ENOT) {
ret = LY_SUCCESS;
} else {
goto cleanup;
}
} else if (!match_first) {
/* get all the attributes */
LY_CHECK_GOTO(ret = lyd_diff_attrs(match_first, iter_second, options, &op, &orig_default, &orig_value), cleanup);
/* there must be changes, it is created */
assert(op == LYD_DIFF_OP_CREATE);
ret = lyd_diff_add(iter_second, op, orig_default, orig_value, NULL, NULL, NULL, NULL, NULL, diff);
free(orig_value);
LY_CHECK_GOTO(ret, cleanup);
} /* else was handled */
if (nosiblings) {
break;
}
}
cleanup:
lyd_dup_inst_free(dup_inst_first);
lyd_dup_inst_free(dup_inst_second);
LY_ARRAY_FOR(userord, u) {
LY_ARRAY_FREE(userord[u].inst);
}
LY_ARRAY_FREE(userord);
return ret;
}
static LY_ERR
lyd_diff(const struct lyd_node *first, const struct lyd_node *second, uint16_t options, ly_bool nosiblings,
struct lyd_node **diff)
{
const struct ly_ctx *ctx;
LY_CHECK_ARG_RET(NULL, diff, LY_EINVAL);
if (first) {
ctx = LYD_CTX(first);
} else if (second) {
ctx = LYD_CTX(second);
} else {
ctx = NULL;
}
if (first && second && (lysc_data_parent(first->schema) != lysc_data_parent(second->schema))) {
LOGERR(ctx, LY_EINVAL, "Invalid arguments - cannot create diff for unrelated data (%s()).", __func__);
return LY_EINVAL;
}
*diff = NULL;
return lyd_diff_siblings_r(first, second, options, nosiblings, diff);
}
LIBYANG_API_DEF LY_ERR
lyd_diff_tree(const struct lyd_node *first, const struct lyd_node *second, uint16_t options, struct lyd_node **diff)
{
return lyd_diff(first, second, options, 1, diff);
}
LIBYANG_API_DEF LY_ERR
lyd_diff_siblings(const struct lyd_node *first, const struct lyd_node *second, uint16_t options, struct lyd_node **diff)
{
return lyd_diff(first, second, options, 0, diff);
}
/**
* @brief Insert a diff node into a data tree.
*
* @param[in,out] first_node First sibling of the data tree.
* @param[in] parent_node Data tree sibling parent node.
* @param[in] new_node Node to insert.
* @param[in] userord_anchor Optional anchor (key, value, or position) of relative (leaf-)list instance. If not set,
* the user-ordered instance will be inserted at the first position.
* @return err_info, NULL on success.
*/
static LY_ERR
lyd_diff_insert(struct lyd_node **first_node, struct lyd_node *parent_node, struct lyd_node *new_node,
const char *userord_anchor)
{
LY_ERR ret;
struct lyd_node *anchor;
uint32_t pos, anchor_pos;
int found;
assert(new_node);
if (!*first_node) {
if (!parent_node) {
/* no parent or siblings */
*first_node = new_node;
return LY_SUCCESS;
}
/* simply insert into parent, no other children */
if (userord_anchor) {
LOGERR(LYD_CTX(new_node), LY_EINVAL, "Node \"%s\" instance to insert next to not found.",
new_node->schema->name);
return LY_EINVAL;
}
return lyd_insert_child(parent_node, new_node);
}
assert(!(*first_node)->parent || (lyd_parent(*first_node) == parent_node));
if (!lysc_is_userordered(new_node->schema)) {
/* simple insert */
return lyd_insert_sibling(*first_node, new_node, first_node);
}
if (userord_anchor) {
/* find the anchor sibling */
if (lysc_is_dup_inst_list(new_node->schema)) {
anchor_pos = atoi(userord_anchor);
if (!anchor_pos) {
LOGERR(LYD_CTX(new_node), LY_EINVAL, "Invalid user-ordered anchor value \"%s\".", userord_anchor);
return LY_EINVAL;
}
found = 0;
pos = 1;
LYD_LIST_FOR_INST(*first_node, new_node->schema, anchor) {
if (pos == anchor_pos) {
found = 1;
break;
}
++pos;
}
if (!found) {
LOGERR(LYD_CTX(new_node), LY_EINVAL, "Node \"%s\" instance to insert next to not found.",
new_node->schema->name);
return LY_EINVAL;
}
} else {
ret = lyd_find_sibling_val(*first_node, new_node->schema, userord_anchor, 0, &anchor);
if (ret == LY_ENOTFOUND) {
LOGERR(LYD_CTX(new_node), LY_EINVAL, "Node \"%s\" instance to insert next to not found.",
new_node->schema->name);
return LY_EINVAL;
} else if (ret) {
return ret;
}
}
/* insert after */
LY_CHECK_RET(lyd_insert_after(anchor, new_node));
assert(new_node->prev == anchor);
if (*first_node == new_node) {
*first_node = anchor;
}
} else {
/* find the first instance */
ret = lyd_find_sibling_val(*first_node, new_node->schema, NULL, 0, &anchor);
LY_CHECK_RET(ret && (ret != LY_ENOTFOUND), ret);
if (anchor) {
/* insert before the first instance */
LY_CHECK_RET(lyd_insert_before(anchor, new_node));
if ((*first_node)->prev->next) {
assert(!new_node->prev->next);
*first_node = new_node;
}
} else {
/* insert anywhere */
LY_CHECK_RET(lyd_insert_sibling(*first_node, new_node, first_node));
}
}
return LY_SUCCESS;
}
/**
* @brief Apply diff subtree on data tree nodes, recursively.
*
* @param[in,out] first_node First sibling of the data tree.
* @param[in] parent_node Parent of the first sibling.
* @param[in] diff_node Current diff node.
* @param[in] diff_cb Optional diff callback.
* @param[in] cb_data User data for @p diff_cb.
* @param[in,out] dup_inst Duplicate instance cache for all @p diff_node siblings.
* @return LY_ERR value.
*/
static LY_ERR
lyd_diff_apply_r(struct lyd_node **first_node, struct lyd_node *parent_node, const struct lyd_node *diff_node,
lyd_diff_cb diff_cb, void *cb_data, struct ly_ht **dup_inst)
{
LY_ERR ret;
struct lyd_node *match, *diff_child;
const char *str_val, *meta_str;
enum lyd_diff_op op;
struct lyd_meta *meta;
struct ly_ht *child_dup_inst = NULL;
const struct ly_ctx *ctx = LYD_CTX(diff_node);
/* read all the valid attributes */
LY_CHECK_RET(lyd_diff_get_op(diff_node, &op));
/* handle specific user-ordered (leaf-)lists operations separately */
if (lysc_is_userordered(diff_node->schema) && ((op == LYD_DIFF_OP_CREATE) || (op == LYD_DIFF_OP_REPLACE))) {
if (op == LYD_DIFF_OP_REPLACE) {
/* find the node (we must have some siblings because the node was only moved) */
LY_CHECK_RET(lyd_diff_find_match(*first_node, diff_node, 1, dup_inst, &match));
LY_CHECK_ERR_RET(!match, LOGERR_NOINST(ctx, diff_node), LY_EINVAL);
} else {
/* duplicate the node */
LY_CHECK_RET(lyd_dup_single(diff_node, NULL, LYD_DUP_NO_META, &match));
}
/* get "key", "value", or "position" metadata string value */
if (lysc_is_dup_inst_list(diff_node->schema)) {
meta_str = "yang:position";
} else if (diff_node->schema->nodetype == LYS_LIST) {
meta_str = "yang:key";
} else {
meta_str = "yang:value";
}
meta = lyd_find_meta(diff_node->meta, NULL, meta_str);
LY_CHECK_ERR_RET(!meta, LOGERR_META(ctx, meta_str, diff_node), LY_EINVAL);
str_val = lyd_get_meta_value(meta);
/* insert/move the node */
if (str_val[0]) {
ret = lyd_diff_insert(first_node, parent_node, match, str_val);
} else {
ret = lyd_diff_insert(first_node, parent_node, match, NULL);
}
if (ret) {
if (op == LYD_DIFF_OP_CREATE) {
lyd_free_tree(match);
}
return ret;
}
goto next_iter_r;
}
/* apply operation */
switch (op) {
case LYD_DIFF_OP_NONE:
/* find the node */
LY_CHECK_RET(lyd_diff_find_match(*first_node, diff_node, 1, dup_inst, &match));
LY_CHECK_ERR_RET(!match, LOGERR_NOINST(ctx, diff_node), LY_EINVAL);
if (match->schema->nodetype & LYD_NODE_TERM) {
/* special case of only dflt flag change */
if (diff_node->flags & LYD_DEFAULT) {
match->flags |= LYD_DEFAULT;
} else {
match->flags &= ~LYD_DEFAULT;
}
} else {
/* none operation on nodes without children is redundant and hence forbidden */
if (!lyd_child_no_keys(diff_node)) {
LOGERR(ctx, LY_EINVAL, "Operation \"none\" is invalid for node \"%s\" without children.",
LYD_NAME(diff_node));
return LY_EINVAL;
}
}
break;
case LYD_DIFF_OP_CREATE:
/* duplicate the node */
LY_CHECK_RET(lyd_dup_single(diff_node, NULL, LYD_DUP_NO_META, &match));
/* insert it at the end */
ret = 0;
if (parent_node) {
if (match->flags & LYD_EXT) {
ret = lyplg_ext_insert(parent_node, match);
} else {
ret = lyd_insert_child(parent_node, match);
}
} else {
ret = lyd_insert_sibling(*first_node, match, first_node);
}
if (ret) {
lyd_free_tree(match);
return ret;
}
break;
case LYD_DIFF_OP_DELETE:
/* find the node */
LY_CHECK_RET(lyd_diff_find_match(*first_node, diff_node, 1, dup_inst, &match));
LY_CHECK_ERR_RET(!match, LOGERR_NOINST(ctx, diff_node), LY_EINVAL);
/* remove it */
if ((match == *first_node) && !match->parent) {
assert(!parent_node);
/* we have removed the top-level node */
*first_node = (*first_node)->next;
}
lyd_free_tree(match);
/* we are not going recursively in this case, the whole subtree was already deleted */
return LY_SUCCESS;
case LYD_DIFF_OP_REPLACE:
if (!(diff_node->schema->nodetype & (LYS_LEAF | LYS_ANYDATA))) {
LOGERR(ctx, LY_EINVAL, "Operation \"replace\" is invalid for %s node \"%s\".",
lys_nodetype2str(diff_node->schema->nodetype), LYD_NAME(diff_node));
return LY_EINVAL;
}
/* find the node */
LY_CHECK_RET(lyd_diff_find_match(*first_node, diff_node, 1, dup_inst, &match));
LY_CHECK_ERR_RET(!match, LOGERR_NOINST(ctx, diff_node), LY_EINVAL);
/* update the value */
if (diff_node->schema->nodetype == LYS_LEAF) {
ret = lyd_change_term(match, lyd_get_value(diff_node));
LY_CHECK_ERR_RET(ret && (ret != LY_EEXIST), LOGERR_UNEXPVAL(ctx, match, "data"), LY_EINVAL);
} else {
struct lyd_node_any *any = (struct lyd_node_any *)diff_node;
LY_CHECK_RET(lyd_any_copy_value(match, &any->value, any->value_type));
}
/* with flags */
match->flags = diff_node->flags;
break;
default:
LOGINT_RET(ctx);
}
next_iter_r:
if (diff_cb) {
/* call callback */
LY_CHECK_RET(diff_cb(diff_node, match, cb_data));
}
/* apply diff recursively */
ret = LY_SUCCESS;
LY_LIST_FOR(lyd_child_no_keys(diff_node), diff_child) {
ret = lyd_diff_apply_r(lyd_node_child_p(match), match, diff_child, diff_cb, cb_data, &child_dup_inst);
if (ret) {
break;
}
}
lyd_dup_inst_free(child_dup_inst);
return ret;
}
LIBYANG_API_DEF LY_ERR
lyd_diff_apply_module(struct lyd_node **data, const struct lyd_node *diff, const struct lys_module *mod,
lyd_diff_cb diff_cb, void *cb_data)
{
const struct lyd_node *root;
struct ly_ht *dup_inst = NULL;
LY_ERR ret = LY_SUCCESS;
LY_LIST_FOR(diff, root) {
if (mod && (lyd_owner_module(root) != mod)) {
/* skip data nodes from different modules */
continue;
}
/* apply relevant nodes from the diff datatree */
ret = lyd_diff_apply_r(data, NULL, root, diff_cb, cb_data, &dup_inst);
if (ret) {
break;
}
}
lyd_dup_inst_free(dup_inst);
return ret;
}
LIBYANG_API_DEF LY_ERR
lyd_diff_apply_all(struct lyd_node **data, const struct lyd_node *diff)
{
return lyd_diff_apply_module(data, diff, NULL, NULL, NULL);
}
/**
* @brief Update operations on a diff node when the new operation is NONE.
*
* @param[in] diff_match Node from the diff.
* @param[in] cur_op Current operation of @p diff_match.
* @param[in] src_diff Current source diff node.
* @return LY_ERR value.
*/
static LY_ERR
lyd_diff_merge_none(struct lyd_node *diff_match, enum lyd_diff_op cur_op, const struct lyd_node *src_diff)
{
switch (cur_op) {
case LYD_DIFF_OP_NONE:
case LYD_DIFF_OP_CREATE:
case LYD_DIFF_OP_REPLACE:
if (src_diff->schema->nodetype & LYD_NODE_TERM) {
/* NONE on a term means only its dflt flag was changed */
diff_match->flags &= ~LYD_DEFAULT;
diff_match->flags |= src_diff->flags & LYD_DEFAULT;
}
break;
default:
/* delete operation is not valid */
LOGERR_MERGEOP(LYD_CTX(diff_match), diff_match, cur_op, LYD_DIFF_OP_NONE);
return LY_EINVAL;
}
return LY_SUCCESS;
}
/**
* @brief Set a specific operation of a node. Delete the previous operation, if any.
* Does not change the default flag.
*
* @param[in] node Node to change.
* @param[in] op Operation to set.
* @return LY_ERR value.
*/
static LY_ERR
lyd_diff_change_op(struct lyd_node *node, enum lyd_diff_op op)
{
lyd_diff_del_meta(node, "operation");
if (node->schema) {
return lyd_new_meta(LYD_CTX(node), node, NULL, "yang:operation", lyd_diff_op2str(op), LYD_NEW_VAL_STORE_ONLY, NULL);
} else {
return lyd_new_attr(node, "yang", "operation", lyd_diff_op2str(op), NULL);
}
}
/**
* @brief Update operations on a diff node when the new operation is REPLACE.
*
* @param[in] diff_match Node from the diff.
* @param[in] cur_op Current operation of @p diff_match.
* @param[in] src_diff Current source diff node.
* @return LY_ERR value.
*/
static LY_ERR
lyd_diff_merge_replace(struct lyd_node *diff_match, enum lyd_diff_op cur_op, const struct lyd_node *src_diff)
{
LY_ERR ret;
const char *str_val, *meta_name, *orig_meta_name;
struct lyd_meta *meta;
const struct lys_module *mod;
const struct lyd_node_any *any;
const struct ly_ctx *ctx = LYD_CTX(diff_match);
/* get "yang" module for the metadata */
mod = ly_ctx_get_module_latest(LYD_CTX(diff_match), "yang");
assert(mod);
switch (cur_op) {
case LYD_DIFF_OP_REPLACE:
case LYD_DIFF_OP_CREATE:
switch (diff_match->schema->nodetype) {
case LYS_LIST:
case LYS_LEAFLIST:
/* it was created/moved somewhere, but now it will be created/moved somewhere else,
* keep orig_key/orig_value (only replace oper) and replace key/value */
assert(lysc_is_userordered(diff_match->schema));
if (lysc_is_dup_inst_list(diff_match->schema)) {
meta_name = "position";
} else if (diff_match->schema->nodetype == LYS_LIST) {
meta_name = "key";
} else {
meta_name = "value";
}
lyd_diff_del_meta(diff_match, meta_name);
meta = lyd_find_meta(src_diff->meta, mod, meta_name);
LY_CHECK_ERR_RET(!meta, LOGERR_META(ctx, meta_name, src_diff), LY_EINVAL);
LY_CHECK_RET(lyd_dup_meta_single(meta, diff_match, NULL));
break;
case LYS_LEAF:
/* replaced with the exact same value, impossible */
if (!lyd_compare_single(diff_match, src_diff, 0)) {
LOGERR_UNEXPVAL(ctx, diff_match, "target diff");
return LY_EINVAL;
}
/* modify the node value */
if (lyd_change_term(diff_match, lyd_get_value(src_diff))) {
LOGINT_RET(LYD_CTX(src_diff));
}
if (cur_op == LYD_DIFF_OP_REPLACE) {
/* compare values whether there is any change at all */
meta = lyd_find_meta(diff_match->meta, mod, "orig-value");
LY_CHECK_ERR_RET(!meta, LOGERR_META(ctx, "orig-value", diff_match), LY_EINVAL);
str_val = lyd_get_meta_value(meta);
ret = lyd_value_compare((struct lyd_node_term *)diff_match, str_val, strlen(str_val));
if (!ret) {
/* values are the same, remove orig-value meta and set oper to NONE */
lyd_free_meta_single(meta);
LY_CHECK_RET(lyd_diff_change_op(diff_match, LYD_DIFF_OP_NONE));
}
}
/* modify the default flag */
diff_match->flags &= ~LYD_DEFAULT;
diff_match->flags |= src_diff->flags & LYD_DEFAULT;
break;
case LYS_ANYXML:
case LYS_ANYDATA:
if (!lyd_compare_single(diff_match, src_diff, 0)) {
LOGERR_UNEXPVAL(ctx, diff_match, "target diff");
return LY_EINVAL;
}
/* modify the node value */
any = (struct lyd_node_any *)src_diff;
LY_CHECK_RET(lyd_any_copy_value(diff_match, &any->value, any->value_type));
break;
default:
LOGINT_RET(LYD_CTX(src_diff));
}
break;
case LYD_DIFF_OP_NONE:
switch (diff_match->schema->nodetype) {
case LYS_LIST:
/* it is moved now */
assert(lysc_is_userordered(diff_match->schema));
/* change the operation */
LY_CHECK_RET(lyd_diff_change_op(diff_match, LYD_DIFF_OP_REPLACE));
/* set orig-meta and meta */
if (lysc_is_dup_inst_list(diff_match->schema)) {
meta_name = "position";
orig_meta_name = "orig-position";
} else {
meta_name = "key";
orig_meta_name = "orig-key";
}
meta = lyd_find_meta(src_diff->meta, mod, orig_meta_name);
LY_CHECK_ERR_RET(!meta, LOGERR_META(ctx, orig_meta_name, src_diff), LY_EINVAL);
LY_CHECK_RET(lyd_dup_meta_single(meta, diff_match, NULL));
meta = lyd_find_meta(src_diff->meta, mod, meta_name);
LY_CHECK_ERR_RET(!meta, LOGERR_META(ctx, meta_name, src_diff), LY_EINVAL);
LY_CHECK_RET(lyd_dup_meta_single(meta, diff_match, NULL));
break;
case LYS_LEAF:
/* only dflt flag changed, now value changed as well, update the operation */
LY_CHECK_RET(lyd_diff_change_op(diff_match, LYD_DIFF_OP_REPLACE));
/* modify the node value */
if (lyd_change_term(diff_match, lyd_get_value(src_diff))) {
LOGINT_RET(LYD_CTX(src_diff));
}
break;
default:
LOGINT_RET(LYD_CTX(src_diff));
}
break;
default:
/* delete operation is not valid */
LOGERR_MERGEOP(ctx, diff_match, cur_op, LYD_DIFF_OP_REPLACE);
return LY_EINVAL;
}
return LY_SUCCESS;
}
/**
* @brief Update operations in a diff node when the new operation is CREATE.
*
* @param[in,out] diff_match Node from the diff, may be replaced.
* @param[in,out] diff Diff root node, may be updated.
* @param[in] cur_op Current operation of @p diff_match.
* @param[in] src_diff Current source diff node.
* @param[in] options Diff merge options.
* @return LY_ERR value.
*/
static LY_ERR
lyd_diff_merge_create(struct lyd_node **diff_match, struct lyd_node **diff, enum lyd_diff_op cur_op,
const struct lyd_node *src_diff, uint16_t options)
{
struct lyd_node *child, *src_dup, *to_free = NULL;
const struct lysc_node_leaf *sleaf = NULL;
uint32_t trg_flags;
const char *meta_name, *orig_meta_name;
struct lyd_meta *meta, *orig_meta;
const struct ly_ctx *ctx = LYD_CTX(*diff_match);
LY_ERR r;
/* create operation is valid only for data nodes */
LY_CHECK_ERR_RET(!src_diff->schema, LOGINT(ctx), LY_EINT);
switch (cur_op) {
case LYD_DIFF_OP_DELETE:
/* remember current flags */
trg_flags = (*diff_match)->flags;
if (lysc_is_userordered(src_diff->schema)) {
assert((*diff_match)->schema);
/* get anchor metadata */
if (lysc_is_dup_inst_list((*diff_match)->schema)) {
meta_name = "yang:position";
orig_meta_name = "yang:orig-position";
} else if ((*diff_match)->schema->nodetype == LYS_LIST) {
meta_name = "yang:key";
orig_meta_name = "yang:orig-key";
} else {
meta_name = "yang:value";
orig_meta_name = "yang:orig-value";
}
meta = lyd_find_meta(src_diff->meta, NULL, meta_name);
LY_CHECK_ERR_RET(!meta, LOGERR_META(ctx, meta_name, src_diff), LY_EINVAL);
orig_meta = lyd_find_meta((*diff_match)->meta, NULL, orig_meta_name);
LY_CHECK_ERR_RET(!orig_meta, LOGERR_META(ctx, orig_meta_name, *diff_match), LY_EINVAL);
if (strcmp(lyd_get_meta_value(meta), lyd_get_meta_value(orig_meta))) {
/* deleted + created at another position -> operation REPLACE */
LY_CHECK_RET(lyd_diff_change_op(*diff_match, LYD_DIFF_OP_REPLACE));
/* add anchor metadata */
LY_CHECK_RET(lyd_dup_meta_single(meta, *diff_match, NULL));
/* previous created nodes affect the metadata so move it at the end (of the instances) */
child = *diff_match;
while (child->next && (child->next->schema == (*diff_match)->schema)) {
child = child->next;
}
if (child != *diff_match) {
LY_CHECK_RET(lyd_insert_after(child, *diff_match));
}
} else {
/* deleted + created at the same position -> operation NONE */
LY_CHECK_RET(lyd_diff_change_op(*diff_match, LYD_DIFF_OP_NONE));
/* delete anchor metadata */
lyd_free_meta_single(orig_meta);
}
} else if (src_diff->schema->nodetype == LYS_LEAF) {
if (options & LYD_DIFF_MERGE_DEFAULTS) {
/* we are dealing with a leaf and are handling default values specially (as explicit nodes) */
sleaf = (struct lysc_node_leaf *)src_diff->schema;
}
if (sleaf && sleaf->dflt && !sleaf->dflt->realtype->plugin->compare(ctx, sleaf->dflt,
&((struct lyd_node_term *)src_diff)->value)) {
/* we deleted it, so a default value was in-use, and it matches the created value -> operation NONE */
LY_CHECK_RET(lyd_diff_change_op(*diff_match, LYD_DIFF_OP_NONE));
} else if (!lyd_compare_single(*diff_match, src_diff, 0)) {
/* deleted + created -> operation NONE */
LY_CHECK_RET(lyd_diff_change_op(*diff_match, LYD_DIFF_OP_NONE));
} else if ((*diff_match)->schema) {
/* we deleted it, but it was created with a different value -> operation REPLACE */
LY_CHECK_RET(lyd_diff_change_op(*diff_match, LYD_DIFF_OP_REPLACE));
/* current value is the previous one (meta) */
LY_CHECK_RET(lyd_new_meta(LYD_CTX(src_diff), *diff_match, NULL, "yang:orig-value",
lyd_get_value(*diff_match), LYD_NEW_VAL_STORE_ONLY, NULL));
/* update the value itself */
LY_CHECK_RET(lyd_change_term(*diff_match, lyd_get_value(src_diff)));
} else {
/* also operation REPLACE but we need to change an opaque node into a data node */
LY_CHECK_RET(lyd_dup_single(src_diff, (*diff_match)->parent, LYD_DUP_NO_META | LYD_DUP_WITH_FLAGS, &src_dup));
if (!(*diff_match)->parent) {
/* will always be inserted before diff_match, which is opaque */
LY_CHECK_RET(lyd_insert_sibling(*diff_match, src_dup, diff));
}
to_free = *diff_match;
*diff_match = src_dup;
r = lyd_new_meta(ctx, src_dup, NULL, "yang:orig-value", lyd_get_value(to_free), LYD_NEW_VAL_STORE_ONLY, NULL);
lyd_free_tree(to_free);
LY_CHECK_RET(r);
LY_CHECK_RET(lyd_new_meta(ctx, src_dup, NULL, "yang:operation", lyd_diff_op2str(LYD_DIFF_OP_REPLACE), LYD_NEW_VAL_STORE_ONLY, NULL));
}
} else {
/* deleted + created -> operation NONE */
LY_CHECK_RET(lyd_diff_change_op(*diff_match, LYD_DIFF_OP_NONE));
}
assert((*diff_match)->schema);
if ((*diff_match)->schema->nodetype & LYD_NODE_TERM) {
/* add orig-dflt metadata */
LY_CHECK_RET(lyd_new_meta(LYD_CTX(src_diff), *diff_match, NULL, "yang:orig-default",
trg_flags & LYD_DEFAULT ? "true" : "false", LYD_NEW_VAL_STORE_ONLY, NULL));
/* update dflt flag itself */
(*diff_match)->flags &= ~LYD_DEFAULT;
(*diff_match)->flags |= src_diff->flags & LYD_DEFAULT;
}
/* but the operation of its children should remain DELETE */
LY_LIST_FOR(lyd_child_no_keys(*diff_match), child) {
LY_CHECK_RET(lyd_diff_change_op(child, LYD_DIFF_OP_DELETE));
}
break;
default:
/* create and replace operations are not valid */
LOGERR_MERGEOP(LYD_CTX(src_diff), *diff_match, cur_op, LYD_DIFF_OP_CREATE);
return LY_EINVAL;
}
return LY_SUCCESS;
}
/**
* @brief Update operations on a diff node when the new operation is DELETE.
*
* @param[in] diff_match Node from the diff.
* @param[in] cur_op Current operation of @p diff_match.
* @param[in] src_diff Current source diff node.
* @return LY_ERR value.
*/
static LY_ERR
lyd_diff_merge_delete(struct lyd_node *diff_match, enum lyd_diff_op cur_op, const struct lyd_node *src_diff)
{
struct lyd_node *child;
struct lyd_meta *meta;
struct lyd_attr *attr;
const char *meta_name;
const struct ly_ctx *ctx = LYD_CTX(diff_match);
LY_ERR r;
/* we can delete only exact existing nodes */
LY_CHECK_ERR_RET(lyd_compare_single(diff_match, src_diff, 0), LOGINT(LYD_CTX(src_diff)), LY_EINT);
switch (cur_op) {
case LYD_DIFF_OP_CREATE:
/* it was created, but then deleted -> set NONE operation */
LY_CHECK_RET(lyd_diff_change_op(diff_match, LYD_DIFF_OP_NONE));
if (diff_match->schema->nodetype & LYD_NODE_TERM) {
/* add orig-default meta because it is expected */
LY_CHECK_RET(lyd_new_meta(LYD_CTX(src_diff), diff_match, NULL, "yang:orig-default",
src_diff->flags & LYD_DEFAULT ? "true" : "false", LYD_NEW_VAL_STORE_ONLY, NULL));
}
break;
case LYD_DIFF_OP_REPLACE:
/* remove the redundant metadata */
if (lysc_is_userordered(diff_match->schema)) {
if (lysc_is_dup_inst_list(diff_match->schema)) {
meta_name = "position";
} else if (diff_match->schema->nodetype == LYS_LIST) {
meta_name = "key";
} else {
meta_name = "value";
}
} else {
assert(diff_match->schema->nodetype == LYS_LEAF);
/* switch value for the original one */
meta = lyd_find_meta(diff_match->meta, NULL, "yang:orig-value");
LY_CHECK_ERR_RET(!meta, LOGERR_META(ctx, "yang:orig-value", diff_match), LY_EINVAL);
if (lyd_change_term(diff_match, lyd_get_meta_value(meta))) {
LOGERR_UNEXPVAL(ctx, diff_match, "target diff");
return LY_EINVAL;
}
/* switch default for the original one, then remove the meta */
meta = lyd_find_meta(diff_match->meta, NULL, "yang:orig-default");
LY_CHECK_ERR_RET(!meta, LOGERR_META(ctx, "yang:orig-default", diff_match), LY_EINVAL);
diff_match->flags &= ~LYD_DEFAULT;
if (meta->value.boolean) {
diff_match->flags |= LYD_DEFAULT;
}
lyd_free_meta_single(meta);
meta_name = "orig-value";
}
lyd_diff_del_meta(diff_match, meta_name);
/* it was being changed, but should be deleted instead -> set DELETE operation */
LY_CHECK_RET(lyd_diff_change_op(diff_match, LYD_DIFF_OP_DELETE));
break;
case LYD_DIFF_OP_NONE:
/* it was not modified, but should be deleted -> set DELETE operation */
LY_CHECK_RET(lyd_diff_change_op(diff_match, LYD_DIFF_OP_DELETE));
break;
default:
/* delete operation is not valid */
LOGERR_MERGEOP(LYD_CTX(diff_match), diff_match, cur_op, LYD_DIFF_OP_DELETE);
return LY_EINVAL;
}
if (!lysc_is_dup_inst_list(diff_match->schema)) {
/* keep operation without one for descendants that are yet to be merged */
LY_LIST_FOR(lyd_child_no_keys(diff_match), child) {
lyd_diff_find_meta(child, "operation", &meta, &attr);
if (meta || attr) {
continue;
}
if (!child->schema) {
r = lyd_find_sibling_opaq_next(lyd_child(src_diff), LYD_NAME(child), NULL);
} else if (child->schema->nodetype & (LYS_LIST | LYS_LEAFLIST)) {
r = lyd_find_sibling_first(lyd_child(src_diff), child, NULL);
} else {
r = lyd_find_sibling_val(lyd_child(src_diff), child->schema, NULL, 0, NULL);
}
if (!r) {
LY_CHECK_RET(lyd_diff_change_op(child, cur_op));
} else if (r != LY_ENOTFOUND) {
return r;
}
}
} /* else key-less list, for which all the descendants act as keys */
return LY_SUCCESS;
}
/**
* @brief Check whether this diff node is redundant (does not change data).
*
* @param[in] diff Diff node.
* @return 0 if not, non-zero if it is.
*/
static int
lyd_diff_is_redundant(struct lyd_node *diff)
{
enum lyd_diff_op op;
struct lyd_meta *meta, *orig_val_meta = NULL, *val_meta = NULL;
struct lyd_node *child;
const struct lys_module *mod;
const char *str, *orig_meta_name, *meta_name;
assert(diff);
if (lysc_is_dup_inst_list(diff->schema)) {
/* all descendants are keys */
child = NULL;
} else {
child = lyd_child_no_keys(diff);
}
mod = ly_ctx_get_module_latest(LYD_CTX(diff), "yang");
assert(mod);
/* get node operation */
LY_CHECK_RET(lyd_diff_get_op(diff, &op), 0);
if ((op == LYD_DIFF_OP_REPLACE) && lysc_is_userordered(diff->schema)) {
/* get metadata names */
if (lysc_is_dup_inst_list(diff->schema)) {
meta_name = "position";
orig_meta_name = "orig-position";
} else if (diff->schema->nodetype == LYS_LIST) {
meta_name = "key";
orig_meta_name = "orig-key";
} else {
meta_name = "value";
orig_meta_name = "orig-value";
}
/* check for redundant move */
orig_val_meta = lyd_find_meta(diff->meta, mod, orig_meta_name);
val_meta = lyd_find_meta(diff->meta, mod, meta_name);
assert(orig_val_meta && val_meta);
if (!lyd_compare_meta(orig_val_meta, val_meta)) {
/* there is actually no move */
lyd_free_meta_single(orig_val_meta);
lyd_free_meta_single(val_meta);
if (child) {
/* change operation to NONE, we have siblings */
lyd_diff_change_op(diff, LYD_DIFF_OP_NONE);
return 0;
}
/* redundant node, BUT !!
* In diff the move operation is always converted to be INSERT_AFTER, which is fine
* because the data that this is applied on should not change for the diff lifetime.
* However, when we are merging 2 diffs, this conversion is actually lossy because
* if the data change, the move operation can also change its meaning. In this specific
* case the move operation will be lost. But it can be considered a feature, it is not supported.
*/
return 1;
}
} else if (op == LYD_DIFF_OP_NONE) {
if (!diff->schema) {
/* opaque node with none must be redundant */
return 1;
}
if (diff->schema->nodetype & LYD_NODE_TERM) {
/* check whether at least the default flags are different */
meta = lyd_find_meta(diff->meta, mod, "orig-default");
assert(meta);
str = lyd_get_meta_value(meta);
/* if previous and current dflt flags are the same, this node is redundant */
if ((!strcmp(str, "true") && (diff->flags & LYD_DEFAULT)) || (!strcmp(str, "false") && !(diff->flags & LYD_DEFAULT))) {
return 1;
}
return 0;
}
}
if (!child && (op == LYD_DIFF_OP_NONE)) {
return 1;
}
return 0;
}
/**
* @brief Merge sysrepo diff subtree with another diff, recursively.
*
* @param[in] src_diff Source diff node.
* @param[in] diff_parent Current sysrepo diff parent.
* @param[in] diff_cb Optional diff callback.
* @param[in] cb_data User data for @p diff_cb.
* @param[in,out] dup_inst Duplicate instance cache for all @p src_diff siblings.
* @param[in] options Diff merge options.
* @param[in,out] diff Diff root node.
* @return LY_ERR value.
*/
static LY_ERR
lyd_diff_merge_r(const struct lyd_node *src_diff, struct lyd_node *diff_parent, lyd_diff_cb diff_cb, void *cb_data,
struct ly_ht **dup_inst, uint16_t options, struct lyd_node **diff)
{
LY_ERR ret = LY_SUCCESS;
struct lyd_node *child, *diff_node = NULL;
enum lyd_diff_op src_op, cur_op;
struct ly_ht *child_dup_inst = NULL;
/* get source node operation */
LY_CHECK_RET(lyd_diff_get_op(src_diff, &src_op));
/* find an equal node in the current diff */
LY_CHECK_RET(lyd_diff_find_match(diff_parent ? lyd_child_no_keys(diff_parent) : *diff, src_diff, 1, dup_inst, &diff_node));
if (diff_node) {
/* get target (current) operation */
LY_CHECK_RET(lyd_diff_get_op(diff_node, &cur_op));
/* merge operations */
switch (src_op) {
case LYD_DIFF_OP_REPLACE:
ret = lyd_diff_merge_replace(diff_node, cur_op, src_diff);
break;
case LYD_DIFF_OP_CREATE:
if ((cur_op == LYD_DIFF_OP_CREATE) && lysc_is_dup_inst_list(diff_node->schema)) {
/* special case of creating duplicate (leaf-)list instances */
goto add_diff;
}
ret = lyd_diff_merge_create(&diff_node, diff, cur_op, src_diff, options);
break;
case LYD_DIFF_OP_DELETE:
ret = lyd_diff_merge_delete(diff_node, cur_op, src_diff);
break;
case LYD_DIFF_OP_NONE:
/* key-less list can never have "none" operation since all its descendants are acting as "keys" */
assert((src_diff->schema->nodetype != LYS_LIST) || !lysc_is_dup_inst_list(src_diff->schema));
ret = lyd_diff_merge_none(diff_node, cur_op, src_diff);
break;
default:
LOGINT_RET(LYD_CTX(src_diff));
}
if (ret) {
LOGERR(LYD_CTX(src_diff), LY_EOTHER, "Merging operation \"%s\" failed.", lyd_diff_op2str(src_op));
return ret;
}
if (diff_cb) {
/* call callback */
LY_CHECK_RET(diff_cb(src_diff, diff_node, cb_data));
}
/* update diff parent */
diff_parent = diff_node;
/* for diff purposes, all key-less list descendants actually act as keys (identifying the same instances),
* so there is nothing to merge for these "keys" */
if (!lysc_is_dup_inst_list(src_diff->schema)) {
/* merge src_diff recursively */
LY_LIST_FOR(lyd_child_no_keys(src_diff), child) {
ret = lyd_diff_merge_r(child, diff_parent, diff_cb, cb_data, &child_dup_inst, options, diff);
if (ret) {
break;
}
}
lyd_dup_inst_free(child_dup_inst);
LY_CHECK_RET(ret);
}
} else {
add_diff:
/* add new diff node with all descendants */
if ((src_diff->flags & LYD_EXT) && diff_parent) {
LY_CHECK_RET(lyd_dup_single_to_ctx(src_diff, LYD_CTX(diff_parent), (struct lyd_node_inner *)diff_parent,
LYD_DUP_RECURSIVE | LYD_DUP_WITH_FLAGS | LYD_DUP_NO_LYDS, &diff_node));
} else {
LY_CHECK_RET(lyd_dup_single(src_diff, (struct lyd_node_inner *)diff_parent,
LYD_DUP_RECURSIVE | LYD_DUP_WITH_FLAGS | LYD_DUP_NO_LYDS, &diff_node));
}
/* insert node into diff if not already */
if (!diff_parent) {
lyd_diff_insert_sibling(*diff, diff_node, diff);
}
/* update operation */
LY_CHECK_RET(lyd_diff_change_op(diff_node, src_op));
if (diff_cb) {
/* call callback with no source diff node since it was duplicated and just added */
LY_CHECK_RET(diff_cb(NULL, diff_node, cb_data));
}
/* update diff parent */
diff_parent = diff_node;
}
/* remove any redundant nodes */
if (lyd_diff_is_redundant(diff_parent)) {
if (diff_parent == *diff) {
*diff = (*diff)->next;
}
lyd_free_tree(diff_parent);
}
return LY_SUCCESS;
}
LIBYANG_API_DEF LY_ERR
lyd_diff_merge_module(struct lyd_node **diff, const struct lyd_node *src_diff, const struct lys_module *mod,
lyd_diff_cb diff_cb, void *cb_data, uint16_t options)
{
const struct lyd_node *src_root;
struct ly_ht *dup_inst = NULL;
LY_ERR ret = LY_SUCCESS;
LY_LIST_FOR(src_diff, src_root) {
if (mod && (lyd_owner_module(src_root) != mod)) {
/* skip data nodes from different modules */
continue;
}
/* apply relevant nodes from the diff datatree */
LY_CHECK_GOTO(ret = lyd_diff_merge_r(src_root, NULL, diff_cb, cb_data, &dup_inst, options, diff), cleanup);
}
cleanup:
lyd_dup_inst_free(dup_inst);
return ret;
}
LIBYANG_API_DEF LY_ERR
lyd_diff_merge_tree(struct lyd_node **diff_first, struct lyd_node *diff_parent, const struct lyd_node *src_sibling,
lyd_diff_cb diff_cb, void *cb_data, uint16_t options)
{
LY_ERR ret;
struct ly_ht *dup_inst = NULL;
if (!src_sibling) {
return LY_SUCCESS;
}
ret = lyd_diff_merge_r(src_sibling, diff_parent, diff_cb, cb_data, &dup_inst, options, diff_first);
lyd_dup_inst_free(dup_inst);
return ret;
}
LIBYANG_API_DEF LY_ERR
lyd_diff_merge_all(struct lyd_node **diff, const struct lyd_node *src_diff, uint16_t options)
{
return lyd_diff_merge_module(diff, src_diff, NULL, NULL, NULL, options);
}
static LY_ERR
lyd_diff_reverse_value(struct lyd_node *node, const struct lys_module *mod)
{
LY_ERR ret = LY_SUCCESS;
struct lyd_meta *meta;
const char *val1 = NULL;
char *val2;
uint32_t flags;
assert(node->schema->nodetype & (LYS_LEAF | LYS_ANYDATA));
meta = lyd_find_meta(node->meta, mod, "orig-value");
LY_CHECK_ERR_RET(!meta, LOGERR_META(LYD_CTX(node), "orig-value", node), LY_EINVAL);
/* orig-value */
val1 = lyd_get_meta_value(meta);
/* current value */
if (node->schema->nodetype == LYS_LEAF) {
val2 = strdup(lyd_get_value(node));
} else {
LY_CHECK_RET(lyd_any_value_str(node, &val2));
}
/* switch values, keep default flag */
flags = node->flags;
if (node->schema->nodetype == LYS_LEAF) {
LY_CHECK_GOTO(ret = lyd_change_term(node, val1), cleanup);
} else {
union lyd_any_value anyval = {.str = val1};
LY_CHECK_GOTO(ret = lyd_any_copy_value(node, &anyval, LYD_ANYDATA_STRING), cleanup);
}
node->flags = flags;
LY_CHECK_GOTO(ret = lyd_change_meta(meta, val2), cleanup);
cleanup:
free(val2);
return ret;
}
static LY_ERR
lyd_diff_reverse_default(struct lyd_node *node, const struct lys_module *mod)
{
struct lyd_meta *meta;
uint32_t flag1, flag2;
meta = lyd_find_meta(node->meta, mod, "orig-default");
LY_CHECK_ERR_RET(!meta, LOGINT(mod->ctx), LY_EINT);
/* orig-default */
if (meta->value.boolean) {
flag1 = LYD_DEFAULT;
} else {
flag1 = 0;
}
/* current default */
flag2 = node->flags & LYD_DEFAULT;
if (flag1 == flag2) {
/* no default state change so nothing to reverse */
return LY_SUCCESS;
}
/* switch defaults */
node->flags &= ~LYD_DEFAULT;
node->flags |= flag1;
LY_CHECK_RET(lyd_change_meta(meta, flag2 ? "true" : "false"));
return LY_SUCCESS;
}
static LY_ERR
lyd_diff_reverse_meta(struct lyd_node *node, const struct lys_module *mod, const char *name1, const char *name2)
{
LY_ERR ret = LY_SUCCESS;
struct lyd_meta *meta1, *meta2;
const char *val1 = NULL;
char *val2 = NULL;
meta1 = lyd_find_meta(node->meta, mod, name1);
LY_CHECK_ERR_RET(!meta1, LOGERR_META(LYD_CTX(node), name1, node), LY_EINVAL);
meta2 = lyd_find_meta(node->meta, mod, name2);
LY_CHECK_ERR_RET(!meta2, LOGERR_META(LYD_CTX(node), name2, node), LY_EINVAL);
/* value1 */
val1 = lyd_get_meta_value(meta1);
/* value2 */
val2 = strdup(lyd_get_meta_value(meta2));
/* switch values */
LY_CHECK_GOTO(ret = lyd_change_meta(meta1, val2), cleanup);
LY_CHECK_GOTO(ret = lyd_change_meta(meta2, val1), cleanup);
cleanup:
free(val2);
return ret;
}
/**
* @brief Remove specific operation from all the nodes in a subtree.
*
* @param[in] diff Diff subtree to process.
* @param[in] op Only expected operation.
* @return LY_ERR value.
*/
static LY_ERR
lyd_diff_reverse_remove_op_r(struct lyd_node *diff, enum lyd_diff_op op)
{
struct lyd_node *elem;
struct lyd_meta *meta;
LYD_TREE_DFS_BEGIN(diff, elem) {
meta = lyd_find_meta(elem->meta, NULL, "yang:operation");
if (meta) {
LY_CHECK_ERR_RET(lyd_diff_str2op(lyd_get_meta_value(meta)) != op, LOGINT(LYD_CTX(diff)), LY_EINT);
lyd_free_meta_single(meta);
}
LYD_TREE_DFS_END(diff, elem);
}
return LY_SUCCESS;
}
LIBYANG_API_DEF LY_ERR
lyd_diff_reverse_all(const struct lyd_node *src_diff, struct lyd_node **diff)
{
LY_ERR ret = LY_SUCCESS;
const struct lys_module *mod;
struct lyd_node *root, *elem, *iter;
enum lyd_diff_op op;
LY_CHECK_ARG_RET(NULL, diff, LY_EINVAL);
if (!src_diff) {
*diff = NULL;
return LY_SUCCESS;
}
/* duplicate diff */
LY_CHECK_RET(lyd_dup_siblings(src_diff, NULL, LYD_DUP_RECURSIVE | LYD_DUP_NO_LYDS, diff));
/* find module with metadata needed for later */
mod = ly_ctx_get_module_latest(LYD_CTX(src_diff), "yang");
LY_CHECK_ERR_GOTO(!mod, LOGINT(LYD_CTX(src_diff)); ret = LY_EINT, cleanup);
LY_LIST_FOR(*diff, root) {
LYD_TREE_DFS_BEGIN(root, elem) {
/* skip all keys */
if (!lysc_is_key(elem->schema)) {
/* find operation attribute, if any */
LY_CHECK_GOTO(ret = lyd_diff_get_op(elem, &op), cleanup);
switch (op) {
case LYD_DIFF_OP_CREATE:
/* reverse create to delete */
LY_CHECK_GOTO(ret = lyd_diff_change_op(elem, LYD_DIFF_OP_DELETE), cleanup);
/* check all the children for the same operation, nothing else is expected */
LY_LIST_FOR(lyd_child(elem), iter) {
lyd_diff_reverse_remove_op_r(iter, LYD_DIFF_OP_CREATE);
}
LYD_TREE_DFS_continue = 1;
break;
case LYD_DIFF_OP_DELETE:
/* reverse delete to create */
LY_CHECK_GOTO(ret = lyd_diff_change_op(elem, LYD_DIFF_OP_CREATE), cleanup);
/* check all the children for the same operation, nothing else is expected */
LY_LIST_FOR(lyd_child(elem), iter) {
lyd_diff_reverse_remove_op_r(iter, LYD_DIFF_OP_DELETE);
}
LYD_TREE_DFS_continue = 1;
break;
case LYD_DIFF_OP_REPLACE:
switch (elem->schema->nodetype) {
case LYS_LEAF:
/* leaf value change */
LY_CHECK_GOTO(ret = lyd_diff_reverse_value(elem, mod), cleanup);
LY_CHECK_GOTO(ret = lyd_diff_reverse_default(elem, mod), cleanup);
break;
case LYS_ANYXML:
case LYS_ANYDATA:
/* any value change */
LY_CHECK_GOTO(ret = lyd_diff_reverse_value(elem, mod), cleanup);
break;
case LYS_LEAFLIST:
/* leaf-list move */
LY_CHECK_GOTO(ret = lyd_diff_reverse_default(elem, mod), cleanup);
if (lysc_is_dup_inst_list(elem->schema)) {
LY_CHECK_GOTO(ret = lyd_diff_reverse_meta(elem, mod, "orig-position", "position"), cleanup);
} else {
LY_CHECK_GOTO(ret = lyd_diff_reverse_meta(elem, mod, "orig-value", "value"), cleanup);
}
break;
case LYS_LIST:
/* list move */
if (lysc_is_dup_inst_list(elem->schema)) {
LY_CHECK_GOTO(ret = lyd_diff_reverse_meta(elem, mod, "orig-position", "position"), cleanup);
} else {
LY_CHECK_GOTO(ret = lyd_diff_reverse_meta(elem, mod, "orig-key", "key"), cleanup);
}
break;
default:
LOGINT(LYD_CTX(src_diff));
ret = LY_EINT;
goto cleanup;
}
break;
case LYD_DIFF_OP_NONE:
switch (elem->schema->nodetype) {
case LYS_LEAF:
case LYS_LEAFLIST:
/* default flag change */
LY_CHECK_GOTO(ret = lyd_diff_reverse_default(elem, mod), cleanup);
break;
default:
/* nothing to do */
break;
}
break;
}
}
LYD_TREE_DFS_END(root, elem);
}
}
cleanup:
if (ret) {
lyd_free_siblings(*diff);
*diff = NULL;
}
return ret;
}
|