2 * Copyright (C) 1995-2008 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
6 * This file may be distributed and/or modified under the terms of the
7 * GNU General Public License version 2 as published by the Free Software
8 * Foundation and appearing in the file LICENSE.GPL included in the
9 * packaging of this file.
11 * Licensees holding valid libFirm Professional Edition licenses may use
12 * this file in accordance with the libFirm Commercial License.
13 * Agreement provided with the Software.
15 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * @brief Representation of all program known entities -- private header.
23 * @author Martin Trapp, Christian Schaefer, Goetz Lindenmaier, Michael Beck
26 #ifndef FIRM_TR_ENTITY_T_H
27 #define FIRM_TR_ENTITY_T_H
34 #include "pseudo_irg.h"
35 #include "compound_path.h"
37 typedef struct ir_initializer_base_t {
38 ir_initializer_kind_t kind;
39 } ir_initializer_base_t;
42 * An compound initializer.
44 typedef struct ir_initializer_compound_t {
45 ir_initializer_base_t base;
46 unsigned n_initializers;
47 ir_initializer_t *initializers[1];
48 } ir_initializer_compound_t;
51 * An initializer containing an ir_node,
53 typedef struct ir_initializer_const_t {
54 ir_initializer_base_t base;
56 } ir_initializer_const_t ;
59 * An initializer containing a tarval.
61 typedef struct ir_initializer_tarval_t {
62 ir_initializer_base_t base;
64 } ir_initializer_tarval_t ;
66 union ir_initializer_t {
67 ir_initializer_kind_t kind;
68 ir_initializer_base_t base;
69 ir_initializer_compound_t compound;
70 ir_initializer_const_t consti;
71 ir_initializer_tarval_t tarval;
74 /** The attributes for compound entities. */
75 typedef struct compound_ent_attr {
76 ir_node **values; /**< constant values of compound entities. */
77 compound_graph_path **val_paths;
78 /**< paths corresponding to constant values. */
81 /** A reserved value for "not yet set". */
82 #define VTABLE_NUM_NOT_SET ((unsigned)(-1))
84 /** The attributes for methods. */
85 typedef struct method_ent_attr {
86 ir_graph *irg; /**< The corresponding irg if known.
87 The ir_graph constructor automatically sets this field. */
88 unsigned irg_add_properties; /**< Additional graph properties can be
89 stored in a entity if no irg is available. */
91 unsigned vtable_number; /**< For a dynamically called method, the number assigned
92 in the virtual function table. */
94 ptr_access_kind *param_access; /**< the parameter access */
95 unsigned *param_weight; /**< The weight of method's parameters. Parameters
96 with a high weight are good candidates for procedure cloning. */
99 /** additional attributes for code entities */
100 typedef struct code_ent_attr {
101 ir_label_t label; /** label of the basic block */
106 * An abstract data type to represent program entities.
111 firm_kind kind; /**< The dynamic type tag for entity. */
112 ident *name; /**< The name of this entity. */
113 ident *ld_name; /**< Unique name of this entity, i.e., the mangled
114 name. If the field is read before written a default
115 mangling is applies. The name of the owner is prepended
116 to the name of the entity, separated by a underscore.
117 E.g., for a class `A' with field `a' this
118 is the ident for `A_a'. */
119 ir_type *type; /**< The type of this entity, e.g., a method type, a
120 basic type of the language or a class itself. */
121 ir_type *owner; /**< The compound type (e.g. class type) this entity belongs to. */
122 unsigned linkage:10; /**< Specifies linkage type */
123 unsigned volatility:1; /**< Specifies volatility of entities content.*/
124 unsigned aligned:1; /**< Specifies alignment of entities content. */
125 unsigned usage:4; /**< flag indicating usage types of this entity,
126 see ir_entity_usage. */
127 unsigned compiler_gen:1; /**< If set, this entity was compiler generated.
129 unsigned visibility:3; /**< @deprecated */
130 unsigned allocation:3; /**< @deprecated */
131 unsigned peculiarity:3; /**< @deprecated */
132 unsigned final:1; /**< @deprecated */
133 int offset; /**< Offset in bytes for this entity. Fixed
134 when layout of owner is determined. */
135 unsigned alignment; /**< entity alignment in bytes */
136 unsigned char offset_bit_remainder;
137 /**< If the entity is a bit field, this is the
138 offset of the start of the bit field
139 within the byte specified by offset. */
140 ir_visited_t visit; /**< visited counter for walks of the type
142 struct dbg_info *dbi; /**< A pointer to information for debug support.
144 void *link; /**< To store some intermediate information. */
145 ir_type *repr_class; /**< If this entity represents a class info, the
148 /* ------------- fields for entities owned by a class type ---------------*/
150 ir_entity **overwrites; /**< A list of entities this entity overwrites.
152 ir_entity **overwrittenby; /**< A list of entities that overwrite this
155 /* ------------- fields for atomic entities --------------- */
156 ir_initializer_t *initializer; /**< entity initializer */
158 /* ------------- fields for compound entities -------------- */
159 compound_ent_attr cmpd_attr;
160 /* ------------- fields for method entities ---------------- */
161 method_ent_attr mtd_attr;
162 /* fields for code entities */
163 code_ent_attr code_attr;
164 } attr; /**< type specific attributes */
166 /* ------------- fields for analyses ---------------*/
169 long nr; /**< A unique node number for each node to make output
174 /** Initialize the entity module. */
175 void firm_init_entity(void);
177 /* ----------------------- inline functions ------------------------ */
179 _is_entity(const void *thing) {
180 return get_kind(thing) == k_entity;
183 static inline const char *
184 _get_entity_name(const ir_entity *ent) {
185 assert(ent && ent->kind == k_entity);
186 return get_id_str(get_entity_ident(ent));
189 static inline ident *
190 _get_entity_ident(const ir_entity *ent) {
191 assert(ent && ent->kind == k_entity);
196 _set_entity_ident(ir_entity *ent, ident *id) {
197 assert(ent && ent->kind == k_entity);
201 static inline ir_type *
202 _get_entity_owner(const ir_entity *ent) {
203 assert(ent && ent->kind == k_entity);
207 static inline ident *
208 _get_entity_ld_ident(const ir_entity *ent)
210 assert(ent && ent->kind == k_entity);
211 if (ent->ld_name == NULL)
217 _set_entity_ld_ident(ir_entity *ent, ident *ld_ident) {
218 assert(ent && ent->kind == k_entity);
219 ent->ld_name = ld_ident;
222 static inline const char *
223 _get_entity_ld_name(const ir_entity *ent) {
224 assert(ent && ent->kind == k_entity);
225 return get_id_str(get_entity_ld_ident(ent));
228 static inline ir_type *
229 _get_entity_type(const ir_entity *ent) {
230 assert(ent && ent->kind == k_entity);
235 _set_entity_type(ir_entity *ent, ir_type *type) {
236 assert(ent && ent->kind == k_entity);
240 static inline ir_linkage
241 _get_entity_linkage(const ir_entity *ent) {
242 assert(ent && ent->kind == k_entity);
246 static inline ir_volatility
247 _get_entity_volatility(const ir_entity *ent) {
248 assert(ent && ent->kind == k_entity);
249 return ent->volatility;
253 _set_entity_volatility(ir_entity *ent, ir_volatility vol) {
254 assert(ent && ent->kind == k_entity);
255 ent->volatility = vol;
258 static inline unsigned
259 _get_entity_alignment(const ir_entity *ent) {
260 assert(ent && ent->kind == k_entity);
261 return ent->alignment;
265 _set_entity_alignment(ir_entity *ent, unsigned alignment) {
266 assert(ent && ent->kind == k_entity);
267 ent->alignment = alignment;
270 static inline ir_align
271 _get_entity_aligned(const ir_entity *ent) {
272 assert(ent && ent->kind == k_entity);
277 _set_entity_aligned(ir_entity *ent, ir_align a) {
278 assert(ent && ent->kind == k_entity);
283 _is_entity_compiler_generated(const ir_entity *ent) {
284 assert(ent && ent->kind == k_entity);
285 return ent->compiler_gen;
289 _set_entity_compiler_generated(ir_entity *ent, int flag) {
290 assert(ent && ent->kind == k_entity);
291 ent->compiler_gen = flag ? 1 : 0;
294 static inline ir_entity_usage
295 _get_entity_usage(const ir_entity *ent) {
296 assert(ent && ent->kind == k_entity);
301 _set_entity_usage(ir_entity *ent, ir_entity_usage state) {
302 assert(ent && ent->kind == k_entity);
307 _get_entity_offset(const ir_entity *ent) {
308 assert(ent && ent->kind == k_entity);
313 _set_entity_offset(ir_entity *ent, int offset) {
314 assert(ent && ent->kind == k_entity);
315 ent->offset = offset;
318 static inline unsigned char
319 _get_entity_offset_bits_remainder(const ir_entity *ent) {
320 assert(ent && ent->kind == k_entity);
321 return ent->offset_bit_remainder;
325 _set_entity_offset_bits_remainder(ir_entity *ent, unsigned char offset) {
326 assert(ent && ent->kind == k_entity);
327 ent->offset_bit_remainder = offset;
331 _get_entity_link(const ir_entity *ent) {
332 assert(ent && ent->kind == k_entity);
337 _set_entity_link(ir_entity *ent, void *l) {
338 assert(ent && ent->kind == k_entity);
342 static inline ir_graph *
343 _get_entity_irg(const ir_entity *ent) {
345 assert(ent && ent->kind == k_entity);
346 if (!is_Method_type(ent->type) || ent == unknown_entity) {
350 irg = ent->attr.mtd_attr.irg;
351 if (irg != NULL && !get_visit_pseudo_irgs() && is_pseudo_ir_graph(irg))
356 static inline ir_visited_t _get_entity_visited(const ir_entity *ent)
358 assert(ent && ent->kind == k_entity);
362 static inline void _set_entity_visited(ir_entity *ent, ir_visited_t num)
364 assert(ent && ent->kind == k_entity);
368 static inline void _mark_entity_visited(ir_entity *ent)
370 assert(ent && ent->kind == k_entity);
371 ent->visit = firm_type_visited;
374 static inline int _entity_visited(const ir_entity *ent)
376 return _get_entity_visited(ent) >= firm_type_visited;
379 static inline int _entity_not_visited(const ir_entity *ent)
381 return _get_entity_visited(ent) < firm_type_visited;
384 static inline ir_type *_get_entity_repr_class(const ir_entity *ent)
386 assert(ent && ent->kind == k_entity);
387 return ent->repr_class;
390 static inline dbg_info *_get_entity_dbg_info(const ir_entity *ent)
395 static inline void _set_entity_dbg_info(ir_entity *ent, dbg_info *db)
400 int is_entity_final(const ir_entity *entity);
402 #define is_entity(thing) _is_entity(thing)
403 #define get_entity_name(ent) _get_entity_name(ent)
404 #define get_entity_ident(ent) _get_entity_ident(ent)
405 #define set_entity_ident(ent, id) _set_entity_ident(ent, id)
406 #define get_entity_owner(ent) _get_entity_owner(ent)
407 #define get_entity_ld_ident(ent) _get_entity_ld_ident(ent)
408 #define set_entity_ld_ident(ent, ld_ident) _set_entity_ld_ident(ent, ld_ident)
409 #define get_entity_ld_name(ent) _get_entity_ld_name(ent)
410 #define get_entity_type(ent) _get_entity_type(ent)
411 #define set_entity_type(ent, type) _set_entity_type(ent, type)
412 #define get_entity_linkage(ent) _get_entity_linkage(ent)
413 #define get_entity_volatility(ent) _get_entity_volatility(ent)
414 #define set_entity_volatility(ent, vol) _set_entity_volatility(ent, vol)
415 #define set_entity_alignment(ent, alignment) _set_entity_alignment(ent, alignment)
416 #define get_entity_alignment(ent) _get_entity_alignment(ent)
417 #define get_entity_align(ent) _get_entity_align(ent)
418 #define set_entity_align(ent, a) _set_entity_align(ent, a)
419 #define is_entity_compiler_generated(ent) _is_entity_compiler_generated(ent)
420 #define set_entity_compiler_generated(ent, flag) _set_entity_compiler_generated(ent, flag)
421 #define get_entity_usage(ent) _get_entity_usage(ent)
422 #define set_entity_usage(ent, flags) _set_entity_usage(ent, flags)
423 #define get_entity_offset(ent) _get_entity_offset(ent)
424 #define set_entity_offset(ent, offset) _set_entity_offset(ent, offset)
425 #define get_entity_offset_bits_remainder(ent) _get_entity_offset_bits_remainder(ent)
426 #define set_entity_offset_bits_remainder(ent, o) _set_entity_offset_bits_remainder(ent, o)
427 #define get_entity_link(ent) _get_entity_link(ent)
428 #define set_entity_link(ent, l) _set_entity_link(ent, l)
429 #define get_entity_irg(ent) _get_entity_irg(ent)
430 #define get_entity_visited(ent) _get_entity_visited(ent)
431 #define set_entity_visited(ent, num) _set_entity_visited(ent, num)
432 #define mark_entity_visited(ent) _mark_entity_visited(ent)
433 #define entity_visited(ent) _entity_visited(ent)
434 #define entity_not_visited(ent) _entity_not_visited(ent)
435 #define get_entity_repr_class(ent) _get_entity_repr_class(ent)
436 #define get_entity_dbg_info(ent) _get_entity_dbg_info(ent)
437 #define set_entity_dbg_info(ent, db) _set_entity_dbg_info(ent, db)