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