irnode.h 51.9 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

70
71
72
/* include projnumber enums generated by specification */
#include "projnumbers.h"

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

81
82
83
84
85
/**
 * Returns the number of predecessors without the block predecessor.
 *
 * @param node   the IR-node
 */
Michael Beck's avatar
Michael Beck committed
86
FIRM_API int get_irn_arity      (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
87
88

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

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

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

Sebastian Hack's avatar
Sebastian Hack committed
109
/**
110
111
112
113
114
115
116
117
118
 * 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
119
FIRM_API int add_irn_dep(ir_node *node, ir_node *dep);
Sebastian Hack's avatar
Sebastian Hack committed
120
121
122

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

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

/**
Michael Beck's avatar
Michael Beck committed
138
139
140
141
142
 * 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
143
FIRM_API ir_node *get_irn_dep(const ir_node *node, int pos);
Sebastian Hack's avatar
Sebastian Hack committed
144
145

/**
Michael Beck's avatar
Michael Beck committed
146
147
148
149
150
 * 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
151
FIRM_API void set_irn_dep(ir_node *node, int pos, ir_node *dep);
Sebastian Hack's avatar
Sebastian Hack committed
152

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

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

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

204
/** Returns the ir_graph this node belongs to. */
Michael Beck's avatar
Michael Beck committed
205
FIRM_API ir_graph *get_irn_irg(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
206

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

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

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

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

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

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

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

Michael Beck's avatar
Michael Beck committed
266
267
268
269
270
271
272
273
274
275
276
/**
 * 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
277
FIRM_API ir_node *get_nodes_MacroBlock(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
278

279
280
281
282
/** 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
283
FIRM_API ir_type *is_frame_pointer(const ir_node *n);
284

285
/** Test whether arbitrary node is the thread local storage (tls) pointer.
286
287
288
 *
 * 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
289
FIRM_API ir_type *is_tls_pointer(const ir_node *n);
290

291
/** Return the number of control flow predecessors of a block. */
Michael Beck's avatar
Michael Beck committed
292
FIRM_API int get_Block_n_cfgpreds(const ir_node *block);
293
/** Return the control flow predecessor of a block at a given position. */
Michael Beck's avatar
Michael Beck committed
294
FIRM_API ir_node *get_Block_cfgpred(const ir_node *block, int pos);
295
/** Set the control flow predecessor of a block at a given position. */
Michael Beck's avatar
Michael Beck committed
296
FIRM_API void set_Block_cfgpred(ir_node *block, int pos, ir_node *pred);
297
298
299
300
301
302
303
304
305
306
307
308
309
310

/**
 * 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
311
FIRM_API int get_Block_cfgpred_pos(const ir_node *block, const ir_node *pred);
312

313
314
/** Get the predecessor block.
 *
315
 *  Returns the block corresponding to the predecessor pos of block.
316
317
318
319
320
321
 *
 *  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
322
 *    Start block, but the Bad node.
323
 */
Michael Beck's avatar
Michael Beck committed
324
FIRM_API ir_node *get_Block_cfgpred_block(const ir_node *node, int pos);
325
326

/** Return the matured flag of a block */
Michael Beck's avatar
Michael Beck committed
327
FIRM_API int get_Block_matured(const ir_node *block);
328
/** set the matured flag of a block. */
Michael Beck's avatar
Michael Beck committed
329
FIRM_API void set_Block_matured(ir_node *block, int matured);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
330
331
332

/** 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
333
334
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);
335
336
337
338
339

/**
 * 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
340
341
FIRM_API ir_node *set_Block_dead(ir_node *block);
FIRM_API int is_Block_dead(const ir_node *block);
342

Götz Lindenmaier's avatar
Götz Lindenmaier committed
343
/* For this current_ir_graph must be set. */
Michael Beck's avatar
Michael Beck committed
344
345
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
346

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

Michael Beck's avatar
Michael Beck committed
378
/** Return the number of Keep alive node. */
Michael Beck's avatar
Michael Beck committed
379
FIRM_API int get_End_n_keepalives(const ir_node *end);
Michael Beck's avatar
Michael Beck committed
380
/** Return the Keep alive node a position pos. */
Michael Beck's avatar
Michael Beck committed
381
FIRM_API ir_node *get_End_keepalive(const ir_node *end, int pos);
Michael Beck's avatar
Michael Beck committed
382
/** Keep alive dedicated nodes.  These must be either PhiM or Block nodes. */
Michael Beck's avatar
Michael Beck committed
383
FIRM_API void add_End_keepalive(ir_node *end, ir_node *ka);
Michael Beck's avatar
Michael Beck committed
384
/** Set the Keep alive node at position pos. */
Michael Beck's avatar
Michael Beck committed
385
FIRM_API void set_End_keepalive(ir_node *end, int pos, ir_node *ka);
386
387
388
389
390
391

/**
 * 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
392
FIRM_API void set_End_keepalives(ir_node *end, int n, ir_node *in[]);
393
394

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

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

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

405
/** Return the target address of an IJmp */
Michael Beck's avatar
Michael Beck committed
406
FIRM_API ir_node *get_IJmp_target(const ir_node *ijmp);
407
/** Sets the target address of an IJmp */
Michael Beck's avatar
Michael Beck committed
408
FIRM_API void set_IJmp_target(ir_node *ijmp, ir_node *tgt);
409

Michael Beck's avatar
Michael Beck committed
410
411
412
413
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
414

Michael Beck's avatar
Michael Beck committed
415
416
417
418
419
420
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
421

Michael Beck's avatar
Michael Beck committed
422
423
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
424

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

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

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

Michael Beck's avatar
Michael Beck committed
434
435
436
/** 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
437
FIRM_API ir_type  *get_Const_type(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
438
439

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

442
443
444
445
/** 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 */
446
#define SYMCONST_HAS_ENT(kind) ((kind) == symconst_addr_ent || (kind) == symconst_ofs_ent)
447

448
449
450
/** 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
451
/** Get the kind of the SymConst. */
Michael Beck's avatar
Michael Beck committed
452
FIRM_API symconst_kind get_SymConst_kind(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
453
/** Set the kind of the SymConst. */
Michael Beck's avatar
Michael Beck committed
454
FIRM_API void          set_SymConst_kind(ir_node *node, symconst_kind num);
Beyhan's avatar
Beyhan committed
455
456

/** Only to access SymConst of kind type_tag or size.  Else assertion: */
Michael Beck's avatar
Michael Beck committed
457
458
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
459
460

/** Only to access SymConst of kind addr_ent.  Else assertion: */
Michael Beck's avatar
Michael Beck committed
461
462
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
463

464
/** Only to access SymConst of kind symconst_enum_const.  Else assertion: */
Michael Beck's avatar
Michael Beck committed
465
466
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);
467

Beyhan's avatar
Beyhan committed
468
469
/** 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
470
/* write 'union': firmjni then does not create a method... */
Michael Beck's avatar
Michael Beck committed
471
472
FIRM_API union symconst_symbol get_SymConst_symbol(const ir_node *node);
FIRM_API void                  set_SymConst_symbol(ir_node *node,
473
                                                   union symconst_symbol sym);
474

Götz Lindenmaier's avatar
Götz Lindenmaier committed
475
476
477
/** Access the type of the value represented by the SymConst.
 *
 *  Example: primitive type int for SymConst size. */
Michael Beck's avatar
Michael Beck committed
478
479
480
481
482
483
484
485
486
487
488
489
490
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
491

Michael Beck's avatar
Michael Beck committed
492
/** Retrieve the memory input of a Call. */
Michael Beck's avatar
Michael Beck committed
493
FIRM_API ir_node *get_Call_mem(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
494
/** Set the memory input of a Call. */
Michael Beck's avatar
Michael Beck committed
495
FIRM_API void     set_Call_mem(ir_node *node, ir_node *mem);
Michael Beck's avatar
Michael Beck committed
496
/** Retrieve the call address of a Call. */
Michael Beck's avatar
Michael Beck committed
497
FIRM_API ir_node *get_Call_ptr(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
498
/** Set the call address of a Call. */
Michael Beck's avatar
Michael Beck committed
499
500
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
501
/** Gets the number of parameters of a call. */
Michael Beck's avatar
Michael Beck committed
502
FIRM_API int      get_Call_n_params(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
503
/** Gets the call parameter at position pos. */
Michael Beck's avatar
Michael Beck committed
504
FIRM_API ir_node *get_Call_param(const ir_node *node, int pos);
Michael Beck's avatar
Michael Beck committed
505
/** Sets the call parameter at position pos. */
Michael Beck's avatar
Michael Beck committed
506
FIRM_API void     set_Call_param(ir_node *node, int pos, ir_node *param);
Michael Beck's avatar
Michael Beck committed
507
/** Gets the type of a call. */
Michael Beck's avatar
Michael Beck committed
508
FIRM_API ir_type *get_Call_type(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
509
/** Sets the type of a call. */
Michael Beck's avatar
Michael Beck committed
510
FIRM_API void     set_Call_type(ir_node *node, ir_type *tp);
511
/** Returns non-zero if this call can be a tail-call. */
Michael Beck's avatar
Michael Beck committed
512
FIRM_API unsigned get_Call_tail_call(const ir_node *node);
513
/** Sets the tail call attribute. */
Michael Beck's avatar
Michael Beck committed
514
FIRM_API void     set_Call_tail_call(ir_node *node, unsigned tail_call);
Michael Beck's avatar
Michael Beck committed
515
516
517
518
519

/**
 * 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
520
FIRM_API int is_self_recursive_Call(const ir_node *call);
521

522
523
524
525
/** 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
526
527
528
529
 *  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.
530
531
532
533
534
535
536
537
538
 *
 *  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
539
540
541
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
542

543
544
545
/** Set the full callee array.
 *
 *  The passed array is copied. Assumes current_ir_graph set properly! */
Michael Beck's avatar
Michael Beck committed
546
547
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);
548

Michael Beck's avatar
Michael Beck committed
549
550
551
552
553
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);
554
/** Gets the number of parameters of a Builtin. */
Michael Beck's avatar
Michael Beck committed
555
FIRM_API int             get_Builtin_n_params(const ir_node *node);
556
/** Gets the Builtin parameter at position pos. */
Michael Beck's avatar
Michael Beck committed
557
FIRM_API ir_node         *get_Builtin_param(const ir_node *node, int pos);
558
/** Sets the Builtin parameter at position pos. */
Michael Beck's avatar
Michael Beck committed
559
FIRM_API void            set_Builtin_param(ir_node *node, int pos, ir_node *param);
560
/** Gets the type of a builtin. */
Michael Beck's avatar
Michael Beck committed
561
FIRM_API ir_type         *get_Builtin_type(const ir_node *node);
562
/** Sets the type of a Builtin. */
Michael Beck's avatar
Michael Beck committed
563
FIRM_API void            set_Builtin_type(ir_node *node, ir_type *tp);
564
/** Returns a human readable string for the ir_builtin_kind. */
Michael Beck's avatar
Michael Beck committed
565
FIRM_API const char *get_builtin_kind_name(ir_builtin_kind kind);
566

Christian Schäfer's avatar
Christian Schäfer committed
567
568
569
/* For unary and binary arithmetic operations the access to the
   operands can be factored out.  Left is the first, right the
   second arithmetic value  as listed in tech report 1999-44.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
570
   unops are: Minus, Abs, Not, Conv, Cast
Christian Schäfer's avatar
Christian Schäfer committed
571
   binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
572
   Shr, Shrs, Rotl, Cmp */
Michael Beck's avatar
Michael Beck committed
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
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_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);
613

Michael Beck's avatar
Michael Beck committed
614
615
616
617
618
619
620
621
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);
622

Michael Beck's avatar
Michael Beck committed
623
624
625
626
627
628
629
630
631
632
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);
633

Michael Beck's avatar
Michael Beck committed
634
635
636
637
638
639
640
641
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);
642

