irnode_t.h 27.8 KB
Newer Older
Götz Lindenmaier's avatar
Götz Lindenmaier committed
1
2
3
4
5
6
7
8
9
10
11
12
/*
 * Project:     libFIRM
 * File name:   ir/ir/irnode_t.h
 * Purpose:     Representation of an intermediate operation -- private header.
 * 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
13
14
15
16
17
18
19
20
/**
 * @file irnode_t.h
 *
 * Declarations of an ir node.
 *
 * @author Martin Trapp, Christian Schaefer
 */

Götz Lindenmaier's avatar
Götz Lindenmaier committed
21
22
23
# ifndef _IRNODE_T_H_
# define _IRNODE_T_H_

24
25
26
27
28
29
30
31
32
33
#include "firm_config.h"
#include "irnode.h"
#include "irop_t.h"
#include "irgraph_t.h"
#include "irflag_t.h"
#include "firm_common_t.h"
#include "irdom_t.h" /* For size of struct dom_info. */
#include "dbginfo.h"
#include "irloop.h"
#include "array.h"
Götz Lindenmaier's avatar
Götz Lindenmaier committed
34

Beyhan's avatar
Beyhan committed
35
#include "set.h"
Sebastian Hack's avatar
Sebastian Hack committed
36
#include "list.h"
Beyhan's avatar
Beyhan committed
37
38
#include "entity_t.h"
#include "type_t.h"
Sebastian Hack's avatar
Sebastian Hack committed
39
#include "tv_t.h"
40
#include "irextbb_t.h"
Sebastian Hack's avatar
Sebastian Hack committed
41

Sebastian Hack's avatar
Sebastian Hack committed
42

Götz Lindenmaier's avatar
Götz Lindenmaier committed
43
/** ir node attributes **/
Götz Lindenmaier's avatar
Götz Lindenmaier committed
44

Michael Beck's avatar
Michael Beck committed
45
/** Block attributes */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
46
typedef struct {
47
48
  /* General attributes */
  ir_graph *irg;
Michael Beck's avatar
Michael Beck committed
49
  unsigned long block_visited;  /**< for the walker that walks over all blocks. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
50
  /* Attributes private to construction: */
51
52
  unsigned matured:1;         /**< if set, all in-nodes of the block are fixed */
  unsigned dead:1;            /**< if set, the block is dead (and could be replace by a Bad */
Michael Beck's avatar
Michael Beck committed
53
  ir_node **graph_arr;        /**< array to store all parameters */
54
  /* Attributes holding analyses information */
Michael Beck's avatar
Michael Beck committed
55
56
57
58
59
60
  dom_info dom;               /**< Datastructure that holds information about dominators.
                                   @@@ @todo
                                   Eventually overlay with graph_arr as only valid
                                   in different phases.  Eventually inline the whole
                                   datastructure. */
  dom_info pdom;              /**< Datastructure that holds information about post-dominators. */
Michael Beck's avatar
Michael Beck committed
61
  ir_node ** in_cg;           /**< array with predecessors in
Michael Beck's avatar
Michael Beck committed
62
63
                               * interprocedural_view, if they differ
                               * from intraprocedural predecessors */
Michael Beck's avatar
Michael Beck committed
64
  int *backedge;              /**< Field n set to true if pred n is backedge.
Michael Beck's avatar
Michael Beck committed
65
                                   @@@ @todo Ev. replace by bit field! */
Michael Beck's avatar
Michael Beck committed
66
  int *cg_backedge;           /**< Field n set to true if pred n is interprocedural backedge.
Michael Beck's avatar
Michael Beck committed
67
                                   @@@ @todo Ev. replace by bit field! */
68
69
  ir_extblk *extblk;          /**< the extended basic block this block belongs to */

70
71
  struct list_head succ_head; /**< A list head for all successor edges of a block. */

Götz Lindenmaier's avatar
Götz Lindenmaier committed
72
73
} block_attr;

74
/** Cond attributes. */
75
typedef struct {
76
77
78
  cond_kind kind;           /**< flavor of Cond */
  long default_proj;        /**< only for non-binary Conds: biggest Proj number, i.e. the one used for default. */
  cond_jmp_predicate pred;  /**< only for binary Conds: The jump predication. */
79
80
} cond_attr;

81
/** Const attributes. */
82
typedef struct {
Michael Beck's avatar
Michael Beck committed
83
84
  tarval  *tv;       /**< the target value */
  ir_type *tp;       /**< the source type, for analyses. default: type_unknown. */
85
86
} const_attr;

87
/** SymConst attributes. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
88
typedef struct {
Beyhan's avatar
Beyhan committed
89
  symconst_symbol sym;  // old tori
Götz Lindenmaier's avatar
Götz Lindenmaier committed
90
  symconst_kind num;
Michael Beck's avatar
Michael Beck committed
91
  ir_type *tp;       /**< the source type, for analyses. default: type_unknown. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
92
93
} symconst_attr;

94
/** Sel attributes. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
95
typedef struct {
Michael Beck's avatar
Michael Beck committed
96
  entity *ent;          /**< entity to select */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
97
98
} sel_attr;

99
/** Exception attributes. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
100
typedef struct {
Michael Beck's avatar
Michael Beck committed
101
102
103
  op_pin_state   pin_state;     /**< the pin state for operations that might generate a exception:
                                     If it's know that no exception will be generated, could be set to
                                     op_pin_state_floats. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
104
#if PRECISE_EXC_CONTEXT
Michael Beck's avatar
Michael Beck committed
105
  struct ir_node **frag_arr;    /**< For Phi node construction in case of exception */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
