irnode.h 53.6 KB
Newer Older
Götz Lindenmaier's avatar
Götz Lindenmaier committed
1
2
3
4
5
/*
 * Project:     libFIRM
 * File name:   ir/ir/irnode.h
 * Purpose:     Representation of an intermediate operation.
 * Author:      Martin Trapp, Christian Schaefer
6
 * Modified by: Goetz Lindenmaier, Michael Beck
Götz Lindenmaier's avatar
Götz Lindenmaier committed
7
8
 * Created:
 * CVS-ID:      $Id$
9
 * Copyright:   (c) 1998-2006 Universität Karlsruhe
Götz Lindenmaier's avatar
Götz Lindenmaier committed
10
 * 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
#include "firm_common.h"
Michael Beck's avatar
Michael Beck committed
18
#include "entity.h"
Michael Beck's avatar
Michael Beck committed
19
20
21
#include "irop.h"
#include "irmode.h"
#include "dbginfo.h"
Christian Schäfer's avatar
Christian Schäfer committed
22

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

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

Götz Lindenmaier's avatar
Götz Lindenmaier committed
56
57
#ifndef _IR_NODE_TYPEDEF_
#define _IR_NODE_TYPEDEF_
Christian Schäfer's avatar
Christian Schäfer committed
58
59
60
typedef struct ir_node ir_node;
#endif

Hannes Jakschitsch's avatar
Hannes Jakschitsch committed
61
#ifdef __cplusplus
Götz Lindenmaier's avatar
Götz Lindenmaier committed
62
extern "C" {
Hannes Jakschitsch's avatar
Hannes Jakschitsch committed
63
64
#endif

Sebastian Felis's avatar
Sebastian Felis committed
65
/**
Michael Beck's avatar
Michael Beck committed
66
67
68
 *   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
69

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

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

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

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

/**
 * Get the n-th predecessor of a node.
 * This function removes Id predecessors.
Michael Beck's avatar
Michael Beck committed
105
 * This function automatically handles intra- and interprocedural views.
106
 */
107
ir_node *get_irn_n(const ir_node *node, int n);
Michael Beck's avatar
Michael Beck committed
108

Sebastian Hack's avatar
Sebastian Hack committed
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
/**
* Add a artificial dependency to the node.
* The dependency is only inserted if it is not there already.
* @param node The node.
* @param dep  The dependency target.
* @return The index in the array (get_irn_dep() with that index returns @p dep).
*/
int add_irn_dep(ir_node *node, ir_node *dep);

/**
 * Copy all dependencies from a node to another.
 * @param tgt The node which sould be enriched.
 * @param src The node whose dependencies shall be copied.
 */
void add_irn_deps(ir_node *tgt, ir_node *src);

/**
* Get the length of the dependency array.
* @param node The node.
* @return The length of the dependency array or 0 if it has not yet been allocated.
*/
int get_irn_deps(const ir_node *node);

/**
* Get an entry of the dependency array.
* @param node The node.
* @param pos  The position.
* @return The node at that position.
*/
ir_node *get_irn_dep(const ir_node *node, int pos);

/**
* Set an entry of the dependency array.
* @param node The node.
* @param pos  The position.
* @param dep  The dependency target.
*/
void set_irn_dep(ir_node *node, int pos, ir_node *dep);


Michael Beck's avatar
Michael Beck committed
149
150
151
152
/**
 * 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.
 */
153
ir_node *get_irn_intra_n(const ir_node *node, int n);
Michael Beck's avatar
Michael Beck committed
154
155
156
157

/**
 * Get the n-th predecessor of a node in interprocedural view.
 */
158
ir_node *get_irn_inter_n(const ir_node *node, int n);
159
160

