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;
90 * you can work on the graph without considering the different types
91 * of nodes, it's just a big graph.
95 * Checks whether a pointer points to a ir node.
97 * @param thing an arbitrary pointer
100 * true if the thing is a ir mode, else false
103 is_ir_node (const void *thing);
105 /** returns the number of predecessors without the block predecessor: */
106 int get_irn_arity (const ir_node *node);
107 int get_irn_intra_arity (const ir_node *node);
108 int get_irn_inter_arity (const ir_node *node);
110 /** Replaces the old in array by a new one that will contain the ins given in
111 the parameters. Conserves the block predecessor. It copies the array passed.
112 This function is necessary to adjust in arrays of blocks, calls and phis.
113 Assumes that current_ir_graph is set to the graph containing "node".
114 "in" must contain all predecessors except the block that are required for
116 void set_irn_in (ir_node *node, int arity,
118 /* to iterate through the predecessors without touching the array. No
119 order of predecessors guaranteed.
120 To iterate over the operands iterate from 0 to i < get_irn_arity(),
121 to iterate including the Block predecessor iterate from i = -1 to
122 i < get_irn_arity. */
123 /* Access predecessor n */
124 /* get_irn_n removes Id predecessors. */
125 ir_node *get_irn_n (ir_node *node, int n);
126 ir_node *get_irn_intra_n (ir_node *node, int n);
127 ir_node *get_irn_inter_n (ir_node *node, int n);
128 void set_irn_n (ir_node *node, int n, ir_node *in);
129 /** Sets the mode struct of node */
130 void set_irn_mode (ir_node *node, ir_mode *mode);
131 /** Gets the mode struct. */
132 ir_mode *get_irn_mode (const ir_node *node);
133 /** Gets the mode-enum modecode. */
134 modecode get_irn_modecode (const ir_node *node);
135 /** Gets the ident for a string representation of the mode .*/
136 ident *get_irn_modeident (const ir_node *node);
137 /** Gets the string representation of the mode .*/
138 const char *get_irn_modename (const ir_node *node);
139 /** Gets the opcode struct of the node */
140 ir_op *get_irn_op (const ir_node *node);
141 /** Sets the opcode struct of the node. */
142 void set_irn_op (ir_node *node, ir_op *op);
143 /** Gets the opcode-enum of the node. */
144 opcode get_irn_opcode (const ir_node *node);
145 /** Get the string representation of the opcode. */
146 const char *get_irn_opname (const ir_node *node);
147 /** Get the ident for a string representation of the opcode. */
148 ident *get_irn_opident (const ir_node *node);
149 unsigned long get_irn_visited (const ir_node *node);
150 void set_irn_visited (ir_node *node, unsigned long visited);
151 /** Sets visited to get_irg_visited(current_ir_graph). */
152 void mark_irn_visited (ir_node *node);
153 /** Returns 1 if visited < get_irg_visited(current_ir_graph). */
154 int irn_not_visited (const ir_node *node);
155 /** Returns 1 if visited >= get_irg_visited(current_ir_graph). */
156 int irn_visited (const ir_node *node);
157 void set_irn_link (ir_node *node, void *link);
158 void *get_irn_link (const ir_node *node);
160 /** Returns the ir_graph this node belongs to. Only valid if irg
161 * is in state pinned (irg is only stored in the block. */
162 ir_graph *get_irn_irg (ir_node *node);
164 /** Outputs a unique number for this node if libFIRM is compiled for
165 debugging, (configure with --enable-debug) else returns address
166 of node cast to long. */
167 long get_irn_node_nr (const ir_node *node);
171 * irnode constructor.
172 * Create a new irnode in irg, with an op, mode, arity and
173 * some incoming irnodes.
174 * This constructor is used in every specified irnode constructor.
176 * @param db Debug info.
177 * @param irg IR-graph on with this new node should be constructed.
178 * @param op The opcode of the new node.
179 * @param mode The mode of the new node.
180 * @param arity The arity of the new node, may be <0 if yet.
181 * @param in An array of arity predecessor nodes.
184 new_ir_node (dbg_info *db,
194 * NAME access functions for node fields.
196 * Not properly documented ;-)
200 /** This works for all except Block. To express the difference to
201 * access routines that work for all nodes we use infix "nodes" and do not
202 * name this function get_irn_block. */
203 #define get_nodes_block get_nodes_Block
204 ir_node *get_nodes_Block (ir_node *node);
205 #define set_nodes_block set_nodes_Block
206 void set_nodes_Block (ir_node *node, ir_node *block);
209 * @function get_irn_block
210 * @see get_nodes_block
214 * Projection numbers for result of Start node: use for Proj nodes!
217 pn_Start_X_initial_exec, /**< Projection on the initial control flow. */
218 pn_Start_M, /**< Projection on the initial memory. */
219 pn_Start_P_frame_base, /**< Projection on the frame base pointer. */
220 pn_Start_P_globals, /**< Projection on the pointer to the data segment
221 containing _all_ global entities. */
222 pn_Start_T_args, /**< Projection on all arguments. */
223 pn_Start_P_value_arg_base /**< Pointer to region of compound value arguments as defined by
224 type of this method. */
225 } pn_Start; /* Projection numbers for Start. */
228 * Projection numbers for result of Start node: use for Proj nodes!
229 * @remark This is the old name convention, don't use anymore.
232 pns_initial_exec, /**< Projection on an executable, the initial control
234 pns_global_store, /**< Projection on the global store */
235 pns_frame_base, /**< Projection on the frame base */
236 pns_globals, /**< Projection on the pointer to the data segment
237 containing _all_ global entities. */
238 pns_args, /**< Projection on all arguments */
239 pns_value_arg_base /**< Pointer to region of compound value arguments as defined by
240 type of this method. */
241 } pns_number; /* pns: Projection Number Start */
243 /** Test whether arbitrary node is frame pointer.
245 * Test whether arbitrary node is frame pointer, i.e. Proj(pn_Start_P_frame_base)
246 * from Start. If so returns frame type, else Null. */
247 type *is_frame_pointer(ir_node *n);
249 /** Test whether arbitrary node is globals pointer.
251 * Test whether arbitrary node is globals pointer, i.e. Proj(pn_Start_P_globals)
252 * from Start. If so returns global type, else Null. */
253 type *is_globals_pointer(ir_node *n);
255 /** Test whether arbitrary node is value arg base.
257 * Test whether arbitrary node is value arg base, i.e. Proj(pn_Start_P_value_arg_base)
258 * from Start. If so returns 1, else 0. */
259 int is_value_arg_pointer(ir_node *n);
262 /* @@@ no more supported */
263 ir_node **get_Block_cfgpred_arr (ir_node *node);
264 int get_Block_n_cfgpreds (ir_node *node);
265 ir_node *get_Block_cfgpred (ir_node *node, int pos);
266 void set_Block_cfgpred (ir_node *node, int pos, ir_node *pred);
267 bool get_Block_matured (ir_node *node);
268 void set_Block_matured (ir_node *node, bool matured);
269 unsigned long get_Block_block_visited (ir_node *node);
270 void set_Block_block_visited (ir_node *node, unsigned long visit);
271 /* For this current_ir_graph must be set. */
272 void mark_Block_block_visited(ir_node *node);
273 int Block_not_block_visited(ir_node *node);
275 /* Set and remove interprocedural predecessors. If the interprocedural
276 * predecessors are removed, the node has the same predecessors in
278 * @@@ Maybe better: arity is zero if no cg preds. */
279 void set_Block_cg_cfgpred_arr(ir_node * node, int arity, ir_node ** in);
280 void set_Block_cg_cfgpred(ir_node * node, int pos, ir_node * pred);
281 /* @@@ not supported */
282 ir_node **get_Block_cg_cfgpred_arr(ir_node * node);
283 /* Returns the number of interprocedural predecessors. 0 if none. */
284 int get_Block_cg_n_cfgpreds(ir_node * node);
285 ir_node *get_Block_cg_cfgpred(ir_node * node, int pos);
286 /* frees the memory. */
287 void remove_Block_cg_cfgpred_arr(ir_node * node);
289 /* Start references the irg it is in.
290 @@@ old -- use get_irn_irg instead! */
291 ir_graph *get_Start_irg(ir_node *node);
293 int get_End_n_keepalives(ir_node *end);
294 ir_node *get_End_keepalive(ir_node *end, int pos);
295 void add_End_keepalive (ir_node *end, ir_node *ka);
296 void set_End_keepalive(ir_node *end, int pos, ir_node *ka);
297 /* Some parts of the End node are allocated separately -- their memory
298 is not recovered by dead_node_elimination if a End node is dead.
299 free_End frees these data structures. */
300 void free_End (ir_node *end);
302 /* @@@ old -- use get_irn_irg instead! */
303 ir_graph *get_EndReg_irg (ir_node *end);
304 ir_graph *get_EndExcept_irg (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
379 type_tag, /**< The SymConst is a type tag for the given type.
380 Type_or_id_p is type *. */
381 size, /**< The SymConst is the size of the given type.
382 Type_or_id_p is type *. */
383 linkage_ptr_info /**< The SymConst is a symbolic pointer to be filled in
384 by the linker. Type_or_id_p is ident *. */
387 typedef union type_or_id * type_or_id_p;
388 symconst_kind get_SymConst_kind (const ir_node *node);
389 void set_SymConst_kind (ir_node *node, symconst_kind num);
390 /* Only to access SymConst of kind type_tag or size. Else assertion: */
391 type *get_SymConst_type (ir_node *node);
392 void set_SymConst_type (ir_node *node, type *tp);
393 /* Only to access SymConst of kind linkage_ptr_info. Else assertion: */
394 ident *get_SymConst_ptrinfo (ir_node *node);
395 void set_SymConst_ptrinfo (ir_node *node, ident *ptrinfo);
396 /* Sets both: type and ptrinfo. Needed to treat the node independent of
397 its semantics. Does a memcpy for the memory tori points to. */
398 type_or_id_p get_SymConst_type_or_id (ir_node *node);
399 void set_SymConst_type_or_id (ir_node *node, type_or_id_p tori);
401 ir_node *get_Sel_mem (ir_node *node);
402 void set_Sel_mem (ir_node *node, ir_node *mem);
403 ir_node *get_Sel_ptr (ir_node *node); /* ptr to the object to select from */
404 void set_Sel_ptr (ir_node *node, ir_node *ptr);
405 ir_node **get_Sel_index_arr (ir_node *node);
406 int get_Sel_n_indexs (ir_node *node);
407 ir_node *get_Sel_index (ir_node *node, int pos);
408 void set_Sel_index (ir_node *node, int pos, ir_node *index);
409 entity *get_Sel_entity (ir_node *node); /* entity to select */
410 void set_Sel_entity (ir_node *node, entity *ent);
413 * Projection numbers for result of Call node: use for Proj nodes!
415 * @remark old name convention!
418 pncl_memory = 0, /**< The memory result. */
419 pncl_exc_target = 1, /**< The control flow result branching to the exception handler */
420 pncl_result_tuple = 2, /**< The tuple containing all (0, 1, 2, ...) results */
421 pncl_exc_memory = 3, /**< The memory result in case the called method terminated with
423 pncl_value_res_base = 4 /**< A pointer to the memory region containing copied results
424 passed by value (for compound result types). */
425 } pncl_number; /* pncl: Projection Number CaLl */
428 * Projection numbers for result of Call node: use for Proj nodes!
431 pn_Call_M_regular = 0, /**< The memory result. */
432 pn_Call_T_result = 2, /**< The tuple containing all (0, 1, 2, ...) results */
433 pn_Call_P_value_res_base = 4,/**< A pointer to the memory region containing copied results
434 passed by value (for compound result types). */
435 pn_Call_X_except = 1, /**< The control flow result branching to the exception handler */
436 pn_Call_M_except = 3 /**< The memory result in case the called method terminated with
438 } pn_Call; /* Projection numbers for Call. */
440 ir_node *get_Call_mem (ir_node *node);
441 void set_Call_mem (ir_node *node, ir_node *mem);
442 ir_node *get_Call_ptr (ir_node *node);
443 void set_Call_ptr (ir_node *node, ir_node *ptr);
444 ir_node **get_Call_param_arr (ir_node *node);
445 /** Gets the number of parameters of a call. */
446 int get_Call_n_params (ir_node *node);
447 /** Gets the call parameter at position pos. */
448 ir_node *get_Call_param (ir_node *node, int pos);
449 /** Sets the call parameter at position pos. */
450 void set_Call_param (ir_node *node, int pos, ir_node *param);
451 /** Gets the type of a call. */
452 type *get_Call_type (ir_node *node);
453 /** Sets the type of a call. */
454 void set_Call_type (ir_node *node, type *tp);
455 /** Gets the arity of a call. Identical to get_Call_n_params(). */
456 int get_Call_arity (ir_node *node);
458 /* Set, get and remove the callee-analysis.
459 The array is only accessible if information is valid.
460 It contains NULL for called methods that are not within
461 the compilation unit. */
462 int Call_has_callees (ir_node *node);
463 int get_Call_n_callees (ir_node * node);
464 entity *get_Call_callee (ir_node * node, int pos);
465 /* assumes current_ir_graph set properly! */
466 void set_Call_callee_arr (ir_node * node, int n, entity ** arr);
467 void remove_Call_callee_arr(ir_node * node);
469 ir_node *get_CallBegin_ptr (ir_node *node);
470 void set_CallBegin_ptr (ir_node *node, ir_node *ptr);
471 /* @@@ old -- use get_irn_irg instead! */
472 ir_graph *get_CallBegin_irg (ir_node *node);
473 ir_node *get_CallBegin_call (ir_node *node);
474 void set_CallBegin_call (ir_node *node, ir_node *call);
476 ir_node *get_FuncCall_ptr (ir_node *node);
477 void set_FuncCall_ptr (ir_node *node, ir_node *ptr);
478 ir_node **get_FuncCall_param_arr (ir_node *node);
479 /** Gets the number of parameters of a func call. */
480 int get_FuncCall_n_params (ir_node *node);
481 /** Gets the func call parameter at position pos. */
482 ir_node *get_FuncCall_param (ir_node *node, int pos);
483 /** Sets the func call parameter at position pos. */
484 void set_FuncCall_param (ir_node *node, int pos, ir_node *param);
485 /** Gets the type of a func call. */
486 type *get_FuncCall_type (ir_node *node);
487 /** Sets the type of a func call. */
488 void set_FuncCall_type (ir_node *node, type *tp);
489 /** Gets the arity of a func call. Identical to get_FuncCall_n_params(). */
490 int get_FuncCall_arity (ir_node *node);
492 /* Set, get and remove the callee-analysis.
493 The array is only accessible if information is valid.
494 It contains NULL for called methods that are not within
495 the compilation unit. */
496 int FuncCall_has_callees (ir_node *node);
497 int get_FuncCall_n_callees (ir_node * node);
498 entity *get_FuncCall_callee (ir_node * node, int pos);
499 /* assumes current_ir_graph set properly! */
500 void set_FuncCall_callee_arr (ir_node * node, int n, entity ** arr);
501 void remove_FuncCall_callee_arr(ir_node * node);
503 /* For unary and binary arithmetic operations the access to the
504 operands can be factored out. Left is the first, right the
505 second arithmetic value as listed in tech report 1999-44.
506 unops are: Minus, Abs, Not, Conv, Cast
507 binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
508 Shr, Shrs, Rot, Cmp */
509 int is_unop (ir_node *node);
510 ir_node *get_unop_op (ir_node *node);
511 void set_unop_op (ir_node *node, ir_node *op);
512 int is_binop (ir_node *node);
513 ir_node *get_binop_left (ir_node *node);
514 void set_binop_left (ir_node *node, ir_node *left);
515 ir_node *get_binop_right (ir_node *node);
516 void set_binop_right (ir_node *node, ir_node *right);
518 ir_node *get_Add_left (ir_node *node);
519 void set_Add_left (ir_node *node, ir_node *left);
520 ir_node *get_Add_right (ir_node *node);
521 void set_Add_right (ir_node *node, ir_node *right);
523 ir_node *get_Sub_left (ir_node *node);
524 void set_Sub_left (ir_node *node, ir_node *left);
525 ir_node *get_Sub_right (ir_node *node);
526 void set_Sub_right (ir_node *node, ir_node *right);
528 ir_node *get_Minus_op (ir_node *node);
529 void set_Minus_op (ir_node *node, ir_node *op);
531 ir_node *get_Mul_left (ir_node *node);
532 void set_Mul_left (ir_node *node, ir_node *left);
533 ir_node *get_Mul_right (ir_node *node);
534 void set_Mul_right (ir_node *node, ir_node *right);
536 ir_node *get_Quot_left (ir_node *node);
537 void set_Quot_left (ir_node *node, ir_node *left);
538 ir_node *get_Quot_right (ir_node *node);
539 void set_Quot_right (ir_node *node, ir_node *right);
540 ir_node *get_Quot_mem (ir_node *node);
541 void set_Quot_mem (ir_node *node, ir_node *mem);
544 * Projection numbers for Quot: use for Proj nodes!
547 pn_Quot_M, /**< Memory result. */
548 pn_Quot_X_except, /**< Execution result if exception occured. */
549 pn_Quot_res /**< Result of computation. */
550 } pn_Quot; /* Projection numbers for Quot. */
552 ir_node *get_DivMod_left (ir_node *node);
553 void set_DivMod_left (ir_node *node, ir_node *left);
554 ir_node *get_DivMod_right (ir_node *node);
555 void set_DivMod_right (ir_node *node, ir_node *right);
556 ir_node *get_DivMod_mem (ir_node *node);
557 void set_DivMod_mem (ir_node *node, ir_node *mem);
560 * Projection numbers for DivMod: use for Proj nodes!
563 pn_DivMod_M, /**< Memory result. */
564 pn_DivMod_X_except, /**< Execution result if exception occured. */
565 pn_DivMod_res_div, /**< Result of computation a / b. */
566 pn_DivMod_res_mod /**< Result of computation a % b. */
567 } pn_DivMod; /* Projection numbers for DivMod. */
569 ir_node *get_Div_left (ir_node *node);
570 void set_Div_left (ir_node *node, ir_node *left);
571 ir_node *get_Div_right (ir_node *node);
572 void set_Div_right (ir_node *node, ir_node *right);
573 ir_node *get_Div_mem (ir_node *node);
574 void set_Div_mem (ir_node *node, ir_node *mem);
577 * Projection numbers for Div: use for Proj nodes!
580 pn_Div_M, /**< Memory result. */
581 pn_Div_X_except, /**< Execution result if exception occured. */
582 pn_Div_res /**< Result of computation. */
583 } pn_Div; /* Projection numbers for Div. */
585 ir_node *get_Mod_left (ir_node *node);
586 void set_Mod_left (ir_node *node, ir_node *left);
587 ir_node *get_Mod_right (ir_node *node);
588 void set_Mod_right (ir_node *node, ir_node *right);
589 ir_node *get_Mod_mem (ir_node *node);
590 void set_Mod_mem (ir_node *node, ir_node *mem);
593 * Projection numbers for Mod: use for Proj nodes!
596 pn_Mod_M, /**< Memory result. */
597 pn_Mod_X_except, /**< Execution result if exception occured. */
598 pn_Mod_res /**< Result of computation. */
599 } pn_Mod; /* Projection numbers for Mod. */
601 ir_node *get_Abs_op (ir_node *node);
602 void set_Abs_op (ir_node *node, ir_node *op);
604 ir_node *get_And_left (ir_node *node);
605 void set_And_left (ir_node *node, ir_node *left);
606 ir_node *get_And_right (ir_node *node);
607 void set_And_right (ir_node *node, ir_node *right);
609 ir_node *get_Or_left (ir_node *node);
610 void set_Or_left (ir_node *node, ir_node *left);
611 ir_node *get_Or_right (ir_node *node);
612 void set_Or_right (ir_node *node, ir_node *right);
614 ir_node *get_Eor_left (ir_node *node);
615 void set_Eor_left (ir_node *node, ir_node *left);
616 ir_node *get_Eor_right (ir_node *node);
617 void set_Eor_right (ir_node *node, ir_node *right);
619 ir_node *get_Not_op (ir_node *node);
620 void set_Not_op (ir_node *node, ir_node *op);
623 * Projection numbers for Cmp are defined several times.
624 * The bit patterns are used for various tests, so don't change.
625 * The "unordered" values are possible results of comparing
626 * floating point numbers.
629 pn_Cmp_False = 0, /**< false */
630 pn_Cmp_Eq, /**< equal */
631 pn_Cmp_Lt, /**< less */
632 pn_Cmp_Le, /**< less or equal */
633 pn_Cmp_Gt, /**< greater */
634 pn_Cmp_Ge, /**< greater or equal */
635 pn_Cmp_Lg, /**< less or greater */
636 pn_Cmp_Leg = 7, /**< less, equal or greater = ordered */
637 pn_Cmp_Uo, /**< unordered */
638 pn_Cmp_Ue, /**< unordered or equal */
639 pn_Cmp_Ul, /**< unordered or less */
640 pn_Cmp_Ule, /**< unordered, less or equal */
641 pn_Cmp_Ug, /**< unordered or greater */
642 pn_Cmp_Uge, /**< unordered, greater or equal */
643 pn_Cmp_Ne, /**< unordered, less or greater = not equal */
644 pn_Cmp_True = 15 /**< true */
645 /* not_mask = Leg*/ /* bits to flip to negate comparison * @@ hack for jni interface */
646 } pn_Cmp; /* Projection numbers for Cmp */
647 /* #define not_mask pn_Cmp_Leg */
649 const char *get_pnc_string(int pnc);
650 int get_negated_pnc(int pnc);
651 ir_node *get_Cmp_left (ir_node *node);
652 void set_Cmp_left (ir_node *node, ir_node *left);
653 ir_node *get_Cmp_right (ir_node *node);
654 void set_Cmp_right (ir_node *node, ir_node *right);
656 ir_node *get_Shl_left (ir_node *node);
657 void set_Shl_left (ir_node *node, ir_node *left);
658 ir_node *get_Shl_right (ir_node *node);
659 void set_Shl_right (ir_node *node, ir_node *right);
661 ir_node *get_Shr_left (ir_node *node);
662 void set_Shr_left (ir_node *node, ir_node *left);
663 ir_node *get_Shr_right (ir_node *node);
664 void set_Shr_right (ir_node *node, ir_node *right);
666 ir_node *get_Shrs_left (ir_node *node);
667 void set_Shrs_left (ir_node *node, ir_node *left);
668 ir_node *get_Shrs_right (ir_node *node);
669 void set_Shrs_right (ir_node *node, ir_node *right);
671 ir_node *get_Rot_left (ir_node *node);
672 void set_Rot_left (ir_node *node, ir_node *left);
673 ir_node *get_Rot_right (ir_node *node);
674 void set_Rot_right (ir_node *node, ir_node *right);
676 ir_node *get_Conv_op (ir_node *node);
677 void set_Conv_op (ir_node *node, ir_node *op);
679 /* Does Cast need a mem operator?
680 * Cast should only depend on the type, not on the state of an
681 * entity. But: we initialze various fields after Alloc, that
682 * are accessed in the cast. This required some precaution, to
683 * get the right memory into the Loads generated from the cast.
685 ir_node *get_Cast_op (ir_node *node);
686 void set_Cast_op (ir_node *node, ir_node *op);
687 type *get_Cast_type (ir_node *node);
688 void set_Cast_type (ir_node *node, type *to_tp);
690 /* Returns true if n is Phi or Filter in interprocedural_view. */
691 int is_Phi (ir_node *n);
692 /* These routines also work for Filter nodes in interprocedural view. */
693 ir_node **get_Phi_preds_arr (ir_node *node);
694 int get_Phi_n_preds (ir_node *node);
695 ir_node *get_Phi_pred (ir_node *node, int pos);
696 void set_Phi_pred (ir_node *node, int pos, ir_node *pred);
698 ir_node *get_Filter_pred(ir_node *node);
699 void set_Filter_pred(ir_node *node, ir_node *pred);
700 long get_Filter_proj(ir_node *node);
701 void set_Filter_proj(ir_node *node, long proj);
702 /* set the interprocedural predecessors, ...d_arr uses current_ir_graph.
703 * @@@ Maybe better: arity is zero if no cg preds. */
704 void set_Filter_cg_pred_arr(ir_node * node, int arity, ir_node ** in);
705 void set_Filter_cg_pred(ir_node * node, int pos, ir_node * pred);
706 int get_Filter_n_cg_preds(ir_node *node);
707 ir_node * get_Filter_cg_pred(ir_node *node, int pos);
710 * Projection numbers for Load: use for Proj nodes!
713 pn_Load_M, /**< Memory result. */
714 pn_Load_X_except, /**< Execution result if exception occured. */
715 pn_Load_res /**< Result of load operation. */
716 } pn_Load; /* Projection numbers for Load. */
718 ir_node *get_Load_mem (ir_node *node);
719 void set_Load_mem (ir_node *node, ir_node *mem);
720 ir_node *get_Load_ptr (ir_node *node);
721 void set_Load_ptr (ir_node *node, ir_node *ptr);
724 * Projection numbers for Store: use for Proj nodes!
727 pn_Store_M, /**< Memory result. */
728 pn_Store_X_except /**< Execution result if exception occured. */
729 } pn_Store; /* Projection numbers for Store. */
731 ir_node *get_Store_mem (ir_node *node);
732 void set_Store_mem (ir_node *node, ir_node *mem);
733 ir_node *get_Store_ptr (ir_node *node);
734 void set_Store_ptr (ir_node *node, ir_node *ptr);
735 ir_node *get_Store_value (ir_node *node);
736 void set_Store_value (ir_node *node, ir_node *value);
739 * Projection numbers for Alloc: use for Proj nodes!
742 pn_Alloc_M, /**< Memory result. */
743 pn_Alloc_X_except, /**< Execution result if exception occured. */
744 pn_Alloc_res /**< Result of allocation. */
745 } pn_Alloc; /* Projection numbers for Alloc. */
747 ir_node *get_Alloc_mem (ir_node *node);
748 void set_Alloc_mem (ir_node *node, ir_node *mem);
749 ir_node *get_Alloc_size (ir_node *node);
750 void set_Alloc_size (ir_node *node, ir_node *size);
751 type *get_Alloc_type (ir_node *node);
752 void set_Alloc_type (ir_node *node, type *tp);
754 /** The allocation place. */
756 stack_alloc, /**< Alloc allocates the object on the stack. */
757 heap_alloc /**< Alloc allocates the object on the heap. */
760 where_alloc get_Alloc_where (ir_node *node);
761 void set_Alloc_where (ir_node *node, where_alloc where);
763 ir_node *get_Free_mem (ir_node *node);
764 void set_Free_mem (ir_node *node, ir_node *mem);
765 ir_node *get_Free_ptr (ir_node *node);
766 void set_Free_ptr (ir_node *node, ir_node *ptr);
767 ir_node *get_Free_size (ir_node *node);
768 void set_Free_size (ir_node *node, ir_node *size);
769 type *get_Free_type (ir_node *node);
770 void set_Free_type (ir_node *node, type *tp);
772 ir_node **get_Sync_preds_arr (ir_node *node);
773 int get_Sync_n_preds (ir_node *node);
774 ir_node *get_Sync_pred (ir_node *node, int pos);
775 void set_Sync_pred (ir_node *node, int pos, ir_node *pred);
777 ir_node *get_Proj_pred (ir_node *node);
778 void set_Proj_pred (ir_node *node, ir_node *pred);
779 /* Why long? shouldn't int be enough, and smaller? Or even byte? */
780 long get_Proj_proj (ir_node *node);
781 void set_Proj_proj (ir_node *node, long proj);
783 ir_node **get_Tuple_preds_arr (ir_node *node);
784 int get_Tuple_n_preds (ir_node *node);
785 ir_node *get_Tuple_pred (ir_node *node, int pos);
786 void set_Tuple_pred (ir_node *node, int pos, ir_node *pred);
788 ir_node *get_Id_pred (ir_node *node);
789 void set_Id_pred (ir_node *node, ir_node *pred);
791 /** Confirm has a single result and returns 'value' unchanged.
792 * The node expresses a restriction on 'value':
793 * 'value' 'cmp' 'bound' == true. */
794 ir_node *get_Confirm_value (ir_node *node);
795 void set_Confirm_value (ir_node *node, ir_node *value);
796 ir_node *get_Confirm_bound (ir_node *node);
797 void set_Confirm_bound (ir_node *node, ir_node *bound);
798 pn_Cmp get_Confirm_cmp (ir_node *node);
799 void set_Confirm_cmp (ir_node *node, pn_Cmp cmp);
803 * NAME Auxiliary routines
805 * Not properly documented ;-)
809 /** returns operand of node if node is a Proj. */
810 ir_node *skip_Proj (ir_node *node);
811 /** returns operand of node if node is a Id */
812 ir_node *skip_nop (ir_node *node);
813 ir_node *skip_Id (ir_node *node); /* Same as skip_nop. */
814 /* returns corresponding operand of Tuple if node is a Proj from
816 ir_node *skip_Tuple (ir_node *node);
817 /** returns operand of node if node is a Cast */
818 ir_node *skip_Cast (ir_node *node);
819 /** returns true if node is a Bad node. */
820 int is_Bad (ir_node *node);
821 /** returns true if the node is not a Block */
822 int is_no_Block (ir_node *node);
823 /** returns true if the node is a Block */
824 int is_Block (ir_node *node);
825 /** returns true if node is a Unknown node. */
826 int is_Unknown (ir_node *node);
827 /** returns true if node is a Proj node or a Filter node in
828 * intraprocedural view */
829 int is_Proj (const ir_node *node);
830 /** Returns true if the operation manipulates control flow:
831 Start, End, Jmp, Cond, Return, Raise, Bad, CallBegin, EndReg, EndExcept */
832 int is_cfop(ir_node *node);
834 /* @@@ old -- use get_irn_irg instead! */
835 ir_graph *get_ip_cfop_irg(ir_node *n);
837 /** Returns true if the operation manipulates interprocedural control flow:
838 CallBegin, EndReg, EndExcept */
839 int is_ip_cfop(ir_node *node);
840 /** Returns true if the operation can change the control flow because
841 of an exception: Call, Quot, DivMod, Div, Mod, Load, Store, Alloc,
843 int is_fragile_op(ir_node *node);
844 /** Returns the memory operand of fragile operations. */
845 ir_node *get_fragile_op_mem(ir_node *node);
850 /* GNU C has the __FUNCTION__ extension */
851 #define __MYFUNC__ __FUNCTION__
853 /* use Filename instead */
854 #define __MYFUNC__ __FILE__
858 Don't format with "\", firmjni gets problems */
859 /** Output location */
860 #define DDM printf("%s(l.%i).\n", __MYFUNC__, __LINE__);
861 /** Output the firm kind of the node */
862 #define DDMK(X) printf("%s(l.%i) %s: %p\n", __MYFUNC__, __LINE__, print_firm_kind(X), (void *)(X));
863 /** Output information about a node */
864 #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))
865 /** Output information about a node and its block */
866 #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)))
867 /** Output information about a type */
868 #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))
869 /** Output information about an entity */
870 #define DDME(X) printf("%s(l.%i) %s: %ld (%p)\n", __MYFUNC__, __LINE__, get_entity_name(X), get_entity_nr(X), (void *)(X))
871 /** Output information about an entity and its type */
872 #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))
873 /** Output information about an entity and its owner */
874 #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))
875 /** Output information about a graph */
876 #define DDMG(X) printf("%s(l.%i) %s: %ld (%p)\n", __MYFUNC__, __LINE__, get_entity_name(get_irg_ent(X)), get_irg_graph_nr(X), (void *)(X))
877 /** Output information about an ident */
878 #define DDMI(X) printf("%s(l.%i) %s: %p\n", __MYFUNC__, __LINE__, id_to_str(X), (void *)(X))
879 /** Output information about a mode */
880 #define DDMM(X) printf("%s(l.%i) %s: %p\n", __MYFUNC__, __LINE__, get_mode_name(X), (void *)(X))
881 /** Output information about a loop */
882 #define DDML(X) printf("%s(l.%i) loop with depth %d: %d\n", __MYFUNC__, __LINE__, get_loop_depth(X), get_loop_loop_nr(X))
883 /** Output information about a tarVal */
884 #define DDMV(X) printf("%s(l.%i) tarval: ",__MYFUNC__, __LINE__); tarval_printf(X); printf(" (%p)\n", (void *)(X));
886 /*@}*/ /* end of ir_node group definition */
889 # endif /* _IRNODE_H_ */