3 * File name: ir/tr/type_t.h
4 * Purpose: Representation of types -- private header.
5 * Author: Goetz Lindenmaier
9 * Copyright: (c) 2001-2003 Universität Karlsruhe
10 * Licence: This file protected by GPL - GNU GENERAL PUBLIC LICENSE.
16 # include "firm_config.h"
24 * This file contains the datatypes hidden in type.h.
26 * @author Goetz Lindenmaier
27 * @see type.h tpop_t.h tpop.h
30 /** class attributes */
32 entity **members; /**< fields and methods of this class */
33 type **subtypes; /**< direct subtypes */
34 type **supertypes; /**< direct supertypes */
35 peculiarity peculiarity;
36 int dfn; /**< number used for 'instanceof' operator */
39 /** struct attributs */
41 entity **members; /**< fields of this struct. No method entities
45 /** method attributes */
47 int n_params; /**< number of parameters */
48 type **param_type; /**< code generation needs this information. */
49 type *value_params; /**< A type whose entities represent copied value arguments. */
50 int n_res; /**< number of results */
51 type **res_type; /**< array with result types */
52 type *value_ress; /**< A type whose entities represent copied value results. */
53 variadicity variadicity; /**< variadicity of the method. */
54 int first_variadic_param; /**< index of the first variadic param or -1 if non-variadic .*/
57 /** union attributs */
60 /* type **unioned_type; * a list of unioned types. */
61 /* ident **delim_names; * names of the union delimiters. */
62 entity **members; /**< fields of this union. No method entities
67 /** array attributs */
69 int n_dimensions; /**< Number of array dimensions. */
70 ir_node **lower_bound; /**< Lower bounds of dimensions. Usually all 0. */
71 ir_node **upper_bound; /**< Upper bounds or dimensions. */
72 int *order; /**< Ordering of dimensions. */
73 type *element_type; /**< The type of the array elements. */
74 entity *element_ent; /**< Entity for the array elements, to be used for
75 element selection with Sel. */
80 int n_enums; /**< Number of enumerators. */
81 tarval **enumer; /**< Contains all constants that represent a member
82 of the enum -- enumerators. */
83 ident **enum_nameid;/**< Contains the names of the enum fields as specified by
87 /** pointer attributs */
89 type *points_to; /**< The type of the enitity the pointer points to. */
93 typedef struct { * No private attr yet! *
98 typedef struct { * No private attr, must be smaller than others! *
102 /** General type attributs. */
104 cls_attr ca; /**< attributes of a class type */
105 stc_attr sa; /**< attributes of a struct type */
106 mtd_attr ma; /**< attributes of a method type */
107 uni_attr ua; /**< attributes of an union type */
108 arr_attr aa; /**< attributes of an array type */
109 enm_attr ea; /**< attributes of an enumeration type */
110 ptr_attr pa; /**< attributes of a pointer type */
113 /** the structure of a type */
115 firm_kind kind; /**< the firm kind, must be k_type */
116 const tp_op *type_op; /**< the type operation of the type */
117 ident *name; /**< The name of the type */
118 type_state state; /**< Represents the types state: layout undefined or
120 int size; /**< Size of an entity of this type. This is determined
121 when fixing the layout of this class. Size must be
123 int align; /**< Alignment of an entity of this type. This should be
124 set according to the source language needs. If not set it's
125 calculated automatically by get_type_alignment().
126 Alignment must be given in bits. */
127 ir_mode *mode; /**< The mode for atomic types */
128 unsigned long visit; /**< visited counter for walks of the type information */
129 void *link; /**< holds temporary data - like in irnode_t.h */
130 struct dbg_info* dbi; /**< A pointer to information for debug support. */
132 /* ------------- fields for analyses ---------------*/
135 int nr; /**< a unique node number for each node to make output
138 tp_attr attr; /* type kind specific fields. This must be the last
139 entry in this struct! Varying size! */
143 * Creates a new type representation:
145 * @param type_op - the kind of this type. May not be type_id.
146 * @param mode - the mode to be used for this type, may be NULL
147 * @param name - an ident for the name of this type.
149 * @return A new type of the given type. The remaining private attributes are not
150 * initialized. The type is in state layout_undefined.
153 new_type(tp_op *type_op,
156 void free_type_attrs (type *tp);
158 INLINE void free_class_entities (type *clss);
159 INLINE void free_struct_entities (type *strct);
160 INLINE void free_method_entities (type *method);
161 INLINE void free_union_entities (type *uni);
162 INLINE void free_array_entities (type *array);
163 INLINE void free_enumeration_entities(type *enumeration);
164 INLINE void free_pointer_entities (type *pointer);
165 INLINE void free_primitive_entities (type *primitive);
167 INLINE void free_class_attrs (type *clss);
168 INLINE void free_struct_attrs (type *strct);
169 INLINE void free_method_attrs (type *method);
170 INLINE void free_union_attrs (type *uni);
171 INLINE void free_array_attrs (type *array);
172 INLINE void free_enumeration_attrs(type *enumeration);
173 INLINE void free_pointer_attrs (type *pointer);
174 INLINE void free_primitive_attrs (type *primitive);
177 /** initialize the type module */
178 void init_type (void);
181 /* ------------------- *
183 * ------------------- */
185 extern unsigned long type_visited;
187 static INLINE void _set_master_type_visited(unsigned long val) { type_visited = val; }
188 static INLINE unsigned long _get_master_type_visited(void) { return type_visited; }
189 static INLINE void _inc_master_type_visited(void) { type_visited++; }
192 _get_type_link(const type *tp) {
193 assert(tp && tp->kind == k_type);
198 _set_type_link(type *tp, void *l) {
199 assert(tp && tp->kind == k_type);
203 static INLINE const tp_op*
204 _get_type_tpop(const type *tp) {
205 assert(tp && tp->kind == k_type);
210 _get_type_tpop_nameid(const type *tp) {
211 assert(tp && tp->kind == k_type);
212 return get_tpop_ident(tp->type_op);
215 static INLINE tp_opcode
216 _get_type_tpop_code(const type *tp) {
217 assert(tp && tp->kind == k_type);
218 return get_tpop_code(tp->type_op);
221 static INLINE ir_mode *
222 _get_type_mode(const type *tp) {
223 assert(tp && tp->kind == k_type);
227 static INLINE ident *
228 _get_type_ident(const type *tp) {
229 assert(tp && tp->kind == k_type);
234 _set_type_ident(type *tp, ident* id) {
235 assert(tp && tp->kind == k_type);
240 _get_type_size_bits(const type *tp) {
241 assert(tp && tp->kind == k_type);
246 _get_type_size_bytes(const type *tp) {
247 int size = _get_type_size_bits(tp);
250 if ((size & 7) != 0) {
251 assert(0 && "cannot take byte size of this type");
257 static INLINE type_state
258 _get_type_state(const type *tp) {
259 assert(tp && tp->kind == k_type);
263 static INLINE unsigned long
264 _get_type_visited(const type *tp) {
265 assert(tp && tp->kind == k_type);
270 _set_type_visited(type *tp, unsigned long num) {
271 assert(tp && tp->kind == k_type);
276 _mark_type_visited(type *tp) {
277 assert(tp && tp->kind == k_type);
278 assert(tp->visit < type_visited);
279 tp->visit = type_visited;
283 _type_visited(const type *tp) {
284 assert(tp && tp->kind == k_type);
285 return tp->visit >= type_visited;
289 _type_not_visited(const type *tp) {
290 assert(tp && tp->kind == k_type);
291 return tp->visit < type_visited;
295 _is_type(const void *thing) {
296 return (get_kind(thing) == k_type);
300 _is_class_type(const type *clss) {
302 return (clss->type_op == type_class);
306 _get_class_n_members (const type *clss) {
307 assert(clss && (clss->type_op == type_class));
308 return (ARR_LEN (clss->attr.ca.members));
311 static INLINE entity *
312 _get_class_member (const type *clss, int pos) {
313 assert(clss && (clss->type_op == type_class));
314 assert(pos >= 0 && pos < _get_class_n_members(clss));
315 return clss->attr.ca.members[pos];
319 _is_struct_type(const type *strct) {
321 return (strct->type_op == type_struct);
325 _is_method_type(const type *method) {
327 return (method->type_op == type_method);
331 _is_union_type(const type *uni) {
333 return (uni->type_op == type_union);
337 _is_array_type(const type *array) {
339 return (array->type_op == type_array);
343 _is_enumeration_type(const type *enumeration) {
345 return (enumeration->type_op == type_enumeration);
349 _is_pointer_type(const type *pointer) {
351 return (pointer->type_op == type_pointer);
354 /** Returns true if a type is a primitive type. */
356 _is_primitive_type(const type *primitive) {
357 assert(primitive && primitive->kind == k_type);
358 return (primitive->type_op == type_primitive);
362 _is_atomic_type(const type *tp) {
363 assert(tp && tp->kind == k_type);
364 return (_is_primitive_type(tp) || _is_pointer_type(tp) ||
365 _is_enumeration_type(tp));
369 #define set_master_type_visited(val) _set_master_type_visited(val)
370 #define get_master_type_visited() _get_master_type_visited()
371 #define inc_master_type_visited() _inc_master_type_visited()
372 #define get_type_link(tp) _get_type_link(tp)
373 #define set_type_link(tp, l) _set_type_link(tp, l)
374 #define get_type_tpop(tp) _get_type_tpop(tp)
375 #define get_type_tpop_nameid(tp) _get_type_tpop_nameid(tp)
376 #define get_type_tpop_code(tp) _get_type_tpop_code(tp)
377 #define get_type_mode(tp) _get_type_mode(tp)
378 #define get_type_ident(tp) _get_type_ident(tp)
379 #define set_type_ident(tp, id) _set_type_ident(tp, id)
380 #define get_type_size(tp) _get_type_size(tp)
381 #define get_type_state(tp) _get_type_state(tp)
382 #define get_type_visited(tp) _get_type_visited(tp)
383 #define set_type_visited(tp, num) _set_type_visited(tp, num)
384 #define mark_type_visited(tp) _mark_type_visited(tp)
385 #define type_visited(tp) _type_visited(tp)
386 #define type_not_visited(tp) _type_not_visited(tp)
387 #define is_type(thing) _is_type(thing)
388 #define is_Class_type(clss) _is_class_type(clss)
389 #define get_class_n_members(clss) _get_class_n_members(clss)
390 #define get_class_member(clss, pos) _get_class_member(clss, pos)
391 #define is_Struct_type(strct) _is_struct_type(strct)
392 #define is_Method_type(method) _is_method_type(method)
393 #define is_Union_type(uni) _is_union_type(uni)
394 #define is_Array_type(array) _is_array_type(array)
395 #define is_Enumeration_type(enumeration) _is_enumeration_type(enumeration)
396 #define is_Pointer_type(pointer) _is_pointer_type(pointer)
397 #define is_Primitive_type(primitive) _is_primitive_type(primitive)
398 #define is_atomic_type(tp) _is_atomic_type(tp)
400 # endif /* _TYPE_T_H_ */