irnode.h 39.7 KB
Newer Older
Götz Lindenmaier's avatar
Götz Lindenmaier committed
1
2
3
4
5
6
7
8
9
10
/*
 * Project:     libFIRM
 * File name:   ir/ir/irnode.h
 * Purpose:     Representation of an intermediate operation.
 * Author:      Martin Trapp, Christian Schaefer
 * Modified by: Goetz Lindenmaier
 * Created:
 * CVS-ID:      $Id$
 * Copyright:   (c) 1998-2003 Universität Karlsruhe
 * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
Michael Beck's avatar
Michael Beck committed
11
12
 */

Christian Schäfer's avatar
Christian Schäfer committed
13
14
15
# ifndef _IRNODE_H_
# define _IRNODE_H_

16
17
#include <stddef.h>

18
19
20
21
/**
 * Projection numbers of compare: use for Proj nodes!
 * @remark there are numbers with normalized names below!
 */
22
typedef enum {
23
  False = 0,    /**< false */
Florian Liekweg's avatar
Florian Liekweg committed
24
25
26
27
28
29
30
31
32
33
34
35
36
37
  Eq,           /**< equal */
  Lt,           /**< less */
  Le,           /**< less or equal */
  Gt,           /**< greater */
  Ge,           /**< greater or equal */
  Lg,           /**< less or greater */
  Leg = 7,      /**< less, equal or greater = ordered */
  Uo,           /**< unordered */
  Ue,           /**< unordered or equal */
  Ul,           /**< unordered or less */
  Ule,          /**< unordered, less or equal */
  Ug,           /**< unordered or greater */
  Uge,          /**< unordered, greater or equal */
  Ne,           /**< unordered, less or greater = not equal */
38
  True = 15     /**< true */
Florian Liekweg's avatar
Florian Liekweg committed
39
  /* not_mask = Leg*/   /* bits to flip to negate comparison * @@ hack for jni interface */
40
} pnc_number;   /* pnc: Projection Number Cmp */
41
42
43
#define not_mask Leg

# include "tv.h"
Christian Schäfer's avatar
Christian Schäfer committed
44
# include "irgraph.h"
Christian Schäfer's avatar
Christian Schäfer committed
45
# include "entity.h"
46
# include "firm_common.h"
Christian Schäfer's avatar
Christian Schäfer committed
47
48
49
# include "irop.h"
# include "irmode.h"
# include "type.h"
Götz Lindenmaier's avatar
Götz Lindenmaier committed
50
# include "dbginfo.h"
51
/* # include "exc.h" */
Christian Schäfer's avatar
Christian Schäfer committed
52

Michael Beck's avatar
Michael Beck committed
53
54
/**
 * @file irnode.h
Götz Lindenmaier's avatar
Götz Lindenmaier committed
55
 *
Michael Beck's avatar
Michael Beck committed
56
 * @author Martin Trapp, Christian Schaefer
Götz Lindenmaier's avatar
Götz Lindenmaier committed
57
 *
Michael Beck's avatar
Michael Beck committed
58
59
60
61
62
63
 * Declarations of an ir node.
 */

/**
 * @defgroup ir_node Declarations of an ir node.
 *
64
 * The type definition of ir_node is also in irgraph.h to resolve
Michael Beck's avatar
Michael Beck committed
65
 *  recursion between irnode.h and irgraph.h
Götz Lindenmaier's avatar
Götz Lindenmaier committed
66
 *
Michael Beck's avatar
Michael Beck committed
67
 * ir_node - a datatype representing a Firm node
Götz Lindenmaier's avatar
Götz Lindenmaier committed
68
 *
Michael Beck's avatar
Michael Beck committed
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 *  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
84
 */
Michael Beck's avatar
Michael Beck committed
85

Götz Lindenmaier's avatar
Götz Lindenmaier committed
86
87
#ifndef _IR_NODE_TYPEDEF_
#define _IR_NODE_TYPEDEF_
Christian Schäfer's avatar
Christian Schäfer committed
88
89
90
typedef struct ir_node ir_node;
#endif

