benode.h 13.3 KB
Newer Older
Christian Würdig's avatar
Christian Würdig committed
1
2
/*
 * This file is part of libFirm.
3
 * Copyright (C) 2012 University of Karlsruhe.
Christian Würdig's avatar
Christian Würdig committed
4
5
 */

Sebastian Hack's avatar
Sebastian Hack committed
6
/**
Christian Würdig's avatar
Christian Würdig committed
7
8
9
10
 * @file
 * @brief       Backend node support for generic backend nodes.
 * @author      Sebastian Hack
 * @date        17.05.2005
Sebastian Hack's avatar
Sebastian Hack committed
11
 *
Christian Würdig's avatar
Christian Würdig committed
12
 * Backend node support for generic backend nodes.
13
 * This file provides Perm, and Copy nodes.
Sebastian Hack's avatar
Sebastian Hack committed
14
 */
Christian Würdig's avatar
Christian Würdig committed
15
16
#ifndef FIRM_BE_BENODE_T_H
#define FIRM_BE_BENODE_T_H
17

18
19
#include <limits.h>

20
#include "firm_types.h"
21
#include "irnode_t.h"
Christian Würdig's avatar
Christian Würdig committed
22
#include "bearch.h"
Sebastian Hack's avatar
Sebastian Hack committed
23

24
25
typedef enum be_opcode {
	beo_Perm,
26
	beo_first = beo_Perm,
27
28
29
30
31
32
33
34
35
36
	beo_MemPerm,
	beo_Copy,
	beo_Keep,
	beo_CopyKeep,
	beo_Call,
	beo_Return,
	beo_IncSP,
	beo_AddSP,
	beo_SubSP,
	beo_Start,
37
	beo_last  = beo_Start
38
39
} be_opcode;

40
41
42
43
/**
 * The benode op's.  Must be available to register emitter function.
 */
extern ir_op *op_be_Perm;
Matthias Braun's avatar
Matthias Braun committed
44
extern ir_op *op_be_MemPerm;
45
46
extern ir_op *op_be_Copy;
extern ir_op *op_be_Keep;
Michael Beck's avatar
Michael Beck committed
47
extern ir_op *op_be_CopyKeep;
48
49
50
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
51
extern ir_op *op_be_AddSP;
Michael Beck's avatar
Michael Beck committed
52
extern ir_op *op_be_SubSP;
53
extern ir_op *op_be_Start;
54

55
56
57
/**
 * Determines if irn is a be_node.
 */
58
59
60
bool is_be_node(const ir_node *irn);

be_opcode get_be_irn_opcode(const ir_node *node);
61

62
63
64
/**
 * Create all BE specific opcodes.
 */
65
void be_init_op(void);
66

Matthias Braun's avatar
Matthias Braun committed
67
68
void be_finish_op(void);

69
70
71
/**
 * Position numbers for the be_Copy inputs.
 */
72
enum {
73
	n_be_Copy_op = 0
74
};
75
76
77
78

/**
 * Make a new Copy node.
 */
79
ir_node *be_new_Copy(ir_node *block, ir_node *in);
80
/** Returns the Copy Argument. */
81
82
ir_node *be_get_Copy_op(const ir_node *cpy);

83
84
85
/**
 * Make a new Perm node.
 */
86
ir_node *be_new_Perm(arch_register_class_t const *cls, ir_node *block, int n, ir_node *const *in);
87
88
89
90
91
92
93

/**
 * Reduce a Perm.
 * Basically, we provide a map to remap the Perm's arguments. If an entry in the
 * map is -1, the argument gets deleted.
 * This function takes care, that the register data and the input array reflects
 * the changes described by the map.
94
95
 * This is needed by the Perm optimization/movement in belower.c, see
 * push_through_perm().
96
 * @param perm     The perm node.
97
98
99
100
 * @param new_size The new number of arguments (must be smaller or equal to the
 *                 current one).
 * @param map      A map assigning each operand a new index (or -1 to indicate
 *                 deletion).
101
102
103
 */
