verify: Clarify assertion message.
[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_Minus:
65         case iro_Phi:
66         case iro_And:
67         case iro_Eor:
68         case iro_Or:
69         case iro_Not:
70                 return true;
71         case iro_Add:
72         case iro_Mul:
73         case iro_Sub:
74                 if (mode_is_float(get_irn_mode(node)))
75                         return false;
76                 return true;
77         case iro_Shl: {
78                 int modulo_shift = get_mode_modulo_shift(dest_mode);
79                 int old_shift    = get_mode_modulo_shift(get_irn_mode(node));
80                 /* bail out if modulo shift changes */
81                 if (modulo_shift != old_shift)
82                         return false;
83                 return true;
84         }
85
86         default:
87                 return false;
88         }
89 }
90
91 static ir_tarval* conv_const_tv(const ir_node* cnst, ir_mode* dest_mode)
92 {
93         return tarval_convert_to(get_Const_tarval(cnst), dest_mode);
94 }
95
96 static bool is_downconv(ir_mode *src_mode, ir_mode *dest_mode)
97 {
98         return ((mode_is_int(src_mode) && mode_is_int(dest_mode))
99                 || (mode_is_float(src_mode) && mode_is_float(dest_mode)))
100                 && get_mode_size_bits(dest_mode) <= get_mode_size_bits(src_mode);
101 }
102
103 static int get_conv_costs(const ir_node *node, ir_mode *dest_mode)
104 {
105         ir_mode *mode = get_irn_mode(node);
106         int arity;
107         int i;
108         int costs;
109
110         if (mode == dest_mode)
111                 return 0;
112
113         if (is_Const(node)) {
114                 return conv_const_tv(node, dest_mode) == tarval_bad ? 1 : 0;
115         }
116
117         if (is_Conv(node) &&
118                         is_downconv(mode, dest_mode) &&
119                         get_irn_mode(get_Conv_op(node)) == dest_mode) {
120                 return -1;
121         }
122
123         if (get_irn_n_edges(node) > 1) {
124                 DB((dbg, LEVEL_3, "multi outs at %+F\n", node));
125                 return 1;
126         }
127
128         if (ir_zero_when_converted(node, dest_mode)) {
129                 return -1;
130         }
131
132         /* TODO: Phi nodes */
133
134         if (!is_downconv(mode, dest_mode)) {
135                 return 1;
136         }
137
138         if (is_Conv(node)) {
139                 ir_node *pred      = get_Conv_op(node);
140                 ir_mode *pred_mode = get_irn_mode(pred);
141
142                 if (smaller_mode(pred_mode, dest_mode)) {
143                         return get_conv_costs(get_Conv_op(node), dest_mode) - 1;
144                 }
145                 if (may_leave_out_middle_conv(pred_mode, mode, dest_mode)) {
146                         return 0;
147                 } else {
148                         return 1;
149                 }
150         }
151
152         if (!is_optimizable_node(node, dest_mode)) {
153                 return 1;
154         }
155
156         costs = 0;
157         // The shift count does not participate in the conv optimisation
158         arity = is_Shl(node) ? 1 : get_irn_arity(node);
159         for (i = 0; i < arity; ++i) {
160                 ir_node *pred = get_irn_n(node, i);
161                 costs += imin(get_conv_costs(pred, dest_mode), 1);
162         }
163
164         return costs;
165 }
166
167 static ir_node *place_conv(ir_node *node, ir_mode *dest_mode)
168 {
169         ir_node *block = get_nodes_block(node);
170         ir_node *conv = new_r_Conv(block, node, dest_mode);
171         return conv;
172 }
173
174 static ir_node *conv_transform(ir_node *node, ir_mode *dest_mode)
175 {
176         ir_mode  *mode = get_irn_mode(node);
177         ir_graph *irg  = get_irn_irg(node);
178         int       arity;
179         int       conv_arity;
180         int       i;
181         ir_node  *new_node;
182         ir_node **ins;
183
184         if (mode == dest_mode)
185                 return node;
186
187         if (is_Const(node)) {
188                 ir_tarval *tv = conv_const_tv(node, dest_mode);
189                 if (tv == tarval_bad) {
190                         return place_conv(node, dest_mode);
191                 } else {
192                         return new_r_Const(irg, tv);
193                 }
194         }
195
196         if (is_Conv(node) &&
197                         is_downconv(mode, dest_mode) &&
198                         get_irn_mode(get_Conv_op(node)) == dest_mode) {
199                 return get_Conv_op(node);
200         }
201
202         if (get_irn_n_edges(node) > 1) {
203                 return place_conv(node, dest_mode);
204         }
205
206         if (!is_downconv(mode, dest_mode)) {
207                 return place_conv(node, dest_mode);
208         }
209
210         if (is_Conv(node)) {
211                 ir_node *pred      = get_Conv_op(node);
212                 ir_mode *pred_mode = get_irn_mode(pred);
213
214                 if (smaller_mode(pred_mode, dest_mode)) {
215                         return conv_transform(get_Conv_op(node), dest_mode);
216                 }
217                 return place_conv(node, dest_mode);
218         }
219
220         if (!is_optimizable_node(node, dest_mode)) {
221                 return place_conv(node, dest_mode);
222         }
223
224         // We want to create a new node with the right mode
225         arity = get_irn_arity(node);
226         ins = ALLOCAN(ir_node *, arity);
227
228         // The shift count does not participate in the conv optimisation
229         conv_arity = is_Shl(node) ? 1 : arity;
230         for (i = 0; i < conv_arity; i++) {
231                 ir_node *pred = get_irn_n(node, i);
232                 ir_node *transformed;
233                 if (get_conv_costs(pred, dest_mode) > 0) {
234                         transformed = place_conv(pred, dest_mode);
235                 } else {
236                         transformed = conv_transform(pred, dest_mode);
237                 }
238                 ins[i] = transformed;
239         }
240
241         for (i = conv_arity; i < arity; i++) {
242                 ins[i] = get_irn_n(node, i);
243         }
244
245         new_node = new_ir_node(get_irn_dbg_info(node),
246                                 irg,
247                                 get_nodes_block(node),
248                                 get_irn_op(node),
249                                 dest_mode,
250                                 arity,
251                                 ins);
252         copy_node_attr(irg, node, new_node);
253
254         return new_node;
255 }
256
257 static void conv_opt_walker(ir_node *node, void *data)
258 {
259         ir_node *transformed;
260         ir_node *pred;
261         ir_mode *pred_mode;
262         ir_mode *mode;
263         int costs;
264         bool *changed = (bool*)data;
265
266         if (!is_Conv(node))
267                 return;
268
269         pred      = get_Conv_op(node);
270         mode      = get_irn_mode(node);
271         pred_mode = get_irn_mode(pred);
272
273         if (mode_is_reference(mode) || mode_is_reference(pred_mode))
274                 return;
275
276         if (!is_Phi(pred) && !is_downconv(pred_mode, mode))
277                 return;
278
279         /* - 1 for the initial conv */
280         costs = get_conv_costs(pred, mode) - 1;
281         DB((dbg, LEVEL_2, "Costs for %+F -> %+F: %d\n", node, pred, costs));
282         if (costs > 0)
283                 return;
284
285         transformed = conv_transform(pred, mode);
286         if (node != transformed) {
287                 exchange(node, transformed);
288                 *changed = true;
289         }
290 }
291
292 void conv_opt(ir_graph *irg)
293 {
294         bool global_changed = false;
295         bool changed;
296         FIRM_DBG_REGISTER(dbg, "firm.opt.conv");
297
298         assure_irg_properties(irg, IR_GRAPH_PROPERTY_CONSISTENT_OUT_EDGES);
299
300         DB((dbg, LEVEL_1, "===> Performing conversion optimization on %+F\n", irg));
301
302         do {
303                 changed = false;
304                 irg_walk_graph(irg, NULL, conv_opt_walker, &changed);
305                 local_optimize_graph(irg);
306                 global_changed |= changed;
307         } while (changed);
308
309         confirm_irg_properties(irg,
310                 global_changed ? IR_GRAPH_PROPERTIES_NONE : IR_GRAPH_PROPERTIES_ALL);
311 }
312
313 /* Creates an ir_graph pass for conv_opt. */
314 ir_graph_pass_t *conv_opt_pass(const char *name)
315 {
316         ir_graph_pass_t *path = def_graph_pass(name ? name : "conv_opt", conv_opt);
317
318         /* safe to run parallel on all irgs */
319         ir_graph_pass_set_parallel(path, 1);
320
321         return path;
322 }