irnode.h 36.2 KB
Newer Older
Götz Lindenmaier's avatar
Götz Lindenmaier committed
1
2
3
4
5
6
7
8
9
10
/*
 * Project:     libFIRM
 * File name:   ir/ir/irnode.h
 * Purpose:     Representation of an intermediate operation.
 * Author:      Martin Trapp, Christian Schaefer
 * Modified by: Goetz Lindenmaier
 * Created:
 * CVS-ID:      $Id$
 * Copyright:   (c) 1998-2003 Universität Karlsruhe
 * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
Michael Beck's avatar
Michael Beck committed
11
12
 */

Christian Schäfer's avatar
Christian Schäfer committed
13
14
15
# ifndef _IRNODE_H_
# define _IRNODE_H_

16
17
18
19
/**
 * Projection numbers of compare: use for Proj nodes!
 * @remark there are numbers with normalized names below!
 */
20
typedef enum {
Florian Liekweg's avatar
Florian Liekweg committed
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
  False = 0,        /**< false */
  Eq,           /**< equal */
  Lt,           /**< less */
  Le,           /**< less or equal */
  Gt,           /**< greater */
  Ge,           /**< greater or equal */
  Lg,           /**< less or greater */
  Leg = 7,      /**< less, equal or greater = ordered */
  Uo,           /**< unordered */
  Ue,           /**< unordered or equal */
  Ul,           /**< unordered or less */
  Ule,          /**< unordered, less or equal */
  Ug,           /**< unordered or greater */
  Uge,          /**< unordered, greater or equal */
  Ne,           /**< unordered, less or greater = not equal */
  True = 15         /**< true */
  /* not_mask = Leg*/   /* bits to flip to negate comparison * @@ hack for jni interface */
38
} pnc_number;   /* pnc: Projection Number Cmp */
39
40
41
#define not_mask Leg

# include "tv.h"
Christian Schäfer's avatar
Christian Schäfer committed
42
# include "irgraph.h"
Christian Schäfer's avatar
Christian Schäfer committed
43
# include "entity.h"
44
# include "firm_common.h"
Christian Schäfer's avatar
Christian Schäfer committed
45
46
47
# include "irop.h"
# include "irmode.h"
# include "type.h"
Götz Lindenmaier's avatar
Götz Lindenmaier committed
48
# include "dbginfo.h"
49
/* # include "exc.h" */
Christian Schäfer's avatar
Christian Schäfer committed
50

Michael Beck's avatar
Michael Beck committed
51
52
/**
 * @file irnode.h
Götz Lindenmaier's avatar
Götz Lindenmaier committed
53
 *
Michael Beck's avatar
Michael Beck committed
54
 * @author Martin Trapp, Christian Schaefer
Götz Lindenmaier's avatar
Götz Lindenmaier committed
55
 *
Michael Beck's avatar
Michael Beck committed
56
57
58
59
60
61
 * Declarations of an ir node.
 */

/**
 * @defgroup ir_node Declarations of an ir node.
 *
62
 * The type definition of ir_node is also in irgraph.h to resolve
Michael Beck's avatar
Michael Beck committed
63
 *  recursion between irnode.h and irgraph.h
Götz Lindenmaier's avatar
Götz Lindenmaier committed
64
 *
Michael Beck's avatar
Michael Beck committed
65
 * ir_node - a datatype representing a Firm node
Götz Lindenmaier's avatar
Götz Lindenmaier committed
66
 *
Michael Beck's avatar
Michael Beck committed
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 *  The common fields are:
 *
 *  - firm_kind - A firm_kind tag containing k_type.  This is useful
 *                for dynamically checking whether a node is a ir_node.
 *  - arity     - The number of predecessors in the Firm graph.
 *  - in        - A list with the predecessors in the Firm graph.  There are
 *                routines to access individual elements and to obtain the
 *                array.  The method returning the array should not be used.
 *  - mode      - The mode of the node.  There are routines to get the mode
 *                but also to access the mode's fields directly.
 *  - opcode    - The opcode of the node. There are routines to get the opcode
 *                but also to access the opcode's fields directly.
 *  - node_nr   - A unique number for the node.  Available only if debugging
 *                is turned on.
 * @{
Götz Lindenmaier's avatar
Götz Lindenmaier committed
82
 */
Michael Beck's avatar
Michael Beck committed
83

Götz Lindenmaier's avatar
Götz Lindenmaier committed
84
85
#ifndef _IR_NODE_TYPEDEF_
#define _IR_NODE_TYPEDEF_
Christian Schäfer's avatar
Christian Schäfer committed
86
87
88
typedef struct ir_node ir_node;
#endif

Sebastian Felis's avatar
Sebastian Felis committed
89
/**
Michael Beck's avatar
Michael Beck committed
90
91
92
 *   you can work on the graph without considering the different types
 *   of nodes, it's just a big graph.
 */
Christian Schäfer's avatar
Christian Schäfer committed
93

Sebastian Felis's avatar
Sebastian Felis committed
94
95
96
97
98
99
100
101
102
/**
 *   Checks whether a pointer points to a ir node.
 *
 *   @param thing     an arbitrary pointer
 *
 *   @return
 *       true if the thing is a ir mode, else false
 */
int
103
is_ir_node (const void *thing);
Sebastian Felis's avatar
Sebastian Felis committed
104

