irnode.h 38.6 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 {
21
  False = 0,    /**< false */
Florian Liekweg's avatar
Florian Liekweg committed
22
23
24
25
26
27
28
29
30
31
32
33
34
35
  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 */
36
  True = 15     /**< true */
Florian Liekweg's avatar
Florian Liekweg committed
37
  /* 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

Hannes Jakschitsch's avatar
Hannes Jakschitsch committed
89
90
91
92
93
#ifdef __cplusplus
	extern "C" {

#endif

Sebastian Felis's avatar
Sebastian Felis committed
94
/**
Michael Beck's avatar
Michael Beck committed
95
96
97
 *   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
98

Sebastian Felis's avatar
Sebastian Felis committed
99
100
101
/**
 *   Checks whether a pointer points to a ir node.
 *
102
103
 *   @param thing   an arbitrary pointer
 *   @return        non-zero if the thing is a ir mode, else zero
Sebastian Felis's avatar
Sebastian Felis committed
104
 */
105
int is_ir_node (const void *thing);
Sebastian Felis's avatar
Sebastian Felis committed
106

107
108
109
110
111
112
/**
 * Returns the number of predecessors without the block predecessor.
 *
 * @param node   the IR-node
 */
int           get_irn_arity         (const ir_node *node);
113
114
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
115
116

/** Replaces the old in array by a new one that will contain the ins given in
117
   the parameters.  Conserves the block predecessor.  It copies the array passed.
118
   This function is necessary to adjust in arrays of blocks, calls and phis.
119
   Assumes that current_ir_graph is set to the graph containing "node".
120
121
   "in" must contain all predecessors except the block that are required for
   the nodes opcode. */
122
void          set_irn_in            (ir_node *node, int arity,
Florian Liekweg's avatar
Florian Liekweg committed
123
                        ir_node *in[]);
Christian Schäfer's avatar
Christian Schäfer committed
124
125
126
/* 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
127
   to iterate including the Block predecessor iterate from i = -1 to
Christian Schäfer's avatar
Christian Schäfer committed
128
   i < get_irn_arity. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
129
/* Access predecessor n */
130
131
132
133
134

/**
 * Get the n-th predecessor of a node.
 * This function removes Id predecessors.
 */
135
136
137
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);
138
139

