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
26 #ifndef FIRM_IR_IRNODE_H
27 #define FIRM_IR_IRNODE_H
31 #include "firm_common.h"
39 * @defgroup ir_node Declarations of an ir node.
41 * The type definition of ir_node is also in irgraph.h to resolve
42 * recursion between irnode.h and irgraph.h
44 * ir_node - a datatype representing a Firm node
46 * The common fields are:
48 * - arity - The number of predecessors in the Firm graph.
49 * - in - A list with the predecessors in the Firm graph. There are
50 * routines to access individual elements and to obtain the
51 * array. The method returning the array should not be used.
52 * - mode - The mode of the node. There are routines to get the mode
53 * but also to access the mode's fields directly.
54 * - opcode - The opcode of the node. There are routines to get the opcode
55 * but also to access the opcode's fields directly.
56 * - node_nr - A unique number for the node. Available only if debugging
62 * Checks whether a pointer points to a ir node.
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);
76 /** Replaces the old in array by a new one that will contain the ins given in
77 the parameters. Conserves the block predecessor. It copies the array passed.
78 This function is necessary to adjust in arrays of blocks, calls and phis.
79 Assumes that current_ir_graph is set to the graph containing "node".
80 "in" must contain all predecessors except the block that are required for
82 FIRM_API void set_irn_in(ir_node *node, int arity, ir_node *in[]);
84 /* to iterate through the predecessors without touching the array. No
85 order of predecessors guaranteed.
86 To iterate over the operands iterate from 0 to i < get_irn_arity(),
87 to iterate including the Block predecessor iterate from i = -1 to
89 /* Access predecessor n */
92 * Get the n-th predecessor of a node.
93 * This function removes Id predecessors.
95 FIRM_API ir_node *get_irn_n(const ir_node *node, int n);
98 * Add a artificial dependency to the node.
99 * The dependency is only inserted if it is not there already.
100 * This is only allowed in phase_backend!
102 * @param node The node.
103 * @param dep The dependency target.
105 * @return The index in the array (get_irn_dep with that index returns @p dep).
107 FIRM_API int add_irn_dep(ir_node *node, ir_node *dep);
110 * Copy all dependencies from a node to another.
111 * This is only allowed in phase_backend!
113 * @param tgt The node which should be enriched.
114 * @param src The node whose dependencies shall be copied.
116 FIRM_API void add_irn_deps(ir_node *tgt, ir_node *src);
119 * Get the length of the dependency array.
120 * @param node The node.
121 * @return The length of the dependency array or 0 if it has not yet been allocated.
123 FIRM_API int get_irn_deps(const ir_node *node);
126 * Get an entry of the dependency array.
127 * @param node The node.
128 * @param pos The position.
129 * @return The node at that position.
131 FIRM_API ir_node *get_irn_dep(const ir_node *node, int pos);
134 * Set an entry of the dependency array.
135 * @param node The node.
136 * @param pos The position.
137 * @param dep The dependency target.
139 FIRM_API void set_irn_dep(ir_node *node, int pos, ir_node *dep);
141 /** Replace the n-th predecessor of a node with a new one. */
142 FIRM_API void set_irn_n(ir_node *node, int n, ir_node *in);
144 * Appends a new predecessor to a node. This only works for nodes with
146 * @returns the number of the new input
148 FIRM_API int add_irn_n(ir_node *node, ir_node *in);
149 /* Remove predecessor i from Sync n */
150 FIRM_API void del_Sync_n(ir_node *n, int i);
151 /* Sets the mode struct of node. */
152 FIRM_API void set_irn_mode(ir_node *node, ir_mode *mode);
153 /** Gets the mode struct of a node. */
154 FIRM_API ir_mode *get_irn_mode(const ir_node *node);
155 /** Gets the opcode struct of the node. */
156 FIRM_API ir_op *get_irn_op(const ir_node *node);
157 /** Sets the opcode struct of the node. */
158 FIRM_API void set_irn_op(ir_node *node, ir_op *op);
159 /** Gets the opcode-enum of the node. */
160 FIRM_API unsigned get_irn_opcode(const ir_node *node);
161 /** Get the string representation of the opcode. */
162 FIRM_API const char *get_irn_opname(const ir_node *node);
163 /** Get the ident for a string representation of the opcode. */
164 FIRM_API ident *get_irn_opident(const ir_node *node);
165 /** If arg is an argument of the node, returns its position, -1 otherwise */
166 FIRM_API int get_irn_pred_pos(ir_node *node, ir_node *arg);
167 /** Gets the visited counter of a node. */
168 FIRM_API ir_visited_t get_irn_visited(const ir_node *node);
169 /** Sets the visited counter of a node. */
170 FIRM_API void set_irn_visited(ir_node *node, ir_visited_t visited);
171 /** Sets visited to get_irg_visited(current_ir_graph). */
172 FIRM_API void mark_irn_visited(ir_node *node);
173 /** Returns 1 if visited >= get_irg_visited(current_ir_graph). */
174 FIRM_API int irn_visited(const ir_node *node);
175 /** Returns 1 if visited >= get_irg_visited(current_ir_graph). Marks the node
176 * visited, if it was not. */
177 FIRM_API int irn_visited_else_mark(ir_node *node);
180 * Sets the link of a node.
181 * Only allowed if the graph is NOT in phase_building.
183 FIRM_API void set_irn_link(ir_node *node, void *link);
185 /** Returns the link of a node. */
186 FIRM_API void *get_irn_link(const ir_node *node);
188 /** Returns the ir_graph this node belongs to. */
189 FIRM_API ir_graph *get_irn_irg(const ir_node *node);
191 /** Outputs a unique number for this node if libFIRM is compiled for
192 debugging, (configure with --enable-debug) else returns address
193 of node cast to long. */
194 FIRM_API long get_irn_node_nr(const ir_node *node);
196 /** Returns the pinned state of a node.
198 * Returns whether the node _always_ must be pinned.
199 * I.e., the node is not floating after global cse.
201 * @returns Either state op_pin_state_pinned or op_pin_state_floats.
203 FIRM_API op_pin_state get_irn_pinned(const ir_node *node);
205 /** Set pin state for nodes with op pin state op_pin_state_exc_pinned */
206 FIRM_API void set_irn_pinned(ir_node *node, op_pin_state state);
208 /** Returns whether the node is currently pinned.
210 * If get_irn_pinned returns op_pin_state_floats and the graph the
211 * node belongs to is in state op_poin_state_floats then this function
212 * returns 'floats', else 'pinned'.
214 FIRM_API op_pin_state is_irn_pinned_in_irg(const ir_node *node);
217 * IR node constructor.
218 * Create a new IR node in irg, with an op, mode, arity and
219 * some incoming IR nodes.
220 * This constructor is used in every specific IR node constructor.
222 * @param db Debug info.
223 * @param irg IR-graph on with this new node should be constructed.
224 * @param block The block the new node belongs to
225 * @param op The opcode of the new node.
226 * @param mode The mode of the new node.
227 * @param arity The arity of the new node, <0 if can be changed dynamically.
228 * @param in An array of arity predecessor nodes.
230 FIRM_API ir_node *new_ir_node(dbg_info *db, ir_graph *irg, ir_node *block,
231 ir_op *op, ir_mode *mode,
232 int arity, ir_node *const *in);
235 * Return the block the node belongs to. This is only
236 * possible for pinned nodes or if the graph is in pinned state.
237 * Otherwise the block may be incorrect. This condition is
238 * now checked by an assertion.
240 * This works for all except Block. It can return Blocks or the Bad node.
242 * To express the difference to access routines that work for all
243 * nodes we use infix "nodes" and do not name this function
244 * get_irn_block(). */
245 FIRM_API ir_node *get_nodes_block (const ir_node *node);
247 /** Sets the Block of a node. */
248 FIRM_API void set_nodes_block (ir_node *node, ir_node *block);
250 /** Test whether arbitrary node is frame pointer.
252 * Test whether arbitrary node is frame pointer, i.e. Proj(pn_Start_P_frame_base)
253 * from Start. If so returns frame type, else Null. */
254 FIRM_API ir_type *is_frame_pointer(const ir_node *n);
256 /** Return the number of control flow predecessors of a block. */
257 FIRM_API int get_Block_n_cfgpreds(const ir_node *block);
258 /** Return the control flow predecessor of a block at a given position. */
259 FIRM_API ir_node *get_Block_cfgpred(const ir_node *block, int pos);
260 /** Set the control flow predecessor of a block at a given position. */
261 FIRM_API void set_Block_cfgpred(ir_node *block, int pos, ir_node *pred);
264 * Return the position of the predecessor block pred in the inputs
265 * of the block block.
267 * @param block the block
268 * @param pred a predecessor block of block
270 * @return the position of pred in block or -1
272 * @note When using the old extended basic block form for blocks
273 * with exception exists, a predecessor block might have more
274 * than one position. In that case it is not specified, with is returned.
276 FIRM_API int get_Block_cfgpred_pos(const ir_node *block, const ir_node *pred);
278 /** Get the predecessor block.
280 * Returns the block corresponding to the predecessor pos of block.
282 * There are several ambiguities we resolve with this function:
283 * - The direct predecessor can be a Proj, which is not pinned.
284 * We walk from the predecessor to the next pinned node
285 * (skip_Proj) and return the block that node is in.
286 * - If we encounter the Bad node, this function does not return
287 * Start block, but the Bad node.
289 FIRM_API ir_node *get_Block_cfgpred_block(const ir_node *node, int pos);
291 /** Return the matured flag of a block */
292 FIRM_API int get_Block_matured(const ir_node *block);
293 /** set the matured flag of a block. */
294 FIRM_API void set_Block_matured(ir_node *block, int matured);
296 /** A visited flag only for block nodes.
297 * @see also: get_irn_visited() inc_irg_visited() inc_irg_block_visited()*/
298 FIRM_API ir_visited_t get_Block_block_visited(const ir_node *block);
299 FIRM_API void set_Block_block_visited(ir_node *block, ir_visited_t visit);
301 /* For this current_ir_graph must be set. */
302 FIRM_API void mark_Block_block_visited(ir_node *node);
303 FIRM_API int Block_block_visited(const ir_node *node);
305 /** Returns the extended basic block a block belongs to. */
306 FIRM_API ir_extblk *get_Block_extbb(const ir_node *block);
307 /** Sets the extended basic block a block belongs to. */
308 FIRM_API void set_Block_extbb(ir_node *block, ir_extblk *extblk);
309 /** Returns the ir_graph this Block belongs to. */
310 FIRM_API ir_graph *get_Block_irg(const ir_node *block);
311 /** Returns non-zero if the block has an entity assigned */
312 FIRM_API int has_Block_entity(const ir_node *block);
313 /** Returns the entity for a Block */
314 FIRM_API ir_entity *get_Block_entity(const ir_node *block);
315 /** Returns the entity for a Block (creating it if necessary) */
316 FIRM_API ir_entity *create_Block_entity(ir_node *block);
317 /** Set a new entity for a block */
318 FIRM_API void set_Block_entity(ir_node *block, ir_entity *entity);
319 /** Gets the head of the Phi list for this block. */
320 FIRM_API ir_node *get_Block_phis(const ir_node *block);
321 /** Sets the head of the Phi list for this block. */
322 FIRM_API void set_Block_phis(ir_node *block, ir_node *phi);
323 /** Add a Phi node to the list of Block Phi's. */
324 FIRM_API void add_Block_phi(ir_node *block, ir_node *phi);
325 /** Get the Block mark (single bit). */
326 FIRM_API unsigned get_Block_mark(const ir_node *block);
327 /** Set the Block mark (single bit). */
328 FIRM_API void set_Block_mark(ir_node *block, unsigned mark);
330 /** Return the number of Keep alive node. */
331 FIRM_API int get_End_n_keepalives(const ir_node *end);
332 /** Return the Keep alive node a position pos. */
333 FIRM_API ir_node *get_End_keepalive(const ir_node *end, int pos);
334 /** Keep alive dedicated nodes. These must be either PhiM or Block nodes. */
335 FIRM_API void add_End_keepalive(ir_node *end, ir_node *ka);
336 /** Set the Keep alive node at position pos. */
337 FIRM_API void set_End_keepalive(ir_node *end, int pos, ir_node *ka);
340 * Set new keep-alives.
341 * Beware: This might be an expensive operation if dynamic edges are enabled,
342 * so avoid it in the backend.
344 FIRM_API void set_End_keepalives(ir_node *end, int n, ir_node *in[]);
346 /** Remove irn from the keep-alive set. */
347 FIRM_API void remove_End_keepalive(ir_node *end, ir_node *irn);
349 /* Remove Bads, NoMem and doublets from the keep-alive set. */
350 FIRM_API void remove_End_Bads_and_doublets(ir_node *end);
352 /** Some parts of the End node are allocated separately -- their memory
353 is not recovered by dead_node_elimination if a End node is dead.
354 free_End() frees these data structures. */
355 FIRM_API void free_End(ir_node *end);
357 FIRM_API ir_node **get_Return_res_arr(ir_node *node);
358 FIRM_API size_t get_Return_n_ress(const ir_node *node);
359 FIRM_API ir_node *get_Return_res(const ir_node *node, int pos);
360 FIRM_API void set_Return_res(ir_node *node, int pos, ir_node *res);
362 /** Return non-zero if the given Const node represents the 0 constant. */
363 FIRM_API int is_Const_null(const ir_node *node);
365 /** Return non-zero if the given Const node represents the 1 constant. */
366 FIRM_API int is_Const_one(const ir_node *node);
368 /** Return non-zero if the given Const node represents the constant with all bits set. */
369 FIRM_API int is_Const_all_one(const ir_node *node);
371 /** Returns true if a node is a Conv node with strict attribute set. */
372 FIRM_API int is_strictConv(const ir_node *node);
374 /** Returns true if node is a SymConst node with kind symconst_addr_ent. */
375 FIRM_API int is_SymConst_addr_ent(const ir_node *node);
377 /** Returns non-zero if s symconst kind has a type attribute */
378 #define SYMCONST_HAS_TYPE(kind) ((kind) <= symconst_type_align)
380 /** Returns non-zero if s symconst kind has an entity attribute */
381 #define SYMCONST_HAS_ENT(kind) ((kind) == symconst_addr_ent || (kind) == symconst_ofs_ent)
383 /** Returns non-zero if s symconst kind has an enum_const attribute */
384 #define SYMCONST_HAS_ENUM(kind) ((kind) == symconst_enum_const)
386 /** Get the kind of the SymConst. */
387 FIRM_API symconst_kind get_SymConst_kind(const ir_node *node);
388 /** Set the kind of the SymConst. */
389 FIRM_API void set_SymConst_kind(ir_node *node, symconst_kind num);
391 /** Only to access SymConst of kind type_tag or size. Else assertion: */
392 FIRM_API ir_type *get_SymConst_type(const ir_node *node);
393 FIRM_API void set_SymConst_type(ir_node *node, ir_type *tp);
395 /** Only to access SymConst of kind addr_ent. Else assertion: */
396 FIRM_API ir_entity *get_SymConst_entity(const ir_node *node);
397 FIRM_API void set_SymConst_entity(ir_node *node, ir_entity *ent);
399 /** Only to access SymConst of kind symconst_enum_const. Else assertion: */
400 FIRM_API ir_enum_const *get_SymConst_enum(const ir_node *node);
401 FIRM_API void set_SymConst_enum(ir_node *node, ir_enum_const *ec);
403 /** Sets both: type and ptrinfo. Needed to treat the node independent of
404 its semantics. Does a memcpy for the memory sym points to. */
405 /* write 'union': firmjni then does not create a method... */
406 FIRM_API union symconst_symbol get_SymConst_symbol(const ir_node *node);
407 FIRM_API void set_SymConst_symbol(ir_node *node,
408 union symconst_symbol sym);
410 FIRM_API ir_node **get_Sel_index_arr(ir_node *node);
411 FIRM_API int get_Sel_n_indexs(const ir_node *node);
412 FIRM_API ir_node *get_Sel_index(const ir_node *node, int pos);
413 FIRM_API void set_Sel_index(ir_node *node, int pos, ir_node *index);
415 FIRM_API ir_node **get_Call_param_arr(ir_node *node);
416 /** Gets the number of parameters of a call. */
417 FIRM_API size_t get_Call_n_params(const ir_node *node);
418 /** Gets the call parameter at position pos. */
419 FIRM_API ir_node *get_Call_param(const ir_node *node, int pos);
420 /** Sets the call parameter at position pos. */
421 FIRM_API void set_Call_param(ir_node *node, int pos, ir_node *param);
423 /** Set, get and remove the callee information for a Call node.
425 * The callee information lists all method entities that can be called
426 * from this node. If the address expression can not be analyzed fully,
427 * e.g., as entities can be called that are not in the compilation unit,
428 * the array contains the unknown_entity. The array contains only entities
429 * with peculiarity_existent, but with all kinds of visibility. The entities
430 * not necessarily contain an irg.
432 * The array is only accessible if callee information is valid. See flag
435 * The memory allocated for the array is managed automatically, i.e., it must
436 * not be freed if the Call node is removed from the graph.
438 * @param node A Call node.
440 FIRM_API int Call_has_callees(const ir_node *node);
441 FIRM_API size_t get_Call_n_callees(const ir_node *node);
442 FIRM_API ir_entity *get_Call_callee(const ir_node *node, size_t pos);
444 /** Set the full callee array.
446 * The passed array is copied. Assumes current_ir_graph set properly! */
447 FIRM_API void set_Call_callee_arr(ir_node *node, size_t n, ir_entity **arr);
448 FIRM_API void remove_Call_callee_arr(ir_node *node);
450 FIRM_API ir_node **get_Builtin_param_arr(ir_node *node);
451 /** Gets the number of parameters of a Builtin. */
452 FIRM_API int get_Builtin_n_params(const ir_node *node);
453 /** Gets the Builtin parameter at position pos. */
454 FIRM_API ir_node *get_Builtin_param(const ir_node *node, int pos);
455 /** Sets the Builtin parameter at position pos. */
456 FIRM_API void set_Builtin_param(ir_node *node, int pos, ir_node *param);
457 /** Returns a human readable string for the ir_builtin_kind. */
458 FIRM_API const char *get_builtin_kind_name(ir_builtin_kind kind);
460 /* For unary and binary arithmetic operations the access to the
461 operands can be factored out. Left is the first, right the
462 second arithmetic value as listed in tech report 1999-44.
463 unops are: Minus, Abs, Not, Conv, Cast
464 binops are: Add, Sub, Mul, Div, Mod, And, Or, Eor, Shl,
465 Shr, Shrs, Rotl, Cmp */
466 FIRM_API int is_unop(const ir_node *node);
467 FIRM_API ir_node *get_unop_op(const ir_node *node);
468 FIRM_API void set_unop_op(ir_node *node, ir_node *op);
469 FIRM_API int is_binop(const ir_node *node);
470 FIRM_API ir_node *get_binop_left(const ir_node *node);
471 FIRM_API void set_binop_left(ir_node *node, ir_node *left);
472 FIRM_API ir_node *get_binop_right(const ir_node *node);
473 FIRM_API void set_binop_right(ir_node *node, ir_node *right);
476 * Test wether a node is the X_except Proj of a fragile operation
478 FIRM_API int is_x_except_Proj(const ir_node *node);
481 * Test wether a node is the X_regular Proj of a fragile operation
483 FIRM_API int is_x_regular_Proj(const ir_node *node);
486 * Set throws exception attribute of a fragile node
487 * @p throws_exception must be 0 or 1
489 FIRM_API void ir_set_throws_exception(ir_node *node, int throws_exception);
492 * Returns throws_exception attribute of a fragile node
494 FIRM_API int ir_throws_exception(const ir_node *node);
496 /** returns the name of an ir_relation */
497 FIRM_API const char *get_relation_string(ir_relation relation);
499 /** Calculates the negated (Complement(R)) relation, i.e. "<" --> ">=" */
500 FIRM_API ir_relation get_negated_relation(ir_relation relation);
502 /** Calculates the inversed (R^-1) relation, i.e., "<" --> ">" */
503 FIRM_API ir_relation get_inversed_relation(ir_relation relation);
505 /** Checks for upcast.
507 * Returns true if the Cast node casts a class type to a super type.
508 * Works also for pointers to classes (recursively).
510 * Needs typeinfo calculated.
512 FIRM_API int is_Cast_upcast(ir_node *node);
514 /** Checks for downcast.
516 * Returns true if the Cast node casts a class type to a sub type.
517 * Works also for pointers to classes (recursively).
519 * Needs typeinfo calculated.
521 FIRM_API int is_Cast_downcast(ir_node *node);
523 /** Returns true if irg in phase phase_building and the Phi has zero
524 predecessors. It's a Phi0 then. */
525 FIRM_API int is_Phi0(const ir_node *n);
526 FIRM_API ir_node **get_Phi_preds_arr(ir_node *node);
527 FIRM_API int get_Phi_n_preds(const ir_node *node);
528 FIRM_API ir_node *get_Phi_pred(const ir_node *node, int pos);
529 FIRM_API void set_Phi_pred(ir_node *node, int pos, ir_node *pred);
531 * Returns the next element of a block phi list.
533 FIRM_API ir_node *get_Phi_next(const ir_node *phi);
535 * Sets the next link of a block Phi list.
537 FIRM_API void set_Phi_next(ir_node *phi, ir_node *next);
539 /** Return true if parameter is a memory operation.
541 * A memory operation is an operation that changes the
542 * memory. I.e., a Load or a Store operation.
544 FIRM_API int is_memop(const ir_node *node);
545 FIRM_API ir_node *get_memop_mem(const ir_node *node);
546 FIRM_API void set_memop_mem(ir_node *node, ir_node *mem);
547 FIRM_API ir_node *get_memop_ptr(const ir_node *node);
548 FIRM_API void set_memop_ptr(ir_node *node, ir_node *ptr);
550 FIRM_API ir_node **get_Sync_preds_arr(ir_node *node);
551 FIRM_API int get_Sync_n_preds(const ir_node *node);
552 FIRM_API ir_node *get_Sync_pred(const ir_node *node, int pos);
553 FIRM_API void set_Sync_pred(ir_node *node, int pos, ir_node *pred);
554 FIRM_API void add_Sync_pred(ir_node *node, ir_node *pred);
557 * Returns non-zero if a node is a routine parameter.
559 * @param node the Proj node to test
561 FIRM_API int is_arg_Proj(const ir_node *node);
563 FIRM_API ir_node **get_Tuple_preds_arr(ir_node *node);
564 FIRM_API int get_Tuple_n_preds(const ir_node *node);
565 FIRM_API ir_node *get_Tuple_pred(const ir_node *node, int pos);
566 FIRM_API void set_Tuple_pred(ir_node *node, int pos, ir_node *pred);
568 /** Return the number of input constraints for an ASM node. */
569 FIRM_API int get_ASM_n_input_constraints(const ir_node *node);
570 /** Return the number of output constraints for an ASM node. */
571 FIRM_API int get_ASM_n_output_constraints(const ir_node *node);
572 /** Return the number of clobbered registers for an ASM node. */
573 FIRM_API int get_ASM_n_clobbers(const ir_node *node);
577 * NAME Auxiliary routines
581 /** Returns operand of node if node is a Proj. */
582 FIRM_API ir_node *skip_Proj(ir_node *node);
583 /** Returns operand of node if node is a Proj. */
584 FIRM_API const ir_node *skip_Proj_const(const ir_node *node);
585 /** Returns operand of node if node is a Id. */
586 FIRM_API ir_node *skip_Id(ir_node *node); /* Old name is skip_nop(). */
587 /** Returns corresponding operand of Tuple if node is a Proj from
589 FIRM_API ir_node *skip_Tuple(ir_node *node);
590 /** Returns operand of node if node is a Cast. */
591 FIRM_API ir_node *skip_Cast(ir_node *node);
592 FIRM_API const ir_node *skip_Cast_const(const ir_node *node);
593 /** Returns operand of node if node is a Pin. */
594 FIRM_API ir_node *skip_Pin(ir_node *node);
595 /** Returns operand of node if node is a Confirm */
596 FIRM_API ir_node *skip_Confirm(ir_node *node);
597 /** Skip all high-level Operations (including Cast, Confirm). */
598 FIRM_API ir_node *skip_HighLevel_ops(ir_node *node);
599 /** Returns true if the operation manipulates control flow:
600 Start, End, Jmp, Cond, Return, Raise, Bad */
601 FIRM_API int is_cfop(const ir_node *node);
602 /** returns true if the operation jumps to an unknown destination.
603 * See irop_flag_unknown_jump for a detailed explanation */
604 FIRM_API int is_unknown_jump(const ir_node *node);
606 /** Returns true if the operation can change the control flow because
607 of an exception: Call, Div, Mod, Load, Store, Alloc,
608 Bad. Raise is not fragile, but a unconditional jump. */
609 FIRM_API int is_fragile_op(const ir_node *node);
610 /** Returns the memory operand of fragile operations. */
611 FIRM_API ir_node *get_fragile_op_mem(ir_node *node);
613 /** Returns true if the operation is a forking control flow
614 * operation: Cond. */
615 FIRM_API int is_irn_forking(const ir_node *node);
618 * Copies attributes stored in the old node to a new node.
619 * Assumes both have the same opcode and sufficient size.
621 * @param irg The irg of the new_node (get_irn_irg on it might not work
623 * @param old_node the node where the attributes are copied from
624 * @param new_node node the attributes get copies to.
626 * This copies all essential information to the new node. It does not copy
627 * temporal or calculated information like visited flags or results of dominance
628 * or loop calculations
630 FIRM_API void copy_node_attr(ir_graph *irg, const ir_node *old_node, ir_node *new_node);
632 /** Return the type attribute of a node n (SymConst, Call, Alloc, Free,
634 FIRM_API ir_type *get_irn_type_attr(ir_node *n);
636 /** Return the entity attribute of a node n (SymConst, Sel) or NULL. */
637 FIRM_API ir_entity *get_irn_entity_attr(ir_node *n);
639 /** Returns non-zero for constant-like nodes. */
640 FIRM_API int is_irn_constlike(const ir_node *node);
643 * Returns non-zero for nodes that are allowed to have keep-alives and
644 * are neither Block nor PhiM.
646 FIRM_API int is_irn_keep(const ir_node *node);
649 * Returns non-zero for nodes that are always placed in the start block.
651 FIRM_API int is_irn_start_block_placed(const ir_node *node);
654 * Returns non-zero for nodes that are machine operations.
656 FIRM_API int is_irn_machine_op(const ir_node *node);
659 * Returns non-zero for nodes that are machine operands.
661 FIRM_API int is_irn_machine_operand(const ir_node *node);
664 * Returns non-zero for nodes that have the n'th user machine flag set.
666 FIRM_API int is_irn_machine_user(const ir_node *node, unsigned n);
669 * Returns non-zero for nodes that are CSE neutral to its users.
671 FIRM_API int is_irn_cse_neutral(const ir_node *node);
673 /** Gets the string representation of the jump prediction. */
674 FIRM_API const char *get_cond_jmp_predicate_name(cond_jmp_predicate pred);
676 /** Checks whether a node represents a global address. */
677 FIRM_API int is_Global(const ir_node *node);
679 /* Returns the entity of a global address. */
680 FIRM_API ir_entity *get_Global_entity(const ir_node *node);
683 * Access custom node data.
684 * The data must have been registered with
685 * register_additional_node_data() before.
686 * @param node The ir node to get the data from.
687 * @param type The type of the data you registered.
688 * @param off The value returned by register_additional_node_data().
689 * @return A pointer of type @p type.
691 #define get_irn_data(node,type,off) \
692 (assert(off > 0 && "Invalid node data offset"), (type *) ((char *) (node) - (off)))
695 * Get the pointer to the node some custom data belongs to.
696 * @param data The pointer to the custom data.
697 * @param off The number as returned by register_additional_node_data().
698 * @return A pointer to the ir node the custom data belongs to.
700 #define get_irn_data_base(data,off) \
701 (assert(off > 0 && "Invalid node data offset"), (ir_node *) ((char *) (data) + (off)))
704 * Request additional data to be allocated with an ir node.
705 * @param size The size of the additional data required.
706 * @return A positive number, if the operation was successful, which
707 * must be passed to the access macro get_irn_data(), 0 if the
708 * registration failed.
710 FIRM_API unsigned firm_register_additional_node_data(unsigned size);
713 * Return a pointer to the node attributes.
714 * Needed for user-defined nodes.
716 FIRM_API void *get_irn_generic_attr(ir_node *node);
717 FIRM_API const void *get_irn_generic_attr_const(const ir_node *node);
720 * Returns the unique node index for the node in its graph.
721 * This index is used to access phase information for this node.
723 FIRM_API unsigned get_irn_idx(const ir_node *node);
726 * Sets the debug information of a node.
729 * @param db The debug info.
731 FIRM_API void set_irn_dbg_info(ir_node *n, dbg_info *db);
734 * Returns the debug information of an node.
738 FIRM_API dbg_info *get_irn_dbg_info(const ir_node *n);
741 * Calculate a hash value of a node. Only inputs, mode and opcode are used.
743 * @param node the node to hash
745 FIRM_API unsigned firm_default_hash(const ir_node *node);
748 * returns a descriptive name of a node (containing type+number)
750 FIRM_API const char *gdb_node_helper(void *firm_object);
752 /*@}*/ /* end of ir_node group definition */