106
#endif
Michael Beck's avatar
Michael Beck committed
107
108
} except_attr;

109
/** Call attributes. */
Michael Beck's avatar
Michael Beck committed
110
111
typedef struct {
  except_attr    exc;           /**< the exception attribute. MUST be the first one. */
Michael Beck's avatar
Michael Beck committed
112
  ir_type *cld_tp;              /**< type of called procedure */
Michael Beck's avatar
Michael Beck committed
113
  entity ** callee_arr;         /**< result of callee analysis */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
114
115
} call_attr;

116
/** Alloc attributes. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
117
typedef struct {
Michael Beck's avatar
Michael Beck committed
118
  except_attr    exc;           /**< the exception attribute. MUST be the first one. */
Michael Beck's avatar
Michael Beck committed
119
  ir_type *type;                /**< Type of the allocated object.  */
Michael Beck's avatar
Michael Beck committed
120
  where_alloc where;            /**< stack, heap or other managed part of memory */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
121
122
} alloc_attr;

123
/** Free attributes. */
Michael Beck's avatar
Michael Beck committed
124
typedef struct {
Michael Beck's avatar
Michael Beck committed
125
  ir_type *type;                /**< Type of the allocated object.  */
Michael Beck's avatar
Michael Beck committed
126
127
128
  where_alloc where;            /**< stack, heap or other managed part of memory */
} free_attr;

129
/** InstOf attributes. */
Michael Beck's avatar
Michael Beck committed
130
typedef struct {
131
132
  except_attr    exc;           /**< the exception attribute. MUST be the first one. */
  ir_type *type;                /**< the type of which the object pointer must be */
133
134
} io_attr;

135
/** Filter attributes. */
136
typedef struct {
Michael Beck's avatar
Michael Beck committed
137
138
139
  long proj;                 /**< contains the result position to project (Proj) */
  ir_node ** in_cg;          /**< array with interprocedural predecessors (Phi) */
  int *backedge;              /**< Field n set to true if pred n is backedge.
140
                     @todo Ev. replace by bitfield! */
141
142
} filter_attr;

143
/** EndReg/EndExcept attributes. */
144
typedef struct {
145
  char dummy;
146
147
} end_attr;

148
/** CallBegin attributes. */
149
typedef struct {
150
  ir_node * call;               /**< Associated Call-operation. */
151
152
} callbegin_attr;

153
/** Cast attributes. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
154
typedef struct {
155
  ir_type *totype;              /**< Type of the casted node. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
156
157
} cast_attr;

158
/** Load attributes. */
159
typedef struct {
160
161
162
  except_attr    exc;           /**< The exception attribute. MUST be the first one. */
  ir_mode        *load_mode;    /**< The mode of this Load operation. */
  ent_volatility volatility;	  /**< The volatility of a Load/Store operation. */
163
164
} load_attr;

165
/** Store attributes. */
166
typedef struct {
Michael Beck's avatar
Michael Beck committed
167
  except_attr    exc;           /**< the exception attribute. MUST be the first one. */
Michael Beck's avatar
Michael Beck committed
168
  ent_volatility volatility;	  /**< the volatility of a Store operation */
169
170
} store_attr;

Michael Beck's avatar
Michael Beck committed
171
typedef pn_Cmp confirm_attr;    /**< Attribute to hold compare operation */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
172

173
/** CopyB attribute. */
Michael Beck's avatar
Michael Beck committed
174
typedef struct {
175
176
  except_attr    exc;           /**< The exception attribute. MUST be the first one. */
  ir_type        *data_type;    /**< Type of the copied entity. */
Michael Beck's avatar
Michael Beck committed
177
178
} copyb_attr;

179
/** Bound attribute. */
Michael Beck's avatar
Michael Beck committed
180
typedef struct {
181
  except_attr    exc;           /**< The exception attribute. MUST be the first one. */
Michael Beck's avatar
Michael Beck committed
182
183
} bound_attr;

184
185
186
187
188
/** Conv attribute. */
typedef struct {
  char           strict;        /**< If set, this is a strict Conv that cannot be removed. */
} conv_attr;

Sebastian Hack's avatar
Sebastian Hack committed
189
190
191
192
/**
 * Edge info to put into an irn.
 */
typedef struct _irn_edge_info_t {
193
194
  struct list_head outs_head;  /**< The list of all outs. */
  int out_count;               /**< Number of outs in the list. */
Sebastian Hack's avatar
Sebastian Hack committed
195
196
197
} irn_edge_info_t;


Michael Beck's avatar
Michael Beck committed
198
/** Some IR-nodes just have one attribute, these are stored here,
Götz Lindenmaier's avatar
Götz Lindenmaier committed
199
200
   some have more. Their name is 'irnodename_attr' */
