irnode.h 54.8 KB
Newer Older
Christian Würdig's avatar
Christian Würdig committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
/*
 * Copyright (C) 1995-2007 University of Karlsruhe.  All right reserved.
 *
 * This file is part of libFirm.
 *
 * This file may be distributed and/or modified under the terms of the
 * GNU General Public License version 2 as published by the Free Software
 * Foundation and appearing in the file LICENSE.GPL included in the
 * packaging of this file.
 *
 * Licensees holding valid libFirm Professional Edition licenses may use
 * this file in accordance with the libFirm Commercial License.
 * Agreement provided with the Software.
 *
 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE.
 */

Götz Lindenmaier's avatar
Götz Lindenmaier committed
20
21
22
23
24
/*
 * Project:     libFIRM
 * File name:   ir/ir/irnode.h
 * Purpose:     Representation of an intermediate operation.
 * Author:      Martin Trapp, Christian Schaefer
25
 * Modified by: Goetz Lindenmaier, Michael Beck
Götz Lindenmaier's avatar
Götz Lindenmaier committed
26
27
 * Created:
 * CVS-ID:      $Id$
28
 * Copyright:   (c) 1998-2006 Universität Karlsruhe
Michael Beck's avatar
Michael Beck committed
29
 */
30
31
#ifndef _FIRM_IR_IRNODE_H_
#define _FIRM_IR_IRNODE_H_
Christian Schäfer's avatar
Christian Schäfer committed
32

33
34
#include <stddef.h>

Michael Beck's avatar
Michael Beck committed
35
#include "firm_common.h"
Michael Beck's avatar
Michael Beck committed
36
#include "entity.h"
Michael Beck's avatar
Michael Beck committed
37
38
39
#include "irop.h"
#include "irmode.h"
#include "dbginfo.h"
Christian Schäfer's avatar
Christian Schäfer committed
40

Michael Beck's avatar
Michael Beck committed
41
42
/**
 * @file irnode.h
Götz Lindenmaier's avatar
Götz Lindenmaier committed
43
 *
Michael Beck's avatar
Michael Beck committed
44
 * @author Martin Trapp, Christian Schaefer
Götz Lindenmaier's avatar
Götz Lindenmaier committed
45
 *
Michael Beck's avatar
Michael Beck committed
46
47
48
49
50
51
 * Declarations of an ir node.
 */

/**
 * @defgroup ir_node Declarations of an ir node.
 *
52
 * The type definition of ir_node is also in irgraph.h to resolve
Michael Beck's avatar
Michael Beck committed
53
 *  recursion between irnode.h and irgraph.h
Götz Lindenmaier's avatar
Götz Lindenmaier committed
54
 *
Michael Beck's avatar
Michael Beck committed
55
 * ir_node - a datatype representing a Firm node
Götz Lindenmaier's avatar
Götz Lindenmaier committed
56
 *
Michael Beck's avatar
Michael Beck committed
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 *  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
72
 */
Michael Beck's avatar
Michael Beck committed
73

Götz Lindenmaier's avatar
Götz Lindenmaier committed
74
75
#ifndef _IR_NODE_TYPEDEF_
#define _IR_NODE_TYPEDEF_
Christian Schäfer's avatar
Christian Schäfer committed
76
77
78
typedef struct ir_node ir_node;
#endif

