irnode.h 48.9 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
 */
Michael Beck's avatar
Michael Beck committed
12
13
#ifndef _IRNODE_H_
#define _IRNODE_H_
Christian Schäfer's avatar
Christian Schäfer committed
14

15
16
#include <stddef.h>

Michael Beck's avatar
Michael Beck committed
17
18
19
20
21
22
23
24
#include "irgraph.h"
#include "entity.h"
#include "firm_common.h"
#include "irop.h"
#include "irmode.h"
#include "type.h"
#include "irextbb.h"
#include "dbginfo.h"
Christian Schäfer's avatar
Christian Schäfer committed
25

Michael Beck's avatar
Michael Beck committed
26
27
/**
 * @file irnode.h
Götz Lindenmaier's avatar
Götz Lindenmaier committed
28
 *
Michael Beck's avatar
Michael Beck committed
29
 * @author Martin Trapp, Christian Schaefer
Götz Lindenmaier's avatar
Götz Lindenmaier committed
30
 *
Michael Beck's avatar
Michael Beck committed
31
32
33
34
35
36
 * Declarations of an ir node.
 */

/**
 * @defgroup ir_node Declarations of an ir node.
 *
37
 * The type definition of ir_node is also in irgraph.h to resolve
Michael Beck's avatar
Michael Beck committed
38
 *  recursion between irnode.h and irgraph.h
Götz Lindenmaier's avatar
Götz Lindenmaier committed
39
 *
Michael Beck's avatar
Michael Beck committed
40
 * ir_node - a datatype representing a Firm node
Götz Lindenmaier's avatar
Götz Lindenmaier committed
41
 *
Michael Beck's avatar
Michael Beck committed
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 *  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
57
 */
Michael Beck's avatar
Michael Beck committed
58

Götz Lindenmaier's avatar
Götz Lindenmaier committed
59
60
#ifndef _IR_NODE_TYPEDEF_
#define _IR_NODE_TYPEDEF_
Christian Schäfer's avatar
Christian Schäfer committed
61
62
63
typedef struct ir_node ir_node;
#endif

