irnode_t.h 23.4 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
  struct ir_node **graph_arr; /**< array to store all parameters */
54
  /* Attributes holding analyses information */
Michael Beck's avatar
Michael Beck committed
55
  struct dom_info dom;        /**< Datastructure that holds information about dominators.
56
57
58
59
60
61
                 @@@ @todo
                 Eventually overlay with graph_arr as only valid
                 in different phases.  Eventually inline the whole
                 datastructure. */
  /*   exc_t exc;  */            /**< role of this block for exception handling */
  /*   ir_node *handler_entry; */    /**< handler entry block iff this block is part of a region */
Michael Beck's avatar
Michael Beck committed
62
  ir_node ** in_cg;           /**< array with predecessors in
63
64
                   * interprocedural_view, if they differ
                   * from intraprocedural predecessors */
Michael Beck's avatar
Michael Beck committed
65
  int *backedge;              /**< Field n set to true if pred n is backedge.
66
                     @@@ @todo Ev. replace by bitfield! */
Michael Beck's avatar
Michael Beck committed
67
  int *cg_backedge;           /**< Field n set to true if pred n is interprocedural backedge.
68
                     @@@ @todo Ev. replace by bitfield! */
69
70
  ir_extblk *extblk;          /**< the extended basic block this block belongs to */

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

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

75
76
/** Start attributes */
typedef struct {
77
  char dummy;
78
  /*   ir_graph *irg;   @@@ now in block */
79
80
} start_attr;

Michael Beck's avatar
Michael Beck committed
81
/** Cond attributes */
82
typedef struct {
83
84
85
  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. */
86
87
} cond_attr;

88
89
90
91
92
93
/** Const attributes */
typedef struct {
  tarval *tv;        /**< the target value */
  type   *tp;        /**< the source type, for analyses. default: type_unknown. */
} const_attr;

