5 * Project: libFIRM <br>
6 * File name: ir/tr/type.h <br>
7 * Purpose: Representation of types. <br>
8 * Author: Goetz Lindenmaier <br>
11 * Copyright: (c) 2001-2003 Universität Karlsruhe <br>
12 * Licence: This file protected by GPL - GNU GENERAL PUBLIC LICENSE. <br>
16 * Datastructure to hold type information.
18 * This module supplies a datastructure to represent all types
19 * known in the compiled program. This includes types specified
20 * in the program as well as types defined by the language. In the
21 * view of the intermediate representation there is no difference
22 * between these types. Finally it specifies some auxiliary types.
24 * There exist several kinds of types, arranged by the structure of
25 * the type. A type is described by a set of attributes. Some of
26 * these attributes are common to all types, others depend on the
29 * Types are different from the modes defined in irmode: Types are
30 * on the level of the programming language, modes at the level of
31 * the target processor.
42 # include "firm_common.h"
48 /* to resolve recursion between entity.h and type.h */
49 #ifndef _ENTITY_TYPEDEF_
50 #define _ENTITY_TYPEDEF_
51 typedef struct entity entity;
54 #ifndef _IR_NODE_TYPEDEF_
55 #define _IR_NODE_TYPEDEF_
56 typedef struct ir_node ir_node;
60 * An abstract data type to represent types.
62 * This is the abstract data type with which any type known in the
63 * compiled program can be represented. This includes types specified
64 * in the program as well as types defined by the language. In the
65 * view of the intermediate representation there is no difference
66 * between these types.
68 * There exist several kinds of types, arranged by the structure of
69 * the type. These are distinguished by a type opcode.
70 * A type is described by a set of attributes. Some of these attributes
71 * are common to all types, others depend on the kind of the type.
73 * The following describes the common attributes. They can only be
74 * accessed by the functions given below.
76 * The common fields are:
78 * - firm_kind: A firm_kind tag containing k_type. This is useful
79 * for dynamically checking whether a node is a type node.
80 * - type_op: A tp_op specifying the kind of the type.
81 * - mode: The mode to be used to represent the type on a machine.
82 * - name: An identifier specifying the name of the type. To be
83 * set by the frontend.
84 * - size: The size of the type, i.e. an entity of this type will
85 * occupy size bytes in memory. In several cases this is
86 * determined when fixing the layout of this type (class,
87 * struct, union, array, enumeration).
88 * - state: The state of the type. The state represents whether the
89 * layout of the type is undefined or fixed (values: layout_undefined
90 * or layout_fixed). Compound types can have an undefined
91 * layout. The layout of the basic types primitive and pointer
92 * is always layout_fixed. If the layout of
93 * compound types is fixed all entities must have an offset
94 * and the size of the type must be set.
95 * A fixed layout for enumeration types means that each enumeration
96 * is associated with an implementation value.
97 * - visit: A counter for walks of the type information.
98 * - link: A void* to associate some additional information with the type.
100 * These fields can only be accessed via access functions.
102 * Depending on the value of @c type_op, i.e., depending on the kind of the
103 * type the adt contains further attributes. These are documented below.
107 * @link class_type class @endlink, @link struct_type struct @endlink,
108 * @link method_type method @endlink, @link union_type union @endlink,
109 * @link array_type array @endlink, @link enumeration_type enumeration @endlink,
110 * @link pointer_type pointer @endlink, @link primitive_type primitive @endlink
113 * mode maybe not global field??
115 #ifndef _TYPE_TYPEDEF_
116 #define _TYPE_TYPEDEF_
117 typedef struct type type;
120 # include "type_or_entity.h"
122 /** Frees the memory used by the type. Does not free the entities
123 belonging to the type, except for the array element entity.
124 Does not free if tp is "none" or "unknown". */
125 void free_type(type *tp);
127 tp_op* get_type_tpop(type *tp);
128 ident* get_type_tpop_nameid(type *tp);
129 const char* get_type_tpop_name(type *tp);
130 tp_opcode get_type_tpop_code(type *tp);
132 ident* get_type_ident(type *tp);
133 void set_type_ident(type *tp, ident* id);
134 const char* get_type_name(type *tp);
136 /** The state of a type layout. */
138 layout_undefined, /**< The layout of this type is not defined.
139 Address computation to access fields is not
140 possible, fields must be accessed by Sel
141 nodes. This is the default value except for
142 pointer, primitive and method types. */
143 layout_fixed /**< The layout is fixed, all component/member entities
144 have an offset assigned. Size of the type is known.
145 Arrays can be accessed by explicit address
146 computation. Default for pointer, primitive and method
150 /** Returns the type layout state of a type. */
151 type_state get_type_state(type *tp);
153 /** Sets the type layout state of a type.
155 * For primitives, pointer and method types the layout is always fixed.
156 * This call is legal but has no effect.
158 void set_type_state(type *tp, type_state state);
160 /** Returns the mode of a type.
162 * Returns NULL for all non atomic types.
164 ir_mode* get_type_mode(type *tp);
166 /** Sets the mode of a type.
168 * Only has an effect on primitive, enumeration and pointer types.
170 void set_type_mode(type *tp, ir_mode* m);
172 /** Returns the size of a type. */
173 int get_type_size(type *tp);
175 /** Sets the size of a type.
177 * For primitive, enumeration, pointer and method types the size
178 * is always fixed. This call is legal but has no effect.
180 void set_type_size(type *tp, int size);
183 unsigned long get_type_visited(type *tp);
184 void set_type_visited(type *tp, unsigned long num);
185 /* Sets visited field in type to type_visited. */
186 void mark_type_visited(type *tp);
187 /* @@@ name clash!! bool type_visited(type *tp); */
188 bool type_not_visited(type *tp);
190 void* get_type_link(type *tp);
191 void set_type_link(type *tp, void *l);
194 * Visited flag to traverse the type information.
196 * Increase this flag by one before traversing the type information.
197 * Mark type nodes as visited by set_type_visited(type, type_visited).
198 * Check whether node was already visited by comparing get_type_visited(type)
200 * Or use the function to walk all types.
204 extern unsigned long type_visited;
205 void set_master_type_visited(unsigned long val);
206 unsigned long get_master_type_visited(void);
207 void inc_master_type_visited(void);
210 * Checks whether a pointer points to a type.
212 * @param thing an arbitrary pointer
215 * true if the thing is a type, else false
217 int is_type (void *thing);
220 * Checks whether two types are structural equal.
222 * @param st pointer type
223 * @param lt pointer type
226 * true if the types are equal, else false.
227 * Types are equal if :
228 * - they are the same type kind
229 * - they have the same name
230 * - they have the same mode (if applicable)
231 * - they have the same type_state and, ev., the same size
232 * - they are class types and have
233 * - the same members (see same_entity in entity.h)
234 * - the same supertypes -- the C-pointers are compared --> no recursive call.
235 * - the same number of subtypes. Subtypes are not compared,
236 * as this could cause a cyclic test.
237 * - the same peculiarity
238 * - they are structure types and have the same members
239 * - they are method types and have
240 * - the same parameter types
241 * - the same result types
242 * - they are union types and have the same members
243 * - they are array types and have
244 * - the same number of dimensions
245 * - the same dimension bounds
246 * - the same dimension order
247 * - the same element type
248 * - they are enumeration types and have the same enumerator names
249 * - they are pointer types and have the identical points_to type
250 * (i.e., the same C-struct to represent the type, type_id is skipped.
251 * This is to avoid endless recursions; with pointer types circlic
252 * type graphs are possible.)
254 bool equal_type(type *tpy1, type *typ2);
257 * Checks whether two types are structural comparable.
259 * @param st pointer type
260 * @param lt pointer type
263 * true if type st is smaller than type lt, i.e. whenever
264 * lt is expected a st can be used.
266 * - they are the same type kind
267 * - mode(st) < mode (lt) (if applicable)
268 * - they are class types and st is (transitive) subtype of lt,
269 * - they are structure types and
270 * - the members of st have exactly one counterpart in lt with the same name,
271 * - the counterpart has a bigger type.
272 * - they are method types and have
273 * - the same number of parameter and result types,
274 * - the parameter types of st are smaller than those of lt,
275 * - the result types of st are smaller than those of lt
276 * - they are union types and have the members of st have exactly one
277 * @return counterpart in lt and the type is smaller
278 * - they are array types and have
279 * - the same number of dimensions
280 * - all bounds of lt are bound of st
281 * - the same dimension order
282 * - the same element type
284 * - the element type of st is smaller than that of lt
285 * - the element types have the same size and fixed layout.
286 * - they are enumeration types and have the same enumerator names
287 * - they are pointer types and have the points_to type of st is
288 * @return smaller than the points_to type of lt.
291 bool smaller_type (type *st, type *lt);
294 * @page class_type Representation of a class type
296 * If the type opcode is set to type_class the type represents class
297 * types. A list of fields and methods is associated with a class.
298 * Further a class can inherit from and bequest to other classes.
300 * The following attributes are private to this type kind:
301 * - member: All entities belonging to this class. This are methode entities
302 * which have type_method or fields that can have any of the
303 * following type kinds: type_class, type_struct, type_union,
304 * type_array, type_enumeration, type_pointer, type_primitive.
306 * The following two are dynamic lists that can be grown with an "add_" function,
309 * - subtypes: A list of direct subclasses.
311 * - supertypes: A list of direct superclasses.
313 * - peculiarity: The peculiarity of this class. If the class is of peculiarity
314 * "description" it only is a description of requirememts to a class,
315 * as, e.g., a Java interface. The class will never be allocated.
316 * Peculiatity inherited is only possible for entities. An entity
317 * is of peculiarity inherited if the compiler generated the entity
318 * to explicitly resolve inheritance. An inherited method entity has
320 * Values: description, existent, inherited. Default: existent.
324 /** Creates a new class type. */
325 type *new_type_class (ident *name);
327 /** Creates a new class type with debug information. */
328 type *new_d_type_class (ident *name, dbg_info *db);
330 /* --- manipulate private fields of class type --- */
332 /** Adds the entity as member of the class. */
333 void add_class_member (type *clss, entity *member);
335 /** Returns the number of members of this class. */
336 int get_class_n_members (type *clss);
338 /** Returns the member at position pos, 0 <= pos < n_member */
339 entity *get_class_member (type *clss, int pos);
341 /** Returns index of mem in clss, -1 if not contained. */
342 int get_class_member_index(type *clss, entity *mem);
344 /** Overwrites the member at position pos, 0 <= pos < n_member with
345 the passed entity. */
346 void set_class_member (type *clss, entity *member, int pos);
348 /** Replaces complete member list in class type by the list passed.
349 Copies the list passed. This function is necessary to reduce the number of members.
350 members is an array of entities, num the size of this array. Sets all
351 owners of the members passed to clss. */
352 void set_class_members (type *clss, entity *members[], int arity);
354 /** Finds member in the list of members and removes it.
355 Shrinks the member list, so iterate from the end!!!
356 Does not deallocate the entity. */
357 void remove_class_member(type *clss, entity *member);
360 /** Adds subtype as subtype to clss.
361 Checks whether clss is a supertype of subtype. If not
362 adds also clss as supertype to subtype. */
363 void add_class_subtype (type *clss, type *subtype);
365 /** Returns the number of subtypes */
366 int get_class_n_subtypes (type *clss);
368 /** Gets the subtype at position pos, 0 <= pos < n_subtype. */
369 type *get_class_subtype (type *clss, int pos);
371 /** Sets the subtype at positioin pos, 0 <= pos < n_subtype.
372 Does not set the corresponding supertype relation for subtype: this might
373 be a different position! */
374 void set_class_subtype (type *clss, type *subtype, int pos);
376 /** Finds subtype in the list of subtypes and removes it */
377 void remove_class_subtype(type *clss, type *subtype);
380 /** Adds supertype as supertype to class.
381 Checks whether clss is a subtype of supertype. If not
382 adds also clss as subtype to supertype. */
383 void add_class_supertype (type *clss, type *supertype);
385 /** Returns the number of supertypes */
386 int get_class_n_supertypes (type *clss);
388 /** Returns the index of an supertype in a type. */
389 int get_class_supertype_index(type *clss, type *super_clss);
391 /** Gets the supertype at position pos, 0 <= pos < n_supertype. */
392 type *get_class_supertype (type *clss, int pos);
394 /** Sets the supertype at postition pos, 0 <= pos < n_subtype.
395 Does not set the corresponding subtype relation for supertype: this might
396 be a different position! */
397 void set_class_supertype (type *clss, type *supertype, int pos);
399 /** Finds supertype in the list of supertypes and removes it */
400 void remove_class_supertype(type *clss, type *supertype);
402 /** This enumeration flags the peculiarity of entities and types. */
403 typedef enum peculiarity {
404 peculiarity_description, /**< Represents only a description. The entity/type is never
405 allocated, no code/data exists for this entity/type. */
406 peculiarity_inherited, /**< Describes explicitly that other entities are
407 inherited to the owner of this entity.
408 Overwrites must refer to at least one other
409 entity. If this is a method entity there exists
410 no irg for this entity, only for one of the
413 peculiarity_existent /**< The entity/type (can) exist. */
415 char *get_peculiarity_string(peculiarity p);
417 /* The peculiarity of the class. The enumeration peculiarity is defined
419 INLINE peculiarity get_class_peculiarity (type *clss);
420 INLINE void set_class_peculiarity (type *clss, peculiarity pec);
422 /* Set and get a class' dfn --
423 @todo This is an undocumented field, subject to change! */
424 void set_class_dfn (type *clss, int dfn);
425 int get_class_dfn (type *clss);
427 /** Returns true if a type is a class type. */
428 bool is_class_type(type *clss);
430 /** Returns true if low is subclass of high. */
431 bool is_subclass_of(type *low, type *high);
434 * @page struct_type Representation of a struct type
436 * Type_strct represents aggregate types that consist of a list
438 * The following attributes are private to this type kind:
439 * - member: All entities belonging to this class. This are the fields
440 * that can have any of the following types: type_class,
441 * type_struct, type_union, type_array, type_enumeration,
442 * type_pointer, type_primitive.
443 * This is a dynamic list that can be grown with an "add_" function,
445 * This is a dynamic list that can be grown with an "add_" function,
448 /** Creates a new type struct */
449 type *new_type_struct (ident *name);
450 /** Creates a new type struct with debug information. */
451 type *new_d_type_struct (ident *name, dbg_info* db);
453 /* manipulate private fields of struct */
454 void add_struct_member (type *strct, entity *member);
455 int get_struct_n_members (type *strct);
456 entity *get_struct_member (type *strct, int pos);
457 void set_struct_member (type *strct, int pos, entity *member);
459 /** Finds member in the list of members and removes it. */
460 void remove_struct_member (type *strct, entity *member);
462 /** Returns true if a type is a struct type. */
463 bool is_struct_type(type *strct);
466 * @page method_type Representation of a method type
468 * A method type represents a method, function or procedure type.
469 * It contains a list of the parameter and result types, as these
470 * are part of the type description. These lists should not
471 * be changed by a optimization, as a change creates a new method
472 * type. Therefore optimizations should allocated new method types.
473 * The set_ routines are only for construction by a frontend.
475 * - n_params: Number of parameters to the procedure.
476 * A procedure in FIRM has only call by value parameters.
478 * - param_type: A list with the types of parameters. This list is ordered.
479 * The nth type in this list corresponds to the nth element
480 * in the parameter tuple that is a result of the start node.
481 * (See ircons.h for more information.)
484 * A list of entities (whose owner is a struct private to the
485 * method type) that represent parameters passed by value.
487 * - n_res: The number of results of the method. In general, procedures
488 * have zero results, functions one.
490 * - res_type: A list with the types of parameters. This list is ordered.
491 * The nth type in this list corresponds to the nth input to
492 * Return nodes. (See ircons.h for more information.)
495 * A list of entities (whose owner is a struct private to the
496 * method type) that represent results passed by value.
499 /* These makros define the suffixes for the types and entities used
500 to represent value parameters / results. */
501 #define VALUE_PARAMS_SUFFIX "val_param"
502 #define VALUE_RESS_SUFFIX "val_res"
504 /** Create a new method type.
506 * @param name the name (ident) of this type
507 * @param n_param the number of parameters
508 * @param n_res the number of results
510 * The arrays for the parameter and result types are not initialized by
513 type *new_type_method (ident *name, int n_param, int n_res);
515 /** Create a new method type with debug information.
517 * @param name the name (ident) of this type
518 * @param n_param the number of parameters
519 * @param n_res the number of results
520 * @param db user defined debug information
522 * The arrays for the parameter and result types are not initialized by
525 type *new_d_type_method (ident *name, int n_param, int n_res, dbg_info* db);
527 /* -- manipulate private fields of method. -- */
529 /** Returns the number of parameters of this method. */
530 int get_method_n_params (type *method);
532 /** Returns the type of the parameter at position pos of a method. */
533 type *get_method_param_type(type *method, int pos);
534 /** Sets the type of the parameter at position pos of a method.
535 Also changes the type in the pass-by-value representation by just
536 changing the type of the corresponding entity if the representation is constructed. */
537 void set_method_param_type(type *method, int pos, type* tp);
538 /* Returns an entity that represents the copied value argument. Only necessary
539 for compounds passed by value. This information is constructed only on demand. */
540 entity *get_method_value_param_ent(type *method, int pos);
542 int get_method_n_ress (type *method);
543 type *get_method_res_type(type *method, int pos);
544 /** Sets the type of the result at position pos of a method.
545 Also changes the type in the pass-by-value representation by just
546 changing the type of the corresponding entity if the representation is constructed. */
547 void set_method_res_type(type *method, int pos, type* tp);
548 /* Returns an entity that represents the copied value result. Only necessary
549 for compounds passed by value. This information is constructed only on demand. */
550 entity *get_method_value_res_ent(type *method, int pos);
553 type *get_method_value_res_type(type *method);
556 * this enum flags the variadicity of methods (methods with a
557 * variable amount of arguments (e.g. C's printf). Default is
560 typedef enum variadicity {
561 variadicity_non_variadic, /**< non variadic */
562 variadicity_variadic /**< variadic */
565 /** Returns the null-terminated name of this variadicity. */
566 const char *get_variadicity_name(variadicity vari);
568 /** Returns the variadicity of a method. */
569 variadicity get_method_variadicity(type *method);
571 /** Sets the variadicity of a method. */
572 void set_method_variadicity(type *method, variadicity vari);
574 /** Returns true if a type is a method type. */
575 bool is_method_type (type *method);
578 * @page union_type Representation of a union type.
580 * The union type represents union types.
581 * - n_types: Number of unioned types.
582 * - members: Entities for unioned types. Fixed length array.
583 * This is a dynamic list that can be grown with an "add_" function,
586 /** Creates a new type union. */
587 type *new_type_union (ident *name);
589 /** Creates a new type union with debug information. */
590 type *new_d_type_union (ident *name, dbg_info* db);
592 /* --- manipulate private fields of struct --- */
594 /** Returns the number of unioned types of this union */
595 int get_union_n_members (type *uni);
597 /** Adds a new entity to a union type */
598 void add_union_member (type *uni, entity *member);
600 /** Returns the entity at position pos of a union */
601 entity *get_union_member (type *uni, int pos);
603 /** Overwrites a entity at position pos in a union type. */
604 void set_union_member (type *uni, int pos, entity *member);
606 /** Finds member in the list of members and removes it. */
607 void remove_union_member (type *uni, entity *member);
609 /** Returns true if a type is a union type. */
610 bool is_union_type (type *uni);
613 * @page array_type Representation of an array type
615 * The array type represents rectangular multi dimensional arrays.
616 * The constants representing the bounds must be allocated to
617 * get_const_code_irg() by setting current_ir_graph accordingly.
619 * - n_dimensions: Number of array dimensions.
620 * - *lower_bound: Lower bounds of dimensions. Usually all 0.
621 * - *upper_bound: Upper bounds or dimensions.
622 * - *element_type: The type of the array elements.
623 * - *element_ent: An entity for the array elements to be used for
624 * element selection with Sel.
626 * Do we need several entities? One might want
627 * to select a dimension and not a single element in case of multidim arrays.
630 /** Create a new type array.
632 * Sets n_dimension to dimension and all dimension entries to NULL.
633 * Initializes order to the order of the dimensions.
634 * The entity for array elements is built automatically.
635 * Set dimension sizes after call to constructor with set_* routines.
637 type *new_type_array (ident *name, int n_dimensions,
640 /** Create a new type array with debug information.
642 * Sets n_dimension to dimension and all dimension entries to NULL.
643 * Initializes order to the order of the dimensions.
644 * The entity for array elements is built automatically.
645 * Set dimension sizes after call to constructor with set_* routines.
647 type *new_d_type_array (ident *name, int n_dimensions,
648 type *element_type, dbg_info* db);
650 /* --- manipulate private fields of array type --- */
652 /** Returns the number of array dimensions of this type. */
653 int get_array_n_dimensions (type *array);
655 /** Allocates Const nodes of mode_I for the array dimensions */
656 void set_array_bounds_int (type *array, int dimension, int lower_bound,
658 void set_array_bounds (type *array, int dimension, ir_node *lower_bound,
659 ir_node *upper_bound);
660 void set_array_lower_bound (type *array, int dimension, ir_node *lower_bound);
661 void set_array_lower_bound_int (type *array, int dimension, int lower_bound);
662 void set_array_upper_bound (type *array, int dimension, ir_node *upper_bound);
663 void set_array_upper_bound_int (type *array, int dimension, int lower_bound);
664 /* returns true if lower bound != Unknown */
665 int has_array_lower_bound (type *array, int dimension);
666 ir_node * get_array_lower_bound (type *array, int dimension);
667 int has_array_upper_bound (type *array, int dimension);
668 ir_node * get_array_upper_bound (type *array, int dimension);
670 void set_array_order (type *array, int dimension, int order);
671 int get_array_order (type *array, int dimension);
673 void set_array_element_type (type *array, type *tp);
674 type *get_array_element_type (type *array);
676 void set_array_element_entity (type *array, entity *ent);
677 entity *get_array_element_entity (type *array);
679 /** Returns true if a type is an array type. */
680 bool is_array_type (type *array);
683 * @page enumeration_type Representation of an enumeration type
685 * Enumeration types need not necessarily be represented explicitly
686 * by Firm types, as the frontend can lower them to integer constants as
687 * well. For debugging purposes or similar tasks this information is useful.
689 * - *enum: The target values representing the constants used to
690 * represent individual enumerations.
691 * - *enum_nameid: Idents containing the source program name of the enumeration
694 /** Create a new type enumeration -- set the enumerators independently. */
695 type *new_type_enumeration (ident *name, int n_enums);
697 /** Create a new type enumeration with debug information -- set the enumerators independently. */
698 type *new_d_type_enumeration (ident *name, int n_enums, dbg_info* db);
700 /* --- manipulate fields of enumeration type. --- */
702 /** Returns the number of enumeration values of this enumeration */
703 int get_enumeration_n_enums (type *enumeration);
705 /** Sets the enumeration value at a given position. */
706 void set_enumeration_enum (type *enumeration, int pos, tarval *con);
708 /** Returns the enumeration value at a given position. */
709 tarval *get_enumeration_enum (type *enumeration, int pos);
711 /** Assign an ident to an enumeration value at a given position. */
712 void set_enumeration_nameid (type *enumeration, int pos, ident *id);
714 /** Returns the assigned ident of an enumeration value at a given position. */
715 ident *get_enumeration_nameid (type *enumeration, int pos);
717 /** Returns the assigned name of an enumeration value at a given position. */
718 const char *get_enumeration_name(type *enumeration, int pos);
720 /** Returns true if a type is a enumeration type. */
721 bool is_enumeration_type (type *enumeration);
724 * @page pointer_type Representation of a pointer type
726 * The mode of the pointer type must be a mode_reference.
729 * - points_to: The type of the entity this pointer points to.
732 /** Creates a new type pointer with mode mode_p. */
733 #define new_type_pointer(N, P) new_type_pointer_mode(N, P, mode_P)
734 /* type *new_type_pointer (ident *name, type *points_to); */
736 /** Creates a new type pointer with given pointer mode. */
737 type *new_type_pointer_mode (ident *name, type *points_to, ir_mode *ptr_mode);
739 /** Creates a new type pointer given pointer mode and with debug information. */
740 type *new_d_type_pointer (ident *name, type *points_to, ir_mode *ptr_mode, dbg_info* db);
742 /* --- manipulate fields of type_pointer --- */
744 /** Sets the type to which a pointer points to. */
745 void set_pointer_points_to_type (type *pointer, type *tp);
747 /** Returns the type to which a pointer points to. */
748 type *get_pointer_points_to_type (type *pointer);
750 /** Returns true if a type is a pointer type. */
751 bool is_pointer_type (type *pointer);
753 /** Returns the first pointer type that has as points_to tp.
754 * Not efficient: O(#types).
755 * If not found returns unknown_type. */
756 type *find_pointer_type_to_type (type *tp);
759 * @page primitive_type Representation of a primitive type
761 * Primitive types are types that represent indivisible data values that
762 * map directly to modes. They don't have a private attribute. The
763 * important information they carry is held in the common mode field.
765 /** Creates a new primitive type. */
766 type *new_type_primitive (ident *name, ir_mode *mode);
768 /** Creates a new primitive type with debug information. */
769 type *new_d_type_primitive (ident *name, ir_mode *mode, dbg_info* db);
771 /** Returns true if a type is a primitive type. */
772 bool is_primitive_type (type *primitive);
778 * This type is an auxiliary type dedicated to support type analyses.
780 * The none type represents that there is no type. The type can be used to
781 * initialize fields of type* that actually can not contain a type or that
782 * are initialized for an analysis. There exists exactly one type none.
783 * This type is not on the type list in ir_prog. It is
784 * allocated when initializing the type module.
786 * The following values are set:
789 * state: layout_fixed
792 /* A variable that contains the only none type. */
793 extern type *none_type;
794 /* Returns the none type */
795 type *get_none_type(void);
800 * This type is an auxiliary type dedicated to support type analyses.
802 * The unknown type represents that there could be a type, but it is not
803 * known. This type can be used to initialize fields before an analysis (not known
804 * yet) or to represent the top of a lattice (could not be determined). There exists
805 * exactly one type unknown. This type is not on the type list in ir_prog. It is
806 * allocated when initializing the type module.
808 * The following values are set:
810 * name: "type_unknown"
811 * state: layout_fixed
814 /* A variable that contains the only unknown type. */
815 extern type *unknown_type;
816 /* Returns the none type */
817 type *get_unknown_type(void);
821 * Checks whether a type is atomic.
822 * @param tp - any type
823 * @return true if type is primitive, pointer or enumeration
825 int is_atomic_type(type *tp);
827 /* --- Support for compound types --- */
830 * Gets the number of elements in a firm compound type.
832 * This is just a comforability function, because structs and
833 * classes can often be treated be the same code, but they have
834 * different access functions to their members.
836 * @param tp The type (must be struct, union or class).
838 * @return Number of members in the compound type.
840 int get_compound_n_members(type *tp);
843 * Gets the member of a firm compound type at position pos.
845 * @param tp The type (must be struct, union or class).
846 * @param pos The number of the member.
848 * @return The member entity at position pos.
850 * @see get_compound_n_members() for justifaction of existence.
852 entity *get_compound_member(type *tp, int pos);
855 * Checks whether a type is compound.
857 * @param tp - any type
859 * @return true if the type is class, structure, union or array type.
861 int is_compound_type(type *tp);
865 * Outputs a unique number for this type if libfirm is compiled for
866 * debugging, (configure with --enable-debug) else returns the address
867 * of the type cast to long.
869 INLINE long get_type_nr(type *tp);
871 # endif /* _TYPE_H_ */