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

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

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

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

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

130
131
132
133
134
135
136
137
138
/**
 * 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);

139
/** Replaces the n-th predecessor of a node with a new one. */
Michael Beck's avatar
Michael Beck committed
140
FIRM_API void set_irn_n(ir_node *node, int n, ir_node *in);
141
142
143
144
145
/**
 * 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
146
FIRM_API int add_irn_n(ir_node *node, ir_node *in);
147
/** Sets the mode struct of node.  */
Michael Beck's avatar
Michael Beck committed
148
FIRM_API void set_irn_mode(ir_node *node, ir_mode *mode);
149
/** Returns the mode struct of a node.  */
Michael Beck's avatar
Michael Beck committed
150
FIRM_API ir_mode *get_irn_mode(const ir_node *node);
151
/** Returns the opcode struct of the node. */
Michael Beck's avatar
Michael Beck committed
152
FIRM_API ir_op *get_irn_op(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
153
/** Sets the opcode struct of the node. */
Michael Beck's avatar
Michael Beck committed
154
FIRM_API void set_irn_op(ir_node *node, ir_op *op);
155
/** Returns the opcode-enum of the node. */
Michael Beck's avatar
Michael Beck committed
156
FIRM_API unsigned get_irn_opcode(const ir_node *node);
157
/** Returns the string representation of the opcode. */
Michael Beck's avatar
Michael Beck committed
158
FIRM_API const char *get_irn_opname(const ir_node *node);
159
/** Returns the ident for a string representation of the opcode. */
Michael Beck's avatar
Michael Beck committed
160
FIRM_API ident *get_irn_opident(const ir_node *node);
161
/** Returns 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);
165
/** Sets visited to get_irg_visited(get_irn_irg(node)). */
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(get_irn_irg(node)). */
Michael Beck's avatar
Michael Beck committed
168
FIRM_API int irn_visited(const ir_node *node);
169
/** Returns 1 if visited >= get_irg_visited(get_irn_irg(node)). Marks the node
170
 * 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
/** Sets 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
 * Returns the block the node belongs to.  This is only
235
236
237
 * 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
/**
250
 * Returns the position of the predecessor block pred in the inputs
251
252
253
254
255
256
257
 * 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
258
FIRM_API int get_Block_cfgpred_pos(const ir_node *block, const ir_node *pred);
259

260
261
/**
 * Returns the predecessor block.
262
 *
263
 * Returns the block corresponding to the predecessor pos of block.
264
 *
265
266
 * If we encounter the Bad node, this function does not return Start block, but
 * the Bad node.
267
 */
Michael Beck's avatar
Michael Beck committed
268
FIRM_API ir_node *get_Block_cfgpred_block(const ir_node *node, int pos);
269

270
/** Returns the matured flag of a block */
Michael Beck's avatar
Michael Beck committed
271
FIRM_API int get_Block_matured(const ir_node *block);
272
/** set the matured flag of a block. */
Michael Beck's avatar
Michael Beck committed
273
FIRM_API void set_Block_matured(ir_node *block, int matured);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
274
275
276

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

281
/** Marks a block as visited by setting its visited counter */
Michael Beck's avatar
Michael Beck committed
282
FIRM_API void mark_Block_block_visited(ir_node *node);
283
/** Returns 1 if a block is marked as visited */
Michael Beck's avatar
Michael Beck committed
284
FIRM_API int Block_block_visited(const ir_node *node);
Christian Schäfer's avatar
Christian Schäfer committed
285

286
/** Returns the ir_graph this Block belongs to. */
Michael Beck's avatar
Michael Beck committed
287
FIRM_API ir_graph *get_Block_irg(const ir_node *block);
288
/** Returns the entity for a Block (creating it if necessary) */
Michael Beck's avatar
Michael Beck committed
289
FIRM_API ir_entity *create_Block_entity(ir_node *block);
290
/** Returns the head of the Phi list for this block. */
Michael Beck's avatar
Michael Beck committed
291
FIRM_API ir_node *get_Block_phis(const ir_node *block);
292
/** Sets the head of the Phi list for this block. */
Michael Beck's avatar
Michael Beck committed
293
FIRM_API void set_Block_phis(ir_node *block, ir_node *phi);
Michael Beck's avatar
Michael Beck committed
294
/** Add a Phi node to the list of Block Phi's. */
Michael Beck's avatar
Michael Beck committed
295
FIRM_API void add_Block_phi(ir_node *block, ir_node *phi);
296
/** Returns the Block mark (single bit). */
Michael Beck's avatar
Michael Beck committed
297
FIRM_API unsigned get_Block_mark(const ir_node *block);
298
/** Sets the Block mark (single bit). */
Michael Beck's avatar
Michael Beck committed
299
FIRM_API void set_Block_mark(ir_node *block, unsigned mark);
Michael Beck's avatar
Michael Beck committed
300

Matthias Braun's avatar
Matthias Braun committed
301
302
/** @} */

303
/** Tests whether arbitrary node is frame pointer.
Matthias Braun's avatar
Matthias Braun committed
304
 *
305
 * Tests whether arbitrary node is frame pointer, i.e. Proj(pn_Start_P_frame_base)
Matthias Braun's avatar
Matthias Braun committed
306
307
308
309
310
311
312
 * 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
313
/** Keep alive dedicated nodes.  These must be either PhiM or Block nodes. */
Michael Beck's avatar
Michael Beck committed
314
FIRM_API void add_End_keepalive(ir_node *end, ir_node *ka);
315
316

/**
317
 * Sets new keep-alives.
318
319
320
 * 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
321
FIRM_API void set_End_keepalives(ir_node *end, int n, ir_node *in[]);
322

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

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

Michael Beck's avatar
Michael Beck committed
329
/** Some parts of the End node are allocated separately -- their memory
330
331
332
 * 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
333
FIRM_API void free_End(ir_node *end);
334

Matthias Braun's avatar
Matthias Braun committed
335
336
337
338
339
340
/** @} */

/** @addtogroup Const
 * @{
 */

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

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

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

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

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

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

362
363
364
365
/** 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 */
366
#define SYMCONST_HAS_ENT(kind) ((kind) == symconst_addr_ent || (kind) == symconst_ofs_ent)
367

368
369
370
/** Returns non-zero if s symconst kind has an enum_const attribute */
#define SYMCONST_HAS_ENUM(kind) ((kind) == symconst_enum_const)

371
/** Returns the kind of the SymConst. */
Michael Beck's avatar
Michael Beck committed
372
FIRM_API symconst_kind get_SymConst_kind(const ir_node *node);
373
374
/** Sets the kind of the SymConst. */
FIRM_API void set_SymConst_kind(ir_node *node, symconst_kind num);
Beyhan's avatar
Beyhan committed
375

376
377
378
379
380
381
/** 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
382

383
384
385
/** 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
386
FIRM_API ir_entity *get_SymConst_entity(const ir_node *node);
387
388
/** 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
389

390
391
392
/** 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
393
FIRM_API ir_enum_const *get_SymConst_enum(const ir_node *node);
394
395
/** Sets the enum attribute of SymConst node @p node. */
FIRM_API void set_SymConst_enum(ir_node *node, ir_enum_const *ec);
396

397
/** Returns the symbol attribute of SymConst node @p node. */
Michael Beck's avatar
Michael Beck committed
398
FIRM_API union symconst_symbol get_SymConst_symbol(const ir_node *node);
399
400
/** Sets the symbol attribute of SymConst node @p node. */
FIRM_API void set_SymConst_symbol(ir_node *node, union symconst_symbol sym);
401

Matthias Braun's avatar
Matthias Braun committed
402
403
404
405
406
407
/** @} */

/** @addtogroup Call
 * @{
 */

408
/** Sets, get and remove the callee information for a Call node.
409
410
411
 *
 *  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
412
413
414
415
 *  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.
416
417
418
419
420
421
422
423
424
 *
 *  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.
 */
425
426
427
428
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. */
429
FIRM_API ir_entity *get_Call_callee(const ir_node *node, size_t pos);
Michael Beck's avatar
Michael Beck committed
430

431
/** Sets the full callee array.
432
 *
433
 *  The passed array is copied. */
434
FIRM_API void set_Call_callee_arr(ir_node *node, size_t n, ir_entity **arr);
435
/** Frees callee array of call node @p node */
Michael Beck's avatar
Michael Beck committed
436
FIRM_API void remove_Call_callee_arr(ir_node *node);
437

Matthias Braun's avatar
Matthias Braun committed
438
439
/** @} */

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

443
444
445
446
447
/** 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
448
FIRM_API ir_node *get_unop_op(const ir_node *node);
449
450
451
452
453
454
455
456
/** 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
457
FIRM_API ir_node *get_binop_left(const ir_node *node);
458
459
460
/** 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
461
FIRM_API ir_node *get_binop_right(const ir_node *node);
462
463
/** 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
464

Matthias Braun's avatar
Matthias Braun committed
465
/**
466
 * Tests whether a node is the X_except Proj of a fragile operation
Matthias Braun's avatar
Matthias Braun committed
467
 */
468
FIRM_API int is_x_except_Proj(const ir_node *node);
Matthias Braun's avatar
Matthias Braun committed
469
470

/**
471
 * Tests whether a node is the X_regular Proj of a fragile operation
Matthias Braun's avatar
Matthias Braun committed
472
 */
473
FIRM_API int is_x_regular_Proj(const ir_node *node);
474
475

/**
476
 * Sets throws exception attribute of a fragile node
477
478
 * @p throws_exception must be 0 or 1
 */
479
FIRM_API void ir_set_throws_exception(ir_node *node, int throws_exception);
480

481
482
/** 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
483

484
/** Returns the name of an ir_relation */
485
FIRM_API const char *get_relation_string(ir_relation relation);
Michael Beck's avatar
Michael Beck committed
486

487
488
/** 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
489

490
491
/** Calculates the inversed (R^-1) relation, i.e., "<" --> ">" */
FIRM_API ir_relation get_inversed_relation(ir_relation relation);
492

Matthias Braun's avatar
Matthias Braun committed
493
494
495
496
497
/**
 * @addtogroup Cast
 * @{
 */

Götz Lindenmaier's avatar
Götz Lindenmaier committed
498
499
500
501
/** Checks for upcast.
 *
 * Returns true if the Cast node casts a class type to a super type.
 * Works also for pointers to classes (recursively).
502
503
 *
 * Needs typeinfo calculated.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
504
 */
Michael Beck's avatar
Michael Beck committed
505
FIRM_API int is_Cast_upcast(ir_node *node);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
506
507
508
509
510

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

Matthias Braun's avatar
Matthias Braun committed
516
517
518
519
520
521
522
/** @} */

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

523
524
525
/**
 * Returns the next element of a block phi list.
 */
526
FIRM_API ir_node *get_Phi_next(const ir_node *phi);
527
528
529
/**
 * Sets the next link of a block Phi list.
 */
530
FIRM_API void set_Phi_next(ir_node *phi, ir_node *next);
531

Matthias Braun's avatar
Matthias Braun committed
532
533
/** @} */

534
/** Returns true if @p node is a memory operation.
535
 *
536
537
538
539
540
541
 * 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.
542
 */
Michael Beck's avatar
Michael Beck committed
543
FIRM_API ir_node *get_memop_mem(const ir_node *node);
544
545
546
547
548
549
550
551
/**
 * Sets the memory input of a memory operation.
 */
FIRM_API void set_memop_mem(ir_node *node, ir_node *mem);

/** @addtogroup Sync
 * @{
 */
552

553
554
555
556
557
558
/** 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);

/** @} */
559

Michael Beck's avatar
Michael Beck committed
560
561
562
563
564
/**
 * Returns non-zero if a node is a routine parameter.
 *
 * @param node  the Proj node to test
 */
Michael Beck's avatar
Michael Beck committed
565
FIRM_API int is_arg_Proj(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
566

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

571
/** Returns the number of output constraints for an ASM node.  */
572
FIRM_API size_t get_ASM_n_output_constraints(const ir_node *node);
573
/** Returns the number of clobbered registers for an ASM node.  */
574
FIRM_API size_t get_ASM_n_clobbers(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
575

Matthias Braun's avatar
Matthias Braun committed
576
577
/** @} */

Michael Beck's avatar
Michael Beck committed
578
/** Returns operand of node if node is a Proj. */
Michael Beck's avatar
Michael Beck committed
579
FIRM_API ir_node *skip_Proj(ir_node *node);
Michael Beck's avatar
Michael Beck committed
580
/** Returns operand of node if node is a Proj. */
Michael Beck's avatar
Michael Beck committed
581
FIRM_API const ir_node *skip_Proj_const(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
582
/** Returns operand of node if node is a Id. */
583
584
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
585
FIRM_API ir_node *skip_Tuple(ir_node *node);
Michael Beck's avatar
Michael Beck committed
586
/** Returns operand of node if node is a Cast. */
Michael Beck's avatar
Michael Beck committed
587
FIRM_API ir_node *skip_Cast(ir_node *node);
588
/** Returns operand of node if node is a Cast. */
Michael Beck's avatar
Michael Beck committed
589
FIRM_API const ir_node *skip_Cast_const(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
590
/** Returns operand of node if node is a Pin. */
Michael Beck's avatar
Michael Beck committed
591
FIRM_API ir_node *skip_Pin(ir_node *node);
Michael Beck's avatar
Michael Beck committed
592
/** Returns operand of node if node is a Confirm */
Michael Beck's avatar
Michael Beck committed
593
FIRM_API ir_node *skip_Confirm(ir_node *node);
Michael Beck's avatar
Michael Beck committed
594
/** Skip all high-level Operations (including Cast, Confirm). */
Michael Beck's avatar
Michael Beck committed
595
FIRM_API ir_node *skip_HighLevel_ops(ir_node *node);
596
/** Returns true if the operation manipulates control flow */
Michael Beck's avatar
Michael Beck committed
597
FIRM_API int is_cfop(const ir_node *node);
598
/** Returns true if the operation jumps to an unknown destination.
599
600
 * See irop_flag_unknown_jump for a detailed explanation */
FIRM_API int is_unknown_jump(const ir_node *node);
601

602
603
604
605
606
/**
 * 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
607
FIRM_API int is_fragile_op(const ir_node *node);
Christian Schäfer's avatar
Christian Schäfer committed
608

Michael Beck's avatar
Michael Beck committed
609
610
/** Returns true if the operation is a forking control flow
 *  operation: Cond. */
Michael Beck's avatar
Michael Beck committed
611
FIRM_API int is_irn_forking(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
612

613
/**
614
 * Copies attributes stored in the old node to a new node.
615
 * Assumes both have the same opcode and sufficient size.
616
617
618
619
620
621
622
623
624
 *
 * @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
625
 */
Michael Beck's avatar
Michael Beck committed
626
FIRM_API void copy_node_attr(ir_graph *irg, const ir_node *old_node, ir_node *new_node);
627

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

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

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

Michael Beck's avatar
Michael Beck committed
638
639
640
641
/**
 * 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
642
FIRM_API int is_irn_keep(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
643

644
645
646
/**
 * Returns non-zero for nodes that are always placed in the start block.
 */
Michael Beck's avatar
Michael Beck committed
647
FIRM_API int is_irn_start_block_placed(const ir_node *node);
648

649
650
651
/**
 * Returns non-zero for nodes that are CSE neutral to its users.
 */
Michael Beck's avatar
Michael Beck committed
652
FIRM_API int is_irn_cse_neutral(const ir_node *node);
653

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

657
/**
658
659
 * Returns a pointer to the node attributes.
 * Used for accessing attributes of user-defined nodes.
660
 */
Michael Beck's avatar
Michael Beck committed
661
FIRM_API void *get_irn_generic_attr(ir_node *node);
662
663
664
665
/**
 * Returns a pointer to the node attributes.
 * Used for accessing attributes of user-defined nodes.
 */
Michael Beck's avatar
Michael Beck committed
666
FIRM_API const void *get_irn_generic_attr_const(const ir_node *node);
667

668
669
670
/**
 * Returns the unique node index for the node in its graph.
 * This index is used to access phase information for this node.
671
 * @see get_idx_irn()
672
 */
Michael Beck's avatar
Michael Beck committed
673
FIRM_API unsigned get_irn_idx(const ir_node *node);
674

675
676
677
678
679
680
/**
 * Sets the debug information of a node.
 *
 * @param n   The node.
 * @param db  The debug info.
 */
Michael Beck's avatar
Michael Beck committed
681
FIRM_API void set_irn_dbg_info(ir_node *n, dbg_info *db);
682
683
684
685
686
687

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

690
/**
691
 * Returns a descriptive name of a node (containing type+number)
692
 */
Michael Beck's avatar
Michael Beck committed
693
FIRM_API const char *gdb_node_helper(void *firm_object);
694

695
696
697
698
699
700
701
702
703
/**
 * @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
704
705
FIRM_API ir_switch_table *ir_new_switch_table(ir_graph *irg, size_t n_entries);

706
707
708
/**
 * Returns number of entries available in switch table @p table.
 */
Matthias Braun's avatar
Matthias Braun committed
709
710
FIRM_API size_t ir_switch_table_get_n_entries(const ir_switch_table *table);

711
712
713
714
715
716
717
718
/**
 * 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
719
720
721
FIRM_API void ir_switch_table_set(ir_switch_table *table, size_t entry,
                                  ir_tarval *min, ir_tarval *max, long pn);

722
/** Returns maximum tarval value of switch table entry @p entry */
Matthias Braun's avatar
Matthias Braun committed
723
724
725
FIRM_API ir_tarval *ir_switch_table_get_max(const ir_switch_table *table,
                                            size_t entry);

726
/** Returns minimum tarval value of switch table entry @p entry */
Matthias Braun's avatar
Matthias Braun committed
727
728
729
FIRM_API ir_tarval *ir_switch_table_get_min(const ir_switch_table *table,
                                            size_t entry);

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

733
/** Duplicates switch table @p table on obstack of @p irg */
Matthias Braun's avatar
Matthias Braun committed
734
FIRM_API ir_switch_table *ir_switch_table_duplicate(ir_graph *irg, const ir_switch_table *table);
735
/** @} */
Matthias Braun's avatar
Matthias Braun committed
736

737
/** @} */
738

739
740
#include "end.h"

Matthias Braun's avatar
Matthias Braun committed
741
#endif