split graph state into properties and constraints
[libfirm] / ir / be / beirgmod.c
1 /*
2  * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
3  *
4  * This file is part of libFirm.
5  *
6  * This file may be distributed and/or modified under the terms of the
7  * GNU General Public License version 2 as published by the Free Software
8  * Foundation and appearing in the file LICENSE.GPL included in the
9  * packaging of this file.
10  *
11  * Licensees holding valid libFirm Professional Edition licenses may use
12  * this file in accordance with the libFirm Commercial License.
13  * Agreement provided with the Software.
14  *
15  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE.
18  */
19
20 /**
21  * @file
22  * @brief       Backend IRG modification routines.
23  * @author      Sebastian Hack, Daniel Grund, Matthias Braun, Christian Wuerdig
24  * @date        04.05.2005
25  *
26  * This file contains the following IRG modifications for be routines:
27  * - insertion of Perm nodes
28  * - empty block elimination
29  * - a simple dead node elimination (set inputs of unreachable nodes to BAD)
30  */
31 #include "config.h"
32
33 #include <stdlib.h>
34
35 #include "hashptr.h"
36 #include "pdeq.h"
37 #include "pset.h"
38 #include "pmap.h"
39 #include "util.h"
40 #include "debug.h"
41 #include "error.h"
42 #include "xmalloc.h"
43
44 #include "irflag_t.h"
45 #include "ircons_t.h"
46 #include "irnode_t.h"
47 #include "ircons_t.h"
48 #include "irmode_t.h"
49 #include "irdom_t.h"
50 #include "iredges_t.h"
51 #include "irgraph_t.h"
52 #include "irgopt.h"
53 #include "irgmod.h"
54 #include "irprintf_t.h"
55 #include "irgwalk.h"
56
57 #include "be_t.h"
58 #include "bechordal_t.h"
59 #include "bearch.h"
60 #include "besched.h"
61 #include "belive_t.h"
62 #include "benode.h"
63 #include "beutil.h"
64 #include "beinsn_t.h"
65 #include "bessaconstr.h"
66 #include "beirg.h"
67 #include "beirgmod.h"
68 #include "bemodule.h"
69
70 DEBUG_ONLY(static firm_dbg_module_t *dbg = NULL;)
71
72 /*
73   ___                     _     ____
74  |_ _|_ __  ___  ___ _ __| |_  |  _ \ ___ _ __ _ __ ___
75   | || '_ \/ __|/ _ \ '__| __| | |_) / _ \ '__| '_ ` _ \
76   | || | | \__ \  __/ |  | |_  |  __/  __/ |  | | | | | |
77  |___|_| |_|___/\___|_|   \__| |_|   \___|_|  |_| |_| |_|
78
79 */
80
81 ir_node *insert_Perm_after(ir_graph *irg, const arch_register_class_t *cls,
82                                                    ir_node *pos)
83 {
84         be_lv_t *lv     = be_get_irg_liveness(irg);
85         ir_node *bl     = is_Block(pos) ? pos : get_nodes_block(pos);
86         ir_nodeset_t          live;
87         ir_nodeset_iterator_t iter;
88
89         ir_node *irn, *perm, **nodes;
90         size_t i, n;
91
92         DBG((dbg, LEVEL_1, "Insert Perm after: %+F\n", pos));
93
94         ir_nodeset_init(&live);
95         be_liveness_nodes_live_at(lv, cls, pos, &live);
96
97         n = ir_nodeset_size(&live);
98         if (n == 0) {
99                 ir_nodeset_destroy(&live);
100                 return NULL;
101         }
102
103         nodes = XMALLOCN(ir_node*, n);
104
105         DBG((dbg, LEVEL_1, "live:\n"));
106         i = 0;
107         foreach_ir_nodeset(&live, irn, iter) {
108                 DBG((dbg, LEVEL_1, "\t%+F\n", irn));
109                 nodes[i] = irn;
110                 i++;
111         }
112         ir_nodeset_destroy(&live);
113
114         perm = be_new_Perm(cls, bl, n, nodes);
115         sched_add_after(pos, perm);
116         free(nodes);
117
118         for (i = 0; i < n; ++i) {
119                 ir_node *perm_op = get_irn_n(perm, i);
120                 const arch_register_t *reg = arch_get_irn_register(perm_op);
121                 be_ssa_construction_env_t senv;
122
123                 ir_mode *mode = get_irn_mode(perm_op);
124                 ir_node *proj = new_r_Proj(perm, mode, i);
125                 arch_set_irn_register(proj, reg);
126
127                 be_ssa_construction_init(&senv, irg);
128                 be_ssa_construction_add_copy(&senv, perm_op);
129                 be_ssa_construction_add_copy(&senv, proj);
130                 be_ssa_construction_fix_users(&senv, perm_op);
131                 be_ssa_construction_update_liveness_phis(&senv, lv);
132                 be_liveness_update(lv, perm_op);
133                 be_liveness_update(lv, proj);
134                 be_ssa_construction_destroy(&senv);
135         }
136
137         return perm;
138 }
139
140 static int blocks_removed;
141
142 /**
143  * Post-block-walker: Find blocks containing only one jump and
144  * remove them.
145  */
146 static void remove_empty_block(ir_node *block)
147 {
148         const ir_edge_t *edge;
149         const ir_edge_t *next;
150         int              i;
151         int              arity;
152         ir_node         *node;
153         ir_node         *pred;
154         ir_node         *succ_block;
155         ir_node         *jump = NULL;
156         ir_graph        *irg = get_irn_irg(block);
157         ir_entity       *entity;
158
159         if (irn_visited_else_mark(block))
160                 return;
161
162         if (get_Block_n_cfgpreds(block) != 1)
163                 goto check_preds;
164
165         sched_foreach(block, node) {
166                 if (! is_Jmp(node)
167                                 && !(arch_get_irn_flags(node) & arch_irn_flags_simple_jump))
168                         goto check_preds;
169                 if (jump != NULL) {
170                         /* we should never have 2 jumps in a block */
171                         panic("found 2 jumps in a block");
172                 }
173                 jump = node;
174         }
175
176         if (jump == NULL)
177                 goto check_preds;
178
179         entity     = get_Block_entity(block);
180         pred       = get_Block_cfgpred(block, 0);
181         succ_block = NULL;
182         foreach_out_edge_safe(jump, edge, next) {
183                 int pos = get_edge_src_pos(edge);
184
185                 assert(succ_block == NULL);
186                 succ_block = get_edge_src_irn(edge);
187                 if (get_Block_entity(succ_block) != NULL && entity != NULL) {
188                         /*
189                          * Currently we can add only one label for a block.
190                          * Therefore we cannot combine them if  both block already have one.
191                          */
192                         goto check_preds;
193                 }
194
195                 set_irn_n(succ_block, pos, pred);
196         }
197
198         if (entity != NULL) {
199                 /* move the label to the successor block */
200                 set_Block_entity(succ_block, entity);
201         }
202
203         /* there can be some non-scheduled Pin nodes left in the block, move them
204          * to the succ block (Pin) or pred block (Sync) */
205         foreach_out_edge_safe(block, edge, next) {
206                 node = get_edge_src_irn(edge);
207
208                 if (node == jump)
209                         continue;
210                 /* we simply kill Pins, because there are some strange interactions
211                  * between jump threading, which produce PhiMs with Pins, we simply
212                  * kill the pins here, everything is scheduled anyway */
213                 if (is_Pin(node)) {
214                         exchange(node, get_Pin_op(node));
215                         continue;
216                 }
217                 if (is_Sync(node)) {
218                         set_nodes_block(node, get_nodes_block(pred));
219                         continue;
220                 }
221                 if (is_End(node)) { /* End-keep, reroute it to the successor */
222                         int pos = get_edge_src_pos(edge);
223                         set_irn_n(node, pos, succ_block);
224                         continue;
225                 }
226                 panic("Unexpected node %+F in block %+F with empty schedule", node, block);
227         }
228
229         set_Block_cfgpred(block, 0, new_r_Bad(irg, mode_X));
230         kill_node(jump);
231         blocks_removed = 1;
232
233         /* check predecessor */
234         remove_empty_block(get_nodes_block(pred));
235         return;
236
237 check_preds:
238         arity = get_Block_n_cfgpreds(block);
239         for (i = 0; i < arity; ++i) {
240                 ir_node *pred = get_Block_cfgpred_block(block, i);
241                 remove_empty_block(pred);
242         }
243 }
244
245 /* removes basic blocks that just contain a jump instruction */
246 int be_remove_empty_blocks(ir_graph *irg)
247 {
248         ir_node *end;
249         int      i, arity;
250
251         blocks_removed = 0;
252
253         ir_reserve_resources(irg, IR_RESOURCE_IRN_VISITED);
254         inc_irg_visited(irg);
255         remove_empty_block(get_irg_end_block(irg));
256         end   = get_irg_end(irg);
257         arity = get_irn_arity(end);
258         for (i = 0; i < arity; ++i) {
259                 ir_node *pred = get_irn_n(end, i);
260                 if (!is_Block(pred))
261                         continue;
262                 remove_empty_block(pred);
263         }
264         ir_free_resources(irg, IR_RESOURCE_IRN_VISITED);
265
266         if (blocks_removed) {
267                 /* invalidate analysis info */
268                 clear_irg_properties(irg, IR_GRAPH_PROPERTY_CONSISTENT_DOMINANCE);
269         }
270         return blocks_removed;
271 }
272
273 //---------------------------------------------------------------------------
274
275 typedef struct remove_dead_nodes_env_t_ {
276         bitset_t *reachable;
277         ir_graph *irg;
278         be_lv_t  *lv;
279 } remove_dead_nodes_env_t;
280
281 /**
282  * Post-walker: remember all visited nodes in a bitset.
283  */
284 static void mark_dead_nodes_walker(ir_node *node, void *data)
285 {
286         remove_dead_nodes_env_t *env = (remove_dead_nodes_env_t*) data;
287         bitset_set(env->reachable, get_irn_idx(node));
288 }
289
290 /**
291  * Post-block-walker:
292  * Walk through the schedule of every block and remove all dead nodes from it.
293  */
294 static void remove_dead_nodes_walker(ir_node *block, void *data)
295 {
296         remove_dead_nodes_env_t *env = (remove_dead_nodes_env_t*) data;
297         ir_node                 *node, *next;
298
299         for (node = sched_first(block); ! sched_is_end(node); node = next) {
300                 /* get next node now, as after calling sched_remove it will be invalid */
301                 next = sched_next(node);
302
303                 if (bitset_is_set(env->reachable, get_irn_idx(node)))
304                         continue;
305
306                 if (env->lv != NULL)
307                         be_liveness_remove(env->lv, node);
308                 sched_remove(node);
309
310                 /* kill projs */
311                 if (get_irn_mode(node) == mode_T) {
312                         const ir_edge_t *edge;
313                         const ir_edge_t *next_edge;
314                         foreach_out_edge_safe(node, edge, next_edge) {
315                                 ir_node *proj = get_edge_src_irn(edge);
316                                 if (!is_Proj(proj))
317                                         continue;
318                                 if (env->lv != NULL)
319                                         be_liveness_remove(env->lv, proj);
320                                 kill_node(proj);
321                         }
322                 }
323                 kill_node(node);
324         }
325 }
326
327 void be_remove_dead_nodes_from_schedule(ir_graph *irg)
328 {
329         remove_dead_nodes_env_t env;
330         env.reachable = bitset_alloca(get_irg_last_idx(irg));
331         env.lv        = be_get_irg_liveness(irg);
332         env.irg       = irg;
333
334         // mark all reachable nodes
335         irg_walk_graph(irg, mark_dead_nodes_walker, NULL, &env);
336
337         // walk schedule and remove non-marked nodes
338         irg_block_walk_graph(irg, remove_dead_nodes_walker, NULL, &env);
339 }
340
341 BE_REGISTER_MODULE_CONSTRUCTOR(be_init_irgmod)
342 void be_init_irgmod(void)
343 {
344         FIRM_DBG_REGISTER(dbg, "firm.be.irgmod");
345 }