Hannes Jakschitsch's avatar
Hannes Jakschitsch committed
91
#ifdef __cplusplus
Götz Lindenmaier's avatar
Götz Lindenmaier committed
92
extern "C" {
Hannes Jakschitsch's avatar
Hannes Jakschitsch committed
93
94
#endif

Sebastian Felis's avatar
Sebastian Felis committed
95
/**
Michael Beck's avatar
Michael Beck committed
96
97
98
 *   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
99

Sebastian Felis's avatar
Sebastian Felis committed
100
101
102
/**
 *   Checks whether a pointer points to a ir node.
 *
103
104
 *   @param thing   an arbitrary pointer
 *   @return        non-zero if the thing is a ir mode, else zero
Sebastian Felis's avatar
Sebastian Felis committed
105
 */
106
int is_ir_node (const void *thing);
Sebastian Felis's avatar
Sebastian Felis committed
107

108
109
110
111
112
113
/**
 * Returns the number of predecessors without the block predecessor.
 *
 * @param node   the IR-node
 */
int           get_irn_arity         (const ir_node *node);
114
115
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
116
117

/** Replaces the old in array by a new one that will contain the ins given in
118
   the parameters.  Conserves the block predecessor.  It copies the array passed.
119
   This function is necessary to adjust in arrays of blocks, calls and phis.
120
   Assumes that current_ir_graph is set to the graph containing "node".
121
122
   "in" must contain all predecessors except the block that are required for
   the nodes opcode. */
123
void          set_irn_in            (ir_node *node, int arity,
Florian Liekweg's avatar
Florian Liekweg committed
124
                        ir_node *in[]);
Christian Schäfer's avatar
Christian Schäfer committed
125
126
127
/* 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
128
   to iterate including the Block predecessor iterate from i = -1 to
Christian Schäfer's avatar
Christian Schäfer committed
129
   i < get_irn_arity. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
130
/* Access predecessor n */
131
132
133
134
135

/**
 * Get the n-th predecessor of a node.
 * This function removes Id predecessors.
 */
Sebastian Hack's avatar
Sebastian Hack committed
136
137
138
ir_node      *get_irn_n             (const ir_node *node, int n);
ir_node      *get_irn_intra_n       (const ir_node *node, int n);
ir_node      *get_irn_inter_n       (const ir_node *node, int n);
139
140

/** Replace the n-th predecessor of a node with a new one. */
141
void          set_irn_n             (ir_node *node, int n, ir_node *in);
142
/* Sets the mode struct of node.  */
143
void          set_irn_mode (ir_node *node, ir_mode *mode);
144
/** Gets the mode struct of a node.  */
145
ir_mode      *get_irn_mode          (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
146
/** Gets the mode-enum modecode. */
147
modecode      get_irn_modecode      (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
148
/** Gets the ident for a string representation of the mode .*/
149
ident        *get_irn_modeident     (const ir_node *node);
150
/** Gets the string representation of the mode .*/
151
const char   *get_irn_modename      (const ir_node *node);
152
/** Gets the opcode struct of the node. */
153
ir_op        *get_irn_op            (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
154
/** Sets the opcode struct of the node. */
155
void          set_irn_op            (ir_node *node, ir_op *op);
Michael Beck's avatar
Michael Beck committed
156
/** Gets the opcode-enum of the node. */
157
opcode        get_irn_opcode        (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
158
/** Get the string representation of the opcode. */
159
const char   *get_irn_opname        (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
160
/** Get the ident for a string representation of the opcode. */
161
ident        *get_irn_opident       (const ir_node *node);
162
/** Gets the visited counter of a node. */
163
unsigned long get_irn_visited (const ir_node *node);
164
/** Sets the visited counter of a node. */
165
void          set_irn_visited (ir_node *node, unsigned long visited);
Michael Beck's avatar
Michael Beck committed
166
/** Sets visited to get_irg_visited(current_ir_graph). */
167
void          mark_irn_visited (ir_node *node);
168
/** Returns 1 if visited < get_irg_visited(current_ir_graph). */
169
int           irn_not_visited  (const ir_node *node);
170
/** Returns 1 if visited >= get_irg_visited(current_ir_graph). */
171
int           irn_visited      (const ir_node *node);
172
173
174
175
176

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

/** Returns the link of a node.  */
180
void         *get_irn_link     (const ir_node *node);
181
182

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

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

Michael Beck's avatar
Michael Beck committed
191
192
193
194
195
/** Returns the pinned state of a node. */
op_pin_state get_irn_pinned    (const ir_node *node);

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

Michael Beck's avatar
Michael Beck committed
197
198
199
200
/**
 * irnode constructor.
 * Create a new irnode in irg, with an op, mode, arity and
 * some incoming irnodes.
201
202
203
204
205
206
207
208
 * This constructor is used in every specified irnode constructor.
 *
 * @param db    Debug info.
 * @param irg   IR-graph on with this new node should be constructed.
 * @param op    The opcode of the new node.
 * @param mode  The mode of the new node.
 * @param arity The arity of the new node, may be <0 if yet.
 * @param in    An array of arity predecessor nodes.
Michael Beck's avatar
Michael Beck committed
209
 */
210
ir_node *
Götz Lindenmaier's avatar
Götz Lindenmaier committed
211
new_ir_node (dbg_info *db,
Florian Liekweg's avatar
Florian Liekweg committed
212
213
214
215
216
217
         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
218

Götz Lindenmaier's avatar
Götz Lindenmaier committed
219
220
221
222
223
224
225
/** Return the block the node belongs to.
 *
 * 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_block. */
Sebastian Hack's avatar
Sebastian Hack committed
226
ir_node  *get_nodes_block (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
227
228

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

Götz Lindenmaier's avatar
Götz Lindenmaier committed
231
/**
Michael Beck's avatar
Michael Beck committed
232
 * @function get_irn_block()
233
 * @see get_nodes_block()
Götz Lindenmaier's avatar
Götz Lindenmaier committed
234
 */
235
236
237
238
/**
 * Projection numbers for result of Start node: use for Proj nodes!
 */
typedef enum {
239
240
241
242
243
244
245
246
247
  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
                                  containing _all_ global entities. */
  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 */
248
249
} pn_Start; /* Projection numbers for Start. */

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

251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
/** 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. */
type *is_frame_pointer(ir_node *n);

/** 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. */
type *is_globals_pointer(ir_node *n);

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

270
/* @@@ no more supported  */
271
ir_node **get_Block_cfgpred_arr (ir_node *node);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
272
int       get_Block_n_cfgpreds (ir_node *node);
273
274
275
276
277
278
ir_node  *get_Block_cfgpred (ir_node *node, int pos);
void      set_Block_cfgpred (ir_node *node, int pos, ir_node *pred);
bool      get_Block_matured (ir_node *node);
void      set_Block_matured (ir_node *node, bool matured);
unsigned long get_Block_block_visited (ir_node *node);
void      set_Block_block_visited (ir_node *node, unsigned long visit);
279
280
281
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
282
/* For this current_ir_graph must be set. */
283
284
void      mark_Block_block_visited(ir_node *node);
int       Block_not_block_visited(ir_node *node);
Christian Schäfer's avatar
Christian Schäfer committed
285

286
287
/* Set and remove interprocedural predecessors. If the interprocedural
 * predecessors are removed, the node has the same predecessors in
288
289
 * both views.
 * @@@ Maybe better:  arity is zero if no cg preds. */
290
291
void      set_Block_cg_cfgpred_arr(ir_node * node, int arity, ir_node ** in);
void      set_Block_cg_cfgpred(ir_node * node, int pos, ir_node * pred);
292
/* @@@ not supported */
293
ir_node **get_Block_cg_cfgpred_arr(ir_node * node);
Michael Beck's avatar
Michael Beck committed
294
/** Returns the number of interprocedural predecessors.  0 if none. */
295
int       get_Block_cg_n_cfgpreds(ir_node * node);
Michael Beck's avatar
Michael Beck committed
296
/** Return the interprocedural predecessor at position pos. */
297
ir_node  *get_Block_cg_cfgpred(ir_node * node, int pos);
298
/* frees the memory. */
299
300
void      remove_Block_cg_cfgpred_arr(ir_node * node);

Michael Beck's avatar
Michael Beck committed
301
/** Return the number of Keep alive node. */
302
int  get_End_n_keepalives(ir_node *end);
Michael Beck's avatar
Michael Beck committed
303
304

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

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

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

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

318

319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
/* 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.
   We differ two flavours of this Cond.  The first, the dense Cond, passes
   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.
   The second Cond flavor differes in the treatment of cases not specified in
   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.
336
337
   The two switch flavors are distinguished by a flag of type cond_kind.
   Default flavor is "dense"
338
339
*/
typedef enum {
Michael Beck's avatar
Michael Beck committed
340
341
  dense,        /**< Default. Missing Proj nodes are dead control flow. */
  fragmentary   /**< Special. No control flow optimizations allowed.  Missing
Florian Liekweg's avatar
Florian Liekweg committed
342
           Proj nodes mean default control flow, i.e., Proj(n). */
343
344
} cond_kind;

345
346
347
348
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);
349
long      get_Cond_defaultProj (ir_node *node);
Christian Schäfer's avatar
Christian Schäfer committed
350

351
352
353
/**
 * Projection numbers for conditions.
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
354
355
typedef enum {
  pn_Cond_false,    /**< Control flow if operand is "false". */
356
357
  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
358
359
} pn_Cond;  /* Projection numbers for Cond. */

360
361
362
363
364
365
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
366

367
368
369
370
ir_node *get_Raise_mem (ir_node *node);
void     set_Raise_mem (ir_node *node, ir_node *mem);
ir_node *get_Raise_exo_ptr (ir_node *node);  /* PoinTeR to EXception Object */
void     set_Raise_exo_ptr (ir_node *node, ir_node *exoptr);
Christian Schäfer's avatar
Christian Schäfer committed
371

372
373
374
/**
 * Projection numbers for Raise.
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
375
376
typedef enum {
  pn_Raise_X,    /**< Execution result. */
377
378
  pn_Raise_M,    /**< Memory result.    */
  pn_Raise_max   /**< number of projections from a Raise */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
379
380
} pn_Raise;  /* Projection numbers for Raise. */

381
382
tarval  *get_Const_tarval (ir_node *node);
void     set_Const_tarval (ir_node *node, tarval *con);
Michael Beck's avatar
Michael Beck committed
383
384
385
386

/** Returns the source language type of a Const node.
 * Must be an atomic type.  Mode of type must be mode of node.
 */
387
type    *get_Const_type   (ir_node *node);
Michael Beck's avatar
Michael Beck committed
388
389

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

Michael Beck's avatar
Michael Beck committed
392
/**  This enum names the three different kinds of symbolic Constants
Götz Lindenmaier's avatar
Götz Lindenmaier committed
393
394
395
396
     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
397
398
399
400
401
402
403
404
405
406
  symconst_type_tag,    /**< The SymConst is a type tag for the given type.
			   Type_or_id_p is type *. */
  symconst_size,        /**< The SymConst is the size of the given type.
			   Type_or_id_p is type *. */
  symconst_addr_name,   /**< The SymConst is a symbolic pointer to be filled in
			   by the linker.  The pointer is represented by a string.
			   Type_or_id_p is ident *. */
  symconst_addr_ent     /**< The SymConst is a symbolic pointer to be filled in
			   by the linker.  The pointer is represented by an entity.
			   Type_or_id_p is entity *. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
407
} symconst_kind;
408

Beyhan's avatar
Beyhan committed
409
410
411
/** SymConst attributes
    This union contains the symbolic information represented by the node  */
union symconst_symbol {
412
413
414
  type   *type_p;
  ident  *ident_p;
  entity *entity_p;
Beyhan's avatar
Beyhan committed
415
};
416

Beyhan's avatar
Beyhan committed
417
418
typedef union symconst_symbol symconst_symbol;

419

Michael Beck's avatar
Michael Beck committed
420
/** Get the kind of the SymConst. */
421
symconst_kind get_SymConst_kind (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
422
/** Set the kind of the SymConst. */
423
void          set_SymConst_kind (ir_node *node, symconst_kind num);
Beyhan's avatar
Beyhan committed
424
425

/** Only to access SymConst of kind type_tag or size.  Else assertion: */
426
427
type    *get_SymConst_type (ir_node *node);
void     set_SymConst_type (ir_node *node, type *tp);
Beyhan's avatar
Beyhan committed
428
429
430
431
432
433
434
435
436
437
438

/** Only to access SymConst of kind addr_name.  Else assertion: */
ident   *get_SymConst_name (ir_node *node);
void     set_SymConst_name (ir_node *node, ident *name);

/** Only to access SymConst of kind addr_ent.  Else assertion: */
entity  *get_SymConst_entity (ir_node *node);
void     set_SymConst_entity (ir_node *node, entity *ent);

/** 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
439
440
441
442
/* write 'union': firmjni then does not create a method... */
union symconst_symbol get_SymConst_symbol (ir_node *node);
void                  set_SymConst_symbol (ir_node *node,
					   union symconst_symbol sym);
443

Götz Lindenmaier's avatar
Götz Lindenmaier committed
444
445
446
447
448
449
/** Access the type of the value represented by the SymConst.
 *
 *  Example: primitive type int for SymConst size. */
type *get_SymConst_value_type (ir_node *node);
void  set_SymConst_value_type (ir_node *node, type *tp);

450
451
452
453
454
455
456
457
458
459
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);
entity  *get_Sel_entity (ir_node *node); /* entity to select */
void     set_Sel_entity (ir_node *node, entity *ent);
Christian Schäfer's avatar
Christian Schäfer committed
460

461
462
463
/**
 * Projection numbers for result of Call node: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
464
465
466
467
typedef enum {
  pn_Call_M_regular = 0,  /**< The memory result. */
  pn_Call_T_result  = 2,  /**< The tuple containing all (0, 1, 2, ...) results */
  pn_Call_P_value_res_base = 4,/**< A pointer to the memory region containing copied results
Florian Liekweg's avatar
Florian Liekweg committed
468
                 passed by value (for compound result types). */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
469
  pn_Call_X_except  = 1,  /**< The control flow result branching to the exception handler */
Michael Beck's avatar
Michael Beck committed
470
  pn_Call_M_except  = 3,  /**< The memory result in case the called method terminated with
Florian Liekweg's avatar
Florian Liekweg committed
471
                 an exception */
472
  pn_Call_max       = 5   /**< number of projections from a Call */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
473
474
} pn_Call;   /* Projection numbers for Call. */

475
476
477
478
479
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
480
/** Gets the number of parameters of a call. */
481
int      get_Call_n_params (ir_node *node);
Michael Beck's avatar
Michael Beck committed
482
/** Gets the call parameter at position pos. */
483
ir_node *get_Call_param (ir_node *node, int pos);
Michael Beck's avatar
Michael Beck committed
484
/** Sets the call parameter at position pos. */
485
void     set_Call_param (ir_node *node, int pos, ir_node *param);
Michael Beck's avatar
Michael Beck committed
486
/** Gets the type of a call. */
487
type    *get_Call_type (ir_node *node);
Michael Beck's avatar
Michael Beck committed
488
/** Sets the type of a call. */
489
void     set_Call_type (ir_node *node, type *tp);
Michael Beck's avatar
Michael Beck committed
490
/** Gets the arity of a call. Identical to get_Call_n_params(). */
491
int      get_Call_arity (ir_node *node);
492

493
494
495
496
/** 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
497
498
499
500
 *  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.
501
502
503
504
505
506
507
508
509
 *
 *  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.
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
510
int     Call_has_callees      (ir_node *node);
511
512
int     get_Call_n_callees    (ir_node *node);
entity *get_Call_callee       (ir_node *node, int pos);
Michael Beck's avatar
Michael Beck committed
513

514
515
516
517
518
/** Set the full callee array.
 *
 *  The passed array is copied. Assumes current_ir_graph set properly! */
void    set_Call_callee_arr   (ir_node *node, const int n, entity **arr);
void    remove_Call_callee_arr(ir_node *node);
519

Götz Lindenmaier's avatar
Götz Lindenmaier committed
520
521
522
523
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);
524

Christian Schäfer's avatar
Christian Schäfer committed
525
526
527
/* 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
528
   unops are: Minus, Abs, Not, Conv, Cast
Christian Schäfer's avatar
Christian Schäfer committed
529
530
   binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
   Shr, Shrs, Rot, Cmp */
Michael Beck's avatar
Michael Beck committed
531
int      is_unop (const ir_node *node);
532
533
ir_node *get_unop_op (ir_node *node);
void     set_unop_op (ir_node *node, ir_node *op);
Michael Beck's avatar
Michael Beck committed
534
int      is_binop (const ir_node *node);
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
ir_node *get_binop_left (ir_node *node);
void     set_binop_left (ir_node *node, ir_node *left);
ir_node *get_binop_right (ir_node *node);
void     set_binop_right (ir_node *node, ir_node *right);

ir_node *get_Add_left (ir_node *node);
void     set_Add_left (ir_node *node, ir_node *left);
ir_node *get_Add_right (ir_node *node);
void     set_Add_right (ir_node *node, ir_node *right);

ir_node *get_Sub_left (ir_node *node);
void     set_Sub_left (ir_node *node, ir_node *left);
ir_node *get_Sub_right (ir_node *node);
void     set_Sub_right (ir_node *node, ir_node *right);

ir_node *get_Minus_op (ir_node *node);
void     set_Minus_op (ir_node *node, ir_node *op);

ir_node *get_Mul_left (ir_node *node);
void     set_Mul_left (ir_node *node, ir_node *left);
ir_node *get_Mul_right (ir_node *node);
void     set_Mul_right (ir_node *node, ir_node *right);

ir_node *get_Quot_left (ir_node *node);
void     set_Quot_left (ir_node *node, ir_node *left);
ir_node *get_Quot_right (ir_node *node);
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);
564

565
566
567
/**
 * Projection numbers for Quot: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
568
569
typedef enum {
  pn_Quot_M,           /**< Memory result.    */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
570
  pn_Quot_X_except,    /**< Execution result if exception occured. */
571
572
  pn_Quot_res,         /**< Result of computation. */
  pn_Quot_max          /**< number of projections from a Quot */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
573
574
} pn_Quot;  /* Projection numbers for Quot. */

575
576
577
578
579
580
ir_node *get_DivMod_left (ir_node *node);
void     set_DivMod_left (ir_node *node, ir_node *left);
ir_node *get_DivMod_right (ir_node *node);
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);
581

