irnode.h 49.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
13
#ifndef _FIRM_IR_IRNODE_H_
#define _FIRM_IR_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

/**
 * Get the n-th predecessor of a node.
 * This function removes Id predecessors.
Michael Beck's avatar
Michael Beck committed
108
 * This function automatically handles intra- and interprocedural views.
109
 */
Sebastian Hack's avatar
Sebastian Hack committed
110
ir_node      *get_irn_n             (const ir_node *node, int n);
Michael Beck's avatar
Michael Beck committed
111
112
113
114
115

/**
 * Get the n-th predecessor of a node in intraprocedural view.
 * Can be used always if it's know that node is not a split one.
 */
Sebastian Hack's avatar
Sebastian Hack committed
116
ir_node      *get_irn_intra_n       (const ir_node *node, int n);
Michael Beck's avatar
Michael Beck committed
117
118
119
120

/**
 * Get the n-th predecessor of a node in interprocedural view.
 */
Sebastian Hack's avatar
Sebastian Hack committed
121
ir_node      *get_irn_inter_n       (const ir_node *node, int n);
122
123

/** Replace the n-th predecessor of a node with a new one. */
124
void          set_irn_n             (ir_node *node, int n, ir_node *in);
125
/* Sets the mode struct of node.  */
126
void          set_irn_mode (ir_node *node, ir_mode *mode);
127
/** Gets the mode struct of a node.  */
128
ir_mode      *get_irn_mode          (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
129
/** Gets the mode-enum modecode. */
130
modecode      get_irn_modecode      (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
131
/** Gets the ident for a string representation of the mode .*/
132
ident        *get_irn_modeident     (const ir_node *node);
133
/** Gets the string representation of the mode .*/
134
const char   *get_irn_modename      (const ir_node *node);
135
/** Gets the opcode struct of the node. */
136
ir_op        *get_irn_op            (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
137
/** Sets the opcode struct of the node. */
138
void          set_irn_op            (ir_node *node, ir_op *op);
Michael Beck's avatar
Michael Beck committed
139
/** Gets the opcode-enum of the node. */
140
opcode        get_irn_opcode        (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
141
/** Get the string representation of the opcode. */
142
const char   *get_irn_opname        (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
143
/** Get the ident for a string representation of the opcode. */
144
ident        *get_irn_opident       (const ir_node *node);
145
146
/** If arg is an argument of the node, returns it's position, -1 otherwise */
int           get_irn_pred_pos      (ir_node *node, ir_node *arg);
147
/** Gets the visited counter of a node. */
148
unsigned long get_irn_visited (const ir_node *node);
149
/** Sets the visited counter of a node. */
150
void          set_irn_visited (ir_node *node, unsigned long visited);
Michael Beck's avatar
Michael Beck committed
151
/** Sets visited to get_irg_visited(current_ir_graph). */
152
void          mark_irn_visited (ir_node *node);
153
/** Returns 1 if visited < get_irg_visited(current_ir_graph). */
154
int           irn_not_visited  (const ir_node *node);
155
/** Returns 1 if visited >= get_irg_visited(current_ir_graph). */
156
int           irn_visited      (const ir_node *node);
157
158
159
160
161

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

/** Returns the link of a node.  */
165
void         *get_irn_link     (const ir_node *node);
166
167

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

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

176
177
178
179
180
181
182
/** 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
183
184
185
186
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
187

188
189
190
191
192
193
194
195
/** 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
196
197
198
199
/**
 * irnode constructor.
 * Create a new irnode in irg, with an op, mode, arity and
 * some incoming irnodes.
200
201
202
203
 * 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
204
 * @param block The block the new node belongs to
205
206
207
208
 * @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
209
 */
210
ir_node *
Götz Lindenmaier's avatar
Götz Lindenmaier committed
211
new_ir_node (dbg_info *db,
Florian Liekweg's avatar
Florian Liekweg committed
212
213
214
215
216
217
         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
218

219
220
221
222
223
/**
 * 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
224
225
226
227
228
 *
 * 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
229
 * get_irn_block(). */
Sebastian Hack's avatar
Sebastian Hack committed
230
ir_node  *get_nodes_block (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
231
232

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

Götz Lindenmaier's avatar
Götz Lindenmaier committed
235
/**
Michael Beck's avatar
Michael Beck committed
236
 * @function get_irn_block()
237
 * @see get_nodes_block()
Götz Lindenmaier's avatar
Götz Lindenmaier committed
238
 */
239

240
241
242
243
/**
 * Projection numbers for result of Start node: use for Proj nodes!
 */
typedef enum {
244
245
246
247
248
249
250
251
252
  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 */
253
254
} pn_Start; /* Projection numbers for Start. */

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

256
257
258
259
/** 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
260
ir_type *is_frame_pointer(ir_node *n);
261
262
263
264
265

/** 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
266
ir_type *is_globals_pointer(ir_node *n);
267
268
269
270
271
272
273

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

275
/* @@@ no more supported  */
276
ir_node **get_Block_cfgpred_arr (ir_node *node);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
277
int       get_Block_n_cfgpreds (ir_node *node);
278
279
ir_node  *get_Block_cfgpred (ir_node *node, int pos);
void      set_Block_cfgpred (ir_node *node, int pos, ir_node *pred);
280
281
/** Get the predecessor block.
 *
282
 *  Returns the block corresponding to the predecessor pos of block.
283
284
285
286
287
288
289
290
291
 *
 *  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);
292
293
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
294
295
296

/** A visited flag only for block nodes.
 *  @see also: get_irn_visited() inc_irg_visited() inc_irg_block_visited()*/
297
298
unsigned long get_Block_block_visited (ir_node *node);
void      set_Block_block_visited (ir_node *node, unsigned long visit);
299
300
301
302
303

/**
 * Marks a block as dead but do not replace it with a Bad node.
 * Dead blocks are removed in the con
 */
304
305
306
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
307
/* For this current_ir_graph must be set. */
308
309
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
310

311
312
/* Set and remove interprocedural predecessors. If the interprocedural
 * predecessors are removed, the node has the same predecessors in
313
314
 * both views.
 * @@@ Maybe better:  arity is zero if no cg preds. */
315
316
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);
317
/* @@@ not supported */
318
ir_node **get_Block_cg_cfgpred_arr(ir_node * node);
Michael Beck's avatar
Michael Beck committed
319
/** Returns the number of interprocedural predecessors.  0 if none. */
320
int       get_Block_cg_n_cfgpreds(ir_node * node);
Michael Beck's avatar
Michael Beck committed
321
/** Return the interprocedural predecessor at position pos. */
322
ir_node  *get_Block_cg_cfgpred(ir_node * node, int pos);
323
/* frees the memory. */
324
325
void      remove_Block_cg_cfgpred_arr(ir_node * node);

326
327
328
329
330
/** 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
331
/** Return the number of Keep alive node. */
332
int  get_End_n_keepalives(ir_node *end);
Michael Beck's avatar
Michael Beck committed
333
334

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

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

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

343
344
345
/** Set new keep-alives */
void set_End_keepalives(ir_node *end, int n, ir_node *in[]);

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

351
352
353
354
355
/** 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);
356

357
358
359
360
361
362
363
364
/* 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.
365
   We differ two flavors of this Cond.  The first, the dense Cond, passes
366
367
   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.
368
   The second Cond flavor differences in the treatment of cases not specified in
369
370
371
372
373
   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.
374
375
   The two switch flavors are distinguished by a flag of type cond_kind.
   Default flavor is "dense"
376
377
*/
typedef enum {
Michael Beck's avatar
Michael Beck committed
378
379
  dense,        /**< Default. Missing Proj nodes are dead control flow. */
  fragmentary   /**< Special. No control flow optimizations allowed.  Missing
Florian Liekweg's avatar
Florian Liekweg committed
380
           Proj nodes mean default control flow, i.e., Proj(n). */
381
382
} cond_kind;

383
384
385
386
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);
387
long      get_Cond_defaultProj (ir_node *node);
Christian Schäfer's avatar
Christian Schäfer committed
388

389
390
391
/**
 * Projection numbers for conditions.
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
392
393
typedef enum {
  pn_Cond_false,    /**< Control flow if operand is "false". */
394
395
  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
396
397
} pn_Cond;  /* Projection numbers for Cond. */

398
399
400
401
402
403
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
404

Sebastian Hack's avatar
Sebastian Hack committed
405
typedef enum {
406
407
408
  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...). */
409
  CNST_OTHER    =  2, /**< The tarval of the const has another value. */
410
411
  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
412
413
} cnst_classify_t;

414
415
tarval  *get_Const_tarval (ir_node *node);
void     set_Const_tarval (ir_node *node, tarval *con);
Michael Beck's avatar
Michael Beck committed
416

Sebastian Hack's avatar
Sebastian Hack committed
417
418
419
420
421
422
423
/**
 * 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
424
425
426
/** 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
427
ir_type  *get_Const_type   (ir_node *node);
Michael Beck's avatar
Michael Beck committed
428
429

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

Michael Beck's avatar
Michael Beck committed
432
/**  This enum names the three different kinds of symbolic Constants
Götz Lindenmaier's avatar
Götz Lindenmaier committed
433
434
435
436
     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
437
438
439
440
441
442
443
444
445
446
  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
447
} symconst_kind;
448

Götz Lindenmaier's avatar
Götz Lindenmaier committed
449
450
451
/** SymConst attribute.
 *
 *  This union contains the symbolic information represented by the node.  */
Beyhan's avatar
Beyhan committed
452
union symconst_symbol {
Michael Beck's avatar
Michael Beck committed
453
454
455
  ir_type *type_p;
  ident   *ident_p;
  entity  *entity_p;
Beyhan's avatar
Beyhan committed
456
};
457

Beyhan's avatar
Beyhan committed
458
459
typedef union symconst_symbol symconst_symbol;

460

Michael Beck's avatar
Michael Beck committed
461
/** Get the kind of the SymConst. */
462
symconst_kind get_SymConst_kind (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
463
/** Set the kind of the SymConst. */
464
void          set_SymConst_kind (ir_node *node, symconst_kind num);
Beyhan's avatar
Beyhan committed
465
466

/** Only to access SymConst of kind type_tag or size.  Else assertion: */
Michael Beck's avatar
Michael Beck committed
467
468
ir_type  *get_SymConst_type (ir_node *node);
void     set_SymConst_type (ir_node *node, ir_type *tp);
Beyhan's avatar
Beyhan committed
469
470
471
472
473
474
475
476
477
478
479

/** 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
480
481
482
483
/* 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);
484

Götz Lindenmaier's avatar
Götz Lindenmaier committed
485
486
487
/** Access the type of the value represented by the SymConst.
 *
 *  Example: primitive type int for SymConst size. */
Michael Beck's avatar
Michael Beck committed
488
489
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
490

491
492
493
494
495
496
497
498
499
500
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
501

502
503
504
/**
 * Projection numbers for result of Call node: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
505
506
507
508
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
509
                 passed by value (for compound result types). */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
510
  pn_Call_X_except  = 1,  /**< The control flow result branching to the exception handler */
Michael Beck's avatar
Michael Beck committed
511
  pn_Call_M_except  = 3,  /**< The memory result in case the called method terminated with
Florian Liekweg's avatar
Florian Liekweg committed
512
                 an exception */
513
  pn_Call_max       = 5   /**< number of projections from a Call */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
514
} pn_Call;   /* Projection numbers for Call. */
515
#define pn_Call_M pn_Call_M_regular
Götz Lindenmaier's avatar
Götz Lindenmaier committed
516

517
518
519
520
521
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
522
/** Gets the number of parameters of a call. */
523
int      get_Call_n_params (ir_node *node);
Michael Beck's avatar
Michael Beck committed
524
/** Gets the call parameter at position pos. */
525
ir_node *get_Call_param (ir_node *node, int pos);
Michael Beck's avatar
Michael Beck committed
526
/** Sets the call parameter at position pos. */
527
void     set_Call_param (ir_node *node, int pos, ir_node *param);
Michael Beck's avatar
Michael Beck committed
528
/** Gets the type of a call. */
Michael Beck's avatar
Michael Beck committed
529
ir_type *get_Call_type (ir_node *node);
Michael Beck's avatar
Michael Beck committed
530
/** Sets the type of a call. */
Michael Beck's avatar
Michael Beck committed
531
void     set_Call_type (ir_node *node, ir_type *tp);
Michael Beck's avatar
Michael Beck committed
532
/** Gets the arity of a call. Identical to get_Call_n_params(). */
533
int      get_Call_arity (ir_node *node);
534

535
536
537
538
/** 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
539
540
541
542
 *  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.
543
544
545
546
547
548
549
550
551
 *
 *  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
552
int     Call_has_callees      (ir_node *node);
553
554
int     get_Call_n_callees    (ir_node *node);
entity *get_Call_callee       (ir_node *node, int pos);
Michael Beck's avatar
Michael Beck committed
555

556
557
558
559
560
/** 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);
561

Götz Lindenmaier's avatar
Götz Lindenmaier committed
562
563
564
565
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);
566

Christian Schäfer's avatar
Christian Schäfer committed
567
568
569
/* 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
570
   unops are: Minus, Abs, Not, Conv, Cast
Christian Schäfer's avatar
Christian Schäfer committed
571
572
   binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
   Shr, Shrs, Rot, Cmp */
Michael Beck's avatar
Michael Beck committed
573
int      is_unop (const ir_node *node);
574
575
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
576
int      is_binop (const ir_node *node);
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
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);
606

607
608
609
/**
 * Projection numbers for Quot: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
610
611
typedef enum {
  pn_Quot_M,           /**< Memory result.    */
Michael Beck's avatar
Michael Beck committed
612
  pn_Quot_X_except,    /**< Execution result if exception occurred. */
613
614
  pn_Quot_res,         /**< Result of computation. */
  pn_Quot_max          /**< number of projections from a Quot */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
615
616
} pn_Quot;  /* Projection numbers for Quot. */

617
618
619
620
621
622
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);
623