/** Replace the n-th predecessor of a node with a new one. */
140
void          set_irn_n             (ir_node *node, int n, ir_node *in);
141
/* Sets the mode struct of node.  */
142
void          set_irn_mode (ir_node *node, ir_mode *mode);
143
/** Gets the mode struct of a node.  */
144
ir_mode      *get_irn_mode          (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
145
/** Gets the mode-enum modecode. */
146
modecode      get_irn_modecode      (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
147
/** Gets the ident for a string representation of the mode .*/
148
ident        *get_irn_modeident     (const ir_node *node);
149
/** Gets the string representation of the mode .*/
150
const char   *get_irn_modename      (const ir_node *node);
151
/** Gets the opcode struct of the node. */
152
ir_op        *get_irn_op            (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
153
/** Sets the opcode struct of the node. */
154
void          set_irn_op            (ir_node *node, ir_op *op);
Michael Beck's avatar
Michael Beck committed
155
/** Gets the opcode-enum of the node. */
156
opcode        get_irn_opcode        (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
157
/** Get the string representation of the opcode. */
158
const char   *get_irn_opname        (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
159
/** Get the ident for a string representation of the opcode. */
160
ident        *get_irn_opident       (const ir_node *node);
161
/** Gets the visited counter of a node. */
162
unsigned long get_irn_visited (const ir_node *node);
163
/** Sets the visited counter of a node. */
164
void          set_irn_visited (ir_node *node, unsigned long visited);
Michael Beck's avatar
Michael Beck committed
165
/** Sets visited to get_irg_visited(current_ir_graph). */
166
void          mark_irn_visited (ir_node *node);
167
/** Returns 1 if visited < get_irg_visited(current_ir_graph). */
168
int           irn_not_visited  (const ir_node *node);
169
/** Returns 1 if visited >= get_irg_visited(current_ir_graph). */
170
int           irn_visited      (const ir_node *node);
171
172
173
174
175

/**
 * Sets the link of a node.
 * Only allowed if the graph is NOT in phase_building.
 */
176
void          set_irn_link     (ir_node *node, void *link);
177
178

/** Returns the link of a node.  */
179
void         *get_irn_link     (const ir_node *node);
180
181

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

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

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

Michael Beck's avatar
Michael Beck committed
191
192
193
194
/**
 * irnode constructor.
 * Create a new irnode in irg, with an op, mode, arity and
 * some incoming irnodes.
195
196
197
198
199
200
201
202
 * 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
203
 */
204
ir_node *
Götz Lindenmaier's avatar
Götz Lindenmaier committed
205
new_ir_node (dbg_info *db,
Florian Liekweg's avatar
Florian Liekweg committed
206
207
208
209
210
211
         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
212

Michael Beck's avatar
Michael Beck committed
213
/*
Götz Lindenmaier's avatar
Götz Lindenmaier committed
214
215
216
 *
 * NAME access functions for node fields.
 *
Sebastian Felis's avatar
Sebastian Felis committed
217
 *  Not properly documented ;-)
Götz Lindenmaier's avatar
Götz Lindenmaier committed
218
219
 *
 */
Christian Schäfer's avatar
Christian Schäfer committed
220

Götz Lindenmaier's avatar
Götz Lindenmaier committed
221
222
223
/** This works for all except Block.  To express the difference to
 * access routines that work for all nodes we use infix "nodes" and do not
 * name this function get_irn_block. */
224
225
ir_node  *get_nodes_block (ir_node *node);
void      set_nodes_block (ir_node *node, ir_node *block);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
226

Götz Lindenmaier's avatar
Götz Lindenmaier committed
227
228
/**
 * @function get_irn_block
229
 * @see get_nodes_block()
Götz Lindenmaier's avatar
Götz Lindenmaier committed
230
 */
231
232
233
234
/**
 * Projection numbers for result of Start node: use for Proj nodes!
 */
typedef enum {
235
236
237
238
239
240
241
242
243
  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
                                  containing _all_ global entities. */
  pn_Start_T_args,           /**< Projection on all arguments. */
  pn_Start_P_value_arg_base, /**< Pointer to region of compound value arguments as defined by
                                  type of this method. */
  pn_Start_max               /**< number of projections from a Start */
244
245
} pn_Start; /* Projection numbers for Start. */

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

247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
/** 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
265

266
/* @@@ no more supported  */
267
ir_node **get_Block_cfgpred_arr (ir_node *node);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
268
int       get_Block_n_cfgpreds (ir_node *node);
269
270
271
272
273
274
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
275
/* For this current_ir_graph must be set. */
276
277
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
278

279
280
/* Set and remove interprocedural predecessors. If the interprocedural
 * predecessors are removed, the node has the same predecessors in
281
282
 * both views.
 * @@@ Maybe better:  arity is zero if no cg preds. */
283
284
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);
285
/* @@@ not supported */
286
ir_node **get_Block_cg_cfgpred_arr(ir_node * node);
287
/* Returns the number of interprocedural predecessors.  0 if none. */
288
289
int       get_Block_cg_n_cfgpreds(ir_node * node);
ir_node  *get_Block_cg_cfgpred(ir_node * node, int pos);
290
/* frees the memory. */
291
292
void      remove_Block_cg_cfgpred_arr(ir_node * node);

Götz Lindenmaier's avatar
Götz Lindenmaier committed
293
294
/** Keep alive dedicated nodes.  These must be either
 *  PhiM or Block nodes. */
295
296
297
298
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);
299
/* Some parts of the End node are allocated separately -- their memory
300
   is not recovered by dead_node_elimination if a End node is dead.
301
   free_End frees these data structures. */
302
void free_End (ir_node *end);
303

304

305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
/* 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.
322
323
   The two switch flavors are distinguished by a flag of type cond_kind.
   Default flavor is "dense"
324
325
*/
typedef enum {
Michael Beck's avatar
Michael Beck committed
326
327
  dense,        /**< Default. Missing Proj nodes are dead control flow. */
  fragmentary   /**< Special. No control flow optimizations allowed.  Missing
Florian Liekweg's avatar
Florian Liekweg committed
328
           Proj nodes mean default control flow, i.e., Proj(n). */
329
330
} cond_kind;

331
332
333
334
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);
335
long      get_Cond_defaultProj (ir_node *node);
Christian Schäfer's avatar
Christian Schäfer committed
336

337
338
339
/**
 * Projection numbers for conditions.
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
340
341
typedef enum {
  pn_Cond_false,    /**< Control flow if operand is "false". */
342
343
  pn_Cond_true,     /**< Control flow if operand is "true".  */
  pn_Cond_max       /**< number of projections from a Cond */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
344
345
} pn_Cond;  /* Projection numbers for Cond. */

346
347
348
349
350
351
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
352

353
354
355
356
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
357

358
359
360
/**
 * Projection numbers for Raise.
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
361
362
typedef enum {
  pn_Raise_X,    /**< Execution result. */
363
364
  pn_Raise_M,    /**< Memory result.    */
  pn_Raise_max   /**< number of projections from a Raise */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
365
366
} pn_Raise;  /* Projection numbers for Raise. */

367
368
tarval  *get_Const_tarval (ir_node *node);
void     set_Const_tarval (ir_node *node, tarval *con);
369
370
371
/* 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. */
372
373
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
374

Michael Beck's avatar
Michael Beck committed
375
/**  This enum names the three different kinds of symbolic Constants
Götz Lindenmaier's avatar
Götz Lindenmaier committed
376
377
378
     represented by SymConst.  The content of the attribute type_or_id
     depends on this tag.  Use the proper access routine after testing
     this flag. */
Beyhan's avatar
Beyhan committed
379

Götz Lindenmaier's avatar
Götz Lindenmaier committed
380
typedef enum {
Beyhan's avatar
Beyhan committed
381
382
383
384
385
386
387
388
389
390
  symconst_type_tag,    /**< The SymConst is a type tag for the given type.
			   Type_or_id_p is type *. */
  symconst_size,        /**< The SymConst is the size of the given type.
			   Type_or_id_p is type *. */
  symconst_addr_name,   /**< The SymConst is a symbolic pointer to be filled in
			   by the linker.  The pointer is represented by a string.
			   Type_or_id_p is ident *. */
  symconst_addr_ent     /**< The SymConst is a symbolic pointer to be filled in
			   by the linker.  The pointer is represented by an entity.
			   Type_or_id_p is entity *. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
391
} symconst_kind;
392

Beyhan's avatar
Beyhan committed
393
394
395
/** SymConst attributes
    This union contains the symbolic information represented by the node  */
union symconst_symbol {
396
397
398
  type   *type_p;
  ident  *ident_p;
  entity *entity_p;
Beyhan's avatar
Beyhan committed
399
};
400
401


Beyhan's avatar
Beyhan committed
402
403
typedef union symconst_symbol symconst_symbol;

404

Beyhan's avatar
Beyhan committed
405
/** Access the kind of the SymConst. */
406
407
symconst_kind get_SymConst_kind (const ir_node *node);
void          set_SymConst_kind (ir_node *node, symconst_kind num);
Beyhan's avatar
Beyhan committed
408
409

/** Only to access SymConst of kind type_tag or size.  Else assertion: */
410
411
type    *get_SymConst_type (ir_node *node);
void     set_SymConst_type (ir_node *node, type *tp);
Beyhan's avatar
Beyhan committed
412
413
414
415
416
417
418
419
420
421
422

/** Only to access SymConst of kind addr_name.  Else assertion: */
ident   *get_SymConst_name (ir_node *node);
void     set_SymConst_name (ir_node *node, ident *name);

/** Only to access SymConst of kind addr_ent.  Else assertion: */
entity  *get_SymConst_entity (ir_node *node);
void     set_SymConst_entity (ir_node *node, entity *ent);

/** Sets both: type and ptrinfo.  Needed to treat the node independent of
   its semantics.  Does a memcpy for the memory sym points to. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
423
424
425
426
/* write 'union': firmjni then does not create a method... */
union symconst_symbol get_SymConst_symbol (ir_node *node);
void                  set_SymConst_symbol (ir_node *node,
					   union symconst_symbol sym);
427
428
429
430
431
432
433
434
435
436
437

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
438

439
440
441
/**
 * Projection numbers for result of Call node: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
442
443
444
445
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
446
                 passed by value (for compound result types). */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
447
  pn_Call_X_except  = 1,  /**< The control flow result branching to the exception handler */
Michael Beck's avatar
Michael Beck committed
448
  pn_Call_M_except  = 3,  /**< The memory result in case the called method terminated with
Florian Liekweg's avatar
Florian Liekweg committed
449
                 an exception */
450
  pn_Call_max       = 5   /**< number of projections from a Call */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
451
452
} pn_Call;   /* Projection numbers for Call. */

453
454
455
456
457
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
458
/** Gets the number of parameters of a call. */
459
int      get_Call_n_params (ir_node *node);
Michael Beck's avatar
Michael Beck committed
460
/** Gets the call parameter at position pos. */
461
ir_node *get_Call_param (ir_node *node, int pos);
Michael Beck's avatar
Michael Beck committed
462
/** Sets the call parameter at position pos. */
463
void     set_Call_param (ir_node *node, int pos, ir_node *param);
Michael Beck's avatar
Michael Beck committed
464
/** Gets the type of a call. */
465
type    *get_Call_type (ir_node *node);
Michael Beck's avatar
Michael Beck committed
466
/** Sets the type of a call. */
467
void     set_Call_type (ir_node *node, type *tp);
Michael Beck's avatar
Michael Beck committed
468
/** Gets the arity of a call. Identical to get_Call_n_params(). */
469
int      get_Call_arity (ir_node *node);
470

471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
/** Set, get and remove the callee information for a Call node.
 *
 *  The callee information lists all method entities that can be called
 *  from this node.  If the address expression can not be analyzed fully,
 *  e.g., as there are external methods that could be called, the array
 *  contains a single NULL entry.
 *
 *  The array is only accessible if callee information is valid.  See flag
 *  in graph.
 *
 *  The memory allocated for the array is managed automatically, i.e., it must
 *  not be freed if the Call node is removed from the graph.
 *
 *  @param node A Call node.
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
486
int     Call_has_callees      (ir_node *node);
487
488
489
490
491
492
493
int     get_Call_n_callees    (ir_node *node);
entity *get_Call_callee       (ir_node *node, int pos);
/** Set the full callee array.
 *
 *  The passed array is copied. Assumes current_ir_graph set properly! */
void    set_Call_callee_arr   (ir_node *node, const int n, entity **arr);
void    remove_Call_callee_arr(ir_node *node);
494

Götz Lindenmaier's avatar
Götz Lindenmaier committed
495
496
497
498
ir_node  *get_CallBegin_ptr  (ir_node *node);
void      set_CallBegin_ptr  (ir_node *node, ir_node *ptr);
ir_node  *get_CallBegin_call (ir_node *node);
void      set_CallBegin_call (ir_node *node, ir_node *call);
499

500
501
502
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);
503
/** Gets the number of parameters of a func call. */
504
int      get_FuncCall_n_params (ir_node *node);
505
/** Gets the func call parameter at position pos. */
506
ir_node *get_FuncCall_param (ir_node *node, int pos);
507
/** Sets the func call parameter at position pos. */
508
void     set_FuncCall_param (ir_node *node, int pos, ir_node *param);
509
/** Gets the type of a func call. */
510
type    *get_FuncCall_type (ir_node *node);
511
/** Sets the type of a func call. */
512
void     set_FuncCall_type (ir_node *node, type *tp);
513
/** Gets the arity of a func call. Identical to get_FuncCall_n_params(). */
514
int      get_FuncCall_arity (ir_node *node);
515

