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
| | /* Incremental, generational, concurrent GC using MPS.
Copyright (C) 2024 Free Software Foundation, Inc.
This file is part of GNU Emacs.
GNU Emacs is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or (at
your option) any later version.
GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>. */
// clang-format on
#include <config.h>
#include <limits.h>
#include <signal.h>
#include <mps.h>
#include <mpsavm.h>
#include <mpscamc.h>
#include "mpscams.h"
#include <mpscawl.h>
#include <mpslib.h>
#include <stdlib.h>
#include "lisp.h"
#include "comp.h"
#include "igc.h"
#include "bignum.h"
#include "buffer.h"
#include "coding.h"
#include "charset.h"
#include "dispextern.h"
#include "emacs-module.h"
#include "font.h"
#include "frame.h"
#include "intervals.h"
#include "itree.h"
#include "pdumper.h"
#include "termhooks.h"
#include "thread.h"
#include "treesit.h"
#include "puresize.h"
#include "termchar.h"
#ifdef HAVE_WINDOW_SYSTEM
#include TERM_HEADER
#endif /* HAVE_WINDOW_SYSTEM */
#ifdef HAVE_XWIDGETS
# include "xwidget.h"
#endif
#ifndef USE_LSB_TAG
# error "USE_LSB_TAG required"
#endif
#ifdef WIDE_EMACS_INT
# error "WIDE_EMACS_INT not supported"
#endif
#if USE_STACK_LISP_OBJECTS
# error "USE_STACK_LISP_OBJECTS not supported"
#endif
#ifndef HAVE_PDUMPER
# error "HAVE_PDUMPER required"
#endif
#if 0 /* Not yet because that amke transfer between GNU and my fork
painful. */
#ifdef CHECK_STRUCTS
# include "dmpstruct.h"
/* If one of these fires, check what has changed, fix uses of the type
in this file, and copy the new hash code from src/dmpstruct.h here. */
# ifndef HASH_Lisp_Cons_00EEE63F67
# error "struct Lisp_Cons changed"
# endif
# ifndef HASH_interval_1B38941C37
# error "struct interval changed"
# endif
# ifndef HASH_Lisp_String_03B2DF1C8E
# error "struct Lisp_String changed"
# endif
# ifndef HASH_Lisp_Marker_B6F52B2098
# error "struct Lisp_Marker changed"
# endif
# ifndef HASH_itree_node_50DE304F13
# error "struct itree_node changed"
# endif
# ifndef HASH_Lisp_Overlay_5F9D7E02FC
# error "struct Lisp_Overlay changed"
# endif
# ifndef HASH_Lisp_Finalizer_D58E647CB8
# error "struct Lisp_Finalizer changed"
# endif
# ifndef HASH_Lisp_Bignum_661945DE2B
# error "struct Lisp_Bignum changed"
# endif
# ifndef HASH_Lisp_Float_9CA83A9083
# error "struct Lisp_Float changed"
# endif
# ifndef HASH_Lisp_Buffer_Local_Value_3C363FAC3C
# error "struct Lisp_Buffer_Local_Value changed"
# endif
# ifndef HASH_Lisp_Symbol_C3C2929454
# error "struct Lisp_Symbol changed"
# endif
# ifndef HASH_symbol_redirect_EA72E4BFF5
# error "enum symbol_redirect changed"
# endif
# ifndef HASH_vectorlike_header_785E52047B
# error "struct vectorlike_header changed"
# endif
# ifndef HASH_Lisp_Hash_Table_AAA2B44B06
# error "struct Lisp_Hash_Table changed"
# endif
# ifndef HASH_buffer_B02F648B82
# error "struct buffer changed"
# endif
# ifndef HASH_Lisp_Vector_3091289B35
# error "struct Lisp_Vector changed"
# endif
# ifndef HASH_Lisp_Subr_20B7443AD7
# error "struct Lisp_Subr changed"
# endif
# ifndef HASH_pvec_type_6604A61AFB
# error "enum pvec_type changed"
# endif
# ifndef HASH_Lisp_Type_45F0582FD7
# error "enum Lisp_Type changed"
# endif
# ifndef HASH_charset_E31F4B5D96
# error "struct charset changed"
# endif
# ifndef HASH_itree_tree_86CA0F8AEE
# error "struct itree_tree changed"
# endif
# ifndef HASH_itree_tree_86CA0F8AEE
# error "struct itree_tree changed"
# endif
# endif // 0
/* Still missing; face, font, frame, thread, and probably a lot of
others. */
#endif /* CHECK_STRUCTS */
/* If igc can currently can be used. Initial state is IGC_STATE_INITIAL,
until everything needed has been successfully initialized and state
becomes IGC_STATE_USABLE. It goes from usable to IGC_STATE_DEAD
if an error happens or something is detected that forces us to
terminate the process. While terminating in this state, fallbacks are
implemented that let Emacs do its thing while terminating. */
enum igc_state
{
IGC_STATE_INITIAL,
IGC_STATE_USABLE,
IGC_STATE_DEAD,
};
static enum igc_state igc_state = IGC_STATE_INITIAL;
static void
set_state (enum igc_state state)
{
igc_state = state;
switch (igc_state)
{
case IGC_STATE_INITIAL:
emacs_abort ();
case IGC_STATE_USABLE:
break;
case IGC_STATE_DEAD:
igc_postmortem ();
terminate_due_to_signal (SIGABRT, INT_MAX);
break;
}
}
static void
check_res (const char *file, unsigned line, mps_res_t res)
{
if (res != MPS_RES_OK)
{
fprintf (stderr, "\r\n%s:%u: Emacs fatal error: MPS error code %d\r\n",
file, line, res);
set_state (IGC_STATE_DEAD);
}
}
#define IGC_CHECK_RES(res) check_res (__FILE__, __LINE__, (res))
/* Function called from MPS and from igc on assertion failures.
The function signature must be that of mps_lib_assert_fail_t. */
static void
igc_assert_fail (const char *file, unsigned line, const char *msg)
{
fprintf (stderr, "\r\n%s:%u: Emacs fatal error: assertion failed: %s\r\n",
file, line, msg);
set_state (IGC_STATE_DEAD);
}
#ifdef IGC_DEBUG
# define igc_assert(expr) \
do \
{ \
if (!(expr)) \
igc_assert_fail (__FILE__, __LINE__, #expr); \
} \
while (0)
#else
# define igc_assert(expr) (void) 0
#endif
#define IGC_NOT_IMPLEMENTED() \
igc_assert_fail (__FILE__, __LINE__, "not implemented")
/* An enum for telemetry event categories seems to be missing from MOS.
The docs only mention the bare numbers. */
enum igc_event_category
{
IGC_EVC_ARENA,
IGC_EVC_POOL,
IGC_EVC_TRACE,
IGC_EVC_SEG,
IGC_EVC_REF,
IGC_EVC_OBJECT,
IGC_EVC_USER,
};
/* Return true if the current MPS telemetry event filter has the bit set
for the given event category C. */
static bool
is_in_telemetry_filter (enum igc_event_category c)
{
return (mps_telemetry_get () & (1 << c)) != 0;
}
#if 0 /* unused */
#ifdef __cplusplus
#define igc_const_cast(type, expr) const_cast<type>(expr))
#else
#define igc_const_cast(type, expr) ((type) (expr))
#endif
#endif /* unused */
enum
{
IGC_TAG_MASK = (~VALMASK),
IGC_TAG_BITS = GCTYPEBITS,
IGC_ALIGN = GCALIGNMENT,
IGC_ALIGN_DFLT = IGC_ALIGN,
};
static bool
is_pure (const mps_addr_t addr)
{
#ifdef IN_MY_FORK
return false;
#else
return PURE_P (addr);
#endif
}
static enum pvec_type
pseudo_vector_type (const struct Lisp_Vector *v)
{
return PSEUDOVECTOR_TYPE (v);
}
static bool
is_builtin_subr (enum igc_obj_type type, void *client)
{
if (type == IGC_OBJ_VECTOR && pseudo_vector_type (client) == PVEC_SUBR)
{
Lisp_Object subr = make_lisp_ptr (client, Lisp_Vectorlike);
return !NATIVE_COMP_FUNCTIONP (subr);
}
return false;
}
static bool
has_header (void *client, bool is_vector)
{
if (is_vector && is_builtin_subr (IGC_OBJ_VECTOR, client))
return false;
if (c_symbol_p (client))
return false;
if (client == &main_thread.s)
return false;
if (is_pure (client))
return false;
return true;
}
static bool
is_aligned (const mps_addr_t addr)
{
return ((mps_word_t) addr & IGC_TAG_MASK) == 0;
}
#define IGC_WITH_PARKED(gc) \
for (int i = (arena_park (gc), 1); i; i = (arena_release (gc), 0))
#define IGC_DEFINE_LIST(data) \
typedef struct data##_list \
{ \
struct data##_list *next, *prev; \
data d; \
} data##_list; \
\
static data##_list *data##_list_push (data##_list **head, data *d) \
{ \
data##_list *r = xzalloc (sizeof *r); \
r->d = *d; \
r->next = *head; \
r->prev = NULL; \
if (r->next) \
r->next->prev = r; \
*head = r; \
return r; \
} \
\
static void data##_list_remove (data *d, data##_list **head, data##_list *r) \
{ \
if (r->next) \
r->next->prev = r->prev; \
if (r->prev) \
r->prev->next = r->next; \
else \
*head = r->next; \
*d = r->d; \
xfree (r); \
}
static const char *obj_type_names[] = {
"IGC_OBJ_INVALID",
"IGC_OBJ_PAD",
"IGC_OBJ_FWD",
"IGC_OBJ_CONS",
"IGC_OBJ_SYMBOL",
"IGC_OBJ_INTERVAL",
"IGC_OBJ_STRING",
"IGC_OBJ_STRING_DATA",
"IGC_OBJ_VECTOR",
"IGC_OBJ_VECTOR_WEAK",
"IGC_OBJ_ITREE_TREE",
"IGC_OBJ_ITREE_NODE",
"IGC_OBJ_IMAGE",
"IGC_OBJ_IMAGE_CACHE",
"IGC_OBJ_FACE",
"IGC_OBJ_FACE_CACHE",
"IGC_OBJ_FLOAT",
"IGC_OBJ_BLV",
"IGC_OBJ_PTR_VEC",
"IGC_OBJ_OBJ_VEC",
"IGC_OBJ_HASH_VEC",
"IGC_OBJ_HASH_VEC_WEAK",
"IGC_OBJ_HANDLER",
"IGC_OBJ_BYTES",
"IGC_OBJ_BUILTIN_SYMBOL",
"IGC_OBJ_BUILTIN_THREAD",
"IGC_OBJ_BUILTIN_SUBR",
"IGC_OBJ_DUMPED_CHARSET_TABLE",
"IGC_OBJ_DUMPED_CODE_SPACE_MASKS",
"IGC_OBJ_DUMPED_BUFFER_TEXT",
"IGC_OBJ_DUMPED_BIGNUM_DATA",
"IGC_OBJ_DUMPED_BYTES",
"IGC_OBJ_WEAK_HASH_TABLE_WEAK_PART",
"IGC_OBJ_WEAK_HASH_TABLE_STRONG_PART",
};
static_assert (ARRAYELTS (obj_type_names) == IGC_OBJ_NUM_TYPES);
static const char *
obj_type_name (enum igc_obj_type type)
{
igc_assert (0 <= type && type < IGC_OBJ_NUM_TYPES);
return obj_type_names[type];
}
static const char *pvec_type_names[] = {
"PVEC_NORMAL_VECTOR",
"PVEC_FREE",
"PVEC_BIGNUM",
"PVEC_MARKER",
"PVEC_OVERLAY",
"PVEC_FINALIZER",
"PVEC_SYMBOL_WITH_POS",
"PVEC_MISC_PTR",
"PVEC_USER_PTR",
"PVEC_PROCESS",
"PVEC_FRAME",
"PVEC_WINDOW",
"PVEC_BOOL_VECTOR",
"PVEC_BUFFER",
"PVEC_HASH_TABLE",
"PVEC_WEAK_HASH_TABLE",
#ifndef IN_MY_FORK
"PVEC_OBARRAY",
#endif
"PVEC_TERMINAL",
"PVEC_WINDOW_CONFIGURATION",
"PVEC_SUBR",
#ifdef IN_MY_FORK
"PVEC_PACKAGE",
#endif
"PVEC_OTHER",
"PVEC_XWIDGET",
"PVEC_XWIDGET_VIEW",
"PVEC_THREAD",
"PVEC_MUTEX",
"PVEC_CONDVAR",
"PVEC_MODULE_FUNCTION",
"PVEC_MODULE_GLOBAL_REFERENCE",
"PVEC_NATIVE_COMP_UNIT",
"PVEC_TS_PARSER",
"PVEC_TS_NODE",
"PVEC_TS_COMPILED_QUERY",
"PVEC_SQLITE",
"PVEC_CLOSURE",
"PVEC_CHAR_TABLE",
"PVEC_SUB_CHAR_TABLE",
"PVEC_RECORD",
"PVEC_FONT",
};
static_assert (ARRAYELTS (pvec_type_names) == PVEC_TAG_MAX + 1);
static const char *
pvec_type_name (enum pvec_type type)
{
igc_assert (0 <= type && type <= PVEC_TAG_MAX);
return pvec_type_names[type];
}
struct igc_stats
{
struct
{
size_t nbytes;
size_t nobjs;
} obj[IGC_OBJ_NUM_TYPES];
struct
{
size_t nbytes;
size_t nobjs;
} pvec[PVEC_TAG_MAX + 1];
};
/* Always having a header makes it possible to have an
address-independent hash, which is (a) much easier to handle than MPS
location dependencies, and (b) makes it possible to implement sxhash
variants in a way that works as expected even if GCs happen between
calls. */
enum
{
IGC_TYPE_BITS = 6,
IGC_HASH_BITS = 26,
IGC_SIZE_BITS = 32,
IGC_HASH_MASK = (1 << IGC_HASH_BITS) - 1,
};
static_assert (IGC_OBJ_NUM_TYPES - 1 < (1 << IGC_TYPE_BITS));
struct igc_header
{
enum igc_obj_type obj_type : IGC_TYPE_BITS;
mps_word_t hash : IGC_HASH_BITS;
mps_word_t nwords : IGC_SIZE_BITS;
};
struct igc_fwd
{
struct igc_header header;
mps_addr_t new_base_addr;
};
static_assert (sizeof (struct igc_header) == 8);
static mps_word_t
to_words (mps_word_t nbytes)
{
igc_assert (nbytes % sizeof (mps_word_t) == 0);
return nbytes / sizeof (mps_word_t);
}
static mps_word_t
to_bytes (mps_word_t nwords)
{
return nwords * sizeof (mps_word_t);
}
/* Value is the size in bytes of the object described by header H.
This includes the header itself. */
static mps_word_t
obj_size (const struct igc_header *h)
{
mps_word_t nbytes = to_bytes (h->nwords);
igc_assert (h->obj_type == IGC_OBJ_PAD || nbytes >= sizeof (struct igc_fwd));
return nbytes;
}
/* Value is the size in bytes of the client area of the object described
by header H. */
static mps_word_t
obj_client_size (const struct igc_header *h)
{
return obj_size (h) - sizeof *h;
}
/* Set the fields of header H to the given values. Use this instead of
setting the fields directly to make it easy to add assertions. */
static void
set_header (struct igc_header *h, enum igc_obj_type type,
mps_word_t nbytes, mps_word_t hash)
{
#if IGC_SIZE_BITS >= 32 && INTPTR_MAX > INT_MAX
/* On 32-bit architecture the assertion below is redundant and
causes compiler warnings. */
igc_assert (nbytes < ((size_t) 1 << IGC_SIZE_BITS));
#endif
igc_assert (type == IGC_OBJ_PAD || nbytes >= sizeof (struct igc_fwd));
h->obj_type = type;
h->nwords = to_words (nbytes);
h->hash = hash;
}
/* Given a pointer to the client area of an object, CLIENT, return
the base address of the object in MPS. */
static mps_addr_t
client_to_base (mps_addr_t client_addr)
{
return (char *) client_addr - sizeof (struct igc_header);
}
/* Given a pointer to the start of an object in MPS, BASE, return a
pointer to its client area. */
static mps_addr_t
base_to_client (mps_addr_t base_addr)
{
return (char *) base_addr + sizeof (struct igc_header);
}
/* Given a client pointer CLIENT to an object, return how many
elements of size ELEM_SIZE can fit into the client area. */
static size_t
object_nelems (void *client, size_t elem_size)
{
struct igc_header *h = client_to_base (client);
return obj_client_size (h) / elem_size;
}
Lisp_Object
igc_ptr_to_lisp (void *client)
{
if (client == 0)
return Qnil;
mps_addr_t base = client_to_base (client);
struct igc_header *h = base;
switch (h->obj_type)
{
case IGC_OBJ_STRING:
return make_lisp_ptr (client, Lisp_String);
case IGC_OBJ_VECTOR:
return make_lisp_ptr (client, Lisp_Vectorlike);
case IGC_OBJ_CONS:
return make_lisp_ptr (client, Lisp_Cons);
return make_lisp_ptr (client, Lisp_Float);
default:
IGC_NOT_IMPLEMENTED ();
emacs_abort ();
}
}
/* Round NBYTES to the next multiple of ALIGN. */
static size_t
igc_round (size_t nbytes, size_t align)
{
return ROUNDUP (nbytes, align);
}
/* Value is the size in bytes that we need to allocate from MPS
for a client object of size NBYTES. */
static size_t
alloc_size (size_t nbytes)
{
nbytes += sizeof (struct igc_header);
nbytes = max (nbytes, sizeof (struct igc_fwd));
nbytes = igc_round (nbytes, IGC_ALIGN_DFLT);
return nbytes;
}
/* Value is a hash to use for a newly allocated object. */
static unsigned
alloc_hash (void)
{
static unsigned count = 0;
return count++;
}
/* This runs in various places for --enable-checking=igc_check_fwd. See
lisp.h, like XSYMBOL, XSTRING and alike. */
#ifdef IGC_CHECK_FWD
void
igc_check_fwd (void *client)
{
if (has_header (client))
{
struct igc_header *h = client_to_base (client);
igc_assert (h->obj_type != IGC_OBJ_FWD);
igc_assert (obj_size (h) >= sizeof (struct igc_fwd));
}
}
#endif
\f
/************************************************************************
Registry of MPS objects
************************************************************************/
/* Registry entry for an MPS root mps_root_t. */
struct igc_root
{
struct igc *gc;
mps_root_t root;
void *start, *end;
const char *label;
bool ambig;
};
typedef struct igc_root igc_root;
IGC_DEFINE_LIST (igc_root);
/* Registry entry for an MPS thread mps_thr_t. */
struct igc_thread
{
struct igc *gc;
mps_thr_t thr;
/* Allocation points for the thread. */
mps_ap_t dflt_ap;
mps_ap_t leaf_ap;
mps_ap_t weak_strong_ap;
mps_ap_t weak_weak_ap;
mps_ap_t weak_hash_strong_ap;
mps_ap_t weak_hash_weak_ap;
mps_ap_t immovable_ap;
/* Quick access to the roots used for specpdl, bytecode stack and
control stack. */
igc_root_list *specpdl_root;
igc_root_list *bc_root;
igc_root_list *stack_root;
/* Back pointer to Emacs' thread object. Allocated so that it doesn't
move in memory. */
struct thread_state *ts;
};
typedef struct igc_thread igc_thread;
IGC_DEFINE_LIST (igc_thread);
/* The registry for an MPS arena. There is only one arena used. */
struct igc
{
/* The MPS arena. */
mps_arena_t arena;
/* Used to allow nested parking/releasing of the arena. */
int park_count;
/* The MPS generation chain. */
mps_chain_t chain;
/* Object formats and pools used. */
mps_fmt_t dflt_fmt;
mps_pool_t dflt_pool;
mps_fmt_t leaf_fmt;
mps_pool_t leaf_pool;
mps_fmt_t weak_fmt;
mps_pool_t weak_pool;
mps_fmt_t weak_hash_fmt;
mps_pool_t weak_hash_pool;
mps_fmt_t immovable_fmt;
mps_pool_t immovable_pool;
/* Registered roots. */
struct igc_root_list *roots;
/* Registered threads. */
struct igc_thread_list *threads;
};
/* The global registry. */
static struct igc *global_igc;
static void
arena_park (struct igc *gc)
{
if (gc->park_count == 0)
mps_arena_park (gc->arena);
++gc->park_count;
}
static void
arena_release (struct igc *gc)
{
--gc->park_count;
igc_assert (gc->park_count >= 0);
if (gc->park_count == 0)
mps_arena_release (gc->arena);
}
/* Register the root ROOT in registry GC with additional info. START
and END are the area of memory covered by the root. END being NULL
means not known. AMBIG true means the root is scanned ambigously, as
opposed to being scanned exactly.
LABEL is a name under which the root appears on the MPS telemetry
stream, if user events are in the telemetry filter. This allows
mapping roots to useful names. */
static struct igc_root_list *
register_root (struct igc *gc, mps_root_t root, void *start, void *end,
bool ambig, const char *label)
{
igc_assert (label != NULL);
if (is_in_telemetry_filter (IGC_EVC_USER))
{
mps_label_t l = mps_telemetry_intern (label);
mps_telemetry_label (root, l);
}
struct igc_root r =
{
.gc = gc,
.root = root,
.start = start,
.end = end,
.ambig = ambig,
.label = label,
};
return igc_root_list_push (&gc->roots, &r);
}
/* Remove the root described by R from the list of known roots
of its registry. Value is the MPS root. */
static mps_root_t
deregister_root (struct igc_root_list *r)
{
struct igc_root root;
igc_root_list_remove (&root, &r->d.gc->roots, r);
return root.root;
}
/* Destroy the root described by *R and remove it from its registry.
Set *R to NULL when done so that it cannot be destroyed twice. */
static void
destroy_root (struct igc_root_list **r)
{
mps_root_destroy (deregister_root (*r));
*r = NULL;
}
static struct igc_thread_list *
register_thread (struct igc *gc, mps_thr_t thr, struct thread_state *ts)
{
struct igc_thread t = { .gc = gc, .thr = thr, .ts = ts };
return igc_thread_list_push (&gc->threads, &t);
}
static mps_thr_t
deregister_thread (struct igc_thread_list *t)
{
struct igc_thread thread;
igc_thread_list_remove (&thread, &t->d.gc->threads, t);
return thread.thr;
}
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wunused-variable"
static size_t
vector_size (const struct Lisp_Vector *v)
{
size_t size = v->header.size;
if (size & PSEUDOVECTOR_FLAG)
size &= PSEUDOVECTOR_SIZE_MASK;
return size;
}
static size_t
vector_start (const struct Lisp_Vector *v)
{
enum pvec_type type = pseudo_vector_type (v);
return type == PVEC_SUB_CHAR_TABLE ? SUB_CHAR_TABLE_OFFSET : 0;
}
static mps_res_t
fix_lisp_obj (mps_ss_t ss, Lisp_Object *pobj)
{
MPS_SCAN_BEGIN (ss)
{
mps_word_t *p = (mps_word_t *) pobj;
mps_word_t word = *p;
/* Quickly rule out Qnil, and prevent subtraxting from a
null pointer. */
if (word == 0)
return MPS_RES_OK;
mps_word_t tag = word & IGC_TAG_MASK;
if (tag == Lisp_Int0 || tag == Lisp_Int1)
return MPS_RES_OK;
else if (tag == Lisp_Type_Unused0)
emacs_abort ();
if (tag == Lisp_Symbol)
{
ptrdiff_t off = word ^ tag;
mps_addr_t client = (mps_addr_t) ((char *) lispsym + off);
mps_addr_t base = client_to_base (client);
if (MPS_FIX1 (ss, base))
{
mps_res_t res = MPS_FIX2 (ss, &base);
if (res != MPS_RES_OK)
return res;
if (base == NULL)
*(Lisp_Object *) p = Qnil;
else
{
client = base_to_client (base);
ptrdiff_t new_off = (char *) client - (char *) lispsym;
*p = new_off | tag;
}
}
}
else
{
/* I have encountered cases where MPS_FIX1 returns true, but the
reference is somewhere completely off, so that MPS_FIX2 asserts.
IOW, MPS_FIX1 has undefined behavior if called on an address that
is not in the arena. */
mps_addr_t client = (mps_addr_t) (word ^ tag);
mps_addr_t base = client_to_base (client);
if (MPS_FIX1 (ss, base))
{
mps_res_t res = MPS_FIX2 (ss, &base);
if (res != MPS_RES_OK)
return res;
if (base == NULL)
*(Lisp_Object *) p = Qnil;
else
{;
client = base_to_client (base);
*p = (mps_word_t) client | tag;
}
}
}
}
MPS_SCAN_END (ss);
return MPS_RES_OK;
}
static mps_res_t
fix_raw (mps_ss_t ss, mps_addr_t *p)
{
MPS_SCAN_BEGIN (ss)
{
mps_addr_t client = *p;
if (client == NULL)
return MPS_RES_OK;
if (is_aligned (client))
{
mps_addr_t base = client_to_base (client);
if (MPS_FIX1 (ss, base))
{
mps_res_t res = MPS_FIX2 (ss, &base);
if (res != MPS_RES_OK)
return res;
if (base == NULL)
*p = NULL;
else
*p = base_to_client (base);
}
}
}
MPS_SCAN_END (ss);
return MPS_RES_OK;
}
#define IGC_FIX12_OBJ(ss, p) \
do \
{ \
mps_res_t res; \
MPS_FIX_CALL (ss, res = fix_lisp_obj (ss, (p))); \
if (res != MPS_RES_OK) \
return res; \
} \
while (0)
#define IGC_FIX12_RAW(ss, p) \
do \
{ \
mps_res_t res; \
MPS_FIX_CALL (ss, res = fix_raw (ss, (mps_addr_t *) (p))); \
if (res != MPS_RES_OK) \
return res; \
} \
while (0)
#define IGC_FIX12_NOBJS(ss, a, n) \
do \
{ \
mps_res_t res; \
MPS_FIX_CALL ((ss), res = fix_array ((ss), (a), (n))); \
if (res != MPS_RES_OK) \
return res; \
} \
while (0)
#define IGC_FIX_CALL(ss, expr) \
do \
{ \
mps_res_t res; \
MPS_FIX_CALL (ss, res = (expr)); \
if (res != MPS_RES_OK) \
return res; \
} \
while (0)
#define IGC_FIX_CALL_FN(ss, type, client_addr, fn) \
do \
{ \
type *obj_ = (type *) client_addr; \
mps_res_t res; \
MPS_FIX_CALL (ss, res = fn (ss, obj_)); \
if (res != MPS_RES_OK) \
return res; \
} \
while (0)
static mps_res_t
fix_array (mps_ss_t ss, Lisp_Object *array, size_t n)
{
MPS_SCAN_BEGIN (ss)
{
for (size_t i = 0; i < n; ++i)
IGC_FIX12_OBJ (ss, &array[i]);
}
MPS_SCAN_END (ss);
return MPS_RES_OK;
}
static mps_res_t
scan_staticvec (mps_ss_t ss, void *start, void *end, void *closure)
{
igc_assert (start == staticvec);
MPS_SCAN_BEGIN (ss)
{
for (Lisp_Object **p = start; (void *) p < end; ++p)
if (*p)
IGC_FIX12_OBJ (ss, *p);
}
MPS_SCAN_END (ss);
return MPS_RES_OK;
}
static mps_res_t
fix_symbol (mps_ss_t ss, struct Lisp_Symbol *sym)
{
MPS_SCAN_BEGIN (ss)
{
IGC_FIX12_OBJ (ss, &sym->u.s.name);
IGC_FIX12_OBJ (ss, &sym->u.s.function);
IGC_FIX12_OBJ (ss, &sym->u.s.plist);
#ifdef IN_MY_FORK
IGC_FIX12_OBJ (ss, &sym->u.s.package);
#else
IGC_FIX12_RAW (ss, &sym->u.s.next);
#endif
switch (sym->u.s.redirect)
{
case SYMBOL_PLAINVAL:
IGC_FIX12_OBJ (ss, &sym->u.s.val.value);
break;
case SYMBOL_VARALIAS:
IGC_FIX12_RAW (ss, &sym->u.s.val.alias);
break;
case SYMBOL_LOCALIZED:
IGC_FIX12_RAW (ss, &sym->u.s.val.blv);
break;
case SYMBOL_FORWARDED:
break;
}
}
MPS_SCAN_END (ss);
return MPS_RES_OK;
}
static mps_res_t
scan_lispsym (mps_ss_t ss, void *start, void *end, void *closure)
{
MPS_SCAN_BEGIN (ss)
{
for (struct Lisp_Symbol *sym = start; (void *) sym < end; ++sym)
IGC_FIX_CALL (ss, fix_symbol (ss, sym));
}
MPS_SCAN_END (ss);
return MPS_RES_OK;
}
static mps_res_t
scan_rdstack (mps_ss_t ss, void *start, void *end, void *closure)
{
MPS_SCAN_BEGIN (ss)
{
for (struct read_stack_entry *e = start; (void *) e < end; ++e)
{
if (e->type == RE_free)
break;
switch (e->type)
{
case RE_free:
emacs_abort ();
case RE_list_start:
break;
case RE_list:
case RE_list_dot:
IGC_FIX12_OBJ (ss, &e->u.list.head);
IGC_FIX12_OBJ (ss, &e->u.list.tail);
break;
case RE_vector:
case RE_record:
case RE_char_table:
case RE_sub_char_table:
case RE_byte_code:
case RE_string_props:
IGC_FIX12_OBJ (ss, &e->u.vector.elems);
break;
case RE_special:
IGC_FIX12_OBJ (ss, &e->u.special.symbol);
break;
case RE_numbered:
IGC_FIX12_OBJ (ss, &e->u.numbered.number);
IGC_FIX12_OBJ (ss, &e->u.numbered.placeholder);
break;
}
}
}
MPS_SCAN_END (ss);
return MPS_RES_OK;
}
static mps_res_t
scan_specpdl (mps_ss_t ss, void *start, void *end, void *closure)
{
MPS_SCAN_BEGIN (ss)
{
/* MPS docs say that root scanning functions have exclusive access
to what is being scanned, the same way format scanning functions
do. That does not mean one can rely on the thread's specpdl_ptr
here because it may be updated after this function runs. */
struct igc_thread_list *t = closure;
igc_assert (start == (void *) t->d.ts->m_specpdl);
igc_assert (end == (void *) t->d.ts->m_specpdl_end);
for (union specbinding *pdl = start;
(void *) pdl < end && pdl->kind != SPECPDL_FREE; ++pdl)
{
switch (pdl->kind)
{
case SPECPDL_FREE:
emacs_abort ();
case SPECPDL_UNWIND:
IGC_FIX12_OBJ (ss, &pdl->unwind.arg);
break;
/* This is used by SAFE_ALLOCA/malloc. */
case SPECPDL_UNWIND_ARRAY:
IGC_FIX12_RAW (ss, &pdl->unwind_array.array);
break;
case SPECPDL_UNWIND_EXCURSION:
IGC_FIX12_OBJ (ss, &pdl->unwind_excursion.marker);
IGC_FIX12_OBJ (ss, &pdl->unwind_excursion.window);
break;
/* The bt.args member either points to something on a
thread's control stack, or to something in the bytecode
stack. Both should already be ambiguous roots. */
case SPECPDL_BACKTRACE:
break;
#ifdef HAVE_MODULES
case SPECPDL_MODULE_RUNTIME:
break;
// If I am not mistaken, the emacs_env in this binding
// actually lives on the stack (see module-load e.g.).
// So, we don't have to do something here for the Lisp
// objects in emacs_env.
case SPECPDL_MODULE_ENVIRONMENT:
break;
#endif
case SPECPDL_LET_DEFAULT:
case SPECPDL_LET_LOCAL:
IGC_FIX12_OBJ (ss, &pdl->let.where.buf);
FALLTHROUGH;
case SPECPDL_LET:
IGC_FIX12_OBJ (ss, &pdl->let.symbol);
IGC_FIX12_OBJ (ss, &pdl->let.old_value);
break;
case SPECPDL_UNWIND_PTR:
/* This can contain a mark function of its own, which is of
no use to us. Only user is sort.c. */
break;
case SPECPDL_UNWIND_INT:
case SPECPDL_UNWIND_INTMAX:
case SPECPDL_UNWIND_VOID:
case SPECPDL_NOP:
break;
}
}
}
MPS_SCAN_END (ss);
return MPS_RES_OK;
}
/* Scan the area of memory [START, END) ambiguously. In general,
references may be either tagged words or pointers. This is used for
blocks allocated with malloc and thread stacks. */
static mps_res_t
scan_ambig (mps_ss_t ss, void *start, void *end, void *closure)
{
MPS_SCAN_BEGIN (ss)
{
for (mps_word_t *p = start; p < (mps_word_t *) end; ++p)
{
mps_word_t word = *p;
mps_word_t tag = word & IGC_TAG_MASK;
/* If the references in the object being scanned are
ambiguous then MPS_FIX2() does not update the
reference (because it can't know if it's a
genuine reference). The MPS handles an ambiguous
reference by pinning the block pointed to so that
it cannot move. */
mps_addr_t ref = (mps_addr_t) word;
mps_res_t res = MPS_FIX12 (ss, &ref);
if (res != MPS_RES_OK)
return res;
switch (tag)
{
case Lisp_Int0:
case Lisp_Int1:
case Lisp_Type_Unused0:
break;
case Lisp_Symbol:
{
ptrdiff_t off = word ^ tag;
ref = (mps_addr_t) ((char *) lispsym + off);
res = MPS_FIX12 (ss, &ref);
if (res != MPS_RES_OK)
return res;
}
break;
default:
ref = (mps_addr_t) (word ^ tag);
res = MPS_FIX12 (ss, &ref);
if (res != MPS_RES_OK)
return res;
break;
}
}
}
MPS_SCAN_END (ss);
return MPS_RES_OK;
}
#ifndef IN_MY_FORK
static mps_res_t
scan_pure (mps_ss_t ss, void *start, void *end, void *closure)
{
MPS_SCAN_BEGIN (ss)
{
igc_assert (start == (void *) pure);
end = (char *) pure + pure_bytes_used_lisp;
if (end > start)
IGC_FIX_CALL (ss, scan_ambig (ss, start, end, NULL));
}
MPS_SCAN_END (ss);
return MPS_RES_OK;
}
#endif
static mps_res_t
scan_bc (mps_ss_t ss, void *start, void *end, void *closure)
{
MPS_SCAN_BEGIN (ss)
{
struct igc_thread_list *t = closure;
struct bc_thread_state *bc = &t->d.ts->bc;
igc_assert (start == (void *) bc->stack);
igc_assert (end == (void *) bc->stack_end);
/* FIXME/igc: AFAIU the current top frame starts at
bc->fp->next_stack and has a maximum length that is given by the
bytecode being executed (COMPILED_STACK_DEPTH). So, we need to
scan upto bc->fo->next_stack + that max depth to be safe. Since
I don't have that number ATM, I'm using an arbitrary estimate for
now.
This must be changed to something better. Note that Mattias said
the bc stack marking will be changed in the future. */
const size_t HORRIBLE_ESTIMATE = 1024;
char *scan_end = bc_next_frame (bc->fp);
scan_end += HORRIBLE_ESTIMATE;
end = min (end, (void *) scan_end);
if (end > start)
IGC_FIX_CALL (ss, scan_ambig (ss, start, end, NULL));
}
MPS_SCAN_END (ss);
return MPS_RES_OK;
}
static mps_res_t
scan_exact (mps_ss_t ss, void *start, void *end, void *closure)
{
MPS_SCAN_BEGIN (ss)
{
for (Lisp_Object *p = start; (void *) p < end; ++p)
IGC_FIX12_OBJ (ss, p);
}
MPS_SCAN_END (ss);
return MPS_RES_OK;
}
static mps_res_t
scan_ptr_exact (mps_ss_t ss, void *start, void *end, void *closure)
{
MPS_SCAN_BEGIN (ss)
{
for (void **p = start; (void *) p < end; ++p)
if (*p)
IGC_FIX12_RAW (ss, p);
}
MPS_SCAN_END (ss);
return MPS_RES_OK;
}
static mps_res_t
scan_tty_list (mps_ss_t ss, void *start, void *end, void *closure)
{
igc_assert (start == &tty_list);
igc_assert (end == (&tty_list) + 1);
MPS_SCAN_BEGIN (ss)
{
for (struct tty_display_info *tty = tty_list; tty; tty = tty->next)
{
IGC_FIX12_RAW (ss, &tty->terminal);
IGC_FIX12_OBJ (ss, &tty->top_frame);
IGC_FIX12_RAW (ss, &tty->previous_frame);
}
}
MPS_SCAN_END (ss);
return MPS_RES_OK;
}
/***********************************************************************
Default pad, fwd, ...
***********************************************************************/
static void
dflt_pad (mps_addr_t base_addr, size_t nbytes)
{
igc_assert (nbytes >= sizeof (struct igc_header));
struct igc_header *h = base_addr;
set_header (h, IGC_OBJ_PAD, nbytes, 0);
}
static void
dflt_fwd (mps_addr_t old_base_addr, mps_addr_t new_base_addr)
{
struct igc_header *h = old_base_addr;
igc_assert (obj_size (h) >= sizeof (struct igc_fwd));
igc_assert (h->obj_type != IGC_OBJ_PAD);
struct igc_fwd *f = old_base_addr;
f->header.obj_type = IGC_OBJ_FWD;
f->new_base_addr = new_base_addr;
}
static mps_addr_t
is_dflt_fwd (mps_addr_t base_addr)
{
struct igc_fwd *f = base_addr;
if (f->header.obj_type == IGC_OBJ_FWD)
return f->new_base_addr;
return NULL;
}
static mps_addr_t
dflt_skip (mps_addr_t base_addr)
{
struct igc_header *h = base_addr;
mps_addr_t next = (char *) base_addr + obj_size (h);
igc_assert (next > base_addr);
return next;
}
static mps_res_t
fix_string (mps_ss_t ss, struct Lisp_String *s)
{
MPS_SCAN_BEGIN (ss)
{
IGC_FIX12_RAW (ss, &s->u.s.data);
IGC_FIX12_RAW (ss, &s->u.s.intervals);
}
MPS_SCAN_END (ss);
return MPS_RES_OK;
}
static mps_res_t
fix_interval (mps_ss_t ss, struct interval *iv)
{
MPS_SCAN_BEGIN (ss)
{
IGC_FIX12_RAW (ss, &iv->left);
IGC_FIX12_RAW (ss, &iv->right);
if (iv->up_obj)
IGC_FIX12_OBJ (ss, &iv->up.obj);
else if (iv->up.interval)
IGC_FIX12_RAW (ss, &iv->up.interval);
IGC_FIX12_OBJ (ss, &iv->plist);
}
MPS_SCAN_END (ss);
return MPS_RES_OK;
}
static mps_res_t
fix_itree_tree (mps_ss_t ss, struct itree_tree *t)
{
MPS_SCAN_BEGIN (ss)
{
if (t->root)
IGC_FIX12_RAW (ss, &t->root);
}
MPS_SCAN_END (ss);
return MPS_RES_OK;
}
static mps_res_t
fix_itree_node (mps_ss_t ss, struct itree_node *n)
{
MPS_SCAN_BEGIN (ss)
{
if (n->parent)
IGC_FIX12_RAW (ss, &n->parent);
if (n->left)
IGC_FIX12_RAW (ss, &n->left);
if (n->right)
IGC_FIX12_RAW (ss, &n->right);
IGC_FIX12_OBJ (ss, &n->data);
}
MPS_SCAN_END (ss);
return MPS_RES_OK;
}
static mps_res_t
fix_image (mps_ss_t ss, struct image *i)
{
MPS_SCAN_BEGIN (ss)
{
#ifdef HAVE_WINDOW_SYSTEM
IGC_FIX12_OBJ (ss, &i->spec);
IGC_FIX12_OBJ (ss, &i->dependencies);
IGC_FIX12_OBJ (ss, &i->lisp_data);
IGC_FIX12_RAW (ss, &i->next);
IGC_FIX12_RAW (ss, &i->prev);
#endif
}
MPS_SCAN_END (ss);
return MPS_RES_OK;
}
static mps_res_t
fix_image_cache (mps_ss_t ss, struct image_cache *c)
{
MPS_SCAN_BEGIN (ss)
{
#ifdef HAVE_WINDOW_SYSTEM
IGC_FIX12_RAW (ss, &c->images);
IGC_FIX12_RAW (ss, &c->buckets);
#endif
}
MPS_SCAN_END (ss);
return MPS_RES_OK;
}
static mps_res_t
fix_face (mps_ss_t ss, struct face *f)
{
MPS_SCAN_BEGIN (ss)
{
IGC_FIX12_NOBJS (ss, f->lface, ARRAYELTS (f->lface));
IGC_FIX12_RAW (ss, &f->font);
IGC_FIX12_RAW (ss, &f->next);
IGC_FIX12_RAW (ss, &f->prev);
IGC_FIX12_RAW (ss, &f->ascii_face);
#if defined HAVE_XFT || defined HAVE_FREETYPE
IGC_FIX12_RAW (ss, &f->extra);
#endif
}
MPS_SCAN_END (ss);
return MPS_RES_OK;
}
static mps_res_t
fix_face_cache (mps_ss_t ss, struct face_cache *c)
{
MPS_SCAN_BEGIN (ss)
{
IGC_FIX12_RAW (ss, &c->f);
IGC_FIX12_RAW (ss, &c->faces_by_id);
IGC_FIX12_RAW (ss, &c->buckets);
}
MPS_SCAN_END (ss);
return MPS_RES_OK;
}
static mps_res_t
fix_ptr_vec (mps_ss_t ss, void *client)
{
MPS_SCAN_BEGIN (ss)
{
void **v = client;
size_t n = object_nelems (client, sizeof *v);
for (size_t i = 0; i < n; ++i)
IGC_FIX12_RAW (ss, &v[i]);
}
MPS_SCAN_END (ss);
return MPS_RES_OK;
}
static mps_res_t
fix_obj_vec (mps_ss_t ss, Lisp_Object *v)
{
MPS_SCAN_BEGIN (ss)
{
size_t n = object_nelems (v, sizeof *v);
for (size_t i = 0; i < n; ++i)
IGC_FIX12_OBJ (ss, &v[i]);
}
MPS_SCAN_END (ss);
return MPS_RES_OK;
}
static mps_res_t
fix_cons (mps_ss_t ss, struct Lisp_Cons *cons)
{
MPS_SCAN_BEGIN (ss)
{
IGC_FIX12_OBJ (ss, &cons->u.s.car);
IGC_FIX12_OBJ (ss, &cons->u.s.u.cdr);
}
MPS_SCAN_END (ss);
return MPS_RES_OK;
}
static mps_res_t
fix_blv (mps_ss_t ss, struct Lisp_Buffer_Local_Value *blv)
{
MPS_SCAN_BEGIN (ss)
{
IGC_FIX12_OBJ (ss, &blv->where);
IGC_FIX12_OBJ (ss, &blv->defcell);
IGC_FIX12_OBJ (ss, &blv->valcell);
}
MPS_SCAN_END (ss);
return MPS_RES_OK;
}
static mps_res_t
fix_handler (mps_ss_t ss, struct handler *h)
{
MPS_SCAN_BEGIN (ss)
{
IGC_FIX12_OBJ (ss, &h->tag_or_ch);
IGC_FIX12_OBJ (ss, &h->val);
IGC_FIX12_RAW (ss, &h->next);
IGC_FIX12_RAW (ss, &h->nextfree);
}
MPS_SCAN_END (ss);
return MPS_RES_OK;
}
static mps_res_t
fix_charset_table (mps_ss_t ss, struct charset *table, size_t nbytes)
{
igc_assert (table == charset_table);
igc_assert (nbytes
== (charset_table_size * sizeof (struct charset)
+ sizeof (struct igc_header)));
MPS_SCAN_BEGIN (ss)
{
for (size_t i = 0, len = nbytes / sizeof (struct charset); i < len; i++)
IGC_FIX12_OBJ (ss, &table[i].attributes);
}
MPS_SCAN_END (ss);
return MPS_RES_OK;
}
static mps_res_t fix_vector (mps_ss_t ss, struct Lisp_Vector *v);
static fix_weak_hash_table_strong_part (mps_ss_t ss, struct Lisp_Weak_Hash_Table_Strong_Part *t);
static fix_weak_hash_table_weak_part (mps_ss_t ss, struct Lisp_Weak_Hash_Table_Weak_Part *w);
static mps_res_t
dflt_scan_obj (mps_ss_t ss, mps_addr_t base_start, mps_addr_t base_limit,
void *closure)
{
MPS_SCAN_BEGIN (ss)
{
mps_addr_t base = base_start;
mps_addr_t client = base_to_client (base);
struct igc_header *header = base;
if (closure)
{
struct igc_stats *st = closure;
mps_word_t obj_type = header->obj_type;
igc_assert (obj_type < IGC_OBJ_NUM_TYPES);
st->obj[obj_type].nbytes += obj_size (header);
st->obj[obj_type].nobjs += 1;
if (obj_type == IGC_OBJ_VECTOR)
{
struct Lisp_Vector* v = (struct Lisp_Vector*) client;
enum pvec_type pvec_type = pseudo_vector_type (v);
igc_assert (0 <= pvec_type && pvec_type <= PVEC_TAG_MAX);
st->pvec[pvec_type].nbytes += obj_size (header);
st->pvec[pvec_type].nobjs += 1;
}
}
switch (header->obj_type)
{
case IGC_OBJ_INVALID:
case IGC_OBJ_BUILTIN_SYMBOL:
case IGC_OBJ_BUILTIN_THREAD:
case IGC_OBJ_BUILTIN_SUBR:
emacs_abort ();
case IGC_OBJ_PAD:
case IGC_OBJ_FWD:
continue;
case IGC_OBJ_HANDLER:
IGC_FIX_CALL_FN (ss, struct handler, client, fix_handler);
break;
case IGC_OBJ_PTR_VEC:
IGC_FIX_CALL_FN (ss, mps_word_t, client, fix_ptr_vec);
break;
case IGC_OBJ_OBJ_VEC:
case IGC_OBJ_HASH_VEC:
IGC_FIX_CALL_FN (ss, Lisp_Object, client, fix_obj_vec);
break;
case IGC_OBJ_CONS:
IGC_FIX_CALL_FN (ss, struct Lisp_Cons, client, fix_cons);
break;
case IGC_OBJ_STRING_DATA:
case IGC_OBJ_FLOAT:
case IGC_OBJ_BYTES:
case IGC_OBJ_DUMPED_CODE_SPACE_MASKS:
case IGC_OBJ_DUMPED_BUFFER_TEXT:
case IGC_OBJ_DUMPED_BIGNUM_DATA:
case IGC_OBJ_DUMPED_BYTES:
/* Can occur in the dump. */
break;
case IGC_OBJ_NUM_TYPES:
emacs_abort ();
case IGC_OBJ_SYMBOL:
IGC_FIX_CALL_FN (ss, struct Lisp_Symbol, client, fix_symbol);
break;
case IGC_OBJ_INTERVAL:
IGC_FIX_CALL_FN (ss, struct interval, client, fix_interval);
break;
case IGC_OBJ_STRING:
IGC_FIX_CALL_FN (ss, struct Lisp_String, client, fix_string);
break;
case IGC_OBJ_VECTOR:
case IGC_OBJ_VECTOR_WEAK:
IGC_FIX_CALL_FN (ss, struct Lisp_Vector, client, fix_vector);
break;
case IGC_OBJ_ITREE_TREE:
IGC_FIX_CALL_FN (ss, struct itree_tree, client, fix_itree_tree);
break;
case IGC_OBJ_ITREE_NODE:
IGC_FIX_CALL_FN (ss, struct itree_node, client, fix_itree_node);
break;
case IGC_OBJ_IMAGE:
IGC_FIX_CALL_FN (ss, struct image, client, fix_image);
break;
case IGC_OBJ_IMAGE_CACHE:
IGC_FIX_CALL_FN (ss, struct image_cache, client, fix_image_cache);
break;
case IGC_OBJ_FACE:
IGC_FIX_CALL_FN (ss, struct face, client, fix_face);
break;
case IGC_OBJ_FACE_CACHE:
IGC_FIX_CALL_FN (ss, struct face_cache, client, fix_face_cache);
break;
case IGC_OBJ_BLV:
IGC_FIX_CALL_FN (ss, struct Lisp_Buffer_Local_Value, client,
fix_blv);
break;
case IGC_OBJ_DUMPED_CHARSET_TABLE:
IGC_FIX_CALL (ss, fix_charset_table (ss, (struct charset *)client,
obj_size (header)));
break;
case IGC_OBJ_WEAK_HASH_TABLE_STRONG_PART:
IGC_FIX_CALL_FN (ss, struct Lisp_Weak_Hash_Table_Strong_Part, client,
fix_weak_hash_table_strong_part);
break;
case IGC_OBJ_WEAK_HASH_TABLE_WEAK_PART:
IGC_FIX_CALL_FN (ss, struct Lisp_Weak_Hash_Table_Strong_Part, client,
fix_weak_hash_table_weak_part);
break;
}
}
MPS_SCAN_END (ss);
return MPS_RES_OK;
}
static mps_res_t
dflt_scanx (mps_ss_t ss, mps_addr_t base_start, mps_addr_t base_limit,
void *closure)
{
MPS_SCAN_BEGIN (ss)
{
for (mps_addr_t base = base_start; base < base_limit;
base = dflt_skip (base))
IGC_FIX_CALL (ss, dflt_scan_obj (ss, base, base_limit, closure));
}
MPS_SCAN_END (ss);
return MPS_RES_OK;
}
static mps_res_t
dflt_scan (mps_ss_t ss, mps_addr_t base_start, mps_addr_t base_limit)
{
MPS_SCAN_BEGIN (ss)
{
IGC_FIX_CALL (ss, dflt_scanx (ss, base_start, base_limit, NULL));
}
MPS_SCAN_END (ss);
return MPS_RES_OK;
}
static mps_res_t
fix_vectorlike (mps_ss_t ss, struct Lisp_Vector *v)
{
MPS_SCAN_BEGIN (ss)
{
size_t size = vector_size (v);
IGC_FIX12_NOBJS (ss, v->contents, size);
}
MPS_SCAN_END (ss);
return MPS_RES_OK;
}
static mps_res_t
fix_buffer (mps_ss_t ss, struct buffer *b)
{
MPS_SCAN_BEGIN (ss)
{
IGC_FIX_CALL_FN (ss, struct Lisp_Vector, b, fix_vectorlike);
IGC_FIX12_RAW (ss, &b->own_text.intervals);
IGC_FIX12_OBJ (ss, &b->own_text.markers);
IGC_FIX12_RAW (ss, &b->overlays);
IGC_FIX12_OBJ (ss, &b->undo_list_);
IGC_FIX12_RAW (ss, &b->base_buffer);
if (b->base_buffer)
b->text = &b->base_buffer->own_text;
else
b->text = &b->own_text;
}
MPS_SCAN_END (ss);
return MPS_RES_OK;
}
static mps_res_t
fix_glyph_matrix (mps_ss_t ss, struct glyph_matrix *matrix)
{
MPS_SCAN_BEGIN (ss)
{
struct glyph_row *row = matrix->rows;
struct glyph_row *end = row + matrix->nrows;
for (; row < end; ++row)
if (row->enabled_p)
{
for (int area = LEFT_MARGIN_AREA; area < LAST_AREA; ++area)
{
struct glyph *glyph = row->glyphs[area];
struct glyph *end_glyph = glyph + row->used[area];
for (; glyph < end_glyph; ++glyph)
IGC_FIX12_OBJ (ss, &glyph->object);
}
}
IGC_FIX12_RAW (ss, &matrix->buffer);
}
MPS_SCAN_END (ss);
return MPS_RES_OK;
}
static mps_res_t
fix_frame (mps_ss_t ss, struct frame *f)
{
MPS_SCAN_BEGIN (ss)
{
// FIXME/igc: Check these
// output_data;
// terminal
// glyph_pool
// glyph matrices
// struct font_driver_list *font_driver_list;
// struct text_conversion_state conversion;
IGC_FIX_CALL_FN (ss, struct Lisp_Vector, f, fix_vectorlike);
IGC_FIX12_RAW (ss, &f->face_cache);
if (f->terminal)
IGC_FIX12_RAW (ss, &f->terminal);
#ifdef HAVE_WINDOW_SYSTEM
if (f->image_cache)
IGC_FIX12_RAW (ss, &f->image_cache);
if (FRAME_WINDOW_P (f) && FRAME_OUTPUT_DATA (f))
{
struct font **font_ptr = &FRAME_FONT (f);
if (*font_ptr)
IGC_FIX12_RAW (ss, font_ptr);
Lisp_Object *nle = &FRAME_DISPLAY_INFO (f)->name_list_element;
IGC_FIX12_OBJ (ss, nle);
#ifdef HAVE_NS
struct ns_display_info *i = FRAME_DISPLAY_INFO (f);
IGC_FIX12_RAW (ss, &i->terminal);
IGC_FIX12_OBJ (ss, &i->rdb);
IGC_FIX12_RAW (ss, &i->highlight_frame);
IGC_FIX12_RAW (ss, &i->ns_focus_frame);
IGC_FIX12_RAW (ss, &i->last_mouse_motion_frame);
struct frame **pf = ns_emacs_view_emacs_frame (f);
if (pf)
IGC_FIX12_RAW (ss, pf);
#endif
}
#endif // HAVE_WINDOW_SYSTEM
}
MPS_SCAN_END (ss);
return MPS_RES_OK;
}
static mps_res_t
fix_window (mps_ss_t ss, struct window *w)
{
MPS_SCAN_BEGIN (ss)
{
IGC_FIX_CALL_FN (ss, struct Lisp_Vector, w, fix_vectorlike);
if (w->current_matrix)
IGC_FIX_CALL (ss, fix_glyph_matrix (ss, w->current_matrix));
if (w->desired_matrix)
IGC_FIX_CALL (ss, fix_glyph_matrix (ss, w->desired_matrix));
IGC_FIX12_OBJ (ss, &w->prev_buffers);
IGC_FIX12_OBJ (ss, &w->next_buffers);
#ifdef HAVE_NS
void *pr[4];
int n = ns_emacs_scroller_refs (w, pr, ARRAYELTS (pr));
for (int i = 0; i < n; ++i)
IGC_FIX12_RAW (ss, pr[i]);
#endif
}
MPS_SCAN_END (ss);
return MPS_RES_OK;
}
static mps_res_t
fix_hash_table (mps_ss_t ss, struct Lisp_Hash_Table *h)
{
MPS_SCAN_BEGIN (ss)
{
// FIXME/igc: weak hash tables
IGC_FIX12_RAW (ss, &h->key);
IGC_FIX12_RAW (ss, &h->value);
IGC_FIX12_RAW (ss, &h->hash);
IGC_FIX12_RAW (ss, &h->next);
IGC_FIX12_RAW (ss, &h->index);
}
MPS_SCAN_END (ss);
return MPS_RES_OK;
}
static mps_res_t
fix_weak_hash_table (mps_ss_t ss, struct Lisp_Weak_Hash_Table *h)
{
MPS_SCAN_BEGIN (ss)
{
// FIXME/igc: weak hash tables
IGC_FIX12_RAW (ss, &h->strong);
IGC_FIX12_RAW (ss, &h->weak);
}
MPS_SCAN_END (ss);
return MPS_RES_OK;
}
static mps_res_t
fix_weak_hash_table_strong_part (mps_ss_t ss, struct Lisp_Weak_Hash_Table_Strong_Part *t)
{
MPS_SCAN_BEGIN (ss)
{
for (ssize_t i = 0; i < 4 * XFIXNUM (t->table_size); i++)
{
IGC_FIX12_OBJ (ss, &t->entries[i]);
}
}
MPS_SCAN_END (ss);
return MPS_RES_OK;
}
extern void
weak_hash_splat_from_table (struct Lisp_Weak_Hash_Table *h, ptrdiff_t i0);
static mps_res_t
fix_weak_hash_table_weak_part (mps_ss_t ss, struct Lisp_Weak_Hash_Table_Weak_Part *w)
{
MPS_SCAN_BEGIN (ss)
{
IGC_FIX12_RAW (ss, &w->strong);
struct Lisp_Weak_Hash_Table_Strong_Part *t = w->strong;
for (ssize_t i = 0; i < 4 * XFIXNUM (t->table_size); i++)
{
bool was_nil = NILP (w->entries[i].lisp_object);
IGC_FIX12_OBJ (ss, &w->entries[i]);
bool is_now_nil = NILP (w->entries[i].lisp_object);
if (is_now_nil && !was_nil)
{
struct Lisp_Weak_Hash_Table pseudo_h =
{
.strong = t,
.weak = w,
};
weak_hash_splat_from_table (&pseudo_h, i);
}
}
}
MPS_SCAN_END (ss);
return MPS_RES_OK;
}
static mps_res_t
fix_char_table (mps_ss_t ss, struct Lisp_Vector *v)
{
MPS_SCAN_BEGIN (ss)
{
for (size_t i = vector_start (v), n = vector_size (v); i < n; ++i)
IGC_FIX12_OBJ (ss, &v->contents[i]);
}
MPS_SCAN_END (ss);
return MPS_RES_OK;
}
static mps_res_t
fix_overlay (mps_ss_t ss, struct Lisp_Overlay *o)
{
MPS_SCAN_BEGIN (ss)
{
IGC_FIX12_RAW (ss, &o->buffer);
IGC_FIX12_OBJ (ss, &o->plist);
IGC_FIX12_RAW (ss, &o->interval);
}
MPS_SCAN_END (ss);
return MPS_RES_OK;
}
static mps_res_t
fix_subr (mps_ss_t ss, struct Lisp_Subr *s)
{
MPS_SCAN_BEGIN (ss)
{
#ifdef HAVE_NATIVE_COMP
if (!NILP (s->native_comp_u))
{
IGC_FIX12_OBJ (ss, &s->native_comp_u);
IGC_FIX12_OBJ (ss, &s->command_modes);
IGC_FIX12_OBJ (ss, &s->intspec.native);
IGC_FIX12_OBJ (ss, &s->lambda_list);
IGC_FIX12_OBJ (ss, &s->type);
}
#endif
}
MPS_SCAN_END (ss);
return MPS_RES_OK;
}
static mps_res_t
fix_misc_ptr (mps_ss_t ss, struct Lisp_Misc_Ptr *p)
{
MPS_SCAN_BEGIN (ss)
{
IGC_FIX_CALL_FN (ss, struct Lisp_Vector, p, fix_vectorlike);
IGC_FIX12_RAW (ss, &p->pointer);
}
MPS_SCAN_END (ss);
return MPS_RES_OK;
}
static mps_res_t
fix_user_ptr (mps_ss_t ss, struct Lisp_User_Ptr *p)
{
MPS_SCAN_BEGIN (ss)
{
IGC_FIX_CALL_FN (ss, struct Lisp_Vector, p, fix_vectorlike);
IGC_FIX12_RAW (ss, &p->p);
}
MPS_SCAN_END (ss);
return MPS_RES_OK;
}
static mps_res_t
fix_thread (mps_ss_t ss, struct thread_state *s)
{
MPS_SCAN_BEGIN (ss)
{
IGC_FIX_CALL_FN (ss, struct Lisp_Vector, s, fix_vectorlike);
IGC_FIX12_RAW (ss, &s->m_current_buffer);
IGC_FIX12_RAW (ss, &s->next_thread);
IGC_FIX12_RAW (ss, &s->m_handlerlist);
IGC_FIX12_RAW (ss, &s->m_handlerlist_sentinel);
}
MPS_SCAN_END (ss);
return MPS_RES_OK;
}
/* This is here because main_thread is, for some reason, a variable in
the data segment, and not like other threads. */
static mps_res_t
scan_main_thread (mps_ss_t ss, void *start, void *end, void *closure)
{
igc_assert (start == (void *) &main_thread.s);
MPS_SCAN_BEGIN (ss)
{
struct thread_state *s = start;
IGC_FIX_CALL (ss, fix_thread (ss, s));
}
MPS_SCAN_END (ss);
return MPS_RES_OK;
}
static mps_res_t
fix_mutex (mps_ss_t ss, struct Lisp_Mutex *m)
{
MPS_SCAN_BEGIN (ss)
{
IGC_FIX_CALL_FN (ss, struct Lisp_Vector, m, fix_vectorlike);
IGC_FIX12_RAW (ss, &m->name);
}
MPS_SCAN_END (ss);
return MPS_RES_OK;
}
static mps_res_t
fix_coding (mps_ss_t ss, struct coding_system *c)
{
MPS_SCAN_BEGIN (ss)
{
if (c)
{
IGC_FIX12_OBJ (ss, &c->src_object);
IGC_FIX12_OBJ (ss, &c->dst_object);
}
}
MPS_SCAN_END (ss);
return MPS_RES_OK;
}
static mps_res_t
fix_terminal (mps_ss_t ss, struct terminal *t)
{
MPS_SCAN_BEGIN (ss)
{
IGC_FIX_CALL_FN (ss, struct Lisp_Vector, t, fix_vectorlike);
IGC_FIX12_RAW (ss, &t->next_terminal);
// These are malloc'd, so they can be accessed.
IGC_FIX_CALL_FN (ss, struct coding_system, t->keyboard_coding, fix_coding);
IGC_FIX_CALL_FN (ss, struct coding_system, t->terminal_coding, fix_coding);
}
MPS_SCAN_END (ss);
return MPS_RES_OK;
}
static mps_res_t
fix_marker (mps_ss_t ss, struct Lisp_Marker *m)
{
MPS_SCAN_BEGIN (ss)
{
if (m->buffer)
IGC_FIX12_RAW (ss, &m->buffer);
}
MPS_SCAN_END (ss);
return MPS_RES_OK;
}
static mps_res_t
fix_finalizer (mps_ss_t ss, struct Lisp_Finalizer *f)
{
MPS_SCAN_BEGIN (ss)
{
IGC_FIX_CALL_FN (ss, struct Lisp_Vector, f, fix_vectorlike);
IGC_FIX12_RAW (ss, &f->next);
IGC_FIX12_RAW (ss, &f->prev);
}
MPS_SCAN_END (ss);
return MPS_RES_OK;
}
static mps_res_t
fix_comp_unit (mps_ss_t ss, struct Lisp_Native_Comp_Unit *u)
{
MPS_SCAN_BEGIN (ss)
{
IGC_FIX_CALL_FN (ss, struct Lisp_Vector, u, fix_vectorlike);
/* FIXME/igc: Cannot scan things within the shared object because we
don't have exclusive (synchronized) access to them. Instead of
storing Lisp_Object references in vectors in the dylib data
segment it would be much nicer to store them in MPS and give the
dylib a pointer to them. */
}
MPS_SCAN_END (ss);
return MPS_RES_OK;
}
#ifdef HAVE_XWIDGETS
static mps_res_t
fix_xwidget (mps_ss_t ss, struct xwidget *w)
{
MPS_SCAN_BEGIN (ss)
{
IGC_FIX_CALL_FN (ss, struct Lisp_Vector, w, fix_vectorlike);
# if defined (NS_IMPL_COCOA)
IGC_FIX12_RAW (ss, &w->xv);
# elif defined USE_GTK
IGC_FIX12_RAW (ss, &w->embedder);
IGC_FIX12_RAW (ss, &w->embedder_view);
# endif
}
MPS_SCAN_END (ss);
return MPS_RES_OK;
}
static mps_res_t
fix_xwidget_view (mps_ss_t ss, struct xwidget_view *v)
{
MPS_SCAN_BEGIN (ss)
{
IGC_FIX_CALL_FN (ss, struct Lisp_Vector, v, fix_vectorlike);
# ifdef USE_GTK
IGC_FIX12_RAW (ss, &v->frame);
# endif
}
MPS_SCAN_END (ss);
return MPS_RES_OK;
}
#endif // HAVE_XWIDGETS
#ifdef HAVE_MODULES
static mps_res_t
fix_global_ref (mps_ss_t ss, struct module_global_reference *r)
{
MPS_SCAN_BEGIN (ss)
{
IGC_FIX_CALL_FN (ss, struct Lisp_Vector, r, fix_vectorlike);
IGC_FIX12_OBJ (ss, &r->value.v);
}
MPS_SCAN_END (ss);
return MPS_RES_OK;
}
#endif
#ifndef IN_MY_FORK
static mps_res_t
fix_obarray (mps_ss_t ss, struct Lisp_Obarray *o)
{
MPS_SCAN_BEGIN (ss)
{
IGC_FIX12_RAW (ss, &o->buckets);
}
MPS_SCAN_END (ss);
return MPS_RES_OK;
}
#endif
#ifdef HAVE_TREE_SITTER
static mps_res_t
fix_ts_parser (mps_ss_t ss, struct Lisp_TS_Parser *p)
{
MPS_SCAN_BEGIN (ss)
{
IGC_FIX_CALL_FN (ss, struct Lisp_Vector, p, fix_vectorlike);
IGC_FIX12_RAW (ss, &p->input.payload);
}
MPS_SCAN_END (ss);
return MPS_RES_OK;
}
#endif
/* Note that there is a small window after committing a vectorlike
allocation where the object is zeroed, and so the vector header is
also zero. This doesn't have an adverse effect. */
static mps_res_t
fix_vector (mps_ss_t ss, struct Lisp_Vector *v)
{
MPS_SCAN_BEGIN (ss)
{
switch (pseudo_vector_type (v))
{
#ifndef IN_MY_FORK
case PVEC_OBARRAY:
IGC_FIX_CALL_FN (ss, struct Lisp_Obarray, v, fix_obarray);
break;
#endif
case PVEC_BUFFER:
IGC_FIX_CALL_FN (ss, struct buffer, v, fix_buffer);
break;
case PVEC_FRAME:
IGC_FIX_CALL_FN (ss, struct frame, v, fix_frame);
break;
case PVEC_WINDOW:
IGC_FIX_CALL_FN (ss, struct window, v, fix_window);
break;
case PVEC_HASH_TABLE:
IGC_FIX_CALL_FN (ss, struct Lisp_Hash_Table, v, fix_hash_table);
break;
case PVEC_WEAK_HASH_TABLE:
IGC_FIX_CALL_FN (ss, struct Lisp_Hash_Table, v, fix_weak_hash_table);
break;
case PVEC_CHAR_TABLE:
case PVEC_SUB_CHAR_TABLE:
IGC_FIX_CALL_FN (ss, struct Lisp_Vector, v, fix_char_table);
break;
case PVEC_BOOL_VECTOR:
break;
case PVEC_OVERLAY:
IGC_FIX_CALL_FN (ss, struct Lisp_Overlay, v, fix_overlay);
break;
case PVEC_SUBR:
IGC_FIX_CALL_FN (ss, struct Lisp_Subr, v, fix_subr);
break;
case PVEC_FREE:
emacs_abort ();
case PVEC_FINALIZER:
IGC_FIX_CALL_FN (ss, struct Lisp_Finalizer, v, fix_finalizer);
break;
case PVEC_MISC_PTR:
IGC_FIX_CALL_FN (ss, struct Lisp_Misc_Ptr, v, fix_misc_ptr);
break;
case PVEC_USER_PTR:
IGC_FIX_CALL_FN (ss, struct Lisp_User_Ptr, v, fix_user_ptr);
break;
#ifdef HAVE_XWIDGETS
case PVEC_XWIDGET:
IGC_FIX_CALL_FN (ss, struct xwidget, v, fix_xwidget);
break;
case PVEC_XWIDGET_VIEW:
IGC_FIX_CALL_FN (ss, struct xwidget_view, v, fix_xwidget_view);
break;
#else
case PVEC_XWIDGET:
case PVEC_XWIDGET_VIEW:
IGC_FIX_CALL_FN (ss, struct Lisp_Vector, v, fix_vectorlike);
break;
#endif
case PVEC_THREAD:
IGC_FIX_CALL_FN (ss, struct thread_state, v, fix_thread);
break;
case PVEC_MUTEX:
IGC_FIX_CALL_FN (ss, struct Lisp_Mutex, v, fix_mutex);
break;
case PVEC_TERMINAL:
IGC_FIX_CALL_FN (ss, struct terminal, v, fix_terminal);
break;
case PVEC_MARKER:
IGC_FIX_CALL_FN (ss, struct Lisp_Marker, v, fix_marker);
break;
case PVEC_BIGNUM:
break;
case PVEC_NATIVE_COMP_UNIT:
IGC_FIX_CALL_FN (ss, struct Lisp_Native_Comp_Unit, v, fix_comp_unit);
break;
case PVEC_MODULE_GLOBAL_REFERENCE:
#ifdef HAVE_MODULES
IGC_FIX_CALL_FN (ss, struct module_global_reference, v, fix_global_ref);
#endif
break;
case PVEC_TS_PARSER:
#ifdef HAVE_TREE_SITTER
IGC_FIX_CALL_FN (ss, struct Lisp_TS_Parser, v, fix_ts_parser);
#else
IGC_FIX_CALL_FN (ss, struct Lisp_Vector, v, fix_vectorlike);
#endif
break;
case PVEC_FONT:
case PVEC_NORMAL_VECTOR:
case PVEC_SYMBOL_WITH_POS:
case PVEC_PROCESS:
case PVEC_WINDOW_CONFIGURATION:
case PVEC_MODULE_FUNCTION:
case PVEC_CONDVAR:
case PVEC_TS_COMPILED_QUERY:
case PVEC_TS_NODE:
case PVEC_SQLITE:
case PVEC_CLOSURE:
case PVEC_RECORD:
case PVEC_OTHER:
#ifdef IN_MY_FORK
case PVEC_PACKAGE:
#endif
IGC_FIX_CALL_FN (ss, struct Lisp_Vector, v, fix_vectorlike);
break;
}
}
MPS_SCAN_END (ss);
return MPS_RES_OK;
}
static igc_scan_result_t
fix12_obj_callback (struct igc_opaque *op, Lisp_Object *addr)
{
mps_ss_t ss = (mps_ss_t) op;
MPS_SCAN_BEGIN (ss)
{
IGC_FIX12_OBJ (ss, addr);
}
MPS_SCAN_END (ss);
return MPS_RES_OK;
}
#pragma GCC diagnostic pop
static igc_root_list *
root_create (struct igc *gc, void *start, void *end, mps_rank_t rank,
mps_area_scan_t scan, void *closure, bool ambig,
const char *label)
{
mps_root_t root;
mps_res_t res
= mps_root_create_area (&root, gc->arena, rank, 0, start, end, scan,
closure);
IGC_CHECK_RES (res);
return register_root (gc, root, start, end, ambig, label);
}
static igc_root_list *
root_create_ambig (struct igc *gc, void *start, void *end,
const char *label)
{
return root_create (gc, start, end, mps_rank_ambig (), scan_ambig, NULL,
true, label);
}
static igc_root_list *
root_create_exact (struct igc *gc, void *start, void *end,
mps_area_scan_t scan, const char *label)
{
return root_create (gc, start, end, mps_rank_exact (), scan, NULL, false,
label);
}
static void
root_create_staticvec (struct igc *gc)
{
root_create_exact (gc, staticvec, staticvec + ARRAYELTS (staticvec),
scan_staticvec, "staticvec");
}
static void
root_create_lispsym (struct igc *gc)
{
root_create_exact (gc, lispsym, lispsym + ARRAYELTS (lispsym),
scan_lispsym, "lispsym");
}
static void
root_create_buffer (struct igc *gc, struct buffer *b)
{
void *start = &b->name_, *end = &b->own_text;
root_create_ambig (gc, start, end, "buffer");
}
static void
root_create_terminal_list (struct igc *gc)
{
void *start = &terminal_list;
void *end = (char *) start + sizeof (terminal_list);
root_create_ambig (gc, start, end, "terminal-list");
}
static void
root_create_tty_list (struct igc *gc)
{
root_create_exact (gc, &tty_list, (&tty_list) + 1,
scan_tty_list, "tty-list");
}
static void
root_create_main_thread (struct igc *gc)
{
void *start = &main_thread.s;
void *end = (char *) &main_thread.s + sizeof (main_thread.s);
root_create_exact (gc, start, end, scan_main_thread, "main-thread");
}
void
igc_root_create_ambig (void *start, void *end, const char* label)
{
root_create_ambig (global_igc, start, end, label);
}
void
igc_root_create_exact (Lisp_Object *start, Lisp_Object *end)
{
root_create_exact (global_igc, start, end, scan_exact, "exact");
}
static void
root_create_exact_ptr (struct igc *gc, void *var_addr)
{
char *start = var_addr;
char *end = start + sizeof (void *);
root_create_exact (gc, start, end, scan_ptr_exact, "exact-ptr");
}
void
igc_root_create_exact_ptr (void *var_addr)
{
root_create_exact_ptr (global_igc, var_addr);
}
static void
root_create_specpdl (struct igc_thread_list *t)
{
struct igc *gc = t->d.gc;
struct thread_state *ts = t->d.ts;
igc_assert (ts->m_specpdl != NULL);
igc_assert (t->d.specpdl_root == NULL);
mps_root_t root;
mps_res_t res
= mps_root_create_area (&root, gc->arena, mps_rank_exact (), 0,
ts->m_specpdl, ts->m_specpdl_end, scan_specpdl, t);
IGC_CHECK_RES (res);
t->d.specpdl_root
= register_root (gc, root, ts->m_specpdl, ts->m_specpdl_end, false,
"specpdl");
}
static void
root_create_bc (struct igc_thread_list *t)
{
struct igc *gc = t->d.gc;
struct bc_thread_state *bc = &t->d.ts->bc;
igc_assert (bc->stack != NULL);
mps_root_t root;
mps_res_t res = mps_root_create_area (&root, gc->arena, mps_rank_ambig (), 0,
bc->stack, bc->stack_end, scan_bc, t);
IGC_CHECK_RES (res);
igc_assert (t->d.bc_root == NULL);
t->d.bc_root = register_root (gc, root, bc->stack, bc->stack_end, true,
"bc-stack");
}
static void
root_create_charset_table (struct igc *gc)
{
root_create_ambig (gc, charset_table_init,
charset_table_init + ARRAYELTS (charset_table_init),
"charset-table");
}
#ifndef IN_MY_FORK
static void
root_create_pure (struct igc *gc)
{
void *start = &pure[0];
void *end = &pure[pure_dim];
root_create (gc, start, end, mps_rank_ambig (), scan_pure, NULL, true,
"pure");
}
#endif
static void
root_create_thread (struct igc_thread_list *t)
{
struct igc *gc = t->d.gc;
mps_root_t root;
void *cold = (void *) t->d.ts->m_stack_bottom;
mps_res_t res
= mps_root_create_thread_scanned (&root, gc->arena, mps_rank_ambig (), 0,
t->d.thr, scan_ambig, 0, cold);
IGC_CHECK_RES (res);
t->d.stack_root = register_root (gc, root, cold, NULL, true, "control stack");
}
void
igc_on_grow_specpdl (void)
{
/* Note that no two roots may overlap, so we have to temporarily
stop the collector while replacing one root with another (xpalloc
may realloc). Alternatives: (1) don't realloc, (2) alloc specpdl
from MPS pool that is scanned. */
struct igc_thread_list *t = current_thread->gc_info;
IGC_WITH_PARKED (t->d.gc)
{
destroy_root (&t->d.specpdl_root);
root_create_specpdl (t);
}
}
static igc_root_list *
root_create_exact_n (Lisp_Object *start, size_t n)
{
igc_assert (start != NULL);
igc_assert (n > 0);
return root_create_exact (global_igc, start, start + n, scan_exact,
"exact-n");
}
void *
igc_root_create_n (Lisp_Object start[], size_t n)
{
return root_create_exact_n (start, n);
}
static igc_root_list *
root_find (void *start)
{
for (igc_root_list *r = global_igc->roots; r; r = r->next)
if (r->d.start == start)
return r;
return NULL;
}
static void
destroy_root_with_start (void *start)
{
if (start)
{
struct igc_root_list *r = root_find (start);
igc_assert (r != NULL);
destroy_root (&r);
}
}
static void
maybe_destroy_root (struct igc_root_list **root)
{
if (*root)
destroy_root (root);
}
void
igc_root_destroy_comp_unit (struct Lisp_Native_Comp_Unit *u)
{
maybe_destroy_root (&u->data_relocs_root);
maybe_destroy_root (&u->data_imp_relocs_root);
maybe_destroy_root (&u->data_eph_relocs_root);
maybe_destroy_root (&u->comp_unit_root);
}
void
igc_root_destroy_comp_unit_eph (struct Lisp_Native_Comp_Unit *u)
{
maybe_destroy_root (&u->data_eph_relocs_root);
}
static mps_res_t
create_weak_ap (mps_ap_t *ap, struct igc_thread *t, bool weak)
{
struct igc *gc = t->gc;
mps_res_t res;
mps_pool_t pool = gc->weak_pool;
MPS_ARGS_BEGIN (args)
{
MPS_ARGS_ADD (args, MPS_KEY_RANK,
weak ? mps_rank_weak () : mps_rank_exact ());
res = mps_ap_create_k (ap, pool, args);
}
MPS_ARGS_END (args);
return res;
}
static mps_res_t
create_weak_hash_ap (mps_ap_t *ap, struct igc_thread *t, bool weak)
{
struct igc *gc = t->gc;
mps_res_t res;
mps_pool_t pool = gc->weak_hash_pool;
MPS_ARGS_BEGIN (args)
{
MPS_ARGS_ADD (args, MPS_KEY_RANK,
weak ? mps_rank_weak () : mps_rank_exact ());
res = mps_ap_create_k (ap, pool, args);
}
MPS_ARGS_END (args);
return res;
}
static void
create_thread_aps (struct igc_thread *t)
{
struct igc *gc = t->gc;
mps_res_t res;
res = mps_ap_create_k (&t->dflt_ap, gc->dflt_pool, mps_args_none);
IGC_CHECK_RES (res);
res = mps_ap_create_k (&t->leaf_ap, gc->leaf_pool, mps_args_none);
IGC_CHECK_RES (res);
res = mps_ap_create_k (&t->immovable_ap, gc->immovable_pool, mps_args_none);
IGC_CHECK_RES (res);
res = create_weak_ap (&t->weak_strong_ap, t, false);
IGC_CHECK_RES (res);
res = create_weak_ap (&t->weak_weak_ap, t, true);
IGC_CHECK_RES (res);
res = create_weak_hash_ap (&t->weak_hash_strong_ap, t, false);
IGC_CHECK_RES (res);
res = create_weak_hash_ap (&t->weak_hash_weak_ap, t, true);
IGC_CHECK_RES (res);
}
static struct igc_thread_list *
thread_add (struct thread_state *ts)
{
mps_thr_t thr;
mps_res_t res = mps_thread_reg (&thr, global_igc->arena);
IGC_CHECK_RES (res);
struct igc_thread_list *t = register_thread (global_igc, thr, ts);
root_create_thread (t);
create_thread_aps (&t->d);
return t;
}
void *
igc_thread_add (struct thread_state *ts)
{
struct igc_thread_list *t = thread_add (ts);
root_create_specpdl (t);
root_create_bc (t);
return t;
}
void
igc_on_alloc_main_thread_specpdl (void)
{
root_create_specpdl (current_thread->gc_info);
}
void
igc_on_alloc_main_thread_bc (void)
{
root_create_bc (current_thread->gc_info);
}
static void
add_main_thread (void)
{
igc_assert (current_thread == &main_thread.s);
igc_assert (current_thread->gc_info == NULL);
igc_assert (current_thread->m_stack_bottom == stack_bottom);
struct igc_thread_list *t = thread_add (current_thread);
current_thread->gc_info = t;
igc_assert (t->d.ts == current_thread);
}
void
igc_thread_remove (void **pinfo)
{
struct igc_thread_list *t = *pinfo;
*pinfo = NULL;
destroy_root (&t->d.stack_root);
destroy_root (&t->d.specpdl_root);
destroy_root (&t->d.bc_root);
mps_ap_destroy (t->d.dflt_ap);
mps_ap_destroy (t->d.leaf_ap);
mps_ap_destroy (t->d.weak_strong_ap);
mps_ap_destroy (t->d.weak_weak_ap);
mps_ap_destroy (t->d.weak_hash_strong_ap);
mps_ap_destroy (t->d.weak_hash_weak_ap);
mps_ap_destroy (t->d.immovable_ap);
mps_thread_dereg (deregister_thread (t));
}
static void
_release_arena (void)
{
arena_release (global_igc);
}
specpdl_ref
igc_park_arena (void)
{
specpdl_ref count = SPECPDL_INDEX ();
record_unwind_protect_void (_release_arena);
arena_park (global_igc);
return count;
}
void
igc_grow_rdstack (struct read_stack *rs)
{
struct igc *gc = global_igc;
IGC_WITH_PARKED (gc)
{
destroy_root_with_start (rs->stack);
ptrdiff_t old_nitems = rs->size;
rs->stack = xpalloc (rs->stack, &rs->size, 1, -1, sizeof *rs->stack);
for (ptrdiff_t i = old_nitems; i < rs->size; ++i)
rs->stack[i].type = RE_free;
root_create_exact (gc, rs->stack, rs->stack + rs->size, scan_rdstack,
"rdstack");
}
}
Lisp_Object *
igc_xalloc_lisp_objs_exact (size_t n)
{
size_t size = n * sizeof (Lisp_Object);
void *p = xzalloc (size);
root_create_exact (global_igc, p, (char *) p + size, scan_exact,
"xalloc-exact");
return p;
}
void *
igc_xzalloc_ambig (size_t size)
{
/* Not sure if xzalloc can ever return NULL here, depending on all the
config options involved. Also not sure when it returns non-null for
size 0. It does for me on macOS. */
void *p = xzalloc (size);
if (p == NULL)
return NULL;
/* Can't make a root that has zero length. Want one to be able to
detect calling igc_free on something not having a root. */
void *end = (char *) p + size;
if (end == p)
end = (char *) p + IGC_ALIGN_DFLT;
root_create_ambig (global_igc, p, end, "xzalloc-ambig");
return p;
}
void *
igc_realloc_ambig (void *block, size_t size)
{
destroy_root_with_start (block);
/* Can't make a root that has zero length. Want one to be able to
detect calling igc_free on something not having a root. */
size_t new_size = (size == 0 ? IGC_ALIGN_DFLT : size);
void *p = xrealloc (block, new_size);
void *end = (char *)p + new_size;
root_create_ambig (global_igc, p, end, "realloc-ambig");
return p;
}
void
igc_xfree (void *p)
{
/* Check for pdumper_object_p here because xfree does the same. Means
that freeing something that is actually in the dump is not an
error. Make the same true if the dump is loaded into MPS memory. */
if (p == NULL || pdumper_object_p (p))
return;
destroy_root_with_start (p);
xfree (p);
}
void *
igc_xpalloc_ambig (void *pa, ptrdiff_t *nitems, ptrdiff_t nitems_incr_min,
ptrdiff_t nitems_max, ptrdiff_t item_size)
{
IGC_WITH_PARKED (global_igc)
{
destroy_root_with_start (pa);
pa = xpalloc (pa, nitems, nitems_incr_min, nitems_max, item_size);
char *end = (char *) pa + *nitems * item_size;
root_create_ambig (global_igc, pa, end, "xpalloc-ambig");
}
return pa;
}
static mps_res_t
scan_xpalloced (mps_ss_t ss, void *start, void *end, void *closure)
{
igc_scan_area_t scan_area = closure;
igc_fix12_obj_t fix12_obj = (igc_fix12_obj_t) fix12_obj_callback;
return scan_area ((struct igc_opaque *) ss, start, end, fix12_obj);
}
void
igc_xpalloc_exact (void **pa_cell, ptrdiff_t *nitems,
ptrdiff_t nitems_incr_min, ptrdiff_t nitems_max,
ptrdiff_t item_size, igc_scan_area_t scan_area)
{
IGC_WITH_PARKED (global_igc)
{
void *pa = *pa_cell;
destroy_root_with_start (pa);
pa = xpalloc (pa, nitems, nitems_incr_min, nitems_max, item_size);
char *end = (char *)pa + *nitems * item_size;
root_create (global_igc, pa, end, mps_rank_exact (),
scan_xpalloced, scan_area, false, "xpalloc-exact");
*pa_cell = pa;
}
}
void *
igc_xnrealloc_ambig (void *pa, ptrdiff_t nitems, ptrdiff_t item_size)
{
IGC_WITH_PARKED (global_igc)
{
destroy_root_with_start (pa);
pa = xnrealloc (pa, nitems, item_size);
char *end = (char *) pa + nitems * item_size;
root_create_ambig (global_igc, pa, end, "xnrealloc-ambig");
}
return pa;
}
static void
finalize_bignum (struct Lisp_Bignum *n)
{
mpz_clear (n->value);
}
static void
finalize_font (struct font *font)
{
struct Lisp_Vector *v = (void *) font;
if (vector_size (v) == FONT_OBJECT_MAX)
{
/* The font driver might sometimes be NULL, e.g. if Emacs was
interrupted before it had time to set it up. */
const struct font_driver *drv = font->driver;
if (drv)
{
/* Attempt to catch subtle bugs like Bug#16140. */
eassert (valid_font_driver (drv));
drv->close_font (font);
}
}
#if defined HAVE_ANDROID && !defined ANDROID_STUBIFY
/* The Android font driver needs the ability to associate extra
information with font entities. */
if (vector_size (v) == FONT_ENTITY_MAX
&& PSEUDOVEC_STRUCT (vector, font_entity)->is_android)
android_finalize_font_entity (PSEUDOVEC_STRUCT (vector, font_entity));
#endif
}
static void
finalize_user_ptr (struct Lisp_User_Ptr *p)
{
if (p->finalizer)
p->finalizer (p->p);
}
#ifdef HAVE_TREE_SITTER
static void
finalize_ts_parser (struct Lisp_TS_Parser *p)
{
treesit_delete_parser (p);
}
static void
finalize_ts_query (struct Lisp_TS_Query *q)
{
treesit_delete_query (q);
}
#endif /* HAVE_TREE_SITTER */
#ifdef HAVE_MODULES
static void
finalize_module_function (struct Lisp_Module_Function *f)
{
module_finalize_function (f);
}
#endif
#ifdef HAVE_NATIVE_COMP
static void
finalize_comp_unit (struct Lisp_Native_Comp_Unit *u)
{
unload_comp_unit (u);
u->data_eph_relocs = NULL;
u->data_imp_relocs = NULL;
u->data_relocs = NULL;
u->comp_unit = NULL;
}
static void
finalize_subr (struct Lisp_Subr *subr)
{
if (!NILP (subr->native_comp_u))
{
subr->native_comp_u = Qnil;
xfree ((char *) subr->symbol_name);
xfree (subr->native_c_name);
}
}
#endif
static Lisp_Object
finalizer_handler (Lisp_Object args)
{
add_to_log ("finalizer failed: %S", args);
return Qnil;
}
static void
finalize_finalizer (struct Lisp_Finalizer *f)
{
Lisp_Object fun = f->function;
if (!NILP (fun))
{
f->function = Qnil;
unchain_finalizer (f);
specpdl_ref count = SPECPDL_INDEX ();
++number_finalizers_run;
specbind (Qinhibit_quit, Qt);
internal_condition_case_1 (call0, fun, Qt, finalizer_handler);
unbind_to (count, Qnil);
}
}
static void
finalize_vector (mps_addr_t v)
{
switch (pseudo_vector_type (v))
{
case PVEC_FREE:
emacs_abort ();
case PVEC_BIGNUM:
finalize_bignum (v);
break;
case PVEC_FONT:
finalize_font (v);
break;
case PVEC_THREAD:
finalize_one_thread (v);
break;
case PVEC_MUTEX:
finalize_one_mutex (v);
break;
case PVEC_CONDVAR:
finalize_one_condvar (v);
break;
case PVEC_USER_PTR:
finalize_user_ptr (v);
break;
case PVEC_TS_PARSER:
#ifdef HAVE_TREE_SITTER
finalize_ts_parser (v);
#endif
break;
case PVEC_TS_COMPILED_QUERY:
#ifdef HAVE_TREE_SITTER
finalize_ts_query (v);
#endif
break;
case PVEC_MODULE_FUNCTION:
#ifdef HAVE_MODULES
finalize_module_function (v);
#endif
break;
case PVEC_NATIVE_COMP_UNIT:
#ifdef HAVE_NATIVE_COMP
finalize_comp_unit (v);
#endif
break;
case PVEC_SUBR:
#ifdef HAVE_NATIVE_COMP
finalize_subr (v);
#endif
break;
case PVEC_FINALIZER:
finalize_finalizer (v);
break;
#ifndef IN_MY_FORK
case PVEC_OBARRAY:
#endif
case PVEC_HASH_TABLE:
case PVEC_SYMBOL_WITH_POS:
case PVEC_PROCESS:
case PVEC_RECORD:
case PVEC_CLOSURE:
case PVEC_SQLITE:
case PVEC_TS_NODE:
case PVEC_NORMAL_VECTOR:
#ifdef IN_MY_FORK
case PVEC_PACKAGE:
#endif
case PVEC_WINDOW_CONFIGURATION:
case PVEC_BUFFER:
case PVEC_FRAME:
case PVEC_WINDOW:
case PVEC_CHAR_TABLE:
case PVEC_SUB_CHAR_TABLE:
case PVEC_BOOL_VECTOR:
case PVEC_OVERLAY:
case PVEC_OTHER:
case PVEC_MISC_PTR:
case PVEC_XWIDGET:
case PVEC_XWIDGET_VIEW:
case PVEC_TERMINAL:
case PVEC_MARKER:
case PVEC_MODULE_GLOBAL_REFERENCE:
igc_assert (!"finalization not implemented");
break;
}
}
static void
finalize (struct igc *gc, mps_addr_t base)
{
mps_addr_t client = base_to_client (base);
struct igc_header *h = base;
switch (h->obj_type)
{
case IGC_OBJ_INVALID:
case IGC_OBJ_PAD:
case IGC_OBJ_FWD:
case IGC_OBJ_BUILTIN_SYMBOL:
case IGC_OBJ_BUILTIN_THREAD:
case IGC_OBJ_BUILTIN_SUBR:
case IGC_OBJ_DUMPED_CHARSET_TABLE:
case IGC_OBJ_DUMPED_CODE_SPACE_MASKS:
case IGC_OBJ_DUMPED_BUFFER_TEXT:
case IGC_OBJ_DUMPED_BIGNUM_DATA:
case IGC_OBJ_DUMPED_BYTES:
case IGC_OBJ_BYTES:
case IGC_OBJ_NUM_TYPES:
emacs_abort ();
case IGC_OBJ_CONS:
case IGC_OBJ_SYMBOL:
case IGC_OBJ_INTERVAL:
case IGC_OBJ_STRING:
case IGC_OBJ_STRING_DATA:
case IGC_OBJ_ITREE_TREE:
case IGC_OBJ_ITREE_NODE:
case IGC_OBJ_IMAGE:
case IGC_OBJ_IMAGE_CACHE:
case IGC_OBJ_FACE:
case IGC_OBJ_FACE_CACHE:
case IGC_OBJ_FLOAT:
case IGC_OBJ_BLV:
case IGC_OBJ_PTR_VEC:
case IGC_OBJ_OBJ_VEC:
case IGC_OBJ_HASH_VEC:
case IGC_OBJ_HANDLER:
igc_assert (!"finalize not implemented");
break;
case IGC_OBJ_VECTOR:
case IGC_OBJ_VECTOR_WEAK:
finalize_vector (client);
break;
}
}
static void
maybe_finalize (mps_addr_t client, enum pvec_type tag)
{
mps_addr_t ref = client_to_base (client);
switch (tag)
{
case PVEC_BIGNUM:
case PVEC_FONT:
case PVEC_THREAD:
case PVEC_MUTEX:
case PVEC_CONDVAR:
case PVEC_USER_PTR:
case PVEC_TS_PARSER:
case PVEC_TS_COMPILED_QUERY:
case PVEC_MODULE_FUNCTION:
case PVEC_NATIVE_COMP_UNIT:
case PVEC_SUBR:
case PVEC_FINALIZER:
mps_finalize (global_igc->arena, &ref);
break;
#ifndef IN_MY_FORK
case PVEC_OBARRAY:
#endif
case PVEC_HASH_TABLE:
case PVEC_NORMAL_VECTOR:
case PVEC_FREE:
case PVEC_MARKER:
case PVEC_OVERLAY:
case PVEC_SYMBOL_WITH_POS:
case PVEC_MISC_PTR:
case PVEC_PROCESS:
case PVEC_FRAME:
case PVEC_WINDOW:
case PVEC_BOOL_VECTOR:
case PVEC_BUFFER:
case PVEC_TERMINAL:
case PVEC_XWIDGET:
case PVEC_XWIDGET_VIEW:
case PVEC_OTHER:
case PVEC_WINDOW_CONFIGURATION:
case PVEC_TS_NODE:
case PVEC_SQLITE:
case PVEC_CLOSURE:
case PVEC_CHAR_TABLE:
case PVEC_SUB_CHAR_TABLE:
case PVEC_RECORD:
#ifdef IN_MY_FORK
case PVEC_PACKAGE:
#endif
case PVEC_MODULE_GLOBAL_REFERENCE:
break;
}
}
struct igc_clock
{
mps_clock_t expire;
};
static bool
clock_has_expired (struct igc_clock *clock)
{
return mps_clock () > clock->expire;
}
static struct igc_clock
make_clock (double secs)
{
/* FIXME/igc: what does this do on 32-bit systems? */
mps_clock_t per_sec = mps_clocks_per_sec ();
mps_clock_t expire = mps_clock () + secs * per_sec;
return (struct igc_clock) { .expire = expire };
}
#define IGC_WITH_CLOCK(c, duration) \
for (struct igc_clock c = make_clock (duration); !clock_has_expired (&c);)
/* Process MPS messages. This should be extended to handle messages only
for a certain amount of time. See mps_clock_t, mps_clock, and
mps_clocks_per_sec functions. */
static bool
process_one_message (struct igc *gc)
{
mps_message_t msg;
if (mps_message_get (&msg, gc->arena, mps_message_type_finalization ()))
{
mps_addr_t base_addr;
mps_message_finalization_ref (&base_addr, gc->arena, msg);
finalize (gc, base_addr);
}
else if (mps_message_get (&msg, gc->arena, mps_message_type_gc_start ()))
{
if (garbage_collection_messages)
{
message1 ("Garbage collecting...");
const char *why = mps_message_gc_start_why (gc->arena, msg);
message1 (why);
}
}
else
return false;
mps_message_discard (gc->arena, msg);
return true;
}
static void
enable_messages (struct igc *gc, bool enable)
{
void (*fun) (mps_arena_t, mps_message_type_t)
= enable ? mps_message_type_enable : mps_message_type_disable;
fun (gc->arena, mps_message_type_finalization ());
fun (gc->arena, mps_message_type_gc_start ());
}
void
igc_process_messages (void)
{
IGC_WITH_CLOCK (clock, 0.1)
{
if (!process_one_message (global_igc))
break;
}
}
/* Discard entries for killed buffers from LIST and return the resulting
list. Used in window-{next,prev}-buffers. */
Lisp_Object
igc_discard_killed_buffers (Lisp_Object list)
{
Lisp_Object *prev = &list;
for (Lisp_Object tail = list; CONSP (tail); tail = XCDR (tail))
{
Lisp_Object buf = XCAR (tail);
if (CONSP (buf))
buf = XCAR (buf);
if (BUFFERP (buf) && !BUFFER_LIVE_P (XBUFFER (buf)))
*prev = XCDR (tail);
else
prev = xcdr_addr (tail);
}
return list;
}
struct igc_buffer_it
{
Lisp_Object alist;
Lisp_Object buf;
};
static struct igc_buffer_it
make_buffer_it (void)
{
return (struct igc_buffer_it) { .alist = Vbuffer_alist, .buf = Qnil };
}
static bool
is_buffer_it_valid (struct igc_buffer_it *it)
{
if (!CONSP (it->alist))
return false;
Lisp_Object elt = XCAR (it->alist);
igc_assert (CONSP (elt));
it->buf = XCDR (elt);
return true;
}
static void
buffer_it_next (struct igc_buffer_it *it)
{
igc_assert (CONSP (it->alist));
it->alist = XCDR (it->alist);
it->buf = Qnil;
}
static bool
arena_step (void)
{
/* mps_arena_step does not guarantee to return swiftly. And it seems
that it sometimes does an opportunistic full collection alledging
the client predicted lots of idle time. But it doesn't tell how
it comes to that conclusioin. */
if (!FIXNUMP (Vigc_step_interval)
|| XFIXNUM (Vigc_step_interval) != 0)
{
double interval = 0;
if (NUMBERP (Vigc_step_interval))
{
interval = XFLOATINT (Vigc_step_interval);
if (interval < 0)
interval = 0.05;
}
if (mps_arena_step (global_igc->arena, interval, 0))
return true;
}
return false;
}
static bool
buffer_step (struct igc_buffer_it *it)
{
if (is_buffer_it_valid (it))
{
Lisp_Object buf = it->buf;
buffer_it_next (it);
compact_buffer (XBUFFER (buf));
return true;
}
return false;
}
void
igc_on_idle (void)
{
struct igc_buffer_it buffer_it = make_buffer_it ();
IGC_WITH_CLOCK (clock, 0.1)
{
bool work_done = false;
switch (igc_state)
{
case IGC_STATE_INITIAL:
case IGC_STATE_DEAD:
return;
case IGC_STATE_USABLE:
work_done |= process_one_message (global_igc);
work_done |= buffer_step (&buffer_it);
work_done |= arena_step ();
break;
}
/* Don't always exhaust the max time we want to spend here. */
if (!work_done)
break;
}
}
static mps_ap_t
thread_ap (enum igc_obj_type type)
{
struct igc_thread_list *t = current_thread->gc_info;
switch (type)
{
case IGC_OBJ_INVALID:
case IGC_OBJ_PAD:
case IGC_OBJ_FWD:
case IGC_OBJ_BUILTIN_SYMBOL:
case IGC_OBJ_BUILTIN_THREAD:
case IGC_OBJ_BUILTIN_SUBR:
case IGC_OBJ_DUMPED_CHARSET_TABLE:
case IGC_OBJ_DUMPED_CODE_SPACE_MASKS:
case IGC_OBJ_DUMPED_BUFFER_TEXT:
case IGC_OBJ_DUMPED_BIGNUM_DATA:
case IGC_OBJ_DUMPED_BYTES:
case IGC_OBJ_NUM_TYPES:
emacs_abort ();
case IGC_OBJ_VECTOR_WEAK:
return t->d.weak_weak_ap;
case IGC_OBJ_WEAK_HASH_TABLE_WEAK_PART:
return t->d.weak_hash_weak_ap;
case IGC_OBJ_WEAK_HASH_TABLE_STRONG_PART:
return t->d.weak_hash_strong_ap;
case IGC_OBJ_VECTOR:
case IGC_OBJ_CONS:
case IGC_OBJ_SYMBOL:
case IGC_OBJ_INTERVAL:
case IGC_OBJ_STRING:
case IGC_OBJ_ITREE_TREE:
case IGC_OBJ_ITREE_NODE:
case IGC_OBJ_IMAGE:
case IGC_OBJ_IMAGE_CACHE:
case IGC_OBJ_FACE:
case IGC_OBJ_FACE_CACHE:
case IGC_OBJ_BLV:
case IGC_OBJ_PTR_VEC:
case IGC_OBJ_OBJ_VEC:
case IGC_OBJ_HASH_VEC:
case IGC_OBJ_HANDLER:
return t->d.dflt_ap;
case IGC_OBJ_STRING_DATA:
case IGC_OBJ_FLOAT:
case IGC_OBJ_BYTES:
return t->d.leaf_ap;
}
emacs_abort ();
}
/* Conditional breakpoints can be so slow that it is often more
effective to instrument code. This function is for such cases. */
void
igc_break (void)
{
}
void
igc_collect (void)
{
struct igc *gc = global_igc;
if (gc->park_count == 0)
{
mps_arena_collect (gc->arena);
mps_arena_release (gc->arena);
}
}
DEFUN ("igc--collect", Figc__collect, Sigc__collect, 0, 0, 0, doc
: /* */)
(void)
{
igc_collect ();
return Qnil;
}
size_t
igc_hash (Lisp_Object key)
{
mps_word_t word = XLI (key);
mps_word_t tag = word & IGC_TAG_MASK;
mps_addr_t client = NULL;
switch (tag)
{
case Lisp_Type_Unused0:
emacs_abort ();
case Lisp_Int0:
case Lisp_Int1:
return word;
case Lisp_Symbol:
{
ptrdiff_t off = word ^ tag;
client = (mps_addr_t) ((char *) lispsym + off);
}
break;
case Lisp_String:
case Lisp_Vectorlike:
case Lisp_Cons:
case Lisp_Float:
client = (mps_addr_t) (word ^ tag);
break;
}
/* Objects in the The dump have igc_headers, too. */
if (has_header (client, tag == Lisp_Vectorlike))
{
// The following assertion is very expensive.
// igc_assert (mps_arena_has_addr (global_igc->arena, client));
struct igc_header *h = client_to_base (client);
return h->hash;
}
/* Use a hash that would fit into igc_header::hash so that we
can keep the hash once a non-MPS object is copied to MPS. */
return word & IGC_HASH_MASK;
}
/* Allocate an object of client size SIZE and of type TYPE from
allocation point AP. Value is a pointer to the client area of the new
object. */
static mps_addr_t
alloc_impl (size_t size, enum igc_obj_type type, mps_ap_t ap)
{
mps_addr_t p UNINIT;
size = alloc_size (size);
switch (igc_state)
{
case IGC_STATE_USABLE:
do
{
mps_res_t res = mps_reserve (&p, ap, size);
if (res != MPS_RES_OK)
memory_full (0);
/* Object _must_ have valid contents before commit. */
memclear (p, size);
set_header (p, type, size, alloc_hash ());
}
while (!mps_commit (ap, p, size));
break;
case IGC_STATE_DEAD:
p = xzalloc (size);
set_header (p, type, size, alloc_hash ());
break;
case IGC_STATE_INITIAL:
emacs_abort ();
}
return base_to_client (p);
}
/* Allocate an object of client size SIZE and of type TYPE from a
type-dependent allocation point. Value is a pointer to the client
area of the new object. */
static mps_addr_t
alloc (size_t size, enum igc_obj_type type)
{
return alloc_impl (size, type, thread_ap (type));
}
/* Allocate an object of client size SIZE and of type TYPE from MPS in a
way tnat ensure that the object will not move in memory. Value is a
pointer to the client area of the new object. */
static mps_addr_t
alloc_immovable (size_t size, enum igc_obj_type type)
{
struct igc_thread_list *t = current_thread->gc_info;
return alloc_impl (size, type, t->d.immovable_ap);
}
void *
igc_alloc_global_ref (void)
{
size_t nwords_mem = VECSIZE (struct module_global_reference);
struct Lisp_Vector *v
= alloc_immovable (header_size + nwords_mem * word_size, IGC_OBJ_VECTOR);
XSETPVECTYPESIZE (v, PVEC_MODULE_GLOBAL_REFERENCE, 0, nwords_mem);
return v;
}
Lisp_Object
igc_make_cons (Lisp_Object car, Lisp_Object cdr)
{
struct Lisp_Cons *cons = alloc (sizeof *cons, IGC_OBJ_CONS);
cons->u.s.car = car;
cons->u.s.u.cdr = cdr;
return make_lisp_ptr (cons, Lisp_Cons);
}
Lisp_Object
igc_alloc_symbol (void)
{
struct Lisp_Symbol *sym = alloc (sizeof *sym, IGC_OBJ_SYMBOL);
return make_lisp_symbol (sym);
}
Lisp_Object
igc_make_float (double val)
{
struct Lisp_Float *f = alloc (sizeof *f, IGC_OBJ_FLOAT);
f->u.data = val;
return make_lisp_ptr (f, Lisp_Float);
}
static unsigned char *
alloc_string_data (size_t nbytes, bool clear)
{
unsigned char *data = alloc (nbytes + 1, IGC_OBJ_STRING_DATA);
data[nbytes] = 0;
return data;
}
void *
igc_alloc_bytes (size_t nbytes)
{
return alloc (nbytes, IGC_OBJ_BYTES);
}
/* Reallocate multibyte STRING data when a single character is
replaced. The character is at byte offset BYTE_POS in the string.
The character being replaced is CHAR_LEN bytes long, and the
character that will replace it is NEW_CLEN bytes long. Return the
address where the caller should store the new character. */
unsigned char *
igc_replace_char (Lisp_Object string, ptrdiff_t at_byte_pos,
ptrdiff_t old_char_len, ptrdiff_t new_char_len)
{
struct Lisp_String *s = XSTRING (string);
// Replacing caaracters of the same length.
if (old_char_len == new_char_len)
return s->u.s.data + at_byte_pos;
ptrdiff_t old_nbytes = SBYTES (string);
ptrdiff_t nbytes_needed = old_nbytes + (new_char_len - old_char_len);
struct igc_header *old_header = client_to_base (s->u.s.data);
/* The capacity is the number of bytes the client has available,
including the terminating NUL byte. Sizes computed from Lisp
strings don't include the NUL. That's the 1 in the if. */
ptrdiff_t capacity = obj_client_size (old_header);
if (capacity < nbytes_needed + 1)
{
unsigned char *new_data = alloc_string_data (nbytes_needed, false);
memcpy (new_data, SDATA (string), old_nbytes + 1);
s->u.s.data = new_data;
}
/* Set up string as if the character had been inserted. */
s->u.s.size_byte = nbytes_needed;
unsigned char *insertion_addr = s->u.s.data + at_byte_pos;
/* Need to move the rest of the string after the insertion point
(old_nbytes - at_bytespos), but not the old char itself (-
old_char_len), but do include the NUL at the end (+ 1). */
ptrdiff_t nbytes_to_move = old_nbytes - at_byte_pos - old_char_len + 1;
memmove (insertion_addr + new_char_len, insertion_addr + old_char_len,
nbytes_to_move);
return insertion_addr;
}
Lisp_Object
igc_make_string (size_t nchars, size_t nbytes, bool unibyte, bool clear)
{
struct Lisp_String *s = alloc (sizeof *s, IGC_OBJ_STRING);
s->u.s.size = nchars;
s->u.s.size_byte = unibyte ? -1 : nbytes;
s->u.s.data = alloc_string_data (nbytes, clear);
return make_lisp_ptr (s, Lisp_String);
}
Lisp_Object
igc_make_multibyte_string (size_t nchars, size_t nbytes, bool clear)
{
return igc_make_string (nchars, nbytes, false, clear);
}
Lisp_Object
igc_make_unibyte_string (size_t nchars, size_t nbytes, bool clear)
{
return igc_make_string (nchars, nbytes, true, clear);
}
struct interval *
igc_make_interval (void)
{
return alloc (sizeof (struct interval), IGC_OBJ_INTERVAL);
}
struct Lisp_Vector *
igc_alloc_pseudovector (size_t nwords_mem, size_t nwords_lisp,
size_t nwords_zero, enum pvec_type tag)
{
/* header_size comes from lisp.h. */
size_t client_size = header_size + nwords_mem * sizeof (Lisp_Object);
struct Lisp_Vector *v;
if (tag == PVEC_THREAD)
{
/* Alloc thread_state immovable because we need access to it for
scanning the bytecode stack (scan_bc), and making thread_state
immovable simplifies the code. */
v = alloc_immovable (client_size, IGC_OBJ_VECTOR);
}
else
v = alloc (client_size, IGC_OBJ_VECTOR);
XSETPVECTYPESIZE (v, tag, nwords_lisp, nwords_mem - nwords_lisp);
maybe_finalize (v, tag);
return v;
}
struct Lisp_Vector *
igc_alloc_vector (ptrdiff_t len)
{
struct Lisp_Vector *v
= alloc (header_size + len * word_size, IGC_OBJ_VECTOR);
v->header.size = len;
return v;
}
struct Lisp_Vector *
igc_alloc_record (ptrdiff_t len)
{
struct Lisp_Vector *v
= alloc (header_size + len * word_size, IGC_OBJ_VECTOR);
v->header.size = len;
XSETPVECTYPE (v, PVEC_RECORD);
return v;
}
struct itree_tree *
igc_make_itree_tree (void)
{
struct itree_tree *t = alloc (sizeof *t, IGC_OBJ_ITREE_TREE);
return t;
}
struct itree_node *
igc_make_itree_node (void)
{
struct itree_node *n = alloc (sizeof *n, IGC_OBJ_ITREE_NODE);
return n;
}
#ifdef HAVE_WINDOW_SYSTEM
struct image *
igc_make_image (void)
{
struct image *img = alloc (sizeof *img, IGC_OBJ_IMAGE);
return img;
}
#endif
struct face *
igc_make_face (void)
{
struct face *face = alloc (sizeof *face, IGC_OBJ_FACE);
return face;
}
struct face_cache *
igc_make_face_cache (void)
{
struct face_cache *c = alloc (sizeof *c, IGC_OBJ_FACE_CACHE);
return c;
}
void *
igc_make_ptr_vec (size_t n)
{
return alloc (n * sizeof (void *), IGC_OBJ_PTR_VEC);
}
/* Allocate a Lisp_Object vector with N elements.
Currently only used by SAFE_ALLOCA_LISP. */
Lisp_Object *
igc_alloc_lisp_obj_vec (size_t n)
{
return alloc (n * sizeof (Lisp_Object), IGC_OBJ_OBJ_VEC);
}
Lisp_Object *
igc_make_hash_table_vec (size_t n, bool weak)
{
if (weak)
return alloc (n * sizeof (Lisp_Object), IGC_OBJ_HASH_VEC_WEAK);
return alloc (n * sizeof (Lisp_Object), IGC_OBJ_HASH_VEC);
}
struct Lisp_Weak_Hash_Table_Strong_Part *
igc_alloc_weak_hash_table_strong_part (hash_table_weakness_t weak, size_t size, size_t index_bits)
{
return alloc (sizeof (struct Lisp_Weak_Hash_Table_Strong_Part) + 5 * size * sizeof (union Lisp_Weak_Hash_Table_Entry),
IGC_OBJ_WEAK_HASH_TABLE_STRONG_PART);
}
struct Lisp_Weak_Hash_Table_Weak_Part *
igc_alloc_weak_hash_table_weak_part (hash_table_weakness_t weak, size_t size, size_t index_bits)
{
return alloc (sizeof (struct Lisp_Weak_Hash_Table_Weak_Part) + 5 * size * sizeof (union Lisp_Weak_Hash_Table_Entry),
IGC_OBJ_WEAK_HASH_TABLE_WEAK_PART);
}
/* Like xpalloc, but uses 'alloc' instead of xrealloc, and should only
be used for growing a vector of pointers whose current size is N
pointers. */
void *
igc_grow_ptr_vec (void *v, ptrdiff_t *n, ptrdiff_t n_incr_min, ptrdiff_t n_max)
{
const ptrdiff_t min_items = 16;
ptrdiff_t nitems0 = *n;
ptrdiff_t half_nitems0 = nitems0 / 2;
ptrdiff_t max_items = n_max < 0 ? PTRDIFF_MAX : n_max;
ptrdiff_t new_nitems;
if (half_nitems0 < n_incr_min)
half_nitems0 = n_incr_min;
if (nitems0 < min_items)
new_nitems = min_items;
else if (nitems0 < max_items - half_nitems0)
new_nitems = nitems0 + half_nitems0;
else
new_nitems = max_items;
if (new_nitems <= nitems0)
memory_full (0);
void *new_vec = igc_make_ptr_vec (new_nitems);
igc_assert (*n <= new_nitems);
igc_assert (new_nitems < PTRDIFF_MAX);
memcpy (new_vec, v, *n * sizeof (void *));
*n = new_nitems;
return new_vec;
}
#ifdef HAVE_WINDOW_SYSTEM
struct image_cache *
igc_make_image_cache (void)
{
struct image_cache *c = alloc (sizeof *c, IGC_OBJ_IMAGE_CACHE);
return c;
}
#endif
struct Lisp_Buffer_Local_Value *
igc_alloc_blv (void)
{
struct Lisp_Buffer_Local_Value *blv
= alloc (sizeof *blv, IGC_OBJ_BLV);
return blv;
}
void *
igc_alloc_handler (void)
{
struct handler *h = alloc (sizeof *h, IGC_OBJ_HANDLER);
return h;
}
int
igc_valid_lisp_object_p (Lisp_Object obj)
{
return 1;
}
static Lisp_Object
alloc_vector_weak (ptrdiff_t len, Lisp_Object init)
{
struct Lisp_Vector *v
= alloc (header_size + len * word_size, IGC_OBJ_VECTOR_WEAK);
v->header.size = len;
for (ptrdiff_t i = 0; i < len; ++i)
v->contents[i] = init;
return make_lisp_ptr (v, Lisp_Vectorlike);
}
static Lisp_Object
larger_vector_weak (Lisp_Object v)
{
ptrdiff_t new_len = 2 * ASIZE (v);
Lisp_Object new_v = alloc_vector_weak (new_len, Qnil);
for (ptrdiff_t i = 0; i < ASIZE (v); ++i)
ASET (new_v, i, AREF (v, i));
return new_v;
}
static ptrdiff_t
find_nil_index (Lisp_Object v)
{
for (ptrdiff_t i = 0; i < ASIZE (v); ++i)
if (NILP (AREF (v, i)))
return i;
return ASIZE (v);
}
void
igc_add_marker (struct buffer *b, struct Lisp_Marker *m)
{
Lisp_Object v = BUF_MARKERS (b);
if (NILP (v))
v = BUF_MARKERS (b) = alloc_vector_weak (1, Qnil);
ptrdiff_t i = find_nil_index (v);
if (i == ASIZE (v))
v = BUF_MARKERS (b) = larger_vector_weak (v);
Lisp_Object marker = make_lisp_ptr (m, Lisp_Vectorlike);
ASET (v, i, marker);
m->index = i;
}
void
igc_remove_marker (struct buffer *b, struct Lisp_Marker *m)
{
Lisp_Object v = BUF_MARKERS (b);
igc_assert (VECTORP (v));
igc_assert (m->index >= 0 && m->index < ASIZE (v));
ASET (v, m->index, Qnil);
m->buffer = NULL;
m->index = -1;
}
void
igc_remove_all_markers (struct buffer *b)
{
Lisp_Object v = BUF_MARKERS (b);
if (VECTORP (v))
{
for (ptrdiff_t i = 0; i < ASIZE (v); ++i)
{
Lisp_Object m = AREF (v, i);
if (MARKERP (m))
{
XMARKER (m)->buffer = NULL;
ASET (v, i, Qnil);
}
}
}
}
#ifdef IGC_DEBUG
static bool
weak_vector_p (Lisp_Object x)
{
if (VECTORP (x))
{
struct igc *igc = global_igc;
mps_pool_t pool = NULL;
mps_addr_pool (&pool, igc->arena, XVECTOR (x));
return pool == igc->weak_pool;
}
else
return false;
}
#endif
void
igc_resurrect_markers (struct buffer *b)
{
Lisp_Object old = BUF_MARKERS (b);
if (NILP (old))
return;
igc_assert (!weak_vector_p (old));
size_t len = ASIZE (old);
Lisp_Object new = alloc_vector_weak (len, Qnil);
memcpy (XVECTOR (new)->contents, XVECTOR (old)->contents,
len * sizeof (Lisp_Object));
BUF_MARKERS (b) = new;
igc_assert (weak_vector_p (BUF_MARKERS (b)));
}
DEFUN ("igc-make-weak-vector", Figc_make_weak_vector, Sigc_make_weak_vector, 2, 2, 0,
doc: /* Return a new weak vector of length LENGTH, with each element being INIT.
See also the function `vector'. */)
(Lisp_Object length, Lisp_Object init)
{
CHECK_TYPE (FIXNATP (length) && XFIXNAT (length) <= PTRDIFF_MAX,
Qwholenump, length);
return alloc_vector_weak (XFIXNAT (length), init);
}
static void
walk_pool (struct igc *gc, mps_pool_t p, struct igc_stats *st)
{
mps_res_t res;
IGC_WITH_PARKED (gc)
res = mps_pool_walk (p, dflt_scanx, st);
if (res != MPS_RES_OK)
error ("Error %d walking memory", res);
}
DEFUN ("igc-info", Figc_info, Sigc_info, 0, 0, 0, doc : /* */)
(void)
{
struct igc *gc = global_igc;
struct igc_stats st = { 0 };
walk_pool (gc, gc->dflt_pool, &st);
walk_pool (gc, gc->leaf_pool, &st);
walk_pool (gc, gc->weak_pool, &st);
walk_pool (gc, gc->immovable_pool, &st);
Lisp_Object result = Qnil;
for (int i = 0; i < IGC_OBJ_NUM_TYPES; ++i)
{
Lisp_Object e
= list3 (build_string (obj_type_name (i)),
make_int (st.obj[i].nobjs), make_int (st.obj[i].nbytes));
result = Fcons (e, result);
}
for (enum pvec_type i = 0; i <= PVEC_TAG_MAX; i++)
{
Lisp_Object e
= list3 (build_string (pvec_type_name (i)),
make_int (st.pvec[i].nobjs), make_int (st.pvec[i].nbytes));
result = Fcons (e, result);
}
result = Fcons (list2 (build_string ("pause-time"),
make_float (mps_arena_pause_time (gc->arena))),
result);
result = Fcons (list2 (build_string ("reserved"),
make_int (mps_arena_reserved (gc->arena))),
result);
result = Fcons (list2 (build_string ("spare"),
make_float (mps_arena_spare (gc->arena))),
result);
result = Fcons (list2 (build_string ("spare-committed"),
make_int (mps_arena_spare_committed (gc->arena))),
result);
result = Fcons (list2 (build_string ("commit-limit"),
make_int (mps_arena_commit_limit (gc->arena))),
result);
result = Fcons (list2 (build_string ("committed"),
make_int (mps_arena_committed (gc->arena))),
result);
return result;
}
DEFUN ("igc--roots", Figc__roots, Sigc__roots, 0, 0, 0, doc : /* */)
(void)
{
struct igc *gc = global_igc;
Lisp_Object roots = Qnil;
for (igc_root_list *r = gc->roots; r; r = r->next)
{
Lisp_Object type = r->d.ambig ? Qambig : Qexact;
Lisp_Object label = r->d.label ? build_string (r->d.label) : Qnil;
Lisp_Object e = list4 (label, type, make_int ((uintptr_t) r->d.start),
r->d.end ? make_int ((uintptr_t) r->d.end) : Qnil);
roots = Fcons (e, roots);
}
return roots;
}
static void
make_arena (struct igc *gc)
{
mps_res_t res;
MPS_ARGS_BEGIN (args)
{
res = mps_arena_create_k (&gc->arena, mps_arena_class_vm (), args);
}
MPS_ARGS_END (args);
IGC_CHECK_RES (res);
mps_gen_param_s gens[] = { { 128000, 0.8 }, { 5 * 128000, 0.4 } };
res = mps_chain_create (&gc->chain, gc->arena, ARRAYELTS (gens), gens);
IGC_CHECK_RES (res);
}
static mps_fmt_t
make_dflt_fmt (struct igc *gc)
{
mps_res_t res;
mps_fmt_t fmt;
MPS_ARGS_BEGIN (args)
{
MPS_ARGS_ADD (args, MPS_KEY_FMT_ALIGN, IGC_ALIGN);
/* Don't use in-band headers. I suspect they ahve problems,
specifically amcSegScanNailedRange calls NailboardGet with a
client address, which calls NailboardGet, and one can see that
the the board contains base addresses which leads to an assertion
failure. */
MPS_ARGS_ADD (args, MPS_KEY_FMT_HEADER_SIZE, 0);
MPS_ARGS_ADD (args, MPS_KEY_FMT_SCAN, dflt_scan);
MPS_ARGS_ADD (args, MPS_KEY_FMT_SKIP, dflt_skip);
MPS_ARGS_ADD (args, MPS_KEY_FMT_FWD, dflt_fwd);
MPS_ARGS_ADD (args, MPS_KEY_FMT_ISFWD, is_dflt_fwd);
MPS_ARGS_ADD (args, MPS_KEY_FMT_PAD, dflt_pad);
res = mps_fmt_create_k (&fmt, gc->arena, args);
}
MPS_ARGS_END (args);
IGC_CHECK_RES (res);
return fmt;
}
static mps_pool_t
make_pool_with_class (struct igc *gc, mps_fmt_t fmt, mps_class_t cls)
{
mps_res_t res;
mps_pool_t pool;
MPS_ARGS_BEGIN (args)
{
MPS_ARGS_ADD (args, MPS_KEY_FORMAT, fmt);
MPS_ARGS_ADD (args, MPS_KEY_CHAIN, gc->chain);
MPS_ARGS_ADD (args, MPS_KEY_INTERIOR, true);
res = mps_pool_create_k (&pool, gc->arena, cls, args);
}
MPS_ARGS_END (args);
IGC_CHECK_RES (res);
return pool;
}
static mps_pool_t
make_pool_amc (struct igc *gc, mps_fmt_t fmt)
{
return make_pool_with_class (gc, fmt, mps_class_amc ());
}
static mps_pool_t
make_pool_ams (struct igc *gc, mps_fmt_t fmt)
{
return make_pool_with_class (gc, fmt, mps_class_ams ());
}
static mps_pool_t
make_pool_awl (struct igc *gc, mps_fmt_t fmt)
{
return make_pool_with_class (gc, fmt, mps_class_awl ());
}
static mps_pool_t
make_pool_amcz (struct igc *gc, mps_fmt_t fmt)
{
return make_pool_with_class (gc, fmt, mps_class_amcz ());
}
static struct igc *
make_igc (void)
{
struct igc *gc = xzalloc (sizeof *gc);
make_arena (gc);
/* We cannot let the GC run until at least all staticpros haven been
processed. Otherwise we might allocate objects that are not
protected by anything. */
arena_park (gc);
gc->dflt_fmt = make_dflt_fmt (gc);
gc->dflt_pool = make_pool_amc (gc, gc->dflt_fmt);
gc->leaf_fmt = make_dflt_fmt (gc);
gc->leaf_pool = make_pool_amcz (gc, gc->leaf_fmt);
gc->weak_fmt = make_dflt_fmt (gc);
gc->weak_pool = make_pool_awl (gc, gc->weak_fmt);
gc->weak_hash_fmt = make_dflt_fmt (gc);
gc->weak_hash_pool = make_pool_awl (gc, gc->weak_hash_fmt);
gc->immovable_fmt = make_dflt_fmt (gc);
gc->immovable_pool = make_pool_ams (gc, gc->immovable_fmt);
#ifndef IN_MY_FORK
root_create_pure (gc);
#endif
root_create_charset_table (gc);
root_create_buffer (gc, &buffer_defaults);
root_create_buffer (gc, &buffer_local_symbols);
root_create_staticvec (gc);
root_create_lispsym (gc);
root_create_terminal_list (gc);
root_create_tty_list (gc);
root_create_main_thread (gc);
root_create_exact_ptr (gc, ¤t_thread);
root_create_exact_ptr (gc, &all_threads);
enable_messages (gc, true);
return gc;
}
void
igc_begin_collecting (void)
{
struct igc *gc = global_igc;
arena_release (gc);
igc_assert (gc->park_count == 0);
}
/* To call from LLDB. */
void
igc_postmortem (void)
{
if (global_igc && global_igc->arena)
mps_arena_postmortem (global_igc->arena);
}
\f
/***********************************************************************
Dumping
***********************************************************************/
size_t
igc_header_size (void)
{
return sizeof (struct igc_header);
}
static enum igc_obj_type
builtin_obj_type_and_hash (size_t *hash, enum igc_obj_type type, void *client)
{
if (c_symbol_p (client))
{
*hash = igc_hash (make_lisp_symbol (client));
return IGC_OBJ_BUILTIN_SYMBOL;
}
if (client == &main_thread.s)
{
*hash = igc_hash (make_lisp_ptr (client, Lisp_Vectorlike));
return IGC_OBJ_BUILTIN_THREAD;
}
if (is_builtin_subr (type, client))
{
*hash = igc_hash (make_lisp_ptr (client, Lisp_Vectorlike));
return IGC_OBJ_BUILTIN_SUBR;
}
if (type == IGC_OBJ_DUMPED_CHARSET_TABLE
|| type == IGC_OBJ_DUMPED_CODE_SPACE_MASKS
|| type == IGC_OBJ_DUMPED_BUFFER_TEXT
|| type == IGC_OBJ_DUMPED_BIGNUM_DATA
|| type == IGC_OBJ_DUMPED_BYTES)
{
*hash = 0;
return type;
}
emacs_abort ();
}
static enum igc_obj_type
pure_obj_type_and_hash (size_t *hash_o, enum igc_obj_type type, void *client)
{
switch (type)
{
case IGC_OBJ_STRING:
*hash_o = igc_hash (make_lisp_ptr (client, Lisp_String));
return type;
case IGC_OBJ_VECTOR:
*hash_o = igc_hash (make_lisp_ptr (client, Lisp_Vectorlike));
return type;
case IGC_OBJ_CONS:
*hash_o = igc_hash (make_lisp_ptr (client, Lisp_Cons));
return type;
case IGC_OBJ_STRING_DATA:
*hash_o = (uintptr_t) client & IGC_HASH_MASK;
return type;
case IGC_OBJ_FLOAT:
*hash_o = igc_hash (make_lisp_ptr (client, Lisp_Float));
return type;
default:
IGC_NOT_IMPLEMENTED ();
emacs_abort ();
}
}
/* Called from the dumper at the end of dumping an object. This function
is responsible for filling out the igc_header of the dumped object.
CLIENT points to the object being dumped. TYPE is the type of objcect
the pdumper intends to write. BASE points to where in the dump CLIENT
has been written, i.e. it is a pointer to its header in the dump.
END is the current end of the object whose start is BASE. Value is
the address in the dump where the object should end which can be >=
end for alignment purposes. */
char *
igc_dump_finish_obj (void *client, enum igc_obj_type type,
char *base, char *end)
{
if (client == NULL)
return end;
bool is_in_dump;
switch (type)
{
case IGC_OBJ_DUMPED_CHARSET_TABLE:
case IGC_OBJ_DUMPED_CODE_SPACE_MASKS:
case IGC_OBJ_DUMPED_BUFFER_TEXT:
case IGC_OBJ_DUMPED_BIGNUM_DATA:
case IGC_OBJ_DUMPED_BYTES:
is_in_dump = true;
break;
default:
is_in_dump = false;
break;
}
struct igc_header *out = (struct igc_header *) base;
/* If the client object to be dumped has a header, copy that. */
if (has_header (client, type == IGC_OBJ_VECTOR)
&& !is_in_dump)
{
struct igc_header *h = client_to_base (client);
if (h->obj_type == IGC_OBJ_VECTOR_WEAK)
igc_assert ((type == IGC_OBJ_VECTOR && h->obj_type == IGC_OBJ_VECTOR_WEAK)
|| h->obj_type == type);
igc_assert (base + obj_size (h) >= end);
*out = *h;
return base + obj_size (h);
}
/* We are dumping some non-MPS object, e.g. a built-in symbol. */
size_t client_size = end - base - sizeof *out;
size_t nbytes = alloc_size (client_size);
size_t hash;
type = (is_pure (client)
? pure_obj_type_and_hash (&hash, type, client)
: builtin_obj_type_and_hash (&hash, type, client));
set_header (out, type, nbytes, hash);
return base + nbytes;
}
void
igc_dump_check_object_starts (Lisp_Object relocs, void *dump_base,
void *hot_start, void *hot_end,
void *cold_start, void *heap_end)
{
eassert (is_aligned (dump_base));
eassert (is_aligned (hot_start));
eassert (is_aligned (hot_end));
eassert (is_aligned (cold_start));
eassert (is_aligned (hot_end));
struct region
{
mps_addr_t start, end;
} regions[] = {
{hot_start, hot_end},
{cold_start, heap_end},
};
for (size_t i = 0; i < ARRAYELTS (regions); i++)
{
struct region region = regions[i];
mps_addr_t p = region.start;
while (p != region.end)
{
eassert (p < region.end);
Lisp_Object r = XCAR (relocs);
relocs = XCDR (relocs);
EMACS_INT start_off = XFIXNUM (XCAR (r));
EMACS_INT end_off = XFIXNUM (XCAR (XCDR (r)));
mps_addr_t start = (uint8_t *) dump_base + start_off;
mps_addr_t end = (uint8_t *) dump_base + end_off;
eassert (start == p);
p = dflt_skip (p);
eassert (end == p);
}
}
eassert (NILP (relocs));
}
static bool
check_dump (mps_addr_t start, mps_addr_t end)
{
struct pdumper_object_it it = { 0 };
for (mps_addr_t p = start; p != end; p = dflt_skip (p))
{
eassert (p < end);
struct igc_header *h = p;
if (h->obj_type != IGC_OBJ_PAD)
{
mps_addr_t obj = pdumper_next_object (&it);
eassert (p == obj);
}
}
eassert (pdumper_next_object (&it) == NULL);
return true;
}
static mps_addr_t pinned_objects_in_dump[3];
/* Called from pdumper_load. [HOT_START, HOT_END) is the hot section of
the dump. [COL_START, COLD_END) is the cold section of the
dump. COLD_USER_DATA_START is where actual object memory starts.
HEAP_END is the heap end as recorded in the dump header. */
void
igc_on_pdump_loaded (void *dump_base, void *hot_start, void *hot_end,
void *cold_start, void *cold_end,
void *cold_user_data_start, void *heap_end)
{
igc_assert (global_igc->park_count > 0);
igc_assert (base_to_client (hot_start) == charset_table);
igc_assert (((struct igc_header *) hot_start)->obj_type
== IGC_OBJ_DUMPED_CHARSET_TABLE);
igc_assert (((struct igc_header *) cold_start)->obj_type
== IGC_OBJ_DUMPED_CODE_SPACE_MASKS);
igc_assert (((struct igc_header *) cold_user_data_start)->obj_type
== IGC_OBJ_DUMPED_BYTES);
igc_assert (((struct igc_header *) heap_end)->obj_type
== IGC_OBJ_DUMPED_BYTES);
size_t discardable_size = (uint8_t *)cold_start - (uint8_t *)hot_end;
// size_t cold_size = (uint8_t *)cold_end - (uint8_t *)cold_start;
size_t dump_header_size = (uint8_t *)hot_start - (uint8_t *)dump_base;
size_t relocs_size = (uint8_t *)cold_end - (uint8_t *)heap_end;
struct igc_header *h = client_to_base (dump_base);
igc_assert (h->obj_type == IGC_OBJ_INVALID);
igc_assert (obj_size (h)
== sizeof *h + (uint8_t *)cold_end - (uint8_t *)dump_base);
igc_assert (discardable_size > 2 * sizeof *h);
/* Ignore dump_header */
set_header (h, IGC_OBJ_PAD, sizeof *h + dump_header_size, 0);
/* Ignore discardable section */
set_header (hot_end, IGC_OBJ_PAD, discardable_size, 0);
/* Ignore relocs */
set_header (heap_end, IGC_OBJ_PAD, relocs_size, 0);
eassert (check_dump (h, cold_end));
/* Pin some stuff in the dump */
mps_addr_t pinned_roots[] = {
charset_table,
base_to_client (cold_start), /* code_space_masks */
base_to_client (cold_user_data_start),
};
static_assert (sizeof pinned_roots == sizeof pinned_objects_in_dump);
memcpy (pinned_objects_in_dump, pinned_roots, sizeof pinned_roots);
igc_root_create_ambig (pinned_objects_in_dump,
(uint8_t *) pinned_objects_in_dump
+ sizeof pinned_objects_in_dump,
"dump-pins");
}
void *
igc_alloc_dump (size_t nbytes)
{
igc_assert (global_igc->park_count > 0);
mps_ap_t ap = thread_ap (IGC_OBJ_CONS);
size_t block_size = igc_header_size () + nbytes;
mps_addr_t block;
do
{
mps_res_t res = mps_reserve (&block, ap, block_size);
if (res != MPS_RES_OK)
memory_full (0);
set_header (block, IGC_OBJ_INVALID, block_size, 0);
}
while (!mps_commit (ap, block, block_size));
return base_to_client (block);
}
bool
igc_busy_p (void)
{
return mps_arena_busy (global_igc->arena);
}
/***********************************************************************
Init
***********************************************************************/
void
init_igc (void)
{
mps_lib_assert_fail_install (igc_assert_fail);
global_igc = make_igc ();
add_main_thread ();
set_state (IGC_STATE_USABLE);
}
void
syms_of_igc (void)
{
defsubr (&Sigc_info);
defsubr (&Sigc_make_weak_vector);
defsubr (&Sigc__roots);
defsubr (&Sigc__collect);
DEFSYM (Qambig, "ambig");
DEFSYM (Qexact, "exact");
Fprovide (intern_c_string ("mps"), Qnil);
DEFVAR_LISP ("igc-step-interval", Vigc_step_interval,
doc: /* How much time is MPS allowed to spend in GC when Emacs is idle.
The value is in seconds, and should be a non-negative number. It can
be either an integer or a float. The default value is 0 which means .
don't do something when idle. Negative values and values that are not numbers
are handled as if they were the default value. */);
Vigc_step_interval = make_fixnum (0);
}
|