irnode.h 55 KB
Newer Older
Christian Würdig's avatar
Christian Würdig committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
/*
 * Copyright (C) 1995-2007 University of Karlsruhe.  All right reserved.
 *
 * 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
35
#include "irop.h"
#include "irmode.h"
#include "dbginfo.h"
Christian Schäfer's avatar
Christian Schäfer committed
36

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

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

Sebastian Felis's avatar
Sebastian Felis committed
70
/**
Michael Beck's avatar
Michael Beck committed
71
72
73
 *   you can work on the graph without considering the different types
 *   of nodes, it's just a big graph.
 */
Christian Schäfer's avatar
Christian Schäfer committed
74

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

83
84
85
86
87
/**
 * Returns the number of predecessors without the block predecessor.
 *
 * @param node   the IR-node
 */
88
89
90
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
91
92

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

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

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

Sebastian Hack's avatar
Sebastian Hack committed
114
115
116
117
118
119
120
121
122
123
124
/**
* Add a artificial dependency to the node.
* The dependency is only inserted if it is not there already.
* @param node The node.
* @param dep  The dependency target.
* @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.
125
 * @param tgt The node which should be enriched.
Sebastian Hack's avatar
Sebastian Hack committed
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 * @param src The node whose dependencies shall be copied.
 */
void add_irn_deps(ir_node *tgt, ir_node *src);

/**
* 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.
*/
int get_irn_deps(const ir_node *node);

/**
* Get an entry of the dependency array.
* @param node The node.
* @param pos  The position.
* @return The node at that position.
*/
ir_node *get_irn_dep(const ir_node *node, int pos);

/**
* Set an entry of the dependency array.
* @param node The node.
* @param pos  The position.
* @param dep  The dependency target.
*/
void set_irn_dep(ir_node *node, int pos, ir_node *dep);


Michael Beck's avatar
Michael Beck committed
154
155
156
157
/**
 * 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.
 */
158
ir_node *get_irn_intra_n(const ir_node *node, int n);
Michael Beck's avatar
Michael Beck committed
159
160
161
162

/**
 * Get the n-th predecessor of a node in interprocedural view.
 */
163
ir_node *get_irn_inter_n(const ir_node *node, int n);
164
165

