nsz Git - libfirm/blob - 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 "irsimpletype.h"
  36 #include "trouts.h"
  37 #include "ircons.h"
  38 #include "irgmod.h"
  39 #include "irflag_t.h"
  40 #include "xmalloc.h"
  41 #include "debug.h"
  42 #include "opt_init.h"
  43
  44 DEBUG_ONLY(static firm_dbg_module_t *dbg;)
  45
  46 /* - statistics ---------------------------------------------- */
  47
  48 static int n_casts_normalized = 0;
  49 static int n_casts_removed    = 0;
  50 static int n_sels_concretized = 0;
  51
  52 /* - Cast normalization. ------------------------------------- */
  53
  54 static ir_type *default_gen_pointer_type_to(ir_type *tp);
  55
  56 #define PTR_TYPE_SUFFIX "cc_ptr_tp"  /* class cast pointer type. */
  57 static ident *ptr_type_suffix = NULL;
  58 static gen_pointer_type_to_func gen_pointer_type_to = default_gen_pointer_type_to;
  59
  60 /**
  61  * Find a pointer type to a given type.
  62  * Uses and updates trouts if available.
  63  */
  64 static ir_type *default_gen_pointer_type_to(ir_type *tp)
  65 {
  66         ir_type *res = NULL;
  67         if (get_trouts_state() == outs_consistent) {
  68                 if (get_type_n_pointertypes_to(tp) > 0) {
  69                         res = get_type_pointertype_to(tp, 0);
  70                 } else {
  71                         res = new_type_pointer(tp);
  72                         /* Update trout for pointer types, so we can use it in next call. */
  73                         add_type_pointertype_to(tp, res);
  74                 }
  75         } else {
  76                 res = find_pointer_type_to_type(tp);
  77                 if (res == firm_unknown_type)
  78                         res = new_type_pointer(tp);
  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 {
  87         for (; depth > 0; --depth) {
  88                 tp = gen_pointer_type_to(tp);
  89         }
  90         return tp;
  91 }
  92
  93
  94 static ir_node *normalize_values_type(ir_type *totype, ir_node *pred)
  95 {
  96         ir_type *fromtype = get_irn_typeinfo_type(pred);
  97         ir_node *new_cast = pred;
  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         set_cur_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_Cast(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_Cast(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 (get_irp_typeinfo_state() != ir_typeinfo_consistent)
 222                 simple_analyse_types();
 223
 224         for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
 225                 pure_normalize_irg_class_casts(get_irp_irg(i));
 226         }
 227
 228         set_irp_class_cast_state(ir_class_casts_normalized);
 229         gen_pointer_type_to = default_gen_pointer_type_to;
 230
 231         DB((dbg, SET_LEVEL_1, " Cast normalization: %d Casts inserted.\n", n_casts_normalized));
 232 }
 233
 234
 235
 236 /* - Cast optimization. ------------------------------------------- */
 237
 238 /**
 239  * Optimizes Casts:
 240  *
 241  *  (T1)(T2)x<T1> -> x<T1>
 242  *
 243  *  (T3)(T2)x<T1> -> (T3)x<T1>
 244  *
 245  * if possible.
 246  *
 247  * @param cast  the Cast node
 248  *
 249  * @return 1 if the cast was changed
 250  */
 251 static int cancel_out_casts(ir_node *cast)
 252 {
 253         ir_node *orig, *pred = get_Cast_op(cast);
 254         ir_type *tp_cast, *tp_pred, *tp_orig;
 255
 256         if (!is_Cast(pred)) return 0;
 257         orig = get_Cast_op(pred);
 258
 259         tp_cast = get_Cast_type(cast);
 260         tp_pred = get_Cast_type(pred);
 261         tp_orig = get_irn_typeinfo_type(orig);
 262
 263         while (is_Pointer_type(tp_cast) &&
 264               is_Pointer_type(tp_pred) &&
 265               is_Pointer_type(tp_orig)   ) {
 266                 tp_cast = get_pointer_points_to_type(tp_cast);
 267                 tp_pred = get_pointer_points_to_type(tp_pred);
 268                 tp_orig = get_pointer_points_to_type(tp_orig);
 269         }
 270
 271         if (!is_Class_type(tp_cast) || !is_Class_type(tp_pred) || !is_Class_type(tp_orig))
 272                 return 0;
 273
 274         if (is_SubClass_of(tp_pred, tp_cast) && get_opt_suppress_downcast_optimization())
 275                 return 0;
 276
 277         if (tp_cast == tp_orig) {
 278                 exchange(cast, orig);
 279                 n_casts_removed += 2;
 280                 return 1;
 281         }
 282
 283         if (!(is_SubClass_of  (tp_cast, tp_orig) || is_SubClass_of  (tp_orig, tp_cast))) {
 284                 /* Avoid (B2)(A)(new B1()) --> (B2)(new B1())
 285                 * if B1 =!> B2  and  B2 =!> B1
 286                 */
 287                 return 0;
 288         }
 289
 290         if ((is_SubClass_of  (tp_cast, tp_pred) && is_SuperClass_of(tp_pred, tp_orig)) ||
 291             (is_SuperClass_of(tp_cast, tp_pred) && is_SubClass_of  (tp_pred, tp_orig))) {
 292                 /* Cast --> Pred --> Orig */
 293                 set_Cast_op(cast, orig);
 294                 ++n_casts_removed;
 295                 return 1;
 296         }
 297         return 0;
 298 }
 299
 300 /**
 301  * Optimize Sel(Cast(type, ptr), ent) into Sel(ptr_type, ent_type)
 302  *
 303  * @param sel  the Sel node
 304  *
 305  * @return 1 if Cast's where removed
 306  */
 307 static int concretize_selected_entity(ir_node *sel)
 308 {
 309         ir_node   *cast, *ptr = get_Sel_ptr(sel);
 310         ir_type   *orig_tp, *cast_tp;
 311         ir_entity *new_ent, *sel_ent;
 312         int       res = 0;
 313
 314         sel_ent = get_Sel_entity(sel);
 315         cast    = get_Sel_ptr(sel);
 316
 317         while (is_Cast(cast)) {
 318                 cast_tp = get_Cast_type(cast);
 319                 ptr     = get_Cast_op(cast);
 320                 orig_tp = get_irn_typeinfo_type(ptr);
 321
 322                 /* we handle only classes */
 323                 if (!is_Pointer_type(orig_tp)|| !is_Pointer_type(cast_tp))
 324                         return res;
 325                 orig_tp = get_pointer_points_to_type(orig_tp);
 326                 cast_tp = get_pointer_points_to_type(cast_tp);
 327                 if (!is_Class_type(orig_tp) || !is_Class_type(cast_tp))
 328                         return res;
 329
 330                 /* We only want to concretize, but not generalize. */
 331                 if (!is_SuperClass_of(cast_tp, orig_tp))
 332                         return res;
 333
 334                 /* The sel entity should be a member of the cast_tp, else
 335                    the graph was not properly typed. */
 336                 if (get_class_member_index(cast_tp, sel_ent) == -1)
 337                         return res;
 338
 339                 new_ent = resolve_ent_polymorphy(orig_tp, sel_ent);
 340
 341                 /* New ent must be member of orig_tp. */
 342                 if (get_class_member_index(orig_tp, new_ent) == -1)
 343                         return res;
 344
 345                 /* all checks done, we can remove the Cast and update the Sel */
 346                 set_Sel_entity(sel, new_ent);
 347                 set_Sel_ptr(sel, ptr);
 348                 ++n_sels_concretized;
 349
 350                 sel_ent = new_ent;
 351                 cast    = ptr;
 352                 res     = 1;
 353         }
 354         return res;
 355 }
 356
 357 /**
 358  * Move Casts of the same type through a Phi node, i.e.
 359  * Phi(Cast(type, x_0), ..., Cast(type, x_n)) -> Cast(type, Phi(x_0, ..., x_n))
 360  *
 361  * @param phi  the Phi node
 362  *
 363  * @return 1 if Cast's where moved
 364  */
 365 static int concretize_Phi_type(ir_node *phi)
 366 {
 367         int       n_preds = get_Phi_n_preds(phi);
 368         ir_node **pred    = ALLOCAN(ir_node*, n_preds);
 369         ir_node  *nn, *blk;
 370         ir_type  *totype;
 371         ir_type  *fromtype;
 372         int       i;
 373
 374         if (n_preds == 0)
 375                 return 0;
 376         pred[0] = get_Phi_pred(phi, 0);
 377
 378         if (!is_Cast(pred[0]))
 379                 return 0;
 380
 381         if (!is_Cast_upcast(pred[0]))
 382                 return 0;
 383
 384         fromtype = get_irn_typeinfo_type(get_Cast_op(pred[0]));
 385         totype   = get_Cast_type(pred[0]);
 386
 387         pred[0] = get_Cast_op(pred[0]);
 388         for (i = 1; i < n_preds; ++i) {
 389                 pred[i] = get_Phi_pred(phi, i);
 390                 if (!is_Cast(pred[i]))
 391                         return 0;
 392                 if (get_irn_typeinfo_type(get_Cast_op(pred[i])) != fromtype)
 393                         return 0;
 394                 pred[i] = get_Cast_op(pred[i]);
 395         }
 396
 397         /* Transform Phi */
 398         blk = get_nodes_block(phi);
 399         nn  = new_r_Phi(blk, n_preds, pred, get_irn_mode(phi));
 400         set_irn_typeinfo_type(nn, fromtype);
 401         nn  = new_r_Cast(blk, nn, totype);
 402         set_irn_typeinfo_type(nn, totype);
 403         exchange(phi, nn);
 404         return 1;
 405 }
 406
 407 /**
 408  * Remove Casted null checks, i.e.
 409  *
 410  * Cmp(Cast(type, x_orig), NULL_type) -> Cmp(x_orig, NULL_orig)
 411  *
 412  * @param cmp  the Cmp node
 413  *
 414  * @return 1 if Cast's where removed
 415  */
 416 static int remove_Cmp_Null_cast(ir_node *cmp)
 417 {
 418         ir_node *cast, *null, *new_null;
 419         int     cast_pos, null_pos;
 420         ir_type *fromtype;
 421         ir_mode *mode;
 422
 423         cast = get_Cmp_left(cmp);
 424         if (!is_Cast(cast)) {
 425                 null     = cast;
 426                 null_pos = 0;
 427                 cast     = get_Cmp_right(cmp);
 428                 cast_pos = 1;
 429                 if (!is_Cast(cast))
 430                         return 0;
 431         } else {
 432                 null = get_Cmp_right(cmp);
 433                 cast_pos = 0;
 434                 null_pos = 1;
 435         }
 436
 437         if (! is_Const(null))
 438                 return 0;
 439         mode = get_irn_mode(null);
 440         if (!mode_is_reference(mode))
 441                 return 0;
 442         if (get_Const_tarval(null) != get_mode_null(mode))
 443                 return 0;
 444
 445         /* Transform Cmp */
 446         set_irn_n(cmp, cast_pos, get_Cast_op(cast));
 447         fromtype = get_irn_typeinfo_type(get_Cast_op(cast));
 448         new_null = new_Const_type(get_Const_tarval(null), fromtype);
 449         set_irn_typeinfo_type(new_null, fromtype);
 450         set_irn_n(cmp, null_pos, new_null);
 451         ++n_casts_removed;
 452         return 1;
 453 }
 454
 455 /**
 456  * Post-Walker: Optimize class casts (mostly by trying to remove them)
 457  */
 458 static void irn_optimize_class_cast(ir_node *n, void *env)
 459 {
 460         int *changed = env;
 461
 462         if (is_Cast(n))
 463                 *changed |= cancel_out_casts(n);
 464         else if (is_Sel(n))
 465                 *changed |= concretize_selected_entity(n);
 466         else if (is_Phi(n))
 467                 *changed |= concretize_Phi_type(n);
 468         else if (is_Cmp(n))
 469                 *changed |= remove_Cmp_Null_cast(n);
 470 }
 471
 472 void optimize_class_casts(void)
 473 {
 474         int changed;
 475
 476         if (get_irp_typeinfo_state() != ir_typeinfo_consistent)
 477                 simple_analyse_types();
 478
 479         changed = 0;
 480         all_irg_walk(NULL, irn_optimize_class_cast, &changed);
 481
 482         if (changed) {
 483                 int i;
 484
 485                 set_trouts_inconsistent();
 486                 for (i = get_irp_n_irgs() - 1; i >= 0; --i)
 487                         set_irg_outs_inconsistent(get_irp_irg(i));
 488         }
 489
 490         DB((dbg, SET_LEVEL_1, " Cast optimization: %d Casts removed, %d Sels concretized.\n",
 491                 n_casts_removed, n_sels_concretized));
 492 }
 493
 494 void firm_init_class_casts_opt(void)
 495 {
 496         FIRM_DBG_REGISTER(dbg, "firm.opt.tropt");
 497 }