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 void* get_type_link(type *tp);
96 void set_type_link(type *tp, void *l);
97 tp_op* get_type_tpop(type *tp);
98 ident* get_type_tpop_nameid(type *tp);
99 const char* get_type_tpop_name(type *tp);
100 tp_opcode get_type_tpop_code(type *tp);
102 ir_mode* get_type_mode(type *tp);
103 void set_type_mode(type *tp, ir_mode* m);
105 ident* get_type_nameid(type *tp);
106 void set_type_nameid(type *tp, ident* id);
107 const char* get_type_name(type *tp);
109 int get_type_size(type *tp);
110 /* For primitives and pointer types the size is always fixed.
111 This call is legal but has no effect. */
112 void set_type_size(type *tp, int size);
115 layout_undefined, /* The layout of this type is not defined.
116 Address computation to access fields is not
117 possible, fields must be accessed by Sel nodes.
118 This is the default value except for pointer and
120 layout_fixed /* The layout is fixed, all component/member entities
121 have an offset assigned. Size of the type is known.
122 Arrays can be accessed by explicit address
123 computation. Default for pointer and primitive types.
127 type_state get_type_state(type *tp);
128 /* For primitives and pointer types the layout is always fixed.
129 This call is legal but has no effect. */
130 void set_type_state(type *tp, type_state state);
132 unsigned long get_type_visited(type *tp);
133 void set_type_visited(type *tp, unsigned long num);
134 /* Sets visited field in type to type_visited. */
135 void mark_type_visited(type *tp);
141 * type_visited - visited flag to traverse the type information
143 * Increase this flag by one before traversing the type information.
144 * Mark type nodes as visited by set_type_visited(type, type_visited).
145 * Check whether node was already visited by comparing get_type_visited(type)
147 * Or use the function to walk all types.
152 extern unsigned long type_visited;
158 * is_type - Checks whether a pointer points to a type.
160 * bool is_type (void *thing);
164 * true if the thing is a type, else false
167 int is_type (void *thing);
171 * Representation of a class type.
173 * If the type opcode is set to type_class the type represents class
174 * types. A list of fields and methods is associated with a class.
175 * Further a class can inherit from and bequest to other classes.
178 * The following attributes are private to this type kind.
179 * member All entities belonging to this class. This are methode entities
180 * which have type_method or fields that can have any of the
181 * following type kinds: type_class, type_struct, type_union,
182 * type_array, type_enumeration, type_pointer, type_primitive.
184 * subtypes A list of direct subclasses.
186 * supertypes A list of direct superclasses.
188 * These are dynamic lists that can be grown with an "add_" function,
192 /* create a new class type */
193 type *new_type_class (ident *name);
195 /** manipulate private fields of class type **/
196 /* Adds the entity as member of the class. */
197 void add_class_member (type *clss, entity *member);
198 /* Returns the number of members of this class. */
199 int get_class_n_member (type *clss);
200 /* Returns the member at position pos, 0 <= pos < n_member */
201 entity *get_class_member (type *clss, int pos);
202 /* Overwrites the member at position pos, 0 <= pos < n_member with
203 the passed entity. */
204 void set_class_member (type *clss, entity *member, int pos);
205 /* Finds member in the list of members and overwrites it with NULL
206 @@@ Doesn't work properly. */
207 void remove_class_member(type *clss, entity *member);
210 /* Adds subtype as subtype to clss.
211 Checks whether clss is a supertype of subtype. If not
212 adds also clss as supertype to subtype. */
213 void add_class_subtype (type *clss, type *subtype);
214 /* Returns the number of subtypes */
215 int get_class_n_subtype (type *clss);
216 /* Gets the subtype at position pos, 0 <= pos < n_subtype. */
217 type *get_class_subtype (type *clss, int pos);
218 /* Sets the subtype at positioin pos, 0 <= pos < n_subtype. Does not
219 set the corresponding supertype relation for subtype: this might
220 be a different position! */
221 void set_class_subtype (type *clss, type *subtype, int pos);
222 /* Finds subtype in the list of subtypes and overwrites it with NULL
223 @@@ Doesn't work properly. */
224 void remove_class_subtype(type *clss, type *subtype);
227 /* Adds supertype as supertype to class.
228 Checks whether clss is a subtype of supertype. If not
229 adds also clss as subtype to supertype. */
230 void add_class_supertype (type *clss, type *supertype);
231 /* Returns the number of supertypes */
232 int get_class_n_supertype (type *clss);
233 /* Gets the supertype at position pos, 0 <= pos < n_supertype. */
234 type *get_class_supertype (type *clss, int pos);
235 /* Sets the supertype at postition pos, 0 <= pos < n_subtype. Does not
236 set the corresponding subtype relation for supertype: this might
237 be a different position! */
238 void set_class_supertype (type *clss, type *supertype, int pos);
239 /* Finds supertype in the list of supertypes and overwrites it with NULL
240 @@@ Doesn't work properly. */
241 void remove_class_supertype(type *clss, type *supertype);
244 bool is_class_type(type *clss);
249 * Representation of a struct type.
251 * Type_strct represents aggregate types that consist of a list
254 * member All entities belonging to this class. This are the fields
255 * that can have any of the following types: type_class,
256 * type_struct, type_union, type_array, type_enumeration,
257 * type_pointer, type_primitive.
258 * This is a dynamic list that can be grown with an "add_" function,
260 * This is a dynamic list that can be grown with an "add_" function,
264 /* create a new type struct */
265 type *new_type_struct (ident *name);
267 /* manipulate private fields of struct */
268 void add_struct_member (type *strct, entity *member);
269 int get_struct_n_member (type *strct);
270 entity *get_struct_member (type *strct, int pos);
271 void set_struct_member (type *strct, int pos, entity *member);
272 /* Finds member in the list of memberss and overwrites it with NULL
273 @@@ Doesn't work properly. */
274 void remove_struct_member (type *strct, entity *member);
277 bool is_struct_type(type *strct);
282 * Representation of a method type.
284 * A method type represents a method, function or procedure type.
285 * It contains a list of the parameter and result types, as these
286 * are part of the type description. These lists should not
287 * be changed by a optimization, as a change creates a new method
288 * type. Therefore optimizations should allocated new method types.
289 * The set_ routines are only for construction by a frontend.
291 * n_params Number of parameters to the procedure.
292 * A procedure in FIRM has only call by value parameters.
294 * param_type A list with the types of parameters. This list is ordered.
295 * The nth type in this list corresponds to the nth element
296 * in the parameter tuple that is a result of the start node.
297 * (See ircons.h for more information.)
299 * n_res The number of results of the method. In general, procedures
300 * have zero results, functions one.
302 * res_type A list with the types of parameters. This list is ordered.
303 * The nth type in this list corresponds to the nth input to
304 * Return nodes. (See ircons.h for more information.)
308 /* Create a new method type.
309 N_param is the number of parameters, n_res the number of results.
310 The arrays for the parameter and result types are not initialized by
312 type *new_type_method (ident *name, int n_param, int n_res);
314 /* manipulate private fields of method. */
315 int get_method_n_params (type *method);
316 type *get_method_param_type(type *method, int pos);
317 void set_method_param_type(type *method, int pos, type* type);
319 int get_method_n_res (type *method);
320 type *get_method_res_type(type *method, int pos);
321 void set_method_res_type(type *method, int pos, type* type);
324 bool is_method_type (type *method);
329 * Representation of a union type.
331 * The union type represents union types.
333 * n_types Number of unioned types.
334 * members Entities for unioned types. Fixed length array.
335 * This is a dynamic list that can be grown with an "add_" function,
339 /* create a new type union */
340 type *new_type_union (ident *name);
342 /* manipulate private fields of struct */
343 int get_union_n_members (type *uni);
344 void add_union_member (type *uni, entity *member);
345 entity *get_union_member (type *uni, int pos);
346 void set_union_member (type *uni, int pos, entity *member);
347 /* Finds member in the list of members and overwrites it with NULL
348 @@@ Doesn't work properly. */
349 void remove_union_member (type *uni, entity *member);
352 bool is_union_type (type *uni);
356 /* We don't need these if the union has entities, which it now
357 does. The entities are necessary for the analysis algorithms. */
358 type *get_union_unioned_type (type *uni, int pos);
359 void set_union_unioned_type (type *uni, int pos, type *type);
361 ident *get_union_delim_nameid (type *uni, int pos);
362 const char *get_union_delim_name (type *uni, int pos);
363 void set_union_delim_nameid (type *uni, int pos, ident *id);
368 * Representation of an array type.
370 * The array type represents rectangular multi dimensional arrays.
372 * n_dimensions Number of array dimensions.
373 * *lower_bound Lower bounds of dimensions. Usually all 0.
374 * *upper_bound Upper bounds or dimensions.
375 * *element_type The type of the array elements.
376 * *element_ent An entity for the array elements to be used for
377 * element selection with Sel.
378 * @@@ Do we need several entities? One might want
379 * to select a dimension and not a single element in
380 * case of multidim arrays.
383 /* create a new type array --
384 Set dimension sizes after call to constructor with set_* routines.
385 Entity for array elements is built automatically. */
386 type *new_type_array (ident *name, int n_dimensions,
389 /* manipulate private fields of array type */
390 int get_array_n_dimensions (type *array);
391 void set_array_bounds (type *array, int dimension, ir_node *lower_bound,
392 ir_node *upper_bound);
393 void set_array_lower_bound (type *array, int dimension, ir_node *lower_bound);
394 void set_array_upper_bound (type *array, int dimension, ir_node *upper_bound);
395 ir_node * get_array_lower_bound (type *array, int dimension);
396 ir_node * get_array_upper_bound (type *array, int dimension);
398 void set_array_element_type (type *array, type *type);
399 type *get_array_element_type (type *array);
401 void set_array_element_entity (type *array, entity *ent);
402 entity *get_array_element_entity (type *array);
405 bool is_array_type (type *array);
408 /****** type/enumeration
410 * Representation of an enumeration type.
412 * Enumeration types need not necessarily be represented explicitly
413 * by Firm types, as the frontend can lower them to integer constants as
414 * well. For debugging purposes or similar tasks this information is useful.
416 * *enum The target values representing the constants used to
417 * represent individual enumerations.
418 * *enum_nameid Idents containing the source program name of the enumeration
423 /* create a new type enumeration -- set the enumerators independently */
424 type *new_type_enumeration (ident *name, int n_enums);
426 /* manipulate fields of enumeration type. */
427 int get_enumeration_n_enums (type *enumeration);
429 void set_enumeration_enum (type *enumeration, int pos, tarval *con);
430 tarval *get_enumeration_enum (type *enumeration, int pos);
432 void set_enumeration_nameid (type *enumeration, int pos, ident *id);
433 ident *get_enumeration_nameid (type *enumeration, int pos);
434 const char *get_enumeration_name(type *enumeration, int pos);
437 bool is_enumeration_type (type *enumeration);
442 * Representation of a pointer type.
446 * points_to The type of the entity this pointer points to.
449 /* Create a new type pointer */
450 type *new_type_pointer (ident *name, type *points_to);
452 /* manipulate fields of type_pointer */
453 void set_pointer_points_to_type (type *pointer, type *type);
454 type *get_pointer_points_to_type (type *pointer);
457 bool is_pointer_type (type *pointer);
460 /****** type/primitive
462 * Representation of a primitive type.
464 * Primitive types are types that represent indivisible data values that
465 * map directly to modes. They don't have a private attribute. The
466 * important information they carry is held in the common mode field.
469 /* create a new type primitive */
470 type *new_type_primitive (ident *name, ir_mode *mode);
473 bool is_primitive_type (type *primitive);
476 # endif /* _TYPE_H_ */