Hannes Jakschitsch's avatar
Hannes Jakschitsch committed
64
#ifdef __cplusplus
Götz Lindenmaier's avatar
Götz Lindenmaier committed
65
extern "C" {
Hannes Jakschitsch's avatar
Hannes Jakschitsch committed
66
67
#endif

Sebastian Felis's avatar
Sebastian Felis committed
68
/**
Michael Beck's avatar
Michael Beck committed
69
70
71
 *   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
72

Sebastian Felis's avatar
Sebastian Felis committed
73
74
75
/**
 *   Checks whether a pointer points to a ir node.
 *
76
77
 *   @param thing   an arbitrary pointer
 *   @return        non-zero if the thing is a ir mode, else zero
Sebastian Felis's avatar
Sebastian Felis committed
78
 */
79
int is_ir_node (const void *thing);
Sebastian Felis's avatar
Sebastian Felis committed
80

81
82
83
84
85
86
/**
 * Returns the number of predecessors without the block predecessor.
 *
 * @param node   the IR-node
 */
int           get_irn_arity         (const ir_node *node);
87
88
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
89
90

/** Replaces the old in array by a new one that will contain the ins given in
91
   the parameters.  Conserves the block predecessor.  It copies the array passed.
92
   This function is necessary to adjust in arrays of blocks, calls and phis.
93
   Assumes that current_ir_graph is set to the graph containing "node".
94
95
   "in" must contain all predecessors except the block that are required for
   the nodes opcode. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
96
97
void          set_irn_in            (ir_node *node, int arity, ir_node *in[]);

Christian Schäfer's avatar
Christian Schäfer committed
98
99
100
/* 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
101
   to iterate including the Block predecessor iterate from i = -1 to
Christian Schäfer's avatar
Christian Schäfer committed
102
   i < get_irn_arity. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
103
/* Access predecessor n */
104
105
106
107
108

/**
 * Get the n-th predecessor of a node.
 * This function removes Id predecessors.
 */
Sebastian Hack's avatar
Sebastian Hack committed
109
110
111
ir_node      *get_irn_n             (const ir_node *node, int n);
ir_node      *get_irn_intra_n       (const ir_node *node, int n);
ir_node      *get_irn_inter_n       (const ir_node *node, int n);
112
113

/** Replace the n-th predecessor of a node with a new one. */
114
void          set_irn_n             (ir_node *node, int n, ir_node *in);
115
/* Sets the mode struct of node.  */
116
void          set_irn_mode (ir_node *node, ir_mode *mode);
117
/** Gets the mode struct of a node.  */
118
ir_mode      *get_irn_mode          (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
119
/** Gets the mode-enum modecode. */
120
modecode      get_irn_modecode      (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
121
/** Gets the ident for a string representation of the mode .*/
122
ident        *get_irn_modeident     (const ir_node *node);
123
/** Gets the string representation of the mode .*/
124
const char   *get_irn_modename      (const ir_node *node);
125
/** Gets the opcode struct of the node. */
126
ir_op        *get_irn_op            (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
127
/** Sets the opcode struct of the node. */
128
void          set_irn_op            (ir_node *node, ir_op *op);
Michael Beck's avatar
Michael Beck committed
129
/** Gets the opcode-enum of the node. */
130
opcode        get_irn_opcode        (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
131
/** Get the string representation of the opcode. */
132
const char   *get_irn_opname        (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
133
/** Get the ident for a string representation of the opcode. */
134
ident        *get_irn_opident       (const ir_node *node);
135
/** Gets the visited counter of a node. */
136
unsigned long get_irn_visited (const ir_node *node);
137
/** Sets the visited counter of a node. */
138
void          set_irn_visited (ir_node *node, unsigned long visited);
Michael Beck's avatar
Michael Beck committed
139
/** Sets visited to get_irg_visited(current_ir_graph). */
140
void          mark_irn_visited (ir_node *node);
141
/** Returns 1 if visited < get_irg_visited(current_ir_graph). */
142
int           irn_not_visited  (const ir_node *node);
143
/** Returns 1 if visited >= get_irg_visited(current_ir_graph). */
144
int           irn_visited      (const ir_node *node);
145
146
147
148
149

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

/** Returns the link of a node.  */
153
void         *get_irn_link     (const ir_node *node);
154
155

/** Returns the ir_graph this node belongs to. Only valid if irg
156
 *  is in state op_pin_state_pinned (irg is only stored in the block. */
Sebastian Hack's avatar
Sebastian Hack committed
157
ir_graph     *get_irn_irg      (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
158

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

164
165
166
167
168
169
170
/** Returns the pinned state of a node.
 *
 *  Returns whether the node _always_ must be pinned.
 *  I.e., the node is not floating after global cse.
 *
 * @returns Either state op_pin_state_pinned or op_pin_state_floats.
 */
Michael Beck's avatar
Michael Beck committed
171
172
173
174
op_pin_state get_irn_pinned    (const ir_node *node);

/** Set pin state for nodes with op pin state op_pin_state_exc_pinned */
void set_irn_pinned(ir_node *node, op_pin_state state);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
175

176
177
178
179
180
181
182
183
/** Returns whether the node is currently pinned.
 *
 * If get_irn_pinned returns op_pin_state_floats and the graph the
 * node belongs to is in state op_poin_state_floats then this function
 * returns 'floats', else 'pinned'.
 */
op_pin_state is_irn_pinned_in_irg (const ir_node *node);

Michael Beck's avatar
Michael Beck committed
184
185
186
187
/**
 * irnode constructor.
 * Create a new irnode in irg, with an op, mode, arity and
 * some incoming irnodes.
188
189
190
191
 * 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.
Michael Beck's avatar
Michael Beck committed
192
 * @param block The block the new node belongs to
193
194
195
196
 * @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
197
 */
198
ir_node *
Götz Lindenmaier's avatar
Götz Lindenmaier committed
199
new_ir_node (dbg_info *db,
Florian Liekweg's avatar
Florian Liekweg committed
200
201
202
203
204
205
         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
206

207
208
209
210
211
/**
 * Return the block the node belongs to.  This is only
 * possible for pinned nodes or if the graph is in pinned state.
 * Otherwise the block may be incorrect.  This condition is
 * now checked by an assertion.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
212
213
214
215
216
 *
 * This works for all except Block.  It can return Blocks or the Bad node.
 *
 * To express the difference to access routines that work for all
 * nodes we use infix "nodes" and do not name this function
217
 * get_irn_block(). */
Sebastian Hack's avatar
Sebastian Hack committed
218
ir_node  *get_nodes_block (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
219
220

/** Sets the Block of a node. */
221
void      set_nodes_block (ir_node *node, ir_node *block);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
222

Götz Lindenmaier's avatar
Götz Lindenmaier committed
223
/**
Michael Beck's avatar
Michael Beck committed
224
 * @function get_irn_block()
225
 * @see get_nodes_block()
Götz Lindenmaier's avatar
Götz Lindenmaier committed
226
 */
227

228
229
230
231
/**
 * Projection numbers for result of Start node: use for Proj nodes!
 */
typedef enum {
232
233
234
235
236
237
238
239
240
  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 */
241
242
} pn_Start; /* Projection numbers for Start. */

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

244
245
246
247
/** 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. */
Michael Beck's avatar
Michael Beck committed
248
ir_type *is_frame_pointer(ir_node *n);
249
250
251
252
253

/** 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. */
Michael Beck's avatar
Michael Beck committed
254
ir_type *is_globals_pointer(ir_node *n);
255
256
257
258
259
260
261

/** 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
262

263
/* @@@ no more supported  */
264
ir_node **get_Block_cfgpred_arr (ir_node *node);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
265
int       get_Block_n_cfgpreds (ir_node *node);
266
267
ir_node  *get_Block_cfgpred (ir_node *node, int pos);
void      set_Block_cfgpred (ir_node *node, int pos, ir_node *pred);
268
269
/** Get the predecessor block.
 *
270
 *  Returns the block corresponding to the predecessor pos of block.
271
272
273
274
275
276
277
278
279
 *
 *  There are several ambiguities we resolve with this function:
 *  - The direct predecessor can be a Proj, which is not pinned.
 *    We walk from the predecessor to the next pinned node
 *    (skip_Proj) and return the block that node is in.
 *  - If we encounter the Bad node, this function does not return
 *    Start, but the Bad node.
 */
ir_node  *get_Block_cfgpred_block(ir_node *node, int pos);
280
281
int       get_Block_matured (ir_node *node);
void      set_Block_matured (ir_node *node, int matured);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
282
283
284

/** A visited flag only for block nodes.
 *  @see also: get_irn_visited() inc_irg_visited() inc_irg_block_visited()*/
285
286
unsigned long get_Block_block_visited (ir_node *node);
void      set_Block_block_visited (ir_node *node, unsigned long visit);
287
288
289
290
291

/**
 * Marks a block as dead but do not replace it with a Bad node.
 * Dead blocks are removed in the con
 */
292
293
294
ir_node  *set_Block_dead(ir_node *block);
int       is_Block_dead(const ir_node *block);

Götz Lindenmaier's avatar
Götz Lindenmaier committed
295
/* For this current_ir_graph must be set. */
296
297
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
298

299
300
/* Set and remove interprocedural predecessors. If the interprocedural
 * predecessors are removed, the node has the same predecessors in
301
302
 * both views.
 * @@@ Maybe better:  arity is zero if no cg preds. */
303
304
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);
305
/* @@@ not supported */
306
ir_node **get_Block_cg_cfgpred_arr(ir_node * node);
Michael Beck's avatar
Michael Beck committed
307
/** Returns the number of interprocedural predecessors.  0 if none. */
308
int       get_Block_cg_n_cfgpreds(ir_node * node);
Michael Beck's avatar
Michael Beck committed
309
/** Return the interprocedural predecessor at position pos. */
310
ir_node  *get_Block_cg_cfgpred(ir_node * node, int pos);
311
/* frees the memory. */
312
313
void      remove_Block_cg_cfgpred_arr(ir_node * node);

314
315
316
317
318
/** returns the extended basic block a block belongs to */
ir_extblk *get_Block_extbb(const ir_node *block);
/** sets the extended basic block a block belongs to */
void set_Block_extbb(ir_node *block, ir_extblk *extblk);

Michael Beck's avatar
Michael Beck committed
319
/** Return the number of Keep alive node. */
320
int  get_End_n_keepalives(ir_node *end);
Michael Beck's avatar
Michael Beck committed
321
322

/** Return the Keep alive node a position pos. */
323
ir_node *get_End_keepalive(ir_node *end, int pos);
Michael Beck's avatar
Michael Beck committed
324
325

/** Keep alive dedicated nodes.  These must be either PhiM or Block nodes. */
326
void add_End_keepalive (ir_node *end, ir_node *ka);
Michael Beck's avatar
Michael Beck committed
327
328

/** Set the Keep alive node at position pos. */
329
void set_End_keepalive(ir_node *end, int pos, ir_node *ka);
Michael Beck's avatar
Michael Beck committed
330

331
332
333
/** Set new keep-alives */
void set_End_keepalives(ir_node *end, int n, ir_node *in[]);

Michael Beck's avatar
Michael Beck committed
334
/** Some parts of the End node are allocated separately -- their memory
335
   is not recovered by dead_node_elimination if a End node is dead.
Michael Beck's avatar
Michael Beck committed
336
   free_End() frees these data structures. */
337
void free_End (ir_node *end);
338

339
340
341
342
343
/** Return the target address of an IJmp */
ir_node *get_IJmp_target(ir_node *ijmp);

/** Sets the target address of an IJmp */
void set_IJmp_target(ir_node *ijmp, ir_node *tgt);
344

345
346
347
348
349
350
351
352
/* 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.
353
   We differ two flavors of this Cond.  The first, the dense Cond, passes
354
355
   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.
356
   The second Cond flavor differences in the treatment of cases not specified in
357
358
359
360
361
   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.
362
363
   The two switch flavors are distinguished by a flag of type cond_kind.
   Default flavor is "dense"
364
365
*/
typedef enum {
Michael Beck's avatar
Michael Beck committed
366
367
  dense,        /**< Default. Missing Proj nodes are dead control flow. */
  fragmentary   /**< Special. No control flow optimizations allowed.  Missing
Florian Liekweg's avatar
Florian Liekweg committed
368
           Proj nodes mean default control flow, i.e., Proj(n). */
369
370
} cond_kind;

371
372
373
374
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);
375
long      get_Cond_defaultProj (ir_node *node);
Christian Schäfer's avatar
Christian Schäfer committed
376

377
378
379
/**
 * Projection numbers for conditions.
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
380
381
typedef enum {
  pn_Cond_false,    /**< Control flow if operand is "false". */
382
383
  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
384
385
} pn_Cond;  /* Projection numbers for Cond. */

386
387
388
389
390
391
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
392

Sebastian Hack's avatar
Sebastian Hack committed
393
typedef enum {
394
395
396
  CNST_NULL     =  0, /**< The node is a const(0). */
  CNST_ONE      = +1, /**< The node is a const(1). */
  CNST_ALL_ONE  = -1, /**< The node is a const(11111...). */
397
  CNST_OTHER    =  2, /**< The tarval of the const has another value. */
398
399
  CNST_SYMCONST =  3, /**< The node is symconst. */
  CNST_NO_CONST =  4  /**< The node is no const at all. */
Sebastian Hack's avatar
Sebastian Hack committed
400
401
} cnst_classify_t;

402
403
tarval  *get_Const_tarval (ir_node *node);
void     set_Const_tarval (ir_node *node, tarval *con);
Michael Beck's avatar
Michael Beck committed
404

Sebastian Hack's avatar
Sebastian Hack committed
405
406
407
408
409
410
411
/**
 * Classify a node concerning constant properties.
 * @param irn A node to check for.
 * @return Constant properties of that node.
 */
cnst_classify_t classify_Const(ir_node *irn);

Michael Beck's avatar
Michael Beck committed
412
413
414
/** Returns the source language type of a Const node.
 * Must be an atomic type.  Mode of type must be mode of node.
 */
Michael Beck's avatar
Michael Beck committed
415
ir_type  *get_Const_type   (ir_node *node);
Michael Beck's avatar
Michael Beck committed
416
417

/** Sets the source language type of a Const node. */
Michael Beck's avatar
Michael Beck committed
418
void     set_Const_type   (ir_node *node, ir_type *tp);
Christian Schäfer's avatar
Christian Schäfer committed
419

Michael Beck's avatar
Michael Beck committed
420
/**  This enum names the three different kinds of symbolic Constants
Götz Lindenmaier's avatar
Götz Lindenmaier committed
421
422
423
424
     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 {
Beyhan's avatar
Beyhan committed
425
426
427
428
429
430
431
432
433
434
  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
435
} symconst_kind;
436

Götz Lindenmaier's avatar
Götz Lindenmaier committed
437
438
439
/** SymConst attribute.
 *
 *  This union contains the symbolic information represented by the node.  */
Beyhan's avatar
Beyhan committed
440
union symconst_symbol {
Michael Beck's avatar
Michael Beck committed
441
442
443
  ir_type *type_p;
  ident   *ident_p;
  entity  *entity_p;
Beyhan's avatar
Beyhan committed
444
};
445

Beyhan's avatar
Beyhan committed
446
447
typedef union symconst_symbol symconst_symbol;

448

Michael Beck's avatar
Michael Beck committed
449
/** Get the kind of the SymConst. */
450
symconst_kind get_SymConst_kind (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
451
/** Set the kind of the SymConst. */
452
void          set_SymConst_kind (ir_node *node, symconst_kind num);
Beyhan's avatar
Beyhan committed
453
454

/** Only to access SymConst of kind type_tag or size.  Else assertion: */
Michael Beck's avatar
Michael Beck committed
455
456
ir_type  *get_SymConst_type (ir_node *node);
void     set_SymConst_type (ir_node *node, ir_type *tp);
Beyhan's avatar
Beyhan committed
457
458
459
460
461
462
463
464
465
466
467

/** 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
468
469
470
471
/* 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);
472

Götz Lindenmaier's avatar
Götz Lindenmaier committed
473
474
475
/** Access the type of the value represented by the SymConst.
 *
 *  Example: primitive type int for SymConst size. */
Michael Beck's avatar
Michael Beck committed
476
477
ir_type *get_SymConst_value_type (ir_node *node);
void    set_SymConst_value_type (ir_node *node, ir_type *tp);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
478

479
480
481
482
483
484
485
486
487
488
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
489

490
491
492
/**
 * Projection numbers for result of Call node: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
493
494
495
496
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
497
                 passed by value (for compound result types). */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
498
  pn_Call_X_except  = 1,  /**< The control flow result branching to the exception handler */
Michael Beck's avatar
Michael Beck committed
499
  pn_Call_M_except  = 3,  /**< The memory result in case the called method terminated with
Florian Liekweg's avatar
Florian Liekweg committed
500
                 an exception */
501
  pn_Call_max       = 5   /**< number of projections from a Call */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
502
} pn_Call;   /* Projection numbers for Call. */
503
#define pn_Call_M pn_Call_M_regular
Götz Lindenmaier's avatar
Götz Lindenmaier committed
504

505
506
507
508
509
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
510
/** Gets the number of parameters of a call. */
511
int      get_Call_n_params (ir_node *node);
Michael Beck's avatar
Michael Beck committed
512
/** Gets the call parameter at position pos. */
513
ir_node *get_Call_param (ir_node *node, int pos);
Michael Beck's avatar
Michael Beck committed
514
/** Sets the call parameter at position pos. */
515
void     set_Call_param (ir_node *node, int pos, ir_node *param);
Michael Beck's avatar
Michael Beck committed
516
/** Gets the type of a call. */
Michael Beck's avatar
Michael Beck committed
517
ir_type *get_Call_type (ir_node *node);
Michael Beck's avatar
Michael Beck committed
518
/** Sets the type of a call. */
Michael Beck's avatar
Michael Beck committed
519
void     set_Call_type (ir_node *node, ir_type *tp);
Michael Beck's avatar
Michael Beck committed
520
/** Gets the arity of a call. Identical to get_Call_n_params(). */
521
int      get_Call_arity (ir_node *node);
522

523
524
525
526
/** 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,
Götz Lindenmaier's avatar
Götz Lindenmaier committed
527
528
529
530
 *  e.g., as entities can be called that are not in the compilation unit,
 *  the array contains the unknown_entity.  The array contains only entities
 *  with peculiarity_existent, but with all kinds of visibility.  The entities
 *  not necessarily contain an irg.
531
532
533
534
535
536
537
538
539
 *
 *  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
540
int     Call_has_callees      (ir_node *node);
541
542
int     get_Call_n_callees    (ir_node *node);
entity *get_Call_callee       (ir_node *node, int pos);
Michael Beck's avatar
Michael Beck committed
543

544
545
546
547
548
/** 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);
549

Götz Lindenmaier's avatar
Götz Lindenmaier committed
550
551
552
553
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);
554

Christian Schäfer's avatar
Christian Schäfer committed
555
556
557
/* 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
558
   unops are: Minus, Abs, Not, Conv, Cast
Christian Schäfer's avatar
Christian Schäfer committed
559
560
   binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
   Shr, Shrs, Rot, Cmp */
Michael Beck's avatar
Michael Beck committed
561
int      is_unop (const ir_node *node);
562
563
ir_node *get_unop_op (ir_node *node);
void     set_unop_op (ir_node *node, ir_node *op);
Michael Beck's avatar
Michael Beck committed
564
int      is_binop (const ir_node *node);
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
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);
594

595
596
597
/**
 * Projection numbers for Quot: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
598
599
typedef enum {
  pn_Quot_M,           /**< Memory result.    */
Michael Beck's avatar
Michael Beck committed
600
  pn_Quot_X_except,    /**< Execution result if exception occurred. */
601
602
  pn_Quot_res,         /**< Result of computation. */
  pn_Quot_max          /**< number of projections from a Quot */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
603
604
} pn_Quot;  /* Projection numbers for Quot. */

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

612
613
614
/**
 * Projection numbers for DivMod: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
615
616
typedef enum {
  pn_DivMod_M,           /**< Memory result.    */
Michael Beck's avatar
Michael Beck committed
617
  pn_DivMod_X_except,    /**< Execution result if exception occurred. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
618
  pn_DivMod_res_div,     /**< Result of computation a / b. */
619
620
  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
621
622
} pn_DivMod;  /* Projection numbers for DivMod. */

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

630
631
632
/**
 * Projection numbers for Div: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
633
634
typedef enum {
  pn_Div_M,           /**< Memory result.    */
Michael Beck's avatar
Michael Beck committed
635
  pn_Div_X_except,    /**< Execution result if exception occurred. */
Rubino Geiß's avatar
typo    
Rubino Geiß committed
636
  pn_Div_res,         /**< Result of computation. */
Rubino Geiß's avatar
Rubino Geiß committed
637
  pn_Div_max          /**< number of projections from a Div */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
638
639
} pn_Div;  /* Projection numbers for Div. */

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

647
648
649
/**
 * Projection numbers for Mod: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
650
651
typedef enum {
  pn_Mod_M,           /**< Memory result.    */
Michael Beck's avatar
Michael Beck committed
652
  pn_Mod_X_except,    /**< Execution result if exception occurred. */
653
654
  pn_Mod_res,         /**< Result of computation. */
  pn_Mod_max          /**< number of projections from a Mod */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
655
656
} pn_Mod;  /* Projection numbers for Mod. */

657
658
ir_node *get_Abs_op (ir_node *node);
void     set_Abs_op (ir_node *node, ir_node *op);
659

660
661
662
663
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);
664

