projects / libfirm / blob
? search:


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