Michael Beck's avatar
Michael Beck committed
643
644
FIRM_API ir_node *get_Abs_op(const ir_node *node);
FIRM_API void     set_Abs_op(ir_node *node, ir_node *op);
645

Michael Beck's avatar
Michael Beck committed
646
647
648
649
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);
650

Michael Beck's avatar
Michael Beck committed
651
652
653
654
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);
655

Michael Beck's avatar
Michael Beck committed
656
657
658
659
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);
660

Michael Beck's avatar
Michael Beck committed
661
662
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
663

Michael Beck's avatar
Michael Beck committed
664
/** returns the pnc name from an pnc constant */
Michael Beck's avatar
Michael Beck committed
665
FIRM_API const char *get_pnc_string(int pnc);
Michael Beck's avatar
Michael Beck committed
666

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

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

673
674
675
/** 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
676
677
678
679
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);
680

Michael Beck's avatar
Michael Beck committed
681
682
683
684
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);
685

Michael Beck's avatar
Michael Beck committed
686
687
688
689
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);
690

Michael Beck's avatar
Michael Beck committed
691
692
693
694
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);
695

Michael Beck's avatar
Michael Beck committed
696
697
698
699
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);
700

Michael Beck's avatar
Michael Beck committed
701
702
703
704
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);
705

Götz Lindenmaier's avatar
comment    
Götz Lindenmaier committed
706
707
/* 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
708
 * entity.  But:  we initialize various fields after Alloc, that
Götz Lindenmaier's avatar
comment    
Götz Lindenmaier committed
709
710
711
 * 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
712
713
714
715
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
716

Götz Lindenmaier's avatar
Götz Lindenmaier committed
717
718
719
720
/** Checks for upcast.
 *
 * Returns true if the Cast node casts a class type to a super type.
 * Works also for pointers to classes (recursively).
721
722
 *
 * Needs typeinfo calculated.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
723
 */
