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". */
202 #define get_nodes_block get_nodes_Block
203 ir_node *get_nodes_Block (ir_node *node);
204 #define set_nodes_block set_nodes_Block
205 void set_nodes_Block (ir_node *node, ir_node *block);
208 * Projection numbers for result of Start node: use for Proj nodes!
211 pn_Start_X_initial_exec, /**< Projection on the initial control flow. */
212 pn_Start_M, /**< Projection on the initial memory. */
213 pn_Start_P_frame_base, /**< Projection on the frame base pointer. */
214 pn_Start_P_globals, /**< Projection on the pointer to the data segment
215 containing _all_ global entities. */
216 pn_Start_T_args, /**< Projection on all arguments. */
217 pn_Start_P_value_arg_base /**< Pointer to region of compound value arguments as defined by
218 type of this method. */
219 } pn_Start; /* Projection numbers for Start. */
222 * Projection numbers for result of Start node: use for Proj nodes!
223 * @remark This is the old name convention, don't use anymore.
226 pns_initial_exec, /**< Projection on an executable, the initial control
228 pns_global_store, /**< Projection on the global store */
229 pns_frame_base, /**< Projection on the frame base */
230 pns_globals, /**< Projection on the pointer to the data segment
231 containing _all_ global entities. */
232 pns_args, /**< Projection on all arguments */
233 pns_value_arg_base /**< Pointer to region of compound value arguments as defined by
234 type of this method. */
235 } pns_number; /* pns: Projection Number Start */
237 /** Test whether arbitrary node is frame pointer.
239 * Test whether arbitrary node is frame pointer, i.e. Proj(pn_Start_P_frame_base)
240 * from Start. If so returns frame type, else Null. */
241 type *is_frame_pointer(ir_node *n);
243 /** Test whether arbitrary node is globals pointer.
245 * Test whether arbitrary node is globals pointer, i.e. Proj(pn_Start_P_globals)
246 * from Start. If so returns global type, else Null. */
247 type *is_globals_pointer(ir_node *n);
249 /** Test whether arbitrary node is value arg base.
251 * Test whether arbitrary node is value arg base, i.e. Proj(pn_Start_P_value_arg_base)
252 * from Start. If so returns 1, else 0. */
253 int is_value_arg_pointer(ir_node *n);
256 /* @@@ no more supported */
257 ir_node **get_Block_cfgpred_arr (ir_node *node);
258 int get_Block_n_cfgpreds (ir_node *node);
259 ir_node *get_Block_cfgpred (ir_node *node, int pos);
260 void set_Block_cfgpred (ir_node *node, int pos, ir_node *pred);
261 bool get_Block_matured (ir_node *node);
262 void set_Block_matured (ir_node *node, bool matured);
263 unsigned long get_Block_block_visited (ir_node *node);
264 void set_Block_block_visited (ir_node *node, unsigned long visit);
265 /* For this current_ir_graph must be set. */
266 void mark_Block_block_visited(ir_node *node);
267 int Block_not_block_visited(ir_node *node);
269 /* Set and remove interprocedural predecessors. If the interprocedural
270 * predecessors are removed, the node has the same predecessors in
272 * @@@ Maybe better: arity is zero if no cg preds. */
273 void set_Block_cg_cfgpred_arr(ir_node * node, int arity, ir_node ** in);
274 void set_Block_cg_cfgpred(ir_node * node, int pos, ir_node * pred);
275 /* @@@ not supported */
276 ir_node **get_Block_cg_cfgpred_arr(ir_node * node);
277 /* Returns the number of interprocedural predecessors. 0 if none. */
278 int get_Block_cg_n_cfgpreds(ir_node * node);
279 ir_node *get_Block_cg_cfgpred(ir_node * node, int pos);
280 /* frees the memory. */
281 void remove_Block_cg_cfgpred_arr(ir_node * node);
283 /* Start references the irg it is in.
284 @@@ old -- use get_irn_irg instead! */
285 ir_graph *get_Start_irg(ir_node *node);
287 int get_End_n_keepalives(ir_node *end);
288 ir_node *get_End_keepalive(ir_node *end, int pos);
289 void add_End_keepalive (ir_node *end, ir_node *ka);
290 void set_End_keepalive(ir_node *end, int pos, ir_node *ka);
291 /* Some parts of the End node are allocated separately -- their memory
292 is not recovered by dead_node_elimination if a End node is dead.
293 free_End frees these data structures. */
294 void free_End (ir_node *end);
296 /* @@@ old -- use get_irn_irg instead! */
297 ir_graph *get_EndReg_irg (ir_node *end);
298 ir_graph *get_EndExcept_irg (ir_node *end);
300 /* We distinguish three kinds of Cond nodes. These can be distinguished
301 by the mode of the selector operand and an internal flag of type cond_kind.
302 First we distinguish binary Conds and switch Conds.
303 A binary Cond has as selector a boolean value. Proj(0) projects the control
304 flow for case "False", Proj(1) the control flow for "True". A binary Cond
305 is recognized by the boolean selector.
306 The switch Cond has as selector an unsigned integer. It produces as result
307 an n+1 Tuple (cf0, ... , cfn) of control flows.
308 We differ two flavours of this Cond. The first, the dense Cond, passes
309 control along output i if the selector value is i, 0 <= i <= n. If the
310 selector value is >n it passes control along output n.
311 The second Cond flavor differes in the treatment of cases not specified in
312 the source program. It magically knows about the existence of Proj nodes.
313 It only passes control along output i, 0 <= i <= n, if a node Proj(Cond, i)
314 exists. Else it passes control along output n (even if this Proj does not
315 exist.) This Cond we call "fragmentary". There is a special constructor
316 new_defaultProj that automatically sets the flavor.
317 The two switch flavors are distinguished by a flag of type cond_kind.
318 Default flavor is "dense"
321 dense, /**< Default. Missing Proj nodes are dead control flow. */
322 fragmentary /**< Special. No control flow optimizations allowed. Missing
323 Proj nodes mean default control flow, i.e., Proj(n). */
326 ir_node *get_Cond_selector (ir_node *node);
327 void set_Cond_selector (ir_node *node, ir_node *selector);
328 cond_kind get_Cond_kind (ir_node *node);
329 void set_Cond_kind (ir_node *node, cond_kind kind);
330 long get_Cond_defaultProj (ir_node *node);
333 * Projection numbers for conditions.
336 pn_Cond_false, /**< Control flow if operand is "false". */
337 pn_Cond_true /**< Control flow if operand is "true". */
338 } pn_Cond; /* Projection numbers for Cond. */
340 ir_node *get_Return_mem (ir_node *node);
341 void set_Return_mem (ir_node *node, ir_node *mem);
342 ir_node **get_Return_res_arr (ir_node *node);
343 int get_Return_n_ress (ir_node *node);
344 ir_node *get_Return_res (ir_node *node, int pos);
345 void set_Return_res (ir_node *node, int pos, ir_node *res);
347 ir_node *get_Raise_mem (ir_node *node);
348 void set_Raise_mem (ir_node *node, ir_node *mem);
349 ir_node *get_Raise_exo_ptr (ir_node *node); /* PoinTeR to EXception Object */
350 void set_Raise_exo_ptr (ir_node *node, ir_node *exoptr);
353 * Projection numbers for Raise.
356 pn_Raise_X, /**< Execution result. */
357 pn_Raise_M /**< Memory result. */
358 } pn_Raise; /* Projection numbers for Raise. */
360 tarval *get_Const_tarval (ir_node *node);
361 void set_Const_tarval (ir_node *node, tarval *con);
362 /* The source language type. Must be an atomic type. Mode of type must
363 be mode of node. For tarvals from entities type must be pointer to
365 type *get_Const_type (ir_node *node);
366 void set_Const_type (ir_node *node, type *tp);
368 /** This enum names the three different kinds of symbolic Constants
369 represented by SymConst. The content of the attribute type_or_id
370 depends on this tag. Use the proper access routine after testing
373 type_tag, /**< The SymConst is a type tag for the given type.
374 Type_or_id_p is type *. */
375 size, /**< The SymConst is the size of the given type.
376 Type_or_id_p is type *. */
377 linkage_ptr_info /**< The SymConst is a symbolic pointer to be filled in
378 by the linker. Type_or_id_p is ident *. */
381 typedef union type_or_id * type_or_id_p;
382 symconst_kind get_SymConst_kind (const ir_node *node);
383 void set_SymConst_kind (ir_node *node, symconst_kind num);
384 /* Only to access SymConst of kind type_tag or size. Else assertion: */
385 type *get_SymConst_type (ir_node *node);
386 void set_SymConst_type (ir_node *node, type *tp);
387 /* Only to access SymConst of kind linkage_ptr_info. Else assertion: */
388 ident *get_SymConst_ptrinfo (ir_node *node);
389 void set_SymConst_ptrinfo (ir_node *node, ident *ptrinfo);
390 /* Sets both: type and ptrinfo. Needed to treat the node independent of
391 its semantics. Does a memcpy for the memory tori points to. */
392 type_or_id_p get_SymConst_type_or_id (ir_node *node);
393 void set_SymConst_type_or_id (ir_node *node, type_or_id_p tori);
395 ir_node *get_Sel_mem (ir_node *node);
396 void set_Sel_mem (ir_node *node, ir_node *mem);
397 ir_node *get_Sel_ptr (ir_node *node); /* ptr to the object to select from */
398 void set_Sel_ptr (ir_node *node, ir_node *ptr);
399 ir_node **get_Sel_index_arr (ir_node *node);
400 int get_Sel_n_indexs (ir_node *node);
401 ir_node *get_Sel_index (ir_node *node, int pos);
402 void set_Sel_index (ir_node *node, int pos, ir_node *index);
403 entity *get_Sel_entity (ir_node *node); /* entity to select */
404 void set_Sel_entity (ir_node *node, entity *ent);
407 * Projection numbers for result of Call node: use for Proj nodes!
409 * @remark old name convention!
412 pncl_memory = 0, /**< The memory result. */
413 pncl_exc_target = 1, /**< The control flow result branching to the exception handler */
414 pncl_result_tuple = 2, /**< The tuple containing all (0, 1, 2, ...) results */
415 pncl_exc_memory = 3, /**< The memory result in case the called method terminated with
417 pncl_value_res_base = 4 /**< A pointer to the memory region containing copied results
418 passed by value (for compound result types). */
419 } pncl_number; /* pncl: Projection Number CaLl */
422 * Projection numbers for result of Call node: use for Proj nodes!
425 pn_Call_M_regular = 0, /**< The memory result. */
426 pn_Call_T_result = 2, /**< The tuple containing all (0, 1, 2, ...) results */
427 pn_Call_P_value_res_base = 4,/**< A pointer to the memory region containing copied results
428 passed by value (for compound result types). */
429 pn_Call_X_except = 1, /**< The control flow result branching to the exception handler */
430 pn_Call_M_except = 3 /**< The memory result in case the called method terminated with
432 } pn_Call; /* Projection numbers for Call. */
434 ir_node *get_Call_mem (ir_node *node);
435 void set_Call_mem (ir_node *node, ir_node *mem);
436 ir_node *get_Call_ptr (ir_node *node);
437 void set_Call_ptr (ir_node *node, ir_node *ptr);
438 ir_node **get_Call_param_arr (ir_node *node);
439 /** Gets the number of parameters of a call. */
440 int get_Call_n_params (ir_node *node);
441 /** Gets the call parameter at position pos. */
442 ir_node *get_Call_param (ir_node *node, int pos);
443 /** Sets the call parameter at position pos. */
444 void set_Call_param (ir_node *node, int pos, ir_node *param);
445 /** Gets the type of a call. */
446 type *get_Call_type (ir_node *node);
447 /** Sets the type of a call. */
448 void set_Call_type (ir_node *node, type *tp);
449 /** Gets the arity of a call. Identical to get_Call_n_params(). */
450 int get_Call_arity (ir_node *node);
452 /* Set, get and remove the callee-analysis.
453 The array is only accessible if information is valid.
454 It contains NULL for called methods that are not within
455 the compilation unit. */
456 int Call_has_callees (ir_node *node);
457 int get_Call_n_callees (ir_node * node);
458 entity *get_Call_callee (ir_node * node, int pos);
459 /* assumes current_ir_graph set properly! */
460 void set_Call_callee_arr (ir_node * node, int n, entity ** arr);
461 void remove_Call_callee_arr(ir_node * node);
463 ir_node *get_CallBegin_ptr (ir_node *node);
464 void set_CallBegin_ptr (ir_node *node, ir_node *ptr);
465 /* @@@ old -- use get_irn_irg instead! */
466 ir_graph *get_CallBegin_irg (ir_node *node);
467 ir_node *get_CallBegin_call (ir_node *node);
468 void set_CallBegin_call (ir_node *node, ir_node *call);
470 ir_node *get_FuncCall_ptr (ir_node *node);
471 void set_FuncCall_ptr (ir_node *node, ir_node *ptr);
472 ir_node **get_FuncCall_param_arr (ir_node *node);
473 /** Gets the number of parameters of a func call. */
474 int get_FuncCall_n_params (ir_node *node);
475 /** Gets the func call parameter at position pos. */
476 ir_node *get_FuncCall_param (ir_node *node, int pos);
477 /** Sets the func call parameter at position pos. */
478 void set_FuncCall_param (ir_node *node, int pos, ir_node *param);
479 /** Gets the type of a func call. */
480 type *get_FuncCall_type (ir_node *node);
481 /** Sets the type of a func call. */
482 void set_FuncCall_type (ir_node *node, type *tp);
483 /** Gets the arity of a func call. Identical to get_FuncCall_n_params(). */
484 int get_FuncCall_arity (ir_node *node);
486 /* Set, get and remove the callee-analysis.
487 The array is only accessible if information is valid.
488 It contains NULL for called methods that are not within
489 the compilation unit. */
490 int FuncCall_has_callees (ir_node *node);
491 int get_FuncCall_n_callees (ir_node * node);
492 entity *get_FuncCall_callee (ir_node * node, int pos);
493 /* assumes current_ir_graph set properly! */
494 void set_FuncCall_callee_arr (ir_node * node, int n, entity ** arr);
495 void remove_FuncCall_callee_arr(ir_node * node);
497 /* For unary and binary arithmetic operations the access to the
498 operands can be factored out. Left is the first, right the
499 second arithmetic value as listed in tech report 1999-44.
500 unops are: Minus, Abs, Not, Conv, Cast
501 binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
502 Shr, Shrs, Rot, Cmp */
503 int is_unop (ir_node *node);
504 ir_node *get_unop_op (ir_node *node);
505 void set_unop_op (ir_node *node, ir_node *op);
506 int is_binop (ir_node *node);
507 ir_node *get_binop_left (ir_node *node);
508 void set_binop_left (ir_node *node, ir_node *left);
509 ir_node *get_binop_right (ir_node *node);
510 void set_binop_right (ir_node *node, ir_node *right);
512 ir_node *get_Add_left (ir_node *node);
513 void set_Add_left (ir_node *node, ir_node *left);
514 ir_node *get_Add_right (ir_node *node);
515 void set_Add_right (ir_node *node, ir_node *right);
517 ir_node *get_Sub_left (ir_node *node);
518 void set_Sub_left (ir_node *node, ir_node *left);
519 ir_node *get_Sub_right (ir_node *node);
520 void set_Sub_right (ir_node *node, ir_node *right);
522 ir_node *get_Minus_op (ir_node *node);
523 void set_Minus_op (ir_node *node, ir_node *op);
525 ir_node *get_Mul_left (ir_node *node);
526 void set_Mul_left (ir_node *node, ir_node *left);
527 ir_node *get_Mul_right (ir_node *node);
528 void set_Mul_right (ir_node *node, ir_node *right);
530 ir_node *get_Quot_left (ir_node *node);
531 void set_Quot_left (ir_node *node, ir_node *left);
532 ir_node *get_Quot_right (ir_node *node);
533 void set_Quot_right (ir_node *node, ir_node *right);
534 ir_node *get_Quot_mem (ir_node *node);
535 void set_Quot_mem (ir_node *node, ir_node *mem);
538 * Projection numbers for Quot: use for Proj nodes!
541 pn_Quot_M, /**< Memory result. */
542 pn_Quot_X_except, /**< Execution result if exception occured. */
543 pn_Quot_res /**< Result of computation. */
544 } pn_Quot; /* Projection numbers for Quot. */
546 ir_node *get_DivMod_left (ir_node *node);
547 void set_DivMod_left (ir_node *node, ir_node *left);
548 ir_node *get_DivMod_right (ir_node *node);
549 void set_DivMod_right (ir_node *node, ir_node *right);
550 ir_node *get_DivMod_mem (ir_node *node);
551 void set_DivMod_mem (ir_node *node, ir_node *mem);
554 * Projection numbers for DivMod: use for Proj nodes!
557 pn_DivMod_M, /**< Memory result. */
558 pn_DivMod_X_except, /**< Execution result if exception occured. */
559 pn_DivMod_res_div, /**< Result of computation a / b. */
560 pn_DivMod_res_mod /**< Result of computation a % b. */
561 } pn_DivMod; /* Projection numbers for DivMod. */
563 ir_node *get_Div_left (ir_node *node);
564 void set_Div_left (ir_node *node, ir_node *left);
565 ir_node *get_Div_right (ir_node *node);
566 void set_Div_right (ir_node *node, ir_node *right);
567 ir_node *get_Div_mem (ir_node *node);
568 void set_Div_mem (ir_node *node, ir_node *mem);
571 * Projection numbers for Div: use for Proj nodes!
574 pn_Div_M, /**< Memory result. */
575 pn_Div_X_except, /**< Execution result if exception occured. */
576 pn_Div_res /**< Result of computation. */
577 } pn_Div; /* Projection numbers for Div. */
579 ir_node *get_Mod_left (ir_node *node);
580 void set_Mod_left (ir_node *node, ir_node *left);
581 ir_node *get_Mod_right (ir_node *node);
582 void set_Mod_right (ir_node *node, ir_node *right);
583 ir_node *get_Mod_mem (ir_node *node);
584 void set_Mod_mem (ir_node *node, ir_node *mem);
587 * Projection numbers for Mod: use for Proj nodes!
590 pn_Mod_M, /**< Memory result. */
591 pn_Mod_X_except, /**< Execution result if exception occured. */
592 pn_Mod_res /**< Result of computation. */
593 } pn_Mod; /* Projection numbers for Mod. */
595 ir_node *get_Abs_op (ir_node *node);
596 void set_Abs_op (ir_node *node, ir_node *op);
598 ir_node *get_And_left (ir_node *node);
599 void set_And_left (ir_node *node, ir_node *left);
600 ir_node *get_And_right (ir_node *node);
601 void set_And_right (ir_node *node, ir_node *right);
603 ir_node *get_Or_left (ir_node *node);
604 void set_Or_left (ir_node *node, ir_node *left);
605 ir_node *get_Or_right (ir_node *node);
606 void set_Or_right (ir_node *node, ir_node *right);
608 ir_node *get_Eor_left (ir_node *node);
609 void set_Eor_left (ir_node *node, ir_node *left);
610 ir_node *get_Eor_right (ir_node *node);
611 void set_Eor_right (ir_node *node, ir_node *right);
613 ir_node *get_Not_op (ir_node *node);
614 void set_Not_op (ir_node *node, ir_node *op);
617 * Projection numbers for Cmp are defined several times.
618 * The bit patterns are used for various tests, so don't change.
619 * The "unordered" values are possible results of comparing
620 * floating point numbers.
623 pn_Cmp_False = 0, /**< false */
624 pn_Cmp_Eq, /**< equal */
625 pn_Cmp_Lt, /**< less */
626 pn_Cmp_Le, /**< less or equal */
627 pn_Cmp_Gt, /**< greater */
628 pn_Cmp_Ge, /**< greater or equal */
629 pn_Cmp_Lg, /**< less or greater */
630 pn_Cmp_Leg = 7, /**< less, equal or greater = ordered */
631 pn_Cmp_Uo, /**< unordered */
632 pn_Cmp_Ue, /**< unordered or equal */
633 pn_Cmp_Ul, /**< unordered or less */
634 pn_Cmp_Ule, /**< unordered, less or equal */
635 pn_Cmp_Ug, /**< unordered or greater */
636 pn_Cmp_Uge, /**< unordered, greater or equal */
637 pn_Cmp_Ne, /**< unordered, less or greater = not equal */
638 pn_Cmp_True = 15 /**< true */
639 /* not_mask = Leg*/ /* bits to flip to negate comparison * @@ hack for jni interface */
640 } pn_Cmp; /* Projection numbers for Cmp */
641 /* #define not_mask pn_Cmp_Leg */
643 const char *get_pnc_string(int pnc);
644 int get_negated_pnc(int pnc);
645 ir_node *get_Cmp_left (ir_node *node);
646 void set_Cmp_left (ir_node *node, ir_node *left);
647 ir_node *get_Cmp_right (ir_node *node);
648 void set_Cmp_right (ir_node *node, ir_node *right);
650 ir_node *get_Shl_left (ir_node *node);
651 void set_Shl_left (ir_node *node, ir_node *left);
652 ir_node *get_Shl_right (ir_node *node);
653 void set_Shl_right (ir_node *node, ir_node *right);
655 ir_node *get_Shr_left (ir_node *node);
656 void set_Shr_left (ir_node *node, ir_node *left);
657 ir_node *get_Shr_right (ir_node *node);
658 void set_Shr_right (ir_node *node, ir_node *right);
660 ir_node *get_Shrs_left (ir_node *node);
661 void set_Shrs_left (ir_node *node, ir_node *left);
662 ir_node *get_Shrs_right (ir_node *node);
663 void set_Shrs_right (ir_node *node, ir_node *right);
665 ir_node *get_Rot_left (ir_node *node);
666 void set_Rot_left (ir_node *node, ir_node *left);
667 ir_node *get_Rot_right (ir_node *node);
668 void set_Rot_right (ir_node *node, ir_node *right);
670 ir_node *get_Conv_op (ir_node *node);
671 void set_Conv_op (ir_node *node, ir_node *op);
673 /* Does Cast need a mem operator?
674 * Cast should only depend on the type, not on the state of an
675 * entity. But: we initialze various fields after Alloc, that
676 * are accessed in the cast. This required some precaution, to
677 * get the right memory into the Loads generated from the cast.
679 ir_node *get_Cast_op (ir_node *node);
680 void set_Cast_op (ir_node *node, ir_node *op);
681 type *get_Cast_type (ir_node *node);
682 void set_Cast_type (ir_node *node, type *to_tp);
684 /* Returns true if n is Phi or Filter in interprocedural_view. */
685 int is_Phi (ir_node *n);
686 /* These routines also work for Filter nodes in interprocedural view. */
687 ir_node **get_Phi_preds_arr (ir_node *node);
688 int get_Phi_n_preds (ir_node *node);
689 ir_node *get_Phi_pred (ir_node *node, int pos);
690 void set_Phi_pred (ir_node *node, int pos, ir_node *pred);
692 ir_node *get_Filter_pred(ir_node *node);
693 void set_Filter_pred(ir_node *node, ir_node *pred);
694 long get_Filter_proj(ir_node *node);
695 void set_Filter_proj(ir_node *node, long proj);
696 /* set the interprocedural predecessors, ...d_arr uses current_ir_graph.
697 * @@@ Maybe better: arity is zero if no cg preds. */
698 void set_Filter_cg_pred_arr(ir_node * node, int arity, ir_node ** in);
699 void set_Filter_cg_pred(ir_node * node, int pos, ir_node * pred);
700 int get_Filter_n_cg_preds(ir_node *node);
701 ir_node * get_Filter_cg_pred(ir_node *node, int pos);
704 * Projection numbers for Load: use for Proj nodes!
707 pn_Load_M, /**< Memory result. */
708 pn_Load_X_except, /**< Execution result if exception occured. */
709 pn_Load_res /**< Result of load operation. */
710 } pn_Load; /* Projection numbers for Load. */
712 ir_node *get_Load_mem (ir_node *node);
713 void set_Load_mem (ir_node *node, ir_node *mem);
714 ir_node *get_Load_ptr (ir_node *node);
715 void set_Load_ptr (ir_node *node, ir_node *ptr);
718 * Projection numbers for Store: use for Proj nodes!
721 pn_Store_M, /**< Memory result. */
722 pn_Store_X_except /**< Execution result if exception occured. */
723 } pn_Store; /* Projection numbers for Store. */
725 ir_node *get_Store_mem (ir_node *node);
726 void set_Store_mem (ir_node *node, ir_node *mem);
727 ir_node *get_Store_ptr (ir_node *node);
728 void set_Store_ptr (ir_node *node, ir_node *ptr);
729 ir_node *get_Store_value (ir_node *node);
730 void set_Store_value (ir_node *node, ir_node *value);
733 * Projection numbers for Alloc: use for Proj nodes!
736 pn_Alloc_M, /**< Memory result. */
737 pn_Alloc_X_except, /**< Execution result if exception occured. */
738 pn_Alloc_res /**< Result of allocation. */
739 } pn_Alloc; /* Projection numbers for Alloc. */
741 ir_node *get_Alloc_mem (ir_node *node);
742 void set_Alloc_mem (ir_node *node, ir_node *mem);
743 ir_node *get_Alloc_size (ir_node *node);
744 void set_Alloc_size (ir_node *node, ir_node *size);
745 type *get_Alloc_type (ir_node *node);
746 void set_Alloc_type (ir_node *node, type *tp);
748 /** The allocation place. */
750 stack_alloc, /**< Alloc allocates the object on the stack. */
751 heap_alloc /**< Alloc allocates the object on the heap. */
754 where_alloc get_Alloc_where (ir_node *node);
755 void set_Alloc_where (ir_node *node, where_alloc where);
757 ir_node *get_Free_mem (ir_node *node);
758 void set_Free_mem (ir_node *node, ir_node *mem);
759 ir_node *get_Free_ptr (ir_node *node);
760 void set_Free_ptr (ir_node *node, ir_node *ptr);
761 ir_node *get_Free_size (ir_node *node);
762 void set_Free_size (ir_node *node, ir_node *size);
763 type *get_Free_type (ir_node *node);
764 void set_Free_type (ir_node *node, type *tp);
766 ir_node **get_Sync_preds_arr (ir_node *node);
767 int get_Sync_n_preds (ir_node *node);
768 ir_node *get_Sync_pred (ir_node *node, int pos);
769 void set_Sync_pred (ir_node *node, int pos, ir_node *pred);
771 ir_node *get_Proj_pred (ir_node *node);
772 void set_Proj_pred (ir_node *node, ir_node *pred);
773 /* Why long? shouldn't int be enough, and smaller? Or even byte? */
774 long get_Proj_proj (ir_node *node);
775 void set_Proj_proj (ir_node *node, long proj);
777 ir_node **get_Tuple_preds_arr (ir_node *node);
778 int get_Tuple_n_preds (ir_node *node);
779 ir_node *get_Tuple_pred (ir_node *node, int pos);
780 void set_Tuple_pred (ir_node *node, int pos, ir_node *pred);
782 ir_node *get_Id_pred (ir_node *node);
783 void set_Id_pred (ir_node *node, ir_node *pred);
785 /** Confirm has a single result and returns 'value' unchanged.
786 * The node expresses a restriction on 'value':
787 * 'value' 'cmp' 'bound' == true. */
788 ir_node *get_Confirm_value (ir_node *node);
789 void set_Confirm_value (ir_node *node, ir_node *value);
790 ir_node *get_Confirm_bound (ir_node *node);
791 void set_Confirm_bound (ir_node *node, ir_node *bound);
792 pn_Cmp get_Confirm_cmp (ir_node *node);
793 void set_Confirm_cmp (ir_node *node, pn_Cmp cmp);
797 * NAME Auxiliary routines
799 * Not properly documented ;-)
803 /** returns operand of node if node is a Proj. */
804 ir_node *skip_Proj (ir_node *node);
805 /** returns operand of node if node is a Id */
806 ir_node *skip_nop (ir_node *node);
807 ir_node *skip_Id (ir_node *node); /* Same as skip_nop. */
808 /* returns corresponding operand of Tuple if node is a Proj from
810 ir_node *skip_Tuple (ir_node *node);
811 /** returns operand of node if node is a Cast */
812 ir_node *skip_Cast (ir_node *node);
813 /** returns true if node is a Bad node. */
814 int is_Bad (ir_node *node);
815 /** returns true if the node is not a Block */
816 int is_no_Block (ir_node *node);
817 /** returns true if the node is a Block */
818 int is_Block (ir_node *node);
819 /** returns true if node is a Unknown node. */
820 int is_Unknown (ir_node *node);
821 /** returns true if node is a Proj node or a Filter node in
822 * intraprocedural view */
823 int is_Proj (const ir_node *node);
824 /** Returns true if the operation manipulates control flow:
825 Start, End, Jmp, Cond, Return, Raise, Bad, CallBegin, EndReg, EndExcept */
826 int is_cfop(ir_node *node);
828 /* @@@ old -- use get_irn_irg instead! */
829 ir_graph *get_ip_cfop_irg(ir_node *n);
831 /** Returns true if the operation manipulates interprocedural control flow:
832 CallBegin, EndReg, EndExcept */
833 int is_ip_cfop(ir_node *node);
834 /** Returns true if the operation can change the control flow because
835 of an exception: Call, Quot, DivMod, Div, Mod, Load, Store, Alloc,
837 int is_fragile_op(ir_node *node);
838 /** Returns the memory operand of fragile operations. */
839 ir_node *get_fragile_op_mem(ir_node *node);
844 /* GNU C has the __FUNCTION__ extension */
845 #define __MYFUNC__ __FUNCTION__
847 /* use Filename instead */
848 #define __MYFUNC__ __FILE__
852 Don't format with "\", firmjni gets problems */
853 /** Output location */
854 #define DDM printf("%s(l.%i).\n", __MYFUNC__, __LINE__);
855 /** Output the firm kind of the node */
856 #define DDMK(X) printf("%s(l.%i) %s: %p\n", __MYFUNC__, __LINE__, print_firm_kind(X), (void *)(X));
857 /** Output information about a node */
858 #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))
859 /** Output information about a node and its block */
860 #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)))
861 /** Output information about a type */
862 #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))
863 /** Output information about an entity */
864 #define DDME(X) printf("%s(l.%i) %s: %ld (%p)\n", __MYFUNC__, __LINE__, get_entity_name(X), get_entity_nr(X), (void *)(X))
865 /** Output information about an entity and its type */
866 #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))
867 /** Output information about an entity and its owner */
868 #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))
869 /** Output information about a graph */
870 #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))
871 /** Output information about an ident */
872 #define DDMI(X) printf("%s(l.%i) %s: %p\n", __MYFUNC__, __LINE__, id_to_str(X), (void *)(X))
873 /** Output information about a mode */
874 #define DDMM(X) printf("%s(l.%i) %s: %p\n", __MYFUNC__, __LINE__, get_mode_name(X), (void *)(X))
875 /** Output information about a loop */
876 #define DDML(X) printf("%s(l.%i) loop with depth %d: %d\n", __MYFUNC__, __LINE__, get_loop_depth(X), get_loop_loop_nr(X))
877 /** Output information about a tarVal */
878 #define DDMV(X) printf("%s(l.%i) tarval: ",__MYFUNC__, __LINE__); tarval_printf(X); printf(" (%p)\n", (void *)(X));
880 /*@}*/ /* end of ir_node group definition */
883 # endif /* _IRNODE_H_ */