irnode.h 59.8 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
65
66
 *  The common fields are:
 *
 *  - firm_kind - A firm_kind tag containing k_type.  This is useful
 *                for dynamically checking whether a node is a ir_node.
 *  - 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
67
 */
Michael Beck's avatar
Michael Beck committed
68

Sebastian Felis's avatar
Sebastian Felis committed
69
/**
70
 * Some projection numbers must be always equal to support automatic phi construction
Michael Beck's avatar
Michael Beck committed
71
 */
72
73
74
75
76
77
enum pn_generic {
	pn_Generic_M_regular = 0,  /**< The memory result. */
	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
78

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

87
88
89
90
91
/**
 * Returns the number of predecessors without the block predecessor.
 *
 * @param node   the IR-node
 */
92
93
94
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
95
96

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

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

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

Sebastian Hack's avatar
Sebastian Hack committed
118
119
120
/**
* Add a artificial dependency to the node.
* The dependency is only inserted if it is not there already.
121
122
* This is only allowed in phase_backend!
*
Sebastian Hack's avatar
Sebastian Hack committed
123
124
* @param node The node.
* @param dep  The dependency target.
125
*
Sebastian Hack's avatar
Sebastian Hack committed
126
127
128
129
130
131
* @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.
132
133
 * This is only allowed in phase_backend!
 *
134
 * @param tgt The node which should be enriched.
Sebastian Hack's avatar
Sebastian Hack committed
135
136
137
138
139
 * @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
140
141
142
143
 * 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
144
145
146
int get_irn_deps(const ir_node *node);

/**
Michael Beck's avatar
Michael Beck committed
147
148
149
150
151
 * 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
152
153
154
ir_node *get_irn_dep(const ir_node *node, int pos);

/**
Michael Beck's avatar
Michael Beck committed
155
156
157
158
159
 * 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
160
161
162
void set_irn_dep(ir_node *node, int pos, ir_node *dep);


Michael Beck's avatar
Michael Beck committed
163
164
165
166
/**
 * 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.
 */
167
ir_node *get_irn_intra_n(const ir_node *node, int n);
Michael Beck's avatar
Michael Beck committed
168
169
170
171

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

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

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

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

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

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

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

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

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

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

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

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

Michael Beck's avatar
Michael Beck committed
292
293
294
295
296
297
298
299
300
301
302
303
304
/**
 * 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);

Götz Lindenmaier's avatar
Götz Lindenmaier committed
305
/**
Michael Beck's avatar
Michael Beck committed
306
 * @function get_irn_block()
307
 * @see get_nodes_block()
Götz Lindenmaier's avatar
Götz Lindenmaier committed
308
 */
309

310
311
312
313
/**
 * Projection numbers for result of Start node: use for Proj nodes!
 */
typedef enum {
Michael Beck's avatar
Michael Beck committed
314
315
316
317
318
319
320
	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 */
321
322
} pn_Start; /* Projection numbers for Start. */

323
324
325
326
/** 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. */
327
ir_type *is_frame_pointer(const ir_node *n);
328

329
/** Test whether arbitrary node is the thread local storage (tls) pointer.
330
331
332
 *
 * Test whether arbitrary node is tls pointer, i.e. Proj(pn_Start_P_tls)
 * from Start.  If so returns tls type, else Null. */
333
ir_type *is_tls_pointer(const ir_node *n);
334

335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
/** 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);

357
358
/** Get the predecessor block.
 *
359
 *  Returns the block corresponding to the predecessor pos of block.
360
361
362
363
364
365
 *
 *  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
366
 *    Start block, but the Bad node.
367
 */
368
ir_node  *get_Block_cfgpred_block(const ir_node *node, int pos);
369
370
371
372
373

/** 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
374
375
376

/** A visited flag only for block nodes.
 *  @see also: get_irn_visited() inc_irg_visited() inc_irg_block_visited()*/
377
378
ir_visited_t get_Block_block_visited(const ir_node *block);
void         set_Block_block_visited(ir_node *block, ir_visited_t visit);
379
380
381
382
383

/**
 * Marks a block as dead but do not replace it with a Bad node.
 * Dead blocks are removed in the con
 */
384
385
386
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
387
/* For this current_ir_graph must be set. */
388
void      mark_Block_block_visited(ir_node *node);
Matthias Braun's avatar
Matthias Braun committed
389
int       Block_block_visited(const ir_node *node);
Christian Schäfer's avatar
Christian Schäfer committed
390

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

408
/** Returns the extended basic block a block belongs to. */
409
ir_extblk *get_Block_extbb(const ir_node *block);
410
/** Sets the extended basic block a block belongs to. */
411
void set_Block_extbb(ir_node *block, ir_extblk *extblk);
Michael Beck's avatar
Michael Beck committed
412
413
/** 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
414
415
/** 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
416
417
/** Get the Macro Block header of a node. */
ir_node *get_irn_MacroBlock(const ir_node *n);
418
419
/** Returns the ir_graph this Block belongs to. */
ir_graph *get_Block_irg(const ir_node *block);
420
421
422
423
424
425
426
427
/** 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);
428
429
430
431
/** 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
432
433
/** 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
434
435
436
437
/** 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
438

Michael Beck's avatar
Michael Beck committed
439
/** Return the number of Keep alive node. */
440
int  get_End_n_keepalives(const ir_node *end);
Michael Beck's avatar
Michael Beck committed
441
/** Return the Keep alive node a position pos. */
442
ir_node *get_End_keepalive(const ir_node *end, int pos);
Michael Beck's avatar
Michael Beck committed
443
/** Keep alive dedicated nodes.  These must be either PhiM or Block nodes. */
444
void add_End_keepalive(ir_node *end, ir_node *ka);
Michael Beck's avatar
Michael Beck committed
445
/** Set the Keep alive node at position pos. */
446
void set_End_keepalive(ir_node *end, int pos, ir_node *ka);
447
448
449
450
451
452

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

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

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

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

466
/** Return the target address of an IJmp */
467
ir_node *get_IJmp_target(const ir_node *ijmp);
468
469
/** Sets the target address of an IJmp */
void set_IJmp_target(ir_node *ijmp, ir_node *tgt);
470

471
472
473
474
475
476
477
478
/* We distinguish three kinds of Cond nodes.  These can be distinguished
   by the mode of the selector operand and an internal flag of type cond_kind.
   First we distinguish binary Conds and switch Conds.
   A binary Cond has as selector a boolean value.  Proj(0) projects the control
   flow for case "False", Proj(1) the control flow for "True".  A binary Cond
   is recognized by the boolean selector.
   The switch Cond has as selector an unsigned integer.  It produces as result
   an n+1 Tuple (cf0, ... , cfn) of control flows.
479
   We differ two flavors of this Cond.  The first, the dense Cond, passes
480
481
   control along output i if the selector value is i, 0 <= i <= n.  If the
   selector value is >n it passes control along output n.
482
   The second Cond flavor differences in the treatment of cases not specified in
483
484
485
486
487
   the source program.  It magically knows about the existence of Proj nodes.
   It only passes control along output i, 0 <= i <= n, if a node Proj(Cond, i)
   exists.  Else it passes control along output n (even if this Proj does not
   exist.)  This Cond we call "fragmentary".  There is a special constructor
   new_defaultProj that automatically sets the flavor.
488
489
   The two switch flavors are distinguished by a flag of type cond_kind.
   Default flavor is "dense"
490
491
*/
typedef enum {
Michael Beck's avatar
Michael Beck committed
492
493
494
	dense,        /**< Default. Missing Proj nodes are dead control flow. */
	fragmentary   /**< Special. No control flow optimizations allowed.  Missing
	                   Proj nodes mean default control flow, i.e., Proj(n). */
495
496
} cond_kind;

497
498
499
/** Gets the string representation of the Cond node kind. */
const char *get_cond_kind_name(cond_kind kind);

500
ir_node  *get_Cond_selector(const ir_node *node);
501
void      set_Cond_selector(ir_node *node, ir_node *selector);
502
cond_kind get_Cond_kind(const ir_node *node);
503
void      set_Cond_kind(ir_node *node, cond_kind kind);
504
505
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
506

507
508
509
/**
 * Projection numbers for conditions.
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
510
typedef enum {
Michael Beck's avatar
Michael Beck committed
511
512
513
	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
514
515
} pn_Cond;  /* Projection numbers for Cond. */

516
ir_node  *get_Return_mem(const ir_node *node);
517
518
void      set_Return_mem(ir_node *node, ir_node *mem);
ir_node **get_Return_res_arr(ir_node *node);
519
520
int       get_Return_n_ress(const ir_node *node);
ir_node  *get_Return_res(const ir_node *node, int pos);
521
void      set_Return_res(ir_node *node, int pos, ir_node *res);
Christian Schäfer's avatar
Christian Schäfer committed
522

Christoph Mallon's avatar
Christoph Mallon committed
523
tarval  *get_Const_tarval(const ir_node *node);
524
void     set_Const_tarval(ir_node *node, tarval *con);
Michael Beck's avatar
Michael Beck committed
525

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

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

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

Michael Beck's avatar
Michael Beck committed
535
536
537
/** Returns the source language type of a Const node.
 * Must be an atomic type.  Mode of type must be mode of node.
 */
538
ir_type  *get_Const_type(ir_node *node);
Michael Beck's avatar
Michael Beck committed
539
540

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

543
544
545
546
547
548
549
/** 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 */
550
#define SYMCONST_HAS_ENT(kind) ((kind) == symconst_addr_ent || (kind) == symconst_ofs_ent)
551

552
553
554
/** 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
555
/** Get the kind of the SymConst. */
556
symconst_kind get_SymConst_kind(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
557
/** Set the kind of the SymConst. */
558
void          set_SymConst_kind(ir_node *node, symconst_kind num);
Beyhan's avatar
Beyhan committed
559
560

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

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

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

572
/** Only to access SymConst of kind symconst_enum_const.  Else assertion: */
Michael Beck's avatar
Michael Beck committed
573
ir_enum_const *get_SymConst_enum(const ir_node *node);
574
void           set_SymConst_enum(ir_node *node, ir_enum_const *ec);
575

Beyhan's avatar
Beyhan committed
576
577
/** 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
578
/* write 'union': firmjni then does not create a method... */
Michael Beck's avatar
Michael Beck committed
579
union symconst_symbol get_SymConst_symbol(const ir_node *node);
580
581
void                  set_SymConst_symbol(ir_node *node,
                                          union symconst_symbol sym);
582

Götz Lindenmaier's avatar
Götz Lindenmaier committed
583
584
585
/** Access the type of the value represented by the SymConst.
 *
 *  Example: primitive type int for SymConst size. */
586
587
588
ir_type *get_SymConst_value_type(ir_node *node);
void    set_SymConst_value_type(ir_node *node, ir_type *tp);

589
ir_node   *get_Sel_mem(const ir_node *node);
590
void       set_Sel_mem(ir_node *node, ir_node *mem);
591
ir_node   *get_Sel_ptr(const ir_node *node);  /* ptr to the object to select from */
592
593
void       set_Sel_ptr(ir_node *node, ir_node *ptr);
ir_node   **get_Sel_index_arr(ir_node *node);
594
595
int        get_Sel_n_indexs(const ir_node *node);
ir_node   *get_Sel_index(const ir_node *node, int pos);
596
void       set_Sel_index(ir_node *node, int pos, ir_node *index);
597
ir_entity *get_Sel_entity(const ir_node *node); /* entity to select */
598
void       set_Sel_entity (ir_node *node, ir_entity *ent);
Christian Schäfer's avatar
Christian Schäfer committed
599

600
601
602
/**
 * Projection numbers for result of Call node: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
603
typedef enum {
604
605
606
607
608
609
610
611
612
	pn_Call_M_regular = pn_Generic_M_regular, /**< The memory result. */
	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_M_except,                         /**< The memory result in case the called method terminated with
	                                               an exception. */
	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
613
} pn_Call;   /* Projection numbers for Call. */
614
#define pn_Call_M pn_Call_M_regular
Götz Lindenmaier's avatar
Götz Lindenmaier committed
615

Michael Beck's avatar
Michael Beck committed
616
/** Retrieve the memory input of a Call. */
617
ir_node *get_Call_mem(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
618
/** Set the memory input of a Call. */
619
void     set_Call_mem(ir_node *node, ir_node *mem);
Michael Beck's avatar
Michael Beck committed
620
/** Retrieve the call address of a Call. */
621
ir_node *get_Call_ptr(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
622
/** Set the call address of a Call. */
623
624
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
625
/** Gets the number of parameters of a call. */
626
int      get_Call_n_params(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
627
/** Gets the call parameter at position pos. */
628
ir_node *get_Call_param(const ir_node *node, int pos);
Michael Beck's avatar
Michael Beck committed
629
/** Sets the call parameter at position pos. */
630
void     set_Call_param(ir_node *node, int pos, ir_node *param);
Michael Beck's avatar
Michael Beck committed
631
/** Gets the type of a call. */
632
ir_type *get_Call_type(ir_node *node);
Michael Beck's avatar
Michael Beck committed
633
/** Sets the type of a call. */
634
void     set_Call_type(ir_node *node, ir_type *tp);
Michael Beck's avatar
Michael Beck committed
635
636
637
638
639
640

/**
 * 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);
641

642
643
644
645
/** 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
646
647
648
649
 *  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.
650
651
652
653
654
655
656
657
658
 *
 *  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.
 */
659
660
661
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
662

663
664
665
/** Set the full callee array.
 *
 *  The passed array is copied. Assumes current_ir_graph set properly! */
666
void    set_Call_callee_arr(ir_node *node, const int n, ir_entity **arr);
667
void    remove_Call_callee_arr(ir_node *node);
668

669
670
671
672
673
/**
 * Projection numbers for result of Builtin node: use for Proj nodes!
 */
typedef enum {
	pn_Builtin_M        = pn_Generic_M_regular, /**< The memory result. */
674
	pn_Builtin_1_result = pn_Generic_other,     /**< first result. */
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
	pn_Builtin_max                              /**< number of projections from a Builtin */
} 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
696
/** Retrieve the call address of a CallBegin. */
697
ir_node  *get_CallBegin_ptr(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
698
/** Set the call address of a CallBegin. */
699
void      set_CallBegin_ptr(ir_node *node, ir_node *ptr);
Michael Beck's avatar
Michael Beck committed
700
/** Retrieve the original Call node of a CallBegin. */
701
ir_node  *get_CallBegin_call(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
702
/** Set the original Call node of a CallBegin. */
703
void      set_CallBegin_call(ir_node *node, ir_node *call);
704

Christian Schäfer's avatar
Christian Schäfer committed
705
706
707
/* 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
708
   unops are: Minus, Abs, Not, Conv, Cast
Christian Schäfer's avatar
Christian Schäfer committed
709
   binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
710
   Shr, Shrs, Rotl, Cmp */
711
int      is_unop(const ir_node *node);
712
ir_node *get_unop_op(const ir_node *node);
713
714
void     set_unop_op(ir_node *node, ir_node *op);
int      is_binop(const ir_node *node);
715
ir_node *get_binop_left(const ir_node *node);
716
void     set_binop_left(ir_node *node, ir_node *left);
717
ir_node *get_binop_right(const ir_node *node);
718
719
void     set_binop_right(ir_node *node, ir_node *right);

720
ir_node *get_Add_left(const ir_node *node);
721
void     set_Add_left(ir_node *node, ir_node *left);
722
ir_node *get_Add_right(const ir_node *node);
723
724
void     set_Add_right(ir_node *node, ir_node *right);

725
726
727
728
729
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);

730
731
732
733
734
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);

735
ir_node *get_Sub_left(const ir_node *node);
736
void     set_Sub_left(ir_node *node, ir_node *left);
737
ir_node *get_Sub_right(const ir_node *node);
738
739
void     set_Sub_right(ir_node *node, ir_node *right);

740
ir_node *get_Minus_op(const ir_node *node);
741
742
void     set_Minus_op(ir_node *node, ir_node *op);

743
ir_node *get_Mul_left(const ir_node *node);
744
void     set_Mul_left(ir_node *node, ir_node *left);
745
ir_node *get_Mul_right(const ir_node *node);
746
747
void     set_Mul_right(ir_node *node, ir_node *right);

Michael Beck's avatar
Michael Beck committed
748
749
750
751
752
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);

753
ir_node *get_Quot_left(const ir_node *node);
754
void     set_Quot_left(ir_node *node, ir_node *left);
755
ir_node *get_Quot_right(const ir_node *node);
756
void     set_Quot_right(ir_node *node, ir_node *right);
757
ir_node *get_Quot_mem(const ir_node *node);
758
void     set_Quot_mem(ir_node *node, ir_node *mem);
759
760
ir_mode *get_Quot_resmode(const ir_node *node);
void     set_Quot_resmode(ir_node *node, ir_mode *mode);
761

762
763
764
/**
 * Projection numbers for Quot: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
765
typedef enum {
766
767
768
769
770
	pn_Quot_M         = pn_Generic_M_regular, /**< Memory result. */
	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
771
772
} pn_Quot;  /* Projection numbers for Quot. */

773
ir_node *get_DivMod_left(const ir_node *node);
774
void     set_DivMod_left(ir_node *node, ir_node *left);
775
ir_node *get_DivMod_right(const ir_node *node);
776
void     set_DivMod_right(ir_node *node, ir_node *right);
777
ir_node *get_DivMod_mem(const ir_node *node);
778
void     set_DivMod_mem(ir_node *node, ir_node *mem);
779
780
ir_mode *get_DivMod_resmode(const ir_node *node);
void     set_DivMod_resmode(ir_node *node, ir_mode *mode);
781

782
783
784
/**
 * Projection numbers for DivMod: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
785
typedef enum {
786
787
788
789
790
791
	pn_DivMod_M         = pn_Generic_M_regular, /**< Memory result. */
	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
792
793
} pn_DivMod;  /* Projection numbers for DivMod. */

794
ir_node *get_Div_left(const ir_node *node);
795
void     set_Div_left(ir_node *node, ir_node *left);
796
ir_node *get_Div_right(const ir_node *node);
797
void     set_Div_right(ir_node *node, ir_node *right);
798
ir_node *get_Div_mem(const ir_node *node);
799
void     set_Div_mem(ir_node *node, ir_node *mem);
800
801
ir_mode *get_Div_resmode(const ir_node *node);
void     set_Div_resmode(ir_node *node, ir_mode *mode);
802
int      get_Div_no_remainder(const ir_node *node);
803
void     set_Div_no_remainder(ir_node *node, int no_remainder);
804

805
806
807
/**
 * Projection numbers for Div: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
808
typedef enum {
809
810
811
812
813
	pn_Div_M         = pn_Generic_M_regular, /**< Memory result. */
	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
814
815
} pn_Div;  /* Projection numbers for Div. */