Hannes Jakschitsch's avatar
Hannes Jakschitsch committed
79
#ifdef __cplusplus
Götz Lindenmaier's avatar
Götz Lindenmaier committed
80
extern "C" {
Hannes Jakschitsch's avatar
Hannes Jakschitsch committed
81
82
#endif

Sebastian Felis's avatar
Sebastian Felis committed
83
/**
Michael Beck's avatar
Michael Beck committed
84
85
86
 *   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
87

Sebastian Felis's avatar
Sebastian Felis committed
88
89
90
/**
 *   Checks whether a pointer points to a ir node.
 *
91
92
 *   @param thing   an arbitrary pointer
 *   @return        non-zero if the thing is a ir mode, else zero
Sebastian Felis's avatar
Sebastian Felis committed
93
 */
94
int is_ir_node (const void *thing);
Sebastian Felis's avatar
Sebastian Felis committed
95

96
97
98
99
100
/**
 * Returns the number of predecessors without the block predecessor.
 *
 * @param node   the IR-node
 */
101
102
103
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
104
105

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

Christian Schäfer's avatar
Christian Schäfer committed
113
114
115
/* 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
116
   to iterate including the Block predecessor iterate from i = -1 to
Christian Schäfer's avatar
Christian Schäfer committed
117
   i < get_irn_arity. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
118
/* Access predecessor n */
119
120
121
122

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

Sebastian Hack's avatar
Sebastian Hack committed
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
/**
* 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
167
168
169
170
/**
 * 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.
 */
171
ir_node *get_irn_intra_n(const ir_node *node, int n);
Michael Beck's avatar
Michael Beck committed
172
173
174
175

/**
 * Get the n-th predecessor of a node in interprocedural view.
 */
176
ir_node *get_irn_inter_n(const ir_node *node, int n);
177
178

/** Replace the n-th predecessor of a node with a new one. */
179
void set_irn_n(ir_node *node, int n, ir_node *in);
180
181
182
183
184
185
/**
 * Appends a new predecessor to a node. This only works for nodes with
 * variable arity!
 * @returns   the number of the new input
 */
int add_irn_n(ir_node *node, ir_node *in);
186
/* Sets the mode struct of node.  */
187
void set_irn_mode(ir_node *node, ir_mode *mode);
188
/** Gets the mode struct of a node.  */
189
ir_mode *get_irn_mode(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
190
/** Gets the mode-enum modecode. */
191
modecode get_irn_modecode(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
192
/** Gets the ident for a string representation of the mode .*/
193
ident *get_irn_modeident(const ir_node *node);
194
/** Gets the string representation of the mode .*/
195
const char *get_irn_modename(const ir_node *node);
196
/** Gets the opcode struct of the node. */
197
ir_op *get_irn_op(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
198
/** Sets the opcode struct of the node. */
199
void set_irn_op(ir_node *node, ir_op *op);
Michael Beck's avatar
Michael Beck committed
200
/** Gets the opcode-enum of the node. */
201
ir_opcode get_irn_opcode(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
202
/** Get the string representation of the opcode. */
203
const char *get_irn_opname(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
204
/** Get the ident for a string representation of the opcode. */
205
ident *get_irn_opident(const ir_node *node);
206
/** If arg is an argument of the node, returns it's position, -1 otherwise */
207
int get_irn_pred_pos(ir_node *node, ir_node *arg);
208
/** Gets the visited counter of a node. */
209
unsigned long get_irn_visited(const ir_node *node);
210
/** Sets the visited counter of a node. */
211
void set_irn_visited(ir_node *node, unsigned long visited);
Michael Beck's avatar
Michael Beck committed
212
/** Sets visited to get_irg_visited(current_ir_graph). */
213
void mark_irn_visited(ir_node *node);
214
/** Returns 1 if visited < get_irg_visited(current_ir_graph). */
215
int irn_not_visited(const ir_node *node);
216
/** Returns 1 if visited >= get_irg_visited(current_ir_graph). */
217
int irn_visited(const ir_node *node);
218
219
220
221
222

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

/** Returns the link of a node.  */
226
void *get_irn_link(const ir_node *node);
227
228

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

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

237
238
239
240
241
242
243
/** 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.
 */
244
op_pin_state get_irn_pinned(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
245
246
247

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

249
250
251
252
253
254
/** 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'.
 */
255
op_pin_state is_irn_pinned_in_irg(const ir_node *node);
256

Michael Beck's avatar
Michael Beck committed
257
/**
258
259
260
261
 * 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.
262
263
264
 *
 * @param db    Debug info.
 * @param irg   IR-graph on with this new node should be constructed.
Michael Beck's avatar
Michael Beck committed
265
 * @param block The block the new node belongs to
266
267
 * @param op    The opcode of the new node.
 * @param mode  The mode of the new node.
268
 * @param arity The arity of the new node, <0 if can be changed dynamically.
269
 * @param in    An array of arity predecessor nodes.
Michael Beck's avatar
Michael Beck committed
270
 */
271
ir_node *
272
new_ir_node(dbg_info *db,
Florian Liekweg's avatar
Florian Liekweg committed
273
274
275
276
277
278
         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
279

280
281
282
283
284
/**
 * 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
285
286
287
288
289
 *
 * 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
290
 * get_irn_block(). */
Sebastian Hack's avatar
Sebastian Hack committed
291
ir_node  *get_nodes_block (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
292
293

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

Götz Lindenmaier's avatar
Götz Lindenmaier committed
296
/**
Michael Beck's avatar
Michael Beck committed
297
 * @function get_irn_block()
298
 * @see get_nodes_block()
Götz Lindenmaier's avatar
Götz Lindenmaier committed
299
 */
300

301
302
303
304
/**
 * Projection numbers for result of Start node: use for Proj nodes!
 */
typedef enum {
305
306
307
308
  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
309
310
311
312
                                  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. */
313
314
315
316
  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 */
317
318
} pn_Start; /* Projection numbers for Start. */

319
320
321
322
/** 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
323
ir_type *is_frame_pointer(ir_node *n);
324
325
326
327
328

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

331
332
333
334
335
336
/** 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);

337
338
339
340
341
342
/** 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
343

344
/* @@@ no more supported  */
345
346
347
348
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);
349
350
/** Get the predecessor block.
 *
351
 *  Returns the block corresponding to the predecessor pos of block.
352
353
354
355
356
357
358
359
360
 *
 *  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);
361
362
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
363
364
365

/** A visited flag only for block nodes.
 *  @see also: get_irn_visited() inc_irg_visited() inc_irg_block_visited()*/
Matthias Braun's avatar
Matthias Braun committed
366
unsigned long get_Block_block_visited(const ir_node *node);
367
void      set_Block_block_visited(ir_node *node, unsigned long visit);
368
369
370
371
372

/**
 * Marks a block as dead but do not replace it with a Bad node.
 * Dead blocks are removed in the con
 */
373
374
375
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
376
/* For this current_ir_graph must be set. */
377
void      mark_Block_block_visited(ir_node *node);
Matthias Braun's avatar
Matthias Braun committed
378
379
int       Block_not_block_visited(const ir_node *node);
int       Block_block_visited(const ir_node *node);
Christian Schäfer's avatar
Christian Schäfer committed
380

381
382
/* Set and remove interprocedural predecessors. If the interprocedural
 * predecessors are removed, the node has the same predecessors in
383
384
 * both views.
 * @@@ Maybe better:  arity is zero if no cg preds. */
385
386
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);
387
/* @@@ not supported */
388
ir_node **get_Block_cg_cfgpred_arr(ir_node * node);
Michael Beck's avatar
Michael Beck committed
389
/** Returns the number of interprocedural predecessors.  0 if none. */
390
int       get_Block_cg_n_cfgpreds(ir_node * node);
Michael Beck's avatar
Michael Beck committed
391
/** Return the interprocedural predecessor at position pos. */
392
ir_node  *get_Block_cg_cfgpred(ir_node * node, int pos);
393
/* frees the memory. */
394
395
void      remove_Block_cg_cfgpred_arr(ir_node * node);

396
397
398
399
400
/** 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
401
/** Return the number of Keep alive node. */
402
int  get_End_n_keepalives(ir_node *end);
Michael Beck's avatar
Michael Beck committed
403
404

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

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

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

413
414
415
/** Set new keep-alives */
void set_End_keepalives(ir_node *end, int n, ir_node *in[]);

416
417
418
/* 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
419
/** Some parts of the End node are allocated separately -- their memory
420
   is not recovered by dead_node_elimination if a End node is dead.
Michael Beck's avatar
Michael Beck committed
421
   free_End() frees these data structures. */
422
void free_End(ir_node *end);
423

424
425
426
427
428
/** 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);
429

430
431
432
433
434
435
436
437
/* 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.
438
   We differ two flavors of this Cond.  The first, the dense Cond, passes
439
440
   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.
441
   The second Cond flavor differences in the treatment of cases not specified in
442
443
444
445
446
   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.
447
448
   The two switch flavors are distinguished by a flag of type cond_kind.
   Default flavor is "dense"
449
450
*/
typedef enum {
Michael Beck's avatar
Michael Beck committed
451
452
  dense,        /**< Default. Missing Proj nodes are dead control flow. */
  fragmentary   /**< Special. No control flow optimizations allowed.  Missing
Florian Liekweg's avatar
Florian Liekweg committed
453
           Proj nodes mean default control flow, i.e., Proj(n). */
454
455
} cond_kind;

456
457
458
459
460
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
461

462
463
464
/**
 * Projection numbers for conditions.
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
465
466
typedef enum {
  pn_Cond_false,    /**< Control flow if operand is "false". */
467
468
  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
469
470
} pn_Cond;  /* Projection numbers for Cond. */

471
472
473
474
475
476
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
477

Sebastian Hack's avatar
Sebastian Hack committed
478
typedef enum {
479
480
481
  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...). */
482
  CNST_OTHER    =  2, /**< The tarval of the const has another value. */
483
484
  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
485
486
} cnst_classify_t;

487
488
tarval  *get_Const_tarval(ir_node *node);
void     set_Const_tarval(ir_node *node, tarval *con);
Michael Beck's avatar
Michael Beck committed
489

Sebastian Hack's avatar
Sebastian Hack committed
490
491
492
493
494
495
496
/**
 * 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
497
498
499
/** Returns the source language type of a Const node.
 * Must be an atomic type.  Mode of type must be mode of node.
 */
500
ir_type  *get_Const_type(ir_node *node);
Michael Beck's avatar
Michael Beck committed
501
502

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

Michael Beck's avatar
Michael Beck committed
505
/**  This enum names the three different kinds of symbolic Constants
Götz Lindenmaier's avatar
Götz Lindenmaier committed
506
507
508
509
     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
510
  symconst_type_tag,    /**< The SymConst is a type tag for the given type.
511
                             symconst_symbol is type *. */
512
  symconst_type_size,   /**< The SymConst is the size of the given type.
513
                             symconst_symbol is type *. */
514
  symconst_type_align,  /**< The SymConst is the alignment of the given type.
515
                             symconst_symbol is type *. */
Beyhan's avatar
Beyhan committed
516
  symconst_addr_name,   /**< The SymConst is a symbolic pointer to be filled in
517
518
                             by the linker.  The pointer is represented by a string.
                             symconst_symbol is ident *. */
519
  symconst_addr_ent,    /**< The SymConst is a symbolic pointer to be filled in
520
521
                             by the linker.  The pointer is represented by an entity.
                             symconst_symbol is entity *. */
522
523
  symconst_ofs_ent,     /**< The SymConst is the offset of its entity in the entities
                             owner type. */
524
  symconst_enum_const   /**< The SymConst is a enumeration constant of an
525
                             enumeration type. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
526
} symconst_kind;
527

528
529
530
531
532
533
534
/** 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 */
535
#define SYMCONST_HAS_ENT(kind) ((kind) == symconst_addr_ent || (kind) == symconst_ofs_ent)
536

537
538
539
/** 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
540
541
/** SymConst attribute.
 *
542
543
 *  This union contains the symbolic information represented by the node.
 */
544
typedef union symconst_symbol {
545
546
  ir_type       *type_p;    /**< the type of a symconst */
  ident         *ident_p;   /**< the ident of a symconst */
547
  ir_entity     *entity_p;  /**< the entity of a symconst */
548
  ir_enum_const *enum_p;    /**< the enumeration constant of a symconst */
549
} symconst_symbol;
550

Michael Beck's avatar
Michael Beck committed
551
/** Get the kind of the SymConst. */
552
symconst_kind get_SymConst_kind(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
553
/** Set the kind of the SymConst. */
554
void          set_SymConst_kind(ir_node *node, symconst_kind num);
Beyhan's avatar
Beyhan committed
555
556

/** Only to access SymConst of kind type_tag or size.  Else assertion: */
557
558
ir_type  *get_SymConst_type(ir_node *node);
void     set_SymConst_type(ir_node *node, ir_type *tp);
Beyhan's avatar
Beyhan committed
559
560

/** Only to access SymConst of kind addr_name.  Else assertion: */
561
562
ident   *get_SymConst_name(ir_node *node);
void     set_SymConst_name(ir_node *node, ident *name);
Beyhan's avatar
Beyhan committed
563
564

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

568
/** Only to access SymConst of kind symconst_enum_const.  Else assertion: */
569
570
ir_enum_const *get_SymConst_enum(ir_node *node);
void           set_SymConst_enum(ir_node *node, ir_enum_const *ec);
571

Beyhan's avatar
Beyhan committed
572
573
/** 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
574
/* write 'union': firmjni then does not create a method... */
575
576
577
union symconst_symbol get_SymConst_symbol(ir_node *node);
void                  set_SymConst_symbol(ir_node *node,
                                          union symconst_symbol sym);
578

Götz Lindenmaier's avatar
Götz Lindenmaier committed
579
580
581
/** Access the type of the value represented by the SymConst.
 *
 *  Example: primitive type int for SymConst size. */
582
583
584
ir_type *get_SymConst_value_type(ir_node *node);
void    set_SymConst_value_type(ir_node *node, ir_type *tp);

585
586
587
588
589
590
591
592
593
594
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
595

596
597
598
/**
 * Projection numbers for result of Call node: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
599
typedef enum {
600
601
  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
602
  pn_Call_P_value_res_base = 4,/**< A pointer to the memory region containing copied results
603
604
605
606
607
                                    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
608
} pn_Call;   /* Projection numbers for Call. */
609
#define pn_Call_M pn_Call_M_regular
Götz Lindenmaier's avatar
Götz Lindenmaier committed
610

611
612
613
614
615
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
616
/** Gets the number of parameters of a call. */
617
int      get_Call_n_params(ir_node *node);
Michael Beck's avatar
Michael Beck committed
618
/** Gets the call parameter at position pos. */
619
ir_node *get_Call_param(ir_node *node, int pos);
Michael Beck's avatar
Michael Beck committed
620
/** Sets the call parameter at position pos. */
621
void     set_Call_param(ir_node *node, int pos, ir_node *param);
Michael Beck's avatar
Michael Beck committed
622
/** Gets the type of a call. */
623
ir_type *get_Call_type(ir_node *node);
Michael Beck's avatar
Michael Beck committed
624
/** Sets the type of a call. */
625
void     set_Call_type(ir_node *node, ir_type *tp);
Michael Beck's avatar
Michael Beck committed
626
/** Gets the arity of a call. Identical to get_Call_n_params(). */
627
int      get_Call_arity(ir_node *node);
628

629
630
631
632
/** 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
633
634
635
636
 *  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.
637
638
639
640
641
642
643
644
645
 *
 *  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.
 */
646
647
648
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
649

650
651
652
/** Set the full callee array.
 *
 *  The passed array is copied. Assumes current_ir_graph set properly! */
653
void    set_Call_callee_arr(ir_node *node, const int n, ir_entity **arr);
654
void    remove_Call_callee_arr(ir_node *node);
655

656
657
658
659
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);
660

Christian Schäfer's avatar
Christian Schäfer committed
661
662
663
/* 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
664
   unops are: Minus, Abs, Not, Conv, Cast
Christian Schäfer's avatar
Christian Schäfer committed
665
666
   binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
   Shr, Shrs, Rot, Cmp */
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
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);
700

701
702
703
/**
 * Projection numbers for Quot: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
704
705
typedef enum {
  pn_Quot_M,           /**< Memory result.    */
Michael Beck's avatar
Michael Beck committed
706
  pn_Quot_X_except,    /**< Execution result if exception occurred. */
707
708
  pn_Quot_res,         /**< Result of computation. */
  pn_Quot_max          /**< number of projections from a Quot */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
709
710
} pn_Quot;  /* Projection numbers for Quot. */

711
712
713
714
715
716
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);
717

718
719
720
/**
 * Projection numbers for DivMod: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
721
722
typedef enum {
  pn_DivMod_M,           /**< Memory result.    */
Michael Beck's avatar
Michael Beck committed
723
  pn_DivMod_X_except,    /**< Execution result if exception occurred. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
724
  pn_DivMod_res_div,     /**< Result of computation a / b. */
725
726
  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
727
728
} pn_DivMod;  /* Projection numbers for DivMod. */

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

736
737
738
/**
 * Projection numbers for Div: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
739
740
typedef enum {
  pn_Div_M,           /**< Memory result.    */
Michael Beck's avatar
Michael Beck committed
741
  pn_Div_X_except,    /**< Execution result if exception occurred. */
Rubino Geiß's avatar
typo    
Rubino Geiß committed
742
  pn_Div_res,         /**< Result of computation. */
Rubino Geiß's avatar
Rubino Geiß committed
743
  pn_Div_max          /**< number of projections from a Div */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
744
745
} pn_Div;  /* Projection numbers for Div. */

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