/** Replace the n-th predecessor of a node with a new one. */
161
void set_irn_n(ir_node *node, int n, ir_node *in);
162
/* Sets the mode struct of node.  */
163
void set_irn_mode(ir_node *node, ir_mode *mode);
164
/** Gets the mode struct of a node.  */
165
ir_mode *get_irn_mode(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
166
/** Gets the mode-enum modecode. */
167
modecode get_irn_modecode(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
168
/** Gets the ident for a string representation of the mode .*/
169
ident *get_irn_modeident(const ir_node *node);
170
/** Gets the string representation of the mode .*/
171
const char *get_irn_modename(const ir_node *node);
172
/** Gets the opcode struct of the node. */
173
ir_op *get_irn_op(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
174
/** Sets the opcode struct of the node. */
175
void set_irn_op(ir_node *node, ir_op *op);
Michael Beck's avatar
Michael Beck committed
176
/** Gets the opcode-enum of the node. */
177
opcode get_irn_opcode(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
178
/** Get the string representation of the opcode. */
179
const char *get_irn_opname(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
180
/** Get the ident for a string representation of the opcode. */
181
ident *get_irn_opident(const ir_node *node);
182
/** If arg is an argument of the node, returns it's position, -1 otherwise */
183
int get_irn_pred_pos(ir_node *node, ir_node *arg);
184
/** Gets the visited counter of a node. */
185
unsigned long get_irn_visited(const ir_node *node);
186
/** Sets the visited counter of a node. */
187
void set_irn_visited(ir_node *node, unsigned long visited);
Michael Beck's avatar
Michael Beck committed
188
/** Sets visited to get_irg_visited(current_ir_graph). */
189
void mark_irn_visited(ir_node *node);
190
/** Returns 1 if visited < get_irg_visited(current_ir_graph). */
191
int irn_not_visited(const ir_node *node);
192
/** Returns 1 if visited >= get_irg_visited(current_ir_graph). */
193
int irn_visited(const ir_node *node);
194
195
196
197
198

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

/** Returns the link of a node.  */
202
void *get_irn_link(const ir_node *node);
203
204

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

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

213
214
215
216
217
218
219
/** 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.
 */
220
op_pin_state get_irn_pinned(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
221
222
223

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

225
226
227
228
229
230
/** 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'.
 */
231
op_pin_state is_irn_pinned_in_irg(const ir_node *node);
232

Michael Beck's avatar
Michael Beck committed
233
/**
234
235
236
237
 * IR node constructor.
 * Create a new IR node in irg, with an op, mode, arity and
 * some incoming IR nodes.
 * This constructor is used in every specific IR node constructor.
238
239
240
 *
 * @param db    Debug info.
 * @param irg   IR-graph on with this new node should be constructed.
Michael Beck's avatar
Michael Beck committed
241
 * @param block The block the new node belongs to
242
243
 * @param op    The opcode of the new node.
 * @param mode  The mode of the new node.
244
 * @param arity The arity of the new node, <0 if can be changed dynamically.
245
 * @param in    An array of arity predecessor nodes.
Michael Beck's avatar
Michael Beck committed
246
 */
247
ir_node *
248
new_ir_node(dbg_info *db,
Florian Liekweg's avatar
Florian Liekweg committed
249
250
251
252
253
254
         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
255

256
257
258
259
260
/**
 * 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
261
262
263
264
265
 *
 * 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
266
 * get_irn_block(). */
Sebastian Hack's avatar
Sebastian Hack committed
267
ir_node  *get_nodes_block (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
268
269

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

Götz Lindenmaier's avatar
Götz Lindenmaier committed
272
/**
Michael Beck's avatar
Michael Beck committed
273
 * @function get_irn_block()
274
 * @see get_nodes_block()
Götz Lindenmaier's avatar
Götz Lindenmaier committed
275
 */
276

277
278
279
280
/**
 * Projection numbers for result of Start node: use for Proj nodes!
 */
typedef enum {
281
282
283
284
  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
285
286
287
288
                                  containing _all_ global entities.  Use for
                                  position independent data/code access. */
  pn_Start_P_tls,            /**< Projection on the pointer to the thread local store
                                  segment containing _all_thread local variables. */
289
290
291
292
  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 */
293
294
} pn_Start; /* Projection numbers for Start. */

295
296
297
298
/** 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
299
ir_type *is_frame_pointer(ir_node *n);
300
301
302
303
304

/** 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
305
ir_type *is_globals_pointer(ir_node *n);
306

307
308
309
310
311
312
/** Test whether arbitrary node is tls pointer.
 *
 * Test whether arbitrary node is tls pointer, i.e. Proj(pn_Start_P_tls)
 * from Start.  If so returns tls type, else Null. */
ir_type *is_tls_pointer(ir_node *n);

313
314
315
316
317
318
/** 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
319

320
/* @@@ no more supported  */
321
322
323
324
ir_node **get_Block_cfgpred_arr(ir_node *node);
int       get_Block_n_cfgpreds(const ir_node *node);
ir_node  *get_Block_cfgpred(ir_node *node, int pos);
void      set_Block_cfgpred(ir_node *node, int pos, ir_node *pred);
325
326
/** Get the predecessor block.
 *
327
 *  Returns the block corresponding to the predecessor pos of block.
328
329
330
331
332
333
334
335
336
 *
 *  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);
337
338
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
339
340
341

/** A visited flag only for block nodes.
 *  @see also: get_irn_visited() inc_irg_visited() inc_irg_block_visited()*/
342
343
unsigned long get_Block_block_visited(ir_node *node);
void      set_Block_block_visited(ir_node *node, unsigned long visit);
344
345
346
347
348

/**
 * Marks a block as dead but do not replace it with a Bad node.
 * Dead blocks are removed in the con
 */
349
350
351
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
352
/* For this current_ir_graph must be set. */
353
354
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
355

356
357
/* Set and remove interprocedural predecessors. If the interprocedural
 * predecessors are removed, the node has the same predecessors in
358
359
 * both views.
 * @@@ Maybe better:  arity is zero if no cg preds. */
360
361
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);
362
/* @@@ not supported */
363
ir_node **get_Block_cg_cfgpred_arr(ir_node * node);
Michael Beck's avatar
Michael Beck committed
364
/** Returns the number of interprocedural predecessors.  0 if none. */
365
int       get_Block_cg_n_cfgpreds(ir_node * node);
Michael Beck's avatar
Michael Beck committed
366
/** Return the interprocedural predecessor at position pos. */
367
ir_node  *get_Block_cg_cfgpred(ir_node * node, int pos);
368
/* frees the memory. */
369
370
void      remove_Block_cg_cfgpred_arr(ir_node * node);

371
372
373
374
375
/** 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
376
/** Return the number of Keep alive node. */
377
int  get_End_n_keepalives(ir_node *end);
Michael Beck's avatar
Michael Beck committed
378
379

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

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

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

388
389
390
/** Set new keep-alives */
void set_End_keepalives(ir_node *end, int n, ir_node *in[]);

391
392
393
/* Set new keep-alives from old keep-alives, skipping irn */
void remove_End_keepalive(ir_node *end, ir_node *irn);

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

399
400
401
402
403
/** 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);
404

405
406
407
408
409
410
411
412
/* 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.
413
   We differ two flavors of this Cond.  The first, the dense Cond, passes
414
415
   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.
416
   The second Cond flavor differences in the treatment of cases not specified in
417
418
419
420
421
   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.
422
423
   The two switch flavors are distinguished by a flag of type cond_kind.
   Default flavor is "dense"
424
425
*/
typedef enum {
Michael Beck's avatar
Michael Beck committed
426
427
  dense,        /**< Default. Missing Proj nodes are dead control flow. */
  fragmentary   /**< Special. No control flow optimizations allowed.  Missing
Florian Liekweg's avatar
Florian Liekweg committed
428
           Proj nodes mean default control flow, i.e., Proj(n). */
429
430
} cond_kind;

431
432
433
434
435
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);
long      get_Cond_defaultProj(ir_node *node);
Christian Schäfer's avatar
Christian Schäfer committed
436

437
438
439
/**
 * Projection numbers for conditions.
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
440
441
typedef enum {
  pn_Cond_false,    /**< Control flow if operand is "false". */
442
443
  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
444
445
} pn_Cond;  /* Projection numbers for Cond. */

446
447
448
449
450
451
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
452

Sebastian Hack's avatar
Sebastian Hack committed
453
typedef enum {
454
455
456
  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...). */
457
  CNST_OTHER    =  2, /**< The tarval of the const has another value. */
458
459
  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
460
461
} cnst_classify_t;

462
463
tarval  *get_Const_tarval(ir_node *node);
void     set_Const_tarval(ir_node *node, tarval *con);
Michael Beck's avatar
Michael Beck committed
464

Sebastian Hack's avatar
Sebastian Hack committed
465
466
467
468
469
470
471
/**
 * 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
472
473
474
/** Returns the source language type of a Const node.
 * Must be an atomic type.  Mode of type must be mode of node.
 */
475
ir_type  *get_Const_type(ir_node *node);
Michael Beck's avatar
Michael Beck committed
476
477

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

Michael Beck's avatar
Michael Beck committed
480
/**  This enum names the three different kinds of symbolic Constants
Götz Lindenmaier's avatar
Götz Lindenmaier committed
481
482
483
484
     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
485
  symconst_type_tag,    /**< The SymConst is a type tag for the given type.
486
                             symconst_symbol is type *. */
487
  symconst_type_size,   /**< The SymConst is the size of the given type.
488
                             symconst_symbol is type *. */
489
  symconst_type_align,  /**< The SymConst is the alignment of the given type.
490
                             symconst_symbol is type *. */
Beyhan's avatar
Beyhan committed
491
  symconst_addr_name,   /**< The SymConst is a symbolic pointer to be filled in
492
493
                             by the linker.  The pointer is represented by a string.
                             symconst_symbol is ident *. */
494
  symconst_addr_ent,    /**< The SymConst is a symbolic pointer to be filled in
495
496
                             by the linker.  The pointer is represented by an entity.
                             symconst_symbol is entity *. */
497
498
  symconst_ofs_ent,     /**< The SymConst is the offset of its entity in the entities
                             owner type. */
499
  symconst_enum_const   /**< The SymConst is a enumeration constant of an
500
                             enumeration type. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
501
} symconst_kind;
502

503
504
505
506
507
508
509
/** Returns non-zero if s symconst kind has a type attribute */
#define SYMCONST_HAS_TYPE(kind) ((kind) <= symconst_type_align)

/** Returns non-zero if s symconst kind has an ident attribute */
#define SYMCONST_HAS_ID(kind) ((kind) == symconst_addr_name)

/** Returns non-zero if s symconst kind has an entity attribute */
510
#define SYMCONST_HAS_ENT(kind) ((kind) == symconst_addr_ent || (kind) == symconst_ofs_ent)
511

512
513
514
/** Returns non-zero if s symconst kind has an enum_const attribute */
#define SYMCONST_HAS_ENUM(kind) ((kind) == symconst_enum_const)

Götz Lindenmaier's avatar
Götz Lindenmaier committed
515
516
/** SymConst attribute.
 *
517
518
 *  This union contains the symbolic information represented by the node.
 */
519
typedef union symconst_symbol {
520
521
  ir_type       *type_p;    /**< the type of a symconst */
  ident         *ident_p;   /**< the ident of a symconst */
522
  ir_entity     *entity_p;  /**< the entity of a symconst */
523
  ir_enum_const *enum_p;    /**< the enumeration constant of a symconst */
524
} symconst_symbol;
525

Michael Beck's avatar
Michael Beck committed
526
/** Get the kind of the SymConst. */
527
symconst_kind get_SymConst_kind(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
528
/** Set the kind of the SymConst. */
529
void          set_SymConst_kind(ir_node *node, symconst_kind num);
Beyhan's avatar
Beyhan committed
530
531

/** Only to access SymConst of kind type_tag or size.  Else assertion: */
532
533
ir_type  *get_SymConst_type(ir_node *node);
void     set_SymConst_type(ir_node *node, ir_type *tp);
Beyhan's avatar
Beyhan committed
534
535

/** Only to access SymConst of kind addr_name.  Else assertion: */
536
537
ident   *get_SymConst_name(ir_node *node);
void     set_SymConst_name(ir_node *node, ident *name);
Beyhan's avatar
Beyhan committed
538
539

/** Only to access SymConst of kind addr_ent.  Else assertion: */
540
541
ir_entity *get_SymConst_entity(ir_node *node);
void       set_SymConst_entity(ir_node *node, ir_entity *ent);
Beyhan's avatar
Beyhan committed
542

543
/** Only to access SymConst of kind symconst_enum_const.  Else assertion: */
544
545
ir_enum_const *get_SymConst_enum(ir_node *node);
void           set_SymConst_enum(ir_node *node, ir_enum_const *ec);
546

Beyhan's avatar
Beyhan committed
547
548
/** 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
549
/* write 'union': firmjni then does not create a method... */
550
551
552
union symconst_symbol get_SymConst_symbol(ir_node *node);
void                  set_SymConst_symbol(ir_node *node,
                                          union symconst_symbol sym);
553

Götz Lindenmaier's avatar
Götz Lindenmaier committed
554
555
556
/** Access the type of the value represented by the SymConst.
 *
 *  Example: primitive type int for SymConst size. */
557
558
559
ir_type *get_SymConst_value_type(ir_node *node);
void    set_SymConst_value_type(ir_node *node, ir_type *tp);

560
561
562
563
564
565
566
567
568
569
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);
ir_entity *get_Sel_entity(ir_node *node); /* entity to select */
void       set_Sel_entity (ir_node *node, ir_entity *ent);
Christian Schäfer's avatar
Christian Schäfer committed
570

571
572
573
/**
 * Projection numbers for result of Call node: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
574
typedef enum {
575
576
  pn_Call_M_regular = 0,       /**< The memory result. */
  pn_Call_T_result  = 2,       /**< The tuple containing all (0, 1, 2, ...) results */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
577
  pn_Call_P_value_res_base = 4,/**< A pointer to the memory region containing copied results
578
579
580
581
582
                                    passed by value (for compound result types). */
  pn_Call_X_except  = 1,       /**< The control flow result branching to the exception handler */
  pn_Call_M_except  = 3,       /**< The memory result in case the called method terminated with
                                    an exception */
  pn_Call_max       = 5        /**< number of projections from a Call */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
583
} pn_Call;   /* Projection numbers for Call. */
584
#define pn_Call_M pn_Call_M_regular
Götz Lindenmaier's avatar
Götz Lindenmaier committed
585

586
587
588
589
590
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
591
/** Gets the number of parameters of a call. */
592
int      get_Call_n_params(ir_node *node);
Michael Beck's avatar
Michael Beck committed
593
/** Gets the call parameter at position pos. */
594
ir_node *get_Call_param(ir_node *node, int pos);
Michael Beck's avatar
Michael Beck committed
595
/** Sets the call parameter at position pos. */
596
void     set_Call_param(ir_node *node, int pos, ir_node *param);
Michael Beck's avatar
Michael Beck committed
597
/** Gets the type of a call. */
598
ir_type *get_Call_type(ir_node *node);
Michael Beck's avatar
Michael Beck committed
599
/** Sets the type of a call. */
600
void     set_Call_type(ir_node *node, ir_type *tp);
Michael Beck's avatar
Michael Beck committed
601
/** Gets the arity of a call. Identical to get_Call_n_params(). */
602
int      get_Call_arity(ir_node *node);
603

604
605
606
607
/** 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
608
609
610
611
 *  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.
612
613
614
615
616
617
618
619
620
 *
 *  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.
 */
621
622
623
int        Call_has_callees(ir_node *node);
int        get_Call_n_callees(ir_node *node);
ir_entity *get_Call_callee(ir_node *node, int pos);
Michael Beck's avatar
Michael Beck committed
624

625
626
627
/** Set the full callee array.
 *
 *  The passed array is copied. Assumes current_ir_graph set properly! */
628
void    set_Call_callee_arr(ir_node *node, const int n, ir_entity **arr);
629
void    remove_Call_callee_arr(ir_node *node);
630

631
632
633
634
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);
635

Christian Schäfer's avatar
Christian Schäfer committed
636
637
638
/* 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
639
   unops are: Minus, Abs, Not, Conv, Cast
Christian Schäfer's avatar
Christian Schäfer committed
640
641
   binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
   Shr, Shrs, Rot, Cmp */
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
int      is_unop(const ir_node *node);
ir_node *get_unop_op(ir_node *node);
void     set_unop_op(ir_node *node, ir_node *op);
int      is_binop(const ir_node *node);
ir_node *get_binop_left(ir_node *node);
void     set_binop_left(ir_node *node, ir_node *left);
ir_node *get_binop_right(ir_node *node);
void     set_binop_right(ir_node *node, ir_node *right);

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

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

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

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

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

676
677
678
/**
 * Projection numbers for Quot: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
679
680
typedef enum {
  pn_Quot_M,           /**< Memory result.    */
Michael Beck's avatar
Michael Beck committed
681
  pn_Quot_X_except,    /**< Execution result if exception occurred. */
682
683
  pn_Quot_res,         /**< Result of computation. */
  pn_Quot_max          /**< number of projections from a Quot */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
684
685
} pn_Quot;  /* Projection numbers for Quot. */

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

693
694
695
/**
 * Projection numbers for DivMod: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
696
697
typedef enum {
  pn_DivMod_M,           /**< Memory result.    */
Michael Beck's avatar
Michael Beck committed
698
  pn_DivMod_X_except,    /**< Execution result if exception occurred. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
699
  pn_DivMod_res_div,     /**< Result of computation a / b. */
700
701
  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
702
703
} pn_DivMod;  /* Projection numbers for DivMod. */

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

