2 ** Copyright (C) 1998 - 2000 by Universitaet Karlsruhe
3 ** All rights reserved.
5 ** Authors: Martin Trapp, Christian Schaefer,
8 ** entity.h: entities represent all program known objects.
10 ** An entity is the representation of program known objects in Firm.
11 ** The primary concept of entities is to represent members of complex
12 ** types, i.e., fields and methods of classes. As not all programming
13 ** language model all variables and methods as members of some class,
14 ** the concept of entities is extended to cover also local and global
15 ** variables, and arbitrary procedures.
17 ** An entity always specifies the type of the object it represents and
18 ** the type of the object it is a part of, the owner of the entity.
19 ** Originally this is the type of the class of which the entity is a
21 ** The owner of local variables is the procedure they are defined in.
22 ** The owner of global variables and procedures visible in the whole
23 ** program is a universally defined class type "GlobalType". The owner
24 ** of procedures defined in the scope of an other procedure is the
25 ** enclosing procedure.
27 ** In detail the datastructure entity has the following fields:
29 ** ident *name Name of this entity as specified in the source code.
30 ** Only unequivocal in conjuction with scope.
31 ** ident *ld_name Unique name of this entity, i.e., the mangled
32 ** name. E.g., for a class `A' with field `a' this
33 ** is the ident for `A_a'.
34 ** type *type The type of this entity, e.g., a method type, a
35 ** basic type of the language or a class itself.
36 ** type *owner; The class this entity belongs to. In case of local
37 ** variables the method they are defined in.
38 ** int offset; Offset in byte for this entity. Fixed when layout
39 ** of owner is determined.
40 ** ir_graph *irg; If (type == method_type) this is the corresponding irg.
41 ** The ir_graph constructor automatically sets this field.
42 ** If (type !- method_type) access of this field will cause
54 /*******************************************************************/
56 /*******************************************************************/
58 /* initalize entity module */
59 void init_entity (void);
61 /*******************************************************************/
63 /*******************************************************************/
65 #ifndef _IR_GRAPH_TYPEDEF_
66 #define _IR_GRAPH_TYPEDEF_
67 /* to resolve recursion between entity.h and irgraph.h */
68 typedef struct ir_graph ir_graph;
74 * entity - An abstract data type to represent program entites.
78 * owner A compound type this entity is a part of.
79 * type The type of this entity.
80 * name The string that represents this entity in the source program.
81 * allocation A flag saying whether the entity is dynamically or statically
82 * allocated (values: dynamic_allocated, static_allocated,
83 * automatic_allocated).
84 * visibility A flag indicating the visibility of this entity (values: local,
85 * external_visible, external_allocated)
86 * variability A flag indicating the variability of this entity (values:
87 * uninitialized, initalized, part_constant, constant)
88 * offset The offset of the entity within the compound object. Only set
89 * if the owner in the state "layout_fixed".
90 * overwrites A list of entities overwritten by this entity. This list is only
91 * existent if the owner of this entity is a class. The members in
92 * this list must be entities of super classes.
93 * link A void* to associate some additional information with the entity.
94 * irg If the entity is a method this is the ir graph that represents the
96 * peculiarity The peculiarity of the entity. If the entity is a method this
97 * indicates whether the entity represents
98 * a real method or whether it only exists to describe an interface.
99 * In that case there nowhere exists code for this entity and this entity
100 * is never dynamically used in the code.
101 * Values: description, existent. Default: existent.
103 * These fields can only be accessed via access functions.
110 #ifndef _ENTITY_TYPEDEF_
111 #define _ENTITY_TYPEDEF_
112 /* to resolve recursion between entity.h and type.h */
113 typedef struct entity entity;
116 /* Creates a new entity.
117 Automatically inserts the entity as a member of owner.
118 Entity is automatic_allocated and uninitialize except if the type
119 is type_method, then it is static_allocated and constant. The constant
120 value is a pointer to the method.
121 Visibility is local, offset -1, and it is not volatile. */
122 entity *new_entity (type *owner, ident *name, type *type);
123 /* Copies the entity if the new_owner is different from the
124 owner of the old entity. Else returns the old entity.
125 Automatically inserts the new entity as a member of owner. */
126 entity *copy_entity_own (entity *old, type *new_owner);
127 /* Copies the entity if the new_name is different from the
128 name of the old entity. Else returns the old entity.
129 Automatically inserts the new entity as a member of owner.
130 The mangled name ld_name is set to NULL. */
131 entity *copy_entity_name (entity *old, ident *new_name);
133 /** manipulate fields of entity **/
134 const char *get_entity_name (entity *ent);
135 ident *get_entity_ident (entity *ent);
136 /* returns the mangled name of the entity. If the mangled name is
137 set it returns the existing name. Else it generates a name
138 with mangle_entity() and remembers this new name internally. */
139 ident *get_entity_ld_ident (entity *ent);
140 void set_entity_ld_ident (entity *ent, ident *ld_ident);
141 const char *get_entity_ld_name (entity *end);
144 char *get_entity_ld_name (entity *ent);
145 void set_entity_ld_name (entity *ent, char *ld_name);
148 type *get_entity_owner (entity *ent);
149 /* Sets the owner field in entity to owner. */
150 void set_entity_owner (entity *ent, type *owner);
151 inline void assert_legal_owner_of_ent(type *owner);
153 type *get_entity_type (entity *ent);
154 void set_entity_type (entity *ent, type *type);
157 automatic_allocated,/* The entity is allocated during runtime, implicitly
158 as component of a compound type. This is the default. */
159 dynamic_allocated, /* The entity is allocated during runtime, explicitly
161 static_allocated /* The entity is allocated statically. We can use a
162 SymConst(?) as address of the entity. */
165 ent_allocation get_entity_allocation (entity *ent);
166 void set_entity_allocation (entity *ent, ent_allocation al);
168 /* This enumeration flags the visibility of entities. This is necessary
169 for partial compilation. */
171 local, /* The entity is only visible locally. This is the default. */
172 external_visible, /* The entity is visible to other external program parts, but
173 it is defined here. It may not be optimized away. The entity must
174 be static_allocated. */
175 external_allocated /* The entity is defined and allocated externaly. This compilation
176 must not allocate memory for this entity. The entity must
177 be static_allocated. */
180 ent_visibility get_entity_visibility (entity *ent);
181 void set_entity_visibility (entity *ent, ent_visibility vis);
183 /* This enumeration flags the variability of entities. */
185 uninitialized, /* The content of the entity is completely unknown. */
186 initialized, /* After allocation the entity is initalized with the
187 value given somewhere in the entity. */
188 part_constant, /* For entities of compound types. Some members of the entity
189 are constant. The others are uninitialized. Those members
190 given a value for are constant. */
191 constant /* The entity is constant. */
194 ent_variability get_entity_variability (entity *ent);
195 void set_entity_variability (entity *ent, ent_variability var);
197 /* This enumeration flags the volatility of entities. */
199 non_volatile, /* The entity is not volatile */
200 is_volatile /* The entity is volatile */
203 ent_volatility get_entity_volatility (entity *ent);
204 void set_entity_volatility (entity *ent, ent_volatility vol);
206 /* For the definition of enumeration peculiarity see type.h */
207 peculiarity get_entity_peculiarity (entity *ent);
208 void set_entity_peculiarity (entity *ent, peculiarity pec);
210 /* Set has no effect for entities of type method. */
211 ir_node *get_atomic_ent_value(entity *ent);
212 void set_atomic_ent_value(entity *ent, ir_node *val);
213 /* Copies the value represented by the entity to current_block
214 in current_ir_graph. */
215 ir_node *copy_atomic_ent_value(entity *ent);
217 /* A value of a compound entity is a pair of value and the corresponding
218 member of the compound. */
219 void add_compound_ent_value(entity *ent, ir_node *val, entity *member);
220 int get_compound_ent_n_values(entity *ent);
221 ir_node *get_compound_ent_value(entity *ent, int pos);
222 entity *get_compound_ent_value_member(entity *ent, int pos);
223 void set_compound_ent_value(entity *ent, ir_node *val, entity *member, int pos);
224 /* Copies the value pos of the entity to current_block in current_ir_graph. */
225 ir_node *copy_compound_ent_value(entity *ent, int pos);
227 /* Only set if layout = fixed. */
228 int get_entity_offset (entity *ent);
229 void set_entity_offset (entity *ent, int offset);
231 /* Overwrites is a field that specifies that an access to the overwritten
232 entity in the supertype must use this entity. It's a list as with
233 multiple inheritance several enitites can be overwritten. This field
234 is mostly useful for method entities.
235 If a Sel node selects an entity that is overwritten by other entities it
236 must return a pointer to the entity of the dynamic type of the pointer
237 that is passed to it. Lowering of the Sel node must assure this. */
238 void add_entity_overwrites (entity *ent, entity *overwritten);
239 int get_entity_n_overwrites (entity *ent);
240 entity *get_entity_overwrites (entity *ent, int pos);
241 void set_entity_overwrites (entity *ent, int pos, entity *overwritten);
242 /* Do we need a second relation "overwritten"? */
244 /* A link to store intermediate information */
245 void* get_entity_link(entity *ent);
246 void set_entity_link(entity *ent, void *l);
248 /* The entity knows the corresponding irg if the entity is a method.
249 This allows to get from a Call to the called irg. */
250 ir_graph *get_entity_irg(entity *ent);
251 void set_entity_irg(entity *ent, ir_graph *irg);
254 /* Returns true if the type of the entity is a primitive, pointer
255 enumeration or method type. */
256 int is_atomic_entity(entity *ent);
257 /* Returns true if the type of the entity is a class, structure,
258 array or union type. */
259 int is_compound_entity(entity *ent);
264 # endif /* _ENTITY_H_ */