benode.h 16.7 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
56
extern ir_op *op_be_FrameAddr;

57
58
59
60
61
/**
 * Determines if irn is a be_node.
 */
int is_be_node(const ir_node *irn);

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

67
68
69
/**
 * Position numbers for the be_Spill inputs.
 */
70
enum {
71
72
	n_be_Spill_frame = 0,
	n_be_Spill_val   = 1
73
};
74
75
76
77

/**
 * Make a new Spill node.
 */
78
79
80
ir_node *be_new_Spill(const arch_register_class_t *cls,
                      const arch_register_class_t *cls_frame, ir_node *block,
                      ir_node *frame, ir_node *to_spill);
81

82
83
84
/**
 * Position numbers for the be_Reload inputs.
 */
85
enum {
86
87
	n_be_Reload_frame = 0,
	n_be_Reload_mem   = 1
88
};
89
90
91
92

/**
 * Make a new Reload node.
 */
93
94
95
ir_node *be_new_Reload(const arch_register_class_t *cls,
                       const arch_register_class_t *cls_frame, ir_node *block,
                       ir_node *frame, ir_node *mem, ir_mode *mode);
96

97
98
99
/**
 * Position numbers for the be_Copy inputs.
 */
100
enum {
101
	n_be_Copy_op = 0
102
};
103
104
105
106

/**
 * Make a new Copy node.
 */
107
108
ir_node *be_new_Copy(const arch_register_class_t *cls, ir_node *block,
                     ir_node *in);
109
/** Returns the Copy Argument. */
110
ir_node *be_get_Copy_op(const ir_node *cpy);
111
112
/** Sets the Copy Argument. */
void be_set_Copy_op(ir_node *cpy, ir_node *op);
113

114
115
116
/**
 * Make a new Perm node.
 */
117
118
ir_node *be_new_Perm(const arch_register_class_t *cls, ir_node *block,
                     int n, ir_node *in[]);
119
120
121
122
123
124
125

/**
 * 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.
126
127
 * This is needed by the Perm optimization/movement in belower.c, see
 * push_through_perm().
128
 * @param perm     The perm node.
129
130
131
132
 * @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).
133
134
135
 */
void be_Perm_reduce(ir_node *perm, int new_size, int *map);

136
137
/**
 * Create a new MemPerm node.
138
139
140
 * A MemPerm node exchanges the values of memory locations. (Typically entities
 * used as spillslots). MemPerm nodes perform this operation without modifying
 * any register values.
141
 */
142
ir_node *be_new_MemPerm(ir_node *block, int n, ir_node *in[]);
143
ir_node *be_new_Keep(ir_node *block, int arity, ir_node *in[]);
Sebastian Hack's avatar
Sebastian Hack committed
144

145
146
void be_Keep_add_node(ir_node *keep, const arch_register_class_t *cls,
                      ir_node *node);
147

148
149
150
151
/**
 * Position numbers for the be_FrameAddr inputs
 */
enum {
152
	n_be_FrameAddr_ptr = 0
153
154
};

Michael Beck's avatar
Michael Beck committed
155
/** Create a new FrameAddr node. */
156
157
ir_node *be_new_FrameAddr(const arch_register_class_t *cls_frame,
                          ir_node *block, ir_node *frame, ir_entity *ent);
158

Michael Beck's avatar
Michael Beck committed
159
/** Return the frame input of a FrameAddr node. */
Matthias Braun's avatar
Matthias Braun committed
160
161
162
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
163

164
165
166
/**
 * Position numbers for the be_AddSP inputs
 */
Sebastian Hack's avatar
Sebastian Hack committed
167
enum {
168
169
170
	n_be_AddSP_old_sp = 0,
	n_be_AddSP_size   = 1,
	n_be_AddSP_last   = 2
Sebastian Hack's avatar
Sebastian Hack committed
171
172
};

Sebastian Hack's avatar
Sebastian Hack committed
173
enum {
174
175
176
177
	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
178
179
};

Sebastian Hack's avatar
Sebastian Hack committed
180
181
/**
 * Make a new AddSP node.
182
183
184
 * 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
185
 * @param sp     The stack pointer register.
186
 * @param block  The block.
Sebastian Hack's avatar
Sebastian Hack committed
187
 * @param old_sp The node representing the old stack pointer value.
188
189
 * @param size   The node expressing the size by which the stack pointer shall
 *               be grown.
Sebastian Hack's avatar
Sebastian Hack committed
190
191
 * @return       A new AddSP node.
 */
192
193
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
194

Michael Beck's avatar
Michael Beck committed
195
196
197
198
/**
 * Position numbers for the be_SubSP inputs
 */
enum {
199
200
201
	n_be_SubSP_old_sp = 0,
	n_be_SubSP_size   = 1,
	n_be_SubSP_last   = 2
Michael Beck's avatar
Michael Beck committed
202
203
204
};

