irnode.h 31.3 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
/**
 * @file
 * @brief   Representation of an intermediate operation.
 * @author  Martin Trapp, Christian Schaefer, Goetz Lindenmaier, Michael Beck
Michael Beck's avatar
Michael Beck committed
24
 */
Matthias Braun's avatar
Matthias Braun committed
25
26
#ifndef FIRM_IR_IRNODE_H
#define FIRM_IR_IRNODE_H
Christian Schäfer's avatar
Christian Schäfer committed
27

28
29
#include <stddef.h>

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

/**
Matthias Braun's avatar
Matthias Braun committed
38
 * @ingroup ir_graph
Matthias Braun's avatar
Matthias Braun committed
39
 * @defgroup ir_node Nodes
Götz Lindenmaier's avatar
Götz Lindenmaier committed
40
 *
Michael Beck's avatar
Michael Beck committed
41
 * ir_node - a datatype representing a Firm node
Götz Lindenmaier's avatar
Götz Lindenmaier committed
42
 *
Michael Beck's avatar
Michael Beck committed
43
44
45
46
47
48
49
50
51
52
53
54
55
 *  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
56
 */
Michael Beck's avatar
Michael Beck committed
57

Sebastian Felis's avatar
Sebastian Felis committed
58
/**
59
60
61
62
 * Checks whether a pointer points to a ir node. This is guessed by looking
 * at the few bytes of the thing. Most things used in firm have a firm_kind
 * attribute there. This function might falsely return true though for things
 * without a firm_kind at the beginning.
Sebastian Felis's avatar
Sebastian Felis committed
63
 *
64
65
 * @param thing   an arbitrary pointer
 * @return        non-zero if the thing is a ir mode, else zero
Sebastian Felis's avatar
Sebastian Felis committed
66
 */
67
FIRM_API int is_ir_node(const void *thing);
Sebastian Felis's avatar
Sebastian Felis committed
68

69
70
71
72
73
/**
 * Returns the number of predecessors without the block predecessor.
 *
 * @param node   the IR-node
 */
74
FIRM_API int get_irn_arity(const ir_node *node);
75
76

/**
77
 * Returns the n-th predecessor of a node.
78
79
 * This function removes Id predecessors.
 */
Michael Beck's avatar
Michael Beck committed
80
FIRM_API ir_node *get_irn_n(const ir_node *node, int n);
Michael Beck's avatar
Michael Beck committed
81

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

Sebastian Hack's avatar
Sebastian Hack committed
91
/**
92
93
94
95
96
97
98
99
100
 * 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
101
FIRM_API int add_irn_dep(ir_node *node, ir_node *dep);
Sebastian Hack's avatar
Sebastian Hack committed
102
103
104

/**
 * Copy all dependencies from a node to another.
105
106
 * This is only allowed in phase_backend!
 *
107
 * @param tgt The node which should be enriched.
Sebastian Hack's avatar
Sebastian Hack committed
108
109
 * @param src The node whose dependencies shall be copied.
 */
Michael Beck's avatar
Michael Beck committed
110
FIRM_API void add_irn_deps(ir_node *tgt, ir_node *src);
Sebastian Hack's avatar
Sebastian Hack committed
111
112

/**
113
 * Returns the length of the dependency array.
Michael Beck's avatar
Michael Beck committed
114
115
116
 * @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
117
FIRM_API int get_irn_deps(const ir_node *node);
Sebastian Hack's avatar
Sebastian Hack committed
118
119

/**
120
 * Returns an entry of the dependency array.
Michael Beck's avatar
Michael Beck committed
121
122
123
124
 * @param node The node.
 * @param pos  The position.
 * @return The node at that position.
 */
Michael Beck's avatar
Michael Beck committed
125
FIRM_API ir_node *get_irn_dep(const ir_node *node, int pos);
Sebastian Hack's avatar
Sebastian Hack committed
126
127

/**
128
 * Sets an entry of the dependency array.
Michael Beck's avatar
Michael Beck committed
129
130
131
132
 * @param node The node.
 * @param pos  The position.
 * @param dep  The dependency target.
 */
Michael Beck's avatar
Michael Beck committed
133
FIRM_API void set_irn_dep(ir_node *node, int pos, ir_node *dep);
Sebastian Hack's avatar
Sebastian Hack committed
134

