3 * File name: ir/ir/irnode.h
4 * Purpose: Representation of an intermediate operation.
5 * Author: Martin Trapp, Christian Schaefer
6 * Modified by: Goetz Lindenmaier
9 * Copyright: (c) 1998-2003 Universität Karlsruhe
10 * Licence: This file protected by GPL - GNU GENERAL PUBLIC LICENSE.
17 * Projection numbers of compare: use for Proj nodes!
18 * @remark there are numbers with normalized names below!
21 False = 0, /**< false */
24 Le, /**< less or equal */
26 Ge, /**< greater or equal */
27 Lg, /**< less or greater */
28 Leg = 7, /**< less, equal or greater = ordered */
30 Ue, /**< unordered or equal */
31 Ul, /**< unordered or less */
32 Ule, /**< unordered, less or equal */
33 Ug, /**< unordered or greater */
34 Uge, /**< unordered, greater or equal */
35 Ne, /**< unordered, less or greater = not equal */
36 True = 15 /**< true */
37 /* not_mask = Leg*/ /* bits to flip to negate comparison * @@ hack for jni interface */
38 } pnc_number; /* pnc: Projection Number Cmp */
44 # include "firm_common.h"
49 /* # include "exc.h" */
54 * @author Martin Trapp, Christian Schaefer
56 * Declarations of an ir node.
60 * @defgroup ir_node Declarations of an ir node.
62 * The type definition of ir_node is also in irgraph.h to resolve
63 * recursion between irnode.h and irgraph.h
65 * ir_node - a datatype representing a Firm node
67 * The common fields are:
69 * - firm_kind - A firm_kind tag containing k_type. This is useful
70 * for dynamically checking whether a node is a ir_node.
71 * - arity - The number of predecessors in the Firm graph.
72 * - in - A list with the predecessors in the Firm graph. There are
73 * routines to access individual elements and to obtain the
74 * array. The method returning the array should not be used.
75 * - mode - The mode of the node. There are routines to get the mode
76 * but also to access the mode's fields directly.
77 * - opcode - The opcode of the node. There are routines to get the opcode
78 * but also to access the opcode's fields directly.
79 * - node_nr - A unique number for the node. Available only if debugging
84 #ifndef _IR_NODE_TYPEDEF_
85 #define _IR_NODE_TYPEDEF_
86 typedef struct ir_node ir_node;
95 * you can work on the graph without considering the different types
96 * of nodes, it's just a big graph.
100 * Checks whether a pointer points to a ir node.
102 * @param thing an arbitrary pointer
103 * @return non-zero if the thing is a ir mode, else zero
105 int is_ir_node (const void *thing);
108 * Returns the number of predecessors without the block predecessor.
110 * @param node the IR-node
112 int get_irn_arity (const ir_node *node);
113 int get_irn_intra_arity (const ir_node *node);
114 int get_irn_inter_arity (const ir_node *node);
116 /** Replaces the old in array by a new one that will contain the ins given in
117 the parameters. Conserves the block predecessor. It copies the array passed.
118 This function is necessary to adjust in arrays of blocks, calls and phis.
119 Assumes that current_ir_graph is set to the graph containing "node".
120 "in" must contain all predecessors except the block that are required for
122 void set_irn_in (ir_node *node, int arity,
124 /* to iterate through the predecessors without touching the array. No
125 order of predecessors guaranteed.
126 To iterate over the operands iterate from 0 to i < get_irn_arity(),
127 to iterate including the Block predecessor iterate from i = -1 to
128 i < get_irn_arity. */
129 /* Access predecessor n */
132 * Get the n-th predecessor of a node.
133 * This function removes Id predecessors.
135 ir_node *get_irn_n (ir_node *node, int n);
136 ir_node *get_irn_intra_n (ir_node *node, int n);
137 ir_node *get_irn_inter_n (ir_node *node, int n);
139 /** Replace the n-th predecessor of a node with a new one. */
140 void set_irn_n (ir_node *node, int n, ir_node *in);
141 /* Sets the mode struct of node. */
142 void set_irn_mode (ir_node *node, ir_mode *mode);
143 /** Gets the mode struct of a node. */
144 ir_mode *get_irn_mode (const ir_node *node);
145 /** Gets the mode-enum modecode. */
146 modecode get_irn_modecode (const ir_node *node);
147 /** Gets the ident for a string representation of the mode .*/
148 ident *get_irn_modeident (const ir_node *node);
149 /** Gets the string representation of the mode .*/
150 const char *get_irn_modename (const ir_node *node);
151 /** Gets the opcode struct of the node. */
152 ir_op *get_irn_op (const ir_node *node);
153 /** Sets the opcode struct of the node. */
154 void set_irn_op (ir_node *node, ir_op *op);
155 /** Gets the opcode-enum of the node. */
156 opcode get_irn_opcode (const ir_node *node);
157 /** Get the string representation of the opcode. */
158 const char *get_irn_opname (const ir_node *node);
159 /** Get the ident for a string representation of the opcode. */
160 ident *get_irn_opident (const ir_node *node);
161 /** Gets the visited counter of a node. */
162 unsigned long get_irn_visited (const ir_node *node);
163 /** Sets the visited counter of a node. */
164 void set_irn_visited (ir_node *node, unsigned long visited);
165 /** Sets visited to get_irg_visited(current_ir_graph). */
166 void mark_irn_visited (ir_node *node);
167 /** Returns 1 if visited < get_irg_visited(current_ir_graph). */
168 int irn_not_visited (const ir_node *node);
169 /** Returns 1 if visited >= get_irg_visited(current_ir_graph). */
170 int irn_visited (const ir_node *node);
173 * Sets the link of a node.
174 * Only allowed if the graph is NOT in phase_building.
176 void set_irn_link (ir_node *node, void *link);
178 /** Returns the link of a node. */
179 void *get_irn_link (const ir_node *node);
181 /** Returns the ir_graph this node belongs to. Only valid if irg
182 * is in state op_pin_state_pinned (irg is only stored in the block. */
183 ir_graph *get_irn_irg (ir_node *node);
185 /** Outputs a unique number for this node if libFIRM is compiled for
186 debugging, (configure with --enable-debug) else returns address
187 of node cast to long. */
188 long get_irn_node_nr (const ir_node *node);
192 * irnode constructor.
193 * Create a new irnode in irg, with an op, mode, arity and
194 * some incoming irnodes.
195 * This constructor is used in every specified irnode constructor.
197 * @param db Debug info.
198 * @param irg IR-graph on with this new node should be constructed.
199 * @param op The opcode of the new node.
200 * @param mode The mode of the new node.
201 * @param arity The arity of the new node, may be <0 if yet.
202 * @param in An array of arity predecessor nodes.
205 new_ir_node (dbg_info *db,
215 * NAME access functions for node fields.
217 * Not properly documented ;-)
221 /** This works for all except Block. To express the difference to
222 * access routines that work for all nodes we use infix "nodes" and do not
223 * name this function get_irn_block. */
224 #define get_nodes_block get_nodes_Block
225 ir_node *get_nodes_block (ir_node *node);
226 #define set_nodes_block set_nodes_Block
227 void set_nodes_block (ir_node *node, ir_node *block);
230 * @function get_irn_block
231 * @see get_nodes_block()
234 * Projection numbers for result of Start node: use for Proj nodes!
237 pn_Start_X_initial_exec, /**< Projection on the initial control flow. */
238 pn_Start_M, /**< Projection on the initial memory. */
239 pn_Start_P_frame_base, /**< Projection on the frame base pointer. */
240 pn_Start_P_globals, /**< Projection on the pointer to the data segment
241 containing _all_ global entities. */
242 pn_Start_T_args, /**< Projection on all arguments. */
243 pn_Start_P_value_arg_base /**< Pointer to region of compound value arguments as defined by
244 type of this method. */
245 } pn_Start; /* Projection numbers for Start. */
248 /** Test whether arbitrary node is frame pointer.
250 * Test whether arbitrary node is frame pointer, i.e. Proj(pn_Start_P_frame_base)
251 * from Start. If so returns frame type, else Null. */
252 type *is_frame_pointer(ir_node *n);
254 /** Test whether arbitrary node is globals pointer.
256 * Test whether arbitrary node is globals pointer, i.e. Proj(pn_Start_P_globals)
257 * from Start. If so returns global type, else Null. */
258 type *is_globals_pointer(ir_node *n);
260 /** Test whether arbitrary node is value arg base.
262 * Test whether arbitrary node is value arg base, i.e. Proj(pn_Start_P_value_arg_base)
263 * from Start. If so returns 1, else 0. */
264 int is_value_arg_pointer(ir_node *n);
267 /* @@@ no more supported */
268 ir_node **get_Block_cfgpred_arr (ir_node *node);
269 int get_Block_n_cfgpreds (ir_node *node);
270 ir_node *get_Block_cfgpred (ir_node *node, int pos);
271 void set_Block_cfgpred (ir_node *node, int pos, ir_node *pred);
272 bool get_Block_matured (ir_node *node);
273 void set_Block_matured (ir_node *node, bool matured);
274 unsigned long get_Block_block_visited (ir_node *node);
275 void set_Block_block_visited (ir_node *node, unsigned long visit);
276 /* For this current_ir_graph must be set. */
277 void mark_Block_block_visited(ir_node *node);
278 int Block_not_block_visited(ir_node *node);
280 /* Set and remove interprocedural predecessors. If the interprocedural
281 * predecessors are removed, the node has the same predecessors in
283 * @@@ Maybe better: arity is zero if no cg preds. */
284 void set_Block_cg_cfgpred_arr(ir_node * node, int arity, ir_node ** in);
285 void set_Block_cg_cfgpred(ir_node * node, int pos, ir_node * pred);
286 /* @@@ not supported */
287 ir_node **get_Block_cg_cfgpred_arr(ir_node * node);
288 /* Returns the number of interprocedural predecessors. 0 if none. */
289 int get_Block_cg_n_cfgpreds(ir_node * node);
290 ir_node *get_Block_cg_cfgpred(ir_node * node, int pos);
291 /* frees the memory. */
292 void remove_Block_cg_cfgpred_arr(ir_node * node);
294 /** Keep alive dedicated nodes. These must be either
295 * PhiM or Block nodes. */
296 int get_End_n_keepalives(ir_node *end);
297 ir_node *get_End_keepalive(ir_node *end, int pos);
298 void add_End_keepalive (ir_node *end, ir_node *ka);
299 void set_End_keepalive(ir_node *end, int pos, ir_node *ka);
300 /* Some parts of the End node are allocated separately -- their memory
301 is not recovered by dead_node_elimination if a End node is dead.
302 free_End frees these data structures. */
303 void free_End (ir_node *end);
306 /* We distinguish three kinds of Cond nodes. These can be distinguished
307 by the mode of the selector operand and an internal flag of type cond_kind.
308 First we distinguish binary Conds and switch Conds.
309 A binary Cond has as selector a boolean value. Proj(0) projects the control
310 flow for case "False", Proj(1) the control flow for "True". A binary Cond
311 is recognized by the boolean selector.
312 The switch Cond has as selector an unsigned integer. It produces as result
313 an n+1 Tuple (cf0, ... , cfn) of control flows.
314 We differ two flavours of this Cond. The first, the dense Cond, passes
315 control along output i if the selector value is i, 0 <= i <= n. If the
316 selector value is >n it passes control along output n.
317 The second Cond flavor differes in the treatment of cases not specified in
318 the source program. It magically knows about the existence of Proj nodes.
319 It only passes control along output i, 0 <= i <= n, if a node Proj(Cond, i)
320 exists. Else it passes control along output n (even if this Proj does not
321 exist.) This Cond we call "fragmentary". There is a special constructor
322 new_defaultProj that automatically sets the flavor.
323 The two switch flavors are distinguished by a flag of type cond_kind.
324 Default flavor is "dense"
327 dense, /**< Default. Missing Proj nodes are dead control flow. */
328 fragmentary /**< Special. No control flow optimizations allowed. Missing
329 Proj nodes mean default control flow, i.e., Proj(n). */
332 ir_node *get_Cond_selector (ir_node *node);
333 void set_Cond_selector (ir_node *node, ir_node *selector);
334 cond_kind get_Cond_kind (ir_node *node);
335 void set_Cond_kind (ir_node *node, cond_kind kind);
336 long get_Cond_defaultProj (ir_node *node);
339 * Projection numbers for conditions.
342 pn_Cond_false, /**< Control flow if operand is "false". */
343 pn_Cond_true /**< Control flow if operand is "true". */
344 } pn_Cond; /* Projection numbers for Cond. */
346 ir_node *get_Return_mem (ir_node *node);
347 void set_Return_mem (ir_node *node, ir_node *mem);
348 ir_node **get_Return_res_arr (ir_node *node);
349 int get_Return_n_ress (ir_node *node);
350 ir_node *get_Return_res (ir_node *node, int pos);
351 void set_Return_res (ir_node *node, int pos, ir_node *res);
353 ir_node *get_Raise_mem (ir_node *node);
354 void set_Raise_mem (ir_node *node, ir_node *mem);
355 ir_node *get_Raise_exo_ptr (ir_node *node); /* PoinTeR to EXception Object */
356 void set_Raise_exo_ptr (ir_node *node, ir_node *exoptr);
359 * Projection numbers for Raise.
362 pn_Raise_X, /**< Execution result. */
363 pn_Raise_M /**< Memory result. */
364 } pn_Raise; /* Projection numbers for Raise. */
366 tarval *get_Const_tarval (ir_node *node);
367 void set_Const_tarval (ir_node *node, tarval *con);
368 /* The source language type. Must be an atomic type. Mode of type must
369 be mode of node. For tarvals from entities type must be pointer to
371 type *get_Const_type (ir_node *node);
372 void set_Const_type (ir_node *node, type *tp);
374 /** This enum names the three different kinds of symbolic Constants
375 represented by SymConst. The content of the attribute type_or_id
376 depends on this tag. Use the proper access routine after testing
380 symconst_type_tag, /**< The SymConst is a type tag for the given type.
381 Type_or_id_p is type *. */
382 symconst_size, /**< The SymConst is the size of the given type.
383 Type_or_id_p is type *. */
384 symconst_addr_name, /**< The SymConst is a symbolic pointer to be filled in
385 by the linker. The pointer is represented by a string.
386 Type_or_id_p is ident *. */
387 symconst_addr_ent /**< The SymConst is a symbolic pointer to be filled in
388 by the linker. The pointer is represented by an entity.
389 Type_or_id_p is entity *. */
392 /** SymConst attributes
393 This union contains the symbolic information represented by the node */
394 union symconst_symbol {
401 typedef union symconst_symbol symconst_symbol;
404 /** Access the kind of the SymConst. */
405 symconst_kind get_SymConst_kind (const ir_node *node);
406 void set_SymConst_kind (ir_node *node, symconst_kind num);
408 /** Only to access SymConst of kind type_tag or size. Else assertion: */
409 type *get_SymConst_type (ir_node *node);
410 void set_SymConst_type (ir_node *node, type *tp);
412 /** Only to access SymConst of kind addr_name. Else assertion: */
413 ident *get_SymConst_name (ir_node *node);
414 void set_SymConst_name (ir_node *node, ident *name);
416 /** Only to access SymConst of kind addr_ent. Else assertion: */
417 entity *get_SymConst_entity (ir_node *node);
418 void set_SymConst_entity (ir_node *node, entity *ent);
420 /** Sets both: type and ptrinfo. Needed to treat the node independent of
421 its semantics. Does a memcpy for the memory sym points to. */
422 /* write 'union': firmjni then does not create a method... */
423 union symconst_symbol get_SymConst_symbol (ir_node *node);
424 void set_SymConst_symbol (ir_node *node,
425 union symconst_symbol sym);
427 ir_node *get_Sel_mem (ir_node *node);
428 void set_Sel_mem (ir_node *node, ir_node *mem);
429 ir_node *get_Sel_ptr (ir_node *node); /* ptr to the object to select from */
430 void set_Sel_ptr (ir_node *node, ir_node *ptr);
431 ir_node **get_Sel_index_arr (ir_node *node);
432 int get_Sel_n_indexs (ir_node *node);
433 ir_node *get_Sel_index (ir_node *node, int pos);
434 void set_Sel_index (ir_node *node, int pos, ir_node *index);
435 entity *get_Sel_entity (ir_node *node); /* entity to select */
436 void set_Sel_entity (ir_node *node, entity *ent);
439 * Projection numbers for result of Call node: use for Proj nodes!
442 pn_Call_M_regular = 0, /**< The memory result. */
443 pn_Call_T_result = 2, /**< The tuple containing all (0, 1, 2, ...) results */
444 pn_Call_P_value_res_base = 4,/**< A pointer to the memory region containing copied results
445 passed by value (for compound result types). */
446 pn_Call_X_except = 1, /**< The control flow result branching to the exception handler */
447 pn_Call_M_except = 3, /**< The memory result in case the called method terminated with
449 pn_Call_max = 5 /**< number of prejections from a Call */
450 } pn_Call; /* Projection numbers for Call. */
452 ir_node *get_Call_mem (ir_node *node);
453 void set_Call_mem (ir_node *node, ir_node *mem);
454 ir_node *get_Call_ptr (ir_node *node);
455 void set_Call_ptr (ir_node *node, ir_node *ptr);
456 ir_node **get_Call_param_arr (ir_node *node);
457 /** Gets the number of parameters of a call. */
458 int get_Call_n_params (ir_node *node);
459 /** Gets the call parameter at position pos. */
460 ir_node *get_Call_param (ir_node *node, int pos);
461 /** Sets the call parameter at position pos. */
462 void set_Call_param (ir_node *node, int pos, ir_node *param);
463 /** Gets the type of a call. */
464 type *get_Call_type (ir_node *node);
465 /** Sets the type of a call. */
466 void set_Call_type (ir_node *node, type *tp);
467 /** Gets the arity of a call. Identical to get_Call_n_params(). */
468 int get_Call_arity (ir_node *node);
470 /* Set, get and remove the callee-analysis.
471 The array is only accessible if information is valid.
472 It contains NULL for called methods that are not within
473 the compilation unit. */
474 int Call_has_callees (ir_node *node);
475 int get_Call_n_callees (ir_node * node);
476 entity *get_Call_callee (ir_node * node, int pos);
477 /* assumes current_ir_graph set properly! */
478 void set_Call_callee_arr (ir_node * node, int n, entity ** arr);
479 void remove_Call_callee_arr(ir_node * node);
481 ir_node *get_CallBegin_ptr (ir_node *node);
482 void set_CallBegin_ptr (ir_node *node, ir_node *ptr);
483 ir_node *get_CallBegin_call (ir_node *node);
484 void set_CallBegin_call (ir_node *node, ir_node *call);
486 ir_node *get_FuncCall_ptr (ir_node *node);
487 void set_FuncCall_ptr (ir_node *node, ir_node *ptr);
488 ir_node **get_FuncCall_param_arr (ir_node *node);
489 /** Gets the number of parameters of a func call. */
490 int get_FuncCall_n_params (ir_node *node);
491 /** Gets the func call parameter at position pos. */
492 ir_node *get_FuncCall_param (ir_node *node, int pos);
493 /** Sets the func call parameter at position pos. */
494 void set_FuncCall_param (ir_node *node, int pos, ir_node *param);
495 /** Gets the type of a func call. */
496 type *get_FuncCall_type (ir_node *node);
497 /** Sets the type of a func call. */
498 void set_FuncCall_type (ir_node *node, type *tp);
499 /** Gets the arity of a func call. Identical to get_FuncCall_n_params(). */
500 int get_FuncCall_arity (ir_node *node);
502 /* Set, get and remove the callee-analysis.
503 The array is only accessible if information is valid.
504 It contains NULL for called methods that are not within
505 the compilation unit. */
506 int FuncCall_has_callees (ir_node *node);
507 int get_FuncCall_n_callees (ir_node * node);
508 entity *get_FuncCall_callee (ir_node * node, int pos);
509 /* assumes current_ir_graph set properly! */
510 void set_FuncCall_callee_arr (ir_node * node, int n, entity ** arr);
511 void remove_FuncCall_callee_arr(ir_node * node);
513 /* For unary and binary arithmetic operations the access to the
514 operands can be factored out. Left is the first, right the
515 second arithmetic value as listed in tech report 1999-44.
516 unops are: Minus, Abs, Not, Conv, Cast
517 binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
518 Shr, Shrs, Rot, Cmp */
519 int is_unop (ir_node *node);
520 ir_node *get_unop_op (ir_node *node);
521 void set_unop_op (ir_node *node, ir_node *op);
522 int is_binop (ir_node *node);
523 ir_node *get_binop_left (ir_node *node);
524 void set_binop_left (ir_node *node, ir_node *left);
525 ir_node *get_binop_right (ir_node *node);
526 void set_binop_right (ir_node *node, ir_node *right);
528 ir_node *get_Add_left (ir_node *node);
529 void set_Add_left (ir_node *node, ir_node *left);
530 ir_node *get_Add_right (ir_node *node);
531 void set_Add_right (ir_node *node, ir_node *right);
533 ir_node *get_Sub_left (ir_node *node);
534 void set_Sub_left (ir_node *node, ir_node *left);
535 ir_node *get_Sub_right (ir_node *node);
536 void set_Sub_right (ir_node *node, ir_node *right);
538 ir_node *get_Minus_op (ir_node *node);
539 void set_Minus_op (ir_node *node, ir_node *op);
541 ir_node *get_Mul_left (ir_node *node);
542 void set_Mul_left (ir_node *node, ir_node *left);
543 ir_node *get_Mul_right (ir_node *node);
544 void set_Mul_right (ir_node *node, ir_node *right);
546 ir_node *get_Quot_left (ir_node *node);
547 void set_Quot_left (ir_node *node, ir_node *left);
548 ir_node *get_Quot_right (ir_node *node);
549 void set_Quot_right (ir_node *node, ir_node *right);
550 ir_node *get_Quot_mem (ir_node *node);
551 void set_Quot_mem (ir_node *node, ir_node *mem);
554 * Projection numbers for Quot: use for Proj nodes!
557 pn_Quot_M, /**< Memory result. */
558 pn_Quot_X_except, /**< Execution result if exception occured. */
559 pn_Quot_res /**< Result of computation. */
560 } pn_Quot; /* Projection numbers for Quot. */
562 ir_node *get_DivMod_left (ir_node *node);
563 void set_DivMod_left (ir_node *node, ir_node *left);
564 ir_node *get_DivMod_right (ir_node *node);
565 void set_DivMod_right (ir_node *node, ir_node *right);
566 ir_node *get_DivMod_mem (ir_node *node);
567 void set_DivMod_mem (ir_node *node, ir_node *mem);
570 * Projection numbers for DivMod: use for Proj nodes!
573 pn_DivMod_M, /**< Memory result. */
574 pn_DivMod_X_except, /**< Execution result if exception occured. */
575 pn_DivMod_res_div, /**< Result of computation a / b. */
576 pn_DivMod_res_mod /**< Result of computation a % b. */
577 } pn_DivMod; /* Projection numbers for DivMod. */
579 ir_node *get_Div_left (ir_node *node);
580 void set_Div_left (ir_node *node, ir_node *left);
581 ir_node *get_Div_right (ir_node *node);
582 void set_Div_right (ir_node *node, ir_node *right);
583 ir_node *get_Div_mem (ir_node *node);
584 void set_Div_mem (ir_node *node, ir_node *mem);
587 * Projection numbers for Div: use for Proj nodes!
590 pn_Div_M, /**< Memory result. */
591 pn_Div_X_except, /**< Execution result if exception occured. */
592 pn_Div_res /**< Result of computation. */
593 } pn_Div; /* Projection numbers for Div. */
595 ir_node *get_Mod_left (ir_node *node);
596 void set_Mod_left (ir_node *node, ir_node *left);
597 ir_node *get_Mod_right (ir_node *node);
598 void set_Mod_right (ir_node *node, ir_node *right);
599 ir_node *get_Mod_mem (ir_node *node);
600 void set_Mod_mem (ir_node *node, ir_node *mem);
603 * Projection numbers for Mod: use for Proj nodes!
606 pn_Mod_M, /**< Memory result. */
607 pn_Mod_X_except, /**< Execution result if exception occured. */
608 pn_Mod_res /**< Result of computation. */
609 } pn_Mod; /* Projection numbers for Mod. */
611 ir_node *get_Abs_op (ir_node *node);
612 void set_Abs_op (ir_node *node, ir_node *op);
614 ir_node *get_And_left (ir_node *node);
615 void set_And_left (ir_node *node, ir_node *left);
616 ir_node *get_And_right (ir_node *node);
617 void set_And_right (ir_node *node, ir_node *right);
619 ir_node *get_Or_left (ir_node *node);
620 void set_Or_left (ir_node *node, ir_node *left);
621 ir_node *get_Or_right (ir_node *node);
622 void set_Or_right (ir_node *node, ir_node *right);
624 ir_node *get_Eor_left (ir_node *node);
625 void set_Eor_left (ir_node *node, ir_node *left);
626 ir_node *get_Eor_right (ir_node *node);
627 void set_Eor_right (ir_node *node, ir_node *right);
629 ir_node *get_Not_op (ir_node *node);
630 void set_Not_op (ir_node *node, ir_node *op);
633 * Projection numbers for Cmp are defined several times.
634 * The bit patterns are used for various tests, so don't change.
635 * The "unordered" values are possible results of comparing
636 * floating point numbers.
639 pn_Cmp_False = 0, /**< false */
640 pn_Cmp_Eq, /**< equal */
641 pn_Cmp_Lt, /**< less */
642 pn_Cmp_Le, /**< less or equal */
643 pn_Cmp_Gt, /**< greater */
644 pn_Cmp_Ge, /**< greater or equal */
645 pn_Cmp_Lg, /**< less or greater */
646 pn_Cmp_Leg = 7, /**< less, equal or greater = ordered */
647 pn_Cmp_Uo, /**< unordered */
648 pn_Cmp_Ue, /**< unordered or equal */
649 pn_Cmp_Ul, /**< unordered or less */
650 pn_Cmp_Ule, /**< unordered, less or equal */
651 pn_Cmp_Ug, /**< unordered or greater */
652 pn_Cmp_Uge, /**< unordered, greater or equal */
653 pn_Cmp_Ne, /**< unordered, less or greater = not equal */
654 pn_Cmp_True = 15 /**< true */
655 /* not_mask = Leg*/ /* bits to flip to negate comparison * @@ hack for jni interface */
656 } pn_Cmp; /* Projection numbers for Cmp */
657 /* #define not_mask pn_Cmp_Leg */
659 const char *get_pnc_string(int pnc);
660 int get_negated_pnc(int pnc);
661 ir_node *get_Cmp_left (ir_node *node);
662 void set_Cmp_left (ir_node *node, ir_node *left);
663 ir_node *get_Cmp_right (ir_node *node);
664 void set_Cmp_right (ir_node *node, ir_node *right);
666 ir_node *get_Shl_left (ir_node *node);
667 void set_Shl_left (ir_node *node, ir_node *left);
668 ir_node *get_Shl_right (ir_node *node);
669 void set_Shl_right (ir_node *node, ir_node *right);
671 ir_node *get_Shr_left (ir_node *node);
672 void set_Shr_left (ir_node *node, ir_node *left);
673 ir_node *get_Shr_right (ir_node *node);
674 void set_Shr_right (ir_node *node, ir_node *right);
676 ir_node *get_Shrs_left (ir_node *node);
677 void set_Shrs_left (ir_node *node, ir_node *left);
678 ir_node *get_Shrs_right (ir_node *node);
679 void set_Shrs_right (ir_node *node, ir_node *right);
681 ir_node *get_Rot_left (ir_node *node);
682 void set_Rot_left (ir_node *node, ir_node *left);
683 ir_node *get_Rot_right (ir_node *node);
684 void set_Rot_right (ir_node *node, ir_node *right);
686 ir_node *get_Conv_op (ir_node *node);
687 void set_Conv_op (ir_node *node, ir_node *op);
689 /* Does Cast need a mem operator?
690 * Cast should only depend on the type, not on the state of an
691 * entity. But: we initialze various fields after Alloc, that
692 * are accessed in the cast. This required some precaution, to
693 * get the right memory into the Loads generated from the cast.
695 ir_node *get_Cast_op (ir_node *node);
696 void set_Cast_op (ir_node *node, ir_node *op);
697 type *get_Cast_type (ir_node *node);
698 void set_Cast_type (ir_node *node, type *to_tp);
700 /** Returns true if n is Phi or Filter in interprocedural_view.
701 Returns false if irg in phase building and the Phi has zero
702 predecessors: it's a Phi0. */
703 int is_Phi (ir_node *n);
704 /** Returns true if irg in phase building and the Phi has zero
705 predecessors: it's a Phi0. */
706 int is_Phi0 (ir_node *n);
707 /* These routines also work for Filter nodes in interprocedural view. */
708 ir_node **get_Phi_preds_arr (ir_node *node);
709 int get_Phi_n_preds (ir_node *node);
710 ir_node *get_Phi_pred (ir_node *node, int pos);
711 void set_Phi_pred (ir_node *node, int pos, ir_node *pred);
713 ir_node *get_Filter_pred(ir_node *node);
714 void set_Filter_pred(ir_node *node, ir_node *pred);
715 long get_Filter_proj(ir_node *node);
716 void set_Filter_proj(ir_node *node, long proj);
717 /* set the interprocedural predecessors, ...d_arr uses current_ir_graph.
718 * @@@ Maybe better: arity is zero if no cg preds. */
719 void set_Filter_cg_pred_arr(ir_node * node, int arity, ir_node ** in);
720 void set_Filter_cg_pred(ir_node * node, int pos, ir_node * pred);
721 int get_Filter_n_cg_preds(ir_node *node);
722 ir_node *get_Filter_cg_pred(ir_node *node, int pos);
724 /** Return true if parameter is a memory operation.
726 * A memory operation is an operation that directly changes the
727 * memory. I.e., a Load or a Store operation.
729 int is_memop(ir_node *node);
730 ir_node *get_memop_mem (ir_node *node);
731 void set_memop_mem (ir_node *node, ir_node *mem);
732 ir_node *get_memop_ptr (ir_node *node);
733 void set_memop_ptr (ir_node *node, ir_node *ptr);
736 * Projection numbers for Load: use for Proj nodes!
739 pn_Load_M, /**< Memory result. */
740 pn_Load_X_except, /**< Execution result if exception occured. */
741 pn_Load_res /**< Result of load operation. */
742 } pn_Load; /* Projection numbers for Load. */
744 ir_node *get_Load_mem (ir_node *node);
745 void set_Load_mem (ir_node *node, ir_node *mem);
746 ir_node *get_Load_ptr (ir_node *node);
747 void set_Load_ptr (ir_node *node, ir_node *ptr);
750 * Projection numbers for Store: use for Proj nodes!
753 pn_Store_M, /**< Memory result. */
754 pn_Store_X_except /**< Execution result if exception occured. */
755 } pn_Store; /* Projection numbers for Store. */
757 ir_node *get_Store_mem (ir_node *node);
758 void set_Store_mem (ir_node *node, ir_node *mem);
759 ir_node *get_Store_ptr (ir_node *node);
760 void set_Store_ptr (ir_node *node, ir_node *ptr);
761 ir_node *get_Store_value (ir_node *node);
762 void set_Store_value (ir_node *node, ir_node *value);
765 * Projection numbers for Alloc: use for Proj nodes!
768 pn_Alloc_M, /**< Memory result. */
769 pn_Alloc_X_except, /**< Execution result if exception occured. */
770 pn_Alloc_res /**< Result of allocation. */
771 } pn_Alloc; /* Projection numbers for Alloc. */
773 ir_node *get_Alloc_mem (ir_node *node);
774 void set_Alloc_mem (ir_node *node, ir_node *mem);
775 ir_node *get_Alloc_size (ir_node *node);
776 void set_Alloc_size (ir_node *node, ir_node *size);
777 type *get_Alloc_type (ir_node *node);
778 void set_Alloc_type (ir_node *node, type *tp);
780 /** The allocation place. */
782 stack_alloc, /**< Alloc allocates the object on the stack. */
783 heap_alloc /**< Alloc allocates the object on the heap. */
786 where_alloc get_Alloc_where (ir_node *node);
787 void set_Alloc_where (ir_node *node, where_alloc where);
789 ir_node *get_Free_mem (ir_node *node);
790 void set_Free_mem (ir_node *node, ir_node *mem);
791 ir_node *get_Free_ptr (ir_node *node);
792 void set_Free_ptr (ir_node *node, ir_node *ptr);
793 ir_node *get_Free_size (ir_node *node);
794 void set_Free_size (ir_node *node, ir_node *size);
795 type *get_Free_type (ir_node *node);
796 void set_Free_type (ir_node *node, type *tp);
798 ir_node **get_Sync_preds_arr (ir_node *node);
799 int get_Sync_n_preds (ir_node *node);
800 ir_node *get_Sync_pred (ir_node *node, int pos);
801 void set_Sync_pred (ir_node *node, int pos, ir_node *pred);
803 ir_node *get_Proj_pred (ir_node *node);
804 void set_Proj_pred (ir_node *node, ir_node *pred);
805 long get_Proj_proj (ir_node *node);
806 void set_Proj_proj (ir_node *node, long proj);
808 ir_node **get_Tuple_preds_arr (ir_node *node);
809 int get_Tuple_n_preds (ir_node *node);
810 ir_node *get_Tuple_pred (ir_node *node, int pos);
811 void set_Tuple_pred (ir_node *node, int pos, ir_node *pred);
813 ir_node *get_Id_pred (ir_node *node);
814 void set_Id_pred (ir_node *node, ir_node *pred);
816 /** Confirm has a single result and returns 'value' unchanged.
817 * The node expresses a restriction on 'value':
818 * 'value' 'cmp' 'bound' == true. */
819 ir_node *get_Confirm_value (ir_node *node);
820 void set_Confirm_value (ir_node *node, ir_node *value);
821 ir_node *get_Confirm_bound (ir_node *node);
822 void set_Confirm_bound (ir_node *node, ir_node *bound);
823 pn_Cmp get_Confirm_cmp (ir_node *node);
824 void set_Confirm_cmp (ir_node *node, pn_Cmp cmp);
828 * NAME Auxiliary routines
830 * Not properly documented ;-)
834 /** returns operand of node if node is a Proj. */
835 ir_node *skip_Proj (ir_node *node);
836 /** returns operand of node if node is a Id */
837 ir_node *skip_Id (ir_node *node); /* Same as skip_nop. */
838 /* returns corresponding operand of Tuple if node is a Proj from
840 ir_node *skip_Tuple (ir_node *node);
841 /** returns operand of node if node is a Cast */
842 ir_node *skip_Cast (ir_node *node);
843 /** returns true if node is a Bad node. */
844 int is_Bad (ir_node *node);
845 /** returns true if the node is not a Block */
846 int is_no_Block (ir_node *node);
847 /** returns true if the node is a Block */
848 int is_Block (ir_node *node);
849 /** returns true if node is a Unknown node. */
850 int is_Unknown (ir_node *node);
851 /** returns true if node is a Proj node or a Filter node in
852 * intraprocedural view */
853 int is_Proj (const ir_node *node);
854 /** Returns true if the operation manipulates control flow:
855 Start, End, Jmp, Cond, Return, Raise, Bad, CallBegin, EndReg, EndExcept */
856 int is_cfop(ir_node *node);
858 /** Returns true if the operation manipulates interprocedural control flow:
859 CallBegin, EndReg, EndExcept */
860 int is_ip_cfop(ir_node *node);
861 /** Returns true if the operation can change the control flow because
862 of an exception: Call, Quot, DivMod, Div, Mod, Load, Store, Alloc,
864 int is_fragile_op(ir_node *node);
865 /** Returns the memory operand of fragile operations. */
866 ir_node *get_fragile_op_mem(ir_node *node);
868 /*-----------------------------------------------------------------*/
870 /*-----------------------------------------------------------------*/
873 /** Debug print the node.
875 * Writes the node, all its attributes and the predecessors to stdout if DEBUG_libfirm
876 * is set. Else does nothing. */
877 void dump_irn(ir_node *n);
882 /* GNU C has the __FUNCTION__ extension */
883 #define __MYFUNC__ __FUNCTION__
885 /* use Filename instead */
886 #define __MYFUNC__ __FILE__
890 Don't format with "\", firmjni gets problems */
891 /** Output location */
892 #define DDM printf("%s(l.%i).\n", __MYFUNC__, __LINE__);
893 /** Output the firm kind of the node */
894 #define DDMK(X) printf("%s(l.%i) %s: %p\n", __MYFUNC__, __LINE__, print_firm_kind(X), (void *)(X));
895 /** Output information about a node */
896 #define DDMN(X) printf("%s(l.%i) %s%s: %ld (%p)\n", __MYFUNC__, __LINE__, get_irn_opname(X), get_mode_name(get_irn_mode(X)), get_irn_node_nr(X), (void *)(X))
897 /** Output information about a node and its block */
898 #define DDMNB(X) printf("%s%s: %ld (in block %ld)\n", get_irn_opname(X), get_mode_name(get_irn_mode(X)), get_irn_node_nr(X), get_irn_node_nr(get_nodes_block(X)))
899 /** Output information about a type */
900 #define DDMT(X) printf("%s(l.%i) %s %s: %ld (%p)\n", __MYFUNC__, __LINE__, get_type_tpop_name(X), get_type_name(X), get_type_nr(X), (void *)(X))
901 /** Output information about an entity */
902 #define DDME(X) printf("%s(l.%i) %s: %ld (%p)\n", __MYFUNC__, __LINE__, get_entity_name(X), get_entity_nr(X), (void *)(X))
903 /** Output information about an entity and its type */
904 #define DDMET(X) printf("%s(l.%i) %s (typ: %s): %ld (%p)\n", __MYFUNC__, __LINE__, get_entity_name(X), get_type_name(get_entity_type(X)), get_entity_nr(X), (void *)(X))
905 /** Output information about an entity and its owner */
906 #define DDMEO(X) printf("%s(l.%i) %s (own: %s): %ld (%p)\n", __MYFUNC__, __LINE__, get_entity_name(X), get_type_name(get_entity_owner(X)), get_entity_nr(X), (void *)(X))
907 /** Output information about a graph */
908 #define DDMG(X) printf("%s(l.%i) graph %s: %ld (%p) in %s %s.\n", __MYFUNC__, __LINE__, get_entity_name(get_irg_entity(X)), get_irg_graph_nr(X), (void *)(X), get_type_tpop_name(get_entity_owner(get_irg_entity(X))), get_type_name(get_entity_owner(get_irg_entity(X))))
909 /** Output information about an ident */
910 #define DDMI(X) printf("%s(l.%i) %s: %p\n", __MYFUNC__, __LINE__, get_id_str(X), (void *)(X))
911 /** Output information about a mode */
912 #define DDMM(X) printf("%s(l.%i) %s: %p\n", __MYFUNC__, __LINE__, get_mode_name(X), (void *)(X))
913 /** Output information about a loop */
914 #define DDML(X) printf("%s(l.%i) loop with depth %d: %d\n", __MYFUNC__, __LINE__, get_loop_depth(X), get_loop_loop_nr(X))
915 /** Output information about a tarVal */
916 #define DDMV(X) printf("%s(l.%i) tarval: ",__MYFUNC__, __LINE__); tarval_printf(X); printf(" (%p)\n", (void *)(X));
918 /*@}*/ /* end of ir_node group definition */
925 # endif /* _IRNODE_H_ */