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_Barrier;
88 be_frame_flag_spill = 1,
89 be_frame_flag_local = 2,
94 * A "symbolic constant" for the size of the stack frame to use with IncSP nodes.
95 * It gets back-patched to the real size as soon it is known.
97 #define BE_STACK_FRAME_SIZE_EXPAND INT_MAX
98 #define BE_STACK_FRAME_SIZE_SHRINK INT_MIN
101 * Determines if irn is a be_node.
103 int is_be_node(const ir_node *irn);
106 * Create all BE specific opcodes.
108 void be_node_init(void);
111 * Position numbers for the be_Spill inputs.
114 be_pos_Spill_frame = 0,
119 * Make a new Spill node.
121 ir_node *be_new_Spill(const arch_register_class_t *cls, const arch_register_class_t *cls_frame,
122 ir_graph *irg, ir_node *bl, ir_node *frame, ir_node *to_spill);
125 * Position numbers for the be_Reload inputs.
128 be_pos_Reload_frame = 0,
129 be_pos_Reload_mem = 1
133 * Make a new Reload node.
135 ir_node *be_new_Reload(const arch_register_class_t *cls, const arch_register_class_t *cls_frame,
136 ir_graph *irg, ir_node *bl, ir_node *frame, ir_node *mem, ir_mode *mode);
139 * Position numbers for the be_Copy inputs.
146 * Make a new Copy node.
148 ir_node *be_new_Copy(const arch_register_class_t *cls, ir_graph *irg, ir_node *block, ir_node *in);
149 /** Returns the Copy Argument. */
150 ir_node *be_get_Copy_op(const ir_node *cpy);
151 /** Sets the Copy Argument. */
152 void be_set_Copy_op(ir_node *cpy, ir_node *op);
155 * Make a new Perm node.
157 ir_node *be_new_Perm(const arch_register_class_t *cls, ir_graph *irg, ir_node *bl, int arity, ir_node *in[]);
161 * Basically, we provide a map to remap the Perm's arguments. If an entry in the
162 * map is -1, the argument gets deleted.
163 * This function takes care, that the register data and the input array reflects
164 * the changes described by the map.
165 * This is needed by the Perm optimization/movement in belower.c, see push_through_perm().
166 * @param perm The perm node.
167 * @param new_size The new number of arguments (must be smaller or equal to the current one).
168 * @param map A map assigning each operand a new index (or -1 to indicate deletion).
170 void be_Perm_reduce(ir_node *perm, int new_size, int *map);
173 * Create a new MemPerm node.
175 ir_node *be_new_MemPerm(const arch_env_t *arch_env, ir_graph *irg, ir_node *bl, int n, ir_node *in[]);
176 ir_node *be_new_Keep(const arch_register_class_t *cls, ir_graph *irg, ir_node *bl, int arity, ir_node *in[]);
178 void be_Keep_add_node(ir_node *keep, const arch_register_class_t *cls, ir_node *node);
181 * Position numbers for the be_FrameLoad inputs
184 be_pos_FrameLoad_mem = 0,
185 be_pos_FrameLoad_ptr = 1
188 ir_node *be_new_FrameLoad(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_entity *ent);
192 * Position numbers for the be_FrameStore inputs
195 be_pos_FrameStore_mem = 0,
196 be_pos_FrameStore_ptr = 1,
197 be_pos_FrameStore_val = 2
200 ir_node *be_new_FrameStore(const arch_register_class_t *cls_frame, const arch_register_class_t *cls_data,
201 ir_graph *irg, ir_node *bl, ir_node *mem, ir_node *frame, ir_node *data, ir_entity *ent);
204 * Position numbers for the be_FrameAddr inputs
207 be_pos_FrameAddr_ptr = 0
210 /** Create a new FrameAddr node. */
211 ir_node *be_new_FrameAddr(const arch_register_class_t *cls_frame, ir_graph *irg, ir_node *bl, ir_node *frame, ir_entity *ent);
213 /** Return the frame input of a FrameAddr node. */
214 ir_node *be_get_FrameAddr_frame(ir_node *node);
217 * Position numbers for the be_AddSP inputs
220 be_pos_AddSP_old_sp = 0,
221 be_pos_AddSP_size = 1,
222 be_pos_AddSP_last = 2
233 * Make a new AddSP node.
234 * An AddSP node expresses an increase of the stack pointer in the direction the stack
235 * grows. In contrast to IncSP, the amount of bytes the stack pointer is grown, is not
236 * given by a constant but an ordinary Firm node.
237 * @param sp The stack pointer register.
238 * @param irg The graph.
239 * @param bl The block.
240 * @param old_sp The node representing the old stack pointer value.
241 * @param sz The node expressing the size by which the stack pointer shall be grown.
242 * @return A new AddSP node.
244 ir_node *be_new_AddSP(const arch_register_t *sp, ir_graph *irg, ir_node *bl, ir_node *old_sp, ir_node *sz);
247 * Position numbers for the be_SubSP inputs
250 be_pos_SubSP_old_sp = 0,
251 be_pos_SubSP_size = 1,
252 be_pos_SubSP_last = 2
262 * Make a new SubSP node.
263 * A SubSP node expresses a decrease of the stack pointer in the direction the stack
264 * grows. In contrast to IncSP, the amount of bytes the stack pointer is grown, is not
265 * given by a constant but an ordinary Firm node.
266 * @param sp The stack pointer register.
267 * @param irg The graph.
268 * @param bl The block.
269 * @param old_sp The node representing the old stack pointer value.
270 * @param sz The node expressing the size by which the stack pointer shall be grown.
271 * @return A new DecSP node.
273 ir_node *be_new_SubSP(const arch_register_t *sp, ir_graph *irg, ir_node *bl, ir_node *old_sp, ir_node *sz);
275 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);
278 * Make a stack pointer increase/decrease node.
279 * @param sp The stack pointer register.
280 * @param irg The graph to insert the node to.
281 * @param bl The block to insert the node into.
282 * @param old_sp The node defining the former stack pointer.
283 * @param amount The mount of bytes the stack shall be expanded/shrinked (see set_IncSP_offset)
284 * @param dir The direction in which the stack pointer shall be modified:
285 * Along the stack's growing direction or against.
286 * @return A new stack pointer increment/decrement node.
287 * @note This node sets a register constraint to the @p sp register on its output.
289 ir_node *be_new_IncSP(const arch_register_t *sp, ir_graph *irg, ir_node *bl, ir_node *old_sp, int offset);
291 /** Returns the previous node that computes the stack pointer. */
292 ir_node *be_get_IncSP_pred(ir_node *incsp);
294 /** Sets the previous node that computes the stack pointer. */
295 void be_set_IncSP_pred(ir_node *incsp, ir_node *pred);
298 * Sets a new offset to a IncSP node.
299 * A positive offset means expanding the stack, a negative offset shrinking
300 * an offset is == BE_STACK_FRAME_SIZE will be replaced by the real size of the
301 * stackframe in the fix_stack_offsets phase.
303 void be_set_IncSP_offset(ir_node *irn, int offset);
305 /** Gets the offset from a IncSP node. */
306 int be_get_IncSP_offset(const ir_node *irn);
308 /** Gets the call entity or NULL if this is no static call. */
309 ir_entity *be_Call_get_entity(const ir_node *call);
310 /** Sets the call entity. */
311 void be_Call_set_entity(ir_node *call, ir_entity *ent);
312 /** Gets the call type. */
313 ir_type *be_Call_get_type(ir_node *call);
314 /** Sets the call type. */
315 void be_Call_set_type(ir_node *call, ir_type *call_tp);
318 * Position numbers for the be_Call inputs.
321 be_pos_Call_mem = 0, /**< memory input of a be_Call node */
322 be_pos_Call_sp = 1, /**< stack pointer input of a be_Call node */
323 be_pos_Call_ptr = 2, /**< call pointer input of a be_Call node */
324 be_pos_Call_first_arg = 3 /**< first argument input of a be_Call node */
328 * Projection numbers for result of be_Call node: use for Proj nodes!
331 pn_be_Call_M_regular = pn_Call_M_regular, /**< The memory result of a be_Call. */
332 pn_be_Call_first_res = pn_Call_max /**< The first result proj number of a be_Call. */
336 * Construct a new be_Call.
338 * @param dbg debug info
339 * @param irg the graph where the call is placed
340 * @param bl the block where the call is placed
341 * @param mem the memory input of the call
342 * @param sp the stack pointer input of the call
343 * @param ptr the address of the called function, if immediate call set to sp
344 * @param n_outs the number of outcoming values from this call
345 * @param n the number of (register) inputs of this call
346 * @param in the (register) inputs of this call
347 * @param call_tp the call type of this call
349 ir_node *be_new_Call(dbg_info *dbg, ir_graph *irg, ir_node *bl, ir_node *mem, ir_node *sp, ir_node *ptr,
350 int n_outs, int n, ir_node *in[], ir_type *call_tp);
353 * Position numbers for the be_Return inputs.
356 be_pos_Return_mem = 0, /**< memory input of a be_Return node */
357 be_pos_Return_sp = 1, /**< stack pointer input of a be_Return node */
358 be_pos_Return_val = 2, /**< first "real" return value if any */
362 * Construct a new be_Return.
363 * @param irg the graph where the new node will be placed
364 * @param bl the block where the new node will be placed
365 * @param n_res number of "real" results
366 * @param n number of inputs
367 * @param in input array
369 ir_node *be_new_Return(dbg_info *dbg, ir_graph *irg, ir_node *bl, int n_res, int n, ir_node *in[]);
371 /** Returns the number of real returns values */
372 int be_Return_get_n_rets(ir_node *ret);
374 /** appends a node to the return node, returns the position of the node */
375 int be_Return_append_node(ir_node *ret, ir_node *node);
378 * StackParam input positions
381 be_pos_StackParam_ptr = 0
385 * Construct a new Stack Parameter node.
387 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);
388 ir_node *be_new_RegParams(ir_graph *irg, ir_node *bl, int n_out);
390 ir_node *be_new_Barrier(ir_graph *irg, ir_node *bl, int n, ir_node *in[]);
393 * Appends a node to a barrier, returns the result proj of the node
395 ir_node *be_Barrier_append_node(ir_node *barrier, ir_node *node);
398 * Appends a register out requirement to a RegParams node
400 * @returns the proj node for the new register
402 ir_node *be_RegParams_append_out_reg(ir_node *regparams,
403 const arch_env_t *arch_env,
404 const arch_register_t *reg);
409 * @param arch_env The architecture environment.
410 * @param irn The node to be spilled.
411 * @param spill_ctx The context in which the spill is introduced (This is mostly == irn up to the case of Phis).
412 * @return The new spill node.
414 ir_node *be_spill(const arch_env_t *arch_env, ir_node *irn);
417 * Make a reload and insert it into the schedule.
419 * @param arch_env The architecture environment.
420 * @param cls The register class of the reloaded value.
421 * @param insert The node in the schedule in front of which the reload is inserted.
422 * @param mode The mode of the original (spilled) value.
423 * @param spill The spill node corresponding to this reload.
424 * @return A freshly made reload.
426 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);
429 be_pos_CopyKeep_op = 0
431 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);
432 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);
433 ir_node *be_get_CopyKeep_op(const ir_node *cpy);
434 void be_set_CopyKeep_op(ir_node *cpy, ir_node *op);
437 * Get the backend opcode of a backend node.
438 * @param irn The node.
439 * @return The backend opcode.
441 be_opcode_t be_get_irn_opcode(const ir_node *irn);
443 int be_is_Spill(const ir_node *irn);
444 int be_is_Reload(const ir_node *irn);
445 int be_is_Copy(const ir_node *irn);
446 int be_is_Perm(const ir_node *irn);
447 int be_is_MemPerm(const ir_node *irn);
448 int be_is_Keep(const ir_node *irn);
449 int be_is_CopyKeep(const ir_node *irn);
450 int be_is_Call(const ir_node *irn);
451 int be_is_Return(const ir_node *irn);
452 int be_is_IncSP(const ir_node *irn);
453 int be_is_SetSP(const ir_node *irn);
454 int be_is_AddSP(const ir_node *irn);
455 int be_is_SubSP(const ir_node *irn);
456 int be_is_RegParams(const ir_node *irn);
457 int be_is_StackParam(const ir_node *irn);
458 int be_is_FrameAddr(const ir_node *irn);
459 int be_is_FrameLoad(const ir_node *irn);
460 int be_is_FrameStore(const ir_node *irn);
461 int be_is_Barrier(const ir_node *irn);
464 * Try to avoid this function and better call arch_get_frame_entity!
466 * Returns the frame entity used by the be node
468 ir_entity *be_get_frame_entity(const ir_node *irn);
471 * Returns the frame offset of this node.
473 int be_get_frame_offset(const ir_node *irn);
475 ir_node* be_get_Reload_mem(const ir_node *irn);
476 ir_node *be_get_Reload_frame(const ir_node *irn);
477 ir_node* be_get_Spill_val(const ir_node *irn);
478 ir_node *be_get_Spill_frame(const ir_node *irn);
480 void be_set_MemPerm_in_entity(const ir_node *irn, int n, ir_entity* ent);
481 ir_entity *be_get_MemPerm_in_entity(const ir_node *irn, int n);
483 void be_set_MemPerm_out_entity(const ir_node *irn, int n, ir_entity* ent);
484 ir_entity *be_get_MemPerm_out_entity(const ir_node *irn, int n);
486 int be_get_MemPerm_entity_arity(const ir_node *irn);
489 * Impose a register constraint on a backend node.
490 * @param irn The node.
491 * @param pos The position of the argument/result. Results range from -1..-m and arguments form 0..n
492 * @param reg The register which is admissible for that node, argument/result and position.
494 void be_set_constr_single_reg(ir_node *irn, int pos, const arch_register_t *reg);
497 * Impose register constraints on a backend node.
498 * The register subsets given by the limited function in @p req are copied to the backend node.
499 * This requires that the constraint type of the @p req is arch_register_req_type_limited.
500 * @param irn The backend node.
501 * @param pos The position (@see be_set_constr_single_reg()).
502 * @param req The register requirements which shall be transferred.
504 void be_set_constr_limited(ir_node *irn, int pos, const arch_register_req_t *req);
507 * Set the flags of a node.
508 * @param irn The node itself.
509 * @param pos The position (0..n) for arguments, (-1..-m) for results.
510 * @param flags The flags to set for that node and position.
512 void be_node_set_flags(ir_node *irn, int pos, arch_irn_flags_t flags);
515 * Set the register class of a node.
516 * @param irn The node itself.
517 * @param pos The position (0..n) for arguments, (-1..-m) for results.
518 * @param flags The register class to set for that node and position.
520 void be_node_set_reg_class(ir_node *irn, int pos, const arch_register_class_t *cls);
523 * Set the register requirement type of a node.
524 * @param irn The node itself.
525 * @param pos The position (0..n) for arguments, (-1..-m) for results.
526 * @param flags The register requirement type to set for that node and position.
528 void be_node_set_req_type(ir_node *irn, int pos, arch_register_req_type_t type);
531 * Make a new phi handler.
532 * @param env The architecture environment.
533 * @return A new phi handler.
535 arch_irn_handler_t *be_phi_handler_new(const arch_env_t *arch_env);
538 * Free a phi handler.
539 * @param handler The handler to free.
541 void be_phi_handler_free(arch_irn_handler_t *handler);
544 * Reset the register data in the phi handler.
545 * This should be called on each new graph and deletes the register information of the current graph.
547 void be_phi_handler_reset(arch_irn_handler_t *handler);
550 * Set the register requirements for a phi node.
552 void be_set_phi_reg_req(const arch_env_t *arch_env, ir_node *phi,
553 const arch_register_req_t *req);
556 * Set flags for a phi node
558 void be_set_phi_flags(const arch_env_t *arch_env, ir_node *phi,
559 arch_irn_flags_t flags);
562 * irn handler for common be nodes.
564 extern const arch_irn_handler_t be_node_irn_handler;
566 #endif /* FIRM_BE_BENODE_T_H */