irnode.h 28.1 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
39
 * @ingroup ir_graph
 * @defgroup ir_node Graph 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
78
79

/**
 * Get the n-th predecessor of a node.
 * 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

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

/**
Michael Beck's avatar
Michael Beck committed
120
121
122
123
124
 * 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
125
FIRM_API ir_node *get_irn_dep(const ir_node *node, int pos);
Sebastian Hack's avatar
Sebastian Hack committed
126
127

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

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

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

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

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

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

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

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

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

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

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

233
234
235
236
237
/**
 * 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
238
239
240
241
242
 *
 * 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
243
 * get_irn_block(). */
244
FIRM_API ir_node *get_nodes_block(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
245
246

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

249
/** Return the number of control flow predecessors of a block. */
Michael Beck's avatar
Michael Beck committed
250
FIRM_API int get_Block_n_cfgpreds(const ir_node *block);
251
/** Return the control flow predecessor of a block at a given position. */
Michael Beck's avatar
Michael Beck committed
252
FIRM_API ir_node *get_Block_cfgpred(const ir_node *block, int pos);
253
/** Set the control flow predecessor of a block at a given position. */
Michael Beck's avatar
Michael Beck committed
254
FIRM_API void set_Block_cfgpred(ir_node *block, int pos, ir_node *pred);
255
256
257
258
259
260
261
262
263
264
265
266
267
268

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

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

/** Return the matured flag of a block */
Michael Beck's avatar
Michael Beck committed
285
FIRM_API int get_Block_matured(const ir_node *block);
286
/** set the matured flag of a block. */
Michael Beck's avatar
Michael Beck committed
287
FIRM_API void set_Block_matured(ir_node *block, int matured);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
288
289
290

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

295
/** mark a block as visited by setting its visited counter */
Michael Beck's avatar
Michael Beck committed
296
FIRM_API void mark_Block_block_visited(ir_node *node);
297
/** returns 1 if a block is marked as visited */
Michael Beck's avatar
Michael Beck committed
298
FIRM_API int Block_block_visited(const ir_node *node);
Christian Schäfer's avatar
Christian Schäfer committed
299

300
/** Returns the extended basic block a block belongs to. */
Michael Beck's avatar
Michael Beck committed
301
FIRM_API ir_extblk *get_Block_extbb(const ir_node *block);
302
/** Sets the extended basic block a block belongs to. */
Michael Beck's avatar
Michael Beck committed
303
FIRM_API void set_Block_extbb(ir_node *block, ir_extblk *extblk);
304
/** Returns the ir_graph this Block belongs to. */
Michael Beck's avatar
Michael Beck committed
305
FIRM_API ir_graph *get_Block_irg(const ir_node *block);
306
/** Returns the entity for a Block (creating it if necessary) */
Michael Beck's avatar
Michael Beck committed
307
FIRM_API ir_entity *create_Block_entity(ir_node *block);
308
/** Gets the head of the Phi list for this block. */
Michael Beck's avatar
Michael Beck committed
309
FIRM_API ir_node *get_Block_phis(const ir_node *block);
310
/** Sets the head of the Phi list for this block. */
Michael Beck's avatar
Michael Beck committed
311
FIRM_API void set_Block_phis(ir_node *block, ir_node *phi);
Michael Beck's avatar
Michael Beck committed
312
/** Add a Phi node to the list of Block Phi's. */
Michael Beck's avatar
Michael Beck committed
313
FIRM_API void add_Block_phi(ir_node *block, ir_node *phi);
Michael Beck's avatar
Michael Beck committed
314
/** Get the Block mark (single bit). */
Michael Beck's avatar
Michael Beck committed
315
FIRM_API unsigned get_Block_mark(const ir_node *block);
Michael Beck's avatar
Michael Beck committed
316
/** Set the Block mark (single bit). */
Michael Beck's avatar
Michael Beck committed
317
FIRM_API void set_Block_mark(ir_node *block, unsigned mark);
Michael Beck's avatar
Michael Beck committed
318

Matthias Braun's avatar
Matthias Braun committed
319
320
321
322
323
324
325
326
327
328
329
330
/** @} */

/** 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. */
FIRM_API ir_type *is_frame_pointer(const ir_node *n);

/** @addtogroup End
 * @{
 */

Michael Beck's avatar
Michael Beck committed
331
/** Return the number of Keep alive node. */
Michael Beck's avatar
Michael Beck committed
332
FIRM_API int get_End_n_keepalives(const ir_node *end);
Michael Beck's avatar
Michael Beck committed
333
/** Return the Keep alive node a position pos. */
Michael Beck's avatar
Michael Beck committed
334
FIRM_API ir_node *get_End_keepalive(const ir_node *end, int pos);
Michael Beck's avatar
Michael Beck committed
335
/** Keep alive dedicated nodes.  These must be either PhiM or Block nodes. */
Michael Beck's avatar
Michael Beck committed
336
FIRM_API void add_End_keepalive(ir_node *end, ir_node *ka);
Michael Beck's avatar
Michael Beck committed
337
/** Set the Keep alive node at position pos. */
Michael Beck's avatar
Michael Beck committed
338
FIRM_API void set_End_keepalive(ir_node *end, int pos, ir_node *ka);
339
340
341
342
343
344

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

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

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

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

Matthias Braun's avatar
Matthias Braun committed
358
359
360
361
362
363
/** @} */

/** @addtogroup Return
 * @{
 */

Michael Beck's avatar
Michael Beck committed
364
FIRM_API ir_node **get_Return_res_arr(ir_node *node);
365
FIRM_API size_t    get_Return_n_ress(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
366
367
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
368

Matthias Braun's avatar
Matthias Braun committed
369
370
371
372
373
374
/** @} */

/** @addtogroup Const
 * @{
 */

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

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

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

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

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

Matthias Braun's avatar
Matthias Braun committed
392
393
394
395
396
397
398
399
/**
 * @addtogroup SymConst
 * @{
 */

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

402
403
404
405
/** 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 */
406
#define SYMCONST_HAS_ENT(kind) ((kind) == symconst_addr_ent || (kind) == symconst_ofs_ent)
407

408
409
410
/** 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
411
/** Get the kind of the SymConst. */
Michael Beck's avatar
Michael Beck committed
412
FIRM_API symconst_kind get_SymConst_kind(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
413
/** Set the kind of the SymConst. */
Michael Beck's avatar
Michael Beck committed
414
FIRM_API void          set_SymConst_kind(ir_node *node, symconst_kind num);
Beyhan's avatar
Beyhan committed
415

Matthias Braun's avatar
Matthias Braun committed
416
/** Only to access SymConst of kind type_size.  Else assertion: */
Michael Beck's avatar
Michael Beck committed
417
418
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
419
420

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

424
/** Only to access SymConst of kind symconst_enum_const.  Else assertion: */
Michael Beck's avatar
Michael Beck committed
425
426
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);
427

Michael Beck's avatar
Michael Beck committed
428
429
FIRM_API union symconst_symbol get_SymConst_symbol(const ir_node *node);
FIRM_API void                  set_SymConst_symbol(ir_node *node,
430
                                                   union symconst_symbol sym);
431

Matthias Braun's avatar
Matthias Braun committed
432
433
434
435
436
437
/** @} */

/** @addtogroup Sel
 * @{
 */

Michael Beck's avatar
Michael Beck committed
438
439
440
441
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);
442

Matthias Braun's avatar
Matthias Braun committed
443
444
445
446
447
448
/** @} */

/** @addtogroup Call
 * @{
 */

Michael Beck's avatar
Michael Beck committed
449
FIRM_API ir_node **get_Call_param_arr(ir_node *node);
Michael Beck's avatar
Michael Beck committed
450
/** Gets the number of parameters of a call. */
451
FIRM_API size_t   get_Call_n_params(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
452
/** Gets the call parameter at position pos. */
Michael Beck's avatar
Michael Beck committed
453
FIRM_API ir_node *get_Call_param(const ir_node *node, int pos);
Michael Beck's avatar
Michael Beck committed
454
/** Sets the call parameter at position pos. */
Michael Beck's avatar
Michael Beck committed
455
FIRM_API void     set_Call_param(ir_node *node, int pos, ir_node *param);
Michael Beck's avatar
Michael Beck committed
456

457
458
459
460
/** 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
461
462
463
464
 *  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.
465
466
467
468
469
470
471
472
473
 *
 *  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
474
FIRM_API int        Call_has_callees(const ir_node *node);
475
476
FIRM_API size_t     get_Call_n_callees(const ir_node *node);
FIRM_API ir_entity *get_Call_callee(const ir_node *node, size_t pos);
Michael Beck's avatar
Michael Beck committed
477

478
479
480
/** Set the full callee array.
 *
 *  The passed array is copied. Assumes current_ir_graph set properly! */
481
FIRM_API void set_Call_callee_arr(ir_node *node, size_t n, ir_entity **arr);
Michael Beck's avatar
Michael Beck committed
482
FIRM_API void remove_Call_callee_arr(ir_node *node);
483

Matthias Braun's avatar
Matthias Braun committed
484
485
486
487
488
489
/** @} */

/** @addtogroup Builtin
 * @{
 */

Michael Beck's avatar
Michael Beck committed
490
FIRM_API ir_node         **get_Builtin_param_arr(ir_node *node);
491
/** Gets the number of parameters of a Builtin. */
Michael Beck's avatar
Michael Beck committed
492
FIRM_API int             get_Builtin_n_params(const ir_node *node);
493
/** Gets the Builtin parameter at position pos. */
Michael Beck's avatar
Michael Beck committed
494
FIRM_API ir_node         *get_Builtin_param(const ir_node *node, int pos);
495
/** Sets the Builtin parameter at position pos. */
Michael Beck's avatar
Michael Beck committed
496
FIRM_API void            set_Builtin_param(ir_node *node, int pos, ir_node *param);
Matthias Braun's avatar
Matthias Braun committed
497
498
499

/** @} */

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

Michael Beck's avatar
Michael Beck committed
503
504
505
506
507
508
509
510
511
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);

Matthias Braun's avatar
Matthias Braun committed
512
513
514
515
516
517
518
519
520
/**
 * Test wether a node is the X_except Proj of a fragile operation
 */
FIRM_API int      is_x_except_Proj(const ir_node *node);

/**
 * Test wether a node is the X_regular Proj of a fragile operation
 */
FIRM_API int      is_x_regular_Proj(const ir_node *node);
521
522
523
524
525
526
527
528
529
530
531

/**
 * Set throws exception attribute of a fragile node
 * @p throws_exception must be 0 or 1
 */
FIRM_API void     ir_set_throws_exception(ir_node *node, int throws_exception);

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

533
534
/** returns the name of an ir_relation */
FIRM_API const char *get_relation_string(ir_relation relation);
Michael Beck's avatar
Michael Beck committed
535

536
537
/** 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
538

539
540
/** Calculates the inversed (R^-1) relation, i.e., "<" --> ">" */
FIRM_API ir_relation get_inversed_relation(ir_relation relation);
541

Matthias Braun's avatar
Matthias Braun committed
542
543
544
545
546
/**
 * @addtogroup Cast
 * @{
 */

Götz Lindenmaier's avatar
Götz Lindenmaier committed
547
548
549
550
/** Checks for upcast.
 *
 * Returns true if the Cast node casts a class type to a super type.
 * Works also for pointers to classes (recursively).
551
552
 *
 * Needs typeinfo calculated.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
553
 */
Michael Beck's avatar
Michael Beck committed
554
FIRM_API int is_Cast_upcast(ir_node *node);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
555
556
557
558
559

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

Matthias Braun's avatar
Matthias Braun committed
565
566
567
568
569
570
571
/** @} */

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

Michael Beck's avatar
Michael Beck committed
572
/** Returns true if irg in phase phase_building and the Phi has zero
573
   predecessors. It's a Phi0 then. */
Michael Beck's avatar
Michael Beck committed
574
575
576
577
578
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);
579
580
581
/**
 * Returns the next element of a block phi list.
 */