Michael Beck's avatar
Michael Beck committed
105
/** returns the number of predecessors without the block predecessor: */
106
int                  get_irn_arity         (const ir_node *node);
107
108
int           get_irn_intra_arity   (const ir_node *node);
int           get_irn_inter_arity   (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
109
110

/** Replaces the old in array by a new one that will contain the ins given in
111
   the parameters.  Conserves the block predecessor.  It copies the array passed.
112
   This function is necessary to adjust in arrays of blocks, calls and phis.
113
   Assumes that current_ir_graph is set to the graph containing "node".
114
115
   "in" must contain all predecessors except the block that are required for
   the nodes opcode. */
116
void          set_irn_in            (ir_node *node, int arity,
Florian Liekweg's avatar
Florian Liekweg committed
117
                        ir_node *in[]);
Christian Schäfer's avatar
Christian Schäfer committed
118
119
120
/* to iterate through the predecessors without touching the array. No
   order of predecessors guaranteed.
   To iterate over the operands iterate from 0 to i < get_irn_arity(),
Götz Lindenmaier's avatar
Götz Lindenmaier committed
121
   to iterate including the Block predecessor iterate from i = -1 to
Christian Schäfer's avatar
Christian Schäfer committed
122
   i < get_irn_arity. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
123
/* Access predecessor n */
124
/* get_irn_n removes Id predecessors. */
125
126
127
128
ir_node      *get_irn_n             (ir_node *node, int n);
ir_node      *get_irn_intra_n       (ir_node *node, int n);
ir_node      *get_irn_inter_n       (ir_node *node, int n);
void          set_irn_n             (ir_node *node, int n, ir_node *in);
129
/** Sets the mode struct of node */
130
void          set_irn_mode (ir_node *node, ir_mode *mode);
Michael Beck's avatar
Michael Beck committed
131
/** Gets the mode struct. */
132
ir_mode      *get_irn_mode          (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
133
/** Gets the mode-enum modecode. */
134
modecode      get_irn_modecode      (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
135
/** Gets the ident for a string representation of the mode .*/
136
ident        *get_irn_modeident     (const ir_node *node);
137
/** Gets the string representation of the mode .*/
138
const char   *get_irn_modename      (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
139
/** Gets the opcode struct of the node */
140
ir_op        *get_irn_op            (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
141
/** Sets the opcode struct of the node. */
142
void          set_irn_op            (ir_node *node, ir_op *op);
Michael Beck's avatar
Michael Beck committed
143
/** Gets the opcode-enum of the node. */
144
opcode        get_irn_opcode        (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
145
/** Get the string representation of the opcode. */
146
const char   *get_irn_opname        (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
147
/** Get the ident for a string representation of the opcode. */
148
149
150
ident        *get_irn_opident       (const ir_node *node);
unsigned long get_irn_visited (const ir_node *node);
void          set_irn_visited (ir_node *node, unsigned long visited);
Michael Beck's avatar
Michael Beck committed
151
/** Sets visited to get_irg_visited(current_ir_graph). */
152
void          mark_irn_visited (ir_node *node);
Michael Beck's avatar
Michael Beck committed
153
/** Returns 1 if visited < get_irg_visited(current_ir_graph).  */
154
int           irn_not_visited  (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
155
/** Returns 1 if visited >= get_irg_visited(current_ir_graph).  */
156
157
158
int           irn_visited      (const ir_node *node);
void          set_irn_link     (ir_node *node, void *link);
void         *get_irn_link     (const ir_node *node);
159
160
161

/** Returns the ir_graph this node belongs to. Only valid if irg
 *  is in state pinned (irg is only stored in the block. */
162
ir_graph     *get_irn_irg      (ir_node *node);
Michael Beck's avatar
Michael Beck committed
163

164
/** Outputs a unique number for this node if libFIRM is compiled for
165
166
   debugging, (configure with --enable-debug) else returns address
   of node cast to long. */
167
long          get_irn_node_nr  (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
168

Götz Lindenmaier's avatar
Götz Lindenmaier committed
169

Michael Beck's avatar
Michael Beck committed
170
171
172
173
/**
 * irnode constructor.
 * Create a new irnode in irg, with an op, mode, arity and
 * some incoming irnodes.
174
175
176
177
178
179
180
181
 * This constructor is used in every specified irnode constructor.
 *
 * @param db    Debug info.
 * @param irg   IR-graph on with this new node should be constructed.
 * @param op    The opcode of the new node.
 * @param mode  The mode of the new node.
 * @param arity The arity of the new node, may be <0 if yet.
 * @param in    An array of arity predecessor nodes.
Michael Beck's avatar
Michael Beck committed
182
 */
183
ir_node *
Götz Lindenmaier's avatar
Götz Lindenmaier committed
184
new_ir_node (dbg_info *db,
Florian Liekweg's avatar
Florian Liekweg committed
185
186
187
188
189
190
         ir_graph *irg,
         ir_node *block,
         ir_op *op,
         ir_mode *mode,
         int arity,
         ir_node *in[]);
Christian Schäfer's avatar
Christian Schäfer committed
191

Michael Beck's avatar
Michael Beck committed
192
/*
Götz Lindenmaier's avatar
Götz Lindenmaier committed
193
194
195
 *
 * NAME access functions for node fields.
 *
Sebastian Felis's avatar
Sebastian Felis committed
196
 *  Not properly documented ;-)
Götz Lindenmaier's avatar
Götz Lindenmaier committed
197
198
 *
 */
Christian Schäfer's avatar
Christian Schäfer committed
199

Götz Lindenmaier's avatar
comment    
Götz Lindenmaier committed
200
201
202
/* This works for all except Block.  To express the difference to
 * access routines that work for all nodes we use infix "nodes". */
#define get_nodes_block get_nodes_Block
203
ir_node  *get_nodes_Block (ir_node *node);
Götz Lindenmaier's avatar
comment    
Götz Lindenmaier committed
204
#define set_nodes_block set_nodes_Block
205
void      set_nodes_Block (ir_node *node, ir_node *block);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
206

207
208
209
210
211
212
213
214
/**
 * Projection numbers for result of Start node: use for Proj nodes!
 */
typedef enum {
  pn_Start_X_initial_exec,  /**< Projection on the initial control flow. */
  pn_Start_M,               /**< Projection on the initial memory. */
  pn_Start_P_frame_base,    /**< Projection on the frame base pointer. */
  pn_Start_P_globals,       /**< Projection on the pointer to the data segment
Florian Liekweg's avatar
Florian Liekweg committed
215
                   containing _all_ global entities. */
216
217
  pn_Start_T_args,          /**< Projection on all arguments. */
  pn_Start_P_value_arg_base /**< Pointer to region of compound value arguments as defined by
Florian Liekweg's avatar
Florian Liekweg committed
218
                   type of this method. */
219
220
221
222
223
224
} pn_Start; /* Projection numbers for Start. */

/**
 * Projection numbers for result of Start node: use for Proj nodes!
 * @remark This is the old name convention, don't use anymore.
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
225
typedef enum {
Michael Beck's avatar
Michael Beck committed
226
  pns_initial_exec,     /**< Projection on an executable, the initial control
Florian Liekweg's avatar
Florian Liekweg committed
227
               flow. */
Michael Beck's avatar
Michael Beck committed
228
229
230
  pns_global_store,     /**< Projection on the global store */
  pns_frame_base,       /**< Projection on the frame base */
  pns_globals,          /**< Projection on the pointer to the data segment
Florian Liekweg's avatar
Florian Liekweg committed
231
                 containing _all_ global entities. */
232
233
  pns_args,             /**< Projection on all arguments */
  pns_value_arg_base    /**< Pointer to region of compound value arguments as defined by
Florian Liekweg's avatar
Florian Liekweg committed
234
                 type of this method. */
235
} pns_number; /* pns: Projection Number Start */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
236

237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
/** Test whether arbitrary node is frame pointer.
 *
 * Test whether arbitrary node is frame pointer, i.e. Proj(pn_Start_P_frame_base)
 * from Start.  If so returns frame type, else Null. */
type *is_frame_pointer(ir_node *n);

/** Test whether arbitrary node is globals pointer.
 *
 * Test whether arbitrary node is globals pointer, i.e. Proj(pn_Start_P_globals)
 * from Start.  If so returns global type, else Null. */
type *is_globals_pointer(ir_node *n);

/** Test whether arbitrary node is value arg base.
 *
 * Test whether arbitrary node is value arg base, i.e. Proj(pn_Start_P_value_arg_base)
 * from Start.   If so returns 1, else 0. */
int   is_value_arg_pointer(ir_node *n);

Götz Lindenmaier's avatar
Götz Lindenmaier committed
255

256
/* @@@ no more supported  */
257
ir_node **get_Block_cfgpred_arr (ir_node *node);
258
int              get_Block_n_cfgpreds (ir_node *node);
259
260
261
262
263
264
ir_node  *get_Block_cfgpred (ir_node *node, int pos);
void      set_Block_cfgpred (ir_node *node, int pos, ir_node *pred);
bool      get_Block_matured (ir_node *node);
void      set_Block_matured (ir_node *node, bool matured);
unsigned long get_Block_block_visited (ir_node *node);
void      set_Block_block_visited (ir_node *node, unsigned long visit);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
265
/* For this current_ir_graph must be set. */
266
267
void      mark_Block_block_visited(ir_node *node);
int       Block_not_block_visited(ir_node *node);
Christian Schäfer's avatar
Christian Schäfer committed
268

269
270
/* Set and remove interprocedural predecessors. If the interprocedural
 * predecessors are removed, the node has the same predecessors in
271
272
 * both views.
 * @@@ Maybe better:  arity is zero if no cg preds. */
273
274
void      set_Block_cg_cfgpred_arr(ir_node * node, int arity, ir_node ** in);
void      set_Block_cg_cfgpred(ir_node * node, int pos, ir_node * pred);
275
/* @@@ not supported */
276
ir_node **get_Block_cg_cfgpred_arr(ir_node * node);
277
/* Returns the number of interprocedural predecessors.  0 if none. */
278
279
int       get_Block_cg_n_cfgpreds(ir_node * node);
ir_node  *get_Block_cg_cfgpred(ir_node * node, int pos);
280
/* frees the memory. */
281
282
void      remove_Block_cg_cfgpred_arr(ir_node * node);

283
284
/* Start references the irg it is in.
 @@@ old -- use get_irn_irg instead! */
285
ir_graph *get_Start_irg(ir_node *node);
286

287
288
289
290
int  get_End_n_keepalives(ir_node *end);
ir_node *get_End_keepalive(ir_node *end, int pos);
void add_End_keepalive (ir_node *end, ir_node *ka);
void set_End_keepalive(ir_node *end, int pos, ir_node *ka);
291
/* Some parts of the End node are allocated separately -- their memory
292
   is not recovered by dead_node_elimination if a End node is dead.
293
   free_End frees these data structures. */
294
void free_End (ir_node *end);
295

296
297
298
/* @@@ old -- use get_irn_irg instead!  */
ir_graph *get_EndReg_irg (ir_node *end);
ir_graph *get_EndExcept_irg (ir_node *end);
299

300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
/* We distinguish three kinds of Cond nodes.  These can be distinguished
   by the mode of the selector operand and an internal flag of type cond_kind.
   First we distinguish binary Conds and switch Conds.
   A binary Cond has as selector a boolean value.  Proj(0) projects the control
   flow for case "False", Proj(1) the control flow for "True".  A binary Cond
   is recognized by the boolean selector.
   The switch Cond has as selector an unsigned integer.  It produces as result
   an n+1 Tuple (cf0, ... , cfn) of control flows.
   We differ two flavours of this Cond.  The first, the dense Cond, passes
   control along output i if the selector value is i, 0 <= i <= n.  If the
   selector value is >n it passes control along output n.
   The second Cond flavor differes in the treatment of cases not specified in
   the source program.  It magically knows about the existence of Proj nodes.
   It only passes control along output i, 0 <= i <= n, if a node Proj(Cond, i)
   exists.  Else it passes control along output n (even if this Proj does not
   exist.)  This Cond we call "fragmentary".  There is a special constructor
   new_defaultProj that automatically sets the flavor.
317
318
   The two switch flavors are distinguished by a flag of type cond_kind.
   Default flavor is "dense"
319
320
*/
typedef enum {
Michael Beck's avatar
Michael Beck committed
321
322
  dense,        /**< Default. Missing Proj nodes are dead control flow. */
  fragmentary   /**< Special. No control flow optimizations allowed.  Missing
Florian Liekweg's avatar
Florian Liekweg committed
323
           Proj nodes mean default control flow, i.e., Proj(n). */
324
325
} cond_kind;

326
327
328
329
ir_node  *get_Cond_selector (ir_node *node);
void      set_Cond_selector (ir_node *node, ir_node *selector);
cond_kind get_Cond_kind (ir_node *node);
void      set_Cond_kind (ir_node *node, cond_kind kind);
330
long      get_Cond_defaultProj (ir_node *node);
Christian Schäfer's avatar
Christian Schäfer committed
331

332
333
334
/**
 * Projection numbers for conditions.
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
335
336
337
338
339
typedef enum {
  pn_Cond_false,    /**< Control flow if operand is "false". */
  pn_Cond_true      /**< Control flow if operand is "true".  */
} pn_Cond;  /* Projection numbers for Cond. */

340
341
342
343
344
345
ir_node  *get_Return_mem (ir_node *node);
void      set_Return_mem (ir_node *node, ir_node *mem);
ir_node **get_Return_res_arr (ir_node *node);
int       get_Return_n_ress (ir_node *node);
ir_node  *get_Return_res (ir_node *node, int pos);
void      set_Return_res (ir_node *node, int pos, ir_node *res);
Christian Schäfer's avatar
Christian Schäfer committed
346

347
348
349
350
ir_node *get_Raise_mem (ir_node *node);
void     set_Raise_mem (ir_node *node, ir_node *mem);
ir_node *get_Raise_exo_ptr (ir_node *node);  /* PoinTeR to EXception Object */
void     set_Raise_exo_ptr (ir_node *node, ir_node *exoptr);
Christian Schäfer's avatar
Christian Schäfer committed
351

352
353
354
/**
 * Projection numbers for Raise.
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
355
356
357
358
359
typedef enum {
  pn_Raise_X,    /**< Execution result. */
  pn_Raise_M     /**< Memory result.    */
} pn_Raise;  /* Projection numbers for Raise. */

360
361
tarval  *get_Const_tarval (ir_node *node);
void     set_Const_tarval (ir_node *node, tarval *con);
362
363
364
/* The source language type.  Must be an atomic type.  Mode of type must
   be mode of node. For tarvals from entities type must be pointer to
   entity type. */
365
366
type    *get_Const_type   (ir_node *node);
void     set_Const_type   (ir_node *node, type *tp);
Christian Schäfer's avatar
Christian Schäfer committed
367

Michael Beck's avatar
Michael Beck committed
368
/**  This enum names the three different kinds of symbolic Constants
Götz Lindenmaier's avatar
Götz Lindenmaier committed
369
370
371
372
     represented by SymConst.  The content of the attribute type_or_id
     depends on this tag.  Use the proper access routine after testing
     this flag. */
typedef enum {
Michael Beck's avatar
Michael Beck committed
373
  type_tag,          /**< The SymConst is a type tag for the given type.
Florian Liekweg's avatar
Florian Liekweg committed
374
            Type_or_id_p is type *. */
Michael Beck's avatar
Michael Beck committed
375
  size,              /**< The SymConst is the size of the given type.
Florian Liekweg's avatar
Florian Liekweg committed
376
            Type_or_id_p is type *. */
Michael Beck's avatar
Michael Beck committed
377
  linkage_ptr_info   /**< The SymConst is a symbolic pointer to be filled in
Florian Liekweg's avatar
Florian Liekweg committed
378
            by the linker. Type_or_id_p is ident *. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
379
} symconst_kind;
380

Götz Lindenmaier's avatar
Götz Lindenmaier committed
381
typedef union type_or_id * type_or_id_p;
382
383
symconst_kind get_SymConst_kind (const ir_node *node);
void          set_SymConst_kind (ir_node *node, symconst_kind num);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
384
/* Only to access SymConst of kind type_tag or size.  Else assertion: */
385
386
type    *get_SymConst_type (ir_node *node);
void     set_SymConst_type (ir_node *node, type *tp);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
387
/* Only to access SymConst of kind linkage_ptr_info.  Else assertion: */
388
389
ident   *get_SymConst_ptrinfo (ir_node *node);
void     set_SymConst_ptrinfo (ir_node *node, ident *ptrinfo);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
390
/* Sets both: type and ptrinfo.  Needed to treat the node independent of
Götz Lindenmaier's avatar
Götz Lindenmaier committed
391
   its semantics.  Does a memcpy for the memory tori points to. */
392
393
394
395
396
397
398
399
400
401
402
403
404
type_or_id_p get_SymConst_type_or_id (ir_node *node);
void set_SymConst_type_or_id (ir_node *node, type_or_id_p tori);

ir_node *get_Sel_mem (ir_node *node);
void     set_Sel_mem (ir_node *node, ir_node *mem);
ir_node *get_Sel_ptr (ir_node *node);  /* ptr to the object to select from */
void     set_Sel_ptr (ir_node *node, ir_node *ptr);
ir_node **get_Sel_index_arr (ir_node *node);
int      get_Sel_n_indexs (ir_node *node);
ir_node *get_Sel_index (ir_node *node, int pos);
void     set_Sel_index (ir_node *node, int pos, ir_node *index);
entity  *get_Sel_entity (ir_node *node); /* entity to select */
void     set_Sel_entity (ir_node *node, entity *ent);
Christian Schäfer's avatar
Christian Schäfer committed
405

406
407
408
409
410
/**
 * Projection numbers for result of Call node: use for Proj nodes!
 *
 * @remark old name convention!
 */
411
412
413
414
415
typedef enum {
  pncl_memory = 0,        /**< The memory result. */
  pncl_exc_target = 1,    /**< The control flow result branching to the exception handler */
  pncl_result_tuple = 2,  /**< The tuple containing all (0, 1, 2, ...) results */
  pncl_exc_memory = 3,    /**< The memory result in case the called method terminated with
Florian Liekweg's avatar
Florian Liekweg committed
416
                  an exception */
417
  pncl_value_res_base = 4 /**< A pointer to the memory region containing copied results
Florian Liekweg's avatar
Florian Liekweg committed
418
                  passed by value (for compound result types). */
419
420
} pncl_number;   /* pncl: Projection Number CaLl */

421
422
423
/**
 * Projection numbers for result of Call node: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
424
425
426
427
typedef enum {
  pn_Call_M_regular = 0,  /**< The memory result. */
  pn_Call_T_result  = 2,  /**< The tuple containing all (0, 1, 2, ...) results */
  pn_Call_P_value_res_base = 4,/**< A pointer to the memory region containing copied results
Florian Liekweg's avatar
Florian Liekweg committed
428
                 passed by value (for compound result types). */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
429
430
  pn_Call_X_except  = 1,  /**< The control flow result branching to the exception handler */
  pn_Call_M_except  = 3   /**< The memory result in case the called method terminated with
Florian Liekweg's avatar
Florian Liekweg committed
431
                 an exception */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
432
433
} pn_Call;   /* Projection numbers for Call. */

434
435
436
437
438
ir_node *get_Call_mem (ir_node *node);
void     set_Call_mem (ir_node *node, ir_node *mem);
ir_node *get_Call_ptr (ir_node *node);
void     set_Call_ptr (ir_node *node, ir_node *ptr);
ir_node **get_Call_param_arr (ir_node *node);
Michael Beck's avatar
Michael Beck committed
439
/** Gets the number of parameters of a call. */
440
int      get_Call_n_params (ir_node *node);
Michael Beck's avatar
Michael Beck committed
441
/** Gets the call parameter at position pos. */
442
ir_node *get_Call_param (ir_node *node, int pos);
Michael Beck's avatar
Michael Beck committed
443
/** Sets the call parameter at position pos. */
444
void     set_Call_param (ir_node *node, int pos, ir_node *param);
Michael Beck's avatar
Michael Beck committed
445
/** Gets the type of a call. */
446
type    *get_Call_type (ir_node *node);
Michael Beck's avatar
Michael Beck committed
447
/** Sets the type of a call. */
448
void     set_Call_type (ir_node *node, type *tp);
Michael Beck's avatar
Michael Beck committed
449
/** Gets the arity of a call. Identical to get_Call_n_params(). */
450
int      get_Call_arity (ir_node *node);
451

Götz Lindenmaier's avatar
Götz Lindenmaier committed
452
/* Set, get and remove the callee-analysis.
453
   The array is only accessible if information is valid.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
454
455
456
   It contains NULL for called methods that are not within
   the compilation unit. */
int     Call_has_callees      (ir_node *node);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
457
458
int     get_Call_n_callees    (ir_node * node);
entity *get_Call_callee       (ir_node * node, int pos);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
459
/* assumes current_ir_graph set properly! */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
460
461
void    set_Call_callee_arr   (ir_node * node, int n, entity ** arr);
void    remove_Call_callee_arr(ir_node * node);
462

Götz Lindenmaier's avatar
Götz Lindenmaier committed
463
464
ir_node  *get_CallBegin_ptr  (ir_node *node);
void      set_CallBegin_ptr  (ir_node *node, ir_node *ptr);
465
/* @@@ old -- use get_irn_irg instead!  */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
466
467
468
ir_graph *get_CallBegin_irg  (ir_node *node);
ir_node  *get_CallBegin_call (ir_node *node);
void      set_CallBegin_call (ir_node *node, ir_node *call);
469

470
471
472
ir_node *get_FuncCall_ptr (ir_node *node);
void     set_FuncCall_ptr (ir_node *node, ir_node *ptr);
ir_node **get_FuncCall_param_arr (ir_node *node);
473
/** Gets the number of parameters of a func call. */
474
int      get_FuncCall_n_params (ir_node *node);
475
/** Gets the func call parameter at position pos. */
476
ir_node *get_FuncCall_param (ir_node *node, int pos);
477
/** Sets the func call parameter at position pos. */
478
void     set_FuncCall_param (ir_node *node, int pos, ir_node *param);
479
/** Gets the type of a func call. */
480
type    *get_FuncCall_type (ir_node *node);
481
/** Sets the type of a func call. */
482
void     set_FuncCall_type (ir_node *node, type *tp);
483
/** Gets the arity of a func call. Identical to get_FuncCall_n_params(). */
484
int      get_FuncCall_arity (ir_node *node);
485
486
487
488
489
490
491
492
493
494
495
496

/* Set, get and remove the callee-analysis.
   The array is only accessible if information is valid.
   It contains NULL for called methods that are not within
   the compilation unit. */
int     FuncCall_has_callees      (ir_node *node);
int     get_FuncCall_n_callees    (ir_node * node);
entity *get_FuncCall_callee       (ir_node * node, int pos);
/* assumes current_ir_graph set properly! */
void    set_FuncCall_callee_arr   (ir_node * node, int n, entity ** arr);
void    remove_FuncCall_callee_arr(ir_node * node);

Christian Schäfer's avatar
Christian Schäfer committed
497
498
499
/* For unary and binary arithmetic operations the access to the
   operands can be factored out.  Left is the first, right the
   second arithmetic value  as listed in tech report 1999-44.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
500
   unops are: Minus, Abs, Not, Conv, Cast
Christian Schäfer's avatar
Christian Schäfer committed
501
502
   binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
   Shr, Shrs, Rot, Cmp */
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
int      is_unop (ir_node *node);
ir_node *get_unop_op (ir_node *node);
void     set_unop_op (ir_node *node, ir_node *op);
int      is_binop (ir_node *node);
ir_node *get_binop_left (ir_node *node);
void     set_binop_left (ir_node *node, ir_node *left);
ir_node *get_binop_right (ir_node *node);
void     set_binop_right (ir_node *node, ir_node *right);

ir_node *get_Add_left (ir_node *node);
void     set_Add_left (ir_node *node, ir_node *left);
ir_node *get_Add_right (ir_node *node);
void     set_Add_right (ir_node *node, ir_node *right);

ir_node *get_Sub_left (ir_node *node);
void     set_Sub_left (ir_node *node, ir_node *left);
ir_node *get_Sub_right (ir_node *node);
void     set_Sub_right (ir_node *node, ir_node *right);

ir_node *get_Minus_op (ir_node *node);
void     set_Minus_op (ir_node *node, ir_node *op);

ir_node *get_Mul_left (ir_node *node);
void     set_Mul_left (ir_node *node, ir_node *left);
ir_node *get_Mul_right (ir_node *node);
void     set_Mul_right (ir_node *node, ir_node *right);

ir_node *get_Quot_left (ir_node *node);
void     set_Quot_left (ir_node *node, ir_node *left);
ir_node *get_Quot_right (ir_node *node);
void     set_Quot_right (ir_node *node, ir_node *right);
ir_node *get_Quot_mem (ir_node *node);
void     set_Quot_mem (ir_node *node, ir_node *mem);
536

537
538
539
/**
 * Projection numbers for Quot: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
540
541
typedef enum {
  pn_Quot_M,           /**< Memory result.    */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
542
  pn_Quot_X_except,    /**< Execution result if exception occured. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
543
544
545
  pn_Quot_res          /**< Result of computation. */
} pn_Quot;  /* Projection numbers for Quot. */

546
547
548
549
550
551
ir_node *get_DivMod_left (ir_node *node);
void     set_DivMod_left (ir_node *node, ir_node *left);
ir_node *get_DivMod_right (ir_node *node);
void     set_DivMod_right (ir_node *node, ir_node *right);
ir_node *get_DivMod_mem (ir_node *node);
void     set_DivMod_mem (ir_node *node, ir_node *mem);
552

553
554
555
/**
 * Projection numbers for DivMod: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
556
557
typedef enum {
  pn_DivMod_M,           /**< Memory result.    */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
558
  pn_DivMod_X_except,    /**< Execution result if exception occured. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
559
560
561
562
  pn_DivMod_res_div,     /**< Result of computation a / b. */
  pn_DivMod_res_mod      /**< Result of computation a % b. */
} pn_DivMod;  /* Projection numbers for DivMod. */

563
564
565
566
567
568
ir_node *get_Div_left (ir_node *node);
void     set_Div_left (ir_node *node, ir_node *left);
ir_node *get_Div_right (ir_node *node);
void     set_Div_right (ir_node *node, ir_node *right);
ir_node *get_Div_mem (ir_node *node);
void     set_Div_mem (ir_node *node, ir_node *mem);
569

570
571
572
/**
 * Projection numbers for Div: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
573
574
typedef enum {
  pn_Div_M,           /**< Memory result.    */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
575
  pn_Div_X_except,    /**< Execution result if exception occured. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
576
577
578
  pn_Div_res          /**< Result of computation. */
} pn_Div;  /* Projection numbers for Div. */

579
580
581
582
583
584
ir_node *get_Mod_left (ir_node *node);
void     set_Mod_left (ir_node *node, ir_node *left);
ir_node *get_Mod_right (ir_node *node);
void     set_Mod_right (ir_node *node, ir_node *right);
ir_node *get_Mod_mem (ir_node *node);
void     set_Mod_mem (ir_node *node, ir_node *mem);
585

586
587
588
/**
 * Projection numbers for Mod: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
589
590
typedef enum {
  pn_Mod_M,           /**< Memory result.    */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
591
  pn_Mod_X_except,    /**< Execution result if exception occured. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
592
593
594
  pn_Mod_res          /**< Result of computation. */
} pn_Mod;  /* Projection numbers for Mod. */

595
596
ir_node *get_Abs_op (ir_node *node);
void     set_Abs_op (ir_node *node, ir_node *op);
597

598
599
600
601
ir_node *get_And_left (ir_node *node);
void     set_And_left (ir_node *node, ir_node *left);
ir_node *get_And_right (ir_node *node);
void     set_And_right (ir_node *node, ir_node *right);
602

603
604
605
606
ir_node *get_Or_left (ir_node *node);
void     set_Or_left (ir_node *node, ir_node *left);
ir_node *get_Or_right (ir_node *node);
void     set_Or_right (ir_node *node, ir_node *right);
607

608
609
610
611
ir_node *get_Eor_left (ir_node *node);
void     set_Eor_left (ir_node *node, ir_node *left);
ir_node *get_Eor_right (ir_node *node);
void     set_Eor_right (ir_node *node, ir_node *right);
612

613
614
ir_node *get_Not_op (ir_node *node);
void     set_Not_op (ir_node *node, ir_node *op);
Christian Schäfer's avatar
Christian Schäfer committed
615

616
617
/**
 * Projection numbers for Cmp are defined several times.
618
 * The bit patterns are used for various tests, so don't change.
619
620
621
 * The "unordered" values are possible results of comparing
 * floating point numbers.
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
622
623
typedef enum {
  pn_Cmp_False = 0,   /**< false */
Florian Liekweg's avatar
Florian Liekweg committed
624
625
626
627
628
629
  pn_Cmp_Eq,          /**< equal */
  pn_Cmp_Lt,          /**< less */
  pn_Cmp_Le,          /**< less or equal */
  pn_Cmp_Gt,          /**< greater */
  pn_Cmp_Ge,          /**< greater or equal */
  pn_Cmp_Lg,          /**< less or greater */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
630
  pn_Cmp_Leg = 7,     /**< less, equal or greater = ordered */
Florian Liekweg's avatar
Florian Liekweg committed
631
632
633
634
635
636
637
  pn_Cmp_Uo,          /**< unordered */
  pn_Cmp_Ue,          /**< unordered or equal */
  pn_Cmp_Ul,          /**< unordered or less */
  pn_Cmp_Ule,         /**< unordered, less or equal */
  pn_Cmp_Ug,          /**< unordered or greater */
  pn_Cmp_Uge,         /**< unordered, greater or equal */
  pn_Cmp_Ne,          /**< unordered, less or greater = not equal */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
638
  pn_Cmp_True = 15    /**< true */
Florian Liekweg's avatar
Florian Liekweg committed
639
  /* not_mask = Leg*/   /* bits to flip to negate comparison * @@ hack for jni interface */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
640
} pn_Cmp;   /* Projection numbers for Cmp */
641
/* #define not_mask pn_Cmp_Leg */
642

643
644
645
646
647
648
const char *get_pnc_string(int pnc);
int         get_negated_pnc(int pnc);
ir_node *get_Cmp_left (ir_node *node);
void     set_Cmp_left (ir_node *node, ir_node *left);
ir_node *get_Cmp_right (ir_node *node);
void     set_Cmp_right (ir_node *node, ir_node *right);
649

650
651
652
653
ir_node *get_Shl_left (ir_node *node);
void     set_Shl_left (ir_node *node, ir_node *left);
ir_node *get_Shl_right (ir_node *node);
void     set_Shl_right (ir_node *node, ir_node *right);
654

655
656
657
658
ir_node *get_Shr_left (ir_node *node);
void     set_Shr_left (ir_node *node, ir_node *left);
ir_node *get_Shr_right (ir_node *node);
void     set_Shr_right (ir_node *node, ir_node *right);
659

660
661
662
663
ir_node *get_Shrs_left (ir_node *node);
void     set_Shrs_left (ir_node *node, ir_node *left);
ir_node *get_Shrs_right (ir_node *node);
void     set_Shrs_right (ir_node *node, ir_node *right);
664

665
666
667
668
ir_node *get_Rot_left (ir_node *node);
void     set_Rot_left (ir_node *node, ir_node *left);
ir_node *get_Rot_right (ir_node *node);
void     set_Rot_right (ir_node *node, ir_node *right);
669

670
671
ir_node *get_Conv_op (ir_node *node);
void     set_Conv_op (ir_node *node, ir_node *op);
672

Götz Lindenmaier's avatar
comment    
Götz Lindenmaier committed
673
674
/* Does Cast need a mem operator?
 * Cast should only depend on the type, not on the state of an
675
 * entity.  But:  we initialze various fields after Alloc, that
Götz Lindenmaier's avatar
comment    
Götz Lindenmaier committed
676
677
678
 * are accessed in the cast.  This required some precaution, to
 * get the right memory into the Loads generated from the cast.
 */
679
680
681
682
ir_node *get_Cast_op (ir_node *node);
void     set_Cast_op (ir_node *node, ir_node *op);
type    *get_Cast_type (ir_node *node);
void     set_Cast_type (ir_node *node, type *to_tp);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
683

Götz Lindenmaier's avatar
Götz Lindenmaier committed
684
/* Returns true if n is Phi or Filter in interprocedural_view. */
685
int       is_Phi (ir_node *n);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
686
/* These routines also work for Filter nodes in interprocedural view. */
687
688
689
690
691
692
693
694
695
ir_node **get_Phi_preds_arr (ir_node *node);
int       get_Phi_n_preds (ir_node *node);
ir_node  *get_Phi_pred (ir_node *node, int pos);
void      set_Phi_pred (ir_node *node, int pos, ir_node *pred);

ir_node  *get_Filter_pred(ir_node *node);
void      set_Filter_pred(ir_node *node, ir_node *pred);
long      get_Filter_proj(ir_node *node);
void      set_Filter_proj(ir_node *node, long proj);
696
697
/* set the interprocedural predecessors, ...d_arr uses current_ir_graph.
 * @@@ Maybe better:  arity is zero if no cg preds. */
698
699
void             set_Filter_cg_pred_arr(ir_node * node, int arity, ir_node ** in);
void             set_Filter_cg_pred(ir_node * node, int pos, ir_node * pred);
700
701
int              get_Filter_n_cg_preds(ir_node *node);
ir_node *        get_Filter_cg_pred(ir_node *node, int pos);
702

703
704
705
/**
 * Projection numbers for Load: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
706
707
typedef enum {
  pn_Load_M,         /**< Memory result.    */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
708
  pn_Load_X_except,  /**< Execution result if exception occured. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
709
710
711
  pn_Load_res        /**< Result of load operation. */
} pn_Load;  /* Projection numbers for Load. */