753
754
755
/**
 * Projection numbers for Mod: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
756
757
typedef enum {
  pn_Mod_M,           /**< Memory result.    */
Michael Beck's avatar
Michael Beck committed
758
  pn_Mod_X_except,    /**< Execution result if exception occurred. */
759
760
  pn_Mod_res,         /**< Result of computation. */
  pn_Mod_max          /**< number of projections from a Mod */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
761
762
} pn_Mod;  /* Projection numbers for Mod. */

763
764
ir_node *get_Abs_op(ir_node *node);
void     set_Abs_op(ir_node *node, ir_node *op);
765

766
767
768
769
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);
770

771
772
773
774
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);
775

776
777
778
779
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);
780

781
782
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
783

784
785
/**
 * Projection numbers for Cmp are defined several times.
786
 * The bit patterns are used for various tests, so don't change.
787
788
 * The "unordered" values are possible results of comparing
 * floating point numbers.
Michael Beck's avatar
Michael Beck committed
789
 * Note that the encoding is imported, so do NOT change the order.
790
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
791
typedef enum {
Michael Beck's avatar
Michael Beck committed
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
  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 */
808
  /* not_mask = Leg*/   /* bits to flip to negate comparison * @@ hack for JNI interface */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
809
} pn_Cmp;   /* Projection numbers for Cmp */
810
/* #define not_mask pn_Cmp_Leg */
811

