1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
|
// file : libbuild2/cc/link-rule.cxx -*- C++ -*-
// license : MIT; see accompanying LICENSE file
#include <libbuild2/cc/link-rule.hxx>
#include <cstdlib> // exit()
#include <cstring> // strlen()
#include <libbutl/filesystem.mxx> // file_exists(), path_search()
#include <libbuild2/depdb.hxx>
#include <libbuild2/scope.hxx>
#include <libbuild2/context.hxx>
#include <libbuild2/variable.hxx>
#include <libbuild2/algorithm.hxx>
#include <libbuild2/filesystem.hxx>
#include <libbuild2/diagnostics.hxx>
#include <libbuild2/bin/rule.hxx> // lib_rule::build_members()
#include <libbuild2/bin/target.hxx>
#include <libbuild2/bin/utility.hxx>
#include <libbuild2/cc/target.hxx> // c, pc*
#include <libbuild2/cc/utility.hxx>
using std::exit;
using namespace butl;
namespace build2
{
namespace cc
{
using namespace bin;
using build2::to_string;
optional<path> link_rule::
find_system_library (const strings& l) const
{
assert (!l.empty ());
// Figure out what we are looking for.
//
// See similar code in process_libraries().
//
// @@ TODO: should we take the link order into account (but do we do
// this when we link system libraries)?
//
string n1, n2;
{
auto i (l.begin ()), e (l.end ());
string s (*i);
if (tsys == "win32-msvc")
{
if (s[0] == '/')
{
// Some option (e.g., /WHOLEARCHIVE:<name>). Fall through to fail.
}
else
{
// Presumably a complete name.
//
n1 = move (s);
i++;
}
}
else
{
if (s[0] == '-')
{
// -l<name>, -l <name>
//
if (s[1] == 'l')
{
if (s.size () == 2) // -l <name>
{
if (i + 1 != e)
s = *++i;
else
s.clear ();
}
else // -l<name>
s.erase (0, 2);
if (!s.empty ())
{
i++;
// Here we need to be consistent with search_library(). Maybe
// one day we should generalize it to be usable here (though
// here we don't need library name guessing).
//
const char* p ("");
const char* e1 (nullptr);
const char* e2 (nullptr);
if (tclass == "windows")
{
if (tsys == "mingw32")
{
p = "lib";
e1 = ".dll.a";
e2 = ".a";
}
else
{
e1 = ".dll.lib";
e2 = ".lib";
}
}
else
{
p = "lib";
e1 = (tclass == "macos" ? ".dylib" : ".so");
e2 = ".a";
}
n1 = p + s + e1;
n2 = e2 != nullptr ? p + s + e2 : string ();
}
}
#if 0
// -framework <name> (Mac OS)
//
else if (tsys == "darwin" && l == "-framework")
{
// @@ TODO: maybe one day.
}
#endif
else
{
// Some other option (e.g., -Wl,--whole-archive). Fall through
// to fail.
}
}
else
{
// Presumably a complete name.
//
n1 = move (s);
i++;
}
}
if (i != e)
fail << "unexpected library name '" << *i << "'";
}
path p; // Reuse the buffer.
for (const dir_path& d: sys_lib_dirs)
{
auto exists = [&p, &d] (const string& n)
{
return file_exists ((p = d, p /= n),
true /* follow_symlinks */,
true /* ignore_errors */);
};
if (exists (n1) || (!n2.empty () && exists (n2)))
return p;
}
return nullopt;
}
link_rule::
link_rule (data&& d)
: common (move (d)),
rule_id (string (x) += ".link 3")
{
static_assert (sizeof (match_data) <= target::data_size,
"insufficient space");
}
link_rule::match_result link_rule::
match (action a,
const target& t,
const target* g,
otype ot,
bool library) const
{
// NOTE: the target may be a group (see utility library logic below).
match_result r;
// Scan prerequisites and see if we can work with what we've got. Note
// that X could be C (as in language). We handle this by always checking
// for X first.
//
// Note also that we treat bmi{} as obj{}. @@ MODHDR hbmi{}?
//
for (prerequisite_member p:
prerequisite_members (a, t, group_prerequisites (t, g)))
{
// If excluded or ad hoc, then don't factor it into our tests.
//
if (include (a, t, p) != include_type::normal)
continue;
if (p.is_a (x_src) ||
(x_mod != nullptr && p.is_a (*x_mod)) ||
// Header-only X library (or library with C source and X header).
(library && x_header (p, false /* c_hdr */)))
{
r.seen_x = true;
}
else if (p.is_a<c> () ||
// Header-only C library.
(library && p.is_a<h> ()))
{
r.seen_c = true;
}
else if (p.is_a<obj> () || p.is_a<bmi> ())
{
r.seen_obj = true;
}
else if (p.is_a<obje> () || p.is_a<bmie> ())
{
// We can make these "no-match" if/when there is a valid use case.
//
if (ot != otype::e)
fail << p.type ().name << "{} as prerequisite of " << t;
r.seen_obj = true;
}
else if (p.is_a<obja> () || p.is_a<bmia> ())
{
if (ot != otype::a)
fail << p.type ().name << "{} as prerequisite of " << t;
r.seen_obj = true;
}
else if (p.is_a<objs> () || p.is_a<bmis> ())
{
if (ot != otype::s)
fail << p.type ().name << "{} as prerequisite of " << t;
r.seen_obj = true;
}
else if (p.is_a<libul> () || p.is_a<libux> ())
{
// For a unility library we look at its prerequisites, recursively.
//
// This is a bit iffy: in our model a rule can only search a
// target's prerequisites if it matches. But we don't yet know
// whether we match. However, it seems correct to assume that any
// rule-specific search will always resolve to an existing target if
// there is one. So perhaps it's time to relax this restriction a
// little? Note that this fits particularly well with what we are
// doing here since if there is no existing target, then there can
// be no prerequisites.
//
// Note, however, that we cannot link-up a prerequisite target
// member to its group since we are not matching this target. As
// result we have to do all the steps except for setting t.group and
// pass both member and group (we also cannot query t.group since
// it's racy).
//
const target* pg (nullptr);
const target* pt (p.search_existing ());
if (p.is_a<libul> ())
{
if (pt != nullptr)
{
// If this is a group then try to pick (again, if exists) a
// suitable member. If it doesn't exist, then we will only be
// considering the group's prerequisites.
//
if (const target* pm =
link_member (pt->as<libul> (),
a,
linfo {ot, lorder::a /* unused */},
true /* existing */))
{
pg = pt;
pt = pm;
}
}
else
{
// It's possible we have no group but have a member so try that.
//
const target_type& tt (ot == otype::a ? libua::static_type :
ot == otype::s ? libus::static_type :
libue::static_type);
// We know this prerequisite member is a prerequisite since
// otherwise the above search would have returned the member
// target.
//
pt = search_existing (t.ctx, p.prerequisite.key (tt));
}
}
else if (!p.is_a<libue> ())
{
// See if we also/instead have a group.
//
pg = search_existing (t.ctx,
p.prerequisite.key (libul::static_type));
if (pt == nullptr)
swap (pt, pg);
}
if (pt != nullptr)
{
// If we are matching a target, use the original output type since
// that would be the member that we pick.
//
otype pot (pt->is_a<libul> () ? ot : link_type (*pt).type);
// Propagate values according to the "see-through" semantics of
// utility libraries.
//
r |= match (a, *pt, pg, pot, true /* lib */);
}
else
r.seen_lib = true; // Consider as just a library.
}
else if (p.is_a<lib> () ||
p.is_a<liba> () ||
p.is_a<libs> ())
{
r.seen_lib = true;
}
// Some other c-common header/source (say C++ in a C rule) other than
// a C header (we assume everyone can hanle that).
//
else if (p.is_a<cc> () && !(x_header (p, true /* c_hdr */)))
{
r.seen_cc = true;
break;
}
}
return r;
}
bool link_rule::
match (action a, target& t, const string& hint) const
{
// NOTE: may be called multiple times and for both inner and outer
// operations (see the install rules).
tracer trace (x, "link_rule::match");
ltype lt (link_type (t));
// If this is a group member library, link-up to our group (this is the
// target group protocol which means this can be done whether we match
// or not).
//
// If we are called for the outer operation (see install rules), then
// use resolve_group() to delegate to inner.
//
if (lt.member_library ())
{
if (a.outer ())
resolve_group (a, t);
else if (t.group == nullptr)
t.group = &search (t,
lt.utility ? libul::static_type : lib::static_type,
t.dir, t.out, t.name);
}
match_result r (match (a, t, t.group, lt.type, lt.library ()));
// If this is some other c-common header/source (say C++ in a C rule),
// then we shouldn't try to handle that (it may need to be compiled,
// etc).
//
if (r.seen_cc)
{
l4 ([&]{trace << "non-" << x_lang << " prerequisite "
<< "for target " << t;});
return false;
}
if (!(r.seen_x || r.seen_c || r.seen_obj || r.seen_lib))
{
l4 ([&]{trace << "no " << x_lang << ", C, or obj/lib prerequisite "
<< "for target " << t;});
return false;
}
// We will only chain a C source if there is also an X source or we were
// explicitly told to.
//
if (r.seen_c && !r.seen_x && hint < x)
{
l4 ([&]{trace << "C prerequisite without " << x_lang << " or hint "
<< "for target " << t;});
return false;
}
return true;
}
auto link_rule::
derive_libs_paths (file& t,
const char* pfx,
const char* sfx) const -> libs_paths
{
bool win (tclass == "windows");
// Get default prefix and extension.
//
const char* ext (nullptr);
if (win)
{
if (tsys == "mingw32")
{
if (pfx == nullptr)
pfx = "lib";
}
ext = "dll";
}
else
{
if (pfx == nullptr)
pfx = "lib";
if (tclass == "macos")
ext = "dylib";
else
ext = "so";
}
// First sort out which extension we are using.
//
const string& e (t.derive_extension (ext));
auto append_ext = [&e] (path& p)
{
if (!e.empty ())
{
p += '.';
p += e;
}
};
// See if we have the load suffix.
//
const string& ls (cast_empty<string> (t["bin.lib.load_suffix"]));
// Figure out the version.
//
string ver;
bool verp (true); // Platform-specific.
using verion_map = map<optional<string>, string>;
if (const verion_map* m = cast_null<verion_map> (t["bin.lib.version"]))
{
// First look for the target system.
//
auto i (m->find (tsys));
// Then look for the target class.
//
if (i == m->end ())
i = m->find (tclass);
// Then look for the wildcard. Since it is higly unlikely one can have
// a version that will work across platforms, this is only useful to
// say "all others -- no version".
//
if (i == m->end ())
i = m->find (string ("*"));
// Finally look for the platform-independent version.
//
if (i == m->end ())
{
verp = false;
i = m->find (nullopt);
// For backwards-compatibility.
//
if (i == m->end ())
i = m->find (string ());
}
// If we didn't find anything, fail. If the bin.lib.version was
// specified, then it should explicitly handle all the targets.
//
if (i == m->end ())
fail << "no version for " << ctgt << " in bin.lib.version" <<
info << "considere adding " << tsys << "@<ver> or " << tclass
<< "@<ver>";
ver = i->second;
}
// Now determine the paths.
//
path lk, ld, so, in;
// We start with the basic path.
//
path b (t.dir);
if (pfx != nullptr && pfx[0] != '\0')
{
b /= pfx;
b += t.name;
}
else
b /= t.name;
if (sfx != nullptr && sfx[0] != '\0')
b += sfx;
// Clean patterns.
//
// Note that looser patterns tend to match all kinds of unexpected
// stuff, for example (using Windows; without the lib prefix things are
// even worse):
//
// foo-io.dll
// foo.dll.obj
// foo-1.dll.obj
// foo.dll.u.lib
//
// Even with these patterns we tighted things up we do additional
// filtering (of things like .d, .t that derived from the suffixed
// and versioned name) at the match site.
//
path cp_l, cp_v;
// Append separator characters (`-`, `_`, maybe `-v`) to the clean
// pattern until we encounter a digit. Return false if the digit was
// never encountered.
//
auto append_sep = [] (path& cp, const string& s) -> bool
{
for (char c: s)
{
if (digit (c))
return true;
cp += c;
}
return false;
};
// On Windows the real path is to libs{} and the link path is empty.
// Note that we still need to derive the import library path.
//
if (win)
{
// Usually on Windows with MSVC the import library is called the same
// as the DLL but with the .lib extension. Which means it clashes with
// the static library. Instead of decorating the static library name
// with ugly suffixes (as is customary), let's use the MinGW approach
// (one must admit it's quite elegant) and call it .dll.lib.
//
libi& i (*find_adhoc_member<libi> (t));
if (i.path ().empty ())
{
path ip (b);
append_ext (ip);
i.derive_path (move (ip), tsys == "mingw32" ? "a" : "lib");
}
}
// We will only need the link name if the following name differs.
//
else if (!ver.empty () || !ls.empty ())
{
lk = b;
append_ext (lk);
}
// See if we have the load suffix.
//
if (!ls.empty ())
{
// Derive the load suffix clean pattern (e.g., `foo-[0-9]*.dll`).
//
// Note: postpone appending the extension since we use this pattern as
// a base for the version clean pattern.
//
cp_l = b;
if (auto* p = cast_null<string> (t["bin.lib.load_suffix_pattern"]))
cp_l += *p;
else if (append_sep (cp_l, ls))
cp_l += "[0-9]*";
else
cp_l.clear (); // Non-digit load suffix (use custom clean pattern).
b += ls;
// We will only need the load name if the following name differs.
//
if (!ver.empty ())
{
ld = b;
append_ext (ld);
}
}
// Append version and derive the real name.
//
const path* re (nullptr);
if (ver.empty () || !verp)
{
if (!ver.empty ())
{
// Derive the version clean pattern (e.g., `foo-[0-9]*.dll`, or, if
// we have the load clean pattern, `foo-[0-9]*-[0-9]*.dll`).
//
cp_v = cp_l.empty () ? b : cp_l;
if (auto* p = cast_null<string> (t["bin.lib.version_pattern"]))
cp_v += *p;
else if (append_sep (cp_v, ver))
cp_v += "[0-9]*";
else
cp_v.clear (); // Non-digit version (use custom clean pattern).
if (!cp_v.empty ())
append_ext (cp_v);
b += ver;
}
re = &t.derive_path (move (b));
}
else
{
// Derive the version clean pattern (e.g., `libfoo.so.[0-9]*`, or, if
// we have the load clean pattern, `libfoo-[0-9]*.so.[0-9]*`).
//
cp_v = cp_l.empty () ? b : cp_l;
append_ext (cp_v);
cp_v += ".[0-9]*";
// Parse the next version component in the X.Y.Z version form.
//
// Note that we don't bother verifying components are numeric assuming
// the user knows what they are doing (one can sometimes see versions
// with non-numeric components though probably not for X).
//
auto next = [&ver,
b = size_t (0),
e = size_t (0)] (const char* what = nullptr) mutable
{
if (size_t n = next_word (ver, b, e, '.'))
return string (ver, b, n);
if (what != nullptr)
fail << "missing " << what << " in shared library version '"
<< ver << "'" << endf;
return string ();
};
if (tclass == "linux")
{
// On Linux the shared library version has the MAJOR.MINOR[.EXTRA]
// form where MAJOR is incremented for backwards-incompatible ABI
// changes, MINOR -- for backwards-compatible, and optional EXTRA
// has no specific meaning and can be used as some sort of release
// or sequence number (e.g., if the ABI has not changed).
//
string ma (next ("major component"));
string mi (next ("minor component"));
string ex (next ());
// The SONAME is libfoo.so.MAJOR
//
so = b;
append_ext (so);
so += '.'; so += ma;
// If we have EXTRA, then make libfoo.so.MAJOR.MINOR to be the
// intermediate name.
//
if (!ex.empty ())
{
in = b;
append_ext (in);
in += '.'; in += ma;
in += '.'; in += mi;
}
// Add the whole version as the extra extension(s).
//
re = &t.derive_path (move (b),
nullptr /* default_ext */,
ver.c_str () /* extra_ext */);
}
else
fail << tclass << "-specific bin.lib.version not yet supported";
}
if (!cp_l.empty ()) append_ext (cp_l);
return libs_paths {
move (lk),
move (ld),
move (so),
move (in),
re,
move (cp_l), move (cp_v)};
}
// Look for binful utility library recursively until we hit a non-utility
// "barier".
//
static const libux*
find_binful (action a, const target& t, linfo li)
{
for (const target* pt: t.prerequisite_targets[a])
{
if (pt == nullptr || unmark (pt) != 0) // Called after pass 1 below.
continue;
const libux* ux;
// If this is the libu*{} group, then pick the appropriate member.
//
if (const libul* ul = pt->is_a<libul> ())
{
ux = &link_member (*ul, a, li)->as<libux> ();
}
else if ((ux = pt->is_a<libue> ()) ||
(ux = pt->is_a<libus> ()) ||
(ux = pt->is_a<libua> ()))
;
else
continue;
if (!ux->path ().empty () || (ux = find_binful (a, *ux, li)))
return ux;
}
return nullptr;
};
recipe link_rule::
apply (action a, target& xt) const
{
tracer trace (x, "link_rule::apply");
file& t (xt.as<file> ());
context& ctx (t.ctx);
// Note that for_install is signalled by install_rule and therefore
// can only be relied upon during execute.
//
match_data& md (t.data (match_data ()));
const scope& bs (t.base_scope ());
const scope& rs (*bs.root_scope ());
ltype lt (link_type (t));
otype ot (lt.type);
linfo li (link_info (bs, ot));
// Set the library type (C, C++, etc) as rule-specific variable.
//
if (lt.library ())
t.state[a].assign (c_type) = string (x);
bool binless (lt.library ()); // Binary-less until proven otherwise.
bool user_binless (lt.library () && cast_false<bool> (t[b_binless]));
// Inject dependency on the output directory. Note that we do it even
// for binless libraries since there could be other output (e.g., .pc
// files).
//
inject_fsdir (a, t);
// Process prerequisites, pass 1: search and match prerequisite
// libraries, search obj/bmi{} targets, and search targets we do rule
// chaining for.
//
// Also clear the binless flag if we see any source or object files.
// Note that if we don't see any this still doesn't mean the library is
// binless since it can depend on a binful utility library. This we
// check below, after matching the libraries.
//
// We do libraries first in order to indicate that we will execute these
// targets before matching any of the obj/bmi{}. This makes it safe for
// compile::apply() to unmatch them and therefore not to hinder
// parallelism.
//
// We also create obj/bmi{} chain targets because we need to add
// (similar to lib{}) all the bmi{} as prerequisites to all the other
// obj/bmi{} that we are creating. Note that this doesn't mean that the
// compile rule will actually treat them all as prerequisite targets.
// Rather, they are used to resolve actual module imports. We don't
// really have to search obj{} targets here but it's the same code so we
// do it here to avoid duplication.
//
// Also, when cleaning, we ignore prerequisites that are not in the same
// or a subdirectory of our project root. Except for libraries: if we
// ignore them, then they won't be added to synthesized dependencies and
// this will break things if we do, say, update after clean in the same
// invocation. So for libraries we ignore them later, on pass 3.
//
optional<dir_paths> usr_lib_dirs; // Extract lazily.
compile_target_types tts (compile_types (ot));
auto skip = [&a, &rs] (const target& pt) -> bool
{
return a.operation () == clean_id && !pt.dir.sub (rs.out_path ());
};
auto& pts (t.prerequisite_targets[a]);
size_t start (pts.size ());
for (prerequisite_member p: group_prerequisite_members (a, t))
{
include_type pi (include (a, t, p));
// We pre-allocate a NULL slot for each (potential; see clean)
// prerequisite target.
//
pts.push_back (prerequisite_target (nullptr, pi));
const target*& pt (pts.back ());
if (pi != include_type::normal) // Skip excluded and ad hoc.
continue;
// Mark:
// 0 - lib
// 1 - src
// 2 - mod
// 3 - obj/bmi and also lib not to be cleaned
//
uint8_t m (0);
bool mod (x_mod != nullptr && p.is_a (*x_mod));
if (mod || p.is_a (x_src) || p.is_a<c> ())
{
binless = binless && (mod ? user_binless : false);
// Rule chaining, part 1.
//
// Which scope shall we use to resolve the root? Unlikely, but
// possible, the prerequisite is from a different project
// altogether. So we are going to use the target's project.
// If the source came from the lib{} group, then create the obj{}
// group and add the source as a prerequisite of the obj{} group,
// not the obj*{} member. This way we only need one prerequisite
// for, say, both liba{} and libs{}. The same goes for bmi{}.
//
bool group (!p.prerequisite.belongs (t)); // Group's prerequisite.
const target_type& rtt (mod
? (group ? bmi::static_type : tts.bmi)
: (group ? obj::static_type : tts.obj));
const prerequisite_key& cp (p.key ()); // Source key.
// Come up with the obj*/bmi*{} target. The source prerequisite
// directory can be relative (to the scope) or absolute. If it is
// relative, then use it as is. If absolute, then translate it to
// the corresponding directory under out_root. While the source
// directory is most likely under src_root, it is also possible it
// is under out_root (e.g., generated source).
//
dir_path d;
{
const dir_path& cpd (*cp.tk.dir);
if (cpd.relative () || cpd.sub (rs.out_path ()))
d = cpd;
else
{
if (!cpd.sub (rs.src_path ()))
fail << "out of project prerequisite " << cp <<
info << "specify corresponding " << rtt.name << "{} "
<< "target explicitly";
d = rs.out_path () / cpd.leaf (rs.src_path ());
}
}
// obj/bmi{} is always in the out tree. Note that currently it could
// be the group -- we will pick a member in part 2 below.
//
pair<target&, ulock> r (
search_locked (
t, rtt, d, dir_path (), *cp.tk.name, nullptr, cp.scope));
// If we shouldn't clean obj{}, then it is fair to assume we
// shouldn't clean the source either (generated source will be in
// the same directory as obj{} and if not, well, go find yourself
// another build system ;-)).
//
if (skip (r.first))
{
pt = nullptr;
continue;
}
// Either set of verify the bin.binless value on this bmi*{} target
// (see config_data::b_binless for semantics).
//
if (mod)
{
if (r.second.owns_lock ())
{
if (user_binless)
r.first.assign (b_binless) = true;
}
else
{
lookup l (r.first[b_binless]);
if (user_binless ? !cast_false<bool> (l) : l.defined ())
fail << "synthesized dependency for prerequisite " << p
<< " would be incompatible with existing target "
<< r.first <<
info << "incompatible bin.binless value";
}
}
pt = &r.first;
m = mod ? 2 : 1;
}
else if (p.is_a<libx> () ||
p.is_a<liba> () ||
p.is_a<libs> () ||
p.is_a<libux> ())
{
// Handle imported libraries.
//
// Note that since the search is rule-specific, we don't cache the
// target in the prerequisite.
//
if (p.proj ())
pt = search_library (
a, sys_lib_dirs, usr_lib_dirs, p.prerequisite);
// The rest is the same basic logic as in search_and_match().
//
if (pt == nullptr)
pt = &p.search (t);
if (skip (*pt))
m = 3; // Mark so it is not matched.
// If this is the lib{}/libul{} group, then pick the appropriate
// member.
//
if (const libx* l = pt->is_a<libx> ())
pt = link_member (*l, a, li);
}
else
{
// If this is the obj{} or bmi{} target group, then pick the
// appropriate member.
//
if (p.is_a<obj> ()) pt = &search (t, tts.obj, p.key ());
else if (p.is_a<bmi> ()) pt = &search (t, tts.bmi, p.key ());
//
// Windows module definition (.def). For other platforms (and for
// static libraries) treat it as an ordinary prerequisite.
//
else if (p.is_a<def> () && tclass == "windows" && ot != otype::a)
{
pt = &p.search (t);
}
//
// Something else. This could be something unrelated that the user
// tacked on (e.g., a doc{}). Or it could be some ad hoc input to
// the linker (say a linker script or some such).
//
else
{
if (!p.is_a<objx> () && !p.is_a<bmix> () && !x_header (p, true))
{
// @@ Temporary hack until we get the default outer operation
// for update. This allows operations like test and install to
// skip such tacked on stuff.
//
// Note that ad hoc inputs have to be explicitly marked with the
// include=adhoc prerequisite-specific variable.
//
if (ctx.current_outer_oif != nullptr)
continue;
}
pt = &p.search (t);
}
if (skip (*pt))
{
pt = nullptr;
continue;
}
// Header BMIs have no object file. Module BMI must be explicitly
// marked with bin.binless by the user to be usable in a binless
// library.
//
binless = binless && !(
pt->is_a<objx> () ||
(pt->is_a<bmix> () &&
!pt->is_a<hbmix> () &&
cast_false<bool> ((*pt)[b_binless])));
m = 3;
}
if (user_binless && !binless)
fail << t << " cannot be binless due to " << p << " prerequisite";
mark (pt, m);
}
// Match lib{} (the only unmarked) in parallel and wait for completion.
//
match_members (a, t, pts, start);
// Check if we have any binful utility libraries.
//
if (binless)
{
if (const libux* l = find_binful (a, t, li))
{
binless = false;
if (user_binless)
fail << t << " cannot be binless due to binful " << *l
<< " prerequisite";
}
}
// Now that we know for sure whether we are binless, derive file name(s)
// and add ad hoc group members. Note that for binless we still need the
// .pc member (whose name depends on the libray prefix) so we take care
// to not derive the path for the library target itself inside.
//
{
const char* e (nullptr); // Extension.
const char* p (nullptr); // Prefix.
const char* s (nullptr); // Suffix.
if (lt.utility)
{
// These are all static libraries with names indicating the kind of
// object files they contain (similar to how we name object files
// themselves). We add the 'u' extension to avoid clashes with
// real libraries/import stubs.
//
// libue libhello.u.a hello.exe.u.lib
// libua libhello.a.u.a hello.lib.u.lib
// libus libhello.so.u.a hello.dll.u.lib hello.dylib.u.lib
//
// Note that we currently don't add bin.lib.{prefix,suffix} since
// these are not installed.
//
if (tsys == "win32-msvc")
{
switch (ot)
{
case otype::e: e = "exe.u.lib"; break;
case otype::a: e = "lib.u.lib"; break;
case otype::s: e = "dll.u.lib"; break;
}
}
else
{
p = "lib";
if (tsys == "mingw32")
{
switch (ot)
{
case otype::e: e = "exe.u.a"; break;
case otype::a: e = "a.u.a"; break;
case otype::s: e = "dll.u.a"; break;
}
}
else if (tsys == "darwin")
{
switch (ot)
{
case otype::e: e = "u.a"; break;
case otype::a: e = "a.u.a"; break;
case otype::s: e = "dylib.u.a"; break;
}
}
else
{
switch (ot)
{
case otype::e: e = "u.a"; break;
case otype::a: e = "a.u.a"; break;
case otype::s: e = "so.u.a"; break;
}
}
}
if (binless)
t.path (empty_path);
else
t.derive_path (e, p, s);
}
else
{
if (auto l = t[ot == otype::e ? "bin.exe.prefix" : "bin.lib.prefix"])
p = cast<string> (l).c_str ();
if (auto l = t[ot == otype::e ? "bin.exe.suffix" : "bin.lib.suffix"])
s = cast<string> (l).c_str ();
switch (ot)
{
case otype::e:
{
if (tclass == "windows")
e = "exe";
else if (tsys == "emscripten")
e = "js";
else
e = "";
t.derive_path (e, p, s);
break;
}
case otype::a:
{
if (tsys == "win32-msvc")
e = "lib";
else
{
if (p == nullptr) p = "lib";
e = "a";
}
if (binless)
t.path (empty_path);
else
t.derive_path (e, p, s);
break;
}
case otype::s:
{
if (binless)
t.path (empty_path);
else
{
// On Windows libs{} is an ad hoc group. The libs{} itself is
// the DLL and we add libi{} import library as its member.
//
if (tclass == "windows")
{
e = "dll";
add_adhoc_member<libi> (t);
}
md.libs_paths = derive_libs_paths (t, p, s);
}
break;
}
}
// Add Emscripten .wasm.
//
if (ot == otype::e && tsys == "emscripten")
{
const target_type& tt (*bs.find_target_type ("wasm"));
file& wasm (add_adhoc_member<file> (t, tt));
if (wasm.path ().empty ())
wasm.derive_path ();
}
// Add VC's .pdb. Note that we are looking for the link.exe /DEBUG
// option.
//
if (!binless && ot != otype::a && tsys == "win32-msvc")
{
if (find_option ("/DEBUG", t, c_loptions, true) ||
find_option ("/DEBUG", t, x_loptions, true))
{
const target_type& tt (*bs.find_target_type ("pdb"));
// We call the target foo.{exe,dll}.pdb rather than just foo.pdb
// because we can have both foo.exe and foo.dll in the same
// directory.
//
file& pdb (add_adhoc_member<file> (t, tt, e));
// Note that the path is derived from the exe/dll path (so it
// will include the version in case of a dll).
//
if (pdb.path ().empty ())
pdb.derive_path (t.path ());
}
}
// Add pkg-config's .pc file.
//
// Note that we do it regardless of whether we are installing or not
// for two reasons. Firstly, it is not easy to detect this situation
// here since the for_install hasn't yet been communicated by
// install_rule. Secondly, always having this member takes care of
// cleanup automagically. The actual generation happens in
// perform_update() below.
//
// Things are even trickier for the common .pc file: we only want to
// have it in the shared library if we are not installing static
// (see pkgconfig_save() for details). But we can't know it at this
// stage. So what we are going to do is conceptually tie the common
// file to the lib{} group (which does somehow feel correct) by only
// installing it if the lib{} group is installed. Specifically, here
// we will use its bin.lib to decide what will be installed and in
// perform_update() we will confirm that it is actually installed.
//
if (ot != otype::e)
{
// Note that here we always use the lib name prefix, even on
// Windows with VC. The reason is the user needs a consistent name
// across platforms by which they can refer to the library. This
// is also the reason why we use the .static and .shared second-
// level extensions rather that a./.lib and .so/.dylib/.dll.
// Note also that the order in which we are adding these members
// is important (see add_addhoc_member() for details).
//
if (ot == otype::a || !link_members (rs).a)
{
auto& pc (add_adhoc_member<pc> (t));
if (pc.path ().empty ())
pc.derive_path (nullptr, (p == nullptr ? "lib" : p), s);
}
auto& pcx (add_adhoc_member<file> (t,
(ot == otype::a
? pca::static_type
: pcs::static_type)));
if (pcx.path ().empty ())
pcx.derive_path (nullptr, (p == nullptr ? "lib" : p), s);
}
// Add the Windows rpath emulating assembly directory as fsdir{}.
//
// Currently this is used in the backlinking logic and in the future
// could also be used for clean (though there we may want to clean
// old assemblies).
//
if (ot == otype::e && tclass == "windows")
{
// Note that here we cannot determine whether we will actually
// need one (for_install, library timestamps are not available at
// this point to call windows_rpath_timestamp()). So we may add
// the ad hoc target but actually not produce the assembly. So
// whomever relies on this must check if the directory actually
// exists (windows_rpath_assembly() does take care to clean it up
// if not used).
//
#ifdef _WIN32
target& dir =
#endif
add_adhoc_member (t,
fsdir::static_type,
path_cast<dir_path> (t.path () + ".dlls"),
t.out,
string () /* name */);
// By default our backlinking logic will try to symlink the
// directory and it can even be done on Windows using junctions.
// The problem is the Windows DLL assembly "logic" refuses to
// recognize a junction as a valid assembly for some reason. So we
// are going to resort to copy-link (i.e., a real directory with a
// bunch of links). Note also that while DLLs can be symlinked,
// the assembly manifest cannot (has to be hard-linked or copied).
//
// Interestingly, the directory symlink works just fine under
// Wine. So we only resort to copy-link'ing if we are running on
// Windows.
//
#ifdef _WIN32
dir.state[a].assign (ctx.var_backlink) = "copy";
#endif
}
}
}
// Process prerequisites, pass 2: finish rule chaining but don't start
// matching anything yet since that may trigger recursive matching of
// bmi{} targets we haven't completed yet. Hairy, I know.
//
// Parallel prerequisites/prerequisite_targets loop.
//
size_t i (start);
for (prerequisite_member p: group_prerequisite_members (a, t))
{
const target*& pt (pts[i].target);
uintptr_t& pd (pts[i++].data);
if (pt == nullptr)
continue;
// New mark:
// 1 - completion
// 2 - verification
//
uint8_t m (unmark (pt));
if (m == 3) // obj/bmi or lib not to be cleaned
{
m = 1; // Just completion.
// Note that if this is a library not to be cleaned, we keep it
// marked for completion (see the next phase).
}
else if (m == 1 || m == 2) // Source/module chain.
{
bool mod (m == 2);
m = 1;
const target& rt (*pt);
bool group (!p.prerequisite.belongs (t)); // Group's prerequisite.
// If we have created a obj/bmi{} target group, pick one of its
// members; the rest would be primarily concerned with it.
//
pt =
group
? &search (t, (mod ? tts.bmi : tts.obj), rt.dir, rt.out, rt.name)
: &rt;
const target_type& rtt (mod
? (group ? bmi::static_type : tts.bmi)
: (group ? obj::static_type : tts.obj));
// If this obj*/bmi*{} already has prerequisites, then verify they
// are "compatible" with what we are doing here. Otherwise,
// synthesize the dependency. Note that we may also end up
// synthesizing with someone beating us to it. In this case also
// verify.
//
bool verify (true);
// Note that we cannot use has_group_prerequisites() since the
// target is not yet matched. So we check the group directly. Of
// course, all of this is racy (see below).
//
if (!pt->has_prerequisites () &&
(!group || !rt.has_prerequisites ()))
{
prerequisites ps {p.as_prerequisite ()}; // Source.
// Add our lib*{} (see the export.* machinery for details) and
// bmi*{} (both original and chained; see module search logic)
// prerequisites.
//
// Note that we don't resolve lib{} to liba{}/libs{} here
// instead leaving it to whomever (e.g., the compile rule) will
// be needing *.export.*. One reason for doing it there is that
// the object target might be specified explicitly by the user
// in which case they will have to specify the set of lib{}
// prerequisites and it's much cleaner to do as lib{} rather
// than liba{}/libs{}.
//
// Initially, we were only adding imported libraries, but there
// is a problem with this approach: the non-imported library
// might depend on the imported one(s) which we will never "see"
// unless we start with this library.
//
// Note: have similar logic in make_module_sidebuild().
//
size_t j (start);
for (prerequisite_member p: group_prerequisite_members (a, t))
{
const target* pt (pts[j++]);
if (pt == nullptr) // Note: ad hoc is taken care of.
continue;
// NOTE: pt may be marked (even for a library -- see clean
// above). So watch out for a faux pax in this careful dance.
//
if (p.is_a<libx> () ||
p.is_a<liba> () || p.is_a<libs> () || p.is_a<libux> () ||
p.is_a<bmi> () || p.is_a (tts.bmi))
{
ps.push_back (p.as_prerequisite ());
}
else if (x_mod != nullptr && p.is_a (*x_mod)) // Chained module.
{
// Searched during pass 1 but can be NULL or marked.
//
if (pt != nullptr && i != j) // Don't add self (note: both +1).
{
// This is sticky: pt might have come before us and if it
// was a group, then we would have picked up a member. So
// here we may have to "unpick" it.
//
bool group (j < i && !p.prerequisite.belongs (t));
unmark (pt);
ps.push_back (prerequisite (group ? *pt->group : *pt));
}
}
}
// Note: adding to the group, not the member.
//
verify = !rt.prerequisites (move (ps));
// Recheck that the target still has no prerequisites. If that's
// no longer the case, then verify the result is compatible with
// what we need.
//
// Note that there are scenarios where we will not detect this or
// the detection will be racy. For example, thread 1 adds the
// prerequisite to the group and then thread 2, which doesn't use
// the group, adds the prerequisite to the member. This could be
// triggered by something like this (undetectable):
//
// lib{foo}: cxx{foo}
// exe{foo}: cxx{foo}
//
// Or this (detection is racy):
//
// lib{bar}: cxx{foo}
// liba{baz}: cxx{foo}
//
// The current feeling, however, is that in non-contrived cases
// (i.e., the source file is the same) this should be harmless.
//
if (!verify && group)
verify = pt->has_prerequisites ();
}
if (verify)
{
// This gets a bit tricky. We need to make sure the source files
// are the same which we can only do by comparing the targets to
// which they resolve. But we cannot search ot's prerequisites --
// only the rule that matches can. Note, however, that if all this
// works out, then our next step is to match the obj*{} target. If
// things don't work out, then we fail, in which case searching
// and matching speculatively doesn't really hurt. So we start the
// async match here and finish this verification in the "harvest"
// loop below.
//
resolve_group (a, *pt); // Not matched yet so resolve group.
bool src (false);
for (prerequisite_member p1: group_prerequisite_members (a, *pt))
{
// Most of the time we will have just a single source so fast-
// path that case.
//
if (p1.is_a (mod ? *x_mod : x_src) || p1.is_a<c> ())
{
src = true;
continue; // Check the rest of the prerequisites.
}
// Ignore some known target types (fsdir, headers, libraries,
// modules).
//
if (p1.is_a<fsdir> () ||
p1.is_a<libx> () ||
p1.is_a<liba> () || p1.is_a<libs> () || p1.is_a<libux> () ||
p1.is_a<bmi> () || p1.is_a<bmix> () ||
(p.is_a (mod ? *x_mod : x_src) && x_header (p1)) ||
(p.is_a<c> () && p1.is_a<h> ()))
continue;
fail << "synthesized dependency for prerequisite " << p
<< " would be incompatible with existing target " << *pt <<
info << "unexpected existing prerequisite type " << p1 <<
info << "specify corresponding " << rtt.name << "{} "
<< "dependency explicitly";
}
if (!src)
fail << "synthesized dependency for prerequisite " << p
<< " would be incompatible with existing target " << *pt <<
info << "no existing c/" << x_name << " source prerequisite" <<
info << "specify corresponding " << rtt.name << "{} "
<< "dependency explicitly";
m = 2; // Needs verification.
}
}
else // lib*{}
{
// If this is a static library, see if we need to link it whole.
// Note that we have to do it after match since we rely on the
// group link-up.
//
bool u;
if ((u = pt->is_a<libux> ()) || pt->is_a<liba> ())
{
const variable& var (ctx.var_pool["bin.whole"]); // @@ Cache.
// See the bin module for the lookup semantics discussion. Note
// that the variable is not overridable so we omit find_override()
// calls.
//
lookup l (p.prerequisite.vars[var]);
if (!l.defined ())
l = pt->lookup_original (var, true).first;
if (!l.defined ())
{
const target* g (pt->group);
target_key tk (pt->key ());
target_key gk (g != nullptr ? g->key () : target_key {});
l = bs.lookup_original (var,
&tk,
g != nullptr ? &gk : nullptr).first;
}
if (l ? cast<bool> (*l) : u)
pd |= lflag_whole;
}
}
mark (pt, m);
}
// Process prerequisites, pass 3: match everything and verify chains.
//
// Wait with unlocked phase to allow phase switching.
//
wait_guard wg (ctx, ctx.count_busy (), t[a].task_count, true);
i = start;
for (prerequisite_member p: group_prerequisite_members (a, t))
{
bool adhoc (pts[i].adhoc);
const target*& pt (pts[i++]);
uint8_t m;
if (pt == nullptr)
{
// Handle ad hoc prerequisities.
//
if (!adhoc)
continue;
pt = &p.search (t);
m = 1; // Mark for completion.
}
else if ((m = unmark (pt)) != 0)
{
// If this is a library not to be cleaned, we can finally blank it
// out.
//
if (skip (*pt))
{
pt = nullptr;
continue;
}
}
match_async (a, *pt, ctx.count_busy (), t[a].task_count);
mark (pt, m);
}
wg.wait ();
// The "harvest" loop: finish matching the targets we have started. Note
// that we may have bailed out early (thus the parallel i/n for-loop).
//
i = start;
for (prerequisite_member p: group_prerequisite_members (a, t))
{
const target*& pt (pts[i++]);
// Skipped or not marked for completion.
//
uint8_t m;
if (pt == nullptr || (m = unmark (pt)) == 0)
continue;
build2::match (a, *pt);
// Nothing else to do if not marked for verification.
//
if (m == 1)
continue;
// Finish verifying the existing dependency (which is now matched)
// compared to what we would have synthesized.
//
bool mod (x_mod != nullptr && p.is_a (*x_mod));
// Note: group already resolved in the previous loop.
for (prerequisite_member p1: group_prerequisite_members (a, *pt))
{
if (p1.is_a (mod ? *x_mod : x_src) || p1.is_a<c> ())
{
// Searching our own prerequisite is ok, p1 must already be
// resolved.
//
const target& tp (p.search (t));
const target& tp1 (p1.search (*pt));
if (&tp != &tp1)
{
bool group (!p.prerequisite.belongs (t));
const target_type& rtt (mod
? (group ? bmi::static_type : tts.bmi)
: (group ? obj::static_type : tts.obj));
fail << "synthesized dependency for prerequisite " << p << " "
<< "would be incompatible with existing target " << *pt <<
info << "existing prerequisite " << p1 << " does not match "
<< p <<
info << p1 << " resolves to target " << tp1 <<
info << p << " resolves to target " << tp <<
info << "specify corresponding " << rtt.name << "{} "
<< "dependency explicitly";
}
break;
}
}
}
md.binless = binless;
md.start = start;
switch (a)
{
case perform_update_id: return [this] (action a, const target& t)
{
return perform_update (a, t);
};
case perform_clean_id: return [this] (action a, const target& t)
{
return perform_clean (a, t);
};
default: return noop_recipe; // Configure update.
}
}
void link_rule::
append_libraries (appended_libraries& ls, strings& args,
const scope& bs, action a,
const file& l, bool la, lflags lf, linfo li,
bool self, bool rel,
library_cache* lib_cache) const
{
struct data
{
appended_libraries& ls;
strings& args;
const file& l;
action a;
linfo li;
bool rel;
compile_target_types tts;
} d {ls, args, l, a, li, rel, compile_types (li.type)};
auto imp = [] (const target&, bool la)
{
return la;
};
auto lib = [&d, this] (
const target* const* lc,
const small_vector<reference_wrapper<const string>, 2>& ns,
lflags f,
bool)
{
// Note: see also make_header_sidebuild().
const file* l (lc != nullptr ? &(*lc)->as<file> () : nullptr);
// Suppress duplicates.
//
// Linking is the complicated case: we cannot add the libraries and
// options on the first occurrence of the library and ignore all
// subsequent occurrences because of the static linking semantics.
// Instead, we can ignore all the occurrences except the last which
// would normally be done with a pre-pass but would also complicate
// things quite a bit. So instead we are going to keep track of the
// duplicates like we've done in other places but in addition we will
// also keep track of the elements added to args corresponding to this
// library. And whenever we see a duplicate, we are going to "hoist"
// that range of elements to the end of args. See GitHub issue #114
// for details.
//
// From the process_libraries() semantics we know that this callback
// is always called and always after the options callbacks.
//
appended_library* al (l != nullptr
? &d.ls.append (*l, d.args.size ())
: d.ls.append (ns, d.args.size ()));
if (al != nullptr && al->end != appended_library::npos) // Closed.
{
// Hoist the elements corresponding to this library to the end.
//
d.ls.hoist (d.args, *al);
return true; // @@ Can we prune here???. But also sha256 version?
// Also in pkgconfig.cxx!
}
if (l == nullptr)
{
// Don't try to link a library (whether -lfoo or foo.lib) to a
// static library.
//
if (d.li.type != otype::a)
{
for (const string& n: ns)
d.args.push_back (n);
}
}
else
{
bool lu (l->is_a<libux> ());
// The utility/non-utility case is tricky. Consider these two
// scenarios:
//
// exe -> (libu1-e -> libu1-e) -> (liba) -> libu-a -> (liba1)
// exe -> (liba) -> libu1-a -> libu1-a -> (liba1) -> libu-a1
//
// Libraries that should be linked are in '()'. That is, we need to
// link the initial sequence of utility libraries and then, after
// encountering a first non-utility, only link non-utilities
// (because they already contain their utility's object files).
//
if (lu)
{
for (ptrdiff_t i (-1); lc[i] != nullptr; --i)
if (!lc[i]->is_a<libux> ())
goto done;
}
if (d.li.type == otype::a)
{
// Linking a utility library to a static library.
//
// Note that utility library prerequisites of utility libraries
// are automatically handled by process_libraries(). So all we
// have to do is implement the "thin archive" logic.
//
// We may also end up trying to link a non-utility library to a
// static library via a utility library (direct linking is taken
// care of by perform_update()). So we cut it off here.
//
if (!lu)
goto done;
if (l->mtime () == timestamp_unreal) // Binless.
goto done;
for (const target* pt: l->prerequisite_targets[d.a])
{
if (pt == nullptr)
continue;
if (modules)
{
if (pt->is_a<bmix> ()) // @@ MODHDR: hbmix{} has no objx{}
pt = find_adhoc_member (*pt, d.tts.obj);
}
// We could have dependency diamonds with utility libraries.
// Repeats will be handled by the linker (in fact, it could be
// required to repeat them to satisfy all the symbols) but here
// we have to suppress duplicates ourselves.
//
if (const file* f = pt->is_a<objx> ())
{
const string& p (d.rel
? relative (f->path ()).string ()
: f->path ().string ());
if (find (d.args.begin (), d.args.end (), p) == d.args.end ())
d.args.push_back (move (p));
}
}
}
else
{
// Linking a library to a shared library or executable.
//
if (l->mtime () == timestamp_unreal) // Binless.
goto done;
// On Windows a shared library is a DLL with the import library as
// an ad hoc group member. MinGW though can link directly to DLLs
// (see search_library() for details).
//
if (tclass == "windows" && l->is_a<libs> ())
{
if (const libi* li = find_adhoc_member<libi> (*l))
l = li;
}
string p (d.rel
? relative (l->path ()).string ()
: l->path ().string ());
if (f & lflag_whole)
{
if (tsys == "win32-msvc")
{
p.insert (0, "/WHOLEARCHIVE:"); // Only available from VC14U2.
}
else if (tsys == "darwin")
{
p.insert (0, "-Wl,-force_load,");
}
else
{
d.args.push_back ("-Wl,--whole-archive");
d.args.push_back (move (p));
d.args.push_back ("-Wl,--no-whole-archive");
goto done;
}
}
d.args.push_back (move (p));
}
}
done:
if (al != nullptr)
al->end = d.args.size (); // Close.
return true;
};
auto opt = [&d, this] (const target& lt,
const string& t,
bool com,
bool exp)
{
const file& l (lt.as<file> ());
// Don't try to pass any loptions when linking a static library.
//
// Note also that we used to pass non-export loptions but that didn't
// turn out to be very natural. Specifically, we would end up linking
// things like version scripts (used to build the shared library
// variant) when linking the static variant. So now any loptions must
// be explicitly exported. Note that things are a bit fuzzy when it
// comes to utility libraries so let's keep the original logic with
// the exp checks below.
//
if (d.li.type == otype::a || !exp)
return true;
// Suppress duplicates.
//
if (d.ls.append (l, d.args.size ()).end != appended_library::npos)
return true;
// If we need an interface value, then use the group (lib{}).
//
if (const target* g = exp && l.is_a<libs> () ? l.group : &l)
{
const variable& var (
com
? (exp ? c_export_loptions : c_loptions)
: (t == x
? (exp ? x_export_loptions : x_loptions)
: l.ctx.var_pool[t + (exp ? ".export.loptions" : ".loptions")]));
append_options (d.args, *g, var);
}
return true;
};
process_libraries (a, bs, li, sys_lib_dirs,
l, la,
lf, imp, lib, opt, self,
lib_cache);
}
void link_rule::
append_libraries (sha256& cs, bool& update, timestamp mt,
const scope& bs, action a,
const file& l, bool la, lflags lf, linfo li,
library_cache* lib_cache) const
{
// Note that we don't do any duplicate suppression here: there is no way
// to "hoist" things once they are hashed and hashing only the first
// occurrence could miss changes to the command line (e.g., due to
// "hoisting").
struct data
{
sha256& cs;
const dir_path& out_root;
bool& update;
timestamp mt;
linfo li;
} d {cs, bs.root_scope ()->out_path (), update, mt, li};
auto imp = [] (const target&, bool la)
{
return la;
};
auto lib = [&d, this] (
const target* const* lc,
const small_vector<reference_wrapper<const string>, 2>& ns,
lflags f,
bool)
{
const file* l (lc != nullptr ? &(*lc)->as<file> () : nullptr);
if (l == nullptr)
{
if (d.li.type != otype::a)
{
for (const string& n: ns)
d.cs.append (n);
}
}
else
{
bool lu (l->is_a<libux> ());
if (lu)
{
for (ptrdiff_t i (-1); lc[i] != nullptr; --i)
if (!lc[i]->is_a<libux> ())
return true;
}
// We also don't need to do anything special for linking a utility
// library to a static library. If any of its object files (or the
// set of its object files) changes, then the library will have to
// be updated as well. In other words, we use the library timestamp
// as a proxy for all of its member's timestamps.
//
// We do need to cut of the static to static linking, just as in
// append_libraries().
//
if (d.li.type == otype::a && !lu)
return true;
if (l->mtime () == timestamp_unreal) // Binless.
return true;
// Check if this library renders us out of date.
//
d.update = d.update || l->newer (d.mt);
// On Windows a shared library is a DLL with the import library as
// an ad hoc group member. MinGW though can link directly to DLLs
// (see search_library() for details).
//
if (tclass == "windows" && l->is_a<libs> ())
{
if (const libi* li = find_adhoc_member<libi> (*l))
l = li;
}
d.cs.append (f);
hash_path (d.cs, l->path (), d.out_root);
}
return true;
};
auto opt = [&d, this] (const target& l,
const string& t,
bool com,
bool exp)
{
if (d.li.type == otype::a || !exp)
return true;
if (const target* g = exp && l.is_a<libs> () ? l.group : &l)
{
const variable& var (
com
? (exp ? c_export_loptions : c_loptions)
: (t == x
? (exp ? x_export_loptions : x_loptions)
: l.ctx.var_pool[t + (exp ? ".export.loptions" : ".loptions")]));
append_options (d.cs, *g, var);
}
return true;
};
process_libraries (a, bs, li, sys_lib_dirs,
l, la,
lf, imp, lib, opt, true /* self */,
lib_cache);
}
void link_rule::
rpath_libraries (rpathed_libraries& ls, strings& args,
const scope& bs,
action a, const file& l, bool la,
linfo li, bool link, bool self,
library_cache* lib_cache) const
{
// Use -rpath-link only on targets that support it (Linux, *BSD). Note
// that we don't really need it for top-level libraries.
//
if (link)
{
if (tclass != "linux" && tclass != "bsd")
return;
}
auto imp = [link] (const target& l, bool la)
{
// If we are not rpath-link'ing, then we only need to rpath interface
// libraries (they will include rpath's for their implementations)
// Otherwise, we have to do this recursively. In both cases we also
// want to see through utility libraries.
//
// The rpath-link part is tricky: ideally we would like to get only
// implementations and only of shared libraries. We are not interested
// in interfaces because we are linking their libraries explicitly.
// However, in our model there is no such thing as "implementation
// only"; it is either interface or interface and implementation. So
// we are going to rpath-link all of them which should be harmless
// except for some noise on the command line.
//
//
return (link ? !la : false) || l.is_a<libux> ();
};
// Package the data to keep within the 2-pointer small std::function
// optimization limit.
//
struct
{
rpathed_libraries& ls;
strings& args;
bool link;
} d {ls, args, link};
auto lib = [&d, this] (
const target* const* lc,
const small_vector<reference_wrapper<const string>, 2>& ns,
lflags,
bool sys)
{
const file* l (lc != nullptr ? &(*lc)->as<file> () : nullptr);
// We don't rpath system libraries. Why, you may ask? There are many
// good reasons and I have them written on a napkin somewhere...
//
// We also assume system libraries can only depend on other system
// libraries and so can prune the traversal.
//
if (sys)
return false;
auto append = [&d] (const string& f)
{
string o (d.link ? "-Wl,-rpath-link," : "-Wl,-rpath,");
size_t p (path::traits_type::rfind_separator (f));
assert (p != string::npos);
o.append (f, 0, (p != 0 ? p : 1)); // Don't include trailing slash.
d.args.push_back (move (o));
};
if (l != nullptr)
{
if (!l->is_a<libs> ())
return true;
if (l->mtime () == timestamp_unreal) // Binless.
return true;
// Suppress duplicates.
//
// We handle rpath similar to the compilation case by adding the
// options on the first occurrence and ignoring (and pruning) all
// the subsequent.
//
if (find (d.ls.begin (), d.ls.end (), l) != d.ls.end ())
return false;
append (ns[0]);
d.ls.push_back (l);
}
else
{
// This is an absolute path and we need to decide whether it is
// a shared or static library. Doesn't seem there is anything
// better than checking for a platform-specific extension (maybe
// we should cache it somewhere).
//
for (const string& f: ns)
{
size_t p (path::traits_type::find_extension (f));
if (p == string::npos)
break;
++p; // Skip dot.
bool c (true);
const char* e;
if (tclass == "windows") {e = "dll"; c = false;}
else if (tsys == "darwin") e = "dylib";
else e = "so";
if ((c
? f.compare (p, string::npos, e)
: icasecmp (f.c_str () + p, e)) == 0)
append (f);
}
}
return true;
};
if (self && !link && !la)
{
// Top-level shared library dependency.
//
if (!l.path ().empty ()) // Not binless.
{
// It is either matched or imported so should be a cc library.
//
if (!cast_false<bool> (l.vars[c_system]))
{
args.push_back ("-Wl,-rpath," + l.path ().directory ().string ());
ls.push_back (&l);
}
}
}
process_libraries (a, bs, li, sys_lib_dirs,
l, la, 0 /* lflags */,
imp, lib, nullptr, false /* self */, lib_cache);
}
void link_rule::
rpath_libraries (strings& args,
const scope& bs, action a,
const target& t, linfo li, bool link) const
{
rpathed_libraries ls;
library_cache lc;
for (const prerequisite_target& pt: t.prerequisite_targets[a])
{
if (pt == nullptr)
continue;
bool la;
const file* f;
if ((la = (f = pt->is_a<liba> ())) ||
(la = (f = pt->is_a<libux> ())) ||
( f = pt->is_a<libs> ()))
{
rpath_libraries (ls, args, bs, a, *f, la, li, link, true, &lc);
}
}
}
// Append object files of bmi{} prerequisites that belong to binless
// libraries.
//
void link_rule::
append_binless_modules (strings& args,
const scope& bs, action a, const file& t) const
{
// Note that here we don't need to hoist anything on duplicate detection
// since the order in which we link object files is not important.
//
for (const target* pt: t.prerequisite_targets[a])
{
if (pt != nullptr &&
pt->is_a<bmix> () &&
cast_false<bool> ((*pt)[b_binless]))
{
const objx& o (*find_adhoc_member<objx> (*pt)); // Must be there.
string p (relative (o.path ()).string ());
if (find (args.begin (), args.end (), p) == args.end ())
{
args.push_back (move (p));
append_binless_modules (args, bs, a, o);
}
}
}
}
void link_rule::
append_binless_modules (sha256& cs,
const scope& bs, action a, const file& t) const
{
for (const target* pt: t.prerequisite_targets[a])
{
if (pt != nullptr &&
pt->is_a<bmix> () &&
cast_false<bool> ((*pt)[b_binless]))
{
const objx& o (*find_adhoc_member<objx> (*pt));
hash_path (cs, o.path (), bs.root_scope ()->out_path ());
append_binless_modules (cs, bs, a, o);
}
}
}
// Filter link.exe noise (msvc.cxx).
//
void
msvc_filter_link (ifdstream&, const file&, otype);
// Translate target CPU to the link.exe/lib.exe /MACHINE option.
//
const char*
msvc_machine (const string& cpu); // msvc.cxx
target_state link_rule::
perform_update (action a, const target& xt) const
{
tracer trace (x, "link_rule::perform_update");
const file& t (xt.as<file> ());
const path& tp (t.path ());
context& ctx (t.ctx);
const scope& bs (t.base_scope ());
const scope& rs (*bs.root_scope ());
match_data& md (t.data<match_data> ());
// Unless the outer install rule signalled that this is update for
// install, signal back that we've performed plain update.
//
if (!md.for_install)
md.for_install = false;
bool for_install (*md.for_install);
ltype lt (link_type (t));
otype ot (lt.type);
linfo li (link_info (bs, ot));
compile_target_types tts (compile_types (ot));
bool binless (md.binless);
assert (!lt.executable() || !binless); // Sanity check.
// Determine if we are out-of-date.
//
bool update (false);
bool scratch (false);
timestamp mt (binless ? timestamp_unreal : t.load_mtime ());
// Update prerequisites. We determine if any relevant non-ad hoc ones
// render us out-of-date manually below.
//
// Note that execute_prerequisites() blanks out all the ad hoc
// prerequisites so we don't need to worry about them from now on.
//
target_state ts;
if (optional<target_state> s =
execute_prerequisites (a,
t,
mt,
[] (const target&, size_t) {return false;}))
ts = *s;
else
{
// An ad hoc prerequisite renders us out-of-date. Let's update from
// scratch for good measure.
//
scratch = update = true;
ts = target_state::changed;
}
// Check for the for_install variable on each prerequisite and blank out
// those that don't match. Note that we have to do it after updating
// prerequisites to keep the dependency counts straight.
//
if (const variable* var_fi = ctx.var_pool.find ("for_install"))
{
// Parallel prerequisites/prerequisite_targets loop.
//
size_t i (md.start);
for (prerequisite_member p: group_prerequisite_members (a, t))
{
const target*& pt (t.prerequisite_targets[a][i++]);
if (pt == nullptr)
continue;
if (lookup l = p.prerequisite.vars[var_fi])
{
if (cast<bool> (l) != for_install)
{
l5 ([&]{trace << "excluding " << *pt << " due to for_install";});
pt = nullptr;
}
}
}
}
// (Re)generate pkg-config's .pc file. While the target itself might be
// up-to-date from a previous run, there is no guarantee that .pc exists
// or also up-to-date. So to keep things simple we just regenerate it
// unconditionally.
//
// Also, if you are wondering why don't we just always produce this .pc,
// install or no install, the reason is unless and until we are updating
// for install, we have no idea where-to things will be installed.
//
if (for_install && lt.library () && !lt.utility)
{
bool la (lt.static_library ());
pkgconfig_save (a, t, la, false /* common */, binless);
// Generate the common .pc file if the lib{} rule is matched (see
// apply() for details on this two-stage logic).
//
auto* m (find_adhoc_member<pc> (t)); // Will be pca/pcs if not found.
if (!m->is_a (la ? pca::static_type : pcs::static_type))
{
if (t.group->matched (a))
pkgconfig_save (a, t, la, true /* common */, binless);
else
// Mark as non-existent not to confuse the install rule.
//
m->mtime (timestamp_nonexistent);
}
}
// If we have no binary to build then we are done.
//
if (binless)
{
t.mtime (timestamp_unreal);
return ts;
}
// Open the dependency database (do it before messing with Windows
// manifests to diagnose missing output directory).
//
depdb dd (tp + ".d");
// Adjust the environment.
//
using environment = small_vector<string, 1>;
environment env;
sha256 env_cs;
// If we have the search paths in the binutils pattern, prepend them to
// the PATH environment variable so that any dependent tools (such as
// mt.exe that is invoked by link.exe) are first search for in there.
//
{
bin::pattern_paths pat (bin::lookup_pattern (rs));
if (pat.paths != nullptr)
{
string v ("PATH=");
v += pat.paths;
env_cs.append (v); // Hash only what we are adding.
if (optional<string> o = getenv ("PATH"))
{
v += path::traits_type::path_separator;
v += *o;
}
env.push_back (move (v));
}
}
// Convert the environment to what's expected by the process API.
//
small_vector<const char*, environment::small_size + 1> env_ptrs;
if (!env.empty ())
{
for (const string& v: env)
env_ptrs.push_back (v.c_str ());
env_ptrs.push_back (nullptr);
}
// If targeting Windows, take care of the manifest.
//
path manifest; // Manifest itself (msvc) or compiled object file.
timestamp rpath_timestamp = timestamp_nonexistent; // DLLs timestamp.
if (lt.executable () && tclass == "windows")
{
// First determine if we need to add our rpath emulating assembly. The
// assembly itself is generated later, after updating the target. Omit
// it if we are updating for install.
//
if (!for_install && cast_true<bool> (t["bin.rpath.auto"]))
rpath_timestamp = windows_rpath_timestamp (t, bs, a, li);
auto p (windows_manifest (t, rpath_timestamp != timestamp_nonexistent));
path& mf (p.first);
timestamp mf_mt (p.second);
if (tsys == "mingw32")
{
// Compile the manifest into the object file with windres. While we
// are going to synthesize an .rc file to pipe to windres' stdin, we
// will still use .manifest to check if everything is up-to-date.
//
manifest = mf + ".o";
if (mf_mt == timestamp_nonexistent || mf_mt > mtime (manifest))
{
path of (relative (manifest));
const process_path& rc (cast<process_path> (rs["bin.rc.path"]));
// @@ Would be good to add this to depdb (e.g,, rc changes).
//
const char* args[] = {
rc.recall_string (),
"--input-format=rc",
"--output-format=coff",
"-o", of.string ().c_str (),
nullptr};
if (verb >= 3)
print_process (args);
if (!ctx.dry_run)
{
auto_rmfile rm (of);
try
{
process pr (rc,
args,
-1 /* stdin */,
1 /* stdout */,
2 /* stderr */,
nullptr /* cwd */,
env_ptrs.empty () ? nullptr : env_ptrs.data ());
try
{
ofdstream os (move (pr.out_fd));
// 1 is resource ID, 24 is RT_MANIFEST. We also need to
// escape Windows path backslashes.
//
os << "1 24 \"" << sanitize_strlit (mf.string ()) << '"'
<< endl;
os.close ();
rm.cancel ();
}
catch (const io_error& e)
{
if (run_wait (args, pr))
fail << "unable to pipe resource file to " << args[0]
<< ": " << e;
// If the child process has failed then assume the io error
// was caused by that and let run_finish() deal with it.
}
run_finish (args, pr);
}
catch (const process_error& e)
{
error << "unable to execute " << args[0] << ": " << e;
if (e.child)
exit (1);
throw failed ();
}
}
update = true; // Manifest changed, force update.
}
}
else
{
manifest = move (mf); // Save for link.exe's /MANIFESTINPUT.
if (mf_mt == timestamp_nonexistent || mf_mt > mt)
update = true; // Manifest changed, force update.
}
}
// Check/update the dependency database.
//
// First should come the rule name/version.
//
if (dd.expect (rule_id) != nullptr)
l4 ([&]{trace << "rule mismatch forcing update of " << t;});
lookup ranlib;
// Then the linker checksum (ar/ranlib or the compiler).
//
if (lt.static_library ())
{
ranlib = rs["bin.ranlib.path"];
const char* rl (
ranlib
? cast<string> (rs["bin.ranlib.checksum"]).c_str ()
: "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855");
if (dd.expect (cast<string> (rs["bin.ar.checksum"])) != nullptr)
l4 ([&]{trace << "ar mismatch forcing update of " << t;});
if (dd.expect (rl) != nullptr)
l4 ([&]{trace << "ranlib mismatch forcing update of " << t;});
}
else
{
// For VC we use link.exe directly.
//
const string& cs (
cast<string> (
rs[tsys == "win32-msvc"
? ctx.var_pool["bin.ld.checksum"]
: x_checksum]));
if (dd.expect (cs) != nullptr)
l4 ([&]{trace << "linker mismatch forcing update of " << t;});
}
// Then the linker environment checksum (original and our modifications).
//
{
bool e (dd.expect (env_checksum) != nullptr);
if (dd.expect (env_cs.string ()) != nullptr || e)
l4 ([&]{trace << "environment mismatch forcing update of " << t;});
}
// Next check the target. While it might be incorporated into the linker
// checksum, it also might not (e.g., VC link.exe).
//
if (dd.expect (ctgt.string ()) != nullptr)
l4 ([&]{trace << "target mismatch forcing update of " << t;});
// Start building the command line. While we don't yet know whether we
// will really need it, we need to hash it to find out. So the options
// are to either replicate the exact process twice, first for hashing
// then for building or to go ahead and start building and hash the
// result. The first approach is probably more efficient while the
// second is simpler. Let's got with the simpler for now (actually it's
// kind of a hybrid).
//
cstrings args {nullptr}; // Reserve one for config.bin.ar/config.x.
strings sargs; // Argument tail with storage.
// Stored args.
//
string arg1, arg2;
strings sargs1;
// Shallow-copy over stored args to args. Note that this must only be
// done once we are finished appending to stored args because of
// potential reallocations.
//
auto append_args = [&args] (const strings& sargs)
{
for (const string& a: sargs)
args.push_back (a.c_str ());
};
if (lt.static_library ())
{
if (tsys == "win32-msvc")
{
// lib.exe has /LIBPATH but it's not clear/documented what it's used
// for. Perhaps for link-time code generation (/LTCG)? If that's the
// case, then we may need to pass *.loptions.
//
args.push_back ("/NOLOGO");
// Add /MACHINE.
//
args.push_back (msvc_machine (cast<string> (rs[x_target_cpu])));
// For utility libraries use thin archives if possible.
//
// LLVM's lib replacement had the /LLVMLIBTHIN option at least from
// version 3.8 so we will assume always.
//
if (lt.utility)
{
const string& id (cast<string> (rs["bin.ar.id"]));
if (id == "msvc-llvm")
args.push_back ("/LLVMLIBTHIN");
}
}
else
{
// If the user asked for ranlib, don't try to do its function with
// -s. Some ar implementations (e.g., the LLVM one) don't support
// leading '-'.
//
arg1 = ranlib ? "rc" : "rcs";
// For utility libraries use thin archives if possible.
//
// Thin archives are supported by GNU ar since binutils 2.19.1 and
// LLVM ar since LLVM 3.8.0. Note that strictly speaking thin
// archives also have to be supported by the linker but it is
// probably safe to assume that the two came from the same version
// of binutils/LLVM.
//
if (lt.utility)
{
const string& id (cast<string> (rs["bin.ar.id"]));
for (bool g (id == "gnu"); g || id == "llvm"; ) // Breakout loop.
{
auto mj (cast<uint64_t> (rs["bin.ar.version.major"]));
if (mj < (g ? 2 : 3)) break;
if (mj == (g ? 2 : 3))
{
auto mi (cast<uint64_t> (rs["bin.ar.version.minor"]));
if (mi < (g ? 18 : 8)) break;
if (mi == 18 && g)
{
auto pa (cast<uint64_t> (rs["bin.ar.version.patch"]));
if (pa < 1) break;
}
}
arg1 += 'T';
break;
}
}
args.push_back (arg1.c_str ());
}
append_options (args, t, c_aoptions);
append_options (args, t, x_aoptions);
}
else
{
// Are we using the compiler or the linker (e.g., link.exe) directly?
//
bool ldc (tsys != "win32-msvc");
if (ldc)
{
append_options (args, t, c_coptions);
append_options (args, t, x_coptions);
}
// Note that these come in the reverse order of coptions since the
// library search paths are examined in the order specified (in
// contrast to the "last value wins" semantics that we assume for
// coptions).
//
append_options (args, t, x_loptions);
append_options (args, t, c_loptions);
// Handle soname/rpath.
//
if (tclass == "windows")
{
// Limited emulation for Windows with no support for user-defined
// rpath/rpath-link.
//
lookup l;
if ((l = t["bin.rpath"]) && !l->empty ())
fail << ctgt << " does not support rpath";
if ((l = t["bin.rpath_link"]) && !l->empty ())
fail << ctgt << " does not support rpath-link";
}
else
{
// Set soname.
//
if (lt.shared_library ())
{
const libs_paths& paths (md.libs_paths);
const string& leaf (paths.effect_soname ().leaf ().string ());
if (tclass == "macos")
{
// With Mac OS 10.5 (Leopard) Apple finally caved in and gave us
// a way to emulate vanilla -rpath.
//
// It may seem natural to do something different on update for
// install. However, if we don't make it @rpath, then the user
// won't be able to use config.bin.rpath for installed libraries.
//
arg1 = "-install_name";
arg2 = "@rpath/" + leaf;
}
else
arg1 = "-Wl,-soname," + leaf;
if (!arg1.empty ())
args.push_back (arg1.c_str ());
if (!arg2.empty ())
args.push_back (arg2.c_str ());
}
// Add rpaths. We used to first add the ones specified by the user
// so that they take precedence. But that caused problems if we have
// old versions of the libraries sitting in the rpath location
// (e.g., installed libraries). And if you think about this, it's
// probably correct to prefer libraries that we explicitly imported
// to the ones found via rpath.
//
// Note also that if this is update for install, then we don't add
// rpath of the imported libraries (i.e., we assume they are also
// installed). But we add -rpath-link for some platforms.
//
if (cast_true<bool> (t[for_install
? "bin.rpath_link.auto"
: "bin.rpath.auto"]))
rpath_libraries (sargs, bs, a, t, li, for_install /* link */);
lookup l;
if ((l = t["bin.rpath"]) && !l->empty ())
for (const dir_path& p: cast<dir_paths> (l))
sargs.push_back ("-Wl,-rpath," + p.string ());
if ((l = t["bin.rpath_link"]) && !l->empty ())
{
// Only certain targets support -rpath-link (Linux, *BSD).
//
if (tclass != "linux" && tclass != "bsd")
fail << ctgt << " does not support rpath-link";
for (const dir_path& p: cast<dir_paths> (l))
sargs.push_back ("-Wl,-rpath-link," + p.string ());
}
}
if (ldc)
{
// See the compile rule for details. Note that here we don't really
// know whether it's a C++ executable so we may end up with some
// unnecessary overhead.
//
if (ctype == compiler_type::clang && cvariant == "emscripten")
{
if (!find_option_prefix ("DISABLE_EXCEPTION_CATCHING=", args))
{
args.push_back ("-s");
args.push_back ("DISABLE_EXCEPTION_CATCHING=0");
}
}
append_options (args, cmode);
}
// Extra system library dirs (last).
//
assert (sys_lib_dirs_extra <= sys_lib_dirs.size ());
if (tsys == "win32-msvc")
{
// If we have no LIB environment variable set, then we add all of
// them. But we want extras to come first.
//
// Note that the mode options are added as part of cmode.
//
auto b (sys_lib_dirs.begin () + sys_lib_dirs_mode);
auto m (sys_lib_dirs.begin () + sys_lib_dirs_extra);
auto e (sys_lib_dirs.end ());
for (auto i (m); i != e; ++i)
sargs1.push_back ("/LIBPATH:" + i->string ());
if (!getenv ("LIB"))
{
for (auto i (b); i != m; ++i)
sargs1.push_back ("/LIBPATH:" + i->string ());
}
append_args (sargs1);
}
else
{
append_option_values (
args,
"-L",
sys_lib_dirs.begin () + sys_lib_dirs_extra, sys_lib_dirs.end (),
[] (const dir_path& d) {return d.string ().c_str ();});
}
}
// All the options should now be in. Hash them and compare with the db.
//
{
sha256 cs;
for (size_t i (1); i != args.size (); ++i)
cs.append (args[i]);
for (size_t i (0); i != sargs.size (); ++i)
cs.append (sargs[i]);
// @@ Note that we don't hash output options so if one of the ad hoc
// members that we manage gets renamed, we will miss a rebuild.
if (dd.expect (cs.string ()) != nullptr)
l4 ([&]{trace << "options mismatch forcing update of " << t;});
}
// Finally, hash and compare the list of input files.
//
// Should we capture actual file names or their checksum? The only good
// reason for capturing actual files is diagnostics: we will be able to
// pinpoint exactly what is causing the update. On the other hand, the
// checksum is faster and simpler. And we like simple.
//
const file* def (nullptr); // Cached if present.
{
sha256 cs;
library_cache lc;
for (const prerequisite_target& p: t.prerequisite_targets[a])
{
const target* pt (p.target);
if (pt == nullptr)
continue;
// If this is bmi*{}, then obj*{} is its ad hoc member.
//
if (modules)
{
if (pt->is_a<bmix> ())
{
pt = find_adhoc_member (*pt, tts.obj);
if (pt == nullptr) // Header BMIs have no object file.
continue;
}
}
const file* f;
bool la (false), ls (false);
// We link utility libraries to everything except other utility
// libraries. In case of linking to liba{} we follow the "thin
// archive" lead and "see through" to their object file
// prerequisites (recursively, until we encounter a non-utility).
//
if ((f = pt->is_a<objx> ()) ||
(!lt.utility &&
(la = (f = pt->is_a<libux> ()))) ||
(!lt.static_library () &&
((la = (f = pt->is_a<liba> ())) ||
(ls = (f = pt->is_a<libs> ())))))
{
// Link all the dependent interface libraries (shared) or interface
// and implementation (static), recursively.
//
// Also check if any of them render us out of date. The tricky
// case is, say, a utility library (static) that depends on a
// shared library. When the shared library is updated, there is no
// reason to re-archive the utility but those who link the utility
// have to "see through" the changes in the shared library.
//
if (la || ls)
{
append_libraries (cs, update, mt, bs, a, *f, la, p.data, li, &lc);
f = nullptr; // Timestamp checked by hash_libraries().
}
else
{
hash_path (cs, f->path (), rs.out_path ());
// @@ Do we actually need to hash this? I don't believe this set
// can change without rendering the object file itself out of
// date. Maybe in some pathological case where the bmi*{} is
// marked with bin.binless manually?
//
if (modules)
append_binless_modules (cs, rs, a, *f);
}
}
else if ((f = pt->is_a<bin::def> ()))
{
if (tclass == "windows" && !lt.static_library ())
{
// At least link.exe only allows a single .def file.
//
if (def != nullptr)
fail << "multiple module definition files specified for " << t;
hash_path (cs, f->path (), rs.out_path ());
def = f;
}
else
f = nullptr; // Not an input.
}
else
f = pt->is_a<exe> (); // Consider executable mtime (e.g., linker).
// Check if this input renders us out of date.
//
if (f != nullptr)
update = update || f->newer (mt);
}
// Treat it as input for both MinGW and VC (mtime checked above).
//
if (!manifest.empty ())
hash_path (cs, manifest, rs.out_path ());
// Treat *.libs variable values as inputs, not options.
//
if (!lt.static_library ())
{
append_options (cs, t, c_libs);
append_options (cs, t, x_libs);
}
if (dd.expect (cs.string ()) != nullptr)
l4 ([&]{trace << "file set mismatch forcing update of " << t;});
}
// If any of the above checks resulted in a mismatch (different linker,
// options or input file set), or if the database is newer than the
// target (interrupted update) then force the target update. Also note
// this situation in the "from scratch" flag.
//
if (dd.writing () || dd.mtime > mt)
scratch = update = true;
dd.close ();
// If nothing changed, then we are done.
//
if (!update)
return ts;
// Ok, so we are updating. Finish building the command line.
//
string in, out, out1, out2, out3; // Storage.
// Translate paths to relative (to working directory) ones. This results
// in easier to read diagnostics.
//
path relt (relative (tp));
const process_path* ld (nullptr);
if (lt.static_library ())
{
ld = &cast<process_path> (rs["bin.ar.path"]);
if (tsys == "win32-msvc")
{
out = "/OUT:" + relt.string ();
args.push_back (out.c_str ());
}
else
args.push_back (relt.string ().c_str ());
}
else
{
// The options are usually similar enough to handle executables
// and shared libraries together.
//
if (tsys == "win32-msvc")
{
// Using link.exe directly.
//
ld = &cast<process_path> (rs["bin.ld.path"]);
args.push_back ("/NOLOGO");
if (ot == otype::s)
args.push_back ("/DLL");
// Add /MACHINE.
//
args.push_back (msvc_machine (cast<string> (rs[x_target_cpu])));
// Unless explicitly enabled with /INCREMENTAL, disable incremental
// linking (it is implicitly enabled if /DEBUG is specified). The
// reason is the .ilk file: its name cannot be changed and if we
// have, say, foo.exe and foo.dll, then they will end up stomping on
// each other's .ilk's.
//
// So the idea is to disable it by default but let the user request
// it explicitly if they are sure their project doesn't suffer from
// the above issue. We can also have something like 'incremental'
// config initializer keyword for this.
//
// It might also be a good idea to ask Microsoft to add an option.
//
if (!find_option ("/INCREMENTAL", args, true))
args.push_back ("/INCREMENTAL:NO");
if (ctype == compiler_type::clang)
{
// See the runtime selection code in the compile rule for details
// on what's going on here.
//
initializer_list<const char*> os {"-nostdlib", "-nostartfiles"};
if (!find_options (os, cmode) &&
!find_options (os, t, c_coptions) &&
!find_options (os, t, x_coptions))
{
args.push_back ("/DEFAULTLIB:msvcrt");
args.push_back ("/DEFAULTLIB:oldnames");
}
}
// If you look at the list of libraries Visual Studio links by
// default, it includes everything and a couple of kitchen sinks
// (winspool32.lib, ole32.lib, odbc32.lib, etc) while we want to
// keep our low-level build as pure as possible. However, there seem
// to be fairly essential libraries that are not linked by link.exe
// by default (use /VERBOSE:LIB to see the list). For example, MinGW
// by default links advapi32, shell32, user32, and kernel32. And so
// we follow suit and make sure those are linked. advapi32 and
// kernel32 are already on the default list and we only need to add
// the other two.
//
// The way we are going to do it is via the /DEFAULTLIB option
// rather than specifying the libraries as normal inputs (as VS
// does). This way the user can override our actions with the
// /NODEFAULTLIB option.
//
args.push_back ("/DEFAULTLIB:shell32");
args.push_back ("/DEFAULTLIB:user32");
// Take care of the manifest (will be empty for the DLL).
//
if (!manifest.empty ())
{
out3 = "/MANIFESTINPUT:";
out3 += relative (manifest).string ();
args.push_back ("/MANIFEST:EMBED");
args.push_back (out3.c_str ());
}
if (def != nullptr)
{
in = "/DEF:" + relative (def->path ()).string ();
args.push_back (in.c_str ());
}
// VC link.exe creates an import library and .exp file for an
// executable if any of its object files export any symbols (think a
// unit test linking libus{}). And, no, there is no way to suppress
// it (but we can change their names with /IMPLIB). Well, there is a
// way: create a .def file with an empty EXPORTS section, pass it to
// lib.exe to create a dummy .exp (and .lib), and then pass this
// empty .exp to link.exe. Wanna go this way? Didn't think so.
//
// Having no way to disable this, the next simplest thing seems to
// be just cleaning this mess up. Note, however, that we better
// change the default name since otherwise it will be impossible to
// have a library and an executable with the same name in the same
// directory (their .lib's will clash).
//
// Note also that if at some point we decide to support such "shared
// executables" (-rdynamic, etc), then it will probably have to be a
// different target type (exes{}?) since it will need a different set
// of object files (-fPIC so probably objs{}), etc.
//
// Also, while we are at it, this means there could be a DLL without
// an import library (which we currently don't handle very well).
//
out2 = "/IMPLIB:";
if (ot == otype::s)
{
// On Windows libs{} is the DLL and an ad hoc group member is the
// import library.
//
// This will also create the .exp export file. Its name will be
// derived from the import library by changing the extension.
// Lucky for us -- there is no option to name it.
//
out2 += relative (find_adhoc_member<libi> (t)->path ()).string ();
}
else
{
out2 += relt.string ();
out2 += ".lib";
}
args.push_back (out2.c_str ());
// If we have /DEBUG then name the .pdb file. It is an ad hoc group
// member.
//
if (find_option ("/DEBUG", args, true))
{
const file& pdb (
*find_adhoc_member<file> (t, *bs.find_target_type ("pdb")));
out1 = "/PDB:";
out1 += relative (pdb.path ()).string ();
args.push_back (out1.c_str ());
}
out = "/OUT:" + relt.string ();
args.push_back (out.c_str ());
}
else
{
switch (cclass)
{
case compiler_class::gcc:
{
ld = &cpath;
// Add the option that triggers building a shared library and
// take care of any extras (e.g., import library).
//
if (ot == otype::s)
{
if (tclass == "macos")
args.push_back ("-dynamiclib");
else
args.push_back ("-shared");
if (tsys == "mingw32")
{
// On Windows libs{} is the DLL and an ad hoc group member
// is the import library.
//
const file& imp (*find_adhoc_member<libi> (t));
out = "-Wl,--out-implib=" + relative (imp.path ()).string ();
args.push_back (out.c_str ());
}
}
args.push_back ("-o");
args.push_back (relt.string ().c_str ());
// For MinGW the .def file is just another input.
//
if (def != nullptr)
{
in = relative (def->path ()).string ();
args.push_back (in.c_str ());
}
break;
}
case compiler_class::msvc: assert (false);
}
}
}
args[0] = ld->recall_string ();
// Append input files noticing the position of the first.
//
#ifdef _WIN32
size_t args_input (args.size ());
#endif
// The same logic as during hashing above. See also a similar loop
// inside append_libraries().
//
bool seen_obj (false);
{
appended_libraries als;
library_cache lc;
for (const prerequisite_target& p: t.prerequisite_targets[a])
{
const target* pt (p.target);
if (pt == nullptr)
continue;
if (modules)
{
if (pt->is_a<bmix> ())
{
pt = find_adhoc_member (*pt, tts.obj);
if (pt == nullptr) // Header BMIs have no object file.
continue;
}
}
const file* f;
bool la (false), ls (false);
if ((f = pt->is_a<objx> ()) ||
(!lt.utility &&
(la = (f = pt->is_a<libux> ()))) ||
(!lt.static_library () &&
((la = (f = pt->is_a<liba> ())) ||
(ls = (f = pt->is_a<libs> ())))))
{
if (la || ls)
append_libraries (
als, sargs, bs, a, *f, la, p.data, li, true, true, &lc);
else
{
// Do not hoist libraries over object files since such object
// files might satisfy symbols in the preceding libraries.
//
als.clear ();
sargs.push_back (relative (f->path ()).string ());
if (modules)
append_binless_modules (sargs, bs, a, *f);
seen_obj = true;
}
}
}
}
// For MinGW manifest is an object file.
//
if (!manifest.empty () && tsys == "mingw32")
sargs.push_back (relative (manifest).string ());
// LLD misses an input file if we are linking only whole archives (LLVM
// bug #43744, fixed in 9.0.1, 10.0.0). Repeating one of the previously-
// mentioned archives seems to work around the issue.
//
if (!seen_obj &&
!lt.static_library () &&
tsys == "win32-msvc" &&
cast<string> (rs["bin.ld.id"]) == "msvc-lld")
{
uint64_t mj;
if ((mj = cast<uint64_t> (rs["bin.ld.version.major"])) < 9 ||
(mj == 9 &&
cast<uint64_t> (rs["bin.ld.version.minor"]) == 0 &&
cast<uint64_t> (rs["bin.ld.version.patch"]) == 0))
{
auto i (find_if (sargs.rbegin (), sargs.rend (),
[] (const string& a)
{
return a.compare (0, 14, "/WHOLEARCHIVE:") == 0;
}));
if (i != sargs.rend ())
sargs.push_back (i->c_str () + 14);
}
}
// Shallow-copy sargs over to args.
//
append_args (sargs);
if (!lt.static_library ())
{
append_options (args, t, c_libs);
append_options (args, t, x_libs);
}
args.push_back (nullptr);
// Cleanup old (versioned) libraries. Let's do it even for dry-run to
// keep things simple.
//
if (lt.shared_library ())
{
const libs_paths& paths (md.libs_paths);
auto rm = [&paths, this] (path&& m, const string&, bool interm)
{
if (!interm)
{
// Filter out paths that match one of the current paths or a
// prefix of the real path (the latter takes care of auxiliary
// things like .d, .t, etc., that are normally derived from the
// target name).
//
// Yes, we are basically ad hoc-excluding things that break. Maybe
// we should use something more powerful for the pattern, such as
// regex? We could have a filesystem pattern which we then filter
// against a regex pattern?
//
auto prefix = [&m] (const path& p)
{
return path::traits_type::compare (m.string (),
p.string (),
p.string ().size ()) == 0;
};
if (!prefix (*paths.real) &&
m != paths.interm &&
m != paths.soname &&
m != paths.load &&
m != paths.link)
{
try_rmfile (m);
if (m.extension () != "d")
{
try_rmfile (m + ".d");
if (tsys == "win32-msvc")
{
try_rmfile (m.base () += ".ilk");
try_rmfile (m += ".pdb");
}
}
}
}
return true;
};
auto clean = [&rm] (const path& p)
{
try
{
if (verb >= 4) // Seeing this with -V doesn't really add any value.
text << "rm " << p;
// Note: doesn't follow symlinks.
//
path_search (p,
rm,
dir_path () /* start */,
path_match_flags::none);
}
catch (const system_error&) {} // Ignore errors.
};
if (!paths.clean_load.empty ()) clean (paths.clean_load);
if (!paths.clean_version.empty ()) clean (paths.clean_version);
}
else if (lt.static_library ())
{
// We use relative paths to the object files which means we may end
// up with different ones depending on CWD and some implementation
// treat them as different archive members. So remote the file to
// be sure. Note that we ignore errors leaving it to the archiever
// to complain.
//
if (mt != timestamp_nonexistent)
try_rmfile (relt, true);
}
if (verb == 1)
text << (lt.static_library () ? "ar " : "ld ") << t;
else if (verb == 2)
print_process (args);
// Adjust linker parallelism.
//
string jobs_arg;
scheduler::alloc_guard jobs_extra;
if (!lt.static_library ())
{
switch (ctype)
{
case compiler_type::gcc:
{
// Rewrite -flto=auto (available since GCC 10).
//
// By default GCC 10 splits the optimization into 128 units.
//
if (cmaj < 10)
break;
auto i (find_option_prefix ("-flto", args.rbegin (), args.rend ()));
if (i != args.rend () && strcmp (*i, "-flto=auto") == 0)
{
jobs_extra = scheduler::alloc_guard (ctx.sched, 0);
jobs_arg = "-flto=" + to_string (1 + jobs_extra.n);
*i = jobs_arg.c_str ();
}
break;
}
case compiler_type::clang:
{
// If we have -flto=thin and no explicit -flto-jobs=N (available
// since Clang 4), then add our own -flto-jobs value.
//
if (cmaj < 4)
break;
auto i (find_option_prefix ("-flto", args.rbegin (), args.rend ()));
if (i != args.rend () &&
strcmp (*i, "-flto=thin") == 0 &&
!find_option_prefix ("-flto-jobs=", args))
{
jobs_extra = scheduler::alloc_guard (ctx.sched, 0);
jobs_arg = "-flto-jobs=" + to_string (1 + jobs_extra.n);
args.insert (i.base (), jobs_arg.c_str ()); // After -flto=thin.
}
break;
}
case compiler_type::msvc:
case compiler_type::icc:
break;
}
}
// Do any necessary fixups to the command line to make it runnable.
//
// Notice the split in the diagnostics: at verbosity level 1 we print
// the "logical" command line while at level 2 and above -- what we are
// actually executing.
//
// On Windows we need to deal with the command line length limit. The
// best workaround seems to be passing (part of) the command line in an
// "options file" ("response file" in Microsoft's terminology). Both
// Microsoft's link.exe/lib.exe as well as GNU g??.exe/ar.exe support
// the same @<file> notation (and with a compatible subset of the
// content format; see below). Note also that GCC is smart enough to use
// an options file to call the underlying linker if we called it with
// @<file>. We will also assume that any other linker that we might be
// using supports this notation.
//
// Note that this is a limitation of the host platform, not the target
// (and Wine, where these lines are a bit blurred, does not have this
// length limitation).
//
#ifdef _WIN32
auto_rmfile trm;
string targ;
{
auto quote = [s = string ()] (const char* a) mutable -> const char*
{
return process::quote_argument (a, s, false /* batch */);
};
// Calculate the would-be command line length similar to how process'
// implementation does it.
//
size_t n (0);
for (const char* a: args)
{
if (a != nullptr)
{
if (n != 0)
n++; // For the space separator.
n += strlen (quote (a));
}
}
if (n > 32766) // 32768 - "Unicode terminating null character".
{
// Use the .t extension (for "temporary").
//
const path& f ((trm = auto_rmfile (relt + ".t")).path);
try
{
ofdstream ofs (f);
// Both Microsoft and GNU support a space-separated list of
// potentially-quoted arguments. GNU also supports backslash-
// escaping (whether Microsoft supports it is unclear; but it
// definitely doesn't need it for backslashes themselves, for
// example, in paths).
//
bool e (tsys != "win32-msvc"); // Assume GNU if not MSVC.
string b;
for (size_t i (args_input), n (args.size () - 1); i != n; ++i)
{
const char* a (args[i]);
if (e) // We will most likely have backslashes so just do it.
{
for (b.clear (); *a != '\0'; ++a)
{
if (*a != '\\')
b += *a;
else
b += "\\\\";
}
a = b.c_str ();
}
ofs << (i != args_input ? " " : "") << quote (a);
}
ofs << '\n';
ofs.close ();
}
catch (const io_error& e)
{
fail << "unable to write to " << f << ": " << e;
}
// Replace input arguments with @file.
//
targ = '@' + f.string ();
args.resize (args_input);
args.push_back (targ.c_str());
args.push_back (nullptr);
//@@ TODO: leave .t file if linker failed and verb > 2?
}
}
#endif
if (verb > 2)
print_process (args);
// Remove the target file if any of the subsequent (after the linker)
// actions fail or if the linker fails but does not clean up its mess
// (like link.exe). If we don't do that, then we will end up with a
// broken build that is up-to-date.
//
auto_rmfile rm;
if (!ctx.dry_run)
{
rm = auto_rmfile (relt);
try
{
// VC tools (both lib.exe and link.exe) send diagnostics to stdout.
// Also, link.exe likes to print various gratuitous messages. So for
// link.exe we redirect stdout to a pipe, filter that noise out, and
// send the rest to stderr.
//
// For lib.exe (and any other insane linker that may try to pull off
// something like this) we are going to redirect stdout to stderr.
// For sane compilers this should be harmless.
//
// Note that we don't need this for LLD's link.exe replacement which
// is quiet.
//
bool filter (tsys == "win32-msvc" &&
!lt.static_library () &&
cast<string> (rs["bin.ld.id"]) != "msvc-lld");
process pr (*ld,
args.data (),
0 /* stdin */,
(filter ? -1 : 2) /* stdout */,
2 /* stderr */,
nullptr /* cwd */,
env_ptrs.empty () ? nullptr : env_ptrs.data ());
if (filter)
{
try
{
ifdstream is (
move (pr.in_ofd), fdstream_mode::text, ifdstream::badbit);
msvc_filter_link (is, t, ot);
// If anything remains in the stream, send it all to stderr.
// Note that the eof check is important: if the stream is at
// eof, this and all subsequent writes to the diagnostics stream
// will fail (and you won't see a thing).
//
if (is.peek () != ifdstream::traits_type::eof ())
diag_stream_lock () << is.rdbuf ();
is.close ();
}
catch (const io_error&) {} // Assume exits with error.
}
run_finish (args, pr);
jobs_extra.deallocate ();
}
catch (const process_error& e)
{
error << "unable to execute " << args[0] << ": " << e;
// In a multi-threaded program that fork()'ed but did not exec(), it
// is unwise to try to do any kind of cleanup (like unwinding the
// stack and running destructors).
//
if (e.child)
{
rm.cancel ();
#ifdef _WIN32
trm.cancel ();
#endif
exit (1);
}
throw failed ();
}
// Clean up executable's import library (see above for details).
//
if (lt.executable () && tsys == "win32-msvc")
{
try_rmfile (relt + ".lib", true /* ignore_errors */);
try_rmfile (relt + ".exp", true /* ignore_errors */);
}
// Set executable bit on the .js file so that it can be run with a
// suitable binfmt interpreter (e.g., nodejs). See Emscripten issue
// 12707 for details.
//
#ifndef _WIN32
if (lt.executable () && tsys == "emscripten")
{
path_perms (relt,
(path_perms (relt) |
permissions::xu |
permissions::xg |
permissions::xo));
}
#endif
}
if (ranlib)
{
const process_path& rl (cast<process_path> (ranlib));
const char* args[] = {
rl.recall_string (),
relt.string ().c_str (),
nullptr};
if (verb >= 2)
print_process (args);
if (!ctx.dry_run)
run (rl,
args,
dir_path () /* cwd */,
env_ptrs.empty () ? nullptr : env_ptrs.data ());
}
// For Windows generate (or clean up) rpath-emulating assembly.
//
if (tclass == "windows")
{
if (lt.executable ())
windows_rpath_assembly (t, bs, a, li,
cast<string> (rs[x_target_cpu]),
rpath_timestamp,
scratch);
}
if (lt.shared_library ())
{
// For shared libraries we may need to create a bunch of symlinks (or
// fallback to hardlinks/copies on Windows).
//
auto ln = [&ctx] (const path& f, const path& l)
{
if (verb >= 3)
text << "ln -sf " << f << ' ' << l;
if (ctx.dry_run)
return;
try
{
try
{
// The -f part.
//
if (file_exists (l, false /* follow_symlinks */))
try_rmfile (l);
mkanylink (f, l, true /* copy */, true /* relative */);
}
catch (system_error& e)
{
throw pair<entry_type, system_error> (entry_type::symlink,
move (e));
}
}
catch (const pair<entry_type, system_error>& e)
{
const char* w (e.first == entry_type::regular ? "copy" :
e.first == entry_type::symlink ? "symlink" :
e.first == entry_type::other ? "hardlink" :
nullptr);
fail << "unable to make " << w << ' ' << l << ": " << e.second;
}
};
const libs_paths& paths (md.libs_paths);
const path& lk (paths.link);
const path& ld (paths.load);
const path& so (paths.soname);
const path& in (paths.interm);
const path* f (paths.real);
if (!in.empty ()) {ln (*f, in); f = ∈}
if (!so.empty ()) {ln (*f, so); f = &so;}
if (!ld.empty ()) {ln (*f, ld); f = &ld;}
if (!lk.empty ()) {ln (*f, lk);}
}
else if (lt.static_library ())
{
// Apple ar (from cctools) for some reason truncates fractional
// seconds when running on APFS (HFS has a second resolution so it's
// not an issue there). This can lead to object files being newer than
// the archive, which is naturally bad news. Filed as bug 49604334,
// reportedly fixed in Xcode 11 beta 5.
//
// Note that this block is not inside #ifdef __APPLE__ because we
// could be cross-compiling, theoretically. We also make sure we use
// Apple's ar (which is (un)recognized as 'generic') instead of, say,
// llvm-ar.
//
if (tsys == "darwin" && cast<string> (rs["bin.ar.id"]) == "generic")
{
if (!ctx.dry_run)
touch (ctx, tp, false /* create */, verb_never);
}
}
if (!ctx.dry_run)
{
rm.cancel ();
dd.check_mtime (tp);
}
// Should we go to the filesystem and get the new mtime? We know the
// file has been modified, so instead just use the current clock time.
// It has the advantage of having the subseconds precision. Plus, in
// case of dry-run, the file won't be modified.
//
t.mtime (system_clock::now ());
return target_state::changed;
}
target_state link_rule::
perform_clean (action a, const target& xt) const
{
const file& t (xt.as<file> ());
ltype lt (link_type (t));
const match_data& md (t.data<match_data> ());
clean_extras extras;
clean_adhoc_extras adhoc_extras;
if (md.binless)
; // Clean prerequsites/members.
else
{
if (tclass != "windows")
; // Everything is the default.
else if (tsys == "mingw32")
{
if (lt.executable ())
{
extras = {".d", ".dlls/", ".manifest.o", ".manifest"};
}
// For shared and static library it's the default.
}
else
{
// Assuming MSVC or alike.
//
if (lt.executable ())
{
// Clean up .ilk in case the user enabled incremental linking
// (notice that the .ilk extension replaces .exe).
//
extras = {".d", ".dlls/", ".manifest", "-.ilk"};
}
else if (lt.shared_library ())
{
// Clean up .ilk and .exp.
//
// Note that .exp is based on the .lib, not .dll name. And with
// versioning their bases may not be the same.
//
extras = {".d", "-.ilk"};
adhoc_extras.push_back ({libi::static_type, {"-.exp"}});
}
// For static library it's the default.
}
if (extras.empty ())
extras = {".d"}; // Default.
#ifdef _WIN32
extras.push_back (".t"); // Options file.
#endif
// For shared libraries we may have a bunch of symlinks that we need
// to remove.
//
if (lt.shared_library ())
{
const libs_paths& lp (md.libs_paths);
auto add = [&extras] (const path& p)
{
if (!p.empty ())
extras.push_back (p.string ().c_str ());
};
add (lp.link);
add (lp.load);
add (lp.soname);
add (lp.interm);
}
}
return perform_clean_extra (a, t, extras, adhoc_extras);
}
}
}
|