void be_Perm_reduce(ir_node *perm, int new_size, int *map);

104
105
/**
 * Create a new MemPerm node.
106
107
108
 * A MemPerm node exchanges the values of memory locations. (Typically entities
 * used as spillslots). MemPerm nodes perform this operation without modifying
 * any register values.
109
 */
110
111
112
ir_node *be_new_MemPerm(ir_node *block, int n, ir_node *const *in);

ir_node *be_new_Keep(ir_node *block, int arity, ir_node *const *in);
Sebastian Hack's avatar
Sebastian Hack committed
113

114
115
void be_Keep_add_node(ir_node *keep, const arch_register_class_t *cls,
                      ir_node *node);
116

117
118
119
/**
 * Position numbers for the be_AddSP inputs
 */
Sebastian Hack's avatar
Sebastian Hack committed
120
enum {
121
122
123
	n_be_AddSP_old_sp = 0,
	n_be_AddSP_size   = 1,
	n_be_AddSP_last   = 2
Sebastian Hack's avatar
Sebastian Hack committed
124
125
};

Sebastian Hack's avatar
Sebastian Hack committed
126
enum {
127
128
129
130
	pn_be_AddSP_sp   = 0,
	pn_be_AddSP_res  = 1,
	pn_be_AddSP_M    = 2,
	pn_be_AddSP_last = 3
Sebastian Hack's avatar
Sebastian Hack committed
131
132
};

Sebastian Hack's avatar
Sebastian Hack committed
133
134
/**
 * Make a new AddSP node.
135
136
137
 * 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.
Sebastian Hack's avatar
Sebastian Hack committed
138
 * @param sp     The stack pointer register.
139
 * @param block  The block.
Sebastian Hack's avatar
Sebastian Hack committed
140
 * @param old_sp The node representing the old stack pointer value.
141
142
 * @param size   The node expressing the size by which the stack pointer shall
 *               be grown.
Sebastian Hack's avatar
Sebastian Hack committed
143
144
 * @return       A new AddSP node.
 */
145
146
ir_node *be_new_AddSP(const arch_register_t *sp, ir_node *block,
                      ir_node *old_sp, ir_node *size);
Sebastian Hack's avatar
Sebastian Hack committed
147

Michael Beck's avatar
Michael Beck committed
148
149
150
151
/**
 * Position numbers for the be_SubSP inputs
 */
enum {
152
153
154
	n_be_SubSP_old_sp = 0,
	n_be_SubSP_size   = 1,
	n_be_SubSP_last   = 2
Michael Beck's avatar
Michael Beck committed
155
156
157
};

enum {
158
	pn_be_SubSP_sp   = 0,
Michael Beck's avatar
Michael Beck committed
159
160
161
162
163
164
	pn_be_SubSP_M    = 1,
	pn_be_SubSP_last = 2
};

/**
 * Make a new SubSP node.
165
166
167
 * A SubSP node expresses a decrease 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.
Michael Beck's avatar
Michael Beck committed
168
 * @param sp     The stack pointer register.
169
 * @param block  The block.
Michael Beck's avatar
Michael Beck committed
170
 * @param old_sp The node representing the old stack pointer value.
171
172
 * @param size   The node expressing the size by which the stack pointer shall
 *               be grown.
Michael Beck's avatar
Michael Beck committed
173
174
 * @return       A new DecSP node.
 */
175
176
ir_node *be_new_SubSP(const arch_register_t *sp, ir_node *block,
                      ir_node *old_sp, ir_node *size);
Michael Beck's avatar
Michael Beck committed
177

