irnode.h 29.3 KB
Newer Older
Christian Würdig's avatar
Christian Würdig committed
1
/*
2
 * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
Christian Würdig's avatar
Christian Würdig committed
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
 *
 * This file is part of libFirm.
 *
 * This file may be distributed and/or modified under the terms of the
 * GNU General Public License version 2 as published by the Free Software
 * Foundation and appearing in the file LICENSE.GPL included in the
 * packaging of this file.
 *
 * Licensees holding valid libFirm Professional Edition licenses may use
 * this file in accordance with the libFirm Commercial License.
 * Agreement provided with the Software.
 *
 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE.
 */

Matthias Braun's avatar
Matthias Braun committed
20
21
22
23
24
/**
 * @file
 * @brief   Representation of an intermediate operation.
 * @author  Martin Trapp, Christian Schaefer, Goetz Lindenmaier, Michael Beck
 * @version $Id$
Michael Beck's avatar
Michael Beck committed
25
 */
Matthias Braun's avatar
Matthias Braun committed
26
27
#ifndef FIRM_IR_IRNODE_H
#define FIRM_IR_IRNODE_H
Christian Schäfer's avatar
Christian Schäfer committed
28

29
30
#include <stddef.h>

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

38
39
ENUM_BITSET(pn_Cmp)

Michael Beck's avatar
Michael Beck committed
40
41
42
/**
 * @defgroup ir_node Declarations of an ir node.
 *
43
 * The type definition of ir_node is also in irgraph.h to resolve
Michael Beck's avatar
Michael Beck committed
44
 *  recursion between irnode.h and irgraph.h
Götz Lindenmaier's avatar
Götz Lindenmaier committed
45
 *
Michael Beck's avatar
Michael Beck committed
46
 * ir_node - a datatype representing a Firm node
Götz Lindenmaier's avatar
Götz Lindenmaier committed
47
 *
Michael Beck's avatar
Michael Beck committed
48
49
50
51
52
53
54
55
56
57
58
59
60
 *  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
61
 */
Michael Beck's avatar
Michael Beck committed
62

Sebastian Felis's avatar
Sebastian Felis committed
63
64
65
/**
 *   Checks whether a pointer points to a ir node.
 *
66
67
 *   @param thing   an arbitrary pointer
 *   @return        non-zero if the thing is a ir mode, else zero
Sebastian Felis's avatar
Sebastian Felis committed
68
 */
Michael Beck's avatar
Michael Beck committed
69
FIRM_API int is_ir_node (const void *thing);
Sebastian Felis's avatar
Sebastian Felis committed
70

71
72
73
74
75
/**
 * Returns the number of predecessors without the block predecessor.
 *
 * @param node   the IR-node
 */
