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

15
16
#include <stddef.h>

Christian Schäfer's avatar
Christian Schäfer committed
17
# include "irgraph.h"
Christian Schäfer's avatar
Christian Schäfer committed
18
# include "entity.h"
19
# include "firm_common.h"
Christian Schäfer's avatar
Christian Schäfer committed
20
21
22
# include "irop.h"
# include "irmode.h"
# include "type.h"
23
# include "irextbb.h"
Götz Lindenmaier's avatar
Götz Lindenmaier committed
24
# 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

Michael Beck's avatar
Michael Beck committed
164
165
166
167
168
/** Returns the pinned state of a node. */
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
169

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

Götz Lindenmaier's avatar
Götz Lindenmaier committed
192
193
194
195
196
197
198
/** Return the block the node belongs to.
 *
 * 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
 * get_irn_block. */
Sebastian Hack's avatar
Sebastian Hack committed
199
ir_node  *get_nodes_block (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
200
201

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

Götz Lindenmaier's avatar
Götz Lindenmaier committed
204
/**
Michael Beck's avatar
Michael Beck committed
205
 * @function get_irn_block()
206
 * @see get_nodes_block()
Götz Lindenmaier's avatar
Götz Lindenmaier committed
207
 */
208
209
210
211
/**
 * Projection numbers for result of Start node: use for Proj nodes!
 */
typedef enum {
212
213
214
215
216
217
218
219
220
  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 */
221
222
} pn_Start; /* Projection numbers for Start. */

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

224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
/** Test whether arbitrary node is frame pointer.
 *
 * Test whether arbitrary node is frame pointer, i.e. Proj(pn_Start_P_frame_base)
 * from Start.  If so returns frame type, else Null. */
type *is_frame_pointer(ir_node *n);

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

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

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

243
/* @@@ no more supported  */
244
ir_node **get_Block_cfgpred_arr (ir_node *node);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
245
int       get_Block_n_cfgpreds (ir_node *node);
246
247
248
249
ir_node  *get_Block_cfgpred (ir_node *node, int pos);
void      set_Block_cfgpred (ir_node *node, int pos, ir_node *pred);
bool      get_Block_matured (ir_node *node);
void      set_Block_matured (ir_node *node, bool matured);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
250
251
252

/** A visited flag only for block nodes.
 *  @see also: get_irn_visited() inc_irg_visited() inc_irg_block_visited()*/
253
254
unsigned long get_Block_block_visited (ir_node *node);
void      set_Block_block_visited (ir_node *node, unsigned long visit);
255
256
257
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
258
/* For this current_ir_graph must be set. */
259
260
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
261

262
263
/* Set and remove interprocedural predecessors. If the interprocedural
 * predecessors are removed, the node has the same predecessors in
264
265
 * both views.
 * @@@ Maybe better:  arity is zero if no cg preds. */
266
267
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);
268
/* @@@ not supported */
269
ir_node **get_Block_cg_cfgpred_arr(ir_node * node);
Michael Beck's avatar
Michael Beck committed
270
/** Returns the number of interprocedural predecessors.  0 if none. */
271
int       get_Block_cg_n_cfgpreds(ir_node * node);
Michael Beck's avatar
Michael Beck committed
272
/** Return the interprocedural predecessor at position pos. */
273
ir_node  *get_Block_cg_cfgpred(ir_node * node, int pos);
274
/* frees the memory. */
275
276
void      remove_Block_cg_cfgpred_arr(ir_node * node);

277
278
279
280
281
/** 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
282
/** Return the number of Keep alive node. */
283
int  get_End_n_keepalives(ir_node *end);
Michael Beck's avatar
Michael Beck committed
284
285

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

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

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

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

299

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

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

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

341
342
343
344
345
346
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
347

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

353
354
355
/**
 * Projection numbers for Raise.
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
356
357
typedef enum {
  pn_Raise_X,    /**< Execution result. */
358
359
  pn_Raise_M,    /**< Memory result.    */
  pn_Raise_max   /**< number of projections from a Raise */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
360
361
} pn_Raise;  /* Projection numbers for Raise. */

Sebastian Hack's avatar
Sebastian Hack committed
362
typedef enum {
363
364
365
366
367
368
  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...). */
  CNST_OTHER    =  2, /**< The tarvel of the const has another value. */
  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
369
370
} cnst_classify_t;

371
372
tarval  *get_Const_tarval (ir_node *node);
void     set_Const_tarval (ir_node *node, tarval *con);
Michael Beck's avatar
Michael Beck committed
373