Sebastian Hack's avatar
Sebastian Hack committed
178
179
/**
 * Make a stack pointer increase/decrease node.
180
181
 * @param sp     The stack pointer register.
 * @param block  The block to insert the node into.
Sebastian Hack's avatar
Sebastian Hack committed
182
 * @param old_sp The node defining the former stack pointer.
183
184
185
186
 * @param offset amount the stack should expand (positive offset) or shrink
 *               (negative offset). Note that the offset is independent of the
 *               natural stack direction of the architecture but just specifies
 *               abstract expanding/shrinking of the stack area.
yb9976's avatar
yb9976 committed
187
 * @param align  force stack alignment to this power of 2. (i.e. specifying 3
188
 *               results in a 2^3 = 8byte stack alignment)
Sebastian Hack's avatar
Sebastian Hack committed
189
 * @return       A new stack pointer increment/decrement node.
190
191
 * @note         This node sets a register constraint to the @p sp register on
 *               its output.
Sebastian Hack's avatar
Sebastian Hack committed
192
 */
193
ir_node *be_new_IncSP(const arch_register_t *sp, ir_node *block,
194
                      ir_node *old_sp, int offset, int align);
Sebastian Hack's avatar
Sebastian Hack committed
195

Michael Beck's avatar
BugFix:    
Michael Beck committed
196
197
/** 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
198

199
/** Sets the previous node that computes the stack pointer. */
200
void     be_set_IncSP_pred(ir_node *incsp, ir_node *pred);
201

202
203
204
205
206
207
208
/**
 * Sets a new offset to a IncSP node.
 * A positive offset means expanding the stack, a negative offset shrinking
 * an offset is == BE_STACK_FRAME_SIZE will be replaced by the real size of the
 * stackframe in the fix_stack_offsets phase.
 */
void     be_set_IncSP_offset(ir_node *irn, int offset);
Michael Beck's avatar
BugFix:    
Michael Beck committed
209
210

/** Gets the offset from a IncSP node. */
211
int be_get_IncSP_offset(const ir_node *irn);
212
int be_get_IncSP_align(const ir_node *irn);
Sebastian Hack's avatar
Sebastian Hack committed
213

214
/** Gets the call entity or NULL if this is no static call. */
215
ir_entity  *be_Call_get_entity(const ir_node *call);
216
/** Sets the call entity. */
217
void     be_Call_set_entity(ir_node *call, ir_entity *ent);
218
219
220
221
/** 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);
222

Matthias Braun's avatar
Matthias Braun committed
223
224
225
226
void     be_Call_set_pop(ir_node *call, unsigned pop);

unsigned be_Call_get_pop(const ir_node *call);

227
228
229
/**
 * Position numbers for the be_Call inputs.
 */
230
enum {
231
232
233
234
	n_be_Call_mem       = 0,  /**< memory input of a be_Call node */
	n_be_Call_sp        = 1,  /**< stack pointer input of a be_Call node */
	n_be_Call_ptr       = 2,  /**< call pointer input of a be_Call node */
	n_be_Call_first_arg = 3   /**< first argument input of a be_Call node */
235
236
};

237
238
239
240
/**
 * Projection numbers for result of be_Call node: use for Proj nodes!
 */
typedef enum {
241
242
243
	pn_be_Call_M         = pn_Call_M, /**< The memory result of a be_Call. */
	pn_be_Call_X_regular = pn_Call_X_regular,
	pn_be_Call_X_except  = pn_Call_X_except,
244
	pn_be_Call_sp        = pn_Call_max+1,
245
	pn_be_Call_first_res     /**< The first result proj number of a be_Call. */
246
247
248
} pn_be_Call;

/**
Michael Beck's avatar
Michael Beck committed
249
250
251
 * Construct a new be_Call.
 *
 * @param dbg      debug info
252
 * @param block    the block where the call is placed
Michael Beck's avatar
Michael Beck committed
253
254
 * @param mem      the memory input of the call
 * @param sp       the stack pointer input of the call
255
256
 * @param ptr      the address of the called function, if immediate call set
 *                 to sp
Michael Beck's avatar
Michael Beck committed
257
258
259
260
 * @param n_outs   the number of outcoming values from this call
 * @param n        the number of (register) inputs of this call
 * @param in       the (register) inputs of this call
 * @param call_tp  the call type of this call
261
 */