516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
/** Set, get and remove the callee information for a Call node.
 *
 *  The callee information lists all method entities that can be called
 *  from this node.  If the address expression can not be analyzed fully,
 *  e.g., as there are external methods that could be called, the array
 *  contains a single NULL entry.
 *
 *  The array is only accessible if callee information is valid.  See flag
 *  in graph.
 *
 *  The memory allocated for the array is managed automatically, i.e., it must
 *  not be freed if the Call node is removed from the graph.
 *
 *  @param node A FuncCall node.
 */
531
532
533
534
535
536
537
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
538
539
540
/* 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
541
   unops are: Minus, Abs, Not, Conv, Cast
Christian Schäfer's avatar
Christian Schäfer committed
542
543
   binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
   Shr, Shrs, Rot, Cmp */
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
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);
577

578
579
580
/**
 * Projection numbers for Quot: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
581
582
typedef enum {
  pn_Quot_M,           /**< Memory result.    */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
583
  pn_Quot_X_except,    /**< Execution result if exception occured. */
584
585
  pn_Quot_res,         /**< Result of computation. */
  pn_Quot_max          /**< number of projections from a Quot */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
586
587
} pn_Quot;  /* Projection numbers for Quot. */

588
589
590
591
592
593
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);
594

595
596
597
/**
 * Projection numbers for DivMod: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
598
599
typedef enum {
  pn_DivMod_M,           /**< Memory result.    */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
