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"
47 /* to resolve recursion between entity.h and type.h */
48 #ifndef _ENTITY_TYPEDEF_
49 #define _ENTITY_TYPEDEF_
50 typedef struct entity entity;
53 #ifndef _IR_NODE_TYPEDEF_
54 #define _IR_NODE_TYPEDEF_
55 typedef struct ir_node ir_node;
58 # include "tr_inheritance.h"
61 * An abstract data type to represent types.
63 * This is the abstract data type with which any type known in the
64 * compiled program can be represented. This includes types specified
65 * in the program as well as types defined by the language. In the
66 * view of the intermediate representation there is no difference
67 * between these types.
69 * There exist several kinds of types, arranged by the structure of
70 * the type. These are distinguished by a type opcode.
71 * A type is described by a set of attributes. Some of these attributes
72 * are common to all types, others depend on the kind of the type.
74 * The following describes the common attributes. They can only be
75 * accessed by the functions given below.
77 * The common fields are:
79 * - firm_kind: A firm_kind tag containing k_type. This is useful
80 * for dynamically checking whether a node is a type node.
81 * - type_op: A tp_op specifying the kind of the type.
82 * - mode: The mode to be used to represent the type on a machine.
83 * - name: An identifier specifying the name of the type. To be
84 * set by the frontend.
85 * - size: The size of the type, i.e. an entity of this type will
86 * occupy size bits in memory. In several cases this is
87 * determined when fixing the layout of this type (class,
88 * struct, union, array, enumeration).
89 * - alignment The alignment of the type, i.e. an entity of this type will
90 * be allocated an an address in memory with this alignment.
91 * In several cases this is determined when fixing the layout
92 * of this type (class, struct, union, array)
93 * - state: The state of the type. The state represents whether the
94 * layout of the type is undefined or fixed (values: layout_undefined
95 * or layout_fixed). Compound types can have an undefined
96 * layout. The layout of the basic types primitive and pointer
97 * is always layout_fixed. If the layout of
98 * compound types is fixed all entities must have an offset
99 * and the size of the type must be set.
100 * A fixed layout for enumeration types means that each enumeration
101 * is associated with an implementation value.
102 * - visit: A counter for walks of the type information.
103 * - link: A void* to associate some additional information with the type.
105 * These fields can only be accessed via access functions.
107 * Depending on the value of @c type_op, i.e., depending on the kind of the
108 * type the adt contains further attributes. These are documented below.
112 * @link class_type class @endlink, @link struct_type struct @endlink,
113 * @link method_type method @endlink, @link union_type union @endlink,
114 * @link array_type array @endlink, @link enumeration_type enumeration @endlink,
115 * @link pointer_type pointer @endlink, @link primitive_type primitive @endlink
118 * mode maybe not global field??
120 #ifndef _TYPE_TYPEDEF_
121 #define _TYPE_TYPEDEF_
122 typedef struct type type;
125 # include "type_or_entity.h"
127 /** frees all entities associated with a type.
128 Does not free array entity.
129 Warning: make sure these entities are not referenced anywhere else.
131 void free_type_entities(type *tp);
133 /** Frees the memory used by the type.
135 * Removes the type from the type list. Does not free the entities
136 * belonging to the type, except for the array element entity. Does
137 * not free if tp is "none" or "unknown". Frees entities in value
138 * param subtypes of method types!!! Make sure these are not
139 * referenced any more. Further make sure there is no pointer type
140 * that refers to this type. */
141 void free_type(type *tp);
143 const tp_op*get_type_tpop(const type *tp);
144 ident* get_type_tpop_nameid(const type *tp);
145 const char* get_type_tpop_name(const type *tp);
146 tp_opcode get_type_tpop_code(const type *tp);
148 ident* get_type_ident(const type *tp);
149 void set_type_ident(type *tp, ident* id);
150 const char* get_type_name(const type *tp);
152 /** The state of the type layout. */
154 layout_undefined, /**< The layout of this type is not defined.
155 Address computation to access fields is not
156 possible, fields must be accessed by Sel
157 nodes. This is the default value except for
158 pointer, primitive and method types. */
159 layout_fixed /**< The layout is fixed, all component/member entities
160 have an offset assigned. Size of the type is known.
161 Arrays can be accessed by explicit address
162 computation. Default for pointer, primitive and method
166 /** Returns a human readable string for the enum entry. */
167 const char *get_type_state_name(type_state s);
169 /** Returns the type layout state of a type. */
170 type_state get_type_state(const type *tp);
172 /** Sets the type layout state of a type.
174 * For primitives, pointer and method types the layout is always fixed.
175 * This call is legal but has no effect.
177 void set_type_state(type *tp, type_state state);
179 /** Returns the mode of a type.
181 * Returns NULL for all non atomic types.
183 ir_mode* get_type_mode(const type *tp);
185 /** Sets the mode of a type.
187 * Only has an effect on primitive, enumeration and pointer types.
189 void set_type_mode(type *tp, ir_mode* m);
191 /** Returns the size of a type in bytes, returns -1 if the size is NOT
192 * a byte size, ie not dividable by 8. */
193 int get_type_size_bytes(const type *tp);
195 /** Returns the size of a type in bits. */
196 int get_type_size_bits(const type *tp);
198 /** Sets the size of a type in bytes.
200 * For primitive, enumeration, pointer and method types the size
201 * is always fixed. This call is legal but has no effect.
203 void set_type_size_bytes(type *tp, int size);
205 /** Sets the size of a type in bits.
207 * For primitive, enumeration, pointer and method types the size
208 * is always fixed. This call is legal but has no effect.
210 void set_type_size_bits(type *tp, int size);
212 /** Returns the alignment of a type in bytes.
214 * Returns -1 if the alignment is NOT
215 * a byte size, i.e. not dividable by 8. Calls get_type_alignment_bits(). */
216 int get_type_alignment_bytes(type *tp);
218 /** Returns the alignment of a type in bits.
220 * If the alignment of a type is
221 * not set, it is calculated here according to the following rules:
222 * 1.) if a type has a mode, the alignment is the mode size.
223 * 2.) compound types have the alignment of it's biggest member.
224 * 3.) array types have the alignment of its element type.
225 * 4.) method types return 0 here.
226 * 5.) all other types return 8 here (i.e. aligned at byte).
228 int get_type_alignment_bits(type *tp);
230 /** Sets the alignment of a type in bytes. */
231 void set_type_alignment_bytes(type *tp, int size);
233 /** Sets the alignment of a type in bits.
235 * For method types the alignment is always fixed.
236 * This call is legal but has no effect.
238 void set_type_alignment_bits(type *tp, int size);
240 unsigned long get_type_visited(const type *tp);
241 void set_type_visited(type *tp, unsigned long num);
242 /* Sets visited field in type to type_visited. */
243 void mark_type_visited(type *tp);
244 /* @@@ name clash!! int type_visited(const type *tp); */
245 int type_not_visited(const type *tp);
247 void* get_type_link(const type *tp);
248 void set_type_link(type *tp, void *l);
251 * Visited flag to traverse the type information.
253 * Increase this flag by one before traversing the type information.
254 * Mark type nodes as visited by set_type_visited(type, type_visited).
255 * Check whether node was already visited by comparing get_type_visited(type)
257 * Or use the function to walk all types.
261 extern unsigned long type_visited;
262 void set_master_type_visited(unsigned long val);
263 unsigned long get_master_type_visited(void);
264 void inc_master_type_visited(void);
267 * Checks whether a pointer points to a type.
269 * @param thing an arbitrary pointer
272 * true if the thing is a type, else false
274 int is_type (const void *thing);
277 * Checks whether two types are structurally equal.
279 * @param st pointer type
280 * @param lt pointer type
283 * true if the types are equal, else false.
284 * Types are equal if :
285 * - they are the same type kind
286 * - they have the same name
287 * - they have the same mode (if applicable)
288 * - they have the same type_state and, ev., the same size
289 * - they are class types and have
290 * - the same members (see same_entity in entity.h)
291 * - the same supertypes -- the C-pointers are compared --> no recursive call.
292 * - the same number of subtypes. Subtypes are not compared,
293 * as this could cause a cyclic test.
294 * - the same peculiarity
295 * - they are structure types and have the same members
296 * - they are method types and have
297 * - the same parameter types
298 * - the same result types
299 * - they are union types and have the same members
300 * - they are array types and have
301 * - the same number of dimensions
302 * - the same dimension bounds
303 * - the same dimension order
304 * - the same element type
305 * - they are enumeration types and have the same enumerator names
306 * - they are pointer types and have the identical points_to type
307 * (i.e., the same C-struct to represent the type, type_id is skipped.
308 * This is to avoid endless recursions; with pointer types circlic
309 * type graphs are possible.)
311 int equal_type(type *tpy1, type *typ2);
314 * Checks whether two types are structural comparable.
316 * @param st pointer type
317 * @param lt pointer type
320 * true if type st is smaller than type lt, i.e. whenever
321 * lt is expected a st can be used.
323 * - they are the same type kind
324 * - mode(st) < mode (lt) (if applicable)
325 * - they are class types and st is (transitive) subtype of lt,
326 * - they are structure types and
327 * - the members of st have exactly one counterpart in lt with the same name,
328 * - the counterpart has a bigger type.
329 * - they are method types and have
330 * - the same number of parameter and result types,
331 * - the parameter types of st are smaller than those of lt,
332 * - the result types of st are smaller than those of lt
333 * - they are union types and have the members of st have exactly one
334 * @return counterpart in lt and the type is smaller
335 * - they are array types and have
336 * - the same number of dimensions
337 * - all bounds of lt are bound of st
338 * - the same dimension order
339 * - the same element type
341 * - the element type of st is smaller than that of lt
342 * - the element types have the same size and fixed layout.
343 * - they are enumeration types and have the same enumerator names
344 * - they are pointer types and have the points_to type of st is
345 * @return smaller than the points_to type of lt.
348 int smaller_type (type *st, type *lt);
351 * @page class_type Representation of a class type
353 * If the type opcode is set to type_class the type represents class
354 * types. A list of fields and methods is associated with a class.
355 * Further a class can inherit from and bequest to other classes.
357 * The following attributes are private to this type kind:
358 * - member: All entities belonging to this class. This are methode entities
359 * which have type_method or fields that can have any of the
360 * following type kinds: type_class, type_struct, type_union,
361 * type_array, type_enumeration, type_pointer, type_primitive.
363 * The following two are dynamic lists that can be grown with an "add_" function,
366 * - subtypes: A list of direct subclasses.
368 * - supertypes: A list of direct superclasses.
370 * - peculiarity: The peculiarity of this class. If the class is of peculiarity
371 * "description" it only is a description of requirements to a class,
372 * as, e.g., a Java interface. The class will never be allocated.
373 * Peculiarity inherited is only possible for entities. An entity
374 * is of peculiarity inherited if the compiler generated the entity
375 * to explicitly resolve inheritance. An inherited method entity has
377 * Values: description, existent, inherited. Default: existent.
381 /** Creates a new class type. */
382 type *new_type_class (ident *name);
384 /** Creates a new class type with debug information. */
385 type *new_d_type_class (ident *name, dbg_info *db);
387 /* --- manipulate private fields of class type --- */
389 /** Adds the entity as member of the class. */
390 void add_class_member (type *clss, entity *member);
392 /** Returns the number of members of this class. */
393 int get_class_n_members (const type *clss);
395 /** Returns the member at position pos, 0 <= pos < n_member */
396 entity *get_class_member (const type *clss, int pos);
398 /** Returns index of mem in clss, -1 if not contained. */
399 int get_class_member_index(type *clss, entity *mem);
401 /** Finds the member with name 'name'. If several members with the same
402 * name returns one of them. Returns NULL if no member found. */
403 entity *get_class_member_by_name(type *clss, ident *name);
405 /** Overwrites the member at position pos, 0 <= pos < n_member with
406 * the passed entity. */
407 void set_class_member (type *clss, entity *member, int pos);
409 /** Replaces complete member list in class type by the list passed.
411 * Copies the list passed. This function is necessary to reduce the number of members.
412 * members is an array of entities, num the size of this array. Sets all
413 * owners of the members passed to clss. */
414 void set_class_members (type *clss, entity *members[], int arity);
416 /** Finds member in the list of members and removes it.
418 * Shrinks the member list, so iterate from the end!!!
419 * Does not deallocate the entity. */
420 void remove_class_member(type *clss, entity *member);
423 /** Adds subtype as subtype to clss.
425 * Checks whether clss is a supertype of subtype. If not
426 * adds also clss as supertype to subtype. */
427 void add_class_subtype (type *clss, type *subtype);
429 /** Returns the number of subtypes */
430 int get_class_n_subtypes (const type *clss);
432 /** Gets the subtype at position pos, 0 <= pos < n_subtype. */
433 type *get_class_subtype (type *clss, int pos);
435 /** Sets the subtype at position pos, 0 <= pos < n_subtype.
437 * Does not set the corresponding supertype relation for subtype: this might
438 * be a different position! */
439 void set_class_subtype (type *clss, type *subtype, int pos);
441 /** Finds subtype in the list of subtypes and removes it */
442 void remove_class_subtype(type *clss, type *subtype);
445 /** Adds supertype as supertype to class.
447 * Checks whether clss is a subtype of supertype. If not
448 * adds also clss as subtype to supertype. */
449 void add_class_supertype (type *clss, type *supertype);
451 /** Returns the number of supertypes */
452 int get_class_n_supertypes (const type *clss);
454 /** Returns the index of an supertype in a type. */
455 int get_class_supertype_index(type *clss, type *super_clss);
457 /** Gets the supertype at position pos, 0 <= pos < n_supertype. */
458 type *get_class_supertype (type *clss, int pos);
460 /** Sets the supertype at position pos, 0 <= pos < n_supertype.
462 * Does not set the corresponding subtype relation for supertype: this might
463 * be at a different position! */
464 void set_class_supertype (type *clss, type *supertype, int pos);
466 /** Finds supertype in the list of supertypes and removes it */
467 void remove_class_supertype(type *clss, type *supertype);
469 /** This enumeration flags the peculiarity of entities and types. */
470 typedef enum peculiarity {
471 peculiarity_description, /**< Represents only a description. The entity/type is never
472 allocated, no code/data exists for this entity/type.
473 @@@ eventually rename to descriptive (adjective as the others!)*/
474 peculiarity_inherited, /**< Describes explicitly that other entities are
475 inherited to the owner of this entity.
476 Overwrites must refer to at least one other
477 entity. If this is a method entity there exists
478 no irg for this entity, only for one of the
481 peculiarity_existent /**< The entity/type (can) exist.
482 @@@ eventually rename to 'real' i.e., 'echt'
483 This serves better as opposition to description _and_ inherited.*/
485 const char *get_peculiarity_string(peculiarity p);
487 /* The peculiarity of the class. The enumeration peculiarity is defined
489 peculiarity get_class_peculiarity (const type *clss);
490 void set_class_peculiarity (type *clss, peculiarity pec);
492 /* Set and get a class' dfn --
493 @todo This is an undocumented field, subject to change! */
494 void set_class_dfn (type *clss, int dfn);
495 int get_class_dfn (const type *clss);
497 /** Returns true if a type is a class type. */
498 int is_Class_type(const type *clss);
501 * @page struct_type Representation of a struct type
503 * Type_strct represents aggregate types that consist of a list
505 * The following attributes are private to this type kind:
506 * - member: All entities belonging to this class. This are the fields
507 * that can have any of the following types: type_class,
508 * type_struct, type_union, type_array, type_enumeration,
509 * type_pointer, type_primitive.
510 * This is a dynamic list that can be grown with an "add_" function,
512 * This is a dynamic list that can be grown with an "add_" function,
515 /** Creates a new type struct */
516 type *new_type_struct (ident *name);
517 /** Creates a new type struct with debug information. */
518 type *new_d_type_struct (ident *name, dbg_info* db);
520 /* --- manipulate private fields of struct --- */
522 /** Adds the entity as member of the struct. */
523 void add_struct_member (type *strct, entity *member);
525 /** Returns the number of members of this struct. */
526 int get_struct_n_members (const type *strct);
528 /** Returns the member at position pos, 0 <= pos < n_member */
529 entity *get_struct_member (const type *strct, int pos);
531 /** Returns index of member in strct, -1 if not contained. */
532 int get_struct_member_index(type *strct, entity *member);
534 /** Overwrites the member at position pos, 0 <= pos < n_member with
535 the passed entity. */
536 void set_struct_member (type *strct, int pos, entity *member);
538 /** Finds member in the list of members and removes it. */
539 void remove_struct_member (type *strct, entity *member);
541 /** Returns true if a type is a struct type. */
542 int is_Struct_type(const type *strct);
545 * @page method_type Representation of a method type
547 * A method type represents a method, function or procedure type.
548 * It contains a list of the parameter and result types, as these
549 * are part of the type description. These lists should not
550 * be changed by a optimization, as a change creates a new method
551 * type. Therefore optimizations should allocated new method types.
552 * The set_ routines are only for construction by a frontend.
554 * - n_params: Number of parameters to the procedure.
555 * A procedure in FIRM has only call by value parameters.
557 * - param_type: A list with the types of parameters. This list is ordered.
558 * The nth type in this list corresponds to the nth element
559 * in the parameter tuple that is a result of the start node.
560 * (See ircons.h for more information.)
563 * A list of entities (whose owner is a struct private to the
564 * method type) that represent parameters passed by value.
566 * - n_res: The number of results of the method. In general, procedures
567 * have zero results, functions one.
569 * - res_type: A list with the types of parameters. This list is ordered.
570 * The nth type in this list corresponds to the nth input to
571 * Return nodes. (See ircons.h for more information.)
574 * A list of entities (whose owner is a struct private to the
575 * method type) that represent results passed by value.
578 /* These macros define the suffixes for the types and entities used
579 to represent value parameters / results. */
580 #define VALUE_PARAMS_SUFFIX "val_param"
581 #define VALUE_RESS_SUFFIX "val_res"
583 /** Create a new method type.
585 * @param name the name (ident) of this type
586 * @param n_param the number of parameters
587 * @param n_res the number of results
589 * The arrays for the parameter and result types are not initialized by
592 type *new_type_method (ident *name, int n_param, int n_res);
594 /** Create a new method type with debug information.
596 * @param name the name (ident) of this type
597 * @param n_param the number of parameters
598 * @param n_res the number of results
599 * @param db user defined debug information
601 * The arrays for the parameter and result types are not initialized by
604 type *new_d_type_method (ident *name, int n_param, int n_res, dbg_info* db);
606 /* -- manipulate private fields of method. -- */
608 /** Returns the number of parameters of this method. */
609 int get_method_n_params (const type *method);
611 /** Returns the type of the parameter at position pos of a method. */
612 type *get_method_param_type(type *method, int pos);
613 /** Sets the type of the parameter at position pos of a method.
614 Also changes the type in the pass-by-value representation by just
615 changing the type of the corresponding entity if the representation is constructed. */
616 void set_method_param_type(type *method, int pos, type* tp);
617 /** Returns an entity that represents the copied value argument. Only necessary
618 for compounds passed by value. This information is constructed only on demand. */
619 entity *get_method_value_param_ent(type *method, int pos);
621 * Returns a type that represents the copied value arguments.
623 type *get_method_value_param_type(const type *method);
625 int get_method_n_ress (const type *method);
626 type *get_method_res_type(type *method, int pos);
627 /** Sets the type of the result at position pos of a method.
628 Also changes the type in the pass-by-value representation by just
629 changing the type of the corresponding entity if the representation is constructed. */
630 void set_method_res_type(type *method, int pos, type* tp);
631 /** Returns an entity that represents the copied value result. Only necessary
632 for compounds passed by value. This information is constructed only on demand. */
633 entity *get_method_value_res_ent(type *method, int pos);
636 * Returns a type that represents the copied value results.
638 type *get_method_value_res_type(const type *method);
641 * this enum flags the variadicity of methods (methods with a
642 * variable amount of arguments (e.g. C's printf). Default is
645 typedef enum variadicity {
646 variadicity_non_variadic, /**< non variadic */
647 variadicity_variadic /**< variadic */
650 /** Returns the null-terminated name of this variadicity. */
651 const char *get_variadicity_name(variadicity vari);
653 /** Returns the variadicity of a method. */
654 variadicity get_method_variadicity(const type *method);
656 /** Sets the variadicity of a method. */
657 void set_method_variadicity(type *method, variadicity vari);
660 * Returns the first variadic parameter index of a type.
661 * If this index was NOT set, the index of the last parameter
662 * of the method type plus one is returned for variadic functions.
663 * Non-variadic function types always return -1 here.
665 int get_method_first_variadic_param_index(const type *method);
668 * Sets the first variadic parameter index. This allows to specify
669 * a complete call type (containing the type of all parameters)
670 * but still have the knowledge, which parameter must be passed as
673 void set_method_first_variadic_param_index(type *method, int index);
675 /** Returns true if a type is a method type. */
676 int is_Method_type (const type *method);
679 * @page union_type Representation of a union type.
681 * The union type represents union types.
682 * - n_types: Number of unioned types.
683 * - members: Entities for unioned types. Fixed length array.
684 * This is a dynamic list that can be grown with an "add_" function,
687 /** Creates a new type union. */
688 type *new_type_union (ident *name);
690 /** Creates a new type union with debug information. */
691 type *new_d_type_union (ident *name, dbg_info* db);
693 /* --- manipulate private fields of struct --- */
695 /** Returns the number of unioned types of this union */
696 int get_union_n_members (const type *uni);
698 /** Adds a new entity to a union type */
699 void add_union_member (type *uni, entity *member);
701 /** Returns the entity at position pos of a union */
702 entity *get_union_member (const type *uni, int pos);
704 /** Overwrites a entity at position pos in a union type. */
705 void set_union_member (type *uni, int pos, entity *member);
707 /** Finds member in the list of members and removes it. */
708 void remove_union_member (type *uni, entity *member);
710 /** Returns true if a type is a union type. */
711 int is_Union_type (const type *uni);
714 * @page array_type Representation of an array type
716 * The array type represents rectangular multi dimensional arrays.
717 * The constants representing the bounds must be allocated to
718 * get_const_code_irg() by setting current_ir_graph accordingly.
720 * - n_dimensions: Number of array dimensions.
721 * - *lower_bound: Lower bounds of dimensions. Usually all 0.
722 * - *upper_bound: Upper bounds or dimensions.
723 * - *element_type: The type of the array elements.
724 * - *element_ent: An entity for the array elements to be used for
725 * element selection with Sel.
727 * Do we need several entities? One might want
728 * to select a dimension and not a single element in case of multi
729 * dimensional arrays.
732 /** Create a new type array.
734 * Sets n_dimension to dimension and all dimension entries to NULL.
735 * Initializes order to the order of the dimensions.
736 * The entity for array elements is built automatically.
737 * Set dimension sizes after call to constructor with set_* routines.
739 type *new_type_array (ident *name, int n_dimensions,
742 /** Create a new type array with debug information.
744 * Sets n_dimension to dimension and all dimension entries to NULL.
745 * Initializes order to the order of the dimensions.
746 * The entity for array elements is built automatically.
747 * Set dimension sizes after call to constructor with set_* routines.
748 * A legal array type must have at least one dimension set.
750 type *new_d_type_array (ident *name, int n_dimensions,
751 type *element_type, dbg_info* db);
753 /* --- manipulate private fields of array type --- */
755 /** Returns the number of array dimensions of this type. */
756 int get_array_n_dimensions (const type *array);
759 * Allocates Const nodes of mode_I for one array dimension.
760 * Upper bound in Firm is the element next to the last, ie [lower,upper[
762 void set_array_bounds_int (type *array, int dimension, int lower_bound,
765 * Sets the bounds for one array dimension.
766 * Upper bound in Firm is the element next to the last, ie [lower,upper[
768 void set_array_bounds (type *array, int dimension, ir_node *lower_bound,
769 ir_node *upper_bound);
770 /** Sets the lower bound for one array dimension, ie [lower,upper[ */
771 void set_array_lower_bound (type *array, int dimension, ir_node *lower_bound);
773 /** Allocates Const nodes of mode_I for the lower bound of an array
774 dimension, ie [lower,upper[ */
775 void set_array_lower_bound_int (type *array, int dimension, int lower_bound);
777 /** Sets the upper bound for one array dimension, ie [lower,upper[ */
778 void set_array_upper_bound (type *array, int dimension, ir_node *upper_bound);
780 /** Allocates Const nodes of mode_I for the upper bound of an array
781 dimension, ie [lower,upper[ */
782 void set_array_upper_bound_int (type *array, int dimension, int upper_bound);
784 /** returns true if lower bound != Unknown */
785 int has_array_lower_bound (const type *array, int dimension);
786 ir_node * get_array_lower_bound (const type *array, int dimension);
787 /** Works only if bound is Const node with tarval that can be converted to long. */
788 long get_array_lower_bound_int (const type *array, int dimension);
789 /** returns true if lower bound != Unknown */
790 int has_array_upper_bound (const type *array, int dimension);
791 ir_node * get_array_upper_bound (const type *array, int dimension);
792 /** Works only if bound is Const node with tarval that can be converted to long. */
793 long get_array_upper_bound_int (const type *array, int dimension);
795 /** Sets an array dimension to a specific order. */
796 void set_array_order (type *array, int dimension, int order);
798 /** Returns the order of an array dimension. */
799 int get_array_order (const type *array, int dimension);
801 /** Find the array dimension that is placed at order ord. */
802 int find_array_dimension(const type *array, int order);
804 /** Sets the array element type. */
805 void set_array_element_type (type *array, type *tp);
807 /** Gets the array element type. */
808 type *get_array_element_type (type *array);
810 /** Sets the array element entity. */
811 void set_array_element_entity (type *array, entity *ent);
813 /** Get the array element entity. */
814 entity *get_array_element_entity (const type *array);
816 /** Returns true if a type is an array type. */
817 int is_Array_type(const type *array);
820 * @page enumeration_type Representation of an enumeration type
822 * Enumeration types need not necessarily be represented explicitly
823 * by Firm types, as the frontend can lower them to integer constants as
824 * well. For debugging purposes or similar tasks this information is useful.
826 * - *enum: The target values representing the constants used to
827 * represent individual enumerations.
828 * - *enum_nameid: Idents containing the source program name of the enumeration
831 /** Create a new type enumeration -- set the enumerators independently. */
832 type *new_type_enumeration (ident *name, int n_enums);
834 /** Create a new type enumeration with debug information -- set the enumerators independently. */
835 type *new_d_type_enumeration (ident *name, int n_enums, dbg_info* db);
837 /* --- manipulate fields of enumeration type. --- */
839 /** Returns the number of enumeration values of this enumeration */
840 int get_enumeration_n_enums (const type *enumeration);
842 /** Sets the enumeration value at a given position. */
843 void set_enumeration_enum (type *enumeration, int pos, tarval *con);
845 /** Returns the enumeration value at a given position. */
846 tarval *get_enumeration_enum (const type *enumeration, int pos);
848 /** Assign an ident to an enumeration value at a given position. */
849 void set_enumeration_nameid (type *enumeration, int pos, ident *id);
851 /** Returns the assigned ident of an enumeration value at a given position. */
852 ident *get_enumeration_nameid (const type *enumeration, int pos);
854 /** Returns the assigned name of an enumeration value at a given position. */
855 const char *get_enumeration_name(const type *enumeration, int pos);
857 /** Returns true if a type is a enumeration type. */
858 int is_Enumeration_type (const type *enumeration);
861 * @page pointer_type Representation of a pointer type
863 * The mode of the pointer type must be a mode_reference.
866 * - points_to: The type of the entity this pointer points to.
869 /** Creates a new type pointer with mode mode_p. */
870 #define new_type_pointer(N, P) new_type_pointer_mode(N, P, mode_P_mach)
872 /** Creates a new type pointer with given pointer mode. */
873 type *new_type_pointer_mode (ident *name, type *points_to, ir_mode *ptr_mode);
875 /** Creates a new type pointer given pointer mode and with debug information. */
876 type *new_d_type_pointer (ident *name, type *points_to, ir_mode *ptr_mode, dbg_info* db);
878 /* --- manipulate fields of type_pointer --- */
880 /** Sets the type to which a pointer points to. */
881 void set_pointer_points_to_type (type *pointer, type *tp);
883 /** Returns the type to which a pointer points to. */
884 type *get_pointer_points_to_type (type *pointer);
886 /** Returns true if a type is a pointer type. */
887 int is_Pointer_type (const type *pointer);
889 /** Returns the first pointer type that has as points_to tp.
890 * Not efficient: O(#types).
891 * If not found returns unknown_type. */
892 type *find_pointer_type_to_type (type *tp);
895 * @page primitive_type Representation of a primitive type
897 * Primitive types are types that represent indivisible data values that
898 * map directly to modes. They don't have a private attribute. The
899 * important information they carry is held in the common mode field.
901 /** Creates a new primitive type. */
902 type *new_type_primitive (ident *name, ir_mode *mode);
904 /** Creates a new primitive type with debug information. */
905 type *new_d_type_primitive (ident *name, ir_mode *mode, dbg_info* db);
907 /** Returns true if a type is a primitive type. */
908 int is_Primitive_type (const type *primitive);
914 * This type is an auxiliary type dedicated to support type analyses.
916 * The none type represents that there is no type. The type can be used to
917 * initialize fields of type* that actually can not contain a type or that
918 * are initialized for an analysis. There exists exactly one type none.
919 * This type is not on the type list in ir_prog. It is
920 * allocated when initializing the type module.
922 * The following values are set:
925 * state: layout_fixed
928 /* A variable that contains the only none type. */
929 extern type *firm_none_type;
930 /* Returns the none type */
931 type *get_none_type(void);
936 * This type is an auxiliary type dedicated to support type analyses.
938 * The unknown type represents that there could be a type, but it is not
939 * known. This type can be used to initialize fields before an analysis (not known
940 * yet) or to represent the top of a lattice (could not be determined). There exists
941 * exactly one type unknown. This type is not on the type list in ir_prog. It is
942 * allocated when initializing the type module.
944 * The following values are set:
946 * name: "type_unknown"
947 * state: layout_fixed
950 /* A variable that contains the only unknown type. */
951 extern type *firm_unknown_type;
952 /* Returns the unknown type */
953 type *get_unknown_type(void);
957 * Checks whether a type is atomic.
958 * @param tp - any type
959 * @return true if type is primitive, pointer or enumeration
961 int is_atomic_type(const type *tp);
963 /* --- Support for compound types --- */
966 * Gets the number of elements in a firm compound type.
968 * This is just a comfortability function, because structs and
969 * classes can often be treated be the same code, but they have
970 * different access functions to their members.
972 * @param tp The type (must be struct, union or class).
974 * @return Number of members in the compound type.
976 int get_compound_n_members(const type *tp);
979 * Gets the member of a firm compound type at position pos.
981 * @param tp The type (must be struct, union or class).
982 * @param pos The number of the member.
984 * @return The member entity at position pos.
986 * @see get_compound_n_members() for justifaction of existence.
988 entity *get_compound_member(const type *tp, int pos);
991 * Checks whether a type is compound.
993 * @param tp - any type
995 * @return true if the type is class, structure, union or array type.
997 int is_compound_type(const type *tp);
1001 * Outputs a unique number for this type if libfirm is compiled for
1002 * debugging, (configure with --enable-debug) else returns the address
1003 * of the type cast to long.
1005 long get_type_nr(const type *tp);
1007 /*******************************************************************/
1009 /*******************************************************************/
1014 # endif /* _TYPE_H_ */