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
9 * Copyright: (c) 1998-2003 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.
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 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 entitiy/index tuple of length len to express the
62 /** the type of an 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
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. */
88 /* ------------- fields for atomic entities ---------------*/
90 ir_node *value; /**< value if entity is not of variability uninitialized.
91 Only for atomic entities. */
93 /* ------------- fields for compound entities ---------------*/
95 ir_node **values; /**< constant values of compound entities. Only available if
96 variability not uninitialized. Must be set for variability constant
98 compound_graph_path **val_paths; /**< paths corresponding to constant values. Only available if
99 variability not uninitialized. Must be set for variability constant */
101 /* ------------- fields for entities owned by a class type ---------------*/
103 entity **overwrites; /**< A list of entities this entity overwrites. */
104 entity **overwrittenby; /**< A list of entities that overwrite this entity. */
106 /* ------------- fields for methods ---------------*/
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 unsigned irg_add_properties; /**< If (type == method_type) this is a set of additional.
113 graph flags if the irg of an entity is not known. */
114 unsigned irg_calling_conv; /**< If (type == method_type) this is a set of calling.
115 convention flags if the irg of an entity is not known. */
116 ptr_access_kind *param_access; /**< the parameter access */
118 /* ------------- fields for analyses ---------------*/
122 int nr; /**< a unique node number for each node to make output
124 # endif /* DEBUG_libfirm */
127 /** Initialize entity module. */
128 void firm_init_entity(void);
131 /* ----------------------- inline functions ------------------------ */
133 _is_entity(const void *thing) {
134 return get_kind(thing) == k_entity;
137 static INLINE const char *
138 _get_entity_name(const entity *ent) {
139 assert(ent && ent->kind == k_entity);
140 return get_id_str(get_entity_ident(ent));
143 static INLINE ident *
144 _get_entity_ident(const entity *ent) {
145 assert(ent && ent->kind == k_entity);
150 _get_entity_owner(entity *ent) {
151 assert(ent && ent->kind == k_entity);
152 return ent->owner = skip_tid(ent->owner);
155 static INLINE ident *
156 _get_entity_ld_ident(entity *ent)
158 assert(ent && ent->kind == k_entity);
159 if (ent->ld_name == NULL)
160 ent->ld_name = mangle_entity(ent);
165 _set_entity_ld_ident(entity *ent, ident *ld_ident) {
166 assert(ent && ent->kind == k_entity);
167 ent->ld_name = ld_ident;
170 static INLINE const char *
171 _get_entity_ld_name(entity *ent) {
172 assert(ent && ent->kind == k_entity);
173 return get_id_str(get_entity_ld_ident(ent));
177 _get_entity_type(entity *ent) {
178 assert(ent && ent->kind == k_entity);
179 return ent->type = skip_tid(ent->type);
183 _set_entity_type(entity *ent, type *type) {
184 assert(ent && ent->kind == k_entity);
188 static INLINE ent_allocation
189 _get_entity_allocation(const entity *ent) {
190 assert(ent && ent->kind == k_entity);
191 return ent->allocation;
195 _set_entity_allocation(entity *ent, ent_allocation al) {
196 assert(ent && ent->kind == k_entity);
197 ent->allocation = al;
200 static INLINE visibility
201 _get_entity_visibility(const entity *ent) {
202 assert(ent && ent->kind == k_entity);
203 return ent->visibility;
206 static INLINE ent_variability
207 _get_entity_variability(const entity *ent) {
208 assert(ent && ent->kind == k_entity);
209 return ent->variability;
212 static INLINE ent_volatility
213 _get_entity_volatility(const entity *ent) {
214 assert(ent && ent->kind == k_entity);
215 return ent->volatility;
219 _set_entity_volatility(entity *ent, ent_volatility vol) {
220 assert(ent && ent->kind == k_entity);
221 ent->volatility = vol;
224 static INLINE peculiarity
225 _get_entity_peculiarity(const entity *ent) {
226 assert(ent && ent->kind == k_entity);
227 return ent->peculiarity;
231 * @todo Why peculiarity only for methods?
232 * Good question. Originally, there were only description and
233 * existent. The thought was, what sense does it make to
234 * describe a field? With inherited the situation changed. So
235 * I removed the assertion. GL, 28.2.05
238 _set_entity_peculiarity(entity *ent, peculiarity pec) {
239 assert(ent && ent->kind == k_entity);
240 /* @@@ why peculiarity only for methods? */
241 //assert(is_Method_type(ent->type));
243 ent->peculiarity = pec;
246 static INLINE ent_stickyness
247 _get_entity_stickyness(const entity *ent) {
248 assert(ent && ent->kind == k_entity);
249 return ent->stickyness;
253 _set_entity_stickyness(entity *ent, ent_stickyness stickyness)
255 assert(ent && ent->kind == k_entity);
256 ent->stickyness = stickyness;
260 _get_entity_offset_bits(const entity *ent) {
261 assert(ent && ent->kind == k_entity);
266 _get_entity_offset_bytes(const entity *ent) {
267 int bits = _get_entity_offset_bits(ent);
269 if (bits & 7) return -1;
274 _set_entity_offset_bits(entity *ent, int offset) {
275 assert(ent && ent->kind == k_entity);
276 ent->offset = offset;
280 _set_entity_offset_bytes(entity *ent, int offset) {
281 _set_entity_offset_bits(ent, offset * 8);
285 _get_entity_link(const entity *ent) {
286 assert(ent && ent->kind == k_entity);
291 _set_entity_link(entity *ent, void *l) {
292 assert(ent && ent->kind == k_entity);
296 static INLINE ir_graph *
297 _get_entity_irg(const entity *ent) {
298 assert(ent && ent->kind == k_entity);
299 assert(ent == unknown_entity || is_Method_type(ent->type));
300 if (!get_visit_pseudo_irgs() && ent->irg && is_pseudo_ir_graph(ent->irg))
305 static INLINE unsigned long
306 _get_entity_visited(entity *ent) {
307 assert(ent && ent->kind == k_entity);
312 _set_entity_visited(entity *ent, unsigned long num) {
313 assert(ent && ent->kind == k_entity);
318 _mark_entity_visited(entity *ent) {
319 assert(ent && ent->kind == k_entity);
320 ent->visit = firm_type_visited;
324 _entity_visited(entity *ent) {
325 return _get_entity_visited(ent) >= firm_type_visited;
329 _entity_not_visited(entity *ent) {
330 return _get_entity_visited(ent) < firm_type_visited;
333 static INLINE unsigned
334 _get_entity_additional_properties(const entity *ent) {
336 assert(ent && ent->kind == k_entity);
337 assert(ent == unknown_entity || is_Method_type(ent->type));
338 irg = _get_entity_irg(ent);
340 get_irg_additional_properties(irg) :
341 ent->irg_add_properties;
345 _set_entity_additional_properties(entity *ent, unsigned mask) {
347 assert(ent && ent->kind == k_entity);
348 assert(ent == unknown_entity || is_Method_type(ent->type));
349 irg = _get_entity_irg(ent);
351 set_irg_additional_properties(irg, mask);
353 ent->irg_add_properties = mask;
357 _set_entity_additional_property(entity *ent, irg_additional_property flag) {
359 assert(ent && ent->kind == k_entity);
360 assert(ent == unknown_entity || is_Method_type(ent->type));
361 irg = _get_entity_irg(ent);
363 set_irg_additional_property(irg, flag);
365 ent->irg_add_properties |= flag;
368 static INLINE unsigned
369 _get_entity_calling_convention(const entity *ent) {
371 assert(ent && ent->kind == k_entity);
372 assert(ent == unknown_entity || is_Method_type(ent->type));
373 irg = _get_entity_irg(ent);
375 return get_irg_calling_convention(irg);
377 return ent->irg_calling_conv;
381 _set_entity_calling_convention(entity *ent, unsigned cc_mask) {
383 assert(ent && ent->kind == k_entity);
384 assert(ent == unknown_entity || is_Method_type(ent->type));
385 irg = _get_entity_irg(ent);
387 set_irg_calling_convention(irg, cc_mask);
389 ent->irg_calling_conv = cc_mask;
392 #define is_entity(thing) _is_entity(thing)
393 #define get_entity_name(ent) _get_entity_name(ent)
394 #define get_entity_ident(ent) _get_entity_ident(ent)
395 #define get_entity_owner(ent) _get_entity_owner(ent)
396 #define get_entity_ld_ident(ent) _get_entity_ld_ident(ent)
397 #define set_entity_ld_ident(ent, ld_ident) _set_entity_ld_ident(ent, ld_ident)
398 #define get_entity_ld_name(ent) _get_entity_ld_name(ent)
399 #define get_entity_type(ent) _get_entity_type(ent)
400 #define set_entity_type(ent, type) _set_entity_type(ent, type)
401 #define get_entity_allocation(ent) _get_entity_allocation(ent)
402 #define set_entity_allocation(ent, al) _set_entity_allocation(ent, al)
403 #define get_entity_visibility(ent) _get_entity_visibility(ent)
404 #define get_entity_variability(ent) _get_entity_variability(ent)
405 #define get_entity_volatility(ent) _get_entity_volatility(ent)
406 #define set_entity_volatility(ent, vol) _set_entity_volatility(ent, vol)
407 #define get_entity_peculiarity(ent) _get_entity_peculiarity(ent)
408 #define set_entity_peculiarity(ent, pec) _set_entity_peculiarity(ent, pec)
409 #define get_entity_stickyness(ent) _get_entity_stickyness(ent)
410 #define set_entity_stickyness(ent, stickyness) _set_entity_stickyness(ent, stickyness)
411 #define get_entity_offset_bits(ent) _get_entity_offset_bits(ent)
412 #define get_entity_offset_bytes(ent) _get_entity_offset_bytes(ent)
413 #define set_entity_offset_bits(ent, offset) _set_entity_offset_bits(ent, offset)
414 #define set_entity_offset_bytes(ent, offset) _set_entity_offset_bytes(ent, offset)
415 #define get_entity_link(ent) _get_entity_link(ent)
416 #define set_entity_link(ent, l) _set_entity_link(ent, l)
417 #define get_entity_irg(ent) _get_entity_irg(ent)
418 #define get_entity_visited(ent) _get_entity_visited(ent)
419 #define set_entity_visited(ent, num) _set_entity_visited(ent, num)
420 #define mark_entity_visited(ent) _mark_entity_visited(ent)
421 #define entity_visited(ent) _entity_visited(ent)
422 #define entity_not_visited(ent) _entity_not_visited(ent)
423 #define get_entity_additional_properties(ent) _get_entity_additional_properties(ent)
424 #define set_entity_additional_properties(ent, m) _set_entity_additional_properties(ent, m)
425 #define set_entity_additional_property(ent, f) _set_entity_additional_property(ent, f)
426 #define get_entity_calling_convention(ent) _get_entity_calling_convention(ent)
427 #define set_entity_calling_convention(ent, cc) _set_entity_calling_convention(ent, cc)
429 # endif /* _ENTITY_T_H_ */