2 * Copyright (C) 1998 - 2000 by Universitaet Karlsruhe
10 * Entities represent all program known objects.
12 * @author Martin Trapp, Christian Schaefer,
13 * @author Goetz Lindenmaier
15 * An entity is the representation of program known objects in Firm.
16 * The primary concept of entities is to represent members of complex
17 * types, i.e., fields and methods of classes. As not all programming
18 * language model all variables and methods as members of some class,
19 * the concept of entities is extended to cover also local and global
20 * variables, and arbitrary procedures.
22 * An entity always specifies the type of the object it represents and
23 * the type of the object it is a part of, the owner of the entity.
24 * Originally this is the type of the class of which the entity is a
26 * The owner of local variables is the procedure they are defined in.
27 * The owner of global variables and procedures visible in the whole
28 * program is a universally defined class type "GlobalType". The owner
29 * of procedures defined in the scope of an other procedure is the
30 * enclosing procedure.
32 * In detail the datastructure entity has the following fields:
34 * ident *name Name of this entity as specified in the source code.
35 * Only unequivocal in conjuction with scope.
36 * ident *ld_name Unique name of this entity, i.e., the mangled
37 * name. E.g., for a class `A' with field `a' this
38 * is the ident for `A_a'.
39 * type *type The type of this entity, e.g., a method type, a
40 * basic type of the language or a class itself.
41 * type *owner; The class this entity belongs to. In case of local
42 * variables the method they are defined in.
43 * int offset; Offset in byte for this entity. Fixed when layout
44 * of owner is determined.
45 * ir_graph *irg; If (type == method_type) this is the corresponding irg.
46 * The ir_graph constructor automatically sets this field.
47 * If (type != method_type) access of this field will cause
60 /*******************************************************************/
62 /*******************************************************************/
64 /** initalize entity module */
65 void init_entity (void);
67 /*******************************************************************/
69 /*******************************************************************/
71 /* to resolve recursion between entity.h and irgraph.h */
72 #ifndef _IR_GRAPH_TYPEDEF_
73 #define _IR_GRAPH_TYPEDEF_
74 typedef struct ir_graph ir_graph;
79 * An abstract data type to represent program entites.
81 * @param owner A compound type this entity is a part of.
82 * @param type The type of this entity.
83 * @param name The string that represents this entity in the source program.
84 * @param allocation A flag saying whether the entity is dynamically or statically
85 * allocated (values: dynamic_allocated, static_allocated,
86 * automatic_allocated).
87 * @param visibility A flag indicating the visibility of this entity (values: local,
88 * external_visible, external_allocated)
89 * @param variability A flag indicating the variability of this entity (values:
90 * uninitialized, initalized, part_constant, constant)
91 * @param volatility @@@
92 * @param offset The offset of the entity within the compound object. Only set
93 * if the owner in the state "layout_fixed".
94 * @param overwrites A list of entities overwritten by 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 super classes.
97 * @param overwrittenby A list of entities that overwrite this entity. This list is only
98 * existent if the owner of this entity is a class. The members in
99 * this list must be entities of sub classes.
100 * @param link A void* to associate some additional information with the entity.
101 * @param irg If the entity is a method this is the ir graph that represents the
102 * code of the method.
103 * @param peculiarity The peculiarity of the entity. If the entity is a method this
104 * indicates whether the entity represents
105 * a real method or whether it only exists to describe an interface.
106 * In that case there nowhere exists code for this entity and this entity
107 * is never dynamically used in the code.
108 * Values: description, existent. Default: existent.
109 * @param visited visited flag. Master flag is type_visited.
111 * @param These fields can only be accessed via access functions.
116 /* to resolve recursion between entity.h and type.h */
117 /** the type of an entity */
118 #ifndef _ENTITY_TYPEDEF_
119 #define _ENTITY_TYPEDEF_
120 typedef struct entity entity;
124 /** Creates a new entity.
125 Automatically inserts the entity as a member of owner.
126 Entity is automatic_allocated and uninitialize except if the type
127 is type_method, then it is static_allocated and constant. The constant
128 value is a pointer to the method.
129 Visibility is local, offset -1, and it is not volatile. */
130 entity *new_entity (type *owner, ident *name, type *tp);
131 entity *new_d_entity (type *owner, ident *name, type *tp, dbg_info *db);
132 /** Copies the entity if the new_owner is different from the
133 owner of the old entity. Else returns the old entity.
134 Automatically inserts the new entity as a member of owner.
135 Resets the overwrites/overwritten_by fields. */
136 entity *copy_entity_own (entity *old, type *new_owner);
137 /** Copies the entity if the new_name is different from the
138 name of the old entity. Else returns the old entity.
139 Automatically inserts the new entity as a member of owner.
140 The mangled name ld_name is set to NULL. */
141 entity *copy_entity_name (entity *old, ident *new_name);
142 /** Frees the entity. The owner will still contain the pointer to this
143 entity, as well as all other references! */
144 void free_entity (entity *ent);
146 /** manipulate fields of entity **/
147 const char *get_entity_name (entity *ent);
148 ident *get_entity_ident (entity *ent);
150 /** Returns the mangled name of the entity.
152 * If the mangled name is set it returns the existing name.
153 * Else it generates a name with mangle_entity()
154 * and remembers this new name internally.
156 ident *get_entity_ld_ident (entity *ent);
158 /** Sets the mangled name of the entity. */
159 void set_entity_ld_ident (entity *ent, ident *ld_ident);
161 /** Returns the mangled name of the entity as a string. */
162 const char *get_entity_ld_name (entity *end);
164 /** Returns the owner of the entity. */
165 type *get_entity_owner (entity *ent);
167 /** Sets the owner field in entity to owner. Don't forget to add
169 void set_entity_owner (entity *ent, type *owner);
171 /** Asserts if the type owner is neither a compound type or an array */
172 INLINE void assert_legal_owner_of_ent(type *owner);
174 type *get_entity_type (entity *ent);
175 void set_entity_type (entity *ent, type *tp);
178 automatic_allocated, /**< The entity is allocated during runtime, implicitly
179 as component of a compound type. This is the default. */
180 parameter_allocated, /**< The entity is a parameter. It is also automatic allocated.
181 We distinguish the allocation of paramters from the allocation
182 of local variables as their placement depends on the calling
184 dynamic_allocated, /**< The entity is allocated during runtime, explicitly
186 static_allocated /**< The entity is allocated statically. We can use a
187 SymConst(?) as address of the entity. */
190 ent_allocation get_entity_allocation (entity *ent);
191 void set_entity_allocation (entity *ent, ent_allocation al);
193 /* This enumeration flags the visibility of entities. This is necessary
194 for partial compilation. */
196 local, /**< The entity is only visible locally. This is the default. */
197 external_visible, /**< The entity is visible to other external program parts, but
198 it is defined here. It may not be optimized away. The entity must
199 be static_allocated. */
200 external_allocated /**< The entity is defined and allocated externally. This compilation
201 must not allocate memory for this entity. The entity must
202 be static_allocated. This can also be an external defined
206 ent_visibility get_entity_visibility (entity *ent);
207 void set_entity_visibility (entity *ent, ent_visibility vis);
209 /** This enumeration flags the variability of entities. */
211 uninitialized, /**< The content of the entity is completely unknown. */
212 initialized, /**< After allocation the entity is initalized with the
213 value given somewhere in the entity. */
214 part_constant, /**< For entities of compound types. Some members of the entity
215 are constant. The others are uninitialized. Those members
216 given a value for are constant. */
217 constant /**< The entity is constant. */
220 ent_variability get_entity_variability (entity *ent);
221 void set_entity_variability (entity *ent, ent_variability var);
223 /** This enumeration flags the volatility of entities. */
225 non_volatile, /**< The entity is not volatile */
226 is_volatile /**< The entity is volatile */
229 ent_volatility get_entity_volatility (entity *ent);
230 void set_entity_volatility (entity *ent, ent_volatility vol);
232 /* Only set if layout = fixed. */
233 int get_entity_offset (entity *ent);
234 void set_entity_offset (entity *ent, int offset);
236 /* A link to store intermediate information */
237 void* get_entity_link(entity *ent);
238 void set_entity_link(entity *ent, void *l);
240 /** Fields of method entities **/
241 /* The entity knows the corresponding irg if the entity is a method.
242 This allows to get from a Call to the called irg.
243 Only entities of peculiarity "existent" can have a corresponding irg,
244 else the field is fixed to NULL. (Get returns NULL, set asserts.) */
245 ir_graph *get_entity_irg(entity *ent);
246 void set_entity_irg(entity *ent, ir_graph *irg);
248 /* For the definition of enumeration peculiarity see type.h */
249 peculiarity get_entity_peculiarity (entity *ent);
250 void set_entity_peculiarity (entity *ent, peculiarity pec);
252 /** Representation of constant values of entites **/
253 /* Set current_ir_graph to get_const_code_irg() to generate a constant
255 /* Copies a firm subgraph that complies to the restrictions for
256 constant expressions to current_block in current_ir_graph. */
257 ir_node *copy_const_value(ir_node *n);
259 /* Set has no effect for entities of type method. */
260 ir_node *get_atomic_ent_value(entity *ent);
261 void set_atomic_ent_value(entity *ent, ir_node *val);
263 /* A value of a compound entity is a pair of a value and the corresponding
264 member of the compound. */
265 void add_compound_ent_value(entity *ent, ir_node *val, entity *member);
266 int get_compound_ent_n_values(entity *ent);
267 ir_node *get_compound_ent_value(entity *ent, int pos);
268 entity *get_compound_ent_value_member(entity *ent, int pos);
269 void set_compound_ent_value(entity *ent, ir_node *val, entity *member, int pos);
270 void remove_compound_ent_value(entity *ent, entity *value_ent);
271 /** Inits the entity ent witch must be of a one dimensional
272 array type with the values given in the values array.
273 The array must have a lower and an upper bound. Keeps the
274 order of values. Does not test whether the number of values
275 fits into the given array size. Does not test whether the
276 values have the proper mode for the array. */
277 void set_array_entity_values(entity *ent, tarval **values, int num_vals);
279 /* --- Fields of entities with a class type as owner --- */
280 /* Overwrites is a field that specifies that an access to the overwritten
281 entity in the supertype must use this entity. It's a list as with
282 multiple inheritance several enitites can be overwritten. This field
283 is mostly useful for method entities.
284 If a Sel node selects an entity that is overwritten by other entities it
285 must return a pointer to the entity of the dynamic type of the pointer
286 that is passed to it. Lowering of the Sel node must assure this.
287 Overwrittenby is the inverse of overwrites. Both add routines add
288 both relations, they only differ in the order of arguments. */
289 void add_entity_overwrites (entity *ent, entity *overwritten);
290 int get_entity_n_overwrites (entity *ent);
291 int get_entity_overwrites_index(entity *ent, entity *overwritten);
292 entity *get_entity_overwrites (entity *ent, int pos);
293 void set_entity_overwrites (entity *ent, int pos, entity *overwritten);
294 void remove_entity_overwrites(entity *ent, entity *overwritten);
296 void add_entity_overwrittenby (entity *ent, entity *overwrites);
297 int get_entity_n_overwrittenby (entity *ent);
298 int get_entity_overwrittenby_index(entity *ent, entity *overwrites);
299 entity *get_entity_overwrittenby (entity *ent, int pos);
300 void set_entity_overwrittenby (entity *ent, int pos, entity *overwrites);
301 void remove_entity_overwrittenby(entity *ent, entity *overwrites);
304 * Checks whether a pointer points to an entity.
306 * @param thing an arbitrary pointer
309 * true if the thing is an entity, else false
311 int is_entity (void *thing);
313 /** Returns true if the type of the entity is a primitive, pointer
314 enumeration or method type. */
315 int is_atomic_entity(entity *ent);
316 /** Returns true if the type of the entity is a class, structure,
317 array or union type. */
318 int is_compound_entity(entity *ent);
320 /** Returns true if ent1 and ent2 have are equal except for their owner.
321 Two entities are equal if
322 - they have the same type (the same C-struct)
325 bool equal_entity(entity *ent1, entity *ent2);
328 /** Outputs a unique number for this entity if libfirm is compiled for
329 debugging, (configure with --enable-debug) else returns 0. */
330 INLINE long get_entity_nr(entity *ent);
332 unsigned long get_entity_visited(entity *ent);
333 void set_entity_visited(entity *ent, unsigned long num);
335 /** Sets visited field in entity to entity_visited. */
336 void mark_entity_visited(entity *ent);
338 /** Returns true if this entity was visited. */
339 bool entity_visited(entity *ent);
341 /** Returns true if this entity was not visited. */
342 bool entity_not_visited(entity *ent);
347 # endif /* _ENTITY_H_ */