a035cd97933ff1082b70f1f4811c58e6366a4aae
[libfirm] / ir / ir / irnode.h
1 /* Copyright (C) 1998 - 2000 by Universitaet Karlsruhe      3 2002/02/28 13:33:52
2  * All rights reserved.
3  */
4
5 /* $Id$ */
6
7 # ifndef _IRNODE_H_
8 # define _IRNODE_H_
9
10 /* Projection numbers of compare: use for Proj nodes! */
11 typedef enum {
12   False,                /* false */
13   Eq,                   /* equal */
14   Lt,                   /* less */
15   Le,                   /* less or equal */
16   Gt,                   /* greater */
17   Ge,                   /* greater or equal */
18   Lg,                   /* less or greater */
19   Leg,                  /* less, equal or greater = ordered */
20   Uo,                   /* unordered */
21   Ue,                   /* unordered or equal */
22   Ul,                   /* unordered or less */
23   Ule,                  /* unordered, less or equal */
24   Ug,                   /* unordered or greater */
25   Uge,                  /* unordered, greater or equal */
26   Ne,                   /* unordered, less or greater = not equal */
27   True                  /* true */
28   /* not_mask = Leg*/   /* bits to flip to negate comparison * @@ hack for jni interface */
29 } pnc_number;
30 #define not_mask Leg
31
32 # include "tv.h"
33 # include "irgraph.h"
34 # include "entity.h"
35 # include "firm_common.h"
36 # include "irop.h"
37 # include "irmode.h"
38 # include "type.h"
39 # include "dbginfo.h"
40 # include "exc.h"
41
42 /**
43  * @file irnode.h
44  *
45  * @author Martin Trapp, Christian Schaefer
46  *
47  * Declarations of an ir node.
48  */
49
50 /**
51  * @defgroup ir_node Declarations of an ir node.
52  *
53  * The type definiton of ir_node is also in irgraph.h to resolve
54  *  recursion between irnode.h and irgraph.h
55  *
56  * ir_node - a datatype representing a Firm node
57  *
58  *  The common fields are:
59  *
60  *  - firm_kind - A firm_kind tag containing k_type.  This is useful
61  *                for dynamically checking whether a node is a ir_node.
62  *  - arity     - The number of predecessors in the Firm graph.
63  *  - in        - A list with the predecessors in the Firm graph.  There are
64  *                routines to access individual elements and to obtain the
65  *                array.  The method returning the array should not be used.
66  *  - mode      - The mode of the node.  There are routines to get the mode
67  *                but also to access the mode's fields directly.
68  *  - opcode    - The opcode of the node. There are routines to get the opcode
69  *                but also to access the opcode's fields directly.
70  *  - node_nr   - A unique number for the node.  Available only if debugging
71  *                is turned on.
72  * @{
73  */
74
75 #ifndef _IR_NODE_TYPEDEF_
76 #define _IR_NODE_TYPEDEF_
77 typedef struct ir_node ir_node;
78 #endif
79
80 /**
81  *   you can work on the graph without considering the different types
82  *   of nodes, it's just a big graph.
83  */
84
85 /** returns the number of predecessors without the block predecessor: */
86 int                  get_irn_arity         (const ir_node *node);
87
88 /** Replaces the old in array by a new one that will contain the ins given in
89    the parameters.  Conserves the block predecessor.  It copies the array passed.
90    This function is necessary to ajust in arrays of blocks, calls and phis.
91    Assumes that current_ir_graph is set to the graph containing "node".
92    "in" must contain all predecessors except the block that are required for
93    the nodes opcode. */
94 INLINE void          set_irn_in            (ir_node *node, int arity,
95                                             ir_node *in[]);
96 /* to iterate through the predecessors without touching the array. No
97    order of predecessors guaranteed.
98    To iterate over the operands iterate from 0 to i < get_irn_arity(),
99    to iterate including the Block predecessor iterate from i = -1 to
100    i < get_irn_arity. */
101 /* Access predecessor n */
102 /* get_irn_n removes Id predecessors. */
103 INLINE ir_node      *get_irn_n             (ir_node *node, int n);
104 INLINE void          set_irn_n             (ir_node *node, int n, ir_node *in);
105 /* Get the mode struct. */
106 INLINE ir_mode      *get_irn_mode          (const ir_node *node);
107 /* Get the mode-enum modecode */
108 INLINE modecode      get_irn_modecode      (const ir_node *node);
109 /* Get the ident for a string representation of the mode */
110 INLINE ident        *get_irn_modeident     (const ir_node *node);
111 /* Access the opcode struct of the node */
112 INLINE ir_op        *get_irn_op            (const ir_node *node);
113 INLINE void          set_irn_op            (ir_node *node, ir_op *op);
114 /* Get the opcode-enum of the node */
115 INLINE opcode        get_irn_opcode        (const ir_node *node);
116 /* Get the string representation of the opcode */
117 INLINE const char   *get_irn_opname        (const ir_node *node);
118 /* Get the ident for a string representation of the opcode */
119 INLINE ident        *get_irn_opident       (const ir_node *node);
120 INLINE unsigned long get_irn_visited (const ir_node *node);
121 INLINE void          set_irn_visited (ir_node *node, unsigned long visited);
122 /* Sets visited to get_irg_visited(current_ir_graph) */
123 INLINE void          mark_irn_visited (ir_node *node);
124 /* Returns 1 if visited < get_irg_visited(current_ir_graph).  */
125 INLINE int           irn_not_visited  (const ir_node *node);
126 /* Returns 1 if visited >= get_irg_visited(current_ir_graph).  */
127 INLINE int           irn_visited      (const ir_node *node);
128 INLINE void          set_irn_link          (ir_node *node, void *link);
129 INLINE void         *get_irn_link          (const ir_node *node);
130
131 /** Outputs a unique number for this node if libfirm is compiled for
132    debugging, (configure with --enable-debug) else returns 0. */
133 INLINE long get_irn_node_nr(const ir_node *node);
134
135 /** Returns the ir_graph this node belongs to. Only valid for
136  * CallBegin, EndReg and EndExcept */
137 INLINE ir_graph *get_irn_irg(ir_node *node);
138
139 /**
140  * irnode constructor.
141  * Create a new irnode in irg, with an op, mode, arity and
142  * some incoming irnodes.
143  * If arity is negative, a node with a dynamic array is created.
144  */
145 INLINE ir_node *
146 new_ir_node (dbg_info *db,
147              ir_graph *irg,
148              ir_node *block,
149              ir_op *op,
150              ir_mode *mode,
151              int arity,
152              ir_node *in[]);
153
154 /*
155  *
156  * NAME access functions for node fields.
157  *
158  *  Not properly documented ;-)
159  *
160  */
161
162 /* this works for all except Block */
163 INLINE ir_node  *get_nodes_Block (ir_node *node);
164 INLINE void      set_nodes_Block (ir_node *node, ir_node *block);
165
166 /** Projection numbers for result of Start node: use for Proj nodes! */
167 typedef enum {
168   pns_initial_exec,     /**< Projection on an executable, the initial control
169                            flow. */
170   pns_global_store,     /**< Projection on the global store */
171   pns_frame_base,       /**< Projection on the frame base */
172   pns_globals,          /**< Projection on the pointer to the data segment
173                            containing _all_ global entities. */
174   pns_args              /**< Projection on all arguments */
175 } pns_number;
176
177 /* @@@ no more supported  */
178 INLINE ir_node **get_Block_cfgpred_arr (ir_node *node);
179 int              get_Block_n_cfgpreds (ir_node *node);
180 INLINE ir_node  *get_Block_cfgpred (ir_node *node, int pos);
181 INLINE void      set_Block_cfgpred (ir_node *node, int pos, ir_node *pred);
182 INLINE bool      get_Block_matured (ir_node *node);
183 INLINE void      set_Block_matured (ir_node *node, bool matured);
184 INLINE unsigned long get_Block_block_visited (ir_node *node);
185 INLINE void      set_Block_block_visited (ir_node *node, unsigned long visit);
186 /* For this current_ir_graph must be set. */
187 INLINE void      mark_Block_block_visited(ir_node *node);
188 INLINE int       Block_not_block_visited(ir_node *node);
189
190 /* Set and remove interprocedural predecessors. If the interprocedural
191  * predecessors are removed, the node has the same predecessors in
192  * both views.
193  * @@@ Maybe better:  arity is zero if no cg preds. */
194 void set_Block_cg_cfgpred_arr(ir_node * node, int arity, ir_node ** in);
195 void set_Block_cg_cfgpred(ir_node * node, int pos, ir_node * pred);
196 /* @@@ not supported */
197 ir_node ** get_Block_cg_cfgpred_arr(ir_node * node);
198 /* Returns the number of interproc predecessors.  0 if none. */
199 int get_Block_cg_n_cfgpreds(ir_node * node);
200 ir_node * get_Block_cg_cfgpred(ir_node * node, int pos);
201 /* frees the memory. */
202 void remove_Block_cg_cfgpred_arr(ir_node * node);
203
204 INLINE int  get_End_n_keepalives(ir_node *end);
205 INLINE ir_node *get_End_keepalive(ir_node *end, int pos);
206 INLINE void add_End_keepalive (ir_node *end, ir_node *ka);
207 INLINE void set_End_keepalive(ir_node *end, int pos, ir_node *ka);
208 /* Some parts of the End node are allocated seperately -- their memory
209    is not recovered by dead_node_elimination if a End node is dead.
210    free_End frees these data structures. */
211 INLINE void free_End (ir_node *end);
212
213 ir_graph *get_EndReg_irg (const ir_node *end);
214 ir_graph *get_EndExcept_irg  (const ir_node *end);
215
216 /* We distinguish three kinds of Cond nodes.  These can be distinguished
217    by the mode of the selector operand and an internal flag of type cond_kind.
218    First we distinguish binary Conds and switch Conds.
219    A binary Cond has as selector a boolean value.  Proj(0) projects the control
220    flow for case "False", Proj(1) the control flow for "True".  A binary Cond
221    is recognized by the boolean selector.
222    The switch Cond has as selector an unsigned integer.  It produces as result
223    an n+1 Tuple (cf0, ... , cfn) of control flows.
224    We differ two flavours of this Cond.  The first, the dense Cond, passes
225    control along output i if the selector value is i, 0 <= i <= n.  If the
226    selector value is >n it passes control along output n.
227    The second Cond flavor differes in the treatment of cases not specified in
228    the source program.  It magically knows about the existence of Proj nodes.
229    It only passes control along output i, 0 <= i <= n, if a node Proj(Cond, i)
230    exists.  Else it passes control along output n (even if this Proj does not
231    exist.)  This Cond we call "fragmentary".  There is a special constructor
232    new_defaultProj that automatically sets the flavor.
233    The two switch flavors are distinguished by a flag of type cond_kind.
234    Default flavor is "dense"
235 */
236 typedef enum {
237   dense,        /**< Default. Missing Proj nodes are dead control flow. */
238   fragmentary   /**< Special. No control flow optimizations allowed.  Missing
239                    Proj nodes mean default control flow, i.e., Proj(n). */
240 } cond_kind;
241
242 INLINE ir_node  *get_Cond_selector (ir_node *node);
243 INLINE void      set_Cond_selector (ir_node *node, ir_node *selector);
244 INLINE cond_kind get_Cond_kind (ir_node *node);
245 INLINE void      set_Cond_kind (ir_node *node, cond_kind kind);
246
247 INLINE ir_node  *get_Return_mem (ir_node *node);
248 INLINE void      set_Return_mem (ir_node *node, ir_node *mem);
249 INLINE ir_node **get_Return_res_arr (ir_node *node);
250 INLINE int       get_Return_n_ress (ir_node *node);
251 INLINE ir_node  *get_Return_res (ir_node *node, int pos);
252 INLINE void      set_Return_res (ir_node *node, int pos, ir_node *res);
253
254 INLINE ir_node *get_Raise_mem (ir_node *node);
255 INLINE void     set_Raise_mem (ir_node *node, ir_node *mem);
256 INLINE ir_node *get_Raise_exo_ptr (ir_node *node);  /* PoinTeR to EXception Object */
257 INLINE void     set_Raise_exo_ptr (ir_node *node, ir_node *exoptr);
258
259 INLINE tarval  *get_Const_tarval (ir_node *node);
260 INLINE void     set_Const_tarval (ir_node *node, tarval *con);
261
262 /**  This enum names the three different kinds of symbolic Constants
263      represented by SymConst.  The content of the attribute type_or_id
264      depends on this tag.  Use the proper access routine after testing
265      this flag. */
266 typedef enum {
267   type_tag,          /**< The SymConst is a type tag for the given type.
268                         Type_or_id_p is type *. */
269   size,              /**< The SymConst is the size of the given type.
270                         Type_or_id_p is type *. */
271   linkage_ptr_info   /**< The SymConst is a symbolic pointer to be filled in
272                         by the linker. Type_or_id_p is ident *. */
273 } symconst_kind;
274 typedef union type_or_id * type_or_id_p;
275 INLINE symconst_kind get_SymConst_kind (const ir_node *node);
276 INLINE void          set_SymConst_kind (ir_node *node, symconst_kind num);
277 /* Only to access SymConst of kind type_tag or size.  Else assertion: */
278 INLINE type    *get_SymConst_type (ir_node *node);
279 INLINE void     set_SymConst_type (ir_node *node, type *tp);
280 /* Only to access SymConst of kind linkage_ptr_info.  Else assertion: */
281 INLINE ident   *get_SymConst_ptrinfo (ir_node *node);
282 INLINE void     set_SymConst_ptrinfo (ir_node *node, ident *ptrinfo);
283 /* Sets both: type and ptrinfo.  Needed to treat the node independent of
284    its semantics.  Does a memcpy for the memory tori points to. */
285 INLINE type_or_id_p get_SymConst_type_or_id (ir_node *node);
286 INLINE void set_SymConst_type_or_id (ir_node *node, type_or_id_p tori);
287
288 INLINE ir_node *get_Sel_mem (ir_node *node);
289 INLINE void     set_Sel_mem (ir_node *node, ir_node *mem);
290 INLINE ir_node *get_Sel_ptr (ir_node *node);  /* ptr to the object to select from */
291 INLINE void     set_Sel_ptr (ir_node *node, ir_node *ptr);
292 INLINE ir_node **get_Sel_index_arr (ir_node *node);
293 INLINE int      get_Sel_n_indexs (ir_node *node);
294 INLINE ir_node *get_Sel_index (ir_node *node, int pos);
295 INLINE void     set_Sel_index (ir_node *node, int pos, ir_node *index);
296 INLINE entity  *get_Sel_entity (ir_node *node); /* entity to select */
297 INLINE void     set_Sel_entity (ir_node *node, entity *ent);
298
299 /* @@@ ajacs specific node -- not supported */
300 type           *get_InstOf_ent   (ir_node *node);
301 void            set_InstOf_ent   (ir_node *node, type *ent);
302 ir_node        *get_InstOf_obj   (ir_node *node);
303 void            set_InstOf_obj   (ir_node *node, ir_node *obj);
304 ir_node        *get_InstOf_store (ir_node *node);
305 void            set_InstOf_store (ir_node *node, ir_node *obj);
306
307 INLINE ir_node *get_Call_mem (ir_node *node);
308 INLINE void     set_Call_mem (ir_node *node, ir_node *mem);
309 INLINE ir_node *get_Call_ptr (ir_node *node);
310 INLINE void     set_Call_ptr (ir_node *node, ir_node *ptr);
311 INLINE ir_node **get_Call_param_arr (ir_node *node);
312 INLINE int      get_Call_n_params (ir_node *node);
313 INLINE ir_node *get_Call_param (ir_node *node, int pos);
314 INLINE void     set_Call_param (ir_node *node, int pos, ir_node *param);
315 INLINE type    *get_Call_type (ir_node *node);
316 INLINE void     set_Call_type (ir_node *node, type *tp);
317 INLINE int      get_Call_arity (ir_node *node);
318
319 /* Set, get and remove the callee-analysis. */
320 int get_Call_n_callees(ir_node * node);
321 entity * get_Call_callee(ir_node * node, int pos);
322 void set_Call_callee_arr(ir_node * node, int n, entity ** arr);
323 void remove_Call_callee_arr(ir_node * node);
324
325 ir_node * get_CallBegin_ptr (ir_node *node);
326 void set_CallBegin_ptr (ir_node *node, ir_node *ptr);
327 ir_graph *get_CallBegin_irg (ir_node *node);
328 ir_node *get_CallBegin_call (ir_node *node);
329 void set_CallBegin_call (ir_node *node, ir_node *call);
330
331 /* For unary and binary arithmetic operations the access to the
332    operands can be factored out.  Left is the first, right the
333    second arithmetic value  as listed in tech report 1999-44.
334    unops are: Minus, Abs, Not, Conv
335    binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
336    Shr, Shrs, Rot, Cmp */
337 INLINE int      is_unop (ir_node *node);
338 INLINE ir_node *get_unop_op (ir_node *node);
339 INLINE void     set_unop_op (ir_node *node, ir_node *op);
340 INLINE int      is_binop (ir_node *node);
341 INLINE ir_node *get_binop_left (ir_node *node);
342 INLINE void     set_binop_left (ir_node *node, ir_node *left);
343 INLINE ir_node *get_binop_right (ir_node *node);
344 INLINE void     set_binop_right (ir_node *node, ir_node *right);
345
346 INLINE ir_node *get_Add_left (ir_node *node);
347 INLINE void     set_Add_left (ir_node *node, ir_node *left);
348 INLINE ir_node *get_Add_right (ir_node *node);
349 INLINE void     set_Add_right (ir_node *node, ir_node *right);
350
351 INLINE ir_node *get_Sub_left (ir_node *node);
352 INLINE void     set_Sub_left (ir_node *node, ir_node *left);
353 INLINE ir_node *get_Sub_right (ir_node *node);
354 INLINE void     set_Sub_right (ir_node *node, ir_node *right);
355
356 INLINE ir_node *get_Minus_op (ir_node *node);
357 INLINE void     set_Minus_op (ir_node *node, ir_node *op);
358
359 INLINE ir_node *get_Mul_left (ir_node *node);
360 INLINE void     set_Mul_left (ir_node *node, ir_node *left);
361 INLINE ir_node *get_Mul_right (ir_node *node);
362 INLINE void     set_Mul_right (ir_node *node, ir_node *right);
363
364 INLINE ir_node *get_Quot_left (ir_node *node);
365 INLINE void     set_Quot_left (ir_node *node, ir_node *left);
366 INLINE ir_node *get_Quot_right (ir_node *node);
367 INLINE void     set_Quot_right (ir_node *node, ir_node *right);
368 INLINE ir_node *get_Quot_mem (ir_node *node);
369 INLINE void     set_Quot_mem (ir_node *node, ir_node *mem);
370
371 INLINE ir_node *get_DivMod_left (ir_node *node);
372 INLINE void     set_DivMod_left (ir_node *node, ir_node *left);
373 INLINE ir_node *get_DivMod_right (ir_node *node);
374 INLINE void     set_DivMod_right (ir_node *node, ir_node *right);
375 INLINE ir_node *get_DivMod_mem (ir_node *node);
376 INLINE void     set_DivMod_mem (ir_node *node, ir_node *mem);
377
378 INLINE ir_node *get_Div_left (ir_node *node);
379 INLINE void     set_Div_left (ir_node *node, ir_node *left);
380 INLINE ir_node *get_Div_right (ir_node *node);
381 INLINE void     set_Div_right (ir_node *node, ir_node *right);
382 INLINE ir_node *get_Div_mem (ir_node *node);
383 INLINE void     set_Div_mem (ir_node *node, ir_node *mem);
384
385 INLINE ir_node *get_Mod_left (ir_node *node);
386 INLINE void     set_Mod_left (ir_node *node, ir_node *left);
387 INLINE ir_node *get_Mod_right (ir_node *node);
388 INLINE void     set_Mod_right (ir_node *node, ir_node *right);
389 INLINE ir_node *get_Mod_mem (ir_node *node);
390 INLINE void     set_Mod_mem (ir_node *node, ir_node *mem);
391
392 INLINE ir_node *get_Abs_op (ir_node *node);
393 INLINE void     set_Abs_op (ir_node *node, ir_node *op);
394
395 INLINE ir_node *get_And_left (ir_node *node);
396 INLINE void     set_And_left (ir_node *node, ir_node *left);
397 INLINE ir_node *get_And_right (ir_node *node);
398 INLINE void     set_And_right (ir_node *node, ir_node *right);
399
400 INLINE ir_node *get_Or_left (ir_node *node);
401 INLINE void     set_Or_left (ir_node *node, ir_node *left);
402 INLINE ir_node *get_Or_right (ir_node *node);
403 INLINE void     set_Or_right (ir_node *node, ir_node *right);
404
405 INLINE ir_node *get_Eor_left (ir_node *node);
406 INLINE void     set_Eor_left (ir_node *node, ir_node *left);
407 INLINE ir_node *get_Eor_right (ir_node *node);
408 INLINE void     set_Eor_right (ir_node *node, ir_node *right);
409
410 INLINE ir_node *get_Not_op (ir_node *node);
411 INLINE void     set_Not_op (ir_node *node, ir_node *op);
412
413 INLINE const char *get_pnc_string(int pnc);
414
415 INLINE int   get_negated_pnc(int pnc);
416 INLINE ir_node *get_Cmp_left (ir_node *node);
417 INLINE void     set_Cmp_left (ir_node *node, ir_node *left);
418 INLINE ir_node *get_Cmp_right (ir_node *node);
419 INLINE void     set_Cmp_right (ir_node *node, ir_node *right);
420
421 INLINE ir_node *get_Shl_left (ir_node *node);
422 INLINE void     set_Shl_left (ir_node *node, ir_node *left);
423 INLINE ir_node *get_Shl_right (ir_node *node);
424 INLINE void     set_Shl_right (ir_node *node, ir_node *right);
425
426 INLINE ir_node *get_Shr_left (ir_node *node);
427 INLINE void     set_Shr_left (ir_node *node, ir_node *left);
428 INLINE ir_node *get_Shr_right (ir_node *node);
429 INLINE void     set_Shr_right (ir_node *node, ir_node *right);
430
431 INLINE ir_node *get_Shrs_left (ir_node *node);
432 INLINE void     set_Shrs_left (ir_node *node, ir_node *left);
433 INLINE ir_node *get_Shrs_right (ir_node *node);
434 INLINE void     set_Shrs_right (ir_node *node, ir_node *right);
435
436 INLINE ir_node *get_Rot_left (ir_node *node);
437 INLINE void     set_Rot_left (ir_node *node, ir_node *left);
438 INLINE ir_node *get_Rot_right (ir_node *node);
439 INLINE void     set_Rot_right (ir_node *node, ir_node *right);
440
441 INLINE ir_node *get_Conv_op (ir_node *node);
442 INLINE void     set_Conv_op (ir_node *node, ir_node *op);
443
444 INLINE ir_node **get_Phi_preds_arr (ir_node *node);
445 INLINE int       get_Phi_n_preds (ir_node *node);
446 INLINE ir_node  *get_Phi_pred (ir_node *node, int pos);
447 INLINE void      set_Phi_pred (ir_node *node, int pos, ir_node *pred);
448
449 INLINE ir_node  *get_Filter_pred(ir_node *node);
450 INLINE void      set_Filter_pred(ir_node *node, ir_node *pred);
451 INLINE long      get_Filter_proj(ir_node *node);
452 INLINE void      set_Filter_proj(ir_node *node, long proj);
453 /* set the interprocedural predecessors, ...d_arr uses current_ir_graph.
454  * @@@ Maybe better:  arity is zero if no cg preds. */
455 void             set_Filter_cg_pred_arr(ir_node * node, int arity, ir_node ** in);
456 void             set_Filter_cg_pred(ir_node * node, int pos, ir_node * pred);
457 int              get_Filter_n_cg_preds(ir_node *node);
458 ir_node *        get_Filter_cg_pred(ir_node *node, int pos);
459
460 INLINE ir_node *get_Load_mem (ir_node *node);
461 INLINE void     set_Load_mem (ir_node *node, ir_node *mem);
462 INLINE ir_node *get_Load_ptr (ir_node *node);
463 INLINE void     set_Load_ptr (ir_node *node, ir_node *ptr);
464
465 INLINE ir_node *get_Store_mem (ir_node *node);
466 INLINE void     set_Store_mem (ir_node *node, ir_node *mem);
467 INLINE ir_node *get_Store_ptr (ir_node *node);
468 INLINE void     set_Store_ptr (ir_node *node, ir_node *ptr);
469 INLINE ir_node *get_Store_value (ir_node *node);
470 INLINE void     set_Store_value (ir_node *node, ir_node *value);
471
472 INLINE ir_node *get_Alloc_mem (ir_node *node);
473 INLINE void     set_Alloc_mem (ir_node *node, ir_node *mem);
474 INLINE ir_node *get_Alloc_size (ir_node *node);
475 INLINE void     set_Alloc_size (ir_node *node, ir_node *size);
476 INLINE type    *get_Alloc_type (ir_node *node);
477 INLINE void     set_Alloc_type (ir_node *node, type *tp);
478
479 /** allocation place. */
480 typedef enum {
481   stack_alloc,          /**< Alloc allocates the object on the stack. */
482   heap_alloc            /**< Alloc allocates the object on the heap. */
483 } where_alloc;
484
485 INLINE where_alloc  get_Alloc_where (ir_node *node);
486 INLINE void         set_Alloc_where (ir_node *node, where_alloc where);
487
488 INLINE ir_node *get_Free_mem (ir_node *node);
489 INLINE void     set_Free_mem (ir_node *node, ir_node *mem);
490 INLINE ir_node *get_Free_ptr (ir_node *node);
491 INLINE void     set_Free_ptr (ir_node *node, ir_node *ptr);
492 INLINE ir_node *get_Free_size (ir_node *node);
493 INLINE void     set_Free_size (ir_node *node, ir_node *size);
494 INLINE type    *get_Free_type (ir_node *node);
495 INLINE void     set_Free_type (ir_node *node, type *tp);
496
497 INLINE ir_node **get_Sync_preds_arr (ir_node *node);
498 INLINE int       get_Sync_n_preds (ir_node *node);
499 INLINE ir_node  *get_Sync_pred (ir_node *node, int pos);
500 INLINE void      set_Sync_pred (ir_node *node, int pos, ir_node *pred);
501
502 INLINE ir_node  *get_Proj_pred (ir_node *node);
503 INLINE void      set_Proj_pred (ir_node *node, ir_node *pred);
504 INLINE long      get_Proj_proj (ir_node *node);
505 INLINE void      set_Proj_proj (ir_node *node, long proj);
506
507 INLINE ir_node **get_Tuple_preds_arr (ir_node *node);
508 INLINE int       get_Tuple_n_preds (ir_node *node);
509 INLINE ir_node  *get_Tuple_pred (ir_node *node, int pos);
510 INLINE void      set_Tuple_pred (ir_node *node, int pos, ir_node *pred);
511
512 INLINE ir_node  *get_Id_pred (ir_node *node);
513 INLINE void      set_Id_pred (ir_node *node, ir_node *pred);
514
515
516 /*
517  *
518  * NAME Auxiliary routines
519  *
520  *  Not properly documented ;-)
521  *
522  */
523
524 /** returns operand of node if node is a Proj. */
525 INLINE ir_node *skip_Proj (ir_node *node);
526 /** returns operand of node if node is a Id */
527 INLINE ir_node *skip_nop  (ir_node *node);
528 INLINE ir_node *skip_Id  (ir_node *node);   /* Same as skip_nop. */
529 /* returns corresponding operand of Tuple if node is a Proj from
530    a Tuple. */
531 INLINE ir_node *skip_Tuple (ir_node *node);
532 /** returns true if node is a Bad node. */
533 INLINE int      is_Bad    (ir_node *node);
534 /** returns true if the node is not a Block */
535 INLINE int      is_no_Block (ir_node *node);
536 /** returns true if the node is a Block */
537 INLINE int      is_Block (ir_node *node);
538 /** returns true if node is a Proj node or a Filter node in
539  * intraprocedural view */
540 INLINE int      is_Proj (const ir_node *node);
541 /** Returns true if the operation manipulates control flow:
542    Start, End, Jmp, Cond, Return, Raise, Bad, CallBegin, EndReg, EndExcept */
543 int is_cfop(ir_node *node);
544
545 /** Returns true if the operation manipulates interprocedural control flow:
546    CallBegin, EndReg, EndExcept */
547 int is_ip_cfop(ir_node *node);
548 /** Returns true if the operation can change the control flow because
549    of an exception: Call, Quot, DivMod, Div, Mod, Load, Store, Alloc,
550    Bad. */
551 ir_graph *get_ip_cfop_irg(ir_node *n);
552
553 int is_fragile_op(ir_node *node);
554 /** Returns the memory operand of fragile operations. */
555 ir_node *get_fragile_op_mem(ir_node *node);
556
557 #include "ident.h"
558
559 #ifdef __GNUC__
560 /* GNU C has the __FUNCTION__ extension */
561 #define __MYFUNC__ __FUNCTION__
562 #else
563 /* use Filename instead */
564 #define __MYFUNC__ __FILE__
565 #endif
566
567 /* !!!!!!!!! @@@
568    Don't format with "\", firmjni gets problems */
569
570 /** Output the firm kind of the node */
571 #define DDMK(X)  printf("%s(l.%i) %s: %p\n",                 __MYFUNC__, __LINE__,  print_firm_kind(X), (X));
572 /** Output information about a node */
573 #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), (X))
574 /** Output information about a node and its block */
575 #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)))
576 /** Output information about a type */
577 #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), (X))
578 /** Output information about an entity */
579 #define DDME(X)  printf("%s(l.%i) %s: %ld (%p\n",            __MYFUNC__, __LINE__, get_entity_name(X), get_entity_nr(X), (X))
580 /** Output information about an entity and its owner */
581 #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), (X))
582 /** Output information about a graph */
583 #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), (X))
584 /** Output information about an ident */
585 #define DDMI(X)  printf("%s(l.%i) %s: %p\n",                 __MYFUNC__, __LINE__, id_to_str(X), (X))
586 /** Output information about a mode */
587 #define DDMM(X)  printf("%s(l.%i) %s: %p\n",                 __MYFUNC__, __LINE__, get_mode_name(X), (X))
588 /** Output information about a loope */
589 #define DDML(X)  printf("%s(l.%i) loop with depth %d: %p\n", __MYFUNC__, __LINE__, get_loop_depth(X), (X))
590
591 /*@}*/ /* end of ir_node group definition */
592
593
594 # endif /* _IRNODE_H_ */