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