benode_t.h 13.2 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

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

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

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

26
27
28
29
30
31
/**
 * 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;
Matthias Braun's avatar
Matthias Braun committed
32
extern ir_op *op_be_MemPerm;
33
34
extern ir_op *op_be_Copy;
extern ir_op *op_be_Keep;
Michael Beck's avatar
Michael Beck committed
35
extern ir_op *op_be_CopyKeep;
36
37
38
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
39
extern ir_op *op_be_AddSP;
40
41
42
43
44
45
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;
46
extern ir_op *op_be_Barrier;
47

Sebastian Hack's avatar
Sebastian Hack committed
48
49
50
51
52
typedef enum {
	beo_NoBeOp = 0,
	beo_Spill,
	beo_Reload,
	beo_Perm,
Matthias Braun's avatar
Matthias Braun committed
53
	beo_MemPerm,
Sebastian Hack's avatar
Sebastian Hack committed
54
55
	beo_Copy,
	beo_Keep,
Sebastian Hack's avatar
Sebastian Hack committed
56
	beo_CopyKeep,
Sebastian Hack's avatar
Sebastian Hack committed
57
	beo_Call,
Sebastian Hack's avatar
Sebastian Hack committed
58
	beo_Return,
Sebastian Hack's avatar
Sebastian Hack committed
59
	beo_AddSP,
Sebastian Hack's avatar
Sebastian Hack committed
60
	beo_IncSP,
Sebastian Hack's avatar
Sebastian Hack committed
61
	beo_SetSP,
Sebastian Hack's avatar
Sebastian Hack committed
62
	beo_RegParams,
Sebastian Hack's avatar
Sebastian Hack committed
63
	beo_StackParam,
64
65
66
	beo_FrameLoad,
	beo_FrameStore,
	beo_FrameAddr,
67
	beo_Barrier,
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
typedef enum {
73
74
	be_stack_dir_expand = 0,
	be_stack_dir_shrink = 1
Sebastian Hack's avatar
Sebastian Hack committed
75
76
} 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)

90
91
92
93
94
/**
 * Determines if irn is a be_node.
 */
int is_be_node(const ir_node *irn);

95
96
97
/**
 * Create all BE specific opcodes.
 */
Sebastian Hack's avatar
Sebastian Hack committed
98
void be_node_init(void);
99

100
101
102
/**
 * Position numbers for the be_Spill inputs.
 */
103
104
105
106
enum {
	be_pos_Spill_frame = 0,
	be_pos_Spill_val   = 1
};
107
108
109
110

/**
 * Make a new Spill node.
 */
Matthias Braun's avatar
Matthias Braun committed
111
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);
112

113
114
115
/**
 * Position numbers for the be_Reload inputs.
 */
116
117
118
119
enum {
	be_pos_Reload_frame = 0,
	be_pos_Reload_mem   = 1
};
120
121
122
123

/**
 * Make a new Reload node.
 */
Sebastian Hack's avatar
Sebastian Hack committed
124
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);
125

126
127
128
/**
 * Position numbers for the be_Copy inputs.
 */
129
enum {
130
	be_pos_Copy_op = 0
131
};
132
133
134
135

/**
 * Make a new Copy node.
 */
Sebastian Hack's avatar
Sebastian Hack committed
136
ir_node *be_new_Copy(const arch_register_class_t *cls, ir_graph *irg, ir_node *block, ir_node *in);
137
/** Returns the Copy Argument. */
138
ir_node *be_get_Copy_op(const ir_node *cpy);
139
140
/** Sets the Copy Argument. */
void be_set_Copy_op(ir_node *cpy, ir_node *op);
141

142
143
144
/**
 * Make a new Perm node.
 */
Sebastian Hack's avatar
Sebastian Hack committed
145
ir_node *be_new_Perm(const arch_register_class_t *cls, ir_graph *irg, ir_node *bl, int arity, ir_node *in[]);
146
147
148
/**
 * Create a new MemPerm node.
 */
