3 * File name: ir/tr/entity.h
4 * Purpose: Representation of all program known entities.
5 * Author: Martin Trapp, Christian Schaefer
6 * Modified by: Goetz Lindenmaier
9 * Copyright: (c) 1998-2003 Universität Karlsruhe
10 * Licence: This file protected by GPL - GNU GENERAL PUBLIC LICENSE.
16 * Entities represent all program known objects.
18 * @author Martin Trapp, Christian Schaefer
19 * @author Goetz Lindenmaier
21 * An entity is the representation of program known objects in Firm.
22 * The primary concept of entities is to represent members of complex
23 * types, i.e., fields and methods of classes. As not all programming
24 * language model all variables and methods as members of some class,
25 * the concept of entities is extended to cover also local and global
26 * variables, and arbitrary procedures.
28 * An entity always specifies the type of the object it represents and
29 * the type of the object it is a part of, the owner of the entity.
30 * Originally this is the type of the class of which the entity is a
32 * The owner of local variables is the procedure they are defined in.
33 * The owner of global variables and procedures visible in the whole
34 * program is a universally defined class type "GlobalType". The owner
35 * of procedures defined in the scope of an other procedure is the
36 * enclosing procedure.
38 * In detail the datastructure entity has the following fields:
40 * - ident *name: Name of this entity as specified in the source code.
41 * Only unequivocal in conjuction with scope.
42 * - ident *ld_name: Unique name of this entity, i.e., the mangled
43 * name. E.g., for a class `A' with field `a' this
44 * is the ident for `A_a'.
45 * - type *type: The type of this entity, e.g., a method type, a
46 * basic type of the language or a class itself.
47 * - type *owner: The class this entity belongs to. In case of local
48 * variables the method they are defined in.
49 * - int offset: Offset in byte for this entity. Fixed when layout
50 * of owner is determined.
51 * - ir_graph *irg: If (type == method_type) this is the corresponding irg.
52 * The ir_graph constructor automatically sets this field.
53 * If (type != method_type) access of this field will cause
66 /*-----------------------------------------------------------------*/
68 /*-----------------------------------------------------------------*/
70 /** Initalize entity module. */
71 void init_entity (void);
73 /*-----------------------------------------------------------------*/
75 /*-----------------------------------------------------------------*/
77 /* to resolve recursion between entity.h and irgraph.h */
78 #ifndef _IR_GRAPH_TYPEDEF_
79 #define _IR_GRAPH_TYPEDEF_
80 typedef struct ir_graph ir_graph;
85 * An abstract data type to represent program entites.
87 * @param owner A compound type this entity is a part of.
88 * @param type The type of this entity.
89 * @param name The string that represents this entity in the source program.
90 * @param allocation A flag saying whether the entity is dynamically or statically
91 * allocated (values: dynamic_allocated, static_allocated,
92 * automatic_allocated).
93 * @param visibility A flag indicating the visibility of this entity (values: local,
94 * external_visible, external_allocated)
95 * @param variability A flag indicating the variability of this entity (values:
96 * uninitialized, initalized, part_constant, constant)
97 * @param volatility @@@
98 * @param offset The offset of the entity within the compound object. Only set
99 * if the owner in the state "layout_fixed".
100 * @param overwrites A list of entities overwritten by this entity. This list is only
101 * existent if the owner of this entity is a class. The members in
102 * this list must be entities of super classes.
103 * @param overwrittenby A list of entities that overwrite this entity. This list is only
104 * existent if the owner of this entity is a class. The members in
105 * this list must be entities of sub classes.
106 * @param link A void* to associate some additional information with the entity.
107 * @param irg If the entity is a method this is the ir graph that represents the
108 * code of the method.
109 * @param peculiarity The peculiarity of the entity. If the entity is a method this
110 * indicates whether the entity represents
111 * a real method or whether it only exists to describe an interface.
112 * In that case there nowhere exists code for this entity and this entity
113 * is never dynamically used in the code.
114 * Values: description, existent. Default: existent.
115 * @param visited visited flag. Master flag is type_visited.
117 * @param These fields can only be accessed via access functions.
122 /* to resolve recursion between entity.h and type.h */
123 /** the type of an entity */
124 #ifndef _ENTITY_TYPEDEF_
125 #define _ENTITY_TYPEDEF_
126 typedef struct entity entity;
130 * Creates a new entity.
132 * Automatically inserts the entity as a member of owner.
133 * Entity is automatic_allocated and uninitialize except if the type
134 * is type_method, then it is static_allocated and constant. The constant
135 * value is a pointer to the method.
136 * Visibility is local, offset -1, and it is not volatile.
138 entity *new_entity (type *owner, ident *name, type *tp);
141 * Creates a new entity.
143 * Automatically inserts the entity as a member of owner.
144 * Entity is automatic_allocated and uninitialize except if the type
145 * is type_method, then it is static_allocated and constant. The constant
146 * value is a pointer to the method.
147 * Visibility is local, offset -1, and it is not volatile.
149 entity *new_d_entity (type *owner, ident *name, type *tp, dbg_info *db);
152 * Copies the entity if the new_owner is different from the
153 * owner of the old entity, else returns the old entity.
155 * Automatically inserts the new entity as a member of owner.
156 * Resets the overwrites/overwritten_by fields.
158 entity *copy_entity_own (entity *old, type *new_owner);
161 * Copies the entity if the new_name is different from the
162 * name of the old entity, else returns the old entity.
164 * Automatically inserts the new entity as a member of owner.
165 * The mangled name ld_name is set to NULL.
167 entity *copy_entity_name (entity *old, ident *new_name);
172 * The owner will still contain the pointer to this
173 * entity, as well as all other references!
175 void free_entity (entity *ent);
177 /** Returns the name of an entity. */
178 const char *get_entity_name (entity *ent);
180 /** Returns the ident of an entity. */
181 ident *get_entity_ident (entity *ent);
183 /** Returns the mangled name of the entity.
185 * If the mangled name is set it returns the existing name.
186 * Else it generates a name with mangle_entity()
187 * and remembers this new name internally.
189 ident *get_entity_ld_ident (entity *ent);
191 /** Sets the mangled name of the entity. */
192 void set_entity_ld_ident (entity *ent, ident *ld_ident);
194 /** Returns the mangled name of the entity as a string. */
195 const char *get_entity_ld_name (entity *end);
197 /** Returns the owner of the entity. */
198 type *get_entity_owner (entity *ent);
200 /** Sets the owner field in entity to owner. Don't forget to add
202 void set_entity_owner (entity *ent, type *owner);
204 /** Asserts if the type owner is neither a compound type or an array */
205 INLINE void assert_legal_owner_of_ent(type *owner);
207 /** Returns the type of an entity. */
208 type *get_entity_type (entity *ent);
210 /** Sets the type of an entity. */
211 void set_entity_type (entity *ent, type *tp);
213 /** The allocation type. */
215 allocation_automatic, /**< The entity is allocated during runtime, implicitly
216 as component of a compound type. This is the default. */
217 allocation_parameter, /**< The entity is a parameter. It is also automatic allocated.
218 We distinguish the allocation of paramters from the allocation
219 of local variables as their placement depends on the calling
221 allocation_dynamic, /**< The entity is allocated during runtime, explicitly
223 allocation_static /**< The entity is allocated statically. We can use a
224 SymConst(?) as address of the entity. */
227 /** Returns the allocation type of an entity. */
228 ent_allocation get_entity_allocation (entity *ent);
230 /** Sets the allocation type of an entity. */
231 void set_entity_allocation (entity *ent, ent_allocation al);
233 /** Return the name of the visibility */
234 const char *get_allocation_name(ent_allocation vis);
237 * This enumeration flags the visibility of entities. This is necessary
238 * for partial compilation.
241 visibility_local, /**< The entity is only visible locally. This is the default. */
242 visibility_external_visible, /**< The entity is visible to other external program parts, but
243 it is defined here. It may not be optimized away. The entity must
244 be static_allocated. */
245 visibility_external_allocated /**< The entity is defined and allocated externally. This compilation
246 must not allocate memory for this entity. The entity must
247 be static_allocated. This can also be an external defined
251 /** Returns the visibility of an entity. */
252 ent_visibility get_entity_visibility (entity *ent);
254 /** Sets the visibility of an entity. */
255 void set_entity_visibility (entity *ent, ent_visibility vis);
257 /** Return the name of the visibility */
258 const char *get_visibility_name(ent_visibility vis);
260 /** This enumeration flags the variability of entities. */
262 variability_uninitialized, /**< The content of the entity is completely unknown. */
263 variability_initialized, /**< After allocation the entity is initalized with the
264 value given somewhere in the entity. */
265 variability_part_constant, /**< For entities of compound types. Some members of the entity
266 are constant. The others are uninitialized. Those members
267 given a value for are constant. */
268 variability_constant /**< The entity is constant. */
271 /** Returns the variability of an entity. */
272 ent_variability get_entity_variability (entity *ent);
274 /** Sets the variability of an entity. */
275 void set_entity_variability (entity *ent, ent_variability var);
277 /** Return the name of the variablity. */
278 const char *get_variability_name(ent_variability var);
280 /** This enumeration flags the volatility of entities. */
282 volatility_non_volatile, /**< The entity is not volatile */
283 volatility_is_volatile /**< The entity is volatile */
286 /** Returns the volatility of an entity. */
287 ent_volatility get_entity_volatility (entity *ent);
289 /** Sets the volatility of an entity. */
290 void set_entity_volatility (entity *ent, ent_volatility vol);
292 /* Return the name of the volatility. */
293 const char *get_volatility_name(ent_volatility var);
295 /** Returns the offset of an entity (in a compound). Only set if layout = fixed. */
296 int get_entity_offset (entity *ent);
298 /** Sets the offset of an entity (in a compound). */
299 void set_entity_offset (entity *ent, int offset);
301 /** Returns the stored intermediate information. */
302 void* get_entity_link(entity *ent);
304 /** Stores new intermediate information. */
305 void set_entity_link(entity *ent, void *l);
307 /* -- Fields of method entities -- */
308 /* The entity knows the corresponding irg if the entity is a method.
309 This allows to get from a Call to the called irg.
310 Only entities of peculiarity "existent" can have a corresponding irg,
311 else the field is fixed to NULL. (Get returns NULL, set asserts.) */
312 ir_graph *get_entity_irg(entity *ent);
313 void set_entity_irg(entity *ent, ir_graph *irg);
315 /** Return the peculiarity of an entity. */
316 peculiarity get_entity_peculiarity (entity *ent);
318 /** Sets the peculiarity of an entity. */
319 void set_entity_peculiarity (entity *ent, peculiarity pec);
321 /** Return the name of the peculiarity. */
322 const char *get_peculiarity_name(peculiarity var);
324 /* -- Representation of constant values of entites -- */
325 /* Set current_ir_graph to get_const_code_irg() to generate a constant
327 /* Copies a firm subgraph that complies to the restrictions for
328 constant expressions to current_block in current_ir_graph. */
329 ir_node *copy_const_value(ir_node *n);
331 /* Set has no effect for existent entities of type method. */
332 ir_node *get_atomic_ent_value(entity *ent);
333 void set_atomic_ent_value(entity *ent, ir_node *val);
335 /* The following type describes a path to a leave in the compound graph.
336 Node 0 in the path must be an entity of type tp given in the constructor. If
337 the type of this element is compound, the path node 1 is an element of the type
338 of node 0 an so forth, until an entity of atomic type is reached. */
339 #ifndef _COMPOUND_GRAPH_PATH_TYPEDEF_
340 #define _COMPOUND_GRAPH_PATH_TYPEDEF_
341 typedef struct compound_graph_path compound_graph_path;
342 #endif /* _COMPOUND_GRAPH_PATH_TYPEDEF_ */
343 compound_graph_path *new_compound_graph_path(type *tp, int length);
344 int is_compound_graph_path(void *thing);
345 void free_compound_graph_path (compound_graph_path *gr);
346 int get_compound_graph_path_length(compound_graph_path *gr);
347 entity *get_compound_graph_path_node(compound_graph_path *gr, int pos);
348 void set_compound_graph_path_node(compound_graph_path *gr, int pos, entity *node);
350 /* A value of a compound entity is a pair of a value and the description of the
351 corresponding access path to the member of the compound. */
352 void add_compound_ent_value_w_path(entity *ent, ir_node *val, compound_graph_path *path);
353 void set_compound_ent_value_w_path(entity *ent, ir_node *val, compound_graph_path *path, int pos);
354 int get_compound_ent_n_values(entity *ent);
355 ir_node *get_compound_ent_value(entity *ent, int pos);
356 compound_graph_path *get_compound_ent_value_path(entity *ent, int pos);
357 /* Removes all constant entries where the path ends at value_ent. Does not
358 free the memory of the paths. (The same path might be used for several
359 constant entities. */
360 void remove_compound_ent_value(entity *ent, entity *value_ent);
362 /* Some languages support only trivial access paths, i.e., the member is a
363 direct, atomic member of the constant entities type. In this case the
364 corresponding entity can be accessed directly. The following functions
365 allow direct access. */
366 /* generates a Path with length 1 */
367 void add_compound_ent_value(entity *ent, ir_node *val, entity *member);
368 /* Returns the last member in the path */
369 entity *get_compound_ent_value_member(entity *ent, int pos);
370 /* Sets the path at pos 0 */
371 void set_compound_ent_value(entity *ent, ir_node *val, entity *member, int pos);
375 /** Inits the entity ent witch must be of a one dimensional
376 array type with the values given in the values array.
377 The array must have a lower and an upper bound. Keeps the
378 order of values. Does not test whether the number of values
379 fits into the given array size. Does not test whether the
380 values have the proper mode for the array. */
381 void set_array_entity_values(entity *ent, tarval **values, int num_vals);
383 /* --- Fields of entities with a class type as owner --- */
384 /* Overwrites is a field that specifies that an access to the overwritten
385 entity in the supertype must use this entity. It's a list as with
386 multiple inheritance several enitites can be overwritten. This field
387 is mostly useful for method entities.
388 If a Sel node selects an entity that is overwritten by other entities it
389 must return a pointer to the entity of the dynamic type of the pointer
390 that is passed to it. Lowering of the Sel node must assure this.
391 Overwrittenby is the inverse of overwrites. Both add routines add
392 both relations, they only differ in the order of arguments. */
393 void add_entity_overwrites (entity *ent, entity *overwritten);
394 int get_entity_n_overwrites (entity *ent);
395 int get_entity_overwrites_index(entity *ent, entity *overwritten);
396 entity *get_entity_overwrites (entity *ent, int pos);
397 void set_entity_overwrites (entity *ent, int pos, entity *overwritten);
398 void remove_entity_overwrites(entity *ent, entity *overwritten);
400 void add_entity_overwrittenby (entity *ent, entity *overwrites);
401 int get_entity_n_overwrittenby (entity *ent);
402 int get_entity_overwrittenby_index(entity *ent, entity *overwrites);
403 entity *get_entity_overwrittenby (entity *ent, int pos);
404 void set_entity_overwrittenby (entity *ent, int pos, entity *overwrites);
405 void remove_entity_overwrittenby(entity *ent, entity *overwrites);
408 * Checks whether a pointer points to an entity.
410 * @param thing an arbitrary pointer
413 * true if the thing is an entity, else false
415 int is_entity (void *thing);
417 /** Returns true if the type of the entity is a primitive, pointer
418 enumeration or method type. */
419 int is_atomic_entity(entity *ent);
420 /** Returns true if the type of the entity is a class, structure,
421 array or union type. */
422 int is_compound_entity(entity *ent);
424 /** Returns true if ent1 and ent2 have are equal except for their owner.
425 Two entities are equal if
426 - they have the same type (the same C-struct)
429 bool equal_entity(entity *ent1, entity *ent2);
432 /** Outputs a unique number for this entity if libfirm is compiled for
433 debugging, (configure with --enable-debug) else returns 0. */
434 INLINE long get_entity_nr(entity *ent);
436 /** Returns the entitys visited count. */
437 unsigned long get_entity_visited(entity *ent);
439 /** Sets the entitys visited count. */
440 void set_entity_visited(entity *ent, unsigned long num);
442 /** Sets visited field in entity to entity_visited. */
443 void mark_entity_visited(entity *ent);
445 /** Returns true if this entity was visited. */
446 bool entity_visited(entity *ent);
448 /** Returns true if this entity was not visited. */
449 bool entity_not_visited(entity *ent);
451 # endif /* _ENTITY_H_ */