711
712
713
/**
 * Projection numbers for Div: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
714
715
typedef enum {
  pn_Div_M,           /**< Memory result.    */
Michael Beck's avatar
Michael Beck committed
716
  pn_Div_X_except,    /**< Execution result if exception occurred. */
Rubino Geiß's avatar
typo    
Rubino Geiß committed
717
  pn_Div_res,         /**< Result of computation. */
Rubino Geiß's avatar
Rubino Geiß committed
718
  pn_Div_max          /**< number of projections from a Div */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
719
720
} pn_Div;  /* Projection numbers for Div. */

721
722
723
724
725
726
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);
727

728
729
730
/**
 * Projection numbers for Mod: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
731
732
typedef enum {
  pn_Mod_M,           /**< Memory result.    */
Michael Beck's avatar
Michael Beck committed
733
  pn_Mod_X_except,    /**< Execution result if exception occurred. */
734
735
  pn_Mod_res,         /**< Result of computation. */
  pn_Mod_max          /**< number of projections from a Mod */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
736
737
} pn_Mod;  /* Projection numbers for Mod. */

738
739
ir_node *get_Abs_op(ir_node *node);
void     set_Abs_op(ir_node *node, ir_node *op);
740

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

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

751
752
753
754
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);
755

756
757
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
758

