emit arm symconsts as .LC%u instead of .L%u to avoid clashed with block numbers
[libfirm] / ir / be / betranshlp.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       be transform helper extracted from the ia32 backend.
23  * @author      Matthias Braun, Michael Beck
24  * @date        14.06.2007
25  * @version     $Id$
26  */
27 #include "config.h"
28
29 #include "pdeq.h"
30 #include "irop_t.h"
31 #include "iropt_t.h"
32 #include "irnode_t.h"
33 #include "irgraph_t.h"
34 #include "ircons_t.h"
35 #include "irhooks.h"
36 #include "iredges.h"
37 #include "irouts.h"
38 #include "trouts.h"
39 #include "cgana.h"
40 #include "debug.h"
41
42 #include "beirg.h"
43 #include "betranshlp.h"
44 #include "belive.h"
45 #include "benode.h"
46
47 typedef struct be_transform_env_t {
48         ir_graph *irg;         /**< The irg, the node should be created in */
49         waitq    *worklist;    /**< worklist of nodes that still need to be
50                                     transformed */
51         ir_node  *old_anchor;  /**< the old anchor node in the old irg */
52 } be_transform_env_t;
53
54
55 static be_transform_env_t env;
56
57 void be_set_transformed_node(ir_node *old_node, ir_node *new_node)
58 {
59         set_irn_link(old_node, new_node);
60         mark_irn_visited(old_node);
61 }
62
63 int be_is_transformed(const ir_node *node)
64 {
65         return irn_visited(node);
66 }
67
68 static inline ir_node *be_get_transformed_node(ir_node *old_node)
69 {
70         if (irn_visited(old_node)) {
71                 ir_node *new_node = get_irn_link(old_node);
72                 assert(new_node != NULL);
73                 return new_node;
74         }
75         return NULL;
76 }
77
78 void be_duplicate_deps(ir_node *old_node, ir_node *new_node)
79 {
80         int i;
81         int deps = get_irn_deps(old_node);
82
83         for (i = 0; i < deps; ++i) {
84                 ir_node *dep     = get_irn_dep(old_node, i);
85                 ir_node *new_dep = be_transform_node(dep);
86
87                 add_irn_dep(new_node, new_dep);
88         }
89 }
90
91 void be_dep_on_frame(ir_node* node)
92 {
93         ir_graph *const irg = current_ir_graph;
94
95         if (get_irg_start_block(irg) == get_nodes_block(node))
96                 add_irn_dep(node, get_irg_frame(irg));
97 }
98
99 void be_set_transform_function(ir_op *op, be_transform_func func)
100 {
101         /* shouldn't be assigned twice (except for exchanging the default
102          * be_duplicate_node entries) */
103         assert(op->ops.generic == NULL
104                         || op->ops.generic == (op_func) be_duplicate_node);
105         op->ops.generic = (op_func) func;
106 }
107
108 void be_start_transform_setup(void)
109 {
110         clear_irp_opcodes_generic_func();
111
112         be_set_transform_function(op_Bad,         be_duplicate_node);
113         be_set_transform_function(op_be_Barrier,  be_duplicate_node);
114         be_set_transform_function(op_be_Copy,     be_duplicate_node);
115         be_set_transform_function(op_be_CopyKeep, be_duplicate_node);
116         be_set_transform_function(op_be_IncSP,    be_duplicate_node);
117         be_set_transform_function(op_be_Keep,     be_duplicate_node);
118         be_set_transform_function(op_be_Return,   be_duplicate_node);
119         be_set_transform_function(op_be_Start,    be_duplicate_node);
120         be_set_transform_function(op_NoMem,       be_duplicate_node);
121         be_set_transform_function(op_Pin,         be_duplicate_node);
122         be_set_transform_function(op_Start,       be_duplicate_node);
123         be_set_transform_function(op_Sync,        be_duplicate_node);
124 }
125
126 ir_node *be_duplicate_node(ir_node *node)
127 {
128         ir_node  *block = be_transform_node(get_nodes_block(node));
129         ir_graph *irg   = env.irg;
130         dbg_info *dbgi  = get_irn_dbg_info(node);
131         ir_mode  *mode  = get_irn_mode(node);
132         ir_op    *op    = get_irn_op(node);
133         ir_node  *new_node;
134         int      i, arity;
135
136         arity = get_irn_arity(node);
137         if (op->opar == oparity_dynamic) {
138                 new_node = new_ir_node(dbgi, irg, block, op, mode, -1, NULL);
139                 for (i = 0; i < arity; ++i) {
140                         ir_node *in = get_irn_n(node, i);
141                         in = be_transform_node(in);
142                         add_irn_n(new_node, in);
143                 }
144         } else {
145                 ir_node **ins = ALLOCAN(ir_node*, arity);
146                 for (i = 0; i < arity; ++i) {
147                         ir_node *in = get_irn_n(node, i);
148                         ins[i] = be_transform_node(in);
149                 }
150
151                 new_node = new_ir_node(dbgi, irg, block, op, mode, arity, ins);
152         }
153
154         copy_node_attr(irg, node, new_node);
155         be_duplicate_deps(node, new_node);
156
157         new_node->node_nr = node->node_nr;
158         return new_node;
159 }
160
161 ir_node *be_transform_node(ir_node *node)
162 {
163         ir_op   *op;
164         ir_node *new_node = be_get_transformed_node(node);
165
166         if (new_node != NULL)
167                 return new_node;
168
169         DEBUG_ONLY(be_set_transformed_node(node, NULL));
170
171         op = get_irn_op(node);
172         if (op->ops.generic == NULL) {
173                 panic("No transform function registered for node %+F.", node);
174         }
175         be_transform_func *transform = (be_transform_func *)op->ops.generic;
176
177         new_node = transform(node);
178         assert(new_node != NULL);
179
180         be_set_transformed_node(node, new_node);
181         hook_dead_node_elim_subst(current_ir_graph, node, new_node);
182         return new_node;
183 }
184
185 void be_enqueue_preds(ir_node *node)
186 {
187         int i, arity;
188
189         /* put the preds in the worklist */
190         arity = get_irn_arity(node);
191         for (i = 0; i < arity; ++i) {
192                 ir_node *pred = get_irn_n(node, i);
193                 pdeq_putr(env.worklist, pred);
194         }
195 }
196
197 /**
198  * Rewire nodes which are potential loops (like Phis) to avoid endless loops.
199  */
200 static void fix_loops(ir_node *node)
201 {
202         int i, arity;
203         int changed;
204
205         assert(node_is_in_irgs_storage(env.irg, node));
206
207         if (irn_visited_else_mark(node))
208                 return;
209
210         changed = 0;
211         if (! is_Block(node)) {
212                 ir_node *block     = get_nodes_block(node);
213                 ir_node *new_block = get_irn_link(block);
214
215                 if (new_block != NULL) {
216                         set_nodes_block(node, new_block);
217                         block = new_block;
218                         changed = 1;
219                 }
220
221                 fix_loops(block);
222         }
223
224         arity = get_irn_arity(node);
225         for (i = 0; i < arity; ++i) {
226                 ir_node *in = get_irn_n(node, i);
227                 ir_node *nw = get_irn_link(in);
228
229                 if (nw != NULL && nw != in) {
230                         set_irn_n(node, i, nw);
231                         in = nw;
232                         changed = 1;
233                 }
234
235                 fix_loops(in);
236         }
237         /* fix proj block */
238         if (is_Proj(node)) {
239                 set_nodes_block(node, get_nodes_block(get_Proj_pred(node)));
240                 changed = 1;
241         }
242
243         arity = get_irn_deps(node);
244         for (i = 0; i < arity; ++i) {
245                 ir_node *in = get_irn_dep(node, i);
246                 ir_node *nw = get_irn_link(in);
247
248                 if (nw != NULL && nw != in) {
249                         set_irn_dep(node, i, nw);
250                         in = nw;
251                         changed = 1;
252                 }
253
254                 fix_loops(in);
255         }
256
257         if (changed) {
258                 identify_remember(current_ir_graph->value_table, node);
259         }
260 }
261
262 ir_node *be_pre_transform_node(ir_node *place)
263 {
264         if (place == NULL)
265                 return NULL;
266
267         return be_transform_node(place);
268 }
269
270 static void pre_transform_anchor(int anchor)
271 {
272         ir_node *old_anchor_node = get_irn_n(env.old_anchor, anchor);
273         ir_node *transformed     = be_transform_node(old_anchor_node);
274         set_irg_anchor(current_ir_graph, anchor, transformed);
275 }
276
277 static void kill_unused_anchor(int anchor)
278 {
279         ir_node *old_anchor_node = get_irn_n(env.old_anchor, anchor);
280         ir_node *old_bad         = get_irn_n(env.old_anchor, anchor_bad);
281         if (old_anchor_node != NULL && get_irn_n_edges(old_anchor_node) <= 1) {
282                 set_irn_n(env.old_anchor, anchor, old_bad);
283         }
284 }
285
286 static ir_node *new_be_Anchor(ir_graph *irg)
287 {
288         struct obstack *obst = be_get_be_obst(irg);
289         backend_info_t *info;
290         ir_node        *new_anchor;
291
292         /* Hack: some places in the code ask the Anchor for its register
293            requirements */
294         new_anchor = new_Anchor(irg);
295         info = be_get_info(new_anchor);
296         info->out_infos = NEW_ARR_D(reg_out_info_t, obst, 1);
297         memset(info->out_infos, 0, 1 * sizeof(info->out_infos[0]));
298         info->out_infos[0].req = arch_no_register_req;
299
300         return new_anchor;
301 }
302
303 /**
304  * Transforms all nodes. Deletes the old obstack and creates a new one.
305  */
306 static void transform_nodes(ir_graph *irg, arch_pretrans_nodes *pre_transform)
307 {
308         int       i;
309         ir_node  *old_end, *new_anchor;
310
311         hook_dead_node_elim(irg, 1);
312
313         inc_irg_visited(irg);
314
315         env.irg         = irg;
316         env.worklist    = new_waitq();
317         env.old_anchor  = irg->anchor;
318
319         old_end = get_irg_end(irg);
320
321         /* put all anchor nodes in the worklist */
322         for (i = get_irg_n_anchors(irg) - 1; i >= 0; --i) {
323                 ir_node *anchor = get_irg_anchor(irg, i);
324
325                 if (anchor == NULL)
326                         continue;
327                 waitq_put(env.worklist, anchor);
328         }
329
330         new_anchor  = new_be_Anchor(irg);
331         irg->anchor = new_anchor;
332
333         /* pre transform some anchors (so they are available in the other transform
334          * functions) */
335         pre_transform_anchor(anchor_bad);
336         pre_transform_anchor(anchor_no_mem);
337         pre_transform_anchor(anchor_start_block);
338         pre_transform_anchor(anchor_start);
339         pre_transform_anchor(anchor_frame);
340         kill_unused_anchor(anchor_tls);
341
342         if (pre_transform)
343                 pre_transform();
344
345         /* process worklist (this should transform all nodes in the graph) */
346         while (! waitq_empty(env.worklist)) {
347                 ir_node *node = waitq_get(env.worklist);
348                 be_transform_node(node);
349         }
350
351         /* fix loops and set new anchors*/
352         inc_irg_visited(irg);
353         for (i = get_irg_n_anchors(irg) - 1; i >= 0; --i) {
354                 ir_node *anchor = get_irn_n(env.old_anchor, i);
355
356                 if (anchor == NULL)
357                         continue;
358
359                 anchor = get_irn_link(anchor);
360                 fix_loops(anchor);
361                 set_irn_n(new_anchor, i, anchor);
362         }
363         set_nodes_block(new_anchor, get_irg_anchor(irg, anchor_end_block));
364
365         del_waitq(env.worklist);
366         free_End(old_end);
367         hook_dead_node_elim(irg, 0);
368 }
369
370 /**
371  * Transform helper for blocks.
372  */
373 static ir_node *gen_Block(ir_node *node)
374 {
375         ir_graph *irg             = current_ir_graph;
376         dbg_info *dbgi            = get_irn_dbg_info(node);
377         ir_node  *macroblock      = get_Block_MacroBlock(node);
378         ir_node  *block;
379
380         block = new_ir_node(dbgi, irg, NULL, get_irn_op(node), get_irn_mode(node),
381                             get_irn_arity(node), get_irn_in(node) + 1);
382         copy_node_attr(irg, node, block);
383         block->node_nr = node->node_nr;
384
385         if (node == macroblock) {
386                 /* this node is a macroblock header */
387                 set_Block_MacroBlock(block, block);
388         } else {
389                 macroblock = be_transform_node(macroblock);
390                 set_Block_MacroBlock(block, macroblock);
391         }
392
393         /* put the preds in the worklist */
394         be_enqueue_preds(node);
395
396         return block;
397 }
398
399 static ir_node *gen_End(ir_node *node)
400 {
401         /* end has to be duplicated manually because we need a dynamic in array */
402         ir_graph *irg   = current_ir_graph;
403         dbg_info *dbgi  = get_irn_dbg_info(node);
404         ir_node  *block = be_transform_node(get_nodes_block(node));
405         int      i, arity;
406         ir_node  *new_end;
407
408         new_end = new_ir_node(dbgi, irg, block, op_End, mode_X, -1, NULL);
409         copy_node_attr(irg, node, new_end);
410         be_duplicate_deps(node, new_end);
411
412         set_irg_end(irg, new_end);
413
414         /* transform preds */
415         arity = get_irn_arity(node);
416         for (i = 0; i < arity; ++i) {
417                 ir_node *in     = get_irn_n(node, i);
418                 ir_node *new_in = be_transform_node(in);
419
420                 add_End_keepalive(new_end, new_in);
421         }
422
423         return new_end;
424 }
425
426 void be_transform_graph(ir_graph *irg, arch_pretrans_nodes *func)
427 {
428         ir_graph *old_current_ir_graph = current_ir_graph;
429         struct obstack *old_obst = NULL;
430         struct obstack *new_obst = NULL;
431
432         current_ir_graph = irg;
433
434         /* create a new obstack */
435         old_obst = irg->obst;
436         new_obst = XMALLOC(struct obstack);
437         obstack_init(new_obst);
438         irg->obst = new_obst;
439         irg->last_node_idx = 0;
440
441         /* invalidate phase info as (at least vrp info) is used inside the
442          * equivalent/compute_value functions and might replace our newly
443          * created nodes with middleend nodes */
444         irg_invalidate_phases(irg);
445
446         /* create new value table for CSE */
447         del_identities(irg->value_table);
448         irg->value_table = new_identities();
449
450         /* enter special helper */
451         op_Block->ops.generic = (op_func)gen_Block;
452         op_End->ops.generic   = (op_func)gen_End;
453
454         /* do the main transformation */
455         transform_nodes(irg, func);
456
457         /* free the old obstack */
458         obstack_free(old_obst, 0);
459         xfree(old_obst);
460
461         /* restore state */
462         current_ir_graph = old_current_ir_graph;
463
464         /* most analysis info is wrong after transformation */
465         free_callee_info(irg);
466         free_irg_outs(irg);
467         free_trouts();
468         free_loop_information(irg);
469         set_irg_doms_inconsistent(irg);
470
471         be_liveness_invalidate(be_get_irg_liveness(irg));
472         /* Hack for now, something is buggy with invalidate liveness... */
473         be_birg_from_irg(irg)->lv = NULL;
474         be_invalidate_dom_front(irg);
475
476         /* recalculate edges */
477         edges_deactivate(irg);
478         edges_activate(irg);
479 }