665
666
667
668
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);
669

670
671
672
673
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);
674

675
676
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
677

678
679
/**
 * Projection numbers for Cmp are defined several times.
680
 * The bit patterns are used for various tests, so don't change.
681
682
 * The "unordered" values are possible results of comparing
 * floating point numbers.
Michael Beck's avatar
Michael Beck committed
683
 * Note that the encoding is imported, so do NOT change the order.
684
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
685
typedef enum {
Michael Beck's avatar
Michael Beck committed
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
  pn_Cmp_False = 0,                             /**< false */
  pn_Cmp_Eq    = 1,                             /**< equal */
  pn_Cmp_Lt    = 2,                             /**< less */
  pn_Cmp_Le    = pn_Cmp_Eq|pn_Cmp_Lt,           /**< less or equal */
  pn_Cmp_Gt    = 4,                             /**< greater */
  pn_Cmp_Ge    = pn_Cmp_Eq|pn_Cmp_Gt,           /**< greater or equal */
  pn_Cmp_Lg    = pn_Cmp_Lt|pn_Cmp_Gt,           /**< less or greater */
  pn_Cmp_Leg   = pn_Cmp_Lt|pn_Cmp_Eq|pn_Cmp_Gt, /**< less, equal or greater = ordered */
  pn_Cmp_Uo    = 8,                             /**< unordered */
  pn_Cmp_Ue    = pn_Cmp_Uo|pn_Cmp_Eq,           /**< unordered or equal */
  pn_Cmp_Ul    = pn_Cmp_Uo|pn_Cmp_Lt,           /**< unordered or less */
  pn_Cmp_Ule   = pn_Cmp_Uo|pn_Cmp_Eq|pn_Cmp_Lt, /**< unordered, less or equal */
  pn_Cmp_Ug    = pn_Cmp_Uo|pn_Cmp_Gt,           /**< unordered or greater */
  pn_Cmp_Uge   = pn_Cmp_Uo|pn_Cmp_Eq|pn_Cmp_Gt, /**< unordered, greater or equal */
  pn_Cmp_Ne    = pn_Cmp_Uo|pn_Cmp_Lt|pn_Cmp_Gt, /**< unordered, less or greater = not equal */
  pn_Cmp_True  = 15                             /**< true */
