nsz Git - libfirm/blob - ir/tr/entity_t.h

   1 /*
   2  * Project:     libFIRM
   3  * File name:   ir/tr/entity_t.h
   4  * Purpose:     Representation of all program known entities -- private header.
   5  * Author:      Martin Trapp, Christian Schaefer
   6  * Modified by: Goetz Lindenmaier
   7  * Created:
   8  * CVS-ID:      $Id$
   9  * Copyright:   (c) 1998-2003 Universität Karlsruhe
  10  * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
  11  */
  12
  13 /**
  14  * @file entity_t.h
  15  *
  16  * entity.h:  entities represent all program known objects.
  17  *
  18  * @author Martin Trapp, Christian Schaefer, Goetz Lindenmaier
  19  *
  20  *  An entity is the representation of program known objects in Firm.
  21  *  The primary concept of entities is to represent members of complex
  22  *  types, i.e., fields and methods of classes.  As not all programming
  23  *  language model all variables and methods as members of some class,
  24  *  the concept of entities is extended to cover also local and global
  25  *  variables, and arbitrary procedures.
  26  *
  27  *  An entity always specifies the type of the object it represents and
  28  *  the type of the object it is a part of, the owner of the entity.
  29  *  Originally this is the type of the class of which the entity is a
  30  *  member.
  31  *  The owner of local variables is the procedure they are defined in.
  32  *  The owner of global variables and procedures visible in the whole
  33  *  program is a universally defined class type "GlobalType".  The owner
  34  *  of procedures defined in the scope of an other procedure is the
  35  *  enclosing procedure.
  36  */
  37
  38 # ifndef _ENTITY_T_H_
  39 # define _ENTITY_T_H_
  40
  41 #include "firm_common_t.h"
  42 #include "firm_config.h"
  43
  44 #include "type_t.h"
  45 #include "entity.h"
  46 #include "typegmod.h"
  47 #include "mangle.h"
  48 #include "pseudo_irg.h"
  49
  50 /** A path in a compund graph. */
  51 struct compound_graph_path {
  52   firm_kind kind;       /**< dynamic type tag for compound graph path. */
  53   type *tp;             /**< The type this path belongs to. */
  54   int len;              /**< length of the path */
  55   struct tuple {
  56     int    index;       /**< Array index.  To compute position of array elements */
  57     entity *node;       /**< entity */
  58   } list[1];            /**< List of entitiy/index tuple of length len to express the
  59                              access path. */
  60 };
  61
  62 /** the type of an entity */
  63 struct entity {
  64   firm_kind kind;       /**< dynamic type tag for entity. */
  65   ident *name;          /**< name of this entity */
  66   ident *ld_name;       /**< Unique name of this entity, i.e., the mangled
  67                            name.  If the field is read before written a default
  68                            mangling is applies.  The name of the owner is prepended
  69                            to the name of the entity, separated by a underscore.
  70                            E.g.,  for a class `A' with field `a' this
  71                            is the ident for `A_a'. */
  72   type *type;           /**< The type of this entity, e.g., a method type, a
  73                            basic type of the language or a class itself */
  74   type *owner;          /**< The compound type (e.g. class type) this entity belongs to. */
  75   ent_allocation allocation;  /**< Distinguishes static and dynamically allocated
  76                  entities and some further cases. */
  77   visibility visibility;  /**< Specifies visibility to external program
  78                  fragments */
  79   ent_variability variability;  /**< Specifies variability of entities content */
  80   ent_volatility volatility;    /**< Specifies volatility of entities content */
  81   ent_stickyness stickyness;    /**< Specifies whether this entity is sticky  */
  82   int  offset;          /**< Offset in bits for this entity.  Fixed when layout
  83                of owner is determined.  */
  84   void *link;           /**< To store some intermediate information */
  85   unsigned long visit;  /**< visited counter for walks of the type information */
  86   struct dbg_info* dbi;    /**< A pointer to information for debug support. */
  87
  88   /* ------------- fields for atomic entities  ---------------*/
  89
  90   ir_node *value;            /**< value if entity is not of variability uninitialized.
  91                                Only for atomic entities. */
  92
  93   /* ------------- fields for compound entities ---------------*/
  94
  95   ir_node **values;     /**< constant values of compound entities. Only available if
  96                variability not uninitialized.  Must be set for variability constant
  97                            */
  98   compound_graph_path **val_paths; /**< paths corresponding to constant values. Only available if
  99                       variability not uninitialized.  Must be set for variability constant */
 100
 101   /* ------------- fields for entities owned by a class type ---------------*/
 102
 103   entity **overwrites;     /**< A list of entities this entity overwrites. */
 104   entity **overwrittenby;  /**< A list of entities that overwrite this entity.  */
 105
 106   /* ------------- fields for methods ---------------*/
 107
 108   enum peculiarity peculiarity;
 109   ir_graph *irg;        /**< If (type == method_type) this is the corresponding irg.
 110                The ir_graph constructor automatically sets this field.
 111                Yes, it must be here. */
 112
 113   /* ------------- fields for analyses ---------------*/
 114
 115
 116 #ifdef DEBUG_libfirm
 117   int nr;             /**< a unique node number for each node to make output
 118                            readable. */
 119 # endif /* DEBUG_libfirm */
 120 };
 121
 122
 123
 124 /* ----------------------- inline functions ------------------------ */
 125 static INLINE int
 126 _is_entity(const void *thing) {
 127   return get_kind(thing) == k_entity;
 128 }
 129
 130 static INLINE const char *
 131 _get_entity_name(const entity *ent) {
 132   assert(ent && ent->kind == k_entity);
 133   return get_id_str(get_entity_ident(ent));
 134 }
 135
 136 static INLINE ident *
 137 _get_entity_ident(const entity *ent) {
 138   assert(ent && ent->kind == k_entity);
 139   return ent->name;
 140 }
 141
 142 static INLINE type *
 143 _get_entity_owner(entity *ent) {
 144   assert(ent && ent->kind == k_entity);
 145   return ent->owner = skip_tid(ent->owner);
 146 }
 147
 148 static INLINE ident *
 149 _get_entity_ld_ident(entity *ent)
 150 {
 151   assert(ent && ent->kind == k_entity);
 152   if (ent->ld_name == NULL)
 153     ent->ld_name = mangle_entity(ent);
 154   return ent->ld_name;
 155 }
 156
 157 static INLINE void
 158 _set_entity_ld_ident(entity *ent, ident *ld_ident) {
 159   assert(ent && ent->kind == k_entity);
 160   ent->ld_name = ld_ident;
 161 }
 162
 163 static INLINE const char *
 164 _get_entity_ld_name(entity *ent) {
 165   assert(ent && ent->kind == k_entity);
 166   return get_id_str(get_entity_ld_ident(ent));
 167 }
 168
 169 static INLINE type *
 170 _get_entity_type(entity *ent) {
 171   assert(ent && ent->kind == k_entity);
 172   return ent->type = skip_tid(ent->type);
 173 }
 174
 175 static INLINE void
 176 _set_entity_type(entity *ent, type *type) {
 177   assert(ent && ent->kind == k_entity);
 178   ent->type = type;
 179 }
 180
 181 static INLINE ent_allocation
 182 _get_entity_allocation(const entity *ent) {
 183   assert(ent && ent->kind == k_entity);
 184   return ent->allocation;
 185 }
 186
 187 static INLINE void
 188 _set_entity_allocation(entity *ent, ent_allocation al) {
 189   assert(ent && ent->kind == k_entity);
 190   ent->allocation = al;
 191 }
 192
 193 static INLINE visibility
 194 _get_entity_visibility(const entity *ent) {
 195   assert(ent && ent->kind == k_entity);
 196   return ent->visibility;
 197 }
 198
 199 static INLINE ent_variability
 200 _get_entity_variability(const entity *ent) {
 201   assert(ent && ent->kind == k_entity);
 202   return ent->variability;
 203 }
 204
 205 static INLINE ent_volatility
 206 _get_entity_volatility(const entity *ent) {
 207   assert(ent && ent->kind == k_entity);
 208   return ent->volatility;
 209 }
 210
 211 static INLINE void
 212 _set_entity_volatility(entity *ent, ent_volatility vol) {
 213   assert(ent && ent->kind == k_entity);
 214   ent->volatility = vol;
 215 }
 216
 217 static INLINE peculiarity
 218 _get_entity_peculiarity(const entity *ent) {
 219   assert(ent && ent->kind == k_entity);
 220   return ent->peculiarity;
 221 }
 222
 223 /**
 224  * @todo Why peculiarity only for methods?
 225  *       Good question.  Originally, there were only description and
 226  *       existent.  The thought was, what sense does it make to
 227  *       describe a field?  With inherited the situation changed.  So
 228  *       I removed the assertion.  GL, 28.2.05
 229  */
 230 static INLINE void
 231 _set_entity_peculiarity(entity *ent, peculiarity pec) {
 232   assert(ent && ent->kind == k_entity);
 233   /* @@@ why peculiarity only for methods? */
 234   //assert(is_Method_type(ent->type));
 235
 236   ent->peculiarity = pec;
 237 }
 238
 239 static INLINE ent_stickyness
 240 _get_entity_stickyness(const entity *ent) {
 241   assert(ent && ent->kind == k_entity);
 242   return ent->stickyness;
 243 }
 244
 245 static INLINE void
 246 _set_entity_stickyness(entity *ent, ent_stickyness stickyness)
 247 {
 248   assert(ent && ent->kind == k_entity);
 249   ent->stickyness = stickyness;
 250 }
 251
 252 static INLINE int
 253 _get_entity_offset_bits(const entity *ent) {
 254   assert(ent && ent->kind == k_entity);
 255   return ent->offset;
 256 }
 257
 258 static INLINE int
 259 _get_entity_offset_bytes(const entity *ent) {
 260   int bits = _get_entity_offset_bits(ent);
 261
 262   if (bits & 7) return -1;
 263   return bits >> 3;
 264 }
 265
 266 static INLINE void
 267 _set_entity_offset_bits(entity *ent, int offset) {
 268   assert(ent && ent->kind == k_entity);
 269   ent->offset = offset;
 270 }
 271
 272 static INLINE void
 273 _set_entity_offset_bytes(entity *ent, int offset) {
 274   _set_entity_offset_bits(ent, offset * 8);
 275 }
 276
 277 static INLINE void *
 278 _get_entity_link(const entity *ent) {
 279   assert(ent && ent->kind == k_entity);
 280   return ent->link;
 281 }
 282
 283 static INLINE void
 284 _set_entity_link(entity *ent, void *l) {
 285   assert(ent && ent->kind == k_entity);
 286   ent->link = l;
 287 }
 288
 289 static INLINE ir_graph *
 290 _get_entity_irg(const entity *ent) {
 291   assert(ent && ent->kind == k_entity);
 292   assert(ent == unknown_entity || is_Method_type(ent->type));
 293   if (!get_visit_pseudo_irgs() && ent->irg && is_pseudo_ir_graph(ent->irg))
 294     return NULL;
 295   return ent->irg;
 296 }
 297
 298 static INLINE unsigned long
 299 _get_entity_visited(entity *ent) {
 300   assert(ent && ent->kind == k_entity);
 301   return ent->visit;
 302 }
 303
 304 static INLINE void
 305 _set_entity_visited(entity *ent, unsigned long num) {
 306   assert(ent && ent->kind == k_entity);
 307   ent->visit = num;
 308 }
 309
 310 static INLINE void
 311 _mark_entity_visited(entity *ent) {
 312   assert(ent && ent->kind == k_entity);
 313   ent->visit = firm_type_visited;
 314 }
 315
 316 static INLINE int
 317 _entity_visited(entity *ent) {
 318   return _get_entity_visited(ent) >= firm_type_visited;
 319 }
 320
 321 static INLINE int
 322 _entity_not_visited(entity *ent) {
 323   return _get_entity_visited(ent) < firm_type_visited;
 324 }
 325
 326 #define is_entity(thing)                        _is_entity(thing)
 327 #define get_entity_name(ent)                    _get_entity_name(ent)
 328 #define get_entity_ident(ent)                   _get_entity_ident(ent)
 329 #define get_entity_owner(ent)                   _get_entity_owner(ent)
 330 #define get_entity_ld_ident(ent)                _get_entity_ld_ident(ent)
 331 #define set_entity_ld_ident(ent, ld_ident)      _set_entity_ld_ident(ent, ld_ident)
 332 #define get_entity_ld_name(ent)                 _get_entity_ld_name(ent)
 333 #define get_entity_type(ent)                    _get_entity_type(ent)
 334 #define set_entity_type(ent, type)              _set_entity_type(ent, type)
 335 #define get_entity_allocation(ent)              _get_entity_allocation(ent)
 336 #define set_entity_allocation(ent, al)          _set_entity_allocation(ent, al)
 337 #define get_entity_visibility(ent)              _get_entity_visibility(ent)
 338 #define get_entity_variability(ent)             _get_entity_variability(ent)
 339 #define get_entity_volatility(ent)              _get_entity_volatility(ent)
 340 #define set_entity_volatility(ent, vol)         _set_entity_volatility(ent, vol)
 341 #define get_entity_peculiarity(ent)             _get_entity_peculiarity(ent)
 342 #define set_entity_peculiarity(ent, pec)        _set_entity_peculiarity(ent, pec)
 343 #define get_entity_stickyness(ent)              _get_entity_stickyness(ent)
 344 #define set_entity_stickyness(ent, stickyness)  _set_entity_stickyness(ent, stickyness)
 345 #define get_entity_offset_bits(ent)             _get_entity_offset_bits(ent)
 346 #define get_entity_offset_bytes(ent)            _get_entity_offset_bytes(ent)
 347 #define set_entity_offset_bits(ent, offset)     _set_entity_offset_bits(ent, offset)
 348 #define set_entity_offset_bytes(ent, offset)    _set_entity_offset_bytes(ent, offset)
 349 #define get_entity_link(ent)                    _get_entity_link(ent)
 350 #define set_entity_link(ent, l)                 _set_entity_link(ent, l)
 351 #define get_entity_irg(ent)                     _get_entity_irg(ent)
 352 #define get_entity_visited(ent)                 _get_entity_visited(ent)
 353 #define set_entity_visited(ent, num)            _set_entity_visited(ent, num)
 354 #define mark_entity_visited(ent)                _mark_entity_visited(ent)
 355 #define entity_visited(ent)                     _entity_visited(ent)
 356 #define entity_not_visited(ent)                 _entity_not_visited(ent)
 357
 358 # endif /* _ENTITY_T_H_ */