Götz Lindenmaier's avatar
Götz Lindenmaier committed
94
typedef struct {
Beyhan's avatar
Beyhan committed
95
  symconst_symbol sym;  // old tori
Götz Lindenmaier's avatar
Götz Lindenmaier committed
96
  symconst_kind num;
Beyhan's avatar
Beyhan committed
97
  type *tp;          /**< the source type, for analyses. default: type_unknown. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
98
99
} symconst_attr;

Michael Beck's avatar
Michael Beck committed
100
/** Sel attributes */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
101
typedef struct {
Michael Beck's avatar
Michael Beck committed
102
  entity *ent;          /**< entity to select */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
103
104
} sel_attr;

Michael Beck's avatar
Michael Beck committed
105
/** Exception attributes */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
106
typedef struct {
Michael Beck's avatar
Michael Beck committed
107
108
109
  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
110
#if PRECISE_EXC_CONTEXT
Michael Beck's avatar
Michael Beck committed
111
  struct ir_node **frag_arr;    /**< For Phi node construction in case of exception */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
112
#endif
Michael Beck's avatar
Michael Beck committed
113
114
115
116
117
118
} except_attr;

typedef struct {
  except_attr    exc;           /**< the exception attribute. MUST be the first one. */
  type *cld_tp;                 /**< type of called procedure */
  entity ** callee_arr;         /**< result of callee analysis */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
119
120
} call_attr;

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

Michael Beck's avatar
Michael Beck committed
128
129
130
131
132
133
/** Free attributes */
typedef struct {
  type *type;                   /**< Type of the allocated object.  */
  where_alloc where;            /**< stack, heap or other managed part of memory */
} free_attr;

Michael Beck's avatar
Michael Beck committed
134
/** InstOf attributes */
135
136
137
138
139
140
typedef struct
{
  type *ent;
  int dfn;
} io_attr;

Michael Beck's avatar
Michael Beck committed
141
/** Filter attributes */
142
typedef struct {
Michael Beck's avatar
Michael Beck committed
143
144
145
  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.
146
                     @todo Ev. replace by bitfield! */
147
148
} filter_attr;

Michael Beck's avatar
Michael Beck committed
149
/** EndReg/EndExcept attributes */
150
typedef struct {
151
  char dummy;
152
153
} end_attr;

Michael Beck's avatar
Michael Beck committed
154
/** CallBegin attributes */
155
typedef struct {
Michael Beck's avatar
Michael Beck committed
156
  ir_node * call;               /**< associated Call-operation */
157
158
} callbegin_attr;

Götz Lindenmaier's avatar
Götz Lindenmaier committed
159
160
/** Cast attributes */
typedef struct {
Michael Beck's avatar
Michael Beck committed
161
  type *totype;                 /**< type of the casted node */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
162
163
} cast_attr;

164
165
/** Load attributes */
typedef struct {
Michael Beck's avatar
Michael Beck committed
166
167
  except_attr    exc;           /**< the exception attribute. MUST be the first one. */
  ir_mode        *load_mode;    /**< the mode of this Load operation */
Michael Beck's avatar
Michael Beck committed
168
  ent_volatility volatility;	  /**< the volatility of a Load/Store operation */
169
170
171
172
} load_attr;

/** Store attributes */
typedef struct {
Michael Beck's avatar
Michael Beck committed
173
  except_attr    exc;           /**< the exception attribute. MUST be the first one. */
Michael Beck's avatar
Michael Beck committed
174
  ent_volatility volatility;	  /**< the volatility of a Store operation */
175
176
} store_attr;

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

Michael Beck's avatar
Michael Beck committed
179
180
181
182
183
typedef struct {
  except_attr    exc;           /**< the exception attribute. MUST be the first one. */
  type           *data_type;    /**< type of the copied entity */
} copyb_attr;

Sebastian Hack's avatar
Sebastian Hack committed
184
185
186
187
/**
 * Edge info to put into an irn.
 */
typedef struct _irn_edge_info_t {
Michael Beck's avatar
Michael Beck committed
188
189
  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
190
191
192
} irn_edge_info_t;


Michael Beck's avatar
Michael Beck committed
193
/** Some IR-nodes just have one attribute, these are stored here,
Götz Lindenmaier's avatar
Götz Lindenmaier committed
194
195
   some have more. Their name is 'irnodename_attr' */
typedef union {
196
  start_attr     start; /**< For Start */
Michael Beck's avatar
Michael Beck committed
197
198
  block_attr     block; /**< For Block: Fields needed to construct it */
  cond_attr      c;     /**< For Cond. */
199
  const_attr     con;   /**< For Const: contains the value of the constant and a type */
Michael Beck's avatar
Michael Beck committed
200
201
202
203
  symconst_attr  i;     /**< For SymConst. */
  sel_attr       s;     /**< For Sel. */
  call_attr      call;  /**< For Call: pointer to the type of the method to call */
  callbegin_attr callbegin; /**< For CallBegin */
Michael Beck's avatar
Michael Beck committed
204
205
  alloc_attr     a;    /**< For Alloc. */
  free_attr      f;    /**< For Free. */
Michael Beck's avatar
Michael Beck committed
206
  io_attr        io;    /**< For InstOf */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
207
  cast_attr      cast;  /**< For Cast. */
208
209
  load_attr      load;  /**< For Load. */
  store_attr     store;  /**< For Store. */
Michael Beck's avatar
Michael Beck committed
210
  int            phi0_pos;  /**< For Phi. Used to remember the value defined by
211
212
213
214
215
                   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
216
  int *phi_backedge;    /**< For Phi after construction.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
217
218
			   Field n set to true if pred n is backedge.
			   @todo Ev. replace by bitfield! */
Michael Beck's avatar
Michael Beck committed
219
  long           proj;          /**< For Proj: contains the result position to project */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
220
  confirm_attr   confirm_cmp;   /**< For Confirm: compare operation */
Michael Beck's avatar
Michael Beck committed
221
222
223
224
  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 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
225
226
227
} attr;


Michael Beck's avatar
Michael Beck committed
228
229
/** 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
230
struct ir_node {
Michael Beck's avatar
Michael Beck committed
231
232
233
234
235
236
237
  /* ------- 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. */
  unsigned long visited;   /**< visited counter for walks of the graph */
  struct ir_node **in;     /**< array with predecessors / operands */
  void *link;              /**< to attach additional information to the node, e.g.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
238
                              used while construction to link Phi0 nodes and
Götz Lindenmaier's avatar
Götz Lindenmaier committed
239
240
			      during optimization to link to nodes that
			      shall replace a node. */
Michael Beck's avatar
Michael Beck committed
241
  /* ------- Fields for optimizations / analysis information ------- */
Sebastian Hack's avatar
Sebastian Hack committed
242
  struct ir_node **out;    /**< @deprecated array of out edges. */
Michael Beck's avatar
Michael Beck committed
243
244
  struct dbg_info* dbi;    /**< A pointer to information for debug support. */
  /* ------- For debugging ------- */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
245
#ifdef DEBUG_libfirm
Sebastian Hack's avatar
Sebastian Hack committed
246
	int out_valid;
Michael Beck's avatar
Michael Beck committed
247
  int node_nr;             /**< a unique node number for each node to make output
Götz Lindenmaier's avatar
Götz Lindenmaier committed
248
			      readable. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
249
#endif
Götz Lindenmaier's avatar
Götz Lindenmaier committed
250
251
  /* ------- 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
252
253
254
#ifdef  DO_HEAPANALYSIS
  struct abstval *av;
  struct section *sec;
Sebastian Hack's avatar
Sebastian Hack committed
255
#endif
256
#if FIRM_EDGES_INPLACE
Michael Beck's avatar
Michael Beck committed
257
  irn_edge_info_t edge_info;  /**< everlasting out edges */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
258
#endif
Götz Lindenmaier's avatar
Götz Lindenmaier committed
259
  /* ------- Opcode depending fields -------- */
Michael Beck's avatar
Michael Beck committed
260
261
  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
262
263
};

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