600
  pn_DivMod_X_except,    /**< Execution result if exception occured. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
601
  pn_DivMod_res_div,     /**< Result of computation a / b. */
602
603
  pn_DivMod_res_mod,     /**< Result of computation a % b. */
  pn_DivMod_max          /**< number of projections from a DivMod */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
604
605
} pn_DivMod;  /* Projection numbers for DivMod. */

606
607
608
609
610
611
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);
612

613
614
615
/**
 * Projection numbers for Div: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
616
617
typedef enum {
  pn_Div_M,           /**< Memory result.    */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
618
  pn_Div_X_except,    /**< Execution result if exception occured. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
619
620
621
  pn_Div_res          /**< Result of computation. */
} pn_Div;  /* Projection numbers for Div. */

622
623
624
625
626
627
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);
628

629
630
631
/**
 * Projection numbers for Mod: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
632
633
typedef enum {
  pn_Mod_M,           /**< Memory result.    */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
634
  pn_Mod_X_except,    /**< Execution result if exception occured. */
635
636
  pn_Mod_res,         /**< Result of computation. */
  pn_Mod_max          /**< number of projections from a Mod */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
637
638
} pn_Mod;  /* Projection numbers for Mod. */

639
640
ir_node *get_Abs_op (ir_node *node);
void     set_Abs_op (ir_node *node, ir_node *op);
641