702
  /* not_mask = Leg*/   /* bits to flip to negate comparison * @@ hack for JNI interface */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
703
} pn_Cmp;   /* Projection numbers for Cmp */
704
/* #define not_mask pn_Cmp_Leg */
705

Michael Beck's avatar
Michael Beck committed
706
/** returns the pnc name from an pnc constant */
707
const char *get_pnc_string(int pnc);
Michael Beck's avatar
Michael Beck committed
708

709
/** Calculates the negated (Complement(R)) pnc condition. */
710
int         get_negated_pnc(int pnc, ir_mode *mode);
Michael Beck's avatar
Michael Beck committed
711

712
713
/** Calculates the inversed (R^-1) pnc condition, i.e., "<" --> ">" */
int         get_inversed_pnc(int pnc);
Michael Beck's avatar
Michael Beck committed
714

715
716
717
718
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);
719

720
721
722
723
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);
724

725
726
727
728
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);
729

730
731
732
733
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);
734

735
736
737
738
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);
739

740
741
ir_node *get_Conv_op (ir_node *node);
void     set_Conv_op (ir_node *node, ir_node *op);
742

Götz Lindenmaier's avatar
comment    
Götz Lindenmaier committed
743
744
/* Does Cast need a mem operator?
 * Cast should only depend on the type, not on the state of an
Michael Beck's avatar
Michael Beck committed
745
 * entity.  But:  we initialize various fields after Alloc, that
Götz Lindenmaier's avatar
comment    
Götz Lindenmaier committed
746
747
748
 * are accessed in the cast.  This required some precaution, to
 * get the right memory into the Loads generated from the cast.
 */