Sebastian Hack's avatar
Sebastian Hack committed
374
375
376
377
378
379
380
/**
 * 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
381
382
383
/** Returns the source language type of a Const node.
 * Must be an atomic type.  Mode of type must be mode of node.
 */
384
type    *get_Const_type   (ir_node *node);
Michael Beck's avatar
Michael Beck committed
385
386

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

Michael Beck's avatar
Michael Beck committed
389
/**  This enum names the three different kinds of symbolic Constants
Götz Lindenmaier's avatar
Götz Lindenmaier committed
390
391
392
393
     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
394
395
396
397
398
399
400
401
402
403
  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
404
} symconst_kind;
405

Beyhan's avatar
Beyhan committed
406
407
408
/** SymConst attributes
    This union contains the symbolic information represented by the node  */
union symconst_symbol {
409
410
411
  type   *type_p;
  ident  *ident_p;
  entity *entity_p;
Beyhan's avatar
Beyhan committed
412
};
413

Beyhan's avatar
Beyhan committed
414
415
typedef union symconst_symbol symconst_symbol;

416

Michael Beck's avatar
Michael Beck committed
417
/** Get the kind of the SymConst. */
418
symconst_kind get_SymConst_kind (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
419
/** Set the kind of the SymConst. */
420
void          set_SymConst_kind (ir_node *node, symconst_kind num);
Beyhan's avatar
Beyhan committed
421
422

/** Only to access SymConst of kind type_tag or size.  Else assertion: */
423
424
type    *get_SymConst_type (ir_node *node);
void     set_SymConst_type (ir_node *node, type *tp);
Beyhan's avatar
Beyhan committed
425
426
427
428
429
430
431
432
433
434
435

/** 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
436
437
438
439
/* 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);
440

Götz Lindenmaier's avatar
Götz Lindenmaier committed
441
442
443
444
445
446
/** Access the type of the value represented by the SymConst.
 *
 *  Example: primitive type int for SymConst size. */
type *get_SymConst_value_type (ir_node *node);
void  set_SymConst_value_type (ir_node *node, type *tp);

447
448
449
450
451
452
453
454
455
456
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
457

Michael Beck's avatar
Michael Beck committed
458
459
460
461
462
463
464
465
/** InstOf access */
type    *get_InstOf_ent (ir_node *node);
void    set_InstOf_ent (ir_node *node, type *ent);
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);

466
467
468
/**
 * Projection numbers for result of Call node: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
469
470
typedef enum {
  pn_Call_M_regular = 0,  /**< The memory result. */
471
  pn_Call_M         = 0,  /**< The memory result. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
472
473
  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
474
                 passed by value (for compound result types). */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
475
  pn_Call_X_except  = 1,  /**< The control flow result branching to the exception handler */
Michael Beck's avatar
Michael Beck committed
476
  pn_Call_M_except  = 3,  /**< The memory result in case the called method terminated with
Florian Liekweg's avatar
Florian Liekweg committed
477
                 an exception */
478
  pn_Call_max       = 5   /**< number of projections from a Call */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
479
480
} pn_Call;   /* Projection numbers for Call. */

481
482
483
484
485
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
486
/** Gets the number of parameters of a call. */
487
int      get_Call_n_params (ir_node *node);
Michael Beck's avatar
Michael Beck committed
488
/** Gets the call parameter at position pos. */
489
ir_node *get_Call_param (ir_node *node, int pos);
Michael Beck's avatar
Michael Beck committed
490
/** Sets the call parameter at position pos. */
491
void     set_Call_param (ir_node *node, int pos, ir_node *param);
Michael Beck's avatar
Michael Beck committed
492
/** Gets the type of a call. */
493
type    *get_Call_type (ir_node *node);
Michael Beck's avatar
Michael Beck committed
494
/** Sets the type of a call. */
495
void     set_Call_type (ir_node *node, type *tp);
Michael Beck's avatar
Michael Beck committed
496
/** Gets the arity of a call. Identical to get_Call_n_params(). */
497
int      get_Call_arity (ir_node *node);
498

499
500
501
502
/** 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
503
504
505
506
 *  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.
507
508
509
510
511
512
513
514
515
 *
 *  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
516
int     Call_has_callees      (ir_node *node);
517
518
int     get_Call_n_callees    (ir_node *node);
entity *get_Call_callee       (ir_node *node, int pos);
Michael Beck's avatar
Michael Beck committed
519

520
521
522
523
524
/** 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);
525

Götz Lindenmaier's avatar
Götz Lindenmaier committed
526
527
528
529
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);
530

Christian Schäfer's avatar
Christian Schäfer committed
531
532
533
/* 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
534
   unops are: Minus, Abs, Not, Conv, Cast
Christian Schäfer's avatar
Christian Schäfer committed
535
536
   binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
   Shr, Shrs, Rot, Cmp */
