benode.h 16.4 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.
 */

Sebastian Hack's avatar
Sebastian Hack committed
20
/**
Christian Würdig's avatar
Christian Würdig committed
21
22
23
24
25
 * @file
 * @brief       Backend node support for generic backend nodes.
 * @author      Sebastian Hack
 * @date        17.05.2005
 * @version     $Id$
Sebastian Hack's avatar
Sebastian Hack committed
26
 *
Christian Würdig's avatar
Christian Würdig committed
27
28
 * Backend node support for generic backend nodes.
 * This file provides Perm, Copy, Spill and Reload nodes.
Sebastian Hack's avatar
Sebastian Hack committed
29
 */
Christian Würdig's avatar
Christian Würdig committed
30
31
#ifndef FIRM_BE_BENODE_T_H
#define FIRM_BE_BENODE_T_H
32

33
34
#include <limits.h>

35
#include "firm_types.h"
36
#include "irnode_t.h"
Christian Würdig's avatar
Christian Würdig committed
37
#include "bearch.h"
Sebastian Hack's avatar
Sebastian Hack committed
38

39
40
41
42
43
44
/**
 * 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
45
extern ir_op *op_be_MemPerm;
46
47
extern ir_op *op_be_Copy;
extern ir_op *op_be_Keep;
Michael Beck's avatar
Michael Beck committed
48
extern ir_op *op_be_CopyKeep;
49
50
51
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
52
extern ir_op *op_be_AddSP;
Michael Beck's avatar
Michael Beck committed
53
extern ir_op *op_be_SubSP;
54
extern ir_op *op_be_Start;
55
extern ir_op *op_be_FrameAddr;
56
extern ir_op *op_be_Barrier;
57

Sebastian Hack's avatar
Sebastian Hack committed
58
59
60
61
/**
 * 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.
 */
62
63
#define BE_STACK_FRAME_SIZE_EXPAND INT_MAX
#define BE_STACK_FRAME_SIZE_SHRINK INT_MIN
Sebastian Hack's avatar
Sebastian Hack committed
64

65
66
67
68
69
/**
 * Determines if irn is a be_node.
 */
int is_be_node(const ir_node *irn);

70
71
72
/**
 * Create all BE specific opcodes.
 */
73
void be_init_op(void);
74

75
76
77
/**
 * Position numbers for the be_Spill inputs.
 */
78
enum {
79
80
	be_pos_Spill_frame = 0,
	be_pos_Spill_val   = 1
81
};
82
83
84
85

/**
 * Make a new Spill node.
 */
86
ir_node *be_new_Spill(const arch_register_class_t *cls, const arch_register_class_t *cls_frame,
87
	ir_node *bl, ir_node *frame, ir_node *to_spill);
88

89
90
91
/**
 * Position numbers for the be_Reload inputs.
 */
92
enum {
93
94
	be_pos_Reload_frame = 0,
	be_pos_Reload_mem   = 1
95
};
96
97
98
99

/**
 * Make a new Reload node.
 */
100
ir_node *be_new_Reload(const arch_register_class_t *cls, const arch_register_class_t *cls_frame,
101
	ir_node *bl, ir_node *frame, ir_node *mem, ir_mode *mode);
102

103
104
105
/**
 * Position numbers for the be_Copy inputs.
 */
106
enum {
107
	be_pos_Copy_op = 0
108
};
109
110
111
112

/**
 * Make a new Copy node.
 */
113
ir_node *be_new_Copy(const arch_register_class_t *cls, ir_node *block, ir_node *in);
114
/** Returns the Copy Argument. */
115
ir_node *be_get_Copy_op(const ir_node *cpy);
116
117
/** Sets the Copy Argument. */
void be_set_Copy_op(ir_node *cpy, ir_node *op);
118

119
120
121
/**
 * Make a new Perm node.
 */
122
ir_node *be_new_Perm(const arch_register_class_t *cls, ir_node *bl, int arity, ir_node *in[]);
123
124
125
126
127
128
129
130
131
132
133
134
135
136

/**
 * 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.
 * This is needed by the Perm optimization/movement in belower.c, see push_through_perm().
 * @param perm     The perm node.
 * @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).
 */
