convert lower_mode_b to assure/confirm_irg_properties style
[libfirm] / ir / lower / lower_mode_b.c
1 /*
2  * Copyright (C) 1995-2011 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       lower mode_b operations to something the backend can handle
23  * @author      Matthias Braun, Christoph Mallon
24  */
25 #include "config.h"
26
27 #include "lower_mode_b.h"
28
29 #include <stdlib.h>
30 #include <stdbool.h>
31
32 #include "irnode_t.h"
33 #include "ircons_t.h"
34 #include "irflag.h"
35 #include "irgwalk.h"
36 #include "irtools.h"
37 #include "iredges.h"
38 #include "iropt_t.h"
39 #include "irgmod.h"
40 #include "tv.h"
41 #include "error.h"
42 #include "lowering.h"
43 #include "pdeq.h"
44 #include "irpass_t.h"
45 #include "util.h"
46 #include "array.h"
47 #include "irgopt.h"
48
49 typedef struct needs_lowering_t {
50         ir_node *node;
51         int      input;
52 } needs_lowering_t;
53
54 static ir_mode          *lowered_mode;
55 static needs_lowering_t *needs_lowering;
56
57 static ir_node *create_not(dbg_info *dbgi, ir_node *node)
58 {
59         ir_node   *block  = get_nodes_block(node);
60         ir_mode   *mode   = lowered_mode;
61         ir_tarval *tv_one = get_mode_one(mode);
62         ir_graph  *irg    = get_irn_irg(node);
63         ir_node   *one    = new_rd_Const(dbgi, irg, tv_one);
64
65         return new_rd_Eor(dbgi, block, node, one, mode);
66 }
67
68 static ir_node *convert_to_modeb(ir_node *node)
69 {
70         ir_node   *block   = get_nodes_block(node);
71         ir_graph  *irg     = get_irn_irg(node);
72         ir_mode   *mode    = lowered_mode;
73         ir_tarval *tv_zero = get_mode_null(mode);
74         ir_node   *zero    = new_r_Const(irg, tv_zero);
75         ir_node   *cmp     = new_r_Cmp(block, node, zero, ir_relation_less_greater);
76         return cmp;
77 }
78
79 /**
80  * implementation of create_set_func which produces a cond with control
81  * flow
82  */
83 static ir_node *create_cond_set(ir_node *cond_value, ir_mode *dest_mode)
84 {
85         ir_node  *lower_block = part_block_edges(cond_value);
86         ir_node  *upper_block = get_nodes_block(cond_value);
87         ir_graph *irg         = get_irn_irg(cond_value);
88         ir_node  *cond        = new_r_Cond(upper_block, cond_value);
89         ir_node  *proj_true   = new_r_Proj(cond, mode_X, pn_Cond_true);
90         ir_node  *proj_false  = new_r_Proj(cond, mode_X, pn_Cond_false);
91         ir_node  *in_true[1]  = { proj_true };
92         ir_node  *in_false[1] = { proj_false };
93         ir_node  *true_block  = new_r_Block(irg, ARRAY_SIZE(in_true), in_true);
94         ir_node  *false_block = new_r_Block(irg, ARRAY_SIZE(in_false),in_false);
95         ir_node  *true_jmp    = new_r_Jmp(true_block);
96         ir_node  *false_jmp   = new_r_Jmp(false_block);
97         ir_node  *lower_in[2] = { true_jmp, false_jmp };
98         ir_node  *one         = new_r_Const(irg, get_mode_one(dest_mode));
99         ir_node  *zero        = new_r_Const(irg, get_mode_null(dest_mode));
100         ir_node  *phi_in[2]   = { one, zero };
101         ir_node  *phi;
102
103         set_irn_in(lower_block, ARRAY_SIZE(lower_in), lower_in);
104         phi = new_r_Phi(lower_block, ARRAY_SIZE(phi_in), phi_in, dest_mode);
105
106         return phi;
107 }
108
109 static ir_node *lower_node(ir_node *node)
110 {
111         dbg_info *dbgi  = get_irn_dbg_info(node);
112         ir_node  *block = get_nodes_block(node);
113         ir_mode  *mode  = lowered_mode;
114         ir_node  *res   = (ir_node*)get_irn_link(node);
115         ir_graph *irg;
116
117         if (res != NULL)
118                 return res;
119
120         node = skip_Tuple(node);
121
122         assert(get_irn_mode(node) == mode_b);
123
124         irg = get_irn_irg(node);
125         switch (get_irn_opcode(node)) {
126         case iro_Phi: {
127                 int       i, arity;
128                 ir_node **in;
129                 ir_node  *dummy;
130                 ir_node  *new_phi;
131
132                 arity = get_irn_arity(node);
133                 in    = ALLOCAN(ir_node*, arity);
134                 dummy = new_r_Dummy(irg, mode);
135                 for (i = 0; i < arity; ++i) {
136                         in[i] = dummy;
137                 }
138                 new_phi = new_r_Phi(block, arity, in, mode);
139                 /* FIXME This does not correctly break cycles: The Phi might not be the
140                  * first in the recursion, so the caller(s) are some yet un-lowered
141                  * nodes and this Phi might have them (indirectly) as operands, so they
142                  * would be replaced twice. */
143                 set_irn_link(node, new_phi);
144
145                 for (i = 0; i < arity; ++i) {
146                         ir_node *in         = get_irn_n(node, i);
147                         ir_node *lowered_in = lower_node(in);
148
149                         set_irn_n(new_phi, i, lowered_in);
150                 }
151
152                 return new_phi;
153         }
154
155         case iro_And: {
156                 ir_node *lowered_left  = lower_node(get_And_left(node));
157                 ir_node *lowered_right = lower_node(get_And_right(node));
158                 res = new_rd_And(dbgi, block, lowered_left, lowered_right, mode);
159                 break;
160         }
161         case iro_Or: {
162                 ir_node *lowered_left  = lower_node(get_Or_left(node));
163                 ir_node *lowered_right = lower_node(get_Or_right(node));
164                 res = new_rd_Or(dbgi, block, lowered_left, lowered_right, mode);
165                 break;
166         }
167         case iro_Eor: {
168                 ir_node *lowered_left  = lower_node(get_Eor_left(node));
169                 ir_node *lowered_right = lower_node(get_Eor_right(node));
170                 res = new_rd_Eor(dbgi, block, lowered_left, lowered_right, mode);
171                 break;
172         }
173
174         case iro_Not: {
175                 ir_node *op     = get_Not_op(node);
176                 ir_node *low_op = lower_node(op);
177
178                 res = create_not(dbgi, low_op);
179                 break;
180         }
181
182         case iro_Mux: {
183                 ir_node *cond        = get_Mux_sel(node);
184                 ir_node *low_cond    = lower_node(cond);
185                 ir_node *v_true      = get_Mux_true(node);
186                 ir_node *low_v_true  = lower_node(v_true);
187                 ir_node *v_false     = get_Mux_false(node);
188                 ir_node *low_v_false = lower_node(v_false);
189
190                 ir_node *and0     = new_rd_And(dbgi, block, low_cond, low_v_true, mode);
191                 ir_node *not_cond = create_not(dbgi, low_cond);
192                 ir_node *and1     = new_rd_And(dbgi, block, not_cond, low_v_false, mode);
193                 res = new_rd_Or(dbgi, block, and0, and1, mode);
194                 break;
195         }
196
197         case iro_Cmp:
198                 res = create_cond_set(node, mode);
199                 break;
200
201         case iro_Const: {
202                 ir_tarval *tv = get_Const_tarval(node);
203                 if (tv == get_tarval_b_true()) {
204                         ir_tarval *tv_one = get_mode_one(mode);
205                         res               = new_rd_Const(dbgi, irg, tv_one);
206                 } else if (tv == get_tarval_b_false()) {
207                         ir_tarval *tv_zero = get_mode_null(mode);
208                         res                = new_rd_Const(dbgi, irg, tv_zero);
209                 } else {
210                         panic("invalid boolean const %+F", node);
211                 }
212                 break;
213         }
214
215         case iro_Unknown:
216                 res = new_r_Unknown(irg, mode);
217                 break;
218
219         case iro_Bad:
220                 res = new_r_Bad(irg, mode);
221                 break;
222
223         default:
224                 panic("Don't know how to lower mode_b node %+F", node);
225         }
226
227         set_irn_link(node, res);
228         return res;
229 }
230
231 static bool needs_mode_b_input(const ir_node *node, int input)
232 {
233         return (is_Cond(node) && input == n_Cond_selector)
234             || (is_Mux(node) && input == n_Mux_sel);
235 }
236
237 /**
238  * Collects "roots" of a mode_b calculation. These are nodes which require a
239  * mode_b input (Cond, Mux)
240  */
241 static void collect_needs_lowering(ir_node *node, void *env)
242 {
243         int arity = get_irn_arity(node);
244         int i;
245         (void) env;
246
247         /* if the node produces mode_b then it is not a root (but should be
248          * something our lower_node function can handle) */
249         if (get_irn_mode(node) == mode_b) {
250                 assert(is_And(node) || is_Or(node) || is_Eor(node) || is_Phi(node)
251                        || is_Not(node) || is_Mux(node) || is_Cmp(node)
252                        || is_Const(node) || is_Unknown(node) || is_Bad(node));
253                 return;
254         }
255
256         for (i = 0; i < arity; ++i) {
257                 needs_lowering_t entry;
258                 ir_node *in = get_irn_n(node, i);
259                 if (get_irn_mode(in) != mode_b)
260                         continue;
261                 if (is_Cmp(in) && needs_mode_b_input(node, i))
262                         continue;
263
264                 entry.node  = node;
265                 entry.input = i;
266                 ARR_APP1(needs_lowering_t, needs_lowering, entry);
267         }
268 }
269
270 void ir_lower_mode_b(ir_graph *const irg, ir_mode *const nlowered_mode)
271 {
272         size_t i;
273         size_t n;
274
275         lowered_mode = nlowered_mode;
276
277         /* edges are used by part_block_edges in the ir_create_cond_set variant. */
278         assure_irg_properties(irg, IR_GRAPH_PROPERTY_CONSISTENT_OUT_EDGES
279                                  | IR_GRAPH_PROPERTY_NO_TUPLES);
280
281         add_irg_constraints(irg, IR_GRAPH_CONSTRAINT_MODEB_LOWERED);
282         ir_reserve_resources(irg, IR_RESOURCE_IRN_LINK);
283
284         needs_lowering = NEW_ARR_F(needs_lowering_t, 0);
285
286         irg_walk_graph(irg, firm_clear_link, collect_needs_lowering, NULL);
287
288         n = ARR_LEN(needs_lowering);
289         for (i = 0; i < n; ++i) {
290                 const needs_lowering_t *entry   = &needs_lowering[i];
291                 ir_node                *node    = entry->node;
292                 int                     input   = entry->input;
293                 ir_node                *in      = get_irn_n(node, input);
294                 ir_node                *lowered = lower_node(in);
295
296                 if (needs_mode_b_input(node, input))
297                         lowered = convert_to_modeb(lowered);
298                 set_irn_n(node, input, lowered);
299         }
300
301         ir_free_resources(irg, IR_RESOURCE_IRN_LINK);
302
303         DEL_ARR_F(needs_lowering);
304
305         confirm_irg_properties(irg, n > 0 ? IR_GRAPH_PROPERTIES_NONE : IR_GRAPH_PROPERTIES_ALL);
306 }