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 bits 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
64 # include "tr_inheritance.h"
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 in bits. 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.
157 * Keeps the old atomic value.
158 * @@@ Maybe we should change this. If peculiarity of a method
159 * is existent, we should add a new SymConst that points to
160 * itself and not to the origin. Right now we have to change
161 * the peculiarity and then set a new atomic value by hand.
163 entity *copy_entity_own (entity *old, type *new_owner);
166 * Copies the entity if the new_name is different from the
167 * name of the old entity, else returns the old entity.
169 * Automatically inserts the new entity as a member of owner.
170 * The mangled name ld_name is set to NULL.
171 * Overwrites relation is copied from old.
173 entity *copy_entity_name (entity *old, ident *new_name);
178 * The owner will still contain the pointer to this
179 * entity, as well as all other references!
181 void free_entity (entity *ent);
183 /** Returns the name of an entity. */
184 const char *get_entity_name (const entity *ent);
186 /** Returns the ident of an entity. */
187 ident *get_entity_ident (const entity *ent);
189 /** Returns the mangled name of the entity.
191 * If the mangled name is set it returns the existing name.
192 * Else it generates a name with mangle_entity()
193 * and remembers this new name internally.
195 ident *get_entity_ld_ident (entity *ent);
197 /** Sets the mangled name of the entity. */
198 void set_entity_ld_ident (entity *ent, ident *ld_ident);
200 /** Returns the mangled name of the entity as a string. */
201 const char *get_entity_ld_name (entity *ent);
203 /** Returns the owner of the entity. */
204 type *get_entity_owner (entity *ent);
206 /** Sets the owner field in entity to owner. Don't forget to add
208 void set_entity_owner (entity *ent, type *owner);
210 /** Asserts if the type owner is either a compound type or an array */
211 void assert_legal_owner_of_ent(type *owner);
213 /** Returns the type of an entity. */
214 type *get_entity_type (entity *ent);
216 /** Sets the type of an entity. */
217 void set_entity_type (entity *ent, type *tp);
219 /** The allocation type. */
221 allocation_automatic, /**< The entity is allocated during runtime, implicitly
222 as component of a compound type. This is the default. */
223 allocation_parameter, /**< The entity is a parameter. It is also automatic allocated.
224 We distinguish the allocation of parameters from the allocation
225 of local variables as their placement depends on the calling
227 allocation_dynamic, /**< The entity is allocated during runtime, explicitly
229 allocation_static /**< The entity is allocated statically. We can use a
230 Const as address of the entity. */
233 /** Returns the allocation type of an entity. */
234 ent_allocation get_entity_allocation (const entity *ent);
236 /** Sets the allocation type of an entity. */
237 void set_entity_allocation (entity *ent, ent_allocation al);
239 /** Return the name of the allocation type. */
240 const char *get_allocation_name(ent_allocation vis);
242 #if 0 // moved to type.h
244 * This enumeration flags the visibility of entities. This is necessary
245 * for partial compilation.
248 visibility_local, /**< The entity is only visible locally. This is the default. */
249 visibility_external_visible, /**< The entity is visible to other external program parts, but
250 it is defined here. It may not be optimized away. The entity must
251 be static_allocated. */
252 visibility_external_allocated /**< The entity is defined and allocated externally. This compilation
253 must not allocate memory for this entity. The entity must
254 be static_allocated. This can also be an external defined
259 /** Returns the visibility of an entity. */
260 visibility get_entity_visibility (const entity *ent);
262 /** Sets the visibility of an entity. */
263 void set_entity_visibility (entity *ent, visibility vis);
265 /** Return the name of the visibility */
266 const char *get_visibility_name(visibility vis);
268 /** This enumeration flags the variability of entities. */
270 variability_uninitialized, /**< The content of the entity is completely unknown. */
271 variability_initialized, /**< After allocation the entity is initalized with the
272 value given somewhere in the entity. */
273 variability_part_constant, /**< For entities of compound types.
274 The members of the entity are mixed constant,
275 initialized or uninitialized. */
276 variability_constant /**< The entity is constant. */
279 /** Returns the variability of an entity. */
280 ent_variability get_entity_variability (const entity *ent);
282 /** Sets the variability of an entity. */
283 void set_entity_variability (entity *ent, ent_variability var);
285 /** Return the name of the variablity. */
286 const char *get_variability_name(ent_variability var);
288 /** This enumeration flags the volatility of entities. */
290 volatility_non_volatile, /**< The entity is not volatile */
291 volatility_is_volatile /**< The entity is volatile */
294 /** Returns the volatility of an entity. */
295 ent_volatility get_entity_volatility (const entity *ent);
297 /** Sets the volatility of an entity. */
298 void set_entity_volatility (entity *ent, ent_volatility vol);
300 /** Return the name of the volatility. */
301 const char *get_volatility_name(ent_volatility var);
303 /** This enumeration flags the stickyness of an entity. */
305 stickyness_unsticky, /**< The entity can be removed from
306 the program, unless contraindicated
307 by other attributes */
308 stickyness_sticky /**< The entity must remain in the
309 program in any case */
312 /** Get the entity's stickyness */
313 ent_stickyness get_entity_stickyness(const entity *ent);
315 /** Set the entity's stickyness */
316 void set_entity_stickyness(entity *ent, ent_stickyness stickyness);
318 /** Returns the offset of an entity (in a compound) in bytes. Only set if layout = fixed. */
319 int get_entity_offset_bytes(const entity *ent);
321 /** Returns the offset of an entity (in a compound) in bits. Only set if layout = fixed. */
322 int get_entity_offset_bits(const entity *ent);
324 /** Sets the offset of an entity (in a compound) in bytes. */
325 void set_entity_offset_bytes(entity *ent, int offset);
327 /** Sets the offset of an entity (in a compound) in bits. */
328 void set_entity_offset_bits(entity *ent, int offset);
330 /** Returns the stored intermediate information. */
331 void* get_entity_link(const entity *ent);
333 /** Stores new intermediate information. */
334 void set_entity_link(entity *ent, void *l);
336 /* -- Fields of method entities -- */
337 /** The entity knows the corresponding irg if the entity is a method.
338 This allows to get from a Call to the called irg.
339 Only entities of peculiarity "existent" can have a corresponding irg,
340 else the field is fixed to NULL. (Get returns NULL, set asserts.) */
341 ir_graph *get_entity_irg(const entity *ent);
342 void set_entity_irg(entity *ent, ir_graph *irg);
344 /** Return the peculiarity of an entity. */
345 peculiarity get_entity_peculiarity (const entity *ent);
347 /** Sets the peculiarity of an entity. */
348 void set_entity_peculiarity (entity *ent, peculiarity pec);
350 /** Return the name of the peculiarity. */
351 const char *get_peculiarity_name(peculiarity var);
353 /* -- Representation of constant values of entites -- */
354 /** Returns true if the the node is representable as code on
356 int is_irn_const_expression(ir_node *n);
357 /* Set current_ir_graph to get_const_code_irg() to generate a constant
361 * Copies a firm subgraph that complies to the restrictions for
362 * constant expressions to current_block in current_ir_graph.
364 ir_node *copy_const_value(ir_node *n);
366 /* Set has no effect for existent entities of type method. */
367 ir_node *get_atomic_ent_value(entity *ent);
368 void set_atomic_ent_value(entity *ent, ir_node *val);
370 /* The following type describes a path to a leave in the compound graph.
371 Node 0 in the path must be an entity of type tp given in the constructor. If
372 the type of this element is compound, the path node 1 is an element of the type
373 of node 0 an so forth, until an entity of atomic type is reached. */
374 #ifndef _COMPOUND_GRAPH_PATH_TYPEDEF_
375 #define _COMPOUND_GRAPH_PATH_TYPEDEF_
376 typedef struct compound_graph_path compound_graph_path;
377 #endif /* _COMPOUND_GRAPH_PATH_TYPEDEF_ */
378 compound_graph_path *new_compound_graph_path(type *tp, int length);
379 int is_compound_graph_path(void *thing);
380 void free_compound_graph_path (compound_graph_path *gr);
381 int get_compound_graph_path_length(compound_graph_path *gr);
382 entity *get_compound_graph_path_node(compound_graph_path *gr, int pos);
383 void set_compound_graph_path_node(compound_graph_path *gr, int pos, entity *node);
384 int get_compound_graph_path_array_index(compound_graph_path *gr, int pos);
385 void set_compound_graph_path_array_index(compound_graph_path *gr, int pos, int index);
387 /** Checks whether the path up to pos is correct. If the path contains a NULL,
388 * assumes the path is not complete and returns 'true'. */
389 int is_proper_compound_graph_path(compound_graph_path *gr, int pos);
391 /* A value of a compound entity is a pair of a value and the description of the
392 corresponding access path to the member of the compound. */
393 void add_compound_ent_value_w_path(entity *ent, ir_node *val, compound_graph_path *path);
394 void set_compound_ent_value_w_path(entity *ent, ir_node *val, compound_graph_path *path, int pos);
395 /** Returns the number of constant values needed to initialize the entity.
397 * Asserts if the entity has variability_uninitialized.
399 int get_compound_ent_n_values(entity *ent);
400 /** Returns a constant value given the position. */
401 ir_node *get_compound_ent_value(entity *ent, int pos);
402 /** Returns the access path for value at position pos. */
403 compound_graph_path *get_compound_ent_value_path(entity *ent, int pos);
404 /** Returns the position of a value with the given path.
405 * The path must contain array indicees for all array element entities. */
406 int get_compound_ent_pos_by_path(entity *ent, compound_graph_path *path);
407 /** Returns a constant value given the access path.
408 * The path must contain array indicees for all array element entities. */
409 ir_node *get_compound_ent_value_by_path(entity *ent, compound_graph_path *path);
411 /** Removes all constant entries where the path ends at value_ent. Does not
412 free the memory of the paths. (The same path might be used for several
413 constant entities. */
414 void remove_compound_ent_value(entity *ent, entity *value_ent);
416 /* Some languages support only trivial access paths, i.e., the member is a
417 direct, atomic member of the constant entities type. In this case the
418 corresponding entity can be accessed directly. The following functions
419 allow direct access. */
421 /** generates a Path with length 1 */
422 void add_compound_ent_value(entity *ent, ir_node *val, entity *member);
424 /** Returns the last member in the path */
425 entity *get_compound_ent_value_member(entity *ent, int pos);
427 /** Sets the path at pos 0 */
428 void set_compound_ent_value(entity *ent, ir_node *val, entity *member, int pos);
430 /** Inits the entity ent witch must be of a one dimensional
431 array type with the values given in the values array.
432 The array must have a lower and an upper bound. Keeps the
433 order of values. Does not test whether the number of values
434 fits into the given array size. Does not test whether the
435 values have the proper mode for the array. */
436 void set_array_entity_values(entity *ent, tarval **values, int num_vals);
438 /** Return the overall offset of value at position pos in bits.
440 * This requires that the layout of all concerned types is fixed.
442 * @param ent Any entity of compound type with at least pos initialization values.
443 * @param pos The position of the value for which the offset is requested.
445 int get_compound_ent_value_offset_bits(entity *ent, int pos);
447 /** Return the overall offset of value at position pos in bytes.
449 * This requires that the layout of all concerned types is fixed.
450 * Asserts if bit offset is not byte aligned.
452 * @param ent Any entity of compound type with at least pos initialization values.
453 * @param pos The position of the value for which the offset is requested.
455 int get_compound_ent_value_offset_bytes(entity *ent, int pos);
457 /** Compute the array indicees in compound graph paths of initialized entities.
459 * All arrays must have fixed lower and upper bounds. One array can
460 * have an open upper bound. If there are several open bounds, we do
461 * nothing. There must be initializer elements for all array
462 * elements. Uses the link field in the array element entities. The
463 * array bounds must be representable as ints.
465 * @param ent Any entity.
467 void compute_compound_ent_array_indicees(entity *ent);
469 /** Sort the values of the compound entity by their overall offset.
471 * This requires that the layout of all concerned types is fixed.
472 * If the entity has no initialization information the method just
473 * returns. This is needed to dump the entity in a backend.
475 * @param ent Any entity.
477 void sort_compound_ent_values(entity *ent);
480 /* --- Fields of entities with a class type as owner --- */
481 /* Overwrites is a field that specifies that an access to the overwritten
482 entity in the supertype must use this entity. It's a list as with
483 multiple inheritance several enitites can be overwritten. This field
484 is mostly useful for method entities.
485 If a Sel node selects an entity that is overwritten by other entities it
486 must return a pointer to the entity of the dynamic type of the pointer
487 that is passed to it. Lowering of the Sel node must assure this.
488 Overwrittenby is the inverse of overwrites. Both add routines add
489 both relations, they only differ in the order of arguments. */
490 void add_entity_overwrites (entity *ent, entity *overwritten);
491 int get_entity_n_overwrites (entity *ent);
492 int get_entity_overwrites_index(entity *ent, entity *overwritten);
493 entity *get_entity_overwrites (entity *ent, int pos);
494 void set_entity_overwrites (entity *ent, int pos, entity *overwritten);
495 void remove_entity_overwrites(entity *ent, entity *overwritten);
497 void add_entity_overwrittenby (entity *ent, entity *overwrites);
498 int get_entity_n_overwrittenby (entity *ent);
499 int get_entity_overwrittenby_index(entity *ent, entity *overwrites);
500 entity *get_entity_overwrittenby (entity *ent, int pos);
501 void set_entity_overwrittenby (entity *ent, int pos, entity *overwrites);
502 void remove_entity_overwrittenby(entity *ent, entity *overwrites);
505 * Checks whether a pointer points to an entity.
507 * @param thing an arbitrary pointer
510 * true if the thing is an entity, else false
512 int is_entity (const void *thing);
514 /** Returns true if the type of the entity is a primitive, pointer
515 enumeration or method type. */
516 int is_atomic_entity(entity *ent);
517 /** Returns true if the type of the entity is a class, structure,
518 array or union type. */
519 int is_compound_entity(entity *ent);
521 /** Returns true if ent1 and ent2 have are equal except for their owner.
522 Two entities are equal if
523 - they have the same type (the same C-struct)
526 bool equal_entity(entity *ent1, entity *ent2);
528 /** Outputs a unique number for this entity if libfirm is compiled for
529 debugging, (configure with --enable-debug) else returns 0. */
530 long get_entity_nr(entity *ent);
532 /** Returns the entitys visited count. */
533 unsigned long get_entity_visited(entity *ent);
535 /** Sets the entitys visited count. */
536 void set_entity_visited(entity *ent, unsigned long num);
538 /** Sets visited field in entity to entity_visited. */
539 void mark_entity_visited(entity *ent);
541 /** Returns true if this entity was visited. */
542 bool entity_visited(entity *ent);
544 /** Returns true if this entity was not visited. */
545 bool entity_not_visited(entity *ent);
548 * @page unknown_entity
550 * This entity is an auxiliary entity dedicated to support analyses.
552 * The unknown entity represents that there could be an entity, but it is not
553 * known. This entity can be used to initialize fields before an analysis (not known
554 * yet) or to represent the top of a lattice (could not be determined). There exists
555 * exactly one entity unknown. This entity has as owner and as type the unknown type. It is
556 * allocated when initializing the entity module.
558 * The entity can take the role of any entity, also methods. It returns default
559 * values in these cases.
561 * The following values are set:
562 * name = "unknown_entity"
563 * ld_name = "unknown_entity"
564 * owner = unknown_type
565 * type = unknown_type
566 * visibility = visibility_external_allocated
568 * variability = variability_uninitialized
569 * value = SymConst(unknown_entity)
572 * peculiarity = peculiarity_existent
573 * volatility = volatility_non_volatile
574 * stickyness = stickyness_unsticky
577 * overwrittenby = NULL
582 /* A variable that contains the only unknown entity. */
583 extern entity *unknown_entity;
584 /* Returns the unknown entity */
585 entity *get_unknown_entity(void);
587 # endif /* _ENTITY_H_ */