X-Git-Url: http://nsz.repo.hu/git/?a=blobdiff_plain;f=ir%2Ftr%2Fentity_t.h;h=cdd8aff43cbef8a544699928722ed5dfb0cdbb5a;hb=9543fd5575184a1167bddfd32c34fb700aa484a4;hp=c407ff635b900ced3cf36e3d2d9fcbccf4db2caf;hpb=5fa487d888ad0867971427eaffdc4cebd3d54e05;p=libfirm diff --git a/ir/tr/entity_t.h b/ir/tr/entity_t.h index c407ff635..cdd8aff43 100644 --- a/ir/tr/entity_t.h +++ b/ir/tr/entity_t.h @@ -1,324 +1,430 @@ /* - * 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 + * Copyright (C) 1995-2011 University of Karlsruhe. All right reserved. * - * entity.h: entities represent all program known objects. + * This file is part of libFirm. * - * @author Martin Trapp, Christian Schaefer, Goetz Lindenmaier + * This file may be distributed and/or modified under the terms of the + * GNU General Public License version 2 as published by the Free Software + * Foundation and appearing in the file LICENSE.GPL included in the + * packaging of this file. * - * 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. + * Licensees holding valid libFirm Professional Edition licenses may use + * this file in accordance with the libFirm Commercial License. + * Agreement provided with the Software. * - * 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. + * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE + * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR + * PURPOSE. + */ + +/* + * @file + * @brief Representation of all program known entities -- private header. + * @author Martin Trapp, Christian Schaefer, Goetz Lindenmaier, Michael Beck + * @version $Id$ */ +#ifndef FIRM_TR_ENTITY_T_H +#define FIRM_TR_ENTITY_T_H -# ifndef _ENTITY_T_H_ -# define _ENTITY_T_H_ +#include -#include "firm_common_t.h" -#include "firm_config.h" +#include "typerep.h" +#include "type_t.h" +#include "ident.h" +#include "compound_path.h" -# include "entity.h" -# include "typegmod.h" -# include "mangle.h" -# include "pseudo_irg.h" +typedef struct ir_initializer_base_t { + ir_initializer_kind_t kind; +} ir_initializer_base_t; +/** + * An compound initializer. + */ +typedef struct ir_initializer_compound_t { + ir_initializer_base_t base; + size_t n_initializers; + ir_initializer_t *initializers[1]; +} ir_initializer_compound_t; -/** 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 indeces. To compute position of - array elements */ - entity *nodes[1]; /**< List of entities of length len to express the - access path. */ +/** + * An initializer containing an ir_node, + */ +typedef struct ir_initializer_const_t { + ir_initializer_base_t base; + ir_node *value; +} ir_initializer_const_t ; + +/** + * An initializer containing a tarval. + */ +typedef struct ir_initializer_tarval_t { + ir_initializer_base_t base; + ir_tarval *value; +} ir_initializer_tarval_t ; + +union ir_initializer_t { + ir_initializer_kind_t kind; + ir_initializer_base_t base; + ir_initializer_compound_t compound; + ir_initializer_const_t consti; + ir_initializer_tarval_t tarval; }; -/** the type of an entity */ -struct entity { - 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 - 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. */ - 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 */ - 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 - */ - 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 **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. */ - - /* ------------- fields for analyses ---------------*/ +/** The attributes for compound entities. */ +typedef struct compound_ent_attr { + ir_node **values; /**< constant values of compound entities. */ + compound_graph_path **val_paths; + /**< paths corresponding to constant values. */ +} compound_ent_attr; + +/** The attributes for methods. */ +typedef struct method_ent_attr { + ir_graph *irg; /**< The corresponding irg if known. + The ir_graph constructor automatically sets this field. */ + mtp_additional_properties irg_add_properties; /**< Additional graph properties can be + stored in a entity if no irg is available. */ + + unsigned vtable_number; /**< For a dynamically called method, the number assigned + in the virtual function table. */ + ptr_access_kind *param_access; /**< the parameter access */ + unsigned *param_weight; /**< The weight of method's parameters. Parameters + with a high weight are good candidates for procedure cloning. */ +} method_ent_attr; + +/** additional attributes for code entities */ +typedef struct code_ent_attr { + ir_label_t label; /** label of the basic block */ +} code_ent_attr; + + +/** + * An abstract data type to represent program entities. + * + * @see ir_type + */ +struct ir_entity { + firm_kind kind; /**< The dynamic type tag for entity. */ + ident *name; /**< The 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'. */ + 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 compound type (e.g. class type) this entity belongs to. */ + unsigned linkage:10; /**< Specifies linkage type */ + unsigned volatility:1; /**< Specifies volatility of entities content.*/ + unsigned aligned:1; /**< Specifies alignment of entities content. */ + unsigned usage:4; /**< flag indicating usage types of this entity, + see ir_entity_usage. */ + unsigned compiler_gen:1; /**< If set, this entity was compiler generated. + */ + unsigned visibility:3; /**< @deprecated */ + unsigned allocation:3; /**< @deprecated */ + unsigned peculiarity:3; /**< @deprecated */ + unsigned final:1; /**< @deprecated */ + int offset; /**< Offset in bytes for this entity. Fixed + when layout of owner is determined. */ + unsigned alignment; /**< entity alignment in bytes */ + unsigned char offset_bit_remainder; + /**< If the entity is a bit field, this is the + offset of the start of the bit field + within the byte specified by offset. */ + ir_visited_t visit; /**< visited counter for walks of the type + information. */ + struct dbg_info *dbi; /**< A pointer to information for debug support. + */ + void *link; /**< To store some intermediate information. */ + ir_type *repr_class; /**< If this entity represents a class info, the + associated class. */ + + /* ------------- fields for entities owned by a class type ---------------*/ + + ir_entity **overwrites; /**< A list of entities this entity overwrites. + */ + ir_entity **overwrittenby; /**< A list of entities that overwrite this + entity. */ + + /* ------------- fields for atomic entities --------------- */ + ir_initializer_t *initializer; /**< entity initializer */ + union { + /* ------------- fields for compound entities -------------- */ + compound_ent_attr cmpd_attr; + /* ------------- fields for method entities ---------------- */ + method_ent_attr mtd_attr; + /* fields for code entities */ + code_ent_attr code_attr; + } attr; /**< type specific attributes */ + + /* ------------- fields for analyses ---------------*/ #ifdef DEBUG_libfirm - int nr; /**< a unique node number for each node to make output - readable. */ -# endif /* DEBUG_libfirm */ + long nr; /**< A unique node number for each node to make output + readable. */ +#endif }; - +/** Initialize the entity module. */ +void ir_init_entity(void); +/** Cleanup entity module */ +void ir_finish_entity(void); /* ----------------------- inline functions ------------------------ */ -static INLINE int -_is_entity(const void *thing) { - return get_kind(thing) == k_entity; +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 const char *_get_entity_name(const ir_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 ident *_get_entity_ident(const ir_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 void _set_entity_ident(ir_entity *ent, ident *id) +{ + assert(ent && ent->kind == k_entity); + ent->name = id; } -static INLINE ident * -_get_entity_ld_ident(entity *ent) +static inline ir_type *_get_entity_owner(const ir_entity *ent) { - assert(ent && ent->kind == k_entity); - if (ent->ld_name == NULL) - ent->ld_name = mangle_entity(ent); - return ent->ld_name; + assert(ent && ent->kind == k_entity); + return ent->owner; } -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 ident *_get_entity_ld_ident(const ir_entity *ent) +{ + assert(ent && ent->kind == k_entity); + if (ent->ld_name == NULL) + return ent->name; + return ent->ld_name; } -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 void _set_entity_ld_ident(ir_entity *ent, ident *ld_ident) +{ + assert(ent && ent->kind == k_entity); + ent->ld_name = ld_ident; } -static INLINE type * -_get_entity_type(entity *ent) { - assert(ent && ent->kind == k_entity); - return ent->type = skip_tid(ent->type); +static inline const char *_get_entity_ld_name(const ir_entity *ent) +{ + assert(ent && ent->kind == k_entity); + return get_id_str(get_entity_ld_ident(ent)); } -static INLINE void -_set_entity_type(entity *ent, type *type) { - assert(ent && ent->kind == k_entity); - ent->type = type; +static inline ir_type *_get_entity_type(const ir_entity *ent) +{ + assert(ent && ent->kind == k_entity); + return ent->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_type(ir_entity *ent, ir_type *type) +{ + assert(ent && ent->kind == k_entity); + ent->type = type; } -static INLINE void -_set_entity_allocation(entity *ent, ent_allocation al) { - assert(ent && ent->kind == k_entity); - ent->allocation = al; +static inline ir_linkage _get_entity_linkage(const ir_entity *ent) +{ + assert(ent && ent->kind == k_entity); + return (ir_linkage) ent->linkage; } -static INLINE ent_visibility -_get_entity_visibility(const entity *ent) { - assert(ent && ent->kind == k_entity); - return ent->visibility; +static inline ir_volatility _get_entity_volatility(const ir_entity *ent) +{ + assert(ent && ent->kind == k_entity); + return (ir_volatility) ent->volatility; } -static INLINE ent_variability -_get_entity_variability(const entity *ent) { - assert(ent && ent->kind == k_entity); - return ent->variability; +static inline void _set_entity_volatility(ir_entity *ent, ir_volatility vol) +{ + assert(ent && ent->kind == k_entity); + ent->volatility = vol; } -static INLINE ent_volatility -_get_entity_volatility(const entity *ent) { - assert(ent && ent->kind == k_entity); - return ent->volatility; +static inline unsigned _get_entity_alignment(const ir_entity *ent) +{ + assert(ent && ent->kind == k_entity); + return ent->alignment; } -static INLINE void -_set_entity_volatility(entity *ent, ent_volatility vol) { - assert(ent && ent->kind == k_entity); - ent->volatility = vol; +static inline void _set_entity_alignment(ir_entity *ent, unsigned alignment) +{ + assert(ent && ent->kind == k_entity); + ent->alignment = alignment; } -static INLINE peculiarity -_get_entity_peculiarity(const entity *ent) { - assert(ent && ent->kind == k_entity); - return ent->peculiarity; +static inline ir_align _get_entity_aligned(const ir_entity *ent) +{ + assert(ent && ent->kind == k_entity); + return (ir_align) ent->aligned; } -/** - * @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)); +static inline void _set_entity_aligned(ir_entity *ent, ir_align a) +{ + assert(ent && ent->kind == k_entity); + ent->aligned = a; +} + +static inline int _is_entity_compiler_generated(const ir_entity *ent) +{ + assert(ent && ent->kind == k_entity); + return ent->compiler_gen; +} + +static inline void _set_entity_compiler_generated(ir_entity *ent, int flag) +{ + assert(ent && ent->kind == k_entity); + ent->compiler_gen = flag ? 1 : 0; +} + +static inline ir_entity_usage _get_entity_usage(const ir_entity *ent) +{ + assert(ent && ent->kind == k_entity); + return (ir_entity_usage) ent->usage; +} + +static inline void _set_entity_usage(ir_entity *ent, ir_entity_usage state) +{ + assert(ent && ent->kind == k_entity); + ent->usage = state; +} + +static inline int _get_entity_offset(const ir_entity *ent) +{ + assert(ent && ent->kind == k_entity); + return ent->offset; +} + +static inline void _set_entity_offset(ir_entity *ent, int offset) +{ + assert(ent && ent->kind == k_entity); + ent->offset = offset; +} - ent->peculiarity = pec; +static inline unsigned char _get_entity_offset_bits_remainder(const ir_entity *ent) +{ + assert(ent && ent->kind == k_entity); + return ent->offset_bit_remainder; } -static INLINE ent_stickyness -_get_entity_stickyness(const entity *ent) { - assert(ent && ent->kind == k_entity); - return ent->stickyness; +static inline void _set_entity_offset_bits_remainder(ir_entity *ent, unsigned char offset) +{ + assert(ent && ent->kind == k_entity); + ent->offset_bit_remainder = offset; } -static INLINE void -_set_entity_stickyness(entity *ent, ent_stickyness stickyness) +static inline void *_get_entity_link(const ir_entity *ent) { - assert(ent && ent->kind == k_entity); - ent->stickyness = stickyness; + assert(ent && ent->kind == k_entity); + return ent->link; } -static INLINE int -_get_entity_offset_bits(const entity *ent) { - assert(ent && ent->kind == k_entity); - return ent->offset; +static inline void _set_entity_link(ir_entity *ent, void *l) +{ + assert(ent && ent->kind == k_entity); + ent->link = l; } -static INLINE int -_get_entity_offset_bytes(const entity *ent) { - int bits = _get_entity_offset_bits(ent); +static inline ir_graph *_get_entity_irg(const ir_entity *ent) +{ + assert(ent && ent->kind == k_entity); + if (!is_Method_type(ent->type) || ent == unknown_entity) { + return NULL; + } - if (bits & 7) return -1; - return bits >> 3; + return ent->attr.mtd_attr.irg; } -static INLINE void -_set_entity_offset_bits(entity *ent, int offset) { - assert(ent && ent->kind == k_entity); - ent->offset = offset; +static inline ir_visited_t _get_entity_visited(const ir_entity *ent) +{ + assert(ent && ent->kind == k_entity); + return ent->visit; } -static INLINE void -_set_entity_offset_bytes(entity *ent, int offset) { - _set_entity_offset_bits(ent, offset * 8); +static inline void _set_entity_visited(ir_entity *ent, ir_visited_t num) +{ + assert(ent && ent->kind == k_entity); + ent->visit = num; } -static INLINE void * -_get_entity_link(const entity *ent) { - assert(ent && ent->kind == k_entity); - return ent->link; +static inline void _mark_entity_visited(ir_entity *ent) +{ + assert(ent && ent->kind == k_entity); + ent->visit = firm_type_visited; } -static INLINE void -_set_entity_link(entity *ent, void *l) { - assert(ent && ent->kind == k_entity); - ent->link = l; +static inline int _entity_visited(const ir_entity *ent) +{ + return _get_entity_visited(ent) >= firm_type_visited; } -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 int _entity_not_visited(const ir_entity *ent) +{ + return _get_entity_visited(ent) < firm_type_visited; } -#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) +static inline ir_type *_get_entity_repr_class(const ir_entity *ent) +{ + assert(ent && ent->kind == k_entity); + return ent->repr_class; +} + +static inline dbg_info *_get_entity_dbg_info(const ir_entity *ent) +{ + return ent->dbi; +} + +static inline void _set_entity_dbg_info(ir_entity *ent, dbg_info *db) +{ + ent->dbi = db; +} -# endif /* _ENTITY_T_H_ */ +#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 set_entity_ident(ent, id) _set_entity_ident(ent, id) +#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_linkage(ent) _get_entity_linkage(ent) +#define get_entity_volatility(ent) _get_entity_volatility(ent) +#define set_entity_volatility(ent, vol) _set_entity_volatility(ent, vol) +#define set_entity_alignment(ent, alignment) _set_entity_alignment(ent, alignment) +#define get_entity_alignment(ent) _get_entity_alignment(ent) +#define get_entity_align(ent) _get_entity_align(ent) +#define set_entity_align(ent, a) _set_entity_align(ent, a) +#define is_entity_compiler_generated(ent) _is_entity_compiler_generated(ent) +#define set_entity_compiler_generated(ent, flag) _set_entity_compiler_generated(ent, flag) +#define get_entity_usage(ent) _get_entity_usage(ent) +#define set_entity_usage(ent, flags) _set_entity_usage(ent, flags) +#define get_entity_offset(ent) _get_entity_offset(ent) +#define set_entity_offset(ent, offset) _set_entity_offset(ent, offset) +#define get_entity_offset_bits_remainder(ent) _get_entity_offset_bits_remainder(ent) +#define set_entity_offset_bits_remainder(ent, o) _set_entity_offset_bits_remainder(ent, o) +#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_repr_class(ent) _get_entity_repr_class(ent) +#define get_entity_dbg_info(ent) _get_entity_dbg_info(ent) +#define set_entity_dbg_info(ent, db) _set_entity_dbg_info(ent, db) + +#endif