135
/** Replaces the n-th predecessor of a node with a new one. */
Michael Beck's avatar
Michael Beck committed
136
FIRM_API void set_irn_n(ir_node *node, int n, ir_node *in);
137
138
139
140
141
/**
 * 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
142
FIRM_API int add_irn_n(ir_node *node, ir_node *in);
143
/** Sets the mode struct of node.  */
Michael Beck's avatar
Michael Beck committed
144
FIRM_API void set_irn_mode(ir_node *node, ir_mode *mode);
145
/** Returns the mode struct of a node.  */
Michael Beck's avatar
Michael Beck committed
146
FIRM_API ir_mode *get_irn_mode(const ir_node *node);
147
/** Returns the opcode struct of the node. */
Michael Beck's avatar
Michael Beck committed
148
FIRM_API ir_op *get_irn_op(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
149
/** Sets the opcode struct of the node. */
Michael Beck's avatar
Michael Beck committed
150
FIRM_API void set_irn_op(ir_node *node, ir_op *op);
151
/** Returns the opcode-enum of the node. */
Michael Beck's avatar
Michael Beck committed
152
FIRM_API unsigned get_irn_opcode(const ir_node *node);
153
/** Returns the string representation of the opcode. */
Michael Beck's avatar
Michael Beck committed
154
FIRM_API const char *get_irn_opname(const ir_node *node);
155
/** Returns the ident for a string representation of the opcode. */
Michael Beck's avatar
Michael Beck committed
156
FIRM_API ident *get_irn_opident(const ir_node *node);
157
/** If arg is an argument of the node, returns its position, -1 otherwise */
Michael Beck's avatar
Michael Beck committed
158
FIRM_API int get_irn_pred_pos(ir_node *node, ir_node *arg);
159
/** Returns the visited counter of a node. */
Michael Beck's avatar
Michael Beck committed
160
FIRM_API ir_visited_t get_irn_visited(const ir_node *node);
161
/** Sets the visited counter of a node. */
Michael Beck's avatar
Michael Beck committed
162
FIRM_API void set_irn_visited(ir_node *node, ir_visited_t visited);
Michael Beck's avatar
Michael Beck committed
163
/** Sets visited to get_irg_visited(current_ir_graph). */
Michael Beck's avatar
Michael Beck committed
164
FIRM_API void mark_irn_visited(ir_node *node);
165
/** Returns 1 if visited >= get_irg_visited(current_ir_graph). */
Michael Beck's avatar
Michael Beck committed
166
FIRM_API int irn_visited(const ir_node *node);
167
168
/** 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
169
FIRM_API int irn_visited_else_mark(ir_node *node);
170
171
172
173
174

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

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

180
/** Returns the ir_graph this node belongs to. */
Michael Beck's avatar
Michael Beck committed
181
FIRM_API ir_graph *get_irn_irg(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
182

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

188
189
190
191
192
193
194
/** 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
195
FIRM_API op_pin_state get_irn_pinned(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
196

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

200
201
202
203
204
205
/** 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
206
FIRM_API op_pin_state is_irn_pinned_in_irg(const ir_node *node);
207

Michael Beck's avatar
Michael Beck committed
208
/**
209
210
211
212
 * 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.
213
214
215
 *
 * @param db    Debug info.
 * @param irg   IR-graph on with this new node should be constructed.
Michael Beck's avatar
Michael Beck committed
216
 * @param block The block the new node belongs to
217
218
 * @param op    The opcode of the new node.
 * @param mode  The mode of the new node.
219
 * @param arity The arity of the new node, <0 if can be changed dynamically.
220
 * @param in    An array of arity predecessor nodes.
Michael Beck's avatar
Michael Beck committed
221
 */
Michael Beck's avatar
Michael Beck committed
222
FIRM_API ir_node *new_ir_node(dbg_info *db, ir_graph *irg, ir_node *block,
223
                              ir_op *op, ir_mode *mode,
224
                              int arity, ir_node *const *in);
Christian Schäfer's avatar
Christian Schäfer committed
225

Matthias Braun's avatar
Matthias Braun committed
226
227
228
229
230
/**
 * @addtogroup Block
 * @{
 */

231
/**
232
 * Returns the block the node belongs to.  This is only
233
234
235
 * 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
236
237
238
239
240
 *
 * 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
241
 * get_irn_block(). */
242
FIRM_API ir_node *get_nodes_block(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
243
244

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

247
/** Returns the number of control flow predecessors of a block. */
Michael Beck's avatar
Michael Beck committed
248
FIRM_API int get_Block_n_cfgpreds(const ir_node *block);
249
/** Returns the control flow predecessor of a block at a given position. */
Michael Beck's avatar
Michael Beck committed
250
FIRM_API ir_node *get_Block_cfgpred(const ir_node *block, int pos);
251
/** Sets the control flow predecessor of a block at a given position. */
Michael Beck's avatar
Michael Beck committed
252
FIRM_API void set_Block_cfgpred(ir_node *block, int pos, ir_node *pred);
253
254

/**
255
 * Returns the position of the predecessor block pred in the inputs
256
257
258
259
260
261
262
 * of the block block.
 *
 * @param block  the block
 * @param pred   a predecessor block of block
 *
 * @return the position of pred in block or -1
 */
Michael Beck's avatar
Michael Beck committed
263
FIRM_API int get_Block_cfgpred_pos(const ir_node *block, const ir_node *pred);
264

265
/** Returns the predecessor block.
266
 *
267
 *  Returns the block corresponding to the predecessor pos of block.
268
269
270
271
272
273
 *
 *  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
274
 *    Start block, but the Bad node.
275
 */
Michael Beck's avatar
Michael Beck committed
276
FIRM_API ir_node *get_Block_cfgpred_block(const ir_node *node, int pos);
277

278
/** Returns the matured flag of a block */
Michael Beck's avatar
Michael Beck committed
279
FIRM_API int get_Block_matured(const ir_node *block);
280
/** set the matured flag of a block. */
Michael Beck's avatar
Michael Beck committed
281
FIRM_API void set_Block_matured(ir_node *block, int matured);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
282
283
284

/** 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
285
FIRM_API ir_visited_t get_Block_block_visited(const ir_node *block);
286
/** set block visited flag */
Michael Beck's avatar
Michael Beck committed
287
FIRM_API void set_Block_block_visited(ir_node *block, ir_visited_t visit);
288

289
/** Marks a block as visited by setting its visited counter */
Michael Beck's avatar
Michael Beck committed
290
FIRM_API void mark_Block_block_visited(ir_node *node);
291
/** Returns 1 if a block is marked as visited */
Michael Beck's avatar
Michael Beck committed
292
FIRM_API int Block_block_visited(const ir_node *node);
Christian Schäfer's avatar
Christian Schäfer committed
293

294
/** Returns the ir_graph this Block belongs to. */
Michael Beck's avatar
Michael Beck committed
295
FIRM_API ir_graph *get_Block_irg(const ir_node *block);
296
/** Returns the entity for a Block (creating it if necessary) */
Michael Beck's avatar
Michael Beck committed
297
FIRM_API ir_entity *create_Block_entity(ir_node *block);
298
/** Returns the head of the Phi list for this block. */
Michael Beck's avatar
Michael Beck committed
299
FIRM_API ir_node *get_Block_phis(const ir_node *block);
300
/** Sets the head of the Phi list for this block. */
Michael Beck's avatar
Michael Beck committed
301
FIRM_API void set_Block_phis(ir_node *block, ir_node *phi);
Michael Beck's avatar
Michael Beck committed
302
/** Add a Phi node to the list of Block Phi's. */
Michael Beck's avatar
Michael Beck committed
303
FIRM_API void add_Block_phi(ir_node *block, ir_node *phi);
304
/** Returns the Block mark (single bit). */
Michael Beck's avatar
Michael Beck committed
305
FIRM_API unsigned get_Block_mark(const ir_node *block);
306
/** Sets the Block mark (single bit). */
Michael Beck's avatar
Michael Beck committed
307
FIRM_API void set_Block_mark(ir_node *block, unsigned mark);
Michael Beck's avatar
Michael Beck committed
308

Matthias Braun's avatar
Matthias Braun committed
309
310
/** @} */

311
/** Tests whether arbitrary node is frame pointer.
Matthias Braun's avatar
Matthias Braun committed
312
 *
313
 * Tests whether arbitrary node is frame pointer, i.e. Proj(pn_Start_P_frame_base)
Matthias Braun's avatar
Matthias Braun committed
314
315
316
317
318
319
320
 * from Start.  If so returns frame type, else Null. */
FIRM_API ir_type *is_frame_pointer(const ir_node *n);

/** @addtogroup End
 * @{
 */

321
/** Returns the number of Keep alive node. */
Michael Beck's avatar
Michael Beck committed
322
FIRM_API int get_End_n_keepalives(const ir_node *end);
323
/** Returns the Keep alive node a position pos. */
Michael Beck's avatar
Michael Beck committed
324
FIRM_API ir_node *get_End_keepalive(const ir_node *end, int pos);
Michael Beck's avatar
Michael Beck committed
325
/** Keep alive dedicated nodes.  These must be either PhiM or Block nodes. */
Michael Beck's avatar
Michael Beck committed
326
FIRM_API void add_End_keepalive(ir_node *end, ir_node *ka);
327
/** Sets the Keep alive node at position pos. */
Michael Beck's avatar
Michael Beck committed
328
FIRM_API void set_End_keepalive(ir_node *end, int pos, ir_node *ka);
329
330

/**
331
 * Sets new keep-alives.
332
333
334
 * 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
335
FIRM_API void set_End_keepalives(ir_node *end, int n, ir_node *in[]);
336

337
/** Removes irn from the keep-alive set. */
Michael Beck's avatar
Michael Beck committed
338
FIRM_API void remove_End_keepalive(ir_node *end, ir_node *irn);
339

340
/** Removes Bads, NoMem and doublets from the keep-alive set. */
Michael Beck's avatar
Michael Beck committed
341
FIRM_API void remove_End_Bads_and_doublets(ir_node *end);
342

Michael Beck's avatar
Michael Beck committed
343
/** Some parts of the End node are allocated separately -- their memory
344
345
346
 * is not recovered by dead_node_elimination if a End node is dead.
 * free_End() frees these data structures.
 */
Michael Beck's avatar
Michael Beck committed
347
FIRM_API void free_End(ir_node *end);
348

Matthias Braun's avatar
Matthias Braun committed
349
350
351
352
353
354
/** @} */

/** @addtogroup Return
 * @{
 */

355
/** Returns return value inputs of Return node @p node as array. */
Michael Beck's avatar
Michael Beck committed
356
FIRM_API ir_node **get_Return_res_arr(ir_node *node);
357
358
359
360
361
362
/** Returns number of return value inputs of Return node @p node. */
FIRM_API size_t get_Return_n_ress(const ir_node *node);
/** Returns return value input @p pos of Return node @p node. */
FIRM_API ir_node *get_Return_res(const ir_node *node, int pos);
/** Sets return value input @p pos of Return node @p node to value @p res. */
FIRM_API void set_Return_res(ir_node *node, int pos, ir_node *res);
Christian Schäfer's avatar
Christian Schäfer committed
363

Matthias Braun's avatar
Matthias Braun committed
364
365
366
367
368
369
/** @} */

/** @addtogroup Const
 * @{
 */

370
/** Returns non-zero if the given Const node represents the 0 constant. */
Michael Beck's avatar
Michael Beck committed
371
FIRM_API int is_Const_null(const ir_node *node);
372

373
/** Returns non-zero if the given Const node represents the 1 constant. */
Michael Beck's avatar
Michael Beck committed
374
FIRM_API int is_Const_one(const ir_node *node);
375

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

Matthias Braun's avatar
Matthias Braun committed
379
380
381
382
383
384
/** @} */

/**
 * @ingroup Conv
 * Returns true if a node is a Conv node with strict attribute set.
 */
385
386
FIRM_API int is_strictConv(const ir_node *node);

Matthias Braun's avatar
Matthias Braun committed
387
388
389
390
391
392
393
394
/**
 * @addtogroup SymConst
 * @{
 */

/**
 * Returns true if node is a SymConst node with kind symconst_addr_ent.
 */
395
396
FIRM_API int is_SymConst_addr_ent(const ir_node *node);

397
398
399
400
/** 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 */
401
#define SYMCONST_HAS_ENT(kind) ((kind) == symconst_addr_ent || (kind) == symconst_ofs_ent)
402

403
404
405
/** Returns non-zero if s symconst kind has an enum_const attribute */
#define SYMCONST_HAS_ENUM(kind) ((kind) == symconst_enum_const)

406
/** Returns the kind of the SymConst. */
Michael Beck's avatar
Michael Beck committed
407
FIRM_API symconst_kind get_SymConst_kind(const ir_node *node);
408
409
/** Sets the kind of the SymConst. */
FIRM_API void set_SymConst_kind(ir_node *node, symconst_kind num);
Beyhan's avatar
Beyhan committed
410

411
412
413
414
415
416
/** Returns the type attribute of SymConst node @p node.
 * @note Only to access SymConst of kind type_siz, else assertion.
 */
FIRM_API ir_type *get_SymConst_type(const ir_node *node);
/** Sets the type attribute of SymConst node @p node. */
FIRM_API void set_SymConst_type(ir_node *node, ir_type *tp);
Beyhan's avatar
Beyhan committed
417

418
419
420
/** Returns the entity attribute of SymConst node @p node.
 * @note Only to access SymConst of kind addr_ent, else assertion.
 */
Michael Beck's avatar
Michael Beck committed
421
FIRM_API ir_entity *get_SymConst_entity(const ir_node *node);
422
423
/** Sets the entity attribute of Symconst node @p node. */
FIRM_API void set_SymConst_entity(ir_node *node, ir_entity *ent);
Beyhan's avatar
Beyhan committed
424

425
426
427
/** Returns the enum attribute of SymConst node @p node.
 * Only to access SymConst of kind symconst_enum_const, else assertion
 */
Michael Beck's avatar
Michael Beck committed
428
FIRM_API ir_enum_const *get_SymConst_enum(const ir_node *node);
429
430
/** Sets the enum attribute of SymConst node @p node. */
FIRM_API void set_SymConst_enum(ir_node *node, ir_enum_const *ec);
431

432
/** Returns the symbol attribute of SymConst node @p node. */
Michael Beck's avatar
Michael Beck committed
433
FIRM_API union symconst_symbol get_SymConst_symbol(const ir_node *node);
434
435
/** Sets the symbol attribute of SymConst node @p node. */
FIRM_API void set_SymConst_symbol(ir_node *node, union symconst_symbol sym);
436

Matthias Braun's avatar
Matthias Braun committed
437
438
439
440
441
442
/** @} */

/** @addtogroup Sel
 * @{
 */

443
444
445
446
447
448
449
450
/** Returns index inputs of Sel node @p node as array. */
FIRM_API ir_node **get_Sel_index_arr(ir_node *node);
/** Returns number of index inputs of Sel node @p node. */
FIRM_API int get_Sel_n_indexs(const ir_node *node);
/** Returns value of index input @p pos of Sel node @p node. */
FIRM_API ir_node *get_Sel_index(const ir_node *node, int pos);
/** Sets @p index as index input @p pos of Sel node @p node. */
FIRM_API void set_Sel_index(ir_node *node, int pos, ir_node *index);
451

Matthias Braun's avatar
Matthias Braun committed
452
453
454
455
456
457
/** @} */

/** @addtogroup Call
 * @{
 */

458
/** Returns parameter inputs of Call node @p node as array. */
Michael Beck's avatar
Michael Beck committed
459
FIRM_API ir_node **get_Call_param_arr(ir_node *node);
460
461
462
/** Returns the number of parameters of a call. */
FIRM_API size_t get_Call_n_params(const ir_node *node);
/** Returns the call parameter at position pos. */
Michael Beck's avatar
Michael Beck committed
463
FIRM_API ir_node *get_Call_param(const ir_node *node, int pos);
Michael Beck's avatar
Michael Beck committed
464
/** Sets the call parameter at position pos. */
465
FIRM_API void set_Call_param(ir_node *node, int pos, ir_node *param);
Michael Beck's avatar
Michael Beck committed
466

467
/** Sets, get and remove the callee information for a Call node.
468
469
470
 *
 *  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
471
472
473
474
 *  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.
475
476
477
478
479
480
481
482
483
 *
 *  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.
 */
484
485
486
487
FIRM_API int Call_has_callees(const ir_node *node);
/** Returns the number of callees of Call node @p node. */
FIRM_API size_t get_Call_n_callees(const ir_node *node);
/** Returns callee number @p pos of Call node @p node. */
488
FIRM_API ir_entity *get_Call_callee(const ir_node *node, size_t pos);
Michael Beck's avatar
Michael Beck committed
489

490
/** Sets the full callee array.
491
492
 *
 *  The passed array is copied. Assumes current_ir_graph set properly! */
493
FIRM_API void set_Call_callee_arr(ir_node *node, size_t n, ir_entity **arr);
494
/** Frees callee array of call node @p node */
Michael Beck's avatar
Michael Beck committed
495
FIRM_API void remove_Call_callee_arr(ir_node *node);
496

Matthias Braun's avatar
Matthias Braun committed
497
498
499
500
501
502
/** @} */

/** @addtogroup Builtin
 * @{
 */

503
504
505
506
507
508
/** Returns the parameter inputs of Builtin node @p node as array. */
FIRM_API ir_node **get_Builtin_param_arr(ir_node *node);
/** Returns the number of parameters of a Builtin. */
FIRM_API int get_Builtin_n_params(const ir_node *node);
/** Returns the Builtin parameter at position pos. */
FIRM_API ir_node *get_Builtin_param(const ir_node *node, int pos);
509
/** Sets the Builtin parameter at position pos. */
510
FIRM_API void set_Builtin_param(ir_node *node, int pos, ir_node *param);
Matthias Braun's avatar
Matthias Braun committed
511
512
513

/** @} */

514
/** Returns a human readable string for the ir_builtin_kind. */
Michael Beck's avatar
Michael Beck committed
515
FIRM_API const char *get_builtin_kind_name(ir_builtin_kind kind);
516

517
518
519
520
521
/** Tests whether node is an unary operation (opcode arity is #oparity_unary)
 * @returns 1 if @p node is an unary operation, 0 otherwise
 */
FIRM_API int is_unop(const ir_node *node);
/** Returns (arithmetic) operand of unary operation @p node. */
Michael Beck's avatar
Michael Beck committed
522
FIRM_API ir_node *get_unop_op(const ir_node *node);
523
524
525
526
527
528
529
530
/** Sets (arithmetic) operand of unary operation @p node. */
FIRM_API void set_unop_op(ir_node *node, ir_node *op);

/** Tests whether node is a binary operation (opcode arity is #oparity_binary)
 * @returns 1 if @p node is an binary operation, 0 otherwise
 */
FIRM_API int is_binop(const ir_node *node);
/** Returns left operand of binary operation @p node. */
Michael Beck's avatar
Michael Beck committed
531
FIRM_API ir_node *get_binop_left(const ir_node *node);
532
533
534
/** Sets left operand of binary operation @p node. */
FIRM_API void set_binop_left(ir_node *node, ir_node *left);
/** Returns rights operand of binary operation @p node. */
Michael Beck's avatar
Michael Beck committed
535
FIRM_API ir_node *get_binop_right(const ir_node *node);
536
537
/** Sets right operand of binary operation @p node. */
FIRM_API void set_binop_right(ir_node *node, ir_node *right);
Michael Beck's avatar
Michael Beck committed
538

Matthias Braun's avatar
Matthias Braun committed
539
/**
540
 * Tests whether a node is the X_except Proj of a fragile operation
Matthias Braun's avatar
Matthias Braun committed
541
 */
542
FIRM_API int is_x_except_Proj(const ir_node *node);
Matthias Braun's avatar
Matthias Braun committed
543
544

/**
545
 * Tests whether a node is the X_regular Proj of a fragile operation
Matthias Braun's avatar
Matthias Braun committed
546
 */
547
FIRM_API int is_x_regular_Proj(const ir_node *node);
548
549

/**
550
 * Sets throws exception attribute of a fragile node
551
552
 * @p throws_exception must be 0 or 1
 */
553
FIRM_API void ir_set_throws_exception(ir_node *node, int throws_exception);
554

555
556
/** Returns throws_exception attribute of a fragile node */
FIRM_API int ir_throws_exception(const ir_node *node);
Matthias Braun's avatar
Matthias Braun committed
557

558
/** Returns the name of an ir_relation */
559
FIRM_API const char *get_relation_string(ir_relation relation);
Michael Beck's avatar
Michael Beck committed
560

561
562
/** Calculates the negated (Complement(R)) relation, i.e. "<" --> ">=" */
FIRM_API ir_relation get_negated_relation(ir_relation relation);
Michael Beck's avatar
Michael Beck committed
563

564
565
/** Calculates the inversed (R^-1) relation, i.e., "<" --> ">" */
FIRM_API ir_relation get_inversed_relation(ir_relation relation);
566

Matthias Braun's avatar
Matthias Braun committed
567
568
569
570
571
/**
 * @addtogroup Cast
 * @{
 */

Götz Lindenmaier's avatar
Götz Lindenmaier committed
572
573
574
575
/** Checks for upcast.
 *
 * Returns true if the Cast node casts a class type to a super type.
 * Works also for pointers to classes (recursively).
576
577
 *
 * Needs typeinfo calculated.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
578
 */
Michael Beck's avatar
Michael Beck committed
579
FIRM_API int is_Cast_upcast(ir_node *node);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
580
581
582
583
584

/** Checks for downcast.
 *
 * Returns true if the Cast node casts a class type to a sub type.
 * Works also for pointers to classes (recursively).
585
586
 *
 * Needs typeinfo calculated.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
587
 */
Michael Beck's avatar
Michael Beck committed
588
FIRM_API int is_Cast_downcast(ir_node *node);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
589

Matthias Braun's avatar
Matthias Braun committed
590
591
592
593
594
595
596
/** @} */

/**
 * @addtogroup Phi
 * @{
 */

597
598
599
/**
 * Returns all phi predecessors as array
 */
Michael Beck's avatar
Michael Beck committed
600
FIRM_API ir_node **get_Phi_preds_arr(ir_node *node);
601
602
603
604
605
606
607
608
609
610
611
612
613
614
/**
 * Returns number of predecessors of phi node @p node
 */
FIRM_API int get_Phi_n_preds(const ir_node *node);
/**
 * Returns the predecessor with number @p pos of phi node @p node.
 * This is the value selected when control flow comes from predecessor @p pos
 * of the containing basic block.
 */
FIRM_API ir_node *get_Phi_pred(const ir_node *node, int pos);
/**
 * Sets value @p pred as predecessor number @p pos of phi node @p node.
 */
FIRM_API void set_Phi_pred(ir_node *node, int pos, ir_node *pred);
615
616
617
/**
 * Returns the next element of a block phi list.
 */
618
FIRM_API ir_node *get_Phi_next(const ir_node *phi);
619
620
621
/**
 * Sets the next link of a block Phi list.
 */
622
FIRM_API void set_Phi_next(ir_node *phi, ir_node *next);
623

Matthias Braun's avatar
Matthias Braun committed
624
625
/** @} */

626
/** Returns true if @p node is a memory operation.
627
 *
628
629
630
631
632
633
 * A memory operation is a node with an opcode that has irop_flag_uses_memory
 * set. It is guaranteed to have (exactly) one memory input.
 */
FIRM_API int is_memop(const ir_node *node);
/**
 * Returns the memory input of a memory operation.
634
 */
Michael Beck's avatar
Michael Beck committed
635
FIRM_API ir_node *get_memop_mem(const ir_node *node);
636
637
638
639
640
641
642
643
/**
 * Sets the memory input of a memory operation.
 */
FIRM_API void set_memop_mem(ir_node *node, ir_node *mem);

/** @addtogroup Sync
 * @{
 */
644

645
/** Returns all predecessors of Sync node @p node as array */
Michael Beck's avatar
Michael Beck committed
646
FIRM_API ir_node **get_Sync_preds_arr(ir_node *node);
647
648
649
650
651
652
653
654
655
656
657
658
/** Returns number of predecessors of Sync node @p node. */
FIRM_API int get_Sync_n_preds(const ir_node *node);
/** Returns predecessor number @p pos of Sync node @p node. */
FIRM_API ir_node *get_Sync_pred(const ir_node *node, int pos);
/** Sets value @p pred as predecessor number @p pos of Sync node @p node. */
FIRM_API void set_Sync_pred(ir_node *node, int pos, ir_node *pred);
/** Adds @p pred to predecessor list of Sync node @p node. */
FIRM_API void add_Sync_pred(ir_node *node, ir_node *pred);
/** Removes predecessor i from Sync n */
FIRM_API void del_Sync_n(ir_node *n, int i);

/** @} */
659

Michael Beck's avatar
Michael Beck committed
660
661
662
663
664
/**
 * Returns non-zero if a node is a routine parameter.
 *
 * @param node  the Proj node to test
 */
Michael Beck's avatar
Michael Beck committed
665
FIRM_API int is_arg_Proj(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
666

Matthias Braun's avatar
Matthias Braun committed
667
668
669
670
/** @addtogroup Tuple
 * @{
 */

671
/** Returns all predecessors of Tuple node @p node as array. */
Michael Beck's avatar
Michael Beck committed
672
FIRM_API ir_node **get_Tuple_preds_arr(ir_node *node);
673
674
675
/** Returns number of predecessors of Tuple node @p node. */
FIRM_API int get_Tuple_n_preds(const ir_node *node);
/** Returns predecessor number @p pos of Tuple node @p node. */
Michael Beck's avatar
Michael Beck committed
676
FIRM_API ir_node  *get_Tuple_pred(const ir_node *node, int pos);
677
678
/** Sets value @p pred as predecessor number @p pos of Tuple node @p node. */
FIRM_API void set_Tuple_pred(ir_node *node, int pos, ir_node *pred);
679

Matthias Braun's avatar
Matthias Braun committed
680
681
682
683
684
685
/** @} */

/** @addtogroup ASM
 * @{
 */

686
/** Returns the number of input constraints for an ASM node. */
687
FIRM_API size_t get_ASM_n_input_constraints(const ir_node *node);
688
/** Returns the number of output constraints for an ASM node.  */
689
FIRM_API size_t get_ASM_n_output_constraints(const ir_node *node);
690
/** Returns the number of clobbered registers for an ASM node.  */
691
FIRM_API size_t get_ASM_n_clobbers(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
692

Matthias Braun's avatar
Matthias Braun committed
693
694
/** @} */

Michael Beck's avatar
Michael Beck committed
695
/** Returns operand of node if node is a Proj. */
Michael Beck's avatar
Michael Beck committed
696
FIRM_API ir_node *skip_Proj(ir_node *node);
Michael Beck's avatar
Michael Beck committed
697
/** Returns operand of node if node is a Proj. */
Michael Beck's avatar
Michael Beck committed
698
FIRM_API const ir_node *skip_Proj_const(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
699
/** Returns operand of node if node is a Id. */
700
701
FIRM_API ir_node *skip_Id(ir_node *node);
/** Returns corresponding operand of Tuple if node is a Proj from a Tuple. */
Michael Beck's avatar
Michael Beck committed
702
FIRM_API ir_node *skip_Tuple(ir_node *node);
Michael Beck's avatar
Michael Beck committed
703
/** Returns operand of node if node is a Cast. */
Michael Beck's avatar
Michael Beck committed
704
FIRM_API ir_node *skip_Cast(ir_node *node);
705
/** Returns operand of node if node is a Cast. */
Michael Beck's avatar
Michael Beck committed
706
FIRM_API const ir_node *skip_Cast_const(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
707
/** Returns operand of node if node is a Pin. */
Michael Beck's avatar
Michael Beck committed
708
FIRM_API ir_node *skip_Pin(ir_node *node);
Michael Beck's avatar
Michael Beck committed
709
/** Returns operand of node if node is a Confirm */
Michael Beck's avatar
Michael Beck committed
710
FIRM_API ir_node *skip_Confirm(ir_node *node);
Michael Beck's avatar
Michael Beck committed
711
/** Skip all high-level Operations (including Cast, Confirm). */
Michael Beck's avatar
Michael Beck committed
712
FIRM_API ir_node *skip_HighLevel_ops(ir_node *node);
713
/** Returns true if the operation manipulates control flow */
Michael Beck's avatar
Michael Beck committed
714
FIRM_API int is_cfop(const ir_node *node);
715
/** Returns true if the operation jumps to an unknown destination.
716
717
 * See irop_flag_unknown_jump for a detailed explanation */
FIRM_API int is_unknown_jump(const ir_node *node);
718

719
720
721
722
723
/**
 * Returns true if the operation can change the control flow because
 * of an exception: Call, Div, Mod, Load, Store, Alloc,
 * Bad. Raise is not fragile, but a unconditional jump.
 */
Michael Beck's avatar
Michael Beck committed
724
FIRM_API int is_fragile_op(const ir_node *node);
Christian Schäfer's avatar
Christian Schäfer committed
725

Michael Beck's avatar
Michael Beck committed
726
727
/** Returns true if the operation is a forking control flow
 *  operation: Cond. */
Michael Beck's avatar
Michael Beck committed
728
FIRM_API int is_irn_forking(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
729

730
/**
731
 * Copies attributes stored in the old node to a new node.
732
 * Assumes both have the same opcode and sufficient size.
733
734
735
736
737
738
739
740
741
 *
 * @param irg       The irg of the new_node (get_irn_irg on it might not work
 *                  yet)
 * @param old_node  the node where the attributes are copied from
 * @param new_node  node the attributes get copies to.
 *
 * This copies all essential information to the new node. It does not copy
 * temporal or calculated information like visited flags or results of dominance
 * or loop calculations
742
 */
Michael Beck's avatar
Michael Beck committed
743
FIRM_API void copy_node_attr(ir_graph *irg, const ir_node *old_node, ir_node *new_node);
744

745
/** Returns the type attribute of a node n (SymConst, Call, Alloc, Free,
746
 *  Cast) or NULL.*/
Michael Beck's avatar
Michael Beck committed
747
FIRM_API ir_type *get_irn_type_attr(ir_node *n);
Michael Beck's avatar
Michael Beck committed
748

749
/** Returns the entity attribute of a node n (SymConst, Sel) or NULL. */
Michael Beck's avatar
Michael Beck committed
750
FIRM_API ir_entity *get_irn_entity_attr(ir_node *n);
751

Michael Beck's avatar
Michael Beck committed
752
/** Returns non-zero for constant-like nodes. */
Michael Beck's avatar
Michael Beck committed
753
FIRM_API int is_irn_constlike(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
754

Michael Beck's avatar
Michael Beck committed
755
756
757
758
/**
 * Returns non-zero for nodes that are allowed to have keep-alives and
 * are neither Block nor PhiM.
 */
Michael Beck's avatar
Michael Beck committed
759
FIRM_API int is_irn_keep(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
760

761
762
763
/**
 * Returns non-zero for nodes that are always placed in the start block.
 */
Michael Beck's avatar
Michael Beck committed
764
FIRM_API int is_irn_start_block_placed(const ir_node *node);
765

766
767
768
/**
 * Returns non-zero for nodes that are CSE neutral to its users.
 */
Michael Beck's avatar
Michael Beck committed
769
FIRM_API int is_irn_cse_neutral(const ir_node *node);
770

771
/** Returns the string representation of the jump prediction. */
Michael Beck's avatar
Michael Beck committed
772
FIRM_API const char *get_cond_jmp_predicate_name(cond_jmp_predicate pred);
773

774
775
776
777
778
779
/**
 * Access custom node data.
 * The data must have been registered with
 * register_additional_node_data() before.
 * @param node The ir node to get the data from.
 * @param type The type of the data you registered.
Sebastian Hack's avatar
Sebastian Hack committed
780
 * @param off The value returned by register_additional_node_data().
781
782
783
 * @return A pointer of type @p type.
 */
#define get_irn_data(node,type,off) \
Sebastian Hack's avatar
Sebastian Hack committed
784
785
786
  (assert(off > 0 && "Invalid node data offset"), (type *) ((char *) (node) - (off)))

/**
787
 * Returns the pointer to the node some custom data belongs to.
Sebastian Hack's avatar
Sebastian Hack committed
788
789
790
791
792
793
 * @param data The pointer to the custom data.
 * @param off The number as returned by register_additional_node_data().
 * @return A pointer to the ir node the custom data belongs to.
 */
#define get_irn_data_base(data,off) \
  (assert(off > 0 && "Invalid node data offset"), (ir_node *) ((char *) (data) + (off)))
794
795
796
797

/**
 * Request additional data to be allocated with an ir node.
 * @param size The size of the additional data required.
Michael Beck's avatar
Michael Beck committed
798
 * @return A positive number, if the operation was successful, which
799
800
801
 * must be passed to the access macro get_irn_data(), 0 if the
 * registration failed.
 */
Michael Beck's avatar
Michael Beck committed
802
FIRM_API unsigned firm_register_additional_node_data(unsigned size);
803

804
/**
805
806
 * Returns a pointer to the node attributes.
 * Used for accessing attributes of user-defined nodes.
807
 */
Michael Beck's avatar
Michael Beck committed
808
FIRM_API void *get_irn_generic_attr(ir_node *node);
809
810
811
812
/**
 * Returns a pointer to the node attributes.
 * Used for accessing attributes of user-defined nodes.
 */
Michael Beck's avatar
Michael Beck committed
813
FIRM_API const void *get_irn_generic_attr_const(const ir_node *node);
814

815
816
817
/**
 * Returns the unique node index for the node in its graph.
 * This index is used to access phase information for this node.
818
 * @see get_idx_irn()
819
 */
Michael Beck's avatar
Michael Beck committed
820
FIRM_API unsigned get_irn_idx(const ir_node *node);
821

822
823
824
825
826
827
/**
 * Sets the debug information of a node.
 *
 * @param n   The node.
 * @param db  The debug info.
 */
Michael Beck's avatar
Michael Beck committed
828
FIRM_API void set_irn_dbg_info(ir_node *n, dbg_info *db);
829
830
831
832
833
834

/**
 * Returns the debug information of an node.
 *
 * @param n   The node.
 */
Michael Beck's avatar
Michael Beck committed
835
FIRM_API dbg_info *get_irn_dbg_info(const ir_node *n);
836

837
838
/**
 * Calculate a hash value of a node. Only inputs, mode and opcode are used.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
839
 *
840
841
 * @param node  the node to hash
 */
Michael Beck's avatar
Michael Beck committed
842
FIRM_API unsigned firm_default_hash(const ir_node *node);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
843

844
/**
845
 * Returns a descriptive name of a node (containing type+number)
846
 */
Michael Beck's avatar
Michael Beck committed
847
FIRM_API const char *gdb_node_helper(void *firm_object);
848

849
850
851
852
853
854
855
856
857
/**
 * @addtogroup Switch
 * @{
 */

/**
 * Creates a new switch_table datastructure with @p n_entries entries.
 * The datastructure is allocated on the obstack of @p irg.
 */
Matthias Braun's avatar
Matthias Braun committed
858
859
FIRM_API ir_switch_table *ir_new_switch_table(ir_graph *irg, size_t n_entries);

860
861
862
/**
 * Returns number of entries available in switch table @p table.
 */
Matthias Braun's avatar
Matthias Braun committed
863
864
FIRM_API size_t ir_switch_table_get_n_entries(const ir_switch_table *table);

865
866
867
868
869
870
871
872
/**
 * Sets entry number @p entry in the switch table @p table.
 * @param table  the switch table
 * @param entry  entry number to set
 * @param min    The minimum tarval that matches this entry
 * @param max    The maximum tarval that matches this entry
 * @param pn     Proj number taken on match
 */
Matthias Braun's avatar
Matthias Braun committed
873
874
875
FIRM_API void ir_switch_table_set(ir_switch_table *table, size_t entry,
                                  ir_tarval *min, ir_tarval *max, long pn);

876
/** Returns maximum tarval value of switch table entry @p entry */
Matthias Braun's avatar
Matthias Braun committed
877
878
879
FIRM_API ir_tarval *ir_switch_table_get_max(const ir_switch_table *table,
                                            size_t entry);

880
/** Returns minimum tarval value of switch table entry @p entry */
Matthias Braun's avatar
Matthias Braun committed
881
882
883
FIRM_API ir_tarval *ir_switch_table_get_min(const ir_switch_table *table,
                                            size_t entry);

884
/** Returns proj number taken if switch table entry @p entry matches */
Matthias Braun's avatar
Matthias Braun committed
885
886
FIRM_API long ir_switch_table_get_pn(const ir_switch_table *table, size_t entry);

887
/** Duplicates switch table @p table on obstack of @p irg */
Matthias Braun's avatar
Matthias Braun committed
888
FIRM_API ir_switch_table *ir_switch_table_duplicate(ir_graph *irg, const ir_switch_table *table);
889
/** @} */
Matthias Braun's avatar
Matthias Braun committed
890

891
/** @} */
892

893
894
#include "end.h"