Michael Beck's avatar
Michael Beck committed
537
int      is_unop (const ir_node *node);
538
539
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
540
int      is_binop (const ir_node *node);
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
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);
570

571
572
573
/**
 * Projection numbers for Quot: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
574
575
typedef enum {
  pn_Quot_M,           /**< Memory result.    */
Michael Beck's avatar
Michael Beck committed
576
  pn_Quot_X_except,    /**< Execution result if exception occurred. */
577
578
  pn_Quot_res,         /**< Result of computation. */
  pn_Quot_max          /**< number of projections from a Quot */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
579
580
} pn_Quot;  /* Projection numbers for Quot. */

581
582
583
584
585
586
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);
587

588
589
590
/**
 * Projection numbers for DivMod: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
591
592
typedef enum {
  pn_DivMod_M,           /**< Memory result.    */
Michael Beck's avatar
Michael Beck committed
593
  pn_DivMod_X_except,    /**< Execution result if exception occurred. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
594
  pn_DivMod_res_div,     /**< Result of computation a / b. */
595
596
  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
597
598
} pn_DivMod;  /* Projection numbers for DivMod. */

599
600
601
602
603
604
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);
605

606
607
608
/**
 * Projection numbers for Div: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
609
610
typedef enum {
  pn_Div_M,           /**< Memory result.    */
Michael Beck's avatar
Michael Beck committed
611
  pn_Div_X_except,    /**< Execution result if exception occurred. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
612
613
614
  pn_Div_res          /**< Result of computation. */
} pn_Div;  /* Projection numbers for Div. */

615
616
617
618
619
620
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);
621

622
623
624
/**
 * Projection numbers for Mod: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
625
626
typedef enum {
  pn_Mod_M,           /**< Memory result.    */
Michael Beck's avatar
Michael Beck committed
627
  pn_Mod_X_except,    /**< Execution result if exception occurred. */
628
629
  pn_Mod_res,         /**< Result of computation. */
  pn_Mod_max          /**< number of projections from a Mod */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
630
631
} pn_Mod;  /* Projection numbers for Mod. */

632
633
ir_node *get_Abs_op (ir_node *node);
void     set_Abs_op (ir_node *node, ir_node *op);
634

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

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

645
646
647
648
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);
649

650
651
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
652

653
654
/**
 * Projection numbers for Cmp are defined several times.
655
 * The bit patterns are used for various tests, so don't change.
656
657
 * The "unordered" values are possible results of comparing
 * floating point numbers.
Michael Beck's avatar
Michael Beck committed
658
 * Note that the encoding is imported, so do NOT change the order.
659
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
660
typedef enum {
Michael Beck's avatar
Michael Beck committed
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
  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 */
Florian Liekweg's avatar
Florian Liekweg committed
677
  /* not_mask = Leg*/   /* bits to flip to negate comparison * @@ hack for jni interface */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
678
} pn_Cmp;   /* Projection numbers for Cmp */
679
/* #define not_mask pn_Cmp_Leg */
680

Michael Beck's avatar
Michael Beck committed
681
/** returns the pnc name from an pnc constant */
682
const char *get_pnc_string(int pnc);
Michael Beck's avatar
Michael Beck committed
683

684
/** Calculates the negated (Complement(R)) pnc condition. */
685
int         get_negated_pnc(int pnc);
Michael Beck's avatar
Michael Beck committed
686

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

690
691
692
693
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);
694

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

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

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

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

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

Götz Lindenmaier's avatar
comment    
Götz Lindenmaier committed
718
719
/* 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
720
 * entity.  But:  we initialize various fields after Alloc, that
Götz Lindenmaier's avatar
comment    
Götz Lindenmaier committed
721
722
723
 * are accessed in the cast.  This required some precaution, to
 * get the right memory into the Loads generated from the cast.
 */
724
725
726
727
ir_node *get_Cast_op (ir_node *node);
void     set_Cast_op (ir_node *node, ir_node *op);
type    *get_Cast_type (ir_node *node);
void     set_Cast_type (ir_node *node, type *to_tp);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
728

Götz Lindenmaier's avatar
Götz Lindenmaier committed
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
/** 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
744
745
746
/** 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
747
int       is_Phi (const ir_node *n);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
748
749
/** Returns true  if irg in phase building and the Phi has zero
   predecessors: it's a Phi0. */
