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
42 #define BE_OUT_POS(p) (-((p) + 1))
45 * The benode op's. Must be available to register emitter function.
47 extern ir_op *op_be_Spill;
48 extern ir_op *op_be_Reload;
49 extern ir_op *op_be_Perm;
50 extern ir_op *op_be_MemPerm;
51 extern ir_op *op_be_Copy;
52 extern ir_op *op_be_Keep;
53 extern ir_op *op_be_CopyKeep;
54 extern ir_op *op_be_Call;
55 extern ir_op *op_be_Return;
56 extern ir_op *op_be_IncSP;
57 extern ir_op *op_be_AddSP;
58 extern ir_op *op_be_SubSP;
59 extern ir_op *op_be_SetSP;
60 extern ir_op *op_be_RegParams;
61 extern ir_op *op_be_StackParam;
62 extern ir_op *op_be_FrameAddr;
63 extern ir_op *op_be_FrameLoad;
64 extern ir_op *op_be_FrameStore;
65 extern ir_op *op_be_Barrier;
93 be_frame_flag_spill = 1,
94 be_frame_flag_local = 2,
99 * A "symbolic constant" for the size of the stack frame to use with IncSP nodes.
100 * It gets back-patched to the real size as soon it is known.
102 #define BE_STACK_FRAME_SIZE_EXPAND INT_MAX
103 #define BE_STACK_FRAME_SIZE_SHRINK INT_MIN
106 * Determines if irn is a be_node.
108 int is_be_node(const ir_node *irn);
111 * Create all BE specific opcodes.
113 void be_node_init(void);
116 * Position numbers for the be_Spill inputs.
119 be_pos_Spill_frame = 0,
124 * Make a new Spill node.
126 ir_node *be_new_Spill(const arch_register_class_t *cls, const arch_register_class_t *cls_frame,
127 ir_graph *irg, ir_node *bl, ir_node *frame, ir_node *to_spill);
130 * Position numbers for the be_Reload inputs.
133 be_pos_Reload_frame = 0,
134 be_pos_Reload_mem = 1
138 * Make a new Reload node.
140 ir_node *be_new_Reload(const arch_register_class_t *cls, const arch_register_class_t *cls_frame,
141 ir_graph *irg, ir_node *bl, ir_node *frame, ir_node *mem, ir_mode *mode);
144 * Position numbers for the be_Copy inputs.
151 * Make a new Copy node.
153 ir_node *be_new_Copy(const arch_register_class_t *cls, ir_graph *irg, ir_node *block, ir_node *in);
154 /** Returns the Copy Argument. */
155 ir_node *be_get_Copy_op(const ir_node *cpy);
156 /** Sets the Copy Argument. */
157 void be_set_Copy_op(ir_node *cpy, ir_node *op);
160 * Make a new Perm node.
162 ir_node *be_new_Perm(const arch_register_class_t *cls, ir_graph *irg, ir_node *bl, int arity, ir_node *in[]);
164 * Create a new MemPerm node.
166 ir_node *be_new_MemPerm(const arch_env_t *arch_env, ir_graph *irg, ir_node *bl, int n, ir_node *in[]);
167 ir_node *be_new_Keep(const arch_register_class_t *cls, ir_graph *irg, ir_node *bl, int arity, ir_node *in[]);
169 void be_Keep_add_node(ir_node *keep, const arch_register_class_t *cls, ir_node *node);
172 * Position numbers for the be_FrameLoad inputs
175 be_pos_FrameLoad_mem = 0,
176 be_pos_FrameLoad_ptr = 1
179 ir_node *be_new_FrameLoad(const arch_register_class_t *cls_frame, const arch_register_class_t *cls_data,
180 ir_graph *irg, ir_node *bl, ir_node *mem, ir_node *frame, ir_entity *ent);
183 * Position numbers for the be_FrameStore inputs
186 be_pos_FrameStore_mem = 0,
187 be_pos_FrameStore_ptr = 1,
188 be_pos_FrameStore_val = 2
191 ir_node *be_new_FrameStore(const arch_register_class_t *cls_frame, const arch_register_class_t *cls_data,
192 ir_graph *irg, ir_node *bl, ir_node *mem, ir_node *frame, ir_node *data, ir_entity *ent);
195 * Position numbers for the be_FrameAddr inputs
198 be_pos_FrameAddr_ptr = 0
201 ir_node *be_new_FrameAddr(const arch_register_class_t *cls_frame, ir_graph *irg, ir_node *bl, ir_node *frame, ir_entity *ent);
204 * Position numbers for the be_AddSP inputs
207 be_pos_AddSP_old_sp = 0,
208 be_pos_AddSP_size = 1,
209 be_pos_AddSP_last = 2
219 * Make a new AddSP node.
220 * An AddSP node expresses an increase of the stack pointer in the direction the stack
221 * grows. In contrast to IncSP, the amount of bytes the stack pointer is grown, is not
222 * given by a constant but an ordinary Firm node.
223 * @param sp The stack pointer register.
224 * @param irg The graph.
225 * @param bl The block.
226 * @param old_sp The node representing the old stack pointer value.
227 * @param sz The node expressing the size by which the stack pointer shall be grown.
228 * @return A new AddSP node.
230 ir_node *be_new_AddSP(const arch_register_t *sp, ir_graph *irg, ir_node *bl, ir_node *old_sp, ir_node *sz);
233 * Position numbers for the be_SubSP inputs
236 be_pos_SubSP_old_sp = 0,
237 be_pos_SubSP_size = 1,
238 be_pos_SubSP_last = 2
248 * Make a new SubSP node.
249 * A SubSP node expresses a decrease of the stack pointer in the direction the stack
250 * grows. In contrast to IncSP, the amount of bytes the stack pointer is grown, is not
251 * given by a constant but an ordinary Firm node.
252 * @param sp The stack pointer register.
253 * @param irg The graph.
254 * @param bl The block.
255 * @param old_sp The node representing the old stack pointer value.
256 * @param sz The node expressing the size by which the stack pointer shall be grown.
257 * @return A new DecSP node.
259 ir_node *be_new_SubSP(const arch_register_t *sp, ir_graph *irg, ir_node *bl, ir_node *old_sp, ir_node *sz);
261 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);
264 * Make a stack pointer increase/decrease node.
265 * @param sp The stack pointer register.
266 * @param irg The graph to insert the node to.
267 * @param bl The block to insert the node into.
268 * @param old_sp The node defining the former stack pointer.
269 * @param amount The mount of bytes the stack shall be expanded/shrinked (see set_IncSP_offset)
270 * @param dir The direction in which the stack pointer shall be modified:
271 * Along the stack's growing direction or against.
272 * @return A new stack pointer increment/decrement node.
273 * @note This node sets a register constraint to the @p sp register on its output.
275 ir_node *be_new_IncSP(const arch_register_t *sp, ir_graph *irg, ir_node *bl, ir_node *old_sp, int offset);
277 /** Returns the previous node that computes the stack pointer. */
278 ir_node *be_get_IncSP_pred(ir_node *incsp);
280 /** Sets the previous node that computes the stack pointer. */
281 void be_set_IncSP_pred(ir_node *incsp, ir_node *pred);
284 * Sets a new offset to a IncSP node.
285 * A positive offset means expanding the stack, a negative offset shrinking
286 * an offset is == BE_STACK_FRAME_SIZE will be replaced by the real size of the
287 * stackframe in the fix_stack_offsets phase.
289 void be_set_IncSP_offset(ir_node *irn, int offset);
291 /** Gets the offset from a IncSP node. */
292 int be_get_IncSP_offset(const ir_node *irn);
294 /** Gets the call entity or NULL if this is no static call. */
295 ir_entity *be_Call_get_entity(const ir_node *call);
296 /** Sets the call entity. */
297 void be_Call_set_entity(ir_node *call, ir_entity *ent);
298 /** Gets the call type. */
299 ir_type *be_Call_get_type(ir_node *call);
300 /** Sets the call type. */
301 void be_Call_set_type(ir_node *call, ir_type *call_tp);
304 * Position numbers for the be_Call inputs.
307 be_pos_Call_mem = 0, /**< memory input of a be_Call node */
308 be_pos_Call_sp = 1, /**< stack pointer input of a be_Call node */
309 be_pos_Call_ptr = 2, /**< call pointer input of a be_Call node */
310 be_pos_Call_first_arg = 3 /**< first argument input of a be_Call node */
314 * Projection numbers for result of be_Call node: use for Proj nodes!
317 pn_be_Call_M_regular = pn_Call_M_regular, /**< The memory result of a be_Call. */
318 pn_be_Call_first_res = pn_Call_max /**< The first result proj number of a be_Call. */
322 * Construct a new be_Call
324 ir_node *be_new_Call(dbg_info *dbg, ir_graph *irg, ir_node *bl, ir_node *mem, ir_node *sp, ir_node *ptr,
325 int n_outs, int n, ir_node *in[], ir_type *call_tp);
328 * Position numbers for the be_Return inputs.
331 be_pos_Return_mem = 0, /**< memory input of a be_Return node */
332 be_pos_Return_sp = 1, /**< stack pointer input of a be_Return node */
333 be_pos_Return_val = 2, /**< first "real" return value if any */
337 * Construct a new be_Return.
338 * @param irg the graph where the new node will be placed
339 * @param bl the block where the new node will be placed
340 * @param n_res number of "real" results
341 * @param n number of inputs
342 * @param in input array
344 ir_node *be_new_Return(dbg_info *dbg, ir_graph *irg, ir_node *bl, int n_res, int n, ir_node *in[]);
346 /** Returns the number of real returns values */
347 int be_Return_get_n_rets(ir_node *ret);
349 /** appends a node to the return node, returns the position of the node */
350 int be_Return_append_node(ir_node *ret, ir_node *node);
353 * StackParam input positions
356 be_pos_StackParam_ptr = 0
360 * Construct a new Stack Parameter node.
362 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);
363 ir_node *be_new_RegParams(ir_graph *irg, ir_node *bl, int n_out);
365 ir_node *be_new_Barrier(ir_graph *irg, ir_node *bl, int n, ir_node *in[]);
368 * Appends a node to a barrier, returns the result proj of the node
370 ir_node *be_Barrier_append_node(ir_node *barrier, ir_node *node);
373 * Appends a register out requirement to a RegParams node
375 * @returns the proj node for the new register
377 ir_node *be_RegParams_append_out_reg(ir_node *regparams,
378 const arch_env_t *arch_env,
379 const arch_register_t *reg);
384 * @param arch_env The architecture environment.
385 * @param irn The node to be spilled.
386 * @param spill_ctx The context in which the spill is introduced (This is mostly == irn up to the case of Phis).
387 * @return The new spill node.
389 ir_node *be_spill(const arch_env_t *arch_env, ir_node *irn);
392 * Make a reload and insert it into the schedule.
394 * @param arch_env The architecture environment.
395 * @param cls The register class of the reloaded value.
396 * @param insert The node in the schedule in front of which the reload is inserted.
397 * @param mode The mode of the original (spilled) value.
398 * @param spill The spill node corresponding to this reload.
399 * @return A freshly made reload.
401 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);
404 be_pos_CopyKeep_op = 0
406 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);
407 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);
408 ir_node *be_get_CopyKeep_op(const ir_node *cpy);
409 void be_set_CopyKeep_op(ir_node *cpy, ir_node *op);
412 * Get the backend opcode of a backend node.
413 * @param irn The node.
414 * @return The backend opcode.
416 be_opcode_t be_get_irn_opcode(const ir_node *irn);
418 int be_is_Spill(const ir_node *irn);
419 int be_is_Reload(const ir_node *irn);
420 int be_is_Copy(const ir_node *irn);
421 int be_is_Perm(const ir_node *irn);
422 int be_is_MemPerm(const ir_node *irn);
423 int be_is_Keep(const ir_node *irn);
424 int be_is_CopyKeep(const ir_node *irn);
425 int be_is_Call(const ir_node *irn);
426 int be_is_Return(const ir_node *irn);
427 int be_is_IncSP(const ir_node *irn);
428 int be_is_SetSP(const ir_node *irn);
429 int be_is_AddSP(const ir_node *irn);
430 int be_is_SubSP(const ir_node *irn);
431 int be_is_RegParams(const ir_node *irn);
432 int be_is_StackParam(const ir_node *irn);
433 int be_is_FrameAddr(const ir_node *irn);
434 int be_is_FrameLoad(const ir_node *irn);
435 int be_is_FrameStore(const ir_node *irn);
436 int be_is_Barrier(const ir_node *irn);
439 * Try to avoid this function and better call arch_get_frame_entity!
441 * Returns 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);
490 * Set the register class 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 register class to set for that node and position.
495 void be_node_set_reg_class(ir_node *irn, int pos, const arch_register_class_t *cls);
498 * Set the register requirement type 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 requirement type to set for that node and position.
503 void be_node_set_req_type(ir_node *irn, int pos, arch_register_req_type_t type);
506 * Make a new phi handler.
507 * @param env The architecture environment.
508 * @return A new phi handler.
510 arch_irn_handler_t *be_phi_handler_new(const arch_env_t *arch_env);
513 * Free a phi handler.
514 * @param handler The handler to free.
516 void be_phi_handler_free(arch_irn_handler_t *handler);
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(arch_irn_handler_t *handler);
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.
539 extern const arch_irn_handler_t be_node_irn_handler;
541 #endif /* FIRM_BE_BENODE_T_H */