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 "pset.h"
  10 #include "firm_types.h"
  11
  12 #include "be.h"
  13 #include "bearch.h"
  14 #include "beabi_t.h"
  15
  16 struct _be_abi_call_flags_bits_t {
  17         unsigned left_to_right          : 1;  /**< Arguments are from left to right. */
  18         unsigned store_args_sequential  : 1;  /**< Use sequential stores for arguments. */
  19         unsigned try_omit_fp            : 1;  /**< Try to omit the frame pointer. */
  20         unsigned fp_free                : 1;  /**< The function can use any register as frame pointer. */
  21         unsigned call_has_imm           : 1;  /**< A call can take the callee's address as an immediate. */
  22         unsigned irg_is_leaf            : 1;  /**< 1, if the IRG is a leaf function. */
  23         unsigned frame_is_setup_on_call : 1;  /**< Set to one, if there is already enough room on the stack for call args. */
  24 };
  25
  26 union _be_abi_call_flags_t {
  27         be_abi_call_flags_bits_t bits;
  28         unsigned val;
  29 };
  30
  31 struct _be_abi_callbacks_t {
  32         /**
  33          * Initialize the callback object.
  34          * @param call The call object.
  35          * @param aenv The architecture environment.
  36          * @param irg  The graph with the method.
  37          * @return     Some pointer. This pointer is passed to all other callback functions as self object.
  38          */
  39         void *(*init)(const be_abi_call_t *call, const arch_env_t *aenv, ir_graph *irg);
  40
  41         /**
  42          * Destroy the callback object.
  43          * @param self The callback object.
  44          */
  45         void (*done)(void *self);
  46
  47         /**
  48          * Get the between type for that call.
  49          * @param self The callback object.
  50          * @return The between type of for that call.
  51          */
  52         ir_type *(*get_between_type)(void *self);
  53
  54         /**
  55          * Put all registers which are saved by the prologue/epilogue in a set.
  56          * @param self The callback object.
  57          * @param regs A set.
  58          */
  59         void (*regs_saved_by_me)(void *self, pset *regs);
  60
  61         /**
  62          * Generate the prologue.
  63          * @param self    The callback object.
  64          * @param mem     A pointer to the mem node. Update this if you define new memory.
  65          * @param reg_map A mapping mapping all callee_save/ignore/parameter registers to their defining nodes.
  66          * @return        The register which shall be used as a stack frame base.
  67          *
  68      * All nodes which define registers in @p reg_map must keep @p reg_map current.
  69          */
  70         const arch_register_t *(*prologue)(void *self, ir_node **mem, pmap *reg_map);
  71
  72         /**
  73          * Generate the epilogue.
  74          * @param self    The callback object.
  75          * @param mem     Memory one can attach to.
  76          * @param reg_map A mapping mapping all callee_save/ignore/return registers to their defining nodes.
  77          *
  78      * All nodes which define registers in @p reg_map must keep @p reg_map current.
  79          * Also, the @p mem variable must be updated, if memory producing nodes are inserted.
  80          */
  81         void (*epilogue)(void *self, ir_node *bl, ir_node **mem, pmap *reg_map);
  82 };
  83
  84 /**
  85  * Set the flags for a call.
  86  * @param call          The call.
  87  * @param flags         Some flags to be set.
  88  * @param cb            The call callbacks for that call.
  89  * @note                The ABI phase might change the flags due to analysis.
  90  */
  91 void be_abi_call_set_flags(be_abi_call_t *call, be_abi_call_flags_t flags, const be_abi_callbacks_t *cb);
  92
  93
  94 void be_abi_call_param_stack(be_abi_call_t *call, int pos, unsigned alignment, unsigned space_before, unsigned space_after);
  95 void be_abi_call_param_reg(be_abi_call_t *call, int pos, const arch_register_t *reg);
  96 void be_abi_call_res_reg(be_abi_call_t *call, int pos, const arch_register_t *reg);
  97
  98 /**
  99  * Get the flags of a ABI call object.
 100  * Note that the flags must not be the same as set by be_abi_call_set_flags(). Analysis may have
 101  * altered several flags, so getting them from the call object is always a good idea.
 102  * @param call The call object.
 103  * @return The flags.
 104  */
 105 be_abi_call_flags_t be_abi_call_get_flags(const be_abi_call_t *call);
 106
 107 /**
 108  * Get the method type of an ABI call object.
 109  * @param call The call object.
 110  * @return The method type for that call object.
 111  */
 112 ir_type *be_abi_call_get_method_type(const be_abi_call_t *call);
 113
 114 be_abi_irg_t *be_abi_introduce(be_irg_t *bi);
 115 void be_abi_fix_stack_bias(be_abi_irg_t *env);
 116 void be_abi_fix_stack_nodes(be_abi_irg_t *env);
 117 void be_abi_free(be_abi_irg_t *abi);
 118
 119 ir_node *be_abi_get_callee_save_irn(be_abi_irg_t *abi, const arch_register_t *reg);
 120
 121 #define be_abi_reg_map_get(map, reg)       pmap_get((map), (void *) (reg))
 122 #define be_abi_reg_map_set(map, reg, irn)  pmap_insert((map), (void *) (reg), (irn))
 123
 124 #endif