582
583
584
/**
 * Projection numbers for DivMod: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
585
586
typedef enum {
  pn_DivMod_M,           /**< Memory result.    */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
587
  pn_DivMod_X_except,    /**< Execution result if exception occured. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
588
  pn_DivMod_res_div,     /**< Result of computation a / b. */
589
590
  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
591
592
} pn_DivMod;  /* Projection numbers for DivMod. */

593
594
595
596
597
598
ir_node *get_Div_left (ir_node *node);
void     set_Div_left (ir_node *node, ir_node *left);
ir_node *get_Div_right (ir_node *node);
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);
599

600
601
602
/**
 * Projection numbers for Div: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
603
604
typedef enum {
  pn_Div_M,           /**< Memory result.    */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
605
  pn_Div_X_except,    /**< Execution result if exception occured. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
606
607
608
  pn_Div_res          /**< Result of computation. */
} pn_Div;  /* Projection numbers for Div. */

609
610
611
612
613
614
ir_node *get_Mod_left (ir_node *node);
void     set_Mod_left (ir_node *node, ir_node *left);
ir_node *get_Mod_right (ir_node *node);
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);
615

616
617
618
/**
 * Projection numbers for Mod: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
619
620
typedef enum {
  pn_Mod_M,           /**< Memory result.    */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