/** Replace the n-th predecessor of a node with a new one. */
166
void set_irn_n(ir_node *node, int n, ir_node *in);
167
168
169
170
171
172
/**
 * 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);
173
/* Sets the mode struct of node.  */
174
void set_irn_mode(ir_node *node, ir_mode *mode);
175
/** Gets the mode struct of a node.  */
176
ir_mode *get_irn_mode(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
177
/** Gets the mode-enum modecode. */
178
modecode get_irn_modecode(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
179
/** Gets the ident for a string representation of the mode .*/
180
ident *get_irn_modeident(const ir_node *node);
181
/** Gets the string representation of the mode .*/
182
const char *get_irn_modename(const ir_node *node);
183
/** Gets the opcode struct of the node. */
184
ir_op *get_irn_op(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
185
/** Sets the opcode struct of the node. */
186
void set_irn_op(ir_node *node, ir_op *op);
Michael Beck's avatar
Michael Beck committed
187
/** Gets the opcode-enum of the node. */
188
ir_opcode get_irn_opcode(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
189
/** Get the string representation of the opcode. */
190
const char *get_irn_opname(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
191
/** Get the ident for a string representation of the opcode. */
192
ident *get_irn_opident(const ir_node *node);
193
/** If arg is an argument of the node, returns it's position, -1 otherwise */
194
int get_irn_pred_pos(ir_node *node, ir_node *arg);
195
/** Gets the visited counter of a node. */
196
unsigned long get_irn_visited(const ir_node *node);
197
/** Sets the visited counter of a node. */
198
void set_irn_visited(ir_node *node, unsigned long visited);
Michael Beck's avatar
Michael Beck committed
199
/** Sets visited to get_irg_visited(current_ir_graph). */
200
void mark_irn_visited(ir_node *node);
201
/** Returns 1 if visited < get_irg_visited(current_ir_graph). */
202
int irn_not_visited(const ir_node *node);
203
/** Returns 1 if visited >= get_irg_visited(current_ir_graph). */
204
int irn_visited(const ir_node *node);
205
206
207
208
209

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

/** Returns the link of a node.  */
213
void *get_irn_link(const ir_node *node);
214
215

/** Returns the ir_graph this node belongs to. Only valid if irg
216
 *  is in state op_pin_state_pinned (irg is only stored in the block. */
217
ir_graph *get_irn_irg(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
218

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

224
225
226
227
228
229
230
/** 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.
 */
231
op_pin_state get_irn_pinned(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
232
233
234

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

236
237
238
239
240
241
/** 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'.
 */
242
op_pin_state is_irn_pinned_in_irg(const ir_node *node);
243

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

267
268
269
270
271
/**
 * 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
272
273
274
275
276
 *
 * 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
277
 * get_irn_block(). */
Sebastian Hack's avatar
Sebastian Hack committed
278
ir_node  *get_nodes_block (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
279
280

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

Götz Lindenmaier's avatar
Götz Lindenmaier committed
283
/**
Michael Beck's avatar
Michael Beck committed
284
 * @function get_irn_block()
285
 * @see get_nodes_block()
Götz Lindenmaier's avatar
Götz Lindenmaier committed
286
 */
287

288
289
290
291
/**
 * Projection numbers for result of Start node: use for Proj nodes!
 */
typedef enum {
292
293
294
295
  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_globals,        /**< Projection on the pointer to the data segment
296
297
298
299
                                  containing _all_ global entities.  Use for
                                  position independent data/code access. */
  pn_Start_P_tls,            /**< Projection on the pointer to the thread local store
                                  segment containing _all_thread local variables. */
300
301
302
303
  pn_Start_T_args,           /**< Projection on all arguments. */
  pn_Start_P_value_arg_base, /**< Pointer to region of compound value arguments as defined by
                                  type of this method. */
  pn_Start_max               /**< number of projections from a Start */
304
305
} pn_Start; /* Projection numbers for Start. */

306
307
308
309
/** Test whether arbitrary node is frame pointer.
 *
 * Test whether arbitrary node is frame pointer, i.e. Proj(pn_Start_P_frame_base)
 * from Start.  If so returns frame type, else Null. */
Michael Beck's avatar
Michael Beck committed
310
ir_type *is_frame_pointer(ir_node *n);
311
312
313
314
315

/** Test whether arbitrary node is globals pointer.
 *
 * Test whether arbitrary node is globals pointer, i.e. Proj(pn_Start_P_globals)
 * from Start.  If so returns global type, else Null. */
Michael Beck's avatar
Michael Beck committed
316
ir_type *is_globals_pointer(ir_node *n);
317

318
319
320
321
322
323
/** Test whether arbitrary node is tls pointer.
 *
 * Test whether arbitrary node is tls pointer, i.e. Proj(pn_Start_P_tls)
 * from Start.  If so returns tls type, else Null. */
ir_type *is_tls_pointer(ir_node *n);

324
325
326
327
328
329
/** Test whether arbitrary node is value arg base.
 *
 * Test whether arbitrary node is value arg base, i.e. Proj(pn_Start_P_value_arg_base)
 * from Start.   If so returns 1, else 0. */
int   is_value_arg_pointer(ir_node *n);

Götz Lindenmaier's avatar
Götz Lindenmaier committed
330

331
/* @@@ no more supported  */
332
333
334
335
ir_node **get_Block_cfgpred_arr(ir_node *node);
int       get_Block_n_cfgpreds(const ir_node *node);
ir_node  *get_Block_cfgpred(ir_node *node, int pos);
void      set_Block_cfgpred(ir_node *node, int pos, ir_node *pred);
336
337
/** Get the predecessor block.
 *
338
 *  Returns the block corresponding to the predecessor pos of block.
339
340
341
342
343
344
345
346
347
 *
 *  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
 *    Start, but the Bad node.
 */
ir_node  *get_Block_cfgpred_block(ir_node *node, int pos);
348
349
int       get_Block_matured(ir_node *node);
void      set_Block_matured(ir_node *node, int matured);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
350
351
352

/** A visited flag only for block nodes.
 *  @see also: get_irn_visited() inc_irg_visited() inc_irg_block_visited()*/
Matthias Braun's avatar
Matthias Braun committed
353
unsigned long get_Block_block_visited(const ir_node *node);
354
void      set_Block_block_visited(ir_node *node, unsigned long visit);
355
356
357
358
359

/**
 * Marks a block as dead but do not replace it with a Bad node.
 * Dead blocks are removed in the con
 */
360
361
362
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
363
/* For this current_ir_graph must be set. */
364
void      mark_Block_block_visited(ir_node *node);
Matthias Braun's avatar
Matthias Braun committed
365
366
int       Block_not_block_visited(const ir_node *node);
int       Block_block_visited(const ir_node *node);
Christian Schäfer's avatar
Christian Schäfer committed
367

368
369
/* Set and remove interprocedural predecessors. If the interprocedural
 * predecessors are removed, the node has the same predecessors in
370
371
 * both views.
 * @@@ Maybe better:  arity is zero if no cg preds. */
Michael Beck's avatar
Michael Beck committed
372
void      set_Block_cg_cfgpred_arr(ir_node *node, int arity, ir_node *in[]);
373
void      set_Block_cg_cfgpred(ir_node *node, int pos, ir_node *pred);
374
/* @@@ not supported */
375
ir_node **get_Block_cg_cfgpred_arr(ir_node *node);
Michael Beck's avatar
Michael Beck committed
376
/** Returns the number of interprocedural predecessors.  0 if none. */
377
int       get_Block_cg_n_cfgpreds(ir_node *node);
Michael Beck's avatar
Michael Beck committed
378
/** Return the interprocedural predecessor at position pos. */
379
380
381
ir_node  *get_Block_cg_cfgpred(ir_node *node, int pos);
/** Frees the memory allocated for interprocedural predecessors. */
void      remove_Block_cg_cfgpred_arr(ir_node *node);
382

383
/** Returns the extended basic block a block belongs to. */
384
ir_extblk *get_Block_extbb(const ir_node *block);
385
/** Sets the extended basic block a block belongs to. */
386
387
void set_Block_extbb(ir_node *block, ir_extblk *extblk);

Michael Beck's avatar
Michael Beck committed
388
389
390
/** 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
391
/** Return the number of Keep alive node. */
392
int  get_End_n_keepalives(ir_node *end);
Michael Beck's avatar
Michael Beck committed
393
394

/** Return the Keep alive node a position pos. */
395
ir_node *get_End_keepalive(ir_node *end, int pos);
Michael Beck's avatar
Michael Beck committed
396
397

/** Keep alive dedicated nodes.  These must be either PhiM or Block nodes. */
398
void add_End_keepalive (ir_node *end, ir_node *ka);
Michael Beck's avatar
Michael Beck committed
399
400

/** Set the Keep alive node at position pos. */
401
void set_End_keepalive(ir_node *end, int pos, ir_node *ka);
Michael Beck's avatar
Michael Beck committed
402

403
404
405
/** Set new keep-alives */
void set_End_keepalives(ir_node *end, int n, ir_node *in[]);

406
407
408
/* Set new keep-alives from old keep-alives, skipping irn */
void remove_End_keepalive(ir_node *end, ir_node *irn);

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

414
415
416
417
418
/** Return the target address of an IJmp */
ir_node *get_IJmp_target(ir_node *ijmp);

/** Sets the target address of an IJmp */
void set_IJmp_target(ir_node *ijmp, ir_node *tgt);
419

420
421
422
423
424
425
426
427
/* 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.
428
   We differ two flavors of this Cond.  The first, the dense Cond, passes
429
430
   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.
431
   The second Cond flavor differences in the treatment of cases not specified in
432
433
434
435
436
   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.
437
438
   The two switch flavors are distinguished by a flag of type cond_kind.
   Default flavor is "dense"
439
440
*/
typedef enum {
Michael Beck's avatar
Michael Beck committed
441
442
  dense,        /**< Default. Missing Proj nodes are dead control flow. */
  fragmentary   /**< Special. No control flow optimizations allowed.  Missing
Florian Liekweg's avatar
Florian Liekweg committed
443
           Proj nodes mean default control flow, i.e., Proj(n). */
444
445
} cond_kind;

446
447
448
449
450
ir_node  *get_Cond_selector(ir_node *node);
void      set_Cond_selector(ir_node *node, ir_node *selector);
cond_kind get_Cond_kind(ir_node *node);
void      set_Cond_kind(ir_node *node, cond_kind kind);
long      get_Cond_defaultProj(ir_node *node);
Christian Schäfer's avatar
Christian Schäfer committed
451

452
453
454
/**
 * Projection numbers for conditions.
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
455
456
typedef enum {
  pn_Cond_false,    /**< Control flow if operand is "false". */
457
458
  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
459
460
} pn_Cond;  /* Projection numbers for Cond. */

461
462
463
464
465
466
ir_node  *get_Return_mem(ir_node *node);
void      set_Return_mem(ir_node *node, ir_node *mem);
ir_node **get_Return_res_arr(ir_node *node);
int       get_Return_n_ress(ir_node *node);
ir_node  *get_Return_res(ir_node *node, int pos);
void      set_Return_res(ir_node *node, int pos, ir_node *res);
Christian Schäfer's avatar
Christian Schäfer committed
467

468
469
470
/**
 * Possible classes for constant classification.
 */
Sebastian Hack's avatar
Sebastian Hack committed
471
typedef enum {
472
473
474
  CNST_NULL     =  0, /**< The node is a const(0). */
  CNST_ONE      = +1, /**< The node is a const(1). */
  CNST_ALL_ONE  = -1, /**< The node is a const(11111...). */
475
  CNST_OTHER    =  2, /**< The tarval of the const has another value. */
476
477
  CNST_SYMCONST =  3, /**< The node is symconst. */
  CNST_NO_CONST =  4  /**< The node is no const at all. */
Sebastian Hack's avatar
Sebastian Hack committed
478
479
} cnst_classify_t;

Christoph Mallon's avatar
Christoph Mallon committed
480
tarval  *get_Const_tarval(const ir_node *node);
481
void     set_Const_tarval(ir_node *node, tarval *con);
Michael Beck's avatar
Michael Beck committed
482

Sebastian Hack's avatar
Sebastian Hack committed
483
484
485
486
487
488
489
/**
 * Classify a node concerning constant properties.
 * @param irn A node to check for.
 * @return Constant properties of that node.
 */
cnst_classify_t classify_Const(ir_node *irn);

Michael Beck's avatar
Michael Beck committed
490
491
492
/** Returns the source language type of a Const node.
 * Must be an atomic type.  Mode of type must be mode of node.
 */
493
ir_type  *get_Const_type(ir_node *node);
Michael Beck's avatar
Michael Beck committed
494
495

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

Michael Beck's avatar
Michael Beck committed
498
/**  This enum names the three different kinds of symbolic Constants
Götz Lindenmaier's avatar
Götz Lindenmaier committed
499
500
501
502
     represented by SymConst.  The content of the attribute type_or_id
     depends on this tag.  Use the proper access routine after testing
     this flag. */
typedef enum {
Beyhan's avatar
Beyhan committed
503
  symconst_type_tag,    /**< The SymConst is a type tag for the given type.
504
                             symconst_symbol is type *. */
505
  symconst_type_size,   /**< The SymConst is the size of the given type.
506
                             symconst_symbol is type *. */
507
  symconst_type_align,  /**< The SymConst is the alignment of the given type.
508
                             symconst_symbol is type *. */
Beyhan's avatar
Beyhan committed
509
  symconst_addr_name,   /**< The SymConst is a symbolic pointer to be filled in
510
511
                             by the linker.  The pointer is represented by a string.
                             symconst_symbol is ident *. */
512
  symconst_addr_ent,    /**< The SymConst is a symbolic pointer to be filled in
513
514
                             by the linker.  The pointer is represented by an entity.
                             symconst_symbol is entity *. */
515
516
  symconst_ofs_ent,     /**< The SymConst is the offset of its entity in the entities
                             owner type. */
517
  symconst_enum_const   /**< The SymConst is a enumeration constant of an
518
                             enumeration type. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
519
} symconst_kind;
520

521
522
523
524
525
526
527
/** 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 */
528
#define SYMCONST_HAS_ENT(kind) ((kind) == symconst_addr_ent || (kind) == symconst_ofs_ent)
529

530
531
532
/** Returns non-zero if s symconst kind has an enum_const attribute */
#define SYMCONST_HAS_ENUM(kind) ((kind) == symconst_enum_const)

Götz Lindenmaier's avatar
Götz Lindenmaier committed
533
534
/** SymConst attribute.
 *
535
536
 *  This union contains the symbolic information represented by the node.
 */
537
typedef union symconst_symbol {
538
539
  ir_type       *type_p;    /**< the type of a symconst */
  ident         *ident_p;   /**< the ident of a symconst */
540
  ir_entity     *entity_p;  /**< the entity of a symconst */
541
  ir_enum_const *enum_p;    /**< the enumeration constant of a symconst */
542
} symconst_symbol;
543

Michael Beck's avatar
Michael Beck committed
544
/** Get the kind of the SymConst. */
545
symconst_kind get_SymConst_kind(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
546
/** Set the kind of the SymConst. */
547
void          set_SymConst_kind(ir_node *node, symconst_kind num);
Beyhan's avatar
Beyhan committed
548
549

/** Only to access SymConst of kind type_tag or size.  Else assertion: */
550
551
ir_type  *get_SymConst_type(ir_node *node);
void     set_SymConst_type(ir_node *node, ir_type *tp);
Beyhan's avatar
Beyhan committed
552
553

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

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

561
/** Only to access SymConst of kind symconst_enum_const.  Else assertion: */
Michael Beck's avatar
Michael Beck committed
562
ir_enum_const *get_SymConst_enum(const ir_node *node);
563
void           set_SymConst_enum(ir_node *node, ir_enum_const *ec);
564

Beyhan's avatar
Beyhan committed
565
566
/** 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
567
/* write 'union': firmjni then does not create a method... */
Michael Beck's avatar
Michael Beck committed
568
union symconst_symbol get_SymConst_symbol(const ir_node *node);
569
570
void                  set_SymConst_symbol(ir_node *node,
                                          union symconst_symbol sym);
571

Götz Lindenmaier's avatar
Götz Lindenmaier committed
572
573
574
/** Access the type of the value represented by the SymConst.
 *
 *  Example: primitive type int for SymConst size. */
575
576
577
ir_type *get_SymConst_value_type(ir_node *node);
void    set_SymConst_value_type(ir_node *node, ir_type *tp);

578
579
580
581
582
583
584
585
586
587
ir_node   *get_Sel_mem(ir_node *node);
void       set_Sel_mem(ir_node *node, ir_node *mem);
ir_node   *get_Sel_ptr(ir_node *node);  /* ptr to the object to select from */
void       set_Sel_ptr(ir_node *node, ir_node *ptr);
ir_node   **get_Sel_index_arr(ir_node *node);
int        get_Sel_n_indexs(ir_node *node);
ir_node   *get_Sel_index(ir_node *node, int pos);
void       set_Sel_index(ir_node *node, int pos, ir_node *index);
ir_entity *get_Sel_entity(ir_node *node); /* entity to select */
void       set_Sel_entity (ir_node *node, ir_entity *ent);
Christian Schäfer's avatar
Christian Schäfer committed
588

589
590
591
/**
 * Projection numbers for result of Call node: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
592
typedef enum {
593
  pn_Call_M_regular = 0,       /**< The memory result. */
594
595
596
597
598
599
  pn_Call_X_regular = 1,       /**< The control flow result when no exception occurs. */
  pn_Call_X_except  = 2,       /**< The control flow result branching to the exception handler. */
  pn_Call_T_result  = 3,       /**< The tuple containing all (0, 1, 2, ...) results. */
  pn_Call_M_except  = 4,       /**< The memory result in case the called method terminated with
                                    an exception. */
  pn_Call_P_value_res_base = 5,/**< A pointer to the memory region containing copied results
600
                                    passed by value (for compound result types). */
601
  pn_Call_max       = 6        /**< number of projections from a Call */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
602
} pn_Call;   /* Projection numbers for Call. */
603
#define pn_Call_M pn_Call_M_regular
Götz Lindenmaier's avatar
Götz Lindenmaier committed
604

605
606
607
608
609
ir_node *get_Call_mem(ir_node *node);
void     set_Call_mem(ir_node *node, ir_node *mem);
ir_node *get_Call_ptr(ir_node *node);
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
610
/** Gets the number of parameters of a call. */
611
int      get_Call_n_params(ir_node *node);
Michael Beck's avatar
Michael Beck committed
612
/** Gets the call parameter at position pos. */
613
ir_node *get_Call_param(ir_node *node, int pos);
Michael Beck's avatar
Michael Beck committed
614
/** Sets the call parameter at position pos. */
615
void     set_Call_param(ir_node *node, int pos, ir_node *param);
Michael Beck's avatar
Michael Beck committed
616
/** Gets the type of a call. */
617
ir_type *get_Call_type(ir_node *node);
Michael Beck's avatar
Michael Beck committed
618
/** Sets the type of a call. */
619
void     set_Call_type(ir_node *node, ir_type *tp);
Michael Beck's avatar
Michael Beck committed
620
/** Gets the arity of a call. Identical to get_Call_n_params(). */
621
int      get_Call_arity(ir_node *node);
622

623
624
625
626
/** 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
627
628
629
630
 *  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.
631
632
633
634
635
636
637
638
639
 *
 *  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.
 */
640
641
642
int        Call_has_callees(ir_node *node);
int        get_Call_n_callees(ir_node *node);
ir_entity *get_Call_callee(ir_node *node, int pos);
Michael Beck's avatar
Michael Beck committed
643

644
645
646
/** Set the full callee array.
 *
 *  The passed array is copied. Assumes current_ir_graph set properly! */
647
void    set_Call_callee_arr(ir_node *node, const int n, ir_entity **arr);
648
void    remove_Call_callee_arr(ir_node *node);
649

650
651
652
653
ir_node  *get_CallBegin_ptr(ir_node *node);
void      set_CallBegin_ptr(ir_node *node, ir_node *ptr);
ir_node  *get_CallBegin_call(ir_node *node);
void      set_CallBegin_call(ir_node *node, ir_node *call);
654

Christian Schäfer's avatar
Christian Schäfer committed
655
656
657
/* 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
658
   unops are: Minus, Abs, Not, Conv, Cast
Christian Schäfer's avatar
Christian Schäfer committed
659
660
   binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
   Shr, Shrs, Rot, Cmp */
661
int      is_unop(const ir_node *node);
662
ir_node *get_unop_op(const ir_node *node);
663
664
void     set_unop_op(ir_node *node, ir_node *op);
int      is_binop(const ir_node *node);
665
ir_node *get_binop_left(const ir_node *node);
666
void     set_binop_left(ir_node *node, ir_node *left);
667
ir_node *get_binop_right(const ir_node *node);
668
669
void     set_binop_right(ir_node *node, ir_node *right);

670
ir_node *get_Add_left(const ir_node *node);
671
void     set_Add_left(ir_node *node, ir_node *left);
672
ir_node *get_Add_right(const ir_node *node);
673
674
void     set_Add_right(ir_node *node, ir_node *right);

675
ir_node *get_Sub_left(const ir_node *node);
676
void     set_Sub_left(ir_node *node, ir_node *left);
677
ir_node *get_Sub_right(const ir_node *node);
678
679
void     set_Sub_right(ir_node *node, ir_node *right);

680
ir_node *get_Minus_op(const ir_node *node);
681
682
void     set_Minus_op(ir_node *node, ir_node *op);

683
ir_node *get_Mul_left(const ir_node *node);
684
void     set_Mul_left(ir_node *node, ir_node *left);
685
ir_node *get_Mul_right(const ir_node *node);
686
687
void     set_Mul_right(ir_node *node, ir_node *right);

688
ir_node *get_Quot_left(const ir_node *node);
689
void     set_Quot_left(ir_node *node, ir_node *left);
690
ir_node *get_Quot_right(const ir_node *node);
691
692
693
void     set_Quot_right(ir_node *node, ir_node *right);
ir_node *get_Quot_mem(ir_node *node);
void     set_Quot_mem(ir_node *node, ir_node *mem);
694
695
ir_mode *get_Quot_resmode(const ir_node *node);
void     set_Quot_resmode(ir_node *node, ir_mode *mode);
696

697
698
699
/**
 * Projection numbers for Quot: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
700
typedef enum {
701
702
  pn_Quot_M,           /**< Memory result. */
  pn_Quot_X_regular,   /**< Execution result if no exception occurred. */
Michael Beck's avatar
Michael Beck committed
703
  pn_Quot_X_except,    /**< Execution result if exception occurred. */
704
705
  pn_Quot_res,         /**< Result of computation. */
  pn_Quot_max          /**< number of projections from a Quot */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
706
707
} pn_Quot;  /* Projection numbers for Quot. */

708
ir_node *get_DivMod_left(const ir_node *node);
709
void     set_DivMod_left(ir_node *node, ir_node *left);
710
ir_node *get_DivMod_right(const ir_node *node);
711
712
713
void     set_DivMod_right(ir_node *node, ir_node *right);
ir_node *get_DivMod_mem(ir_node *node);
void     set_DivMod_mem(ir_node *node, ir_node *mem);
714
715
ir_mode *get_DivMod_resmode(const ir_node *node);
void     set_DivMod_resmode(ir_node *node, ir_mode *mode);
716

717
718
719
/**
 * Projection numbers for DivMod: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
720
typedef enum {
721
722
  pn_DivMod_M,           /**< Memory result. */
  pn_DivMod_X_regular,   /**< Execution result if no exception occurred. */
Michael Beck's avatar
Michael Beck committed
723
  pn_DivMod_X_except,    /**< Execution result if exception occurred. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
724
  pn_DivMod_res_div,     /**< Result of computation a / b. */
725
726
  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
727
728
} pn_DivMod;  /* Projection numbers for DivMod. */

729
ir_node *get_Div_left(const ir_node *node);
730
void     set_Div_left(ir_node *node, ir_node *left);
731
ir_node *get_Div_right(const ir_node *node);
732
733
734
void     set_Div_right(ir_node *node, ir_node *right);
ir_node *get_Div_mem(ir_node *node);
void     set_Div_mem(ir_node *node, ir_node *mem);
735
736
ir_mode *get_Div_resmode(const ir_node *node);
void     set_Div_resmode(ir_node *node, ir_mode *mode);
737

738
739
740
/**
 * Projection numbers for Div: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
741
typedef enum {
742
743
  pn_Div_M,           /**< Memory result. */
  pn_Div_X_regular,   /**< Execution result if no exception occurred. */
Michael Beck's avatar
Michael Beck committed
744
  pn_Div_X_except,    /**< Execution result if exception occurred. */
Rubino Geiß's avatar
typo    
Rubino Geiß committed
745
  pn_Div_res,         /**< Result of computation. */
Rubino Geiß's avatar
Rubino Geiß committed
746
  pn_Div_max          /**< number of projections from a Div */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
747
748
} pn_Div;  /* Projection numbers for Div. */

749
ir_node *get_Mod_left(const ir_node *node);
750
void     set_Mod_left(ir_node *node, ir_node *left);
751
ir_node *get_Mod_right(const ir_node *node);
752
753
754
void     set_Mod_right(ir_node *node, ir_node *right);
ir_node *get_Mod_mem(ir_node *node);
void     set_Mod_mem(ir_node *node, ir_node *mem);
755
756
ir_mode *get_Mod_resmode(const ir_node *node);
void     set_Mod_resmode(ir_node *node, ir_mode *mode);
757

758
759
760
/**
 * Projection numbers for Mod: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
761
762
typedef enum {
  pn_Mod_M,           /**< Memory result.    */
763
  pn_Mod_X_regular,   /**< Execution result if no exception occurred. */
Michael Beck's avatar
Michael Beck committed
764
  pn_Mod_X_except,    /**< Execution result if exception occurred. */
765
766
  pn_Mod_res,         /**< Result of computation. */
  pn_Mod_max          /**< number of projections from a Mod */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
767
768
} pn_Mod;  /* Projection numbers for Mod. */

769
ir_node *get_Abs_op(const ir_node *node);
770
void     set_Abs_op(ir_node *node, ir_node *op);
771

772
ir_node *get_And_left(const ir_node *node);
773
void     set_And_left(ir_node *node, ir_node *left);
774
ir_node *get_And_right(const ir_node *node);
775
void     set_And_right(ir_node *node, ir_node *right);
776

777
ir_node *get_Or_left(const ir_node *node);
778
void     set_Or_left(ir_node *node, ir_node *left);
779
ir_node *get_Or_right(const ir_node *node);
780
void     set_Or_right(ir_node *node, ir_node *right);
781

782
ir_node *get_Eor_left(const ir_node *node);
783
void     set_Eor_left(ir_node *node, ir_node *left);
784
ir_node *get_Eor_right(const ir_node *node);
785
void     set_Eor_right(ir_node *node, ir_node *right);
786

787
ir_node *get_Not_op(const ir_node *node);
788
void     set_Not_op(ir_node *node, ir_node *op);
Christian Schäfer's avatar
Christian Schäfer committed
789

790
791
/**
 * Projection numbers for Cmp are defined several times.
792
 * The bit patterns are used for various tests, so don't change.
793
794
 * The "unordered" values are possible results of comparing
 * floating point numbers.
Michael Beck's avatar
Michael Beck committed
795
 * Note that the encoding is imported, so do NOT change the order.
796
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
797
typedef enum {
Michael Beck's avatar
Michael Beck committed
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
  pn_Cmp_False = 0,                             /**< false */
  pn_Cmp_Eq    = 1,                             /**< equal */
  pn_Cmp_Lt    = 2,                             /**< less */
  pn_Cmp_Le    = pn_Cmp_Eq|pn_Cmp_Lt,           /**< less or equal */
  pn_Cmp_Gt    = 4,                             /**< greater */
  pn_Cmp_Ge    = pn_Cmp_Eq|pn_Cmp_Gt,           /**< greater or equal */
  pn_Cmp_Lg    = pn_Cmp_Lt|pn_Cmp_Gt,           /**< less or greater */
  pn_Cmp_Leg   = pn_Cmp_Lt|pn_Cmp_Eq|pn_Cmp_Gt, /**< less, equal or greater = ordered */
  pn_Cmp_Uo    = 8,                             /**< unordered */
  pn_Cmp_Ue    = pn_Cmp_Uo|pn_Cmp_Eq,           /**< unordered or equal */
  pn_Cmp_Ul    = pn_Cmp_Uo|pn_Cmp_Lt,           /**< unordered or less */
  pn_Cmp_Ule   = pn_Cmp_Uo|pn_Cmp_Eq|pn_Cmp_Lt, /**< unordered, less or equal */
  pn_Cmp_Ug    = pn_Cmp_Uo|pn_Cmp_Gt,           /**< unordered or greater */
  pn_Cmp_Uge   = pn_Cmp_Uo|pn_Cmp_Eq|pn_Cmp_Gt, /**< unordered, greater or equal */
  pn_Cmp_Ne    = pn_Cmp_Uo|pn_Cmp_Lt|pn_Cmp_Gt, /**< unordered, less or greater = not equal */
  pn_Cmp_True  = 15                             /**< true */
814
  /* not_mask = Leg*/   /* bits to flip to negate comparison * @@ hack for JNI interface */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
815
} pn_Cmp;   /* Projection numbers for Cmp */
816
/* #define not_mask pn_Cmp_Leg */
817

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

821
/** Calculates the negated (Complement(R)) pnc condition. */
822
int         get_negated_pnc(int pnc, ir_mode *mode);
Michael Beck's avatar
Michael Beck committed
823

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

827
ir_node *get_Cmp_left(const ir_node *node);
828
void     set_Cmp_left(ir_node *node, ir_node *left);
829
ir_node *get_Cmp_right(const ir_node *node);
830
void     set_Cmp_right(ir_node *node, ir_node *right);
831

832
ir_node *get_Shl_left(const ir_node *node);
833
void     set_Shl_left(ir_node *node, ir_node *left);
834
ir_node *get_Shl_right(const ir_node *node);
835
void     set_Shl_right(ir_node *node, ir_node *right);
836

837
ir_node *get_Shr_left(const ir_node *node);
838
void     set_Shr_left(ir_node *node, ir_node *left);
839
ir_node *get_Shr_right(const ir_node *node);
840
void     set_Shr_right(ir_node *node, ir_node *right);
841

842
ir_node *get_Shrs_left(const ir_node *node);
843
void     set_Shrs_left(ir_node *node, ir_node *left);
844
ir_node *get_Shrs_right(const ir_node *node);
845
void     set_Shrs_right(ir_node *node, ir_node *right);
846

847
ir_node *get_Rot_left(const ir_node *node);
848
void     set_Rot_left(ir_node *node, ir_node *left);
849
ir_node *get_Rot_right(const ir_node *node);
850
void     set_Rot_right(ir_node *node, ir_node *right);
851

852
ir_node *get_Conv_op(const ir_node *node);
853
854
855
void     set_Conv_op(ir_node *node, ir_node *op);
int      get_Conv_strict(ir_node *node);
void     set_Conv_strict(ir_node *node, int flag);
856

Götz Lindenmaier's avatar
comment    
Götz Lindenmaier committed
857
858
/* Does Cast need a mem operator?
 * Cast should only depend on the type, not on the state of an
Michael Beck's avatar
Michael Beck committed
859
 * entity.  But:  we initialize various fields after Alloc, that
Götz Lindenmaier's avatar
comment    
Götz Lindenmaier committed
860
861
862
 * are accessed in the cast.  This required some precaution, to
 * get the right memory into the Loads generated from the cast.
 */
863
ir_node *get_Cast_op(const ir_node *node);