nsz Git - libfirm/blob - ir/be/bestack.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  * @author      Sebastian Hack, Matthias Braun
  23  *
  24  * Handling of the stack frame. It is composed of three types:
  25  * 1) The type of the arguments which are pushed on the stack.
  26  * 2) The "between type" which consists of stuff the call of the
  27  *    function pushes on the stack (like the return address and
  28  *    the old base pointer for ia32).
  29  * 3) The Firm frame type which consists of all local variables
  30  *    and the spills.
  31  */
  32 #include "config.h"
  33
  34 #include "bestack.h"
  35 #include "beirg.h"
  36 #include "besched.h"
  37 #include "benode.h"
  38 #include "bessaconstr.h"
  39
  40 #include "ircons_t.h"
  41 #include "irnode_t.h"
  42 #include "irgwalk.h"
  43 #include "irgmod.h"
  44
  45 int be_get_stack_entity_offset(be_stack_layout_t *frame, ir_entity *ent,
  46                                int bias)
  47 {
  48         ir_type *t = get_entity_owner(ent);
  49         int ofs    = get_entity_offset(ent);
  50
  51         int index;
  52
  53         /* Find the type the entity is contained in. */
  54         for (index = 0; index < N_FRAME_TYPES; ++index) {
  55                 if (frame->order[index] == t)
  56                         break;
  57                 /* Add the size of all the types below the one of the entity to the entity's offset */
  58                 ofs += get_type_size_bytes(frame->order[index]);
  59         }
  60
  61         /* correct the offset by the initial position of the frame pointer */
  62         ofs -= frame->initial_offset;
  63
  64         /* correct the offset with the current bias. */
  65         ofs += bias;
  66
  67         return ofs;
  68 }
  69
  70 /**
  71  * Retrieve the entity with given offset from a frame type.
  72  */
  73 static ir_entity *search_ent_with_offset(ir_type *t, int offset)
  74 {
  75         int i, n;
  76
  77         for (i = 0, n = get_compound_n_members(t); i < n; ++i) {
  78                 ir_entity *ent = get_compound_member(t, i);
  79                 if (get_entity_offset(ent) == offset)
  80                         return ent;
  81         }
  82
  83         return NULL;
  84 }
  85
  86 static int stack_frame_compute_initial_offset(be_stack_layout_t *frame)
  87 {
  88         ir_type  *base = frame->between_type;
  89         ir_entity *ent = search_ent_with_offset(base, 0);
  90
  91         if (ent == NULL) {
  92                 frame->initial_offset = get_type_size_bytes(frame->frame_type);
  93         } else {
  94                 frame->initial_offset = be_get_stack_entity_offset(frame, ent, 0);
  95         }
  96
  97         return frame->initial_offset;
  98 }
  99
 100 /**
 101  * Walker: finally lower all Sels of outer frame or parameter
 102  * entities.
 103  */
 104 static void lower_outer_frame_sels(ir_node *sel, void *ctx)
 105 {
 106         ir_node           *ptr;
 107         ir_entity         *ent;
 108         ir_type           *owner;
 109         be_stack_layout_t *layout;
 110         ir_graph          *irg;
 111         (void) ctx;
 112
 113         if (! is_Sel(sel))
 114                 return;
 115
 116         ent    = get_Sel_entity(sel);
 117         owner  = get_entity_owner(ent);
 118         ptr    = get_Sel_ptr(sel);
 119         irg    = get_irn_irg(sel);
 120         layout = be_get_irg_stack_layout(irg);
 121
 122         if (owner == layout->frame_type || owner == layout->arg_type) {
 123                 /* found access to outer frame or arguments */
 124                 int offset = be_get_stack_entity_offset(layout, ent, 0);
 125
 126                 if (offset != 0) {
 127                         ir_node  *bl   = get_nodes_block(sel);
 128                         dbg_info *dbgi = get_irn_dbg_info(sel);
 129                         ir_mode  *mode = get_irn_mode(sel);
 130                         ir_mode  *mode_UInt = get_reference_mode_unsigned_eq(mode);
 131                         ir_node  *cnst = new_r_Const_long(current_ir_graph, mode_UInt, offset);
 132
 133                         ptr = new_rd_Add(dbgi, bl, ptr, cnst, mode);
 134                 }
 135                 exchange(sel, ptr);
 136         }
 137 }
 138
 139 /**
 140  * A helper struct for the bias walker.
 141  */
 142 typedef struct bias_walk {
 143         int      start_block_bias; /**< The bias at the end of the start block. */
 144         ir_node *start_block;      /**< The start block of the current graph. */
 145 } bias_walk;
 146
 147 /**
 148  * Fix all stack accessing operations in the block bl.
 149  *
 150  * @param bl         the block to process
 151  * @param real_bias  the bias value
 152  *
 153  * @return the bias at the end of this block
 154  */
 155 static int process_stack_bias(ir_node *bl, int real_bias)
 156 {
 157         int                wanted_bias = real_bias;
 158         ir_graph          *irg         = get_Block_irg(bl);
 159         be_stack_layout_t *layout      = be_get_irg_stack_layout(irg);
 160         bool               sp_relative = layout->sp_relative;
 161         const arch_env_t  *arch_env    = be_get_irg_arch_env(irg);
 162
 163         sched_foreach(bl, irn) {
 164                 int ofs;
 165
 166                 /*
 167                    Check, if the node relates to an entity on the stack frame.
 168                    If so, set the true offset (including the bias) for that
 169                    node.
 170                  */
 171                 ir_entity *ent = arch_get_frame_entity(irn);
 172                 if (ent != NULL) {
 173                         int bias   = sp_relative ? real_bias : 0;
 174                         int offset = be_get_stack_entity_offset(layout, ent, bias);
 175                         arch_set_frame_offset(irn, offset);
 176                 }
 177
 178                 /*
 179                  * If the node modifies the stack pointer by a constant offset,
 180                  * record that in the bias.
 181                  */
 182                 if (be_is_IncSP(irn)) {
 183                         ofs = be_get_IncSP_offset(irn);
 184                         /* fill in real stack frame size */
 185                         if (be_get_IncSP_align(irn)) {
 186                                 /* patch IncSP to produce an aligned stack pointer */
 187                                 int const between_size = get_type_size_bytes(layout->between_type);
 188                                 int const alignment    = 1 << arch_env->stack_alignment;
 189                                 int const delta        = (real_bias + ofs + between_size) & (alignment - 1);
 190                                 assert(ofs >= 0);
 191                                 if (delta > 0) {
 192                                         be_set_IncSP_offset(irn, ofs + alignment - delta);
 193                                         real_bias += alignment - delta;
 194                                 }
 195                         } else {
 196                                 /* adjust so real_bias corresponds with wanted_bias */
 197                                 int delta = wanted_bias - real_bias;
 198                                 assert(delta <= 0);
 199                                 if (delta != 0) {
 200                                         be_set_IncSP_offset(irn, ofs + delta);
 201                                         real_bias += delta;
 202                                 }
 203                         }
 204                         real_bias   += ofs;
 205                         wanted_bias += ofs;
 206                 } else {
 207                         ofs = arch_get_sp_bias(irn);
 208                         if (ofs == SP_BIAS_RESET) {
 209                                 real_bias   = 0;
 210                                 wanted_bias = 0;
 211                         } else {
 212                                 real_bias   += ofs;
 213                                 wanted_bias += ofs;
 214                         }
 215                 }
 216         }
 217
 218         assert(real_bias == wanted_bias);
 219         return real_bias;
 220 }
 221
 222 /**
 223  * Block-Walker: fix all stack offsets for all blocks
 224  * except the start block
 225  */
 226 static void stack_bias_walker(ir_node *bl, void *data)
 227 {
 228         bias_walk *bw = (bias_walk*)data;
 229         if (bl != bw->start_block) {
 230                 process_stack_bias(bl, bw->start_block_bias);
 231         }
 232 }
 233
 234 void be_abi_fix_stack_bias(ir_graph *irg)
 235 {
 236         be_stack_layout_t *stack_layout = be_get_irg_stack_layout(irg);
 237         ir_type           *frame_tp;
 238         int                i;
 239         bias_walk          bw;
 240
 241         stack_frame_compute_initial_offset(stack_layout);
 242
 243         /* Determine the stack bias at the end of the start block. */
 244         bw.start_block_bias = process_stack_bias(get_irg_start_block(irg),
 245                                                  stack_layout->initial_bias);
 246
 247         /* fix the bias is all other blocks */
 248         bw.start_block = get_irg_start_block(irg);
 249         irg_block_walk_graph(irg, stack_bias_walker, NULL, &bw);
 250
 251         /* fix now inner functions: these still have Sel node to outer
 252            frame and parameter entities */
 253         frame_tp = get_irg_frame_type(irg);
 254         for (i = get_class_n_members(frame_tp) - 1; i >= 0; --i) {
 255                 ir_entity *ent = get_class_member(frame_tp, i);
 256                 ir_graph  *irg = get_entity_irg(ent);
 257
 258                 if (irg != NULL) {
 259                         irg_walk_graph(irg, NULL, lower_outer_frame_sels, NULL);
 260                 }
 261         }
 262 }
 263
 264 typedef struct fix_stack_walker_env_t {
 265         ir_node **sp_nodes;
 266 } fix_stack_walker_env_t;
 267
 268 /**
 269  * Walker. Collect all stack modifying nodes.
 270  */
 271 static void collect_stack_nodes_walker(ir_node *node, void *data)
 272 {
 273         ir_node                   *insn = node;
 274         fix_stack_walker_env_t    *env  = (fix_stack_walker_env_t*)data;
 275         const arch_register_req_t *req;
 276
 277         if (is_Proj(node)) {
 278                 insn = get_Proj_pred(node);
 279         }
 280
 281         if (arch_get_irn_n_outs(insn) == 0)
 282                 return;
 283         if (get_irn_mode(node) == mode_T)
 284                 return;
 285
 286         req = arch_get_irn_register_req(node);
 287         if (! (req->type & arch_register_req_type_produces_sp))
 288                 return;
 289
 290         ARR_APP1(ir_node*, env->sp_nodes, node);
 291 }
 292
 293 void be_abi_fix_stack_nodes(ir_graph *irg)
 294 {
 295         be_lv_t                   *lv       = be_get_irg_liveness(irg);
 296         const arch_env_t          *arch_env = be_get_irg_arch_env(irg);
 297         be_irg_t                  *birg     = be_birg_from_irg(irg);
 298         const arch_register_req_t *sp_req   = birg->sp_req;
 299         const arch_register_t     *sp       = arch_env->sp;
 300         be_ssa_construction_env_t  senv;
 301         int i, len;
 302         ir_node **phis;
 303         fix_stack_walker_env_t walker_env;
 304
 305         if (sp_req == NULL) {
 306                 struct obstack      *obst = be_get_be_obst(irg);
 307                 arch_register_req_t *new_sp_req;
 308                 unsigned            *limited_bitset;
 309
 310                 new_sp_req        = OALLOCZ(obst, arch_register_req_t);
 311                 new_sp_req->type  = arch_register_req_type_limited
 312                                   | arch_register_req_type_produces_sp;
 313                 new_sp_req->cls   = arch_env->sp->reg_class;
 314                 new_sp_req->width = 1;
 315
 316                 limited_bitset = rbitset_obstack_alloc(obst, new_sp_req->cls->n_regs);
 317                 rbitset_set(limited_bitset, sp->index);
 318                 new_sp_req->limited = limited_bitset;
 319
 320                 if (!rbitset_is_set(birg->allocatable_regs, sp->global_index)) {
 321                         new_sp_req->type |= arch_register_req_type_ignore;
 322                 }
 323
 324                 sp_req = new_sp_req;
 325                 birg->sp_req = new_sp_req;
 326         }
 327
 328         walker_env.sp_nodes = NEW_ARR_F(ir_node*, 0);
 329
 330         irg_walk_graph(irg, collect_stack_nodes_walker, NULL, &walker_env);
 331
 332         /* nothing to be done if we didn't find any node, in fact we mustn't
 333          * continue, as for endless loops incsp might have had no users and is bad
 334          * now.
 335          */
 336         len = ARR_LEN(walker_env.sp_nodes);
 337         if (len == 0) {
 338                 DEL_ARR_F(walker_env.sp_nodes);
 339                 return;
 340         }
 341
 342         be_ssa_construction_init(&senv, irg);
 343         be_ssa_construction_add_copies(&senv, walker_env.sp_nodes,
 344                                    ARR_LEN(walker_env.sp_nodes));
 345         be_ssa_construction_fix_users_array(&senv, walker_env.sp_nodes,
 346                                             ARR_LEN(walker_env.sp_nodes));
 347
 348         if (lv != NULL) {
 349                 len = ARR_LEN(walker_env.sp_nodes);
 350                 for (i = 0; i < len; ++i) {
 351                         be_liveness_update(lv, walker_env.sp_nodes[i]);
 352                 }
 353                 be_ssa_construction_update_liveness_phis(&senv, lv);
 354         }
 355
 356         phis = be_ssa_construction_get_new_phis(&senv);
 357
 358         /* set register requirements for stack phis */
 359         len = ARR_LEN(phis);
 360         for (i = 0; i < len; ++i) {
 361                 ir_node *phi = phis[i];
 362                 be_set_phi_reg_req(phi, sp_req);
 363                 arch_set_irn_register(phi, arch_env->sp);
 364         }
 365         be_ssa_construction_destroy(&senv);
 366         DEL_ARR_F(walker_env.sp_nodes);
 367
 368         /* when doing code with frame-pointers then often the last incsp-nodes are
 369          * not used anymore because we copy the framepointer to the stack pointer
 370          * when leaving the function. Though the last incsp is often kept (because
 371          * you often don't know which incsp is the last one and fixstack should find
 372          * them all). Remove unnecessary keeps and IncSP nodes */
 373         {
 374                 ir_node  *end    = get_irg_end(irg);
 375                 int       arity  = get_irn_arity(end);
 376                 int       i;
 377                 for (i = arity-1; i >= 0; --i) {
 378                         ir_node *in = get_irn_n(end, i);
 379                         if (!be_is_IncSP(in)) {
 380                                 continue;
 381                         }
 382
 383                         remove_End_keepalive(end, in);
 384                         if (get_irn_n_edges(in) == 0) {
 385                                 sched_remove(in);
 386                                 kill_node(in);
 387                         }
 388                 }
 389         }
 390 }