irnode.h 57.7 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"
Christian Schäfer's avatar
Christian Schäfer committed
35

Michael Beck's avatar
Michael Beck committed
36
37
/**
 * @file irnode.h
Götz Lindenmaier's avatar
Götz Lindenmaier committed
38
 *
Michael Beck's avatar
Michael Beck committed
39
 * @author Martin Trapp, Christian Schaefer
Götz Lindenmaier's avatar
Götz Lindenmaier committed
40
 *
Michael Beck's avatar
Michael Beck committed
41
42
43
44
45
46
 * Declarations of an ir node.
 */

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

Sebastian Felis's avatar
Sebastian Felis committed
67
/**
68
 * Some projection numbers must be always equal to support automatic phi construction
Michael Beck's avatar
Michael Beck committed
69
 */
70
enum pn_generic {
71
	pn_Generic_M         = 0,  /**< The memory result. */
72
73
74
75
	pn_Generic_X_regular = 1,  /**< Execution result if no exception occurred. */
	pn_Generic_X_except  = 2,  /**< The control flow result branching to the exception handler */
	pn_Generic_other     = 3   /**< First free projection number */
};
Christian Schäfer's avatar
Christian Schäfer committed
76

Sebastian Felis's avatar
Sebastian Felis committed
77
78
79
/**
 *   Checks whether a pointer points to a ir node.
 *
80
81
 *   @param thing   an arbitrary pointer
 *   @return        non-zero if the thing is a ir mode, else zero
Sebastian Felis's avatar
Sebastian Felis committed
82
 */
83
int is_ir_node (const void *thing);
Sebastian Felis's avatar
Sebastian Felis committed
84

85
86
87
88
89
/**
 * Returns the number of predecessors without the block predecessor.
 *
 * @param node   the IR-node
 */