262
ir_node *be_new_Call(dbg_info *dbg, ir_node *block, ir_node *mem, arch_register_req_t const *sp_req, ir_node *sp, arch_register_req_t const *ptr_req, ir_node *ptr, int n_outs, int n, ir_node *const *in, ir_type *call_tp);
263
264

/**
265
266
267
 * Position numbers for the be_Return inputs.
 */
enum {
268
269
270
	n_be_Return_mem  = 0,     /**< memory input of a be_Return node */
	n_be_Return_sp   = 1,     /**< stack pointer input of a be_Return node */
	n_be_Return_val  = 2,     /**< first "real" return value if any */
271
272
273
274
};

/**
 * Construct a new be_Return.
Michael Beck's avatar
Michael Beck committed
275
276
 *
 * @param dbg    debug info
277
 * @param block  the block where the new node will be placed
278
 * @param n_res  number of "real" results
279
 * @param pop    pop number of bytes on return
280
 * @param n      number of inputs
281
282
 * @param in     input array
 */
283
ir_node *be_new_Return(dbg_info *dbg, ir_node *block, int n_res, unsigned pop, int n, ir_node *const *in);
284
285

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

Michael Beck's avatar
Michael Beck committed
288
/**
289
290
 * Return the number of bytes that should be popped from stack when executing
 * the Return.
Michael Beck's avatar
Michael Beck committed
291
292
293
 *
 * @param ret  the be_Return node
 */
294
unsigned be_Return_get_pop(const ir_node *ret);
295

296
297
298
299
300
301
302
303
304
305
306
307
308
/**
 * Return non-zero, if number of popped bytes must be always emitted.
 *
 * @param ret  the be_Return node
 */
int be_Return_get_emit_pop(const ir_node *ret);

/**
 * Set the emit_pop flag.
 *
 * @param ret  the be_Return node
 */
void be_Return_set_emit_pop(ir_node *ret, int emit_pop);
309

310
ir_node *be_new_Start(dbg_info *dbgi, ir_node *block, int n_out);
Sebastian Hack's avatar
Sebastian Hack committed
311

Sebastian Hack's avatar
Sebastian Hack committed
312
enum {
313
	n_be_CopyKeep_op = 0
Sebastian Hack's avatar
Sebastian Hack committed
314
};
315
316
ir_node *be_new_CopyKeep(ir_node *block, ir_node *src,
                         int n, ir_node *in_keep[]);
317

318
ir_node *be_new_CopyKeep_single(ir_node *block, ir_node *src, ir_node *keep);
319

320
ir_node *be_get_CopyKeep_op(const ir_node *cpy);
Sebastian Hack's avatar
Sebastian Hack committed
321

322
void be_set_CopyKeep_op(ir_node *cpy, ir_node *op);
Sebastian Hack's avatar
Sebastian Hack committed
323

324
325
void be_set_MemPerm_in_entity(const ir_node *irn, int n, ir_entity* ent);
ir_entity *be_get_MemPerm_in_entity(const ir_node *irn, int n);
Matthias Braun's avatar
Matthias Braun committed
326

327
328
void be_set_MemPerm_out_entity(const ir_node *irn, int n, ir_entity* ent);
ir_entity *be_get_MemPerm_out_entity(const ir_node *irn, int n);
329

330
331
332
void be_set_MemPerm_offset(ir_node *irn, int offset);
int be_get_MemPerm_offset(const ir_node *irn);

333
334
int be_get_MemPerm_entity_arity(const ir_node *irn);