typedef union {
201
202
203
204
205
206
  block_attr     block;   /**< For Block: Fields needed to construct it */
  cond_attr      cond;    /**< For Cond. */
  const_attr     con;     /**< For Const: contains the value of the constant and a type */
  symconst_attr  symc;    /**< For SymConst. */
  sel_attr       sel;     /**< For Sel. */
  call_attr      call;    /**< For Call: pointer to the type of the method to call */
Michael Beck's avatar
Michael Beck committed
207
  callbegin_attr callbegin; /**< For CallBegin */
208
209
210
211
212
  alloc_attr     alloc;  /**< For Alloc. */
  free_attr      free;   /**< For Free. */
  io_attr        instof; /**< For InstOf */
  cast_attr      cast;   /**< For Cast. */
  load_attr      load;   /**< For Load. */
213
  store_attr     store;  /**< For Store. */
Michael Beck's avatar
Michael Beck committed
214
  int            phi0_pos;  /**< For Phi. Used to remember the value defined by
215
216
217
218
219
                   this Phi node.  Needed when the Phi is completed
                   to call get_r_internal_value to find the
                   predecessors. If this attribute is set, the Phi
                   node takes the role of the obsolete Phi0 node,
                   therefore the name. */
Michael Beck's avatar
Michael Beck committed
220
  int *phi_backedge;    /**< For Phi after construction.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
221
222
			   Field n set to true if pred n is backedge.
			   @todo Ev. replace by bitfield! */
Michael Beck's avatar
Michael Beck committed
223
  long           proj;          /**< For Proj: contains the result position to project */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
224
  confirm_attr   confirm_cmp;   /**< For Confirm: compare operation */
Michael Beck's avatar
Michael Beck committed
225
226
227
228
  filter_attr    filter;        /**< For Filter */
  end_attr       end;           /**< For EndReg, EndExcept */
  except_attr    except;        /**< For Phi node construction in case of exceptions */
  copyb_attr     copyb;         /**< For CopyB operation */
Michael Beck's avatar
Michael Beck committed
229
  bound_attr     bound;         /**< For Bound operation */
230
  conv_attr      conv;          /**< For Conv operation */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
231
232
233
} attr;


Michael Beck's avatar
Michael Beck committed
234
235
/** common structure of an irnode
    if the node has some attributes, they are stored in attr */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