816
ir_node *get_Mod_left(const ir_node *node);
817
void     set_Mod_left(ir_node *node, ir_node *left);
818
ir_node *get_Mod_right(const ir_node *node);
819
void     set_Mod_right(ir_node *node, ir_node *right);
820
ir_node *get_Mod_mem(const ir_node *node);
821
void     set_Mod_mem(ir_node *node, ir_node *mem);
822
823
ir_mode *get_Mod_resmode(const ir_node *node);
void     set_Mod_resmode(ir_node *node, ir_mode *mode);
824

825
826
827
/**
 * Projection numbers for Mod: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
828
typedef enum {
829
830
831
832
833
	pn_Mod_M         = pn_Generic_M_regular, /**< Memory result.    */
	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
834
835
} pn_Mod;  /* Projection numbers for Mod. */

836
ir_node *get_Abs_op(const ir_node *node);
837
void     set_Abs_op(ir_node *node, ir_node *op);
838

839
ir_node *get_And_left(const ir_node *node);
840
void     set_And_left(ir_node *node, ir_node *left);
841
ir_node *get_And_right(const ir_node *node);
842
void     set_And_right(ir_node *node, ir_node *right);
843

844
ir_node *get_Or_left(const ir_node *node);
845
void     set_Or_left(ir_node *node, ir_node *left);
846
ir_node *get_Or_right(const ir_node *node);
847
void     set_Or_right(ir_node *node, ir_node *right);
848

849
ir_node *get_Eor_left(const ir_node *node);
850
void     set_Eor_left(ir_node *node, ir_node *left);
851
ir_node *get_Eor_right(const ir_node *node);
852
void     set_Eor_right(ir_node *node, ir_node *right);
853

854
ir_node *get_Not_op(const ir_node *node);
855
void     set_Not_op(ir_node *node, ir_node *op);
Christian Schäfer's avatar
Christian Schäfer committed
856

Michael Beck's avatar
Michael Beck committed
857
/** returns the pnc name from an pnc constant */
858
const char *get_pnc_string(int pnc);
Michael Beck's avatar
Michael Beck committed
859

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

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

866
867
868
/** An alternative name for get_inversed_pnc() that can be better memorized. */
#define get_mirrored_pnc(pnc)  get_inversed_pnc(pnc)

869
ir_node *get_Cmp_left(const ir_node *node);
870
void     set_Cmp_left(ir_node *node, ir_node *left);
871
ir_node *get_Cmp_right(const ir_node *node);
872
void     set_Cmp_right(ir_node *node, ir_node *right);