Fixes backend/lower_call.c
[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       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  * After this pass the following should hold:
30  *   - The only inputs with mode_b are for the Cond node or the
31  *     Sel input of a Mux node.
32  *   - The only nodes producing mode_b are: Proj(Cmp) and ConvB(X) (where X
33  *     is some mode that can be converted to the lowered mode).
34  *     ConvB will usually be implemented by a comparison with 0 producing some
35  *     flags in the backends. It's debatable whether ConvB(X) is a good idea.
36  *     Maybe we should rather introduce a Test node.
37  * All other former uses should be converted to manipulations with an integer
38  * mode that was specified in the pass configuration.
39  */
40 #include "config.h"
41
42 #include <stdlib.h>
43 #include <stdbool.h>
44
45 #include "irnode_t.h"
46 #include "ircons_t.h"
47 #include "irflag.h"
48 #include "irgwalk.h"
49 #include "irtools.h"
50 #include "iredges.h"
51 #include "iropt_t.h"
52 #include "irgmod.h"
53 #include "tv.h"
54 #include "error.h"
55 #include "lowering.h"
56 #include "pdeq.h"
57 #include "irpass_t.h"
58 #include "util.h"
59 #include "array.h"
60
61 static const lower_mode_b_config_t *config;
62 static ir_type                     *lowered_type;
63 static ir_node                    **lowered_nodes;
64 static ir_node                    **check_later;
65
66 /**
67  * Removes a node if its out-edge count has reached 0.
68  * temporary hack until we have proper automatic dead code elimination.
69  */
70 static void maybe_kill_node(ir_node *node)
71 {
72         ir_graph *irg;
73         int       i, arity;
74
75         if (get_irn_n_edges(node) != 0)
76                 return;
77
78         irg = get_irn_irg(node);
79
80         assert(!is_Bad(node));
81
82         arity = get_irn_arity(node);
83         for (i = 0; i < arity; ++i) {
84                 set_irn_n(node, i, new_r_Bad(irg));
85         }
86         set_nodes_block(node, new_r_Bad(irg));
87
88         edges_node_deleted(node);
89 }
90
91 static ir_node *create_not(dbg_info *dbgi, ir_node *node)
92 {
93         ir_node   *block  = get_nodes_block(node);
94         ir_mode   *mode   = config->lowered_mode;
95         ir_tarval *tv_one = get_mode_one(mode);
96         ir_graph  *irg    = get_irn_irg(node);
97         ir_node   *one    = new_rd_Const(dbgi, irg, tv_one);
98
99         return new_rd_Eor(dbgi, block, node, one, mode);
100 }
101
102 static ir_node *create_convb(ir_node *node)
103 {
104         ir_node  *block = get_nodes_block(node);
105         ir_node  *conv  = new_rd_Conv(NULL, block, node, mode_b);
106
107         return conv;
108 }
109
110 static ir_type *create_lowered_type(void)
111 {
112         if (lowered_type == NULL) {
113                 lowered_type = new_type_primitive(config->lowered_mode);
114         }
115         return lowered_type;
116 }
117
118 ir_node *ir_create_mux_set(ir_node *cond, ir_mode *dest_mode)
119 {
120         ir_graph  *irg     = get_irn_irg(cond);
121         ir_node   *block   = get_nodes_block(cond);
122         ir_tarval *tv_one  = get_mode_one(dest_mode);
123         ir_node   *one     = new_r_Const(irg, tv_one);
124         ir_tarval *tv_zero = get_mode_null(dest_mode);
125         ir_node   *zero    = new_r_Const(irg, tv_zero);
126         ir_node   *set     = new_r_Mux(block, cond, zero, one, dest_mode);
127         return set;
128 }
129
130 ir_node *ir_create_cond_set(ir_node *cond_value, ir_mode *dest_mode)
131 {
132         ir_node  *lower_block = part_block_edges(cond_value);
133         ir_node  *upper_block = get_nodes_block(cond_value);
134         ir_graph *irg         = get_irn_irg(cond_value);
135         ir_node  *cond        = new_r_Cond(upper_block, cond_value);
136         ir_node  *proj_true   = new_r_Proj(cond, mode_X, pn_Cond_true);
137         ir_node  *proj_false  = new_r_Proj(cond, mode_X, pn_Cond_false);
138         ir_node  *in_true[1]  = { proj_true };
139         ir_node  *in_false[1] = { proj_false };
140         ir_node  *true_block  = new_r_Block(irg, ARRAY_SIZE(in_true), in_true);
141         ir_node  *false_block = new_r_Block(irg, ARRAY_SIZE(in_false),in_false);
142         ir_node  *true_jmp    = new_r_Jmp(true_block);
143         ir_node  *false_jmp   = new_r_Jmp(false_block);
144         ir_node  *lower_in[2] = { true_jmp, false_jmp };
145         ir_node  *one         = new_r_Const(irg, get_mode_one(dest_mode));
146         ir_node  *zero        = new_r_Const(irg, get_mode_null(dest_mode));
147         ir_node  *phi_in[2]   = { one, zero };
148         ir_node  *phi;
149
150         set_irn_in(lower_block, ARRAY_SIZE(lower_in), lower_in);
151         phi = new_r_Phi(lower_block, ARRAY_SIZE(phi_in), phi_in, dest_mode);
152
153         /* make sure we do visit the cond_value later... */
154         ARR_APP1(ir_node*, check_later, cond_value);
155
156         return phi;
157 }
158
159 static void adjust_method_type(ir_type *method_type)
160 {
161         size_t i;
162         size_t n_params;
163         size_t n_res;
164
165         n_params = get_method_n_params(method_type);
166         for (i = 0; i < n_params; ++i) {
167                 ir_type *param = get_method_param_type(method_type, i);
168                 if (get_type_mode(param) == mode_b) {
169                         set_method_param_type(method_type, i, create_lowered_type());
170                 }
171         }
172
173         n_res = get_method_n_ress(method_type);
174         for (i = 0; i < n_res; ++i) {
175                 ir_type *res_type = get_method_res_type(method_type, i);
176                 if (get_type_mode(res_type) == mode_b) {
177                         set_method_res_type(method_type, i, create_lowered_type());
178                 }
179         }
180 }
181
182 static ir_node *lower_node(ir_node *node)
183 {
184         dbg_info *dbgi  = get_irn_dbg_info(node);
185         ir_node  *block = get_nodes_block(node);
186         ir_mode  *mode  = config->lowered_mode;
187         ir_node  *res   = (ir_node*)get_irn_link(node);
188         ir_graph *irg;
189
190         if (res != NULL)
191                 return res;
192
193         assert(get_irn_mode(node) == mode_b);
194
195         irg = get_irn_irg(node);
196         switch (get_irn_opcode(node)) {
197         case iro_Phi: {
198                 int       i, arity;
199                 ir_node **in;
200                 ir_node  *dummy;
201                 ir_node  *new_phi;
202
203                 arity = get_irn_arity(node);
204                 in    = ALLOCAN(ir_node*, arity);
205                 dummy = new_r_Dummy(irg, mode);
206                 for (i = 0; i < arity; ++i) {
207                         in[i] = dummy;
208                 }
209                 new_phi = new_r_Phi(block, arity, in, mode);
210                 /* FIXME This does not correctly break cycles: The Phi might not be the
211                  * first in the recursion, so the caller(s) are some yet un-lowered
212                  * nodes and this Phi might have them (indirectly) as operands, so they
213                  * would be replaced twice. */
214                 set_irn_link(node, new_phi);
215                 ARR_APP1(ir_node*, lowered_nodes, node);
216
217                 for (i = 0; i < arity; ++i) {
218                         ir_node *in     = get_irn_n(node, i);
219                         ir_node *low_in = lower_node(in);
220
221                         set_irn_n(new_phi, i, low_in);
222                 }
223
224                 return new_phi;
225         }
226
227         case iro_And: {
228                 ir_node *lowered_left  = lower_node(get_And_left(node));
229                 ir_node *lowered_right = lower_node(get_And_right(node));
230                 res = new_rd_And(dbgi, block, lowered_left, lowered_right, mode);
231                 break;
232         }
233         case iro_Or: {
234                 ir_node *lowered_left  = lower_node(get_Or_left(node));
235                 ir_node *lowered_right = lower_node(get_Or_right(node));
236                 res = new_rd_Or(dbgi, block, lowered_left, lowered_right, mode);
237                 break;
238         }
239         case iro_Eor: {
240                 ir_node *lowered_left  = lower_node(get_Eor_left(node));
241                 ir_node *lowered_right = lower_node(get_Eor_right(node));
242                 res = new_rd_Eor(dbgi, block, lowered_left, lowered_right, mode);
243                 break;
244         }
245
246         case iro_Not: {
247                 ir_node *op     = get_Not_op(node);
248                 ir_node *low_op = lower_node(op);
249
250                 res = create_not(dbgi, low_op);
251                 break;
252         }
253
254         case iro_Mux: {
255                 ir_node *cond        = get_Mux_sel(node);
256                 ir_node *low_cond    = lower_node(cond);
257                 ir_node *v_true      = get_Mux_true(node);
258                 ir_node *low_v_true  = lower_node(v_true);
259                 ir_node *v_false     = get_Mux_false(node);
260                 ir_node *low_v_false = lower_node(v_false);
261
262                 ir_node *and0     = new_rd_And(dbgi, block, low_cond, low_v_true, mode);
263                 ir_node *not_cond = create_not(dbgi, low_cond);
264                 ir_node *and1     = new_rd_And(dbgi, block, not_cond, low_v_false, mode);
265                 res = new_rd_Or(dbgi, block, and0, and1, mode);
266                 break;
267         }
268
269         case iro_Conv: {
270                 ir_node   *pred     = get_Conv_op(node);
271                 ir_mode   *mode     = get_irn_mode(pred);
272                 ir_tarval *tv_zeroc = get_mode_null(mode);
273                 ir_node   *zero_cmp = new_rd_Const(dbgi, irg, tv_zeroc);
274
275                 ir_node *cmp      = new_rd_Cmp(dbgi, block, pred, zero_cmp, ir_relation_less_greater);
276                 res = config->create_set(cmp);
277                 break;
278         }
279
280         case iro_Cmp: {
281                 ir_node    *left     = get_Cmp_left(node);
282                 ir_node    *right    = get_Cmp_right(node);
283                 ir_mode    *cmp_mode = get_irn_mode(left);
284                 ir_relation relation = get_Cmp_relation(node);
285
286                 if ((mode_is_int(cmp_mode) || mode_is_reference(cmp_mode)) &&
287                         (get_mode_size_bits(cmp_mode) < get_mode_size_bits(mode) ||
288                         (mode_is_signed(cmp_mode) && is_Const(right) && is_Const_null(right) && relation != ir_relation_greater))) {
289                         int         need_not = 0;
290                         ir_node    *a        = NULL;
291                         ir_node    *b        = NULL;
292                         int         bits;
293                         ir_tarval  *tv;
294                         ir_node    *shift_cnt;
295
296                         if (relation == ir_relation_less) {
297                                 /* a < b  ->  (a - b) >> 31 */
298                                 a = left;
299                                 b = right;
300                         } else if (relation == ir_relation_less_equal) {
301                                 /* a <= b  -> ~(a - b) >> 31 */
302                                 a        = right;
303                                 b        = left;
304                                 need_not = 1;
305                         } else if (relation == ir_relation_greater) {
306                                 /* a > b   -> (b - a) >> 31 */
307                                 a = right;
308                                 b = left;
309                         } else if (relation == ir_relation_greater_equal) {
310                                 /* a >= b   -> ~(a - b) >> 31 */
311                                 a        = left;
312                                 b        = right;
313                                 need_not = 1;
314                         } else {
315                                 goto synth_zero_one;
316                         }
317
318                         bits      = get_mode_size_bits(mode);
319                         tv        = new_tarval_from_long(bits-1, mode_Iu);
320                         shift_cnt = new_rd_Const(dbgi, irg, tv);
321
322                         if (cmp_mode != mode) {
323                                 a = new_rd_Conv(dbgi, block, a, mode);
324                                 b = new_rd_Conv(dbgi, block, b, mode);
325                         }
326
327                         res = new_rd_Sub(dbgi, block, a, b, mode);
328                         if (need_not) {
329                                 res = new_rd_Not(dbgi, block, res, mode);
330                         }
331                         res = new_rd_Shr(dbgi, block, res, shift_cnt, mode);
332                 } else {
333                         /* synthesize the 0/1 value */
334 synth_zero_one:
335                         res = config->create_set(node);
336                 }
337                 break;
338         }
339
340         case iro_Proj: {
341                 ir_node *pred = get_Proj_pred(node);
342
343                 if (is_Proj(pred) && is_Call(get_Proj_pred(pred))) {
344                         ir_type *type = get_Call_type(get_Proj_pred(pred));
345                         adjust_method_type(type);
346                         set_irn_mode(node, mode);
347                         res = node;
348                         goto own_replacement;
349                 } else if (is_Proj(pred) && is_Start(get_Proj_pred(pred))) {
350                         ir_graph  *irg    = get_irn_irg(node);
351                         ir_entity *entity = get_irg_entity(irg);
352                         ir_type   *type   = get_entity_type(entity);
353                         adjust_method_type(type);
354                         set_irn_mode(node, mode);
355                         res = node;
356                         goto own_replacement;
357                 } else {
358                         panic("unexpected projb: %+F (pred: %+F)", node, pred);
359                 }
360                 break;
361         }
362
363         case iro_Const: {
364                 ir_tarval *tv = get_Const_tarval(node);
365                 if (tv == get_tarval_b_true()) {
366                         ir_tarval *tv_one = get_mode_one(mode);
367                         res               = new_rd_Const(dbgi, irg, tv_one);
368                 } else if (tv == get_tarval_b_false()) {
369                         ir_tarval *tv_zero = get_mode_null(mode);
370                         res                = new_rd_Const(dbgi, irg, tv_zero);
371                 } else {
372                         panic("invalid boolean const %+F", node);
373                 }
374                 break;
375         }
376
377         case iro_Unknown:
378                 res = new_r_Unknown(irg, mode);
379                 break;
380
381         default:
382                 panic("didn't expect %+F to have mode_b", node);
383         }
384
385         ARR_APP1(ir_node*, lowered_nodes, node);
386 own_replacement:
387         set_irn_link(node, res);
388         return res;
389 }
390
391 static void lower_mode_b_walker(ir_node *node, void *env)
392 {
393         int i, arity;
394         bool changed = false;
395
396         arity = get_irn_arity(node);
397         for (i = 0; i < arity; ++i) {
398                 ir_node *lowered_in;
399                 ir_node *in = get_irn_n(node, i);
400                 if (get_irn_mode(in) != mode_b)
401                         continue;
402
403                 if (! config->lower_direct_cmp) {
404                         /* Cmp as input for Cond and Mux nodes needs no changes.
405                            (Mux with mode_b is an exception as it gets replaced by and/or
406                             anyway so we still lower the inputs then) */
407                         if (is_Cond(node) ||
408                             (is_Mux(node) && get_irn_mode(node) != mode_b)) {
409                                 if (is_Cmp(in)) {
410                                         continue;
411                                 }
412                         }
413                 }
414
415                 lowered_in = lower_node(in);
416
417                 if (is_Call(node)) {
418                         ir_type *type = get_Call_type(node);
419                         adjust_method_type(type);
420                 } else if (is_Cond(node) || (is_Mux(node) && i == 0)) {
421                         lowered_in = create_convb(lowered_in);
422                 }
423                 set_irn_n(node, i, lowered_in);
424                 changed = true;
425         }
426         if (changed) {
427                 bool *global_changed = (bool*)env;
428                 *global_changed = true;
429                 add_identities(node);
430         }
431 }
432
433 void ir_lower_mode_b(ir_graph *irg, const lower_mode_b_config_t *nconfig)
434 {
435         ir_entity *entity  = get_irg_entity(irg);
436         ir_type   *type    = get_entity_type(entity);
437         bool       changed = false;
438         size_t     i;
439         size_t     n;
440
441         config        = nconfig;
442         lowered_nodes = NEW_ARR_F(ir_node*, 0);
443         check_later   = NEW_ARR_F(ir_node*, 0);
444         lowered_type  = NULL;
445
446         edges_assure(irg);
447
448         /* ensure no optimisation touches muxes anymore */
449         set_irg_state(irg, IR_GRAPH_STATE_KEEP_MUX | IR_GRAPH_STATE_BCONV_ALLOWED);
450
451         ir_reserve_resources(irg, IR_RESOURCE_IRN_LINK);
452
453         adjust_method_type(type);
454
455         irg_walk_graph(irg, firm_clear_link, NULL, NULL);
456         irg_walk_graph(irg, lower_mode_b_walker, NULL, &changed);
457
458         for (i = 0, n = ARR_LEN(check_later); i < n; ++i) {
459                 ir_node *node = check_later[i];
460                 irg_walk_core(node, lower_mode_b_walker, NULL, &changed);
461         }
462
463         for (i = 0, n = ARR_LEN(lowered_nodes); i < n; ++i) {
464                 ir_node *node = lowered_nodes[i];
465                 maybe_kill_node(node);
466         }
467         DEL_ARR_F(check_later);
468         DEL_ARR_F(lowered_nodes);
469
470         ir_free_resources(irg, IR_RESOURCE_IRN_LINK);
471
472         if (changed) {
473                 set_irg_outs_inconsistent(irg);
474         }
475 }