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, Michael Beck
9 * Copyright: (c) 1998-2006 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 * - ir_type *type: The type of this entity, e.g., a method type, a
46 * basic type of the language or a class itself.
47 * - ir_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
55 * - unsigned irg_add_properties:
56 * If (type == method_type) this mirrors the additional flags
57 * of the corresponding irg if set or is an own set for
58 * this entity. This construction allows to specify these
59 * flags even if no graph is available.
60 * If (type != method_type) access of this field will cause
63 #ifndef _FIRM_TR_ENTITY_H_
64 #define _FIRM_TR_ENTITY_H_
66 #include "firm_types.h"
69 #include "tr_inheritance.h"
71 /*-----------------------------------------------------------------*/
73 /*-----------------------------------------------------------------*/
77 * An abstract data type to represent program entities.
79 * @param owner A compound type this entity is a part of.
80 * @param type The type of this entity.
81 * @param name The string that represents this entity in the source program.
82 * @param allocation A flag saying whether the entity is dynamically or statically
83 * allocated (values: dynamic_allocated, static_allocated,
84 * automatic_allocated).
85 * @param visibility A flag indicating the visibility of this entity (values: local,
86 * external_visible, external_allocated)
87 * @param variability A flag indicating the variability of this entity (values:
88 * uninitialized, initialized, part_constant, constant)
89 * @param volatility @@@
90 * @param offset The offset of the entity within the compound object in bits. Only set
91 * if the owner in the state "layout_fixed".
92 * @param overwrites A list of entities overwritten by 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 super classes.
95 * @param overwrittenby A list of entities that overwrite this entity. This list is only
96 * existent if the owner of this entity is a class. The members in
97 * this list must be entities of sub classes.
98 * @param link A void* to associate some additional information with the entity.
99 * @param irg If the entity is a method this is the ir graph that represents the
100 * code of the method.
101 * @param peculiarity The peculiarity of the entity. If the entity is a method this
102 * indicates whether the entity represents
103 * a real method or whether it only exists to describe an interface.
104 * In that case there nowhere exists code for this entity and this entity
105 * is never dynamically used in the code.
106 * Values: description, existent. Default: existent.
107 * @param visited visited flag. Master flag is type_visited.
109 * @param These fields can only be accessed via access functions.
114 /* to resolve recursion between entity.h and type.h */
115 /** the type of an entity */
116 #ifndef _ENTITY_TYPEDEF_
117 #define _ENTITY_TYPEDEF_
118 typedef struct entity entity;
122 * Creates a new entity.
124 * Automatically inserts the entity as a member of owner.
125 * Entity is automatic_allocated and uninitialized except if the type
126 * is type_method, then it is static_allocated and constant. The constant
127 * value is a pointer to the method.
128 * Visibility is local, offset -1, and it is not volatile.
130 entity *new_entity(ir_type *owner, ident *name, ir_type *tp);
133 * Creates a new entity.
135 * Automatically inserts the entity as a member of owner.
136 * The entity is automatic allocated and uninitialized except if the type
137 * is type_method, then it is static allocated and constant. The constant
138 * value is a pointer to the method.
139 * Visibility is local, offset -1, and it is not volatile.
141 entity *new_d_entity(ir_type *owner, ident *name, ir_type *tp, dbg_info *db);
144 * Copies the entity if the new_owner is different from the
145 * owner of the old entity, else returns the old entity.
147 * Automatically inserts the new entity as a member of owner.
148 * Resets the overwrites/overwritten_by fields.
149 * Keeps the old atomic value.
150 * @@@ Maybe we should change this. If peculiarity of a method
151 * is existent, we should add a new SymConst that points to
152 * itself and not to the origin. Right now we have to change
153 * the peculiarity and then set a new atomic value by hand.
155 entity *copy_entity_own(entity *old, ir_type *new_owner);
158 * Copies the entity if the new_name is different from the
159 * name of the old entity, else returns the old entity.
161 * Automatically inserts the new entity as a member of owner.
162 * The mangled name ld_name is set to NULL.
163 * Overwrites relation is copied from old.
165 entity *copy_entity_name(entity *old, ident *new_name);
170 * The owner will still contain the pointer to this
171 * entity, as well as all other references!
173 void free_entity(entity *ent);
175 /** Returns the name of an entity. */
176 const char *get_entity_name(const entity *ent);
178 /** Returns the ident of an entity. */
179 ident *get_entity_ident(const entity *ent);
181 /** Sets the ident of the entity. */
182 void set_entity_ident(entity *ent, ident *id);
184 /** Returns the mangled name of the entity.
186 * If the mangled name is set it returns the existing name.
187 * Else it generates a name with mangle_entity()
188 * and remembers this new name internally.
190 ident *get_entity_ld_ident(entity *ent);
192 /** Sets the mangled name of the entity. */
193 void set_entity_ld_ident(entity *ent, ident *ld_ident);
195 /** Returns the mangled name of the entity as a string. */
196 const char *get_entity_ld_name(entity *ent);
198 /** Returns the owner of the entity. */
199 ir_type *get_entity_owner(entity *ent);
201 /** Sets the owner field in entity to owner. Don't forget to add
203 void set_entity_owner(entity *ent, ir_type *owner);
205 /** Returns the type of an entity. */
206 ir_type *get_entity_type(entity *ent);
208 /** Sets the type of an entity. */
209 void set_entity_type(entity *ent, ir_type *tp);
211 /** The allocation type. */
213 allocation_automatic, /**< The entity is allocated during runtime, implicitly
214 as component of a compound type. This is the default. */
215 allocation_parameter, /**< The entity is a parameter. It is also automatic allocated.
216 We distinguish the allocation of parameters from the allocation
217 of local variables as their placement depends on the calling
219 allocation_dynamic, /**< The entity is allocated during runtime, explicitly
221 allocation_static /**< The entity is allocated statically. We can use a
222 Const as address of the entity. This is the default for methods. */
225 /** Returns the allocation type of an entity. */
226 ir_allocation get_entity_allocation(const entity *ent);
228 /** Sets the allocation type of an entity. */
229 void set_entity_allocation(entity *ent, ir_allocation al);
231 /** Return the name of the allocation type. */
232 const char *get_allocation_name(ir_allocation vis);
234 /** Returns the visibility of an entity. */
235 ir_visibility get_entity_visibility(const entity *ent);
237 /** Sets the visibility of an entity. */
238 void set_entity_visibility(entity *ent, ir_visibility vis);
240 /** Return the name of the visibility */
241 const char *get_visibility_name(ir_visibility vis);
243 /** This enumeration flags the variability of entities. */
245 variability_uninitialized, /**< The content of the entity is completely unknown. Default. */
246 variability_initialized, /**< After allocation the entity is initialized with the
247 value given somewhere in the entity. */
248 variability_part_constant, /**< For entities of compound types.
249 The members of the entity are mixed constant,
250 initialized or uninitialized. */
251 variability_constant /**< The entity is constant. */
254 /** Returns the variability of an entity. */
255 ir_variability get_entity_variability(const entity *ent);
257 /** Sets the variability of an entity. */
258 void set_entity_variability(entity *ent, ir_variability var);
260 /** Return the name of the variability. */
261 const char *get_variability_name(ir_variability var);
263 /** This enumeration flags the volatility of entities. */
265 volatility_non_volatile, /**< The entity is not volatile. Default. */
266 volatility_is_volatile /**< The entity is volatile */
269 /** Returns the volatility of an entity. */
270 ir_volatility get_entity_volatility(const entity *ent);
272 /** Sets the volatility of an entity. */
273 void set_entity_volatility(entity *ent, ir_volatility vol);
275 /** Return the name of the volatility. */
276 const char *get_volatility_name(ir_volatility var);
278 /** This enumeration flags the stickyness of an entity. */
280 stickyness_unsticky, /**< The entity can be removed from
281 the program, unless contraindicated
282 by other attributes. Default. */
283 stickyness_sticky /**< The entity must remain in the
284 program in any case. */
287 /** Get the entity's stickyness */
288 ir_stickyness get_entity_stickyness(const entity *ent);
290 /** Set the entity's stickyness */
291 void set_entity_stickyness(entity *ent, ir_stickyness stickyness);
293 /** Returns the offset of an entity (in a compound) in bytes. Only set if layout = fixed. */
294 int get_entity_offset_bytes(const entity *ent);
296 /** Returns the offset of an entity (in a compound) in bits. Only set if layout = fixed. */
297 int get_entity_offset_bits(const entity *ent);
299 /** Sets the offset of an entity (in a compound) in bytes. */
300 void set_entity_offset_bytes(entity *ent, int offset);
302 /** Sets the offset of an entity (in a compound) in bits. */
303 void set_entity_offset_bits(entity *ent, int offset);
305 /** Returns the stored intermediate information. */
306 void *get_entity_link(const entity *ent);
308 /** Stores new intermediate information. */
309 void set_entity_link(entity *ent, void *l);
311 /* -- Fields of method entities -- */
312 /** The entity knows the corresponding irg if the entity is a method.
313 This allows to get from a Call to the called irg.
314 Only entities of peculiarity "existent" can have a corresponding irg,
315 else the field is fixed to NULL. (Get returns NULL, set asserts.) */
316 ir_graph *get_entity_irg(const entity *ent);
317 void set_entity_irg(entity *ent, ir_graph *irg);
319 /** Gets the entity vtable number. */
320 unsigned get_entity_vtable_number(entity *ent);
322 /** Sets the entity vtable number. */
323 void set_entity_vtable_number(entity *ent, unsigned vtable_number);
325 /** Return the peculiarity of an entity. */
326 ir_peculiarity get_entity_peculiarity(const entity *ent);
328 /** Sets the peculiarity of an entity. */
329 void set_entity_peculiarity(entity *ent, ir_peculiarity pec);
331 /** Checks if an entity is compiler generated */
332 int is_entity_compiler_generated(const entity *ent);
334 /** Sets/resets the compiler generated flag */
335 void set_entity_compiler_generated(entity *ent, int flag);
337 /* -- Representation of constant values of entities -- */
338 /** Returns true if the the node is representable as code on
340 int is_irn_const_expression(ir_node *n);
341 /* Set current_ir_graph to get_const_code_irg() to generate a constant
345 * Copies a firm subgraph that complies to the restrictions for
346 * constant expressions to current_block in current_ir_graph.
348 ir_node *copy_const_value(dbg_info *dbg, ir_node *n);
350 /* Set has no effect for existent entities of type method. */
351 ir_node *get_atomic_ent_value(entity *ent);
352 void set_atomic_ent_value(entity *ent, ir_node *val);
355 * The following type describes a path to a leave in the compound graph.
356 * Node 0 in the path must be an entity of type tp given in the constructor. If
357 * the type of this element is compound, the path node 1 is an element of the type
358 * of node 0 an so forth, until an entity of atomic type is reached.
360 #ifndef _COMPOUND_GRAPH_PATH_TYPEDEF_
361 #define _COMPOUND_GRAPH_PATH_TYPEDEF_
362 typedef struct compound_graph_path compound_graph_path;
363 #endif /* _COMPOUND_GRAPH_PATH_TYPEDEF_ */
365 /** Creates a new compound graph path. */
366 compound_graph_path *new_compound_graph_path(ir_type *tp, int length);
368 /** Returns non-zero if an object is a compound graph path */
369 int is_compound_graph_path(void *thing);
371 /** Frees a graph path object */
372 void free_compound_graph_path (compound_graph_path *gr);
374 /** Returns the length of a graph path */
375 int get_compound_graph_path_length(compound_graph_path *gr);
377 entity *get_compound_graph_path_node(compound_graph_path *gr, int pos);
378 void set_compound_graph_path_node(compound_graph_path *gr, int pos, entity *node);
379 int get_compound_graph_path_array_index(compound_graph_path *gr, int pos);
380 void set_compound_graph_path_array_index(compound_graph_path *gr, int pos, int index);
382 /** Checks whether the path up to pos is correct. If the path contains a NULL,
383 * assumes the path is not complete and returns non-zero. */
384 int is_proper_compound_graph_path(compound_graph_path *gr, int pos);
386 /* A value of a compound entity is a pair of a value and the description of the
387 corresponding access path to the member of the compound. */
388 void add_compound_ent_value_w_path(entity *ent, ir_node *val, compound_graph_path *path);
389 void set_compound_ent_value_w_path(entity *ent, ir_node *val, compound_graph_path *path, int pos);
390 /** Returns the number of constant values needed to initialize the entity.
392 * Asserts if the entity has variability_uninitialized.
394 int get_compound_ent_n_values(entity *ent);
395 /** Returns a constant value given the position. */
396 ir_node *get_compound_ent_value(entity *ent, int pos);
397 /** Returns the access path for value at position pos. */
398 compound_graph_path *get_compound_ent_value_path(entity *ent, int pos);
399 /** Returns the position of a value with the given path.
400 * The path must contain array indicees for all array element entities. */
401 int get_compound_ent_pos_by_path(entity *ent, compound_graph_path *path);
402 /** Returns a constant value given the access path.
403 * The path must contain array indicees for all array element entities. */
404 ir_node *get_compound_ent_value_by_path(entity *ent, compound_graph_path *path);
406 /** Removes all constant entries where the path ends at value_ent. Does not
407 free the memory of the paths. (The same path might be used for several
408 constant entities. */
409 void remove_compound_ent_value(entity *ent, entity *value_ent);
411 /* Some languages support only trivial access paths, i.e., the member is a
412 direct, atomic member of the constant entities type. In this case the
413 corresponding entity can be accessed directly. The following functions
414 allow direct access. */
416 /** Generates a Path with length 1.
417 Beware: Has a bad runtime for array elements (O(|array|) and should be
418 avoided there. Use add_compound_ent_value_w_path() instead and create
419 the path manually. */
420 void add_compound_ent_value(entity *ent, ir_node *val, entity *member);
422 /** Returns the last member in the path */
423 entity *get_compound_ent_value_member(entity *ent, int pos);
425 /** Sets the path at pos 0 */
426 void set_compound_ent_value(entity *ent, ir_node *val, entity *member, int pos);
428 /** Initializes the entity ent which must be of a one dimensional
429 array type with the values given in the values array.
430 The array must have a lower and an upper bound. Keeps the
431 order of values. Does not test whether the number of values
432 fits into the given array size. Does not test whether the
433 values have the proper mode for the array. */
434 void set_array_entity_values(entity *ent, tarval **values, int num_vals);
436 /** Return the overall offset of value at position pos in bits.
438 * This requires that the layout of all concerned types is fixed.
440 * @param ent Any entity of compound type with at least pos initialization values.
441 * @param pos The position of the value for which the offset is requested.
443 int get_compound_ent_value_offset_bits(entity *ent, int pos);
445 /** Return the overall offset of value at position pos in bytes.
447 * This requires that the layout of all concerned types is fixed.
448 * Asserts if bit offset is not byte aligned.
450 * @param ent Any entity of compound type with at least pos initialization values.
451 * @param pos The position of the value for which the offset is requested.
453 int get_compound_ent_value_offset_bytes(entity *ent, int pos);
455 /** Compute the array indicees in compound graph paths of initialized entities.
457 * All arrays must have fixed lower and upper bounds. One array can
458 * have an open upper bound. If there are several open bounds, we do
459 * nothing. There must be initializer elements for all array
460 * elements. Uses the link field in the array element entities. The
461 * array bounds must be representable as integers.
463 * @param ent Any entity.
465 void compute_compound_ent_array_indicees(entity *ent);
467 /** Sort the values of the compound entity by their overall offset.
469 * This requires that the layout of all concerned types is fixed.
470 * If the entity has no initialization information the method just
471 * returns. This is needed to dump the entity in a backend.
473 * @param ent Any entity.
475 void sort_compound_ent_values(entity *ent);
478 /* --- Fields of entities with a class type as owner --- */
479 /* Overwrites is a field that specifies that an access to the overwritten
480 entity in the supertype must use this entity. It's a list as with
481 multiple inheritance several entities can be overwritten. This field
482 is mostly useful for method entities.
483 If a Sel node selects an entity that is overwritten by other entities it
484 must return a pointer to the entity of the dynamic type of the pointer
485 that is passed to it. Lowering of the Sel node must assure this.
486 Overwrittenby is the inverse of overwrites. Both add routines add
487 both relations, they only differ in the order of arguments. */
488 void add_entity_overwrites (entity *ent, entity *overwritten);
489 int get_entity_n_overwrites (entity *ent);
490 int get_entity_overwrites_index(entity *ent, entity *overwritten);
491 entity *get_entity_overwrites (entity *ent, int pos);
492 void set_entity_overwrites (entity *ent, int pos, entity *overwritten);
493 void remove_entity_overwrites(entity *ent, entity *overwritten);
495 void add_entity_overwrittenby (entity *ent, entity *overwrites);
496 int get_entity_n_overwrittenby (entity *ent);
497 int get_entity_overwrittenby_index(entity *ent, entity *overwrites);
498 entity *get_entity_overwrittenby (entity *ent, int pos);
499 void set_entity_overwrittenby (entity *ent, int pos, entity *overwrites);
500 void remove_entity_overwrittenby(entity *ent, entity *overwrites);
503 * Checks whether a pointer points to an entity.
505 * @param thing an arbitrary pointer
508 * true if the thing is an entity, else false
510 int is_entity (const void *thing);
512 /** Returns true if the type of the entity is a primitive, pointer
513 enumeration or method type. */
514 int is_atomic_entity(entity *ent);
515 /** Returns true if the type of the entity is a class, structure,
516 array or union type. */
517 int is_compound_entity(entity *ent);
518 /** Returns true if the type of the entity is a Method type. */
519 int is_method_entity(entity *ent);
521 /** Returns non-zero 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 int 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 the address
530 * of the type cast to long.
532 long get_entity_nr(entity *ent);
534 /** Returns the entities visited count. */
535 unsigned long get_entity_visited(entity *ent);
537 /** Sets the entities visited count. */
538 void set_entity_visited(entity *ent, unsigned long num);
540 /** Sets visited field in entity to entity_visited. */
541 void mark_entity_visited(entity *ent);
543 /** Returns true if this entity was visited. */
544 int entity_visited(entity *ent);
546 /** Returns true if this entity was not visited. */
547 int entity_not_visited(entity *ent);
550 * Returns the mask of the additional entity properties.
551 * The properties are automatically inherited from the irg if available
552 * or from the method type if they were not set using
553 * set_entity_additional_properties() or
554 * set_entity_additional_property().
556 unsigned get_entity_additional_properties(entity *ent);
558 /** Sets the mask of the additional graph properties. */
559 void set_entity_additional_properties(entity *ent, unsigned property_mask);
561 /** Sets one additional graph property. */
562 void set_entity_additional_property(entity *ent, mtp_additional_property flag);
564 /** Returns the class type that this type info entity represents or NULL
565 if ent is no type info entity. */
566 ir_type *get_entity_repr_class(const entity *ent);
569 * @page unknown_entity
571 * This entity is an auxiliary entity dedicated to support analyses.
573 * The unknown entity represents that there could be an entity, but it is not
574 * known. This entity can be used to initialize fields before an analysis (not known
575 * yet) or to represent the top of a lattice (could not be determined). There exists
576 * exactly one entity unknown. This entity has as owner and as type the unknown type. It is
577 * allocated when initializing the entity module.
579 * The entity can take the role of any entity, also methods. It returns default
580 * values in these cases.
582 * The following values are set:
583 * name = "unknown_entity"
584 * ld_name = "unknown_entity"
585 * owner = unknown_type
586 * type = unknown_type
587 * allocation = allocation_automatic
588 * visibility = visibility_external_allocated
590 * variability = variability_uninitialized
591 * value = SymConst(unknown_entity)
594 * peculiarity = peculiarity_existent
595 * volatility = volatility_non_volatile
596 * stickyness = stickyness_unsticky
599 * overwrittenby = NULL
603 /* A variable that contains the only unknown entity. */
604 extern entity *unknown_entity;
606 /** Returns the unknown entity */
607 entity *get_unknown_entity(void);
609 /** Encodes how a pointer parameter is accessed. */
610 typedef enum acc_bits {
611 ptr_access_none = 0, /**< no access */
612 ptr_access_read = 1, /**< read access */
613 ptr_access_write = 2, /**< write access */
614 ptr_access_rw = ptr_access_read|ptr_access_write, /**< read AND write access */
615 ptr_access_store = 4, /**< the pointer is stored */
616 ptr_access_all = ptr_access_rw|ptr_access_store /**< all possible access */
619 #define IS_READ(a) ((a) & ptr_access_read)
620 #define IS_WRITTEN(a) ((a) & ptr_access_write)
621 #define IS_STORED(a) ((a) & ptr_access_store)
624 * Supported image sections.
625 * Currently only methods can be placed in different sections.
628 section_text, /**< The code segment. This is the default for methods. */
629 section_constructors /**< The constructor section. */
632 /** Returns the section of a method. */
633 ir_img_section get_method_img_section(const entity *method);
635 /** Sets the section of a method. */
636 void set_method_img_section(entity *method, ir_img_section section);
638 #endif /* _FIRM_TR_ENTITY_H_ */