624
625
626
/**
 * Projection numbers for DivMod: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
627
628
typedef enum {
  pn_DivMod_M,           /**< Memory result.    */
Michael Beck's avatar
Michael Beck committed
629
  pn_DivMod_X_except,    /**< Execution result if exception occurred. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
630
  pn_DivMod_res_div,     /**< Result of computation a / b. */
631
632
  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
633
634
} pn_DivMod;  /* Projection numbers for DivMod. */

635
636
637
638
639
640
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);
641

642
643
644
/**
 * Projection numbers for Div: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
645
646
typedef enum {
  pn_Div_M,           /**< Memory result.    */
Michael Beck's avatar
Michael Beck committed
647
  pn_Div_X_except,    /**< Execution result if exception occurred. */
Rubino Geiß's avatar
typo    
Rubino Geiß committed
648
  pn_Div_res,         /**< Result of computation. */
Rubino Geiß's avatar
Rubino Geiß committed
649
  pn_Div_max          /**< number of projections from a Div */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
650
651
} pn_Div;  /* Projection numbers for Div. */

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

659
660
661
/**
 * Projection numbers for Mod: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
662
663
typedef enum {
  pn_Mod_M,           /**< Memory result.    */
Michael Beck's avatar
Michael Beck committed
664
  pn_Mod_X_except,    /**< Execution result if exception occurred. */
