2 * Copyright (C) 1995-2008 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
6 * This file may be distributed and/or modified under the terms of the
7 * GNU General Public License version 2 as published by the Free Software
8 * Foundation and appearing in the file LICENSE.GPL included in the
9 * packaging of this file.
11 * Licensees holding valid libFirm Professional Edition licenses may use
12 * this file in accordance with the libFirm Commercial License.
13 * Agreement provided with the Software.
15 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * @brief Backend node support for generic backend nodes.
23 * @author Sebastian Hack
27 * Backend node support for generic backend nodes.
28 * This file provides Perm, Copy, Spill and Reload nodes.
30 #ifndef FIRM_BE_BENODE_T_H
31 #define FIRM_BE_BENODE_T_H
35 #include "firm_types.h"
40 * The benode op's. Must be available to register emitter function.
42 extern ir_op *op_be_Spill;
43 extern ir_op *op_be_Reload;
44 extern ir_op *op_be_Perm;
45 extern ir_op *op_be_MemPerm;
46 extern ir_op *op_be_Copy;
47 extern ir_op *op_be_Keep;
48 extern ir_op *op_be_CopyKeep;
49 extern ir_op *op_be_Call;
50 extern ir_op *op_be_Return;
51 extern ir_op *op_be_IncSP;
52 extern ir_op *op_be_AddSP;
53 extern ir_op *op_be_SubSP;
54 extern ir_op *op_be_Start;
55 extern ir_op *op_be_FrameAddr;
58 * A "symbolic constant" for the size of the stack frame to use with IncSP nodes.
59 * It gets back-patched to the real size as soon it is known.
61 #define BE_STACK_FRAME_SIZE_EXPAND INT_MAX
62 #define BE_STACK_FRAME_SIZE_SHRINK INT_MIN
65 * Determines if irn is a be_node.
67 int is_be_node(const ir_node *irn);
70 * Create all BE specific opcodes.
72 void be_init_op(void);
75 * Position numbers for the be_Spill inputs.
78 be_pos_Spill_frame = 0,
83 * Make a new Spill node.
85 ir_node *be_new_Spill(const arch_register_class_t *cls,
86 const arch_register_class_t *cls_frame, ir_node *block,
87 ir_node *frame, ir_node *to_spill);
90 * Position numbers for the be_Reload inputs.
93 be_pos_Reload_frame = 0,
98 * Make a new Reload node.
100 ir_node *be_new_Reload(const arch_register_class_t *cls,
101 const arch_register_class_t *cls_frame, ir_node *block,
102 ir_node *frame, ir_node *mem, ir_mode *mode);
105 * Position numbers for the be_Copy inputs.
112 * Make a new Copy node.
114 ir_node *be_new_Copy(const arch_register_class_t *cls, ir_node *block,
116 /** Returns the Copy Argument. */
117 ir_node *be_get_Copy_op(const ir_node *cpy);
118 /** Sets the Copy Argument. */
119 void be_set_Copy_op(ir_node *cpy, ir_node *op);
122 * Make a new Perm node.
124 ir_node *be_new_Perm(const arch_register_class_t *cls, ir_node *block,
125 int n, ir_node *in[]);
129 * Basically, we provide a map to remap the Perm's arguments. If an entry in the
130 * map is -1, the argument gets deleted.
131 * This function takes care, that the register data and the input array reflects
132 * the changes described by the map.
133 * This is needed by the Perm optimization/movement in belower.c, see
134 * push_through_perm().
135 * @param perm The perm node.
136 * @param new_size The new number of arguments (must be smaller or equal to the
138 * @param map A map assigning each operand a new index (or -1 to indicate
141 void be_Perm_reduce(ir_node *perm, int new_size, int *map);
144 * Create a new MemPerm node.
145 * A MemPerm node exchanges the values of memory locations. (Typically entities
146 * used as spillslots). MemPerm nodes perform this operation without modifying
147 * any register values.
149 ir_node *be_new_MemPerm(ir_node *block, int n, ir_node *in[]);
150 ir_node *be_new_Keep(ir_node *block, int arity, ir_node *in[]);
152 void be_Keep_add_node(ir_node *keep, const arch_register_class_t *cls,
156 * Position numbers for the be_FrameAddr inputs
159 be_pos_FrameAddr_ptr = 0
162 /** Create a new FrameAddr node. */
163 ir_node *be_new_FrameAddr(const arch_register_class_t *cls_frame,
164 ir_node *block, ir_node *frame, ir_entity *ent);
166 /** Return the frame input of a FrameAddr node. */
167 ir_node *be_get_FrameAddr_frame(const ir_node *node);
169 ir_entity *be_get_FrameAddr_entity(const ir_node *node);
172 * Position numbers for the be_AddSP inputs
175 be_pos_AddSP_old_sp = 0,
176 be_pos_AddSP_size = 1,
177 be_pos_AddSP_last = 2
188 * Make a new AddSP node.
189 * An AddSP node expresses an increase of the stack pointer in the direction
190 * the stack grows. In contrast to IncSP, the amount of bytes the stack pointer
191 * is grown, is not given by a constant but an ordinary Firm node.
192 * @param sp The stack pointer register.
193 * @param block The block.
194 * @param old_sp The node representing the old stack pointer value.
195 * @param size The node expressing the size by which the stack pointer shall
197 * @return A new AddSP node.
199 ir_node *be_new_AddSP(const arch_register_t *sp, ir_node *block,
200 ir_node *old_sp, ir_node *size);
203 * Position numbers for the be_SubSP inputs
206 be_pos_SubSP_old_sp = 0,
207 be_pos_SubSP_size = 1,
208 be_pos_SubSP_last = 2
218 * Make a new SubSP node.
219 * A SubSP node expresses a decrease of the stack pointer in the direction the
220 * stack grows. In contrast to IncSP, the amount of bytes the stack pointer is
221 * grown, is not given by a constant but an ordinary Firm node.
222 * @param sp The stack pointer register.
223 * @param block The block.
224 * @param old_sp The node representing the old stack pointer value.
225 * @param size The node expressing the size by which the stack pointer shall
227 * @return A new DecSP node.
229 ir_node *be_new_SubSP(const arch_register_t *sp, ir_node *block,
230 ir_node *old_sp, ir_node *size);
233 * Make a stack pointer increase/decrease node.
234 * @param sp The stack pointer register.
235 * @param block The block to insert the node into.
236 * @param old_sp The node defining the former stack pointer.
237 * @param offset amount the stack should expand (positive offset) or shrink
238 * (negative offset). Note that the offset is independent of the
239 * natural stack direction of the architecture but just specifies
240 * abstract expanding/shrinking of the stack area.
241 * @param align force stack alignment to this power of 2. (ie. specifying 3
242 * results in a 2^3 = 8byte stack alignment)
243 * @return A new stack pointer increment/decrement node.
244 * @note This node sets a register constraint to the @p sp register on
247 ir_node *be_new_IncSP(const arch_register_t *sp, ir_node *block,
248 ir_node *old_sp, int offset, int align);
250 /** Returns the previous node that computes the stack pointer. */
251 ir_node *be_get_IncSP_pred(ir_node *incsp);
253 /** Sets the previous node that computes the stack pointer. */
254 void be_set_IncSP_pred(ir_node *incsp, ir_node *pred);
257 * Sets a new offset to a IncSP node.
258 * A positive offset means expanding the stack, a negative offset shrinking
259 * an offset is == BE_STACK_FRAME_SIZE will be replaced by the real size of the
260 * stackframe in the fix_stack_offsets phase.
262 void be_set_IncSP_offset(ir_node *irn, int offset);
264 /** Gets the offset from a IncSP node. */
265 int be_get_IncSP_offset(const ir_node *irn);
266 int be_get_IncSP_align(const ir_node *irn);
268 /** Gets the call entity or NULL if this is no static call. */
269 ir_entity *be_Call_get_entity(const ir_node *call);
270 /** Sets the call entity. */
271 void be_Call_set_entity(ir_node *call, ir_entity *ent);
272 /** Gets the call type. */
273 ir_type *be_Call_get_type(ir_node *call);
274 /** Sets the call type. */
275 void be_Call_set_type(ir_node *call, ir_type *call_tp);
277 void be_Call_set_pop(ir_node *call, unsigned pop);
279 unsigned be_Call_get_pop(const ir_node *call);
282 * Position numbers for the be_Call inputs.
285 be_pos_Call_mem = 0, /**< memory input of a be_Call node */
286 be_pos_Call_sp = 1, /**< stack pointer input of a be_Call node */
287 be_pos_Call_ptr = 2, /**< call pointer input of a be_Call node */
288 be_pos_Call_first_arg = 3 /**< first argument input of a be_Call node */
292 * Projection numbers for result of be_Call node: use for Proj nodes!
295 pn_be_Call_M_regular = pn_Call_M, /**< The memory result of a be_Call. */
296 pn_be_Call_sp = pn_Call_max,
297 pn_be_Call_first_res /**< The first result proj number of a
302 * Construct a new be_Call.
304 * @param dbg debug info
305 * @param irg the graph where the call is placed
306 * @param block the block where the call is placed
307 * @param mem the memory input of the call
308 * @param sp the stack pointer input of the call
309 * @param ptr the address of the called function, if immediate call set
311 * @param n_outs the number of outcoming values from this call
312 * @param n the number of (register) inputs of this call
313 * @param in the (register) inputs of this call
314 * @param call_tp the call type of this call
316 ir_node *be_new_Call(dbg_info *dbg, ir_graph *irg, ir_node *block, ir_node *mem,
317 ir_node *sp, ir_node *ptr, int n_outs,
318 int n, ir_node *in[], ir_type *call_tp);
321 * Position numbers for the be_Return inputs.
324 be_pos_Return_mem = 0, /**< memory input of a be_Return node */
325 be_pos_Return_sp = 1, /**< stack pointer input of a be_Return node */
326 be_pos_Return_val = 2, /**< first "real" return value if any */
330 * Construct a new be_Return.
332 * @param dbg debug info
333 * @param irg the graph where the new node will be placed
334 * @param block the block where the new node will be placed
335 * @param n_res number of "real" results
336 * @param pop pop number of bytes on return
337 * @param n number of inputs
338 * @param in input array
340 ir_node *be_new_Return(dbg_info *dbg, ir_graph *irg, ir_node *block, int n_res,
341 unsigned pop, int n, ir_node *in[]);
343 /** Returns the number of real returns values */
344 int be_Return_get_n_rets(const ir_node *ret);
347 * Return the number of bytes that should be popped from stack when executing
350 * @param ret the be_Return node
352 unsigned be_Return_get_pop(const ir_node *ret);
355 * Return non-zero, if number of popped bytes must be always emitted.
357 * @param ret the be_Return node
359 int be_Return_get_emit_pop(const ir_node *ret);
362 * Set the emit_pop flag.
364 * @param ret the be_Return node
366 void be_Return_set_emit_pop(ir_node *ret, int emit_pop);
368 /** appends a node to the return node, returns the position of the node */
369 int be_Return_append_node(ir_node *ret, ir_node *node);
371 ir_node *be_new_Start(dbg_info *dbgi, ir_node *block, int n_out);
376 * @param irn The node to be spilled.
377 * @param block the block where the spill should be placed
378 * @return The new spill node.
380 ir_node *be_spill(ir_node *block, ir_node *irn);
383 * Make a reload and insert it into the schedule.
385 * @param cls The register class of the reloaded value.
386 * @param insert The node in the schedule in front of which the reload is
388 * @param mode The mode of the original (spilled) value.
389 * @param spill The spill node corresponding to this reload.
390 * @return A freshly made reload.
392 ir_node *be_reload(const arch_register_class_t *cls, ir_node *insert,
393 ir_mode *mode, ir_node *spill);
396 be_pos_CopyKeep_op = 0
398 ir_node *be_new_CopyKeep(const arch_register_class_t *cls, ir_node *block,
399 ir_node *src, int n, ir_node *in_keep[],
402 ir_node *be_new_CopyKeep_single(const arch_register_class_t *cls,
403 ir_node *block, ir_node *src, ir_node *keep,
406 ir_node *be_get_CopyKeep_op(const ir_node *cpy);
408 void be_set_CopyKeep_op(ir_node *cpy, ir_node *op);
411 * Returns the frame entity of a be node.
412 * Try to avoid this function and better call arch_get_frame_entity!
414 * @return the frame entity used by the be node
416 ir_entity *be_get_frame_entity(const ir_node *irn);
418 void be_node_set_frame_entity(ir_node *node, ir_entity *entity);
421 * Returns the frame offset of this node.
423 int be_get_frame_offset(const ir_node *irn);
425 ir_node* be_get_Reload_mem(const ir_node *irn);
426 ir_node *be_get_Reload_frame(const ir_node *irn);
427 ir_node* be_get_Spill_val(const ir_node *irn);
428 ir_node *be_get_Spill_frame(const ir_node *irn);
430 void be_set_MemPerm_in_entity(const ir_node *irn, int n, ir_entity* ent);
431 ir_entity *be_get_MemPerm_in_entity(const ir_node *irn, int n);
433 void be_set_MemPerm_out_entity(const ir_node *irn, int n, ir_entity* ent);
434 ir_entity *be_get_MemPerm_out_entity(const ir_node *irn, int n);
436 int be_get_MemPerm_entity_arity(const ir_node *irn);
439 * Impose a register constraint on a backend node.
440 * @param irn The node.
441 * @param pos The position of the argument.
442 * @param reg The register which is admissible for that node, argument/result
445 void be_set_constr_single_reg_in(ir_node *irn, int pos,
446 const arch_register_t *reg, arch_register_req_type_t additional_flags);
447 void be_set_constr_single_reg_out(ir_node *irn, int pos,
448 const arch_register_t *reg, arch_register_req_type_t additional_flags);
450 const arch_register_req_t *be_create_reg_req(struct obstack *obst,
451 const arch_register_t *reg, arch_register_req_type_t additional_types);
454 * Impose register constraints on a backend node.
455 * The register subsets given by the limited function in @p req are copied to
456 * the backend node. This requires that the constraint type of the @p req is
457 * arch_register_req_type_limited.
458 * @param irn The backend node.
459 * @param pos The position (@see be_set_constr_single_reg()).
460 * @param req The register requirements which shall be transferred.
462 void be_set_constr_in(ir_node *irn, int pos, const arch_register_req_t *req);
463 void be_set_constr_out(ir_node *irn, int pos, const arch_register_req_t *req);
466 * Set the register class of a node.
467 * @param irn The node itself.
468 * @param pos The position (0..n) for arguments
469 * @param flags The register class to set for that node and position.
471 void be_node_set_reg_class_in(ir_node *irn, int pos,
472 const arch_register_class_t *cls);
473 void be_node_set_reg_class_out(ir_node *irn, int pos,
474 const arch_register_class_t *cls);
477 * Set the register requirements for a phi node.
479 void be_set_phi_reg_req(ir_node *phi, const arch_register_req_t *req);
481 void be_dump_phi_reg_reqs(FILE *out, ir_node *node, dump_reason_t reason);
484 * Creates a new phi with associated backend informations
486 ir_node *be_new_Phi(ir_node *block, int n_ins, ir_node **ins, ir_mode *mode,
487 const arch_register_class_t *cls);
490 * irn handler for common be nodes and Phi's.
492 const void *be_node_get_irn_ops(const ir_node *irn);
494 static inline int be_is_Spill (const ir_node *irn) { return get_irn_opcode(irn) == beo_Spill ; }
495 static inline int be_is_Reload (const ir_node *irn) { return get_irn_opcode(irn) == beo_Reload ; }
496 static inline int be_is_Copy (const ir_node *irn) { return get_irn_opcode(irn) == beo_Copy ; }
497 static inline int be_is_CopyKeep (const ir_node *irn) { return get_irn_opcode(irn) == beo_CopyKeep ; }
498 static inline int be_is_Perm (const ir_node *irn) { return get_irn_opcode(irn) == beo_Perm ; }
499 static inline int be_is_MemPerm (const ir_node *irn) { return get_irn_opcode(irn) == beo_MemPerm ; }
500 static inline int be_is_Keep (const ir_node *irn) { return get_irn_opcode(irn) == beo_Keep ; }
501 static inline int be_is_Call (const ir_node *irn) { return get_irn_opcode(irn) == beo_Call ; }
502 static inline int be_is_Return (const ir_node *irn) { return get_irn_opcode(irn) == beo_Return ; }
503 static inline int be_is_IncSP (const ir_node *irn) { return get_irn_opcode(irn) == beo_IncSP ; }
504 static inline int be_is_AddSP (const ir_node *irn) { return get_irn_opcode(irn) == beo_AddSP ; }
505 static inline int be_is_SubSP (const ir_node *irn) { return get_irn_opcode(irn) == beo_SubSP ; }
506 static inline int be_is_Start (const ir_node *irn) { return get_irn_opcode(irn) == beo_Start; }
507 static inline int be_is_FrameAddr(const ir_node *irn) { return get_irn_opcode(irn) == beo_FrameAddr; }