nsz Git - libfirm/blob - ir/be/belive.c

   1 /*
   2  * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
   3  *
   4  * This file is part of libFirm.
   5  *
   6  * This file may be distributed and/or modified under the terms of the
   7  * GNU General Public License version 2 as published by the Free Software
   8  * Foundation and appearing in the file LICENSE.GPL included in the
   9  * packaging of this file.
  10  *
  11  * Licensees holding valid libFirm Professional Edition licenses may use
  12  * this file in accordance with the libFirm Commercial License.
  13  * Agreement provided with the Software.
  14  *
  15  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
  16  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  17  * PURPOSE.
  18  */
  19
  20 /**
  21  * @file
  22  * @brief       Interblock liveness analysis.
  23  * @author      Sebastian Hack
  24  * @date        06.12.2004
  25  */
  26 #include "config.h"
  27
  28 /* statev is expensive here, only enable when needed */
  29 #define DISABLE_STATEV
  30
  31 #include "iredges_t.h"
  32 #include "irgwalk.h"
  33 #include "irprintf.h"
  34 #include "irdump_t.h"
  35 #include "irnodeset.h"
  36
  37 #include "absgraph.h"
  38 #include "statev_t.h"
  39 #include "be_t.h"
  40 #include "bearch.h"
  41 #include "beutil.h"
  42 #include "belive_t.h"
  43 #include "besched.h"
  44 #include "bemodule.h"
  45
  46 DEBUG_ONLY(static firm_dbg_module_t *dbg = NULL;)
  47
  48 #define LV_STD_SIZE             64
  49
  50 /**
  51  * Filter out some nodes for which we never need liveness.
  52  *
  53  * @param irn  the node t check
  54  * @return 0 if no liveness info is needed, 1 else
  55  */
  56 static inline int is_liveness_node(const ir_node *irn)
  57 {
  58         switch (get_irn_opcode(irn)) {
  59         case iro_Block:
  60         case iro_Bad:
  61         case iro_End:
  62         case iro_Anchor:
  63         case iro_NoMem:
  64                 return 0;
  65         default:
  66                 return 1;
  67         }
  68 }
  69
  70 int (be_is_live_in)(const be_lv_t *lv, const ir_node *block, const ir_node *irn)
  71 {
  72         return _be_is_live_xxx(lv, block, irn, be_lv_state_in);
  73 }
  74
  75 int (be_is_live_out)(const be_lv_t *lv, const ir_node *block, const ir_node *irn)
  76 {
  77         return _be_is_live_xxx(lv, block, irn, be_lv_state_out);
  78 }
  79
  80 int (be_is_live_end)(const be_lv_t *lv, const ir_node *block, const ir_node *irn)
  81 {
  82         return _be_is_live_xxx(lv, block, irn, be_lv_state_end);
  83 }
  84
  85 static inline unsigned _be_liveness_bsearch(be_lv_info_t *arr, const ir_node *node)
  86 {
  87         be_lv_info_t *payload = arr + 1;
  88
  89         unsigned n   = arr[0].head.n_members;
  90         unsigned res = 0;
  91         int lo       = 0;
  92         int hi       = n;
  93
  94         if (n == 0)
  95                 return 0;
  96
  97         do {
  98                 int md           = lo + ((hi - lo) >> 1);
  99                 ir_node *md_node = payload[md].node.node;
 100
 101                 if (node > md_node)
 102                         lo = md + 1;
 103                 else if (node < md_node)
 104                         hi = md;
 105                 else {
 106                         res = md;
 107                         break;
 108                 }
 109
 110                 res = lo;
 111         } while (lo < hi);
 112
 113         return res;
 114 }
 115
 116 be_lv_info_node_t *be_lv_get(const be_lv_t *li, const ir_node *bl,
 117                              const ir_node *irn)
 118 {
 119         be_lv_info_t *irn_live;
 120         be_lv_info_node_t *res = NULL;
 121
 122         stat_ev_tim_push();
 123         irn_live = ir_nodehashmap_get(be_lv_info_t, &li->map, bl);
 124         if (irn_live != NULL) {
 125                 /* Get the position of the index in the array. */
 126                 int pos = _be_liveness_bsearch(irn_live, irn);
 127
 128                 /* Get the record in question. 1 must be added, since the first record contains information about the array and must be skipped. */
 129                 be_lv_info_node_t *rec = &irn_live[pos + 1].node;
 130
 131                 /* Check, if the irn is in deed in the array. */
 132                 if (rec->node == irn)
 133                         res = rec;
 134         }
 135         stat_ev_tim_pop("be_lv_get");
 136
 137         return res;
 138 }
 139
 140 static be_lv_info_node_t *be_lv_get_or_set(be_lv_t *li, ir_node *bl,
 141                                            ir_node *irn)
 142 {
 143         be_lv_info_t *irn_live = ir_nodehashmap_get(be_lv_info_t, &li->map, bl);
 144         if (irn_live == NULL) {
 145                 irn_live = OALLOCNZ(&li->obst, be_lv_info_t, LV_STD_SIZE);
 146                 irn_live[0].head.n_size = LV_STD_SIZE-1;
 147                 ir_nodehashmap_insert(&li->map, bl, irn_live);
 148         }
 149
 150         /* Get the position of the index in the array. */
 151         unsigned pos = _be_liveness_bsearch(irn_live, irn);
 152
 153         /* Get the record in question. 1 must be added, since the first record contains information about the array and must be skipped. */
 154         be_lv_info_node_t *res = &irn_live[pos + 1].node;
 155
 156         /* Check, if the irn is in deed in the array. */
 157         if (res->node != irn) {
 158                 be_lv_info_t *payload;
 159                 unsigned n_members = irn_live[0].head.n_members;
 160                 unsigned n_size    = irn_live[0].head.n_size;
 161                 unsigned i;
 162
 163                 if (n_members + 1 >= n_size) {
 164                         /* double the array size. Remember that the first entry is
 165                          * metadata about the array and not a real array element */
 166                         unsigned old_size_bytes  = (n_size + 1) * sizeof(irn_live[0]);
 167                         unsigned new_size        = (2 * n_size) + 1;
 168                         size_t   new_size_bytes  = new_size * sizeof(irn_live[0]);
 169                         be_lv_info_t *nw = OALLOCN(&li->obst, be_lv_info_t, new_size);
 170                         memcpy(nw, irn_live, old_size_bytes);
 171                         memset(((char*) nw) + old_size_bytes, 0,
 172                                new_size_bytes - old_size_bytes);
 173                         nw[0].head.n_size = new_size - 1;
 174                         irn_live = nw;
 175                         ir_nodehashmap_insert(&li->map, bl, nw);
 176                 }
 177
 178                 payload = &irn_live[1];
 179                 for (i = n_members; i > pos; --i) {
 180                         payload[i] = payload[i - 1];
 181                 }
 182
 183                 ++irn_live[0].head.n_members;
 184
 185                 res        = &payload[pos].node;
 186                 res->node  = irn;
 187                 res->flags = 0;
 188         }
 189
 190         return res;
 191 }
 192
 193 /**
 194  * Removes a node from the list of live variables of a block.
 195  * @return 1 if the node was live at that block, 0 if not.
 196  */
 197 static int be_lv_remove(be_lv_t *li, const ir_node *bl,
 198                         const ir_node *irn)
 199 {
 200         be_lv_info_t *irn_live = ir_nodehashmap_get(be_lv_info_t, &li->map, bl);
 201
 202         if (irn_live != NULL) {
 203                 unsigned n   = irn_live[0].head.n_members;
 204                 unsigned pos = _be_liveness_bsearch(irn_live, irn);
 205                 be_lv_info_t *payload  = irn_live + 1;
 206                 be_lv_info_node_t *res = &payload[pos].node;
 207
 208                 /* The node is in deed in the block's array. Let's remove it. */
 209                 if (res->node == irn) {
 210                         unsigned i;
 211
 212                         for (i = pos + 1; i < n; ++i)
 213                                 payload[i - 1] = payload[i];
 214
 215                         payload[n - 1].node.node  = NULL;
 216                         payload[n - 1].node.flags = 0;
 217
 218                         --irn_live[0].head.n_members;
 219                         DBG((dbg, LEVEL_3, "\tdeleting %+F from %+F at pos %d\n", irn, bl, pos));
 220                         return 1;
 221                 }
 222         }
 223
 224         return 0;
 225 }
 226
 227 /**
 228  * Mark a node as live-in in a block.
 229  */
 230 static inline void mark_live_in(be_lv_t *lv, ir_node *block, ir_node *irn)
 231 {
 232         be_lv_info_node_t *n = be_lv_get_or_set(lv, block, irn);
 233         DBG((dbg, LEVEL_2, "marking %+F live in at %+F\n", irn, block));
 234         n->flags |= be_lv_state_in;
 235 }
 236
 237 /**
 238  * Mark a node as live-out in a block.
 239  */
 240 static inline void mark_live_out(be_lv_t *lv, ir_node *block, ir_node *irn)
 241 {
 242         be_lv_info_node_t *n = be_lv_get_or_set(lv, block, irn);
 243         DBG((dbg, LEVEL_2, "marking %+F live out at %+F\n", irn, block));
 244         n->flags |= be_lv_state_out | be_lv_state_end;
 245 }
 246
 247 /**
 248  * Mark a node as live-end in a block.
 249  */
 250 static inline void mark_live_end(be_lv_t *lv, ir_node *block, ir_node *irn)
 251 {
 252         be_lv_info_node_t *n = be_lv_get_or_set(lv, block, irn);
 253         DBG((dbg, LEVEL_2, "marking %+F live end at %+F\n", irn, block));
 254         n->flags |= be_lv_state_end;
 255 }
 256
 257 static struct {
 258         be_lv_t  *lv;         /**< The liveness object. */
 259         ir_node  *def;        /**< The node (value). */
 260         ir_node  *def_block;  /**< The block of def. */
 261         bitset_t *visited;    /**< A set were all visited blocks are recorded. */
 262 } re;
 263
 264 /**
 265  * Mark a node (value) live out at a certain block. Do this also
 266  * transitively, i.e. if the block is not the block of the value's
 267  * definition, all predecessors are also marked live.
 268  * @param block The block to mark the value live out of.
 269  * @param is_true_out Is the node real out there or only live at the end
 270  * of the block.
 271  */
 272 static void live_end_at_block(ir_node *block, int is_true_out)
 273 {
 274         be_lv_t *lv  = re.lv;
 275         ir_node *def = re.def;
 276         bitset_t *visited;
 277
 278         mark_live_end(lv, block, def);
 279         if (is_true_out)
 280                 mark_live_out(lv, block, def);
 281
 282         visited = re.visited;
 283         if (!bitset_is_set(visited, get_irn_idx(block))) {
 284                 bitset_set(visited, get_irn_idx(block));
 285
 286                 /*
 287                  * If this block is not the definition block, we have to go up
 288                  * further.
 289                  */
 290                 if (re.def_block != block) {
 291                         int i;
 292
 293                         mark_live_in(lv, block, def);
 294
 295                         for (i = get_Block_n_cfgpreds(block) - 1; i >= 0; --i)
 296                                 live_end_at_block(get_Block_cfgpred_block(block, i), 1);
 297                 }
 298         }
 299 }
 300
 301 typedef struct lv_remove_walker_t {
 302         be_lv_t       *lv;
 303         const ir_node *irn;
 304 } lv_remove_walker_t;
 305
 306
 307 /**
 308  * Liveness analysis for a value.
 309  * Compute the set of all blocks a value is live in.
 310  * @param irn     The node (value).
 311  */
 312 static void liveness_for_node(ir_node *irn)
 313 {
 314         ir_node *def_block;
 315
 316         bitset_clear_all(re.visited);
 317         def_block = get_nodes_block(irn);
 318
 319         re.def       = irn;
 320         re.def_block = def_block;
 321
 322         /* Go over all uses of the value */
 323         foreach_out_edge(irn, edge) {
 324                 ir_node *use = edge->src;
 325                 ir_node *use_block;
 326
 327                 DBG((dbg, LEVEL_4, "%+F: use at %+F, pos %d in %+F\n", irn, use, edge->pos, get_block(use)));
 328                 assert(get_irn_n(use, edge->pos) == irn);
 329
 330                 /*
 331                  * If the usage is no data node, skip this use, since it does not
 332                  * affect the liveness of the node.
 333                  */
 334                 if (!is_liveness_node(use))
 335                         continue;
 336
 337                 /* Get the block where the usage is in. */
 338                 use_block = get_nodes_block(use);
 339
 340                 /*
 341                  * If the use is a phi function, determine the corresponding block
 342                  * through which the value reaches the phi function and mark the
 343                  * value as live out of that block.
 344                  */
 345                 if (is_Phi(use)) {
 346                         ir_node *pred_block = get_Block_cfgpred_block(use_block, edge->pos);
 347                         live_end_at_block(pred_block, 0);
 348                 }
 349
 350                 /*
 351                  * Else, the value is live in at this block. Mark it and call live
 352                  * out on the predecessors.
 353                  */
 354                 else if (def_block != use_block) {
 355                         int i;
 356
 357                         mark_live_in(re.lv, use_block, irn);
 358
 359                         for (i = get_Block_n_cfgpreds(use_block) - 1; i >= 0; --i) {
 360                                 ir_node *pred_block = get_Block_cfgpred_block(use_block, i);
 361                                 live_end_at_block(pred_block, 1);
 362                         }
 363                 }
 364         }
 365 }
 366
 367 static void lv_remove_irn_walker(ir_node *bl, void *data)
 368 {
 369         lv_remove_walker_t *w = (lv_remove_walker_t*)data;
 370         be_lv_remove(w->lv, bl, w->irn);
 371 }
 372
 373 /**
 374  * Walker, collect all nodes for which we want calculate liveness info
 375  * on an obstack.
 376  */
 377 static void collect_liveness_nodes(ir_node *irn, void *data)
 378 {
 379         ir_node **nodes = (ir_node**)data;
 380         if (is_liveness_node(irn))
 381                 nodes[get_irn_idx(irn)] = irn;
 382 }
 383
 384 void be_liveness_compute_sets(be_lv_t *lv)
 385 {
 386         ir_node **nodes;
 387         int       i;
 388         int       n;
 389
 390         if (lv->sets_valid)
 391                 return;
 392
 393         be_timer_push(T_LIVE);
 394         ir_nodehashmap_init(&lv->map);
 395         obstack_init(&lv->obst);
 396
 397         n = get_irg_last_idx(lv->irg);
 398         nodes = NEW_ARR_F(ir_node *, n);
 399         memset(nodes, 0, sizeof(nodes[0]) * n);
 400
 401         /* inserting the variables sorted by their ID is probably
 402          * more efficient since the binary sorted set insertion
 403          * will not need to move around the data. */
 404         irg_walk_graph(lv->irg, NULL, collect_liveness_nodes, nodes);
 405
 406         re.lv      = lv;
 407         re.visited = bitset_malloc(n);
 408
 409         for (i = 0; i < n; ++i) {
 410                 if (nodes[i] != NULL)
 411                         liveness_for_node(nodes[i]);
 412         }
 413
 414         DEL_ARR_F(nodes);
 415         free(re.visited);
 416
 417         be_timer_pop(T_LIVE);
 418
 419         lv->sets_valid = true;
 420 }
 421
 422 void be_liveness_compute_chk(be_lv_t *lv)
 423 {
 424         if (lv->lvc != NULL)
 425                 return;
 426         lv->lvc = lv_chk_new(lv->irg);
 427 }
 428
 429 void be_liveness_invalidate_sets(be_lv_t *lv)
 430 {
 431         if (!lv->sets_valid)
 432                 return;
 433         obstack_free(&lv->obst, NULL);
 434         ir_nodehashmap_destroy(&lv->map);
 435         lv->sets_valid = false;
 436 }
 437
 438 void be_liveness_invalidate_chk(be_lv_t *lv)
 439 {
 440         be_liveness_invalidate_sets(lv);
 441
 442         if (lv->lvc == NULL)
 443                 return;
 444         lv_chk_free(lv->lvc);
 445         lv->lvc = NULL;
 446 }
 447
 448 be_lv_t *be_liveness_new(ir_graph *irg)
 449 {
 450         be_lv_t *lv = XMALLOCZ(be_lv_t);
 451
 452         lv->irg = irg;
 453
 454         return lv;
 455 }
 456
 457 void be_liveness_free(be_lv_t *lv)
 458 {
 459         be_liveness_invalidate_sets(lv);
 460         be_liveness_invalidate_chk(lv);
 461
 462         xfree(lv);
 463 }
 464
 465 void be_liveness_remove(be_lv_t *lv, const ir_node *irn)
 466 {
 467         if (lv->sets_valid) {
 468                 lv_remove_walker_t w;
 469
 470                 /*
 471                  * Removes a single irn from the liveness information.
 472                  * Since an irn can only be live at blocks dominated by the block of its
 473                  * definition, we only have to process that dominance subtree.
 474                  */
 475                 w.lv  = lv;
 476                 w.irn = irn;
 477                 dom_tree_walk(get_nodes_block(irn), lv_remove_irn_walker, NULL, &w);
 478         }
 479 }
 480
 481 void be_liveness_introduce(be_lv_t *lv, ir_node *irn)
 482 {
 483         /* Don't compute liveness information for non-data nodes. */
 484         if (lv->sets_valid && is_liveness_node(irn)) {
 485                 re.lv      = lv;
 486                 re.visited = bitset_malloc(get_irg_last_idx(lv->irg));
 487                 liveness_for_node(irn);
 488                 bitset_free(re.visited);
 489         }
 490 }
 491
 492 void be_liveness_update(be_lv_t *lv, ir_node *irn)
 493 {
 494         be_liveness_remove(lv, irn);
 495         be_liveness_introduce(lv, irn);
 496 }
 497
 498 void be_liveness_transfer(const arch_register_class_t *cls,
 499                           ir_node *node, ir_nodeset_t *nodeset)
 500 {
 501         /* You should better break out of your loop when hitting the first phi
 502          * function. */
 503         assert(!is_Phi(node) && "liveness_transfer produces invalid results for phi nodes");
 504
 505         be_foreach_definition(node, cls, value,
 506                 ir_nodeset_remove(nodeset, value);
 507         );
 508
 509         int arity = get_irn_arity(node);
 510         for (int i = 0; i < arity; ++i) {
 511                 const arch_register_req_t *in_req = arch_get_irn_register_req_in(node, i);
 512                 if (in_req->cls != cls)
 513                         continue;
 514                 ir_node                   *op     = get_irn_n(node, i);
 515                 const arch_register_req_t *op_req = arch_get_irn_register_req(op);
 516                 if (arch_register_req_is(op_req, ignore))
 517                         continue;
 518                 ir_nodeset_insert(nodeset, op);
 519         }
 520 }
 521
 522
 523
 524 void be_liveness_end_of_block(const be_lv_t *lv,
 525                               const arch_register_class_t *cls,
 526                               const ir_node *block, ir_nodeset_t *live)
 527 {
 528         assert(lv->sets_valid && "live sets must be computed");
 529         be_lv_foreach(lv, block, be_lv_state_end, node) {
 530                 if (!arch_irn_consider_in_reg_alloc(cls, node))
 531                         continue;
 532
 533                 ir_nodeset_insert(live, node);
 534         }
 535 }
 536
 537
 538
 539 void be_liveness_nodes_live_before(be_lv_t const *const lv, arch_register_class_t const *const cls, ir_node const *const pos, ir_nodeset_t *const live)
 540 {
 541         ir_node const *const bl = get_nodes_block(pos);
 542         be_liveness_end_of_block(lv, cls, bl, live);
 543         sched_foreach_reverse(bl, irn) {
 544                 be_liveness_transfer(cls, irn, live);
 545                 if (irn == pos)
 546                         return;
 547         }
 548 }
 549
 550 static void collect_node(ir_node *irn, void *data)
 551 {
 552         struct obstack *obst = (struct obstack*)data;
 553         obstack_ptr_grow(obst, irn);
 554 }
 555
 556 static void be_live_chk_compare(be_lv_t *lv, lv_chk_t *lvc)
 557 {
 558         ir_graph *irg    = lv->irg;
 559
 560         struct obstack obst;
 561         ir_node **nodes;
 562         ir_node **blocks;
 563         int i, j;
 564
 565         obstack_init(&obst);
 566
 567         irg_block_walk_graph(irg, collect_node, NULL, &obst);
 568         obstack_ptr_grow(&obst, NULL);
 569         blocks = (ir_node**)obstack_finish(&obst);
 570
 571         irg_walk_graph(irg, collect_node, NULL, &obst);
 572         obstack_ptr_grow(&obst, NULL);
 573         nodes = (ir_node**)obstack_finish(&obst);
 574
 575         stat_ev_ctx_push("be_lv_chk_compare");
 576         for (j = 0; nodes[j]; ++j) {
 577                 ir_node *irn = nodes[j];
 578                 if (is_Block(irn))
 579                         continue;
 580
 581                 for (i = 0; blocks[i]; ++i) {
 582                         ir_node *bl = blocks[i];
 583                         int lvr_in  = be_is_live_in (lv, bl, irn);
 584                         int lvr_out = be_is_live_out(lv, bl, irn);
 585                         int lvr_end = be_is_live_end(lv, bl, irn);
 586
 587                         int lvc_in  = lv_chk_bl_in (lvc, bl, irn);
 588                         int lvc_out = lv_chk_bl_out(lvc, bl, irn);
 589                         int lvc_end = lv_chk_bl_end(lvc, bl, irn);
 590
 591                         if (lvr_in - lvc_in != 0)
 592                                 ir_fprintf(stderr, "live in  info for %+F at %+F differs: nml: %d, chk: %d\n", irn, bl, lvr_in, lvc_in);
 593
 594                         if (lvr_end - lvc_end != 0)
 595                                 ir_fprintf(stderr, "live end info for %+F at %+F differs: nml: %d, chk: %d\n", irn, bl, lvr_end, lvc_end);
 596
 597                         if (lvr_out - lvc_out != 0)
 598                                 ir_fprintf(stderr, "live out info for %+F at %+F differs: nml: %d, chk: %d\n", irn, bl, lvr_out, lvc_out);
 599                 }
 600         }
 601         stat_ev_ctx_pop("be_lv_chk_compare");
 602
 603         obstack_free(&obst, NULL);
 604 }
 605
 606 BE_REGISTER_MODULE_CONSTRUCTOR(be_init_live)
 607 void be_init_live(void)
 608 {
 609         (void)be_live_chk_compare;
 610         FIRM_DBG_REGISTER(dbg, "firm.be.liveness");
 611 }