2 * Copyright (C) 1995-2011 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
25 #ifndef FIRM_TR_ENTITY_T_H
26 #define FIRM_TR_ENTITY_T_H
35 #define is_entity(thing) _is_entity(thing)
36 #define get_entity_name(ent) _get_entity_name(ent)
37 #define get_entity_ident(ent) _get_entity_ident(ent)
38 #define set_entity_ident(ent, id) _set_entity_ident(ent, id)
39 #define get_entity_owner(ent) _get_entity_owner(ent)
40 #define get_entity_ld_ident(ent) _get_entity_ld_ident(ent)
41 #define set_entity_ld_ident(ent, ld_ident) _set_entity_ld_ident(ent, ld_ident)
42 #define get_entity_ld_name(ent) _get_entity_ld_name(ent)
43 #define get_entity_type(ent) _get_entity_type(ent)
44 #define get_entity_linkage(ent) _get_entity_linkage(ent)
45 #define get_entity_volatility(ent) _get_entity_volatility(ent)
46 #define set_entity_volatility(ent, vol) _set_entity_volatility(ent, vol)
47 #define set_entity_alignment(ent, alignment) _set_entity_alignment(ent, alignment)
48 #define get_entity_alignment(ent) _get_entity_alignment(ent)
49 #define get_entity_align(ent) _get_entity_align(ent)
50 #define set_entity_align(ent, a) _set_entity_align(ent, a)
51 #define is_entity_compiler_generated(ent) _is_entity_compiler_generated(ent)
52 #define set_entity_compiler_generated(ent, flag) _set_entity_compiler_generated(ent, flag)
53 #define get_entity_usage(ent) _get_entity_usage(ent)
54 #define set_entity_usage(ent, flags) _set_entity_usage(ent, flags)
55 #define get_entity_offset(ent) _get_entity_offset(ent)
56 #define set_entity_offset(ent, offset) _set_entity_offset(ent, offset)
57 #define get_entity_offset_bits_remainder(ent) _get_entity_offset_bits_remainder(ent)
58 #define set_entity_offset_bits_remainder(ent, o) _set_entity_offset_bits_remainder(ent, o)
59 #define get_entity_link(ent) _get_entity_link(ent)
60 #define set_entity_link(ent, l) _set_entity_link(ent, l)
61 #define get_entity_irg(ent) _get_entity_irg(ent)
62 #define is_parameter_entity(ent) _is_parameter_entity(ent)
63 #define get_entity_parameter_number(ent) _get_entity_parameter_number(ent)
64 #define get_entity_visited(ent) _get_entity_visited(ent)
65 #define set_entity_visited(ent, num) _set_entity_visited(ent, num)
66 #define mark_entity_visited(ent) _mark_entity_visited(ent)
67 #define entity_visited(ent) _entity_visited(ent)
68 #define entity_not_visited(ent) _entity_not_visited(ent)
69 #define get_entity_dbg_info(ent) _get_entity_dbg_info(ent)
70 #define set_entity_dbg_info(ent, db) _set_entity_dbg_info(ent, db)
72 typedef struct ir_initializer_base_t {
73 ir_initializer_kind_t kind;
74 } ir_initializer_base_t;
77 * An compound initializer.
79 typedef struct ir_initializer_compound_t {
80 ir_initializer_base_t base;
81 size_t n_initializers;
82 ir_initializer_t *initializers[1];
83 } ir_initializer_compound_t;
86 * An initializer containing an ir_node,
88 typedef struct ir_initializer_const_t {
89 ir_initializer_base_t base;
91 } ir_initializer_const_t ;
94 * An initializer containing a tarval.
96 typedef struct ir_initializer_tarval_t {
97 ir_initializer_base_t base;
99 } ir_initializer_tarval_t ;
101 union ir_initializer_t {
102 ir_initializer_kind_t kind;
103 ir_initializer_base_t base;
104 ir_initializer_compound_t compound;
105 ir_initializer_const_t consti;
106 ir_initializer_tarval_t tarval;
109 /** The attributes for methods. */
110 typedef struct method_ent_attr {
111 ir_graph *irg; /**< The corresponding irg if known.
112 The ir_graph constructor automatically sets this field. */
113 mtp_additional_properties properties; /**< Additional graph properties can be
114 stored in a entity if no irg is available. */
116 unsigned vtable_number; /**< For a dynamically called method, the number assigned
117 in the virtual function table. */
119 ptr_access_kind *param_access; /**< the parameter access */
120 unsigned *param_weight; /**< The weight of method's parameters. Parameters
121 with a high weight are good candidates for procedure cloning. */
124 /** additional attributes for code entities */
125 typedef struct code_ent_attr {
126 ir_label_t label; /** label of the basic block */
129 typedef struct parameter_ent_attr {
130 size_t number; /**< corresponding parameter number */
131 ir_mode *doubleword_low_mode;/**< entity is a lowered doubleword parameter,
132 so additional stores because of calling
133 convention are correctly performed.
134 Matze: This is a hack. In an ideal
135 wor^H^H^Hlibfirm we would first establish
136 calling conventions and then perform doubleword
138 } parameter_ent_attr;
140 typedef enum ir_entity_kind {
143 IR_ENTITY_COMPOUND_MEMBER,
150 * An abstract data type to represent program entities.
153 firm_kind kind; /**< The dynamic type tag for entity. */
154 ident *name; /**< The name of this entity. */
155 ident *ld_name; /**< Unique name of this entity, i.e., the mangled
156 name. May be NULL to indicate that a default
157 mangling based on the name should happen */
158 ir_type *type; /**< The type of this entity */
159 ir_type *owner; /**< The compound type (e.g. class type) this
160 entity belongs to. */
161 unsigned entity_kind:3; /**< entity kind */
162 unsigned linkage:10; /**< Specifies linkage type */
163 unsigned volatility:1; /**< Specifies volatility of entities content.*/
164 unsigned aligned:1; /**< Specifies alignment of entities content. */
165 unsigned usage:4; /**< flag indicating usage types of this entity,
166 see ir_entity_usage. */
167 unsigned compiler_gen:1; /**< If set, this entity was compiler generated.
169 unsigned visibility:3; /**< @deprecated */
170 unsigned allocation:3; /**< @deprecated */
171 unsigned peculiarity:3; /**< @deprecated */
172 unsigned final:1; /**< @deprecated */
173 unsigned offset_bit_remainder:8;
174 /**< If the entity is a bit field, this is the
175 offset of the start of the bit field
176 within the byte specified by offset. */
177 int offset; /**< Offset in bytes for this entity. Fixed
178 when layout of owner is determined. */
179 unsigned alignment; /**< entity alignment in bytes */
180 ir_visited_t visit; /**< visited counter for walks of the type
182 struct dbg_info *dbi; /**< A pointer to information for debug support. */
183 void *link; /**< To store some intermediate information. */
185 ir_entity **overwrites; /**< A list of entities this entity overwrites. */
186 ir_entity **overwrittenby; /**< A list of entities that overwrite this
189 ir_initializer_t *initializer; /**< entity initializer */
191 long nr; /**< A unique node number for each node to make output
196 /* ------------- fields for method entities ---------------- */
197 method_ent_attr mtd_attr;
198 /* fields for code entities */
199 code_ent_attr code_attr;
200 /** parameter number for parameter entities */
201 parameter_ent_attr parameter;
202 } attr; /**< type specific attributes */
205 /** Initialize the entity module. */
206 void ir_init_entity(ir_prog *irp);
207 /** Cleanup entity module */
208 void ir_finish_entity(ir_prog *irp);
211 * Creates an entity corresponding to the start address of a basic block
212 * (the basic block is marked with a label id).
214 ir_entity *new_label_entity(ir_label_t label);
217 * Like new_label_entity() but with debug information.
219 ir_entity *new_d_label_entity(ir_label_t label, dbg_info *dbgi);
221 void set_entity_irg(ir_entity *ent, ir_graph *irg);
223 /* ----------------------- inline functions ------------------------ */
224 static inline int _is_entity(const void *thing)
226 return get_kind(thing) == k_entity;
229 static inline ident *_get_entity_ident(const ir_entity *ent)
231 assert(ent->kind == k_entity);
235 static inline const char *_get_entity_name(const ir_entity *ent)
237 assert(ent->kind == k_entity);
238 return get_id_str(get_entity_ident(ent));
241 static inline void _set_entity_ident(ir_entity *ent, ident *id)
243 assert(ent->kind == k_entity);
247 static inline ir_type *_get_entity_owner(const ir_entity *ent)
249 assert(ent->kind == k_entity);
253 static inline ident *_get_entity_ld_ident(const ir_entity *ent)
255 assert(ent->kind == k_entity);
256 if (ent->ld_name == NULL)
261 static inline void _set_entity_ld_ident(ir_entity *ent, ident *ld_ident)
263 assert(ent->kind == k_entity);
264 ent->ld_name = ld_ident;
267 static inline const char *_get_entity_ld_name(const ir_entity *ent)
269 assert(ent->kind == k_entity);
270 return get_id_str(get_entity_ld_ident(ent));
273 static inline ir_type *_get_entity_type(const ir_entity *ent)
275 assert(ent->kind == k_entity);
279 static inline ir_linkage _get_entity_linkage(const ir_entity *ent)
281 assert(ent->kind == k_entity);
282 return (ir_linkage) ent->linkage;
285 static inline ir_volatility _get_entity_volatility(const ir_entity *ent)
287 assert(ent->kind == k_entity);
288 return (ir_volatility) ent->volatility;
291 static inline void _set_entity_volatility(ir_entity *ent, ir_volatility vol)
293 assert(ent->kind == k_entity);
294 ent->volatility = vol;
297 static inline unsigned _get_entity_alignment(const ir_entity *ent)
299 assert(ent->kind == k_entity);
300 return ent->alignment;
303 static inline void _set_entity_alignment(ir_entity *ent, unsigned alignment)
305 assert(ent->kind == k_entity);
306 ent->alignment = alignment;
309 static inline ir_align _get_entity_aligned(const ir_entity *ent)
311 assert(ent->kind == k_entity);
312 return (ir_align) ent->aligned;
315 static inline void _set_entity_aligned(ir_entity *ent, ir_align a)
317 assert(ent->kind == k_entity);
321 static inline int _is_entity_compiler_generated(const ir_entity *ent)
323 assert(ent->kind == k_entity);
324 return ent->compiler_gen;
327 static inline void _set_entity_compiler_generated(ir_entity *ent, int flag)
329 assert(ent->kind == k_entity);
330 ent->compiler_gen = flag ? 1 : 0;
333 static inline ir_entity_usage _get_entity_usage(const ir_entity *ent)
335 assert(ent->kind == k_entity);
336 return (ir_entity_usage) ent->usage;
339 static inline void _set_entity_usage(ir_entity *ent, ir_entity_usage state)
341 assert(ent->kind == k_entity);
345 static inline int _get_entity_offset(const ir_entity *ent)
347 assert(ent->kind == k_entity);
351 static inline void _set_entity_offset(ir_entity *ent, int offset)
353 assert(ent->kind == k_entity);
354 ent->offset = offset;
357 static inline unsigned char _get_entity_offset_bits_remainder(const ir_entity *ent)
359 assert(ent->kind == k_entity);
360 return ent->offset_bit_remainder;
363 static inline void _set_entity_offset_bits_remainder(ir_entity *ent, unsigned char offset)
365 assert(ent->kind == k_entity);
366 ent->offset_bit_remainder = offset;
369 static inline void *_get_entity_link(const ir_entity *ent)
371 assert(ent->kind == k_entity);
375 static inline void _set_entity_link(ir_entity *ent, void *l)
377 assert(ent->kind == k_entity);
381 static inline ir_graph *_get_entity_irg(const ir_entity *ent)
383 assert(ent->kind == k_entity);
384 if (!is_Method_type(ent->type) || is_unknown_entity(ent)) {
388 return ent->attr.mtd_attr.irg;
391 static inline ir_visited_t _get_entity_visited(const ir_entity *ent)
393 assert(ent->kind == k_entity);
397 static inline void _set_entity_visited(ir_entity *ent, ir_visited_t num)
399 assert(ent->kind == k_entity);
403 static inline void _mark_entity_visited(ir_entity *ent)
405 assert(ent->kind == k_entity);
406 ent->visit = firm_type_visited;
409 static inline int _entity_visited(const ir_entity *ent)
411 return _get_entity_visited(ent) >= firm_type_visited;
414 static inline int _entity_not_visited(const ir_entity *ent)
416 return _get_entity_visited(ent) < firm_type_visited;
419 static inline int _is_parameter_entity(const ir_entity *entity)
421 return entity->entity_kind == IR_ENTITY_PARAMETER;
424 static inline size_t _get_entity_parameter_number(const ir_entity *entity)
426 assert(entity->entity_kind == IR_ENTITY_PARAMETER);
427 return entity->attr.parameter.number;
430 static inline dbg_info *_get_entity_dbg_info(const ir_entity *ent)
435 static inline void _set_entity_dbg_info(ir_entity *ent, dbg_info *db)