665
666
  pn_Mod_res,         /**< Result of computation. */
  pn_Mod_max          /**< number of projections from a Mod */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
667
668
} pn_Mod;  /* Projection numbers for Mod. */

669
670
ir_node *get_Abs_op (ir_node *node);
void     set_Abs_op (ir_node *node, ir_node *op);
671

672
673
674
675
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);
676

677
678
679
680
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);
681

682
683
684
685
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);
686

687
688
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
689

690
691
/**
 * Projection numbers for Cmp are defined several times.
692
 * The bit patterns are used for various tests, so don't change.
693
694
 * The "unordered" values are possible results of comparing
 * floating point numbers.
Michael Beck's avatar
Michael Beck committed
695
 * Note that the encoding is imported, so do NOT change the order.
696
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
697
typedef enum {
Michael Beck's avatar
Michael Beck committed
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
  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 */
714
  /* not_mask = Leg*/   /* bits to flip to negate comparison * @@ hack for JNI interface */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
715
} pn_Cmp;   /* Projection numbers for Cmp */
716
/* #define not_mask pn_Cmp_Leg */
717

Michael Beck's avatar
Michael Beck committed
718
/** returns the pnc name from an pnc constant */
719
const char *get_pnc_string(int pnc);
Michael Beck's avatar
Michael Beck committed
720

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

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

