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()
235 * Projection numbers for result of Start node: use for Proj nodes!
238 pn_Start_X_initial_exec, /**< Projection on the initial control flow. */
239 pn_Start_M, /**< Projection on the initial memory. */
240 pn_Start_P_frame_base, /**< Projection on the frame base pointer. */
241 pn_Start_P_globals, /**< Projection on the pointer to the data segment
242 containing _all_ global entities. */
243 pn_Start_T_args, /**< Projection on all arguments. */
244 pn_Start_P_value_arg_base /**< Pointer to region of compound value arguments as defined by
245 type of this method. */
246 } pn_Start; /* Projection numbers for Start. */
249 /** Test whether arbitrary node is frame pointer.
251 * Test whether arbitrary node is frame pointer, i.e. Proj(pn_Start_P_frame_base)
252 * from Start. If so returns frame type, else Null. */
253 type *is_frame_pointer(ir_node *n);
255 /** Test whether arbitrary node is globals pointer.
257 * Test whether arbitrary node is globals pointer, i.e. Proj(pn_Start_P_globals)
258 * from Start. If so returns global type, else Null. */
259 type *is_globals_pointer(ir_node *n);
261 /** Test whether arbitrary node is value arg base.
263 * Test whether arbitrary node is value arg base, i.e. Proj(pn_Start_P_value_arg_base)
264 * from Start. If so returns 1, else 0. */
265 int is_value_arg_pointer(ir_node *n);
268 /* @@@ no more supported */
269 ir_node **get_Block_cfgpred_arr (ir_node *node);
270 int get_Block_n_cfgpreds (ir_node *node);
271 ir_node *get_Block_cfgpred (ir_node *node, int pos);
272 void set_Block_cfgpred (ir_node *node, int pos, ir_node *pred);
273 bool get_Block_matured (ir_node *node);
274 void set_Block_matured (ir_node *node, bool matured);
275 unsigned long get_Block_block_visited (ir_node *node);
276 void set_Block_block_visited (ir_node *node, unsigned long visit);
277 /* For this current_ir_graph must be set. */
278 void mark_Block_block_visited(ir_node *node);
279 int Block_not_block_visited(ir_node *node);
281 /* Set and remove interprocedural predecessors. If the interprocedural
282 * predecessors are removed, the node has the same predecessors in
284 * @@@ Maybe better: arity is zero if no cg preds. */
285 void set_Block_cg_cfgpred_arr(ir_node * node, int arity, ir_node ** in);
286 void set_Block_cg_cfgpred(ir_node * node, int pos, ir_node * pred);
287 /* @@@ not supported */
288 ir_node **get_Block_cg_cfgpred_arr(ir_node * node);
289 /* Returns the number of interprocedural predecessors. 0 if none. */
290 int get_Block_cg_n_cfgpreds(ir_node * node);
291 ir_node *get_Block_cg_cfgpred(ir_node * node, int pos);
292 /* frees the memory. */
293 void remove_Block_cg_cfgpred_arr(ir_node * node);
295 int get_End_n_keepalives(ir_node *end);
296 ir_node *get_End_keepalive(ir_node *end, int pos);
297 void add_End_keepalive (ir_node *end, ir_node *ka);
298 void set_End_keepalive(ir_node *end, int pos, ir_node *ka);
299 /* Some parts of the End node are allocated separately -- their memory
300 is not recovered by dead_node_elimination if a End node is dead.
301 free_End frees these data structures. */
302 void free_End (ir_node *end);
305 /* We distinguish three kinds of Cond nodes. These can be distinguished
306 by the mode of the selector operand and an internal flag of type cond_kind.
307 First we distinguish binary Conds and switch Conds.
308 A binary Cond has as selector a boolean value. Proj(0) projects the control
309 flow for case "False", Proj(1) the control flow for "True". A binary Cond
310 is recognized by the boolean selector.
311 The switch Cond has as selector an unsigned integer. It produces as result
312 an n+1 Tuple (cf0, ... , cfn) of control flows.
313 We differ two flavours of this Cond. The first, the dense Cond, passes
314 control along output i if the selector value is i, 0 <= i <= n. If the
315 selector value is >n it passes control along output n.
316 The second Cond flavor differes in the treatment of cases not specified in
317 the source program. It magically knows about the existence of Proj nodes.
318 It only passes control along output i, 0 <= i <= n, if a node Proj(Cond, i)
319 exists. Else it passes control along output n (even if this Proj does not
320 exist.) This Cond we call "fragmentary". There is a special constructor
321 new_defaultProj that automatically sets the flavor.
322 The two switch flavors are distinguished by a flag of type cond_kind.
323 Default flavor is "dense"
326 dense, /**< Default. Missing Proj nodes are dead control flow. */
327 fragmentary /**< Special. No control flow optimizations allowed. Missing
328 Proj nodes mean default control flow, i.e., Proj(n). */
331 ir_node *get_Cond_selector (ir_node *node);
332 void set_Cond_selector (ir_node *node, ir_node *selector);
333 cond_kind get_Cond_kind (ir_node *node);
334 void set_Cond_kind (ir_node *node, cond_kind kind);
335 long get_Cond_defaultProj (ir_node *node);
338 * Projection numbers for conditions.
341 pn_Cond_false, /**< Control flow if operand is "false". */
342 pn_Cond_true /**< Control flow if operand is "true". */
343 } pn_Cond; /* Projection numbers for Cond. */
345 ir_node *get_Return_mem (ir_node *node);
346 void set_Return_mem (ir_node *node, ir_node *mem);
347 ir_node **get_Return_res_arr (ir_node *node);
348 int get_Return_n_ress (ir_node *node);
349 ir_node *get_Return_res (ir_node *node, int pos);
350 void set_Return_res (ir_node *node, int pos, ir_node *res);
352 ir_node *get_Raise_mem (ir_node *node);
353 void set_Raise_mem (ir_node *node, ir_node *mem);
354 ir_node *get_Raise_exo_ptr (ir_node *node); /* PoinTeR to EXception Object */
355 void set_Raise_exo_ptr (ir_node *node, ir_node *exoptr);
358 * Projection numbers for Raise.
361 pn_Raise_X, /**< Execution result. */
362 pn_Raise_M /**< Memory result. */
363 } pn_Raise; /* Projection numbers for Raise. */
365 tarval *get_Const_tarval (ir_node *node);
366 void set_Const_tarval (ir_node *node, tarval *con);
367 /* The source language type. Must be an atomic type. Mode of type must
368 be mode of node. For tarvals from entities type must be pointer to
370 type *get_Const_type (ir_node *node);
371 void set_Const_type (ir_node *node, type *tp);
373 /** This enum names the three different kinds of symbolic Constants
374 represented by SymConst. The content of the attribute type_or_id
375 depends on this tag. Use the proper access routine after testing
379 symconst_type_tag, /**< The SymConst is a type tag for the given type.
380 Type_or_id_p is type *. */
381 symconst_size, /**< The SymConst is the size of the given type.
382 Type_or_id_p is type *. */
383 symconst_addr_name, /**< The SymConst is a symbolic pointer to be filled in
384 by the linker. The pointer is represented by a string.
385 Type_or_id_p is ident *. */
386 symconst_addr_ent /**< The SymConst is a symbolic pointer to be filled in
387 by the linker. The pointer is represented by an entity.
388 Type_or_id_p is entity *. */
391 /** SymConst attributes
392 This union contains the symbolic information represented by the node */
393 union symconst_symbol {
400 typedef union symconst_symbol symconst_symbol;
403 /** Access the kind of the SymConst. */
404 symconst_kind get_SymConst_kind (const ir_node *node);
405 void set_SymConst_kind (ir_node *node, symconst_kind num);
407 /** Only to access SymConst of kind type_tag or size. Else assertion: */
408 type *get_SymConst_type (ir_node *node);
409 void set_SymConst_type (ir_node *node, type *tp);
411 /** Only to access SymConst of kind addr_name. Else assertion: */
412 ident *get_SymConst_name (ir_node *node);
413 void set_SymConst_name (ir_node *node, ident *name);
415 /** Only to access SymConst of kind addr_ent. Else assertion: */
416 entity *get_SymConst_entity (ir_node *node);
417 void set_SymConst_entity (ir_node *node, entity *ent);
419 /** Sets both: type and ptrinfo. Needed to treat the node independent of
420 its semantics. Does a memcpy for the memory sym points to. */
421 /* write 'union': firmjni then does not create a method... */
422 union symconst_symbol get_SymConst_symbol (ir_node *node);
423 void set_SymConst_symbol (ir_node *node,
424 union symconst_symbol sym);
426 ir_node *get_Sel_mem (ir_node *node);
427 void set_Sel_mem (ir_node *node, ir_node *mem);
428 ir_node *get_Sel_ptr (ir_node *node); /* ptr to the object to select from */
429 void set_Sel_ptr (ir_node *node, ir_node *ptr);
430 ir_node **get_Sel_index_arr (ir_node *node);
431 int get_Sel_n_indexs (ir_node *node);
432 ir_node *get_Sel_index (ir_node *node, int pos);
433 void set_Sel_index (ir_node *node, int pos, ir_node *index);
434 entity *get_Sel_entity (ir_node *node); /* entity to select */
435 void set_Sel_entity (ir_node *node, entity *ent);
438 * Projection numbers for result of Call node: use for Proj nodes!
441 pn_Call_M_regular = 0, /**< The memory result. */
442 pn_Call_T_result = 2, /**< The tuple containing all (0, 1, 2, ...) results */
443 pn_Call_P_value_res_base = 4,/**< A pointer to the memory region containing copied results
444 passed by value (for compound result types). */
445 pn_Call_X_except = 1, /**< The control flow result branching to the exception handler */
446 pn_Call_M_except = 3, /**< The memory result in case the called method terminated with
448 pn_Call_max = 5 /**< number of prejections from a Call */
449 } pn_Call; /* Projection numbers for Call. */
451 ir_node *get_Call_mem (ir_node *node);
452 void set_Call_mem (ir_node *node, ir_node *mem);
453 ir_node *get_Call_ptr (ir_node *node);
454 void set_Call_ptr (ir_node *node, ir_node *ptr);
455 ir_node **get_Call_param_arr (ir_node *node);
456 /** Gets the number of parameters of a call. */
457 int get_Call_n_params (ir_node *node);
458 /** Gets the call parameter at position pos. */
459 ir_node *get_Call_param (ir_node *node, int pos);
460 /** Sets the call parameter at position pos. */
461 void set_Call_param (ir_node *node, int pos, ir_node *param);
462 /** Gets the type of a call. */
463 type *get_Call_type (ir_node *node);
464 /** Sets the type of a call. */
465 void set_Call_type (ir_node *node, type *tp);
466 /** Gets the arity of a call. Identical to get_Call_n_params(). */
467 int get_Call_arity (ir_node *node);
469 /* Set, get and remove the callee-analysis.
470 The array is only accessible if information is valid.
471 It contains NULL for called methods that are not within
472 the compilation unit. */
473 int Call_has_callees (ir_node *node);
474 int get_Call_n_callees (ir_node * node);
475 entity *get_Call_callee (ir_node * node, int pos);
476 /* assumes current_ir_graph set properly! */
477 void set_Call_callee_arr (ir_node * node, int n, entity ** arr);
478 void remove_Call_callee_arr(ir_node * node);
480 ir_node *get_CallBegin_ptr (ir_node *node);
481 void set_CallBegin_ptr (ir_node *node, ir_node *ptr);
482 ir_node *get_CallBegin_call (ir_node *node);
483 void set_CallBegin_call (ir_node *node, ir_node *call);
485 ir_node *get_FuncCall_ptr (ir_node *node);
486 void set_FuncCall_ptr (ir_node *node, ir_node *ptr);
487 ir_node **get_FuncCall_param_arr (ir_node *node);
488 /** Gets the number of parameters of a func call. */
489 int get_FuncCall_n_params (ir_node *node);
490 /** Gets the func call parameter at position pos. */
491 ir_node *get_FuncCall_param (ir_node *node, int pos);
492 /** Sets the func call parameter at position pos. */
493 void set_FuncCall_param (ir_node *node, int pos, ir_node *param);
494 /** Gets the type of a func call. */
495 type *get_FuncCall_type (ir_node *node);
496 /** Sets the type of a func call. */
497 void set_FuncCall_type (ir_node *node, type *tp);
498 /** Gets the arity of a func call. Identical to get_FuncCall_n_params(). */
499 int get_FuncCall_arity (ir_node *node);
501 /* Set, get and remove the callee-analysis.
502 The array is only accessible if information is valid.
503 It contains NULL for called methods that are not within
504 the compilation unit. */
505 int FuncCall_has_callees (ir_node *node);
506 int get_FuncCall_n_callees (ir_node * node);
507 entity *get_FuncCall_callee (ir_node * node, int pos);
508 /* assumes current_ir_graph set properly! */
509 void set_FuncCall_callee_arr (ir_node * node, int n, entity ** arr);
510 void remove_FuncCall_callee_arr(ir_node * node);
512 /* For unary and binary arithmetic operations the access to the
513 operands can be factored out. Left is the first, right the
514 second arithmetic value as listed in tech report 1999-44.
515 unops are: Minus, Abs, Not, Conv, Cast
516 binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
517 Shr, Shrs, Rot, Cmp */
518 int is_unop (ir_node *node);
519 ir_node *get_unop_op (ir_node *node);
520 void set_unop_op (ir_node *node, ir_node *op);
521 int is_binop (ir_node *node);
522 ir_node *get_binop_left (ir_node *node);
523 void set_binop_left (ir_node *node, ir_node *left);
524 ir_node *get_binop_right (ir_node *node);
525 void set_binop_right (ir_node *node, ir_node *right);
527 ir_node *get_Add_left (ir_node *node);
528 void set_Add_left (ir_node *node, ir_node *left);
529 ir_node *get_Add_right (ir_node *node);
530 void set_Add_right (ir_node *node, ir_node *right);
532 ir_node *get_Sub_left (ir_node *node);
533 void set_Sub_left (ir_node *node, ir_node *left);
534 ir_node *get_Sub_right (ir_node *node);
535 void set_Sub_right (ir_node *node, ir_node *right);
537 ir_node *get_Minus_op (ir_node *node);
538 void set_Minus_op (ir_node *node, ir_node *op);
540 ir_node *get_Mul_left (ir_node *node);
541 void set_Mul_left (ir_node *node, ir_node *left);
542 ir_node *get_Mul_right (ir_node *node);
543 void set_Mul_right (ir_node *node, ir_node *right);
545 ir_node *get_Quot_left (ir_node *node);
546 void set_Quot_left (ir_node *node, ir_node *left);
547 ir_node *get_Quot_right (ir_node *node);
548 void set_Quot_right (ir_node *node, ir_node *right);
549 ir_node *get_Quot_mem (ir_node *node);
550 void set_Quot_mem (ir_node *node, ir_node *mem);
553 * Projection numbers for Quot: use for Proj nodes!
556 pn_Quot_M, /**< Memory result. */
557 pn_Quot_X_except, /**< Execution result if exception occured. */
558 pn_Quot_res /**< Result of computation. */
559 } pn_Quot; /* Projection numbers for Quot. */
561 ir_node *get_DivMod_left (ir_node *node);
562 void set_DivMod_left (ir_node *node, ir_node *left);
563 ir_node *get_DivMod_right (ir_node *node);
564 void set_DivMod_right (ir_node *node, ir_node *right);
565 ir_node *get_DivMod_mem (ir_node *node);
566 void set_DivMod_mem (ir_node *node, ir_node *mem);
569 * Projection numbers for DivMod: use for Proj nodes!
572 pn_DivMod_M, /**< Memory result. */
573 pn_DivMod_X_except, /**< Execution result if exception occured. */
574 pn_DivMod_res_div, /**< Result of computation a / b. */
575 pn_DivMod_res_mod /**< Result of computation a % b. */
576 } pn_DivMod; /* Projection numbers for DivMod. */
578 ir_node *get_Div_left (ir_node *node);
579 void set_Div_left (ir_node *node, ir_node *left);
580 ir_node *get_Div_right (ir_node *node);
581 void set_Div_right (ir_node *node, ir_node *right);
582 ir_node *get_Div_mem (ir_node *node);
583 void set_Div_mem (ir_node *node, ir_node *mem);
586 * Projection numbers for Div: use for Proj nodes!
589 pn_Div_M, /**< Memory result. */
590 pn_Div_X_except, /**< Execution result if exception occured. */
591 pn_Div_res /**< Result of computation. */
592 } pn_Div; /* Projection numbers for Div. */
594 ir_node *get_Mod_left (ir_node *node);
595 void set_Mod_left (ir_node *node, ir_node *left);
596 ir_node *get_Mod_right (ir_node *node);
597 void set_Mod_right (ir_node *node, ir_node *right);
598 ir_node *get_Mod_mem (ir_node *node);
599 void set_Mod_mem (ir_node *node, ir_node *mem);
602 * Projection numbers for Mod: use for Proj nodes!
605 pn_Mod_M, /**< Memory result. */
606 pn_Mod_X_except, /**< Execution result if exception occured. */
607 pn_Mod_res /**< Result of computation. */
608 } pn_Mod; /* Projection numbers for Mod. */
610 ir_node *get_Abs_op (ir_node *node);
611 void set_Abs_op (ir_node *node, ir_node *op);
613 ir_node *get_And_left (ir_node *node);
614 void set_And_left (ir_node *node, ir_node *left);
615 ir_node *get_And_right (ir_node *node);
616 void set_And_right (ir_node *node, ir_node *right);
618 ir_node *get_Or_left (ir_node *node);
619 void set_Or_left (ir_node *node, ir_node *left);
620 ir_node *get_Or_right (ir_node *node);
621 void set_Or_right (ir_node *node, ir_node *right);
623 ir_node *get_Eor_left (ir_node *node);
624 void set_Eor_left (ir_node *node, ir_node *left);
625 ir_node *get_Eor_right (ir_node *node);
626 void set_Eor_right (ir_node *node, ir_node *right);
628 ir_node *get_Not_op (ir_node *node);
629 void set_Not_op (ir_node *node, ir_node *op);
632 * Projection numbers for Cmp are defined several times.
633 * The bit patterns are used for various tests, so don't change.
634 * The "unordered" values are possible results of comparing
635 * floating point numbers.
638 pn_Cmp_False = 0, /**< false */
639 pn_Cmp_Eq, /**< equal */
640 pn_Cmp_Lt, /**< less */
641 pn_Cmp_Le, /**< less or equal */
642 pn_Cmp_Gt, /**< greater */
643 pn_Cmp_Ge, /**< greater or equal */
644 pn_Cmp_Lg, /**< less or greater */
645 pn_Cmp_Leg = 7, /**< less, equal or greater = ordered */
646 pn_Cmp_Uo, /**< unordered */
647 pn_Cmp_Ue, /**< unordered or equal */
648 pn_Cmp_Ul, /**< unordered or less */
649 pn_Cmp_Ule, /**< unordered, less or equal */
650 pn_Cmp_Ug, /**< unordered or greater */
651 pn_Cmp_Uge, /**< unordered, greater or equal */
652 pn_Cmp_Ne, /**< unordered, less or greater = not equal */
653 pn_Cmp_True = 15 /**< true */
654 /* not_mask = Leg*/ /* bits to flip to negate comparison * @@ hack for jni interface */
655 } pn_Cmp; /* Projection numbers for Cmp */
656 /* #define not_mask pn_Cmp_Leg */
658 const char *get_pnc_string(int pnc);
659 int get_negated_pnc(int pnc);
660 ir_node *get_Cmp_left (ir_node *node);
661 void set_Cmp_left (ir_node *node, ir_node *left);
662 ir_node *get_Cmp_right (ir_node *node);
663 void set_Cmp_right (ir_node *node, ir_node *right);
665 ir_node *get_Shl_left (ir_node *node);
666 void set_Shl_left (ir_node *node, ir_node *left);
667 ir_node *get_Shl_right (ir_node *node);
668 void set_Shl_right (ir_node *node, ir_node *right);
670 ir_node *get_Shr_left (ir_node *node);
671 void set_Shr_left (ir_node *node, ir_node *left);
672 ir_node *get_Shr_right (ir_node *node);
673 void set_Shr_right (ir_node *node, ir_node *right);
675 ir_node *get_Shrs_left (ir_node *node);
676 void set_Shrs_left (ir_node *node, ir_node *left);
677 ir_node *get_Shrs_right (ir_node *node);
678 void set_Shrs_right (ir_node *node, ir_node *right);
680 ir_node *get_Rot_left (ir_node *node);
681 void set_Rot_left (ir_node *node, ir_node *left);
682 ir_node *get_Rot_right (ir_node *node);
683 void set_Rot_right (ir_node *node, ir_node *right);
685 ir_node *get_Conv_op (ir_node *node);
686 void set_Conv_op (ir_node *node, ir_node *op);
688 /* Does Cast need a mem operator?
689 * Cast should only depend on the type, not on the state of an
690 * entity. But: we initialze various fields after Alloc, that
691 * are accessed in the cast. This required some precaution, to
692 * get the right memory into the Loads generated from the cast.
694 ir_node *get_Cast_op (ir_node *node);
695 void set_Cast_op (ir_node *node, ir_node *op);
696 type *get_Cast_type (ir_node *node);
697 void set_Cast_type (ir_node *node, type *to_tp);
699 /** Returns true if n is Phi or Filter in interprocedural_view.
700 Returns false if irg in phase building and the Phi has zero
701 predecessors: it's a Phi0. */
702 int is_Phi (ir_node *n);
703 /** Returns true if irg in phase building and the Phi has zero
704 predecessors: it's a Phi0. */
705 int is_Phi0 (ir_node *n);
706 /* These routines also work for Filter nodes in interprocedural view. */
707 ir_node **get_Phi_preds_arr (ir_node *node);
708 int get_Phi_n_preds (ir_node *node);
709 ir_node *get_Phi_pred (ir_node *node, int pos);
710 void set_Phi_pred (ir_node *node, int pos, ir_node *pred);
712 ir_node *get_Filter_pred(ir_node *node);
713 void set_Filter_pred(ir_node *node, ir_node *pred);
714 long get_Filter_proj(ir_node *node);
715 void set_Filter_proj(ir_node *node, long proj);
716 /* set the interprocedural predecessors, ...d_arr uses current_ir_graph.
717 * @@@ Maybe better: arity is zero if no cg preds. */
718 void set_Filter_cg_pred_arr(ir_node * node, int arity, ir_node ** in);
719 void set_Filter_cg_pred(ir_node * node, int pos, ir_node * pred);
720 int get_Filter_n_cg_preds(ir_node *node);
721 ir_node *get_Filter_cg_pred(ir_node *node, int pos);
724 * Projection numbers for Load: use for Proj nodes!
727 pn_Load_M, /**< Memory result. */
728 pn_Load_X_except, /**< Execution result if exception occured. */
729 pn_Load_res /**< Result of load operation. */
730 } pn_Load; /* Projection numbers for Load. */
732 ir_node *get_Load_mem (ir_node *node);
733 void set_Load_mem (ir_node *node, ir_node *mem);
734 ir_node *get_Load_ptr (ir_node *node);
735 void set_Load_ptr (ir_node *node, ir_node *ptr);
738 * Projection numbers for Store: use for Proj nodes!
741 pn_Store_M, /**< Memory result. */
742 pn_Store_X_except /**< Execution result if exception occured. */
743 } pn_Store; /* Projection numbers for Store. */
745 ir_node *get_Store_mem (ir_node *node);
746 void set_Store_mem (ir_node *node, ir_node *mem);
747 ir_node *get_Store_ptr (ir_node *node);
748 void set_Store_ptr (ir_node *node, ir_node *ptr);
749 ir_node *get_Store_value (ir_node *node);
750 void set_Store_value (ir_node *node, ir_node *value);
753 * Projection numbers for Alloc: use for Proj nodes!
756 pn_Alloc_M, /**< Memory result. */
757 pn_Alloc_X_except, /**< Execution result if exception occured. */
758 pn_Alloc_res /**< Result of allocation. */
759 } pn_Alloc; /* Projection numbers for Alloc. */
761 ir_node *get_Alloc_mem (ir_node *node);
762 void set_Alloc_mem (ir_node *node, ir_node *mem);
763 ir_node *get_Alloc_size (ir_node *node);
764 void set_Alloc_size (ir_node *node, ir_node *size);
765 type *get_Alloc_type (ir_node *node);
766 void set_Alloc_type (ir_node *node, type *tp);
768 /** The allocation place. */
770 stack_alloc, /**< Alloc allocates the object on the stack. */
771 heap_alloc /**< Alloc allocates the object on the heap. */
774 where_alloc get_Alloc_where (ir_node *node);
775 void set_Alloc_where (ir_node *node, where_alloc where);
777 ir_node *get_Free_mem (ir_node *node);
778 void set_Free_mem (ir_node *node, ir_node *mem);
779 ir_node *get_Free_ptr (ir_node *node);
780 void set_Free_ptr (ir_node *node, ir_node *ptr);
781 ir_node *get_Free_size (ir_node *node);
782 void set_Free_size (ir_node *node, ir_node *size);
783 type *get_Free_type (ir_node *node);
784 void set_Free_type (ir_node *node, type *tp);
786 ir_node **get_Sync_preds_arr (ir_node *node);
787 int get_Sync_n_preds (ir_node *node);
788 ir_node *get_Sync_pred (ir_node *node, int pos);
789 void set_Sync_pred (ir_node *node, int pos, ir_node *pred);
791 ir_node *get_Proj_pred (ir_node *node);
792 void set_Proj_pred (ir_node *node, ir_node *pred);
793 long get_Proj_proj (ir_node *node);
794 void set_Proj_proj (ir_node *node, long proj);
796 ir_node **get_Tuple_preds_arr (ir_node *node);
797 int get_Tuple_n_preds (ir_node *node);
798 ir_node *get_Tuple_pred (ir_node *node, int pos);
799 void set_Tuple_pred (ir_node *node, int pos, ir_node *pred);
801 ir_node *get_Id_pred (ir_node *node);
802 void set_Id_pred (ir_node *node, ir_node *pred);
804 /** Confirm has a single result and returns 'value' unchanged.
805 * The node expresses a restriction on 'value':
806 * 'value' 'cmp' 'bound' == true. */
807 ir_node *get_Confirm_value (ir_node *node);
808 void set_Confirm_value (ir_node *node, ir_node *value);
809 ir_node *get_Confirm_bound (ir_node *node);
810 void set_Confirm_bound (ir_node *node, ir_node *bound);
811 pn_Cmp get_Confirm_cmp (ir_node *node);
812 void set_Confirm_cmp (ir_node *node, pn_Cmp cmp);
816 * NAME Auxiliary routines
818 * Not properly documented ;-)
822 /** returns operand of node if node is a Proj. */
823 ir_node *skip_Proj (ir_node *node);
824 /** returns operand of node if node is a Id */
825 ir_node *skip_Id (ir_node *node); /* Same as skip_nop. */
826 /* returns corresponding operand of Tuple if node is a Proj from
828 ir_node *skip_Tuple (ir_node *node);
829 /** returns operand of node if node is a Cast */
830 ir_node *skip_Cast (ir_node *node);
831 /** returns true if node is a Bad node. */
832 int is_Bad (ir_node *node);
833 /** returns true if the node is not a Block */
834 int is_no_Block (ir_node *node);
835 /** returns true if the node is a Block */
836 int is_Block (ir_node *node);
837 /** returns true if node is a Unknown node. */
838 int is_Unknown (ir_node *node);
839 /** returns true if node is a Proj node or a Filter node in
840 * intraprocedural view */
841 int is_Proj (const ir_node *node);
842 /** Returns true if the operation manipulates control flow:
843 Start, End, Jmp, Cond, Return, Raise, Bad, CallBegin, EndReg, EndExcept */
844 int is_cfop(ir_node *node);
846 /** Returns true if the operation manipulates interprocedural control flow:
847 CallBegin, EndReg, EndExcept */
848 int is_ip_cfop(ir_node *node);
849 /** Returns true if the operation can change the control flow because
850 of an exception: Call, Quot, DivMod, Div, Mod, Load, Store, Alloc,
852 int is_fragile_op(ir_node *node);
853 /** Returns the memory operand of fragile operations. */
854 ir_node *get_fragile_op_mem(ir_node *node);
856 /*-----------------------------------------------------------------*/
858 /*-----------------------------------------------------------------*/
861 /** Debug print the node.
863 * Writes the node, all its attributes and the predecessors to stdout if DEBUG_libfirm
864 * is set. Else does nothing. */
865 void dump_irn(ir_node *n);
870 /* GNU C has the __FUNCTION__ extension */
871 #define __MYFUNC__ __FUNCTION__
873 /* use Filename instead */
874 #define __MYFUNC__ __FILE__
878 Don't format with "\", firmjni gets problems */
879 /** Output location */
880 #define DDM printf("%s(l.%i).\n", __MYFUNC__, __LINE__);
881 /** Output the firm kind of the node */
882 #define DDMK(X) printf("%s(l.%i) %s: %p\n", __MYFUNC__, __LINE__, print_firm_kind(X), (void *)(X));
883 /** Output information about a node */
884 #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))
885 /** Output information about a node and its block */
886 #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)))
887 /** Output information about a type */
888 #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))
889 /** Output information about an entity */
890 #define DDME(X) printf("%s(l.%i) %s: %ld (%p)\n", __MYFUNC__, __LINE__, get_entity_name(X), get_entity_nr(X), (void *)(X))
891 /** Output information about an entity and its type */
892 #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))
893 /** Output information about an entity and its owner */
894 #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))
895 /** Output information about a graph */
896 #define DDMG(X) printf("%s(l.%i) %s: %ld (%p)\n", __MYFUNC__, __LINE__, get_entity_name(get_irg_entity(X)), get_irg_graph_nr(X), (void *)(X))
897 /** Output information about an ident */
898 #define DDMI(X) printf("%s(l.%i) %s: %p\n", __MYFUNC__, __LINE__, get_id_str(X), (void *)(X))
899 /** Output information about a mode */
900 #define DDMM(X) printf("%s(l.%i) %s: %p\n", __MYFUNC__, __LINE__, get_mode_name(X), (void *)(X))
901 /** Output information about a loop */
902 #define DDML(X) printf("%s(l.%i) loop with depth %d: %d\n", __MYFUNC__, __LINE__, get_loop_depth(X), get_loop_loop_nr(X))
903 /** Output information about a tarVal */
904 #define DDMV(X) printf("%s(l.%i) tarval: ",__MYFUNC__, __LINE__); tarval_printf(X); printf(" (%p)\n", (void *)(X));
906 /*@}*/ /* end of ir_node group definition */
913 # endif /* _IRNODE_H_ */