nsz Git - libfirm/blob - ir/be/beabihelper.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       Helper functions for handling ABI constraints in the code
  23  *              selection phase.
  24  * @author      Matthias Braun
  25  * @version     $Id$
  26  */
  27 #include "config.h"
  28
  29 #include "beabihelper.h"
  30 #include "bearch.h"
  31 #include "benode.h"
  32 #include "besched.h"
  33 #include "ircons.h"
  34 #include "iredges.h"
  35 #include "irgwalk.h"
  36 #include "irphase_t.h"
  37 #include "height.h"
  38
  39 typedef struct reg_flag_t {
  40         const arch_register_t *reg;   /**< register at an input position.
  41                                            may be NULL in case of memory input */
  42         arch_irn_flags_t       flags;
  43 } reg_flag_t;
  44
  45 /**
  46  * A register state mapping keeps track of the symbol values (=firm nodes)
  47  * to registers. This is usefull when constructing straight line code
  48  * which like the function prolog or epilog in some architectures.
  49  */
  50 typedef struct register_state_mapping_t {
  51         ir_node   **value_map;     /**< mapping of state indices to values */
  52         int       **reg_index_map; /**< mapping of regclass,regnum to an index
  53                                         into the value_map */
  54         reg_flag_t *regs;          /**< registers (and memory values) that form a
  55                                         state */
  56         ir_node    *last_barrier;
  57 } register_state_mapping_t;
  58
  59 struct beabi_helper_env_t {
  60         ir_graph                 *irg;
  61         register_state_mapping_t  prolog;
  62         register_state_mapping_t  epilog;
  63         ir_phase                 *stack_order;
  64 };
  65
  66 static void prepare_rsm(register_state_mapping_t *rsm,
  67                         const arch_env_t *arch_env)
  68 {
  69         unsigned   n_reg_classes = arch_env_get_n_reg_class(arch_env);
  70         unsigned   c;
  71         reg_flag_t memory = { NULL, 0 };
  72
  73         rsm->regs = NEW_ARR_F(reg_flag_t, 0);
  74         /* memory input at 0 */
  75         ARR_APP1(reg_flag_t, rsm->regs, memory);
  76
  77         rsm->value_map     = NULL;
  78         rsm->reg_index_map = XMALLOCN(int*, n_reg_classes);
  79         for (c = 0; c < n_reg_classes; ++c) {
  80                 const arch_register_class_t *cls = arch_env_get_reg_class(arch_env, c);
  81                 unsigned                     n_regs = arch_register_class_n_regs(cls);
  82                 unsigned                     r;
  83
  84                 rsm->reg_index_map[c] = XMALLOCN(int, n_regs);
  85                 for (r = 0; r < n_regs; ++r) {
  86                         rsm->reg_index_map[c][r] = -1;
  87                 }
  88         }
  89 }
  90
  91 static void free_rsm(register_state_mapping_t *rsm, const arch_env_t *arch_env)
  92 {
  93         unsigned n_reg_classes = arch_env_get_n_reg_class(arch_env);
  94         unsigned c;
  95
  96         for (c = 0; c < n_reg_classes; ++c) {
  97                 free(rsm->reg_index_map[c]);
  98         }
  99
 100         free(rsm->reg_index_map);
 101         if (rsm->value_map != NULL)
 102                 DEL_ARR_F(rsm->value_map);
 103         DEL_ARR_F(rsm->regs);
 104
 105         rsm->regs          = NULL;
 106         rsm->reg_index_map = NULL;
 107         rsm->value_map     = NULL;
 108 }
 109
 110 static void rsm_clear_regs(register_state_mapping_t *rsm,
 111                            const arch_env_t *arch_env)
 112 {
 113         unsigned   n_reg_classes = arch_env_get_n_reg_class(arch_env);
 114         unsigned   c;
 115         reg_flag_t memory = { NULL, 0 };
 116
 117         for (c = 0; c < n_reg_classes; ++c) {
 118                 const arch_register_class_t *cls = arch_env_get_reg_class(arch_env, c);
 119                 unsigned                     n_regs = arch_register_class_n_regs(cls);
 120                 unsigned                     r;
 121
 122                 for (r = 0; r < n_regs; ++r) {
 123                         rsm->reg_index_map[c][r] = -1;
 124                 }
 125         }
 126         ARR_RESIZE(reg_flag_t, rsm->regs, 0);
 127         ARR_APP1(reg_flag_t, rsm->regs, memory);
 128
 129         if (rsm->value_map != NULL) {
 130                 DEL_ARR_F(rsm->value_map);
 131                 rsm->value_map = NULL;
 132         }
 133 }
 134
 135 static void rsm_add_reg(register_state_mapping_t *rsm,
 136                         const arch_register_t *reg, arch_irn_flags_t flags)
 137 {
 138         int        input_idx = ARR_LEN(rsm->regs);
 139         int        cls_idx   = reg->reg_class->index;
 140         int        reg_idx   = reg->index;
 141         reg_flag_t regflag   = { reg, flags };
 142
 143         /* we must not have used get_value yet */
 144         assert(rsm->reg_index_map[cls_idx][reg_idx] == -1);
 145         rsm->reg_index_map[cls_idx][reg_idx] = input_idx;
 146         ARR_APP1(reg_flag_t, rsm->regs, regflag);
 147 }
 148
 149
 150 static ir_node *rsm_get_value(register_state_mapping_t *rsm, int index)
 151 {
 152         assert(index < ARR_LEN(rsm->value_map));
 153         return rsm->value_map[index];
 154 }
 155
 156 static ir_node *rsm_get_reg_value(register_state_mapping_t *rsm,
 157                                   const arch_register_t *reg)
 158 {
 159         int cls_idx   = reg->reg_class->index;
 160         int reg_idx   = reg->index;
 161         int input_idx = rsm->reg_index_map[cls_idx][reg_idx];
 162
 163         return rsm_get_value(rsm, input_idx);
 164 }
 165
 166 static void rsm_set_value(register_state_mapping_t *rsm, int index,
 167                           ir_node *value)
 168 {
 169         assert(index < ARR_LEN(rsm->value_map));
 170         rsm->value_map[index] = value;
 171 }
 172
 173 static void rsm_set_reg_value(register_state_mapping_t *rsm,
 174                               const arch_register_t *reg, ir_node *value)
 175 {
 176         int cls_idx   = reg->reg_class->index;
 177         int reg_idx   = reg->index;
 178         int input_idx = rsm->reg_index_map[cls_idx][reg_idx];
 179         rsm_set_value(rsm, input_idx, value);
 180 }
 181
 182 static ir_node *rsm_create_barrier(register_state_mapping_t *rsm,
 183                                    ir_node *block)
 184 {
 185         int       n_barrier_outs = ARR_LEN(rsm->regs);
 186         ir_node **in             = rsm->value_map;
 187         ir_node  *barrier;
 188         int       o;
 189
 190         assert(ARR_LEN(rsm->value_map) == n_barrier_outs);
 191
 192         barrier = be_new_Barrier(block, n_barrier_outs, in);
 193
 194         for (o = 0; o < n_barrier_outs; ++o) {
 195                 const reg_flag_t      *regflag = &rsm->regs[o];
 196                 const arch_register_t *reg     = regflag->reg;
 197                 ir_node               *proj;
 198                 if (reg == NULL) {
 199                         arch_set_out_register_req(barrier, o, arch_no_register_req);
 200                         proj = new_r_Proj(barrier, mode_M, o);
 201                 } else {
 202                         be_set_constr_single_reg_in(barrier, o, reg, 0);
 203                         be_set_constr_single_reg_out(barrier, o, reg, regflag->flags);
 204                         proj = new_r_Proj(barrier, reg->reg_class->mode, o);
 205                 }
 206                 rsm->value_map[o] = proj;
 207         }
 208
 209         rsm->last_barrier = barrier;
 210
 211         return barrier;
 212 }
 213
 214
 215
 216
 217
 218 beabi_helper_env_t *be_abihelper_prepare(ir_graph *irg)
 219 {
 220         const arch_env_t   *arch_env = be_get_irg_arch_env(irg);
 221         beabi_helper_env_t *env      = XMALLOCZ(beabi_helper_env_t);
 222
 223         env->irg = irg;
 224         prepare_rsm(&env->prolog, arch_env);
 225         prepare_rsm(&env->epilog, arch_env);
 226
 227         return env;
 228 }
 229
 230 void be_abihelper_finish(beabi_helper_env_t *env)
 231 {
 232         const arch_env_t *arch_env = be_get_irg_arch_env(env->irg);
 233
 234         free_rsm(&env->prolog, arch_env);
 235         if (env->epilog.reg_index_map != NULL) {
 236                 free_rsm(&env->epilog, arch_env);
 237         }
 238         free(env);
 239 }
 240
 241 void be_prolog_add_reg(beabi_helper_env_t *env, const arch_register_t *reg,
 242                        arch_irn_flags_t flags)
 243 {
 244         rsm_add_reg(&env->prolog, reg, flags);
 245 }
 246
 247 ir_node *be_prolog_create_start(beabi_helper_env_t *env, dbg_info *dbgi,
 248                                 ir_node *block)
 249 {
 250         int      n_start_outs = ARR_LEN(env->prolog.regs);
 251         ir_node *start        = be_new_Start(dbgi, block, n_start_outs);
 252         int      o;
 253
 254         assert(env->prolog.value_map == NULL);
 255         env->prolog.value_map = NEW_ARR_F(ir_node*, n_start_outs);
 256
 257         for (o = 0; o < n_start_outs; ++o) {
 258                 const reg_flag_t      *regflag = &env->prolog.regs[o];
 259                 const arch_register_t *reg     = regflag->reg;
 260                 ir_node               *proj;
 261                 if (reg == NULL) {
 262                         arch_set_out_register_req(start, o, arch_no_register_req);
 263                         proj = new_r_Proj(start, mode_M, o);
 264                 } else {
 265                         be_set_constr_single_reg_out(start, o, regflag->reg,
 266                                                      regflag->flags);
 267                         arch_irn_set_register(start, o, regflag->reg);
 268                         proj = new_r_Proj(start, reg->reg_class->mode, o);
 269                 }
 270                 env->prolog.value_map[o] = proj;
 271         }
 272
 273         /* start node should really be the first thing constructed */
 274         assert(env->prolog.last_barrier == NULL);
 275         env->prolog.last_barrier = start;
 276
 277         return start;
 278 }
 279
 280 ir_node *be_prolog_create_barrier(beabi_helper_env_t *env, ir_node *block)
 281 {
 282         return rsm_create_barrier(&env->prolog, block);
 283 }
 284
 285 ir_node *be_prolog_get_reg_value(beabi_helper_env_t *env,
 286                                  const arch_register_t *reg)
 287 {
 288         return rsm_get_reg_value(&env->prolog, reg);
 289 }
 290
 291 ir_node *be_prolog_get_memory(beabi_helper_env_t *env)
 292 {
 293         return rsm_get_value(&env->prolog, 0);
 294 }
 295
 296 void be_prolog_set_reg_value(beabi_helper_env_t *env,
 297                              const arch_register_t *reg, ir_node *value)
 298 {
 299         rsm_set_reg_value(&env->prolog, reg, value);
 300 }
 301
 302 void be_prolog_set_memory(beabi_helper_env_t *env, ir_node *value)
 303 {
 304         rsm_set_value(&env->prolog, 0, value);
 305 }
 306
 307
 308
 309 void be_epilog_begin(beabi_helper_env_t *env)
 310 {
 311         const arch_env_t *arch_env = be_get_irg_arch_env(env->irg);
 312         rsm_clear_regs(&env->epilog, arch_env);
 313         env->epilog.value_map    = NEW_ARR_F(ir_node*, 1);
 314         env->epilog.value_map[0] = NULL;
 315 }
 316
 317 void be_epilog_add_reg(beabi_helper_env_t *env, const arch_register_t *reg,
 318                        arch_irn_flags_t flags, ir_node *value)
 319 {
 320         rsm_add_reg(&env->epilog, reg, flags);
 321         ARR_APP1(ir_node*, env->epilog.value_map, value);
 322 }
 323
 324 void be_epilog_set_reg_value(beabi_helper_env_t *env,
 325                              const arch_register_t *reg, ir_node *value)
 326 {
 327         rsm_set_reg_value(&env->epilog, reg, value);
 328 }
 329
 330 void be_epilog_set_memory(beabi_helper_env_t *env, ir_node *value)
 331 {
 332         rsm_set_value(&env->epilog, 0, value);
 333 }
 334
 335 ir_node *be_epilog_get_reg_value(beabi_helper_env_t *env,
 336                                  const arch_register_t *reg)
 337 {
 338         return rsm_get_reg_value(&env->epilog, reg);
 339 }
 340
 341 ir_node *be_epilog_get_memory(beabi_helper_env_t *env)
 342 {
 343         return rsm_get_value(&env->epilog, 0);
 344 }
 345
 346 ir_node *be_epilog_create_barrier(beabi_helper_env_t *env, ir_node *block)
 347 {
 348         return rsm_create_barrier(&env->epilog, block);
 349 }
 350
 351 ir_node *be_epilog_create_return(beabi_helper_env_t *env, dbg_info *dbgi,
 352                                  ir_node *block)
 353 {
 354         int       n_return_in = ARR_LEN(env->epilog.regs);
 355         ir_node **in          = env->epilog.value_map;
 356         int       n_res       = 1; /* TODO */
 357         unsigned  pop         = 0; /* TODO */
 358         int       i;
 359         ir_node  *ret;
 360
 361         assert(ARR_LEN(env->epilog.value_map) == n_return_in);
 362
 363         ret = be_new_Return(dbgi, get_irn_irg(block), block, n_res, pop,
 364                             n_return_in, in);
 365         for (i = 0; i < n_return_in; ++i) {
 366                 const reg_flag_t      *regflag = &env->epilog.regs[i];
 367                 const arch_register_t *reg     = regflag->reg;
 368                 if (reg != NULL) {
 369                         be_set_constr_single_reg_in(ret, i, reg, 0);
 370                 }
 371         }
 372
 373         rsm_clear_regs(&env->epilog, be_get_irg_arch_env(env->irg));
 374         env->epilog.last_barrier = NULL;
 375
 376         return ret;
 377 }
 378
 379 static void add_missing_keep_walker(ir_node *node, void *data)
 380 {
 381         int              n_outs, i;
 382         unsigned         found_projs = 0;
 383         const ir_edge_t *edge;
 384         ir_mode         *mode = get_irn_mode(node);
 385         ir_node         *last_keep;
 386         (void) data;
 387         if (mode != mode_T)
 388                 return;
 389
 390         n_outs = arch_irn_get_n_outs(node);
 391         if (n_outs <= 0)
 392                 return;
 393
 394         assert(n_outs < (int) sizeof(unsigned) * 8);
 395         foreach_out_edge(node, edge) {
 396                 ir_node *succ = get_edge_src_irn(edge);
 397                 int      pn;
 398
 399                 /* The node could be kept */
 400                 if (is_End(succ) || is_Anchor(succ))
 401                         continue;
 402
 403                 if (get_irn_mode(succ) == mode_M)
 404                         continue;
 405
 406                 pn = get_Proj_proj(succ);
 407                 assert(pn < n_outs);
 408                 found_projs |= 1 << pn;
 409         }
 410
 411
 412         /* are keeps missing? */
 413         last_keep = NULL;
 414         for (i = 0; i < n_outs; ++i) {
 415                 ir_node                     *block;
 416                 ir_node                     *in[1];
 417                 const arch_register_req_t   *req;
 418                 const arch_register_class_t *cls;
 419
 420                 if (found_projs & (1 << i)) {
 421                         continue;
 422                 }
 423
 424                 req = arch_get_out_register_req(node, i);
 425                 cls = req->cls;
 426                 if (cls == NULL || (cls->flags & arch_register_class_flag_manual_ra)) {
 427                         continue;
 428                 }
 429
 430                 block = get_nodes_block(node);
 431                 in[0] = new_r_Proj(node, arch_register_class_mode(cls), i);
 432                 if (last_keep != NULL) {
 433                         be_Keep_add_node(last_keep, cls, in[0]);
 434                 } else {
 435                         last_keep = be_new_Keep(block, 1, in);
 436                         if (sched_is_scheduled(node)) {
 437                                 sched_add_after(node, last_keep);
 438                         }
 439                 }
 440         }
 441 }
 442
 443 void be_add_missing_keeps(ir_graph *irg)
 444 {
 445         irg_walk_graph(irg, add_missing_keep_walker, NULL, NULL);
 446 }
 447
 448
 449
 450 static void collect_node(ir_node *node)
 451 {
 452         ir_node *block = get_nodes_block(node);
 453         ir_node *old   = get_irn_link(block);
 454
 455         set_irn_link(node, old);
 456         set_irn_link(block, node);
 457 }
 458
 459 static void link_ops_in_block_walker(ir_node *node, void *data)
 460 {
 461         (void) data;
 462
 463         switch (get_irn_opcode(node)) {
 464         case iro_Return:
 465         case iro_Call:
 466                 collect_node(node);
 467                 break;
 468         case iro_Alloc:
 469                 /** all non-stack alloc nodes should be lowered before the backend */
 470                 assert(get_Alloc_where(node) == stack_alloc);
 471                 collect_node(node);
 472                 break;
 473         case iro_Free:
 474                 assert(get_Free_where(node) == stack_alloc);
 475                 collect_node(node);
 476                 break;
 477         case iro_Builtin:
 478                 if (get_Builtin_kind(node) == ir_bk_return_address) {
 479                         ir_node *param = get_Builtin_param(node, 0);
 480                         tarval  *tv    = get_Const_tarval(param); /* must be Const */
 481                         long     value = get_tarval_long(tv);
 482                         if (value > 0) {
 483                                 /* we need esp for the climbframe algo */
 484                                 collect_node(node);
 485                         }
 486                 }
 487                 break;
 488         default:
 489                 break;
 490         }
 491 }
 492
 493 static heights_t *heights;
 494
 495 /**
 496  * Check if a node is somehow data dependent on another one.
 497  * both nodes must be in the same basic block.
 498  * @param n1 The first node.
 499  * @param n2 The second node.
 500  * @return 1, if n1 is data dependent (transitively) on n2, 0 if not.
 501  */
 502 static int dependent_on(const ir_node *n1, const ir_node *n2)
 503 {
 504         assert(get_nodes_block(n1) == get_nodes_block(n2));
 505
 506         return heights_reachable_in_block(heights, n1, n2);
 507 }
 508
 509 static int cmp_call_dependency(const void *c1, const void *c2)
 510 {
 511         const ir_node *n1 = *(const ir_node **) c1;
 512         const ir_node *n2 = *(const ir_node **) c2;
 513
 514         /*
 515                 Classical qsort() comparison function behavior:
 516                 0  if both elements are equal
 517                 1  if second is "smaller" that first
 518                 -1 if first is "smaller" that second
 519         */
 520         if (dependent_on(n1, n2))
 521                 return 1;
 522
 523         if (dependent_on(n2, n1))
 524                 return -1;
 525
 526         /* The nodes have no depth order, but we need a total order because qsort()
 527          * is not stable. */
 528         return get_irn_idx(n2) - get_irn_idx(n1);
 529 }
 530
 531 static void process_ops_in_block(ir_node *block, void *data)
 532 {
 533         ir_phase *phase = data;
 534         unsigned  n;
 535         unsigned  n_nodes;
 536         ir_node  *node;
 537         ir_node **nodes;
 538
 539         n_nodes = 0;
 540         for (node = get_irn_link(block); node != NULL; node = get_irn_link(node)) {
 541                 ++n_nodes;
 542         }
 543
 544         if (n_nodes == 0)
 545                 return;
 546
 547         nodes = XMALLOCN(ir_node*, n_nodes);
 548         n = 0;
 549         for (node = get_irn_link(block); node != NULL; node = get_irn_link(node)) {
 550                 nodes[n++] = node;;
 551         }
 552         assert(n == n_nodes);
 553
 554         /* order nodes according to their data dependencies */
 555         qsort(nodes, n_nodes, sizeof(nodes[0]), cmp_call_dependency);
 556
 557         for (n = n_nodes-1; n > 0; --n) {
 558                 ir_node *node = nodes[n];
 559                 ir_node *pred = nodes[n-1];
 560
 561                 phase_set_irn_data(phase, node, pred);
 562         }
 563 }
 564
 565 void be_collect_stacknodes(beabi_helper_env_t *env)
 566 {
 567         ir_graph *irg = env->irg;
 568         irg_walk_graph(irg, firm_clear_link, link_ops_in_block_walker, NULL);
 569
 570         assert(env->stack_order == NULL);
 571         env->stack_order = new_phase(irg, phase_irn_init_default);
 572
 573         heights = heights_new(irg);
 574         irg_block_walk_graph(irg, NULL, process_ops_in_block, env->stack_order);
 575         heights_free(heights);
 576 }
 577
 578 ir_node *be_get_stack_pred(const beabi_helper_env_t *env, const ir_node *node)
 579 {
 580         return phase_get_irn_data(env->stack_order, node);
 581 }