2 * Copyright (C) 1995-2007 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_SetSP;
57 extern ir_op *op_be_RegParams;
58 extern ir_op *op_be_StackParam;
59 extern ir_op *op_be_FrameAddr;
60 extern ir_op *op_be_FrameLoad;
61 extern ir_op *op_be_FrameStore;
62 extern ir_op *op_be_Barrier;
90 be_frame_flag_spill = 1,
91 be_frame_flag_local = 2,
96 * A "symbolic constant" for the size of the stack frame to use with IncSP nodes.
97 * It gets back-patched to the real size as soon it is known.
99 #define BE_STACK_FRAME_SIZE_EXPAND INT_MAX
100 #define BE_STACK_FRAME_SIZE_SHRINK INT_MIN
103 * Determines if irn is a be_node.
105 int is_be_node(const ir_node *irn);
108 * Create all BE specific opcodes.
110 void be_node_init(void);
113 * Position numbers for the be_Spill inputs.
116 be_pos_Spill_frame = 0,
121 * Make a new Spill node.
123 ir_node *be_new_Spill(const arch_register_class_t *cls, const arch_register_class_t *cls_frame,
124 ir_graph *irg, ir_node *bl, ir_node *frame, ir_node *to_spill);
127 * Position numbers for the be_Reload inputs.
130 be_pos_Reload_frame = 0,
131 be_pos_Reload_mem = 1
135 * Make a new Reload node.
137 ir_node *be_new_Reload(const arch_register_class_t *cls, const arch_register_class_t *cls_frame,
138 ir_graph *irg, ir_node *bl, ir_node *frame, ir_node *mem, ir_mode *mode);
141 * Position numbers for the be_Copy inputs.
148 * Make a new Copy node.
150 ir_node *be_new_Copy(const arch_register_class_t *cls, ir_graph *irg, ir_node *block, ir_node *in);
151 /** Returns the Copy Argument. */
152 ir_node *be_get_Copy_op(const ir_node *cpy);
153 /** Sets the Copy Argument. */
154 void be_set_Copy_op(ir_node *cpy, ir_node *op);
157 * Make a new Perm node.
159 ir_node *be_new_Perm(const arch_register_class_t *cls, ir_graph *irg, ir_node *bl, int arity, ir_node *in[]);
161 * Create a new MemPerm node.
163 ir_node *be_new_MemPerm(const arch_env_t *arch_env, ir_graph *irg, ir_node *bl, int n, ir_node *in[]);
164 ir_node *be_new_Keep(const arch_register_class_t *cls, ir_graph *irg, ir_node *bl, int arity, ir_node *in[]);
166 void be_Keep_add_node(ir_node *keep, const arch_register_class_t *cls, ir_node *node);
169 * Position numbers for the be_FrameLoad inputs
172 be_pos_FrameLoad_mem = 0,
173 be_pos_FrameLoad_ptr = 1
176 ir_node *be_new_FrameLoad(const arch_register_class_t *cls_frame, const arch_register_class_t *cls_data,
177 ir_graph *irg, ir_node *bl, ir_node *mem, ir_node *frame, ir_entity *ent);
180 * Position numbers for the be_FrameStore inputs
183 be_pos_FrameStore_mem = 0,
184 be_pos_FrameStore_ptr = 1,
185 be_pos_FrameStore_val = 2
188 ir_node *be_new_FrameStore(const arch_register_class_t *cls_frame, const arch_register_class_t *cls_data,
189 ir_graph *irg, ir_node *bl, ir_node *mem, ir_node *frame, ir_node *data, ir_entity *ent);
192 * Position numbers for the be_FrameAddr inputs
195 be_pos_FrameAddr_ptr = 0
198 ir_node *be_new_FrameAddr(const arch_register_class_t *cls_frame, ir_graph *irg, ir_node *bl, ir_node *frame, ir_entity *ent);
201 * Position numbers for the be_AddSP inputs
204 be_pos_AddSP_old_sp = 0,
205 be_pos_AddSP_size = 1,
206 be_pos_AddSP_last = 2
216 * Make a new AddSP node.
217 * An AddSP node expresses an increase 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 AddSP node.
227 ir_node *be_new_AddSP(const arch_register_t *sp, ir_graph *irg, ir_node *bl, ir_node *old_sp, ir_node *sz);
230 * Position numbers for the be_SubSP inputs
233 be_pos_SubSP_old_sp = 0,
234 be_pos_SubSP_size = 1,
235 be_pos_SubSP_last = 2
245 * Make a new SubSP node.
246 * A SubSP node expresses a decrease of the stack pointer in the direction the stack
247 * grows. In contrast to IncSP, the amount of bytes the stack pointer is grown, is not
248 * given by a constant but an ordinary Firm node.
249 * @param sp The stack pointer register.
250 * @param irg The graph.
251 * @param bl The block.
252 * @param old_sp The node representing the old stack pointer value.
253 * @param sz The node expressing the size by which the stack pointer shall be grown.
254 * @return A new DecSP node.
256 ir_node *be_new_SubSP(const arch_register_t *sp, ir_graph *irg, ir_node *bl, ir_node *old_sp, ir_node *sz);
258 ir_node *be_new_SetSP(const arch_register_t *sp, ir_graph *irg, ir_node *bl, ir_node *old_sp, ir_node *operand, ir_node *mem);
261 * Make a stack pointer increase/decrease node.
262 * @param sp The stack pointer register.
263 * @param irg The graph to insert the node to.
264 * @param bl The block to insert the node into.
265 * @param old_sp The node defining the former stack pointer.
266 * @param amount The mount of bytes the stack shall be expanded/shrinked (see set_IncSP_offset)
267 * @param dir The direction in which the stack pointer shall be modified:
268 * Along the stack's growing direction or against.
269 * @return A new stack pointer increment/decrement node.
270 * @note This node sets a register constraint to the @p sp register on its output.
272 ir_node *be_new_IncSP(const arch_register_t *sp, ir_graph *irg, ir_node *bl, ir_node *old_sp, int offset);
274 /** Returns the previous node that computes the stack pointer. */
275 ir_node *be_get_IncSP_pred(ir_node *incsp);
277 /** Sets the previous node that computes the stack pointer. */
278 void be_set_IncSP_pred(ir_node *incsp, ir_node *pred);
281 * Sets a new offset to a IncSP node.
282 * A positive offset means expanding the stack, a negative offset shrinking
283 * an offset is == BE_STACK_FRAME_SIZE will be replaced by the real size of the
284 * stackframe in the fix_stack_offsets phase.
286 void be_set_IncSP_offset(ir_node *irn, int offset);
288 /** Gets the offset from a IncSP node. */
289 int be_get_IncSP_offset(const ir_node *irn);
291 /** Gets the call entity or NULL if this is no static call. */
292 ir_entity *be_Call_get_entity(const ir_node *call);
293 /** Sets the call entity. */
294 void be_Call_set_entity(ir_node *call, ir_entity *ent);
295 /** Gets the call type. */
296 ir_type *be_Call_get_type(ir_node *call);
297 /** Sets the call type. */
298 void be_Call_set_type(ir_node *call, ir_type *call_tp);
301 * Position numbers for the be_Call inputs.
304 be_pos_Call_mem = 0, /**< memory input of a be_Call node */
305 be_pos_Call_sp = 1, /**< stack pointer input of a be_Call node */
306 be_pos_Call_ptr = 2, /**< call pointer input of a be_Call node */
307 be_pos_Call_first_arg = 3 /**< first argument input of a be_Call node */
311 * Projection numbers for result of be_Call node: use for Proj nodes!
314 pn_be_Call_M_regular = pn_Call_M_regular, /**< The memory result of a be_Call. */
315 pn_be_Call_first_res = pn_Call_max /**< The first result proj number of a be_Call. */
319 * Construct a new be_Call.
321 * @param dbg debug info
322 * @param irg the graph where the call is placed
323 * @param bl the block where the call is placed
324 * @param mem the memory input of the call
325 * @param sp the stack pointer input of the call
326 * @param ptr the address of the called function, if immediate call set to sp
327 * @param n_outs the number of outcoming values from this call
328 * @param n the number of (register) inputs of this call
329 * @param in the (register) inputs of this call
330 * @param call_tp the call type of this call
332 ir_node *be_new_Call(dbg_info *dbg, ir_graph *irg, ir_node *bl, ir_node *mem, ir_node *sp, ir_node *ptr,
333 int n_outs, int n, ir_node *in[], ir_type *call_tp);
336 * Position numbers for the be_Return inputs.
339 be_pos_Return_mem = 0, /**< memory input of a be_Return node */
340 be_pos_Return_sp = 1, /**< stack pointer input of a be_Return node */
341 be_pos_Return_val = 2, /**< first "real" return value if any */
345 * Construct a new be_Return.
346 * @param irg the graph where the new node will be placed
347 * @param bl the block where the new node will be placed
348 * @param n_res number of "real" results
349 * @param n number of inputs
350 * @param in input array
352 ir_node *be_new_Return(dbg_info *dbg, ir_graph *irg, ir_node *bl, int n_res, int n, ir_node *in[]);
354 /** Returns the number of real returns values */
355 int be_Return_get_n_rets(ir_node *ret);
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);
361 * StackParam input positions
364 be_pos_StackParam_ptr = 0
368 * Construct a new Stack Parameter node.
370 ir_node *be_new_StackParam(const arch_register_class_t *cls, const arch_register_class_t *cls_frame, ir_graph *irg, ir_node *bl, ir_mode *mode, ir_node *frame_pointer, ir_entity *ent);
371 ir_node *be_new_RegParams(ir_graph *irg, ir_node *bl, int n_out);
373 ir_node *be_new_Barrier(ir_graph *irg, ir_node *bl, int n, ir_node *in[]);
376 * Appends a node to a barrier, returns the result proj of the node
378 ir_node *be_Barrier_append_node(ir_node *barrier, ir_node *node);
381 * Appends a register out requirement to a RegParams node
383 * @returns the proj node for the new register
385 ir_node *be_RegParams_append_out_reg(ir_node *regparams,
386 const arch_env_t *arch_env,
387 const arch_register_t *reg);
392 * @param arch_env The architecture environment.
393 * @param irn The node to be spilled.
394 * @param spill_ctx The context in which the spill is introduced (This is mostly == irn up to the case of Phis).
395 * @return The new spill node.
397 ir_node *be_spill(const arch_env_t *arch_env, ir_node *irn);
400 * Make a reload and insert it into the schedule.
402 * @param arch_env The architecture environment.
403 * @param cls The register class of the reloaded value.
404 * @param insert The node in the schedule in front of which the reload is inserted.
405 * @param mode The mode of the original (spilled) value.
406 * @param spill The spill node corresponding to this reload.
407 * @return A freshly made reload.
409 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);
412 be_pos_CopyKeep_op = 0
414 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);
415 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);
416 ir_node *be_get_CopyKeep_op(const ir_node *cpy);
417 void be_set_CopyKeep_op(ir_node *cpy, ir_node *op);
420 * Get the backend opcode of a backend node.
421 * @param irn The node.
422 * @return The backend opcode.
424 be_opcode_t be_get_irn_opcode(const ir_node *irn);
426 int be_is_Spill(const ir_node *irn);
427 int be_is_Reload(const ir_node *irn);
428 int be_is_Copy(const ir_node *irn);
429 int be_is_Perm(const ir_node *irn);
430 int be_is_MemPerm(const ir_node *irn);
431 int be_is_Keep(const ir_node *irn);
432 int be_is_CopyKeep(const ir_node *irn);
433 int be_is_Call(const ir_node *irn);
434 int be_is_Return(const ir_node *irn);
435 int be_is_IncSP(const ir_node *irn);
436 int be_is_SetSP(const ir_node *irn);
437 int be_is_AddSP(const ir_node *irn);
438 int be_is_SubSP(const ir_node *irn);
439 int be_is_RegParams(const ir_node *irn);
440 int be_is_StackParam(const ir_node *irn);
441 int be_is_FrameAddr(const ir_node *irn);
442 int be_is_FrameLoad(const ir_node *irn);
443 int be_is_FrameStore(const ir_node *irn);
444 int be_is_Barrier(const ir_node *irn);
447 * Try to avoid this function and better call arch_get_frame_entity!
449 * Returns the frame entity used by the be node
451 ir_entity *be_get_frame_entity(const ir_node *irn);
454 * Returns the frame offset of this node.
456 int be_get_frame_offset(const ir_node *irn);
458 ir_node* be_get_Reload_mem(const ir_node *irn);
459 ir_node *be_get_Reload_frame(const ir_node *irn);
460 ir_node* be_get_Spill_val(const ir_node *irn);
461 ir_node *be_get_Spill_frame(const ir_node *irn);
463 void be_set_MemPerm_in_entity(const ir_node *irn, int n, ir_entity* ent);
464 ir_entity *be_get_MemPerm_in_entity(const ir_node *irn, int n);
466 void be_set_MemPerm_out_entity(const ir_node *irn, int n, ir_entity* ent);
467 ir_entity *be_get_MemPerm_out_entity(const ir_node *irn, int n);
469 int be_get_MemPerm_entity_arity(const ir_node *irn);
472 * Impose a register constraint on a backend node.
473 * @param irn The node.
474 * @param pos The position of the argument/result. Results range from -1..-m and arguments form 0..n
475 * @param reg The register which is admissible for that node, argument/result and position.
477 void be_set_constr_single_reg(ir_node *irn, int pos, const arch_register_t *reg);
480 * Impose register constraints on a backend node.
481 * The register subsets given by the limited function in @p req are copied to the backend node.
482 * This requires that the constraint type of the @p req is arch_register_req_type_limited.
483 * @param irn The backend node.
484 * @param pos The position (@see be_set_constr_single_reg()).
485 * @param req The register requirements which shall be transferred.
487 void be_set_constr_limited(ir_node *irn, int pos, const arch_register_req_t *req);
490 * Set the flags of a node.
491 * @param irn The node itself.
492 * @param pos The position (0..n) for arguments, (-1..-m) for results.
493 * @param flags The flags to set for that node and position.
495 void be_node_set_flags(ir_node *irn, int pos, arch_irn_flags_t flags);
498 * Set the register class of a node.
499 * @param irn The node itself.
500 * @param pos The position (0..n) for arguments, (-1..-m) for results.
501 * @param flags The register class to set for that node and position.
503 void be_node_set_reg_class(ir_node *irn, int pos, const arch_register_class_t *cls);
506 * Set the register requirement type of a node.
507 * @param irn The node itself.
508 * @param pos The position (0..n) for arguments, (-1..-m) for results.
509 * @param flags The register requirement type to set for that node and position.
511 void be_node_set_req_type(ir_node *irn, int pos, arch_register_req_type_t type);
514 * Make a new phi handler.
515 * @param env The architecture environment.
516 * @return A new phi handler.
518 arch_irn_handler_t *be_phi_handler_new(const arch_env_t *arch_env);
521 * Free a phi handler.
522 * @param handler The handler to free.
524 void be_phi_handler_free(arch_irn_handler_t *handler);
527 * Reset the register data in the phi handler.
528 * This should be called on each new graph and deletes the register information of the current graph.
530 void be_phi_handler_reset(arch_irn_handler_t *handler);
533 * Set the register requirements for a phi node.
535 void be_set_phi_reg_req(const arch_env_t *arch_env, ir_node *phi,
536 const arch_register_req_t *req);
539 * Set flags for a phi node
541 void be_set_phi_flags(const arch_env_t *arch_env, ir_node *phi,
542 arch_irn_flags_t flags);
545 * irn handler for common be nodes.
547 extern const arch_irn_handler_t be_node_irn_handler;
549 #endif /* FIRM_BE_BENODE_T_H */