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