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