merge kaps
[libfirm] / include / libfirm / be.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       Generic backend types and interfaces.
23  * @author      Sebastian Hack
24  * @version     $Id$
25  */
26 #ifndef FIRM_BE_MAIN_H
27 #define FIRM_BE_MAIN_H
28
29 #include <stdio.h>
30 #include "irarch.h"
31 #include "lowering.h"
32 #include "iroptimize.h"
33 #include "begin.h"
34
35 typedef enum {
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)
50
51 /**
52  * Build a Trampoline for the closure.
53  * @param block       the block where to build the trampoline
54  * @param mem         memory
55  * @param trampoline  address of a trampoline region
56  * @param env         address of the environment
57  * @param callee      address of the function to call
58  *
59  * @return modified memory
60  */
61 typedef ir_node *(create_trampoline_fkt)(ir_node *block, ir_node *mem, ir_node *trampoline, ir_node *env, ir_node *callee);
62
63 /**
64  * This structure contains parameters that should be
65  * propagated to the libFirm parameter set.
66  */
67 typedef struct backend_params {
68         /** If set, the backend supports inline assembly. */
69         unsigned support_inline_asm:1;
70         /** If set, the backend supports Rotl nodes */
71         unsigned support_rotl:1;
72         /** the backend uses big-endian byte ordering if set, else little endian */
73         unsigned byte_order_big_endian:1;
74
75         /** Settings for architecture dependent optimizations. */
76         const ir_settings_arch_dep_t *dep_param;
77
78         /** Backend settings for if-conversion. */
79         arch_allow_ifconv_func allow_ifconv;
80
81         /**
82          * some backends like x87 can only do arithmetic in a specific float
83          * mode (but convert to/from other float modes).
84          */
85         ir_mode *mode_float_arithmetic;
86
87         /** Size of the trampoline code. */
88         unsigned trampoline_size;
89
90         /** Alignment of the trampoline code. */
91         unsigned trampoline_align;
92
93         /** If non-zero, build the trampoline. */
94         create_trampoline_fkt *build_trampoline;
95
96         /** Alignment of stack parameters */
97         unsigned stack_param_align;
98 } backend_params;
99
100 /**
101  * Register the Firm backend command line options.
102  */
103 FIRM_API void be_opt_register(void);
104
105 /**
106  * Parse one backend argument.
107  */
108 FIRM_API int be_parse_arg(const char *arg);
109
110 /**
111  * Return the backend configuration parameter.
112  *
113  * @return libFirm configuration parameters for the selected
114  *         backend
115  */
116 FIRM_API const backend_params *be_get_backend_param(void);
117
118 /**
119  * Lowers current program for the target architecture.
120  * This must be run once before using be_main. The idea here is that the backend
121  * can perform lowerings like doubleword-lowering, ABI adjustments or
122  * implementation of boolean values, if-conversion, with target specific
123  * settings.
124  * The resulting graph is still a "normal" firm-graph on which you can and
125  * should perform further architecture-neutral optimisations before be_main.
126  */
127 FIRM_API void be_lower_for_target(void);
128
129 /**
130  * Creates an ir_prog pass which performs lowerings necessary for the target
131  * architecture. (Calling backend_params->lower_for_target)
132  */
133 FIRM_API ir_prog_pass_t *lower_for_target_pass(const char *name);
134
135 /**
136  * Main interface to the frontend.
137  */
138 FIRM_API void be_main(FILE *output, const char *compilation_unit_name);
139
140 /**
141  * parse assembler constraint strings and returns flags (so the frontend knows
142  * which operands are inputs/outputs and whether memory is required)
143  */
144 FIRM_API asm_constraint_flags_t be_parse_asm_constraints(const char *constraints);
145
146 /**
147  * tests whether a string is a valid clobber in an ASM instruction
148  */
149 FIRM_API int be_is_valid_clobber(const char *clobber);
150
151 #include "end.h"
152
153 #endif