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 static struct {
 208         be_lv_t  *lv;         /**< The liveness object. */
 209         ir_node  *def;        /**< The node (value). */
 210         ir_node  *def_block;  /**< The block of def. */
 211         bitset_t *visited;    /**< A set were all visited blocks are recorded. */
 212 } re;
 213
 214 /**
 215  * Mark a node (value) live out at a certain block. Do this also
 216  * transitively, i.e. if the block is not the block of the value's
 217  * definition, all predecessors are also marked live.
 218  * @param block The block to mark the value live out of.
 219  * @param state The liveness bits to set, either end or end+out.
 220  */
 221 static void live_end_at_block(ir_node *const block, be_lv_state_t const state)
 222 {
 223         be_lv_info_node_t *const n = be_lv_get_or_set(re.lv, block, re.def);
 224
 225         assert(state == be_lv_state_end || state == (be_lv_state_end | be_lv_state_out));
 226         DBG((dbg, LEVEL_2, "marking %+F live %s at %+F\n", re.def, state & be_lv_state_out ? "end+out" : "end", block));
 227         n->flags |= state;
 228
 229         bitset_t *const visited = re.visited;
 230         if (!bitset_is_set(visited, get_irn_idx(block))) {
 231                 bitset_set(visited, get_irn_idx(block));
 232
 233                 /*
 234                  * If this block is not the definition block, we have to go up
 235                  * further.
 236                  */
 237                 if (re.def_block != block) {
 238                         int i;
 239
 240                         DBG((dbg, LEVEL_2, "marking %+F live in at %+F\n", re.def, block));
 241                         n->flags |= be_lv_state_in;
 242
 243                         for (i = get_Block_n_cfgpreds(block) - 1; i >= 0; --i)
 244                                 live_end_at_block(get_Block_cfgpred_block(block, i), be_lv_state_end | be_lv_state_out);
 245                 }
 246         }
 247 }
 248
 249 typedef struct lv_remove_walker_t {
 250         be_lv_t       *lv;
 251         const ir_node *irn;
 252 } lv_remove_walker_t;
 253
 254
 255 /**
 256  * Liveness analysis for a value.
 257  * Compute the set of all blocks a value is live in.
 258  * @param irn     The node (value).
 259  */
 260 static void liveness_for_node(ir_node *irn)
 261 {
 262         ir_node *def_block;
 263
 264         bitset_clear_all(re.visited);
 265         def_block = get_nodes_block(irn);
 266
 267         re.def       = irn;
 268         re.def_block = def_block;
 269
 270         /* Go over all uses of the value */
 271         foreach_out_edge(irn, edge) {
 272                 ir_node *use = edge->src;
 273                 ir_node *use_block;
 274
 275                 DBG((dbg, LEVEL_4, "%+F: use at %+F, pos %d in %+F\n", irn, use, edge->pos, get_block(use)));
 276                 assert(get_irn_n(use, edge->pos) == irn);
 277
 278                 /*
 279                  * If the usage is no data node, skip this use, since it does not
 280                  * affect the liveness of the node.
 281                  */
 282                 if (!is_liveness_node(use))
 283                         continue;
 284
 285                 /* Get the block where the usage is in. */
 286                 use_block = get_nodes_block(use);
 287
 288                 /*
 289                  * If the use is a phi function, determine the corresponding block
 290                  * through which the value reaches the phi function and mark the
 291                  * value as live out of that block.
 292                  */
 293                 if (is_Phi(use)) {
 294                         ir_node *pred_block = get_Block_cfgpred_block(use_block, edge->pos);
 295                         live_end_at_block(pred_block, be_lv_state_end);
 296                 }
 297
 298                 /*
 299                  * Else, the value is live in at this block. Mark it and call live
 300                  * out on the predecessors.
 301                  */
 302                 else if (def_block != use_block) {
 303                         int i;
 304
 305                         be_lv_info_node_t *const n = be_lv_get_or_set(re.lv, use_block, irn);
 306                         DBG((dbg, LEVEL_2, "marking %+F live in at %+F\n", irn, use_block));
 307                         n->flags |= be_lv_state_in;
 308
 309                         for (i = get_Block_n_cfgpreds(use_block) - 1; i >= 0; --i) {
 310                                 ir_node *pred_block = get_Block_cfgpred_block(use_block, i);
 311                                 live_end_at_block(pred_block, be_lv_state_end | be_lv_state_out);
 312                         }
 313                 }
 314         }
 315 }
 316
 317 static void lv_remove_irn_walker(ir_node *bl, void *data)
 318 {
 319         lv_remove_walker_t *w = (lv_remove_walker_t*)data;
 320         be_lv_remove(w->lv, bl, w->irn);
 321 }
 322
 323 /**
 324  * Walker, collect all nodes for which we want calculate liveness info
 325  * on an obstack.
 326  */
 327 static void collect_liveness_nodes(ir_node *irn, void *data)
 328 {
 329         ir_node **nodes = (ir_node**)data;
 330         if (is_liveness_node(irn))
 331                 nodes[get_irn_idx(irn)] = irn;
 332 }
 333
 334 void be_liveness_compute_sets(be_lv_t *lv)
 335 {
 336         int       i;
 337         int       n;
 338
 339         if (lv->sets_valid)
 340                 return;
 341
 342         be_timer_push(T_LIVE);
 343         ir_nodehashmap_init(&lv->map);
 344         obstack_init(&lv->obst);
 345
 346         n = get_irg_last_idx(lv->irg);
 347         ir_node **const nodes = NEW_ARR_FZ(ir_node*, n);
 348
 349         /* inserting the variables sorted by their ID is probably
 350          * more efficient since the binary sorted set insertion
 351          * will not need to move around the data. */
 352         irg_walk_graph(lv->irg, NULL, collect_liveness_nodes, nodes);
 353
 354         re.lv      = lv;
 355         re.visited = bitset_malloc(n);
 356
 357         for (i = 0; i < n; ++i) {
 358                 if (nodes[i] != NULL)
 359                         liveness_for_node(nodes[i]);
 360         }
 361
 362         DEL_ARR_F(nodes);
 363         free(re.visited);
 364
 365         be_timer_pop(T_LIVE);
 366
 367         lv->sets_valid = true;
 368 }
 369
 370 void be_liveness_compute_chk(be_lv_t *lv)
 371 {
 372         if (lv->lvc != NULL)
 373                 return;
 374         lv->lvc = lv_chk_new(lv->irg);
 375 }
 376
 377 void be_liveness_invalidate_sets(be_lv_t *lv)
 378 {
 379         if (!lv->sets_valid)
 380                 return;
 381         obstack_free(&lv->obst, NULL);
 382         ir_nodehashmap_destroy(&lv->map);
 383         lv->sets_valid = false;
 384 }
 385
 386 void be_liveness_invalidate_chk(be_lv_t *lv)
 387 {
 388         be_liveness_invalidate_sets(lv);
 389
 390         if (lv->lvc == NULL)
 391                 return;
 392         lv_chk_free(lv->lvc);
 393         lv->lvc = NULL;
 394 }
 395
 396 be_lv_t *be_liveness_new(ir_graph *irg)
 397 {
 398         be_lv_t *lv = XMALLOCZ(be_lv_t);
 399
 400         lv->irg = irg;
 401
 402         return lv;
 403 }
 404
 405 void be_liveness_free(be_lv_t *lv)
 406 {
 407         be_liveness_invalidate_sets(lv);
 408         be_liveness_invalidate_chk(lv);
 409
 410         xfree(lv);
 411 }
 412
 413 void be_liveness_remove(be_lv_t *lv, const ir_node *irn)
 414 {
 415         if (lv->sets_valid) {
 416                 lv_remove_walker_t w;
 417
 418                 /*
 419                  * Removes a single irn from the liveness information.
 420                  * Since an irn can only be live at blocks dominated by the block of its
 421                  * definition, we only have to process that dominance subtree.
 422                  */
 423                 w.lv  = lv;
 424                 w.irn = irn;
 425                 dom_tree_walk(get_nodes_block(irn), lv_remove_irn_walker, NULL, &w);
 426         }
 427 }
 428
 429 void be_liveness_introduce(be_lv_t *lv, ir_node *irn)
 430 {
 431         /* Don't compute liveness information for non-data nodes. */
 432         if (lv->sets_valid && is_liveness_node(irn)) {
 433                 re.lv      = lv;
 434                 re.visited = bitset_malloc(get_irg_last_idx(lv->irg));
 435                 liveness_for_node(irn);
 436                 bitset_free(re.visited);
 437         }
 438 }
 439
 440 void be_liveness_update(be_lv_t *lv, ir_node *irn)
 441 {
 442         be_liveness_remove(lv, irn);
 443         be_liveness_introduce(lv, irn);
 444 }
 445
 446 void be_liveness_transfer(const arch_register_class_t *cls,
 447                           ir_node *node, ir_nodeset_t *nodeset)
 448 {
 449         /* You should better break out of your loop when hitting the first phi
 450          * function. */
 451         assert(!is_Phi(node) && "liveness_transfer produces invalid results for phi nodes");
 452
 453         be_foreach_definition(node, cls, value, req,
 454                 ir_nodeset_remove(nodeset, value);
 455         );
 456
 457         be_foreach_use(node, cls, in_req, op, op_req,
 458                 ir_nodeset_insert(nodeset, op);
 459         );
 460 }
 461
 462
 463
 464 void be_liveness_end_of_block(const be_lv_t *lv,
 465                               const arch_register_class_t *cls,
 466                               const ir_node *block, ir_nodeset_t *live)
 467 {
 468         assert(lv->sets_valid && "live sets must be computed");
 469         be_lv_foreach_cls(lv, block, be_lv_state_end, cls, node) {
 470                 ir_nodeset_insert(live, node);
 471         }
 472 }
 473
 474
 475
 476 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)
 477 {
 478         ir_node const *const bl = get_nodes_block(pos);
 479         be_liveness_end_of_block(lv, cls, bl, live);
 480         sched_foreach_reverse(bl, irn) {
 481                 be_liveness_transfer(cls, irn, live);
 482                 if (irn == pos)
 483                         return;
 484         }
 485 }
 486
 487 static void collect_node(ir_node *irn, void *data)
 488 {
 489         struct obstack *obst = (struct obstack*)data;
 490         obstack_ptr_grow(obst, irn);
 491 }
 492
 493 static void be_live_chk_compare(be_lv_t *lv, lv_chk_t *lvc)
 494 {
 495         ir_graph *irg    = lv->irg;
 496
 497         struct obstack obst;
 498         ir_node **nodes;
 499         ir_node **blocks;
 500         int i, j;
 501
 502         obstack_init(&obst);
 503
 504         irg_block_walk_graph(irg, collect_node, NULL, &obst);
 505         obstack_ptr_grow(&obst, NULL);
 506         blocks = (ir_node**)obstack_finish(&obst);
 507
 508         irg_walk_graph(irg, collect_node, NULL, &obst);
 509         obstack_ptr_grow(&obst, NULL);
 510         nodes = (ir_node**)obstack_finish(&obst);
 511
 512         stat_ev_ctx_push("be_lv_chk_compare");
 513         for (j = 0; nodes[j]; ++j) {
 514                 ir_node *irn = nodes[j];
 515                 if (is_Block(irn))
 516                         continue;
 517
 518                 for (i = 0; blocks[i]; ++i) {
 519                         ir_node *bl = blocks[i];
 520                         int lvr_in  = be_is_live_in (lv, bl, irn);
 521                         int lvr_out = be_is_live_out(lv, bl, irn);
 522                         int lvr_end = be_is_live_end(lv, bl, irn);
 523
 524                         int lvc_in  = lv_chk_bl_in (lvc, bl, irn);
 525                         int lvc_out = lv_chk_bl_out(lvc, bl, irn);
 526                         int lvc_end = lv_chk_bl_end(lvc, bl, irn);
 527
 528                         if (lvr_in - lvc_in != 0)
 529                                 ir_fprintf(stderr, "live in  info for %+F at %+F differs: nml: %d, chk: %d\n", irn, bl, lvr_in, lvc_in);
 530
 531                         if (lvr_end - lvc_end != 0)
 532                                 ir_fprintf(stderr, "live end info for %+F at %+F differs: nml: %d, chk: %d\n", irn, bl, lvr_end, lvc_end);
 533
 534                         if (lvr_out - lvc_out != 0)
 535                                 ir_fprintf(stderr, "live out info for %+F at %+F differs: nml: %d, chk: %d\n", irn, bl, lvr_out, lvc_out);
 536                 }
 537         }
 538         stat_ev_ctx_pop("be_lv_chk_compare");
 539
 540         obstack_free(&obst, NULL);
 541 }
 542
 543 BE_REGISTER_MODULE_CONSTRUCTOR(be_init_live)
 544 void be_init_live(void)
 545 {
 546         (void)be_live_chk_compare;
 547         FIRM_DBG_REGISTER(dbg, "firm.be.liveness");
 548 }