Michael Beck's avatar
Michael Beck committed
724
FIRM_API int is_Cast_upcast(ir_node *node);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
725
726
727
728
729

/** Checks for downcast.
 *
 * Returns true if the Cast node casts a class type to a sub type.
 * Works also for pointers to classes (recursively).
730
731
 *
 * Needs typeinfo calculated.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
732
 */
Michael Beck's avatar
Michael Beck committed
733
FIRM_API int is_Cast_downcast(ir_node *node);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
734
735


736
/** Returns true if n is a Phi.
Michael Beck's avatar
Michael Beck committed
737
   Returns false if irg is in phase phase_building and the Phi has zero
Götz Lindenmaier's avatar
Götz Lindenmaier committed
738
   predecessors: it's a Phi0. */
Michael Beck's avatar
Michael Beck committed
739
FIRM_API int       is_Phi(const ir_node *n);
Michael Beck's avatar
Michael Beck committed
740
/** Returns true if irg in phase phase_building and the Phi has zero
741
   predecessors. It's a Phi0 then. */
Michael Beck's avatar
Michael Beck committed
742
743
744
745
746
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);
747
748
749
/**
 * Returns the next element of a block phi list.
 */
Michael Beck's avatar
Michael Beck committed
750
FIRM_API ir_node  *get_Phi_next(const ir_node *phi);
751
752
753
/**
 * Sets the next link of a block Phi list.
 */
