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