236
struct ir_node {
Michael Beck's avatar
Michael Beck committed
237
238
239
240
241
  /* ------- Basics of the representation  ------- */
  firm_kind kind;          /**< distinguishes this node from others */
  ir_op *op;               /**< Opcode of this node. */
  ir_mode *mode;           /**< Mode of this node. */
  struct ir_node **in;     /**< array with predecessors / operands */
Michael Beck's avatar
Michael Beck committed
242
  unsigned long visited;   /**< visited counter for walks of the graph */
243
  unsigned node_idx;       /**< the node index of this node in its graph */
Michael Beck's avatar
Michael Beck committed
244
  void *link;              /**< to attach additional information to the node, e.g.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
245
                              used while construction to link Phi0 nodes and
246
247
                              during optimization to link to nodes that
                              shall replace a node. */
Michael Beck's avatar
Michael Beck committed
248
  /* ------- Fields for optimizations / analysis information ------- */
Sebastian Hack's avatar
Sebastian Hack committed
249
  struct ir_node **out;    /**< @deprecated array of out edges. */
Michael Beck's avatar
Michael Beck committed
250
251
  struct dbg_info* dbi;    /**< A pointer to information for debug support. */
  /* ------- For debugging ------- */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
252
#ifdef DEBUG_libfirm
253
  int out_valid;
Michael Beck's avatar
Michael Beck committed
254
  long node_nr;            /**< a unique node number for each node to make output
255
                                   readable. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
256
#endif
Götz Lindenmaier's avatar
Götz Lindenmaier committed
257
258
  /* ------- For analyses -------- */
  ir_loop *loop;           /**< the loop the node is in. Access routines in irloop.h */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
259
#ifdef  DO_HEAPANALYSIS
Michael Beck's avatar
Michael Beck committed
260
  struct abstval *av;      /**< the abstract value of this node */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
261
  struct section *sec;
Sebastian Hack's avatar
Sebastian Hack committed
262
#endif
Michael Beck's avatar
Michael Beck committed
263
  irn_edge_info_t edge_info;  /**< everlasting out edges */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
264
  /* ------- Opcode depending fields -------- */
Michael Beck's avatar
Michael Beck committed
265
266
  attr attr;               /**< attribute of this node. Depends on opcode.
                              Must be last field of struct ir_node. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
267
268
};

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

270
271
272
273
274
275
/**
 * Returns the array with the ins.  The content of the array may not be
 * changed.
 * Note that this function returns the whole in array including the
 * block predecessor. So, it is NOT symmetric with set_irn_in().
 */
276
ir_node     **get_irn_in            (const ir_node *node);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
277

Michael Beck's avatar
Michael Beck committed
278
/** @{ */
Michael Beck's avatar
Michael Beck committed
279
/** access attributes directly */
280
281
282
const_attr    get_irn_const_attr    (ir_node *node);
long          get_irn_proj_attr     (ir_node *node);
alloc_attr    get_irn_alloc_attr    (ir_node *node);
Michael Beck's avatar
Michael Beck committed
283
free_attr     get_irn_free_attr     (ir_node *node);
284
symconst_attr get_irn_symconst_attr (ir_node *node);
Michael Beck's avatar
Michael Beck committed
285
286
ir_type      *get_irn_call_attr     (ir_node *node);
ir_type      *get_irn_funccall_attr (ir_node *node);
287
288
289
290
291
292
sel_attr      get_irn_sel_attr      (ir_node *node);
int           get_irn_phi_attr      (ir_node *node);
block_attr    get_irn_block_attr    (ir_node *node);
load_attr     get_irn_load_attr     (ir_node *node);
store_attr    get_irn_store_attr    (ir_node *node);
except_attr   get_irn_except_attr   (ir_node *node);
Michael Beck's avatar
Michael Beck committed
293
/** @} */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
294

295
/**
296
297
298
299
 * The amount of additional space for custom data to be allocated upon creating a new node.
 */
extern unsigned firm_add_node_size;

Michael Beck's avatar
Michael Beck committed
300
301
302
303
304
305
306
307
308
309
/**
 * Sets the get_type operation for an ir_op_ops.
 *
 * @param code   the opcode for the default operation
 * @param ops    the operations initialized
 *
 * @return
 *    The operations.
 */
ir_op_ops *firm_set_default_get_type(opcode code, ir_op_ops *ops);
310

Michael Beck's avatar
Michael Beck committed
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
/**
 * Sets the get_type_attr operation for an ir_op_ops.
 *
 * @param code   the opcode for the default operation
 * @param ops    the operations initialized
 *
 * @return
 *    The operations.
 */
ir_op_ops *firm_set_default_get_type_attr(opcode code, ir_op_ops *ops);

/**
 * Sets the get_entity_attr operation for an ir_op_ops.
 *
 * @param code   the opcode for the default operation
 * @param ops    the operations initialized
 *
 * @return
 *    The operations.
 */
ir_op_ops *firm_set_default_get_entity_attr(opcode code, ir_op_ops *ops);

Michael Beck's avatar
Michael Beck committed
333
/*-------------------------------------------------------------------*/
Götz Lindenmaier's avatar
Götz Lindenmaier committed
334
335
/*  These function are most used in libfirm.  Give them as static    */
/*  functions so they can be inlined.                                */
Michael Beck's avatar
Michael Beck committed
336
/*-------------------------------------------------------------------*/
Götz Lindenmaier's avatar
Götz Lindenmaier committed
337

338
339
340
341
342
/**
 * Checks whether a pointer points to a ir node.
 * Intern version for libFirm.
 */
static INLINE int
343
_is_ir_node (const void *thing) {
344
345
  return (get_kind(thing) == k_ir_node);
}
Götz Lindenmaier's avatar
Götz Lindenmaier committed
346

347
348
349
350
351
/**
 * Gets the op of a node.
 * Intern version for libFirm.
 */
static INLINE ir_op *
352
_get_irn_op (const ir_node *node) {
353
354
355
356
  assert (node);
  return node->op;
}

357
358
359
360
361
362
static INLINE void
_set_irn_op (ir_node *node, ir_op *op) {
  assert (node);
  node->op = op;
}

363
364
365
366
/** Copies all attributes stored in the old node  to the new node.
    Assumes both have the same opcode and sufficient size. */
static INLINE void
copy_node_attr(const ir_node *old_node, ir_node *new_node) {
367
  ir_op *op = _get_irn_op(old_node);
368
369

  /* must always exist */
Michael Beck's avatar
Michael Beck committed
370
  op->ops.copy_attr(old_node, new_node);
371
372
}

373
374
375
376
377
/**
 * Gets the opcode of a node.
 * Intern version for libFirm.
 */
static INLINE opcode
378
_get_irn_opcode (const ir_node *node) {
379
  assert (k_ir_node == get_kind(node));
380
  assert (node->op);
381
382
  return node->op->code;
}
Götz Lindenmaier's avatar
Götz Lindenmaier committed
383

Michael Beck's avatar
Michael Beck committed
384
385
386
387
/**
 * Returns the number of predecessors without the block predecessor.
 * Intern version for libFirm.
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
388
static INLINE int
389
_get_irn_intra_arity (const ir_node *node) {
Götz Lindenmaier's avatar
Götz Lindenmaier committed
390
391
392
393
  assert(node);
  return ARR_LEN(node->in) - 1;
}

Michael Beck's avatar
Michael Beck committed
394
395
396
397
/**
 * Returns the number of predecessors without the block predecessor.
 * Intern version for libFirm.
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
398
static INLINE int
399
_get_irn_inter_arity (const ir_node *node) {
Götz Lindenmaier's avatar
Götz Lindenmaier committed
400
  assert(node);
Michael Beck's avatar
Michael Beck committed
401
  if (_get_irn_op(node) == op_Filter) {
Götz Lindenmaier's avatar
Götz Lindenmaier committed
402
403
    assert(node->attr.filter.in_cg);
    return ARR_LEN(node->attr.filter.in_cg) - 1;
Michael Beck's avatar
Michael Beck committed
404
  } else if (_get_irn_op(node) == op_Block && node->attr.block.in_cg) {
Götz Lindenmaier's avatar
Götz Lindenmaier committed
405
406
    return ARR_LEN(node->attr.block.in_cg) - 1;
  }
407
  return _get_irn_intra_arity(node);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
408
409
}

Michael Beck's avatar
Michael Beck committed
410
411
412
413
/**
 * Returns the number of predecessors without the block predecessor.
 * Intern version for libFirm.
 */
414
extern int (*_get_irn_arity)(const ir_node *node);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
415

Michael Beck's avatar
Michael Beck committed
416
417
418
/**
 * Intern version for libFirm.
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
419
static INLINE ir_node *
420
_get_irn_intra_n (const ir_node *node, int n) {
Michael Beck's avatar
Michael Beck committed
421
422
  ir_node *nn;

423
  assert(node); assert(-1 <= n && n < _get_irn_intra_arity(node));
424

Michael Beck's avatar
Michael Beck committed
425
426
427
428
  nn = node->in[n + 1];
  if (!nn || (nn->op != op_Id)) return nn;

  return (node->in[n + 1] = skip_Id(nn));
Götz Lindenmaier's avatar
Götz Lindenmaier committed
429
430
}

Michael Beck's avatar
Michael Beck committed
431
432
433
/**
 * Intern version for libFirm.
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
434
static INLINE ir_node*
435
436
_get_irn_inter_n (const ir_node *node, int n) {
  assert(node); assert(-1 <= n && n < _get_irn_inter_arity(node));
437

Götz Lindenmaier's avatar
Götz Lindenmaier committed
438
  /* handle Filter and Block specially */
439
  if (_get_irn_op(node) == op_Filter) {
Götz Lindenmaier's avatar
Götz Lindenmaier committed
440
    assert(node->attr.filter.in_cg);
441
    return (node->attr.filter.in_cg[n + 1] = skip_Id(node->attr.filter.in_cg[n + 1]));
442
  } else if (_get_irn_op(node) == op_Block && node->attr.block.in_cg) {
443
    return (node->attr.block.in_cg[n + 1] = skip_Id(node->attr.block.in_cg[n + 1]));
Götz Lindenmaier's avatar
Götz Lindenmaier committed
444
445
  }

446
  return _get_irn_intra_n (node, n);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
447
448
}