Michael Beck's avatar
Michael Beck committed
265
/** Returns the array with the ins.  The content of the array may not be
266
   changed.  */
267
ir_node     **get_irn_in            (const ir_node *node);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
268

Michael Beck's avatar
Michael Beck committed
269
/** @{ */
Michael Beck's avatar
Michael Beck committed
270
/** access attributes directly */
271
272
273
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
274
free_attr     get_irn_free_attr     (ir_node *node);
275
276
277
278
279
280
281
282
283
symconst_attr get_irn_symconst_attr (ir_node *node);
type         *get_irn_call_attr     (ir_node *node);
type         *get_irn_funccall_attr (ir_node *node);
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
284
/** @} */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
285

286
/**
287
288
289
290
 * 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
291
292
293
294
295
296
297
298
299
300
/**
 * 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);
301

Michael Beck's avatar
Michael Beck committed
302
/*-------------------------------------------------------------------*/
Götz Lindenmaier's avatar
Götz Lindenmaier committed
303
304
/*  These function are most used in libfirm.  Give them as static    */
/*  functions so they can be inlined.                                */
Michael Beck's avatar
Michael Beck committed
305
/*-------------------------------------------------------------------*/
Götz Lindenmaier's avatar
Götz Lindenmaier committed
306

307
308
309
310
311
/**
 * Checks whether a pointer points to a ir node.
 * Intern version for libFirm.
 */
static INLINE int
312
_is_ir_node (const void *thing) {
313
314
  return (get_kind(thing) == k_ir_node);
}
Götz Lindenmaier's avatar
Götz Lindenmaier committed
315

316
317
318
319
320
/**
 * Gets the op of a node.
 * Intern version for libFirm.
 */
static INLINE ir_op *
321
_get_irn_op (const ir_node *node) {
322
323
324
325
  assert (node);
  return node->op;
}

326
327
328
329
/** 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) {
330
  ir_op *op = _get_irn_op(old_node);
331
332

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

336
337
338
339
340
/**
 * Gets the opcode of a node.
 * Intern version for libFirm.
 */
static INLINE opcode
341
_get_irn_opcode (const ir_node *node) {
342
  assert (k_ir_node == get_kind(node));
343
  assert (node->op);
344
345
  return node->op->code;
}
Götz Lindenmaier's avatar
Götz Lindenmaier committed
346