727
728
729
730
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);
731

732
733
734
735
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);
736

737
738
739
740
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);
741

742
743
744
745
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);
746

747
748
749
750
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);
751

752
753
ir_node *get_Conv_op (ir_node *node);
void     set_Conv_op (ir_node *node, ir_node *op);
754

Götz Lindenmaier's avatar
comment    
Götz Lindenmaier committed
755
756
/* 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
757
 * entity.  But:  we initialize various fields after Alloc, that
Götz Lindenmaier's avatar
comment    
Götz Lindenmaier committed
758
759
760
 * are accessed in the cast.  This required some precaution, to
 * get the right memory into the Loads generated from the cast.
 */
761
762
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
763
764
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
765

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

805
806
/** Return true if parameter is a memory operation.
 *
Götz Lindenmaier's avatar
Götz Lindenmaier committed
807
 *  A memory operation is an operation that changes the
808
809
810
811
812
813
814
815
 *  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);

816
817
818
/**
 * Projection numbers for Load: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
819
820
typedef enum {
  pn_Load_M,         /**< Memory result.    */
Michael Beck's avatar
Michael Beck committed
821
  pn_Load_X_except,  /**< Execution result if exception occurred. */
822
823
  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
824
825
} pn_Load;  /* Projection numbers for Load. */

