nsz Git - libfirm/blob - ir/opt/funccall.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   Optimization of function calls.
  23  * @author  Michael Beck
  24  */
  25 #include "config.h"
  26
  27 #include "opt_init.h"
  28 #include <stdbool.h>
  29
  30 #include "irnode_t.h"
  31 #include "irgraph_t.h"
  32 #include "irgmod.h"
  33 #include "irgwalk.h"
  34 #include "dbginfo_t.h"
  35 #include "irflag_t.h"
  36 #include "irloop_t.h"
  37 #include "ircons.h"
  38 #include "iredges_t.h"
  39 #include "irpass_t.h"
  40 #include "iroptimize.h"
  41 #include "analyze_irg_args.h"
  42 #include "irhooks.h"
  43 #include "raw_bitset.h"
  44 #include "debug.h"
  45
  46 DEBUG_ONLY(static firm_dbg_module_t *dbg;)
  47
  48 /**
  49  * The walker environment for updating function calls.
  50  */
  51 typedef struct env_t {
  52         size_t   n_calls_SymConst;
  53         size_t   n_calls_Sel;
  54         ir_node  *float_const_call_list;    /**< The list of all floating const function calls that will be changed. */
  55         ir_node  *nonfloat_const_call_list; /**< The list of all non-floating const function calls that will be changed. */
  56         ir_node  *pure_call_list;           /**< The list of all pure function calls that will be changed. */
  57         ir_node  *nothrow_call_list;        /**< The list of all nothrow function calls that will be changed. */
  58         ir_node  *proj_list;                /**< The list of all potential Proj nodes that must be fixed. */
  59 } env_t;
  60
  61 /** Ready IRG's are marked in the ready set. */
  62 static unsigned *ready_set;
  63
  64 /** IRG's that are in progress are marked here. */
  65 static unsigned *busy_set;
  66
  67 /**
  68  * We misuse the mtp_property_inherited flag as temporary here.
  69  * The is ok, as we cannot set or get it anyway using the
  70  * get_addtional_properties API.
  71  */
  72 #define mtp_temporary  mtp_property_inherited
  73
  74 /**
  75  * Walker: Collect all calls to const and pure functions
  76  * to lists. Collect all Proj(Call) nodes into a Proj list.
  77  */
  78 static void collect_const_and_pure_calls(ir_node *node, void *env)
  79 {
  80         env_t     *ctx = (env_t*)env;
  81         ir_node   *call;
  82         ir_node   *ptr;
  83         ir_entity *ent;
  84         unsigned  and_prop, or_prop, prop;
  85
  86         if (is_Call(node)) {
  87                 call = node;
  88
  89                 /* set the link to NULL for all non-const/pure calls */
  90                 set_irn_link(call, NULL);
  91                 ptr = get_Call_ptr(call);
  92                 if (is_SymConst_addr_ent(ptr)) {
  93                         ent = get_SymConst_entity(ptr);
  94
  95                         prop = get_entity_additional_properties(ent);
  96                         if ((prop & (mtp_property_const|mtp_property_pure)) == 0)
  97                                 return;
  98                         ++ctx->n_calls_SymConst;
  99                 } else if (get_opt_closed_world() &&
 100                            is_Sel(ptr) &&
 101                            get_irg_callee_info_state(get_irn_irg(node)) == irg_callee_info_consistent) {
 102                         /* If all possible callees are const functions, we can remove the memory edge. */
 103                         size_t i, n_callees = get_Call_n_callees(call);
 104                         if (n_callees == 0) {
 105                                 /* This is kind of strange:  dying code or a Call that will raise an exception
 106                                    when executed as there is no implementation to call.  So better not
 107                                    optimize. */
 108                                 return;
 109                         }
 110
 111                         /* note that const function are a subset of pure ones */
 112                         and_prop = mtp_property_const | mtp_property_pure;
 113                         or_prop  = 0;
 114                         for (i = 0; i < n_callees; ++i) {
 115                                 ent = get_Call_callee(call, i);
 116                                 if (is_unknown_entity(ent)) {
 117                                         /* we don't know which entity is called here */
 118                                         return;
 119                                 }
 120                                 prop      = get_entity_additional_properties(ent);
 121                                 and_prop &= prop;
 122                                 or_prop  &= prop;
 123                                 if (and_prop == mtp_no_property)
 124                                         return;
 125                         }
 126                         prop = and_prop | (or_prop & mtp_property_has_loop);
 127                         ++ctx->n_calls_Sel;
 128                 } else
 129                         return;
 130
 131                 /* ok, if we get here we found a call to a const or a pure function */
 132                 if (prop & mtp_property_pure) {
 133                         set_irn_link(call, ctx->pure_call_list);
 134                         ctx->pure_call_list = call;
 135                 } else {
 136                         if (prop & mtp_property_has_loop) {
 137                                 set_irn_link(call, ctx->nonfloat_const_call_list);
 138                                 ctx->nonfloat_const_call_list = call;
 139                         } else {
 140                                 set_irn_link(call, ctx->float_const_call_list);
 141                                 ctx->float_const_call_list = call;
 142                         }
 143                 }
 144         } else if (is_Proj(node)) {
 145                 /*
 146                  * Collect all memory and exception Proj's from
 147                  * calls.
 148                  */
 149                 call = get_Proj_pred(node);
 150                 if (! is_Call(call))
 151                         return;
 152
 153                 /* collect the Proj's in the Proj list */
 154                 switch (get_Proj_proj(node)) {
 155                 case pn_Call_M:
 156                 case pn_Call_X_except:
 157                 case pn_Call_X_regular:
 158                         set_irn_link(node, ctx->proj_list);
 159                         ctx->proj_list = node;
 160                         break;
 161                 default:
 162                         break;
 163                 }
 164         }
 165 }  /* collect_const_and_pure_calls */
 166
 167 /**
 168  * Fix the list of collected Calls.
 169  *
 170  * @param irg  the graph that contained calls to pure functions
 171  * @param ctx  context
 172  */
 173 static void fix_const_call_lists(ir_graph *irg, env_t *ctx)
 174 {
 175         ir_node *call, *next, *mem, *proj;
 176         int exc_changed = 0;
 177
 178         /* First step: fix all calls by removing their memory input and let
 179          * them floating.
 180          * The original memory input is preserved in their link fields. */
 181         for (call = ctx->float_const_call_list; call != NULL; call = next) {
 182                 next = (ir_node*)get_irn_link(call);
 183                 mem  = get_Call_mem(call);
 184
 185                 set_irn_link(call, mem);
 186                 set_Call_mem(call, get_irg_no_mem(irg));
 187
 188                 /*
 189                  * Unfortunately we cannot simply set the node to 'float'.
 190                  * There is a reason for that:
 191                  *
 192                  * - The call might be inside a loop/if that is NOT entered
 193                  *   and calls a endless function. Setting the call to float
 194                  *   would allow to move it out from the loop/if causing this
 195                  *   function be called even if the loop/if is not entered ...
 196                  *
 197                  * This could be fixed using post-dominators for calls and Pin nodes
 198                  * but need some more analyzes to ensure that a call that potential
 199                  * never returns is not executed before some code that generates
 200                  * observable states...
 201                  */
 202
 203                 /* finally, this call can float */
 204                 set_irn_pinned(call, op_pin_state_floats);
 205                 hook_func_call(irg, call);
 206         }
 207
 208         /* Last step: fix all Proj's */
 209         for (proj = ctx->proj_list; proj != NULL; proj = next) {
 210                 next = (ir_node*)get_irn_link(proj);
 211                 call = get_Proj_pred(proj);
 212                 mem  = (ir_node*)get_irn_link(call);
 213
 214                 /* beware of calls in the pure call list */
 215                 if (!mem || is_Call(mem))
 216                         continue;
 217                 assert(get_irn_mode(mem) == mode_M);
 218
 219                 switch (get_Proj_proj(proj)) {
 220                 case pn_Call_M: {
 221                         /* in dead code there might be cycles where proj == mem */
 222                         if (proj != mem)
 223                                 exchange(proj, mem);
 224                          break;
 225                 }
 226                 case pn_Call_X_except:
 227                         exc_changed = 1;
 228                         exchange(proj, new_r_Bad(irg, mode_X));
 229                         break;
 230                 case pn_Call_X_regular: {
 231                         ir_node *block = get_nodes_block(call);
 232                         exc_changed = 1;
 233                         exchange(proj, new_r_Jmp(block));
 234                         break;
 235                 }
 236                 default:
 237                         break;
 238                 }
 239         }
 240
 241         if (exc_changed) {
 242                 /* ... including exception edges */
 243                 clear_irg_properties(irg, IR_GRAPH_PROPERTY_CONSISTENT_DOMINANCE
 244                                    | IR_GRAPH_PROPERTY_CONSISTENT_LOOPINFO);
 245         }
 246 }  /* fix_const_call_list */
 247
 248 /**
 249  * Walker: Collect all calls to nothrow functions
 250  * to lists. Collect all Proj(Call) nodes into a Proj list.
 251  */
 252 static void collect_nothrow_calls(ir_node *node, void *env)
 253 {
 254         env_t *ctx = (env_t*)env;
 255         ir_node *call, *ptr;
 256         ir_entity *ent;
 257         unsigned prop;
 258
 259         if (is_Call(node)) {
 260                 call = node;
 261
 262                 /* set the link to NULL for all non-const/pure calls */
 263                 set_irn_link(call, NULL);
 264                 ptr = get_Call_ptr(call);
 265                 if (is_SymConst_addr_ent(ptr)) {
 266                         ent = get_SymConst_entity(ptr);
 267
 268                         prop = get_entity_additional_properties(ent);
 269                         if ((prop & mtp_property_nothrow) == 0)
 270                                 return;
 271                         ++ctx->n_calls_SymConst;
 272                 } else if (get_opt_closed_world() &&
 273                            is_Sel(ptr) &&
 274                            get_irg_callee_info_state(get_irn_irg(node)) == irg_callee_info_consistent) {
 275                         /* If all possible callees are nothrow functions, we can remove the exception edge. */
 276                         size_t i, n_callees = get_Call_n_callees(call);
 277                         if (n_callees == 0) {
 278                                 /* This is kind of strange:  dying code or a Call that will raise an exception
 279                                    when executed as there is no implementation to call.  So better not
 280                                    optimize. */
 281                                 return;
 282                         }
 283
 284                         /* note that const function are a subset of pure ones */
 285                         prop = mtp_property_nothrow;
 286                         for (i = 0; i < n_callees; ++i) {
 287                                 ent = get_Call_callee(call, i);
 288                                 if (is_unknown_entity(ent)) {
 289                                         /* we don't know which entity is called here */
 290                                         return;
 291                                 }
 292                                 prop &= get_entity_additional_properties(ent);
 293                                 if (prop == mtp_no_property)
 294                                         return;
 295                         }
 296                         ++ctx->n_calls_Sel;
 297                 } else
 298                         return;
 299
 300                 /* ok, if we get here we found a call to a nothrow function */
 301                 set_irn_link(call, ctx->nothrow_call_list);
 302                 ctx->nothrow_call_list = call;
 303         } else if (is_Proj(node)) {
 304                 /*
 305                  * Collect all memory and exception Proj's from
 306                  * calls.
 307                  */
 308                 call = get_Proj_pred(node);
 309                 if (! is_Call(call))
 310                         return;
 311
 312                 /* collect the Proj's in the Proj list */
 313                 switch (get_Proj_proj(node)) {
 314                 case pn_Call_M:
 315                 case pn_Call_X_except:
 316                 case pn_Call_X_regular:
 317                         set_irn_link(node, ctx->proj_list);
 318                         ctx->proj_list = node;
 319                         break;
 320                 default:
 321                         break;
 322                 }
 323         }
 324 }  /* collect_nothrow_calls */
 325
 326 /**
 327  * Fix the list of collected nothrow Calls.
 328  *
 329  * @param irg        the graph that contained calls to pure functions
 330  * @param call_list  the list of all call sites of const functions
 331  * @param proj_list  the list of all memory/exception Proj's of this call sites
 332  */
 333 static void fix_nothrow_call_list(ir_graph *irg, ir_node *call_list, ir_node *proj_list)
 334 {
 335         ir_node *call, *next, *proj;
 336         int exc_changed = 0;
 337
 338         /* First step: go through the list of calls and mark them. */
 339         for (call = call_list; call; call = next) {
 340                 next = (ir_node*)get_irn_link(call);
 341
 342                 /* current_ir_graph is in memory anyway, so it's a good marker */
 343                 set_irn_link(call, &current_ir_graph);
 344                 hook_func_call(irg, call);
 345         }
 346
 347         /* Second step: Remove all exception Proj's */
 348         for (proj = proj_list; proj; proj = next) {
 349                 next = (ir_node*)get_irn_link(proj);
 350                 call = get_Proj_pred(proj);
 351
 352                 /* handle only marked calls */
 353                 if (get_irn_link(call) != &current_ir_graph)
 354                         continue;
 355
 356                 /* kill any exception flow */
 357                 switch (get_Proj_proj(proj)) {
 358                 case pn_Call_X_except:
 359                         exc_changed = 1;
 360                         exchange(proj, new_r_Bad(irg, mode_X));
 361                         break;
 362                 case pn_Call_X_regular: {
 363                         ir_node *block = get_nodes_block(call);
 364                         exc_changed = 1;
 365                         exchange(proj, new_r_Jmp(block));
 366                         break;
 367                 }
 368                 default:
 369                         break;
 370                 }
 371         }
 372
 373         /* changes were done ... */
 374         if (exc_changed) {
 375                 /* ... including exception edges */
 376                 clear_irg_properties(irg, IR_GRAPH_PROPERTY_CONSISTENT_DOMINANCE
 377                                    | IR_GRAPH_PROPERTY_CONSISTENT_LOOPINFO);
 378         }
 379 }  /* fix_nothrow_call_list */
 380
 381 /* marking */
 382 #define SET_IRG_READY(irg)  rbitset_set(ready_set, get_irg_idx(irg))
 383 #define IS_IRG_READY(irg)   rbitset_is_set(ready_set, get_irg_idx(irg))
 384 #define SET_IRG_BUSY(irg)   rbitset_set(busy_set, get_irg_idx(irg))
 385 #define CLEAR_IRG_BUSY(irg) rbitset_clear(busy_set, get_irg_idx(irg))
 386 #define IS_IRG_BUSY(irg)    rbitset_is_set(busy_set, get_irg_idx(irg))
 387
 388 /* forward */
 389 static mtp_additional_properties check_const_or_pure_function(ir_graph *irg, int top);
 390
 391 /**
 392  * Calculate the bigger property of two. Handle the temporary flag right.
 393  */
 394 static mtp_additional_properties max_property(mtp_additional_properties a,
 395                                               mtp_additional_properties b)
 396 {
 397         mtp_additional_properties r;
 398         mtp_additional_properties t = (a | b) & mtp_temporary;
 399         a &= ~mtp_temporary;
 400         b &= ~mtp_temporary;
 401
 402         if (a == mtp_no_property || b == mtp_no_property)
 403                 return mtp_no_property;
 404         r = a > b ? a : b;
 405         return r | t;
 406 }  /* max_property */
 407
 408 /**
 409  * Follow the memory chain starting at node and determine
 410  * the mtp_property.
 411  *
 412  * @return mtp_property_const if only calls of const functions are detected
 413  *         mtp_property_pure  if only Loads and const/pure calls detected
 414  *         mtp_no_property    else
 415  */
 416 static mtp_additional_properties follow_mem_(ir_node *node)
 417 {
 418         mtp_additional_properties mode = mtp_property_const;
 419         mtp_additional_properties m;
 420         ir_node  *ptr;
 421         int i;
 422
 423         for (;;) {
 424                 if (mode == mtp_no_property)
 425                         return mtp_no_property;
 426
 427                 if (irn_visited_else_mark(node))
 428                         return mode;
 429
 430                 switch (get_irn_opcode(node)) {
 431                 case iro_Proj:
 432                         node = get_Proj_pred(node);
 433                         break;
 434
 435                 case iro_NoMem:
 436                         /* finish here */
 437                         return mode;
 438
 439                 case iro_Phi:
 440                 case iro_Sync:
 441                         /* do a dfs search */
 442                         for (i = get_irn_arity(node) - 1; i >= 0; --i) {
 443                                 m    = follow_mem_(get_irn_n(node, i));
 444                                 mode = max_property(mode, m);
 445                                 if (mode == mtp_no_property)
 446                                         return mtp_no_property;
 447                         }
 448                         return mode;
 449
 450                 case iro_Load:
 451                         /* Beware volatile Loads are NOT allowed in pure functions. */
 452                         if (get_Load_volatility(node) == volatility_is_volatile)
 453                                 return mtp_no_property;
 454                         mode = max_property(mode, mtp_property_pure);
 455                         node = get_Load_mem(node);
 456                         break;
 457
 458                 case iro_Call:
 459                         /* A call is only tolerable if its either constant or pure. */
 460                         ptr = get_Call_ptr(node);
 461                         if (is_SymConst_addr_ent(ptr)) {
 462                                 ir_entity *ent = get_SymConst_entity(ptr);
 463                                 ir_graph  *irg = get_entity_irg(ent);
 464
 465                                 if (irg == NULL) {
 466                                         m = get_entity_additional_properties(ent) & (mtp_property_const|mtp_property_pure);
 467                                         mode = max_property(mode, m);
 468                                 } else {
 469                                         /* we have a graph, analyze it. */
 470                                         m = check_const_or_pure_function(irg, /*top=*/0);
 471                                         mode = max_property(mode, m);
 472                                 }
 473                         } else
 474                                 return mtp_no_property;
 475                         node = get_Call_mem(node);
 476                         break;
 477
 478                 default:
 479                         return mtp_no_property;
 480                 }
 481         }
 482 }
 483
 484 /**
 485  * Follow the memory chain starting at node and determine
 486  * the mtp_property.
 487  *
 488  * @return mtp_property_const if only calls of const functions are detected
 489  *         mtp_property_pure  if only Loads and const/pure calls detected
 490  *         mtp_no_property else
 491  */
 492 static mtp_additional_properties follow_mem(ir_node *node, mtp_additional_properties mode)
 493 {
 494         mtp_additional_properties m = follow_mem_(node);
 495         return max_property(mode, m);
 496 }
 497
 498 /**
 499  * Check if a graph represents a const or a pure function.
 500  *
 501  * @param irg  the graph to check
 502  * @param top  if set, this is the top call
 503  */
 504 static mtp_additional_properties check_const_or_pure_function(ir_graph *irg, int top)
 505 {
 506         ir_node *end, *endbl;
 507         int j;
 508         ir_entity *entity   = get_irg_entity(irg);
 509         ir_type   *type     = get_entity_type(entity);
 510         size_t     n_params = get_method_n_params(type);
 511         size_t     i;
 512         mtp_additional_properties may_be_const = mtp_property_const;
 513         mtp_additional_properties prop = get_irg_additional_properties(irg);
 514
 515         /* libfirm handles aggregate parameters by passing around pointers to
 516          * stuff in memory, so if we have compound parameters we are never const */
 517         for (i = 0; i < n_params; ++i) {
 518                 ir_type *param = get_method_param_type(type, i);
 519                 if (is_compound_type(param)) {
 520                         prop        &= ~mtp_property_const;
 521                         may_be_const = mtp_no_property;
 522                 }
 523         }
 524
 525         if (prop & mtp_property_const) {
 526                 /* already marked as a const function */
 527                 return mtp_property_const;
 528         }
 529         if (prop & mtp_property_pure) {
 530                 /* already marked as a pure function */
 531                 return mtp_property_pure;
 532         }
 533
 534         if (IS_IRG_READY(irg)) {
 535                 /* already checked */
 536                 return mtp_no_property;
 537         }
 538         if (IS_IRG_BUSY(irg)) {
 539                 /* We are still evaluate this method.
 540                  * The function (indirectly) calls itself and thus may not terminate.
 541                  */
 542                 return mtp_no_property;
 543         }
 544         SET_IRG_BUSY(irg);
 545
 546         end   = get_irg_end(irg);
 547         endbl = get_nodes_block(end);
 548         prop  = may_be_const;
 549
 550         ir_reserve_resources(irg, IR_RESOURCE_IRN_VISITED);
 551         inc_irg_visited(irg);
 552         /* mark the initial mem: recursion of follow_mem() stops here */
 553         mark_irn_visited(get_irg_initial_mem(irg));
 554
 555         /* visit every Return */
 556         for (j = get_Block_n_cfgpreds(endbl) - 1; j >= 0; --j) {
 557                 ir_node   *node = get_Block_cfgpred(endbl, j);
 558                 unsigned   code = get_irn_opcode(node);
 559                 ir_node   *mem;
 560
 561                 /* Bad nodes usually do NOT produce anything, so it's ok */
 562                 if (code == iro_Bad)
 563                         continue;
 564
 565                 if (code == iro_Return) {
 566                         mem = get_Return_mem(node);
 567
 568                         /* Bad nodes usually do NOT produce anything, so it's ok */
 569                         if (is_Bad(mem))
 570                                 continue;
 571
 572                         if (mem != get_irg_initial_mem(irg))
 573                                 prop = max_property(prop, follow_mem(mem, prop));
 574                 } else {
 575                         /* Exception found. Cannot be const or pure. */
 576                         prop = mtp_no_property;
 577                         break;
 578                 }
 579                 if (prop == mtp_no_property)
 580                         break;
 581         }
 582
 583         if (prop != mtp_no_property) {
 584                 /* check, if a keep-alive exists */
 585                 for (j = get_End_n_keepalives(end) - 1; j >= 0; --j) {
 586                         ir_node *kept = get_End_keepalive(end, j);
 587
 588                         if (is_Block(kept)) {
 589                                 prop = mtp_no_property;
 590                                 break;
 591                         }
 592
 593                         if (mode_M != get_irn_mode(kept))
 594                                 continue;
 595
 596                         prop = max_property(prop, follow_mem(kept, prop));
 597                         if (prop == mtp_no_property)
 598                                 break;
 599                 }
 600         }
 601
 602         if (top) {
 603                 /* Set the property only if we are at top-level. */
 604                 if (prop != mtp_no_property) {
 605                         add_irg_additional_properties(irg, prop);
 606                 }
 607                 SET_IRG_READY(irg);
 608         }
 609         CLEAR_IRG_BUSY(irg);
 610         ir_free_resources(irg, IR_RESOURCE_IRN_VISITED);
 611         return prop;
 612 }  /* check_const_or_pure_function */
 613
 614 /**
 615  * Handle calls to const functions.
 616  *
 617  * @param ctx  context
 618  */
 619 static void handle_const_Calls(env_t *ctx)
 620 {
 621         size_t i, n;
 622
 623         ctx->n_calls_SymConst = 0;
 624         ctx->n_calls_Sel      = 0;
 625
 626         /* all calls of const functions can be transformed */
 627         for (i = 0, n = get_irp_n_irgs(); i < n; ++i) {
 628                 ir_graph *irg  = get_irp_irg(i);
 629
 630                 ctx->float_const_call_list    = NULL;
 631                 ctx->nonfloat_const_call_list = NULL;
 632                 ctx->pure_call_list           = NULL;
 633                 ctx->proj_list                = NULL;
 634
 635                 ir_reserve_resources(irg, IR_RESOURCE_IRN_LINK);
 636                 irg_walk_graph(irg, NULL, collect_const_and_pure_calls, ctx);
 637
 638                 if (ctx->float_const_call_list != NULL)
 639                         fix_const_call_lists(irg, ctx);
 640                 ir_free_resources(irg, IR_RESOURCE_IRN_LINK);
 641
 642                 confirm_irg_properties(irg,
 643                         IR_GRAPH_PROPERTIES_CONTROL_FLOW
 644                         | IR_GRAPH_PROPERTY_ONE_RETURN
 645                         | IR_GRAPH_PROPERTY_MANY_RETURNS);
 646         }
 647 }
 648
 649 /**
 650  * Handle calls to nothrow functions.
 651  *
 652  * @param ctx  context
 653  */
 654 static void handle_nothrow_Calls(env_t *ctx)
 655 {
 656         size_t i, n;
 657
 658         ctx->n_calls_SymConst = 0;
 659         ctx->n_calls_Sel      = 0;
 660
 661         /* all calls of const functions can be transformed */
 662         for (i = 0, n = get_irp_n_irgs(); i < n; ++i) {
 663                 ir_graph *irg  = get_irp_irg(i);
 664
 665                 ctx->nothrow_call_list = NULL;
 666                 ctx->proj_list         = NULL;
 667
 668                 ir_reserve_resources(irg, IR_RESOURCE_IRN_LINK);
 669                 irg_walk_graph(irg, NULL, collect_nothrow_calls, ctx);
 670
 671                 if (ctx->nothrow_call_list)
 672                         fix_nothrow_call_list(irg, ctx->nothrow_call_list, ctx->proj_list);
 673                 ir_free_resources(irg, IR_RESOURCE_IRN_LINK);
 674         }
 675 }
 676
 677 /**
 678  * Check, whether a given node represents a return value of
 679  * a malloc like function (ie, new heap allocated memory).
 680  *
 681  * @param node  the node to check
 682  */
 683 static int is_malloc_call_result(const ir_node *node)
 684 {
 685         if (is_Alloc(node) && get_Alloc_where(node) == heap_alloc) {
 686                 /* Firm style high-level allocation */
 687                 return 1;
 688         }
 689         /* TODO: check mtp_malloc */
 690         return 0;
 691 }
 692
 693 /**
 694  * Update a property depending on a call property.
 695  */
 696 static mtp_additional_properties update_property(mtp_additional_properties orig_prop, mtp_additional_properties call_prop)
 697 {
 698         mtp_additional_properties t = (orig_prop | call_prop) & mtp_temporary;
 699         mtp_additional_properties r = orig_prop & call_prop;
 700         return r | t;
 701 }
 702
 703 /**
 704  * Check if a node is stored.
 705  */
 706 static bool is_stored(const ir_node *n)
 707 {
 708         const ir_node *ptr;
 709
 710         foreach_out_edge(n, edge) {
 711                 const ir_node *succ = get_edge_src_irn(edge);
 712
 713                 switch (get_irn_opcode(succ)) {
 714                 case iro_Return:
 715                 case iro_Load:
 716                 case iro_Cmp:
 717                         /* ok */
 718                         break;
 719                 case iro_Store:
 720                         if (get_Store_value(succ) == n)
 721                                 return true;
 722                         /* ok if its only the address input */
 723                         break;
 724                 case iro_Sel:
 725                 case iro_Cast:
 726                 case iro_Confirm:
 727                         if (is_stored(succ))
 728                                 return true;
 729                         break;
 730                 case iro_Call:
 731                         ptr = get_Call_ptr(succ);
 732                         if (is_SymConst_addr_ent(ptr)) {
 733                                 ir_entity *ent = get_SymConst_entity(ptr);
 734                                 size_t    i;
 735
 736                                 /* we know the called entity */
 737                                 for (i = get_Call_n_params(succ); i > 0;) {
 738                                         if (get_Call_param(succ, --i) == n) {
 739                                                 /* n is the i'th param of the call */
 740                                                 if (get_method_param_access(ent, i) & ptr_access_store) {
 741                                                         /* n is store in ent */
 742                                                         return true;
 743                                                 }
 744                                         }
 745                                 }
 746                         } else {
 747                                 /* unknown call address */
 748                                 return true;
 749                         }
 750                         break;
 751                 default:
 752                         /* bad, potential alias */
 753                         return true;
 754                 }
 755         }
 756         return false;
 757 }
 758
 759 /**
 760  * Check that the return value of an irg is not stored anywhere.
 761  *
 762  * return ~mtp_property_malloc if return values are stored, ~0 else
 763  */
 764 static mtp_additional_properties check_stored_result(ir_graph *irg)
 765 {
 766         ir_node  *end_blk = get_irg_end_block(irg);
 767         int      i;
 768         mtp_additional_properties res = ~mtp_no_property;
 769
 770         assure_irg_properties(irg, IR_GRAPH_PROPERTY_CONSISTENT_OUT_EDGES);
 771
 772         for (i = get_Block_n_cfgpreds(end_blk) - 1; i >= 0; --i) {
 773                 ir_node *pred = get_Block_cfgpred(end_blk, i);
 774                 size_t  j;
 775
 776                 if (! is_Return(pred))
 777                         continue;
 778                 for (j = get_Return_n_ress(pred); j > 0;) {
 779                         const ir_node *irn = get_Return_res(pred, --j);
 780
 781                         if (is_stored(irn)) {
 782                                 /* bad, might create an alias */
 783                                 res = ~mtp_property_malloc;
 784                                 goto finish;
 785                         }
 786                 }
 787         }
 788 finish:
 789         confirm_irg_properties(irg, IR_GRAPH_PROPERTIES_ALL);
 790         return res;
 791 }
 792
 793 /**
 794  * Check if a graph represents a nothrow or a malloc function.
 795  *
 796  * @param irg  the graph to check
 797  * @param top  if set, this is the top call
 798  */
 799 static mtp_additional_properties check_nothrow_or_malloc(ir_graph *irg, int top)
 800 {
 801         mtp_additional_properties curr_prop = mtp_property_malloc | mtp_property_nothrow;
 802         ir_node                  *end_blk   = get_irg_end_block(irg);
 803         ir_entity *ent;
 804         ir_type   *mtp;
 805         int       i;
 806
 807         if (IS_IRG_READY(irg)) {
 808                 /* already checked */
 809                 return get_irg_additional_properties(irg);
 810         }
 811         if (IS_IRG_BUSY(irg)) {
 812                 /* we are still evaluate this method. Be optimistic,
 813                 return the best possible so far but mark the result as temporary. */
 814                 return mtp_temporary | mtp_property_malloc | mtp_property_nothrow;
 815         }
 816         SET_IRG_BUSY(irg);
 817
 818         ent = get_irg_entity(irg);
 819         mtp = get_entity_type(ent);
 820
 821         if (get_method_n_ress(mtp) <= 0)
 822                 curr_prop &= ~mtp_property_malloc;
 823
 824         for (i = get_Block_n_cfgpreds(end_blk) - 1; i >= 0; --i) {
 825                 ir_node *pred = get_Block_cfgpred(end_blk, i);
 826
 827                 if (is_Return(pred)) {
 828                         if (curr_prop & mtp_property_malloc) {
 829                                 size_t j;
 830
 831                                 /* check, if malloc is called here */
 832                                 for (j = get_Return_n_ress(pred); j > 0;) {
 833                                         ir_node *res = get_Return_res(pred, --j);
 834
 835                                         /* skip Confirms and Casts */
 836                                         res = skip_HighLevel_ops(res);
 837                                         /* skip Proj's */
 838                                         while (is_Proj(res))
 839                                                 res = get_Proj_pred(res);
 840                                         if (is_malloc_call_result(res)) {
 841                                                 /* ok, this is a malloc */
 842                                         } else if (is_Call(res)) {
 843                                                 ir_node *ptr = get_Call_ptr(res);
 844
 845                                                 if (is_SymConst_addr_ent(ptr)) {
 846                                                         /* a direct call */
 847                                                         ir_entity *ent    = get_SymConst_entity(ptr);
 848                                                         ir_graph  *callee = get_entity_irg(ent);
 849
 850                                                         if (callee == irg) {
 851                                                                 /* A self-recursive call. The property did not depend on this call. */
 852                                                         } else if (callee != NULL) {
 853                                                                 mtp_additional_properties prop = check_nothrow_or_malloc(callee, /*top=*/0);
 854                                                                 curr_prop = update_property(curr_prop, prop);
 855                                                         } else {
 856                                                                 curr_prop = update_property(curr_prop, get_entity_additional_properties(ent));
 857                                                         }
 858                                                 } else if (get_opt_closed_world() &&
 859                                                            is_Sel(ptr) &&
 860                                                            get_irg_callee_info_state(irg) == irg_callee_info_consistent) {
 861                                                         /* check if all possible callees are malloc functions. */
 862                                                         size_t i, n_callees = get_Call_n_callees(res);
 863                                                         if (n_callees == 0) {
 864                                                                 /* This is kind of strange:  dying code or a Call that will raise an exception
 865                                                                    when executed as there is no implementation to call.  So better not
 866                                                                    optimize. */
 867                                                                 curr_prop &= ~mtp_property_malloc;
 868                                                                 continue;
 869                                                         }
 870
 871                                                         for (i = 0; i < n_callees; ++i) {
 872                                                                 ir_entity *ent = get_Call_callee(res, i);
 873                                                                 if (is_unknown_entity(ent)) {
 874                                                                         /* we don't know which entity is called here */
 875                                                                         curr_prop &= ~mtp_property_malloc;
 876                                                                         break;
 877                                                                 }
 878                                                                 if ((get_entity_additional_properties(ent) & mtp_property_malloc) == 0) {
 879                                                                         curr_prop &= ~mtp_property_malloc;
 880                                                                         break;
 881                                                                 }
 882                                                         }
 883                                                         /* if we pass the for cycle, malloc is still ok */
 884                                                 } else {
 885                                                         /* unknown call */
 886                                                         curr_prop &= ~mtp_property_malloc;
 887                                                 }
 888                                         } else {
 889                                                 /* unknown return value */
 890                                                 curr_prop &= ~mtp_property_malloc;
 891                                         }
 892                                 }
 893                         }
 894                 } else if (curr_prop & mtp_property_nothrow) {
 895                         /* exception flow detected */
 896                         pred = skip_Proj(pred);
 897
 898                         if (is_Call(pred)) {
 899                                 ir_node *ptr = get_Call_ptr(pred);
 900
 901                                 if (is_SymConst_addr_ent(ptr)) {
 902                                         /* a direct call */
 903                                         ir_entity *ent    = get_SymConst_entity(ptr);
 904                                         ir_graph  *callee = get_entity_irg(ent);
 905
 906                                         if (callee == irg) {
 907                                                 /* A self-recursive call. The property did not depend on this call. */
 908                                         } else if (callee != NULL) {
 909                                                 /* Note: we check here for nothrow only, so do NOT reset the malloc property */
 910                                                 mtp_additional_properties prop = check_nothrow_or_malloc(callee, /*top=*/0) | mtp_property_malloc;
 911                                                 curr_prop = update_property(curr_prop, prop);
 912                                         } else {
 913                                                 if ((get_entity_additional_properties(ent) & mtp_property_nothrow) == 0)
 914                                                         curr_prop &= ~mtp_property_nothrow;
 915                                         }
 916                                 } else if (get_opt_closed_world() &&
 917                                            is_Sel(ptr) &&
 918                                            get_irg_callee_info_state(irg) == irg_callee_info_consistent) {
 919                                         /* check if all possible callees are nothrow functions. */
 920                                         size_t i, n_callees = get_Call_n_callees(pred);
 921                                         if (n_callees == 0) {
 922                                                 /* This is kind of strange:  dying code or a Call that will raise an exception
 923                                                    when executed as there is no implementation to call.  So better not
 924                                                    optimize. */
 925                                                 curr_prop &= ~mtp_property_nothrow;
 926                                                 continue;
 927                                         }
 928
 929                                         for (i = 0; i < n_callees; ++i) {
 930                                                 ir_entity *ent = get_Call_callee(pred, i);
 931                                                 if (is_unknown_entity(ent)) {
 932                                                         /* we don't know which entity is called here */
 933                                                         curr_prop &= ~mtp_property_nothrow;
 934                                                         break;
 935                                                 }
 936                                                 if ((get_entity_additional_properties(ent) & mtp_property_nothrow) == 0) {
 937                                                         curr_prop &= ~mtp_property_nothrow;
 938                                                         break;
 939                                                 }
 940                                         }
 941                                         /* if we pass the for cycle, nothrow is still ok */
 942                                 } else {
 943                                         /* unknown call */
 944                                         curr_prop &= ~mtp_property_nothrow;
 945                                 }
 946                         } else {
 947                                 /* real exception flow possible. */
 948                                 curr_prop &= ~mtp_property_nothrow;
 949                         }
 950                 }
 951                 if ((curr_prop & ~mtp_temporary) == mtp_no_property) {
 952                         /* no need to search further */
 953                         break;
 954                 }
 955         }
 956
 957         if (curr_prop & mtp_property_malloc) {
 958                 /*
 959                  * Note that the malloc property means not only return newly allocated
 960                  * memory, but also that this memory is ALIAS FREE.
 961                  * To ensure that, we do NOT allow that the returned memory is somewhere
 962                  * stored.
 963              */
 964                 curr_prop &= check_stored_result(irg);
 965         }
 966
 967         if (curr_prop != mtp_no_property) {
 968                 if (top || (curr_prop & mtp_temporary) == 0) {
 969                         /* We use the temporary flag here to mark an optimistic result.
 970                            Set the property only if we are sure that it does NOT base on
 971                            temporary results OR if we are at top-level. */
 972                         add_irg_additional_properties(irg, curr_prop & ~mtp_temporary);
 973                         SET_IRG_READY(irg);
 974                 }
 975         }
 976         if (top)
 977                 SET_IRG_READY(irg);
 978         CLEAR_IRG_BUSY(irg);
 979         return curr_prop;
 980 }  /* check_nothrow_or_malloc */
 981
 982 /**
 983  * When a function was detected as "const", it might be moved out of loops.
 984  * This might be dangerous if the graph can contain endless loops.
 985  */
 986 static void check_for_possible_endless_loops(ir_graph *irg)
 987 {
 988         ir_loop *root_loop;
 989         assure_irg_properties(irg, IR_GRAPH_PROPERTY_CONSISTENT_LOOPINFO);
 990
 991         root_loop = get_irg_loop(irg);
 992         if (root_loop->flags & loop_outer_loop)
 993                 add_irg_additional_properties(irg, mtp_property_has_loop);
 994
 995         confirm_irg_properties(irg, IR_GRAPH_PROPERTIES_ALL);
 996 }
 997
 998 /*
 999  * optimize function calls by handling const functions
1000  */
1001 void optimize_funccalls(void)
1002 {
1003         size_t i, n;
1004         size_t last_idx;
1005         env_t  ctx;
1006         size_t num_const   = 0;
1007         size_t num_pure    = 0;
1008         size_t num_nothrow = 0;
1009         size_t num_malloc  = 0;
1010
1011         /* prepare: mark all graphs as not analyzed */
1012         last_idx  = get_irp_last_idx();
1013         ready_set = rbitset_malloc(last_idx);
1014         busy_set  = rbitset_malloc(last_idx);
1015
1016         /* first step: detect, which functions are nothrow or malloc */
1017         DB((dbg, LEVEL_2, "Detecting nothrow and malloc properties ...\n"));
1018         for (i = 0, n = get_irp_n_irgs(); i < n; ++i) {
1019                 ir_graph *irg = get_irp_irg(i);
1020                 unsigned prop = check_nothrow_or_malloc(irg, /*top=*/1);
1021
1022                 if (prop & mtp_property_nothrow) {
1023                         ++num_nothrow;
1024                         DB((dbg, LEVEL_2, "%+F has the nothrow property\n", irg));
1025                 } else if (prop & mtp_property_malloc) {
1026                         ++num_malloc;
1027                         DB((dbg, LEVEL_2, "%+F has the malloc property\n", irg));
1028                 }
1029         }
1030
1031         /* second step: remove exception edges: this must be done before the
1032            detection of const and pure functions take place. */
1033         handle_nothrow_Calls(&ctx);
1034         DB((dbg, LEVEL_1, "Detected %zu nothrow graphs, %zu malloc graphs.\n", num_nothrow, num_malloc));
1035         DB((dbg, LEVEL_1, "Optimizes %zu(SymConst) + %zu(Sel) calls to nothrow functions.\n",
1036                 ctx.n_calls_SymConst, ctx.n_calls_Sel));
1037
1038         rbitset_clear_all(ready_set, last_idx);
1039         rbitset_clear_all(busy_set, last_idx);
1040
1041         /* third step: detect, which functions are const or pure */
1042         DB((dbg, LEVEL_2, "Detecting const and pure properties ...\n"));
1043         for (i = 0, n = get_irp_n_irgs(); i < n; ++i) {
1044                 ir_graph *irg = get_irp_irg(i);
1045                 unsigned prop = check_const_or_pure_function(irg, /*top=*/1);
1046
1047                 if (prop & mtp_property_const) {
1048                         ++num_const;
1049                         DB((dbg, LEVEL_2, "%+F has the const property\n", irg));
1050                         check_for_possible_endless_loops(irg);
1051                 } else if (prop & mtp_property_pure) {
1052                         ++num_pure;
1053                         DB((dbg, LEVEL_2, "%+F has the pure property\n", irg));
1054                 }
1055         }
1056
1057         handle_const_Calls(&ctx);
1058         DB((dbg, LEVEL_1, "Detected %zu const graphs, %zu pure graphs.\n",
1059             num_const, num_pure));
1060         DB((dbg, LEVEL_1, "Optimizes %u(SymConst) + %u(Sel) calls to const functions.\n",
1061             ctx.n_calls_SymConst, ctx.n_calls_Sel));
1062
1063         xfree(busy_set);
1064         xfree(ready_set);
1065 }
1066
1067 /* initialize the funccall optimization */
1068 void firm_init_funccalls(void)
1069 {
1070         FIRM_DBG_REGISTER(dbg, "firm.opt.funccalls");
1071 }
1072
1073 /* Creates an ir_prog pass for optimize_funccalls. */
1074 ir_prog_pass_t *optimize_funccalls_pass(const char *name)
1075 {
1076         return def_prog_pass(name ? name : "funccall", optimize_funccalls);
1077 }