Michael Beck's avatar
Michael Beck committed
754
FIRM_API void      set_Phi_next(ir_node *phi, ir_node *next);
755

756
757
/** Return true if parameter is a memory operation.
 *
Götz Lindenmaier's avatar
Götz Lindenmaier committed
758
 *  A memory operation is an operation that changes the
759
760
 *  memory.  I.e., a Load or a Store operation.
 */
Michael Beck's avatar
Michael Beck committed
761
762
763
764
765
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);
766

Michael Beck's avatar
Michael Beck committed
767
768
769
770
771
772
773
774
775
776
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);
777

Michael Beck's avatar
Michael Beck committed
778
779
780
781
782
783
784
785
786
787
FIRM_API ir_node       *get_Store_mem(const ir_node *node);
FIRM_API void           set_Store_mem(ir_node *node, ir_node *mem);
FIRM_API ir_node       *get_Store_ptr(const ir_node *node);
FIRM_API void           set_Store_ptr(ir_node *node, ir_node *ptr);
FIRM_API ir_node       *get_Store_value(const ir_node *node);
FIRM_API void           set_Store_value(ir_node *node, ir_node *value);
FIRM_API ir_volatility  get_Store_volatility(const ir_node *node);
FIRM_API void           set_Store_volatility(ir_node *node, ir_volatility volatility);
FIRM_API ir_align       get_Store_align(const ir_node *node);
FIRM_API void           set_Store_align(ir_node *node, ir_align align);
788

