benode_t.h 9.44 KB
Newer Older
Sebastian Hack's avatar
Sebastian Hack committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
/**
 * @file   benode_t.h
 * @date   17.05.2005
 * @author Sebastian Hack
 *
 * Backend node support.
 *
 * Copyright (C) 2005 Universitaet Karlsruhe
 * Released under the GPL
 */

#ifndef _BENODE_T_H
#define _BENODE_T_H

Sebastian Hack's avatar
Sebastian Hack committed
15
#include "firm_config.h"
16
17
#include "pmap.h"

Sebastian Hack's avatar
Sebastian Hack committed
18
19
#include "irmode.h"
#include "irnode.h"
20
#include "entity_t.h"
Sebastian Hack's avatar
Sebastian Hack committed
21

22
#include "be_t.h"
Sebastian Hack's avatar
Sebastian Hack committed
23
24
#include "bearch.h"

25
26
#define BE_OUT_POS(p) (-((p) + 1))

27
28
29
30
31
32
33
34
35
36
37
/**
 * The benode op's.  Must be available to register emitter function.
 */
extern ir_op *op_be_Spill;
extern ir_op *op_be_Reload;
extern ir_op *op_be_Perm;
extern ir_op *op_be_Copy;
extern ir_op *op_be_Keep;
extern ir_op *op_be_Call;
extern ir_op *op_be_Return;
extern ir_op *op_be_IncSP;
Sebastian Hack's avatar
Sebastian Hack committed
38
extern ir_op *op_be_AddSP;
39
40
41
42
43
44
extern ir_op *op_be_SetSP;
extern ir_op *op_be_RegParams;
extern ir_op *op_be_StackParam;
extern ir_op *op_be_FrameAddr;
extern ir_op *op_be_FrameLoad;
extern ir_op *op_be_FrameStore;
Sebastian Hack's avatar
Sebastian Hack committed
45
46
extern ir_op *op_be_Epilogue;
extern ir_op *op_be_Prologue;
47

Sebastian Hack's avatar
Sebastian Hack committed
48
49
50
51
52
53
54
typedef enum {
	beo_NoBeOp = 0,
	beo_Spill,
	beo_Reload,
	beo_Perm,
	beo_Copy,
	beo_Keep,
Sebastian Hack's avatar
Sebastian Hack committed
55
	beo_CopyKeep,
Sebastian Hack's avatar
Sebastian Hack committed
56
	beo_Call,
Sebastian Hack's avatar
Sebastian Hack committed
57
	beo_Return,
Sebastian Hack's avatar
Sebastian Hack committed
58
	beo_AddSP,
Sebastian Hack's avatar
Sebastian Hack committed
59
	beo_IncSP,
Sebastian Hack's avatar
Sebastian Hack committed
60
	beo_SetSP,
Sebastian Hack's avatar
Sebastian Hack committed
61
	beo_RegParams,
Sebastian Hack's avatar
Sebastian Hack committed
62
	beo_StackParam,
63
64
65
	beo_FrameLoad,
	beo_FrameStore,
	beo_FrameAddr,
Sebastian Hack's avatar
Sebastian Hack committed
66
67
	beo_Epilogue,
	beo_Prologue,
Sebastian Hack's avatar
Sebastian Hack committed
68
69
	beo_Last
} be_opcode_t;
70

Sebastian Hack's avatar
Sebastian Hack committed
71
/** Expresses the direction of the stack pointer increment of IncSP nodes. */
Sebastian Hack's avatar
Sebastian Hack committed
72
73
74
75
76
typedef enum {
	be_stack_dir_along = 0,
	be_stack_dir_against = 1
} be_stack_dir_t;

Sebastian Hack's avatar
Sebastian Hack committed
77
/** Not used yet. */
78
79
80
81
82
83
typedef enum {
	be_frame_flag_spill = 1,
	be_frame_flag_local = 2,
	be_frame_flag_arg   = 4
} be_frame_flag_t;

Sebastian Hack's avatar
Sebastian Hack committed
84
85
86
87
/**
 * A "symbolic constant" for the size of the stack frame to use with IncSP nodes.
 * It gets back-patched to the real size as soon it is known.
 */
Sebastian Hack's avatar
Sebastian Hack committed
88
89
#define BE_STACK_FRAME_SIZE ((unsigned) -1)

