irnode.h 60.6 KB
Newer Older
Christian Würdig's avatar
Christian Würdig committed
1
/*
2
 * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
Christian Würdig's avatar
Christian Würdig committed
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
 *
 * 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.
 */

Matthias Braun's avatar
Matthias Braun committed
20
21
22
23
24
/**
 * @file
 * @brief   Representation of an intermediate operation.
 * @author  Martin Trapp, Christian Schaefer, Goetz Lindenmaier, Michael Beck
 * @version $Id$
Michael Beck's avatar
Michael Beck committed
25
 */
Matthias Braun's avatar
Matthias Braun committed
26
27
#ifndef FIRM_IR_IRNODE_H
#define FIRM_IR_IRNODE_H
Christian Schäfer's avatar
Christian Schäfer committed
28

29
30
#include <stddef.h>

Michael Beck's avatar
Michael Beck committed
31
#include "firm_common.h"
32
#include "typerep.h"
Michael Beck's avatar
Michael Beck committed
33
34
#include "irop.h"
#include "irmode.h"
35
#include "begin.h"
Michael Beck's avatar
Michael Beck committed
36
37
38
39

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

Sebastian Felis's avatar
Sebastian Felis committed
60
/**
61
 * Some projection numbers must be always equal to support automatic phi construction
Michael Beck's avatar
Michael Beck committed
62
 */
63
enum pn_generic {
64
	pn_Generic_M         = 0,  /**< The memory result. */
65
66
67
68
	pn_Generic_X_regular = 1,  /**< Execution result if no exception occurred. */
	pn_Generic_X_except  = 2,  /**< The control flow result branching to the exception handler */
	pn_Generic_other     = 3   /**< First free projection number */
};
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
 */
Michael Beck's avatar
Michael Beck committed
76
FIRM_API 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
 */