642
643
644
645
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);
646

647
648
649
650
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);
651

652
653
654
655
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);
656

657
658
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
659

660
661
/**
 * Projection numbers for Cmp are defined several times.
662
 * The bit patterns are used for various tests, so don't change.
663
664
665
 * The "unordered" values are possible results of comparing
 * floating point numbers.
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
666
667
typedef enum {
  pn_Cmp_False = 0,   /**< false */
Florian Liekweg's avatar
Florian Liekweg committed
668
669
670
671
672
673
  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
674
  pn_Cmp_Leg = 7,     /**< less, equal or greater = ordered */
Florian Liekweg's avatar
Florian Liekweg committed
675
676
677
678
679
680
681
  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
682
  pn_Cmp_True = 15    /**< true */
Florian Liekweg's avatar
Florian Liekweg committed
683
  /* not_mask = Leg*/   /* bits to flip to negate comparison * @@ hack for jni interface */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
684
} pn_Cmp;   /* Projection numbers for Cmp */
685
/* #define not_mask pn_Cmp_Leg */
686

687
688
689
690
691
692
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);
693

694
695
696
697
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);
698

699
700
701
702
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);
703

704
705
706
707
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);
708

709
710
711
712
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);
713

714
715
ir_node *get_Conv_op (ir_node *node);
void     set_Conv_op (ir_node *node, ir_node *op);
716

Götz Lindenmaier's avatar
comment    
Götz Lindenmaier committed
717
718
/* Does Cast need a mem operator?
 * Cast should only depend on the type, not on the state of an
719
 * entity.  But:  we initialze various fields after Alloc, that
Götz Lindenmaier's avatar
comment    
Götz Lindenmaier committed
720
721
722
 * are accessed in the cast.  This required some precaution, to
 * get the right memory into the Loads generated from the cast.
 */
723
724
725
726
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
727

Götz Lindenmaier's avatar
Götz Lindenmaier committed
728
729
730
/** Returns true if n is Phi or Filter in interprocedural_view.
   Returns false if irg in phase building and the Phi has zero
   predecessors: it's a Phi0. */
731
int       is_Phi (ir_node *n);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
732
733
734
/** Returns true  if irg in phase building and the Phi has zero
   predecessors: it's a Phi0. */
int       is_Phi0 (ir_node *n);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
735
/* These routines also work for Filter nodes in interprocedural view. */
736
737
738
739
740
741
742
743
744
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);
745
746
/* set the interprocedural predecessors, ...d_arr uses current_ir_graph.
 * @@@ Maybe better:  arity is zero if no cg preds. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
747
748
749
750
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);
int      get_Filter_n_cg_preds(ir_node *node);
ir_node *get_Filter_cg_pred(ir_node *node, int pos);
751

752
753
754
755
756
757
758
759
760
761
762
/** Return true if parameter is a memory operation.
 *
 *  A memory operation is an operation that directly changes the
 *  memory.  I.e., a Load or a Store operation.
 */