enum {
205
	pn_be_SubSP_sp   = 0,
Michael Beck's avatar
Michael Beck committed
206
207
208
209
210
211
	pn_be_SubSP_M    = 1,
	pn_be_SubSP_last = 2
};

/**
 * Make a new SubSP node.
212
213
214
 * 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
215
 * @param sp     The stack pointer register.
216
 * @param block  The block.
Michael Beck's avatar
Michael Beck committed
217
 * @param old_sp The node representing the old stack pointer value.
218
219
 * @param size   The node expressing the size by which the stack pointer shall
 *               be grown.
Michael Beck's avatar
Michael Beck committed
220
221
 * @return       A new DecSP node.
 */
222
223
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
224

Sebastian Hack's avatar
Sebastian Hack committed
225
226
/**
 * Make a stack pointer increase/decrease node.
227
228
 * @param sp     The stack pointer register.
 * @param block  The block to insert the node into.
Sebastian Hack's avatar
Sebastian Hack committed
229
 * @param old_sp The node defining the former stack pointer.
230
231
232
233
234
235
 * @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.
 * @param align  force stack alignment to this power of 2. (ie. specifying 3
 *               results in a 2^3 = 8byte stack alignment)
Sebastian Hack's avatar
Sebastian Hack committed
236
 * @return       A new stack pointer increment/decrement node.
237
238
 * @note         This node sets a register constraint to the @p sp register on
 *               its output.
Sebastian Hack's avatar
Sebastian Hack committed
239
 */
240
ir_node *be_new_IncSP(const arch_register_t *sp, ir_node *block,
241
                      ir_node *old_sp, int offset, int align);
Sebastian Hack's avatar
Sebastian Hack committed
242

Michael Beck's avatar
BugFix:    
Michael Beck committed
243
244
/** 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
245

246
/** Sets the previous node that computes the stack pointer. */
247
void     be_set_IncSP_pred(ir_node *incsp, ir_node *pred);
248

249
250
251
252
253
254
255
/**
 * 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
256
257

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

261
/** Gets the call entity or NULL if this is no static call. */
262
ir_entity  *be_Call_get_entity(const ir_node *call);
263
/** Sets the call entity. */
264
void     be_Call_set_entity(ir_node *call, ir_entity *ent);
265
266
267
268
/** 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);
269

Matthias Braun's avatar
Matthias Braun committed
270
271
272
273
void     be_Call_set_pop(ir_node *call, unsigned pop);

unsigned be_Call_get_pop(const ir_node *call);

274
275
276
/**
 * Position numbers for the be_Call inputs.
 */
277
enum {
278
279
280
281
	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 */
282
283
};

284
285
286
287
/**
 * Projection numbers for result of be_Call node: use for Proj nodes!
 */
typedef enum {
288
	pn_be_Call_M_regular = pn_Call_M,    /**< The memory result of a be_Call. */
Matthias Braun's avatar
Matthias Braun committed
289
	pn_be_Call_sp        = pn_Call_max,
290
291
	pn_be_Call_first_res                 /**< The first result proj number of a
	                                          be_Call. */
292
293
294
} pn_be_Call;

/**
Michael Beck's avatar
Michael Beck committed
295
296
297
298
 * Construct a new be_Call.
 *
 * @param dbg      debug info
 * @param irg      the graph where the call is placed
299
 * @param block    the block where the call is placed
Michael Beck's avatar
Michael Beck committed
300
301
 * @param mem      the memory input of the call
 * @param sp       the stack pointer input of the call
302
303
 * @param ptr      the address of the called function, if immediate call set
 *                 to sp
Michael Beck's avatar
Michael Beck committed
304
305
306
307
 * @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
308
 */
309
310
311
ir_node *be_new_Call(dbg_info *dbg, ir_graph *irg, ir_node *block, ir_node *mem,
                     ir_node *sp, ir_node *ptr, int n_outs,
                     int n, ir_node *in[], ir_type *call_tp);
312
313

/**
314
315
316
 * Position numbers for the be_Return inputs.
 */
enum {
317
318
319
	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 */
320
321
322
323
};

/**
 * Construct a new be_Return.
Michael Beck's avatar
Michael Beck committed
324
325
 *
 * @param dbg    debug info
326
 * @param irg    the graph where the new node will be placed
327
 * @param block  the block where the new node will be placed
328
 * @param n_res  number of "real" results
329
 * @param pop    pop number of bytes on return
330
 * @param n      number of inputs
331
332
 * @param in     input array
 */
333
334
ir_node *be_new_Return(dbg_info *dbg, ir_graph *irg, ir_node *block, int n_res,
                       unsigned pop, int n, ir_node *in[]);
335
336

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

