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 "tropt.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         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                         ir_mode *mode = is_Method_type(tp) ? mode_P_code : mode_P_data;
  71
  72                         res = new_type_pointer(id_mangle_u(get_type_ident(tp), ptr_type_suffix), tp, mode);
  73                         /* Update trout for pointer types, so we can use it in next call. */
  74                         add_type_pointertype_to(tp, res);
  75                 }
  76         }
  77         else {
  78                 res = find_pointer_type_to_type(tp);
  79                 if (res == firm_unknown_type)
  80                         res = new_type_pointer(id_mangle_u(get_type_ident(tp), ptr_type_suffix), tp, mode_P_data);
  81         }
  82
  83         return res;
  84 }
  85
  86 /** Return a type that is a depth times pointer to type. */
  87 static ir_type *pointerize_type(ir_type *tp, int depth) {
  88         for (; depth > 0; --depth) {
  89                 tp = gen_pointer_type_to(tp);
  90         }
  91         return tp;
  92 }
  93
  94
  95 static ir_node *normalize_values_type(ir_type *totype, ir_node *pred) {
  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         ir_node *res;
 170         (void) env;
 171         if (is_Cast(n)) {
 172                 ir_node *pred   = get_Cast_op(n);
 173                 ir_type *totype = get_Cast_type(n);
 174                 res = normalize_values_type(totype, pred);
 175                 set_Cast_op(n, res);
 176         } else if (is_Call(n)) {
 177                 int i, n_params = get_Call_n_params(n);
 178                 ir_type *tp = get_Call_type(n);
 179                 for (i = 0; i < n_params; ++i) {
 180                         res = normalize_values_type(get_method_param_type(tp, i), get_Call_param(n, i));
 181                         set_Call_param(n, i, res);
 182                 }
 183         }
 184 }
 185
 186
 187 static void pure_normalize_irg_class_casts(ir_graph *irg) {
 188         assert(get_irg_class_cast_state(irg) != ir_class_casts_any &&
 189                 "Cannot normalize irregular casts.");
 190         if (get_irg_class_cast_state(irg) == ir_class_casts_normalized) {
 191                 verify_irg_class_cast_state(irg);
 192                 return;
 193         }
 194
 195         irg_walk_graph(irg, NULL, normalize_irn_class_cast, NULL);
 196         set_irg_class_cast_state(irg, ir_class_casts_normalized);
 197 }
 198
 199
 200 void normalize_irg_class_casts(ir_graph *irg, gen_pointer_type_to_func gppt_fct) {
 201         assert(get_irp_typeinfo_state() == ir_typeinfo_consistent);
 202
 203         if (gppt_fct) gen_pointer_type_to = gppt_fct;
 204
 205         if (!ptr_type_suffix)
 206                 ptr_type_suffix = new_id_from_str(PTR_TYPE_SUFFIX);
 207
 208         pure_normalize_irg_class_casts(irg);
 209
 210         gen_pointer_type_to = default_gen_pointer_type_to;
 211 }
 212
 213 void normalize_irp_class_casts(gen_pointer_type_to_func gppt_fct) {
 214         int i;
 215         if (gppt_fct) gen_pointer_type_to = gppt_fct;
 216
 217         if (get_irp_typeinfo_state() != ir_typeinfo_consistent)
 218                 simple_analyse_types();
 219
 220         for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
 221                 pure_normalize_irg_class_casts(get_irp_irg(i));
 222         }
 223
 224         set_irp_class_cast_state(ir_class_casts_normalized);
 225         gen_pointer_type_to = default_gen_pointer_type_to;
 226
 227         DB((dbg, SET_LEVEL_1, " Cast normalization: %d Casts inserted.\n", n_casts_normalized));
 228 }
 229
 230
 231
 232 /* - Cast optimization. ------------------------------------------- */
 233
 234 /**
 235  * Optimizes Casts:
 236  *
 237  *  (T1)(T2)x<T1> -> x<T1>
 238  *
 239  *  (T3)(T2)x<T1> -> (T3)x<T1>
 240  *
 241  * if possible.
 242  *
 243  * @param cast  the Cast node
 244  *
 245  * @return 1 if the cast was changed
 246  */
 247 static int cancel_out_casts(ir_node *cast) {
 248         ir_node *orig, *pred = get_Cast_op(cast);
 249         ir_type *tp_cast, *tp_pred, *tp_orig;
 250         int ref_depth = 0;
 251
 252         if (!is_Cast(pred)) return 0;
 253         orig = get_Cast_op(pred);
 254
 255         tp_cast = get_Cast_type(cast);
 256         tp_pred = get_Cast_type(pred);
 257         tp_orig = get_irn_typeinfo_type(orig);
 258
 259         while (is_Pointer_type(tp_cast) &&
 260               is_Pointer_type(tp_pred) &&
 261               is_Pointer_type(tp_orig)   ) {
 262                 tp_cast = get_pointer_points_to_type(tp_cast);
 263                 tp_pred = get_pointer_points_to_type(tp_pred);
 264                 tp_orig = get_pointer_points_to_type(tp_orig);
 265                 ref_depth++;
 266         }
 267
 268         if (!is_Class_type(tp_cast) || !is_Class_type(tp_pred) || !is_Class_type(tp_orig))
 269                 return 0;
 270
 271         if (is_SubClass_of(tp_pred, tp_cast) && get_opt_suppress_downcast_optimization())
 272                 return 0;
 273
 274         if (tp_cast == tp_orig) {
 275                 exchange(cast, orig);
 276                 n_casts_removed += 2;
 277                 return 1;
 278         }
 279
 280         if (!(is_SubClass_of  (tp_cast, tp_orig) || is_SubClass_of  (tp_orig, tp_cast))) {
 281                 /* Avoid (B2)(A)(new B1()) --> (B2)(new B1())
 282                 * if B1 =!> B2  and  B2 =!> B1
 283                 */
 284                 return 0;
 285         }
 286
 287         if ((is_SubClass_of  (tp_cast, tp_pred) && is_SuperClass_of(tp_pred, tp_orig)) ||
 288             (is_SuperClass_of(tp_cast, tp_pred) && is_SubClass_of  (tp_pred, tp_orig))) {
 289                 /* Cast --> Pred --> Orig */
 290                 set_Cast_op(cast, orig);
 291                 ++n_casts_removed;
 292                 return 1;
 293         }
 294         return 0;
 295 }
 296
 297 /**
 298  * Optimize Sel(Cast(type, ptr), ent) into Sel(ptr_type, ent_type)
 299  *
 300  * @param sel  the Sel node
 301  *
 302  * @return 1 if Cast's where removed
 303  */
 304 static int concretize_selected_entity(ir_node *sel) {
 305         ir_node   *cast, *ptr = get_Sel_ptr(sel);
 306         ir_type   *orig_tp, *cast_tp;
 307         ir_entity *new_ent, *sel_ent;
 308         int       res = 0;
 309
 310         sel_ent = get_Sel_entity(sel);
 311         cast    = get_Sel_ptr(sel);
 312
 313         while (is_Cast(cast)) {
 314                 cast_tp = get_Cast_type(cast);
 315                 ptr     = get_Cast_op(cast);
 316                 orig_tp = get_irn_typeinfo_type(ptr);
 317
 318                 /* we handle only classes */
 319                 if (!is_Pointer_type(orig_tp)|| !is_Pointer_type(cast_tp))
 320                         return res;
 321                 orig_tp = get_pointer_points_to_type(orig_tp);
 322                 cast_tp = get_pointer_points_to_type(cast_tp);
 323                 if (!is_Class_type(orig_tp) || !is_Class_type(cast_tp))
 324                         return res;
 325
 326                 /* We only want to concretize, but not generalize. */
 327                 if (!is_SuperClass_of(cast_tp, orig_tp))
 328                         return res;
 329
 330                 /* The sel entity should be a member of the cast_tp, else
 331                    the graph was not properly typed. */
 332                 if (get_class_member_index(cast_tp, sel_ent) == -1)
 333                         return res;
 334
 335                 new_ent = resolve_ent_polymorphy(orig_tp, sel_ent);
 336
 337                 /* New ent must be member of orig_tp. */
 338                 if (get_class_member_index(orig_tp, new_ent) == -1)
 339                         return res;
 340
 341                 /* all checks done, we can remove the Cast and update the Sel */
 342                 set_Sel_entity(sel, new_ent);
 343                 set_Sel_ptr(sel, ptr);
 344                 ++n_sels_concretized;
 345
 346                 sel_ent = new_ent;
 347                 cast    = ptr;
 348                 res     = 1;
 349         }
 350         return res;
 351 }
 352
 353 /**
 354  * Move Casts of the same type through a Phi node, i.e.
 355  * Phi(Cast(type, x_0), ..., Cast(type, x_n)) -> Cast(type, Phi(x_0, ..., x_n))
 356  *
 357  * @param phi  the Phi node
 358  *
 359  * @return 1 if Cast's where moved
 360  */
 361 static int concretize_Phi_type(ir_node *phi)
 362 {
 363         int       n_preds = get_Phi_n_preds(phi);
 364         ir_node **pred    = ALLOCAN(ir_node*, n_preds);
 365         ir_node  *nn, *blk;
 366         ir_type  *totype;
 367         ir_type  *fromtype;
 368         int       i;
 369
 370         if (n_preds == 0)
 371                 return 0;
 372         pred[0] = get_Phi_pred(phi, 0);
 373
 374         if (!is_Cast(pred[0]))
 375                 return 0;
 376
 377         if (!is_Cast_upcast(pred[0]))
 378                 return 0;
 379
 380         fromtype = get_irn_typeinfo_type(get_Cast_op(pred[0]));
 381         totype   = get_Cast_type(pred[0]);
 382
 383         pred[0] = get_Cast_op(pred[0]);
 384         for (i = 1; i < n_preds; ++i) {
 385                 pred[i] = get_Phi_pred(phi, i);
 386                 if (!is_Cast(pred[i]))
 387                         return 0;
 388                 if (get_irn_typeinfo_type(get_Cast_op(pred[i])) != fromtype)
 389                         return 0;
 390                 pred[i] = get_Cast_op(pred[i]);
 391         }
 392
 393         /* Transform Phi */
 394         blk = get_nodes_block(phi);
 395         nn  = new_r_Phi(current_ir_graph, blk, n_preds, pred, get_irn_mode(phi));
 396         set_irn_typeinfo_type(nn, fromtype);
 397         nn  = new_r_Cast(current_ir_graph, blk, nn, totype);
 398         set_irn_typeinfo_type(nn, totype);
 399         exchange(phi, nn);
 400         return 1;
 401 }
 402
 403 /**
 404  * Remove Casted null checks, i.e.
 405  *
 406  * Cmp(Cast(type, x_orig), NULL_type) -> Cmp(x_orig, NULL_orig)
 407  *
 408  * @param cmp  the Cmp node
 409  *
 410  * @return 1 if Cast's where removed
 411  */
 412 static int remove_Cmp_Null_cast(ir_node *cmp) {
 413         ir_node *cast, *null, *new_null;
 414         int     cast_pos, null_pos;
 415         ir_type *fromtype;
 416         ir_mode *mode;
 417
 418         cast = get_Cmp_left(cmp);
 419         if (!is_Cast(cast)) {
 420                 null     = cast;
 421                 null_pos = 0;
 422                 cast     = get_Cmp_right(cmp);
 423                 cast_pos = 1;
 424                 if (!is_Cast(cast))
 425                         return 0;
 426         } else {
 427                 null = get_Cmp_right(cmp);
 428                 cast_pos = 0;
 429                 null_pos = 1;
 430         }
 431
 432         if (! is_Const(null))
 433                 return 0;
 434         mode = get_irn_mode(null);
 435         if (!mode_is_reference(mode))
 436                 return 0;
 437         if (get_Const_tarval(null) != get_mode_null(mode))
 438                 return 0;
 439
 440         /* Transform Cmp */
 441         set_irn_n(cmp, cast_pos, get_Cast_op(cast));
 442         fromtype = get_irn_typeinfo_type(get_Cast_op(cast));
 443         new_null = new_Const_type(get_Const_tarval(null), fromtype);
 444         set_irn_typeinfo_type(new_null, fromtype);
 445         set_irn_n(cmp, null_pos, new_null);
 446         ++n_casts_removed;
 447         return 1;
 448 }
 449
 450 /**
 451  * Post-Walker: Optimize class casts (mostly by trying to remove them)
 452  */
 453 static void irn_optimize_class_cast(ir_node *n, void *env) {
 454         int *changed = env;
 455
 456         if (is_Cast(n))
 457                 *changed |= cancel_out_casts(n);
 458         else if (is_Sel(n))
 459                 *changed |= concretize_selected_entity(n);
 460         else if (is_Phi(n))
 461                 *changed |= concretize_Phi_type(n);
 462         else if (is_Cmp(n))
 463                 *changed |= remove_Cmp_Null_cast(n);
 464 }
 465
 466 void optimize_class_casts(void) {
 467         int changed;
 468
 469         if (get_irp_typeinfo_state() != ir_typeinfo_consistent)
 470                 simple_analyse_types();
 471
 472         changed = 0;
 473         all_irg_walk(NULL, irn_optimize_class_cast, &changed);
 474
 475         if (changed) {
 476                 int i;
 477
 478                 set_trouts_inconsistent();
 479                 for (i = get_irp_n_irgs() - 1; i >= 0; --i)
 480                         set_irg_outs_inconsistent(get_irp_irg(i));
 481         }
 482
 483         DB((dbg, SET_LEVEL_1, " Cast optimization: %d Casts removed, %d Sels concretized.\n",
 484                 n_casts_removed, n_sels_concretized));
 485 }
 486
 487 void firm_init_class_casts_opt(void) {
 488         FIRM_DBG_REGISTER(dbg, "firm.opt.tropt");
 489 }