712
713
714
715
ir_node *get_Load_mem (ir_node *node);
void     set_Load_mem (ir_node *node, ir_node *mem);
ir_node *get_Load_ptr (ir_node *node);
void     set_Load_ptr (ir_node *node, ir_node *ptr);
716

717
718
719
/**
 * Projection numbers for Store: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
720
typedef enum {
Götz Lindenmaier's avatar
Götz Lindenmaier committed
721
722
  pn_Store_M,         /**< Memory result.    */
  pn_Store_X_except   /**< Execution result if exception occured. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
723
724
} pn_Store;  /* Projection numbers for Store. */

725
726
727
728
729
730
ir_node *get_Store_mem (ir_node *node);
void     set_Store_mem (ir_node *node, ir_node *mem);
ir_node *get_Store_ptr (ir_node *node);
void     set_Store_ptr (ir_node *node, ir_node *ptr);
ir_node *get_Store_value (ir_node *node);
void     set_Store_value (ir_node *node, ir_node *value);
731

732
733
734
/**
 * Projection numbers for Alloc: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
735
736
typedef enum {
  pn_Alloc_M,    /**< Memory result. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
737
  pn_Alloc_X_except,    /**< Execution result if exception occured. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
738
739
740
  pn_Alloc_res   /**< Result of allocation. */
} pn_Alloc;  /* Projection numbers for Alloc. */