Michael Beck's avatar
Michael Beck committed
347
348
349
350
/**
 * Returns the number of predecessors without the block predecessor.
 * Intern version for libFirm.
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
351
static INLINE int
352
_get_irn_intra_arity (const ir_node *node) {
Götz Lindenmaier's avatar
Götz Lindenmaier committed
353
354
355
356
  assert(node);
  return ARR_LEN(node->in) - 1;
}

Michael Beck's avatar
Michael Beck committed
357
358
359
360
/**
 * Returns the number of predecessors without the block predecessor.
 * Intern version for libFirm.
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
361
static INLINE int
362
_get_irn_inter_arity (const ir_node *node) {
Götz Lindenmaier's avatar
Götz Lindenmaier committed
363
  assert(node);
364
  if (_get_irn_opcode(node) == iro_Filter) {
Götz Lindenmaier's avatar
Götz Lindenmaier committed
365
366
    assert(node->attr.filter.in_cg);
    return ARR_LEN(node->attr.filter.in_cg) - 1;
367
  } else if (_get_irn_opcode(node) == iro_Block && node->attr.block.in_cg) {
Götz Lindenmaier's avatar
Götz Lindenmaier committed
368
369
    return ARR_LEN(node->attr.block.in_cg) - 1;
  }
370
  return _get_irn_intra_arity(node);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
371
372
}

Michael Beck's avatar
Michael Beck committed
373
374
375
376
/**
 * Returns the number of predecessors without the block predecessor.
 * Intern version for libFirm.
 */
377
extern int (*_get_irn_arity)(const ir_node *node);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
378

Michael Beck's avatar
Michael Beck committed
379
380
381
/**
 * Intern version for libFirm.
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
382
static INLINE ir_node *
383
384
_get_irn_intra_n (const ir_node *node, int n) {
  assert(node); assert(-1 <= n && n < _get_irn_intra_arity(node));
385

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

Michael Beck's avatar
Michael Beck committed
389
390
391
/**
 * Intern version for libFirm.
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
392
static INLINE ir_node*
393
394
_get_irn_inter_n (const ir_node *node, int n) {
  assert(node); assert(-1 <= n && n < _get_irn_inter_arity(node));
395

Götz Lindenmaier's avatar
Götz Lindenmaier committed
396
  /* handle Filter and Block specially */
397
  if (_get_irn_op(node) == op_Filter) {
Götz Lindenmaier's avatar
Götz Lindenmaier committed
398
    assert(node->attr.filter.in_cg);
399
    return (node->attr.filter.in_cg[n + 1] = skip_Id(node->attr.filter.in_cg[n + 1]));
400
  } else if (_get_irn_op(node) == op_Block && node->attr.block.in_cg) {
401
    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
402
403
  }

404
  return _get_irn_intra_n (node, n);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
405
406
}

Michael Beck's avatar
Michael Beck committed
407
408
/**
 * Access to the predecessors of a node.
409
 * To iterate over the operands iterate from 0 to i < get_irn_arity(),
Michael Beck's avatar
Michael Beck committed
410
411
412
413
414
 * 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.
 */
415
extern ir_node *(*_get_irn_n)(const ir_node *node, int n);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
416

Michael Beck's avatar
Michael Beck committed
417
418
419
420
/**
 * Gets the mode of a node.
 * Intern version for libFirm.
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
421
static INLINE ir_mode *
422
_get_irn_mode (const ir_node *node)
Götz Lindenmaier's avatar
Götz Lindenmaier committed
423
424
425
426
427
{
  assert (node);
  return node->mode;
}

Michael Beck's avatar
Michael Beck committed
428
/**
429
430
431
432
 * Sets the mode of a node.
 * Intern version of libFirm.
 */
static INLINE void
433
_set_irn_mode (ir_node *node, ir_mode *mode)
434
435
436
437
438
439
440
{
  assert (node);
  node->mode = mode;
}

/**
 * Gets the visited counter of a node.
Michael Beck's avatar
Michael Beck committed
441
442
 * Intern version for libFirm.
 */
443
static INLINE unsigned long
444
_get_irn_visited (const ir_node *node)
Götz Lindenmaier's avatar
Götz Lindenmaier committed
445
446
{
  assert (node);
447
  return node->visited;
Götz Lindenmaier's avatar
Götz Lindenmaier committed
448
449
}

Michael Beck's avatar
Michael Beck committed
450
/**
451
 * Sets the visited counter of a node.
Michael Beck's avatar
Michael Beck committed
452
453
 * Intern version for libFirm.
 */
454
static INLINE void
455
_set_irn_visited (ir_node *node, unsigned long visited)
Götz Lindenmaier's avatar
Götz Lindenmaier committed
456
{
457
458
459
460
461
462
463
464
465
  assert (node);
  node->visited = visited;
}

/**
 * Mark a node as visited in a graph.
 * Intern version for libFirm.
 */
static INLINE void
466
_mark_irn_visited (ir_node *node) {
467
468
469
470
471
472
473
474
475
  assert (node);
  node->visited = current_ir_graph->visited;
}

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