Michael Beck's avatar
Michael Beck committed
83
FIRM_API int get_irn_arity      (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
84
85

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

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

/**
 * Get the n-th predecessor of a node.
 * This function removes Id predecessors.
 */
Michael Beck's avatar
Michael Beck committed
104
FIRM_API ir_node *get_irn_n(const ir_node *node, int n);
Michael Beck's avatar
Michael Beck committed
105

Sebastian Hack's avatar
Sebastian Hack committed
106
/**
107
108
109
110
111
112
113
114
115
 * Add a artificial dependency to the node.
 * The dependency is only inserted if it is not there already.
 * This is only allowed in phase_backend!
 *
 * @param node The node.
 * @param dep  The dependency target.
 *
 * @return The index in the array (get_irn_dep with that index returns @p dep).
 */
Michael Beck's avatar
Michael Beck committed
116
FIRM_API int add_irn_dep(ir_node *node, ir_node *dep);
Sebastian Hack's avatar
Sebastian Hack committed
117
118
119

/**
 * Copy all dependencies from a node to another.
120
121
 * This is only allowed in phase_backend!
 *
122
 * @param tgt The node which should be enriched.
Sebastian Hack's avatar
Sebastian Hack committed
123
124
 * @param src The node whose dependencies shall be copied.
 */
Michael Beck's avatar
Michael Beck committed
125
FIRM_API void add_irn_deps(ir_node *tgt, ir_node *src);
Sebastian Hack's avatar
Sebastian Hack committed
126
127

/**
Michael Beck's avatar
Michael Beck committed
128
129
130
131
 * 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.
 */
Michael Beck's avatar
Michael Beck committed
132
FIRM_API int get_irn_deps(const ir_node *node);
Sebastian Hack's avatar
Sebastian Hack committed
133
134

/**
Michael Beck's avatar
Michael Beck committed
135
136
137
138
139
 * Get an entry of the dependency array.
 * @param node The node.
 * @param pos  The position.
 * @return The node at that position.
 */
Michael Beck's avatar
Michael Beck committed
140
FIRM_API ir_node *get_irn_dep(const ir_node *node, int pos);
Sebastian Hack's avatar
Sebastian Hack committed
141
142

/**
Michael Beck's avatar
Michael Beck committed
143
144
145
146
147
 * Set an entry of the dependency array.
 * @param node The node.
 * @param pos  The position.
 * @param dep  The dependency target.
 */
Michael Beck's avatar
Michael Beck committed
148
FIRM_API void set_irn_dep(ir_node *node, int pos, ir_node *dep);
Sebastian Hack's avatar
Sebastian Hack committed
149

150
/** Replace the n-th predecessor of a node with a new one. */
Michael Beck's avatar
Michael Beck committed
151
FIRM_API void set_irn_n(ir_node *node, int n, ir_node *in);
152
153
154
155
156
/**
 * Appends a new predecessor to a node. This only works for nodes with
 * variable arity!
 * @returns   the number of the new input
 */
Michael Beck's avatar
Michael Beck committed
157
FIRM_API int add_irn_n(ir_node *node, ir_node *in);
Christoph Mallon's avatar
Christoph Mallon committed
158
/* Remove predecessor i from Sync n */
Michael Beck's avatar
Michael Beck committed
159
FIRM_API void del_Sync_n(ir_node *n, int i);
160
/* Sets the mode struct of node.  */
Michael Beck's avatar
Michael Beck committed
161
FIRM_API void set_irn_mode(ir_node *node, ir_mode *mode);
162
/** Gets the mode struct of a node.  */
Michael Beck's avatar
Michael Beck committed
163
FIRM_API ir_mode *get_irn_mode(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
164
/** Gets the ident for a string representation of the mode .*/
Michael Beck's avatar
Michael Beck committed
165
FIRM_API ident *get_irn_modeident(const ir_node *node);
166
/** Gets the string representation of the mode .*/
Michael Beck's avatar
Michael Beck committed
167
FIRM_API const char *get_irn_modename(const ir_node *node);
168
/** Gets the opcode struct of the node. */
Michael Beck's avatar
Michael Beck committed
169
FIRM_API ir_op *get_irn_op(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
170
/** Sets the opcode struct of the node. */
Michael Beck's avatar
Michael Beck committed
171
FIRM_API void set_irn_op(ir_node *node, ir_op *op);
Michael Beck's avatar
Michael Beck committed
172
/** Gets the opcode-enum of the node. */
Michael Beck's avatar
Michael Beck committed
173
FIRM_API unsigned get_irn_opcode(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
174
/** Get the string representation of the opcode. */
Michael Beck's avatar
Michael Beck committed
175
FIRM_API const char *get_irn_opname(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
176
/** Get the ident for a string representation of the opcode. */
Michael Beck's avatar
Michael Beck committed
177
FIRM_API ident *get_irn_opident(const ir_node *node);
178
/** If arg is an argument of the node, returns it's position, -1 otherwise */
Michael Beck's avatar
Michael Beck committed
179
FIRM_API int get_irn_pred_pos(ir_node *node, ir_node *arg);
180
/** Gets the visited counter of a node. */
Michael Beck's avatar
Michael Beck committed
181
FIRM_API ir_visited_t get_irn_visited(const ir_node *node);
182
/** Sets the visited counter of a node. */
Michael Beck's avatar
Michael Beck committed
183
FIRM_API void set_irn_visited(ir_node *node, ir_visited_t visited);
Michael Beck's avatar
Michael Beck committed
184
/** Sets visited to get_irg_visited(current_ir_graph). */
Michael Beck's avatar
Michael Beck committed
185
FIRM_API void mark_irn_visited(ir_node *node);
186
/** Returns 1 if visited >= get_irg_visited(current_ir_graph). */
Michael Beck's avatar
Michael Beck committed
187
FIRM_API int irn_visited(const ir_node *node);
188
189
/** Returns 1 if visited >= get_irg_visited(current_ir_graph). Marks the node
 * visited, if it was not. */
Michael Beck's avatar
Michael Beck committed
190
FIRM_API int irn_visited_else_mark(ir_node *node);
191
192
193
194
195

/**
 * Sets the link of a node.
 * Only allowed if the graph is NOT in phase_building.
 */
Michael Beck's avatar
Michael Beck committed
196
FIRM_API void set_irn_link(ir_node *node, void *link);
197
198

/** Returns the link of a node.  */
Michael Beck's avatar
Michael Beck committed
199
FIRM_API void *get_irn_link(const ir_node *node);
200

201
/** Returns the ir_graph this node belongs to. */
Michael Beck's avatar
Michael Beck committed
202
FIRM_API ir_graph *get_irn_irg(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
203

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

209
210
211
212
213
214
215
/** Returns the pinned state of a node.
 *
 *  Returns whether the node _always_ must be pinned.
 *  I.e., the node is not floating after global cse.
 *
 * @returns Either state op_pin_state_pinned or op_pin_state_floats.
 */
Michael Beck's avatar
Michael Beck committed
216
FIRM_API op_pin_state get_irn_pinned(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
217
218

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

221
222
223
224
225
226
/** 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'.
 */
Michael Beck's avatar
Michael Beck committed
227
FIRM_API op_pin_state is_irn_pinned_in_irg(const ir_node *node);
228

Michael Beck's avatar
Michael Beck committed
229
/**
230
231
232
233
 * 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.
234
235
236
 *
 * @param db    Debug info.
 * @param irg   IR-graph on with this new node should be constructed.
Michael Beck's avatar
Michael Beck committed
237
 * @param block The block the new node belongs to
238
239
 * @param op    The opcode of the new node.
 * @param mode  The mode of the new node.
240
 * @param arity The arity of the new node, <0 if can be changed dynamically.
241
 * @param in    An array of arity predecessor nodes.
Michael Beck's avatar
Michael Beck committed
242
 */
Michael Beck's avatar
Michael Beck committed
243
FIRM_API ir_node *new_ir_node(dbg_info *db, ir_graph *irg, ir_node *block,
244
245
                              ir_op *op, ir_mode *mode,
                              int arity, ir_node *in[]);
Christian Schäfer's avatar
Christian Schäfer committed
246

247
248
249
250
251
/**
 * 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
252
253
254
255
256
 *
 * 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
257
 * get_irn_block(). */
Michael Beck's avatar
Michael Beck committed
258
FIRM_API ir_node *get_nodes_block (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
259
260

/** Sets the Block of a node. */
Michael Beck's avatar
Michael Beck committed
261
FIRM_API void set_nodes_block (ir_node *node, ir_node *block);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
262

Michael Beck's avatar
Michael Beck committed
263
264
265
266
267
268
269
270
271
272
273
/**
 * Return the MacroBlock the node belongs to.  This is only
 * possible for pinned nodes or if the graph is in pinned state.
 * Otherwise the MacroBlock may be incorrect.  This condition is
 * now checked by an assertion.
 *
 * This works for all except Block.  It can return Blocks or the Bad node.
 *
 * To express the difference to access routines that work for all
 * nodes we use infix "nodes" and do not name this function
 * get_irn_MacroBlock(). */
Michael Beck's avatar
Michael Beck committed
274
FIRM_API ir_node *get_nodes_MacroBlock(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
275

276
277
278
279
/**
 * Projection numbers for result of Start node: use for Proj nodes!
 */
typedef enum {
Michael Beck's avatar
Michael Beck committed
280
281
282
283
284
285
286
	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_tls,            /**< Projection on the pointer to the thread local store
	                                segment containing _all_thread local variables. */
	pn_Start_T_args,           /**< Projection on all arguments. */
	pn_Start_max               /**< number of projections from a Start */
287
288
} pn_Start; /* Projection numbers for Start. */

289
290
291
292
/** 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
293
FIRM_API ir_type *is_frame_pointer(const ir_node *n);
294

295
/** Test whether arbitrary node is the thread local storage (tls) pointer.
296
297
298
 *
 * Test whether arbitrary node is tls pointer, i.e. Proj(pn_Start_P_tls)
 * from Start.  If so returns tls type, else Null. */
Michael Beck's avatar
Michael Beck committed
299
FIRM_API ir_type *is_tls_pointer(const ir_node *n);
300

301
/** Return the number of control flow predecessors of a block. */
Michael Beck's avatar
Michael Beck committed
302
FIRM_API int get_Block_n_cfgpreds(const ir_node *block);
303
/** Return the control flow predecessor of a block at a given position. */
Michael Beck's avatar
Michael Beck committed
304
FIRM_API ir_node *get_Block_cfgpred(const ir_node *block, int pos);
305
/** Set the control flow predecessor of a block at a given position. */
Michael Beck's avatar
Michael Beck committed
306
FIRM_API void set_Block_cfgpred(ir_node *block, int pos, ir_node *pred);
307
308
309
310
311
312
313
314
315
316
317
318
319
320

/**
 * Return the position of the predecessor block pred in the inputs
 * of the block block.
 *
 * @param block  the block
 * @param pred   a predecessor block of block
 *
 * @return the position of pred in block or -1
 *
 * @note When using the old extended basic block form for blocks
 * with exception exists, a predecessor block might have more
 * than one position. In that case it is not specified, with is returned.
 */
Michael Beck's avatar
Michael Beck committed
321
FIRM_API int get_Block_cfgpred_pos(const ir_node *block, const ir_node *pred);
322

323
324
/** Get the predecessor block.
 *
325
 *  Returns the block corresponding to the predecessor pos of block.
326
327
328
329
330
331
 *
 *  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
Michael Beck's avatar
Michael Beck committed
332
 *    Start block, but the Bad node.
333
 */
Michael Beck's avatar
Michael Beck committed
334
FIRM_API ir_node *get_Block_cfgpred_block(const ir_node *node, int pos);
335
336

/** Return the matured flag of a block */
Michael Beck's avatar
Michael Beck committed
337
FIRM_API int get_Block_matured(const ir_node *block);
338
/** set the matured flag of a block. */
Michael Beck's avatar
Michael Beck committed
339
FIRM_API void set_Block_matured(ir_node *block, int matured);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
340
341
342

/** A visited flag only for block nodes.
 *  @see also: get_irn_visited() inc_irg_visited() inc_irg_block_visited()*/
Michael Beck's avatar
Michael Beck committed
343
344
FIRM_API ir_visited_t get_Block_block_visited(const ir_node *block);
FIRM_API void set_Block_block_visited(ir_node *block, ir_visited_t visit);
345
346
347
348
349

/**
 * Marks a block as dead but do not replace it with a Bad node.
 * Dead blocks are removed in the con
 */
Michael Beck's avatar
Michael Beck committed
350
351
FIRM_API ir_node *set_Block_dead(ir_node *block);
FIRM_API int is_Block_dead(const ir_node *block);
352

Götz Lindenmaier's avatar
Götz Lindenmaier committed
353
/* For this current_ir_graph must be set. */
Michael Beck's avatar
Michael Beck committed
354
355
FIRM_API void mark_Block_block_visited(ir_node *node);
FIRM_API int Block_block_visited(const ir_node *node);
Christian Schäfer's avatar
Christian Schäfer committed
356

357
/** Returns the extended basic block a block belongs to. */
Michael Beck's avatar
Michael Beck committed
358
FIRM_API ir_extblk *get_Block_extbb(const ir_node *block);
359
/** Sets the extended basic block a block belongs to. */
Michael Beck's avatar
Michael Beck committed
360
FIRM_API void set_Block_extbb(ir_node *block, ir_extblk *extblk);
Michael Beck's avatar
Michael Beck committed
361
/** Get the Macro Block header of a (sub-) block. */
Michael Beck's avatar
Michael Beck committed
362
FIRM_API ir_node *get_Block_MacroBlock(const ir_node *block);
Michael Beck's avatar
Michael Beck committed
363
/** Set the Macro Block header of a (sub-) block. */
Michael Beck's avatar
Michael Beck committed
364
FIRM_API void set_Block_MacroBlock(ir_node *block, ir_node *mbh);
Michael Beck's avatar
Michael Beck committed
365
/** Get the Macro Block header of a node. */
Michael Beck's avatar
Michael Beck committed
366
FIRM_API ir_node *get_irn_MacroBlock(const ir_node *n);
367
/** Returns the ir_graph this Block belongs to. */
Michael Beck's avatar
Michael Beck committed
368
FIRM_API ir_graph *get_Block_irg(const ir_node *block);
369
/** Returns non-zero if the block has an entity assigned */
Michael Beck's avatar
Michael Beck committed
370
FIRM_API int has_Block_entity(const ir_node *block);
371
/** Returns the entity for a Block */
Michael Beck's avatar
Michael Beck committed
372
FIRM_API ir_entity *get_Block_entity(const ir_node *block);
373
/** Returns the entity for a Block (creating it if necessary) */
Michael Beck's avatar
Michael Beck committed
374
FIRM_API ir_entity *create_Block_entity(ir_node *block);
375
/** Set a new entity for a block */
Michael Beck's avatar
Michael Beck committed
376
FIRM_API void set_Block_entity(ir_node *block, ir_entity *entity);
377
/** Gets the head of the Phi list for this block. */
Michael Beck's avatar
Michael Beck committed
378
FIRM_API ir_node *get_Block_phis(const ir_node *block);
379
/** Sets the head of the Phi list for this block. */
Michael Beck's avatar
Michael Beck committed
380
FIRM_API void set_Block_phis(ir_node *block, ir_node *phi);
Michael Beck's avatar
Michael Beck committed
381
/** Add a Phi node to the list of Block Phi's. */
Michael Beck's avatar
Michael Beck committed
382
FIRM_API void add_Block_phi(ir_node *block, ir_node *phi);
Michael Beck's avatar
Michael Beck committed
383
/** Get the Block mark (single bit). */
Michael Beck's avatar
Michael Beck committed
384
FIRM_API unsigned get_Block_mark(const ir_node *block);
Michael Beck's avatar
Michael Beck committed
385
/** Set the Block mark (single bit). */
Michael Beck's avatar
Michael Beck committed
386
FIRM_API void set_Block_mark(ir_node *block, unsigned mark);
Michael Beck's avatar
Michael Beck committed
387

Michael Beck's avatar
Michael Beck committed
388
/** Return the number of Keep alive node. */
Michael Beck's avatar
Michael Beck committed
389
FIRM_API int get_End_n_keepalives(const ir_node *end);
Michael Beck's avatar
Michael Beck committed
390
/** Return the Keep alive node a position pos. */
Michael Beck's avatar
Michael Beck committed
391
FIRM_API ir_node *get_End_keepalive(const ir_node *end, int pos);
Michael Beck's avatar
Michael Beck committed
392
/** Keep alive dedicated nodes.  These must be either PhiM or Block nodes. */
Michael Beck's avatar
Michael Beck committed
393
FIRM_API void add_End_keepalive(ir_node *end, ir_node *ka);
Michael Beck's avatar
Michael Beck committed
394
/** Set the Keep alive node at position pos. */
Michael Beck's avatar
Michael Beck committed
395
FIRM_API void set_End_keepalive(ir_node *end, int pos, ir_node *ka);
396
397
398
399
400
401

/**
 * Set new keep-alives.
 * Beware: This might be an expensive operation if dynamic edges are enabled,
 * so avoid it in the backend.
 */
Michael Beck's avatar
Michael Beck committed
402
FIRM_API void set_End_keepalives(ir_node *end, int n, ir_node *in[]);
403
404

/** Remove irn from the keep-alive set. */
Michael Beck's avatar
Michael Beck committed
405
FIRM_API void remove_End_keepalive(ir_node *end, ir_node *irn);
406

Michael Beck's avatar
Michael Beck committed
407
/* Remove Bads, NoMem and doublets from the keep-alive set. */
Michael Beck's avatar
Michael Beck committed
408
FIRM_API void remove_End_Bads_and_doublets(ir_node *end);
409

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

415
/** Return the target address of an IJmp */
Michael Beck's avatar
Michael Beck committed
416
FIRM_API ir_node *get_IJmp_target(const ir_node *ijmp);
417
/** Sets the target address of an IJmp */
Michael Beck's avatar
Michael Beck committed
418
FIRM_API void set_IJmp_target(ir_node *ijmp, ir_node *tgt);
419

Michael Beck's avatar
Michael Beck committed
420
421
422
423
FIRM_API ir_node *get_Cond_selector(const ir_node *node);
FIRM_API void set_Cond_selector(ir_node *node, ir_node *selector);
FIRM_API long get_Cond_default_proj(const ir_node *node);
FIRM_API void set_Cond_default_proj(ir_node *node, long defproj);
Christian Schäfer's avatar
Christian Schäfer committed
424

425
426
427
/**
 * Projection numbers for conditions.
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
428
typedef enum {
Michael Beck's avatar
Michael Beck committed
429
430
431
	pn_Cond_false,    /**< Control flow if operand is "false". */
	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
432
433
} pn_Cond;  /* Projection numbers for Cond. */

Michael Beck's avatar
Michael Beck committed
434
435
436
437
438
439
FIRM_API ir_node  *get_Return_mem(const ir_node *node);
FIRM_API void      set_Return_mem(ir_node *node, ir_node *mem);
FIRM_API ir_node **get_Return_res_arr(ir_node *node);
FIRM_API int       get_Return_n_ress(const ir_node *node);
FIRM_API ir_node  *get_Return_res(const ir_node *node, int pos);
FIRM_API void      set_Return_res(ir_node *node, int pos, ir_node *res);
Christian Schäfer's avatar
Christian Schäfer committed
440

Michael Beck's avatar
Michael Beck committed
441
442
FIRM_API tarval  *get_Const_tarval(const ir_node *node);
FIRM_API void     set_Const_tarval(ir_node *node, tarval *con);
Michael Beck's avatar
Michael Beck committed
443

Michael Beck's avatar
Michael Beck committed
444
/** Return non-zero if the given Const node represents the 0 constant. */
Michael Beck's avatar
Michael Beck committed
445
FIRM_API int is_Const_null(const ir_node *node);
446

Michael Beck's avatar
Michael Beck committed
447
/** Return non-zero if the given Const node represents the 1 constant. */
Michael Beck's avatar
Michael Beck committed
448
FIRM_API int is_Const_one(const ir_node *node);
449

Michael Beck's avatar
Michael Beck committed
450
/** Return non-zero if the given Const node represents the constant with all bits set. */
Michael Beck's avatar
Michael Beck committed
451
FIRM_API int is_Const_all_one(const ir_node *node);
Sebastian Hack's avatar
Sebastian Hack committed
452

Michael Beck's avatar
Michael Beck committed
453
454
455
/** Returns the source language type of a Const node.
 * Must be an atomic type.  Mode of type must be mode of node.
 */
Michael Beck's avatar
Michael Beck committed
456
FIRM_API ir_type  *get_Const_type(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
457
458

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

461
462
463
464
/** 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 entity attribute */
465
#define SYMCONST_HAS_ENT(kind) ((kind) == symconst_addr_ent || (kind) == symconst_ofs_ent)
466

467
468
469
/** Returns non-zero if s symconst kind has an enum_const attribute */
#define SYMCONST_HAS_ENUM(kind) ((kind) == symconst_enum_const)

Michael Beck's avatar
Michael Beck committed
470
/** Get the kind of the SymConst. */
Michael Beck's avatar
Michael Beck committed
471
FIRM_API symconst_kind get_SymConst_kind(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
472
/** Set the kind of the SymConst. */
Michael Beck's avatar
Michael Beck committed
473
FIRM_API void          set_SymConst_kind(ir_node *node, symconst_kind num);
Beyhan's avatar
Beyhan committed
474
475

/** Only to access SymConst of kind type_tag or size.  Else assertion: */
Michael Beck's avatar
Michael Beck committed
476
477
FIRM_API ir_type  *get_SymConst_type(const ir_node *node);
FIRM_API void     set_SymConst_type(ir_node *node, ir_type *tp);
Beyhan's avatar
Beyhan committed
478
479

/** Only to access SymConst of kind addr_ent.  Else assertion: */
Michael Beck's avatar
Michael Beck committed
480
481
FIRM_API ir_entity *get_SymConst_entity(const ir_node *node);
FIRM_API void       set_SymConst_entity(ir_node *node, ir_entity *ent);
Beyhan's avatar
Beyhan committed
482

483
/** Only to access SymConst of kind symconst_enum_const.  Else assertion: */
Michael Beck's avatar
Michael Beck committed
484
485
FIRM_API ir_enum_const *get_SymConst_enum(const ir_node *node);
FIRM_API void           set_SymConst_enum(ir_node *node, ir_enum_const *ec);
486

Beyhan's avatar
Beyhan committed
487
488
/** 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
489
/* write 'union': firmjni then does not create a method... */
Michael Beck's avatar
Michael Beck committed
490
491
FIRM_API union symconst_symbol get_SymConst_symbol(const ir_node *node);
FIRM_API void                  set_SymConst_symbol(ir_node *node,
492
                                                   union symconst_symbol sym);
493

Götz Lindenmaier's avatar
Götz Lindenmaier committed
494
495
496
/** Access the type of the value represented by the SymConst.
 *
 *  Example: primitive type int for SymConst size. */
Michael Beck's avatar
Michael Beck committed
497
498
499
500
501
502
503
504
505
506
507
508
509
FIRM_API ir_type *get_SymConst_value_type(const ir_node *node);
FIRM_API void    set_SymConst_value_type(ir_node *node, ir_type *tp);

FIRM_API ir_node   *get_Sel_mem(const ir_node *node);
FIRM_API void       set_Sel_mem(ir_node *node, ir_node *mem);
FIRM_API ir_node   *get_Sel_ptr(const ir_node *node);
FIRM_API void       set_Sel_ptr(ir_node *node, ir_node *ptr);
FIRM_API ir_node   **get_Sel_index_arr(ir_node *node);
FIRM_API int        get_Sel_n_indexs(const ir_node *node);
FIRM_API ir_node   *get_Sel_index(const ir_node *node, int pos);
FIRM_API void       set_Sel_index(ir_node *node, int pos, ir_node *index);
FIRM_API ir_entity *get_Sel_entity(const ir_node *node);
FIRM_API void       set_Sel_entity (ir_node *node, ir_entity *ent);
Christian Schäfer's avatar
Christian Schäfer committed
510

511
512
513
/**
 * Projection numbers for result of Call node: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
514
typedef enum {
515
	pn_Call_M         = pn_Generic_M,         /**< The memory result. */
516
517
518
519
520
521
	pn_Call_X_regular = pn_Generic_X_regular, /**< The control flow result when no exception occurs. */
	pn_Call_X_except  = pn_Generic_X_except,  /**< The control flow result branching to the exception handler. */
	pn_Call_T_result  = pn_Generic_other,     /**< The tuple containing all (0, 1, 2, ...) results. */
	pn_Call_P_value_res_base,                 /**< A pointer to the memory region containing copied results
	                                               passed by value (for compound result types). */
	pn_Call_max                               /**< number of projections from a Call */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
522
523
} pn_Call;   /* Projection numbers for Call. */

Michael Beck's avatar
Michael Beck committed
524
/** Retrieve the memory input of a Call. */
Michael Beck's avatar
Michael Beck committed
525
FIRM_API ir_node *get_Call_mem(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
526
/** Set the memory input of a Call. */
Michael Beck's avatar
Michael Beck committed
527
FIRM_API void     set_Call_mem(ir_node *node, ir_node *mem);
Michael Beck's avatar
Michael Beck committed
528
/** Retrieve the call address of a Call. */
Michael Beck's avatar
Michael Beck committed
529
FIRM_API ir_node *get_Call_ptr(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
530
/** Set the call address of a Call. */
Michael Beck's avatar
Michael Beck committed
531
532
FIRM_API void     set_Call_ptr(ir_node *node, ir_node *ptr);
FIRM_API ir_node **get_Call_param_arr(ir_node *node);
Michael Beck's avatar
Michael Beck committed
533
/** Gets the number of parameters of a call. */
Michael Beck's avatar
Michael Beck committed
534
FIRM_API int      get_Call_n_params(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
535
/** Gets the call parameter at position pos. */
Michael Beck's avatar
Michael Beck committed
536
FIRM_API ir_node *get_Call_param(const ir_node *node, int pos);
Michael Beck's avatar
Michael Beck committed
537
/** Sets the call parameter at position pos. */
Michael Beck's avatar
Michael Beck committed
538
FIRM_API void     set_Call_param(ir_node *node, int pos, ir_node *param);
Michael Beck's avatar
Michael Beck committed
539
/** Gets the type of a call. */
Michael Beck's avatar
Michael Beck committed
540
FIRM_API ir_type *get_Call_type(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
541
/** Sets the type of a call. */
Michael Beck's avatar
Michael Beck committed
542
FIRM_API void     set_Call_type(ir_node *node, ir_type *tp);
543
/** Returns non-zero if this call can be a tail-call. */
Michael Beck's avatar
Michael Beck committed
544
FIRM_API unsigned get_Call_tail_call(const ir_node *node);
545
/** Sets the tail call attribute. */
Michael Beck's avatar
Michael Beck committed
546
FIRM_API void     set_Call_tail_call(ir_node *node, unsigned tail_call);
Michael Beck's avatar
Michael Beck committed
547
548
549
550
551

/**
 * Returns non-zero if a Call is surely a self-recursive Call.
 * Beware: if this functions returns 0, the call might be self-recursive!
 */
Michael Beck's avatar
Michael Beck committed
552
FIRM_API int is_self_recursive_Call(const ir_node *call);
553

554
555
556
557
/** 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
558
559
560
561
 *  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.
562
563
564
565
566
567
568
569
570
 *
 *  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.
 */
Michael Beck's avatar
Michael Beck committed
571
572
573
FIRM_API int        Call_has_callees(const ir_node *node);
FIRM_API int        get_Call_n_callees(const ir_node *node);
FIRM_API ir_entity *get_Call_callee(const ir_node *node, int pos);
Michael Beck's avatar
Michael Beck committed
574

575
576
577
/** Set the full callee array.
 *
 *  The passed array is copied. Assumes current_ir_graph set properly! */
Michael Beck's avatar
Michael Beck committed
578
579
FIRM_API void set_Call_callee_arr(ir_node *node, const int n, ir_entity **arr);
FIRM_API void remove_Call_callee_arr(ir_node *node);
580

581
582
583
584
/**
 * Projection numbers for result of Builtin node: use for Proj nodes!
 */
typedef enum {
585
586
587
	pn_Builtin_M        = pn_Generic_M,     /**< The memory result. */
	pn_Builtin_1_result = pn_Generic_other, /**< first result. */
	pn_Builtin_max                          /**< number of projections from a Builtin */
588
589
} pn_Builtin;   /* Projection numbers for Builtin. */

Michael Beck's avatar
Michael Beck committed
590
591
592
593
594
FIRM_API ir_node         *get_Builtin_mem(const ir_node *node);
FIRM_API void            set_Builtin_mem(ir_node *node, ir_node *mem);
FIRM_API ir_builtin_kind get_Builtin_kind(const ir_node *node);
FIRM_API void            set_Builtin_kind(ir_node *node, ir_builtin_kind kind);
FIRM_API ir_node         **get_Builtin_param_arr(ir_node *node);
595
/** Gets the number of parameters of a Builtin. */
Michael Beck's avatar
Michael Beck committed
596
FIRM_API int             get_Builtin_n_params(const ir_node *node);
597
/** Gets the Builtin parameter at position pos. */
Michael Beck's avatar
Michael Beck committed
598
FIRM_API ir_node         *get_Builtin_param(const ir_node *node, int pos);
599
/** Sets the Builtin parameter at position pos. */
Michael Beck's avatar
Michael Beck committed
600
FIRM_API void            set_Builtin_param(ir_node *node, int pos, ir_node *param);
601
/** Gets the type of a builtin. */
Michael Beck's avatar
Michael Beck committed
602
FIRM_API ir_type         *get_Builtin_type(const ir_node *node);
603
/** Sets the type of a Builtin. */
Michael Beck's avatar
Michael Beck committed
604
FIRM_API void            set_Builtin_type(ir_node *node, ir_type *tp);
605
/** Returns a human readable string for the ir_builtin_kind. */
Michael Beck's avatar
Michael Beck committed
606
FIRM_API const char *get_builtin_kind_name(ir_builtin_kind kind);
607

Christian Schäfer's avatar
Christian Schäfer committed
608
609
610
/* 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
611
   unops are: Minus, Abs, Not, Conv, Cast
Christian Schäfer's avatar
Christian Schäfer committed
612
   binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
613
   Shr, Shrs, Rotl, Cmp */
Michael Beck's avatar
Michael Beck committed
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
FIRM_API int      is_unop(const ir_node *node);
FIRM_API ir_node *get_unop_op(const ir_node *node);
FIRM_API void     set_unop_op(ir_node *node, ir_node *op);
FIRM_API int      is_binop(const ir_node *node);
FIRM_API ir_node *get_binop_left(const ir_node *node);
FIRM_API void     set_binop_left(ir_node *node, ir_node *left);
FIRM_API ir_node *get_binop_right(const ir_node *node);
FIRM_API void     set_binop_right(ir_node *node, ir_node *right);

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

FIRM_API ir_node *get_Carry_left(const ir_node *node);
FIRM_API void     set_Carry_left(ir_node *node, ir_node *left);
FIRM_API ir_node *get_Carry_right(const ir_node *node);
FIRM_API void     set_Carry_right(ir_node *node, ir_node *right);

FIRM_API ir_node *get_Borrow_left(const ir_node *node);
FIRM_API void     set_Borrow_left(ir_node *node, ir_node *left);
FIRM_API ir_node *get_Borrow_right(const ir_node *node);
FIRM_API void     set_Borrow_right(ir_node *node, ir_node *right);

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

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

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

FIRM_API ir_node *get_Mulh_left(const ir_node *node);
FIRM_API void     set_Mulh_left(ir_node *node, ir_node *left);
FIRM_API ir_node *get_Mulh_right(const ir_node *node);
FIRM_API void     set_Mulh_right(ir_node *node, ir_node *right);

FIRM_API ir_node *get_Quot_left(const ir_node *node);
FIRM_API void     set_Quot_left(ir_node *node, ir_node *left);
FIRM_API ir_node *get_Quot_right(const ir_node *node);
FIRM_API void     set_Quot_right(ir_node *node, ir_node *right);
FIRM_API ir_node *get_Quot_mem(const ir_node *node);
FIRM_API void     set_Quot_mem(ir_node *node, ir_node *mem);
FIRM_API ir_mode *get_Quot_resmode(const ir_node *node);
FIRM_API void     set_Quot_resmode(ir_node *node, ir_mode *mode);
664

665
666
667
/**
 * Projection numbers for Quot: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
668
typedef enum {
669
	pn_Quot_M         = pn_Generic_M,         /**< Memory result. */
670
671
672
673
	pn_Quot_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
	pn_Quot_X_except  = pn_Generic_X_except,  /**< Execution result if exception occurred. */
	pn_Quot_res       = pn_Generic_other,     /**< Result of computation. */
	pn_Quot_max                               /**< number of projections from a Quot */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
674
675
} pn_Quot;  /* Projection numbers for Quot. */

Michael Beck's avatar
Michael Beck committed
676
677
678
679
680
681
682
683
FIRM_API ir_node *get_DivMod_left(const ir_node *node);
FIRM_API void     set_DivMod_left(ir_node *node, ir_node *left);
FIRM_API ir_node *get_DivMod_right(const ir_node *node);
FIRM_API void     set_DivMod_right(ir_node *node, ir_node *right);
FIRM_API ir_node *get_DivMod_mem(const ir_node *node);
FIRM_API void     set_DivMod_mem(ir_node *node, ir_node *mem);
FIRM_API ir_mode *get_DivMod_resmode(const ir_node *node);
FIRM_API void     set_DivMod_resmode(ir_node *node, ir_mode *mode);
684

685
686
687
/**
 * Projection numbers for DivMod: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
688
typedef enum {
689
	pn_DivMod_M         = pn_Generic_M,         /**< Memory result. */
690
691
692
693
694
	pn_DivMod_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
	pn_DivMod_X_except  = pn_Generic_X_except,  /**< Execution result if exception occurred. */
	pn_DivMod_res_div   = pn_Generic_other,     /**< Result of computation a / b. */
	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
695
696
} pn_DivMod;  /* Projection numbers for DivMod. */

Michael Beck's avatar
Michael Beck committed
697
698
699
700
701
702
703
704
705
706
FIRM_API ir_node *get_Div_left(const ir_node *node);
FIRM_API void     set_Div_left(ir_node *node, ir_node *left);
FIRM_API ir_node *get_Div_right(const ir_node *node);
FIRM_API void     set_Div_right(ir_node *node, ir_node *right);
FIRM_API ir_node *get_Div_mem(const ir_node *node);
FIRM_API void     set_Div_mem(ir_node *node, ir_node *mem);
FIRM_API ir_mode *get_Div_resmode(const ir_node *node);
FIRM_API void     set_Div_resmode(ir_node *node, ir_mode *mode);
FIRM_API int      get_Div_no_remainder(const ir_node *node);
FIRM_API void     set_Div_no_remainder(ir_node *node, int no_remainder);
707

708
709
710
/**
 * Projection numbers for Div: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
711
typedef enum {
712
	pn_Div_M         = pn_Generic_M,         /**< Memory result. */
713
714
715
716
	pn_Div_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
	pn_Div_X_except  = pn_Generic_X_except,  /**< Execution result if exception occurred. */
	pn_Div_res       = pn_Generic_other,     /**< Result of computation. */
	pn_Div_max                               /**< number of projections from a Div */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
717
718
} pn_Div;  /* Projection numbers for Div. */

Michael Beck's avatar
Michael Beck committed
719
720
721
722
723
724
725
726
FIRM_API ir_node *get_Mod_left(const ir_node *node);
FIRM_API void     set_Mod_left(ir_node *node, ir_node *left);
FIRM_API ir_node *get_Mod_right(const ir_node *node);
FIRM_API void     set_Mod_right(ir_node *node, ir_node *right);
FIRM_API ir_node *get_Mod_mem(const ir_node *node);
FIRM_API void     set_Mod_mem(ir_node *node, ir_node *mem);
FIRM_API ir_mode *get_Mod_resmode(const ir_node *node);
FIRM_API void     set_Mod_resmode(ir_node *node, ir_mode *mode);
727

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

Michael Beck's avatar
Michael Beck committed
739
740
FIRM_API ir_node *get_Abs_op(const ir_node *node);
FIRM_API void     set_Abs_op(ir_node *node, ir_node *op);
741

Michael Beck's avatar
Michael Beck committed
742
743
744
745
FIRM_API ir_node *get_And_left(const ir_node *node);
FIRM_API void     set_And_left(ir_node *node, ir_node *left);
FIRM_API ir_node *get_And_right(const ir_node *node);
FIRM_API void     set_And_right(ir_node *node, ir_node *right);
746

Michael Beck's avatar
Michael Beck committed
747
748
749
750
FIRM_API ir_node *get_Or_left(const ir_node *node);
FIRM_API void     set_Or_left(ir_node *node, ir_node *left);
FIRM_API ir_node *get_Or_right(const ir_node *node);
FIRM_API void     set_Or_right(ir_node *node, ir_node *right);
751

Michael Beck's avatar
Michael Beck committed
752
753
754
755
FIRM_API ir_node *get_Eor_left(const ir_node *node);
FIRM_API void     set_Eor_left(ir_node *node, ir_node *left);
FIRM_API ir_node *get_Eor_right(const ir_node *node);
FIRM_API void     set_Eor_right(ir_node *node, ir_node *right);
756

Michael Beck's avatar
Michael Beck committed
757
758
FIRM_API ir_node *get_Not_op(const ir_node *node);
FIRM_API void     set_Not_op(ir_node *node, ir_node *op);
Christian Schäfer's avatar
Christian Schäfer committed
759

Michael Beck's avatar
Michael Beck committed
760
/** returns the pnc name from an pnc constant */
Michael Beck's avatar
Michael Beck committed
761
FIRM_API const char *get_pnc_string(int pnc);
Michael Beck's avatar
Michael Beck committed
762

763
/** Calculates the negated (Complement(R)) pnc condition. */
Michael Beck's avatar
Michael Beck committed
764
FIRM_API pn_Cmp      get_negated_pnc(long pnc, ir_mode *mode);
Michael Beck's avatar
Michael Beck committed
765

766
/** Calculates the inversed (R^-1) pnc condition, i.e., "<" --> ">" */
Michael Beck's avatar
Michael Beck committed
767
FIRM_API pn_Cmp      get_inversed_pnc(long pnc);
Michael Beck's avatar
Michael Beck committed
768

769
770
771
/** An alternative name for get_inversed_pnc() that can be better memorized. */
#define get_mirrored_pnc(pnc)  get_inversed_pnc(pnc)

Michael Beck's avatar
Michael Beck committed
772
773
774
775
FIRM_API ir_node *get_Cmp_left(const ir_node *node);
FIRM_API void     set_Cmp_left(ir_node *node, ir_node *left);
FIRM_API ir_node *get_Cmp_right(const ir_node *node);
FIRM_API void     set_Cmp_right(ir_node *node, ir_node *right);
776

Michael Beck's avatar
Michael Beck committed
777
778
779
780
FIRM_API ir_node *get_Shl_left(const ir_node *node);
FIRM_API void     set_Shl_left(ir_node *node, ir_node *left);
FIRM_API ir_node *get_Shl_right(const ir_node *node);
FIRM_API void     set_Shl_right(ir_node *node, ir_node *right);
781

Michael Beck's avatar
Michael Beck committed
782
783
784
785
FIRM_API ir_node *get_Shr_left(const ir_node *node);
FIRM_API void     set_Shr_left(ir_node *node, ir_node *left);
FIRM_API ir_node *get_Shr_right(const ir_node *node);
FIRM_API void     set_Shr_right(ir_node *node, ir_node *right);
786

Michael Beck's avatar
Michael Beck committed
787
788
789
790
FIRM_API ir_node *get_Shrs_left(const ir_node *node);
FIRM_API void     set_Shrs_left(ir_node *node, ir_node *left);
FIRM_API ir_node *get_Shrs_right(const ir_node *node);
FIRM_API void     set_Shrs_right(ir_node *node, ir_node *right);
791

Michael Beck's avatar
Michael Beck committed
792
793
794
795
FIRM_API ir_node *get_Rotl_left(const ir_node *node);
FIRM_API void     set_Rotl_left(ir_node *node, ir_node *left);
FIRM_API ir_node *get_Rotl_right(const ir_node *node);
FIRM_API void     set_Rotl_right(ir_node *node, ir_node *right);
796

Michael Beck's avatar
Michael Beck committed
797
798
799
800
FIRM_API ir_node *get_Conv_op(const ir_node *node);
FIRM_API void     set_Conv_op(ir_node *node, ir_node *op);
FIRM_API int      get_Conv_strict(const ir_node *node);
FIRM_API void     set_Conv_strict(ir_node *node, int flag);
801

Götz Lindenmaier's avatar
comment    
Götz Lindenmaier committed
802
803
/* 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
804
 * entity.  But:  we initialize various fields after Alloc, that
Götz Lindenmaier's avatar
comment    
Götz Lindenmaier committed
805
806
807
 * are accessed in the cast.  This required some precaution, to
 * get the right memory into the Loads generated from the cast.
 */
Michael Beck's avatar
Michael Beck committed
808
809
810
811
FIRM_API ir_node *get_Cast_op(const ir_node *node);
FIRM_API void     set_Cast_op(ir_node *node, ir_node *op);
FIRM_API ir_type *get_Cast_type(const ir_node *node);
FIRM_API void     set_Cast_type(ir_node *node, ir_type *to_tp);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
812

Götz Lindenmaier's avatar
Götz Lindenmaier committed
813
814
815
816
/** Checks for upcast.
 *
 * Returns true if the Cast node casts a class type to a super type.
 * Works also for pointers to classes (recursively).
817
818
 *
 * Needs typeinfo calculated.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
819
 */
Michael Beck's avatar
Michael Beck committed
820
FIRM_API int is_Cast_upcast(ir_node *node);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
821
822
823
824
825

/** Checks for downcast.
 *
 * Returns true if the Cast node casts a class type to a sub type.
 * Works also for pointers to classes (recursively).
826
827
 *
 * Needs typeinfo calculated.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
828
 */
Michael Beck's avatar
Michael Beck committed
829
FIRM_API int is_Cast_downcast(ir_node *node);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
830
831


832
/** Returns true if n is a Phi.
Michael Beck's avatar
Michael Beck committed
833
   Returns false if irg is in phase phase_building and the Phi has zero
Götz Lindenmaier's avatar
Götz Lindenmaier committed
834
   predecessors: it's a Phi0. */
Michael Beck's avatar
Michael Beck committed
835
FIRM_API int       is_Phi(const ir_node *n);
Michael Beck's avatar
Michael Beck committed
836
/** Returns true if irg in phase phase_building and the Phi has zero
837
   predecessors. It's a Phi0 then. */
Michael Beck's avatar
Michael Beck committed
838
839
840
841
842
FIRM_API int       is_Phi0(const ir_node *n);
FIRM_API ir_node **get_Phi_preds_arr(ir_node *node);
FIRM_API int       get_Phi_n_preds(const ir_node *node);
FIRM_API ir_node  *get_Phi_pred(const ir_node *node, int pos);
FIRM_API void      set_Phi_pred(ir_node *node, int pos, ir_node *pred);
843
844
845
/**
 * Returns the next element of a block phi list.
 */
Michael Beck's avatar
Michael Beck committed
846
FIRM_API ir_node  *get_Phi_next(const ir_node *phi);
847
848
849
/**
 * Sets the next link of a block Phi list.
 */
Michael Beck's avatar
Michael Beck committed
850
FIRM_API void      set_Phi_next(ir_node *phi, ir_node *next);
851

852
853
/** Return true if parameter is a memory operation.
 *
Götz Lindenmaier's avatar
Götz Lindenmaier committed
854
 *  A memory operation is an operation that changes the
855
856
 *  memory.  I.e., a Load or a Store operation.
 */
Michael Beck's avatar
Michael Beck committed
857
858
859
860
861
FIRM_API int      is_memop(const ir_node *node);
FIRM_API ir_node *get_memop_mem(const ir_node *node);
FIRM_API void     set_memop_mem(ir_node *node, ir_node *mem);
FIRM_API ir_node *get_memop_ptr(const ir_node *node);
FIRM_API void     set_memop_ptr(ir_node *node, ir_node *ptr);
862

863
864
865
/**
 * Projection numbers for Load: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
866
typedef enum {
867
	pn_Load_M         = pn_Generic_M,         /**< Memory result. */
868
869
870
871
	pn_Load_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
	pn_Load_X_except  = pn_Generic_X_except,  /**< Execution result if exception occurred. */
	pn_Load_res       = pn_Generic_other,     /**< Result of load operation. */
	pn_Load_max                               /**< number of projections from a Load */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
872
873
} pn_Load;  /* Projection numbers for Load. */

Michael Beck's avatar
Michael Beck committed
874
875
876
877
878
879
880
881
882
883
FIRM_API ir_node       *get_Load_mem(const ir_node *node);
FIRM_API void           set_Load_mem(ir_node *node, ir_node *mem);
FIRM_API ir_node       *get_Load_ptr(const ir_node *node);
FIRM_API void           set_Load_ptr(ir_node *node, ir_node *ptr);
FIRM_API ir_mode       *get_Load_mode(const ir_node *node);
FIRM_API void           set_Load_mode(ir_node *node, ir_mode *mode);
FIRM_API ir_volatility  get_Load_volatility(const ir_node *node);
FIRM_API void           set_Load_volatility(ir_node *node, ir_volatility volatility);
FIRM_API ir_align       get_Load_align(const ir_node *node);
FIRM_API void           set_Load_align(ir_node *node, ir_align align);
884

885
886
887
/**
 * Projection numbers for Store: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
888
typedef enum {
889
	pn_Store_M         = pn_Generic_M,         /**< Memory result. */
Michael Beck's avatar
Michael Beck committed
890
891
892
	pn_Store_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
	pn_Store_X_except  = pn_Generic_X_except,  /**< Execution result if exception occurred. */
	pn_Store_max       = pn_Generic_other      /**< number of projections from a Store */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
893
894
} pn_Store;  /* Projection numbers for Store. */

Michael Beck's avatar
Michael Beck committed
895
896