1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
6946
6947
6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
7033
7034
7035
7036
7037
7038
7039
7040
7041
7042
7043
7044
7045
7046
7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
7074
7075
7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
7161
7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
7204
7205
7206
7207
7208
7209
7210
7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
7233
7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
7256
7257
7258
7259
7260
7261
7262
7263
7264
7265
7266
7267
7268
7269
7270
7271
7272
7273
7274
7275
7276
7277
7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
7332
7333
7334
7335
7336
7337
7338
7339
7340
7341
7342
7343
7344
7345
7346
7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
7425
7426
7427
7428
7429
7430
7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
7536
7537
7538
7539
7540
7541
7542
7543
7544
7545
7546
7547
7548
7549
7550
7551
7552
7553
7554
7555
7556
7557
7558
7559
7560
7561
7562
7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
7588
7589
7590
7591
7592
7593
7594
7595
7596
7597
7598
7599
7600
7601
7602
7603
7604
7605
7606
7607
7608
7609
7610
7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
7645
7646
7647
7648
7649
7650
7651
7652
7653
7654
7655
7656
7657
7658
7659
7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
7694
7695
7696
7697
7698
7699
7700
7701
7702
7703
7704
7705
7706
7707
7708
7709
7710
7711
7712
7713
7714
7715
7716
7717
7718
7719
7720
7721
7722
7723
7724
7725
7726
7727
7728
7729
7730
7731
7732
7733
7734
7735
7736
7737
7738
7739
7740
7741
7742
7743
7744
7745
7746
7747
7748
7749
7750
7751
7752
7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
7775
7776
7777
7778
7779
7780
7781
7782
7783
7784
7785
7786
7787
7788
7789
7790
7791
7792
7793
7794
7795
7796
7797
7798
7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
7828
7829
7830
7831
7832
7833
7834
7835
7836
7837
7838
7839
7840
7841
7842
7843
7844
7845
7846
7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
7858
7859
7860
7861
7862
7863
7864
7865
7866
7867
7868
7869
7870
7871
7872
7873
7874
7875
7876
7877
7878
7879
7880
7881
7882
7883
7884
7885
7886
7887
7888
7889
7890
7891
7892
7893
7894
7895
7896
7897
7898
7899
7900
7901
7902
7903
7904
7905
7906
7907
7908
7909
7910
7911
7912
7913
7914
7915
7916
7917
7918
7919
7920
7921
7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
7966
7967
7968
7969
7970
7971
7972
7973
7974
7975
7976
7977
7978
7979
7980
7981
7982
7983
7984
7985
7986
7987
7988
7989
7990
7991
7992
7993
7994
7995
7996
7997
7998
7999
8000
8001
8002
8003
8004
8005
8006
8007
8008
8009
8010
8011
8012
8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
8024
8025
8026
8027
8028
8029
8030
8031
8032
8033
8034
8035
8036
8037
8038
8039
8040
8041
8042
8043
8044
8045
8046
8047
8048
8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
8077
8078
8079
8080
8081
8082
8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
8098
8099
8100
8101
8102
8103
8104
8105
8106
8107
8108
8109
8110
8111
8112
8113
8114
8115
8116
8117
8118
8119
8120
8121
8122
8123
8124
8125
8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
8137
8138
8139
8140
8141
8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
8161
8162
8163
8164
8165
8166
8167
8168
8169
8170
8171
8172
8173
8174
8175
8176
8177
8178
8179
8180
8181
8182
8183
8184
8185
8186
8187
8188
8189
8190
8191
8192
8193
8194
8195
8196
8197
8198
8199
8200
8201
|
------------------------------------------------------------------------------
-- --
-- GNAT COMPILER COMPONENTS --
-- --
-- S E M _ E L A B --
-- --
-- B o d y --
-- --
-- Copyright (C) 1997-2017, Free Software Foundation, Inc. --
-- --
-- GNAT is free software; you can redistribute it and/or modify it under --
-- terms of the GNU General Public License as published by the Free Soft- --
-- ware Foundation; either version 3, or (at your option) any later ver- --
-- sion. GNAT is distributed in the hope that it will be useful, but WITH- --
-- OUT 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 distributed with GNAT; see file COPYING3. If not, go to --
-- http://www.gnu.org/licenses for a complete copy of the license. --
-- --
-- GNAT was originally developed by the GNAT team at New York University. --
-- Extensive contributions were provided by Ada Core Technologies Inc. --
-- --
------------------------------------------------------------------------------
with Atree; use Atree;
with Debug; use Debug;
with Einfo; use Einfo;
with Errout; use Errout;
with Exp_Tss; use Exp_Tss;
with Exp_Util; use Exp_Util;
with Lib; use Lib;
with Lib.Load; use Lib.Load;
with Namet; use Namet;
with Nlists; use Nlists;
with Nmake; use Nmake;
with Opt; use Opt;
with Restrict; use Restrict;
with Rident; use Rident;
with Rtsfind; use Rtsfind;
with Sem; use Sem;
with Sem_Aux; use Sem_Aux;
with Sem_Ch7; use Sem_Ch7;
with Sem_Ch8; use Sem_Ch8;
with Sem_Prag; use Sem_Prag;
with Sem_Util; use Sem_Util;
with Sinfo; use Sinfo;
with Snames; use Snames;
with Stand; use Stand;
with Table;
with Tbuild; use Tbuild;
with Uintp; use Uintp;
with Uname; use Uname;
with GNAT.HTable; use GNAT.HTable;
package body Sem_Elab is
-----------------------------------------
-- Access-before-elaboration mechanism --
-----------------------------------------
-- The access-before-elaboration (ABE) mechanism implemented in this unit
-- has the following objectives:
--
-- * Diagnose at compile-time or install run-time checks to prevent ABE
-- access to data and behaviour.
--
-- The high level idea is to accurately diagnose ABE issues within a
-- single unit because the ABE mechanism can inspect the whole unit.
-- As soon as the elaboration graph extends to an external unit, the
-- diagnostics stop because the body of the unit may not be available.
-- Due to control and data flow, the ABE mechanism cannot accurately
-- determine whether a particular scenario will be elaborated or not.
-- Conditional ABE checks are therefore used to verify the elaboration
-- status of a local and external target at run time.
--
-- * Supply elaboration dependencies for a unit to binde
--
-- The ABE mechanism registers each outgoing elaboration edge for the
-- main unit in its ALI file. GNATbind and binde can then reconstruct
-- the full elaboration graph and determine the proper elaboration
-- order for all units in the compilation.
--
-- The ABE mechanism supports three models of elaboration:
--
-- * Dynamic model - This is the most permissive of the three models.
-- When the dynamic model is in effect, the mechanism performs very
-- little diagnostics and generates run-time checks to detect ABE
-- issues. The behaviour of this model is identical to that specified
-- by the Ada RM. This model is enabled with switch -gnatE.
--
-- * Static model - This is the middle ground of the three models. When
-- the static model is in effect, the mechanism diagnoses and installs
-- run-time checks to detect ABE issues in the main unit. In addition,
-- the mechanism generates implicit Elaborate or Elaborate_All pragmas
-- to ensure the prior elaboration of withed units. The model employs
-- textual order, with clause context, and elaboration-related source
-- pragmas. This is the default model.
--
-- * SPARK model - This is the most conservative of the three models and
-- impelements the semantics defined in SPARK RM 7.7. The SPARK model
-- is in effect only when a context resides in a SPARK_Mode On region,
-- otherwise the mechanism falls back to one of the previous models.
--
-- The ABE mechanism consists of a "recording" phase and a "processing"
-- phase.
-----------------
-- Terminology --
-----------------
-- * Bridge target - A type of target. A bridge target is a link between
-- scenarios. It is usually a byproduct of expansion and does not have
-- any direct ABE ramifications.
--
-- * Call marker - A special node used to indicate the presence of a call
-- in the tree in case expansion transforms or eliminates the original
-- call. N_Call_Marker nodes do not have static and run-time semantics.
--
-- * Conditional ABE - A type of ABE. A conditional ABE occurs when the
-- elaboration or invocation of a target by a scenario within the main
-- unit causes an ABE, but does not cause an ABE for another scenarios
-- within the main unit.
--
-- * Declaration level - A type of enclosing level. A scenario or target is
-- at the declaration level when it appears within the declarations of a
-- block statement, entry body, subprogram body, or task body, ignoring
-- enclosing packges.
--
-- * Generic library level - A type of enclosing level. A scenario or
-- target is at the generic library level if it appears in a generic
-- package library unit, ignoring enclosing packages.
--
-- * Guaranteed ABE - A type of ABE. A guaranteed ABE occurs when the
-- elaboration or invocation of a target by all scenarios within the
-- main unit causes an ABE.
--
-- * Instantiation library level - A type of enclosing level. A scenario
-- or target is at the instantiation library level if it appears in an
-- instantiation library unit, ignoring enclosing packages.
--
-- * Library level - A type of enclosing level. A scenario or target is at
-- the library level if it appears in a package library unit, ignoring
-- enclosng packages.
--
-- * Non-library level encapsulator - A construct that cannot be elaborated
-- on its own and requires elaboration by a top level scenario.
--
-- * Scenario - A construct or context which may be elaborated or executed
-- by elaboration code. The scenarios recognized by the ABE mechanism are
-- as follows:
--
-- - '[Unrestricted_]Access of entries, operators, and subprograms
--
-- - Assignments to variables
--
-- - Calls to entries, operators, and subprograms
--
-- - Instantiations
--
-- - References to variables
--
-- - Task activation
--
-- * Target - A construct referenced by a scenario. The targets recognized
-- by the ABE mechanism are as follows:
--
-- - For '[Unrestricted_]Access of entries, operators, and subprograms,
-- the target is the entry, operator, or subprogram.
--
-- - For assignments to variables, the target is the variable
--
-- - For calls, the target is the entry, operator, or subprogram
--
-- - For instantiations, the target is the generic template
--
-- - For references to variables, the target is the variable
--
-- - For task activation, the target is the task body
--
-- * Top level scenario - A scenario which appears in a non-generic main
-- unit. Depending on the elaboration model is in effect, the following
-- addotional restrictions apply:
--
-- - Dynamic model - No restrictions
--
-- - SPARK model - Falls back to either the dynamic or static model
--
-- - Static model - The scenario must be at the library level
---------------------
-- Recording phase --
---------------------
-- The Recording phase coincides with the analysis/resolution phase of the
-- compiler. It has the following objectives:
--
-- * Record all top level scenarios for examination by the Processing
-- phase.
--
-- Saving only a certain number of nodes improves the performance of
-- the ABE mechanism. This eliminates the need to examine the whole
-- tree in a separate pass.
--
-- * Detect and diagnose calls in preelaborable or pure units, including
-- generic bodies.
--
-- This diagnostic is carried out during the Recording phase because it
-- does not need the heavy recursive traversal done by the Processing
-- phase.
--
-- * Detect and diagnose guaranteed ABEs caused by instantiations,
-- calls, and task activation.
--
-- The issues detected by the ABE mechanism are reported as warnings
-- because they do not violate Ada semantics. Forward instantiations
-- may thus reach gigi, however gigi cannot handle certain kinds of
-- premature instantiations and may crash. To avoid this limitation,
-- the ABE mechanism must identify forward instantiations as early as
-- possible and suppress their bodies. Calls and task activations are
-- included in this category for completeness.
----------------------
-- Processing phase --
----------------------
-- The Processing phase is a separate pass which starts after instantiating
-- and/or inlining of bodies, but before the removal of Ghost code. It has
-- the following objectives:
--
-- * Examine all top level scenarios saved during the Recording phase
--
-- The top level scenarios act as roots for depth-first traversal of
-- the call/instantiation/task activation graph. The traversal stops
-- when an outgoing edge leaves the main unit.
--
-- * Depending on the elaboration model in effect, perform the following
-- actions:
--
-- - Dynamic model - Diagnose guaranteed ABEs and install run-time
-- conditional ABE checks.
--
-- - SPARK model - Enforce the SPARK elaboration rules
--
-- - Static model - Diagnose conditional/guaranteed ABEs, install
-- run-time conditional ABE checks, and guarantee the elaboration
-- of external units.
--
-- * Examine nested scenarios
--
-- Nested scenarios discovered during the depth-first traversal are
-- in turn subjected to the same actions outlined above and examined
-- for the next level of nested scenarios.
------------------
-- Architecture --
------------------
-- +------------------------ Recording phase ---------------------------+
-- | |
-- | Record_Elaboration_Scenario |
-- | | |
-- | +--> Check_Preelaborated_Call |
-- | | |
-- | +--> Process_Guaranteed_ABE |
-- | | |
-- +------------------------- | --------------------------------------+
-- |
-- |
-- v
-- Top_Level_Scenarios
-- +-----------+-----------+ .. +-----------+
-- | Scenario1 | Scenario2 | .. | ScenarioN |
-- +-----------+-----------+ .. +-----------+
-- |
-- |
-- +------------------------- | --------------------------------------+
-- | | |
-- | Check_Elaboration_Scenarios |
-- | | |
-- | v |
-- | +----------- Process_Scenario <-----------+ |
-- | | | |
-- | +--> Process_Access Is_Suitable_Scenario |
-- | | ^ |
-- | +--> Process_Activation_Call --+ | |
-- | | +---> Traverse_Body |
-- | +--> Process_Call -------------+ |
-- | | |
-- | +--> Process_Instantiation |
-- | | |
-- | +--> Process_Variable_Assignment |
-- | | |
-- | +--> Process_Variable_Reference |
-- | |
-- +------------------------- Processing phase -------------------------+
----------------------
-- Important points --
----------------------
-- The Processing phase starts after the analysis, resolution, expansion
-- phase has completed. As a result, no current semantic information is
-- available. The scope stack is empty, global flags such as In_Instance
-- or Inside_A_Generic become useless. To remedy this, the ABE mechanism
-- must either save or recompute semantic information.
-- Expansion heavily transforms calls and to some extent instantiations. To
-- remedy this, the ABE mechanism generates N_Call_Marker nodes in order to
-- capture the target and relevant attributes of the original call.
-- The diagnostics of the ABE mechanism depend on accurate source locations
-- to determine the spacial relation of nodes.
--------------
-- Switches --
--------------
-- The following switches may be used to control the behavior of the ABE
-- mechanism.
--
-- -gnatdE elaboration checks on predefined units
--
-- The ABE mechanism considers scenarios which appear in internal
-- units (Ada, GNAT, Interfaces, System).
--
-- -gnatd.G ignore calls through generic formal parameters for elaboration
--
-- The ABE mechanism does not generate N_Call_Marker nodes for
-- calls which occur in expanded instances, and invoke generic
-- actual subprograms through generic formal subprograms. As a
-- result, the calls are not recorded or processed.
--
-- If switches -gnatd.G and -gnatdL are used together, then the
-- ABE mechanism effectively ignores all calls which cause the
-- elaboration flow to "leave" the instance.
--
-- -gnatdL ignore external calls from instances for elaboration
--
-- The ABE mechanism does not generate N_Call_Marker nodes for
-- calls which occur in expanded instances, do not invoke generic
-- actual subprograms through formal subprograms, and the target
-- is external to the instance. As a result, the calls are not
-- recorded or processed.
--
-- If switches -gnatd.G and -gnatdL are used together, then the
-- ABE mechanism effectively ignores all calls which cause the
-- elaboration flow to "leave" the instance.
--
-- -gnatd.o conservarive elaboration order for indirect calls
--
-- The ABE mechanism treats '[Unrestricted_]Access of an entry,
-- operator, or subprogram as an immediate invocation of the
-- target. As a result, it performs ABE checks and diagnostics on
-- the immediate call.
--
-- -gnatd.U ignore indirect calls for static elaboration
--
-- The ABE mechanism does not consider '[Unrestricted_]Access of
-- entries, operators, and subprograms. As a result, the scenarios
-- are not recorder or processed.
--
-- -gnatd.y disable implicit pragma Elaborate_All on task bodies
--
-- The ABE mechanism does not generate implicit Elaborate_All when
-- the need for the pragma came from a task body.
--
-- -gnatE dynamic elaboration checking mode enabled
--
-- The ABE mechanism assumes that any scenario is elaborated or
-- invoked by elaboration code. The ABE mechanism performs very
-- little diagnostics and generates condintional ABE checks to
-- detect ABE issues at run-time.
--
-- -gnatel turn on info messages on generated Elaborate[_All] pragmas
--
-- The ABE mechanism produces information messages on generated
-- implicit Elabote[_All] pragmas along with traceback showing
-- why the pragma was generated. In addition, the ABE mechanism
-- produces information messages for each scenario elaborated or
-- invoked by elaboration code.
--
-- -gnateL turn off info messages on generated Elaborate[_All] pragmas
--
-- The complimentary switch for -gnatel.
--
-- -gnatwl turn on warnings for elaboration problems
--
-- The ABE mechanism produces warnings on detected ABEs along with
-- traceback showing the graph of the ABE.
--
-- -gnatwL turn off warnings for elaboration problems
--
-- The complimentary switch for -gnatwl.
--
-- -gnatw.f turn on warnings for suspicious Subp'Access
--
-- The ABE mechanism treats '[Unrestricted_]Access of an entry,
-- operator, or subprogram as a pseudo invocation of the target.
-- As a result, it performs ABE diagnostics on the pseudo call.
--
-- -gnatw.F turn off warnings for suspicious Subp'Access
--
-- The complimentary switch for -gnatw.f.
---------------------------
-- Adding a new scenario --
---------------------------
-- The following steps describe how to add a new elaboration scenario and
-- preserve the existing architecture.
--
-- 1) If necessary, update predicates Is_Check_Emitting_Scenario and
-- Is_Scenario.
--
-- 2) Add predicate Is_Suitable_xxx. Include a call to it in predicate
-- Is_Suitable_Scenario.
--
-- 3) Update routine Record_Elaboration_Scenario
--
-- 4) Add routine Process_xxx. Include a call to it in Process_Scenario.
--
-- 5) Add routine Info_xxx. Include a call to it in Process_xxx.
--
-- 6) Add routine Output_xxx. Include a call to it in routine
-- Output_Active_Scenarios.
--
-- 7) If necessary, add a new Extract_xxx_Attributes routine
--
-- 8) If necessary, update routine Is_Potential_Scenario
-------------------------
-- Adding a new target --
-------------------------
-- The following steps describe how to add a new elaboration target and
-- preserve the existing architecture.
--
-- 1) Add predicate Is_xxx.
--
-- 2) Update predicates Is_Ada_Semantic_Target, Is_Bridge_Target, or
-- Is_SPARK_Semantic_Target. If necessary, create a new category.
--
-- 3) Update the appropriate Info_xxx routine.
--
-- 4) Update the appropriate Output_xxx routine.
--
-- 5) Update routine Extract_Target_Attributes. If necessary, create a
-- new Extract_xxx routine.
--------------------------
-- Debugging ABE issues --
--------------------------
-- * If the issue involves a call, ensure that the call is eligible for ABE
-- processing and receives a corresponding call marker. The routines of
-- interest are
--
-- Build_Call_Marker
-- Record_Elaboration_Scenario
-- * If the issue involves an arbitrary scenario, ensure that the scenario
-- is either recorded, or is successfully recognized while traversing a
-- body. The routines of interest are
--
-- Record_Elaboration_Scenario
-- Process_Scenario
-- Traverse_Body
-- * If the issue involves a circularity in the elaboration order, examine
-- the ALI files and look for the following encodings next to units:
--
-- E indicates a source Elaborate
--
-- EA indicates a source Elaborate_All
--
-- AD indicates an implicit Elaborate_All
--
-- ED indicates an implicit Elaborate
--
-- If possible, compare these encodings with those generated by the old
-- ABE mechanism. The routines of interest are
--
-- Ensure_Prior_Elaboration
----------------
-- Attributes --
----------------
-- The following type captures relevant attributes which pertain to a call
type Call_Attributes is record
Elab_Checks_OK : Boolean;
-- This flag is set when the call has elaboration checks enabled
From_Source : Boolean;
-- This flag is set when the call comes from source
Ghost_Mode_Ignore : Boolean;
-- This flag is set when the call appears in a region subject to pragma
-- Ghost with policy Ignore.
In_Declarations : Boolean;
-- This flag is set when the call appears at the declaration level
Is_Dispatching : Boolean;
-- This flag is set when the call is dispatching
SPARK_Mode_On : Boolean;
-- This flag is set when the call appears in a region subject to pragma
-- SPARK_Mode with value On.
end record;
-- The following type captures relevant attributes which pertain to the
-- prior elaboration of a unit. This type is coupled together with a unit
-- to form a key -> value relationship.
type Elaboration_Attributes is record
Source_Pragma : Node_Id;
-- This attribute denotes a source Elaborate or Elaborate_All pragma
-- which guarantees the prior elaboration of some unit with respect
-- to the main unit. The pragma may come from the following contexts:
-- * The main unit
-- * The spec of the main unit (if applicable)
-- * Any parent spec of the main unit (if applicable)
-- * Any parent subunit of the main unit (if applicable)
-- The attribute remains Empty if no such pragma is available. Source
-- pragmas play a role in satisfying SPARK elaboration requirements.
With_Clause : Node_Id;
-- This attribute denotes an internally generated or source with clause
-- for some unit withed by the main unit. With clauses carry flags which
-- represent implicit Elaborate or Elaborate_All pragmas. These clauses
-- play a role in supplying the elaboration dependencies to binde.
end record;
No_Elaboration_Attributes : constant Elaboration_Attributes :=
(Source_Pragma => Empty,
With_Clause => Empty);
-- The following type captures relevant attributes which pertain to an
-- instantiation.
type Instantiation_Attributes is record
Elab_Checks_OK : Boolean;
-- This flag is set when the instantiation has elaboration checks
-- enabled.
Ghost_Mode_Ignore : Boolean;
-- This flag is set when the instantiation appears in a region subject
-- to pragma Ghost with policy ignore, or starts one such region.
In_Declarations : Boolean;
-- This flag is set when the instantiation appears at the declaration
-- level.
SPARK_Mode_On : Boolean;
-- This flag is set when the instantiation appears in a region subject
-- to pragma SPARK_Mode with value On, or starts one such region.
end record;
-- The following type captures relevant attributes which pertain to a
-- target.
type Target_Attributes is record
Elab_Checks_OK : Boolean;
-- This flag is set when the target has elaboration checks enabled
From_Source : Boolean;
-- This flag is set when the target comes from source
Ghost_Mode_Ignore : Boolean;
-- This flag is set when the target appears in a region subject to
-- pragma Ghost with policy ignore, or starts one such region.
SPARK_Mode_On : Boolean;
-- This flag is set when the target appears in a region subject to
-- pragma SPARK_Mode with value On, or starts one such region.
Spec_Decl : Node_Id;
-- This attribute denotes the declaration of Spec_Id
Unit_Id : Entity_Id;
-- This attribute denotes the top unit where Spec_Id resides
-- The semantics of the following attributes depend on the target
Body_Barf : Node_Id;
Body_Decl : Node_Id;
Spec_Id : Entity_Id;
-- The target is a generic package or a subprogram
--
-- * Body_Barf - Empty
--
-- * Body_Decl - This attribute denotes the generic or subprogram
-- body.
--
-- * Spec_Id - This attribute denotes the entity of the generic
-- package or subprogram.
-- The target is a protected entry
--
-- * Body_Barf - This attribute denotes the body of the barrier
-- function if expansion took place, otherwise it is Empty.
--
-- * Body_Decl - This attribute denotes the body of the procedure
-- which emulates the entry if expansion took place, otherwise it
-- denotes the body of the protected entry.
--
-- * Spec_Id - This attribute denotes the entity of the procedure
-- which emulates the entry if expansion took place, otherwise it
-- denotes the protected entry.
-- The target is a protected subprogram
--
-- * Body_Barf - Empty
--
-- * Body_Decl - This attribute denotes the body of the protected or
-- unprotected version of the protected subprogram if expansion took
-- place, otherwise it denotes the body of the protected subprogram.
--
-- * Spec_Id - This attribute denotes the entity of the protected or
-- unprotected version of the protected subprogram if expansion took
-- place, otherwise it is the entity of the protected subprogram.
-- The target is a task entry
--
-- * Body_Barf - Empty
--
-- * Body_Decl - This attribute denotes the body of the procedure
-- which emulates the task body if expansion took place, otherwise
-- it denotes the body of the task type.
--
-- * Spec_Id - This attribute denotes the entity of the procedure
-- which emulates the task body if expansion took place, otherwise
-- it denotes the entity of the task type.
end record;
-- The following type captures relevant attributes which pertain to a task
-- type.
type Task_Attributes is record
Body_Decl : Node_Id;
-- This attribute denotes the declaration of the procedure body which
-- emulates the behaviour of the task body.
Elab_Checks_OK : Boolean;
-- This flag is set when the task type has elaboration checks enabled
Ghost_Mode_Ignore : Boolean;
-- This flag is set when the task type appears in a region subject to
-- pragma Ghost with policy ignore, or starts one such region.
SPARK_Mode_On : Boolean;
-- This flag is set when the task type appears in a region subject to
-- pragma SPARK_Mode with value On, or starts one such region.
Spec_Id : Entity_Id;
-- This attribute denotes the entity of the initial declaration of the
-- procedure body which emulates the behaviour of the task body.
Task_Decl : Node_Id;
-- This attribute denotes the declaration of the task type
Unit_Id : Entity_Id;
-- This attribute denotes the entity of the compilation unit where the
-- task type resides.
end record;
-- The following type captures relevant attributes which pertain to a
-- variable.
type Variable_Attributes is record
SPARK_Mode_On : Boolean;
-- This flag is set when the variable appears in a region subject to
-- pragma SPARK_Mode with value On, or starts one such region.
Unit_Id : Entity_Id;
-- This attribute denotes the entity of the compilation unit where the
-- variable resides.
end record;
---------------------
-- Data structures --
---------------------
-- The following table stores the elaboration status of all units withed by
-- the main unit.
Elaboration_Context_Max : constant := 1009;
type Elaboration_Context_Index is range 0 .. Elaboration_Context_Max - 1;
function Elaboration_Context_Hash
(Key : Entity_Id) return Elaboration_Context_Index;
-- Obtain the hash value of entity Key
package Elaboration_Context is new Simple_HTable
(Header_Num => Elaboration_Context_Index,
Element => Elaboration_Attributes,
No_Element => No_Elaboration_Attributes,
Key => Entity_Id,
Hash => Elaboration_Context_Hash,
Equal => "=");
-- The following table stores all active scenarios in a recursive traversal
-- starting from a top level scenario. This table must be maintained in a
-- FIFO fashion.
package Scenario_Stack is new Table.Table
(Table_Component_Type => Node_Id,
Table_Index_Type => Int,
Table_Low_Bound => 1,
Table_Initial => 50,
Table_Increment => 100,
Table_Name => "Scenario_Stack");
-- The following table stores all top level scenario saved during the
-- Recording phase. The contents of this table act as traversal roots
-- later in the Processing phase. This table must be maintained in a
-- LIFO fashion.
package Top_Level_Scenarios is new Table.Table
(Table_Component_Type => Node_Id,
Table_Index_Type => Int,
Table_Low_Bound => 1,
Table_Initial => 1000,
Table_Increment => 100,
Table_Name => "Top_Level_Scenarios");
-- The following table stores the bodies of all eligible scenarios visited
-- during a traversal starting from a top level scenario. The contents of
-- this table must be reset upon each new traversal.
Visited_Bodies_Max : constant := 511;
type Visited_Bodies_Index is range 0 .. Visited_Bodies_Max - 1;
function Visited_Bodies_Hash (Key : Node_Id) return Visited_Bodies_Index;
-- Obtain the hash value of node Key
package Visited_Bodies is new Simple_HTable
(Header_Num => Visited_Bodies_Index,
Element => Boolean,
No_Element => False,
Key => Node_Id,
Hash => Visited_Bodies_Hash,
Equal => "=");
-----------------------
-- Local subprograms --
-----------------------
procedure Check_Preelaborated_Call (Call : Node_Id);
-- Determine whether entry, operator, or subprogram call Call appears at
-- the library level of a preelaborated unit. Emit an error if this is the
-- case.
function Compilation_Unit (Unit_Id : Entity_Id) return Node_Id;
pragma Inline (Compilation_Unit);
-- Return the N_Compilation_Unit node of unit Unit_Id
procedure Elab_Msg_NE
(Msg : String;
N : Node_Id;
Id : Entity_Id;
Info_Msg : Boolean;
In_SPARK : Boolean);
pragma Inline (Elab_Msg_NE);
-- Wrapper around Error_Msg_NE. Emit message Msg concerning arbitrary node
-- N and entity. If flag Info_Msg is set, the routine emits an information
-- message, otherwise it emits an error. If flag In_SPARK is set, then
-- string " in SPARK" is added to the end of the message.
procedure Ensure_Dynamic_Prior_Elaboration
(N : Node_Id;
Unit_Id : Entity_Id;
Prag_Nam : Name_Id);
-- Guarantee the elaboration of unit Unit_Id with respect to the main unit
-- by suggesting the use of Elaborate[_All] with name Prag_Nam. N denotes
-- the related scenario.
procedure Ensure_Prior_Elaboration
(N : Node_Id;
Unit_Id : Entity_Id;
In_Task_Body : Boolean);
-- Guarantee the elaboration of unit Unit_Id with respect to the main unit.
-- N denotes the related scenario. Flag In_Task_Body should be set when the
-- need for elaboration is initiated from a task body.
procedure Ensure_Static_Prior_Elaboration
(N : Node_Id;
Unit_Id : Entity_Id;
Prag_Nam : Name_Id);
-- Guarantee the elaboration of unit Unit_Id with respect to the main unit
-- by installing an implicit Elaborate[_All] pragma with name Prag_Nam. N
-- denotes the related scenario.
function Extract_Assignment_Name (Asmt : Node_Id) return Node_Id;
pragma Inline (Extract_Assignment_Name);
-- Obtain the Name attribute of assignment statement Asmt
procedure Extract_Call_Attributes
(Call : Node_Id;
Target_Id : out Entity_Id;
Attrs : out Call_Attributes);
-- Obtain attributes Attrs associated with call Call. Target_Id is the
-- entity of the call target.
function Extract_Call_Name (Call : Node_Id) return Node_Id;
pragma Inline (Extract_Call_Name);
-- Obtain the Name attribute of entry or subprogram call Call
procedure Extract_Instance_Attributes
(Exp_Inst : Node_Id;
Inst_Body : out Node_Id;
Inst_Decl : out Node_Id);
pragma Inline (Extract_Instance_Attributes);
-- Obtain body Inst_Body and spec Inst_Decl of expanded instance Exp_Inst
procedure Extract_Instantiation_Attributes
(Exp_Inst : Node_Id;
Inst : out Node_Id;
Inst_Id : out Entity_Id;
Gen_Id : out Entity_Id;
Attrs : out Instantiation_Attributes);
-- Obtain attributes Attrs associated with expanded instantiation Exp_Inst.
-- Inst is the instantiation. Inst_Id is the entity of the instance. Gen_Id
-- is the entity of the generic unit being instantiated.
procedure Extract_Target_Attributes
(Target_Id : Entity_Id;
Attrs : out Target_Attributes);
-- Obtain attributes Attrs associated with an entry, package, or subprogram
-- denoted by Target_Id.
procedure Extract_Task_Attributes
(Typ : Entity_Id;
Attrs : out Task_Attributes);
-- Obtain attributes Attrs associated with task type Typ
procedure Extract_Variable_Reference_Attributes
(Ref : Node_Id;
Var_Id : out Entity_Id;
Attrs : out Variable_Attributes);
-- Obtain attributes Attrs associated with reference Ref which mentions
-- variable Var_Id.
function Find_Code_Unit (N : Node_Or_Entity_Id) return Entity_Id;
pragma Inline (Find_Code_Unit);
-- Return the code unit which contains arbitrary node or entity N. This
-- is the unit of the file which physically contains the related construct
-- denoted by N except when N is within an instantiation. In that case the
-- unit is that of the top level instantiation.
procedure Find_Elaborated_Units;
-- Populate table Elaboration_Context with all units which have prior
-- elaboration with respect to the main unit.
function Find_Enclosing_Instance (N : Node_Id) return Node_Id;
pragma Inline (Find_Enclosing_Instance);
-- Find the declaration or body of the nearest expanded instance which
-- encloses arbitrary node N. Return Empty if no such instance exists.
function Find_Top_Unit (N : Node_Or_Entity_Id) return Entity_Id;
pragma Inline (Find_Top_Unit);
-- Return the top unit which contains arbitrary node or entity N. The unit
-- is obtained by logically unwinding instantiations and subunits when N
-- resides within one.
function First_Formal_Type (Subp_Id : Entity_Id) return Entity_Id;
pragma Inline (First_Formal_Type);
-- Return the type of subprogram Subp_Id's first formal parameter. If the
-- subprogram lacks formal parameters, return Empty.
function Has_Body (Pack_Decl : Node_Id) return Boolean;
-- Determine whether package declaration Pack_Decl has a corresponding body
-- or would eventually have one.
function Has_Prior_Elaboration
(Unit_Id : Entity_Id;
Context_OK : Boolean := False;
Elab_Body_OK : Boolean := False;
Same_Unit_OK : Boolean := False) return Boolean;
pragma Inline (Has_Prior_Elaboration);
-- Determine whether unit Unit_Id is elaborated prior to the main unit.
-- If flag Context_OK is set, the routine considers the following case
-- as valid prior elaboration:
--
-- * Unit_Id is in the elaboration context of the main unit
--
-- If flag Elab_Body_OK is set, the routine considers the following case
-- as valid prior elaboration:
--
-- * Unit_Id has pragma Elaborate_Body and is not the main unit
--
-- If flag Same_Unit_OK is set, the routine considers the following cases
-- as valid prior elaboration:
--
-- * Unit_Id is the main unit
--
-- * Unit_Id denotes the spec of the main unit body
function In_External_Instance
(N : Node_Id;
Target_Decl : Node_Id) return Boolean;
-- Determine whether a target desctibed by its declaration Target_Decl
-- resides in a package instance which is external to scenario N.
function In_Main_Context (N : Node_Id) return Boolean;
pragma Inline (In_Main_Context);
-- Determine whether arbitrary node N appears within the main compilation
-- unit.
function In_Same_Context
(N1 : Node_Id;
N2 : Node_Id;
Nested_OK : Boolean := False) return Boolean;
-- Determine whether two arbitrary nodes N1 and N2 appear within the same
-- context ignoring enclosing library levels. Nested_OK should be set when
-- the context of N1 can enclose that of N2.
procedure Info_Call
(Call : Node_Id;
Target_Id : Entity_Id;
Info_Msg : Boolean;
In_SPARK : Boolean);
-- Output information concerning call Call which invokes target Target_Id.
-- If flag Info_Msg is set, the routine emits an information message,
-- otherwise it emits an error. If flag In_SPARK is set, then string " in
-- SPARK" is added to the end of the message.
procedure Info_Instantiation
(Inst : Node_Id;
Gen_Id : Entity_Id;
Info_Msg : Boolean;
In_SPARK : Boolean);
-- Output information concerning instantiation Inst which instantiates
-- generic unit Gen_Id. If flag Info_Msg is set, the routine emits an
-- information message, otherwise it emits an error. If flag In_SPARK
-- is set, then string " in SPARK" is added to the end of the message.
procedure Info_Variable_Reference
(Ref : Node_Id;
Var_Id : Entity_Id;
Info_Msg : Boolean;
In_SPARK : Boolean);
-- Output information concerning reference Ref which mentions variable
-- Var_Id. If flag Info_Msg is set, the routine emits an information
-- message, otherwise it emits an error. If flag In_SPARK is set, then
-- string " in SPARK" is added to the end of the message.
function Insertion_Node (N : Node_Id; Ins_Nod : Node_Id) return Node_Id;
pragma Inline (Insertion_Node);
-- Obtain the proper insertion node of an ABE check or failure for scenario
-- N and candidate insertion node Ins_Nod.
procedure Install_ABE_Check
(N : Node_Id;
Id : Entity_Id;
Ins_Nod : Node_Id);
-- Insert a run-time ABE check for elaboration scenario N which verifies
-- whether arbitrary entity Id is elaborated. The check in inserted prior
-- to node Ins_Nod.
procedure Install_ABE_Check
(N : Node_Id;
Target_Id : Entity_Id;
Target_Decl : Node_Id;
Target_Body : Node_Id;
Ins_Nod : Node_Id);
-- Insert a run-time ABE check for elaboration scenario N which verifies
-- whether target Target_Id with initial declaration Target_Decl and body
-- Target_Body is elaborated. The check is inserted prior to node Ins_Nod.
procedure Install_ABE_Failure (N : Node_Id; Ins_Nod : Node_Id);
-- Insert a Program_Error concerning a guaranteed ABE for elaboration
-- scenario N. The failure is inserted prior to node Node_Id.
function Is_Accept_Alternative_Proc (Id : Entity_Id) return Boolean;
pragma Inline (Is_Accept_Alternative_Proc);
-- Determine whether arbitrary entity Id denotes an internally generated
-- procedure which encapsulates the statements of an accept alternative.
function Is_Activation_Proc (Id : Entity_Id) return Boolean;
pragma Inline (Is_Activation_Proc);
-- Determine whether arbitrary entity Id denotes a runtime procedure in
-- charge with activating tasks.
function Is_Ada_Semantic_Target (Id : Entity_Id) return Boolean;
pragma Inline (Is_Ada_Semantic_Target);
-- Determine whether arbitrary entity Id nodes a source or internally
-- generated subprogram which emulates Ada semantics.
function Is_Bodiless_Subprogram (Subp_Id : Entity_Id) return Boolean;
pragma Inline (Is_Bodiless_Subprogram);
-- Determine whether subprogram Subp_Id will never have a body
function Is_Check_Emitting_Scenario (N : Node_Id) return Boolean;
pragma Inline (Is_Check_Emitting_Scenario);
-- Determine whether arbitrary node N denotes a scenario which may emit a
-- conditional ABE check.
function Is_Controlled_Proc
(Subp_Id : Entity_Id;
Subp_Nam : Name_Id) return Boolean;
pragma Inline (Is_Controlled_Proc);
-- Determine whether subprogram Subp_Id denotes controlled type primitives
-- Adjust, Finalize, or Initialize as denoted by name Subp_Nam.
function Is_Default_Initial_Condition_Proc (Id : Entity_Id) return Boolean;
pragma Inline (Is_Default_Initial_Condition_Proc);
-- Determine whether arbitrary entity Id denotes internally generated
-- routine Default_Initial_Condition.
function Is_Finalizer_Proc (Id : Entity_Id) return Boolean;
pragma Inline (Is_Finalizer_Proc);
-- Determine whether arbitrary entity Id denotes internally generated
-- routine _Finalizer.
function Is_Guaranteed_ABE
(N : Node_Id;
Target_Decl : Node_Id;
Target_Body : Node_Id) return Boolean;
-- Determine whether scenario N with a target described by its initial
-- declaration Target_Decl and body Target_Decl results in a guaranteed
-- ABE.
function Is_Initial_Condition_Proc (Id : Entity_Id) return Boolean;
pragma Inline (Is_Initial_Condition_Proc);
-- Determine whether arbitrary entity Id denotes internally generated
-- routine Initial_Condition.
function Is_Invariant_Proc (Id : Entity_Id) return Boolean;
pragma Inline (Is_Invariant_Proc);
-- Determine whether arbitrary entity Id denotes an invariant procedure
function Is_Non_Library_Level_Encapsulator (N : Node_Id) return Boolean;
pragma Inline (Is_Non_Library_Level_Encapsulator);
-- Determine whether arbitrary node N is a non-library encapsulator
function Is_Partial_Invariant_Proc (Id : Entity_Id) return Boolean;
pragma Inline (Is_Partial_Invariant_Proc);
-- Determine whether arbitrary entity Id denotes a partial invariant
-- procedure.
function Is_Postconditions_Proc (Id : Entity_Id) return Boolean;
pragma Inline (Is_Postconditions_Proc);
-- Determine whether arbitrary entity Id denotes internally generated
-- routine _Postconditions.
function Is_Preelaborated_Unit (Id : Entity_Id) return Boolean;
pragma Inline (Is_Preelaborated_Unit);
-- Determine whether arbitrary entity Id denotes a unit which is subject to
-- one of the following pragmas:
--
-- * Preelaborable
-- * Pure
-- * Remote_Call_Interface
-- * Remote_Types
-- * Shared_Passive
function Is_Protected_Entry (Id : Entity_Id) return Boolean;
pragma Inline (Is_Protected_Entry);
-- Determine whether arbitrary entity Id denotes a protected entry
function Is_Protected_Subp (Id : Entity_Id) return Boolean;
pragma Inline (Is_Protected_Subp);
-- Determine whether entity Id denotes a protected subprogram
function Is_Protected_Body_Subp (Id : Entity_Id) return Boolean;
pragma Inline (Is_Protected_Body_Subp);
-- Determine whether entity Id denotes the protected or unprotected version
-- of a protected subprogram.
function Is_Safe_Activation
(Call : Node_Id;
Task_Decl : Node_Id) return Boolean;
pragma Inline (Is_Safe_Activation);
-- Determine whether call Call which activates a task object described by
-- declaration Task_Decl is always ABE-safe.
function Is_Safe_Call
(Call : Node_Id;
Target_Attrs : Target_Attributes) return Boolean;
pragma Inline (Is_Safe_Call);
-- Determine whether call Call which invokes a target described by
-- attributes Target_Attrs is always ABE-safe.
function Is_Safe_Instantiation
(Inst : Node_Id;
Gen_Attrs : Target_Attributes) return Boolean;
pragma Inline (Is_Safe_Instantiation);
-- Determine whether instance Inst which instantiates a generic unit
-- described by attributes Gen_Attrs is always ABE-safe.
function Is_Same_Unit
(Unit_1 : Entity_Id;
Unit_2 : Entity_Id) return Boolean;
pragma Inline (Is_Same_Unit);
-- Determine whether entities Unit_1 and Unit_2 denote the same unit
function Is_Scenario (N : Node_Id) return Boolean;
pragma Inline (Is_Scenario);
-- Determine whether attribute node N denotes a scenario. The scenario may
-- not necessarily be eligible for ABE processing.
function Is_SPARK_Semantic_Target (Id : Entity_Id) return Boolean;
pragma Inline (Is_SPARK_Semantic_Target);
-- Determine whether arbitrary entity Id nodes a source or internally
-- generated subprogram which emulates SPARK semantics.
function Is_Suitable_Access (N : Node_Id) return Boolean;
pragma Inline (Is_Suitable_Access);
-- Determine whether arbitrary node N denotes a suitable attribute for ABE
-- processing.
function Is_Suitable_Call (N : Node_Id) return Boolean;
pragma Inline (Is_Suitable_Call);
-- Determine whether arbitrary node N denotes a suitable call for ABE
-- processing.
function Is_Suitable_Instantiation (N : Node_Id) return Boolean;
pragma Inline (Is_Suitable_Instantiation);
-- Determine whether arbitrary node N is a suitable instantiation for ABE
-- processing.
function Is_Suitable_Scenario (N : Node_Id) return Boolean;
pragma Inline (Is_Suitable_Scenario);
-- Determine whether arbitrary node N is a suitable scenario for ABE
-- processing.
function Is_Suitable_Variable_Assignment (N : Node_Id) return Boolean;
pragma Inline (Is_Suitable_Variable_Assignment);
-- Determine whether arbitrary node N denotes a suitable assignment for ABE
-- processing.
function Is_Suitable_Variable_Reference (N : Node_Id) return Boolean;
pragma Inline (Is_Suitable_Variable_Reference);
-- Determine whether arbitrary node N is a suitable reference to a variable
-- for ABE processing.
function Is_Task_Entry (Id : Entity_Id) return Boolean;
pragma Inline (Is_Task_Entry);
-- Determine whether arbitrary entity Id denotes a task entry
function Is_Up_Level_Target (Target_Decl : Node_Id) return Boolean;
pragma Inline (Is_Up_Level_Target);
-- Determine whether the current root resides at the declaration level. If
-- this is the case, determine whether a target described by declaration
-- Target_Decl is within a context which encloses the current root or is in
-- a different unit.
procedure Meet_Elaboration_Requirement
(N : Node_Id;
Target_Id : Entity_Id;
Req_Nam : Name_Id);
-- Determine whether elaboration requirement Req_Nam for scenario N with
-- target Target_Id is met by the context of the main unit using the SPARK
-- rules. Req_Nam must denote either Elaborate or Elaborate_All. Emit an
-- error if this is not the case.
function Non_Private_View (Typ : Entity_Id) return Entity_Id;
pragma Inline (Non_Private_View);
-- Return the full view of private type Typ if available, otherwise return
-- type Typ.
procedure Output_Active_Scenarios (Error_Nod : Node_Id);
-- Output the contents of the active scenario stack from earliest to latest
-- to supplement an earlier error emitted for node Error_Nod.
procedure Pop_Active_Scenario (N : Node_Id);
pragma Inline (Pop_Active_Scenario);
-- Pop the top of the scenario stack. A check is made to ensure that the
-- scenario being removed is the same as N.
procedure Process_Access (Attr : Node_Id; In_Task_Body : Boolean);
-- Perform ABE checks and diagnostics for 'Access to entry, operator, or
-- subprogram denoted by Attr. Flag In_Task_Body should be set when the
-- processing is initiated from a task body.
generic
with procedure Process_Single_Activation
(Call : Node_Id;
Call_Attrs : Call_Attributes;
Obj_Id : Entity_Id;
Task_Attrs : Task_Attributes;
In_Task_Body : Boolean);
-- Perform ABE checks and diagnostics for task activation call Call
-- which activates task Obj_Id. Call_Attrs are the attributes of the
-- activation call. Task_Attrs are the attributes of the task type.
-- Flag In_Task_Body should be set when the processing is initiated
-- from a task body.
procedure Process_Activation_Call
(Call : Node_Id;
Call_Attrs : Call_Attributes;
In_Task_Body : Boolean);
-- Perform ABE checks and diagnostics for activation call Call by invoking
-- routine Process_Single_Activation on each task object being activated.
-- Call_Attrs are the attributes of the activation call. Flag In_Task_Body
-- should be set when the processing is initiated from a task body.
procedure Process_Activation_Conditional_ABE_Impl
(Call : Node_Id;
Call_Attrs : Call_Attributes;
Obj_Id : Entity_Id;
Task_Attrs : Task_Attributes;
In_Task_Body : Boolean);
-- Perform common conditional ABE checks and diagnostics for call Call
-- which activates task Obj_Id ignoring the Ada or SPARK rules. CAll_Attrs
-- are the attributes of the activation call. Task_Attrs are the attributes
-- of the task type. Flag In_Task_Body should be set when the processing is
-- initiated from a task body.
procedure Process_Activation_Guaranteed_ABE_Impl
(Call : Node_Id;
Call_Attrs : Call_Attributes;
Obj_Id : Entity_Id;
Task_Attrs : Task_Attributes;
In_Task_Body : Boolean);
-- Perform common guaranteed ABE checks and diagnostics for call Call
-- which activates task Obj_Id ignoring the Ada or SPARK rules. CAll_Attrs
-- are the attributes of the activation call. Task_Attrs are the attributes
-- of the task type. Flag In_Task_Body should be set when the processing is
-- initiated from a task body.
procedure Process_Call
(Call : Node_Id;
Call_Attrs : Call_Attributes;
Target_Id : Entity_Id;
In_Task_Body : Boolean);
-- Top level dispatcher for processing of calls. Perform ABE checks and
-- diagnostics for call Call which invokes target Target_Id. Call_Attrs
-- are the attributes of the call. Flag In_Task_Body should be set when
-- the processing is initiated from a task body.
procedure Process_Call_Ada
(Call : Node_Id;
Call_Attrs : Call_Attributes;
Target_Id : Entity_Id;
Target_Attrs : Target_Attributes;
In_Task_Body : Boolean);
-- Perform ABE checks and diagnostics for call Call which invokes target
-- Target_Id using the Ada rules. Call_Attrs are the attributes of the
-- call. Target_Attrs are attributes of the target. Flag In_Task_Body
-- should be set when the processing is initiated from a task body.
procedure Process_Call_Conditional_ABE
(Call : Node_Id;
Call_Attrs : Call_Attributes;
Target_Id : Entity_Id;
Target_Attrs : Target_Attributes);
-- Perform common conditional ABE checks and diagnostics for call Call that
-- invokes target Target_Id ignoring the Ada or SPARK rules. Call_Attrs are
-- the attributes of the call. Target_Attrs are attributes of the target.
procedure Process_Call_Guaranteed_ABE
(Call : Node_Id;
Call_Attrs : Call_Attributes;
Target_Id : Entity_Id);
-- Perform common guaranteed ABE checks and diagnostics for call Call which
-- invokes target Target_Id ignoring the Ada or SPARK rules. Call_Attrs are
-- the attributes of the call.
procedure Process_Call_SPARK
(Call : Node_Id;
Call_Attrs : Call_Attributes;
Target_Id : Entity_Id;
Target_Attrs : Target_Attributes);
-- Perform ABE checks and diagnostics for call Call which invokes target
-- Target_Id using the SPARK rules. Call_Attrs are the attributes of the
-- call. Target_Attrs are attributes of the target.
procedure Process_Guaranteed_ABE (N : Node_Id);
-- Top level dispatcher for processing of scenarios which result in a
-- guaranteed ABE.
procedure Process_Instantiation
(Exp_Inst : Node_Id;
In_Task_Body : Boolean);
-- Top level dispatcher for processing of instantiations. Perform ABE
-- checks and diagnostics for expanded instantiation Exp_Inst. Flag
-- In_Task_Body should be set when the processing is initiated from a
-- task body.
procedure Process_Instantiation_Ada
(Exp_Inst : Node_Id;
Inst : Node_Id;
Inst_Attrs : Instantiation_Attributes;
Gen_Id : Entity_Id;
Gen_Attrs : Target_Attributes;
In_Task_Body : Boolean);
-- Perform ABE checks and diagnostics for expanded instantiation Exp_Inst
-- of generic Gen_Id using the Ada rules. Inst is the instantiation node.
-- Inst_Attrs are the attributes of the instance. Gen_Attrs are the
-- attributes of the generic. Flag In_Task_Body should be set when the
-- processing is initiated from a task body.
procedure Process_Instantiation_Conditional_ABE
(Exp_Inst : Node_Id;
Inst : Node_Id;
Inst_Attrs : Instantiation_Attributes;
Gen_Id : Entity_Id;
Gen_Attrs : Target_Attributes);
-- Perform common conditional ABE checks and diagnostics for expanded
-- instantiation Exp_Inst of generic Gen_Id ignoring the Ada or SPARK
-- rules. Inst is the instantiation node. Inst_Attrs are the attributes
-- of the instance. Gen_Attrs are the attributes of the generic.
procedure Process_Instantiation_Guaranteed_ABE (Exp_Inst : Node_Id);
-- Perform common guaranteed ABE checks and diagnostics for expanded
-- instantiation Exp_Inst of generic Gen_Id ignoring the Ada or SPARK
-- rules.
procedure Process_Instantiation_SPARK
(Exp_Inst : Node_Id;
Inst : Node_Id;
Inst_Attrs : Instantiation_Attributes;
Gen_Id : Entity_Id;
Gen_Attrs : Target_Attributes);
-- Perform ABE checks and diagnostics for expanded instantiation Exp_Inst
-- of generic Gen_Id using the SPARK rules. Inst is the instantiation node.
-- Inst_Attrs are the attributes of the instance. Gen_Attrs are the
-- attributes of the generic.
procedure Process_Scenario (N : Node_Id; In_Task_Body : Boolean := False);
-- Top level dispatcher for processing of various elaboration scenarios.
-- Perform ABE checks and diagnostics for scenario N. Flag In_Task_Body
-- should be set when the processing is initiated from a task body.
procedure Process_Variable_Assignment (Asmt : Node_Id);
-- Perform ABE checks and diagnostics for assignment statement Asmt
procedure Process_Variable_Reference (Ref : Node_Id);
-- Perform ABE checks and diagnostics for variable reference Ref
procedure Push_Active_Scenario (N : Node_Id);
pragma Inline (Push_Active_Scenario);
-- Push scenario N on top of the scenario stack
function Root_Scenario return Node_Id;
pragma Inline (Root_Scenario);
-- Return the top level scenario which started a recursive search for other
-- scenarios. It is assumed that there is a valid top level scenario on the
-- active scenario stack.
function Static_Elaboration_Checks return Boolean;
pragma Inline (Static_Elaboration_Checks);
-- Determine whether the static model is in effect
procedure Traverse_Body (N : Node_Id; In_Task_Body : Boolean);
-- Inspect the declarations and statements of subprogram body N for
-- suitable elaboration scenarios and process them. Flag In_Task_Body
-- should be set when the traversal is initiated from a task body.
procedure Update_Elaboration_Scenario (New_N : Node_Id; Old_N : Node_Id);
-- Update all relevant internal data structures when scenario Old_N is
-- transformed into scenario New_N by Atree.Rewrite.
-----------------------
-- Build_Call_Marker --
-----------------------
procedure Build_Call_Marker (N : Node_Id) is
function In_External_Context
(Call : Node_Id;
Target_Id : Entity_Id) return Boolean;
pragma Inline (In_External_Context);
-- Determine whether target Target_Id is external to call N which must
-- reside within an instance.
function In_Premature_Context (Call : Node_Id) return Boolean;
-- Determine whether call Call appears within a premature context
function Is_Bridge_Target (Id : Entity_Id) return Boolean;
pragma Inline (Is_Bridge_Target);
-- Determine whether arbitrary entity Id denotes a bridge target
function Is_Default_Expression (Call : Node_Id) return Boolean;
pragma Inline (Is_Default_Expression);
-- Determine whether call Call acts as the expression of a defaulted
-- parameter within a source call.
function Is_Generic_Formal_Subp (Subp_Id : Entity_Id) return Boolean;
pragma Inline (Is_Generic_Formal_Subp);
-- Determine whether subprogram Subp_Id denotes a generic formal
-- subprogram which appears in the "prologue" of an instantiation.
-------------------------
-- In_External_Context --
-------------------------
function In_External_Context
(Call : Node_Id;
Target_Id : Entity_Id) return Boolean
is
Target_Decl : constant Node_Id := Unit_Declaration_Node (Target_Id);
Inst : Node_Id;
Inst_Body : Node_Id;
Inst_Decl : Node_Id;
begin
-- Performance note: parent traversal
Inst := Find_Enclosing_Instance (Call);
-- The call appears within an instance
if Present (Inst) then
-- The call comes from the main unit and the target does not
if In_Extended_Main_Code_Unit (Call)
and then not In_Extended_Main_Code_Unit (Target_Decl)
then
return True;
-- Otherwise the target declaration must not appear within the
-- instance spec or body.
else
Extract_Instance_Attributes
(Exp_Inst => Inst,
Inst_Decl => Inst_Decl,
Inst_Body => Inst_Body);
-- Performance note: parent traversal
return not In_Subtree
(N => Target_Decl,
Root1 => Inst_Decl,
Root2 => Inst_Body);
end if;
end if;
return False;
end In_External_Context;
--------------------------
-- In_Premature_Context --
--------------------------
function In_Premature_Context (Call : Node_Id) return Boolean is
Par : Node_Id;
begin
-- Climb the parent chain looking for premature contexts
Par := Parent (Call);
while Present (Par) loop
-- Aspect specifications and generic associations are premature
-- contexts because nested calls has not been relocated to their
-- final context.
if Nkind_In (Par, N_Aspect_Specification,
N_Generic_Association)
then
return True;
-- Prevent the search from going too far
elsif Is_Body_Or_Package_Declaration (Par) then
exit;
end if;
Par := Parent (Par);
end loop;
return False;
end In_Premature_Context;
----------------------
-- Is_Bridge_Target --
----------------------
function Is_Bridge_Target (Id : Entity_Id) return Boolean is
begin
return
Is_Accept_Alternative_Proc (Id)
or else Is_Finalizer_Proc (Id)
or else Is_Partial_Invariant_Proc (Id)
or else Is_Postconditions_Proc (Id)
or else Is_TSS (Id, TSS_Deep_Adjust)
or else Is_TSS (Id, TSS_Deep_Finalize)
or else Is_TSS (Id, TSS_Deep_Initialize);
end Is_Bridge_Target;
---------------------------
-- Is_Default_Expression --
---------------------------
function Is_Default_Expression (Call : Node_Id) return Boolean is
Outer_Call : constant Node_Id := Parent (Call);
Outer_Nam : Node_Id;
begin
-- To qualify, the node must appear immediately within a source call
-- which invokes a source target.
if Nkind_In (Outer_Call, N_Entry_Call_Statement,
N_Function_Call,
N_Procedure_Call_Statement)
and then Comes_From_Source (Outer_Call)
then
Outer_Nam := Extract_Call_Name (Outer_Call);
return
Is_Entity_Name (Outer_Nam)
and then Present (Entity (Outer_Nam))
and then Is_Subprogram_Or_Entry (Entity (Outer_Nam))
and then Comes_From_Source (Entity (Outer_Nam));
end if;
return False;
end Is_Default_Expression;
----------------------------
-- Is_Generic_Formal_Subp --
----------------------------
function Is_Generic_Formal_Subp (Subp_Id : Entity_Id) return Boolean is
Subp_Decl : constant Node_Id := Unit_Declaration_Node (Subp_Id);
Context : constant Node_Id := Parent (Subp_Decl);
begin
-- To qualify, the subprogram must rename a generic actual subprogram
-- where the enclosing context is an instantiation.
return
Nkind (Subp_Decl) = N_Subprogram_Renaming_Declaration
and then not Comes_From_Source (Subp_Decl)
and then Nkind_In (Context, N_Function_Specification,
N_Package_Specification,
N_Procedure_Specification)
and then Present (Generic_Parent (Context));
end Is_Generic_Formal_Subp;
-- Local variables
Call_Attrs : Call_Attributes;
Call_Nam : Node_Id;
Marker : Node_Id;
Target_Id : Entity_Id;
-- Start of processing for Build_Call_Marker
begin
-- Nothing to do for ASIS. As a result, ABE checks and diagnostics are
-- not performed in this mode.
if ASIS_Mode then
return;
-- Nothing to do when the input does not denote a call or a requeue
elsif not Nkind_In (N, N_Entry_Call_Statement,
N_Function_Call,
N_Procedure_Call_Statement,
N_Requeue_Statement)
then
return;
-- Nothing to do when the call is being preanalyzed as the marker will
-- be inserted in the wrong place.
elsif Preanalysis_Active then
return;
-- Nothing to do when the call is analyzed/resolved too early within an
-- intermediate context.
-- Performance note: parent traversal
elsif In_Premature_Context (N) then
return;
end if;
Call_Nam := Extract_Call_Name (N);
-- Nothing to do when the call is erroneous or left in a bad state
if not (Is_Entity_Name (Call_Nam)
and then Present (Entity (Call_Nam))
and then Is_Subprogram_Or_Entry (Entity (Call_Nam)))
then
return;
-- Nothing to do when the call invokes a generic formal subprogram and
-- switch -gnatd.G (ignore calls through generic formal parameters for
-- elaboration) is in effect. This check must be performed with the
-- direct target of the call to avoid the side effects of mapping
-- actuals to formals using renamings.
elsif Debug_Flag_Dot_GG
and then Is_Generic_Formal_Subp (Entity (Call_Nam))
then
return;
end if;
Extract_Call_Attributes
(Call => N,
Target_Id => Target_Id,
Attrs => Call_Attrs);
-- Nothing to do when the call appears within the expanded spec or
-- body of an instantiated generic, the call does not invoke a generic
-- formal subprogram, the target is external to the instance, and switch
-- -gnatdL (ignore external calls from instances for elaboration) is in
-- effect. This behaviour approximates that of the old ABE mechanism.
if Debug_Flag_LL
and then not Is_Generic_Formal_Subp (Entity (Call_Nam))
-- Performance note: parent traversal
and then In_External_Context
(Call => N,
Target_Id => Target_Id)
then
return;
-- Source calls to source targets are always considered because they
-- reflect the original call graph.
elsif Comes_From_Source (Target_Id) and then Call_Attrs.From_Source then
null;
-- A call to a source function which acts as the default expression in
-- another call requires special detection.
elsif Comes_From_Source (Target_Id)
and then Nkind (N) = N_Function_Call
and then Is_Default_Expression (N)
then
null;
-- The target emulates Ada semantics
elsif Is_Ada_Semantic_Target (Target_Id) then
null;
-- The target acts as a link between scenarios
elsif Is_Bridge_Target (Target_Id) then
null;
-- The target emulates SPARK semantics
elsif Is_SPARK_Semantic_Target (Target_Id) then
null;
-- Otherwise the call is not suitable for ABE processing. This prevents
-- the generation of call markers which will never play a role in ABE
-- diagnostics.
else
return;
end if;
-- At this point it is known that the call will play some role in ABE
-- checks and diagnostics. Create a corresponding call marker in case
-- the original call is heavily transformed by expansion later on.
Marker := Make_Call_Marker (Sloc (N));
-- Inherit the attributes of the original call
Set_Target (Marker, Target_Id);
Set_Is_Elaboration_Checks_OK_Node (Marker, Call_Attrs.Elab_Checks_OK);
Set_Is_Declaration_Level_Node (Marker, Call_Attrs.In_Declarations);
Set_Is_Dispatching_Call (Marker, Call_Attrs.Is_Dispatching);
Set_Is_Ignored_Ghost_Node (Marker, Call_Attrs.Ghost_Mode_Ignore);
Set_Is_Source_Call (Marker, Call_Attrs.From_Source);
Set_Is_SPARK_Mode_On_Node (Marker, Call_Attrs.SPARK_Mode_On);
-- The marker is inserted prior to the original call. This placement has
-- several desirable effects:
-- 1) The marker appears in the same context, in close proximity to
-- the call.
-- <marker>
-- <call>
-- 2) Inserting the marker prior to the call ensures that an ABE check
-- will take effect prior to the call.
-- <ABE check>
-- <marker>
-- <call>
-- 3) The above two properties are preserved even when the call is a
-- function which is subsequently relocated in order to capture its
-- result. Note that if the call is relocated to a new context, the
-- relocated call will receive a marker of its own.
-- <ABE check>
-- <maker>
-- Temp : ... := Func_Call ...;
-- ... Temp ...
-- The insertion must take place even when the call does not occur in
-- the main unit to keep the tree symmetric. This ensures that internal
-- name serialization is consistent in case the call marker causes the
-- tree to transform in some way.
Insert_Action (N, Marker);
-- The marker becomes the "corresponding" scenario for the call. Save
-- the marker for later processing by the ABE phase.
Record_Elaboration_Scenario (Marker);
end Build_Call_Marker;
---------------------------------
-- Check_Elaboration_Scenarios --
---------------------------------
procedure Check_Elaboration_Scenarios is
begin
-- Nothing to do for ASIS. As a result, no ABE checks and diagnostics
-- are performed in this mode.
if ASIS_Mode then
return;
end if;
-- Examine the context of the main unit and record all units with prior
-- elaboration with respect to it.
Find_Elaborated_Units;
-- Examine each top level scenario saved during the Recording phase and
-- perform various actions depending on the elaboration model in effect.
for Index in Top_Level_Scenarios.First .. Top_Level_Scenarios.Last loop
-- Clear the table of visited scenario bodies for each new top level
-- scenario.
Visited_Bodies.Reset;
Process_Scenario (Top_Level_Scenarios.Table (Index));
end loop;
end Check_Elaboration_Scenarios;
------------------------------
-- Check_Preelaborated_Call --
------------------------------
procedure Check_Preelaborated_Call (Call : Node_Id) is
function In_Preelaborated_Context (N : Node_Id) return Boolean;
-- Determine whether arbitrary node appears in a preelaborated context
------------------------------
-- In_Preelaborated_Context --
------------------------------
function In_Preelaborated_Context (N : Node_Id) return Boolean is
Body_Id : constant Entity_Id := Find_Code_Unit (N);
Spec_Id : constant Entity_Id := Unique_Entity (Body_Id);
begin
-- The node appears within a package body whose corresponding spec is
-- subject to pragma Remote_Call_Interface or Remote_Types. This does
-- not result in a preelaborated context because the package body may
-- be on another machine.
if Ekind (Body_Id) = E_Package_Body
and then Ekind (Spec_Id) = E_Package
and then (Is_Remote_Call_Interface (Spec_Id)
or else Is_Remote_Types (Spec_Id))
then
return False;
-- Otherwise the node appears within a preelaborated context when the
-- associated unit is preelaborated.
else
return Is_Preelaborated_Unit (Spec_Id);
end if;
end In_Preelaborated_Context;
-- Local variables
Call_Attrs : Call_Attributes;
Level : Enclosing_Level_Kind;
Target_Id : Entity_Id;
-- Start of processing for Check_Preelaborated_Call
begin
Extract_Call_Attributes
(Call => Call,
Target_Id => Target_Id,
Attrs => Call_Attrs);
-- Nothing to do when the call is internally generated because it is
-- assumed that it will never violate preelaboration.
if not Call_Attrs.From_Source then
return;
end if;
-- Performance note: parent traversal
Level := Find_Enclosing_Level (Call);
-- Library level calls are always considered because they are part of
-- the associated unit's elaboration actions.
if Level in Library_Level then
null;
-- Calls at the library level of a generic package body must be checked
-- because they would render an instantiation illegal if the template is
-- marked as preelaborated. Note that this does not apply to calls at
-- the library level of a generic package spec.
elsif Level = Generic_Package_Body then
null;
-- Otherwise the call does not appear at the proper level and must not
-- be considered for this check.
else
return;
end if;
-- The call appears within a preelaborated unit. Emit a warning only for
-- internal uses, otherwise this is an error.
if In_Preelaborated_Context (Call) then
Error_Msg_Warn := GNAT_Mode;
Error_Msg_N
("<<non-static call not allowed in preelaborated unit", Call);
end if;
end Check_Preelaborated_Call;
----------------------
-- Compilation_Unit --
----------------------
function Compilation_Unit (Unit_Id : Entity_Id) return Node_Id is
Comp_Unit : Node_Id;
begin
Comp_Unit := Parent (Unit_Id);
-- Handle the case where a concurrent subunit is rewritten as a null
-- statement due to expansion activities.
if Nkind (Comp_Unit) = N_Null_Statement
and then Nkind_In (Original_Node (Comp_Unit), N_Protected_Body,
N_Task_Body)
then
Comp_Unit := Parent (Comp_Unit);
pragma Assert (Nkind (Comp_Unit) = N_Subunit);
-- Otherwise use the declaration node of the unit
else
Comp_Unit := Parent (Unit_Declaration_Node (Unit_Id));
end if;
if Nkind (Comp_Unit) = N_Subunit then
Comp_Unit := Parent (Comp_Unit);
end if;
pragma Assert (Nkind (Comp_Unit) = N_Compilation_Unit);
return Comp_Unit;
end Compilation_Unit;
-----------------
-- Elab_Msg_NE --
-----------------
procedure Elab_Msg_NE
(Msg : String;
N : Node_Id;
Id : Entity_Id;
Info_Msg : Boolean;
In_SPARK : Boolean)
is
function Prefix return String;
-- Obtain the prefix of the message
function Suffix return String;
-- Obtain the suffix of the message
------------
-- Prefix --
------------
function Prefix return String is
begin
if Info_Msg then
return "info: ";
else
return "";
end if;
end Prefix;
------------
-- Suffix --
------------
function Suffix return String is
begin
if In_SPARK then
return " in SPARK";
else
return "";
end if;
end Suffix;
-- Start of processing for Elab_Msg_NE
begin
Error_Msg_NE (Prefix & Msg & Suffix, N, Id);
end Elab_Msg_NE;
------------------------------
-- Elaboration_Context_Hash --
------------------------------
function Elaboration_Context_Hash
(Key : Entity_Id) return Elaboration_Context_Index
is
begin
return Elaboration_Context_Index (Key mod Elaboration_Context_Max);
end Elaboration_Context_Hash;
--------------------------------------
-- Ensure_Dynamic_Prior_Elaboration --
--------------------------------------
procedure Ensure_Dynamic_Prior_Elaboration
(N : Node_Id;
Unit_Id : Entity_Id;
Prag_Nam : Name_Id)
is
procedure Info_Missing_Pragma;
pragma Inline (Info_Missing_Pragma);
-- Output information concerning missing Elaborate or Elaborate_All
-- pragma with name Prag_Nam for scenario N which ensures the prior
-- elaboration of Unit_Id.
-------------------------
-- Info_Missing_Pragma --
-------------------------
procedure Info_Missing_Pragma is
begin
-- Internal units are ignored as they cause unnecessary noise
if not In_Internal_Unit (Unit_Id) then
-- The name of the unit subjected to the elaboration pragma is
-- fully qualified to improve the clarity of the info message.
Error_Msg_Name_1 := Prag_Nam;
Error_Msg_Qual_Level := Nat'Last;
Error_Msg_NE ("info: missing pragma % for unit &", N, Unit_Id);
Error_Msg_Qual_Level := 0;
end if;
end Info_Missing_Pragma;
-- Local variables
Elab_Attrs : Elaboration_Attributes;
Level : Enclosing_Level_Kind;
-- Start of processing for Ensure_Dynamic_Prior_Elaboration
begin
Elab_Attrs := Elaboration_Context.Get (Unit_Id);
-- Nothing to do when the unit is guaranteed prior elaboration by means
-- of a source Elaborate[_All] pragma.
if Present (Elab_Attrs.Source_Pragma) then
return;
end if;
-- Output extra information on a missing Elaborate[_All] pragma when
-- switch -gnatel (info messages on implicit Elaborate[_All] pragmas
-- is in effect.
if Elab_Info_Messages then
-- Performance note: parent traversal
Level := Find_Enclosing_Level (N);
-- Declaration level scenario
if (Is_Suitable_Call (N) or else Is_Suitable_Instantiation (N))
and then Level = Declaration_Level
then
null;
-- Library level scenario
elsif Level in Library_Level then
null;
-- Instantiation library level scenario
elsif Level = Instantiation then
null;
-- Otherwise the scenario does not appear at the proper level and
-- cannot possibly act as a top level scenario.
else
return;
end if;
Info_Missing_Pragma;
end if;
end Ensure_Dynamic_Prior_Elaboration;
------------------------------
-- Ensure_Prior_Elaboration --
------------------------------
procedure Ensure_Prior_Elaboration
(N : Node_Id;
Unit_Id : Entity_Id;
In_Task_Body : Boolean)
is
Prag_Nam : Name_Id;
begin
-- Instantiating an external generic unit requires an implicit Elaborate
-- because Elaborate_All is too strong and could introduce non-existent
-- elaboration cycles.
-- package External is
-- function Func ...;
-- end External;
-- with External;
-- generic
-- package Gen is
-- X : ... := External.Func;
-- end Gen;
-- [with External;] -- implicit with for External
-- [pragma Elaborate_All (External);] -- Elaborate_All for External
-- with Gen;
-- [pragma Elaborate (Gen);] -- Elaborate for generic
-- procedure Main is
-- package Inst is new Gen; -- calls External.Func
-- ...
-- end Main;
if Nkind (N) in N_Generic_Instantiation then
Prag_Nam := Name_Elaborate;
-- Otherwise generate an implicit Elaborate_All
else
Prag_Nam := Name_Elaborate_All;
end if;
-- Nothing to do when the need for prior elaboration came from a task
-- body and switch -gnatd.y (disable implicit pragma Elaborate_All on
-- task bodies) is in effect.
if Debug_Flag_Dot_Y and then In_Task_Body then
return;
-- Nothing to do when the unit is elaborated prior to the main unit.
-- This check must also consider the following cases:
-- * No check is made against the context of the main unit because this
-- is specific to the elaboration model in effect and requires custom
-- handling (see Ensure_xxx_Prior_Elaboration).
-- * Unit_Id is subject to pragma Elaborate_Body. An implicit pragma
-- Elaborate[_All] MUST be generated even though Unit_Id is always
-- elaborated prior to the main unit. This is a conservative strategy
-- which ensures that other units withed by Unit_Id will not lead to
-- an ABE.
-- package A is package body A is
-- procedure ABE; procedure ABE is ... end ABE;
-- end A; end A;
-- with A;
-- package B is package body B is
-- pragma Elaborate_Body; procedure Proc is
-- begin
-- procedure Proc; A.ABE;
-- package B; end Proc;
-- end B;
-- with B;
-- package C is package body C is
-- ... ...
-- end C; begin
-- B.Proc;
-- end C;
-- In the example above, the elaboration of C invokes B.Proc. B is
-- subject to pragma Elaborate_Body. If no pragma Elaborate[_All] is
-- generated for B in C, then the following elaboratio order will lead
-- to an ABE:
-- spec of A elaborated
-- spec of B elaborated
-- body of B elaborated
-- spec of C elaborated
-- body of C elaborated <-- calls B.Proc which calls A.ABE
-- body of A elaborated <-- problem
-- The generation of an implicit pragma Elaborate_All (B) ensures that
-- the elaboration order mechanism will not pick the above order.
-- An implicit Elaborate is NOT generated when the unit is subject to
-- Elaborate_Body because both pragmas have the exact same effect.
-- * Unit_Id is the main unit. An implicit pragma Elaborate[_All] MUST
-- NOT be generated in this case because a unit cannot depend on its
-- own elaboration. This case is therefore treated as valid prior
-- elaboration.
elsif Has_Prior_Elaboration
(Unit_Id => Unit_Id,
Same_Unit_OK => True,
Elab_Body_OK => Prag_Nam = Name_Elaborate)
then
return;
-- Suggest the use of pragma Prag_Nam when the dynamic model is in
-- effect.
elsif Dynamic_Elaboration_Checks then
Ensure_Dynamic_Prior_Elaboration
(N => N,
Unit_Id => Unit_Id,
Prag_Nam => Prag_Nam);
-- Install an implicit pragma Prag_Nam when the static model is in
-- effect.
else
pragma Assert (Static_Elaboration_Checks);
Ensure_Static_Prior_Elaboration
(N => N,
Unit_Id => Unit_Id,
Prag_Nam => Prag_Nam);
end if;
end Ensure_Prior_Elaboration;
-------------------------------------
-- Ensure_Static_Prior_Elaboration --
-------------------------------------
procedure Ensure_Static_Prior_Elaboration
(N : Node_Id;
Unit_Id : Entity_Id;
Prag_Nam : Name_Id)
is
function Find_With_Clause
(Items : List_Id;
Withed_Id : Entity_Id) return Node_Id;
-- Find a non-limited with clause in the list of context items Items
-- which withs unit Withed_Id. Return Empty if no such clause is found.
procedure Info_Implicit_Pragma;
pragma Inline (Info_Implicit_Pragma);
-- Output information concerning an implicitly generated Elaborate or
-- Elaborate_All pragma with name Prag_Nam for scenario N which ensures
-- the prior elaboration of unit Unit_Id.
----------------------
-- Find_With_Clause --
----------------------
function Find_With_Clause
(Items : List_Id;
Withed_Id : Entity_Id) return Node_Id
is
Item : Node_Id;
begin
-- Examine the context clauses looking for a suitable with. Note that
-- limited clauses do not affect the elaboration order.
Item := First (Items);
while Present (Item) loop
if Nkind (Item) = N_With_Clause
and then not Error_Posted (Item)
and then not Limited_Present (Item)
and then Entity (Name (Item)) = Withed_Id
then
return Item;
end if;
Next (Item);
end loop;
return Empty;
end Find_With_Clause;
--------------------------
-- Info_Implicit_Pragma --
--------------------------
procedure Info_Implicit_Pragma is
begin
-- Internal units are ignored as they cause unnecessary noise
if not In_Internal_Unit (Unit_Id) then
-- The name of the unit subjected to the elaboration pragma is
-- fully qualified to improve the clarity of the info message.
Error_Msg_Name_1 := Prag_Nam;
Error_Msg_Qual_Level := Nat'Last;
Error_Msg_NE
("info: implicit pragma % generated for unit &", N, Unit_Id);
Error_Msg_Qual_Level := 0;
Output_Active_Scenarios (N);
end if;
end Info_Implicit_Pragma;
-- Local variables
Main_Cunit : constant Node_Id := Cunit (Main_Unit);
Loc : constant Source_Ptr := Sloc (Main_Cunit);
Unit_Cunit : constant Node_Id := Compilation_Unit (Unit_Id);
Is_Instantiation : constant Boolean :=
Nkind (N) in N_Generic_Instantiation;
Clause : Node_Id;
Elab_Attrs : Elaboration_Attributes;
Items : List_Id;
-- Start of processing for Ensure_Static_Prior_Elaboration
begin
Elab_Attrs := Elaboration_Context.Get (Unit_Id);
-- Nothing to do when the unit is guaranteed prior elaboration by means
-- of a source Elaborate[_All] pragma.
if Present (Elab_Attrs.Source_Pragma) then
return;
-- Nothing to do when the unit has an existing implicit Elaborate[_All]
-- pragma installed by a previous scenario.
elsif Present (Elab_Attrs.With_Clause) then
-- The unit is already guaranteed prior elaboration by means of an
-- implicit Elaborate pragma, however the current scenario imposes
-- a stronger requirement of Elaborate_All. "Upgrade" the existing
-- pragma to match this new requirement.
if Elaborate_Desirable (Elab_Attrs.With_Clause)
and then Prag_Nam = Name_Elaborate_All
then
Set_Elaborate_All_Desirable (Elab_Attrs.With_Clause);
Set_Elaborate_Desirable (Elab_Attrs.With_Clause, False);
end if;
return;
end if;
-- At this point it is known that the unit has no prior elaboration
-- according to pragmas and hierarchical relationships.
Items := Context_Items (Main_Cunit);
if No (Items) then
Items := New_List;
Set_Context_Items (Main_Cunit, Items);
end if;
-- Locate the with clause for the unit. Note that there may not be a
-- clause if the unit is visible through a subunit-body, body-spec, or
-- spec-parent relationship.
Clause :=
Find_With_Clause
(Items => Items,
Withed_Id => Unit_Id);
-- Generate:
-- with Id;
-- Note that adding implicit with clauses is safe because analysis,
-- resolution, and expansion have already taken place and it is not
-- possible to interfere with visibility.
if No (Clause) then
Clause :=
Make_With_Clause (Loc,
Name => New_Occurrence_Of (Unit_Id, Loc));
Set_Implicit_With (Clause);
Set_Library_Unit (Clause, Unit_Cunit);
Append_To (Items, Clause);
end if;
-- Instantiations require an implicit Elaborate because Elaborate_All is
-- too conservative and may introduce non-existent elaboration cycles.
if Is_Instantiation then
Set_Elaborate_Desirable (Clause);
-- Otherwise generate an implicit Elaborate_All
else
Set_Elaborate_All_Desirable (Clause);
end if;
-- The implicit Elaborate[_All] ensures the prior elaboration of the
-- unit. Include the unit in the elaboration context of the main unit.
Elaboration_Context.Set (Unit_Id,
Elaboration_Attributes'(Source_Pragma => Empty,
With_Clause => Clause));
-- Output extra information on an implicit Elaborate[_All] pragma when
-- switch -gnatel (info messages on implicit Elaborate[_All] pragmas is
-- in effect.
if Elab_Info_Messages then
Info_Implicit_Pragma;
end if;
end Ensure_Static_Prior_Elaboration;
-----------------------------
-- Extract_Assignment_Name --
-----------------------------
function Extract_Assignment_Name (Asmt : Node_Id) return Node_Id is
Nam : Node_Id;
begin
Nam := Name (Asmt);
-- When the name denotes an array or record component, find the whole
-- object.
while Nkind_In (Nam, N_Explicit_Dereference,
N_Indexed_Component,
N_Selected_Component,
N_Slice)
loop
Nam := Prefix (Nam);
end loop;
return Nam;
end Extract_Assignment_Name;
-----------------------------
-- Extract_Call_Attributes --
-----------------------------
procedure Extract_Call_Attributes
(Call : Node_Id;
Target_Id : out Entity_Id;
Attrs : out Call_Attributes)
is
From_Source : Boolean;
In_Declarations : Boolean;
Is_Dispatching : Boolean;
begin
-- Extraction for call markers
if Nkind (Call) = N_Call_Marker then
Target_Id := Target (Call);
From_Source := Is_Source_Call (Call);
In_Declarations := Is_Declaration_Level_Node (Call);
Is_Dispatching := Is_Dispatching_Call (Call);
-- Extraction for entry calls, requeue, and subprogram calls
else
pragma Assert (Nkind_In (Call, N_Entry_Call_Statement,
N_Function_Call,
N_Procedure_Call_Statement,
N_Requeue_Statement));
Target_Id := Entity (Extract_Call_Name (Call));
From_Source := Comes_From_Source (Call);
-- Performance note: parent traversal
In_Declarations := Find_Enclosing_Level (Call) = Declaration_Level;
Is_Dispatching :=
Nkind_In (Call, N_Function_Call, N_Procedure_Call_Statement)
and then Present (Controlling_Argument (Call));
end if;
-- Obtain the original entry or subprogram which the target may rename
-- except when the target is an instantiation. In this case the alias
-- is the internally generated subprogram which appears within the the
-- anonymous package created for the instantiation. Such an alias is not
-- a suitable target.
if not (Is_Subprogram (Target_Id)
and then Is_Generic_Instance (Target_Id))
then
Target_Id := Get_Renamed_Entity (Target_Id);
end if;
-- Set all attributes
Attrs.Elab_Checks_OK := Is_Elaboration_Checks_OK_Node (Call);
Attrs.From_Source := From_Source;
Attrs.Ghost_Mode_Ignore := Is_Ignored_Ghost_Node (Call);
Attrs.In_Declarations := In_Declarations;
Attrs.Is_Dispatching := Is_Dispatching;
Attrs.SPARK_Mode_On := Is_SPARK_Mode_On_Node (Call);
end Extract_Call_Attributes;
-----------------------
-- Extract_Call_Name --
-----------------------
function Extract_Call_Name (Call : Node_Id) return Node_Id is
Nam : Node_Id;
begin
Nam := Name (Call);
-- When the call invokes an entry family, the name appears as an indexed
-- component.
if Nkind (Nam) = N_Indexed_Component then
Nam := Prefix (Nam);
end if;
-- When the call employs the object.operation form, the name appears as
-- a selected component.
if Nkind (Nam) = N_Selected_Component then
Nam := Selector_Name (Nam);
end if;
return Nam;
end Extract_Call_Name;
---------------------------------
-- Extract_Instance_Attributes --
---------------------------------
procedure Extract_Instance_Attributes
(Exp_Inst : Node_Id;
Inst_Body : out Node_Id;
Inst_Decl : out Node_Id)
is
Body_Id : Entity_Id;
begin
-- Assume that the attributes are unavailable
Inst_Body := Empty;
Inst_Decl := Empty;
-- Generic package or subprogram spec
if Nkind_In (Exp_Inst, N_Package_Declaration,
N_Subprogram_Declaration)
then
Inst_Decl := Exp_Inst;
Body_Id := Corresponding_Body (Inst_Decl);
if Present (Body_Id) then
Inst_Body := Unit_Declaration_Node (Body_Id);
end if;
-- Generic package or subprogram body
else
pragma Assert
(Nkind_In (Exp_Inst, N_Package_Body, N_Subprogram_Body));
Inst_Body := Exp_Inst;
Inst_Decl := Unit_Declaration_Node (Corresponding_Spec (Inst_Body));
end if;
end Extract_Instance_Attributes;
--------------------------------------
-- Extract_Instantiation_Attributes --
--------------------------------------
procedure Extract_Instantiation_Attributes
(Exp_Inst : Node_Id;
Inst : out Node_Id;
Inst_Id : out Entity_Id;
Gen_Id : out Entity_Id;
Attrs : out Instantiation_Attributes)
is
begin
Inst := Original_Node (Exp_Inst);
Inst_Id := Defining_Entity (Inst);
-- Traverse a possible chain of renamings to obtain the original generic
-- being instantiatied.
Gen_Id := Get_Renamed_Entity (Entity (Name (Inst)));
-- Set all attributes
Attrs.Elab_Checks_OK := Is_Elaboration_Checks_OK_Node (Inst);
Attrs.Ghost_Mode_Ignore := Is_Ignored_Ghost_Node (Inst);
Attrs.In_Declarations := Is_Declaration_Level_Node (Inst);
Attrs.SPARK_Mode_On := Is_SPARK_Mode_On_Node (Inst);
end Extract_Instantiation_Attributes;
-------------------------------
-- Extract_Target_Attributes --
-------------------------------
procedure Extract_Target_Attributes
(Target_Id : Entity_Id;
Attrs : out Target_Attributes)
is
procedure Extract_Package_Or_Subprogram_Attributes
(Spec_Id : out Entity_Id;
Body_Decl : out Node_Id);
-- Obtain the attributes associated with a package or a subprogram.
-- Spec_Id is the package or subprogram. Body_Decl is the declaration
-- of the corresponding package or subprogram body.
procedure Extract_Protected_Entry_Attributes
(Spec_Id : out Entity_Id;
Body_Decl : out Node_Id;
Body_Barf : out Node_Id);
-- Obtain the attributes associated with a protected entry [family].
-- Spec_Id is the entity of the protected body subprogram. Body_Decl
-- is the declaration of Spec_Id's corresponding body. Body_Barf is
-- the declaration of the barrier function body.
procedure Extract_Protected_Subprogram_Attributes
(Spec_Id : out Entity_Id;
Body_Decl : out Node_Id);
-- Obtain the attributes associated with a protected subprogram. Formal
-- Spec_Id is the entity of the protected body subprogram. Body_Decl is
-- the declaration of Spec_Id's corresponding body.
procedure Extract_Task_Entry_Attributes
(Spec_Id : out Entity_Id;
Body_Decl : out Node_Id);
-- Obtain the attributes associated with a task entry [family]. Formal
-- Spec_Id is the entity of the task body procedure. Body_Decl is the
-- declaration of Spec_Id's corresponding body.
----------------------------------------------
-- Extract_Package_Or_Subprogram_Attributes --
----------------------------------------------
procedure Extract_Package_Or_Subprogram_Attributes
(Spec_Id : out Entity_Id;
Body_Decl : out Node_Id)
is
Body_Id : Entity_Id;
Init_Id : Entity_Id;
Spec_Decl : Node_Id;
begin
-- Assume that the body is not available
Body_Decl := Empty;
Spec_Id := Target_Id;
-- For body retrieval purposes, the entity of the initial declaration
-- is that of the spec.
Init_Id := Spec_Id;
-- The only exception to the above is a function which returns a
-- constrained array type in a SPARK-to-C compilation. In this case
-- the function receives a corresponding procedure which has an out
-- parameter. The proper body for ABE checks and diagnostics is that
-- of the procedure.
if Ekind (Init_Id) = E_Function
and then Rewritten_For_C (Init_Id)
then
Init_Id := Corresponding_Procedure (Init_Id);
end if;
-- Extract the attributes of the body
Spec_Decl := Unit_Declaration_Node (Init_Id);
-- The initial declaration is a stand alone subprogram body
if Nkind (Spec_Decl) = N_Subprogram_Body then
Body_Decl := Spec_Decl;
-- Otherwise the package or subprogram has a spec and a completing
-- body.
elsif Nkind_In (Spec_Decl, N_Generic_Package_Declaration,
N_Generic_Subprogram_Declaration,
N_Package_Declaration,
N_Subprogram_Body_Stub,
N_Subprogram_Declaration)
then
Body_Id := Corresponding_Body (Spec_Decl);
if Present (Body_Id) then
Body_Decl := Unit_Declaration_Node (Body_Id);
end if;
end if;
end Extract_Package_Or_Subprogram_Attributes;
----------------------------------------
-- Extract_Protected_Entry_Attributes --
----------------------------------------
procedure Extract_Protected_Entry_Attributes
(Spec_Id : out Entity_Id;
Body_Decl : out Node_Id;
Body_Barf : out Node_Id)
is
Barf_Id : Entity_Id;
Body_Id : Entity_Id;
begin
-- Assume that the bodies are not available
Body_Barf := Empty;
Body_Decl := Empty;
-- When the entry [family] has already been expanded, it carries both
-- the procedure which emulates the behavior of the entry [family] as
-- well as the barrier function.
if Present (Protected_Body_Subprogram (Target_Id)) then
Spec_Id := Protected_Body_Subprogram (Target_Id);
-- Extract the attributes of the barrier function
Barf_Id :=
Corresponding_Body
(Unit_Declaration_Node (Barrier_Function (Target_Id)));
if Present (Barf_Id) then
Body_Barf := Unit_Declaration_Node (Barf_Id);
end if;
-- Otherwise no expansion took place
else
Spec_Id := Target_Id;
end if;
-- Extract the attributes of the entry body
Body_Id := Corresponding_Body (Unit_Declaration_Node (Spec_Id));
if Present (Body_Id) then
Body_Decl := Unit_Declaration_Node (Body_Id);
end if;
end Extract_Protected_Entry_Attributes;
---------------------------------------------
-- Extract_Protected_Subprogram_Attributes --
---------------------------------------------
procedure Extract_Protected_Subprogram_Attributes
(Spec_Id : out Entity_Id;
Body_Decl : out Node_Id)
is
Body_Id : Entity_Id;
begin
-- Assume that the body is not available
Body_Decl := Empty;
-- When the protected subprogram has already been expanded, it
-- carries the subprogram which seizes the lock and invokes the
-- original statements.
if Present (Protected_Subprogram (Target_Id)) then
Spec_Id :=
Protected_Body_Subprogram (Protected_Subprogram (Target_Id));
-- Otherwise no expansion took place
else
Spec_Id := Target_Id;
end if;
-- Extract the attributes of the body
Body_Id := Corresponding_Body (Unit_Declaration_Node (Spec_Id));
if Present (Body_Id) then
Body_Decl := Unit_Declaration_Node (Body_Id);
end if;
end Extract_Protected_Subprogram_Attributes;
-----------------------------------
-- Extract_Task_Entry_Attributes --
-----------------------------------
procedure Extract_Task_Entry_Attributes
(Spec_Id : out Entity_Id;
Body_Decl : out Node_Id)
is
Task_Typ : constant Entity_Id := Non_Private_View (Scope (Target_Id));
Body_Id : Entity_Id;
begin
-- Assume that the body is not available
Body_Decl := Empty;
-- The the task type has already been expanded, it carries the
-- procedure which emulates the behavior of the task body.
if Present (Task_Body_Procedure (Task_Typ)) then
Spec_Id := Task_Body_Procedure (Task_Typ);
-- Otherwise no expansion took place
else
Spec_Id := Task_Typ;
end if;
-- Extract the attributes of the body
Body_Id := Corresponding_Body (Unit_Declaration_Node (Spec_Id));
if Present (Body_Id) then
Body_Decl := Unit_Declaration_Node (Body_Id);
end if;
end Extract_Task_Entry_Attributes;
-- Local variables
Prag : constant Node_Id := SPARK_Pragma (Target_Id);
Body_Barf : Node_Id;
Body_Decl : Node_Id;
Spec_Id : Entity_Id;
-- Start of processing for Extract_Target_Attributes
begin
-- Assume that the body of the barrier function is not available
Body_Barf := Empty;
-- The target is a protected entry [family]
if Is_Protected_Entry (Target_Id) then
Extract_Protected_Entry_Attributes
(Spec_Id => Spec_Id,
Body_Decl => Body_Decl,
Body_Barf => Body_Barf);
-- The target is a protected subprogram
elsif Is_Protected_Subp (Target_Id)
or else Is_Protected_Body_Subp (Target_Id)
then
Extract_Protected_Subprogram_Attributes
(Spec_Id => Spec_Id,
Body_Decl => Body_Decl);
-- The target is a task entry [family]
elsif Is_Task_Entry (Target_Id) then
Extract_Task_Entry_Attributes
(Spec_Id => Spec_Id,
Body_Decl => Body_Decl);
-- Otherwise the target is a package or a subprogram
else
Extract_Package_Or_Subprogram_Attributes
(Spec_Id => Spec_Id,
Body_Decl => Body_Decl);
end if;
-- Set all attributes
Attrs.Body_Barf := Body_Barf;
Attrs.Body_Decl := Body_Decl;
Attrs.Elab_Checks_OK := Is_Elaboration_Checks_OK_Id (Target_Id);
Attrs.From_Source := Comes_From_Source (Target_Id);
Attrs.Ghost_Mode_Ignore := Is_Ignored_Ghost_Entity (Target_Id);
Attrs.SPARK_Mode_On :=
Present (Prag) and then Get_SPARK_Mode_From_Annotation (Prag) = On;
Attrs.Spec_Decl := Unit_Declaration_Node (Spec_Id);
Attrs.Spec_Id := Spec_Id;
Attrs.Unit_Id := Find_Top_Unit (Target_Id);
-- At this point certain attributes should always be available
pragma Assert (Present (Attrs.Spec_Decl));
pragma Assert (Present (Attrs.Spec_Id));
pragma Assert (Present (Attrs.Unit_Id));
end Extract_Target_Attributes;
-----------------------------
-- Extract_Task_Attributes --
-----------------------------
procedure Extract_Task_Attributes
(Typ : Entity_Id;
Attrs : out Task_Attributes)
is
Task_Typ : constant Entity_Id := Non_Private_View (Typ);
Body_Decl : Node_Id;
Body_Id : Entity_Id;
Prag : Node_Id;
Spec_Id : Entity_Id;
begin
-- Assume that the body of the task procedure is not available
Body_Decl := Empty;
-- The initial declaration is that of the task body procedure
Spec_Id := Get_Task_Body_Procedure (Task_Typ);
Body_Id := Corresponding_Body (Unit_Declaration_Node (Spec_Id));
if Present (Body_Id) then
Body_Decl := Unit_Declaration_Node (Body_Id);
end if;
Prag := SPARK_Pragma (Task_Typ);
-- Set all attributes
Attrs.Body_Decl := Body_Decl;
Attrs.Elab_Checks_OK := Is_Elaboration_Checks_OK_Id (Task_Typ);
Attrs.Ghost_Mode_Ignore := Is_Ignored_Ghost_Entity (Task_Typ);
Attrs.SPARK_Mode_On :=
Present (Prag) and then Get_SPARK_Mode_From_Annotation (Prag) = On;
Attrs.Spec_Id := Spec_Id;
Attrs.Task_Decl := Declaration_Node (Task_Typ);
Attrs.Unit_Id := Find_Top_Unit (Task_Typ);
-- At this point certain attributes should always be available
pragma Assert (Present (Attrs.Spec_Id));
pragma Assert (Present (Attrs.Task_Decl));
pragma Assert (Present (Attrs.Unit_Id));
end Extract_Task_Attributes;
-------------------------------------------
-- Extract_Variable_Reference_Attributes --
-------------------------------------------
procedure Extract_Variable_Reference_Attributes
(Ref : Node_Id;
Var_Id : out Entity_Id;
Attrs : out Variable_Attributes)
is
begin
-- Traverse a possible chain of renamings to obtain the original
-- variable being referenced.
Var_Id := Get_Renamed_Entity (Entity (Ref));
Attrs.SPARK_Mode_On := Is_SPARK_Mode_On_Node (Ref);
Attrs.Unit_Id := Find_Top_Unit (Var_Id);
-- At this point certain attributes should always be available
pragma Assert (Present (Attrs.Unit_Id));
end Extract_Variable_Reference_Attributes;
--------------------
-- Find_Code_Unit --
--------------------
function Find_Code_Unit (N : Node_Or_Entity_Id) return Entity_Id is
N_Unit : constant Node_Id := Unit (Cunit (Get_Code_Unit (N)));
begin
return Defining_Entity (N_Unit, Concurrent_Subunit => True);
end Find_Code_Unit;
---------------------------
-- Find_Elaborated_Units --
---------------------------
procedure Find_Elaborated_Units is
procedure Add_Pragma (Prag : Node_Id);
-- Determine whether pragma Prag denotes a legal Elaborate[_All] pragma.
-- If this is the case, add the related unit to the elaboration context.
-- For pragma Elaborate_All, include recursively all units withed by the
-- related unit.
procedure Add_Unit
(Unit_Id : Entity_Id;
Prag : Node_Id;
Full_Context : Boolean);
-- Add unit Unit_Id to the elaboration context. Prag denotes the pragma
-- which prompted the inclusion of the unit to the elaboration context.
-- If flag Full_Context is set, examine the non-limited clauses of unit
-- Unit_Id and add each withed unit to the context.
procedure Find_Elaboration_Context (Comp_Unit : Node_Id);
-- Examine the context items of compilation unit Comp_Unit for suitable
-- elaboration-related pragmas and add all related units to the context.
----------------
-- Add_Pragma --
----------------
procedure Add_Pragma (Prag : Node_Id) is
Prag_Args : constant List_Id := Pragma_Argument_Associations (Prag);
Prag_Nam : constant Name_Id := Pragma_Name (Prag);
Unit_Arg : Node_Id;
begin
-- Nothing to do if the pragma is not related to elaboration
if not Nam_In (Prag_Nam, Name_Elaborate, Name_Elaborate_All) then
return;
-- Nothing to do when the pragma is illegal
elsif Error_Posted (Prag) then
return;
end if;
Unit_Arg := Get_Pragma_Arg (First (Prag_Args));
-- The argument of the pragma may appear in package.package form
if Nkind (Unit_Arg) = N_Selected_Component then
Unit_Arg := Selector_Name (Unit_Arg);
end if;
Add_Unit
(Unit_Id => Entity (Unit_Arg),
Prag => Prag,
Full_Context => Prag_Nam = Name_Elaborate_All);
end Add_Pragma;
--------------
-- Add_Unit --
--------------
procedure Add_Unit
(Unit_Id : Entity_Id;
Prag : Node_Id;
Full_Context : Boolean)
is
Clause : Node_Id;
Elab_Attrs : Elaboration_Attributes;
begin
-- Nothing to do when some previous error left a with clause or a
-- pragma in a bad state.
if No (Unit_Id) then
return;
end if;
Elab_Attrs := Elaboration_Context.Get (Unit_Id);
-- The current unit is not part of the context. Prepare a new set of
-- attributes.
if Elab_Attrs = No_Elaboration_Attributes then
Elab_Attrs :=
Elaboration_Attributes'(Source_Pragma => Prag,
With_Clause => Empty);
-- The unit is already included in the context by means of pragma
-- Elaborate. "Upgrage" the existing attributes when the unit is
-- subject to Elaborate_All because the new pragma covers a larger
-- set of units. All other properties remain the same.
elsif Pragma_Name (Elab_Attrs.Source_Pragma) = Name_Elaborate
and then Pragma_Name (Prag) = Name_Elaborate_All
then
Elab_Attrs.Source_Pragma := Prag;
-- Otherwise the unit is already included in the context
else
return;
end if;
-- Add or update the attributes of the unit
Elaboration_Context.Set (Unit_Id, Elab_Attrs);
-- Includes all units withed by the current one when computing the
-- full context.
if Full_Context then
-- Process all non-limited with clauses found in the context of
-- the current unit. Note that limited clauses do not impose an
-- elaboration order.
Clause := First (Context_Items (Compilation_Unit (Unit_Id)));
while Present (Clause) loop
if Nkind (Clause) = N_With_Clause
and then not Error_Posted (Clause)
and then not Limited_Present (Clause)
then
Add_Unit
(Unit_Id => Entity (Name (Clause)),
Prag => Prag,
Full_Context => Full_Context);
end if;
Next (Clause);
end loop;
end if;
end Add_Unit;
------------------------------
-- Find_Elaboration_Context --
------------------------------
procedure Find_Elaboration_Context (Comp_Unit : Node_Id) is
Prag : Node_Id;
begin
pragma Assert (Nkind (Comp_Unit) = N_Compilation_Unit);
-- Process all elaboration-related pragmas found in the context of
-- the compilation unit.
Prag := First (Context_Items (Comp_Unit));
while Present (Prag) loop
if Nkind (Prag) = N_Pragma then
Add_Pragma (Prag);
end if;
Next (Prag);
end loop;
end Find_Elaboration_Context;
-- Local variables
Par_Id : Entity_Id;
Unt : Node_Id;
-- Start of processing for Find_Elaborated_Units
begin
-- Perform a traversal which examines the context of the main unit and
-- populates the Elaboration_Context table with all units elaborated
-- prior to the main unit. The traversal performs the following jumps:
-- subunit -> parent subunit
-- parent subunit -> body
-- body -> spec
-- spec -> parent spec
-- parent spec -> grandparent spec and so on
-- The traversal relies on units rather than scopes because the scope of
-- a subunit is some spec, while this traversal must process the body as
-- well. Given that protected and task bodies can also be subunits, this
-- complicates the scope approach even further.
Unt := Unit (Cunit (Main_Unit));
-- Perform the following traversals when the main unit is a subunit
-- subunit -> parent subunit
-- parent subunit -> body
while Present (Unt) and then Nkind (Unt) = N_Subunit loop
Find_Elaboration_Context (Parent (Unt));
-- Continue the traversal by going to the unit which contains the
-- corresponding stub.
if Present (Corresponding_Stub (Unt)) then
Unt := Unit (Cunit (Get_Source_Unit (Corresponding_Stub (Unt))));
-- Otherwise the subunit may be erroneous or left in a bad state
else
exit;
end if;
end loop;
-- Perform the following traversal now that subunits have been taken
-- care of, or the main unit is a body.
-- body -> spec
if Present (Unt)
and then Nkind_In (Unt, N_Package_Body, N_Subprogram_Body)
then
Find_Elaboration_Context (Parent (Unt));
-- Continue the traversal by going to the unit which contains the
-- corresponding spec.
if Present (Corresponding_Spec (Unt)) then
Unt := Unit (Cunit (Get_Source_Unit (Corresponding_Spec (Unt))));
end if;
end if;
-- Perform the following traversals now that the body has been taken
-- care of, or the main unit is a spec.
-- spec -> parent spec
-- parent spec -> grandparent spec and so on
if Present (Unt)
and then Nkind_In (Unt, N_Generic_Package_Declaration,
N_Generic_Subprogram_Declaration,
N_Package_Declaration,
N_Subprogram_Declaration)
then
Find_Elaboration_Context (Parent (Unt));
-- Process a potential chain of parent units which ends with the
-- main unit spec. The traversal can now safely rely on the scope
-- chain.
Par_Id := Scope (Defining_Entity (Unt));
while Present (Par_Id) and then Par_Id /= Standard_Standard loop
Find_Elaboration_Context (Compilation_Unit (Par_Id));
Par_Id := Scope (Par_Id);
end loop;
end if;
end Find_Elaborated_Units;
-----------------------------
-- Find_Enclosing_Instance --
-----------------------------
function Find_Enclosing_Instance (N : Node_Id) return Node_Id is
Par : Node_Id;
Spec_Id : Entity_Id;
begin
-- Climb the parent chain looking for an enclosing instance spec or body
Par := N;
while Present (Par) loop
-- Generic package or subprogram spec
if Nkind_In (Par, N_Package_Declaration,
N_Subprogram_Declaration)
and then Is_Generic_Instance (Defining_Entity (Par))
then
return Par;
-- Generic package or subprogram body
elsif Nkind_In (Par, N_Package_Body, N_Subprogram_Body) then
Spec_Id := Corresponding_Spec (Par);
if Present (Spec_Id) and then Is_Generic_Instance (Spec_Id) then
return Par;
end if;
end if;
Par := Parent (Par);
end loop;
return Empty;
end Find_Enclosing_Instance;
--------------------------
-- Find_Enclosing_Level --
--------------------------
function Find_Enclosing_Level (N : Node_Id) return Enclosing_Level_Kind is
function Level_Of (Unit : Node_Id) return Enclosing_Level_Kind;
-- Obtain the corresponding level of unit Unit
--------------
-- Level_Of --
--------------
function Level_Of (Unit : Node_Id) return Enclosing_Level_Kind is
Spec_Id : Entity_Id;
begin
if Nkind (Unit) in N_Generic_Instantiation then
return Instantiation;
elsif Nkind (Unit) = N_Generic_Package_Declaration then
return Generic_Package_Spec;
elsif Nkind (Unit) = N_Package_Declaration then
return Package_Spec;
elsif Nkind (Unit) = N_Package_Body then
Spec_Id := Corresponding_Spec (Unit);
-- The body belongs to a generic package
if Present (Spec_Id)
and then Ekind (Spec_Id) = E_Generic_Package
then
return Generic_Package_Body;
-- Otherwise the body belongs to a non-generic package. This also
-- treats an illegal package body without a corresponding spec as
-- a non-generic package body.
else
return Package_Body;
end if;
end if;
return No_Level;
end Level_Of;
-- Local variables
Context : Node_Id;
Curr : Node_Id;
Prev : Node_Id;
-- Start of processing for Find_Enclosing_Level
begin
-- Call markers and instantiations which appear at the declaration level
-- but are later relocated in a different context retain their original
-- declaration level.
if Nkind_In (N, N_Call_Marker,
N_Function_Instantiation,
N_Package_Instantiation,
N_Procedure_Instantiation)
and then Is_Declaration_Level_Node (N)
then
return Declaration_Level;
end if;
-- Climb the parent chain looking at the enclosing levels
Prev := N;
Curr := Parent (Prev);
while Present (Curr) loop
-- A traversal from a subunit continues via the corresponding stub
if Nkind (Curr) = N_Subunit then
Curr := Corresponding_Stub (Curr);
-- The current construct is a package. Packages are ignored because
-- they are always elaborated when the enclosing context is invoked
-- or elaborated.
elsif Nkind_In (Curr, N_Package_Body, N_Package_Declaration) then
null;
-- The current construct is a block statement
elsif Nkind (Curr) = N_Block_Statement then
-- Ignore internally generated blocks created by the expander for
-- various purposes such as abort defer/undefer.
if not Comes_From_Source (Curr) then
null;
-- If the traversal came from the handled sequence of statments,
-- then the node appears at the level of the enclosing construct.
-- This is a more reliable test because transients scopes within
-- the declarative region of the encapsulator are hard to detect.
elsif Nkind (Prev) = N_Handled_Sequence_Of_Statements
and then Handled_Statement_Sequence (Curr) = Prev
then
return Find_Enclosing_Level (Parent (Curr));
-- Otherwise the traversal came from the declarations, the node is
-- at the declaration level.
else
return Declaration_Level;
end if;
-- The current construct is a declaration level encapsulator
elsif Nkind_In (Curr, N_Entry_Body,
N_Subprogram_Body,
N_Task_Body)
then
-- If the traversal came from the handled sequence of statments,
-- then the node cannot possibly appear at any level. This is
-- a more reliable test because transients scopes within the
-- declarative region of the encapsulator are hard to detect.
if Nkind (Prev) = N_Handled_Sequence_Of_Statements
and then Handled_Statement_Sequence (Curr) = Prev
then
return No_Level;
-- Otherwise the traversal came from the declarations, the node is
-- at the declaration level.
else
return Declaration_Level;
end if;
-- The current construct is a non-library level encapsulator which
-- indicates that the node cannot possibly appear at any level.
-- Note that this check must come after the declaration level check
-- because both predicates share certain nodes.
elsif Is_Non_Library_Level_Encapsulator (Curr) then
Context := Parent (Curr);
-- The sole exception is when the encapsulator is the compilation
-- utit itself because the compilation unit node requires special
-- processing (see below).
if Present (Context)
and then Nkind (Context) = N_Compilation_Unit
then
null;
-- Otherwise the node is not at any level
else
return No_Level;
end if;
-- The current construct is a compilation unit. The node appears at
-- the [generic] library level when the unit is a [generic] package.
elsif Nkind (Curr) = N_Compilation_Unit then
return Level_Of (Unit (Curr));
end if;
Prev := Curr;
Curr := Parent (Prev);
end loop;
return No_Level;
end Find_Enclosing_Level;
-------------------
-- Find_Top_Unit --
-------------------
function Find_Top_Unit (N : Node_Or_Entity_Id) return Entity_Id is
N_Unit : constant Node_Id := Unit (Cunit (Get_Top_Level_Code_Unit (N)));
begin
return Defining_Entity (N_Unit, Concurrent_Subunit => True);
end Find_Top_Unit;
-----------------------
-- First_Formal_Type --
-----------------------
function First_Formal_Type (Subp_Id : Entity_Id) return Entity_Id is
Formal_Id : constant Entity_Id := First_Formal (Subp_Id);
Typ : Entity_Id;
begin
if Present (Formal_Id) then
Typ := Etype (Formal_Id);
-- Handle various combinations of concurrent and private types
loop
if Ekind_In (Typ, E_Protected_Type, E_Task_Type)
and then Present (Anonymous_Object (Typ))
then
Typ := Anonymous_Object (Typ);
elsif Is_Concurrent_Record_Type (Typ) then
Typ := Corresponding_Concurrent_Type (Typ);
elsif Is_Private_Type (Typ) and then Present (Full_View (Typ)) then
Typ := Full_View (Typ);
else
exit;
end if;
end loop;
return Typ;
end if;
return Empty;
end First_Formal_Type;
--------------
-- Has_Body --
--------------
function Has_Body (Pack_Decl : Node_Id) return Boolean is
function Find_Corresponding_Body (Spec_Id : Entity_Id) return Node_Id;
-- Try to locate the corresponding body of spec Spec_Id. If no body is
-- found, return Empty.
function Find_Body
(Spec_Id : Entity_Id;
From : Node_Id) return Node_Id;
-- Try to locate the corresponding body of spec Spec_Id in the node list
-- which follows arbitrary node From. If no body is found, return Empty.
function Load_Package_Body (Unit_Nam : Unit_Name_Type) return Node_Id;
-- Attempt to load the body of unit Unit_Nam. If the load failed, return
-- Empty. If the compilation will not generate code, return Empty.
-----------------------------
-- Find_Corresponding_Body --
-----------------------------
function Find_Corresponding_Body (Spec_Id : Entity_Id) return Node_Id is
Context : constant Entity_Id := Scope (Spec_Id);
Spec_Decl : constant Node_Id := Unit_Declaration_Node (Spec_Id);
Body_Decl : Node_Id;
Body_Id : Entity_Id;
begin
if Is_Compilation_Unit (Spec_Id) then
Body_Id := Corresponding_Body (Spec_Decl);
if Present (Body_Id) then
return Unit_Declaration_Node (Body_Id);
-- The package is at the library and requires a body. Load the
-- corresponding body because the optional body may be declared
-- there.
elsif Unit_Requires_Body (Spec_Id) then
return
Load_Package_Body
(Get_Body_Name (Unit_Name (Get_Source_Unit (Spec_Decl))));
-- Otherwise there is no optional body
else
return Empty;
end if;
-- The immediate context is a package. The optional body may be
-- within the body of that package.
-- procedure Proc is
-- package Nested_1 is
-- package Nested_2 is
-- generic
-- package Pack is
-- end Pack;
-- end Nested_2;
-- end Nested_1;
-- package body Nested_1 is
-- package body Nested_2 is separate;
-- end Nested_1;
-- separate (Proc.Nested_1.Nested_2)
-- package body Nested_2 is
-- package body Pack is -- optional body
-- ...
-- end Pack;
-- end Nested_2;
elsif Is_Package_Or_Generic_Package (Context) then
Body_Decl := Find_Corresponding_Body (Context);
-- The optional body is within the body of the enclosing package
if Present (Body_Decl) then
return
Find_Body
(Spec_Id => Spec_Id,
From => First (Declarations (Body_Decl)));
-- Otherwise the enclosing package does not have a body. This may
-- be the result of an error or a genuine lack of a body.
else
return Empty;
end if;
-- Otherwise the immediate context is a body. The optional body may
-- be within the same list as the spec.
-- procedure Proc is
-- generic
-- package Pack is
-- end Pack;
-- package body Pack is -- optional body
-- ...
-- end Pack;
else
return
Find_Body
(Spec_Id => Spec_Id,
From => Next (Spec_Decl));
end if;
end Find_Corresponding_Body;
---------------
-- Find_Body --
---------------
function Find_Body
(Spec_Id : Entity_Id;
From : Node_Id) return Node_Id
is
Spec_Nam : constant Name_Id := Chars (Spec_Id);
Item : Node_Id;
Lib_Unit : Node_Id;
begin
Item := From;
while Present (Item) loop
-- The current item denotes the optional body
if Nkind (Item) = N_Package_Body
and then Chars (Defining_Entity (Item)) = Spec_Nam
then
return Item;
-- The current item denotes a stub, the optional body may be in
-- the subunit.
elsif Nkind (Item) = N_Package_Body_Stub
and then Chars (Defining_Entity (Item)) = Spec_Nam
then
Lib_Unit := Library_Unit (Item);
-- The corresponding subunit was previously loaded
if Present (Lib_Unit) then
return Lib_Unit;
-- Otherwise attempt to load the corresponding subunit
else
return Load_Package_Body (Get_Unit_Name (Item));
end if;
end if;
Next (Item);
end loop;
return Empty;
end Find_Body;
-----------------------
-- Load_Package_Body --
-----------------------
function Load_Package_Body (Unit_Nam : Unit_Name_Type) return Node_Id is
Body_Decl : Node_Id;
Unit_Num : Unit_Number_Type;
begin
-- The load is performed only when the compilation will generate code
if Operating_Mode = Generate_Code then
Unit_Num :=
Load_Unit
(Load_Name => Unit_Nam,
Required => False,
Subunit => False,
Error_Node => Pack_Decl);
-- The load failed most likely because the physical file is
-- missing.
if Unit_Num = No_Unit then
return Empty;
-- Otherwise the load was successful, return the body of the unit
else
Body_Decl := Unit (Cunit (Unit_Num));
-- If the unit is a subunit with an available proper body,
-- return the proper body.
if Nkind (Body_Decl) = N_Subunit
and then Present (Proper_Body (Body_Decl))
then
Body_Decl := Proper_Body (Body_Decl);
end if;
return Body_Decl;
end if;
end if;
return Empty;
end Load_Package_Body;
-- Local variables
Pack_Id : constant Entity_Id := Defining_Entity (Pack_Decl);
-- Start of processing for Has_Body
begin
-- The body is available
if Present (Corresponding_Body (Pack_Decl)) then
return True;
-- The body is required if the package spec contains a construct which
-- requires a completion in a body.
elsif Unit_Requires_Body (Pack_Id) then
return True;
-- The body may be optional
else
return Present (Find_Corresponding_Body (Pack_Id));
end if;
end Has_Body;
---------------------------
-- Has_Prior_Elaboration --
---------------------------
function Has_Prior_Elaboration
(Unit_Id : Entity_Id;
Context_OK : Boolean := False;
Elab_Body_OK : Boolean := False;
Same_Unit_OK : Boolean := False) return Boolean
is
Main_Id : constant Entity_Id := Cunit_Entity (Main_Unit);
begin
-- A preelaborated unit is always elaborated prior to the main unit
if Is_Preelaborated_Unit (Unit_Id) then
return True;
-- An internal unit is always elaborated prior to a non-internal main
-- unit.
elsif In_Internal_Unit (Unit_Id)
and then not In_Internal_Unit (Main_Id)
then
return True;
-- A unit has prior elaboration if it appears within the context of the
-- main unit. Consider this case only when requested by the caller.
elsif Context_OK
and then Elaboration_Context.Get (Unit_Id) /= No_Elaboration_Attributes
then
return True;
-- A unit whose body is elaborated together with its spec has prior
-- elaboration except with respect to itself. Consider this case only
-- when requested by the caller.
elsif Elab_Body_OK
and then Has_Pragma_Elaborate_Body (Unit_Id)
and then not Is_Same_Unit (Unit_Id, Main_Id)
then
return True;
-- A unit has no prior elaboration with respect to itself, but does not
-- require any means of ensuring its own elaboration either. Treat this
-- case as valid prior elaboration only when requested by the caller.
elsif Same_Unit_OK and then Is_Same_Unit (Unit_Id, Main_Id) then
return True;
end if;
return False;
end Has_Prior_Elaboration;
--------------------------
-- In_External_Instance --
--------------------------
function In_External_Instance
(N : Node_Id;
Target_Decl : Node_Id) return Boolean
is
Dummy : Node_Id;
Inst_Body : Node_Id;
Inst_Decl : Node_Id;
begin
-- Performance note: parent traversal
Inst_Decl := Find_Enclosing_Instance (Target_Decl);
-- The target declaration appears within an instance spec. Visibility is
-- ignored because internally generated primitives for private types may
-- reside in the private declarations and still be invoked from outside.
if Present (Inst_Decl)
and then Nkind (Inst_Decl) = N_Package_Declaration
then
-- The scenario comes from the main unit and the instance does not
if In_Extended_Main_Code_Unit (N)
and then not In_Extended_Main_Code_Unit (Inst_Decl)
then
return True;
-- Otherwise the scenario must not appear within the instance spec or
-- body.
else
Extract_Instance_Attributes
(Exp_Inst => Inst_Decl,
Inst_Body => Inst_Body,
Inst_Decl => Dummy);
-- Performance note: parent traversal
return not In_Subtree
(N => N,
Root1 => Inst_Decl,
Root2 => Inst_Body);
end if;
end if;
return False;
end In_External_Instance;
---------------------
-- In_Main_Context --
---------------------
function In_Main_Context (N : Node_Id) return Boolean is
begin
-- Scenarios outside the main unit are not considered because the ALI
-- information supplied to binde is for the main unit only.
if not In_Extended_Main_Code_Unit (N) then
return False;
-- Scenarios within internal units are not considered unless switch
-- -gnatdE (elaboration checks on predefined units) is in effect.
elsif not Debug_Flag_EE and then In_Internal_Unit (N) then
return False;
end if;
return True;
end In_Main_Context;
---------------------
-- In_Same_Context --
---------------------
function In_Same_Context
(N1 : Node_Id;
N2 : Node_Id;
Nested_OK : Boolean := False) return Boolean
is
function Find_Enclosing_Context (N : Node_Id) return Node_Id;
-- Return the nearest enclosing non-library level or compilation unit
-- node which which encapsulates arbitrary node N. Return Empty is no
-- such context is available.
function In_Nested_Context
(Outer : Node_Id;
Inner : Node_Id) return Boolean;
-- Determine whether arbitrary node Outer encapsulates arbitrary node
-- Inner.
----------------------------
-- Find_Enclosing_Context --
----------------------------
function Find_Enclosing_Context (N : Node_Id) return Node_Id is
Context : Node_Id;
Par : Node_Id;
begin
Par := Parent (N);
while Present (Par) loop
-- A traversal from a subunit continues via the corresponding stub
if Nkind (Par) = N_Subunit then
Par := Corresponding_Stub (Par);
-- Stop the traversal when the nearest enclosing non-library level
-- encapsulator has been reached.
elsif Is_Non_Library_Level_Encapsulator (Par) then
Context := Parent (Par);
-- The sole exception is when the encapsulator is the unit of
-- compilation because this case requires special processing
-- (see below).
if Present (Context)
and then Nkind (Context) = N_Compilation_Unit
then
null;
else
return Par;
end if;
-- Reaching a compilation unit node without hitting a non-library
-- level encapsulator indicates that N is at the library level in
-- which case the compilation unit is the context.
elsif Nkind (Par) = N_Compilation_Unit then
return Par;
end if;
Par := Parent (Par);
end loop;
return Empty;
end Find_Enclosing_Context;
-----------------------
-- In_Nested_Context --
-----------------------
function In_Nested_Context
(Outer : Node_Id;
Inner : Node_Id) return Boolean
is
Par : Node_Id;
begin
Par := Inner;
while Present (Par) loop
-- A traversal from a subunit continues via the corresponding stub
if Nkind (Par) = N_Subunit then
Par := Corresponding_Stub (Par);
elsif Par = Outer then
return True;
end if;
Par := Parent (Par);
end loop;
return False;
end In_Nested_Context;
-- Local variables
Context_1 : constant Node_Id := Find_Enclosing_Context (N1);
Context_2 : constant Node_Id := Find_Enclosing_Context (N2);
-- Start of processing for In_Same_Context
begin
-- Both nodes appear within the same context
if Context_1 = Context_2 then
return True;
-- Both nodes appear in compilation units. Determine whether one unit
-- is the body of the other.
elsif Nkind (Context_1) = N_Compilation_Unit
and then Nkind (Context_2) = N_Compilation_Unit
then
return
Is_Same_Unit
(Unit_1 => Defining_Entity (Unit (Context_1)),
Unit_2 => Defining_Entity (Unit (Context_2)));
-- The context of N1 encloses the context of N2
elsif Nested_OK and then In_Nested_Context (Context_1, Context_2) then
return True;
end if;
return False;
end In_Same_Context;
----------------
-- Initialize --
----------------
procedure Initialize is
begin
-- Set the soft link which enables Atree.Rewrite to update a top level
-- scenario each time it is transformed into another node.
Set_Rewriting_Proc (Update_Elaboration_Scenario'Access);
end Initialize;
---------------
-- Info_Call --
---------------
procedure Info_Call
(Call : Node_Id;
Target_Id : Entity_Id;
Info_Msg : Boolean;
In_SPARK : Boolean)
is
procedure Info_Accept_Alternative;
pragma Inline (Info_Accept_Alternative);
-- Output information concerning an accept alternative
procedure Info_Simple_Call;
pragma Inline (Info_Simple_Call);
-- Output information concerning the call
procedure Info_Type_Actions (Action : String);
pragma Inline (Info_Type_Actions);
-- Output information concerning action Action of a type
procedure Info_Verification_Call
(Pred : String;
Id : Entity_Id;
Id_Kind : String);
pragma Inline (Info_Verification_Call);
-- Output information concerning the verification of predicate Pred
-- applied to related entity Id with kind Id_Kind.
-----------------------------
-- Info_Accept_Alternative --
-----------------------------
procedure Info_Accept_Alternative is
Entry_Id : constant Entity_Id := Receiving_Entry (Target_Id);
begin
pragma Assert (Present (Entry_Id));
Elab_Msg_NE
(Msg => "accept for entry & during elaboration",
N => Call,
Id => Entry_Id,
Info_Msg => Info_Msg,
In_SPARK => In_SPARK);
end Info_Accept_Alternative;
----------------------
-- Info_Simple_Call --
----------------------
procedure Info_Simple_Call is
begin
Elab_Msg_NE
(Msg => "call to & during elaboration",
N => Call,
Id => Target_Id,
Info_Msg => Info_Msg,
In_SPARK => In_SPARK);
end Info_Simple_Call;
-----------------------
-- Info_Type_Actions --
-----------------------
procedure Info_Type_Actions (Action : String) is
Typ : constant Entity_Id := First_Formal_Type (Target_Id);
begin
pragma Assert (Present (Typ));
Elab_Msg_NE
(Msg => Action & " actions for type & during elaboration",
N => Call,
Id => Typ,
Info_Msg => Info_Msg,
In_SPARK => In_SPARK);
end Info_Type_Actions;
----------------------------
-- Info_Verification_Call --
----------------------------
procedure Info_Verification_Call
(Pred : String;
Id : Entity_Id;
Id_Kind : String)
is
begin
pragma Assert (Present (Id));
Elab_Msg_NE
(Msg =>
"verification of " & Pred & " of " & Id_Kind & " & during "
& "elaboration",
N => Call,
Id => Id,
Info_Msg => Info_Msg,
In_SPARK => In_SPARK);
end Info_Verification_Call;
-- Start of processing for Info_Call
begin
-- Do not output anything for targets defined in internal units because
-- this creates noise.
if not In_Internal_Unit (Target_Id) then
-- Accept alternative
if Is_Accept_Alternative_Proc (Target_Id) then
Info_Accept_Alternative;
-- Adjustment
elsif Is_TSS (Target_Id, TSS_Deep_Adjust) then
Info_Type_Actions ("adjustment");
-- Default_Initial_Condition
elsif Is_Default_Initial_Condition_Proc (Target_Id) then
Info_Verification_Call
(Pred => "Default_Initial_Condition",
Id => First_Formal_Type (Target_Id),
Id_Kind => "type");
-- Entries
elsif Is_Protected_Entry (Target_Id) then
Info_Simple_Call;
-- Task entry calls are never processed because the entry being
-- invoked does not have a corresponding "body", it has a select.
elsif Is_Task_Entry (Target_Id) then
null;
-- Finalization
elsif Is_TSS (Target_Id, TSS_Deep_Finalize) then
Info_Type_Actions ("finalization");
-- Calls to _Finalizer procedures must not appear in the output
-- because this creates confusing noise.
elsif Is_Finalizer_Proc (Target_Id) then
null;
-- Initial_Condition
elsif Is_Initial_Condition_Proc (Target_Id) then
Info_Verification_Call
(Pred => "Initial_Condition",
Id => Find_Enclosing_Scope (Call),
Id_Kind => "package");
-- Initialization
elsif Is_Init_Proc (Target_Id)
or else Is_TSS (Target_Id, TSS_Deep_Initialize)
then
Info_Type_Actions ("initialization");
-- Invariant
elsif Is_Invariant_Proc (Target_Id) then
Info_Verification_Call
(Pred => "invariants",
Id => First_Formal_Type (Target_Id),
Id_Kind => "type");
-- Partial invariant calls must not appear in the output because this
-- creates confusing noise.
elsif Is_Partial_Invariant_Proc (Target_Id) then
null;
-- _Postconditions
elsif Is_Postconditions_Proc (Target_Id) then
Info_Verification_Call
(Pred => "postconditions",
Id => Find_Enclosing_Scope (Call),
Id_Kind => "subprogram");
-- Subprograms must come last because some of the previous cases fall
-- under this category.
elsif Ekind (Target_Id) = E_Function then
Info_Simple_Call;
elsif Ekind (Target_Id) = E_Procedure then
Info_Simple_Call;
else
pragma Assert (False);
null;
end if;
end if;
end Info_Call;
------------------------
-- Info_Instantiation --
------------------------
procedure Info_Instantiation
(Inst : Node_Id;
Gen_Id : Entity_Id;
Info_Msg : Boolean;
In_SPARK : Boolean)
is
begin
Elab_Msg_NE
(Msg => "instantiation of & during elaboration",
N => Inst,
Id => Gen_Id,
Info_Msg => Info_Msg,
In_SPARK => In_SPARK);
end Info_Instantiation;
-----------------------------
-- Info_Variable_Reference --
-----------------------------
procedure Info_Variable_Reference
(Ref : Node_Id;
Var_Id : Entity_Id;
Info_Msg : Boolean;
In_SPARK : Boolean)
is
begin
Elab_Msg_NE
(Msg => "reference to variable & during elaboration",
N => Ref,
Id => Var_Id,
Info_Msg => Info_Msg,
In_SPARK => In_SPARK);
end Info_Variable_Reference;
--------------------
-- Insertion_Node --
--------------------
function Insertion_Node (N : Node_Id; Ins_Nod : Node_Id) return Node_Id is
begin
-- When the scenario denotes an instantiation, the proper insertion node
-- is the instance spec. This ensures that the generic actuals will not
-- be evaluated prior to a potential ABE.
if Nkind (N) in N_Generic_Instantiation
and then Present (Instance_Spec (N))
then
return Instance_Spec (N);
-- Otherwise the proper insertion node is the candidate insertion node
else
return Ins_Nod;
end if;
end Insertion_Node;
-----------------------
-- Install_ABE_Check --
-----------------------
procedure Install_ABE_Check
(N : Node_Id;
Id : Entity_Id;
Ins_Nod : Node_Id)
is
Check_Ins_Nod : constant Node_Id := Insertion_Node (N, Ins_Nod);
-- Insert the check prior to this node
Loc : constant Source_Ptr := Sloc (N);
Spec_Id : constant Entity_Id := Unique_Entity (Id);
Unit_Id : constant Entity_Id := Find_Top_Unit (Id);
Scop_Id : Entity_Id;
begin
-- Nothing to do when compiling for GNATprove because raise statements
-- are not supported.
if GNATprove_Mode then
return;
-- Nothing to do when the compilation will not produce an executable
elsif Serious_Errors_Detected > 0 then
return;
-- Nothing to do for a compilation unit because there is no executable
-- environment at that level.
elsif Nkind (Parent (Check_Ins_Nod)) = N_Compilation_Unit then
return;
-- Nothing to do when the unit is elaborated prior to the main unit.
-- This check must also consider the following cases:
-- * Id's unit appears in the context of the main unit
-- * Id's unit is subject to pragma Elaborate_Body. An ABE check MUST
-- NOT be generated because Id's unit is always elaborated prior to
-- the main unit.
-- * Id's unit is the main unit. An ABE check MUST be generated in this
-- case because a conditional ABE may be raised depending on the flow
-- of execution within the main unit (flag Same_Unit_OK is False).
elsif Has_Prior_Elaboration
(Unit_Id => Unit_Id,
Context_OK => True,
Elab_Body_OK => True)
then
return;
end if;
-- Prevent multiple scenarios from installing the same ABE check
Set_Is_Elaboration_Checks_OK_Node (N, False);
-- Install the nearest enclosing scope of the scenario as there must be
-- something on the scope stack.
-- Performance note: parent traversal
Scop_Id := Find_Enclosing_Scope (Check_Ins_Nod);
pragma Assert (Present (Scop_Id));
Push_Scope (Scop_Id);
-- Generate:
-- if not Spec_Id'Elaborated then
-- raise Program_Error with "access before elaboration";
-- end if;
Insert_Action (Check_Ins_Nod,
Make_Raise_Program_Error (Loc,
Condition =>
Make_Op_Not (Loc,
Right_Opnd =>
Make_Attribute_Reference (Loc,
Prefix => New_Occurrence_Of (Spec_Id, Loc),
Attribute_Name => Name_Elaborated)),
Reason => PE_Access_Before_Elaboration));
Pop_Scope;
end Install_ABE_Check;
-----------------------
-- Install_ABE_Check --
-----------------------
procedure Install_ABE_Check
(N : Node_Id;
Target_Id : Entity_Id;
Target_Decl : Node_Id;
Target_Body : Node_Id;
Ins_Nod : Node_Id)
is
procedure Build_Elaboration_Entity;
pragma Inline (Build_Elaboration_Entity);
-- Create a new elaboration flag for Target_Id, insert it prior to
-- Target_Decl, and set it after Body_Decl.
------------------------------
-- Build_Elaboration_Entity --
------------------------------
procedure Build_Elaboration_Entity is
Loc : constant Source_Ptr := Sloc (Target_Id);
Flag_Id : Entity_Id;
begin
-- Create the declaration of the elaboration flag. The name carries a
-- unique counter in case of name overloading.
Flag_Id :=
Make_Defining_Identifier (Loc,
Chars => New_External_Name (Chars (Target_Id), 'E', -1));
Set_Elaboration_Entity (Target_Id, Flag_Id);
Set_Elaboration_Entity_Required (Target_Id);
Push_Scope (Scope (Target_Id));
-- Generate:
-- Enn : Short_Integer := 0;
Insert_Action (Target_Decl,
Make_Object_Declaration (Loc,
Defining_Identifier => Flag_Id,
Object_Definition =>
New_Occurrence_Of (Standard_Short_Integer, Loc),
Expression => Make_Integer_Literal (Loc, Uint_0)));
-- Generate:
-- Enn := 1;
Set_Elaboration_Flag (Target_Body, Target_Id);
Pop_Scope;
end Build_Elaboration_Entity;
-- Local variables
Target_Unit_Id : constant Entity_Id := Find_Top_Unit (Target_Id);
-- Start for processing for Install_ABE_Check
begin
-- Nothing to do when compiling for GNATprove because raise statements
-- are not supported.
if GNATprove_Mode then
return;
-- Nothing to do when the compilation will not produce an executable
elsif Serious_Errors_Detected > 0 then
return;
-- Nothing to do when the target is a protected subprogram because the
-- check is associated with the protected body subprogram.
elsif Is_Protected_Subp (Target_Id) then
return;
-- Nothing to do when the target is elaborated prior to the main unit.
-- This check must also consider the following cases:
-- * The unit of the target appears in the context of the main unit
-- * The unit of the target is subject to pragma Elaborate_Body. An ABE
-- check MUST NOT be generated because the unit is always elaborated
-- prior to the main unit.
-- * The unit of the target is the main unit. An ABE check MUST be added
-- in this case because a conditional ABE may be raised depending on
-- the flow of execution within the main unit (flag Same_Unit_OK is
-- False).
elsif Has_Prior_Elaboration
(Unit_Id => Target_Unit_Id,
Context_OK => True,
Elab_Body_OK => True)
then
return;
-- Create an elaboration flag for the target when it does not have one
elsif No (Elaboration_Entity (Target_Id)) then
Build_Elaboration_Entity;
end if;
Install_ABE_Check
(N => N,
Ins_Nod => Ins_Nod,
Id => Target_Id);
end Install_ABE_Check;
-------------------------
-- Install_ABE_Failure --
-------------------------
procedure Install_ABE_Failure (N : Node_Id; Ins_Nod : Node_Id) is
Fail_Ins_Nod : constant Node_Id := Insertion_Node (N, Ins_Nod);
-- Insert the failure prior to this node
Loc : constant Source_Ptr := Sloc (N);
Scop_Id : Entity_Id;
begin
-- Nothing to do when compiling for GNATprove because raise statements
-- are not supported.
if GNATprove_Mode then
return;
-- Nothing to do when the compilation will not produce an executable
elsif Serious_Errors_Detected > 0 then
return;
-- Do not install an ABE check for a compilation unit because there is
-- no executable environment at that level.
elsif Nkind (Parent (Fail_Ins_Nod)) = N_Compilation_Unit then
return;
end if;
-- Prevent multiple scenarios from installing the same ABE failure
Set_Is_Elaboration_Checks_OK_Node (N, False);
-- Install the nearest enclosing scope of the scenario as there must be
-- something on the scope stack.
-- Performance note: parent traversal
Scop_Id := Find_Enclosing_Scope (Fail_Ins_Nod);
pragma Assert (Present (Scop_Id));
Push_Scope (Scop_Id);
-- Generate:
-- raise Program_Error with "access before elaboration";
Insert_Action (Fail_Ins_Nod,
Make_Raise_Program_Error (Loc,
Reason => PE_Access_Before_Elaboration));
Pop_Scope;
end Install_ABE_Failure;
--------------------------------
-- Is_Accept_Alternative_Proc --
--------------------------------
function Is_Accept_Alternative_Proc (Id : Entity_Id) return Boolean is
begin
-- To qualify, the entity must denote a procedure with a receiving entry
return Ekind (Id) = E_Procedure and then Present (Receiving_Entry (Id));
end Is_Accept_Alternative_Proc;
------------------------
-- Is_Activation_Proc --
------------------------
function Is_Activation_Proc (Id : Entity_Id) return Boolean is
begin
-- To qualify, the entity must denote one of the runtime procedures in
-- charge of task activation.
if Ekind (Id) = E_Procedure then
if Restricted_Profile then
return Is_RTE (Id, RE_Activate_Restricted_Tasks);
else
return Is_RTE (Id, RE_Activate_Tasks);
end if;
end if;
return False;
end Is_Activation_Proc;
----------------------------
-- Is_Ada_Semantic_Target --
----------------------------
function Is_Ada_Semantic_Target (Id : Entity_Id) return Boolean is
begin
return
Is_Activation_Proc (Id)
or else Is_Controlled_Proc (Id, Name_Adjust)
or else Is_Controlled_Proc (Id, Name_Finalize)
or else Is_Controlled_Proc (Id, Name_Initialize)
or else Is_Init_Proc (Id)
or else Is_Invariant_Proc (Id)
or else Is_Protected_Entry (Id)
or else Is_Protected_Subp (Id)
or else Is_Protected_Body_Subp (Id)
or else Is_Task_Entry (Id);
end Is_Ada_Semantic_Target;
----------------------------
-- Is_Bodiless_Subprogram --
----------------------------
function Is_Bodiless_Subprogram (Subp_Id : Entity_Id) return Boolean is
begin
-- An abstract subprogram does not have a body
if Ekind_In (Subp_Id, E_Function,
E_Operator,
E_Procedure)
and then Is_Abstract_Subprogram (Subp_Id)
then
return True;
-- A formal subprogram does not have a body
elsif Is_Formal_Subprogram (Subp_Id) then
return True;
-- An imported subprogram may have a body, however it is not known at
-- compile or bind time where the body resides and whether it will be
-- elaborated on time.
elsif Is_Imported (Subp_Id) then
return True;
end if;
return False;
end Is_Bodiless_Subprogram;
--------------------------------
-- Is_Check_Emitting_Scenario --
--------------------------------
function Is_Check_Emitting_Scenario (N : Node_Id) return Boolean is
begin
return
Nkind_In (N, N_Call_Marker,
N_Function_Instantiation,
N_Package_Instantiation,
N_Procedure_Instantiation);
end Is_Check_Emitting_Scenario;
------------------------
-- Is_Controlled_Proc --
------------------------
function Is_Controlled_Proc
(Subp_Id : Entity_Id;
Subp_Nam : Name_Id) return Boolean
is
Formal_Id : Entity_Id;
begin
pragma Assert (Nam_In (Subp_Nam, Name_Adjust,
Name_Finalize,
Name_Initialize));
-- To qualify, the subprogram must denote a source procedure with name
-- Adjust, Finalize, or Initialize where the sole formal is controlled.
if Comes_From_Source (Subp_Id)
and then Ekind (Subp_Id) = E_Procedure
and then Chars (Subp_Id) = Subp_Nam
then
Formal_Id := First_Formal (Subp_Id);
return
Present (Formal_Id)
and then Is_Controlled (Etype (Formal_Id))
and then No (Next_Formal (Formal_Id));
end if;
return False;
end Is_Controlled_Proc;
---------------------------------------
-- Is_Default_Initial_Condition_Proc --
---------------------------------------
function Is_Default_Initial_Condition_Proc
(Id : Entity_Id) return Boolean
is
begin
-- To qualify, the entity must denote a Default_Initial_Condition
-- procedure.
return Ekind (Id) = E_Procedure and then Is_DIC_Procedure (Id);
end Is_Default_Initial_Condition_Proc;
-----------------------
-- Is_Finalizer_Proc --
-----------------------
function Is_Finalizer_Proc (Id : Entity_Id) return Boolean is
begin
-- To qualify, the entity must denote a _Finalizer procedure
return Ekind (Id) = E_Procedure and then Chars (Id) = Name_uFinalizer;
end Is_Finalizer_Proc;
-----------------------
-- Is_Guaranteed_ABE --
-----------------------
function Is_Guaranteed_ABE
(N : Node_Id;
Target_Decl : Node_Id;
Target_Body : Node_Id) return Boolean
is
begin
-- Avoid cascaded errors if there were previous serious infractions.
-- As a result the scenario will not be treated as a guaranteed ABE.
-- This behaviour parallels that of the old ABE mechanism.
if Serious_Errors_Detected > 0 then
return False;
-- The scenario and the target appear within the same context ignoring
-- enclosing library levels.
-- Performance note: parent traversal
elsif In_Same_Context (N, Target_Decl) then
-- The target body has already been encountered. The scenario results
-- in a guaranteed ABE if it appears prior to the body.
if Present (Target_Body) then
return Earlier_In_Extended_Unit (N, Target_Body);
-- Otherwise the body has not been encountered yet. The scenario is
-- a guaranteed ABE since the body will appear later. It is assumed
-- that the caller has already checked whether the scenario is ABE-
-- safe as optional bodies are not considered here.
else
return True;
end if;
end if;
return False;
end Is_Guaranteed_ABE;
-------------------------------
-- Is_Initial_Condition_Proc --
-------------------------------
function Is_Initial_Condition_Proc (Id : Entity_Id) return Boolean is
begin
-- To qualify, the entity must denote an Initial_Condition procedure
return
Ekind (Id) = E_Procedure and then Is_Initial_Condition_Procedure (Id);
end Is_Initial_Condition_Proc;
-----------------------
-- Is_Invariant_Proc --
-----------------------
function Is_Invariant_Proc (Id : Entity_Id) return Boolean is
begin
-- To qualify, the entity must denote the "full" invariant procedure
return Ekind (Id) = E_Procedure and then Is_Invariant_Procedure (Id);
end Is_Invariant_Proc;
---------------------------------------
-- Is_Non_Library_Level_Encapsulator --
---------------------------------------
function Is_Non_Library_Level_Encapsulator (N : Node_Id) return Boolean is
begin
case Nkind (N) is
when N_Abstract_Subprogram_Declaration
| N_Aspect_Specification
| N_Component_Declaration
| N_Entry_Body
| N_Entry_Declaration
| N_Expression_Function
| N_Formal_Abstract_Subprogram_Declaration
| N_Formal_Concrete_Subprogram_Declaration
| N_Formal_Object_Declaration
| N_Formal_Package_Declaration
| N_Formal_Type_Declaration
| N_Generic_Association
| N_Implicit_Label_Declaration
| N_Incomplete_Type_Declaration
| N_Private_Extension_Declaration
| N_Private_Type_Declaration
| N_Protected_Body
| N_Protected_Type_Declaration
| N_Single_Protected_Declaration
| N_Single_Task_Declaration
| N_Subprogram_Body
| N_Subprogram_Declaration
| N_Task_Body
| N_Task_Type_Declaration
=>
return True;
when others =>
return Is_Generic_Declaration_Or_Body (N);
end case;
end Is_Non_Library_Level_Encapsulator;
-------------------------------
-- Is_Partial_Invariant_Proc --
-------------------------------
function Is_Partial_Invariant_Proc (Id : Entity_Id) return Boolean is
begin
-- To qualify, the entity must denote the "partial" invariant procedure
return
Ekind (Id) = E_Procedure and then Is_Partial_Invariant_Procedure (Id);
end Is_Partial_Invariant_Proc;
----------------------------
-- Is_Postconditions_Proc --
----------------------------
function Is_Postconditions_Proc (Id : Entity_Id) return Boolean is
begin
-- To qualify, the entity must denote a _Postconditions procedure
return
Ekind (Id) = E_Procedure and then Chars (Id) = Name_uPostconditions;
end Is_Postconditions_Proc;
---------------------------
-- Is_Preelaborated_Unit --
---------------------------
function Is_Preelaborated_Unit (Id : Entity_Id) return Boolean is
begin
return
Is_Preelaborated (Id)
or else Is_Pure (Id)
or else Is_Remote_Call_Interface (Id)
or else Is_Remote_Types (Id)
or else Is_Shared_Passive (Id);
end Is_Preelaborated_Unit;
------------------------
-- Is_Protected_Entry --
------------------------
function Is_Protected_Entry (Id : Entity_Id) return Boolean is
begin
-- To qualify, the entity must denote an entry defined in a protected
-- type.
return
Is_Entry (Id)
and then Is_Protected_Type (Non_Private_View (Scope (Id)));
end Is_Protected_Entry;
-----------------------
-- Is_Protected_Subp --
-----------------------
function Is_Protected_Subp (Id : Entity_Id) return Boolean is
begin
-- To qualify, the entity must denote a subprogram defined within a
-- protected type.
return
Ekind_In (Id, E_Function, E_Procedure)
and then Is_Protected_Type (Non_Private_View (Scope (Id)));
end Is_Protected_Subp;
----------------------------
-- Is_Protected_Body_Subp --
----------------------------
function Is_Protected_Body_Subp (Id : Entity_Id) return Boolean is
begin
-- To qualify, the entity must denote a subprogram with attribute
-- Protected_Subprogram set.
return
Ekind_In (Id, E_Function, E_Procedure)
and then Present (Protected_Subprogram (Id));
end Is_Protected_Body_Subp;
------------------------
-- Is_Safe_Activation --
------------------------
function Is_Safe_Activation
(Call : Node_Id;
Task_Decl : Node_Id) return Boolean
is
begin
-- The activation of a task coming from an external instance cannot
-- cause an ABE because the generic was already instantiated. Note
-- that the instantiation itself may lead to an ABE.
return
In_External_Instance
(N => Call,
Target_Decl => Task_Decl);
end Is_Safe_Activation;
------------------
-- Is_Safe_Call --
------------------
function Is_Safe_Call
(Call : Node_Id;
Target_Attrs : Target_Attributes) return Boolean
is
begin
-- The target is either an abstract subprogram, formal subprogram, or
-- imported, in which case it does not have a body at compile or bind
-- time. Assume that the call is ABE-safe.
if Is_Bodiless_Subprogram (Target_Attrs.Spec_Id) then
return True;
-- The target is an instantiation of a generic subprogram. The call
-- cannot cause an ABE because the generic was already instantiated.
-- Note that the instantiation itself may lead to an ABE.
elsif Is_Generic_Instance (Target_Attrs.Spec_Id) then
return True;
-- The invocation of a target coming from an external instance cannot
-- cause an ABE because the generic was already instantiated. Note that
-- the instantiation itself may lead to an ABE.
elsif In_External_Instance
(N => Call,
Target_Decl => Target_Attrs.Spec_Decl)
then
return True;
-- The target is a subprogram body without a previous declaration. The
-- call cannot cause an ABE because the body has already been seen.
elsif Nkind (Target_Attrs.Spec_Decl) = N_Subprogram_Body
and then No (Corresponding_Spec (Target_Attrs.Spec_Decl))
then
return True;
-- The target is a subprogram body stub without a prior declaration.
-- The call cannot cause an ABE because the proper body substitutes
-- the stub.
elsif Nkind (Target_Attrs.Spec_Decl) = N_Subprogram_Body_Stub
and then No (Corresponding_Spec_Of_Stub (Target_Attrs.Spec_Decl))
then
return True;
-- Subprogram bodies which wrap attribute references used as actuals
-- in instantiations are always ABE-safe. These bodies are artifacts
-- of expansion.
elsif Present (Target_Attrs.Body_Decl)
and then Nkind (Target_Attrs.Body_Decl) = N_Subprogram_Body
and then Was_Attribute_Reference (Target_Attrs.Body_Decl)
then
return True;
end if;
return False;
end Is_Safe_Call;
---------------------------
-- Is_Safe_Instantiation --
---------------------------
function Is_Safe_Instantiation
(Inst : Node_Id;
Gen_Attrs : Target_Attributes) return Boolean
is
begin
-- The generic is an intrinsic subprogram in which case it does not
-- have a body at compile or bind time. Assume that the instantiation
-- is ABE-safe.
if Is_Bodiless_Subprogram (Gen_Attrs.Spec_Id) then
return True;
-- The instantiation of an external nested generic cannot cause an ABE
-- if the outer generic was already instantiated. Note that the instance
-- of the outer generic may lead to an ABE.
elsif In_External_Instance
(N => Inst,
Target_Decl => Gen_Attrs.Spec_Decl)
then
return True;
-- The generic is a package. The instantiation cannot cause an ABE when
-- the package has no body.
elsif Ekind (Gen_Attrs.Spec_Id) = E_Generic_Package
and then not Has_Body (Gen_Attrs.Spec_Decl)
then
return True;
end if;
return False;
end Is_Safe_Instantiation;
------------------
-- Is_Same_Unit --
------------------
function Is_Same_Unit
(Unit_1 : Entity_Id;
Unit_2 : Entity_Id) return Boolean
is
function Is_Subunit (Unit_Id : Entity_Id) return Boolean;
pragma Inline (Is_Subunit);
-- Determine whether unit Unit_Id is a subunit
function Normalize_Unit (Unit_Id : Entity_Id) return Entity_Id;
-- Strip a potential subunit chain ending with unit Unit_Id and return
-- the corresponding spec.
----------------
-- Is_Subunit --
----------------
function Is_Subunit (Unit_Id : Entity_Id) return Boolean is
begin
return Nkind (Parent (Unit_Declaration_Node (Unit_Id))) = N_Subunit;
end Is_Subunit;
--------------------
-- Normalize_Unit --
--------------------
function Normalize_Unit (Unit_Id : Entity_Id) return Entity_Id is
Result : Entity_Id;
begin
-- Eliminate a potential chain of subunits to reach to proper body
Result := Unit_Id;
while Present (Result)
and then Result /= Standard_Standard
and then Is_Subunit (Result)
loop
Result := Scope (Result);
end loop;
-- Obtain the entity of the corresponding spec (if any)
return Unique_Entity (Result);
end Normalize_Unit;
-- Start of processing for Is_Same_Unit
begin
return Normalize_Unit (Unit_1) = Normalize_Unit (Unit_2);
end Is_Same_Unit;
-----------------
-- Is_Scenario --
-----------------
function Is_Scenario (N : Node_Id) return Boolean is
begin
case Nkind (N) is
when N_Assignment_Statement
| N_Attribute_Reference
| N_Call_Marker
| N_Entry_Call_Statement
| N_Expanded_Name
| N_Function_Call
| N_Function_Instantiation
| N_Identifier
| N_Package_Instantiation
| N_Procedure_Call_Statement
| N_Procedure_Instantiation
| N_Requeue_Statement
=>
return True;
when others =>
return False;
end case;
end Is_Scenario;
------------------------------
-- Is_SPARK_Semantic_Target --
------------------------------
function Is_SPARK_Semantic_Target (Id : Entity_Id) return Boolean is
begin
return
Is_Default_Initial_Condition_Proc (Id)
or else Is_Initial_Condition_Proc (Id);
end Is_SPARK_Semantic_Target;
------------------------
-- Is_Suitable_Access --
------------------------
function Is_Suitable_Access (N : Node_Id) return Boolean is
Nam : Name_Id;
Pref : Node_Id;
Subp_Id : Entity_Id;
begin
-- This scenario is relevant only when the static model is in effect
-- because it is graph-dependent and does not involve any run-time
-- checks. Allowing it in the dynamic model would create confusing
-- noise.
if not Static_Elaboration_Checks then
return False;
-- Nothing to do when switch -gnatd.U (ignore 'Access) is in effect
elsif Debug_Flag_Dot_UU then
return False;
-- Nothing to do when the scenario is not an attribute reference
elsif Nkind (N) /= N_Attribute_Reference then
return False;
-- Nothing to do for internally-generated attributes because they are
-- assumed to be ABE safe.
elsif not Comes_From_Source (N) then
return False;
end if;
Nam := Attribute_Name (N);
Pref := Prefix (N);
-- Sanitize the prefix of the attribute
if not Is_Entity_Name (Pref) then
return False;
elsif No (Entity (Pref)) then
return False;
end if;
Subp_Id := Entity (Pref);
if not Is_Subprogram_Or_Entry (Subp_Id) then
return False;
end if;
-- Traverse a possible chain of renamings to obtain the original entry
-- or subprogram which the prefix may rename.
Subp_Id := Get_Renamed_Entity (Subp_Id);
-- To qualify, the attribute must meet the following prerequisites:
return
-- The prefix must denote a source entry, operator, or subprogram
-- which is not imported.
Comes_From_Source (Subp_Id)
and then Is_Subprogram_Or_Entry (Subp_Id)
and then not Is_Bodiless_Subprogram (Subp_Id)
-- The attribute name must be one of the 'Access forms. Note that
-- 'Unchecked_Access cannot apply to a subprogram.
and then Nam_In (Nam, Name_Access, Name_Unrestricted_Access);
end Is_Suitable_Access;
----------------------
-- Is_Suitable_Call --
----------------------
function Is_Suitable_Call (N : Node_Id) return Boolean is
begin
-- Entry and subprogram calls are intentionally ignored because they
-- may undergo expansion depending on the compilation mode, previous
-- errors, generic context, etc. Call markers play the role of calls
-- and provide a uniform foundation for ABE processing.
return Nkind (N) = N_Call_Marker;
end Is_Suitable_Call;
-------------------------------
-- Is_Suitable_Instantiation --
-------------------------------
function Is_Suitable_Instantiation (N : Node_Id) return Boolean is
Orig_N : constant Node_Id := Original_Node (N);
-- Use the original node in case an instantiation library unit is
-- rewritten as a package or subprogram.
begin
-- To qualify, the instantiation must come from source
return
Comes_From_Source (Orig_N)
and then Nkind (Orig_N) in N_Generic_Instantiation;
end Is_Suitable_Instantiation;
--------------------------
-- Is_Suitable_Scenario --
--------------------------
function Is_Suitable_Scenario (N : Node_Id) return Boolean is
begin
return
Is_Suitable_Access (N)
or else Is_Suitable_Call (N)
or else Is_Suitable_Instantiation (N)
or else Is_Suitable_Variable_Assignment (N)
or else Is_Suitable_Variable_Reference (N);
end Is_Suitable_Scenario;
-------------------------------------
-- Is_Suitable_Variable_Assignment --
-------------------------------------
function Is_Suitable_Variable_Assignment (N : Node_Id) return Boolean is
N_Unit : Node_Id;
N_Unit_Id : Entity_Id;
Nam : Node_Id;
Var_Decl : Node_Id;
Var_Id : Entity_Id;
Var_Unit : Node_Id;
Var_Unit_Id : Entity_Id;
begin
-- This scenario is relevant only when the static model is in effect
-- because it is graph-dependent and does not involve any run-time
-- checks. Allowing it in the dynamic model would create confusing
-- noise.
if not Static_Elaboration_Checks then
return False;
-- Nothing to do when the scenario is not an assignment
elsif Nkind (N) /= N_Assignment_Statement then
return False;
-- Nothing to do for internally-generated assignments because they are
-- assumed to be ABE safe.
elsif not Comes_From_Source (N) then
return False;
-- Assignments are ignored in GNAT mode on the assumption that they are
-- ABE-safe. This behaviour parallels that of the old ABE mechanism.
elsif GNAT_Mode then
return False;
end if;
Nam := Extract_Assignment_Name (N);
-- Sanitize the left hand side of the assignment
if not Is_Entity_Name (Nam) then
return False;
elsif No (Entity (Nam)) then
return False;
end if;
Var_Id := Entity (Nam);
-- Sanitize the variable
if Var_Id = Any_Id then
return False;
elsif Ekind (Var_Id) /= E_Variable then
return False;
end if;
Var_Decl := Declaration_Node (Var_Id);
if Nkind (Var_Decl) /= N_Object_Declaration then
return False;
end if;
N_Unit_Id := Find_Top_Unit (N);
N_Unit := Unit_Declaration_Node (N_Unit_Id);
Var_Unit_Id := Find_Top_Unit (Var_Decl);
Var_Unit := Unit_Declaration_Node (Var_Unit_Id);
-- To qualify, the assignment must meet the following prerequisites:
return
-- The variable must be a source entity and susceptible to warnings
Comes_From_Source (Var_Id)
and then not Has_Warnings_Off (Var_Id)
-- The variable must be declared in the spec of compilation unit U
and then Nkind (Var_Unit) = N_Package_Declaration
-- Performance note: parent traversal
and then Find_Enclosing_Level (Var_Decl) = Package_Spec
-- The variable must lack initialization
and then not Has_Init_Expression (Var_Decl)
and then No (Expression (Var_Decl))
-- The assignment must occur in the body of compilation unit U
and then Nkind (N_Unit) = N_Package_Body
and then Present (Corresponding_Body (Var_Unit))
and then Corresponding_Body (Var_Unit) = N_Unit_Id
-- The package spec must lack pragma Elaborate_Body
and then not Has_Pragma_Elaborate_Body (Var_Unit_Id);
end Is_Suitable_Variable_Assignment;
------------------------------------
-- Is_Suitable_Variable_Reference --
------------------------------------
function Is_Suitable_Variable_Reference (N : Node_Id) return Boolean is
function In_Pragma (Nod : Node_Id) return Boolean;
-- Determine whether arbitrary node N appears within a pragma
---------------
-- In_Pragma --
---------------
function In_Pragma (Nod : Node_Id) return Boolean is
Par : Node_Id;
begin
Par := Nod;
while Present (Par) loop
if Nkind (Par) = N_Pragma then
return True;
-- Prevent the search from going too far
elsif Is_Body_Or_Package_Declaration (Par) then
exit;
end if;
Par := Parent (Par);
end loop;
return False;
end In_Pragma;
-- Local variables
Prag : Node_Id;
Var_Id : Entity_Id;
-- Start of processing for Is_Suitable_Variable_Reference
begin
-- This scenario is relevant only when the static model is in effect
-- because it is graph-dependent and does not involve any run-time
-- checks. Allowing it in the dynamic model would create confusing
-- noise.
if not Static_Elaboration_Checks then
return False;
-- Attributes and operator sumbols are not considered to be suitable
-- references to variables even though they are part of predicate
-- Is_Entity_Name.
elsif not Nkind_In (N, N_Expanded_Name, N_Identifier) then
return False;
-- Nothing to do for internally-generated references because they are
-- assumed to be ABE safe.
elsif not Comes_From_Source (N) then
return False;
end if;
-- Sanitize the reference
Var_Id := Entity (N);
if No (Var_Id) then
return False;
elsif Var_Id = Any_Id then
return False;
elsif Ekind (Var_Id) /= E_Variable then
return False;
end if;
Prag := SPARK_Pragma (Var_Id);
-- To qualify, the reference must meet the following prerequisites:
return
Comes_From_Source (Var_Id)
-- Both the variable and the reference must appear in SPARK_Mode On
-- regions because this scenario falls under the SPARK rules.
and then Present (Prag)
and then Get_SPARK_Mode_From_Annotation (Prag) = On
and then Is_SPARK_Mode_On_Node (N)
-- The reference must not be considered when it appears in a pragma.
-- If the pragma has run-time semantics, then the reference will be
-- reconsidered once the pragma is expanded.
-- Performance note: parent traversal
and then not In_Pragma (N);
end Is_Suitable_Variable_Reference;
-------------------
-- Is_Task_Entry --
-------------------
function Is_Task_Entry (Id : Entity_Id) return Boolean is
begin
-- To qualify, the entity must denote an entry defined in a task type
return
Is_Entry (Id) and then Is_Task_Type (Non_Private_View (Scope (Id)));
end Is_Task_Entry;
------------------------
-- Is_Up_Level_Target --
------------------------
function Is_Up_Level_Target (Target_Decl : Node_Id) return Boolean is
Root : constant Node_Id := Root_Scenario;
begin
-- The root appears within the declaratons of a block statement, entry
-- body, subprogram body, or task body ignoring enclosing packages. The
-- root is always within the main unit. An up level target is a notion
-- applicable only to the static model because scenarios are reached by
-- means of graph traversal started from a fixed declarative or library
-- level.
-- Performance note: parent traversal
if Static_Elaboration_Checks
and then Find_Enclosing_Level (Root) = Declaration_Level
then
-- The target is within the main unit. It acts as an up level target
-- when it appears within a context which encloses the root.
-- package body Main_Unit is
-- function Func ...; -- target
-- procedure Proc is
-- X : ... := Func; -- root scenario
if In_Extended_Main_Code_Unit (Target_Decl) then
-- Performance note: parent traversal
return not In_Same_Context (Root, Target_Decl, Nested_OK => True);
-- Otherwise the target is external to the main unit which makes it
-- an up level target.
else
return True;
end if;
end if;
return False;
end Is_Up_Level_Target;
-------------------------------
-- Kill_Elaboration_Scenario --
-------------------------------
procedure Kill_Elaboration_Scenario (N : Node_Id) is
begin
-- Eliminate the scenario by suppressing the generation of conditional
-- ABE checks or guaranteed ABE failures. Note that other diagnostics
-- must be carried out ignoring the fact that the scenario is within
-- dead code.
if Is_Scenario (N) then
Set_Is_Elaboration_Checks_OK_Node (N, False);
end if;
end Kill_Elaboration_Scenario;
----------------------------------
-- Meet_Elaboration_Requirement --
----------------------------------
procedure Meet_Elaboration_Requirement
(N : Node_Id;
Target_Id : Entity_Id;
Req_Nam : Name_Id)
is
Main_Id : constant Entity_Id := Cunit_Entity (Main_Unit);
Unit_Id : constant Entity_Id := Find_Top_Unit (Target_Id);
function Find_Preelaboration_Pragma
(Prag_Nam : Name_Id) return Node_Id;
pragma Inline (Find_Preelaboration_Pragma);
-- Traverse the visible declarations of unit Unit_Id and locate a source
-- preelaboration-related pragma with name Prag_Nam.
procedure Info_Requirement_Met (Prag : Node_Id);
pragma Inline (Info_Requirement_Met);
-- Output information concerning pragma Prag which meets requirement
-- Req_Nam.
procedure Info_Scenario;
pragma Inline (Info_Scenario);
-- Output information concerning scenario N
--------------------------------
-- Find_Preelaboration_Pragma --
--------------------------------
function Find_Preelaboration_Pragma
(Prag_Nam : Name_Id) return Node_Id
is
Spec : constant Node_Id := Parent (Unit_Id);
Decl : Node_Id;
begin
-- A preelaboration-related pragma comes from source and appears at
-- the top of the visible declarations of a package.
if Nkind (Spec) = N_Package_Specification then
Decl := First (Visible_Declarations (Spec));
while Present (Decl) loop
if Comes_From_Source (Decl) then
if Nkind (Decl) = N_Pragma
and then Pragma_Name (Decl) = Prag_Nam
then
return Decl;
-- Otherwise the construct terminates the region where the
-- preelabortion-related pragma may appear.
else
exit;
end if;
end if;
Next (Decl);
end loop;
end if;
return Empty;
end Find_Preelaboration_Pragma;
--------------------------
-- Info_Requirement_Met --
--------------------------
procedure Info_Requirement_Met (Prag : Node_Id) is
begin
pragma Assert (Present (Prag));
Error_Msg_Name_1 := Req_Nam;
Error_Msg_Sloc := Sloc (Prag);
Error_Msg_NE
("\\% requirement for unit & met by pragma #", N, Unit_Id);
end Info_Requirement_Met;
-------------------
-- Info_Scenario --
-------------------
procedure Info_Scenario is
begin
if Is_Suitable_Call (N) then
Info_Call
(Call => N,
Target_Id => Target_Id,
Info_Msg => False,
In_SPARK => True);
elsif Is_Suitable_Instantiation (N) then
Info_Instantiation
(Inst => N,
Gen_Id => Target_Id,
Info_Msg => False,
In_SPARK => True);
elsif Is_Suitable_Variable_Reference (N) then
Info_Variable_Reference
(Ref => N,
Var_Id => Target_Id,
Info_Msg => False,
In_SPARK => True);
-- No other scenario may impose a requirement on the context of the
-- main unit.
else
pragma Assert (False);
null;
end if;
end Info_Scenario;
-- Local variables
Elab_Attrs : Elaboration_Attributes;
Elab_Nam : Name_Id;
Req_Met : Boolean;
-- Start of processing for Meet_Elaboration_Requirement
begin
pragma Assert (Nam_In (Req_Nam, Name_Elaborate, Name_Elaborate_All));
-- Assume that the requirement has not been met
Req_Met := False;
-- Elaboration requirements are verified only when the static model is
-- in effect because this diagnostic is graph-dependent.
if not Static_Elaboration_Checks then
return;
-- If the target is within the main unit, either at the source level or
-- through an instantiation, then there is no real requirement to meet
-- because the main unit cannot force its own elaboration by means of an
-- Elaborate[_All] pragma. Treat this case as valid coverage.
elsif In_Extended_Main_Code_Unit (Target_Id) then
Req_Met := True;
-- Otherwise the target resides in an external unit
-- The requirement is met when the target comes from an internal unit
-- because such a unit is elaborated prior to a non-internal unit.
elsif In_Internal_Unit (Unit_Id)
and then not In_Internal_Unit (Main_Id)
then
Req_Met := True;
-- The requirement is met when the target comes from a preelaborated
-- unit. This portion must parallel predicate Is_Preelaborated_Unit.
elsif Is_Preelaborated_Unit (Unit_Id) then
Req_Met := True;
-- Output extra information when switch -gnatel (info messages on
-- implicit Elaborate[_All] pragmas.
if Elab_Info_Messages then
if Is_Preelaborated (Unit_Id) then
Elab_Nam := Name_Preelaborate;
elsif Is_Pure (Unit_Id) then
Elab_Nam := Name_Pure;
elsif Is_Remote_Call_Interface (Unit_Id) then
Elab_Nam := Name_Remote_Call_Interface;
elsif Is_Remote_Types (Unit_Id) then
Elab_Nam := Name_Remote_Types;
else
pragma Assert (Is_Shared_Passive (Unit_Id));
Elab_Nam := Name_Shared_Passive;
end if;
Info_Requirement_Met (Find_Preelaboration_Pragma (Elab_Nam));
end if;
-- Determine whether the context of the main unit has a pragma strong
-- enough to meet the requirement.
else
Elab_Attrs := Elaboration_Context.Get (Unit_Id);
-- The pragma must be either Elaborate_All or be as strong as the
-- requirement.
if Present (Elab_Attrs.Source_Pragma)
and then Nam_In (Pragma_Name (Elab_Attrs.Source_Pragma),
Name_Elaborate_All,
Req_Nam)
then
Req_Met := True;
-- Output extra information when switch -gnatel (info messages on
-- implicit Elaborate[_All] pragmas.
if Elab_Info_Messages then
Info_Requirement_Met (Elab_Attrs.Source_Pragma);
end if;
end if;
end if;
-- The requirement was not met by the context of the main unit, issue an
-- error.
if not Req_Met then
Info_Scenario;
Error_Msg_Name_1 := Req_Nam;
Error_Msg_Node_2 := Unit_Id;
Error_Msg_NE ("\\unit & requires pragma % for &", N, Main_Id);
Output_Active_Scenarios (N);
end if;
end Meet_Elaboration_Requirement;
----------------------
-- Non_Private_View --
----------------------
function Non_Private_View (Typ : Entity_Id) return Entity_Id is
Result : Entity_Id;
begin
Result := Typ;
if Is_Private_Type (Result) and then Present (Full_View (Result)) then
Result := Full_View (Result);
end if;
return Result;
end Non_Private_View;
-----------------------------
-- Output_Active_Scenarios --
-----------------------------
procedure Output_Active_Scenarios (Error_Nod : Node_Id) is
procedure Output_Access (N : Node_Id);
-- Emit a specific diagnostic message for 'Access denote by N
procedure Output_Activation_Call (N : Node_Id);
-- Emit a specific diagnostic message for task activation N
procedure Output_Call (N : Node_Id; Target_Id : Entity_Id);
-- Emit a specific diagnostic message for call N which invokes target
-- Target_Id.
procedure Output_Header;
-- Emit a specific diagnostic message for the unit of the root scenario
procedure Output_Instantiation (N : Node_Id);
-- Emit a specific diagnostic message for instantiation N
procedure Output_Variable_Assignment (N : Node_Id);
-- Emit a specific diagnostic message for assignment statement N
procedure Output_Variable_Reference (N : Node_Id);
-- Emit a specific diagnostic message for variable reference N
-------------------
-- Output_Access --
-------------------
procedure Output_Access (N : Node_Id) is
Subp_Id : constant Entity_Id := Entity (Prefix (N));
begin
Error_Msg_Name_1 := Attribute_Name (N);
Error_Msg_Sloc := Sloc (N);
Error_Msg_NE ("\\ % of & taken #", Error_Nod, Subp_Id);
end Output_Access;
----------------------------
-- Output_Activation_Call --
----------------------------
procedure Output_Activation_Call (N : Node_Id) is
function Find_Activator (Call : Node_Id) return Entity_Id;
-- Find the nearest enclosing construct which houses call Call
--------------------
-- Find_Activator --
--------------------
function Find_Activator (Call : Node_Id) return Entity_Id is
Par : Node_Id;
begin
-- Climb the parent chain looking for a package [body] or a
-- construct with a statement sequence.
Par := Parent (Call);
while Present (Par) loop
if Nkind_In (Par, N_Package_Body, N_Package_Declaration) then
return Defining_Entity (Par);
elsif Nkind (Par) = N_Handled_Sequence_Of_Statements then
return Defining_Entity (Parent (Par));
end if;
Par := Parent (Par);
end loop;
return Empty;
end Find_Activator;
-- Local variables
Activator : constant Entity_Id := Find_Activator (N);
-- Start of processing for Output_Activation_Call
begin
pragma Assert (Present (Activator));
Error_Msg_NE ("\\ local tasks of & activated", Error_Nod, Activator);
end Output_Activation_Call;
-----------------
-- Output_Call --
-----------------
procedure Output_Call (N : Node_Id; Target_Id : Entity_Id) is
procedure Output_Accept_Alternative;
pragma Inline (Output_Accept_Alternative);
-- Emit a specific diagnostic message concerning an accept
-- alternative.
procedure Output_Call (Kind : String);
pragma Inline (Output_Call);
-- Emit a specific diagnostic message concerning a call of kind Kind
procedure Output_Type_Actions (Action : String);
pragma Inline (Output_Type_Actions);
-- Emit a specific diagnostic message concerning action Action of a
-- type.
procedure Output_Verification_Call
(Pred : String;
Id : Entity_Id;
Id_Kind : String);
pragma Inline (Output_Verification_Call);
-- Emit a specific diagnostic message concerning the verification of
-- predicate Pred applied to related entity Id with kind Id_Kind.
-------------------------------
-- Output_Accept_Alternative --
-------------------------------
procedure Output_Accept_Alternative is
Entry_Id : constant Entity_Id := Receiving_Entry (Target_Id);
begin
pragma Assert (Present (Entry_Id));
Error_Msg_NE ("\\ entry & selected #", Error_Nod, Entry_Id);
end Output_Accept_Alternative;
-----------------
-- Output_Call --
-----------------
procedure Output_Call (Kind : String) is
begin
Error_Msg_NE ("\\ " & Kind & " & called #", Error_Nod, Target_Id);
end Output_Call;
-------------------------
-- Output_Type_Actions --
-------------------------
procedure Output_Type_Actions (Action : String) is
Typ : constant Entity_Id := First_Formal_Type (Target_Id);
begin
pragma Assert (Present (Typ));
Error_Msg_NE
("\\ " & Action & " actions for type & #", Error_Nod, Typ);
end Output_Type_Actions;
------------------------------
-- Output_Verification_Call --
------------------------------
procedure Output_Verification_Call
(Pred : String;
Id : Entity_Id;
Id_Kind : String)
is
begin
pragma Assert (Present (Id));
Error_Msg_NE
("\\ " & Pred & " of " & Id_Kind & " & verified #",
Error_Nod, Id);
end Output_Verification_Call;
-- Start of processing for Output_Call
begin
Error_Msg_Sloc := Sloc (N);
-- Accept alternative
if Is_Accept_Alternative_Proc (Target_Id) then
Output_Accept_Alternative;
-- Adjustment
elsif Is_TSS (Target_Id, TSS_Deep_Adjust) then
Output_Type_Actions ("adjustment");
-- Default_Initial_Condition
elsif Is_Default_Initial_Condition_Proc (Target_Id) then
Output_Verification_Call
(Pred => "Default_Initial_Condition",
Id => First_Formal_Type (Target_Id),
Id_Kind => "type");
-- Entries
elsif Is_Protected_Entry (Target_Id) then
Output_Call ("entry");
-- Task entry calls are never processed because the entry being
-- invoked does not have a corresponding "body", it has a select. A
-- task entry call appears in the stack of active scenarios for the
-- sole purpose of checking No_Entry_Calls_In_Elaboration_Code and
-- nothing more.
elsif Is_Task_Entry (Target_Id) then
null;
-- Finalization
elsif Is_TSS (Target_Id, TSS_Deep_Finalize) then
Output_Type_Actions ("finalization");
-- Calls to _Finalizer procedures must not appear in the output
-- because this creates confusing noise.
elsif Is_Finalizer_Proc (Target_Id) then
null;
-- Initial_Condition
elsif Is_Initial_Condition_Proc (Target_Id) then
Output_Verification_Call
(Pred => "Initial_Condition",
Id => Find_Enclosing_Scope (N),
Id_Kind => "package");
-- Initialization
elsif Is_Init_Proc (Target_Id)
or else Is_TSS (Target_Id, TSS_Deep_Initialize)
then
Output_Type_Actions ("initialization");
-- Invariant
elsif Is_Invariant_Proc (Target_Id) then
Output_Verification_Call
(Pred => "invariants",
Id => First_Formal_Type (Target_Id),
Id_Kind => "type");
-- Partial invariant calls must not appear in the output because this
-- creates confusing noise. Note that a partial invariant is always
-- invoked by the "full" invariant which is already placed on the
-- stack.
elsif Is_Partial_Invariant_Proc (Target_Id) then
null;
-- _Postconditions
elsif Is_Postconditions_Proc (Target_Id) then
Output_Verification_Call
(Pred => "postconditions",
Id => Find_Enclosing_Scope (N),
Id_Kind => "subprogram");
-- Subprograms must come last because some of the previous cases fall
-- under this category.
elsif Ekind (Target_Id) = E_Function then
Output_Call ("function");
elsif Ekind (Target_Id) = E_Procedure then
Output_Call ("procedure");
else
pragma Assert (False);
null;
end if;
end Output_Call;
-------------------
-- Output_Header --
-------------------
procedure Output_Header is
Unit_Id : constant Entity_Id := Find_Top_Unit (Root_Scenario);
begin
if Ekind (Unit_Id) = E_Package then
Error_Msg_NE ("\\ spec of unit & elaborated", Error_Nod, Unit_Id);
elsif Ekind (Unit_Id) = E_Package_Body then
Error_Msg_NE ("\\ body of unit & elaborated", Error_Nod, Unit_Id);
else
Error_Msg_NE ("\\ in body of unit &", Error_Nod, Unit_Id);
end if;
end Output_Header;
--------------------------
-- Output_Instantiation --
--------------------------
procedure Output_Instantiation (N : Node_Id) is
procedure Output_Instantiation (Gen_Id : Entity_Id; Kind : String);
pragma Inline (Output_Instantiation);
-- Emit a specific diagnostic message concerning an instantiation of
-- generic unit Gen_Id. Kind denotes the kind of the instantiation.
--------------------------
-- Output_Instantiation --
--------------------------
procedure Output_Instantiation (Gen_Id : Entity_Id; Kind : String) is
begin
Error_Msg_NE
("\\ " & Kind & " & instantiated as & #", Error_Nod, Gen_Id);
end Output_Instantiation;
-- Local variables
Inst : Node_Id;
Inst_Attrs : Instantiation_Attributes;
Inst_Id : Entity_Id;
Gen_Id : Entity_Id;
-- Start of processing for Output_Instantiation
begin
Extract_Instantiation_Attributes
(Exp_Inst => N,
Inst => Inst,
Inst_Id => Inst_Id,
Gen_Id => Gen_Id,
Attrs => Inst_Attrs);
Error_Msg_Node_2 := Inst_Id;
Error_Msg_Sloc := Sloc (Inst);
if Nkind (Inst) = N_Function_Instantiation then
Output_Instantiation (Gen_Id, "function");
elsif Nkind (Inst) = N_Package_Instantiation then
Output_Instantiation (Gen_Id, "package");
elsif Nkind (Inst) = N_Procedure_Instantiation then
Output_Instantiation (Gen_Id, "procedure");
else
pragma Assert (False);
null;
end if;
end Output_Instantiation;
--------------------------------
-- Output_Variable_Assignment --
--------------------------------
procedure Output_Variable_Assignment (N : Node_Id) is
Var_Id : constant Entity_Id := Entity (Extract_Assignment_Name (N));
begin
Error_Msg_Sloc := Sloc (N);
Error_Msg_NE ("\\ variable & assigned #", Error_Nod, Var_Id);
end Output_Variable_Assignment;
-------------------------------
-- Output_Variable_Reference --
-------------------------------
procedure Output_Variable_Reference (N : Node_Id) is
Dummy : Variable_Attributes;
Var_Id : Entity_Id;
begin
Extract_Variable_Reference_Attributes
(Ref => N,
Var_Id => Var_Id,
Attrs => Dummy);
Error_Msg_Sloc := Sloc (N);
Error_Msg_NE ("\\ variable & referenced #", Error_Nod, Var_Id);
end Output_Variable_Reference;
-- Local variables
package Stack renames Scenario_Stack;
Dummy : Call_Attributes;
N : Node_Id;
Posted : Boolean;
Target_Id : Entity_Id;
-- Start of processing for Output_Active_Scenarios
begin
-- Active scenarios are emitted only when the static model is in effect
-- because there is an inherent order by which all these scenarios were
-- reached from the declaration or library level.
if not Static_Elaboration_Checks then
return;
end if;
Posted := False;
for Index in Stack.First .. Stack.Last loop
N := Stack.Table (Index);
if not Posted then
Posted := True;
Output_Header;
end if;
-- 'Access
if Nkind (N) = N_Attribute_Reference then
Output_Access (N);
-- Calls
elsif Is_Suitable_Call (N) then
Extract_Call_Attributes
(Call => N,
Target_Id => Target_Id,
Attrs => Dummy);
if Is_Activation_Proc (Target_Id) then
Output_Activation_Call (N);
else
Output_Call (N, Target_Id);
end if;
-- Instantiations
elsif Is_Suitable_Instantiation (N) then
Output_Instantiation (N);
-- Variable assignments
elsif Nkind (N) = N_Assignment_Statement then
Output_Variable_Assignment (N);
-- Variable references
elsif Is_Suitable_Variable_Reference (N) then
Output_Variable_Reference (N);
else
pragma Assert (False);
null;
end if;
end loop;
end Output_Active_Scenarios;
-------------------------
-- Pop_Active_Scenario --
-------------------------
procedure Pop_Active_Scenario (N : Node_Id) is
Top : Node_Id renames Scenario_Stack.Table (Scenario_Stack.Last);
begin
pragma Assert (Top = N);
Scenario_Stack.Decrement_Last;
end Pop_Active_Scenario;
--------------------
-- Process_Access --
--------------------
procedure Process_Access (Attr : Node_Id; In_Task_Body : Boolean) is
function Build_Access_Marker (Target_Id : Entity_Id) return Node_Id;
pragma Inline (Build_Access_Marker);
-- Create a suitable call marker which invokes target Target_Id
-------------------------
-- Build_Access_Marker --
-------------------------
function Build_Access_Marker (Target_Id : Entity_Id) return Node_Id is
Marker : Node_Id;
begin
Marker := Make_Call_Marker (Sloc (Attr));
-- Inherit relevant attributes from the attribute
-- Performance note: parent traversal
Set_Target (Marker, Target_Id);
Set_Is_Declaration_Level_Node
(Marker, Find_Enclosing_Level (Attr) = Declaration_Level);
Set_Is_Dispatching_Call
(Marker, False);
Set_Is_Elaboration_Checks_OK_Node
(Marker, Is_Elaboration_Checks_OK_Node (Attr));
Set_Is_Source_Call
(Marker, Comes_From_Source (Attr));
Set_Is_SPARK_Mode_On_Node
(Marker, Is_SPARK_Mode_On_Node (Attr));
-- Partially insert the call marker into the tree by setting its
-- parent pointer.
Set_Parent (Marker, Attr);
return Marker;
end Build_Access_Marker;
-- Local variables
Root : constant Node_Id := Root_Scenario;
Target_Id : constant Entity_Id := Entity (Prefix (Attr));
Target_Attrs : Target_Attributes;
-- Start of processing for Process_Access
begin
-- Output relevant information when switch -gnatel (info messages on
-- implicit Elaborate[_All] pragmas) is in effect.
if Elab_Info_Messages then
Error_Msg_NE
("info: access to & during elaboration", Attr, Target_Id);
end if;
Extract_Target_Attributes
(Target_Id => Target_Id,
Attrs => Target_Attrs);
-- Both the attribute and the corresponding body are in the same unit.
-- The corresponding body must appear prior to the root scenario which
-- started the recursive search. If this is not the case, then there is
-- a potential ABE if the access value is used to call the subprogram.
-- Emit a warning only when switch -gnatw.f (warnings on suspucious
-- 'Access) is in effect.
if Warn_On_Elab_Access
and then Present (Target_Attrs.Body_Decl)
and then In_Extended_Main_Code_Unit (Target_Attrs.Body_Decl)
and then Earlier_In_Extended_Unit (Root, Target_Attrs.Body_Decl)
then
Error_Msg_Name_1 := Attribute_Name (Attr);
Error_Msg_NE ("??% attribute of & before body seen", Attr, Target_Id);
Error_Msg_N ("\possible Program_Error on later references", Attr);
Output_Active_Scenarios (Attr);
end if;
-- Treat the attribute as an immediate invocation of the target when
-- switch -gnatd.o (conservarive elaboration order for indirect calls)
-- is in effect. Note that the prior elaboration of the unit containing
-- the target is ensured processing the corresponding call marker.
if Debug_Flag_Dot_O then
Process_Scenario
(N => Build_Access_Marker (Target_Id),
In_Task_Body => In_Task_Body);
-- Otherwise ensure that the unit with the corresponding body is
-- elaborated prior to the main unit.
else
Ensure_Prior_Elaboration
(N => Attr,
Unit_Id => Target_Attrs.Unit_Id,
In_Task_Body => In_Task_Body);
end if;
end Process_Access;
-----------------------------
-- Process_Activation_Call --
-----------------------------
procedure Process_Activation_Call
(Call : Node_Id;
Call_Attrs : Call_Attributes;
In_Task_Body : Boolean)
is
procedure Process_Task_Object (Obj_Id : Entity_Id; Typ : Entity_Id);
-- Perform ABE checks and diagnostics for object Obj_Id with type Typ.
-- Typ may be a task type or a composite type with at least one task
-- component.
procedure Process_Task_Objects (List : List_Id);
-- Perform ABE checks and diagnostics for all task objects found in
-- the list List.
-------------------------
-- Process_Task_Object --
-------------------------
procedure Process_Task_Object (Obj_Id : Entity_Id; Typ : Entity_Id) is
Base_Typ : constant Entity_Id := Base_Type (Typ);
Comp_Id : Entity_Id;
Task_Attrs : Task_Attributes;
begin
if Is_Task_Type (Typ) then
Extract_Task_Attributes
(Typ => Base_Typ,
Attrs => Task_Attrs);
Process_Single_Activation
(Call => Call,
Call_Attrs => Call_Attrs,
Obj_Id => Obj_Id,
Task_Attrs => Task_Attrs,
In_Task_Body => In_Task_Body);
-- Examine the component type when the object is an array
elsif Is_Array_Type (Typ) and then Has_Task (Base_Typ) then
Process_Task_Object (Obj_Id, Component_Type (Typ));
-- Examine individual component types when the object is a record
elsif Is_Record_Type (Typ) and then Has_Task (Base_Typ) then
Comp_Id := First_Component (Typ);
while Present (Comp_Id) loop
Process_Task_Object (Obj_Id, Etype (Comp_Id));
Next_Component (Comp_Id);
end loop;
end if;
end Process_Task_Object;
--------------------------
-- Process_Task_Objects --
--------------------------
procedure Process_Task_Objects (List : List_Id) is
Item : Node_Id;
Item_Id : Entity_Id;
Item_Typ : Entity_Id;
begin
-- Examine the contents of the list looking for an object declaration
-- of a task type or one that contains a task within.
Item := First (List);
while Present (Item) loop
if Nkind (Item) = N_Object_Declaration then
Item_Id := Defining_Entity (Item);
Item_Typ := Etype (Item_Id);
if Has_Task (Item_Typ) then
Process_Task_Object (Item_Id, Item_Typ);
end if;
end if;
Next (Item);
end loop;
end Process_Task_Objects;
-- Local variables
Context : Node_Id;
Spec : Node_Id;
-- Start of processing for Process_Activation_Call
begin
-- Nothing to do when the activation is a guaranteed ABE
if Is_Known_Guaranteed_ABE (Call) then
return;
end if;
-- Find the proper context of the activation call where all task objects
-- being activated are declared. This is usually the immediate parent of
-- the call.
Context := Parent (Call);
-- In the case of package bodies, the activation call is in the handled
-- sequence of statements, but the task objects are in the declaration
-- list of the body.
if Nkind (Context) = N_Handled_Sequence_Of_Statements
and then Nkind (Parent (Context)) = N_Package_Body
then
Context := Parent (Context);
end if;
-- Process all task objects defined in both the spec and body when the
-- activation call precedes the "begin" of a package body.
if Nkind (Context) = N_Package_Body then
Spec :=
Specification
(Unit_Declaration_Node (Corresponding_Spec (Context)));
Process_Task_Objects (Visible_Declarations (Spec));
Process_Task_Objects (Private_Declarations (Spec));
Process_Task_Objects (Declarations (Context));
-- Process all task objects defined in the spec when the activation call
-- appears at the end of a package spec.
elsif Nkind (Context) = N_Package_Specification then
Process_Task_Objects (Visible_Declarations (Context));
Process_Task_Objects (Private_Declarations (Context));
-- Otherwise the context of the activation is some construct with a
-- declarative part. Note that the corresponding record type of a task
-- type is controlled. Because of this, the finalization machinery must
-- relocate the task object to the handled statements of the construct
-- to perform proper finalization in case of an exception. Examine the
-- statements of the construct rather than the declarations.
else
pragma Assert (Nkind (Context) = N_Handled_Sequence_Of_Statements);
Process_Task_Objects (Statements (Context));
end if;
end Process_Activation_Call;
---------------------------------------------
-- Process_Activation_Conditional_ABE_Impl --
---------------------------------------------
procedure Process_Activation_Conditional_ABE_Impl
(Call : Node_Id;
Call_Attrs : Call_Attributes;
Obj_Id : Entity_Id;
Task_Attrs : Task_Attributes;
In_Task_Body : Boolean)
is
Check_OK : constant Boolean :=
not Is_Ignored_Ghost_Entity (Obj_Id)
and then not Task_Attrs.Ghost_Mode_Ignore
and then Is_Elaboration_Checks_OK_Id (Obj_Id)
and then Task_Attrs.Elab_Checks_OK;
-- A run-time ABE check may be installed only when the object and the
-- task type have active elaboration checks, and both are not ignored
-- Ghost constructs.
Root : constant Node_Id := Root_Scenario;
begin
-- Output relevant information when switch -gnatel (info messages on
-- implicit Elaborate[_All] pragmas) is in effect.
if Elab_Info_Messages then
Error_Msg_NE
("info: activation of & during elaboration", Call, Obj_Id);
end if;
-- Nothing to do when the activation is a guaranteed ABE
if Is_Known_Guaranteed_ABE (Call) then
return;
-- Nothing to do when the root scenario appears at the declaration
-- level and the task is in the same unit, but outside this context.
-- task type Task_Typ; -- task declaration
-- procedure Proc is
-- function A ... is
-- begin
-- if Some_Condition then
-- declare
-- T : Task_Typ;
-- begin
-- <activation call> -- activation site
-- end;
-- ...
-- end A;
-- X : ... := A; -- root scenario
-- ...
-- task body Task_Typ is
-- ...
-- end Task_Typ;
-- In the example above, the context of X is the declarative list of
-- Proc. The "elaboration" of X may reach the activation of T whose body
-- is defined outside of X's context. The task body is relevant only
-- when Proc is invoked, but this happens only in "normal" elaboration,
-- therefore the task body must not be considered if this is not the
-- case.
-- Performance note: parent traversal
elsif Is_Up_Level_Target (Task_Attrs.Task_Decl) then
return;
-- Nothing to do when the activation is ABE-safe
-- generic
-- package Gen is
-- task type Task_Typ;
-- end Gen;
-- package body Gen is
-- task body Task_Typ is
-- begin
-- ...
-- end Task_Typ;
-- end Gen;
-- with Gen;
-- procedure Main is
-- package Nested is
-- ...
-- end Nested;
-- package body Nested is
-- package Inst is new Gen;
-- T : Inst.Task_Typ;
-- [begin]
-- <activation call> -- safe activation
-- end Nested;
-- ...
elsif Is_Safe_Activation (Call, Task_Attrs.Task_Decl) then
-- Note that the task body must still be examined for any nested
-- scenarios.
null;
-- The activation call and the task body are both in the main unit
elsif Present (Task_Attrs.Body_Decl)
and then In_Extended_Main_Code_Unit (Task_Attrs.Body_Decl)
then
-- If the root scenario appears prior to the task body, then this is
-- a possible ABE with respect to the root scenario.
-- task type Task_Typ;
-- function A ... is
-- begin
-- if Some_Condition then
-- declare
-- package Pack is
-- ...
-- end Pack;
-- package body Pack is
-- T : Task_Typ;
-- [begin]
-- <activation call> -- activation of T
-- end Pack;
-- ...
-- end A;
-- X : ... := A; -- root scenario
-- task body Task_Typ is -- task body
-- ...
-- end Task_Typ;
-- Y : ... := A; -- root scenario
-- IMPORTANT: The activation of T is a possible ABE for X, but
-- not for Y. Intalling an unconditional ABE raise prior to the
-- activation call would be wrong as it will fail for Y as well
-- but in Y's case the activation of T is never an ABE.
if Earlier_In_Extended_Unit (Root, Task_Attrs.Body_Decl) then
-- ABE diagnostics are emitted only in the static model because
-- there is a well-defined order to visiting scenarios. Without
-- this order diagnostics appear jumbled and result in unwanted
-- noise.
if Static_Elaboration_Checks then
Error_Msg_Sloc := Sloc (Call);
Error_Msg_N
("??task & will be activated # before elaboration of its "
& "body", Obj_Id);
Error_Msg_N
("\Program_Error may be raised at run time", Obj_Id);
Output_Active_Scenarios (Obj_Id);
end if;
-- Install a conditional run-time ABE check to verify that the
-- task body has been elaborated prior to the activation call.
if Check_OK then
Install_ABE_Check
(N => Call,
Ins_Nod => Call,
Target_Id => Task_Attrs.Spec_Id,
Target_Decl => Task_Attrs.Task_Decl,
Target_Body => Task_Attrs.Body_Decl);
end if;
end if;
-- Otherwise the task body is not available in this compilation or it
-- resides in an external unit. Install a run-time ABE check to verify
-- that the task body has been elaborated prior to the activation call
-- when the dynamic model is in effect.
elsif Dynamic_Elaboration_Checks and then Check_OK then
Install_ABE_Check
(N => Call,
Ins_Nod => Call,
Id => Task_Attrs.Unit_Id);
end if;
-- Both the activation call and task type are subject to SPARK_Mode
-- On, this triggers the SPARK rules for task activation. Compared to
-- calls and instantiations, task activation in SPARK does not require
-- the presence of Elaborate[_All] pragmas in case the task type is
-- defined outside the main unit. This is because SPARK utilizes a
-- special policy which activates all tasks after the main unit has
-- finished its elaboration.
if Call_Attrs.SPARK_Mode_On and Task_Attrs.SPARK_Mode_On then
null;
-- Otherwise the Ada rules are in effect. Ensure that the unit with the
-- task body is elaborated prior to the main unit.
else
Ensure_Prior_Elaboration
(N => Call,
Unit_Id => Task_Attrs.Unit_Id,
In_Task_Body => In_Task_Body);
end if;
Traverse_Body (Task_Attrs.Body_Decl, In_Task_Body => True);
end Process_Activation_Conditional_ABE_Impl;
procedure Process_Activation_Conditional_ABE is
new Process_Activation_Call (Process_Activation_Conditional_ABE_Impl);
--------------------------------------------
-- Process_Activation_Guaranteed_ABE_Impl --
--------------------------------------------
procedure Process_Activation_Guaranteed_ABE_Impl
(Call : Node_Id;
Call_Attrs : Call_Attributes;
Obj_Id : Entity_Id;
Task_Attrs : Task_Attributes;
In_Task_Body : Boolean)
is
pragma Unreferenced (Call_Attrs);
pragma Unreferenced (In_Task_Body);
Check_OK : constant Boolean :=
not Is_Ignored_Ghost_Entity (Obj_Id)
and then not Task_Attrs.Ghost_Mode_Ignore
and then Is_Elaboration_Checks_OK_Id (Obj_Id)
and then Task_Attrs.Elab_Checks_OK;
-- A run-time ABE check may be installed only when the object and the
-- task type have active elaboration checks, and both are not ignored
-- Ghost constructs.
begin
-- Nothing to do when the root scenario appears at the declaration
-- level and the task is in the same unit, but outside this context.
-- task type Task_Typ; -- task declaration
-- procedure Proc is
-- function A ... is
-- begin
-- if Some_Condition then
-- declare
-- T : Task_Typ;
-- begin
-- <activation call> -- activation site
-- end;
-- ...
-- end A;
-- X : ... := A; -- root scenario
-- ...
-- task body Task_Typ is
-- ...
-- end Task_Typ;
-- In the example above, the context of X is the declarative list of
-- Proc. The "elaboration" of X may reach the activation of T whose body
-- is defined outside of X's context. The task body is relevant only
-- when Proc is invoked, but this happens only in "normal" elaboration,
-- therefore the task body must not be considered if this is not the
-- case.
-- Performance note: parent traversal
if Is_Up_Level_Target (Task_Attrs.Task_Decl) then
return;
-- Nothing to do when the activation is ABE-safe
-- generic
-- package Gen is
-- task type Task_Typ;
-- end Gen;
-- package body Gen is
-- task body Task_Typ is
-- begin
-- ...
-- end Task_Typ;
-- end Gen;
-- with Gen;
-- procedure Main is
-- package Nested is
-- ...
-- end Nested;
-- package body Nested is
-- package Inst is new Gen;
-- T : Inst.Task_Typ;
-- [begin]
-- <activation call> -- safe activation
-- end Nested;
-- ...
elsif Is_Safe_Activation (Call, Task_Attrs.Task_Decl) then
return;
-- An activation call leads to a guaranteed ABE when the activation
-- call and the task appear within the same context ignoring library
-- levels, and the body of the task has not been seen yet or appears
-- after the activation call.
-- procedure Guaranteed_ABE is
-- task type Task_Typ;
-- package Nested is
-- ...
-- end Nested;
-- package body Nested is
-- T : Task_Typ;
-- [begin]
-- <activation call> -- guaranteed ABE
-- end Nested;
-- task body Task_Typ is
-- ...
-- end Task_Typ;
-- ...
-- Performance note: parent traversal
elsif Is_Guaranteed_ABE
(N => Call,
Target_Decl => Task_Attrs.Task_Decl,
Target_Body => Task_Attrs.Body_Decl)
then
Error_Msg_Sloc := Sloc (Call);
Error_Msg_N
("??task & will be activated # before elaboration of its body",
Obj_Id);
Error_Msg_N ("\Program_Error will be raised at run time", Obj_Id);
-- Mark the activation call as a guaranteed ABE
Set_Is_Known_Guaranteed_ABE (Call);
-- Install a run-time ABE failue because this activation call will
-- always result in an ABE.
if Check_OK then
Install_ABE_Failure
(N => Call,
Ins_Nod => Call);
end if;
end if;
end Process_Activation_Guaranteed_ABE_Impl;
procedure Process_Activation_Guaranteed_ABE is
new Process_Activation_Call (Process_Activation_Guaranteed_ABE_Impl);
------------------
-- Process_Call --
------------------
procedure Process_Call
(Call : Node_Id;
Call_Attrs : Call_Attributes;
Target_Id : Entity_Id;
In_Task_Body : Boolean)
is
SPARK_Rules_On : Boolean;
Target_Attrs : Target_Attributes;
begin
Extract_Target_Attributes
(Target_Id => Target_Id,
Attrs => Target_Attrs);
-- The SPARK rules are in effect when both the call and target are
-- subject to SPARK_Mode On.
SPARK_Rules_On :=
Call_Attrs.SPARK_Mode_On and Target_Attrs.SPARK_Mode_On;
-- Output relevant information when switch -gnatel (info messages on
-- implicit Elaborate[_All] pragmas) is in effect.
if Elab_Info_Messages then
Info_Call
(Call => Call,
Target_Id => Target_Id,
Info_Msg => True,
In_SPARK => SPARK_Rules_On);
end if;
-- Check whether the invocation of an entry clashes with an existing
-- restriction.
if Is_Protected_Entry (Target_Id) then
Check_Restriction (No_Entry_Calls_In_Elaboration_Code, Call);
elsif Is_Task_Entry (Target_Id) then
Check_Restriction (No_Entry_Calls_In_Elaboration_Code, Call);
-- Task entry calls are never processed because the entry being
-- invoked does not have a corresponding "body", it has a select.
return;
end if;
-- Nothing to do when the call is a guaranteed ABE
if Is_Known_Guaranteed_ABE (Call) then
return;
-- Nothing to do when the root scenario appears at the declaration level
-- and the target is in the same unit, but outside this context.
-- function B ...; -- target declaration
-- procedure Proc is
-- function A ... is
-- begin
-- if Some_Condition then
-- return B; -- call site
-- ...
-- end A;
-- X : ... := A; -- root scenario
-- ...
-- function B ... is
-- ...
-- end B;
-- In the example above, the context of X is the declarative region of
-- Proc. The "elaboration" of X may eventually reach B which is defined
-- outside of X's context. B is relevant only when Proc is invoked, but
-- this happens only by means of "normal" elaboration, therefore B must
-- not be considered if this is not the case.
-- Performance note: parent traversal
elsif Is_Up_Level_Target (Target_Attrs.Spec_Decl) then
return;
-- The SPARK rules are in effect
elsif SPARK_Rules_On then
Process_Call_SPARK
(Call => Call,
Call_Attrs => Call_Attrs,
Target_Id => Target_Id,
Target_Attrs => Target_Attrs);
-- Otherwise the Ada rules are in effect
else
Process_Call_Ada
(Call => Call,
Call_Attrs => Call_Attrs,
Target_Id => Target_Id,
Target_Attrs => Target_Attrs,
In_Task_Body => In_Task_Body);
end if;
-- Inspect the target body (and barried function) for other suitable
-- elaboration scenarios.
Traverse_Body (Target_Attrs.Body_Barf, In_Task_Body);
Traverse_Body (Target_Attrs.Body_Decl, In_Task_Body);
end Process_Call;
----------------------
-- Process_Call_Ada --
----------------------
procedure Process_Call_Ada
(Call : Node_Id;
Call_Attrs : Call_Attributes;
Target_Id : Entity_Id;
Target_Attrs : Target_Attributes;
In_Task_Body : Boolean)
is
function In_Initialization_Context (N : Node_Id) return Boolean;
-- Determine whether arbitrary node N appears within a type init proc or
-- primitive [Deep_]Initialize.
-------------------------------
-- In_Initialization_Context --
-------------------------------
function In_Initialization_Context (N : Node_Id) return Boolean is
Par : Node_Id;
Spec_Id : Entity_Id;
begin
-- Climb the parent chain looking for initialization actions
Par := Parent (N);
while Present (Par) loop
-- A block may be part of the initialization actions of a default
-- initialized object.
if Nkind (Par) = N_Block_Statement
and then Is_Initialization_Block (Par)
then
return True;
-- A subprogram body may denote an initialization routine
elsif Nkind (Par) = N_Subprogram_Body then
Spec_Id := Unique_Defining_Entity (Par);
-- The current subprogram body denotes a type init proc or
-- primitive [Deep_]Initialize.
if Is_Init_Proc (Spec_Id)
or else Is_Controlled_Proc (Spec_Id, Name_Initialize)
or else Is_TSS (Spec_Id, TSS_Deep_Initialize)
then
return True;
end if;
-- Prevent the search from going too far
elsif Is_Body_Or_Package_Declaration (Par) then
exit;
end if;
Par := Parent (Par);
end loop;
return False;
end In_Initialization_Context;
-- Local variables
Check_OK : constant Boolean :=
not Call_Attrs.Ghost_Mode_Ignore
and then not Target_Attrs.Ghost_Mode_Ignore
and then Call_Attrs.Elab_Checks_OK
and then Target_Attrs.Elab_Checks_OK;
-- A run-time ABE check may be installed only when both the call and the
-- target have active elaboration checks, and both are not ignored Ghost
-- constructs.
-- Start of processing for Process_Call_Ada
begin
-- Nothing to do for an Ada dispatching call because there are no ABE
-- diagnostics for either models. ABE checks for the dynamic model are
-- handled by Install_Primitive_Elaboration_Check.
if Call_Attrs.Is_Dispatching then
return;
-- Nothing to do when the call is ABE-safe
-- generic
-- function Gen ...;
-- function Gen ... is
-- begin
-- ...
-- end Gen;
-- with Gen;
-- procedure Main is
-- function Inst is new Gen;
-- X : ... := Inst; -- safe call
-- ...
elsif Is_Safe_Call (Call, Target_Attrs) then
return;
-- The call and the target body are both in the main unit
elsif Present (Target_Attrs.Body_Decl)
and then In_Extended_Main_Code_Unit (Target_Attrs.Body_Decl)
then
Process_Call_Conditional_ABE
(Call => Call,
Call_Attrs => Call_Attrs,
Target_Id => Target_Id,
Target_Attrs => Target_Attrs);
-- Otherwise the target body is not available in this compilation or it
-- resides in an external unit. Install a run-time ABE check to verify
-- that the target body has been elaborated prior to the call site when
-- the dynamic model is in effect.
elsif Dynamic_Elaboration_Checks and then Check_OK then
Install_ABE_Check
(N => Call,
Ins_Nod => Call,
Id => Target_Attrs.Unit_Id);
end if;
-- No implicit pragma Elaborate[_All] is generated when the call has
-- elaboration checks suppressed. This behaviour parallels that of the
-- old ABE mechanism.
if not Call_Attrs.Elab_Checks_OK then
null;
-- No implicit pragma Elaborate[_All] is generated for finalization
-- actions when primitive [Deep_]Finalize is not defined in the main
-- unit and the call appears within some initialization actions. This
-- behaviour parallels that of the old ABE mechanism.
-- Performance note: parent traversal
elsif (Is_Controlled_Proc (Target_Id, Name_Finalize)
or else Is_TSS (Target_Id, TSS_Deep_Finalize))
and then not In_Extended_Main_Code_Unit (Target_Attrs.Spec_Decl)
and then In_Initialization_Context (Call)
then
null;
-- Otherwise ensure that the unit with the target body is elaborated
-- prior to the main unit.
else
Ensure_Prior_Elaboration
(N => Call,
Unit_Id => Target_Attrs.Unit_Id,
In_Task_Body => In_Task_Body);
end if;
end Process_Call_Ada;
----------------------------------
-- Process_Call_Conditional_ABE --
----------------------------------
procedure Process_Call_Conditional_ABE
(Call : Node_Id;
Call_Attrs : Call_Attributes;
Target_Id : Entity_Id;
Target_Attrs : Target_Attributes)
is
Check_OK : constant Boolean :=
not Call_Attrs.Ghost_Mode_Ignore
and then not Target_Attrs.Ghost_Mode_Ignore
and then Call_Attrs.Elab_Checks_OK
and then Target_Attrs.Elab_Checks_OK;
-- A run-time ABE check may be installed only when both the call and the
-- target have active elaboration checks, and both are not ignored Ghost
-- constructs.
Root : constant Node_Id := Root_Scenario;
begin
-- If the root scenario appears prior to the target body, then this is a
-- possible ABE with respect to the root scenario.
-- function B ...;
-- function A ... is
-- begin
-- if Some_Condition then
-- return B; -- call site
-- ...
-- end A;
-- X : ... := A; -- root scenario
-- function B ... is -- target body
-- ...
-- end B;
-- Y : ... := A; -- root scenario
-- IMPORTANT: The call to B from A is a possible ABE for X, but not for
-- Y. Installing an unconditional ABE raise prior to the call to B would
-- be wrong as it will fail for Y as well, but in Y's case the call to B
-- is never an ABE.
if Earlier_In_Extended_Unit (Root, Target_Attrs.Body_Decl) then
-- ABE diagnostics are emitted only in the static model because there
-- is a well-defined order to visiting scenarios. Without this order
-- diagnostics appear jumbled and result in unwanted noise.
if Static_Elaboration_Checks then
Error_Msg_NE ("??cannot call & before body seen", Call, Target_Id);
Error_Msg_N ("\Program_Error may be raised at run time", Call);
Output_Active_Scenarios (Call);
end if;
-- Install a conditional run-time ABE check to verify that the target
-- body has been elaborated prior to the call.
if Check_OK then
Install_ABE_Check
(N => Call,
Ins_Nod => Call,
Target_Id => Target_Attrs.Spec_Id,
Target_Decl => Target_Attrs.Spec_Decl,
Target_Body => Target_Attrs.Body_Decl);
end if;
end if;
end Process_Call_Conditional_ABE;
---------------------------------
-- Process_Call_Guaranteed_ABE --
---------------------------------
procedure Process_Call_Guaranteed_ABE
(Call : Node_Id;
Call_Attrs : Call_Attributes;
Target_Id : Entity_Id)
is
Target_Attrs : Target_Attributes;
begin
Extract_Target_Attributes
(Target_Id => Target_Id,
Attrs => Target_Attrs);
-- Nothing to do when the root scenario appears at the declaration level
-- and the target is in the same unit, but outside this context.
-- function B ...; -- target declaration
-- procedure Proc is
-- function A ... is
-- begin
-- if Some_Condition then
-- return B; -- call site
-- ...
-- end A;
-- X : ... := A; -- root scenario
-- ...
-- function B ... is
-- ...
-- end B;
-- In the example above, the context of X is the declarative region of
-- Proc. The "elaboration" of X may eventually reach B which is defined
-- outside of X's context. B is relevant only when Proc is invoked, but
-- this happens only by means of "normal" elaboration, therefore B must
-- not be considered if this is not the case.
-- Performance note: parent traversal
if Is_Up_Level_Target (Target_Attrs.Spec_Decl) then
return;
-- Nothing to do when the call is ABE-safe
-- generic
-- function Gen ...;
-- function Gen ... is
-- begin
-- ...
-- end Gen;
-- with Gen;
-- procedure Main is
-- function Inst is new Gen;
-- X : ... := Inst; -- safe call
-- ...
elsif Is_Safe_Call (Call, Target_Attrs) then
return;
-- A call leads to a guaranteed ABE when the call and the target appear
-- within the same context ignoring library levels, and the body of the
-- target has not been seen yet or appears after the call.
-- procedure Guaranteed_ABE is
-- function Func ...;
-- package Nested is
-- Obj : ... := Func; -- guaranteed ABE
-- end Nested;
-- function Func ... is
-- ...
-- end Func;
-- ...
-- Performance note: parent traversal
elsif Is_Guaranteed_ABE
(N => Call,
Target_Decl => Target_Attrs.Spec_Decl,
Target_Body => Target_Attrs.Body_Decl)
then
Error_Msg_NE ("??cannot call & before body seen", Call, Target_Id);
Error_Msg_N ("\Program_Error will be raised at run time", Call);
-- Mark the call as a guarnateed ABE
Set_Is_Known_Guaranteed_ABE (Call);
-- Install a run-time ABE failure because the call will always result
-- in an ABE. The failure is installed when both the call and target
-- have enabled elaboration checks, and both are not ignored Ghost
-- constructs.
if Call_Attrs.Elab_Checks_OK
and then Target_Attrs.Elab_Checks_OK
and then not Call_Attrs.Ghost_Mode_Ignore
and then not Target_Attrs.Ghost_Mode_Ignore
then
Install_ABE_Failure
(N => Call,
Ins_Nod => Call);
end if;
end if;
end Process_Call_Guaranteed_ABE;
------------------------
-- Process_Call_SPARK --
------------------------
procedure Process_Call_SPARK
(Call : Node_Id;
Call_Attrs : Call_Attributes;
Target_Id : Entity_Id;
Target_Attrs : Target_Attributes)
is
begin
-- A call to a source target or to a target which emulates Ada or SPARK
-- semantics imposes an Elaborate_All requirement on the context of the
-- main unit. Determine whether the context has a pragma strong enough
-- to meet the requirement. The check is orthogonal to the ABE effects
-- of the call.
if Target_Attrs.From_Source
or else Is_Ada_Semantic_Target (Target_Id)
or else Is_SPARK_Semantic_Target (Target_Id)
then
Meet_Elaboration_Requirement
(N => Call,
Target_Id => Target_Id,
Req_Nam => Name_Elaborate_All);
end if;
-- Nothing to do when the call is ABE-safe
-- generic
-- function Gen ...;
-- function Gen ... is
-- begin
-- ...
-- end Gen;
-- with Gen;
-- procedure Main is
-- function Inst is new Gen;
-- X : ... := Inst; -- safe call
-- ...
if Is_Safe_Call (Call, Target_Attrs) then
return;
-- The call and the target body are both in the main unit
elsif Present (Target_Attrs.Body_Decl)
and then In_Extended_Main_Code_Unit (Target_Attrs.Body_Decl)
then
Process_Call_Conditional_ABE
(Call => Call,
Call_Attrs => Call_Attrs,
Target_Id => Target_Id,
Target_Attrs => Target_Attrs);
-- Otherwise the target body is not available in this compilation or it
-- resides in an external unit. There is no need to guarantee the prior
-- elaboration of the unit with the target body because either the main
-- unit meets the Elaborate_All requirement imposed by the call, or the
-- program is illegal.
else
null;
end if;
end Process_Call_SPARK;
----------------------------
-- Process_Guaranteed_ABE --
----------------------------
procedure Process_Guaranteed_ABE (N : Node_Id) is
Call_Attrs : Call_Attributes;
Target_Id : Entity_Id;
begin
-- Add the current scenario to the stack of active scenarios
Push_Active_Scenario (N);
-- Only calls, instantiations, and task activations may result in a
-- guaranteed ABE.
if Is_Suitable_Call (N) then
Extract_Call_Attributes
(Call => N,
Target_Id => Target_Id,
Attrs => Call_Attrs);
if Is_Activation_Proc (Target_Id) then
Process_Activation_Guaranteed_ABE
(Call => N,
Call_Attrs => Call_Attrs,
In_Task_Body => False);
else
Process_Call_Guaranteed_ABE
(Call => N,
Call_Attrs => Call_Attrs,
Target_Id => Target_Id);
end if;
elsif Is_Suitable_Instantiation (N) then
Process_Instantiation_Guaranteed_ABE (N);
end if;
-- Remove the current scenario from the stack of active scenarios once
-- all ABE diagnostics and checks have been performed.
Pop_Active_Scenario (N);
end Process_Guaranteed_ABE;
---------------------------
-- Process_Instantiation --
---------------------------
procedure Process_Instantiation
(Exp_Inst : Node_Id;
In_Task_Body : Boolean)
is
Gen_Attrs : Target_Attributes;
Gen_Id : Entity_Id;
Inst : Node_Id;
Inst_Attrs : Instantiation_Attributes;
Inst_Id : Entity_Id;
SPARK_Rules_On : Boolean;
-- This flag is set when the SPARK rules are in effect
begin
Extract_Instantiation_Attributes
(Exp_Inst => Exp_Inst,
Inst => Inst,
Inst_Id => Inst_Id,
Gen_Id => Gen_Id,
Attrs => Inst_Attrs);
Extract_Target_Attributes (Gen_Id, Gen_Attrs);
-- The SPARK rules are in effect when both the instantiation and generic
-- are subject to SPARK_Mode On.
SPARK_Rules_On := Inst_Attrs.SPARK_Mode_On and Gen_Attrs.SPARK_Mode_On;
-- Output relevant information when switch -gnatel (info messages on
-- implicit Elaborate[_All] pragmas) is in effect.
if Elab_Info_Messages then
Info_Instantiation
(Inst => Inst,
Gen_Id => Gen_Id,
Info_Msg => True,
In_SPARK => SPARK_Rules_On);
end if;
-- Nothing to do when the instantiation is a guaranteed ABE
if Is_Known_Guaranteed_ABE (Inst) then
return;
-- Nothing to do when the root scenario appears at the declaration level
-- and the generic is in the same unit, but outside this context.
-- generic
-- procedure Gen is ...; -- generic declaration
-- procedure Proc is
-- function A ... is
-- begin
-- if Some_Condition then
-- declare
-- procedure I is new Gen; -- instantiation site
-- ...
-- ...
-- end A;
-- X : ... := A; -- root scenario
-- ...
-- procedure Gen is
-- ...
-- end Gen;
-- In the example above, the context of X is the declarative region of
-- Proc. The "elaboration" of X may eventually reach Gen which appears
-- outside of X's context. Gen is relevant only when Proc is invoked,
-- but this happens only by means of "normal" elaboration, therefore
-- Gen must not be considered if this is not the case.
-- Performance note: parent traversal
elsif Is_Up_Level_Target (Gen_Attrs.Spec_Decl) then
return;
-- The SPARK rules are in effect
elsif SPARK_Rules_On then
Process_Instantiation_SPARK
(Exp_Inst => Exp_Inst,
Inst => Inst,
Inst_Attrs => Inst_Attrs,
Gen_Id => Gen_Id,
Gen_Attrs => Gen_Attrs);
-- Otherwise the Ada rules are in effect
else
Process_Instantiation_Ada
(Exp_Inst => Exp_Inst,
Inst => Inst,
Inst_Attrs => Inst_Attrs,
Gen_Id => Gen_Id,
Gen_Attrs => Gen_Attrs,
In_Task_Body => In_Task_Body);
end if;
end Process_Instantiation;
-------------------------------
-- Process_Instantiation_Ada --
-------------------------------
procedure Process_Instantiation_Ada
(Exp_Inst : Node_Id;
Inst : Node_Id;
Inst_Attrs : Instantiation_Attributes;
Gen_Id : Entity_Id;
Gen_Attrs : Target_Attributes;
In_Task_Body : Boolean)
is
Check_OK : constant Boolean :=
not Inst_Attrs.Ghost_Mode_Ignore
and then not Gen_Attrs.Ghost_Mode_Ignore
and then Inst_Attrs.Elab_Checks_OK
and then Gen_Attrs.Elab_Checks_OK;
-- A run-time ABE check may be installed only when both the instance and
-- the generic have active elaboration checks and both are not ignored
-- Ghost constructs.
begin
-- Nothing to do when the instantiation is ABE-safe
-- generic
-- package Gen is
-- ...
-- end Gen;
-- package body Gen is
-- ...
-- end Gen;
-- with Gen;
-- procedure Main is
-- package Inst is new Gen (ABE); -- safe instantiation
-- ...
if Is_Safe_Instantiation (Inst, Gen_Attrs) then
return;
-- The instantiation and the generic body are both in the main unit
elsif Present (Gen_Attrs.Body_Decl)
and then In_Extended_Main_Code_Unit (Gen_Attrs.Body_Decl)
then
Process_Instantiation_Conditional_ABE
(Exp_Inst => Exp_Inst,
Inst => Inst,
Inst_Attrs => Inst_Attrs,
Gen_Id => Gen_Id,
Gen_Attrs => Gen_Attrs);
-- Otherwise the generic body is not available in this compilation or it
-- resides in an external unit. Install a run-time ABE check to verify
-- that the generic body has been elaborated prior to the instantiation
-- when the dynamic model is in effect.
elsif Dynamic_Elaboration_Checks and then Check_OK then
Install_ABE_Check
(N => Inst,
Ins_Nod => Exp_Inst,
Id => Gen_Attrs.Unit_Id);
end if;
-- Ensure that the unit with the generic body is elaborated prior to
-- the main unit. No implicit pragma Elaborate[_All] is generated if
-- the instantiation has elaboration checks suppressed. This behaviour
-- parallels that of the old ABE mechanism.
if Inst_Attrs.Elab_Checks_OK then
Ensure_Prior_Elaboration
(N => Inst,
Unit_Id => Gen_Attrs.Unit_Id,
In_Task_Body => In_Task_Body);
end if;
end Process_Instantiation_Ada;
-------------------------------------------
-- Process_Instantiation_Conditional_ABE --
-------------------------------------------
procedure Process_Instantiation_Conditional_ABE
(Exp_Inst : Node_Id;
Inst : Node_Id;
Inst_Attrs : Instantiation_Attributes;
Gen_Id : Entity_Id;
Gen_Attrs : Target_Attributes)
is
Check_OK : constant Boolean :=
not Inst_Attrs.Ghost_Mode_Ignore
and then not Gen_Attrs.Ghost_Mode_Ignore
and then Inst_Attrs.Elab_Checks_OK
and then Gen_Attrs.Elab_Checks_OK;
-- A run-time ABE check may be installed only when both the instance and
-- the generic have active elaboration checks and both are not ignored
-- Ghost constructs.
Root : constant Node_Id := Root_Scenario;
begin
-- If the root scenario appears prior to the generic body, then this is
-- a possible ABE with respect to the root scenario.
-- generic
-- package Gen is
-- ...
-- end Gen;
-- function A ... is
-- begin
-- if Some_Condition then
-- declare
-- package Inst is new Gen; -- instantiation site
-- ...
-- end A;
-- X : ... := A; -- root scenario
-- package body Gen is -- generic body
-- ...
-- end Gen;
-- Y : ... := A; -- root scenario
-- IMPORTANT: The instantiation of Gen is a possible ABE for X, but not
-- for Y. Installing an unconditional ABE raise prior to the instance
-- site would be wrong as it will fail for Y as well, but in Y's case
-- the instantiation of Gen is never an ABE.
if Earlier_In_Extended_Unit (Root, Gen_Attrs.Body_Decl) then
-- ABE diagnostics are emitted only in the static model because there
-- is a well-defined order to visiting scenarios. Without this order
-- diagnostics appear jumbled and result in unwanted noise.
if Static_Elaboration_Checks then
Error_Msg_NE
("??cannot instantiate & before body seen", Inst, Gen_Id);
Error_Msg_N ("\Program_Error may be raised at run time", Inst);
Output_Active_Scenarios (Inst);
end if;
-- Install a conditional run-time ABE check to verify that the
-- generic body has been elaborated prior to the instantiation.
if Check_OK then
Install_ABE_Check
(N => Inst,
Ins_Nod => Exp_Inst,
Target_Id => Gen_Attrs.Spec_Id,
Target_Decl => Gen_Attrs.Spec_Decl,
Target_Body => Gen_Attrs.Body_Decl);
end if;
end if;
end Process_Instantiation_Conditional_ABE;
------------------------------------------
-- Process_Instantiation_Guaranteed_ABE --
------------------------------------------
procedure Process_Instantiation_Guaranteed_ABE (Exp_Inst : Node_Id) is
Gen_Attrs : Target_Attributes;
Gen_Id : Entity_Id;
Inst : Node_Id;
Inst_Attrs : Instantiation_Attributes;
Inst_Id : Entity_Id;
begin
Extract_Instantiation_Attributes
(Exp_Inst => Exp_Inst,
Inst => Inst,
Inst_Id => Inst_Id,
Gen_Id => Gen_Id,
Attrs => Inst_Attrs);
Extract_Target_Attributes (Gen_Id, Gen_Attrs);
-- Nothing to do when the root scenario appears at the declaration level
-- and the generic is in the same unit, but outside this context.
-- generic
-- procedure Gen is ...; -- generic declaration
-- procedure Proc is
-- function A ... is
-- begin
-- if Some_Condition then
-- declare
-- procedure I is new Gen; -- instantiation site
-- ...
-- ...
-- end A;
-- X : ... := A; -- root scenario
-- ...
-- procedure Gen is
-- ...
-- end Gen;
-- In the example above, the context of X is the declarative region of
-- Proc. The "elaboration" of X may eventually reach Gen which appears
-- outside of X's context. Gen is relevant only when Proc is invoked,
-- but this happens only by means of "normal" elaboration, therefore
-- Gen must not be considered if this is not the case.
-- Performance note: parent traversal
if Is_Up_Level_Target (Gen_Attrs.Spec_Decl) then
return;
-- Nothing to do when the instantiation is ABE-safe
-- generic
-- package Gen is
-- ...
-- end Gen;
-- package body Gen is
-- ...
-- end Gen;
-- with Gen;
-- procedure Main is
-- package Inst is new Gen (ABE); -- safe instantiation
-- ...
elsif Is_Safe_Instantiation (Inst, Gen_Attrs) then
return;
-- An instantiation leads to a guaranteed ABE when the instantiation and
-- the generic appear within the same context ignoring library levels,
-- and the body of the generic has not been seen yet or appears after
-- the instantiation.
-- procedure Guaranteed_ABE is
-- generic
-- procedure Gen;
-- package Nested is
-- procedure Inst is new Gen; -- guaranteed ABE
-- end Nested;
-- procedure Gen is
-- ...
-- end Gen;
-- ...
-- Performance note: parent traversal
elsif Is_Guaranteed_ABE
(N => Inst,
Target_Decl => Gen_Attrs.Spec_Decl,
Target_Body => Gen_Attrs.Body_Decl)
then
Error_Msg_NE
("??cannot instantiate & before body seen", Inst, Gen_Id);
Error_Msg_N ("\Program_Error will be raised at run time", Inst);
-- Mark the instantiation as a guarantee ABE. This automatically
-- suppresses the instantiation of the generic body.
Set_Is_Known_Guaranteed_ABE (Inst);
-- Install a run-time ABE failure because the instantiation will
-- always result in an ABE. The failure is installed when both the
-- instance and the generic have enabled elaboration checks, and both
-- are not ignored Ghost constructs.
if Inst_Attrs.Elab_Checks_OK
and then Gen_Attrs.Elab_Checks_OK
and then not Inst_Attrs.Ghost_Mode_Ignore
and then not Gen_Attrs.Ghost_Mode_Ignore
then
Install_ABE_Failure
(N => Inst,
Ins_Nod => Exp_Inst);
end if;
end if;
end Process_Instantiation_Guaranteed_ABE;
---------------------------------
-- Process_Instantiation_SPARK --
---------------------------------
procedure Process_Instantiation_SPARK
(Exp_Inst : Node_Id;
Inst : Node_Id;
Inst_Attrs : Instantiation_Attributes;
Gen_Id : Entity_Id;
Gen_Attrs : Target_Attributes)
is
Req_Nam : Name_Id;
begin
-- A source instantiation imposes an Elaborate[_All] requirement on the
-- context of the main unit. Determine whether the context has a pragma
-- strong enough to meet the requirement. The check is orthogonal to the
-- ABE ramifications of the instantiation.
if Nkind (Inst) = N_Package_Instantiation then
Req_Nam := Name_Elaborate;
else
Req_Nam := Name_Elaborate_All;
end if;
Meet_Elaboration_Requirement
(N => Inst,
Target_Id => Gen_Id,
Req_Nam => Req_Nam);
-- Nothing to do when the instantiation is ABE-safe
-- generic
-- package Gen is
-- ...
-- end Gen;
-- package body Gen is
-- ...
-- end Gen;
-- with Gen;
-- procedure Main is
-- package Inst is new Gen (ABE); -- safe instantiation
-- ...
if Is_Safe_Instantiation (Inst, Gen_Attrs) then
return;
-- The instantiation and the generic body are both in the main unit
elsif Present (Gen_Attrs.Body_Decl)
and then In_Extended_Main_Code_Unit (Gen_Attrs.Body_Decl)
then
Process_Instantiation_Conditional_ABE
(Exp_Inst => Exp_Inst,
Inst => Inst,
Inst_Attrs => Inst_Attrs,
Gen_Id => Gen_Id,
Gen_Attrs => Gen_Attrs);
-- Otherwise the generic body is not available in this compilation or
-- it resides in an external unit. There is no need to guarantee the
-- prior elaboration of the unit with the generic body because either
-- the main unit meets the Elaborate[_All] requirement imposed by the
-- instantiation, or the program is illegal.
else
null;
end if;
end Process_Instantiation_SPARK;
---------------------------------
-- Process_Variable_Assignment --
---------------------------------
procedure Process_Variable_Assignment (Asmt : Node_Id) is
Var_Id : constant Entity_Id := Entity (Extract_Assignment_Name (Asmt));
Spec_Id : Entity_Id;
begin
-- Output relevant information when switch -gnatel (info messages on
-- implicit Elaborate[_All] pragmas) is in effect.
if Elab_Info_Messages then
Error_Msg_NE
("info: assignment to & during elaboration", Asmt, Var_Id);
end if;
Spec_Id := Find_Top_Unit (Var_Id);
-- Generate an implicit Elaborate_Body in the spec
Set_Elaborate_Body_Desirable (Spec_Id);
-- No warning is emitted for internal uses. This behaviour parallels
-- that of the old ABE mechanism.
if GNAT_Mode then
null;
else
Error_Msg_NE
("??variable & can be accessed by clients before this "
& "initialization", Asmt, Var_Id);
Error_Msg_NE
("\add pragma ""Elaborate_Body"" to spec & to ensure proper "
& "initialization", Asmt, Spec_Id);
Output_Active_Scenarios (Asmt);
end if;
end Process_Variable_Assignment;
--------------------------------
-- Process_Variable_Reference --
--------------------------------
procedure Process_Variable_Reference (Ref : Node_Id) is
Var_Attrs : Variable_Attributes;
Var_Id : Entity_Id;
begin
Extract_Variable_Reference_Attributes
(Ref => Ref,
Var_Id => Var_Id,
Attrs => Var_Attrs);
-- Output relevant information when switch -gnatel (info messages on
-- implicit Elaborate[_All] pragmas) is in effect.
if Elab_Info_Messages then
Elab_Msg_NE
(Msg => "reference to variable & during elaboration",
N => Ref,
Id => Var_Id,
Info_Msg => True,
In_SPARK => True);
end if;
-- A source variable reference imposes an Elaborate_All requirement on
-- the context of the main unit. Determine whethe the context has a
-- pragma strong enough to meet the requirement.
Meet_Elaboration_Requirement
(N => Ref,
Target_Id => Var_Id,
Req_Nam => Name_Elaborate_All);
end Process_Variable_Reference;
--------------------------
-- Push_Active_Scenario --
--------------------------
procedure Push_Active_Scenario (N : Node_Id) is
begin
Scenario_Stack.Append (N);
end Push_Active_Scenario;
----------------------
-- Process_Scenario --
----------------------
procedure Process_Scenario (N : Node_Id; In_Task_Body : Boolean := False) is
Call_Attrs : Call_Attributes;
Target_Id : Entity_Id;
begin
-- Add the current scenario to the stack of active scenarios
Push_Active_Scenario (N);
-- 'Access
if Is_Suitable_Access (N) then
Process_Access (N, In_Task_Body);
-- Calls
elsif Is_Suitable_Call (N) then
-- In general, only calls found within the main unit are processed
-- because the ALI information supplied to binde is for the main
-- unit only. However, to preserve the consistency of the tree and
-- ensure proper serialization of internal names, external calls
-- also receive corresponding call markers (see Build_Call_Marker).
-- Regardless of the reason, external calls must not be processed.
if In_Main_Context (N) then
Extract_Call_Attributes
(Call => N,
Target_Id => Target_Id,
Attrs => Call_Attrs);
if Is_Activation_Proc (Target_Id) then
Process_Activation_Conditional_ABE
(Call => N,
Call_Attrs => Call_Attrs,
In_Task_Body => In_Task_Body);
else
Process_Call
(Call => N,
Call_Attrs => Call_Attrs,
Target_Id => Target_Id,
In_Task_Body => In_Task_Body);
end if;
end if;
-- Instantiations
elsif Is_Suitable_Instantiation (N) then
Process_Instantiation (N, In_Task_Body);
-- Variable assignments
elsif Is_Suitable_Variable_Assignment (N) then
Process_Variable_Assignment (N);
-- Variable references
elsif Is_Suitable_Variable_Reference (N) then
Process_Variable_Reference (N);
end if;
-- Remove the current scenario from the stack of active scenarios once
-- all ABE diagnostics and checks have been performed.
Pop_Active_Scenario (N);
end Process_Scenario;
---------------------------------
-- Record_Elaboration_Scenario --
---------------------------------
procedure Record_Elaboration_Scenario (N : Node_Id) is
Level : Enclosing_Level_Kind;
Declaration_Level_OK : Boolean;
-- This flag is set when a particular scenario is allowed to appear at
-- the declaration level.
begin
-- Assume that the scenario must not appear at the declaration level
Declaration_Level_OK := False;
-- Nothing to do for ASIS. As a result, no ABE checks and diagnostics
-- are performed in this mode.
if ASIS_Mode then
return;
-- Nothing to do when the scenario is being preanalyzed
elsif Preanalysis_Active then
return;
end if;
-- Ensure that a library level call does not appear in a preelaborated
-- unit. The check must come before ignoring scenarios within external
-- units or inside generics because calls in those context must also be
-- verified.
if Is_Suitable_Call (N) then
Check_Preelaborated_Call (N);
end if;
-- Nothing to do when the scenario does not appear within the main unit
if not In_Main_Context (N) then
return;
-- Scenarios within a generic unit are never considered because generics
-- cannot be elaborated.
elsif Inside_A_Generic then
return;
-- Scenarios which do not fall in one of the elaboration categories
-- listed below are not considered. The categories are:
-- 'Access for entries, operators, and subprograms
-- Calls (includes task activation)
-- Instantiations
-- Variable assignments
-- Variable references
elsif Is_Suitable_Access (N)
or else Is_Suitable_Variable_Assignment (N)
or else Is_Suitable_Variable_Reference (N)
then
null;
elsif Is_Suitable_Call (N) or else Is_Suitable_Instantiation (N) then
Declaration_Level_OK := True;
-- Otherwise the input does not denote a suitable scenario
else
return;
end if;
-- The static model imposes additional restrictions on the placement of
-- scenarios. In contrast, the dynamic model assumes that every scenario
-- will be elaborated or invoked at some point.
if Static_Elaboration_Checks then
-- Performance note: parent traversal
Level := Find_Enclosing_Level (N);
-- Declaration level scenario
if Declaration_Level_OK and then Level = Declaration_Level then
null;
-- Library level scenario
elsif Level in Library_Level then
null;
-- Instantiation library level scenario
elsif Level = Instantiation then
null;
-- Otherwise the scenario does not appear at the proper level and
-- cannot possibly act as a top level scenario.
else
return;
end if;
end if;
-- Perform early detection of guaranteed ABEs in order to suppress the
-- instantiation of generic bodies as gigi cannot handle certain types
-- of premature instantiations.
Process_Guaranteed_ABE (N);
-- At this point all checks have been performed. Record the scenario for
-- later processing by the ABE phase.
Top_Level_Scenarios.Append (N);
-- Mark a scenario which may produce run-time conditional ABE checks or
-- guaranteed ABE failures as recorded. The flag ensures that scenario
-- rewritting performed by Atree.Rewrite will be properly reflected in
-- all relevant internal data structures.
if Is_Check_Emitting_Scenario (N) then
Set_Is_Recorded_Scenario (N);
end if;
end Record_Elaboration_Scenario;
-------------------
-- Root_Scenario --
-------------------
function Root_Scenario return Node_Id is
package Stack renames Scenario_Stack;
begin
-- Ensure that the scenario stack has at least one active scenario in
-- it. The one at the bottom (index First) is the root scenario.
pragma Assert (Stack.Last >= Stack.First);
return Stack.Table (Stack.First);
end Root_Scenario;
-------------------------------
-- Static_Elaboration_Checks --
-------------------------------
function Static_Elaboration_Checks return Boolean is
begin
return not Dynamic_Elaboration_Checks;
end Static_Elaboration_Checks;
-------------------
-- Traverse_Body --
-------------------
procedure Traverse_Body (N : Node_Id; In_Task_Body : Boolean) is
function Is_Potential_Scenario (Nod : Node_Id) return Traverse_Result;
-- Determine whether arbitrary node Nod denotes a suitable scenario and
-- if so, process it.
procedure Traverse_Potential_Scenarios is
new Traverse_Proc (Is_Potential_Scenario);
procedure Traverse_List (List : List_Id);
-- Inspect list List for suitable elaboration scenarios and process them
---------------------------
-- Is_Potential_Scenario --
---------------------------
function Is_Potential_Scenario (Nod : Node_Id) return Traverse_Result is
begin
-- Special cases
-- Skip constructs which do not have elaboration of their own and
-- need to be elaborated by other means such as invocation, task
-- activation, etc.
if Is_Non_Library_Level_Encapsulator (Nod) then
return Skip;
-- Terminate the traversal of a task body with an accept statement
-- when no entry calls in elaboration are allowed because the task
-- will block at run-time and none of the remaining statements will
-- be executed.
elsif Nkind_In (Original_Node (Nod), N_Accept_Statement,
N_Selective_Accept)
and then Restriction_Active (No_Entry_Calls_In_Elaboration_Code)
then
return Abandon;
-- Certain nodes carry semantic lists which act as repositories until
-- expansion transforms the node and relocates the contents. Examine
-- these lists in case expansion is disabled.
elsif Nkind_In (Nod, N_And_Then, N_Or_Else) then
Traverse_List (Actions (Nod));
elsif Nkind_In (Nod, N_Elsif_Part, N_Iteration_Scheme) then
Traverse_List (Condition_Actions (Nod));
elsif Nkind (Nod) = N_If_Expression then
Traverse_List (Then_Actions (Nod));
Traverse_List (Else_Actions (Nod));
elsif Nkind_In (Nod, N_Component_Association,
N_Iterated_Component_Association)
then
Traverse_List (Loop_Actions (Nod));
-- General case
elsif Is_Suitable_Scenario (Nod) then
Process_Scenario (Nod, In_Task_Body);
end if;
return OK;
end Is_Potential_Scenario;
-------------------
-- Traverse_List --
-------------------
procedure Traverse_List (List : List_Id) is
Item : Node_Id;
begin
Item := First (List);
while Present (Item) loop
Traverse_Potential_Scenarios (Item);
Next (Item);
end loop;
end Traverse_List;
-- Start of processing for Traverse_Body
begin
-- Nothing to do when there is no body
if No (N) then
return;
elsif Nkind (N) /= N_Subprogram_Body then
return;
end if;
-- Nothing to do if the body was already traversed during the processing
-- of the same top level scenario.
if Visited_Bodies.Get (N) then
return;
-- Otherwise mark the body as traversed
else
Visited_Bodies.Set (N, True);
end if;
-- Examine the declarations for suitable scenarios
Traverse_List (Declarations (N));
-- Examine the handled sequence of statements. This also includes any
-- exceptions handlers.
Traverse_Potential_Scenarios (Handled_Statement_Sequence (N));
end Traverse_Body;
---------------------------------
-- Update_Elaboration_Scenario --
---------------------------------
procedure Update_Elaboration_Scenario (New_N : Node_Id; Old_N : Node_Id) is
package Scenarios renames Top_Level_Scenarios;
begin
-- A scenario is being transformed by Atree.Rewrite. Update all relevant
-- internal data structures to reflect this change. This ensures that a
-- potential run-time conditional ABE check or a guaranteed ABE failure
-- is inserted at the proper place in the tree.
if Is_Check_Emitting_Scenario (Old_N)
and then Is_Recorded_Scenario (Old_N)
and then Old_N /= New_N
then
-- Performance note: list traversal
for Index in Scenarios.First .. Scenarios.Last loop
if Scenarios.Table (Index) = Old_N then
Scenarios.Table (Index) := New_N;
Set_Is_Recorded_Scenario (Old_N, False);
Set_Is_Recorded_Scenario (New_N);
return;
end if;
end loop;
-- A recorded scenario must be in the table of recorded scenarios
pragma Assert (False);
end if;
end Update_Elaboration_Scenario;
-------------------------
-- Visited_Bodies_Hash --
-------------------------
function Visited_Bodies_Hash (Key : Node_Id) return Visited_Bodies_Index is
begin
return Visited_Bodies_Index (Key mod Visited_Bodies_Max);
end Visited_Bodies_Hash;
end Sem_Elab;
|