741
742
743
744
745
746
ir_node *get_Alloc_mem (ir_node *node);
void     set_Alloc_mem (ir_node *node, ir_node *mem);
ir_node *get_Alloc_size (ir_node *node);
void     set_Alloc_size (ir_node *node, ir_node *size);
type    *get_Alloc_type (ir_node *node);
void     set_Alloc_type (ir_node *node, type *tp);
Michael Beck's avatar
Michael Beck committed
747

748
/** The allocation place. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
749
typedef enum {
Michael Beck's avatar
Michael Beck committed
750
751
  stack_alloc,          /**< Alloc allocates the object on the stack. */
  heap_alloc            /**< Alloc allocates the object on the heap. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
752
} where_alloc;
Michael Beck's avatar
Michael Beck committed
753

754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
where_alloc  get_Alloc_where (ir_node *node);
void         set_Alloc_where (ir_node *node, where_alloc where);

ir_node *get_Free_mem (ir_node *node);
void     set_Free_mem (ir_node *node, ir_node *mem);
ir_node *get_Free_ptr (ir_node *node);
void     set_Free_ptr (ir_node *node, ir_node *ptr);
ir_node *get_Free_size (ir_node *node);
void     set_Free_size (ir_node *node, ir_node *size);
type    *get_Free_type (ir_node *node);
void     set_Free_type (ir_node *node, type *tp);

ir_node **get_Sync_preds_arr (ir_node *node);
int       get_Sync_n_preds (ir_node *node);
ir_node  *get_Sync_pred (ir_node *node, int pos);
void      set_Sync_pred (ir_node *node, int pos, ir_node *pred);

ir_node  *get_Proj_pred (ir_node *node);
void      set_Proj_pred (ir_node *node, ir_node *pred);
773
/* Why long? shouldn't int be enough, and smaller? Or even byte? */
774
775
long      get_Proj_proj (ir_node *node);
void      set_Proj_proj (ir_node *node, long proj);
776

