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