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
34 #include "compound_path.h"
36 typedef struct ir_initializer_base_t {
37 ir_initializer_kind_t kind;
38 } ir_initializer_base_t;
41 * An compound initializer.
43 typedef struct ir_initializer_compound_t {
44 ir_initializer_base_t base;
45 size_t n_initializers;
46 ir_initializer_t *initializers[1];
47 } ir_initializer_compound_t;
50 * An initializer containing an ir_node,
52 typedef struct ir_initializer_const_t {
53 ir_initializer_base_t base;
55 } ir_initializer_const_t ;
58 * An initializer containing a tarval.
60 typedef struct ir_initializer_tarval_t {
61 ir_initializer_base_t base;
63 } ir_initializer_tarval_t ;
65 union ir_initializer_t {
66 ir_initializer_kind_t kind;
67 ir_initializer_base_t base;
68 ir_initializer_compound_t compound;
69 ir_initializer_const_t consti;
70 ir_initializer_tarval_t tarval;
73 /** The attributes for compound entities. */
74 typedef struct compound_ent_attr {
75 ir_node **values; /**< constant values of compound entities. */
76 compound_graph_path **val_paths;
77 /**< paths corresponding to constant values. */
80 /** The attributes for methods. */
81 typedef struct method_ent_attr {
82 ir_graph *irg; /**< The corresponding irg if known.
83 The ir_graph constructor automatically sets this field. */
84 mtp_additional_properties irg_add_properties; /**< Additional graph properties can be
85 stored in a entity if no irg is available. */
87 unsigned vtable_number; /**< For a dynamically called method, the number assigned
88 in the virtual function table. */
90 ptr_access_kind *param_access; /**< the parameter access */
91 unsigned *param_weight; /**< The weight of method's parameters. Parameters
92 with a high weight are good candidates for procedure cloning. */
95 /** additional attributes for code entities */
96 typedef struct code_ent_attr {
97 ir_label_t label; /** label of the basic block */
100 typedef struct parameter_ent_attr {
101 /**< parameters might be compounds too */
102 compound_ent_attr cmpd_attr;
104 size_t number; /**< corresponding parameter number */
105 ir_mode *doubleword_low_mode;/**< entity is a lowered doubleword parameter,
106 so additional stores because of calling
107 convention are correctly performed.
108 Matze: This is a hack. In an ideal
109 wor^H^H^Hlibfirm we would first establish
110 calling conventions and then perform doubleword
112 } parameter_ent_attr;
114 typedef enum ir_entity_kind {
117 IR_ENTITY_COMPOUND_MEMBER,
123 * An abstract data type to represent program entities.
126 firm_kind kind; /**< The dynamic type tag for entity. */
127 ident *name; /**< The name of this entity. */
128 ident *ld_name; /**< Unique name of this entity, i.e., the mangled
129 name. May be NULL to indicate that a default
130 mangling based on the name should happen */
131 ir_type *type; /**< The type of this entity */
132 ir_type *owner; /**< The compound type (e.g. class type) this
133 entity belongs to. */
134 unsigned entity_kind:3; /**< entity kind */
135 unsigned linkage:10; /**< Specifies linkage type */
136 unsigned volatility:1; /**< Specifies volatility of entities content.*/
137 unsigned aligned:1; /**< Specifies alignment of entities content. */
138 unsigned usage:4; /**< flag indicating usage types of this entity,
139 see ir_entity_usage. */
140 unsigned compiler_gen:1; /**< If set, this entity was compiler generated.
142 unsigned visibility:3; /**< @deprecated */
143 unsigned allocation:3; /**< @deprecated */
144 unsigned peculiarity:3; /**< @deprecated */
145 unsigned final:1; /**< @deprecated */
146 unsigned offset_bit_remainder:8;
147 /**< If the entity is a bit field, this is the
148 offset of the start of the bit field
149 within the byte specified by offset. */
150 int offset; /**< Offset in bytes for this entity. Fixed
151 when layout of owner is determined. */
152 unsigned alignment; /**< entity alignment in bytes */
153 ir_visited_t visit; /**< visited counter for walks of the type
155 struct dbg_info *dbi; /**< A pointer to information for debug support. */
156 void *link; /**< To store some intermediate information. */
157 ir_type *repr_class; /**< If this entity represents a class info, the
160 ir_entity **overwrites; /**< A list of entities this entity overwrites. */
161 ir_entity **overwrittenby; /**< A list of entities that overwrite this
164 ir_initializer_t *initializer; /**< entity initializer */
166 long nr; /**< A unique node number for each node to make output
171 /* ------------- fields for compound entities -------------- */
172 compound_ent_attr cmpd_attr;
173 /* ------------- fields for method entities ---------------- */
174 method_ent_attr mtd_attr;
175 /* fields for code entities */
176 code_ent_attr code_attr;
177 /** parameter number for parameter entities */
178 parameter_ent_attr parameter;
179 } attr; /**< type specific attributes */
182 /** Initialize the entity module. */
183 void ir_init_entity(void);
184 /** Cleanup entity module */
185 void ir_finish_entity(void);
188 * Creates an entity corresponding to the start address of a basic block
189 * (the basic block is marked with a label id).
191 ir_entity *new_label_entity(ir_label_t label);
194 * Like new_label_entity() but with debug information.
196 ir_entity *new_d_label_entity(ir_label_t label, dbg_info *dbgi);
198 void set_entity_irg(ir_entity *ent, ir_graph *irg);
200 /* ----------------------- inline functions ------------------------ */
201 static inline int _is_entity(const void *thing)
203 return get_kind(thing) == k_entity;
206 static inline const char *_get_entity_name(const ir_entity *ent)
208 assert(ent && ent->kind == k_entity);
209 return get_id_str(get_entity_ident(ent));
212 static inline ident *_get_entity_ident(const ir_entity *ent)
214 assert(ent && ent->kind == k_entity);
218 static inline void _set_entity_ident(ir_entity *ent, ident *id)
220 assert(ent && ent->kind == k_entity);
224 static inline ir_type *_get_entity_owner(const ir_entity *ent)
226 assert(ent && ent->kind == k_entity);
230 static inline ident *_get_entity_ld_ident(const ir_entity *ent)
232 assert(ent && ent->kind == k_entity);
233 if (ent->ld_name == NULL)
238 static inline void _set_entity_ld_ident(ir_entity *ent, ident *ld_ident)
240 assert(ent && ent->kind == k_entity);
241 ent->ld_name = ld_ident;
244 static inline const char *_get_entity_ld_name(const ir_entity *ent)
246 assert(ent && ent->kind == k_entity);
247 return get_id_str(get_entity_ld_ident(ent));
250 static inline ir_type *_get_entity_type(const ir_entity *ent)
252 assert(ent && ent->kind == k_entity);
256 static inline ir_linkage _get_entity_linkage(const ir_entity *ent)
258 assert(ent && ent->kind == k_entity);
259 return (ir_linkage) ent->linkage;
262 static inline ir_volatility _get_entity_volatility(const ir_entity *ent)
264 assert(ent && ent->kind == k_entity);
265 return (ir_volatility) ent->volatility;
268 static inline void _set_entity_volatility(ir_entity *ent, ir_volatility vol)
270 assert(ent && ent->kind == k_entity);
271 ent->volatility = vol;
274 static inline unsigned _get_entity_alignment(const ir_entity *ent)
276 assert(ent && ent->kind == k_entity);
277 return ent->alignment;
280 static inline void _set_entity_alignment(ir_entity *ent, unsigned alignment)
282 assert(ent && ent->kind == k_entity);
283 ent->alignment = alignment;
286 static inline ir_align _get_entity_aligned(const ir_entity *ent)
288 assert(ent && ent->kind == k_entity);
289 return (ir_align) ent->aligned;
292 static inline void _set_entity_aligned(ir_entity *ent, ir_align a)
294 assert(ent && ent->kind == k_entity);
298 static inline int _is_entity_compiler_generated(const ir_entity *ent)
300 assert(ent && ent->kind == k_entity);
301 return ent->compiler_gen;
304 static inline void _set_entity_compiler_generated(ir_entity *ent, int flag)
306 assert(ent && ent->kind == k_entity);
307 ent->compiler_gen = flag ? 1 : 0;
310 static inline ir_entity_usage _get_entity_usage(const ir_entity *ent)
312 assert(ent && ent->kind == k_entity);
313 return (ir_entity_usage) ent->usage;
316 static inline void _set_entity_usage(ir_entity *ent, ir_entity_usage state)
318 assert(ent && ent->kind == k_entity);
322 static inline int _get_entity_offset(const ir_entity *ent)
324 assert(ent && ent->kind == k_entity);
328 static inline void _set_entity_offset(ir_entity *ent, int offset)
330 assert(ent && ent->kind == k_entity);
331 ent->offset = offset;
334 static inline unsigned char _get_entity_offset_bits_remainder(const ir_entity *ent)
336 assert(ent && ent->kind == k_entity);
337 return ent->offset_bit_remainder;
340 static inline void _set_entity_offset_bits_remainder(ir_entity *ent, unsigned char offset)
342 assert(ent && ent->kind == k_entity);
343 ent->offset_bit_remainder = offset;
346 static inline void *_get_entity_link(const ir_entity *ent)
348 assert(ent && ent->kind == k_entity);
352 static inline void _set_entity_link(ir_entity *ent, void *l)
354 assert(ent && ent->kind == k_entity);
358 static inline ir_graph *_get_entity_irg(const ir_entity *ent)
360 assert(ent && ent->kind == k_entity);
361 if (!is_Method_type(ent->type) || ent == unknown_entity) {
365 return ent->attr.mtd_attr.irg;
368 static inline ir_visited_t _get_entity_visited(const ir_entity *ent)
370 assert(ent && ent->kind == k_entity);
374 static inline void _set_entity_visited(ir_entity *ent, ir_visited_t num)
376 assert(ent && ent->kind == k_entity);
380 static inline void _mark_entity_visited(ir_entity *ent)
382 assert(ent && ent->kind == k_entity);
383 ent->visit = firm_type_visited;
386 static inline int _entity_visited(const ir_entity *ent)
388 return _get_entity_visited(ent) >= firm_type_visited;
391 static inline int _entity_not_visited(const ir_entity *ent)
393 return _get_entity_visited(ent) < firm_type_visited;
396 static inline int _is_parameter_entity(const ir_entity *entity)
398 return entity->entity_kind == IR_ENTITY_PARAMETER;
401 static inline size_t _get_entity_parameter_number(const ir_entity *entity)
403 assert(entity->entity_kind == IR_ENTITY_PARAMETER);
404 return entity->attr.parameter.number;
407 static inline ir_type *_get_entity_repr_class(const ir_entity *ent)
409 assert(ent && ent->kind == k_entity);
410 return ent->repr_class;
413 static inline dbg_info *_get_entity_dbg_info(const ir_entity *ent)
418 static inline void _set_entity_dbg_info(ir_entity *ent, dbg_info *db)
423 #define is_entity(thing) _is_entity(thing)
424 #define get_entity_name(ent) _get_entity_name(ent)
425 #define get_entity_ident(ent) _get_entity_ident(ent)
426 #define set_entity_ident(ent, id) _set_entity_ident(ent, id)
427 #define get_entity_owner(ent) _get_entity_owner(ent)
428 #define get_entity_ld_ident(ent) _get_entity_ld_ident(ent)
429 #define set_entity_ld_ident(ent, ld_ident) _set_entity_ld_ident(ent, ld_ident)
430 #define get_entity_ld_name(ent) _get_entity_ld_name(ent)
431 #define get_entity_type(ent) _get_entity_type(ent)
432 #define get_entity_linkage(ent) _get_entity_linkage(ent)
433 #define get_entity_volatility(ent) _get_entity_volatility(ent)
434 #define set_entity_volatility(ent, vol) _set_entity_volatility(ent, vol)
435 #define set_entity_alignment(ent, alignment) _set_entity_alignment(ent, alignment)
436 #define get_entity_alignment(ent) _get_entity_alignment(ent)
437 #define get_entity_align(ent) _get_entity_align(ent)
438 #define set_entity_align(ent, a) _set_entity_align(ent, a)
439 #define is_entity_compiler_generated(ent) _is_entity_compiler_generated(ent)
440 #define set_entity_compiler_generated(ent, flag) _set_entity_compiler_generated(ent, flag)
441 #define get_entity_usage(ent) _get_entity_usage(ent)
442 #define set_entity_usage(ent, flags) _set_entity_usage(ent, flags)
443 #define get_entity_offset(ent) _get_entity_offset(ent)
444 #define set_entity_offset(ent, offset) _set_entity_offset(ent, offset)
445 #define get_entity_offset_bits_remainder(ent) _get_entity_offset_bits_remainder(ent)
446 #define set_entity_offset_bits_remainder(ent, o) _set_entity_offset_bits_remainder(ent, o)
447 #define get_entity_link(ent) _get_entity_link(ent)
448 #define set_entity_link(ent, l) _set_entity_link(ent, l)
449 #define get_entity_irg(ent) _get_entity_irg(ent)
450 #define is_parameter_entity(ent) _is_parameter_entity(ent)
451 #define get_entity_parameter_number(ent) _get_entity_parameter_number(ent)
452 #define get_entity_visited(ent) _get_entity_visited(ent)
453 #define set_entity_visited(ent, num) _set_entity_visited(ent, num)
454 #define mark_entity_visited(ent) _mark_entity_visited(ent)
455 #define entity_visited(ent) _entity_visited(ent)
456 #define entity_not_visited(ent) _entity_not_visited(ent)
457 #define get_entity_repr_class(ent) _get_entity_repr_class(ent)
458 #define get_entity_dbg_info(ent) _get_entity_dbg_info(ent)
459 #define set_entity_dbg_info(ent, db) _set_entity_dbg_info(ent, db)