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.
40 #ifndef _FIRM_TR_ENTITY_H_
41 #define _FIRM_TR_ENTITY_H_
43 #include "firm_types.h"
46 #include "tr_inheritance.h"
48 /*-----------------------------------------------------------------*/
50 /*-----------------------------------------------------------------*/
53 * @page ir_entity Representation of an program entity.
55 * The type ir_entity is an abstract data type to represent program entities.
56 * If contains the following attributes:
58 * - owner: A compound type this entity is a part of.
59 * - type: The type of this entity.
60 * - name: The string that represents this entity in the source program.
61 * - allocation: A flag saying whether the entity is dynamically or statically
62 * allocated (values: dynamic_allocated, static_allocated,
63 * automatic_allocated).
64 * - visibility: A flag indicating the visibility of this entity (values: local,
65 * external_visible, external_allocated)
66 * - variability: A flag indicating the variability of this entity (values:
67 * uninitialized, initialized, part_constant, constant)
69 * - offset: The offset of the entity within the compound object in bytes. Only set
70 * if the owner in the state "layout_fixed".
71 * - offset_bits_remainder: The offset bit remainder of a bitfield entity (in a compound)
72 * in bits. Only set if the owner in the state "layout_fixed".
73 * - overwrites: A list of entities overwritten by this entity. This list is only
74 * existent if the owner of this entity is a class. The members in
75 * this list must be entities of super classes.
76 * - overwrittenby: A list of entities that overwrite this entity. This list is only
77 * existent if the owner of this entity is a class. The members in
78 * this list must be entities of sub classes.
79 * - link: A void* to associate some additional information with the entity.
80 * - irg: If the entity is a method this is the ir graph that represents the
82 * - peculiarity: The peculiarity of the entity. If the entity is a method this
83 * indicates whether the entity represents
84 * a real method or whether it only exists to describe an interface.
85 * In that case there nowhere exists code for this entity and this entity
86 * is never dynamically used in the code.
87 * Values: description, existent. Default: existent.
88 * - visited: visited flag. Master flag is type_visited.
90 * These fields can only be accessed via access functions.
95 /* to resolve recursion between entity.h and type.h */
96 /** the type of an entity */
97 #ifndef _ENTITY_TYPEDEF_
98 #define _ENTITY_TYPEDEF_
99 typedef struct ir_entity ir_entity, entity;
103 * Creates a new entity.
105 * Automatically inserts the entity as a member of owner.
106 * Entity is automatic_allocated and uninitialized except if the type
107 * is type_method, then it is static_allocated and constant. The constant
108 * value is a pointer to the method.
109 * Visibility is local, offset -1, and it is not volatile.
111 ir_entity *new_entity(ir_type *owner, ident *name, ir_type *tp);
114 * Creates a new entity.
116 * Automatically inserts the entity as a member of owner.
117 * The entity is automatic allocated and uninitialized except if the type
118 * is type_method, then it is static allocated and constant. The constant
119 * value is a pointer to the method.
120 * Visibility is local, offset -1, and it is not volatile.
122 ir_entity *new_d_entity(ir_type *owner, ident *name, ir_type *tp, dbg_info *db);
125 * Copies the entity if the new_owner is different from the
126 * 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 * Keeps the old atomic value.
131 * @@@ Maybe we should change this. If peculiarity of a method
132 * is existent, we should add a new SymConst that points to
133 * itself and not to the origin. Right now we have to change
134 * the peculiarity and then set a new atomic value by hand.
136 ir_entity *copy_entity_own(ir_entity *old, ir_type *new_owner);
139 * Copies the entity if the new_name is different from the
140 * name of the old entity, else returns the old entity.
142 * Automatically inserts the new entity as a member of owner.
143 * The mangled name ld_name is set to NULL.
144 * Overwrites relation is copied from old.
146 ir_entity *copy_entity_name(ir_entity *old, ident *new_name);
151 * The owner will still contain the pointer to this
152 * entity, as well as all other references!
154 void free_entity(ir_entity *ent);
156 /** Returns the name of an entity. */
157 const char *get_entity_name(const ir_entity *ent);
159 /** Returns the ident of an entity. */
160 ident *get_entity_ident(const ir_entity *ent);
162 /** Sets the ident of the entity. */
163 void set_entity_ident(ir_entity *ent, ident *id);
165 /** Returns the mangled name of the entity.
167 * If the mangled name is set it returns the existing name.
168 * Else it generates a name with mangle_entity()
169 * and remembers this new name internally.
171 ident *get_entity_ld_ident(ir_entity *ent);
173 /** Sets the mangled name of the entity. */
174 void set_entity_ld_ident(ir_entity *ent, ident *ld_ident);
176 /** Returns the mangled name of the entity as a string. */
177 const char *get_entity_ld_name(ir_entity *ent);
179 /** Returns the owner of the entity. */
180 ir_type *get_entity_owner(ir_entity *ent);
182 /** Sets the owner field in entity to owner. Don't forget to add
184 void set_entity_owner(ir_entity *ent, ir_type *owner);
186 /** Returns the type of an entity. */
187 ir_type *get_entity_type(ir_entity *ent);
189 /** Sets the type of an entity. */
190 void set_entity_type(ir_entity *ent, ir_type *tp);
192 /** The allocation type. */
194 allocation_automatic, /**< The entity is allocated during runtime, implicitly
195 as component of a compound type. This is the default. */
196 allocation_parameter, /**< The entity is a parameter. It is also automatic allocated.
197 We distinguish the allocation of parameters from the allocation
198 of local variables as their placement depends on the calling
200 allocation_dynamic, /**< The entity is allocated during runtime, explicitly
202 allocation_static /**< The entity is allocated statically. We can use a
203 Const as address of the entity. This is the default for methods. */
206 /** Returns the allocation type of an entity. */
207 ir_allocation get_entity_allocation(const ir_entity *ent);
209 /** Sets the allocation type of an entity. */
210 void set_entity_allocation(ir_entity *ent, ir_allocation al);
212 /** Return the name of the allocation type. */
213 const char *get_allocation_name(ir_allocation vis);
215 /** Returns the visibility of an entity. */
216 ir_visibility get_entity_visibility(const ir_entity *ent);
218 /** Sets the visibility of an entity. */
219 void set_entity_visibility(ir_entity *ent, ir_visibility vis);
221 /** Return the name of the visibility */
222 const char *get_visibility_name(ir_visibility vis);
224 /** This enumeration flags the variability of entities. */
226 variability_uninitialized, /**< The content of the entity is completely unknown. Default. */
227 variability_initialized, /**< After allocation the entity is initialized with the
228 value given somewhere in the entity. */
229 variability_part_constant, /**< For entities of compound types.
230 The members of the entity are mixed constant,
231 initialized or uninitialized. */
232 variability_constant /**< The entity is constant. */
235 /** Returns the variability of an entity. */
236 ir_variability get_entity_variability(const ir_entity *ent);
238 /** Sets the variability of an entity. */
239 void set_entity_variability(ir_entity *ent, ir_variability var);
241 /** Return the name of the variability. */
242 const char *get_variability_name(ir_variability var);
244 /** This enumeration flags the volatility of entities. */
246 volatility_non_volatile, /**< The entity is not volatile. Default. */
247 volatility_is_volatile /**< The entity is volatile */
250 /** Returns the volatility of an entity. */
251 ir_volatility get_entity_volatility(const ir_entity *ent);
253 /** Sets the volatility of an entity. */
254 void set_entity_volatility(ir_entity *ent, ir_volatility vol);
256 /** Return the name of the volatility. */
257 const char *get_volatility_name(ir_volatility var);
259 /** This enumeration flags the stickyness of an entity. */
261 stickyness_unsticky, /**< The entity can be removed from
262 the program, unless contraindicated
263 by other attributes. Default. */
264 stickyness_sticky /**< The entity must remain in the
265 program in any case. */
268 /** Get the entity's stickyness. */
269 ir_stickyness get_entity_stickyness(const ir_entity *ent);
271 /** Set the entity's stickyness. */
272 void set_entity_stickyness(ir_entity *ent, ir_stickyness stickyness);
274 /** Returns the offset of an entity (in a compound) in bytes. Only set if layout = fixed. */
275 int get_entity_offset(const ir_entity *ent);
277 /** Sets the offset of an entity (in a compound) in bytes. */
278 void set_entity_offset(ir_entity *ent, int offset);
280 /** Returns the offset bit remainder of a bitfield entity (in a compound) in bits. Only set if layout = fixed. */
281 unsigned char get_entity_offset_bits_remainder(const ir_entity *ent);
283 /** Sets the offset bit remainder of a bitfield entity (in a compound) in bits. */
284 void set_entity_offset_bits_remainder(ir_entity *ent, unsigned char offset);
286 /** Returns the stored intermediate information. */
287 void *get_entity_link(const ir_entity *ent);
289 /** Stores new intermediate information. */
290 void set_entity_link(ir_entity *ent, void *l);
292 /* -- Fields of method entities -- */
293 /** The entity knows the corresponding irg if the entity is a method.
294 This allows to get from a Call to the called irg.
295 Only entities of peculiarity "existent" can have a corresponding irg,
296 else the field is fixed to NULL. (Get returns NULL, set asserts.) */
297 ir_graph *get_entity_irg(const ir_entity *ent);
298 void set_entity_irg(ir_entity *ent, ir_graph *irg);
300 /** Gets the entity vtable number. */
301 unsigned get_entity_vtable_number(const ir_entity *ent);
303 /** Sets the entity vtable number. */
304 void set_entity_vtable_number(ir_entity *ent, unsigned vtable_number);
306 /** Return the peculiarity of an entity. */
307 ir_peculiarity get_entity_peculiarity(const ir_entity *ent);
309 /** Sets the peculiarity of an entity. */
310 void set_entity_peculiarity(ir_entity *ent, ir_peculiarity pec);
312 /** Checks if an entity cannot be overridden anymore. */
313 int get_entity_final(const ir_entity *ent);
315 /** Sets/resets the final flag of an entity. */
316 void set_entity_final(ir_entity *ent, int final);
318 /** Checks if an entity is compiler generated. */
319 int is_entity_compiler_generated(const ir_entity *ent);
321 /** Sets/resets the compiler generated flag. */
322 void set_entity_compiler_generated(ir_entity *ent, int flag);
324 /* -- Representation of constant values of entities -- */
326 * Returns true if the the node is representable as code on
329 * @deprecated This function is not used by libFirm and stays here
330 * only as a helper for the old Jack frontend.
332 int is_irn_const_expression(ir_node *n);
335 * Copies a Firm subgraph that complies to the restrictions for
336 * constant expressions to current_block in current_ir_graph.
338 * @param dbg debug info for all newly created nodes
341 * Set current_ir_graph to get_const_code_irg() to generate a constant
344 ir_node *copy_const_value(dbg_info *dbg, ir_node *n);
346 /* Set has no effect for existent entities of type method. */
347 ir_node *get_atomic_ent_value(ir_entity *ent);
348 void set_atomic_ent_value(ir_entity *ent, ir_node *val);
351 * The following type describes a path to a leave in the compound graph.
352 * Node 0 in the path must be an entity of type tp given in the constructor. If
353 * the type of this element is compound, the path node 1 is an element of the type
354 * of node 0 an so forth, until an entity of atomic type is reached.
356 #ifndef _COMPOUND_GRAPH_PATH_TYPEDEF_
357 #define _COMPOUND_GRAPH_PATH_TYPEDEF_
358 typedef struct compound_graph_path compound_graph_path;
359 #endif /* _COMPOUND_GRAPH_PATH_TYPEDEF_ */
361 /** Creates a new compound graph path. */
362 compound_graph_path *new_compound_graph_path(ir_type *tp, int length);
364 /** Returns non-zero if an object is a compound graph path */
365 int is_compound_graph_path(const void *thing);
367 /** Frees a graph path object */
368 void free_compound_graph_path (compound_graph_path *gr);
370 /** Returns the length of a graph path */
371 int get_compound_graph_path_length(const compound_graph_path *gr);
373 ir_entity *get_compound_graph_path_node(const compound_graph_path *gr, int pos);
374 void set_compound_graph_path_node(compound_graph_path *gr, int pos, ir_entity *node);
375 int get_compound_graph_path_array_index(const compound_graph_path *gr, int pos);
376 void set_compound_graph_path_array_index(compound_graph_path *gr, int pos, int index);
378 /** Checks whether the path up to pos is correct. If the path contains a NULL,
379 * assumes the path is not complete and returns non-zero. */
380 int is_proper_compound_graph_path(compound_graph_path *gr, int pos);
382 /* A value of a compound entity is a pair of a value and the description of the
383 corresponding access path to the member of the compound. */
384 void add_compound_ent_value_w_path(ir_entity *ent, ir_node *val, compound_graph_path *path);
385 void set_compound_ent_value_w_path(ir_entity *ent, ir_node *val, compound_graph_path *path, int pos);
386 /** Returns the number of constant values needed to initialize the entity.
388 * Asserts if the entity has variability_uninitialized.
390 int get_compound_ent_n_values(ir_entity *ent);
391 /** Returns a constant value given the position. */
392 ir_node *get_compound_ent_value(ir_entity *ent, int pos);
393 /** Returns the access path for value at position pos. */
394 compound_graph_path *get_compound_ent_value_path(ir_entity *ent, int pos);
395 /** Returns a constant value given the access path.
396 * The path must contain array indices for all array element entities. */
397 ir_node *get_compound_ent_value_by_path(ir_entity *ent, compound_graph_path *path);
399 /** Removes all constant entries where the path ends at value_ent. Does not
400 free the memory of the paths. (The same path might be used for several
401 constant entities. */
402 void remove_compound_ent_value(ir_entity *ent, ir_entity *value_ent);
404 /* Some languages support only trivial access paths, i.e., the member is a
405 direct, atomic member of the constant entities type. In this case the
406 corresponding entity can be accessed directly. The following functions
407 allow direct access. */
409 /** Generates a Path with length 1.
410 Beware: Has a bad runtime for array elements (O(|array|) and should be
411 avoided there. Use add_compound_ent_value_w_path() instead and create
412 the path manually. */
413 void add_compound_ent_value(ir_entity *ent, ir_node *val, ir_entity *member);
415 /** Returns the last member in the path */
416 ir_entity *get_compound_ent_value_member(ir_entity *ent, int pos);
418 /** Sets the path at pos 0 */
419 void set_compound_ent_value(ir_entity *ent, ir_node *val, ir_entity *member, int pos);
421 /** Initializes the entity ent which must be of a one dimensional
422 array type with the values given in the values array.
423 The array must have a lower and an upper bound. Keeps the
424 order of values. Does not test whether the number of values
425 fits into the given array size. Does not test whether the
426 values have the proper mode for the array. */
427 void set_array_entity_values(ir_entity *ent, tarval **values, int num_vals);
430 * Return the offset in bits from the last byte address.
432 * This requires that the layout of all concerned types is fixed.
434 * @param ent Any entity of compound type with at least pos initialization values.
435 * @param pos The position of the value for which the offset is requested.
437 int get_compound_ent_value_offset_bit_remainder(ir_entity *ent, int pos);
439 /** Return the overall offset of value at position pos in bytes.
441 * This requires that the layout of all concerned types is fixed.
442 * Asserts if bit offset is not byte aligned.
444 * @param ent Any entity of compound type with at least pos initialization values.
445 * @param pos The position of the value for which the offset is requested.
447 int get_compound_ent_value_offset_bytes(ir_entity *ent, int pos);
449 /** Compute the array indices in compound graph paths of initialized entities.
451 * All arrays must have fixed lower and upper bounds. One array can
452 * have an open upper bound. If there are several open bounds, we do
453 * nothing. There must be initializer elements for all array
454 * elements. Uses the link field in the array element entities. The
455 * array bounds must be representable as integers.
457 * @param ent Any entity.
458 * @return 0 in case of an error, 1 otherwise
460 int compute_compound_ent_array_indices(ir_entity *ent);
462 /* --- Fields of entities with a class type as owner --- */
463 /* Overwrites is a field that specifies that an access to the overwritten
464 entity in the supertype must use this entity. It's a list as with
465 multiple inheritance several entities can be overwritten. This field
466 is mostly useful for method entities.
467 If a Sel node selects an entity that is overwritten by other entities it
468 must return a pointer to the entity of the dynamic type of the pointer
469 that is passed to it. Lowering of the Sel node must assure this.
470 Overwrittenby is the inverse of overwrites. Both add routines add
471 both relations, they only differ in the order of arguments. */
472 void add_entity_overwrites (ir_entity *ent, ir_entity *overwritten);
473 int get_entity_n_overwrites (ir_entity *ent);
474 int get_entity_overwrites_index(ir_entity *ent, ir_entity *overwritten);
475 ir_entity *get_entity_overwrites (ir_entity *ent, int pos);
476 void set_entity_overwrites (ir_entity *ent, int pos, ir_entity *overwritten);
477 void remove_entity_overwrites(ir_entity *ent, ir_entity *overwritten);
479 void add_entity_overwrittenby (ir_entity *ent, ir_entity *overwrites);
480 int get_entity_n_overwrittenby (ir_entity *ent);
481 int get_entity_overwrittenby_index(ir_entity *ent, ir_entity *overwrites);
482 ir_entity *get_entity_overwrittenby (ir_entity *ent, int pos);
483 void set_entity_overwrittenby (ir_entity *ent, int pos, ir_entity *overwrites);
484 void remove_entity_overwrittenby(ir_entity *ent, ir_entity *overwrites);
487 * Checks whether a pointer points to an entity.
489 * @param thing an arbitrary pointer
492 * true if the thing is an entity, else false
494 int is_entity (const void *thing);
496 /** Returns true if the type of the entity is a primitive, pointer
497 * enumeration or method type.
499 * @Note This is a different classification than from is_primitive_type().
501 int is_atomic_entity(ir_entity *ent);
502 /** Returns true if the type of the entity is a class, structure,
503 array or union type. */
504 int is_compound_entity(ir_entity *ent);
505 /** Returns true if the type of the entity is a Method type. */
506 int is_method_entity(ir_entity *ent);
508 /** Returns non-zero if ent1 and ent2 have are equal except for their owner.
509 Two entities are equal if
510 - they have the same type (the same C-struct)
513 int equal_entity(ir_entity *ent1, ir_entity *ent2);
515 /** Outputs a unique number for this entity if libfirm is compiled for
516 * debugging, (configure with --enable-debug) else returns the address
517 * of the type cast to long.
519 long get_entity_nr(const ir_entity *ent);
521 /** Returns the entities visited count. */
522 unsigned long get_entity_visited(ir_entity *ent);
524 /** Sets the entities visited count. */
525 void set_entity_visited(ir_entity *ent, unsigned long num);
527 /** Sets visited field in entity to entity_visited. */
528 void mark_entity_visited(ir_entity *ent);
530 /** Returns true if this entity was visited. */
531 int entity_visited(ir_entity *ent);
533 /** Returns true if this entity was not visited. */
534 int entity_not_visited(ir_entity *ent);
537 * Returns the mask of the additional entity properties.
538 * The properties are automatically inherited from the irg if available
539 * or from the method type if they were not set using
540 * set_entity_additional_properties() or
541 * set_entity_additional_property().
543 unsigned get_entity_additional_properties(ir_entity *ent);
545 /** Sets the mask of the additional graph properties. */
546 void set_entity_additional_properties(ir_entity *ent, unsigned property_mask);
548 /** Sets one additional graph property. */
549 void set_entity_additional_property(ir_entity *ent, mtp_additional_property flag);
551 /** Returns the class type that this type info entity represents or NULL
552 if ent is no type info entity. */
553 ir_type *get_entity_repr_class(const ir_entity *ent);
556 * @page unknown_entity The Unknown entity
558 * This entity is an auxiliary entity dedicated to support analyses.
560 * The unknown entity represents that there could be an entity, but it is not
561 * known. This entity can be used to initialize fields before an analysis (not known
562 * yet) or to represent the top of a lattice (could not be determined). There exists
563 * exactly one entity unknown. This entity has as owner and as type the unknown type. It is
564 * allocated when initializing the entity module.
566 * The entity can take the role of any entity, also methods. It returns default
567 * values in these cases.
569 * The following values are set:
571 * - name = "unknown_entity"
572 * - ld_name = "unknown_entity"
573 * - owner = unknown_type
574 * - type = unknown_type
575 * - allocation = allocation_automatic
576 * - visibility = visibility_external_allocated
578 * - variability = variability_uninitialized
579 * - value = SymConst(unknown_entity)
582 * - peculiarity = peculiarity_existent
583 * - volatility = volatility_non_volatile
584 * - stickyness = stickyness_unsticky
586 * - overwrites = NULL
587 * - overwrittenby = NULL
591 /* A variable that contains the only unknown entity. */
592 extern ir_entity *unknown_entity;
594 /** Returns the @link unknown_entity unknown entity @endlink. */
595 ir_entity *get_unknown_entity(void);
597 /** Encodes how a pointer parameter is accessed. */
598 typedef enum acc_bits {
599 ptr_access_none = 0, /**< no access */
600 ptr_access_read = 1, /**< read access */
601 ptr_access_write = 2, /**< write access */
602 ptr_access_rw = ptr_access_read|ptr_access_write, /**< read AND write access */
603 ptr_access_store = 4, /**< the pointer is stored */
604 ptr_access_all = ptr_access_rw|ptr_access_store /**< all possible access */
607 #define IS_READ(a) ((a) & ptr_access_read)
608 #define IS_WRITTEN(a) ((a) & ptr_access_write)
609 #define IS_STORED(a) ((a) & ptr_access_store)
612 * Supported image sections.
613 * Currently only methods can be placed in different sections.
616 section_text, /**< The code segment. This is the default for methods. */
617 section_constructors /**< The constructor section. */
620 /** Returns the section of a method. */
621 ir_img_section get_method_img_section(const ir_entity *method);
623 /** Sets the section of a method. */
624 void set_method_img_section(ir_entity *method, ir_img_section section);
626 #endif /* _FIRM_TR_ENTITY_H_ */