nsz Git - libfirm/blob - ir/be/beabi.h

   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       Backend ABI implementation.
  23  * @author      Sebastian Hack
  24  * @version     $Id$
  25  */
  26 #ifndef FIRM_BE_BEABI_H
  27 #define FIRM_BE_BEABI_H
  28
  29 #include "firm_types.h"
  30
  31 #include "pset.h"
  32 #include "pmap.h"
  33 #include "bitset.h"
  34
  35 #include "be.h"
  36 #include "beirg.h"
  37 #include "bearch.h"
  38 #include "beabi.h"
  39
  40 struct _be_abi_call_flags_bits_t {
  41         unsigned left_to_right          : 1;  /**< Arguments are from left to right. */
  42         unsigned store_args_sequential  : 1;  /**< Use sequential stores for arguments. */
  43         unsigned try_omit_fp            : 1;  /**< Try to omit the frame pointer. */
  44         unsigned fp_free                : 1;  /**< The function can use any register as frame pointer. */
  45         unsigned call_has_imm           : 1;  /**< A call can take the callee's address as an immediate. */
  46         unsigned irg_is_leaf            : 1;  /**< 1, if the IRG is a leaf function. */
  47         unsigned frame_is_setup_on_call : 1;  /**< Set to one, if there is already enough room on the stack for call args. */
  48 };
  49
  50 union _be_abi_call_flags_t {
  51         be_abi_call_flags_bits_t bits;
  52         unsigned val;
  53 };
  54
  55 struct _be_abi_callbacks_t {
  56         /**
  57          * Initialize the callback object.
  58          * @param call The call object.
  59          * @param aenv The architecture environment.
  60          * @param irg  The graph with the method.
  61          * @return     Some pointer. This pointer is passed to all other callback functions as self object.
  62          */
  63         void *(*init)(const be_abi_call_t *call, const arch_env_t *aenv, ir_graph *irg);
  64
  65         /**
  66          * Destroy the callback object.
  67          * @param self The callback object.
  68          */
  69         void (*done)(void *self);
  70
  71         /**
  72          * Get the between type for that call.
  73          * @param self The callback object.
  74          * @return The between type of for that call.
  75          */
  76         ir_type *(*get_between_type)(void *self);
  77
  78         /**
  79          * Generate the prologue.
  80          * @param self       The callback object.
  81          * @param mem        A pointer to the mem node. Update this if you define new memory.
  82          * @param reg_map    A map mapping all callee_save/ignore/parameter registers to their defining nodes.
  83          * @param stack_bias Points to the current stack bias, can be modified if needed.
  84          * @return           The register which shall be used as a stack frame base.
  85          *
  86          * All nodes which define registers in @p reg_map must keep @p reg_map current.
  87          */
  88         const arch_register_t *(*prologue)(void *self, ir_node **mem, pmap *reg_map, int *stack_bias);
  89
  90         /**
  91          * Generate the epilogue.
  92          * @param self    The callback object.
  93          * @param mem     Memory one can attach to.
  94          * @param reg_map A mapping mapping all callee_save/ignore/return registers to their defining nodes.
  95          *
  96      * All nodes which define registers in @p reg_map must keep @p reg_map current.
  97          * Also, the @p mem variable must be updated, if memory producing nodes are inserted.
  98          */
  99         void (*epilogue)(void *self, ir_node *bl, ir_node **mem, pmap *reg_map);
 100 };
 101
 102 /**
 103  * Set the flags for a call.
 104  * @param call          The call.
 105  * @param flags         Some flags to be set.
 106  * @param cb            The call callbacks for that call.
 107  * @note                The ABI phase might change the flags due to analysis.
 108  */
 109 void be_abi_call_set_flags(be_abi_call_t *call, be_abi_call_flags_t flags, const be_abi_callbacks_t *cb);
 110
 111 /**
 112  * Sets the number of bytes the stackframe is shrinked by the callee on return
 113  */
 114 void be_abi_call_set_pop(be_abi_call_t *call, int pop);
 115
 116 /**
 117  * Set register class for call address.
 118  * @param call      The call.
 119  * @param cls       The register class for call address.
 120  */
 121 void be_abi_call_set_call_address_reg_class(be_abi_call_t *call, const arch_register_class_t *cls);
 122
 123 /**
 124  * The ABI can change when we call a function vs. when we have
 125  * been called.
 126  */
 127 typedef enum {
 128         ABI_CONTEXT_CALLEE = 1 << 0,
 129         ABI_CONTEXT_CALLER = 1 << 1,
 130         ABI_CONTEXT_BOTH   = ABI_CONTEXT_CALLEE | ABI_CONTEXT_CALLER
 131 } be_abi_context_t;
 132
 133 /**
 134  * Record the that ABI transmits call argument pos on the stack. Modifies the abi object.
 135  *
 136  * @param call          the abi call object
 137  * @param pos           the parameter position
 138  * @param load_mode     load the parameter with this mode (if the parameter mode is different from this mode a Conv is inserted)
 139  * @param alignment     stack alignment for the parameter on the current architecture
 140  * @param space_before  size of allocated additional space before the parameter
 141  * @param space_after   size of allocated additional space after the parameter
 142  */
 143 void be_abi_call_param_stack(be_abi_call_t *call, int pos, ir_mode *load_mode,
 144                              unsigned alignment, unsigned space_before,
 145                              unsigned space_after, be_abi_context_t context);
 146
 147 /**
 148  * Record the that ABI transmits call argument pos in the given register.
 149  *
 150  * @param call          the abi call object
 151  * @param pos           the parameter position
 152  * @param reg           the register used
 153  */
 154 void be_abi_call_param_reg(be_abi_call_t *call, int pos,
 155                            const arch_register_t *reg,
 156                            be_abi_context_t context);
 157
 158 /**
 159  * Record the that ABI transmits return value pos in the given register.
 160  *
 161  * @param call          the abi call object
 162  * @param pos           the return value position
 163  * @param reg           the register used
 164  */
 165 void be_abi_call_res_reg(be_abi_call_t *call, int pos,
 166                          const arch_register_t *reg,
 167                          be_abi_context_t context);
 168
 169 /**
 170  * Get the flags of a ABI call object.
 171  * Note that the flags must not be the same as set by be_abi_call_set_flags(). Analysis may have
 172  * altered several flags, so getting them from the call object is always a good idea.
 173  * @param call The call object.
 174  * @return The flags.
 175  */
 176 be_abi_call_flags_t be_abi_call_get_flags(const be_abi_call_t *call);
 177
 178 /**
 179  * Get the method type of an ABI call object.
 180  * @param call The call object.
 181  * @return The method type for that call object.
 182  */
 183 ir_type *be_abi_call_get_method_type(const be_abi_call_t *call);
 184
 185 be_abi_irg_t *be_abi_introduce(be_irg_t *bi);
 186
 187 /**
 188  * Fix the stack bias for all nodes accessing the stack frame using the
 189  * stack pointer.
 190  */
 191 void be_abi_fix_stack_bias(be_abi_irg_t *env);
 192 void be_abi_free(be_abi_irg_t *abi);
 193
 194 /**
 195  * Rewire all stack modifying nodes and their users to assure SSA property.
 196  * @param env   The abi
 197  */
 198 void be_abi_fix_stack_nodes(be_abi_irg_t *env);
 199
 200 /**
 201  * Put the registers which are forbidden specifically for this IRG in a bitset.
 202  */
 203 void be_abi_put_ignore_regs(be_abi_irg_t *abi, const arch_register_class_t *cls, bitset_t *bs);
 204
 205 void be_abi_set_non_ignore_regs(be_abi_irg_t *abi, const arch_register_class_t *cls, unsigned *raw_bitset);
 206
 207 ir_node *be_abi_get_callee_save_irn(be_abi_irg_t *abi, const arch_register_t *reg);
 208 ir_node *be_abi_get_ignore_irn(be_abi_irg_t *abi, const arch_register_t *reg);
 209
 210 #define be_abi_reg_map_get(map, reg)       pmap_get((map), (void *) (reg))
 211 #define be_abi_reg_map_set(map, reg, irn)  pmap_insert((map), (void *) (reg), (irn))
 212
 213 /** The number of parts of the stack layout. */
 214 #define N_FRAME_TYPES 3
 215
 216 /**
 217  * This type describes the stack layout.
 218  * The stack is divided into 3 parts:
 219  * - arg_type:     A struct type describing the stack arguments and it's order.
 220  * - between_type: A struct type describing the stack layout between arguments
 221  *                 and frame type. In architectures that put the return address
 222  *                 automatically on the stack, the return address is put here.
 223  * - frame_type:   A class type describing the frame layout.
 224  */
 225 struct _be_stack_layout_t {
 226         ir_type *arg_type;                 /**< A type describing the stack argument layout. */
 227         ir_type *between_type;             /**< A type describing the "between" layout. */
 228         ir_type *frame_type;               /**< The frame type. */
 229
 230         ir_type *order[N_FRAME_TYPES];     /**< arg, between and frame types ordered. */
 231
 232         ir_entity **param_map;             /**< An array mapping type parameters to arg_type entries */
 233         int initial_offset;                /**< the initial difference between stack pointer and frame pointer */
 234         int initial_bias;                  /**< the initial stack bias */
 235         int stack_dir;                     /**< -1 for decreasing, 1 for increasing. */
 236 };
 237
 238 /**
 239  * Returns the stack layout from a abi environment.
 240  */
 241 const be_stack_layout_t *be_abi_get_stack_layout(const be_abi_irg_t *abi);
 242
 243 /**
 244  * Returns non-zero if the ABI has omitted the frame pointer in
 245  * the current graph.
 246  */
 247 int be_abi_omit_fp(const be_abi_irg_t *abi);
 248
 249 #endif /* FIRM_BE_BEABI_H */