Michael Beck's avatar
Michael Beck committed
339
/**
340
341
 * Return the number of bytes that should be popped from stack when executing
 * the Return.
Michael Beck's avatar
Michael Beck committed
342
343
344
 *
 * @param ret  the be_Return node
 */
345
unsigned be_Return_get_pop(const ir_node *ret);
346

347
348
349
350
351
352
353
354
355
356
357
358
359
360
/**
 * 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);

361
362
363
/** appends a node to the return node, returns the position of the node */
int be_Return_append_node(ir_node *ret, ir_node *node);

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

Sebastian Hack's avatar
Sebastian Hack committed
366
/**
367
 * Make a spill node.
Sebastian Hack's avatar
Sebastian Hack committed
368
369
 *
 * @param irn       The node to be spilled.
370
 * @param block     the block where the spill should be placed
Sebastian Hack's avatar
Sebastian Hack committed
371
372
 * @return          The new spill node.
 */
373
ir_node *be_spill(ir_node *block, ir_node *irn);
Sebastian Hack's avatar
Sebastian Hack committed
374
375
376
377
378

/**
 * Make a reload and insert it into the schedule.
 *
 * @param cls      The register class of the reloaded value.
379
380
 * @param insert   The node in the schedule in front of which the reload is
 *                 inserted.
Sebastian Hack's avatar
Sebastian Hack committed
381
382
383
384
 * @param mode     The mode of the original (spilled) value.
 * @param spill    The spill node corresponding to this reload.
 * @return         A freshly made reload.
 */
385
386
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
387

Sebastian Hack's avatar
Sebastian Hack committed
388
enum {
389
	n_be_CopyKeep_op = 0
Sebastian Hack's avatar
Sebastian Hack committed
390
};
391
392
393
394
395
396
397
398
ir_node *be_new_CopyKeep(const arch_register_class_t *cls, ir_node *block,
                         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 *block, ir_node *src, ir_node *keep,
                                ir_mode *mode);

399
ir_node *be_get_CopyKeep_op(const ir_node *cpy);
Sebastian Hack's avatar
Sebastian Hack committed
400

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

403
/**
Michael Beck's avatar
Michael Beck committed
404
 * Returns the frame entity of a be node.
405
 * Try to avoid this function and better call arch_get_frame_entity!
406
 *
Michael Beck's avatar
Michael Beck committed
407
 * @return the frame entity used by the be node
408
 */
409
410
ir_entity *be_get_frame_entity(const ir_node *irn);

411
412
void be_node_set_frame_entity(ir_node *node, ir_entity *entity);

413
414
415
416
/**
 * Returns the frame offset of this node.
 */
int be_get_frame_offset(const ir_node *irn);
417
418

ir_node* be_get_Reload_mem(const ir_node *irn);
419
ir_node *be_get_Reload_frame(const ir_node *irn);
420
ir_node* be_get_Spill_val(const ir_node *irn);
421
ir_node *be_get_Spill_frame(const ir_node *irn);
422

423
424
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
425

426
427
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);
428

429
430
int be_get_MemPerm_entity_arity(const ir_node *irn);

Sebastian Hack's avatar
Sebastian Hack committed
431
432
433
/**
 * Impose a register constraint on a backend node.
 * @param irn The node.
434
 * @param pos The position of the argument.
435
436
 * @param reg The register which is admissible for that node, argument/result
 *            and position.
Sebastian Hack's avatar
Sebastian Hack committed
437
 */
438
439
440
441
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);
442

443
444
445
const arch_register_req_t *be_create_reg_req(struct obstack *obst,
		const arch_register_t *reg, arch_register_req_type_t additional_types);

446
/**
447
 * Impose register constraints on a backend node.
448
449
450
 * 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.
451
452
453
 * @param irn The backend node.
 * @param pos The position (@see be_set_constr_single_reg()).
 * @param req The register requirements which shall be transferred.
454
 */
455
456
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);
457

Sebastian Hack's avatar
Sebastian Hack committed
458
459
460
/**
 * Set the register class of a node.
 * @param irn The node itself.
461
 * @param pos The position (0..n) for arguments
Sebastian Hack's avatar
Sebastian Hack committed
462
463
 * @param flags The register class to set for that node and position.
 */
464
465
466
467
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
468

469
470
471
/**
 * Set the register requirements for a phi node.
 */
472
473
void be_set_phi_reg_req(ir_node *phi, const arch_register_req_t *req);

474
void be_dump_phi_reg_reqs(FILE *out, ir_node *node, dump_reason_t reason);
475

476
477
478
479
480
481
/**
 * 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);

482
483
484
485
486
487
488
489
490
491
492
493
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    ; }
494
static inline int be_is_Start    (const ir_node *irn) { return get_irn_opcode(irn) == beo_Start; }
495
static inline int be_is_FrameAddr(const ir_node *irn) { return get_irn_opcode(irn) == beo_FrameAddr; }
496

497
#endif