* - int offset: Offset in bits for this entity. Fixed when layout
* of owner is determined.
* - ir_graph *irg: If (type == method_type) this is the corresponding irg.
-* The ir_graph constructor automatically sets this field.
+* The ir_graph constructor automatically sets this field.
* If (type != method_type) access of this field will cause
* an assertion.
*/
-/* $Id$ */
-
# ifndef _ENTITY_H_
# define _ENTITY_H_
# include "type.h"
# include "dbginfo.h"
+# include "tr_inheritance.h"
+
/*-----------------------------------------------------------------*/
/* general */
/*-----------------------------------------------------------------*/
*
* Automatically inserts the new entity as a member of owner.
* Resets the overwrites/overwritten_by fields.
+ * Keeps the old atomic value.
+ * @@@ Maybe we should change this. If peculiarity of a method
+ * is existent, we should add a new SymConst that points to
+ * 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, type *new_owner);
*
* Automatically inserts the new entity as a member of owner.
* The mangled name ld_name is set to NULL.
+ * Overwrites relation is copied from old.
*/
entity *copy_entity_name (entity *old, ident *new_name);
void free_entity (entity *ent);
/** Returns the name of an entity. */
-const char *get_entity_name (entity *ent);
+const char *get_entity_name (const entity *ent);
/** Returns the ident of an entity. */
-ident *get_entity_ident (entity *ent);
+ident *get_entity_ident (const entity *ent);
/** Returns the mangled name of the entity.
*
void set_entity_ld_ident (entity *ent, ident *ld_ident);
/** Returns the mangled name of the entity as a string. */
-const char *get_entity_ld_name (entity *end);
+const char *get_entity_ld_name (entity *ent);
/** Returns the owner of the entity. */
type *get_entity_owner (entity *ent);
allocation_automatic, /**< The entity is allocated during runtime, implicitly
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 paramters from the allocation
+ 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
} ent_allocation;
/** Returns the allocation type of an entity. */
-ent_allocation get_entity_allocation (entity *ent);
+ent_allocation get_entity_allocation (const entity *ent);
/** Sets the allocation type of an entity. */
void set_entity_allocation (entity *ent, ent_allocation al);
/** Return the name of the allocation type. */
const char *get_allocation_name(ent_allocation vis);
-/**
- * This enumeration flags the visibility of entities. This is necessary
- * for partial compilation.
- */
-typedef enum {
- visibility_local, /**< The entity is only visible locally. This is the default. */
- visibility_external_visible, /**< The entity is visible to other external program parts, but
- it is defined here. It may not be optimized away. The entity must
- be static_allocated. */
- visibility_external_allocated /**< The entity is defined and allocated externally. This compilation
- must not allocate memory for this entity. The entity must
- be static_allocated. This can also be an external defined
- method. */
-} ent_visibility;
-
/** Returns the visibility of an entity. */
-ent_visibility get_entity_visibility (entity *ent);
+visibility get_entity_visibility (const entity *ent);
/** Sets the visibility of an entity. */
-void set_entity_visibility (entity *ent, ent_visibility vis);
+void set_entity_visibility (entity *ent, visibility vis);
/** Return the name of the visibility */
-const char *get_visibility_name(ent_visibility vis);
+const char *get_visibility_name(visibility vis);
/** This enumeration flags the variability of entities. */
typedef enum {
} ent_variability;
/** Returns the variability of an entity. */
-ent_variability get_entity_variability (entity *ent);
+ent_variability get_entity_variability (const entity *ent);
/** Sets the variability of an entity. */
void set_entity_variability (entity *ent, ent_variability var);
} ent_volatility;
/** Returns the volatility of an entity. */
-ent_volatility get_entity_volatility (entity *ent);
+ent_volatility get_entity_volatility (const entity *ent);
/** Sets the volatility of an entity. */
void set_entity_volatility (entity *ent, ent_volatility vol);
-/* Return the name of the volatility. */
+/** Return the name of the volatility. */
const char *get_volatility_name(ent_volatility var);
/** This enumeration flags the stickyness of an entity. */
} ent_stickyness;
/** Get the entity's stickyness */
-ent_stickyness get_entity_stickyness(entity *ent);
+ent_stickyness get_entity_stickyness(const entity *ent);
/** Set the entity's stickyness */
void set_entity_stickyness(entity *ent, ent_stickyness stickyness);
/** Returns the offset of an entity (in a compound) in bytes. Only set if layout = fixed. */
-int get_entity_offset_bytes(entity *ent);
+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(entity *ent);
+int get_entity_offset_bits(const 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_bits(entity *ent, int offset);
/** Returns the stored intermediate information. */
-void* get_entity_link(entity *ent);
+void* get_entity_link(const entity *ent);
/** Stores new intermediate information. */
void set_entity_link(entity *ent, void *l);
/* -- Fields of method entities -- */
-/* The entity knows the corresponding irg if the entity is a method.
+/** 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(entity *ent);
+ir_graph *get_entity_irg(const entity *ent);
void set_entity_irg(entity *ent, ir_graph *irg);
/** Return the peculiarity of an entity. */
-peculiarity get_entity_peculiarity (entity *ent);
+peculiarity get_entity_peculiarity (const entity *ent);
/** Sets the peculiarity of an entity. */
void set_entity_peculiarity (entity *ent, peculiarity pec);
int is_irn_const_expression(ir_node *n);
/* Set current_ir_graph to get_const_code_irg() to generate a constant
expression. */
-/* Copies a firm subgraph that complies to the restrictions for
- constant expressions to current_block in current_ir_graph. */
+
+/**
+ * Copies a firm subgraph that complies to the restrictions for
+ * constant expressions to current_block in current_ir_graph.
+ */
ir_node *copy_const_value(ir_node *n);
/* Set has no effect for existent entities of type method. */
int get_compound_graph_path_array_index(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,
+ * assumes the path is not complete and returns 'true'. */
+int is_proper_compound_graph_path(compound_graph_path *gr, int pos);
+
/* 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);
* Asserts if the entity has variability_uninitialized.
* */
int get_compound_ent_n_values(entity *ent);
+/** Returns a constant value given the position. */
ir_node *get_compound_ent_value(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);
-/* Removes all constant entries where the path ends at value_ent. Does not
+/** 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);
+/** 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);
+
+/** 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);
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 */
+
+/** generates a Path with length 1 */
void add_compound_ent_value(entity *ent, ir_node *val, entity *member);
-/* Returns the last member in the path */
+
+/** Returns the last member in the path */
entity *get_compound_ent_value_member(entity *ent, int pos);
-/* Sets the path at pos 0 */
+
+/** Sets the path at pos 0 */
void set_compound_ent_value(entity *ent, ir_node *val, entity *member, int pos);
/** Inits the entity ent witch must be of a one dimensional
* @return
* true if the thing is an entity, else false
*/
-int is_entity (void *thing);
+int is_entity (const void *thing);
/** Returns true if the type of the entity is a primitive, pointer
enumeration or method type. */
*/
bool equal_entity(entity *ent1, entity *ent2);
-
/** Outputs a unique number for this entity if libfirm is compiled for
debugging, (configure with --enable-debug) else returns 0. */
long get_entity_nr(entity *ent);
/** Returns true if this entity was not visited. */
bool entity_not_visited(entity *ent);
-/** Returns the dynamically referenced entity if the static entity and the
- * dynamic type are given. */
-entity *resolve_ent_polymorphy(type *dynamic_class, entity* static_ent);
-
-
-/*-----------------------------------------------------------------*/
-/* Debug aides */
-/*-----------------------------------------------------------------*/
-
-
-/** Write the entity and all its attributes to stdout.
+/**
+ * @page unknown_entity
*
- * Writes the entity and all its attributes to stdout if DEBUG_libfirm
- * is set. Else does nothing. */
-void dump_entity (entity *ent);
-
+ * This entity is an auxiliary entity dedicated to support analyses.
+ *
+ * The unknown entity represents that there could be an entity, but it is not
+ * known. This entity can be used to initialize fields before an analysis (not known
+ * yet) or to represent the top of a lattice (could not be determined). There exists
+ * exactly one entity unknown. This entity has as owner and as type the unknown type. It is
+ * allocated when initializing the entity module.
+ *
+ * The entity can take the role of any entity, also methods. It returns default
+ * values in these cases.
+ *
+ * The following values are set:
+ * name = "unknown_entity"
+ * ld_name = "unknown_entity"
+ * owner = unknown_type
+ * type = unknown_type
+ * visibility = visibility_external_allocated
+ * offset = -1
+ * variability = variability_uninitialized
+ * value = SymConst(unknown_entity)
+ * values = NULL
+ * val_paths = NULL
+ * peculiarity = peculiarity_existent
+ * volatility = volatility_non_volatile
+ * stickyness = stickyness_unsticky
+ * ld_name = NULL
+ * overwrites = NULL
+ * overwrittenby = NULL
+ * irg = NULL
+ * link = NULL
+ *
+ */
+/* A variable that contains the only unknown entity. */
+extern entity *unknown_entity;
+/* Returns the unknown entity */
+entity *get_unknown_entity(void);
# endif /* _ENTITY_H_ */
projects / libfirm / blobdiff