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.
16 /** Projection numbers of compare: use for Proj nodes! */
17 /* @@@ there are numbers with normalized names below! */
19 False = 0, /**< false */
22 Le, /**< less or equal */
24 Ge, /**< greater or equal */
25 Lg, /**< less or greater */
26 Leg = 7, /**< less, equal or greater = ordered */
28 Ue, /**< unordered or equal */
29 Ul, /**< unordered or less */
30 Ule, /**< unordered, less or equal */
31 Ug, /**< unordered or greater */
32 Uge, /**< unordered, greater or equal */
33 Ne, /**< unordered, less or greater = not equal */
34 True = 15 /**< true */
35 /* not_mask = Leg*/ /* bits to flip to negate comparison * @@ hack for jni interface */
36 } pnc_number; /* pnc: Projection Number Cmp */
42 # include "firm_common.h"
52 * @author Martin Trapp, Christian Schaefer
54 * Declarations of an ir node.
58 * @defgroup ir_node Declarations of an ir node.
60 * The type definiton of ir_node is also in irgraph.h to resolve
61 * recursion between irnode.h and irgraph.h
63 * ir_node - a datatype representing a Firm node
65 * The common fields are:
67 * - firm_kind - A firm_kind tag containing k_type. This is useful
68 * for dynamically checking whether a node is a ir_node.
69 * - arity - The number of predecessors in the Firm graph.
70 * - in - A list with the predecessors in the Firm graph. There are
71 * routines to access individual elements and to obtain the
72 * array. The method returning the array should not be used.
73 * - mode - The mode of the node. There are routines to get the mode
74 * but also to access the mode's fields directly.
75 * - opcode - The opcode of the node. There are routines to get the opcode
76 * but also to access the opcode's fields directly.
77 * - node_nr - A unique number for the node. Available only if debugging
82 #ifndef _IR_NODE_TYPEDEF_
83 #define _IR_NODE_TYPEDEF_
84 typedef struct ir_node ir_node;
88 * you can work on the graph without considering the different types
89 * of nodes, it's just a big graph.
93 * Checks whether a pointer points to a ir node.
95 * @param thing an arbitrary pointer
98 * true if the thing is a ir mode, else false
101 is_ir_node (void *thing);
103 /** returns the number of predecessors without the block predecessor: */
104 int get_irn_arity (const ir_node *node);
106 /** Replaces the old in array by a new one that will contain the ins given in
107 the parameters. Conserves the block predecessor. It copies the array passed.
108 This function is necessary to ajust in arrays of blocks, calls and phis.
109 Assumes that current_ir_graph is set to the graph containing "node".
110 "in" must contain all predecessors except the block that are required for
112 INLINE void set_irn_in (ir_node *node, int arity,
114 /* to iterate through the predecessors without touching the array. No
115 order of predecessors guaranteed.
116 To iterate over the operands iterate from 0 to i < get_irn_arity(),
117 to iterate including the Block predecessor iterate from i = -1 to
118 i < get_irn_arity. */
119 /* Access predecessor n */
120 /* get_irn_n removes Id predecessors. */
121 INLINE ir_node *get_irn_n (ir_node *node, int n);
122 INLINE void set_irn_n (ir_node *node, int n, ir_node *in);
123 /** Sets the mode struct of node */
124 INLINE void set_irn_mode (ir_node *node, ir_mode *mode);
125 /** Gets the mode struct. */
126 INLINE ir_mode *get_irn_mode (const ir_node *node);
127 /** Gets the mode-enum modecode. */
128 INLINE modecode get_irn_modecode (const ir_node *node);
129 /** Gets the ident for a string representation of the mode .*/
130 INLINE ident *get_irn_modeident (const ir_node *node);
131 /** Gets the opcode struct of the node */
132 INLINE ir_op *get_irn_op (const ir_node *node);
133 /** Sets the opcode struct of the node. */
134 INLINE void set_irn_op (ir_node *node, ir_op *op);
135 /** Gets the opcode-enum of the node. */
136 INLINE opcode get_irn_opcode (const ir_node *node);
137 /** Get the string representation of the opcode. */
138 INLINE const char *get_irn_opname (const ir_node *node);
139 /** Get the ident for a string representation of the opcode. */
140 INLINE ident *get_irn_opident (const ir_node *node);
141 INLINE unsigned long get_irn_visited (const ir_node *node);
142 INLINE void set_irn_visited (ir_node *node, unsigned long visited);
143 /** Sets visited to get_irg_visited(current_ir_graph). */
144 INLINE void mark_irn_visited (ir_node *node);
145 /** Returns 1 if visited < get_irg_visited(current_ir_graph). */
146 INLINE int irn_not_visited (const ir_node *node);
147 /** Returns 1 if visited >= get_irg_visited(current_ir_graph). */
148 INLINE int irn_visited (const ir_node *node);
149 INLINE void set_irn_link (ir_node *node, void *link);
150 INLINE void *get_irn_link (const ir_node *node);
152 /** Outputs a unique number for this node if libfirm is compiled for
153 debugging, (configure with --enable-debug) else returns 0. */
154 INLINE long get_irn_node_nr(const ir_node *node);
156 /** Returns the ir_graph this node belongs to. Only valid for
157 * CallBegin, EndReg, EndExcept and Start */
158 INLINE ir_graph *get_irn_irg(ir_node *node);
161 * irnode constructor.
162 * Create a new irnode in irg, with an op, mode, arity and
163 * some incoming irnodes.
164 * If arity is negative, a node with a dynamic array is created.
167 new_ir_node (dbg_info *db,
177 * NAME access functions for node fields.
179 * Not properly documented ;-)
183 /* This works for all except Block. To express the difference to
184 * access routines that work for all nodes we use infix "nodes". */
185 #define get_nodes_block get_nodes_Block
186 INLINE ir_node *get_nodes_Block (ir_node *node);
187 #define set_nodes_block set_nodes_Block
188 INLINE void set_nodes_Block (ir_node *node, ir_node *block);
190 /** Projection numbers for result of Start node: use for Proj nodes! */
191 /* @@@ old name convention! */
193 pns_initial_exec, /**< Projection on an executable, the initial control
195 pns_global_store, /**< Projection on the global store */
196 pns_frame_base, /**< Projection on the frame base */
197 pns_globals, /**< Projection on the pointer to the data segment
198 containing _all_ global entities. */
199 pns_args, /**< Projection on all arguments */
200 pns_value_arg_base /**< Pointer to region of compound value arguments as defined by
201 type of this method. */
202 } pns_number; /* pns: Projection Number Start */
204 pn_Start_X_initial_exec, /**< Projection on the initial control flow. */
205 pn_Start_M, /**< Projection on the initial memory. */
206 pn_Start_P_frame_base, /**< Projection on the frame base pointer. */
207 pn_Start_P_globals, /**< Projection on the pointer to the data segment
208 containing _all_ global entities. */
209 pn_Start_T_args, /**< Projection on all arguments. */
210 pn_Start_P_value_arg_base /**< Pointer to region of compound value arguments as defined by
211 type of this method. */
212 } pn_Start; /* Projection numbers for Start. */
215 /* @@@ no more supported */
216 INLINE ir_node **get_Block_cfgpred_arr (ir_node *node);
217 int get_Block_n_cfgpreds (ir_node *node);
218 INLINE ir_node *get_Block_cfgpred (ir_node *node, int pos);
219 INLINE void set_Block_cfgpred (ir_node *node, int pos, ir_node *pred);
220 INLINE bool get_Block_matured (ir_node *node);
221 INLINE void set_Block_matured (ir_node *node, bool matured);
222 INLINE unsigned long get_Block_block_visited (ir_node *node);
223 INLINE void set_Block_block_visited (ir_node *node, unsigned long visit);
224 /* For this current_ir_graph must be set. */
225 INLINE void mark_Block_block_visited(ir_node *node);
226 INLINE int Block_not_block_visited(ir_node *node);
228 /* Set and remove interprocedural predecessors. If the interprocedural
229 * predecessors are removed, the node has the same predecessors in
231 * @@@ Maybe better: arity is zero if no cg preds. */
232 void set_Block_cg_cfgpred_arr(ir_node * node, int arity, ir_node ** in);
233 void set_Block_cg_cfgpred(ir_node * node, int pos, ir_node * pred);
234 /* @@@ not supported */
235 ir_node **get_Block_cg_cfgpred_arr(ir_node * node);
236 /* Returns the number of interproc predecessors. 0 if none. */
237 int get_Block_cg_n_cfgpreds(ir_node * node);
238 ir_node *get_Block_cg_cfgpred(ir_node * node, int pos);
239 /* frees the memory. */
240 void remove_Block_cg_cfgpred_arr(ir_node * node);
242 /* Start references the irg it is in. */
243 ir_graph *get_Start_irg(ir_node *node);
244 void set_Start_irg(ir_node *node, ir_graph *irg);
246 INLINE int get_End_n_keepalives(ir_node *end);
247 INLINE ir_node *get_End_keepalive(ir_node *end, int pos);
248 INLINE void add_End_keepalive (ir_node *end, ir_node *ka);
249 INLINE void set_End_keepalive(ir_node *end, int pos, ir_node *ka);
250 /* Some parts of the End node are allocated seperately -- their memory
251 is not recovered by dead_node_elimination if a End node is dead.
252 free_End frees these data structures. */
253 INLINE void free_End (ir_node *end);
255 ir_graph *get_EndReg_irg (const ir_node *end);
256 ir_graph *get_EndExcept_irg (const ir_node *end);
258 /* We distinguish three kinds of Cond nodes. These can be distinguished
259 by the mode of the selector operand and an internal flag of type cond_kind.
260 First we distinguish binary Conds and switch Conds.
261 A binary Cond has as selector a boolean value. Proj(0) projects the control
262 flow for case "False", Proj(1) the control flow for "True". A binary Cond
263 is recognized by the boolean selector.
264 The switch Cond has as selector an unsigned integer. It produces as result
265 an n+1 Tuple (cf0, ... , cfn) of control flows.
266 We differ two flavours of this Cond. The first, the dense Cond, passes
267 control along output i if the selector value is i, 0 <= i <= n. If the
268 selector value is >n it passes control along output n.
269 The second Cond flavor differes in the treatment of cases not specified in
270 the source program. It magically knows about the existence of Proj nodes.
271 It only passes control along output i, 0 <= i <= n, if a node Proj(Cond, i)
272 exists. Else it passes control along output n (even if this Proj does not
273 exist.) This Cond we call "fragmentary". There is a special constructor
274 new_defaultProj that automatically sets the flavor.
275 The two switch flavors are distinguished by a flag of type cond_kind.
276 Default flavor is "dense"
279 dense, /**< Default. Missing Proj nodes are dead control flow. */
280 fragmentary /**< Special. No control flow optimizations allowed. Missing
281 Proj nodes mean default control flow, i.e., Proj(n). */
284 INLINE ir_node *get_Cond_selector (ir_node *node);
285 INLINE void set_Cond_selector (ir_node *node, ir_node *selector);
286 INLINE cond_kind get_Cond_kind (ir_node *node);
287 INLINE void set_Cond_kind (ir_node *node, cond_kind kind);
290 pn_Cond_false, /**< Control flow if operand is "false". */
291 pn_Cond_true /**< Control flow if operand is "true". */
292 } pn_Cond; /* Projection numbers for Cond. */
294 INLINE ir_node *get_Return_mem (ir_node *node);
295 INLINE void set_Return_mem (ir_node *node, ir_node *mem);
296 INLINE ir_node **get_Return_res_arr (ir_node *node);
297 INLINE int get_Return_n_ress (ir_node *node);
298 INLINE ir_node *get_Return_res (ir_node *node, int pos);
299 INLINE void set_Return_res (ir_node *node, int pos, ir_node *res);
301 INLINE ir_node *get_Raise_mem (ir_node *node);
302 INLINE void set_Raise_mem (ir_node *node, ir_node *mem);
303 INLINE ir_node *get_Raise_exo_ptr (ir_node *node); /* PoinTeR to EXception Object */
304 INLINE void set_Raise_exo_ptr (ir_node *node, ir_node *exoptr);
307 pn_Raise_X, /**< Execution result. */
308 pn_Raise_M /**< Memory result. */
309 } pn_Raise; /* Projection numbers for Raise. */
311 INLINE tarval *get_Const_tarval (ir_node *node);
312 INLINE void set_Const_tarval (ir_node *node, tarval *con);
313 /* The source language type. Must be an atomic type. Mode of type must
314 be mode of node. For tarvals from entities type must be pointer to
316 INLINE type *get_Const_type (ir_node *node);
317 INLINE void set_Const_type (ir_node *node, type *tp);
319 /** This enum names the three different kinds of symbolic Constants
320 represented by SymConst. The content of the attribute type_or_id
321 depends on this tag. Use the proper access routine after testing
324 type_tag, /**< The SymConst is a type tag for the given type.
325 Type_or_id_p is type *. */
326 size, /**< The SymConst is the size of the given type.
327 Type_or_id_p is type *. */
328 linkage_ptr_info /**< The SymConst is a symbolic pointer to be filled in
329 by the linker. Type_or_id_p is ident *. */
331 typedef union type_or_id * type_or_id_p;
332 INLINE symconst_kind get_SymConst_kind (const ir_node *node);
333 INLINE void set_SymConst_kind (ir_node *node, symconst_kind num);
334 /* Only to access SymConst of kind type_tag or size. Else assertion: */
335 INLINE type *get_SymConst_type (ir_node *node);
336 INLINE void set_SymConst_type (ir_node *node, type *tp);
337 /* Only to access SymConst of kind linkage_ptr_info. Else assertion: */
338 INLINE ident *get_SymConst_ptrinfo (ir_node *node);
339 INLINE void set_SymConst_ptrinfo (ir_node *node, ident *ptrinfo);
340 /* Sets both: type and ptrinfo. Needed to treat the node independent of
341 its semantics. Does a memcpy for the memory tori points to. */
342 INLINE type_or_id_p get_SymConst_type_or_id (ir_node *node);
343 INLINE void set_SymConst_type_or_id (ir_node *node, type_or_id_p tori);
345 INLINE ir_node *get_Sel_mem (ir_node *node);
346 INLINE void set_Sel_mem (ir_node *node, ir_node *mem);
347 INLINE ir_node *get_Sel_ptr (ir_node *node); /* ptr to the object to select from */
348 INLINE void set_Sel_ptr (ir_node *node, ir_node *ptr);
349 INLINE ir_node **get_Sel_index_arr (ir_node *node);
350 INLINE int get_Sel_n_indexs (ir_node *node);
351 INLINE ir_node *get_Sel_index (ir_node *node, int pos);
352 INLINE void set_Sel_index (ir_node *node, int pos, ir_node *index);
353 INLINE entity *get_Sel_entity (ir_node *node); /* entity to select */
354 INLINE void set_Sel_entity (ir_node *node, entity *ent);
356 /** Projection numbers for result of Call node: use for Proj nodes! */
357 /* @@@ old name convention! */
359 pncl_memory = 0, /**< The memory result. */
360 pncl_exc_target = 1, /**< The control flow result branching to the exception handler */
361 pncl_result_tuple = 2, /**< The tuple containing all (0, 1, 2, ...) results */
362 pncl_exc_memory = 3, /**< The memory result in case the called method terminated with
364 pncl_value_res_base = 4 /**< A pointer to the memory region containing copied results
365 passed by value (for compound result types). */
366 } pncl_number; /* pncl: Projection Number CaLl */
369 pn_Call_M_regular = 0, /**< The memory result. */
370 pn_Call_T_result = 2, /**< The tuple containing all (0, 1, 2, ...) results */
371 pn_Call_P_value_res_base = 4,/**< A pointer to the memory region containing copied results
372 passed by value (for compound result types). */
373 pn_Call_X_except = 1, /**< The control flow result branching to the exception handler */
374 pn_Call_M_except = 3 /**< The memory result in case the called method terminated with
376 } pn_Call; /* Projection numbers for Call. */
378 INLINE ir_node *get_Call_mem (ir_node *node);
379 INLINE void set_Call_mem (ir_node *node, ir_node *mem);
380 INLINE ir_node *get_Call_ptr (ir_node *node);
381 INLINE void set_Call_ptr (ir_node *node, ir_node *ptr);
382 INLINE ir_node **get_Call_param_arr (ir_node *node);
383 /** Gets the number of parameters of a call. */
384 INLINE int get_Call_n_params (ir_node *node);
385 /** Gets the call parameter at position pos. */
386 INLINE ir_node *get_Call_param (ir_node *node, int pos);
387 /** Sets the call parameter at position pos. */
388 INLINE void set_Call_param (ir_node *node, int pos, ir_node *param);
389 /** Gets the type of a call. */
390 INLINE type *get_Call_type (ir_node *node);
391 /** Sets the type of a call. */
392 INLINE void set_Call_type (ir_node *node, type *tp);
393 /** Gets the arity of a call. Identical to get_Call_n_params(). */
394 INLINE int get_Call_arity (ir_node *node);
396 /* Set, get and remove the callee-analysis. */
397 int get_Call_n_callees (ir_node * node);
398 entity *get_Call_callee (ir_node * node, int pos);
399 void set_Call_callee_arr (ir_node * node, int n, entity ** arr);
400 void remove_Call_callee_arr(ir_node * node);
402 ir_node *get_CallBegin_ptr (ir_node *node);
403 void set_CallBegin_ptr (ir_node *node, ir_node *ptr);
404 ir_graph *get_CallBegin_irg (ir_node *node);
405 ir_node *get_CallBegin_call (ir_node *node);
406 void set_CallBegin_call (ir_node *node, ir_node *call);
408 /* For unary and binary arithmetic operations the access to the
409 operands can be factored out. Left is the first, right the
410 second arithmetic value as listed in tech report 1999-44.
411 unops are: Minus, Abs, Not, Conv, Cast
412 binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
413 Shr, Shrs, Rot, Cmp */
414 INLINE int is_unop (ir_node *node);
415 INLINE ir_node *get_unop_op (ir_node *node);
416 INLINE void set_unop_op (ir_node *node, ir_node *op);
417 INLINE int is_binop (ir_node *node);
418 INLINE ir_node *get_binop_left (ir_node *node);
419 INLINE void set_binop_left (ir_node *node, ir_node *left);
420 INLINE ir_node *get_binop_right (ir_node *node);
421 INLINE void set_binop_right (ir_node *node, ir_node *right);
423 INLINE ir_node *get_Add_left (ir_node *node);
424 INLINE void set_Add_left (ir_node *node, ir_node *left);
425 INLINE ir_node *get_Add_right (ir_node *node);
426 INLINE void set_Add_right (ir_node *node, ir_node *right);
428 INLINE ir_node *get_Sub_left (ir_node *node);
429 INLINE void set_Sub_left (ir_node *node, ir_node *left);
430 INLINE ir_node *get_Sub_right (ir_node *node);
431 INLINE void set_Sub_right (ir_node *node, ir_node *right);
433 INLINE ir_node *get_Minus_op (ir_node *node);
434 INLINE void set_Minus_op (ir_node *node, ir_node *op);
436 INLINE ir_node *get_Mul_left (ir_node *node);
437 INLINE void set_Mul_left (ir_node *node, ir_node *left);
438 INLINE ir_node *get_Mul_right (ir_node *node);
439 INLINE void set_Mul_right (ir_node *node, ir_node *right);
441 INLINE ir_node *get_Quot_left (ir_node *node);
442 INLINE void set_Quot_left (ir_node *node, ir_node *left);
443 INLINE ir_node *get_Quot_right (ir_node *node);
444 INLINE void set_Quot_right (ir_node *node, ir_node *right);
445 INLINE ir_node *get_Quot_mem (ir_node *node);
446 INLINE void set_Quot_mem (ir_node *node, ir_node *mem);
449 pn_Quot_X_except, /**< Execution result if exception occured. */
450 pn_Quot_M, /**< Memory result. */
451 pn_Quot_res /**< Result of computation. */
452 } pn_Quot; /* Projection numbers for Quot. */
454 INLINE ir_node *get_DivMod_left (ir_node *node);
455 INLINE void set_DivMod_left (ir_node *node, ir_node *left);
456 INLINE ir_node *get_DivMod_right (ir_node *node);
457 INLINE void set_DivMod_right (ir_node *node, ir_node *right);
458 INLINE ir_node *get_DivMod_mem (ir_node *node);
459 INLINE void set_DivMod_mem (ir_node *node, ir_node *mem);
462 pn_DivMod_X_except, /**< Execution result if exception occured. */
463 pn_DivMod_M, /**< Memory result. */
464 pn_DivMod_res_div, /**< Result of computation a / b. */
465 pn_DivMod_res_mod /**< Result of computation a % b. */
466 } pn_DivMod; /* Projection numbers for DivMod. */
468 INLINE ir_node *get_Div_left (ir_node *node);
469 INLINE void set_Div_left (ir_node *node, ir_node *left);
470 INLINE ir_node *get_Div_right (ir_node *node);
471 INLINE void set_Div_right (ir_node *node, ir_node *right);
472 INLINE ir_node *get_Div_mem (ir_node *node);
473 INLINE void set_Div_mem (ir_node *node, ir_node *mem);
476 pn_Div_X_except, /**< Execution result if exception occured. */
477 pn_Div_M, /**< Memory result. */
478 pn_Div_res /**< Result of computation. */
479 } pn_Div; /* Projection numbers for Div. */
481 INLINE ir_node *get_Mod_left (ir_node *node);
482 INLINE void set_Mod_left (ir_node *node, ir_node *left);
483 INLINE ir_node *get_Mod_right (ir_node *node);
484 INLINE void set_Mod_right (ir_node *node, ir_node *right);
485 INLINE ir_node *get_Mod_mem (ir_node *node);
486 INLINE void set_Mod_mem (ir_node *node, ir_node *mem);
489 pn_Mod_X_except, /**< Execution result if exception occured. */
490 pn_Mod_M, /**< Memory result. */
491 pn_Mod_res /**< Result of computation. */
492 } pn_Mod; /* Projection numbers for Mod. */
494 INLINE ir_node *get_Abs_op (ir_node *node);
495 INLINE void set_Abs_op (ir_node *node, ir_node *op);
497 INLINE ir_node *get_And_left (ir_node *node);
498 INLINE void set_And_left (ir_node *node, ir_node *left);
499 INLINE ir_node *get_And_right (ir_node *node);
500 INLINE void set_And_right (ir_node *node, ir_node *right);
502 INLINE ir_node *get_Or_left (ir_node *node);
503 INLINE void set_Or_left (ir_node *node, ir_node *left);
504 INLINE ir_node *get_Or_right (ir_node *node);
505 INLINE void set_Or_right (ir_node *node, ir_node *right);
507 INLINE ir_node *get_Eor_left (ir_node *node);
508 INLINE void set_Eor_left (ir_node *node, ir_node *left);
509 INLINE ir_node *get_Eor_right (ir_node *node);
510 INLINE void set_Eor_right (ir_node *node, ir_node *right);
512 INLINE ir_node *get_Not_op (ir_node *node);
513 INLINE void set_Not_op (ir_node *node, ir_node *op);
515 /* Projection numbers for Cmp are defined several times.
516 The bit patterns are used for variouse tests, so don't change.
517 The "unordered" values are possible results of comparing
518 floating point numbers. */
520 pn_Cmp_False = 0, /**< false */
521 pn_Cmp_Eq, /**< equal */
522 pn_Cmp_Lt, /**< less */
523 pn_Cmp_Le, /**< less or equal */
524 pn_Cmp_Gt, /**< greater */
525 pn_Cmp_Ge, /**< greater or equal */
526 pn_Cmp_Lg, /**< less or greater */
527 pn_Cmp_Leg = 7, /**< less, equal or greater = ordered */
528 pn_Cmp_Uo, /**< unordered */
529 pn_Cmp_Ue, /**< unordered or equal */
530 pn_Cmp_Ul, /**< unordered or less */
531 pn_Cmp_Ule, /**< unordered, less or equal */
532 pn_Cmp_Ug, /**< unordered or greater */
533 pn_Cmp_Uge, /**< unordered, greater or equal */
534 pn_Cmp_Ne, /**< unordered, less or greater = not equal */
535 pn_Cmp_True = 15 /**< true */
536 /* not_mask = Leg*/ /* bits to flip to negate comparison * @@ hack for jni interface */
537 } pn_Cmp; /* Projection numbers for Cmp */
538 //#define not_mask pn_Cmp_Leg
540 INLINE const char *get_pnc_string(int pnc);
541 INLINE int get_negated_pnc(int pnc);
542 INLINE ir_node *get_Cmp_left (ir_node *node);
543 INLINE void set_Cmp_left (ir_node *node, ir_node *left);
544 INLINE ir_node *get_Cmp_right (ir_node *node);
545 INLINE void set_Cmp_right (ir_node *node, ir_node *right);
547 INLINE ir_node *get_Shl_left (ir_node *node);
548 INLINE void set_Shl_left (ir_node *node, ir_node *left);
549 INLINE ir_node *get_Shl_right (ir_node *node);
550 INLINE void set_Shl_right (ir_node *node, ir_node *right);
552 INLINE ir_node *get_Shr_left (ir_node *node);
553 INLINE void set_Shr_left (ir_node *node, ir_node *left);
554 INLINE ir_node *get_Shr_right (ir_node *node);
555 INLINE void set_Shr_right (ir_node *node, ir_node *right);
557 INLINE ir_node *get_Shrs_left (ir_node *node);
558 INLINE void set_Shrs_left (ir_node *node, ir_node *left);
559 INLINE ir_node *get_Shrs_right (ir_node *node);
560 INLINE void set_Shrs_right (ir_node *node, ir_node *right);
562 INLINE ir_node *get_Rot_left (ir_node *node);
563 INLINE void set_Rot_left (ir_node *node, ir_node *left);
564 INLINE ir_node *get_Rot_right (ir_node *node);
565 INLINE void set_Rot_right (ir_node *node, ir_node *right);
567 INLINE ir_node *get_Conv_op (ir_node *node);
568 INLINE void set_Conv_op (ir_node *node, ir_node *op);
570 /* Does Cast need a mem operator?
571 * Cast should only depend on the type, not on the state of an
572 * entity. But: we initialzie various fields after Alloc, that
573 * are accessed in the cast. This required some precaution, to
574 * get the right memory into the Loads generated from the cast.
576 INLINE ir_node *get_Cast_op (ir_node *node);
577 INLINE void set_Cast_op (ir_node *node, ir_node *op);
578 INLINE type *get_Cast_type (ir_node *node);
579 INLINE void set_Cast_type (ir_node *node, type *to_tp);
581 INLINE ir_node **get_Phi_preds_arr (ir_node *node);
582 INLINE int get_Phi_n_preds (ir_node *node);
583 INLINE ir_node *get_Phi_pred (ir_node *node, int pos);
584 INLINE void set_Phi_pred (ir_node *node, int pos, ir_node *pred);
586 INLINE ir_node *get_Filter_pred(ir_node *node);
587 INLINE void set_Filter_pred(ir_node *node, ir_node *pred);
588 INLINE long get_Filter_proj(ir_node *node);
589 INLINE void set_Filter_proj(ir_node *node, long proj);
590 /* set the interprocedural predecessors, ...d_arr uses current_ir_graph.
591 * @@@ Maybe better: arity is zero if no cg preds. */
592 void set_Filter_cg_pred_arr(ir_node * node, int arity, ir_node ** in);
593 void set_Filter_cg_pred(ir_node * node, int pos, ir_node * pred);
594 int get_Filter_n_cg_preds(ir_node *node);
595 ir_node * get_Filter_cg_pred(ir_node *node, int pos);
598 pn_Load_X_except, /**< Execution result if exception occured. */
599 pn_Load_M, /**< Memory result. */
600 pn_Load_res /**< Result of load operation. */
601 } pn_Load; /* Projection numbers for Load. */
603 INLINE ir_node *get_Load_mem (ir_node *node);
604 INLINE void set_Load_mem (ir_node *node, ir_node *mem);
605 INLINE ir_node *get_Load_ptr (ir_node *node);
606 INLINE void set_Load_ptr (ir_node *node, ir_node *ptr);
609 pn_Store_X_except, /**< Execution result if exception occured. */
610 pn_Store_M /**< Memory result. */
611 } pn_Store; /* Projection numbers for Store. */
613 INLINE ir_node *get_Store_mem (ir_node *node);
614 INLINE void set_Store_mem (ir_node *node, ir_node *mem);
615 INLINE ir_node *get_Store_ptr (ir_node *node);
616 INLINE void set_Store_ptr (ir_node *node, ir_node *ptr);
617 INLINE ir_node *get_Store_value (ir_node *node);
618 INLINE void set_Store_value (ir_node *node, ir_node *value);
621 pn_Alloc_X, /**< Execution result if exception occured. */
622 pn_Alloc_M, /**< Memory result. */
623 pn_Alloc_res /**< Result of allocation. */
624 } pn_Alloc; /* Projection numbers for Alloc. */
626 INLINE ir_node *get_Alloc_mem (ir_node *node);
627 INLINE void set_Alloc_mem (ir_node *node, ir_node *mem);
628 INLINE ir_node *get_Alloc_size (ir_node *node);
629 INLINE void set_Alloc_size (ir_node *node, ir_node *size);
630 INLINE type *get_Alloc_type (ir_node *node);
631 INLINE void set_Alloc_type (ir_node *node, type *tp);
633 /** allocation place. */
635 stack_alloc, /**< Alloc allocates the object on the stack. */
636 heap_alloc /**< Alloc allocates the object on the heap. */
639 INLINE where_alloc get_Alloc_where (ir_node *node);
640 INLINE void set_Alloc_where (ir_node *node, where_alloc where);
642 INLINE ir_node *get_Free_mem (ir_node *node);
643 INLINE void set_Free_mem (ir_node *node, ir_node *mem);
644 INLINE ir_node *get_Free_ptr (ir_node *node);
645 INLINE void set_Free_ptr (ir_node *node, ir_node *ptr);
646 INLINE ir_node *get_Free_size (ir_node *node);
647 INLINE void set_Free_size (ir_node *node, ir_node *size);
648 INLINE type *get_Free_type (ir_node *node);
649 INLINE void set_Free_type (ir_node *node, type *tp);
651 INLINE ir_node **get_Sync_preds_arr (ir_node *node);
652 INLINE int get_Sync_n_preds (ir_node *node);
653 INLINE ir_node *get_Sync_pred (ir_node *node, int pos);
654 INLINE void set_Sync_pred (ir_node *node, int pos, ir_node *pred);
656 INLINE ir_node *get_Proj_pred (ir_node *node);
657 INLINE void set_Proj_pred (ir_node *node, ir_node *pred);
658 /* Why long? shouldn't int be enough, and smaller? Or even byte? */
659 INLINE long get_Proj_proj (ir_node *node);
660 INLINE void set_Proj_proj (ir_node *node, long proj);
662 INLINE ir_node **get_Tuple_preds_arr (ir_node *node);
663 INLINE int get_Tuple_n_preds (ir_node *node);
664 INLINE ir_node *get_Tuple_pred (ir_node *node, int pos);
665 INLINE void set_Tuple_pred (ir_node *node, int pos, ir_node *pred);
667 INLINE ir_node *get_Id_pred (ir_node *node);
668 INLINE void set_Id_pred (ir_node *node, ir_node *pred);
673 * NAME Auxiliary routines
675 * Not properly documented ;-)
679 /** returns operand of node if node is a Proj. */
680 INLINE ir_node *skip_Proj (ir_node *node);
681 /** returns operand of node if node is a Id */
682 INLINE ir_node *skip_nop (ir_node *node);
683 INLINE ir_node *skip_Id (ir_node *node); /* Same as skip_nop. */
684 /* returns corresponding operand of Tuple if node is a Proj from
686 INLINE ir_node *skip_Tuple (ir_node *node);
687 /** returns true if node is a Bad node. */
688 INLINE int is_Bad (ir_node *node);
689 /** returns true if the node is not a Block */
690 INLINE int is_no_Block (ir_node *node);
691 /** returns true if the node is a Block */
692 INLINE int is_Block (ir_node *node);
693 /** returns true if node is a Proj node or a Filter node in
694 * intraprocedural view */
695 INLINE int is_Proj (const ir_node *node);
696 /** Returns true if the operation manipulates control flow:
697 Start, End, Jmp, Cond, Return, Raise, Bad, CallBegin, EndReg, EndExcept */
698 int is_cfop(ir_node *node);
700 /** Returns true if the operation manipulates interprocedural control flow:
701 CallBegin, EndReg, EndExcept */
702 int is_ip_cfop(ir_node *node);
703 /** Returns true if the operation can change the control flow because
704 of an exception: Call, Quot, DivMod, Div, Mod, Load, Store, Alloc,
706 ir_graph *get_ip_cfop_irg(ir_node *n);
708 int is_fragile_op(ir_node *node);
709 /** Returns the memory operand of fragile operations. */
710 ir_node *get_fragile_op_mem(ir_node *node);
715 /* GNU C has the __FUNCTION__ extension */
716 #define __MYFUNC__ __FUNCTION__
718 /* use Filename instead */
719 #define __MYFUNC__ __FILE__
723 Don't format with "\", firmjni gets problems */
724 /** Output location */
725 #define DDM printf("%s(l.%i).\n", __MYFUNC__, __LINE__);
726 /** Output the firm kind of the node */
727 #define DDMK(X) printf("%s(l.%i) %s: %p\n", __MYFUNC__, __LINE__, print_firm_kind(X), (void *)(X));
728 /** Output information about a node */
729 #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))
730 /** Output information about a node and its block */
731 #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)))
732 /** Output information about a type */
733 #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))
734 /** Output information about an entity */
735 #define DDME(X) printf("%s(l.%i) %s: %ld (%p)\n", __MYFUNC__, __LINE__, get_entity_name(X), get_entity_nr(X), (void *)(X))
736 /** Output information about an entity and its type */
737 #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))
738 /** Output information about an entity and its owner */
739 #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))
740 /** Output information about a graph */
741 #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))
742 /** Output information about an ident */
743 #define DDMI(X) printf("%s(l.%i) %s: %p\n", __MYFUNC__, __LINE__, id_to_str(X), (void *)(X))
744 /** Output information about a mode */
745 #define DDMM(X) printf("%s(l.%i) %s: %p\n", __MYFUNC__, __LINE__, get_mode_name(X), (void *)(X))
746 /** Output information about a loop */
747 #define DDML(X) printf("%s(l.%i) loop with depth %d: %p\n", __MYFUNC__, __LINE__, get_loop_depth(X), (void *)(X))
748 /** Output information about a tarVal */
749 #define DDMV(X) printf("%s(l.%i) tarval: ",__MYFUNC__, __LINE__); tarval_printf(X); printf(" (%p)\n", (void *)(X));
751 /*@}*/ /* end of ir_node group definition */
754 # endif /* _IRNODE_H_ */