1 /****h* libfirm/type6 2002/03/19 13:08:33
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.
43 #ifndef _ENTITY_TYPEDEF_
44 #define _ENTITY_TYPEDEF_
45 /* to resolve recursion between entity.h and type.h */
46 typedef struct entity entity;
49 #ifndef _IR_NODE_TYPEDEF_
50 #define _IR_NODE_TYPEDEF_
51 typedef struct ir_node ir_node;
57 * type - An abstract data type to represent types.
59 * This is the abstract data type with which any type known in the
60 * compiled program can be represented. This includes types specified
61 * in the program as well as types defined by the language. In the
62 * view of the intermediate representation there is no difference
63 * between these types.
65 * There exist several kinds of types, arranged by the structure of
66 * the type. These are distinguished by a type opcode.
67 * A type is described by a set of attributes. Some of these attributes
68 * are common to all types, others depend on the kind of the type.
70 * The following describes the common attributes. They can only be
71 * accessed by the functions given below.
74 * The common fields are:
76 * firm_kind A firm_kind tag containing k_type. This is useful
77 * for dynamically checking whether a node is a type node.
78 * type_op A tp_op specifying the kind of the type.
79 * mode The mode to be used to represent the type on a machine.
80 * @@@ maybe not global field??
81 * name An identifier specifying the name of the type. To be
82 * set by the frontend.
83 * size The size of the type, i.e. an entity of this type will
84 * occupy size bytes in memory. In several cases this is
85 * determined when fixing the layout of this type (class,
86 * struct, union, array, enumeration).
87 * state The state of the type. The state represents whether the
88 * layout of the type is undefined or fixed (values: layout_undefined
89 * or layout_fixed). Compound types can have an undefined
90 * layout. The layout of the basic types primitive and pointer
91 * is always layout_fixed. If the layout of
92 * compound types is fixed all entities must have an offset
93 * and the size of the type must be set.
94 * A fixed layout for enumeration types means that each enumeration
95 * is associated with an implementation value.
96 * visit A counter for walks of the type information.
97 * link A void* to associate some additional information with the type.
99 * These fields can only be accessed via access functions.
101 * Depending on the value of type_op, i.e., depending on the kind of the
102 * type the adt contains further attributes. These are documented below.
104 * class, struct, method, union, array, enumeration, pointer, primitive
107 typedef struct type type;
109 # include "type_or_entity.h"
111 /* Frees the memory used by the type. Does not free the entities
112 belonging to the type, except for the array element entity. */
113 void free_type(type *tp);
115 tp_op* get_type_tpop(type *tp);
116 ident* get_type_tpop_nameid(type *tp);
117 const char* get_type_tpop_name(type *tp);
118 tp_opcode get_type_tpop_code(type *tp);
120 ident* get_type_ident(type *tp);
121 void set_type_ident(type *tp, ident* id);
122 const char* get_type_name(type *tp);
125 layout_undefined, /* The layout of this type is not defined.
126 Address computation to access fields is not
127 possible, fields must be accessed by Sel
128 nodes. This is the default value except for
129 pointer, primitive and method types. */
130 layout_fixed /* The layout is fixed, all component/member entities
131 have an offset assigned. Size of the type is known.
132 Arrays can be accessed by explicit address
133 computation. Default for pointer, primitive ane method
136 type_state get_type_state(type *tp);
137 /* For primitives, pointer and method types the layout is always fixed.
138 This call is legal but has no effect. */
139 void set_type_state(type *tp, type_state state);
141 /* Returns NULL for all non atomic types. */
142 ir_mode* get_type_mode(type *tp);
143 /* Only has an effect on primitive and enumeration types */
144 void set_type_mode(type *tp, ir_mode* m);
146 int get_type_size(type *tp);
147 /* For primitive, enumeration, pointer and method types the size
148 is always fixed. This call is legal but has no effect. */
149 void set_type_size(type *tp, int size);
152 unsigned long get_type_visited(type *tp);
153 void set_type_visited(type *tp, unsigned long num);
154 /* Sets visited field in type to type_visited. */
155 void mark_type_visited(type *tp);
157 void* get_type_link(type *tp);
158 void set_type_link(type *tp, void *l);
164 * type_visited - visited flag to traverse the type information
166 * Increase this flag by one before traversing the type information.
167 * Mark type nodes as visited by set_type_visited(type, type_visited).
168 * Check whether node was already visited by comparing get_type_visited(type)
170 * Or use the function to walk all types.
175 extern unsigned long type_visited;
181 * is_type - Checks whether a pointer points to a type.
183 * bool is_type (void *thing);
187 * true if the thing is a type, else false
190 int is_type (void *thing);
194 * Representation of a class type.
196 * If the type opcode is set to type_class the type represents class
197 * types. A list of fields and methods is associated with a class.
198 * Further a class can inherit from and bequest to other classes.
201 * The following attributes are private to this type kind.
202 * member All entities belonging to this class. This are methode entities
203 * which have type_method or fields that can have any of the
204 * following type kinds: type_class, type_struct, type_union,
205 * type_array, type_enumeration, type_pointer, type_primitive.
207 * subtypes A list of direct subclasses.
209 * supertypes A list of direct superclasses.
211 * These are dynamic lists that can be grown with an "add_" function,
214 * peculiarity The peculiarity of this class. If the class is of peculiarity
215 * "description" it only is a description of requirememts to a class,
216 * as, e.g., a Java interface. The class will never be allocated.
217 * Peculiatity inherited is only possible for entities. An entity
218 * is of peculiarity inherited if the compiler generated the entity
219 * to explicitly resolve inheritance. An inherited method entity has
221 * Values: description, existent, inherited. Default: existent.
225 /* create a new class type */
226 type *new_type_class (ident *name);
228 /** manipulate private fields of class type **/
229 /* Adds the entity as member of the class. */
230 void add_class_member (type *clss, entity *member);
231 /* Returns the number of members of this class. */
232 int get_class_n_members (type *clss);
233 /* Returns the member at position pos, 0 <= pos < n_member */
234 entity *get_class_member (type *clss, int pos);
235 /* Overwrites the member at position pos, 0 <= pos < n_member with
236 the passed entity. */
237 void set_class_member (type *clss, entity *member, int pos);
238 /* Replaces complete member list in class type by the list passed. Copies the
239 list passed. This function is necessary to reduce the number of members.
240 members is an array of entities, num the size of this array. Sets all
241 owners of the members passed to clss. */
242 void set_class_members (type *clss, entity **members, int arity);
243 /* Finds member in the list of members and overwrites it with NULL
244 @@@ Doesn't work properly. */
245 void remove_class_member(type *clss, entity *member);
248 /* Adds subtype as subtype to clss.
249 Checks whether clss is a supertype of subtype. If not
250 adds also clss as supertype to subtype. */
251 void add_class_subtype (type *clss, type *subtype);
252 /* Returns the number of subtypes */
253 int get_class_n_subtypes (type *clss);
254 /* Gets the subtype at position pos, 0 <= pos < n_subtype. */
255 type *get_class_subtype (type *clss, int pos);
256 /* Sets the subtype at positioin pos, 0 <= pos < n_subtype. Does not
257 set the corresponding supertype relation for subtype: this might
258 be a different position! */
259 void set_class_subtype (type *clss, type *subtype, int pos);
260 /* Finds subtype in the list of subtypes and overwrites it with NULL
261 @@@ Doesn't work properly. */
262 void remove_class_subtype(type *clss, type *subtype);
265 /* Adds supertype as supertype to class.
266 Checks whether clss is a subtype of supertype. If not
267 adds also clss as subtype to supertype. */
268 void add_class_supertype (type *clss, type *supertype);
269 /* Returns the number of supertypes */
270 int get_class_n_supertypes (type *clss);
271 /* Gets the supertype at position pos, 0 <= pos < n_supertype. */
272 type *get_class_supertype (type *clss, int pos);
273 /* Sets the supertype at postition pos, 0 <= pos < n_subtype. Does not
274 set the corresponding subtype relation for supertype: this might
275 be a different position! */
276 void set_class_supertype (type *clss, type *supertype, int pos);
277 /* Finds supertype in the list of supertypes and overwrites it with NULL
278 @@@ Doesn't work properly. */
279 void remove_class_supertype(type *clss, type *supertype);
281 /* This enumeration flags the peculiarity of entities and types. */
282 typedef enum peculiarity {
283 description, /* Represents only a description. The entity/type is never
284 allocated, no code/data exists for this entity/type. */
285 inherited, /* Describes explicitly that other entities are inherited
286 to the owner of this entity. Overwrites must refer to
287 at least one other entity. If this is a method entity
288 there exists no irg for this entity, only for one of
289 the overwritten ones. */
290 existent /* The entity/type (can) exist. */
293 /* The peculiarity of the class. The enumeration peculiarity is defined
295 INLINE peculiarity get_class_peculiarity (type *clss);
296 INLINE void set_class_peculiarity (type *clss, peculiarity pec);
298 /* Set and get a class' dfn --
299 @@@ This is an undocumented field, subject to change! */
300 void set_class_dfn (type*, int);
301 int get_class_dfn (type*);
304 bool is_class_type(type *clss);
309 * Representation of a struct type.
311 * Type_strct represents aggregate types that consist of a list
314 * member All entities belonging to this class. This are the fields
315 * that can have any of the following types: type_class,
316 * type_struct, type_union, type_array, type_enumeration,
317 * type_pointer, type_primitive.
318 * This is a dynamic list that can be grown with an "add_" function,
320 * This is a dynamic list that can be grown with an "add_" function,
324 /* create a new type struct */
325 type *new_type_struct (ident *name);
327 /* manipulate private fields of struct */
328 void add_struct_member (type *strct, entity *member);
329 int get_struct_n_members (type *strct);
330 entity *get_struct_member (type *strct, int pos);
331 void set_struct_member (type *strct, int pos, entity *member);
332 /* Finds member in the list of memberss and overwrites it with NULL
333 @@@ Doesn't work properly. */
334 void remove_struct_member (type *strct, entity *member);
337 bool is_struct_type(type *strct);
342 * Representation of a method type.
344 * A method type represents a method, function or procedure type.
345 * It contains a list of the parameter and result types, as these
346 * are part of the type description. These lists should not
347 * be changed by a optimization, as a change creates a new method
348 * type. Therefore optimizations should allocated new method types.
349 * The set_ routines are only for construction by a frontend.
351 * n_params Number of parameters to the procedure.
352 * A procedure in FIRM has only call by value parameters.
354 * param_type A list with the types of parameters. This list is ordered.
355 * The nth type in this list corresponds to the nth element
356 * in the parameter tuple that is a result of the start node.
357 * (See ircons.h for more information.)
359 * n_res The number of results of the method. In general, procedures
360 * have zero results, functions one.
362 * res_type A list with the types of parameters. This list is ordered.
363 * The nth type in this list corresponds to the nth input to
364 * Return nodes. (See ircons.h for more information.)
368 /* Create a new method type.
369 N_param is the number of parameters, n_res the number of results.
370 The arrays for the parameter and result types are not initialized by
372 type *new_type_method (ident *name, int n_param, int n_res);
374 /* manipulate private fields of method. */
375 int get_method_n_params (type *method);
376 type *get_method_param_type(type *method, int pos);
377 void set_method_param_type(type *method, int pos, type* type);
379 int get_method_n_ress (type *method);
380 type *get_method_res_type(type *method, int pos);
381 void set_method_res_type(type *method, int pos, type* type);
384 bool is_method_type (type *method);
389 * Representation of a union type.
391 * The union type represents union types.
393 * n_types Number of unioned types.
394 * members Entities for unioned types. Fixed length array.
395 * This is a dynamic list that can be grown with an "add_" function,
399 /* create a new type union */
400 type *new_type_union (ident *name);
402 /* manipulate private fields of struct */
403 int get_union_n_members (type *uni);
404 void add_union_member (type *uni, entity *member);
405 entity *get_union_member (type *uni, int pos);
406 void set_union_member (type *uni, int pos, entity *member);
407 /* Finds member in the list of members and overwrites it with NULL
408 @@@ Doesn't work properly. */
409 void remove_union_member (type *uni, entity *member);
412 bool is_union_type (type *uni);
416 /* We don't need these if the union has entities, which it now
417 does. The entities are necessary for the analysis algorithms. */
418 type *get_union_unioned_type (type *uni, int pos);
419 void set_union_unioned_type (type *uni, int pos, type *type);
421 ident *get_union_delim_nameid (type *uni, int pos);
422 const char *get_union_delim_name (type *uni, int pos);
423 void set_union_delim_nameid (type *uni, int pos, ident *id);
428 * Representation of an array type.
430 * The array type represents rectangular multi dimensional arrays.
431 * The constants representing the bounds must be allocated to
432 * get_const_code_irg() by setting current_ir_graph accordingly.
434 * n_dimensions Number of array dimensions.
435 * *lower_bound Lower bounds of dimensions. Usually all 0.
436 * *upper_bound Upper bounds or dimensions.
437 * *element_type The type of the array elements.
438 * *element_ent An entity for the array elements to be used for
439 * element selection with Sel.
440 * @@@ Do we need several entities? One might want
441 * to select a dimension and not a single element in
442 * case of multidim arrays.
445 /* create a new type array --
446 Sets n_dimension to dimension and all dimension entries to NULL.
447 Initializes order to the order of the dimensions.
448 The entity for array elements is built automatically.
449 Set dimension sizes after call to constructor with set_* routines. */
450 type *new_type_array (ident *name, int n_dimensions,
453 /* manipulate private fields of array type */
454 int get_array_n_dimensions (type *array);
455 /* Allocates Const nodes of mode_I for the array dimensions */
456 void set_array_bounds_int (type *array, int dimension, int lower_bound,
458 void set_array_bounds (type *array, int dimension, ir_node *lower_bound,
459 ir_node *upper_bound);
460 void set_array_lower_bound (type *array, int dimension, ir_node *lower_bound);
461 void set_array_lower_bound_int (type *array, int dimension, int lower_bound);
462 void set_array_upper_bound (type *array, int dimension, ir_node *upper_bound);
463 void set_array_upper_bound_int (type *array, int dimension, int lower_bound);
464 ir_node * get_array_lower_bound (type *array, int dimension);
465 ir_node * get_array_upper_bound (type *array, int dimension);
467 void set_array_order (type *array, int dimension, int order);
468 int get_array_order (type *array, int dimension);
470 void set_array_element_type (type *array, type *type);
471 type *get_array_element_type (type *array);
473 void set_array_element_entity (type *array, entity *ent);
474 entity *get_array_element_entity (type *array);
477 bool is_array_type (type *array);
480 /****** type/enumeration
482 * Representation of an enumeration type.
484 * Enumeration types need not necessarily be represented explicitly
485 * by Firm types, as the frontend can lower them to integer constants as
486 * well. For debugging purposes or similar tasks this information is useful.
488 * *enum The target values representing the constants used to
489 * represent individual enumerations.
490 * *enum_nameid Idents containing the source program name of the enumeration
495 /* create a new type enumeration -- set the enumerators independently */
496 type *new_type_enumeration (ident *name, int n_enums);
498 /* manipulate fields of enumeration type. */
499 int get_enumeration_n_enums (type *enumeration);
501 void set_enumeration_enum (type *enumeration, int pos, tarval *con);
502 tarval *get_enumeration_enum (type *enumeration, int pos);
504 void set_enumeration_nameid (type *enumeration, int pos, ident *id);
505 ident *get_enumeration_nameid (type *enumeration, int pos);
506 const char *get_enumeration_name(type *enumeration, int pos);
509 bool is_enumeration_type (type *enumeration);
514 * Representation of a pointer type.
518 * points_to The type of the entity this pointer points to.
521 /* Create a new type pointer */
522 type *new_type_pointer (ident *name, type *points_to);
524 /* manipulate fields of type_pointer */
525 void set_pointer_points_to_type (type *pointer, type *type);
526 type *get_pointer_points_to_type (type *pointer);
529 bool is_pointer_type (type *pointer);
532 /****** type/primitive
534 * Representation of a primitive type.
536 * Primitive types are types that represent indivisible data values that
537 * map directly to modes. They don't have a private attribute. The
538 * important information they carry is held in the common mode field.
541 /* create a new type primitive */
542 type *new_type_primitive (ident *name, ir_mode *mode);
545 bool is_primitive_type (type *primitive);
550 /****f* type/is_atomic_type
553 * is_atomic_type - Checks whether a type is atomic.
555 * int is_atomic_type(type *tp);
559 * true if type is primitive, pointer or enumeration
562 int is_atomic_type(type *tp);
564 /****f* type/is_compound_type
567 * is_compound_type - Checks whether a type is compound.
569 * int is_compound_type(type *tp)
573 * true if the type is class, structure, union or array type.
576 int is_compound_type(type *tp);
578 # endif /* _TYPE_H_ */