int is_memop(ir_node *node);
ir_node *get_memop_mem (ir_node *node);
void     set_memop_mem (ir_node *node, ir_node *mem);
ir_node *get_memop_ptr (ir_node *node);
void     set_memop_ptr (ir_node *node, ir_node *ptr);

763
764
765
/**
 * Projection numbers for Load: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
766
767
typedef enum {
  pn_Load_M,         /**< Memory result.    */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
768
  pn_Load_X_except,  /**< Execution result if exception occured. */
769
770
  pn_Load_res,       /**< Result of load operation. */
  pn_Load_max        /**< number of projections from a Load */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
771
772
} pn_Load;  /* Projection numbers for Load. */

773
774
775
776
777
778
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);
ir_mode       *get_Load_mode (ir_node *node);
void           set_Load_mode (ir_node *node, ir_mode *mode);
Michael Beck's avatar
Michael Beck committed
779
780
ent_volatility get_Load_volatility (ir_node *node);
void           set_Load_volatility (ir_node *node, ent_volatility volatility);
781

782
783
784
/**
 * Projection numbers for Store: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
785
typedef enum {
Götz Lindenmaier's avatar
Götz Lindenmaier committed
786
  pn_Store_M,         /**< Memory result.    */
787
788
  pn_Store_X_except,  /**< Execution result if exception occured. */
  pn_Store_max        /**< number of projections from a Store */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
789
790
} pn_Store;  /* Projection numbers for Store. */

791
792
793
794
795
796
797
798
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);
ent_volatility get_Store_volatility (ir_node *node);
void           set_Store_volatility (ir_node *node, ent_volatility volatility);
799

800
801
802
/**
 * Projection numbers for Alloc: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
803
typedef enum {
804
805
806
807
  pn_Alloc_M,          /**< Memory result. */
  pn_Alloc_X_except,  /**< Execution result if exception occured. */
  pn_Alloc_res,       /**< Result of allocation. */
  pn_Alloc_max        /**< number of projections from an Alloc */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
808
809
} pn_Alloc;  /* Projection numbers for Alloc. */

810
811
812
813
814
815
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
816

817
/** The allocation place. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
818
typedef enum {
Michael Beck's avatar
Michael Beck committed
819
820
  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
821
} where_alloc;
Michael Beck's avatar
Michael Beck committed
822

823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
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);
long      get_Proj_proj (ir_node *node);
void      set_Proj_proj (ir_node *node, long proj);
844

845
846
847
848
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);
849

850
851
ir_node  *get_Id_pred (ir_node *node);
void      set_Id_pred (ir_node *node, ir_node *pred);
852

Götz Lindenmaier's avatar
Götz Lindenmaier committed
853
854
855
/** Confirm has a single result and returns 'value' unchanged.
 *  The node expresses a restriction on 'value':
 *  'value' 'cmp' 'bound' == true.                                 */
856
857
858
859
860
861
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
862

Michael Beck's avatar
Michael Beck committed
863
/*
Götz Lindenmaier's avatar
Götz Lindenmaier committed
864
865
866
 *
 * NAME Auxiliary routines
 *
Sebastian Felis's avatar
Sebastian Felis committed
867
 *  Not properly documented ;-)
Götz Lindenmaier's avatar
Götz Lindenmaier committed
868
869
 *
 */
Christian Schäfer's avatar
Christian Schäfer committed
870

Michael Beck's avatar
Michael Beck committed
871
/** returns operand of node if node is a Proj. */
872
ir_node *skip_Proj (ir_node *node);
Michael Beck's avatar
Michael Beck committed
873
/** returns operand of node if node is a Id */
874
ir_node *skip_Id  (ir_node *node);   /* Same as skip_nop. */
875
876
/* returns corresponding operand of Tuple if node is a Proj from
   a Tuple. */
877
ir_node *skip_Tuple (ir_node *node);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
878
879
/** returns operand of node if node is a Cast */
ir_node *skip_Cast  (ir_node *node);
Michael Beck's avatar
Michael Beck committed
880
/** returns true if node is a Bad node. */
881
int      is_Bad    (ir_node *node);
Michael Beck's avatar
Michael Beck committed
882
/** returns true if the node is not a Block */
883
int      is_no_Block (ir_node *node);
Michael Beck's avatar
Michael Beck committed
884
/** returns true if the node is a Block */
885
int      is_Block (ir_node *node);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
886
/** returns true if node is a Unknown node. */
887
int      is_Unknown (ir_node *node);
Michael Beck's avatar
Michael Beck committed
888
/** returns true if node is a Proj node or a Filter node in
889
 * intraprocedural view */
