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 ident for a string representation of the mode .*/
156 FIRM_API ident *get_irn_modeident(const ir_node *node);
157 /** Gets the string representation of the mode .*/
158 FIRM_API const char *get_irn_modename(const ir_node *node);
159 /** Gets the opcode struct of the node. */
160 FIRM_API ir_op *get_irn_op(const ir_node *node);
161 /** Sets the opcode struct of the node. */
162 FIRM_API void set_irn_op(ir_node *node, ir_op *op);
163 /** Gets the opcode-enum of the node. */
164 FIRM_API unsigned get_irn_opcode(const ir_node *node);
165 /** Get the string representation of the opcode. */
166 FIRM_API const char *get_irn_opname(const ir_node *node);
167 /** Get the ident for a string representation of the opcode. */
168 FIRM_API ident *get_irn_opident(const ir_node *node);
169 /** If arg is an argument of the node, returns it's position, -1 otherwise */
170 FIRM_API int get_irn_pred_pos(ir_node *node, ir_node *arg);
171 /** Gets the visited counter of a node. */
172 FIRM_API ir_visited_t get_irn_visited(const ir_node *node);
173 /** Sets the visited counter of a node. */
174 FIRM_API void set_irn_visited(ir_node *node, ir_visited_t visited);
175 /** Sets visited to get_irg_visited(current_ir_graph). */
176 FIRM_API void mark_irn_visited(ir_node *node);
177 /** Returns 1 if visited >= get_irg_visited(current_ir_graph). */
178 FIRM_API int irn_visited(const ir_node *node);
179 /** Returns 1 if visited >= get_irg_visited(current_ir_graph). Marks the node
180 * visited, if it was not. */
181 FIRM_API int irn_visited_else_mark(ir_node *node);
184 * Sets the link of a node.
185 * Only allowed if the graph is NOT in phase_building.
187 FIRM_API void set_irn_link(ir_node *node, void *link);
189 /** Returns the link of a node. */
190 FIRM_API void *get_irn_link(const ir_node *node);
192 /** Returns the ir_graph this node belongs to. */
193 FIRM_API ir_graph *get_irn_irg(const ir_node *node);
195 /** Outputs a unique number for this node if libFIRM is compiled for
196 debugging, (configure with --enable-debug) else returns address
197 of node cast to long. */
198 FIRM_API long get_irn_node_nr(const ir_node *node);
200 /** Returns the pinned state of a node.
202 * Returns whether the node _always_ must be pinned.
203 * I.e., the node is not floating after global cse.
205 * @returns Either state op_pin_state_pinned or op_pin_state_floats.
207 FIRM_API op_pin_state get_irn_pinned(const ir_node *node);
209 /** Set pin state for nodes with op pin state op_pin_state_exc_pinned */
210 FIRM_API void set_irn_pinned(ir_node *node, op_pin_state state);
212 /** Returns whether the node is currently pinned.
214 * If get_irn_pinned returns op_pin_state_floats and the graph the
215 * node belongs to is in state op_poin_state_floats then this function
216 * returns 'floats', else 'pinned'.
218 FIRM_API op_pin_state is_irn_pinned_in_irg(const ir_node *node);
221 * IR node constructor.
222 * Create a new IR node in irg, with an op, mode, arity and
223 * some incoming IR nodes.
224 * This constructor is used in every specific IR node constructor.
226 * @param db Debug info.
227 * @param irg IR-graph on with this new node should be constructed.
228 * @param block The block the new node belongs to
229 * @param op The opcode of the new node.
230 * @param mode The mode of the new node.
231 * @param arity The arity of the new node, <0 if can be changed dynamically.
232 * @param in An array of arity predecessor nodes.
234 FIRM_API ir_node *new_ir_node(dbg_info *db, ir_graph *irg, ir_node *block,
235 ir_op *op, ir_mode *mode,
236 int arity, ir_node *in[]);
239 * Return the block the node belongs to. This is only
240 * possible for pinned nodes or if the graph is in pinned state.
241 * Otherwise the block may be incorrect. This condition is
242 * now checked by an assertion.
244 * This works for all except Block. It can return Blocks or the Bad node.
246 * To express the difference to access routines that work for all
247 * nodes we use infix "nodes" and do not name this function
248 * get_irn_block(). */
249 FIRM_API ir_node *get_nodes_block (const ir_node *node);
251 /** Sets the Block of a node. */
252 FIRM_API void set_nodes_block (ir_node *node, ir_node *block);
255 * Return the MacroBlock the node belongs to. This is only
256 * possible for pinned nodes or if the graph is in pinned state.
257 * Otherwise the MacroBlock may be incorrect. This condition is
258 * now checked by an assertion.
260 * This works for all except Block. It can return Blocks or the Bad node.
262 * To express the difference to access routines that work for all
263 * nodes we use infix "nodes" and do not name this function
264 * get_irn_MacroBlock(). */
265 FIRM_API ir_node *get_nodes_MacroBlock(const ir_node *node);
267 /** Test whether arbitrary node is frame pointer.
269 * Test whether arbitrary node is frame pointer, i.e. Proj(pn_Start_P_frame_base)
270 * from Start. If so returns frame type, else Null. */
271 FIRM_API ir_type *is_frame_pointer(const ir_node *n);
273 /** Test whether arbitrary node is the thread local storage (tls) pointer.
275 * Test whether arbitrary node is tls pointer, i.e. Proj(pn_Start_P_tls)
276 * from Start. If so returns tls type, else Null. */
277 FIRM_API ir_type *is_tls_pointer(const ir_node *n);
279 /** Return the number of control flow predecessors of a block. */
280 FIRM_API int get_Block_n_cfgpreds(const ir_node *block);
281 /** Return the control flow predecessor of a block at a given position. */
282 FIRM_API ir_node *get_Block_cfgpred(const ir_node *block, int pos);
283 /** Set the control flow predecessor of a block at a given position. */
284 FIRM_API void set_Block_cfgpred(ir_node *block, int pos, ir_node *pred);
287 * Return the position of the predecessor block pred in the inputs
288 * of the block block.
290 * @param block the block
291 * @param pred a predecessor block of block
293 * @return the position of pred in block or -1
295 * @note When using the old extended basic block form for blocks
296 * with exception exists, a predecessor block might have more
297 * than one position. In that case it is not specified, with is returned.
299 FIRM_API int get_Block_cfgpred_pos(const ir_node *block, const ir_node *pred);
301 /** Get the predecessor block.
303 * Returns the block corresponding to the predecessor pos of block.
305 * There are several ambiguities we resolve with this function:
306 * - The direct predecessor can be a Proj, which is not pinned.
307 * We walk from the predecessor to the next pinned node
308 * (skip_Proj) and return the block that node is in.
309 * - If we encounter the Bad node, this function does not return
310 * Start block, but the Bad node.
312 FIRM_API ir_node *get_Block_cfgpred_block(const ir_node *node, int pos);
314 /** Return the matured flag of a block */
315 FIRM_API int get_Block_matured(const ir_node *block);
316 /** set the matured flag of a block. */
317 FIRM_API void set_Block_matured(ir_node *block, int matured);
319 /** A visited flag only for block nodes.
320 * @see also: get_irn_visited() inc_irg_visited() inc_irg_block_visited()*/
321 FIRM_API ir_visited_t get_Block_block_visited(const ir_node *block);
322 FIRM_API void set_Block_block_visited(ir_node *block, ir_visited_t visit);
325 * Marks a block as dead but do not replace it with a Bad node.
326 * Dead blocks are removed in the con
328 FIRM_API ir_node *set_Block_dead(ir_node *block);
329 FIRM_API int is_Block_dead(const ir_node *block);
331 /* For this current_ir_graph must be set. */
332 FIRM_API void mark_Block_block_visited(ir_node *node);
333 FIRM_API int Block_block_visited(const ir_node *node);
335 /** Returns the extended basic block a block belongs to. */
336 FIRM_API ir_extblk *get_Block_extbb(const ir_node *block);
337 /** Sets the extended basic block a block belongs to. */
338 FIRM_API void set_Block_extbb(ir_node *block, ir_extblk *extblk);
339 /** Get the Macro Block header of a (sub-) block. */
340 FIRM_API ir_node *get_Block_MacroBlock(const ir_node *block);
341 /** Set the Macro Block header of a (sub-) block. */
342 FIRM_API void set_Block_MacroBlock(ir_node *block, ir_node *mbh);
343 /** Get the Macro Block header of a node. */
344 FIRM_API ir_node *get_irn_MacroBlock(const ir_node *n);
345 /** Returns the ir_graph this Block belongs to. */
346 FIRM_API ir_graph *get_Block_irg(const ir_node *block);
347 /** Returns non-zero if the block has an entity assigned */
348 FIRM_API int has_Block_entity(const ir_node *block);
349 /** Returns the entity for a Block */
350 FIRM_API ir_entity *get_Block_entity(const ir_node *block);
351 /** Returns the entity for a Block (creating it if necessary) */
352 FIRM_API ir_entity *create_Block_entity(ir_node *block);
353 /** Set a new entity for a block */
354 FIRM_API void set_Block_entity(ir_node *block, ir_entity *entity);
355 /** Gets the head of the Phi list for this block. */
356 FIRM_API ir_node *get_Block_phis(const ir_node *block);
357 /** Sets the head of the Phi list for this block. */
358 FIRM_API void set_Block_phis(ir_node *block, ir_node *phi);
359 /** Add a Phi node to the list of Block Phi's. */
360 FIRM_API void add_Block_phi(ir_node *block, ir_node *phi);
361 /** Get the Block mark (single bit). */
362 FIRM_API unsigned get_Block_mark(const ir_node *block);
363 /** Set the Block mark (single bit). */
364 FIRM_API void set_Block_mark(ir_node *block, unsigned mark);
366 /** Return the number of Keep alive node. */
367 FIRM_API int get_End_n_keepalives(const ir_node *end);
368 /** Return the Keep alive node a position pos. */
369 FIRM_API ir_node *get_End_keepalive(const ir_node *end, int pos);
370 /** Keep alive dedicated nodes. These must be either PhiM or Block nodes. */
371 FIRM_API void add_End_keepalive(ir_node *end, ir_node *ka);
372 /** Set the Keep alive node at position pos. */
373 FIRM_API void set_End_keepalive(ir_node *end, int pos, ir_node *ka);
376 * Set new keep-alives.
377 * Beware: This might be an expensive operation if dynamic edges are enabled,
378 * so avoid it in the backend.
380 FIRM_API void set_End_keepalives(ir_node *end, int n, ir_node *in[]);
382 /** Remove irn from the keep-alive set. */
383 FIRM_API void remove_End_keepalive(ir_node *end, ir_node *irn);
385 /* Remove Bads, NoMem and doublets from the keep-alive set. */
386 FIRM_API void remove_End_Bads_and_doublets(ir_node *end);
388 /** Some parts of the End node are allocated separately -- their memory
389 is not recovered by dead_node_elimination if a End node is dead.
390 free_End() frees these data structures. */
391 FIRM_API void free_End(ir_node *end);
393 FIRM_API ir_node **get_Return_res_arr(ir_node *node);
394 FIRM_API int get_Return_n_ress(const ir_node *node);
395 FIRM_API ir_node *get_Return_res(const ir_node *node, int pos);
396 FIRM_API void set_Return_res(ir_node *node, int pos, ir_node *res);
398 /** Return non-zero if the given Const node represents the 0 constant. */
399 FIRM_API int is_Const_null(const ir_node *node);
401 /** Return non-zero if the given Const node represents the 1 constant. */
402 FIRM_API int is_Const_one(const ir_node *node);
404 /** Return non-zero if the given Const node represents the constant with all bits set. */
405 FIRM_API int is_Const_all_one(const ir_node *node);
407 /** Returns true if a node is a Conv node with strict attribute set. */
408 FIRM_API int is_strictConv(const ir_node *node);
410 /** Returns true if node is a SymConst node with kind symconst_addr_ent. */
411 FIRM_API int is_SymConst_addr_ent(const ir_node *node);
413 /** Returns the source language type of a Const node.
414 * Must be an atomic type. Mode of type must be mode of node.
416 FIRM_API ir_type *get_Const_type(const ir_node *node);
418 /** Sets the source language type of a Const node. */
419 FIRM_API void set_Const_type(ir_node *node, ir_type *tp);
421 /** Returns non-zero if s symconst kind has a type attribute */
422 #define SYMCONST_HAS_TYPE(kind) ((kind) <= symconst_type_align)
424 /** Returns non-zero if s symconst kind has an entity attribute */
425 #define SYMCONST_HAS_ENT(kind) ((kind) == symconst_addr_ent || (kind) == symconst_ofs_ent)
427 /** Returns non-zero if s symconst kind has an enum_const attribute */
428 #define SYMCONST_HAS_ENUM(kind) ((kind) == symconst_enum_const)
430 /** Get the kind of the SymConst. */
431 FIRM_API symconst_kind get_SymConst_kind(const ir_node *node);
432 /** Set the kind of the SymConst. */
433 FIRM_API void set_SymConst_kind(ir_node *node, symconst_kind num);
435 /** Only to access SymConst of kind type_tag or size. Else assertion: */
436 FIRM_API ir_type *get_SymConst_type(const ir_node *node);
437 FIRM_API void set_SymConst_type(ir_node *node, ir_type *tp);
439 /** Only to access SymConst of kind addr_ent. Else assertion: */
440 FIRM_API ir_entity *get_SymConst_entity(const ir_node *node);
441 FIRM_API void set_SymConst_entity(ir_node *node, ir_entity *ent);
443 /** Only to access SymConst of kind symconst_enum_const. Else assertion: */
444 FIRM_API ir_enum_const *get_SymConst_enum(const ir_node *node);
445 FIRM_API void set_SymConst_enum(ir_node *node, ir_enum_const *ec);
447 /** Sets both: type and ptrinfo. Needed to treat the node independent of
448 its semantics. Does a memcpy for the memory sym points to. */
449 /* write 'union': firmjni then does not create a method... */
450 FIRM_API union symconst_symbol get_SymConst_symbol(const ir_node *node);
451 FIRM_API void set_SymConst_symbol(ir_node *node,
452 union symconst_symbol sym);
454 /** Access the type of the value represented by the SymConst.
456 * Example: primitive type int for SymConst size. */
457 FIRM_API ir_type *get_SymConst_value_type(const ir_node *node);
458 FIRM_API void set_SymConst_value_type(ir_node *node, ir_type *tp);
460 FIRM_API ir_node **get_Sel_index_arr(ir_node *node);
461 FIRM_API int get_Sel_n_indexs(const ir_node *node);
462 FIRM_API ir_node *get_Sel_index(const ir_node *node, int pos);
463 FIRM_API void set_Sel_index(ir_node *node, int pos, ir_node *index);
465 FIRM_API ir_node **get_Call_param_arr(ir_node *node);
466 /** Gets the number of parameters of a call. */
467 FIRM_API int get_Call_n_params(const ir_node *node);
468 /** Gets the call parameter at position pos. */
469 FIRM_API ir_node *get_Call_param(const ir_node *node, int pos);
470 /** Sets the call parameter at position pos. */
471 FIRM_API void set_Call_param(ir_node *node, int pos, ir_node *param);
474 * Returns non-zero if a Call is surely a self-recursive Call.
475 * Beware: if this functions returns 0, the call might be self-recursive!
477 FIRM_API int is_self_recursive_Call(const ir_node *call);
479 /** Set, get and remove the callee information for a Call node.
481 * The callee information lists all method entities that can be called
482 * from this node. If the address expression can not be analyzed fully,
483 * e.g., as entities can be called that are not in the compilation unit,
484 * the array contains the unknown_entity. The array contains only entities
485 * with peculiarity_existent, but with all kinds of visibility. The entities
486 * not necessarily contain an irg.
488 * The array is only accessible if callee information is valid. See flag
491 * The memory allocated for the array is managed automatically, i.e., it must
492 * not be freed if the Call node is removed from the graph.
494 * @param node A Call node.
496 FIRM_API int Call_has_callees(const ir_node *node);
497 FIRM_API int get_Call_n_callees(const ir_node *node);
498 FIRM_API ir_entity *get_Call_callee(const ir_node *node, int pos);
500 /** Set the full callee array.
502 * The passed array is copied. Assumes current_ir_graph set properly! */
503 FIRM_API void set_Call_callee_arr(ir_node *node, const int n, ir_entity **arr);
504 FIRM_API void remove_Call_callee_arr(ir_node *node);
506 FIRM_API ir_node **get_Builtin_param_arr(ir_node *node);
507 /** Gets the number of parameters of a Builtin. */
508 FIRM_API int get_Builtin_n_params(const ir_node *node);
509 /** Gets the Builtin parameter at position pos. */
510 FIRM_API ir_node *get_Builtin_param(const ir_node *node, int pos);
511 /** Sets the Builtin parameter at position pos. */
512 FIRM_API void set_Builtin_param(ir_node *node, int pos, ir_node *param);
513 /** Returns a human readable string for the ir_builtin_kind. */
514 FIRM_API const char *get_builtin_kind_name(ir_builtin_kind kind);
516 /* For unary and binary arithmetic operations the access to the
517 operands can be factored out. Left is the first, right the
518 second arithmetic value as listed in tech report 1999-44.
519 unops are: Minus, Abs, Not, Conv, Cast
520 binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
521 Shr, Shrs, Rotl, Cmp */
522 FIRM_API int is_unop(const ir_node *node);
523 FIRM_API ir_node *get_unop_op(const ir_node *node);
524 FIRM_API void set_unop_op(ir_node *node, ir_node *op);
525 FIRM_API int is_binop(const ir_node *node);
526 FIRM_API ir_node *get_binop_left(const ir_node *node);
527 FIRM_API void set_binop_left(ir_node *node, ir_node *left);
528 FIRM_API ir_node *get_binop_right(const ir_node *node);
529 FIRM_API void set_binop_right(ir_node *node, ir_node *right);
531 /** returns the pnc name from an pnc constant */
532 FIRM_API const char *get_pnc_string(int pnc);
534 /** Calculates the negated (Complement(R)) pnc condition. */
535 FIRM_API pn_Cmp get_negated_pnc(long pnc, ir_mode *mode);
537 /** Calculates the inversed (R^-1) pnc condition, i.e., "<" --> ">" */
538 FIRM_API pn_Cmp get_inversed_pnc(long pnc);
540 /** An alternative name for get_inversed_pnc() that can be better memorized. */
541 #define get_mirrored_pnc(pnc) get_inversed_pnc(pnc)
543 /** Checks for upcast.
545 * Returns true if the Cast node casts a class type to a super type.
546 * Works also for pointers to classes (recursively).
548 * Needs typeinfo calculated.
550 FIRM_API int is_Cast_upcast(ir_node *node);
552 /** Checks for downcast.
554 * Returns true if the Cast node casts a class type to a sub type.
555 * Works also for pointers to classes (recursively).
557 * Needs typeinfo calculated.
559 FIRM_API int is_Cast_downcast(ir_node *node);
561 /** Returns true if irg in phase phase_building and the Phi has zero
562 predecessors. It's a Phi0 then. */
563 FIRM_API int is_Phi0(const ir_node *n);
564 FIRM_API ir_node **get_Phi_preds_arr(ir_node *node);
565 FIRM_API int get_Phi_n_preds(const ir_node *node);
566 FIRM_API ir_node *get_Phi_pred(const ir_node *node, int pos);
567 FIRM_API void set_Phi_pred(ir_node *node, int pos, ir_node *pred);
569 * Returns the next element of a block phi list.
571 FIRM_API ir_node *get_Phi_next(const ir_node *phi);
573 * Sets the next link of a block Phi list.
575 FIRM_API void set_Phi_next(ir_node *phi, ir_node *next);
577 /** Return true if parameter is a memory operation.
579 * A memory operation is an operation that changes the
580 * memory. I.e., a Load or a Store operation.
582 FIRM_API int is_memop(const ir_node *node);
583 FIRM_API ir_node *get_memop_mem(const ir_node *node);
584 FIRM_API void set_memop_mem(ir_node *node, ir_node *mem);
585 FIRM_API ir_node *get_memop_ptr(const ir_node *node);
586 FIRM_API void set_memop_ptr(ir_node *node, ir_node *ptr);
588 FIRM_API ir_volatility get_Load_volatility(const ir_node *node);
589 FIRM_API void set_Load_volatility(ir_node *node, ir_volatility volatility);
590 FIRM_API ir_align get_Load_align(const ir_node *node);
591 FIRM_API void set_Load_align(ir_node *node, ir_align align);
593 FIRM_API ir_volatility get_Store_volatility(const ir_node *node);
594 FIRM_API void set_Store_volatility(ir_node *node, ir_volatility volatility);
595 FIRM_API ir_align get_Store_align(const ir_node *node);
596 FIRM_API void set_Store_align(ir_node *node, ir_align align);
598 FIRM_API ir_node **get_Sync_preds_arr(ir_node *node);
599 FIRM_API int get_Sync_n_preds(const ir_node *node);
600 FIRM_API ir_node *get_Sync_pred(const ir_node *node, int pos);
601 FIRM_API void set_Sync_pred(ir_node *node, int pos, ir_node *pred);
602 FIRM_API void add_Sync_pred(ir_node *node, ir_node *pred);
604 /** Returns the source language type of a Proj node.
605 * Must be an atomic type. Mode of type must be mode of node.
607 FIRM_API ir_type *get_Proj_type(const ir_node *node);
609 /** Return the projection number of a Proj node. */
610 FIRM_API long get_Proj_proj(const ir_node *node);
611 FIRM_API void set_Proj_proj(ir_node *node, long proj);
614 * Returns non-zero if a node is a routine parameter.
616 * @param node the Proj node to test
618 FIRM_API int is_arg_Proj(const ir_node *node);
620 FIRM_API ir_node **get_Tuple_preds_arr(ir_node *node);
621 FIRM_API int get_Tuple_n_preds(const ir_node *node);
622 FIRM_API ir_node *get_Tuple_pred(const ir_node *node, int pos);
623 FIRM_API void set_Tuple_pred(ir_node *node, int pos, ir_node *pred);
625 /** Return the number of input constraints for an ASM node. */
626 FIRM_API int get_ASM_n_input_constraints(const ir_node *node);
627 /** Return the number of output constraints for an ASM node. */
628 FIRM_API int get_ASM_n_output_constraints(const ir_node *node);
629 /** Return the number of clobbered registers for an ASM node. */
630 FIRM_API int get_ASM_n_clobbers(const ir_node *node);
634 * NAME Auxiliary routines
638 /** Returns operand of node if node is a Proj. */
639 FIRM_API ir_node *skip_Proj(ir_node *node);
640 /** Returns operand of node if node is a Proj. */
641 FIRM_API const ir_node *skip_Proj_const(const ir_node *node);
642 /** Returns operand of node if node is a Id. */
643 FIRM_API ir_node *skip_Id(ir_node *node); /* Old name is skip_nop(). */
644 /** Returns corresponding operand of Tuple if node is a Proj from
646 FIRM_API ir_node *skip_Tuple(ir_node *node);
647 /** Returns operand of node if node is a Cast. */
648 FIRM_API ir_node *skip_Cast(ir_node *node);
649 FIRM_API const ir_node *skip_Cast_const(const ir_node *node);
650 /** Returns operand of node if node is a Pin. */
651 FIRM_API ir_node *skip_Pin(ir_node *node);
652 /** Returns operand of node if node is a Confirm */
653 FIRM_API ir_node *skip_Confirm(ir_node *node);
654 /** Skip all high-level Operations (including Cast, Confirm). */
655 FIRM_API ir_node *skip_HighLevel_ops(ir_node *node);
656 /** Returns true if the operation manipulates control flow:
657 Start, End, Jmp, Cond, Return, Raise, Bad */
658 FIRM_API int is_cfop(const ir_node *node);
660 /** Returns true if the operation can change the control flow because
661 of an exception: Call, Quot, DivMod, Div, Mod, Load, Store, Alloc,
662 Bad. Raise is not fragile, but a unconditional jump. */
663 FIRM_API int is_fragile_op(const ir_node *node);
664 /** Returns the memory operand of fragile operations. */
665 FIRM_API ir_node *get_fragile_op_mem(ir_node *node);
666 /** Returns the result mode of a Div operation. */
667 FIRM_API ir_mode *get_divop_resmod(const ir_node *node);
669 /** Returns true if the operation is a forking control flow
670 * operation: Cond. */
671 FIRM_API int is_irn_forking(const ir_node *node);
674 * Copies attributes stored in the old node to a new node.
675 * Assumes both have the same opcode and sufficient size.
677 * @param irg The irg of the new_node (get_irn_irg on it might not work
679 * @param old_node the node where the attributes are copied from
680 * @param new_node node the attributes get copies to.
682 * This copies all essential information to the new node. It does not copy
683 * temporal or calculated information like visited flags or results of dominance
684 * or loop calculations
686 FIRM_API void copy_node_attr(ir_graph *irg, const ir_node *old_node, ir_node *new_node);
688 /** Return the type associated with the value produced by n
689 * if the node remarks this type as it is the case for
690 * Cast, Const, SymConst and some Proj nodes or unknown_type. */
691 FIRM_API ir_type *get_irn_type(ir_node *n);
693 /** Return the type attribute of a node n (SymConst, Call, Alloc, Free,
695 FIRM_API ir_type *get_irn_type_attr(ir_node *n);
697 /** Return the entity attribute of a node n (SymConst, Sel) or NULL. */
698 FIRM_API ir_entity *get_irn_entity_attr(ir_node *n);
700 /** Returns non-zero for constant-like nodes. */
701 FIRM_API int is_irn_constlike(const ir_node *node);
704 * Returns non-zero for nodes that must be always optimized
705 * (Phi, Id. Proj, Cond, Block, Confirm ...).
707 FIRM_API int is_irn_always_opt(const ir_node *node);
710 * Returns non-zero for nodes that are allowed to have keep-alives and
711 * are neither Block nor PhiM.
713 FIRM_API int is_irn_keep(const ir_node *node);
716 * Returns non-zero for nodes that are always placed in the start block.
718 FIRM_API int is_irn_start_block_placed(const ir_node *node);
721 * Returns non-zero for nodes that are machine operations.
723 FIRM_API int is_irn_machine_op(const ir_node *node);
726 * Returns non-zero for nodes that are machine operands.
728 FIRM_API int is_irn_machine_operand(const ir_node *node);
731 * Returns non-zero for nodes that have the n'th user machine flag set.
733 FIRM_API int is_irn_machine_user(const ir_node *node, unsigned n);
736 * Returns non-zero for nodes that are CSE neutral to its users.
738 FIRM_API int is_irn_cse_neutral(const ir_node *node);
740 /** Gets the string representation of the jump prediction. */
741 FIRM_API const char *get_cond_jmp_predicate_name(cond_jmp_predicate pred);
743 /** Checks whether a node represents a global address. */
744 FIRM_API int is_Global(const ir_node *node);
746 /* Returns the entity of a global address. */
747 FIRM_API ir_entity *get_Global_entity(const ir_node *node);
750 * Access custom node data.
751 * The data must have been registered with
752 * register_additional_node_data() before.
753 * @param node The ir node to get the data from.
754 * @param type The type of the data you registered.
755 * @param off The value returned by register_additional_node_data().
756 * @return A pointer of type @p type.
758 #define get_irn_data(node,type,off) \
759 (assert(off > 0 && "Invalid node data offset"), (type *) ((char *) (node) - (off)))
762 * Get the pointer to the node some custom data belongs to.
763 * @param data The pointer to the custom data.
764 * @param off The number as returned by register_additional_node_data().
765 * @return A pointer to the ir node the custom data belongs to.
767 #define get_irn_data_base(data,off) \
768 (assert(off > 0 && "Invalid node data offset"), (ir_node *) ((char *) (data) + (off)))
771 * Request additional data to be allocated with an ir node.
772 * @param size The size of the additional data required.
773 * @return A positive number, if the operation was successful, which
774 * must be passed to the access macro get_irn_data(), 0 if the
775 * registration failed.
777 FIRM_API unsigned firm_register_additional_node_data(unsigned size);
780 * Return a pointer to the node attributes.
781 * Needed for user-defined nodes.
783 FIRM_API void *get_irn_generic_attr(ir_node *node);
784 FIRM_API const void *get_irn_generic_attr_const(const ir_node *node);
787 * Returns the unique node index for the node in its graph.
788 * This index is used to access phase information for this node.
790 FIRM_API unsigned get_irn_idx(const ir_node *node);
793 * Sets the debug information of a node.
796 * @param db The debug info.
798 FIRM_API void set_irn_dbg_info(ir_node *n, dbg_info *db);
801 * Returns the debug information of an node.
805 FIRM_API dbg_info *get_irn_dbg_info(const ir_node *n);
808 * Calculate a hash value of a node. Only inputs, mode and opcode are used.
810 * @param node the node to hash
812 FIRM_API unsigned firm_default_hash(const ir_node *node);
815 * returns a descriptive name of a node (containing type+number)
817 FIRM_API const char *gdb_node_helper(void *firm_object);
819 /*@}*/ /* end of ir_node group definition */