Michael Beck's avatar
Michael Beck committed
449
450
/**
 * Access to the predecessors of a node.
451
 * To iterate over the operands iterate from 0 to i < get_irn_arity(),
Michael Beck's avatar
Michael Beck committed
452
453
454
455
456
 * to iterate including the Block predecessor iterate from i = -1 to
 * i < get_irn_arity.
 * If it is a block, the entry -1 is NULL.
 * Intern version for libFirm.
 */
457
extern ir_node *(*_get_irn_n)(const ir_node *node, int n);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
458

Michael Beck's avatar
Michael Beck committed
459
460
461
462
/**
 * Gets the mode of a node.
 * Intern version for libFirm.
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
463
static INLINE ir_mode *
Michael Beck's avatar
Michael Beck committed
464
_get_irn_mode(const ir_node *node) {
Götz Lindenmaier's avatar
Götz Lindenmaier committed
465
466
467
468
  assert (node);
  return node->mode;
}

Michael Beck's avatar
Michael Beck committed
469
/**
470
471
472
473
 * Sets the mode of a node.
 * Intern version of libFirm.
 */
static INLINE void
Michael Beck's avatar
Michael Beck committed
474
_set_irn_mode(ir_node *node, ir_mode *mode) {
475
476
477
478
479
480
  assert (node);
  node->mode = mode;
}

/**
 * Gets the visited counter of a node.
Michael Beck's avatar
Michael Beck committed
481
482
 * Intern version for libFirm.
 */
483
static INLINE unsigned long
Michael Beck's avatar
Michael Beck committed
484
_get_irn_visited(const ir_node *node) {
Götz Lindenmaier's avatar
Götz Lindenmaier committed
485
  assert (node);
486
  return node->visited;
Götz Lindenmaier's avatar
Götz Lindenmaier committed
487
488
}

Michael Beck's avatar
Michael Beck committed
489
/**
490
 * Sets the visited counter of a node.
Michael Beck's avatar
Michael Beck committed
491
492
 * Intern version for libFirm.
 */
493
static INLINE void
Michael Beck's avatar
Michael Beck committed
494
_set_irn_visited(ir_node *node, unsigned long visited) {
495
496
497
498
499
500
501
502
503
  assert (node);
  node->visited = visited;
}

/**
 * Mark a node as visited in a graph.
 * Intern version for libFirm.
 */
static INLINE void
Michael Beck's avatar
Michael Beck committed
504
_mark_irn_visited(ir_node *node) {
505
506
507
508
509
510
511
512
513
  assert (node);
  node->visited = current_ir_graph->visited;
}

/**
 * Returns non-zero if a node of was visited.
 * Intern version for libFirm.
 */
static INLINE int
514
_irn_visited(const ir_node *node) {
515
516
  assert (node);
  return (node->visited >= current_ir_graph->visited);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
517
518
}

519
520
521
522
523
/**
 * Returns non-zero if a node of was NOT visited.
 * Intern version for libFirm.
 */
static INLINE int
524
_irn_not_visited(const ir_node *node) {
525
526
527
528
529
530
531
532
533
  assert (node);
  return (node->visited < current_ir_graph->visited);
}

/**
 * Sets the link of a node.
 * Intern version of libFirm.
 */
static INLINE void
534
_set_irn_link(ir_node *node, void *link) {
535
536
537
  assert (node);
  /* Link field is used for Phi construction and various optimizations
     in iropt. */
538
  assert(get_irg_phase_state(get_irn_irg(node)) != phase_building);
539
540
541
542
543
544
545
546
547

  node->link = link;
}

/**
 * Returns the link of a node.
 * Intern version of libFirm.
 */
static INLINE void *
548
549
_get_irn_link(const ir_node *node) {
  assert (node && _is_ir_node(node));
550
551
  return node->link;
}
Götz Lindenmaier's avatar
Götz Lindenmaier committed
552

Michael Beck's avatar
Michael Beck committed
553
/**
554
555
556
 * Returns whether the node _always_ must be pinned.
 * I.e., the node is not floating after global cse.
 *
Michael Beck's avatar
Michael Beck committed
557
558
559
 * Intern version of libFirm.
 */
static INLINE op_pin_state
560
561
562
_get_irn_pinned(const ir_node *node) {
  op_pin_state state;
  assert(node && _is_ir_node(node));
563
  /* Check opcode */
564
  state = _get_op_pinned(_get_irn_op(node));
565

566
  if (state >= op_pin_state_exc_pinned)
Michael Beck's avatar
Michael Beck committed
567
568
569
570
    return get_opt_fragile_ops() ? node->attr.except.pin_state : op_pin_state_pinned;
  return state;
}

571
572
static INLINE op_pin_state
_is_irn_pinned_in_irg(const ir_node *node) {
Michael Beck's avatar
Michael Beck committed
573
574
  if (get_irg_pinned(get_irn_irg(node)) == op_pin_state_floats)
    return get_irn_pinned(node);
575
576
577
  return op_pin_state_pinned;
}