void be_Perm_reduce(ir_node *perm, int new_size, int *map);

137
138
139
/**
 * Create a new MemPerm node.
 */
140
ir_node *be_new_MemPerm(const arch_env_t *arch_env, ir_node *bl, int n, ir_node *in[]);
141
ir_node *be_new_Keep(ir_node *block, int arity, ir_node *in[]);
Sebastian Hack's avatar
Sebastian Hack committed
142

143
144
void be_Keep_add_node(ir_node *keep, const arch_register_class_t *cls, ir_node *node);

145
146
147
148
149
150
151
/**
 * Position numbers for the be_FrameAddr inputs
 */
enum {
	be_pos_FrameAddr_ptr = 0
};

Michael Beck's avatar
Michael Beck committed
152
/** Create a new FrameAddr node. */
153
ir_node *be_new_FrameAddr(const arch_register_class_t *cls_frame, ir_node *bl, ir_node *frame, ir_entity *ent);
154

Michael Beck's avatar
Michael Beck committed
155
/** Return the frame input of a FrameAddr node. */
Matthias Braun's avatar
Matthias Braun committed
156
157
158
ir_node *be_get_FrameAddr_frame(const ir_node *node);

ir_entity *be_get_FrameAddr_entity(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
159

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

Sebastian Hack's avatar
Sebastian Hack committed
169
enum {
170
171
172
173
	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
174
175
};

Sebastian Hack's avatar
Sebastian Hack committed
176
177
178
179
180
181
182
183
184
185
186
/**
 * 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 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.
 */
187
ir_node *be_new_AddSP(const arch_register_t *sp, ir_node *bl, ir_node *old_sp, ir_node *sz);
Sebastian Hack's avatar
Sebastian Hack committed
188

Michael Beck's avatar
Michael Beck committed
189
190
191
192
193
194
195
196
197
198
/**
 * Position numbers for the be_SubSP inputs
 */
enum {
	be_pos_SubSP_old_sp = 0,
	be_pos_SubSP_size   = 1,
	be_pos_SubSP_last   = 2
};

enum {
199
	pn_be_SubSP_sp   = 0,
Michael Beck's avatar
Michael Beck committed
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
	pn_be_SubSP_M    = 1,
	pn_be_SubSP_last = 2
};

/**
 * Make a new SubSP node.
 * 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.
 * @param sp     The stack pointer register.
 * @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 DecSP node.
 */
215
ir_node *be_new_SubSP(const arch_register_t *sp, ir_node *bl, ir_node *old_sp, ir_node *sz);
Michael Beck's avatar
Michael Beck committed
216

Sebastian Hack's avatar
Sebastian Hack committed
217
218
/**
 * Make a stack pointer increase/decrease node.
219
 * @param sp     The stack pointer register. * @param irg    The graph to insert the node to.
Sebastian Hack's avatar
Sebastian Hack committed
220
221
 * @param bl     The block to insert the node into.
 * @param old_sp The node defining the former stack pointer.
222
 * @param amount The mount of bytes the stack shall be expanded/shrinked (see set_IncSP_offset)
Sebastian Hack's avatar
Sebastian Hack committed
223
224
225
226
227
 * @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.
 */
228
ir_node *be_new_IncSP(const arch_register_t *sp, ir_node *bl,
229
                      ir_node *old_sp, int offset, int align);
Sebastian Hack's avatar
Sebastian Hack committed
230

Michael Beck's avatar
BugFix:    
Michael Beck committed
231
232
/** 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
233

234
/** Sets the previous node that computes the stack pointer. */
235
void     be_set_IncSP_pred(ir_node *incsp, ir_node *pred);
236

237
238
239
240
241
242
243
/**
 * 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
244
245

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

249
/** Gets the call entity or NULL if this is no static call. */
250
ir_entity  *be_Call_get_entity(const ir_node *call);
251
/** Sets the call entity. */
252
void     be_Call_set_entity(ir_node *call, ir_entity *ent);
253
254
255
256
/** 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);
257

Matthias Braun's avatar
Matthias Braun committed
258
259
260
261
void     be_Call_set_pop(ir_node *call, unsigned pop);

unsigned be_Call_get_pop(const ir_node *call);

262
263
264
/**
 * Position numbers for the be_Call inputs.
 */
265
enum {
266
267
268
269
	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 */
270
271
};

272
273
274
275
/**
 * Projection numbers for result of be_Call node: use for Proj nodes!
 */
typedef enum {
276
	pn_be_Call_M_regular = pn_Call_M,    /**< The memory result of a be_Call. */
Matthias Braun's avatar
Matthias Braun committed
277
	pn_be_Call_sp        = pn_Call_max,
278
	pn_be_Call_first_res                 /**< The first result proj number of a be_Call. */
279
280
281
} pn_be_Call;

/**
Michael Beck's avatar
Michael Beck committed
282
283
284
285
286
287
288
289
290
291
292
293
 * Construct a new be_Call.
 *
 * @param dbg      debug info
 * @param irg      the graph where the call is placed
 * @param bl       the block where the call is placed
 * @param mem      the memory input of the call
 * @param sp       the stack pointer input of the call
 * @param ptr      the address of the called function, if immediate call set to sp
 * @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
294
295
296
297
298
 */
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);

