X-Git-Url: http://nsz.repo.hu/git/?a=blobdiff_plain;f=ir%2Ftr%2Fentity_t.h;h=41309a7d1ef69062d8417ff20ef127b1c9f03d5a;hb=3bcbfec36f89ae53617d216824c72a01c9034abb;hp=6ff0da8502e2bb13f4f91462483d8495c303ce72;hpb=f3157bda5e3b46233ea4ec9abd8499a8e7bb83ff;p=libfirm diff --git a/ir/tr/entity_t.h b/ir/tr/entity_t.h index 6ff0da850..41309a7d1 100644 --- a/ir/tr/entity_t.h +++ b/ir/tr/entity_t.h @@ -1,38 +1,62 @@ -/*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 "firm_common_t.h" + # include "entity.h" +# include "typegmod.h" +# include "mangle.h" + +/** 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 */ + int *arr_indicees; /**< List of array indicees. To compute position of + array elements */ + entity *nodes[1]; /**< List of entities of length len to express the + access path. */ +}; + +/** the type of an entity */ struct entity { firm_kind kind; /**< dynamic type tag for entity. */ ident *name; /**< name of this entity */ @@ -46,38 +70,248 @@ struct entity { basic type of the language or a class itself */ 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. */ + entities and some further cases. */ ent_visibility visibility; /**< Specifies visibility to external program - fragments */ + fragments */ ent_variability variability; /**< Specifies variability of entities content */ ent_volatility volatility; /**< Specifies volatility of entities content */ - int offset; /**< Offset in byte for this entity. Fixed when layout - of owner is determined. */ + 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 - variablility not uninitialized. Must be set for variability constant + variablility not uninitialized. Must be set for variability constant */ - entity **val_ents; /**< entities corresponding to constant values. Only available if - variablility not uninitialized. Must be set for variability constant */ + compound_graph_path **val_paths; /**< paths corresponding to constant values. Only available if + variablility 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 **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. */ + The ir_graph constructor automatically sets this field. + Yes, it must be here. */ + + /* ------------- fields for analyses ---------------*/ + + +#ifdef DEBUG_libfirm + int nr; /**< a unique node number for each node to make output + readable. */ + char *c_name; /**< Since idents are ipaque, provide the name in cleartext */ +# endif /* DEBUG_libfirm */ }; + +/* ----------------------- 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 ent_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 + */ +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)); + return ent->irg; +} + +#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) + # endif /* _ENTITY_T_H_ */