826
827
828
829
830
831
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
832
833
ent_volatility get_Load_volatility (ir_node *node);
void           set_Load_volatility (ir_node *node, ent_volatility volatility);
834

835
836
837
/**
 * Projection numbers for Store: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
838
typedef enum {
Götz Lindenmaier's avatar
Götz Lindenmaier committed
839
  pn_Store_M,         /**< Memory result.    */
Michael Beck's avatar
Michael Beck committed
840
  pn_Store_X_except,  /**< Execution result if exception occurred. */
841
  pn_Store_max        /**< number of projections from a Store */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
842
843
} pn_Store;  /* Projection numbers for Store. */

844
845
846
847
848
849
850
851
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);
852

853
854
855
/**
 * Projection numbers for Alloc: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
856
typedef enum {
857
  pn_Alloc_M,         /**< Memory result. */
Michael Beck's avatar
Michael Beck committed
858
  pn_Alloc_X_except,  /**< Execution result if exception occurred. */
859
860
  pn_Alloc_res,       /**< Result of allocation. */
  pn_Alloc_max        /**< number of projections from an Alloc */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
861
862
} pn_Alloc;  /* Projection numbers for Alloc. */

863
864
865
866
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
867
868
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
869

870
/** The allocation place. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
871
typedef enum {
Michael Beck's avatar
Michael Beck committed
872
873
  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
874
} where_alloc;
Michael Beck's avatar
Michael Beck committed
875

876
877
878
879
880
881
882
883
884
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
885
886
ir_type *get_Free_type (ir_node *node);
void     set_Free_type (ir_node *node, ir_type *tp);
887

888
889
890
where_alloc  get_Free_where (ir_node *node);
void         set_Free_where (ir_node *node, where_alloc where);

891
892
893
894
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);
Michael Beck's avatar
Michael Beck committed
895
void      add_Sync_pred (ir_node *node, ir_node *pred);
896

897
898
899
/** 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
900
ir_type  *get_Proj_type (ir_node *node);
901
902

/** Return the predecessor of a Proj node. */
Sebastian Hack's avatar
Sebastian Hack committed
903
ir_node  *get_Proj_pred (const ir_node *node);
904
void      set_Proj_pred (ir_node *node, ir_node *pred);
905
/** Return the projection number of a Proj node. */
Sebastian Hack's avatar
Sebastian Hack committed
906
long      get_Proj_proj (const ir_node *node);
907
void      set_Proj_proj (ir_node *node, long proj);
908

909
910
911
912
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);
913

914
915
ir_node  *get_Id_pred (ir_node *node);
void      set_Id_pred (ir_node *node, ir_node *pred);
916

Götz Lindenmaier's avatar
Götz Lindenmaier committed
917
918
919
/** Confirm has a single result and returns 'value' unchanged.
 *  The node expresses a restriction on 'value':
 *  'value' 'cmp' 'bound' == true.                                 */
920
921
922
923
924
925
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
926

Michael Beck's avatar
Michael Beck committed
927
928
929
930
/*
 * Mux Support: Note that Psi nodes with one condition can be handled
 * like Mux nodes, and the access functions work as expected.
 */
931
932
933
934
935
936
937
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
938
939
940
941
942
943
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
944
int      get_Psi_n_conds(ir_node *node);
Michael Beck's avatar
Michael Beck committed
945

946
947
948
949
/**
 * Projection numbers for result of CopyB node: use for Proj nodes!
 */
typedef enum {
950
951
952
  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
953
                 an exception */
954
  pn_CopyB_max       = 3   /**< number of projections from a CopyB */
955
956
957
958
959
960
961
962
963
} 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
964
965
ir_type *get_CopyB_type(ir_node *node);
void     set_CopyB_type(ir_node *node, ir_type *data_type);
966

967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
/**
 * 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 {
992
993
994
  pn_Raise_X = 0,  /**< The control flow to the exception handler. */
  pn_Raise_M = 1,