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 Generic backend types and interfaces.
23 * @author Sebastian Hack
25 #ifndef FIRM_BE_MAIN_H
26 #define FIRM_BE_MAIN_H
31 #include "iroptimize.h"
35 * @defgroup be Code Generation
37 * Code Generation (backend) produces machine-code.
42 * flags categorizing assembler constraint specifications
44 typedef enum asm_constraint_flags_t {
45 ASM_CONSTRAINT_FLAG_NONE = 0, /**< no constraints */
46 /** input/output can be in a register */
47 ASM_CONSTRAINT_FLAG_SUPPORTS_REGISTER = 1u << 0,
48 /** input/output can be read/written to/from a memory address */
49 ASM_CONSTRAINT_FLAG_SUPPORTS_MEMOP = 1u << 1,
50 /** input can be encoded as an immediate number */
51 ASM_CONSTRAINT_FLAG_SUPPORTS_IMMEDIATE = 1u << 2,
52 /** the constraint is not supported yet by libFirm */
53 ASM_CONSTRAINT_FLAG_NO_SUPPORT = 1u << 3,
54 /** The input is also written to */
55 ASM_CONSTRAINT_FLAG_MODIFIER_WRITE = 1u << 4,
56 /** the input is not written to */
57 ASM_CONSTRAINT_FLAG_MODIFIER_NO_WRITE = 1u << 5,
58 /** the input is read */
59 ASM_CONSTRAINT_FLAG_MODIFIER_READ = 1u << 6,
60 /** the input is not read */
61 ASM_CONSTRAINT_FLAG_MODIFIER_NO_READ = 1u << 7,
62 /** the value is modified before all inputs to the asm block
64 ASM_CONSTRAINT_FLAG_MODIFIER_EARLYCLOBBER = 1u << 8,
65 /** This operand and the following operand are commutative */
66 ASM_CONSTRAINT_FLAG_MODIFIER_COMMUTATIVE = 1u << 9,
67 /** invalid constraint (due to parse error) */
68 ASM_CONSTRAINT_FLAG_INVALID = 1u << 10
69 } asm_constraint_flags_t;
70 ENUM_BITSET(asm_constraint_flags_t)
72 /** Dwarf source language codes. */
76 DW_LANG_Ada83 = 0x0003,
77 DW_LANG_C_plus_plus = 0x0004,
78 DW_LANG_Cobol74 = 0x0005,
79 DW_LANG_Cobol85 = 0x0006,
80 DW_LANG_Fortran77 = 0x0007,
81 DW_LANG_Fortran90 = 0x0008,
82 DW_LANG_Pascal83 = 0x0009,
83 DW_LANG_Modula2 = 0x000a,
84 DW_LANG_Java = 0x000b,
86 DW_LANG_Ada95 = 0x000d,
87 DW_LANG_Fortran95 = 0x000e,
89 DW_LANG_ObjC = 0x0010,
90 DW_LANG_ObjC_plus_plus = 0x0011,
93 DW_LANG_Python = 0x0014,
95 } dwarf_source_language;
98 * Build a Trampoline for the closure.
99 * @param block the block where to build the trampoline
101 * @param trampoline address of a trampoline region
102 * @param env address of the environment
103 * @param callee address of the function to call
105 * @return modified memory
107 typedef ir_node *(create_trampoline_fkt)(ir_node *block, ir_node *mem, ir_node *trampoline, ir_node *env, ir_node *callee);
110 * This structure contains parameters that should be
111 * propagated to the libFirm parameter set.
113 typedef struct backend_params {
114 /** If set, the backend supports inline assembly. */
115 unsigned support_inline_asm:1;
116 /** If set, the backend supports Rotl nodes */
117 unsigned support_rotl:1;
118 /** the backend uses big-endian byte ordering if set, else little endian */
119 unsigned byte_order_big_endian:1;
120 /** whether the architecure can natively handle modulo shift modes.
121 * If this is true, then you can assume that shifting in modes with
122 * module_shift==machine_size (if mode size is <= machine_size) is efficient
124 unsigned modulo_shift_efficient:1;
125 /** whether the architecure can natively handle modulo shift modes.
126 * If this is true, then you can assume that shifting without modulo shift
129 unsigned non_modulo_shift_efficient:1;
131 /** Settings for architecture dependent optimizations. */
132 const ir_settings_arch_dep_t *dep_param;
134 /** Backend settings for if-conversion. */
135 arch_allow_ifconv_func allow_ifconv;
137 /** size of machine words. This is usually the size of the general purpose
138 * integer registers. */
139 unsigned machine_size;
142 * some backends like x87 can only do arithmetic in a specific float
143 * mode (load/store are still done in the "normal" float/double modes).
145 ir_mode *mode_float_arithmetic;
148 * type used for long long or NULL if none available.
150 ir_type *type_long_long;
153 * type used for unsigned long long or NULL if none available
155 ir_type *type_unsigned_long_long;
158 * type used for long double or NULL if none available.
160 ir_type *type_long_double;
162 /** Size of the trampoline code. */
163 unsigned trampoline_size;
165 /** Alignment of the trampoline code. */
166 unsigned trampoline_align;
168 /** If non-zero, build the trampoline. */
169 create_trampoline_fkt *build_trampoline;
171 /** Alignment of stack parameters */
172 unsigned stack_param_align;
176 * Parse one backend argument.
178 FIRM_API int be_parse_arg(const char *arg);
181 * Returns the backend configuration parameter.
183 * @return libFirm configuration parameters for the selected
186 FIRM_API const backend_params *be_get_backend_param(void);
189 * Lowers current program for the target architecture.
190 * This must be run once before using be_main. The idea here is that the backend
191 * can perform lowerings like doubleword-lowering, ABI adjustments or
192 * implementation of boolean values, if-conversion, with target specific
194 * The resulting graph is still a "normal" firm-graph on which you can and
195 * should perform further architecture-neutral optimisations before be_main.
197 FIRM_API void be_lower_for_target(void);
200 * Creates an ir_prog pass which performs lowerings necessary for the target
201 * architecture. (Calling backend_params->lower_for_target)
203 FIRM_API ir_prog_pass_t *lower_for_target_pass(const char *name);
206 * Main interface to the frontend.
208 FIRM_API void be_main(FILE *output, const char *compilation_unit_name);
211 * parse assembler constraint strings and returns flags (so the frontend knows
212 * which operands are inputs/outputs and whether memory is required)
214 FIRM_API asm_constraint_flags_t be_parse_asm_constraints(const char *constraints);
217 * tests whether a string is a valid clobber in an ASM instruction
219 FIRM_API int be_is_valid_clobber(const char *clobber);
222 * Sets source language for dwarf debug information.
224 FIRM_API void be_dwarf_set_source_language(dwarf_source_language language);
227 * Sets working directory of the compiler (or directory where the compiler
228 * searched for sources) for dwarf debug information.
230 FIRM_API void be_dwarf_set_compilation_directory(const char *directory);