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.
42 #ifndef _ENTITY_TYPEDEF_
43 #define _ENTITY_TYPEDEF_
44 /* to resolve recursion between entity.h and type.h */
45 typedef struct entity entity;
48 #ifndef _IR_NODE_TYPEDEF_
49 #define _IR_NODE_TYPEDEF_
50 typedef struct ir_node ir_node;
56 * type - An abstract data type to represent types.
58 * This is the abstract data type with which any type known in the
59 * compiled program can be represented. This includes types specified
60 * in the program as well as types defined by the language. In the
61 * view of the intermediate representation there is no difference
62 * between these types.
64 * There exist several kinds of types, arranged by the structure of
65 * the type. These are distinguished by a type opcode.
66 * A type is described by a set of attributes. Some of these attributes
67 * are common to all types, others depend on the kind of the type.
69 * The following describes the common attributes. They can only be
70 * accessed by the functions given below.
73 * The common fields are:
75 * firm_kind A firm_kind tag containing k_type. This is useful
76 * for dynamically checking whether a node is a type node.
77 * type_op A tp_op specifying the kind of the type.
78 * mode The mode to be used to represent the type on a machine.
79 * @@@ maybe not global field??
80 * name An identifier specifying the name of the type. To be
81 * set by the frontend.
82 * size The size of the type, i.e. an entity of this type will
83 * occupy size bytes in memory. In several cases this is
84 * determined when fixing the layout of this type (class,
85 * struct, union, array, enumeration).
86 * state The state of the type. The state represents whether the
87 * layout of the type is undefined or fixed (values: layout_undefined
88 * or layout_fixed). Compound types can have an undefined
89 * layout. The layout of the basic types primitive and pointer
90 * is always layout_fixed. If the layout of
91 * compound types is fixed all entities must have an offset
92 * and the size of the type must be set.
93 * A fixed layout for enumeration types means that each enumeration
94 * is associated with an implementation value.
95 * visit A counter for walks of the type information.
96 * link A void* to associate some additional inforamtion with the type.
98 * These fields can only be accessed via access functions.
100 * Depending on the value of type_op, i.e., depending on the kind of the
101 * type the adt contains further attributes. These are documented below.
103 * class, struct, method, union, array, enumeration, pointer, primitive
106 typedef struct type type;
108 void* get_type_link(type *tp);
109 void set_type_link(type *tp, void *l);
110 tp_op* get_type_tpop(type *tp);
111 ident* get_type_tpop_nameid(type *tp);
112 const char* get_type_tpop_name(type *tp);
113 tp_opcode get_type_tpop_code(type *tp);
115 ir_mode* get_type_mode(type *tp);
116 void set_type_mode(type *tp, ir_mode* m);
118 ident* get_type_ident(type *tp);
119 void set_type_ident(type *tp, ident* id);
120 const char* get_type_name(type *tp);
122 int get_type_size(type *tp);
123 /* For primitives and pointer types the size is always fixed.
124 This call is legal but has no effect. */
125 void set_type_size(type *tp, int size);
128 layout_undefined, /* The layout of this type is not defined.
129 Address computation to access fields is not
130 possible, fields must be accessed by Sel nodes.
131 This is the default value except for pointer and
133 layout_fixed /* The layout is fixed, all component/member entities
134 have an offset assigned. Size of the type is known.
135 Arrays can be accessed by explicit address
136 computation. Default for pointer and primitive types.
140 type_state get_type_state(type *tp);
141 /* For primitives and pointer types the layout is always fixed.
142 This call is legal but has no effect. */
143 void set_type_state(type *tp, type_state state);
145 unsigned long get_type_visited(type *tp);
146 void set_type_visited(type *tp, unsigned long num);
147 /* Sets visited field in type to type_visited. */
148 void mark_type_visited(type *tp);
154 * type_visited - visited flag to traverse the type information
156 * Increase this flag by one before traversing the type information.
157 * Mark type nodes as visited by set_type_visited(type, type_visited).
158 * Check whether node was already visited by comparing get_type_visited(type)
160 * Or use the function to walk all types.
165 extern unsigned long type_visited;
171 * is_type - Checks whether a pointer points to a type.
173 * bool is_type (void *thing);
177 * true if the thing is a type, else false
180 int is_type (void *thing);
184 * Representation of a class type.
186 * If the type opcode is set to type_class the type represents class
187 * types. A list of fields and methods is associated with a class.
188 * Further a class can inherit from and bequest to other classes.
191 * The following attributes are private to this type kind.
192 * member All entities belonging to this class. This are methode entities
193 * which have type_method or fields that can have any of the
194 * following type kinds: type_class, type_struct, type_union,
195 * type_array, type_enumeration, type_pointer, type_primitive.
197 * subtypes A list of direct subclasses.
199 * supertypes A list of direct superclasses.
201 * These are dynamic lists that can be grown with an "add_" function,
205 /* create a new class type */
206 type *new_type_class (ident *name);
208 /** manipulate private fields of class type **/
209 /* Adds the entity as member of the class. */
210 void add_class_member (type *clss, entity *member);
211 /* Returns the number of members of this class. */
212 int get_class_n_member (type *clss);
213 /* Returns the member at position pos, 0 <= pos < n_member */
214 entity *get_class_member (type *clss, int pos);
215 /* Overwrites the member at position pos, 0 <= pos < n_member with
216 the passed entity. */
217 void set_class_member (type *clss, entity *member, int pos);
218 /* Finds member in the list of members and overwrites it with NULL
219 @@@ Doesn't work properly. */
220 void remove_class_member(type *clss, entity *member);
223 /* Adds subtype as subtype to clss.
224 Checks whether clss is a supertype of subtype. If not
225 adds also clss as supertype to subtype. */
226 void add_class_subtype (type *clss, type *subtype);
227 /* Returns the number of subtypes */
228 int get_class_n_subtype (type *clss);
229 /* Gets the subtype at position pos, 0 <= pos < n_subtype. */
230 type *get_class_subtype (type *clss, int pos);
231 /* Sets the subtype at positioin pos, 0 <= pos < n_subtype. Does not
232 set the corresponding supertype relation for subtype: this might
233 be a different position! */
234 void set_class_subtype (type *clss, type *subtype, int pos);
235 /* Finds subtype in the list of subtypes and overwrites it with NULL
236 @@@ Doesn't work properly. */
237 void remove_class_subtype(type *clss, type *subtype);
240 /* Adds supertype as supertype to class.
241 Checks whether clss is a subtype of supertype. If not
242 adds also clss as subtype to supertype. */
243 void add_class_supertype (type *clss, type *supertype);
244 /* Returns the number of supertypes */
245 int get_class_n_supertype (type *clss);
246 /* Gets the supertype at position pos, 0 <= pos < n_supertype. */
247 type *get_class_supertype (type *clss, int pos);
248 /* Sets the supertype at postition pos, 0 <= pos < n_subtype. Does not
249 set the corresponding subtype relation for supertype: this might
250 be a different position! */
251 void set_class_supertype (type *clss, type *supertype, int pos);
252 /* Finds supertype in the list of supertypes and overwrites it with NULL
253 @@@ Doesn't work properly. */
254 void remove_class_supertype(type *clss, type *supertype);
257 bool is_class_type(type *clss);
262 * Representation of a struct type.
264 * Type_strct represents aggregate types that consist of a list
267 * member All entities belonging to this class. This are the fields
268 * that can have any of the following types: type_class,
269 * type_struct, type_union, type_array, type_enumeration,
270 * type_pointer, type_primitive.
271 * This is a dynamic list that can be grown with an "add_" function,
273 * This is a dynamic list that can be grown with an "add_" function,
277 /* create a new type struct */
278 type *new_type_struct (ident *name);
280 /* manipulate private fields of struct */
281 void add_struct_member (type *strct, entity *member);
282 int get_struct_n_member (type *strct);
283 entity *get_struct_member (type *strct, int pos);
284 void set_struct_member (type *strct, int pos, entity *member);
285 /* Finds member in the list of memberss and overwrites it with NULL
286 @@@ Doesn't work properly. */
287 void remove_struct_member (type *strct, entity *member);
290 bool is_struct_type(type *strct);
295 * Representation of a method type.
297 * A method type represents a method, function or procedure type.
298 * It contains a list of the parameter and result types, as these
299 * are part of the type description. These lists should not
300 * be changed by a optimization, as a change creates a new method
301 * type. Therefore optimizations should allocated new method types.
302 * The set_ routines are only for construction by a frontend.
304 * n_params Number of parameters to the procedure.
305 * A procedure in FIRM has only call by value parameters.
307 * param_type A list with the types of parameters. This list is ordered.
308 * The nth type in this list corresponds to the nth element
309 * in the parameter tuple that is a result of the start node.
310 * (See ircons.h for more information.)
312 * n_res The number of results of the method. In general, procedures
313 * have zero results, functions one.
315 * res_type A list with the types of parameters. This list is ordered.
316 * The nth type in this list corresponds to the nth input to
317 * Return nodes. (See ircons.h for more information.)
321 /* Create a new method type.
322 N_param is the number of parameters, n_res the number of results.
323 The arrays for the parameter and result types are not initialized by
325 type *new_type_method (ident *name, int n_param, int n_res);
327 /* manipulate private fields of method. */
328 int get_method_n_params (type *method);
329 type *get_method_param_type(type *method, int pos);
330 void set_method_param_type(type *method, int pos, type* type);
332 int get_method_n_res (type *method);
333 type *get_method_res_type(type *method, int pos);
334 void set_method_res_type(type *method, int pos, type* type);
337 bool is_method_type (type *method);
342 * Representation of a union type.
344 * The union type represents union types.
346 * n_types Number of unioned types.
347 * members Entities for unioned types. Fixed length array.
348 * This is a dynamic list that can be grown with an "add_" function,
352 /* create a new type union */
353 type *new_type_union (ident *name);
355 /* manipulate private fields of struct */
356 int get_union_n_members (type *uni);
357 void add_union_member (type *uni, entity *member);
358 entity *get_union_member (type *uni, int pos);
359 void set_union_member (type *uni, int pos, entity *member);
360 /* Finds member in the list of members and overwrites it with NULL
361 @@@ Doesn't work properly. */
362 void remove_union_member (type *uni, entity *member);
365 bool is_union_type (type *uni);
369 /* We don't need these if the union has entities, which it now
370 does. The entities are necessary for the analysis algorithms. */
371 type *get_union_unioned_type (type *uni, int pos);
372 void set_union_unioned_type (type *uni, int pos, type *type);
374 ident *get_union_delim_nameid (type *uni, int pos);
375 const char *get_union_delim_name (type *uni, int pos);
376 void set_union_delim_nameid (type *uni, int pos, ident *id);
381 * Representation of an array type.
383 * The array type represents rectangular multi dimensional arrays.
384 * The constants representing the bounds must be allocated to
385 * get_const_code_irg() by setting current_ir_graph accordingly.
387 * n_dimensions Number of array dimensions.
388 * *lower_bound Lower bounds of dimensions. Usually all 0.
389 * *upper_bound Upper bounds or dimensions.
390 * *element_type The type of the array elements.
391 * *element_ent An entity for the array elements to be used for
392 * element selection with Sel.
393 * @@@ Do we need several entities? One might want
394 * to select a dimension and not a single element in
395 * case of multidim arrays.
398 /* create a new type array --
399 Set dimension sizes after call to constructor with set_* routines.
400 Entity for array elements is built automatically. */
401 type *new_type_array (ident *name, int n_dimensions,
404 /* manipulate private fields of array type */
405 int get_array_n_dimensions (type *array);
406 /* Allocates Const nodes of mode_I for the array dimensions */
407 void set_array_bounds_int (type *array, int dimension, int lower_bound,
409 void set_array_bounds (type *array, int dimension, ir_node *lower_bound,
410 ir_node *upper_bound);
411 void set_array_lower_bound (type *array, int dimension, ir_node *lower_bound);
412 void set_array_upper_bound (type *array, int dimension, ir_node *upper_bound);
413 ir_node * get_array_lower_bound (type *array, int dimension);
414 ir_node * get_array_upper_bound (type *array, int dimension);
416 void set_array_element_type (type *array, type *type);
417 type *get_array_element_type (type *array);
419 void set_array_element_entity (type *array, entity *ent);
420 entity *get_array_element_entity (type *array);
423 bool is_array_type (type *array);
426 /****** type/enumeration
428 * Representation of an enumeration type.
430 * Enumeration types need not necessarily be represented explicitly
431 * by Firm types, as the frontend can lower them to integer constants as
432 * well. For debugging purposes or similar tasks this information is useful.
434 * *enum The target values representing the constants used to
435 * represent individual enumerations.
436 * *enum_nameid Idents containing the source program name of the enumeration
441 /* create a new type enumeration -- set the enumerators independently */
442 type *new_type_enumeration (ident *name, int n_enums);
444 /* manipulate fields of enumeration type. */
445 int get_enumeration_n_enums (type *enumeration);
447 void set_enumeration_enum (type *enumeration, int pos, tarval *con);
448 tarval *get_enumeration_enum (type *enumeration, int pos);
450 void set_enumeration_nameid (type *enumeration, int pos, ident *id);
451 ident *get_enumeration_nameid (type *enumeration, int pos);
452 const char *get_enumeration_name(type *enumeration, int pos);
455 bool is_enumeration_type (type *enumeration);
460 * Representation of a pointer type.
464 * points_to The type of the entity this pointer points to.
467 /* Create a new type pointer */
468 type *new_type_pointer (ident *name, type *points_to);
470 /* manipulate fields of type_pointer */
471 void set_pointer_points_to_type (type *pointer, type *type);
472 type *get_pointer_points_to_type (type *pointer);
475 bool is_pointer_type (type *pointer);
478 /****** type/primitive
480 * Representation of a primitive type.
482 * Primitive types are types that represent indivisible data values that
483 * map directly to modes. They don't have a private attribute. The
484 * important information they carry is held in the common mode field.
487 /* create a new type primitive */
488 type *new_type_primitive (ident *name, ir_mode *mode);
491 bool is_primitive_type (type *primitive);
496 /****f* type/is_atomic_type
499 * is_atomic_type - Checks whether a type is atomic.
501 * int is_atomic_type(type *tp);
505 * true if type is primitive, pointer or enumeration
508 int is_atomic_type(type *tp);
510 /****f* type/is_compound_type
513 * is_compound_type - Checks whether a type is compound.
515 * int is_compound_type(type *tp)
519 * true if the type is class, structure, union or array type.
522 int is_compound_type(type *tp);
524 # endif /* _TYPE_H_ */