Michael Beck's avatar
Michael Beck committed
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
FIRM_API ir_node *get_Alloc_mem(const ir_node *node);
FIRM_API void     set_Alloc_mem(ir_node *node, ir_node *mem);
FIRM_API ir_node *get_Alloc_count(const ir_node *node);
FIRM_API void     set_Alloc_count(ir_node *node, ir_node *count);
FIRM_API ir_type *get_Alloc_type(const ir_node *node);
FIRM_API void     set_Alloc_type(ir_node *node, ir_type *tp);

FIRM_API ir_where_alloc get_Alloc_where(const ir_node *node);
FIRM_API void           set_Alloc_where(ir_node *node, ir_where_alloc where);

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

FIRM_API ir_where_alloc get_Free_where(const ir_node *node);
FIRM_API void           set_Free_where(ir_node *node, ir_where_alloc where);

FIRM_API ir_node **get_Sync_preds_arr(ir_node *node);
FIRM_API int       get_Sync_n_preds(const ir_node *node);
FIRM_API ir_node  *get_Sync_pred(const ir_node *node, int pos);
FIRM_API void      set_Sync_pred(ir_node *node, int pos, ir_node *pred);
FIRM_API void      add_Sync_pred(ir_node *node, ir_node *pred);
816

817
818
819
/** Returns the source language type of a Proj node.
 * Must be an atomic type.  Mode of type must be mode of node.
 */
Michael Beck's avatar
Michael Beck committed
820
FIRM_API ir_type  *get_Proj_type(const ir_node *node);
821
822

/** Return the predecessor of a Proj node. */
Michael Beck's avatar
Michael Beck committed
823
824
FIRM_API ir_node  *get_Proj_pred(const ir_node *node);
FIRM_API void      set_Proj_pred(ir_node *node, ir_node *pred);
825
/** Return the projection number of a Proj node. */
Michael Beck's avatar
Michael Beck committed
826
827
FIRM_API long      get_Proj_proj(const ir_node *node);
FIRM_API void      set_Proj_proj(ir_node *node, long proj);
828

Michael Beck's avatar
Michael Beck committed
829
830
831
832
833
/**
 * Returns non-zero if a node is a routine parameter.
 *
 * @param node  the Proj node to test
 */