621
  pn_Mod_X_except,    /**< Execution result if exception occured. */
622
623
  pn_Mod_res,         /**< Result of computation. */
  pn_Mod_max          /**< number of projections from a Mod */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
624
625
} pn_Mod;  /* Projection numbers for Mod. */

626
627
ir_node *get_Abs_op (ir_node *node);
void     set_Abs_op (ir_node *node, ir_node *op);
628

629
630
631
632
ir_node *get_And_left (ir_node *node);
void     set_And_left (ir_node *node, ir_node *left);
ir_node *get_And_right (ir_node *node);
void     set_And_right (ir_node *node, ir_node *right);
633

634
635
636
637
ir_node *get_Or_left (ir_node *node);
void     set_Or_left (ir_node *node, ir_node *left);
ir_node *get_Or_right (ir_node *node);
void     set_Or_right (ir_node *node, ir_node *right);
638

639
640
641
642
ir_node *get_Eor_left (ir_node *node);
void     set_Eor_left (ir_node *node, ir_node *left);
ir_node *get_Eor_right (ir_node *node);
void     set_Eor_right (ir_node *node, ir_node *right);
643

644
645
ir_node *get_Not_op (ir_node *node);
void     set_Not_op (ir_node *node, ir_node *op);
Christian Schäfer's avatar
Christian Schäfer committed
646

