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 * @author Martin Trapp, Christian Schaefer
41 * Declarations of an ir node.
45 * @defgroup ir_node Declarations of an ir node.
47 * The type definition of ir_node is also in irgraph.h to resolve
48 * recursion between irnode.h and irgraph.h
50 * ir_node - a datatype representing a Firm node
52 * The common fields are:
54 * - arity - The number of predecessors in the Firm graph.
55 * - in - A list with the predecessors in the Firm graph. There are
56 * routines to access individual elements and to obtain the
57 * array. The method returning the array should not be used.
58 * - mode - The mode of the node. There are routines to get the mode
59 * but also to access the mode's fields directly.
60 * - opcode - The opcode of the node. There are routines to get the opcode
61 * but also to access the opcode's fields directly.
62 * - node_nr - A unique number for the node. Available only if debugging
68 * Some projection numbers must be always equal to support automatic phi construction
71 pn_Generic_M = 0, /**< The memory result. */
72 pn_Generic_X_regular = 1, /**< Execution result if no exception occurred. */
73 pn_Generic_X_except = 2, /**< The control flow result branching to the exception handler */
74 pn_Generic_other = 3 /**< First free projection number */
78 * Checks whether a pointer points to a ir node.
80 * @param thing an arbitrary pointer
81 * @return non-zero if the thing is a ir mode, else zero
83 int is_ir_node (const void *thing);
86 * Returns the number of predecessors without the block predecessor.
88 * @param node the IR-node
90 int get_irn_arity (const ir_node *node);
91 int get_irn_intra_arity(const ir_node *node);
92 int get_irn_inter_arity(const ir_node *node);
94 /** Replaces the old in array by a new one that will contain the ins given in
95 the parameters. Conserves the block predecessor. It copies the array passed.
96 This function is necessary to adjust in arrays of blocks, calls and phis.
97 Assumes that current_ir_graph is set to the graph containing "node".
98 "in" must contain all predecessors except the block that are required for
100 void set_irn_in(ir_node *node, int arity, ir_node *in[]);
102 /* to iterate through the predecessors without touching the array. No
103 order of predecessors guaranteed.
104 To iterate over the operands iterate from 0 to i < get_irn_arity(),
105 to iterate including the Block predecessor iterate from i = -1 to
106 i < get_irn_arity. */
107 /* Access predecessor n */
110 * Get the n-th predecessor of a node.
111 * This function removes Id predecessors.
112 * This function automatically handles intra- and interprocedural views.
114 ir_node *get_irn_n(const ir_node *node, int n);
117 * Add a artificial dependency to the node.
118 * The dependency is only inserted if it is not there already.
119 * This is only allowed in phase_backend!
121 * @param node The node.
122 * @param dep The dependency target.
124 * @return The index in the array (get_irn_dep() with that index returns @p dep).
126 int add_irn_dep(ir_node *node, ir_node *dep);
129 * Copy all dependencies from a node to another.
130 * This is only allowed in phase_backend!
132 * @param tgt The node which should be enriched.
133 * @param src The node whose dependencies shall be copied.
135 void add_irn_deps(ir_node *tgt, ir_node *src);
138 * Get the length of the dependency array.
139 * @param node The node.
140 * @return The length of the dependency array or 0 if it has not yet been allocated.
142 int get_irn_deps(const ir_node *node);
145 * Get an entry of the dependency array.
146 * @param node The node.
147 * @param pos The position.
148 * @return The node at that position.
150 ir_node *get_irn_dep(const ir_node *node, int pos);
153 * Set an entry of the dependency array.
154 * @param node The node.
155 * @param pos The position.
156 * @param dep The dependency target.
158 void set_irn_dep(ir_node *node, int pos, ir_node *dep);
162 * Get the n-th predecessor of a node in intraprocedural view.
163 * Can be used always if it's know that node is not a split one.
165 ir_node *get_irn_intra_n(const ir_node *node, int n);
168 * Get the n-th predecessor of a node in interprocedural view.
170 ir_node *get_irn_inter_n(const ir_node *node, int n);
172 /** Replace the n-th predecessor of a node with a new one. */
173 void set_irn_n(ir_node *node, int n, ir_node *in);
175 * Appends a new predecessor to a node. This only works for nodes with
177 * @returns the number of the new input
179 int add_irn_n(ir_node *node, ir_node *in);
180 /* Remove predecessor i from Sync n */
181 void del_Sync_n(ir_node *n, int i);
182 /* Sets the mode struct of node. */
183 void set_irn_mode(ir_node *node, ir_mode *mode);
184 /** Gets the mode struct of a node. */
185 ir_mode *get_irn_mode(const ir_node *node);
186 /** Gets the ident for a string representation of the mode .*/
187 ident *get_irn_modeident(const ir_node *node);
188 /** Gets the string representation of the mode .*/
189 const char *get_irn_modename(const ir_node *node);
190 /** Gets the opcode struct of the node. */
191 ir_op *get_irn_op(const ir_node *node);
192 /** Sets the opcode struct of the node. */
193 void set_irn_op(ir_node *node, ir_op *op);
194 /** Gets the opcode-enum of the node. */
195 unsigned get_irn_opcode(const ir_node *node);
196 /** Get the string representation of the opcode. */
197 const char *get_irn_opname(const ir_node *node);
198 /** Get the ident for a string representation of the opcode. */
199 ident *get_irn_opident(const ir_node *node);
200 /** If arg is an argument of the node, returns it's position, -1 otherwise */
201 int get_irn_pred_pos(ir_node *node, ir_node *arg);
202 /** Gets the visited counter of a node. */
203 ir_visited_t get_irn_visited(const ir_node *node);
204 /** Sets the visited counter of a node. */
205 void set_irn_visited(ir_node *node, ir_visited_t visited);
206 /** Sets visited to get_irg_visited(current_ir_graph). */
207 void mark_irn_visited(ir_node *node);
208 /** Returns 1 if visited >= get_irg_visited(current_ir_graph). */
209 int irn_visited(const ir_node *node);
210 /** Returns 1 if visited >= get_irg_visited(current_ir_graph). Marks the node
211 * visited, if it was not. */
212 int irn_visited_else_mark(ir_node *node);
215 * Sets the link of a node.
216 * Only allowed if the graph is NOT in phase_building.
218 void set_irn_link(ir_node *node, void *link);
220 /** Returns the link of a node. */
221 void *get_irn_link(const ir_node *node);
223 /** Returns the ir_graph this node belongs to. */
224 ir_graph *get_irn_irg(const ir_node *node);
226 /** Outputs a unique number for this node if libFIRM is compiled for
227 debugging, (configure with --enable-debug) else returns address
228 of node cast to long. */
229 long get_irn_node_nr(const ir_node *node);
231 /** Returns the pinned state of a node.
233 * Returns whether the node _always_ must be pinned.
234 * I.e., the node is not floating after global cse.
236 * @returns Either state op_pin_state_pinned or op_pin_state_floats.
238 op_pin_state get_irn_pinned(const ir_node *node);
240 /** Set pin state for nodes with op pin state op_pin_state_exc_pinned */
241 void set_irn_pinned(ir_node *node, op_pin_state state);
243 /** Returns whether the node is currently pinned.
245 * If get_irn_pinned returns op_pin_state_floats and the graph the
246 * node belongs to is in state op_poin_state_floats then this function
247 * returns 'floats', else 'pinned'.
249 op_pin_state is_irn_pinned_in_irg(const ir_node *node);
252 * IR node constructor.
253 * Create a new IR node in irg, with an op, mode, arity and
254 * some incoming IR nodes.
255 * This constructor is used in every specific IR node constructor.
257 * @param db Debug info.
258 * @param irg IR-graph on with this new node should be constructed.
259 * @param block The block the new node belongs to
260 * @param op The opcode of the new node.
261 * @param mode The mode of the new node.
262 * @param arity The arity of the new node, <0 if can be changed dynamically.
263 * @param in An array of arity predecessor nodes.
265 ir_node *new_ir_node(dbg_info *db, ir_graph *irg, ir_node *block, ir_op *op,
266 ir_mode *mode, int arity, ir_node *in[]);
269 * Return the block the node belongs to. This is only
270 * possible for pinned nodes or if the graph is in pinned state.
271 * Otherwise the block may be incorrect. This condition is
272 * now checked by an assertion.
274 * This works for all except Block. It can return Blocks or the Bad node.
276 * To express the difference to access routines that work for all
277 * nodes we use infix "nodes" and do not name this function
278 * get_irn_block(). */
279 ir_node *get_nodes_block (const ir_node *node);
281 /** Sets the Block of a node. */
282 void set_nodes_block (ir_node *node, ir_node *block);
285 * Return the MacroBlock the node belongs to. This is only
286 * possible for pinned nodes or if the graph is in pinned state.
287 * Otherwise the MacroBlock may be incorrect. This condition is
288 * now checked by an assertion.
290 * This works for all except Block. It can return Blocks or the Bad node.
292 * To express the difference to access routines that work for all
293 * nodes we use infix "nodes" and do not name this function
294 * get_irn_MacroBlock(). */
295 ir_node *get_nodes_MacroBlock(const ir_node *node);
298 * Projection numbers for result of Start node: use for Proj nodes!
301 pn_Start_X_initial_exec, /**< Projection on the initial control flow. */
302 pn_Start_M, /**< Projection on the initial memory. */
303 pn_Start_P_frame_base, /**< Projection on the frame base pointer. */
304 pn_Start_P_tls, /**< Projection on the pointer to the thread local store
305 segment containing _all_thread local variables. */
306 pn_Start_T_args, /**< Projection on all arguments. */
307 pn_Start_max /**< number of projections from a Start */
308 } pn_Start; /* Projection numbers for Start. */
310 /** Test whether arbitrary node is frame pointer.
312 * Test whether arbitrary node is frame pointer, i.e. Proj(pn_Start_P_frame_base)
313 * from Start. If so returns frame type, else Null. */
314 ir_type *is_frame_pointer(const ir_node *n);
316 /** Test whether arbitrary node is the thread local storage (tls) pointer.
318 * Test whether arbitrary node is tls pointer, i.e. Proj(pn_Start_P_tls)
319 * from Start. If so returns tls type, else Null. */
320 ir_type *is_tls_pointer(const ir_node *n);
322 /** Return the number of control flow predecessors of a block. */
323 int get_Block_n_cfgpreds(const ir_node *block);
324 /** Return the control flow predecessor of a block at a given position. */
325 ir_node *get_Block_cfgpred(const ir_node *block, int pos);
326 /** Set the control flow predecessor of a block at a given position. */
327 void set_Block_cfgpred(ir_node *block, int pos, ir_node *pred);
330 * Return the position of the predecessor block pred in the inputs
331 * of the block block.
333 * @param block the block
334 * @param pred a predecessor block of block
336 * @return the position of pred in block or -1
338 * @note When using the old extended basic block form for blocks
339 * with exception exists, a predecessor block might have more
340 * than one position. In that case it is not specified, with is returned.
342 int get_Block_cfgpred_pos(const ir_node *block, const ir_node *pred);
344 /** Get the predecessor block.
346 * Returns the block corresponding to the predecessor pos of block.
348 * There are several ambiguities we resolve with this function:
349 * - The direct predecessor can be a Proj, which is not pinned.
350 * We walk from the predecessor to the next pinned node
351 * (skip_Proj) and return the block that node is in.
352 * - If we encounter the Bad node, this function does not return
353 * Start block, but the Bad node.
355 ir_node *get_Block_cfgpred_block(const ir_node *node, int pos);
357 /** Return the matured flag of a block */
358 int get_Block_matured(const ir_node *block);
359 /** set the matured flag of a block. */
360 void set_Block_matured(ir_node *block, int matured);
362 /** A visited flag only for block nodes.
363 * @see also: get_irn_visited() inc_irg_visited() inc_irg_block_visited()*/
364 ir_visited_t get_Block_block_visited(const ir_node *block);
365 void set_Block_block_visited(ir_node *block, ir_visited_t visit);
368 * Marks a block as dead but do not replace it with a Bad node.
369 * Dead blocks are removed in the con
371 ir_node *set_Block_dead(ir_node *block);
372 int is_Block_dead(const ir_node *block);
374 /* For this current_ir_graph must be set. */
375 void mark_Block_block_visited(ir_node *node);
376 int Block_block_visited(const ir_node *node);
378 #ifdef INTERPROCEDURAL_VIEW
379 /* Set and remove interprocedural predecessors. If the interprocedural
380 * predecessors are removed, the node has the same predecessors in
382 * @@@ Maybe better: arity is zero if no cg preds. */
383 void set_Block_cg_cfgpred_arr(ir_node *node, int arity, ir_node *in[]);
384 void set_Block_cg_cfgpred(ir_node *node, int pos, ir_node *pred);
385 /* @@@ not supported */
386 ir_node **get_Block_cg_cfgpred_arr(ir_node *node);
387 /** Returns the number of interprocedural predecessors. 0 if none. */
388 int get_Block_cg_n_cfgpreds(const ir_node *node);
389 /** Return the interprocedural predecessor at position pos. */
390 ir_node *get_Block_cg_cfgpred(const ir_node *node, int pos);
391 /** Frees the memory allocated for interprocedural predecessors. */
392 void remove_Block_cg_cfgpred_arr(ir_node *node);
395 /** Returns the extended basic block a block belongs to. */
396 ir_extblk *get_Block_extbb(const ir_node *block);
397 /** Sets the extended basic block a block belongs to. */
398 void set_Block_extbb(ir_node *block, ir_extblk *extblk);
399 /** Get the Macro Block header of a (sub-) block. */
400 ir_node *get_Block_MacroBlock(const ir_node *block);
401 /** Set the Macro Block header of a (sub-) block. */
402 void set_Block_MacroBlock(ir_node *block, ir_node *mbh);
403 /** Get the Macro Block header of a node. */
404 ir_node *get_irn_MacroBlock(const ir_node *n);
405 /** Returns the ir_graph this Block belongs to. */
406 ir_graph *get_Block_irg(const ir_node *block);
407 /** Returns non-zero if the block has an entity assigned */
408 int has_Block_entity(const ir_node *block);
409 /** Returns the entity for a Block */
410 ir_entity *get_Block_entity(const ir_node *block);
411 /** Returns the entity for a Block (creating it if necessary) */
412 ir_entity *create_Block_entity(ir_node *block);
413 /** Set a new entity for a block */
414 void set_Block_entity(ir_node *block, ir_entity *entity);
415 /** Gets the head of the Phi list for this block. */
416 ir_node *get_Block_phis(const ir_node *block);
417 /** Sets the head of the Phi list for this block. */
418 void set_Block_phis(ir_node *block, ir_node *phi);
419 /** Add a Phi node to the list of Block Phi's. */
420 void add_Block_phi(ir_node *block, ir_node *phi);
421 /** Get the Block mark (single bit). */
422 unsigned get_Block_mark(const ir_node *block);
423 /** Set the Block mark (single bit). */
424 void set_Block_mark(ir_node *block, unsigned mark);
426 /** Return the number of Keep alive node. */
427 int get_End_n_keepalives(const ir_node *end);
428 /** Return the Keep alive node a position pos. */
429 ir_node *get_End_keepalive(const ir_node *end, int pos);
430 /** Keep alive dedicated nodes. These must be either PhiM or Block nodes. */
431 void add_End_keepalive(ir_node *end, ir_node *ka);
432 /** Set the Keep alive node at position pos. */
433 void set_End_keepalive(ir_node *end, int pos, ir_node *ka);
436 * Set new keep-alives.
437 * Beware: This might be an expensive operation if dynamic edges are enabled,
438 * so avoid it in the backend.
440 void set_End_keepalives(ir_node *end, int n, ir_node *in[]);
442 /** Remove irn from the keep-alive set. */
443 void remove_End_keepalive(ir_node *end, ir_node *irn);
445 /* Remove Bads, NoMem and doublets from the keep-alive set. */
446 void remove_End_Bads_and_doublets(ir_node *end);
448 /** Some parts of the End node are allocated separately -- their memory
449 is not recovered by dead_node_elimination if a End node is dead.
450 free_End() frees these data structures. */
451 void free_End(ir_node *end);
453 /** Return the target address of an IJmp */
454 ir_node *get_IJmp_target(const ir_node *ijmp);
455 /** Sets the target address of an IJmp */
456 void set_IJmp_target(ir_node *ijmp, ir_node *tgt);
458 ir_node *get_Cond_selector(const ir_node *node);
459 void set_Cond_selector(ir_node *node, ir_node *selector);
460 long get_Cond_default_proj(const ir_node *node);
461 void set_Cond_default_proj(ir_node *node, long defproj);
464 * Projection numbers for conditions.
467 pn_Cond_false, /**< Control flow if operand is "false". */
468 pn_Cond_true, /**< Control flow if operand is "true". */
469 pn_Cond_max /**< number of projections from a Cond */
470 } pn_Cond; /* Projection numbers for Cond. */
472 ir_node *get_Return_mem(const ir_node *node);
473 void set_Return_mem(ir_node *node, ir_node *mem);
474 ir_node **get_Return_res_arr(ir_node *node);
475 int get_Return_n_ress(const ir_node *node);
476 ir_node *get_Return_res(const ir_node *node, int pos);
477 void set_Return_res(ir_node *node, int pos, ir_node *res);
479 tarval *get_Const_tarval(const ir_node *node);
480 void set_Const_tarval(ir_node *node, tarval *con);
482 /** Return non-zero if the given Const node represents the 0 constant. */
483 int is_Const_null(const ir_node *node);
485 /** Return non-zero if the given Const node represents the 1 constant. */
486 int is_Const_one(const ir_node *node);
488 /** Return non-zero if the given Const node represents the constant with all bits set. */
489 int is_Const_all_one(const ir_node *node);
491 /** Returns the source language type of a Const node.
492 * Must be an atomic type. Mode of type must be mode of node.
494 ir_type *get_Const_type(const ir_node *node);
496 /** Sets the source language type of a Const node. */
497 void set_Const_type(ir_node *node, ir_type *tp);
499 /** Returns non-zero if s symconst kind has a type attribute */
500 #define SYMCONST_HAS_TYPE(kind) ((kind) <= symconst_type_align)
502 /** Returns non-zero if s symconst kind has an entity attribute */
503 #define SYMCONST_HAS_ENT(kind) ((kind) == symconst_addr_ent || (kind) == symconst_ofs_ent)
505 /** Returns non-zero if s symconst kind has an enum_const attribute */
506 #define SYMCONST_HAS_ENUM(kind) ((kind) == symconst_enum_const)
508 /** Get the kind of the SymConst. */
509 symconst_kind get_SymConst_kind(const ir_node *node);
510 /** Set the kind of the SymConst. */
511 void set_SymConst_kind(ir_node *node, symconst_kind num);
513 /** Only to access SymConst of kind type_tag or size. Else assertion: */
514 ir_type *get_SymConst_type(const ir_node *node);
515 void set_SymConst_type(ir_node *node, ir_type *tp);
517 /** Only to access SymConst of kind addr_ent. Else assertion: */
518 ir_entity *get_SymConst_entity(const ir_node *node);
519 void set_SymConst_entity(ir_node *node, ir_entity *ent);
521 /** Only to access SymConst of kind symconst_enum_const. Else assertion: */
522 ir_enum_const *get_SymConst_enum(const ir_node *node);
523 void set_SymConst_enum(ir_node *node, ir_enum_const *ec);
525 /** Sets both: type and ptrinfo. Needed to treat the node independent of
526 its semantics. Does a memcpy for the memory sym points to. */
527 /* write 'union': firmjni then does not create a method... */
528 union symconst_symbol get_SymConst_symbol(const ir_node *node);
529 void set_SymConst_symbol(ir_node *node,
530 union symconst_symbol sym);
532 /** Access the type of the value represented by the SymConst.
534 * Example: primitive type int for SymConst size. */
535 ir_type *get_SymConst_value_type(const ir_node *node);
536 void set_SymConst_value_type(ir_node *node, ir_type *tp);
538 ir_node *get_Sel_mem(const ir_node *node);
539 void set_Sel_mem(ir_node *node, ir_node *mem);
540 ir_node *get_Sel_ptr(const ir_node *node); /* ptr to the object to select from */
541 void set_Sel_ptr(ir_node *node, ir_node *ptr);
542 ir_node **get_Sel_index_arr(ir_node *node);
543 int get_Sel_n_indexs(const ir_node *node);
544 ir_node *get_Sel_index(const ir_node *node, int pos);
545 void set_Sel_index(ir_node *node, int pos, ir_node *index);
546 ir_entity *get_Sel_entity(const ir_node *node); /* entity to select */
547 void set_Sel_entity (ir_node *node, ir_entity *ent);
550 * Projection numbers for result of Call node: use for Proj nodes!
553 pn_Call_M = pn_Generic_M, /**< The memory result. */
554 pn_Call_X_regular = pn_Generic_X_regular, /**< The control flow result when no exception occurs. */
555 pn_Call_X_except = pn_Generic_X_except, /**< The control flow result branching to the exception handler. */
556 pn_Call_T_result = pn_Generic_other, /**< The tuple containing all (0, 1, 2, ...) results. */
557 pn_Call_P_value_res_base, /**< A pointer to the memory region containing copied results
558 passed by value (for compound result types). */
559 pn_Call_max /**< number of projections from a Call */
560 } pn_Call; /* Projection numbers for Call. */
562 /** Retrieve the memory input of a Call. */
563 ir_node *get_Call_mem(const ir_node *node);
564 /** Set the memory input of a Call. */
565 void set_Call_mem(ir_node *node, ir_node *mem);
566 /** Retrieve the call address of a Call. */
567 ir_node *get_Call_ptr(const ir_node *node);
568 /** Set the call address of a Call. */
569 void set_Call_ptr(ir_node *node, ir_node *ptr);
570 ir_node **get_Call_param_arr(ir_node *node);
571 /** Gets the number of parameters of a call. */
572 int get_Call_n_params(const ir_node *node);
573 /** Gets the call parameter at position pos. */
574 ir_node *get_Call_param(const ir_node *node, int pos);
575 /** Sets the call parameter at position pos. */
576 void set_Call_param(ir_node *node, int pos, ir_node *param);
577 /** Gets the type of a call. */
578 ir_type *get_Call_type(const ir_node *node);
579 /** Sets the type of a call. */
580 void set_Call_type(ir_node *node, ir_type *tp);
581 /** Returns non-zero if this call can be a tail-call. */
582 unsigned get_Call_tail_call(const ir_node *node);
583 /** Sets the tail call attribute. */
584 void set_Call_tail_call(ir_node *node, unsigned tail_call);
587 * Returns non-zero if a Call is surely a self-recursive Call.
588 * Beware: if this functions returns 0, the call might be self-recursive!
590 int is_self_recursive_Call(const ir_node *call);
592 /** Set, get and remove the callee information for a Call node.
594 * The callee information lists all method entities that can be called
595 * from this node. If the address expression can not be analyzed fully,
596 * e.g., as entities can be called that are not in the compilation unit,
597 * the array contains the unknown_entity. The array contains only entities
598 * with peculiarity_existent, but with all kinds of visibility. The entities
599 * not necessarily contain an irg.
601 * The array is only accessible if callee information is valid. See flag
604 * The memory allocated for the array is managed automatically, i.e., it must
605 * not be freed if the Call node is removed from the graph.
607 * @param node A Call node.
609 int Call_has_callees(const ir_node *node);
610 int get_Call_n_callees(const ir_node *node);
611 ir_entity *get_Call_callee(const ir_node *node, int pos);
613 /** Set the full callee array.
615 * The passed array is copied. Assumes current_ir_graph set properly! */
616 void set_Call_callee_arr(ir_node *node, const int n, ir_entity **arr);
617 void remove_Call_callee_arr(ir_node *node);
620 * Projection numbers for result of Builtin node: use for Proj nodes!
623 pn_Builtin_M = pn_Generic_M, /**< The memory result. */
624 pn_Builtin_1_result = pn_Generic_other, /**< first result. */
625 pn_Builtin_max /**< number of projections from a Builtin */
626 } pn_Builtin; /* Projection numbers for Builtin. */
628 ir_node *get_Builtin_mem(const ir_node *node);
629 void set_Builtin_mem(ir_node *node, ir_node *mem);
630 ir_builtin_kind get_Builtin_kind(const ir_node *node);
631 void set_Builtin_kind(ir_node *node, ir_builtin_kind kind);
632 ir_node **get_Builtin_param_arr(ir_node *node);
633 /** Gets the number of parameters of a Builtin. */
634 int get_Builtin_n_params(const ir_node *node);
635 /** Gets the Builtin parameter at position pos. */
636 ir_node *get_Builtin_param(const ir_node *node, int pos);
637 /** Sets the Builtin parameter at position pos. */
638 void set_Builtin_param(ir_node *node, int pos, ir_node *param);
639 /** Gets the type of a builtin. */
640 ir_type *get_Builtin_type(const ir_node *node);
641 /** Sets the type of a Builtin. */
642 void set_Builtin_type(ir_node *node, ir_type *tp);
643 /** Returns a human readable string for the ir_builtin_kind. */
644 const char *get_builtin_kind_name(ir_builtin_kind kind);
646 /** Retrieve the call address of a CallBegin. */
647 ir_node *get_CallBegin_ptr(const ir_node *node);
648 /** Set the call address of a CallBegin. */
649 void set_CallBegin_ptr(ir_node *node, ir_node *ptr);
650 /** Retrieve the original Call node of a CallBegin. */
651 ir_node *get_CallBegin_call(const ir_node *node);
652 /** Set the original Call node of a CallBegin. */
653 void set_CallBegin_call(ir_node *node, ir_node *call);
655 /* For unary and binary arithmetic operations the access to the
656 operands can be factored out. Left is the first, right the
657 second arithmetic value as listed in tech report 1999-44.
658 unops are: Minus, Abs, Not, Conv, Cast
659 binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
660 Shr, Shrs, Rotl, Cmp */
661 int is_unop(const ir_node *node);
662 ir_node *get_unop_op(const ir_node *node);
663 void set_unop_op(ir_node *node, ir_node *op);
664 int is_binop(const ir_node *node);
665 ir_node *get_binop_left(const ir_node *node);
666 void set_binop_left(ir_node *node, ir_node *left);
667 ir_node *get_binop_right(const ir_node *node);
668 void set_binop_right(ir_node *node, ir_node *right);
670 ir_node *get_Add_left(const ir_node *node);
671 void set_Add_left(ir_node *node, ir_node *left);
672 ir_node *get_Add_right(const ir_node *node);
673 void set_Add_right(ir_node *node, ir_node *right);
675 ir_node *get_Carry_left(const ir_node *node);
676 void set_Carry_left(ir_node *node, ir_node *left);
677 ir_node *get_Carry_right(const ir_node *node);
678 void set_Carry_right(ir_node *node, ir_node *right);
680 ir_node *get_Borrow_left(const ir_node *node);
681 void set_Borrow_left(ir_node *node, ir_node *left);
682 ir_node *get_Borrow_right(const ir_node *node);
683 void set_Borrow_right(ir_node *node, ir_node *right);
685 ir_node *get_Sub_left(const ir_node *node);
686 void set_Sub_left(ir_node *node, ir_node *left);
687 ir_node *get_Sub_right(const ir_node *node);
688 void set_Sub_right(ir_node *node, ir_node *right);
690 ir_node *get_Minus_op(const ir_node *node);
691 void set_Minus_op(ir_node *node, ir_node *op);
693 ir_node *get_Mul_left(const ir_node *node);
694 void set_Mul_left(ir_node *node, ir_node *left);
695 ir_node *get_Mul_right(const ir_node *node);
696 void set_Mul_right(ir_node *node, ir_node *right);
698 ir_node *get_Mulh_left(const ir_node *node);
699 void set_Mulh_left(ir_node *node, ir_node *left);
700 ir_node *get_Mulh_right(const ir_node *node);
701 void set_Mulh_right(ir_node *node, ir_node *right);
703 ir_node *get_Quot_left(const ir_node *node);
704 void set_Quot_left(ir_node *node, ir_node *left);
705 ir_node *get_Quot_right(const ir_node *node);
706 void set_Quot_right(ir_node *node, ir_node *right);
707 ir_node *get_Quot_mem(const ir_node *node);
708 void set_Quot_mem(ir_node *node, ir_node *mem);
709 ir_mode *get_Quot_resmode(const ir_node *node);
710 void set_Quot_resmode(ir_node *node, ir_mode *mode);
713 * Projection numbers for Quot: use for Proj nodes!
716 pn_Quot_M = pn_Generic_M, /**< Memory result. */
717 pn_Quot_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
718 pn_Quot_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
719 pn_Quot_res = pn_Generic_other, /**< Result of computation. */
720 pn_Quot_max /**< number of projections from a Quot */
721 } pn_Quot; /* Projection numbers for Quot. */
723 ir_node *get_DivMod_left(const ir_node *node);
724 void set_DivMod_left(ir_node *node, ir_node *left);
725 ir_node *get_DivMod_right(const ir_node *node);
726 void set_DivMod_right(ir_node *node, ir_node *right);
727 ir_node *get_DivMod_mem(const ir_node *node);
728 void set_DivMod_mem(ir_node *node, ir_node *mem);
729 ir_mode *get_DivMod_resmode(const ir_node *node);
730 void set_DivMod_resmode(ir_node *node, ir_mode *mode);
733 * Projection numbers for DivMod: use for Proj nodes!
736 pn_DivMod_M = pn_Generic_M, /**< Memory result. */
737 pn_DivMod_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
738 pn_DivMod_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
739 pn_DivMod_res_div = pn_Generic_other, /**< Result of computation a / b. */
740 pn_DivMod_res_mod, /**< Result of computation a % b. */
741 pn_DivMod_max /**< number of projections from a DivMod */
742 } pn_DivMod; /* Projection numbers for DivMod. */
744 ir_node *get_Div_left(const ir_node *node);
745 void set_Div_left(ir_node *node, ir_node *left);
746 ir_node *get_Div_right(const ir_node *node);
747 void set_Div_right(ir_node *node, ir_node *right);
748 ir_node *get_Div_mem(const ir_node *node);
749 void set_Div_mem(ir_node *node, ir_node *mem);
750 ir_mode *get_Div_resmode(const ir_node *node);
751 void set_Div_resmode(ir_node *node, ir_mode *mode);
752 int get_Div_no_remainder(const ir_node *node);
753 void set_Div_no_remainder(ir_node *node, int no_remainder);
756 * Projection numbers for Div: use for Proj nodes!
759 pn_Div_M = pn_Generic_M, /**< Memory result. */
760 pn_Div_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
761 pn_Div_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
762 pn_Div_res = pn_Generic_other, /**< Result of computation. */
763 pn_Div_max /**< number of projections from a Div */
764 } pn_Div; /* Projection numbers for Div. */
766 ir_node *get_Mod_left(const ir_node *node);
767 void set_Mod_left(ir_node *node, ir_node *left);
768 ir_node *get_Mod_right(const ir_node *node);
769 void set_Mod_right(ir_node *node, ir_node *right);
770 ir_node *get_Mod_mem(const ir_node *node);
771 void set_Mod_mem(ir_node *node, ir_node *mem);
772 ir_mode *get_Mod_resmode(const ir_node *node);
773 void set_Mod_resmode(ir_node *node, ir_mode *mode);
776 * Projection numbers for Mod: use for Proj nodes!
779 pn_Mod_M = pn_Generic_M, /**< Memory result. */
780 pn_Mod_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
781 pn_Mod_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
782 pn_Mod_res = pn_Generic_other, /**< Result of computation. */
783 pn_Mod_max /**< number of projections from a Mod */
784 } pn_Mod; /* Projection numbers for Mod. */
786 ir_node *get_Abs_op(const ir_node *node);
787 void set_Abs_op(ir_node *node, ir_node *op);
789 ir_node *get_And_left(const ir_node *node);
790 void set_And_left(ir_node *node, ir_node *left);
791 ir_node *get_And_right(const ir_node *node);
792 void set_And_right(ir_node *node, ir_node *right);
794 ir_node *get_Or_left(const ir_node *node);
795 void set_Or_left(ir_node *node, ir_node *left);
796 ir_node *get_Or_right(const ir_node *node);
797 void set_Or_right(ir_node *node, ir_node *right);
799 ir_node *get_Eor_left(const ir_node *node);
800 void set_Eor_left(ir_node *node, ir_node *left);
801 ir_node *get_Eor_right(const ir_node *node);
802 void set_Eor_right(ir_node *node, ir_node *right);
804 ir_node *get_Not_op(const ir_node *node);
805 void set_Not_op(ir_node *node, ir_node *op);
807 /** returns the pnc name from an pnc constant */
808 const char *get_pnc_string(int pnc);
810 /** Calculates the negated (Complement(R)) pnc condition. */
811 pn_Cmp get_negated_pnc(long pnc, ir_mode *mode);
813 /** Calculates the inversed (R^-1) pnc condition, i.e., "<" --> ">" */
814 pn_Cmp get_inversed_pnc(long pnc);
816 /** An alternative name for get_inversed_pnc() that can be better memorized. */
817 #define get_mirrored_pnc(pnc) get_inversed_pnc(pnc)
819 ir_node *get_Cmp_left(const ir_node *node);
820 void set_Cmp_left(ir_node *node, ir_node *left);
821 ir_node *get_Cmp_right(const ir_node *node);
822 void set_Cmp_right(ir_node *node, ir_node *right);
824 ir_node *get_Shl_left(const ir_node *node);
825 void set_Shl_left(ir_node *node, ir_node *left);
826 ir_node *get_Shl_right(const ir_node *node);
827 void set_Shl_right(ir_node *node, ir_node *right);
829 ir_node *get_Shr_left(const ir_node *node);
830 void set_Shr_left(ir_node *node, ir_node *left);
831 ir_node *get_Shr_right(const ir_node *node);
832 void set_Shr_right(ir_node *node, ir_node *right);
834 ir_node *get_Shrs_left(const ir_node *node);
835 void set_Shrs_left(ir_node *node, ir_node *left);
836 ir_node *get_Shrs_right(const ir_node *node);
837 void set_Shrs_right(ir_node *node, ir_node *right);
839 ir_node *get_Rotl_left(const ir_node *node);
840 void set_Rotl_left(ir_node *node, ir_node *left);
841 ir_node *get_Rotl_right(const ir_node *node);
842 void set_Rotl_right(ir_node *node, ir_node *right);
844 ir_node *get_Conv_op(const ir_node *node);
845 void set_Conv_op(ir_node *node, ir_node *op);
846 int get_Conv_strict(const ir_node *node);
847 void set_Conv_strict(ir_node *node, int flag);
849 /* Does Cast need a mem operator?
850 * Cast should only depend on the type, not on the state of an
851 * entity. But: we initialize various fields after Alloc, that
852 * are accessed in the cast. This required some precaution, to
853 * get the right memory into the Loads generated from the cast.
855 ir_node *get_Cast_op(const ir_node *node);
856 void set_Cast_op(ir_node *node, ir_node *op);
857 ir_type *get_Cast_type(const ir_node *node);
858 void set_Cast_type(ir_node *node, ir_type *to_tp);
860 /** Checks for upcast.
862 * Returns true if the Cast node casts a class type to a super type.
863 * Works also for pointers to classes (recursively).
865 * Needs typeinfo calculated.
867 int is_Cast_upcast(ir_node *node);
869 /** Checks for downcast.
871 * Returns true if the Cast node casts a class type to a sub type.
872 * Works also for pointers to classes (recursively).
874 * Needs typeinfo calculated.
876 int is_Cast_downcast(ir_node *node);
879 /** Returns true if n is a Phi or a Filter node in INTER-procedural view.
880 Returns false if irg is in phase phase_building and the Phi has zero
881 predecessors: it's a Phi0. */
882 int is_Phi(const ir_node *n);
883 /** Returns true if irg in phase phase_building and the Phi has zero
884 predecessors. It's a Phi0 then. */
885 int is_Phi0(const ir_node *n);
886 /* These routines also work for Filter nodes in INTER-procedural view. */
887 ir_node **get_Phi_preds_arr(ir_node *node);
888 int get_Phi_n_preds(const ir_node *node);
889 ir_node *get_Phi_pred(const ir_node *node, int pos);
890 void set_Phi_pred(ir_node *node, int pos, ir_node *pred);
891 ir_node *get_Phi_next(const ir_node *phi);
892 void set_Phi_next(ir_node *phi, ir_node *next);
894 ir_node *get_Filter_pred(const ir_node *node);
895 void set_Filter_pred(ir_node *node, ir_node *pred);
896 long get_Filter_proj(const ir_node *node);
897 void set_Filter_proj(ir_node *node, long proj);
898 /* set the interprocedural predecessors, ...d_arr uses current_ir_graph.
899 * @@@ Maybe better: arity is zero if no cg preds. */
900 void set_Filter_cg_pred_arr(ir_node * node, int arity, ir_node ** in);
901 void set_Filter_cg_pred(ir_node * node, int pos, ir_node * pred);
902 int get_Filter_n_cg_preds(const ir_node *node);
903 ir_node *get_Filter_cg_pred(const ir_node *node, int pos);
905 /** Return true if parameter is a memory operation.
907 * A memory operation is an operation that changes the
908 * memory. I.e., a Load or a Store operation.
910 int is_memop(const ir_node *node);
911 ir_node *get_memop_mem(const ir_node *node);
912 void set_memop_mem(ir_node *node, ir_node *mem);
913 ir_node *get_memop_ptr(const ir_node *node);
914 void set_memop_ptr(ir_node *node, ir_node *ptr);
917 * Projection numbers for Load: use for Proj nodes!
920 pn_Load_M = pn_Generic_M, /**< Memory result. */
921 pn_Load_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
922 pn_Load_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
923 pn_Load_res = pn_Generic_other, /**< Result of load operation. */
924 pn_Load_max /**< number of projections from a Load */
925 } pn_Load; /* Projection numbers for Load. */
927 ir_node *get_Load_mem(const ir_node *node);
928 void set_Load_mem(ir_node *node, ir_node *mem);
929 ir_node *get_Load_ptr(const ir_node *node);
930 void set_Load_ptr(ir_node *node, ir_node *ptr);
931 ir_mode *get_Load_mode(const ir_node *node);
932 void set_Load_mode(ir_node *node, ir_mode *mode);
933 ir_volatility get_Load_volatility(const ir_node *node);
934 void set_Load_volatility(ir_node *node, ir_volatility volatility);
935 ir_align get_Load_align(const ir_node *node);
936 void set_Load_align(ir_node *node, ir_align align);
939 * Projection numbers for Store: use for Proj nodes!
942 pn_Store_M = pn_Generic_M, /**< Memory result. */
943 pn_Store_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
944 pn_Store_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
945 pn_Store_max = pn_Generic_other /**< number of projections from a Store */
946 } pn_Store; /* Projection numbers for Store. */
948 ir_node *get_Store_mem(const ir_node *node);
949 void set_Store_mem(ir_node *node, ir_node *mem);
950 ir_node *get_Store_ptr(const ir_node *node);
951 void set_Store_ptr(ir_node *node, ir_node *ptr);
952 ir_node *get_Store_value(const ir_node *node);
953 void set_Store_value(ir_node *node, ir_node *value);
954 ir_volatility get_Store_volatility(const ir_node *node);
955 void set_Store_volatility(ir_node *node, ir_volatility volatility);
956 ir_align get_Store_align(const ir_node *node);
957 void set_Store_align(ir_node *node, ir_align align);
960 * Projection numbers for Alloc: use for Proj nodes!
963 pn_Alloc_M = pn_Generic_M, /**< Memory result. */
964 pn_Alloc_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
965 pn_Alloc_X_except = pn_Generic_X_except, /**< Execution result if exception occurred. */
966 pn_Alloc_res = pn_Generic_other, /**< Result of allocation. */
967 pn_Alloc_max /**< number of projections from an Alloc */
968 } pn_Alloc; /* Projection numbers for Alloc. */
970 ir_node *get_Alloc_mem(const ir_node *node);
971 void set_Alloc_mem(ir_node *node, ir_node *mem);
972 ir_node *get_Alloc_count(const ir_node *node);
973 void set_Alloc_count(ir_node *node, ir_node *count);
974 ir_type *get_Alloc_type(const ir_node *node);
975 void set_Alloc_type(ir_node *node, ir_type *tp);
977 ir_where_alloc get_Alloc_where(const ir_node *node);
978 void set_Alloc_where(ir_node *node, ir_where_alloc where);
980 ir_node *get_Free_mem(const ir_node *node);
981 void set_Free_mem(ir_node *node, ir_node *mem);
982 ir_node *get_Free_ptr(const ir_node *node);
983 void set_Free_ptr(ir_node *node, ir_node *ptr);
984 ir_node *get_Free_size(const ir_node *node);
985 void set_Free_size(ir_node *node, ir_node *size);
986 ir_type *get_Free_type(const ir_node *node);
987 void set_Free_type(ir_node *node, ir_type *tp);
989 ir_where_alloc get_Free_where(const ir_node *node);
990 void set_Free_where(ir_node *node, ir_where_alloc where);
992 ir_node **get_Sync_preds_arr(ir_node *node);
993 int get_Sync_n_preds(const ir_node *node);
994 ir_node *get_Sync_pred(const ir_node *node, int pos);
995 void set_Sync_pred(ir_node *node, int pos, ir_node *pred);
996 void add_Sync_pred(ir_node *node, ir_node *pred);
998 /** Returns the source language type of a Proj node.
999 * Must be an atomic type. Mode of type must be mode of node.
1001 ir_type *get_Proj_type(const ir_node *node);
1003 /** Return the predecessor of a Proj node. */
1004 ir_node *get_Proj_pred(const ir_node *node);
1005 void set_Proj_pred(ir_node *node, ir_node *pred);
1006 /** Return the projection number of a Proj node. */
1007 long get_Proj_proj(const ir_node *node);
1008 void set_Proj_proj(ir_node *node, long proj);
1011 * Returns non-zero if a node is a routine parameter.
1013 * @param node the Proj node to test
1015 int is_arg_Proj(const ir_node *node);
1017 ir_node **get_Tuple_preds_arr(ir_node *node);
1018 int get_Tuple_n_preds(const ir_node *node);
1019 ir_node *get_Tuple_pred(const ir_node *node, int pos);
1020 void set_Tuple_pred(ir_node *node, int pos, ir_node *pred);
1022 ir_node *get_Id_pred(const ir_node *node);
1023 void set_Id_pred(ir_node *node, ir_node *pred);
1025 /** Confirm has a single result and returns 'value' unchanged.
1026 * The node expresses a restriction on 'value':
1027 * 'value' 'cmp' 'bound' == true. */
1028 ir_node *get_Confirm_value(const ir_node *node);
1029 void set_Confirm_value(ir_node *node, ir_node *value);
1030 ir_node *get_Confirm_bound(const ir_node *node);
1031 void set_Confirm_bound(ir_node *node, ir_node *bound);
1032 pn_Cmp get_Confirm_cmp(const ir_node *node);
1033 void set_Confirm_cmp(ir_node *node, pn_Cmp cmp);
1038 ir_node *get_Mux_sel(const ir_node *node);
1039 void set_Mux_sel(ir_node *node, ir_node *sel);
1040 ir_node *get_Mux_false(const ir_node *node);
1041 void set_Mux_false(ir_node *node, ir_node *ir_false);
1042 ir_node *get_Mux_true(const ir_node *node);
1043 void set_Mux_true(ir_node *node, ir_node *ir_true);
1046 * Projection numbers for result of CopyB node: use for Proj nodes!
1049 pn_CopyB_M_regular = pn_Generic_M, /**< The memory result. */
1050 pn_CopyB_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
1051 pn_CopyB_X_except = pn_Generic_X_except, /**< The control flow result branching to the exception handler */
1052 pn_CopyB_max = pn_Generic_other /**< number of projections from a CopyB */
1053 } pn_CopyB; /* Projection numbers for CopyB. */
1054 #define pn_CopyB_M pn_CopyB_M_regular
1056 ir_node *get_CopyB_mem(const ir_node *node);
1057 void set_CopyB_mem(ir_node *node, ir_node *mem);
1058 ir_node *get_CopyB_dst(const ir_node *node);
1059 void set_CopyB_dst(ir_node *node, ir_node *dst);
1060 ir_node *get_CopyB_src(const ir_node *node);
1061 void set_CopyB_src(ir_node *node, ir_node *src);
1062 ir_type *get_CopyB_type(const ir_node *node);
1063 void set_CopyB_type(ir_node *node, ir_type *data_type);
1066 * Projection numbers for result of InstOf node: use for Proj nodes!
1069 pn_InstOf_M_regular = pn_Generic_M, /**< The memory result. */
1070 pn_InstOf_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
1071 pn_InstOf_X_except = pn_Generic_X_except, /**< The control flow result branching to the exception handler */
1072 pn_InstOf_res = pn_Generic_other, /**< The checked object pointer. */
1073 pn_InstOf_max /**< number of projections from an InstOf */
1075 #define pn_InstOf_M pn_InstOf_M_regular
1077 /** InstOf access. */
1078 ir_type *get_InstOf_type(const ir_node *node);
1079 void set_InstOf_type(ir_node *node, ir_type *type);
1080 ir_node *get_InstOf_store(const ir_node *node);
1081 void set_InstOf_store(ir_node *node, ir_node *obj);
1082 ir_node *get_InstOf_obj(const ir_node *node);
1083 void set_InstOf_obj(ir_node *node, ir_node *obj);
1086 * Projection numbers for Raise.
1089 pn_Raise_M = pn_Generic_M, /**< The Memory result. */
1090 pn_Raise_X = pn_Generic_X_regular, /**< The control flow to the exception handler. */
1091 pn_Raise_max /**< number of projections from a Raise */
1092 } pn_Raise; /* Projection numbers for Raise. */
1094 ir_node *get_Raise_mem(const ir_node *node);
1095 void set_Raise_mem(ir_node *node, ir_node *mem);
1096 ir_node *get_Raise_exo_ptr(const ir_node *node); /* PoinTeR to EXception Object */
1097 void set_Raise_exo_ptr(ir_node *node, ir_node *exoptr);
1100 * Projection numbers for result of Bound node: use for Proj nodes!
1103 pn_Bound_M = pn_Generic_M, /**< The memory result. */
1104 pn_Bound_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
1105 pn_Bound_X_except = pn_Generic_X_except, /**< The control flow result branching to the exception handler */
1106 pn_Bound_res = pn_Generic_other, /**< The checked index. */
1107 pn_Bound_max /**< number of projections from a Bound */
1110 /** Returns the memory input of a Bound operation. */
1111 ir_node *get_Bound_mem(const ir_node *bound);
1112 void set_Bound_mem(ir_node *bound, ir_node *mem);
1114 /** Returns the index input of a Bound operation. */
1115 ir_node *get_Bound_index(const ir_node *bound);
1116 void set_Bound_index(ir_node *bound, ir_node *idx);
1118 /** Returns the lower bound input of a Bound operation. */
1119 ir_node *get_Bound_lower(const ir_node *bound);
1120 void set_Bound_lower(ir_node *bound, ir_node *lower);
1122 /** Returns the upper bound input of a Bound operation. */
1123 ir_node *get_Bound_upper(const ir_node *bound);
1124 void set_Bound_upper(ir_node *bound, ir_node *upper);
1126 /** Return the operand of a Pin node. */
1127 ir_node *get_Pin_op(const ir_node *pin);
1128 void set_Pin_op(ir_node *pin, ir_node *node);
1130 /** Return the assembler text of an ASM pseudo node. */
1131 ident *get_ASM_text(const ir_node *node);
1132 /** Set assembler text of ASM node */
1133 void set_ASM_text(ir_node *node, ident *text);
1134 /** Return the number of input constraints for an ASM node. */
1135 int get_ASM_n_input_constraints(const ir_node *node);
1136 /** Return the input constraints for an ASM node. */
1137 ir_asm_constraint *get_ASM_input_constraints(const ir_node *node);
1138 /** Set input constraints for ASM node. */
1139 void set_ASM_input_constraints(ir_node *node, ir_asm_constraint *constraints);
1140 /** Return the number of output constraints for an ASM node. */
1141 int get_ASM_n_output_constraints(const ir_node *node);
1142 /** Return the output constraints for an ASM node. */
1143 ir_asm_constraint *get_ASM_output_constraints(const ir_node *node);
1144 /** Set output constraints for ASM node. (note: has to be a firm array) */
1145 void set_ASM_output_constraints(ir_node *node, ir_asm_constraint *constraints);
1146 /** Return the number of clobbered registers for an ASM node. */
1147 int get_ASM_n_clobbers(const ir_node *node);
1148 /** Return the list of clobbered registers for an ASM node. */
1149 ident **get_ASM_clobbers(const ir_node *node);
1150 /** Set list of clobbered register for ASM node (note: has to be a firm
1152 void set_ASM_clobbers(ir_node *node, ident **clobbers);
1156 * NAME Auxiliary routines
1160 /** Returns operand of node if node is a Proj. */
1161 ir_node *skip_Proj(ir_node *node);
1162 /** Returns operand of node if node is a Proj. */
1163 const ir_node *skip_Proj_const(const ir_node *node);
1164 /** Returns operand of node if node is a Id. */
1165 ir_node *skip_Id(ir_node *node); /* Old name is skip_nop(). */
1166 /** Returns corresponding operand of Tuple if node is a Proj from
1168 ir_node *skip_Tuple(ir_node *node);
1169 /** Returns operand of node if node is a Cast. */
1170 ir_node *skip_Cast(ir_node *node);
1171 const ir_node *skip_Cast_const(const ir_node *node);
1172 /** Returns operand of node if node is a Pin. */
1173 ir_node *skip_Pin(ir_node *node);
1174 /** Returns operand of node if node is a Confirm */
1175 ir_node *skip_Confirm(ir_node *node);
1176 /** Skip all high-level Operations (including Cast, Confirm). */
1177 ir_node *skip_HighLevel_ops(ir_node *node);
1178 /** Returns true if irn is a Const node. */
1179 int is_Const(const ir_node *node);
1180 /** Returns true if a node is a Conv node. */
1181 int is_Conv(const ir_node *node);
1182 /** Returns true if a node is a strictConv node. */
1183 int is_strictConv(const ir_node *node);
1184 /** Returns true if a node is a Cast node. */
1185 int is_Cast(const ir_node *node);
1186 /** Returns true if node is a Bad node. */
1187 int is_Bad(const ir_node *node);
1188 /** Returns true if node is a NoMem node. */
1189 int is_NoMem(const ir_node *node);
1190 /** Returns true if node is a Start node. */
1191 int is_Start(const ir_node *node);
1192 /** Returns true if node is an End node. */
1193 int is_End(const ir_node *node);
1194 /** Returns true if node is an EndExcept node. */
1195 int is_EndExcept(const ir_node *node);
1196 /** Returns true if node is an EndReg node. */
1197 int is_EndReg(const ir_node *node);
1198 /** Returns true if node is a Minus node. */
1199 int is_Minus(const ir_node *node);
1200 /** Returns true if node is a Abs node. */
1201 int is_Abs(const ir_node *node);
1202 /** Returns true if node is a Mod node. */
1203 int is_Mod(const ir_node *node);
1204 /** Returns true if node is a Div node. */
1205 int is_Div(const ir_node *node);
1206 /** Returns true if node is a DivMod node. */
1207 int is_DivMod(const ir_node *node);
1208 /** Returns true if node is a Quot node. */
1209 int is_Quot(const ir_node *node);
1210 /** Returns true if node is an Add node. */
1211 int is_Add(const ir_node *node);
1212 /** Returns true if node is a Carry node. */
1213 int is_Carry(const ir_node *node);
1214 /** Returns true if node is an And node. */
1215 int is_And(const ir_node *node);
1216 /** Returns true if node is an Or node. */
1217 int is_Or(const ir_node *node);
1218 /** Returns true if node is an Eor node. */
1219 int is_Eor(const ir_node *node);
1220 /** Returns true if node is a Sub node. */
1221 int is_Sub(const ir_node *node);
1222 /** Returns true if node is a Not node. */
1223 int is_Not(const ir_node *node);
1224 /** Returns true if node is a Shl node. */
1225 int is_Shl(const ir_node *node);
1226 /** Returns true if node is a Shr node. */
1227 int is_Shr(const ir_node *node);
1228 /** Returns true if node is a Shrs node. */
1229 int is_Shrs(const ir_node *node);
1230 /** Returns true if node is a Rotl node. */
1231 int is_Rotl(const ir_node *node);
1232 /** Returns true if node is an Id node. */
1233 int is_Id(const ir_node *node);
1234 /** Returns true if node is a Tuple node. */
1235 int is_Tuple(const ir_node *node);
1236 /** Returns true if node is a Bound node. */
1237 int is_Bound(const ir_node *node);
1238 /** Returns true if the node is not a Block */
1239 int is_no_Block(const ir_node *node);
1240 /** Returns true if the node is a Block */
1241 int is_Block(const ir_node *node);
1242 /** Returns true if node is an Unknown node. */
1243 int is_Unknown(const ir_node *node);
1244 /** Returns true if node is a Return node. */
1245 int is_Return(const ir_node *node);
1246 /** Returns true if node is a Call node. */
1247 int is_Call(const ir_node *node);
1248 /** Returns true if node is a Builtin node. */
1249 int is_Builtin(const ir_node *node);
1250 /** Returns true if node is a CallBegin node. */
1251 int is_CallBegin(const ir_node *node);
1252 /** Returns true if node is a Sel node. */
1253 int is_Sel(const ir_node *node);
1254 /** Returns true if node is a Mul node. */
1255 int is_Mul(const ir_node *node);
1256 /** Returns true if node is a Mulh node. */
1257 int is_Mulh(const ir_node *node);
1258 /** Returns true if node is a Mux node. */
1259 int is_Mux(const ir_node *node);
1260 /** Returns true if node is a Load node. */
1261 int is_Load(const ir_node *node);
1262 /** Returns true if node is a Store node. */
1263 int is_Store(const ir_node *node);
1264 /** Returns true if node is a Sync node. */
1265 int is_Sync(const ir_node *node);
1266 /** Returns true if node is a Confirm node. */
1267 int is_Confirm(const ir_node *node);
1268 /** Returns true if node is a Pin node. */
1269 int is_Pin(const ir_node *node);
1270 /** Returns true if node is a SymConst node. */
1271 int is_SymConst(const ir_node *node);
1272 /** Returns true if node is a SymConst node with kind symconst_addr_ent. */
1273 int is_SymConst_addr_ent(const ir_node *node);
1274 /** Returns true if node is a Cond node. */
1275 int is_Cond(const ir_node *node);
1276 /** Returns true of node is a CopyB node. */
1277 int is_CopyB(const ir_node *node);
1278 /** Returns true if node is a Cmp node. */
1279 int is_Cmp(const ir_node *node);
1280 /** Returns true if node is an Alloc node. */
1281 int is_Alloc(const ir_node *node);
1282 /** Returns true if node is a Free node. */
1283 int is_Free(const ir_node *node);
1284 /** Returns true if a node is a Jmp node. */
1285 int is_Jmp(const ir_node *node);
1286 /** Returns true if a node is a IJmp node. */
1287 int is_IJmp(const ir_node *node);
1288 /** Returns true if a node is a Raise node. */
1289 int is_Raise(const ir_node *node);
1290 /** Returns true if a node is an ASM node. */
1291 int is_ASM(const ir_node *node);
1292 /** Returns true if a node is a Dummy node. */
1293 int is_Dummy(const ir_node *node);
1294 /** Returns true if a node is an Anchor node */
1295 int is_Anchor(const ir_node *node);
1296 /** Returns true if a node is a Borrow node */
1297 int is_Borrow(const ir_node *node);
1298 /** Returns true if a node is a Break node */
1299 int is_Break(const ir_node *node);
1300 /** Returns true if a node is an instff node */
1301 int is_InstOf(const ir_node *node);
1302 /** Returns true if node is a Proj node or a Filter node in INTRA-procedural view. */
1303 int is_Proj(const ir_node *node);
1304 /** Returns true if node is a Filter node. */
1305 int is_Filter(const ir_node *node);
1307 /** Returns true if the operation manipulates control flow:
1308 Start, End, Jmp, Cond, Return, Raise, Bad, CallBegin, EndReg, EndExcept */
1309 int is_cfop(const ir_node *node);
1311 /** Returns true if the operation manipulates interprocedural control flow:
1312 CallBegin, EndReg, EndExcept */
1313 int is_ip_cfop(const ir_node *node);
1314 /** Returns true if the operation can change the control flow because
1315 of an exception: Call, Quot, DivMod, Div, Mod, Load, Store, Alloc,
1316 Bad. Raise is not fragile, but a unconditional jump. */
1317 int is_fragile_op(const ir_node *node);
1318 /** Returns the memory operand of fragile operations. */
1319 ir_node *get_fragile_op_mem(ir_node *node);
1320 /** Returns the result mode of a Div operation. */
1321 ir_mode *get_divop_resmod(const ir_node *node);
1323 /** Returns true if the operation is a forking control flow
1324 * operation: Cond. */
1325 int is_irn_forking(const ir_node *node);
1328 * Copies attributes stored in the old node to a new node.
1329 * Assumes both have the same opcode and sufficient size.
1331 * @param irg The irg of the new_node (get_irn_irg on it might not work
1333 * @param old_node the node where the attributes are copied from
1334 * @param new_node node the attributes get copies to.
1336 * This copies all essential information to the new node. It does not copy
1337 * temporal or calculated information like visited flags or results of dominance
1338 * or loop calculations
1340 void copy_node_attr(ir_graph *irg, const ir_node *old_node, ir_node *new_node);
1342 /** Return the type associated with the value produced by n
1343 * if the node remarks this type as it is the case for
1344 * Cast, Const, SymConst and some Proj nodes or unknown_type. */
1345 ir_type *get_irn_type(ir_node *n);
1347 /** Return the type attribute of a node n (SymConst, Call, Alloc, Free,
1349 ir_type *get_irn_type_attr(ir_node *n);
1351 /** Return the entity attribute of a node n (SymConst, Sel) or NULL. */
1352 ir_entity *get_irn_entity_attr(ir_node *n);
1354 /** Returns non-zero for constant-like nodes. */
1355 int is_irn_constlike(const ir_node *node);
1358 * Returns non-zero for nodes that must be always optimized
1359 * (Phi, Id. Proj, Cond, Block, Confirm ...).
1361 int is_irn_always_opt(const ir_node *node);
1364 * Returns non-zero for nodes that are allowed to have keep-alives and
1365 * are neither Block nor PhiM.
1367 int is_irn_keep(const ir_node *node);
1370 * Returns non-zero for nodes that are always placed in the start block.
1372 int is_irn_start_block_placed(const ir_node *node);
1375 * Returns non-zero for nodes that are machine operations.
1377 int is_irn_machine_op(const ir_node *node);
1380 * Returns non-zero for nodes that are machine operands.
1382 int is_irn_machine_operand(const ir_node *node);
1385 * Returns non-zero for nodes that have the n'th user machine flag set.
1387 int is_irn_machine_user(const ir_node *node, unsigned n);
1390 * Returns non-zero for nodes that are CSE neutral to its users.
1392 int is_irn_cse_neutral(const ir_node *node);
1395 * A type to express conditional jump predictions.
1398 COND_JMP_PRED_NONE, /**< No jump prediction. Default. */
1399 COND_JMP_PRED_TRUE, /**< The True case is predicted. */
1400 COND_JMP_PRED_FALSE /**< The False case is predicted. */
1401 } cond_jmp_predicate;
1403 /** Gets the string representation of the jump prediction. */
1404 const char *get_cond_jmp_predicate_name(cond_jmp_predicate pred);
1406 /** Returns the conditional jump prediction of a Cond node. */
1407 cond_jmp_predicate get_Cond_jmp_pred(const ir_node *cond);
1409 /** Sets a new conditional jump prediction. */
1410 void set_Cond_jmp_pred(ir_node *cond, cond_jmp_predicate pred);
1412 /** Checks whether a node represents a global address. */
1413 int is_Global(const ir_node *node);
1415 /* Returns the entity of a global address. */
1416 ir_entity *get_Global_entity(const ir_node *node);
1419 * Access custom node data.
1420 * The data must have been registered with
1421 * register_additional_node_data() before.
1422 * @param node The ir node to get the data from.
1423 * @param type The type of the data you registered.
1424 * @param off The value returned by register_additional_node_data().
1425 * @return A pointer of type @p type.
1427 #define get_irn_data(node,type,off) \
1428 (assert(off > 0 && "Invalid node data offset"), (type *) ((char *) (node) - (off)))
1431 * Get the pointer to the node some custom data belongs to.
1432 * @param data The pointer to the custom data.
1433 * @param off The number as returned by register_additional_node_data().
1434 * @return A pointer to the ir node the custom data belongs to.
1436 #define get_irn_data_base(data,off) \
1437 (assert(off > 0 && "Invalid node data offset"), (ir_node *) ((char *) (data) + (off)))
1440 * Request additional data to be allocated with an ir node.
1441 * @param size The size of the additional data required.
1442 * @return A positive number, if the operation was successful, which
1443 * must be passed to the access macro get_irn_data(), 0 if the
1444 * registration failed.
1446 unsigned firm_register_additional_node_data(unsigned size);
1449 * Return a pointer to the node attributes.
1450 * Needed for user-defined nodes.
1452 void *get_irn_generic_attr(ir_node *node);
1453 const void *get_irn_generic_attr_const(const ir_node *node);
1456 * Returns the unique node index for the node in its graph.
1457 * This index is used to access phase information for this node.
1459 unsigned get_irn_idx(const ir_node *node);
1462 * Sets the debug information of a node.
1464 * @param n The node.
1465 * @param db The debug info.
1467 void set_irn_dbg_info(ir_node *n, dbg_info *db);
1470 * Returns the debug information of an node.
1472 * @param n The node.
1474 dbg_info *get_irn_dbg_info(const ir_node *n);
1477 * Calculate a hash value of a node. Only inputs, mode and opcode are used.
1479 * @param node the node to hash
1481 unsigned firm_default_hash(const ir_node *node);
1484 * returns a descriptive name of a node (containing type+number)
1486 const char *gdb_node_helper(void *firm_object);
1488 /*@}*/ /* end of ir_node group definition */