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 address
154 of node cast to long. */
155 INLINE long get_irn_node_nr(const ir_node *node);
157 /** Returns the ir_graph this node belongs to. Only valid for
158 * CallBegin, EndReg, EndExcept and Start */
159 INLINE ir_graph *get_irn_irg(ir_node *node);
162 * irnode constructor.
163 * Create a new irnode in irg, with an op, mode, arity and
164 * some incoming irnodes.
165 * If arity is negative, a node with a dynamic array is created.
168 new_ir_node (dbg_info *db,
178 * NAME access functions for node fields.
180 * Not properly documented ;-)
184 /* This works for all except Block. To express the difference to
185 * access routines that work for all nodes we use infix "nodes". */
186 #define get_nodes_block get_nodes_Block
187 INLINE ir_node *get_nodes_Block (ir_node *node);
188 #define set_nodes_block set_nodes_Block
189 INLINE void set_nodes_Block (ir_node *node, ir_node *block);
191 /** Projection numbers for result of Start node: use for Proj nodes! */
192 /* @@@ old name convention! */
194 pns_initial_exec, /**< Projection on an executable, the initial control
196 pns_global_store, /**< Projection on the global store */
197 pns_frame_base, /**< Projection on the frame base */
198 pns_globals, /**< Projection on the pointer to the data segment
199 containing _all_ global entities. */
200 pns_args, /**< Projection on all arguments */
201 pns_value_arg_base /**< Pointer to region of compound value arguments as defined by
202 type of this method. */
203 } pns_number; /* pns: Projection Number Start */
205 pn_Start_X_initial_exec, /**< Projection on the initial control flow. */
206 pn_Start_M, /**< Projection on the initial memory. */
207 pn_Start_P_frame_base, /**< Projection on the frame base pointer. */
208 pn_Start_P_globals, /**< Projection on the pointer to the data segment
209 containing _all_ global entities. */
210 pn_Start_T_args, /**< Projection on all arguments. */
211 pn_Start_P_value_arg_base /**< Pointer to region of compound value arguments as defined by
212 type of this method. */
213 } pn_Start; /* Projection numbers for Start. */
216 /* @@@ no more supported */
217 INLINE ir_node **get_Block_cfgpred_arr (ir_node *node);
218 int get_Block_n_cfgpreds (ir_node *node);
219 INLINE ir_node *get_Block_cfgpred (ir_node *node, int pos);
220 INLINE void set_Block_cfgpred (ir_node *node, int pos, ir_node *pred);
221 INLINE bool get_Block_matured (ir_node *node);
222 INLINE void set_Block_matured (ir_node *node, bool matured);
223 INLINE unsigned long get_Block_block_visited (ir_node *node);
224 INLINE void set_Block_block_visited (ir_node *node, unsigned long visit);
225 /* For this current_ir_graph must be set. */
226 INLINE void mark_Block_block_visited(ir_node *node);
227 INLINE int Block_not_block_visited(ir_node *node);
229 /* Set and remove interprocedural predecessors. If the interprocedural
230 * predecessors are removed, the node has the same predecessors in
232 * @@@ Maybe better: arity is zero if no cg preds. */
233 void set_Block_cg_cfgpred_arr(ir_node * node, int arity, ir_node ** in);
234 void set_Block_cg_cfgpred(ir_node * node, int pos, ir_node * pred);
235 /* @@@ not supported */
236 ir_node **get_Block_cg_cfgpred_arr(ir_node * node);
237 /* Returns the number of interproc predecessors. 0 if none. */
238 int get_Block_cg_n_cfgpreds(ir_node * node);
239 ir_node *get_Block_cg_cfgpred(ir_node * node, int pos);
240 /* frees the memory. */
241 void remove_Block_cg_cfgpred_arr(ir_node * node);
243 /* Start references the irg it is in. */
244 ir_graph *get_Start_irg(ir_node *node);
245 void set_Start_irg(ir_node *node, ir_graph *irg);
247 INLINE int get_End_n_keepalives(ir_node *end);
248 INLINE ir_node *get_End_keepalive(ir_node *end, int pos);
249 INLINE void add_End_keepalive (ir_node *end, ir_node *ka);
250 INLINE void set_End_keepalive(ir_node *end, int pos, ir_node *ka);
251 /* Some parts of the End node are allocated seperately -- their memory
252 is not recovered by dead_node_elimination if a End node is dead.
253 free_End frees these data structures. */
254 INLINE void free_End (ir_node *end);
256 ir_graph *get_EndReg_irg (const ir_node *end);
257 ir_graph *get_EndExcept_irg (const ir_node *end);
259 /* We distinguish three kinds of Cond nodes. These can be distinguished
260 by the mode of the selector operand and an internal flag of type cond_kind.
261 First we distinguish binary Conds and switch Conds.
262 A binary Cond has as selector a boolean value. Proj(0) projects the control
263 flow for case "False", Proj(1) the control flow for "True". A binary Cond
264 is recognized by the boolean selector.
265 The switch Cond has as selector an unsigned integer. It produces as result
266 an n+1 Tuple (cf0, ... , cfn) of control flows.
267 We differ two flavours of this Cond. The first, the dense Cond, passes
268 control along output i if the selector value is i, 0 <= i <= n. If the
269 selector value is >n it passes control along output n.
270 The second Cond flavor differes in the treatment of cases not specified in
271 the source program. It magically knows about the existence of Proj nodes.
272 It only passes control along output i, 0 <= i <= n, if a node Proj(Cond, i)
273 exists. Else it passes control along output n (even if this Proj does not
274 exist.) This Cond we call "fragmentary". There is a special constructor
275 new_defaultProj that automatically sets the flavor.
276 The two switch flavors are distinguished by a flag of type cond_kind.
277 Default flavor is "dense"
280 dense, /**< Default. Missing Proj nodes are dead control flow. */
281 fragmentary /**< Special. No control flow optimizations allowed. Missing
282 Proj nodes mean default control flow, i.e., Proj(n). */
285 INLINE ir_node *get_Cond_selector (ir_node *node);
286 INLINE void set_Cond_selector (ir_node *node, ir_node *selector);
287 INLINE cond_kind get_Cond_kind (ir_node *node);
288 INLINE void set_Cond_kind (ir_node *node, cond_kind kind);
291 pn_Cond_false, /**< Control flow if operand is "false". */
292 pn_Cond_true /**< Control flow if operand is "true". */
293 } pn_Cond; /* Projection numbers for Cond. */
295 INLINE ir_node *get_Return_mem (ir_node *node);
296 INLINE void set_Return_mem (ir_node *node, ir_node *mem);
297 INLINE ir_node **get_Return_res_arr (ir_node *node);
298 INLINE int get_Return_n_ress (ir_node *node);
299 INLINE ir_node *get_Return_res (ir_node *node, int pos);
300 INLINE void set_Return_res (ir_node *node, int pos, ir_node *res);
302 INLINE ir_node *get_Raise_mem (ir_node *node);
303 INLINE void set_Raise_mem (ir_node *node, ir_node *mem);
304 INLINE ir_node *get_Raise_exo_ptr (ir_node *node); /* PoinTeR to EXception Object */
305 INLINE void set_Raise_exo_ptr (ir_node *node, ir_node *exoptr);
308 pn_Raise_X, /**< Execution result. */
309 pn_Raise_M /**< Memory result. */
310 } pn_Raise; /* Projection numbers for Raise. */
312 INLINE tarval *get_Const_tarval (ir_node *node);
313 INLINE void set_Const_tarval (ir_node *node, tarval *con);
314 /* The source language type. Must be an atomic type. Mode of type must
315 be mode of node. For tarvals from entities type must be pointer to
317 INLINE type *get_Const_type (ir_node *node);
318 INLINE void set_Const_type (ir_node *node, type *tp);
320 /** This enum names the three different kinds of symbolic Constants
321 represented by SymConst. The content of the attribute type_or_id
322 depends on this tag. Use the proper access routine after testing
325 type_tag, /**< The SymConst is a type tag for the given type.
326 Type_or_id_p is type *. */
327 size, /**< The SymConst is the size of the given type.
328 Type_or_id_p is type *. */
329 linkage_ptr_info /**< The SymConst is a symbolic pointer to be filled in
330 by the linker. Type_or_id_p is ident *. */
332 typedef union type_or_id * type_or_id_p;
333 INLINE symconst_kind get_SymConst_kind (const ir_node *node);
334 INLINE void set_SymConst_kind (ir_node *node, symconst_kind num);
335 /* Only to access SymConst of kind type_tag or size. Else assertion: */
336 INLINE type *get_SymConst_type (ir_node *node);
337 INLINE void set_SymConst_type (ir_node *node, type *tp);
338 /* Only to access SymConst of kind linkage_ptr_info. Else assertion: */
339 INLINE ident *get_SymConst_ptrinfo (ir_node *node);
340 INLINE void set_SymConst_ptrinfo (ir_node *node, ident *ptrinfo);
341 /* Sets both: type and ptrinfo. Needed to treat the node independent of
342 its semantics. Does a memcpy for the memory tori points to. */
343 INLINE type_or_id_p get_SymConst_type_or_id (ir_node *node);
344 INLINE void set_SymConst_type_or_id (ir_node *node, type_or_id_p tori);
346 INLINE ir_node *get_Sel_mem (ir_node *node);
347 INLINE void set_Sel_mem (ir_node *node, ir_node *mem);
348 INLINE ir_node *get_Sel_ptr (ir_node *node); /* ptr to the object to select from */
349 INLINE void set_Sel_ptr (ir_node *node, ir_node *ptr);
350 INLINE ir_node **get_Sel_index_arr (ir_node *node);
351 INLINE int get_Sel_n_indexs (ir_node *node);
352 INLINE ir_node *get_Sel_index (ir_node *node, int pos);
353 INLINE void set_Sel_index (ir_node *node, int pos, ir_node *index);
354 INLINE entity *get_Sel_entity (ir_node *node); /* entity to select */
355 INLINE void set_Sel_entity (ir_node *node, entity *ent);
357 /** Projection numbers for result of Call node: use for Proj nodes! */
358 /* @@@ old name convention! */
360 pncl_memory = 0, /**< The memory result. */
361 pncl_exc_target = 1, /**< The control flow result branching to the exception handler */
362 pncl_result_tuple = 2, /**< The tuple containing all (0, 1, 2, ...) results */
363 pncl_exc_memory = 3, /**< The memory result in case the called method terminated with
365 pncl_value_res_base = 4 /**< A pointer to the memory region containing copied results
366 passed by value (for compound result types). */
367 } pncl_number; /* pncl: Projection Number CaLl */
370 pn_Call_M_regular = 0, /**< The memory result. */
371 pn_Call_T_result = 2, /**< The tuple containing all (0, 1, 2, ...) results */
372 pn_Call_P_value_res_base = 4,/**< A pointer to the memory region containing copied results
373 passed by value (for compound result types). */
374 pn_Call_X_except = 1, /**< The control flow result branching to the exception handler */
375 pn_Call_M_except = 3 /**< The memory result in case the called method terminated with
377 } pn_Call; /* Projection numbers for Call. */
379 INLINE ir_node *get_Call_mem (ir_node *node);
380 INLINE void set_Call_mem (ir_node *node, ir_node *mem);
381 INLINE ir_node *get_Call_ptr (ir_node *node);
382 INLINE void set_Call_ptr (ir_node *node, ir_node *ptr);
383 INLINE ir_node **get_Call_param_arr (ir_node *node);
384 /** Gets the number of parameters of a call. */
385 INLINE int get_Call_n_params (ir_node *node);
386 /** Gets the call parameter at position pos. */
387 INLINE ir_node *get_Call_param (ir_node *node, int pos);
388 /** Sets the call parameter at position pos. */
389 INLINE void set_Call_param (ir_node *node, int pos, ir_node *param);
390 /** Gets the type of a call. */
391 INLINE type *get_Call_type (ir_node *node);
392 /** Sets the type of a call. */
393 INLINE void set_Call_type (ir_node *node, type *tp);
394 /** Gets the arity of a call. Identical to get_Call_n_params(). */
395 INLINE int get_Call_arity (ir_node *node);
397 /* Set, get and remove the callee-analysis. */
398 int get_Call_n_callees (ir_node * node);
399 entity *get_Call_callee (ir_node * node, int pos);
400 void set_Call_callee_arr (ir_node * node, int n, entity ** arr);
401 void remove_Call_callee_arr(ir_node * node);
403 ir_node *get_CallBegin_ptr (ir_node *node);
404 void set_CallBegin_ptr (ir_node *node, ir_node *ptr);
405 ir_graph *get_CallBegin_irg (ir_node *node);
406 ir_node *get_CallBegin_call (ir_node *node);
407 void set_CallBegin_call (ir_node *node, ir_node *call);
409 /* For unary and binary arithmetic operations the access to the
410 operands can be factored out. Left is the first, right the
411 second arithmetic value as listed in tech report 1999-44.
412 unops are: Minus, Abs, Not, Conv, Cast
413 binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
414 Shr, Shrs, Rot, Cmp */
415 INLINE int is_unop (ir_node *node);
416 INLINE ir_node *get_unop_op (ir_node *node);
417 INLINE void set_unop_op (ir_node *node, ir_node *op);
418 INLINE int is_binop (ir_node *node);
419 INLINE ir_node *get_binop_left (ir_node *node);
420 INLINE void set_binop_left (ir_node *node, ir_node *left);
421 INLINE ir_node *get_binop_right (ir_node *node);
422 INLINE void set_binop_right (ir_node *node, ir_node *right);
424 INLINE ir_node *get_Add_left (ir_node *node);
425 INLINE void set_Add_left (ir_node *node, ir_node *left);
426 INLINE ir_node *get_Add_right (ir_node *node);
427 INLINE void set_Add_right (ir_node *node, ir_node *right);
429 INLINE ir_node *get_Sub_left (ir_node *node);
430 INLINE void set_Sub_left (ir_node *node, ir_node *left);
431 INLINE ir_node *get_Sub_right (ir_node *node);
432 INLINE void set_Sub_right (ir_node *node, ir_node *right);
434 INLINE ir_node *get_Minus_op (ir_node *node);
435 INLINE void set_Minus_op (ir_node *node, ir_node *op);
437 INLINE ir_node *get_Mul_left (ir_node *node);
438 INLINE void set_Mul_left (ir_node *node, ir_node *left);
439 INLINE ir_node *get_Mul_right (ir_node *node);
440 INLINE void set_Mul_right (ir_node *node, ir_node *right);
442 INLINE ir_node *get_Quot_left (ir_node *node);
443 INLINE void set_Quot_left (ir_node *node, ir_node *left);
444 INLINE ir_node *get_Quot_right (ir_node *node);
445 INLINE void set_Quot_right (ir_node *node, ir_node *right);
446 INLINE ir_node *get_Quot_mem (ir_node *node);
447 INLINE void set_Quot_mem (ir_node *node, ir_node *mem);
450 pn_Quot_X_except, /**< Execution result if exception occured. */
451 pn_Quot_M, /**< Memory result. */
452 pn_Quot_res /**< Result of computation. */
453 } pn_Quot; /* Projection numbers for Quot. */
455 INLINE ir_node *get_DivMod_left (ir_node *node);
456 INLINE void set_DivMod_left (ir_node *node, ir_node *left);
457 INLINE ir_node *get_DivMod_right (ir_node *node);
458 INLINE void set_DivMod_right (ir_node *node, ir_node *right);
459 INLINE ir_node *get_DivMod_mem (ir_node *node);
460 INLINE void set_DivMod_mem (ir_node *node, ir_node *mem);
463 pn_DivMod_X_except, /**< Execution result if exception occured. */
464 pn_DivMod_M, /**< Memory result. */
465 pn_DivMod_res_div, /**< Result of computation a / b. */
466 pn_DivMod_res_mod /**< Result of computation a % b. */
467 } pn_DivMod; /* Projection numbers for DivMod. */
469 INLINE ir_node *get_Div_left (ir_node *node);
470 INLINE void set_Div_left (ir_node *node, ir_node *left);
471 INLINE ir_node *get_Div_right (ir_node *node);
472 INLINE void set_Div_right (ir_node *node, ir_node *right);
473 INLINE ir_node *get_Div_mem (ir_node *node);
474 INLINE void set_Div_mem (ir_node *node, ir_node *mem);
477 pn_Div_X_except, /**< Execution result if exception occured. */
478 pn_Div_M, /**< Memory result. */
479 pn_Div_res /**< Result of computation. */
480 } pn_Div; /* Projection numbers for Div. */
482 INLINE ir_node *get_Mod_left (ir_node *node);
483 INLINE void set_Mod_left (ir_node *node, ir_node *left);
484 INLINE ir_node *get_Mod_right (ir_node *node);
485 INLINE void set_Mod_right (ir_node *node, ir_node *right);
486 INLINE ir_node *get_Mod_mem (ir_node *node);
487 INLINE void set_Mod_mem (ir_node *node, ir_node *mem);
490 pn_Mod_X_except, /**< Execution result if exception occured. */
491 pn_Mod_M, /**< Memory result. */
492 pn_Mod_res /**< Result of computation. */
493 } pn_Mod; /* Projection numbers for Mod. */
495 INLINE ir_node *get_Abs_op (ir_node *node);
496 INLINE void set_Abs_op (ir_node *node, ir_node *op);
498 INLINE ir_node *get_And_left (ir_node *node);
499 INLINE void set_And_left (ir_node *node, ir_node *left);
500 INLINE ir_node *get_And_right (ir_node *node);
501 INLINE void set_And_right (ir_node *node, ir_node *right);
503 INLINE ir_node *get_Or_left (ir_node *node);
504 INLINE void set_Or_left (ir_node *node, ir_node *left);
505 INLINE ir_node *get_Or_right (ir_node *node);
506 INLINE void set_Or_right (ir_node *node, ir_node *right);
508 INLINE ir_node *get_Eor_left (ir_node *node);
509 INLINE void set_Eor_left (ir_node *node, ir_node *left);
510 INLINE ir_node *get_Eor_right (ir_node *node);
511 INLINE void set_Eor_right (ir_node *node, ir_node *right);
513 INLINE ir_node *get_Not_op (ir_node *node);
514 INLINE void set_Not_op (ir_node *node, ir_node *op);
516 /* Projection numbers for Cmp are defined several times.
517 The bit patterns are used for variouse tests, so don't change.
518 The "unordered" values are possible results of comparing
519 floating point numbers. */
521 pn_Cmp_False = 0, /**< false */
522 pn_Cmp_Eq, /**< equal */
523 pn_Cmp_Lt, /**< less */
524 pn_Cmp_Le, /**< less or equal */
525 pn_Cmp_Gt, /**< greater */
526 pn_Cmp_Ge, /**< greater or equal */
527 pn_Cmp_Lg, /**< less or greater */
528 pn_Cmp_Leg = 7, /**< less, equal or greater = ordered */
529 pn_Cmp_Uo, /**< unordered */
530 pn_Cmp_Ue, /**< unordered or equal */
531 pn_Cmp_Ul, /**< unordered or less */
532 pn_Cmp_Ule, /**< unordered, less or equal */
533 pn_Cmp_Ug, /**< unordered or greater */
534 pn_Cmp_Uge, /**< unordered, greater or equal */
535 pn_Cmp_Ne, /**< unordered, less or greater = not equal */
536 pn_Cmp_True = 15 /**< true */
537 /* not_mask = Leg*/ /* bits to flip to negate comparison * @@ hack for jni interface */
538 } pn_Cmp; /* Projection numbers for Cmp */
539 //#define not_mask pn_Cmp_Leg
541 INLINE const char *get_pnc_string(int pnc);
542 INLINE int get_negated_pnc(int pnc);
543 INLINE ir_node *get_Cmp_left (ir_node *node);
544 INLINE void set_Cmp_left (ir_node *node, ir_node *left);
545 INLINE ir_node *get_Cmp_right (ir_node *node);
546 INLINE void set_Cmp_right (ir_node *node, ir_node *right);
548 INLINE ir_node *get_Shl_left (ir_node *node);
549 INLINE void set_Shl_left (ir_node *node, ir_node *left);
550 INLINE ir_node *get_Shl_right (ir_node *node);
551 INLINE void set_Shl_right (ir_node *node, ir_node *right);
553 INLINE ir_node *get_Shr_left (ir_node *node);
554 INLINE void set_Shr_left (ir_node *node, ir_node *left);
555 INLINE ir_node *get_Shr_right (ir_node *node);
556 INLINE void set_Shr_right (ir_node *node, ir_node *right);
558 INLINE ir_node *get_Shrs_left (ir_node *node);
559 INLINE void set_Shrs_left (ir_node *node, ir_node *left);
560 INLINE ir_node *get_Shrs_right (ir_node *node);
561 INLINE void set_Shrs_right (ir_node *node, ir_node *right);
563 INLINE ir_node *get_Rot_left (ir_node *node);
564 INLINE void set_Rot_left (ir_node *node, ir_node *left);
565 INLINE ir_node *get_Rot_right (ir_node *node);
566 INLINE void set_Rot_right (ir_node *node, ir_node *right);
568 INLINE ir_node *get_Conv_op (ir_node *node);
569 INLINE void set_Conv_op (ir_node *node, ir_node *op);
571 /* Does Cast need a mem operator?
572 * Cast should only depend on the type, not on the state of an
573 * entity. But: we initialzie various fields after Alloc, that
574 * are accessed in the cast. This required some precaution, to
575 * get the right memory into the Loads generated from the cast.
577 INLINE ir_node *get_Cast_op (ir_node *node);
578 INLINE void set_Cast_op (ir_node *node, ir_node *op);
579 INLINE type *get_Cast_type (ir_node *node);
580 INLINE void set_Cast_type (ir_node *node, type *to_tp);
582 INLINE ir_node **get_Phi_preds_arr (ir_node *node);
583 INLINE int get_Phi_n_preds (ir_node *node);
584 INLINE ir_node *get_Phi_pred (ir_node *node, int pos);
585 INLINE void set_Phi_pred (ir_node *node, int pos, ir_node *pred);
587 INLINE ir_node *get_Filter_pred(ir_node *node);
588 INLINE void set_Filter_pred(ir_node *node, ir_node *pred);
589 INLINE long get_Filter_proj(ir_node *node);
590 INLINE void set_Filter_proj(ir_node *node, long proj);
591 /* set the interprocedural predecessors, ...d_arr uses current_ir_graph.
592 * @@@ Maybe better: arity is zero if no cg preds. */
593 void set_Filter_cg_pred_arr(ir_node * node, int arity, ir_node ** in);
594 void set_Filter_cg_pred(ir_node * node, int pos, ir_node * pred);
595 int get_Filter_n_cg_preds(ir_node *node);
596 ir_node * get_Filter_cg_pred(ir_node *node, int pos);
599 pn_Load_X_except, /**< Execution result if exception occured. */
600 pn_Load_M, /**< Memory result. */
601 pn_Load_res /**< Result of load operation. */
602 } pn_Load; /* Projection numbers for Load. */
604 INLINE ir_node *get_Load_mem (ir_node *node);
605 INLINE void set_Load_mem (ir_node *node, ir_node *mem);
606 INLINE ir_node *get_Load_ptr (ir_node *node);
607 INLINE void set_Load_ptr (ir_node *node, ir_node *ptr);
610 pn_Store_X_except, /**< Execution result if exception occured. */
611 pn_Store_M /**< Memory result. */
612 } pn_Store; /* Projection numbers for Store. */
614 INLINE ir_node *get_Store_mem (ir_node *node);
615 INLINE void set_Store_mem (ir_node *node, ir_node *mem);
616 INLINE ir_node *get_Store_ptr (ir_node *node);
617 INLINE void set_Store_ptr (ir_node *node, ir_node *ptr);
618 INLINE ir_node *get_Store_value (ir_node *node);
619 INLINE void set_Store_value (ir_node *node, ir_node *value);
622 pn_Alloc_X, /**< Execution result if exception occured. */
623 pn_Alloc_M, /**< Memory result. */
624 pn_Alloc_res /**< Result of allocation. */
625 } pn_Alloc; /* Projection numbers for Alloc. */
627 INLINE ir_node *get_Alloc_mem (ir_node *node);
628 INLINE void set_Alloc_mem (ir_node *node, ir_node *mem);
629 INLINE ir_node *get_Alloc_size (ir_node *node);
630 INLINE void set_Alloc_size (ir_node *node, ir_node *size);
631 INLINE type *get_Alloc_type (ir_node *node);
632 INLINE void set_Alloc_type (ir_node *node, type *tp);
634 /** allocation place. */
636 stack_alloc, /**< Alloc allocates the object on the stack. */
637 heap_alloc /**< Alloc allocates the object on the heap. */
640 INLINE where_alloc get_Alloc_where (ir_node *node);
641 INLINE void set_Alloc_where (ir_node *node, where_alloc where);
643 INLINE ir_node *get_Free_mem (ir_node *node);
644 INLINE void set_Free_mem (ir_node *node, ir_node *mem);
645 INLINE ir_node *get_Free_ptr (ir_node *node);
646 INLINE void set_Free_ptr (ir_node *node, ir_node *ptr);
647 INLINE ir_node *get_Free_size (ir_node *node);
648 INLINE void set_Free_size (ir_node *node, ir_node *size);
649 INLINE type *get_Free_type (ir_node *node);
650 INLINE void set_Free_type (ir_node *node, type *tp);
652 INLINE ir_node **get_Sync_preds_arr (ir_node *node);
653 INLINE int get_Sync_n_preds (ir_node *node);
654 INLINE ir_node *get_Sync_pred (ir_node *node, int pos);
655 INLINE void set_Sync_pred (ir_node *node, int pos, ir_node *pred);
657 INLINE ir_node *get_Proj_pred (ir_node *node);
658 INLINE void set_Proj_pred (ir_node *node, ir_node *pred);
659 /* Why long? shouldn't int be enough, and smaller? Or even byte? */
660 INLINE long get_Proj_proj (ir_node *node);
661 INLINE void set_Proj_proj (ir_node *node, long proj);
663 INLINE ir_node **get_Tuple_preds_arr (ir_node *node);
664 INLINE int get_Tuple_n_preds (ir_node *node);
665 INLINE ir_node *get_Tuple_pred (ir_node *node, int pos);
666 INLINE void set_Tuple_pred (ir_node *node, int pos, ir_node *pred);
668 INLINE ir_node *get_Id_pred (ir_node *node);
669 INLINE void set_Id_pred (ir_node *node, ir_node *pred);
671 /** Confirm has a single result and returns 'value' unchanged.
672 * The node expresses a restriction on 'value':
673 * 'value' 'cmp' 'bound' == true. */
674 INLINE ir_node *get_Confirm_value (ir_node *node);
675 INLINE void set_Confirm_value (ir_node *node, ir_node *value);
676 INLINE ir_node *get_Confirm_bound (ir_node *node);
677 INLINE void set_Confirm_bound (ir_node *node, ir_node *bound);
678 INLINE pn_Cmp get_Confirm_cmp (ir_node *node);
679 INLINE void set_Confirm_cmp (ir_node *node, pn_Cmp cmp);
683 * NAME Auxiliary routines
685 * Not properly documented ;-)
689 /** returns operand of node if node is a Proj. */
690 INLINE ir_node *skip_Proj (ir_node *node);
691 /** returns operand of node if node is a Id */
692 INLINE ir_node *skip_nop (ir_node *node);
693 INLINE ir_node *skip_Id (ir_node *node); /* Same as skip_nop. */
694 /* returns corresponding operand of Tuple if node is a Proj from
696 INLINE ir_node *skip_Tuple (ir_node *node);
697 /** returns true if node is a Bad node. */
698 INLINE int is_Bad (ir_node *node);
699 /** returns true if the node is not a Block */
700 INLINE int is_no_Block (ir_node *node);
701 /** returns true if the node is a Block */
702 INLINE int is_Block (ir_node *node);
703 /** returns true if node is a Proj node or a Filter node in
704 * intraprocedural view */
705 INLINE int is_Proj (const ir_node *node);
706 /** Returns true if the operation manipulates control flow:
707 Start, End, Jmp, Cond, Return, Raise, Bad, CallBegin, EndReg, EndExcept */
708 int is_cfop(ir_node *node);
710 /** Returns true if the operation manipulates interprocedural control flow:
711 CallBegin, EndReg, EndExcept */
712 int is_ip_cfop(ir_node *node);
713 /** Returns true if the operation can change the control flow because
714 of an exception: Call, Quot, DivMod, Div, Mod, Load, Store, Alloc,
716 ir_graph *get_ip_cfop_irg(ir_node *n);
718 int is_fragile_op(ir_node *node);
719 /** Returns the memory operand of fragile operations. */
720 ir_node *get_fragile_op_mem(ir_node *node);
725 /* GNU C has the __FUNCTION__ extension */
726 #define __MYFUNC__ __FUNCTION__
728 /* use Filename instead */
729 #define __MYFUNC__ __FILE__
733 Don't format with "\", firmjni gets problems */
734 /** Output location */
735 #define DDM printf("%s(l.%i).\n", __MYFUNC__, __LINE__);
736 /** Output the firm kind of the node */
737 #define DDMK(X) printf("%s(l.%i) %s: %p\n", __MYFUNC__, __LINE__, print_firm_kind(X), (void *)(X));
738 /** Output information about a node */
739 #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))
740 /** Output information about a node and its block */
741 #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)))
742 /** Output information about a type */
743 #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))
744 /** Output information about an entity */
745 #define DDME(X) printf("%s(l.%i) %s: %ld (%p)\n", __MYFUNC__, __LINE__, get_entity_name(X), get_entity_nr(X), (void *)(X))
746 /** Output information about an entity and its type */
747 #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))
748 /** Output information about an entity and its owner */
749 #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))
750 /** Output information about a graph */
751 #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))
752 /** Output information about an ident */
753 #define DDMI(X) printf("%s(l.%i) %s: %p\n", __MYFUNC__, __LINE__, id_to_str(X), (void *)(X))
754 /** Output information about a mode */
755 #define DDMM(X) printf("%s(l.%i) %s: %p\n", __MYFUNC__, __LINE__, get_mode_name(X), (void *)(X))
756 /** Output information about a loop */
757 #define DDML(X) printf("%s(l.%i) loop with depth %d: %p\n", __MYFUNC__, __LINE__, get_loop_depth(X), (void *)(X))
758 /** Output information about a tarVal */
759 #define DDMV(X) printf("%s(l.%i) tarval: ",__MYFUNC__, __LINE__); tarval_printf(X); printf(" (%p)\n", (void *)(X));
761 /*@}*/ /* end of ir_node group definition */
764 # endif /* _IRNODE_H_ */