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, Michael Beck
9 * Copyright: (c) 1998-2006 Universität Karlsruhe
10 * Licence: This file protected by GPL - GNU GENERAL PUBLIC LICENSE.
16 * entity.h: entities represent all program known objects.
18 * @author Martin Trapp, Christian Schaefer, Goetz Lindenmaier
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.
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
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.
38 #ifndef _FIRM_TR_ENTITY_T_H_
39 #define _FIRM_TR_ENTITY_T_H_
41 #include "firm_common_t.h"
42 #include "firm_config.h"
48 #include "pseudo_irg.h"
50 /** A path in a compound graph. */
51 struct compound_graph_path {
52 firm_kind kind; /**< dynamic type tag for compound graph path. */
53 ir_type *tp; /**< The type this path belongs to. */
54 int len; /**< length of the path */
56 int index; /**< Array index. To compute position of array elements */
57 entity *node; /**< entity */
58 } list[1]; /**< List of entity/index tuple of length len to express the
62 /** The attributes for atomic entities. */
63 typedef struct atomic_ent_attr {
64 ir_node *value; /**< value if entity is not of variability uninitialized.
65 Only for atomic entities. */
68 /** The attributes for compound entities. */
69 typedef struct compound_ent_attr {
70 ir_node **values; /**< constant values of compound entities. Only available if
71 variability not uninitialized. Must be set for variability constant. */
72 compound_graph_path **val_paths; /**< paths corresponding to constant values. Only available if
73 variability not uninitialized. Must be set for variability constant. */
76 /** A reserved value for "not yet set". */
77 #define VTABLE_NUM_NOT_SET ((unsigned)(-1))
79 /** The attributes for methods. */
80 typedef struct method_ent_attr {
81 ir_graph *irg; /**< The corresponding irg if known.
82 The ir_graph constructor automatically sets this field. */
83 unsigned irg_add_properties; /**< Additional graph properties can be
84 stored in a entity if no irg is available. */
86 unsigned vtable_number; /**< For a dynamically called method, the number assigned
87 in the virtual function table. */
89 ptr_access_kind *param_access; /**< the parameter access */
90 float *param_weight; /**< The weight of method's parameters. Parameters
91 with a high weight are good for procedure cloning. */
92 ir_img_section section; /**< The code section where this method should be placed */
96 /** The type of an entity. */
98 firm_kind kind; /**< The dynamic type tag for entity. */
99 ident *name; /**< The name of this entity. */
100 ident *ld_name; /**< Unique name of this entity, i.e., the mangled
101 name. If the field is read before written a default
102 mangling is applies. The name of the owner is prepended
103 to the name of the entity, separated by a underscore.
104 E.g., for a class `A' with field `a' this
105 is the ident for `A_a'. */
106 ir_type *type; /**< The type of this entity, e.g., a method type, a
107 basic type of the language or a class itself. */
108 ir_type *owner; /**< The compound type (e.g. class type) this entity belongs to. */
109 ir_allocation allocation:3; /**< Distinguishes static and dynamically allocated
110 entities and some further cases. */
111 ir_visibility visibility:3; /**< Specifies visibility to external program
113 ir_variability variability:3; /**< Specifies variability of entities content. */
114 ir_volatility volatility:2; /**< Specifies volatility of entities content. */
115 ir_stickyness stickyness:2; /**< Specifies whether this entity is sticky. */
116 ir_peculiarity peculiarity:3; /**< The peculiarity of this entity. */
117 unsigned compiler_gen:1; /**< If set, this entity was compiler generated. */
118 int offset; /**< Offset in bits for this entity. Fixed when layout
119 of owner is determined. */
120 unsigned long visit; /**< visited counter for walks of the type information. */
121 struct dbg_info *dbi; /**< A pointer to information for debug support. */
122 void *link; /**< To store some intermediate information. */
123 ir_type *repr_class; /**< If this entity represents a class info, the associated class. */
125 /* ------------- fields for entities owned by a class type ---------------*/
127 entity **overwrites; /**< A list of entities this entity overwrites. */
128 entity **overwrittenby; /**< A list of entities that overwrite this entity. */
130 /* ------------- fields for atomic entities --------------- */
131 ir_node *value; /**< value if entity is not of variability uninitialized.
132 Only for atomic entities. */
134 /* ------------- fields for compound entities -------------- */
135 compound_ent_attr cmpd_attr;
136 /* ------------- fields for method entities ---------------- */
137 method_ent_attr mtd_attr;
138 } attr; /**< type specific attributes */
140 /* ------------- fields for analyses ---------------*/
143 long nr; /**< A unique node number for each node to make output
145 # endif /* DEBUG_libfirm */
148 /** Initialize the entity module. */
149 void firm_init_entity(void);
152 /* ----------------------- inline functions ------------------------ */
154 _is_entity(const void *thing) {
155 return get_kind(thing) == k_entity;
158 static INLINE const char *
159 _get_entity_name(const entity *ent) {
160 assert(ent && ent->kind == k_entity);
161 return get_id_str(get_entity_ident(ent));
164 static INLINE ident *
165 _get_entity_ident(const entity *ent) {
166 assert(ent && ent->kind == k_entity);
171 _set_entity_ident(entity *ent, ident *id) {
172 assert(ent && ent->kind == k_entity);
176 static INLINE ir_type *
177 _get_entity_owner(entity *ent) {
178 assert(ent && ent->kind == k_entity);
179 return ent->owner = skip_tid(ent->owner);
182 static INLINE ident *
183 _get_entity_ld_ident(entity *ent)
185 assert(ent && ent->kind == k_entity);
186 if (ent->ld_name == NULL)
187 ent->ld_name = mangle_entity(ent);
192 _set_entity_ld_ident(entity *ent, ident *ld_ident) {
193 assert(ent && ent->kind == k_entity);
194 ent->ld_name = ld_ident;
197 static INLINE const char *
198 _get_entity_ld_name(entity *ent) {
199 assert(ent && ent->kind == k_entity);
200 return get_id_str(get_entity_ld_ident(ent));
203 static INLINE ir_type *
204 _get_entity_type(entity *ent) {
205 assert(ent && ent->kind == k_entity);
206 return ent->type = skip_tid(ent->type);
210 _set_entity_type(entity *ent, ir_type *type) {
211 assert(ent && ent->kind == k_entity);
215 static INLINE ir_allocation
216 _get_entity_allocation(const entity *ent) {
217 assert(ent && ent->kind == k_entity);
218 return ent->allocation;
222 _set_entity_allocation(entity *ent, ir_allocation al) {
223 assert(ent && ent->kind == k_entity);
224 ent->allocation = al;
227 static INLINE ir_visibility
228 _get_entity_visibility(const entity *ent) {
229 assert(ent && ent->kind == k_entity);
230 return ent->visibility;
233 static INLINE ir_variability
234 _get_entity_variability(const entity *ent) {
235 assert(ent && ent->kind == k_entity);
236 return ent->variability;
239 static INLINE ir_volatility
240 _get_entity_volatility(const entity *ent) {
241 assert(ent && ent->kind == k_entity);
242 return ent->volatility;
246 _set_entity_volatility(entity *ent, ir_volatility vol) {
247 assert(ent && ent->kind == k_entity);
248 ent->volatility = vol;
251 static INLINE ir_peculiarity
252 _get_entity_peculiarity(const entity *ent) {
253 assert(ent && ent->kind == k_entity);
254 return ent->peculiarity;
258 * @todo Why peculiarity only for methods?
259 * Good question. Originally, there were only description and
260 * existent. The thought was, what sense does it make to
261 * describe a field? With inherited the situation changed. So
262 * I removed the assertion. GL, 28.2.05
265 _set_entity_peculiarity(entity *ent, ir_peculiarity pec) {
266 assert(ent && ent->kind == k_entity);
267 /* @@@ why peculiarity only for methods? */
268 //assert(is_Method_type(ent->type));
270 ent->peculiarity = pec;
273 static INLINE ir_stickyness
274 _get_entity_stickyness(const entity *ent) {
275 assert(ent && ent->kind == k_entity);
276 return ent->stickyness;
280 _set_entity_stickyness(entity *ent, ir_stickyness stickyness)
282 assert(ent && ent->kind == k_entity);
283 ent->stickyness = stickyness;
287 _get_entity_offset_bits(const entity *ent) {
288 assert(ent && ent->kind == k_entity);
293 _get_entity_offset_bytes(const entity *ent) {
294 int bits = _get_entity_offset_bits(ent);
296 if (bits & 7) return -1;
301 _set_entity_offset_bits(entity *ent, int offset) {
302 assert(ent && ent->kind == k_entity);
303 ent->offset = offset;
307 _set_entity_offset_bytes(entity *ent, int offset) {
308 _set_entity_offset_bits(ent, offset * 8);
312 _get_entity_link(const entity *ent) {
313 assert(ent && ent->kind == k_entity);
318 _set_entity_link(entity *ent, void *l) {
319 assert(ent && ent->kind == k_entity);
323 static INLINE ir_graph *
324 _get_entity_irg(const entity *ent) {
325 assert(ent && ent->kind == k_entity);
326 assert(ent == unknown_entity || is_Method_type(ent->type));
327 if (!get_visit_pseudo_irgs() && ent->attr.mtd_attr.irg
328 && is_pseudo_ir_graph(ent->attr.mtd_attr.irg))
330 return ent->attr.mtd_attr.irg;
333 static INLINE unsigned long
334 _get_entity_visited(entity *ent) {
335 assert(ent && ent->kind == k_entity);
340 _set_entity_visited(entity *ent, unsigned long num) {
341 assert(ent && ent->kind == k_entity);
346 _mark_entity_visited(entity *ent) {
347 assert(ent && ent->kind == k_entity);
348 ent->visit = firm_type_visited;
352 _entity_visited(entity *ent) {
353 return _get_entity_visited(ent) >= firm_type_visited;
357 _entity_not_visited(entity *ent) {
358 return _get_entity_visited(ent) < firm_type_visited;
361 static INLINE ir_type *
362 _get_entity_repr_class(const entity *ent) {
363 assert(ent && ent->kind == k_entity);
364 return ent->repr_class;
367 #define is_entity(thing) _is_entity(thing)
368 #define get_entity_name(ent) _get_entity_name(ent)
369 #define get_entity_ident(ent) _get_entity_ident(ent)
370 #define set_entity_ident(ent, id) _set_entity_ident(ent, id)
371 #define get_entity_owner(ent) _get_entity_owner(ent)
372 #define get_entity_ld_ident(ent) _get_entity_ld_ident(ent)
373 #define set_entity_ld_ident(ent, ld_ident) _set_entity_ld_ident(ent, ld_ident)
374 #define get_entity_ld_name(ent) _get_entity_ld_name(ent)
375 #define get_entity_type(ent) _get_entity_type(ent)
376 #define set_entity_type(ent, type) _set_entity_type(ent, type)
377 #define get_entity_allocation(ent) _get_entity_allocation(ent)
378 #define set_entity_allocation(ent, al) _set_entity_allocation(ent, al)
379 #define get_entity_visibility(ent) _get_entity_visibility(ent)
380 #define get_entity_variability(ent) _get_entity_variability(ent)
381 #define get_entity_volatility(ent) _get_entity_volatility(ent)
382 #define set_entity_volatility(ent, vol) _set_entity_volatility(ent, vol)
383 #define get_entity_peculiarity(ent) _get_entity_peculiarity(ent)
384 #define set_entity_peculiarity(ent, pec) _set_entity_peculiarity(ent, pec)
385 #define get_entity_stickyness(ent) _get_entity_stickyness(ent)
386 #define set_entity_stickyness(ent, stickyness) _set_entity_stickyness(ent, stickyness)
387 #define get_entity_offset_bits(ent) _get_entity_offset_bits(ent)
388 #define get_entity_offset_bytes(ent) _get_entity_offset_bytes(ent)
389 #define set_entity_offset_bits(ent, offset) _set_entity_offset_bits(ent, offset)
390 #define set_entity_offset_bytes(ent, offset) _set_entity_offset_bytes(ent, offset)
391 #define get_entity_link(ent) _get_entity_link(ent)
392 #define set_entity_link(ent, l) _set_entity_link(ent, l)
393 #define get_entity_irg(ent) _get_entity_irg(ent)
394 #define get_entity_visited(ent) _get_entity_visited(ent)
395 #define set_entity_visited(ent, num) _set_entity_visited(ent, num)
396 #define mark_entity_visited(ent) _mark_entity_visited(ent)
397 #define entity_visited(ent) _entity_visited(ent)
398 #define entity_not_visited(ent) _entity_not_visited(ent)
399 #define get_entity_repr_class(ent) _get_entity_repr_class(ent)
402 #endif /* _FIRM_TR_ENTITY_T_H_ */