Matthias Braun's avatar
Matthias Braun committed
149
ir_node *be_new_MemPerm(const arch_env_t *arch_env, ir_graph *irg, ir_node *bl, int n, ir_node *in[]);
Sebastian Hack's avatar
Sebastian Hack committed
150
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
151

152
153
154
155
156
157
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);

158
159
160
/**
 * Position numbers for the be_AddSP inputs
 */
Sebastian Hack's avatar
Sebastian Hack committed
161
162
163
164
165
166
enum {
	be_pos_AddSP_old_sp = 0,
	be_pos_AddSP_size   = 1,
	be_pos_AddSP_last   = 2
};

Sebastian Hack's avatar
Sebastian Hack committed
167
168
169
170
171
172
enum {
	pn_be_AddSP_res  = 0,
	pn_be_AddSP_M    = 1,
	pn_be_AddSP_last = 2
};

Sebastian Hack's avatar
Sebastian Hack committed
173
174
175
176
177
178
179
180
181
182
183
184
185
/**
 * 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
186

Sebastian Hack's avatar
Sebastian Hack committed
187
188
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
189
190
/**
 * Make a stack pointer increase/decrease node.
Sebastian Hack's avatar
Sebastian Hack committed
191
 * @param sp     The stack pointer register.
Sebastian Hack's avatar
Sebastian Hack committed
192
193
194
195
196
197
198
199
200
 * @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.
 */
201
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
202

Michael Beck's avatar
BugFix:    
Michael Beck committed
203
204
/** Returns the previous node that computes the stack pointer. */
ir_node *be_get_IncSP_pred(ir_node *incsp);
Sebastian Hack's avatar
Sebastian Hack committed
205

206
/** Sets the previous node that computes the stack pointer. */
207
void     be_set_IncSP_pred(ir_node *incsp, ir_node *pred);
208

Michael Beck's avatar
Michael Beck committed
209
210
211
/** Returns the memory input of the IncSP. */
ir_node *be_get_IncSP_mem(ir_node *irn);

Michael Beck's avatar
BugFix:    
Michael Beck committed
212
/** Sets a new offset to a IncSP node. */
Sebastian Hack's avatar
Sebastian Hack committed
213
void     be_set_IncSP_offset(ir_node *irn, unsigned offset);
Michael Beck's avatar
BugFix:    
Michael Beck committed
214
215

/** Gets the offset from a IncSP node. */
216
unsigned be_get_IncSP_offset(const ir_node *irn);
Sebastian Hack's avatar
Sebastian Hack committed
217

Michael Beck's avatar
BugFix:    
Michael Beck committed
218
/** Sets a new direction to a IncSP node. */
Sebastian Hack's avatar
Sebastian Hack committed
219
void           be_set_IncSP_direction(ir_node *irn, be_stack_dir_t dir);
Michael Beck's avatar
BugFix:    
Michael Beck committed
220
221

/** Gets the direction from a IncSP node. */
222
be_stack_dir_t be_get_IncSP_direction(const ir_node *irn);
Sebastian Hack's avatar
Sebastian Hack committed
223

224
225
226
227
228
229
230
231
/** Gets the call entity or NULL if this is no static call. */
entity  *be_Call_get_entity(const ir_node *call);
/** Sets the call entity. */
void     be_Call_set_entity(ir_node *call, entity *ent);
/** Gets the call type. */
ir_type *be_Call_get_type(ir_node *call);
/** Sets the call type. */
void     be_Call_set_type(ir_node *call, ir_type *call_tp);
232

233
234
235
/**
 * Position numbers for the be_Call inputs.
 */
236
enum {
237
238
239
240
	be_pos_Call_mem       = 0,  /**< memory input of a be_Call node */
	be_pos_Call_sp        = 1,  /**< stack pointer input of a be_Call node */
	be_pos_Call_ptr       = 2,  /**< call pointer input of a be_Call node */
	be_pos_Call_first_arg = 3   /**< first argument input of a be_Call node */
241
242
};

