* 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.
*/
/**
-* @file entity.h
-*
-* Entities represent all program known objects.
-*
-* @author Martin Trapp, Christian Schaefer
-* @author Goetz Lindenmaier
-*
-* An entity is the representation of program known objects in Firm.
-* The primary concept of entities is to represent members of complex
-* types, i.e., fields and methods of classes. As not all programming
-* language model all variables and methods as members of some class,
-* the concept of entities is extended to cover also local and global
-* variables, and arbitrary procedures.
-*
-* An entity always specifies the type of the object it represents and
-* the type of the object it is a part of, the owner of the entity.
-* Originally this is the type of the class of which the entity is a
-* member.
-* The owner of local variables is the procedure they are defined in.
-* The owner of global variables and procedures visible in the whole
-* program is a universally defined class type "GlobalType". The owner
-* of procedures defined in the scope of an other procedure is the
-* enclosing procedure.
-*
-* In detail the datastructure entity has the following fields:
-*
-* - ident *name: Name of this entity as specified in the source code.
-* Only unequivocal in conjuction with scope.
-* - ident *ld_name: Unique name of this entity, i.e., the mangled
-* name. E.g., for a class `A' with field `a' this
-* is the ident for `A_a'.
-* - type *type: The type of this entity, e.g., a method type, a
-* basic type of the language or a class itself.
-* - type *owner: The class this entity belongs to. In case of local
-* variables the method they are defined in.
-* - 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.
-* If (type != method_type) access of this field will cause
-* an assertion.
-*/
-
-# ifndef _ENTITY_H_
-# define _ENTITY_H_
-
-# include "ident.h"
-# include "type.h"
-# include "dbginfo.h"
-
-# include "tr_inheritance.h"
+ * @file entity.h
+ *
+ * Entities represent all program known objects.
+ *
+ * @author Martin Trapp, Christian Schaefer
+ * @author Goetz Lindenmaier
+ *
+ * An entity is the representation of program known objects in Firm.
+ * The primary concept of entities is to represent members of complex
+ * types, i.e., fields and methods of classes. As not all programming
+ * language model all variables and methods as members of some class,
+ * the concept of entities is extended to cover also local and global
+ * variables, and arbitrary procedures.
+ *
+ * An entity always specifies the type of the object it represents and
+ * the type of the object it is a part of, the owner of the entity.
+ * Originally this is the type of the class of which the entity is a
+ * member.
+ * The owner of local variables is the procedure they are defined in.
+ * The owner of global variables and procedures visible in the whole
+ * program is a universally defined class type "GlobalType". The owner
+ * of procedures defined in the scope of an other procedure is the
+ * enclosing procedure.
+ *
+ * In detail the datastructure entity has the following fields:
+ *
+ * - ident *name: Name of this entity as specified in the source code.
+ * Only unequivocal in conjuction with scope.
+ * - ident *ld_name: Unique name of this entity, i.e., the mangled
+ * name. E.g., for a class `A' with field `a' this
+ * is the ident for `A_a'.
+ * - ir_type *type: The type of this entity, e.g., a method type, a
+ * basic type of the language or a class itself.
+ * - ir_type *owner: The class this entity belongs to. In case of local
+ * variables the method they are defined in.
+ * - 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.
+ * If (type != method_type) access of this field will cause
+ * an assertion.
+ * - unsigned irg_add_properties:
+ * If (type == method_type) this mirrors the additional flags
+ * of the corresponding irg if set or is an own set for
+ * this entity. This construction allows to specify these
+ * flags even if no graph is available.
+ * If (type != method_type) access of this field will cause
+ * an assertion.
+ */
+#ifndef _FIRM_TR_ENTITY_H_
+#define _FIRM_TR_ENTITY_H_
-/*-----------------------------------------------------------------*/
-/* general */
-/*-----------------------------------------------------------------*/
+#include "firm_types.h"
+#include "dbginfo.h"
-/** Initalize entity module. */
-void init_entity (void);
+#include "tr_inheritance.h"
/*-----------------------------------------------------------------*/
/* ENTITY */
/*-----------------------------------------------------------------*/
-/* to resolve recursion between entity.h and irgraph.h */
-#ifndef _IR_GRAPH_TYPEDEF_
-#define _IR_GRAPH_TYPEDEF_
-typedef struct ir_graph ir_graph;
-#endif
-
/**
*
- * An abstract data type to represent program entites.
+ * An abstract data type to represent program entities.
*
* @param owner A compound type this entity is a part of.
* @param type The type of this entity.
* @param visibility A flag indicating the visibility of this entity (values: local,
* external_visible, external_allocated)
* @param variability A flag indicating the variability of this entity (values:
- * uninitialized, initalized, part_constant, constant)
+ * uninitialized, initialized, part_constant, constant)
* @param volatility @@@
* @param offset The offset of the entity within the compound object in bits. Only set
* if the owner in the state "layout_fixed".
* Creates a new entity.
*
* Automatically inserts the entity as a member of owner.
- * Entity is automatic_allocated and uninitialize except if the type
+ * Entity is automatic_allocated and uninitialized except if the type
* is type_method, then it is static_allocated and constant. The constant
* value is a pointer to the method.
* Visibility is local, offset -1, and it is not volatile.
*/
-entity *new_entity (type *owner, ident *name, type *tp);
+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 (type *owner, ident *name, type *tp, dbg_info *db);
+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, type *new_owner);
+entity *copy_entity_own (entity *old, ir_type *new_owner);
/**
* Copies the entity if the new_name is different from the
/** Returns the ident of an entity. */
ident *get_entity_ident (const entity *ent);
+/** Sets the ident of the entity. */
+void set_entity_ident (entity *ent, ident *id);
+
/** Returns the mangled name of the entity.
*
* If the mangled name is set it returns the existing name.
const char *get_entity_ld_name (entity *ent);
/** Returns the owner of the entity. */
-type *get_entity_owner (entity *ent);
+ir_type *get_entity_owner (entity *ent);
/** Sets the owner field in entity to owner. Don't forget to add
ent to owner!! */
-void set_entity_owner (entity *ent, type *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(type *owner);
+void assert_legal_owner_of_ent(ir_type *owner);
/** Returns the type of an entity. */
-type *get_entity_type (entity *ent);
+ir_type *get_entity_type (entity *ent);
/** Sets the type of an entity. */
-void set_entity_type (entity *ent, type *tp);
+void set_entity_type (entity *ent, ir_type *tp);
/** The allocation type. */
typedef enum {
allocation_dynamic, /**< The entity is allocated during runtime, explicitly
by an Alloc node. */
allocation_static /**< The entity is allocated statically. We can use a
- Const as address of the entity. */
+ Const as address of the entity. This is the default for methods. */
} ent_allocation;
/** Returns the allocation type of an entity. */
/** This enumeration flags the variability of entities. */
typedef enum {
- variability_uninitialized, /**< The content of the entity is completely unknown. */
+ 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. */
variability_part_constant, /**< For entities of compound types.
/** This enumeration flags the volatility of entities. */
typedef enum {
- volatility_non_volatile, /**< The entity is not volatile */
+ volatility_non_volatile, /**< The entity is not volatile. Default. */
volatility_is_volatile /**< The entity is volatile */
} ent_volatility;
typedef enum {
stickyness_unsticky, /**< The entity can be removed from
the program, unless contraindicated
- by other attributes */
+ by other attributes. Default. */
stickyness_sticky /**< The entity must remain in the
- program in any case */
+ program in any case. */
} ent_stickyness;
/** Get the entity's stickyness */
ir_graph *get_entity_irg(const entity *ent);
void set_entity_irg(entity *ent, ir_graph *irg);
+/** Gets the entity vtable number. */
+unsigned get_entity_vtable_number(entity *ent);
+
+/** Sets the entity vtable number. */
+void set_entity_vtable_number(entity *ent, unsigned vtable_number);
+
/** Return the peculiarity of an entity. */
peculiarity get_entity_peculiarity (const entity *ent);
/** Sets the peculiarity of an entity. */
void set_entity_peculiarity (entity *ent, peculiarity pec);
-/** Return the name of the peculiarity. */
-const char *get_peculiarity_name(peculiarity var);
-
/* -- Representation of constant values of entities -- */
/** Returns true if the the node is representable as code on
* const_code_irg. */
* 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);
+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);
#endif /* _COMPOUND_GRAPH_PATH_TYPEDEF_ */
/** Creates a new compound graph path. */
-compound_graph_path *new_compound_graph_path(type *tp, int length);
+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);
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'. */
+ * assumes the path is not complete and returns non-zero. */
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
/** 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
+/** Initializes the entity ent which must be of a one dimensional
array type with the values given in the values array.
The array must have a lower and an upper bound. Keeps the
order of values. Does not test whether the number of values
* have an open upper bound. If there are several open bounds, we do
* nothing. There must be initializer elements for all array
* elements. Uses the link field in the array element entities. The
- * array bounds must be representable as ints.
+ * array bounds must be representable as integers.
*
* @param ent Any entity.
*/
/* --- Fields of entities with a class type as owner --- */
/* Overwrites is a field that specifies that an access to the overwritten
entity in the supertype must use this entity. It's a list as with
- multiple inheritance several enitites can be overwritten. This field
+ multiple inheritance several entities can be overwritten. This field
is mostly useful for method entities.
If a Sel node selects an entity that is overwritten by other entities it
must return a pointer to the entity of the dynamic type of the pointer
/** Returns true if the type of the entity is a class, structure,
array or union type. */
int is_compound_entity(entity *ent);
+/** Returns true if the type of the entity is a Method type. */
+int is_method_entity(entity *ent);
-/** Returns true if ent1 and ent2 have are equal except for their owner.
+/** 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)
- ...?
*/
-bool equal_entity(entity *ent1, entity *ent2);
+int 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. */
+ * debugging, (configure with --enable-debug) else returns the address
+ * of the type cast to long.
+ */
long get_entity_nr(entity *ent);
-/** Returns the entitys visited count. */
+/** Returns the entities visited count. */
unsigned long get_entity_visited(entity *ent);
-/** Sets the entitys visited count. */
+/** Sets the entities visited count. */
void set_entity_visited(entity *ent, unsigned long num);
/** Sets visited field in entity to entity_visited. */
void mark_entity_visited(entity *ent);
/** Returns true if this entity was visited. */
-bool entity_visited(entity *ent);
+int entity_visited(entity *ent);
/** Returns true if this entity was not visited. */
-bool entity_not_visited(entity *ent);
+int entity_not_visited(entity *ent);
+
+/**
+ * Returns the mask of the additional entity properties.
+ * The properties are automatically inherited from the irg if available
+ * or from the method type if they were not set using
+ * set_entity_additional_properties() or
+ * set_entity_additional_property().
+ */
+unsigned get_entity_additional_properties(entity *ent);
+
+/** Sets the mask of the additional graph properties. */
+void set_entity_additional_properties(entity *ent, unsigned property_mask);
+
+/** Sets one additional graph property. */
+void set_entity_additional_property(entity *ent, mtp_additional_property flag);
/**
* @page unknown_entity
* ld_name = "unknown_entity"
* owner = unknown_type
* type = unknown_type
+ * allocation = allocation_automatic
* visibility = visibility_external_allocated
* offset = -1
* variability = variability_uninitialized
* overwrittenby = NULL
* irg = NULL
* link = NULL
- *
*/
/* A variable that contains the only unknown entity. */
extern entity *unknown_entity;
-/* Returns the unknown entity */
+
+/** Returns the unknown entity */
entity *get_unknown_entity(void);
-# endif /* _ENTITY_H_ */
+/** 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_all = ptr_access_rw|ptr_access_store /**< all possible access */
+} ptr_access_kind;
+
+#define IS_READ(a) ((a) & ptr_access_read)
+#define IS_WRITTEN(a) ((a) & ptr_access_write)
+#define IS_STORED(a) ((a) & ptr_access_store)
+
+#endif /* _FIRM_TR_ENTITY_H_ */
projects / libfirm / blobdiff