759
760
/**
 * Projection numbers for Cmp are defined several times.
761
 * The bit patterns are used for various tests, so don't change.
762
763
 * The "unordered" values are possible results of comparing
 * floating point numbers.
Michael Beck's avatar
Michael Beck committed
764
 * Note that the encoding is imported, so do NOT change the order.
765
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
766
typedef enum {
Michael Beck's avatar
Michael Beck committed
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
  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 */
783
  /* not_mask = Leg*/   /* bits to flip to negate comparison * @@ hack for JNI interface */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
784
} pn_Cmp;   /* Projection numbers for Cmp */
785
/* #define not_mask pn_Cmp_Leg */
786

Michael Beck's avatar
Michael Beck committed
787
/** returns the pnc name from an pnc constant */
788
const char *get_pnc_string(int pnc);
Michael Beck's avatar
Michael Beck committed
789

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

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

796
797
798
799
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);
800

801
802
803
804
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);
805

806
807
808
809
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);
810

811
812
813
814
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);
815

816
817
818
819
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);
820

821
822
823
824
ir_node *get_Conv_op(ir_node *node);
void     set_Conv_op(ir_node *node, ir_node *op);
int      get_Conv_strict(ir_node *node);
void     set_Conv_strict(ir_node *node, int flag);
825

Götz Lindenmaier's avatar
comment    
Götz Lindenmaier committed
826
827
/* 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
828
 * entity.  But:  we initialize various fields after Alloc, that
Götz Lindenmaier's avatar
comment    
Götz Lindenmaier committed
829
830
831
 * are accessed in the cast.  This required some precaution, to
 * get the right memory into the Loads generated from the cast.
 */
