be.h 5.06 KB
Newer Older
Christian Würdig's avatar
Christian Würdig committed
1
/*
Michael Beck's avatar
Michael Beck committed
2
 * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
Christian Würdig's avatar
Christian Würdig committed
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
 *
 * This file is part of libFirm.
 *
 * This file may be distributed and/or modified under the terms of the
 * GNU General Public License version 2 as published by the Free Software
 * Foundation and appearing in the file LICENSE.GPL included in the
 * packaging of this file.
 *
 * Licensees holding valid libFirm Professional Edition licenses may use
 * this file in accordance with the libFirm Commercial License.
 * Agreement provided with the Software.
 *
 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE.
 */

Christian Würdig's avatar
Christian Würdig committed
20
21
22
23
24
25
26
27
/**
 * @file
 * @brief       Generic backend types and interfaces.
 * @author      Sebastian Hack
 * @version     $Id$
 */
#ifndef FIRM_BE_MAIN_H
#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"
Christian Würdig's avatar
Christian Würdig committed
34

35
typedef enum {
36
37
38
39
40
41
42
43
44
45
46
47
	ASM_CONSTRAINT_FLAG_NONE                  = 0,
	ASM_CONSTRAINT_FLAG_SUPPORTS_REGISTER     = 1u << 0,
	ASM_CONSTRAINT_FLAG_SUPPORTS_MEMOP        = 1u << 1,
	ASM_CONSTRAINT_FLAG_SUPPORTS_IMMEDIATE    = 1u << 2,
	ASM_CONSTRAINT_FLAG_NO_SUPPORT            = 1u << 3,
	ASM_CONSTRAINT_FLAG_MODIFIER_WRITE        = 1u << 4,
	ASM_CONSTRAINT_FLAG_MODIFIER_NO_WRITE     = 1u << 5,
	ASM_CONSTRAINT_FLAG_MODIFIER_READ         = 1u << 6,
	ASM_CONSTRAINT_FLAG_MODIFIER_NO_READ      = 1u << 7,
	ASM_CONSTRAINT_FLAG_MODIFIER_EARLYCLOBBER = 1u << 8,
	ASM_CONSTRAINT_FLAG_MODIFIER_COMMUTATIVE  = 1u << 9,
	ASM_CONSTRAINT_FLAG_INVALID               = 1u << 10
48
} asm_constraint_flags_t;
49
ENUM_BITSET(asm_constraint_flags_t)
50

51
52
53
54
55
56
57
58
59
60
61
62
/**
 * Build a Trampoline for the closure.
 * @param block       the block where to build the trampoline
 * @param mem         memory
 * @param trampoline  address of a trampoline region
 * @param env         address of the environment
 * @param callee      address of the function to call
 *
 * @return modified memory
 */
typedef ir_node *(create_trampoline_fkt)(ir_node *block, ir_node *mem, ir_node *trampoline, ir_node *env, ir_node *callee);

63
64
65
66
67
68
69
70
/** callback where the backend performs required lowering for the target
 * architecture. Typical examples are transforming doubleword operations into
 * sequences of word operations. The callback should be invoked before the
 * frontend, because it is usually a good idea to perform other optimisations
 * after the lowering
 */
typedef void (*lower_for_target_func)(void);

71
72
73
74
75
/**
 * This structure contains parameters that should be
 * propagated to the libFirm parameter set.
 */
typedef struct backend_params {
76
	/** If set, the backend supports inline assembly. */
77
	unsigned support_inline_asm:1;
78
79
	/** If set, the backend supports Rotl nodes */
	unsigned support_rotl:1;
80
81
	/** the backend uses big-endian byte ordering if set, else little endian */
	unsigned byte_order_big_endian:1;
82

83
	/** Settings for architecture dependent optimizations. */
84
	const ir_settings_arch_dep_t *dep_param;
85

86
	/** Backend settings for if-conversion. */
87
	arch_allow_ifconv_func allow_ifconv;
88

89
90
91
92
93
94
	/**
	 * some backends like x87 can only do arithmetic in a specific float
	 * mode (but convert to/from other float modes).
	 */
	ir_mode *mode_float_arithmetic;

95
96
97
98
99
100
101
102
	/** Size of the trampoline code. */
	unsigned trampoline_size;

	/** Alignment of the trampoline code. */
	unsigned trampoline_align;

	/** If non-zero, build the trampoline. */
	create_trampoline_fkt *build_trampoline;
103
104
105

	/** Alignment of stack parameters */
	unsigned stack_param_align;
106
107
} backend_params;

108
109
110
/**
 * Register the Firm backend command line options.
 */
Michael Beck's avatar
Michael Beck committed
111
FIRM_API void be_opt_register(void);
112
113
114
115

/**
 * Parse one backend argument.
 */
Michael Beck's avatar
Michael Beck committed
116
FIRM_API int be_parse_arg(const char *arg);
117
118

/**
119
 * Return the backend configuration parameter.
120
121
122
 *
 * @return libFirm configuration parameters for the selected
 *         backend
123
 */
Michael Beck's avatar
Michael Beck committed
124
FIRM_API const backend_params *be_get_backend_param(void);
Michael Beck's avatar
Michael Beck committed
125

126
127
128
129
130
131
132
133
134
135
136
/**
 * Lowers current program for the target architecture.
 * This must be run once before using be_main. The idea here is that the backend
 * can perform lowerings like doubleword-lowering, ABI adjustments or
 * implementation of boolean values, if-conversion, with target specific
 * settings.
 * The resulting graph is still a "normal" firm-graph on which you can and
 * should perform further architecture-neutral optimisations before be_main.
 */
FIRM_API void be_lower_for_target(void);

137
138
139
140
141
142
/**
 * Creates an ir_prog pass which performs lowerings necessary for the target
 * architecture. (Calling backend_params->lower_for_target)
 */
FIRM_API ir_prog_pass_t *lower_for_target_pass(const char *name);

Michael Beck's avatar
Michael Beck committed
143
144
145
/**
 * Main interface to the frontend.
 */
Michael Beck's avatar
Michael Beck committed
146
FIRM_API void be_main(FILE *output, const char *compilation_unit_name);
147

148
149
/**
 * parse assembler constraint strings and returns flags (so the frontend knows
150
 * which operands are inputs/outputs and whether memory is required)
151
 */
Michael Beck's avatar
Michael Beck committed
152
FIRM_API asm_constraint_flags_t be_parse_asm_constraints(const char *constraints);
153
154

/**
155
 * tests whether a string is a valid clobber in an ASM instruction
156
 */
Michael Beck's avatar
Michael Beck committed
157
FIRM_API int be_is_valid_clobber(const char *clobber);
158

159
160
#include "end.h"

Matthias Braun's avatar
Matthias Braun committed
161
#endif