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  * @version $Id$
  25  */
  26 #include "config.h"
  27
  28 #include "opt_init.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_Global(ptr)) {
  93                         ent = get_Global_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                         int 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 (ent == unknown_entity) {
 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, get_irg_bad(irg));
 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         /* changes were done ... */
 242         set_irg_outs_inconsistent(irg);
 243         set_irg_loopinfo_state(irg, loopinfo_cf_inconsistent);
 244
 245         if (exc_changed) {
 246                 /* ... including exception edges */
 247                 set_irg_doms_inconsistent(irg);
 248         }
 249 }  /* fix_const_call_list */
 250
 251 /**
 252  * Walker: Collect all calls to nothrow functions
 253  * to lists. Collect all Proj(Call) nodes into a Proj list.
 254  */
 255 static void collect_nothrow_calls(ir_node *node, void *env)
 256 {
 257         env_t *ctx = (env_t*)env;
 258         ir_node *call, *ptr;
 259         ir_entity *ent;
 260         unsigned prop;
 261
 262         if (is_Call(node)) {
 263                 call = node;
 264
 265                 /* set the link to NULL for all non-const/pure calls */
 266                 set_irn_link(call, NULL);
 267                 ptr = get_Call_ptr(call);
 268                 if (is_Global(ptr)) {
 269                         ent = get_Global_entity(ptr);
 270
 271                         prop = get_entity_additional_properties(ent);
 272                         if ((prop & mtp_property_nothrow) == 0)
 273                                 return;
 274                         ++ctx->n_calls_SymConst;
 275                 } else if (get_opt_closed_world() &&
 276                            is_Sel(ptr) &&
 277                            get_irg_callee_info_state(get_irn_irg(node)) == irg_callee_info_consistent) {
 278                         /* If all possible callees are nothrow functions, we can remove the exception edge. */
 279                         int i, n_callees = get_Call_n_callees(call);
 280                         if (n_callees == 0) {
 281                                 /* This is kind of strange:  dying code or a Call that will raise an exception
 282                                    when executed as there is no implementation to call.  So better not
 283                                    optimize. */
 284                                 return;
 285                         }
 286
 287                         /* note that const function are a subset of pure ones */
 288                         prop = mtp_property_nothrow;
 289                         for (i = 0; i < n_callees; ++i) {
 290                                 ent = get_Call_callee(call, i);
 291                                 if (ent == unknown_entity) {
 292                                         /* we don't know which entity is called here */
 293                                         return;
 294                                 }
 295                                 prop &= get_entity_additional_properties(ent);
 296                                 if (prop == mtp_no_property)
 297                                         return;
 298                         }
 299                         ++ctx->n_calls_Sel;
 300                 } else
 301                         return;
 302
 303                 /* ok, if we get here we found a call to a nothrow function */
 304                 set_irn_link(call, ctx->nothrow_call_list);
 305                 ctx->nothrow_call_list = call;
 306         } else if (is_Proj(node)) {
 307                 /*
 308                  * Collect all memory and exception Proj's from
 309                  * calls.
 310                  */
 311                 call = get_Proj_pred(node);
 312                 if (! is_Call(call))
 313                         return;
 314
 315                 /* collect the Proj's in the Proj list */
 316                 switch (get_Proj_proj(node)) {
 317                 case pn_Call_M:
 318                 case pn_Call_X_except:
 319                 case pn_Call_X_regular:
 320                         set_irn_link(node, ctx->proj_list);
 321                         ctx->proj_list = node;
 322                         break;
 323                 default:
 324                         break;
 325                 }
 326         }
 327 }  /* collect_nothrow_calls */
 328
 329 /**
 330  * Fix the list of collected nothrow Calls.
 331  *
 332  * @param irg        the graph that contained calls to pure functions
 333  * @param call_list  the list of all call sites of const functions
 334  * @param proj_list  the list of all memory/exception Proj's of this call sites
 335  */
 336 static void fix_nothrow_call_list(ir_graph *irg, ir_node *call_list, ir_node *proj_list)
 337 {
 338         ir_node *call, *next, *proj;
 339         int exc_changed = 0;
 340
 341         /* First step: go through the list of calls and mark them. */
 342         for (call = call_list; call; call = next) {
 343                 next = (ir_node*)get_irn_link(call);
 344
 345                 /* current_ir_graph is in memory anyway, so it's a good marker */
 346                 set_irn_link(call, &current_ir_graph);
 347                 hook_func_call(irg, call);
 348         }
 349
 350         /* Second step: Remove all exception Proj's */
 351         for (proj = proj_list; proj; proj = next) {
 352                 next = (ir_node*)get_irn_link(proj);
 353                 call = get_Proj_pred(proj);
 354
 355                 /* handle only marked calls */
 356                 if (get_irn_link(call) != &current_ir_graph)
 357                         continue;
 358
 359                 /* kill any exception flow */
 360                 switch (get_Proj_proj(proj)) {
 361                 case pn_Call_X_except:
 362                         exc_changed = 1;
 363                         exchange(proj, get_irg_bad(irg));
 364                         break;
 365                 case pn_Call_X_regular: {
 366                         ir_node *block = get_nodes_block(call);
 367                         exc_changed = 1;
 368                         exchange(proj, new_r_Jmp(block));
 369                         break;
 370                 }
 371                 default:
 372                         break;
 373                 }
 374         }
 375
 376         /* changes were done ... */
 377         set_irg_outs_inconsistent(irg);
 378         set_irg_loopinfo_state(irg, loopinfo_cf_inconsistent);
 379
 380         if (exc_changed) {
 381                 /* ... including exception edges */
 382                 set_irg_doms_inconsistent(irg);
 383         }
 384 }  /* fix_nothrow_call_list */
 385
 386 /* marking */
 387 #define SET_IRG_READY(irg)  rbitset_set(ready_set, get_irg_idx(irg))
 388 #define IS_IRG_READY(irg)   rbitset_is_set(ready_set, get_irg_idx(irg))
 389 #define SET_IRG_BUSY(irg)   rbitset_set(busy_set, get_irg_idx(irg))
 390 #define CLEAR_IRG_BUSY(irg) rbitset_clear(busy_set, get_irg_idx(irg))
 391 #define IS_IRG_BUSY(irg)    rbitset_is_set(busy_set, get_irg_idx(irg))
 392
 393 /* forward */
 394 static mtp_additional_properties check_const_or_pure_function(ir_graph *irg, int top);
 395
 396 /**
 397  * Calculate the bigger property of two. Handle the temporary flag right.
 398  */
 399 static mtp_additional_properties max_property(mtp_additional_properties a,
 400                                               mtp_additional_properties b)
 401 {
 402         mtp_additional_properties r;
 403         mtp_additional_properties t = (a | b) & mtp_temporary;
 404         a &= ~mtp_temporary;
 405         b &= ~mtp_temporary;
 406
 407         if (a == mtp_no_property || b == mtp_no_property)
 408                 return mtp_no_property;
 409         r = a > b ? a : b;
 410         return r | t;
 411 }  /* max_property */
 412
 413 /**
 414  * Follow the memory chain starting at node and determine
 415  * the mtp_property.
 416  *
 417  * @return mtp_property_const if only calls of const functions are detected
 418  *         mtp_property_pure  if only Loads and const/pure calls detected
 419  *         mtp_no_property    else
 420  */
 421 static mtp_additional_properties follow_mem_(ir_node *node)
 422 {
 423         mtp_additional_properties mode = mtp_property_const;
 424         mtp_additional_properties m;
 425         ir_node  *ptr;
 426         int i;
 427
 428         for (;;) {
 429                 if (mode == mtp_no_property)
 430                         return mtp_no_property;
 431
 432                 if (irn_visited_else_mark(node))
 433                         return mode;
 434
 435                 switch (get_irn_opcode(node)) {
 436                 case iro_Proj:
 437                         node = get_Proj_pred(node);
 438                         break;
 439
 440                 case iro_NoMem:
 441                         /* finish here */
 442                         return mode;
 443
 444                 case iro_Phi:
 445                 case iro_Sync:
 446                         /* do a dfs search */
 447                         for (i = get_irn_arity(node) - 1; i >= 0; --i) {
 448                                 m    = follow_mem_(get_irn_n(node, i));
 449                                 mode = max_property(mode, m);
 450                                 if (mode == mtp_no_property)
 451                                         return mtp_no_property;
 452                         }
 453                         return mode;
 454
 455                 case iro_Load:
 456                         /* Beware volatile Loads are NOT allowed in pure functions. */
 457                         if (get_Load_volatility(node) == volatility_is_volatile)
 458                                 return mtp_no_property;
 459                         mode = max_property(mode, mtp_property_pure);
 460                         node = get_Load_mem(node);
 461                         break;
 462
 463                 case iro_Call:
 464                         /* A call is only tolerable if its either constant or pure. */
 465                         ptr = get_Call_ptr(node);
 466                         if (is_SymConst_addr_ent(ptr)) {
 467                                 ir_entity *ent = get_SymConst_entity(ptr);
 468                                 ir_graph  *irg = get_entity_irg(ent);
 469
 470                                 if (irg == get_irn_irg(node)) {
 471                                         /* A self-recursive call. The property did not depend on this call. */
 472                                 } else if (irg == NULL) {
 473                                         m = get_entity_additional_properties(ent) & (mtp_property_const|mtp_property_pure);
 474                                         mode = max_property(mode, m);
 475                                 } else if (irg != NULL) {
 476                                         /* we have a graph, analyze it. */
 477                                         m = check_const_or_pure_function(irg, /*top=*/0);
 478                                         mode = max_property(mode, m);
 479                                 }
 480                         } else
 481                                 return mtp_no_property;
 482                         node = get_Call_mem(node);
 483                         break;
 484
 485                 default:
 486                         return mtp_no_property;
 487                 }
 488         }
 489 }
 490
 491 /**
 492  * Follow the memory chain starting at node and determine
 493  * the mtp_property.
 494  *
 495  * @return mtp_property_const if only calls of const functions are detected
 496  *         mtp_property_pure  if only Loads and const/pure calls detected
 497  *         mtp_no_property else
 498  */
 499 static mtp_additional_properties follow_mem(ir_node *node, mtp_additional_properties mode)
 500 {
 501         mtp_additional_properties m = follow_mem_(node);
 502         return max_property(mode, m);
 503 }
 504
 505 /**
 506  * Check if a graph represents a const or a pure function.
 507  *
 508  * @param irg  the graph to check
 509  * @param top  if set, this is the top call
 510  */
 511 static mtp_additional_properties check_const_or_pure_function(ir_graph *irg, int top)
 512 {
 513         ir_node *end, *endbl;
 514         int j;
 515         mtp_additional_properties prop = get_irg_additional_properties(irg);
 516
 517         if (prop & mtp_property_const) {
 518                 /* already marked as a const function */
 519                 return mtp_property_const;
 520         }
 521         if (prop & mtp_property_pure) {
 522                 /* already marked as a pure function */
 523                 return mtp_property_pure;
 524         }
 525
 526         if (IS_IRG_READY(irg)) {
 527                 /* already checked */
 528                 return mtp_no_property;
 529         }
 530         if (IS_IRG_BUSY(irg)) {
 531                 /* we are still evaluate this method. Be optimistic,
 532                    return the best possible so far but mark the result as temporary. */
 533                 return mtp_temporary | mtp_property_const;
 534         }
 535         SET_IRG_BUSY(irg);
 536
 537         end   = get_irg_end(irg);
 538         endbl = get_nodes_block(end);
 539         prop  = mtp_property_const;
 540
 541         ir_reserve_resources(irg, IR_RESOURCE_IRN_VISITED);
 542         inc_irg_visited(irg);
 543         /* mark the initial mem: recursion of follow_mem() stops here */
 544         mark_irn_visited(get_irg_initial_mem(irg));
 545
 546         /* visit every Return */
 547         for (j = get_Block_n_cfgpreds(endbl) - 1; j >= 0; --j) {
 548                 ir_node   *node = get_Block_cfgpred(endbl, j);
 549                 unsigned   code = get_irn_opcode(node);
 550                 ir_node   *mem;
 551
 552                 /* Bad nodes usually do NOT produce anything, so it's ok */
 553                 if (code == iro_Bad)
 554                         continue;
 555
 556                 if (code == iro_Return) {
 557                         mem = get_Return_mem(node);
 558
 559                         /* Bad nodes usually do NOT produce anything, so it's ok */
 560                         if (is_Bad(mem))
 561                                 continue;
 562
 563                         if (mem != get_irg_initial_mem(irg))
 564                                 prop = max_property(prop, follow_mem(mem, prop));
 565                 } else {
 566                         /* Exception found. Cannot be const or pure. */
 567                         prop = mtp_no_property;
 568                         break;
 569                 }
 570                 if (prop == mtp_no_property)
 571                         break;
 572         }
 573
 574         if (prop != mtp_no_property) {
 575                 /* check, if a keep-alive exists */
 576                 for (j = get_End_n_keepalives(end) - 1; j >= 0; --j) {
 577                         ir_node *kept = get_End_keepalive(end, j);
 578
 579                         if (is_Block(kept)) {
 580                                 prop = mtp_no_property;
 581                                 break;
 582                         }
 583
 584                         if (mode_M != get_irn_mode(kept))
 585                                 continue;
 586
 587                         prop = max_property(prop, follow_mem(kept, prop));
 588                         if (prop == mtp_no_property)
 589                                 break;
 590                 }
 591         }
 592
 593         if (prop != mtp_no_property) {
 594                 if (top || (prop & mtp_temporary) == 0) {
 595                         /* We use the temporary flag here to mark optimistic result.
 596                            Set the property only if we are sure that it does NOT base on
 597                            temporary results OR if we are at top-level. */
 598                         add_irg_additional_properties(irg, prop & ~mtp_temporary);
 599                         SET_IRG_READY(irg);
 600                 }
 601         }
 602         if (top)
 603                 SET_IRG_READY(irg);
 604         CLEAR_IRG_BUSY(irg);
 605         ir_free_resources(irg, IR_RESOURCE_IRN_VISITED);
 606         return prop;
 607 }  /* check_const_or_pure_function */
 608
 609 /**
 610  * Handle calls to const functions.
 611  *
 612  * @param ctx  context
 613  */
 614 static void handle_const_Calls(env_t *ctx)
 615 {
 616         size_t i, n;
 617
 618         ctx->n_calls_SymConst = 0;
 619         ctx->n_calls_Sel      = 0;
 620
 621         /* all calls of const functions can be transformed */
 622         for (i = 0, n = get_irp_n_irgs(); i < n; ++i) {
 623                 ir_graph *irg  = get_irp_irg(i);
 624
 625                 ctx->float_const_call_list    = NULL;
 626                 ctx->nonfloat_const_call_list = NULL;
 627                 ctx->pure_call_list           = NULL;
 628                 ctx->proj_list                = NULL;
 629
 630                 ir_reserve_resources(irg, IR_RESOURCE_IRN_LINK);
 631                 irg_walk_graph(irg, NULL, collect_const_and_pure_calls, ctx);
 632
 633                 if (ctx->float_const_call_list != NULL)
 634                         fix_const_call_lists(irg, ctx);
 635                 ir_free_resources(irg, IR_RESOURCE_IRN_LINK);
 636         }
 637 }  /* handle_const_Calls */
 638
 639 /**
 640  * Handle calls to nothrow functions.
 641  *
 642  * @param ctx  context
 643  */
 644 static void handle_nothrow_Calls(env_t *ctx)
 645 {
 646         size_t i, n;
 647
 648         ctx->n_calls_SymConst = 0;
 649         ctx->n_calls_Sel      = 0;
 650
 651         /* all calls of const functions can be transformed */
 652         for (i = 0, n = get_irp_n_irgs(); i < n; ++i) {
 653                 ir_graph *irg  = get_irp_irg(i);
 654
 655                 ctx->nothrow_call_list = NULL;
 656                 ctx->proj_list         = NULL;
 657
 658                 ir_reserve_resources(irg, IR_RESOURCE_IRN_LINK);
 659                 irg_walk_graph(irg, NULL, collect_nothrow_calls, ctx);
 660
 661                 if (ctx->nothrow_call_list)
 662                         fix_nothrow_call_list(irg, ctx->nothrow_call_list, ctx->proj_list);
 663                 ir_free_resources(irg, IR_RESOURCE_IRN_LINK);
 664         }
 665 }
 666
 667 /**
 668  * Check, whether a given node represents a return value of
 669  * a malloc like function (ie, new heap allocated memory).
 670  *
 671  * @param node  the node to check
 672  */
 673 static int is_malloc_call_result(const ir_node *node)
 674 {
 675         if (is_Alloc(node) && get_Alloc_where(node) == heap_alloc) {
 676                 /* Firm style high-level allocation */
 677                 return 1;
 678         }
 679         /* TODO: check mtp_malloc */
 680         return 0;
 681 }
 682
 683 /**
 684  * Update a property depending on a call property.
 685  */
 686 static mtp_additional_properties update_property(mtp_additional_properties orig_prop, mtp_additional_properties call_prop)
 687 {
 688         mtp_additional_properties t = (orig_prop | call_prop) & mtp_temporary;
 689         mtp_additional_properties r = orig_prop & call_prop;
 690         return r | t;
 691 }
 692
 693 /**
 694  * Check if a node is stored.
 695  */
 696 static int is_stored(const ir_node *n)
 697 {
 698         const ir_edge_t *edge;
 699         const ir_node   *ptr;
 700
 701         foreach_out_edge(n, edge) {
 702                 const ir_node *succ = get_edge_src_irn(edge);
 703
 704                 switch (get_irn_opcode(succ)) {
 705                 case iro_Return:
 706                 case iro_Load:
 707                 case iro_Cmp:
 708                         /* ok */
 709                         break;
 710                 case iro_Store:
 711                         if (get_Store_value(succ) == n)
 712                                 return 1;
 713                         /* ok if its only the address input */
 714                         break;
 715                 case iro_Sel:
 716                 case iro_Cast:
 717                 case iro_Confirm:
 718                         if (is_stored(succ))
 719                                 return 1;
 720                         break;
 721                 case iro_Call:
 722                         ptr = get_Call_ptr(succ);
 723                         if (is_Global(ptr)) {
 724                                 ir_entity *ent = get_Global_entity(ptr);
 725                                 int       i;
 726
 727                                 /* we know the called entity */
 728                                 for (i = get_Call_n_params(succ) - 1; i >= 0; --i) {
 729                                         if (get_Call_param(succ, i) == n) {
 730                                                 /* n is the i'th param of the call */
 731                                                 if (get_method_param_access(ent, i) & ptr_access_store) {
 732                                                         /* n is store in ent */
 733                                                         return 1;
 734                                                 }
 735                                         }
 736                                 }
 737                         } else {
 738                                 /* unknown call address */
 739                                 return 1;
 740                         }
 741                         break;
 742                 default:
 743                         /* bad, potential alias */
 744                         return 1;
 745                 }
 746         }
 747         return 0;
 748 }  /* is_stored */
 749
 750 /**
 751  * Check that the return value of an irg is not stored anywhere.
 752  *
 753  * return ~mtp_property_malloc if return values are stored, ~0 else
 754  */
 755 static mtp_additional_properties check_stored_result(ir_graph *irg)
 756 {
 757         ir_node  *end_blk = get_irg_end_block(irg);
 758         int      i, j;
 759         mtp_additional_properties res = ~mtp_no_property;
 760         int      old_edges = edges_assure_kind(irg, EDGE_KIND_NORMAL);
 761
 762         for (i = get_Block_n_cfgpreds(end_blk) - 1; i >= 0; --i) {
 763                 ir_node *pred = get_Block_cfgpred(end_blk, i);
 764
 765                 if (! is_Return(pred))
 766                         continue;
 767                 for (j = get_Return_n_ress(pred) - 1; j >= 0; --j) {
 768                         const ir_node *irn = get_Return_res(pred, j);
 769
 770                         if (is_stored(irn)) {
 771                                 /* bad, might create an alias */
 772                                 res = ~mtp_property_malloc;
 773                                 goto finish;
 774                         }
 775                 }
 776         }
 777 finish:
 778         if (! old_edges)
 779                 edges_deactivate_kind(irg, EDGE_KIND_NORMAL);
 780         return res;
 781 }
 782
 783 /**
 784  * Check if a graph represents a nothrow or a malloc function.
 785  *
 786  * @param irg  the graph to check
 787  * @param top  if set, this is the top call
 788  */
 789 static mtp_additional_properties check_nothrow_or_malloc(ir_graph *irg, int top)
 790 {
 791         mtp_additional_properties curr_prop = mtp_property_malloc | mtp_property_nothrow;
 792         ir_node                  *end_blk   = get_irg_end_block(irg);
 793         ir_entity *ent;
 794         ir_type   *mtp;
 795         int       i, j;
 796
 797         if (IS_IRG_READY(irg)) {
 798                 /* already checked */
 799                 return get_irg_additional_properties(irg);
 800         }
 801         if (IS_IRG_BUSY(irg)) {
 802                 /* we are still evaluate this method. Be optimistic,
 803                 return the best possible so far but mark the result as temporary. */
 804                 return mtp_temporary | mtp_property_malloc | mtp_property_nothrow;
 805         }
 806         SET_IRG_BUSY(irg);
 807
 808         ent = get_irg_entity(irg);
 809         mtp = get_entity_type(ent);
 810
 811         if (get_method_n_ress(mtp) <= 0)
 812                 curr_prop &= ~mtp_property_malloc;
 813
 814         for (i = get_Block_n_cfgpreds(end_blk) - 1; i >= 0; --i) {
 815                 ir_node *pred = get_Block_cfgpred(end_blk, i);
 816
 817                 if (is_Return(pred)) {
 818                         if (curr_prop & mtp_property_malloc) {
 819                                 /* check, if malloc is called here */
 820                                 for (j = get_Return_n_ress(pred) - 1; j >= 0; --j) {
 821                                         ir_node *res = get_Return_res(pred, j);
 822
 823                                         /* skip Confirms and Casts */
 824                                         res = skip_HighLevel_ops(res);
 825                                         /* skip Proj's */
 826                                         while (is_Proj(res))
 827                                                 res = get_Proj_pred(res);
 828                                         if (is_malloc_call_result(res)) {
 829                                                 /* ok, this is a malloc */
 830                                         } else if (is_Call(res)) {
 831                                                 ir_node *ptr = get_Call_ptr(res);
 832
 833                                                 if (is_Global(ptr)) {
 834                                                         /* a direct call */
 835                                                         ir_entity *ent    = get_Global_entity(ptr);
 836                                                         ir_graph  *callee = get_entity_irg(ent);
 837
 838                                                         if (callee == irg) {
 839                                                                 /* A self-recursive call. The property did not depend on this call. */
 840                                                         } else if (callee != NULL) {
 841                                                                 mtp_additional_properties prop = check_nothrow_or_malloc(callee, /*top=*/0);
 842                                                                 curr_prop = update_property(curr_prop, prop);
 843                                                         } else {
 844                                                                 curr_prop = update_property(curr_prop, get_entity_additional_properties(ent));
 845                                                         }
 846                                                 } else if (get_opt_closed_world() &&
 847                                                            is_Sel(ptr) &&
 848                                                            get_irg_callee_info_state(irg) == irg_callee_info_consistent) {
 849                                                         /* check if all possible callees are malloc functions. */
 850                                                         int i, n_callees = get_Call_n_callees(res);
 851                                                         if (n_callees == 0) {
 852                                                                 /* This is kind of strange:  dying code or a Call that will raise an exception
 853                                                                    when executed as there is no implementation to call.  So better not
 854                                                                    optimize. */
 855                                                                 curr_prop &= ~mtp_property_malloc;
 856                                                                 continue;
 857                                                         }
 858
 859                                                         for (i = 0; i < n_callees; ++i) {
 860                                                                 ir_entity *ent = get_Call_callee(res, i);
 861                                                                 if (ent == unknown_entity) {
 862                                                                         /* we don't know which entity is called here */
 863                                                                         curr_prop &= ~mtp_property_malloc;
 864                                                                         break;
 865                                                                 }
 866                                                                 if ((get_entity_additional_properties(ent) & mtp_property_malloc) == 0) {
 867                                                                         curr_prop &= ~mtp_property_malloc;
 868                                                                         break;
 869                                                                 }
 870                                                         }
 871                                                         /* if we pass the for cycle, malloc is still ok */
 872                                                 } else {
 873                                                         /* unknown call */
 874                                                         curr_prop &= ~mtp_property_malloc;
 875                                                 }
 876                                         } else {
 877                                                 /* unknown return value */
 878                                                 curr_prop &= ~mtp_property_malloc;
 879                                         }
 880                                 }
 881                         }
 882                 } else if (curr_prop & mtp_property_nothrow) {
 883                         /* exception flow detected */
 884                         pred = skip_Proj(pred);
 885
 886                         if (is_Call(pred)) {
 887                                 ir_node *ptr = get_Call_ptr(pred);
 888
 889                                 if (is_Global(ptr)) {
 890                                         /* a direct call */
 891                                         ir_entity *ent    = get_Global_entity(ptr);
 892                                         ir_graph  *callee = get_entity_irg(ent);
 893
 894                                         if (callee == irg) {
 895                                                 /* A self-recursive call. The property did not depend on this call. */
 896                                         } else if (callee != NULL) {
 897                                                 /* Note: we check here for nothrow only, so do NOT reset the malloc property */
 898                                                 mtp_additional_properties prop = check_nothrow_or_malloc(callee, /*top=*/0) | mtp_property_malloc;
 899                                                 curr_prop = update_property(curr_prop, prop);
 900                                         } else {
 901                                                 if ((get_entity_additional_properties(ent) & mtp_property_nothrow) == 0)
 902                                                         curr_prop &= ~mtp_property_nothrow;
 903                                         }
 904                                 } else if (get_opt_closed_world() &&
 905                                            is_Sel(ptr) &&
 906                                            get_irg_callee_info_state(irg) == irg_callee_info_consistent) {
 907                                         /* check if all possible callees are nothrow functions. */
 908                                         int i, n_callees = get_Call_n_callees(pred);
 909                                         if (n_callees == 0) {
 910                                                 /* This is kind of strange:  dying code or a Call that will raise an exception
 911                                                    when executed as there is no implementation to call.  So better not
 912                                                    optimize. */
 913                                                 curr_prop &= ~mtp_property_nothrow;
 914                                                 continue;
 915                                         }
 916
 917                                         for (i = 0; i < n_callees; ++i) {
 918                                                 ir_entity *ent = get_Call_callee(pred, i);
 919                                                 if (ent == unknown_entity) {
 920                                                         /* we don't know which entity is called here */
 921                                                         curr_prop &= ~mtp_property_nothrow;
 922                                                         break;
 923                                                 }
 924                                                 if ((get_entity_additional_properties(ent) & mtp_property_nothrow) == 0) {
 925                                                         curr_prop &= ~mtp_property_nothrow;
 926                                                         break;
 927                                                 }
 928                                         }
 929                                         /* if we pass the for cycle, nothrow is still ok */
 930                                 } else {
 931                                         /* unknown call */
 932                                         curr_prop &= ~mtp_property_nothrow;
 933                                 }
 934                         } else {
 935                                 /* real exception flow possible. */
 936                                 curr_prop &= ~mtp_property_nothrow;
 937                         }
 938                 }
 939                 if ((curr_prop & ~mtp_temporary) == mtp_no_property) {
 940                         /* no need to search further */
 941                         break;
 942                 }
 943         }
 944
 945         if (curr_prop & mtp_property_malloc) {
 946                 /*
 947                  * Note that the malloc property means not only return newly allocated
 948                  * memory, but also that this memory is ALIAS FREE.
 949                  * To ensure that, we do NOT allow that the returned memory is somewhere
 950                  * stored.
 951              */
 952                 curr_prop &= check_stored_result(irg);
 953         }
 954
 955         if (curr_prop != mtp_no_property) {
 956                 if (top || (curr_prop & mtp_temporary) == 0) {
 957                         /* We use the temporary flag here to mark an optimistic result.
 958                            Set the property only if we are sure that it does NOT base on
 959                            temporary results OR if we are at top-level. */
 960                         add_irg_additional_properties(irg, curr_prop & ~mtp_temporary);
 961                         SET_IRG_READY(irg);
 962                 }
 963         }
 964         if (top)
 965                 SET_IRG_READY(irg);
 966         CLEAR_IRG_BUSY(irg);
 967         return curr_prop;
 968 }  /* check_nothrow_or_malloc */
 969
 970 /**
 971  * When a function was detected as "const", it might be moved out of loops.
 972  * This might be dangerous if the graph can contain endless loops.
 973  */
 974 static void check_for_possible_endless_loops(ir_graph *irg)
 975 {
 976         ir_loop *root_loop;
 977         assure_cf_loop(irg);
 978
 979         root_loop = get_irg_loop(irg);
 980         if (root_loop->flags & loop_outer_loop)
 981                 add_irg_additional_properties(irg, mtp_property_has_loop);
 982 }
 983
 984 /*
 985  * optimize function calls by handling const functions
 986  */
 987 void optimize_funccalls(void)
 988 {
 989         size_t i, n;
 990         int last_idx;
 991         env_t  ctx;
 992         size_t num_const   = 0;
 993         size_t num_pure    = 0;
 994         size_t num_nothrow = 0;
 995         size_t num_malloc  = 0;
 996
 997         /* prepare: mark all graphs as not analyzed */
 998         last_idx  = get_irp_last_idx();
 999         ready_set = rbitset_malloc(last_idx);
1000         busy_set  = rbitset_malloc(last_idx);
1001
1002         /* first step: detect, which functions are nothrow or malloc */
1003         DB((dbg, LEVEL_2, "Detecting nothrow and malloc properties ...\n"));
1004         for (i = 0, n = get_irp_n_irgs(); i < n; ++i) {
1005                 ir_graph *irg = get_irp_irg(i);
1006                 unsigned prop = check_nothrow_or_malloc(irg, /*top=*/1);
1007
1008                 if (prop & mtp_property_nothrow) {
1009                         ++num_nothrow;
1010                         DB((dbg, LEVEL_2, "%+F has the nothrow property\n", irg));
1011                 } else if (prop & mtp_property_malloc) {
1012                         ++num_malloc;
1013                         DB((dbg, LEVEL_2, "%+F has the malloc property\n", irg));
1014                 }
1015         }
1016
1017         /* second step: remove exception edges: this must be done before the
1018            detection of const and pure functions take place. */
1019         handle_nothrow_Calls(&ctx);
1020         DB((dbg, LEVEL_1, "Detected %zu nothrow graphs, %zu malloc graphs.\n", num_nothrow, num_malloc));
1021         DB((dbg, LEVEL_1, "Optimizes %zu(SymConst) + %zu(Sel) calls to nothrow functions.\n",
1022                 ctx.n_calls_SymConst, ctx.n_calls_Sel));
1023
1024         rbitset_clear_all(ready_set, last_idx);
1025         rbitset_clear_all(busy_set, last_idx);
1026
1027         /* third step: detect, which functions are const or pure */
1028         DB((dbg, LEVEL_2, "Detecting const and pure properties ...\n"));
1029         for (i = 0, n = get_irp_n_irgs(); i < n; ++i) {
1030                 ir_graph *irg = get_irp_irg(i);
1031                 unsigned prop = check_const_or_pure_function(irg, /*top=*/1);
1032
1033                 if (prop & mtp_property_const) {
1034                         ++num_const;
1035                         DB((dbg, LEVEL_2, "%+F has the const property\n", irg));
1036                         check_for_possible_endless_loops(irg);
1037                 } else if (prop & mtp_property_pure) {
1038                         ++num_pure;
1039                         DB((dbg, LEVEL_2, "%+F has the pure property\n", irg));
1040                 }
1041         }
1042
1043         handle_const_Calls(&ctx);
1044         DB((dbg, LEVEL_1, "Detected %zu const graphs, %zu pure graphs.\n", num_const, num_pure));
1045         DB((dbg, LEVEL_1, "Optimizes %u(SymConst) + %u(Sel) calls to const functions.\n",
1046                    ctx.n_calls_SymConst, ctx.n_calls_Sel));
1047
1048         xfree(busy_set);
1049         xfree(ready_set);
1050 }
1051
1052 /* initialize the funccall optimization */
1053 void firm_init_funccalls(void)
1054 {
1055         FIRM_DBG_REGISTER(dbg, "firm.opt.funccalls");
1056 }
1057
1058 /* Creates an ir_prog pass for optimize_funccalls. */
1059 ir_prog_pass_t *optimize_funccalls_pass(const char *name)
1060 {
1061         return def_prog_pass(name ? name : "funccall", optimize_funccalls);
1062 }