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)
89 * offset The offset of the entity within the compound object. Only set
90 * if the owner in the state "layout_fixed".
91 * overwrites A list of entities overwritten by this entity. This list is only
92 * existent if the owner of this entity is a class. The members in
93 * this list must be entities of super classes.
94 * overwrittenby A list of entities that overwrite this entity. This list is only
95 * existent if the owner of this entity is a class. The members in
96 * this list must be entities of sub classes.
97 * link A void* to associate some additional information with the entity.
98 * irg If the entity is a method this is the ir graph that represents the
100 * peculiarity The peculiarity of the entity. If the entity is a method this
101 * indicates whether the entity represents
102 * a real method or whether it only exists to describe an interface.
103 * In that case there nowhere exists code for this entity and this entity
104 * is never dynamically used in the code.
105 * Values: description, existent. Default: existent.
107 * These fields can only be accessed via access functions.
114 #ifndef _ENTITY_TYPEDEF_
115 #define _ENTITY_TYPEDEF_
116 /* to resolve recursion between entity.h and type.h */
117 typedef struct entity entity;
120 /* Creates a new entity.
121 Automatically inserts the entity as a member of owner.
122 Entity is automatic_allocated and uninitialize except if the type
123 is type_method, then it is static_allocated and constant. The constant
124 value is a pointer to the method.
125 Visibility is local, offset -1, and it is not volatile. */
126 entity *new_entity (type *owner, ident *name, type *type);
127 /* Copies the entity if the new_owner is different from the
128 owner of the old entity. Else returns the old entity.
129 Automatically inserts the new entity as a member of owner. */
130 entity *copy_entity_own (entity *old, type *new_owner);
131 /* Copies the entity if the new_name is different from the
132 name of the old entity. Else returns the old entity.
133 Automatically inserts the new entity as a member of owner.
134 The mangled name ld_name is set to NULL. */
135 entity *copy_entity_name (entity *old, ident *new_name);
136 /* Frees the entity. The owner will still contain the pointer to this
137 entity, as well as all other references! */
138 void free_entity (entity *ent);
140 /** manipulate fields of entity **/
141 const char *get_entity_name (entity *ent);
142 ident *get_entity_ident (entity *ent);
144 /* returns the mangled name of the entity. If the mangled name is
145 set it returns the existing name. Else it generates a name
146 with mangle_entity() and remembers this new name internally. */
147 ident *get_entity_ld_ident (entity *ent);
148 void set_entity_ld_ident (entity *ent, ident *ld_ident);
149 const char *get_entity_ld_name (entity *end);
151 type *get_entity_owner (entity *ent);
152 /* Sets the owner field in entity to owner. */
153 void set_entity_owner (entity *ent, type *owner);
154 INLINE void assert_legal_owner_of_ent(type *owner);
156 type *get_entity_type (entity *ent);
157 void set_entity_type (entity *ent, type *type);
160 automatic_allocated,/* The entity is allocated during runtime, implicitly
161 as component of a compound type. This is the default. */
162 dynamic_allocated, /* The entity is allocated during runtime, explicitly
164 static_allocated /* The entity is allocated statically. We can use a
165 SymConst(?) as address of the entity. */
168 ent_allocation get_entity_allocation (entity *ent);
169 void set_entity_allocation (entity *ent, ent_allocation al);
171 /* This enumeration flags the visibility of entities. This is necessary
172 for partial compilation. */
174 local, /* The entity is only visible locally. This is the default. */
175 external_visible, /* The entity is visible to other external program parts, but
176 it is defined here. It may not be optimized away. The entity must
177 be static_allocated. */
178 external_allocated /* The entity is defined and allocated externally. This compilation
179 must not allocate memory for this entity. The entity must
180 be static_allocated. This can also be an external defined
184 ent_visibility get_entity_visibility (entity *ent);
185 void set_entity_visibility (entity *ent, ent_visibility vis);
187 /* This enumeration flags the variability of entities. */
189 uninitialized, /* The content of the entity is completely unknown. */
190 initialized, /* After allocation the entity is initalized with the
191 value given somewhere in the entity. */
192 part_constant, /* For entities of compound types. Some members of the entity
193 are constant. The others are uninitialized. Those members
194 given a value for are constant. */
195 constant /* The entity is constant. */
198 ent_variability get_entity_variability (entity *ent);
199 void set_entity_variability (entity *ent, ent_variability var);
201 /* This enumeration flags the volatility of entities. */
203 non_volatile, /* The entity is not volatile */
204 is_volatile /* The entity is volatile */
207 ent_volatility get_entity_volatility (entity *ent);
208 void set_entity_volatility (entity *ent, ent_volatility vol);
210 /* Only set if layout = fixed. */
211 int get_entity_offset (entity *ent);
212 void set_entity_offset (entity *ent, int offset);
214 /* A link to store intermediate information */
215 void* get_entity_link(entity *ent);
216 void set_entity_link(entity *ent, void *l);
218 /** Fields of method entities **/
219 /* The entity knows the corresponding irg if the entity is a method.
220 This allows to get from a Call to the called irg.
221 Only entities of peculiarity "existent" can have a corresponding irg,
222 else the field is fixed to NULL. (Get returns NULL, set asserts.) */
223 ir_graph *get_entity_irg(entity *ent);
224 void set_entity_irg(entity *ent, ir_graph *irg);
226 /* For the definition of enumeration peculiarity see type.h */
227 peculiarity get_entity_peculiarity (entity *ent);
228 void set_entity_peculiarity (entity *ent, peculiarity pec);
230 /** Representation of constant values of entites **/
231 /* Set current_ir_graph to get_const_code_irg() to generate a constant
233 /* Copies a firm subgraph that complies to the restrictions for
234 constant expressions to current_block in current_ir_graph. */
235 ir_node *copy_const_value(ir_node *n);
237 /* Set has no effect for entities of type method. */
238 ir_node *get_atomic_ent_value(entity *ent);
239 void set_atomic_ent_value(entity *ent, ir_node *val);
241 /* A value of a compound entity is a pair of a value and the corresponding
242 member of the compound. */
243 void add_compound_ent_value(entity *ent, ir_node *val, entity *member);
244 int get_compound_ent_n_values(entity *ent);
245 ir_node *get_compound_ent_value(entity *ent, int pos);
246 entity *get_compound_ent_value_member(entity *ent, int pos);
247 void set_compound_ent_value(entity *ent, ir_node *val, entity *member, int pos);
248 /* Inits the entity ent witch must be of a one dimensional
249 array type with the values given in the values array.
250 The array must have a lower and an upper bound. Keeps the
251 order of values. Does not test whether the number of values
252 fits into the given array size. Does not test whether the
253 values have the proper mode for the array. */
254 void set_array_entity_values(entity *ent, tarval **values, int num_vals);
256 /** Fields of entities with a class type as owner **/
257 /* Overwrites is a field that specifies that an access to the overwritten
258 entity in the supertype must use this entity. It's a list as with
259 multiple inheritance several enitites can be overwritten. This field
260 is mostly useful for method entities.
261 If a Sel node selects an entity that is overwritten by other entities it
262 must return a pointer to the entity of the dynamic type of the pointer
263 that is passed to it. Lowering of the Sel node must assure this.
264 Overwrittenby is the inverse of overwrites. Both add routines add
265 both relations, they only differ in the order of arguments. */
266 void add_entity_overwrites (entity *ent, entity *overwritten);
267 int get_entity_n_overwrites (entity *ent);
268 entity *get_entity_overwrites (entity *ent, int pos);
269 void set_entity_overwrites (entity *ent, int pos, entity *overwritten);
271 void add_entity_overwrittenby (entity *ent, entity *overwrites);
272 int get_entity_n_overwrittenby (entity *ent);
273 entity *get_entity_overwrittenby (entity *ent, int pos);
274 void set_entity_overwrittenby (entity *ent, int pos, entity *overwrites);
276 /* Returns true if the type of the entity is a primitive, pointer
277 enumeration or method type. */
278 int is_atomic_entity(entity *ent);
279 /* Returns true if the type of the entity is a class, structure,
280 array or union type. */
281 int is_compound_entity(entity *ent);
283 /* Returns true if ent1 and ent2 have are equal except for their owner.
284 Two entities are equal if
285 - they have the same type (the same C-struct)
287 bool equal_entity(entity *ent1, entity *ent2);
291 # endif /* _ENTITY_H_ */