2 * (C) 2001 by Universitaet Karlsruhe
9 * Datastructure to hold type information.
11 * @author Goetz Lindenmaier
13 * This module supplies a datastructure to represent all types
14 * known in the compiled program. This includes types specified
15 * in the program as well as types defined by the language. In the
16 * view of the intermediate representation there is no difference
17 * between these types.
19 * There exist several kinds of types, arranged by the structure of
20 * the type. A type is described by a set of attributes. Some of
21 * these attributes are common to all types, others depend on the
24 * Types are different from the modes defined in irmode: Types are
25 * on the level of the programming language, modes at the level of
26 * the target processor.
37 # include "firm_common.h"
44 /* to resolve recursion between entity.h and type.h */
45 #ifndef _ENTITY_TYPEDEF_
46 #define _ENTITY_TYPEDEF_
47 typedef struct entity entity;
50 #ifndef _IR_NODE_TYPEDEF_
51 #define _IR_NODE_TYPEDEF_
52 typedef struct ir_node ir_node;
56 * 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.
72 * The common fields are:
74 * - firm_kind: A firm_kind tag containing k_type. This is useful
75 * for dynamically checking whether a node is a type node.
76 * - type_op: A tp_op specifying the kind of the type.
77 * - mode: The mode to be used to represent the type on a machine.
78 * - name: An identifier specifying the name of the type. To be
79 * set by the frontend.
80 * - size: The size of the type, i.e. an entity of this type will
81 * occupy size bytes in memory. In several cases this is
82 * determined when fixing the layout of this type (class,
83 * struct, union, array, enumeration).
84 * - state: The state of the type. The state represents whether the
85 * layout of the type is undefined or fixed (values: layout_undefined
86 * or layout_fixed). Compound types can have an undefined
87 * layout. The layout of the basic types primitive and pointer
88 * is always layout_fixed. If the layout of
89 * compound types is fixed all entities must have an offset
90 * and the size of the type must be set.
91 * A fixed layout for enumeration types means that each enumeration
92 * is associated with an implementation value.
93 * - visit: A counter for walks of the type information.
94 * - link: A void* to associate some additional information with the type.
96 * These fields can only be accessed via access functions.
98 * Depending on the value of @c type_op, i.e., depending on the kind of the
99 * type the adt contains further attributes. These are documented below.
103 * @link class_type class @endlink, @link struct_type struct @endlink,
104 * @link method_type method @endlink, @link union_type union @endlink,
105 * @link array_type array @endlink, @link enumeration_type enumeration @endlink,
106 * @link pointer_type pointer @endlink, @link primitive_type primitive @endlink
109 * mode maybe not global field??
111 #ifndef _TYPE_TYPEDEF_
112 #define _TYPE_TYPEDEF_
113 typedef struct type type;
116 # include "type_or_entity.h"
118 /** Frees the memory used by the type. Does not free the entities
119 belonging to the type, except for the array element entity. */
120 void free_type(type *tp);
122 tp_op* get_type_tpop(type *tp);
123 ident* get_type_tpop_nameid(type *tp);
124 const char* get_type_tpop_name(type *tp);
125 tp_opcode get_type_tpop_code(type *tp);
127 ident* get_type_ident(type *tp);
128 void set_type_ident(type *tp, ident* id);
129 const char* get_type_name(type *tp);
131 /** The state of a type layout. */
133 layout_undefined, /**< The layout of this type is not defined.
134 Address computation to access fields is not
135 possible, fields must be accessed by Sel
136 nodes. This is the default value except for
137 pointer, primitive and method types. */
138 layout_fixed /**< The layout is fixed, all component/member entities
139 have an offset assigned. Size of the type is known.
140 Arrays can be accessed by explicit address
141 computation. Default for pointer, primitive ane method
145 /** Returns the type layout state of a type. */
146 type_state get_type_state(type *tp);
148 /** Sets the type layout state of a type.
150 * For primitives, pointer and method types the layout is always fixed.
151 * This call is legal but has no effect.
153 void set_type_state(type *tp, type_state state);
155 /** Returns the mode of a type.
157 * Returns NULL for all non atomic types.
159 ir_mode* get_type_mode(type *tp);
161 /** Sets the mode of a type.
163 * Only has an effect on primitive and enumeration types.
165 void set_type_mode(type *tp, ir_mode* m);
167 /** Returns the size of a type. */
168 int get_type_size(type *tp);
170 /** Sets the size of a type.
172 * For primitive, enumeration, pointer and method types the size
173 * is always fixed. This call is legal but has no effect.
175 void set_type_size(type *tp, int size);
178 unsigned long get_type_visited(type *tp);
179 void set_type_visited(type *tp, unsigned long num);
180 /* Sets visited field in type to type_visited. */
181 void mark_type_visited(type *tp);
182 /* @@@ name clash!! bool type_visited(type *tp); */
183 bool type_not_visited(type *tp);
185 void* get_type_link(type *tp);
186 void set_type_link(type *tp, void *l);
189 * Visited flag to traverse the type information.
191 * Increase this flag by one before traversing the type information.
192 * Mark type nodes as visited by set_type_visited(type, type_visited).
193 * Check whether node was already visited by comparing get_type_visited(type)
195 * Or use the function to walk all types.
199 extern unsigned long type_visited;
200 void set_master_type_visited(unsigned long val);
201 unsigned long get_master_type_visited(void);
202 void inc_master_type_visited(void);
205 * Checks whether a pointer points to a type.
207 * @param thing an arbitrary pointer
210 * true if the thing is a type, else false
212 int is_type (void *thing);
215 * Checks whether two types are structural equal.
217 * @param st pointer type
218 * @param lt pointer type
221 * true if the types are equal, else false.
222 * Types are equal if :
223 * - they are the same type kind
224 * - they have the same name
225 * - they have the same mode (if applicable)
226 * - they have the same type_state and, ev., the same size
227 * - they are class types and have
228 * - the same members (see same_entity in entity.h)
229 * - the same supertypes -- the C-pointers are compared --> no recursive call.
230 * - the same number of subtypes. Subtypes are not compared,
231 * as this could cause a cyclic test.
232 * - the same peculiarity
233 * - they are structure types and have the same members
234 * - they are method types and have
235 * - the same parameter types
236 * - the same result types
237 * - they are union types and have the same members
238 * - they are array types and have
239 * - the same number of dimensions
240 * - the same dimension bounds
241 * - the same dimension order
242 * - the same element type
243 * - they are enumeration types and have the same enumerator names
244 * - they are pointer types and have the identical points_to type
245 * (i.e., the same C-struct to represent the type, type_id is skipped.
246 * This is to avoid endless recursions; with pointer types circlic
247 * type graphs are possible.)
249 bool equal_type(type *tpy1, type *typ2);
252 * Checks whether two types are structural comparable.
254 * @param st pointer type
255 * @param lt pointer type
258 * true if type st is smaller than type lt, i.e. whenever
259 * lt is expected a st can be used.
261 * - they are the same type kind
262 * - mode(st) < mode (lt) (if applicable)
263 * - they are class types and st is (transitive) subtype of lt,
264 * - they are structure types and
265 * - the members of st have exactly one counterpart in lt with the same name,
266 * - the counterpart has a bigger type.
267 * - they are method types and have
268 * - the same number of parameter and result types,
269 * - the parameter types of st are smaller than those of lt,
270 * - the result types of st are smaller than those of lt
271 * - they are union types and have the members of st have exactly one
272 * @return counterpart in lt and the type is smaller
273 * - they are array types and have
274 * - the same number of dimensions
275 * - all bounds of lt are bound of st
276 * - the same dimension order
277 * - the same element type
279 * - the element type of st is smaller than that of lt
280 * - the element types have the same size and fixed layout.
281 * - they are enumeration types and have the same enumerator names
282 * - they are pointer types and have the points_to type of st is
283 * @return smaller than the points_to type of lt.
286 bool smaller_type (type *st, type *lt);
289 * @page class_type Representation of a class type
291 * If the type opcode is set to type_class the type represents class
292 * types. A list of fields and methods is associated with a class.
293 * Further a class can inherit from and bequest to other classes.
295 * The following attributes are private to this type kind:
296 * - member: All entities belonging to this class. This are methode entities
297 * which have type_method or fields that can have any of the
298 * following type kinds: type_class, type_struct, type_union,
299 * type_array, type_enumeration, type_pointer, type_primitive.
301 * The following two are dynamic lists that can be grown with an "add_" function,
304 * - subtypes: A list of direct subclasses.
306 * - supertypes: A list of direct superclasses.
308 * - peculiarity: The peculiarity of this class. If the class is of peculiarity
309 * "description" it only is a description of requirememts to a class,
310 * as, e.g., a Java interface. The class will never be allocated.
311 * Peculiatity inherited is only possible for entities. An entity
312 * is of peculiarity inherited if the compiler generated the entity
313 * to explicitly resolve inheritance. An inherited method entity has
315 * Values: description, existent, inherited. Default: existent.
319 /** Creates a new class type. */
320 type *new_type_class (ident *name);
322 /** Creates a new class type with debug information. */
323 type *new_d_type_class (ident *name, dbg_info *db);
325 /* --- manipulate private fields of class type --- */
327 /** Adds the entity as member of the class. */
328 void add_class_member (type *clss, entity *member);
330 /** Returns the number of members of this class. */
331 int get_class_n_members (type *clss);
333 /** Returns the member at position pos, 0 <= pos < n_member */
334 entity *get_class_member (type *clss, int pos);
336 /** Returns index of mem in clss, -1 if not contained. */
337 int get_class_member_index(type *clss, entity *mem);
339 /** Overwrites the member at position pos, 0 <= pos < n_member with
340 the passed entity. */
341 void set_class_member (type *clss, entity *member, int pos);
343 /** Replaces complete member list in class type by the list passed.
344 Copies the list passed. This function is necessary to reduce the number of members.
345 members is an array of entities, num the size of this array. Sets all
346 owners of the members passed to clss. */
347 void set_class_members (type *clss, entity *members[], int arity);
349 /** Finds member in the list of members and removes it.
350 Shrinks the member list, so iterate from the end!!!
351 Does not deallocate the entity. */
352 void remove_class_member(type *clss, entity *member);
355 /** Adds subtype as subtype to clss.
356 Checks whether clss is a supertype of subtype. If not
357 adds also clss as supertype to subtype. */
358 void add_class_subtype (type *clss, type *subtype);
360 /** Returns the number of subtypes */
361 int get_class_n_subtypes (type *clss);
363 /** Gets the subtype at position pos, 0 <= pos < n_subtype. */
364 type *get_class_subtype (type *clss, int pos);
366 /** Sets the subtype at positioin pos, 0 <= pos < n_subtype.
367 Does not set the corresponding supertype relation for subtype: this might
368 be a different position! */
369 void set_class_subtype (type *clss, type *subtype, int pos);
371 /** Finds subtype in the list of subtypes and removes it */
372 void remove_class_subtype(type *clss, type *subtype);
375 /** Adds supertype as supertype to class.
376 Checks whether clss is a subtype of supertype. If not
377 adds also clss as subtype to supertype. */
378 void add_class_supertype (type *clss, type *supertype);
380 /** Returns the number of supertypes */
381 int get_class_n_supertypes (type *clss);
383 /** Returns the index of an supertype in a type. */
384 int get_class_supertype_index(type *clss, type *super_clss);
386 /** Gets the supertype at position pos, 0 <= pos < n_supertype. */
387 type *get_class_supertype (type *clss, int pos);
389 /** Sets the supertype at postition pos, 0 <= pos < n_subtype.
390 Does not set the corresponding subtype relation for supertype: this might
391 be a different position! */
392 void set_class_supertype (type *clss, type *supertype, int pos);
394 /** Finds supertype in the list of supertypes and removes it */
395 void remove_class_supertype(type *clss, type *supertype);
397 /** This enumeration flags the peculiarity of entities and types. */
398 typedef enum peculiarity {
399 description, /**< Represents only a description. The entity/type is never
400 allocated, no code/data exists for this entity/type. */
401 inherited, /**< Describes explicitly that other entities are
402 inherited to the owner of this entity.
403 Overwrites must refer to at least one other
404 entity. If this is a method entity there exists
405 no irg for this entity, only for one of the
407 existent /**< The entity/type (can) exist. */
410 /* The peculiarity of the class. The enumeration peculiarity is defined
412 INLINE peculiarity get_class_peculiarity (type *clss);
413 INLINE void set_class_peculiarity (type *clss, peculiarity pec);
415 /* Set and get a class' dfn --
416 @todo This is an undocumented field, subject to change! */
417 void set_class_dfn (type *clss, int dfn);
418 int get_class_dfn (type *clss);
420 /** Returns true if a type is a class type. */
421 bool is_class_type(type *clss);
423 /** Returns true if low is subclass of high. */
424 bool is_subclass_of(type *low, type *high);
427 * @page struct_type Representation of a struct type
429 * Type_strct represents aggregate types that consist of a list
431 * The following attributes are private to this type kind:
432 * - member: All entities belonging to this class. This are the fields
433 * that can have any of the following types: type_class,
434 * type_struct, type_union, type_array, type_enumeration,
435 * type_pointer, type_primitive.
436 * This is a dynamic list that can be grown with an "add_" function,
438 * This is a dynamic list that can be grown with an "add_" function,
441 /** Creates a new type struct */
442 type *new_type_struct (ident *name);
443 /** Creates a new type struct with debug information. */
444 type *new_d_type_struct (ident *name, dbg_info* db);
446 /* manipulate private fields of struct */
447 void add_struct_member (type *strct, entity *member);
448 int get_struct_n_members (type *strct);
449 entity *get_struct_member (type *strct, int pos);
450 void set_struct_member (type *strct, int pos, entity *member);
452 /** Finds member in the list of members and removes it. */
453 void remove_struct_member (type *strct, entity *member);
455 /** Returns true if a type is a struct type. */
456 bool is_struct_type(type *strct);
459 * @page method_type Representation of a method type
461 * A method type represents a method, function or procedure type.
462 * It contains a list of the parameter and result types, as these
463 * are part of the type description. These lists should not
464 * be changed by a optimization, as a change creates a new method
465 * type. Therefore optimizations should allocated new method types.
466 * The set_ routines are only for construction by a frontend.
468 * - n_params: Number of parameters to the procedure.
469 * A procedure in FIRM has only call by value parameters.
471 * - param_type: A list with the types of parameters. This list is ordered.
472 * The nth type in this list corresponds to the nth element
473 * in the parameter tuple that is a result of the start node.
474 * (See ircons.h for more information.)
476 * - n_res: The number of results of the method. In general, procedures
477 * have zero results, functions one.
479 * - res_type: A list with the types of parameters. This list is ordered.
480 * The nth type in this list corresponds to the nth input to
481 * Return nodes. (See ircons.h for more information.)
484 /** Create a new method type.
486 * @param name the name (ident) of this type
487 * @param n_param the number of parameters
488 * @param n_res the number of results
490 * The arrays for the parameter and result types are not initialized by
493 type *new_type_method (ident *name, int n_param, int n_res);
495 /** Create a new method type with debug information.
497 * @param name the name (ident) of this type
498 * @param n_param the number of parameters
499 * @param n_res the number of results
500 * @param db user defined debug information
502 * The arrays for the parameter and result types are not initialized by
505 type *new_d_type_method (ident *name, int n_param, int n_res, dbg_info* db);
507 /* -- manipulate private fields of method. -- */
509 /** Returns the number of parameters of this method. */
510 int get_method_n_params (type *method);
512 /** Returns the type of the parameter at position pos of a method. */
513 type *get_method_param_type(type *method, int pos);
515 /** Sets the type of the parameter at position pos of a method. */
516 void set_method_param_type(type *method, int pos, type* tp);
518 int get_method_n_ress (type *method);
519 type *get_method_res_type(type *method, int pos);
520 void set_method_res_type(type *method, int pos, type* tp);
523 * this enum flags the variadicity of methods (methods with a
524 * variable amount of arguments (e.g. C's printf). Default is
527 typedef enum variadicity {
528 non_variadic, /**< non variadic */
529 variadic /**< variadic */
532 /** Returns the variadicity of a method. */
533 variadicity get_method_variadicity(type *method);
535 /** Sets the variadicity of a method. */
536 void set_method_variadicity(type *method, variadicity vari);
538 /** Returns true if a type is a method type. */
539 bool is_method_type (type *method);
542 * @page union_type Representation of a union type.
544 * The union type represents union types.
545 * - n_types: Number of unioned types.
546 * - members: Entities for unioned types. Fixed length array.
547 * This is a dynamic list that can be grown with an "add_" function,
550 /** Creates a new type union. */
551 type *new_type_union (ident *name);
553 /** Creates a new type union with debug information. */
554 type *new_d_type_union (ident *name, dbg_info* db);
556 /* --- manipulate private fields of struct --- */
558 /** Returns the number of unioned types of this union */
559 int get_union_n_members (type *uni);
561 /** Adds a new entity to a union type */
562 void add_union_member (type *uni, entity *member);
564 /** Returns the entity at position pos of a union */
565 entity *get_union_member (type *uni, int pos);
567 /** Overwrites a entity at position pos in a union type. */
568 void set_union_member (type *uni, int pos, entity *member);
570 /** Finds member in the list of members and removes it. */
571 void remove_union_member (type *uni, entity *member);
573 /** Returns true if a type is a union type. */
574 bool is_union_type (type *uni);
577 * @page array_type Representation of an array type
579 * The array type represents rectangular multi dimensional arrays.
580 * The constants representing the bounds must be allocated to
581 * get_const_code_irg() by setting current_ir_graph accordingly.
583 * - n_dimensions: Number of array dimensions.
584 * - *lower_bound: Lower bounds of dimensions. Usually all 0.
585 * - *upper_bound: Upper bounds or dimensions.
586 * - *element_type: The type of the array elements.
587 * - *element_ent: An entity for the array elements to be used for
588 * element selection with Sel.
590 * Do we need several entities? One might want
591 * to select a dimension and not a single element in case of multidim arrays.
594 /** Create a new type array.
596 * Sets n_dimension to dimension and all dimension entries to NULL.
597 * Initializes order to the order of the dimensions.
598 * The entity for array elements is built automatically.
599 * Set dimension sizes after call to constructor with set_* routines.
601 type *new_type_array (ident *name, int n_dimensions,
604 /** Create a new type array with debug information.
606 * Sets n_dimension to dimension and all dimension entries to NULL.
607 * Initializes order to the order of the dimensions.
608 * The entity for array elements is built automatically.
609 * Set dimension sizes after call to constructor with set_* routines.
611 type *new_d_type_array (ident *name, int n_dimensions,
612 type *element_type, dbg_info* db);
614 /* --- manipulate private fields of array type --- */
616 /** Returns the number of array dimensions of this type. */
617 int get_array_n_dimensions (type *array);
619 /** Allocates Const nodes of mode_I for the array dimensions */
620 void set_array_bounds_int (type *array, int dimension, int lower_bound,
622 void set_array_bounds (type *array, int dimension, ir_node *lower_bound,
623 ir_node *upper_bound);
624 void set_array_lower_bound (type *array, int dimension, ir_node *lower_bound);
625 void set_array_lower_bound_int (type *array, int dimension, int lower_bound);
626 void set_array_upper_bound (type *array, int dimension, ir_node *upper_bound);
627 void set_array_upper_bound_int (type *array, int dimension, int lower_bound);
628 ir_node * get_array_lower_bound (type *array, int dimension);
629 ir_node * get_array_upper_bound (type *array, int dimension);
631 void set_array_order (type *array, int dimension, int order);
632 int get_array_order (type *array, int dimension);
634 void set_array_element_type (type *array, type *tp);
635 type *get_array_element_type (type *array);
637 void set_array_element_entity (type *array, entity *ent);
638 entity *get_array_element_entity (type *array);
640 /** Returns true if a type is an array type. */
641 bool is_array_type (type *array);
644 * @page enumeration_type Representation of an enumeration type
646 * Enumeration types need not necessarily be represented explicitly
647 * by Firm types, as the frontend can lower them to integer constants as
648 * well. For debugging purposes or similar tasks this information is useful.
650 * - *enum: The target values representing the constants used to
651 * represent individual enumerations.
652 * - *enum_nameid: Idents containing the source program name of the enumeration
655 /** Create a new type enumeration -- set the enumerators independently. */
656 type *new_type_enumeration (ident *name, int n_enums);
658 /** Create a new type enumeration with debug information -- set the enumerators independently. */
659 type *new_d_type_enumeration (ident *name, int n_enums, dbg_info* db);
661 /* --- manipulate fields of enumeration type. --- */
663 /** Returns the number of enumeration values of this enumeration */
664 int get_enumeration_n_enums (type *enumeration);
666 /** Sets the enumeration value at a given position. */
667 void set_enumeration_enum (type *enumeration, int pos, tarval *con);
669 /** Returns the enumeration value at a given position. */
670 tarval *get_enumeration_enum (type *enumeration, int pos);
672 /** Assign an ident to an enumeration value at a given position. */
673 void set_enumeration_nameid (type *enumeration, int pos, ident *id);
675 /** Returns the assigned ident of an enumeration value at a given position. */
676 ident *get_enumeration_nameid (type *enumeration, int pos);
678 /** Returns the assigned name of an enumeration value at a given position. */
679 const char *get_enumeration_name(type *enumeration, int pos);
681 /** Returns true if a type is a enumeration type. */
682 bool is_enumeration_type (type *enumeration);
685 * @page pointer_type Representation of a pointer type
688 * - points_to: The type of the entity this pointer points to.
690 /** Creates a new type pointer. */
691 type *new_type_pointer (ident *name, type *points_to);
693 /** Creates a new type pointer with debug information. */
694 type *new_d_type_pointer (ident *name, type *points_to, dbg_info* db);
696 /* --- manipulate fields of type_pointer --- */
698 /** Sets the type to which a pointer points to. */
699 void set_pointer_points_to_type (type *pointer, type *tp);
701 /** Returns the type to which a pointer points to. */
702 type *get_pointer_points_to_type (type *pointer);
704 /** Returns true if a type is a pointer type. */
705 bool is_pointer_type (type *pointer);
708 * @page primitive_type Representation of a primitive type
710 * Primitive types are types that represent indivisible data values that
711 * map directly to modes. They don't have a private attribute. The
712 * important information they carry is held in the common mode field.
714 /** Creates a new primitive type. */
715 type *new_type_primitive (ident *name, ir_mode *mode);
717 /** Creates a new primitive type with debug information. */
718 type *new_d_type_primitive (ident *name, ir_mode *mode, dbg_info* db);
720 /** Returns true if a type is a primitive type. */
721 bool is_primitive_type (type *primitive);
725 * Checks whether a type is atomic.
726 * @param tp - any type
727 * @return true if type is primitive, pointer or enumeration
729 int is_atomic_type(type *tp);
731 /* --- Support for compound types --- */
734 * Gets the number of elements in a firm compound type.
736 * This is just a comforability function, because structs and
737 * classes can often be treated be the same code, but they have
738 * different access functions to their members.
740 * @param tp The type (must be struct, union or class).
742 * @return Number of members in the compound type.
744 int get_compound_n_members(type *tp);
747 * Gets the member of a firm compound type at position pos.
749 * @param tp The type (must be struct, union or class).
750 * @param pos The number of the member.
752 * @return The member entity at position pos.
754 * @see get_compound_n_members() for justifaction of existence.
756 entity *get_compound_member(type *tp, int pos);
759 * Checks whether a type is compound.
761 * @param tp - any type
763 * @return true if the type is class, structure, union or array type.
765 int is_compound_type(type *tp);
768 /** Outputs a unique number for this type if libfirm is compiled for
769 debugging, (configure with --enable-debug) else returns 0. */
770 INLINE long get_type_nr(type *tp);
772 # endif /* _TYPE_H_ */