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"
38 * @defgroup ir_node Declarations of an ir node.
40 * The type definition of ir_node is also in irgraph.h to resolve
41 * recursion between irnode.h and irgraph.h
43 * ir_node - a datatype representing a Firm node
45 * The common fields are:
47 * - arity - The number of predecessors in the Firm graph.
48 * - in - A list with the predecessors in the Firm graph. There are
49 * routines to access individual elements and to obtain the
50 * array. The method returning the array should not be used.
51 * - mode - The mode of the node. There are routines to get the mode
52 * but also to access the mode's fields directly.
53 * - opcode - The opcode of the node. There are routines to get the opcode
54 * but also to access the opcode's fields directly.
55 * - node_nr - A unique number for the node. Available only if debugging
61 * Some projection numbers must be always equal to support automatic phi construction
64 pn_Generic_M = 0, /**< The memory result. */
65 pn_Generic_X_regular = 1, /**< Execution result if no exception occurred. */
66 pn_Generic_X_except = 2, /**< The control flow result branching to the exception handler */
67 pn_Generic_other = 3 /**< First free projection number */
70 /* include projnumber enums generated by specification */
71 #include "projnumbers.h"
74 * Checks whether a pointer points to a ir node.
76 * @param thing an arbitrary pointer
77 * @return non-zero if the thing is a ir mode, else zero
79 FIRM_API int is_ir_node (const void *thing);
82 * Returns the number of predecessors without the block predecessor.
84 * @param node the IR-node
86 FIRM_API int get_irn_arity (const ir_node *node);
88 /** Replaces the old in array by a new one that will contain the ins given in
89 the parameters. Conserves the block predecessor. It copies the array passed.
90 This function is necessary to adjust in arrays of blocks, calls and phis.
91 Assumes that current_ir_graph is set to the graph containing "node".
92 "in" must contain all predecessors except the block that are required for
94 FIRM_API void set_irn_in(ir_node *node, int arity, ir_node *in[]);
96 /* to iterate through the predecessors without touching the array. No
97 order of predecessors guaranteed.
98 To iterate over the operands iterate from 0 to i < get_irn_arity(),
99 to iterate including the Block predecessor iterate from i = -1 to
100 i < get_irn_arity. */
101 /* Access predecessor n */
104 * Get the n-th predecessor of a node.
105 * This function removes Id predecessors.
107 FIRM_API ir_node *get_irn_n(const ir_node *node, int n);
110 * Add a artificial dependency to the node.
111 * The dependency is only inserted if it is not there already.
112 * This is only allowed in phase_backend!
114 * @param node The node.
115 * @param dep The dependency target.
117 * @return The index in the array (get_irn_dep with that index returns @p dep).
119 FIRM_API int add_irn_dep(ir_node *node, ir_node *dep);
122 * Copy all dependencies from a node to another.
123 * This is only allowed in phase_backend!
125 * @param tgt The node which should be enriched.
126 * @param src The node whose dependencies shall be copied.
128 FIRM_API void add_irn_deps(ir_node *tgt, ir_node *src);
131 * Get the length of the dependency array.
132 * @param node The node.
133 * @return The length of the dependency array or 0 if it has not yet been allocated.
135 FIRM_API int get_irn_deps(const ir_node *node);
138 * Get an entry of the dependency array.
139 * @param node The node.
140 * @param pos The position.
141 * @return The node at that position.
143 FIRM_API ir_node *get_irn_dep(const ir_node *node, int pos);
146 * Set an entry of the dependency array.
147 * @param node The node.
148 * @param pos The position.
149 * @param dep The dependency target.
151 FIRM_API void set_irn_dep(ir_node *node, int pos, ir_node *dep);
153 /** Replace the n-th predecessor of a node with a new one. */
154 FIRM_API void set_irn_n(ir_node *node, int n, ir_node *in);
156 * Appends a new predecessor to a node. This only works for nodes with
158 * @returns the number of the new input
160 FIRM_API int add_irn_n(ir_node *node, ir_node *in);
161 /* Remove predecessor i from Sync n */
162 FIRM_API void del_Sync_n(ir_node *n, int i);
163 /* Sets the mode struct of node. */
164 FIRM_API void set_irn_mode(ir_node *node, ir_mode *mode);
165 /** Gets the mode struct of a node. */
166 FIRM_API ir_mode *get_irn_mode(const ir_node *node);
167 /** Gets the ident for a string representation of the mode .*/
168 FIRM_API ident *get_irn_modeident(const ir_node *node);
169 /** Gets the string representation of the mode .*/
170 FIRM_API const char *get_irn_modename(const ir_node *node);
171 /** Gets the opcode struct of the node. */
172 FIRM_API ir_op *get_irn_op(const ir_node *node);
173 /** Sets the opcode struct of the node. */
174 FIRM_API void set_irn_op(ir_node *node, ir_op *op);
175 /** Gets the opcode-enum of the node. */
176 FIRM_API unsigned get_irn_opcode(const ir_node *node);
177 /** Get the string representation of the opcode. */
178 FIRM_API const char *get_irn_opname(const ir_node *node);
179 /** Get the ident for a string representation of the opcode. */
180 FIRM_API ident *get_irn_opident(const ir_node *node);
181 /** If arg is an argument of the node, returns it's position, -1 otherwise */
182 FIRM_API int get_irn_pred_pos(ir_node *node, ir_node *arg);
183 /** Gets the visited counter of a node. */
184 FIRM_API ir_visited_t get_irn_visited(const ir_node *node);
185 /** Sets the visited counter of a node. */
186 FIRM_API void set_irn_visited(ir_node *node, ir_visited_t visited);
187 /** Sets visited to get_irg_visited(current_ir_graph). */
188 FIRM_API void mark_irn_visited(ir_node *node);
189 /** Returns 1 if visited >= get_irg_visited(current_ir_graph). */
190 FIRM_API int irn_visited(const ir_node *node);
191 /** Returns 1 if visited >= get_irg_visited(current_ir_graph). Marks the node
192 * visited, if it was not. */
193 FIRM_API int irn_visited_else_mark(ir_node *node);
196 * Sets the link of a node.
197 * Only allowed if the graph is NOT in phase_building.
199 FIRM_API void set_irn_link(ir_node *node, void *link);
201 /** Returns the link of a node. */
202 FIRM_API void *get_irn_link(const ir_node *node);
204 /** Returns the ir_graph this node belongs to. */
205 FIRM_API ir_graph *get_irn_irg(const ir_node *node);
207 /** Outputs a unique number for this node if libFIRM is compiled for
208 debugging, (configure with --enable-debug) else returns address
209 of node cast to long. */
210 FIRM_API long get_irn_node_nr(const ir_node *node);
212 /** Returns the pinned state of a node.
214 * Returns whether the node _always_ must be pinned.
215 * I.e., the node is not floating after global cse.
217 * @returns Either state op_pin_state_pinned or op_pin_state_floats.
219 FIRM_API op_pin_state get_irn_pinned(const ir_node *node);
221 /** Set pin state for nodes with op pin state op_pin_state_exc_pinned */
222 FIRM_API void set_irn_pinned(ir_node *node, op_pin_state state);
224 /** Returns whether the node is currently pinned.
226 * If get_irn_pinned returns op_pin_state_floats and the graph the
227 * node belongs to is in state op_poin_state_floats then this function
228 * returns 'floats', else 'pinned'.
230 FIRM_API op_pin_state is_irn_pinned_in_irg(const ir_node *node);
233 * IR node constructor.
234 * Create a new IR node in irg, with an op, mode, arity and
235 * some incoming IR nodes.
236 * This constructor is used in every specific IR node constructor.
238 * @param db Debug info.
239 * @param irg IR-graph on with this new node should be constructed.
240 * @param block The block the new node belongs to
241 * @param op The opcode of the new node.
242 * @param mode The mode of the new node.
243 * @param arity The arity of the new node, <0 if can be changed dynamically.
244 * @param in An array of arity predecessor nodes.
246 FIRM_API ir_node *new_ir_node(dbg_info *db, ir_graph *irg, ir_node *block,
247 ir_op *op, ir_mode *mode,
248 int arity, ir_node *in[]);
251 * Return the block the node belongs to. This is only
252 * possible for pinned nodes or if the graph is in pinned state.
253 * Otherwise the block may be incorrect. This condition is
254 * now checked by an assertion.
256 * This works for all except Block. It can return Blocks or the Bad node.
258 * To express the difference to access routines that work for all
259 * nodes we use infix "nodes" and do not name this function
260 * get_irn_block(). */
261 FIRM_API ir_node *get_nodes_block (const ir_node *node);
263 /** Sets the Block of a node. */
264 FIRM_API void set_nodes_block (ir_node *node, ir_node *block);
267 * Return the MacroBlock the node belongs to. This is only
268 * possible for pinned nodes or if the graph is in pinned state.
269 * Otherwise the MacroBlock may be incorrect. This condition is
270 * now checked by an assertion.
272 * This works for all except Block. It can return Blocks or the Bad node.
274 * To express the difference to access routines that work for all
275 * nodes we use infix "nodes" and do not name this function
276 * get_irn_MacroBlock(). */
277 FIRM_API ir_node *get_nodes_MacroBlock(const ir_node *node);
279 /** Test whether arbitrary node is frame pointer.
281 * Test whether arbitrary node is frame pointer, i.e. Proj(pn_Start_P_frame_base)
282 * from Start. If so returns frame type, else Null. */
283 FIRM_API ir_type *is_frame_pointer(const ir_node *n);
285 /** Test whether arbitrary node is the thread local storage (tls) pointer.
287 * Test whether arbitrary node is tls pointer, i.e. Proj(pn_Start_P_tls)
288 * from Start. If so returns tls type, else Null. */
289 FIRM_API ir_type *is_tls_pointer(const ir_node *n);
291 /** Return the number of control flow predecessors of a block. */
292 FIRM_API int get_Block_n_cfgpreds(const ir_node *block);
293 /** Return the control flow predecessor of a block at a given position. */
294 FIRM_API ir_node *get_Block_cfgpred(const ir_node *block, int pos);
295 /** Set the control flow predecessor of a block at a given position. */
296 FIRM_API void set_Block_cfgpred(ir_node *block, int pos, ir_node *pred);
299 * Return the position of the predecessor block pred in the inputs
300 * of the block block.
302 * @param block the block
303 * @param pred a predecessor block of block
305 * @return the position of pred in block or -1
307 * @note When using the old extended basic block form for blocks
308 * with exception exists, a predecessor block might have more
309 * than one position. In that case it is not specified, with is returned.
311 FIRM_API int get_Block_cfgpred_pos(const ir_node *block, const ir_node *pred);
313 /** Get the predecessor block.
315 * Returns the block corresponding to the predecessor pos of block.
317 * There are several ambiguities we resolve with this function:
318 * - The direct predecessor can be a Proj, which is not pinned.
319 * We walk from the predecessor to the next pinned node
320 * (skip_Proj) and return the block that node is in.
321 * - If we encounter the Bad node, this function does not return
322 * Start block, but the Bad node.
324 FIRM_API ir_node *get_Block_cfgpred_block(const ir_node *node, int pos);
326 /** Return the matured flag of a block */
327 FIRM_API int get_Block_matured(const ir_node *block);
328 /** set the matured flag of a block. */
329 FIRM_API void set_Block_matured(ir_node *block, int matured);
331 /** A visited flag only for block nodes.
332 * @see also: get_irn_visited() inc_irg_visited() inc_irg_block_visited()*/
333 FIRM_API ir_visited_t get_Block_block_visited(const ir_node *block);
334 FIRM_API void set_Block_block_visited(ir_node *block, ir_visited_t visit);
337 * Marks a block as dead but do not replace it with a Bad node.
338 * Dead blocks are removed in the con
340 FIRM_API ir_node *set_Block_dead(ir_node *block);
341 FIRM_API int is_Block_dead(const ir_node *block);
343 /* For this current_ir_graph must be set. */
344 FIRM_API void mark_Block_block_visited(ir_node *node);
345 FIRM_API int Block_block_visited(const ir_node *node);
347 /** Returns the extended basic block a block belongs to. */
348 FIRM_API ir_extblk *get_Block_extbb(const ir_node *block);
349 /** Sets the extended basic block a block belongs to. */
350 FIRM_API void set_Block_extbb(ir_node *block, ir_extblk *extblk);
351 /** Get the Macro Block header of a (sub-) block. */
352 FIRM_API ir_node *get_Block_MacroBlock(const ir_node *block);
353 /** Set the Macro Block header of a (sub-) block. */
354 FIRM_API void set_Block_MacroBlock(ir_node *block, ir_node *mbh);
355 /** Get the Macro Block header of a node. */
356 FIRM_API ir_node *get_irn_MacroBlock(const ir_node *n);
357 /** Returns the ir_graph this Block belongs to. */
358 FIRM_API ir_graph *get_Block_irg(const ir_node *block);
359 /** Returns non-zero if the block has an entity assigned */
360 FIRM_API int has_Block_entity(const ir_node *block);
361 /** Returns the entity for a Block */
362 FIRM_API ir_entity *get_Block_entity(const ir_node *block);
363 /** Returns the entity for a Block (creating it if necessary) */
364 FIRM_API ir_entity *create_Block_entity(ir_node *block);
365 /** Set a new entity for a block */
366 FIRM_API void set_Block_entity(ir_node *block, ir_entity *entity);
367 /** Gets the head of the Phi list for this block. */
368 FIRM_API ir_node *get_Block_phis(const ir_node *block);
369 /** Sets the head of the Phi list for this block. */
370 FIRM_API void set_Block_phis(ir_node *block, ir_node *phi);
371 /** Add a Phi node to the list of Block Phi's. */
372 FIRM_API void add_Block_phi(ir_node *block, ir_node *phi);
373 /** Get the Block mark (single bit). */
374 FIRM_API unsigned get_Block_mark(const ir_node *block);
375 /** Set the Block mark (single bit). */
376 FIRM_API void set_Block_mark(ir_node *block, unsigned mark);
378 /** Return the number of Keep alive node. */
379 FIRM_API int get_End_n_keepalives(const ir_node *end);
380 /** Return the Keep alive node a position pos. */
381 FIRM_API ir_node *get_End_keepalive(const ir_node *end, int pos);
382 /** Keep alive dedicated nodes. These must be either PhiM or Block nodes. */
383 FIRM_API void add_End_keepalive(ir_node *end, ir_node *ka);
384 /** Set the Keep alive node at position pos. */
385 FIRM_API void set_End_keepalive(ir_node *end, int pos, ir_node *ka);
388 * Set new keep-alives.
389 * Beware: This might be an expensive operation if dynamic edges are enabled,
390 * so avoid it in the backend.
392 FIRM_API void set_End_keepalives(ir_node *end, int n, ir_node *in[]);
394 /** Remove irn from the keep-alive set. */
395 FIRM_API void remove_End_keepalive(ir_node *end, ir_node *irn);
397 /* Remove Bads, NoMem and doublets from the keep-alive set. */
398 FIRM_API void remove_End_Bads_and_doublets(ir_node *end);
400 /** Some parts of the End node are allocated separately -- their memory
401 is not recovered by dead_node_elimination if a End node is dead.
402 free_End() frees these data structures. */
403 FIRM_API void free_End(ir_node *end);
405 /** Return the target address of an IJmp */
406 FIRM_API ir_node *get_IJmp_target(const ir_node *ijmp);
407 /** Sets the target address of an IJmp */
408 FIRM_API void set_IJmp_target(ir_node *ijmp, ir_node *tgt);
410 FIRM_API ir_node *get_Cond_selector(const ir_node *node);
411 FIRM_API void set_Cond_selector(ir_node *node, ir_node *selector);
412 FIRM_API long get_Cond_default_proj(const ir_node *node);
413 FIRM_API void set_Cond_default_proj(ir_node *node, long defproj);
415 FIRM_API ir_node *get_Return_mem(const ir_node *node);
416 FIRM_API void set_Return_mem(ir_node *node, ir_node *mem);
417 FIRM_API ir_node **get_Return_res_arr(ir_node *node);
418 FIRM_API int get_Return_n_ress(const ir_node *node);
419 FIRM_API ir_node *get_Return_res(const ir_node *node, int pos);
420 FIRM_API void set_Return_res(ir_node *node, int pos, ir_node *res);
422 FIRM_API tarval *get_Const_tarval(const ir_node *node);
423 FIRM_API void set_Const_tarval(ir_node *node, tarval *con);
425 /** Return non-zero if the given Const node represents the 0 constant. */
426 FIRM_API int is_Const_null(const ir_node *node);
428 /** Return non-zero if the given Const node represents the 1 constant. */
429 FIRM_API int is_Const_one(const ir_node *node);
431 /** Return non-zero if the given Const node represents the constant with all bits set. */
432 FIRM_API int is_Const_all_one(const ir_node *node);
434 /** Returns the source language type of a Const node.
435 * Must be an atomic type. Mode of type must be mode of node.
437 FIRM_API ir_type *get_Const_type(const ir_node *node);
439 /** Sets the source language type of a Const node. */
440 FIRM_API void set_Const_type(ir_node *node, ir_type *tp);
442 /** Returns non-zero if s symconst kind has a type attribute */
443 #define SYMCONST_HAS_TYPE(kind) ((kind) <= symconst_type_align)
445 /** Returns non-zero if s symconst kind has an entity attribute */
446 #define SYMCONST_HAS_ENT(kind) ((kind) == symconst_addr_ent || (kind) == symconst_ofs_ent)
448 /** Returns non-zero if s symconst kind has an enum_const attribute */
449 #define SYMCONST_HAS_ENUM(kind) ((kind) == symconst_enum_const)
451 /** Get the kind of the SymConst. */
452 FIRM_API symconst_kind get_SymConst_kind(const ir_node *node);
453 /** Set the kind of the SymConst. */
454 FIRM_API void set_SymConst_kind(ir_node *node, symconst_kind num);
456 /** Only to access SymConst of kind type_tag or size. Else assertion: */
457 FIRM_API ir_type *get_SymConst_type(const ir_node *node);
458 FIRM_API void set_SymConst_type(ir_node *node, ir_type *tp);
460 /** Only to access SymConst of kind addr_ent. Else assertion: */
461 FIRM_API ir_entity *get_SymConst_entity(const ir_node *node);
462 FIRM_API void set_SymConst_entity(ir_node *node, ir_entity *ent);
464 /** Only to access SymConst of kind symconst_enum_const. Else assertion: */
465 FIRM_API ir_enum_const *get_SymConst_enum(const ir_node *node);
466 FIRM_API void set_SymConst_enum(ir_node *node, ir_enum_const *ec);
468 /** Sets both: type and ptrinfo. Needed to treat the node independent of
469 its semantics. Does a memcpy for the memory sym points to. */
470 /* write 'union': firmjni then does not create a method... */
471 FIRM_API union symconst_symbol get_SymConst_symbol(const ir_node *node);
472 FIRM_API void set_SymConst_symbol(ir_node *node,
473 union symconst_symbol sym);
475 /** Access the type of the value represented by the SymConst.
477 * Example: primitive type int for SymConst size. */
478 FIRM_API ir_type *get_SymConst_value_type(const ir_node *node);
479 FIRM_API void set_SymConst_value_type(ir_node *node, ir_type *tp);
481 FIRM_API ir_node *get_Sel_mem(const ir_node *node);
482 FIRM_API void set_Sel_mem(ir_node *node, ir_node *mem);
483 FIRM_API ir_node *get_Sel_ptr(const ir_node *node);
484 FIRM_API void set_Sel_ptr(ir_node *node, ir_node *ptr);
485 FIRM_API ir_node **get_Sel_index_arr(ir_node *node);
486 FIRM_API int get_Sel_n_indexs(const ir_node *node);
487 FIRM_API ir_node *get_Sel_index(const ir_node *node, int pos);
488 FIRM_API void set_Sel_index(ir_node *node, int pos, ir_node *index);
489 FIRM_API ir_entity *get_Sel_entity(const ir_node *node);
490 FIRM_API void set_Sel_entity (ir_node *node, ir_entity *ent);
492 /** Retrieve the memory input of a Call. */
493 FIRM_API ir_node *get_Call_mem(const ir_node *node);
494 /** Set the memory input of a Call. */
495 FIRM_API void set_Call_mem(ir_node *node, ir_node *mem);
496 /** Retrieve the call address of a Call. */
497 FIRM_API ir_node *get_Call_ptr(const ir_node *node);
498 /** Set the call address of a Call. */
499 FIRM_API void set_Call_ptr(ir_node *node, ir_node *ptr);
500 FIRM_API ir_node **get_Call_param_arr(ir_node *node);
501 /** Gets the number of parameters of a call. */
502 FIRM_API int get_Call_n_params(const ir_node *node);
503 /** Gets the call parameter at position pos. */
504 FIRM_API ir_node *get_Call_param(const ir_node *node, int pos);
505 /** Sets the call parameter at position pos. */
506 FIRM_API void set_Call_param(ir_node *node, int pos, ir_node *param);
507 /** Gets the type of a call. */
508 FIRM_API ir_type *get_Call_type(const ir_node *node);
509 /** Sets the type of a call. */
510 FIRM_API void set_Call_type(ir_node *node, ir_type *tp);
511 /** Returns non-zero if this call can be a tail-call. */
512 FIRM_API unsigned get_Call_tail_call(const ir_node *node);
513 /** Sets the tail call attribute. */
514 FIRM_API void set_Call_tail_call(ir_node *node, unsigned tail_call);
517 * Returns non-zero if a Call is surely a self-recursive Call.
518 * Beware: if this functions returns 0, the call might be self-recursive!
520 FIRM_API int is_self_recursive_Call(const ir_node *call);
522 /** Set, get and remove the callee information for a Call node.
524 * The callee information lists all method entities that can be called
525 * from this node. If the address expression can not be analyzed fully,
526 * e.g., as entities can be called that are not in the compilation unit,
527 * the array contains the unknown_entity. The array contains only entities
528 * with peculiarity_existent, but with all kinds of visibility. The entities
529 * not necessarily contain an irg.
531 * The array is only accessible if callee information is valid. See flag
534 * The memory allocated for the array is managed automatically, i.e., it must
535 * not be freed if the Call node is removed from the graph.
537 * @param node A Call node.
539 FIRM_API int Call_has_callees(const ir_node *node);
540 FIRM_API int get_Call_n_callees(const ir_node *node);
541 FIRM_API ir_entity *get_Call_callee(const ir_node *node, int pos);
543 /** Set the full callee array.
545 * The passed array is copied. Assumes current_ir_graph set properly! */
546 FIRM_API void set_Call_callee_arr(ir_node *node, const int n, ir_entity **arr);
547 FIRM_API void remove_Call_callee_arr(ir_node *node);
549 FIRM_API ir_node *get_Builtin_mem(const ir_node *node);
550 FIRM_API void set_Builtin_mem(ir_node *node, ir_node *mem);
551 FIRM_API ir_builtin_kind get_Builtin_kind(const ir_node *node);
552 FIRM_API void set_Builtin_kind(ir_node *node, ir_builtin_kind kind);
553 FIRM_API ir_node **get_Builtin_param_arr(ir_node *node);
554 /** Gets the number of parameters of a Builtin. */
555 FIRM_API int get_Builtin_n_params(const ir_node *node);
556 /** Gets the Builtin parameter at position pos. */
557 FIRM_API ir_node *get_Builtin_param(const ir_node *node, int pos);
558 /** Sets the Builtin parameter at position pos. */
559 FIRM_API void set_Builtin_param(ir_node *node, int pos, ir_node *param);
560 /** Gets the type of a builtin. */
561 FIRM_API ir_type *get_Builtin_type(const ir_node *node);
562 /** Sets the type of a Builtin. */
563 FIRM_API void set_Builtin_type(ir_node *node, ir_type *tp);
564 /** Returns a human readable string for the ir_builtin_kind. */
565 FIRM_API const char *get_builtin_kind_name(ir_builtin_kind kind);
567 /* For unary and binary arithmetic operations the access to the
568 operands can be factored out. Left is the first, right the
569 second arithmetic value as listed in tech report 1999-44.
570 unops are: Minus, Abs, Not, Conv, Cast
571 binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
572 Shr, Shrs, Rotl, Cmp */
573 FIRM_API int is_unop(const ir_node *node);
574 FIRM_API ir_node *get_unop_op(const ir_node *node);
575 FIRM_API void set_unop_op(ir_node *node, ir_node *op);
576 FIRM_API int is_binop(const ir_node *node);
577 FIRM_API ir_node *get_binop_left(const ir_node *node);
578 FIRM_API void set_binop_left(ir_node *node, ir_node *left);
579 FIRM_API ir_node *get_binop_right(const ir_node *node);
580 FIRM_API void set_binop_right(ir_node *node, ir_node *right);
582 FIRM_API ir_node *get_Add_left(const ir_node *node);
583 FIRM_API void set_Add_left(ir_node *node, ir_node *left);
584 FIRM_API ir_node *get_Add_right(const ir_node *node);
585 FIRM_API void set_Add_right(ir_node *node, ir_node *right);
587 FIRM_API ir_node *get_Carry_left(const ir_node *node);
588 FIRM_API void set_Carry_left(ir_node *node, ir_node *left);
589 FIRM_API ir_node *get_Carry_right(const ir_node *node);
590 FIRM_API void set_Carry_right(ir_node *node, ir_node *right);
592 FIRM_API ir_node *get_Borrow_left(const ir_node *node);
593 FIRM_API void set_Borrow_left(ir_node *node, ir_node *left);
594 FIRM_API ir_node *get_Borrow_right(const ir_node *node);
595 FIRM_API void set_Borrow_right(ir_node *node, ir_node *right);
597 FIRM_API ir_node *get_Sub_left(const ir_node *node);
598 FIRM_API void set_Sub_left(ir_node *node, ir_node *left);
599 FIRM_API ir_node *get_Sub_right(const ir_node *node);
600 FIRM_API void set_Sub_right(ir_node *node, ir_node *right);
602 FIRM_API ir_node *get_Minus_op(const ir_node *node);
603 FIRM_API void set_Minus_op(ir_node *node, ir_node *op);
605 FIRM_API ir_node *get_Mul_left(const ir_node *node);
606 FIRM_API void set_Mul_left(ir_node *node, ir_node *left);
607 FIRM_API ir_node *get_Mul_right(const ir_node *node);
608 FIRM_API void set_Mul_right(ir_node *node, ir_node *right);
610 FIRM_API ir_node *get_Mulh_left(const ir_node *node);
611 FIRM_API void set_Mulh_left(ir_node *node, ir_node *left);
612 FIRM_API ir_node *get_Mulh_right(const ir_node *node);
613 FIRM_API void set_Mulh_right(ir_node *node, ir_node *right);
615 FIRM_API ir_node *get_Quot_left(const ir_node *node);
616 FIRM_API void set_Quot_left(ir_node *node, ir_node *left);
617 FIRM_API ir_node *get_Quot_right(const ir_node *node);
618 FIRM_API void set_Quot_right(ir_node *node, ir_node *right);
619 FIRM_API ir_node *get_Quot_mem(const ir_node *node);
620 FIRM_API void set_Quot_mem(ir_node *node, ir_node *mem);
621 FIRM_API ir_mode *get_Quot_resmode(const ir_node *node);
622 FIRM_API void set_Quot_resmode(ir_node *node, ir_mode *mode);
624 FIRM_API ir_node *get_DivMod_left(const ir_node *node);
625 FIRM_API void set_DivMod_left(ir_node *node, ir_node *left);
626 FIRM_API ir_node *get_DivMod_right(const ir_node *node);
627 FIRM_API void set_DivMod_right(ir_node *node, ir_node *right);
628 FIRM_API ir_node *get_DivMod_mem(const ir_node *node);
629 FIRM_API void set_DivMod_mem(ir_node *node, ir_node *mem);
630 FIRM_API ir_mode *get_DivMod_resmode(const ir_node *node);
631 FIRM_API void set_DivMod_resmode(ir_node *node, ir_mode *mode);
633 FIRM_API ir_node *get_Div_left(const ir_node *node);
634 FIRM_API void set_Div_left(ir_node *node, ir_node *left);
635 FIRM_API ir_node *get_Div_right(const ir_node *node);
636 FIRM_API void set_Div_right(ir_node *node, ir_node *right);
637 FIRM_API ir_node *get_Div_mem(const ir_node *node);
638 FIRM_API void set_Div_mem(ir_node *node, ir_node *mem);
639 FIRM_API ir_mode *get_Div_resmode(const ir_node *node);
640 FIRM_API void set_Div_resmode(ir_node *node, ir_mode *mode);
641 FIRM_API int get_Div_no_remainder(const ir_node *node);
642 FIRM_API void set_Div_no_remainder(ir_node *node, int no_remainder);
644 FIRM_API ir_node *get_Mod_left(const ir_node *node);
645 FIRM_API void set_Mod_left(ir_node *node, ir_node *left);
646 FIRM_API ir_node *get_Mod_right(const ir_node *node);
647 FIRM_API void set_Mod_right(ir_node *node, ir_node *right);
648 FIRM_API ir_node *get_Mod_mem(const ir_node *node);
649 FIRM_API void set_Mod_mem(ir_node *node, ir_node *mem);
650 FIRM_API ir_mode *get_Mod_resmode(const ir_node *node);
651 FIRM_API void set_Mod_resmode(ir_node *node, ir_mode *mode);
653 FIRM_API ir_node *get_Abs_op(const ir_node *node);
654 FIRM_API void set_Abs_op(ir_node *node, ir_node *op);
656 FIRM_API ir_node *get_And_left(const ir_node *node);
657 FIRM_API void set_And_left(ir_node *node, ir_node *left);
658 FIRM_API ir_node *get_And_right(const ir_node *node);
659 FIRM_API void set_And_right(ir_node *node, ir_node *right);
661 FIRM_API ir_node *get_Or_left(const ir_node *node);
662 FIRM_API void set_Or_left(ir_node *node, ir_node *left);
663 FIRM_API ir_node *get_Or_right(const ir_node *node);
664 FIRM_API void set_Or_right(ir_node *node, ir_node *right);
666 FIRM_API ir_node *get_Eor_left(const ir_node *node);
667 FIRM_API void set_Eor_left(ir_node *node, ir_node *left);
668 FIRM_API ir_node *get_Eor_right(const ir_node *node);
669 FIRM_API void set_Eor_right(ir_node *node, ir_node *right);
671 FIRM_API ir_node *get_Not_op(const ir_node *node);
672 FIRM_API void set_Not_op(ir_node *node, ir_node *op);
674 /** returns the pnc name from an pnc constant */
675 FIRM_API const char *get_pnc_string(int pnc);
677 /** Calculates the negated (Complement(R)) pnc condition. */
678 FIRM_API pn_Cmp get_negated_pnc(long pnc, ir_mode *mode);
680 /** Calculates the inversed (R^-1) pnc condition, i.e., "<" --> ">" */
681 FIRM_API pn_Cmp get_inversed_pnc(long pnc);
683 /** An alternative name for get_inversed_pnc() that can be better memorized. */
684 #define get_mirrored_pnc(pnc) get_inversed_pnc(pnc)
686 FIRM_API ir_node *get_Cmp_left(const ir_node *node);
687 FIRM_API void set_Cmp_left(ir_node *node, ir_node *left);
688 FIRM_API ir_node *get_Cmp_right(const ir_node *node);
689 FIRM_API void set_Cmp_right(ir_node *node, ir_node *right);
691 FIRM_API ir_node *get_Shl_left(const ir_node *node);
692 FIRM_API void set_Shl_left(ir_node *node, ir_node *left);
693 FIRM_API ir_node *get_Shl_right(const ir_node *node);
694 FIRM_API void set_Shl_right(ir_node *node, ir_node *right);
696 FIRM_API ir_node *get_Shr_left(const ir_node *node);
697 FIRM_API void set_Shr_left(ir_node *node, ir_node *left);
698 FIRM_API ir_node *get_Shr_right(const ir_node *node);
699 FIRM_API void set_Shr_right(ir_node *node, ir_node *right);
701 FIRM_API ir_node *get_Shrs_left(const ir_node *node);
702 FIRM_API void set_Shrs_left(ir_node *node, ir_node *left);
703 FIRM_API ir_node *get_Shrs_right(const ir_node *node);
704 FIRM_API void set_Shrs_right(ir_node *node, ir_node *right);
706 FIRM_API ir_node *get_Rotl_left(const ir_node *node);
707 FIRM_API void set_Rotl_left(ir_node *node, ir_node *left);
708 FIRM_API ir_node *get_Rotl_right(const ir_node *node);
709 FIRM_API void set_Rotl_right(ir_node *node, ir_node *right);
711 FIRM_API ir_node *get_Conv_op(const ir_node *node);
712 FIRM_API void set_Conv_op(ir_node *node, ir_node *op);
713 FIRM_API int get_Conv_strict(const ir_node *node);
714 FIRM_API void set_Conv_strict(ir_node *node, int flag);
716 /* Does Cast need a mem operator?
717 * Cast should only depend on the type, not on the state of an
718 * entity. But: we initialize various fields after Alloc, that
719 * are accessed in the cast. This required some precaution, to
720 * get the right memory into the Loads generated from the cast.
722 FIRM_API ir_node *get_Cast_op(const ir_node *node);
723 FIRM_API void set_Cast_op(ir_node *node, ir_node *op);
724 FIRM_API ir_type *get_Cast_type(const ir_node *node);
725 FIRM_API void set_Cast_type(ir_node *node, ir_type *to_tp);
727 /** Checks for upcast.
729 * Returns true if the Cast node casts a class type to a super type.
730 * Works also for pointers to classes (recursively).
732 * Needs typeinfo calculated.
734 FIRM_API int is_Cast_upcast(ir_node *node);
736 /** Checks for downcast.
738 * Returns true if the Cast node casts a class type to a sub type.
739 * Works also for pointers to classes (recursively).
741 * Needs typeinfo calculated.
743 FIRM_API int is_Cast_downcast(ir_node *node);
746 /** Returns true if n is a Phi.
747 Returns false if irg is in phase phase_building and the Phi has zero
748 predecessors: it's a Phi0. */
749 FIRM_API int is_Phi(const ir_node *n);
750 /** Returns true if irg in phase phase_building and the Phi has zero
751 predecessors. It's a Phi0 then. */
752 FIRM_API int is_Phi0(const ir_node *n);
753 FIRM_API ir_node **get_Phi_preds_arr(ir_node *node);
754 FIRM_API int get_Phi_n_preds(const ir_node *node);
755 FIRM_API ir_node *get_Phi_pred(const ir_node *node, int pos);
756 FIRM_API void set_Phi_pred(ir_node *node, int pos, ir_node *pred);
758 * Returns the next element of a block phi list.
760 FIRM_API ir_node *get_Phi_next(const ir_node *phi);
762 * Sets the next link of a block Phi list.
764 FIRM_API void set_Phi_next(ir_node *phi, ir_node *next);
766 /** Return true if parameter is a memory operation.
768 * A memory operation is an operation that changes the
769 * memory. I.e., a Load or a Store operation.
771 FIRM_API int is_memop(const ir_node *node);
772 FIRM_API ir_node *get_memop_mem(const ir_node *node);
773 FIRM_API void set_memop_mem(ir_node *node, ir_node *mem);
774 FIRM_API ir_node *get_memop_ptr(const ir_node *node);
775 FIRM_API void set_memop_ptr(ir_node *node, ir_node *ptr);
777 FIRM_API ir_node *get_Load_mem(const ir_node *node);
778 FIRM_API void set_Load_mem(ir_node *node, ir_node *mem);
779 FIRM_API ir_node *get_Load_ptr(const ir_node *node);
780 FIRM_API void set_Load_ptr(ir_node *node, ir_node *ptr);
781 FIRM_API ir_mode *get_Load_mode(const ir_node *node);
782 FIRM_API void set_Load_mode(ir_node *node, ir_mode *mode);
783 FIRM_API ir_volatility get_Load_volatility(const ir_node *node);
784 FIRM_API void set_Load_volatility(ir_node *node, ir_volatility volatility);
785 FIRM_API ir_align get_Load_align(const ir_node *node);
786 FIRM_API void set_Load_align(ir_node *node, ir_align align);
788 FIRM_API ir_node *get_Store_mem(const ir_node *node);
789 FIRM_API void set_Store_mem(ir_node *node, ir_node *mem);
790 FIRM_API ir_node *get_Store_ptr(const ir_node *node);
791 FIRM_API void set_Store_ptr(ir_node *node, ir_node *ptr);
792 FIRM_API ir_node *get_Store_value(const ir_node *node);
793 FIRM_API void set_Store_value(ir_node *node, ir_node *value);
794 FIRM_API ir_volatility get_Store_volatility(const ir_node *node);
795 FIRM_API void set_Store_volatility(ir_node *node, ir_volatility volatility);
796 FIRM_API ir_align get_Store_align(const ir_node *node);
797 FIRM_API void set_Store_align(ir_node *node, ir_align align);
799 FIRM_API ir_node *get_Alloc_mem(const ir_node *node);
800 FIRM_API void set_Alloc_mem(ir_node *node, ir_node *mem);
801 FIRM_API ir_node *get_Alloc_count(const ir_node *node);
802 FIRM_API void set_Alloc_count(ir_node *node, ir_node *count);
803 FIRM_API ir_type *get_Alloc_type(const ir_node *node);
804 FIRM_API void set_Alloc_type(ir_node *node, ir_type *tp);
806 FIRM_API ir_where_alloc get_Alloc_where(const ir_node *node);
807 FIRM_API void set_Alloc_where(ir_node *node, ir_where_alloc where);
809 FIRM_API ir_node *get_Free_mem(const ir_node *node);
810 FIRM_API void set_Free_mem(ir_node *node, ir_node *mem);
811 FIRM_API ir_node *get_Free_ptr(const ir_node *node);
812 FIRM_API void set_Free_ptr(ir_node *node, ir_node *ptr);
813 FIRM_API ir_node *get_Free_size(const ir_node *node);
814 FIRM_API void set_Free_size(ir_node *node, ir_node *size);
815 FIRM_API ir_type *get_Free_type(const ir_node *node);
816 FIRM_API void set_Free_type(ir_node *node, ir_type *tp);
818 FIRM_API ir_where_alloc get_Free_where(const ir_node *node);
819 FIRM_API void set_Free_where(ir_node *node, ir_where_alloc where);
821 FIRM_API ir_node **get_Sync_preds_arr(ir_node *node);
822 FIRM_API int get_Sync_n_preds(const ir_node *node);
823 FIRM_API ir_node *get_Sync_pred(const ir_node *node, int pos);
824 FIRM_API void set_Sync_pred(ir_node *node, int pos, ir_node *pred);
825 FIRM_API void add_Sync_pred(ir_node *node, ir_node *pred);
827 /** Returns the source language type of a Proj node.
828 * Must be an atomic type. Mode of type must be mode of node.
830 FIRM_API ir_type *get_Proj_type(const ir_node *node);
832 /** Return the predecessor of a Proj node. */
833 FIRM_API ir_node *get_Proj_pred(const ir_node *node);
834 FIRM_API void set_Proj_pred(ir_node *node, ir_node *pred);
835 /** Return the projection number of a Proj node. */
836 FIRM_API long get_Proj_proj(const ir_node *node);
837 FIRM_API void set_Proj_proj(ir_node *node, long proj);
840 * Returns non-zero if a node is a routine parameter.
842 * @param node the Proj node to test
844 FIRM_API int is_arg_Proj(const ir_node *node);
846 FIRM_API ir_node **get_Tuple_preds_arr(ir_node *node);
847 FIRM_API int get_Tuple_n_preds(const ir_node *node);
848 FIRM_API ir_node *get_Tuple_pred(const ir_node *node, int pos);
849 FIRM_API void set_Tuple_pred(ir_node *node, int pos, ir_node *pred);
851 FIRM_API ir_node *get_Id_pred(const ir_node *node);
852 FIRM_API void set_Id_pred(ir_node *node, ir_node *pred);
854 /** Confirm has a single result and returns 'value' unchanged.
855 * The node expresses a restriction on 'value':
856 * 'value' 'cmp' 'bound' == true. */
857 FIRM_API ir_node *get_Confirm_value(const ir_node *node);
858 FIRM_API void set_Confirm_value(ir_node *node, ir_node *value);
859 FIRM_API ir_node *get_Confirm_bound(const ir_node *node);
860 FIRM_API void set_Confirm_bound(ir_node *node, ir_node *bound);
861 FIRM_API pn_Cmp get_Confirm_cmp(const ir_node *node);
862 FIRM_API void set_Confirm_cmp(ir_node *node, pn_Cmp cmp);
867 FIRM_API ir_node *get_Mux_sel(const ir_node *node);
868 FIRM_API void set_Mux_sel(ir_node *node, ir_node *sel);
869 FIRM_API ir_node *get_Mux_false(const ir_node *node);
870 FIRM_API void set_Mux_false(ir_node *node, ir_node *ir_false);
871 FIRM_API ir_node *get_Mux_true(const ir_node *node);
872 FIRM_API void set_Mux_true(ir_node *node, ir_node *ir_true);
874 FIRM_API ir_node *get_CopyB_mem(const ir_node *node);
875 FIRM_API void set_CopyB_mem(ir_node *node, ir_node *mem);
876 FIRM_API ir_node *get_CopyB_dst(const ir_node *node);
877 FIRM_API void set_CopyB_dst(ir_node *node, ir_node *dst);
878 FIRM_API ir_node *get_CopyB_src(const ir_node *node);
879 FIRM_API void set_CopyB_src(ir_node *node, ir_node *src);
880 FIRM_API ir_type *get_CopyB_type(const ir_node *node);
881 FIRM_API void set_CopyB_type(ir_node *node, ir_type *data_type);
883 /** InstOf access. */
884 FIRM_API ir_type *get_InstOf_type(const ir_node *node);
885 FIRM_API void set_InstOf_type(ir_node *node, ir_type *type);
886 FIRM_API ir_node *get_InstOf_store(const ir_node *node);
887 FIRM_API void set_InstOf_store(ir_node *node, ir_node *obj);
888 FIRM_API ir_node *get_InstOf_obj(const ir_node *node);
889 FIRM_API void set_InstOf_obj(ir_node *node, ir_node *obj);
891 FIRM_API ir_node *get_Raise_mem(const ir_node *node);
892 FIRM_API void set_Raise_mem(ir_node *node, ir_node *mem);
893 FIRM_API ir_node *get_Raise_exo_ptr(const ir_node *node); /* PoinTeR to EXception Object */
894 FIRM_API void set_Raise_exo_ptr(ir_node *node, ir_node *exoptr);
896 /** Returns the memory input of a Bound operation. */
897 FIRM_API ir_node *get_Bound_mem(const ir_node *bound);
898 FIRM_API void set_Bound_mem(ir_node *bound, ir_node *mem);
900 /** Returns the index input of a Bound operation. */
901 FIRM_API ir_node *get_Bound_index(const ir_node *bound);
902 FIRM_API void set_Bound_index(ir_node *bound, ir_node *idx);
904 /** Returns the lower bound input of a Bound operation. */
905 FIRM_API ir_node *get_Bound_lower(const ir_node *bound);
906 FIRM_API void set_Bound_lower(ir_node *bound, ir_node *lower);
908 /** Returns the upper bound input of a Bound operation. */
909 FIRM_API ir_node *get_Bound_upper(const ir_node *bound);
910 FIRM_API void set_Bound_upper(ir_node *bound, ir_node *upper);
912 /** Return the operand of a Pin node. */
913 FIRM_API ir_node *get_Pin_op(const ir_node *pin);
914 FIRM_API void set_Pin_op(ir_node *pin, ir_node *node);
916 /** Return the assembler text of an ASM pseudo node. */
917 FIRM_API ident *get_ASM_text(const ir_node *node);
918 /** Set assembler text of ASM node */
919 FIRM_API void set_ASM_text(ir_node *node, ident *text);
920 /** Return the number of input constraints for an ASM node. */
921 FIRM_API int get_ASM_n_input_constraints(const ir_node *node);
922 /** Return the input constraints for an ASM node. */
923 FIRM_API ir_asm_constraint *get_ASM_input_constraints(const ir_node *node);
924 /** Set input constraints for ASM node. */
925 FIRM_API void set_ASM_input_constraints(ir_node *node, ir_asm_constraint *constraints);
926 /** Return the number of output constraints for an ASM node. */
927 FIRM_API int get_ASM_n_output_constraints(const ir_node *node);
928 /** Return the output constraints for an ASM node. */
929 FIRM_API ir_asm_constraint *get_ASM_output_constraints(const ir_node *node);
930 /** Set output constraints for ASM node. (note: has to be a firm array) */
931 FIRM_API void set_ASM_output_constraints(ir_node *node, ir_asm_constraint *constraints);
932 /** Return the number of clobbered registers for an ASM node. */
933 FIRM_API int get_ASM_n_clobbers(const ir_node *node);
934 /** Return the list of clobbered registers for an ASM node. */
935 FIRM_API ident **get_ASM_clobbers(const ir_node *node);
936 /** Set list of clobbered register for ASM node (note: has to be a firm
938 FIRM_API void set_ASM_clobbers(ir_node *node, ident **clobbers);
942 * NAME Auxiliary routines
946 /** Returns operand of node if node is a Proj. */
947 FIRM_API ir_node *skip_Proj(ir_node *node);
948 /** Returns operand of node if node is a Proj. */
949 FIRM_API const ir_node *skip_Proj_const(const ir_node *node);
950 /** Returns operand of node if node is a Id. */
951 FIRM_API ir_node *skip_Id(ir_node *node); /* Old name is skip_nop(). */
952 /** Returns corresponding operand of Tuple if node is a Proj from
954 FIRM_API ir_node *skip_Tuple(ir_node *node);
955 /** Returns operand of node if node is a Cast. */
956 FIRM_API ir_node *skip_Cast(ir_node *node);
957 FIRM_API const ir_node *skip_Cast_const(const ir_node *node);
958 /** Returns operand of node if node is a Pin. */
959 FIRM_API ir_node *skip_Pin(ir_node *node);
960 /** Returns operand of node if node is a Confirm */
961 FIRM_API ir_node *skip_Confirm(ir_node *node);
962 /** Skip all high-level Operations (including Cast, Confirm). */
963 FIRM_API ir_node *skip_HighLevel_ops(ir_node *node);
964 /** Returns true if irn is a Const node. */
965 FIRM_API int is_Const(const ir_node *node);
966 /** Returns true if a node is a Conv node. */
967 FIRM_API int is_Conv(const ir_node *node);
968 /** Returns true if a node is a strictConv node. */
969 FIRM_API int is_strictConv(const ir_node *node);
970 /** Returns true if a node is a Cast node. */
971 FIRM_API int is_Cast(const ir_node *node);
972 /** Returns true if node is a Bad node. */
973 FIRM_API int is_Bad(const ir_node *node);
974 /** Returns true if node is a NoMem node. */
975 FIRM_API int is_NoMem(const ir_node *node);
976 /** Returns true if node is a Start node. */
977 FIRM_API int is_Start(const ir_node *node);
978 /** Returns true if node is an End node. */
979 FIRM_API int is_End(const ir_node *node);
980 /** Returns true if node is a Minus node. */
981 FIRM_API int is_Minus(const ir_node *node);
982 /** Returns true if node is a Abs node. */
983 FIRM_API int is_Abs(const ir_node *node);
984 /** Returns true if node is a Mod node. */
985 FIRM_API int is_Mod(const ir_node *node);
986 /** Returns true if node is a Div node. */
987 FIRM_API int is_Div(const ir_node *node);
988 /** Returns true if node is a DivMod node. */
989 FIRM_API int is_DivMod(const ir_node *node);
990 /** Returns true if node is a Quot node. */
991 FIRM_API int is_Quot(const ir_node *node);
992 /** Returns true if node is an Add node. */
993 FIRM_API int is_Add(const ir_node *node);
994 /** Returns true if node is a Carry node. */
995 FIRM_API int is_Carry(const ir_node *node);
996 /** Returns true if node is an And node. */
997 FIRM_API int is_And(const ir_node *node);
998 /** Returns true if node is an Or node. */
999 FIRM_API int is_Or(const ir_node *node);
1000 /** Returns true if node is an Eor node. */
1001 FIRM_API int is_Eor(const ir_node *node);
1002 /** Returns true if node is a Sub node. */
1003 FIRM_API int is_Sub(const ir_node *node);
1004 /** Returns true if node is a Not node. */
1005 FIRM_API int is_Not(const ir_node *node);
1006 /** Returns true if node is a Shl node. */
1007 FIRM_API int is_Shl(const ir_node *node);
1008 /** Returns true if node is a Shr node. */
1009 FIRM_API int is_Shr(const ir_node *node);
1010 /** Returns true if node is a Shrs node. */
1011 FIRM_API int is_Shrs(const ir_node *node);
1012 /** Returns true if node is a Rotl node. */
1013 FIRM_API int is_Rotl(const ir_node *node);
1014 /** Returns true if node is an Id node. */
1015 FIRM_API int is_Id(const ir_node *node);
1016 /** Returns true if node is a Tuple node. */
1017 FIRM_API int is_Tuple(const ir_node *node);
1018 /** Returns true if node is a Bound node. */
1019 FIRM_API int is_Bound(const ir_node *node);
1020 /** Returns true if the node is not a Block */
1021 FIRM_API int is_no_Block(const ir_node *node);
1022 /** Returns true if the node is a Block */
1023 FIRM_API int is_Block(const ir_node *node);
1024 /** Returns true if node is an Unknown node. */
1025 FIRM_API int is_Unknown(const ir_node *node);
1026 /** Returns true if node is a Return node. */
1027 FIRM_API int is_Return(const ir_node *node);
1028 /** Returns true if node is a Call node. */
1029 FIRM_API int is_Call(const ir_node *node);
1030 /** Returns true if node is a Builtin node. */
1031 FIRM_API int is_Builtin(const ir_node *node);
1032 /** Returns true if node is a Sel node. */
1033 FIRM_API int is_Sel(const ir_node *node);
1034 /** Returns true if node is a Mul node. */
1035 FIRM_API int is_Mul(const ir_node *node);
1036 /** Returns true if node is a Mulh node. */
1037 FIRM_API int is_Mulh(const ir_node *node);
1038 /** Returns true if node is a Mux node. */
1039 FIRM_API int is_Mux(const ir_node *node);
1040 /** Returns true if node is a Load node. */
1041 FIRM_API int is_Load(const ir_node *node);
1042 /** Returns true if node is a Store node. */
1043 FIRM_API int is_Store(const ir_node *node);
1044 /** Returns true if node is a Sync node. */
1045 FIRM_API int is_Sync(const ir_node *node);
1046 /** Returns true if node is a Confirm node. */
1047 FIRM_API int is_Confirm(const ir_node *node);
1048 /** Returns true if node is a Pin node. */
1049 FIRM_API int is_Pin(const ir_node *node);
1050 /** Returns true if node is a SymConst node. */
1051 FIRM_API int is_SymConst(const ir_node *node);
1052 /** Returns true if node is a SymConst node with kind symconst_addr_ent. */
1053 FIRM_API int is_SymConst_addr_ent(const ir_node *node);
1054 /** Returns true if node is a Cond node. */
1055 FIRM_API int is_Cond(const ir_node *node);
1056 /** Returns true of node is a CopyB node. */
1057 FIRM_API int is_CopyB(const ir_node *node);
1058 /** Returns true if node is a Cmp node. */
1059 FIRM_API int is_Cmp(const ir_node *node);
1060 /** Returns true if node is an Alloc node. */
1061 FIRM_API int is_Alloc(const ir_node *node);
1062 /** Returns true if node is a Free node. */
1063 FIRM_API int is_Free(const ir_node *node);
1064 /** Returns true if a node is a Jmp node. */
1065 FIRM_API int is_Jmp(const ir_node *node);
1066 /** Returns true if a node is a IJmp node. */
1067 FIRM_API int is_IJmp(const ir_node *node);
1068 /** Returns true if a node is a Raise node. */
1069 FIRM_API int is_Raise(const ir_node *node);
1070 /** Returns true if a node is an ASM node. */
1071 FIRM_API int is_ASM(const ir_node *node);
1072 /** Returns true if a node is a Dummy node. */
1073 FIRM_API int is_Dummy(const ir_node *node);
1074 /** Returns true if a node is an Anchor node */
1075 FIRM_API int is_Anchor(const ir_node *node);
1076 /** Returns true if a node is a Borrow node */
1077 FIRM_API int is_Borrow(const ir_node *node);
1078 /** Returns true if a node is a Break node */
1079 FIRM_API int is_Break(const ir_node *node);
1080 /** Returns true if a node is an instff node */
1081 FIRM_API int is_InstOf(const ir_node *node);
1082 /** Returns true if node is a Proj node */
1083 FIRM_API int is_Proj(const ir_node *node);
1085 /** Returns true if the operation manipulates control flow:
1086 Start, End, Jmp, Cond, Return, Raise, Bad */
1087 FIRM_API int is_cfop(const ir_node *node);
1089 /** Returns true if the operation can change the control flow because
1090 of an exception: Call, Quot, DivMod, Div, Mod, Load, Store, Alloc,
1091 Bad. Raise is not fragile, but a unconditional jump. */
1092 FIRM_API int is_fragile_op(const ir_node *node);
1093 /** Returns the memory operand of fragile operations. */
1094 FIRM_API ir_node *get_fragile_op_mem(ir_node *node);
1095 /** Returns the result mode of a Div operation. */
1096 FIRM_API ir_mode *get_divop_resmod(const ir_node *node);
1098 /** Returns true if the operation is a forking control flow
1099 * operation: Cond. */
1100 FIRM_API int is_irn_forking(const ir_node *node);
1103 * Copies attributes stored in the old node to a new node.
1104 * Assumes both have the same opcode and sufficient size.
1106 * @param irg The irg of the new_node (get_irn_irg on it might not work
1108 * @param old_node the node where the attributes are copied from
1109 * @param new_node node the attributes get copies to.
1111 * This copies all essential information to the new node. It does not copy
1112 * temporal or calculated information like visited flags or results of dominance
1113 * or loop calculations
1115 FIRM_API void copy_node_attr(ir_graph *irg, const ir_node *old_node, ir_node *new_node);
1117 /** Return the type associated with the value produced by n
1118 * if the node remarks this type as it is the case for
1119 * Cast, Const, SymConst and some Proj nodes or unknown_type. */
1120 FIRM_API ir_type *get_irn_type(ir_node *n);
1122 /** Return the type attribute of a node n (SymConst, Call, Alloc, Free,
1124 FIRM_API ir_type *get_irn_type_attr(ir_node *n);
1126 /** Return the entity attribute of a node n (SymConst, Sel) or NULL. */
1127 FIRM_API ir_entity *get_irn_entity_attr(ir_node *n);
1129 /** Returns non-zero for constant-like nodes. */
1130 FIRM_API int is_irn_constlike(const ir_node *node);
1133 * Returns non-zero for nodes that must be always optimized
1134 * (Phi, Id. Proj, Cond, Block, Confirm ...).
1136 FIRM_API int is_irn_always_opt(const ir_node *node);
1139 * Returns non-zero for nodes that are allowed to have keep-alives and
1140 * are neither Block nor PhiM.
1142 FIRM_API int is_irn_keep(const ir_node *node);
1145 * Returns non-zero for nodes that are always placed in the start block.
1147 FIRM_API int is_irn_start_block_placed(const ir_node *node);
1150 * Returns non-zero for nodes that are machine operations.
1152 FIRM_API int is_irn_machine_op(const ir_node *node);
1155 * Returns non-zero for nodes that are machine operands.
1157 FIRM_API int is_irn_machine_operand(const ir_node *node);
1160 * Returns non-zero for nodes that have the n'th user machine flag set.
1162 FIRM_API int is_irn_machine_user(const ir_node *node, unsigned n);
1165 * Returns non-zero for nodes that are CSE neutral to its users.
1167 FIRM_API int is_irn_cse_neutral(const ir_node *node);
1170 * A type to express conditional jump predictions.
1173 COND_JMP_PRED_NONE, /**< No jump prediction. Default. */
1174 COND_JMP_PRED_TRUE, /**< The True case is predicted. */
1175 COND_JMP_PRED_FALSE /**< The False case is predicted. */
1176 } cond_jmp_predicate;
1178 /** Gets the string representation of the jump prediction. */
1179 FIRM_API const char *get_cond_jmp_predicate_name(cond_jmp_predicate pred);
1181 /** Returns the conditional jump prediction of a Cond node. */
1182 FIRM_API cond_jmp_predicate get_Cond_jmp_pred(const ir_node *cond);
1184 /** Sets a new conditional jump prediction. */
1185 FIRM_API void set_Cond_jmp_pred(ir_node *cond, cond_jmp_predicate pred);
1187 /** Checks whether a node represents a global address. */
1188 FIRM_API int is_Global(const ir_node *node);
1190 /* Returns the entity of a global address. */
1191 FIRM_API ir_entity *get_Global_entity(const ir_node *node);
1194 * Access custom node data.
1195 * The data must have been registered with
1196 * register_additional_node_data() before.
1197 * @param node The ir node to get the data from.
1198 * @param type The type of the data you registered.
1199 * @param off The value returned by register_additional_node_data().
1200 * @return A pointer of type @p type.
1202 #define get_irn_data(node,type,off) \
1203 (assert(off > 0 && "Invalid node data offset"), (type *) ((char *) (node) - (off)))
1206 * Get the pointer to the node some custom data belongs to.
1207 * @param data The pointer to the custom data.
1208 * @param off The number as returned by register_additional_node_data().
1209 * @return A pointer to the ir node the custom data belongs to.
1211 #define get_irn_data_base(data,off) \
1212 (assert(off > 0 && "Invalid node data offset"), (ir_node *) ((char *) (data) + (off)))
1215 * Request additional data to be allocated with an ir node.
1216 * @param size The size of the additional data required.
1217 * @return A positive number, if the operation was successful, which
1218 * must be passed to the access macro get_irn_data(), 0 if the
1219 * registration failed.
1221 FIRM_API unsigned firm_register_additional_node_data(unsigned size);
1224 * Return a pointer to the node attributes.
1225 * Needed for user-defined nodes.
1227 FIRM_API void *get_irn_generic_attr(ir_node *node);
1228 FIRM_API const void *get_irn_generic_attr_const(const ir_node *node);
1231 * Returns the unique node index for the node in its graph.
1232 * This index is used to access phase information for this node.
1234 FIRM_API unsigned get_irn_idx(const ir_node *node);
1237 * Sets the debug information of a node.
1239 * @param n The node.
1240 * @param db The debug info.
1242 FIRM_API void set_irn_dbg_info(ir_node *n, dbg_info *db);
1245 * Returns the debug information of an node.
1247 * @param n The node.
1249 FIRM_API dbg_info *get_irn_dbg_info(const ir_node *n);
1252 * Calculate a hash value of a node. Only inputs, mode and opcode are used.
1254 * @param node the node to hash
1256 FIRM_API unsigned firm_default_hash(const ir_node *node);
1259 * returns a descriptive name of a node (containing type+number)
1261 FIRM_API const char *gdb_node_helper(void *firm_object);
1263 /*@}*/ /* end of ir_node group definition */