777
778
779
780
ir_node **get_Tuple_preds_arr (ir_node *node);
int       get_Tuple_n_preds (ir_node *node);
ir_node  *get_Tuple_pred (ir_node *node, int pos);
void      set_Tuple_pred (ir_node *node, int pos, ir_node *pred);
781

782
783
ir_node  *get_Id_pred (ir_node *node);
void      set_Id_pred (ir_node *node, ir_node *pred);
784

Götz Lindenmaier's avatar
Götz Lindenmaier committed
785
786
787
/** Confirm has a single result and returns 'value' unchanged.
 *  The node expresses a restriction on 'value':
 *  'value' 'cmp' 'bound' == true.                                 */
788
789
790
791
792
793
ir_node *get_Confirm_value (ir_node *node);
void     set_Confirm_value (ir_node *node, ir_node *value);
ir_node *get_Confirm_bound (ir_node *node);
void     set_Confirm_bound (ir_node *node, ir_node *bound);
pn_Cmp   get_Confirm_cmp   (ir_node *node);
void     set_Confirm_cmp   (ir_node *node, pn_Cmp cmp);
Christian Schäfer's avatar
Christian Schäfer committed
794

Michael Beck's avatar
Michael Beck committed
795
/*
Götz Lindenmaier's avatar
Götz Lindenmaier committed
796
797
798
 *
 * NAME Auxiliary routines
 *
Sebastian Felis's avatar
Sebastian Felis committed
799
 *  Not properly documented ;-)
Götz Lindenmaier's avatar
Götz Lindenmaier committed
800
801
 *
 */
