be.h 4.58 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
36
37
38
39
40
41
42
43
44
45
46
47
48
typedef enum {
	ASM_CONSTRAINT_FLAG_SUPPORTS_REGISTER     = 0x0001,
	ASM_CONSTRAINT_FLAG_SUPPORTS_MEMOP        = 0x0002,
	ASM_CONSTRAINT_FLAG_SUPPORTS_IMMEDIATE    = 0x0004,
	ASM_CONSTRAINT_FLAG_NO_SUPPORT            = 0x0008,
	ASM_CONSTRAINT_FLAG_MODIFIER_WRITE        = 0x0010,
	ASM_CONSTRAINT_FLAG_MODIFIER_NO_WRITE     = 0x0020,
	ASM_CONSTRAINT_FLAG_MODIFIER_READ         = 0x0040,
	ASM_CONSTRAINT_FLAG_MODIFIER_NO_READ      = 0x0080,
	ASM_CONSTRAINT_FLAG_MODIFIER_EARLYCLOBBER = 0x0100,
	ASM_CONSTRAINT_FLAG_MODIFIER_COMMUTATIVE  = 0x0200,
	ASM_CONSTRAINT_FLAG_INVALID               = 0x8000
} asm_constraint_flags_t;

49
50
51
52
53
54
55
56
57
58
59
60
/**
 * 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);

61
62
63
64
65
66
67
68
/** 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);

69
70
71
72
73
/**
 * This structure contains parameters that should be
 * propagated to the libFirm parameter set.
 */
typedef struct backend_params {
74
	/** If set, the backend supports inline assembly. */
75
	unsigned support_inline_asm:1;
76
77
	/** If set, the backend supports Rotl nodes */
	unsigned support_rotl:1;
78

79
80
81
	/** callback that performs lowerings required for target architecture */
	lower_for_target_func lower_for_target;

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

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

88
89
90
91
92
93
	/**
	 * 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;

94
95
96
97
98
99
100
101
	/** 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;
102
103
104

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

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

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

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

125
126
127
128
129
130
/**
 * 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
131
132
133
/**
 * Main interface to the frontend.
 */
Michael Beck's avatar
Michael Beck committed
134
FIRM_API void be_main(FILE *output, const char *compilation_unit_name);
135

136
137
/**
 * parse assembler constraint strings and returns flags (so the frontend knows
138
 * which operands are inputs/outputs and whether memory is required)
139
 */
Michael Beck's avatar
Michael Beck committed
140
FIRM_API asm_constraint_flags_t be_parse_asm_constraints(const char *constraints);
141
142

/**
143
 * tests whether a string is a valid clobber in an ASM instruction
144
 */
Michael Beck's avatar
Michael Beck committed
145
FIRM_API int be_is_valid_clobber(const char *clobber);
146

147
148
typedef struct be_main_env_t be_main_env_t;
typedef struct be_options_t  be_options_t;
Sebastian Hack's avatar
Sebastian Hack committed
149

150
151
#include "end.h"

Matthias Braun's avatar
Matthias Braun committed
152
#endif