X-Git-Url: http://nsz.repo.hu/git/?a=blobdiff_plain;f=ir%2Ftr%2Fentity_t.h;h=19b9d6fe2f39efdb444b9c3691c50acdd35e5114;hb=695676572c14ef6620122147115c0e09d068cd95;hp=17c43ef2e91cbac5426aa9fe24d41980f0dd68d5;hpb=58278afc9917d9fc28ae5a4def6e1d9e53d7179f;p=libfirm diff --git a/ir/tr/entity_t.h b/ir/tr/entity_t.h index 17c43ef2e..19b9d6fe2 100644 --- a/ir/tr/entity_t.h +++ b/ir/tr/entity_t.h @@ -1,76 +1,428 @@ -/*10 2002/03/19 13:08:33 -** Copyright (C) 1998 - 2000 by Universitaet Karlsruhe -** All rights reserved. -** -** Authors: Martin Trapp, Christian Schaefer, -** Goetz Lindenmaier -** -** entity.h: entities represent all program known objects. -** -** 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. -** -*/ - -/* $Id$ */ +/* + * Project: libFIRM + * File name: ir/tr/entity_t.h + * Purpose: Representation of all program known entities -- private header. + * Author: Martin Trapp, Christian Schaefer + * Modified by: Goetz Lindenmaier + * Created: + * CVS-ID: $Id$ + * Copyright: (c) 1998-2003 Universität Karlsruhe + * Licence: This file protected by GPL - GNU GENERAL PUBLIC LICENSE. + */ + +/** + * @file entity_t.h + * + * entity.h: entities represent all program known objects. + * + * @author Martin Trapp, Christian Schaefer, 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. + */ # ifndef _ENTITY_T_H_ # define _ENTITY_T_H_ -# include "entity.h" +#include "firm_common_t.h" +#include "firm_config.h" + +#include "type_t.h" +#include "entity.h" +#include "typegmod.h" +#include "mangle.h" +#include "pseudo_irg.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 +/** A path in a compund graph. */ +struct compound_graph_path { + firm_kind kind; /**< dynamic type tag for compound graph path. */ + type *tp; /**< The type this path belongs to. */ + int len; /**< length of the path */ + struct tuple { + int index; /**< Array index. To compute position of array elements */ + entity *node; /**< entity */ + } list[1]; /**< List of entitiy/index tuple of length len to express the + access path. */ +}; +/** the type of an entity */ struct entity { - firm_kind kind; - ident *name; /* name of this entity */ - ident *ld_name; /* Unique name of this entity, i.e., the mangled - name. E.g., for a class `A' with field `a' this + firm_kind kind; /**< dynamic type tag for entity. */ + ident *name; /**< name of this entity */ + ident *ld_name; /**< Unique name of this entity, i.e., the mangled + name. If the field is read before written a default + mangling is applies. The name of the owner is prepended + to the name of the entity, separated by a underscore. + 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 + 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. */ - entity **overwrites; /* A list of entities this entity overwrites. */ - entity **overwrittenby; /* A list of entities that overwrite this entity. */ - ent_allocation allocation; /* Distinguishes static and dynamically allocated - entities. */ - ent_visibility visibility; /* Specifies visibility to external program - fragments */ - ent_variability variability; /* Specifies variability of entities content */ - ent_volatility volatility; /* Specifies volatility of entities content */ - ir_node *value; /* value of atomic entity */ - ir_node **values; /* values of compound entities */ - entity **val_ents; /* entities corresponding to constant values */ - int offset; /* Offset in byte for this entity. Fixed when layout - of owner is determined. */ - void *link; /* To store some intermediate information */ - unsigned long visit; /* visited counter for walks of the type information */ - /* for methods */ + type *owner; /**< The compound type (e.g. class type) this entity belongs to. */ + ent_allocation allocation; /**< Distinguishes static and dynamically allocated + entities and some further cases. */ + visibility visibility; /**< Specifies visibility to external program + fragments */ + ent_variability variability; /**< Specifies variability of entities content */ + ent_volatility volatility; /**< Specifies volatility of entities content */ + ent_stickyness stickyness; /**< Specifies whether this entity is sticky */ + int offset; /**< Offset in bits for this entity. Fixed when layout + of owner is determined. */ + void *link; /**< To store some intermediate information */ + unsigned long visit; /**< visited counter for walks of the type information */ + struct dbg_info *dbi; /**< A pointer to information for debug support. */ + + /* ------------- fields for atomic entities ---------------*/ + + ir_node *value; /**< value if entity is not of variability uninitialized. + Only for atomic entities. */ + + /* ------------- fields for compound entities ---------------*/ + + ir_node **values; /**< constant values of compound entities. Only available if + variability not uninitialized. Must be set for variability constant + */ + compound_graph_path **val_paths; /**< paths corresponding to constant values. Only available if + variability not uninitialized. Must be set for variability constant */ + + /* ------------- fields for entities owned by a class type ---------------*/ + + entity **overwrites; /**< A list of entities this entity overwrites. */ + entity **overwrittenby; /**< A list of entities that overwrite this entity. */ + + /* ------------- fields for methods ---------------*/ + enum peculiarity peculiarity; - ir_graph *irg; /* If (type == method_type) this is the corresponding irg. - The ir_graph constructor automatically sets this field. - Yes, it must be here. */ - struct dbg_info* dbi; /* A pointer to information for debug support. */ + ir_graph *irg; /**< If (type == method_type) this is the corresponding irg. + The ir_graph constructor automatically sets this field. + Yes, it must be here. */ + unsigned irg_add_properties; /**< If (type == method_type) this is a set of additional. + graph flags if the irg of an entity is not known. */ + unsigned irg_calling_conv; /**< If (type == method_type) this is a set of calling. + convention flags if the irg of an entity is not known. */ + + /* ------------- fields for analyses ---------------*/ + + +#ifdef DEBUG_libfirm + int nr; /**< a unique node number for each node to make output + readable. */ +# endif /* DEBUG_libfirm */ }; +/** Initialize entity module. */ +void firm_init_entity(void); + + +/* ----------------------- inline functions ------------------------ */ +static INLINE int +_is_entity(const void *thing) { + return get_kind(thing) == k_entity; +} + +static INLINE const char * +_get_entity_name(const entity *ent) { + assert(ent && ent->kind == k_entity); + return get_id_str(get_entity_ident(ent)); +} + +static INLINE ident * +_get_entity_ident(const entity *ent) { + assert(ent && ent->kind == k_entity); + return ent->name; +} + +static INLINE type * +_get_entity_owner(entity *ent) { + assert(ent && ent->kind == k_entity); + return ent->owner = skip_tid(ent->owner); +} + +static INLINE ident * +_get_entity_ld_ident(entity *ent) +{ + assert(ent && ent->kind == k_entity); + if (ent->ld_name == NULL) + ent->ld_name = mangle_entity(ent); + return ent->ld_name; +} + +static INLINE void +_set_entity_ld_ident(entity *ent, ident *ld_ident) { + assert(ent && ent->kind == k_entity); + ent->ld_name = ld_ident; +} + +static INLINE const char * +_get_entity_ld_name(entity *ent) { + assert(ent && ent->kind == k_entity); + return get_id_str(get_entity_ld_ident(ent)); +} + +static INLINE type * +_get_entity_type(entity *ent) { + assert(ent && ent->kind == k_entity); + return ent->type = skip_tid(ent->type); +} + +static INLINE void +_set_entity_type(entity *ent, type *type) { + assert(ent && ent->kind == k_entity); + ent->type = type; +} + +static INLINE ent_allocation +_get_entity_allocation(const entity *ent) { + assert(ent && ent->kind == k_entity); + return ent->allocation; +} + +static INLINE void +_set_entity_allocation(entity *ent, ent_allocation al) { + assert(ent && ent->kind == k_entity); + ent->allocation = al; +} + +static INLINE visibility +_get_entity_visibility(const entity *ent) { + assert(ent && ent->kind == k_entity); + return ent->visibility; +} + +static INLINE ent_variability +_get_entity_variability(const entity *ent) { + assert(ent && ent->kind == k_entity); + return ent->variability; +} + +static INLINE ent_volatility +_get_entity_volatility(const entity *ent) { + assert(ent && ent->kind == k_entity); + return ent->volatility; +} + +static INLINE void +_set_entity_volatility(entity *ent, ent_volatility vol) { + assert(ent && ent->kind == k_entity); + ent->volatility = vol; +} + +static INLINE peculiarity +_get_entity_peculiarity(const entity *ent) { + assert(ent && ent->kind == k_entity); + return ent->peculiarity; +} + +/** + * @todo Why peculiarity only for methods? + * Good question. Originally, there were only description and + * existent. The thought was, what sense does it make to + * describe a field? With inherited the situation changed. So + * I removed the assertion. GL, 28.2.05 + */ +static INLINE void +_set_entity_peculiarity(entity *ent, peculiarity pec) { + assert(ent && ent->kind == k_entity); + /* @@@ why peculiarity only for methods? */ + //assert(is_Method_type(ent->type)); + + ent->peculiarity = pec; +} + +static INLINE ent_stickyness +_get_entity_stickyness(const entity *ent) { + assert(ent && ent->kind == k_entity); + return ent->stickyness; +} + +static INLINE void +_set_entity_stickyness(entity *ent, ent_stickyness stickyness) +{ + assert(ent && ent->kind == k_entity); + ent->stickyness = stickyness; +} + +static INLINE int +_get_entity_offset_bits(const entity *ent) { + assert(ent && ent->kind == k_entity); + return ent->offset; +} + +static INLINE int +_get_entity_offset_bytes(const entity *ent) { + int bits = _get_entity_offset_bits(ent); + + if (bits & 7) return -1; + return bits >> 3; +} + +static INLINE void +_set_entity_offset_bits(entity *ent, int offset) { + assert(ent && ent->kind == k_entity); + ent->offset = offset; +} + +static INLINE void +_set_entity_offset_bytes(entity *ent, int offset) { + _set_entity_offset_bits(ent, offset * 8); +} + +static INLINE void * +_get_entity_link(const entity *ent) { + assert(ent && ent->kind == k_entity); + return ent->link; +} + +static INLINE void +_set_entity_link(entity *ent, void *l) { + assert(ent && ent->kind == k_entity); + ent->link = l; +} + +static INLINE ir_graph * +_get_entity_irg(const entity *ent) { + assert(ent && ent->kind == k_entity); + assert(ent == unknown_entity || is_Method_type(ent->type)); + if (!get_visit_pseudo_irgs() && ent->irg && is_pseudo_ir_graph(ent->irg)) + return NULL; + return ent->irg; +} + +static INLINE unsigned long +_get_entity_visited(entity *ent) { + assert(ent && ent->kind == k_entity); + return ent->visit; +} + +static INLINE void +_set_entity_visited(entity *ent, unsigned long num) { + assert(ent && ent->kind == k_entity); + ent->visit = num; +} + +static INLINE void +_mark_entity_visited(entity *ent) { + assert(ent && ent->kind == k_entity); + ent->visit = firm_type_visited; +} + +static INLINE int +_entity_visited(entity *ent) { + return _get_entity_visited(ent) >= firm_type_visited; +} + +static INLINE int +_entity_not_visited(entity *ent) { + return _get_entity_visited(ent) < firm_type_visited; +} + +static INLINE unsigned +_get_entity_additional_properties(const entity *ent) { + ir_graph *irg; + assert(ent && ent->kind == k_entity); + assert(ent == unknown_entity || is_Method_type(ent->type)); + irg = _get_entity_irg(ent); + return irg ? + get_irg_additional_properties(irg) : + ent->irg_add_properties; +} + +static INLINE void +_set_entity_additional_properties(entity *ent, unsigned mask) { + ir_graph *irg; + assert(ent && ent->kind == k_entity); + assert(ent == unknown_entity || is_Method_type(ent->type)); + irg = _get_entity_irg(ent); + if (irg) + set_irg_additional_properties(irg, mask); + else + ent->irg_add_properties = mask; +} + +static INLINE void +_set_entity_additional_property(entity *ent, irg_additional_property flag) { + ir_graph *irg; + assert(ent && ent->kind == k_entity); + assert(ent == unknown_entity || is_Method_type(ent->type)); + irg = _get_entity_irg(ent); + if (irg) + set_irg_additional_property(irg, flag); + else + ent->irg_add_properties |= flag; +} + +static INLINE unsigned +_get_entity_calling_convention(const entity *ent) { + ir_graph *irg; + assert(ent && ent->kind == k_entity); + assert(ent == unknown_entity || is_Method_type(ent->type)); + irg = _get_entity_irg(ent); + if (irg) + return get_irg_calling_convention(irg); + else + return ent->irg_calling_conv; +} + +static INLINE void +_set_entity_calling_convention(entity *ent, unsigned cc_mask) { + ir_graph *irg; + assert(ent && ent->kind == k_entity); + assert(ent == unknown_entity || is_Method_type(ent->type)); + irg = _get_entity_irg(ent); + if (irg) + set_irg_calling_convention(irg, cc_mask); + else + ent->irg_calling_conv = cc_mask; +} + +#define is_entity(thing) _is_entity(thing) +#define get_entity_name(ent) _get_entity_name(ent) +#define get_entity_ident(ent) _get_entity_ident(ent) +#define get_entity_owner(ent) _get_entity_owner(ent) +#define get_entity_ld_ident(ent) _get_entity_ld_ident(ent) +#define set_entity_ld_ident(ent, ld_ident) _set_entity_ld_ident(ent, ld_ident) +#define get_entity_ld_name(ent) _get_entity_ld_name(ent) +#define get_entity_type(ent) _get_entity_type(ent) +#define set_entity_type(ent, type) _set_entity_type(ent, type) +#define get_entity_allocation(ent) _get_entity_allocation(ent) +#define set_entity_allocation(ent, al) _set_entity_allocation(ent, al) +#define get_entity_visibility(ent) _get_entity_visibility(ent) +#define get_entity_variability(ent) _get_entity_variability(ent) +#define get_entity_volatility(ent) _get_entity_volatility(ent) +#define set_entity_volatility(ent, vol) _set_entity_volatility(ent, vol) +#define get_entity_peculiarity(ent) _get_entity_peculiarity(ent) +#define set_entity_peculiarity(ent, pec) _set_entity_peculiarity(ent, pec) +#define get_entity_stickyness(ent) _get_entity_stickyness(ent) +#define set_entity_stickyness(ent, stickyness) _set_entity_stickyness(ent, stickyness) +#define get_entity_offset_bits(ent) _get_entity_offset_bits(ent) +#define get_entity_offset_bytes(ent) _get_entity_offset_bytes(ent) +#define set_entity_offset_bits(ent, offset) _set_entity_offset_bits(ent, offset) +#define set_entity_offset_bytes(ent, offset) _set_entity_offset_bytes(ent, offset) +#define get_entity_link(ent) _get_entity_link(ent) +#define set_entity_link(ent, l) _set_entity_link(ent, l) +#define get_entity_irg(ent) _get_entity_irg(ent) +#define get_entity_visited(ent) _get_entity_visited(ent) +#define set_entity_visited(ent, num) _set_entity_visited(ent, num) +#define mark_entity_visited(ent) _mark_entity_visited(ent) +#define entity_visited(ent) _entity_visited(ent) +#define entity_not_visited(ent) _entity_not_visited(ent) +#define get_entity_additional_properties(ent) _get_entity_additional_properties(ent) +#define set_entity_additional_properties(ent, m) _set_entity_additional_properties(ent, m) +#define set_entity_additional_property(ent, f) _set_entity_additional_property(ent, f) +#define get_entity_calling_convention(ent) _get_entity_calling_convention(ent) +#define set_entity_calling_convention(ent, cc) _set_entity_calling_convention(ent, cc) # endif /* _ENTITY_T_H_ */