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
26 #ifndef FIRM_BE_MAIN_H
27 #define FIRM_BE_MAIN_H
32 #include "iroptimize.h"
36 ASM_CONSTRAINT_FLAG_NONE = 0,
37 ASM_CONSTRAINT_FLAG_SUPPORTS_REGISTER = 1u << 0,
38 ASM_CONSTRAINT_FLAG_SUPPORTS_MEMOP = 1u << 1,
39 ASM_CONSTRAINT_FLAG_SUPPORTS_IMMEDIATE = 1u << 2,
40 ASM_CONSTRAINT_FLAG_NO_SUPPORT = 1u << 3,
41 ASM_CONSTRAINT_FLAG_MODIFIER_WRITE = 1u << 4,
42 ASM_CONSTRAINT_FLAG_MODIFIER_NO_WRITE = 1u << 5,
43 ASM_CONSTRAINT_FLAG_MODIFIER_READ = 1u << 6,
44 ASM_CONSTRAINT_FLAG_MODIFIER_NO_READ = 1u << 7,
45 ASM_CONSTRAINT_FLAG_MODIFIER_EARLYCLOBBER = 1u << 8,
46 ASM_CONSTRAINT_FLAG_MODIFIER_COMMUTATIVE = 1u << 9,
47 ASM_CONSTRAINT_FLAG_INVALID = 1u << 10
48 } asm_constraint_flags_t;
49 ENUM_BITSET(asm_constraint_flags_t)
52 * Build a Trampoline for the closure.
53 * @param block the block where to build the trampoline
55 * @param trampoline address of a trampoline region
56 * @param env address of the environment
57 * @param callee address of the function to call
59 * @return modified memory
61 typedef ir_node *(create_trampoline_fkt)(ir_node *block, ir_node *mem, ir_node *trampoline, ir_node *env, ir_node *callee);
63 /** callback where the backend performs required lowering for the target
64 * architecture. Typical examples are transforming doubleword operations into
65 * sequences of word operations. The callback should be invoked before the
66 * frontend, because it is usually a good idea to perform other optimisations
69 typedef void (*lower_for_target_func)(void);
72 * This structure contains parameters that should be
73 * propagated to the libFirm parameter set.
75 typedef struct backend_params {
76 /** If set, the backend supports inline assembly. */
77 unsigned support_inline_asm:1;
78 /** If set, the backend supports Rotl nodes */
79 unsigned support_rotl:1;
80 /** the backend uses big-endian byte ordering if set, else little endian */
81 unsigned byte_order_big_endian:1;
83 /** Settings for architecture dependent optimizations. */
84 const ir_settings_arch_dep_t *dep_param;
86 /** Backend settings for if-conversion. */
87 arch_allow_ifconv_func allow_ifconv;
90 * some backends like x87 can only do arithmetic in a specific float
91 * mode (but convert to/from other float modes).
93 ir_mode *mode_float_arithmetic;
95 /** Size of the trampoline code. */
96 unsigned trampoline_size;
98 /** Alignment of the trampoline code. */
99 unsigned trampoline_align;
101 /** If non-zero, build the trampoline. */
102 create_trampoline_fkt *build_trampoline;
104 /** Alignment of stack parameters */
105 unsigned stack_param_align;
109 * Register the Firm backend command line options.
111 FIRM_API void be_opt_register(void);
114 * Parse one backend argument.
116 FIRM_API int be_parse_arg(const char *arg);
119 * Return the backend configuration parameter.
121 * @return libFirm configuration parameters for the selected
124 FIRM_API const backend_params *be_get_backend_param(void);
127 * Lowers current program for the target architecture.
128 * This must be run once before using be_main. The idea here is that the backend
129 * can perform lowerings like doubleword-lowering, ABI adjustments or
130 * implementation of boolean values, if-conversion, with target specific
132 * The resulting graph is still a "normal" firm-graph on which you can and
133 * should perform further architecture-neutral optimisations before be_main.
135 FIRM_API void be_lower_for_target(void);
138 * Creates an ir_prog pass which performs lowerings necessary for the target
139 * architecture. (Calling backend_params->lower_for_target)
141 FIRM_API ir_prog_pass_t *lower_for_target_pass(const char *name);
144 * Main interface to the frontend.
146 FIRM_API void be_main(FILE *output, const char *compilation_unit_name);
149 * parse assembler constraint strings and returns flags (so the frontend knows
150 * which operands are inputs/outputs and whether memory is required)
152 FIRM_API asm_constraint_flags_t be_parse_asm_constraints(const char *constraints);
155 * tests whether a string is a valid clobber in an ASM instruction
157 FIRM_API int be_is_valid_clobber(const char *clobber);