749
750
ir_node *get_Cast_op (ir_node *node);
void     set_Cast_op (ir_node *node, ir_node *op);
Michael Beck's avatar
Michael Beck committed
751
752
ir_type *get_Cast_type (ir_node *node);
void     set_Cast_type (ir_node *node, ir_type *to_tp);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
753

Götz Lindenmaier's avatar
Götz Lindenmaier committed
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
/** Checks for upcast.
 *
 * Returns true if the Cast node casts a class type to a super type.
 * Works also for pointers to classes (recursively).
 */
int is_Cast_upcast(ir_node *node);

/** Checks for downcast.
 *
 * Returns true if the Cast node casts a class type to a sub type.
 * Works also for pointers to classes (recursively).
 */
int is_Cast_downcast(ir_node *node);


Götz Lindenmaier's avatar
Götz Lindenmaier committed
769
770
771
/** 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. */
Sebastian Hack's avatar
Sebastian Hack committed
772
int       is_Phi (const ir_node *n);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
773
774
/** Returns true  if irg in phase building and the Phi has zero
   predecessors: it's a Phi0. */
Sebastian Hack's avatar
Sebastian Hack committed
775
int       is_Phi0 (const ir_node *n);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
776
/* These routines also work for Filter nodes in interprocedural view. */
777
778
779
780
781
782
783
784
785
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);
786
787
/* 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
788
789
790
791
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);
792

793
794
/** Return true if parameter is a memory operation.
 *
Götz Lindenmaier's avatar
Götz Lindenmaier committed
795
 *  A memory operation is an operation that changes the
796
797
798
799
800
801
802
803
 *  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);

804
805
806
/**
 * Projection numbers for Load: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
807
808
typedef enum {
  pn_Load_M,         /**< Memory result.    */