Sebastian Hack's avatar
Sebastian Hack committed
90
void be_node_init(void);
91

Sebastian Hack's avatar
Sebastian Hack committed
92
const arch_irn_handler_t be_node_irn_handler;
Sebastian Hack's avatar
Sebastian Hack committed
93

94
95
96
97
enum {
	be_pos_Spill_frame = 0,
	be_pos_Spill_val   = 1
};
Sebastian Hack's avatar
Sebastian Hack committed
98
ir_node *be_new_Spill(const arch_register_class_t *cls, const arch_register_class_t *cls_frame, ir_graph *irg, ir_node *bl, ir_node *frame, ir_node *node_to_spill, ir_node *ctx);
99
100
101
102
103

enum {
	be_pos_Reload_frame = 0,
	be_pos_Reload_mem   = 1
};
Sebastian Hack's avatar
Sebastian Hack committed
104
ir_node *be_new_Reload(const arch_register_class_t *cls, const arch_register_class_t *cls_frame, ir_graph *irg, ir_node *bl, ir_node *frame, ir_node *spill_node, ir_mode *mode);
105
106
107
108

enum {
	be_pos_Copy_orig = 0
};
Sebastian Hack's avatar
Sebastian Hack committed
109
110
111
ir_node *be_new_Copy(const arch_register_class_t *cls, ir_graph *irg, ir_node *block, ir_node *in);
ir_node *be_new_Perm(const arch_register_class_t *cls, ir_graph *irg, ir_node *bl, int arity, ir_node *in[]);
ir_node *be_new_Keep(const arch_register_class_t *cls, ir_graph *irg, ir_node *bl, int arity, ir_node *in[]);
Sebastian Hack's avatar
Sebastian Hack committed
112

113
114
115
116
117
118
ir_node *be_new_FrameLoad(const arch_register_class_t *cls_frame, const arch_register_class_t *cls_data,
						  ir_graph *irg, ir_node *bl, ir_node *mem, ir_node *frame, entity *ent);
ir_node *be_new_FrameStore(const arch_register_class_t *cls_frame, const arch_register_class_t *cls_data,
						   ir_graph *irg, ir_node *bl, ir_node *mem, ir_node *frame, ir_node *data, entity *ent);
ir_node *be_new_FrameAddr(const arch_register_class_t *cls_frame, ir_graph *irg, ir_node *bl, ir_node *frame, entity *ent);

Sebastian Hack's avatar
Sebastian Hack committed
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
enum {
	be_pos_AddSP_old_sp = 0,
	be_pos_AddSP_size   = 1,
	be_pos_AddSP_last   = 2
};

/**
 * Make a new AddSP node.
 * An AddSP node expresses an increase of the stack pointer in the direction the stack
 * grows. In contrast to IncSP, the amount of bytes the stack pointer is grown, is not
 * given by a constant but an ordinary Firm node.
 * @param sp     The stack pointer register.
 * @param irg    The graph.
 * @param bl     The block.
 * @param old_sp The node representing the old stack pointer value.
 * @param sz     The node expressing the size by which the stack pointer shall be grown.
 * @return       A new AddSP node.
 */
ir_node *be_new_AddSP(const arch_register_t *sp, ir_graph *irg, ir_node *bl, ir_node *old_sp, ir_node *sz);
Sebastian Hack's avatar
Sebastian Hack committed
138

Sebastian Hack's avatar
Sebastian Hack committed
139
140
ir_node *be_new_SetSP(const arch_register_t *sp, ir_graph *irg, ir_node *bl, ir_node *old_sp, ir_node *operand, ir_node *mem);

Sebastian Hack's avatar
Sebastian Hack committed
141
142
/**
 * Make a stack pointer increase/decrease node.
Sebastian Hack's avatar
Sebastian Hack committed
143
 * @param sp     The stack pointer register.
Sebastian Hack's avatar
Sebastian Hack committed
144
145
146
147
148
149
150
151
152
 * @param irg    The graph to insert the node to.
 * @param bl     The block to insert the node into.
 * @param old_sp The node defining the former stack pointer.
 * @param amount The mount of bytes the stack pointer shall be increased/decreased.
 * @param dir    The direction in which the stack pointer shall be modified:
 *               Along the stack's growing direction or against.
 * @return       A new stack pointer increment/decrement node.
 * @note         This node sets a register constraint to the @p sp register on its output.
 */
