irnode.h 29.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
/**
 * @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
 * Add an artificial dependency to the node.
93
94
95
96
 *
 * @param node The node.
 * @param dep  The dependency target.
 */
97
FIRM_API void add_irn_dep(ir_node *node, ir_node *dep);
Sebastian Hack's avatar
Sebastian Hack committed
98
99
100

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

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

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

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

131
132
133
134
135
136
137
138
139
/**
 * Deletes the entry of the dependency array, that points to dep. Does nothing
 * if no dependency exists.
 *
 * @param node the node to delete the dependency at
 * @param dep the target of the dependency to delete
 */
FIRM_API void delete_irn_dep(ir_node *node, ir_node *dep);

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

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

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

183
/** Returns the ir_graph this node belongs to. */
Michael Beck's avatar
Michael Beck committed
184
FIRM_API ir_graph *get_irn_irg(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
185

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

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

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

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

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

Matthias Braun's avatar
Matthias Braun committed
229
230
231
232
233
/**
 * @addtogroup Block
 * @{
 */

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

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

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

/**
258
 * Returns the position of the predecessor block pred in the inputs
259
260
261
262
263
264
265
 * 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
266
FIRM_API int get_Block_cfgpred_pos(const ir_node *block, const ir_node *pred);
267

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

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

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

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

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

Matthias Braun's avatar
Matthias Braun committed
312
313
/** @} */

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

/** @addtogroup End
 * @{
 */

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

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

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

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

Michael Beck's avatar
Michael Beck committed
346
/** Some parts of the End node are allocated separately -- their memory
347
348
349
 * 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
350
FIRM_API void free_End(ir_node *end);
351

Matthias Braun's avatar
Matthias Braun committed
352
353
354
355
356
357
/** @} */

/** @addtogroup Return
 * @{
 */

358
/** Returns return value inputs of Return node @p node as array. */
Michael Beck's avatar
Michael Beck committed
359
FIRM_API ir_node **get_Return_res_arr(ir_node *node);
360
361
362
363
364
365
/** 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
366

Matthias Braun's avatar
Matthias Braun committed
367
368
369
370
371
372
/** @} */

/** @addtogroup Const
 * @{
 */

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

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

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

Matthias Braun's avatar
Matthias Braun committed
382
383
384
385
386
387
388
389
390
391
/** @} */

/**
 * @addtogroup SymConst
 * @{
 */

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

394
395
396
397
/** 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 */
398
#define SYMCONST_HAS_ENT(kind) ((kind) == symconst_addr_ent || (kind) == symconst_ofs_ent)
399

400
401
402
/** Returns non-zero if s symconst kind has an enum_const attribute */
#define SYMCONST_HAS_ENUM(kind) ((kind) == symconst_enum_const)

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

408
409
410
411
412
413
/** 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
414

415
416
417
/** 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
418
FIRM_API ir_entity *get_SymConst_entity(const ir_node *node);
419
420
/** 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
421

422
423
424
/** 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
425
FIRM_API ir_enum_const *get_SymConst_enum(const ir_node *node);
426
427
/** Sets the enum attribute of SymConst node @p node. */
FIRM_API void set_SymConst_enum(ir_node *node, ir_enum_const *ec);
428

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

Matthias Braun's avatar
Matthias Braun committed
434
435
436
437
438
439
/** @} */

/** @addtogroup Sel
 * @{
 */

440
441
442
443
444
445
446
447
/** 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);
448

Matthias Braun's avatar
Matthias Braun committed
449
450
451
452
453
454
/** @} */

/** @addtogroup Call
 * @{
 */

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

464
/** Sets, get and remove the callee information for a Call node.
465
466
467
 *
 *  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
468
469
470
471
 *  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.
472
473
474
475
476
477
478
479
480
 *
 *  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.
 */
481
482
483
484
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. */
485
FIRM_API ir_entity *get_Call_callee(const ir_node *node, size_t pos);
Michael Beck's avatar
Michael Beck committed
486

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

Matthias Braun's avatar
Matthias Braun committed
494
495
496
497
498
499
/** @} */

/** @addtogroup Builtin
 * @{
 */

500
501
502
503
504
505
/** 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);
506
/** Sets the Builtin parameter at position pos. */
507
FIRM_API void set_Builtin_param(ir_node *node, int pos, ir_node *param);
Matthias Braun's avatar
Matthias Braun committed
508
509
510

/** @} */

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

514
515
516
517
518
/** 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
519
FIRM_API ir_node *get_unop_op(const ir_node *node);
520
521
522
523
524
525
526
527
/** 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
528
FIRM_API ir_node *get_binop_left(const ir_node *node);
529
530
531
/** 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
532
FIRM_API ir_node *get_binop_right(const ir_node *node);
533
534
/** 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
535

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

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

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

552
553
/** 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
554

555
/** Returns the name of an ir_relation */
556
FIRM_API const char *get_relation_string(ir_relation relation);
Michael Beck's avatar
Michael Beck committed
557

558
559
/** 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
560

561
562
/** Calculates the inversed (R^-1) relation, i.e., "<" --> ">" */
FIRM_API ir_relation get_inversed_relation(ir_relation relation);
563

Matthias Braun's avatar
Matthias Braun committed
564
565
566
567
568
/**
 * @addtogroup Cast
 * @{
 */

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

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

Matthias Braun's avatar
Matthias Braun committed
587
588
589
590
591
592
593
/** @} */

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

594
595
596
/**
 * Returns all phi predecessors as array
 */
Michael Beck's avatar
Michael Beck committed
597
FIRM_API ir_node **get_Phi_preds_arr(ir_node *node);
598
599
600
601
602
603
604
605
606
607
608
609
610
611
/**
 * 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);
612
613
614
/**
 * Returns the next element of a block phi list.
 */
615
FIRM_API ir_node *get_Phi_next(const ir_node *phi);
616
617
618
/**
 * Sets the next link of a block Phi list.
 */
619
FIRM_API void set_Phi_next(ir_node *phi, ir_node *next);
620

Matthias Braun's avatar
Matthias Braun committed
621
622
/** @} */

623
/** Returns true if @p node is a memory operation.
624
 *
625
626
627
628
629
630
 * 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.
631
 */
Michael Beck's avatar
Michael Beck committed
632
FIRM_API ir_node *get_memop_mem(const ir_node *node);
633
634
635
636
637
638
639
640
/**
 * Sets the memory input of a memory operation.
 */
FIRM_API void set_memop_mem(ir_node *node, ir_node *mem);

/** @addtogroup Sync
 * @{
 */
641

642
/** Returns all predecessors of Sync node @p node as array */
Michael Beck's avatar
Michael Beck committed
643
FIRM_API ir_node **get_Sync_preds_arr(ir_node *node);
644
645
646
647
648
649
650
651
652
653
654
655
/** 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);

/** @} */
656

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

Matthias Braun's avatar
Matthias Braun committed
664
665
666
667
/** @addtogroup Tuple
 * @{
 */

668
/** Returns all predecessors of Tuple node @p node as array. */
Michael Beck's avatar
Michael Beck committed
669
FIRM_API ir_node **get_Tuple_preds_arr(ir_node *node);
670
671
672
/** 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
673
FIRM_API ir_node  *get_Tuple_pred(const ir_node *node, int pos);
674
675
/** 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);
676

Matthias Braun's avatar
Matthias Braun committed
677
678
679
680
681
682
/** @} */

/** @addtogroup ASM
 * @{
 */

683
/** Returns the number of input constraints for an ASM node. */
684
685
686
FIRM_API int get_ASM_n_inputs(const ir_node *node);
/** Returns input number @p pos of an ASM node. */
FIRM_API ir_node *get_ASM_input(const ir_node *node, int pos);
687
/** Returns the number of output constraints for an ASM node.  */
688
FIRM_API size_t get_ASM_n_output_constraints(const ir_node *node);
689
/** Returns the number of clobbered registers for an ASM node.  */
690
FIRM_API size_t get_ASM_n_clobbers(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
691

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

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

718
719
720
721
722
/**
 * 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
723
FIRM_API int is_fragile_op(const ir_node *node);
Christian Schäfer's avatar
Christian Schäfer committed
724

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

729
/**
730
 * Copies attributes stored in the old node to a new node.
731
 * Assumes both have the same opcode and sufficient size.
732
733
734
735
736
737
738
739
740
 *
 * @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
741
 */
Michael Beck's avatar
Michael Beck committed
742
FIRM_API void copy_node_attr(ir_graph *irg, const ir_node *old_node, ir_node *new_node);
743

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

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

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

Michael Beck's avatar
Michael Beck committed
754
755
756
757
/**
 * 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
758
FIRM_API int is_irn_keep(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
759

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

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

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

773
/**
774
775
 * Returns a pointer to the node attributes.
 * Used for accessing attributes of user-defined nodes.
776
 */
Michael Beck's avatar
Michael Beck committed
777
FIRM_API void *get_irn_generic_attr(ir_node *node);
778
779
780
781
/**
 * Returns a pointer to the node attributes.
 * Used for accessing attributes of user-defined nodes.
 */
Michael Beck's avatar
Michael Beck committed
782
FIRM_API const void *get_irn_generic_attr_const(const ir_node *node);
783

784
785
786
/**
 * Returns the unique node index for the node in its graph.
 * This index is used to access phase information for this node.
787
 * @see get_idx_irn()
788
 */
Michael Beck's avatar
Michael Beck committed
789
FIRM_API unsigned get_irn_idx(const ir_node *node);
790

791
792
793
794
795
796
/**
 * Sets the debug information of a node.
 *
 * @param n   The node.
 * @param db  The debug info.
 */
Michael Beck's avatar
Michael Beck committed
797
FIRM_API void set_irn_dbg_info(ir_node *n, dbg_info *db);
798
799
800
801
802
803

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

806
/**
807
 * Returns a descriptive name of a node (containing type+number)
808
 */
Michael Beck's avatar
Michael Beck committed
809
FIRM_API const char *gdb_node_helper(void *firm_object);
810

811
812
813
814
815
816
817
818
819
/**
 * @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
820
821
FIRM_API ir_switch_table *ir_new_switch_table(ir_graph *irg, size_t n_entries);

822
823
824
/**
 * Returns number of entries available in switch table @p table.
 */
Matthias Braun's avatar
Matthias Braun committed
825
826
FIRM_API size_t ir_switch_table_get_n_entries(const ir_switch_table *table);

827
828
829
830
831
832
833
834
/**
 * 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
835
836
837
FIRM_API void ir_switch_table_set(ir_switch_table *table, size_t entry,
                                  ir_tarval *min, ir_tarval *max, long pn);

838
/** Returns maximum tarval value of switch table entry @p entry */
Matthias Braun's avatar
Matthias Braun committed
839
840
841
FIRM_API ir_tarval *ir_switch_table_get_max(const ir_switch_table *table,
                                            size_t entry);

842
/** Returns minimum tarval value of switch table entry @p entry */
Matthias Braun's avatar
Matthias Braun committed
843
844
845
FIRM_API ir_tarval *ir_switch_table_get_min(const ir_switch_table *table,
                                            size_t entry);

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

849
/** Duplicates switch table @p table on obstack of @p irg */
Matthias Braun's avatar
Matthias Braun committed
850
FIRM_API ir_switch_table *ir_switch_table_duplicate(ir_graph *irg, const ir_switch_table *table);
851
/** @} */
Matthias Braun's avatar
Matthias Braun committed
852

853
/** @} */
854

855
856
#include "end.h"

Matthias Braun's avatar
Matthias Braun committed
857
#endif