Christian Schäfer's avatar
Christian Schäfer committed
802

Michael Beck's avatar
Michael Beck committed
803
/** returns operand of node if node is a Proj. */
804
ir_node *skip_Proj (ir_node *node);
Michael Beck's avatar
Michael Beck committed
805
/** returns operand of node if node is a Id */
806
807
ir_node *skip_nop  (ir_node *node);
ir_node *skip_Id  (ir_node *node);   /* Same as skip_nop. */
808
809
/* returns corresponding operand of Tuple if node is a Proj from
   a Tuple. */
810
ir_node *skip_Tuple (ir_node *node);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
811
812
/** returns operand of node if node is a Cast */
ir_node *skip_Cast  (ir_node *node);
Michael Beck's avatar
Michael Beck committed
813
/** returns true if node is a Bad node. */
814
int      is_Bad    (ir_node *node);
Michael Beck's avatar
Michael Beck committed
815
/** returns true if the node is not a Block */
816
int      is_no_Block (ir_node *node);
Michael Beck's avatar
Michael Beck committed
817
/** returns true if the node is a Block */
818
int      is_Block (ir_node *node);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
819
/** returns true if node is a Unknown node. */
820
int      is_Unknown (ir_node *node);
Michael Beck's avatar
Michael Beck committed
821
/** returns true if node is a Proj node or a Filter node in
822
 * intraprocedural view */
