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

   1
   2 /**
   3  * Backend ABI implementation.
   4  */
   5
   6 #ifndef _BEABI_H
   7 #define _BEABI_H
   8
   9 #include "firm_types.h"
  10
  11 #include "pset.h"
  12 #include "pmap.h"
  13 #include "bitset.h"
  14
  15 #include "be.h"
  16 #include "bearch.h"
  17 #include "beabi_t.h"
  18
  19 struct _be_abi_call_flags_bits_t {
  20         unsigned left_to_right          : 1;  /**< Arguments are from left to right. */
  21         unsigned store_args_sequential  : 1;  /**< Use sequential stores for arguments. */
  22         unsigned try_omit_fp            : 1;  /**< Try to omit the frame pointer. */
  23         unsigned fp_free                : 1;  /**< The function can use any register as frame pointer. */
  24         unsigned call_has_imm           : 1;  /**< A call can take the callee's address as an immediate. */
  25         unsigned irg_is_leaf            : 1;  /**< 1, if the IRG is a leaf function. */
  26         unsigned frame_is_setup_on_call : 1;  /**< Set to one, if there is already enough room on the stack for call args. */
  27 };
  28
  29 union _be_abi_call_flags_t {
  30         be_abi_call_flags_bits_t bits;
  31         unsigned val;
  32 };
  33
  34 struct _be_abi_callbacks_t {
  35         /**
  36          * Initialize the callback object.
  37          * @param call The call object.
  38          * @param aenv The architecture environment.
  39          * @param irg  The graph with the method.
  40          * @return     Some pointer. This pointer is passed to all other callback functions as self object.
  41          */
  42         void *(*init)(const be_abi_call_t *call, const arch_env_t *aenv, ir_graph *irg);
  43
  44         /**
  45          * Destroy the callback object.
  46          * @param self The callback object.
  47          */
  48         void (*done)(void *self);
  49
  50         /**
  51          * Get the between type for that call.
  52          * @param self The callback object.
  53          * @return The between type of for that call.
  54          */
  55         ir_type *(*get_between_type)(void *self);
  56
  57         /**
  58          * Put all registers which are saved by the prologue/epilogue in a set.
  59          * @param self The callback object.
  60          * @param regs A set.
  61          */
  62         void (*regs_saved_by_me)(void *self, pset *regs);
  63
  64         /**
  65          * Generate the prologue.
  66          * @param self    The callback object.
  67          * @param mem     A pointer to the mem node. Update this if you define new memory.
  68          * @param reg_map A mapping mapping all callee_save/ignore/parameter registers to their defining nodes.
  69          * @return        The register which shall be used as a stack frame base.
  70          *
  71          * All nodes which define registers in @p reg_map must keep @p reg_map current.
  72          */
  73         const arch_register_t *(*prologue)(void *self, ir_node **mem, pmap *reg_map);
  74
  75         /**
  76          * Generate the epilogue.
  77          * @param self    The callback object.
  78          * @param mem     Memory one can attach to.
  79          * @param reg_map A mapping mapping all callee_save/ignore/return registers to their defining nodes.
  80          *
  81      * All nodes which define registers in @p reg_map must keep @p reg_map current.
  82          * Also, the @p mem variable must be updated, if memory producing nodes are inserted.
  83          */
  84         void (*epilogue)(void *self, ir_node *bl, ir_node **mem, pmap *reg_map);
  85 };
  86
  87 /**
  88  * Set the flags for a call.
  89  * @param call          The call.
  90  * @param flags         Some flags to be set.
  91  * @param cb            The call callbacks for that call.
  92  * @note                The ABI phase might change the flags due to analysis.
  93  */
  94 void be_abi_call_set_flags(be_abi_call_t *call, be_abi_call_flags_t flags, const be_abi_callbacks_t *cb);
  95
  96 /**
  97  * Set register class for call address.
  98  * @param call      The call.
  99  * @param cls       The register class for call address.
 100  */
 101 void be_abi_call_set_call_address_reg_class(be_abi_call_t *call, const arch_register_class_t *cls);
 102
 103 void be_abi_call_param_stack(be_abi_call_t *call, int pos, unsigned alignment, unsigned space_before, unsigned space_after);
 104 void be_abi_call_param_reg(be_abi_call_t *call, int pos, const arch_register_t *reg);
 105 void be_abi_call_res_reg(be_abi_call_t *call, int pos, const arch_register_t *reg);
 106
 107 /**
 108  * Get the flags of a ABI call object.
 109  * Note that the flags must not be the same as set by be_abi_call_set_flags(). Analysis may have
 110  * altered several flags, so getting them from the call object is always a good idea.
 111  * @param call The call object.
 112  * @return The flags.
 113  */
 114 be_abi_call_flags_t be_abi_call_get_flags(const be_abi_call_t *call);
 115
 116 /**
 117  * Get the method type of an ABI call object.
 118  * @param call The call object.
 119  * @return The method type for that call object.
 120  */
 121 ir_type *be_abi_call_get_method_type(const be_abi_call_t *call);
 122
 123 be_abi_irg_t *be_abi_introduce(be_irg_t *bi);
 124 void be_abi_fix_stack_bias(be_abi_irg_t *env);
 125 void be_abi_fix_stack_nodes(be_abi_irg_t *env, be_lv_t *lv);
 126 void be_abi_free(be_abi_irg_t *abi);
 127
 128 /**
 129  * Put the registers which are forbidden specifically for this IRG in a bitset.
 130  */
 131 void be_abi_put_ignore_regs(be_abi_irg_t *abi, const arch_register_class_t *cls, bitset_t *bs);
 132
 133 ir_node *be_abi_get_callee_save_irn(be_abi_irg_t *abi, const arch_register_t *reg);
 134 ir_node *be_abi_get_ignore_irn(be_abi_irg_t *abi, const arch_register_t *reg);
 135 ir_node *be_abi_get_start_barrier(be_abi_irg_t *abi);
 136
 137 #define be_abi_reg_map_get(map, reg)       pmap_get((map), (void *) (reg))
 138 #define be_abi_reg_map_set(map, reg, irn)  pmap_insert((map), (void *) (reg), (irn))
 139
 140 #define N_FRAME_TYPES 3
 141
 142 /**
 143  * This type describes the stack layout.
 144  * The stack is divided into 3 parts:
 145  * - arg_type:     A struct type describing the stack arguments and it's order.
 146  * - between_type: A struct type describing the stack layout between arguments
 147  *                 and frame type
 148  * - frame_type:   A class type describing the frame layout
 149  */
 150 struct _be_stack_layout_t {
 151         ir_type *arg_type;                 /**< A type describing the stack argument layout. */
 152         ir_type *between_type;             /**< A type describing the "between" layout. */
 153         ir_type *frame_type;               /**< The frame type. */
 154
 155         ir_type *order[N_FRAME_TYPES];     /**< arg, between and frame types ordered. */
 156
 157         int initial_offset;
 158         int stack_dir;                     /**< -1 for decreasing, 1 for increasing. */
 159         entity **param_map;                /**< An array mapping type parameters to arg_type entries */
 160 };
 161
 162 /**
 163  * Returns the stack layout from a abi environment.
 164  */
 165 const be_stack_layout_t *be_abi_get_stack_layout(const be_abi_irg_t *abi);
 166
 167 /**
 168  * Returns non-zero if the ABI has omitted the frame pointer in
 169  * the current graph.
 170  */
 171 int be_abi_omit_fp(const be_abi_irg_t *abi);
 172
 173 #endif /* _BEABI_H */