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
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
| #! /usr/bin/python2
# generated from systemctl3.py - do not change
from __future__ import print_function
import threading
import grp
import pwd
import hashlib
import select
import fcntl
import string
import datetime
import socket
import time
import signal
import sys
import os
import errno
import collections
import shlex
import fnmatch
import re
from types import GeneratorType
__copyright__ = "(C) 2016-2025 Guido U. Draheim, licensed under the EUPL"
__version__ = "1.5.9063"
# |
# |
# |
# |
# |
# |
# |
# |
# |
# |
# |
# |
# |
import logging
logg = logging.getLogger("systemctl")
if sys.version[0] == '3':
basestring = str
xrange = range
DEBUG_AFTER = False
DEBUG_STATUS = False
DEBUG_BOOTTIME = False
DEBUG_INITLOOP = False
DEBUG_KILLALL = False
DEBUG_FLOCK = False
DebugPrintResult = False
TestListen = False
TestAccept = False
HINT = (logging.DEBUG + logging.INFO) // 2
NOTE = (logging.WARNING + logging.INFO) // 2
DONE = (logging.WARNING + logging.ERROR) // 2
logging.addLevelName(HINT, "HINT")
logging.addLevelName(NOTE, "NOTE")
logging.addLevelName(DONE, "DONE")
def logg_debug_flock(format, *args):
if DEBUG_FLOCK:
logg.debug(format, *args) # pragma: no cover
def logg_debug_after(format, *args):
if DEBUG_AFTER:
logg.debug(format, *args) # pragma: no cover
NOT_A_PROBLEM = 0 # FOUND_OK
NOT_OK = 1 # FOUND_ERROR
NOT_ACTIVE = 2 # FOUND_INACTIVE
NOT_FOUND = 4 # FOUND_UNKNOWN
# defaults for options
_extra_vars = []
_force = False
_full = False
_log_lines = 0
_no_pager = False
_now = False
_no_reload = False
_no_legend = False
_no_ask_password = False
_preset_mode = "all"
_quiet = False
_root = ""
_show_all = False
_user_mode = False
_only_what = []
_only_type = []
_only_state = []
_only_property = []
# common default paths
_system_folders = [
"/etc/systemd/system",
"/run/systemd/system",
"/var/run/systemd/system",
"/usr/local/lib/systemd/system",
"/usr/lib/systemd/system",
"/lib/systemd/system",
]
_user_folders = [
"{XDG_CONFIG_HOME}/systemd/user",
"/etc/systemd/user",
"{XDG_RUNTIME_DIR}/systemd/user",
"/run/systemd/user",
"/var/run/systemd/user",
"{XDG_DATA_HOME}/systemd/user",
"/usr/local/lib/systemd/user",
"/usr/lib/systemd/user",
"/lib/systemd/user",
]
_init_folders = [
"/etc/init.d",
"/run/init.d",
"/var/run/init.d",
]
_preset_folders = [
"/etc/systemd/system-preset",
"/run/systemd/system-preset",
"/var/run/systemd/system-preset",
"/usr/local/lib/systemd/system-preset",
"/usr/lib/systemd/system-preset",
"/lib/systemd/system-preset",
]
# standard paths
_dev_null = "/dev/null"
_dev_zero = "/dev/zero"
_etc_hosts = "/etc/hosts"
_rc3_boot_folder = "/etc/rc3.d"
_rc3_init_folder = "/etc/init.d/rc3.d"
_rc5_boot_folder = "/etc/rc5.d"
_rc5_init_folder = "/etc/init.d/rc5.d"
_proc_pid_stat = "/proc/{pid}/stat"
_proc_pid_status = "/proc/{pid}/status"
_proc_pid_cmdline= "/proc/{pid}/cmdline"
_proc_pid_dir = "/proc"
_proc_sys_uptime = "/proc/uptime"
_proc_sys_stat = "/proc/stat"
# default values
SystemCompatibilityVersion = 219
SysInitTarget = "sysinit.target"
SysInitWait = 5 # max for target
MinimumYield = 0.5
MinimumTimeoutStartSec = 4
MinimumTimeoutStopSec = 4
DefaultTimeoutStartSec = 90 # official value
DefaultTimeoutStopSec = 90 # official value
DefaultTimeoutAbortSec = 3600 # officially it none (usually larget than StopSec)
DefaultMaximumTimeout = 200 # overrides all other
DefaultRestartSec = 0.1 # official value of 100ms
DefaultStartLimitIntervalSec = 10 # official value
DefaultStartLimitBurst = 5 # official value
InitLoopSleep = 5
MaxLockWait = 0 # equals DefaultMaximumTimeout
DefaultPath = "/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
ResetLocale = ["LANG", "LANGUAGE", "LC_CTYPE", "LC_NUMERIC", "LC_TIME", "LC_COLLATE", "LC_MONETARY",
"LC_MESSAGES", "LC_PAPER", "LC_NAME", "LC_ADDRESS", "LC_TELEPHONE", "LC_MEASUREMENT",
"LC_IDENTIFICATION", "LC_ALL"]
LocaleConf="/etc/locale.conf"
DefaultListenBacklog=2
ExitWhenNoMoreServices = False
ExitWhenNoMoreProcs = False
DefaultUnit = os.environ.get("SYSTEMD_DEFAULT_UNIT", "default.target") # systemd.exe --unit=default.target
DefaultTarget = os.environ.get("SYSTEMD_DEFAULT_TARGET", "multi-user.target") # DefaultUnit fallback
# LogLevel = os.environ.get("SYSTEMD_LOG_LEVEL", "info") # systemd.exe --log-level
# LogTarget = os.environ.get("SYSTEMD_LOG_TARGET", "journal-or-kmsg") # systemd.exe --log-target
# LogLocation = os.environ.get("SYSTEMD_LOG_LOCATION", "no") # systemd.exe --log-location
# ShowStatus = os.environ.get("SYSTEMD_SHOW_STATUS", "auto") # systemd.exe --show-status
DefaultStandardInput=os.environ.get("SYSTEMD_STANDARD_INPUT", "null")
DefaultStandardOutput=os.environ.get("SYSTEMD_STANDARD_OUTPUT", "journal") # systemd.exe --default-standard-output
DefaultStandardError=os.environ.get("SYSTEMD_STANDARD_ERROR", "inherit") # systemd.exe --default-standard-error
EXEC_SPAWN = False
EXEC_DUP2 = True
REMOVE_LOCK_FILE = False
BOOT_PID_MIN = 0
BOOT_PID_MAX = -9
PROC_MAX_DEPTH = 100
EXPAND_VARS_MAXDEPTH = 20
EXPAND_KEEP_VARS = True
RESTART_FAILED_UNITS = True
ACTIVE_IF_ENABLED=False
TAIL_CMDS = ["/bin/tail", "/usr/bin/tail", "/usr/local/bin/tail"]
LESS_CMDS = ["/bin/less", "/usr/bin/less", "/usr/local/bin/less"]
CAT_CMDS = ["/bin/cat", "/usr/bin/cat", "/usr/local/bin/cat"]
# The systemd default was NOTIFY_SOCKET="/var/run/systemd/notify"
_notify_socket_folder = "{RUN}/systemd" # alias /run/systemd
_journal_log_folder = "{LOG}/journal"
SYSTEMCTL_DEBUG_LOG = "{LOG}/systemctl.debug.log"
SYSTEMCTL_EXTRA_LOG = "{LOG}/systemctl.log"
_default_targets = ["poweroff.target", "rescue.target", "sysinit.target", "basic.target", "multi-user.target", "graphical.target", "reboot.target"]
_feature_targets = ["network.target", "remote-fs.target", "local-fs.target", "timers.target", "nfs-client.target"]
_all_common_targets = ["default.target"] + _default_targets + _feature_targets
# inside a docker we pretend the following
_all_common_enabled = ["default.target", "multi-user.target", "remote-fs.target"]
_all_common_disabled = ["graphical.target", "resue.target", "nfs-client.target"]
target_requires = {"graphical.target": "multi-user.target", "multi-user.target": "basic.target", "basic.target": "sockets.target"}
_runlevel_mappings = {} # the official list
_runlevel_mappings["0"] = "poweroff.target"
_runlevel_mappings["1"] = "rescue.target"
_runlevel_mappings["2"] = "multi-user.target"
_runlevel_mappings["3"] = "multi-user.target"
_runlevel_mappings["4"] = "multi-user.target"
_runlevel_mappings["5"] = "graphical.target"
_runlevel_mappings["6"] = "reboot.target"
_sysv_mappings = {} # by rule of thumb
_sysv_mappings["$local_fs"] = "local-fs.target"
_sysv_mappings["$network"] = "network.target"
_sysv_mappings["$remote_fs"] = "remote-fs.target"
_sysv_mappings["$timer"] = "timers.target"
# sections from conf
Unit = "Unit"
Service = "Service"
Socket = "Socket"
Install = "Install"
# https://tldp.org/LDP/abs/html/exitcodes.html
# https://freedesktop.org/software/systemd/man/systemd.exec.html#id-1.20.8
EXIT_SUCCESS = 0
EXIT_FAILURE = 1
def strINET(value):
if value == socket.SOCK_DGRAM:
return "UDP"
if value == socket.SOCK_STREAM:
return "TCP"
if value == socket.SOCK_RAW: # pragma: no cover
return "RAW"
if value == socket.SOCK_RDM: # pragma: no cover
return "RDM"
if value == socket.SOCK_SEQPACKET: # pragma: no cover
return "SEQ"
return "<?>" # pragma: no cover
def strYes(value):
if value is True:
return "yes"
if not value:
return "no"
return str(value)
def strE(part):
if not part:
return ""
return str(part)
def strQ(part):
if part is None:
return ""
if isinstance(part, int):
return str(part)
return "'%s'" % part
def shell_cmd(cmd):
return " ".join([strQ(part) for part in cmd])
def to_intN(value, default = None):
if not value:
return default
try:
return int(value)
except:
return default
def to_int(value, default = 0):
try:
return int(value)
except:
return default
def to_list(value):
if not value:
return []
if isinstance(value, list):
return value
if isinstance(value, tuple):
return list(value)
return str(value or "").split(",")
def commalist(value):
return list(_commalist(value))
def _commalist(value):
for val in value:
if not val:
continue
for elem in val.strip().split(","):
yield elem
def int_mode(value):
try: return int(value, 8)
except: return None # pragma: no cover
def unit_of(module):
if "." not in module:
return module + ".service"
return module
def o22(part):
if isinstance(part, basestring):
if len(part) <= 22:
return part
return part[:5] + "..." + part[-14:]
return part # pragma: no cover (is always str)
def o44(part):
if isinstance(part, basestring):
if len(part) <= 44:
return part
return part[:10] + "..." + part[-31:]
return part # pragma: no cover (is always str)
def o77(part):
if isinstance(part, basestring):
if len(part) <= 77:
return part
return part[:20] + "..." + part[-54:]
return part # pragma: no cover (is always str)
def path44(filename):
if not filename:
return "<none>"
x = filename.find("/", 8)
if len(filename) <= 40:
if "/" not in filename:
return ".../" + filename
elif len(filename) <= 44:
return filename
if 0 < x and x < 14:
out = filename[:x+1]
out += "..."
else:
out = filename[:10]
out += "..."
remain = len(filename) - len(out)
y = filename.find("/", remain)
if 0 < y and y < remain+5:
out += filename[y:]
else:
out += filename[remain:]
return out
def unit_name_escape(text):
# https://www.freedesktop.org/software/systemd/man/systemd.unit.html#id-1.6
esc = re.sub("([^a-z-AZ.-/])", lambda m: "\\x%02x" % ord(m.group(1)[0]), text)
return esc.replace("/", "-")
def unit_name_unescape(text):
esc = text.replace("-", "/")
return re.sub("\\\\x(..)", lambda m: "%c" % chr(int(m.group(1), 16)), esc)
def is_good_root(root):
if not root:
return True
return root.strip(os.path.sep).count(os.path.sep) > 1
def os_path(root, path):
if not root:
return path
if not path:
return path
if is_good_root(root) and path.startswith(root):
return path
while path.startswith(os.path.sep):
path = path[1:]
return os.path.join(root, path)
def path_replace_extension(path, old, new):
if path.endswith(old):
path = path[:-len(old)]
return path + new
def get_exist_path(paths):
for p in paths:
if os.path.exists(p):
return p
return None
def get_PAGER():
PAGER = os.environ.get("PAGER", "less")
pager = os.environ.get("SYSTEMD_PAGER", "{PAGER}").format(**locals())
options = os.environ.get("SYSTEMD_LESS", "FRSXMK") # see 'man timedatectl'
if not pager: pager = "cat"
if "less" in pager and options:
return [pager, "-" + options]
return [pager]
def os_getlogin():
""" NOT using os.getlogin() """
return pwd.getpwuid(os.geteuid()).pw_name
def get_runtime_dir():
explicit = os.environ.get("XDG_RUNTIME_DIR", "")
if explicit: return explicit
user = os_getlogin()
return "/tmp/run-"+user
def get_RUN(root = False):
tmp_var = get_TMP(root)
if _root:
tmp_var = _root
if root:
for p in ("/run", "/var/run", "{tmp_var}/run"):
path = p.format(**locals())
if os.path.isdir(path) and os.access(path, os.W_OK):
return path
os.makedirs(path) # "/tmp/run"
return path
else:
uid = get_USER_ID(root)
for p in ("/run/user/{uid}", "/var/run/user/{uid}", "{tmp_var}/run-{uid}"):
path = p.format(**locals())
if os.path.isdir(path) and os.access(path, os.W_OK):
return path
os.makedirs(path, 0o700) # "/tmp/run/user/{uid}"
return path
def get_PID_DIR(root = False):
if root:
return get_RUN(root)
else:
return os.path.join(get_RUN(root), "run") # compat with older systemctl.py
def get_home():
if False: # pragma: no cover
explicit = os.environ.get("HOME", "") # >> On Unix, an initial ~ (tilde) is replaced by the
if explicit: return explicit # environment variable HOME if it is set; otherwise
uid = os.geteuid() # the current users home directory is looked up in the
# # password directory through the built-in module pwd.
return pwd.getpwuid(uid).pw_name # An initial ~user i looked up directly in the
return os.path.expanduser("~") # password directory. << from docs(os.path.expanduser)
def get_HOME(root = False):
if root: return "/root"
return get_home()
def get_USER_ID(root = False):
ID = 0
if root: return ID
return os.geteuid()
def get_USER(root = False):
if root: return "root"
uid = os.geteuid()
return pwd.getpwuid(uid).pw_name
def get_GROUP_ID(root = False):
ID = 0
if root: return ID
return os.getegid()
def get_GROUP(root = False):
if root: return "root"
gid = os.getegid()
return grp.getgrgid(gid).gr_name
def get_TMP(root = False):
TMP = "/tmp"
if root: return TMP
return os.environ.get("TMPDIR", os.environ.get("TEMP", os.environ.get("TMP", TMP)))
def get_VARTMP(root = False):
VARTMP = "/var/tmp"
if root: return VARTMP
return os.environ.get("TMPDIR", os.environ.get("TEMP", os.environ.get("TMP", VARTMP)))
def get_SHELL(root = False):
SHELL = "/bin/sh"
if root: return SHELL
return os.environ.get("SHELL", SHELL)
def get_RUNTIME_DIR(root = False):
RUN = "/run"
if root: return RUN
return os.environ.get("XDG_RUNTIME_DIR", get_runtime_dir())
def get_CONFIG_HOME(root = False):
CONFIG = "/etc"
if root: return CONFIG
HOME = get_HOME(root)
return os.environ.get("XDG_CONFIG_HOME", HOME + "/.config")
def get_CACHE_HOME(root = False):
CACHE = "/var/cache"
if root: return CACHE
HOME = get_HOME(root)
return os.environ.get("XDG_CACHE_HOME", HOME + "/.cache")
def get_DATA_HOME(root = False):
SHARE = "/usr/share"
if root: return SHARE
HOME = get_HOME(root)
return os.environ.get("XDG_DATA_HOME", HOME + "/.local/share")
def get_LOG_DIR(root = False):
LOGDIR = "/var/log"
if root: return LOGDIR
CONFIG = get_CONFIG_HOME(root)
return os.path.join(CONFIG, "log")
def get_VARLIB_HOME(root = False):
VARLIB = "/var/lib"
if root: return VARLIB
CONFIG = get_CONFIG_HOME(root)
return CONFIG
def expand_path(path, root = False):
HOME = get_HOME(root)
RUN = get_RUN(root)
LOG = get_LOG_DIR(root)
XDG_DATA_HOME=get_DATA_HOME(root)
XDG_CONFIG_HOME=get_CONFIG_HOME(root)
XDG_RUNTIME_DIR=get_RUNTIME_DIR(root)
return os.path.expanduser(path.replace("${", "{").format(**locals()))
def shutil_chown(path, user, group):
if user or group:
uid, gid = -1, -1
if user:
uid = pwd.getpwnam(user).pw_uid
gid = pwd.getpwnam(user).pw_gid
if group:
gid = grp.getgrnam(group).gr_gid
os.chown(path, uid, gid)
def shutil_fchown(fileno, user, group):
if user or group:
uid, gid = -1, -1
if user:
uid = pwd.getpwnam(user).pw_uid
gid = pwd.getpwnam(user).pw_gid
if group:
gid = grp.getgrnam(group).gr_gid
os.fchown(fileno, uid, gid)
def shutil_setuid(user = None, group = None, xgroups = None):
""" set fork-child uid/gid (returns pw-info env-settings)"""
if group:
gid = grp.getgrnam(group).gr_gid
os.setgid(gid)
logg.debug("setgid %s for %s", gid, strQ(group))
groups = [gid]
try:
os.setgroups(groups)
logg.debug("setgroups %s < (%s)", groups, group)
except OSError as e: # pragma: no cover (it will occur in non-root mode anyway)
logg.debug("setgroups %s < (%s) : %s", groups, group, e)
if user:
pw = pwd.getpwnam(user)
gid = pw.pw_gid
gname = grp.getgrgid(gid).gr_name
if not group:
os.setgid(gid)
logg.debug("setgid %s for user %s", gid, strQ(user))
groupnames = [g.gr_name for g in grp.getgrall() if user in g.gr_mem]
groups = [g.gr_gid for g in grp.getgrall() if user in g.gr_mem]
if xgroups:
groups += [g.gr_gid for g in grp.getgrall() if g.gr_name in xgroups and g.gr_gid not in groups]
if not groups:
if group:
gid = grp.getgrnam(group).gr_gid
groups = [gid]
try:
os.setgroups(groups)
logg.debug("setgroups %s > %s ", groups, groupnames)
except OSError as e: # pragma: no cover (it will occur in non-root mode anyway)
logg.debug("setgroups %s > %s : %s", groups, groupnames, e)
uid = pw.pw_uid
os.setuid(uid)
logg.debug("setuid %s for user %s", uid, strQ(user))
home = pw.pw_dir
shell = pw.pw_shell
logname = pw.pw_name
return {"USER": user, "LOGNAME": logname, "HOME": home, "SHELL": shell}
return {}
def shutil_truncate(filename):
""" truncates the file (or creates a new empty file)"""
filedir = os.path.dirname(filename)
if not os.path.isdir(filedir):
os.makedirs(filedir)
with open(filename, "w") as f:
f.write("")
# http://stackoverflow.com/questions/568271/how-to-check-if-there-exists-a-process-with-a-given-pid
def pid_exists(pid):
"""Check whether pid exists in the current process table."""
if pid is None: # pragma: no cover (is never null)
return False
return _pid_exists(int(pid))
def _pid_exists(pid):
"""Check whether pid exists in the current process table.
UNIX only.
"""
if pid < 0:
return False
if pid == 0:
# According to "man 2 kill" PID 0 refers to every process
# in the process group of the calling process.
# On certain systems 0 is a valid PID but we have no way
# to know that in a portable fashion.
raise ValueError('invalid PID 0')
try:
os.kill(pid, 0)
except OSError as err:
if err.errno == errno.ESRCH:
# ESRCH == No such process
return False
elif err.errno == errno.EPERM:
# EPERM clearly means there's a process to deny access to
return True
else:
# According to "man 2 kill" possible error values are
# (EINVAL, EPERM, ESRCH)
raise
else:
return True
def pid_zombie(pid):
""" may be a pid exists but it is only a zombie """
if pid is None:
return False
return _pid_zombie(int(pid))
def _pid_zombie(pid):
""" may be a pid exists but it is only a zombie """
if pid < 0:
return False
if pid == 0:
# According to "man 2 kill" PID 0 refers to every process
# in the process group of the calling process.
# On certain systems 0 is a valid PID but we have no way
# to know that in a portable fashion.
raise ValueError('invalid PID 0')
check = _proc_pid_status.format(**locals())
try:
with open(check) as f:
for line in f:
if line.startswith("State:"):
return "Z" in line
except IOError as e:
if e.errno != errno.ENOENT:
logg.error("%s (%s): %s", check, e.errno, e)
return False
return False
def checkprefix(cmd):
prefix = ""
for i, c in enumerate(cmd):
if c in "-+!@:":
prefix = prefix + c
else:
newcmd = cmd[i:]
return prefix, newcmd
return prefix, ""
ExecMode = collections.namedtuple("ExecMode", ["mode", "check", "nouser", "noexpand", "argv0"])
def exec_path(cmd):
""" Hint: exec_path values are usually not moved by --root (while load_path are)"""
prefix, newcmd = checkprefix(cmd)
check = "-" not in prefix
nouser = "+" in prefix or "!" in prefix
noexpand = ":" in prefix
argv0 = "@" in prefix
mode = ExecMode(prefix, check, nouser, noexpand, argv0)
return mode, newcmd
LoadMode = collections.namedtuple("LoadMode", ["mode", "check"])
def load_path(ref):
""" Hint: load_path values are usually moved by --root (while exec_path are not)"""
prefix, filename = "", ref
while filename.startswith("-"):
prefix = prefix + filename[0]
filename = filename[1:]
check = "-" not in prefix
mode = LoadMode(prefix, check)
return mode, filename
# https://github.com/phusion/baseimage-docker/blob/rel-0.9.16/image/bin/my_init
def ignore_signals_and_raise_keyboard_interrupt(signame):
signal.signal(signal.SIGTERM, signal.SIG_IGN)
signal.signal(signal.SIGINT, signal.SIG_IGN)
raise KeyboardInterrupt(signame)
_default_dict_type = collections.OrderedDict
_default_conf_type = collections.OrderedDict
class SystemctlConfData:
""" A *.service files has a structure similar to an *.ini file so
that data is structured in sections and values. Actually the
values are lists - the raw data is in .getlist(). Otherwise
.get() will return the first line that was encountered. """
# |
# |
# |
# |
# |
# |
def __init__(self, defaults=None, dict_type=None, conf_type=None, allow_no_value=False):
self._defaults = defaults or {}
self._conf_type = conf_type or _default_conf_type
self._dict_type = dict_type or _default_dict_type
self._allow_no_value = allow_no_value
self._conf = self._conf_type()
self._files = []
def defaults(self):
return self._defaults
def sections(self):
return list(self._conf.keys())
def add_section(self, section):
if section not in self._conf:
self._conf[section] = self._dict_type()
def has_section(self, section):
return section in self._conf
def has_option(self, section, option):
if section not in self._conf:
return False
return option in self._conf[section]
def set(self, section, option, value):
if section not in self._conf:
self._conf[section] = self._dict_type()
if value is None:
self._conf[section][option] = []
elif option not in self._conf[section]:
self._conf[section][option] = [value]
else:
self._conf[section][option].append(value)
def getstr(self, section, option, default = None, allow_no_value = False):
done = self.get(section, option, strE(default), allow_no_value)
if done is None: return strE(default)
return done
def get(self, section, option, default = None, allow_no_value = False):
allow_no_value = allow_no_value or self._allow_no_value
if section not in self._conf:
if default is not None:
return default
if allow_no_value:
return None
logg.warning("section {} does not exist".format(section))
logg.warning(" have {}".format(self.sections()))
raise AttributeError("section {} does not exist".format(section))
if option not in self._conf[section]:
if default is not None:
return default
if allow_no_value:
return None
raise AttributeError("option {} in {} does not exist".format(option, section))
if not self._conf[section][option]: # i.e. an empty list
if default is not None:
return default
if allow_no_value:
return None
raise AttributeError("option {} in {} is None".format(option, section))
return self._conf[section][option][0] # the first line in the list of configs
def getlist(self, section, option, default = None, allow_no_value = False):
allow_no_value = allow_no_value or self._allow_no_value
if section not in self._conf:
if default is not None:
return default
if allow_no_value:
return []
logg.warning("section {} does not exist".format(section))
logg.warning(" have {}".format(self.sections()))
raise AttributeError("section {} does not exist".format(section))
if option not in self._conf[section]:
if default is not None:
return default
if allow_no_value:
return []
raise AttributeError("option {} in {} does not exist".format(option, section))
return self._conf[section][option] # returns a list, possibly empty
def filenames(self):
return self._files
class SystemctlConfigParser(SystemctlConfData):
""" A *.service files has a structure similar to an *.ini file but it is
actually not like it. Settings may occur multiple times in each section
and they create an implicit list. In reality all the settings are
globally uniqute, so that an 'environment' can be printed without
adding prefixes. Settings are continued with a backslash at the end
of the line. """
# def __init__(self, defaults=None, dict_type=None, allow_no_value=False):
# SystemctlConfData.__init__(self, defaults, dict_type, allow_no_value)
def read(self, filename):
return self.read_sysd(filename)
def read_sysd(self, filename):
initscript = False
initinfo = False
section = "GLOBAL"
nextline = False
name, text = "", ""
if os.path.isfile(filename):
self._files.append(filename)
with open(filename) as f:
for orig_line in f:
if nextline:
text += orig_line
if text.rstrip().endswith("\\") or text.rstrip().endswith("\\\n"):
text = text.rstrip() + "\n"
else:
self.set(section, name, text)
nextline = False
continue
line = orig_line.strip()
if not line:
continue
if line.startswith("#"):
continue
if line.startswith(";"):
continue
if line.startswith(".include"):
logg.error("the '.include' syntax is deprecated. Use x.service.d/ drop-in files!")
includefile = re.sub(r'^\.include[ ]*', '', line).rstrip()
if not os.path.isfile(includefile):
raise Exception("tried to include file that doesn't exist: %s" % includefile)
self.read_sysd(includefile)
continue
if line.startswith("["):
x = line.find("]")
if x > 0:
section = line[1:x]
self.add_section(section)
continue
m = re.match(r"(\w+) *=(.*)", line)
if not m:
logg.warning("bad ini line: %s", line)
raise Exception("bad ini line")
name, text = m.group(1), m.group(2).strip()
if text.endswith("\\") or text.endswith("\\\n"):
nextline = True
text = text + "\n"
else:
# hint: an empty line shall reset the value-list
self.set(section, name, text and text or None)
if nextline:
self.set(section, name, text)
return self
def read_sysv(self, filename):
""" an LSB header is scanned and converted to (almost)
equivalent settings of a SystemD ini-style input """
initscript = False
initinfo = False
section = "GLOBAL"
if os.path.isfile(filename):
self._files.append(filename)
with open(filename) as f:
for orig_line in f:
line = orig_line.strip()
if line.startswith("#"):
if " BEGIN INIT INFO" in line:
initinfo = True
section = "init.d"
if " END INIT INFO" in line:
initinfo = False
if initinfo:
m = re.match(r"\S+\s*(\w[\w_-]*):(.*)", line)
if m:
key, val = m.group(1), m.group(2).strip()
self.set(section, key, val)
continue
self.systemd_sysv_generator(filename)
return self
def systemd_sysv_generator(self, filename):
""" see systemd-sysv-generator(8) """
self.set(Unit, "SourcePath", filename)
description = self.get("init.d", "Description", "")
if description:
self.set(Unit, "Description", description)
check = self.get("init.d", "Required-Start", "")
if check:
for item in check.split(" "):
if item.strip() in _sysv_mappings:
self.set(Unit, "Requires", _sysv_mappings[item.strip()])
provides = self.get("init.d", "Provides", "")
if provides:
self.set(Install, "Alias", provides)
# if already in multi-user.target then start it there.
runlevels = self.getstr("init.d", "Default-Start", "3 5")
for item in runlevels.split(" "):
if item.strip() in _runlevel_mappings:
self.set(Install, "WantedBy", _runlevel_mappings[item.strip()])
self.set(Service, "Restart", "no")
self.set(Service, "TimeoutSec", strE(DefaultMaximumTimeout))
self.set(Service, "KillMode", "process")
self.set(Service, "GuessMainPID", "no")
# self.set(Service, "RemainAfterExit", "yes")
# self.set(Service, "SuccessExitStatus", "5 6")
self.set(Service, "ExecStart", filename + " start")
self.set(Service, "ExecStop", filename + " stop")
if description: # LSB style initscript
self.set(Service, "ExecReload", filename + " reload")
self.set(Service, "Type", "forking") # not "sysv" anymore
# UnitConfParser = ConfigParser.RawConfigParser
UnitConfParser = SystemctlConfigParser
class SystemctlSocket:
def __init__(self, conf, sock, skip = False):
self.conf = conf
self.sock = sock
self.skip = skip
def fileno(self):
return self.sock.fileno()
def listen(self, backlog = None):
if backlog is None:
backlog = DefaultListenBacklog
dgram = (self.sock.type == socket.SOCK_DGRAM)
if not dgram and not self.skip:
self.sock.listen(backlog)
def name(self):
return self.conf.name()
def addr(self):
stream = self.conf.get(Socket, "ListenStream", "")
dgram = self.conf.get(Socket, "ListenDatagram", "")
return stream or dgram
def close(self):
self.sock.close()
class SystemctlConf:
# |
# |
# |
# |
# |
# |
# |
# |
# |
def __init__(self, data, module = None):
self.data = data # UnitConfParser
self.env = {}
self.status = None
self.masked = None
self.module = module
self.nonloaded_path = ""
self.drop_in_files = {}
self._root = _root
self._user_mode = _user_mode
def root_mode(self):
return not self._user_mode
def loaded(self):
files = self.data.filenames()
if self.masked:
return "masked"
if len(files):
return "loaded"
return ""
def filename(self):
""" returns the last filename that was parsed """
files = self.data.filenames()
if files:
return files[0]
return None
def overrides(self):
""" drop-in files are loaded alphabetically by name, not by full path """
return [self.drop_in_files[name] for name in sorted(self.drop_in_files)]
def name(self):
""" the unit id or defaults to the file name """
name = self.module or ""
filename = self.filename()
if filename:
name = os.path.basename(filename)
return self.module or name
def set(self, section, name, value):
return self.data.set(section, name, value)
def get(self, section, name, default, allow_no_value = False):
return self.data.getstr(section, name, default, allow_no_value)
def getlist(self, section, name, default = None, allow_no_value = False):
return self.data.getlist(section, name, default or [], allow_no_value)
def getbool(self, section, name, default = None):
value = self.data.get(section, name, default or "no")
if value:
if value[0] in "TtYy123456789":
return True
return False
class PresetFile:
# |
# |
def __init__(self):
self._files = []
self._lines = []
def filename(self):
""" returns the last filename that was parsed """
if self._files:
return self._files[-1]
return None
def read(self, filename):
self._files.append(filename)
with open(filename) as f:
for line in f:
self._lines.append(line.strip())
return self
def get_preset(self, unit):
for line in self._lines:
m = re.match(r"(enable|disable)\s+(\S+)", line)
if m:
status, pattern = m.group(1), m.group(2)
if fnmatch.fnmatchcase(unit, pattern):
logg.debug("%s %s => %s %s", status, pattern, unit, strQ(self.filename()))
return status
return None
## with waitlock(conf): self.start()
class waitlock:
# |
# |
# |
def __init__(self, conf):
self.conf = conf # currently unused
self.opened = -1
self.lockfolder = expand_path(_notify_socket_folder, conf.root_mode())
try:
folder = self.lockfolder
if not os.path.isdir(folder):
os.makedirs(folder)
except Exception as e:
logg.warning("oops, %s", e)
def lockfile(self):
unit = ""
if self.conf:
unit = self.conf.name()
return os.path.join(self.lockfolder, str(unit or "global") + ".lock")
def __enter__(self):
try:
lockfile = self.lockfile()
lockname = os.path.basename(lockfile)
self.opened = os.open(lockfile, os.O_RDWR | os.O_CREAT, 0o600)
for attempt in xrange(int(MaxLockWait or DefaultMaximumTimeout)):
try:
logg_debug_flock("[%s] %s. trying %s _______ ", os.getpid(), attempt, lockname)
fcntl.flock(self.opened, fcntl.LOCK_EX | fcntl.LOCK_NB)
st = os.fstat(self.opened)
if not st.st_nlink:
logg_debug_flock("[%s] %s. %s got deleted, trying again", os.getpid(), attempt, lockname)
os.close(self.opened)
self.opened = os.open(lockfile, os.O_RDWR | os.O_CREAT, 0o600)
continue
content = "{ 'systemctl': %s, 'lock': '%s' }\n" % (os.getpid(), lockname)
os.write(self.opened, content.encode("utf-8"))
logg_debug_flock("[%s] %s. holding lock on %s", os.getpid(), attempt, lockname)
return True
except IOError as e:
whom = os.read(self.opened, 4096)
os.lseek(self.opened, 0, os.SEEK_SET)
logg.info("[%s] %s. systemctl locked by %s", os.getpid(), attempt, whom.rstrip())
time.sleep(1) # until MaxLockWait
continue
logg.error("[%s] not able to get the lock to %s", os.getpid(), lockname)
except Exception as e:
logg.warning("[%s] oops %s, %s", os.getpid(), str(type(e)), e)
# TODO# raise Exception("no lock for %s", self.unit or "global")
return False
def __exit__(self, type, value, traceback):
try:
os.lseek(self.opened, 0, os.SEEK_SET)
os.ftruncate(self.opened, 0)
if REMOVE_LOCK_FILE: # an optional implementation
lockfile = self.lockfile()
lockname = os.path.basename(lockfile)
os.unlink(lockfile) # ino is kept allocated because opened by this process
logg.debug("[%s] lockfile removed for %s", os.getpid(), lockname)
fcntl.flock(self.opened, fcntl.LOCK_UN)
os.close(self.opened) # implies an unlock but that has happend like 6 seconds later
self.opened = -1
except Exception as e:
logg.warning("oops, %s", e)
SystemctlWaitPID = collections.namedtuple("SystemctlWaitPID", ["pid", "returncode", "signal"])
def must_have_failed(waitpid, cmd):
# found to be needed on ubuntu:16.04 to match test result from ubuntu:18.04 and other distros
# .... I have tracked it down that python's os.waitpid() returns an exitcode==0 even when the
# .... underlying process has actually failed with an exitcode<>0. It is unknown where that
# .... bug comes from but it seems a bit serious to trash some very basic unix functionality.
# .... Essentially a parent process does not get the correct exitcode from its own children.
if cmd and cmd[0] == "/bin/kill":
pid = None
for arg in cmd[1:]:
if not arg.startswith("-"):
pid = arg
if pid is None: # unknown $MAINPID
if not waitpid.returncode:
logg.error("waitpid %s did return %s => correcting as 11", cmd, waitpid.returncode)
waitpid = SystemctlWaitPID(waitpid.pid, 11, waitpid.signal)
return waitpid
def subprocess_waitpid(pid):
run_pid, run_stat = os.waitpid(pid, 0)
return SystemctlWaitPID(run_pid, os.WEXITSTATUS(run_stat), os.WTERMSIG(run_stat))
def subprocess_testpid(pid):
run_pid, run_stat = os.waitpid(pid, os.WNOHANG)
if run_pid:
return SystemctlWaitPID(run_pid, os.WEXITSTATUS(run_stat), os.WTERMSIG(run_stat))
else:
return SystemctlWaitPID(pid, None, 0)
SystemctlUnitName = collections.namedtuple("SystemctlUnitName", ["fullname", "name", "prefix", "instance", "suffix", "component"])
def parse_unit(fullname): # -> object(prefix, instance, suffix, ...., name, component)
name, suffix = fullname, ""
has_suffix = fullname.rfind(".")
if has_suffix > 0:
name = fullname[:has_suffix]
suffix = fullname[has_suffix+1:]
prefix, instance = name, ""
has_instance = name.find("@")
if has_instance > 0:
prefix = name[:has_instance]
instance = name[has_instance+1:]
component = ""
has_component = prefix.rfind("-")
if has_component > 0:
component = prefix[has_component+1:]
return SystemctlUnitName(fullname, name, prefix, instance, suffix, component)
def time_to_seconds(text, maximum):
value = 0.
for part in str(text).split(" "):
item = part.strip()
if item == "infinity":
return maximum
if item.endswith("m"):
try: value += 60 * int(item[:-1])
except: pass # pragma: no cover
if item.endswith("min"):
try: value += 60 * int(item[:-3])
except: pass # pragma: no cover
elif item.endswith("ms"):
try: value += int(item[:-2]) / 1000.
except: pass # pragma: no cover
elif item.endswith("s"):
try: value += int(item[:-1])
except: pass # pragma: no cover
elif item:
try: value += int(item)
except: pass # pragma: no cover
if value > maximum:
return maximum
if not value and text.strip() == "0":
return 0.
if not value:
return 1.
return value
def seconds_to_time(seconds):
seconds = float(seconds)
mins = int(int(seconds) / 60)
secs = int(int(seconds) - (mins * 60))
msecs = int(int(seconds * 1000) - (secs * 1000 + mins * 60000))
if mins and secs and msecs:
return "%smin %ss %sms" % (mins, secs, msecs)
elif mins and secs:
return "%smin %ss" % (mins, secs)
elif secs and msecs:
return "%ss %sms" % (secs, msecs)
elif mins and msecs:
return "%smin %sms" % (mins, msecs)
elif mins:
return "%smin" % (mins)
else:
return "%ss" % (secs)
def getBefore(conf):
result = []
beforelist = conf.getlist(Unit, "Before", [])
for befores in beforelist:
for before in befores.split(" "):
name = before.strip()
if name and name not in result:
result.append(name)
return result
def getAfter(conf):
result = []
afterlist = conf.getlist(Unit, "After", [])
for afters in afterlist:
for after in afters.split(" "):
name = after.strip()
if name and name not in result:
result.append(name)
return result
def compareAfter(confA, confB):
idA = confA.name()
idB = confB.name()
for after in getAfter(confA):
if after == idB:
logg.debug("%s After %s", idA, idB)
return -1
for after in getAfter(confB):
if after == idA:
logg.debug("%s After %s", idB, idA)
return 1
for before in getBefore(confA):
if before == idB:
logg.debug("%s Before %s", idA, idB)
return 1
for before in getBefore(confB):
if before == idA:
logg.debug("%s Before %s", idB, idA)
return -1
return 0
def conf_sortedAfter(conflist, cmp = compareAfter):
# the normal sorted() does only look at two items
# so if "A after C" and a list [A, B, C] then
# it will see "A = B" and "B = C" assuming that
# "A = C" and the list is already sorted.
#
# To make a totalsorted we have to create a marker
# that informs sorted() that also B has a relation.
# It only works when 'after' has a direction, so
# anything without 'before' is a 'after'. In that
# case we find that "B after C".
class SortTuple:
def __init__(self, rank, conf):
self.rank = rank
self.conf = conf
sortlist = [SortTuple(0, conf) for conf in conflist]
for check in xrange(len(sortlist)): # maxrank = len(sortlist)
changed = 0
for A in xrange(len(sortlist)):
for B in xrange(len(sortlist)):
if A != B:
itemA = sortlist[A]
itemB = sortlist[B]
before = compareAfter(itemA.conf, itemB.conf)
if before > 0 and itemA.rank <= itemB.rank:
logg_debug_after(" %-30s before %s", itemA.conf.name(), itemB.conf.name())
itemA.rank = itemB.rank + 1
changed += 1
if before < 0 and itemB.rank <= itemA.rank:
logg_debug_after(" %-30s before %s", itemB.conf.name(), itemA.conf.name())
itemB.rank = itemA.rank + 1
changed += 1
if not changed:
logg_debug_after("done in check %s of %s", check, len(sortlist))
break
# because Requires is almost always the same as the After clauses
# we are mostly done in round 1 as the list is in required order
for conf in conflist:
logg_debug_after(".. %s", conf.name())
for item in sortlist:
logg_debug_after("(%s) %s", item.rank, item.conf.name())
sortedlist = sorted(sortlist, key = lambda item: -item.rank)
for item in sortedlist:
logg_debug_after("[%s] %s", item.rank, item.conf.name())
return [item.conf for item in sortedlist]
class SystemctlListenThread(threading.Thread):
def __init__(self, systemctl):
threading.Thread.__init__(self, name="listen")
self.systemctl = systemctl
self.stopped = threading.Event()
def stop(self):
self.stopped.set()
def run(self):
READ_ONLY = select.POLLIN | select.POLLPRI | select.POLLHUP | select.POLLERR
READ_WRITE = READ_ONLY | select.POLLOUT
me = os.getpid()
if DEBUG_INITLOOP: # pragma: no cover
logg.info("[%s] listen: new thread", me)
if not self.systemctl._sockets:
return
if DEBUG_INITLOOP: # pragma: no cover
logg.info("[%s] listen: start thread", me)
listen = select.poll()
for sock in self.systemctl._sockets.values():
listen.register(sock, READ_ONLY)
sock.listen()
logg.debug("[%s] listen: %s :%s", me, sock.name(), sock.addr())
timestamp = time.time()
while not self.stopped.is_set():
try:
sleep_sec = InitLoopSleep - (time.time() - timestamp)
if sleep_sec < MinimumYield:
sleep_sec = MinimumYield
sleeping = sleep_sec
while sleeping > 2:
time.sleep(1) # accept signals atleast every second
sleeping = InitLoopSleep - (time.time() - timestamp)
if sleeping < MinimumYield:
sleeping = MinimumYield
break
time.sleep(sleeping) # remainder waits less that 2 seconds
if DEBUG_INITLOOP: # pragma: no cover
logg.debug("[%s] listen: poll", me)
accepting = listen.poll(100) # milliseconds
if DEBUG_INITLOOP: # pragma: no cover
logg.debug("[%s] listen: poll (%s)", me, len(accepting))
for sock_fileno, event in accepting:
for sock in self.systemctl._sockets.values():
if sock.fileno() == sock_fileno:
if not self.stopped.is_set():
if self.systemctl.loop.acquire():
logg.debug("[%s] listen: accept %s :%s", me, sock.name(), sock_fileno)
self.systemctl.do_accept_socket_from(sock.conf, sock.sock)
except Exception as e:
logg.info("[%s] listen: interrupted - exception %s", me, e)
raise
for sock in self.systemctl._sockets.values():
try:
listen.unregister(sock)
sock.close()
except Exception as e:
logg.warning("[%s] listen: close socket: %s", me, e)
return
class Systemctl:
# |
# |
# |
# |
# |
# |
# |
# |
# |
# |
# |
# |
# |
# |
# |
# |
# |
# |
# |
# |
# |
# |
# |
# |
# |
# |
# |
# |
# |
# |
# |
# |
# |
# |
# |
# |
# |
# |
# |
def __init__(self):
self.error = NOT_A_PROBLEM # program exitcode or process returncode
# from command line options or the defaults
self._extra_vars = _extra_vars
self._force = _force
self._full = _full
self._init = _init
self._no_ask_password = _no_ask_password
self._no_legend = _no_legend
self._now = _now
self._preset_mode = _preset_mode
self._quiet = _quiet
self._root = _root
self._show_all = _show_all
self._only_what = commalist(_only_what) or [""]
self._only_property = commalist(_only_property)
self._only_state = commalist(_only_state)
self._only_type = commalist(_only_type)
# some common constants that may be changed
self._systemd_version = SystemCompatibilityVersion
self._journal_log_folder = _journal_log_folder
# and the actual internal runtime state
self._loaded_file_sysv = {} # /etc/init.d/name => config data
self._loaded_file_sysd = {} # /etc/systemd/system/name.service => config data
self._file_for_unit_sysv = None # name.service => /etc/init.d/name
self._file_for_unit_sysd = None # name.service => /etc/systemd/system/name.service
self._preset_file_list = None # /etc/systemd/system-preset/* => file content
self._default_target = DefaultTarget
self._sysinit_target = None # stores a UnitConf()
self.doExitWhenNoMoreProcs = ExitWhenNoMoreProcs or False
self.doExitWhenNoMoreServices = ExitWhenNoMoreServices or False
self._user_mode = _user_mode
self._user_getlogin = os_getlogin()
self._log_file = {} # init-loop
self._log_hold = {} # init-loop
self._boottime = None # cache self.get_boottime()
self._SYSTEMD_UNIT_PATH = None
self._SYSTEMD_SYSVINIT_PATH = None
self._SYSTEMD_PRESET_PATH = None
self._restarted_unit = {}
self._restart_failed_units = {}
self._sockets = {}
self.loop = threading.Lock()
def user(self):
return self._user_getlogin
def user_mode(self):
return self._user_mode
def user_folder(self):
for folder in self.user_folders():
if folder: return folder
raise Exception("did not find any systemd/user folder")
def system_folder(self):
for folder in self.system_folders():
if folder: return folder
raise Exception("did not find any systemd/system folder")
def preset_folders(self):
SYSTEMD_PRESET_PATH = self.get_SYSTEMD_PRESET_PATH()
for path in SYSTEMD_PRESET_PATH.split(":"):
if path.strip(): yield expand_path(path.strip())
if SYSTEMD_PRESET_PATH.endswith(":"):
for p in _preset_folders:
yield expand_path(p.strip())
def init_folders(self):
SYSTEMD_SYSVINIT_PATH = self.get_SYSTEMD_SYSVINIT_PATH()
for path in SYSTEMD_SYSVINIT_PATH.split(":"):
if path.strip(): yield expand_path(path.strip())
if SYSTEMD_SYSVINIT_PATH.endswith(":"):
for p in _init_folders:
yield expand_path(p.strip())
def user_folders(self):
SYSTEMD_UNIT_PATH = self.get_SYSTEMD_UNIT_PATH()
for path in SYSTEMD_UNIT_PATH.split(":"):
if path.strip(): yield expand_path(path.strip())
if SYSTEMD_UNIT_PATH.endswith(":"):
for p in _user_folders:
yield expand_path(p.strip())
def system_folders(self):
SYSTEMD_UNIT_PATH = self.get_SYSTEMD_UNIT_PATH()
for path in SYSTEMD_UNIT_PATH.split(":"):
if path.strip(): yield expand_path(path.strip())
if SYSTEMD_UNIT_PATH.endswith(":"):
for p in _system_folders:
yield expand_path(p.strip())
def get_SYSTEMD_UNIT_PATH(self):
if self._SYSTEMD_UNIT_PATH is None:
self._SYSTEMD_UNIT_PATH = os.environ.get("SYSTEMD_UNIT_PATH", ":")
assert self._SYSTEMD_UNIT_PATH is not None
return self._SYSTEMD_UNIT_PATH
def get_SYSTEMD_SYSVINIT_PATH(self):
if self._SYSTEMD_SYSVINIT_PATH is None:
self._SYSTEMD_SYSVINIT_PATH = os.environ.get("SYSTEMD_SYSVINIT_PATH", ":")
assert self._SYSTEMD_SYSVINIT_PATH is not None
return self._SYSTEMD_SYSVINIT_PATH
def get_SYSTEMD_PRESET_PATH(self):
if self._SYSTEMD_PRESET_PATH is None:
self._SYSTEMD_PRESET_PATH = os.environ.get("SYSTEMD_PRESET_PATH", ":")
assert self._SYSTEMD_PRESET_PATH is not None
return self._SYSTEMD_PRESET_PATH
def sysd_folders(self):
""" if --user then these folders are preferred """
if self.user_mode():
for folder in self.user_folders():
yield folder
if True:
for folder in self.system_folders():
yield folder
def scan_unit_sysd_files(self, module = None): # -> [ unit-names,... ]
""" reads all unit files, returns the first filename for the unit given """
if self._file_for_unit_sysd is None:
self._file_for_unit_sysd = {}
for folder in self.sysd_folders():
if not folder:
continue
folder = os_path(self._root, folder)
if not os.path.isdir(folder):
continue
for name in os.listdir(folder):
path = os.path.join(folder, name)
if os.path.isdir(path):
continue
service_name = name
if service_name not in self._file_for_unit_sysd:
self._file_for_unit_sysd[service_name] = path
logg.debug("found %s sysd files", len(self._file_for_unit_sysd))
return list(self._file_for_unit_sysd.keys())
def scan_unit_sysv_files(self, module = None): # -> [ unit-names,... ]
""" reads all init.d files, returns the first filename when unit is a '.service' """
if self._file_for_unit_sysv is None:
self._file_for_unit_sysv = {}
for folder in self.init_folders():
if not folder:
continue
folder = os_path(self._root, folder)
if not os.path.isdir(folder):
continue
for name in os.listdir(folder):
path = os.path.join(folder, name)
if os.path.isdir(path):
continue
service_name = name + ".service" # simulate systemd
if service_name not in self._file_for_unit_sysv:
self._file_for_unit_sysv[service_name] = path
logg.debug("found %s sysv files", len(self._file_for_unit_sysv))
return list(self._file_for_unit_sysv.keys())
def unit_sysd_file(self, module = None): # -> filename?
""" file path for the given module (systemd) """
self.scan_unit_sysd_files()
assert self._file_for_unit_sysd is not None
if module and module in self._file_for_unit_sysd:
return self._file_for_unit_sysd[module]
if module and unit_of(module) in self._file_for_unit_sysd:
return self._file_for_unit_sysd[unit_of(module)]
return None
def unit_sysv_file(self, module = None): # -> filename?
""" file path for the given module (sysv) """
self.scan_unit_sysv_files()
assert self._file_for_unit_sysv is not None
if module and module in self._file_for_unit_sysv:
return self._file_for_unit_sysv[module]
if module and unit_of(module) in self._file_for_unit_sysv:
return self._file_for_unit_sysv[unit_of(module)]
return None
def unit_file(self, module = None): # -> filename?
""" file path for the given module (sysv or systemd) """
path = self.unit_sysd_file(module)
if path is not None: return path
path = self.unit_sysv_file(module)
if path is not None: return path
return None
def is_sysv_file(self, filename):
""" for routines that have a special treatment for init.d services """
self.unit_file() # scan all
assert self._file_for_unit_sysd is not None
assert self._file_for_unit_sysv is not None
if not filename: return None
if filename in self._file_for_unit_sysd.values(): return False
if filename in self._file_for_unit_sysv.values(): return True
return None # not True
def is_user_conf(self, conf):
if not conf: # pragma: no cover (is never null)
return False
filename = conf.nonloaded_path or conf.filename()
if filename and "/user/" in filename:
return True
return False
def not_user_conf(self, conf):
""" conf can not be started as user service (when --user)"""
if conf is None: # pragma: no cover (is never null)
return True
if not self.user_mode():
logg.debug("%s no --user mode >> accept", strQ(conf.filename()))
return False
if self.is_user_conf(conf):
logg.debug("%s is /user/ conf >> accept", strQ(conf.filename()))
return False
# to allow for 'docker run -u user' with system services
user = self.get_User(conf)
if user and user == self.user():
logg.debug("%s with User=%s >> accept", strQ(conf.filename()), user)
return False
return True
def find_drop_in_files(self, unit):
""" search for some.service.d/extra.conf files """
result = {}
basename_d = unit + ".d"
for folder in self.sysd_folders():
if not folder:
continue
folder = os_path(self._root, folder)
override_d = os_path(folder, basename_d)
if not os.path.isdir(override_d):
continue
for name in os.listdir(override_d):
path = os.path.join(override_d, name)
if os.path.isdir(path):
continue
if not path.endswith(".conf"):
continue
if name not in result:
result[name] = path
return result
def load_sysd_template_conf(self, module): # -> conf?
""" read the unit template with a UnitConfParser (systemd) """
if module and "@" in module:
unit = parse_unit(module)
service = "%s@.service" % unit.prefix
conf = self.load_sysd_unit_conf(service)
if conf:
conf.module = module
return conf
return None
def load_sysd_unit_conf(self, module): # -> conf?
""" read the unit file with a UnitConfParser (systemd) """
path = self.unit_sysd_file(module)
if not path: return None
assert self._loaded_file_sysd is not None
if path in self._loaded_file_sysd:
return self._loaded_file_sysd[path]
masked = None
if os.path.islink(path) and os.readlink(path).startswith("/dev"):
masked = os.readlink(path)
drop_in_files = {}
data = UnitConfParser()
if not masked:
data.read_sysd(path)
drop_in_files = self.find_drop_in_files(os.path.basename(path))
# load in alphabetic order, irrespective of location
for name in sorted(drop_in_files):
path = drop_in_files[name]
data.read_sysd(path)
conf = SystemctlConf(data, module)
conf.masked = masked
conf.nonloaded_path = path # if masked
conf.drop_in_files = drop_in_files
conf._root = self._root
self._loaded_file_sysd[path] = conf
return conf
def load_sysv_unit_conf(self, module): # -> conf?
""" read the unit file with a UnitConfParser (sysv) """
path = self.unit_sysv_file(module)
if not path: return None
assert self._loaded_file_sysv is not None
if path in self._loaded_file_sysv:
return self._loaded_file_sysv[path]
data = UnitConfParser()
data.read_sysv(path)
conf = SystemctlConf(data, module)
conf._root = self._root
self._loaded_file_sysv[path] = conf
return conf
def load_unit_conf(self, module): # -> conf | None(not-found)
""" read the unit file with a UnitConfParser (sysv or systemd) """
try:
conf = self.load_sysd_unit_conf(module)
if conf is not None:
return conf
conf = self.load_sysd_template_conf(module)
if conf is not None:
return conf
conf = self.load_sysv_unit_conf(module)
if conf is not None:
return conf
except Exception as e:
logg.warning("%s not loaded: %s", module, e)
return None
def default_unit_conf(self, module, description = None): # -> conf
""" a unit conf that can be printed to the user where
attributes are empty and loaded() is False """
data = UnitConfParser()
data.set(Unit, "Description", description or ("NOT-FOUND " + str(module)))
# assert(not data.loaded())
conf = SystemctlConf(data, module)
conf._root = self._root
return conf
def get_unit_conf(self, module): # -> conf (conf | default-conf)
""" accept that a unit does not exist
and return a unit conf that says 'not-loaded' """
conf = self.load_unit_conf(module)
if conf is not None:
return conf
return self.default_unit_conf(module)
def get_unit_type(self, module):
name, ext = os.path.splitext(module)
if ext in [".service", ".socket", ".target"]:
return ext[1:]
return None
def get_unit_section(self, module, default = Service):
return string.capwords(self.get_unit_type(module) or default)
def get_unit_section_from(self, conf, default = Service):
return self.get_unit_section(conf.name(), default)
def match_sysd_templates(self, modules = None, suffix=".service"): # -> generate[ unit ]
""" make a file glob on all known template units (systemd areas).
It returns no modules (!!) if no modules pattern were given.
The module string should contain an instance name already. """
modules = to_list(modules)
if not modules:
return
self.scan_unit_sysd_files()
assert self._file_for_unit_sysd is not None
for item in sorted(self._file_for_unit_sysd.keys()):
if "@" not in item:
continue
service_unit = parse_unit(item)
for module in modules:
if "@" not in module:
continue
module_unit = parse_unit(module)
if service_unit.prefix == module_unit.prefix:
yield "%s@%s.%s" % (service_unit.prefix, module_unit.instance, service_unit.suffix)
def match_sysd_units(self, modules = None, suffix=".service"): # -> generate[ unit ]
""" make a file glob on all known units (systemd areas).
It returns all modules if no modules pattern were given.
Also a single string as one module pattern may be given. """
modules = to_list(modules)
self.scan_unit_sysd_files()
assert self._file_for_unit_sysd is not None
for item in sorted(self._file_for_unit_sysd.keys()):
if "." not in item:
pass
elif not modules:
yield item
elif [module for module in modules if fnmatch.fnmatchcase(item, module)]:
yield item
elif [module for module in modules if module+suffix == item]:
yield item
def match_sysv_units(self, modules = None, suffix=".service"): # -> generate[ unit ]
""" make a file glob on all known units (sysv areas).
It returns all modules if no modules pattern were given.
Also a single string as one module pattern may be given. """
modules = to_list(modules)
self.scan_unit_sysv_files()
assert self._file_for_unit_sysv is not None
for item in sorted(self._file_for_unit_sysv.keys()):
if not modules:
yield item
elif [module for module in modules if fnmatch.fnmatchcase(item, module)]:
yield item
elif [module for module in modules if module+suffix == item]:
yield item
def match_units(self, modules = None, suffix=".service"): # -> [ units,.. ]
""" Helper for about any command with multiple units which can
actually be glob patterns on their respective unit name.
It returns all modules if no modules pattern were given.
Also a single string as one module pattern may be given. """
found = []
for unit in self.match_sysd_units(modules, suffix):
if unit not in found:
found.append(unit)
for unit in self.match_sysd_templates(modules, suffix):
if unit not in found:
found.append(unit)
for unit in self.match_sysv_units(modules, suffix):
if unit not in found:
found.append(unit)
return found
def list_service_unit_basics(self):
""" show all the basic loading state of services """
filename = self.unit_file() # scan all
assert self._file_for_unit_sysd is not None
assert self._file_for_unit_sysv is not None
result = []
for name, value in self._file_for_unit_sysd.items():
result += [(name, "SysD", value)]
for name, value in self._file_for_unit_sysv.items():
result += [(name, "SysV", value)]
return result
def list_service_units(self, *modules): # -> [ (unit,loaded+active+substate,description) ]
""" show all the service units """
result = {}
active = {}
substate = {}
description = {}
for unit in self.match_units(to_list(modules)):
result[unit] = "not-found"
active[unit] = "inactive"
substate[unit] = "dead"
description[unit] = ""
try:
conf = self.get_unit_conf(unit)
result[unit] = "loaded"
description[unit] = self.get_description_from(conf)
active[unit] = self.get_active_from(conf)
substate[unit] = self.get_substate_from(conf) or "unknown"
except Exception as e:
logg.warning("list-units: %s", e)
if self._only_state:
if result[unit] in self._only_state:
pass
elif active[unit] in self._only_state:
pass
elif substate[unit] in self._only_state:
pass
else:
del result[unit]
return [(unit, result[unit] + " " + active[unit] + " " + substate[unit], description[unit]) for unit in sorted(result)]
def list_units_modules(self, *modules): # -> [ (unit,loaded,description) ]
""" [PATTERN]... -- List loaded units.
If one or more PATTERNs are specified, only units matching one of
them are shown. NOTE: This is the default command."""
hint = "To show all installed unit files use 'systemctl list-unit-files'."
result = self.list_service_units(*modules)
if self._no_legend:
return result
found = "%s loaded units listed." % len(result)
return result + [("", "", ""), (found, "", ""), (hint, "", "")]
def list_service_unit_files(self, *modules): # -> [ (unit,enabled) ]
""" show all the service units and the enabled status"""
logg.debug("list service unit files for %s", modules)
result = {}
enabled = {}
for unit in self.match_units(to_list(modules)):
if self._only_type and self.get_unit_type(unit) not in self._only_type:
continue
result[unit] = None
enabled[unit] = ""
try:
conf = self.get_unit_conf(unit)
if self.not_user_conf(conf):
result[unit] = None
continue
result[unit] = conf
enabled[unit] = self.enabled_from(conf)
except Exception as e:
logg.warning("list-units: %s", e)
return [(unit, enabled[unit]) for unit in sorted(result) if result[unit]]
def each_target_file(self):
folders = self.system_folders()
if self.user_mode():
folders = self.user_folders()
for folder1 in folders:
folder = os_path(self._root, folder1)
if not os.path.isdir(folder):
continue
for filename in os.listdir(folder):
if filename.endswith(".target"):
yield (filename, os.path.join(folder, filename))
def list_target_unit_files(self, *modules): # -> [ (unit,enabled) ]
""" show all the target units and the enabled status"""
enabled = {}
targets = {}
for target, filepath in self.each_target_file():
logg.info("target %s", filepath)
targets[target] = filepath
enabled[target] = "static"
for unit in _all_common_targets:
targets[unit] = None
enabled[unit] = "static"
if unit in _all_common_enabled:
enabled[unit] = "enabled"
if unit in _all_common_disabled:
enabled[unit] = "disabled"
return [(unit, enabled[unit]) for unit in sorted(targets)]
def list_unit_files_modules(self, *modules): # -> [ (unit,enabled) ]
"""[PATTERN]... -- List installed unit files
List installed unit files and their enablement state (as reported
by is-enabled). If one or more PATTERNs are specified, only units
whose filename (just the last component of the path) matches one of
them are shown. This command reacts to limitations of --type being
--type=service or --type=target (and --now for some basics)."""
result = []
if self._now:
basics = self.list_service_unit_basics()
result = [(name, sysv + " " + filename) for name, sysv, filename in basics]
elif self._only_type:
if "target" in self._only_type:
result = self.list_target_unit_files()
if "service" in self._only_type:
result = self.list_service_unit_files()
else:
result = self.list_target_unit_files()
result += self.list_service_unit_files(*modules)
if self._no_legend:
return result
found = "%s unit files listed." % len(result)
return [("UNIT FILE", "STATE")] + result + [("", ""), (found, "")]
##
##
def get_description(self, unit, default = None):
return self.get_description_from(self.load_unit_conf(unit))
def get_description_from(self, conf, default = None): # -> text
""" Unit.Description could be empty sometimes """
if not conf: return default or ""
description = conf.get(Unit, "Description", default or "")
return self.expand_special(description, conf)
def read_pid_file(self, pid_file, default = None):
pid = default
if not pid_file:
return default
if not os.path.isfile(pid_file):
return default
if self.truncate_old(pid_file):
return default
try:
# some pid-files from applications contain multiple lines
with open(pid_file) as f:
for line in f:
if line.strip():
pid = to_intN(line.strip())
break
except Exception as e:
logg.warning("bad read of pid file '%s': %s", pid_file, e)
return pid
def wait_pid_file(self, pid_file, timeout = None): # -> pid?
""" wait some seconds for the pid file to appear and return the pid """
timeout = int(timeout or (DefaultTimeoutStartSec/2))
timeout = max(timeout, (MinimumTimeoutStartSec))
dirpath = os.path.dirname(os.path.abspath(pid_file))
for x in xrange(timeout):
if not os.path.isdir(dirpath):
time.sleep(1) # until TimeoutStartSec/2
continue
pid = self.read_pid_file(pid_file)
if not pid:
time.sleep(1) # until TimeoutStartSec/2
continue
if not pid_exists(pid):
time.sleep(1) # until TimeoutStartSec/2
continue
return pid
return None
def get_status_pid_file(self, unit):
""" actual file path of pid file (internal) """
conf = self.get_unit_conf(unit)
return self.pid_file_from(conf) or self.get_status_file_from(conf)
def pid_file_from(self, conf, default = ""):
""" get the specified pid file path (not a computed default) """
pid_file = self.get_pid_file(conf) or default
return os_path(self._root, self.expand_special(pid_file, conf))
def get_pid_file(self, conf, default = None):
return conf.get(Service, "PIDFile", default)
def read_mainpid_from(self, conf, default = None):
""" MAINPID is either the PIDFile content written from the application
or it is the value in the status file written by this systemctl.py code """
pid_file = self.pid_file_from(conf)
if pid_file:
return self.read_pid_file(pid_file, default)
status = self.read_status_from(conf)
if "MainPID" in status:
return to_intN(status["MainPID"], default)
return default
def clean_pid_file_from(self, conf):
pid_file = self.pid_file_from(conf)
if pid_file and os.path.isfile(pid_file):
try:
os.remove(pid_file)
except OSError as e:
logg.warning("while rm %s: %s", pid_file, e)
self.write_status_from(conf, MainPID=None)
def get_status_file(self, unit): # for testing
conf = self.get_unit_conf(unit)
return self.get_status_file_from(conf)
def get_status_file_from(self, conf, default = None):
status_file = self.get_StatusFile(conf)
# this not a real setting, but do the expand_special anyway
return os_path(self._root, self.expand_special(status_file, conf))
def get_StatusFile(self, conf, default = None): # -> text
""" file where to store a status mark """
status_file = conf.get(Service, "StatusFile", default)
if status_file:
return status_file
root = conf.root_mode()
folder = get_PID_DIR(root)
name = "%s.status" % conf.name()
return os.path.join(folder, name)
def clean_status_from(self, conf):
status_file = self.get_status_file_from(conf)
if os.path.exists(status_file):
os.remove(status_file)
conf.status = {}
def write_status_from(self, conf, **status): # -> bool(written)
""" if a status_file is known then path is created and the
give status is written as the only content. """
status_file = self.get_status_file_from(conf)
# if not status_file: return False
dirpath = os.path.dirname(os.path.abspath(status_file))
if not os.path.isdir(dirpath):
os.makedirs(dirpath)
if conf.status is None:
conf.status = self.read_status_from(conf)
if True:
for key in sorted(status.keys()):
value = status[key]
if key.upper() == "AS": key = "ActiveState"
if key.upper() == "EXIT": key = "ExecMainCode"
if value is None:
try: del conf.status[key]
except KeyError: pass
else:
conf.status[key] = strE(value)
try:
with open(status_file, "w") as f:
for key in sorted(conf.status):
value = conf.status[key]
if key == "MainPID" and str(value) == "0":
logg.warning("ignore writing MainPID=0")
continue
content = "{}={}\n".format(key, str(value))
logg.debug("writing to %s\n\t%s", status_file, content.strip())
f.write(content)
except IOError as e:
logg.error("writing STATUS %s: %s\n\t to status file %s", status, e, status_file)
return True
def read_status_from(self, conf):
status_file = self.get_status_file_from(conf)
status = {}
# if not status_file: return status
if not os.path.isfile(status_file):
if DEBUG_STATUS: logg.debug("no status file: %s\n returning %s", status_file, status)
return status
if self.truncate_old(status_file):
if DEBUG_STATUS: logg.debug("old status file: %s\n returning %s", status_file, status)
return status
try:
if DEBUG_STATUS: logg.debug("reading %s", status_file)
with open(status_file) as f:
for line in f:
if line.strip():
m = re.match(r"(\w+)[:=](.*)", line)
if m:
key, value = m.group(1), m.group(2)
if key.strip():
status[key.strip()] = value.strip()
else: # pragma: no cover
logg.warning("ignored %s", line.strip())
except:
logg.warning("bad read of status file '%s'", status_file)
return status
def get_status_from(self, conf, name, default = None):
if conf.status is None:
conf.status = self.read_status_from(conf)
return conf.status.get(name, default)
def set_status_from(self, conf, name, value):
if conf.status is None:
conf.status = self.read_status_from(conf)
if value is None:
try: del conf.status[name]
except KeyError: pass
else:
conf.status[name] = value
#
def get_boottime(self):
""" detects the boot time of the container - in general the start time of PID 1 """
if self._boottime is None:
self._boottime = self.get_boottime_from_proc()
assert self._boottime is not None
return self._boottime
def get_boottime_from_proc(self):
""" detects the latest boot time by looking at the start time of available process"""
pid1 = BOOT_PID_MIN or 0
pid_max = BOOT_PID_MAX
if pid_max < 0:
pid_max = pid1 - pid_max
for pid in xrange(pid1, pid_max):
proc = _proc_pid_stat.format(**locals())
try:
if os.path.exists(proc):
# return os.path.getmtime(proc) # did sometimes change
return self.path_proc_started(proc)
except Exception as e: # pragma: no cover
logg.warning("boottime - could not access %s: %s", proc, e)
if DEBUG_BOOTTIME:
logg.debug(" boottime from the oldest entry in /proc [nothing in %s..%s]", pid1, pid_max)
return self.get_boottime_from_old_proc()
def get_boottime_from_old_proc(self):
booted = time.time()
for pid in os.listdir(_proc_pid_dir):
proc = _proc_pid_stat.format(**locals())
try:
if os.path.exists(proc):
# ctime = os.path.getmtime(proc)
ctime = self.path_proc_started(proc)
if ctime < booted:
booted = ctime
except Exception as e: # pragma: no cover
logg.warning("could not access %s: %s", proc, e)
return booted
# Use uptime, time process running in ticks, and current time to determine process boot time
# You can't use the modified timestamp of the status file because it isn't static.
# ... using clock ticks it is known to be a linear time on Linux
def path_proc_started(self, proc):
# get time process started after boot in clock ticks
with open(proc) as file_stat:
data_stat = file_stat.readline()
file_stat.close()
stat_data = data_stat.split()
started_ticks = stat_data[21]
# man proc(5): "(22) starttime = The time the process started after system boot."
# ".. the value is expressed in clock ticks (divide by sysconf(_SC_CLK_TCK))."
# NOTE: for containers the start time is related to the boot time of host system.
clkTickInt = os.sysconf_names['SC_CLK_TCK']
clockTicksPerSec = os.sysconf(clkTickInt)
started_secs = float(started_ticks) / clockTicksPerSec
if DEBUG_BOOTTIME:
logg.debug(" BOOT .. Proc started time: %.3f (%s)", started_secs, proc)
# this value is the start time from the host system
# Variant 1:
system_uptime = _proc_sys_uptime
with open(system_uptime, "rb") as file_uptime:
data_uptime = file_uptime.readline()
file_uptime.close()
uptime_data = data_uptime.decode().split()
uptime_secs = float(uptime_data[0])
if DEBUG_BOOTTIME:
logg.debug(" BOOT 1. System uptime secs: %.3f (%s)", uptime_secs, system_uptime)
# get time now
now = time.time()
started_time = now - (uptime_secs - started_secs)
if DEBUG_BOOTTIME:
logg.debug(" BOOT 1. Proc has been running since: %s" % (datetime.datetime.fromtimestamp(started_time)))
# Variant 2:
system_stat = _proc_sys_stat
system_btime = 0.
with open(system_stat, "rb") as f:
for line in f:
assert isinstance(line, bytes)
if line.startswith(b"btime"):
system_btime = float(line.decode().split()[1])
if DEBUG_BOOTTIME:
logg.debug(" BOOT 2. System btime secs: %.3f (%s)", system_btime, system_stat)
started_btime = system_btime + started_secs
if DEBUG_BOOTTIME:
logg.debug(" BOOT 2. Proc has been running since: %s" % (datetime.datetime.fromtimestamp(started_btime)))
# return started_time
return started_btime
def get_filetime(self, filename):
return os.path.getmtime(filename)
def truncate_old(self, filename):
filetime = self.get_filetime(filename)
boottime = self.get_boottime()
if filetime >= boottime:
if DEBUG_BOOTTIME:
logg.debug(" file time: %s (%s)", datetime.datetime.fromtimestamp(filetime), o22(filename))
logg.debug(" boot time: %s (%s)", datetime.datetime.fromtimestamp(boottime), "status modified later")
return False # OK
if DEBUG_BOOTTIME:
logg.info(" file time: %s (%s)", datetime.datetime.fromtimestamp(filetime), o22(filename))
logg.info(" boot time: %s (%s)", datetime.datetime.fromtimestamp(boottime), "status TRUNCATED NOW")
try:
shutil_truncate(filename)
except Exception as e:
logg.warning("while truncating: %s", e)
return True # truncated
def getsize(self, filename):
if filename is None: # pragma: no cover (is never null)
return 0
if not os.path.isfile(filename):
return 0
if self.truncate_old(filename):
return 0
try:
return os.path.getsize(filename)
except Exception as e:
logg.warning("while reading file size: %s\n of %s", e, filename)
return 0
#
def read_env_file(self, env_file): # -> generate[ (name,value) ]
""" EnvironmentFile=<name> is being scanned """
mode, env_file = load_path(env_file)
real_file = os_path(self._root, env_file)
if not os.path.exists(real_file):
if mode.check:
logg.error("file does not exist: %s", real_file)
else:
logg.debug("file does not exist: %s", real_file)
return
try:
with open(os_path(self._root, env_file)) as f:
for real_line in f:
line = real_line.strip()
if not line or line.startswith("#"):
continue
m = re.match(r"(?:export +)?([\w_]+)[=]'([^']*)'", line)
if m:
yield m.group(1), m.group(2)
continue
m = re.match(r'(?:export +)?([\w_]+)[=]"([^"]*)"', line)
if m:
yield m.group(1), m.group(2)
continue
m = re.match(r'(?:export +)?([\w_]+)[=](.*)', line)
if m:
yield m.group(1), m.group(2)
continue
except Exception as e:
logg.info("while reading %s: %s", env_file, e)
def read_env_part(self, env_part): # -> generate[ (name, value) ]
""" Environment=<name>=<value> is being scanned """
# systemd Environment= spec says it is a space-separated list of
# assignments. In order to use a space or an equals sign in a value
# one should enclose the whole assignment with double quotes:
# Environment="VAR1=word word" VAR2=word3 "VAR3=$word 5 6"
# and the $word is not expanded by other environment variables.
try:
for real_line in env_part.split("\n"):
line = real_line.strip()
for found in re.finditer(r'\s*("[\w_]+=[^"]*"|[\w_]+=\S*)', line):
part = found.group(1)
if part.startswith('"'):
part = part[1:-1]
name, value = part.split("=", 1)
yield name, value
except Exception as e:
logg.info("while reading %s: %s", env_part, e)
def command_of_unit(self, unit):
""" [UNIT]. -- show service settings (experimental)
or use -p VarName to show another property than 'ExecStart' """
conf = self.load_unit_conf(unit)
if conf is None:
logg.error("Unit %s could not be found.", unit)
self.error |= NOT_FOUND
return None
if self._only_property:
found = []
for prop in self._only_property:
found += conf.getlist(Service, prop)
return found
return conf.getlist(Service, "ExecStart")
def environment_of_unit(self, unit):
""" [UNIT]. -- show environment parts """
conf = self.load_unit_conf(unit)
if conf is None:
logg.error("Unit %s could not be found.", unit)
self.error |= NOT_FOUND
return None
return self.get_env(conf)
def extra_vars(self):
return self._extra_vars # from command line
def get_env(self, conf):
env = os.environ.copy()
for env_part in conf.getlist(Service, "Environment", []):
for name, value in self.read_env_part(self.expand_special(env_part, conf)):
env[name] = value # a '$word' is not special here (lazy expansion)
for env_file in conf.getlist(Service, "EnvironmentFile", []):
for name, value in self.read_env_file(self.expand_special(env_file, conf)):
env[name] = self.expand_env(value, env) # but nonlazy expansion here
logg.debug("extra-vars %s", self.extra_vars())
for extra in self.extra_vars():
if extra.startswith("@"):
for name, value in self.read_env_file(extra[1:]):
logg.info("override %s=%s", name, value)
env[name] = self.expand_env(value, env)
else:
for name, value in self.read_env_part(extra):
logg.info("override %s=%s", name, value)
env[name] = value # a '$word' is not special here
return env
def expand_env(self, cmd, env):
def get_env1(m):
name = m.group(1)
if name in env:
return env[name]
namevar = "$%s" % name
logg.debug("can not expand %s", namevar)
return (EXPAND_KEEP_VARS and namevar or "")
def get_env2(m):
name = m.group(1)
if name in env:
return env[name]
namevar = "${%s}" % name
logg.debug("can not expand %s", namevar)
return (EXPAND_KEEP_VARS and namevar or "")
#
maxdepth = EXPAND_VARS_MAXDEPTH
expanded = re.sub(r"[$](\w+)", lambda m: get_env1(m), cmd.replace("\\\n", ""))
for depth in xrange(maxdepth):
new_text = re.sub(r"[$][{](\w+)[}]", lambda m: get_env2(m), expanded)
if new_text == expanded:
return expanded
expanded = new_text
logg.error("shell variable expansion exceeded maxdepth %s", maxdepth)
return expanded
def expand_special(self, cmd, conf):
""" expand %i %t and similar special vars. They are being expanded
before any other expand_env takes place which handles shell-style
$HOME references. """
def xx(arg): return unit_name_unescape(arg)
def yy(arg): return arg
def get_confs(conf):
confs={"%": "%"}
if conf is None: # pragma: no cover (is never null)
return confs
unit = parse_unit(conf.name())
#
root = conf.root_mode()
VARTMP = get_VARTMP(root) # $TMPDIR # "/var/tmp"
TMP = get_TMP(root) # $TMPDIR # "/tmp"
RUN = get_RUNTIME_DIR(root) # $XDG_RUNTIME_DIR # "/run"
ETC = get_CONFIG_HOME(root) # $XDG_CONFIG_HOME # "/etc"
DAT = get_VARLIB_HOME(root) # $XDG_CONFIG_HOME # "/var/lib"
LOG = get_LOG_DIR(root) # $XDG_CONFIG_HOME/log # "/var/log"
CACHE = get_CACHE_HOME(root) # $XDG_CACHE_HOME # "/var/cache"
HOME = get_HOME(root) # $HOME or ~ # "/root"
USER = get_USER(root) # geteuid().pw_name # "root"
USER_ID = get_USER_ID(root) # geteuid() # 0
GROUP = get_GROUP(root) # getegid().gr_name # "root"
GROUP_ID = get_GROUP_ID(root) # getegid() # 0
SHELL = get_SHELL(root) # $SHELL # "/bin/sh"
# confs["b"] = boot_ID
confs["C"] = os_path(self._root, CACHE) # Cache directory root
confs["E"] = os_path(self._root, ETC) # Configuration directory root
confs["F"] = strE(conf.filename()) # EXTRA
confs["f"] = "/%s" % xx(unit.instance or unit.prefix)
confs["h"] = HOME # User home directory
# confs["H"] = host_NAME
confs["i"] = yy(unit.instance)
confs["I"] = xx(unit.instance) # same as %i but escaping undone
confs["j"] = yy(unit.component) # final component of the prefix
confs["J"] = xx(unit.component) # unescaped final component
confs["L"] = os_path(self._root, LOG)
# confs["m"] = machine_ID
confs["n"] = yy(unit.fullname) # Full unit name
confs["N"] = yy(unit.name) # Same as "%n", but with the type suffix removed.
confs["p"] = yy(unit.prefix) # before the first "@" or same as %n
confs["P"] = xx(unit.prefix) # same as %p but escaping undone
confs["s"] = SHELL
confs["S"] = os_path(self._root, DAT)
confs["t"] = os_path(self._root, RUN)
confs["T"] = os_path(self._root, TMP)
confs["g"] = GROUP
confs["G"] = str(GROUP_ID)
confs["u"] = USER
confs["U"] = str(USER_ID)
confs["V"] = os_path(self._root, VARTMP)
return confs
def get_conf1(m):
confs = get_confs(conf)
if m.group(1) in confs:
return confs[m.group(1)]
logg.warning("can not expand %%%s", m.group(1))
return ""
result = ""
if cmd:
result = re.sub("[%](.)", lambda m: get_conf1(m), cmd)
# ++# logg.info("expanded => %s", result)
return result
def exec_newcmd(self, cmd, env, conf):
mode, exe = exec_path(cmd)
if mode.noexpand:
newcmd = self.split_cmd(exe)
else:
newcmd = self.expand_cmd(exe, env, conf)
if mode.argv0:
if len(newcmd) > 1:
del newcmd[1] # TODO: keep but allow execve calls to pick it up
return mode, newcmd
def split_cmd(self, cmd):
cmd2 = cmd.replace("\\\n", "")
newcmd = []
for part in shlex.split(cmd2):
newcmd += [part]
return newcmd
def expand_cmd(self, cmd, env, conf):
""" expand ExecCmd statements including %i and $MAINPID """
cmd2 = cmd.replace("\\\n", "")
# according to documentation, when bar="one two" then the expansion
# of '$bar' is ["one","two"] and '${bar}' becomes ["one two"]. We
# tackle that by expand $bar before shlex, and the rest thereafter.
def get_env1(m):
name = m.group(1)
if name in env:
return env[name]
logg.debug("can not expand $%s", name)
return "" # empty string
def get_env2(m):
name = m.group(1)
if name in env:
return env[name]
logg.debug("can not expand $%s}}", name)
return "" # empty string
cmd3 = re.sub(r"[$](\w+)", lambda m: get_env1(m), cmd2)
newcmd = []
for part in shlex.split(cmd3):
part2 = self.expand_special(part, conf)
newcmd += [re.sub(r"[$][{](\w+)[}]", lambda m: get_env2(m), part2)] # type: ignore[arg-type]
return newcmd
def remove_service_directories(self, conf, section = Service):
# |
ok = True
nameRuntimeDirectory = self.get_RuntimeDirectory(conf, section)
keepRuntimeDirectory = self.get_RuntimeDirectoryPreserve(conf, section)
if not keepRuntimeDirectory:
root = conf.root_mode()
for name in nameRuntimeDirectory.split(" "):
if not name.strip(): continue
RUN = get_RUNTIME_DIR(root)
path = os.path.join(RUN, name)
dirpath = os_path(self._root, path)
ok = self.do_rm_tree(dirpath) and ok
if RUN == "/run":
for var_run in ("/var/run", "/tmp/run"):
if os.path.isdir(var_run):
var_path = os.path.join(var_run, name)
var_dirpath = os_path(self._root, var_path)
self.do_rm_tree(var_dirpath)
if not ok:
logg.debug("could not fully remove service directory %s", path)
return ok
def do_rm_tree(self, path):
ok = True
if os.path.isdir(path):
for dirpath, dirnames, filenames in os.walk(path, topdown=False):
for item in filenames:
filepath = os.path.join(dirpath, item)
try:
os.remove(filepath)
except Exception as e: # pragma: no cover
logg.debug("not removed file: %s (%s)", filepath, e)
ok = False
for item in dirnames:
dir_path = os.path.join(dirpath, item)
try:
os.rmdir(dir_path)
except Exception as e: # pragma: no cover
logg.debug("not removed dir: %s (%s)", dir_path, e)
ok = False
try:
os.rmdir(path)
except Exception as e:
logg.debug("not removed top dir: %s (%s)", path, e)
ok = False # pragma: no cover
logg.debug("%s rm_tree %s", ok and "done" or "fail", path)
return ok
def get_RuntimeDirectoryPreserve(self, conf, section = Service):
return conf.getbool(section, "RuntimeDirectoryPreserve", "no")
def get_RuntimeDirectory(self, conf, section = Service):
return self.expand_special(conf.get(section, "RuntimeDirectory", ""), conf)
def get_StateDirectory(self, conf, section = Service):
return self.expand_special(conf.get(section, "StateDirectory", ""), conf)
def get_CacheDirectory(self, conf, section = Service):
return self.expand_special(conf.get(section, "CacheDirectory", ""), conf)
def get_LogsDirectory(self, conf, section = Service):
return self.expand_special(conf.get(section, "LogsDirectory", ""), conf)
def get_ConfigurationDirectory(self, conf, section = Service):
return self.expand_special(conf.get(section, "ConfigurationDirectory", ""), conf)
def get_RuntimeDirectoryMode(self, conf, section = Service):
return conf.get(section, "RuntimeDirectoryMode", "")
def get_StateDirectoryMode(self, conf, section = Service):
return conf.get(section, "StateDirectoryMode", "")
def get_CacheDirectoryMode(self, conf, section = Service):
return conf.get(section, "CacheDirectoryMode", "")
def get_LogsDirectoryMode(self, conf, section = Service):
return conf.get(section, "LogsDirectoryMode", "")
def get_ConfigurationDirectoryMode(self, conf, section = Service):
return conf.get(section, "ConfigurationDirectoryMode", "")
def clean_service_directories(self, conf, which = ""):
ok = True
section = self.get_unit_section_from(conf)
nameRuntimeDirectory = self.get_RuntimeDirectory(conf, section)
nameStateDirectory = self.get_StateDirectory(conf, section)
nameCacheDirectory = self.get_CacheDirectory(conf, section)
nameLogsDirectory = self.get_LogsDirectory(conf, section)
nameConfigurationDirectory = self.get_ConfigurationDirectory(conf, section)
root = conf.root_mode()
for name in nameRuntimeDirectory.split(" "):
if not name.strip(): continue
RUN = get_RUNTIME_DIR(root)
path = os.path.join(RUN, name)
if which in ["all", "runtime", ""]:
dirpath = os_path(self._root, path)
ok = self.do_rm_tree(dirpath) and ok
if RUN == "/run":
for var_run in ("/var/run", "/tmp/run"):
var_path = os.path.join(var_run, name)
var_dirpath = os_path(self._root, var_path)
self.do_rm_tree(var_dirpath)
for name in nameStateDirectory.split(" "):
if not name.strip(): continue
DAT = get_VARLIB_HOME(root)
path = os.path.join(DAT, name)
if which in ["all", "state"]:
dirpath = os_path(self._root, path)
ok = self.do_rm_tree(dirpath) and ok
for name in nameCacheDirectory.split(" "):
if not name.strip(): continue
CACHE = get_CACHE_HOME(root)
path = os.path.join(CACHE, name)
if which in ["all", "cache", ""]:
dirpath = os_path(self._root, path)
ok = self.do_rm_tree(dirpath) and ok
for name in nameLogsDirectory.split(" "):
if not name.strip(): continue
LOGS = get_LOG_DIR(root)
path = os.path.join(LOGS, name)
if which in ["all", "logs"]:
dirpath = os_path(self._root, path)
ok = self.do_rm_tree(dirpath) and ok
for name in nameConfigurationDirectory.split(" "):
if not name.strip(): continue
CONFIG = get_CONFIG_HOME(root)
path = os.path.join(CONFIG, name)
if which in ["all", "configuration", ""]:
dirpath = os_path(self._root, path)
ok = self.do_rm_tree(dirpath) and ok
return ok
def env_service_directories(self, conf):
envs = {}
section = self.get_unit_section_from(conf)
nameRuntimeDirectory = self.get_RuntimeDirectory(conf, section)
nameStateDirectory = self.get_StateDirectory(conf, section)
nameCacheDirectory = self.get_CacheDirectory(conf, section)
nameLogsDirectory = self.get_LogsDirectory(conf, section)
nameConfigurationDirectory = self.get_ConfigurationDirectory(conf, section)
root = conf.root_mode()
for name in nameRuntimeDirectory.split(" "):
if not name.strip(): continue
RUN = get_RUNTIME_DIR(root)
path = os.path.join(RUN, name)
envs["RUNTIME_DIRECTORY"] = path
for name in nameStateDirectory.split(" "):
if not name.strip(): continue
DAT = get_VARLIB_HOME(root)
path = os.path.join(DAT, name)
envs["STATE_DIRECTORY"] = path
for name in nameCacheDirectory.split(" "):
if not name.strip(): continue
CACHE = get_CACHE_HOME(root)
path = os.path.join(CACHE, name)
envs["CACHE_DIRECTORY"] = path
for name in nameLogsDirectory.split(" "):
if not name.strip(): continue
LOGS = get_LOG_DIR(root)
path = os.path.join(LOGS, name)
envs["LOGS_DIRECTORY"] = path
for name in nameConfigurationDirectory.split(" "):
if not name.strip(): continue
CONFIG = get_CONFIG_HOME(root)
path = os.path.join(CONFIG, name)
envs["CONFIGURATION_DIRECTORY"] = path
return envs
def create_service_directories(self, conf):
envs = {}
section = self.get_unit_section_from(conf)
nameRuntimeDirectory = self.get_RuntimeDirectory(conf, section)
modeRuntimeDirectory = self.get_RuntimeDirectoryMode(conf, section)
nameStateDirectory = self.get_StateDirectory(conf, section)
modeStateDirectory = self.get_StateDirectoryMode(conf, section)
nameCacheDirectory = self.get_CacheDirectory(conf, section)
modeCacheDirectory = self.get_CacheDirectoryMode(conf, section)
nameLogsDirectory = self.get_LogsDirectory(conf, section)
modeLogsDirectory = self.get_LogsDirectoryMode(conf, section)
nameConfigurationDirectory = self.get_ConfigurationDirectory(conf, section)
modeConfigurationDirectory = self.get_ConfigurationDirectoryMode(conf, section)
root = conf.root_mode()
user = self.get_User(conf)
group = self.get_Group(conf)
for name in nameRuntimeDirectory.split(" "):
if not name.strip(): continue
RUN = get_RUNTIME_DIR(root)
path = os.path.join(RUN, name)
logg.debug("RuntimeDirectory %s", path)
self.make_service_directory(path, modeRuntimeDirectory)
self.chown_service_directory(path, user, group)
envs["RUNTIME_DIRECTORY"] = path
if RUN == "/run":
for var_run in ("/var/run", "/tmp/run"):
if os.path.isdir(var_run):
var_path = os.path.join(var_run, name)
var_dirpath = os_path(self._root, var_path)
if os.path.isdir(var_dirpath):
if not os.path.islink(var_dirpath):
logg.debug("not a symlink: %s", var_dirpath)
continue
dirpath = os_path(self._root, path)
basepath = os.path.dirname(var_dirpath)
if not os.path.isdir(basepath):
os.makedirs(basepath)
try:
os.symlink(dirpath, var_dirpath)
except Exception as e:
logg.debug("var symlink %s\n\t%s", var_dirpath, e)
for name in nameStateDirectory.split(" "):
if not name.strip(): continue
DAT = get_VARLIB_HOME(root)
path = os.path.join(DAT, name)
logg.debug("StateDirectory %s", path)
self.make_service_directory(path, modeStateDirectory)
self.chown_service_directory(path, user, group)
envs["STATE_DIRECTORY"] = path
for name in nameCacheDirectory.split(" "):
if not name.strip(): continue
CACHE = get_CACHE_HOME(root)
path = os.path.join(CACHE, name)
logg.debug("CacheDirectory %s", path)
self.make_service_directory(path, modeCacheDirectory)
self.chown_service_directory(path, user, group)
envs["CACHE_DIRECTORY"] = path
for name in nameLogsDirectory.split(" "):
if not name.strip(): continue
LOGS = get_LOG_DIR(root)
path = os.path.join(LOGS, name)
logg.debug("LogsDirectory %s", path)
self.make_service_directory(path, modeLogsDirectory)
self.chown_service_directory(path, user, group)
envs["LOGS_DIRECTORY"] = path
for name in nameConfigurationDirectory.split(" "):
if not name.strip(): continue
CONFIG = get_CONFIG_HOME(root)
path = os.path.join(CONFIG, name)
logg.debug("ConfigurationDirectory %s", path)
self.make_service_directory(path, modeConfigurationDirectory)
# not done according the standard
# self.chown_service_directory(path, user, group)
envs["CONFIGURATION_DIRECTORY"] = path
return envs
def make_service_directory(self, path, mode):
ok = True
dirpath = os_path(self._root, path)
if not os.path.isdir(dirpath):
try:
os.makedirs(dirpath)
logg.info("created directory path: %s", dirpath)
except Exception as e: # pragma: no cover
logg.debug("errors directory path: %s\n\t%s", dirpath, e)
ok = False
filemode = int_mode(mode)
if filemode:
try:
os.chmod(dirpath, filemode)
except Exception as e: # pragma: no cover
logg.debug("errors directory path: %s\n\t%s", dirpath, e)
ok = False
else:
logg.debug("path did already exist: %s", dirpath)
if not ok:
logg.debug("could not fully create service directory %s", path)
return ok
def chown_service_directory(self, path, user, group):
# the standard defines an optimization so that if the parent
# directory does have the correct user and group then there
# is no other chown on files and subdirectories to be done.
dirpath = os_path(self._root, path)
if not os.path.isdir(dirpath):
logg.debug("chown did not find %s", dirpath)
return True
if user or group:
st = os.stat(dirpath)
st_user = pwd.getpwuid(st.st_uid).pw_name
st_group = grp.getgrgid(st.st_gid).gr_name
change = False
if user and (user.strip() != st_user and user.strip() != str(st.st_uid)):
change = True
if group and (group.strip() != st_group and group.strip() != str(st.st_gid)):
change = True
if change:
logg.debug("do chown %s", dirpath)
try:
ok = self.do_chown_tree(dirpath, user, group)
logg.info("changed %s:%s %s", user, group, ok)
return ok
except Exception as e:
logg.info("oops %s\n\t%s", dirpath, e)
else:
logg.debug("untouched %s", dirpath)
return True
def do_chown_tree(self, path, user, group):
ok = True
uid, gid = -1, -1
if user:
uid = pwd.getpwnam(user).pw_uid
gid = pwd.getpwnam(user).pw_gid
if group:
gid = grp.getgrnam(group).gr_gid
for dirpath, dirnames, filenames in os.walk(path, topdown=False):
for item in filenames:
filepath = os.path.join(dirpath, item)
try:
os.chown(filepath, uid, gid)
except Exception as e: # pragma: no cover
logg.debug("could not set %s:%s on %s\n\t%s", user, group, filepath, e)
ok = False
for item in dirnames:
dir_path = os.path.join(dirpath, item)
try:
os.chown(dir_path, uid, gid)
except Exception as e: # pragma: no cover
logg.debug("could not set %s:%s on %s\n\t%s", user, group, dir_path, e)
ok = False
try:
os.chown(path, uid, gid)
except Exception as e: # pragma: no cover
logg.debug("could not set %s:%s on %s\n\t%s", user, group, path, e)
ok = False
if not ok:
logg.debug("could not chown %s:%s service directory %s", user, group, path)
return ok
def clean_modules(self, *modules):
""" [UNIT]... -- remove the state directories
/// it recognizes --what=all or any of configuration, state, cache, logs, runtime
while an empty value (the default) removes cache and runtime directories"""
found_all = True
units = []
for module in modules:
matched = self.match_units(to_list(module))
if not matched:
logg.error("Unit %s not found.", unit_of(module))
self.error |= NOT_FOUND
found_all = False
continue
for unit in matched:
if unit not in units:
units += [unit]
lines = _log_lines
follow = _force
ok = self.clean_units(units)
return ok and found_all
def clean_units(self, units, what = ""):
if not what:
what = self._only_what[0]
ok = True
for unit in units:
ok = self.clean_unit(unit, what) and ok
return ok
def clean_unit(self, unit, what = ""):
conf = self.load_unit_conf(unit)
if not conf: return False
return self.clean_unit_from(conf, what)
def clean_unit_from(self, conf, what):
if self.is_active_from(conf):
logg.warning("can not clean active unit: %s", conf.name())
return False
return self.clean_service_directories(conf, what)
def log_modules(self, *modules):
""" [UNIT]... -- start 'less' on the log files for the services
/// use '-f' to follow and '-n lines' to limit output using 'tail',
using '--no-pager' just does a full 'cat'"""
found_all = True
units = []
for module in modules:
matched = self.match_units(to_list(module))
if not matched:
logg.error("Unit %s not found.", unit_of(module))
self.error |= NOT_FOUND
found_all = False
continue
for unit in matched:
if unit not in units:
units += [unit]
lines = _log_lines
follow = _force
result = self.log_units(units, lines, follow)
if result:
self.error = result
return False
return found_all
def log_units(self, units, lines = None, follow = False):
result = 0
for unit in self.sortedAfter(units):
exitcode = self.log_unit(unit, lines, follow)
if exitcode < 0:
return exitcode
if exitcode > result:
result = exitcode
return result
def log_unit(self, unit, lines = None, follow = False):
conf = self.load_unit_conf(unit)
if not conf: return -1
return self.log_unit_from(conf, lines, follow)
def log_unit_from(self, conf, lines = None, follow = False):
cmd_args = []
log_path = self.get_journal_log_from(conf)
if follow:
tail_cmd = get_exist_path(TAIL_CMDS)
if tail_cmd is None:
print("tail command not found")
return 1
cmd = [tail_cmd, "-n", str(lines or 10), "-F", log_path]
logg.debug("journalctl %s -> %s", conf.name(), cmd)
cmd_args = [arg for arg in cmd] # satisfy mypy
return os.execvp(cmd_args[0], cmd_args)
elif lines:
tail_cmd = get_exist_path(TAIL_CMDS)
if tail_cmd is None:
print("tail command not found")
return 1
cmd = [tail_cmd, "-n", str(lines or 10), log_path]
logg.debug("journalctl %s -> %s", conf.name(), cmd)
cmd_args = [arg for arg in cmd] # satisfy mypy
return os.execvp(cmd_args[0], cmd_args)
elif _no_pager:
cat_cmd = get_exist_path(CAT_CMDS)
if cat_cmd is None:
print("cat command not found")
return 1
cmd = [cat_cmd, log_path]
logg.debug("journalctl %s -> %s", conf.name(), cmd)
cmd_args = [arg for arg in cmd] # satisfy mypy
return os.execvp(cmd_args[0], cmd_args)
else:
less_cmd = get_exist_path(LESS_CMDS)
if less_cmd is None:
print("less command not found")
return 1
cmd = [less_cmd, log_path]
logg.debug("journalctl %s -> %s", conf.name(), cmd)
cmd_args = [arg for arg in cmd] # satisfy mypy
return os.execvp(cmd_args[0], cmd_args)
def get_journal_log_from(self, conf):
return os_path(self._root, self.get_journal_log(conf))
def get_journal_log(self, conf):
""" /var/log/zzz.service.log or /var/log/default.unit.log """
filename = os.path.basename(strE(conf.filename()))
unitname = (conf.name() or "default")+".unit"
name = filename or unitname
log_folder = expand_path(self._journal_log_folder, conf.root_mode())
log_file = name.replace(os.path.sep, ".") + ".log"
if log_file.startswith("."):
log_file = "dot."+log_file
return os.path.join(log_folder, log_file)
def open_journal_log(self, conf):
log_file = self.get_journal_log_from(conf)
log_folder = os.path.dirname(log_file)
if not os.path.isdir(log_folder):
os.makedirs(log_folder)
return open(os.path.join(log_file), "a")
def get_WorkingDirectory(self, conf):
return conf.get(Service, "WorkingDirectory", "")
def chdir_workingdir(self, conf):
""" if specified then change the working directory """
# the original systemd will start in '/' even if User= is given
if self._root:
os.chdir(self._root)
workingdir = self.get_WorkingDirectory(conf)
mode, workingdir = load_path(workingdir)
if workingdir:
into = os_path(self._root, self.expand_special(workingdir, conf))
try:
logg.debug("chdir workingdir '%s'", into)
os.chdir(into)
return False
except Exception as e:
if mode.check:
logg.error("chdir workingdir '%s': %s", into, e)
return into
else:
logg.debug("chdir workingdir '%s': %s", into, e)
return None
return None
NotifySocket = collections.namedtuple("NotifySocket", ["socket", "socketfile"])
def get_notify_socket_from(self, conf, socketfile = None, debug = False):
""" creates a notify-socket for the (non-privileged) user """
notify_socket_folder = expand_path(_notify_socket_folder, conf.root_mode())
notify_folder = os_path(self._root, notify_socket_folder)
notify_name = "notify." + str(conf.name() or "systemctl")
notify_socket = os.path.join(notify_folder, notify_name)
socketfile = socketfile or notify_socket
if len(socketfile) > 100:
# occurs during testsuite.py for ~user/test.tmp/root path
if debug:
logg.debug("https://unix.stackexchange.com/questions/367008/%s",
"why-is-socket-path-length-limited-to-a-hundred-chars")
logg.debug("old notify socketfile (%s) = %s", len(socketfile), socketfile)
notify_name44 = o44(notify_name)
notify_name77 = o77(notify_name)
socketfile = os.path.join(notify_folder, notify_name77)
if len(socketfile) > 100:
socketfile = os.path.join(notify_folder, notify_name44)
pref = "zz.%i.%s" % (get_USER_ID(), o22(os.path.basename(notify_socket_folder)))
if len(socketfile) > 100:
socketfile = os.path.join(get_TMP(), pref, notify_name)
if len(socketfile) > 100:
socketfile = os.path.join(get_TMP(), pref, notify_name77)
if len(socketfile) > 100: # pragma: no cover
socketfile = os.path.join(get_TMP(), pref, notify_name44)
if len(socketfile) > 100: # pragma: no cover
socketfile = os.path.join(get_TMP(), notify_name44)
if debug:
logg.info("new notify socketfile (%s) = %s", len(socketfile), socketfile)
return socketfile
def notify_socket_from(self, conf, socketfile = None):
socketfile = self.get_notify_socket_from(conf, socketfile, debug=True)
try:
if not os.path.isdir(os.path.dirname(socketfile)):
os.makedirs(os.path.dirname(socketfile))
if os.path.exists(socketfile):
os.unlink(socketfile)
except Exception as e:
logg.warning("error %s: %s", socketfile, e)
sock = socket.socket(socket.AF_UNIX, socket.SOCK_DGRAM)
sock.bind(socketfile)
os.chmod(socketfile, 0o777) # the service my run under some User=setting
return Systemctl.NotifySocket(sock, socketfile)
def read_notify_socket(self, notify, timeout):
notify.socket.settimeout(timeout or DefaultMaximumTimeout)
result = ""
try:
result, client_address = notify.socket.recvfrom(4096)
assert isinstance(result, bytes)
if result:
result = result.decode("utf-8")
result_txt = result.replace("\n", "|")
result_len = len(result)
logg.debug("read_notify_socket(%s):%s", result_len, result_txt)
except socket.timeout as e:
if timeout > 2:
logg.debug("socket.timeout %s", e)
return result
def wait_notify_socket(self, notify, timeout, pid = None, pid_file = None):
if not os.path.exists(notify.socketfile):
logg.info("no $NOTIFY_SOCKET exists")
return {}
#
lapseTimeout = max(3, int(timeout / 100))
mainpidTimeout = lapseTimeout # Apache sends READY before MAINPID
status = ""
logg.info("wait $NOTIFY_SOCKET, timeout %s (lapse %s)", timeout, lapseTimeout)
waiting = " ---"
results = {}
for attempt in xrange(int(timeout)+1):
if pid and not self.is_active_pid(pid):
logg.info("seen dead PID %s", pid)
return results
if not attempt: # first one
time.sleep(1) # until TimeoutStartSec
continue
result = self.read_notify_socket(notify, 1) # sleep max 1 second
for line in result.splitlines():
# for name, value in self.read_env_part(line)
if "=" not in line:
continue
name, value = line.split("=", 1)
results[name] = value
if name in ["STATUS", "ACTIVESTATE", "MAINPID", "READY"]:
hint="seen notify %s " % (waiting)
logg.debug("%s :%s=%s", hint, name, value)
if status != results.get("STATUS", ""):
mainpidTimeout = lapseTimeout
status = results.get("STATUS", "")
if "READY" not in results:
time.sleep(1) # until TimeoutStart
continue
if "MAINPID" not in results and not pid_file:
mainpidTimeout -= 1
if mainpidTimeout > 0:
waiting = "%4i" % (-mainpidTimeout)
time.sleep(1) # until TimeoutStart
continue
break # READY and MAINPID
if "READY" not in results:
logg.info(".... timeout while waiting for 'READY=1' status on $NOTIFY_SOCKET")
elif "MAINPID" not in results:
logg.info(".... seen 'READY=1' but no MAINPID update status on $NOTIFY_SOCKET")
logg.debug("notify = %s", results)
try:
notify.socket.close()
except Exception as e:
logg.debug("socket.close %s", e)
return results
def start_modules(self, *modules):
""" [UNIT]... -- start these units
/// SPECIAL: with --now or --init it will
run the init-loop and stop the units afterwards """
found_all = True
units = []
for module in modules:
matched = self.match_units(to_list(module))
if not matched:
logg.error("Unit %s not found.", unit_of(module))
self.error |= NOT_FOUND
found_all = False
continue
for unit in matched:
if unit not in units:
units += [unit]
init = self._now or self._init
return self.start_units(units, init) and found_all
def start_units(self, units, init = None):
""" fails if any unit does not start
/// SPECIAL: may run the init-loop and
stop the named units afterwards """
self.wait_system()
done = True
started_units = []
for unit in self.sortedAfter(units):
started_units.append(unit)
if not self.start_unit(unit):
done = False
if init:
logg.info("init-loop start")
sig = self.init_loop_until_stop(started_units)
logg.info("init-loop %s", sig)
for unit in reversed(started_units):
self.stop_unit(unit)
return done
def start_unit(self, unit):
conf = self.load_unit_conf(unit)
if conf is None:
logg.debug("unit could not be loaded (%s)", unit)
logg.error("Unit %s not found.", unit)
return False
if self.not_user_conf(conf):
logg.error("Unit %s not for --user mode", unit)
return False
return self.start_unit_from(conf)
def get_TimeoutStartSec(self, conf):
timeout = conf.get(Service, "TimeoutSec", strE(DefaultTimeoutStartSec))
timeout = conf.get(Service, "TimeoutStartSec", timeout)
return time_to_seconds(timeout, DefaultMaximumTimeout)
def get_SocketTimeoutSec(self, conf):
timeout = conf.get(Socket, "TimeoutSec", strE(DefaultTimeoutStartSec))
return time_to_seconds(timeout, DefaultMaximumTimeout)
def get_RemainAfterExit(self, conf):
return conf.getbool(Service, "RemainAfterExit", "no")
def start_unit_from(self, conf):
if not conf: return False
if self.syntax_check(conf) > 100: return False
with waitlock(conf):
logg.debug(" start unit %s => %s", conf.name(), strQ(conf.filename()))
return self.do_start_unit_from(conf)
def do_start_unit_from(self, conf):
if conf.name().endswith(".service"):
return self.do_start_service_from(conf)
elif conf.name().endswith(".socket"):
return self.do_start_socket_from(conf)
elif conf.name().endswith(".target"):
return self.do_start_target_from(conf)
else:
logg.error("start not implemented for unit type: %s", conf.name())
return False
def do_start_service_from(self, conf):
timeout = self.get_TimeoutStartSec(conf)
doRemainAfterExit = self.get_RemainAfterExit(conf)
runs = conf.get(Service, "Type", "simple").lower()
env = self.get_env(conf)
if not self._quiet:
okee = self.exec_check_unit(conf, env, Service, "Exec") # all...
if not okee and _no_reload: return False
service_directories = self.create_service_directories(conf)
env.update(service_directories) # atleast sshd did check for /run/sshd
# for StopPost on failure:
returncode = 0
service_result = "success"
if True:
if runs in ["simple", "exec", "forking", "notify", "idle"]:
env["MAINPID"] = strE(self.read_mainpid_from(conf))
for cmd in conf.getlist(Service, "ExecStartPre", []):
exe, newcmd = self.exec_newcmd(cmd, env, conf)
logg.info(" pre-start %s", shell_cmd(newcmd))
forkpid = os.fork()
if not forkpid:
self.execve_from(conf, newcmd, env) # pragma: no cover
run = subprocess_waitpid(forkpid)
logg.debug(" pre-start done (%s) <-%s>",
run.returncode or "OK", run.signal or "")
if run.returncode and exe.check:
logg.error("the ExecStartPre control process exited with error code")
active = "failed"
self.write_status_from(conf, AS=active)
if self._only_what[0] not in ["none", "keep"]:
self.remove_service_directories(conf) # cleanup that /run/sshd
return False
if runs in ["oneshot"]:
status_file = self.get_status_file_from(conf)
if self.get_status_from(conf, "ActiveState", "unknown") == "active":
logg.warning("the service was already up once")
return True
for cmd in conf.getlist(Service, "ExecStart", []):
exe, newcmd = self.exec_newcmd(cmd, env, conf)
logg.info("%s start %s", runs, shell_cmd(newcmd))
forkpid = os.fork()
if not forkpid: # pragma: no cover
os.setsid() # detach child process from parent
self.execve_from(conf, newcmd, env)
run = subprocess_waitpid(forkpid)
if run.returncode and exe.check:
returncode = run.returncode
service_result = "failed"
logg.error("%s start %s (%s) <-%s>", runs, service_result,
run.returncode or "OK", run.signal or "")
break
logg.info("%s start done (%s) <-%s>", runs,
run.returncode or "OK", run.signal or "")
if True:
self.set_status_from(conf, "ExecMainCode", strE(returncode))
active = returncode and "failed" or "active"
self.write_status_from(conf, AS=active)
elif runs in ["simple", "exec", "idle"]:
status_file = self.get_status_file_from(conf)
pid = self.read_mainpid_from(conf)
if self.is_active_pid(pid):
logg.warning("the service is already running on PID %s", pid)
return True
if doRemainAfterExit:
logg.debug("%s RemainAfterExit -> AS=active", runs)
self.write_status_from(conf, AS="active")
cmdlist = conf.getlist(Service, "ExecStart", [])
for idx, cmd in enumerate(cmdlist):
logg.debug("ExecStart[%s]: %s", idx, cmd)
for cmd in cmdlist:
pid = self.read_mainpid_from(conf)
env["MAINPID"] = strE(pid)
exe, newcmd = self.exec_newcmd(cmd, env, conf)
logg.info("%s start %s", runs, shell_cmd(newcmd))
forkpid = os.fork()
if not forkpid: # pragma: no cover
os.setsid() # detach child process from parent
self.execve_from(conf, newcmd, env)
self.write_status_from(conf, MainPID=forkpid)
logg.info("%s started PID %s", runs, forkpid)
env["MAINPID"] = strE(forkpid)
time.sleep(MinimumYield)
run = subprocess_testpid(forkpid)
if run.returncode is not None:
logg.info("%s stopped PID %s (%s) <-%s>", runs, run.pid,
run.returncode or "OK", run.signal or "")
if doRemainAfterExit:
self.set_status_from(conf, "ExecMainCode", strE(run.returncode))
active = run.returncode and "failed" or "active"
self.write_status_from(conf, AS=active)
if run.returncode and exe.check:
service_result = "failed"
break
elif runs in ["notify"]:
# "notify" is the same as "simple" but we create a $NOTIFY_SOCKET
# and wait for startup completion by checking the socket messages
pid_file = self.pid_file_from(conf)
pid = self.read_mainpid_from(conf)
if self.is_active_pid(pid):
logg.error("the service is already running on PID %s", pid)
return False
notify = self.notify_socket_from(conf)
if notify:
env["NOTIFY_SOCKET"] = notify.socketfile
logg.debug("use NOTIFY_SOCKET=%s", notify.socketfile)
if doRemainAfterExit:
logg.debug("%s RemainAfterExit -> AS=active", runs)
self.write_status_from(conf, AS="active")
cmdlist = conf.getlist(Service, "ExecStart", [])
for idx, cmd in enumerate(cmdlist):
logg.debug("ExecStart[%s]: %s", idx, cmd)
mainpid = None
for cmd in cmdlist:
mainpid = self.read_mainpid_from(conf)
env["MAINPID"] = strE(mainpid)
exe, newcmd = self.exec_newcmd(cmd, env, conf)
logg.info("%s start %s", runs, shell_cmd(newcmd))
forkpid = os.fork()
if not forkpid: # pragma: no cover
os.setsid() # detach child process from parent
self.execve_from(conf, newcmd, env)
# via NOTIFY # self.write_status_from(conf, MainPID=forkpid)
logg.info("%s started PID %s", runs, forkpid)
mainpid = forkpid
self.write_status_from(conf, MainPID=mainpid)
env["MAINPID"] = strE(mainpid)
time.sleep(MinimumYield)
run = subprocess_testpid(forkpid)
if run.returncode is not None:
logg.info("%s stopped PID %s (%s) <-%s>", runs, run.pid,
run.returncode or "OK", run.signal or "")
if doRemainAfterExit:
self.set_status_from(conf, "ExecMainCode", strE(run.returncode))
active = run.returncode and "failed" or "active"
self.write_status_from(conf, AS=active)
if run.returncode and exe.check:
service_result = "failed"
break
if service_result in ["success"] and mainpid:
logg.debug("okay, waiting on socket for %ss", timeout)
results = self.wait_notify_socket(notify, timeout, mainpid, pid_file)
if "MAINPID" in results:
new_pid = to_intN(results["MAINPID"])
if new_pid and new_pid != mainpid:
logg.info("NEW PID %s from sd_notify (was PID %s)", new_pid, mainpid)
self.write_status_from(conf, MainPID=new_pid)
mainpid = new_pid
logg.info("%s start done %s", runs, mainpid)
pid = self.read_mainpid_from(conf)
if pid:
env["MAINPID"] = strE(pid)
else:
service_result = "timeout" # "could not start service"
elif runs in ["forking"]:
pid_file = self.pid_file_from(conf)
for cmd in conf.getlist(Service, "ExecStart", []):
exe, newcmd = self.exec_newcmd(cmd, env, conf)
if not newcmd: continue
logg.info("%s start %s", runs, shell_cmd(newcmd))
forkpid = os.fork()
if not forkpid: # pragma: no cover
os.setsid() # detach child process from parent
self.execve_from(conf, newcmd, env)
logg.info("%s started PID %s", runs, forkpid)
run = subprocess_waitpid(forkpid)
if run.returncode and exe.check:
returncode = run.returncode
service_result = "failed"
logg.info("%s stopped PID %s (%s) <-%s>", runs, run.pid,
run.returncode or "OK", run.signal or "")
if pid_file and service_result in ["success"]:
pid = self.wait_pid_file(pid_file) # application PIDFile
logg.info("%s start done PID %s [%s]", runs, pid, pid_file)
if pid:
env["MAINPID"] = strE(pid)
if not pid_file:
time.sleep(MinimumTimeoutStartSec)
logg.warning("No PIDFile for forking %s", strQ(conf.filename()))
status_file = self.get_status_file_from(conf)
self.set_status_from(conf, "ExecMainCode", strE(returncode))
active = returncode and "failed" or "active"
self.write_status_from(conf, AS=active)
else:
logg.error("unsupported run type '%s'", runs)
return False
# POST sequence
if not self.is_active_from(conf):
logg.warning("%s start not active", runs)
# according to the systemd documentation, a failed start-sequence
# should execute the ExecStopPost sequence allowing some cleanup.
env["SERVICE_RESULT"] = service_result
for cmd in conf.getlist(Service, "ExecStopPost", []):
exe, newcmd = self.exec_newcmd(cmd, env, conf)
logg.info("post-fail %s", shell_cmd(newcmd))
forkpid = os.fork()
if not forkpid:
self.execve_from(conf, newcmd, env) # pragma: no cover
run = subprocess_waitpid(forkpid)
logg.debug("post-fail done (%s) <-%s>",
run.returncode or "OK", run.signal or "")
if self._only_what[0] not in ["none", "keep"]:
self.remove_service_directories(conf)
return False
else:
for cmd in conf.getlist(Service, "ExecStartPost", []):
exe, newcmd = self.exec_newcmd(cmd, env, conf)
logg.info("post-start %s", shell_cmd(newcmd))
forkpid = os.fork()
if not forkpid:
self.execve_from(conf, newcmd, env) # pragma: no cover
run = subprocess_waitpid(forkpid)
logg.debug("post-start done (%s) <-%s>",
run.returncode or "OK", run.signal or "")
return True
def listen_modules(self, *modules):
""" [UNIT]... -- listen socket units"""
found_all = True
units = []
for module in modules:
matched = self.match_units(to_list(module))
if not matched:
logg.error("Unit %s not found.", unit_of(module))
self.error |= NOT_FOUND
found_all = False
continue
for unit in matched:
if unit not in units:
units += [unit]
return self.listen_units(units) and found_all
def listen_units(self, units):
""" fails if any socket does not start """
self.wait_system()
done = True
started_units = []
active_units = []
for unit in self.sortedAfter(units):
started_units.append(unit)
if not self.listen_unit(unit):
done = False
else:
active_units.append(unit)
if active_units:
logg.info("init-loop start")
sig = self.init_loop_until_stop(started_units)
logg.info("init-loop %s", sig)
for unit in reversed(started_units):
pass # self.stop_unit(unit)
return done
def listen_unit(self, unit):
conf = self.load_unit_conf(unit)
if conf is None:
logg.debug("unit could not be loaded (%s)", unit)
logg.error("Unit %s not found.", unit)
return False
if self.not_user_conf(conf):
logg.error("Unit %s not for --user mode", unit)
return False
return self.listen_unit_from(conf)
def listen_unit_from(self, conf):
if not conf: return False
with waitlock(conf):
logg.debug(" listen unit %s => %s", conf.name(), strQ(conf.filename()))
return self.do_listen_unit_from(conf)
def do_listen_unit_from(self, conf):
if conf.name().endswith(".socket"):
return self.do_start_socket_from(conf)
else:
logg.error("listen not implemented for unit type: %s", conf.name())
return False
def do_accept_socket_from(self, conf, sock):
logg.debug("%s: accepting %s", conf.name(), sock.fileno())
service_unit = self.get_socket_service_from(conf)
service_conf = self.load_unit_conf(service_unit)
if service_conf is None or TestAccept: # pragma: no cover
if sock.type == socket.SOCK_STREAM:
conn, addr = sock.accept()
data = conn.recv(1024)
logg.debug("%s: '%s'", conf.name(), data)
conn.send(b"ERROR: "+data.upper())
conn.close()
return False
if sock.type == socket.SOCK_DGRAM:
data, sender = sock.recvfrom(1024)
logg.debug("%s: '%s'", conf.name(), data)
sock.sendto(b"ERROR: "+data.upper(), sender)
return False
logg.error("can not accept socket type %s", strINET(sock.type))
return False
return self.do_start_service_from(service_conf)
def get_socket_service_from(self, conf):
socket_unit = conf.name()
accept = conf.getbool(Socket, "Accept", "no")
service_type = accept and "@.service" or ".service"
service_name = path_replace_extension(socket_unit, ".socket", service_type)
service_unit = conf.get(Socket, Service, service_name)
logg.debug("socket %s -> service %s", socket_unit, service_unit)
return service_unit
def do_start_socket_from(self, conf):
runs = "socket"
timeout = self.get_SocketTimeoutSec(conf)
accept = conf.getbool(Socket, "Accept", "no")
stream = conf.get(Socket, "ListenStream", "")
service_unit = self.get_socket_service_from(conf)
service_conf = self.load_unit_conf(service_unit)
if service_conf is None:
logg.debug("unit could not be loaded (%s)", service_unit)
logg.error("Unit %s not found.", service_unit)
return False
env = self.get_env(conf)
if not self._quiet:
okee = self.exec_check_unit(conf, env, Socket, "Exec") # all...
if not okee and _no_reload: return False
if True:
for cmd in conf.getlist(Socket, "ExecStartPre", []):
exe, newcmd = self.exec_newcmd(cmd, env, conf)
logg.info(" pre-start %s", shell_cmd(newcmd))
forkpid = os.fork()
if not forkpid:
self.execve_from(conf, newcmd, env) # pragma: no cover
run = subprocess_waitpid(forkpid)
logg.debug(" pre-start done (%s) <-%s>",
run.returncode or "OK", run.signal or "")
if run.returncode and exe.check:
logg.error("the ExecStartPre control process exited with error code")
active = "failed"
self.write_status_from(conf, AS=active)
return False
# service_directories = self.create_service_directories(conf)
# env.update(service_directories)
listening=False
if not accept:
sock = self.create_socket(conf)
if sock and TestListen:
listening=True
self._sockets[conf.name()] = SystemctlSocket(conf, sock)
service_result = "success"
state = sock and "active" or "failed"
self.write_status_from(conf, AS=state)
if not listening:
# we do not listen but have the service started right away
done = self.do_start_service_from(service_conf)
service_result = done and "success" or "failed"
if not self.is_active_from(service_conf):
service_result = "failed"
state = service_result
if service_result in ["success"]:
state = "active"
self.write_status_from(conf, AS=state)
# POST sequence
if service_result in ["failed"]:
# according to the systemd documentation, a failed start-sequence
# should execute the ExecStopPost sequence allowing some cleanup.
env["SERVICE_RESULT"] = service_result
for cmd in conf.getlist(Socket, "ExecStopPost", []):
exe, newcmd = self.exec_newcmd(cmd, env, conf)
logg.info("post-fail %s", shell_cmd(newcmd))
forkpid = os.fork()
if not forkpid:
self.execve_from(conf, newcmd, env) # pragma: no cover
run = subprocess_waitpid(forkpid)
logg.debug("post-fail done (%s) <-%s>",
run.returncode or "OK", run.signal or "")
return False
else:
for cmd in conf.getlist(Socket, "ExecStartPost", []):
exe, newcmd = self.exec_newcmd(cmd, env, conf)
logg.info("post-start %s", shell_cmd(newcmd))
forkpid = os.fork()
if not forkpid:
self.execve_from(conf, newcmd, env) # pragma: no cover
run = subprocess_waitpid(forkpid)
logg.debug("post-start done (%s) <-%s>",
run.returncode or "OK", run.signal or "")
return True
def create_socket(self, conf):
unsupported = ["ListenUSBFunction", "ListenMessageQueue", "ListenNetlink"]
unsupported += ["ListenSpecial", "ListenFIFO", "ListenSequentialPacket"]
for item in unsupported:
if conf.get(Socket, item, ""):
logg.warning("%s: %s sockets are not implemented", conf.name(), item)
self.error |= NOT_OK
return None
vListenDatagram = conf.get(Socket, "ListenDatagram", "")
vListenStream = conf.get(Socket, "ListenStream", "")
address = vListenStream or vListenDatagram
m = re.match(r"(/.*)", address)
if m:
path = m.group(1)
sock = self.create_unix_socket(conf, path, not vListenStream)
self.set_status_from(conf, "path", path)
return sock
m = re.match(r"(\d+[.]\d*[.]\d*[.]\d+):(\d+)", address)
if m:
addr, port = m.group(1), m.group(2)
sock = self.create_port_ipv4_socket(conf, addr, port, not vListenStream)
self.set_status_from(conf, "port", port)
self.set_status_from(conf, "addr", addr)
return sock
m = re.match(r"\[([0-9a-fA-F:]*)\]:(\d+)", address)
if m:
addr, port = m.group(1), m.group(2)
sock = self.create_port_ipv6_socket(conf, addr, port, not vListenStream)
self.set_status_from(conf, "port", port)
self.set_status_from(conf, "addr", addr)
return sock
m = re.match(r"(\d+)$", address)
if m:
port = m.group(1)
sock = self.create_port_socket(conf, port, not vListenStream)
self.set_status_from(conf, "port", port)
return sock
if re.match("@.*", address):
logg.warning("%s: abstract namespace socket not implemented (%s)", conf.name(), address)
return None
if re.match("vsock:.*", address):
logg.warning("%s: virtual machine socket not implemented (%s)", conf.name(), address)
return None
logg.error("%s: unknown socket address type (%s)", conf.name(), address)
return None
def create_unix_socket(self, conf, path, dgram):
sock_stream = dgram and socket.SOCK_DGRAM or socket.SOCK_STREAM
sock = socket.socket(socket.AF_UNIX, sock_stream)
try:
dirmode = conf.get(Socket, "DirectoryMode", "0755")
mode = conf.get(Socket, "SocketMode", "0666")
user = conf.get(Socket, "SocketUser", "")
group = conf.get(Socket, "SocketGroup", "")
symlinks = conf.getlist(Socket, "SymLinks", [])
dirpath = os.path.dirname(path)
if not os.path.isdir(dirpath):
os.makedirs(dirpath, int(dirmode, 8))
if os.path.exists(path):
os.unlink(path)
sock.bind(path)
os.fchmod(sock.fileno(), int(mode, 8))
shutil_fchown(sock.fileno(), user, group)
if symlinks:
logg.warning("%s: symlinks for socket not implemented (%s)", conf.name(), path)
except Exception as e:
logg.error("%s: create socket failed [%s]: %s", conf.name(), path, e)
sock.close()
return None
return sock
def create_port_socket(self, conf, port, dgram):
inet = dgram and socket.SOCK_DGRAM or socket.SOCK_STREAM
sock = socket.socket(socket.AF_INET, inet)
try:
sock.bind(('', int(port)))
logg.info("%s: bound socket at %s %s:%s", conf.name(), strINET(inet), "*", port)
except Exception as e:
logg.error("%s: create socket failed (%s:%s): %s", conf.name(), "*", port, e)
sock.close()
return None
return sock
def create_port_ipv4_socket(self, conf, addr, port, dgram):
inet = dgram and socket.SOCK_DGRAM or socket.SOCK_STREAM
sock = socket.socket(socket.AF_INET, inet)
try:
sock.bind((addr, int(port)))
logg.info("%s: bound socket at %s %s:%s", conf.name(), strINET(inet), addr, port)
except Exception as e:
logg.error("%s: create socket failed (%s:%s): %s", conf.name(), addr, port, e)
sock.close()
return None
return sock
def create_port_ipv6_socket(self, conf, addr, port, dgram):
inet = dgram and socket.SOCK_DGRAM or socket.SOCK_STREAM
sock = socket.socket(socket.AF_INET6, inet)
try:
sock.bind((addr, int(port)))
logg.info("%s: bound socket at %s [%s]:%s", conf.name(), strINET(inet), addr, port)
except Exception as e:
logg.error("%s: create socket failed ([%s]:%s): %s", conf.name(), addr, port, e)
sock.close()
return None
return sock
def extend_exec_env(self, env):
env = env.copy()
# implant DefaultPath into $PATH
path = env.get("PATH", DefaultPath)
parts = path.split(os.pathsep)
for part in DefaultPath.split(os.pathsep):
if part and part not in parts:
parts.append(part)
env["PATH"] = str(os.pathsep).join(parts)
# reset locale to system default
for name in ResetLocale:
if name in env:
del env[name]
locale = {}
path = env.get("LOCALE_CONF", LocaleConf)
parts = path.split(os.pathsep)
for part in parts:
if os.path.isfile(part):
for var, val in self.read_env_file("-"+part):
locale[var] = val
env[var] = val
if "LANG" not in locale:
env["LANG"] = locale.get("LANGUAGE", locale.get("LC_CTYPE", "C"))
return env
def expand_list(self, group_lines, conf):
result = []
for line in group_lines:
for item in line.split():
if item:
result.append(self.expand_special(item, conf))
return result
def get_User(self, conf):
return self.expand_special(conf.get(Service, "User", ""), conf)
def get_Group(self, conf):
return self.expand_special(conf.get(Service, "Group", ""), conf)
def get_SupplementaryGroups(self, conf):
return self.expand_list(conf.getlist(Service, "SupplementaryGroups", []), conf)
def skip_journal_log(self, conf):
if self.get_unit_type(conf.name()) not in ["service"]:
return True
std_out = conf.get(Service, "StandardOutput", DefaultStandardOutput)
std_err = conf.get(Service, "StandardError", DefaultStandardError)
out, err = False, False
if std_out in ["null"]: out = True
if std_out.startswith("file:"): out = True
if std_err in ["inherit"]: std_err = std_out
if std_err in ["null"]: err = True
if std_err.startswith("file:"): err = True
if std_err.startswith("append:"): err = True
return out and err
def dup2_journal_log(self, conf):
msg = ""
std_inp = conf.get(Service, "StandardInput", DefaultStandardInput)
std_out = conf.get(Service, "StandardOutput", DefaultStandardOutput)
std_err = conf.get(Service, "StandardError", DefaultStandardError)
inp, out, err = None, None, None
if std_inp in ["null"]:
inp = open(_dev_null, "r")
elif std_inp.startswith("file:"):
fname = std_inp[len("file:"):]
if os.path.exists(fname):
inp = open(fname, "r")
else:
inp = open(_dev_zero, "r")
else:
inp = open(_dev_zero, "r")
assert inp is not None
try:
if std_out in ["null"]:
out = open(_dev_null, "w")
elif std_out.startswith("file:"):
fname = std_out[len("file:"):]
fdir = os.path.dirname(fname)
if not os.path.exists(fdir):
os.makedirs(fdir)
out = open(fname, "w")
elif std_out.startswith("append:"):
fname = std_out[len("append:"):]
fdir = os.path.dirname(fname)
if not os.path.exists(fdir):
os.makedirs(fdir)
out = open(fname, "a")
except Exception as e:
msg += "\n%s: %s" % (fname, e)
if out is None:
out = self.open_journal_log(conf)
err = out
assert out is not None
try:
if std_err in ["inherit"]:
err = out
elif std_err in ["null"]:
err = open(_dev_null, "w")
elif std_err.startswith("file:"):
fname = std_err[len("file:"):]
fdir = os.path.dirname(fname)
if not os.path.exists(fdir):
os.makedirs(fdir)
err = open(fname, "w")
elif std_err.startswith("append:"):
fname = std_err[len("append:"):]
fdir = os.path.dirname(fname)
if not os.path.exists(fdir):
os.makedirs(fdir)
err = open(fname, "a")
except Exception as e:
msg += "\n%s: %s" % (fname, e)
if err is None:
err = self.open_journal_log(conf)
assert err is not None
if msg:
err.write("ERROR:")
err.write(msg.strip())
err.write("\n")
if EXEC_DUP2:
os.dup2(inp.fileno(), sys.stdin.fileno())
os.dup2(out.fileno(), sys.stdout.fileno())
os.dup2(err.fileno(), sys.stderr.fileno())
def execve_from(self, conf, cmd, env):
""" this code is commonly run in a child process // returns exit-code"""
# |
runs = conf.get(Service, "Type", "simple").lower()
# logg.debug("%s process for %s => %s", runs, strE(conf.name()), strQ(conf.filename()))
self.dup2_journal_log(conf)
cmd_args = []
#
runuser = self.get_User(conf)
rungroup = self.get_Group(conf)
xgroups = self.get_SupplementaryGroups(conf)
envs = shutil_setuid(runuser, rungroup, xgroups)
badpath = self.chdir_workingdir(conf) # some dirs need setuid before
if badpath:
logg.error("(%s): bad workingdir: '%s'", shell_cmd(cmd), badpath)
sys.exit(1)
env = self.extend_exec_env(env)
env.update(envs) # set $HOME to ~$USER
try:
if EXEC_SPAWN:
cmd_args = [arg for arg in cmd] # satisfy mypy
exitcode = os.spawnvpe(os.P_WAIT, cmd[0], cmd_args, env)
sys.exit(exitcode)
else: # pragma: no cover
os.execve(cmd[0], cmd, env)
sys.exit(11) # pragma: no cover (can not be reached / bug like mypy#8401)
except Exception as e:
logg.error("(%s): %s", shell_cmd(cmd), e)
sys.exit(1)
def test_start_unit(self, unit):
""" helper function to test the code that is normally forked off """
conf = self.load_unit_conf(unit)
if not conf: return None
env = self.get_env(conf)
for cmd in conf.getlist(Service, "ExecStart", []):
exe, newcmd = self.exec_newcmd(cmd, env, conf)
self.execve_from(conf, newcmd, env)
return None
def stop_modules(self, *modules):
""" [UNIT]... -- stop these units """
found_all = True
units = []
for module in modules:
matched = self.match_units(to_list(module))
if not matched:
logg.error("Unit %s not found.", unit_of(module))
self.error |= NOT_FOUND
found_all = False
continue
for unit in matched:
if unit not in units:
units += [unit]
return self.stop_units(units) and found_all
def stop_units(self, units):
""" fails if any unit fails to stop """
self.wait_system()
done = True
for unit in self.sortedBefore(units):
if not self.stop_unit(unit):
done = False
return done
def stop_unit(self, unit):
conf = self.load_unit_conf(unit)
if conf is None:
logg.error("Unit %s not found.", unit)
return False
if self.not_user_conf(conf):
logg.error("Unit %s not for --user mode", unit)
return False
return self.stop_unit_from(conf)
def get_TimeoutStopSec(self, conf):
timeout = conf.get(Service, "TimeoutSec", strE(DefaultTimeoutStartSec))
timeout = conf.get(Service, "TimeoutStopSec", timeout)
return time_to_seconds(timeout, DefaultMaximumTimeout)
def stop_unit_from(self, conf):
if not conf: return False
if self.syntax_check(conf) > 100: return False
with waitlock(conf):
logg.info(" stop unit %s => %s", conf.name(), strQ(conf.filename()))
return self.do_stop_unit_from(conf)
def do_stop_unit_from(self, conf):
if conf.name().endswith(".service"):
return self.do_stop_service_from(conf)
elif conf.name().endswith(".socket"):
return self.do_stop_socket_from(conf)
elif conf.name().endswith(".target"):
return self.do_stop_target_from(conf)
else:
logg.error("stop not implemented for unit type: %s", conf.name())
return False
def do_stop_service_from(self, conf):
# |
timeout = self.get_TimeoutStopSec(conf)
runs = conf.get(Service, "Type", "simple").lower()
env = self.get_env(conf)
if not self._quiet:
okee = self.exec_check_unit(conf, env, Service, "ExecStop")
if not okee and _no_reload: return False
service_directories = self.env_service_directories(conf)
env.update(service_directories)
returncode = 0
service_result = "success"
if runs in ["oneshot"]:
status_file = self.get_status_file_from(conf)
if self.get_status_from(conf, "ActiveState", "unknown") == "inactive":
logg.warning("the service is already down once")
return True
for cmd in conf.getlist(Service, "ExecStop", []):
exe, newcmd = self.exec_newcmd(cmd, env, conf)
logg.info("%s stop %s", runs, shell_cmd(newcmd))
forkpid = os.fork()
if not forkpid:
self.execve_from(conf, newcmd, env) # pragma: no cover
run = subprocess_waitpid(forkpid)
if run.returncode and exe.check:
returncode = run.returncode
service_result = "failed"
break
if True:
if returncode:
self.set_status_from(conf, "ExecStopCode", strE(returncode))
self.write_status_from(conf, AS="failed")
else:
self.clean_status_from(conf) # "inactive"
# fallback Stop => Kill for ["simple","notify","forking"]
elif not conf.getlist(Service, "ExecStop", []):
logg.info("no ExecStop => systemctl kill")
if True:
self.do_kill_unit_from(conf)
self.clean_pid_file_from(conf)
self.clean_status_from(conf) # "inactive"
elif runs in ["simple", "exec", "notify", "idle"]:
status_file = self.get_status_file_from(conf)
size = os.path.exists(status_file) and os.path.getsize(status_file)
logg.info("STATUS %s %s", status_file, size)
pid = 0
for cmd in conf.getlist(Service, "ExecStop", []):
env["MAINPID"] = strE(self.read_mainpid_from(conf))
exe, newcmd = self.exec_newcmd(cmd, env, conf)
logg.info("%s stop %s", runs, shell_cmd(newcmd))
forkpid = os.fork()
if not forkpid:
self.execve_from(conf, newcmd, env) # pragma: no cover
run = subprocess_waitpid(forkpid)
run = must_have_failed(run, newcmd) # TODO: a workaround
# self.write_status_from(conf, MainPID=run.pid) # no ExecStop
if run.returncode and exe.check:
returncode = run.returncode
service_result = "failed"
break
pid = to_intN(env.get("MAINPID"))
if pid:
if self.wait_vanished_pid(pid, timeout):
self.clean_pid_file_from(conf)
self.clean_status_from(conf) # "inactive"
else:
logg.info("%s sleep as no PID was found on Stop", runs)
time.sleep(MinimumTimeoutStopSec)
pid = self.read_mainpid_from(conf)
if not pid or not pid_exists(pid) or pid_zombie(pid):
self.clean_pid_file_from(conf)
self.clean_status_from(conf) # "inactive"
elif runs in ["forking"]:
status_file = self.get_status_file_from(conf)
pid_file = self.pid_file_from(conf)
for cmd in conf.getlist(Service, "ExecStop", []):
# active = self.is_active_from(conf)
if pid_file:
new_pid = self.read_mainpid_from(conf)
if new_pid:
env["MAINPID"] = strE(new_pid)
exe, newcmd = self.exec_newcmd(cmd, env, conf)
logg.info("fork stop %s", shell_cmd(newcmd))
forkpid = os.fork()
if not forkpid:
self.execve_from(conf, newcmd, env) # pragma: no cover
run = subprocess_waitpid(forkpid)
if run.returncode and exe.check:
returncode = run.returncode
service_result = "failed"
break
pid = to_intN(env.get("MAINPID"))
if pid:
if self.wait_vanished_pid(pid, timeout):
self.clean_pid_file_from(conf)
else:
logg.info("%s sleep as no PID was found on Stop", runs)
time.sleep(MinimumTimeoutStopSec)
pid = self.read_mainpid_from(conf)
if not pid or not pid_exists(pid) or pid_zombie(pid):
self.clean_pid_file_from(conf)
if returncode:
if os.path.isfile(status_file):
self.set_status_from(conf, "ExecStopCode", strE(returncode))
self.write_status_from(conf, AS="failed")
else:
self.clean_status_from(conf) # "inactive"
else:
logg.error("unsupported run type '%s'", runs)
return False
# POST sequence
if not self.is_active_from(conf):
env["SERVICE_RESULT"] = service_result
for cmd in conf.getlist(Service, "ExecStopPost", []):
exe, newcmd = self.exec_newcmd(cmd, env, conf)
logg.info("post-stop %s", shell_cmd(newcmd))
forkpid = os.fork()
if not forkpid:
self.execve_from(conf, newcmd, env) # pragma: no cover
run = subprocess_waitpid(forkpid)
logg.debug("post-stop done (%s) <-%s>",
run.returncode or "OK", run.signal or "")
if self._only_what[0] not in ["none", "keep"]:
self.remove_service_directories(conf)
return service_result == "success"
def do_stop_socket_from(self, conf):
runs = "socket"
timeout = self.get_SocketTimeoutSec(conf)
accept = conf.getbool(Socket, "Accept", "no")
service_unit = self.get_socket_service_from(conf)
service_conf = self.load_unit_conf(service_unit)
if service_conf is None:
logg.debug("unit could not be loaded (%s)", service_unit)
logg.error("Unit %s not found.", service_unit)
return False
env = self.get_env(conf)
if not self._quiet:
okee = self.exec_check_unit(conf, env, Socket, "ExecStop")
if not okee and _no_reload: return False
if not accept:
# we do not listen but have the service started right away
done = self.do_stop_service_from(service_conf)
service_result = done and "success" or "failed"
else:
done = self.do_stop_service_from(service_conf)
service_result = done and "success" or "failed"
# service_directories = self.env_service_directories(conf)
# env.update(service_directories)
# POST sequence
if not self.is_active_from(conf):
env["SERVICE_RESULT"] = service_result
for cmd in conf.getlist(Socket, "ExecStopPost", []):
exe, newcmd = self.exec_newcmd(cmd, env, conf)
logg.info("post-stop %s", shell_cmd(newcmd))
forkpid = os.fork()
if not forkpid:
self.execve_from(conf, newcmd, env) # pragma: no cover
run = subprocess_waitpid(forkpid)
logg.debug("post-stop done (%s) <-%s>",
run.returncode or "OK", run.signal or "")
return service_result == "success"
def wait_vanished_pid(self, pid, timeout):
if not pid:
return True
if not self.is_active_pid(pid):
return True
logg.info("wait for PID %s to vanish (%ss)", pid, timeout)
for x in xrange(int(timeout)):
time.sleep(1) # until TimeoutStopSec
if not self.is_active_pid(pid):
logg.info("wait for PID %s is done (%s.)", pid, x)
return True
logg.info("wait for PID %s failed (%s.)", pid, timeout)
return False
def reload_modules(self, *modules):
""" [UNIT]... -- reload these units """
self.wait_system()
found_all = True
units = []
for module in modules:
matched = self.match_units(to_list(module))
if not matched:
logg.error("Unit %s not found.", unit_of(module))
self.error |= NOT_FOUND
found_all = False
continue
for unit in matched:
if unit not in units:
units += [unit]
return self.reload_units(units) and found_all
def reload_units(self, units):
""" fails if any unit fails to reload """
self.wait_system()
done = True
for unit in self.sortedAfter(units):
if not self.reload_unit(unit):
done = False
return done
def reload_unit(self, unit):
conf = self.load_unit_conf(unit)
if conf is None:
logg.error("Unit %s not found.", unit)
return False
if self.not_user_conf(conf):
logg.error("Unit %s not for --user mode", unit)
return False
return self.reload_unit_from(conf)
def reload_unit_from(self, conf):
if not conf: return False
if self.syntax_check(conf) > 100: return False
with waitlock(conf):
logg.info(" reload unit %s => %s", conf.name(), strQ(conf.filename()))
return self.do_reload_unit_from(conf)
def do_reload_unit_from(self, conf):
if conf.name().endswith(".service"):
return self.do_reload_service_from(conf)
elif conf.name().endswith(".socket"):
service_unit = self.get_socket_service_from(conf)
service_conf = self.load_unit_conf(service_unit)
if service_conf:
return self.do_reload_service_from(service_conf)
else:
logg.error("no %s found for unit type: %s", service_unit, conf.name())
return False
elif conf.name().endswith(".target"):
return self.do_reload_target_from(conf)
else:
logg.error("reload not implemented for unit type: %s", conf.name())
return False
def do_reload_service_from(self, conf):
runs = conf.get(Service, "Type", "simple").lower()
env = self.get_env(conf)
if not self._quiet:
okee = self.exec_check_unit(conf, env, Service, "ExecReload")
if not okee and _no_reload: return False
initscript = conf.filename()
if self.is_sysv_file(initscript):
status_file = self.get_status_file_from(conf)
if initscript:
newcmd = [initscript, "reload"]
env["SYSTEMCTL_SKIP_REDIRECT"] = "yes"
logg.info("%s reload %s", runs, shell_cmd(newcmd))
forkpid = os.fork()
if not forkpid:
self.execve_from(conf, newcmd, env) # pragma: nocover
run = subprocess_waitpid(forkpid)
self.set_status_from(conf, "ExecReloadCode", run.returncode)
if run.returncode:
self.write_status_from(conf, AS="failed")
return False
else:
self.write_status_from(conf, AS="active")
return True
service_directories = self.env_service_directories(conf)
env.update(service_directories)
if runs in ["simple", "exec", "notify", "forking", "idle"]:
if not self.is_active_from(conf):
logg.info("no reload on inactive service %s", conf.name())
return True
for cmd in conf.getlist(Service, "ExecReload", []):
env["MAINPID"] = strE(self.read_mainpid_from(conf))
exe, newcmd = self.exec_newcmd(cmd, env, conf)
logg.info("%s reload %s", runs, shell_cmd(newcmd))
forkpid = os.fork()
if not forkpid:
self.execve_from(conf, newcmd, env) # pragma: no cover
run = subprocess_waitpid(forkpid)
if run.returncode and exe.check:
logg.error("Job for %s failed because the control process exited with error code. (%s)",
conf.name(), run.returncode)
return False
time.sleep(MinimumYield)
return True
elif runs in ["oneshot"]:
logg.debug("ignored run type '%s' for reload", runs)
return True
else:
logg.error("unsupported run type '%s'", runs)
return False
def restart_modules(self, *modules):
""" [UNIT]... -- restart these units """
found_all = True
units = []
for module in modules:
matched = self.match_units(to_list(module))
if not matched:
logg.error("Unit %s not found.", unit_of(module))
self.error |= NOT_FOUND
found_all = False
continue
for unit in matched:
if unit not in units:
units += [unit]
return self.restart_units(units) and found_all
def restart_units(self, units):
""" fails if any unit fails to restart """
self.wait_system()
done = True
for unit in self.sortedAfter(units):
if not self.restart_unit(unit):
done = False
return done
def restart_unit(self, unit):
conf = self.load_unit_conf(unit)
if conf is None:
logg.error("Unit %s not found.", unit)
return False
if self.not_user_conf(conf):
logg.error("Unit %s not for --user mode", unit)
return False
return self.restart_unit_from(conf)
def restart_unit_from(self, conf):
if not conf: return False
if self.syntax_check(conf) > 100: return False
with waitlock(conf):
if conf.name().endswith(".service"):
logg.info(" restart service %s => %s", conf.name(), strQ(conf.filename()))
if not self.is_active_from(conf):
return self.do_start_unit_from(conf)
else:
return self.do_restart_unit_from(conf)
else:
return self.do_restart_unit_from(conf)
def do_restart_unit_from(self, conf):
logg.info("(restart) => stop/start %s", conf.name())
self.do_stop_unit_from(conf)
return self.do_start_unit_from(conf)
def try_restart_modules(self, *modules):
""" [UNIT]... -- try-restart these units """
found_all = True
units = []
for module in modules:
matched = self.match_units(to_list(module))
if not matched:
logg.error("Unit %s not found.", unit_of(module))
self.error |= NOT_FOUND
found_all = False
continue
for unit in matched:
if unit not in units:
units += [unit]
return self.try_restart_units(units) and found_all
def try_restart_units(self, units):
""" fails if any module fails to try-restart """
self.wait_system()
done = True
for unit in self.sortedAfter(units):
if not self.try_restart_unit(unit):
done = False
return done
def try_restart_unit(self, unit):
""" only do 'restart' if 'active' """
conf = self.load_unit_conf(unit)
if conf is None:
logg.error("Unit %s not found.", unit)
return False
if self.not_user_conf(conf):
logg.error("Unit %s not for --user mode", unit)
return False
with waitlock(conf):
logg.info(" try-restart unit %s => %s", conf.name(), strQ(conf.filename()))
if self.is_active_from(conf):
return self.do_restart_unit_from(conf)
return True
def reload_or_restart_modules(self, *modules):
""" [UNIT]... -- reload-or-restart these units """
found_all = True
units = []
for module in modules:
matched = self.match_units(to_list(module))
if not matched:
logg.error("Unit %s not found.", unit_of(module))
self.error |= NOT_FOUND
found_all = False
continue
for unit in matched:
if unit not in units:
units += [unit]
return self.reload_or_restart_units(units) and found_all
def reload_or_restart_units(self, units):
""" fails if any unit does not reload-or-restart """
self.wait_system()
done = True
for unit in self.sortedAfter(units):
if not self.reload_or_restart_unit(unit):
done = False
return done
def reload_or_restart_unit(self, unit):
""" do 'reload' if specified, otherwise do 'restart' """
conf = self.load_unit_conf(unit)
if conf is None:
logg.error("Unit %s not found.", unit)
return False
if self.not_user_conf(conf):
logg.error("Unit %s not for --user mode", unit)
return False
return self.reload_or_restart_unit_from(conf)
def reload_or_restart_unit_from(self, conf):
""" do 'reload' if specified, otherwise do 'restart' """
if not conf: return False
with waitlock(conf):
logg.info(" reload-or-restart unit %s => %s", conf.name(), strQ(conf.filename()))
return self.do_reload_or_restart_unit_from(conf)
def do_reload_or_restart_unit_from(self, conf):
if not self.is_active_from(conf):
# try: self.stop_unit_from(conf)
# except Exception as e: pass
return self.do_start_unit_from(conf)
elif conf.getlist(Service, "ExecReload", []):
logg.info("found service to have ExecReload -> 'reload'")
return self.do_reload_unit_from(conf)
else:
logg.info("found service without ExecReload -> 'restart'")
return self.do_restart_unit_from(conf)
def reload_or_try_restart_modules(self, *modules):
""" [UNIT]... -- reload-or-try-restart these units """
found_all = True
units = []
for module in modules:
matched = self.match_units(to_list(module))
if not matched:
logg.error("Unit %s not found.", unit_of(module))
self.error |= NOT_FOUND
found_all = False
continue
for unit in matched:
if unit not in units:
units += [unit]
return self.reload_or_try_restart_units(units) and found_all
def reload_or_try_restart_units(self, units):
""" fails if any unit fails to reload-or-try-restart """
self.wait_system()
done = True
for unit in self.sortedAfter(units):
if not self.reload_or_try_restart_unit(unit):
done = False
return done
def reload_or_try_restart_unit(self, unit):
conf = self.load_unit_conf(unit)
if conf is None:
logg.error("Unit %s not found.", unit)
return False
if self.not_user_conf(conf):
logg.error("Unit %s not for --user mode", unit)
return False
return self.reload_or_try_restart_unit_from(conf)
def reload_or_try_restart_unit_from(self, conf):
with waitlock(conf):
logg.info(" reload-or-try-restart unit %s => %s", conf.name(), strQ(conf.filename()))
return self.do_reload_or_try_restart_unit_from(conf)
def do_reload_or_try_restart_unit_from(self, conf):
if conf.getlist(Service, "ExecReload", []):
return self.do_reload_unit_from(conf)
elif not self.is_active_from(conf):
return True
else:
return self.do_restart_unit_from(conf)
def kill_modules(self, *modules):
""" [UNIT]... -- kill these units """
found_all = True
units = []
for module in modules:
matched = self.match_units(to_list(module))
if not matched:
logg.error("Unit %s not found.", unit_of(module))
# self.error |= NOT_FOUND
found_all = False
continue
for unit in matched:
if unit not in units:
units += [unit]
return self.kill_units(units) and found_all
def kill_units(self, units):
""" fails if any unit could not be killed """
self.wait_system()
done = True
for unit in self.sortedBefore(units):
if not self.kill_unit(unit):
done = False
return done
def kill_unit(self, unit):
conf = self.load_unit_conf(unit)
if conf is None:
logg.error("Unit %s not found.", unit)
return False
if self.not_user_conf(conf):
logg.error("Unit %s not for --user mode", unit)
return False
return self.kill_unit_from(conf)
def kill_unit_from(self, conf):
if not conf: return False
with waitlock(conf):
logg.info(" kill unit %s => %s", conf.name(), strQ(conf.filename()))
return self.do_kill_unit_from(conf)
def do_kill_unit_from(self, conf):
started = time.time()
doSendSIGKILL = self.get_SendSIGKILL(conf)
doSendSIGHUP = self.get_SendSIGHUP(conf)
useKillMode = self.get_KillMode(conf)
useKillSignal = self.get_KillSignal(conf)
kill_signal = getattr(signal, useKillSignal)
timeout = self.get_TimeoutStopSec(conf)
status_file = self.get_status_file_from(conf)
size = os.path.exists(status_file) and os.path.getsize(status_file)
logg.info("STATUS %s %s", status_file, size)
mainpid = self.read_mainpid_from(conf)
self.clean_status_from(conf) # clear RemainAfterExit and TimeoutStartSec
if not mainpid:
if useKillMode in ["control-group"]:
logg.warning("no main PID %s", strQ(conf.filename()))
logg.warning("and there is no control-group here")
else:
logg.info("no main PID %s", strQ(conf.filename()))
return False
if not pid_exists(mainpid) or pid_zombie(mainpid):
logg.debug("ignoring children when mainpid is already dead")
# because we list child processes, not processes in control-group
return True
pidlist = self.pidlist_of(mainpid) # here
if pid_exists(mainpid):
logg.info("stop kill PID %s", mainpid)
self._kill_pid(mainpid, kill_signal)
if useKillMode in ["control-group"]:
if len(pidlist) > 1:
logg.info("stop control-group PIDs %s", pidlist)
for pid in pidlist:
if pid != mainpid:
self._kill_pid(pid, kill_signal)
if doSendSIGHUP:
logg.info("stop SendSIGHUP to PIDs %s", pidlist)
for pid in pidlist:
self._kill_pid(pid, signal.SIGHUP)
# wait for the processes to have exited
while True:
dead = True
for pid in pidlist:
if pid_exists(pid) and not pid_zombie(pid):
dead = False
break
if dead:
break
if time.time() > started + timeout:
logg.info("service PIDs not stopped after %s", timeout)
break
time.sleep(1) # until TimeoutStopSec
if dead or not doSendSIGKILL:
logg.info("done kill PID %s %s", mainpid, dead and "OK")
return dead
if useKillMode in ["control-group", "mixed"]:
logg.info("hard kill PIDs %s", pidlist)
for pid in pidlist:
if pid != mainpid:
self._kill_pid(pid, signal.SIGKILL)
time.sleep(MinimumYield)
# useKillMode in [ "control-group", "mixed", "process" ]
if pid_exists(mainpid):
logg.info("hard kill PID %s", mainpid)
self._kill_pid(mainpid, signal.SIGKILL)
time.sleep(MinimumYield)
dead = not pid_exists(mainpid) or pid_zombie(mainpid)
logg.info("done hard kill PID %s %s", mainpid, dead and "OK")
return dead
def _kill_pid(self, pid, kill_signal = None):
try:
sig = kill_signal or signal.SIGTERM
os.kill(pid, sig)
except OSError as e:
if e.errno == errno.ESRCH or e.errno == errno.ENOENT:
logg.debug("kill PID %s => No such process", pid)
return True
else:
logg.error("kill PID %s => %s", pid, str(e))
return False
return not pid_exists(pid) or pid_zombie(pid)
def is_active_modules(self, *modules):
""" [UNIT].. -- check if these units are in active state
implements True if all is-active = True """
# systemctl returns multiple lines, one for each argument
# "active" when is_active
# "inactive" when not is_active
# "unknown" when not enabled
# The return code is set to
# 0 when "active"
# 1 when unit is not found
# 3 when any "inactive" or "unknown"
# However: # TODO! BUG in original systemctl!
# documentation says " exit code 0 if at least one is active"
# and "Unless --quiet is specified, print the unit state"
# |
units = []
results = []
for module in modules:
units = self.match_units(to_list(module))
if not units:
logg.error("Unit %s not found.", unit_of(module))
# self.error |= NOT_FOUND
self.error |= NOT_ACTIVE
results += ["inactive"]
continue
for unit in units:
active = self.get_active_unit(unit)
enabled = self.enabled_unit(unit)
if enabled != "enabled" and ACTIVE_IF_ENABLED:
active = "inactive" # "unknown"
results += [active]
break
# how it should work:
status = "active" in results
# how 'systemctl' works:
non_active = [result for result in results if result != "active"]
if non_active:
self.error |= NOT_ACTIVE
if non_active:
self.error |= NOT_OK # status
if _quiet:
return []
return results
def is_active_from(self, conf):
""" used in try-restart/other commands to check if needed. """
if not conf: return False
return self.get_active_from(conf) == "active"
def active_pid_from(self, conf):
if not conf: return False
pid = self.read_mainpid_from(conf)
return self.is_active_pid(pid)
def is_active_pid(self, pid):
""" returns pid if the pid is still an active process """
if pid and pid_exists(pid) and not pid_zombie(pid):
return pid # usually a string (not null)
return None
def get_active_unit(self, unit):
""" returns 'active' 'inactive' 'failed' 'unknown' """
conf = self.load_unit_conf(unit)
if not conf:
logg.warning("Unit %s not found.", unit)
return "unknown"
else:
return self.get_active_from(conf)
def get_active_from(self, conf):
if conf.name().endswith(".service"):
return self.get_active_service_from(conf)
elif conf.name().endswith(".socket"):
service_unit = self.get_socket_service_from(conf)
service_conf = self.load_unit_conf(service_unit)
return self.get_active_service_from(service_conf)
elif conf.name().endswith(".target"):
return self.get_active_target_from(conf)
else:
logg.debug("is-active not implemented for unit type: %s", conf.name())
return "unknown" # TODO: "inactive" ?
def get_active_service_from(self, conf):
""" returns 'active' 'inactive' 'failed' 'unknown' """
# used in try-restart/other commands to check if needed.
if not conf: return "unknown"
pid_file = self.pid_file_from(conf)
if pid_file: # application PIDFile
if not os.path.exists(pid_file):
return "inactive"
status_file = self.get_status_file_from(conf)
if self.getsize(status_file):
state = self.get_status_from(conf, "ActiveState", "")
if state:
if DEBUG_STATUS:
logg.info("get_status_from %s => %s", conf.name(), state)
return state
pid = self.read_mainpid_from(conf)
if DEBUG_STATUS:
logg.debug("pid_file '%s' => PID %s", pid_file or status_file, strE(pid))
if pid:
if not pid_exists(pid) or pid_zombie(pid):
return "failed"
return "active"
else:
return "inactive"
def get_active_target_from(self, conf):
""" returns 'active' 'inactive' 'failed' 'unknown' """
return self.get_active_target(conf.name())
def get_active_target(self, target):
""" returns 'active' 'inactive' 'failed' 'unknown' """
if target in self.get_active_target_list():
status = self.is_system_running()
if status in ["running"]:
return "active"
return "inactive"
else:
services = self.target_default_services(target)
result = "active"
for service in services:
conf = self.load_unit_conf(service)
if conf:
state = self.get_active_from(conf)
if state in ["failed"]:
result = state
elif state not in ["active"]:
result = state
return result
def get_active_target_list(self):
current_target = self.get_default_target()
target_list = self.get_target_list(current_target)
target_list += [DefaultUnit] # upper end
target_list += [SysInitTarget] # lower end
return target_list
def get_substate_from(self, conf):
""" returns 'running' 'exited' 'dead' 'failed' 'plugged' 'mounted' """
if not conf: return None
pid_file = self.pid_file_from(conf)
if pid_file:
if not os.path.exists(pid_file):
return "dead"
status_file = self.get_status_file_from(conf)
if self.getsize(status_file):
state = self.get_status_from(conf, "ActiveState", "")
if state:
if state in ["active"]:
return self.get_status_from(conf, "SubState", "running")
else:
return self.get_status_from(conf, "SubState", "dead")
pid = self.read_mainpid_from(conf)
if DEBUG_STATUS:
logg.debug("pid_file '%s' => PID %s", pid_file or status_file, strE(pid))
if pid:
if not pid_exists(pid) or pid_zombie(pid):
return "failed"
return "running"
else:
return "dead"
def is_failed_modules(self, *modules):
""" [UNIT]... -- check if these units are in failes state
implements True if any is-active = True """
units = []
results = []
for module in modules:
units = self.match_units(to_list(module))
if not units:
logg.error("Unit %s not found.", unit_of(module))
# self.error |= NOT_FOUND
results += ["inactive"]
continue
for unit in units:
active = self.get_active_unit(unit)
enabled = self.enabled_unit(unit)
if enabled != "enabled" and ACTIVE_IF_ENABLED:
active = "inactive"
results += [active]
break
if "failed" in results:
self.error = 0
else:
self.error |= NOT_OK
if _quiet:
return []
return results
def is_failed_from(self, conf):
if conf is None: return True
return self.get_active_from(conf) == "failed"
def reset_failed_modules(self, *modules):
""" [UNIT]... -- Reset failed state for all, one, or more units """
units = []
status = True
for module in modules:
units = self.match_units(to_list(module))
if not units:
logg.error("Unit %s not found.", unit_of(module))
# self.error |= NOT_FOUND
return False
for unit in units:
if not self.reset_failed_unit(unit):
logg.error("Unit %s could not be reset.", unit_of(module))
status = False
break
return status
def reset_failed_unit(self, unit):
conf = self.load_unit_conf(unit)
if not conf:
logg.warning("Unit %s not found.", unit)
return False
if self.not_user_conf(conf):
logg.error("Unit %s not for --user mode", unit)
return False
return self.reset_failed_from(conf)
def reset_failed_from(self, conf):
if conf is None: return True
if not self.is_failed_from(conf): return False
done = False
status_file = self.get_status_file_from(conf)
if status_file and os.path.exists(status_file):
try:
os.remove(status_file)
done = True
logg.debug("done rm %s", status_file)
except Exception as e:
logg.error("while rm %s: %s", status_file, e)
pid_file = self.pid_file_from(conf)
if pid_file and os.path.exists(pid_file):
try:
os.remove(pid_file)
done = True
logg.debug("done rm %s", pid_file)
except Exception as e:
logg.error("while rm %s: %s", pid_file, e)
return done
def status_modules(self, *modules):
""" [UNIT]... check the status of these units.
"""
found_all = True
units = []
for module in modules:
matched = self.match_units(to_list(module))
if not matched:
logg.error("Unit %s could not be found.", unit_of(module))
self.error |= NOT_FOUND
found_all = False
continue
for unit in matched:
if unit not in units:
units += [unit]
result = self.status_units(units)
# if not found_all:
# self.error |= NOT_OK | NOT_ACTIVE # 3
# # same as (dead) # original behaviour
return result
def status_units(self, units):
""" concatenates the status output of all units
and the last non-successful statuscode """
status = 0
result = ""
for unit in units:
status1, result1 = self.status_unit(unit)
if status1: status = status1
if result: result += "\n\n"
result += result1
if status:
self.error |= NOT_OK | NOT_ACTIVE # 3
return result
def status_unit(self, unit):
conf = self.get_unit_conf(unit)
result = "%s - %s" % (unit, self.get_description_from(conf))
loaded = conf.loaded()
if loaded:
filename = str(conf.filename())
enabled = self.enabled_from(conf)
result += "\n Loaded: {loaded} ({filename}, {enabled})".format(**locals())
for path in conf.overrides():
result += "\n Drop-In: {path}".format(**locals())
else:
result += "\n Loaded: failed"
return 3, result
active = self.get_active_from(conf)
substate = self.get_substate_from(conf)
result += "\n Active: {} ({})".format(active, substate)
if active == "active":
return 0, result
else:
return 3, result
def cat_modules(self, *modules):
""" [UNIT]... show the *.system file for these"
"""
found_all = True
units = []
for module in modules:
matched = self.match_units(to_list(module))
if not matched:
logg.error("Unit %s could not be found.", unit_of(module))
# self.error |= NOT_FOUND
found_all = False
continue
for unit in matched:
if unit not in units:
units += [unit]
result = self.cat_units(units)
if not found_all:
self.error |= NOT_OK
return result
def cat_units(self, units):
done = True
result = ""
for unit in units:
text = self.cat_unit(unit)
if not text:
done = False
else:
if result:
result += "\n\n"
result += text
if not done:
self.error = NOT_OK
return result
def cat_unit(self, unit):
try:
unit_file = self.unit_file(unit)
if unit_file:
return open(unit_file).read()
logg.error("No files found for %s", unit)
except Exception as e:
print("Unit {} is not-loaded: {}".format(unit, e))
self.error |= NOT_OK
return None
##
##
def load_preset_files(self, module = None): # -> [ preset-file-names,... ]
""" reads all preset files, returns the scanned files """
if self._preset_file_list is None:
self._preset_file_list = {}
assert self._preset_file_list is not None
for folder in self.preset_folders():
if not folder:
continue
if self._root:
folder = os_path(self._root, folder)
if not os.path.isdir(folder):
continue
for name in os.listdir(folder):
if not name.endswith(".preset"):
continue
if name not in self._preset_file_list:
path = os.path.join(folder, name)
if os.path.isdir(path):
continue
preset = PresetFile().read(path)
self._preset_file_list[name] = preset
logg.debug("found %s preset files", len(self._preset_file_list))
return sorted(self._preset_file_list.keys())
def get_preset_of_unit(self, unit):
""" [UNIT] check the *.preset of this unit
"""
self.load_preset_files()
assert self._preset_file_list is not None
for filename in sorted(self._preset_file_list.keys()):
preset = self._preset_file_list[filename]
status = preset.get_preset(unit)
if status:
return status
return None
def preset_modules(self, *modules):
""" [UNIT]... -- set 'enabled' when in *.preset
"""
if self.user_mode():
logg.warning("preset makes no sense in --user mode")
return True
found_all = True
units = []
for module in modules:
matched = self.match_units(to_list(module))
if not matched:
logg.error("Unit %s could not be found.", unit_of(module))
found_all = False
continue
for unit in matched:
if unit not in units:
units += [unit]
return self.preset_units(units) and found_all
def preset_units(self, units):
""" fails if any unit could not be changed """
self.wait_system()
fails = 0
found = 0
for unit in units:
status = self.get_preset_of_unit(unit)
if not status: continue
found += 1
if status.startswith("enable"):
if self._preset_mode == "disable": continue
logg.info("preset enable %s", unit)
if not self.enable_unit(unit):
logg.warning("failed to enable %s", unit)
fails += 1
if status.startswith("disable"):
if self._preset_mode == "enable": continue
logg.info("preset disable %s", unit)
if not self.disable_unit(unit):
logg.warning("failed to disable %s", unit)
fails += 1
return not fails and not not found
def preset_all_modules(self, *modules):
""" 'preset' all services
enable or disable services according to *.preset files
"""
if self.user_mode():
logg.warning("preset-all makes no sense in --user mode")
return True
found_all = True
units = self.match_units() # TODO: how to handle module arguments
return self.preset_units(units) and found_all
def wanted_from(self, conf, default = None):
if not conf: return default
return conf.get(Install, "WantedBy", default, True)
def enablefolders(self, wanted):
if self.user_mode():
for folder in self.user_folders():
yield self.default_enablefolder(wanted, folder)
if True:
for folder in self.system_folders():
yield self.default_enablefolder(wanted, folder)
def enablefolder(self, wanted):
if self.user_mode():
user_folder = self.user_folder()
return self.default_enablefolder(wanted, user_folder)
else:
return self.default_enablefolder(wanted)
def default_enablefolder(self, wanted, basefolder = None):
basefolder = basefolder or self.system_folder()
if not wanted:
return wanted
if not wanted.endswith(".wants"):
wanted = wanted + ".wants"
return os.path.join(basefolder, wanted)
def enable_modules(self, *modules):
""" [UNIT]... -- enable these units """
found_all = True
units = []
for module in modules:
matched = self.match_units(to_list(module))
if not matched:
logg.error("Unit %s not found.", unit_of(module))
# self.error |= NOT_FOUND
found_all = False
continue
for unit in matched:
logg.info("matched %s", unit) # ++
if unit not in units:
units += [unit]
return self.enable_units(units) and found_all
def enable_units(self, units):
self.wait_system()
done = True
for unit in units:
if not self.enable_unit(unit):
done = False
elif self._now:
self.start_unit(unit)
return done
def enable_unit(self, unit):
conf = self.load_unit_conf(unit)
if conf is None:
logg.error("Unit %s not found.", unit)
return False
unit_file = conf.filename()
if unit_file is None:
logg.error("Unit file %s not found.", unit)
return False
if self.is_sysv_file(unit_file):
if self.user_mode():
logg.error("Initscript %s not for --user mode", unit)
return False
return self.enable_unit_sysv(unit_file)
if self.not_user_conf(conf):
logg.error("Unit %s not for --user mode", unit)
return False
return self.enable_unit_from(conf)
def enable_unit_from(self, conf):
wanted = self.wanted_from(conf)
if not wanted and not self._force:
logg.debug("%s has no target", conf.name())
return False # "static" is-enabled
target = wanted or self.get_default_target()
folder = self.enablefolder(target)
if self._root:
folder = os_path(self._root, folder)
if not os.path.isdir(folder):
os.makedirs(folder)
source = conf.filename()
if not source: # pragma: no cover (was checked before)
logg.debug("%s has no real file", conf.name())
return False
symlink = os.path.join(folder, conf.name())
if True:
_f = self._force and "-f" or ""
logg.info("ln -s {_f} '{source}' '{symlink}'".format(**locals()))
if self._force and os.path.islink(symlink):
os.remove(target)
if not os.path.islink(symlink):
os.symlink(source, symlink)
return True
def rc3_root_folder(self):
old_folder = os_path(self._root, _rc3_boot_folder)
new_folder = os_path(self._root, _rc3_init_folder)
if os.path.isdir(old_folder): # pragma: no cover
return old_folder
return new_folder
def rc5_root_folder(self):
old_folder = os_path(self._root, _rc5_boot_folder)
new_folder = os_path(self._root, _rc5_init_folder)
if os.path.isdir(old_folder): # pragma: no cover
return old_folder
return new_folder
def enable_unit_sysv(self, unit_file):
# a "multi-user.target"/rc3 is also started in /rc5
rc3 = self._enable_unit_sysv(unit_file, self.rc3_root_folder())
rc5 = self._enable_unit_sysv(unit_file, self.rc5_root_folder())
return rc3 and rc5
def _enable_unit_sysv(self, unit_file, rc_folder):
name = os.path.basename(unit_file)
nameS = "S50"+name
nameK = "K50"+name
if not os.path.isdir(rc_folder):
os.makedirs(rc_folder)
# do not double existing entries
for found in os.listdir(rc_folder):
m = re.match(r"S\d\d(.*)", found)
if m and m.group(1) == name:
nameS = found
m = re.match(r"K\d\d(.*)", found)
if m and m.group(1) == name:
nameK = found
target = os.path.join(rc_folder, nameS)
if not os.path.exists(target):
os.symlink(unit_file, target)
target = os.path.join(rc_folder, nameK)
if not os.path.exists(target):
os.symlink(unit_file, target)
return True
def disable_modules(self, *modules):
""" [UNIT]... -- disable these units """
found_all = True
units = []
for module in modules:
matched = self.match_units(to_list(module))
if not matched:
logg.error("Unit %s not found.", unit_of(module))
# self.error |= NOT_FOUND
found_all = False
continue
for unit in matched:
if unit not in units:
units += [unit]
return self.disable_units(units) and found_all
def disable_units(self, units):
self.wait_system()
done = True
for unit in units:
if not self.disable_unit(unit):
done = False
elif self._now:
self.stop_unit(unit)
return done
def disable_unit(self, unit):
conf = self.load_unit_conf(unit)
if conf is None:
logg.error("Unit %s not found.", unit)
return False
unit_file = conf.filename()
if unit_file is None:
logg.error("Unit file %s not found.", unit)
return False
if self.is_sysv_file(unit_file):
if self.user_mode():
logg.error("Initscript %s not for --user mode", unit)
return False
return self.disable_unit_sysv(unit_file)
if self.not_user_conf(conf):
logg.error("Unit %s not for --user mode", unit)
return False
return self.disable_unit_from(conf)
def disable_unit_from(self, conf):
wanted = self.wanted_from(conf)
if not wanted and not self._force:
logg.debug("%s has no target", conf.name())
return False # "static" is-enabled
target = wanted or self.get_default_target()
for folder in self.enablefolders(target):
if self._root:
folder = os_path(self._root, folder)
symlink = os.path.join(folder, conf.name())
if os.path.exists(symlink):
try:
_f = self._force and "-f" or ""
logg.info("rm {_f} '{symlink}'".format(**locals()))
if os.path.islink(symlink) or self._force:
os.remove(symlink)
except IOError as e:
logg.error("disable %s: %s", symlink, e)
except OSError as e:
logg.error("disable %s: %s", symlink, e)
return True
def disable_unit_sysv(self, unit_file):
rc3 = self._disable_unit_sysv(unit_file, self.rc3_root_folder())
rc5 = self._disable_unit_sysv(unit_file, self.rc5_root_folder())
return rc3 and rc5
def _disable_unit_sysv(self, unit_file, rc_folder):
# a "multi-user.target"/rc3 is also started in /rc5
name = os.path.basename(unit_file)
nameS = "S50"+name
nameK = "K50"+name
# do not forget the existing entries
for found in os.listdir(rc_folder):
m = re.match(r"S\d\d(.*)", found)
if m and m.group(1) == name:
nameS = found
m = re.match(r"K\d\d(.*)", found)
if m and m.group(1) == name:
nameK = found
target = os.path.join(rc_folder, nameS)
if os.path.exists(target):
os.unlink(target)
target = os.path.join(rc_folder, nameK)
if os.path.exists(target):
os.unlink(target)
return True
def is_enabled_sysv(self, unit_file):
name = os.path.basename(unit_file)
target = os.path.join(self.rc3_root_folder(), "S50%s" % name)
if os.path.exists(target):
return True
return False
def is_enabled_modules(self, *modules):
""" [UNIT]... -- check if these units are enabled
returns True if any of them is enabled."""
found_all = True
units = []
for module in modules:
matched = self.match_units(to_list(module))
if not matched:
logg.error("Unit %s not found.", unit_of(module))
# self.error |= NOT_FOUND
found_all = False
continue
for unit in matched:
if unit not in units:
units += [unit]
return self.is_enabled_units(units) # and found_all
def is_enabled_units(self, units):
""" true if any is enabled, and a list of infos """
result = False
infos = []
for unit in units:
infos += [self.enabled_unit(unit)]
if self.is_enabled(unit):
result = True
if not result:
self.error |= NOT_OK
return infos
def is_enabled(self, unit):
conf = self.load_unit_conf(unit)
if conf is None:
logg.error("Unit %s not found.", unit)
return False
unit_file = conf.filename()
if not unit_file:
logg.error("Unit %s not found.", unit)
return False
if self.is_sysv_file(unit_file):
return self.is_enabled_sysv(unit_file)
state = self.get_enabled_from(conf)
if state in ["enabled", "static"]:
return True
return False # ["disabled", "masked"]
def enabled_unit(self, unit):
conf = self.get_unit_conf(unit)
return self.enabled_from(conf)
def enabled_from(self, conf):
unit_file = strE(conf.filename())
if self.is_sysv_file(unit_file):
state = self.is_enabled_sysv(unit_file)
if state:
return "enabled"
return "disabled"
return self.get_enabled_from(conf)
def get_enabled_from(self, conf):
if conf.masked:
return "masked"
wanted = self.wanted_from(conf)
target = wanted or self.get_default_target()
for folder in self.enablefolders(target):
if self._root:
folder = os_path(self._root, folder)
target = os.path.join(folder, conf.name())
if os.path.isfile(target):
return "enabled"
if not wanted:
return "static"
return "disabled"
def mask_modules(self, *modules):
""" [UNIT]... -- mask non-startable units """
found_all = True
units = []
for module in modules:
matched = self.match_units(to_list(module))
if not matched:
logg.error("Unit %s not found.", unit_of(module))
self.error |= NOT_FOUND
found_all = False
continue
for unit in matched:
if unit not in units:
units += [unit]
return self.mask_units(units) and found_all
def mask_units(self, units):
self.wait_system()
done = True
for unit in units:
if not self.mask_unit(unit):
done = False
return done
def mask_unit(self, unit):
unit_file = self.unit_file(unit)
if not unit_file:
logg.error("Unit %s not found.", unit)
return False
if self.is_sysv_file(unit_file):
logg.error("Initscript %s can not be masked", unit)
return False
conf = self.get_unit_conf(unit)
if self.not_user_conf(conf):
logg.error("Unit %s not for --user mode", unit)
return False
folder = self.mask_folder()
if self._root:
folder = os_path(self._root, folder)
if not os.path.isdir(folder):
os.makedirs(folder)
target = os.path.join(folder, os.path.basename(unit_file))
dev_null = _dev_null
if True:
_f = self._force and "-f" or ""
logg.debug("ln -s {_f} {dev_null} '{target}'".format(**locals()))
if self._force and os.path.islink(target):
os.remove(target)
if not os.path.exists(target):
os.symlink(dev_null, target)
logg.info("Created symlink {target} -> {dev_null}".format(**locals()))
return True
elif os.path.islink(target):
logg.debug("mask symlink does already exist: %s", target)
return True
else:
logg.error("mask target does already exist: %s", target)
return False
def mask_folder(self):
for folder in self.mask_folders():
if folder: return folder
raise Exception("did not find any systemd/system folder")
def mask_folders(self):
if self.user_mode():
for folder in self.user_folders():
yield folder
if True:
for folder in self.system_folders():
yield folder
def unmask_modules(self, *modules):
""" [UNIT]... -- unmask non-startable units """
found_all = True
units = []
for module in modules:
matched = self.match_units(to_list(module))
if not matched:
logg.error("Unit %s not found.", unit_of(module))
self.error |= NOT_FOUND
found_all = False
continue
for unit in matched:
if unit not in units:
units += [unit]
return self.unmask_units(units) and found_all
def unmask_units(self, units):
self.wait_system()
done = True
for unit in units:
if not self.unmask_unit(unit):
done = False
return done
def unmask_unit(self, unit):
unit_file = self.unit_file(unit)
if not unit_file:
logg.error("Unit %s not found.", unit)
return False
if self.is_sysv_file(unit_file):
logg.error("Initscript %s can not be un/masked", unit)
return False
conf = self.get_unit_conf(unit)
if self.not_user_conf(conf):
logg.error("Unit %s not for --user mode", unit)
return False
folder = self.mask_folder()
if self._root:
folder = os_path(self._root, folder)
target = os.path.join(folder, os.path.basename(unit_file))
if True:
_f = self._force and "-f" or ""
logg.info("rm {_f} '{target}'".format(**locals()))
if os.path.islink(target):
os.remove(target)
return True
elif not os.path.exists(target):
logg.debug("Symlink did not exist anymore: %s", target)
return True
else:
logg.warning("target is not a symlink: %s", target)
return True
def list_dependencies_modules(self, *modules):
""" [UNIT]... show the dependency tree"
"""
found_all = True
units = []
for module in modules:
matched = self.match_units(to_list(module))
if not matched:
logg.error("Unit %s could not be found.", unit_of(module))
found_all = False
continue
for unit in matched:
if unit not in units:
units += [unit]
return self.list_dependencies_units(units) # and found_all
def list_dependencies_units(self, units):
result = []
for unit in units:
if result:
result += ["", ""]
result += self.list_dependencies_unit(unit)
return result
def list_dependencies_unit(self, unit):
result = []
for line in self.list_dependencies(unit, ""):
result += [line]
return result
def list_dependencies(self, unit, indent = None, mark = None, loop = []):
mapping = {}
mapping["Requires"] = "required to start"
mapping["Wants"] = "wanted to start"
mapping["Requisite"] = "required started"
mapping["Bindsto"] = "binds to start"
mapping["PartOf"] = "part of started"
mapping[".requires"] = ".required to start"
mapping[".wants"] = ".wanted to start"
mapping["PropagateReloadTo"] = "(to be reloaded as well)"
mapping["Conflicts"] = "(to be stopped on conflict)"
restrict = ["Requires", "Requisite", "ConsistsOf", "Wants",
"BindsTo", ".requires", ".wants"]
indent = indent or ""
mark = mark or ""
deps = self.get_dependencies_unit(unit)
conf = self.get_unit_conf(unit)
if not conf.loaded():
if not self._show_all:
return
yield "%s(%s): %s" % (indent, unit, mark)
else:
yield "%s%s: %s" % (indent, unit, mark)
for stop_recursion in ["Conflict", "conflict", "reloaded", "Propagate"]:
if stop_recursion in mark:
return
for dep in deps:
if dep in loop:
logg.debug("detected loop at %s", dep)
continue
new_loop = loop + list(deps.keys())
new_indent = indent + "| "
new_mark = deps[dep]
if not self._show_all:
if new_mark not in restrict:
continue
if new_mark in mapping:
new_mark = mapping[new_mark]
restrict = ["Requires", "Wants", "Requisite", "BindsTo", "PartOf", "ConsistsOf",
".requires", ".wants"]
for line in self.list_dependencies(dep, new_indent, new_mark, new_loop):
yield line
def get_dependencies_unit(self, unit, styles = None):
styles = styles or ["Requires", "Wants", "Requisite", "BindsTo", "PartOf", "ConsistsOf",
".requires", ".wants", "PropagateReloadTo", "Conflicts", ]
conf = self.get_unit_conf(unit)
deps = {}
for style in styles:
if style.startswith("."):
for folder in self.sysd_folders():
if not folder:
continue
require_path = os.path.join(folder, unit + style)
if self._root:
require_path = os_path(self._root, require_path)
if os.path.isdir(require_path):
for required in os.listdir(require_path):
if required not in deps:
deps[required] = style
else:
for requirelist in conf.getlist(Unit, style, []):
for required in requirelist.strip().split(" "):
deps[required.strip()] = style
return deps
def get_required_dependencies(self, unit, styles = None):
styles = styles or ["Requires", "Wants", "Requisite", "BindsTo",
".requires", ".wants"]
return self.get_dependencies_unit(unit, styles)
def get_start_dependencies(self, unit, styles = None): # pragma: no cover
""" the list of services to be started as well / TODO: unused """
styles = styles or ["Requires", "Wants", "Requisite", "BindsTo", "PartOf", "ConsistsOf",
".requires", ".wants"]
deps = {}
unit_deps = self.get_dependencies_unit(unit)
for dep_unit, dep_style in unit_deps.items():
if dep_style in styles:
if dep_unit in deps:
if dep_style not in deps[dep_unit]:
deps[dep_unit].append(dep_style)
else:
deps[dep_unit] = [dep_style]
next_deps = self.get_start_dependencies(dep_unit)
for dep, styles in next_deps.items():
for style in styles:
if dep in deps:
if style not in deps[dep]:
deps[dep].append(style)
else:
deps[dep] = [style]
return deps
def list_start_dependencies_modules(self, *modules):
""" [UNIT]... show the dependency tree (experimental)"
"""
return self.list_start_dependencies_units(list(modules))
def list_start_dependencies_units(self, units):
unit_order = []
deps = {}
for unit in units:
unit_order.append(unit)
# unit_deps = self.get_start_dependencies(unit) # TODO
unit_deps = self.get_dependencies_unit(unit)
for dep_unit, styles in unit_deps.items():
dep_styles = to_list(styles)
for dep_style in dep_styles:
if dep_unit in deps:
if dep_style not in deps[dep_unit]:
deps[dep_unit].append(dep_style)
else:
deps[dep_unit] = [dep_style]
deps_conf = []
for dep in deps:
if dep in unit_order:
continue
conf = self.get_unit_conf(dep)
if conf.loaded():
deps_conf.append(conf)
for unit in unit_order:
deps[unit] = ["Requested"]
conf = self.get_unit_conf(unit)
if conf.loaded():
deps_conf.append(conf)
result = []
sortlist = conf_sortedAfter(deps_conf, cmp=compareAfter)
for item in sortlist:
line = (item.name(), "(%s)" % (" ".join(deps[item.name()])))
result.append(line)
return result
def sortedAfter(self, unitlist):
""" get correct start order for the unit list (ignoring masked units) """
conflist = [self.get_unit_conf(unit) for unit in unitlist]
if True:
conflist = []
for unit in unitlist:
conf = self.get_unit_conf(unit)
if conf.masked:
logg.debug("ignoring masked unit %s", unit)
continue
conflist.append(conf)
sortlist = conf_sortedAfter(conflist)
return [item.name() for item in sortlist]
def sortedBefore(self, unitlist):
""" get correct start order for the unit list (ignoring masked units) """
conflist = [self.get_unit_conf(unit) for unit in unitlist]
if True:
conflist = []
for unit in unitlist:
conf = self.get_unit_conf(unit)
if conf.masked:
logg.debug("ignoring masked unit %s", unit)
continue
conflist.append(conf)
sortlist = conf_sortedAfter(reversed(conflist))
return [item.name() for item in reversed(sortlist)]
def daemon_reload_target(self):
""" reload does will only check the service files here.
The returncode will tell the number of warnings,
and it is over 100 if it can not continue even
for the relaxed systemctl.py style of execution. """
errors = 0
for unit in self.match_units():
try:
conf = self.get_unit_conf(unit)
except Exception as e:
logg.error("%s: can not read unit file %s\n\t%s",
unit, strQ(conf.filename()), e)
continue
errors += self.syntax_check(conf)
if errors:
logg.warning(" (%s) found %s problems", errors, errors % 100)
return True # errors
def syntax_check(self, conf):
filename = conf.filename()
if filename and filename.endswith(".service"):
return self.syntax_check_service(conf)
return 0
def syntax_check_service(self, conf, section = Service):
unit = conf.name()
if not conf.data.has_section(Service):
logg.error(" %s: a .service file without [Service] section", unit)
return 101
errors = 0
haveType = conf.get(section, "Type", "simple")
haveExecStart = conf.getlist(section, "ExecStart", [])
haveExecStop = conf.getlist(section, "ExecStop", [])
haveExecReload = conf.getlist(section, "ExecReload", [])
usedExecStart = []
usedExecStop = []
usedExecReload = []
if haveType not in ["simple", "exec", "forking", "notify", "oneshot", "dbus", "idle"]:
logg.error(" %s: Failed to parse service type, ignoring: %s", unit, haveType)
errors += 100
for line in haveExecStart:
mode, exe = exec_path(line)
if not exe.startswith("/"):
if mode.check:
logg.error(" %s: %s Executable path is not absolute.", unit, section)
else:
logg.warning("%s: %s Executable path is not absolute.", unit, section)
logg.info("%s: %s exe = %s", unit, section, exe)
errors += 1
usedExecStart.append(line)
for line in haveExecStop:
mode, exe = exec_path(line)
if not exe.startswith("/"):
if mode.check:
logg.error(" %s: %s Executable path is not absolute.", unit, section)
else:
logg.warning("%s: %s Executable path is not absolute.", unit, section)
logg.info("%s: %s exe = %s", unit, section, exe)
errors += 1
usedExecStop.append(line)
for line in haveExecReload:
mode, exe = exec_path(line)
if not exe.startswith("/"):
if mode.check:
logg.error(" %s: %s Executable path is not absolute.", unit, section)
else:
logg.warning("%s: %s Executable path is not absolute.", unit, section)
logg.info("%s: %s exe = %s", unit, section, exe)
errors += 1
usedExecReload.append(line)
if haveType in ["simple", "exec", "notify", "forking", "idle"]:
if not usedExecStart and not usedExecStop:
logg.error(" %s: %s lacks both ExecStart and ExecStop= setting. Refusing.", unit, section)
errors += 101
elif not usedExecStart and haveType != "oneshot":
logg.error(" %s: %s has no ExecStart= setting, which is only allowed for Type=oneshot services. Refusing.", unit, section)
errors += 101
if len(usedExecStart) > 1 and haveType != "oneshot":
logg.error(" %s: there may be only one %s ExecStart statement (unless for 'oneshot' services)." +
"\n\t\t\tYou can use ExecStartPre / ExecStartPost to add additional commands.", unit, section)
errors += 1
if len(usedExecStop) > 1 and haveType != "oneshot":
logg.info(" %s: there should be only one %s ExecStop statement (unless for 'oneshot' services)." +
"\n\t\t\tYou can use ExecStopPost to add additional commands (also executed on failed Start)", unit, section)
if len(usedExecReload) > 1:
logg.info(" %s: there should be only one %s ExecReload statement." +
"\n\t\t\tUse ' ; ' for multiple commands (ExecReloadPost or ExedReloadPre do not exist)", unit, section)
if len(usedExecReload) > 0 and "/bin/kill " in usedExecReload[0]:
logg.warning(" %s: the use of /bin/kill is not recommended for %s ExecReload as it is asynchronous." +
"\n\t\t\tThat means all the dependencies will perform the reload simultaneously / out of order.", unit, section)
if conf.getlist(Service, "ExecRestart", []): # pragma: no cover
logg.error(" %s: there no such thing as an %s ExecRestart (ignored)", unit, section)
if conf.getlist(Service, "ExecRestartPre", []): # pragma: no cover
logg.error(" %s: there no such thing as an %s ExecRestartPre (ignored)", unit, section)
if conf.getlist(Service, "ExecRestartPost", []): # pragma: no cover
logg.error(" %s: there no such thing as an %s ExecRestartPost (ignored)", unit, section)
if conf.getlist(Service, "ExecReloadPre", []): # pragma: no cover
logg.error(" %s: there no such thing as an %s ExecReloadPre (ignored)", unit, section)
if conf.getlist(Service, "ExecReloadPost", []): # pragma: no cover
logg.error(" %s: there no such thing as an %s ExecReloadPost (ignored)", unit, section)
if conf.getlist(Service, "ExecStopPre", []): # pragma: no cover
logg.error(" %s: there no such thing as an %s ExecStopPre (ignored)", unit, section)
for env_file in conf.getlist(Service, "EnvironmentFile", []):
if env_file.startswith("-"): continue
if not os.path.isfile(os_path(self._root, self.expand_special(env_file, conf))):
logg.error(" %s: Failed to load environment files: %s", unit, env_file)
errors += 101
return errors
def exec_check_unit(self, conf, env, section = Service, exectype = ""):
if conf is None: # pragma: no cover (is never null)
return True
if not conf.data.has_section(section):
return True # pragma: no cover
haveType = conf.get(section, "Type", "simple")
if self.is_sysv_file(conf.filename()):
return True # we don't care about that
unit = conf.name()
abspath = 0
notexists = 0
badusers = 0
badgroups = 0
for execs in ["ExecStartPre", "ExecStart", "ExecStartPost", "ExecStop", "ExecStopPost", "ExecReload"]:
if not execs.startswith(exectype):
continue
for cmd in conf.getlist(section, execs, []):
mode, newcmd = self.exec_newcmd(cmd, env, conf)
if not newcmd:
continue
exe = newcmd[0]
if not exe:
continue
if exe[0] != "/":
logg.error(" %s: Exec is not an absolute path: %s=%s", unit, execs, cmd)
abspath += 1
if not os.path.isfile(exe):
logg.error(" %s: Exec command does not exist: (%s) %s", unit, execs, exe)
if mode.check:
notexists += 1
newexe1 = os.path.join("/usr/bin", exe)
newexe2 = os.path.join("/bin", exe)
if os.path.exists(newexe1):
logg.error(" %s: but this does exist: %s %s", unit, " " * len(execs), newexe1)
elif os.path.exists(newexe2):
logg.error(" %s: but this does exist: %s %s", unit, " " * len(execs), newexe2)
users = [conf.get(section, "User", ""), conf.get(section, "SocketUser", "")]
groups = [conf.get(section, "Group", ""), conf.get(section, "SocketGroup", "")] + conf.getlist(section, "SupplementaryGroups")
for user in users:
if user:
try: pwd.getpwnam(self.expand_special(user, conf))
except Exception as e:
logg.error(" %s: User does not exist: %s (%s)", unit, user, getattr(e, "__doc__", ""))
badusers += 1
for group in groups:
if group:
try: grp.getgrnam(self.expand_special(group, conf))
except Exception as e:
logg.error(" %s: Group does not exist: %s (%s)", unit, group, getattr(e, "__doc__", ""))
badgroups += 1
tmpproblems = 0
for setting in ("RootDirectory", "RootImage", "BindPaths", "BindReadOnlyPaths",
"ReadWritePaths", "ReadOnlyPaths", "TemporaryFileSystem"):
setting_value = conf.get(section, setting, "")
if setting_value:
logg.info("%s: %s private directory remounts ignored: %s=%s", unit, section, setting, setting_value)
tmpproblems += 1
for setting in ("PrivateTmp", "PrivateDevices", "PrivateNetwork", "PrivateUsers", "DynamicUser",
"ProtectSystem", "ProjectHome", "ProtectHostname", "PrivateMounts", "MountAPIVFS"):
setting_yes = conf.getbool(section, setting, "no")
if setting_yes:
logg.info("%s: %s private directory option is ignored: %s=yes", unit, section, setting)
tmpproblems += 1
if not abspath and not notexists and not badusers and not badgroups:
return True
if True:
filename = strE(conf.filename())
if len(filename) > 44: filename = o44(filename)
logg.error(" !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!")
if abspath:
logg.error(" The SystemD ExecXY commands must always be absolute paths by definition.")
time.sleep(1)
if notexists:
logg.error(" Oops, %s executable paths were not found in the current environment. Refusing.", notexists)
time.sleep(1)
if badusers or badgroups:
logg.error(" Oops, %s user names and %s group names were not found. Refusing.", badusers, badgroups)
time.sleep(1)
if tmpproblems:
logg.info(" Note, %s private directory settings are ignored. The application should not depend on it.", tmpproblems)
time.sleep(1)
logg.error(" !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!")
return False
def show_modules(self, *modules):
""" [PATTERN]... -- Show properties of one or more units
Show properties of one or more units (or the manager itself).
If no argument is specified, properties of the manager will be
shown. If a unit name is specified, properties of the unit is
shown. By default, empty properties are suppressed. Use --all to
show those too. To select specific properties to show, use
--property=. This command is intended to be used whenever
computer-parsable output is required. Use status if you are looking
for formatted human-readable output.
/
NOTE: only a subset of properties is implemented """
notfound = []
units = []
found_all = True
for module in modules:
matched = self.match_units(to_list(module))
if not matched:
logg.error("Unit %s could not be found.", unit_of(module))
units += [module]
# self.error |= NOT_FOUND
found_all = False
continue
for unit in matched:
if unit not in units:
units += [unit]
return self.show_units(units) + notfound # and found_all
def show_units(self, units):
logg.debug("show --property=%s", ",".join(self._only_property))
result = []
for unit in units:
if result: result += [""]
for var, value in self.show_unit_items(unit):
if self._only_property:
if var not in self._only_property:
continue
else:
if not value and not self._show_all:
continue
result += ["%s=%s" % (var, value)]
return result
def show_unit_items(self, unit):
""" [UNIT]... -- show properties of a unit.
"""
logg.info("try read unit %s", unit)
conf = self.get_unit_conf(unit)
for entry in self.each_unit_items(unit, conf):
yield entry
def each_unit_items(self, unit, conf):
loaded = conf.loaded()
if not loaded:
loaded = "not-loaded"
if "NOT-FOUND" in self.get_description_from(conf):
loaded = "not-found"
names = {unit: 1, conf.name(): 1}
yield "Id", conf.name()
yield "Names", " ".join(sorted(names.keys()))
yield "Description", self.get_description_from(conf) # conf.get(Unit, "Description")
yield "PIDFile", self.get_pid_file(conf) # not self.pid_file_from w/o default location
yield "PIDFilePath", self.pid_file_from(conf)
yield "MainPID", strE(self.active_pid_from(conf)) # status["MainPID"] or PIDFile-read
yield "SubState", self.get_substate_from(conf) or "unknown" # status["SubState"] or notify-result
yield "ActiveState", self.get_active_from(conf) or "unknown" # status["ActiveState"]
yield "LoadState", loaded
yield "UnitFileState", self.enabled_from(conf)
yield "StatusFile", self.get_StatusFile(conf)
yield "StatusFilePath", self.get_status_file_from(conf)
yield "JournalFile", self.get_journal_log(conf)
yield "JournalFilePath", self.get_journal_log_from(conf)
yield "NotifySocket", self.get_notify_socket_from(conf)
yield "User", self.get_User(conf) or ""
yield "Group", self.get_Group(conf) or ""
yield "SupplementaryGroups", " ".join(self.get_SupplementaryGroups(conf))
yield "TimeoutStartUSec", seconds_to_time(self.get_TimeoutStartSec(conf))
yield "TimeoutStopUSec", seconds_to_time(self.get_TimeoutStopSec(conf))
yield "NeedDaemonReload", "no"
yield "SendSIGKILL", strYes(self.get_SendSIGKILL(conf))
yield "SendSIGHUP", strYes(self.get_SendSIGHUP(conf))
yield "KillMode", strE(self.get_KillMode(conf))
yield "KillSignal", strE(self.get_KillSignal(conf))
yield "StartLimitBurst", strE(self.get_StartLimitBurst(conf))
yield "StartLimitIntervalSec", seconds_to_time(self.get_StartLimitIntervalSec(conf))
yield "RestartSec", seconds_to_time(self.get_RestartSec(conf))
yield "RemainAfterExit", strYes(self.get_RemainAfterExit(conf))
yield "WorkingDirectory", strE(self.get_WorkingDirectory(conf))
env_parts = []
for env_part in conf.getlist(Service, "Environment", []):
env_parts.append(self.expand_special(env_part, conf))
if env_parts:
yield "Environment", " ".join(env_parts)
env_files = []
for env_file in conf.getlist(Service, "EnvironmentFile", []):
env_files.append(self.expand_special(env_file, conf))
if env_files:
yield "EnvironmentFile", " ".join(env_files)
def get_SendSIGKILL(self, conf):
return conf.getbool(Service, "SendSIGKILL", "yes")
def get_SendSIGHUP(self, conf):
return conf.getbool(Service, "SendSIGHUP", "no")
def get_KillMode(self, conf):
return conf.get(Service, "KillMode", "control-group")
def get_KillSignal(self, conf):
return conf.get(Service, "KillSignal", "SIGTERM")
#
igno_centos = ["netconsole", "network"]
igno_opensuse = ["raw", "pppoe", "*.local", "boot.*", "rpmconf*", "postfix*"]
igno_ubuntu = ["mount*", "umount*", "ondemand", "*.local"]
igno_always = ["network*", "dbus*", "systemd-*", "kdump*", "kmod*"]
igno_always += ["purge-kernels.service", "after-local.service", "dm-event.*"] # as on opensuse
igno_targets = ["remote-fs.target"]
def _ignored_unit(self, unit, ignore_list):
for ignore in ignore_list:
if fnmatch.fnmatchcase(unit, ignore):
return True # ignore
if fnmatch.fnmatchcase(unit, ignore+".service"):
return True # ignore
return False
def default_services_modules(self, *modules):
""" show the default services
This is used internally to know the list of service to be started in the 'get-default'
target runlevel when the container is started through default initialisation. It will
ignore a number of services - use '--all' to show a longer list of services and
use '--all --force' if not even a minimal filter shall be used.
"""
results = []
targets = modules or [self.get_default_target()]
for target in targets:
units = self.target_default_services(target)
logg.debug(" %s # %s", " ".join(units), target)
for unit in units:
if unit not in results:
results.append(unit)
return results
def target_default_services(self, target = None, sysv = "S"):
""" get the default services for a target - this will ignore a number of services,
use '--all' and --force' to get more services.
"""
igno = self.igno_centos + self.igno_opensuse + self.igno_ubuntu + self.igno_always
if self._show_all:
igno = self.igno_always
if self._force:
igno = []
logg.debug("ignored services filter for default.target:\n\t%s", igno)
default_target = target or self.get_default_target()
return self.enabled_target_services(default_target, sysv, igno)
def enabled_target_services(self, target, sysv = "S", igno = []):
units = []
if self.user_mode():
targetlist = self.get_target_list(target)
logg.debug("check for %s user services : %s", target, targetlist)
for targets in targetlist:
for unit in self.enabled_target_user_local_units(targets, ".target", igno):
if unit not in units:
units.append(unit)
for targets in targetlist:
for unit in self.required_target_units(targets, ".socket", igno):
if unit not in units:
units.append(unit)
for targets in targetlist:
for unit in self.enabled_target_user_local_units(targets, ".socket", igno):
if unit not in units:
units.append(unit)
for targets in targetlist:
for unit in self.required_target_units(targets, ".service", igno):
if unit not in units:
units.append(unit)
for targets in targetlist:
for unit in self.enabled_target_user_local_units(targets, ".service", igno):
if unit not in units:
units.append(unit)
for targets in targetlist:
for unit in self.enabled_target_user_system_units(targets, ".service", igno):
if unit not in units:
units.append(unit)
else:
targetlist = self.get_target_list(target)
logg.debug("check for %s system services: %s", target, targetlist)
for targets in targetlist:
for unit in self.enabled_target_configured_system_units(targets, ".target", igno + self.igno_targets):
if unit not in units:
units.append(unit)
for targets in targetlist:
for unit in self.required_target_units(targets, ".socket", igno):
if unit not in units:
units.append(unit)
for targets in targetlist:
for unit in self.enabled_target_installed_system_units(targets, ".socket", igno):
if unit not in units:
units.append(unit)
for targets in targetlist:
for unit in self.required_target_units(targets, ".service", igno):
if unit not in units:
units.append(unit)
for targets in targetlist:
for unit in self.enabled_target_installed_system_units(targets, ".service", igno):
if unit not in units:
units.append(unit)
for targets in targetlist:
for unit in self.enabled_target_sysv_units(targets, sysv, igno):
if unit not in units:
units.append(unit)
return units
def enabled_target_user_local_units(self, target, unit_kind = ".service", igno = []):
units = []
for basefolder in self.user_folders():
if not basefolder:
continue
folder = self.default_enablefolder(target, basefolder)
if self._root:
folder = os_path(self._root, folder)
if os.path.isdir(folder):
for unit in sorted(os.listdir(folder)):
path = os.path.join(folder, unit)
if os.path.isdir(path): continue
if self._ignored_unit(unit, igno):
continue # ignore
if unit.endswith(unit_kind):
units.append(unit)
return units
def enabled_target_user_system_units(self, target, unit_kind = ".service", igno = []):
units = []
for basefolder in self.system_folders():
if not basefolder:
continue
folder = self.default_enablefolder(target, basefolder)
if self._root:
folder = os_path(self._root, folder)
if os.path.isdir(folder):
for unit in sorted(os.listdir(folder)):
path = os.path.join(folder, unit)
if os.path.isdir(path): continue
if self._ignored_unit(unit, igno):
continue # ignore
if unit.endswith(unit_kind):
conf = self.load_unit_conf(unit)
if conf is None:
pass
elif self.not_user_conf(conf):
pass
else:
units.append(unit)
return units
def enabled_target_installed_system_units(self, target, unit_type = ".service", igno = []):
units = []
for basefolder in self.system_folders():
if not basefolder:
continue
folder = self.default_enablefolder(target, basefolder)
if self._root:
folder = os_path(self._root, folder)
if os.path.isdir(folder):
for unit in sorted(os.listdir(folder)):
path = os.path.join(folder, unit)
if os.path.isdir(path): continue
if self._ignored_unit(unit, igno):
continue # ignore
if unit.endswith(unit_type):
units.append(unit)
return units
def enabled_target_configured_system_units(self, target, unit_type = ".service", igno = []):
units = []
if True:
folder = self.default_enablefolder(target)
if self._root:
folder = os_path(self._root, folder)
if os.path.isdir(folder):
for unit in sorted(os.listdir(folder)):
path = os.path.join(folder, unit)
if os.path.isdir(path): continue
if self._ignored_unit(unit, igno):
continue # ignore
if unit.endswith(unit_type):
units.append(unit)
return units
def enabled_target_sysv_units(self, target, sysv = "S", igno = []):
units = []
folders = []
if target in ["multi-user.target", DefaultUnit]:
folders += [self.rc3_root_folder()]
if target in ["graphical.target"]:
folders += [self.rc5_root_folder()]
for folder in folders:
if not os.path.isdir(folder):
logg.warning("non-existent %s", folder)
continue
for unit in sorted(os.listdir(folder)):
path = os.path.join(folder, unit)
if os.path.isdir(path): continue
m = re.match(sysv+r"\d\d(.*)", unit)
if m:
service = m.group(1)
unit = service + ".service"
if self._ignored_unit(unit, igno):
continue # ignore
units.append(unit)
return units
def required_target_units(self, target, unit_type, igno):
units = []
deps = self.get_required_dependencies(target)
for unit in sorted(deps):
if self._ignored_unit(unit, igno):
continue # ignore
if unit.endswith(unit_type):
if unit not in units:
units.append(unit)
return units
def get_target_conf(self, module): # -> conf (conf | default-conf)
""" accept that a unit does not exist
and return a unit conf that says 'not-loaded' """
conf = self.load_unit_conf(module)
if conf is not None:
return conf
target_conf = self.default_unit_conf(module)
if module in target_requires:
target_conf.set(Unit, "Requires", target_requires[module])
return target_conf
def get_target_list(self, module):
""" the Requires= in target units are only accepted if known """
target = module
if "." not in target: target += ".target"
targets = [target]
conf = self.get_target_conf(module)
requires = conf.get(Unit, "Requires", "")
while requires in target_requires:
targets = [requires] + targets
requires = target_requires[requires]
logg.debug("the %s requires %s", module, targets)
return targets
def default_system(self, arg = True):
""" start units for default system level
This will go through the enabled services in the default 'multi-user.target'.
However some services are ignored as being known to be installation garbage
from unintended services. Use '--all' so start all of the installed services
and with '--all --force' even those services that are otherwise wrong.
/// SPECIAL: with --now or --init the init-loop is run and afterwards
a system_halt is performed with the enabled services to be stopped."""
self.sysinit_status(SubState = "initializing")
logg.info("system default requested - %s", arg)
init = self._now or self._init
return self.start_system_default(init = init)
def start_system_default(self, init = False):
""" detect the default.target services and start them.
When --init is given then the init-loop is run and
the services are stopped again by 'systemctl halt'."""
target = self.get_default_target()
services = self.start_target_system(target, init)
logg.info("%s system is up", target)
if init:
logg.info("init-loop start")
sig = self.init_loop_until_stop(services)
logg.info("init-loop %s", sig)
self.stop_system_default()
return not not services
def start_target_system(self, target, init = False):
services = self.target_default_services(target, "S")
self.sysinit_status(SubState = "starting")
self.start_units(services)
return services
def do_start_target_from(self, conf):
target = conf.name()
# services = self.start_target_system(target)
services = self.target_default_services(target, "S")
units = [service for service in services if not self.is_running_unit(service)]
logg.debug("start %s is starting %s from %s", target, units, services)
return self.start_units(units)
def stop_system_default(self):
""" detect the default.target services and stop them.
This is commonly run through 'systemctl halt' or
at the end of a 'systemctl --init default' loop."""
target = self.get_default_target()
services = self.stop_target_system(target)
logg.info("%s system is down", target)
return not not services
def stop_target_system(self, target):
services = self.target_default_services(target, "K")
self.sysinit_status(SubState = "stopping")
self.stop_units(services)
return services
def do_stop_target_from(self, conf):
target = conf.name()
# services = self.stop_target_system(target)
services = self.target_default_services(target, "K")
units = [service for service in services if self.is_running_unit(service)]
logg.debug("stop %s is stopping %s from %s", target, units, services)
return self.stop_units(units)
def do_reload_target_from(self, conf):
target = conf.name()
return self.reload_target_system(target)
def reload_target_system(self, target):
services = self.target_default_services(target, "S")
units = [service for service in services if self.is_running_unit(service)]
return self.reload_units(units)
def halt_target(self, arg = True):
""" stop units from default system level """
logg.info("system halt requested - %s", arg)
done = self.stop_system_default()
try:
os.kill(1, signal.SIGQUIT) # exit init-loop on no_more_procs
except Exception as e:
logg.warning("SIGQUIT to init-loop on PID-1: %s", e)
return done
def system_get_default(self):
""" get current default run-level"""
return self.get_default_target()
def get_targets_folder(self):
return os_path(self._root, self.mask_folder())
def get_default_target_file(self):
targets_folder = self.get_targets_folder()
return os.path.join(targets_folder, DefaultUnit)
def get_default_target(self, default_target = None):
""" get current default run-level"""
current = default_target or self._default_target
default_target_file = self.get_default_target_file()
if os.path.islink(default_target_file):
current = os.path.basename(os.readlink(default_target_file))
return current
def set_default_modules(self, *modules):
""" set current default run-level"""
if not modules:
logg.debug(".. no runlevel given")
self.error |= NOT_OK
return "Too few arguments"
current = self.get_default_target()
default_target_file = self.get_default_target_file()
msg = ""
for module in modules:
if module == current:
continue
targetfile = None
for targetname, targetpath in self.each_target_file():
if targetname == module:
targetfile = targetpath
if not targetfile:
self.error |= NOT_OK | NOT_ACTIVE # 3
msg = "No such runlevel %s" % (module)
continue
#
if os.path.islink(default_target_file):
os.unlink(default_target_file)
if not os.path.isdir(os.path.dirname(default_target_file)):
os.makedirs(os.path.dirname(default_target_file))
os.symlink(targetfile, default_target_file)
msg = "Created symlink from %s -> %s" % (default_target_file, targetfile)
logg.debug("%s", msg)
return msg
def init_modules(self, *modules):
""" [UNIT*] -- init loop: '--init default' or '--init start UNIT*'
The systemctl init service will start the enabled 'default' services,
and then wait for any zombies to be reaped. When a SIGINT is received
then a clean shutdown of the enabled services is ensured. A Control-C in
in interactive mode will also run 'stop' on all the enabled services. //
When a UNIT name is given then only that one is started instead of the
services in the 'default.target'. Using 'init UNIT' is better than
'--init start UNIT' because the UNIT is also stopped cleanly even when
it was never enabled in the system.
/// SPECIAL: when using --now then only the init-loop is started,
with the reap-zombies function and waiting for an interrupt.
(and no unit is started/stoppped wether given or not).
"""
if self._now:
result = self.init_loop_until_stop([])
return not not result
if not modules:
# like 'systemctl --init default'
if self._now or self._show_all:
logg.debug("init default --now --all => no_more_procs")
self.doExitWhenNoMoreProcs = True
return self.start_system_default(init = True)
#
# otherwise quit when all the init-services have died
self.doExitWhenNoMoreServices = True
if self._now or self._show_all:
logg.debug("init services --now --all => no_more_procs")
self.doExitWhenNoMoreProcs = True
found_all = True
units = []
for module in modules:
matched = self.match_units(to_list(module))
if not matched:
logg.error("Unit %s could not be found.", unit_of(module))
found_all = False
continue
for unit in matched:
if unit not in units:
units += [unit]
logg.info("init %s -> start %s", ",".join(modules), ",".join(units))
done = self.start_units(units, init = True)
logg.info("-- init is done")
return done # and found_all
def start_log_files(self, units):
self._log_file = {}
self._log_hold = {}
for unit in units:
conf = self.load_unit_conf(unit)
if not conf: continue
if self.skip_journal_log(conf): continue
log_path = self.get_journal_log_from(conf)
try:
opened = os.open(log_path, os.O_RDONLY | os.O_NONBLOCK)
self._log_file[unit] = opened
self._log_hold[unit] = b""
except Exception as e:
logg.error("can not open %s log: %s\n\t%s", unit, log_path, e)
def read_log_files(self, units):
self.print_log_files(units)
def print_log_files(self, units, stdout = 1):
BUFSIZE=8192
printed = 0
for unit in units:
if unit in self._log_file:
new_text = b""
while True:
buf = os.read(self._log_file[unit], BUFSIZE)
if not buf: break
new_text += buf
continue
text = self._log_hold[unit] + new_text
if not text: continue
lines = text.split(b"\n")
if not text.endswith(b"\n"):
self._log_hold[unit] = lines[-1]
lines = lines[:-1]
for line in lines:
prefix = unit.encode("utf-8")
content = prefix+b": "+line+b"\n"
try:
os.write(stdout, content)
try:
os.fsync(stdout)
except Exception:
pass
printed += 1
except BlockingIOError:
pass
return printed
def stop_log_files(self, units):
for unit in units:
try:
if unit in self._log_file:
if self._log_file[unit]:
os.close(self._log_file[unit])
except Exception as e:
logg.error("can not close log: %s\n\t%s", unit, e)
self._log_file = {}
self._log_hold = {}
def get_StartLimitBurst(self, conf):
defaults = DefaultStartLimitBurst
return to_int(conf.get(Service, "StartLimitBurst", strE(defaults)), defaults) # 5
def get_StartLimitIntervalSec(self, conf, maximum = None):
maximum = maximum or 999
defaults = DefaultStartLimitIntervalSec
interval = conf.get(Service, "StartLimitIntervalSec", strE(defaults)) # 10s
return time_to_seconds(interval, maximum)
def get_RestartSec(self, conf, maximum = None):
maximum = maximum or DefaultMaximumTimeout
delay = conf.get(Service, "RestartSec", strE(DefaultRestartSec))
return time_to_seconds(delay, maximum)
def restart_failed_units(self, units, maximum = None):
""" This function will restart failed units.
/
NOTE that with standard settings the LimitBurst implementation has no effect. If
the InitLoopSleep is ticking at the Default of 5sec and the LimitBurst Default
is 5x within a Default 10secs time frame then within those 10sec only 2 loop
rounds have come here checking for possible restarts. You can directly shorten
the interval ('-c InitLoopSleep=1') or have it indirectly shorter from the
service descriptor's RestartSec ("RestartSec=2s").
"""
global InitLoopSleep
me = os.getpid()
maximum = maximum or DefaultStartLimitIntervalSec
restartDelay = MinimumYield
for unit in units:
now = time.time()
try:
conf = self.load_unit_conf(unit)
if not conf: continue
restartPolicy = conf.get(Service, "Restart", "no")
if restartPolicy in ["no", "on-success"]:
logg.debug("[%s] [%s] Current NoCheck (Restart=%s)", me, unit, restartPolicy)
continue
restartSec = self.get_RestartSec(conf)
if restartSec == 0:
if InitLoopSleep > 1:
logg.warning("[%s] set InitLoopSleep from %ss to 1 (caused by RestartSec=0!)",
unit, InitLoopSleep)
InitLoopSleep = 1
elif restartSec > 0.9 and restartSec < InitLoopSleep:
restartSleep = int(restartSec + 0.2)
if restartSleep < InitLoopSleep:
logg.warning("[%s] set InitLoopSleep from %ss to %s (caused by RestartSec=%.3fs)",
unit, InitLoopSleep, restartSleep, restartSec)
InitLoopSleep = restartSleep
isUnitState = self.get_active_from(conf)
isUnitFailed = isUnitState in ["failed"]
logg.debug("[%s] [%s] Current Status: %s (%s)", me, unit, isUnitState, isUnitFailed)
if not isUnitFailed:
if unit in self._restart_failed_units:
del self._restart_failed_units[unit]
continue
limitBurst = self.get_StartLimitBurst(conf)
limitSecs = self.get_StartLimitIntervalSec(conf)
if limitBurst > 1 and limitSecs >= 1:
try:
if unit not in self._restarted_unit:
self._restarted_unit[unit] = []
# we want to register restarts from now on
restarted = self._restarted_unit[unit]
logg.debug("[%s] [%s] Current limitSecs=%ss limitBurst=%sx (restarted %sx)",
me, unit, limitSecs, limitBurst, len(restarted))
oldest = 0.
interval = 0.
if len(restarted) >= limitBurst:
logg.debug("[%s] [%s] restarted %s",
me, unit, ["%.3fs" % (t - now) for t in restarted])
while len(restarted):
oldest = restarted[0]
interval = time.time() - oldest
if interval > limitSecs:
restarted = restarted[1:]
continue
break
self._restarted_unit[unit] = restarted
logg.debug("[%s] [%s] ratelimit %s",
me, unit, ["%.3fs" % (t - now) for t in restarted])
# all values in restarted have a time below limitSecs
if len(restarted) >= limitBurst:
logg.info("[%s] [%s] Blocking Restart - oldest %s is %s ago (allowed %s)",
me, unit, oldest, interval, limitSecs)
self.write_status_from(conf, AS="error")
unit = "" # dropped out
continue
except Exception as e:
logg.error("[%s] burst exception %s", unit, e)
if unit: # not dropped out
if unit not in self._restart_failed_units:
self._restart_failed_units[unit] = now + restartSec
logg.debug("[%s] [%s] restart scheduled in %+.3fs",
me, unit, (self._restart_failed_units[unit] - now))
except Exception as e:
logg.error("[%s] [%s] An error occurred while restart checking: %s", me, unit, e)
if not self._restart_failed_units:
self.error |= NOT_OK
return []
# NOTE: this function is only called from InitLoop when "running"
# let's check if any of the restart_units has its restartSec expired
now = time.time()
restart_done = []
logg.debug("[%s] Restart checking %s",
me, ["%+.3fs" % (t - now) for t in self._restart_failed_units.values()])
for unit in sorted(self._restart_failed_units):
restartAt = self._restart_failed_units[unit]
if restartAt > now:
continue
restart_done.append(unit)
try:
conf = self.load_unit_conf(unit)
if not conf: continue
isUnitState = self.get_active_from(conf)
isUnitFailed = isUnitState in ["failed"]
logg.debug("[%s] [%s] Restart Status: %s (%s)", me, unit, isUnitState, isUnitFailed)
if isUnitFailed:
logg.debug("[%s] [%s] --- restarting failed unit...", me, unit)
self.restart_unit(unit)
logg.debug("[%s] [%s] --- has been restarted.", me, unit)
if unit in self._restarted_unit:
self._restarted_unit[unit].append(time.time())
except Exception as e:
logg.error("[%s] [%s] An error occurred while restarting: %s", me, unit, e)
for unit in restart_done:
if unit in self._restart_failed_units:
del self._restart_failed_units[unit]
logg.debug("[%s] Restart remaining %s",
me, ["%+.3fs" % (t - now) for t in self._restart_failed_units.values()])
return restart_done
def init_loop_until_stop(self, units):
""" this is the init-loop - it checks for any zombies to be reaped and
waits for an interrupt. When a SIGTERM /SIGINT /Control-C signal
is received then the signal name is returned. Any other signal will
just raise an Exception like one would normally expect. As a special
the 'systemctl halt' emits SIGQUIT which puts it into no_more_procs mode."""
signal.signal(signal.SIGQUIT, lambda signum, frame: ignore_signals_and_raise_keyboard_interrupt("SIGQUIT"))
signal.signal(signal.SIGINT, lambda signum, frame: ignore_signals_and_raise_keyboard_interrupt("SIGINT"))
signal.signal(signal.SIGTERM, lambda signum, frame: ignore_signals_and_raise_keyboard_interrupt("SIGTERM"))
result = None
#
self.start_log_files(units)
logg.debug("start listen")
listen = SystemctlListenThread(self)
logg.debug("starts listen")
listen.start()
logg.debug("started listen")
self.sysinit_status(ActiveState = "active", SubState = "running")
timestamp = time.time()
while True:
try:
if DEBUG_INITLOOP: # pragma: no cover
logg.debug("DONE InitLoop (sleep %ss)", InitLoopSleep)
sleep_sec = InitLoopSleep - (time.time() - timestamp)
if sleep_sec < MinimumYield:
sleep_sec = MinimumYield
sleeping = sleep_sec
while sleeping > 2:
time.sleep(1) # accept signals atleast every second
sleeping = InitLoopSleep - (time.time() - timestamp)
if sleeping < MinimumYield:
sleeping = MinimumYield
break
time.sleep(sleeping) # remainder waits less that 2 seconds
timestamp = time.time()
self.loop.acquire()
if DEBUG_INITLOOP: # pragma: no cover
logg.debug("NEXT InitLoop (after %ss)", sleep_sec)
self.read_log_files(units)
if DEBUG_INITLOOP: # pragma: no cover
logg.debug("reap zombies - check current processes")
running = self.reap_zombies()
if DEBUG_INITLOOP: # pragma: no cover
logg.debug("reap zombies - init-loop found %s running procs", running)
if self.doExitWhenNoMoreServices:
active = False
for unit in units:
conf = self.load_unit_conf(unit)
if not conf: continue
if self.is_active_from(conf):
active = True
if not active:
logg.info("no more services - exit init-loop")
break
if self.doExitWhenNoMoreProcs:
if not running:
logg.info("no more procs - exit init-loop")
break
if RESTART_FAILED_UNITS:
self.restart_failed_units(units)
self.loop.release()
except KeyboardInterrupt as e:
if e.args and e.args[0] == "SIGQUIT":
# the original systemd puts a coredump on that signal.
logg.info("SIGQUIT - switch to no more procs check")
self.doExitWhenNoMoreProcs = True
continue
signal.signal(signal.SIGTERM, signal.SIG_DFL)
signal.signal(signal.SIGINT, signal.SIG_DFL)
logg.info("interrupted - exit init-loop")
result = str(e) or "STOPPED"
break
except Exception as e:
logg.info("interrupted - exception %s", e)
raise
self.sysinit_status(ActiveState = None, SubState = "degraded")
try: self.loop.release()
except: pass
listen.stop()
listen.join(2)
self.read_log_files(units)
self.read_log_files(units)
self.stop_log_files(units)
logg.debug("done - init loop")
return result
def reap_zombies_target(self):
""" -- check to reap children (internal) """
running = self.reap_zombies()
return "remaining {running} process".format(**locals())
def reap_zombies(self):
""" check to reap children """
selfpid = os.getpid()
running = 0
for pid_entry in os.listdir(_proc_pid_dir):
pid = to_intN(pid_entry)
if pid is None:
continue
if pid == selfpid:
continue
proc_status = _proc_pid_status.format(**locals())
if os.path.isfile(proc_status):
zombie = False
ppid = -1
try:
with open(proc_status) as f:
for line in f:
m = re.match(r"State:\s*Z.*", line)
if m: zombie = True
m = re.match(r"PPid:\s*(\d+)", line)
if m: ppid = int(m.group(1))
except IOError as e:
logg.warning("%s : %s", proc_status, e)
continue
if zombie and ppid == os.getpid():
logg.info("reap zombie %s", pid)
try: os.waitpid(pid, os.WNOHANG)
except OSError as e:
logg.warning("reap zombie %s: %s", e.strerror)
if os.path.isfile(proc_status):
if pid > 1:
running += 1
return running # except PID 0 and PID 1
def sysinit_status(self, **status):
conf = self.sysinit_target()
self.write_status_from(conf, **status)
def sysinit_target(self):
if not self._sysinit_target:
self._sysinit_target = self.default_unit_conf(SysInitTarget, "System Initialization")
assert self._sysinit_target is not None
return self._sysinit_target
def is_system_running(self):
conf = self.sysinit_target()
if not self.is_running_unit_from(conf):
time.sleep(MinimumYield)
if not self.is_running_unit_from(conf):
return "offline"
status = self.read_status_from(conf)
return status.get("SubState", "unknown")
def is_system_running_info(self):
state = self.is_system_running()
if state not in ["running"]:
self.error |= NOT_OK # 1
if self._quiet:
return None
return state
def wait_system(self, target = None):
target = target or SysInitTarget
for attempt in xrange(int(SysInitWait)):
state = self.is_system_running()
if "init" in state:
if target in [SysInitTarget, "basic.target"]:
logg.info("system not initialized - wait %s", target)
time.sleep(1)
continue
if "start" in state or "stop" in state:
if target in ["basic.target"]:
logg.info("system not running - wait %s", target)
time.sleep(1)
continue
if "running" not in state:
logg.info("system is %s", state)
break
def is_running_unit_from(self, conf):
status_file = self.get_status_file_from(conf)
pid_file = self.pid_file_from(conf)
return self.getsize(status_file) > 0 or self.getsize(pid_file) > 0
def is_running_unit(self, unit):
conf = self.get_unit_conf(unit)
return self.is_running_unit_from(conf)
def pidlist_of(self, pid):
if not pid:
return []
pidlist = [pid]
pids = [pid]
for depth in xrange(PROC_MAX_DEPTH):
for pid_entry in os.listdir(_proc_pid_dir):
pid = to_intN(pid_entry)
if pid is None:
continue
proc_status = _proc_pid_status.format(**locals())
if os.path.isfile(proc_status):
try:
with open(proc_status) as f:
for line in f:
if line.startswith("PPid:"):
ppid_text = line[len("PPid:"):].strip()
try: ppid = int(ppid_text)
except: continue
if ppid in pidlist and pid not in pids:
pids += [pid]
except IOError as e:
logg.warning("%s : %s", proc_status, e)
continue
if len(pids) != len(pidlist):
pidlist = pids[:]
continue
return pids
def echo(self, *targets):
line = " ".join(*targets)
logg.info(" == echo == %s", line)
return line
def killall(self, *targets):
mapping = {}
mapping[":3"] = signal.SIGQUIT
mapping[":QUIT"] = signal.SIGQUIT
mapping[":6"] = signal.SIGABRT
mapping[":ABRT"] = signal.SIGABRT
mapping[":9"] = signal.SIGKILL
mapping[":KILL"] = signal.SIGKILL
sig = signal.SIGTERM
for target in targets:
if target.startswith(":"):
if target in mapping:
sig = mapping[target]
else: # pragma: no cover
logg.error("unsupported %s", target)
continue
for pid_entry in os.listdir(_proc_pid_dir):
pid = to_intN(pid_entry)
if pid:
try:
cmdline = _proc_pid_cmdline.format(**locals())
with open(cmdline) as f:
cmd = f.read().split("\0")
if DEBUG_KILLALL: logg.debug("cmdline %s", cmd)
found = None
cmd_exe = os.path.basename(cmd[0])
if DEBUG_KILLALL: logg.debug("cmd.exe '%s'", cmd_exe)
if fnmatch.fnmatchcase(cmd_exe, target): found = "exe"
if len(cmd) > 1 and cmd_exe.startswith("python"):
X = 1
while cmd[X].startswith("-"): X += 1 # atleast '-u' unbuffered
cmd_arg = os.path.basename(cmd[X])
if DEBUG_KILLALL: logg.debug("cmd.arg '%s'", cmd_arg)
if fnmatch.fnmatchcase(cmd_arg, target): found = "arg"
if cmd_exe.startswith("coverage") or cmd_arg.startswith("coverage"):
x = cmd.index("--")
if x > 0 and x+1 < len(cmd):
cmd_run = os.path.basename(cmd[x+1])
if DEBUG_KILLALL: logg.debug("cmd.run '%s'", cmd_run)
if fnmatch.fnmatchcase(cmd_run, target): found = "run"
if found:
if DEBUG_KILLALL: logg.debug("%s found %s %s", found, pid, [c for c in cmd])
if pid != os.getpid():
logg.debug(" kill -%s %s # %s", sig, pid, target)
os.kill(pid, sig)
except Exception as e:
logg.error("kill -%s %s : %s", sig, pid, e)
return True
def force_ipv4(self, *args):
""" only ipv4 localhost in /etc/hosts """
logg.debug("checking hosts sysconf for '::1 localhost'")
lines = []
sysconf_hosts = os_path(self._root, _etc_hosts)
with open(sysconf_hosts) as f:
for line in f:
if "::1" in line:
newline = re.sub("\\slocalhost\\s", " ", line)
if line != newline:
logg.info("%s: '%s' => '%s'", _etc_hosts, line.rstrip(), newline.rstrip())
line = newline
lines.append(line)
with open(sysconf_hosts, "w") as f:
for line in lines:
f.write(line)
def force_ipv6(self, *args):
""" only ipv4 localhost in /etc/hosts """
logg.debug("checking hosts sysconf for '127.0.0.1 localhost'")
lines = []
sysconf_hosts = os_path(self._root, _etc_hosts)
with open(sysconf_hosts) as f:
for line in f:
if "127.0.0.1" in line:
newline = re.sub("\\slocalhost\\s", " ", line)
if line != newline:
logg.info("%s: '%s' => '%s'", _etc_hosts, line.rstrip(), newline.rstrip())
line = newline
lines.append(line)
with open(sysconf_hosts, "w") as f:
for line in lines:
f.write(line)
def help_modules(self, *args):
"""[command] -- show this help
"""
lines = []
okay = True
prog = os.path.basename(sys.argv[0])
if not args:
argz = {}
for name in dir(self):
arg = None
if name.startswith("system_"):
arg = name[len("system_"):].replace("_", "-")
if name.startswith("show_"):
arg = name[len("show_"):].replace("_", "-")
if name.endswith("_of_unit"):
arg = name[:-len("_of_unit")].replace("_", "-")
if name.endswith("_modules"):
arg = name[:-len("_modules")].replace("_", "-")
if arg:
argz[arg] = name
lines.append("%s command [options]..." % prog)
lines.append("")
lines.append("Commands:")
for arg in sorted(argz):
name = argz[arg]
method = getattr(self, name)
doc = "..."
doctext = getattr(method, "__doc__")
if doctext:
doc = doctext
elif not self._show_all:
continue # pragma: no cover
firstline = doc.split("\n")[0]
doc_text = firstline.strip()
if "--" not in firstline:
doc_text = "-- " + doc_text
lines.append(" %s %s" % (arg, firstline.strip()))
return lines
for arg in args:
arg = arg.replace("-", "_")
func1 = getattr(self.__class__, arg+"_modules", None)
func2 = getattr(self.__class__, arg+"_of_unit", None)
func3 = getattr(self.__class__, "show_"+arg, None)
func4 = getattr(self.__class__, "system_"+arg, None)
func5 = None
if arg.startswith("__"):
func5 = getattr(self.__class__, arg[2:], None)
func = func1 or func2 or func3 or func4 or func5
if func is None:
print("error: no such command '%s'" % arg)
okay = False
else:
doc_text = "..."
doc = getattr(func, "__doc__", "")
if doc:
doc_text = doc.replace("\n", "\n\n", 1).strip()
if "--" not in doc_text:
doc_text = "-- " + doc_text
else:
func_name = arg # FIXME
logg.debug("__doc__ of %s is none", func_name)
if not self._show_all: continue
lines.append("%s %s %s" % (prog, arg, doc_text))
if not okay:
self.help_modules()
self.error |= NOT_OK
return []
return lines
def systemd_version(self):
""" the version line for systemd compatibility """
return "systemd %s\n - via systemctl.py %s" % (self._systemd_version, __version__)
def systemd_features(self):
""" the info line for systemd features """
features1 = "-PAM -AUDIT -SELINUX -IMA -APPARMOR -SMACK"
features2 = " +SYSVINIT -UTMP -LIBCRYPTSETUP -GCRYPT -GNUTLS"
features3 = " -ACL -XZ -LZ4 -SECCOMP -BLKID -ELFUTILS -KMOD -IDN"
return features1+features2+features3
def version_info(self):
return [self.systemd_version(), self.systemd_features()]
def test_float(self):
return 0. # "Unknown result type"
def print_begin(argv, args):
script = os.path.realpath(argv[0])
system = _user_mode and " --user" or " --system"
init = _init and " --init" or ""
logg.info("EXEC BEGIN %s %s%s%s", script, " ".join(args), system, init)
if _root and not is_good_root(_root):
root44 = path44(_root)
logg.warning("the --root=%s should have atleast three levels /tmp/test_123/root", root44)
def print_begin2(args):
logg.debug("======= systemctl.py %s", " ".join(args))
def is_not_ok(result):
if DebugPrintResult:
logg.log(HINT, "EXEC END %s", result)
if result is False:
return NOT_OK
return 0
def print_str(result):
if result is None:
if DebugPrintResult:
logg.debug(" END %s", result)
return
print(result)
if DebugPrintResult:
result1 = result.split("\n")[0][:-20]
if result == result1:
logg.log(HINT, "EXEC END '%s'", result)
else:
logg.log(HINT, "EXEC END '%s...'", result1)
logg.debug(" END '%s'", result)
def print_str_list(result):
if result is None:
if DebugPrintResult:
logg.debug(" END %s", result)
return
shown = 0
for element in result:
print(element)
shown += 1
if DebugPrintResult:
logg.log(HINT, "EXEC END %i items", shown)
logg.debug(" END %s", result)
def print_str_list_list(result):
shown = 0
for element in result:
print("\t".join([str(elem) for elem in element]))
shown += 1
if DebugPrintResult:
logg.log(HINT, "EXEC END %i items", shown)
logg.debug(" END %s", result)
def print_str_dict(result):
if result is None:
if DebugPrintResult:
logg.debug(" END %s", result)
return
shown = 0
for key in sorted(result.keys()):
element = result[key]
print("%s=%s" % (key, element))
shown += 1
if DebugPrintResult:
logg.log(HINT, "EXEC END %i items", shown)
logg.debug(" END %s", result)
def print_str_dict_dict(result):
if result is None:
if DebugPrintResult:
logg.debug(" END %s", result)
return
shown = 0
for key in sorted(result):
element = result[key]
for name in sorted(element):
value = element[name]
print("%s [%s] %s" % (key, value, name))
shown += 1
if DebugPrintResult:
logg.log(HINT, "EXEC END %i items", shown)
logg.debug(" END %s", result)
def runcommand(command, *modules):
systemctl = Systemctl()
if FORCE_IPV4:
systemctl.force_ipv4()
elif FORCE_IPV6:
systemctl.force_ipv6()
exitcode = 0
if command in ["help"]:
print_str_list(systemctl.help_modules(*modules))
elif command in ["cat"]:
print_str(systemctl.cat_modules(*modules))
elif command in ["clean"]:
exitcode = is_not_ok(systemctl.clean_modules(*modules))
elif command in ["command"]:
print_str_list(systemctl.command_of_unit(*modules))
elif command in ["daemon-reload"]:
exitcode = is_not_ok(systemctl.daemon_reload_target())
elif command in ["default"]:
exitcode = is_not_ok(systemctl.default_system())
elif command in ["default-services"]:
print_str_list(systemctl.default_services_modules(*modules))
elif command in ["disable"]:
exitcode = is_not_ok(systemctl.disable_modules(*modules))
elif command in ["enable"]:
exitcode = is_not_ok(systemctl.enable_modules(*modules))
elif command in ["environment"]:
print_str_dict(systemctl.environment_of_unit(*modules))
elif command in ["get-default"]:
print_str(systemctl.get_default_target())
elif command in ["get-preset"]:
print_str(systemctl.get_preset_of_unit(*modules))
elif command in ["halt"]:
exitcode = is_not_ok(systemctl.halt_target())
elif command in ["init"]:
exitcode = is_not_ok(systemctl.init_modules(*modules))
elif command in ["is-active"]:
print_str_list(systemctl.is_active_modules(*modules))
elif command in ["is-enabled"]:
print_str_list(systemctl.is_enabled_modules(*modules))
elif command in ["is-failed"]:
print_str_list(systemctl.is_failed_modules(*modules))
elif command in ["is-system-running"]:
print_str(systemctl.is_system_running_info())
elif command in ["kill"]:
exitcode = is_not_ok(systemctl.kill_modules(*modules))
elif command in ["list-start-dependencies"]:
print_str_list_list(systemctl.list_start_dependencies_modules(*modules))
elif command in ["list-dependencies"]:
print_str_list(systemctl.list_dependencies_modules(*modules))
elif command in ["list-unit-files"]:
print_str_list_list(systemctl.list_unit_files_modules(*modules))
elif command in ["list-units"]:
print_str_list_list(systemctl.list_units_modules(*modules))
elif command in ["listen"]:
exitcode = is_not_ok(systemctl.listen_modules(*modules))
elif command in ["log", "logs"]:
exitcode = is_not_ok(systemctl.log_modules(*modules))
elif command in ["mask"]:
exitcode = is_not_ok(systemctl.mask_modules(*modules))
elif command in ["preset"]:
exitcode = is_not_ok(systemctl.preset_modules(*modules))
elif command in ["preset-all"]:
exitcode = is_not_ok(systemctl.preset_all_modules())
elif command in ["reap-zombies"]:
print_str(systemctl.reap_zombies_target())
elif command in ["reload"]:
exitcode = is_not_ok(systemctl.reload_modules(*modules))
elif command in ["reload-or-restart"]:
exitcode = is_not_ok(systemctl.reload_or_restart_modules(*modules))
elif command in ["reload-or-try-restart"]:
exitcode = is_not_ok(systemctl.reload_or_try_restart_modules(*modules))
elif command in ["reset-failed"]:
exitcode = is_not_ok(systemctl.reset_failed_modules(*modules))
elif command in ["restart"]:
exitcode = is_not_ok(systemctl.restart_modules(*modules))
elif command in ["set-default"]:
print_str(systemctl.set_default_modules(*modules))
elif command in ["show"]:
print_str_list(systemctl.show_modules(*modules))
elif command in ["start"]:
exitcode = is_not_ok(systemctl.start_modules(*modules))
elif command in ["status"]:
print_str(systemctl.status_modules(*modules))
elif command in ["stop"]:
exitcode = is_not_ok(systemctl.stop_modules(*modules))
elif command in ["try-restart"]:
exitcode = is_not_ok(systemctl.try_restart_modules(*modules))
elif command in ["unmask"]:
exitcode = is_not_ok(systemctl.unmask_modules(*modules))
elif command in ["version"]:
print_str_list(systemctl.version_info())
elif command in ["__cat_unit"]:
print_str(systemctl.cat_unit(*modules))
elif command in ["__get_active_unit"]:
print_str(systemctl.get_active_unit(*modules))
elif command in ["__get_description"]:
print_str(systemctl.get_description(*modules))
elif command in ["__get_status_file"]:
print_str(systemctl.get_status_file(modules[0]))
elif command in ["__get_status_pid_file", "__get_pid_file"]:
print_str(systemctl.get_status_pid_file(modules[0]))
elif command in ["__disable_unit"]:
exitcode = is_not_ok(systemctl.disable_unit(*modules))
elif command in ["__enable_unit"]:
exitcode = is_not_ok(systemctl.enable_unit(*modules))
elif command in ["__is_enabled"]:
exitcode = is_not_ok(systemctl.is_enabled(*modules))
elif command in ["__killall"]:
exitcode = is_not_ok(systemctl.killall(*modules))
elif command in ["__kill_unit"]:
exitcode = is_not_ok(systemctl.kill_unit(*modules))
elif command in ["__load_preset_files"]:
print_str_list(systemctl.load_preset_files(*modules))
elif command in ["__mask_unit"]:
exitcode = is_not_ok(systemctl.mask_unit(*modules))
elif command in ["__read_env_file"]:
print_str_list_list(list(systemctl.read_env_file(*modules)))
elif command in ["__reload_unit"]:
exitcode = is_not_ok(systemctl.reload_unit(*modules))
elif command in ["__reload_or_restart_unit"]:
exitcode = is_not_ok(systemctl.reload_or_restart_unit(*modules))
elif command in ["__reload_or_try_restart_unit"]:
exitcode = is_not_ok(systemctl.reload_or_try_restart_unit(*modules))
elif command in ["__reset_failed_unit"]:
exitcode = is_not_ok(systemctl.reset_failed_unit(*modules))
elif command in ["__restart_unit"]:
exitcode = is_not_ok(systemctl.restart_unit(*modules))
elif command in ["__start_unit"]:
exitcode = is_not_ok(systemctl.start_unit(*modules))
elif command in ["__stop_unit"]:
exitcode = is_not_ok(systemctl.stop_unit(*modules))
elif command in ["__try_restart_unit"]:
exitcode = is_not_ok(systemctl.try_restart_unit(*modules))
elif command in ["__test_start_unit"]:
systemctl.test_start_unit(*modules)
elif command in ["__unmask_unit"]:
exitcode = is_not_ok(systemctl.unmask_unit(*modules))
elif command in ["__show_unit_items"]:
print_str_list_list(list(systemctl.show_unit_items(*modules)))
else:
logg.error("Unknown operation %s", command)
return EXIT_FAILURE
#
exitcode |= systemctl.error
return exitcode
if __name__ == "__main__":
import optparse
_o = optparse.OptionParser("%prog [options] command [name...]",
epilog="use 'help' command for more information")
_o.add_option("--version", action="store_true",
help="Show package version")
_o.add_option("--system", action="store_true", default=False,
help="Connect to system manager (default)") # overrides --user
_o.add_option("--user", action="store_true", default=_user_mode,
help="Connect to user service manager")
# _o.add_option("-H", "--host", metavar="[USER@]HOST",
# help="Operate on remote host*")
# _o.add_option("-M", "--machine", metavar="CONTAINER",
# help="Operate on local container*")
_o.add_option("-t", "--type", metavar="TYPE", action="append", dest="only_type", default=_only_type,
help="List units of a particual type")
_o.add_option("--state", metavar="STATE", action="append", dest="only_state", default=_only_state,
help="List units with particular LOAD or SUB or ACTIVE state")
_o.add_option("-p", "--property", metavar="NAME", action="append", dest="only_property", default=_only_property,
help="Show only properties by this name")
_o.add_option("--what", metavar="TYPE", action="append", dest="only_what", default=_only_what,
help="Defines the service directories to be cleaned (configuration, state, cache, logs, runtime)")
_o.add_option("-a", "--all", action="store_true", dest="show_all", default=_show_all,
help="Show all loaded units/properties, including dead empty ones. To list all units installed on the system, use the 'list-unit-files' command instead")
_o.add_option("-l", "--full", action="store_true", default=_full,
help="Don't ellipsize unit names on output (never ellipsized)")
_o.add_option("--reverse", action="store_true",
help="Show reverse dependencies with 'list-dependencies' (ignored)")
_o.add_option("--job-mode", metavar="MODE",
help="Specify how to deal with already queued jobs, when queuing a new job (ignored)")
_o.add_option("--show-types", action="store_true",
help="When showing sockets, explicitly show their type (ignored)")
_o.add_option("-i", "--ignore-inhibitors", action="store_true",
help="When shutting down or sleeping, ignore inhibitors (ignored)")
_o.add_option("--kill-who", metavar="WHO",
help="Who to send signal to (ignored)")
_o.add_option("-s", "--signal", metavar="SIG",
help="Which signal to send (ignored)")
_o.add_option("--now", action="store_true", default=_now,
help="Start or stop unit in addition to enabling or disabling it")
_o.add_option("-q", "--quiet", action="store_true", default=_quiet,
help="Suppress output")
_o.add_option("--no-block", action="store_true", default=False,
help="Do not wait until operation finished (ignored)")
_o.add_option("--no-legend", action="store_true", default=_no_legend,
help="Do not print a legend (column headers and hints)")
_o.add_option("--no-wall", action="store_true", default=False,
help="Don't send wall message before halt/power-off/reboot (ignored)")
_o.add_option("--no-reload", action="store_true", default=_no_reload,
help="Don't reload daemon after en-/dis-abling unit files")
_o.add_option("--no-ask-password", action="store_true", default=_no_ask_password,
help="Do not ask for system passwords")
# _o.add_option("--global", action="store_true", dest="globally", default=_globally,
# help="Enable/disable unit files globally") # for all user logins
# _o.add_option("--runtime", action="store_true",
# help="Enable unit files only temporarily until next reboot")
_o.add_option("-f", "--force", action="store_true", default=_force,
help="When enabling unit files, override existing symblinks / When shutting down, execute action immediately")
_o.add_option("--preset-mode", metavar="TYPE", default=_preset_mode,
help="Apply only enable, only disable, or all presets [%default]")
_o.add_option("--root", metavar="PATH", default=_root,
help="Enable unit files in the specified root directory (used for alternative root prefix)")
_o.add_option("-n", "--lines", metavar="NUM",
help="Number of journal entries to show")
_o.add_option("-o", "--output", metavar="CAT",
help="change journal output mode [short, ..., cat] (ignored)")
_o.add_option("--plain", action="store_true",
help="Print unit dependencies as a list instead of a tree (ignored)")
_o.add_option("--no-pager", action="store_true",
help="Do not pipe output into pager (mostly ignored)")
_o.add_option("--no-warn", action="store_true",
help="Do not generate certain warnings (ignored)")
#
_o.add_option("-c", "--config", metavar="NAME=VAL", action="append", default=[],
help="..override internal variables (InitLoopSleep,SysInitTarget) {%default}")
_o.add_option("-e", "--extra-vars", "--environment", metavar="NAME=VAL", action="append", default=[],
help="..override settings in the syntax of 'Environment='")
_o.add_option("-v", "--verbose", action="count", default=0,
help="..increase debugging information level")
_o.add_option("-4", "--ipv4", action="store_true", default=False,
help="..only keep ipv4 localhost in /etc/hosts")
_o.add_option("-6", "--ipv6", action="store_true", default=False,
help="..only keep ipv6 localhost in /etc/hosts")
_o.add_option("-1", "--init", action="store_true", default=False,
help="..keep running as init-process (default if PID 1)")
opt, args = _o.parse_args()
logging.basicConfig(level = max(0, logging.FATAL - 10 * opt.verbose))
logg.setLevel(max(0, logging.ERROR - 10 * opt.verbose))
#
_extra_vars = opt.extra_vars
_force = opt.force
_full = opt.full
_log_lines = opt.lines
_no_pager = opt.no_pager
_no_reload = opt.no_reload
_no_legend = opt.no_legend
_no_ask_password = opt.no_ask_password
_now = opt.now
_preset_mode = opt.preset_mode
_quiet = opt.quiet
_root = opt.root
_show_all = opt.show_all
_only_state = opt.only_state
_only_type = opt.only_type
_only_property = opt.only_property
_only_what = opt.only_what
FORCE_IPV4 = opt.ipv4
FORCE_IPV6 = opt.ipv6
# being PID 1 (or 0) in a container will imply --init
_pid = os.getpid()
_init = opt.init or _pid in [1, 0]
_user_mode = opt.user
if os.geteuid() and _pid in [1, 0]:
_user_mode = True
if opt.system:
_user_mode = False # override --user
#
for setting in opt.config:
nam, val = setting, "1"
if "=" in setting:
nam, val = setting.split("=", 1)
elif nam.startswith("no-") or nam.startswith("NO-"):
nam, val = nam[3:], "0"
elif nam.startswith("No") or nam.startswith("NO"):
nam, val = nam[2:], "0"
if nam in globals():
old = globals()[nam]
if old is False or old is True:
logg.debug("yes %s=%s", nam, val)
globals()[nam] = (val in ("true", "True", "TRUE", "yes", "y", "Y", "YES", "1"))
logg.debug("... _show_all=%s", _show_all)
elif isinstance(old, float):
logg.debug("num %s=%s", nam, val)
globals()[nam] = float(val)
logg.debug("... MinimumYield=%s", MinimumYield)
elif isinstance(old, int):
logg.debug("int %s=%s", nam, val)
globals()[nam] = int(val)
logg.debug("... InitLoopSleep=%s", InitLoopSleep)
elif isinstance(old, basestring):
logg.debug("str %s=%s", nam, val)
globals()[nam] = val.strip()
logg.debug("... SysInitTarget=%s", SysInitTarget)
elif isinstance(old, list):
logg.debug("str %s+=[%s]", nam, val)
globals()[nam] += val.strip().split(",")
logg.debug("... _extra_vars=%s", _extra_vars)
else:
logg.warning("(ignored) unknown target type -c '%s' : %s", nam, type(old))
else:
logg.warning("(ignored) unknown target config -c '%s' : no such variable", nam)
#
systemctl_debug_log = os_path(_root, expand_path(SYSTEMCTL_DEBUG_LOG, not _user_mode))
systemctl_extra_log = os_path(_root, expand_path(SYSTEMCTL_EXTRA_LOG, not _user_mode))
if os.access(systemctl_extra_log, os.W_OK):
loggfile = logging.FileHandler(systemctl_extra_log)
loggfile.setFormatter(logging.Formatter("%(asctime)s %(levelname)s %(message)s"))
logg.addHandler(loggfile)
logg.setLevel(max(0, logging.INFO - 10 * opt.verbose))
if os.access(systemctl_debug_log, os.W_OK):
loggfile = logging.FileHandler(systemctl_debug_log)
loggfile.setFormatter(logging.Formatter("%(asctime)s %(levelname)s %(message)s"))
logg.addHandler(loggfile)
logg.setLevel(logging.DEBUG)
#
print_begin(sys.argv, args)
#
if opt.version:
args = ["version"]
if not args:
if _init:
args = ["default"]
else:
args = ["list-units"]
print_begin2(args)
command = args[0]
modules = args[1:]
try:
modules.remove("service")
except ValueError:
pass
sys.exit(runcommand(command, *modules))
|