6e985b94a2c9ba108597e6ed03ccc4a53c712df4
[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  * 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 wether ConvB(X) is a goode 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 "tv.h"
53 #include "error.h"
54 #include "lowering.h"
55 #include "pdeq.h"
56 #include "irpass_t.h"
57
58 static lower_mode_b_config_t  config;
59 static ir_type               *lowered_type  = NULL;
60 static pdeq                  *lowered_nodes = NULL;
61
62 /**
63  * Removes a node if its out-edge count has reached 0.
64  * temporary hack until we have proper automatic dead code elimination.
65  */
66 static void maybe_kill_node(ir_node *node)
67 {
68         ir_graph *irg;
69         int       i, arity;
70
71         if (get_irn_n_edges(node) != 0)
72                 return;
73
74         irg = get_irn_irg(node);
75
76         assert(!is_Bad(node));
77
78         arity = get_irn_arity(node);
79         for (i = 0; i < arity; ++i) {
80                 set_irn_n(node, i, new_Bad());
81         }
82         set_nodes_block(node, new_Bad());
83
84         edges_node_deleted(node, irg);
85 }
86
87 static ir_node *create_not(dbg_info *dbgi, ir_node *node)
88 {
89         ir_node  *block  = get_nodes_block(node);
90         ir_mode  *mode   = config.lowered_mode;
91         tarval   *tv_one = get_tarval_one(mode);
92         ir_node  *one    = new_d_Const(dbgi, tv_one);
93
94         return new_rd_Eor(dbgi, block, node, one, mode);
95 }
96
97 static ir_node *create_convb(ir_node *node)
98 {
99         ir_node  *block = get_nodes_block(node);
100         ir_node  *conv  = new_rd_Conv(NULL, block, node, mode_b);
101
102         return conv;
103 }
104
105 static ir_type *create_lowered_type(void)
106 {
107         if (lowered_type == NULL) {
108                 lowered_type = new_type_primitive(config.lowered_mode);
109         }
110         return lowered_type;
111 }
112
113 /**
114  * creates a "set" node that produces a 0 or 1 based on a Cmp result
115  */
116 static ir_node *create_set(ir_node *node)
117 {
118         dbg_info *dbgi    = get_irn_dbg_info(node);
119         ir_mode  *mode    = config.lowered_set_mode;
120         tarval   *tv_one  = get_tarval_one(mode);
121         ir_node  *one     = new_d_Const(dbgi, tv_one);
122         ir_node  *block   = get_nodes_block(node);
123         tarval   *tv_zero = get_tarval_null(mode);
124         ir_node  *zero    = new_d_Const(dbgi, tv_zero);
125
126         ir_node *set      = new_rd_Mux(dbgi, block, node, zero, one, mode);
127
128         if (mode != config.lowered_mode) {
129                 set = new_r_Conv(block, set, config.lowered_mode);
130         }
131
132         return set;
133 }
134
135 static void adjust_method_type(ir_type *method_type)
136 {
137         int i;
138         int n_params;
139         int n_res;
140
141         n_params = get_method_n_params(method_type);
142         for (i = 0; i < n_params; ++i) {
143                 ir_type *param = get_method_param_type(method_type, i);
144                 if (get_type_mode(param) == mode_b) {
145                         set_method_param_type(method_type, i, create_lowered_type());
146                 }
147         }
148
149         n_res = get_method_n_ress(method_type);
150         for (i = 0; i < n_res; ++i) {
151                 ir_type *res_type = get_method_res_type(method_type, i);
152                 if (get_type_mode(res_type) == mode_b) {
153                         set_method_res_type(method_type, i, create_lowered_type());
154                 }
155         }
156 }
157
158 static ir_node *lower_node(ir_node *node)
159 {
160         dbg_info *dbgi  = get_irn_dbg_info(node);
161         ir_node  *block = get_nodes_block(node);
162         ir_mode  *mode  = config.lowered_mode;
163         ir_node  *res;
164
165         res = get_irn_link(node);
166         if (res != NULL)
167                 return res;
168
169         assert(get_irn_mode(node) == mode_b);
170
171         switch (get_irn_opcode(node)) {
172         case iro_Phi: {
173                 int       i, arity;
174                 ir_node **in;
175                 ir_node  *unknown, *new_phi;
176
177                 arity   = get_irn_arity(node);
178                 in      = ALLOCAN(ir_node*, arity);
179                 unknown = new_Unknown(mode);
180                 for (i = 0; i < arity; ++i) {
181                         in[i] = unknown;
182                 }
183                 new_phi = new_r_Phi(block, arity, in, mode);
184                 /* FIXME This does not correctly break cycles: The Phi might not be the
185                  * first in the recursion, so the caller(s) are some yet un-lowered nodes
186                  * and this Phi might have them (indirectly) as operands, so they would be
187                  * replaced twice. */
188                 set_irn_link(node, new_phi);
189                 pdeq_putr(lowered_nodes, node);
190
191                 for (i = 0; i < arity; ++i) {
192                         ir_node *in     = get_irn_n(node, i);
193                         ir_node *low_in = lower_node(in);
194
195                         set_irn_n(new_phi, i, low_in);
196                 }
197
198                 return new_phi;
199         }
200
201         case iro_And:
202         case iro_Or:
203         case iro_Eor: {
204                 int i, arity;
205
206                 res   = exact_copy(node);
207                 arity = get_irn_arity(node);
208                 for (i = 0; i < arity; ++i) {
209                         ir_node *in     = get_irn_n(node, i);
210                         ir_node *low_in = lower_node(in);
211
212                         set_irn_n(res, i, low_in);
213                 }
214                 set_irn_mode(res, mode);
215                 break;
216         }
217
218         case iro_Not: {
219                 ir_node *op     = get_Not_op(node);
220                 ir_node *low_op = lower_node(op);
221
222                 res = create_not(dbgi, low_op);
223                 break;
224         }
225
226         case iro_Mux: {
227                 ir_node *cond        = get_Mux_sel(node);
228                 ir_node *low_cond    = lower_node(cond);
229                 ir_node *v_true      = get_Mux_true(node);
230                 ir_node *low_v_true  = lower_node(v_true);
231                 ir_node *v_false     = get_Mux_false(node);
232                 ir_node *low_v_false = lower_node(v_false);
233
234                 ir_node *and0     = new_rd_And(dbgi, block, low_cond, low_v_true, mode);
235                 ir_node *not_cond = create_not(dbgi, low_cond);
236                 ir_node *and1     = new_rd_And(dbgi, block, not_cond, low_v_false, mode);
237                 res = new_rd_Or(dbgi, block, and0, and1, mode);
238                 break;
239         }
240
241         case iro_Conv: {
242                 ir_node *pred     = get_Conv_op(node);
243                 ir_mode *mode     = get_irn_mode(pred);
244                 tarval  *tv_zeroc = get_tarval_null(mode);
245                 ir_node *zero_cmp = new_d_Const(dbgi, tv_zeroc);
246
247                 ir_node *cmp      = new_rd_Cmp(dbgi, block, pred, zero_cmp);
248                 ir_node *proj     = new_rd_Proj(dbgi, block, cmp, mode_b, pn_Cmp_Lg);
249                 res = create_set(proj);
250                 break;
251         }
252
253         case iro_Proj: {
254                 ir_node *pred = get_Proj_pred(node);
255
256                 if (is_Cmp(pred)) {
257                         ir_node *left  = get_Cmp_left(pred);
258                         ir_node *right = get_Cmp_right(pred);
259                         ir_mode *cmp_mode  = get_irn_mode(left);
260
261                         if ((mode_is_int(cmp_mode) || mode_is_reference(cmp_mode)) && (
262                                                 get_mode_size_bits(cmp_mode) < get_mode_size_bits(mode) ||
263                                                 (mode_is_signed(cmp_mode) && is_Const(right) && is_Const_null(right))
264                                         )) {
265                                 int      pnc      = get_Proj_proj(node);
266                                 int      need_not = 0;
267                                 ir_node *a        = NULL;
268                                 ir_node *b        = NULL;
269
270                                 if (pnc == pn_Cmp_Lt) {
271                                         /* a < b  ->  (a - b) >> 31 */
272                                         a = left;
273                                         b = right;
274                                 } else if (pnc == pn_Cmp_Le) {
275                                         /* a <= b  -> ~(a - b) >> 31 */
276                                         a        = right;
277                                         b        = left;
278                                         need_not = 1;
279                                 } else if (pnc == pn_Cmp_Gt) {
280                                         /* a > b   -> (b - a) >> 31 */
281                                         a = right;
282                                         b = left;
283                                 } else if (pnc == pn_Cmp_Ge) {
284                                         /* a >= b   -> ~(a - b) >> 31 */
285                                         a        = left;
286                                         b        = right;
287                                         need_not = 1;
288                                 } else {
289                                         goto synth_zero_one;
290                                 }
291
292                                 int      bits      = get_mode_size_bits(mode);
293                                 tarval  *tv        = new_tarval_from_long(bits-1, mode_Iu);
294                                 ir_node *shift_cnt = new_d_Const(dbgi, tv);
295
296                                 if (cmp_mode != mode) {
297                                         a = new_rd_Conv(dbgi, block, a, mode);
298                                         b = new_rd_Conv(dbgi, block, b, mode);
299                                 }
300
301                                 res = new_rd_Sub(dbgi, block, a, b, mode);
302                                 if (need_not) {
303                                         res = new_rd_Not(dbgi, block, res, mode);
304                                 }
305                                 res = new_rd_Shr(dbgi, block, res, shift_cnt, mode);
306                         } else {
307                                 /* synthesize the 0/1 value */
308 synth_zero_one:
309                                 res = create_set(node);
310                         }
311                 } else if (is_Proj(pred) && is_Call(get_Proj_pred(pred))) {
312                         ir_type   *type   = get_Call_type(get_Proj_pred(pred));
313                         adjust_method_type(type);
314                         set_irn_mode(node, mode);
315                         res = node;
316                         goto own_replacement;
317                 } else if (is_Proj(pred) && is_Start(get_Proj_pred(pred))) {
318                         ir_entity *entity = get_irg_entity(current_ir_graph);
319                         ir_type   *type   = get_entity_type(entity);
320                         adjust_method_type(type);
321                         set_irn_mode(node, mode);
322                         res = node;
323                         goto own_replacement;
324                 } else {
325                         panic("unexpected projb: %+F (pred: %+F)", node, pred);
326                 }
327                 break;
328         }
329
330         case iro_Const: {
331                 tarval *tv = get_Const_tarval(node);
332                 if (tv == get_tarval_b_true()) {
333                         tarval  *tv_one  = get_tarval_one(mode);
334                         res              = new_d_Const(dbgi, tv_one);
335                 } else if (tv == get_tarval_b_false()) {
336                         tarval  *tv_zero = get_tarval_null(mode);
337                         res              = new_d_Const(dbgi, tv_zero);
338                 } else {
339                         panic("invalid boolean const %+F", node);
340                 }
341                 break;
342         }
343
344         case iro_Unknown:
345                 res = new_Unknown(mode);
346                 break;
347
348         default:
349                 panic("didn't expect %+F to have mode_b", node);
350         }
351
352         pdeq_putr(lowered_nodes, node);
353 own_replacement:
354         set_irn_link(node, res);
355         return res;
356 }
357
358 static void lower_mode_b_walker(ir_node *node, void *env)
359 {
360         int i, arity;
361         bool changed = 0;
362         (void) env;
363
364         arity = get_irn_arity(node);
365         for (i = 0; i < arity; ++i) {
366                 ir_node *lowered_in;
367                 ir_node *in = get_irn_n(node, i);
368                 if (get_irn_mode(in) != mode_b)
369                         continue;
370
371                 if (! config.lower_direct_cmp) {
372                         /* Proj(Cmp) as input for Cond and Mux nodes needs no changes.
373                            (Mux with mode_b is an exception as it gets replaced by and/or
374                             anyway so we still lower the inputs then) */
375                         if (is_Cond(node) ||
376                             (is_Mux(node) && get_irn_mode(node) != mode_b)) {
377                                 if (is_Proj(in)) {
378                                         ir_node *pred = get_Proj_pred(in);
379                                         if (is_Cmp(pred))
380                                                 continue;
381                                 }
382                         }
383                 }
384
385                 lowered_in = lower_node(in);
386
387                 if (is_Call(node)) {
388                         ir_type *type = get_Call_type(node);
389                         adjust_method_type(type);
390                 } else if (is_Cond(node) || (is_Mux(node) && i == 0)) {
391                         lowered_in = create_convb(lowered_in);
392                 }
393                 set_irn_n(node, i, lowered_in);
394                 changed = true;
395         }
396         if (changed) {
397                 add_identities(current_ir_graph->value_table, node);
398         }
399 }
400
401 void ir_lower_mode_b(ir_graph *irg, const lower_mode_b_config_t *nconfig)
402 {
403         ir_entity *entity = get_irg_entity(irg);
404         ir_type   *type   = get_entity_type(entity);
405
406         config        = *nconfig;
407         lowered_nodes = new_pdeq();
408         lowered_type  = NULL;
409
410         /* ensure no optimisation touches muxes anymore */
411         set_irg_state(irg, IR_GRAPH_STATE_KEEP_MUX);
412
413         ir_reserve_resources(irg, IR_RESOURCE_IRN_LINK);
414
415         adjust_method_type(type);
416
417         set_opt_allow_conv_b(0);
418         irg_walk_graph(irg, firm_clear_link, NULL, NULL);
419         irg_walk_graph(irg, lower_mode_b_walker, NULL, NULL);
420
421         while(!pdeq_empty(lowered_nodes)) {
422                 ir_node *node = (ir_node*) pdeq_getr(lowered_nodes);
423                 maybe_kill_node(node);
424         }
425         del_pdeq(lowered_nodes);
426
427         ir_free_resources(irg, IR_RESOURCE_IRN_LINK);
428 }
429
430 struct pass_t {
431         ir_graph_pass_t             pass;
432         const lower_mode_b_config_t *config;
433 };
434
435 /**
436  * Wrapper to run ir_lower_mode_b() as an ir_graph pass
437  */
438 static int pass_wrapper(ir_graph *irg, void *context)
439 {
440         struct pass_t *pass = context;
441
442         ir_lower_mode_b(irg, pass->config);
443         return 0;
444 }
445
446 ir_graph_pass_t *ir_lower_mode_b_pass(
447         const char *name, const lower_mode_b_config_t *config)
448 {
449         struct pass_t *pass = XMALLOCZ(struct pass_t);
450
451         pass->config = config;
452         return def_graph_pass_constructor(
453                 &pass->pass, name ? name : "lower_mode_b", pass_wrapper);
454 }