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 types -- private header.
23 * @author Goetz Lindenmaier, Michael Beck
25 * @see type.h tpop_t.h tpop.h
27 #ifndef FIRM_TR_TYPE_T_H
28 #define FIRM_TR_TYPE_T_H
34 #include "firm_common.h"
40 cf_none = 0, /**< No flags. */
41 cf_final_class = 1, /**< Set if a class is an final class */
42 cf_interface_class = 2, /**< Set if a class is an "interface" */
43 cf_absctract_class = 4, /**< Set if a class is "abstract" */
46 /** Class type attributes. */
48 ir_entity **members; /**< Array containing the fields and methods of this class. */
49 ir_type **subtypes; /**< Array containing the direct subtypes. */
50 ir_type **supertypes; /**< Array containing the direct supertypes */
51 ir_peculiarity peculiarity; /**< The peculiarity of this class. */
52 ir_entity *type_info; /**< An ir_entity representing this class, used for type info. */
53 int dfn; /**< A number that can be used for 'instanceof' operator. */
54 unsigned vtable_size; /**< The size of the vtable for this class. */
55 unsigned clss_flags; /**< Additional class flags. */
58 /** Struct type attributes. */
60 ir_entity **members; /**< Fields of this struct. No method entities allowed. */
63 /** A (type, ir_entity) pair. */
65 ir_type *tp; /**< A type. */
66 ir_entity *ent; /**< An ir_entity. */
69 /** Method type attributes. */
71 size_t n_params; /**< Number of parameters. */
72 tp_ent_pair *params; /**< Array of parameter type/value entities pairs. */
73 size_t n_res; /**< Number of results. */
74 tp_ent_pair *res_type; /**< Array of result type/value ir_entity pairs. */
75 ir_variadicity variadicity; /**< The variadicity of the method. */
76 mtp_additional_properties additional_properties; /**< Set of additional method properties. */
77 unsigned irg_calling_conv; /**< A set of calling convention flags. */
78 bool has_compound_ret_parameter : 1; /**< first parameter compound return address */
81 /** Union type attributes. */
83 ir_entity **members; /**< Fields of this union. No method entities allowed. */
86 /** Array type attributes. */
88 size_t n_dimensions; /**< Number of array dimensions. */
89 ir_node **lower_bound; /**< Lower bounds of dimensions. Usually all 0. */
90 ir_node **upper_bound; /**< Upper bounds or dimensions. */
91 size_t *order; /**< Ordering of dimensions. */
92 ir_type *element_type; /**< The type of the array elements. */
93 ir_entity *element_ent; /**< entity for the array elements, to be used for
94 element selection with a Sel node. */
97 /** An enumerator constant. */
98 struct ir_enum_const {
99 ir_tarval *value; /**< The constants that represents this enumerator identifier. */
100 ident *nameid; /**< The name of the enumerator identifier. */
101 ir_type *owner; /**< owner type of this enumerator constant. */
104 /** Enum type attributes. */
106 ir_enum_const *enumer; /**< Contains all enumerator constants that represent a member
107 of the enum -- enumerators. */
110 /** Pointer type attributes. */
112 ir_type *points_to; /**< The type of the ir_entity the pointer points to. */
115 /** Primitive type attributes. */
117 ir_type *base_type; /**< For bitfield types: The base primitive type, NULL else. */
120 /** General type attributes. */
122 cls_attr ca; /**< Attributes of a class type */
123 stc_attr sa; /**< Attributes of a struct type */
124 mtd_attr ma; /**< Attributes of a method type */
125 uni_attr ua; /**< Attributes of an union type */
126 arr_attr aa; /**< Attributes of an array type */
127 enm_attr ea; /**< Attributes of an enumeration type */
128 ptr_attr pa; /**< Attributes of a pointer type */
129 pri_attr ba; /**< Attributes of a primitive bitfield type */
132 /** Additional type flags. */
134 tf_none = 0, /**< No flags. */
135 tf_lowered_type = 1U << 0, /**< Set if this is a lowered type. */
136 tf_layout_fixed = 1U << 1, /**< Set if the layout of a type is fixed */
138 tf_frame_type = 1U << 2, /**< Set if this is a frame type. */
139 tf_global_type = 1U << 3, /**< Set only for the global type */
140 tf_tls_type = 1U << 4, /**< Set only for the tls type */
141 tf_constructors = 1U << 5, /**< Set only for the constructors segment type */
142 tf_destructors = 1U << 6, /**< Set only for the destructors segment type */
144 ENUM_BITSET(type_flags)
147 * An abstract data type to represent types.
149 * This is the abstract data type with which any type known in the
150 * compiled program can be represented. This includes types specified
151 * in the program as well as types defined by the language. In the
152 * view of the intermediate representation there is no difference
153 * between these types.
155 * There exist several kinds of types, arranged by the structure of
156 * the type. These are distinguished by a type opcode.
157 * A type is described by a set of attributes. Some of these attributes
158 * are common to all types, others depend on the kind of the type.
160 * The following describes the common attributes. They can only be
161 * accessed by the functions given below.
163 * The common fields are:
165 * - firm_kind: A firm_kind tag containing k_type. This is useful
166 * for dynamically checking whether a node is a type node.
167 * - type_op: A tp_op specifying the kind of the type.
168 * - name: An identifier specifying the name of the type. To be
169 * set by the frontend.
170 * - size: The size of the type, i.e. an entity of this type will
171 * occupy size bits in memory. In several cases this is
172 * determined when fixing the layout of this type (class,
173 * struct, union, array, enumeration).
174 * - alignment The alignment of the type, i.e. an entity of this type will
175 * be allocated an an address in memory with this alignment.
176 * In several cases this is determined when fixing the layout
177 * of this type (class, struct, union, array)
178 * - mode: The mode to be used to represent the type on a machine.
179 * - state: The state of the type. The state represents whether the
180 * layout of the type is undefined or fixed (values: layout_undefined
181 * or layout_fixed). Compound types can have an undefined
182 * layout. The layout of the basic types primitive and pointer
183 * is always layout_fixed. If the layout of
184 * compound types is fixed all entities must have an offset
185 * and the size of the type must be set.
186 * A fixed layout for enumeration types means that each enumeration
187 * is associated with an implementation value.
188 * - assoc_type: The associated lowered/upper type.
189 * - visit: A counter for walks of the type information.
190 * - link: A void* to associate some additional information with the type.
192 * These fields can only be accessed via access functions.
194 * Depending on the value of @c type_op, i.e., depending on the kind of the
195 * type the adt contains further attributes. These are documented below.
199 * @link class_type class @endlink, @link struct_type struct @endlink,
200 * @link method_type method @endlink, @link union_type union @endlink,
201 * @link array_type array @endlink, @link enumeration_type enumeration @endlink,
202 * @link pointer_type pointer @endlink, @link primitive_type primitive @endlink
205 * mode maybe not global field??
208 firm_kind kind; /**< the firm kind, must be k_type */
209 const tp_op *type_op; /**< the type operation of the type */
210 ident *name; /**< The name of the type */
211 ir_visibility visibility;/**< Visibility of entities of this type. */
212 unsigned flags; /**< Type flags, a bitmask of enum type_flags. */
213 unsigned size; /**< Size of an ir_entity of this type. This is determined
214 when fixing the layout of this class. Size must be
216 unsigned align; /**< Alignment of an ir_entity of this type. This should be
217 set according to the source language needs. If not set, it's
218 calculated automatically by get_type_alignment().
219 Alignment must be given in bytes. */
220 ir_mode *mode; /**< The mode for atomic types */
221 ir_visited_t visit; /**< visited counter for walks of the type information */
222 void *link; /**< holds temporary data - like in irnode_t.h */
223 type_dbg_info *dbi; /**< A pointer to information for debug support. */
224 ir_type *assoc_type; /**< The associated lowered/unlowered type */
226 /* ------------- fields for analyses ---------------*/
229 long nr; /**< An unique node number for each node to make output
232 tp_attr attr; /**< Type kind specific fields. This must be the last
233 entry in this struct! Varying size! */
237 * Creates a new type representation:
239 * @param type_op the kind of this type. May not be type_id.
240 * @param mode the mode to be used for this type, may be NULL
241 * @param db debug info
243 * @return A new type of the given type. The remaining private attributes are not
244 * initialized. The type is in state layout_undefined.
246 ir_type *new_type(const tp_op *type_op, ir_mode *mode, type_dbg_info *db);
247 void free_type_attrs(ir_type *tp);
249 void free_class_entities (ir_type *clss);
250 void free_struct_entities (ir_type *strct);
251 void free_method_entities (ir_type *method);
252 void free_union_entities (ir_type *uni);
253 void free_array_entities (ir_type *array);
254 void free_enumeration_entities(ir_type *enumeration);
255 void free_pointer_entities (ir_type *pointer);
257 void free_array_automatic_entities(ir_type *array);
259 void free_class_attrs (ir_type *clss);
260 void free_struct_attrs (ir_type *strct);
261 void free_method_attrs (ir_type *method);
262 void free_union_attrs (ir_type *uni);
263 void free_array_attrs (ir_type *array);
264 void free_enumeration_attrs(ir_type *enumeration);
265 void free_pointer_attrs (ir_type *pointer);
267 void set_class_mode(ir_type *tp, ir_mode *mode);
268 void set_struct_mode(ir_type *tp, ir_mode *mode);
269 void set_pointer_mode(ir_type *tp, ir_mode *mode);
270 void set_primitive_mode(ir_type *tp, ir_mode *mode);
271 void set_enumeration_mode(ir_type *tp, ir_mode *mode);
273 void set_class_size(ir_type *tp, unsigned bytes);
274 void set_struct_size(ir_type *tp, unsigned bytes);
275 void set_union_size(ir_type *tp, unsigned bytes);
276 void set_array_size(ir_type *tp, unsigned bytes);
277 void set_default_size(ir_type *tp, unsigned bytes);
279 /** Set and get a class' dfn --
280 * This is an undocumented field, subject to change! */
281 void set_class_dfn(ir_type *clss, int dfn);
282 int get_class_dfn(const ir_type *clss);
284 void add_compound_member(ir_type *compound, ir_entity *entity);
286 /** Initialize the type module. */
287 void ir_init_type(void);
289 /** free internal datastructures of type module */
290 void ir_finish_type(void);
292 /** Clone an existing method type.
294 * @param tp the method type to clone.
295 * @param prefix if non-null, will be the prefix for the name of
298 * @return the cloned method type.
300 ir_type *clone_type_method(ir_type *tp);
302 /* ------------------- *
304 * ------------------- */
306 extern ir_visited_t firm_type_visited;
308 static inline void _set_master_type_visited(ir_visited_t val) { firm_type_visited = val; }
309 static inline ir_visited_t _get_master_type_visited(void) { return firm_type_visited; }
310 static inline void _inc_master_type_visited(void) { ++firm_type_visited; }
312 static inline int is_lowered_type(const ir_type *tp)
314 return tp->flags & tf_lowered_type;
318 * Gets the lowered/unlowered type of a type or NULL if this type
319 * has no lowered/unlowered one.
321 static inline ir_type *get_associated_type(const ir_type *tp)
323 return tp->assoc_type;
326 static inline void set_lowered_type(ir_type *tp, ir_type *lowered_type)
328 assert (is_type(tp) && is_type(lowered_type));
329 lowered_type->flags |= tf_lowered_type;
330 tp->assoc_type = lowered_type;
331 lowered_type->assoc_type = tp;
334 static inline void *_get_type_link(const ir_type *tp)
336 assert(tp && tp->kind == k_type);
340 static inline void _set_type_link(ir_type *tp, void *l)
342 assert(tp && tp->kind == k_type);
346 static inline const tp_op *_get_type_tpop(const ir_type *tp)
348 assert(tp && tp->kind == k_type);
352 static inline ident *_get_type_tpop_nameid(const ir_type *tp)
354 assert(tp && tp->kind == k_type);
355 return get_tpop_ident(tp->type_op);
358 static inline tp_opcode _get_type_tpop_code(const ir_type *tp)
360 assert(tp && tp->kind == k_type);
361 return get_tpop_code(tp->type_op);
364 static inline ir_mode *_get_type_mode(const ir_type *tp)
366 assert(tp && tp->kind == k_type);
370 static inline unsigned _get_type_size_bytes(const ir_type *tp)
372 assert(tp && tp->kind == k_type);
376 static inline ir_type_state _get_type_state(const ir_type *tp)
378 assert(tp && tp->kind == k_type);
379 return tp->flags & tf_layout_fixed ? layout_fixed : layout_undefined;
382 static inline ir_visited_t _get_type_visited(const ir_type *tp)
384 assert(tp && tp->kind == k_type);
388 static inline void _set_type_visited(ir_type *tp, ir_visited_t num)
390 assert(tp && tp->kind == k_type);
394 static inline void _mark_type_visited(ir_type *tp)
396 assert(tp && tp->kind == k_type);
397 assert(tp->visit < firm_type_visited);
398 tp->visit = firm_type_visited;
401 static inline int _type_visited(const ir_type *tp)
403 assert(tp && tp->kind == k_type);
404 return tp->visit >= firm_type_visited;
407 static inline int _type_not_visited(const ir_type *tp)
409 assert(tp && tp->kind == k_type);
410 return tp->visit < firm_type_visited;
413 static inline type_dbg_info *_get_type_dbg_info(const ir_type *tp)
418 static inline void _set_type_dbg_info(ir_type *tp, type_dbg_info *db)
423 static inline int _is_type(const void *thing)
425 return get_kind(thing) == k_type;
428 static inline int _is_class_type(const ir_type *clss)
430 return clss->type_op == type_class;
433 static inline size_t _get_class_n_members(const ir_type *clss)
435 assert(clss->type_op == type_class);
436 return ARR_LEN(clss->attr.ca.members);
439 static inline ir_entity *_get_class_member(const ir_type *clss, size_t pos)
441 assert(clss->type_op == type_class);
442 assert(pos < _get_class_n_members(clss));
443 return clss->attr.ca.members[pos];
446 static inline unsigned _get_class_vtable_size(const ir_type *clss)
448 assert(clss->type_op == type_class);
449 return clss->attr.ca.vtable_size;
452 static inline void _set_class_vtable_size(ir_type *clss, unsigned vtable_size)
454 assert(clss->type_op == type_class);
455 clss->attr.ca.vtable_size = vtable_size;
458 static inline int _is_class_final(const ir_type *clss)
460 assert(clss->type_op == type_class);
461 return clss->attr.ca.clss_flags & cf_final_class;
464 static inline void _set_class_final(ir_type *clss, int final)
466 assert(clss->type_op == type_class);
468 clss->attr.ca.clss_flags |= cf_final_class;
470 clss->attr.ca.clss_flags &= ~cf_final_class;
473 static inline int _is_class_interface(const ir_type *clss)
475 assert(clss->type_op == type_class);
476 return clss->attr.ca.clss_flags & cf_interface_class;
479 static inline void _set_class_interface(ir_type *clss, int final)
481 assert(clss->type_op == type_class);
483 clss->attr.ca.clss_flags |= cf_interface_class;
485 clss->attr.ca.clss_flags &= ~cf_interface_class;
488 static inline int _is_class_abstract(const ir_type *clss)
490 assert(clss->type_op == type_class);
491 return clss->attr.ca.clss_flags & cf_absctract_class;
494 static inline void _set_class_abstract(ir_type *clss, int final)
496 assert(clss->type_op == type_class);
498 clss->attr.ca.clss_flags |= cf_absctract_class;
500 clss->attr.ca.clss_flags &= ~cf_absctract_class;
503 static inline int _is_struct_type(const ir_type *strct)
505 return (strct->type_op == type_struct);
508 static inline int _is_method_type(const ir_type *method)
510 return (method->type_op == type_method);
513 static inline int _is_union_type(const ir_type *uni)
515 return (uni->type_op == type_union);
518 static inline int _is_array_type(const ir_type *array)
520 return (array->type_op == type_array);
523 static inline int _is_enumeration_type(const ir_type *enumeration)
525 return (enumeration->type_op == type_enumeration);
528 static inline int _is_pointer_type(const ir_type *pointer)
530 return (pointer->type_op == type_pointer);
533 /** Returns true if a type is a primitive type. */
534 static inline int _is_primitive_type(const ir_type *primitive)
536 assert(primitive->kind == k_type);
537 return (primitive->type_op == type_primitive);
540 static inline int _is_atomic_type(const ir_type *tp)
542 assert(tp->kind == k_type);
543 return (_is_primitive_type(tp) || _is_pointer_type(tp) ||
544 _is_enumeration_type(tp));
547 static inline size_t _get_method_n_params(const ir_type *method)
549 assert(method->type_op == type_method);
550 return method->attr.ma.n_params;
553 static inline size_t _get_method_n_ress(const ir_type *method)
555 assert(method->type_op == type_method);
556 return method->attr.ma.n_res;
559 static inline mtp_additional_properties _get_method_additional_properties(const ir_type *method)
561 assert(method->type_op == type_method);
562 return method->attr.ma.additional_properties;
565 static inline void _set_method_additional_properties(ir_type *method, mtp_additional_properties mask)
567 assert(method->type_op == type_method);
569 /* do not allow to set the mtp_property_inherited flag or
570 * the automatic inheritance of flags will not work */
571 method->attr.ma.additional_properties = mask & ~mtp_property_inherited;
574 static inline void _add_method_additional_properties(ir_type *method, mtp_additional_properties flag)
576 assert(method->type_op == type_method);
578 /* do not allow to set the mtp_property_inherited flag or
579 * the automatic inheritance of flags will not work */
580 method->attr.ma.additional_properties |= flag & ~mtp_property_inherited;
583 static inline unsigned _get_method_calling_convention(const ir_type *method)
585 assert(method->type_op == type_method);
586 return method->attr.ma.irg_calling_conv;
589 static inline void _set_method_calling_convention(ir_type *method, unsigned cc_mask)
591 assert(method->type_op == type_method);
592 method->attr.ma.irg_calling_conv = cc_mask;
596 #define set_master_type_visited(val) _set_master_type_visited(val)
597 #define get_master_type_visited() _get_master_type_visited()
598 #define inc_master_type_visited() _inc_master_type_visited()
599 #define get_type_link(tp) _get_type_link(tp)
600 #define set_type_link(tp, l) _set_type_link(tp, l)
601 #define get_type_tpop(tp) _get_type_tpop(tp)
602 #define get_type_tpop_nameid(tp) _get_type_tpop_nameid(tp)
603 #define get_type_tpop_code(tp) _get_type_tpop_code(tp)
604 #define get_type_mode(tp) _get_type_mode(tp)
605 #define get_type_size_bytes(tp) _get_type_size_bytes(tp)
606 #define get_type_state(tp) _get_type_state(tp)
607 #define get_type_visited(tp) _get_type_visited(tp)
608 #define set_type_visited(tp, num) _set_type_visited(tp, num)
609 #define mark_type_visited(tp) _mark_type_visited(tp)
610 #define type_visited(tp) _type_visited(tp)
611 #define type_not_visited(tp) _type_not_visited(tp)
612 #define get_type_dbg_info(tp) _get_type_dbg_info(tp)
613 #define set_type_dbg_info(tp, db) _set_type_dbg_info(tp, db)
614 #define is_type(thing) _is_type(thing)
615 #define is_Class_type(clss) _is_class_type(clss)
616 #define get_class_n_members(clss) _get_class_n_members(clss)
617 #define get_class_member(clss, pos) _get_class_member(clss, pos)
618 #define get_class_vtable_size(clss) _get_class_vtable_size(clss)
619 #define set_class_vtable_size(clss, size) _set_class_vtable_size(clss, size)
620 #define is_class_final(clss) _is_class_final(clss)
621 #define set_class_final(clss, flag) _set_class_final(clss, flag)
622 #define is_class_interface(clss) _is_class_interface(clss)
623 #define set_class_interface(clss, flag) _set_class_interface(clss, flag)
624 #define is_class_abstract(clss) _is_class_abstract(clss)
625 #define set_class_abstract(clss, flag) _set_class_abstract(clss, flag)
626 #define is_Struct_type(strct) _is_struct_type(strct)
627 #define is_Method_type(method) _is_method_type(method)
628 #define is_Union_type(uni) _is_union_type(uni)
629 #define is_Array_type(array) _is_array_type(array)
630 #define is_Enumeration_type(enumeration) _is_enumeration_type(enumeration)
631 #define is_Pointer_type(pointer) _is_pointer_type(pointer)
632 #define is_Primitive_type(primitive) _is_primitive_type(primitive)
633 #define is_atomic_type(tp) _is_atomic_type(tp)
634 #define get_method_n_params(method) _get_method_n_params(method)
635 #define get_method_n_ress(method) _get_method_n_ress(method)
636 #define get_method_additional_properties(method) _get_method_additional_properties(method)
637 #define set_method_additional_properties(method, mask) _set_method_additional_properties(method, mask)
638 #define add_method_additional_properties(method, flag) _add_method_additional_properties(method, flag)
639 #define get_method_calling_convention(method) _get_method_calling_convention(method)
640 #define set_method_calling_convention(method, cc_mask) _set_method_calling_convention(method, cc_mask)
642 #endif /* FIRM_TR_TYPE_T_H */