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.
187 //# include "entity.h"
189 #ifndef _ENTITY_TYPEDEF_
190 #define _ENTITY_TYPEDEF_
191 /* to resolve recursion between entity.h and type.h */
192 typedef struct entity entity;
195 /* for recursive type definiton */
196 //#ifndef _TYPE_TYPEDEF_
197 //#define _TYPE_TYPEDEF_
198 /* to resolve recursion between entity.h and irgraph.h */
199 typedef union type type;
203 /* visited flag to traverse the type information */
204 extern unsigned long type_visited;
206 /*******************************************************************/
208 /*******************************************************************/
210 typedef struct type_class type_class;
214 ident *name; /* needs list with it's entities
216 Entities can be added during their creation. */
217 struct entity **members; /* to represent inheritance */
218 type_class **subtypes; /* direct subtypes */
219 type_class **supertypes; /* direct supertypes */
220 unsigned long visit; /* visited counter for walks of
221 the type information */
225 /* create a new type_class */
226 type_class *new_type_class (ident *name);
228 /* manipulate fields of type_class */
230 const char *get_class_name (type_class *class);
231 ident *get_class_ident (type_class *class);
233 /* Not necessary now!
234 void set_class_name (type_class *class, char *name);
235 void set_class_ident (type_class *class, ident* ident);
238 void add_class_member (type_class *class, entity *member);
239 int get_class_n_member (type_class *class);
240 entity *get_class_member (type_class *class, int pos);
241 void set_class_member (type_class *class, entity *member, int pos);
243 void add_class_subtype (type_class *class, type_class *subtype);
244 int get_class_n_subtype (type_class *class);
245 type_class *get_class_subtype (type_class *class, int pos);
246 void set_class_subtype (type_class *class, type_class *subtype, int pos);
248 void add_class_supertype (type_class *class, type_class *supertype);
249 int get_class_n_supertype (type_class *class);
250 type_class *get_class_supertype (type_class *class, int pos);
251 void set_class_supertype (type_class *class, type_class *supertype, int pos);
253 /*******************************************************************/
255 /*******************************************************************/
261 unsigned long visit; /* visited counter for walks of the type information */
265 /* create a new type_strct */
266 type_strct *new_type_strct (ident *name);
268 /* manipulate fields of type_strct */
269 const char *get_strct_name (type_strct *strct);
270 ident *get_strct_ident (type_strct *strct);
272 void add_strct_member (type_strct *strct, entity *member);
273 int get_strct_n_member (type_strct *strct);
274 entity *get_strct_member (type_strct *strct, int pos);
275 void set_strct_member (type_strct *strct, int pos, entity *member);
278 void set_strct_name (type_strct *strct, char *name);
279 void set_strct_ident (type_strct *strct, ident* ident);
283 /*******************************************************************/
285 /*******************************************************************/
289 ident *name; /* Name of the method type. Usually method
290 types are not explicitly named (but the entity). */
291 int arity; /* number of parameters, better n_params */
292 type **param_type; /* code generation needs this information.
293 Should it be generated by the frontend,
294 or does this impose unnecessary work for
295 optimizations that change the parameters of
297 int n_res; /* number of results */
298 type **res_type; /* array with result types */
299 unsigned long visit; /* visited counter for walks of the type information */
302 /* Create a new type_method.
303 Arity is the number of parameters. */
304 type_method *new_type_method (ident *name, int arity, int n_res);
306 /* manipulate fields of type_method */
307 const char *get_method_name (type_method *method);
308 ident *get_method_ident (type_method *method);
310 void set_method_name (type_method *method, char *name);
311 void set_method_ident (type_method *method, ident* ident); */
313 inline int get_method_arity (type_method *method);
314 /*inline void set_method_arity (type_method *method, int arity);*/
315 inline type *get_method_param_type(type_method *method, int pos);
316 inline void set_method_param_type(type_method *method, int pos, type* type);
318 inline int get_method_n_res (type_method *method);
319 /*inline void set_method_n_res (type_method *method, int n_res);*/
320 inline type *get_method_res_type(type_method *method, int pos);
321 inline void set_method_res_type(type_method *method, int pos, type* type);
324 /*******************************************************************/
326 /*******************************************************************/
330 ident *name; /* do I need a name? */
332 /* type **unioned_type; ... or something like that? */
333 unsigned long visit; /* visited counter for walks of the type information */
336 /* create a new type_union -- set unioned types by hand. */
337 type_union *new_type_union (ident *name, int n_types);
339 /* manipulate fields of type_union */
340 const char *get_union_name (type_union *uni);
341 ident *get_union_ident (type_union *uni);
343 void set_union_name (type_union *union, char *name);
344 void set_union_ident (type_union *union, ident* ident);
347 int get_union_n_types (type_union *union);
348 void set_union_n_types (type_union *union, int n);
349 type *get_union_unioned_type (type_union *union, int pos);
350 void set_union_unioned_type (type_union *union, int pos, type *type);
353 /*******************************************************************/
355 /*******************************************************************/
357 /* multidimensional, polyhedric arrays */
365 unsigned long visit; /* visited counter for walks of the type information */
368 /* create a new type array -- set dimension sizes independently */
369 type_array *new_type_array (ident *name, int n_dimensions);
371 /* manipulate fields of type_array */
372 const char *get_array_name (type_array *array);
373 ident *get_array_ident (type_array *array);
375 void set_array_name (type_array *array, char *name);
376 void set_array_ident (type_array *array, ident* ident);
378 void set_array_n_dimensions (type_array *array, int n);
379 int get_array_n_dimensions (type_array *array);
381 void set_array_bounds (type_array *array, int dimension, int lower_bound,
383 void set_array_lower_bound (type_array *array, int dimension, int lower_bound);
384 void set_array_upper_bound (type_array *array, int dimension, int upper_bound);
385 int get_array_lower_bound (type_array *array, int dimension);
386 int get_array_upper_bound (type_array *array, int dimension);
388 void set_array_element_type (type_array *array, type *type);
389 type *get_array_element_type (type_array *array);
391 /*******************************************************************/
392 /** TYPE_ENUMERATION **/
393 /*******************************************************************/
394 /** Enums are needed to keep debugging information. They can as well
395 be lowered to integers. **/
401 tarval **enum * Contains all constant nodes that represent a member
402 of the enum -- enumerators. */
404 ident **enum_name * Contains the names of the enum fields as specified by
405 the source program */
406 /* is ir_node the propper array member? */
407 unsigned long visit; /* visited counter for walks of the type information */
410 /* create a new type enumeration -- set the enumerators independently */
411 type_enumeration *new_type_enumeration (ident *name /* , int n_enums */);
413 /* manipulate fields of type_enumeration */
414 const char *get_enumeration_name (type_enumeration *enumeration);
415 ident *get_enumeration_ident (type_enumeration *enumeration);
417 void set_enumeration_name (type_enumeration *enumeration, char *name);
418 void set_enumeration_ident (type_enumeration *enumeration, ident* ident);
421 void set_enumeration_n_enums (type_enumeration *enumeration, int n);
422 int *get_enumeration_n_enums (type_enumeration *enumeration);
423 void set_enumeration_enum (type_enumeration *enumeration, int pos,
425 ir_node *get_enumeration_enum (type_enumeration *enumeration, int pos);
428 /*******************************************************************/
430 /*******************************************************************/
435 /* ir_mode *mode; * The mode to be used for this type.
436 Not here as there might be several pointer types?
437 A method get_pointer_mode should read a unique,
440 unsigned long visit; /* visited counter for walks of the type information */
443 /* create a new type pointer */
444 type_pointer *new_type_pointer (ident *name, type *points_to);
446 /* manipulate fields of type_pointer */
447 const char *get_pointer_name (type_pointer *pointer);
448 ident *get_pointer_ident (type_pointer *pointer);
450 void set_pointer_name (type_pointer *pointer, char *name);
451 void set_pointer_ident (type_pointer *pointer, ident* ident);
453 void set_pointer_points_to_type (type_pointer *pointer, type *type);
454 type *get_pointer_points_to_type (type_pointer *pointer);
456 /*******************************************************************/
457 /** TYPE_PRIMITIVE **/
458 /*******************************************************************/
460 /* primitive, language-defined types */
461 /* What is the type of an entity if it is atomic? Are alle basic data
462 types classses in Sather? Else this is needed. */
466 ir_mode *mode; /* The mode to be used for this type */
467 unsigned long visit; /* visited counter for walks of the type information */
470 /* create a new type primitive */
471 type_primitive *new_type_primitive (ident *name, ir_mode *mode);
473 /* manipulate fields of type_primitive */
474 const char *get_primitive_name (type_primitive *primitive);
475 ident *get_primitive_ident (type_primitive *primitive);
477 void set_primitive_name (type_primitive *primitive, char *name);
478 void set_primitive_ident (type_primitive *primitive, ident* ident);
480 ir_mode *get_primitive_mode (type_primitive *primitive);
481 void set_primitive_mode (type_primitive *primitive, ir_mode *mode);
486 /*******************************************************************/
487 /** To manage all different types the same **/
488 /*******************************************************************/
496 type_union uni; /* union is keyword */
497 type_enumeration enumeration;
498 type_pointer pointer;
499 type_primitive primitive;
503 int is_type(void *thing);
508 # endif /* _TYPE_H_ */