Michael Beck's avatar
Michael Beck committed
76
FIRM_API int get_irn_arity      (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
77
78

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

Christian Schäfer's avatar
Christian Schäfer committed
86
87
88
/* to iterate through the predecessors without touching the array. No
   order of predecessors guaranteed.
   To iterate over the operands iterate from 0 to i < get_irn_arity(),
Götz Lindenmaier's avatar
Götz Lindenmaier committed
89
   to iterate including the Block predecessor iterate from i = -1 to
Christian Schäfer's avatar
Christian Schäfer committed
90
   i < get_irn_arity. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
91
/* Access predecessor n */
92
93
94
95
96

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

Sebastian Hack's avatar
Sebastian Hack committed
99
/**
100
101
102
103
104
105
106
107
108
 * 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
109
FIRM_API int add_irn_dep(ir_node *node, ir_node *dep);
Sebastian Hack's avatar
Sebastian Hack committed
110
111
112

/**
 * Copy all dependencies from a node to another.
113
114
 * This is only allowed in phase_backend!
 *
115
 * @param tgt The node which should be enriched.
Sebastian Hack's avatar
Sebastian Hack committed
116
117
 * @param src The node whose dependencies shall be copied.
 */
Michael Beck's avatar
Michael Beck committed
118
FIRM_API void add_irn_deps(ir_node *tgt, ir_node *src);
Sebastian Hack's avatar
Sebastian Hack committed
119
120

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

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

/**
Michael Beck's avatar
Michael Beck committed
136
137
138
139
140
 * 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
141
FIRM_API void set_irn_dep(ir_node *node, int pos, ir_node *dep);
Sebastian Hack's avatar
Sebastian Hack committed
142

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

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

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

190
/** Returns the ir_graph this node belongs to. */
Michael Beck's avatar
Michael Beck committed
191
FIRM_API ir_graph *get_irn_irg(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
192

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

198
199
200
201
202
203
204
/** 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
205
FIRM_API op_pin_state get_irn_pinned(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
206
207

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

210
211
212
213
214
215
/** 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
216
FIRM_API op_pin_state is_irn_pinned_in_irg(const ir_node *node);
217

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

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

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

252
253
254
255
/** Test whether arbitrary node is frame pointer.
 *
 * Test whether arbitrary node is frame pointer, i.e. Proj(pn_Start_P_frame_base)
 * from Start.  If so returns frame type, else Null. */
Michael Beck's avatar
Michael Beck committed
256
FIRM_API ir_type *is_frame_pointer(const ir_node *n);
257

258
/** Test whether arbitrary node is the thread local storage (tls) pointer.
259
260
261
 *
 * Test whether arbitrary node is tls pointer, i.e. Proj(pn_Start_P_tls)
 * from Start.  If so returns tls type, else Null. */
Michael Beck's avatar
Michael Beck committed
262
FIRM_API ir_type *is_tls_pointer(const ir_node *n);
263

264
/** Return the number of control flow predecessors of a block. */
Michael Beck's avatar
Michael Beck committed
265
FIRM_API int get_Block_n_cfgpreds(const ir_node *block);
266
/** Return the control flow predecessor of a block at a given position. */
Michael Beck's avatar
Michael Beck committed
267
FIRM_API ir_node *get_Block_cfgpred(const ir_node *block, int pos);
268
/** Set the control flow predecessor of a block at a given position. */
Michael Beck's avatar
Michael Beck committed
269
FIRM_API void set_Block_cfgpred(ir_node *block, int pos, ir_node *pred);
270
271
272
273
274
275
276
277
278
279
280
281
282
283

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

286
287
/** Get the predecessor block.
 *
288
 *  Returns the block corresponding to the predecessor pos of block.
289
290
291
292
293
294
 *
 *  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
295
 *    Start block, but the Bad node.
296
 */
Michael Beck's avatar
Michael Beck committed
297
FIRM_API ir_node *get_Block_cfgpred_block(const ir_node *node, int pos);
298
299

/** Return the matured flag of a block */
Michael Beck's avatar
Michael Beck committed
300
FIRM_API int get_Block_matured(const ir_node *block);
301
/** set the matured flag of a block. */
Michael Beck's avatar
Michael Beck committed
302
FIRM_API void set_Block_matured(ir_node *block, int matured);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
303
304
305

/** 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
306
307
FIRM_API ir_visited_t get_Block_block_visited(const ir_node *block);
FIRM_API void set_Block_block_visited(ir_node *block, ir_visited_t visit);
308
309
310
311
312

/**
 * Marks a block as dead but do not replace it with a Bad node.
 * Dead blocks are removed in the con
 */
Michael Beck's avatar
Michael Beck committed
313
314
FIRM_API ir_node *set_Block_dead(ir_node *block);
FIRM_API int is_Block_dead(const ir_node *block);
315

Götz Lindenmaier's avatar
Götz Lindenmaier committed
316
/* For this current_ir_graph must be set. */
Michael Beck's avatar
Michael Beck committed
317
318
FIRM_API void mark_Block_block_visited(ir_node *node);
FIRM_API int Block_block_visited(const ir_node *node);
Christian Schäfer's avatar
Christian Schäfer committed
319

320
/** Returns the extended basic block a block belongs to. */
Michael Beck's avatar
Michael Beck committed
321
FIRM_API ir_extblk *get_Block_extbb(const ir_node *block);
322
/** Sets the extended basic block a block belongs to. */
Michael Beck's avatar
Michael Beck committed
323
FIRM_API void set_Block_extbb(ir_node *block, ir_extblk *extblk);
324
/** Returns the ir_graph this Block belongs to. */
Michael Beck's avatar
Michael Beck committed
325
FIRM_API ir_graph *get_Block_irg(const ir_node *block);
326
/** Returns non-zero if the block has an entity assigned */
Michael Beck's avatar
Michael Beck committed
327
FIRM_API int has_Block_entity(const ir_node *block);
328
/** Returns the entity for a Block */
Michael Beck's avatar
Michael Beck committed
329
FIRM_API ir_entity *get_Block_entity(const ir_node *block);
330
/** Returns the entity for a Block (creating it if necessary) */
Michael Beck's avatar
Michael Beck committed
331
FIRM_API ir_entity *create_Block_entity(ir_node *block);
332
/** Set a new entity for a block */
Michael Beck's avatar
Michael Beck committed
333
FIRM_API void set_Block_entity(ir_node *block, ir_entity *entity);
334
/** Gets the head of the Phi list for this block. */
Michael Beck's avatar
Michael Beck committed
335
FIRM_API ir_node *get_Block_phis(const ir_node *block);
336
/** Sets the head of the Phi list for this block. */
Michael Beck's avatar
Michael Beck committed
337
FIRM_API void set_Block_phis(ir_node *block, ir_node *phi);
Michael Beck's avatar
Michael Beck committed
338
/** Add a Phi node to the list of Block Phi's. */
Michael Beck's avatar
Michael Beck committed
339
FIRM_API void add_Block_phi(ir_node *block, ir_node *phi);
Michael Beck's avatar
Michael Beck committed
340
/** Get the Block mark (single bit). */
Michael Beck's avatar
Michael Beck committed
341
FIRM_API unsigned get_Block_mark(const ir_node *block);
Michael Beck's avatar
Michael Beck committed
342
/** Set the Block mark (single bit). */
Michael Beck's avatar
Michael Beck committed
343
FIRM_API void set_Block_mark(ir_node *block, unsigned mark);
Michael Beck's avatar
Michael Beck committed
344

Michael Beck's avatar
Michael Beck committed
345
/** Return the number of Keep alive node. */
Michael Beck's avatar
Michael Beck committed
346
FIRM_API int get_End_n_keepalives(const ir_node *end);
Michael Beck's avatar
Michael Beck committed
347
/** Return the Keep alive node a position pos. */
Michael Beck's avatar
Michael Beck committed
348
FIRM_API ir_node *get_End_keepalive(const ir_node *end, int pos);
Michael Beck's avatar
Michael Beck committed
349
/** Keep alive dedicated nodes.  These must be either PhiM or Block nodes. */
Michael Beck's avatar
Michael Beck committed
350
FIRM_API void add_End_keepalive(ir_node *end, ir_node *ka);
Michael Beck's avatar
Michael Beck committed
351
/** Set the Keep alive node at position pos. */
Michael Beck's avatar
Michael Beck committed
352
FIRM_API void set_End_keepalive(ir_node *end, int pos, ir_node *ka);
353
354
355
356
357
358

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

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

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

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

Michael Beck's avatar
Michael Beck committed
372
FIRM_API ir_node **get_Return_res_arr(ir_node *node);
373
FIRM_API size_t    get_Return_n_ress(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
374
375
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
376

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

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

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

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

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

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

398
399
400
/** 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
401
/** Get the kind of the SymConst. */
Michael Beck's avatar
Michael Beck committed
402
FIRM_API symconst_kind get_SymConst_kind(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
403
/** Set the kind of the SymConst. */
Michael Beck's avatar
Michael Beck committed
404
FIRM_API void          set_SymConst_kind(ir_node *node, symconst_kind num);
Beyhan's avatar
Beyhan committed
405
406

/** Only to access SymConst of kind type_tag or size.  Else assertion: */
Michael Beck's avatar
Michael Beck committed
407
408
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
409
410

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

414
/** Only to access SymConst of kind symconst_enum_const.  Else assertion: */
Michael Beck's avatar
Michael Beck committed
415
416
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);
417

Beyhan's avatar
Beyhan committed
418
419
/** Sets both: type and ptrinfo.  Needed to treat the node independent of
   its semantics.  Does a memcpy for the memory sym points to. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
420
/* write 'union': firmjni then does not create a method... */
Michael Beck's avatar
Michael Beck committed
421
422
FIRM_API union symconst_symbol get_SymConst_symbol(const ir_node *node);
FIRM_API void                  set_SymConst_symbol(ir_node *node,
423
                                                   union symconst_symbol sym);
424

Michael Beck's avatar
Michael Beck committed
425
426
427
428
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);
429

Michael Beck's avatar
Michael Beck committed
430
FIRM_API ir_node **get_Call_param_arr(ir_node *node);
Michael Beck's avatar
Michael Beck committed
431
/** Gets the number of parameters of a call. */
432
FIRM_API size_t   get_Call_n_params(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
433
/** Gets the call parameter at position pos. */
Michael Beck's avatar
Michael Beck committed
434
FIRM_API ir_node *get_Call_param(const ir_node *node, int pos);
Michael Beck's avatar
Michael Beck committed
435
/** Sets the call parameter at position pos. */
Michael Beck's avatar
Michael Beck committed
436
FIRM_API void     set_Call_param(ir_node *node, int pos, ir_node *param);
Michael Beck's avatar
Michael Beck committed
437
438
439
440
441

/**
 * Returns non-zero if a Call is surely a self-recursive Call.
 * Beware: if this functions returns 0, the call might be self-recursive!
 */
Michael Beck's avatar
Michael Beck committed
442
FIRM_API int is_self_recursive_Call(const ir_node *call);
443

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

465
466
467
/** Set the full callee array.
 *
 *  The passed array is copied. Assumes current_ir_graph set properly! */
468
FIRM_API void set_Call_callee_arr(ir_node *node, size_t n, ir_entity **arr);
Michael Beck's avatar
Michael Beck committed
469
FIRM_API void remove_Call_callee_arr(ir_node *node);
470

Michael Beck's avatar
Michael Beck committed
471
FIRM_API ir_node         **get_Builtin_param_arr(ir_node *node);
472
/** Gets the number of parameters of a Builtin. */
Michael Beck's avatar
Michael Beck committed
473
FIRM_API int             get_Builtin_n_params(const ir_node *node);
474
/** Gets the Builtin parameter at position pos. */
Michael Beck's avatar
Michael Beck committed
475
FIRM_API ir_node         *get_Builtin_param(const ir_node *node, int pos);
476
/** Sets the Builtin parameter at position pos. */
Michael Beck's avatar
Michael Beck committed
477
FIRM_API void            set_Builtin_param(ir_node *node, int pos, ir_node *param);
478
/** Returns a human readable string for the ir_builtin_kind. */
Michael Beck's avatar
Michael Beck committed
479
FIRM_API const char *get_builtin_kind_name(ir_builtin_kind kind);
480

Christian Schäfer's avatar
Christian Schäfer committed
481
482
483
/* For unary and binary arithmetic operations the access to the
   operands can be factored out.  Left is the first, right the
   second arithmetic value  as listed in tech report 1999-44.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
484
   unops are: Minus, Abs, Not, Conv, Cast
485
   binops are: Add, Sub, Mul, Div, Mod, And, Or, Eor, Shl,
486
   Shr, Shrs, Rotl, Cmp */
Michael Beck's avatar
Michael Beck committed
487
488
489
490
491
492
493
494
495
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);

496
497
/** returns the name of an ir_relation */
FIRM_API const char *get_relation_string(ir_relation relation);
Michael Beck's avatar
Michael Beck committed
498

499
500
/** 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
501

502
503
/** Calculates the inversed (R^-1) relation, i.e., "<" --> ">" */
FIRM_API ir_relation get_inversed_relation(ir_relation relation);
504

Götz Lindenmaier's avatar
Götz Lindenmaier committed
505
506
507
508
/** Checks for upcast.
 *
 * Returns true if the Cast node casts a class type to a super type.
 * Works also for pointers to classes (recursively).
509
510
 *
 * Needs typeinfo calculated.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
511
 */
Michael Beck's avatar
Michael Beck committed
512
FIRM_API int is_Cast_upcast(ir_node *node);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
513
514
515
516
517

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

Michael Beck's avatar
Michael Beck committed
523
/** Returns true if irg in phase phase_building and the Phi has zero
524
   predecessors. It's a Phi0 then. */
Michael Beck's avatar
Michael Beck committed
525
526
527
528
529
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);
530
531
532
/**
 * Returns the next element of a block phi list.
 */
Michael Beck's avatar
Michael Beck committed
533
FIRM_API ir_node  *get_Phi_next(const ir_node *phi);
534
535
536
/**
 * Sets the next link of a block Phi list.
 */
Michael Beck's avatar
Michael Beck committed
537
FIRM_API void      set_Phi_next(ir_node *phi, ir_node *next);
538

539
540
/** Return true if parameter is a memory operation.
 *
Götz Lindenmaier's avatar
Götz Lindenmaier committed
541
 *  A memory operation is an operation that changes the
542
543
 *  memory.  I.e., a Load or a Store operation.
 */
Michael Beck's avatar
Michael Beck committed
544
545
546
547
548
FIRM_API int      is_memop(const ir_node *node);
FIRM_API ir_node *get_memop_mem(const ir_node *node);
FIRM_API void     set_memop_mem(ir_node *node, ir_node *mem);
FIRM_API ir_node *get_memop_ptr(const ir_node *node);
FIRM_API void     set_memop_ptr(ir_node *node, ir_node *ptr);
549

Michael Beck's avatar
Michael Beck committed
550
551
552
553
FIRM_API ir_volatility  get_Load_volatility(const ir_node *node);
FIRM_API void           set_Load_volatility(ir_node *node, ir_volatility volatility);
FIRM_API ir_align       get_Load_align(const ir_node *node);
FIRM_API void           set_Load_align(ir_node *node, ir_align align);
554

Michael Beck's avatar
Michael Beck committed
555
556
557
558
FIRM_API ir_volatility  get_Store_volatility(const ir_node *node);
FIRM_API void           set_Store_volatility(ir_node *node, ir_volatility volatility);
FIRM_API ir_align       get_Store_align(const ir_node *node);
FIRM_API void           set_Store_align(ir_node *node, ir_align align);
559

Michael Beck's avatar
Michael Beck committed
560
561
562
563
564
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);
565

