X-Git-Url: http://nsz.repo.hu/git/?a=blobdiff_plain;f=ir%2Ftr%2Fentity.h;h=7a9c4d5f1b3aead532dccce23cf8f5c0a61f43fd;hb=e0ae3612c08edee7add1c54202f442691c42c530;hp=48e911443c0d53edf44471be3f580430b54bd4b6;hpb=73aba04481fc9b5982b5f61c44994ebd9b1d73cb;p=libfirm diff --git a/ir/tr/entity.h b/ir/tr/entity.h index 48e911443..7a9c4d5f1 100644 --- a/ir/tr/entity.h +++ b/ir/tr/entity.h @@ -43,6 +43,8 @@ ** an assertion. */ +/* $Id$ */ + # ifndef _ENTITY_H_ # define _ENTITY_H_ @@ -72,10 +74,34 @@ typedef struct ir_graph ir_graph; * entity - An abstract data type to represent program entites. * NOTE * - * ... not documented ... - * * ATTRIBUTES - * + * owner A compound type this entity is a part of. + * 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, + * 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) + * offset The offset of the entity within the compound object. Only set + * 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. * * These fields can only be accessed via access functions. * @@ -91,7 +117,11 @@ typedef struct entity entity; #endif /* Creates a new entity. - Automatically inserts the entity as a member of owner. */ + 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 *type); /* Copies the entity if the new_owner is different from the owner of the old entity. Else returns the old entity. @@ -111,26 +141,28 @@ ident *get_entity_ident (entity *ent); 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); +char *get_entity_ld_name (entity *ent); +void set_entity_ld_name (entity *ent, char *ld_name); */ -type *get_entity_owner (entity *ent); +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); +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); 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. */ + automatic_allocated,/* The entity is allocated during runtime, implicitly + as component of a compound type. This is the default. */ + 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. */ + SymConst(?) as address of the entity. */ } ent_allocation; ent_allocation get_entity_allocation (entity *ent); @@ -151,6 +183,64 @@ typedef enum { 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); + +/* For the definition of enumeration peculiarity see type.h */ +peculiarity get_entity_peculiarity (entity *ent); +void set_entity_peculiarity (entity *ent, peculiarity pec); + +/* 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); +/* Copies the value represented by the entity to current_block + in current_ir_graph. @@@ oblivious, use copy_const_vallue */ +ir_node *copy_atomic_ent_value(entity *ent); + +/* A value of a compound entity is a pair of value and the corresponding + member of the compound. */ +void add_compound_ent_value(entity *ent, ir_node *val, entity *member); +/* oblivious, use copy_const_value @@@ */ +void copy_and_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); +/* 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); +/* Copies the value pos of the entity to current_block in current_ir_graph. */ +ir_node *copy_compound_ent_value(entity *ent, int pos); + +/* Only set if layout = fixed. */ int get_entity_offset (entity *ent); void set_entity_offset (entity *ent, int offset); @@ -160,19 +250,37 @@ void set_entity_offset (entity *ent, int offset); 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"? */ +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); + +/* A link to store intermediate information */ +void* get_entity_link(entity *ent); +void set_entity_link(entity *ent, void *l); /* The entity knows the corresponding irg if the entity is a method. - This allows to get from a Call to the called irg. */ + 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); +/* 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); + /*****/