823
int      is_Proj (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
824
/** Returns true if the operation manipulates control flow:
825
   Start, End, Jmp, Cond, Return, Raise, Bad, CallBegin, EndReg, EndExcept */
Christian Schäfer's avatar
Christian Schäfer committed
826
int is_cfop(ir_node *node);
827

828
829
830
/* @@@ old -- use get_irn_irg instead!  */
ir_graph *get_ip_cfop_irg(ir_node *n);

Michael Beck's avatar
Michael Beck committed
831
/** Returns true if the operation manipulates interprocedural control flow:
832
    CallBegin, EndReg, EndExcept */
833
int is_ip_cfop(ir_node *node);
Michael Beck's avatar
Michael Beck committed
834
/** Returns true if the operation can change the control flow because
835
836
    of an exception: Call, Quot, DivMod, Div, Mod, Load, Store, Alloc,
    Bad. */
Christian Schäfer's avatar
Christian Schäfer committed
837
int is_fragile_op(ir_node *node);
Michael Beck's avatar
Michael Beck committed
838
/** Returns the memory operand of fragile operations. */
839
ir_node *get_fragile_op_mem(ir_node *node);
Christian Schäfer's avatar
Christian Schäfer committed
840

Götz Lindenmaier's avatar
Götz Lindenmaier committed
841
842
#include "ident.h"

843
#ifdef __GNUC__
844
/* GNU C has the __FUNCTION__ extension */
845
846
847
848
849
#define __MYFUNC__ __FUNCTION__
#else
/* use Filename instead */
#define __MYFUNC__ __FILE__
#endif
850

Götz Lindenmaier's avatar
Götz Lindenmaier committed
851
852
/* !!!!!!!!! @@@
   Don't format with "\", firmjni gets problems */
853
/** Output location */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
854
#define DDM      printf("%s(l.%i).\n",                       __MYFUNC__, __LINE__);
855
/** Output the firm kind of the node */
856
#define DDMK(X)  printf("%s(l.%i) %s: %p\n",                 __MYFUNC__, __LINE__,  print_firm_kind(X), (void *)(X));
857
/** Output information about a node */
858
#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))
859
/** Output information about a node and its block */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
860
#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)))
861
/** Output information about a type */
862
#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))
863
/** Output information about an entity */
864
#define DDME(X)  printf("%s(l.%i) %s: %ld (%p)\n",           __MYFUNC__, __LINE__, get_entity_name(X), get_entity_nr(X), (void *)(X))
865
866
/** Output information about an entity and its type */
#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))
867
/** Output information about an entity and its owner */
868
#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))
869
/** Output information about a graph */
870
#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))
871
/** Output information about an ident */
872
#define DDMI(X)  printf("%s(l.%i) %s: %p\n",                 __MYFUNC__, __LINE__, id_to_str(X), (void *)(X))
873
/** Output information about a mode */
874
#define DDMM(X)  printf("%s(l.%i) %s: %p\n",                 __MYFUNC__, __LINE__, get_mode_name(X), (void *)(X))
875
/** Output information about a loop */
876
#define DDML(X)  printf("%s(l.%i) loop with depth %d: %d\n", __MYFUNC__, __LINE__, get_loop_depth(X), get_loop_loop_nr(X))
877
/** Output information about a tarVal */
878
#define DDMV(X)  printf("%s(l.%i) tarval: ",__MYFUNC__, __LINE__); tarval_printf(X); printf(" (%p)\n", (void *)(X));
879

Michael Beck's avatar
Michael Beck committed
880
/*@}*/ /* end of ir_node group definition */
881

Götz Lindenmaier's avatar
Götz Lindenmaier committed
882

Christian Schäfer's avatar
Christian Schäfer committed
883
# endif /* _IRNODE_H_ */