243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
/**
 * Projection numbers for result of be_Call node: use for Proj nodes!
 */
typedef enum {
	pn_be_Call_M_regular = pn_Call_M_regular,  /**< The memory result of a be_Call. */
	pn_be_Call_first_res = pn_Call_max         /**< The first result proj number of a be_Call. */
} pn_be_Call;

/**
 * Construct a new be_Call
 */
ir_node *be_new_Call(dbg_info *dbg, ir_graph *irg, ir_node *bl, ir_node *mem, ir_node *sp, ir_node *ptr,
                     int n_outs, int n, ir_node *in[], ir_type *call_tp);

/**
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 * Position numbers for the be_Return inputs.
 */
enum {
	be_pos_Return_mem  = 0,     /**< memory input of a be_Return node */
	be_pos_Return_sp   = 1,     /**< stack pointer input of a be_Return node */
	be_pos_Return_val  = 2,     /**< first "real" return value if any */
};

/**
 * Construct a new be_Return.
 * @param irg    the graph where the new node will be placed
 * @param bl     the block where the new node will be placed
 * @param n_res  number of "real" results
 * @param n      number of inputs
 * @param in     input array
 */
ir_node *be_new_Return(dbg_info *dbg, ir_graph *irg, ir_node *bl, int n_res, int n, ir_node *in[]);

/** Returns the number of real returns values */
int be_Return_get_n_rets(ir_node *ret);

/**
 * Construct a new Stack Parameter node.
281
 */
Sebastian Hack's avatar
Sebastian Hack committed
282
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
283
ir_node *be_new_RegParams(ir_graph *irg, ir_node *bl, int n_out);
Sebastian Hack's avatar
Sebastian Hack committed
284

285
ir_node *be_new_Barrier(ir_graph *irg, ir_node *bl, int n, ir_node *in[]);
Sebastian Hack's avatar
Sebastian Hack committed
286

Sebastian Hack's avatar
Sebastian Hack committed
287
/**
288
 * Make a spill node.
Sebastian Hack's avatar
Sebastian Hack committed
289
290
291
292
293
294
 *
 * @param arch_env  The architecture environment.
 * @param irn       The node to be spilled.
 * @param spill_ctx The context in which the spill is introduced (This is mostly == irn up to the case of Phis).
 * @return          The new spill node.
 */
Matthias Braun's avatar
Matthias Braun committed
295
ir_node *be_spill(const arch_env_t *arch_env, ir_node *irn);
Sebastian Hack's avatar
Sebastian Hack committed
296
297
298
299
300
301
302
303
304
305
306
307

/**
 * Make a reload and insert it into the schedule.
 *
 * @param arch_env The architecture environment.
 * @param cls      The register class of the reloaded value.
 * @param insert   The node in the schedule in front of which the reload is inserted.
 * @param mode     The mode of the original (spilled) value.
 * @param spill    The spill node corresponding to this reload.
 * @return         A freshly made reload.
 */
ir_node *be_reload(const arch_env_t *arch_env, const arch_register_class_t *cls, ir_node *insert, ir_mode *mode, ir_node *spill);
Sebastian Hack's avatar
Sebastian Hack committed
308

Sebastian Hack's avatar
Sebastian Hack committed
309
310
311
enum {
	be_pos_CopyKeep_op = 0
};
Sebastian Hack's avatar
Sebastian Hack committed
312
313
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);
314
315
ir_node *be_get_CopyKeep_op(const ir_node *cpy);
void be_set_CopyKeep_op(ir_node *cpy, ir_node *op);
Sebastian Hack's avatar
Sebastian Hack committed
316

Sebastian Hack's avatar
Sebastian Hack committed
317
318
319
320
321
/**
 * Get the backend opcode of a backend node.
 * @param irn The node.
 * @return The backend opcode.
 */