Sebastian Hack's avatar
Sebastian Hack committed
335
336
337
/**
 * Impose a register constraint on a backend node.
 * @param irn The node.
338
 * @param pos The position of the argument.
339
340
 * @param reg The register which is admissible for that node, argument/result
 *            and position.
Sebastian Hack's avatar
Sebastian Hack committed
341
 */
342
343
344
345
void be_set_constr_single_reg_in(ir_node *irn, int pos,
		const arch_register_t *reg, arch_register_req_type_t additional_flags);
void be_set_constr_single_reg_out(ir_node *irn, int pos,
		const arch_register_t *reg, arch_register_req_type_t additional_flags);
346

347
348
349
const arch_register_req_t *be_create_reg_req(struct obstack *obst,
		const arch_register_t *reg, arch_register_req_type_t additional_types);

350
/**
351
 * Impose register constraints on a backend node.
352
353
354
 * 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.
355
356
357
 * @param irn The backend node.
 * @param pos The position (@see be_set_constr_single_reg()).
 * @param req The register requirements which shall be transferred.
358
 */
359
360
void be_set_constr_in(ir_node *irn, int pos, const arch_register_req_t *req);
void be_set_constr_out(ir_node *irn, int pos, const arch_register_req_t *req);
361

Sebastian Hack's avatar
Sebastian Hack committed
362
363
364
/**
 * Set the register class of a node.
 * @param irn The node itself.
365
 * @param pos The position (0..n) for arguments
Sebastian Hack's avatar
Sebastian Hack committed
366
367
 * @param flags The register class to set for that node and position.
 */
368
369
370
371
void be_node_set_reg_class_in(ir_node *irn, int pos,
                              const arch_register_class_t *cls);
void be_node_set_reg_class_out(ir_node *irn, int pos,
                               const arch_register_class_t *cls);
Sebastian Hack's avatar
Sebastian Hack committed
372

373
374
375
/**
 * Set the register requirements for a phi node.
 */
376
377
void be_set_phi_reg_req(ir_node *phi, const arch_register_req_t *req);

378
void be_dump_phi_reg_reqs(FILE *out, const ir_node *node, dump_reason_t reason);
379

380
381
382
383
/**
 * Creates a new phi with associated backend informations
 */
ir_node *be_new_Phi(ir_node *block, int n_ins, ir_node **ins, ir_mode *mode,
384
                    const arch_register_req_t *req);
385

386
387
388
389
390
/**
 * Search for output of start node with a specific register
 */
ir_node *be_get_initial_reg_value(ir_graph *irg, const arch_register_t *reg);

391
392
393
394
395
396
397
398
399
400
401
static inline bool be_is_Copy     (const ir_node *irn) { return get_irn_op(irn) == op_be_Copy     ; }
static inline bool be_is_CopyKeep (const ir_node *irn) { return get_irn_op(irn) == op_be_CopyKeep ; }
static inline bool be_is_Perm     (const ir_node *irn) { return get_irn_op(irn) == op_be_Perm     ; }
static inline bool be_is_MemPerm  (const ir_node *irn) { return get_irn_op(irn) == op_be_MemPerm  ; }
static inline bool be_is_Keep     (const ir_node *irn) { return get_irn_op(irn) == op_be_Keep     ; }
static inline bool be_is_Call     (const ir_node *irn) { return get_irn_op(irn) == op_be_Call     ; }
static inline bool be_is_Return   (const ir_node *irn) { return get_irn_op(irn) == op_be_Return   ; }
static inline bool be_is_IncSP    (const ir_node *irn) { return get_irn_op(irn) == op_be_IncSP    ; }
static inline bool be_is_AddSP    (const ir_node *irn) { return get_irn_op(irn) == op_be_AddSP    ; }
static inline bool be_is_SubSP    (const ir_node *irn) { return get_irn_op(irn) == op_be_SubSP    ; }
static inline bool be_is_Start    (const ir_node *irn) { return get_irn_op(irn) == op_be_Start    ; }
402

403
#endif