X-Git-Url: http://nsz.repo.hu/git/?a=blobdiff_plain;f=ir%2Ftr%2Fentity.h;h=e6c2cd2f4095bb6a433903d38b5e42ce137975e7;hb=da9c4a1519a03db4b6a4cbd79dff05f69387611f;hp=89d23dbc31b0113ae020021179c32c6fd11e03c0;hpb=66b4ee69562e61429ef96ef718fc3ca0511c47f9;p=libfirm diff --git a/ir/tr/entity.h b/ir/tr/entity.h index 89d23dbc3..e6c2cd2f4 100644 --- a/ir/tr/entity.h +++ b/ir/tr/entity.h @@ -39,15 +39,18 @@ ** 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 +** If (type != method_type) access of this field will cause ** an assertion. */ +/* $Id$ */ + # ifndef _ENTITY_H_ # define _ENTITY_H_ # include "ident.h" # include "type.h" +# include "dbginfo.h" /*******************************************************************/ /** general **/ @@ -60,9 +63,9 @@ void init_entity (void); /** ENTITY **/ /*******************************************************************/ +/* to resolve recursion between entity.h and irgraph.h */ #ifndef _IR_GRAPH_TYPEDEF_ #define _IR_GRAPH_TYPEDEF_ -/* to resolve recursion between entity.h and irgraph.h */ typedef struct ir_graph ir_graph; #endif @@ -77,18 +80,31 @@ typedef struct ir_graph ir_graph; * type The type of this entity. * name The string that represents this entity in the source program. * allocation A flag saying whether the entity is dynamically or statically - * allocated (values: dynamic_allocated, static_allocated). - * @@@ Does this make sense??? + * allocated (values: dynamic_allocated, static_allocated, + * automatic_allocated). * visibility A flag indicating the visibility of this entity (values: local, * external_visible, external_allocated) + * variability A flag indicating the variability of this entity (values: + * uninitialized, initalized, part_constant, constant) + * volatility @@@ * offset The offset of the entity within the compound object. Only set - * if IR in the state "@@@" Wie nennen wir den?? + * if the owner in the state "layout_fixed". * overwrites A list of entities overwritten by this entity. This list is only * existent if the owner of this entity is a class. The members in * this list must be entities of super classes. + * overwrittenby A list of entities that overwrite this entity. This list is only + * existent if the owner of this entity is a class. The members in + * this list must be entities of sub classes. + * link A void* to associate some additional information with the entity. * irg If the entity is a method this is the ir graph that represents the * code of the method. - * + * peculiarity The peculiarity of the entity. If the entity is a method this + * indicates whether the entity represents + * a real method or whether it only exists to describe an interface. + * In that case there nowhere exists code for this entity and this entity + * is never dynamically used in the code. + * Values: description, existent. Default: existent. + * visited visited flag. Master flag is type_visited. * * These fields can only be accessed via access functions. * @@ -97,15 +113,21 @@ typedef struct ir_graph ir_graph; * SOURCE */ +/* to resolve recursion between entity.h and type.h */ #ifndef _ENTITY_TYPEDEF_ #define _ENTITY_TYPEDEF_ -/* to resolve recursion between entity.h and type.h */ typedef struct entity entity; #endif + /* Creates a new entity. - Automatically inserts the entity as a member of owner. */ -entity *new_entity (type *owner, ident *name, type *type); + Automatically inserts the entity as a member of owner. + Entity is automatic_allocated and uninitialize 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_d_entity (type *owner, ident *name, type *tp, dbg_info *db); /* Copies the entity if the new_owner is different from the owner of the old entity. Else returns the old entity. Automatically inserts the new entity as a member of owner. */ @@ -115,35 +137,41 @@ 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. */ entity *copy_entity_name (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); /** manipulate fields of entity **/ const char *get_entity_name (entity *ent); ident *get_entity_ident (entity *ent); + /* returns the mangled name of the entity. If the mangled name is set it returns the existing name. Else it generates a name with mangle_entity() and remembers this new name internally. */ ident *get_entity_ld_ident (entity *ent); void set_entity_ld_ident (entity *ent, ident *ld_ident); +const char *get_entity_ld_name (entity *end); -/* -char *get_entity_ld_name (entity *ent); -void set_entity_ld_name (entity *ent, char *ld_name); -*/ - -type *get_entity_owner (entity *ent); -/* Sets the owner field in entity to owner. */ -void set_entity_owner (entity *ent, type *owner); -inline void assert_legal_owner_of_ent(type *owner); +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); +INLINE void assert_legal_owner_of_ent(type *owner); type *get_entity_type (entity *ent); -void set_entity_type (entity *ent, type *type); +void set_entity_type (entity *ent, type *tp); typedef enum { - dynamic_allocated, /* The entity is allocated during runtime, either explicitly - by an Alloc node or implicitly as component of a compound - type. This is the default. */ - static_allocated /* The entity is allocated statically. We can use a - SymConst as address of the entity. */ + automatic_allocated, /* The entity is allocated during runtime, implicitly + as component of a compound type. This is the default. */ + parameter_allocated, /* The entity is a parameter. It is also automatic allocated. + We distinguish the allocation of paramters from the allocation + of local variables as their placement depends on the calling + conventions. */ + dynamic_allocated, /* The entity is allocated during runtime, explicitly + by an Alloc node. */ + static_allocated /* The entity is allocated statically. We can use a + SymConst(?) as address of the entity. */ } ent_allocation; ent_allocation get_entity_allocation (entity *ent); @@ -156,35 +184,124 @@ typedef enum { 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. */ - external_allocated /* The entity is defined and allocated externaly. This compilation + external_allocated /* The entity is defined and allocated externally. This compilation must not allocate memory for this entity. The entity must - be static_allocated. */ + be static_allocated. This can also be an external defined + method. */ } ent_visibility; ent_visibility get_entity_visibility (entity *ent); void set_entity_visibility (entity *ent, ent_visibility vis); +/* This enumeration flags the variability of entities. */ +typedef enum { + uninitialized, /* The content of the entity is completely unknown. */ + initialized, /* After allocation the entity is initalized with the + value given somewhere in the entity. */ + part_constant, /* For entities of compound types. Some members of the entity + are constant. The others are uninitialized. Those members + given a value for are constant. */ + constant /* The entity is constant. */ +} ent_variability; + +ent_variability get_entity_variability (entity *ent); +void set_entity_variability (entity *ent, ent_variability var); + +/* This enumeration flags the volatility of entities. */ +typedef enum { + non_volatile, /* The entity is not volatile */ + is_volatile /* The entity is volatile */ +} ent_volatility; + +ent_volatility get_entity_volatility (entity *ent); +void set_entity_volatility (entity *ent, ent_volatility vol); + +/* Only set if layout = fixed. */ int get_entity_offset (entity *ent); void set_entity_offset (entity *ent, int offset); +/* A link to store intermediate information */ +void* get_entity_link(entity *ent); +void set_entity_link(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(entity *ent); +void set_entity_irg(entity *ent, ir_graph *irg); + +/* For the definition of enumeration peculiarity see type.h */ +peculiarity get_entity_peculiarity (entity *ent); +void set_entity_peculiarity (entity *ent, peculiarity pec); + +/** Representation of constant values of entites **/ +/* 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. */ +ir_node *copy_const_value(ir_node *n); + +/* Set has no effect for entities of type method. */ +ir_node *get_atomic_ent_value(entity *ent); +void set_atomic_ent_value(entity *ent, ir_node *val); + +/* A value of a compound entity is a pair of a value and the corresponding + member of the compound. */ +void add_compound_ent_value(entity *ent, ir_node *val, entity *member); +int get_compound_ent_n_values(entity *ent); +ir_node *get_compound_ent_value(entity *ent, int pos); +entity *get_compound_ent_value_member(entity *ent, int pos); +void set_compound_ent_value(entity *ent, ir_node *val, entity *member, int pos); +void remove_compound_ent_value(entity *ent, entity *value_ent); +/* Inits the entity ent witch 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 + 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); + +/** 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 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 - that is passed to it. Lowering of the Sel node must assure this. */ + 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); entity *get_entity_overwrites (entity *ent, int pos); void set_entity_overwrites (entity *ent, int pos, entity *overwritten); -/* Do we need a second relation "overwritten"? */ -/* The entity knows the corresponding irg if the entity is a method. - This allows to get from a Call to the called irg. */ -ir_graph *get_entity_irg(entity *ent); -void set_entity_irg(entity *ent, ir_graph *irg); +void add_entity_overwrittenby (entity *ent, entity *overwrites); +int get_entity_n_overwrittenby (entity *ent); +entity *get_entity_overwrittenby (entity *ent, int pos); +void set_entity_overwrittenby (entity *ent, int pos, entity *overwrites); + +/* Returns true if the type of the entity is a primitive, pointer + enumeration or method type. */ +int is_atomic_entity(entity *ent); +/* 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 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); + +unsigned long get_entity_visited(entity *ent); +void set_entity_visited(entity *ent, unsigned long num); +/* Sets visited field in entity to entity_visited. */ +void mark_entity_visited(entity *ent); /*****/