Michael Beck's avatar
Michael Beck committed
578
static INLINE int
579
580
_is_unop(const ir_node *node) {
  assert(node && _is_ir_node(node));
Michael Beck's avatar
Michael Beck committed
581
582
583
584
  return (node->op->opar == oparity_unary);
}

static INLINE int
585
586
_is_binop(const ir_node *node) {
  assert(node && _is_ir_node(node));
Michael Beck's avatar
Michael Beck committed
587
588
589
590
  return (node->op->opar == oparity_binary);
}

static INLINE int
591
_is_Bad(const ir_node *node) {
Michael Beck's avatar
Michael Beck committed
592
  assert(node);
Michael Beck's avatar
Michael Beck committed
593
  return (_get_irn_op(node) == op_Bad);
Michael Beck's avatar
Michael Beck committed
594
595
}

Sebastian Hack's avatar
Sebastian Hack committed
596
597
static INLINE int
_is_Const(const ir_node *node) {
Michael Beck's avatar
Michael Beck committed
598
  assert(node);
Michael Beck's avatar
Michael Beck committed
599
  return (_get_irn_op(node) == op_Const);
Sebastian Hack's avatar
Sebastian Hack committed
600
601
}

Michael Beck's avatar
Michael Beck committed
602
static INLINE int
Michael Beck's avatar
Michael Beck committed
603
_is_Unknown(const ir_node *node) {
Michael Beck's avatar
Michael Beck committed
604
  assert(node);
Michael Beck's avatar
Michael Beck committed
605
  return (_get_irn_op(node) == op_Unknown);
Michael Beck's avatar
Michael Beck committed
606
607
}

608
static INLINE int
Michael Beck's avatar
Michael Beck committed
609
_is_Return(const ir_node *node) {
610
  assert(node);
Michael Beck's avatar
Michael Beck committed
611
  return (_get_irn_op(node) == op_Return);
612
613
614
}

static INLINE int
Michael Beck's avatar
Michael Beck committed
615
_is_Call(const ir_node *node) {
616
  assert(node);
Michael Beck's avatar
Michael Beck committed
617
  return (_get_irn_op(node) == op_Call);
618
619
620
}

static INLINE int
Michael Beck's avatar
Michael Beck committed
621
_is_Sel(const ir_node *node) {
622
  assert(node);
Michael Beck's avatar
Michael Beck committed
623
  return (_get_irn_op(node) == op_Sel);
624
625
}

Michael Beck's avatar
Michael Beck committed
626
static INLINE int
Michael Beck's avatar
Michael Beck committed
627
_is_Mux(const ir_node *node) {
Michael Beck's avatar
Michael Beck committed
628
629
630
631
632
633
634
635
  assert(node);
  if (node) {
    ir_op *op = _get_irn_op(node);
    return (op == op_Mux || ((op == op_Psi) && _get_irn_arity(node) == 3));
  }
  return 0;
}

Michael Beck's avatar
Michael Beck committed
636
static INLINE int
Michael Beck's avatar
Michael Beck committed
637
_is_Load(const ir_node *node) {
Michael Beck's avatar
Michael Beck committed
638
  assert(node);
Michael Beck's avatar
Michael Beck committed
639
  return (_get_irn_op(node) == op_Load);
Michael Beck's avatar
Michael Beck committed
640
641
642
}

static INLINE int
Michael Beck's avatar
Michael Beck committed
643
_is_Sync(const ir_node *node) {
Michael Beck's avatar
Michael Beck committed
644
  assert(node);
Michael Beck's avatar
Michael Beck committed
645
  return (_get_irn_op(node) == op_Sync);
Michael Beck's avatar
Michael Beck committed
646
647
648
}

static INLINE int
Michael Beck's avatar
Michael Beck committed
649
_is_Confirm(const ir_node *node) {
Michael Beck's avatar
Michael Beck committed
650
  assert(node);
Michael Beck's avatar
Michael Beck committed
651
  return (_get_irn_op(node) == op_Confirm);
Michael Beck's avatar
Michael Beck committed
652
653
}

Michael Beck's avatar
Michael Beck committed
654
static INLINE int
655
656
657
_is_no_Block(const ir_node *node) {
  assert(node && _is_ir_node(node));
  return (_get_irn_op(node) != op_Block);
Michael Beck's avatar
Michael Beck committed
658
659
660
}

static INLINE int
661
662
663
_is_Block(const ir_node *node) {
  assert(node && _is_ir_node(node));
  return (_get_irn_op(node) == op_Block);
Michael Beck's avatar
Michael Beck committed
664
665
}

666
static INLINE int
Michael Beck's avatar
Michael Beck committed
667
_get_Block_n_cfgpreds(ir_node *node) {
668
669
670
671
672
  assert(_is_Block(node));
  return _get_irn_arity(node);
}

static INLINE ir_node *
Michael Beck's avatar
Michael Beck committed
673
_get_Block_cfgpred(ir_node *node, int pos) {
674
675
676
677
678
  assert(0 <= pos && pos < get_irn_arity(node));
  assert(_is_Block(node));
  return _get_irn_n(node, pos);
}

679
680
/* Get the predecessor block.
 *
681
 *  Returns the block corresponding to the predecessor pos.
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
 *
 *  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.
 */
static INLINE ir_node  *
_get_Block_cfgpred_block(ir_node *node, int pos) {
  ir_node *res = skip_Proj(get_Block_cfgpred(node, pos));
  if (!is_Bad(res))
    res = get_nodes_block(res);
  return res;
}