Michael Beck's avatar
Michael Beck committed
582
FIRM_API ir_node  *get_Phi_next(const ir_node *phi);
583
584
585
/**
 * Sets the next link of a block Phi list.
 */
Michael Beck's avatar
Michael Beck committed
586
FIRM_API void      set_Phi_next(ir_node *phi, ir_node *next);
587

Matthias Braun's avatar
Matthias Braun committed
588
589
/** @} */

590
/** Return true if @p node is a memory operation.
591
 *
Götz Lindenmaier's avatar
Götz Lindenmaier committed
592
 *  A memory operation is an operation that changes the
593
 *  memory.  I.e., a Load or a Store operation.
594
 *  memops have a memory input and output
595
 */
Michael Beck's avatar
Michael Beck committed
596
597
598
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);
599

Michael Beck's avatar
Michael Beck committed
600
601
602
603
604
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);
605

Michael Beck's avatar
Michael Beck committed
606
607
608
609
610
/**
 * Returns non-zero if a node is a routine parameter.
 *
 * @param node  the Proj node to test
 */
Michael Beck's avatar
Michael Beck committed
611
FIRM_API int is_arg_Proj(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
612

Matthias Braun's avatar
Matthias Braun committed
613
614
615
616
/** @addtogroup Tuple
 * @{
 */

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

Matthias Braun's avatar
Matthias Braun committed
622
623
624
625
626
627
/** @} */

/** @addtogroup ASM
 * @{
 */

Michael Beck's avatar
Michael Beck committed
628
/** Return the number of input constraints for an ASM node. */
629
FIRM_API size_t get_ASM_n_input_constraints(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
630
/** Return the number of output constraints for an ASM node.  */
631
FIRM_API size_t get_ASM_n_output_constraints(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
632
/** Return the number of clobbered registers for an ASM node.  */
633
FIRM_API size_t get_ASM_n_clobbers(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
634

Matthias Braun's avatar
Matthias Braun committed
635
636
/** @} */

Michael Beck's avatar
Michael Beck committed
637
/** Returns operand of node if node is a Proj. */
Michael Beck's avatar
Michael Beck committed
638
FIRM_API ir_node *skip_Proj(ir_node *node);
Michael Beck's avatar
Michael Beck committed
639
/** Returns operand of node if node is a Proj. */
Michael Beck's avatar
Michael Beck committed
640
FIRM_API const ir_node *skip_Proj_const(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
641
/** Returns operand of node if node is a Id. */
642
643
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
644
FIRM_API ir_node *skip_Tuple(ir_node *node);
Michael Beck's avatar
Michael Beck committed
645
/** Returns operand of node if node is a Cast. */
Michael Beck's avatar
Michael Beck committed
646
647
FIRM_API ir_node *skip_Cast(ir_node *node);
FIRM_API const ir_node *skip_Cast_const(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
648
/** Returns operand of node if node is a Pin. */
Michael Beck's avatar
Michael Beck committed
649
FIRM_API ir_node *skip_Pin(ir_node *node);
Michael Beck's avatar
Michael Beck committed
650
/** Returns operand of node if node is a Confirm */
Michael Beck's avatar
Michael Beck committed
651
FIRM_API ir_node *skip_Confirm(ir_node *node);
Michael Beck's avatar
Michael Beck committed
652
/** Skip all high-level Operations (including Cast, Confirm). */
Michael Beck's avatar
Michael Beck committed
653
FIRM_API ir_node *skip_HighLevel_ops(ir_node *node);
654
/** Returns true if the operation manipulates control flow */
Michael Beck's avatar
Michael Beck committed
655
FIRM_API int is_cfop(const ir_node *node);
656
657
658
/** returns true if the operation jumps to an unknown destination.
 * See irop_flag_unknown_jump for a detailed explanation */
FIRM_API int is_unknown_jump(const ir_node *node);
659

660
661
662
663
664
/**
 * 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
665
FIRM_API int is_fragile_op(const ir_node *node);
Christian Schäfer's avatar
Christian Schäfer committed
666

Michael Beck's avatar
Michael Beck committed
667
668
/** Returns true if the operation is a forking control flow
 *  operation: Cond. */
Michael Beck's avatar
Michael Beck committed
669
FIRM_API int is_irn_forking(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
670

671
/**
672
 * Copies attributes stored in the old node to a new node.
673
 * Assumes both have the same opcode and sufficient size.
674
675
676
677
678
679
680
681
682
 *
 * @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
683
 */
Michael Beck's avatar
Michael Beck committed
684
FIRM_API void copy_node_attr(ir_graph *irg, const ir_node *old_node, ir_node *new_node);
685

Michael Beck's avatar
Michael Beck committed
686
/** Return the type attribute of a node n (SymConst, Call, Alloc, Free,
687
 *  Cast) or NULL.*/
Michael Beck's avatar
Michael Beck committed
688
FIRM_API ir_type *get_irn_type_attr(ir_node *n);
Michael Beck's avatar
Michael Beck committed
689
690

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

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

Michael Beck's avatar
Michael Beck committed
696
697
698
699
/**
 * 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
700
FIRM_API int is_irn_keep(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
701

702
703
704
/**
 * Returns non-zero for nodes that are always placed in the start block.
 */
Michael Beck's avatar
Michael Beck committed
705
FIRM_API int is_irn_start_block_placed(const ir_node *node);
706

707
708
709
/**
 * Returns non-zero for nodes that are CSE neutral to its users.
 */
Michael Beck's avatar
Michael Beck committed
710
FIRM_API int is_irn_cse_neutral(const ir_node *node);
711

712
/** Gets the string representation of the jump prediction. */
Michael Beck's avatar
Michael Beck committed
713
FIRM_API const char *get_cond_jmp_predicate_name(cond_jmp_predicate pred);
714

715
716
717
718
719
720
/**
 * 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
721
 * @param off The value returned by register_additional_node_data().
722
723
724
 * @return A pointer of type @p type.
 */
#define get_irn_data(node,type,off) \
Sebastian Hack's avatar
Sebastian Hack committed
725
726
727
728
729
730
731
732
733
734
  (assert(off > 0 && "Invalid node data offset"), (type *) ((char *) (node) - (off)))

/**
 * Get the pointer to the node some custom data belongs to.
 * @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)))
735
736
737
738

/**
 * 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
739
 * @return A positive number, if the operation was successful, which
740
741
742
 * must be passed to the access macro get_irn_data(), 0 if the
 * registration failed.
 */
Michael Beck's avatar
Michael Beck committed
743
FIRM_API unsigned firm_register_additional_node_data(unsigned size);
744

745
746
747
748
/**
 * Return a pointer to the node attributes.
 * Needed for user-defined nodes.
 */
Michael Beck's avatar
Michael Beck committed
749
750
FIRM_API void *get_irn_generic_attr(ir_node *node);
FIRM_API const void *get_irn_generic_attr_const(const ir_node *node);
751

752
753
754
755
/**
 * Returns the unique node index for the node in its graph.
 * This index is used to access phase information for this node.
 */
Michael Beck's avatar
Michael Beck committed
756
FIRM_API unsigned get_irn_idx(const ir_node *node);
757

758
759
760
761
762
763
/**
 * Sets the debug information of a node.
 *
 * @param n   The node.
 * @param db  The debug info.
 */
Michael Beck's avatar
Michael Beck committed
764
FIRM_API void set_irn_dbg_info(ir_node *n, dbg_info *db);
765
766
767
768
769
770

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

773
774
/**
 * Calculate a hash value of a node. Only inputs, mode and opcode are used.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
775
 *
776
777
 * @param node  the node to hash
 */
Michael Beck's avatar
Michael Beck committed
778
FIRM_API unsigned firm_default_hash(const ir_node *node);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
779

780
781
782
/**
 * returns a descriptive name of a node (containing type+number)
 */
Michael Beck's avatar
Michael Beck committed
783
FIRM_API const char *gdb_node_helper(void *firm_object);
784

Matthias Braun's avatar
Matthias Braun committed
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
FIRM_API ir_switch_table *ir_new_switch_table(ir_graph *irg, size_t n_entries);

FIRM_API size_t ir_switch_table_get_n_entries(const ir_switch_table *table);

FIRM_API void ir_switch_table_set(ir_switch_table *table, size_t entry,
                                  ir_tarval *min, ir_tarval *max, long pn);

FIRM_API ir_tarval *ir_switch_table_get_max(const ir_switch_table *table,
                                            size_t entry);

FIRM_API ir_tarval *ir_switch_table_get_min(const ir_switch_table *table,
                                            size_t entry);

FIRM_API long ir_switch_table_get_pn(const ir_switch_table *table, size_t entry);

FIRM_API ir_switch_table *ir_switch_table_duplicate(ir_graph *irg, const ir_switch_table *table);

802
/*@}*/
803

804
805
#include "end.h"

Matthias Braun's avatar
Matthias Braun committed
806
#endif