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
25 #ifndef FIRM_BE_BEABI_H
26 #define FIRM_BE_BEABI_H
28 #include "firm_types.h"
38 #include "beabihelper.h"
40 struct be_abi_call_flags_bits_t {
41 unsigned store_args_sequential : 1; /**< Use sequential stores for arguments. */
42 unsigned try_omit_fp : 1; /**< Try to omit the frame pointer. */
43 unsigned fp_free : 1; /**< The function can use any register as frame pointer. */
44 unsigned call_has_imm : 1; /**< A call can take the callee's address as an immediate. */
45 unsigned irg_is_leaf : 1; /**< 1, if the IRG is a leaf function. */
46 unsigned frame_is_setup_on_call : 1; /**< Set to one, if there is already enough room on the stack for call args. */
49 union be_abi_call_flags_t {
50 be_abi_call_flags_bits_t bits;
54 struct be_abi_callbacks_t {
56 * Get the between type for that call.
57 * @param self The callback object.
58 * @return The between type of for that call.
60 ir_type *(*get_between_type)(ir_graph *irg);
64 * Set the flags for a call.
65 * @param call The call.
66 * @param flags Some flags to be set.
67 * @param cb The call callbacks for that call.
68 * @note The ABI phase might change the flags due to analysis.
70 void be_abi_call_set_flags(be_abi_call_t *call, be_abi_call_flags_t flags, const be_abi_callbacks_t *cb);
73 * Sets the number of bytes the stackframe is shrinked by the callee on return
75 void be_abi_call_set_pop(be_abi_call_t *call, int pop);
78 * Set register class for call address.
79 * @param call The call.
80 * @param cls The register class for call address.
82 void be_abi_call_set_call_address_reg_class(be_abi_call_t *call, const arch_register_class_t *cls);
85 * The ABI can change when we call a function vs. when we have
89 ABI_CONTEXT_CALLEE = 1 << 0,
90 ABI_CONTEXT_CALLER = 1 << 1,
91 ABI_CONTEXT_BOTH = ABI_CONTEXT_CALLEE | ABI_CONTEXT_CALLER
95 * Record the that ABI transmits call argument pos on the stack. Modifies the abi object.
97 * @param call the abi call object
98 * @param pos the parameter position
99 * @param load_mode load the parameter with this mode (if the parameter mode is different from this mode a Conv is inserted)
100 * @param alignment stack alignment for the parameter on the current architecture
101 * @param space_before size of allocated additional space before the parameter
102 * @param space_after size of allocated additional space after the parameter
104 void be_abi_call_param_stack(be_abi_call_t *call, int pos, ir_mode *load_mode,
105 unsigned alignment, unsigned space_before,
106 unsigned space_after, be_abi_context_t context);
109 * Record the that ABI transmits call argument pos in the given register.
111 * @param call the abi call object
112 * @param pos the parameter position
113 * @param reg the register used
115 void be_abi_call_param_reg(be_abi_call_t *call, int pos,
116 const arch_register_t *reg,
117 be_abi_context_t context);
120 * Record the that ABI transmits return value pos in the given register.
122 * @param call the abi call object
123 * @param pos the return value position
124 * @param reg the register used
126 void be_abi_call_res_reg(be_abi_call_t *call, int pos,
127 const arch_register_t *reg,
128 be_abi_context_t context);
131 * Get the flags of a ABI call object.
132 * Note that the flags must not be the same as set by be_abi_call_set_flags(). Analysis may have
133 * altered several flags, so getting them from the call object is always a good idea.
134 * @param call The call object.
137 be_abi_call_flags_t be_abi_call_get_flags(const be_abi_call_t *call);
140 * Get the method type of an ABI call object.
141 * @param call The call object.
142 * @return The method type for that call object.
144 ir_type *be_abi_call_get_method_type(const be_abi_call_t *call);
146 void be_abi_introduce(ir_graph *irg);
148 void be_abi_free(ir_graph *irg);