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_Start;
57 extern ir_op *op_be_FrameAddr;
58 extern ir_op *op_be_Barrier;
61 * A "symbolic constant" for the size of the stack frame to use with IncSP nodes.
62 * It gets back-patched to the real size as soon it is known.
64 #define BE_STACK_FRAME_SIZE_EXPAND INT_MAX
65 #define BE_STACK_FRAME_SIZE_SHRINK INT_MIN
68 * Determines if irn is a be_node.
70 int is_be_node(const ir_node *irn);
73 * Create all BE specific opcodes.
75 void be_init_op(void);
78 * Position numbers for the be_Spill inputs.
81 be_pos_Spill_frame = 0,
86 * Make a new Spill node.
88 ir_node *be_new_Spill(const arch_register_class_t *cls, const arch_register_class_t *cls_frame,
89 ir_node *bl, ir_node *frame, ir_node *to_spill);
92 * Position numbers for the be_Reload inputs.
95 be_pos_Reload_frame = 0,
100 * Make a new Reload node.
102 ir_node *be_new_Reload(const arch_register_class_t *cls, const arch_register_class_t *cls_frame,
103 ir_node *bl, ir_node *frame, ir_node *mem, ir_mode *mode);
106 * Position numbers for the be_Copy inputs.
113 * Make a new Copy node.
115 ir_node *be_new_Copy(const arch_register_class_t *cls, ir_node *block, ir_node *in);
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 *bl, int arity, ir_node *in[]);
128 * Basically, we provide a map to remap the Perm's arguments. If an entry in the
129 * map is -1, the argument gets deleted.
130 * This function takes care, that the register data and the input array reflects
131 * the changes described by the map.
132 * This is needed by the Perm optimization/movement in belower.c, see push_through_perm().
133 * @param perm The perm node.
134 * @param new_size The new number of arguments (must be smaller or equal to the current one).
135 * @param map A map assigning each operand a new index (or -1 to indicate deletion).
137 void be_Perm_reduce(ir_node *perm, int new_size, int *map);
140 * Create a new MemPerm node.
142 ir_node *be_new_MemPerm(const arch_env_t *arch_env, ir_node *bl, int n, ir_node *in[]);
143 ir_node *be_new_Keep(ir_node *block, int arity, ir_node *in[]);
145 void be_Keep_add_node(ir_node *keep, const arch_register_class_t *cls, ir_node *node);
148 * Position numbers for the be_FrameAddr inputs
151 be_pos_FrameAddr_ptr = 0
154 /** Create a new FrameAddr node. */
155 ir_node *be_new_FrameAddr(const arch_register_class_t *cls_frame, ir_node *bl, ir_node *frame, ir_entity *ent);
157 /** Return the frame input of a FrameAddr node. */
158 ir_node *be_get_FrameAddr_frame(const ir_node *node);
160 ir_entity *be_get_FrameAddr_entity(const ir_node *node);
163 * Position numbers for the be_AddSP inputs
166 be_pos_AddSP_old_sp = 0,
167 be_pos_AddSP_size = 1,
168 be_pos_AddSP_last = 2
179 * Make a new AddSP node.
180 * An AddSP node expresses an increase of the stack pointer in the direction the stack
181 * grows. In contrast to IncSP, the amount of bytes the stack pointer is grown, is not
182 * given by a constant but an ordinary Firm node.
183 * @param sp The stack pointer register.
184 * @param bl The block.
185 * @param old_sp The node representing the old stack pointer value.
186 * @param sz The node expressing the size by which the stack pointer shall be grown.
187 * @return A new AddSP node.
189 ir_node *be_new_AddSP(const arch_register_t *sp, ir_node *bl, ir_node *old_sp, ir_node *sz);
192 * Position numbers for the be_SubSP inputs
195 be_pos_SubSP_old_sp = 0,
196 be_pos_SubSP_size = 1,
197 be_pos_SubSP_last = 2
207 * Make a new SubSP node.
208 * A SubSP node expresses a decrease of the stack pointer in the direction the stack
209 * grows. In contrast to IncSP, the amount of bytes the stack pointer is grown, is not
210 * given by a constant but an ordinary Firm node.
211 * @param sp The stack pointer register.
212 * @param bl The block.
213 * @param old_sp The node representing the old stack pointer value.
214 * @param sz The node expressing the size by which the stack pointer shall be grown.
215 * @return A new DecSP node.
217 ir_node *be_new_SubSP(const arch_register_t *sp, ir_node *bl, ir_node *old_sp, ir_node *sz);
220 * Make a stack pointer increase/decrease node.
221 * @param sp The stack pointer register. * @param irg The graph to insert the node to.
222 * @param bl The block to insert the node into.
223 * @param old_sp The node defining the former stack pointer.
224 * @param amount The mount of bytes the stack shall be expanded/shrinked (see set_IncSP_offset)
225 * @param dir The direction in which the stack pointer shall be modified:
226 * Along the stack's growing direction or against.
227 * @return A new stack pointer increment/decrement node.
228 * @note This node sets a register constraint to the @p sp register on its output.
230 ir_node *be_new_IncSP(const arch_register_t *sp, ir_node *bl,
231 ir_node *old_sp, int offset, int align);
233 /** Returns the previous node that computes the stack pointer. */
234 ir_node *be_get_IncSP_pred(ir_node *incsp);
236 /** Sets the previous node that computes the stack pointer. */
237 void be_set_IncSP_pred(ir_node *incsp, ir_node *pred);
240 * Sets a new offset to a IncSP node.
241 * A positive offset means expanding the stack, a negative offset shrinking
242 * an offset is == BE_STACK_FRAME_SIZE will be replaced by the real size of the
243 * stackframe in the fix_stack_offsets phase.
245 void be_set_IncSP_offset(ir_node *irn, int offset);
247 /** Gets the offset from a IncSP node. */
248 int be_get_IncSP_offset(const ir_node *irn);
249 int be_get_IncSP_align(const ir_node *irn);
251 /** Gets the call entity or NULL if this is no static call. */
252 ir_entity *be_Call_get_entity(const ir_node *call);
253 /** Sets the call entity. */
254 void be_Call_set_entity(ir_node *call, ir_entity *ent);
255 /** Gets the call type. */
256 ir_type *be_Call_get_type(ir_node *call);
257 /** Sets the call type. */
258 void be_Call_set_type(ir_node *call, ir_type *call_tp);
260 void be_Call_set_pop(ir_node *call, unsigned pop);
262 unsigned be_Call_get_pop(const ir_node *call);
265 * Position numbers for the be_Call inputs.
268 be_pos_Call_mem = 0, /**< memory input of a be_Call node */
269 be_pos_Call_sp = 1, /**< stack pointer input of a be_Call node */
270 be_pos_Call_ptr = 2, /**< call pointer input of a be_Call node */
271 be_pos_Call_first_arg = 3 /**< first argument input of a be_Call node */
275 * Projection numbers for result of be_Call node: use for Proj nodes!
278 pn_be_Call_M_regular = pn_Call_M_regular, /**< The memory result of a be_Call. */
279 pn_be_Call_sp = pn_Call_max,
280 pn_be_Call_first_res /**< The first result proj number of a be_Call. */
284 * Construct a new be_Call.
286 * @param dbg debug info
287 * @param irg the graph where the call is placed
288 * @param bl the block where the call is placed
289 * @param mem the memory input of the call
290 * @param sp the stack pointer input of the call
291 * @param ptr the address of the called function, if immediate call set to sp
292 * @param n_outs the number of outcoming values from this call
293 * @param n the number of (register) inputs of this call
294 * @param in the (register) inputs of this call
295 * @param call_tp the call type of this call
297 ir_node *be_new_Call(dbg_info *dbg, ir_graph *irg, ir_node *bl, ir_node *mem, ir_node *sp, ir_node *ptr,
298 int n_outs, int n, ir_node *in[], ir_type *call_tp);
301 * Position numbers for the be_Return inputs.
304 be_pos_Return_mem = 0, /**< memory input of a be_Return node */
305 be_pos_Return_sp = 1, /**< stack pointer input of a be_Return node */
306 be_pos_Return_val = 2, /**< first "real" return value if any */
310 * Construct a new be_Return.
312 * @param dbg debug info
313 * @param irg the graph where the new node will be placed
314 * @param bl the block where the new node will be placed
315 * @param n_res number of "real" results
316 * @param n number of inputs
317 * @param pop pop number of bytes on return
318 * @param in input array
320 ir_node *be_new_Return(dbg_info *dbg, ir_graph *irg, ir_node *bl, int n_res, unsigned pop, int n, ir_node *in[]);
322 /** Returns the number of real returns values */
323 int be_Return_get_n_rets(const ir_node *ret);
326 * Return the number of bytes that should be popped from stack when executing the Return.
328 * @param ret the be_Return node
330 unsigned be_Return_get_pop(const ir_node *ret);
333 * Return non-zero, if number of popped bytes must be always emitted.
335 * @param ret the be_Return node
337 int be_Return_get_emit_pop(const ir_node *ret);
340 * Set the emit_pop flag.
342 * @param ret the be_Return node
344 void be_Return_set_emit_pop(ir_node *ret, int emit_pop);
346 /** appends a node to the return node, returns the position of the node */
347 int be_Return_append_node(ir_node *ret, ir_node *node);
349 ir_node *be_new_Start(ir_node *block, int n_out);
351 ir_node *be_new_Barrier(ir_node *bl, int n, ir_node *in[]);
354 * Appends a node to a barrier, returns the result proj of the node
356 ir_node *be_Barrier_append_node(ir_node *barrier, ir_node *node);
361 * @param irn The node to be spilled.
362 * @param spill_ctx The context in which the spill is introduced (This is mostly == irn up to the case of Phis).
363 * @return The new spill node.
365 ir_node *be_spill(ir_node *block, ir_node *irn);
368 * Make a reload and insert it into the schedule.
370 * @param cls The register class of the reloaded value.
371 * @param insert The node in the schedule in front of which the reload is inserted.
372 * @param mode The mode of the original (spilled) value.
373 * @param spill The spill node corresponding to this reload.
374 * @return A freshly made reload.
376 ir_node *be_reload(const arch_register_class_t *cls, ir_node *insert, ir_mode *mode, ir_node *spill);
379 be_pos_CopyKeep_op = 0
381 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);
382 ir_node *be_new_CopyKeep_single(const arch_register_class_t *cls, ir_node *bl, ir_node *src, ir_node *keep, ir_mode *mode);
383 ir_node *be_get_CopyKeep_op(const ir_node *cpy);
384 void be_set_CopyKeep_op(ir_node *cpy, ir_node *op);
387 * Get the backend opcode of a backend node.
388 * @param irn The node.
389 * @return The backend opcode.
391 #define be_get_irn_opcode(irn) get_irn_opcode(irn)
394 * Returns the frame entity of a be node.
395 * Try to avoid this function and better call arch_get_frame_entity!
397 * @return the frame entity used by the be node
399 ir_entity *be_get_frame_entity(const ir_node *irn);
402 * Returns the frame offset of this node.
404 int be_get_frame_offset(const ir_node *irn);
406 ir_node* be_get_Reload_mem(const ir_node *irn);
407 ir_node *be_get_Reload_frame(const ir_node *irn);
408 ir_node* be_get_Spill_val(const ir_node *irn);
409 ir_node *be_get_Spill_frame(const ir_node *irn);
411 void be_set_MemPerm_in_entity(const ir_node *irn, int n, ir_entity* ent);
412 ir_entity *be_get_MemPerm_in_entity(const ir_node *irn, int n);
414 void be_set_MemPerm_out_entity(const ir_node *irn, int n, ir_entity* ent);
415 ir_entity *be_get_MemPerm_out_entity(const ir_node *irn, int n);
417 int be_get_MemPerm_entity_arity(const ir_node *irn);
420 * Impose a register constraint on a backend node.
421 * @param irn The node.
422 * @param pos The position of the argument.
423 * @param reg The register which is admissible for that node, argument/result and position.
425 void be_set_constr_single_reg_in(ir_node *irn, int pos,
426 const arch_register_t *reg, arch_register_req_type_t additional_flags);
427 void be_set_constr_single_reg_out(ir_node *irn, int pos,
428 const arch_register_t *reg, arch_register_req_type_t additional_flags);
431 * Impose register constraints on a backend node.
432 * The register subsets given by the limited function in @p req are copied to the backend node.
433 * This requires that the constraint type of the @p req is arch_register_req_type_limited.
434 * @param irn The backend node.
435 * @param pos The position (@see be_set_constr_single_reg()).
436 * @param req The register requirements which shall be transferred.
438 void be_set_constr_in(ir_node *irn, int pos, const arch_register_req_t *req);
439 void be_set_constr_out(ir_node *irn, int pos, const arch_register_req_t *req);
442 * Set the register class of a node.
443 * @param irn The node itself.
444 * @param pos The position (0..n) for arguments
445 * @param flags The register class to set for that node and position.
447 void be_node_set_reg_class_in(ir_node *irn, int pos, const arch_register_class_t *cls);
448 void be_node_set_reg_class_out(ir_node *irn, int pos, const arch_register_class_t *cls);
451 * Set the register requirements for a phi node.
453 void be_set_phi_reg_req(ir_node *phi, const arch_register_req_t *req);
455 int be_dump_phi_reg_reqs(ir_node *node, FILE *F, dump_reason_t reason);
458 * Creates a new phi with associated backend informations
460 ir_node *be_new_Phi(ir_node *block, int n_ins, ir_node **ins, ir_mode *mode,
461 const arch_register_class_t *cls);
464 * irn handler for common be nodes and Phi's.
466 const void *be_node_get_irn_ops(const ir_node *irn);
468 static inline int be_is_Spill (const ir_node *irn) { return get_irn_opcode(irn) == beo_Spill ; }
469 static inline int be_is_Reload (const ir_node *irn) { return get_irn_opcode(irn) == beo_Reload ; }
470 static inline int be_is_Copy (const ir_node *irn) { return get_irn_opcode(irn) == beo_Copy ; }
471 static inline int be_is_CopyKeep (const ir_node *irn) { return get_irn_opcode(irn) == beo_CopyKeep ; }
472 static inline int be_is_Perm (const ir_node *irn) { return get_irn_opcode(irn) == beo_Perm ; }
473 static inline int be_is_MemPerm (const ir_node *irn) { return get_irn_opcode(irn) == beo_MemPerm ; }
474 static inline int be_is_Keep (const ir_node *irn) { return get_irn_opcode(irn) == beo_Keep ; }
475 static inline int be_is_Call (const ir_node *irn) { return get_irn_opcode(irn) == beo_Call ; }
476 static inline int be_is_Return (const ir_node *irn) { return get_irn_opcode(irn) == beo_Return ; }
477 static inline int be_is_IncSP (const ir_node *irn) { return get_irn_opcode(irn) == beo_IncSP ; }
478 static inline int be_is_AddSP (const ir_node *irn) { return get_irn_opcode(irn) == beo_AddSP ; }
479 static inline int be_is_SubSP (const ir_node *irn) { return get_irn_opcode(irn) == beo_SubSP ; }
480 static inline int be_is_Start (const ir_node *irn) { return get_irn_opcode(irn) == beo_Start; }
481 static inline int be_is_FrameAddr(const ir_node *irn) { return get_irn_opcode(irn) == beo_FrameAddr; }
482 static inline int be_is_Barrier (const ir_node *irn) { return get_irn_opcode(irn) == beo_Barrier ; }
484 #endif /* FIRM_BE_BENODE_T_H */