832
833
834
835
ir_node *get_Cast_op(ir_node *node);
void     set_Cast_op(ir_node *node, ir_node *op);
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
836

Götz Lindenmaier's avatar
Götz Lindenmaier committed
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
/** 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
852
853
854
/** 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. */
855
int       is_Phi(const ir_node *n);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
856
857
/** Returns true  if irg in phase building and the Phi has zero
   predecessors: it's a Phi0. */
858
int       is_Phi0(const ir_node *n);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
859
/* These routines also work for Filter nodes in interprocedural view. */
860
861
862
863
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);
864
865
866
867
868

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);
869
870
/* 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
871
872
873
874
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);
875

876
877
/** Return true if parameter is a memory operation.
 *
Götz Lindenmaier's avatar
Götz Lindenmaier committed
878
 *  A memory operation is an operation that changes the
879
880
881
 *  memory.  I.e., a Load or a Store operation.
 */
int is_memop(ir_node *node);
882
883
884
885
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);
886

887
888
889
/**
 * Projection numbers for Load: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
890
891
typedef enum {
  pn_Load_M,         /**< Memory result.    */
Michael Beck's avatar
Michael Beck committed
892
  pn_Load_X_except,  /**< Execution result if exception occurred. */
893
894
  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
895
896
} pn_Load;  /* Projection numbers for Load. */