/**
299
300
301
302
303
304
305
306
307
308
 * 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.
Michael Beck's avatar
Michael Beck committed
309
310
 *
 * @param dbg    debug info
311
312
313
314
 * @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
315
 * @param pop    pop number of bytes on return
316
317
 * @param in     input array
 */
318
ir_node *be_new_Return(dbg_info *dbg, ir_graph *irg, ir_node *bl, int n_res, unsigned pop, int n, ir_node *in[]);
319
320

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

Michael Beck's avatar
Michael Beck committed
323
324
325
326
327
/**
 * Return the number of bytes that should be popped from stack when executing the Return.
 *
 * @param ret  the be_Return node
 */
328
unsigned be_Return_get_pop(const ir_node *ret);
329

330
331
332
333
334
335
336
337
338
339
340
341
342
343
/**
 * 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);

344
345
346
/** appends a node to the return node, returns the position of the node */
int be_Return_append_node(ir_node *ret, ir_node *node);

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

349
ir_node *be_new_Barrier(ir_node *bl, int n, ir_node *in[]);
Sebastian Hack's avatar
Sebastian Hack committed
350

351
352
353
354
355
/**
 * Appends a node to a barrier, returns the result proj of the node
 */
ir_node *be_Barrier_append_node(ir_node *barrier, ir_node *node);

Sebastian Hack's avatar
Sebastian Hack committed
356
/**
357
 * Make a spill node.
Sebastian Hack's avatar
Sebastian Hack committed
358
359
360
361
362
 *
 * @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.
 */
363
ir_node *be_spill(ir_node *block, ir_node *irn);
Sebastian Hack's avatar
Sebastian Hack committed
364
365
366
367
368
369
370
371
372
373

/**
 * Make a reload and insert it into the schedule.
 *
 * @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.
 */
374
ir_node *be_reload(const arch_register_class_t *cls, ir_node *insert, ir_mode *mode, ir_node *spill);
Sebastian Hack's avatar
Sebastian Hack committed
375

Sebastian Hack's avatar
Sebastian Hack committed
376
377
378
enum {
	be_pos_CopyKeep_op = 0
};
379
380
ir_node *be_new_CopyKeep(const arch_register_class_t *cls, 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_node *bl, ir_node *src, ir_node *keep, ir_mode *mode);
381
382
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
383

Sebastian Hack's avatar
Sebastian Hack committed
384
385
386
387
388
/**
 * Get the backend opcode of a backend node.
 * @param irn The node.
 * @return The backend opcode.
 */
389
#define be_get_irn_opcode(irn)	get_irn_opcode(irn)
Sebastian Hack's avatar
Sebastian Hack committed
390

391
/**
Michael Beck's avatar
Michael Beck committed
392
 * Returns the frame entity of a be node.
393
 * Try to avoid this function and better call arch_get_frame_entity!
394
 *
Michael Beck's avatar
Michael Beck committed
395
 * @return the frame entity used by the be node
396
 */
397
398
399
400
401
402
ir_entity *be_get_frame_entity(const ir_node *irn);