Michael Beck's avatar
Michael Beck committed
812
/** returns the pnc name from an pnc constant */
813
const char *get_pnc_string(int pnc);
Michael Beck's avatar
Michael Beck committed
814

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

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

821
822
823
824
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);
825

826
827
828
829
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);
830

831
832
833
834
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);
835

836
837
838
839
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);
840

841
842
843
844
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);
845

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

Götz Lindenmaier's avatar
comment    
Götz Lindenmaier committed
851
852
/* 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
853
 * entity.  But:  we initialize various fields after Alloc, that
Götz Lindenmaier's avatar
comment    
Götz Lindenmaier committed
854
855
856
 * are accessed in the cast.  This required some precaution, to
 * get the right memory into the Loads generated from the cast.
 */
857
858
859
860
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
861

Götz Lindenmaier's avatar
Götz Lindenmaier committed
862
863
864
865
/** Checks for upcast.
 *
 * Returns true if the Cast node casts a class type to a super type.
 * Works also for pointers to classes (recursively).
866
867
 *
 * Needs typeinfo calculated.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
868
869
870
871
872
873
874
 */
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).
875
876
 *
 * Needs typeinfo calculated.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
877
878
879
880
 */
int is_Cast_downcast(ir_node *node);


Götz Lindenmaier's avatar
Götz Lindenmaier committed
881
882
883
/** 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. */
884
int       is_Phi(const ir_node *n);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
885
886
/** Returns true  if irg in phase building and the Phi has zero
   predecessors: it's a Phi0. */
