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