890
int      is_Proj (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
891
/** Returns true if the operation manipulates control flow:
892
   Start, End, Jmp, Cond, Return, Raise, Bad, CallBegin, EndReg, EndExcept */
Christian Schäfer's avatar
Christian Schäfer committed
893
int is_cfop(ir_node *node);
894

Michael Beck's avatar
Michael Beck committed
895
/** Returns true if the operation manipulates interprocedural control flow:
896
    CallBegin, EndReg, EndExcept */
897
int is_ip_cfop(ir_node *node);
Michael Beck's avatar
Michael Beck committed
898
/** Returns true if the operation can change the control flow because
899
900
    of an exception: Call, Quot, DivMod, Div, Mod, Load, Store, Alloc,
    Bad. */
Christian Schäfer's avatar
Christian Schäfer committed
901
int is_fragile_op(ir_node *node);
Michael Beck's avatar
Michael Beck committed
902
/** Returns the memory operand of fragile operations. */
903
ir_node *get_fragile_op_mem(ir_node *node);
Christian Schäfer's avatar
Christian Schäfer committed
904

Michael Beck's avatar
Michael Beck committed
905
/*-----------------------------------------------------------------*/
Götz Lindenmaier's avatar
Götz Lindenmaier committed
906
/** Debug aides                                                   **/
Michael Beck's avatar
Michael Beck committed
907
/*-----------------------------------------------------------------*/
Götz Lindenmaier's avatar
Götz Lindenmaier committed
908
909
910
911
912
913


/** Debug print the node.
 *
 *  Writes the node, all its attributes and the predecessors to stdout if DEBUG_libfirm
 *  is set.  Else does nothing. */
Michael Beck's avatar
Michael Beck committed
914
void    dump_irn(ir_node *n);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
915

Götz Lindenmaier's avatar
Götz Lindenmaier committed
916
917
#include "ident.h"

918
#ifdef __GNUC__
919
/* GNU C has the __FUNCTION__ extension */
920
921
922
923
924
#define __MYFUNC__ __FUNCTION__
#else
/* use Filename instead */
#define __MYFUNC__ __FILE__
#endif
925

Götz Lindenmaier's avatar
Götz Lindenmaier committed
926
927
/* !!!!!!!!! @@@
   Don't format with "\", firmjni gets problems */
928
/** Output location */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
929
#define DDM      printf("%s(l.%i).\n",                       __MYFUNC__, __LINE__);
930
/** Output the firm kind of the node */
931
#define DDMK(X)  printf("%s(l.%i) %s: %p\n",                 __MYFUNC__, __LINE__,  print_firm_kind(X), (void *)(X));
932
/** Output information about a node */
933
#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))
934
/** Output information about a node and its block */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
935
#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)))
936
/** Output information about a type */
937
#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))
938
/** Output information about an entity */
939
#define DDME(X)  printf("%s(l.%i) %s: %ld (%p)\n",           __MYFUNC__, __LINE__, get_entity_name(X), get_entity_nr(X), (void *)(X))
940
941
/** 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))
942
/** Output information about an entity and its owner */
943
#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))
944
/** Output information about a graph */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
945
#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))))
946
/** Output information about an ident */
947
#define DDMI(X)  printf("%s(l.%i) %s: %p\n",                 __MYFUNC__, __LINE__, get_id_str(X), (void *)(X))
948
/** Output information about a mode */
949
#define DDMM(X)  printf("%s(l.%i) %s: %p\n",                 __MYFUNC__, __LINE__, get_mode_name(X), (void *)(X))
950
/** Output information about a loop */
951
#define DDML(X)  printf("%s(l.%i) loop with depth %d: %d\n", __MYFUNC__, __LINE__, get_loop_depth(X), get_loop_loop_nr(X))
952
/** Output information about a tarVal */
953
#define DDMV(X)  printf("%s(l.%i) tarval: ",__MYFUNC__, __LINE__); tarval_printf(X); printf(" (%p)\n", (void *)(X));
954

Michael Beck's avatar
Michael Beck committed
955
/*@}*/ /* end of ir_node group definition */
956

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

Hannes Jakschitsch's avatar
Hannes Jakschitsch committed
958
959
960
961
#ifdef __cplusplus
}
#endif

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