647
648
/**
 * Projection numbers for Cmp are defined several times.
649
 * The bit patterns are used for various tests, so don't change.
650
651
 * The "unordered" values are possible results of comparing
 * floating point numbers.
Michael Beck's avatar
Michael Beck committed
652
 * Note that the encoding is imported, so do NOT change the order.
653
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
654
typedef enum {
Michael Beck's avatar
Michael Beck committed
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
  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 */
Florian Liekweg's avatar
Florian Liekweg committed
671
  /* not_mask = Leg*/   /* bits to flip to negate comparison * @@ hack for jni interface */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
672
} pn_Cmp;   /* Projection numbers for Cmp */
673
/* #define not_mask pn_Cmp_Leg */
674

675
676
677
678
679
680
const char *get_pnc_string(int pnc);
int         get_negated_pnc(int pnc);
ir_node *get_Cmp_left (ir_node *node);
void     set_Cmp_left (ir_node *node, ir_node *left);
ir_node *get_Cmp_right (ir_node *node);
void     set_Cmp_right (ir_node *node, ir_node *right);
681

682
683
684
685
ir_node *get_Shl_left (ir_node *node);
void     set_Shl_left (ir_node *node, ir_node *left);
ir_node *get_Shl_right (ir_node *node);
void     set_Shl_right (ir_node *node, ir_node *right);
686

687
688
689
690
ir_node *get_Shr_left (ir_node *node);
void     set_Shr_left (ir_node *node, ir_node *left);
ir_node *get_Shr_right (ir_node *node);
void     set_Shr_right (ir_node *node, ir_node *right);
691

692
693
694
695
ir_node *get_Shrs_left (ir_node *node);
void     set_Shrs_left (ir_node *node, ir_node *left);
ir_node *get_Shrs_right (ir_node *node);
void     set_Shrs_right (ir_node *node, ir_node *right);
696

697
698
699
700
ir_node *get_Rot_left (ir_node *node);
void     set_Rot_left (ir_node *node, ir_node *left);
ir_node *get_Rot_right (ir_node *node);
void     set_Rot_right (ir_node *node, ir_node *right);
701

