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 irg  The graph with the method.
  60          * @return     Some pointer. This pointer is passed to all other callback functions as self object.
  61          */
  62         void *(*init)(const be_abi_call_t *call, ir_graph *irg);
  63
  64         /**
  65          * Destroy the callback object.
  66          * @param self The callback object.
  67          */
  68         void (*done)(void *self);
  69
  70         /**
  71          * Get the between type for that call.
  72          * @param self The callback object.
  73          * @return The between type of for that call.
  74          */
  75         ir_type *(*get_between_type)(void *self);
  76
  77         /**
  78          * Generate the prologue.
  79          * @param self       The callback object.
  80          * @param mem        A pointer to the mem node. Update this if you define new memory.
  81          * @param reg_map    A map mapping all callee_save/ignore/parameter registers to their defining nodes.
  82          * @param stack_bias Points to the current stack bias, can be modified if needed.
  83          * @return           The register which shall be used as a stack frame base.
  84          *
  85          * All nodes which define registers in @p reg_map must keep @p reg_map current.
  86          */
  87         const arch_register_t *(*prologue)(void *self, ir_node **mem, pmap *reg_map, int *stack_bias);
  88
  89         /**
  90          * Generate the epilogue.
  91          * @param self    The callback object.
  92          * @param mem     Memory one can attach to.
  93          * @param reg_map A mapping mapping all callee_save/ignore/return registers to their defining nodes.
  94          *
  95      * All nodes which define registers in @p reg_map must keep @p reg_map current.
  96          * Also, the @p mem variable must be updated, if memory producing nodes are inserted.
  97          */
  98         void (*epilogue)(void *self, ir_node *bl, ir_node **mem, pmap *reg_map);
  99 };
 100
 101 /**
 102  * Set the flags for a call.
 103  * @param call          The call.
 104  * @param flags         Some flags to be set.
 105  * @param cb            The call callbacks for that call.
 106  * @note                The ABI phase might change the flags due to analysis.
 107  */
 108 void be_abi_call_set_flags(be_abi_call_t *call, be_abi_call_flags_t flags, const be_abi_callbacks_t *cb);
 109
 110 /**
 111  * Sets the number of bytes the stackframe is shrinked by the callee on return
 112  */
 113 void be_abi_call_set_pop(be_abi_call_t *call, int pop);
 114
 115 /**
 116  * Set register class for call address.
 117  * @param call      The call.
 118  * @param cls       The register class for call address.
 119  */
 120 void be_abi_call_set_call_address_reg_class(be_abi_call_t *call, const arch_register_class_t *cls);
 121
 122 /**
 123  * The ABI can change when we call a function vs. when we have
 124  * been called.
 125  */
 126 typedef enum {
 127         ABI_CONTEXT_CALLEE = 1 << 0,
 128         ABI_CONTEXT_CALLER = 1 << 1,
 129         ABI_CONTEXT_BOTH   = ABI_CONTEXT_CALLEE | ABI_CONTEXT_CALLER
 130 } be_abi_context_t;
 131
 132 /**
 133  * Record the that ABI transmits call argument pos on the stack. Modifies the abi object.
 134  *
 135  * @param call          the abi call object
 136  * @param pos           the parameter position
 137  * @param load_mode     load the parameter with this mode (if the parameter mode is different from this mode a Conv is inserted)
 138  * @param alignment     stack alignment for the parameter on the current architecture
 139  * @param space_before  size of allocated additional space before the parameter
 140  * @param space_after   size of allocated additional space after the parameter
 141  */
 142 void be_abi_call_param_stack(be_abi_call_t *call, int pos, ir_mode *load_mode,
 143                              unsigned alignment, unsigned space_before,
 144                              unsigned space_after, be_abi_context_t context);
 145
 146 /**
 147  * Record the that ABI transmits call argument pos in the given register.
 148  *
 149  * @param call          the abi call object
 150  * @param pos           the parameter position
 151  * @param reg           the register used
 152  */
 153 void be_abi_call_param_reg(be_abi_call_t *call, int pos,
 154                            const arch_register_t *reg,
 155                            be_abi_context_t context);
 156
 157 /**
 158  * Record the that ABI transmits return value pos in the given register.
 159  *
 160  * @param call          the abi call object
 161  * @param pos           the return value position
 162  * @param reg           the register used
 163  */
 164 void be_abi_call_res_reg(be_abi_call_t *call, int pos,
 165                          const arch_register_t *reg,
 166                          be_abi_context_t context);
 167
 168 /**
 169  * Get the flags of a ABI call object.
 170  * Note that the flags must not be the same as set by be_abi_call_set_flags(). Analysis may have
 171  * altered several flags, so getting them from the call object is always a good idea.
 172  * @param call The call object.
 173  * @return The flags.
 174  */
 175 be_abi_call_flags_t be_abi_call_get_flags(const be_abi_call_t *call);
 176
 177 /**
 178  * Get the method type of an ABI call object.
 179  * @param call The call object.
 180  * @return The method type for that call object.
 181  */
 182 ir_type *be_abi_call_get_method_type(const be_abi_call_t *call);
 183
 184 be_abi_irg_t *be_abi_introduce(ir_graph *irg);
 185
 186 /**
 187  * Fix the stack bias for all nodes accessing the stack frame using the
 188  * stack pointer.
 189  */
 190 void be_abi_fix_stack_bias(ir_graph *irg);
 191 void be_abi_free(ir_graph *irg);
 192
 193 /**
 194  * Rewire all stack modifying nodes and their users to assure SSA property.
 195  * @param env   The abi
 196  */
 197 void be_abi_fix_stack_nodes(ir_graph *irg);
 198
 199 /**
 200  * Put the registers which are forbidden specifically for this IRG in a bitset.
 201  */
 202 void be_abi_put_ignore_regs(be_abi_irg_t *abi, const arch_register_class_t *cls, bitset_t *bs);
 203
 204 void be_abi_set_non_ignore_regs(be_abi_irg_t *abi, const arch_register_class_t *cls, unsigned *raw_bitset);
 205
 206 ir_node *be_abi_get_callee_save_irn(be_abi_irg_t *abi, const arch_register_t *reg);
 207 ir_node *be_abi_get_ignore_irn(be_abi_irg_t *abi, const arch_register_t *reg);
 208
 209 #define be_abi_reg_map_get(map, reg)       pmap_get((map), (void *) (reg))
 210 #define be_abi_reg_map_set(map, reg, irn)  pmap_insert((map), (void *) (reg), (irn))
 211
 212 #endif