153
ir_node *be_new_IncSP(const arch_register_t *sp, ir_graph *irg, ir_node *bl, ir_node *old_sp, ir_node *mem, unsigned amount, be_stack_dir_t dir);
Sebastian Hack's avatar
Sebastian Hack committed
154

Sebastian Hack's avatar
Sebastian Hack committed
155
156


Sebastian Hack's avatar
Sebastian Hack committed
157
void     be_set_IncSP_offset(ir_node *irn, unsigned offset);
158
unsigned be_get_IncSP_offset(const ir_node *irn);
Sebastian Hack's avatar
Sebastian Hack committed
159
160

void           be_set_IncSP_direction(ir_node *irn, be_stack_dir_t dir);
161
be_stack_dir_t be_get_IncSP_direction(const ir_node *irn);
Sebastian Hack's avatar
Sebastian Hack committed
162

163
164
165
entity *be_Call_get_entity(const ir_node *call);
void    be_Call_set_entity(ir_node *call, entity *ent);

166
167
168
169
170
171
enum {
	be_pos_Call_mem = 0,
	be_pos_Call_sp  = 1,
	be_pos_Call_ptr = 2
};

Sebastian Hack's avatar
Sebastian Hack committed
172
ir_node *be_new_Call(ir_graph *irg, ir_node *bl, ir_node *mem, ir_node *sp, ir_node *ptr, int n_outs, int n, ir_node *in[]);
Sebastian Hack's avatar
Sebastian Hack committed
173
ir_node *be_new_Return(ir_graph *irg, ir_node *bl, int n, ir_node *in[]);
Sebastian Hack's avatar
Sebastian Hack committed
174
ir_node *be_new_StackParam(const arch_register_class_t *cls, const arch_register_class_t *cls_frame, ir_graph *irg, ir_node *bl, ir_mode *mode, ir_node *frame_pointer, entity *ent);
Sebastian Hack's avatar
Sebastian Hack committed
175
ir_node *be_new_RegParams(ir_graph *irg, ir_node *bl, int n_out);
Sebastian Hack's avatar
Sebastian Hack committed
176

Sebastian Hack's avatar
Sebastian Hack committed
177
178
179
ir_node *be_new_Epilogue(ir_graph *irg, ir_node *bl, int n, ir_node *in[]);
ir_node *be_new_Prologue(ir_graph *irg, ir_node *bl, int n, ir_node *in[]);

Sebastian Hack's avatar
Sebastian Hack committed
180
ir_node *be_spill(const arch_env_t *arch_env, ir_node *irn,ir_node *spill_ctx);
Sebastian Hack's avatar
Sebastian Hack committed
181
ir_node *be_reload(const arch_env_t *arch_env, const arch_register_class_t *cls, ir_node *reloader, ir_mode *mode, ir_node *spill);
Sebastian Hack's avatar
Sebastian Hack committed
182

Sebastian Hack's avatar
Sebastian Hack committed
183
184
185
186
ir_node *be_new_CopyKeep(const arch_register_class_t *cls, ir_graph *irg, ir_node *bl, ir_node *src, int n, ir_node *in_keep[], ir_mode *mode);
ir_node *be_new_CopyKeep_single(const arch_register_class_t *cls, ir_graph *irg, ir_node *bl, ir_node *src, ir_node *keep, ir_mode *mode);


Sebastian Hack's avatar
Sebastian Hack committed
187
188
189
190
191
/**
 * Get the backend opcode of a backend node.
 * @param irn The node.
 * @return The backend opcode.
 */
Sebastian Hack's avatar
Sebastian Hack committed
192
193
be_opcode_t be_get_irn_opcode(const ir_node *irn);

