4 * file type.h - datastructure to hold type information.
6 * (C) 2001 by Universitaet Karlsruhe
11 * This module supplies a datastructure to represent all types
12 * known in the compiled program. This includes types specified
13 * in the program as well as types defined by the language. In the
14 * view of the intermediate representation there is no difference
15 * between these types.
17 * There exist several kinds of types, arranged by the structure of
18 * the type. A type is described by a set of attributes. Some of
19 * these attributes are common to all types, others depend on the
22 * Types are different from the modes defined in irmode: Types are
23 * on the level of the programming language, modes at the level of
24 * the target processor.
39 #ifndef _ENTITY_TYPEDEF_
40 #define _ENTITY_TYPEDEF_
41 /* to resolve recursion between entity.h and type.h */
42 typedef struct entity entity;
45 #ifndef _IR_NODE_TYPEDEF_
46 #define _IR_NODE_TYPEDEF_
47 typedef struct ir_node ir_node;
53 * type - An abstract data type to represent types.
55 * This is the abstract data type with which any type known in the
56 * compiled program can be represented. This includes types specified
57 * in the program as well as types defined by the language. In the
58 * view of the intermediate representation there is no difference
59 * between these types.
61 * There exist several kinds of types, arranged by the structure of
62 * the type. These are distinguished by a type opcode.
63 * A type is described by a set of attributes. Some of these attributes
64 * are common to all types, others depend on the kind of the type.
66 * The following describes the common attributes. They can only be
67 * accessed by the functions given below.
70 * The common fields are:
72 * firm_kind A firm_kind tag containing k_type. This is useful
73 * for dynamically checking whether a node is a type node.
74 * type_op A tp_op specifying the kind of the type.
75 * mode The mode to be used to represent the type on a machine.
76 * @@@ maybe not global field??
77 * name An identifier specifying the name of the type. To be
78 * set by the frontend.
79 * size The size of the type, i.e. an entity of this type will
80 * occupy size bytes in memory. In several cases this is
81 * determined when fixing the layout of this type (class,
82 * struct, union, array, enumeration).
83 * visit A counter for walks of the type information.
85 * These fields can only be accessed via access functions.
87 * Depending on the value of type_op, i.e., depending on the kind of the
88 * type the adt contains further attributes. These are documented below.
90 * class, struct, method, union, array, enumeration, pointer, primitive
93 typedef struct type type;
95 tp_op* get_type_tpop(type *tp);
96 ident* get_type_tpop_nameid(type *tp);
97 const char* get_type_tpop_name(type *tp);
98 tp_opcode get_type_tpop_code(type *tp);
100 ir_mode* get_type_mode(type *tp);
101 void set_type_mode(type *tp, ir_mode* m);
103 ident* get_type_nameid(type *tp);
104 void set_type_nameid(type *tp, ident* id);
105 const char* get_type_name(type *tp);
107 int get_type_size(type *tp);
108 /* For primitives and pointer types the size is always fixed.
109 This call is legal but has no effect. */
110 void set_type_size(type *tp, int size);
113 layout_undefined, /* The layout of this type is not defined.
114 Address computation to access fields is not
115 possible, fields must be accessed by Sel nodes.
116 This is the default value except for pointer and
118 layout_fixed /* The layout is fixed, all component/member entities
119 have an offset assigned. Size of the type is known.
120 Arrays can be accessed by explicit address
121 computation. Default for pointer and primitive types.
125 type_state get_type_state(type *tp);
126 /* For primitives and pointer types the layout is always fixed.
127 This call is legal but has no effect. */
128 void set_type_state(type *tp, type_state state);
130 unsigned long get_type_visited(type *tp);
131 void set_type_visited(type *tp, unsigned long num);
132 /* Sets visited field in type to type_visited. */
133 void mark_type_visited(type *tp);
139 * type_visited - visited flag to traverse the type information
141 * Increase this flag by one before traversing the type information.
142 * Mark type nodes as visited by set_type_visited(type, type_visited).
143 * Check whether node was already visited by comparing get_type_visited(type)
145 * Or use the function to walk all types.
150 extern unsigned long type_visited;
156 * is_type - Checks whether a pointer points to a type.
158 * bool is_type (void *thing);
162 * true if the thing is a type, else false
165 int is_type (void *thing);
169 * Representation of a class type.
171 * If the type opcode is set to type_class the type represents class
172 * types. A list of fields and methods is associated with a class.
173 * Further a class can inherit from and bequest to other classes.
176 * The following attributes are private to this type kind.
177 * member All entities belonging to this class. This are methode entities
178 * which have type_method or fields that can have any of the
179 * following type kinds: type_class, type_struct, type_union,
180 * type_array, type_enumeration, type_pointer, type_primitive.
182 * subtypes A list of direct subclasses.
184 * supertypes A list of direct superclasses.
186 * These are dynamic lists that can be grown with an "add_" function,
190 /* create a new class type */
191 type *new_type_class (ident *name);
193 /** manipulate private fields of class type **/
194 /* Adds the entity as member of the class. */
195 void add_class_member (type *clss, entity *member);
196 /* Returns the number of members of this class. */
197 int get_class_n_member (type *clss);
198 /* Returns the member at position pos, 0 <= pos < n_member */
199 entity *get_class_member (type *clss, int pos);
200 /* Overwrites the member at position pos, 0 <= pos < n_member with
201 the passed entity. */
202 void set_class_member (type *clss, entity *member, int pos);
203 /* Finds member in the list of members and overwrites it with NULL */
204 void remove_class_member(type *clss, entity *member);
207 /* Adds subtype as subtype to clss and also
208 clss as supertype to subtype */
209 void add_class_subtype (type *clss, type *subtype);
210 /* Returns the number of subtypes */
211 int get_class_n_subtype (type *clss);
212 /* Gets the subtype at position pos, 0 <= pos < n_subtype. */
213 type *get_class_subtype (type *clss, int pos);
214 /* Sets the subtype at positioin pos, 0 <= pos < n_subtype. Does not
215 set the corresponding supertype relation for subtype: this might
216 be a different position! */
217 void set_class_subtype (type *clss, type *subtype, int pos);
218 /* Finds subtype in the list of subtypes and overwrites it with NULL */
219 void remove_class_subtype(type *clss, type *subtype);
222 /* Adds supertype as supertype to class and also
223 class as subtype to supertype. */
224 void add_class_supertype (type *clss, type *supertype);
225 /* Returns the number of supertypes */
226 int get_class_n_supertype (type *clss);
227 /* Gets the supertype at position pos, 0 <= pos < n_supertype. */
228 type *get_class_supertype (type *clss, int pos);
229 /* Sets the supertype at postition pos, 0 <= pos < n_subtype. Does not
230 set the corresponding subtype relation for supertype: this might
231 be a different position! */
232 void set_class_supertype (type *clss, type *supertype, int pos);
233 /* Finds supertype in the list of supertypes and overwrites it with NULL */
234 void remove_class_supertype(type *clss, type *supertype);
237 bool is_class_type(type *clss);
242 * Representation of a struct type.
244 * Type_strct represents aggregate types that consist of a list
247 * member All entities belonging to this class. This are the fields
248 * that can have any of the following types: type_class,
249 * type_struct, type_union, type_array, type_enumeration,
250 * type_pointer, type_primitive.
251 * This is a dynamic list that can be grown with an "add_" function,
253 * This is a dynamic list that can be grown with an "add_" function,
257 /* create a new type struct */
258 type *new_type_struct (ident *name);
260 /* manipulate private fields of struct */
261 void add_struct_member (type *strct, entity *member);
262 int get_struct_n_member (type *strct);
263 entity *get_struct_member (type *strct, int pos);
264 void set_struct_member (type *strct, int pos, entity *member);
265 /* Finds member in the list of memberss and overwrites it with NULL */
266 void remove_struct_member (type *strct, entity *member);
269 bool is_struct_type(type *strct);
274 * Representation of a method type.
276 * A method type represents a method, function or procedure type.
277 * It contains a list of the parameter and result types, as these
278 * are part of the type description. These lists should not
279 * be changed by a optimization, as a change creates a new method
280 * type. Therefore optimizations should allocated new method types.
281 * The set_ routines are only for construction by a frontend.
283 * n_params Number of parameters to the procedure.
284 * A procedure in FIRM has only call by value parameters.
286 * param_type A list with the types of parameters. This list is ordered.
287 * The nth type in this list corresponds to the nth element
288 * in the parameter tuple that is a result of the start node.
289 * (See ircons.h for more information.)
291 * n_res The number of results of the method. In general, procedures
292 * have zero results, functions one.
294 * res_type A list with the types of parameters. This list is ordered.
295 * The nth type in this list corresponds to the nth input to
296 * Return nodes. (See ircons.h for more information.)
300 /* Create a new method type.
301 N_param is the number of parameters, n_res the number of results.
302 The arrays for the parameter and result types are not initialized by
304 type *new_type_method (ident *name, int n_param, int n_res);
306 /* manipulate private fields of method. */
307 int get_method_n_params (type *method);
308 type *get_method_param_type(type *method, int pos);
309 void set_method_param_type(type *method, int pos, type* type);
311 int get_method_n_res (type *method);
312 type *get_method_res_type(type *method, int pos);
313 void set_method_res_type(type *method, int pos, type* type);
316 bool is_method_type (type *method);
321 * Representation of a union type.
323 * The union type represents union types.
325 * n_types Number of unioned types.
326 * members Entities for unioned types. Fixed length array.
327 * This is a dynamic list that can be grown with an "add_" function,
331 /* create a new type union */
332 type *new_type_union (ident *name);
334 /* manipulate private fields of struct */
335 int get_union_n_members (type *uni);
336 void add_union_member (type *uni, entity *member);
337 entity *get_union_member (type *uni, int pos);
338 void set_union_member (type *uni, int pos, entity *member);
339 void remove_union_member (type *uni, entity *member);
342 bool is_union_type (type *uni);
346 /* We don't need these if the union has entities, which it now
347 does. The entities are necessary for the analysis algorithms. */
348 type *get_union_unioned_type (type *uni, int pos);
349 void set_union_unioned_type (type *uni, int pos, type *type);
351 ident *get_union_delim_nameid (type *uni, int pos);
352 const char *get_union_delim_name (type *uni, int pos);
353 void set_union_delim_nameid (type *uni, int pos, ident *id);
358 * Representation of an array type.
360 * The array type represents rectangular multi dimensional arrays.
362 * n_dimensions Number of array dimensions.
363 * *lower_bound Lower bounds of dimensions. Usually all 0.
364 * *upper_bound Upper bounds or dimensions.
365 * *element_type The type of the array elements.
366 * *element_ent An entity for the array elements to be used for
367 * element selection with Sel.
368 * @@@ Do we need several entities? One might want
369 * to select a dimension and not a single element in
370 * case of multidim arrays.
373 /* create a new type array --
374 Set dimension sizes after call to constructor with set_* routines.
375 Entity for array elements is built automatically. */
376 type *new_type_array (ident *name, int n_dimensions,
379 /* manipulate private fields of array type */
380 int get_array_n_dimensions (type *array);
381 void set_array_bounds (type *array, int dimension, ir_node *lower_bound,
382 ir_node *upper_bound);
383 void set_array_lower_bound (type *array, int dimension, ir_node *lower_bound);
384 void set_array_upper_bound (type *array, int dimension, ir_node *upper_bound);
385 ir_node * get_array_lower_bound (type *array, int dimension);
386 ir_node * get_array_upper_bound (type *array, int dimension);
388 void set_array_element_type (type *array, type *type);
389 type *get_array_element_type (type *array);
391 void set_array_element_entity (type *array, entity *ent);
392 entity *get_array_element_entity (type *array);
395 bool is_array_type (type *array);
398 /****** type/enumeration
400 * Representation of an enumeration type.
402 * Enumeration types need not necessarily be represented explicitly
403 * by Firm types, as the frontend can lower them to integer constants as
404 * well. For debugging purposes or similar tasks this information is useful.
406 * *enum The target values representing the constants used to
407 * represent individual enumerations.
408 * *enum_nameid Idents containing the source program name of the enumeration
413 /* create a new type enumeration -- set the enumerators independently */
414 type *new_type_enumeration (ident *name, int n_enums);
416 /* manipulate fields of enumeration type. */
417 int get_enumeration_n_enums (type *enumeration);
419 void set_enumeration_enum (type *enumeration, int pos, tarval *con);
420 tarval *get_enumeration_enum (type *enumeration, int pos);
422 void set_enumeration_nameid (type *enumeration, int pos, ident *id);
423 ident *get_enumeration_nameid (type *enumeration, int pos);
424 const char *get_enumeration_name(type *enumeration, int pos);
427 bool is_enumeration_type (type *enumeration);
432 * Representation of a pointer type.
436 * points_to The type of the entity this pointer points to.
439 /* Create a new type pointer */
440 type *new_type_pointer (ident *name, type *points_to);
442 /* manipulate fields of type_pointer */
443 void set_pointer_points_to_type (type *pointer, type *type);
444 type *get_pointer_points_to_type (type *pointer);
447 bool is_pointer_type (type *pointer);
450 /****** type/primitive
452 * Representation of a primitive type.
454 * Primitive types are types that represent indivisible data values that
455 * map directly to modes. They don't have a private attribute. The
456 * important information they carry is held in the common mode field.
459 /* create a new type primitive */
460 type *new_type_primitive (ident *name, ir_mode *mode);
463 bool is_primitive_type (type *primitive);
466 # endif /* _TYPE_H_ */