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 /** This enumeration flags the visibility of entities and types.
154 * This is necessary for partial compilation.
155 * We rely on the ordering of the flags.
158 visibility_local, /**< The entity is only visible locally. This is the default for
160 The type is only visible locally. All instances are allocated
161 locally, and no pointer to entities of this type are passed
162 out of this compilation unit. */
163 visibility_external_visible, /**< The entity is visible to other external program parts, but
164 it is defined here. It may not be optimized away. The entity must
166 For types: entities of this type can be accessed externaly. No
167 instances of this type are allocated externally. */
168 visibility_external_allocated /**< The entity is defined and allocated externally. This compilation
169 must not allocate memory for this entity. The entity must
170 be static_allocated. This can also be an external defined
172 For types: entities of this type are allocated and accessed from
173 external code. Default for types. */
176 /** The visibility of a type.
178 * The visibility of a type indicates, whether entities of this type
179 * are accessed or allocated in external code.
181 * An entity of a type is allocated in external code, if the external
182 * code declares a variable of this type, or dynamically allocates
183 * an entity of this type. If the external code declares a (compound)
184 * type, that contains entities of this type, the visibility also
185 * must be external_allocated.
187 * The visibility must be higher than that of all entities, if the
188 * type is a compound. Here it is questionable, what happens with
189 * static entities. If these are accessed external by direct reference,
190 * (a static call to a method, that is also in the dispatch table)
191 * it should not affect the visibility of the type.
194 * @@@ Do we need a visibility for types?
195 * I change the layout of types radically when doing type splitting.
196 * I need to know, which fields of classes are accessed in the rts,
197 * e.g., [_length. I may not move [_length to the split part.
198 * The layout though, is a property of the type.
200 * One could also think of changing the mode of a type ...
202 * But, we could also output macros to access the fields, e.g.,
203 * ACCESS_[_length (X) X->length // conventional
204 * ACCESS_[_length (X) X->_split_ref->length // with type splitting
206 * For now I implement this function, that returns the visibility
207 * based on the visibility of the entities of a compound ...
209 * This function returns visibility_external_visible if one or more
210 * entities of a compound type have visibility_external_visible.
211 * Entities of types are never visibility_external_allocated (right?).
212 * Else returns visibility_local.
214 visibility get_type_visibility (const type *tp);
215 void set_type_visibility (type *tp, visibility v);
219 /** The state of the type layout. */
221 layout_undefined, /**< The layout of this type is not defined.
222 Address computation to access fields is not
223 possible, fields must be accessed by Sel
224 nodes. This is the default value except for
225 pointer, primitive and method types. */
226 layout_fixed /**< The layout is fixed, all component/member entities
227 have an offset assigned. Size of the type is known.
228 Arrays can be accessed by explicit address
229 computation. Default for pointer, primitive and method
233 /** Returns a human readable string for the enum entry. */
234 const char *get_type_state_name(type_state s);
236 /** Returns the type layout state of a type. */
237 type_state get_type_state(const type *tp);
239 /** Sets the type layout state of a type.
241 * For primitives, pointer and method types the layout is always fixed.
242 * This call is legal but has no effect.
244 void set_type_state(type *tp, type_state state);
246 /** Returns the mode of a type.
248 * Returns NULL for all non atomic types.
250 ir_mode* get_type_mode(const type *tp);
252 /** Sets the mode of a type.
254 * Only has an effect on primitive, enumeration and pointer types.
256 void set_type_mode(type *tp, ir_mode* m);
258 /** Returns the size of a type in bytes, returns -1 if the size is NOT
259 * a byte size, ie not dividable by 8. */
260 int get_type_size_bytes(const type *tp);
262 /** Returns the size of a type in bits. */
263 int get_type_size_bits(const type *tp);
265 /** Sets the size of a type in bytes.
267 * For primitive, enumeration, pointer and method types the size
268 * is always fixed. This call is legal but has no effect.
270 void set_type_size_bytes(type *tp, int size);
272 /** Sets the size of a type in bits.
274 * For primitive, enumeration, pointer and method types the size
275 * is always fixed. This call is legal but has no effect.
277 void set_type_size_bits(type *tp, int size);
279 /** Returns the alignment of a type in bytes.
281 * Returns -1 if the alignment is NOT
282 * a byte size, i.e. not dividable by 8. Calls get_type_alignment_bits(). */
283 int get_type_alignment_bytes(type *tp);
285 /** Returns the alignment of a type in bits.
287 * If the alignment of a type is
288 * not set, it is calculated here according to the following rules:
289 * 1.) if a type has a mode, the alignment is the mode size.
290 * 2.) compound types have the alignment of it's biggest member.
291 * 3.) array types have the alignment of its element type.
292 * 4.) method types return 0 here.
293 * 5.) all other types return 8 here (i.e. aligned at byte).
295 int get_type_alignment_bits(type *tp);
297 /** Sets the alignment of a type in bytes. */
298 void set_type_alignment_bytes(type *tp, int size);
300 /** Sets the alignment of a type in bits.
302 * For method types the alignment is always fixed.
303 * This call is legal but has no effect.
305 void set_type_alignment_bits(type *tp, int size);
307 unsigned long get_type_visited(const type *tp);
308 void set_type_visited(type *tp, unsigned long num);
309 /* Sets visited field in type to type_visited. */
310 void mark_type_visited(type *tp);
311 /* @@@ name clash!! int type_visited(const type *tp); */
312 int type_not_visited(const type *tp);
314 void* get_type_link(const type *tp);
315 void set_type_link(type *tp, void *l);
318 * Visited flag to traverse the type information.
320 * Increase this flag by one before traversing the type information.
321 * Mark type nodes as visited by set_type_visited(type, type_visited).
322 * Check whether node was already visited by comparing get_type_visited(type)
324 * Or use the function to walk all types.
328 extern unsigned long type_visited;
329 void set_master_type_visited(unsigned long val);
330 unsigned long get_master_type_visited(void);
331 void inc_master_type_visited(void);
334 * Checks whether a pointer points to a type.
336 * @param thing an arbitrary pointer
339 * true if the thing is a type, else false
341 int is_type (const void *thing);
344 * Checks whether two types are structurally equal.
346 * @param st pointer type
347 * @param lt pointer type
350 * true if the types are equal, else false.
351 * Types are equal if :
352 * - they are the same type kind
353 * - they have the same name
354 * - they have the same mode (if applicable)
355 * - they have the same type_state and, ev., the same size
356 * - they are class types and have
357 * - the same members (see same_entity in entity.h)
358 * - the same supertypes -- the C-pointers are compared --> no recursive call.
359 * - the same number of subtypes. Subtypes are not compared,
360 * as this could cause a cyclic test.
361 * - the same peculiarity
362 * - they are structure types and have the same members
363 * - they are method types and have
364 * - the same parameter types
365 * - the same result types
366 * - they are union types and have the same members
367 * - they are array types and have
368 * - the same number of dimensions
369 * - the same dimension bounds
370 * - the same dimension order
371 * - the same element type
372 * - they are enumeration types and have the same enumerator names
373 * - they are pointer types and have the identical points_to type
374 * (i.e., the same C-struct to represent the type, type_id is skipped.
375 * This is to avoid endless recursions; with pointer types circlic
376 * type graphs are possible.)
378 int equal_type(type *tpy1, type *typ2);
381 * Checks whether two types are structural comparable.
383 * @param st pointer type
384 * @param lt pointer type
387 * true if type st is smaller than type lt, i.e. whenever
388 * lt is expected a st can be used.
390 * - they are the same type kind
391 * - mode(st) < mode (lt) (if applicable)
392 * - they are class types and st is (transitive) subtype of lt,
393 * - they are structure types and
394 * - the members of st have exactly one counterpart in lt with the same name,
395 * - the counterpart has a bigger type.
396 * - they are method types and have
397 * - the same number of parameter and result types,
398 * - the parameter types of st are smaller than those of lt,
399 * - the result types of st are smaller than those of lt
400 * - they are union types and have the members of st have exactly one
401 * @return counterpart in lt and the type is smaller
402 * - they are array types and have
403 * - the same number of dimensions
404 * - all bounds of lt are bound of st
405 * - the same dimension order
406 * - the same element type
408 * - the element type of st is smaller than that of lt
409 * - the element types have the same size and fixed layout.
410 * - they are enumeration types and have the same enumerator names
411 * - they are pointer types and have the points_to type of st is
412 * @return smaller than the points_to type of lt.
415 int smaller_type (type *st, type *lt);
418 * @page class_type Representation of a class type
420 * If the type opcode is set to type_class the type represents class
421 * types. A list of fields and methods is associated with a class.
422 * Further a class can inherit from and bequest to other classes.
424 * The following attributes are private to this type kind:
425 * - member: All entities belonging to this class. This are methode entities
426 * which have type_method or fields that can have any of the
427 * following type kinds: type_class, type_struct, type_union,
428 * type_array, type_enumeration, type_pointer, type_primitive.
430 * The following two are dynamic lists that can be grown with an "add_" function,
433 * - subtypes: A list of direct subclasses.
435 * - supertypes: A list of direct superclasses.
437 * - peculiarity: The peculiarity of this class. If the class is of peculiarity
438 * "description" it only is a description of requirements to a class,
439 * as, e.g., a Java interface. The class will never be allocated.
440 * Peculiarity inherited is only possible for entities. An entity
441 * is of peculiarity inherited if the compiler generated the entity
442 * to explicitly resolve inheritance. An inherited method entity has
444 * Values: description, existent, inherited. Default: existent.
448 /** Creates a new class type. */
449 type *new_type_class (ident *name);
451 /** Creates a new class type with debug information. */
452 type *new_d_type_class (ident *name, dbg_info *db);
454 /* --- manipulate private fields of class type --- */
456 /** Adds the entity as member of the class. */
457 void add_class_member (type *clss, entity *member);
459 /** Returns the number of members of this class. */
460 int get_class_n_members (const type *clss);
462 /** Returns the member at position pos, 0 <= pos < n_member */
463 entity *get_class_member (const type *clss, int pos);
465 /** Returns index of mem in clss, -1 if not contained. */
466 int get_class_member_index(type *clss, entity *mem);
468 /** Finds the member with name 'name'. If several members with the same
469 * name returns one of them. Returns NULL if no member found. */
470 entity *get_class_member_by_name(type *clss, ident *name);
472 /** Overwrites the member at position pos, 0 <= pos < n_member with
473 * the passed entity. */
474 void set_class_member (type *clss, entity *member, int pos);
476 /** Replaces complete member list in class type by the list passed.
478 * Copies the list passed. This function is necessary to reduce the number of members.
479 * members is an array of entities, num the size of this array. Sets all
480 * owners of the members passed to clss. */
481 void set_class_members (type *clss, entity *members[], int arity);
483 /** Finds member in the list of members and removes it.
485 * Shrinks the member list, so iterate from the end!!!
486 * Does not deallocate the entity. */
487 void remove_class_member(type *clss, entity *member);
490 /** Adds subtype as subtype to clss.
492 * Checks whether clss is a supertype of subtype. If not
493 * adds also clss as supertype to subtype. */
494 void add_class_subtype (type *clss, type *subtype);
496 /** Returns the number of subtypes */
497 int get_class_n_subtypes (const type *clss);
499 /** Gets the subtype at position pos, 0 <= pos < n_subtype. */
500 type *get_class_subtype (type *clss, int pos);
502 /** Returns the index to access subclass as subtype of class.
504 * If subclass is no direct subtype of class returns -1.
506 int get_class_subtype_index(type *clss, const type *subclass);
508 /** Sets the subtype at position pos, 0 <= pos < n_subtype.
510 * Does not set the corresponding supertype relation for subtype: this might
511 * be a different position! */
512 void set_class_subtype (type *clss, type *subtype, int pos);
514 /** Finds subtype in the list of subtypes and removes it */
515 void remove_class_subtype(type *clss, type *subtype);
518 /** Adds supertype as supertype to class.
520 * Checks whether clss is a subtype of supertype. If not
521 * adds also clss as subtype to supertype. */
522 void add_class_supertype (type *clss, type *supertype);
524 /** Returns the number of supertypes */
525 int get_class_n_supertypes (const type *clss);
527 /** Returns the index to access superclass as supertype of class.
529 * If superclass is no direct supertype of class returns -1.
531 int get_class_supertype_index(type *clss, type *super_clss);
533 /** Gets the supertype at position pos, 0 <= pos < n_supertype. */
534 type *get_class_supertype (type *clss, int pos);
536 /** Sets the supertype at position pos, 0 <= pos < n_supertype.
538 * Does not set the corresponding subtype relation for supertype: this might
539 * be at a different position! */
540 void set_class_supertype (type *clss, type *supertype, int pos);
542 /** Finds supertype in the list of supertypes and removes it */
543 void remove_class_supertype(type *clss, type *supertype);
545 /** This enumeration flags the peculiarity of entities and types. */
546 typedef enum peculiarity {
547 peculiarity_description, /**< Represents only a description. The entity/type is never
548 allocated, no code/data exists for this entity/type.
549 @@@ eventually rename to descriptive (adjective as the others!)*/
550 peculiarity_inherited, /**< Describes explicitly that other entities are
551 inherited to the owner of this entity.
552 Overwrites must refer to at least one other
553 entity. If this is a method entity there exists
554 no irg for this entity, only for one of the
557 peculiarity_existent /**< The entity/type (can) exist.
558 @@@ eventually rename to 'real' i.e., 'echt'
559 This serves better as opposition to description _and_ inherited.*/
561 const char *get_peculiarity_string(peculiarity p);
563 /* The peculiarity of the class. The enumeration peculiarity is defined
565 peculiarity get_class_peculiarity (const type *clss);
566 void set_class_peculiarity (type *clss, peculiarity pec);
568 /* Set and get a class' dfn --
569 @todo This is an undocumented field, subject to change! */
570 void set_class_dfn (type *clss, int dfn);
571 int get_class_dfn (const type *clss);
573 /** Returns true if a type is a class type. */
574 int is_Class_type(const type *clss);
577 * @page struct_type Representation of a struct type
579 * Type_strct represents aggregate types that consist of a list
581 * The following attributes are private to this type kind:
582 * - member: All entities belonging to this class. This are the fields
583 * that can have any of the following types: type_class,
584 * type_struct, type_union, type_array, type_enumeration,
585 * type_pointer, type_primitive.
586 * This is a dynamic list that can be grown with an "add_" function,
588 * This is a dynamic list that can be grown with an "add_" function,
591 /** Creates a new type struct */
592 type *new_type_struct (ident *name);
593 /** Creates a new type struct with debug information. */
594 type *new_d_type_struct (ident *name, dbg_info* db);
596 /* --- manipulate private fields of struct --- */
598 /** Adds the entity as member of the struct. */
599 void add_struct_member (type *strct, entity *member);
601 /** Returns the number of members of this struct. */
602 int get_struct_n_members (const type *strct);
604 /** Returns the member at position pos, 0 <= pos < n_member */
605 entity *get_struct_member (const type *strct, int pos);
607 /** Returns index of member in strct, -1 if not contained. */
608 int get_struct_member_index(type *strct, entity *member);
610 /** Overwrites the member at position pos, 0 <= pos < n_member with
611 the passed entity. */
612 void set_struct_member (type *strct, int pos, entity *member);
614 /** Finds member in the list of members and removes it. */
615 void remove_struct_member (type *strct, entity *member);
617 /** Returns true if a type is a struct type. */
618 int is_Struct_type(const type *strct);
621 * @page method_type Representation of a method type
623 * A method type represents a method, function or procedure type.
624 * It contains a list of the parameter and result types, as these
625 * are part of the type description. These lists should not
626 * be changed by a optimization, as a change creates a new method
627 * type. Therefore optimizations should allocated new method types.
628 * The set_ routines are only for construction by a frontend.
630 * - n_params: Number of parameters to the procedure.
631 * A procedure in FIRM has only call by value parameters.
633 * - param_type: A list with the types of parameters. This list is ordered.
634 * The nth type in this list corresponds to the nth element
635 * in the parameter tuple that is a result of the start node.
636 * (See ircons.h for more information.)
639 * A list of entities (whose owner is a struct private to the
640 * method type) that represent parameters passed by value.
642 * - n_res: The number of results of the method. In general, procedures
643 * have zero results, functions one.
645 * - res_type: A list with the types of parameters. This list is ordered.
646 * The nth type in this list corresponds to the nth input to
647 * Return nodes. (See ircons.h for more information.)
650 * A list of entities (whose owner is a struct private to the
651 * method type) that represent results passed by value.
654 /* These macros define the suffixes for the types and entities used
655 to represent value parameters / results. */
656 #define VALUE_PARAMS_SUFFIX "val_param"
657 #define VALUE_RESS_SUFFIX "val_res"
659 /** Create a new method type.
661 * @param name the name (ident) of this type
662 * @param n_param the number of parameters
663 * @param n_res the number of results
665 * The arrays for the parameter and result types are not initialized by
668 type *new_type_method (ident *name, int n_param, int n_res);
670 /** Create a new method type with debug information.
672 * @param name the name (ident) of this type
673 * @param n_param the number of parameters
674 * @param n_res the number of results
675 * @param db user defined debug information
677 * The arrays for the parameter and result types are not initialized by
680 type *new_d_type_method (ident *name, int n_param, int n_res, dbg_info* db);
682 /* -- manipulate private fields of method. -- */
684 /** Returns the number of parameters of this method. */
685 int get_method_n_params (const type *method);
687 /** Returns the type of the parameter at position pos of a method. */
688 type *get_method_param_type(type *method, int pos);
689 /** Sets the type of the parameter at position pos of a method.
690 Also changes the type in the pass-by-value representation by just
691 changing the type of the corresponding entity if the representation is constructed. */
692 void set_method_param_type(type *method, int pos, type* tp);
693 /** Returns an entity that represents the copied value argument. Only necessary
694 for compounds passed by value. This information is constructed only on demand. */
695 entity *get_method_value_param_ent(type *method, int pos);
697 * Returns a type that represents the copied value arguments.
699 type *get_method_value_param_type(const type *method);
701 int get_method_n_ress (const type *method);
702 type *get_method_res_type(type *method, int pos);
703 /** Sets the type of the result at position pos of a method.
704 Also changes the type in the pass-by-value representation by just
705 changing the type of the corresponding entity if the representation is constructed. */
706 void set_method_res_type(type *method, int pos, type* tp);
707 /** Returns an entity that represents the copied value result. Only necessary
708 for compounds passed by value. This information is constructed only on demand. */
709 entity *get_method_value_res_ent(type *method, int pos);
712 * Returns a type that represents the copied value results.
714 type *get_method_value_res_type(const type *method);
717 * this enum flags the variadicity of methods (methods with a
718 * variable amount of arguments (e.g. C's printf). Default is
721 typedef enum variadicity {
722 variadicity_non_variadic, /**< non variadic */
723 variadicity_variadic /**< variadic */
726 /** Returns the null-terminated name of this variadicity. */
727 const char *get_variadicity_name(variadicity vari);
729 /** Returns the variadicity of a method. */
730 variadicity get_method_variadicity(const type *method);
732 /** Sets the variadicity of a method. */
733 void set_method_variadicity(type *method, variadicity vari);
736 * Returns the first variadic parameter index of a type.
737 * If this index was NOT set, the index of the last parameter
738 * of the method type plus one is returned for variadic functions.
739 * Non-variadic function types always return -1 here.
741 int get_method_first_variadic_param_index(const type *method);
744 * Sets the first variadic parameter index. This allows to specify
745 * a complete call type (containing the type of all parameters)
746 * but still have the knowledge, which parameter must be passed as
749 void set_method_first_variadic_param_index(type *method, int index);
751 /** Returns true if a type is a method type. */
752 int is_Method_type (const type *method);
755 * @page union_type Representation of a union type.
757 * The union type represents union types.
758 * - n_types: Number of unioned types.
759 * - members: Entities for unioned types. Fixed length array.
760 * This is a dynamic list that can be grown with an "add_" function,
763 /** Creates a new type union. */
764 type *new_type_union (ident *name);
766 /** Creates a new type union with debug information. */
767 type *new_d_type_union (ident *name, dbg_info* db);
769 /* --- manipulate private fields of struct --- */
771 /** Returns the number of unioned types of this union */
772 int get_union_n_members (const type *uni);
774 /** Adds a new entity to a union type */
775 void add_union_member (type *uni, entity *member);
777 /** Returns the entity at position pos of a union */
778 entity *get_union_member (const type *uni, int pos);
780 /** Overwrites a entity at position pos in a union type. */
781 void set_union_member (type *uni, int pos, entity *member);
783 /** Finds member in the list of members and removes it. */
784 void remove_union_member (type *uni, entity *member);
786 /** Returns true if a type is a union type. */
787 int is_Union_type (const type *uni);
790 * @page array_type Representation of an array type
792 * The array type represents rectangular multi dimensional arrays.
793 * The constants representing the bounds must be allocated to
794 * get_const_code_irg() by setting current_ir_graph accordingly.
796 * - n_dimensions: Number of array dimensions.
797 * - *lower_bound: Lower bounds of dimensions. Usually all 0.
798 * - *upper_bound: Upper bounds or dimensions.
799 * - *element_type: The type of the array elements.
800 * - *element_ent: An entity for the array elements to be used for
801 * element selection with Sel.
803 * Do we need several entities? One might want
804 * to select a dimension and not a single element in case of multi
805 * dimensional arrays.
808 /** Create a new type array.
810 * Sets n_dimension to dimension and all dimension entries to NULL.
811 * Initializes order to the order of the dimensions.
812 * The entity for array elements is built automatically.
813 * Set dimension sizes after call to constructor with set_* routines.
815 type *new_type_array (ident *name, int n_dimensions,
818 /** Create a new type array with debug information.
820 * Sets n_dimension to dimension and all dimension entries to NULL.
821 * Initializes order to the order of the dimensions.
822 * The entity for array elements is built automatically.
823 * Set dimension sizes after call to constructor with set_* routines.
824 * A legal array type must have at least one dimension set.
826 type *new_d_type_array (ident *name, int n_dimensions,
827 type *element_type, dbg_info* db);
829 /* --- manipulate private fields of array type --- */
831 /** Returns the number of array dimensions of this type. */
832 int get_array_n_dimensions (const type *array);
835 * Allocates Const nodes of mode_I for one array dimension.
836 * Upper bound in Firm is the element next to the last, ie [lower,upper[
838 void set_array_bounds_int (type *array, int dimension, int lower_bound,
841 * Sets the bounds for one array dimension.
842 * Upper bound in Firm is the element next to the last, ie [lower,upper[
844 void set_array_bounds (type *array, int dimension, ir_node *lower_bound,
845 ir_node *upper_bound);
846 /** Sets the lower bound for one array dimension, ie [lower,upper[ */
847 void set_array_lower_bound (type *array, int dimension, ir_node *lower_bound);
849 /** Allocates Const nodes of mode_I for the lower bound of an array
850 dimension, ie [lower,upper[ */
851 void set_array_lower_bound_int (type *array, int dimension, int lower_bound);
853 /** Sets the upper bound for one array dimension, ie [lower,upper[ */
854 void set_array_upper_bound (type *array, int dimension, ir_node *upper_bound);
856 /** Allocates Const nodes of mode_I for the upper bound of an array
857 dimension, ie [lower,upper[ */
858 void set_array_upper_bound_int (type *array, int dimension, int upper_bound);
860 /** returns true if lower bound != Unknown */
861 int has_array_lower_bound (const type *array, int dimension);
862 ir_node * get_array_lower_bound (const type *array, int dimension);
863 /** Works only if bound is Const node with tarval that can be converted to long. */
864 long get_array_lower_bound_int (const type *array, int dimension);
865 /** returns true if lower bound != Unknown */
866 int has_array_upper_bound (const type *array, int dimension);
867 ir_node * get_array_upper_bound (const type *array, int dimension);
868 /** Works only if bound is Const node with tarval that can be converted to long. */
869 long get_array_upper_bound_int (const type *array, int dimension);
871 /** Sets an array dimension to a specific order. */
872 void set_array_order (type *array, int dimension, int order);
874 /** Returns the order of an array dimension. */
875 int get_array_order (const type *array, int dimension);
877 /** Find the array dimension that is placed at order ord. */
878 int find_array_dimension(const type *array, int order);
880 /** Sets the array element type. */
881 void set_array_element_type (type *array, type *tp);
883 /** Gets the array element type. */
884 type *get_array_element_type (type *array);
886 /** Sets the array element entity. */
887 void set_array_element_entity (type *array, entity *ent);
889 /** Get the array element entity. */
890 entity *get_array_element_entity (const type *array);
892 /** Returns true if a type is an array type. */
893 int is_Array_type(const type *array);
896 * @page enumeration_type Representation of an enumeration type
898 * Enumeration types need not necessarily be represented explicitly
899 * by Firm types, as the frontend can lower them to integer constants as
900 * well. For debugging purposes or similar tasks this information is useful.
902 * - *enum: The target values representing the constants used to
903 * represent individual enumerations.
904 * - *enum_nameid: Idents containing the source program name of the enumeration
907 /** Create a new type enumeration -- set the enumerators independently. */
908 type *new_type_enumeration (ident *name, int n_enums);
910 /** Create a new type enumeration with debug information -- set the enumerators independently. */
911 type *new_d_type_enumeration (ident *name, int n_enums, dbg_info* db);
913 /* --- manipulate fields of enumeration type. --- */
915 /** Returns the number of enumeration values of this enumeration */
916 int get_enumeration_n_enums (const type *enumeration);
918 /** Sets the enumeration value at a given position. */
919 void set_enumeration_enum (type *enumeration, int pos, tarval *con);
921 /** Returns the enumeration value at a given position. */
922 tarval *get_enumeration_enum (const type *enumeration, int pos);
924 /** Assign an ident to an enumeration value at a given position. */
925 void set_enumeration_nameid (type *enumeration, int pos, ident *id);
927 /** Returns the assigned ident of an enumeration value at a given position. */
928 ident *get_enumeration_nameid (const type *enumeration, int pos);
930 /** Returns the assigned name of an enumeration value at a given position. */
931 const char *get_enumeration_name(const type *enumeration, int pos);
933 /** Returns true if a type is a enumeration type. */
934 int is_Enumeration_type (const type *enumeration);
937 * @page pointer_type Representation of a pointer type
939 * The mode of the pointer type must be a mode_reference.
942 * - points_to: The type of the entity this pointer points to.
945 /** Creates a new type pointer with mode mode_p. */
946 #define new_type_pointer(N, P) new_type_pointer_mode(N, P, mode_P_mach)
948 /** Creates a new type pointer with given pointer mode. */
949 type *new_type_pointer_mode (ident *name, type *points_to, ir_mode *ptr_mode);
951 /** Creates a new type pointer given pointer mode and with debug information. */
952 type *new_d_type_pointer (ident *name, type *points_to, ir_mode *ptr_mode, dbg_info* db);
954 /* --- manipulate fields of type_pointer --- */
956 /** Sets the type to which a pointer points to. */
957 void set_pointer_points_to_type (type *pointer, type *tp);
959 /** Returns the type to which a pointer points to. */
960 type *get_pointer_points_to_type (type *pointer);
962 /** Returns true if a type is a pointer type. */
963 int is_Pointer_type (const type *pointer);
965 /** Returns the first pointer type that has as points_to tp.
966 * Not efficient: O(#types).
967 * If not found returns unknown_type. */
968 type *find_pointer_type_to_type (type *tp);
971 * @page primitive_type Representation of a primitive type
973 * Primitive types are types that represent indivisible data values that
974 * map directly to modes. They don't have a private attribute. The
975 * important information they carry is held in the common mode field.
977 /** Creates a new primitive type. */
978 type *new_type_primitive (ident *name, ir_mode *mode);
980 /** Creates a new primitive type with debug information. */
981 type *new_d_type_primitive (ident *name, ir_mode *mode, dbg_info* db);
983 /** Returns true if a type is a primitive type. */
984 int is_Primitive_type (const type *primitive);
990 * This type is an auxiliary type dedicated to support type analyses.
992 * The none type represents that there is no type. The type can be used to
993 * initialize fields of type* that actually can not contain a type or that
994 * are initialized for an analysis. There exists exactly one type none.
995 * This type is not on the type list in ir_prog. It is
996 * allocated when initializing the type module.
998 * The following values are set:
1001 * state: layout_fixed
1004 /* A variable that contains the only none type. */
1005 extern type *firm_none_type;
1006 /* Returns the none type */
1007 type *get_none_type(void);
1010 * @page unknown_type
1012 * This type is an auxiliary type dedicated to support type analyses.
1014 * The unknown type represents that there could be a type, but it is not
1015 * known. This type can be used to initialize fields before an analysis (not known
1016 * yet) or to represent the top of a lattice (could not be determined). There exists
1017 * exactly one type unknown. This type is not on the type list in ir_prog. It is
1018 * allocated when initializing the type module.
1020 * The following values are set:
1022 * name: "type_unknown"
1023 * state: layout_fixed
1026 /* A variable that contains the only unknown type. */
1027 extern type *firm_unknown_type;
1028 /* Returns the unknown type */
1029 type *get_unknown_type(void);
1033 * Checks whether a type is atomic.
1034 * @param tp - any type
1035 * @return true if type is primitive, pointer or enumeration
1037 int is_atomic_type(const type *tp);
1039 /* --- Support for compound types --- */
1042 * Gets the number of elements in a firm compound type.
1044 * This is just a comfortability function, because structs and
1045 * classes can often be treated be the same code, but they have
1046 * different access functions to their members.
1048 * @param tp The type (must be struct, union or class).
1050 * @return Number of members in the compound type.
1052 int get_compound_n_members(const type *tp);
1055 * Gets the member of a firm compound type at position pos.
1057 * @param tp The type (must be struct, union or class).
1058 * @param pos The number of the member.
1060 * @return The member entity at position pos.
1062 * @see get_compound_n_members() for justifaction of existence.
1064 entity *get_compound_member(const type *tp, int pos);
1067 * Checks whether a type is compound.
1069 * @param tp - any type
1071 * @return true if the type is class, structure, union or array type.
1073 int is_compound_type(const type *tp);
1077 * Outputs a unique number for this type if libfirm is compiled for
1078 * debugging, (configure with --enable-debug) else returns the address
1079 * of the type cast to long.
1081 long get_type_nr(const type *tp);
1083 /*******************************************************************/
1085 /*******************************************************************/
1090 # endif /* _TYPE_H_ */