Sebastian Hack's avatar
Sebastian Hack committed
322
323
be_opcode_t be_get_irn_opcode(const ir_node *irn);

324
325
326
327
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);
Matthias Braun's avatar
Matthias Braun committed
328
int be_is_MemPerm(const ir_node *irn);
Sebastian Hack's avatar
Sebastian Hack committed
329
int be_is_Keep(const ir_node *irn);
Sebastian Hack's avatar
Sebastian Hack committed
330
int be_is_CopyKeep(const ir_node *irn);
Sebastian Hack's avatar
Sebastian Hack committed
331
int be_is_Call(const ir_node *irn);
332
int be_is_Return(const ir_node *irn);
Sebastian Hack's avatar
Sebastian Hack committed
333
int be_is_IncSP(const ir_node *irn);
334
int be_is_SetSP(const ir_node *irn);
Sebastian Hack's avatar
Sebastian Hack committed
335
int be_is_AddSP(const ir_node *irn);
Sebastian Hack's avatar
Sebastian Hack committed
336
337
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
338
339
340
int be_is_FrameAddr(const ir_node *irn);
int be_is_FrameLoad(const ir_node *irn);
int be_is_FrameStore(const ir_node *irn);
341
int be_is_Barrier(const ir_node *irn);
Sebastian Hack's avatar
Sebastian Hack committed
342

343
/**
344
 * Try to avoid this function and better call arch_get_frame_entity!
345
 *
346
 * Returns the frame entity used by the be node
347
 */
348
entity* be_get_frame_entity(const ir_node *irn);
349
350
351
352

ir_node* be_get_Reload_mem(const ir_node *irn);
ir_node* be_get_Reload_frame(const ir_node* irn);

Matthias Braun's avatar
Matthias Braun committed
353
354
355
356
357
void be_set_MemPerm_in_entity(const ir_node *irn, int n, entity* ent);
entity *be_get_MemPerm_in_entity(const ir_node *irn, int n);

void be_set_MemPerm_out_entity(const ir_node *irn, int n, entity* ent);
entity *be_get_MemPerm_out_entity(const ir_node *irn, int n);
358

359
360
int be_get_MemPerm_entity_arity(const ir_node *irn);

Sebastian Hack's avatar
Sebastian Hack committed
361
362
363
364
365
366
367
/**
 * 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);
368

369
/**
370
371
372
373
374
375
 * 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.
376
 */
377
void be_set_constr_limited(ir_node *irn, int pos, const arch_register_req_t *req);
378

Sebastian Hack's avatar
Sebastian Hack committed
379
380
381
382
383
384
/**
 * 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
385
386
void be_node_set_flags(ir_node *irn, int pos, arch_irn_flags_t flags);

Sebastian Hack's avatar
Sebastian Hack committed
387
388
389
390
391
392
/**
 * 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
393
394
void be_node_set_reg_class(ir_node *irn, int pos, const arch_register_class_t *cls);

395
/**
Sebastian Hack's avatar
Sebastian Hack committed
396
397
398
 * Make a new phi handler.
 * @param env The architecture environment.
 * @return A new phi handler.
399
 */
Sebastian Hack's avatar
Sebastian Hack committed
400
arch_irn_handler_t *be_phi_handler_new(const arch_env_t *arch_env);
Sebastian Hack's avatar
Sebastian Hack committed
401

Sebastian Hack's avatar
Sebastian Hack committed
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
/**
 * Free a phi handler.
 * @param handler The handler to free.
 */
void be_phi_handler_free(arch_irn_handler_t *handler);

/**
 * Reset the register data in the phi handler.
 * This should be called on each new graph and deletes the register information of the current graph.
 */
void be_phi_handler_reset(arch_irn_handler_t *handler);

/**
 * irn handler for common be nodes.
 */
extern const arch_irn_handler_t be_node_irn_handler;
Sebastian Hack's avatar
Sebastian Hack committed
418

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