1 /* Copyright (C) 1998 - 2000 by Universitaet Karlsruhe
2 ** All rights reserved.
4 ** Authors: Martin Trapp, Christian Schaefer &
8 @@@@@@@ Improve documentation: distinguish fields that are
9 set by the frontend and contain knowledge specified by the source
10 program from fields containing information derived by analysis/optimization
14 ** type.h: datastructures to hold type information.
16 ** This module supplies datastructures to represent all types
17 ** known in the compiled program. This includes types specified
18 ** in the program as well as types defined by the language. In the
19 ** view of the intermediate representation there is no difference
20 ** between these types.
21 ** Types are different from the modes defined in irmode: Types are
22 ** on the level of the programming language, modes at the level of
23 ** the target processor.
26 ** General datastructure
27 ** =====================
29 ** Firm distinguishes several different type constructs. These are
30 ** implemented as structs. A union of the individual structs constructs
31 ** the firm node "type".
33 ** All type constructs have the following fields:
35 ** kind A firm_kind tag containing k_type_class. This is useful
36 ** for dynamically checking the sort of a type. Automatically
39 ** name An identifier specifying the type name. Set by the frontend.
41 ** visit A counter for walks of the type information.
44 ** General functionality
45 ** =====================
47 ** is_type(t) Returns true if t is a type node, else false.
53 ** Type_class represents class types. A list of fields and
54 ** methods is associated with a class. Further a class can
55 ** inherit from and bequest to other classes.
60 ** **member All entities belonging to this class. This are methodes
61 ** which have type_method or fields that can have any of the
62 ** following types: k_type_class, k_type_strct, k_type_union,
63 ** k_type_array, k_type_enumeration, k_type_pointer, k_type_primitive.
65 ** **subtypes A list of direct subclasses.
67 ** **supertypes A list of direct superclasses.
73 ** Type_strct represents aggregate types that consist of a list
79 ** **member All entities belonging to this class. This are the fields
80 ** that can have any of the following types: k_type_class,
81 ** k_type_strct, k_type_union, k_type_array, k_type_enumeration,
82 ** k_type_pointer, k_type_primitive.
87 ** Type_method represents method, function and procedure types.
92 ** arity Number of parameters to the procedure. @@@ better n_params
93 ** A procedure in FIRM has only call by value parameters.
95 ** **param_type A list with the types of parameters. This list is ordered.
96 ** The nth type in this list corresponds to the nth element
97 ** in the parameter tuple that is a result of the start node.
98 ** (See ircons.h for more information.)
100 ** n_res The number of results of the method. In general, procedures
101 ** have zero results, functions one.
103 ** **res_type A list with the types of parameters. This list is ordered.
104 ** The nth type in this list corresponds to the nth input to
105 ** Return nodes. (See ircons.h for more information.)
111 ** Type_union represents union types.
116 ** **unioned_type A list of unioned types.
122 ** Type_array represents rectangular multi dimensional arrays.
127 ** n_dimensions Number of array dimensions.
129 ** *lower_bound Lower bounds of dimensions. Mostly all 0.
131 ** *upper_bound Upper bounds or dimensions.
133 ** *element_type The type of the array elements.
139 ** Enumeration types. These need not necessarily be represented explicitly
140 ** by Firm types, as the frontend can lower them to integer constants as
141 ** well. For debugging purposes or similar tasks this information is useful.
146 ** **enum The target values representing the constants used to
147 ** represent individual enumerations.
149 ** **enum_name Idents containing the source program name of the enumeration
160 ** *mode The mode used to implement a pointer. @@@ So far this field
161 ** is constant and set to mode_P. Maybe we will move this
162 ** to a global constant (irprog), or are there processors
163 ** that require a set of different pointer modes?
165 ** *points_to The type of the entity this pointer points to.
170 ** Primitive types are types that represent indivisible data values that
171 ** map directly to modes.
176 ** mode The mode to be used for this type.
188 /* for recursive type definiton */
189 #ifndef _TYPE_TYPEDEF_
190 #define _TYPE_TYPEDEF_
191 /* to resolve recursion between entity.h and irgraph.h */
192 typedef union type type;
195 /* visited flag to traverse the type information */
196 extern unsigned long type_visited;
198 /*******************************************************************/
200 /*******************************************************************/
202 typedef struct type_class type_class;
206 ident *name; /* needs list with it's entities
208 Entities can be added during their creation. */
209 struct entity **members; /* to represent inheritance */
210 type_class **subtypes; /* direct subtypes */
211 type_class **supertypes; /* direct supertypes */
212 unsigned long visit; /* visited counter for walks of
213 the type information */
217 /* create a new type_class */
218 type_class *new_type_class (ident *name);
220 /* manipulate fields of type_class */
222 char *get_class_name (type_class *class);
223 ident *get_class_ident (type_class *class);
225 /* Not necessary now!
226 void set_class_name (type_class *class, char *name);
227 void set_class_ident (type_class *class, ident* ident);
230 void add_class_member (type_class *class, entity *member);
231 entity *get_class_member (type_class *class, int pos);
232 void set_class_member (type_class *class, entity *member, int pos);
234 void add_class_subtype (type_class *class, type_class *subtype);
235 type_class *get_class_subtype (type_class *class, int pos);
236 void set_class_subtype (type_class *class, type_class *subtype, int pos);
238 void add_class_supertype (type_class *class, type_class *supertype);
239 type_class *get_class_supertype (type_class *class, int pos);
240 void set_class_supertype (type_class *class, type_class *supertype, int pos);
243 /* get_class_entity_arr
245 get_class_entity(class, pos)
246 set_class_entity(class, pos, entity)
252 /*******************************************************************/
254 /*******************************************************************/
259 /** needs list with it's entities -- does it really??
260 Entities can be added during their creation.
263 unsigned long visit; /* visited counter for walks of the type information */
267 /* create a new type_strct */
268 type_strct *new_type_strct (ident *name);
270 /* manipulate fields of type_strct */
271 char *get_strct_name (type_strct *strct);
272 ident *get_strct_ident (type_strct *strct);
274 void set_strct_name (type_strct *strct, char *name);
275 void set_strct_ident (type_strct *strct, ident* ident);
279 /*******************************************************************/
281 /*******************************************************************/
285 ident *name; /* Name of the method type. Usually method
286 types are not explicitly named (but the entity). */
287 int arity; /* number of parameters, better n_params */
288 type **param_type; /* code generation needs this information.
289 Should it be generated by the frontend,
290 or does this impose unnecessary work for
291 optimizations that change the parameters of
293 int n_res; /* number of results */
294 type **res_type; /* array with result types */
295 unsigned long visit; /* visited counter for walks of the type information */
298 /* create a new type_method */
299 type_method *new_type_method (ident *name, int arity, int n_res);
301 /* manipulate fields of type_method */
302 char *get_method_name (type_method *method);
303 ident *get_method_ident (type_method *method);
305 void set_method_name (type_method *method, char *name);
306 void set_method_ident (type_method *method, ident* ident); */
308 inline int get_method_arity (type_method *method);
309 inline void set_method_arity (type_method *method, int arity);
310 inline type *get_method_param_type(type_method *method, int pos);
311 inline void set_method_param_type(type_method *method, int pos, type* type);
313 inline int get_method_n_res (type_method *method);
314 inline void set_method_n_res (type_method *method, int n_res);
315 inline type *get_method_res_type(type_method *method, int pos);
316 inline void set_method_res_type(type_method *method, int pos, type* type);
319 /*******************************************************************/
321 /*******************************************************************/
325 ident *name; /* do I need a name? */
327 /* type **unioned_type; ... or something like that? */
328 unsigned long visit; /* visited counter for walks of the type information */
331 /* create a new type_union -- set unioned types by hand. */
332 type_union *new_type_union (ident *name, int n_types);
334 /* manipulate fields of type_union */
335 char *get_union_name (type_union *uni);
336 ident *get_union_ident (type_union *uni);
338 void set_union_name (type_union *union, char *name);
339 void set_union_ident (type_union *union, ident* ident);
342 int get_union_n_types (type_union *union);
343 void set_union_n_types (type_union *union, int n);
344 type *get_union_unioned_type (type_union *union, int pos);
345 void set_union_unioned_type (type_union *union, int pos, type *type);
348 /*******************************************************************/
350 /*******************************************************************/
352 /* multidimensional, polyhedric arrays */
360 unsigned long visit; /* visited counter for walks of the type information */
363 /* create a new type array -- set dimension sizes independently */
364 type_array *new_type_array (ident *name, int n_dimensions);
366 /* manipulate fields of type_array */
367 char *get_array_name (type_array *array);
368 ident *get_array_ident (type_array *array);
370 void set_array_name (type_array *array, char *name);
371 void set_array_ident (type_array *array, ident* ident);
373 void set_array_n_dimensions (type_array *array, int n);
374 int get_array_n_dimensions (type_array *array);
376 void set_array_bounds (type_array *array, int dimension, int lower_bound,
378 void set_array_lower_bound (type_array *array, int dimension, int lower_bound);
379 void set_array_upper_bound (type_array *array, int dimension, int upper_bound);
380 int get_array_lower_bound (type_array *array, int dimension);
381 int get_array_upper_bound (type_array *array, int dimension);
383 void set_array_element_type (type_array *array, type *type);
384 type *get_array_element_type (type_array *array);
386 /*******************************************************************/
387 /** TYPE_ENUMERATION **/
388 /*******************************************************************/
389 /** Enums are needed to keep debugging information. They can as well
390 be lowered to integers. **/
396 tarval **enum * Contains all constant nodes that represent a member
397 of the enum -- enumerators. */
399 ident **enum_name * Contains the names of the enum fields as specified by
400 the source program */
401 /* is ir_node the propper array member? */
402 unsigned long visit; /* visited counter for walks of the type information */
405 /* create a new type enumeration -- set the enumerators independently */
406 type_enumeration *new_type_enumeration (ident *name /* , int n_enums */);
408 /* manipulate fields of type_enumeration */
409 char *get_enumeration_name (type_enumeration *enumeration);
410 ident *get_enumeration_ident (type_enumeration *enumeration);
412 void set_enumeration_name (type_enumeration *enumeration, char *name);
413 void set_enumeration_ident (type_enumeration *enumeration, ident* ident);
416 void set_enumeration_n_enums (type_enumeration *enumeration, int n);
417 int *get_enumeration_n_enums (type_enumeration *enumeration);
418 void set_enumeration_enum (type_enumeration *enumeration, int pos,
420 ir_node *get_enumeration_enum (type_enumeration *enumeration, int pos);
423 /*******************************************************************/
425 /*******************************************************************/
430 /* ir_mode *mode; * The mode to be used for this type.
431 Not here as there might be several pointer types?
432 A method get_pointer_mode should read a unique,
435 unsigned long visit; /* visited counter for walks of the type information */
438 /* create a new type pointer */
439 type_pointer *new_type_pointer (ident *name, type *points_to);
441 /* manipulate fields of type_pointer */
442 char *get_pointer_name (type_pointer *pointer);
443 ident *get_pointer_ident (type_pointer *pointer);
445 void set_pointer_name (type_pointer *pointer, char *name);
446 void set_pointer_ident (type_pointer *pointer, ident* ident);
448 void set_pointer_points_to_type (type_pointer *pointer, type *type);
449 type *get_pointer_points_to_type (type_pointer *pointer);
451 /*******************************************************************/
452 /** TYPE_PRIMITIVE **/
453 /*******************************************************************/
455 /* primitive, language-defined types */
456 /* What is the type of an entity if it is atomic? Are alle basic data
457 types classses in Sather? Else this is needed. */
461 ir_mode *mode; /* The mode to be used for this type */
462 unsigned long visit; /* visited counter for walks of the type information */
465 /* create a new type primitive */
466 type_primitive *new_type_primitive (ident *name, ir_mode *mode);
468 /* manipulate fields of type_primitive */
469 char *get_primitive_name (type_primitive *primitive);
470 ident *get_primitive_ident (type_primitive *primitive);
472 void set_primitive_name (type_primitive *primitive, char *name);
473 void set_primitive_ident (type_primitive *primitive, ident* ident);
475 ir_mode *get_primitive_mode (type_primitive *primitive);
476 void set_primitive_mode (type_primitive *primitive, ir_mode *mode);
481 /*******************************************************************/
482 /** To manage all different types the same **/
483 /*******************************************************************/
491 type_union uni; /* union is keyword */
492 type_enumeration enumeration;
493 type_pointer pointer;
494 type_primitive primitive;
498 int is_type(void *thing);
503 # endif /* _TYPE_H_ */