Michael Beck's avatar
Michael Beck committed
809
  pn_Load_X_except,  /**< Execution result if exception occurred. */
810
811
  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
812
813
} pn_Load;  /* Projection numbers for Load. */

814
815
816
817
818
819
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
820
821
ent_volatility get_Load_volatility (ir_node *node);
void           set_Load_volatility (ir_node *node, ent_volatility volatility);
822

823
824
825
/**
 * Projection numbers for Store: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
826
typedef enum {
Götz Lindenmaier's avatar
Götz Lindenmaier committed
827
  pn_Store_M,         /**< Memory result.    */
Michael Beck's avatar
Michael Beck committed
828
  pn_Store_X_except,  /**< Execution result if exception occurred. */
829
  pn_Store_max        /**< number of projections from a Store */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
830
831
} pn_Store;  /* Projection numbers for Store. */

832
833
834
835
836
837
838
839
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);
840

841
842
843
/**
 * Projection numbers for Alloc: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
844
typedef enum {
845
  pn_Alloc_M,         /**< Memory result. */
Michael Beck's avatar
Michael Beck committed
846
  pn_Alloc_X_except,  /**< Execution result if exception occurred. */
847
848
  pn_Alloc_res,       /**< Result of allocation. */
  pn_Alloc_max        /**< number of projections from an Alloc */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