481
482
483
484
485
/**
 * Returns non-zero if a node of was NOT visited.
 * Intern version for libFirm.
 */
static INLINE int
486
_irn_not_visited(const ir_node *node) {
487
488
489
490
491
492
493
494
495
  assert (node);
  return (node->visited < current_ir_graph->visited);
}

/**
 * Sets the link of a node.
 * Intern version of libFirm.
 */
static INLINE void
496
_set_irn_link(ir_node *node, void *link) {
497
498
499
  assert (node);
  /* Link field is used for Phi construction and various optimizations
     in iropt. */
500
  assert(get_irg_phase_state(get_irn_irg(node)) != phase_building);
501
502
503
504
505
506
507
508
509

  node->link = link;
}

/**
 * Returns the link of a node.
 * Intern version of libFirm.
 */
static INLINE void *
510
511
_get_irn_link(const ir_node *node) {
  assert (node && _is_ir_node(node));
512
513
  return node->link;
}
Götz Lindenmaier's avatar
Götz Lindenmaier committed
514

Michael Beck's avatar
Michael Beck committed
515
/**
516
517
518
 * 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
519
520
521
 * Intern version of libFirm.
 */
static INLINE op_pin_state
522
523
524
_get_irn_pinned(const ir_node *node) {
  op_pin_state state;
  assert(node && _is_ir_node(node));
525
  /* Check opcode */
526
  state = _get_op_pinned(_get_irn_op(node));
527

528
  if (state >= op_pin_state_exc_pinned)
Michael Beck's avatar
Michael Beck committed
529
530
531
532
    return get_opt_fragile_ops() ? node->attr.except.pin_state : op_pin_state_pinned;
  return state;
}

533
534
static INLINE op_pin_state
_is_irn_pinned_in_irg(const ir_node *node) {
Michael Beck's avatar
Michael Beck committed
535
536
  if (get_irg_pinned(get_irn_irg(node)) == op_pin_state_floats)
    return get_irn_pinned(node);
537
538
539
  return op_pin_state_pinned;
}

Michael Beck's avatar
Michael Beck committed
540
static INLINE int
541
542
_is_unop(const ir_node *node) {
  assert(node && _is_ir_node(node));
Michael Beck's avatar
Michael Beck committed
543
544
545
546
  return (node->op->opar == oparity_unary);
}

static INLINE int
547
548
_is_binop(const ir_node *node) {
  assert(node && _is_ir_node(node));
Michael Beck's avatar
Michael Beck committed
549
550
551
552
  return (node->op->opar == oparity_binary);
}

static INLINE int
553
_is_Bad(const ir_node *node) {
Michael Beck's avatar
Michael Beck committed
554
  assert(node);
555
  return (node && _get_irn_op(node) == op_Bad);
Michael Beck's avatar
Michael Beck committed
556
557
}

Sebastian Hack's avatar
Sebastian Hack committed
558
559
static INLINE int
_is_Const(const ir_node *node) {
Michael Beck's avatar
Michael Beck committed
560
  assert(node);
Sebastian Hack's avatar
Sebastian Hack committed
561
562
563
  return (node && _get_irn_op(node) == op_Const);
}

Michael Beck's avatar
Michael Beck committed
564
565
566
567
568
569
static INLINE int
_is_Unknown (const ir_node *node) {
  assert(node);
  return (node && _get_irn_op(node) == op_Unknown);
}

Michael Beck's avatar
Michael Beck committed
570
static INLINE int
571
572
573
_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
574
575
576
}

static INLINE int
577
578
579
_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
580
581
}

582
583
584
585
586
587
588
589
590
591
592
593
594
static INLINE int
_get_Block_n_cfgpreds (ir_node *node) {
  assert(_is_Block(node));
  return _get_irn_arity(node);
}

static INLINE ir_node *
_get_Block_cfgpred (ir_node *node, int pos) {
  assert(0 <= pos && pos < get_irn_arity(node));
  assert(_is_Block(node));
  return _get_irn_n(node, pos);
}

