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