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