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
|
// file : libbuild2/adhoc-rule-buildscript.cxx -*- C++ -*-
// license : MIT; see accompanying LICENSE file
#include <libbuild2/adhoc-rule-buildscript.hxx>
#include <sstream>
#include <libbutl/filesystem.hxx> // try_rm_file()
#include <libbuild2/depdb.hxx>
#include <libbuild2/scope.hxx>
#include <libbuild2/target.hxx>
#include <libbuild2/dyndep.hxx>
#include <libbuild2/context.hxx>
#include <libbuild2/algorithm.hxx>
#include <libbuild2/filesystem.hxx> // path_perms(), auto_rmfile
#include <libbuild2/diagnostics.hxx>
#include <libbuild2/make-parser.hxx>
#include <libbuild2/parser.hxx> // attributes
#include <libbuild2/build/script/parser.hxx>
#include <libbuild2/build/script/runner.hxx>
using namespace std;
namespace build2
{
static inline void
hash_script_vars (sha256& cs,
const build::script::script& s,
const scope& bs,
const target& t,
names& storage)
{
auto& vp (bs.var_pool ());
for (const string& n: s.vars)
{
cs.append (n);
lookup l;
if (const variable* var = vp.find (n))
l = t[var];
cs.append (!l.defined () ? '\x1' : l->null ? '\x2' : '\x3');
if (l)
{
storage.clear ();
names_view ns (reverse (*l, storage, true /* reduce */));
for (const name& n: ns)
to_checksum (cs, n);
}
}
}
// How should we hash target and prerequisite sets ($> and $<)? We could
// hash them as target names (i.e., the same as the $>/< content) or as
// paths (only for path-based targets). While names feel more general, they
// are also more expensive to compute. And for path-based targets, path is
// generally a good proxy for the target name. Since the bulk of the ad hoc
// recipes will presumably be operating exclusively on path-based targets,
// let's do it both ways.
//
static inline void
hash_target (sha256& cs, const target& t, names& storage)
{
if (const path_target* pt = t.is_a<path_target> ())
cs.append (pt->path ().string ());
else
{
storage.clear ();
t.as_name (storage);
for (const name& n: storage)
to_checksum (cs, n);
}
};
// The script can reference a program in one of four ways:
//
// 1. As an (imported) target (e.g., $cli)
//
// 2. As a process_path_ex (e.g., $cxx.path).
//
// 3. As a builtin (e.g., sed)
//
// 4. As a program path/name.
//
// When it comes to change tracking, there is nothing we can do for (4) (the
// user can track its environment manually with depdb-env) and there is
// nothing to do for (3) (assuming builtin semantics is stable/backwards-
// compatible). The (2) case is handled automatically by hashing all the
// variable values referenced by the script (see below), which in case of
// process_path_ex includes the checksums (both executable and environment),
// if available.
//
// This leaves the (1) case, which itself splits into two sub-cases: the
// target comes with the dependency information (e.g., imported from a
// project via an export stub) or it does not (e.g., imported as installed).
// We don't need to do anything extra for the first sub-case since the
// target's state/mtime can be relied upon like any other prerequisite.
// Which cannot be said about the second sub-case, where we reply on
// checksum that may be included as part of the target metadata.
//
// So what we are going to do is hash checksum metadata of every executable
// prerequisite target that has it (we do it here in order to include ad hoc
// prerequisites, which feels like the right thing to do; the user may mark
// tools as ad hoc in order to omit them from $<).
//
static inline void
hash_prerequisite_target (sha256& cs, sha256& exe_cs, sha256& env_cs,
const target& pt,
names& storage)
{
hash_target (cs, pt, storage);
if (const exe* et = pt.is_a<exe> ())
{
if (const string* c = et->lookup_metadata<string> ("checksum"))
{
exe_cs.append (*c);
}
if (const strings* e = et->lookup_metadata<strings> ("environment"))
{
hash_environment (env_cs, *e);
}
}
}
bool adhoc_buildscript_rule::
recipe_text (const scope& s,
const target_type& tt,
string&& t,
attributes& as)
{
// Handle and erase recipe-specific attributes.
//
optional<string> diag;
for (auto i (as.begin ()); i != as.end (); )
{
attribute& a (*i);
const string& n (a.name);
if (n == "diag")
try
{
diag = convert<string> (move (a.value));
}
catch (const invalid_argument& e)
{
fail (as.loc) << "invalid " << n << " attribute value: " << e;
}
else
{
++i;
continue;
}
i = as.erase (i);
}
checksum = sha256 (t).string ();
ttype = &tt;
istringstream is (move (t));
build::script::parser p (s.ctx);
script = p.pre_parse (s, tt, actions,
is, loc.file, loc.line + 1,
move (diag), as.loc);
return false;
}
void adhoc_buildscript_rule::
dump_attributes (ostream& os) const
{
// For now we dump it as an attribute whether it was specified or derived
// from the script. Maybe that's ok (we use this in tests)?
//
if (script.diag_name)
{
os << " [";
os << "diag=";
to_stream (os, name (*script.diag_name), quote_mode::normal, '@');
os << ']';
}
}
void adhoc_buildscript_rule::
dump_text (ostream& os, string& ind) const
{
os << ind << string (braces, '{') << endl;
ind += " ";
if (script.depdb_clear)
os << ind << "depdb clear" << endl;
script::dump (os, ind, script.depdb_preamble);
script::dump (os, ind, script.diag_preamble);
script::dump (os, ind, script.body);
ind.resize (ind.size () - 2);
os << ind << string (braces, '}');
}
bool adhoc_buildscript_rule::
reverse_fallback (action a, const target_type& tt) const
{
// We can provide clean for a file or group target if we are providing
// update.
//
return (a == perform_clean_id &&
(tt.is_a<file> () || tt.is_a<group> ()) &&
find (actions.begin (), actions.end (),
perform_update_id) != actions.end ());
}
using dynamic_target = build::script::parser::dynamic_target;
using dynamic_targets = build::script::parser::dynamic_targets;
struct adhoc_buildscript_rule::match_data
{
match_data (action a, const target& t, const scope& bs, bool temp_dir)
: env (a, t, bs, temp_dir) {}
build::script::environment env;
build::script::default_runner run;
path dd;
dynamic_targets dyn_targets;
const scope* bs;
timestamp mt;
bool deferred_failure;
};
struct adhoc_buildscript_rule::match_data_byproduct
{
match_data_byproduct (action a, const target& t,
const scope& bs,
bool temp_dir)
: env (a, t, bs, temp_dir) {}
build::script::environment env;
build::script::default_runner run;
build::script::parser::dyndep_byproduct byp;
depdb::reopen_state dd;
size_t skip_count = 0;
size_t pts_n; // Number of static prerequisites in prerequisite_targets.
const scope* bs;
timestamp mt;
};
bool adhoc_buildscript_rule::
match (action a, target& xt, const string& h, match_extra& me) const
{
const target& t (xt); // See adhoc_rule::match().
// We pre-parsed the script with the assumption it will be used on a
// non/file-based (or file group-based) target. Note that this should not
// be possible with patterns.
//
if (pattern == nullptr)
{
// Let's not allow mixing file/group.
//
if ((t.is_a<file> () != nullptr) == ttype->is_a<file> () ||
(t.is_a<group> () != nullptr) == ttype->is_a<group> ())
;
else
fail (loc) << "incompatible target types used with shared recipe" <<
info << "all targets must be file- or file group-based or non";
}
return adhoc_rule::match (a, xt, h, me);
}
recipe adhoc_buildscript_rule::
apply (action a, target& t, match_extra& me) const
{
return apply (a, t, me, nullopt);
}
recipe adhoc_buildscript_rule::
apply (action a,
target& t,
match_extra& me,
const optional<timestamp>& deadline) const
{
tracer trace ("adhoc_buildscript_rule::apply");
// Handle matching group members (see adhoc_rule::match() for background).
//
if (const group* g = t.group != nullptr ? t.group->is_a<group> () : nullptr)
{
match_sync (a, *g);
return group_recipe; // Execute the group's recipe.
}
// We don't support deadlines for any of these cases (see below).
//
if (deadline && (a.outer () ||
me.fallback ||
(a == perform_update_id &&
(t.is_a<file> () || t.is_a<group> ()))))
return empty_recipe;
// If this is an outer operation (e.g., update-for-test), then delegate to
// the inner.
//
if (a.outer ())
{
match_inner (a, t);
return inner_recipe;
}
context& ctx (t.ctx);
const scope& bs (t.base_scope ());
group* g (t.is_a<group> ()); // Explicit group.
// Inject pattern's ad hoc group members, if any (explicit group members
// are injected after reset below).
//
if (g == nullptr && pattern != nullptr)
pattern->apply_group_members (a, t, bs, me);
// Derive file names for the target and its static/ad hoc group members,
// if any.
//
if (a == perform_update_id || a == perform_clean_id)
{
if (g != nullptr)
{
g->reset_members (a); // See group::group_members() for background.
// Note that we rely on the fact that if the group has static members,
// then they always come first in members and the first static member
// is a file.
//
for (const target& m: g->static_members)
g->members.push_back (&m);
g->members_static = g->members.size ();
if (pattern != nullptr)
{
pattern->apply_group_members (a, *g, bs, me);
g->members_static = g->members.size ();
}
if (g->members_static == 0)
{
if (!script.depdb_dyndep_dyn_target)
fail << "group " << *g << " has no static or dynamic members";
}
else
{
if (!g->members.front ()->is_a<file> ())
{
// We use the first static member to derive depdb path, get mtime,
// etc. So it must be file-based.
//
fail << "first static member " << g->members.front ()
<< " of group " << *g << " is not a file";
}
// Derive paths for all the static members.
//
for (const target* m: g->members)
if (auto* p = m->is_a<path_target> ())
p->derive_path ();
}
}
else
{
for (target* m (&t); m != nullptr; m = m->adhoc_member)
{
if (auto* p = m->is_a<path_target> ())
p->derive_path ();
}
}
}
else if (g != nullptr)
{
// This could be, for example, configure/dist update which could need a
// "representative sample" of members (in order to be able to match the
// rules). So add static members unless we already have something
// cached.
//
if (g->group_members (a).members == nullptr) // Note: not g->member.
{
g->reset_members (a);
for (const target& m: g->static_members)
g->members.push_back (&m);
g->members_static = g->members.size ();
if (pattern != nullptr)
{
pattern->apply_group_members (a, *g, bs, me);
g->members_static = g->members.size ();
}
}
}
// Inject dependency on the output directory.
//
// We do it always instead of only if one of the targets is path-based in
// case the recipe creates temporary files or some such.
//
// Note that we disable the prerequisite search for fsdir{} because of the
// prerequisites injected by the pattern. So we have to handle this ad hoc
// below.
//
const fsdir* dir (inject_fsdir (a, t, false /* prereq */));
// Match prerequisites.
//
// This is essentially match_prerequisite_members() but with support
// for update=unmatch|match.
//
auto& pts (t.prerequisite_targets[a]);
{
// Re-create the clean semantics as in match_prerequisite_members().
//
bool clean (a.operation () == clean_id && !t.is_a<alias> ());
// Add target's prerequisites.
//
for (prerequisite_member p: group_prerequisite_members (a, t))
{
// Note that we have to recognize update=unmatch|match for *(update),
// not just perform(update). But only actually do anything about it
// for perform(update).
//
lookup l; // The `update` variable value, if any.
include_type pi (
include (a, t, p, a.operation () == update_id ? &l : nullptr));
// Use prerequisite_target::include to signal update during match or
// unmatch.
//
uintptr_t mask (0);
if (l)
{
const string& v (cast<string> (l));
if (v == "match")
{
if (a == perform_update_id)
mask = prerequisite_target::include_udm;
}
else if (v == "unmatch")
{
if (a == perform_update_id)
mask = include_unmatch;
}
else if (v != "false" && v != "true" && v != "execute")
{
fail << "unrecognized update variable value '" << v
<< "' specified for prerequisite " << p.prerequisite;
}
}
// Skip excluded.
//
if (!pi)
continue;
const target& pt (p.search (t));
if (&pt == dir) // Don't add injected fsdir{} twice.
continue;
if (clean && !pt.in (*bs.root_scope ()))
continue;
prerequisite_target pto (&pt, pi);
if (mask != 0)
pto.include |= mask;
pts.push_back (move (pto));
}
// Inject pattern's prerequisites, if any.
//
if (pattern != nullptr)
pattern->apply_prerequisites (a, t, bs, me);
// Start asynchronous matching of prerequisites. Wait with unlocked
// phase to allow phase switching.
//
wait_guard wg (ctx, ctx.count_busy (), t[a].task_count, true);
for (const prerequisite_target& pt: pts)
{
if (pt.target == dir) // Don't match injected fsdir{} twice.
continue;
match_async (a, *pt.target, ctx.count_busy (), t[a].task_count);
}
wg.wait ();
// Finish matching all the targets that we have started.
//
for (prerequisite_target& pt: pts)
{
if (pt.target == dir) // See above.
continue;
// Handle update=unmatch.
//
unmatch um ((pt.include & include_unmatch) != 0
? unmatch::safe
: unmatch::none);
pair<bool, target_state> mr (match_complete (a, *pt.target, um));
if (um != unmatch::none)
{
l6 ([&]{trace << "unmatch " << *pt.target << ": " << mr.first;});
// If we managed to unmatch, blank it out so that it's not executed,
// etc. Otherwise, leave it as is (but we still automatically avoid
// hashing it, updating it during match in exec_depdb_dyndep(), and
// making us out of date in execute_update_prerequisites()).
//
// The hashing part is tricky: by not hashing it we won't detect the
// case where it was removed as a prerequisite altogether. The
// thinking is that it was added with update=unmatch to extract some
// information (e.g., poptions from a library) and those will be
// change-tracked.
//
// Note: set the include_target flag for the updated_during_match()
// check.
//
if (mr.first)
{
pt.data = reinterpret_cast<uintptr_t> (pt.target);
pt.target = nullptr;
pt.include |= prerequisite_target::include_target;
// Note that this prerequisite could also be ad hoc and we must
// clear that flag if we managed to unmatch (failed that we will
// treat it as ordinary ad hoc since it has the target pointer in
// data).
//
// But that makes it impossible to distinguish ad hoc unmatch from
// ordinary unmatch prerequisites later when setting $<. Another
// flag to the rescue.
//
if ((pt.include & prerequisite_target::include_adhoc) != 0)
{
pt.include &= ~prerequisite_target::include_adhoc;
pt.include |= include_unmatch_adhoc;
}
}
}
}
}
// Read the list of dynamic targets and, optionally, fsdir{} prerequisites
// from depdb, if exists (used in a few depdb-dyndep --dyn-target handling
// places below).
//
auto read_dyn_targets = [] (path ddp, bool fsdir)
-> pair<dynamic_targets, dir_paths>
{
depdb dd (move (ddp), true /* read_only */);
pair<dynamic_targets, dir_paths> r;
while (dd.reading ()) // Breakout loop.
{
string* l;
auto read = [&dd, &l] () -> bool
{
return (l = dd.read ()) != nullptr;
};
if (!read ()) // Rule id.
break;
// We can omit this for as long as we don't break our blank line
// anchors semantics.
//
#if 0
if (*l != rule_id_)
fail << "unable to clean dynamic target group " << t
<< " with old depdb";
#endif
// Note that we cannot read out expected lines since there can be
// custom depdb builtins. So we use the blank lines as anchors to
// skip to the parts we need.
//
// Skip until the first blank that separated custom depdb entries from
// the prerequisites list.
{
bool g;
while ((g = read ()) && !l->empty ()) ;
if (!g)
break;
}
// Next read the prerequisites, detecting fsdir{} entries if asked.
//
{
bool g;
while ((g = read ()) && !l->empty ())
{
if (fsdir)
{
path p (*l);
if (p.to_directory ())
r.second.push_back (path_cast<dir_path> (move (p)));
}
}
if (!g)
break;
}
// Read the dynamic target files. We should always end with a blank
// line.
//
for (;;)
{
if (!read () || l->empty ())
break;
// Split into type and path.
//
size_t p (l->find (' '));
if (p == string::npos || // Invalid format.
p == 0 || // Empty type.
p + 1 == l->size ()) // Empty path.
break;
r.first.push_back (
dynamic_target {string (*l, 0, p), path (*l, p + 1, string::npos)});
}
break;
}
return r;
};
// Target path to derive the depdb path, query mtime (if file), etc.
//
// To derive the depdb path for a group with at least one static member we
// use the path of the first member. For a group without any static
// members we use the group name with the target type name as the
// second-level extension.
//
auto target_path = [&t, g, p = path ()] () mutable -> const path&
{
return
g == nullptr ? t.as<file> ().path () :
g->members_static != 0 ? g->members.front ()->as<file> ().path () :
(p = g->dir / (g->name + '.' + g->type ().name));
};
// See if we are providing the standard clean as a fallback.
//
if (me.fallback)
{
// For depdb-dyndep --dyn-target use depdb to clean dynamic targets.
//
if (script.depdb_dyndep_dyn_target)
{
// Note that only removing the relevant filesystem entries is not
// enough: we actually have to populate the group with members since
// this information could be used to clean derived targets (for
// example, object files). So we just do that and let the standard
// clean logic take care of them the same as static members.
//
// NOTE that this logic should be consistent with what we have in
// exec_depdb_dyndep().
//
using dyndep = dyndep_rule;
function<dyndep::group_filter_func> filter;
if (g != nullptr)
{
filter = [] (mtime_target& g, const build2::file& m)
{
auto& ms (g.as<group> ().members);
return find (ms.begin (), ms.end (), &m) == ms.end ();
};
}
pair<dynamic_targets, dir_paths> p (
read_dyn_targets (target_path () + ".d", true));
for (dynamic_target& dt: p.first)
{
path& f (dt.path);
// Resolve target type. Clean it as file if unable to.
//
const target_type* tt (bs.find_target_type (dt.type));
if (tt == nullptr)
tt = &file::static_type;
if (g != nullptr)
{
pair<const build2::file&, bool> r (
dyndep::inject_group_member (a, bs, *g, move (f), *tt, filter));
if (r.second)
g->members.push_back (&r.first);
}
else
{
// Note that here we don't bother cleaning any old dynamic targets
// -- the more we can clean, the merrier.
//
dyndep::inject_adhoc_group_member (a, bs, t, move (f), *tt);
}
}
// Enter fsdir{} prerequisites.
//
// See the add lambda in exec_depdb_dyndep() for background.
//
for (dir_path& d: p.second)
{
dir_path o; string n; // For GCC 13 -Wdangling-reference.
const fsdir& dt (search<fsdir> (t,
move (d),
move (o),
move (n), nullptr, nullptr));
match_sync (a, dt);
pts.push_back (prerequisite_target (&dt, true /* adhoc */));
}
}
return g == nullptr ? perform_clean_file : perform_clean_group;
}
// If we have any update during match prerequisites, now is the time to
// update them.
//
// Note that we ignore the result and whether it renders us out of date,
// leaving it to the common execute logic in perform_update_*().
//
// Note also that update_during_match_prerequisites() spoils
// prerequisite_target::data.
//
if (a == perform_update_id)
update_during_match_prerequisites (trace, a, t);
// See if this is not update or not on a file/group-based target.
//
if (a != perform_update_id || !(g != nullptr || t.is_a<file> ()))
{
// Make sure we get small object optimization.
//
if (deadline)
{
return [dv = *deadline, this] (action a, const target& t)
{
return default_action (a, t, dv);
};
}
else
{
return [this] (action a, const target& t)
{
return default_action (a, t, nullopt);
};
}
}
// This is a perform update on a file or group target.
//
// See if this is the simple case with only static dependencies.
//
if (!script.depdb_dyndep)
{
return [this] (action a, const target& t)
{
return perform_update_file_or_group (a, t);
};
}
// This is a perform update on a file or group target with extraction of
// dynamic dependency information either in the depdb preamble
// (depdb-dyndep without --byproduct) or as a byproduct of the recipe body
// execution (depdb-dyndep with --byproduct).
//
// For the former case, we may need to add additional prerequisites (or
// even target group members). We also have to save any such additional
// prerequisites in depdb so that we can check if any of them have changed
// on subsequent updates. So all this means that we have to take care of
// depdb here in apply() instead of perform_*() like we normally do. We
// also do things in slightly different order due to the restrictions
// impose by the match phase.
//
// The latter case (depdb-dyndep --byproduct) is sort of a combination
// of the normal dyndep and the static case: we check the depdb during
// match but save after executing the recipe.
//
// Note that the C/C++ header dependency extraction is the canonical
// example and all this logic is based on the prior work in the cc module
// where you can often find more detailed rationale for some of the steps
// performed (like the fsdir update below).
// Re-acquire fsdir{} specified by the user, similar to inject_fsdir()
// (which we have disabled; see above).
//
if (dir == nullptr)
{
for (const target* pt: pts)
{
if (pt != nullptr)
{
if (const fsdir* dt = pt->is_a<fsdir> ())
{
if (dt->dir == t.dir)
{
dir = dt;
break;
}
}
}
}
}
if (dir != nullptr)
fsdir_rule::perform_update_direct (a, t);
// Because the depdb preamble can access $<, we have to blank out all the
// ad hoc prerequisites. Since we will still need them later, we "move"
// them to the auxiliary data member in prerequisite_target (see
// execute_update_prerequisites() for details).
//
// Note: set the include_target flag for the updated_during_match() check.
//
for (prerequisite_target& p: pts)
{
// Note that fsdir{} injected above is adhoc.
//
if (p.target != nullptr && p.adhoc ())
{
p.data = reinterpret_cast<uintptr_t> (p.target);
p.target = nullptr;
p.include |= prerequisite_target::include_target;
}
}
const path& tp (target_path ());
// Note that while it's tempting to turn match_data* into recipes, some of
// their members are not movable. And in the end we will have the same
// result: one dynamic memory allocation.
//
unique_ptr<match_data> md;
unique_ptr<match_data_byproduct> mdb;
dynamic_targets old_dyn_targets;
if (script.depdb_dyndep_byproduct)
{
mdb.reset (new match_data_byproduct (
a, t, bs, script.depdb_preamble_temp_dir));
}
else
{
md.reset (new match_data (a, t, bs, script.depdb_preamble_temp_dir));
// If the set of dynamic targets can change based on changes to the
// inputs (say, each entity, such as a type, in the input file gets its
// own output file), then we can end up with a large number of old
// output files laying around because they are not part of the new
// dynamic target set. So we try to clean them up based on the old depdb
// information, similar to how we do it for perform_clean above (except
// here we will just keep the list of old files).
//
// Note: do before opening depdb, which can start over-writing it.
//
// We also have to do this speculatively, without knowing whether we
// will need to update. Oh, well, being dynamic ain't free.
//
if (script.depdb_dyndep_dyn_target)
old_dyn_targets = read_dyn_targets (tp + ".d", false).first;
}
depdb dd (tp + ".d");
// NOTE: see the "static dependencies" version (with comments) below.
//
// NOTE: We use blank lines as anchors to skip directly to certain entries
// (e.g., dynamic targets). So make sure none of the other entries
// can be blank (for example, see `depdb string` builtin).
//
// NOTE: KEEP IN SYNC WITH read_dyn_targets ABOVE!
//
if (dd.expect ("<ad hoc buildscript recipe> 1") != nullptr)
l4 ([&]{trace << "rule mismatch forcing update of " << t;});
if (dd.expect (checksum) != nullptr)
l4 ([&]{trace << "recipe text change forcing update of " << t;});
if (!script.depdb_clear)
{
names storage;
sha256 prq_cs, exe_cs, env_cs;
for (const prerequisite_target& p: pts)
{
if (const target* pt =
(p.target != nullptr ? p.target :
p.adhoc () ? reinterpret_cast<target*> (p.data) :
nullptr))
{
if ((p.include & include_unmatch) != 0) // Skip update=unmatch.
continue;
hash_prerequisite_target (prq_cs, exe_cs, env_cs, *pt, storage);
}
}
{
sha256 cs;
hash_script_vars (cs, script, bs, t, storage);
if (dd.expect (cs.string ()) != nullptr)
l4 ([&]{trace << "recipe variable change forcing update of " << t;});
}
// Static targets and prerequisites (there can also be dynamic targets;
// see dyndep --dyn-target).
//
{
sha256 tcs;
if (g == nullptr)
{
// There is a nuance: in an operation batch (e.g., `b update
// update`) we will already have the dynamic targets as members on
// the subsequent operations and we need to make sure we don't treat
// them as static. Using target_decl to distinguish the two seems
// like a natural way.
//
for (const target* m (&t); m != nullptr; m = m->adhoc_member)
{
if (m->decl == target_decl::real)
hash_target (tcs, *m, storage);
}
}
else
{
// Feels like there is not much sense in hashing the group itself.
//
for (const target* m: g->members)
hash_target (tcs, *m, storage);
}
if (dd.expect (tcs.string ()) != nullptr)
l4 ([&]{trace << "target set change forcing update of " << t;});
if (dd.expect (prq_cs.string ()) != nullptr)
l4 ([&]{trace << "prerequisite set change forcing update of " << t;});
}
{
if (dd.expect (exe_cs.string ()) != nullptr)
l4 ([&]{trace << "program checksum change forcing update of " << t;});
if (dd.expect (env_cs.string ()) != nullptr)
l4 ([&]{trace << "environment change forcing update of " << t;});
}
}
// Get ready to run the depdb preamble.
//
build::script::environment& env (mdb != nullptr ? mdb->env : md->env);
build::script::default_runner& run (mdb != nullptr ? mdb->run : md->run);
run.enter (env, script.start_loc);
// Run the first half of the preamble (before depdb-dyndep).
//
{
build::script::parser p (ctx);
p.execute_depdb_preamble (a, bs, t, env, script, run, dd);
// Write a blank line after the custom depdb entries and before
// prerequisites, which we use as an anchor (see read_dyn_targets
// above). We only do it for the new --dyn-target mode in order not to
// invalidate the existing depdb instances.
//
if (script.depdb_dyndep_dyn_target)
dd.expect ("");
}
// Determine if we need to do an update based on the above checks.
//
bool update (false);
timestamp mt;
if (dd.writing ())
update = true;
else
{
if (g == nullptr)
{
const file& ft (t.as<file> ());
if ((mt = ft.mtime ()) == timestamp_unknown)
ft.mtime (mt = mtime (tp)); // Cache.
}
else
{
// Use static member, old dynamic, or force update.
//
const path* p (
g->members_static != 0
? &tp /* first static member path */
: (!old_dyn_targets.empty ()
? &old_dyn_targets.front ().path
: nullptr));
if (p != nullptr)
mt = g->load_mtime (*p);
else
update = true;
}
if (!update)
update = dd.mtime > mt;
}
if (update)
mt = timestamp_nonexistent;
if (script.depdb_dyndep_byproduct)
{
// If we have the dynamic dependency information as byproduct of the
// recipe body, then do the first part: verify the entries in depdb
// unless we are already updating. Essentially, this is the `if(cache)`
// equivalent of the restart loop in exec_depdb_dyndep().
using dyndep = dyndep_rule;
// Update our prerequisite targets and extract the depdb-dyndep
// command's information (we may also execute some variable
// assignments).
//
// Do we really need to update our prerequisite targets in this case?
// While it may seem like we should be able to avoid it by triggering
// update on encountering any non-existent files in depbd, we may
// actually incorrectly "validate" some number of depdb entires while
// having an out-of-date main source file. We could probably avoid the
// update if we are already updating (or not: there is pre-generation
// to consider; see inject_existing_file() for details).
//
{
build::script::parser p (ctx);
mdb->byp = p.execute_depdb_preamble_dyndep_byproduct (
a, bs, t,
env, script, run,
dd, update, mt);
}
mdb->pts_n = pts.size ();
if (!update)
{
const auto& byp (mdb->byp);
const char* what (byp.what.c_str ());
const location& ll (byp.location);
function<dyndep::map_extension_func> map_ext (
[] (const scope& bs, const string& n, const string& e)
{
// NOTE: another version in exec_depdb_dyndep().
return dyndep::map_extension (bs, n, e, nullptr);
});
// Similar to exec_depdb_dyndep()::add() but only for cache=true and
// without support for generated files.
//
// Note that we have to update each file for the same reason as the
// main source file -- if any of them changed, then we must assume the
// subsequent entries are invalid.
//
size_t& skip_count (mdb->skip_count);
auto add = [&trace, what,
a, &bs, &t, pts_n = mdb->pts_n,
&byp, &map_ext,
&skip_count, mt] (path fp) -> optional<bool>
{
if (const build2::file* ft = dyndep::enter_file (
trace, what,
a, bs, t,
fp, true /* cache */, true /* normalized */,
map_ext, *byp.default_type).first)
{
// Note: mark the injected prerequisite target as updated (see
// execute_update_prerequisites() for details).
//
if (optional<bool> u = dyndep::inject_existing_file (
trace, what,
a, t, pts_n,
*ft, mt,
false /* fail */,
false /* adhoc */,
1 /* data */))
{
skip_count++;
return *u;
}
}
return nullopt;
};
auto df = make_diag_frame (
[&ll, &t] (const diag_record& dr)
{
if (verb != 0)
dr << info (ll) << "while extracting dynamic dependencies for "
<< t;
});
while (!update)
{
// We should always end with a blank line.
//
string* l (dd.read ());
// If the line is invalid, run the compiler.
//
if (l == nullptr)
{
update = true;
break;
}
if (l->empty ()) // Done, nothing changed.
break;
if (optional<bool> r = add (path (move (*l))))
{
if (*r)
update = true;
}
else
{
// Invalidate this line and trigger update.
//
dd.write ();
update = true;
}
if (update)
l6 ([&]{trace << "restarting (cache)";});
}
}
// Note that in case of dry run we will have an incomplete (but valid)
// database which will be updated on the next non-dry run.
//
if (!update || ctx.dry_run_option)
dd.close (false /* mtime_check */);
else
mdb->dd = dd.close_to_reopen ();
// Pass on base scope and update/mtime.
//
mdb->bs = &bs;
mdb->mt = update ? timestamp_nonexistent : mt;
return [this, md = move (mdb)] (action a, const target& t)
{
return perform_update_file_or_group_dyndep_byproduct (a, t, *md);
};
}
else
{
// Run the second half of the preamble (depdb-dyndep commands) to update
// our prerequisite targets and extract dynamic dependencies (targets
// and prerequisites).
//
// Note that this should be the last update to depdb (the invalidation
// order semantics).
//
md->deferred_failure = false;
{
build::script::parser p (ctx);
p.execute_depdb_preamble_dyndep (a, bs, t,
env, script, run,
dd,
md->dyn_targets,
update,
mt,
md->deferred_failure);
}
if (update && dd.reading () && !ctx.dry_run_option)
dd.touch = timestamp_unknown;
dd.close (false /* mtime_check */);
// Remove previous dynamic targets since their set may change with
// changes to the inputs.
//
// The dry-run mode complicates things: if we don't remove the old
// files, then that information will be gone (since we update depdb even
// in the dry-run mode). But if we remove everything in the dry-run
// mode, then we may also remove some of the current files, which would
// be incorrect. So let's always remove but only files that are not in
// the current set.
//
// Note that we used to do this in perform_update_file_or_group_dyndep()
// but that had a tricky issue: if we end up performing match but not
// execute (e.g., via the resolve_members() logic), then we will not
// cleanup old targets but loose this information (since the depdb has
// be updated). So now we do it here, which is a bit strange, but it
// sort of fits into that dry-run logic above. Note also that we do this
// unconditionally, update or not, since if everything is up to date,
// then old and new sets should be the same.
//
for (const dynamic_target& dt: old_dyn_targets)
{
const path& f (dt.path);
if (find_if (md->dyn_targets.begin (), md->dyn_targets.end (),
[&f] (const dynamic_target& dt)
{
return dt.path == f;
}) == md->dyn_targets.end ())
{
// This is an optimization so best effort.
//
if (optional<rmfile_status> s = butl::try_rmfile_ignore_error (f))
{
if (s == rmfile_status::success && verb >= 2)
text << "rm " << f;
}
}
}
// Pass on the base scope, depdb path, and update/mtime.
//
md->bs = &bs;
md->dd = move (dd.path);
md->mt = update ? timestamp_nonexistent : mt;
return [this, md = move (md)] (action a, const target& t)
{
return perform_update_file_or_group_dyndep (a, t, *md);
};
}
}
target_state adhoc_buildscript_rule::
perform_update_file_or_group_dyndep_byproduct (
action a, const target& t, match_data_byproduct& md) const
{
// Note: using shared function name among the three variants.
//
tracer trace (
"adhoc_buildscript_rule::perform_update_file_or_group_dyndep_byproduct");
context& ctx (t.ctx);
// For a group we use the first (for now static) member as a source of
// mtime.
//
// @@ TODO: expl: byproduct: Note that until we support dynamic targets in
// the byproduct mode, we verify there is at least one static member in
// apply() above. Once we do support this, we will need to verify after
// the dependency extraction below.
//
const group* g (t.is_a<group> ());
// Note that even if we've updated all our prerequisites in apply(), we
// still need to execute them here to keep the dependency counts straight.
//
optional<target_state> ps (execute_update_prerequisites (a, t, md.mt));
if (!ps)
md.mt = timestamp_nonexistent; // Update.
build::script::environment& env (md.env);
build::script::default_runner& run (md.run);
if (md.mt != timestamp_nonexistent)
{
run.leave (env, script.end_loc);
return *ps;
}
const scope& bs (*md.bs);
// Sequence start time for mtime checks below.
//
timestamp start (!ctx.dry_run && depdb::mtime_check ()
? system_clock::now ()
: timestamp_unknown);
if (!ctx.dry_run || verb != 0)
{
if (g == nullptr)
execute_update_file (bs, a, t.as<file> (), env, run);
else
{
// Note: no dynamic members yet.
//
execute_update_group (bs, a, *g, env, run);
}
}
// Extract the dynamic dependency information as byproduct of the recipe
// body. Essentially, this is the `if(!cache)` equivalent of the restart
// loop in exec_depdb_dyndep().
//
if (!ctx.dry_run)
{
using dyndep = dyndep_rule;
using dyndep_format = build::script::parser::dyndep_format;
depdb dd (move (md.dd));
const auto& byp (md.byp);
const location& ll (byp.location);
const char* what (byp.what.c_str ());
const path& file (byp.file);
env.clean ({build2::script::cleanup_type::always, file},
true /* implicit */);
function<dyndep::map_extension_func> map_ext (
[] (const scope& bs, const string& n, const string& e)
{
// NOTE: another version in exec_depdb_dyndep() and above.
return dyndep::map_extension (bs, n, e, nullptr);
});
// Analogous to exec_depdb_dyndep()::add() but only for cache=false.
// The semantics is quite different, however: instead of updating the
// dynamic prerequisites we verify they are not generated.
//
// Note that fp is expected to be absolute.
//
size_t skip (md.skip_count);
const auto& pts (t.prerequisite_targets[a]);
auto add = [&trace, what,
a, &bs, &t, g, &pts, pts_n = md.pts_n,
&byp, &map_ext, &dd, &skip] (path fp)
{
normalize_external (fp, what);
// Note that unless we take into account dynamic targets, the skip
// logic below falls apart since we neither see targets entered via
// prerequsites (skip static prerequisites) nor by the cache=true code
// above (skip depdb entries).
//
// If this turns out to be racy (which is the reason we would skip
// dynamic targets; see the fine_file() implementation for details),
// then the only answer for now is to not use the byproduct mode.
//
if (const build2::file* ft = dyndep::find_file (
trace, what,
a, bs, t,
fp, false /* cache */, true /* normalized */,
true /* dynamic */,
map_ext, *byp.default_type).first)
{
// Skip if this is one of the static prerequisites provided it was
// updated.
//
for (size_t i (0); i != pts_n; ++i)
{
const prerequisite_target& p (pts[i]);
if (const target* pt =
(p.target != nullptr ? p.target :
p.adhoc () ? reinterpret_cast<target*> (p.data) :
nullptr))
{
if (ft == pt && (p.adhoc () || p.data == 1))
return;
}
}
// Skip if this is one of the targets (see the non-byproduct version
// for background).
//
if (byp.drop_cycles)
{
if (g != nullptr)
{
auto& ms (g->members);
if (find (ms.begin (), ms.end (), ft) != ms.end ())
return;
}
else
{
for (const target* m (&t); m != nullptr; m = m->adhoc_member)
{
if (ft == m)
return;
}
}
}
// Skip until where we left off.
//
if (skip != 0)
{
--skip;
return;
}
// Verify it has noop recipe.
//
// @@ Currently we will issue an imprecise diagnostics if this is
// a static prerequisite that was not updated (see above).
//
dyndep::verify_existing_file (trace, what, a, t, pts_n, *ft);
}
dd.write (fp);
};
auto df = make_diag_frame (
[&ll, &t] (const diag_record& dr)
{
if (verb != 0)
dr << info (ll) << "while extracting dynamic dependencies for "
<< t;
});
ifdstream is (ifdstream::badbit);
try
{
is.open (file);
}
catch (const io_error& e)
{
fail (ll) << "unable to open file " << file << ": " << e;
}
location il (file, 1);
// The way we parse things is format-specific.
//
// Note: similar code in exec_depdb_dyndep(). Except here we just add
// the paths to depdb without entering them as targets.
//
switch (md.byp.format)
{
case dyndep_format::make:
{
using make_state = make_parser;
using make_type = make_parser::type;
make_parser make;
for (string l;; ++il.line) // Reuse the buffer.
{
if (eof (getline (is, l)))
{
if (make.state != make_state::end)
fail (il) << "incomplete make dependency declaration";
break;
}
size_t pos (0);
do
{
// Note that we don't really need a diag frame that prints the
// line being parsed since we are always parsing the file.
//
pair<make_type, path> r (make.next (l, pos, il));
if (r.second.empty ())
continue;
// Note: no support for dynamic targets in byproduct mode.
//
if (r.first == make_type::target)
continue;
path& f (r.second);
if (f.relative ())
{
if (!byp.cwd)
fail (il) << "relative " << what
<< " prerequisite path '" << f
<< "' in make dependency declaration" <<
info << "consider using --cwd to specify relative path "
<< "base";
f = *byp.cwd / f;
}
add (move (f));
}
while (pos != l.size ());
if (make.state == make_state::end)
break;
}
break;
}
case dyndep_format::lines:
{
for (string l;; ++il.line) // Reuse the buffer.
{
if (eof (getline (is, l)))
break;
if (l.empty ())
fail (il) << "blank line in prerequisites list";
if (l.front () == ' ')
fail (il) << "non-existent prerequisite in --byproduct mode";
path f;
try
{
f = path (l);
// fsdir{} prerequisites only make sense with dynamic targets.
//
if (f.to_directory ())
throw invalid_path ("");
if (f.relative ())
{
if (!byp.cwd)
fail (il) << "relative " << what
<< " prerequisite path '" << f
<< "' in lines dependency declaration" <<
info << "consider using --cwd to specify "
<< "relative path base";
f = *byp.cwd / f;
}
}
catch (const invalid_path&)
{
fail (il) << "invalid " << what << " prerequisite path '"
<< l << "'";
}
add (move (f));
}
break;
}
}
// Add the terminating blank line.
//
dd.expect ("");
dd.close ();
//@@ TODO: expl: byproduct: verify have at least one member.
md.dd.path = move (dd.path); // For mtime check below.
}
run.leave (env, script.end_loc);
timestamp now (system_clock::now ());
if (!ctx.dry_run)
{
// Only now we know for sure there must be a member in the group.
//
const file& ft ((g == nullptr ? t : *g->members.front ()).as<file> ());
depdb::check_mtime (start, md.dd.path, ft.path (), now);
}
(g == nullptr
? static_cast<const mtime_target&> (t.as<file> ())
: static_cast<const mtime_target&> (*g)).mtime (now);
return target_state::changed;
}
target_state adhoc_buildscript_rule::
perform_update_file_or_group_dyndep (
action a, const target& t, match_data& md) const
{
tracer trace (
"adhoc_buildscript_rule::perform_update_file_or_group_dyndep");
context& ctx (t.ctx);
// For a group we use the first (static or dynamic) member as a source of
// mtime. Note that in this case there must be at least one since we fail
// if we were unable to extract any dynamic members and there are no
// static (see exec_depdb_dyndep()).
//
const group* g (t.is_a<group> ());
// Note that even if we've updated all our prerequisites in apply(), we
// still need to execute them here to keep the dependency counts straight.
//
optional<target_state> ps (execute_update_prerequisites (a, t, md.mt));
if (!ps)
md.mt = timestamp_nonexistent; // Update.
build::script::environment& env (md.env);
build::script::default_runner& run (md.run);
// Force update in case of a deferred failure even if nothing changed.
//
if (md.mt != timestamp_nonexistent && !md.deferred_failure)
{
run.leave (env, script.end_loc);
return *ps;
}
// Sequence start time for mtime checks below.
//
timestamp start (!ctx.dry_run && depdb::mtime_check ()
? system_clock::now ()
: timestamp_unknown);
if (!ctx.dry_run || verb != 0)
{
if (g == nullptr)
execute_update_file (
*md.bs, a, t.as<file> (), env, run, md.deferred_failure);
else
execute_update_group (*md.bs, a, *g, env, run, md.deferred_failure);
}
run.leave (env, script.end_loc);
timestamp now (system_clock::now ());
if (!ctx.dry_run)
{
// Note: in case of deferred failure we may not have any members.
//
const file& ft ((g == nullptr ? t : *g->members.front ()).as<file> ());
depdb::check_mtime (start, md.dd, ft.path (), now);
}
(g == nullptr
? static_cast<const mtime_target&> (t)
: static_cast<const mtime_target&> (*g)).mtime (now);
return target_state::changed;
}
target_state adhoc_buildscript_rule::
perform_update_file_or_group (action a, const target& t) const
{
tracer trace ("adhoc_buildscript_rule::perform_update_file_or_group");
context& ctx (t.ctx);
const scope& bs (t.base_scope ());
// For a group we use the first (static) member to derive depdb path, as a
// source of mtime, etc. Note that in this case there must be a static
// member since in this version of perform_update we don't extract dynamic
// dependencies (see apply() details).
//
const group* g (t.is_a<group> ());
const file& ft ((g == nullptr ? t : *g->members.front ()).as<file> ());
const path& tp (ft.path ());
// Update prerequisites and determine if any of them render this target
// out-of-date.
//
timestamp mt (g == nullptr ? ft.load_mtime () : g->load_mtime (tp));
// This is essentially ps=execute_prerequisites(a, t, mt) which we
// cannot use because we need to see ad hoc prerequisites.
//
optional<target_state> ps (execute_update_prerequisites (a, t, mt));
// Calculate prerequisite checksums (that need to include ad hoc
// prerequisites) unless the script tracks changes itself.
//
names storage;
sha256 prq_cs, exe_cs, env_cs;
if (!script.depdb_clear)
{
for (const prerequisite_target& p: t.prerequisite_targets[a])
{
if (const target* pt =
(p.target != nullptr ? p.target :
p.adhoc () ? reinterpret_cast<target*> (p.data)
: nullptr))
{
if ((p.include & include_unmatch) != 0) // Skip update=unmatch.
continue;
hash_prerequisite_target (prq_cs, exe_cs, env_cs, *pt, storage);
}
}
}
bool update (!ps);
// We use depdb to track changes to the script itself, input/output file
// names, tools, etc.
//
// NOTE: see the "dynamic dependencies" version above.
//
depdb dd (tp + ".d");
// First should come the rule name/version.
//
if (dd.expect ("<ad hoc buildscript recipe> 1") != nullptr)
l4 ([&]{trace << "rule mismatch forcing update of " << t;});
// Then the script checksum.
//
// Ideally, to detect changes to the script semantics, we would hash the
// text with all the variables expanded but without executing any
// commands. In practice, this is easier said than done (think the set
// builtin that receives output of a command that modifies the
// filesystem).
//
// So as the next best thing we are going to hash the unexpanded text as
// well as values of all the variables expanded in it (which we get as a
// side effect of pre-parsing the script). This approach has a number of
// drawbacks:
//
// - We can't handle computed variable names (e.g., $($x ? X : Y)).
//
// - We may "overhash" by including variables that are actually
// script-local.
//
// - There are functions like $install.resolve() with result based on
// external (to the script) information.
//
if (dd.expect (checksum) != nullptr)
l4 ([&]{trace << "recipe text change forcing update of " << t;});
// Track the variables, targets, and prerequisites changes, unless the
// script tracks the dependency changes itself.
//
if (!script.depdb_clear)
{
// For each variable hash its name, undefined/null/non-null indicator,
// and the value if non-null.
//
// Note that this excludes the special $< and $> variables which we
// handle below.
//
// @@ TODO: maybe detect and decompose process_path_ex in order to
// properly attribute checksum and environment changes?
//
{
sha256 cs;
hash_script_vars (cs, script, bs, t, storage);
if (dd.expect (cs.string ()) != nullptr)
l4 ([&]{trace << "recipe variable change forcing update of " << t;});
}
// Target and prerequisite sets ($> and $<).
//
{
sha256 tcs;
if (g == nullptr)
{
for (const target* m (&t); m != nullptr; m = m->adhoc_member)
hash_target (tcs, *m, storage);
}
else
{
// Feels like there is not much sense in hashing the group itself.
//
for (const target* m: g->members)
hash_target (tcs, *m, storage);
}
if (dd.expect (tcs.string ()) != nullptr)
l4 ([&]{trace << "target set change forcing update of " << t;});
if (dd.expect (prq_cs.string ()) != nullptr)
l4 ([&]{trace << "prerequisite set change forcing update of " << t;});
}
// Finally the programs and environment checksums.
//
{
if (dd.expect (exe_cs.string ()) != nullptr)
l4 ([&]{trace << "program checksum change forcing update of " << t;});
if (dd.expect (env_cs.string ()) != nullptr)
l4 ([&]{trace << "environment change forcing update of " << t;});
}
}
// Execute the custom dependency change tracking commands, if present.
//
// Note that we share the environment between the execute_depdb_preamble()
// and execute_body() calls, which is not merely an optimization since
// variables set in the preamble must be available in the body.
//
// Creating the environment instance is not cheap so optimize for the
// common case where we don't have the depdb preamble and nothing to
// update.
//
bool depdb_preamble (!script.depdb_preamble.empty ());
if (!depdb_preamble)
{
if (dd.writing () || dd.mtime > mt)
update = true;
if (!update)
{
dd.close ();
return *ps;
}
}
build::script::environment env (a, t, bs, false /* temp_dir */);
build::script::default_runner run;
if (depdb_preamble)
{
if (script.depdb_preamble_temp_dir)
env.set_temp_dir_variable ();
build::script::parser p (ctx);
run.enter (env, script.start_loc);
p.execute_depdb_preamble (a, bs, t, env, script, run, dd);
}
// Update if depdb mismatch.
//
if (dd.writing () || dd.mtime > mt)
update = true;
dd.close ();
// If nothing changed, then we are done.
//
if (!update)
{
// Note that if we execute the depdb preamble but not the script body,
// we need to call the runner's leave() function explicitly (here and
// below).
//
if (depdb_preamble)
run.leave (env, script.end_loc);
return *ps;
}
bool r (false);
if (!ctx.dry_run || verb != 0)
{
// Prepare to execute the script diag preamble and/or body.
//
r = g == nullptr
? execute_update_file (bs, a, ft, env, run)
: execute_update_group (bs, a, *g, env, run);
if (r)
{
if (!ctx.dry_run)
dd.check_mtime (tp);
}
}
if (r || depdb_preamble)
run.leave (env, script.end_loc);
(g == nullptr
? static_cast<const mtime_target&> (ft)
: static_cast<const mtime_target&> (*g)).mtime (system_clock::now ());
return target_state::changed;
}
// Update prerequisite targets.
//
// Each (non-NULL) prerequisite target should be in one of the following
// states:
//
// target adhoc data
// --------------------
// !NULL false 0 - normal prerequisite to be updated
// !NULL false 1 - normal prerequisite already updated
// !NULL true 0 - ad hoc prerequisite to be updated and blanked
// NULL true !NULL - ad hoc prerequisite already updated and blanked
// NULL false !NULL - unmatched prerequisite (ignored by this function)
//
// Note that we still execute already updated prerequisites to keep the
// dependency counts straight. But we don't consider them for the "renders
// us out-of-date" check assuming this has already been done.
//
// See also environment::set_special_variables().
//
// See also perform_execute() which has to deal with these shenanigans.
//
optional<target_state> adhoc_buildscript_rule::
execute_update_prerequisites (action a, const target& t, timestamp mt) const
{
context& ctx (t.ctx);
// This is essentially a customized execute_prerequisites(a, t, mt).
//
size_t busy (ctx.count_busy ());
target_state rs (target_state::unchanged);
wait_guard wg (ctx, busy, t[a].task_count);
auto& pts (t.prerequisite_targets[a]);
for (const prerequisite_target& p: pts)
{
if (const target* pt =
(p.target != nullptr ? p.target :
p.adhoc () ? reinterpret_cast<target*> (p.data) : nullptr))
{
target_state s (execute_async (a, *pt, busy, t[a].task_count));
assert (s != target_state::postponed);
}
}
wg.wait ();
bool e (mt == timestamp_nonexistent);
for (prerequisite_target& p: pts)
{
if (const target* pt =
(p.target != nullptr ? p.target :
p.adhoc () ? reinterpret_cast<target*> (p.data) : nullptr))
{
target_state s (execute_complete (a, *pt));
if (p.data == 0)
{
rs |= s;
// Compare our timestamp to this prerequisite's skipping
// update=unmatch.
//
if (!e && (p.include & include_unmatch) == 0)
{
// If this is an mtime-based target, then compare timestamps.
//
if (const mtime_target* mpt = pt->is_a<mtime_target> ())
{
if (mpt->newer (mt, s))
e = true;
}
else
{
// Otherwise we assume the prerequisite is newer if it was
// changed.
//
if (s == target_state::changed)
e = true;
}
}
// Blank out adhoc.
//
// Note: set the include_target flag for the updated_during_match()
// check.
//
if (p.adhoc ())
{
p.data = reinterpret_cast<uintptr_t> (p.target);
p.target = nullptr;
p.include |= prerequisite_target::include_target;
}
}
}
}
return e ? nullopt : optional<target_state> (rs);
}
// Return true if execute_diag_preamble() and/or execute_body() were called
// and thus the caller should call run.leave().
//
bool adhoc_buildscript_rule::
execute_update_file (const scope& bs,
action a, const file& t,
build::script::environment& env,
build::script::default_runner& run,
bool deferred_failure) const
{
// NOTE: similar to execute_update_group() below.
//
context& ctx (t.ctx);
const scope& rs (*bs.root_scope ());
// Note that it doesn't make much sense to use the temporary directory
// variable ($~) in the 'diag' builtin call, so we postpone setting it
// until the script body execution, that can potentially be omitted.
//
build::script::parser p (ctx);
bool exec_body (!ctx.dry_run || verb >= 2);
bool exec_diag (!script.diag_preamble.empty () && (exec_body || verb == 1));
bool exec_depdb (!script.depdb_preamble.empty ());
if (script.diag_name)
{
if (verb == 1)
{
// By default we print the first non-ad hoc prerequisite target as the
// "main" prerequisite, unless there isn't any or it's not file-based,
// in which case we fallback to the second form without the
// prerequisite. Potential future improvements:
//
// - Somehow detect that the first prerequisite target is a tool being
// executed and fallback to the second form. It's tempting to just
// exclude all exe{} targets, but this could be a rule for something
// like strip.
//
const file* pt (nullptr);
for (const prerequisite_target& p: t.prerequisite_targets[a])
{
// See execute_update_prerequisites().
//
if (p.target != nullptr && !p.adhoc ())
{
pt = p.target->is_a<file> ();
break;
}
}
if (t.adhoc_member == nullptr)
{
if (pt != nullptr)
print_diag (script.diag_name->c_str (), *pt, t);
else
print_diag (script.diag_name->c_str (), t);
}
else
{
vector<target_key> ts;
for (const target* m (&t); m != nullptr; m = m->adhoc_member)
ts.push_back (m->key ());
if (pt != nullptr)
print_diag (script.diag_name->c_str (), pt->key (), move (ts));
else
print_diag (script.diag_name->c_str (), move (ts));
}
}
}
else if (exec_diag)
{
if (script.diag_preamble_temp_dir && !script.depdb_preamble_temp_dir)
env.set_temp_dir_variable ();
pair<names, location> diag (
p.execute_diag_preamble (rs, bs,
env, script, run,
verb == 1 /* diag */,
!exec_depdb /* enter */,
false /* leave */));
if (verb == 1)
print_custom_diag (bs, move (diag.first), diag.second);
}
if (exec_body)
{
// On failure remove the target files that may potentially exist but
// be invalid.
//
small_vector<auto_rmfile, 8> rms;
if (!ctx.dry_run)
{
for (const target* m (&t); m != nullptr; m = m->adhoc_member)
{
if (auto* f = m->is_a<file> ())
rms.emplace_back (f->path ());
}
}
if (script.body_temp_dir &&
!script.depdb_preamble_temp_dir &&
!script.diag_preamble_temp_dir)
env.set_temp_dir_variable ();
p.execute_body (rs, bs,
env, script, run,
!exec_depdb && !exec_diag /* enter */,
false /* leave */);
if (!ctx.dry_run)
{
if (deferred_failure)
fail << "expected error exit status from recipe body";
// If this is an executable, let's be helpful to the user and set
// the executable bit on POSIX.
//
#ifndef _WIN32
auto chmod = [] (const path& p)
{
path_perms (p,
(path_perms (p) |
permissions::xu |
permissions::xg |
permissions::xo));
};
for (const target* m (&t); m != nullptr; m = m->adhoc_member)
{
if (auto* p = m->is_a<exe> ())
chmod (p->path ());
}
#endif
for (auto& rm: rms)
rm.cancel ();
}
}
return exec_diag || exec_body;
}
bool adhoc_buildscript_rule::
execute_update_group (const scope& bs,
action a, const group& g,
build::script::environment& env,
build::script::default_runner& run,
bool deferred_failure) const
{
// Note: similar to execute_update_file() above (see there for comments).
//
// NOTE: when called from perform_update_file_or_group_dyndep_byproduct(),
// the group does not contain dynamic members yet and thus could
// have no members at all.
//
context& ctx (g.ctx);
const scope& rs (*bs.root_scope ());
build::script::parser p (ctx);
bool exec_body (!ctx.dry_run || verb >= 2);
bool exec_diag (!script.diag_preamble.empty () && (exec_body || verb == 1));
bool exec_depdb (!script.depdb_preamble.empty ());
if (script.diag_name)
{
if (verb == 1)
{
const file* pt (nullptr);
for (const prerequisite_target& p: g.prerequisite_targets[a])
{
if (p.target != nullptr && !p.adhoc ())
{
pt = p.target->is_a<file> ();
break;
}
}
if (pt != nullptr)
print_diag (script.diag_name->c_str (), *pt, g);
else
print_diag (script.diag_name->c_str (), g);
}
}
else if (exec_diag)
{
if (script.diag_preamble_temp_dir && !script.depdb_preamble_temp_dir)
env.set_temp_dir_variable ();
pair<names, location> diag (
p.execute_diag_preamble (rs, bs,
env, script, run,
verb == 1 /* diag */,
!exec_depdb /* enter */,
false /* leave */));
if (verb == 1)
print_custom_diag (bs, move (diag.first), diag.second);
}
if (exec_body)
{
// On failure remove the target files that may potentially exist but
// be invalid.
//
// Note: we may leave dynamic members if we don't know about them yet.
// Feels natural enough.
//
small_vector<auto_rmfile, 8> rms;
if (!ctx.dry_run)
{
for (const target* m: g.members)
{
if (auto* f = m->is_a<file> ())
rms.emplace_back (f->path ());
}
}
if (script.body_temp_dir &&
!script.depdb_preamble_temp_dir &&
!script.diag_preamble_temp_dir)
env.set_temp_dir_variable ();
p.execute_body (rs, bs,
env, script, run,
!exec_depdb && !exec_diag /* enter */,
false /* leave */);
if (!ctx.dry_run)
{
if (deferred_failure)
fail << "expected error exit status from recipe body";
// @@ TODO: expl: byproduct
//
// Note: will not work for dynamic members if we don't know about them
// yet. Could probably fix by doing this later, after the dynamic
// dependency extraction.
//
#ifndef _WIN32
auto chmod = [] (const path& p)
{
path_perms (p,
(path_perms (p) |
permissions::xu |
permissions::xg |
permissions::xo));
};
for (const target* m: g.members)
{
if (auto* p = m->is_a<exe> ())
chmod (p->path ());
}
#endif
for (auto& rm: rms)
rm.cancel ();
}
}
return exec_diag || exec_body;
}
target_state adhoc_buildscript_rule::
perform_clean_file (action a, const target& t)
{
// Besides .d (depdb) also clean .t which is customarily used as a
// temporary file, such as make dependency output in depdb-dyndep. In
// fact, initially the plan was to only clean it if we have dyndep but
// there is no reason it cannot be used for something else.
//
// Note that the main advantage of using this file over something in the
// temporary directory ($~) is that it's next to other output which makes
// it easier to examine during recipe troubleshooting.
//
// Finally, we print the entire ad hoc group at verbosity level 1, similar
// to the default update diagnostics.
//
// @@ TODO: .t may also be a temporary directory (and below).
//
return perform_clean_extra (a,
t.as<file> (),
{".d", ".t"},
{},
true /* show_adhoc_members */);
}
target_state adhoc_buildscript_rule::
perform_clean_group (action a, const target& xt)
{
const group& g (xt.as<group> ());
path d, t;
if (g.members_static != 0)
{
const path& p (g.members.front ()->as<file> ().path ());
d = p + ".d";
t = p + ".t";
}
else
{
// See target_path lambda in apply().
//
t = g.dir / (g.name + '.' + g.type ().name);
d = t + ".d";
t += ".t";
}
return perform_clean_group_extra (a, g, {d.string ().c_str (),
t.string ().c_str ()});
}
target_state adhoc_buildscript_rule::
default_action (action a,
const target& t,
const optional<timestamp>& deadline) const
{
tracer trace ("adhoc_buildscript_rule::default_action");
context& ctx (t.ctx);
execute_prerequisites (a, t);
if (!ctx.dry_run || verb != 0)
{
const scope& bs (t.base_scope ());
const scope& rs (*bs.root_scope ());
build::script::environment e (a, t, bs, false /* temp_dir */, deadline);
build::script::parser p (ctx);
build::script::default_runner r;
bool exec_body (!ctx.dry_run || verb >= 2);
bool exec_diag (!script.diag_preamble.empty () &&
(exec_body || verb == 1));
if (script.diag_name)
{
if (verb == 1)
{
// For operations other than update (as well as for non-file
// targets), we default to the second form (without the
// prerequisite). Think test.
//
if (t.adhoc_member == nullptr)
print_diag (script.diag_name->c_str (), t);
else
{
vector<target_key> ts;
for (const target* m (&t); m != nullptr; m = m->adhoc_member)
ts.push_back (m->key ());
print_diag (script.diag_name->c_str (), move (ts));
}
}
}
else if (exec_diag)
{
if (script.diag_preamble_temp_dir)
e.set_temp_dir_variable ();
pair<names, location> diag (
p.execute_diag_preamble (rs, bs,
e, script, r,
verb == 1 /* diag */,
true /* enter */,
!exec_body /* leave */));
if (verb == 1)
print_custom_diag (bs, move (diag.first), diag.second);
}
if (exec_body)
{
if (script.body_temp_dir && !script.diag_preamble_temp_dir)
e.set_temp_dir_variable ();
p.execute_body (rs, bs, e, script, r, !exec_diag /* enter */);
}
}
return target_state::changed;
}
void adhoc_buildscript_rule::
print_custom_diag (const scope& bs, names&& ns, const location& l) const
{
// The straightforward thing to do would be to just print the diagnostics
// as specified by the user. But that will make some of the tidying up
// done by print_diag() unavailable to custom diagnostics. Things like
// omitting the out-qualification as well as compact printing of the
// groups. Also, in the future we may want to support colorization of the
// diagnostics, which will be difficult to achive with such a "just print"
// approach.
//
// So instead we are going to parse the custom diagnostics, translate
// names back to targets (where appropriate), and call one of the
// print_diag() functions. Specifically, we expect the custom diagnostics
// to be in one of the following two forms (which correspond to the two
// forms of pring_diag()):
//
// diag <prog> <l-target> <comb> <r-target>...
// diag <prog> <r-target>...
//
// And the way we are going to disambiguate this is by analyzing name
// types. Specifically, we expect <comb> to be a simple name that also
// does not contain any directory separators (so we can distinguish it
// from both target names as well as paths, which can be specified on
// either side). We will also recognize `-` as the special stdout path
// name (so <comb> cannot be `-`). Finally, <l-target> (but not
// <r-target>) can be a string (e.g., an argument) but that should not
// pose an ambiguity.
//
// With this approach, the way to re-create the default diagnostics would
// be:
//
// diag <prog> ($<[0]) -> $>
// diag <prog> $>
//
auto i (ns.begin ()), e (ns.end ());
// <prog>
//
if (i == e)
fail (l) << "missing program name in diag builtin";
if (!i->simple () || i->empty ())
fail (l) << "expected simple name as program name in diag builtin";
const char* prog (i->value.c_str ());
++i;
// <l-target>
//
const target* l_t (nullptr);
path l_p;
string l_s;
auto parse_target = [&bs, &l, &i, &e] () -> const target&
{
name& n (*i++);
name o;
if (n.pair)
{
if (i == e)
fail (l) << "invalid target name pair in diag builtin";
o = move (*i++);
}
// Similar to to_target() in $target.*().
//
if (const target* r = search_existing (n, bs, o.dir))
return *r;
fail (l) << "target "
<< (n.pair ? names {move (n), move (o)} : names {move (n)})
<< " not found in diag builtin" << endf;
};
auto parse_first = [&l, &i, &e,
&parse_target] (const target*& t, path& p, string& s,
const char* after)
{
if (i == e)
fail (l) << "missing target after " << after << " in diag builtin";
try
{
if (i->typed ())
{
t = &parse_target ();
return; // i is already incremented.
}
else if (!i->dir.empty ())
{
p = move (i->dir);
p /= i->value;
}
else if (path_traits::find_separator (i->value) != string::npos)
{
p = path (move (i->value));
}
else if (!i->value.empty ())
{
s = move (i->value);
}
else
fail (l) << "expected target, path, or argument after "
<< after << " in diag builtin";
}
catch (const invalid_path& e)
{
fail (l) << "invalid path '" << e.path << "' after "
<< after << " in diag builtin";
}
++i;
};
parse_first (l_t, l_p, l_s, "program name");
// Now detect which form it is.
//
if (i != e &&
i->simple () &&
!i->empty () &&
path_traits::find_separator (i->value) == string::npos)
{
// The first form.
// <comb>
//
const char* comb (i->value.c_str ());
++i;
// <r-target>
//
const target* r_t (nullptr);
path r_p;
string r_s;
parse_first (r_t, r_p, r_s, "combiner");
path_name r_pn;
if (r_t != nullptr)
;
else if (!r_p.empty ())
r_pn = path_name (&r_p);
else
{
if (r_s != "-")
fail (l) << "expected target or path instead of '" << r_s
<< "' after combiner in diag builtin";
r_pn = path_name (move (r_s));
}
if (i == e)
{
if (r_t != nullptr)
{
if (l_t != nullptr) print_diag (prog, *l_t, *r_t, comb);
else if (!l_p.empty ()) print_diag (prog, l_p, *r_t, comb);
else print_diag (prog, l_s, *r_t, comb);
}
else
{
if (l_t != nullptr) print_diag (prog, *l_t, r_pn, comb);
else if (!l_p.empty ()) print_diag (prog, l_p, r_pn, comb);
else print_diag (prog, l_s, r_pn, comb);
}
return;
}
// We can only have multiple targets, not paths.
//
if (r_t == nullptr)
fail (l) << "unexpected name after path in diag builtin";
// <r-target>...
//
vector<target_key> r_ts {r_t->key ()};
do r_ts.push_back (parse_target ().key ()); while (i != e);
if (l_t != nullptr) print_diag (prog, l_t->key (), move (r_ts), comb);
else if (!l_p.empty ()) print_diag (prog, l_p, move (r_ts), comb);
else print_diag (prog, l_s, move (r_ts), comb);
}
else
{
// The second form.
// First "absorb" the l_* values as the first <r-target>.
//
const target* r_t (nullptr);
path_name r_pn;
if (l_t != nullptr)
r_t = l_t;
else if (!l_p.empty ())
r_pn = path_name (&l_p);
else
{
if (l_s != "-")
{
diag_record dr (fail (l));
dr << "expected target or path instead of '" << l_s
<< "' after program name in diag builtin";
if (i != e)
dr << info << "alternatively, missing combiner after '"
<< l_s << "'";
}
r_pn = path_name (move (l_s));
}
if (i == e)
{
if (r_t != nullptr)
print_diag (prog, *r_t);
else
print_diag (prog, r_pn);
return;
}
// We can only have multiple targets, not paths.
//
if (r_t == nullptr)
fail (l) << "unexpected name after path in diag builtin";
// <r-target>...
//
vector<target_key> r_ts {r_t->key ()};
do r_ts.push_back (parse_target ().key ()); while (i != e);
print_diag (prog, move (r_ts));
}
}
}
|