849
850
} pn_Alloc;  /* Projection numbers for Alloc. */

851
852
853
854
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);
Michael Beck's avatar
Michael Beck committed
855
856
ir_type *get_Alloc_type (ir_node *node);
void     set_Alloc_type (ir_node *node, ir_type *tp);
Michael Beck's avatar
Michael Beck committed
857

858
/** The allocation place. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
859
typedef enum {
Michael Beck's avatar
Michael Beck committed
860
861
  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
862
} where_alloc;
Michael Beck's avatar
Michael Beck committed
863

864
865
866
867
868
869
870
871
872
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);
Michael Beck's avatar
Michael Beck committed
873
874
ir_type *get_Free_type (ir_node *node);
void     set_Free_type (ir_node *node, ir_type *tp);
875

876
877
878
where_alloc  get_Free_where (ir_node *node);
void         set_Free_where (ir_node *node, where_alloc where);

879
880
881
882
883
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);

884
885
886
/** Returns the source language type of a Proj node.
 * Must be an atomic type.  Mode of type must be mode of node.
 */
Michael Beck's avatar
Michael Beck committed
887
ir_type  *get_Proj_type (ir_node *node);
888
889

/** Return the predecessor of a Proj node. */
Sebastian Hack's avatar
Sebastian Hack committed
890
ir_node  *get_Proj_pred (const ir_node *node);
891
void      set_Proj_pred (ir_node *node, ir_node *pred);
892
/** Return the projection number of a Proj node. */
Sebastian Hack's avatar
Sebastian Hack committed
893
long      get_Proj_proj (const ir_node *node);
894
void      set_Proj_proj (ir_node *node, long proj);
895

896
897
898
899
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);
900

901
902
ir_node  *get_Id_pred (ir_node *node);
void      set_Id_pred (ir_node *node, ir_node *pred);
903

Götz Lindenmaier's avatar
Götz Lindenmaier committed
904
905
906
/** Confirm has a single result and returns 'value' unchanged.
 *  The node expresses a restriction on 'value':
 *  'value' 'cmp' 'bound' == true.                                 */
907
908
909
910
911
912
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
913

Michael Beck's avatar
Michael Beck committed
914
915
916
917
/*
 * Mux Support: Note that Psi nodes with one condition can be handled
 * like Mux nodes, and the access functions work as expected.
 */
918
919
920
921
922
923
924
ir_node *get_Mux_sel   (ir_node *node);
void     set_Mux_sel   (ir_node *node, ir_node *sel);
ir_node *get_Mux_false (ir_node *node);
void     set_Mux_false (ir_node *node, ir_node *ir_false);
ir_node *get_Mux_true  (ir_node *node);
void     set_Mux_true  (ir_node *node, ir_node *ir_true);

