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 Representation of an intermediate operation.
23 * @author Martin Trapp, Christian Schaefer, Goetz Lindenmaier, Michael Beck
25 #ifndef FIRM_IR_IRNODE_H
26 #define FIRM_IR_IRNODE_H
30 #include "firm_common.h"
39 * @defgroup ir_node Nodes
41 * ir_node - a datatype representing a Firm node
43 * The common fields are:
45 * - arity - The number of predecessors in the Firm graph.
46 * - in - A list with the predecessors in the Firm graph. There are
47 * routines to access individual elements and to obtain the
48 * array. The method returning the array should not be used.
49 * - mode - The mode of the node. There are routines to get the mode
50 * but also to access the mode's fields directly.
51 * - opcode - The opcode of the node. There are routines to get the opcode
52 * but also to access the opcode's fields directly.
53 * - node_nr - A unique number for the node. Available only if debugging
59 * Checks whether a pointer points to a ir node. This is guessed by looking
60 * at the few bytes of the thing. Most things used in firm have a firm_kind
61 * attribute there. This function might falsely return true though for things
62 * without a firm_kind at the beginning.
64 * @param thing an arbitrary pointer
65 * @return non-zero if the thing is a ir mode, else zero
67 FIRM_API int is_ir_node(const void *thing);
70 * Returns the number of predecessors without the block predecessor.
72 * @param node the IR-node
74 FIRM_API int get_irn_arity(const ir_node *node);
77 * Returns the n-th predecessor of a node.
78 * This function removes Id predecessors.
80 FIRM_API ir_node *get_irn_n(const ir_node *node, int n);
83 * Replaces the old in array by a new one that will contain the ins given in
84 * the parameters. Conserves the block predecessor. It copies the array passed.
85 * This function is necessary to adjust in arrays of blocks, calls and phis.
86 * Assumes that current_ir_graph is set to the graph containing "node".
87 * "in" must contain all predecessors except the block that are required for
88 * the nodes opcode. */
89 FIRM_API void set_irn_in(ir_node *node, int arity, ir_node *in[]);
92 * Add a artificial dependency to the node.
93 * The dependency is only inserted if it is not there already.
94 * This is only allowed in phase_backend!
96 * @param node The node.
97 * @param dep The dependency target.
99 * @return The index in the array (get_irn_dep with that index returns @p dep).
101 FIRM_API int add_irn_dep(ir_node *node, ir_node *dep);
104 * Copy all dependencies from a node to another.
105 * This is only allowed in phase_backend!
107 * @param tgt The node which should be enriched.
108 * @param src The node whose dependencies shall be copied.
110 FIRM_API void add_irn_deps(ir_node *tgt, ir_node *src);
113 * Returns the length of the dependency array.
114 * @param node The node.
115 * @return The length of the dependency array or 0 if it has not yet been allocated.
117 FIRM_API int get_irn_deps(const ir_node *node);
120 * Returns an entry of the dependency array.
121 * @param node The node.
122 * @param pos The position.
123 * @return The node at that position.
125 FIRM_API ir_node *get_irn_dep(const ir_node *node, int pos);
128 * Sets an entry of the dependency array.
129 * @param node The node.
130 * @param pos The position.
131 * @param dep The dependency target.
133 FIRM_API void set_irn_dep(ir_node *node, int pos, ir_node *dep);
135 /** Replaces the n-th predecessor of a node with a new one. */
136 FIRM_API void set_irn_n(ir_node *node, int n, ir_node *in);
138 * Appends a new predecessor to a node. This only works for nodes with
140 * @returns the number of the new input
142 FIRM_API int add_irn_n(ir_node *node, ir_node *in);
143 /** Sets the mode struct of node. */
144 FIRM_API void set_irn_mode(ir_node *node, ir_mode *mode);
145 /** Returns the mode struct of a node. */
146 FIRM_API ir_mode *get_irn_mode(const ir_node *node);
147 /** Returns the opcode struct of the node. */
148 FIRM_API ir_op *get_irn_op(const ir_node *node);
149 /** Sets the opcode struct of the node. */
150 FIRM_API void set_irn_op(ir_node *node, ir_op *op);
151 /** Returns the opcode-enum of the node. */
152 FIRM_API unsigned get_irn_opcode(const ir_node *node);
153 /** Returns the string representation of the opcode. */
154 FIRM_API const char *get_irn_opname(const ir_node *node);
155 /** Returns the ident for a string representation of the opcode. */
156 FIRM_API ident *get_irn_opident(const ir_node *node);
157 /** If arg is an argument of the node, returns its position, -1 otherwise */
158 FIRM_API int get_irn_pred_pos(ir_node *node, ir_node *arg);
159 /** Returns the visited counter of a node. */
160 FIRM_API ir_visited_t get_irn_visited(const ir_node *node);
161 /** Sets the visited counter of a node. */
162 FIRM_API void set_irn_visited(ir_node *node, ir_visited_t visited);
163 /** Sets visited to get_irg_visited(current_ir_graph). */
164 FIRM_API void mark_irn_visited(ir_node *node);
165 /** Returns 1 if visited >= get_irg_visited(current_ir_graph). */
166 FIRM_API int irn_visited(const ir_node *node);
167 /** Returns 1 if visited >= get_irg_visited(current_ir_graph). Marks the node
168 * visited, if it was not. */
169 FIRM_API int irn_visited_else_mark(ir_node *node);
172 * Sets the link of a node.
173 * Only allowed if the graph is NOT in phase_building.
175 FIRM_API void set_irn_link(ir_node *node, void *link);
177 /** Returns the link of a node. */
178 FIRM_API void *get_irn_link(const ir_node *node);
180 /** Returns the ir_graph this node belongs to. */
181 FIRM_API ir_graph *get_irn_irg(const ir_node *node);
183 /** Outputs a unique number for this node if libFIRM is compiled for
184 debugging, (configure with --enable-debug) else returns address
185 of node cast to long. */
186 FIRM_API long get_irn_node_nr(const ir_node *node);
188 /** Returns the pinned state of a node.
190 * Returns whether the node _always_ must be pinned.
191 * I.e., the node is not floating after global cse.
193 * @returns Either state op_pin_state_pinned or op_pin_state_floats.
195 FIRM_API op_pin_state get_irn_pinned(const ir_node *node);
197 /** Sets pin state for nodes with op pin state op_pin_state_exc_pinned */
198 FIRM_API void set_irn_pinned(ir_node *node, op_pin_state state);
200 /** Returns whether the node is currently pinned.
202 * If get_irn_pinned returns op_pin_state_floats and the graph the
203 * node belongs to is in state op_poin_state_floats then this function
204 * returns 'floats', else 'pinned'.
206 FIRM_API op_pin_state is_irn_pinned_in_irg(const ir_node *node);
209 * IR node constructor.
210 * Create a new IR node in irg, with an op, mode, arity and
211 * some incoming IR nodes.
212 * This constructor is used in every specific IR node constructor.
214 * @param db Debug info.
215 * @param irg IR-graph on with this new node should be constructed.
216 * @param block The block the new node belongs to
217 * @param op The opcode of the new node.
218 * @param mode The mode of the new node.
219 * @param arity The arity of the new node, <0 if can be changed dynamically.
220 * @param in An array of arity predecessor nodes.
222 FIRM_API ir_node *new_ir_node(dbg_info *db, ir_graph *irg, ir_node *block,
223 ir_op *op, ir_mode *mode,
224 int arity, ir_node *const *in);
232 * Returns the block the node belongs to. This is only
233 * possible for pinned nodes or if the graph is in pinned state.
234 * Otherwise the block may be incorrect. This condition is
235 * now checked by an assertion.
237 * This works for all except Block. It can return Blocks or the Bad node.
239 * To express the difference to access routines that work for all
240 * nodes we use infix "nodes" and do not name this function
241 * get_irn_block(). */
242 FIRM_API ir_node *get_nodes_block(const ir_node *node);
244 /** Sets the Block of a node. */
245 FIRM_API void set_nodes_block(ir_node *node, ir_node *block);
247 /** Returns the number of control flow predecessors of a block. */
248 FIRM_API int get_Block_n_cfgpreds(const ir_node *block);
249 /** Returns the control flow predecessor of a block at a given position. */
250 FIRM_API ir_node *get_Block_cfgpred(const ir_node *block, int pos);
251 /** Sets the control flow predecessor of a block at a given position. */
252 FIRM_API void set_Block_cfgpred(ir_node *block, int pos, ir_node *pred);
255 * Returns the position of the predecessor block pred in the inputs
256 * of the block block.
258 * @param block the block
259 * @param pred a predecessor block of block
261 * @return the position of pred in block or -1
263 * @note When using the old extended basic block form for blocks
264 * with exception exists, a predecessor block might have more
265 * than one position. In that case it is not specified, with is returned.
267 FIRM_API int get_Block_cfgpred_pos(const ir_node *block, const ir_node *pred);
269 /** Returns the predecessor block.
271 * Returns the block corresponding to the predecessor pos of block.
273 * There are several ambiguities we resolve with this function:
274 * - The direct predecessor can be a Proj, which is not pinned.
275 * We walk from the predecessor to the next pinned node
276 * (skip_Proj) and return the block that node is in.
277 * - If we encounter the Bad node, this function does not return
278 * Start block, but the Bad node.
280 FIRM_API ir_node *get_Block_cfgpred_block(const ir_node *node, int pos);
282 /** Returns the matured flag of a block */
283 FIRM_API int get_Block_matured(const ir_node *block);
284 /** set the matured flag of a block. */
285 FIRM_API void set_Block_matured(ir_node *block, int matured);
287 /** A visited flag only for block nodes.
288 * @see also: get_irn_visited() inc_irg_visited() inc_irg_block_visited()*/
289 FIRM_API ir_visited_t get_Block_block_visited(const ir_node *block);
290 /** set block visited flag */
291 FIRM_API void set_Block_block_visited(ir_node *block, ir_visited_t visit);
293 /** Marks a block as visited by setting its visited counter */
294 FIRM_API void mark_Block_block_visited(ir_node *node);
295 /** Returns 1 if a block is marked as visited */
296 FIRM_API int Block_block_visited(const ir_node *node);
298 /** Returns the extended basic block a block belongs to. */
299 FIRM_API ir_extblk *get_Block_extbb(const ir_node *block);
300 /** Sets the extended basic block a block belongs to. */
301 FIRM_API void set_Block_extbb(ir_node *block, ir_extblk *extblk);
302 /** Returns the ir_graph this Block belongs to. */
303 FIRM_API ir_graph *get_Block_irg(const ir_node *block);
304 /** Returns the entity for a Block (creating it if necessary) */
305 FIRM_API ir_entity *create_Block_entity(ir_node *block);
306 /** Returns the head of the Phi list for this block. */
307 FIRM_API ir_node *get_Block_phis(const ir_node *block);
308 /** Sets the head of the Phi list for this block. */
309 FIRM_API void set_Block_phis(ir_node *block, ir_node *phi);
310 /** Add a Phi node to the list of Block Phi's. */
311 FIRM_API void add_Block_phi(ir_node *block, ir_node *phi);
312 /** Returns the Block mark (single bit). */
313 FIRM_API unsigned get_Block_mark(const ir_node *block);
314 /** Sets the Block mark (single bit). */
315 FIRM_API void set_Block_mark(ir_node *block, unsigned mark);
319 /** Tests whether arbitrary node is frame pointer.
321 * Tests whether arbitrary node is frame pointer, i.e. Proj(pn_Start_P_frame_base)
322 * from Start. If so returns frame type, else Null. */
323 FIRM_API ir_type *is_frame_pointer(const ir_node *n);
329 /** Returns the number of Keep alive node. */
330 FIRM_API int get_End_n_keepalives(const ir_node *end);
331 /** Returns the Keep alive node a position pos. */
332 FIRM_API ir_node *get_End_keepalive(const ir_node *end, int pos);
333 /** Keep alive dedicated nodes. These must be either PhiM or Block nodes. */
334 FIRM_API void add_End_keepalive(ir_node *end, ir_node *ka);
335 /** Sets the Keep alive node at position pos. */
336 FIRM_API void set_End_keepalive(ir_node *end, int pos, ir_node *ka);
339 * Sets new keep-alives.
340 * Beware: This might be an expensive operation if dynamic edges are enabled,
341 * so avoid it in the backend.
343 FIRM_API void set_End_keepalives(ir_node *end, int n, ir_node *in[]);
345 /** Removes irn from the keep-alive set. */
346 FIRM_API void remove_End_keepalive(ir_node *end, ir_node *irn);
348 /** Removes Bads, NoMem and doublets from the keep-alive set. */
349 FIRM_API void remove_End_Bads_and_doublets(ir_node *end);
351 /** Some parts of the End node are allocated separately -- their memory
352 * is not recovered by dead_node_elimination if a End node is dead.
353 * free_End() frees these data structures.
355 FIRM_API void free_End(ir_node *end);
359 /** @addtogroup Return
363 /** Returns return value inputs of Return node @p node as array. */
364 FIRM_API ir_node **get_Return_res_arr(ir_node *node);
365 /** Returns number of return value inputs of Return node @p node. */
366 FIRM_API size_t get_Return_n_ress(const ir_node *node);
367 /** Returns return value input @p pos of Return node @p node. */
368 FIRM_API ir_node *get_Return_res(const ir_node *node, int pos);
369 /** Sets return value input @p pos of Return node @p node to value @p res. */
370 FIRM_API void set_Return_res(ir_node *node, int pos, ir_node *res);
374 /** @addtogroup Const
378 /** Returns non-zero if the given Const node represents the 0 constant. */
379 FIRM_API int is_Const_null(const ir_node *node);
381 /** Returns non-zero if the given Const node represents the 1 constant. */
382 FIRM_API int is_Const_one(const ir_node *node);
384 /** Returns non-zero if the given Const node represents the constant with all bits set. */
385 FIRM_API int is_Const_all_one(const ir_node *node);
391 * Returns true if a node is a Conv node with strict attribute set.
393 FIRM_API int is_strictConv(const ir_node *node);
396 * @addtogroup SymConst
401 * Returns true if node is a SymConst node with kind symconst_addr_ent.
403 FIRM_API int is_SymConst_addr_ent(const ir_node *node);
405 /** Returns non-zero if s symconst kind has a type attribute */
406 #define SYMCONST_HAS_TYPE(kind) ((kind) <= symconst_type_align)
408 /** Returns non-zero if s symconst kind has an entity attribute */
409 #define SYMCONST_HAS_ENT(kind) ((kind) == symconst_addr_ent || (kind) == symconst_ofs_ent)
411 /** Returns non-zero if s symconst kind has an enum_const attribute */
412 #define SYMCONST_HAS_ENUM(kind) ((kind) == symconst_enum_const)
414 /** Returns the kind of the SymConst. */
415 FIRM_API symconst_kind get_SymConst_kind(const ir_node *node);
416 /** Sets the kind of the SymConst. */
417 FIRM_API void set_SymConst_kind(ir_node *node, symconst_kind num);
419 /** Returns the type attribute of SymConst node @p node.
420 * @note Only to access SymConst of kind type_siz, else assertion.
422 FIRM_API ir_type *get_SymConst_type(const ir_node *node);
423 /** Sets the type attribute of SymConst node @p node. */
424 FIRM_API void set_SymConst_type(ir_node *node, ir_type *tp);
426 /** Returns the entity attribute of SymConst node @p node.
427 * @note Only to access SymConst of kind addr_ent, else assertion.
429 FIRM_API ir_entity *get_SymConst_entity(const ir_node *node);
430 /** Sets the entity attribute of Symconst node @p node. */
431 FIRM_API void set_SymConst_entity(ir_node *node, ir_entity *ent);
433 /** Returns the enum attribute of SymConst node @p node.
434 * Only to access SymConst of kind symconst_enum_const, else assertion
436 FIRM_API ir_enum_const *get_SymConst_enum(const ir_node *node);
437 /** Sets the enum attribute of SymConst node @p node. */
438 FIRM_API void set_SymConst_enum(ir_node *node, ir_enum_const *ec);
440 /** Returns the symbol attribute of SymConst node @p node. */
441 FIRM_API union symconst_symbol get_SymConst_symbol(const ir_node *node);
442 /** Sets the symbol attribute of SymConst node @p node. */
443 FIRM_API void set_SymConst_symbol(ir_node *node, union symconst_symbol sym);
451 /** Returns index inputs of Sel node @p node as array. */
452 FIRM_API ir_node **get_Sel_index_arr(ir_node *node);
453 /** Returns number of index inputs of Sel node @p node. */
454 FIRM_API int get_Sel_n_indexs(const ir_node *node);
455 /** Returns value of index input @p pos of Sel node @p node. */
456 FIRM_API ir_node *get_Sel_index(const ir_node *node, int pos);
457 /** Sets @p index as index input @p pos of Sel node @p node. */
458 FIRM_API void set_Sel_index(ir_node *node, int pos, ir_node *index);
466 /** Returns parameter inputs of Call node @p node as array. */
467 FIRM_API ir_node **get_Call_param_arr(ir_node *node);
468 /** Returns the number of parameters of a call. */
469 FIRM_API size_t get_Call_n_params(const ir_node *node);
470 /** Returns the call parameter at position pos. */
471 FIRM_API ir_node *get_Call_param(const ir_node *node, int pos);
472 /** Sets the call parameter at position pos. */
473 FIRM_API void set_Call_param(ir_node *node, int pos, ir_node *param);
475 /** Sets, get and remove the callee information for a Call node.
477 * The callee information lists all method entities that can be called
478 * from this node. If the address expression can not be analyzed fully,
479 * e.g., as entities can be called that are not in the compilation unit,
480 * the array contains the unknown_entity. The array contains only entities
481 * with peculiarity_existent, but with all kinds of visibility. The entities
482 * not necessarily contain an irg.
484 * The array is only accessible if callee information is valid. See flag
487 * The memory allocated for the array is managed automatically, i.e., it must
488 * not be freed if the Call node is removed from the graph.
490 * @param node A Call node.
492 FIRM_API int Call_has_callees(const ir_node *node);
493 /** Returns the number of callees of Call node @p node. */
494 FIRM_API size_t get_Call_n_callees(const ir_node *node);
495 /** Returns callee number @p pos of Call node @p node. */
496 FIRM_API ir_entity *get_Call_callee(const ir_node *node, size_t pos);
498 /** Sets the full callee array.
500 * The passed array is copied. Assumes current_ir_graph set properly! */
501 FIRM_API void set_Call_callee_arr(ir_node *node, size_t n, ir_entity **arr);
502 /** Frees callee array of call node @p node */
503 FIRM_API void remove_Call_callee_arr(ir_node *node);
507 /** @addtogroup Builtin
511 /** Returns the parameter inputs of Builtin node @p node as array. */
512 FIRM_API ir_node **get_Builtin_param_arr(ir_node *node);
513 /** Returns the number of parameters of a Builtin. */
514 FIRM_API int get_Builtin_n_params(const ir_node *node);
515 /** Returns the Builtin parameter at position pos. */
516 FIRM_API ir_node *get_Builtin_param(const ir_node *node, int pos);
517 /** Sets the Builtin parameter at position pos. */
518 FIRM_API void set_Builtin_param(ir_node *node, int pos, ir_node *param);
522 /** Returns a human readable string for the ir_builtin_kind. */
523 FIRM_API const char *get_builtin_kind_name(ir_builtin_kind kind);
525 /** Tests whether node is an unary operation (opcode arity is #oparity_unary)
526 * @returns 1 if @p node is an unary operation, 0 otherwise
528 FIRM_API int is_unop(const ir_node *node);
529 /** Returns (arithmetic) operand of unary operation @p node. */
530 FIRM_API ir_node *get_unop_op(const ir_node *node);
531 /** Sets (arithmetic) operand of unary operation @p node. */
532 FIRM_API void set_unop_op(ir_node *node, ir_node *op);
534 /** Tests whether node is a binary operation (opcode arity is #oparity_binary)
535 * @returns 1 if @p node is an binary operation, 0 otherwise
537 FIRM_API int is_binop(const ir_node *node);
538 /** Returns left operand of binary operation @p node. */
539 FIRM_API ir_node *get_binop_left(const ir_node *node);
540 /** Sets left operand of binary operation @p node. */
541 FIRM_API void set_binop_left(ir_node *node, ir_node *left);
542 /** Returns rights operand of binary operation @p node. */
543 FIRM_API ir_node *get_binop_right(const ir_node *node);
544 /** Sets right operand of binary operation @p node. */
545 FIRM_API void set_binop_right(ir_node *node, ir_node *right);
548 * Tests whether a node is the X_except Proj of a fragile operation
550 FIRM_API int is_x_except_Proj(const ir_node *node);
553 * Tests whether a node is the X_regular Proj of a fragile operation
555 FIRM_API int is_x_regular_Proj(const ir_node *node);
558 * Sets throws exception attribute of a fragile node
559 * @p throws_exception must be 0 or 1
561 FIRM_API void ir_set_throws_exception(ir_node *node, int throws_exception);
563 /** Returns throws_exception attribute of a fragile node */
564 FIRM_API int ir_throws_exception(const ir_node *node);
566 /** Returns the name of an ir_relation */
567 FIRM_API const char *get_relation_string(ir_relation relation);
569 /** Calculates the negated (Complement(R)) relation, i.e. "<" --> ">=" */
570 FIRM_API ir_relation get_negated_relation(ir_relation relation);
572 /** Calculates the inversed (R^-1) relation, i.e., "<" --> ">" */
573 FIRM_API ir_relation get_inversed_relation(ir_relation relation);
580 /** Checks for upcast.
582 * Returns true if the Cast node casts a class type to a super type.
583 * Works also for pointers to classes (recursively).
585 * Needs typeinfo calculated.
587 FIRM_API int is_Cast_upcast(ir_node *node);
589 /** Checks for downcast.
591 * Returns true if the Cast node casts a class type to a sub type.
592 * Works also for pointers to classes (recursively).
594 * Needs typeinfo calculated.
596 FIRM_API int is_Cast_downcast(ir_node *node);
606 * Returns 1 if irg in phase phase_building and the Phi has zero
607 * predecessors. It's a "Phi0" then.
609 FIRM_API int is_Phi0(const ir_node *n);
611 * Returns all phi predecessors as array
613 FIRM_API ir_node **get_Phi_preds_arr(ir_node *node);
615 * Returns number of predecessors of phi node @p node
617 FIRM_API int get_Phi_n_preds(const ir_node *node);
619 * Returns the predecessor with number @p pos of phi node @p node.
620 * This is the value selected when control flow comes from predecessor @p pos
621 * of the containing basic block.
623 FIRM_API ir_node *get_Phi_pred(const ir_node *node, int pos);
625 * Sets value @p pred as predecessor number @p pos of phi node @p node.
627 FIRM_API void set_Phi_pred(ir_node *node, int pos, ir_node *pred);
629 * Returns the next element of a block phi list.
631 FIRM_API ir_node *get_Phi_next(const ir_node *phi);
633 * Sets the next link of a block Phi list.
635 FIRM_API void set_Phi_next(ir_node *phi, ir_node *next);
639 /** Returns true if @p node is a memory operation.
641 * A memory operation is a node with an opcode that has irop_flag_uses_memory
642 * set. It is guaranteed to have (exactly) one memory input.
644 FIRM_API int is_memop(const ir_node *node);
646 * Returns the memory input of a memory operation.
648 FIRM_API ir_node *get_memop_mem(const ir_node *node);
650 * Sets the memory input of a memory operation.
652 FIRM_API void set_memop_mem(ir_node *node, ir_node *mem);
658 /** Returns all predecessors of Sync node @p node as array */
659 FIRM_API ir_node **get_Sync_preds_arr(ir_node *node);
660 /** Returns number of predecessors of Sync node @p node. */
661 FIRM_API int get_Sync_n_preds(const ir_node *node);
662 /** Returns predecessor number @p pos of Sync node @p node. */
663 FIRM_API ir_node *get_Sync_pred(const ir_node *node, int pos);
664 /** Sets value @p pred as predecessor number @p pos of Sync node @p node. */
665 FIRM_API void set_Sync_pred(ir_node *node, int pos, ir_node *pred);
666 /** Adds @p pred to predecessor list of Sync node @p node. */
667 FIRM_API void add_Sync_pred(ir_node *node, ir_node *pred);
668 /** Removes predecessor i from Sync n */
669 FIRM_API void del_Sync_n(ir_node *n, int i);
674 * Returns non-zero if a node is a routine parameter.
676 * @param node the Proj node to test
678 FIRM_API int is_arg_Proj(const ir_node *node);
680 /** @addtogroup Tuple
684 /** Returns all predecessors of Tuple node @p node as array. */
685 FIRM_API ir_node **get_Tuple_preds_arr(ir_node *node);
686 /** Returns number of predecessors of Tuple node @p node. */
687 FIRM_API int get_Tuple_n_preds(const ir_node *node);
688 /** Returns predecessor number @p pos of Tuple node @p node. */
689 FIRM_API ir_node *get_Tuple_pred(const ir_node *node, int pos);
690 /** Sets value @p pred as predecessor number @p pos of Tuple node @p node. */
691 FIRM_API void set_Tuple_pred(ir_node *node, int pos, ir_node *pred);
699 /** Returns the number of input constraints for an ASM node. */
700 FIRM_API size_t get_ASM_n_input_constraints(const ir_node *node);
701 /** Returns the number of output constraints for an ASM node. */
702 FIRM_API size_t get_ASM_n_output_constraints(const ir_node *node);
703 /** Returns the number of clobbered registers for an ASM node. */
704 FIRM_API size_t get_ASM_n_clobbers(const ir_node *node);
708 /** Returns operand of node if node is a Proj. */
709 FIRM_API ir_node *skip_Proj(ir_node *node);
710 /** Returns operand of node if node is a Proj. */
711 FIRM_API const ir_node *skip_Proj_const(const ir_node *node);
712 /** Returns operand of node if node is a Id. */
713 FIRM_API ir_node *skip_Id(ir_node *node);
714 /** Returns corresponding operand of Tuple if node is a Proj from a Tuple. */
715 FIRM_API ir_node *skip_Tuple(ir_node *node);
716 /** Returns operand of node if node is a Cast. */
717 FIRM_API ir_node *skip_Cast(ir_node *node);
718 /** Returns operand of node if node is a Cast. */
719 FIRM_API const ir_node *skip_Cast_const(const ir_node *node);
720 /** Returns operand of node if node is a Pin. */
721 FIRM_API ir_node *skip_Pin(ir_node *node);
722 /** Returns operand of node if node is a Confirm */
723 FIRM_API ir_node *skip_Confirm(ir_node *node);
724 /** Skip all high-level Operations (including Cast, Confirm). */
725 FIRM_API ir_node *skip_HighLevel_ops(ir_node *node);
726 /** Returns true if the operation manipulates control flow */
727 FIRM_API int is_cfop(const ir_node *node);
728 /** Returns true if the operation jumps to an unknown destination.
729 * See irop_flag_unknown_jump for a detailed explanation */
730 FIRM_API int is_unknown_jump(const ir_node *node);
733 * Returns true if the operation can change the control flow because
734 * of an exception: Call, Div, Mod, Load, Store, Alloc,
735 * Bad. Raise is not fragile, but a unconditional jump.
737 FIRM_API int is_fragile_op(const ir_node *node);
739 /** Returns true if the operation is a forking control flow
740 * operation: Cond. */
741 FIRM_API int is_irn_forking(const ir_node *node);
744 * Copies attributes stored in the old node to a new node.
745 * Assumes both have the same opcode and sufficient size.
747 * @param irg The irg of the new_node (get_irn_irg on it might not work
749 * @param old_node the node where the attributes are copied from
750 * @param new_node node the attributes get copies to.
752 * This copies all essential information to the new node. It does not copy
753 * temporal or calculated information like visited flags or results of dominance
754 * or loop calculations
756 FIRM_API void copy_node_attr(ir_graph *irg, const ir_node *old_node, ir_node *new_node);
758 /** Returns the type attribute of a node n (SymConst, Call, Alloc, Free,
760 FIRM_API ir_type *get_irn_type_attr(ir_node *n);
762 /** Returns the entity attribute of a node n (SymConst, Sel) or NULL. */
763 FIRM_API ir_entity *get_irn_entity_attr(ir_node *n);
765 /** Returns non-zero for constant-like nodes. */
766 FIRM_API int is_irn_constlike(const ir_node *node);
769 * Returns non-zero for nodes that are allowed to have keep-alives and
770 * are neither Block nor PhiM.
772 FIRM_API int is_irn_keep(const ir_node *node);
775 * Returns non-zero for nodes that are always placed in the start block.
777 FIRM_API int is_irn_start_block_placed(const ir_node *node);
780 * Returns non-zero for nodes that are CSE neutral to its users.
782 FIRM_API int is_irn_cse_neutral(const ir_node *node);
784 /** Returns the string representation of the jump prediction. */
785 FIRM_API const char *get_cond_jmp_predicate_name(cond_jmp_predicate pred);
788 * Access custom node data.
789 * The data must have been registered with
790 * register_additional_node_data() before.
791 * @param node The ir node to get the data from.
792 * @param type The type of the data you registered.
793 * @param off The value returned by register_additional_node_data().
794 * @return A pointer of type @p type.
796 #define get_irn_data(node,type,off) \
797 (assert(off > 0 && "Invalid node data offset"), (type *) ((char *) (node) - (off)))
800 * Returns the pointer to the node some custom data belongs to.
801 * @param data The pointer to the custom data.
802 * @param off The number as returned by register_additional_node_data().
803 * @return A pointer to the ir node the custom data belongs to.
805 #define get_irn_data_base(data,off) \
806 (assert(off > 0 && "Invalid node data offset"), (ir_node *) ((char *) (data) + (off)))
809 * Request additional data to be allocated with an ir node.
810 * @param size The size of the additional data required.
811 * @return A positive number, if the operation was successful, which
812 * must be passed to the access macro get_irn_data(), 0 if the
813 * registration failed.
815 FIRM_API unsigned firm_register_additional_node_data(unsigned size);
818 * Returns a pointer to the node attributes.
819 * Used for accessing attributes of user-defined nodes.
821 FIRM_API void *get_irn_generic_attr(ir_node *node);
823 * Returns a pointer to the node attributes.
824 * Used for accessing attributes of user-defined nodes.
826 FIRM_API const void *get_irn_generic_attr_const(const ir_node *node);
829 * Returns the unique node index for the node in its graph.
830 * This index is used to access phase information for this node.
833 FIRM_API unsigned get_irn_idx(const ir_node *node);
836 * Sets the debug information of a node.
839 * @param db The debug info.
841 FIRM_API void set_irn_dbg_info(ir_node *n, dbg_info *db);
844 * Returns the debug information of an node.
848 FIRM_API dbg_info *get_irn_dbg_info(const ir_node *n);
851 * Calculate a hash value of a node. Only inputs, mode and opcode are used.
853 * @param node the node to hash
855 FIRM_API unsigned firm_default_hash(const ir_node *node);
858 * Returns a descriptive name of a node (containing type+number)
860 FIRM_API const char *gdb_node_helper(void *firm_object);
868 * Creates a new switch_table datastructure with @p n_entries entries.
869 * The datastructure is allocated on the obstack of @p irg.
871 FIRM_API ir_switch_table *ir_new_switch_table(ir_graph *irg, size_t n_entries);
874 * Returns number of entries available in switch table @p table.
876 FIRM_API size_t ir_switch_table_get_n_entries(const ir_switch_table *table);
879 * Sets entry number @p entry in the switch table @p table.
880 * @param table the switch table
881 * @param entry entry number to set
882 * @param min The minimum tarval that matches this entry
883 * @param max The maximum tarval that matches this entry
884 * @param pn Proj number taken on match
886 FIRM_API void ir_switch_table_set(ir_switch_table *table, size_t entry,
887 ir_tarval *min, ir_tarval *max, long pn);
889 /** Returns maximum tarval value of switch table entry @p entry */
890 FIRM_API ir_tarval *ir_switch_table_get_max(const ir_switch_table *table,
893 /** Returns minimum tarval value of switch table entry @p entry */
894 FIRM_API ir_tarval *ir_switch_table_get_min(const ir_switch_table *table,
897 /** Returns proj number taken if switch table entry @p entry matches */
898 FIRM_API long ir_switch_table_get_pn(const ir_switch_table *table, size_t entry);
900 /** Duplicates switch table @p table on obstack of @p irg */
901 FIRM_API ir_switch_table *ir_switch_table_duplicate(ir_graph *irg, const ir_switch_table *table);