Michael Beck's avatar
Michael Beck committed
698
static INLINE unsigned long
Michael Beck's avatar
Michael Beck committed
699
_get_Block_block_visited(ir_node *node) {
Michael Beck's avatar
Michael Beck committed
700
701
702
703
704
  assert (node->op == op_Block);
  return node->attr.block.block_visited;
}

static INLINE void
Michael Beck's avatar
Michael Beck committed
705
_set_Block_block_visited(ir_node *node, unsigned long visit) {
Michael Beck's avatar
Michael Beck committed
706
707
708
709
710
711
  assert (node->op == op_Block);
  node->attr.block.block_visited = visit;
}

/* For this current_ir_graph must be set. */
static INLINE void
Michael Beck's avatar
Michael Beck committed
712
_mark_Block_block_visited(ir_node *node) {
Michael Beck's avatar
Michael Beck committed
713
714
715
716
717
718
719
720
721
722
  assert (node->op == op_Block);
  node->attr.block.block_visited = get_irg_block_visited(current_ir_graph);
}

static INLINE int
_Block_not_block_visited(ir_node *node) {
  assert (node->op == op_Block);
  return (node->attr.block.block_visited < get_irg_block_visited(current_ir_graph));
}

723
static INLINE ir_node *
724
725
_set_Block_dead(ir_node *block) {
  assert(_get_irn_op(block) == op_Block);
726
727
728
729
730
  block->attr.block.dead = 1;
  return block;
}

static INLINE int
731
_is_Block_dead(const ir_node *block) {
Michael Beck's avatar
Michael Beck committed
732
  ir_op *op = _get_irn_op(block);
733
734
735
736
737
738
739
740
741

  if (op == op_Bad)
    return 1;
  else {
    assert(op == op_Block);
    return block->attr.block.dead;
  }
}

Sebastian Hack's avatar
Sebastian Hack committed
742
static INLINE tarval *_get_Const_tarval (ir_node *node) {
743
  assert (_get_irn_op(node) == op_Const);
Sebastian Hack's avatar
Sebastian Hack committed
744
745
746
  return node->attr.con.tv;
}

747
748
static INLINE cnst_classify_t _classify_Const(ir_node *node) {
  ir_op *op;
Sebastian Hack's avatar
Sebastian Hack committed
749
750
  assert(_is_ir_node(node));

751
  op = _get_irn_op(node);
Sebastian Hack's avatar
Sebastian Hack committed
752

Michael Beck's avatar
Michael Beck committed
753
  if (op == op_Const)
754
755
756
    return classify_tarval(_get_Const_tarval(node));
  else if(op == op_SymConst)
    return CNST_SYMCONST;
Sebastian Hack's avatar
Sebastian Hack committed
757

758
  return CNST_NO_CONST;
Sebastian Hack's avatar
Sebastian Hack committed
759
760
}

Michael Beck's avatar
Michael Beck committed
761
762
763
764
static INLINE int _is_irn_forking(const ir_node *node) {
  return is_op_forking(_get_irn_op(node));
}

Michael Beck's avatar
Michael Beck committed
765
static INLINE ir_type *_get_irn_type(ir_node *node) {
Michael Beck's avatar
Michael Beck committed
766
  return _get_irn_op(node)->ops.get_type(node);
767
}
Sebastian Hack's avatar
Sebastian Hack committed
768

Michael Beck's avatar
Michael Beck committed
769
static INLINE ir_type *_get_irn_type_attr(ir_node *node) {
Michael Beck's avatar
Michael Beck committed
770
771
772
  return _get_irn_op(node)->ops.get_type_attr(node);
}

Michael Beck's avatar
Michael Beck committed
773
static INLINE entity *_get_irn_entity_attr(ir_node *node) {
Michael Beck's avatar
Michael Beck committed
774
775
776
  return _get_irn_op(node)->ops.get_entity_attr(node);
}

Michael Beck's avatar
Michael Beck committed
777
778
779
780
static INLINE int _is_irn_constlike(const ir_node *node) {
  return is_op_constlike(_get_irn_op(node));
}

Michael Beck's avatar
Michael Beck committed
781
782
783
784
static INLINE int _is_irn_always_opt(const ir_node *node) {
  return is_op_always_opt(_get_irn_op(node));
}

Michael Beck's avatar
Michael Beck committed
785
786
787
788
static INLINE int _is_irn_keep(const ir_node *node) {
  return is_op_keep(_get_irn_op(node));
}

789
790
791
792
793
794
795
796
797
798
799
800
static INLINE int _is_irn_machine_op(const ir_node *node) {
  return is_op_machine(_get_irn_op(node));
}

static INLINE int _is_irn_machine_operand(const ir_node *node) {
  return is_op_machine_operand(_get_irn_op(node));
}

static INLINE int _is_irn_machine_user(const ir_node *node, unsigned n) {
  return is_op_machine_user(_get_irn_op(node), n);
}

801
802
static INLINE cond_jmp_predicate _get_Cond_jmp_pred(ir_node *node) {
  assert (_get_irn_op(node) == op_Cond);
803
  return node->attr.cond.pred;
804
805
806
807
}

static INLINE void _set_Cond_jmp_pred(ir_node *node, cond_jmp_predicate pred) {
  assert (_get_irn_op(node) == op_Cond);
808
  node->attr.cond.pred = pred;
809
810
}

Michael Beck's avatar
Michael Beck committed
811
812
813
814
815
static INLINE int _get_Psi_n_conds(ir_node *node) {
  assert(_get_irn_op(node) == op_Psi);
  return _get_irn_arity(node) >> 1;
}

