2 * Copyright (C) 1998 - 2000 by Universitaet Karlsruhe
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
55 /*******************************************************************/
57 /*******************************************************************/
59 /* initalize entity module */
60 void init_entity (void);
62 /*******************************************************************/
64 /*******************************************************************/
66 /* to resolve recursion between entity.h and irgraph.h */
67 #ifndef _IR_GRAPH_TYPEDEF_
68 #define _IR_GRAPH_TYPEDEF_
69 typedef struct ir_graph ir_graph;
74 * An abstract data type to represent program entites.
76 * @param owner A compound type this entity is a part of.
77 * @param type The type of this entity.
78 * @param name The string that represents this entity in the source program.
79 * @param allocation A flag saying whether the entity is dynamically or statically
80 * allocated (values: dynamic_allocated, static_allocated,
81 * automatic_allocated).
82 * @param visibility A flag indicating the visibility of this entity (values: local,
83 * external_visible, external_allocated)
84 * @param variability A flag indicating the variability of this entity (values:
85 * uninitialized, initalized, part_constant, constant)
86 * @param volatility @@@
87 * @param offset The offset of the entity within the compound object. Only set
88 * if the owner in the state "layout_fixed".
89 * @param overwrites A list of entities overwritten by this entity. This list is only
90 * existent if the owner of this entity is a class. The members in
91 * this list must be entities of super classes.
92 * @param overwrittenby A list of entities that overwrite this entity. This list is only
93 * existent if the owner of this entity is a class. The members in
94 * this list must be entities of sub classes.
95 * @param link A void* to associate some additional information with the entity.
96 * @param irg If the entity is a method this is the ir graph that represents the
98 * @param peculiarity The peculiarity of the entity. If the entity is a method this
99 * indicates whether the entity represents
100 * a real method or whether it only exists to describe an interface.
101 * In that case there nowhere exists code for this entity and this entity
102 * is never dynamically used in the code.
103 * Values: description, existent. Default: existent.
104 * @param visited visited flag. Master flag is type_visited.
106 * @param These fields can only be accessed via access functions.
111 /* to resolve recursion between entity.h and type.h */
112 #ifndef _ENTITY_TYPEDEF_
113 #define _ENTITY_TYPEDEF_
114 typedef struct entity entity;
118 /* Creates a new entity.
119 Automatically inserts the entity as a member of owner.
120 Entity is automatic_allocated and uninitialize except if the type
121 is type_method, then it is static_allocated and constant. The constant
122 value is a pointer to the method.
123 Visibility is local, offset -1, and it is not volatile. */
124 entity *new_entity (type *owner, ident *name, type *tp);
125 entity *new_d_entity (type *owner, ident *name, type *tp, dbg_info *db);
126 /* Copies the entity if the new_owner is different from the
127 owner of the old entity. Else returns the old entity.
128 Automatically inserts the new entity as a member of owner.
129 Resets the overwrites/overwritten_by fields. */
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. Don't forget to add
154 void set_entity_owner (entity *ent, type *owner);
155 INLINE void assert_legal_owner_of_ent(type *owner);
157 type *get_entity_type (entity *ent);
158 void set_entity_type (entity *ent, type *tp);
161 automatic_allocated, /* The entity is allocated during runtime, implicitly
162 as component of a compound type. This is the default. */
163 parameter_allocated, /* The entity is a parameter. It is also automatic allocated.
164 We distinguish the allocation of paramters from the allocation
165 of local variables as their placement depends on the calling
167 dynamic_allocated, /* The entity is allocated during runtime, explicitly
169 static_allocated /* The entity is allocated statically. We can use a
170 SymConst(?) as address of the entity. */
173 ent_allocation get_entity_allocation (entity *ent);
174 void set_entity_allocation (entity *ent, ent_allocation al);
176 /* This enumeration flags the visibility of entities. This is necessary
177 for partial compilation. */
179 local, /* The entity is only visible locally. This is the default. */
180 external_visible, /* The entity is visible to other external program parts, but
181 it is defined here. It may not be optimized away. The entity must
182 be static_allocated. */
183 external_allocated /* The entity is defined and allocated externally. This compilation
184 must not allocate memory for this entity. The entity must
185 be static_allocated. This can also be an external defined
189 ent_visibility get_entity_visibility (entity *ent);
190 void set_entity_visibility (entity *ent, ent_visibility vis);
192 /* This enumeration flags the variability of entities. */
194 uninitialized, /* The content of the entity is completely unknown. */
195 initialized, /* After allocation the entity is initalized with the
196 value given somewhere in the entity. */
197 part_constant, /* For entities of compound types. Some members of the entity
198 are constant. The others are uninitialized. Those members
199 given a value for are constant. */
200 constant /* The entity is constant. */
203 ent_variability get_entity_variability (entity *ent);
204 void set_entity_variability (entity *ent, ent_variability var);
206 /** This enumeration flags the volatility of entities. */
208 non_volatile, /**< The entity is not volatile */
209 is_volatile /**< The entity is volatile */
212 ent_volatility get_entity_volatility (entity *ent);
213 void set_entity_volatility (entity *ent, ent_volatility vol);
215 /* Only set if layout = fixed. */
216 int get_entity_offset (entity *ent);
217 void set_entity_offset (entity *ent, int offset);
219 /* A link to store intermediate information */
220 void* get_entity_link(entity *ent);
221 void set_entity_link(entity *ent, void *l);
223 /** Fields of method entities **/
224 /* The entity knows the corresponding irg if the entity is a method.
225 This allows to get from a Call to the called irg.
226 Only entities of peculiarity "existent" can have a corresponding irg,
227 else the field is fixed to NULL. (Get returns NULL, set asserts.) */
228 ir_graph *get_entity_irg(entity *ent);
229 void set_entity_irg(entity *ent, ir_graph *irg);
231 /* For the definition of enumeration peculiarity see type.h */
232 peculiarity get_entity_peculiarity (entity *ent);
233 void set_entity_peculiarity (entity *ent, peculiarity pec);
235 /** Representation of constant values of entites **/
236 /* Set current_ir_graph to get_const_code_irg() to generate a constant
238 /* Copies a firm subgraph that complies to the restrictions for
239 constant expressions to current_block in current_ir_graph. */
240 ir_node *copy_const_value(ir_node *n);
242 /* Set has no effect for entities of type method. */
243 ir_node *get_atomic_ent_value(entity *ent);
244 void set_atomic_ent_value(entity *ent, ir_node *val);
246 /* A value of a compound entity is a pair of a value and the corresponding
247 member of the compound. */
248 void add_compound_ent_value(entity *ent, ir_node *val, entity *member);
249 int get_compound_ent_n_values(entity *ent);
250 ir_node *get_compound_ent_value(entity *ent, int pos);
251 entity *get_compound_ent_value_member(entity *ent, int pos);
252 void set_compound_ent_value(entity *ent, ir_node *val, entity *member, int pos);
253 void remove_compound_ent_value(entity *ent, entity *value_ent);
254 /* Inits the entity ent witch must be of a one dimensional
255 array type with the values given in the values array.
256 The array must have a lower and an upper bound. Keeps the
257 order of values. Does not test whether the number of values
258 fits into the given array size. Does not test whether the
259 values have the proper mode for the array. */
260 void set_array_entity_values(entity *ent, tarval **values, int num_vals);
262 /** Fields of entities with a class type as owner **/
263 /* Overwrites is a field that specifies that an access to the overwritten
264 entity in the supertype must use this entity. It's a list as with
265 multiple inheritance several enitites can be overwritten. This field
266 is mostly useful for method entities.
267 If a Sel node selects an entity that is overwritten by other entities it
268 must return a pointer to the entity of the dynamic type of the pointer
269 that is passed to it. Lowering of the Sel node must assure this.
270 Overwrittenby is the inverse of overwrites. Both add routines add
271 both relations, they only differ in the order of arguments. */
272 void add_entity_overwrites (entity *ent, entity *overwritten);
273 int get_entity_n_overwrites (entity *ent);
274 int get_entity_overwrites_index(entity *ent, entity *overwritten);
275 entity *get_entity_overwrites (entity *ent, int pos);
276 void set_entity_overwrites (entity *ent, int pos, entity *overwritten);
277 void remove_entity_overwrites(entity *ent, entity *overwritten);
279 void add_entity_overwrittenby (entity *ent, entity *overwrites);
280 int get_entity_n_overwrittenby (entity *ent);
281 int get_entity_overwrittenby_index(entity *ent, entity *overwrites);
282 entity *get_entity_overwrittenby (entity *ent, int pos);
283 void set_entity_overwrittenby (entity *ent, int pos, entity *overwrites);
284 void remove_entity_overwrittenby(entity *ent, entity *overwrites);
287 * Checks whether a pointer points to an entity.
289 * @param thing an arbitrary pointer
292 * true if the thing is an entity, else false
294 int is_entity (void *thing);
296 /* Returns true if the type of the entity is a primitive, pointer
297 enumeration or method type. */
298 int is_atomic_entity(entity *ent);
299 /* Returns true if the type of the entity is a class, structure,
300 array or union type. */
301 int is_compound_entity(entity *ent);
303 /* Returns true if ent1 and ent2 have are equal except for their owner.
304 Two entities are equal if
305 - they have the same type (the same C-struct)
308 bool equal_entity(entity *ent1, entity *ent2);
311 unsigned long get_entity_visited(entity *ent);
312 void set_entity_visited(entity *ent, unsigned long num);
313 /* Sets visited field in entity to entity_visited. */
314 void mark_entity_visited(entity *ent);
315 bool entity_visited(entity *ent);
316 bool entity_not_visited(entity *ent);
321 # endif /* _ENTITY_H_ */