Michael Beck's avatar
Michael Beck committed
834
FIRM_API int is_arg_Proj(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
835

Michael Beck's avatar
Michael Beck committed
836
837
838
839
FIRM_API ir_node **get_Tuple_preds_arr(ir_node *node);
FIRM_API int       get_Tuple_n_preds(const ir_node *node);
FIRM_API ir_node  *get_Tuple_pred(const ir_node *node, int pos);
FIRM_API void      set_Tuple_pred(ir_node *node, int pos, ir_node *pred);
840

Michael Beck's avatar
Michael Beck committed
841
842
FIRM_API ir_node  *get_Id_pred(const ir_node *node);
FIRM_API void      set_Id_pred(ir_node *node, ir_node *pred);
843

Götz Lindenmaier's avatar
Götz Lindenmaier committed
844
845
846
/** Confirm has a single result and returns 'value' unchanged.
 *  The node expresses a restriction on 'value':
 *  'value' 'cmp' 'bound' == true.                                 */
Michael Beck's avatar
Michael Beck committed
847
848
849
850
851
852
FIRM_API ir_node      *get_Confirm_value(const ir_node *node);
FIRM_API void          set_Confirm_value(ir_node *node, ir_node *value);
FIRM_API ir_node      *get_Confirm_bound(const ir_node *node);
FIRM_API void          set_Confirm_bound(ir_node *node, ir_node *bound);
FIRM_API pn_Cmp        get_Confirm_cmp(const ir_node *node);
FIRM_API void          set_Confirm_cmp(ir_node *node, pn_Cmp cmp);
Christian Schäfer's avatar
Christian Schäfer committed
853

Michael Beck's avatar
Michael Beck committed
854
/*
855
 * Mux Support
Michael Beck's avatar
Michael Beck committed
856
 */
Michael Beck's avatar
Michael Beck committed
857
858
859
860
861
862
FIRM_API ir_node *get_Mux_sel(const ir_node *node);
FIRM_API void     set_Mux_sel(ir_node *node, ir_node *sel);
FIRM_API ir_node *get_Mux_false(const ir_node *node);
FIRM_API void     set_Mux_false(ir_node *node, ir_node *ir_false);
FIRM_API ir_node *get_Mux_true(const ir_node *node);
FIRM_API void     set_Mux_true(ir_node *node, ir_node *ir_true);
863

Michael Beck's avatar
Michael Beck committed
864
865
866
867
868
869
870
871
FIRM_API ir_node *get_CopyB_mem(const ir_node *node);
FIRM_API void     set_CopyB_mem(ir_node *node, ir_node *mem);
FIRM_API ir_node *get_CopyB_dst(const ir_node *node);
FIRM_API void     set_CopyB_dst(ir_node *node, ir_node *dst);
FIRM_API ir_node *get_CopyB_src(const ir_node *node);
FIRM_API void     set_CopyB_src(ir_node *node, ir_node *src);
FIRM_API ir_type *get_CopyB_type(const ir_node *node);
FIRM_API void     set_CopyB_type(ir_node *node, ir_type *data_type);
872

Michael Beck's avatar
Michael Beck committed
873
/** InstOf access. */
Michael Beck's avatar
Michael Beck committed
874
875
876
877
878
879
FIRM_API ir_type *get_InstOf_type(const ir_node *node);
FIRM_API void    set_InstOf_type(ir_node *node, ir_type *type);
FIRM_API ir_node *get_InstOf_store(const ir_node *node);
FIRM_API void    set_InstOf_store(ir_node *node, ir_node *obj);
FIRM_API ir_node *get_InstOf_obj(const ir_node *node);
FIRM_API void    set_InstOf_obj(ir_node *node, ir_node *obj);
880

Michael Beck's avatar
Michael Beck committed
881
882
883
884
FIRM_API ir_node *get_Raise_mem(const ir_node *node);
FIRM_API void     set_Raise_mem(ir_node *node, ir_node *mem);
FIRM_API ir_node *get_Raise_exo_ptr(const ir_node *node);  /* PoinTeR to EXception Object */
FIRM_API void     set_Raise_exo_ptr(ir_node *node, ir_node *exoptr);
885

Michael Beck's avatar
Michael Beck committed
886
/** Returns the memory input of a Bound operation. */
Michael Beck's avatar
Michael Beck committed
887
888
FIRM_API ir_node *get_Bound_mem(const ir_node *bound);
FIRM_API void     set_Bound_mem(ir_node *bound, ir_node *mem);
Michael Beck's avatar
Michael Beck committed
889
890

/** Returns the index input of a Bound operation. */
Michael Beck's avatar
Michael Beck committed
891
892
FIRM_API ir_node *get_Bound_index(const ir_node *bound);
FIRM_API void     set_Bound_index(ir_node *bound, ir_node *idx);
Michael Beck's avatar
Michael Beck committed
893
894

/** Returns the lower bound input of a Bound operation. */