897
898
899
900
901
902
903
904
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);
ir_volatility  get_Load_volatility(ir_node *node);
void           set_Load_volatility(ir_node *node, ir_volatility volatility);
905

906
907
908
/**
 * Projection numbers for Store: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
909
typedef enum {
Götz Lindenmaier's avatar
Götz Lindenmaier committed
910
  pn_Store_M,         /**< Memory result.    */
Michael Beck's avatar
Michael Beck committed
911
  pn_Store_X_except,  /**< Execution result if exception occurred. */
912
  pn_Store_max        /**< number of projections from a Store */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
913
914
} pn_Store;  /* Projection numbers for Store. */

915
916
917
918
919
920
921
922
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);
ir_volatility  get_Store_volatility(ir_node *node);
void           set_Store_volatility(ir_node *node, ir_volatility volatility);
923

924
925
926
/**
 * Projection numbers for Alloc: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
927
typedef enum {
928
  pn_Alloc_M,         /**< Memory result. */
Michael Beck's avatar
Michael Beck committed
929
  pn_Alloc_X_except,  /**< Execution result if exception occurred. */
930
931
  pn_Alloc_res,       /**< Result of allocation. */
  pn_Alloc_max        /**< number of projections from an Alloc */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
932
933
} pn_Alloc;  /* Projection numbers for Alloc. */

934
935
936
937
938
939
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);
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
940

941
/** The allocation place. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
942
typedef enum {
Michael Beck's avatar
Michael Beck committed
943
944
  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
945
} where_alloc;
Michael Beck's avatar
Michael Beck committed
946

947
948
where_alloc  get_Alloc_where(ir_node *node);
void         set_Alloc_where(ir_node *node, where_alloc where);
949

950
951
952
953
954
955
956
957
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);
ir_type *get_Free_type(ir_node *node);
void     set_Free_type(ir_node *node, ir_type *tp);
958

959
960
where_alloc  get_Free_where(ir_node *node);
void         set_Free_where(ir_node *node, where_alloc where);
961

962
963
964
965
966
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);
void      add_Sync_pred(ir_node *node, ir_node *pred);
967

968
969
970