816
817
818
819
static INLINE unsigned _get_irn_idx(const ir_node *node) {
  return node->node_idx;
}

820
/* this section MUST contain all inline functions */
Michael Beck's avatar
Michael Beck committed
821
822
823
824
825
826
827
828
829
830
#define is_ir_node(thing)                     _is_ir_node(thing)
#define get_irn_intra_arity(node)             _get_irn_intra_arity(node)
#define get_irn_inter_arity(node)             _get_irn_inter_arity(node)
#define get_irn_arity(node)                   _get_irn_arity(node)
#define get_irn_intra_n(node, n)              _get_irn_intra_n(node, n)
#define get_irn_inter_n(node, n)              _get_irn_inter_n(node, n)
#define get_irn_n(node, n)                    _get_irn_n(node, n)
#define get_irn_mode(node)                    _get_irn_mode(node)
#define set_irn_mode(node, mode)              _set_irn_mode(node, mode)
#define get_irn_op(node)                      _get_irn_op(node)
831
#define set_irn_op(node, op)                  _set_irn_op(node, op)
Michael Beck's avatar
Michael Beck committed
832
833
834
835
836
837
838
839
#define get_irn_opcode(node)                  _get_irn_opcode(node)
#define get_irn_visited(node)                 _get_irn_visited(node)
#define set_irn_visited(node, v)              _set_irn_visited(node, v)
#define mark_irn_visited(node)                _mark_irn_visited(node)
#define irn_visited(node)                     _irn_visited(node)
#define irn_not_visited(node)                 _irn_not_visited(node)
#define set_irn_link(node, link)              _set_irn_link(node, link)
#define get_irn_link(node)                    _get_irn_link(node)
840
841
#define get_irn_pinned(node)                  _get_irn_pinned(node)
#define is_irn_pinned_in_irg(node)            _is_irn_pinned_in_irg(node)
Michael Beck's avatar
Michael Beck committed
842
843
#define is_unop(node)                         _is_unop(node)
#define is_binop(node)                        _is_binop(node)
Sebastian Hack's avatar
Sebastian Hack committed
844
#define is_Const(node)                        _is_Const(node)
Michael Beck's avatar
Michael Beck committed
845
#define is_Unknown(node)                      _is_Unknown(node)
846
847
848
#define is_Return(node)                       _is_Return(node)
#define is_Call(node)                         _is_Call(node)
#define is_Sel(node)                          _is_Sel(node)
Michael Beck's avatar
Michael Beck committed
849
#define is_Mux(node)                          _is_Mux(node)
Michael Beck's avatar
Michael Beck committed
850
851
852
#define is_Load(node)                         _is_Load(node)
#define is_Sync(node)                         _is_Sync(node)
#define is_Confirm(node)                      _is_Confirm(node)
Michael Beck's avatar
Michael Beck committed
853
854
855
#define is_Bad(node)                          _is_Bad(node)
#define is_no_Block(node)                     _is_no_Block(node)
#define is_Block(node)                        _is_Block(node)
856
857
#define get_Block_n_cfgpreds(node)            _get_Block_n_cfgpreds(node)
#define get_Block_cfgpred(node, pos)          _get_Block_cfgpred(node, pos)
858
#define get_Block_cfgpred_block(node, pos)    _get_Block_cfgpred_block(node, pos)
Michael Beck's avatar
Michael Beck committed
859
860
861
862
863
864
865
866
#define get_Block_block_visited(node)         _get_Block_block_visited(node)
#define set_Block_block_visited(node, visit)  _set_Block_block_visited(node, visit)
#define mark_Block_block_visited(node)        _mark_Block_block_visited(node)
#define Block_not_block_visited(node)         _Block_not_block_visited(node)
#define set_Block_dead(block)                 _set_Block_dead(block)
#define is_Block_dead(block)                  _is_Block_dead(block)
#define get_Const_tarval(node)                _get_Const_tarval(node)
#define classify_Const(node)                  _classify_Const(node)
Michael Beck's avatar
Michael Beck committed
867
#define is_irn_forking(node)                  _is_irn_forking(node)
Michael Beck's avatar
Michael Beck committed
868
#define get_irn_type(node)                    _get_irn_type(node)
Michael Beck's avatar
Michael Beck committed
869
870
#define get_irn_type_attr(node)               _get_irn_type_attr(node)
#define get_irn_entity_attr(node)             _get_irn_entity_attr(node)
Michael Beck's avatar
Michael Beck committed
871
#define is_irn_constlike(node)                _is_irn_constlike(node)
Michael Beck's avatar
Michael Beck committed
872
#define is_irn_always_opt(node)               _is_irn_always_opt(node)
Michael Beck's avatar
Michael Beck committed
873
#define is_irn_keep(node)                     _is_irn_keep(node)
874
875
876
#define is_irn_machine_op(node)               _is_irn_machine_op(node)
#define is_irn_machine_operand(node)          _is_irn_machine_operand(node)
#define is_irn_machine_user(node, n)          _is_irn_machine_user(node, n)
877
878
#define get_Cond_jmp_pred(node)               _get_Cond_jmp_pred(node)
#define set_Cond_jmp_pred(node, pred)         _set_Cond_jmp_pred(node, pred)
Michael Beck's avatar
Michael Beck committed
879
#define get_Psi_n_conds(node)                 _get_Psi_n_conds(node)
880
#define get_irn_idx(node)                     _get_irn_idx(node)
Götz Lindenmaier's avatar
Götz Lindenmaier committed
881

Götz Lindenmaier's avatar
Götz Lindenmaier committed
882
# endif /* _IRNODE_T_H_ */