d2d3b3d11d2828eb0336e116e93a7d13acf80ee6
[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 #ifndef _IRNODE_H_
13 #define _IRNODE_H_
14
15 #include <stddef.h>
16
17 #include "irgraph.h"
18 #include "entity.h"
19 #include "firm_common.h"
20 #include "irop.h"
21 #include "irmode.h"
22 #include "type.h"
23 #include "irextbb.h"
24 #include "dbginfo.h"
25
26 /**
27  * @file irnode.h
28  *
29  * @author Martin Trapp, Christian Schaefer
30  *
31  * Declarations of an ir node.
32  */
33
34 /**
35  * @defgroup ir_node Declarations of an ir node.
36  *
37  * The type definition of ir_node is also in irgraph.h to resolve
38  *  recursion between irnode.h and irgraph.h
39  *
40  * ir_node - a datatype representing a Firm node
41  *
42  *  The common fields are:
43  *
44  *  - firm_kind - A firm_kind tag containing k_type.  This is useful
45  *                for dynamically checking whether a node is a ir_node.
46  *  - arity     - The number of predecessors in the Firm graph.
47  *  - in        - A list with the predecessors in the Firm graph.  There are
48  *                routines to access individual elements and to obtain the
49  *                array.  The method returning the array should not be used.
50  *  - mode      - The mode of the node.  There are routines to get the mode
51  *                but also to access the mode's fields directly.
52  *  - opcode    - The opcode of the node. There are routines to get the opcode
53  *                but also to access the opcode's fields directly.
54  *  - node_nr   - A unique number for the node.  Available only if debugging
55  *                is turned on.
56  * @{
57  */
58
59 #ifndef _IR_NODE_TYPEDEF_
60 #define _IR_NODE_TYPEDEF_
61 typedef struct ir_node ir_node;
62 #endif
63
64 #ifdef __cplusplus
65 extern "C" {
66 #endif
67
68 /**
69  *   you can work on the graph without considering the different types
70  *   of nodes, it's just a big graph.
71  */
72
73 /**
74  *   Checks whether a pointer points to a ir node.
75  *
76  *   @param thing   an arbitrary pointer
77  *   @return        non-zero if the thing is a ir mode, else zero
78  */
79 int is_ir_node (const void *thing);
80
81 /**
82  * Returns the number of predecessors without the block predecessor.
83  *
84  * @param node   the IR-node
85  */
86 int           get_irn_arity         (const ir_node *node);
87 int           get_irn_intra_arity   (const ir_node *node);
88 int           get_irn_inter_arity   (const ir_node *node);
89
90 /** Replaces the old in array by a new one that will contain the ins given in
91    the parameters.  Conserves the block predecessor.  It copies the array passed.
92    This function is necessary to adjust in arrays of blocks, calls and phis.
93    Assumes that current_ir_graph is set to the graph containing "node".
94    "in" must contain all predecessors except the block that are required for
95    the nodes opcode. */
96 void          set_irn_in            (ir_node *node, int arity, ir_node *in[]);
97
98 /* to iterate through the predecessors without touching the array. No
99    order of predecessors guaranteed.
100    To iterate over the operands iterate from 0 to i < get_irn_arity(),
101    to iterate including the Block predecessor iterate from i = -1 to
102    i < get_irn_arity. */
103 /* Access predecessor n */
104
105 /**
106  * Get the n-th predecessor of a node.
107  * This function removes Id predecessors.
108  */
109 ir_node      *get_irn_n             (const ir_node *node, int n);
110 ir_node      *get_irn_intra_n       (const ir_node *node, int n);
111 ir_node      *get_irn_inter_n       (const ir_node *node, int n);
112
113 /** Replace the n-th predecessor of a node with a new one. */
114 void          set_irn_n             (ir_node *node, int n, ir_node *in);
115 /* Sets the mode struct of node.  */
116 void          set_irn_mode (ir_node *node, ir_mode *mode);
117 /** Gets the mode struct of a node.  */
118 ir_mode      *get_irn_mode          (const ir_node *node);
119 /** Gets the mode-enum modecode. */
120 modecode      get_irn_modecode      (const ir_node *node);
121 /** Gets the ident for a string representation of the mode .*/
122 ident        *get_irn_modeident     (const ir_node *node);
123 /** Gets the string representation of the mode .*/
124 const char   *get_irn_modename      (const ir_node *node);
125 /** Gets the opcode struct of the node. */
126 ir_op        *get_irn_op            (const ir_node *node);
127 /** Sets the opcode struct of the node. */
128 void          set_irn_op            (ir_node *node, ir_op *op);
129 /** Gets the opcode-enum of the node. */
130 opcode        get_irn_opcode        (const ir_node *node);
131 /** Get the string representation of the opcode. */
132 const char   *get_irn_opname        (const ir_node *node);
133 /** Get the ident for a string representation of the opcode. */
134 ident        *get_irn_opident       (const ir_node *node);
135 /** Gets the visited counter of a node. */
136 unsigned long get_irn_visited (const ir_node *node);
137 /** Sets the visited counter of a node. */
138 void          set_irn_visited (ir_node *node, unsigned long visited);
139 /** Sets visited to get_irg_visited(current_ir_graph). */
140 void          mark_irn_visited (ir_node *node);
141 /** Returns 1 if visited < get_irg_visited(current_ir_graph). */
142 int           irn_not_visited  (const ir_node *node);
143 /** Returns 1 if visited >= get_irg_visited(current_ir_graph). */
144 int           irn_visited      (const ir_node *node);
145
146 /**
147  * Sets the link of a node.
148  * Only allowed if the graph is NOT in phase_building.
149  */
150 void          set_irn_link     (ir_node *node, void *link);
151
152 /** Returns the link of a node.  */
153 void         *get_irn_link     (const ir_node *node);
154
155 /** Returns the ir_graph this node belongs to. Only valid if irg
156  *  is in state op_pin_state_pinned (irg is only stored in the block. */
157 ir_graph     *get_irn_irg      (const ir_node *node);
158
159 /** Outputs a unique number for this node if libFIRM is compiled for
160    debugging, (configure with --enable-debug) else returns address
161    of node cast to long. */
162 long          get_irn_node_nr  (const ir_node *node);
163
164 /** Returns the pinned state of a node.
165  *
166  *  Returns whether the node _always_ must be pinned.
167  *  I.e., the node is not floating after global cse.
168  *
169  * @returns Either state op_pin_state_pinned or op_pin_state_floats.
170  */
171 op_pin_state get_irn_pinned    (const ir_node *node);
172
173 /** Set pin state for nodes with op pin state op_pin_state_exc_pinned */
174 void set_irn_pinned(ir_node *node, op_pin_state state);
175
176 /** Returns whether the node is currently pinned.
177  *
178  * If get_irn_pinned returns op_pin_state_floats and the graph the
179  * node belongs to is in state op_poin_state_floats then this function
180  * returns 'floats', else 'pinned'.
181  */
182 op_pin_state is_irn_pinned_in_irg (const ir_node *node);
183
184 /**
185  * irnode constructor.
186  * Create a new irnode in irg, with an op, mode, arity and
187  * some incoming irnodes.
188  * This constructor is used in every specified irnode constructor.
189  *
190  * @param db    Debug info.
191  * @param irg   IR-graph on with this new node should be constructed.
192  * @param block The block the new node belongs to
193  * @param op    The opcode of the new node.
194  * @param mode  The mode of the new node.
195  * @param arity The arity of the new node, may be <0 if yet.
196  * @param in    An array of arity predecessor nodes.
197  */
198 ir_node *
199 new_ir_node (dbg_info *db,
200          ir_graph *irg,
201          ir_node *block,
202          ir_op *op,
203          ir_mode *mode,
204          int arity,
205          ir_node *in[]);
206
207 /**
208  * Return the block the node belongs to.  This is only
209  * possible for pinned nodes or if the graph is in pinned state.
210  * Otherwise the block may be incorrect.  This condition is
211  * now checked by an assertion.
212  *
213  * This works for all except Block.  It can return Blocks or the Bad node.
214  *
215  * To express the difference to access routines that work for all
216  * nodes we use infix "nodes" and do not name this function
217  * get_irn_block(). */
218 ir_node  *get_nodes_block (const ir_node *node);
219
220 /** Sets the Block of a node. */
221 void      set_nodes_block (ir_node *node, ir_node *block);
222
223 /**
224  * @function get_irn_block()
225  * @see get_nodes_block()
226  */
227
228 /**
229  * Projection numbers for result of Start node: use for Proj nodes!
230  */
231 typedef enum {
232   pn_Start_X_initial_exec,   /**< Projection on the initial control flow. */
233   pn_Start_M,                /**< Projection on the initial memory. */
234   pn_Start_P_frame_base,     /**< Projection on the frame base pointer. */
235   pn_Start_P_globals,        /**< Projection on the pointer to the data segment
236                                   containing _all_ global entities. */
237   pn_Start_T_args,           /**< Projection on all arguments. */
238   pn_Start_P_value_arg_base, /**< Pointer to region of compound value arguments as defined by
239                                   type of this method. */
240   pn_Start_max               /**< number of projections from a Start */
241 } pn_Start; /* Projection numbers for Start. */
242
243
244 /** Test whether arbitrary node is frame pointer.
245  *
246  * Test whether arbitrary node is frame pointer, i.e. Proj(pn_Start_P_frame_base)
247  * from Start.  If so returns frame type, else Null. */
248 ir_type *is_frame_pointer(ir_node *n);
249
250 /** Test whether arbitrary node is globals pointer.
251  *
252  * Test whether arbitrary node is globals pointer, i.e. Proj(pn_Start_P_globals)
253  * from Start.  If so returns global type, else Null. */
254 ir_type *is_globals_pointer(ir_node *n);
255
256 /** Test whether arbitrary node is value arg base.
257  *
258  * Test whether arbitrary node is value arg base, i.e. Proj(pn_Start_P_value_arg_base)
259  * from Start.   If so returns 1, else 0. */
260 int   is_value_arg_pointer(ir_node *n);
261
262
263 /* @@@ no more supported  */
264 ir_node **get_Block_cfgpred_arr (ir_node *node);
265 int       get_Block_n_cfgpreds (ir_node *node);
266 ir_node  *get_Block_cfgpred (ir_node *node, int pos);
267 void      set_Block_cfgpred (ir_node *node, int pos, ir_node *pred);
268 /** Get the predecessor block.
269  *
270  *  Returns the block corresponding to the predecessor pos of block.
271  *
272  *  There are several ambiguities we resolve with this function:
273  *  - The direct predecessor can be a Proj, which is not pinned.
274  *    We walk from the predecessor to the next pinned node
275  *    (skip_Proj) and return the block that node is in.
276  *  - If we encounter the Bad node, this function does not return
277  *    Start, but the Bad node.
278  */
279 ir_node  *get_Block_cfgpred_block(ir_node *node, int pos);
280 int       get_Block_matured (ir_node *node);
281 void      set_Block_matured (ir_node *node, int matured);
282
283 /** A visited flag only for block nodes.
284  *  @see also: get_irn_visited() inc_irg_visited() inc_irg_block_visited()*/
285 unsigned long get_Block_block_visited (ir_node *node);
286 void      set_Block_block_visited (ir_node *node, unsigned long visit);
287
288 /**
289  * Marks a block as dead but do not replace it with a Bad node.
290  * Dead blocks are removed in the con
291  */
292 ir_node  *set_Block_dead(ir_node *block);
293 int       is_Block_dead(const ir_node *block);
294
295 /* For this current_ir_graph must be set. */
296 void      mark_Block_block_visited(ir_node *node);
297 int       Block_not_block_visited(ir_node *node);
298
299 /* Set and remove interprocedural predecessors. If the interprocedural
300  * predecessors are removed, the node has the same predecessors in
301  * both views.
302  * @@@ Maybe better:  arity is zero if no cg preds. */
303 void      set_Block_cg_cfgpred_arr(ir_node * node, int arity, ir_node ** in);
304 void      set_Block_cg_cfgpred(ir_node * node, int pos, ir_node * pred);
305 /* @@@ not supported */
306 ir_node **get_Block_cg_cfgpred_arr(ir_node * node);
307 /** Returns the number of interprocedural predecessors.  0 if none. */
308 int       get_Block_cg_n_cfgpreds(ir_node * node);
309 /** Return the interprocedural predecessor at position pos. */
310 ir_node  *get_Block_cg_cfgpred(ir_node * node, int pos);
311 /* frees the memory. */
312 void      remove_Block_cg_cfgpred_arr(ir_node * node);
313
314 /** returns the extended basic block a block belongs to */
315 ir_extblk *get_Block_extbb(const ir_node *block);
316 /** sets the extended basic block a block belongs to */
317 void set_Block_extbb(ir_node *block, ir_extblk *extblk);
318
319 /** Return the number of Keep alive node. */
320 int  get_End_n_keepalives(ir_node *end);
321
322 /** Return the Keep alive node a position pos. */
323 ir_node *get_End_keepalive(ir_node *end, int pos);
324
325 /** Keep alive dedicated nodes.  These must be either PhiM or Block nodes. */
326 void add_End_keepalive (ir_node *end, ir_node *ka);
327
328 /** Set the Keep alive node at position pos. */
329 void set_End_keepalive(ir_node *end, int pos, ir_node *ka);
330
331 /** Set new keep-alives */
332 void set_End_keepalives(ir_node *end, int n, ir_node *in[]);
333
334 /** Some parts of the End node are allocated separately -- their memory
335    is not recovered by dead_node_elimination if a End node is dead.
336    free_End() frees these data structures. */
337 void free_End (ir_node *end);
338
339 /** Return the target address of an IJmp */
340 ir_node *get_IJmp_target(ir_node *ijmp);
341
342 /** Sets the target address of an IJmp */
343 void set_IJmp_target(ir_node *ijmp, ir_node *tgt);
344
345 /* We distinguish three kinds of Cond nodes.  These can be distinguished
346    by the mode of the selector operand and an internal flag of type cond_kind.
347    First we distinguish binary Conds and switch Conds.
348    A binary Cond has as selector a boolean value.  Proj(0) projects the control
349    flow for case "False", Proj(1) the control flow for "True".  A binary Cond
350    is recognized by the boolean selector.
351    The switch Cond has as selector an unsigned integer.  It produces as result
352    an n+1 Tuple (cf0, ... , cfn) of control flows.
353    We differ two flavors of this Cond.  The first, the dense Cond, passes
354    control along output i if the selector value is i, 0 <= i <= n.  If the
355    selector value is >n it passes control along output n.
356    The second Cond flavor differences in the treatment of cases not specified in
357    the source program.  It magically knows about the existence of Proj nodes.
358    It only passes control along output i, 0 <= i <= n, if a node Proj(Cond, i)
359    exists.  Else it passes control along output n (even if this Proj does not
360    exist.)  This Cond we call "fragmentary".  There is a special constructor
361    new_defaultProj that automatically sets the flavor.
362    The two switch flavors are distinguished by a flag of type cond_kind.
363    Default flavor is "dense"
364 */
365 typedef enum {
366   dense,        /**< Default. Missing Proj nodes are dead control flow. */
367   fragmentary   /**< Special. No control flow optimizations allowed.  Missing
368            Proj nodes mean default control flow, i.e., Proj(n). */
369 } cond_kind;
370
371 ir_node  *get_Cond_selector (ir_node *node);
372 void      set_Cond_selector (ir_node *node, ir_node *selector);
373 cond_kind get_Cond_kind (ir_node *node);
374 void      set_Cond_kind (ir_node *node, cond_kind kind);
375 long      get_Cond_defaultProj (ir_node *node);
376
377 /**
378  * Projection numbers for conditions.
379  */
380 typedef enum {
381   pn_Cond_false,    /**< Control flow if operand is "false". */
382   pn_Cond_true,     /**< Control flow if operand is "true".  */
383   pn_Cond_max       /**< number of projections from a Cond */
384 } pn_Cond;  /* Projection numbers for Cond. */
385
386 ir_node  *get_Return_mem (ir_node *node);
387 void      set_Return_mem (ir_node *node, ir_node *mem);
388 ir_node **get_Return_res_arr (ir_node *node);
389 int       get_Return_n_ress (ir_node *node);
390 ir_node  *get_Return_res (ir_node *node, int pos);
391 void      set_Return_res (ir_node *node, int pos, ir_node *res);
392
393 typedef enum {
394   CNST_NULL     =  0, /**< The node is a const(0). */
395   CNST_ONE      = +1, /**< The node is a const(1). */
396   CNST_ALL_ONE  = -1, /**< The node is a const(11111...). */
397   CNST_OTHER    =  2, /**< The tarval of the const has another value. */
398   CNST_SYMCONST =  3, /**< The node is symconst. */
399   CNST_NO_CONST =  4  /**< The node is no const at all. */
400 } cnst_classify_t;
401
402 tarval  *get_Const_tarval (ir_node *node);
403 void     set_Const_tarval (ir_node *node, tarval *con);
404
405 /**
406  * Classify a node concerning constant properties.
407  * @param irn A node to check for.
408  * @return Constant properties of that node.
409  */
410 cnst_classify_t classify_Const(ir_node *irn);
411
412 /** Returns the source language type of a Const node.
413  * Must be an atomic type.  Mode of type must be mode of node.
414  */
415 ir_type  *get_Const_type   (ir_node *node);
416
417 /** Sets the source language type of a Const node. */
418 void     set_Const_type   (ir_node *node, ir_type *tp);
419
420 /**  This enum names the three different kinds of symbolic Constants
421      represented by SymConst.  The content of the attribute type_or_id
422      depends on this tag.  Use the proper access routine after testing
423      this flag. */
424 typedef enum {
425   symconst_type_tag,    /**< The SymConst is a type tag for the given type.
426                            Type_or_id_p is type *. */
427   symconst_size,        /**< The SymConst is the size of the given type.
428                            Type_or_id_p is type *. */
429   symconst_addr_name,   /**< The SymConst is a symbolic pointer to be filled in
430                            by the linker.  The pointer is represented by a string.
431                            Type_or_id_p is ident *. */
432   symconst_addr_ent     /**< The SymConst is a symbolic pointer to be filled in
433                            by the linker.  The pointer is represented by an entity.
434                            Type_or_id_p is entity *. */
435 } symconst_kind;
436
437 /** SymConst attribute.
438  *
439  *  This union contains the symbolic information represented by the node.  */
440 union symconst_symbol {
441   ir_type *type_p;
442   ident   *ident_p;
443   entity  *entity_p;
444 };
445
446 typedef union symconst_symbol symconst_symbol;
447
448
449 /** Get the kind of the SymConst. */
450 symconst_kind get_SymConst_kind (const ir_node *node);
451 /** Set the kind of the SymConst. */
452 void          set_SymConst_kind (ir_node *node, symconst_kind num);
453
454 /** Only to access SymConst of kind type_tag or size.  Else assertion: */
455 ir_type  *get_SymConst_type (ir_node *node);
456 void     set_SymConst_type (ir_node *node, ir_type *tp);
457
458 /** Only to access SymConst of kind addr_name.  Else assertion: */
459 ident   *get_SymConst_name (ir_node *node);
460 void     set_SymConst_name (ir_node *node, ident *name);
461
462 /** Only to access SymConst of kind addr_ent.  Else assertion: */
463 entity  *get_SymConst_entity (ir_node *node);
464 void     set_SymConst_entity (ir_node *node, entity *ent);
465
466 /** Sets both: type and ptrinfo.  Needed to treat the node independent of
467    its semantics.  Does a memcpy for the memory sym points to. */
468 /* write 'union': firmjni then does not create a method... */
469 union symconst_symbol get_SymConst_symbol (ir_node *node);
470 void                  set_SymConst_symbol (ir_node *node,
471                                            union symconst_symbol sym);
472
473 /** Access the type of the value represented by the SymConst.
474  *
475  *  Example: primitive type int for SymConst size. */
476 ir_type *get_SymConst_value_type (ir_node *node);
477 void    set_SymConst_value_type (ir_node *node, ir_type *tp);
478
479 ir_node *get_Sel_mem (ir_node *node);
480 void     set_Sel_mem (ir_node *node, ir_node *mem);
481 ir_node *get_Sel_ptr (ir_node *node);  /* ptr to the object to select from */
482 void     set_Sel_ptr (ir_node *node, ir_node *ptr);
483 ir_node **get_Sel_index_arr (ir_node *node);
484 int      get_Sel_n_indexs (ir_node *node);
485 ir_node *get_Sel_index (ir_node *node, int pos);
486 void     set_Sel_index (ir_node *node, int pos, ir_node *index);
487 entity  *get_Sel_entity (ir_node *node); /* entity to select */
488 void     set_Sel_entity (ir_node *node, entity *ent);
489
490 /**
491  * Projection numbers for result of Call node: use for Proj nodes!
492  */
493 typedef enum {
494   pn_Call_M_regular = 0,  /**< The memory result. */
495   pn_Call_T_result  = 2,  /**< The tuple containing all (0, 1, 2, ...) results */
496   pn_Call_P_value_res_base = 4,/**< A pointer to the memory region containing copied results
497                  passed by value (for compound result types). */
498   pn_Call_X_except  = 1,  /**< The control flow result branching to the exception handler */
499   pn_Call_M_except  = 3,  /**< The memory result in case the called method terminated with
500                  an exception */
501   pn_Call_max       = 5   /**< number of projections from a Call */
502 } pn_Call;   /* Projection numbers for Call. */
503 #define pn_Call_M pn_Call_M_regular
504
505 ir_node *get_Call_mem (ir_node *node);
506 void     set_Call_mem (ir_node *node, ir_node *mem);
507 ir_node *get_Call_ptr (ir_node *node);
508 void     set_Call_ptr (ir_node *node, ir_node *ptr);
509 ir_node **get_Call_param_arr (ir_node *node);
510 /** Gets the number of parameters of a call. */
511 int      get_Call_n_params (ir_node *node);
512 /** Gets the call parameter at position pos. */
513 ir_node *get_Call_param (ir_node *node, int pos);
514 /** Sets the call parameter at position pos. */
515 void     set_Call_param (ir_node *node, int pos, ir_node *param);
516 /** Gets the type of a call. */
517 ir_type *get_Call_type (ir_node *node);
518 /** Sets the type of a call. */
519 void     set_Call_type (ir_node *node, ir_type *tp);
520 /** Gets the arity of a call. Identical to get_Call_n_params(). */
521 int      get_Call_arity (ir_node *node);
522
523 /** Set, get and remove the callee information for a Call node.
524  *
525  *  The callee information lists all method entities that can be called
526  *  from this node.  If the address expression can not be analyzed fully,
527  *  e.g., as entities can be called that are not in the compilation unit,
528  *  the array contains the unknown_entity.  The array contains only entities
529  *  with peculiarity_existent, but with all kinds of visibility.  The entities
530  *  not necessarily contain an irg.
531  *
532  *  The array is only accessible if callee information is valid.  See flag
533  *  in graph.
534  *
535  *  The memory allocated for the array is managed automatically, i.e., it must
536  *  not be freed if the Call node is removed from the graph.
537  *
538  *  @param node A Call node.
539  */
540 int     Call_has_callees      (ir_node *node);
541 int     get_Call_n_callees    (ir_node *node);
542 entity *get_Call_callee       (ir_node *node, int pos);
543
544 /** Set the full callee array.
545  *
546  *  The passed array is copied. Assumes current_ir_graph set properly! */
547 void    set_Call_callee_arr   (ir_node *node, const int n, entity **arr);
548 void    remove_Call_callee_arr(ir_node *node);
549
550 ir_node  *get_CallBegin_ptr  (ir_node *node);
551 void      set_CallBegin_ptr  (ir_node *node, ir_node *ptr);
552 ir_node  *get_CallBegin_call (ir_node *node);
553 void      set_CallBegin_call (ir_node *node, ir_node *call);
554
555 /* For unary and binary arithmetic operations the access to the
556    operands can be factored out.  Left is the first, right the
557    second arithmetic value  as listed in tech report 1999-44.
558    unops are: Minus, Abs, Not, Conv, Cast
559    binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
560    Shr, Shrs, Rot, Cmp */
561 int      is_unop (const ir_node *node);
562 ir_node *get_unop_op (ir_node *node);
563 void     set_unop_op (ir_node *node, ir_node *op);
564 int      is_binop (const ir_node *node);
565 ir_node *get_binop_left (ir_node *node);
566 void     set_binop_left (ir_node *node, ir_node *left);
567 ir_node *get_binop_right (ir_node *node);
568 void     set_binop_right (ir_node *node, ir_node *right);
569
570 ir_node *get_Add_left (ir_node *node);
571 void     set_Add_left (ir_node *node, ir_node *left);
572 ir_node *get_Add_right (ir_node *node);
573 void     set_Add_right (ir_node *node, ir_node *right);
574
575 ir_node *get_Sub_left (ir_node *node);
576 void     set_Sub_left (ir_node *node, ir_node *left);
577 ir_node *get_Sub_right (ir_node *node);
578 void     set_Sub_right (ir_node *node, ir_node *right);
579
580 ir_node *get_Minus_op (ir_node *node);
581 void     set_Minus_op (ir_node *node, ir_node *op);
582
583 ir_node *get_Mul_left (ir_node *node);
584 void     set_Mul_left (ir_node *node, ir_node *left);
585 ir_node *get_Mul_right (ir_node *node);
586 void     set_Mul_right (ir_node *node, ir_node *right);
587
588 ir_node *get_Quot_left (ir_node *node);
589 void     set_Quot_left (ir_node *node, ir_node *left);
590 ir_node *get_Quot_right (ir_node *node);
591 void     set_Quot_right (ir_node *node, ir_node *right);
592 ir_node *get_Quot_mem (ir_node *node);
593 void     set_Quot_mem (ir_node *node, ir_node *mem);
594
595 /**
596  * Projection numbers for Quot: use for Proj nodes!
597  */
598 typedef enum {
599   pn_Quot_M,           /**< Memory result.    */
600   pn_Quot_X_except,    /**< Execution result if exception occurred. */
601   pn_Quot_res,         /**< Result of computation. */
602   pn_Quot_max          /**< number of projections from a Quot */
603 } pn_Quot;  /* Projection numbers for Quot. */
604
605 ir_node *get_DivMod_left (ir_node *node);
606 void     set_DivMod_left (ir_node *node, ir_node *left);
607 ir_node *get_DivMod_right (ir_node *node);
608 void     set_DivMod_right (ir_node *node, ir_node *right);
609 ir_node *get_DivMod_mem (ir_node *node);
610 void     set_DivMod_mem (ir_node *node, ir_node *mem);
611
612 /**
613  * Projection numbers for DivMod: use for Proj nodes!
614  */
615 typedef enum {
616   pn_DivMod_M,           /**< Memory result.    */
617   pn_DivMod_X_except,    /**< Execution result if exception occurred. */
618   pn_DivMod_res_div,     /**< Result of computation a / b. */
619   pn_DivMod_res_mod,     /**< Result of computation a % b. */
620   pn_DivMod_max          /**< number of projections from a DivMod */
621 } pn_DivMod;  /* Projection numbers for DivMod. */
622
623 ir_node *get_Div_left (ir_node *node);
624 void     set_Div_left (ir_node *node, ir_node *left);
625 ir_node *get_Div_right (ir_node *node);
626 void     set_Div_right (ir_node *node, ir_node *right);
627 ir_node *get_Div_mem (ir_node *node);
628 void     set_Div_mem (ir_node *node, ir_node *mem);
629
630 /**
631  * Projection numbers for Div: use for Proj nodes!
632  */
633 typedef enum {
634   pn_Div_M,           /**< Memory result.    */
635   pn_Div_X_except,    /**< Execution result if exception occurred. */
636   pn_Div_res,         /**< Result of computation. */
637   pn_Div_max          /**< number of projections from a Div */
638 } pn_Div;  /* Projection numbers for Div. */
639
640 ir_node *get_Mod_left (ir_node *node);
641 void     set_Mod_left (ir_node *node, ir_node *left);
642 ir_node *get_Mod_right (ir_node *node);
643 void     set_Mod_right (ir_node *node, ir_node *right);
644 ir_node *get_Mod_mem (ir_node *node);
645 void     set_Mod_mem (ir_node *node, ir_node *mem);
646
647 /**
648  * Projection numbers for Mod: use for Proj nodes!
649  */
650 typedef enum {
651   pn_Mod_M,           /**< Memory result.    */
652   pn_Mod_X_except,    /**< Execution result if exception occurred. */
653   pn_Mod_res,         /**< Result of computation. */
654   pn_Mod_max          /**< number of projections from a Mod */
655 } pn_Mod;  /* Projection numbers for Mod. */
656
657 ir_node *get_Abs_op (ir_node *node);
658 void     set_Abs_op (ir_node *node, ir_node *op);
659
660 ir_node *get_And_left (ir_node *node);
661 void     set_And_left (ir_node *node, ir_node *left);
662 ir_node *get_And_right (ir_node *node);
663 void     set_And_right (ir_node *node, ir_node *right);
664
665 ir_node *get_Or_left (ir_node *node);
666 void     set_Or_left (ir_node *node, ir_node *left);
667 ir_node *get_Or_right (ir_node *node);
668 void     set_Or_right (ir_node *node, ir_node *right);
669
670 ir_node *get_Eor_left (ir_node *node);
671 void     set_Eor_left (ir_node *node, ir_node *left);
672 ir_node *get_Eor_right (ir_node *node);
673 void     set_Eor_right (ir_node *node, ir_node *right);
674
675 ir_node *get_Not_op (ir_node *node);
676 void     set_Not_op (ir_node *node, ir_node *op);
677
678 /**
679  * Projection numbers for Cmp are defined several times.
680  * The bit patterns are used for various tests, so don't change.
681  * The "unordered" values are possible results of comparing
682  * floating point numbers.
683  * Note that the encoding is imported, so do NOT change the order.
684  */
685 typedef enum {
686   pn_Cmp_False = 0,                             /**< false */
687   pn_Cmp_Eq    = 1,                             /**< equal */
688   pn_Cmp_Lt    = 2,                             /**< less */
689   pn_Cmp_Le    = pn_Cmp_Eq|pn_Cmp_Lt,           /**< less or equal */
690   pn_Cmp_Gt    = 4,                             /**< greater */
691   pn_Cmp_Ge    = pn_Cmp_Eq|pn_Cmp_Gt,           /**< greater or equal */
692   pn_Cmp_Lg    = pn_Cmp_Lt|pn_Cmp_Gt,           /**< less or greater */
693   pn_Cmp_Leg   = pn_Cmp_Lt|pn_Cmp_Eq|pn_Cmp_Gt, /**< less, equal or greater = ordered */
694   pn_Cmp_Uo    = 8,                             /**< unordered */
695   pn_Cmp_Ue    = pn_Cmp_Uo|pn_Cmp_Eq,           /**< unordered or equal */
696   pn_Cmp_Ul    = pn_Cmp_Uo|pn_Cmp_Lt,           /**< unordered or less */
697   pn_Cmp_Ule   = pn_Cmp_Uo|pn_Cmp_Eq|pn_Cmp_Lt, /**< unordered, less or equal */
698   pn_Cmp_Ug    = pn_Cmp_Uo|pn_Cmp_Gt,           /**< unordered or greater */
699   pn_Cmp_Uge   = pn_Cmp_Uo|pn_Cmp_Eq|pn_Cmp_Gt, /**< unordered, greater or equal */
700   pn_Cmp_Ne    = pn_Cmp_Uo|pn_Cmp_Lt|pn_Cmp_Gt, /**< unordered, less or greater = not equal */
701   pn_Cmp_True  = 15                             /**< true */
702   /* not_mask = Leg*/   /* bits to flip to negate comparison * @@ hack for JNI interface */
703 } pn_Cmp;   /* Projection numbers for Cmp */
704 /* #define not_mask pn_Cmp_Leg */
705
706 /** returns the pnc name from an pnc constant */
707 const char *get_pnc_string(int pnc);
708
709 /** Calculates the negated (Complement(R)) pnc condition. */
710 int         get_negated_pnc(int pnc, ir_mode *mode);
711
712 /** Calculates the inversed (R^-1) pnc condition, i.e., "<" --> ">" */
713 int         get_inversed_pnc(int pnc);
714
715 ir_node *get_Cmp_left (ir_node *node);
716 void     set_Cmp_left (ir_node *node, ir_node *left);
717 ir_node *get_Cmp_right (ir_node *node);
718 void     set_Cmp_right (ir_node *node, ir_node *right);
719
720 ir_node *get_Shl_left (ir_node *node);
721 void     set_Shl_left (ir_node *node, ir_node *left);
722 ir_node *get_Shl_right (ir_node *node);
723 void     set_Shl_right (ir_node *node, ir_node *right);
724
725 ir_node *get_Shr_left (ir_node *node);
726 void     set_Shr_left (ir_node *node, ir_node *left);
727 ir_node *get_Shr_right (ir_node *node);
728 void     set_Shr_right (ir_node *node, ir_node *right);
729
730 ir_node *get_Shrs_left (ir_node *node);
731 void     set_Shrs_left (ir_node *node, ir_node *left);
732 ir_node *get_Shrs_right (ir_node *node);
733 void     set_Shrs_right (ir_node *node, ir_node *right);
734
735 ir_node *get_Rot_left (ir_node *node);
736 void     set_Rot_left (ir_node *node, ir_node *left);
737 ir_node *get_Rot_right (ir_node *node);
738 void     set_Rot_right (ir_node *node, ir_node *right);
739
740 ir_node *get_Conv_op (ir_node *node);
741 void     set_Conv_op (ir_node *node, ir_node *op);
742
743 /* Does Cast need a mem operator?
744  * Cast should only depend on the type, not on the state of an
745  * entity.  But:  we initialize various fields after Alloc, that
746  * are accessed in the cast.  This required some precaution, to
747  * get the right memory into the Loads generated from the cast.
748  */
749 ir_node *get_Cast_op (ir_node *node);
750 void     set_Cast_op (ir_node *node, ir_node *op);
751 ir_type *get_Cast_type (ir_node *node);
752 void     set_Cast_type (ir_node *node, ir_type *to_tp);
753
754 /** Checks for upcast.
755  *
756  * Returns true if the Cast node casts a class type to a super type.
757  * Works also for pointers to classes (recursively).
758  */
759 int is_Cast_upcast(ir_node *node);
760
761 /** Checks for downcast.
762  *
763  * Returns true if the Cast node casts a class type to a sub type.
764  * Works also for pointers to classes (recursively).
765  */
766 int is_Cast_downcast(ir_node *node);
767
768
769 /** Returns true if n is Phi or Filter in interprocedural_view.
770    Returns false if irg in phase building and the Phi has zero
771    predecessors: it's a Phi0. */
772 int       is_Phi (const ir_node *n);
773 /** Returns true  if irg in phase building and the Phi has zero
774    predecessors: it's a Phi0. */
775 int       is_Phi0 (const ir_node *n);
776 /* These routines also work for Filter nodes in interprocedural view. */
777 ir_node **get_Phi_preds_arr (ir_node *node);
778 int       get_Phi_n_preds (ir_node *node);
779 ir_node  *get_Phi_pred (ir_node *node, int pos);
780 void      set_Phi_pred (ir_node *node, int pos, ir_node *pred);
781
782 ir_node  *get_Filter_pred(ir_node *node);
783 void      set_Filter_pred(ir_node *node, ir_node *pred);
784 long      get_Filter_proj(ir_node *node);
785 void      set_Filter_proj(ir_node *node, long proj);
786 /* set the interprocedural predecessors, ...d_arr uses current_ir_graph.
787  * @@@ Maybe better:  arity is zero if no cg preds. */
788 void     set_Filter_cg_pred_arr(ir_node * node, int arity, ir_node ** in);
789 void     set_Filter_cg_pred(ir_node * node, int pos, ir_node * pred);
790 int      get_Filter_n_cg_preds(ir_node *node);
791 ir_node *get_Filter_cg_pred(ir_node *node, int pos);
792
793 /** Return true if parameter is a memory operation.
794  *
795  *  A memory operation is an operation that changes the
796  *  memory.  I.e., a Load or a Store operation.
797  */
798 int is_memop(ir_node *node);
799 ir_node *get_memop_mem (ir_node *node);
800 void     set_memop_mem (ir_node *node, ir_node *mem);
801 ir_node *get_memop_ptr (ir_node *node);
802 void     set_memop_ptr (ir_node *node, ir_node *ptr);
803
804 /**
805  * Projection numbers for Load: use for Proj nodes!
806  */
807 typedef enum {
808   pn_Load_M,         /**< Memory result.    */
809   pn_Load_X_except,  /**< Execution result if exception occurred. */
810   pn_Load_res,       /**< Result of load operation. */
811   pn_Load_max        /**< number of projections from a Load */
812 } pn_Load;  /* Projection numbers for Load. */
813
814 ir_node       *get_Load_mem (ir_node *node);
815 void           set_Load_mem (ir_node *node, ir_node *mem);
816 ir_node       *get_Load_ptr (ir_node *node);
817 void           set_Load_ptr (ir_node *node, ir_node *ptr);
818 ir_mode       *get_Load_mode (ir_node *node);
819 void           set_Load_mode (ir_node *node, ir_mode *mode);
820 ent_volatility get_Load_volatility (ir_node *node);
821 void           set_Load_volatility (ir_node *node, ent_volatility volatility);
822
823 /**
824  * Projection numbers for Store: use for Proj nodes!
825  */
826 typedef enum {
827   pn_Store_M,         /**< Memory result.    */
828   pn_Store_X_except,  /**< Execution result if exception occurred. */
829   pn_Store_max        /**< number of projections from a Store */
830 } pn_Store;  /* Projection numbers for Store. */
831
832 ir_node       *get_Store_mem (ir_node *node);
833 void           set_Store_mem (ir_node *node, ir_node *mem);
834 ir_node       *get_Store_ptr (ir_node *node);
835 void           set_Store_ptr (ir_node *node, ir_node *ptr);
836 ir_node       *get_Store_value (ir_node *node);
837 void           set_Store_value (ir_node *node, ir_node *value);
838 ent_volatility get_Store_volatility (ir_node *node);
839 void           set_Store_volatility (ir_node *node, ent_volatility volatility);
840
841 /**
842  * Projection numbers for Alloc: use for Proj nodes!
843  */
844 typedef enum {
845   pn_Alloc_M,         /**< Memory result. */
846   pn_Alloc_X_except,  /**< Execution result if exception occurred. */
847   pn_Alloc_res,       /**< Result of allocation. */
848   pn_Alloc_max        /**< number of projections from an Alloc */
849 } pn_Alloc;  /* Projection numbers for Alloc. */
850
851 ir_node *get_Alloc_mem (ir_node *node);
852 void     set_Alloc_mem (ir_node *node, ir_node *mem);
853 ir_node *get_Alloc_size (ir_node *node);
854 void     set_Alloc_size (ir_node *node, ir_node *size);
855 ir_type *get_Alloc_type (ir_node *node);
856 void     set_Alloc_type (ir_node *node, ir_type *tp);
857
858 /** The allocation place. */
859 typedef enum {
860   stack_alloc,          /**< Alloc allocates the object on the stack. */
861   heap_alloc            /**< Alloc allocates the object on the heap. */
862 } where_alloc;
863
864 where_alloc  get_Alloc_where (ir_node *node);
865 void         set_Alloc_where (ir_node *node, where_alloc where);
866
867 ir_node *get_Free_mem (ir_node *node);
868 void     set_Free_mem (ir_node *node, ir_node *mem);
869 ir_node *get_Free_ptr (ir_node *node);
870 void     set_Free_ptr (ir_node *node, ir_node *ptr);
871 ir_node *get_Free_size (ir_node *node);
872 void     set_Free_size (ir_node *node, ir_node *size);
873 ir_type *get_Free_type (ir_node *node);
874 void     set_Free_type (ir_node *node, ir_type *tp);
875
876 where_alloc  get_Free_where (ir_node *node);
877 void         set_Free_where (ir_node *node, where_alloc where);
878
879 ir_node **get_Sync_preds_arr (ir_node *node);
880 int       get_Sync_n_preds (ir_node *node);
881 ir_node  *get_Sync_pred (ir_node *node, int pos);
882 void      set_Sync_pred (ir_node *node, int pos, ir_node *pred);
883
884 /** Returns the source language type of a Proj node.
885  * Must be an atomic type.  Mode of type must be mode of node.
886  */
887 ir_type  *get_Proj_type (ir_node *node);
888
889 /** Return the predecessor of a Proj node. */
890 ir_node  *get_Proj_pred (const ir_node *node);
891 void      set_Proj_pred (ir_node *node, ir_node *pred);
892 /** Return the projection number of a Proj node. */
893 long      get_Proj_proj (const ir_node *node);
894 void      set_Proj_proj (ir_node *node, long proj);
895
896 ir_node **get_Tuple_preds_arr (ir_node *node);
897 int       get_Tuple_n_preds (ir_node *node);
898 ir_node  *get_Tuple_pred (ir_node *node, int pos);
899 void      set_Tuple_pred (ir_node *node, int pos, ir_node *pred);
900
901 ir_node  *get_Id_pred (ir_node *node);
902 void      set_Id_pred (ir_node *node, ir_node *pred);
903
904 /** Confirm has a single result and returns 'value' unchanged.
905  *  The node expresses a restriction on 'value':
906  *  'value' 'cmp' 'bound' == true.                                 */
907 ir_node *get_Confirm_value (ir_node *node);
908 void     set_Confirm_value (ir_node *node, ir_node *value);
909 ir_node *get_Confirm_bound (ir_node *node);
910 void     set_Confirm_bound (ir_node *node, ir_node *bound);
911 pn_Cmp   get_Confirm_cmp   (ir_node *node);
912 void     set_Confirm_cmp   (ir_node *node, pn_Cmp cmp);
913
914 /*
915  * Mux Support: Note that Psi nodes with one condition can be handled
916  * like Mux nodes, and the access functions work as expected.
917  */
918 ir_node *get_Mux_sel   (ir_node *node);
919 void     set_Mux_sel   (ir_node *node, ir_node *sel);
920 ir_node *get_Mux_false (ir_node *node);
921 void     set_Mux_false (ir_node *node, ir_node *ir_false);
922 ir_node *get_Mux_true  (ir_node *node);
923 void     set_Mux_true  (ir_node *node, ir_node *ir_true);
924
925 ir_node *get_Psi_cond   (ir_node *node, int pos);
926 void     set_Psi_cond   (ir_node *node, int pos, ir_node *cond);
927 ir_node *get_Psi_val    (ir_node *node, int pos);
928 void     set_Psi_val    (ir_node *node, int pos, ir_node *val);
929 ir_node *get_Psi_default(ir_node *node);
930 void     set_Psi_default(ir_node *node, ir_node *val);
931 int      get_Psi_n_conds(ir_node *node);
932
933 /**
934  * Projection numbers for result of CopyB node: use for Proj nodes!
935  */
936 typedef enum {
937   pn_CopyB_M_regular = 0,  /**< The memory result. */
938   pn_CopyB_X_except  = 1,  /**< The control flow result branching to the exception handler */
939   pn_CopyB_M_except  = 2,  /**< The memory result in case the runtime function terminated with
940                  an exception */
941   pn_CopyB_max       = 3   /**< number of projections from a CopyB */
942 } pn_CopyB;   /* Projection numbers for CopyB. */
943 #define pn_CopyB_M pn_CopyB_M_regular
944
945 ir_node *get_CopyB_mem (ir_node *node);
946 void     set_CopyB_mem (ir_node *node, ir_node *mem);
947 ir_node *get_CopyB_dst (ir_node *node);
948 void     set_CopyB_dst (ir_node *node, ir_node *dst);
949 ir_node *get_CopyB_src (ir_node *node);
950 void     set_CopyB_src (ir_node *node, ir_node *src);
951 ir_type *get_CopyB_type(ir_node *node);
952 void     set_CopyB_type(ir_node *node, ir_type *data_type);
953
954 /**
955  * Projection numbers for result of InstOf node: use for Proj nodes!
956  */
957 typedef enum {
958   pn_InstOf_M_regular = 0,   /**< The memory result. */
959   pn_InstOf_X_except = 1,    /**< The control flow result branching to the exception handler */
960   pn_InstOf_res = 2,         /**< The checked object pointer. */
961   pn_InstOf_M_except = 3,    /**< The memory result in case the runtime function terminated with
962                                  an exception */
963   pn_InstOf_max = 4          /**< number of projections from an InstOf */
964 } pn_InstOf;
965 #define pn_InstOf_M pn_InstOf_M_regular
966
967 /** InstOf access */
968 ir_type *get_InstOf_type (ir_node *node);
969 void    set_InstOf_type (ir_node *node, ir_type *type);
970 ir_node *get_InstOf_store (ir_node *node);
971 void    set_InstOf_store (ir_node *node, ir_node *obj);
972 ir_node *get_InstOf_obj (ir_node *node);
973 void    set_InstOf_obj (ir_node *node, ir_node *obj);
974
975 /**
976  * Projection numbers for Raise.
977  */
978 typedef enum {
979   pn_Raise_X = 0,  /**< The control flow to the exception handler. */
980   pn_Raise_M = 1,  /**< The Memory result. */
981   pn_Raise_max     /**< number of projections from a Raise */
982 } pn_Raise;  /* Projection numbers for Raise. */
983
984 ir_node *get_Raise_mem (ir_node *node);
985 void     set_Raise_mem (ir_node *node, ir_node *mem);
986 ir_node *get_Raise_exo_ptr (ir_node *node);  /* PoinTeR to EXception Object */
987 void     set_Raise_exo_ptr (ir_node *node, ir_node *exoptr);
988
989 /**
990  * Projection numbers for result of Bound node: use for Proj nodes!
991  */
992 typedef enum {
993   pn_Bound_M_regular = 0,   /**< The memory result. */
994   pn_Bound_X_except = 1,    /**< The control flow result branching to the exception handler */
995   pn_Bound_res = 2,         /**< The checked index. */
996   pn_Bound_M_except = 3,    /**< The memory result in case the runtime function terminated with
997                                  an exception */
998   pn_Bound_max = 4          /**< number of projections from a Bound */
999 } pn_Bound;
1000 #define pn_Bound_M pn_Bound_M_regular
1001
1002 /** Returns the memory input of a Bound operation. */
1003 ir_node *get_Bound_mem(ir_node *bound);
1004 void     set_Bound_mem (ir_node *bound, ir_node *mem);
1005
1006 /** Returns the index input of a Bound operation. */
1007 ir_node *get_Bound_index(ir_node *bound);
1008 void     set_Bound_index(ir_node *bound, ir_node *idx);
1009
1010 /** Returns the lower bound input of a Bound operation. */
1011 ir_node *get_Bound_lower(ir_node *bound);
1012 void     set_Bound_lower(ir_node *bound, ir_node *lower);
1013
1014 /** Returns the upper bound input of a Bound operation. */
1015 ir_node *get_Bound_upper(ir_node *bound);
1016 void     set_Bound_upper(ir_node *bound, ir_node *upper);
1017
1018 /*
1019  *
1020  * NAME Auxiliary routines
1021  *
1022  *  Not properly documented ;-)
1023  *
1024  */
1025
1026 /** returns operand of node if node is a Proj. */
1027 ir_node *skip_Proj (ir_node *node);
1028 /** returns operand of node if node is a Id */
1029 ir_node *skip_Id  (ir_node *node);   /* Old name is skip_nop(). */
1030 /** returns corresponding operand of Tuple if node is a Proj from
1031    a Tuple. */
1032 ir_node *skip_Tuple (ir_node *node);
1033 /** returns operand of node if node is a Cast */
1034 ir_node *skip_Cast  (ir_node *node);
1035 /** returns operand of node if node is a Confirm */
1036 ir_node *skip_Confirm  (ir_node *node);
1037 /** Skip all high-level Operations. */
1038 ir_node *skip_HighLevel(ir_node *node);
1039 /** returns true if irn is a Const node. */
1040 int                      is_Const(const ir_node *node);
1041 /** returns true if node is a Bad node. */
1042 int      is_Bad    (const ir_node *node);
1043 /** returns true if the node is not a Block */
1044 int      is_no_Block (const ir_node *node);
1045 /** returns true if the node is a Block */
1046 int      is_Block (const ir_node *node);
1047 /** returns true if node is an Unknown node. */
1048 int      is_Unknown (const ir_node *node);
1049 /** returns true if node is a Return node. */
1050 int      is_Return (const ir_node *node);
1051 /** returns true if node is a Call node. */
1052 int      is_Call (const ir_node *node);
1053 /** returns true if node is a Sel node. */
1054 int      is_Sel (const ir_node *node);
1055 /** returns true if node is a Mux node or a Psi with only one condition. */
1056 int      is_Mux (const ir_node *node);
1057 /** returns true if node is a Proj node or a Filter node in
1058  * intraprocedural view */
1059 int      is_Proj (const ir_node *node);
1060 /** Returns true if the operation manipulates control flow:
1061    Start, End, Jmp, Cond, Return, Raise, Bad, CallBegin, EndReg, EndExcept */
1062 int is_cfop(const ir_node *node);
1063
1064 /** Returns true if the operation manipulates interprocedural control flow:
1065     CallBegin, EndReg, EndExcept */
1066 int is_ip_cfop(const ir_node *node);
1067 /** Returns true if the operation can change the control flow because
1068     of an exception: Call, Quot, DivMod, Div, Mod, Load, Store, Alloc,
1069     Bad. Raise is not fragile, but a unconditional jump. */
1070 int is_fragile_op(const ir_node *node);
1071 /** Returns the memory operand of fragile operations. */
1072 ir_node *get_fragile_op_mem(ir_node *node);
1073
1074 /** Returns true if the operation is a forking control flow
1075  *  operation: Cond. */
1076 int is_irn_forking(const ir_node *node);
1077
1078 /** Return the type associated with the value produced by n
1079  *  if the node remarks this type as it is the case for
1080  *  Cast, Const, SymConst and some Proj nodes or unknown_type. */
1081 ir_type *get_irn_type(ir_node *n);
1082
1083 /** Return the type attribute of a node n (SymConst, Call, Alloc, Free,
1084     Cast) or NULL.*/
1085 ir_type *get_irn_type_attr(ir_node *n);
1086
1087 /** Return the entity attribute of a node n (SymConst, Sel) or NULL. */
1088 entity *get_irn_entity_attr(ir_node *n);
1089
1090 /** Returns non-zero for constant-like nodes. */
1091 int is_irn_constlike(const ir_node *node);
1092
1093 /**
1094  * Returns non-zero for nodes that are allowed to have keep-alives and
1095  * are neither Block nor PhiM.
1096  */
1097 int is_irn_keep(const ir_node *node);
1098
1099 /**
1100  * Returns non-zero for nodes that are machine operations.
1101  */
1102 int is_irn_machine_op(const ir_node *node);
1103
1104 /**
1105  * Returns non-zero for nodes that are machine operands.
1106  */
1107 int is_irn_machine_operand(const ir_node *node);
1108
1109 /**
1110  * Returns non-zero for nodes that have the n'th user machine flag set.
1111  */
1112 int is_irn_machine_user(const ir_node *node, unsigned n);
1113
1114 /**
1115  * A type to express conditional jump predictions.
1116  */
1117 typedef enum {
1118   COND_JMP_PRED_NONE,        /**< No jump prediction. Default. */
1119   COND_JMP_PRED_TRUE,        /**< The True case is predicted. */
1120   COND_JMP_PRED_FALSE        /**< The False case is predicted. */
1121 } cond_jmp_predicate;
1122
1123 /** Gets the string representation of the jump prediction .*/
1124 const char *get_cond_jmp_predicate_name(cond_jmp_predicate pred);
1125
1126 /** Returns the conditional jump prediction of a Cond node. */
1127 cond_jmp_predicate get_Cond_jmp_pred(ir_node *cond);
1128
1129 /** Sets a new conditional jump prediction. */
1130 void set_Cond_jmp_pred(ir_node *cond, cond_jmp_predicate pred);
1131
1132 /**
1133  * Access custom node data.
1134  * The data must have been registered with
1135  * register_additional_node_data() before.
1136  * @param node The ir node to get the data from.
1137  * @param type The type of the data you registered.
1138  * @param off The value returned by register_additional_node_data().
1139  * @return A pointer of type @p type.
1140  */
1141 #define get_irn_data(node,type,off) \
1142   (assert(off > 0 && "Invalid node data offset"), (type *) ((char *) (node) - (off)))
1143
1144 /**
1145  * Get the pointer to the node some custom data belongs to.
1146  * @param data The pointer to the custom data.
1147  * @param off The number as returned by register_additional_node_data().
1148  * @return A pointer to the ir node the custom data belongs to.
1149  */
1150 #define get_irn_data_base(data,off) \
1151   (assert(off > 0 && "Invalid node data offset"), (ir_node *) ((char *) (data) + (off)))
1152
1153 /**
1154  * Request additional data to be allocated with an ir node.
1155  * @param size The size of the additional data required.
1156  * @return A positive number, if the operation was successful, which
1157  * must be passed to the access macro get_irn_data(), 0 if the
1158  * registration failed.
1159  */
1160 unsigned register_additional_node_data(unsigned size);
1161
1162 /**
1163  * Return a pointer to the node attributes.
1164  * Needed for user-defined nodes.
1165  */
1166 void *get_irn_generic_attr(ir_node *node);
1167
1168 /**
1169  * Returns the unique node index for the node in its graph.
1170  * This index is used to access phase information for this node.
1171  */
1172 unsigned get_irn_idx(const ir_node *node);
1173
1174 /*-----------------------------------------------------------------*/
1175 /** Debug aides                                                   **/
1176 /*-----------------------------------------------------------------*/
1177
1178
1179 /** Debug print the node.
1180  *
1181  *  Writes the node, all its attributes and the predecessors to stdout if DEBUG_libfirm
1182  *  is set.  Else does nothing. */
1183 void    dump_irn(ir_node *n);
1184
1185 #include "ident.h"
1186 #include <stdio.h>
1187
1188 #ifdef __GNUC__
1189 /* GNU C has the __FUNCTION__ extension */
1190 #define __MYFUNC__ __FUNCTION__
1191 #else
1192 /* use Filename instead */
1193 #define __MYFUNC__ __FILE__
1194 #endif
1195
1196 /* !!!!!!!!! @@@
1197    Don't format with "\", firmjni gets problems */
1198 /** Output location */
1199 #define DDM      printf("%s(l.%i).\n",                       __MYFUNC__, __LINE__);
1200 /** Output the firm kind of the node */
1201 #define DDMK(X)  printf("%s(l.%i) %s: %p\n",                 __MYFUNC__, __LINE__,  print_firm_kind(X), (void *)(X));
1202 /** Output information about a node */
1203
1204 /*#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))*/
1205 int dump_node_opcode(FILE *F, ir_node *n);
1206 #define DDMN(X)  do { printf("%s(l.%i) ", __MYFUNC__, __LINE__); dump_node_opcode(stdout, X); printf(": %ld (%p)\n", get_irn_node_nr(X), (void *)(X)); } while (0)
1207
1208 /** Output information about a node and its block */
1209 #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)))
1210 /** Output information about a type */
1211 #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))
1212 /** Output information about an entity */
1213 #define DDME(X)  printf("%s(l.%i) %s: %ld (%p)\n",           __MYFUNC__, __LINE__, get_entity_name(X), get_entity_nr(X), (void *)(X))
1214 /** Output information about an entity and its type */
1215 #define DDMET(X) printf("%s(l.%i) %s (typ: %s): %ld (%p)\n", __MYFUNC__, __LINE__, get_entity_name(X), get_type_name(get_entity_type(X)), get_entity_nr(X), (void *)(X))
1216 /** Output information about an entity and its owner */
1217 #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))
1218 /** Output information about a graph */
1219 #define DDMG(X)  printf("%s(l.%i) graph %s: %ld (%p) in %s %s.\n", __MYFUNC__, __LINE__, get_entity_name(get_irg_entity(X)), get_irg_graph_nr(X), (void *)(X), get_type_tpop_name(get_entity_owner(get_irg_entity(X))), get_type_name(get_entity_owner(get_irg_entity(X))))
1220 /** Output information about an ident */
1221 #define DDMI(X)  printf("%s(l.%i) %s: %p\n",                 __MYFUNC__, __LINE__, get_id_str(X), (void *)(X))
1222 /** Output information about a mode */
1223 #define DDMM(X)  printf("%s(l.%i) %s: %p\n",                 __MYFUNC__, __LINE__, get_mode_name(X), (void *)(X))
1224 /** Output information about a loop */
1225 #define DDML(X)  printf("%s(l.%i) loop with depth %d: %d\n", __MYFUNC__, __LINE__, get_loop_depth(X), get_loop_loop_nr(X))
1226 /** Output information about a tarVal */
1227 #define DDMV(X)  printf("%s(l.%i) tarval: ",__MYFUNC__, __LINE__); tarval_printf(X); printf(" (%p)\n", (void *)(X));
1228
1229 /*@}*/ /* end of ir_node group definition */
1230
1231
1232 #ifdef __cplusplus
1233 }
1234 #endif
1235
1236 #endif /* _IRNODE_H_ */