90
91
92
int get_irn_arity      (const ir_node *node);
int get_irn_intra_arity(const ir_node *node);
int get_irn_inter_arity(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
93
94

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

Christian Schäfer's avatar
Christian Schäfer committed
102
103
104
/* 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
105
   to iterate including the Block predecessor iterate from i = -1 to
Christian Schäfer's avatar
Christian Schäfer committed
106
   i < get_irn_arity. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
107
/* Access predecessor n */
108
109
110
111

/**
 * Get the n-th predecessor of a node.
 * This function removes Id predecessors.
Michael Beck's avatar
Michael Beck committed
112
 * This function automatically handles intra- and interprocedural views.
113
 */
114
ir_node *get_irn_n(const ir_node *node, int n);
Michael Beck's avatar
Michael Beck committed
115

Sebastian Hack's avatar
Sebastian Hack committed
116
117
118
/**
* Add a artificial dependency to the node.
* The dependency is only inserted if it is not there already.
119
120
* This is only allowed in phase_backend!
*
Sebastian Hack's avatar
Sebastian Hack committed
121
122
* @param node The node.
* @param dep  The dependency target.
123
*
Sebastian Hack's avatar
Sebastian Hack committed
124
125
126
127
128
129
* @return The index in the array (get_irn_dep() with that index returns @p dep).
*/
int add_irn_dep(ir_node *node, ir_node *dep);

/**
 * Copy all dependencies from a node to another.
130
131
 * This is only allowed in phase_backend!
 *
132
 * @param tgt The node which should be enriched.
Sebastian Hack's avatar
Sebastian Hack committed
133
134
135
136
137
 * @param src The node whose dependencies shall be copied.
 */
void add_irn_deps(ir_node *tgt, ir_node *src);

/**
Michael Beck's avatar
Michael Beck committed
138
139
140
141
 * 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.
 */
Sebastian Hack's avatar
Sebastian Hack committed
142
143
144
int get_irn_deps(const ir_node *node);

/**
Michael Beck's avatar
Michael Beck committed
145
146
147
148
149
 * Get an entry of the dependency array.
 * @param node The node.
 * @param pos  The position.
 * @return The node at that position.
 */
Sebastian Hack's avatar
Sebastian Hack committed
150
151
152
ir_node *get_irn_dep(const ir_node *node, int pos);

/**
Michael Beck's avatar
Michael Beck committed
153
154
155
156
157
 * Set an entry of the dependency array.
 * @param node The node.
 * @param pos  The position.
 * @param dep  The dependency target.
 */
Sebastian Hack's avatar
Sebastian Hack committed
158
159
160
void set_irn_dep(ir_node *node, int pos, ir_node *dep);


Michael Beck's avatar
Michael Beck committed
161
162
163
164
/**
 * Get the n-th predecessor of a node in intraprocedural view.
 * Can be used always if it's know that node is not a split one.
 */
165
ir_node *get_irn_intra_n(const ir_node *node, int n);
Michael Beck's avatar
Michael Beck committed
166
167
168
169

/**
 * Get the n-th predecessor of a node in interprocedural view.
 */
170
ir_node *get_irn_inter_n(const ir_node *node, int n);
171
172

/** Replace the n-th predecessor of a node with a new one. */
173
void set_irn_n(ir_node *node, int n, ir_node *in);
174
175
176
177
178
179
/**
 * Appends a new predecessor to a node. This only works for nodes with
 * variable arity!
 * @returns   the number of the new input
 */
int add_irn_n(ir_node *node, ir_node *in);
Christoph Mallon's avatar
Christoph Mallon committed
180
181
/* Remove predecessor i from Sync n */
void del_Sync_n(ir_node *n, int i);
182
/* Sets the mode struct of node.  */
183
void set_irn_mode(ir_node *node, ir_mode *mode);
184
/** Gets the mode struct of a node.  */
185
ir_mode *get_irn_mode(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
186
/** Gets the ident for a string representation of the mode .*/
187
ident *get_irn_modeident(const ir_node *node);
188
/** Gets the string representation of the mode .*/
189
const char *get_irn_modename(const ir_node *node);
190
/** Gets the opcode struct of the node. */
191
ir_op *get_irn_op(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
192
/** Sets the opcode struct of the node. */
193
void set_irn_op(ir_node *node, ir_op *op);
Michael Beck's avatar
Michael Beck committed
194
/** Gets the opcode-enum of the node. */
Matthias Braun's avatar
Matthias Braun committed
195
unsigned get_irn_opcode(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
196
/** Get the string representation of the opcode. */
197
const char *get_irn_opname(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
198
/** Get the ident for a string representation of the opcode. */
199
ident *get_irn_opident(const ir_node *node);
200
/** If arg is an argument of the node, returns it's position, -1 otherwise */
201
int get_irn_pred_pos(ir_node *node, ir_node *arg);
202
/** Gets the visited counter of a node. */
203
ir_visited_t get_irn_visited(const ir_node *node);
204
/** Sets the visited counter of a node. */
205
void set_irn_visited(ir_node *node, ir_visited_t visited);
Michael Beck's avatar
Michael Beck committed
206
/** Sets visited to get_irg_visited(current_ir_graph). */
207
void mark_irn_visited(ir_node *node);
208
/** Returns 1 if visited >= get_irg_visited(current_ir_graph). */
209
int irn_visited(const ir_node *node);
210
211
212
/** Returns 1 if visited >= get_irg_visited(current_ir_graph). Marks the node
 * visited, if it was not. */
int irn_visited_else_mark(ir_node *node);
213
214
215
216
217

/**
 * Sets the link of a node.
 * Only allowed if the graph is NOT in phase_building.
 */
218
void set_irn_link(ir_node *node, void *link);
219
220

/** Returns the link of a node.  */
221
void *get_irn_link(const ir_node *node);
222

223
/** Returns the ir_graph this node belongs to. */
224
ir_graph *get_irn_irg(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
225

226
/** Outputs a unique number for this node if libFIRM is compiled for
227
228
   debugging, (configure with --enable-debug) else returns address
   of node cast to long. */
229
long get_irn_node_nr(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
230

231
232
233
234
235
236
237
/** 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.
 */
238
op_pin_state get_irn_pinned(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
239
240
241

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

243
244
245
246
247
248
/** 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'.
 */
249
op_pin_state is_irn_pinned_in_irg(const ir_node *node);
250

Michael Beck's avatar
Michael Beck committed
251
/**
252
253
254
255
 * 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.
256
257
258
 *
 * @param db    Debug info.
 * @param irg   IR-graph on with this new node should be constructed.
Michael Beck's avatar
Michael Beck committed
259
 * @param block The block the new node belongs to
260
261
 * @param op    The opcode of the new node.
 * @param mode  The mode of the new node.
262
 * @param arity The arity of the new node, <0 if can be changed dynamically.
263
 * @param in    An array of arity predecessor nodes.
Michael Beck's avatar
Michael Beck committed
264
 */
265
ir_node *
266
new_ir_node(dbg_info *db,
Florian Liekweg's avatar
Florian Liekweg committed
267
268
269
270
271
272
         ir_graph *irg,
         ir_node *block,
         ir_op *op,
         ir_mode *mode,
         int arity,
         ir_node *in[]);
Christian Schäfer's avatar
Christian Schäfer committed
273

274
275
276
277
278
/**
 * 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
279
280
281
282
283
 *
 * 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
284
 * get_irn_block(). */
Sebastian Hack's avatar
Sebastian Hack committed
285
ir_node  *get_nodes_block (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
286
287

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

Michael Beck's avatar
Michael Beck committed
290
291
292
293
294
295
296
297
298
299
300
301
302
/**
 * Return the MacroBlock the node belongs to.  This is only
 * possible for pinned nodes or if the graph is in pinned state.
 * Otherwise the MacroBlock may be incorrect.  This condition is
 * now checked by an assertion.
 *
 * 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
 * get_irn_MacroBlock(). */
ir_node  *get_nodes_MacroBlock(const ir_node *node);

303
304
305
306
/**
 * Projection numbers for result of Start node: use for Proj nodes!
 */
typedef enum {
Michael Beck's avatar
Michael Beck committed
307
308
309
310
311
312
313
	pn_Start_X_initial_exec,   /**< Projection on the initial control flow. */
	pn_Start_M,                /**< Projection on the initial memory. */
	pn_Start_P_frame_base,     /**< Projection on the frame base pointer. */
	pn_Start_P_tls,            /**< Projection on the pointer to the thread local store
	                                segment containing _all_thread local variables. */
	pn_Start_T_args,           /**< Projection on all arguments. */
	pn_Start_max               /**< number of projections from a Start */
314
315
} pn_Start; /* Projection numbers for Start. */

316
317
318
319
/** 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. */
320
ir_type *is_frame_pointer(const ir_node *n);
321

322
/** Test whether arbitrary node is the thread local storage (tls) pointer.
323
324
325
 *
 * Test whether arbitrary node is tls pointer, i.e. Proj(pn_Start_P_tls)
 * from Start.  If so returns tls type, else Null. */
326
ir_type *is_tls_pointer(const ir_node *n);
327

328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
/** Return the number of control flow predecessors of a block. */
int       get_Block_n_cfgpreds(const ir_node *block);
/** Return the control flow predecessor of a block at a given position. */
ir_node  *get_Block_cfgpred(const ir_node *block, int pos);
/** Set the control flow predecessor of a block at a given position. */
void      set_Block_cfgpred(ir_node *block, int pos, ir_node *pred);

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

350
351
/** Get the predecessor block.
 *
352
 *  Returns the block corresponding to the predecessor pos of block.
353
354
355
356
357
358
 *
 *  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
359
 *    Start block, but the Bad node.
360
 */
361
ir_node  *get_Block_cfgpred_block(const ir_node *node, int pos);
362
363
364
365
366

/** Return the matured flag of a block */
int       get_Block_matured(const ir_node *block);
/** set the matured flag of a block. */
void      set_Block_matured(ir_node *block, int matured);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
367
368
369

/** A visited flag only for block nodes.
 *  @see also: get_irn_visited() inc_irg_visited() inc_irg_block_visited()*/
370
371
ir_visited_t get_Block_block_visited(const ir_node *block);
void         set_Block_block_visited(ir_node *block, ir_visited_t visit);
372
373
374
375
376

/**
 * Marks a block as dead but do not replace it with a Bad node.
 * Dead blocks are removed in the con
 */
377
378
379
ir_node  *set_Block_dead(ir_node *block);
int       is_Block_dead(const ir_node *block);

Götz Lindenmaier's avatar
Götz Lindenmaier committed
380
/* For this current_ir_graph must be set. */
381
void      mark_Block_block_visited(ir_node *node);
Matthias Braun's avatar
Matthias Braun committed
382
int       Block_block_visited(const ir_node *node);
Christian Schäfer's avatar
Christian Schäfer committed
383

384
#ifdef INTERPROCEDURAL_VIEW
385
386
/* Set and remove interprocedural predecessors. If the interprocedural
 * predecessors are removed, the node has the same predecessors in
387
388
 * both views.
 * @@@ Maybe better:  arity is zero if no cg preds. */
Michael Beck's avatar
Michael Beck committed
389
void      set_Block_cg_cfgpred_arr(ir_node *node, int arity, ir_node *in[]);
390
void      set_Block_cg_cfgpred(ir_node *node, int pos, ir_node *pred);
391
/* @@@ not supported */
392
ir_node **get_Block_cg_cfgpred_arr(ir_node *node);
Michael Beck's avatar
Michael Beck committed
393
/** Returns the number of interprocedural predecessors.  0 if none. */
394
int       get_Block_cg_n_cfgpreds(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
395
/** Return the interprocedural predecessor at position pos. */
396
ir_node  *get_Block_cg_cfgpred(const ir_node *node, int pos);
397
398
/** Frees the memory allocated for interprocedural predecessors. */
void      remove_Block_cg_cfgpred_arr(ir_node *node);
399
400
#endif

401
/** Returns the extended basic block a block belongs to. */
402
ir_extblk *get_Block_extbb(const ir_node *block);
403
/** Sets the extended basic block a block belongs to. */
404
void set_Block_extbb(ir_node *block, ir_extblk *extblk);
Michael Beck's avatar
Michael Beck committed
405
406
/** Get the Macro Block header of a (sub-) block. */
ir_node *get_Block_MacroBlock(const ir_node *block);
Michael Beck's avatar
Michael Beck committed
407
408
/** Set the Macro Block header of a (sub-) block. */
void set_Block_MacroBlock(ir_node *block, ir_node *mbh);
Michael Beck's avatar
Michael Beck committed
409
410
/** Get the Macro Block header of a node. */
ir_node *get_irn_MacroBlock(const ir_node *n);
411
412
/** Returns the ir_graph this Block belongs to. */
ir_graph *get_Block_irg(const ir_node *block);
413
414
415
416
417
418
419
420
/** Returns non-zero if the block has an entity assigned */
int has_Block_entity(const ir_node *block);
/** Returns the entity for a Block */
ir_entity *get_Block_entity(const ir_node *block);
/** Returns the entity for a Block (creating it if necessary) */
ir_entity *create_Block_entity(ir_node *block);
/** Set a new entity for a block */
void set_Block_entity(ir_node *block, ir_entity *entity);
421
422
423
424
/** Gets the head of the Phi list for this block. */
ir_node *get_Block_phis(const ir_node *block);
/** Sets the head of the Phi list for this block. */
void set_Block_phis(ir_node *block, ir_node *phi);
Michael Beck's avatar
Michael Beck committed
425
426
/** Add a Phi node to the list of Block Phi's. */
void add_Block_phi(ir_node *block, ir_node *phi);
Michael Beck's avatar
Michael Beck committed
427
428
429
430
/** Get the Block mark (single bit). */
unsigned get_Block_mark(const ir_node *block);
/** Set the Block mark (single bit). */
void set_Block_mark(ir_node *block, unsigned mark);
Michael Beck's avatar
Michael Beck committed
431

Michael Beck's avatar
Michael Beck committed
432
/** Return the number of Keep alive node. */
433
int  get_End_n_keepalives(const ir_node *end);
Michael Beck's avatar
Michael Beck committed
434
/** Return the Keep alive node a position pos. */
435
ir_node *get_End_keepalive(const ir_node *end, int pos);
Michael Beck's avatar
Michael Beck committed
436
/** Keep alive dedicated nodes.  These must be either PhiM or Block nodes. */
437
void add_End_keepalive(ir_node *end, ir_node *ka);
Michael Beck's avatar
Michael Beck committed
438
/** Set the Keep alive node at position pos. */
439
void set_End_keepalive(ir_node *end, int pos, ir_node *ka);
440
441
442
443
444
445

/**
 * Set new keep-alives.
 * Beware: This might be an expensive operation if dynamic edges are enabled,
 * so avoid it in the backend.
 */
446
void set_End_keepalives(ir_node *end, int n, ir_node *in[]);
447
448

/** Remove irn from the keep-alive set. */
449
450
void remove_End_keepalive(ir_node *end, ir_node *irn);

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

Michael Beck's avatar
Michael Beck committed
454
/** Some parts of the End node are allocated separately -- their memory
455
   is not recovered by dead_node_elimination if a End node is dead.
Michael Beck's avatar
Michael Beck committed
456
   free_End() frees these data structures. */
457
void free_End(ir_node *end);
458

459
/** Return the target address of an IJmp */
460
ir_node *get_IJmp_target(const ir_node *ijmp);
461
462
/** Sets the target address of an IJmp */
void set_IJmp_target(ir_node *ijmp, ir_node *tgt);
463

464
ir_node  *get_Cond_selector(const ir_node *node);
465
void      set_Cond_selector(ir_node *node, ir_node *selector);
466
467
long      get_Cond_default_proj(const ir_node *node);
void      set_Cond_default_proj(ir_node *node, long defproj);
Christian Schäfer's avatar
Christian Schäfer committed
468

469
470
471
/**
 * Projection numbers for conditions.
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
472
typedef enum {
Michael Beck's avatar
Michael Beck committed
473
474
475
	pn_Cond_false,    /**< Control flow if operand is "false". */
	pn_Cond_true,     /**< Control flow if operand is "true".  */
	pn_Cond_max       /**< number of projections from a Cond */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
476
477
} pn_Cond;  /* Projection numbers for Cond. */

478
ir_node  *get_Return_mem(const ir_node *node);
479
480
void      set_Return_mem(ir_node *node, ir_node *mem);
ir_node **get_Return_res_arr(ir_node *node);
481
482
int       get_Return_n_ress(const ir_node *node);
ir_node  *get_Return_res(const ir_node *node, int pos);
483
void      set_Return_res(ir_node *node, int pos, ir_node *res);
Christian Schäfer's avatar
Christian Schäfer committed
484

Christoph Mallon's avatar
Christoph Mallon committed
485
tarval  *get_Const_tarval(const ir_node *node);
486
void     set_Const_tarval(ir_node *node, tarval *con);
Michael Beck's avatar
Michael Beck committed
487

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

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

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

Michael Beck's avatar
Michael Beck committed
497
498
499
/** Returns the source language type of a Const node.
 * Must be an atomic type.  Mode of type must be mode of node.
 */
500
ir_type  *get_Const_type(ir_node *node);
Michael Beck's avatar
Michael Beck committed
501
502

/** Sets the source language type of a Const node. */
503
void     set_Const_type(ir_node *node, ir_type *tp);
Christian Schäfer's avatar
Christian Schäfer committed
504

505
506
507
508
509
510
511
/** 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 ident attribute */
#define SYMCONST_HAS_ID(kind) ((kind) == symconst_addr_name)

/** Returns non-zero if s symconst kind has an entity attribute */
512
#define SYMCONST_HAS_ENT(kind) ((kind) == symconst_addr_ent || (kind) == symconst_ofs_ent)
513

514
515
516
/** 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
517
/** Get the kind of the SymConst. */
518
symconst_kind get_SymConst_kind(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
519
/** Set the kind of the SymConst. */
520
void          set_SymConst_kind(ir_node *node, symconst_kind num);
Beyhan's avatar
Beyhan committed
521
522

/** Only to access SymConst of kind type_tag or size.  Else assertion: */
Michael Beck's avatar
Michael Beck committed
523
ir_type  *get_SymConst_type(const ir_node *node);
524
void     set_SymConst_type(ir_node *node, ir_type *tp);
Beyhan's avatar
Beyhan committed
525
526

/** Only to access SymConst of kind addr_name.  Else assertion: */
Michael Beck's avatar
Michael Beck committed
527
ident   *get_SymConst_name(const ir_node *node);
528
void     set_SymConst_name(ir_node *node, ident *name);
Beyhan's avatar
Beyhan committed
529
530

/** Only to access SymConst of kind addr_ent.  Else assertion: */
Michael Beck's avatar
Michael Beck committed
531
ir_entity *get_SymConst_entity(const ir_node *node);
532
void       set_SymConst_entity(ir_node *node, ir_entity *ent);
Beyhan's avatar
Beyhan committed
533

534
/** Only to access SymConst of kind symconst_enum_const.  Else assertion: */
Michael Beck's avatar
Michael Beck committed
535
ir_enum_const *get_SymConst_enum(const ir_node *node);
536
void           set_SymConst_enum(ir_node *node, ir_enum_const *ec);
537

Beyhan's avatar
Beyhan committed
538
539
/** 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
540
/* write 'union': firmjni then does not create a method... */
Michael Beck's avatar
Michael Beck committed
541
union symconst_symbol get_SymConst_symbol(const ir_node *node);
542
543
void                  set_SymConst_symbol(ir_node *node,
                                          union symconst_symbol sym);
544

Götz Lindenmaier's avatar
Götz Lindenmaier committed
545
546
547
/** Access the type of the value represented by the SymConst.
 *
 *  Example: primitive type int for SymConst size. */
548
549
550
ir_type *get_SymConst_value_type(ir_node *node);
void    set_SymConst_value_type(ir_node *node, ir_type *tp);

551
ir_node   *get_Sel_mem(const ir_node *node);
552
void       set_Sel_mem(ir_node *node, ir_node *mem);
553
ir_node   *get_Sel_ptr(const ir_node *node);  /* ptr to the object to select from */
554
555
void       set_Sel_ptr(ir_node *node, ir_node *ptr);
ir_node   **get_Sel_index_arr(ir_node *node);
556
557
int        get_Sel_n_indexs(const ir_node *node);
ir_node   *get_Sel_index(const ir_node *node, int pos);
558
void       set_Sel_index(ir_node *node, int pos, ir_node *index);
559
ir_entity *get_Sel_entity(const ir_node *node); /* entity to select */
560
void       set_Sel_entity (ir_node *node, ir_entity *ent);
Christian Schäfer's avatar
Christian Schäfer committed
561

562
563
564
/**
 * Projection numbers for result of Call node: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
565
typedef enum {
566
	pn_Call_M         = pn_Generic_M,         /**< The memory result. */
567
568
569
570
571
572
	pn_Call_X_regular = pn_Generic_X_regular, /**< The control flow result when no exception occurs. */
	pn_Call_X_except  = pn_Generic_X_except,  /**< The control flow result branching to the exception handler. */
	pn_Call_T_result  = pn_Generic_other,     /**< The tuple containing all (0, 1, 2, ...) results. */
	pn_Call_P_value_res_base,                 /**< A pointer to the memory region containing copied results
	                                               passed by value (for compound result types). */
	pn_Call_max                               /**< number of projections from a Call */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
573
574
} pn_Call;   /* Projection numbers for Call. */

Michael Beck's avatar
Michael Beck committed
575
/** Retrieve the memory input of a Call. */
576
ir_node *get_Call_mem(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
577
/** Set the memory input of a Call. */
578
void     set_Call_mem(ir_node *node, ir_node *mem);
Michael Beck's avatar
Michael Beck committed
579
/** Retrieve the call address of a Call. */
580
ir_node *get_Call_ptr(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
581
/** Set the call address of a Call. */
582
583
void     set_Call_ptr(ir_node *node, ir_node *ptr);
ir_node **get_Call_param_arr(ir_node *node);
Michael Beck's avatar
Michael Beck committed
584
/** Gets the number of parameters of a call. */
585
int      get_Call_n_params(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
586
/** Gets the call parameter at position pos. */
587
ir_node *get_Call_param(const ir_node *node, int pos);
Michael Beck's avatar
Michael Beck committed
588
/** Sets the call parameter at position pos. */
589
void     set_Call_param(ir_node *node, int pos, ir_node *param);
Michael Beck's avatar
Michael Beck committed
590
/** Gets the type of a call. */
591
ir_type *get_Call_type(ir_node *node);
Michael Beck's avatar
Michael Beck committed
592
/** Sets the type of a call. */
593
void     set_Call_type(ir_node *node, ir_type *tp);
594
595
596
597
/** Returns non-zero if this call can be a tail-call. */
unsigned get_Call_tail_call(const ir_node *node);
/** Sets the tail call attribute. */
void     set_Call_tail_call(ir_node *node, unsigned tail_call);
Michael Beck's avatar
Michael Beck committed
598
599
600
601
602
603

/**
 * Returns non-zero if a Call is surely a self-recursive Call.
 * Beware: if this functions returns 0, the call might be self-recursive!
 */
int is_self_recursive_Call(const ir_node *call);
604

605
606
607
608
/** 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
609
610
611
612
 *  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.
613
614
615
616
617
618
619
620
621
 *
 *  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.
 */
622
623
624
int        Call_has_callees(const ir_node *node);
int        get_Call_n_callees(const ir_node *node);
ir_entity *get_Call_callee(const ir_node *node, int pos);
Michael Beck's avatar
Michael Beck committed
625

626
627
628
/** Set the full callee array.
 *
 *  The passed array is copied. Assumes current_ir_graph set properly! */
629
void    set_Call_callee_arr(ir_node *node, const int n, ir_entity **arr);
630
void    remove_Call_callee_arr(ir_node *node);
631

632
633
634
635
/**
 * Projection numbers for result of Builtin node: use for Proj nodes!
 */
typedef enum {
636
637
638
	pn_Builtin_M        = pn_Generic_M,     /**< The memory result. */
	pn_Builtin_1_result = pn_Generic_other, /**< first result. */
	pn_Builtin_max                          /**< number of projections from a Builtin */
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
} pn_Builtin;   /* Projection numbers for Builtin. */

ir_node         *get_Builtin_mem(const ir_node *node);
void            set_Builtin_mem(ir_node *node, ir_node *mem);
ir_builtin_kind get_Builtin_kind(const ir_node *node);
void            set_Builtin_kind(ir_node *node, ir_builtin_kind kind);
ir_node         **get_Builtin_param_arr(ir_node *node);
/** Gets the number of parameters of a Builtin. */
int             get_Builtin_n_params(const ir_node *node);
/** Gets the Builtin parameter at position pos. */
ir_node         *get_Builtin_param(const ir_node *node, int pos);
/** Sets the Builtin parameter at position pos. */
void            set_Builtin_param(ir_node *node, int pos, ir_node *param);
/** Gets the type of a builtin. */
ir_type         *get_Builtin_type(ir_node *node);
/** Sets the type of a Builtin. */
void            set_Builtin_type(ir_node *node, ir_type *tp);
/** Returns a human readable string for the ir_builtin_kind. */
const char *get_builtin_kind_name(ir_builtin_kind kind);

Michael Beck's avatar
Michael Beck committed
659
/** Retrieve the call address of a CallBegin. */
660
ir_node  *get_CallBegin_ptr(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
661
/** Set the call address of a CallBegin. */
662
void      set_CallBegin_ptr(ir_node *node, ir_node *ptr);
Michael Beck's avatar
Michael Beck committed
663
/** Retrieve the original Call node of a CallBegin. */
664
ir_node  *get_CallBegin_call(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
665
/** Set the original Call node of a CallBegin. */
666
void      set_CallBegin_call(ir_node *node, ir_node *call);
667

Christian Schäfer's avatar
Christian Schäfer committed
668
669
670
/* 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
671
   unops are: Minus, Abs, Not, Conv, Cast
Christian Schäfer's avatar
Christian Schäfer committed
672
   binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
673
   Shr, Shrs, Rotl, Cmp */
674
int      is_unop(const ir_node *node);
675
ir_node *get_unop_op(const ir_node *node);
676
677
void     set_unop_op(ir_node *node, ir_node *op);
int      is_binop(const ir_node *node);
678
ir_node *get_binop_left(const ir_node *node);
679
void     set_binop_left(ir_node *node, ir_node *left);
680
ir_node *get_binop_right(const ir_node *node);
681
682
void     set_binop_right(ir_node *node, ir_node *right);

683
ir_node *get_Add_left(const ir_node *node);
684
void     set_Add_left(ir_node *node, ir_node *left);
685
ir_node *get_Add_right(const ir_node *node);
686
687
void     set_Add_right(ir_node *node, ir_node *right);

688
689
690
691
692
ir_node *get_Carry_left(const ir_node *node);
void     set_Carry_left(ir_node *node, ir_node *left);
ir_node *get_Carry_right(const ir_node *node);
void     set_Carry_right(ir_node *node, ir_node *right);

693
694
695
696
697
ir_node *get_Borrow_left(const ir_node *node);
void     set_Borrow_left(ir_node *node, ir_node *left);
ir_node *get_Borrow_right(const ir_node *node);
void     set_Borrow_right(ir_node *node, ir_node *right);

698
ir_node *get_Sub_left(const ir_node *node);
699
void     set_Sub_left(ir_node *node, ir_node *left);
700
ir_node *get_Sub_right(const ir_node *node);
701
702
void     set_Sub_right(ir_node *node, ir_node *right);

703
ir_node *get_Minus_op(const ir_node *node);
704
705
void     set_Minus_op(ir_node *node, ir_node *op);

706
ir_node *get_Mul_left(const ir_node *node);
707
void     set_Mul_left(ir_node *node, ir_node *left);
708
ir_node *get_Mul_right(const ir_node *node);
709
710
void     set_Mul_right(ir_node *node, ir_node *right);

Michael Beck's avatar
Michael Beck committed
711
712
713
714
715
ir_node *get_Mulh_left(const ir_node *node);
void     set_Mulh_left(ir_node *node, ir_node *left);
ir_node *get_Mulh_right(const ir_node *node);
void     set_Mulh_right(ir_node *node, ir_node *right);

716
ir_node *get_Quot_left(const ir_node *node);
717
void     set_Quot_left(ir_node *node, ir_node *left);
718
ir_node *get_Quot_right(const ir_node *node);
719
void     set_Quot_right(ir_node *node, ir_node *right);
720
ir_node *get_Quot_mem(const ir_node *node);
721
void     set_Quot_mem(ir_node *node, ir_node *mem);
722
723
ir_mode *get_Quot_resmode(const ir_node *node);
void     set_Quot_resmode(ir_node *node, ir_mode *mode);
724

725
726
727
/**
 * Projection numbers for Quot: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
728
typedef enum {
729
	pn_Quot_M         = pn_Generic_M,         /**< Memory result. */
730
731
732
733
	pn_Quot_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
	pn_Quot_X_except  = pn_Generic_X_except,  /**< Execution result if exception occurred. */
	pn_Quot_res       = pn_Generic_other,     /**< Result of computation. */
	pn_Quot_max                               /**< number of projections from a Quot */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
734
735
} pn_Quot;  /* Projection numbers for Quot. */

736
ir_node *get_DivMod_left(const ir_node *node);
737
void     set_DivMod_left(ir_node *node, ir_node *left);
738
ir_node *get_DivMod_right(const ir_node *node);
739
void     set_DivMod_right(ir_node *node, ir_node *right);
740
ir_node *get_DivMod_mem(const ir_node *node);
741
void     set_DivMod_mem(ir_node *node, ir_node *mem);
742
743
ir_mode *get_DivMod_resmode(const ir_node *node);
void     set_DivMod_resmode(ir_node *node, ir_mode *mode);
744

745
746
747
/**
 * Projection numbers for DivMod: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
748
typedef enum {
749
	pn_DivMod_M         = pn_Generic_M,         /**< Memory result. */
750
751
752
753
754
	pn_DivMod_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
	pn_DivMod_X_except  = pn_Generic_X_except,  /**< Execution result if exception occurred. */
	pn_DivMod_res_div   = pn_Generic_other,     /**< Result of computation a / b. */
	pn_DivMod_res_mod,                          /**< Result of computation a % b. */
	pn_DivMod_max                               /**< number of projections from a DivMod */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
755
756
} pn_DivMod;  /* Projection numbers for DivMod. */

757
ir_node *get_Div_left(const ir_node *node);
758
void     set_Div_left(ir_node *node, ir_node *left);
759
ir_node *get_Div_right(const ir_node *node);
760
void     set_Div_right(ir_node *node, ir_node *right);
761
ir_node *get_Div_mem(const ir_node *node);
762
void     set_Div_mem(ir_node *node, ir_node *mem);
763
764
ir_mode *get_Div_resmode(const ir_node *node);
void     set_Div_resmode(ir_node *node, ir_mode *mode);
765
int      get_Div_no_remainder(const ir_node *node);
766
void     set_Div_no_remainder(ir_node *node, int no_remainder);
767

768
769
770
/**
 * Projection numbers for Div: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
771
typedef enum {
772
	pn_Div_M         = pn_Generic_M,         /**< Memory result. */
773
774
775
776
	pn_Div_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
	pn_Div_X_except  = pn_Generic_X_except,  /**< Execution result if exception occurred. */
	pn_Div_res       = pn_Generic_other,     /**< Result of computation. */
	pn_Div_max                               /**< number of projections from a Div */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
777
778
} pn_Div;  /* Projection numbers for Div. */

779
ir_node *get_Mod_left(const ir_node *node);
780
void     set_Mod_left(ir_node *node, ir_node *left);
781
ir_node *get_Mod_right(const ir_node *node);
782
void     set_Mod_right(ir_node *node, ir_node *right);
783
ir_node *get_Mod_mem(const ir_node *node);
784
void     set_Mod_mem(ir_node *node, ir_node *mem);
785
786
ir_mode *get_Mod_resmode(const ir_node *node);
void     set_Mod_resmode(ir_node *node, ir_mode *mode);
787

788
789
790
/**
 * Projection numbers for Mod: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
791
typedef enum {
792
	pn_Mod_M         = pn_Generic_M,         /**< Memory result.    */
793
794
795
796
	pn_Mod_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
	pn_Mod_X_except  = pn_Generic_X_except,  /**< Execution result if exception occurred. */
	pn_Mod_res       = pn_Generic_other,     /**< Result of computation. */
	pn_Mod_max                               /**< number of projections from a Mod */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
797
798
} pn_Mod;  /* Projection numbers for Mod. */

799
ir_node *get_Abs_op(const ir_node *node);
800
void     set_Abs_op(ir_node *node, ir_node *op);
801

802
ir_node *get_And_left(const ir_node *node);
803
void     set_And_left(ir_node *node, ir_node *left);
804
ir_node *get_And_right(const ir_node *node);
805
void     set_And_right(ir_node *node, ir_node *right);
806

807
ir_node *get_Or_left(const ir_node *node);
808
void     set_Or_left(ir_node *node, ir_node *left);
809
ir_node *get_Or_right(const ir_node *node);
810
void     set_Or_right(ir_node *node, ir_node *right);
811

812
ir_node *get_Eor_left(const ir_node *node);
813
void     set_Eor_left(ir_node *node, ir_node *left);
814
ir_node *get_Eor_right(const ir_node *node);
815
void     set_Eor_right(ir_node *node, ir_node *right);
816

817
ir_node *get_Not_op(const ir_node *node);
818
void     set_Not_op(ir_node *node, ir_node *op);
Christian Schäfer's avatar
Christian Schäfer committed
819

Michael Beck's avatar
Michael Beck committed
820
/** returns the pnc name from an pnc constant */
821
const char *get_pnc_string(int pnc);
Michael Beck's avatar
Michael Beck committed
822

823
/** Calculates the negated (Complement(R)) pnc condition. */
824
pn_Cmp      get_negated_pnc(long pnc, ir_mode *mode);
Michael Beck's avatar
Michael Beck committed
825

826
/** Calculates the inversed (R^-1) pnc condition, i.e., "<" --> ">" */
827
pn_Cmp      get_inversed_pnc(long pnc);
Michael Beck's avatar
Michael Beck committed
828

829
830
831
/** An alternative name for get_inversed_pnc() that can be better memorized. */
#define get_mirrored_pnc(pnc)  get_inversed_pnc(pnc)

832
ir_node *get_Cmp_left(const ir_node *node);
833
void     set_Cmp_left(ir_node *node, ir_node *left);
834
ir_node *get_Cmp_right(const ir_node *node);
835
void     set_Cmp_right(ir_node *node, ir_node *right);
836

837
ir_node *get_Shl_left(const ir_node *node);
838
void     set_Shl_left(ir_node *node, ir_node *left);
839
ir_node *get_Shl_right(const ir_node *node);
840
void     set_Shl_right(ir_node *node, ir_node *right);
841

842
ir_node *get_Shr_left(const ir_node *node);
843
void     set_Shr_left(ir_node *node, ir_node *left);
844
ir_node *get_Shr_right(const ir_node *node);
845
void     set_Shr_right(ir_node *node, ir_node *right);
846

847
ir_node *get_Shrs_left(const ir_node *node);
848
void     set_Shrs_left(ir_node *node, ir_node *left);
849
ir_node *get_Shrs_right(const ir_node *node);
Michael Beck's avatar