fix wrong assert, expor copy_node_attr function to public API
[libfirm] / ir / lower / lower_mode_b.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       lowers operations with mode_b. The result is a graph which
23  *              might still contains some convs from/to mode_b, but no
24  *              operations are performed on them anymore, they are just there
25  *              so modes match. A backend can safely skip all mode_b convs.
26  * @author      Matthias Braun, Christoph Mallon
27  * @version     $Id$
28  */
29 #include "config.h"
30
31 #include <stdlib.h>
32
33 #include "irnode_t.h"
34 #include "ircons_t.h"
35 #include "irflag.h"
36 #include "irgwalk.h"
37 #include "irtools.h"
38 #include "iredges.h"
39 #include "iropt_t.h"
40 #include "tv.h"
41 #include "error.h"
42 #include "lowering.h"
43 #include "pdeq.h"
44
45 static lower_mode_b_config_t  config;
46 static ir_type               *lowered_type  = NULL;
47 static pdeq                  *lowered_nodes = NULL;
48
49 /**
50  * Removes a node if its out-edge count has reached 0.
51  * temporary hack until we have proper automatic dead code elimination.
52  */
53 static void maybe_kill_node(ir_node *node)
54 {
55         ir_graph *irg;
56         int       i, arity;
57
58         if(get_irn_n_edges(node) != 0)
59                 return;
60
61         irg = get_irn_irg(node);
62
63         assert(!is_Bad(node));
64
65         arity = get_irn_arity(node);
66         for (i = 0; i < arity; ++i) {
67                 set_irn_n(node, i, new_Bad());
68         }
69         set_nodes_block(node, new_Bad());
70
71         edges_node_deleted(node, irg);
72 }
73
74 static ir_node *create_not(dbg_info *dbgi, ir_node *node)
75 {
76         ir_graph *irg    = current_ir_graph;
77         ir_node  *block  = get_nodes_block(node);
78         ir_mode  *mode   = config.lowered_mode;
79         tarval   *tv_one = get_tarval_one(mode);
80         ir_node  *one    = new_d_Const(dbgi, tv_one);
81
82         return new_rd_Eor(dbgi, irg, block, node, one, mode);
83 }
84
85 static ir_node *create_convb(ir_node *node)
86 {
87         ir_graph *irg   = current_ir_graph;
88         ir_node  *block = get_nodes_block(node);
89         ir_node  *conv  = new_rd_Conv(NULL, irg, block, node, mode_b);
90
91         return conv;
92 }
93
94 static ir_type *create_lowered_type(void)
95 {
96         if(lowered_type == NULL) {
97                 lowered_type = new_type_primitive(new_id_from_str("__lowered_mode_b"),
98                                                   config.lowered_mode);
99         }
100         return lowered_type;
101 }
102
103 /**
104  * creates a "set" node that produces a 0 or 1 based on a Cmp result
105  */
106 static ir_node *create_set(ir_node *node)
107 {
108         ir_graph *irg     = current_ir_graph;
109         dbg_info *dbgi    = get_irn_dbg_info(node);
110         ir_mode  *mode    = config.lowered_set_mode;
111         tarval   *tv_one  = get_tarval_one(mode);
112         ir_node  *one     = new_d_Const(dbgi, tv_one);
113         ir_node  *block   = get_nodes_block(node);
114         tarval   *tv_zero = get_tarval_null(mode);
115         ir_node  *zero    = new_d_Const(dbgi, tv_zero);
116
117         ir_node *set      = new_rd_Mux(dbgi, irg, block, node, zero, one, mode);
118
119         if (mode != config.lowered_mode) {
120                 set = new_r_Conv(irg, block, set, config.lowered_mode);
121         }
122
123         return set;
124 }
125
126 static void adjust_method_type(ir_type *method_type)
127 {
128         int i;
129         int n_params;
130         int n_res;
131
132         n_params = get_method_n_params(method_type);
133         for(i = 0; i < n_params; ++i) {
134                 ir_type *param = get_method_param_type(method_type, i);
135                 if(get_type_mode(param) == mode_b) {
136                         set_method_param_type(method_type, i, create_lowered_type());
137                 }
138         }
139
140         n_res = get_method_n_ress(method_type);
141         for(i = 0; i < n_res; ++i) {
142                 ir_type *res_type = get_method_res_type(method_type, i);
143                 if(get_type_mode(res_type) == mode_b) {
144                         set_method_res_type(method_type, i, create_lowered_type());
145                 }
146         }
147 }
148
149 static ir_node *lower_node(ir_node *node)
150 {
151         ir_graph *irg   = current_ir_graph;
152         dbg_info *dbgi  = get_irn_dbg_info(node);
153         ir_node  *block = get_nodes_block(node);
154         ir_mode *mode   = config.lowered_mode;
155         ir_node  *res;
156
157         assert(get_irn_mode(node) == mode_b);
158
159         res = get_irn_link(node);
160         if(res != NULL)
161                 return res;
162
163         /* TODO: be robust against phi-loops... */
164         switch (get_irn_opcode(node)) {
165         case iro_Phi: {
166                 int       i, arity;
167                 ir_node **in;
168                 ir_node  *unknown, *new_phi;
169
170                 arity   = get_irn_arity(node);
171                 in      = ALLOCAN(ir_node*, arity);
172                 unknown = new_Unknown(config.lowered_mode);
173                 for(i = 0; i < arity; ++i) {
174                         in[i] = unknown;
175                 }
176                 new_phi = new_r_Phi(irg, block, arity, in, config.lowered_mode);
177                 set_irn_link(node, new_phi);
178                 pdeq_putr(lowered_nodes, node);
179
180                 for(i = 0; i < arity; ++i) {
181                         ir_node *in     = get_irn_n(node, i);
182                         ir_node *low_in = lower_node(in);
183
184                         set_irn_n(new_phi, i, low_in);
185                 }
186
187                 return new_phi;
188         }
189
190         case iro_And:
191         case iro_Or:
192         case iro_Eor: {
193                 int i, arity;
194                 ir_node *copy = exact_copy(node);
195
196                 arity = get_irn_arity(node);
197                 for(i = 0; i < arity; ++i) {
198                         ir_node *in     = get_irn_n(node, i);
199                         ir_node *low_in = lower_node(in);
200
201                         set_irn_n(copy, i, low_in);
202                 }
203                 set_irn_mode(copy, config.lowered_mode);
204
205                 set_irn_link(node, copy);
206                 pdeq_putr(lowered_nodes, node);
207                 return copy;
208         }
209         case iro_Not: {
210                 ir_node *op     = get_Not_op(node);
211                 ir_node *low_op = lower_node(op);
212
213                 res = create_not(dbgi, low_op);
214                 set_irn_link(node, res);
215                 pdeq_putr(lowered_nodes, node);
216                 return res;
217         }
218         case iro_Mux: {
219                 ir_node *cond        = get_Mux_sel(node);
220                 ir_node *low_cond    = lower_node(cond);
221                 ir_node *v_true      = get_Mux_true(node);
222                 ir_node *low_v_true  = lower_node(v_true);
223                 ir_node *v_false     = get_Mux_false(node);
224                 ir_node *low_v_false = lower_node(v_false);
225
226                 ir_node *and0     = new_rd_And(dbgi, irg, block, low_cond, low_v_true, mode);
227                 ir_node *not_cond = create_not(dbgi, low_cond);
228                 ir_node *and1     = new_rd_And(dbgi, irg, block, not_cond, low_v_false, mode);
229                 ir_node *or       = new_rd_Or(dbgi, irg, block, and0, and1, mode);
230
231                 set_irn_link(node, or);
232                 pdeq_putr(lowered_nodes, node);
233                 return or;
234         }
235         case iro_Conv: {
236                 ir_node *pred     = get_Conv_op(node);
237                 ir_mode *mode     = get_irn_mode(pred);
238                 tarval  *tv_zeroc = get_tarval_null(mode);
239                 ir_node *zero_cmp = new_d_Const(dbgi, tv_zeroc);
240                 ir_node *set;
241
242                 ir_node *cmp      = new_rd_Cmp(dbgi, irg, block, pred, zero_cmp);
243                 ir_node *proj     = new_rd_Proj(dbgi, irg, block, cmp, mode_b,
244                                                 pn_Cmp_Lg);
245                 set = create_set(proj);
246
247                 set_irn_link(node, set);
248                 pdeq_putr(lowered_nodes, node);
249                 return set;
250         }
251         case iro_Proj: {
252                 ir_node *pred = get_Proj_pred(node);
253
254                 if(is_Cmp(pred)) {
255                         ir_node *left  = get_Cmp_left(pred);
256                         ir_node *right = get_Cmp_right(pred);
257                         ir_mode *cmp_mode  = get_irn_mode(left);
258                         ir_node *set;
259
260                         if ((mode_is_int(cmp_mode) || mode_is_reference(cmp_mode)) && (
261                                                 get_mode_size_bits(cmp_mode) < get_mode_size_bits(mode) ||
262                                                 (mode_is_signed(cmp_mode) && is_Const(right) && is_Const_null(right))
263                                         )) {
264                                 int      pnc      = get_Proj_proj(node);
265                                 int      need_not = 0;
266                                 ir_node *a        = NULL;
267                                 ir_node *b        = NULL;
268
269                                 if(pnc == pn_Cmp_Lt) {
270                                         /* a < b  ->  (a - b) >> 31 */
271                                         a = left;
272                                         b = right;
273                                 } else if(pnc == pn_Cmp_Le) {
274                                         /* a <= b  -> ~(a - b) >> 31 */
275                                         a        = right;
276                                         b        = left;
277                                         need_not = 1;
278                                 } else if(pnc == pn_Cmp_Gt) {
279                                         /* a > b   -> (b - a) >> 31 */
280                                         a = right;
281                                         b = left;
282                                 } else if(pnc == pn_Cmp_Ge) {
283                                         /* a >= b   -> ~(a - b) >> 31 */
284                                         a        = left;
285                                         b        = right;
286                                         need_not = 1;
287                                 }
288
289                                 if(a != NULL) {
290                                         int      bits      = get_mode_size_bits(mode);
291                                         tarval  *tv        = new_tarval_from_long(bits-1, mode_Iu);
292                                         ir_node *shift_cnt = new_d_Const(dbgi, tv);
293
294                                         if(cmp_mode != mode) {
295                                                 a = new_rd_Conv(dbgi, irg, block, a, mode);
296                                                 b = new_rd_Conv(dbgi, irg, block, b, mode);
297                                         }
298
299                                         res = new_rd_Sub(dbgi, irg, block, a, b, mode);
300                                         if(need_not) {
301                                                 res = new_rd_Not(dbgi, irg, block, res, mode);
302                                         }
303                                         res = new_rd_Shr(dbgi, irg, block, res, shift_cnt, mode);
304
305                                         set_irn_link(node, res);
306                                         pdeq_putr(lowered_nodes, node);
307                                         return res;
308                                 }
309                         }
310
311                         /* synthesize the 0/1 value */
312                         set = create_set(node);
313                         set_irn_link(node, set);
314                         pdeq_putr(lowered_nodes, node);
315                         return set;
316                 } else if(is_Proj(pred) && is_Call(get_Proj_pred(pred))) {
317                         ir_type   *type   = get_Call_type(get_Proj_pred(pred));
318                         adjust_method_type(type);
319                         set_irn_mode(node, mode);
320                         return node;
321                 } else if(is_Proj(pred) && is_Start(get_Proj_pred(pred))) {
322                         ir_entity *entity = get_irg_entity(irg);
323                         ir_type   *type   = get_entity_type(entity);
324                         adjust_method_type(type);
325                         set_irn_mode(node, mode);
326                         return node;
327                 }
328
329                 panic("unexpected projb: %+F (pred: %+F)", node, pred);
330         }
331         case iro_Const: {
332                 tarval *tv = get_Const_tarval(node);
333                 if(tv == get_tarval_b_true()) {
334                         tarval  *tv_one  = get_tarval_one(mode);
335                         res              = new_d_Const(dbgi, tv_one);
336                 } else if(tv == get_tarval_b_false()) {
337                         tarval  *tv_zero = get_tarval_null(mode);
338                         res              = new_d_Const(dbgi, tv_zero);
339                 } else {
340                         panic("invalid boolean const %+F", node);
341                 }
342                 set_irn_link(node, res);
343                 pdeq_putr(lowered_nodes, node);
344                 return res;
345         }
346         case iro_Unknown:
347                 return new_Unknown(config.lowered_mode);
348         default:
349                 panic("didn't expect %+F to have mode_b", node);
350         }
351 }
352
353 static void lower_mode_b_walker(ir_node *node, void *env)
354 {
355         int i, arity;
356         int changed = 0;
357         (void) env;
358
359         arity = get_irn_arity(node);
360         for(i = 0; i < arity; ++i) {
361                 ir_node *lowered_in;
362                 ir_node *in = get_irn_n(node, i);
363                 if(get_irn_mode(in) != mode_b)
364                         continue;
365
366                 if(! config.lower_direct_cmp) {
367                         if (is_Cond(node) ||
368                             (is_Mux(node) && get_irn_mode(node) != mode_b)) {
369                                 if(is_Proj(in)) {
370                                         ir_node *pred = get_Proj_pred(in);
371                                         if(is_Cmp(pred))
372                                                 continue;
373                                 }
374                         }
375                 }
376
377                 lowered_in = lower_node(in);
378
379                 if(is_Return(node)) {
380                         ir_entity *entity = get_irg_entity(current_ir_graph);
381                         ir_type   *type   = get_entity_type(entity);
382                         adjust_method_type(type);
383                 } else if(is_Call(node)) {
384                         ir_type *type = get_Call_type(node);
385                         adjust_method_type(type);
386                 } else {
387                         lowered_in = create_convb(lowered_in);
388                 }
389                 set_irn_n(node, i, lowered_in);
390                 changed = 1;
391         }
392         if(changed) {
393                 add_identities(current_ir_graph->value_table, node);
394         }
395 }
396
397 static void clear_links(ir_node *node, void *env)
398 {
399         (void) env;
400         set_irn_link(node, NULL);
401 }
402
403 void ir_lower_mode_b(ir_graph *irg, const lower_mode_b_config_t *nconfig)
404 {
405         config        = *nconfig;
406         lowered_nodes = new_pdeq();
407
408         /* ensure no optimisation touches muxes anymore */
409         set_irg_state(irg, IR_GRAPH_STATE_KEEP_MUX);
410
411         ir_reserve_resources(irg, IR_RESOURCE_IRN_LINK);
412
413         set_opt_allow_conv_b(0);
414         irg_walk_graph(irg, clear_links, NULL, NULL);
415         irg_walk_graph(irg, lower_mode_b_walker, NULL, NULL);
416
417         while(!pdeq_empty(lowered_nodes)) {
418                 ir_node *node = (ir_node*) pdeq_getr(lowered_nodes);
419                 maybe_kill_node(node);
420         }
421         del_pdeq(lowered_nodes);
422
423         ir_free_resources(irg, IR_RESOURCE_IRN_LINK);
424 }