/**
 * Returns the frame offset of this node.
 */
int be_get_frame_offset(const ir_node *irn);
403
404

ir_node* be_get_Reload_mem(const ir_node *irn);
405
ir_node *be_get_Reload_frame(const ir_node *irn);
406
ir_node* be_get_Spill_val(const ir_node *irn);
407
ir_node *be_get_Spill_frame(const ir_node *irn);
408

409
410
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
411

412
413
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);
414

415
416
int be_get_MemPerm_entity_arity(const ir_node *irn);

Sebastian Hack's avatar
Sebastian Hack committed
417
418
419
/**
 * Impose a register constraint on a backend node.
 * @param irn The node.
420
 * @param pos The position of the argument.
Sebastian Hack's avatar
Sebastian Hack committed
421
422
 * @param reg The register which is admissible for that node, argument/result and position.
 */
423
424
425
426
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);
427

428
/**
429
430
431
432
433
434
 * 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.
435
 */
436
437
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);
438

Sebastian Hack's avatar
Sebastian Hack committed
439
440
441
/**
 * Set the register class of a node.
 * @param irn The node itself.
442
 * @param pos The position (0..n) for arguments
Sebastian Hack's avatar
Sebastian Hack committed
443
444
 * @param flags The register class to set for that node and position.
 */
445
446
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
447

448
449
450
/**
 * Set the register requirements for a phi node.
 */
451
452
void be_set_phi_reg_req(ir_node *phi, const arch_register_req_t *req);

453
void be_dump_phi_reg_reqs(FILE *out, ir_node *node, dump_reason_t reason);
454

455
456
457
458
459
460
/**
 * 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,
                    const arch_register_class_t *cls);

Sebastian Hack's avatar
Sebastian Hack committed
461
/**
Michael Beck's avatar
Michael Beck committed
462
 * irn handler for common be nodes and Phi's.
Sebastian Hack's avatar
Sebastian Hack committed
463
 */
464
const void *be_node_get_irn_ops(const ir_node *irn);
Sebastian Hack's avatar
Sebastian Hack committed
465

466
467
468
469
470
471
472
473
474
475
476
477
static inline int be_is_Spill    (const ir_node *irn) { return get_irn_opcode(irn) == beo_Spill    ; }
static inline int be_is_Reload   (const ir_node *irn) { return get_irn_opcode(irn) == beo_Reload   ; }
static inline int be_is_Copy     (const ir_node *irn) { return get_irn_opcode(irn) == beo_Copy     ; }
static inline int be_is_CopyKeep (const ir_node *irn) { return get_irn_opcode(irn) == beo_CopyKeep ; }
static inline int be_is_Perm     (const ir_node *irn) { return get_irn_opcode(irn) == beo_Perm     ; }
static inline int be_is_MemPerm  (const ir_node *irn) { return get_irn_opcode(irn) == beo_MemPerm  ; }
static inline int be_is_Keep     (const ir_node *irn) { return get_irn_opcode(irn) == beo_Keep     ; }
static inline int be_is_Call     (const ir_node *irn) { return get_irn_opcode(irn) == beo_Call     ; }
static inline int be_is_Return   (const ir_node *irn) { return get_irn_opcode(irn) == beo_Return   ; }
static inline int be_is_IncSP    (const ir_node *irn) { return get_irn_opcode(irn) == beo_IncSP    ; }
static inline int be_is_AddSP    (const ir_node *irn) { return get_irn_opcode(irn) == beo_AddSP    ; }
static inline int be_is_SubSP    (const ir_node *irn) { return get_irn_opcode(irn) == beo_SubSP    ; }
478
static inline int be_is_Start    (const ir_node *irn) { return get_irn_opcode(irn) == beo_Start; }
479
480
static inline int be_is_FrameAddr(const ir_node *irn) { return get_irn_opcode(irn) == beo_FrameAddr; }
static inline int be_is_Barrier  (const ir_node *irn) { return get_irn_opcode(irn) == beo_Barrier  ; }
481

Christian Würdig's avatar
Christian Würdig committed
482
#endif /* FIRM_BE_BENODE_T_H */