removed c99 feature
[libfirm] / ir / opt / tropt.c
1 /*
2  * Copyright (C) 1995-2007 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  * @version $Id$
26  */
27 #ifdef HAVE_CONFIG_H
28 #include "config.h"
29 #endif
30
31 #include <assert.h>
32
33 #include "iroptimize.h"
34 #include "irprog.h"
35 #include "irtypeinfo.h"
36 #include "irgwalk.h"
37 #include "irsimpletype.h"
38 #include "trouts.h"
39 #include "ircons.h"
40 #include "irgmod.h"
41 #include "irflag_t.h"
42 #include "xmalloc.h"
43
44 /* - statistics ---------------------------------------------- */
45
46 static int n_casts_normalized = 0;
47 static int n_casts_removed    = 0;
48 static int 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   ir_type *res = NULL;
64   if (get_trouts_state() == outs_consistent) {
65     if (get_type_n_pointertypes_to(tp) > 0) {
66       res = get_type_pointertype_to(tp, 0);
67     } else {
68       ir_mode *mode = is_Method_type(tp) ? mode_P_code : mode_P_data;
69
70       res = new_type_pointer(mangle_u(get_type_ident(tp), ptr_type_suffix), tp, mode);
71       /* Update trout for pointer types, so we can use it in next call. */
72       add_type_pointertype_to(tp, res);
73     }
74   }
75   else {
76     res = find_pointer_type_to_type(tp);
77     if (res == firm_unknown_type)
78       res = new_type_pointer(mangle_u(get_type_ident(tp), ptr_type_suffix), tp, mode_P_data);
79   }
80
81   return res;
82 }
83
84 /** Return a type that is a depth times pointer to type. */
85 static ir_type *pointerize_type(ir_type *tp, int depth) {
86   for (; depth > 0; --depth) {
87     tp = gen_pointer_type_to(tp);
88   }
89   return tp;
90 }
91
92
93 static ir_node *normalize_values_type(ir_type *totype, ir_node *pred) {
94   ir_type *fromtype = get_irn_typeinfo_type(pred);
95   ir_node *new_cast = pred;
96   int ref_depth = 0;
97
98   if (totype == fromtype) return pred;   /* Case for optimization! */
99
100   while (is_Pointer_type(totype) && is_Pointer_type(fromtype)) {
101     totype   = get_pointer_points_to_type(totype);
102     fromtype = get_pointer_points_to_type(fromtype);
103     ref_depth++;
104   }
105
106   if (!is_Class_type(totype))   return pred;
107   if (!is_Class_type(fromtype)) return pred;
108
109   if ((get_class_supertype_index(totype, fromtype) != -1) ||
110       (get_class_supertype_index(fromtype, totype) != -1) ) {
111     /* It's just what we want ... */
112     return pred;
113   }
114
115   set_cur_block(get_nodes_block(pred));
116
117   if (is_SubClass_of(totype, fromtype)) {
118     /* downcast */
119     while (get_class_subtype_index(fromtype, totype) == -1) {
120       /* Insert a cast to a subtype of fromtype. */
121       ir_type *new_type = NULL;
122       ir_node *new_cast;
123       int i, n_subtypes = get_class_n_subtypes(fromtype);
124       for (i = 0; i < n_subtypes && !new_type; ++i) {
125         ir_type *new_sub = get_class_subtype(fromtype, i);
126         if (is_SuperClass_of(new_sub, totype))
127           new_type = new_sub;
128       }
129       assert(new_type);
130       fromtype = new_type;
131       new_type = pointerize_type(new_type, ref_depth);
132       new_cast = new_Cast(pred, new_type);
133       pred = new_cast;
134       n_casts_normalized ++;
135       set_irn_typeinfo_type(new_cast, new_type);  /* keep type information up to date. */
136       if (get_trouts_state() != outs_none) add_type_cast(new_type, new_cast);
137     }
138   }
139   else {
140     assert(is_SuperClass_of(totype, fromtype));
141     /* upcast */
142     while (get_class_supertype_index(fromtype, totype) == -1) {
143       /* Insert a cast to a supertype of fromtype. */
144       ir_type *new_type = NULL;
145       int i, n_supertypes = get_class_n_supertypes(fromtype);
146       for (i = 0; i < n_supertypes && !new_type; ++i) {
147         ir_type *new_super = get_class_supertype(fromtype, i);
148         if (is_SubClass_of(new_super, totype))
149           new_type = new_super;
150       }
151       assert(new_type);
152       fromtype = new_type;
153       new_type = pointerize_type(new_type, ref_depth);
154       new_cast = new_Cast(pred, new_type);
155       pred = new_cast;
156       n_casts_normalized ++;
157       set_irn_typeinfo_type(new_cast, new_type);  /* keep type information up to date. */
158       if (get_trouts_state() != outs_none) add_type_cast(new_type, new_cast);
159     }
160   }
161   return new_cast;
162 }
163
164
165 static void normalize_irn_class_cast(ir_node *n, void *env) {
166   ir_node *res;
167   if (get_irn_op(n) == op_Cast) {
168     ir_node *pred  = get_Cast_op(n);
169     ir_type *totype   = get_Cast_type(n);
170     res = normalize_values_type(totype, pred);
171     set_Cast_op(n, res);
172   } else if (get_irn_op(n) == op_Call) {
173     int i, n_params = get_Call_n_params(n);
174     ir_type *tp = get_Call_type(n);
175     for (i = 0; i < n_params; ++i) {
176       res = normalize_values_type(get_method_param_type(tp, i), get_Call_param(n, i));
177       set_Call_param(n, i, res);
178     }
179   }
180 }
181
182
183 static void pure_normalize_irg_class_casts(ir_graph *irg) {
184   assert(get_irg_class_cast_state(irg) != ir_class_casts_any &&
185          "Cannot normalize irregular casts.");
186   if (get_irg_class_cast_state(irg) == ir_class_casts_normalized) {
187     verify_irg_class_cast_state(irg);
188     return;
189   }
190
191   irg_walk_graph(irg, NULL, normalize_irn_class_cast, NULL);
192   set_irg_class_cast_state(irg, ir_class_casts_normalized);
193 }
194
195
196 void normalize_irg_class_casts(ir_graph *irg, gen_pointer_type_to_func gppt_fct) {
197   assert(get_irp_typeinfo_state() == ir_typeinfo_consistent);
198
199   if (gppt_fct) gen_pointer_type_to = gppt_fct;
200
201   if (!ptr_type_suffix)
202     ptr_type_suffix = new_id_from_str(PTR_TYPE_SUFFIX);
203
204   pure_normalize_irg_class_casts(irg);
205
206   gen_pointer_type_to = default_gen_pointer_type_to;
207 }
208
209 void normalize_irp_class_casts(gen_pointer_type_to_func gppt_fct) {
210   int i, n_irgs = get_irp_n_irgs();
211   if (gppt_fct) gen_pointer_type_to = gppt_fct;
212
213   if (get_irp_typeinfo_state() != ir_typeinfo_consistent)
214     simple_analyse_types();
215
216   for (i = 0; i < n_irgs; ++i) {
217     pure_normalize_irg_class_casts(get_irp_irg(i));
218   }
219
220   set_irp_class_cast_state(ir_class_casts_normalized);
221   gen_pointer_type_to = default_gen_pointer_type_to;
222
223   if (get_opt_optimize_class_casts_verbose() && get_firm_verbosity()) {
224     printf(" Cast normalization: %d Casts inserted.\n", n_casts_normalized);
225   }
226 }
227
228
229
230 /* - Cast optimization. ------------------------------------------- */
231
232 /**
233  * Optimizes Casts:
234  *
235  *  (T1)(T2)x<T1> -> x<T1>
236  *
237  *  (T3)(T2)x<T1> -> (T3)x<T1>
238  *
239  * if possible.
240  */
241 static void cancel_out_casts(ir_node *cast) {
242   ir_node *orig, *pred = get_Cast_op(cast);
243   ir_type *tp_cast, *tp_pred, *tp_orig;
244   int ref_depth = 0;
245
246   if (get_irn_op(pred) != op_Cast) return;
247   orig = get_Cast_op(pred);
248
249   tp_cast = get_Cast_type(cast);
250   tp_pred = get_Cast_type(pred);
251   tp_orig = get_irn_typeinfo_type(orig);
252
253   while (is_Pointer_type(tp_cast) &&
254          is_Pointer_type(tp_pred) &&
255          is_Pointer_type(tp_orig)   ) {
256     tp_cast = get_pointer_points_to_type(tp_cast);
257     tp_pred = get_pointer_points_to_type(tp_pred);
258     tp_orig = get_pointer_points_to_type(tp_orig);
259     ref_depth++;
260   }
261
262   if (!is_Class_type(tp_cast)) return;
263   if (!is_Class_type(tp_pred)) return;
264   if (!is_Class_type(tp_orig)) return;
265
266   if (is_SubClass_of(tp_pred, tp_cast) && get_opt_suppress_downcast_optimization())
267     return;
268
269   if (tp_cast == tp_orig) {
270     exchange(cast, orig);
271     n_casts_removed += 2;
272     return;
273   }
274
275   if (!(is_SubClass_of  (tp_cast, tp_orig) || is_SubClass_of  (tp_orig, tp_cast))) {
276     /* Avoid (B2)(A)(new B1()) --> (B2)(new B1())
277      * if B1 =!> B2  and  B2 =!> B1
278      */
279     return;
280   }
281
282   if ((is_SubClass_of  (tp_cast, tp_pred) && is_SuperClass_of(tp_pred, tp_orig)) ||
283       (is_SuperClass_of(tp_cast, tp_pred) && is_SubClass_of  (tp_pred, tp_orig))   ) {
284     /* Cast --> Pred --> Orig */
285     set_Cast_op (cast, orig);
286     n_casts_removed ++;
287   }
288 }
289
290 static void concretize_selected_entity(ir_node *sel) {
291   ir_node *cast, *ptr = get_Sel_ptr(sel);
292   ir_type *orig_tp, *cast_tp;
293   ir_entity *new_ent, *sel_ent;
294
295   sel_ent = get_Sel_entity(sel);
296   cast = get_Sel_ptr(sel);
297
298   while (get_irn_op(cast) == op_Cast) {
299     cast_tp = get_Cast_type(cast);
300     ptr = get_Cast_op(cast);
301     orig_tp = get_irn_typeinfo_type(ptr);
302
303     if (!is_Pointer_type(orig_tp)) return;
304     if (!is_Pointer_type(cast_tp)) return;
305     orig_tp = get_pointer_points_to_type(orig_tp);
306     cast_tp = get_pointer_points_to_type(cast_tp);
307     if (!is_Class_type(orig_tp)) return;
308     if (!is_Class_type(cast_tp)) return;
309
310     /* We only want to concretize, but not generalize. */
311     if (!is_SuperClass_of(cast_tp, orig_tp)) return;
312
313     /* Hmm, we are not properly typed. */
314     if (get_class_member_index(cast_tp, sel_ent) == -1) return;
315
316     new_ent = resolve_ent_polymorphy(orig_tp, sel_ent);
317
318     /* New ent must be member of orig_tp. */
319     if (get_class_member_index(orig_tp, new_ent) == -1) return;
320
321     set_Sel_entity(sel, new_ent);
322     set_Sel_ptr(sel, ptr);
323     n_sels_concretized++;
324
325     sel_ent = new_ent;
326     cast = ptr;
327   }
328 }
329
330 static void concretize_Phi_type(ir_node *phi) {
331   int i, n_preds = get_Phi_n_preds(phi);
332   ir_node **pred = alloca(n_preds * sizeof(ir_node *));
333   ir_node *new;
334   ir_type *totype, *fromtype;
335
336   if (n_preds == 0) return;
337   pred[0] = get_Phi_pred(phi, 0);
338
339   if (get_irn_op(pred[0]) != op_Cast) return;
340
341   if (!is_Cast_upcast(pred[0])) return;
342
343   fromtype = get_irn_typeinfo_type(get_Cast_op(pred[0]));
344   totype   = get_Cast_type(pred[0]);
345
346   pred[0] = get_Cast_op(pred[0]);
347   for (i = 1; i < n_preds; ++i) {
348     pred[i] = get_Phi_pred(phi, i);
349     if (get_irn_op(pred[i]) != op_Cast) return;
350     if (get_irn_typeinfo_type(get_Cast_op(pred[i])) != fromtype) return;
351     pred[i] = get_Cast_op(pred[i]);
352   }
353
354   /* Transform Phi */
355   set_cur_block(get_nodes_block(phi));
356   new = new_Phi(n_preds, pred, get_irn_mode(phi));
357   set_irn_typeinfo_type(new, fromtype);
358   new = new_Cast(new, totype);
359   set_irn_typeinfo_type(new, totype);
360   exchange(phi, new);
361 }
362
363 void remove_Cmp_Null_cast(ir_node *cmp) {
364   ir_node *cast, *null, *new_null;
365   int cast_pos, null_pos;
366   ir_type *fromtype;
367
368   cast = get_Cmp_left(cmp);
369   cast_pos = 0;
370   if (get_irn_op(cast) != op_Cast) {
371     null = cast;
372     null_pos = cast_pos;
373     cast = get_Cmp_right(cmp);
374     cast_pos = 1;
375     if (get_irn_op(cast) != op_Cast) return;
376   } else {
377     null = get_Cmp_right(cmp);
378     null_pos = 1;
379   }
380
381   if (get_irn_op(null) != op_Const) return;
382   if (!mode_is_reference(get_irn_mode(null))) return;
383   if (get_Const_tarval(null) != get_mode_null(get_irn_mode(null))) return;
384
385   /* Transform Cmp */
386   set_irn_n(cmp, cast_pos, get_Cast_op(cast));
387   fromtype = get_irn_typeinfo_type(get_Cast_op(cast));
388   new_null = new_Const_type(get_Const_tarval(null), fromtype);
389   set_irn_typeinfo_type(new_null, fromtype);
390   set_irn_n(cmp, null_pos, new_null);
391   n_casts_removed ++;
392 }
393
394 /**
395  * Post-Walker:
396  */
397 static void irn_optimize_class_cast(ir_node *n, void *env) {
398   if (get_irn_op(n) == op_Cast)
399     cancel_out_casts(n);
400   else if (get_irn_op(n) == op_Sel)
401     concretize_selected_entity(n);
402   else if (get_irn_op(n) == op_Phi)
403     concretize_Phi_type(n);
404   else if (get_irn_op(n) == op_Cmp)
405     remove_Cmp_Null_cast(n);
406 }
407
408 void optimize_class_casts(void) {
409   int i, n_irgs = get_irp_n_irgs();
410
411   if (get_irp_typeinfo_state() != ir_typeinfo_consistent)
412     simple_analyse_types();
413
414   all_irg_walk(NULL, irn_optimize_class_cast, NULL);
415
416   set_trouts_inconsistent();
417   for (i = 0; i < n_irgs; ++i)
418     set_irg_outs_inconsistent(get_irp_irg(i));
419
420   if (get_opt_optimize_class_casts_verbose() && get_firm_verbosity()) {
421     printf(" Cast optimization: %d Casts removed, %d Sels concretized.\n",
422            n_casts_removed, n_sels_concretized);
423   }
424 }