887
int       is_Phi0(const ir_node *n);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
888
/* These routines also work for Filter nodes in interprocedural view. */
889
890
891
892
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);
893
894
895
896
897

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);
898
899
/* 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
900
901
902
903
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);
904

905
906
/** Return true if parameter is a memory operation.
 *
Götz Lindenmaier's avatar
Götz Lindenmaier committed
907
 *  A memory operation is an operation that changes the
908
909
910
 *  memory.  I.e., a Load or a Store operation.
 */
int is_memop(ir_node *node);
911
912
913
914
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);
915

916
917
918
/**
 * Projection numbers for Load: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
919
920
typedef enum {
  pn_Load_M,         /**< Memory result.    */
Michael Beck's avatar
Michael Beck committed
921
  pn_Load_X_except,  /**< Execution result if exception occurred. */
922
923
  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
924
925
} pn_Load;  /* Projection numbers for Load. */

926
927
928
929
930
931
932
933
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);
934

935
936
937
/**
 * Projection numbers for Store: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
938
typedef enum {
Götz Lindenmaier's avatar
Götz Lindenmaier committed
939
  pn_Store_M,         /**< Memory result.    */
Michael Beck's avatar
Michael Beck committed
940
  pn_Store_X_except,  /**< Execution result if exception occurred. */
941
  pn_Store_max        /**< number of projections from a Store */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
942
943
} pn_Store;  /* Projection numbers for Store. */

944
945
946
947
948
949
950
951
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);
952

953
954
955
/**
 * Projection numbers for Alloc: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
956
typedef enum {
957
  pn_Alloc_M,         /**< Memory result. */
Michael Beck's avatar
Michael Beck committed
958
  pn_Alloc_X_except,  /**< Execution result if exception occurred. */
959
960
  pn_Alloc_res,       /**< Result of allocation. */
  pn_Alloc_max        /**< number of projections from an Alloc */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
961
962
} pn_Alloc;  /* Projection numbers for Alloc. */

963
964
965
966
967
968
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
969

970
/** The allocation place. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
971
typedef enum {
Michael Beck's avatar
Michael Beck committed
972
973
  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
974
} where_alloc;
Michael Beck's avatar
Michael Beck committed
975

976
977
where_alloc  get_Alloc_where(ir_node *node);
void         set_Alloc_where(ir_node *node, where_alloc where);