2 * Copyright (C) 1995-2008 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
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.
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.
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
22 * @brief Backend ABI implementation.
23 * @author Sebastian Hack
26 #ifndef FIRM_BE_BEABI_H
27 #define FIRM_BE_BEABI_H
29 #include "firm_types.h"
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. */
50 union _be_abi_call_flags_t {
51 be_abi_call_flags_bits_t bits;
55 struct _be_abi_callbacks_t {
57 * Initialize the callback object.
58 * @param call The call object.
59 * @param aenv The architecture environment.
60 * @param irg The graph with the method.
61 * @return Some pointer. This pointer is passed to all other callback functions as self object.
63 void *(*init)(const be_abi_call_t *call, const arch_env_t *aenv, ir_graph *irg);
66 * Destroy the callback object.
67 * @param self The callback object.
69 void (*done)(void *self);
72 * Get the between type for that call.
73 * @param self The callback object.
74 * @return The between type of for that call.
76 ir_type *(*get_between_type)(void *self);
79 * Generate the prologue.
80 * @param self The callback object.
81 * @param mem A pointer to the mem node. Update this if you define new memory.
82 * @param reg_map A map mapping all callee_save/ignore/parameter registers to their defining nodes.
83 * @param stack_bias Points to the current stack bias, can be modified if needed.
84 * @return The register which shall be used as a stack frame base.
86 * All nodes which define registers in @p reg_map must keep @p reg_map current.
88 const arch_register_t *(*prologue)(void *self, ir_node **mem, pmap *reg_map, int *stack_bias);
91 * Generate the epilogue.
92 * @param self The callback object.
93 * @param mem Memory one can attach to.
94 * @param reg_map A mapping mapping all callee_save/ignore/return registers to their defining nodes.
96 * All nodes which define registers in @p reg_map must keep @p reg_map current.
97 * Also, the @p mem variable must be updated, if memory producing nodes are inserted.
99 void (*epilogue)(void *self, ir_node *bl, ir_node **mem, pmap *reg_map);
103 * Set the flags for a call.
104 * @param call The call.
105 * @param flags Some flags to be set.
106 * @param cb The call callbacks for that call.
107 * @note The ABI phase might change the flags due to analysis.
109 void be_abi_call_set_flags(be_abi_call_t *call, be_abi_call_flags_t flags, const be_abi_callbacks_t *cb);
112 * Sets the number of bytes the stackframe is shrinked by the callee on return
114 void be_abi_call_set_pop(be_abi_call_t *call, int pop);
117 * Set register class for call address.
118 * @param call The call.
119 * @param cls The register class for call address.
121 void be_abi_call_set_call_address_reg_class(be_abi_call_t *call, const arch_register_class_t *cls);
124 * Record the that ABI transmits call argument pos on the stack. Modifies the abi object.
126 * @param call the abi call object
127 * @param pos the parameter position
128 * @param load_mode load the parameter with this mode (if the parameter mode is different from this mode a Conv is inserted)
129 * @param alignment stack alignment for the parameter on the current architecture
130 * @param space_before size of allocated additional space before the parameter
131 * @param space_after size of allocated additional space after the parameter
133 void be_abi_call_param_stack(be_abi_call_t *call, int pos, ir_mode *load_mode, unsigned alignment, unsigned space_before, unsigned space_after);
136 * Record the that ABI transmits call argument pos in the given register.
138 * @param call the abi call object
139 * @param pos the parameter position
140 * @param reg the register used
142 void be_abi_call_param_reg(be_abi_call_t *call, int pos, const arch_register_t *reg);
145 * Record the that ABI transmits return value pos in the given register.
147 * @param call the abi call object
148 * @param pos the return value position
149 * @param reg the register used
151 void be_abi_call_res_reg(be_abi_call_t *call, int pos, const arch_register_t *reg);
154 * Get the flags of a ABI call object.
155 * Note that the flags must not be the same as set by be_abi_call_set_flags(). Analysis may have
156 * altered several flags, so getting them from the call object is always a good idea.
157 * @param call The call object.
160 be_abi_call_flags_t be_abi_call_get_flags(const be_abi_call_t *call);
163 * Get the method type of an ABI call object.
164 * @param call The call object.
165 * @return The method type for that call object.
167 ir_type *be_abi_call_get_method_type(const be_abi_call_t *call);
169 be_abi_irg_t *be_abi_introduce(be_irg_t *bi);
172 * Fix the stack bias for all nodes accessing the stack frame using the
175 void be_abi_fix_stack_bias(be_abi_irg_t *env);
176 void be_abi_free(be_abi_irg_t *abi);
179 * Rewire all stack modifying nodes and their users to assure SSA property.
182 void be_abi_fix_stack_nodes(be_abi_irg_t *env);
185 * Put the registers which are forbidden specifically for this IRG in a bitset.
187 void be_abi_put_ignore_regs(be_abi_irg_t *abi, const arch_register_class_t *cls, bitset_t *bs);
189 void be_abi_set_non_ignore_regs(be_abi_irg_t *abi, const arch_register_class_t *cls, unsigned *raw_bitset);
191 ir_node *be_abi_get_callee_save_irn(be_abi_irg_t *abi, const arch_register_t *reg);
192 ir_node *be_abi_get_ignore_irn(be_abi_irg_t *abi, const arch_register_t *reg);
194 #define be_abi_reg_map_get(map, reg) pmap_get((map), (void *) (reg))
195 #define be_abi_reg_map_set(map, reg, irn) pmap_insert((map), (void *) (reg), (irn))
197 /** The number of parts of the stack layout. */
198 #define N_FRAME_TYPES 3
201 * This type describes the stack layout.
202 * The stack is divided into 3 parts:
203 * - arg_type: A struct type describing the stack arguments and it's order.
204 * - between_type: A struct type describing the stack layout between arguments
205 * and frame type. In architectures that put the return address
206 * automatically on the stack, the return address is put here.
207 * - frame_type: A class type describing the frame layout.
209 struct _be_stack_layout_t {
210 ir_type *arg_type; /**< A type describing the stack argument layout. */
211 ir_type *between_type; /**< A type describing the "between" layout. */
212 ir_type *frame_type; /**< The frame type. */
214 ir_type *order[N_FRAME_TYPES]; /**< arg, between and frame types ordered. */
216 ir_entity **param_map; /**< An array mapping type parameters to arg_type entries */
217 int initial_offset; /**< the initial difference between stack pointer and frame pointer */
218 int initial_bias; /**< the initial stack bias */
219 int stack_dir; /**< -1 for decreasing, 1 for increasing. */
223 * Returns the stack layout from a abi environment.
225 const be_stack_layout_t *be_abi_get_stack_layout(const be_abi_irg_t *abi);
228 * Returns non-zero if the ABI has omitted the frame pointer in
231 int be_abi_omit_fp(const be_abi_irg_t *abi);
233 #endif /* FIRM_BE_BEABI_H */