194
195
196
197
int be_is_Spill(const ir_node *irn);
int be_is_Reload(const ir_node *irn);
int be_is_Copy(const ir_node *irn);
int be_is_Perm(const ir_node *irn);
Sebastian Hack's avatar
Sebastian Hack committed
198
int be_is_Keep(const ir_node *irn);
Sebastian Hack's avatar
Sebastian Hack committed
199
int be_is_CopyKeep(const ir_node *irn);
Sebastian Hack's avatar
Sebastian Hack committed
200
int be_is_Call(const ir_node *irn);
201
int be_is_Return(const ir_node *irn);
Sebastian Hack's avatar
Sebastian Hack committed
202
int be_is_IncSP(const ir_node *irn);
203
int be_is_SetSP(const ir_node *irn);
Sebastian Hack's avatar
Sebastian Hack committed
204
int be_is_AddSP(const ir_node *irn);
Sebastian Hack's avatar
Sebastian Hack committed
205
206
int be_is_RegParams(const ir_node *irn);
int be_is_StackParam(const ir_node *irn);
Christian Würdig's avatar
Christian Würdig committed
207
208
209
int be_is_FrameAddr(const ir_node *irn);
int be_is_FrameLoad(const ir_node *irn);
int be_is_FrameStore(const ir_node *irn);
Sebastian Hack's avatar
Sebastian Hack committed
210
211
int be_is_Epilogue(const ir_node *irn);
int be_is_Prologue(const ir_node *irn);
Sebastian Hack's avatar
Sebastian Hack committed
212

213
214
215
216
217
218
219
/**
 * Get the entity on the stack frame the given node uses.
 * @param irn The node.
 * @return The entity on the stack frame used by the node or NULL,
 *         if the node does not access the stack frame or is no back-end node.
 *
 */
220
entity *be_get_frame_entity(const ir_node *irn);
221

222
void   be_set_Spill_entity(ir_node *irn, entity *ent);
223
entity *be_get_spill_entity(const ir_node *irn);
224

Sebastian Hack's avatar
Sebastian Hack committed
225
ir_node *be_get_Spill_context(const ir_node *irn);
226

227
228
229
230
231
232
/**
 * Set the entities of a Reload to the ones of the Spill it is pointing to.
 * @param irg The graph.
 */
void be_copy_entities_to_reloads(ir_graph *irg);

Sebastian Hack's avatar
Sebastian Hack committed
233
234
235
236
237
238
239
/**
 * Impose a register constraint on a backend node.
 * @param irn The node.
 * @param pos The position of the argument/result. Results range from -1..-m and arguments form 0..n
 * @param reg The register which is admissible for that node, argument/result and position.
 */
void be_set_constr_single_reg(ir_node *irn, int pos, const arch_register_t *reg);
240

241
/**
242
243
244
245
246
247
 * Impose register constraints on a backend node.
 * The register subsets given by the limited function in @p req are copied to the backend node.
 * This requires that the constraint type of the @p req is arch_register_req_type_limited.
 * @param irn The backend node.
 * @param pos The position (@see be_set_constr_single_reg()).
 * @param req The register requirements which shall be transferred.
248
 */
249
void be_set_constr_limited(ir_node *irn, int pos, const arch_register_req_t *req);
250

Sebastian Hack's avatar
Sebastian Hack committed
251
252
253
254
255
256
/**
 * Set the flags of a node.
 * @param irn The node itself.
 * @param pos The position (0..n) for arguments, (-1..-m) for results.
 * @param flags The flags to set for that node and position.
 */
Sebastian Hack's avatar
Sebastian Hack committed
257
258
void be_node_set_flags(ir_node *irn, int pos, arch_irn_flags_t flags);

Sebastian Hack's avatar
Sebastian Hack committed
259
260
261
262
263
264
/**
 * Set the register class of a node.
 * @param irn The node itself.
 * @param pos The position (0..n) for arguments, (-1..-m) for results.
 * @param flags The register class to set for that node and position.
 */
Sebastian Hack's avatar
Sebastian Hack committed
265
266
void be_node_set_reg_class(ir_node *irn, int pos, const arch_register_class_t *cls);

267
268
269
270
271
272
/**
 * Insert a Perm node after a specific node in the schedule.
 * The Perm permutes over all values live at the given node.
 * This means that all liveness intervals are cut apart at this
 * location in the program.
 */
Sebastian Hack's avatar
Sebastian Hack committed
273
ir_node *insert_Perm_after(const arch_env_t *env,
Sebastian Hack's avatar
Sebastian Hack committed
274
275
276
						   const arch_register_class_t *cls,
						   dom_front_info_t *dom_front,
						   ir_node *pos);
Sebastian Hack's avatar
Sebastian Hack committed
277

Sebastian Hack's avatar
Sebastian Hack committed
278

Sebastian Hack's avatar
Sebastian Hack committed
279
#endif /* _BENODE_T_H */