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