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);
105 INLINE int get_irn_intra_arity (const ir_node *node);
106 INLINE int get_irn_inter_arity (const ir_node *node);
108 /** Replaces the old in array by a new one that will contain the ins given in
109 the parameters. Conserves the block predecessor. It copies the array passed.
110 This function is necessary to ajust in arrays of blocks, calls and phis.
111 Assumes that current_ir_graph is set to the graph containing "node".
112 "in" must contain all predecessors except the block that are required for
114 INLINE void set_irn_in (ir_node *node, int arity,
116 /* to iterate through the predecessors without touching the array. No
117 order of predecessors guaranteed.
118 To iterate over the operands iterate from 0 to i < get_irn_arity(),
119 to iterate including the Block predecessor iterate from i = -1 to
120 i < get_irn_arity. */
121 /* Access predecessor n */
122 /* get_irn_n removes Id predecessors. */
123 INLINE ir_node *get_irn_n (ir_node *node, int n);
124 INLINE ir_node *get_irn_intra_n (ir_node *node, int n);
125 INLINE ir_node *get_irn_inter_n (ir_node *node, int n);
126 INLINE void set_irn_n (ir_node *node, int n, ir_node *in);
127 /** Sets the mode struct of node */
128 INLINE void set_irn_mode (ir_node *node, ir_mode *mode);
129 /** Gets the mode struct. */
130 INLINE ir_mode *get_irn_mode (const ir_node *node);
131 /** Gets the mode-enum modecode. */
132 INLINE modecode get_irn_modecode (const ir_node *node);
133 /** Gets the ident for a string representation of the mode .*/
134 INLINE ident *get_irn_modeident (const ir_node *node);
135 /** Gets the string representation of the mode .*/
136 INLINE const char *get_irn_modename (const ir_node *node);
137 /** Gets the opcode struct of the node */
138 INLINE ir_op *get_irn_op (const ir_node *node);
139 /** Sets the opcode struct of the node. */
140 INLINE void set_irn_op (ir_node *node, ir_op *op);
141 /** Gets the opcode-enum of the node. */
142 INLINE opcode get_irn_opcode (const ir_node *node);
143 /** Get the string representation of the opcode. */
144 INLINE const char *get_irn_opname (const ir_node *node);
145 /** Get the ident for a string representation of the opcode. */
146 INLINE ident *get_irn_opident (const ir_node *node);
147 INLINE unsigned long get_irn_visited (const ir_node *node);
148 INLINE void set_irn_visited (ir_node *node, unsigned long visited);
149 /** Sets visited to get_irg_visited(current_ir_graph). */
150 INLINE void mark_irn_visited (ir_node *node);
151 /** Returns 1 if visited < get_irg_visited(current_ir_graph). */
152 INLINE int irn_not_visited (const ir_node *node);
153 /** Returns 1 if visited >= get_irg_visited(current_ir_graph). */
154 INLINE int irn_visited (const ir_node *node);
155 INLINE void set_irn_link (ir_node *node, void *link);
156 INLINE void *get_irn_link (const ir_node *node);
158 /** Returns the ir_graph this node belongs to. Only valid if irg
159 * is in state pinned (irg is only stored in the block. */
160 INLINE ir_graph *get_irn_irg (ir_node *node);
162 /** Outputs a unique number for this node if libfirm is compiled for
163 debugging, (configure with --enable-debug) else returns address
164 of node cast to long. */
165 INLINE long get_irn_node_nr (const ir_node *node);
169 * irnode constructor.
170 * Create a new irnode in irg, with an op, mode, arity and
171 * some incoming irnodes.
172 * If arity is negative, a node with a dynamic array is created.
175 new_ir_node (dbg_info *db,
185 * NAME access functions for node fields.
187 * Not properly documented ;-)
191 /* This works for all except Block. To express the difference to
192 * access routines that work for all nodes we use infix "nodes". */
193 #define get_nodes_block get_nodes_Block
194 INLINE ir_node *get_nodes_Block (ir_node *node);
195 #define set_nodes_block set_nodes_Block
196 INLINE void set_nodes_Block (ir_node *node, ir_node *block);
198 /** Projection numbers for result of Start node: use for Proj nodes! */
199 /* @@@ old name convention! */
201 pns_initial_exec, /**< Projection on an executable, the initial control
203 pns_global_store, /**< Projection on the global store */
204 pns_frame_base, /**< Projection on the frame base */
205 pns_globals, /**< Projection on the pointer to the data segment
206 containing _all_ global entities. */
207 pns_args, /**< Projection on all arguments */
208 pns_value_arg_base /**< Pointer to region of compound value arguments as defined by
209 type of this method. */
210 } pns_number; /* pns: Projection Number Start */
212 pn_Start_X_initial_exec, /**< Projection on the initial control flow. */
213 pn_Start_M, /**< Projection on the initial memory. */
214 pn_Start_P_frame_base, /**< Projection on the frame base pointer. */
215 pn_Start_P_globals, /**< Projection on the pointer to the data segment
216 containing _all_ global entities. */
217 pn_Start_T_args, /**< Projection on all arguments. */
218 pn_Start_P_value_arg_base /**< Pointer to region of compound value arguments as defined by
219 type of this method. */
220 } pn_Start; /* Projection numbers for Start. */
222 /** Test whether arbitrary node is frame pointer.
224 * Test whether arbitrary node is frame pointer, i.e. Proj(pn_Start_P_frame_base)
225 * from Start. If so returns frame type, else Null. */
226 type *is_frame_pointer(ir_node *n);
228 /** Test whether arbitrary node is globals pointer.
230 * Test whether arbitrary node is globals pointer, i.e. Proj(pn_Start_P_globals)
231 * from Start. If so returns global type, else Null. */
232 type *is_globals_pointer(ir_node *n);
234 /** Test whether arbitrary node is value arg base.
236 * Test whether arbitrary node is value arg base, i.e. Proj(pn_Start_P_value_arg_base)
237 * from Start. If so returns 1, else 0. */
238 int is_value_arg_pointer(ir_node *n);
241 /* @@@ no more supported */
242 INLINE ir_node **get_Block_cfgpred_arr (ir_node *node);
243 int get_Block_n_cfgpreds (ir_node *node);
244 INLINE ir_node *get_Block_cfgpred (ir_node *node, int pos);
245 INLINE void set_Block_cfgpred (ir_node *node, int pos, ir_node *pred);
246 INLINE bool get_Block_matured (ir_node *node);
247 INLINE void set_Block_matured (ir_node *node, bool matured);
248 INLINE unsigned long get_Block_block_visited (ir_node *node);
249 INLINE void set_Block_block_visited (ir_node *node, unsigned long visit);
250 /* For this current_ir_graph must be set. */
251 INLINE void mark_Block_block_visited(ir_node *node);
252 INLINE int Block_not_block_visited(ir_node *node);
254 /* Set and remove interprocedural predecessors. If the interprocedural
255 * predecessors are removed, the node has the same predecessors in
257 * @@@ Maybe better: arity is zero if no cg preds. */
258 void set_Block_cg_cfgpred_arr(ir_node * node, int arity, ir_node ** in);
259 void set_Block_cg_cfgpred(ir_node * node, int pos, ir_node * pred);
260 /* @@@ not supported */
261 ir_node **get_Block_cg_cfgpred_arr(ir_node * node);
262 /* Returns the number of interproc predecessors. 0 if none. */
263 int get_Block_cg_n_cfgpreds(ir_node * node);
264 ir_node *get_Block_cg_cfgpred(ir_node * node, int pos);
265 /* frees the memory. */
266 void remove_Block_cg_cfgpred_arr(ir_node * node);
268 /* Start references the irg it is in.
269 @@@ old -- use get_irn_irg instead! */
270 ir_graph *get_Start_irg(ir_node *node);
272 INLINE int get_End_n_keepalives(ir_node *end);
273 INLINE ir_node *get_End_keepalive(ir_node *end, int pos);
274 INLINE void add_End_keepalive (ir_node *end, ir_node *ka);
275 INLINE void set_End_keepalive(ir_node *end, int pos, ir_node *ka);
276 /* Some parts of the End node are allocated seperately -- their memory
277 is not recovered by dead_node_elimination if a End node is dead.
278 free_End frees these data structures. */
279 INLINE void free_End (ir_node *end);
281 /* @@@ old -- use get_irn_irg instead! */
282 ir_graph *get_EndReg_irg (ir_node *end);
283 ir_graph *get_EndExcept_irg (ir_node *end);
285 /* We distinguish three kinds of Cond nodes. These can be distinguished
286 by the mode of the selector operand and an internal flag of type cond_kind.
287 First we distinguish binary Conds and switch Conds.
288 A binary Cond has as selector a boolean value. Proj(0) projects the control
289 flow for case "False", Proj(1) the control flow for "True". A binary Cond
290 is recognized by the boolean selector.
291 The switch Cond has as selector an unsigned integer. It produces as result
292 an n+1 Tuple (cf0, ... , cfn) of control flows.
293 We differ two flavours of this Cond. The first, the dense Cond, passes
294 control along output i if the selector value is i, 0 <= i <= n. If the
295 selector value is >n it passes control along output n.
296 The second Cond flavor differes in the treatment of cases not specified in
297 the source program. It magically knows about the existence of Proj nodes.
298 It only passes control along output i, 0 <= i <= n, if a node Proj(Cond, i)
299 exists. Else it passes control along output n (even if this Proj does not
300 exist.) This Cond we call "fragmentary". There is a special constructor
301 new_defaultProj that automatically sets the flavor.
302 The two switch flavors are distinguished by a flag of type cond_kind.
303 Default flavor is "dense"
306 dense, /**< Default. Missing Proj nodes are dead control flow. */
307 fragmentary /**< Special. No control flow optimizations allowed. Missing
308 Proj nodes mean default control flow, i.e., Proj(n). */
311 INLINE ir_node *get_Cond_selector (ir_node *node);
312 INLINE void set_Cond_selector (ir_node *node, ir_node *selector);
313 INLINE cond_kind get_Cond_kind (ir_node *node);
314 INLINE void set_Cond_kind (ir_node *node, cond_kind kind);
317 pn_Cond_false, /**< Control flow if operand is "false". */
318 pn_Cond_true /**< Control flow if operand is "true". */
319 } pn_Cond; /* Projection numbers for Cond. */
321 INLINE ir_node *get_Return_mem (ir_node *node);
322 INLINE void set_Return_mem (ir_node *node, ir_node *mem);
323 INLINE ir_node **get_Return_res_arr (ir_node *node);
324 INLINE int get_Return_n_ress (ir_node *node);
325 INLINE ir_node *get_Return_res (ir_node *node, int pos);
326 INLINE void set_Return_res (ir_node *node, int pos, ir_node *res);
328 INLINE ir_node *get_Raise_mem (ir_node *node);
329 INLINE void set_Raise_mem (ir_node *node, ir_node *mem);
330 INLINE ir_node *get_Raise_exo_ptr (ir_node *node); /* PoinTeR to EXception Object */
331 INLINE void set_Raise_exo_ptr (ir_node *node, ir_node *exoptr);
334 pn_Raise_X, /**< Execution result. */
335 pn_Raise_M /**< Memory result. */
336 } pn_Raise; /* Projection numbers for Raise. */
338 INLINE tarval *get_Const_tarval (ir_node *node);
339 INLINE void set_Const_tarval (ir_node *node, tarval *con);
340 /* The source language type. Must be an atomic type. Mode of type must
341 be mode of node. For tarvals from entities type must be pointer to
343 INLINE type *get_Const_type (ir_node *node);
344 INLINE void set_Const_type (ir_node *node, type *tp);
346 /** This enum names the three different kinds of symbolic Constants
347 represented by SymConst. The content of the attribute type_or_id
348 depends on this tag. Use the proper access routine after testing
351 type_tag, /**< The SymConst is a type tag for the given type.
352 Type_or_id_p is type *. */
353 size, /**< The SymConst is the size of the given type.
354 Type_or_id_p is type *. */
355 linkage_ptr_info /**< The SymConst is a symbolic pointer to be filled in
356 by the linker. Type_or_id_p is ident *. */
358 typedef union type_or_id * type_or_id_p;
359 INLINE symconst_kind get_SymConst_kind (const ir_node *node);
360 INLINE void set_SymConst_kind (ir_node *node, symconst_kind num);
361 /* Only to access SymConst of kind type_tag or size. Else assertion: */
362 INLINE type *get_SymConst_type (ir_node *node);
363 INLINE void set_SymConst_type (ir_node *node, type *tp);
364 /* Only to access SymConst of kind linkage_ptr_info. Else assertion: */
365 INLINE ident *get_SymConst_ptrinfo (ir_node *node);
366 INLINE void set_SymConst_ptrinfo (ir_node *node, ident *ptrinfo);
367 /* Sets both: type and ptrinfo. Needed to treat the node independent of
368 its semantics. Does a memcpy for the memory tori points to. */
369 INLINE type_or_id_p get_SymConst_type_or_id (ir_node *node);
370 INLINE void set_SymConst_type_or_id (ir_node *node, type_or_id_p tori);
372 INLINE ir_node *get_Sel_mem (ir_node *node);
373 INLINE void set_Sel_mem (ir_node *node, ir_node *mem);
374 INLINE ir_node *get_Sel_ptr (ir_node *node); /* ptr to the object to select from */
375 INLINE void set_Sel_ptr (ir_node *node, ir_node *ptr);
376 INLINE ir_node **get_Sel_index_arr (ir_node *node);
377 INLINE int get_Sel_n_indexs (ir_node *node);
378 INLINE ir_node *get_Sel_index (ir_node *node, int pos);
379 INLINE void set_Sel_index (ir_node *node, int pos, ir_node *index);
380 INLINE entity *get_Sel_entity (ir_node *node); /* entity to select */
381 INLINE void set_Sel_entity (ir_node *node, entity *ent);
383 /** Projection numbers for result of Call node: use for Proj nodes! */
384 /* @@@ old name convention! */
386 pncl_memory = 0, /**< The memory result. */
387 pncl_exc_target = 1, /**< The control flow result branching to the exception handler */
388 pncl_result_tuple = 2, /**< The tuple containing all (0, 1, 2, ...) results */
389 pncl_exc_memory = 3, /**< The memory result in case the called method terminated with
391 pncl_value_res_base = 4 /**< A pointer to the memory region containing copied results
392 passed by value (for compound result types). */
393 } pncl_number; /* pncl: Projection Number CaLl */
396 pn_Call_M_regular = 0, /**< The memory result. */
397 pn_Call_T_result = 2, /**< The tuple containing all (0, 1, 2, ...) results */
398 pn_Call_P_value_res_base = 4,/**< A pointer to the memory region containing copied results
399 passed by value (for compound result types). */
400 pn_Call_X_except = 1, /**< The control flow result branching to the exception handler */
401 pn_Call_M_except = 3 /**< The memory result in case the called method terminated with
403 } pn_Call; /* Projection numbers for Call. */
405 INLINE ir_node *get_Call_mem (ir_node *node);
406 INLINE void set_Call_mem (ir_node *node, ir_node *mem);
407 INLINE ir_node *get_Call_ptr (ir_node *node);
408 INLINE void set_Call_ptr (ir_node *node, ir_node *ptr);
409 INLINE ir_node **get_Call_param_arr (ir_node *node);
410 /** Gets the number of parameters of a call. */
411 INLINE int get_Call_n_params (ir_node *node);
412 /** Gets the call parameter at position pos. */
413 INLINE ir_node *get_Call_param (ir_node *node, int pos);
414 /** Sets the call parameter at position pos. */
415 INLINE void set_Call_param (ir_node *node, int pos, ir_node *param);
416 /** Gets the type of a call. */
417 INLINE type *get_Call_type (ir_node *node);
418 /** Sets the type of a call. */
419 INLINE void set_Call_type (ir_node *node, type *tp);
420 /** Gets the arity of a call. Identical to get_Call_n_params(). */
421 INLINE int get_Call_arity (ir_node *node);
423 /* Set, get and remove the callee-analysis.
424 The array is only accessible if intformation is valid.
425 It contains NULL for called methods that are not within
426 the compilation unit. */
427 int Call_has_callees (ir_node *node);
428 int get_Call_n_callees (ir_node * node);
429 entity *get_Call_callee (ir_node * node, int pos);
430 void set_Call_callee_arr (ir_node * node, int n, entity ** arr);
431 void remove_Call_callee_arr(ir_node * node);
433 ir_node *get_CallBegin_ptr (ir_node *node);
434 void set_CallBegin_ptr (ir_node *node, ir_node *ptr);
435 /* @@@ old -- use get_irn_irg instead! */
436 ir_graph *get_CallBegin_irg (ir_node *node);
437 ir_node *get_CallBegin_call (ir_node *node);
438 void set_CallBegin_call (ir_node *node, ir_node *call);
440 /* For unary and binary arithmetic operations the access to the
441 operands can be factored out. Left is the first, right the
442 second arithmetic value as listed in tech report 1999-44.
443 unops are: Minus, Abs, Not, Conv, Cast
444 binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
445 Shr, Shrs, Rot, Cmp */
446 INLINE int is_unop (ir_node *node);
447 INLINE ir_node *get_unop_op (ir_node *node);
448 INLINE void set_unop_op (ir_node *node, ir_node *op);
449 INLINE int is_binop (ir_node *node);
450 INLINE ir_node *get_binop_left (ir_node *node);
451 INLINE void set_binop_left (ir_node *node, ir_node *left);
452 INLINE ir_node *get_binop_right (ir_node *node);
453 INLINE void set_binop_right (ir_node *node, ir_node *right);
455 INLINE ir_node *get_Add_left (ir_node *node);
456 INLINE void set_Add_left (ir_node *node, ir_node *left);
457 INLINE ir_node *get_Add_right (ir_node *node);
458 INLINE void set_Add_right (ir_node *node, ir_node *right);
460 INLINE ir_node *get_Sub_left (ir_node *node);
461 INLINE void set_Sub_left (ir_node *node, ir_node *left);
462 INLINE ir_node *get_Sub_right (ir_node *node);
463 INLINE void set_Sub_right (ir_node *node, ir_node *right);
465 INLINE ir_node *get_Minus_op (ir_node *node);
466 INLINE void set_Minus_op (ir_node *node, ir_node *op);
468 INLINE ir_node *get_Mul_left (ir_node *node);
469 INLINE void set_Mul_left (ir_node *node, ir_node *left);
470 INLINE ir_node *get_Mul_right (ir_node *node);
471 INLINE void set_Mul_right (ir_node *node, ir_node *right);
473 INLINE ir_node *get_Quot_left (ir_node *node);
474 INLINE void set_Quot_left (ir_node *node, ir_node *left);
475 INLINE ir_node *get_Quot_right (ir_node *node);
476 INLINE void set_Quot_right (ir_node *node, ir_node *right);
477 INLINE ir_node *get_Quot_mem (ir_node *node);
478 INLINE void set_Quot_mem (ir_node *node, ir_node *mem);
481 pn_Quot_M, /**< Memory result. */
482 pn_Quot_X_except, /**< Execution result if exception occured. */
483 pn_Quot_res /**< Result of computation. */
484 } pn_Quot; /* Projection numbers for Quot. */
486 INLINE ir_node *get_DivMod_left (ir_node *node);
487 INLINE void set_DivMod_left (ir_node *node, ir_node *left);
488 INLINE ir_node *get_DivMod_right (ir_node *node);
489 INLINE void set_DivMod_right (ir_node *node, ir_node *right);
490 INLINE ir_node *get_DivMod_mem (ir_node *node);
491 INLINE void set_DivMod_mem (ir_node *node, ir_node *mem);
494 pn_DivMod_M, /**< Memory result. */
495 pn_DivMod_X_except, /**< Execution result if exception occured. */
496 pn_DivMod_res_div, /**< Result of computation a / b. */
497 pn_DivMod_res_mod /**< Result of computation a % b. */
498 } pn_DivMod; /* Projection numbers for DivMod. */
500 INLINE ir_node *get_Div_left (ir_node *node);
501 INLINE void set_Div_left (ir_node *node, ir_node *left);
502 INLINE ir_node *get_Div_right (ir_node *node);
503 INLINE void set_Div_right (ir_node *node, ir_node *right);
504 INLINE ir_node *get_Div_mem (ir_node *node);
505 INLINE void set_Div_mem (ir_node *node, ir_node *mem);
508 pn_Div_M, /**< Memory result. */
509 pn_Div_X_except, /**< Execution result if exception occured. */
510 pn_Div_res /**< Result of computation. */
511 } pn_Div; /* Projection numbers for Div. */
513 INLINE ir_node *get_Mod_left (ir_node *node);
514 INLINE void set_Mod_left (ir_node *node, ir_node *left);
515 INLINE ir_node *get_Mod_right (ir_node *node);
516 INLINE void set_Mod_right (ir_node *node, ir_node *right);
517 INLINE ir_node *get_Mod_mem (ir_node *node);
518 INLINE void set_Mod_mem (ir_node *node, ir_node *mem);
521 pn_Mod_M, /**< Memory result. */
522 pn_Mod_X_except, /**< Execution result if exception occured. */
523 pn_Mod_res /**< Result of computation. */
524 } pn_Mod; /* Projection numbers for Mod. */
526 INLINE ir_node *get_Abs_op (ir_node *node);
527 INLINE void set_Abs_op (ir_node *node, ir_node *op);
529 INLINE ir_node *get_And_left (ir_node *node);
530 INLINE void set_And_left (ir_node *node, ir_node *left);
531 INLINE ir_node *get_And_right (ir_node *node);
532 INLINE void set_And_right (ir_node *node, ir_node *right);
534 INLINE ir_node *get_Or_left (ir_node *node);
535 INLINE void set_Or_left (ir_node *node, ir_node *left);
536 INLINE ir_node *get_Or_right (ir_node *node);
537 INLINE void set_Or_right (ir_node *node, ir_node *right);
539 INLINE ir_node *get_Eor_left (ir_node *node);
540 INLINE void set_Eor_left (ir_node *node, ir_node *left);
541 INLINE ir_node *get_Eor_right (ir_node *node);
542 INLINE void set_Eor_right (ir_node *node, ir_node *right);
544 INLINE ir_node *get_Not_op (ir_node *node);
545 INLINE void set_Not_op (ir_node *node, ir_node *op);
547 /* Projection numbers for Cmp are defined several times.
548 The bit patterns are used for variouse tests, so don't change.
549 The "unordered" values are possible results of comparing
550 floating point numbers. */
552 pn_Cmp_False = 0, /**< false */
553 pn_Cmp_Eq, /**< equal */
554 pn_Cmp_Lt, /**< less */
555 pn_Cmp_Le, /**< less or equal */
556 pn_Cmp_Gt, /**< greater */
557 pn_Cmp_Ge, /**< greater or equal */
558 pn_Cmp_Lg, /**< less or greater */
559 pn_Cmp_Leg = 7, /**< less, equal or greater = ordered */
560 pn_Cmp_Uo, /**< unordered */
561 pn_Cmp_Ue, /**< unordered or equal */
562 pn_Cmp_Ul, /**< unordered or less */
563 pn_Cmp_Ule, /**< unordered, less or equal */
564 pn_Cmp_Ug, /**< unordered or greater */
565 pn_Cmp_Uge, /**< unordered, greater or equal */
566 pn_Cmp_Ne, /**< unordered, less or greater = not equal */
567 pn_Cmp_True = 15 /**< true */
568 /* not_mask = Leg*/ /* bits to flip to negate comparison * @@ hack for jni interface */
569 } pn_Cmp; /* Projection numbers for Cmp */
570 //#define not_mask pn_Cmp_Leg
572 INLINE const char *get_pnc_string(int pnc);
573 INLINE int get_negated_pnc(int pnc);
574 INLINE ir_node *get_Cmp_left (ir_node *node);
575 INLINE void set_Cmp_left (ir_node *node, ir_node *left);
576 INLINE ir_node *get_Cmp_right (ir_node *node);
577 INLINE void set_Cmp_right (ir_node *node, ir_node *right);
579 INLINE ir_node *get_Shl_left (ir_node *node);
580 INLINE void set_Shl_left (ir_node *node, ir_node *left);
581 INLINE ir_node *get_Shl_right (ir_node *node);
582 INLINE void set_Shl_right (ir_node *node, ir_node *right);
584 INLINE ir_node *get_Shr_left (ir_node *node);
585 INLINE void set_Shr_left (ir_node *node, ir_node *left);
586 INLINE ir_node *get_Shr_right (ir_node *node);
587 INLINE void set_Shr_right (ir_node *node, ir_node *right);
589 INLINE ir_node *get_Shrs_left (ir_node *node);
590 INLINE void set_Shrs_left (ir_node *node, ir_node *left);
591 INLINE ir_node *get_Shrs_right (ir_node *node);
592 INLINE void set_Shrs_right (ir_node *node, ir_node *right);
594 INLINE ir_node *get_Rot_left (ir_node *node);
595 INLINE void set_Rot_left (ir_node *node, ir_node *left);
596 INLINE ir_node *get_Rot_right (ir_node *node);
597 INLINE void set_Rot_right (ir_node *node, ir_node *right);
599 INLINE ir_node *get_Conv_op (ir_node *node);
600 INLINE void set_Conv_op (ir_node *node, ir_node *op);
602 /* Does Cast need a mem operator?
603 * Cast should only depend on the type, not on the state of an
604 * entity. But: we initialzie various fields after Alloc, that
605 * are accessed in the cast. This required some precaution, to
606 * get the right memory into the Loads generated from the cast.
608 INLINE ir_node *get_Cast_op (ir_node *node);
609 INLINE void set_Cast_op (ir_node *node, ir_node *op);
610 INLINE type *get_Cast_type (ir_node *node);
611 INLINE void set_Cast_type (ir_node *node, type *to_tp);
613 /* Returns true if n is Phi or Filter in interprocedural_view. */
614 INLINE int is_Phi (ir_node *n);
615 /* These routines also work for Filter nodes in interprocedural view. */
616 INLINE ir_node **get_Phi_preds_arr (ir_node *node);
617 INLINE int get_Phi_n_preds (ir_node *node);
618 INLINE ir_node *get_Phi_pred (ir_node *node, int pos);
619 INLINE void set_Phi_pred (ir_node *node, int pos, ir_node *pred);
621 INLINE ir_node *get_Filter_pred(ir_node *node);
622 INLINE void set_Filter_pred(ir_node *node, ir_node *pred);
623 INLINE long get_Filter_proj(ir_node *node);
624 INLINE void set_Filter_proj(ir_node *node, long proj);
625 /* set the interprocedural predecessors, ...d_arr uses current_ir_graph.
626 * @@@ Maybe better: arity is zero if no cg preds. */
627 void set_Filter_cg_pred_arr(ir_node * node, int arity, ir_node ** in);
628 void set_Filter_cg_pred(ir_node * node, int pos, ir_node * pred);
629 int get_Filter_n_cg_preds(ir_node *node);
630 ir_node * get_Filter_cg_pred(ir_node *node, int pos);
633 pn_Load_M, /**< Memory result. */
634 pn_Load_X_except, /**< Execution result if exception occured. */
635 pn_Load_res /**< Result of load operation. */
636 } pn_Load; /* Projection numbers for Load. */
638 INLINE ir_node *get_Load_mem (ir_node *node);
639 INLINE void set_Load_mem (ir_node *node, ir_node *mem);
640 INLINE ir_node *get_Load_ptr (ir_node *node);
641 INLINE void set_Load_ptr (ir_node *node, ir_node *ptr);
644 pn_Store_M, /**< Memory result. */
645 pn_Store_X_except /**< Execution result if exception occured. */
646 } pn_Store; /* Projection numbers for Store. */
648 INLINE ir_node *get_Store_mem (ir_node *node);
649 INLINE void set_Store_mem (ir_node *node, ir_node *mem);
650 INLINE ir_node *get_Store_ptr (ir_node *node);
651 INLINE void set_Store_ptr (ir_node *node, ir_node *ptr);
652 INLINE ir_node *get_Store_value (ir_node *node);
653 INLINE void set_Store_value (ir_node *node, ir_node *value);
656 pn_Alloc_M, /**< Memory result. */
657 pn_Alloc_X_except, /**< Execution result if exception occured. */
658 pn_Alloc_res /**< Result of allocation. */
659 } pn_Alloc; /* Projection numbers for Alloc. */
661 INLINE ir_node *get_Alloc_mem (ir_node *node);
662 INLINE void set_Alloc_mem (ir_node *node, ir_node *mem);
663 INLINE ir_node *get_Alloc_size (ir_node *node);
664 INLINE void set_Alloc_size (ir_node *node, ir_node *size);
665 INLINE type *get_Alloc_type (ir_node *node);
666 INLINE void set_Alloc_type (ir_node *node, type *tp);
668 /** allocation place. */
670 stack_alloc, /**< Alloc allocates the object on the stack. */
671 heap_alloc /**< Alloc allocates the object on the heap. */
674 INLINE where_alloc get_Alloc_where (ir_node *node);
675 INLINE void set_Alloc_where (ir_node *node, where_alloc where);
677 INLINE ir_node *get_Free_mem (ir_node *node);
678 INLINE void set_Free_mem (ir_node *node, ir_node *mem);
679 INLINE ir_node *get_Free_ptr (ir_node *node);
680 INLINE void set_Free_ptr (ir_node *node, ir_node *ptr);
681 INLINE ir_node *get_Free_size (ir_node *node);
682 INLINE void set_Free_size (ir_node *node, ir_node *size);
683 INLINE type *get_Free_type (ir_node *node);
684 INLINE void set_Free_type (ir_node *node, type *tp);
686 INLINE ir_node **get_Sync_preds_arr (ir_node *node);
687 INLINE int get_Sync_n_preds (ir_node *node);
688 INLINE ir_node *get_Sync_pred (ir_node *node, int pos);
689 INLINE void set_Sync_pred (ir_node *node, int pos, ir_node *pred);
691 INLINE ir_node *get_Proj_pred (ir_node *node);
692 INLINE void set_Proj_pred (ir_node *node, ir_node *pred);
693 /* Why long? shouldn't int be enough, and smaller? Or even byte? */
694 INLINE long get_Proj_proj (ir_node *node);
695 INLINE void set_Proj_proj (ir_node *node, long proj);
697 INLINE ir_node **get_Tuple_preds_arr (ir_node *node);
698 INLINE int get_Tuple_n_preds (ir_node *node);
699 INLINE ir_node *get_Tuple_pred (ir_node *node, int pos);
700 INLINE void set_Tuple_pred (ir_node *node, int pos, ir_node *pred);
702 INLINE ir_node *get_Id_pred (ir_node *node);
703 INLINE void set_Id_pred (ir_node *node, ir_node *pred);
705 /** Confirm has a single result and returns 'value' unchanged.
706 * The node expresses a restriction on 'value':
707 * 'value' 'cmp' 'bound' == true. */
708 INLINE ir_node *get_Confirm_value (ir_node *node);
709 INLINE void set_Confirm_value (ir_node *node, ir_node *value);
710 INLINE ir_node *get_Confirm_bound (ir_node *node);
711 INLINE void set_Confirm_bound (ir_node *node, ir_node *bound);
712 INLINE pn_Cmp get_Confirm_cmp (ir_node *node);
713 INLINE void set_Confirm_cmp (ir_node *node, pn_Cmp cmp);
717 * NAME Auxiliary routines
719 * Not properly documented ;-)
723 /** returns operand of node if node is a Proj. */
724 INLINE ir_node *skip_Proj (ir_node *node);
725 /** returns operand of node if node is a Id */
726 INLINE ir_node *skip_nop (ir_node *node);
727 INLINE ir_node *skip_Id (ir_node *node); /* Same as skip_nop. */
728 /* returns corresponding operand of Tuple if node is a Proj from
730 INLINE ir_node *skip_Tuple (ir_node *node);
731 /** returns true if node is a Bad node. */
732 INLINE int is_Bad (ir_node *node);
733 /** returns true if the node is not a Block */
734 INLINE int is_no_Block (ir_node *node);
735 /** returns true if the node is a Block */
736 INLINE int is_Block (ir_node *node);
737 /** returns true if node is a Unknown node. */
738 INLINE int is_Unknown (ir_node *node);
739 /** returns true if node is a Proj node or a Filter node in
740 * intraprocedural view */
741 INLINE int is_Proj (const ir_node *node);
742 /** Returns true if the operation manipulates control flow:
743 Start, End, Jmp, Cond, Return, Raise, Bad, CallBegin, EndReg, EndExcept */
744 int is_cfop(ir_node *node);
746 /* @@@ old -- use get_irn_irg instead! */
747 ir_graph *get_ip_cfop_irg(ir_node *n);
749 /** Returns true if the operation manipulates interprocedural control flow:
750 CallBegin, EndReg, EndExcept */
751 int is_ip_cfop(ir_node *node);
752 /** Returns true if the operation can change the control flow because
753 of an exception: Call, Quot, DivMod, Div, Mod, Load, Store, Alloc,
755 int is_fragile_op(ir_node *node);
756 /** Returns the memory operand of fragile operations. */
757 ir_node *get_fragile_op_mem(ir_node *node);
762 /* GNU C has the __FUNCTION__ extension */
763 #define __MYFUNC__ __FUNCTION__
765 /* use Filename instead */
766 #define __MYFUNC__ __FILE__
770 Don't format with "\", firmjni gets problems */
771 /** Output location */
772 #define DDM printf("%s(l.%i).\n", __MYFUNC__, __LINE__);
773 /** Output the firm kind of the node */
774 #define DDMK(X) printf("%s(l.%i) %s: %p\n", __MYFUNC__, __LINE__, print_firm_kind(X), (void *)(X));
775 /** Output information about a node */
776 #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))
777 /** Output information about a node and its block */
778 #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)))
779 /** Output information about a type */
780 #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))
781 /** Output information about an entity */
782 #define DDME(X) printf("%s(l.%i) %s: %ld (%p)\n", __MYFUNC__, __LINE__, get_entity_name(X), get_entity_nr(X), (void *)(X))
783 /** Output information about an entity and its type */
784 #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))
785 /** Output information about an entity and its owner */
786 #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))
787 /** Output information about a graph */
788 #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))
789 /** Output information about an ident */
790 #define DDMI(X) printf("%s(l.%i) %s: %p\n", __MYFUNC__, __LINE__, id_to_str(X), (void *)(X))
791 /** Output information about a mode */
792 #define DDMM(X) printf("%s(l.%i) %s: %p\n", __MYFUNC__, __LINE__, get_mode_name(X), (void *)(X))
793 /** Output information about a loop */
794 #define DDML(X) printf("%s(l.%i) loop with depth %d: %p\n", __MYFUNC__, __LINE__, get_loop_depth(X), (void *)(X))
795 /** Output information about a tarVal */
796 #define DDMV(X) printf("%s(l.%i) tarval: ",__MYFUNC__, __LINE__); tarval_printf(X); printf(" (%p)\n", (void *)(X));
798 /*@}*/ /* end of ir_node group definition */
801 # endif /* _IRNODE_H_ */