1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
|
/* Debuginfo-over-http server.
Copyright (C) 2019-2021 Red Hat, Inc.
Copyright (C) 2021, 2022 Mark J. Wielaard <mark@klomp.org>
This file is part of elfutils.
This file is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
elfutils is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>. */
/* cargo-cult from libdwfl linux-kernel-modules.c */
/* In case we have a bad fts we include this before config.h because it
can't handle _FILE_OFFSET_BITS.
Everything we need here is fine if its declarations just come first.
Also, include sys/types.h before fts. On some systems fts.h is not self
contained. */
#ifdef BAD_FTS
#include <sys/types.h>
#include <fts.h>
#endif
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
// #define _GNU_SOURCE
#ifdef HAVE_SCHED_H
extern "C" {
#include <sched.h>
}
#endif
#ifdef HAVE_SYS_RESOURCE_H
extern "C" {
#include <sys/resource.h>
}
#endif
extern "C" {
#include "printversion.h"
#include "system.h"
}
#include "debuginfod.h"
#include <dwarf.h>
#include <argp.h>
#ifdef __GNUC__
#undef __attribute__ /* glibc bug - rhbz 1763325 */
#endif
#include <unistd.h>
#include <stdlib.h>
#include <locale.h>
#include <pthread.h>
#include <signal.h>
#include <sys/stat.h>
#include <sys/time.h>
#include <sys/vfs.h>
#include <unistd.h>
#include <fcntl.h>
#include <netdb.h>
/* If fts.h is included before config.h, its indirect inclusions may not
give us the right LFS aliases of these functions, so map them manually. */
#ifdef BAD_FTS
#ifdef _FILE_OFFSET_BITS
#define open open64
#define fopen fopen64
#endif
#else
#include <sys/types.h>
#include <fts.h>
#endif
#include <cstring>
#include <vector>
#include <set>
#include <map>
#include <string>
#include <iostream>
#include <iomanip>
#include <ostream>
#include <sstream>
#include <mutex>
#include <deque>
#include <condition_variable>
#include <thread>
// #include <regex> // on rhel7 gcc 4.8, not competent
#include <regex.h>
// #include <algorithm>
using namespace std;
#include <gelf.h>
#include <libdwelf.h>
#include <microhttpd.h>
#if MHD_VERSION >= 0x00097002
// libmicrohttpd 0.9.71 broke API
#define MHD_RESULT enum MHD_Result
#else
#define MHD_RESULT int
#endif
#include <curl/curl.h>
#include <archive.h>
#include <archive_entry.h>
#include <sqlite3.h>
#ifdef __linux__
#include <sys/syscall.h>
#endif
#ifdef __linux__
#define tid() syscall(SYS_gettid)
#else
#define tid() pthread_self()
#endif
inline bool
string_endswith(const string& haystack, const string& needle)
{
return (haystack.size() >= needle.size() &&
equal(haystack.end()-needle.size(), haystack.end(),
needle.begin()));
}
// Roll this identifier for every sqlite schema incompatibility.
#define BUILDIDS "buildids9"
#if SQLITE_VERSION_NUMBER >= 3008000
#define WITHOUT_ROWID "without rowid"
#else
#define WITHOUT_ROWID ""
#endif
static const char DEBUGINFOD_SQLITE_DDL[] =
"pragma foreign_keys = on;\n"
"pragma synchronous = 0;\n" // disable fsync()s - this cache is disposable across a machine crash
"pragma journal_mode = wal;\n" // https://sqlite.org/wal.html
"pragma wal_checkpoint = truncate;\n" // clean out any preexisting wal file
"pragma journal_size_limit = 0;\n" // limit steady state file (between grooming, which also =truncate's)
"pragma auto_vacuum = incremental;\n" // https://sqlite.org/pragma.html
"pragma busy_timeout = 1000;\n" // https://sqlite.org/pragma.html
// NB: all these are overridable with -D option
// Normalization table for interning file names
"create table if not exists " BUILDIDS "_files (\n"
" id integer primary key not null,\n"
" name text unique not null\n"
" );\n"
// Normalization table for interning buildids
"create table if not exists " BUILDIDS "_buildids (\n"
" id integer primary key not null,\n"
" hex text unique not null);\n"
// Track the completion of scanning of a given file & sourcetype at given time
"create table if not exists " BUILDIDS "_file_mtime_scanned (\n"
" mtime integer not null,\n"
" file integer not null,\n"
" size integer not null,\n" // in bytes
" sourcetype text(1) not null\n"
" check (sourcetype IN ('F', 'R')),\n"
" foreign key (file) references " BUILDIDS "_files(id) on update cascade on delete cascade,\n"
" primary key (file, mtime, sourcetype)\n"
" ) " WITHOUT_ROWID ";\n"
"create table if not exists " BUILDIDS "_f_de (\n"
" buildid integer not null,\n"
" debuginfo_p integer not null,\n"
" executable_p integer not null,\n"
" file integer not null,\n"
" mtime integer not null,\n"
" foreign key (file) references " BUILDIDS "_files(id) on update cascade on delete cascade,\n"
" foreign key (buildid) references " BUILDIDS "_buildids(id) on update cascade on delete cascade,\n"
" primary key (buildid, file, mtime)\n"
" ) " WITHOUT_ROWID ";\n"
// Index for faster delete by file identifier
"create index if not exists " BUILDIDS "_f_de_idx on " BUILDIDS "_f_de (file, mtime);\n"
"create table if not exists " BUILDIDS "_f_s (\n"
" buildid integer not null,\n"
" artifactsrc integer not null,\n"
" file integer not null,\n" // NB: not necessarily entered into _mtime_scanned
" mtime integer not null,\n"
" foreign key (file) references " BUILDIDS "_files(id) on update cascade on delete cascade,\n"
" foreign key (artifactsrc) references " BUILDIDS "_files(id) on update cascade on delete cascade,\n"
" foreign key (buildid) references " BUILDIDS "_buildids(id) on update cascade on delete cascade,\n"
" primary key (buildid, artifactsrc, file, mtime)\n"
" ) " WITHOUT_ROWID ";\n"
"create table if not exists " BUILDIDS "_r_de (\n"
" buildid integer not null,\n"
" debuginfo_p integer not null,\n"
" executable_p integer not null,\n"
" file integer not null,\n"
" mtime integer not null,\n"
" content integer not null,\n"
" foreign key (file) references " BUILDIDS "_files(id) on update cascade on delete cascade,\n"
" foreign key (content) references " BUILDIDS "_files(id) on update cascade on delete cascade,\n"
" foreign key (buildid) references " BUILDIDS "_buildids(id) on update cascade on delete cascade,\n"
" primary key (buildid, debuginfo_p, executable_p, file, content, mtime)\n"
" ) " WITHOUT_ROWID ";\n"
// Index for faster delete by archive file identifier
"create index if not exists " BUILDIDS "_r_de_idx on " BUILDIDS "_r_de (file, mtime);\n"
"create table if not exists " BUILDIDS "_r_sref (\n" // outgoing dwarf sourcefile references from rpm
" buildid integer not null,\n"
" artifactsrc integer not null,\n"
" foreign key (artifactsrc) references " BUILDIDS "_files(id) on update cascade on delete cascade,\n"
" foreign key (buildid) references " BUILDIDS "_buildids(id) on update cascade on delete cascade,\n"
" primary key (buildid, artifactsrc)\n"
" ) " WITHOUT_ROWID ";\n"
"create table if not exists " BUILDIDS "_r_sdef (\n" // rpm contents that may satisfy sref
" file integer not null,\n"
" mtime integer not null,\n"
" content integer not null,\n"
" foreign key (file) references " BUILDIDS "_files(id) on update cascade on delete cascade,\n"
" foreign key (content) references " BUILDIDS "_files(id) on update cascade on delete cascade,\n"
" primary key (content, file, mtime)\n"
" ) " WITHOUT_ROWID ";\n"
// create views to glue together some of the above tables, for webapi D queries
"create view if not exists " BUILDIDS "_query_d as \n"
"select\n"
" b.hex as buildid, n.mtime, 'F' as sourcetype, f0.name as source0, n.mtime as mtime, null as source1\n"
" from " BUILDIDS "_buildids b, " BUILDIDS "_files f0, " BUILDIDS "_f_de n\n"
" where b.id = n.buildid and f0.id = n.file and n.debuginfo_p = 1\n"
"union all select\n"
" b.hex as buildid, n.mtime, 'R' as sourcetype, f0.name as source0, n.mtime as mtime, f1.name as source1\n"
" from " BUILDIDS "_buildids b, " BUILDIDS "_files f0, " BUILDIDS "_files f1, " BUILDIDS "_r_de n\n"
" where b.id = n.buildid and f0.id = n.file and f1.id = n.content and n.debuginfo_p = 1\n"
";"
// ... and for E queries
"create view if not exists " BUILDIDS "_query_e as \n"
"select\n"
" b.hex as buildid, n.mtime, 'F' as sourcetype, f0.name as source0, n.mtime as mtime, null as source1\n"
" from " BUILDIDS "_buildids b, " BUILDIDS "_files f0, " BUILDIDS "_f_de n\n"
" where b.id = n.buildid and f0.id = n.file and n.executable_p = 1\n"
"union all select\n"
" b.hex as buildid, n.mtime, 'R' as sourcetype, f0.name as source0, n.mtime as mtime, f1.name as source1\n"
" from " BUILDIDS "_buildids b, " BUILDIDS "_files f0, " BUILDIDS "_files f1, " BUILDIDS "_r_de n\n"
" where b.id = n.buildid and f0.id = n.file and f1.id = n.content and n.executable_p = 1\n"
";"
// ... and for S queries
"create view if not exists " BUILDIDS "_query_s as \n"
"select\n"
" b.hex as buildid, fs.name as artifactsrc, 'F' as sourcetype, f0.name as source0, n.mtime as mtime, null as source1, null as source0ref\n"
" from " BUILDIDS "_buildids b, " BUILDIDS "_files f0, " BUILDIDS "_files fs, " BUILDIDS "_f_s n\n"
" where b.id = n.buildid and f0.id = n.file and fs.id = n.artifactsrc\n"
"union all select\n"
" b.hex as buildid, f1.name as artifactsrc, 'R' as sourcetype, f0.name as source0, sd.mtime as mtime, f1.name as source1, fsref.name as source0ref\n"
" from " BUILDIDS "_buildids b, " BUILDIDS "_files f0, " BUILDIDS "_files f1, " BUILDIDS "_files fsref, "
" " BUILDIDS "_r_sdef sd, " BUILDIDS "_r_sref sr, " BUILDIDS "_r_de sde\n"
" where b.id = sr.buildid and f0.id = sd.file and fsref.id = sde.file and f1.id = sd.content\n"
" and sr.artifactsrc = sd.content and sde.buildid = sr.buildid\n"
";"
// and for startup overview counts
"drop view if exists " BUILDIDS "_stats;\n"
"create view if not exists " BUILDIDS "_stats as\n"
" select 'file d/e' as label,count(*) as quantity from " BUILDIDS "_f_de\n"
"union all select 'file s',count(*) from " BUILDIDS "_f_s\n"
"union all select 'archive d/e',count(*) from " BUILDIDS "_r_de\n"
"union all select 'archive sref',count(*) from " BUILDIDS "_r_sref\n"
"union all select 'archive sdef',count(*) from " BUILDIDS "_r_sdef\n"
"union all select 'buildids',count(*) from " BUILDIDS "_buildids\n"
"union all select 'filenames',count(*) from " BUILDIDS "_files\n"
"union all select 'files scanned (#)',count(*) from " BUILDIDS "_file_mtime_scanned\n"
"union all select 'files scanned (mb)',coalesce(sum(size)/1024/1024,0) from " BUILDIDS "_file_mtime_scanned\n"
#if SQLITE_VERSION_NUMBER >= 3016000
"union all select 'index db size (mb)',page_count*page_size/1024/1024 as size FROM pragma_page_count(), pragma_page_size()\n"
#endif
";\n"
// schema change history & garbage collection
//
// XXX: we could have migration queries here to bring prior-schema
// data over instead of just dropping it.
//
// buildids9: widen the mtime_scanned table
"" // <<< we are here
// buildids8: slim the sref table
"drop table if exists buildids8_f_de;\n"
"drop table if exists buildids8_f_s;\n"
"drop table if exists buildids8_r_de;\n"
"drop table if exists buildids8_r_sref;\n"
"drop table if exists buildids8_r_sdef;\n"
"drop table if exists buildids8_file_mtime_scanned;\n"
"drop table if exists buildids8_files;\n"
"drop table if exists buildids8_buildids;\n"
// buildids7: separate _norm table into dense subtype tables
"drop table if exists buildids7_f_de;\n"
"drop table if exists buildids7_f_s;\n"
"drop table if exists buildids7_r_de;\n"
"drop table if exists buildids7_r_sref;\n"
"drop table if exists buildids7_r_sdef;\n"
"drop table if exists buildids7_file_mtime_scanned;\n"
"drop table if exists buildids7_files;\n"
"drop table if exists buildids7_buildids;\n"
// buildids6: drop bolo/rfolo again, represent sources / rpmcontents in main table
"drop table if exists buildids6_norm;\n"
"drop table if exists buildids6_files;\n"
"drop table if exists buildids6_buildids;\n"
"drop view if exists buildids6;\n"
// buildids5: redefine srcfile1 column to be '.'-less (for rpms)
"drop table if exists buildids5_norm;\n"
"drop table if exists buildids5_files;\n"
"drop table if exists buildids5_buildids;\n"
"drop table if exists buildids5_bolo;\n"
"drop table if exists buildids5_rfolo;\n"
"drop view if exists buildids5;\n"
// buildids4: introduce rpmfile RFOLO
"drop table if exists buildids4_norm;\n"
"drop table if exists buildids4_files;\n"
"drop table if exists buildids4_buildids;\n"
"drop table if exists buildids4_bolo;\n"
"drop table if exists buildids4_rfolo;\n"
"drop view if exists buildids4;\n"
// buildids3*: split out srcfile BOLO
"drop table if exists buildids3_norm;\n"
"drop table if exists buildids3_files;\n"
"drop table if exists buildids3_buildids;\n"
"drop table if exists buildids3_bolo;\n"
"drop view if exists buildids3;\n"
// buildids2: normalized buildid and filenames into interning tables;
"drop table if exists buildids2_norm;\n"
"drop table if exists buildids2_files;\n"
"drop table if exists buildids2_buildids;\n"
"drop view if exists buildids2;\n"
// buildids1: made buildid and artifacttype NULLable, to represent cached-negative
// lookups from sources, e.g. files or rpms that contain no buildid-indexable content
"drop table if exists buildids1;\n"
// buildids: original
"drop table if exists buildids;\n"
;
static const char DEBUGINFOD_SQLITE_CLEANUP_DDL[] =
"pragma wal_checkpoint = truncate;\n" // clean out any preexisting wal file
;
/* Name and version of program. */
ARGP_PROGRAM_VERSION_HOOK_DEF = print_version;
/* Bug report address. */
ARGP_PROGRAM_BUG_ADDRESS_DEF = PACKAGE_BUGREPORT;
/* Definitions of arguments for argp functions. */
static const struct argp_option options[] =
{
{ NULL, 0, NULL, 0, "Scanners:", 1 },
{ "scan-file-dir", 'F', NULL, 0, "Enable ELF/DWARF file scanning.", 0 },
{ "scan-rpm-dir", 'R', NULL, 0, "Enable RPM scanning.", 0 },
{ "scan-deb-dir", 'U', NULL, 0, "Enable DEB scanning.", 0 },
{ "scan-archive", 'Z', "EXT=CMD", 0, "Enable arbitrary archive scanning.", 0 },
// "source-oci-imageregistry" ...
{ NULL, 0, NULL, 0, "Options:", 2 },
{ "logical", 'L', NULL, 0, "Follow symlinks, default=ignore.", 0 },
{ "rescan-time", 't', "SECONDS", 0, "Number of seconds to wait between rescans, 0=disable.", 0 },
{ "groom-time", 'g', "SECONDS", 0, "Number of seconds to wait between database grooming, 0=disable.", 0 },
{ "maxigroom", 'G', NULL, 0, "Run a complete database groom/shrink pass at startup.", 0 },
{ "concurrency", 'c', "NUM", 0, "Limit scanning thread concurrency to NUM, default=#CPUs.", 0 },
{ "connection-pool", 'C', "NUM", OPTION_ARG_OPTIONAL,
"Use webapi connection pool with NUM threads, default=unlim.", 0 },
{ "include", 'I', "REGEX", 0, "Include files matching REGEX, default=all.", 0 },
{ "exclude", 'X', "REGEX", 0, "Exclude files matching REGEX, default=none.", 0 },
{ "port", 'p', "NUM", 0, "HTTP port to listen on, default 8002.", 0 },
{ "database", 'd', "FILE", 0, "Path to sqlite database.", 0 },
{ "ddl", 'D', "SQL", 0, "Apply extra sqlite ddl/pragma to connection.", 0 },
{ "verbose", 'v', NULL, 0, "Increase verbosity.", 0 },
{ "regex-groom", 'r', NULL, 0,"Uses regexes from -I and -X arguments to groom the database.",0},
#define ARGP_KEY_FDCACHE_FDS 0x1001
{ "fdcache-fds", ARGP_KEY_FDCACHE_FDS, "NUM", 0, "Maximum number of archive files to keep in fdcache.", 0 },
#define ARGP_KEY_FDCACHE_MBS 0x1002
{ "fdcache-mbs", ARGP_KEY_FDCACHE_MBS, "MB", 0, "Maximum total size of archive file fdcache.", 0 },
#define ARGP_KEY_FDCACHE_PREFETCH 0x1003
{ "fdcache-prefetch", ARGP_KEY_FDCACHE_PREFETCH, "NUM", 0, "Number of archive files to prefetch into fdcache.", 0 },
#define ARGP_KEY_FDCACHE_MINTMP 0x1004
{ "fdcache-mintmp", ARGP_KEY_FDCACHE_MINTMP, "NUM", 0, "Minimum free space% on tmpdir.", 0 },
#define ARGP_KEY_FDCACHE_PREFETCH_MBS 0x1005
{ "fdcache-prefetch-mbs", ARGP_KEY_FDCACHE_PREFETCH_MBS, "MB", 0,"Megabytes allocated to the \
prefetch cache.", 0},
#define ARGP_KEY_FDCACHE_PREFETCH_FDS 0x1006
{ "fdcache-prefetch-fds", ARGP_KEY_FDCACHE_PREFETCH_FDS, "NUM", 0,"Number of files allocated to the \
prefetch cache.", 0},
#define ARGP_KEY_FORWARDED_TTL_LIMIT 0x1007
{"forwarded-ttl-limit", ARGP_KEY_FORWARDED_TTL_LIMIT, "NUM", 0, "Limit of X-Forwarded-For hops, default 8.", 0},
#define ARGP_KEY_PASSIVE 0x1008
{ "passive", ARGP_KEY_PASSIVE, NULL, 0, "Do not scan or groom, read-only database.", 0 },
#define ARGP_KEY_DISABLE_SOURCE_SCAN 0x1009
{ "disable-source-scan", ARGP_KEY_DISABLE_SOURCE_SCAN, NULL, 0, "Do not scan dwarf source info.", 0 },
{ NULL, 0, NULL, 0, NULL, 0 },
};
/* Short description of program. */
static const char doc[] = "Serve debuginfo-related content across HTTP from files under PATHs.";
/* Strings for arguments in help texts. */
static const char args_doc[] = "[PATH ...]";
/* Prototype for option handler. */
static error_t parse_opt (int key, char *arg, struct argp_state *state);
static unsigned default_concurrency();
/* Data structure to communicate with argp functions. */
static struct argp argp =
{
options, parse_opt, args_doc, doc, NULL, NULL, NULL
};
static string db_path;
static sqlite3 *db; // single connection, serialized across all our threads!
static sqlite3 *dbq; // webapi query-servicing readonly connection, serialized ditto!
static unsigned verbose;
static volatile sig_atomic_t interrupted = 0;
static volatile sig_atomic_t forced_rescan_count = 0;
static volatile sig_atomic_t sigusr1 = 0;
static volatile sig_atomic_t forced_groom_count = 0;
static volatile sig_atomic_t sigusr2 = 0;
static unsigned http_port = 8002;
static unsigned rescan_s = 300;
static unsigned groom_s = 86400;
static bool maxigroom = false;
static unsigned concurrency = default_concurrency();
static int connection_pool = 0;
static set<string> source_paths;
static bool scan_files = false;
static map<string,string> scan_archives;
static vector<string> extra_ddl;
static regex_t file_include_regex;
static regex_t file_exclude_regex;
static bool regex_groom = false;
static bool traverse_logical;
static long fdcache_fds;
static long fdcache_mbs;
static long fdcache_prefetch;
static long fdcache_mintmp;
static long fdcache_prefetch_mbs;
static long fdcache_prefetch_fds;
static unsigned forwarded_ttl_limit = 8;
static bool scan_source_info = true;
static string tmpdir;
static bool passive_p = false;
static void set_metric(const string& key, double value);
// static void inc_metric(const string& key);
static void set_metric(const string& metric,
const string& lname, const string& lvalue,
double value);
static void inc_metric(const string& metric,
const string& lname, const string& lvalue);
static void add_metric(const string& metric,
const string& lname, const string& lvalue,
double value);
static void inc_metric(const string& metric,
const string& lname, const string& lvalue,
const string& rname, const string& rvalue);
static void add_metric(const string& metric,
const string& lname, const string& lvalue,
const string& rname, const string& rvalue,
double value);
class tmp_inc_metric { // a RAII style wrapper for exception-safe scoped increment & decrement
string m, n, v;
public:
tmp_inc_metric(const string& mname, const string& lname, const string& lvalue):
m(mname), n(lname), v(lvalue)
{
add_metric (m, n, v, 1);
}
~tmp_inc_metric()
{
add_metric (m, n, v, -1);
}
};
class tmp_ms_metric { // a RAII style wrapper for exception-safe scoped timing
string m, n, v;
struct timespec ts_start;
public:
tmp_ms_metric(const string& mname, const string& lname, const string& lvalue):
m(mname), n(lname), v(lvalue)
{
clock_gettime (CLOCK_MONOTONIC, & ts_start);
}
~tmp_ms_metric()
{
struct timespec ts_end;
clock_gettime (CLOCK_MONOTONIC, & ts_end);
double deltas = (ts_end.tv_sec - ts_start.tv_sec)
+ (ts_end.tv_nsec - ts_start.tv_nsec)/1.e9;
add_metric (m + "_milliseconds_sum", n, v, (deltas*1000.0));
inc_metric (m + "_milliseconds_count", n, v);
}
};
/* Handle program arguments. */
static error_t
parse_opt (int key, char *arg,
struct argp_state *state __attribute__ ((unused)))
{
int rc;
switch (key)
{
case 'v': verbose ++; break;
case 'd':
/* When using the in-memory database make sure it is shareable,
so we can open it twice as read/write and read-only. */
if (strcmp (arg, ":memory:") == 0)
db_path = "file::memory:?cache=shared";
else
db_path = string(arg);
break;
case 'p': http_port = (unsigned) atoi(arg);
if (http_port == 0 || http_port > 65535)
argp_failure(state, 1, EINVAL, "port number");
break;
case 'F': scan_files = true; break;
case 'R':
scan_archives[".rpm"]="cat"; // libarchive groks rpm natively
break;
case 'U':
scan_archives[".deb"]="(bsdtar -O -x -f - data.tar\\*)<";
scan_archives[".ddeb"]="(bsdtar -O -x -f - data.tar\\*)<";
scan_archives[".ipk"]="(bsdtar -O -x -f - data.tar\\*)<";
// .udeb too?
break;
case 'Z':
{
char* extension = strchr(arg, '=');
if (arg[0] == '\0')
argp_failure(state, 1, EINVAL, "missing EXT");
else if (extension)
scan_archives[string(arg, (extension-arg))]=string(extension+1);
else
scan_archives[string(arg)]=string("cat");
}
break;
case 'L':
if (passive_p)
argp_failure(state, 1, EINVAL, "-L option inconsistent with passive mode");
traverse_logical = true;
break;
case 'D':
if (passive_p)
argp_failure(state, 1, EINVAL, "-D option inconsistent with passive mode");
extra_ddl.push_back(string(arg));
break;
case 't':
if (passive_p)
argp_failure(state, 1, EINVAL, "-t option inconsistent with passive mode");
rescan_s = (unsigned) atoi(arg);
break;
case 'g':
if (passive_p)
argp_failure(state, 1, EINVAL, "-g option inconsistent with passive mode");
groom_s = (unsigned) atoi(arg);
break;
case 'G':
if (passive_p)
argp_failure(state, 1, EINVAL, "-G option inconsistent with passive mode");
maxigroom = true;
break;
case 'c':
if (passive_p)
argp_failure(state, 1, EINVAL, "-c option inconsistent with passive mode");
concurrency = (unsigned) atoi(arg);
if (concurrency < 1) concurrency = 1;
break;
case 'C':
if (arg)
{
connection_pool = atoi(arg);
if (connection_pool < 2)
argp_failure(state, 1, EINVAL, "-C NUM minimum 2");
}
break;
case 'I':
// NB: no problem with unconditional free here - an earlier failed regcomp would exit program
if (passive_p)
argp_failure(state, 1, EINVAL, "-I option inconsistent with passive mode");
regfree (&file_include_regex);
rc = regcomp (&file_include_regex, arg, REG_EXTENDED|REG_NOSUB);
if (rc != 0)
argp_failure(state, 1, EINVAL, "regular expression");
break;
case 'X':
if (passive_p)
argp_failure(state, 1, EINVAL, "-X option inconsistent with passive mode");
regfree (&file_exclude_regex);
rc = regcomp (&file_exclude_regex, arg, REG_EXTENDED|REG_NOSUB);
if (rc != 0)
argp_failure(state, 1, EINVAL, "regular expression");
break;
case 'r':
if (passive_p)
argp_failure(state, 1, EINVAL, "-r option inconsistent with passive mode");
regex_groom = true;
break;
case ARGP_KEY_FDCACHE_FDS:
fdcache_fds = atol (arg);
break;
case ARGP_KEY_FDCACHE_MBS:
fdcache_mbs = atol (arg);
break;
case ARGP_KEY_FDCACHE_PREFETCH:
fdcache_prefetch = atol (arg);
break;
case ARGP_KEY_FDCACHE_MINTMP:
fdcache_mintmp = atol (arg);
if( fdcache_mintmp > 100 || fdcache_mintmp < 0 )
argp_failure(state, 1, EINVAL, "fdcache mintmp percent");
break;
case ARGP_KEY_FORWARDED_TTL_LIMIT:
forwarded_ttl_limit = (unsigned) atoi(arg);
break;
case ARGP_KEY_ARG:
source_paths.insert(string(arg));
break;
case ARGP_KEY_FDCACHE_PREFETCH_FDS:
fdcache_prefetch_fds = atol(arg);
if ( fdcache_prefetch_fds < 0)
argp_failure(state, 1, EINVAL, "fdcache prefetch fds");
break;
case ARGP_KEY_FDCACHE_PREFETCH_MBS:
fdcache_prefetch_mbs = atol(arg);
if ( fdcache_prefetch_mbs < 0)
argp_failure(state, 1, EINVAL, "fdcache prefetch mbs");
break;
case ARGP_KEY_PASSIVE:
passive_p = true;
if (source_paths.size() > 0
|| maxigroom
|| extra_ddl.size() > 0
|| traverse_logical)
// other conflicting options tricky to check
argp_failure(state, 1, EINVAL, "inconsistent options with passive mode");
break;
case ARGP_KEY_DISABLE_SOURCE_SCAN:
scan_source_info = false;
break;
// case 'h': argp_state_help (state, stderr, ARGP_HELP_LONG|ARGP_HELP_EXIT_OK);
default: return ARGP_ERR_UNKNOWN;
}
return 0;
}
////////////////////////////////////////////////////////////////////////
static void add_mhd_response_header (struct MHD_Response *r,
const char *h, const char *v);
// represent errors that may get reported to an ostream and/or a libmicrohttpd connection
struct reportable_exception
{
int code;
string message;
reportable_exception(int c, const string& m): code(c), message(m) {}
reportable_exception(const string& m): code(503), message(m) {}
reportable_exception(): code(503), message() {}
void report(ostream& o) const; // defined under obatched() class below
MHD_RESULT mhd_send_response(MHD_Connection* c) const {
MHD_Response* r = MHD_create_response_from_buffer (message.size(),
(void*) message.c_str(),
MHD_RESPMEM_MUST_COPY);
add_mhd_response_header (r, "Content-Type", "text/plain");
MHD_RESULT rc = MHD_queue_response (c, code, r);
MHD_destroy_response (r);
return rc;
}
};
struct sqlite_exception: public reportable_exception
{
sqlite_exception(int rc, const string& msg):
reportable_exception(string("sqlite3 error: ") + msg + ": " + string(sqlite3_errstr(rc) ?: "?")) {
inc_metric("error_count","sqlite3",sqlite3_errstr(rc));
}
};
struct libc_exception: public reportable_exception
{
libc_exception(int rc, const string& msg):
reportable_exception(string("libc error: ") + msg + ": " + string(strerror(rc) ?: "?")) {
inc_metric("error_count","libc",strerror(rc));
}
};
struct archive_exception: public reportable_exception
{
archive_exception(const string& msg):
reportable_exception(string("libarchive error: ") + msg) {
inc_metric("error_count","libarchive",msg);
}
archive_exception(struct archive* a, const string& msg):
reportable_exception(string("libarchive error: ") + msg + ": " + string(archive_error_string(a) ?: "?")) {
inc_metric("error_count","libarchive",msg + ": " + string(archive_error_string(a) ?: "?"));
}
};
struct elfutils_exception: public reportable_exception
{
elfutils_exception(int rc, const string& msg):
reportable_exception(string("elfutils error: ") + msg + ": " + string(elf_errmsg(rc) ?: "?")) {
inc_metric("error_count","elfutils",elf_errmsg(rc));
}
};
////////////////////////////////////////////////////////////////////////
template <typename Payload>
class workq
{
set<Payload> q; // eliminate duplicates
mutex mtx;
condition_variable cv;
bool dead;
unsigned idlers; // number of threads busy with wait_idle / done_idle
unsigned fronters; // number of threads busy with wait_front / done_front
public:
workq() { dead = false; idlers = 0; fronters = 0; }
~workq() {}
void push_back(const Payload& p)
{
unique_lock<mutex> lock(mtx);
q.insert (p);
set_metric("thread_work_pending","role","scan", q.size());
cv.notify_all();
}
// kill this workqueue, wake up all idlers / scanners
void nuke() {
unique_lock<mutex> lock(mtx);
// optional: q.clear();
dead = true;
cv.notify_all();
}
// clear the workqueue, when scanning is interrupted with USR2
void clear() {
unique_lock<mutex> lock(mtx);
q.clear();
set_metric("thread_work_pending","role","scan", q.size());
// NB: there may still be some live fronters
cv.notify_all(); // maybe wake up waiting idlers
}
// block this scanner thread until there is work to do and no active idler
bool wait_front (Payload& p)
{
unique_lock<mutex> lock(mtx);
while (!dead && (q.size() == 0 || idlers > 0))
cv.wait(lock);
if (dead)
return false;
else
{
p = * q.begin();
q.erase (q.begin());
fronters ++; // prevent idlers from starting awhile, even if empty q
set_metric("thread_work_pending","role","scan", q.size());
// NB: don't wake up idlers yet! The consumer is busy
// processing this element until it calls done_front().
return true;
}
}
// notify waitq that scanner thread is done with that last item
void done_front ()
{
unique_lock<mutex> lock(mtx);
fronters --;
if (q.size() == 0 && fronters == 0)
cv.notify_all(); // maybe wake up waiting idlers
}
// block this idler thread until there is no work to do
void wait_idle ()
{
unique_lock<mutex> lock(mtx);
cv.notify_all(); // maybe wake up waiting scanners
while (!dead && ((q.size() != 0) || fronters > 0))
cv.wait(lock);
idlers ++;
}
void done_idle ()
{
unique_lock<mutex> lock(mtx);
idlers --;
cv.notify_all(); // maybe wake up waiting scanners, but probably not (shutting down)
}
};
typedef struct stat stat_t;
typedef pair<string,stat_t> scan_payload;
inline bool operator< (const scan_payload& a, const scan_payload& b)
{
return a.first < b.first; // don't bother compare the stat fields
}
static workq<scan_payload> scanq; // just a single one
// producer & idler: thread_main_fts_source_paths()
// consumer: thread_main_scanner()
// idler: thread_main_groom()
////////////////////////////////////////////////////////////////////////
// Unique set is a thread-safe structure that lends 'ownership' of a value
// to a thread. Other threads requesting the same thing are made to wait.
// It's like a semaphore-on-demand.
template <typename T>
class unique_set
{
private:
set<T> values;
mutex mtx;
condition_variable cv;
public:
unique_set() {}
~unique_set() {}
void acquire(const T& value)
{
unique_lock<mutex> lock(mtx);
while (values.find(value) != values.end())
cv.wait(lock);
values.insert(value);
}
void release(const T& value)
{
unique_lock<mutex> lock(mtx);
// assert (values.find(value) != values.end());
values.erase(value);
cv.notify_all();
}
};
// This is the object that's instantiate to uniquely hold a value in a
// RAII-pattern way.
template <typename T>
class unique_set_reserver
{
private:
unique_set<T>& please_hold;
T mine;
public:
unique_set_reserver(unique_set<T>& t, const T& value):
please_hold(t), mine(value) { please_hold.acquire(mine); }
~unique_set_reserver() { please_hold.release(mine); }
};
////////////////////////////////////////////////////////////////////////
// Print a standard timestamp.
static ostream&
timestamp (ostream &o)
{
char datebuf[80];
char *now2 = NULL;
time_t now_t = time(NULL);
struct tm now;
struct tm *nowp = gmtime_r (&now_t, &now);
if (nowp)
{
(void) strftime (datebuf, sizeof (datebuf), "%c", nowp);
now2 = datebuf;
}
return o << "[" << (now2 ? now2 : "") << "] "
<< "(" << getpid () << "/" << tid() << "): ";
}
// A little class that impersonates an ostream to the extent that it can
// take << streaming operations. It batches up the bits into an internal
// stringstream until it is destroyed; then flushes to the original ostream.
// It adds a timestamp
class obatched
{
private:
ostream& o;
stringstream stro;
static mutex lock;
public:
obatched(ostream& oo, bool timestamp_p = true): o(oo)
{
if (timestamp_p)
timestamp(stro);
}
~obatched()
{
unique_lock<mutex> do_not_cross_the_streams(obatched::lock);
o << stro.str();
o.flush();
}
operator ostream& () { return stro; }
template <typename T> ostream& operator << (const T& t) { stro << t; return stro; }
};
mutex obatched::lock; // just the one, since cout/cerr iostreams are not thread-safe
void reportable_exception::report(ostream& o) const {
obatched(o) << message << endl;
}
////////////////////////////////////////////////////////////////////////
// RAII style sqlite prepared-statement holder that matches { } block lifetime
struct sqlite_ps
{
private:
sqlite3* db;
const string nickname;
const string sql;
sqlite3_stmt *pp;
sqlite_ps(const sqlite_ps&); // make uncopyable
sqlite_ps& operator=(const sqlite_ps &); // make unassignable
public:
sqlite_ps (sqlite3* d, const string& n, const string& s): db(d), nickname(n), sql(s) {
// tmp_ms_metric tick("sqlite3","prep",nickname);
if (verbose > 4)
obatched(clog) << nickname << " prep " << sql << endl;
int rc = sqlite3_prepare_v2 (db, sql.c_str(), -1 /* to \0 */, & this->pp, NULL);
if (rc != SQLITE_OK)
throw sqlite_exception(rc, "prepare " + sql);
}
sqlite_ps& reset()
{
tmp_ms_metric tick("sqlite3","reset",nickname);
sqlite3_reset(this->pp);
return *this;
}
sqlite_ps& bind(int parameter, const string& str)
{
if (verbose > 4)
obatched(clog) << nickname << " bind " << parameter << "=" << str << endl;
int rc = sqlite3_bind_text (this->pp, parameter, str.c_str(), -1, SQLITE_TRANSIENT);
if (rc != SQLITE_OK)
throw sqlite_exception(rc, "sqlite3 bind");
return *this;
}
sqlite_ps& bind(int parameter, int64_t value)
{
if (verbose > 4)
obatched(clog) << nickname << " bind " << parameter << "=" << value << endl;
int rc = sqlite3_bind_int64 (this->pp, parameter, value);
if (rc != SQLITE_OK)
throw sqlite_exception(rc, "sqlite3 bind");
return *this;
}
sqlite_ps& bind(int parameter)
{
if (verbose > 4)
obatched(clog) << nickname << " bind " << parameter << "=" << "NULL" << endl;
int rc = sqlite3_bind_null (this->pp, parameter);
if (rc != SQLITE_OK)
throw sqlite_exception(rc, "sqlite3 bind");
return *this;
}
void step_ok_done() {
tmp_ms_metric tick("sqlite3","step_done",nickname);
int rc = sqlite3_step (this->pp);
if (verbose > 4)
obatched(clog) << nickname << " step-ok-done(" << sqlite3_errstr(rc) << ") " << sql << endl;
if (rc != SQLITE_OK && rc != SQLITE_DONE && rc != SQLITE_ROW)
throw sqlite_exception(rc, "sqlite3 step");
(void) sqlite3_reset (this->pp);
}
int step() {
tmp_ms_metric tick("sqlite3","step",nickname);
int rc = sqlite3_step (this->pp);
if (verbose > 4)
obatched(clog) << nickname << " step(" << sqlite3_errstr(rc) << ") " << sql << endl;
return rc;
}
~sqlite_ps () { sqlite3_finalize (this->pp); }
operator sqlite3_stmt* () { return this->pp; }
};
////////////////////////////////////////////////////////////////////////
// RAII style templated autocloser
template <class Payload, class Ignore>
struct defer_dtor
{
public:
typedef Ignore (*dtor_fn) (Payload);
private:
Payload p;
dtor_fn fn;
public:
defer_dtor(Payload _p, dtor_fn _fn): p(_p), fn(_fn) {}
~defer_dtor() { (void) (*fn)(p); }
private:
defer_dtor(const defer_dtor<Payload,Ignore>&); // make uncopyable
defer_dtor& operator=(const defer_dtor<Payload,Ignore> &); // make unassignable
};
////////////////////////////////////////////////////////////////////////
static string
header_censor(const string& str)
{
string y;
for (auto&& x : str)
{
if (isalnum(x) || x == '/' || x == '.' || x == ',' || x == '_' || x == ':')
y += x;
}
return y;
}
static string
conninfo (struct MHD_Connection * conn)
{
char hostname[256]; // RFC1035
char servname[256];
int sts = -1;
if (conn == 0)
return "internal";
/* Look up client address data. */
const union MHD_ConnectionInfo *u = MHD_get_connection_info (conn,
MHD_CONNECTION_INFO_CLIENT_ADDRESS);
struct sockaddr *so = u ? u->client_addr : 0;
if (so && so->sa_family == AF_INET) {
sts = getnameinfo (so, sizeof (struct sockaddr_in),
hostname, sizeof (hostname),
servname, sizeof (servname),
NI_NUMERICHOST | NI_NUMERICSERV);
} else if (so && so->sa_family == AF_INET6) {
struct sockaddr_in6* addr6 = (struct sockaddr_in6*) so;
if (IN6_IS_ADDR_V4MAPPED(&addr6->sin6_addr)) {
struct sockaddr_in addr4;
memset (&addr4, 0, sizeof(addr4));
addr4.sin_family = AF_INET;
addr4.sin_port = addr6->sin6_port;
memcpy (&addr4.sin_addr.s_addr, addr6->sin6_addr.s6_addr+12, sizeof(addr4.sin_addr.s_addr));
sts = getnameinfo ((struct sockaddr*) &addr4, sizeof (addr4),
hostname, sizeof (hostname),
servname, sizeof (servname),
NI_NUMERICHOST | NI_NUMERICSERV);
} else {
sts = getnameinfo (so, sizeof (struct sockaddr_in6),
hostname, sizeof (hostname),
servname, sizeof (servname),
NI_NUMERICHOST | NI_NUMERICSERV);
}
}
if (sts != 0) {
hostname[0] = servname[0] = '\0';
}
// extract headers relevant to administration
const char* user_agent = MHD_lookup_connection_value (conn, MHD_HEADER_KIND, "User-Agent") ?: "";
const char* x_forwarded_for = MHD_lookup_connection_value (conn, MHD_HEADER_KIND, "X-Forwarded-For") ?: "";
// NB: these are untrustworthy, beware if machine-processing log files
return string(hostname) + string(":") + string(servname) +
string(" UA:") + header_censor(string(user_agent)) +
string(" XFF:") + header_censor(string(x_forwarded_for));
}
////////////////////////////////////////////////////////////////////////
/* Wrapper for MHD_add_response_header that logs an error if we
couldn't add the specified header. */
static void
add_mhd_response_header (struct MHD_Response *r,
const char *h, const char *v)
{
if (MHD_add_response_header (r, h, v) == MHD_NO)
obatched(clog) << "Error: couldn't add '" << h << "' header" << endl;
}
static void
add_mhd_last_modified (struct MHD_Response *resp, time_t mtime)
{
struct tm now;
struct tm *nowp = gmtime_r (&mtime, &now);
if (nowp != NULL)
{
char datebuf[80];
size_t rc = strftime (datebuf, sizeof (datebuf), "%a, %d %b %Y %T GMT",
nowp);
if (rc > 0 && rc < sizeof (datebuf))
add_mhd_response_header (resp, "Last-Modified", datebuf);
}
add_mhd_response_header (resp, "Cache-Control", "public");
}
// quote all questionable characters of str for safe passage through a sh -c expansion.
static string
shell_escape(const string& str)
{
string y;
for (auto&& x : str)
{
if (! isalnum(x) && x != '/')
y += "\\";
y += x;
}
return y;
}
// PR25548: Perform POSIX / RFC3986 style path canonicalization on the input string.
//
// Namely:
// // -> /
// /foo/../ -> /
// /./ -> /
//
// This mapping is done on dwarf-side source path names, which may
// include these constructs, so we can deal with debuginfod clients
// that accidentally canonicalize the paths.
//
// realpath(3) is close but not quite right, because it also resolves
// symbolic links. Symlinks at the debuginfod server have nothing to
// do with the build-time symlinks, thus they must not be considered.
//
// see also curl Curl_dedotdotify() aka RFC3986, which we mostly follow here
// see also libc __realpath()
// see also llvm llvm::sys::path::remove_dots()
static string
canon_pathname (const string& input)
{
string i = input; // 5.2.4 (1)
string o;
while (i.size() != 0)
{
// 5.2.4 (2) A
if (i.substr(0,3) == "../")
i = i.substr(3);
else if(i.substr(0,2) == "./")
i = i.substr(2);
// 5.2.4 (2) B
else if (i.substr(0,3) == "/./")
i = i.substr(2);
else if (i == "/.")
i = ""; // no need to handle "/." complete-path-segment case; we're dealing with file names
// 5.2.4 (2) C
else if (i.substr(0,4) == "/../") {
i = i.substr(3);
string::size_type sl = o.rfind("/");
if (sl != string::npos)
o = o.substr(0, sl);
else
o = "";
} else if (i == "/..")
i = ""; // no need to handle "/.." complete-path-segment case; we're dealing with file names
// 5.2.4 (2) D
// no need to handle these cases; we're dealing with file names
else if (i == ".")
i = "";
else if (i == "..")
i = "";
// POSIX special: map // to /
else if (i.substr(0,2) == "//")
i = i.substr(1);
// 5.2.4 (2) E
else {
string::size_type next_slash = i.find("/", (i[0]=='/' ? 1 : 0)); // skip first slash
o += i.substr(0, next_slash);
if (next_slash == string::npos)
i = "";
else
i = i.substr(next_slash);
}
}
return o;
}
// Estimate available free space for a given filesystem via statfs(2).
// Return true if the free fraction is known to be smaller than the
// given minimum percentage. Also update a related metric.
bool statfs_free_enough_p(const string& path, const string& label, long minfree = 0)
{
struct statfs sfs;
int rc = statfs(path.c_str(), &sfs);
if (rc == 0)
{
double s = (double) sfs.f_bavail / (double) sfs.f_blocks;
set_metric("filesys_free_ratio","purpose",label, s);
return ((s * 100.0) < minfree);
}
return false;
}
// A map-like class that owns a cache of file descriptors (indexed by
// file / content names).
//
// If only it could use fd's instead of file names ... but we can't
// dup(2) to create independent descriptors for the same unlinked
// files, so would have to use some goofy linux /proc/self/fd/%d
// hack such as the following
#if 0
int superdup(int fd)
{
#ifdef __linux__
char *fdpath = NULL;
int rc = asprintf(& fdpath, "/proc/self/fd/%d", fd);
int newfd;
if (rc >= 0)
newfd = open(fdpath, O_RDONLY);
else
newfd = -1;
free (fdpath);
return newfd;
#else
return -1;
#endif
}
#endif
class libarchive_fdcache
{
private:
mutex fdcache_lock;
struct fdcache_entry
{
string archive;
string entry;
string fd;
double fd_size_mb; // slightly rounded up megabytes
};
deque<fdcache_entry> lru; // @head: most recently used
long max_fds;
deque<fdcache_entry> prefetch; // prefetched
long max_mbs;
long max_prefetch_mbs;
long max_prefetch_fds;
public:
void set_metrics()
{
double fdcache_mb = 0.0;
double prefetch_mb = 0.0;
for (auto i = lru.begin(); i < lru.end(); i++)
fdcache_mb += i->fd_size_mb;
for (auto j = prefetch.begin(); j < prefetch.end(); j++)
prefetch_mb += j->fd_size_mb;
set_metric("fdcache_bytes", fdcache_mb*1024.0*1024.0);
set_metric("fdcache_count", lru.size());
set_metric("fdcache_prefetch_bytes", prefetch_mb*1024.0*1024.0);
set_metric("fdcache_prefetch_count", prefetch.size());
}
void intern(const string& a, const string& b, string fd, off_t sz, bool front_p)
{
{
unique_lock<mutex> lock(fdcache_lock);
// nuke preexisting copy
for (auto i = lru.begin(); i < lru.end(); i++)
{
if (i->archive == a && i->entry == b)
{
unlink (i->fd.c_str());
lru.erase(i);
inc_metric("fdcache_op_count","op","dequeue");
break; // must not continue iterating
}
}
// nuke preexisting copy in prefetch
for (auto i = prefetch.begin(); i < prefetch.end(); i++)
{
if (i->archive == a && i->entry == b)
{
unlink (i->fd.c_str());
prefetch.erase(i);
inc_metric("fdcache_op_count","op","prefetch_dequeue");
break; // must not continue iterating
}
}
double mb = (sz+65535)/1048576.0; // round up to 64K block
fdcache_entry n = { a, b, fd, mb };
if (front_p)
{
inc_metric("fdcache_op_count","op","enqueue");
lru.push_front(n);
}
else
{
inc_metric("fdcache_op_count","op","prefetch_enqueue");
prefetch.push_front(n);
}
if (verbose > 3)
obatched(clog) << "fdcache interned a=" << a << " b=" << b
<< " fd=" << fd << " mb=" << mb << " front=" << front_p << endl;
set_metrics();
}
// NB: we age the cache at lookup time too
if (statfs_free_enough_p(tmpdir, "tmpdir", fdcache_mintmp))
{
inc_metric("fdcache_op_count","op","emerg-flush");
obatched(clog) << "fdcache emergency flush for filling tmpdir" << endl;
this->limit(0, 0, 0, 0); // emergency flush
}
else if (front_p)
this->limit(max_fds, max_mbs, max_prefetch_fds, max_prefetch_mbs); // age cache if required
}
int lookup(const string& a, const string& b)
{
int fd = -1;
{
unique_lock<mutex> lock(fdcache_lock);
for (auto i = lru.begin(); i < lru.end(); i++)
{
if (i->archive == a && i->entry == b)
{ // found it; move it to head of lru
fdcache_entry n = *i;
lru.erase(i); // invalidates i, so no more iteration!
lru.push_front(n);
inc_metric("fdcache_op_count","op","requeue_front");
fd = open(n.fd.c_str(), O_RDONLY);
break;
}
}
// Iterate through prefetch while fd == -1 to ensure that no duplication between lru and
// prefetch occurs.
for ( auto i = prefetch.begin(); fd == -1 && i < prefetch.end(); ++i)
{
if (i->archive == a && i->entry == b)
{ // found it; take the entry from the prefetch deque to the lru deque, since it has now been accessed.
fdcache_entry n = *i;
prefetch.erase(i);
lru.push_front(n);
inc_metric("fdcache_op_count","op","prefetch_access");
fd = open(n.fd.c_str(), O_RDONLY);
break;
}
}
}
if (statfs_free_enough_p(tmpdir, "tmpdir", fdcache_mintmp))
{
inc_metric("fdcache_op_count","op","emerg-flush");
obatched(clog) << "fdcache emergency flush for filling tmpdir" << endl;
this->limit(0, 0, 0, 0); // emergency flush
}
else if (fd >= 0)
this->limit(max_fds, max_mbs, max_prefetch_fds, max_prefetch_mbs); // age cache if required
return fd;
}
int probe(const string& a, const string& b) // just a cache residency check - don't modify LRU state, don't open
{
unique_lock<mutex> lock(fdcache_lock);
for (auto i = lru.begin(); i < lru.end(); i++)
{
if (i->archive == a && i->entry == b)
{
inc_metric("fdcache_op_count","op","probe_hit");
return true;
}
}
for (auto i = prefetch.begin(); i < prefetch.end(); i++)
{
if (i->archive == a && i->entry == b)
{
inc_metric("fdcache_op_count","op","prefetch_probe_hit");
return true;
}
}
inc_metric("fdcache_op_count","op","probe_miss");
return false;
}
void clear(const string& a, const string& b)
{
unique_lock<mutex> lock(fdcache_lock);
for (auto i = lru.begin(); i < lru.end(); i++)
{
if (i->archive == a && i->entry == b)
{ // found it; erase it from lru
fdcache_entry n = *i;
lru.erase(i); // invalidates i, so no more iteration!
inc_metric("fdcache_op_count","op","clear");
unlink (n.fd.c_str());
set_metrics();
return;
}
}
for (auto i = prefetch.begin(); i < prefetch.end(); i++)
{
if (i->archive == a && i->entry == b)
{ // found it; erase it from lru
fdcache_entry n = *i;
prefetch.erase(i); // invalidates i, so no more iteration!
inc_metric("fdcache_op_count","op","prefetch_clear");
unlink (n.fd.c_str());
set_metrics();
return;
}
}
}
void limit(long maxfds, long maxmbs, long maxprefetchfds, long maxprefetchmbs , bool metrics_p = true)
{
if (verbose > 3 && (this->max_fds != maxfds || this->max_mbs != maxmbs))
obatched(clog) << "fdcache limited to maxfds=" << maxfds << " maxmbs=" << maxmbs << endl;
unique_lock<mutex> lock(fdcache_lock);
this->max_fds = maxfds;
this->max_mbs = maxmbs;
this->max_prefetch_fds = maxprefetchfds;
this->max_prefetch_mbs = maxprefetchmbs;
long total_fd = 0;
double total_mb = 0.0;
for (auto i = lru.begin(); i < lru.end(); i++)
{
// accumulate totals from most recently used one going backward
total_fd ++;
total_mb += i->fd_size_mb;
if (total_fd > this->max_fds || total_mb > this->max_mbs)
{
// found the cut here point!
for (auto j = i; j < lru.end(); j++) // close all the fds from here on in
{
if (verbose > 3)
obatched(clog) << "fdcache evicted a=" << j->archive << " b=" << j->entry
<< " fd=" << j->fd << " mb=" << j->fd_size_mb << endl;
if (metrics_p)
inc_metric("fdcache_op_count","op","evict");
unlink (j->fd.c_str());
}
lru.erase(i, lru.end()); // erase the nodes generally
break;
}
}
total_fd = 0;
total_mb = 0.0;
for(auto i = prefetch.begin(); i < prefetch.end(); i++){
// accumulate totals from most recently used one going backward
total_fd ++;
total_mb += i->fd_size_mb;
if (total_fd > this->max_prefetch_fds || total_mb > this->max_prefetch_mbs)
{
// found the cut here point!
for (auto j = i; j < prefetch.end(); j++) // close all the fds from here on in
{
if (verbose > 3)
obatched(clog) << "fdcache evicted from prefetch a=" << j->archive << " b=" << j->entry
<< " fd=" << j->fd << " mb=" << j->fd_size_mb << endl;
if (metrics_p)
inc_metric("fdcache_op_count","op","prefetch_evict");
unlink (j->fd.c_str());
}
prefetch.erase(i, prefetch.end()); // erase the nodes generally
break;
}
}
if (metrics_p) set_metrics();
}
~libarchive_fdcache()
{
// unlink any fdcache entries in $TMPDIR
// don't update metrics; those globals may be already destroyed
limit(0, 0, 0, 0, false);
}
};
static libarchive_fdcache fdcache;
/* Search ELF_FD for an ELF/DWARF section with name SECTION.
If found copy the section to a temporary file and return
its file descriptor, otherwise return -1.
The temporary file's mtime will be set to PARENT_MTIME.
B_SOURCE should be a description of the parent file suitable
for printing to the log. */
static int
extract_section (int elf_fd, int64_t parent_mtime,
const string& b_source, const string& section)
{
/* Search the fdcache. */
struct stat fs;
int fd = fdcache.lookup (b_source, section);
if (fd >= 0)
{
if (fstat (fd, &fs) != 0)
{
if (verbose)
obatched (clog) << "cannot fstate fdcache "
<< b_source << " " << section << endl;
close (fd);
return -1;
}
if ((int64_t) fs.st_mtime != parent_mtime)
{
if (verbose)
obatched(clog) << "mtime mismatch for "
<< b_source << " " << section << endl;
close (fd);
return -1;
}
/* Success. */
return fd;
}
Elf *elf = elf_begin (elf_fd, ELF_C_READ_MMAP_PRIVATE, NULL);
if (elf == NULL)
return -1;
/* Try to find the section and copy the contents into a separate file. */
try
{
size_t shstrndx;
int rc = elf_getshdrstrndx (elf, &shstrndx);
if (rc < 0)
throw elfutils_exception (rc, "getshdrstrndx");
Elf_Scn *scn = NULL;
while (true)
{
scn = elf_nextscn (elf, scn);
if (scn == NULL)
break;
GElf_Shdr shdr_storage;
GElf_Shdr *shdr = gelf_getshdr (scn, &shdr_storage);
if (shdr == NULL)
break;
const char *scn_name = elf_strptr (elf, shstrndx, shdr->sh_name);
if (scn_name == NULL)
break;
if (scn_name == section)
{
Elf_Data *data = NULL;
/* We found the desired section. */
data = elf_rawdata (scn, NULL);
if (data == NULL)
throw elfutils_exception (elf_errno (), "elfraw_data");
if (data->d_buf == NULL)
{
obatched(clog) << "section " << section
<< " is empty" << endl;
break;
}
/* Create temporary file containing the section. */
char *tmppath = NULL;
rc = asprintf (&tmppath, "%s/debuginfod.XXXXXX", tmpdir.c_str());
if (rc < 0)
throw libc_exception (ENOMEM, "cannot allocate tmppath");
defer_dtor<void*,void> tmmpath_freer (tmppath, free);
fd = mkstemp (tmppath);
if (fd < 0)
throw libc_exception (errno, "cannot create temporary file");
ssize_t res = write_retry (fd, data->d_buf, data->d_size);
if (res < 0 || (size_t) res != data->d_size)
throw libc_exception (errno, "cannot write to temporary file");
/* Set mtime to be the same as the parent file's mtime. */
struct timeval tvs[2];
if (fstat (elf_fd, &fs) != 0)
throw libc_exception (errno, "cannot fstat file");
tvs[0].tv_sec = tvs[1].tv_sec = fs.st_mtime;
tvs[0].tv_usec = tvs[1].tv_usec = 0;
(void) futimes (fd, tvs);
/* Add to fdcache. */
fdcache.intern (b_source, section, tmppath, data->d_size, true);
break;
}
}
}
catch (const reportable_exception &e)
{
e.report (clog);
close (fd);
fd = -1;
}
elf_end (elf);
return fd;
}
static struct MHD_Response*
handle_buildid_f_match (bool internal_req_t,
int64_t b_mtime,
const string& b_source0,
const string& section,
int *result_fd)
{
(void) internal_req_t; // ignored
int fd = open(b_source0.c_str(), O_RDONLY);
if (fd < 0)
throw libc_exception (errno, string("open ") + b_source0);
// NB: use manual close(2) in error case instead of defer_dtor, because
// in the normal case, we want to hand the fd over to libmicrohttpd for
// file transfer.
struct stat s;
int rc = fstat(fd, &s);
if (rc < 0)
{
close(fd);
throw libc_exception (errno, string("fstat ") + b_source0);
}
if ((int64_t) s.st_mtime != b_mtime)
{
if (verbose)
obatched(clog) << "mtime mismatch for " << b_source0 << endl;
close(fd);
return 0;
}
if (!section.empty ())
{
int scn_fd = extract_section (fd, s.st_mtime, b_source0, section);
close (fd);
if (scn_fd >= 0)
fd = scn_fd;
else
{
if (verbose)
obatched (clog) << "cannot find section " << section
<< " for " << b_source0 << endl;
return 0;
}
rc = fstat(fd, &s);
if (rc < 0)
{
close (fd);
throw libc_exception (errno, string ("fstat ") + b_source0
+ string (" ") + section);
}
}
struct MHD_Response* r = MHD_create_response_from_fd ((uint64_t) s.st_size, fd);
inc_metric ("http_responses_total","result","file");
if (r == 0)
{
if (verbose)
obatched(clog) << "cannot create fd-response for " << b_source0
<< " section=" << section << endl;
close(fd);
}
else
{
std::string file = b_source0.substr(b_source0.find_last_of("/")+1, b_source0.length());
add_mhd_response_header (r, "Content-Type", "application/octet-stream");
add_mhd_response_header (r, "X-DEBUGINFOD-SIZE",
to_string(s.st_size).c_str());
add_mhd_response_header (r, "X-DEBUGINFOD-FILE", file.c_str());
add_mhd_last_modified (r, s.st_mtime);
if (verbose > 1)
obatched(clog) << "serving file " << b_source0 << " section=" << section << endl;
/* libmicrohttpd will close it. */
if (result_fd)
*result_fd = fd;
}
return r;
}
// For security/portability reasons, many distro-package archives have
// a "./" in front of path names; others have nothing, others have
// "/". Canonicalize them all to a single leading "/", with the
// assumption that this matches the dwarf-derived file names too.
string canonicalized_archive_entry_pathname(struct archive_entry *e)
{
string fn = archive_entry_pathname(e);
if (fn.size() == 0)
return fn;
if (fn[0] == '/')
return fn;
if (fn[0] == '.')
return fn.substr(1);
else
return string("/")+fn;
}
static struct MHD_Response*
handle_buildid_r_match (bool internal_req_p,
int64_t b_mtime,
const string& b_source0,
const string& b_source1,
const string& section,
int *result_fd)
{
struct stat fs;
int rc = stat (b_source0.c_str(), &fs);
if (rc != 0)
throw libc_exception (errno, string("stat ") + b_source0);
if ((int64_t) fs.st_mtime != b_mtime)
{
if (verbose)
obatched(clog) << "mtime mismatch for " << b_source0 << endl;
return 0;
}
// check for a match in the fdcache first
int fd = fdcache.lookup(b_source0, b_source1);
while (fd >= 0) // got one!; NB: this is really an if() with a possible branch out to the end
{
rc = fstat(fd, &fs);
if (rc < 0) // disappeared?
{
if (verbose)
obatched(clog) << "cannot fstat fdcache " << b_source0 << endl;
close(fd);
fdcache.clear(b_source0, b_source1);
break; // branch out of if "loop", to try new libarchive fetch attempt
}
if (!section.empty ())
{
int scn_fd = extract_section (fd, fs.st_mtime,
b_source0 + ":" + b_source1,
section);
close (fd);
if (scn_fd >= 0)
fd = scn_fd;
else
{
if (verbose)
obatched (clog) << "cannot find section " << section
<< " for archive " << b_source0
<< " file " << b_source1 << endl;
return 0;
}
rc = fstat(fd, &fs);
if (rc < 0)
{
close (fd);
throw libc_exception (errno,
string ("fstat archive ") + b_source0 + string (" file ") + b_source1
+ string (" section ") + section);
}
}
struct MHD_Response* r = MHD_create_response_from_fd (fs.st_size, fd);
if (r == 0)
{
if (verbose)
obatched(clog) << "cannot create fd-response for " << b_source0 << endl;
close(fd);
break; // branch out of if "loop", to try new libarchive fetch attempt
}
inc_metric ("http_responses_total","result","archive fdcache");
add_mhd_response_header (r, "Content-Type", "application/octet-stream");
add_mhd_response_header (r, "X-DEBUGINFOD-SIZE",
to_string(fs.st_size).c_str());
add_mhd_response_header (r, "X-DEBUGINFOD-ARCHIVE", b_source0.c_str());
add_mhd_response_header (r, "X-DEBUGINFOD-FILE", b_source1.c_str());
add_mhd_last_modified (r, fs.st_mtime);
if (verbose > 1)
obatched(clog) << "serving fdcache archive " << b_source0
<< " file " << b_source1
<< " section=" << section << endl;
/* libmicrohttpd will close it. */
if (result_fd)
*result_fd = fd;
return r;
// NB: see, we never go around the 'loop' more than once
}
// no match ... grumble, must process the archive
string archive_decoder = "/dev/null";
string archive_extension = "";
for (auto&& arch : scan_archives)
if (string_endswith(b_source0, arch.first))
{
archive_extension = arch.first;
archive_decoder = arch.second;
}
FILE* fp;
defer_dtor<FILE*,int>::dtor_fn dfn;
if (archive_decoder != "cat")
{
string popen_cmd = archive_decoder + " " + shell_escape(b_source0);
fp = popen (popen_cmd.c_str(), "r"); // "e" O_CLOEXEC?
dfn = pclose;
if (fp == NULL)
throw libc_exception (errno, string("popen ") + popen_cmd);
}
else
{
fp = fopen (b_source0.c_str(), "r");
dfn = fclose;
if (fp == NULL)
throw libc_exception (errno, string("fopen ") + b_source0);
}
defer_dtor<FILE*,int> fp_closer (fp, dfn);
struct archive *a;
a = archive_read_new();
if (a == NULL)
throw archive_exception("cannot create archive reader");
defer_dtor<struct archive*,int> archive_closer (a, archive_read_free);
rc = archive_read_support_format_all(a);
if (rc != ARCHIVE_OK)
throw archive_exception(a, "cannot select all format");
rc = archive_read_support_filter_all(a);
if (rc != ARCHIVE_OK)
throw archive_exception(a, "cannot select all filters");
rc = archive_read_open_FILE (a, fp);
if (rc != ARCHIVE_OK)
{
obatched(clog) << "cannot open archive from pipe " << b_source0 << endl;
throw archive_exception(a, "cannot open archive from pipe");
}
// archive traversal is in three stages, no, four stages:
// 1) skip entries whose names do not match the requested one
// 2) extract the matching entry name (set r = result)
// 3) extract some number of prefetched entries (just into fdcache)
// 4) abort any further processing
struct MHD_Response* r = 0; // will set in stage 2
unsigned prefetch_count =
internal_req_p ? 0 : fdcache_prefetch; // will decrement in stage 3
while(r == 0 || prefetch_count > 0) // stage 1, 2, or 3
{
if (interrupted)
break;
struct archive_entry *e;
rc = archive_read_next_header (a, &e);
if (rc != ARCHIVE_OK)
break;
if (! S_ISREG(archive_entry_mode (e))) // skip non-files completely
continue;
string fn = canonicalized_archive_entry_pathname (e);
if ((r == 0) && (fn != b_source1)) // stage 1
continue;
if (fdcache.probe (b_source0, fn) && // skip if already interned
fn != b_source1) // but only if we'd just be prefetching, PR29474
continue;
// extract this file to a temporary file
char* tmppath = NULL;
rc = asprintf (&tmppath, "%s/debuginfod.XXXXXX", tmpdir.c_str());
if (rc < 0)
throw libc_exception (ENOMEM, "cannot allocate tmppath");
defer_dtor<void*,void> tmmpath_freer (tmppath, free);
fd = mkstemp (tmppath);
if (fd < 0)
throw libc_exception (errno, "cannot create temporary file");
// NB: don't unlink (tmppath), as fdcache will take charge of it.
// NB: this can take many uninterruptible seconds for a huge file
rc = archive_read_data_into_fd (a, fd);
if (rc != ARCHIVE_OK) // e.g. ENOSPC!
{
close (fd);
unlink (tmppath);
throw archive_exception(a, "cannot extract file");
}
// Set the mtime so the fdcache file mtimes, even prefetched ones,
// propagate to future webapi clients.
struct timeval tvs[2];
tvs[0].tv_sec = tvs[1].tv_sec = archive_entry_mtime(e);
tvs[0].tv_usec = tvs[1].tv_usec = 0;
(void) futimes (fd, tvs); /* best effort */
if (r != 0) // stage 3
{
// NB: now we know we have a complete reusable file; make fdcache
// responsible for unlinking it later.
fdcache.intern(b_source0, fn,
tmppath, archive_entry_size(e),
false); // prefetched ones go to the prefetch cache
prefetch_count --;
close (fd); // we're not saving this fd to make a mhd-response from!
continue;
}
// NB: now we know we have a complete reusable file; make fdcache
// responsible for unlinking it later.
fdcache.intern(b_source0, b_source1,
tmppath, archive_entry_size(e),
true); // requested ones go to the front of lru
if (!section.empty ())
{
int scn_fd = extract_section (fd, b_mtime,
b_source0 + ":" + b_source1,
section);
close (fd);
if (scn_fd >= 0)
fd = scn_fd;
else
{
if (verbose)
obatched (clog) << "cannot find section " << section
<< " for archive " << b_source0
<< " file " << b_source1 << endl;
return 0;
}
rc = fstat(fd, &fs);
if (rc < 0)
{
close (fd);
throw libc_exception (errno,
string ("fstat ") + b_source0 + string (" ") + section);
}
r = MHD_create_response_from_fd (fs.st_size, fd);
}
else
r = MHD_create_response_from_fd (archive_entry_size(e), fd);
inc_metric ("http_responses_total","result",archive_extension + " archive");
if (r == 0)
{
if (verbose)
obatched(clog) << "cannot create fd-response for " << b_source0 << endl;
close(fd);
break; // assume no chance of better luck around another iteration; no other copies of same file
}
else
{
std::string file = b_source1.substr(b_source1.find_last_of("/")+1, b_source1.length());
add_mhd_response_header (r, "Content-Type",
"application/octet-stream");
add_mhd_response_header (r, "X-DEBUGINFOD-SIZE",
to_string(archive_entry_size(e)).c_str());
add_mhd_response_header (r, "X-DEBUGINFOD-ARCHIVE",
b_source0.c_str());
add_mhd_response_header (r, "X-DEBUGINFOD-FILE", file.c_str());
add_mhd_last_modified (r, archive_entry_mtime(e));
if (verbose > 1)
obatched(clog) << "serving archive " << b_source0
<< " file " << b_source1
<< " section=" << section << endl;
/* libmicrohttpd will close it. */
if (result_fd)
*result_fd = fd;
continue;
}
}
// XXX: rpm/file not found: delete this R entry?
return r;
}
static struct MHD_Response*
handle_buildid_match (bool internal_req_p,
int64_t b_mtime,
const string& b_stype,
const string& b_source0,
const string& b_source1,
const string& section,
int *result_fd)
{
try
{
if (b_stype == "F")
return handle_buildid_f_match(internal_req_p, b_mtime, b_source0,
section, result_fd);
else if (b_stype == "R")
return handle_buildid_r_match(internal_req_p, b_mtime, b_source0,
b_source1, section, result_fd);
}
catch (const reportable_exception &e)
{
e.report(clog);
// Report but swallow libc etc. errors here; let the caller
// iterate to other matches of the content.
}
return 0;
}
static int
debuginfod_find_progress (debuginfod_client *, long a, long b)
{
if (verbose > 4)
obatched(clog) << "federated debuginfod progress=" << a << "/" << b << endl;
return interrupted;
}
// a little lru pool of debuginfod_client*s for reuse between query threads
mutex dc_pool_lock;
deque<debuginfod_client*> dc_pool;
debuginfod_client* debuginfod_pool_begin()
{
unique_lock<mutex> lock(dc_pool_lock);
if (dc_pool.size() > 0)
{
inc_metric("dc_pool_op_count","op","begin-reuse");
debuginfod_client *c = dc_pool.front();
dc_pool.pop_front();
return c;
}
inc_metric("dc_pool_op_count","op","begin-new");
return debuginfod_begin();
}
void debuginfod_pool_groom()
{
unique_lock<mutex> lock(dc_pool_lock);
while (dc_pool.size() > 0)
{
inc_metric("dc_pool_op_count","op","end");
debuginfod_end(dc_pool.front());
dc_pool.pop_front();
}
}
void debuginfod_pool_end(debuginfod_client* c)
{
unique_lock<mutex> lock(dc_pool_lock);
inc_metric("dc_pool_op_count","op","end-save");
dc_pool.push_front(c); // accelerate reuse, vs. push_back
}
static struct MHD_Response*
handle_buildid (MHD_Connection* conn,
const string& buildid /* unsafe */,
string& artifacttype /* unsafe, cleanse on exception/return */,
const string& suffix /* unsafe */,
int *result_fd)
{
// validate artifacttype
string atype_code;
if (artifacttype == "debuginfo") atype_code = "D";
else if (artifacttype == "executable") atype_code = "E";
else if (artifacttype == "source") atype_code = "S";
else if (artifacttype == "section") atype_code = "I";
else {
artifacttype = "invalid"; // PR28242 ensure http_resposes metrics don't propagate unclean user data
throw reportable_exception("invalid artifacttype");
}
if (conn != 0)
inc_metric("http_requests_total", "type", artifacttype);
string section;
if (atype_code == "I")
{
if (suffix.size () < 2)
throw reportable_exception ("invalid section suffix");
// Remove leading '/'
section = suffix.substr(1);
}
if (atype_code == "S" && suffix == "")
throw reportable_exception("invalid source suffix");
// validate buildid
if ((buildid.size() < 2) || // not empty
(buildid.size() % 2) || // even number
(buildid.find_first_not_of("0123456789abcdef") != string::npos)) // pure tasty lowercase hex
throw reportable_exception("invalid buildid");
if (verbose > 1)
obatched(clog) << "searching for buildid=" << buildid << " artifacttype=" << artifacttype
<< " suffix=" << suffix << endl;
// If invoked from the scanner threads, use the scanners' read-write
// connection. Otherwise use the web query threads' read-only connection.
sqlite3 *thisdb = (conn == 0) ? db : dbq;
sqlite_ps *pp = 0;
if (atype_code == "D")
{
pp = new sqlite_ps (thisdb, "mhd-query-d",
"select mtime, sourcetype, source0, source1 from " BUILDIDS "_query_d where buildid = ? "
"order by mtime desc");
pp->reset();
pp->bind(1, buildid);
}
else if (atype_code == "E")
{
pp = new sqlite_ps (thisdb, "mhd-query-e",
"select mtime, sourcetype, source0, source1 from " BUILDIDS "_query_e where buildid = ? "
"order by mtime desc");
pp->reset();
pp->bind(1, buildid);
}
else if (atype_code == "S")
{
// PR25548
// Incoming source queries may come in with either dwarf-level OR canonicalized paths.
// We let the query pass with either one.
pp = new sqlite_ps (thisdb, "mhd-query-s",
"select mtime, sourcetype, source0, source1 from " BUILDIDS "_query_s where buildid = ? and artifactsrc in (?,?) "
"order by sharedprefix(source0,source0ref) desc, mtime desc");
pp->reset();
pp->bind(1, buildid);
// NB: we don't store the non-canonicalized path names any more, but old databases
// might have them (and no canon ones), so we keep searching for both.
pp->bind(2, suffix);
pp->bind(3, canon_pathname(suffix));
}
else if (atype_code == "I")
{
pp = new sqlite_ps (thisdb, "mhd-query-i",
"select mtime, sourcetype, source0, source1, 1 as debug_p from " BUILDIDS "_query_d where buildid = ? "
"union all "
"select mtime, sourcetype, source0, source1, 0 as debug_p from " BUILDIDS "_query_e where buildid = ? "
"order by debug_p desc, mtime desc");
pp->reset();
pp->bind(1, buildid);
pp->bind(2, buildid);
}
unique_ptr<sqlite_ps> ps_closer(pp); // release pp if exception or return
bool do_upstream_section_query = true;
// consume all the rows
while (1)
{
int rc = pp->step();
if (rc == SQLITE_DONE) break;
if (rc != SQLITE_ROW)
throw sqlite_exception(rc, "step");
int64_t b_mtime = sqlite3_column_int64 (*pp, 0);
string b_stype = string((const char*) sqlite3_column_text (*pp, 1) ?: ""); /* by DDL may not be NULL */
string b_source0 = string((const char*) sqlite3_column_text (*pp, 2) ?: ""); /* may be NULL */
string b_source1 = string((const char*) sqlite3_column_text (*pp, 3) ?: ""); /* may be NULL */
if (verbose > 1)
obatched(clog) << "found mtime=" << b_mtime << " stype=" << b_stype
<< " source0=" << b_source0 << " source1=" << b_source1 << endl;
// Try accessing the located match.
// XXX: in case of multiple matches, attempt them in parallel?
auto r = handle_buildid_match (conn ? false : true,
b_mtime, b_stype, b_source0, b_source1,
section, result_fd);
if (r)
return r;
// If a debuginfo file matching BUILDID was found but didn't contain
// the desired section, then the section should not exist. Don't
// bother querying upstream servers.
if (!section.empty () && (sqlite3_column_int (*pp, 4) == 1))
{
struct stat st;
// For "F" sourcetype, check if the debuginfo exists. For "R"
// sourcetype, check if the debuginfo was interned into the fdcache.
if ((b_stype == "F" && (stat (b_source0.c_str (), &st) == 0))
|| (b_stype == "R" && fdcache.probe (b_source0, b_source1)))
do_upstream_section_query = false;
}
}
pp->reset();
if (!do_upstream_section_query)
throw reportable_exception(MHD_HTTP_NOT_FOUND, "not found");
// We couldn't find it in the database. Last ditch effort
// is to defer to other debuginfo servers.
int fd = -1;
debuginfod_client *client = debuginfod_pool_begin ();
if (client == NULL)
throw libc_exception(errno, "debuginfod client pool alloc");
defer_dtor<debuginfod_client*,void> client_closer (client, debuginfod_pool_end);
debuginfod_set_progressfn (client, & debuginfod_find_progress);
if (conn)
{
// Transcribe incoming User-Agent:
string ua = MHD_lookup_connection_value (conn, MHD_HEADER_KIND, "User-Agent") ?: "";
string ua_complete = string("User-Agent: ") + ua;
debuginfod_add_http_header (client, ua_complete.c_str());
// Compute larger XFF:, for avoiding info loss during
// federation, and for future cyclicity detection.
string xff = MHD_lookup_connection_value (conn, MHD_HEADER_KIND, "X-Forwarded-For") ?: "";
if (xff != "")
xff += string(", "); // comma separated list
unsigned int xff_count = 0;
for (auto&& i : xff){
if (i == ',') xff_count++;
}
// if X-Forwarded-For: exceeds N hops,
// do not delegate a local lookup miss to upstream debuginfods.
if (xff_count >= forwarded_ttl_limit)
throw reportable_exception(MHD_HTTP_NOT_FOUND, "not found, --forwared-ttl-limit reached \
and will not query the upstream servers");
// Compute the client's numeric IP address only - so can't merge with conninfo()
const union MHD_ConnectionInfo *u = MHD_get_connection_info (conn,
MHD_CONNECTION_INFO_CLIENT_ADDRESS);
struct sockaddr *so = u ? u->client_addr : 0;
char hostname[256] = ""; // RFC1035
if (so && so->sa_family == AF_INET) {
(void) getnameinfo (so, sizeof (struct sockaddr_in), hostname, sizeof (hostname), NULL, 0,
NI_NUMERICHOST);
} else if (so && so->sa_family == AF_INET6) {
struct sockaddr_in6* addr6 = (struct sockaddr_in6*) so;
if (IN6_IS_ADDR_V4MAPPED(&addr6->sin6_addr)) {
struct sockaddr_in addr4;
memset (&addr4, 0, sizeof(addr4));
addr4.sin_family = AF_INET;
addr4.sin_port = addr6->sin6_port;
memcpy (&addr4.sin_addr.s_addr, addr6->sin6_addr.s6_addr+12, sizeof(addr4.sin_addr.s_addr));
(void) getnameinfo ((struct sockaddr*) &addr4, sizeof (addr4),
hostname, sizeof (hostname), NULL, 0,
NI_NUMERICHOST);
} else {
(void) getnameinfo (so, sizeof (struct sockaddr_in6), hostname, sizeof (hostname), NULL, 0,
NI_NUMERICHOST);
}
}
string xff_complete = string("X-Forwarded-For: ")+xff+string(hostname);
debuginfod_add_http_header (client, xff_complete.c_str());
}
if (artifacttype == "debuginfo")
fd = debuginfod_find_debuginfo (client,
(const unsigned char*) buildid.c_str(),
0, NULL);
else if (artifacttype == "executable")
fd = debuginfod_find_executable (client,
(const unsigned char*) buildid.c_str(),
0, NULL);
else if (artifacttype == "source")
fd = debuginfod_find_source (client,
(const unsigned char*) buildid.c_str(),
0, suffix.c_str(), NULL);
else if (artifacttype == "section")
fd = debuginfod_find_section (client,
(const unsigned char*) buildid.c_str(),
0, section.c_str(), NULL);
if (fd >= 0)
{
if (conn != 0)
inc_metric ("http_responses_total","result","upstream");
struct stat s;
int rc = fstat (fd, &s);
if (rc == 0)
{
auto r = MHD_create_response_from_fd ((uint64_t) s.st_size, fd);
if (r)
{
add_mhd_response_header (r, "Content-Type",
"application/octet-stream");
// Copy the incoming headers
const char * hdrs = debuginfod_get_headers(client);
string header_dup;
if (hdrs)
header_dup = string(hdrs);
// Parse the "header: value\n" lines into (h,v) tuples and pass on
while(1)
{
size_t newline = header_dup.find('\n');
if (newline == string::npos) break;
size_t colon = header_dup.find(':');
if (colon == string::npos) break;
string header = header_dup.substr(0,colon);
string value = header_dup.substr(colon+1,newline-colon-1);
// strip leading spaces from value
size_t nonspace = value.find_first_not_of(" ");
if (nonspace != string::npos)
value = value.substr(nonspace);
add_mhd_response_header(r, header.c_str(), value.c_str());
header_dup = header_dup.substr(newline+1);
}
add_mhd_last_modified (r, s.st_mtime);
if (verbose > 1)
obatched(clog) << "serving file from upstream debuginfod/cache" << endl;
if (result_fd)
*result_fd = fd;
return r; // NB: don't close fd; libmicrohttpd will
}
}
close (fd);
}
else
switch(fd)
{
case -ENOSYS:
break;
case -ENOENT:
break;
default: // some more tricky error
throw libc_exception(-fd, "upstream debuginfod query failed");
}
throw reportable_exception(MHD_HTTP_NOT_FOUND, "not found");
}
////////////////////////////////////////////////////////////////////////
static map<string,double> metrics; // arbitrary data for /metrics query
// NB: store int64_t since all our metrics are integers; prometheus accepts double
static mutex metrics_lock;
// NB: these objects get released during the process exit via global dtors
// do not call them from within other global dtors
// utility function for assembling prometheus-compatible
// name="escaped-value" strings
// https://prometheus.io/docs/instrumenting/exposition_formats/
static string
metric_label(const string& name, const string& value)
{
string x = name + "=\"";
for (auto&& c : value)
switch(c)
{
case '\\': x += "\\\\"; break;
case '\"': x += "\\\""; break;
case '\n': x += "\\n"; break;
default: x += c; break;
}
x += "\"";
return x;
}
// add prometheus-format metric name + label tuple (if any) + value
static void
set_metric(const string& metric, double value)
{
unique_lock<mutex> lock(metrics_lock);
metrics[metric] = value;
}
#if 0 /* unused */
static void
inc_metric(const string& metric)
{
unique_lock<mutex> lock(metrics_lock);
metrics[metric] ++;
}
#endif
static void
set_metric(const string& metric,
const string& lname, const string& lvalue,
double value)
{
string key = (metric + "{" + metric_label(lname, lvalue) + "}");
unique_lock<mutex> lock(metrics_lock);
metrics[key] = value;
}
static void
inc_metric(const string& metric,
const string& lname, const string& lvalue)
{
string key = (metric + "{" + metric_label(lname, lvalue) + "}");
unique_lock<mutex> lock(metrics_lock);
metrics[key] ++;
}
static void
add_metric(const string& metric,
const string& lname, const string& lvalue,
double value)
{
string key = (metric + "{" + metric_label(lname, lvalue) + "}");
unique_lock<mutex> lock(metrics_lock);
metrics[key] += value;
}
#if 0
static void
add_metric(const string& metric,
double value)
{
unique_lock<mutex> lock(metrics_lock);
metrics[metric] += value;
}
#endif
// and more for higher arity labels if needed
static void
inc_metric(const string& metric,
const string& lname, const string& lvalue,
const string& rname, const string& rvalue)
{
string key = (metric + "{"
+ metric_label(lname, lvalue) + ","
+ metric_label(rname, rvalue) + "}");
unique_lock<mutex> lock(metrics_lock);
metrics[key] ++;
}
static void
add_metric(const string& metric,
const string& lname, const string& lvalue,
const string& rname, const string& rvalue,
double value)
{
string key = (metric + "{"
+ metric_label(lname, lvalue) + ","
+ metric_label(rname, rvalue) + "}");
unique_lock<mutex> lock(metrics_lock);
metrics[key] += value;
}
static struct MHD_Response*
handle_metrics (off_t* size)
{
stringstream o;
{
unique_lock<mutex> lock(metrics_lock);
for (auto&& i : metrics)
o << i.first
<< " "
<< std::setprecision(std::numeric_limits<double>::digits10 + 1)
<< i.second
<< endl;
}
const string& os = o.str();
MHD_Response* r = MHD_create_response_from_buffer (os.size(),
(void*) os.c_str(),
MHD_RESPMEM_MUST_COPY);
if (r != NULL)
{
*size = os.size();
add_mhd_response_header (r, "Content-Type", "text/plain");
}
return r;
}
static struct MHD_Response*
handle_root (off_t* size)
{
static string version = "debuginfod (" + string (PACKAGE_NAME) + ") "
+ string (PACKAGE_VERSION);
MHD_Response* r = MHD_create_response_from_buffer (version.size (),
(void *) version.c_str (),
MHD_RESPMEM_PERSISTENT);
if (r != NULL)
{
*size = version.size ();
add_mhd_response_header (r, "Content-Type", "text/plain");
}
return r;
}
////////////////////////////////////////////////////////////////////////
/* libmicrohttpd callback */
static MHD_RESULT
handler_cb (void * /*cls*/,
struct MHD_Connection *connection,
const char *url,
const char *method,
const char * /*version*/,
const char * /*upload_data*/,
size_t * /*upload_data_size*/,
void ** ptr)
{
struct MHD_Response *r = NULL;
string url_copy = url;
/* libmicrohttpd always makes (at least) two callbacks: once just
past the headers, and one after the request body is finished
being received. If we process things early (first callback) and
queue a response, libmicrohttpd would suppress http keep-alive
(via connection->read_closed = true). */
static int aptr; /* just some random object to use as a flag */
if (&aptr != *ptr)
{
/* do never respond on first call */
*ptr = &aptr;
return MHD_YES;
}
*ptr = NULL; /* reset when done */
const char *maxsize_string = MHD_lookup_connection_value(connection, MHD_HEADER_KIND, "X-DEBUGINFOD-MAXSIZE");
long maxsize = 0;
if (maxsize_string != NULL && maxsize_string[0] != '\0')
maxsize = atol(maxsize_string);
else
maxsize = 0;
#if MHD_VERSION >= 0x00097002
enum MHD_Result rc;
#else
int rc = MHD_NO; // mhd
#endif
int http_code = 500;
off_t http_size = -1;
struct timespec ts_start, ts_end;
clock_gettime (CLOCK_MONOTONIC, &ts_start);
double afteryou = 0.0;
string artifacttype, suffix;
try
{
if (string(method) != "GET")
throw reportable_exception(400, "we support GET only");
/* Start decoding the URL. */
size_t slash1 = url_copy.find('/', 1);
string url1 = url_copy.substr(0, slash1); // ok even if slash1 not found
if (slash1 != string::npos && url1 == "/buildid")
{
// PR27863: block this thread awhile if another thread is already busy
// fetching the exact same thing. This is better for Everyone.
// The latecomer says "... after you!" and waits.
add_metric ("thread_busy", "role", "http-buildid-after-you", 1);
#ifdef HAVE_PTHREAD_SETNAME_NP
(void) pthread_setname_np (pthread_self(), "mhd-buildid-after-you");
#endif
struct timespec tsay_start, tsay_end;
clock_gettime (CLOCK_MONOTONIC, &tsay_start);
static unique_set<string> busy_urls;
unique_set_reserver<string> after_you(busy_urls, url_copy);
clock_gettime (CLOCK_MONOTONIC, &tsay_end);
afteryou = (tsay_end.tv_sec - tsay_start.tv_sec) + (tsay_end.tv_nsec - tsay_start.tv_nsec)/1.e9;
add_metric ("thread_busy", "role", "http-buildid-after-you", -1);
tmp_inc_metric m ("thread_busy", "role", "http-buildid");
#ifdef HAVE_PTHREAD_SETNAME_NP
(void) pthread_setname_np (pthread_self(), "mhd-buildid");
#endif
size_t slash2 = url_copy.find('/', slash1+1);
if (slash2 == string::npos)
throw reportable_exception("/buildid/ webapi error, need buildid");
string buildid = url_copy.substr(slash1+1, slash2-slash1-1);
size_t slash3 = url_copy.find('/', slash2+1);
if (slash3 == string::npos)
{
artifacttype = url_copy.substr(slash2+1);
suffix = "";
}
else
{
artifacttype = url_copy.substr(slash2+1, slash3-slash2-1);
suffix = url_copy.substr(slash3); // include the slash in the suffix
}
// get the resulting fd so we can report its size
int fd;
r = handle_buildid(connection, buildid, artifacttype, suffix, &fd);
if (r)
{
struct stat fs;
if (fstat(fd, &fs) == 0)
http_size = fs.st_size;
// libmicrohttpd will close (fd);
}
}
else if (url1 == "/metrics")
{
tmp_inc_metric m ("thread_busy", "role", "http-metrics");
artifacttype = "metrics";
inc_metric("http_requests_total", "type", artifacttype);
r = handle_metrics(& http_size);
}
else if (url1 == "/")
{
artifacttype = "/";
inc_metric("http_requests_total", "type", artifacttype);
r = handle_root(& http_size);
}
else
throw reportable_exception("webapi error, unrecognized '" + url1 + "'");
if (r == 0)
throw reportable_exception("internal error, missing response");
if (maxsize > 0 && http_size > maxsize)
{
MHD_destroy_response(r);
throw reportable_exception(406, "File too large, max size=" + std::to_string(maxsize));
}
rc = MHD_queue_response (connection, MHD_HTTP_OK, r);
http_code = MHD_HTTP_OK;
MHD_destroy_response (r);
}
catch (const reportable_exception& e)
{
inc_metric("http_responses_total","result","error");
e.report(clog);
http_code = e.code;
http_size = e.message.size();
rc = e.mhd_send_response (connection);
}
clock_gettime (CLOCK_MONOTONIC, &ts_end);
double deltas = (ts_end.tv_sec - ts_start.tv_sec) + (ts_end.tv_nsec - ts_start.tv_nsec)/1.e9;
// afteryou: delay waiting for other client's identical query to complete
// deltas: total latency, including afteryou waiting
obatched(clog) << conninfo(connection)
<< ' ' << method << ' ' << url
<< ' ' << http_code << ' ' << http_size
<< ' ' << (int)(afteryou*1000) << '+' << (int)((deltas-afteryou)*1000) << "ms"
<< endl;
// related prometheus metrics
string http_code_str = to_string(http_code);
add_metric("http_responses_transfer_bytes_sum",
"code", http_code_str, "type", artifacttype, http_size);
inc_metric("http_responses_transfer_bytes_count",
"code", http_code_str, "type", artifacttype);
add_metric("http_responses_duration_milliseconds_sum",
"code", http_code_str, "type", artifacttype, deltas*1000); // prometheus prefers _seconds and floating point
inc_metric("http_responses_duration_milliseconds_count",
"code", http_code_str, "type", artifacttype);
add_metric("http_responses_after_you_milliseconds_sum",
"code", http_code_str, "type", artifacttype, afteryou*1000);
inc_metric("http_responses_after_you_milliseconds_count",
"code", http_code_str, "type", artifacttype);
return rc;
}
////////////////////////////////////////////////////////////////////////
// borrowed originally from src/nm.c get_local_names()
static void
dwarf_extract_source_paths (Elf *elf, set<string>& debug_sourcefiles)
noexcept // no exceptions - so we can simplify the altdbg resource release at end
{
Dwarf* dbg = dwarf_begin_elf (elf, DWARF_C_READ, NULL);
if (dbg == NULL)
return;
Dwarf* altdbg = NULL;
int altdbg_fd = -1;
// DWZ handling: if we have an unsatisfied debug-alt-link, add an
// empty string into the outgoing sourcefiles set, so the caller
// should know that our data is incomplete.
const char *alt_name_p;
const void *alt_build_id; // elfutils-owned memory
ssize_t sz = dwelf_dwarf_gnu_debugaltlink (dbg, &alt_name_p, &alt_build_id);
if (sz > 0) // got one!
{
string buildid;
unsigned char* build_id_bytes = (unsigned char*) alt_build_id;
for (ssize_t idx=0; idx<sz; idx++)
{
buildid += "0123456789abcdef"[build_id_bytes[idx] >> 4];
buildid += "0123456789abcdef"[build_id_bytes[idx] & 0xf];
}
if (verbose > 3)
obatched(clog) << "Need altdebug buildid=" << buildid << endl;
// but is it unsatisfied the normal elfutils ways?
Dwarf* alt = dwarf_getalt (dbg);
if (alt == NULL)
{
// Yup, unsatisfied the normal way. Maybe we can satisfy it
// from our own debuginfod database.
int alt_fd;
struct MHD_Response *r = 0;
try
{
string artifacttype = "debuginfo";
r = handle_buildid (0, buildid, artifacttype, "", &alt_fd);
}
catch (const reportable_exception& e)
{
// swallow exceptions
}
// NB: this is not actually recursive! This invokes the web-query
// path, which cannot get back into the scan code paths.
if (r)
{
// Found it!
altdbg_fd = dup(alt_fd); // ok if this fails, downstream failures ok
alt = altdbg = dwarf_begin (altdbg_fd, DWARF_C_READ);
// NB: must close this dwarf and this fd at the bottom of the function!
MHD_destroy_response (r); // will close alt_fd
if (alt)
dwarf_setalt (dbg, alt);
}
}
else
{
// NB: dwarf_setalt(alt) inappropriate - already done!
// NB: altdbg will stay 0 so nothing tries to redundantly dealloc.
}
if (alt)
{
if (verbose > 3)
obatched(clog) << "Resolved altdebug buildid=" << buildid << endl;
}
else // (alt == NULL) - signal possible presence of poor debuginfo
{
debug_sourcefiles.insert("");
if (verbose > 3)
obatched(clog) << "Unresolved altdebug buildid=" << buildid << endl;
}
}
Dwarf_Off offset = 0;
Dwarf_Off old_offset;
size_t hsize;
while (dwarf_nextcu (dbg, old_offset = offset, &offset, &hsize, NULL, NULL, NULL) == 0)
{
Dwarf_Die cudie_mem;
Dwarf_Die *cudie = dwarf_offdie (dbg, old_offset + hsize, &cudie_mem);
if (cudie == NULL)
continue;
if (dwarf_tag (cudie) != DW_TAG_compile_unit)
continue;
const char *cuname = dwarf_diename(cudie) ?: "unknown";
Dwarf_Files *files;
size_t nfiles;
if (dwarf_getsrcfiles (cudie, &files, &nfiles) != 0)
continue;
// extract DW_AT_comp_dir to resolve relative file names
const char *comp_dir = "";
const char *const *dirs;
size_t ndirs;
if (dwarf_getsrcdirs (files, &dirs, &ndirs) == 0 &&
dirs[0] != NULL)
comp_dir = dirs[0];
if (comp_dir == NULL)
comp_dir = "";
if (verbose > 3)
obatched(clog) << "searching for sources for cu=" << cuname << " comp_dir=" << comp_dir
<< " #files=" << nfiles << " #dirs=" << ndirs << endl;
if (comp_dir[0] == '\0' && cuname[0] != '/')
{
// This is a common symptom for dwz-compressed debug files,
// where the altdebug file cannot be resolved.
if (verbose > 3)
obatched(clog) << "skipping cu=" << cuname << " due to empty comp_dir" << endl;
continue;
}
for (size_t f = 1; f < nfiles; f++)
{
const char *hat = dwarf_filesrc (files, f, NULL, NULL);
if (hat == NULL)
continue;
if (string(hat) == "<built-in>") // gcc intrinsics, don't bother record
continue;
string waldo;
if (hat[0] == '/') // absolute
waldo = (string (hat));
else if (comp_dir[0] != '\0') // comp_dir relative
waldo = (string (comp_dir) + string("/") + string (hat));
else
{
if (verbose > 3)
obatched(clog) << "skipping hat=" << hat << " due to empty comp_dir" << endl;
continue;
}
// NB: this is the 'waldo' that a dbginfo client will have
// to supply for us to give them the file The comp_dir
// prefixing is a definite complication. Otherwise we'd
// have to return a setof comp_dirs (one per CU!) with
// corresponding filesrc[] names, instead of one absolute
// resoved set. Maybe we'll have to do that anyway. XXX
if (verbose > 4)
obatched(clog) << waldo
<< (debug_sourcefiles.find(waldo)==debug_sourcefiles.end() ? " new" : " dup") << endl;
debug_sourcefiles.insert (waldo);
}
}
dwarf_end(dbg);
if (altdbg)
dwarf_end(altdbg);
if (altdbg_fd >= 0)
close(altdbg_fd);
}
static void
elf_classify (int fd, bool &executable_p, bool &debuginfo_p, string &buildid, set<string>& debug_sourcefiles)
{
Elf *elf = elf_begin (fd, ELF_C_READ_MMAP_PRIVATE, NULL);
if (elf == NULL)
return;
try // catch our types of errors and clean up the Elf* object
{
if (elf_kind (elf) != ELF_K_ELF)
{
elf_end (elf);
return;
}
GElf_Ehdr ehdr_storage;
GElf_Ehdr *ehdr = gelf_getehdr (elf, &ehdr_storage);
if (ehdr == NULL)
{
elf_end (elf);
return;
}
auto elf_type = ehdr->e_type;
const void *build_id; // elfutils-owned memory
ssize_t sz = dwelf_elf_gnu_build_id (elf, & build_id);
if (sz <= 0)
{
// It's not a diagnostic-worthy error for an elf file to lack build-id.
// It might just be very old.
elf_end (elf);
return;
}
// build_id is a raw byte array; convert to hexadecimal *lowercase*
unsigned char* build_id_bytes = (unsigned char*) build_id;
for (ssize_t idx=0; idx<sz; idx++)
{
buildid += "0123456789abcdef"[build_id_bytes[idx] >> 4];
buildid += "0123456789abcdef"[build_id_bytes[idx] & 0xf];
}
// now decide whether it's an executable - namely, any allocatable section has
// PROGBITS;
if (elf_type == ET_EXEC || elf_type == ET_DYN)
{
size_t shnum;
int rc = elf_getshdrnum (elf, &shnum);
if (rc < 0)
throw elfutils_exception(rc, "getshdrnum");
executable_p = false;
for (size_t sc = 0; sc < shnum; sc++)
{
Elf_Scn *scn = elf_getscn (elf, sc);
if (scn == NULL)
continue;
GElf_Shdr shdr_mem;
GElf_Shdr *shdr = gelf_getshdr (scn, &shdr_mem);
if (shdr == NULL)
continue;
// allocated (loadable / vm-addr-assigned) section with available content?
if ((shdr->sh_type == SHT_PROGBITS) && (shdr->sh_flags & SHF_ALLOC))
{
if (verbose > 4)
obatched(clog) << "executable due to SHF_ALLOC SHT_PROGBITS sc=" << sc << endl;
executable_p = true;
break; // no need to keep looking for others
}
} // iterate over sections
} // executable_p classification
// now decide whether it's a debuginfo - namely, if it has any .debug* or .zdebug* sections
// logic mostly stolen from fweimer@redhat.com's elfclassify drafts
size_t shstrndx;
int rc = elf_getshdrstrndx (elf, &shstrndx);
if (rc < 0)
throw elfutils_exception(rc, "getshdrstrndx");
Elf_Scn *scn = NULL;
bool symtab_p = false;
bool bits_alloc_p = false;
while (true)
{
scn = elf_nextscn (elf, scn);
if (scn == NULL)
break;
GElf_Shdr shdr_storage;
GElf_Shdr *shdr = gelf_getshdr (scn, &shdr_storage);
if (shdr == NULL)
break;
const char *section_name = elf_strptr (elf, shstrndx, shdr->sh_name);
if (section_name == NULL)
break;
if (startswith (section_name, ".debug_line") ||
startswith (section_name, ".zdebug_line"))
{
debuginfo_p = true;
if (scan_source_info)
dwarf_extract_source_paths (elf, debug_sourcefiles);
break; // expecting only one .*debug_line, so no need to look for others
}
else if (startswith (section_name, ".debug_") ||
startswith (section_name, ".zdebug_"))
{
debuginfo_p = true;
// NB: don't break; need to parse .debug_line for sources
}
else if (shdr->sh_type == SHT_SYMTAB)
{
symtab_p = true;
}
else if (shdr->sh_type != SHT_NOBITS
&& shdr->sh_type != SHT_NOTE
&& (shdr->sh_flags & SHF_ALLOC) != 0)
{
bits_alloc_p = true;
}
}
// For more expansive elf/split-debuginfo classification, we
// want to identify as debuginfo "strip -s"-produced files
// without .debug_info* (like libicudata), but we don't want to
// identify "strip -g" executables (with .symtab left there).
if (symtab_p && !bits_alloc_p)
debuginfo_p = true;
}
catch (const reportable_exception& e)
{
e.report(clog);
}
elf_end (elf);
}
static void
scan_source_file (const string& rps, const stat_t& st,
sqlite_ps& ps_upsert_buildids,
sqlite_ps& ps_upsert_files,
sqlite_ps& ps_upsert_de,
sqlite_ps& ps_upsert_s,
sqlite_ps& ps_query,
sqlite_ps& ps_scan_done,
unsigned& fts_cached,
unsigned& fts_executable,
unsigned& fts_debuginfo,
unsigned& fts_sourcefiles)
{
/* See if we know of it already. */
int rc = ps_query
.reset()
.bind(1, rps)
.bind(2, st.st_mtime)
.step();
ps_query.reset();
if (rc == SQLITE_ROW) // i.e., a result, as opposed to DONE (no results)
// no need to recheck a file/version we already know
// specifically, no need to elf-begin a file we already determined is non-elf
// (so is stored with buildid=NULL)
{
fts_cached++;
return;
}
bool executable_p = false, debuginfo_p = false; // E and/or D
string buildid;
set<string> sourcefiles;
int fd = open (rps.c_str(), O_RDONLY);
try
{
if (fd >= 0)
elf_classify (fd, executable_p, debuginfo_p, buildid, sourcefiles);
else
throw libc_exception(errno, string("open ") + rps);
add_metric ("scanned_bytes_total","source","file",
st.st_size);
inc_metric ("scanned_files_total","source","file");
}
// NB: we catch exceptions here too, so that we can
// cache the corrupt-elf case (!executable_p &&
// !debuginfo_p) just below, just as if we had an
// EPERM error from open(2).
catch (const reportable_exception& e)
{
e.report(clog);
}
if (fd >= 0)
close (fd);
// register this file name in the interning table
ps_upsert_files
.reset()
.bind(1, rps)
.step_ok_done();
if (buildid == "")
{
// no point storing an elf file without buildid
executable_p = false;
debuginfo_p = false;
}
else
{
// register this build-id in the interning table
ps_upsert_buildids
.reset()
.bind(1, buildid)
.step_ok_done();
}
if (executable_p)
fts_executable ++;
if (debuginfo_p)
fts_debuginfo ++;
if (executable_p || debuginfo_p)
{
ps_upsert_de
.reset()
.bind(1, buildid)
.bind(2, debuginfo_p ? 1 : 0)
.bind(3, executable_p ? 1 : 0)
.bind(4, rps)
.bind(5, st.st_mtime)
.step_ok_done();
}
if (executable_p)
inc_metric("found_executable_total","source","files");
if (debuginfo_p)
inc_metric("found_debuginfo_total","source","files");
if (sourcefiles.size() && buildid != "")
{
fts_sourcefiles += sourcefiles.size();
for (auto&& dwarfsrc : sourcefiles)
{
char *srp = realpath(dwarfsrc.c_str(), NULL);
if (srp == NULL) // also if DWZ unresolved dwarfsrc=""
continue; // unresolvable files are not a serious problem
// throw libc_exception(errno, "fts/file realpath " + srcpath);
string srps = string(srp);
free (srp);
struct stat sfs;
rc = stat(srps.c_str(), &sfs);
if (rc != 0)
continue;
if (verbose > 2)
obatched(clog) << "recorded buildid=" << buildid << " file=" << srps
<< " mtime=" << sfs.st_mtime
<< " as source " << dwarfsrc << endl;
ps_upsert_files
.reset()
.bind(1, srps)
.step_ok_done();
// PR25548: store canonicalized dwarfsrc path
string dwarfsrc_canon = canon_pathname (dwarfsrc);
if (dwarfsrc_canon != dwarfsrc)
{
if (verbose > 3)
obatched(clog) << "canonicalized src=" << dwarfsrc << " alias=" << dwarfsrc_canon << endl;
}
ps_upsert_files
.reset()
.bind(1, dwarfsrc_canon)
.step_ok_done();
ps_upsert_s
.reset()
.bind(1, buildid)
.bind(2, dwarfsrc_canon)
.bind(3, srps)
.bind(4, sfs.st_mtime)
.step_ok_done();
inc_metric("found_sourcerefs_total","source","files");
}
}
ps_scan_done
.reset()
.bind(1, rps)
.bind(2, st.st_mtime)
.bind(3, st.st_size)
.step_ok_done();
if (verbose > 2)
obatched(clog) << "recorded buildid=" << buildid << " file=" << rps
<< " mtime=" << st.st_mtime << " atype="
<< (executable_p ? "E" : "")
<< (debuginfo_p ? "D" : "") << endl;
}
// Analyze given archive file of given age; record buildids / exec/debuginfo-ness of its
// constituent files with given upsert statements.
static void
archive_classify (const string& rps, string& archive_extension,
sqlite_ps& ps_upsert_buildids, sqlite_ps& ps_upsert_files,
sqlite_ps& ps_upsert_de, sqlite_ps& ps_upsert_sref, sqlite_ps& ps_upsert_sdef,
time_t mtime,
unsigned& fts_executable, unsigned& fts_debuginfo, unsigned& fts_sref, unsigned& fts_sdef,
bool& fts_sref_complete_p)
{
string archive_decoder = "/dev/null";
for (auto&& arch : scan_archives)
if (string_endswith(rps, arch.first))
{
archive_extension = arch.first;
archive_decoder = arch.second;
}
FILE* fp;
defer_dtor<FILE*,int>::dtor_fn dfn;
if (archive_decoder != "cat")
{
string popen_cmd = archive_decoder + " " + shell_escape(rps);
fp = popen (popen_cmd.c_str(), "r"); // "e" O_CLOEXEC?
dfn = pclose;
if (fp == NULL)
throw libc_exception (errno, string("popen ") + popen_cmd);
}
else
{
fp = fopen (rps.c_str(), "r");
dfn = fclose;
if (fp == NULL)
throw libc_exception (errno, string("fopen ") + rps);
}
defer_dtor<FILE*,int> fp_closer (fp, dfn);
struct archive *a;
a = archive_read_new();
if (a == NULL)
throw archive_exception("cannot create archive reader");
defer_dtor<struct archive*,int> archive_closer (a, archive_read_free);
int rc = archive_read_support_format_all(a);
if (rc != ARCHIVE_OK)
throw archive_exception(a, "cannot select all formats");
rc = archive_read_support_filter_all(a);
if (rc != ARCHIVE_OK)
throw archive_exception(a, "cannot select all filters");
rc = archive_read_open_FILE (a, fp);
if (rc != ARCHIVE_OK)
{
obatched(clog) << "cannot open archive from pipe " << rps << endl;
throw archive_exception(a, "cannot open archive from pipe");
}
if (verbose > 3)
obatched(clog) << "libarchive scanning " << rps << endl;
while(1) // parse archive entries
{
if (interrupted)
break;
try
{
struct archive_entry *e;
rc = archive_read_next_header (a, &e);
if (rc != ARCHIVE_OK)
break;
if (! S_ISREG(archive_entry_mode (e))) // skip non-files completely
continue;
string fn = canonicalized_archive_entry_pathname (e);
if (verbose > 3)
obatched(clog) << "libarchive checking " << fn << endl;
// extract this file to a temporary file
char* tmppath = NULL;
rc = asprintf (&tmppath, "%s/debuginfod.XXXXXX", tmpdir.c_str());
if (rc < 0)
throw libc_exception (ENOMEM, "cannot allocate tmppath");
defer_dtor<void*,void> tmmpath_freer (tmppath, free);
int fd = mkstemp (tmppath);
if (fd < 0)
throw libc_exception (errno, "cannot create temporary file");
unlink (tmppath); // unlink now so OS will release the file as soon as we close the fd
defer_dtor<int,int> minifd_closer (fd, close);
rc = archive_read_data_into_fd (a, fd);
if (rc != ARCHIVE_OK)
throw archive_exception(a, "cannot extract file");
// finally ... time to run elf_classify on this bad boy and update the database
bool executable_p = false, debuginfo_p = false;
string buildid;
set<string> sourcefiles;
elf_classify (fd, executable_p, debuginfo_p, buildid, sourcefiles);
// NB: might throw
if (buildid != "") // intern buildid
{
ps_upsert_buildids
.reset()
.bind(1, buildid)
.step_ok_done();
}
ps_upsert_files // register this rpm constituent file name in interning table
.reset()
.bind(1, fn)
.step_ok_done();
if (sourcefiles.size() > 0) // sref records needed
{
// NB: we intern each source file once. Once raw, as it
// appears in the DWARF file list coming back from
// elf_classify() - because it'll end up in the
// _norm.artifactsrc column. We don't also put another
// version with a '.' at the front, even though that's
// how rpm/cpio packs names, because we hide that from
// the database for storage efficiency.
for (auto&& s : sourcefiles)
{
if (s == "")
{
fts_sref_complete_p = false;
continue;
}
// PR25548: store canonicalized source path
const string& dwarfsrc = s;
string dwarfsrc_canon = canon_pathname (dwarfsrc);
if (dwarfsrc_canon != dwarfsrc)
{
if (verbose > 3)
obatched(clog) << "canonicalized src=" << dwarfsrc << " alias=" << dwarfsrc_canon << endl;
}
ps_upsert_files
.reset()
.bind(1, dwarfsrc_canon)
.step_ok_done();
ps_upsert_sref
.reset()
.bind(1, buildid)
.bind(2, dwarfsrc_canon)
.step_ok_done();
fts_sref ++;
}
}
if (executable_p)
fts_executable ++;
if (debuginfo_p)
fts_debuginfo ++;
if (executable_p || debuginfo_p)
{
ps_upsert_de
.reset()
.bind(1, buildid)
.bind(2, debuginfo_p ? 1 : 0)
.bind(3, executable_p ? 1 : 0)
.bind(4, rps)
.bind(5, mtime)
.bind(6, fn)
.step_ok_done();
}
else // potential source - sdef record
{
fts_sdef ++;
ps_upsert_sdef
.reset()
.bind(1, rps)
.bind(2, mtime)
.bind(3, fn)
.step_ok_done();
}
if ((verbose > 2) && (executable_p || debuginfo_p))
obatched(clog) << "recorded buildid=" << buildid << " rpm=" << rps << " file=" << fn
<< " mtime=" << mtime << " atype="
<< (executable_p ? "E" : "")
<< (debuginfo_p ? "D" : "")
<< " sourcefiles=" << sourcefiles.size() << endl;
}
catch (const reportable_exception& e)
{
e.report(clog);
}
}
}
// scan for archive files such as .rpm
static void
scan_archive_file (const string& rps, const stat_t& st,
sqlite_ps& ps_upsert_buildids,
sqlite_ps& ps_upsert_files,
sqlite_ps& ps_upsert_de,
sqlite_ps& ps_upsert_sref,
sqlite_ps& ps_upsert_sdef,
sqlite_ps& ps_query,
sqlite_ps& ps_scan_done,
unsigned& fts_cached,
unsigned& fts_executable,
unsigned& fts_debuginfo,
unsigned& fts_sref,
unsigned& fts_sdef)
{
/* See if we know of it already. */
int rc = ps_query
.reset()
.bind(1, rps)
.bind(2, st.st_mtime)
.step();
ps_query.reset();
if (rc == SQLITE_ROW) // i.e., a result, as opposed to DONE (no results)
// no need to recheck a file/version we already know
// specifically, no need to parse this archive again, since we already have
// it as a D or E or S record,
// (so is stored with buildid=NULL)
{
fts_cached ++;
return;
}
// intern the archive file name
ps_upsert_files
.reset()
.bind(1, rps)
.step_ok_done();
// extract the archive contents
unsigned my_fts_executable = 0, my_fts_debuginfo = 0, my_fts_sref = 0, my_fts_sdef = 0;
bool my_fts_sref_complete_p = true;
try
{
string archive_extension;
archive_classify (rps, archive_extension,
ps_upsert_buildids, ps_upsert_files,
ps_upsert_de, ps_upsert_sref, ps_upsert_sdef, // dalt
st.st_mtime,
my_fts_executable, my_fts_debuginfo, my_fts_sref, my_fts_sdef,
my_fts_sref_complete_p);
add_metric ("scanned_bytes_total","source",archive_extension + " archive",
st.st_size);
inc_metric ("scanned_files_total","source",archive_extension + " archive");
add_metric("found_debuginfo_total","source",archive_extension + " archive",
my_fts_debuginfo);
add_metric("found_executable_total","source",archive_extension + " archive",
my_fts_executable);
add_metric("found_sourcerefs_total","source",archive_extension + " archive",
my_fts_sref);
}
catch (const reportable_exception& e)
{
e.report(clog);
}
if (verbose > 2)
obatched(clog) << "scanned archive=" << rps
<< " mtime=" << st.st_mtime
<< " executables=" << my_fts_executable
<< " debuginfos=" << my_fts_debuginfo
<< " srefs=" << my_fts_sref
<< " sdefs=" << my_fts_sdef
<< endl;
fts_executable += my_fts_executable;
fts_debuginfo += my_fts_debuginfo;
fts_sref += my_fts_sref;
fts_sdef += my_fts_sdef;
if (my_fts_sref_complete_p) // leave incomplete?
ps_scan_done
.reset()
.bind(1, rps)
.bind(2, st.st_mtime)
.bind(3, st.st_size)
.step_ok_done();
}
////////////////////////////////////////////////////////////////////////
// The thread that consumes file names off of the scanq. We hold
// the persistent sqlite_ps's at this level and delegate file/archive
// scanning to other functions.
static void*
thread_main_scanner (void* arg)
{
(void) arg;
// all the prepared statements fit to use, the _f_ set:
sqlite_ps ps_f_upsert_buildids (db, "file-buildids-intern", "insert or ignore into " BUILDIDS "_buildids VALUES (NULL, ?);");
sqlite_ps ps_f_upsert_files (db, "file-files-intern", "insert or ignore into " BUILDIDS "_files VALUES (NULL, ?);");
sqlite_ps ps_f_upsert_de (db, "file-de-upsert",
"insert or ignore into " BUILDIDS "_f_de "
"(buildid, debuginfo_p, executable_p, file, mtime) "
"values ((select id from " BUILDIDS "_buildids where hex = ?),"
" ?,?,"
" (select id from " BUILDIDS "_files where name = ?), ?);");
sqlite_ps ps_f_upsert_s (db, "file-s-upsert",
"insert or ignore into " BUILDIDS "_f_s "
"(buildid, artifactsrc, file, mtime) "
"values ((select id from " BUILDIDS "_buildids where hex = ?),"
" (select id from " BUILDIDS "_files where name = ?),"
" (select id from " BUILDIDS "_files where name = ?),"
" ?);");
sqlite_ps ps_f_query (db, "file-negativehit-find",
"select 1 from " BUILDIDS "_file_mtime_scanned where sourcetype = 'F' "
"and file = (select id from " BUILDIDS "_files where name = ?) and mtime = ?;");
sqlite_ps ps_f_scan_done (db, "file-scanned",
"insert or ignore into " BUILDIDS "_file_mtime_scanned (sourcetype, file, mtime, size)"
"values ('F', (select id from " BUILDIDS "_files where name = ?), ?, ?);");
// and now for the _r_ set
sqlite_ps ps_r_upsert_buildids (db, "rpm-buildid-intern", "insert or ignore into " BUILDIDS "_buildids VALUES (NULL, ?);");
sqlite_ps ps_r_upsert_files (db, "rpm-file-intern", "insert or ignore into " BUILDIDS "_files VALUES (NULL, ?);");
sqlite_ps ps_r_upsert_de (db, "rpm-de-insert",
"insert or ignore into " BUILDIDS "_r_de (buildid, debuginfo_p, executable_p, file, mtime, content) values ("
"(select id from " BUILDIDS "_buildids where hex = ?), ?, ?, "
"(select id from " BUILDIDS "_files where name = ?), ?, "
"(select id from " BUILDIDS "_files where name = ?));");
sqlite_ps ps_r_upsert_sref (db, "rpm-sref-insert",
"insert or ignore into " BUILDIDS "_r_sref (buildid, artifactsrc) values ("
"(select id from " BUILDIDS "_buildids where hex = ?), "
"(select id from " BUILDIDS "_files where name = ?));");
sqlite_ps ps_r_upsert_sdef (db, "rpm-sdef-insert",
"insert or ignore into " BUILDIDS "_r_sdef (file, mtime, content) values ("
"(select id from " BUILDIDS "_files where name = ?), ?,"
"(select id from " BUILDIDS "_files where name = ?));");
sqlite_ps ps_r_query (db, "rpm-negativehit-query",
"select 1 from " BUILDIDS "_file_mtime_scanned where "
"sourcetype = 'R' and file = (select id from " BUILDIDS "_files where name = ?) and mtime = ?;");
sqlite_ps ps_r_scan_done (db, "rpm-scanned",
"insert or ignore into " BUILDIDS "_file_mtime_scanned (sourcetype, file, mtime, size)"
"values ('R', (select id from " BUILDIDS "_files where name = ?), ?, ?);");
unsigned fts_cached = 0, fts_executable = 0, fts_debuginfo = 0, fts_sourcefiles = 0;
unsigned fts_sref = 0, fts_sdef = 0;
add_metric("thread_count", "role", "scan", 1);
add_metric("thread_busy", "role", "scan", 1);
while (! interrupted)
{
scan_payload p;
add_metric("thread_busy", "role", "scan", -1);
bool gotone = scanq.wait_front(p);
add_metric("thread_busy", "role", "scan", 1);
if (! gotone) continue; // go back to waiting
try
{
bool scan_archive = false;
for (auto&& arch : scan_archives)
if (string_endswith(p.first, arch.first))
scan_archive = true;
if (scan_archive)
scan_archive_file (p.first, p.second,
ps_r_upsert_buildids,
ps_r_upsert_files,
ps_r_upsert_de,
ps_r_upsert_sref,
ps_r_upsert_sdef,
ps_r_query,
ps_r_scan_done,
fts_cached,
fts_executable,
fts_debuginfo,
fts_sref,
fts_sdef);
if (scan_files) // NB: maybe "else if" ?
scan_source_file (p.first, p.second,
ps_f_upsert_buildids,
ps_f_upsert_files,
ps_f_upsert_de,
ps_f_upsert_s,
ps_f_query,
ps_f_scan_done,
fts_cached, fts_executable, fts_debuginfo, fts_sourcefiles);
}
catch (const reportable_exception& e)
{
e.report(cerr);
}
scanq.done_front(); // let idlers run
if (fts_cached || fts_executable || fts_debuginfo || fts_sourcefiles || fts_sref || fts_sdef)
{} // NB: not just if a successful scan - we might have encountered -ENOSPC & failed
(void) statfs_free_enough_p(db_path, "database"); // report sqlite filesystem size
(void) statfs_free_enough_p(tmpdir, "tmpdir"); // this too, in case of fdcache/tmpfile usage
// finished a scanning step -- not a "loop", because we just
// consume the traversal loop's work, whenever
inc_metric("thread_work_total","role","scan");
}
add_metric("thread_busy", "role", "scan", -1);
return 0;
}
// The thread that traverses all the source_paths and enqueues all the
// matching files into the file/archive scan queue.
static void
scan_source_paths()
{
// NB: fedora 31 glibc/fts(3) crashes inside fts_read() on empty
// path list.
if (source_paths.empty())
return;
// Turn the source_paths into an fts(3)-compatible char**. Since
// source_paths[] does not change after argv processing, the
// c_str()'s are safe to keep around awile.
vector<const char *> sps;
for (auto&& sp: source_paths)
sps.push_back(sp.c_str());
sps.push_back(NULL);
FTS *fts = fts_open ((char * const *)sps.data(),
(traverse_logical ? FTS_LOGICAL : FTS_PHYSICAL|FTS_XDEV)
| FTS_NOCHDIR /* multithreaded */,
NULL);
if (fts == NULL)
throw libc_exception(errno, "cannot fts_open");
defer_dtor<FTS*,int> fts_cleanup (fts, fts_close);
struct timespec ts_start, ts_end;
clock_gettime (CLOCK_MONOTONIC, &ts_start);
unsigned fts_scanned = 0, fts_regex = 0;
FTSENT *f;
while ((f = fts_read (fts)) != NULL)
{
if (interrupted) break;
if (sigusr2 != forced_groom_count) // stop early if groom triggered
{
scanq.clear(); // clear previously issued work for scanner threads
break;
}
fts_scanned ++;
if (verbose > 2)
obatched(clog) << "fts traversing " << f->fts_path << endl;
switch (f->fts_info)
{
case FTS_F:
{
/* Found a file. Convert it to an absolute path, so
the buildid database does not have relative path
names that are unresolvable from a subsequent run
in a different cwd. */
char *rp = realpath(f->fts_path, NULL);
if (rp == NULL)
continue; // ignore dangling symlink or such
string rps = string(rp);
free (rp);
bool ri = !regexec (&file_include_regex, rps.c_str(), 0, 0, 0);
bool rx = !regexec (&file_exclude_regex, rps.c_str(), 0, 0, 0);
if (!ri || rx)
{
if (verbose > 3)
obatched(clog) << "fts skipped by regex "
<< (!ri ? "I" : "") << (rx ? "X" : "") << endl;
fts_regex ++;
if (!ri)
inc_metric("traversed_total","type","file-skipped-I");
if (rx)
inc_metric("traversed_total","type","file-skipped-X");
}
else
{
scanq.push_back (make_pair(rps, *f->fts_statp));
inc_metric("traversed_total","type","file");
}
}
break;
case FTS_ERR:
case FTS_NS:
// report on some types of errors because they may reflect fixable misconfiguration
{
auto x = libc_exception(f->fts_errno, string("fts traversal ") + string(f->fts_path));
x.report(cerr);
}
inc_metric("traversed_total","type","error");
break;
case FTS_SL: // ignore, but count because debuginfod -L would traverse these
inc_metric("traversed_total","type","symlink");
break;
case FTS_D: // ignore
inc_metric("traversed_total","type","directory");
break;
default: // ignore
inc_metric("traversed_total","type","other");
break;
}
}
clock_gettime (CLOCK_MONOTONIC, &ts_end);
double deltas = (ts_end.tv_sec - ts_start.tv_sec) + (ts_end.tv_nsec - ts_start.tv_nsec)/1.e9;
obatched(clog) << "fts traversed source paths in " << deltas << "s, scanned=" << fts_scanned
<< ", regex-skipped=" << fts_regex << endl;
}
static void*
thread_main_fts_source_paths (void* arg)
{
(void) arg; // ignore; we operate on global data
set_metric("thread_tid", "role","traverse", tid());
add_metric("thread_count", "role", "traverse", 1);
time_t last_rescan = 0;
while (! interrupted)
{
sleep (1);
scanq.wait_idle(); // don't start a new traversal while scanners haven't finished the job
scanq.done_idle(); // release the hounds
if (interrupted) break;
time_t now = time(NULL);
bool rescan_now = false;
if (last_rescan == 0) // at least one initial rescan is documented even for -t0
rescan_now = true;
if (rescan_s > 0 && (long)now > (long)(last_rescan + rescan_s))
rescan_now = true;
if (sigusr1 != forced_rescan_count)
{
forced_rescan_count = sigusr1;
rescan_now = true;
}
if (rescan_now)
{
set_metric("thread_busy", "role","traverse", 1);
try
{
scan_source_paths();
}
catch (const reportable_exception& e)
{
e.report(cerr);
}
last_rescan = time(NULL); // NB: now was before scanning
// finished a traversal loop
inc_metric("thread_work_total", "role","traverse");
set_metric("thread_busy", "role","traverse", 0);
}
}
return 0;
}
////////////////////////////////////////////////////////////////////////
static void
database_stats_report()
{
sqlite_ps ps_query (db, "database-overview",
"select label,quantity from " BUILDIDS "_stats");
obatched(clog) << "database record counts:" << endl;
while (1)
{
if (interrupted) break;
if (sigusr1 != forced_rescan_count) // stop early if scan triggered
break;
int rc = ps_query.step();
if (rc == SQLITE_DONE) break;
if (rc != SQLITE_ROW)
throw sqlite_exception(rc, "step");
obatched(clog)
<< ((const char*) sqlite3_column_text(ps_query, 0) ?: (const char*) "NULL")
<< " "
<< (sqlite3_column_text(ps_query, 1) ?: (const unsigned char*) "NULL")
<< endl;
set_metric("groom", "statistic",
((const char*) sqlite3_column_text(ps_query, 0) ?: (const char*) "NULL"),
(sqlite3_column_double(ps_query, 1)));
}
}
// Do a round of database grooming that might take many minutes to run.
void groom()
{
obatched(clog) << "grooming database" << endl;
struct timespec ts_start, ts_end;
clock_gettime (CLOCK_MONOTONIC, &ts_start);
// scan for files that have disappeared
sqlite_ps files (db, "check old files",
"select distinct s.mtime, s.file, f.name from "
BUILDIDS "_file_mtime_scanned s, " BUILDIDS "_files f "
"where f.id = s.file");
// NB: Because _ftime_mtime_scanned can contain both F and
// R records for the same file, this query would return duplicates if the
// DISTINCT qualifier were not there.
files.reset();
// DECISION TIME - we enumerate stale fileids/mtimes
deque<pair<int64_t,int64_t> > stale_fileid_mtime;
time_t time_start = time(NULL);
while(1)
{
// PR28514: limit grooming iteration to O(rescan time), to avoid
// slow filesystem tests over many files locking out rescans for
// too long.
if (rescan_s > 0 && (long)time(NULL) > (long)(time_start + rescan_s))
{
inc_metric("groomed_total", "decision", "aborted");
break;
}
if (interrupted) break;
int rc = files.step();
if (rc != SQLITE_ROW)
break;
int64_t mtime = sqlite3_column_int64 (files, 0);
int64_t fileid = sqlite3_column_int64 (files, 1);
const char* filename = ((const char*) sqlite3_column_text (files, 2) ?: "");
struct stat s;
bool regex_file_drop = 0;
if (regex_groom)
{
bool reg_include = !regexec (&file_include_regex, filename, 0, 0, 0);
bool reg_exclude = !regexec (&file_exclude_regex, filename, 0, 0, 0);
regex_file_drop = reg_exclude && !reg_include;
}
rc = stat(filename, &s);
if ( regex_file_drop || rc < 0 || (mtime != (int64_t) s.st_mtime) )
{
if (verbose > 2)
obatched(clog) << "groom: stale file=" << filename << " mtime=" << mtime << endl;
stale_fileid_mtime.push_back(make_pair(fileid,mtime));
inc_metric("groomed_total", "decision", "stale");
set_metric("thread_work_pending","role","groom", stale_fileid_mtime.size());
}
else
inc_metric("groomed_total", "decision", "fresh");
if (sigusr1 != forced_rescan_count) // stop early if scan triggered
break;
}
files.reset();
// ACTION TIME
// Now that we know which file/mtime tuples are stale, actually do
// the deletion from the database. Doing this during the SELECT
// iteration above results in undefined behaviour in sqlite, as per
// https://www.sqlite.org/isolation.html
// We could shuffle stale_fileid_mtime[] here. It'd let aborted
// sequences of nuke operations resume at random locations, instead
// of just starting over. But it doesn't matter much either way,
// as long as we make progress.
sqlite_ps files_del_f_de (db, "nuke f_de", "delete from " BUILDIDS "_f_de where file = ? and mtime = ?");
sqlite_ps files_del_r_de (db, "nuke r_de", "delete from " BUILDIDS "_r_de where file = ? and mtime = ?");
sqlite_ps files_del_scan (db, "nuke f_m_s", "delete from " BUILDIDS "_file_mtime_scanned "
"where file = ? and mtime = ?");
while (! stale_fileid_mtime.empty())
{
auto stale = stale_fileid_mtime.front();
stale_fileid_mtime.pop_front();
set_metric("thread_work_pending","role","groom", stale_fileid_mtime.size());
// PR28514: limit grooming iteration to O(rescan time), to avoid
// slow nuke_* queries over many files locking out rescans for too
// long. We iterate over the files in random() sequence to avoid
// partial checks going over the same set.
if (rescan_s > 0 && (long)time(NULL) > (long)(time_start + rescan_s))
{
inc_metric("groomed_total", "action", "aborted");
break;
}
if (interrupted) break;
int64_t fileid = stale.first;
int64_t mtime = stale.second;
files_del_f_de.reset().bind(1,fileid).bind(2,mtime).step_ok_done();
files_del_r_de.reset().bind(1,fileid).bind(2,mtime).step_ok_done();
files_del_scan.reset().bind(1,fileid).bind(2,mtime).step_ok_done();
inc_metric("groomed_total", "action", "cleaned");
if (sigusr1 != forced_rescan_count) // stop early if scan triggered
break;
}
stale_fileid_mtime.clear(); // no need for this any longer
set_metric("thread_work_pending","role","groom", stale_fileid_mtime.size());
// delete buildids with no references in _r_de or _f_de tables;
// cascades to _r_sref & _f_s records
sqlite_ps buildids_del (db, "nuke orphan buildids",
"delete from " BUILDIDS "_buildids "
"where not exists (select 1 from " BUILDIDS "_f_de d where " BUILDIDS "_buildids.id = d.buildid) "
"and not exists (select 1 from " BUILDIDS "_r_de d where " BUILDIDS "_buildids.id = d.buildid)");
buildids_del.reset().step_ok_done();
if (interrupted) return;
// NB: "vacuum" is too heavy for even daily runs: it rewrites the entire db, so is done as maxigroom -G
sqlite_ps g1 (db, "incremental vacuum", "pragma incremental_vacuum");
g1.reset().step_ok_done();
sqlite_ps g2 (db, "optimize", "pragma optimize");
g2.reset().step_ok_done();
sqlite_ps g3 (db, "wal checkpoint", "pragma wal_checkpoint=truncate");
g3.reset().step_ok_done();
database_stats_report();
(void) statfs_free_enough_p(db_path, "database"); // report sqlite filesystem size
sqlite3_db_release_memory(db); // shrink the process if possible
sqlite3_db_release_memory(dbq); // ... for both connections
debuginfod_pool_groom(); // and release any debuginfod_client objects we've been holding onto
fdcache.limit(0,0,0,0); // release the fdcache contents
fdcache.limit(fdcache_fds, fdcache_mbs, fdcache_prefetch_fds, fdcache_prefetch_mbs); // restore status quo parameters
clock_gettime (CLOCK_MONOTONIC, &ts_end);
double deltas = (ts_end.tv_sec - ts_start.tv_sec) + (ts_end.tv_nsec - ts_start.tv_nsec)/1.e9;
obatched(clog) << "groomed database in " << deltas << "s" << endl;
}
static void*
thread_main_groom (void* /*arg*/)
{
set_metric("thread_tid", "role", "groom", tid());
add_metric("thread_count", "role", "groom", 1);
time_t last_groom = 0;
while (1)
{
sleep (1);
scanq.wait_idle(); // PR25394: block scanners during grooming!
if (interrupted) break;
time_t now = time(NULL);
bool groom_now = false;
if (last_groom == 0) // at least one initial groom is documented even for -g0
groom_now = true;
if (groom_s > 0 && (long)now > (long)(last_groom + groom_s))
groom_now = true;
if (sigusr2 != forced_groom_count)
{
forced_groom_count = sigusr2;
groom_now = true;
}
if (groom_now)
{
set_metric("thread_busy", "role", "groom", 1);
try
{
groom ();
}
catch (const sqlite_exception& e)
{
obatched(cerr) << e.message << endl;
}
last_groom = time(NULL); // NB: now was before grooming
// finished a grooming loop
inc_metric("thread_work_total", "role", "groom");
set_metric("thread_busy", "role", "groom", 0);
}
scanq.done_idle();
}
return 0;
}
////////////////////////////////////////////////////////////////////////
static void
signal_handler (int /* sig */)
{
interrupted ++;
if (db)
sqlite3_interrupt (db);
if (dbq)
sqlite3_interrupt (dbq);
// NB: don't do anything else in here
}
static void
sigusr1_handler (int /* sig */)
{
sigusr1 ++;
// NB: don't do anything else in here
}
static void
sigusr2_handler (int /* sig */)
{
sigusr2 ++;
// NB: don't do anything else in here
}
static void // error logging callback from libmicrohttpd internals
error_cb (void *arg, const char *fmt, va_list ap)
{
(void) arg;
inc_metric("error_count","libmicrohttpd",fmt);
char errmsg[512];
(void) vsnprintf (errmsg, sizeof(errmsg), fmt, ap); // ok if slightly truncated
obatched(cerr) << "libmicrohttpd error: " << errmsg; // MHD_DLOG calls already include \n
}
// A user-defined sqlite function, to score the sharedness of the
// prefix of two strings. This is used to compare candidate debuginfo
// / source-rpm names, so that the closest match
// (directory-topology-wise closest) is found. This is important in
// case the same sref (source file name) is in many -debuginfo or
// -debugsource RPMs, such as when multiple versions/releases of the
// same package are in the database.
static void sqlite3_sharedprefix_fn (sqlite3_context* c, int argc, sqlite3_value** argv)
{
if (argc != 2)
sqlite3_result_error(c, "expect 2 string arguments", -1);
else if ((sqlite3_value_type(argv[0]) != SQLITE_TEXT) ||
(sqlite3_value_type(argv[1]) != SQLITE_TEXT))
sqlite3_result_null(c);
else
{
const unsigned char* a = sqlite3_value_text (argv[0]);
const unsigned char* b = sqlite3_value_text (argv[1]);
int i = 0;
while (*a != '\0' && *b != '\0' && *a++ == *b++)
i++;
sqlite3_result_int (c, i);
}
}
static unsigned
default_concurrency() // guaranteed >= 1
{
// Prior to PR29975 & PR29976, we'd just use this:
unsigned sth = std::thread::hardware_concurrency();
// ... but on many-CPU boxes, admins or distros may throttle
// resources in such a way that debuginfod would mysteriously fail.
// So we reduce the defaults:
unsigned aff = 0;
#ifdef HAVE_SCHED_GETAFFINITY
{
int ret;
cpu_set_t mask;
CPU_ZERO(&mask);
ret = sched_getaffinity(0, sizeof(mask), &mask);
if (ret == 0)
aff = CPU_COUNT(&mask);
}
#endif
unsigned fn = 0;
#ifdef HAVE_GETRLIMIT
{
struct rlimit rlim;
int rc = getrlimit(RLIMIT_NOFILE, &rlim);
if (rc == 0)
fn = max((rlim_t)1, (rlim.rlim_cur - 100) / 4);
// at least 2 fds are used by each listener thread etc.
// plus a bunch to account for shared libraries and such
}
#endif
unsigned d = min(max(sth, 1U),
min(max(aff, 1U),
max(fn, 1U)));
return d;
}
int
main (int argc, char *argv[])
{
(void) setlocale (LC_ALL, "");
(void) bindtextdomain (PACKAGE_TARNAME, LOCALEDIR);
(void) textdomain (PACKAGE_TARNAME);
/* Tell the library which version we are expecting. */
elf_version (EV_CURRENT);
tmpdir = string(getenv("TMPDIR") ?: "/tmp");
/* Set computed default values. */
db_path = string(getenv("HOME") ?: "/") + string("/.debuginfod.sqlite"); /* XDG? */
int rc = regcomp (& file_include_regex, ".*", REG_EXTENDED|REG_NOSUB); // match everything
if (rc != 0)
error (EXIT_FAILURE, 0, "regcomp failure: %d", rc);
rc = regcomp (& file_exclude_regex, "^$", REG_EXTENDED|REG_NOSUB); // match nothing
if (rc != 0)
error (EXIT_FAILURE, 0, "regcomp failure: %d", rc);
// default parameters for fdcache are computed from system stats
struct statfs sfs;
rc = statfs(tmpdir.c_str(), &sfs);
if (rc < 0)
fdcache_mbs = 1024; // 1 gigabyte
else
fdcache_mbs = sfs.f_bavail * sfs.f_bsize / 1024 / 1024 / 4; // 25% of free space
fdcache_mintmp = 25; // emergency flush at 25% remaining (75% full)
fdcache_prefetch = 64; // guesstimate storage is this much less costly than re-decompression
fdcache_fds = (concurrency + fdcache_prefetch) * 2;
/* Parse and process arguments. */
int remaining;
(void) argp_parse (&argp, argc, argv, ARGP_IN_ORDER, &remaining, NULL);
if (remaining != argc)
error (EXIT_FAILURE, 0,
"unexpected argument: %s", argv[remaining]);
// Make the prefetch cache spaces a fraction of the main fdcache if
// unspecified.
if (fdcache_prefetch_fds == 0)
fdcache_prefetch_fds = fdcache_fds / 2;
if (fdcache_prefetch_mbs == 0)
fdcache_prefetch_mbs = fdcache_mbs / 2;
if (scan_archives.size()==0 && !scan_files && source_paths.size()>0)
obatched(clog) << "warning: without -F -R -U -Z, ignoring PATHs" << endl;
fdcache.limit(fdcache_fds, fdcache_mbs, fdcache_prefetch_fds, fdcache_prefetch_mbs);
(void) signal (SIGPIPE, SIG_IGN); // microhttpd can generate it incidentally, ignore
(void) signal (SIGINT, signal_handler); // ^C
(void) signal (SIGHUP, signal_handler); // EOF
(void) signal (SIGTERM, signal_handler); // systemd
(void) signal (SIGUSR1, sigusr1_handler); // end-user
(void) signal (SIGUSR2, sigusr2_handler); // end-user
/* Get database ready. */
if (! passive_p)
{
rc = sqlite3_open_v2 (db_path.c_str(), &db, (SQLITE_OPEN_READWRITE
|SQLITE_OPEN_URI
|SQLITE_OPEN_PRIVATECACHE
|SQLITE_OPEN_CREATE
|SQLITE_OPEN_FULLMUTEX), /* thread-safe */
NULL);
if (rc == SQLITE_CORRUPT)
{
(void) unlink (db_path.c_str());
error (EXIT_FAILURE, 0,
"cannot open %s, deleted database: %s", db_path.c_str(), sqlite3_errmsg(db));
}
else if (rc)
{
error (EXIT_FAILURE, 0,
"cannot open %s, consider deleting database: %s", db_path.c_str(), sqlite3_errmsg(db));
}
}
// open the readonly query variant
// NB: PRIVATECACHE allows web queries to operate in parallel with
// much other grooming/scanning operation.
rc = sqlite3_open_v2 (db_path.c_str(), &dbq, (SQLITE_OPEN_READONLY
|SQLITE_OPEN_URI
|SQLITE_OPEN_PRIVATECACHE
|SQLITE_OPEN_FULLMUTEX), /* thread-safe */
NULL);
if (rc)
{
error (EXIT_FAILURE, 0,
"cannot open %s, consider deleting database: %s", db_path.c_str(), sqlite3_errmsg(dbq));
}
obatched(clog) << "opened database " << db_path
<< (db?" rw":"") << (dbq?" ro":"") << endl;
obatched(clog) << "sqlite version " << sqlite3_version << endl;
obatched(clog) << "service mode " << (passive_p ? "passive":"active") << endl;
// add special string-prefix-similarity function used in rpm sref/sdef resolution
rc = sqlite3_create_function(dbq, "sharedprefix", 2, SQLITE_UTF8, NULL,
& sqlite3_sharedprefix_fn, NULL, NULL);
if (rc != SQLITE_OK)
error (EXIT_FAILURE, 0,
"cannot create sharedprefix function: %s", sqlite3_errmsg(dbq));
if (! passive_p)
{
if (verbose > 3)
obatched(clog) << "ddl: " << DEBUGINFOD_SQLITE_DDL << endl;
rc = sqlite3_exec (db, DEBUGINFOD_SQLITE_DDL, NULL, NULL, NULL);
if (rc != SQLITE_OK)
{
error (EXIT_FAILURE, 0,
"cannot run database schema ddl: %s", sqlite3_errmsg(db));
}
}
obatched(clog) << "libmicrohttpd version " << MHD_get_version() << endl;
/* If '-C' wasn't given or was given with no arg, pick a reasonable default
for the number of worker threads. */
if (connection_pool == 0)
connection_pool = default_concurrency();
/* Note that MHD_USE_EPOLL and MHD_USE_THREAD_PER_CONNECTION don't
work together. */
unsigned int use_epoll = 0;
#if MHD_VERSION >= 0x00095100
use_epoll = MHD_USE_EPOLL;
#endif
unsigned int mhd_flags = (
#if MHD_VERSION >= 0x00095300
MHD_USE_INTERNAL_POLLING_THREAD
#else
MHD_USE_SELECT_INTERNALLY
#endif
| MHD_USE_DUAL_STACK
| use_epoll
#if MHD_VERSION >= 0x00095200
| MHD_USE_ITC
#endif
| MHD_USE_DEBUG); /* report errors to stderr */
// Start httpd server threads. Use a single dual-homed pool.
MHD_Daemon *d46 = MHD_start_daemon (mhd_flags, http_port,
NULL, NULL, /* default accept policy */
handler_cb, NULL, /* handler callback */
MHD_OPTION_EXTERNAL_LOGGER,
error_cb, NULL,
MHD_OPTION_THREAD_POOL_SIZE,
(int)connection_pool,
MHD_OPTION_END);
MHD_Daemon *d4 = NULL;
if (d46 == NULL)
{
// Cannot use dual_stack, use ipv4 only
mhd_flags &= ~(MHD_USE_DUAL_STACK);
d4 = MHD_start_daemon (mhd_flags, http_port,
NULL, NULL, /* default accept policy */
handler_cb, NULL, /* handler callback */
MHD_OPTION_EXTERNAL_LOGGER,
error_cb, NULL,
(connection_pool
? MHD_OPTION_THREAD_POOL_SIZE
: MHD_OPTION_END),
(connection_pool
? (int)connection_pool
: MHD_OPTION_END),
MHD_OPTION_END);
if (d4 == NULL)
{
sqlite3 *database = db;
sqlite3 *databaseq = dbq;
db = dbq = 0; // for signal_handler not to freak
sqlite3_close (databaseq);
sqlite3_close (database);
error (EXIT_FAILURE, 0, "cannot start http server at port %d",
http_port);
}
}
obatched(clog) << "started http server on"
<< (d4 != NULL ? " IPv4 " : " IPv4 IPv6 ")
<< "port=" << http_port << endl;
// add maxigroom sql if -G given
if (maxigroom)
{
obatched(clog) << "maxigrooming database, please wait." << endl;
extra_ddl.push_back("create index if not exists " BUILDIDS "_r_sref_arc on " BUILDIDS "_r_sref(artifactsrc);");
extra_ddl.push_back("delete from " BUILDIDS "_r_sdef where not exists (select 1 from " BUILDIDS "_r_sref b where " BUILDIDS "_r_sdef.content = b.artifactsrc);");
extra_ddl.push_back("drop index if exists " BUILDIDS "_r_sref_arc;");
// NB: we don't maxigroom the _files interning table. It'd require a temp index on all the
// tables that have file foreign-keys, which is a lot.
// NB: with =delete, may take up 3x disk space total during vacuum process
// vs. =off (only 2x but may corrupt database if program dies mid-vacuum)
// vs. =wal (>3x observed, but safe)
extra_ddl.push_back("pragma journal_mode=delete;");
extra_ddl.push_back("vacuum;");
extra_ddl.push_back("pragma journal_mode=wal;");
}
// run extra -D sql if given
if (! passive_p)
for (auto&& i: extra_ddl)
{
if (verbose > 1)
obatched(clog) << "extra ddl:\n" << i << endl;
rc = sqlite3_exec (db, i.c_str(), NULL, NULL, NULL);
if (rc != SQLITE_OK && rc != SQLITE_DONE && rc != SQLITE_ROW)
error (0, 0,
"warning: cannot run database extra ddl %s: %s", i.c_str(), sqlite3_errmsg(db));
if (maxigroom)
obatched(clog) << "maxigroomed database" << endl;
}
if (! passive_p)
obatched(clog) << "search concurrency " << concurrency << endl;
obatched(clog) << "webapi connection pool " << connection_pool
<< (connection_pool ? "" : " (unlimited)") << endl;
if (! passive_p)
obatched(clog) << "rescan time " << rescan_s << endl;
obatched(clog) << "fdcache fds " << fdcache_fds << endl;
obatched(clog) << "fdcache mbs " << fdcache_mbs << endl;
obatched(clog) << "fdcache prefetch " << fdcache_prefetch << endl;
obatched(clog) << "fdcache tmpdir " << tmpdir << endl;
obatched(clog) << "fdcache tmpdir min% " << fdcache_mintmp << endl;
if (! passive_p)
obatched(clog) << "groom time " << groom_s << endl;
obatched(clog) << "prefetch fds " << fdcache_prefetch_fds << endl;
obatched(clog) << "prefetch mbs " << fdcache_prefetch_mbs << endl;
obatched(clog) << "forwarded ttl limit " << forwarded_ttl_limit << endl;
if (scan_archives.size()>0)
{
obatched ob(clog);
auto& o = ob << "accepting archive types ";
for (auto&& arch : scan_archives)
o << arch.first << "(" << arch.second << ") ";
o << endl;
}
const char* du = getenv(DEBUGINFOD_URLS_ENV_VAR);
if (du && du[0] != '\0') // set to non-empty string?
obatched(clog) << "upstream debuginfod servers: " << du << endl;
vector<pthread_t> all_threads;
if (! passive_p)
{
pthread_t pt;
rc = pthread_create (& pt, NULL, thread_main_groom, NULL);
if (rc)
error (EXIT_FAILURE, rc, "cannot spawn thread to groom database\n");
else
{
#ifdef HAVE_PTHREAD_SETNAME_NP
(void) pthread_setname_np (pt, "groom");
#endif
all_threads.push_back(pt);
}
if (scan_files || scan_archives.size() > 0)
{
rc = pthread_create (& pt, NULL, thread_main_fts_source_paths, NULL);
if (rc)
error (EXIT_FAILURE, rc, "cannot spawn thread to traverse source paths\n");
#ifdef HAVE_PTHREAD_SETNAME_NP
(void) pthread_setname_np (pt, "traverse");
#endif
all_threads.push_back(pt);
for (unsigned i=0; i<concurrency; i++)
{
rc = pthread_create (& pt, NULL, thread_main_scanner, NULL);
if (rc)
error (EXIT_FAILURE, rc, "cannot spawn thread to scan source files / archives\n");
#ifdef HAVE_PTHREAD_SETNAME_NP
(void) pthread_setname_np (pt, "scan");
#endif
all_threads.push_back(pt);
}
}
}
/* Trivial main loop! */
set_metric("ready", 1);
while (! interrupted)
pause ();
scanq.nuke(); // wake up any remaining scanq-related threads, let them die
set_metric("ready", 0);
if (verbose)
obatched(clog) << "stopping" << endl;
/* Join all our threads. */
for (auto&& it : all_threads)
pthread_join (it, NULL);
/* Stop all the web service threads. */
if (d46) MHD_stop_daemon (d46);
if (d4) MHD_stop_daemon (d4);
if (! passive_p)
{
/* With all threads known dead, we can clean up the global resources. */
rc = sqlite3_exec (db, DEBUGINFOD_SQLITE_CLEANUP_DDL, NULL, NULL, NULL);
if (rc != SQLITE_OK)
{
error (0, 0,
"warning: cannot run database cleanup ddl: %s", sqlite3_errmsg(db));
}
}
debuginfod_pool_groom ();
// NB: no problem with unconditional free here - an earlier failed regcomp would exit program
(void) regfree (& file_include_regex);
(void) regfree (& file_exclude_regex);
sqlite3 *database = db;
sqlite3 *databaseq = dbq;
db = dbq = 0; // for signal_handler not to freak
(void) sqlite3_close (databaseq);
if (! passive_p)
(void) sqlite3_close (database);
return 0;
}
|