595
596
/* Get the predecessor block.
 *
597
 *  Returns the block corresponding to the predecessor pos.
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
 *
 *  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
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
static INLINE unsigned long
_get_Block_block_visited (ir_node *node) {
  assert (node->op == op_Block);
  return node->attr.block.block_visited;
}

static INLINE void
_set_Block_block_visited (ir_node *node, unsigned long visit) {
  assert (node->op == op_Block);
  node->attr.block.block_visited = visit;
}

/* For this current_ir_graph must be set. */
static INLINE void
_mark_Block_block_visited (ir_node *node) {
  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));
}

639
static INLINE ir_node *
640
641
_set_Block_dead(ir_node *block) {
  assert(_get_irn_op(block) == op_Block);
642
643
644
645
646
  block->attr.block.dead = 1;
  return block;
}

static INLINE int
647
648
_is_Block_dead(const ir_node *block) {
  ir_op * op = _get_irn_op(block);
649
650
651
652
653
654
655
656
657

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

Sebastian Hack's avatar
Sebastian Hack committed
658
static INLINE tarval *_get_Const_tarval (ir_node *node) {
659
  assert (_get_irn_op(node) == op_Const);
Sebastian Hack's avatar
Sebastian Hack committed
660
661
662
  return node->attr.con.tv;
}

663
664
static INLINE cnst_classify_t _classify_Const(ir_node *node) {
  ir_op *op;
Sebastian Hack's avatar
Sebastian Hack committed
665
666
  assert(_is_ir_node(node));

667
  op = _get_irn_op(node);
Sebastian Hack's avatar
Sebastian Hack committed
668

669
670
671
672
  if(op == op_Const)
    return classify_tarval(_get_Const_tarval(node));
  else if(op == op_SymConst)
    return CNST_SYMCONST;
Sebastian Hack's avatar
Sebastian Hack committed
673

674
  return CNST_NO_CONST;
Sebastian Hack's avatar
Sebastian Hack committed
675
676
}

Michael Beck's avatar
Michael Beck committed
677
678
679
680
static INLINE int _is_irn_forking(const ir_node *node) {
  return is_op_forking(_get_irn_op(node));
}

681
static INLINE type *_get_irn_type(ir_node *node) {
Michael Beck's avatar
Michael Beck committed
682
  return _get_irn_op(node)->ops.get_type(node);
683
}
Sebastian Hack's avatar
Sebastian Hack committed
684

Michael Beck's avatar
Michael Beck committed
685
686
687
688
static INLINE int _is_irn_constlike(const ir_node *node) {
  return is_op_constlike(_get_irn_op(node));
}

689
690
691
692
693
694
695
696
697
698
static INLINE cond_jmp_predicate _get_Cond_jmp_pred(ir_node *node) {
  assert (_get_irn_op(node) == op_Cond);
  return node->attr.c.pred;
}

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

699
/* this section MUST contain all inline functions */
Michael Beck's avatar
Michael Beck committed
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
#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)
#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)
718
719
#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
720
721
#define is_unop(node)                         _is_unop(node)
#define is_binop(node)                        _is_binop(node)
Sebastian Hack's avatar
Sebastian Hack committed
722
#define is_Const(node)                        _is_Const(node)
Michael Beck's avatar
Michael Beck committed
723
#define is_Unknown(node)                      _is_Unknown(node)
Michael Beck's avatar
Michael Beck committed
724
725
726
#define is_Bad(node)                          _is_Bad(node)
#define is_no_Block(node)                     _is_no_Block(node)
#define is_Block(node)                        _is_Block(node)
727
728
#define get_Block_n_cfgpreds(node)            _get_Block_n_cfgpreds(node)
#define get_Block_cfgpred(node, pos)          _get_Block_cfgpred(node, pos)
729
#define get_Block_cfgpred_block(node, pos)    _get_Block_cfgpred_block(node, pos)
Michael Beck's avatar
Michael Beck committed
730
731
732
733
734
735
736
737
#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
738
#define is_irn_forking(node)                  _is_irn_forking(node)
Michael Beck's avatar
Michael Beck committed
739
#define get_irn_type(node)                    _get_irn_type(node)
Michael Beck's avatar
Michael Beck committed
740
#define is_irn_constlike(node)                _is_irn_constlike(node)
741
742
#define get_Cond_jmp_pred(node)               _get_Cond_jmp_pred(node)
#define set_Cond_jmp_pred(node, pred)         _set_Cond_jmp_pred(node, pred)
Götz Lindenmaier's avatar
Götz Lindenmaier committed
743

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