** changed typo in new_r_Raise
[libfirm] / ir / ir / irnode_t.h
1 /* Copyright (C) 1998 - 2000 by Universitaet Karlsruhe
2 ** All rights reserved.
3 **
4 ** Authors: Martin Trapp, Christian Schaefer
5 **
6 ** declarations of an ir node
7 */
8
9 # ifndef _IRNODE_T_H_
10 # define _IRNODE_T_H_
11
12 # include "irnode.h"
13 # include "xprintf.h"
14 # include "irop_t.h"
15
16 /** ir node attributes **/
17 /* Block attributes */
18 typedef struct {
19   unsigned long block_visited;  /* for the walker that walks over all blocks. */
20   /* Attributes private to construction: */
21   bool matured;               /* if set, all in-nodes of the block are fixed */
22   struct ir_node **graph_arr; /* array to store all parameters */
23 } block_attr;
24
25 /* Cond attributes */
26 typedef struct {
27   cond_kind kind;    /* flavor of Cond */
28   long default_proj; /* for optimization: biggest Proj number, i.e. the one
29                         used for default. */
30 } cond_attr;
31
32 /* SymConst attributes */
33 /*   This union contains the symbolic information represented by the node */
34 typedef union type_or_id {
35   type *typ;
36   ident *ptrinfo;
37 } type_or_id;
38
39 typedef struct {
40   type_or_id tori;
41   symconst_kind num;
42 } symconst_attr;
43
44 /* Sel attributes */
45 typedef struct {
46   entity *ent;          /* entity to select */
47   linkage_type ltyp;    /* linkage type of the entity */
48 } sel_attr;
49
50 /* Alloc attributes */
51 typedef struct {
52   type *type;           /* Type of the allocated object.  */
53   where_alloc where;    /* stack, heap or other managed part of memory */
54 } alloc_attr;
55
56 /* Some irnodes just have one attribute, these are stored here,
57    some have more. Their name is 'irnodename_attr' */
58 typedef union {
59   block_attr     block; /* For Block: Fields needed to construct it */
60   cond_attr      c;     /* For Cond. */
61   struct tarval *con;   /* For Const: contains the value of the constant */
62   symconst_attr  i;     /* For SymConst. */
63   sel_attr       s;     /* For Sel. */
64   type          *call;  /* For Call: pointer to the type of the method to call */
65   long           proj;  /* For Proj: contains the result position to project */
66   alloc_attr     a;     /* For Alloc. */
67   type          *f;     /* For Free. */
68   int            phi0_pos;  /* For Phi. Used to remember the value defined by
69                                this Phi node.  Needed when the Phi is completed
70                                to call get_r_internal_value to find the
71                                predecessors. If this attribute is set, the Phi
72                                node takes the role of the obsolete Phi0 node,
73                                therefore the name. */
74 } attr;
75
76
77 /* common structure of an irnode */
78 /* if the node has some attributes, they are stored in attr */
79
80 struct ir_node {
81   firm_kind kind;          /* distinguishes this node from others */
82   ir_op *op;               /* Opcode of this node. */
83   ir_mode *mode;           /* Mode of this node. */
84   unsigned long visited;   /* visited counter for walks of the graph */
85   struct ir_node **in;     /* array with predecessors / operands */
86   struct ir_node *link;    /* for linking nodes somehow to a list, e.g.
87                               used while construction to link Phi0 nodes and
88                               during optimization to link to nodes that
89                               shall replace a node. */
90 #ifdef DEBUG_libfirm
91   int node_nr;             /* a unique node number for each node to make output
92                               readable. */
93 #endif
94   attr attr;               /* attribute of this node. Depends on opcode. */
95                            /* Must be last field of struct ir_node. */
96 };
97
98 /* Copies all attributes stored in the old node  to the new node.
99    Assumes both have the same opcode and sufficient size. */
100 void
101 copy_attrs (ir_node *old, ir_node *new);
102
103
104 /* Print IR-Nodes with attributes */
105 /* @@@@ brauchen wir dienoch? dann fliegt ev. das xprint raus?*/
106 int ir_node_print (XP_PAR1, const xprintf_info *, XP_PARN);
107
108
109 /** access attributes directly **/
110 inline tarval       *get_irn_const_attr    (ir_node *node);
111 inline long          get_irn_proj_attr     (ir_node *node);
112 inline alloc_attr    get_irn_alloc_attr    (ir_node *node);
113 inline type         *get_irn_free_attr     (ir_node *node);
114 inline symconst_attr get_irn_symconst_attr (ir_node *node);
115 type         *get_irn_call_attr     (ir_node *node);
116 sel_attr      get_irn_sel_attr      (ir_node *node);
117 int           get_irn_phi_attr      (ir_node *node);
118 block_attr    get_irn_return_attr   (ir_node *node);
119
120 # endif /* _IRNODE_T_H_ */