Sebastian Hack's avatar
Sebastian Hack committed
750
int       is_Phi0 (const ir_node *n);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
751
/* These routines also work for Filter nodes in interprocedural view. */
752
753
754
755
756
757
758
759
760
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);
761
762
/* 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
763
764
765
766
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);
767

768
769
/** Return true if parameter is a memory operation.
 *
Götz Lindenmaier's avatar
Götz Lindenmaier committed
770
 *  A memory operation is an operation that changes the
771
772
773
774
775
776
777
778
 *  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);

779
780
781
/**
 * Projection numbers for Load: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
782
783
typedef enum {
  pn_Load_M,         /**< Memory result.    */
Michael Beck's avatar
Michael Beck committed
784
  pn_Load_X_except,  /**< Execution result if exception occurred. */
785
786
  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
787
788
} pn_Load;  /* Projection numbers for Load. */

789
790
791
792
793
794
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
795
796
ent_volatility get_Load_volatility (ir_node *node);
void           set_Load_volatility (ir_node *node, ent_volatility volatility);
797

798
799
800
/**
 * Projection numbers for Store: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
801
typedef enum {
Götz Lindenmaier's avatar
Götz Lindenmaier committed
802
  pn_Store_M,         /**< Memory result.    */
Michael Beck's avatar
Michael Beck committed
803
  pn_Store_X_except,  /**< Execution result if exception occurred. */
804
  pn_Store_max        /**< number of projections from a Store */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
805
806
} pn_Store;  /* Projection numbers for Store. */

807
808
809
810
811
812
813
814
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);
815

816
817
818
/**
 * Projection numbers for Alloc: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
819
typedef enum {
820
  pn_Alloc_M,          /**< Memory result. */
Michael Beck's avatar
Michael Beck committed
821
  pn_Alloc_X_except,  /**< Execution result if exception occurred. */
822
823
  pn_Alloc_res,       /**< Result of allocation. */
  pn_Alloc_max        /**< number of projections from an Alloc */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
824
825
} pn_Alloc;  /* Projection numbers for Alloc. */

826
827
828
829
830
831
ir_node *get_Alloc_mem (ir_node *node);
void     set_Alloc_mem (ir_node *node, ir_node *mem);
ir_node *get_Alloc_size (ir_node *node);
void     set_Alloc_size (ir_node *node, ir_node *size);
type    *get_Alloc_type (ir_node *node);
void     set_Alloc_type (ir_node *node, type *tp);
Michael Beck's avatar
Michael Beck committed
832

833
/** The allocation place. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
834
typedef enum {
Michael Beck's avatar
Michael Beck committed
835
836
  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
837
} where_alloc;
Michael Beck's avatar
Michael Beck committed
838

839
840
841
842
843
844
845
846
847
848
849
850
where_alloc  get_Alloc_where (ir_node *node);
void         set_Alloc_where (ir_node *node, where_alloc where);

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

851
852
853
where_alloc  get_Free_where (ir_node *node);
void         set_Free_where (ir_node *node, where_alloc where);

854
855
856
857
858
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);

859
860
861
862
863
864
/** Returns the source language type of a Proj node.
 * Must be an atomic type.  Mode of type must be mode of node.
 */
type     *get_Proj_type (ir_node *node);

/** Return the predecessor of a Proj node. */
Sebastian Hack's avatar
Sebastian Hack committed
865
ir_node  *get_Proj_pred (const ir_node *node);
866
void      set_Proj_pred (ir_node *node, ir_node *pred);
867
/** Return the projection number of a Proj node. */
Sebastian Hack's avatar
Sebastian Hack committed
868
long      get_Proj_proj (const ir_node *node);
869
void      set_Proj_proj (ir_node *node, long proj);
870

871
872
873
874
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);
875

876
877
ir_node  *get_Id_pred (ir_node *node);
void      set_Id_pred (ir_node *node, ir_node *pred);
878

Götz Lindenmaier's avatar
Götz Lindenmaier committed
879
880
881
/** Confirm has a single result and returns 'value' unchanged.
 *  The node expresses a restriction on 'value':
 *  'value' 'cmp' 'bound' == true.                                 */
882
883
884
885
886
887
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
888

889
890
891
892
893
894
895
896
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
897
/*
Götz Lindenmaier's avatar
Götz Lindenmaier committed
898
899
900
 *
 * NAME Auxiliary routines
 *
Sebastian Felis's avatar
Sebastian Felis committed
901
 *  Not properly documented ;-)
Götz Lindenmaier's avatar
Götz Lindenmaier committed
902
903
 *
 */
