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 * Determines if irn is a be_node.
60 int is_be_node(const ir_node *irn);
63 * Create all BE specific opcodes.
65 void be_init_op(void);
68 * Position numbers for the be_Spill inputs.
76 * Make a new Spill node.
78 ir_node *be_new_Spill(const arch_register_class_t *cls,
79 const arch_register_class_t *cls_frame, ir_node *block,
80 ir_node *frame, ir_node *to_spill);
83 * Position numbers for the be_Reload inputs.
86 n_be_Reload_frame = 0,
91 * Make a new Reload node.
93 ir_node *be_new_Reload(const arch_register_class_t *cls,
94 const arch_register_class_t *cls_frame, ir_node *block,
95 ir_node *frame, ir_node *mem, ir_mode *mode);
98 * Position numbers for the be_Copy inputs.
105 * Make a new Copy node.
107 ir_node *be_new_Copy(ir_node *block, ir_node *in);
108 /** Returns the Copy Argument. */
109 ir_node *be_get_Copy_op(const ir_node *cpy);
110 /** Sets the Copy Argument. */
111 void be_set_Copy_op(ir_node *cpy, ir_node *op);
114 * Make a new Perm node.
116 ir_node *be_new_Perm(const arch_register_class_t *cls, ir_node *block,
117 int n, ir_node *in[]);
121 * Basically, we provide a map to remap the Perm's arguments. If an entry in the
122 * map is -1, the argument gets deleted.
123 * This function takes care, that the register data and the input array reflects
124 * the changes described by the map.
125 * This is needed by the Perm optimization/movement in belower.c, see
126 * push_through_perm().
127 * @param perm The perm node.
128 * @param new_size The new number of arguments (must be smaller or equal to the
130 * @param map A map assigning each operand a new index (or -1 to indicate
133 void be_Perm_reduce(ir_node *perm, int new_size, int *map);
136 * Create a new MemPerm node.
137 * A MemPerm node exchanges the values of memory locations. (Typically entities
138 * used as spillslots). MemPerm nodes perform this operation without modifying
139 * any register values.
141 ir_node *be_new_MemPerm(ir_node *block, int n, ir_node *in[]);
142 ir_node *be_new_Keep(ir_node *block, int arity, ir_node *in[]);
144 void be_Keep_add_node(ir_node *keep, const arch_register_class_t *cls,
148 * Position numbers for the be_FrameAddr inputs
151 n_be_FrameAddr_ptr = 0
154 /** Create a new FrameAddr node. */
155 ir_node *be_new_FrameAddr(const arch_register_class_t *cls_frame,
156 ir_node *block, ir_node *frame, ir_entity *ent);
158 /** Return the frame input of a FrameAddr node. */
159 ir_node *be_get_FrameAddr_frame(const ir_node *node);
161 ir_entity *be_get_FrameAddr_entity(const ir_node *node);
164 * Position numbers for the be_AddSP inputs
167 n_be_AddSP_old_sp = 0,
180 * Make a new AddSP node.
181 * An AddSP node expresses an increase of the stack pointer in the direction
182 * the stack grows. In contrast to IncSP, the amount of bytes the stack pointer
183 * is grown, is not given by a constant but an ordinary Firm node.
184 * @param sp The stack pointer register.
185 * @param block The block.
186 * @param old_sp The node representing the old stack pointer value.
187 * @param size The node expressing the size by which the stack pointer shall
189 * @return A new AddSP node.
191 ir_node *be_new_AddSP(const arch_register_t *sp, ir_node *block,
192 ir_node *old_sp, ir_node *size);
195 * Position numbers for the be_SubSP inputs
198 n_be_SubSP_old_sp = 0,
210 * Make a new SubSP node.
211 * A SubSP node expresses a decrease of the stack pointer in the direction the
212 * stack grows. In contrast to IncSP, the amount of bytes the stack pointer is
213 * grown, is not given by a constant but an ordinary Firm node.
214 * @param sp The stack pointer register.
215 * @param block The block.
216 * @param old_sp The node representing the old stack pointer value.
217 * @param size The node expressing the size by which the stack pointer shall
219 * @return A new DecSP node.
221 ir_node *be_new_SubSP(const arch_register_t *sp, ir_node *block,
222 ir_node *old_sp, ir_node *size);
225 * Make a stack pointer increase/decrease node.
226 * @param sp The stack pointer register.
227 * @param block The block to insert the node into.
228 * @param old_sp The node defining the former stack pointer.
229 * @param offset amount the stack should expand (positive offset) or shrink
230 * (negative offset). Note that the offset is independent of the
231 * natural stack direction of the architecture but just specifies
232 * abstract expanding/shrinking of the stack area.
233 * @param align force stack alignment to this power of 2. (ie. specifying 3
234 * results in a 2^3 = 8byte stack alignment)
235 * @return A new stack pointer increment/decrement node.
236 * @note This node sets a register constraint to the @p sp register on
239 ir_node *be_new_IncSP(const arch_register_t *sp, ir_node *block,
240 ir_node *old_sp, int offset, int align);
242 /** Returns the previous node that computes the stack pointer. */
243 ir_node *be_get_IncSP_pred(ir_node *incsp);
245 /** Sets the previous node that computes the stack pointer. */
246 void be_set_IncSP_pred(ir_node *incsp, ir_node *pred);
249 * Sets a new offset to a IncSP node.
250 * A positive offset means expanding the stack, a negative offset shrinking
251 * an offset is == BE_STACK_FRAME_SIZE will be replaced by the real size of the
252 * stackframe in the fix_stack_offsets phase.
254 void be_set_IncSP_offset(ir_node *irn, int offset);
256 /** Gets the offset from a IncSP node. */
257 int be_get_IncSP_offset(const ir_node *irn);
258 int be_get_IncSP_align(const ir_node *irn);
260 /** Gets the call entity or NULL if this is no static call. */
261 ir_entity *be_Call_get_entity(const ir_node *call);
262 /** Sets the call entity. */
263 void be_Call_set_entity(ir_node *call, ir_entity *ent);
264 /** Gets the call type. */
265 ir_type *be_Call_get_type(ir_node *call);
266 /** Sets the call type. */
267 void be_Call_set_type(ir_node *call, ir_type *call_tp);
269 void be_Call_set_pop(ir_node *call, unsigned pop);
271 unsigned be_Call_get_pop(const ir_node *call);
274 * Position numbers for the be_Call inputs.
277 n_be_Call_mem = 0, /**< memory input of a be_Call node */
278 n_be_Call_sp = 1, /**< stack pointer input of a be_Call node */
279 n_be_Call_ptr = 2, /**< call pointer input of a be_Call node */
280 n_be_Call_first_arg = 3 /**< first argument input of a be_Call node */
284 * Projection numbers for result of be_Call node: use for Proj nodes!
287 pn_be_Call_M = pn_Call_M, /**< The memory result of a be_Call. */
288 pn_be_Call_X_regular = pn_Call_X_regular,
289 pn_be_Call_X_except = pn_Call_X_except,
290 pn_be_Call_sp = pn_Call_max+1,
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 block 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
304 * @param n_outs the number of outcoming values from this call
305 * @param n the number of (register) inputs of this call
306 * @param in the (register) inputs of this call
307 * @param call_tp the call type of this call
309 ir_node *be_new_Call(dbg_info *dbg, ir_graph *irg, ir_node *block, ir_node *mem,
310 ir_node *sp, ir_node *ptr, int n_outs,
311 int n, ir_node *in[], ir_type *call_tp);
314 * Position numbers for the be_Return inputs.
317 n_be_Return_mem = 0, /**< memory input of a be_Return node */
318 n_be_Return_sp = 1, /**< stack pointer input of a be_Return node */
319 n_be_Return_val = 2, /**< first "real" return value if any */
323 * Construct a new be_Return.
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 * @param in input array
333 ir_node *be_new_Return(dbg_info *dbg, ir_graph *irg, ir_node *block, int n_res,
334 unsigned pop, int n, ir_node *in[]);
336 /** Returns the number of real returns values */
337 int be_Return_get_n_rets(const ir_node *ret);
340 * Return the number of bytes that should be popped from stack when executing
343 * @param ret the be_Return node
345 unsigned be_Return_get_pop(const ir_node *ret);
348 * Return non-zero, if number of popped bytes must be always emitted.
350 * @param ret the be_Return node
352 int be_Return_get_emit_pop(const ir_node *ret);
355 * Set the emit_pop flag.
357 * @param ret the be_Return node
359 void be_Return_set_emit_pop(ir_node *ret, int emit_pop);
361 /** appends a node to the return node, returns the position of the node */
362 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);
369 * @param irn The node to be spilled.
370 * @param block the block where the spill should be placed
371 * @return The new spill node.
373 ir_node *be_spill(ir_node *block, ir_node *irn);
376 * Make a reload and insert it into the schedule.
378 * @param cls The register class of the reloaded value.
379 * @param insert The node in the schedule in front of which the reload is
381 * @param mode The mode of the original (spilled) value.
382 * @param spill The spill node corresponding to this reload.
383 * @return A freshly made reload.
385 ir_node *be_reload(const arch_register_class_t *cls, ir_node *insert,
386 ir_mode *mode, ir_node *spill);
391 ir_node *be_new_CopyKeep(ir_node *block, ir_node *src,
392 int n, ir_node *in_keep[]);
394 ir_node *be_new_CopyKeep_single(ir_node *block, ir_node *src, ir_node *keep);
396 ir_node *be_get_CopyKeep_op(const ir_node *cpy);
398 void be_set_CopyKeep_op(ir_node *cpy, ir_node *op);
401 * Returns the frame entity of a be node.
402 * Try to avoid this function and better call arch_get_frame_entity!
404 * @return the frame entity used by the be node
406 ir_entity *be_get_frame_entity(const ir_node *irn);
408 void be_node_set_frame_entity(ir_node *node, ir_entity *entity);
411 * Returns the frame offset of this node.
413 int be_get_frame_offset(const ir_node *irn);
415 ir_node* be_get_Reload_mem(const ir_node *irn);
416 ir_node *be_get_Reload_frame(const ir_node *irn);
417 ir_node* be_get_Spill_val(const ir_node *irn);
418 ir_node *be_get_Spill_frame(const ir_node *irn);
420 void be_set_MemPerm_in_entity(const ir_node *irn, int n, ir_entity* ent);
421 ir_entity *be_get_MemPerm_in_entity(const ir_node *irn, int n);
423 void be_set_MemPerm_out_entity(const ir_node *irn, int n, ir_entity* ent);
424 ir_entity *be_get_MemPerm_out_entity(const ir_node *irn, int n);
426 int be_get_MemPerm_entity_arity(const ir_node *irn);
429 * Impose a register constraint on a backend node.
430 * @param irn The node.
431 * @param pos The position of the argument.
432 * @param reg The register which is admissible for that node, argument/result
435 void be_set_constr_single_reg_in(ir_node *irn, int pos,
436 const arch_register_t *reg, arch_register_req_type_t additional_flags);
437 void be_set_constr_single_reg_out(ir_node *irn, int pos,
438 const arch_register_t *reg, arch_register_req_type_t additional_flags);
440 const arch_register_req_t *be_create_reg_req(struct obstack *obst,
441 const arch_register_t *reg, arch_register_req_type_t additional_types);
444 * Impose register constraints on a backend node.
445 * The register subsets given by the limited function in @p req are copied to
446 * the backend node. This requires that the constraint type of the @p req is
447 * arch_register_req_type_limited.
448 * @param irn The backend node.
449 * @param pos The position (@see be_set_constr_single_reg()).
450 * @param req The register requirements which shall be transferred.
452 void be_set_constr_in(ir_node *irn, int pos, const arch_register_req_t *req);
453 void be_set_constr_out(ir_node *irn, int pos, const arch_register_req_t *req);
456 * Set the register class of a node.
457 * @param irn The node itself.
458 * @param pos The position (0..n) for arguments
459 * @param flags The register class to set for that node and position.
461 void be_node_set_reg_class_in(ir_node *irn, int pos,
462 const arch_register_class_t *cls);
463 void be_node_set_reg_class_out(ir_node *irn, int pos,
464 const arch_register_class_t *cls);
467 * Set the register requirements for a phi node.
469 void be_set_phi_reg_req(ir_node *phi, const arch_register_req_t *req);
471 void be_dump_phi_reg_reqs(FILE *out, ir_node *node, dump_reason_t reason);
474 * Creates a new phi with associated backend informations
476 ir_node *be_new_Phi(ir_node *block, int n_ins, ir_node **ins, ir_mode *mode,
477 const arch_register_class_t *cls);
480 * Search for output of start node with a specific register
482 ir_node *be_get_initial_reg_value(ir_graph *irg, const arch_register_t *reg);
485 * Search for input of a return node with a specific register and return
488 int be_find_return_reg_input(ir_node *ret, const arch_register_t *reg);
490 static inline int be_is_Spill (const ir_node *irn) { return get_irn_opcode(irn) == beo_Spill ; }
491 static inline int be_is_Reload (const ir_node *irn) { return get_irn_opcode(irn) == beo_Reload ; }
492 static inline int be_is_Copy (const ir_node *irn) { return get_irn_opcode(irn) == beo_Copy ; }
493 static inline int be_is_CopyKeep (const ir_node *irn) { return get_irn_opcode(irn) == beo_CopyKeep ; }
494 static inline int be_is_Perm (const ir_node *irn) { return get_irn_opcode(irn) == beo_Perm ; }
495 static inline int be_is_MemPerm (const ir_node *irn) { return get_irn_opcode(irn) == beo_MemPerm ; }
496 static inline int be_is_Keep (const ir_node *irn) { return get_irn_opcode(irn) == beo_Keep ; }
497 static inline int be_is_Call (const ir_node *irn) { return get_irn_opcode(irn) == beo_Call ; }
498 static inline int be_is_Return (const ir_node *irn) { return get_irn_opcode(irn) == beo_Return ; }
499 static inline int be_is_IncSP (const ir_node *irn) { return get_irn_opcode(irn) == beo_IncSP ; }
500 static inline int be_is_AddSP (const ir_node *irn) { return get_irn_opcode(irn) == beo_AddSP ; }
501 static inline int be_is_SubSP (const ir_node *irn) { return get_irn_opcode(irn) == beo_SubSP ; }
502 static inline int be_is_Start (const ir_node *irn) { return get_irn_opcode(irn) == beo_Start ; }
503 static inline int be_is_FrameAddr(const ir_node *irn) { return get_irn_opcode(irn) == beo_FrameAddr; }