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"
39 #define BE_OUT_POS(p) (-((p) + 1))
42 * The benode op's. Must be available to register emitter function.
44 extern ir_op *op_be_Spill;
45 extern ir_op *op_be_Reload;
46 extern ir_op *op_be_Perm;
47 extern ir_op *op_be_MemPerm;
48 extern ir_op *op_be_Copy;
49 extern ir_op *op_be_Keep;
50 extern ir_op *op_be_CopyKeep;
51 extern ir_op *op_be_Call;
52 extern ir_op *op_be_Return;
53 extern ir_op *op_be_IncSP;
54 extern ir_op *op_be_AddSP;
55 extern ir_op *op_be_SubSP;
56 extern ir_op *op_be_RegParams;
57 extern ir_op *op_be_FrameAddr;
58 extern ir_op *op_be_Barrier;
59 extern ir_op *op_be_Unwind;
63 be_frame_flag_spill = 1,
64 be_frame_flag_local = 2,
69 * A "symbolic constant" for the size of the stack frame to use with IncSP nodes.
70 * It gets back-patched to the real size as soon it is known.
72 #define BE_STACK_FRAME_SIZE_EXPAND INT_MAX
73 #define BE_STACK_FRAME_SIZE_SHRINK INT_MIN
76 * Determines if irn is a be_node.
78 int is_be_node(const ir_node *irn);
81 * Create all BE specific opcodes.
83 void be_node_init(void);
86 * Position numbers for the be_Spill inputs.
89 be_pos_Spill_frame = 0,
94 * Make a new Spill node.
96 ir_node *be_new_Spill(const arch_register_class_t *cls, const arch_register_class_t *cls_frame,
97 ir_graph *irg, ir_node *bl, ir_node *frame, ir_node *to_spill);
100 * Position numbers for the be_Reload inputs.
103 be_pos_Reload_frame = 0,
104 be_pos_Reload_mem = 1
108 * Make a new Reload node.
110 ir_node *be_new_Reload(const arch_register_class_t *cls, const arch_register_class_t *cls_frame,
111 ir_graph *irg, ir_node *bl, ir_node *frame, ir_node *mem, ir_mode *mode);
114 * Position numbers for the be_Copy inputs.
121 * Make a new Copy node.
123 ir_node *be_new_Copy(const arch_register_class_t *cls, ir_graph *irg, ir_node *block, ir_node *in);
124 /** Returns the Copy Argument. */
125 ir_node *be_get_Copy_op(const ir_node *cpy);
126 /** Sets the Copy Argument. */
127 void be_set_Copy_op(ir_node *cpy, ir_node *op);
130 * Make a new Perm node.
132 ir_node *be_new_Perm(const arch_register_class_t *cls, ir_graph *irg, ir_node *bl, int arity, ir_node *in[]);
136 * Basically, we provide a map to remap the Perm's arguments. If an entry in the
137 * map is -1, the argument gets deleted.
138 * This function takes care, that the register data and the input array reflects
139 * the changes described by the map.
140 * This is needed by the Perm optimization/movement in belower.c, see push_through_perm().
141 * @param perm The perm node.
142 * @param new_size The new number of arguments (must be smaller or equal to the current one).
143 * @param map A map assigning each operand a new index (or -1 to indicate deletion).
145 void be_Perm_reduce(ir_node *perm, int new_size, int *map);
148 * Create a new MemPerm node.
150 ir_node *be_new_MemPerm(const arch_env_t *arch_env, ir_graph *irg, ir_node *bl, int n, ir_node *in[]);
151 ir_node *be_new_Keep(const arch_register_class_t *cls, ir_graph *irg, ir_node *bl, int arity, ir_node *in[]);
153 void be_Keep_add_node(ir_node *keep, const arch_register_class_t *cls, ir_node *node);
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, ir_graph *irg, ir_node *bl, ir_node *frame, ir_entity *ent);
165 /** Return the frame input of a FrameAddr node. */
166 ir_node *be_get_FrameAddr_frame(const ir_node *node);
168 ir_entity *be_get_FrameAddr_entity(const ir_node *node);
171 * Position numbers for the be_AddSP inputs
174 be_pos_AddSP_old_sp = 0,
175 be_pos_AddSP_size = 1,
176 be_pos_AddSP_last = 2
187 * Make a new AddSP node.
188 * An AddSP node expresses an increase of the stack pointer in the direction the stack
189 * grows. In contrast to IncSP, the amount of bytes the stack pointer is grown, is not
190 * given by a constant but an ordinary Firm node.
191 * @param sp The stack pointer register.
192 * @param irg The graph.
193 * @param bl The block.
194 * @param old_sp The node representing the old stack pointer value.
195 * @param sz The node expressing the size by which the stack pointer shall be grown.
196 * @return A new AddSP node.
198 ir_node *be_new_AddSP(const arch_register_t *sp, ir_graph *irg, ir_node *bl, ir_node *old_sp, ir_node *sz);
201 * Position numbers for the be_SubSP inputs
204 be_pos_SubSP_old_sp = 0,
205 be_pos_SubSP_size = 1,
206 be_pos_SubSP_last = 2
216 * Make a new SubSP node.
217 * A SubSP node expresses a decrease of the stack pointer in the direction the stack
218 * grows. In contrast to IncSP, the amount of bytes the stack pointer is grown, is not
219 * given by a constant but an ordinary Firm node.
220 * @param sp The stack pointer register.
221 * @param irg The graph.
222 * @param bl The block.
223 * @param old_sp The node representing the old stack pointer value.
224 * @param sz The node expressing the size by which the stack pointer shall be grown.
225 * @return A new DecSP node.
227 ir_node *be_new_SubSP(const arch_register_t *sp, ir_graph *irg, ir_node *bl, ir_node *old_sp, ir_node *sz);
230 * Make a stack pointer increase/decrease node.
231 * @param sp The stack pointer register.
232 * @param irg The graph to insert the node to.
233 * @param bl The block to insert the node into.
234 * @param old_sp The node defining the former stack pointer.
235 * @param amount The mount of bytes the stack shall be expanded/shrinked (see set_IncSP_offset)
236 * @param dir The direction in which the stack pointer shall be modified:
237 * Along the stack's growing direction or against.
238 * @return A new stack pointer increment/decrement node.
239 * @note This node sets a register constraint to the @p sp register on its output.
241 ir_node *be_new_IncSP(const arch_register_t *sp, ir_graph *irg, ir_node *bl,
242 ir_node *old_sp, int offset, int align);
244 /** Returns the previous node that computes the stack pointer. */
245 ir_node *be_get_IncSP_pred(ir_node *incsp);
247 /** Sets the previous node that computes the stack pointer. */
248 void be_set_IncSP_pred(ir_node *incsp, ir_node *pred);
251 * Sets a new offset to a IncSP node.
252 * A positive offset means expanding the stack, a negative offset shrinking
253 * an offset is == BE_STACK_FRAME_SIZE will be replaced by the real size of the
254 * stackframe in the fix_stack_offsets phase.
256 void be_set_IncSP_offset(ir_node *irn, int offset);
258 /** Gets the offset from a IncSP node. */
259 int be_get_IncSP_offset(const ir_node *irn);
260 int be_get_IncSP_align(const ir_node *irn);
262 /** Gets the call entity or NULL if this is no static call. */
263 ir_entity *be_Call_get_entity(const ir_node *call);
264 /** Sets the call entity. */
265 void be_Call_set_entity(ir_node *call, ir_entity *ent);
266 /** Gets the call type. */
267 ir_type *be_Call_get_type(ir_node *call);
268 /** Sets the call type. */
269 void be_Call_set_type(ir_node *call, ir_type *call_tp);
271 void be_Call_set_pop(ir_node *call, unsigned pop);
273 unsigned be_Call_get_pop(const ir_node *call);
276 * Position numbers for the be_Call inputs.
279 be_pos_Call_mem = 0, /**< memory input of a be_Call node */
280 be_pos_Call_sp = 1, /**< stack pointer input of a be_Call node */
281 be_pos_Call_ptr = 2, /**< call pointer input of a be_Call node */
282 be_pos_Call_first_arg = 3 /**< first argument input of a be_Call node */
286 * Projection numbers for result of be_Call node: use for Proj nodes!
289 pn_be_Call_M_regular = pn_Call_M_regular, /**< The memory result of a be_Call. */
290 pn_be_Call_sp = pn_Call_max,
291 pn_be_Call_first_res /**< The first result proj number of a be_Call. */
295 * Construct a new be_Call.
297 * @param dbg debug info
298 * @param irg the graph where the call is placed
299 * @param bl the block where the call is placed
300 * @param mem the memory input of the call
301 * @param sp the stack pointer input of the call
302 * @param ptr the address of the called function, if immediate call set to sp
303 * @param n_outs the number of outcoming values from this call
304 * @param n the number of (register) inputs of this call
305 * @param in the (register) inputs of this call
306 * @param call_tp the call type of this call
308 ir_node *be_new_Call(dbg_info *dbg, ir_graph *irg, ir_node *bl, ir_node *mem, ir_node *sp, ir_node *ptr,
309 int n_outs, int n, ir_node *in[], ir_type *call_tp);
312 * Position numbers for the be_Return inputs.
315 be_pos_Return_mem = 0, /**< memory input of a be_Return node */
316 be_pos_Return_sp = 1, /**< stack pointer input of a be_Return node */
317 be_pos_Return_val = 2, /**< first "real" return value if any */
321 * Construct a new be_Return.
323 * @param dbg debug info
324 * @param irg the graph where the new node will be placed
325 * @param bl the block where the new node will be placed
326 * @param n_res number of "real" results
327 * @param n number of inputs
328 * @param pop pop number of bytes on return
329 * @param in input array
331 ir_node *be_new_Return(dbg_info *dbg, ir_graph *irg, ir_node *bl, int n_res, unsigned pop, int n, ir_node *in[]);
333 /** Returns the number of real returns values */
334 int be_Return_get_n_rets(const ir_node *ret);
337 * Return the number of bytes that should be popped from stack when executing the Return.
339 * @param ret the be_Return node
341 unsigned be_Return_get_pop(const ir_node *ret);
344 * Return non-zero, if number of popped bytes must be always emitted.
346 * @param ret the be_Return node
348 int be_Return_get_emit_pop(const ir_node *ret);
351 * Set the emit_pop flag.
353 * @param ret the be_Return node
355 void be_Return_set_emit_pop(ir_node *ret, int emit_pop);
357 /** appends a node to the return node, returns the position of the node */
358 int be_Return_append_node(ir_node *ret, ir_node *node);
360 ir_node *be_new_RegParams(ir_graph *irg, ir_node *bl, int n_out);
362 ir_node *be_new_Barrier(ir_graph *irg, ir_node *bl, int n, ir_node *in[]);
365 * Appends a node to a barrier, returns the result proj of the node
367 ir_node *be_Barrier_append_node(ir_node *barrier, ir_node *node);
370 * Appends a register out requirement to a RegParams node
372 * @returns the proj node for the new register
374 ir_node *be_RegParams_append_out_reg(ir_node *regparams,
375 const arch_env_t *arch_env,
376 const arch_register_t *reg);
381 * @param arch_env The architecture environment.
382 * @param irn The node to be spilled.
383 * @param spill_ctx The context in which the spill is introduced (This is mostly == irn up to the case of Phis).
384 * @return The new spill node.
386 ir_node *be_spill(const arch_env_t *arch_env, ir_node *block, ir_node *irn);
389 * Make a reload and insert it into the schedule.
391 * @param arch_env The architecture environment.
392 * @param cls The register class of the reloaded value.
393 * @param insert The node in the schedule in front of which the reload is inserted.
394 * @param mode The mode of the original (spilled) value.
395 * @param spill The spill node corresponding to this reload.
396 * @return A freshly made reload.
398 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);
401 be_pos_CopyKeep_op = 0
403 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);
404 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);
405 ir_node *be_get_CopyKeep_op(const ir_node *cpy);
406 void be_set_CopyKeep_op(ir_node *cpy, ir_node *op);
409 * Position numbers for the be_Unwind inputs.
412 be_pos_Unwind_mem = 0, /**< memory input of a be_Unwind node */
413 be_pos_Unwind_sp = 1, /**< stack pointer input of a be_Unwind node */
417 * Construct a new be_Unwind.
419 * @param dbg debug info
420 * @param irg the graph where the new node will be placed
421 * @param bl the block where the new node will be placed
422 * @param mem the memory input
423 * @param sp the stack pointer input
425 ir_node *be_new_Unwind(dbg_info *dbg, ir_graph *irg, ir_node *bl, ir_node *mem, ir_node *sp);
427 ir_node *be_get_Unwind_mem(const ir_node *irn);
428 ir_node *be_get_Unwind_sp(const ir_node *irn);
431 * Get the backend opcode of a backend node.
432 * @param irn The node.
433 * @return The backend opcode.
435 #define be_get_irn_opcode(irn) get_irn_opcode(irn)
438 * Returns the frame entity of a be node.
439 * Try to avoid this function and better call arch_get_frame_entity!
441 * @return the frame entity used by the be node
443 ir_entity *be_get_frame_entity(const ir_node *irn);
446 * Returns the frame offset of this node.
448 int be_get_frame_offset(const ir_node *irn);
450 ir_node* be_get_Reload_mem(const ir_node *irn);
451 ir_node *be_get_Reload_frame(const ir_node *irn);
452 ir_node* be_get_Spill_val(const ir_node *irn);
453 ir_node *be_get_Spill_frame(const ir_node *irn);
455 void be_set_MemPerm_in_entity(const ir_node *irn, int n, ir_entity* ent);
456 ir_entity *be_get_MemPerm_in_entity(const ir_node *irn, int n);
458 void be_set_MemPerm_out_entity(const ir_node *irn, int n, ir_entity* ent);
459 ir_entity *be_get_MemPerm_out_entity(const ir_node *irn, int n);
461 int be_get_MemPerm_entity_arity(const ir_node *irn);
464 * Impose a register constraint on a backend node.
465 * @param irn The node.
466 * @param pos The position of the argument/result. Results range from -1..-m and arguments form 0..n
467 * @param reg The register which is admissible for that node, argument/result and position.
469 void be_set_constr_single_reg(ir_node *irn, int pos, const arch_register_t *reg);
472 * Impose register constraints on a backend node.
473 * The register subsets given by the limited function in @p req are copied to the backend node.
474 * This requires that the constraint type of the @p req is arch_register_req_type_limited.
475 * @param irn The backend node.
476 * @param pos The position (@see be_set_constr_single_reg()).
477 * @param req The register requirements which shall be transferred.
479 void be_set_constr_limited(ir_node *irn, int pos, const arch_register_req_t *req);
482 * Set the flags of a node.
483 * @param irn The node itself.
484 * @param pos The position (0..n) for arguments, (-1..-m) for results.
485 * @param flags The flags to set for that node and position.
487 void be_node_set_flags(ir_node *irn, int pos, arch_irn_flags_t flags);
489 void be_node_add_flags(ir_node *irn, int pos, arch_irn_flags_t flags);
492 * Set the register class of a node.
493 * @param irn The node itself.
494 * @param pos The position (0..n) for arguments, (-1..-m) for results.
495 * @param flags The register class to set for that node and position.
497 void be_node_set_reg_class(ir_node *irn, int pos, const arch_register_class_t *cls);
500 * Set the register requirement type of a node.
501 * @param irn The node itself.
502 * @param pos The position (0..n) for arguments, (-1..-m) for results.
503 * @param flags The register requirement type to set for that node and position.
505 void be_node_set_req_type(ir_node *irn, int pos, arch_register_req_type_t type);
508 * Initialize the Phi handler.
509 * @param env The be_main environment.
511 void be_phi_handler_new(be_main_env_t *env);
514 * Destroy the Phi handler.
516 void be_phi_handler_free(void);
519 * Reset the register data in the Phi handler.
520 * This should be called on each new graph and deletes the register information of the current graph.
522 void be_phi_handler_reset(void);
525 * Set the register requirements for a phi node.
527 void be_set_phi_reg_req(const arch_env_t *arch_env, ir_node *phi,
528 const arch_register_req_t *req);
531 * Set flags for a phi node
533 void be_set_phi_flags(const arch_env_t *arch_env, ir_node *phi,
534 arch_irn_flags_t flags);
537 * irn handler for common be nodes and Phi's.
539 const void *be_node_get_irn_ops(const ir_node *irn);
541 static INLINE int be_is_Spill (const ir_node *irn) { return get_irn_opcode(irn) == beo_Spill ; }
542 static INLINE int be_is_Reload (const ir_node *irn) { return get_irn_opcode(irn) == beo_Reload ; }
543 static INLINE int be_is_Copy (const ir_node *irn) { return get_irn_opcode(irn) == beo_Copy ; }
544 static INLINE int be_is_CopyKeep (const ir_node *irn) { return get_irn_opcode(irn) == beo_CopyKeep ; }
545 static INLINE int be_is_Perm (const ir_node *irn) { return get_irn_opcode(irn) == beo_Perm ; }
546 static INLINE int be_is_MemPerm (const ir_node *irn) { return get_irn_opcode(irn) == beo_MemPerm ; }
547 static INLINE int be_is_Keep (const ir_node *irn) { return get_irn_opcode(irn) == beo_Keep ; }
548 static INLINE int be_is_Call (const ir_node *irn) { return get_irn_opcode(irn) == beo_Call ; }
549 static INLINE int be_is_Return (const ir_node *irn) { return get_irn_opcode(irn) == beo_Return ; }
550 static INLINE int be_is_IncSP (const ir_node *irn) { return get_irn_opcode(irn) == beo_IncSP ; }
551 static INLINE int be_is_AddSP (const ir_node *irn) { return get_irn_opcode(irn) == beo_AddSP ; }
552 static INLINE int be_is_SubSP (const ir_node *irn) { return get_irn_opcode(irn) == beo_SubSP ; }
553 static INLINE int be_is_RegParams(const ir_node *irn) { return get_irn_opcode(irn) == beo_RegParams; }
554 static INLINE int be_is_FrameAddr(const ir_node *irn) { return get_irn_opcode(irn) == beo_FrameAddr; }
555 static INLINE int be_is_Barrier (const ir_node *irn) { return get_irn_opcode(irn) == beo_Barrier ; }
556 static INLINE int be_is_Unwind (const ir_node *irn) { return get_irn_opcode(irn) == beo_Unwind ; }
558 #endif /* FIRM_BE_BENODE_T_H */