Christian Schäfer's avatar
Christian Schäfer committed
904

Michael Beck's avatar
Michael Beck committed
905
/** returns operand of node if node is a Proj. */
906
ir_node *skip_Proj (ir_node *node);
Michael Beck's avatar
Michael Beck committed
907
/** returns operand of node if node is a Id */
908
ir_node *skip_Id  (ir_node *node);   /* Same as skip_nop. */
909
910
/* returns corresponding operand of Tuple if node is a Proj from
   a Tuple. */
911
ir_node *skip_Tuple (ir_node *node);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
912
913
/** returns operand of node if node is a Cast */
ir_node *skip_Cast  (ir_node *node);
Michael Beck's avatar
Michael Beck committed
914
915
916
917
/** returns operand of node if node is a Confirm */
ir_node *skip_Confirm  (ir_node *node);
/** Skip all high-level Operations. */
ir_node *skip_HighLevel(ir_node *node);
Sebastian Hack's avatar
Sebastian Hack committed
918
919
/** returns true if irn is a Const node. */
int			 is_Const(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
920
/** returns true if node is a Bad node. */
Michael Beck's avatar
Michael Beck committed
921
int      is_Bad    (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
922
/** returns true if the node is not a Block */
Michael Beck's avatar
Michael Beck committed
923
int      is_no_Block (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
924
/** returns true if the node is a Block */
Michael Beck's avatar
Michael Beck committed
925
int      is_Block (const ir_node *node);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
926
/** returns true if node is a Unknown node. */
Michael Beck's avatar
Michael Beck committed
927
int      is_Unknown (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
928
/** returns true if node is a Proj node or a Filter node in
929
 * intraprocedural view */
930
int      is_Proj (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
931
/** Returns true if the operation manipulates control flow:
932
   Start, End, Jmp, Cond, Return, Raise, Bad, CallBegin, EndReg, EndExcept */
Michael Beck's avatar
Michael Beck committed
933
int is_cfop(const ir_node *node);
934

Michael Beck's avatar
Michael Beck committed
935
/** Returns true if the operation manipulates interprocedural control flow:
936
    CallBegin, EndReg, EndExcept */
Michael Beck's avatar
Michael Beck committed
937
int is_ip_cfop(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
938
/** Returns true if the operation can change the control flow because
939
    of an exception: Call, Quot, DivMod, Div, Mod, Load, Store, Alloc,
Götz Lindenmaier's avatar
Götz Lindenmaier committed
940
    Bad. Raise is not fragile, but a unconditional jump. */
Michael Beck's avatar
Michael Beck committed
941
int is_fragile_op(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
942
/** Returns the memory operand of fragile operations. */
943
ir_node *get_fragile_op_mem(ir_node *node);
Christian Schäfer's avatar
Christian Schäfer committed
944

Michael Beck's avatar
Michael Beck committed
945
946
/** Returns true if the operation is a forking control flow
 *  operation: Cond. */
Michael Beck's avatar
Michael Beck committed
947
int is_forking_op(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
948

949
950
951
952
953
/** Return the type associated with the value produced by n
 *  if the node remarks this type as it is the case for
 *  Cast, Const, SymConst and some Proj nodes. */
type *get_irn_type(ir_node *n);

954
955
956
957
958
959
/**
 * Access custom node data.
 * The data must have been registered with
 * register_additional_node_data() before.
 * @param node The ir node to get the data from.
 * @param type The type of the data you registered.
Sebastian Hack's avatar
Sebastian Hack committed
960
 * @param off The value returned by register_additional_node_data().
961
962
963
 * @return A pointer of type @p type.
 */
#define get_irn_data(node,type,off) \
Sebastian Hack's avatar
Sebastian Hack committed
964
965
966
967
968
969
970
971
972
973
  (assert(off > 0 && "Invalid node data offset"), (type *) ((char *) (node) - (off)))

/**
 * Get the pointer to the node some custom data belongs to.
 * @param data The pointer to the custom data.
 * @param off The number as returned by register_additional_node_data().
 * @return A pointer to the ir node the custom data belongs to.
 */
#define get_irn_data_base(data,off) \
  (assert(off > 0 && "Invalid node data offset"), (ir_node *) ((char *) (data) + (off)))
974
975
976
977

/**
 * Request additional data to be allocated with an ir node.
 * @param size The size of the additional data required.
Michael Beck's avatar
Michael Beck committed
978
 * @return A positive number, if the operation was successful, which
979
980
981
 * must be passed to the access macro get_irn_data(), 0 if the
 * registration failed.
 */
982