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
|
/* Rewrite a program in Normal form into SSA.
Copyright (C) 2001, 2002, 2003, 2004 Free Software Foundation, Inc.
Contributed by Diego Novillo <dnovillo@redhat.com>
This file is part of GCC.
GCC is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.
GCC is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with GCC; see the file COPYING. If not, write to
the Free Software Foundation, 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA. */
#include "config.h"
#include "system.h"
#include "coretypes.h"
#include "tm.h"
#include "tree.h"
#include "flags.h"
#include "rtl.h"
#include "tm_p.h"
#include "langhooks.h"
#include "hard-reg-set.h"
#include "basic-block.h"
#include "output.h"
#include "errors.h"
#include "expr.h"
#include "function.h"
#include "diagnostic.h"
#include "bitmap.h"
#include "tree-flow.h"
#include "tree-gimple.h"
#include "tree-inline.h"
#include "varray.h"
#include "timevar.h"
#include "tree-alias-common.h"
#include "hashtab.h"
#include "tree-dump.h"
#include "tree-pass.h"
#include "cfgloop.h"
#include "domwalk.h"
#include "ggc.h"
/* This file builds the SSA form for a function as described in:
R. Cytron, J. Ferrante, B. Rosen, M. Wegman, and K. Zadeck. Efficiently
Computing Static Single Assignment Form and the Control Dependence
Graph. ACM Transactions on Programming Languages and Systems,
13(4):451-490, October 1991. */
/* Structure to map a variable VAR to the set of blocks that contain
definitions for VAR. */
struct def_blocks_d
{
/* The variable. */
tree var;
/* Blocks that contain definitions of VAR. Bit I will be set if the
Ith block contains a definition of VAR. */
bitmap def_blocks;
/* Blocks that contain a phi node for VAR. */
bitmap phi_blocks;
/* Blocks where VAR is live-on-entry. Similar semantics as
DEF_BLOCKS. */
bitmap livein_blocks;
};
/* Each entry in DEF_BLOCKS contains an element of type STRUCT
DEF_BLOCKS_D, mapping a variable VAR to a bitmap describing all the
basic blocks where VAR is defined (assigned a new value). It also
contains a bitmap of all the blocks where VAR is live-on-entry
(i.e., there is a use of VAR in block B without a preceding
definition in B). The live-on-entry information is used when
computing PHI pruning heuristics. */
static htab_t def_blocks;
/* Global data to attach to the main dominator walk structure. */
struct mark_def_sites_global_data
{
/* This sbitmap contains the variables which are set before they
are used in a basic block. We keep it as a global variable
solely to avoid the overhead of allocating and deallocating
the bitmap. */
sbitmap kills;
/* Bitmap of names to rename. */
sbitmap names_to_rename;
};
struct rewrite_block_data
{
varray_type block_defs;
};
/* Information stored for ssa names. */
struct ssa_name_info
{
/* This field indicates whether or not the variable may need PHI nodes.
See the enum's definition for more detailed information about the
states. */
ENUM_BITFIELD (need_phi_state) need_phi_state : 2;
/* The actual definition of the ssa name. */
tree current_def;
};
/* Local functions. */
static void rewrite_finalize_block (struct dom_walk_data *, basic_block);
static void rewrite_initialize_block_local_data (struct dom_walk_data *,
basic_block, bool);
static void rewrite_initialize_block (struct dom_walk_data *, basic_block);
static void rewrite_add_phi_arguments (struct dom_walk_data *, basic_block);
static void mark_def_sites (struct dom_walk_data *walk_data,
basic_block bb, block_stmt_iterator);
static void mark_def_sites_initialize_block (struct dom_walk_data *walk_data,
basic_block bb);
static void set_def_block (tree, basic_block, bool, bool);
static void set_livein_block (tree, basic_block);
static bool prepare_use_operand_for_rename (use_operand_p, size_t *uid_p);
static bool prepare_def_operand_for_rename (tree def, size_t *uid_p);
static void insert_phi_nodes (bitmap *, bitmap);
static void rewrite_stmt (struct dom_walk_data *, basic_block,
block_stmt_iterator);
static inline void rewrite_operand (use_operand_p);
static void insert_phi_nodes_for (tree, bitmap *, varray_type *);
static tree get_reaching_def (tree);
static hashval_t def_blocks_hash (const void *);
static int def_blocks_eq (const void *, const void *);
static void def_blocks_free (void *);
static int debug_def_blocks_r (void **, void *);
static inline struct def_blocks_d *get_def_blocks_for (tree);
static inline struct def_blocks_d *find_def_blocks_for (tree);
static void htab_statistics (FILE *, htab_t);
/* Get the information associated with NAME. */
static inline struct ssa_name_info *
get_ssa_name_ann (tree name)
{
if (!SSA_NAME_AUX (name))
SSA_NAME_AUX (name) = xcalloc (1, sizeof (struct ssa_name_info));
return SSA_NAME_AUX (name);
}
/* Gets phi_state field for VAR. */
static inline enum need_phi_state
get_phi_state (tree var)
{
if (TREE_CODE (var) == SSA_NAME)
return get_ssa_name_ann (var)->need_phi_state;
else
return var_ann (var)->need_phi_state;
}
/* Sets phi_state field for VAR to STATE. */
static inline void
set_phi_state (tree var, enum need_phi_state state)
{
if (TREE_CODE (var) == SSA_NAME)
get_ssa_name_ann (var)->need_phi_state = state;
else
var_ann (var)->need_phi_state = state;
}
/* Return the current definition for VAR. */
static inline tree
get_current_def (tree var)
{
if (TREE_CODE (var) == SSA_NAME)
return get_ssa_name_ann (var)->current_def;
else
return var_ann (var)->current_def;
}
/* Sets current definition of VAR to DEF. */
static inline void
set_current_def (tree var, tree def)
{
if (TREE_CODE (var) == SSA_NAME)
get_ssa_name_ann (var)->current_def = def;
else
var_ann (var)->current_def = def;
}
/* Compute global livein information given the set of blockx where
an object is locally live at the start of the block (LIVEIN)
and the set of blocks where the object is defined (DEF_BLOCKS).
Note: This routine augments the existing local livein information
to include global livein (i.e., it modifies the underlying bitmap
for LIVEIN). */
void
compute_global_livein (bitmap livein, bitmap def_blocks)
{
basic_block bb, *worklist, *tos;
int i;
tos = worklist
= (basic_block *) xmalloc (sizeof (basic_block) * (n_basic_blocks + 1));
EXECUTE_IF_SET_IN_BITMAP (livein, 0, i,
{
*tos++ = BASIC_BLOCK (i);
});
/* Iterate until the worklist is empty. */
while (tos != worklist)
{
edge e;
/* Pull a block off the worklist. */
bb = *--tos;
/* For each predecessor block. */
for (e = bb->pred; e; e = e->pred_next)
{
basic_block pred = e->src;
int pred_index = pred->index;
/* None of this is necessary for the entry block. */
if (pred != ENTRY_BLOCK_PTR
&& ! bitmap_bit_p (livein, pred_index)
&& ! bitmap_bit_p (def_blocks, pred_index))
{
*tos++ = pred;
bitmap_set_bit (livein, pred_index);
}
}
}
free (worklist);
}
/* Block initialization routine for mark_def_sites. Clear the
KILLS bitmap at the start of each block. */
static void
mark_def_sites_initialize_block (struct dom_walk_data *walk_data,
basic_block bb ATTRIBUTE_UNUSED)
{
struct mark_def_sites_global_data *gd = walk_data->global_data;
sbitmap kills = gd->kills;
sbitmap_zero (kills);
}
/* Block initialization routine for mark_def_sites. Clear the
KILLS bitmap at the start of each block. */
static void
ssa_mark_def_sites_initialize_block (struct dom_walk_data *walk_data,
basic_block bb)
{
struct mark_def_sites_global_data *gd = walk_data->global_data;
sbitmap kills = gd->kills;
tree phi, def;
unsigned def_uid;
sbitmap_zero (kills);
for (phi = phi_nodes (bb); phi; phi = TREE_CHAIN (phi))
{
def = PHI_RESULT (phi);
def_uid = SSA_NAME_VERSION (def);
if (!TEST_BIT (gd->names_to_rename, def_uid))
continue;
set_def_block (def, bb, true, true);
SET_BIT (kills, def_uid);
}
}
/* Marks ssa names used as arguments of phis at the end of BB. */
static void
ssa_mark_phi_uses (struct dom_walk_data *walk_data, basic_block bb)
{
struct mark_def_sites_global_data *gd = walk_data->global_data;
sbitmap kills = gd->kills;
edge e;
tree phi, use;
unsigned uid;
for (e = bb->succ; e; e = e->succ_next)
{
if (e->dest == EXIT_BLOCK_PTR)
continue;
for (phi = phi_nodes (e->dest); phi; phi = TREE_CHAIN (phi))
{
use = PHI_ARG_DEF_FROM_EDGE (phi, e);
if (TREE_CODE (use) != SSA_NAME)
continue;
uid = SSA_NAME_VERSION (use);
if (TEST_BIT (gd->names_to_rename, uid)
&& !TEST_BIT (kills, uid))
set_livein_block (use, bb);
}
}
}
/* Call back for walk_dominator_tree used to collect definition sites
for every variable in the function. For every statement S in block
BB:
1- Variables defined by S in DEF_OPS(S) are marked in the bitmap
WALK_DATA->GLOBAL_DATA->KILLS.
2- If S uses a variable VAR and there is no preceding kill of VAR,
then it is marked in marked in the LIVEIN_BLOCKS bitmap
associated with VAR.
This information is used to determine which variables are live
across block boundaries to reduce the number of PHI nodes
we create. */
static void
mark_def_sites (struct dom_walk_data *walk_data,
basic_block bb,
block_stmt_iterator bsi)
{
struct mark_def_sites_global_data *gd = walk_data->global_data;
sbitmap kills = gd->kills;
v_may_def_optype v_may_defs;
v_must_def_optype v_must_defs;
vuse_optype vuses;
def_optype defs;
use_optype uses;
size_t i, uid;
tree stmt;
stmt_ann_t ann;
/* Mark all the blocks that have definitions for each variable in the
VARS_TO_RENAME bitmap. */
stmt = bsi_stmt (bsi);
get_stmt_operands (stmt);
ann = stmt_ann (stmt);
/* If a variable is used before being set, then the variable is live
across a block boundary, so mark it live-on-entry to BB. */
uses = USE_OPS (ann);
for (i = 0; i < NUM_USES (uses); i++)
{
use_operand_p use_p = USE_OP_PTR (uses, i);
if (prepare_use_operand_for_rename (use_p, &uid)
&& !TEST_BIT (kills, uid))
set_livein_block (USE_FROM_PTR (use_p), bb);
}
/* Similarly for virtual uses. */
vuses = VUSE_OPS (ann);
for (i = 0; i < NUM_VUSES (vuses); i++)
{
use_operand_p use_p = VUSE_OP_PTR (vuses, i);
if (prepare_use_operand_for_rename (use_p, &uid)
&& !TEST_BIT (kills, uid))
set_livein_block (USE_FROM_PTR (use_p), bb);
}
/* Note that virtual definitions are irrelevant for computing KILLS
because a V_MAY_DEF does not constitute a killing definition of the
variable. However, the operand of a virtual definitions is a use
of the variable, so it may cause the variable to be considered
live-on-entry. */
v_may_defs = V_MAY_DEF_OPS (ann);
for (i = 0; i < NUM_V_MAY_DEFS (v_may_defs); i++)
{
use_operand_p use_p = V_MAY_DEF_OP_PTR (v_may_defs, i);
if (prepare_use_operand_for_rename (use_p, &uid))
{
/* If we do not already have an SSA_NAME for our destination,
then set the destination to the source. */
if (TREE_CODE (V_MAY_DEF_RESULT (v_may_defs, i)) != SSA_NAME)
SET_V_MAY_DEF_RESULT (v_may_defs, i, USE_FROM_PTR (use_p));
set_livein_block (USE_FROM_PTR (use_p), bb);
set_def_block (V_MAY_DEF_RESULT (v_may_defs, i), bb, false, false);
}
}
/* Now process the virtual must-defs made by this statement. */
v_must_defs = V_MUST_DEF_OPS (ann);
for (i = 0; i < NUM_V_MUST_DEFS (v_must_defs); i++)
{
tree def = V_MUST_DEF_OP (v_must_defs, i);
if (prepare_def_operand_for_rename (def, &uid))
{
set_def_block (def, bb, false, false);
SET_BIT (kills, uid);
}
}
/* Now process the definition made by this statement. Mark the
variables in KILLS. */
defs = DEF_OPS (ann);
for (i = 0; i < NUM_DEFS (defs); i++)
{
tree def = DEF_OP (defs, i);
if (prepare_def_operand_for_rename (def, &uid))
{
set_def_block (def, bb, false, false);
SET_BIT (kills, uid);
}
}
}
/* Ditto, but works over ssa names. */
static void
ssa_mark_def_sites (struct dom_walk_data *walk_data,
basic_block bb,
block_stmt_iterator bsi)
{
struct mark_def_sites_global_data *gd = walk_data->global_data;
sbitmap kills = gd->kills;
v_may_def_optype v_may_defs;
v_must_def_optype v_must_defs;
vuse_optype vuses;
def_optype defs;
use_optype uses;
size_t i, uid, def_uid;
tree stmt, use, def;
stmt_ann_t ann;
/* Mark all the blocks that have definitions for each variable in the
names_to_rename bitmap. */
stmt = bsi_stmt (bsi);
get_stmt_operands (stmt);
ann = stmt_ann (stmt);
/* If a variable is used before being set, then the variable is live
across a block boundary, so mark it live-on-entry to BB. */
uses = USE_OPS (ann);
for (i = 0; i < NUM_USES (uses); i++)
{
use = USE_OP (uses, i);
uid = SSA_NAME_VERSION (use);
if (TEST_BIT (gd->names_to_rename, uid)
&& !TEST_BIT (kills, uid))
set_livein_block (use, bb);
}
/* Similarly for virtual uses. */
vuses = VUSE_OPS (ann);
for (i = 0; i < NUM_VUSES (vuses); i++)
{
use = VUSE_OP (vuses, i);
uid = SSA_NAME_VERSION (use);
if (TEST_BIT (gd->names_to_rename, uid)
&& !TEST_BIT (kills, uid))
set_livein_block (use, bb);
}
v_may_defs = V_MAY_DEF_OPS (ann);
for (i = 0; i < NUM_V_MAY_DEFS (v_may_defs); i++)
{
use = V_MAY_DEF_OP (v_may_defs, i);
uid = SSA_NAME_VERSION (use);
if (TEST_BIT (gd->names_to_rename, uid)
&& !TEST_BIT (kills, uid))
set_livein_block (use, bb);
}
/* Now process the definition made by this statement. Mark the
variables in KILLS. */
defs = DEF_OPS (ann);
for (i = 0; i < NUM_DEFS (defs); i++)
{
def = DEF_OP (defs, i);
def_uid = SSA_NAME_VERSION (def);
if (TEST_BIT (gd->names_to_rename, def_uid))
{
set_def_block (def, bb, false, true);
SET_BIT (kills, def_uid);
}
}
v_may_defs = V_MAY_DEF_OPS (ann);
for (i = 0; i < NUM_V_MAY_DEFS (v_may_defs); i++)
{
def = V_MAY_DEF_RESULT (v_may_defs, i);
def_uid = SSA_NAME_VERSION (def);
if (TEST_BIT (gd->names_to_rename, def_uid))
{
set_def_block (def, bb, false, true);
SET_BIT (kills, def_uid);
}
}
v_must_defs = V_MUST_DEF_OPS (ann);
for (i = 0; i < NUM_V_MUST_DEFS (v_must_defs); i++)
{
def = V_MUST_DEF_OP (v_must_defs, i);
def_uid = SSA_NAME_VERSION (def);
if (TEST_BIT (gd->names_to_rename, def_uid))
{
set_def_block (def, bb, false, true);
SET_BIT (kills, def_uid);
}
}
}
/* Mark block BB as the definition site for variable VAR. PHI_P is true if
VAR is defined by a phi node. SSA_P is true if we are called from
rewrite_ssa_into_ssa. */
static void
set_def_block (tree var, basic_block bb, bool phi_p, bool ssa_p)
{
struct def_blocks_d *db_p;
enum need_phi_state state;
if (!ssa_p
&& TREE_CODE (var) == SSA_NAME)
var = SSA_NAME_VAR (var);
state = get_phi_state (var);
db_p = get_def_blocks_for (var);
/* Set the bit corresponding to the block where VAR is defined. */
bitmap_set_bit (db_p->def_blocks, bb->index);
if (phi_p)
bitmap_set_bit (db_p->phi_blocks, bb->index);
/* Keep track of whether or not we may need to insert phi nodes.
If we are in the UNKNOWN state, then this is the first definition
of VAR. Additionally, we have not seen any uses of VAR yet, so
we do not need a phi node for this variable at this time (i.e.,
transition to NEED_PHI_STATE_NO).
If we are in any other state, then we either have multiple definitions
of this variable occurring in different blocks or we saw a use of the
variable which was not dominated by the block containing the
definition(s). In this case we may need a PHI node, so enter
state NEED_PHI_STATE_MAYBE. */
if (state == NEED_PHI_STATE_UNKNOWN)
set_phi_state (var, NEED_PHI_STATE_NO);
else
set_phi_state (var, NEED_PHI_STATE_MAYBE);
}
/* Mark block BB as having VAR live at the entry to BB. */
static void
set_livein_block (tree var, basic_block bb)
{
struct def_blocks_d *db_p;
enum need_phi_state state = get_phi_state (var);
db_p = get_def_blocks_for (var);
/* Set the bit corresponding to the block where VAR is live in. */
bitmap_set_bit (db_p->livein_blocks, bb->index);
/* Keep track of whether or not we may need to insert phi nodes.
If we reach here in NEED_PHI_STATE_NO, see if this use is dominated
by the single block containing the definition(s) of this variable. If
it is, then we remain in NEED_PHI_STATE_NO, otherwise we transition to
NEED_PHI_STATE_MAYBE. */
if (state == NEED_PHI_STATE_NO)
{
int def_block_index = bitmap_first_set_bit (db_p->def_blocks);
if (def_block_index == -1
|| ! dominated_by_p (CDI_DOMINATORS, bb,
BASIC_BLOCK (def_block_index)))
set_phi_state (var, NEED_PHI_STATE_MAYBE);
}
else
set_phi_state (var, NEED_PHI_STATE_MAYBE);
}
/* If the use operand pointed to by OP_P needs to be renamed, then strip away
any SSA_NAME wrapping the operand, set *UID_P to the underlying variable's
uid, and return true. Otherwise return false. If the operand was an
SSA_NAME, change it to the stripped name. */
static bool
prepare_use_operand_for_rename (use_operand_p op_p, size_t *uid_p)
{
tree use = USE_FROM_PTR (op_p);
tree var = (TREE_CODE (use) != SSA_NAME) ? use : SSA_NAME_VAR (use);
*uid_p = var_ann (var)->uid;
/* Ignore variables that don't need to be renamed. */
if (vars_to_rename && !bitmap_bit_p (vars_to_rename, *uid_p))
return false;
/* The variable needs to be renamed. If this is a use which already
has an SSA_NAME, then strip it off.
By not throwing away SSA_NAMEs on assignments, we avoid a lot of
useless churn of SSA_NAMEs without having to overly complicate the
renamer. */
if (TREE_CODE (use) == SSA_NAME)
SET_USE (op_p, var);
return true;
}
/* If the def variable DEF needs to be renamed, then strip away any SSA_NAME
wrapping the operand, set *UID_P to the underlying variable's uid and return
true. Otherwise return false. */
static bool
prepare_def_operand_for_rename (tree def, size_t *uid_p)
{
tree var = (TREE_CODE (def) != SSA_NAME) ? def : SSA_NAME_VAR (def);
*uid_p = var_ann (var)->uid;
/* Ignore variables that don't need to be renamed. */
if (vars_to_rename && !bitmap_bit_p (vars_to_rename, *uid_p))
return false;
return true;
}
/* Helper for insert_phi_nodes. If VAR needs PHI nodes, insert them
at the dominance frontier (DFS) of blocks defining VAR.
WORK_STACK is the varray used to implement the worklist of basic
blocks. */
static inline
void insert_phi_nodes_1 (tree var, bitmap *dfs, varray_type *work_stack)
{
if (get_phi_state (var) != NEED_PHI_STATE_NO)
insert_phi_nodes_for (var, dfs, work_stack);
}
/* Insert PHI nodes at the dominance frontier of blocks with variable
definitions. DFS contains the dominance frontier information for
the flowgraph. PHI nodes will only be inserted at the dominance
frontier of definition blocks for variables whose NEED_PHI_STATE
annotation is marked as ``maybe'' or ``unknown'' (computed by
mark_def_sites). If NAMES_TO_RENAME is not NULL, do the same but
for ssa name rewriting. */
static void
insert_phi_nodes (bitmap *dfs, bitmap names_to_rename)
{
size_t i;
varray_type work_stack;
timevar_push (TV_TREE_INSERT_PHI_NODES);
/* Array WORK_STACK is a stack of CFG blocks. Each block that contains
an assignment or PHI node will be pushed to this stack. */
VARRAY_GENERIC_PTR_NOGC_INIT (work_stack, last_basic_block, "work_stack");
/* Iterate over all variables in VARS_TO_RENAME. For each variable, add
to the work list all the blocks that have a definition for the
variable. PHI nodes will be added to the dominance frontier blocks of
each definition block. */
if (names_to_rename)
{
EXECUTE_IF_SET_IN_BITMAP (names_to_rename, 0, i,
{
if (ssa_name (i))
insert_phi_nodes_1 (ssa_name (i), dfs, &work_stack);
});
}
else if (vars_to_rename)
EXECUTE_IF_SET_IN_BITMAP (vars_to_rename, 0, i,
insert_phi_nodes_1 (referenced_var (i), dfs, &work_stack));
else
for (i = 0; i < num_referenced_vars; i++)
insert_phi_nodes_1 (referenced_var (i), dfs, &work_stack);
VARRAY_FREE (work_stack);
timevar_pop (TV_TREE_INSERT_PHI_NODES);
}
/* Perform a depth-first traversal of the dominator tree looking for
variables to rename. BB is the block where to start searching.
Renaming is a five step process:
1- Every definition made by PHI nodes at the start of the blocks is
registered as the current definition for the corresponding variable.
2- Every statement in BB is rewritten. USE and VUSE operands are
rewritten with their corresponding reaching definition. DEF and
VDEF targets are registered as new definitions.
3- All the PHI nodes in successor blocks of BB are visited. The
argument corresponding to BB is replaced with its current reaching
definition.
4- Recursively rewrite every dominator child block of BB.
5- Restore (in reverse order) the current reaching definition for every
new definition introduced in this block. This is done so that when
we return from the recursive call, all the current reaching
definitions are restored to the names that were valid in the
dominator parent of BB. */
/* Initialize the local stacks.
BLOCK_DEFS is used to save all the existing reaching definitions for
the new SSA names introduced in this block. Before registering a
new definition for a variable, the existing reaching definition is
pushed into this stack so that we can restore it in Step 5. */
static void
rewrite_initialize_block_local_data (struct dom_walk_data *walk_data ATTRIBUTE_UNUSED,
basic_block bb ATTRIBUTE_UNUSED,
bool recycled ATTRIBUTE_UNUSED)
{
#ifdef ENABLE_CHECKING
struct rewrite_block_data *bd
= (struct rewrite_block_data *)VARRAY_TOP_GENERIC_PTR (walk_data->block_data_stack);
/* We get cleared memory from the allocator, so if the memory is
not cleared, then we are re-using a previously allocated entry. In
that case, we can also re-use the underlying virtual arrays. Just
make sure we clear them before using them! */
if (recycled && bd->block_defs && VARRAY_ACTIVE_SIZE (bd->block_defs) > 0)
abort ();
#endif
}
/* SSA Rewriting Step 1. Initialization, create a block local stack
of reaching definitions for new SSA names produced in this block
(BLOCK_DEFS). Register new definitions for every PHI node in the
block. */
static void
rewrite_initialize_block (struct dom_walk_data *walk_data, basic_block bb)
{
tree phi;
struct rewrite_block_data *bd
= (struct rewrite_block_data *)VARRAY_TOP_GENERIC_PTR (walk_data->block_data_stack);
if (dump_file && (dump_flags & TDF_DETAILS))
fprintf (dump_file, "\n\nRenaming block #%d\n\n", bb->index);
/* Step 1. Register new definitions for every PHI node in the block.
Conceptually, all the PHI nodes are executed in parallel and each PHI
node introduces a new version for the associated variable. */
for (phi = phi_nodes (bb); phi; phi = PHI_CHAIN (phi))
{
tree result = PHI_RESULT (phi);
register_new_def (result, &bd->block_defs);
}
}
/* Register DEF (an SSA_NAME) to be a new definition for the original
ssa name VAR and push VAR's current reaching definition
into the stack pointed by BLOCK_DEFS_P. */
static void
ssa_register_new_def (tree var, tree def, varray_type *block_defs_p)
{
tree currdef;
/* If this variable is set in a single basic block and all uses are
dominated by the set(s) in that single basic block, then there is
nothing to do. TODO we should not be called at all, and just
keep the original name. */
if (get_phi_state (var) == NEED_PHI_STATE_NO)
{
set_current_def (var, def);
return;
}
currdef = get_current_def (var);
if (! *block_defs_p)
VARRAY_TREE_INIT (*block_defs_p, 20, "block_defs");
/* Push the current reaching definition into *BLOCK_DEFS_P. This stack is
later used by the dominator tree callbacks to restore the reaching
definitions for all the variables defined in the block after a recursive
visit to all its immediately dominated blocks. */
VARRAY_PUSH_TREE (*block_defs_p, var);
VARRAY_PUSH_TREE (*block_defs_p, currdef);
/* Set the current reaching definition for VAR to be DEF. */
set_current_def (var, def);
}
/* Ditto, for rewriting ssa names. */
static void
ssa_rewrite_initialize_block (struct dom_walk_data *walk_data, basic_block bb)
{
tree phi, new_name;
struct rewrite_block_data *bd
= (struct rewrite_block_data *)VARRAY_TOP_GENERIC_PTR (walk_data->block_data_stack);
sbitmap names_to_rename = walk_data->global_data;
edge e;
bool abnormal_phi;
if (dump_file && (dump_flags & TDF_DETAILS))
fprintf (dump_file, "\n\nRenaming block #%d\n\n", bb->index);
for (e = bb->pred; e; e = e->pred_next)
if (e->flags & EDGE_ABNORMAL)
break;
abnormal_phi = (e != NULL);
/* Step 1. Register new definitions for every PHI node in the block.
Conceptually, all the PHI nodes are executed in parallel and each PHI
node introduces a new version for the associated variable. */
for (phi = phi_nodes (bb); phi; phi = TREE_CHAIN (phi))
{
tree result = PHI_RESULT (phi);
if (TEST_BIT (names_to_rename, SSA_NAME_VERSION (result)))
{
new_name = duplicate_ssa_name (result, phi);
SET_PHI_RESULT (phi, new_name);
if (abnormal_phi)
SSA_NAME_OCCURS_IN_ABNORMAL_PHI (new_name) = 1;
}
else
new_name = result;
ssa_register_new_def (result, new_name, &bd->block_defs);
}
}
/* SSA Rewriting Step 3. Visit all the successor blocks of BB looking for
PHI nodes. For every PHI node found, add a new argument containing the
current reaching definition for the variable and the edge through which
that definition is reaching the PHI node. */
static void
rewrite_add_phi_arguments (struct dom_walk_data *walk_data ATTRIBUTE_UNUSED,
basic_block bb)
{
edge e;
for (e = bb->succ; e; e = e->succ_next)
{
tree phi;
for (phi = phi_nodes (e->dest); phi; phi = TREE_CHAIN (phi))
{
tree currdef;
/* If this PHI node has already been rewritten, then there is
nothing to do for this PHI or any following PHIs since we
always add new PHI nodes at the start of the PHI chain. */
if (PHI_REWRITTEN (phi))
break;
currdef = get_reaching_def (SSA_NAME_VAR (PHI_RESULT (phi)));
add_phi_arg (&phi, currdef, e);
}
}
}
/* Ditto, for ssa name rewriting. */
static void
ssa_rewrite_phi_arguments (struct dom_walk_data *walk_data, basic_block bb)
{
edge e;
sbitmap names_to_rename = walk_data->global_data;
use_operand_p op;
for (e = bb->succ; e; e = e->succ_next)
{
tree phi;
if (e->dest == EXIT_BLOCK_PTR)
continue;
for (phi = phi_nodes (e->dest); phi; phi = TREE_CHAIN (phi))
{
op = PHI_ARG_DEF_PTR_FROM_EDGE (phi, e);
if (TREE_CODE (USE_FROM_PTR (op)) != SSA_NAME)
continue;
if (!TEST_BIT (names_to_rename, SSA_NAME_VERSION (USE_FROM_PTR (op))))
continue;
SET_USE (op, get_reaching_def (USE_FROM_PTR (op)));
if (e->flags & EDGE_ABNORMAL)
SSA_NAME_OCCURS_IN_ABNORMAL_PHI (USE_FROM_PTR (op)) = 1;
}
}
}
/* SSA Rewriting Step 5. Restore the current reaching definition for each
variable referenced in the block (in reverse order). */
static void
rewrite_finalize_block (struct dom_walk_data *walk_data,
basic_block bb ATTRIBUTE_UNUSED)
{
struct rewrite_block_data *bd
= (struct rewrite_block_data *)VARRAY_TOP_GENERIC_PTR (walk_data->block_data_stack);
/* Step 5. Restore the current reaching definition for each variable
referenced in the block (in reverse order). */
while (bd->block_defs && VARRAY_ACTIVE_SIZE (bd->block_defs) > 0)
{
tree tmp = VARRAY_TOP_TREE (bd->block_defs);
tree saved_def, var;
VARRAY_POP (bd->block_defs);
if (TREE_CODE (tmp) == SSA_NAME)
{
saved_def = tmp;
var = SSA_NAME_VAR (saved_def);
}
else
{
saved_def = NULL;
var = tmp;
}
set_current_def (var, saved_def);
}
}
/* Ditto, for rewriting ssa names. */
static void
ssa_rewrite_finalize_block (struct dom_walk_data *walk_data,
basic_block bb ATTRIBUTE_UNUSED)
{
struct rewrite_block_data *bd
= (struct rewrite_block_data *)VARRAY_TOP_GENERIC_PTR (walk_data->block_data_stack);
/* Step 5. Restore the current reaching definition for each variable
referenced in the block (in reverse order). */
while (bd->block_defs && VARRAY_ACTIVE_SIZE (bd->block_defs) > 0)
{
tree var;
tree saved_def = VARRAY_TOP_TREE (bd->block_defs);
VARRAY_POP (bd->block_defs);
var = VARRAY_TOP_TREE (bd->block_defs);
VARRAY_POP (bd->block_defs);
set_current_def (var, saved_def);
}
}
/* Dump SSA information to FILE. */
void
dump_tree_ssa (FILE *file)
{
basic_block bb;
const char *funcname
= lang_hooks.decl_printable_name (current_function_decl, 2);
fprintf (file, "SSA information for %s\n\n", funcname);
FOR_EACH_BB (bb)
{
dump_bb (bb, file, 0);
fputs (" ", file);
print_generic_stmt (file, phi_nodes (bb), dump_flags);
fputs ("\n\n", file);
}
}
/* Dump SSA information to stderr. */
void
debug_tree_ssa (void)
{
dump_tree_ssa (stderr);
}
/* Dump SSA statistics on FILE. */
void
dump_tree_ssa_stats (FILE *file)
{
fprintf (file, "\nHash table statistics:\n");
fprintf (file, " def_blocks: ");
htab_statistics (file, def_blocks);
fprintf (file, "\n");
}
/* Dump SSA statistics on stderr. */
void
debug_tree_ssa_stats (void)
{
dump_tree_ssa_stats (stderr);
}
/* Dump statistics for the hash table HTAB. */
static void
htab_statistics (FILE *file, htab_t htab)
{
fprintf (file, "size %ld, %ld elements, %f collision/search ratio\n",
(long) htab_size (htab),
(long) htab_elements (htab),
htab_collisions (htab));
}
/* Insert PHI nodes for variable VAR using the dominance frontier
information given in DFS. WORK_STACK is the varray used to
implement the worklist of basic blocks. */
static void
insert_phi_nodes_for (tree var, bitmap *dfs, varray_type *work_stack)
{
struct def_blocks_d *def_map;
bitmap phi_insertion_points;
int bb_index;
edge e;
tree phi;
basic_block bb;
def_map = find_def_blocks_for (var);
if (def_map == NULL)
return;
phi_insertion_points = BITMAP_XMALLOC ();
EXECUTE_IF_SET_IN_BITMAP (def_map->def_blocks, 0, bb_index,
{
VARRAY_PUSH_GENERIC_PTR_NOGC (*work_stack, BASIC_BLOCK (bb_index));
});
/* Pop a block off the worklist, add every block that appears in
the original block's dfs that we have not already processed to
the worklist. Iterate until the worklist is empty. Blocks
which are added to the worklist are potential sites for
PHI nodes.
The iteration step could be done during PHI insertion just as
easily. We do it here for historical reasons -- we used to have
a heuristic which used the potential PHI insertion points to
determine if fully pruned or semi pruned SSA form was appropriate.
We now always use fully pruned SSA form. */
while (VARRAY_ACTIVE_SIZE (*work_stack) > 0)
{
int dfs_index;
bb = VARRAY_TOP_GENERIC_PTR_NOGC (*work_stack);
bb_index = bb->index;
VARRAY_POP (*work_stack);
EXECUTE_IF_AND_COMPL_IN_BITMAP (dfs[bb_index],
phi_insertion_points,
0, dfs_index,
{
basic_block bb = BASIC_BLOCK (dfs_index);
VARRAY_PUSH_GENERIC_PTR_NOGC (*work_stack, bb);
bitmap_set_bit (phi_insertion_points, dfs_index);
});
}
/* Remove the blocks where we already have the phis. */
bitmap_operation (phi_insertion_points, phi_insertion_points,
def_map->phi_blocks, BITMAP_AND_COMPL);
/* Now compute global livein for this variable. Note this modifies
def_map->livein_blocks. */
compute_global_livein (def_map->livein_blocks, def_map->def_blocks);
/* And insert the PHI nodes. */
EXECUTE_IF_AND_IN_BITMAP (phi_insertion_points, def_map->livein_blocks,
0, bb_index,
do
{
bb = BASIC_BLOCK (bb_index);
phi = create_phi_node (var, bb);
/* If we are rewriting ssa names, add also the phi arguments. */
if (TREE_CODE (var) == SSA_NAME)
{
for (e = bb->pred; e; e = e->pred_next)
add_phi_arg (&phi, var, e);
}
}
while (0));
BITMAP_XFREE (phi_insertion_points);
}
/* SSA Rewriting Step 2. Rewrite every variable used in each statement in
the block with its immediate reaching definitions. Update the current
definition of a variable when a new real or virtual definition is found. */
static void
rewrite_stmt (struct dom_walk_data *walk_data,
basic_block bb ATTRIBUTE_UNUSED,
block_stmt_iterator si)
{
size_t i;
stmt_ann_t ann;
tree stmt;
vuse_optype vuses;
v_may_def_optype v_may_defs;
v_must_def_optype v_must_defs;
def_optype defs;
use_optype uses;
struct rewrite_block_data *bd;
bd = VARRAY_TOP_GENERIC_PTR (walk_data->block_data_stack);
stmt = bsi_stmt (si);
ann = stmt_ann (stmt);
if (dump_file && (dump_flags & TDF_DETAILS))
{
fprintf (dump_file, "Renaming statement ");
print_generic_stmt (dump_file, stmt, TDF_SLIM);
fprintf (dump_file, "\n");
}
#if defined ENABLE_CHECKING
/* We have just scanned the code for operands. No statement should
be modified. */
if (ann->modified)
abort ();
#endif
defs = DEF_OPS (ann);
uses = USE_OPS (ann);
vuses = VUSE_OPS (ann);
v_may_defs = V_MAY_DEF_OPS (ann);
v_must_defs = V_MUST_DEF_OPS (ann);
/* Step 1. Rewrite USES and VUSES in the statement. */
for (i = 0; i < NUM_USES (uses); i++)
rewrite_operand (USE_OP_PTR (uses, i));
/* Rewrite virtual uses in the statement. */
for (i = 0; i < NUM_VUSES (vuses); i++)
rewrite_operand (VUSE_OP_PTR (vuses, i));
/* Step 2. Register the statement's DEF and VDEF operands. */
for (i = 0; i < NUM_DEFS (defs); i++)
{
def_operand_p def_p = DEF_OP_PTR (defs, i);
if (TREE_CODE (DEF_FROM_PTR (def_p)) != SSA_NAME)
SET_DEF (def_p, make_ssa_name (DEF_FROM_PTR (def_p), stmt));
/* FIXME: We shouldn't be registering new defs if the variable
doesn't need to be renamed. */
register_new_def (DEF_FROM_PTR (def_p), &bd->block_defs);
}
/* Register new virtual definitions made by the statement. */
for (i = 0; i < NUM_V_MAY_DEFS (v_may_defs); i++)
{
rewrite_operand (V_MAY_DEF_OP_PTR (v_may_defs, i));
if (TREE_CODE (V_MAY_DEF_RESULT (v_may_defs, i)) != SSA_NAME)
SET_V_MAY_DEF_RESULT (v_may_defs, i,
make_ssa_name (V_MAY_DEF_RESULT (v_may_defs, i),
stmt));
/* FIXME: We shouldn't be registering new defs if the variable
doesn't need to be renamed. */
register_new_def (V_MAY_DEF_RESULT (v_may_defs, i), &bd->block_defs);
}
/* Register new virtual mustdefs made by the statement. */
for (i = 0; i < NUM_V_MUST_DEFS (v_must_defs); i++)
{
def_operand_p v_must_def_p = V_MUST_DEF_OP_PTR (v_must_defs, i);
if (TREE_CODE (DEF_FROM_PTR (v_must_def_p)) != SSA_NAME)
SET_DEF (v_must_def_p,
make_ssa_name (DEF_FROM_PTR (v_must_def_p), stmt));
/* FIXME: We shouldn't be registering new mustdefs if the variable
doesn't need to be renamed. */
register_new_def (DEF_FROM_PTR (v_must_def_p), &bd->block_defs);
}
}
/* Ditto, for rewriting ssa names. */
static void
ssa_rewrite_stmt (struct dom_walk_data *walk_data,
basic_block bb ATTRIBUTE_UNUSED,
block_stmt_iterator si)
{
size_t i;
stmt_ann_t ann;
tree stmt, var;
use_operand_p use_p;
def_operand_p def_p;
vuse_optype vuses;
v_may_def_optype v_may_defs;
v_must_def_optype v_must_defs;
def_optype defs;
use_optype uses;
struct rewrite_block_data *bd;
sbitmap names_to_rename = walk_data->global_data;
bd = VARRAY_TOP_GENERIC_PTR (walk_data->block_data_stack);
stmt = bsi_stmt (si);
ann = stmt_ann (stmt);
if (dump_file && (dump_flags & TDF_DETAILS))
{
fprintf (dump_file, "Renaming statement ");
print_generic_stmt (dump_file, stmt, TDF_SLIM);
fprintf (dump_file, "\n");
}
#if defined ENABLE_CHECKING
/* We have just scanned the code for operands. No statement should
be modified. */
if (ann->modified)
abort ();
#endif
defs = DEF_OPS (ann);
uses = USE_OPS (ann);
vuses = VUSE_OPS (ann);
v_may_defs = V_MAY_DEF_OPS (ann);
v_must_defs = V_MUST_DEF_OPS (ann);
/* Step 1. Rewrite USES and VUSES in the statement. */
for (i = 0; i < NUM_USES (uses); i++)
{
use_p = USE_OP_PTR (uses, i);
if (TEST_BIT (names_to_rename, SSA_NAME_VERSION (USE_FROM_PTR (use_p))))
SET_USE (use_p, get_reaching_def (USE_FROM_PTR (use_p)));
}
/* Rewrite virtual uses in the statement. */
for (i = 0; i < NUM_VUSES (vuses); i++)
{
use_p = VUSE_OP_PTR (vuses, i);
if (TEST_BIT (names_to_rename, SSA_NAME_VERSION (USE_FROM_PTR (use_p))))
SET_USE (use_p, get_reaching_def (USE_FROM_PTR (use_p)));
}
for (i = 0; i < NUM_V_MAY_DEFS (v_may_defs); i++)
{
use_p = V_MAY_DEF_OP_PTR (v_may_defs, i);
if (TEST_BIT (names_to_rename, SSA_NAME_VERSION (USE_FROM_PTR (use_p))))
SET_USE (use_p, get_reaching_def (USE_FROM_PTR (use_p)));
}
/* Step 2. Register the statement's DEF and VDEF operands. */
for (i = 0; i < NUM_DEFS (defs); i++)
{
def_p = DEF_OP_PTR (defs, i);
var = DEF_FROM_PTR (def_p);
if (!TEST_BIT (names_to_rename, SSA_NAME_VERSION (var)))
continue;
SET_DEF (def_p, duplicate_ssa_name (var, stmt));
ssa_register_new_def (var, DEF_FROM_PTR (def_p), &bd->block_defs);
}
/* Register new virtual definitions made by the statement. */
for (i = 0; i < NUM_V_MAY_DEFS (v_may_defs); i++)
{
def_p = V_MAY_DEF_RESULT_PTR (v_may_defs, i);
var = DEF_FROM_PTR (def_p);
if (!TEST_BIT (names_to_rename, SSA_NAME_VERSION (var)))
continue;
SET_DEF (def_p, duplicate_ssa_name (var, stmt));
ssa_register_new_def (var, DEF_FROM_PTR (def_p), &bd->block_defs);
}
for (i = 0; i < NUM_V_MUST_DEFS (v_must_defs); i++)
{
def_p = V_MUST_DEF_OP_PTR (v_must_defs, i);
var = DEF_FROM_PTR (def_p);
if (!TEST_BIT (names_to_rename, SSA_NAME_VERSION (var)))
continue;
SET_DEF (def_p, duplicate_ssa_name (var, stmt));
ssa_register_new_def (var, DEF_FROM_PTR (def_p), &bd->block_defs);
}
}
/* Replace the operand pointed by OP_P with its immediate reaching
definition. */
static inline void
rewrite_operand (use_operand_p op_p)
{
if (TREE_CODE (USE_FROM_PTR (op_p)) != SSA_NAME)
SET_USE (op_p, get_reaching_def (USE_FROM_PTR (op_p)));
}
/* Register DEF (an SSA_NAME) to be a new definition for its underlying
variable (SSA_NAME_VAR (DEF)) and push VAR's current reaching definition
into the stack pointed by BLOCK_DEFS_P. */
void
register_new_def (tree def, varray_type *block_defs_p)
{
tree var = SSA_NAME_VAR (def);
tree currdef;
/* If this variable is set in a single basic block and all uses are
dominated by the set(s) in that single basic block, then there is
no reason to record anything for this variable in the block local
definition stacks. Doing so just wastes time and memory.
This is the same test to prune the set of variables which may
need PHI nodes. So we just use that information since it's already
computed and available for us to use. */
if (get_phi_state (var) == NEED_PHI_STATE_NO)
{
set_current_def (var, def);
return;
}
currdef = get_current_def (var);
if (! *block_defs_p)
VARRAY_TREE_INIT (*block_defs_p, 20, "block_defs");
/* Push the current reaching definition into *BLOCK_DEFS_P. This stack is
later used by the dominator tree callbacks to restore the reaching
definitions for all the variables defined in the block after a recursive
visit to all its immediately dominated blocks. If there is no current
reaching definition, then just record the underlying _DECL node. */
VARRAY_PUSH_TREE (*block_defs_p, currdef ? currdef : var);
/* Set the current reaching definition for VAR to be DEF. */
set_current_def (var, def);
}
/* Return the current definition for variable VAR. If none is found,
create a new SSA name to act as the zeroth definition for VAR. If VAR
is call clobbered and there exists a more recent definition of
GLOBAL_VAR, return the definition for GLOBAL_VAR. This means that VAR
has been clobbered by a function call since its last assignment. */
static tree
get_reaching_def (tree var)
{
tree default_d, currdef_var, avar;
/* Lookup the current reaching definition for VAR. */
default_d = NULL_TREE;
currdef_var = get_current_def (var);
/* If there is no reaching definition for VAR, create and register a
default definition for it (if needed). */
if (currdef_var == NULL_TREE)
{
if (TREE_CODE (var) == SSA_NAME)
avar = SSA_NAME_VAR (var);
else
avar = var;
default_d = default_def (avar);
if (default_d == NULL_TREE)
{
default_d = make_ssa_name (avar, build_empty_stmt ());
set_default_def (avar, default_d);
}
set_current_def (var, default_d);
}
/* Return the current reaching definition for VAR, or the default
definition, if we had to create one. */
return (currdef_var) ? currdef_var : default_d;
}
/* Hashing and equality functions for DEF_BLOCKS. */
static hashval_t
def_blocks_hash (const void *p)
{
return htab_hash_pointer
((const void *)((const struct def_blocks_d *)p)->var);
}
static int
def_blocks_eq (const void *p1, const void *p2)
{
return ((const struct def_blocks_d *)p1)->var
== ((const struct def_blocks_d *)p2)->var;
}
/* Free memory allocated by one entry in DEF_BLOCKS. */
static void
def_blocks_free (void *p)
{
struct def_blocks_d *entry = p;
BITMAP_XFREE (entry->def_blocks);
BITMAP_XFREE (entry->phi_blocks);
BITMAP_XFREE (entry->livein_blocks);
free (entry);
}
/* Dump the DEF_BLOCKS hash table on stderr. */
void
debug_def_blocks (void)
{
htab_traverse (def_blocks, debug_def_blocks_r, NULL);
}
/* Callback for htab_traverse to dump the DEF_BLOCKS hash table. */
static int
debug_def_blocks_r (void **slot, void *data ATTRIBUTE_UNUSED)
{
unsigned long i;
struct def_blocks_d *db_p = (struct def_blocks_d *) *slot;
fprintf (stderr, "VAR: ");
print_generic_expr (stderr, db_p->var, dump_flags);
fprintf (stderr, ", DEF_BLOCKS: { ");
EXECUTE_IF_SET_IN_BITMAP (db_p->def_blocks, 0, i,
fprintf (stderr, "%ld ", i));
fprintf (stderr, "}");
fprintf (stderr, ", LIVEIN_BLOCKS: { ");
EXECUTE_IF_SET_IN_BITMAP (db_p->livein_blocks, 0, i,
fprintf (stderr, "%ld ", i));
fprintf (stderr, "}\n");
return 1;
}
/* Return the set of blocks where variable VAR is defined and the blocks
where VAR is live on entry (livein). Return NULL, if no entry is
found in DEF_BLOCKS. */
static inline struct def_blocks_d *
find_def_blocks_for (tree var)
{
struct def_blocks_d dm;
dm.var = var;
return (struct def_blocks_d *) htab_find (def_blocks, &dm);
}
/* Return the set of blocks where variable VAR is defined and the blocks
where VAR is live on entry (livein). If no entry is found in
DEF_BLOCKS, a new one is created and returned. */
static inline struct def_blocks_d *
get_def_blocks_for (tree var)
{
struct def_blocks_d db, *db_p;
void **slot;
db.var = var;
slot = htab_find_slot (def_blocks, (void *) &db, INSERT);
if (*slot == NULL)
{
db_p = xmalloc (sizeof (*db_p));
db_p->var = var;
db_p->def_blocks = BITMAP_XMALLOC ();
db_p->phi_blocks = BITMAP_XMALLOC ();
db_p->livein_blocks = BITMAP_XMALLOC ();
*slot = (void *) db_p;
}
else
db_p = (struct def_blocks_d *) *slot;
return db_p;
}
/* If a variable V in VARS_TO_RENAME is a pointer, the renaming
process will cause us to lose the name memory tags that may have
been associated with the various SSA_NAMEs of V. This means that
the variables aliased to those name tags also need to be renamed
again.
FIXME 1- We should either have a better scheme for renaming
pointers that doesn't lose name tags or re-run alias
analysis to recover points-to information.
2- Currently we just invalidate *all* the name tags. This
should be more selective. */
static void
invalidate_name_tags (bitmap vars_to_rename)
{
size_t i;
bool rename_name_tags_p;
rename_name_tags_p = false;
EXECUTE_IF_SET_IN_BITMAP (vars_to_rename, 0, i,
if (POINTER_TYPE_P (TREE_TYPE (referenced_var (i))))
{
rename_name_tags_p = true;
break;
});
if (rename_name_tags_p)
for (i = 0; i < num_referenced_vars; i++)
{
var_ann_t ann = var_ann (referenced_var (i));
if (ann->mem_tag_kind == NAME_TAG)
{
size_t j;
varray_type may_aliases = ann->may_aliases;
bitmap_set_bit (vars_to_rename, ann->uid);
if (ann->may_aliases)
for (j = 0; j < VARRAY_ACTIVE_SIZE (may_aliases); j++)
{
tree var = VARRAY_TREE (may_aliases, j);
bitmap_set_bit (vars_to_rename, var_ann (var)->uid);
}
}
}
}
/* Main entry point into the SSA builder. The renaming process
proceeds in five main phases:
1- If VARS_TO_RENAME has any entries, any existing PHI nodes for
those variables are removed from the flow graph so that they can
be computed again.
2- Compute dominance frontier and immediate dominators, needed to
insert PHI nodes and rename the function in dominator tree
order.
3- Find and mark all the blocks that define variables
(mark_def_sites).
4- Insert PHI nodes at dominance frontiers (insert_phi_nodes).
5- Rename all the blocks (rewrite_initialize_block,
rewrite_add_phi_arguments) and statements in the program
(rewrite_stmt).
Steps 3 and 5 are done using the dominator tree walker
(walk_dominator_tree).
ALL is true if all variables should be renamed (otherwise just those
mentioned in vars_to_rename are taken into account). */
void
rewrite_into_ssa (bool all)
{
bitmap *dfs;
basic_block bb;
struct dom_walk_data walk_data;
struct mark_def_sites_global_data mark_def_sites_global_data;
bitmap old_vars_to_rename = vars_to_rename;
unsigned i;
timevar_push (TV_TREE_SSA_OTHER);
if (all)
vars_to_rename = NULL;
else
{
/* Initialize the array of variables to rename. */
if (vars_to_rename == NULL)
abort ();
if (bitmap_first_set_bit (vars_to_rename) < 0)
{
timevar_pop (TV_TREE_SSA_OTHER);
return;
}
invalidate_name_tags (vars_to_rename);
/* Now remove all the existing PHI nodes (if any) for the variables
that we are about to rename into SSA. */
remove_all_phi_nodes_for (vars_to_rename);
}
/* Allocate memory for the DEF_BLOCKS hash table. */
def_blocks = htab_create (VARRAY_ACTIVE_SIZE (referenced_vars),
def_blocks_hash, def_blocks_eq, def_blocks_free);
/* Initialize dominance frontier and immediate dominator bitmaps.
Also count the number of predecessors for each block. Doing so
can save significant time during PHI insertion for large graphs. */
dfs = (bitmap *) xmalloc (last_basic_block * sizeof (bitmap *));
FOR_EACH_BB (bb)
{
edge e;
int count = 0;
for (e = bb->pred; e; e = e->pred_next)
count++;
bb_ann (bb)->num_preds = count;
dfs[bb->index] = BITMAP_XMALLOC ();
}
for (i = 0; i < num_referenced_vars; i++)
set_current_def (referenced_var (i), NULL_TREE);
/* Ensure that the dominance information is OK. */
calculate_dominance_info (CDI_DOMINATORS);
/* Compute dominance frontiers. */
compute_dominance_frontiers (dfs);
/* Setup callbacks for the generic dominator tree walker to find and
mark definition sites. */
walk_data.walk_stmts_backward = false;
walk_data.dom_direction = CDI_DOMINATORS;
walk_data.initialize_block_local_data = NULL;
walk_data.before_dom_children_before_stmts = mark_def_sites_initialize_block;
walk_data.before_dom_children_walk_stmts = mark_def_sites;
walk_data.before_dom_children_after_stmts = NULL;
walk_data.after_dom_children_before_stmts = NULL;
walk_data.after_dom_children_walk_stmts = NULL;
walk_data.after_dom_children_after_stmts = NULL;
/* Notice that this bitmap is indexed using variable UIDs, so it must be
large enough to accommodate all the variables referenced in the
function, not just the ones we are renaming. */
mark_def_sites_global_data.kills = sbitmap_alloc (num_referenced_vars);
walk_data.global_data = &mark_def_sites_global_data;
/* We do not have any local data. */
walk_data.block_local_data_size = 0;
/* Initialize the dominator walker. */
init_walk_dominator_tree (&walk_data);
/* Recursively walk the dominator tree. */
walk_dominator_tree (&walk_data, ENTRY_BLOCK_PTR);
/* Finalize the dominator walker. */
fini_walk_dominator_tree (&walk_data);
/* We no longer need this bitmap, clear and free it. */
sbitmap_free (mark_def_sites_global_data.kills);
/* Insert PHI nodes at dominance frontiers of definition blocks. */
insert_phi_nodes (dfs, NULL);
/* Rewrite all the basic blocks in the program. */
timevar_push (TV_TREE_SSA_REWRITE_BLOCKS);
/* Setup callbacks for the generic dominator tree walker. */
walk_data.walk_stmts_backward = false;
walk_data.dom_direction = CDI_DOMINATORS;
walk_data.initialize_block_local_data = rewrite_initialize_block_local_data;
walk_data.before_dom_children_before_stmts = rewrite_initialize_block;
walk_data.before_dom_children_walk_stmts = rewrite_stmt;
walk_data.before_dom_children_after_stmts = rewrite_add_phi_arguments;
walk_data.after_dom_children_before_stmts = NULL;
walk_data.after_dom_children_walk_stmts = NULL;
walk_data.after_dom_children_after_stmts = rewrite_finalize_block;
walk_data.global_data = NULL;
walk_data.block_local_data_size = sizeof (struct rewrite_block_data);
/* Initialize the dominator walker. */
init_walk_dominator_tree (&walk_data);
/* Recursively walk the dominator tree rewriting each statement in
each basic block. */
walk_dominator_tree (&walk_data, ENTRY_BLOCK_PTR);
/* Finalize the dominator walker. */
fini_walk_dominator_tree (&walk_data);
timevar_pop (TV_TREE_SSA_REWRITE_BLOCKS);
/* Debugging dumps. */
if (dump_file && (dump_flags & TDF_STATS))
{
dump_dfa_stats (dump_file);
dump_tree_ssa_stats (dump_file);
}
/* Free allocated memory. */
FOR_EACH_BB (bb)
BITMAP_XFREE (dfs[bb->index]);
free (dfs);
htab_delete (def_blocks);
vars_to_rename = old_vars_to_rename;
timevar_pop (TV_TREE_SSA_OTHER);
}
/* The ssa names in NAMES_TO_RENAME may have more than one definition;
add phi nodes and rewrite them to fix this. */
void
rewrite_ssa_into_ssa (bitmap names_to_rename)
{
bitmap *dfs;
basic_block bb;
struct dom_walk_data walk_data;
struct mark_def_sites_global_data mark_def_sites_global_data;
unsigned i;
sbitmap snames_to_rename;
tree name;
if (bitmap_first_set_bit (names_to_rename) < 0)
return;
timevar_push (TV_TREE_SSA_OTHER);
/* Allocate memory for the DEF_BLOCKS hash table. */
def_blocks = htab_create (num_ssa_names,
def_blocks_hash, def_blocks_eq, def_blocks_free);
/* Initialize dominance frontier and immediate dominator bitmaps.
Also count the number of predecessors for each block. Doing so
can save significant time during PHI insertion for large graphs. */
dfs = (bitmap *) xmalloc (last_basic_block * sizeof (bitmap *));
FOR_EACH_BB (bb)
{
edge e;
int count = 0;
for (e = bb->pred; e; e = e->pred_next)
count++;
bb_ann (bb)->num_preds = count;
dfs[bb->index] = BITMAP_XMALLOC ();
}
/* Ensure that the dominance information is OK. */
calculate_dominance_info (CDI_DOMINATORS);
/* Compute dominance frontiers. */
compute_dominance_frontiers (dfs);
/* Setup callbacks for the generic dominator tree walker to find and
mark definition sites. */
walk_data.walk_stmts_backward = false;
walk_data.dom_direction = CDI_DOMINATORS;
walk_data.initialize_block_local_data = NULL;
walk_data.before_dom_children_before_stmts
= ssa_mark_def_sites_initialize_block;
walk_data.before_dom_children_walk_stmts = ssa_mark_def_sites;
walk_data.before_dom_children_after_stmts = ssa_mark_phi_uses;
walk_data.after_dom_children_before_stmts = NULL;
walk_data.after_dom_children_walk_stmts = NULL;
walk_data.after_dom_children_after_stmts = NULL;
snames_to_rename = sbitmap_alloc (num_ssa_names);
sbitmap_zero (snames_to_rename);
EXECUTE_IF_SET_IN_BITMAP (names_to_rename, 0, i,
SET_BIT (snames_to_rename, i));
mark_def_sites_global_data.kills = sbitmap_alloc (num_ssa_names);
mark_def_sites_global_data.names_to_rename = snames_to_rename;
walk_data.global_data = &mark_def_sites_global_data;
/* We do not have any local data. */
walk_data.block_local_data_size = 0;
/* Initialize the dominator walker. */
init_walk_dominator_tree (&walk_data);
/* Recursively walk the dominator tree. */
walk_dominator_tree (&walk_data, ENTRY_BLOCK_PTR);
/* Finalize the dominator walker. */
fini_walk_dominator_tree (&walk_data);
/* We no longer need this bitmap, clear and free it. */
sbitmap_free (mark_def_sites_global_data.kills);
for (i = 1; i < num_ssa_names; i++)
set_current_def (ssa_name (i), NULL_TREE);
/* Insert PHI nodes at dominance frontiers of definition blocks. */
insert_phi_nodes (dfs, names_to_rename);
/* Rewrite all the basic blocks in the program. */
timevar_push (TV_TREE_SSA_REWRITE_BLOCKS);
/* Setup callbacks for the generic dominator tree walker. */
walk_data.walk_stmts_backward = false;
walk_data.dom_direction = CDI_DOMINATORS;
walk_data.initialize_block_local_data
= rewrite_initialize_block_local_data;
walk_data.before_dom_children_before_stmts = ssa_rewrite_initialize_block;
walk_data.before_dom_children_walk_stmts = ssa_rewrite_stmt;
walk_data.before_dom_children_after_stmts = ssa_rewrite_phi_arguments;
walk_data.after_dom_children_before_stmts = NULL;
walk_data.after_dom_children_walk_stmts = NULL;
walk_data.after_dom_children_after_stmts = ssa_rewrite_finalize_block;
walk_data.global_data = snames_to_rename;
walk_data.block_local_data_size = sizeof (struct rewrite_block_data);
/* Initialize the dominator walker. */
init_walk_dominator_tree (&walk_data);
/* Recursively walk the dominator tree rewriting each statement in
each basic block. */
walk_dominator_tree (&walk_data, ENTRY_BLOCK_PTR);
/* Finalize the dominator walker. */
fini_walk_dominator_tree (&walk_data);
EXECUTE_IF_SET_IN_BITMAP (names_to_rename, 0, i,
release_ssa_name (ssa_name (i)));
sbitmap_free (snames_to_rename);
timevar_pop (TV_TREE_SSA_REWRITE_BLOCKS);
/* Debugging dumps. */
if (dump_file && (dump_flags & TDF_STATS))
{
dump_dfa_stats (dump_file);
dump_tree_ssa_stats (dump_file);
}
/* Free allocated memory. */
FOR_EACH_BB (bb)
BITMAP_XFREE (dfs[bb->index]);
free (dfs);
htab_delete (def_blocks);
for (i = 1; i < num_ssa_names; i++)
{
name = ssa_name (i);
if (!SSA_NAME_AUX (name))
continue;
free (SSA_NAME_AUX (name));
SSA_NAME_AUX (name) = NULL;
}
timevar_pop (TV_TREE_SSA_OTHER);
}
/* Rewrites all variables into ssa. */
static void
rewrite_all_into_ssa (void)
{
rewrite_into_ssa (true);
}
struct tree_opt_pass pass_build_ssa =
{
"ssa", /* name */
NULL, /* gate */
rewrite_all_into_ssa, /* execute */
NULL, /* sub */
NULL, /* next */
0, /* static_pass_number */
0, /* tv_id */
PROP_cfg | PROP_referenced_vars, /* properties_required */
PROP_ssa, /* properties_provided */
0, /* properties_destroyed */
0, /* todo_flags_start */
TODO_dump_func | TODO_verify_ssa /* todo_flags_finish */
};
|