* File name: ir/tr/entity.h
* Purpose: Representation of all program known entities.
* Author: Martin Trapp, Christian Schaefer
- * Modified by: Goetz Lindenmaier
+ * Modified by: Goetz Lindenmaier, Michael Beck
* Created:
* CVS-ID: $Id$
- * Copyright: (c) 1998-2003 Universität Karlsruhe
+ * Copyright: (c) 1998-2006 Universität Karlsruhe
* Licence: This file protected by GPL - GNU GENERAL PUBLIC LICENSE.
*/
* of procedures defined in the scope of an other procedure is the
* enclosing procedure.
*
- * In detail the datastructure entity has the following fields:
+ * In detail the datastructure ir_entity has the following fields:
*
* - ident *name: Name of this entity as specified in the source code.
* Only unequivocal in conjuction with scope.
* If (type != method_type) access of this field will cause
* an assertion.
*/
-#ifndef _ENTITY_H_
-#define _ENTITY_H_
+#ifndef _FIRM_TR_ENTITY_H_
+#define _FIRM_TR_ENTITY_H_
#include "firm_types.h"
#include "dbginfo.h"
/** the type of an entity */
#ifndef _ENTITY_TYPEDEF_
#define _ENTITY_TYPEDEF_
-typedef struct entity entity;
+typedef struct ir_entity ir_entity, entity;
#endif
/**
* value is a pointer to the method.
* Visibility is local, offset -1, and it is not volatile.
*/
-entity *new_entity (ir_type *owner, ident *name, ir_type *tp);
+ir_entity *new_entity(ir_type *owner, ident *name, ir_type *tp);
/**
* Creates a new entity.
* value is a pointer to the method.
* Visibility is local, offset -1, and it is not volatile.
*/
-entity *new_d_entity (ir_type *owner, ident *name, ir_type *tp, dbg_info *db);
+ir_entity *new_d_entity(ir_type *owner, ident *name, ir_type *tp, dbg_info *db);
/**
* Copies the entity if the new_owner is different from the
* itself and not to the origin. Right now we have to change
* the peculiarity and then set a new atomic value by hand.
*/
-entity *copy_entity_own (entity *old, ir_type *new_owner);
+ir_entity *copy_entity_own(ir_entity *old, ir_type *new_owner);
/**
* Copies the entity if the new_name is different from the
* The mangled name ld_name is set to NULL.
* Overwrites relation is copied from old.
*/
-entity *copy_entity_name (entity *old, ident *new_name);
+ir_entity *copy_entity_name(ir_entity *old, ident *new_name);
/**
* Frees the entity.
* The owner will still contain the pointer to this
* entity, as well as all other references!
*/
-void free_entity (entity *ent);
+void free_entity(ir_entity *ent);
/** Returns the name of an entity. */
-const char *get_entity_name (const entity *ent);
+const char *get_entity_name(const ir_entity *ent);
/** Returns the ident of an entity. */
-ident *get_entity_ident (const entity *ent);
+ident *get_entity_ident(const ir_entity *ent);
+
+/** Sets the ident of the entity. */
+void set_entity_ident(ir_entity *ent, ident *id);
/** Returns the mangled name of the entity.
*
* Else it generates a name with mangle_entity()
* and remembers this new name internally.
*/
-ident *get_entity_ld_ident (entity *ent);
+ident *get_entity_ld_ident(ir_entity *ent);
/** Sets the mangled name of the entity. */
-void set_entity_ld_ident (entity *ent, ident *ld_ident);
+void set_entity_ld_ident(ir_entity *ent, ident *ld_ident);
/** Returns the mangled name of the entity as a string. */
-const char *get_entity_ld_name (entity *ent);
+const char *get_entity_ld_name(ir_entity *ent);
/** Returns the owner of the entity. */
-ir_type *get_entity_owner (entity *ent);
+ir_type *get_entity_owner(ir_entity *ent);
/** Sets the owner field in entity to owner. Don't forget to add
ent to owner!! */
-void set_entity_owner (entity *ent, ir_type *owner);
-
-/** Asserts if the type owner is either a compound type or an array */
-void assert_legal_owner_of_ent(ir_type *owner);
+void set_entity_owner(ir_entity *ent, ir_type *owner);
/** Returns the type of an entity. */
-ir_type *get_entity_type (entity *ent);
+ir_type *get_entity_type(ir_entity *ent);
/** Sets the type of an entity. */
-void set_entity_type (entity *ent, ir_type *tp);
+void set_entity_type(ir_entity *ent, ir_type *tp);
/** The allocation type. */
typedef enum {
allocation_automatic, /**< The entity is allocated during runtime, implicitly
- as component of a compound type. This is the default. */
+ as component of a compound type. This is the default. */
allocation_parameter, /**< The entity is a parameter. It is also automatic allocated.
- We distinguish the allocation of parameters from the allocation
- of local variables as their placement depends on the calling
- conventions. */
+ We distinguish the allocation of parameters from the allocation
+ of local variables as their placement depends on the calling
+ conventions. */
allocation_dynamic, /**< The entity is allocated during runtime, explicitly
- by an Alloc node. */
+ by an Alloc node. */
allocation_static /**< The entity is allocated statically. We can use a
- Const as address of the entity. */
-} ent_allocation;
+ Const as address of the entity. This is the default for methods. */
+} ir_allocation;
/** Returns the allocation type of an entity. */
-ent_allocation get_entity_allocation (const entity *ent);
+ir_allocation get_entity_allocation(const ir_entity *ent);
/** Sets the allocation type of an entity. */
-void set_entity_allocation (entity *ent, ent_allocation al);
+void set_entity_allocation(ir_entity *ent, ir_allocation al);
/** Return the name of the allocation type. */
-const char *get_allocation_name(ent_allocation vis);
+const char *get_allocation_name(ir_allocation vis);
/** Returns the visibility of an entity. */
-visibility get_entity_visibility (const entity *ent);
+ir_visibility get_entity_visibility(const ir_entity *ent);
/** Sets the visibility of an entity. */
-void set_entity_visibility (entity *ent, visibility vis);
+void set_entity_visibility(ir_entity *ent, ir_visibility vis);
/** Return the name of the visibility */
-const char *get_visibility_name(visibility vis);
+const char *get_visibility_name(ir_visibility vis);
/** This enumeration flags the variability of entities. */
typedef enum {
variability_uninitialized, /**< The content of the entity is completely unknown. Default. */
variability_initialized, /**< After allocation the entity is initialized with the
- value given somewhere in the entity. */
+ value given somewhere in the entity. */
variability_part_constant, /**< For entities of compound types.
- The members of the entity are mixed constant,
- initialized or uninitialized. */
+ The members of the entity are mixed constant,
+ initialized or uninitialized. */
variability_constant /**< The entity is constant. */
-} ent_variability;
+} ir_variability;
/** Returns the variability of an entity. */
-ent_variability get_entity_variability (const entity *ent);
+ir_variability get_entity_variability(const ir_entity *ent);
/** Sets the variability of an entity. */
-void set_entity_variability (entity *ent, ent_variability var);
+void set_entity_variability(ir_entity *ent, ir_variability var);
/** Return the name of the variability. */
-const char *get_variability_name(ent_variability var);
+const char *get_variability_name(ir_variability var);
/** This enumeration flags the volatility of entities. */
typedef enum {
volatility_non_volatile, /**< The entity is not volatile. Default. */
volatility_is_volatile /**< The entity is volatile */
-} ent_volatility;
+} ir_volatility;
/** Returns the volatility of an entity. */
-ent_volatility get_entity_volatility (const entity *ent);
+ir_volatility get_entity_volatility(const ir_entity *ent);
/** Sets the volatility of an entity. */
-void set_entity_volatility (entity *ent, ent_volatility vol);
+void set_entity_volatility(ir_entity *ent, ir_volatility vol);
/** Return the name of the volatility. */
-const char *get_volatility_name(ent_volatility var);
+const char *get_volatility_name(ir_volatility var);
/** This enumeration flags the stickyness of an entity. */
typedef enum {
by other attributes. Default. */
stickyness_sticky /**< The entity must remain in the
program in any case. */
-} ent_stickyness;
+} ir_stickyness;
-/** Get the entity's stickyness */
-ent_stickyness get_entity_stickyness(const entity *ent);
+/** Get the entity's stickyness. */
+ir_stickyness get_entity_stickyness(const ir_entity *ent);
-/** Set the entity's stickyness */
-void set_entity_stickyness(entity *ent, ent_stickyness stickyness);
+/** Set the entity's stickyness. */
+void set_entity_stickyness(ir_entity *ent, ir_stickyness stickyness);
/** Returns the offset of an entity (in a compound) in bytes. Only set if layout = fixed. */
-int get_entity_offset_bytes(const entity *ent);
-
-/** Returns the offset of an entity (in a compound) in bits. Only set if layout = fixed. */
-int get_entity_offset_bits(const entity *ent);
+int get_entity_offset(const ir_entity *ent);
/** Sets the offset of an entity (in a compound) in bytes. */
-void set_entity_offset_bytes(entity *ent, int offset);
+void set_entity_offset(ir_entity *ent, int offset);
+
+/** Returns the offset bit remainder of a bitfield entity (in a compound) in bits. Only set if layout = fixed. */
+unsigned char get_entity_offset_bits_remainder(const ir_entity *ent);
-/** Sets the offset of an entity (in a compound) in bits. */
-void set_entity_offset_bits(entity *ent, int offset);
+/** Sets the offset bit remainder of a bitfield entity (in a compound) in bits. */
+void set_entity_offset_bits_remainder(ir_entity *ent, unsigned char offset);
/** Returns the stored intermediate information. */
-void* get_entity_link(const entity *ent);
+void *get_entity_link(const ir_entity *ent);
/** Stores new intermediate information. */
-void set_entity_link(entity *ent, void *l);
+void set_entity_link(ir_entity *ent, void *l);
/* -- Fields of method entities -- */
/** The entity knows the corresponding irg if the entity is a method.
This allows to get from a Call to the called irg.
Only entities of peculiarity "existent" can have a corresponding irg,
else the field is fixed to NULL. (Get returns NULL, set asserts.) */
-ir_graph *get_entity_irg(const entity *ent);
-void set_entity_irg(entity *ent, ir_graph *irg);
+ir_graph *get_entity_irg(const ir_entity *ent);
+void set_entity_irg(ir_entity *ent, ir_graph *irg);
+
+/** Gets the entity vtable number. */
+unsigned get_entity_vtable_number(ir_entity *ent);
+
+/** Sets the entity vtable number. */
+void set_entity_vtable_number(ir_entity *ent, unsigned vtable_number);
/** Return the peculiarity of an entity. */
-peculiarity get_entity_peculiarity (const entity *ent);
+ir_peculiarity get_entity_peculiarity(const ir_entity *ent);
/** Sets the peculiarity of an entity. */
-void set_entity_peculiarity (entity *ent, peculiarity pec);
+void set_entity_peculiarity(ir_entity *ent, ir_peculiarity pec);
+
+/** Checks if an entity cannot be overridden anymore. */
+int get_entity_final(const ir_entity *ent);
-/** Return the name of the peculiarity. */
-const char *get_peculiarity_name(peculiarity var);
+/** Sets/resets the final flag of an entity. */
+void set_entity_final(ir_entity *ent, int final);
+
+/** Checks if an entity is compiler generated. */
+int is_entity_compiler_generated(const ir_entity *ent);
+
+/** Sets/resets the compiler generated flag. */
+void set_entity_compiler_generated(ir_entity *ent, int flag);
/* -- Representation of constant values of entities -- */
/** Returns true if the the node is representable as code on
ir_node *copy_const_value(dbg_info *dbg, ir_node *n);
/* Set has no effect for existent entities of type method. */
-ir_node *get_atomic_ent_value(entity *ent);
-void set_atomic_ent_value(entity *ent, ir_node *val);
+ir_node *get_atomic_ent_value(ir_entity *ent);
+void set_atomic_ent_value(ir_entity *ent, ir_node *val);
/**
* The following type describes a path to a leave in the compound graph.
compound_graph_path *new_compound_graph_path(ir_type *tp, int length);
/** Returns non-zero if an object is a compound graph path */
-int is_compound_graph_path(void *thing);
+int is_compound_graph_path(const void *thing);
/** Frees a graph path object */
void free_compound_graph_path (compound_graph_path *gr);
/** Returns the length of a graph path */
-int get_compound_graph_path_length(compound_graph_path *gr);
+int get_compound_graph_path_length(const compound_graph_path *gr);
-entity *get_compound_graph_path_node(compound_graph_path *gr, int pos);
-void set_compound_graph_path_node(compound_graph_path *gr, int pos, entity *node);
-int get_compound_graph_path_array_index(compound_graph_path *gr, int pos);
+ir_entity *get_compound_graph_path_node(const compound_graph_path *gr, int pos);
+void set_compound_graph_path_node(compound_graph_path *gr, int pos, ir_entity *node);
+int get_compound_graph_path_array_index(const compound_graph_path *gr, int pos);
void set_compound_graph_path_array_index(compound_graph_path *gr, int pos, int index);
/** Checks whether the path up to pos is correct. If the path contains a NULL,
/* A value of a compound entity is a pair of a value and the description of the
corresponding access path to the member of the compound. */
-void add_compound_ent_value_w_path(entity *ent, ir_node *val, compound_graph_path *path);
-void set_compound_ent_value_w_path(entity *ent, ir_node *val, compound_graph_path *path, int pos);
+void add_compound_ent_value_w_path(ir_entity *ent, ir_node *val, compound_graph_path *path);
+void set_compound_ent_value_w_path(ir_entity *ent, ir_node *val, compound_graph_path *path, int pos);
/** Returns the number of constant values needed to initialize the entity.
*
* Asserts if the entity has variability_uninitialized.
* */
-int get_compound_ent_n_values(entity *ent);
+int get_compound_ent_n_values(ir_entity *ent);
/** Returns a constant value given the position. */
-ir_node *get_compound_ent_value(entity *ent, int pos);
+ir_node *get_compound_ent_value(ir_entity *ent, int pos);
/** Returns the access path for value at position pos. */
-compound_graph_path *get_compound_ent_value_path(entity *ent, int pos);
+compound_graph_path *get_compound_ent_value_path(ir_entity *ent, int pos);
/** Returns the position of a value with the given path.
- * The path must contain array indicees for all array element entities. */
-int get_compound_ent_pos_by_path(entity *ent, compound_graph_path *path);
+ * The path must contain array indices for all array element entities. */
+int get_compound_ent_pos_by_path(ir_entity *ent, compound_graph_path *path);
/** Returns a constant value given the access path.
- * The path must contain array indicees for all array element entities. */
-ir_node *get_compound_ent_value_by_path(entity *ent, compound_graph_path *path);
+ * The path must contain array indices for all array element entities. */
+ir_node *get_compound_ent_value_by_path(ir_entity *ent, compound_graph_path *path);
/** Removes all constant entries where the path ends at value_ent. Does not
free the memory of the paths. (The same path might be used for several
constant entities. */
-void remove_compound_ent_value(entity *ent, entity *value_ent);
+void remove_compound_ent_value(ir_entity *ent, ir_entity *value_ent);
/* Some languages support only trivial access paths, i.e., the member is a
direct, atomic member of the constant entities type. In this case the
corresponding entity can be accessed directly. The following functions
allow direct access. */
-/** generates a Path with length 1 */
-void add_compound_ent_value(entity *ent, ir_node *val, entity *member);
+/** Generates a Path with length 1.
+ Beware: Has a bad runtime for array elements (O(|array|) and should be
+ avoided there. Use add_compound_ent_value_w_path() instead and create
+ the path manually. */
+void add_compound_ent_value(ir_entity *ent, ir_node *val, ir_entity *member);
/** Returns the last member in the path */
-entity *get_compound_ent_value_member(entity *ent, int pos);
+ir_entity *get_compound_ent_value_member(ir_entity *ent, int pos);
/** Sets the path at pos 0 */
-void set_compound_ent_value(entity *ent, ir_node *val, entity *member, int pos);
+void set_compound_ent_value(ir_entity *ent, ir_node *val, ir_entity *member, int pos);
/** Initializes the entity ent which must be of a one dimensional
array type with the values given in the values array.
order of values. Does not test whether the number of values
fits into the given array size. Does not test whether the
values have the proper mode for the array. */
-void set_array_entity_values(entity *ent, tarval **values, int num_vals);
+void set_array_entity_values(ir_entity *ent, tarval **values, int num_vals);
-/** Return the overall offset of value at position pos in bits.
+/**
+ * Return the offset in bits from the last byte address.
*
* This requires that the layout of all concerned types is fixed.
*
* @param ent Any entity of compound type with at least pos initialization values.
* @param pos The position of the value for which the offset is requested.
*/
-int get_compound_ent_value_offset_bits(entity *ent, int pos);
+int get_compound_ent_value_offset_bit_remainder(ir_entity *ent, int pos);
/** Return the overall offset of value at position pos in bytes.
*
* @param ent Any entity of compound type with at least pos initialization values.
* @param pos The position of the value for which the offset is requested.
*/
-int get_compound_ent_value_offset_bytes(entity *ent, int pos);
+int get_compound_ent_value_offset_bytes(ir_entity *ent, int pos);
-/** Compute the array indicees in compound graph paths of initialized entities.
+/** Compute the array indices in compound graph paths of initialized entities.
*
* All arrays must have fixed lower and upper bounds. One array can
* have an open upper bound. If there are several open bounds, we do
* array bounds must be representable as integers.
*
* @param ent Any entity.
+ * @return 0 in case of an error, 1 otherwise
*/
-void compute_compound_ent_array_indicees(entity *ent);
-
-/** Sort the values of the compound entity by their overall offset.
- *
- * This requires that the layout of all concerned types is fixed.
- * If the entity has no initialization information the method just
- * returns. This is needed to dump the entity in a backend.
- *
- * @param ent Any entity.
- */
-void sort_compound_ent_values(entity *ent);
-
+int compute_compound_ent_array_indices(ir_entity *ent);
/* --- Fields of entities with a class type as owner --- */
/* Overwrites is a field that specifies that an access to the overwritten
that is passed to it. Lowering of the Sel node must assure this.
Overwrittenby is the inverse of overwrites. Both add routines add
both relations, they only differ in the order of arguments. */
-void add_entity_overwrites (entity *ent, entity *overwritten);
-int get_entity_n_overwrites (entity *ent);
-int get_entity_overwrites_index(entity *ent, entity *overwritten);
-entity *get_entity_overwrites (entity *ent, int pos);
-void set_entity_overwrites (entity *ent, int pos, entity *overwritten);
-void remove_entity_overwrites(entity *ent, entity *overwritten);
-
-void add_entity_overwrittenby (entity *ent, entity *overwrites);
-int get_entity_n_overwrittenby (entity *ent);
-int get_entity_overwrittenby_index(entity *ent, entity *overwrites);
-entity *get_entity_overwrittenby (entity *ent, int pos);
-void set_entity_overwrittenby (entity *ent, int pos, entity *overwrites);
-void remove_entity_overwrittenby(entity *ent, entity *overwrites);
+void add_entity_overwrites (ir_entity *ent, ir_entity *overwritten);
+int get_entity_n_overwrites (ir_entity *ent);
+int get_entity_overwrites_index(ir_entity *ent, ir_entity *overwritten);
+ir_entity *get_entity_overwrites (ir_entity *ent, int pos);
+void set_entity_overwrites (ir_entity *ent, int pos, ir_entity *overwritten);
+void remove_entity_overwrites(ir_entity *ent, ir_entity *overwritten);
+
+void add_entity_overwrittenby (ir_entity *ent, ir_entity *overwrites);
+int get_entity_n_overwrittenby (ir_entity *ent);
+int get_entity_overwrittenby_index(ir_entity *ent, ir_entity *overwrites);
+ir_entity *get_entity_overwrittenby (ir_entity *ent, int pos);
+void set_entity_overwrittenby (ir_entity *ent, int pos, ir_entity *overwrites);
+void remove_entity_overwrittenby(ir_entity *ent, ir_entity *overwrites);
/**
* Checks whether a pointer points to an entity.
/** Returns true if the type of the entity is a primitive, pointer
enumeration or method type. */
-int is_atomic_entity(entity *ent);
+int is_atomic_entity(ir_entity *ent);
/** Returns true if the type of the entity is a class, structure,
array or union type. */
-int is_compound_entity(entity *ent);
+int is_compound_entity(ir_entity *ent);
+/** Returns true if the type of the entity is a Method type. */
+int is_method_entity(ir_entity *ent);
/** Returns non-zero if ent1 and ent2 have are equal except for their owner.
Two entities are equal if
- they have the same type (the same C-struct)
- ...?
*/
-int equal_entity(entity *ent1, entity *ent2);
+int equal_entity(ir_entity *ent1, ir_entity *ent2);
/** Outputs a unique number for this entity if libfirm is compiled for
* debugging, (configure with --enable-debug) else returns the address
* of the type cast to long.
*/
-long get_entity_nr(entity *ent);
+long get_entity_nr(ir_entity *ent);
/** Returns the entities visited count. */
-unsigned long get_entity_visited(entity *ent);
+unsigned long get_entity_visited(ir_entity *ent);
/** Sets the entities visited count. */
-void set_entity_visited(entity *ent, unsigned long num);
+void set_entity_visited(ir_entity *ent, unsigned long num);
/** Sets visited field in entity to entity_visited. */
-void mark_entity_visited(entity *ent);
+void mark_entity_visited(ir_entity *ent);
/** Returns true if this entity was visited. */
-int entity_visited(entity *ent);
+int entity_visited(ir_entity *ent);
/** Returns true if this entity was not visited. */
-int entity_not_visited(entity *ent);
+int entity_not_visited(ir_entity *ent);
/**
* Returns the mask of the additional entity properties.
* set_entity_additional_properties() or
* set_entity_additional_property().
*/
-unsigned get_entity_additional_properties(entity *ent);
+unsigned get_entity_additional_properties(ir_entity *ent);
/** Sets the mask of the additional graph properties. */
-void set_entity_additional_properties(entity *ent, unsigned property_mask);
+void set_entity_additional_properties(ir_entity *ent, unsigned property_mask);
/** Sets one additional graph property. */
-void set_entity_additional_property(entity *ent, mtp_additional_property flag);
+void set_entity_additional_property(ir_entity *ent, mtp_additional_property flag);
+
+/** Returns the class type that this type info entity represents or NULL
+ if ent is no type info entity. */
+ir_type *get_entity_repr_class(const ir_entity *ent);
/**
* @page unknown_entity
* link = NULL
*/
/* A variable that contains the only unknown entity. */
-extern entity *unknown_entity;
+extern ir_entity *unknown_entity;
/** Returns the unknown entity */
entity *get_unknown_entity(void);
/** Encodes how a pointer parameter is accessed. */
typedef enum acc_bits {
- ptr_access_none = 0, /**< no access */
- ptr_access_read = 1, /**< read access */
- ptr_access_write = 2, /**< write access */
- ptr_access_rw = ptr_access_read|ptr_access_write, /**< read AND write access */
- ptr_access_store = 4, /**< the pointer is stored */
+ ptr_access_none = 0, /**< no access */
+ ptr_access_read = 1, /**< read access */
+ ptr_access_write = 2, /**< write access */
+ ptr_access_rw = ptr_access_read|ptr_access_write, /**< read AND write access */
+ ptr_access_store = 4, /**< the pointer is stored */
ptr_access_all = ptr_access_rw|ptr_access_store /**< all possible access */
} ptr_access_kind;
-#endif /* _ENTITY_H_ */
+#define IS_READ(a) ((a) & ptr_access_read)
+#define IS_WRITTEN(a) ((a) & ptr_access_write)
+#define IS_STORED(a) ((a) & ptr_access_store)
+
+/**
+ * Supported image sections.
+ * Currently only methods can be placed in different sections.
+ */
+typedef enum {
+ section_text, /**< The code segment. This is the default for methods. */
+ section_constructors /**< The constructor section. */
+} ir_img_section;
+
+/** Returns the section of a method. */
+ir_img_section get_method_img_section(const ir_entity *method);
+
+/** Sets the section of a method. */
+void set_method_img_section(ir_entity *method, ir_img_section section);
+
+#endif /* _FIRM_TR_ENTITY_H_ */
projects / libfirm / blobdiff