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