Michael Beck's avatar
Michael Beck committed
925
926
927
928
929
930
ir_node *get_Psi_cond   (ir_node *node, int pos);
void     set_Psi_cond   (ir_node *node, int pos, ir_node *cond);
ir_node *get_Psi_val    (ir_node *node, int pos);
void     set_Psi_val    (ir_node *node, int pos, ir_node *val);
ir_node *get_Psi_default(ir_node *node);
void     set_Psi_default(ir_node *node, ir_node *val);
Michael Beck's avatar
Michael Beck committed
931
int      get_Psi_n_conds(ir_node *node);
Michael Beck's avatar
Michael Beck committed
932

933
934
935
936
/**
 * Projection numbers for result of CopyB node: use for Proj nodes!
 */
typedef enum {
937
938
939
  pn_CopyB_M_regular = 0,  /**< The memory result. */
  pn_CopyB_X_except  = 1,  /**< The control flow result branching to the exception handler */
  pn_CopyB_M_except  = 2,  /**< The memory result in case the runtime function terminated with
940
                 an exception */
941
  pn_CopyB_max       = 3   /**< number of projections from a CopyB */
942
943
944
945
946
947
948
949
950
} pn_CopyB;   /* Projection numbers for CopyB. */
#define pn_CopyB_M pn_CopyB_M_regular

ir_node *get_CopyB_mem (ir_node *node);
void     set_CopyB_mem (ir_node *node, ir_node *mem);
ir_node *get_CopyB_dst (ir_node *node);
void     set_CopyB_dst (ir_node *node, ir_node *dst);
ir_node *get_CopyB_src (ir_node *node);
void     set_CopyB_src (ir_node *node, ir_node *src);
Michael Beck's avatar
Michael Beck committed
951
952
ir_type *get_CopyB_type(ir_node *node);
void     set_CopyB_type(ir_node *node, ir_type *data_type);
953

954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
/**
 * Projection numbers for result of InstOf node: use for Proj nodes!
 */
typedef enum {
  pn_InstOf_M_regular = 0,   /**< The memory result. */
  pn_InstOf_X_except = 1,    /**< The control flow result branching to the exception handler */
  pn_InstOf_res = 2,         /**< The checked object pointer. */
  pn_InstOf_M_except = 3,    /**< The memory result in case the runtime function terminated with
                                 an exception */
  pn_InstOf_max = 4          /**< number of projections from an InstOf */
} pn_InstOf;
#define pn_InstOf_M pn_InstOf_M_regular

/** InstOf access */
ir_type *get_InstOf_type (ir_node *node);
void    set_InstOf_type (ir_node *node, ir_type *type);
ir_node *get_InstOf_store (ir_node *node);
void    set_InstOf_store (ir_node *node, ir_node *obj);
ir_node *get_InstOf_obj (ir_node *node);
void    set_InstOf_obj (ir_node *node, ir_node *obj);

/**
 * Projection numbers for Raise.
 */
typedef enum {
979
980
981
  pn_Raise_X = 0,  /**< The control flow to the exception handler. */
  pn_Raise_M = 1,  /**< The Memory result. */
  pn_Raise_max     /**< number of projections from a Raise */
982
983
984
985
986
987
988
} pn_Raise;  /* Projection numbers for Raise. */

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);

Michael Beck's avatar
Michael Beck committed
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
/**
 * Projection numbers for result of Bound node: use for Proj nodes!
 */
typedef enum {
  pn_Bound_M_regular = 0,   /**< The memory result. */
  pn_Bound_X_except = 1,    /**< The control flow result branching to the exception handler */
  pn_Bound_res = 2,         /**< The checked index. */
  pn_Bound_M_except = 3,    /**< The memory result in case the runtime function terminated with
                                 an exception */
  pn_Bound_max = 4          /**< number of projections from a Bound */
} pn_Bound;
#define pn_Bound_M pn_Bound_M_regular

/** Returns the memory input of a Bound operation. */
ir_node *get_Bound_mem(ir_node *bound);
void     set_Bound_mem (ir_node *bound, ir_node *mem);

/** Returns the index input of a Bound operation. */
ir_node *get_Bound_index(ir_node *bound);
void     set_Bound_index(ir_node *bound, ir_node *idx);

/** Returns the lower bound input of a Bound operation. */
ir_node *get_Bound_lower(ir_node *bound);
void     set_Bound_lower(ir_node *bound, ir_node *lower);

/** Returns the upper bound input of a Bound operation. */
ir_node *get_Bound_upper(ir_node *bound);
void     set_Bound_upper(ir_node *bound, ir_node *upper);

Michael Beck's avatar
Michael Beck committed
1018
/*