702
703
ir_node *get_Conv_op (ir_node *node);
void     set_Conv_op (ir_node *node, ir_node *op);
704

Götz Lindenmaier's avatar
comment    
Götz Lindenmaier committed
705
706
/* Does Cast need a mem operator?
 * Cast should only depend on the type, not on the state of an
707
 * entity.  But:  we initialze various fields after Alloc, that
Götz Lindenmaier's avatar
comment    
Götz Lindenmaier committed
708
709
710
 * are accessed in the cast.  This required some precaution, to
 * get the right memory into the Loads generated from the cast.
 */
711
712
713
714
ir_node *get_Cast_op (ir_node *node);
void     set_Cast_op (ir_node *node, ir_node *op);
type    *get_Cast_type (ir_node *node);
void     set_Cast_type (ir_node *node, type *to_tp);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
715

Götz Lindenmaier's avatar
Götz Lindenmaier committed
716
717
718
/** Returns true if n is Phi or Filter in interprocedural_view.
   Returns false if irg in phase building and the Phi has zero
   predecessors: it's a Phi0. */
Sebastian Hack's avatar
Sebastian Hack committed
719
int       is_Phi (const ir_node *n);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
720
721
/** Returns true  if irg in phase building and the Phi has zero
   predecessors: it's a Phi0. */
Sebastian Hack's avatar
Sebastian Hack committed
722
int       is_Phi0 (const ir_node *n);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
723
/* These routines also work for Filter nodes in interprocedural view. */
724
725
726
727
728
729
730
731
732
ir_node **get_Phi_preds_arr (ir_node *node);
int       get_Phi_n_preds (ir_node *node);
ir_node  *get_Phi_pred (ir_node *node, int pos);
void      set_Phi_pred (ir_node *node, int pos, ir_node *pred);

ir_node  *get_Filter_pred(ir_node *node);
void      set_Filter_pred(ir_node *node, ir_node *pred);
long      get_Filter_proj(ir_node *node);
void      set_Filter_proj(ir_node *node, long proj);
733
734
/* set the interprocedural predecessors, ...d_arr uses current_ir_graph.
 * @@@ Maybe better:  arity is zero if no cg preds. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
735
736
737
738
void     set_Filter_cg_pred_arr(ir_node * node, int arity, ir_node ** in);
void     set_Filter_cg_pred(ir_node * node, int pos, ir_node * pred);
int      get_Filter_n_cg_preds(ir_node *node);
ir_node *get_Filter_cg_pred(ir_node *node, int pos);
739

740
741
/** Return true if parameter is a memory operation.
 *
Götz Lindenmaier's avatar
Götz Lindenmaier committed
742
 *  A memory operation is an operation that changes the
743
744
745
746
747
748
749
750
 *  memory.  I.e., a Load or a Store operation.
 */
int is_memop(ir_node *node);
ir_node *get_memop_mem (ir_node *node);
void     set_memop_mem (ir_node *node, ir_node *mem);
ir_node *get_memop_ptr (ir_node *node);
void     set_memop_ptr (ir_node *node, ir_node *ptr);

751
752
753
/**
 * Projection numbers for Load: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
754
755
typedef enum {
  pn_Load_M,         /**< Memory result.    */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
756
  pn_Load_X_except,  /**< Execution result if exception occured. */
757
758
  pn_Load_res,       /**< Result of load operation. */
  pn_Load_max        /**< number of projections from a Load */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
759
760
} pn_Load;  /* Projection numbers for Load. */

761
762
763
764
765
766
ir_node       *get_Load_mem (ir_node *node);
void           set_Load_mem (ir_node *node, ir_node *mem);
ir_node       *get_Load_ptr (ir_node *node);
void           set_Load_ptr (ir_node *node, ir_node *ptr);
ir_mode       *get_Load_mode (ir_node *node);
void           set_Load_mode (ir_node *node, ir_mode *mode);
Michael Beck's avatar
Michael Beck committed
767
768
ent_volatility get_Load_volatility (ir_node *node);
void           set_Load_volatility (ir_node *node, ent_volatility volatility);
769

770
771
772
/**
 * Projection numbers for Store: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
773
typedef enum {
Götz Lindenmaier's avatar
Götz Lindenmaier committed
774
  pn_Store_M,         /**< Memory result.    */
775
776
  pn_Store_X_except,  /**< Execution result if exception occured. */
  pn_Store_max        /**< number of projections from a Store */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
777
778
} pn_Store;  /* Projection numbers for Store. */

779
780
781
782
783
784
785
786
ir_node       *get_Store_mem (ir_node *node);
void           set_Store_mem (ir_node *node, ir_node *mem);
ir_node       *get_Store_ptr (ir_node *node);
void           set_Store_ptr (ir_node *node, ir_node *ptr);
ir_node       *get_Store_value (ir_node *node);
void           set_Store_value (ir_node *node, ir_node *value);
ent_volatility get_Store_volatility (ir_node *node);
void           set_Store_volatility (ir_node *node, ent_volatility volatility);
787

788
789
790
/**
 * Projection numbers for Alloc: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
791
typedef enum {
792
793
794
795
  pn_Alloc_M,          /**< Memory result. */
  pn_Alloc_X_except,  /**< Execution result if exception occured. */
  pn_Alloc_res,       /**< Result of allocation. */
  pn_Alloc_max        /**< number of projections from an Alloc */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
796
797
} pn_Alloc;  /* Projection numbers for Alloc. */

