cleanup irouts
[libfirm] / ir / opt / convopt.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   conv node optimisation
23  * @author  Matthias Braun, Christoph Mallon
24  *
25  * Try to minimize the number of conv nodes by changing modes of operations.
26  * The typical example is the following structure:
27  *    (some node mode_Hs)
28  *            |                                       (some node_Hs)
29  *         Conv Is                                          |
30  *            |                                          Add Hs
31  *          Add Is            gets transformed to           |
32  *            |
33  *         Conv Hs
34  *
35  * TODO: * try to optimize cmp modes
36  *       * decide when it is useful to move the convs through phis
37  */
38 #include "config.h"
39
40 #include "iroptimize.h"
41
42 #include <assert.h>
43 #include <stdbool.h>
44 #include "debug.h"
45 #include "ircons.h"
46 #include "irgmod.h"
47 #include "irgopt.h"
48 #include "irnode_t.h"
49 #include "iropt_t.h"
50 #include "iredges_t.h"
51 #include "irgwalk.h"
52 #include "irprintf.h"
53 #include "irpass_t.h"
54 #include "tv.h"
55 #include "vrp.h"
56
57 DEBUG_ONLY(static firm_dbg_module_t *dbg;)
58
59 static inline int imin(int a, int b) { return a < b ? a : b; }
60
61 static bool is_optimizable_node(const ir_node *node, ir_mode *dest_mode)
62 {
63         switch (get_irn_opcode(node)) {
64         case iro_Add:
65         case iro_And:
66         case iro_Eor:
67         case iro_Minus:
68         case iro_Mul:
69         case iro_Not:
70         case iro_Or:
71         case iro_Phi:
72         case iro_Sub:
73                 return true;
74         case iro_Shl: {
75                 int modulo_shift = get_mode_modulo_shift(dest_mode);
76                 int old_shift    = get_mode_modulo_shift(get_irn_mode(node));
77                 /* bail out if modulo shift changes */
78                 if (modulo_shift != old_shift)
79                         return false;
80                 return true;
81         }
82
83         default:
84                 return false;
85         }
86 }
87
88 static ir_tarval* conv_const_tv(const ir_node* cnst, ir_mode* dest_mode)
89 {
90         return tarval_convert_to(get_Const_tarval(cnst), dest_mode);
91 }
92
93 static int is_downconv(ir_mode *src_mode, ir_mode *dest_mode)
94 {
95         return
96                 mode_is_int(src_mode) &&
97                 mode_is_int(dest_mode) &&
98                 get_mode_size_bits(dest_mode) <= get_mode_size_bits(src_mode);
99 }
100
101 static int get_conv_costs(const ir_node *node, ir_mode *dest_mode)
102 {
103         ir_mode *mode = get_irn_mode(node);
104         int arity;
105         int i;
106         int costs;
107
108         if (mode == dest_mode)
109                 return 0;
110
111         if (is_Const(node)) {
112                 return conv_const_tv(node, dest_mode) == tarval_bad ? 1 : 0;
113         }
114
115         if (is_Conv(node) &&
116                         is_downconv(mode, dest_mode) &&
117                         get_irn_mode(get_Conv_op(node)) == dest_mode) {
118                 return -1;
119         }
120
121         if (get_irn_n_edges(node) > 1) {
122                 DB((dbg, LEVEL_3, "multi outs at %+F\n", node));
123                 return 1;
124         }
125
126         if (ir_zero_when_converted(node, dest_mode)) {
127                 return -1;
128         }
129
130 #if 0 // TODO
131         /* Take the minimum of the conversion costs for Phi predecessors as only one
132          * branch is actually executed at a time */
133         if (is_Phi(node)) {
134                 int i;
135                 int arity = get_Phi_n_preds(node);
136                 int costs;
137
138                 costs = get_conv_costs(get_Phi_pred(node, 0), dest_mode);
139                 for (i = 1; i < arity; ++i) {
140                         ir_node *pred = get_Phi_pred(node, i);
141                         int c = get_conv_costs(pred, dest_mode);
142                         if (c < costs) costs = c;
143                 }
144
145                 return costs;
146         }
147 #endif
148
149         if (!is_downconv(mode, dest_mode)) {
150                 return 1;
151         }
152
153         if (is_Conv(node)) {
154                 ir_node *pred      = get_Conv_op(node);
155                 ir_mode *pred_mode = get_irn_mode(pred);
156
157                 if (smaller_mode(pred_mode, dest_mode)) {
158                         return get_conv_costs(get_Conv_op(node), dest_mode) - 1;
159                 }
160                 if (may_leave_out_middle_conv(pred_mode, mode, dest_mode)) {
161                         return 0;
162                 } else {
163                         return 1;
164                 }
165         }
166
167         if (!is_optimizable_node(node, dest_mode)) {
168                 return 1;
169         }
170
171         costs = 0;
172         // The shift count does not participate in the conv optimisation
173         arity = is_Shl(node) ? 1 : get_irn_arity(node);
174         for (i = 0; i < arity; ++i) {
175                 ir_node *pred = get_irn_n(node, i);
176                 costs += imin(get_conv_costs(pred, dest_mode), 1);
177         }
178
179         return costs;
180 }
181
182 static ir_node *place_conv(ir_node *node, ir_mode *dest_mode)
183 {
184         ir_node *block = get_nodes_block(node);
185         ir_node *conv = new_r_Conv(block, node, dest_mode);
186         return conv;
187 }
188
189 static ir_node *conv_transform(ir_node *node, ir_mode *dest_mode)
190 {
191         ir_mode  *mode = get_irn_mode(node);
192         ir_graph *irg  = get_irn_irg(node);
193         int       arity;
194         int       conv_arity;
195         int       i;
196         ir_node  *new_node;
197         ir_node **ins;
198
199         if (mode == dest_mode)
200                 return node;
201
202         if (is_Const(node)) {
203                 ir_tarval *tv = conv_const_tv(node, dest_mode);
204                 if (tv == tarval_bad) {
205                         return place_conv(node, dest_mode);
206                 } else {
207                         return new_r_Const(irg, tv);
208                 }
209         }
210
211         if (is_Conv(node) &&
212                         is_downconv(mode, dest_mode) &&
213                         get_irn_mode(get_Conv_op(node)) == dest_mode) {
214                 return get_Conv_op(node);
215         }
216
217         if (get_irn_n_edges(node) > 1) {
218                 return place_conv(node, dest_mode);
219         }
220
221         if (!is_downconv(mode, dest_mode)) {
222                 return place_conv(node, dest_mode);
223         }
224
225         if (is_Conv(node)) {
226                 ir_node *pred      = get_Conv_op(node);
227                 ir_mode *pred_mode = get_irn_mode(pred);
228
229                 if (smaller_mode(pred_mode, dest_mode)) {
230                         return conv_transform(get_Conv_op(node), dest_mode);
231                 }
232                 return place_conv(node, dest_mode);
233         }
234
235         if (!is_optimizable_node(node, dest_mode)) {
236                 return place_conv(node, dest_mode);
237         }
238
239         // We want to create a new node with the right mode
240         arity = get_irn_arity(node);
241         ins = ALLOCAN(ir_node *, arity);
242
243         // The shift count does not participate in the conv optimisation
244         conv_arity = is_Shl(node) ? 1 : arity;
245         for (i = 0; i < conv_arity; i++) {
246                 ir_node *pred = get_irn_n(node, i);
247                 ir_node *transformed;
248                 if (get_conv_costs(pred, dest_mode) > 0) {
249                         transformed = place_conv(pred, dest_mode);
250                 } else {
251                         transformed = conv_transform(pred, dest_mode);
252                 }
253                 ins[i] = transformed;
254         }
255
256         for (i = conv_arity; i < arity; i++) {
257                 ins[i] = get_irn_n(node, i);
258         }
259
260         new_node = new_ir_node(get_irn_dbg_info(node),
261                                 irg,
262                                 get_nodes_block(node),
263                                 get_irn_op(node),
264                                 dest_mode,
265                                 arity,
266                                 ins);
267         copy_node_attr(irg, node, new_node);
268
269         return new_node;
270 }
271
272 static void conv_opt_walker(ir_node *node, void *data)
273 {
274         ir_node *transformed;
275         ir_node *pred;
276         ir_mode *pred_mode;
277         ir_mode *mode;
278         int costs;
279         bool *changed = (bool*)data;
280
281         if (!is_Conv(node))
282                 return;
283
284         pred      = get_Conv_op(node);
285         mode      = get_irn_mode(node);
286         pred_mode = get_irn_mode(pred);
287
288         if (mode_is_reference(mode) || mode_is_reference(pred_mode))
289                 return;
290
291         if (!is_Phi(pred) && !is_downconv(pred_mode, mode))
292                 return;
293
294         /* - 1 for the initial conv */
295         costs = get_conv_costs(pred, mode) - 1;
296         DB((dbg, LEVEL_2, "Costs for %+F -> %+F: %d\n", node, pred, costs));
297         if (costs > 0)
298                 return;
299
300         transformed = conv_transform(pred, mode);
301         if (node != transformed) {
302                 exchange(node, transformed);
303                 *changed = true;
304         }
305 }
306
307 void conv_opt(ir_graph *irg)
308 {
309         bool global_changed = false;
310         bool changed;
311         FIRM_DBG_REGISTER(dbg, "firm.opt.conv");
312
313         assure_irg_properties(irg, IR_GRAPH_PROPERTY_CONSISTENT_OUT_EDGES);
314
315         DB((dbg, LEVEL_1, "===> Performing conversion optimization on %+F\n", irg));
316
317         do {
318                 changed = false;
319                 irg_walk_graph(irg, NULL, conv_opt_walker, &changed);
320                 local_optimize_graph(irg);
321                 global_changed |= changed;
322         } while (changed);
323
324         confirm_irg_properties(irg,
325                 global_changed ? IR_GRAPH_PROPERTIES_NONE : IR_GRAPH_PROPERTIES_ALL);
326 }
327
328 /* Creates an ir_graph pass for conv_opt. */
329 ir_graph_pass_t *conv_opt_pass(const char *name)
330 {
331         ir_graph_pass_t *path = def_graph_pass(name ? name : "conv_opt", conv_opt);
332
333         /* safe to run parallel on all irgs */
334         ir_graph_pass_set_parallel(path, 1);
335
336         return path;
337 }