566
/** Return the projection number of a Proj node. */
Michael Beck's avatar
Michael Beck committed
567
568
FIRM_API long      get_Proj_proj(const ir_node *node);
FIRM_API void      set_Proj_proj(ir_node *node, long proj);
569

Michael Beck's avatar
Michael Beck committed
570
571
572
573
574
/**
 * Returns non-zero if a node is a routine parameter.
 *
 * @param node  the Proj node to test
 */
Michael Beck's avatar
Michael Beck committed
575
FIRM_API int is_arg_Proj(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
576

Michael Beck's avatar
Michael Beck committed
577
578
579
580
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);
581

Michael Beck's avatar
Michael Beck committed
582
/** Return the number of input constraints for an ASM node. */
Michael Beck's avatar
Michael Beck committed
583
FIRM_API int get_ASM_n_input_constraints(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
584
/** Return the number of output constraints for an ASM node.  */
Michael Beck's avatar
Michael Beck committed
585
FIRM_API int get_ASM_n_output_constraints(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
586
/** Return the number of clobbered registers for an ASM node.  */
Michael Beck's avatar
Michael Beck committed
587
FIRM_API int get_ASM_n_clobbers(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
588

Michael Beck's avatar
Michael Beck committed
589
/*
Götz Lindenmaier's avatar
Götz Lindenmaier committed
590
591
592
593
 *
 * NAME Auxiliary routines
 *
 */
Christian Schäfer's avatar
Christian Schäfer committed
594

Michael Beck's avatar
Michael Beck committed
595
/** Returns operand of node if node is a Proj. */
Michael Beck's avatar
Michael Beck committed
596
FIRM_API ir_node *skip_Proj(ir_node *node);
Michael Beck's avatar
Michael Beck committed
597
/** Returns operand of node if node is a Proj. */
Michael Beck's avatar
Michael Beck committed
598
FIRM_API const ir_node *skip_Proj_const(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
599
/** Returns operand of node if node is a Id. */
Michael Beck's avatar
Michael Beck committed
600
FIRM_API ir_node *skip_Id(ir_node *node);   /* Old name is skip_nop(). */
Michael Beck's avatar
Michael Beck committed
601
/** Returns corresponding operand of Tuple if node is a Proj from
602
   a Tuple. */
Michael Beck's avatar
Michael Beck committed
603
FIRM_API ir_node *skip_Tuple(ir_node *node);
Michael Beck's avatar
Michael Beck committed
604
/** Returns operand of node if node is a Cast. */
Michael Beck's avatar
Michael Beck committed
605
606
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
607
/** Returns operand of node if node is a Pin. */
Michael Beck's avatar
Michael Beck committed
608
FIRM_API ir_node *skip_Pin(ir_node *node);
Michael Beck's avatar
Michael Beck committed
609
/** Returns operand of node if node is a Confirm */
Michael Beck's avatar
Michael Beck committed
610
FIRM_API ir_node *skip_Confirm(ir_node *node);
Michael Beck's avatar
Michael Beck committed
611
/** Skip all high-level Operations (including Cast, Confirm). */
Michael Beck's avatar
Michael Beck committed
612
FIRM_API ir_node *skip_HighLevel_ops(ir_node *node);
Michael Beck's avatar
Michael Beck committed
613
/** Returns true if the operation manipulates control flow:
614
   Start, End, Jmp, Cond, Return, Raise, Bad */
Michael Beck's avatar
Michael Beck committed
615
FIRM_API int is_cfop(const ir_node *node);
616

Michael Beck's avatar
Michael Beck committed
617
/** Returns true if the operation can change the control flow because
618
    of an exception: Call, Div, Mod, Load, Store, Alloc,
Götz Lindenmaier's avatar
Götz Lindenmaier committed
619
    Bad. Raise is not fragile, but a unconditional jump. */
Michael Beck's avatar
Michael Beck committed
620
FIRM_API int is_fragile_op(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
621
/** Returns the memory operand of fragile operations. */
Michael Beck's avatar
Michael Beck committed
622
FIRM_API ir_node *get_fragile_op_mem(ir_node *node);
Christian Schäfer's avatar
Christian Schäfer committed
623

Michael Beck's avatar
Michael Beck committed
624
625
/** Returns true if the operation is a forking control flow
 *  operation: Cond. */
Michael Beck's avatar
Michael Beck committed
626
FIRM_API int is_irn_forking(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
627

628
/**
629
 * Copies attributes stored in the old node to a new node.
630
 * Assumes both have the same opcode and sufficient size.
631
632
633
634
635
636
637
638
639
 *
 * @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
640
 */
Michael Beck's avatar
Michael Beck committed
641
FIRM_API void copy_node_attr(ir_graph *irg, const ir_node *old_node, ir_node *new_node);
642

Michael Beck's avatar
Michael Beck committed
643
644
/** Return the type attribute of a node n (SymConst, Call, Alloc, Free,
    Cast) or NULL.*/
Michael Beck's avatar
Michael Beck committed
645
FIRM_API ir_type *get_irn_type_attr(ir_node *n);
Michael Beck's avatar
Michael Beck committed
646
647

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

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

Michael Beck's avatar
Michael Beck committed
653
654
655
656
/**
 * 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
657
FIRM_API int is_irn_keep(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
658

659
660
661
/**
 * Returns non-zero for nodes that are always placed in the start block.
 */
Michael Beck's avatar
Michael Beck committed
662
FIRM_API int is_irn_start_block_placed(const ir_node *node);
663

664
665
666
/**
 * Returns non-zero for nodes that are machine operations.
 */
Michael Beck's avatar
Michael Beck committed
667
FIRM_API int is_irn_machine_op(const ir_node *node);
668
669
670
671

/**
 * Returns non-zero for nodes that are machine operands.
 */
Michael Beck's avatar
Michael Beck committed
672
FIRM_API int is_irn_machine_operand(const ir_node *node);
673
674
675
676

/**
 * Returns non-zero for nodes that have the n'th user machine flag set.
 */
Michael Beck's avatar
Michael Beck committed
677
FIRM_API int is_irn_machine_user(const ir_node *node, unsigned n);
678

679
680
681
/**
 * Returns non-zero for nodes that are CSE neutral to its users.
 */
Michael Beck's avatar
Michael Beck committed
682
FIRM_API int is_irn_cse_neutral(const ir_node *node);
683

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

687
/** Checks whether a node represents a global address. */
Michael Beck's avatar
Michael Beck committed
688
FIRM_API int is_Global(const ir_node *node);
689
690

/* Returns the entity of a global address. */
Michael Beck's avatar
Michael Beck committed
691
FIRM_API ir_entity *get_Global_entity(const ir_node *node);
692

693
694
695
696
697
698
/**
 * 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
699
 * @param off The value returned by register_additional_node_data().
700
701
702
 * @return A pointer of type @p type.
 */
#define get_irn_data(node,type,off) \
Sebastian Hack's avatar
Sebastian Hack committed
703
704
705
706
707
708
709
710
711
712
  (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)))
713
714
715
716

/**
 * 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
717
 * @return A positive number, if the operation was successful, which
718
719
720
 * must be passed to the access macro get_irn_data(), 0 if the
 * registration failed.
 */
Michael Beck's avatar
Michael Beck committed
721
FIRM_API unsigned firm_register_additional_node_data(unsigned size);
722

723
724
725
726
/**
 * Return a pointer to the node attributes.
 * Needed for user-defined nodes.
 */
Michael Beck's avatar
Michael Beck committed
727
728
FIRM_API void *get_irn_generic_attr(ir_node *node);
FIRM_API const void *get_irn_generic_attr_const(const ir_node *node);
729

730
731
732
733
/**
 * 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
734
FIRM_API unsigned get_irn_idx(const ir_node *node);
735

736
737
738
739
740
741
/**
 * Sets the debug information of a node.
 *
 * @param n   The node.
 * @param db  The debug info.
 */
Michael Beck's avatar
Michael Beck committed
742
FIRM_API void set_irn_dbg_info(ir_node *n, dbg_info *db);
743
744
745
746
747
748

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

751
752
/**
 * Calculate a hash value of a node. Only inputs, mode and opcode are used.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
753
 *
754
755
 * @param node  the node to hash
 */
Michael Beck's avatar
Michael Beck committed
756
FIRM_API unsigned firm_default_hash(const ir_node *node);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
757

758
759
760
/**
 * returns a descriptive name of a node (containing type+number)
 */
Michael Beck's avatar
Michael Beck committed
761
FIRM_API const char *gdb_node_helper(void *firm_object);
762

Michael Beck's avatar
Michael Beck committed
763
/*@}*/ /* end of ir_node group definition */
764

765
766
#include "end.h"

Matthias Braun's avatar
Matthias Braun committed
767
#endif