798
799
800
801
802
803
ir_node *get_Alloc_mem (ir_node *node);
void     set_Alloc_mem (ir_node *node, ir_node *mem);
ir_node *get_Alloc_size (ir_node *node);
void     set_Alloc_size (ir_node *node, ir_node *size);
type    *get_Alloc_type (ir_node *node);
void     set_Alloc_type (ir_node *node, type *tp);
Michael Beck's avatar
Michael Beck committed
804

805
/** The allocation place. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
806
typedef enum {
Michael Beck's avatar
Michael Beck committed
807
808
  stack_alloc,          /**< Alloc allocates the object on the stack. */
  heap_alloc            /**< Alloc allocates the object on the heap. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
809
} where_alloc;
Michael Beck's avatar
Michael Beck committed
810

811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
where_alloc  get_Alloc_where (ir_node *node);
void         set_Alloc_where (ir_node *node, where_alloc where);

ir_node *get_Free_mem (ir_node *node);
void     set_Free_mem (ir_node *node, ir_node *mem);
ir_node *get_Free_ptr (ir_node *node);
void     set_Free_ptr (ir_node *node, ir_node *ptr);
ir_node *get_Free_size (ir_node *node);
void     set_Free_size (ir_node *node, ir_node *size);
type    *get_Free_type (ir_node *node);
void     set_Free_type (ir_node *node, type *tp);

ir_node **get_Sync_preds_arr (ir_node *node);
int       get_Sync_n_preds (ir_node *node);
ir_node  *get_Sync_pred (ir_node *node, int pos);
void      set_Sync_pred (ir_node *node, int pos, ir_node *pred);

ir_node  *get_Proj_pred (ir_node *node);
void      set_Proj_pred (ir_node *node, ir_node *pred);
long      get_Proj_proj (ir_node *node);
void      set_Proj_proj (ir_node *node, long proj);
832

833
834
835
836
ir_node **get_Tuple_preds_arr (ir_node *node);
int       get_Tuple_n_preds (ir_node *node);
ir_node  *get_Tuple_pred (ir_node *node, int pos);
void      set_Tuple_pred (ir_node *node, int pos, ir_node *pred);
837

838
839
ir_node  *get_Id_pred (ir_node *node);
void      set_Id_pred (ir_node *node, ir_node *pred);
840

Götz Lindenmaier's avatar
Götz Lindenmaier committed
841
842
843
/** Confirm has a single result and returns 'value' unchanged.
 *  The node expresses a restriction on 'value':
 *  'value' 'cmp' 'bound' == true.                                 */
844
845
846
847
848
849
ir_node *get_Confirm_value (ir_node *node);
void     set_Confirm_value (ir_node *node, ir_node *value);
ir_node *get_Confirm_bound (ir_node *node);
void     set_Confirm_bound (ir_node *node, ir_node *bound);
pn_Cmp   get_Confirm_cmp   (ir_node *node);
void     set_Confirm_cmp   (ir_node *node, pn_Cmp cmp);
Christian Schäfer's avatar
Christian Schäfer committed
850

Michael Beck's avatar
Michael Beck committed
851
/*
Götz Lindenmaier's avatar
Götz Lindenmaier committed
852
853
854
 *
 * NAME Auxiliary routines
 *
Sebastian Felis's avatar
Sebastian Felis committed
855
 *  Not properly documented ;-)
Götz Lindenmaier's avatar
Götz Lindenmaier committed
856
857
 *
 */
Christian Schäfer's avatar
Christian Schäfer committed
858

Michael Beck's avatar
Michael Beck committed
859
/** returns operand of node if node is a Proj. */
860
ir_node *skip_Proj (ir_node *node);
Michael Beck's avatar
Michael Beck committed
861
/** returns operand of node if node is a Id */
862
ir_node *skip_Id  (ir_node *node);   /* Same as skip_nop. */
863
864
/* returns corresponding operand of Tuple if node is a Proj from
   a Tuple. */
