remove #if 1
[libfirm] / ir / opt / tropt.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   Perform optimizations of the type representation.
23  * @date    20.4.2005
24  * @author  Goetz Lindenmaier
25  */
26 #include "config.h"
27
28 #include <assert.h>
29
30 #include "iroptimize.h"
31 #include "irprog.h"
32 #include "irtypeinfo.h"
33 #include "irgwalk.h"
34 #include "trouts.h"
35 #include "ircons.h"
36 #include "irgmod.h"
37 #include "irflag_t.h"
38 #include "xmalloc.h"
39 #include "debug.h"
40 #include "opt_init.h"
41
42 DEBUG_ONLY(static firm_dbg_module_t *dbg;)
43
44 /* - statistics ---------------------------------------------- */
45
46 static size_t n_casts_normalized = 0;
47 static size_t n_casts_removed    = 0;
48 static size_t n_sels_concretized = 0;
49
50 /* - Cast normalization. ------------------------------------- */
51
52 static ir_type *default_gen_pointer_type_to(ir_type *tp);
53
54 #define PTR_TYPE_SUFFIX "cc_ptr_tp"  /* class cast pointer type. */
55 static ident *ptr_type_suffix = NULL;
56 static gen_pointer_type_to_func gen_pointer_type_to = default_gen_pointer_type_to;
57
58 /**
59  * Find a pointer type to a given type.
60  * Uses and updates trouts if available.
61  */
62 static ir_type *default_gen_pointer_type_to(ir_type *tp)
63 {
64         ir_type *res = find_pointer_type_to_type(tp);
65         if (is_unknown_type(res))
66                 res = new_type_pointer(tp);
67
68         return res;
69 }
70
71 /** Return a type that is a depth times pointer to type. */
72 static ir_type *pointerize_type(ir_type *tp, size_t depth)
73 {
74         for (; depth > 0; --depth) {
75                 tp = gen_pointer_type_to(tp);
76         }
77         return tp;
78 }
79
80
81 static ir_node *normalize_values_type(ir_type *totype, ir_node *pred)
82 {
83         ir_type *fromtype = get_irn_typeinfo_type(pred);
84         ir_node *new_cast = pred;
85         ir_node *block;
86         size_t  ref_depth = 0;
87
88         if (totype == fromtype) return pred;   /* Case for optimization! */
89
90         while (is_Pointer_type(totype) && is_Pointer_type(fromtype)) {
91                 totype   = get_pointer_points_to_type(totype);
92                 fromtype = get_pointer_points_to_type(fromtype);
93                 ++ref_depth;
94         }
95
96         if (!is_Class_type(totype))   return pred;
97         if (!is_Class_type(fromtype)) return pred;
98
99         if ((get_class_supertype_index(totype, fromtype) != (size_t)-1) ||
100                 (get_class_supertype_index(fromtype, totype) != (size_t)-1) ) {
101                         /* It's just what we want ... */
102                         return pred;
103         }
104
105         block = get_nodes_block(pred);
106
107         if (is_SubClass_of(totype, fromtype)) {
108                 /* downcast */
109                 while (get_class_subtype_index(fromtype, totype) == (size_t)-1) {
110                         /* Insert a cast to a subtype of fromtype. */
111                         ir_type *new_type = NULL;
112                         ir_node *new_cast;
113                         size_t   i;
114                         size_t   n_subtypes = get_class_n_subtypes(fromtype);
115                         for (i = 0; i < n_subtypes && !new_type; ++i) {
116                                 ir_type *new_sub = get_class_subtype(fromtype, i);
117                                 if (is_SuperClass_of(new_sub, totype))
118                                         new_type = new_sub;
119                         }
120                         assert(new_type);
121                         fromtype = new_type;
122                         new_type = pointerize_type(new_type, ref_depth);
123                         new_cast = new_r_Cast(block, pred, new_type);
124                         pred = new_cast;
125                         ++n_casts_normalized;
126                         set_irn_typeinfo_type(new_cast, new_type);  /* keep type information up to date. */
127                 }
128         } else {
129                 assert(is_SuperClass_of(totype, fromtype));
130                 /* upcast */
131                 while (get_class_supertype_index(fromtype, totype) == (size_t)-1) {
132                         /* Insert a cast to a supertype of fromtype. */
133                         ir_type *new_type = NULL;
134                         size_t i, n_supertypes = get_class_n_supertypes(fromtype);
135                         for (i = 0; i < n_supertypes && !new_type; ++i) {
136                                 ir_type *new_super = get_class_supertype(fromtype, i);
137                                 if (is_SubClass_of(new_super, totype))
138                                         new_type = new_super;
139                         }
140                         assert(new_type);
141                         fromtype = new_type;
142                         new_type = pointerize_type(new_type, ref_depth);
143                         new_cast = new_r_Cast(block, pred, new_type);
144                         pred = new_cast;
145                         ++n_casts_normalized;
146                         set_irn_typeinfo_type(new_cast, new_type);  /* keep type information up to date. */
147                 }
148         }
149         return new_cast;
150 }
151
152 /**
153  * Post-Walker.
154  */
155 static void normalize_irn_class_cast(ir_node *n, void *env)
156 {
157         ir_node *res;
158         (void) env;
159         if (is_Cast(n)) {
160                 ir_node *pred   = get_Cast_op(n);
161                 ir_type *totype = get_Cast_type(n);
162                 res = normalize_values_type(totype, pred);
163                 set_Cast_op(n, res);
164         } else if (is_Call(n)) {
165                 size_t n_params = get_Call_n_params(n);
166                 size_t i;
167                 ir_type *tp = get_Call_type(n);
168                 for (i = 0; i < n_params; ++i) {
169                         res = normalize_values_type(get_method_param_type(tp, i), get_Call_param(n, i));
170                         set_Call_param(n, i, res);
171                 }
172         }
173 }
174
175
176 static void pure_normalize_irg_class_casts(ir_graph *irg)
177 {
178         assert(get_irg_class_cast_state(irg) != ir_class_casts_any &&
179                "Cannot normalize irregular casts.");
180         if (get_irg_class_cast_state(irg) == ir_class_casts_normalized) {
181                 return;
182         }
183
184         irg_walk_graph(irg, NULL, normalize_irn_class_cast, NULL);
185         set_irg_class_cast_state(irg, ir_class_casts_normalized);
186 }
187
188
189 void normalize_irg_class_casts(ir_graph *irg, gen_pointer_type_to_func gppt_fct)
190 {
191         assert(get_irp_typeinfo_state() == ir_typeinfo_consistent);
192
193         if (gppt_fct) gen_pointer_type_to = gppt_fct;
194
195         if (!ptr_type_suffix)
196                 ptr_type_suffix = new_id_from_str(PTR_TYPE_SUFFIX);
197
198         pure_normalize_irg_class_casts(irg);
199
200         gen_pointer_type_to = default_gen_pointer_type_to;
201 }
202
203 void normalize_irp_class_casts(gen_pointer_type_to_func gppt_fct)
204 {
205         size_t i, n;
206         if (gppt_fct) gen_pointer_type_to = gppt_fct;
207
208         for (i = 0, n = get_irp_n_irgs(); i < n; ++i) {
209                 ir_graph *irg = get_irp_irg(i);
210                 pure_normalize_irg_class_casts(irg);
211         }
212
213         set_irp_class_cast_state(ir_class_casts_normalized);
214         gen_pointer_type_to = default_gen_pointer_type_to;
215
216         DB((dbg, SET_LEVEL_1, " Cast normalization: %zu Casts inserted.\n", n_casts_normalized));
217 }
218
219
220
221 /* - Cast optimization. ------------------------------------------- */
222
223 /**
224  * Optimizes Casts:
225  *
226  *  (T1)(T2)x<T1> -> x<T1>
227  *
228  *  (T3)(T2)x<T1> -> (T3)x<T1>
229  *
230  * if possible.
231  *
232  * @param cast  the Cast node
233  *
234  * @return 1 if the cast was changed
235  */
236 static int cancel_out_casts(ir_node *cast)
237 {
238         ir_node *orig, *pred = get_Cast_op(cast);
239         ir_type *tp_cast, *tp_pred, *tp_orig;
240
241         if (!is_Cast(pred)) return 0;
242         orig = get_Cast_op(pred);
243
244         tp_cast = get_Cast_type(cast);
245         tp_pred = get_Cast_type(pred);
246         tp_orig = get_irn_typeinfo_type(orig);
247
248         while (is_Pointer_type(tp_cast) &&
249               is_Pointer_type(tp_pred) &&
250               is_Pointer_type(tp_orig)   ) {
251                 tp_cast = get_pointer_points_to_type(tp_cast);
252                 tp_pred = get_pointer_points_to_type(tp_pred);
253                 tp_orig = get_pointer_points_to_type(tp_orig);
254         }
255
256         if (!is_Class_type(tp_cast) || !is_Class_type(tp_pred) || !is_Class_type(tp_orig))
257                 return 0;
258
259         if (is_SubClass_of(tp_pred, tp_cast) && get_opt_suppress_downcast_optimization())
260                 return 0;
261
262         if (tp_cast == tp_orig) {
263                 exchange(cast, orig);
264                 n_casts_removed += 2;
265                 return 1;
266         }
267
268         if (!(is_SubClass_of  (tp_cast, tp_orig) || is_SubClass_of  (tp_orig, tp_cast))) {
269                 /* Avoid (B2)(A)(new B1()) --> (B2)(new B1())
270                 * if B1 =!> B2  and  B2 =!> B1
271                 */
272                 return 0;
273         }
274
275         if ((is_SubClass_of  (tp_cast, tp_pred) && is_SuperClass_of(tp_pred, tp_orig)) ||
276             (is_SuperClass_of(tp_cast, tp_pred) && is_SubClass_of  (tp_pred, tp_orig))) {
277                 /* Cast --> Pred --> Orig */
278                 set_Cast_op(cast, orig);
279                 ++n_casts_removed;
280                 return 1;
281         }
282         return 0;
283 }
284
285 /**
286  * Optimize Sel(Cast(type, ptr), ent) into Sel(ptr_type, ent_type)
287  *
288  * @param sel  the Sel node
289  *
290  * @return 1 if Cast's where removed
291  */
292 static int concretize_selected_entity(ir_node *sel)
293 {
294         int res = 0;
295
296         ir_entity *sel_ent = get_Sel_entity(sel);
297         ir_node   *cast    = get_Sel_ptr(sel);
298         while (is_Cast(cast)) {
299                 ir_type *cast_tp = get_Cast_type(cast);
300                 ir_node *ptr     = get_Cast_op(cast);
301                 ir_type *orig_tp = get_irn_typeinfo_type(ptr);
302
303                 /* we handle only classes */
304                 if (!is_Pointer_type(orig_tp)|| !is_Pointer_type(cast_tp))
305                         return res;
306                 orig_tp = get_pointer_points_to_type(orig_tp);
307                 cast_tp = get_pointer_points_to_type(cast_tp);
308                 if (!is_Class_type(orig_tp) || !is_Class_type(cast_tp))
309                         return res;
310
311                 /* We only want to concretize, but not generalize. */
312                 if (!is_SuperClass_of(cast_tp, orig_tp))
313                         return res;
314
315                 /* The sel entity should be a member of the cast_tp, else
316                    the graph was not properly typed. */
317                 if (get_class_member_index(cast_tp, sel_ent) == (size_t)-1)
318                         return res;
319
320                 ir_entity *new_ent = resolve_ent_polymorphy(orig_tp, sel_ent);
321
322                 /* New ent must be member of orig_tp. */
323                 if (get_class_member_index(orig_tp, new_ent) == (size_t)-1)
324                         return res;
325
326                 /* all checks done, we can remove the Cast and update the Sel */
327                 set_Sel_entity(sel, new_ent);
328                 set_Sel_ptr(sel, ptr);
329                 ++n_sels_concretized;
330
331                 sel_ent = new_ent;
332                 cast    = ptr;
333                 res     = 1;
334         }
335         return res;
336 }
337
338 /**
339  * Move Casts of the same type through a Phi node, i.e.
340  * Phi(Cast(type, x_0), ..., Cast(type, x_n)) -> Cast(type, Phi(x_0, ..., x_n))
341  *
342  * @param phi  the Phi node
343  *
344  * @return 1 if Cast's where moved
345  */
346 static int concretize_Phi_type(ir_node *phi)
347 {
348         int       n_preds = get_Phi_n_preds(phi);
349         ir_node **pred    = ALLOCAN(ir_node*, n_preds);
350         ir_node  *nn, *blk;
351         ir_type  *totype;
352         ir_type  *fromtype;
353         int       i;
354
355         if (n_preds == 0)
356                 return 0;
357         pred[0] = get_Phi_pred(phi, 0);
358
359         if (!is_Cast(pred[0]))
360                 return 0;
361
362         if (!is_Cast_upcast(pred[0]))
363                 return 0;
364
365         fromtype = get_irn_typeinfo_type(get_Cast_op(pred[0]));
366         totype   = get_Cast_type(pred[0]);
367
368         pred[0] = get_Cast_op(pred[0]);
369         for (i = 1; i < n_preds; ++i) {
370                 pred[i] = get_Phi_pred(phi, i);
371                 if (!is_Cast(pred[i]))
372                         return 0;
373                 if (get_irn_typeinfo_type(get_Cast_op(pred[i])) != fromtype)
374                         return 0;
375                 pred[i] = get_Cast_op(pred[i]);
376         }
377
378         /* Transform Phi */
379         blk = get_nodes_block(phi);
380         nn  = new_r_Phi(blk, n_preds, pred, get_irn_mode(phi));
381         set_irn_typeinfo_type(nn, fromtype);
382         nn  = new_r_Cast(blk, nn, totype);
383         set_irn_typeinfo_type(nn, totype);
384         exchange(phi, nn);
385         return 1;
386 }
387
388 /**
389  * Remove Casted null checks, i.e.
390  *
391  * Cmp(Cast(type, x_orig), NULL_type) -> Cmp(x_orig, NULL_orig)
392  *
393  * @param cmp  the Cmp node
394  *
395  * @return 1 if Cast's where removed
396  */
397 static int remove_Cmp_Null_cast(ir_node *cmp)
398 {
399         ir_graph *irg;
400         ir_node *cast, *null, *new_null;
401         int     cast_pos, null_pos;
402         ir_type *fromtype;
403         ir_mode *mode;
404
405         cast = get_Cmp_left(cmp);
406         if (!is_Cast(cast)) {
407                 null     = cast;
408                 null_pos = 0;
409                 cast     = get_Cmp_right(cmp);
410                 cast_pos = 1;
411                 if (!is_Cast(cast))
412                         return 0;
413         } else {
414                 null = get_Cmp_right(cmp);
415                 cast_pos = 0;
416                 null_pos = 1;
417         }
418
419         if (! is_Const(null))
420                 return 0;
421         mode = get_irn_mode(null);
422         if (!mode_is_reference(mode))
423                 return 0;
424         if (get_Const_tarval(null) != get_mode_null(mode))
425                 return 0;
426
427         /* Transform Cmp */
428         irg = get_irn_irg(cmp);
429         set_irn_n(cmp, cast_pos, get_Cast_op(cast));
430         fromtype = get_irn_typeinfo_type(get_Cast_op(cast));
431         new_null = new_r_Const(irg, get_Const_tarval(null));
432         set_irn_typeinfo_type(new_null, fromtype);
433         set_irn_n(cmp, null_pos, new_null);
434         ++n_casts_removed;
435         return 1;
436 }
437
438 /**
439  * Post-Walker: Optimize class casts (mostly by trying to remove them)
440  */
441 static void irn_optimize_class_cast(ir_node *n, void *env)
442 {
443         int *changed = (int*)env;
444
445         if (is_Cast(n))
446                 *changed |= cancel_out_casts(n);
447         else if (is_Sel(n))
448                 *changed |= concretize_selected_entity(n);
449         else if (is_Phi(n))
450                 *changed |= concretize_Phi_type(n);
451         else if (is_Cmp(n))
452                 *changed |= remove_Cmp_Null_cast(n);
453 }
454
455 void optimize_class_casts(void)
456 {
457         int changed;
458
459         changed = 0;
460         all_irg_walk(NULL, irn_optimize_class_cast, &changed);
461
462         DB((dbg, SET_LEVEL_1, " Cast optimization: %zu Casts removed, %zu Sels concretized.\n",
463                 n_casts_removed, n_sels_concretized));
464 }
465
466 void firm_init_class_casts_opt(void)
467 {
468         FIRM_DBG_REGISTER(dbg, "firm.opt.tropt");
469 }