865
ir_node *skip_Tuple (ir_node *node);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
866
867
/** returns operand of node if node is a Cast */
ir_node *skip_Cast  (ir_node *node);
Michael Beck's avatar
Michael Beck committed
868
/** returns true if node is a Bad node. */
Michael Beck's avatar
Michael Beck committed
869
int      is_Bad    (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
870
/** returns true if the node is not a Block */
Michael Beck's avatar
Michael Beck committed
871
int      is_no_Block (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
872
/** returns true if the node is a Block */
Michael Beck's avatar
Michael Beck committed
873
int      is_Block (const ir_node *node);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
874
/** returns true if node is a Unknown node. */
Michael Beck's avatar
Michael Beck committed
875
int      is_Unknown (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
876
/** returns true if node is a Proj node or a Filter node in
877
 * intraprocedural view */
878
int      is_Proj (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
879
/** Returns true if the operation manipulates control flow:
880
   Start, End, Jmp, Cond, Return, Raise, Bad, CallBegin, EndReg, EndExcept */
Michael Beck's avatar
Michael Beck committed
881
int is_cfop(const ir_node *node);
882

Michael Beck's avatar
Michael Beck committed
883
/** Returns true if the operation manipulates interprocedural control flow:
884
    CallBegin, EndReg, EndExcept */
Michael Beck's avatar
Michael Beck committed
885
int is_ip_cfop(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
886
/** Returns true if the operation can change the control flow because
887
888
    of an exception: Call, Quot, DivMod, Div, Mod, Load, Store, Alloc,
    Bad. */
Michael Beck's avatar
Michael Beck committed
889
int is_fragile_op(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
890
/** Returns the memory operand of fragile operations. */
891
ir_node *get_fragile_op_mem(ir_node *node);
Christian Schäfer's avatar
Christian Schäfer committed
892

Michael Beck's avatar
Michael Beck committed
893
894
/** Returns true if the operation is a forking control flow
 *  operation: Cond. */
Michael Beck's avatar
Michael Beck committed
895
int is_forking_op(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
896

897
898
899
900
901
902
/**
 * Access custom node data.
 * The data must have been registered with
 * register_additional_node_data() before.
 * @param node The ir node to get the data from.
 * @param type The type of the data you registered.
Sebastian Hack's avatar
Sebastian Hack committed
903
 * @param off The value returned by register_additional_node_data().
904
905
906
 * @return A pointer of type @p type.
 */
#define get_irn_data(node,type,off) \
Sebastian Hack's avatar
Sebastian Hack committed
907
908
909
910
911
912
913
914
915
916
  (assert(off > 0 && "Invalid node data offset"), (type *) ((char *) (node) - (off)))

/**
 * Get the pointer to the node some custom data belongs to.
 * @param data The pointer to the custom data.
 * @param off The number as returned by register_additional_node_data().
 * @return A pointer to the ir node the custom data belongs to.
 */
#define get_irn_data_base(data,off) \
  (assert(off > 0 && "Invalid node data offset"), (ir_node *) ((char *) (data) + (off)))
917
918
919
920
921
922
923
924

/**
 * Request additional data to be allocated with an ir node.
 * @param size The size of the additional data required.
 * @return A positive number, if the opration was successful, which
 * must be passed to the access macro get_irn_data(), 0 if the
 * registration failed.
 */
925
unsigned register_additional_node_data(unsigned size);
926
927


Michael Beck's avatar
Michael Beck committed
928
/*-----------------------------------------------------------------*/
Götz Lindenmaier's avatar
Götz Lindenmaier committed
929
/** Debug aides                                                   **/
Michael Beck's avatar
Michael Beck committed
930
/*-----------------------------------------------------------------*/
Götz Lindenmaier's avatar
Götz Lindenmaier committed
931
932
933
934
935
936


/** Debug print the node.
 *
 *  Writes the node, all its attributes and the predecessors to stdout if DEBUG_libfirm
 *  is set.  Else does nothing. */
Michael Beck's avatar
Michael Beck committed
937
void    dump_irn(ir_node *n);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
938

Götz Lindenmaier's avatar
Götz Lindenmaier committed
939
940
#include "ident.h"

941
#ifdef __GNUC__
942
/* GNU C has the __FUNCTION__ extension */
943
944
945
946
947
#define __MYFUNC__ __FUNCTION__
#else
/* use Filename instead */
#define __MYFUNC__ __FILE__
#endif
948

Götz Lindenmaier's avatar
Götz Lindenmaier committed
949
950
/* !!!!!!!!! @@@
   Don't format with "\", firmjni gets problems */
951
/** Output location */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
952
#define DDM      printf("%s(l.%i).\n",                       __MYFUNC__, __LINE__);
953
/** Output the firm kind of the node */
954
#define DDMK(X)  printf("%s(l.%i) %s: %p\n",                 __MYFUNC__, __LINE__,  print_firm_kind(X), (void *)(X));
955
/** Output information about a node */
956
#define DDMN(X)  printf("%s(l.%i) %s%s: %ld (%p)\n",         __MYFUNC__, __LINE__,  get_irn_opname(X), get_mode_name(get_irn_mode(X)), get_irn_node_nr(X), (void *)(X))
957
/** Output information about a node and its block */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
958
#define DDMNB(X) printf("%s%s: %ld (in block %ld)\n", get_irn_opname(X),  get_mode_name(get_irn_mode(X)), get_irn_node_nr(X), get_irn_node_nr(get_nodes_block(X)))
959
/** Output information about a type */
960
#define DDMT(X)  printf("%s(l.%i) %s %s: %ld (%p)\n",        __MYFUNC__, __LINE__, get_type_tpop_name(X), get_type_name(X), get_type_nr(X), (void *)(X))
961
/** Output information about an entity */
962
#define DDME(X)  printf("%s(l.%i) %s: %ld (%p)\n",           __MYFUNC__, __LINE__, get_entity_name(X), get_entity_nr(X), (void *)(X))
963
964
/** Output information about an entity and its type */
#define DDMET(X) printf("%s(l.%i) %s (typ: %s): %ld (%p)\n", __MYFUNC__, __LINE__, get_entity_name(X), get_type_name(get_entity_type(X)), get_entity_nr(X), (void *)(X))
965
/** Output information about an entity and its owner */
966
#define DDMEO(X) printf("%s(l.%i) %s (own: %s): %ld (%p)\n", __MYFUNC__, __LINE__, get_entity_name(X), get_type_name(get_entity_owner(X)), get_entity_nr(X), (void *)(X))
967
/** Output information about a graph */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
968
#define DDMG(X)  printf("%s(l.%i) graph %s: %ld (%p) in %s %s.\n", __MYFUNC__, __LINE__, get_entity_name(get_irg_entity(X)), get_irg_graph_nr(X), (void *)(X), get_type_tpop_name(get_entity_owner(get_irg_entity(X))), get_type_name(get_entity_owner(get_irg_entity(X))))
969
/** Output information about an ident */
970
#define DDMI(X)  printf("%s(l.%i) %s: %p\n",                 __MYFUNC__, __LINE__, get_id_str(X), (void *)(X))
971
/** Output information about a mode */