4 * Project: libFIRM <br>
5 * File name: ir/tr/type.h <br>
6 * Purpose: Representation of types. <br>
7 * Author: Goetz Lindenmaier <br>
10 * Copyright: (c) 2001-2003 Universität Karlsruhe <br>
11 * Licence: This file protected by GPL - GNU GENERAL PUBLIC LICENSE. <br>
15 * Datastructure to hold type information.
17 * This module supplies a datastructure to represent all types
18 * known in the compiled program. This includes types specified
19 * in the program as well as types defined by the language. In the
20 * view of the intermediate representation there is no difference
21 * between these types. Finally it specifies some auxiliary types.
23 * There exist several kinds of types, arranged by the structure of
24 * the type. A type is described by a set of attributes. Some of
25 * these attributes are common to all types, others depend on the
28 * Types are different from the modes defined in irmode: Types are
29 * on the level of the programming language, modes at the level of
30 * the target processor.
40 # include "firm_types.h"
42 # include "firm_common.h"
46 # include "tr_inheritance.h"
49 * An abstract data type to represent types.
51 * This is the abstract data type with which any type known in the
52 * compiled program can be represented. This includes types specified
53 * in the program as well as types defined by the language. In the
54 * view of the intermediate representation there is no difference
55 * between these types.
57 * There exist several kinds of types, arranged by the structure of
58 * the type. These are distinguished by a type opcode.
59 * A type is described by a set of attributes. Some of these attributes
60 * are common to all types, others depend on the kind of the type.
62 * The following describes the common attributes. They can only be
63 * accessed by the functions given below.
65 * The common fields are:
67 * - firm_kind: A firm_kind tag containing k_type. This is useful
68 * for dynamically checking whether a node is a type node.
69 * - type_op: A tp_op specifying the kind of the type.
70 * - mode: The mode to be used to represent the type on a machine.
71 * - name: An identifier specifying the name of the type. To be
72 * set by the frontend.
73 * - size: The size of the type, i.e. an entity of this type will
74 * occupy size bits in memory. In several cases this is
75 * determined when fixing the layout of this type (class,
76 * struct, union, array, enumeration).
77 * - alignment The alignment of the type, i.e. an entity of this type will
78 * be allocated an an address in memory with this alignment.
79 * In several cases this is determined when fixing the layout
80 * of this type (class, struct, union, array)
81 * - state: The state of the type. The state represents whether the
82 * layout of the type is undefined or fixed (values: layout_undefined
83 * or layout_fixed). Compound types can have an undefined
84 * layout. The layout of the basic types primitive and pointer
85 * is always layout_fixed. If the layout of
86 * compound types is fixed all entities must have an offset
87 * and the size of the type must be set.
88 * A fixed layout for enumeration types means that each enumeration
89 * is associated with an implementation value.
90 * - visit: A counter for walks of the type information.
91 * - link: A void* to associate some additional information with the type.
93 * These fields can only be accessed via access functions.
95 * Depending on the value of @c type_op, i.e., depending on the kind of the
96 * type the adt contains further attributes. These are documented below.
100 * @link class_type class @endlink, @link struct_type struct @endlink,
101 * @link method_type method @endlink, @link union_type union @endlink,
102 * @link array_type array @endlink, @link enumeration_type enumeration @endlink,
103 * @link pointer_type pointer @endlink, @link primitive_type primitive @endlink
106 * mode maybe not global field??
108 #ifndef _TYPE_TYPEDEF_
109 #define _TYPE_TYPEDEF_
110 typedef struct type type;
113 # include "type_or_entity.h"
115 /** frees all entities associated with a type.
116 Does not free array entity.
117 Warning: make sure these entities are not referenced anywhere else.
119 void free_type_entities(type *tp);
121 /** Frees the memory used by the type.
123 * Removes the type from the type list. Does not free the entities
124 * belonging to the type, except for the array element entity. Does
125 * not free if tp is "none" or "unknown". Frees entities in value
126 * param subtypes of method types!!! Make sure these are not
127 * referenced any more. Further make sure there is no pointer type
128 * that refers to this type. */
129 void free_type(type *tp);
131 const tp_op*get_type_tpop(const type *tp);
132 ident* get_type_tpop_nameid(const type *tp);
133 const char* get_type_tpop_name(const type *tp);
134 tp_opcode get_type_tpop_code(const type *tp);
136 ident* get_type_ident(const type *tp);
137 void set_type_ident(type *tp, ident* id);
138 const char* get_type_name(const type *tp);
140 /** This enumeration flags the visibility of entities and types.
142 * This is necessary for partial compilation.
143 * We rely on the ordering of the flags.
146 visibility_local, /**< The entity is only visible locally. This is the default for
148 The type is only visible locally. All instances are allocated
149 locally, and no pointer to entities of this type are passed
150 out of this compilation unit. */
151 visibility_external_visible, /**< The entity is visible to other external program parts, but
152 it is defined here. It may not be optimized away. The entity must
154 For types: entities of this type can be accessed externally. No
155 instances of this type are allocated externally. */
156 visibility_external_allocated /**< The entity is defined and allocated externally. This compilation
157 must not allocate memory for this entity. The entity must
158 be static_allocated. This can also be an external defined
160 For types: entities of this type are allocated and accessed from
161 external code. Default for types. */
164 /** The visibility of a type.
166 * The visibility of a type indicates, whether entities of this type
167 * are accessed or allocated in external code.
169 * An entity of a type is allocated in external code, if the external
170 * code declares a variable of this type, or dynamically allocates
171 * an entity of this type. If the external code declares a (compound)
172 * type, that contains entities of this type, the visibility also
173 * must be external_allocated.
175 * The visibility must be higher than that of all entities, if the
176 * type is a compound. Here it is questionable, what happens with
177 * static entities. If these are accessed external by direct reference,
178 * (a static call to a method, that is also in the dispatch table)
179 * it should not affect the visibility of the type.
182 * @@@ Do we need a visibility for types?
183 * I change the layout of types radically when doing type splitting.
184 * I need to know, which fields of classes are accessed in the RTS,
185 * e.g., [_length. I may not move [_length to the split part.
186 * The layout though, is a property of the type.
188 * One could also think of changing the mode of a type ...
190 * But, we could also output macros to access the fields, e.g.,
191 * ACCESS_[_length (X) X->length // conventional
192 * ACCESS_[_length (X) X->_split_ref->length // with type splitting
194 * For now I implement this function, that returns the visibility
195 * based on the visibility of the entities of a compound ...
197 * This function returns visibility_external_visible if one or more
198 * entities of a compound type have visibility_external_visible.
199 * Entities of types are never visibility_external_allocated (right?).
200 * Else returns visibility_local.
202 visibility get_type_visibility (const type *tp);
203 void set_type_visibility (type *tp, visibility v);
207 /** The state of the type layout. */
209 layout_undefined, /**< The layout of this type is not defined.
210 Address computation to access fields is not
211 possible, fields must be accessed by Sel
212 nodes. This is the default value except for
213 pointer, primitive and method types. */
214 layout_fixed /**< The layout is fixed, all component/member entities
215 have an offset assigned. Size of the type is known.
216 Arrays can be accessed by explicit address
217 computation. Default for pointer, primitive and method
221 /** Returns a human readable string for the enum entry. */
222 const char *get_type_state_name(type_state s);
224 /** Returns the type layout state of a type. */
225 type_state get_type_state(const type *tp);
227 /** Sets the type layout state of a type.
229 * For primitives, pointer and method types the layout is always fixed.
230 * This call is legal but has no effect.
232 void set_type_state(type *tp, type_state state);
234 /** Returns the mode of a type.
236 * Returns NULL for all non atomic types.
238 ir_mode* get_type_mode(const type *tp);
240 /** Sets the mode of a type.
242 * Only has an effect on primitive, enumeration and pointer types.
244 void set_type_mode(type *tp, ir_mode* m);
246 /** Returns the size of a type in bytes, returns -1 if the size is NOT
247 * a byte size, i.e. not dividable by 8. */
248 int get_type_size_bytes(const type *tp);
250 /** Returns the size of a type in bits. */
251 int get_type_size_bits(const type *tp);
253 /** Sets the size of a type in bytes.
255 * For primitive, enumeration, pointer and method types the size
256 * is always fixed. This call is legal but has no effect.
258 void set_type_size_bytes(type *tp, int size);
260 /** Sets the size of a type in bits.
262 * For primitive, enumeration, pointer and method types the size
263 * is always fixed. This call is legal but has no effect.
265 void set_type_size_bits(type *tp, int size);
267 /** Returns the alignment of a type in bytes.
269 * Returns -1 if the alignment is NOT
270 * a byte size, i.e. not dividable by 8. Calls get_type_alignment_bits(). */
271 int get_type_alignment_bytes(type *tp);
273 /** Returns the alignment of a type in bits.
275 * If the alignment of a type is
276 * not set, it is calculated here according to the following rules:
277 * -#.) if a type has a mode, the alignment is the mode size.
278 * -#.) compound types have the alignment of there biggest member.
279 * -#.) array types have the alignment of there element type.
280 * -#.) method types return 0 here.
281 * -#.) all other types return 8 here (i.e. aligned at byte).
283 int get_type_alignment_bits(type *tp);
285 /** Sets the alignment of a type in bytes. */
286 void set_type_alignment_bytes(type *tp, int size);
288 /** Sets the alignment of a type in bits.
290 * For method types the alignment is always fixed.
291 * This call is legal but has no effect.
293 void set_type_alignment_bits(type *tp, int size);
295 unsigned long get_type_visited(const type *tp);
296 void set_type_visited(type *tp, unsigned long num);
297 /* Sets visited field in type to type_visited. */
298 void mark_type_visited(type *tp);
299 int type_visited(const type *tp);
300 int type_not_visited(const type *tp);
302 /** Returns the associated link field of a type. */
303 void* get_type_link(const type *tp);
304 /** Sets the associated link field of a type. */
305 void set_type_link(type *tp, void *l);
308 * Visited flag to traverse the type information.
310 * Increase this flag by one before traversing the type information
311 * using inc_master_type_visited().
312 * Mark type nodes as visited by mark_type_visited(type).
313 * Check whether node was already visited by type_visited(type)
314 * and type_not_visited(type).
315 * Or use the function to walk all types.
319 void set_master_type_visited(unsigned long val);
320 unsigned long get_master_type_visited(void);
321 void inc_master_type_visited(void);
324 * Checks whether a pointer points to a type.
326 * @param thing an arbitrary pointer
329 * true if the thing is a type, else false
331 int is_type (const void *thing);
334 * Checks whether two types are structurally equal.
336 * @param typ1 the first type
337 * @param typ2 the second type
340 * true if the types are equal, else false.
342 * Types are equal if :
343 * - they are the same type kind
344 * - they have the same name
345 * - they have the same mode (if applicable)
346 * - they have the same type_state and, ev., the same size
347 * - they are class types and have:
348 * - the same members (see same_entity in entity.h)
349 * - the same supertypes -- the C-pointers are compared --> no recursive call.
350 * - the same number of subtypes. Subtypes are not compared,
351 * as this could cause a cyclic test.
352 * - the same peculiarity
353 * - they are structure types and have the same members
354 * - they are method types and have
355 * - the same parameter types
356 * - the same result types
357 * - they are union types and have the same members
358 * - they are array types and have
359 * - the same number of dimensions
360 * - the same dimension bounds
361 * - the same dimension order
362 * - the same element type
363 * - they are enumeration types and have the same enumerator names
364 * - they are pointer types and have the identical points_to type
365 * (i.e., the same C-struct to represent the type, type_id is skipped.
366 * This is to avoid endless recursions; with pointer types cyclic
367 * type graphs are possible.)
369 int equal_type(type *typ1, type *typ2);
372 * Checks whether two types are structural comparable.
374 * @param st pointer type
375 * @param lt pointer type
378 * true if type st is smaller than type lt, i.e. whenever
379 * lt is expected a st can be used.
381 * - they are the same type kind
382 * - mode(st) < mode (lt) (if applicable)
383 * - they are class types and st is (transitive) subtype of lt,
384 * - they are structure types and
385 * - the members of st have exactly one counterpart in lt with the same name,
386 * - the counterpart has a bigger type.
387 * - they are method types and have
388 * - the same number of parameter and result types,
389 * - the parameter types of st are smaller than those of lt,
390 * - the result types of st are smaller than those of lt
391 * - they are union types and have the members of st have exactly one
392 * @return counterpart in lt and the type is smaller
393 * - they are array types and have
394 * - the same number of dimensions
395 * - all bounds of lt are bound of st
396 * - the same dimension order
397 * - the same element type
399 * - the element type of st is smaller than that of lt
400 * - the element types have the same size and fixed layout.
401 * - they are enumeration types and have the same enumerator names
402 * - they are pointer types and have the points_to type of st is
403 * @return smaller than the points_to type of lt.
406 int smaller_type (type *st, type *lt);
409 * @page class_type Representation of a class type
411 * If the type opcode is set to type_class the type represents class
412 * types. A list of fields and methods is associated with a class.
413 * Further a class can inherit from and bequest to other classes.
415 * The following attributes are private to this type kind:
416 * - member: All entities belonging to this class. This are method entities
417 * which have type_method or fields that can have any of the
418 * following type kinds: type_class, type_struct, type_union,
419 * type_array, type_enumeration, type_pointer, type_primitive.
421 * The following two are dynamic lists that can be grown with an "add_" function,
424 * - subtypes: A list of direct subclasses.
426 * - supertypes: A list of direct superclasses.
428 * - peculiarity: The peculiarity of this class. If the class is of peculiarity
429 * "description" it only is a description of requirements to a class,
430 * as, e.g., a Java interface. The class will never be allocated.
431 * Peculiarity inherited is only possible for entities. An entity
432 * is of peculiarity inherited if the compiler generated the entity
433 * to explicitly resolve inheritance. An inherited method entity has
435 * Values: description, existent, inherited. Default: existent.
439 /** Creates a new class type. */
440 type *new_type_class (ident *name);
442 /** Creates a new class type with debug information. */
443 type *new_d_type_class (ident *name, dbg_info *db);
445 /* --- manipulate private fields of class type --- */
447 /** Adds the entity as member of the class. */
448 void add_class_member (type *clss, entity *member);
450 /** Returns the number of members of this class. */
451 int get_class_n_members (const type *clss);
453 /** Returns the member at position pos, 0 <= pos < n_member */
454 entity *get_class_member (const type *clss, int pos);
456 /** Returns index of mem in clss, -1 if not contained. */
457 int get_class_member_index(type *clss, entity *mem);
459 /** Finds the member with name 'name'. If several members with the same
460 * name returns one of them. Returns NULL if no member found. */
461 entity *get_class_member_by_name(type *clss, ident *name);
463 /** Overwrites the member at position pos, 0 <= pos < n_member with
464 * the passed entity. */
465 void set_class_member (type *clss, entity *member, int pos);
467 /** Replaces complete member list in class type by the list passed.
469 * Copies the list passed. This function is necessary to reduce the number of members.
470 * members is an array of entities, num the size of this array. Sets all
471 * owners of the members passed to clss. */
472 void set_class_members (type *clss, entity *members[], int arity);
474 /** Finds member in the list of members and removes it.
476 * Shrinks the member list, so iterate from the end!!!
477 * Does not deallocate the entity. */
478 void remove_class_member(type *clss, entity *member);
481 /** Adds subtype as subtype to clss.
483 * Checks whether clss is a supertype of subtype. If not
484 * adds also clss as supertype to subtype. */
485 void add_class_subtype (type *clss, type *subtype);
487 /** Returns the number of subtypes */
488 int get_class_n_subtypes (const type *clss);
490 /** Gets the subtype at position pos, 0 <= pos < n_subtype. */
491 type *get_class_subtype (type *clss, int pos);
493 /** Returns the index to access subclass as subtype of class.
495 * If subclass is no direct subtype of class returns -1.
497 int get_class_subtype_index(type *clss, const type *subclass);
499 /** Sets the subtype at position pos, 0 <= pos < n_subtype.
501 * Does not set the corresponding supertype relation for subtype: this might
502 * be a different position! */
503 void set_class_subtype (type *clss, type *subtype, int pos);
505 /** Finds subtype in the list of subtypes and removes it */
506 void remove_class_subtype(type *clss, type *subtype);
508 /* Convenience macros */
509 #define add_class_derived_type(clss, drvtype) add_class_subtype(clss, drvtype)
510 #define get_class_n_derived_types(clss) get_class_n_subtypes(clss)
511 #define get_class_derived_type(clss, pos) get_class_subtype(clss, pos)
512 #define get_class_derived_type_index(clss, drvtype) get_class_subtype_index(clss, drvtype)
513 #define set_class_derived_type(clss, drvtype, pos) set_class_subtype(clss, drvtype, pos)
514 #define remove_class_derived_type(clss, drvtype) remove_class_subtype(clss, drvtype)
516 /** Adds supertype as supertype to class.
518 * Checks whether clss is a subtype of supertype. If not
519 * adds also clss as subtype to supertype. */
520 void add_class_supertype (type *clss, type *supertype);
522 /** Returns the number of supertypes */
523 int get_class_n_supertypes (const type *clss);
525 /** Returns the index to access superclass as supertype of class.
527 * If superclass is no direct supertype of class returns -1.
529 int get_class_supertype_index(type *clss, type *super_clss);
531 /** Gets the supertype at position pos, 0 <= pos < n_supertype. */
532 type *get_class_supertype (type *clss, int pos);
534 /** Sets the supertype at position pos, 0 <= pos < n_supertype.
536 * Does not set the corresponding subtype relation for supertype: this might
537 * be at a different position! */
538 void set_class_supertype (type *clss, type *supertype, int pos);
540 /** Finds supertype in the list of supertypes and removes it */
541 void remove_class_supertype(type *clss, type *supertype);
543 /** Convenience macro */
544 #define add_class_base_type(clss, basetype) add_class_supertype(clss, basetype)
545 #define get_class_n_base_types(clss) get_class_n_supertypes(clss)
546 #define get_class_base_type_index(clss, base_clss) get_class_supertype_index(clss, base_clss)
547 #define get_class_base_type(clss, pos) get_class_supertype(clss, pos)
548 #define set_class_base_type(clss, basetype, pos) set_class_supertype(clss, basetype, pos)
549 #define remove_class_base_type(clss, basetype) remove_class_supertype(clss, basetype)
551 /** This enumeration flags the peculiarity of entities and types. */
552 typedef enum peculiarity {
553 peculiarity_description, /**< Represents only a description. The entity/type is never
554 allocated, no code/data exists for this entity/type.
555 @@@ eventually rename to descriptive (adjective as the others!)*/
556 peculiarity_inherited, /**< Describes explicitly that other entities are
557 inherited to the owner of this entity.
558 Overwrites must refer to at least one other
559 entity. If this is a method entity there exists
560 no irg for this entity, only for one of the
563 peculiarity_existent /**< The entity/type (can) exist.
564 @@@ eventually rename to 'real' i.e., 'echt'
565 This serves better as opposition to description _and_ inherited.*/
567 const char *get_peculiarity_string(peculiarity p);
569 /** Returns the peculiarity of the class. */
570 peculiarity get_class_peculiarity (const type *clss);
571 /** Sets the peculiarity of the class. */
572 void set_class_peculiarity (type *clss, peculiarity pec);
574 /* Set and get a class' dfn --
575 @todo This is an undocumented field, subject to change! */
576 void set_class_dfn (type *clss, int dfn);
577 int get_class_dfn (const type *clss);
579 /** Returns true if a type is a class type. */
580 int is_Class_type(const type *clss);
583 * @page struct_type Representation of a struct type
585 * Type_strct represents aggregate types that consist of a list
587 * The following attributes are private to this type kind:
588 * - member: All entities belonging to this class. This are the fields
589 * that can have any of the following types: type_class,
590 * type_struct, type_union, type_array, type_enumeration,
591 * type_pointer, type_primitive.
592 * This is a dynamic list that can be grown with an "add_" function,
594 * This is a dynamic list that can be grown with an "add_" function,
597 /** Creates a new type struct */
598 type *new_type_struct (ident *name);
599 /** Creates a new type struct with debug information. */
600 type *new_d_type_struct (ident *name, dbg_info* db);
602 /* --- manipulate private fields of struct --- */
604 /** Adds the entity as member of the struct. */
605 void add_struct_member (type *strct, entity *member);
607 /** Returns the number of members of this struct. */
608 int get_struct_n_members (const type *strct);
610 /** Returns the member at position pos, 0 <= pos < n_member */
611 entity *get_struct_member (const type *strct, int pos);
613 /** Returns index of member in strct, -1 if not contained. */
614 int get_struct_member_index(type *strct, entity *member);
616 /** Overwrites the member at position pos, 0 <= pos < n_member with
617 the passed entity. */
618 void set_struct_member (type *strct, int pos, entity *member);
620 /** Finds member in the list of members and removes it. */
621 void remove_struct_member (type *strct, entity *member);
623 /** Returns true if a type is a struct type. */
624 int is_Struct_type(const type *strct);
627 * @page method_type Representation of a method type
629 * A method type represents a method, function or procedure type.
630 * It contains a list of the parameter and result types, as these
631 * are part of the type description. These lists should not
632 * be changed by a optimization, as a change creates a new method
633 * type. Therefore optimizations should allocated new method types.
634 * The set_ routines are only for construction by a frontend.
636 * - n_params: Number of parameters to the procedure.
637 * A procedure in FIRM has only call by value parameters.
639 * - param_type: A list with the types of parameters. This list is ordered.
640 * The nth type in this list corresponds to the nth element
641 * in the parameter tuple that is a result of the start node.
642 * (See ircons.h for more information.)
645 * A list of entities (whose owner is a struct private to the
646 * method type) that represent parameters passed by value.
648 * - n_res: The number of results of the method. In general, procedures
649 * have zero results, functions one.
651 * - res_type: A list with the types of parameters. This list is ordered.
652 * The nth type in this list corresponds to the nth input to
653 * Return nodes. (See ircons.h for more information.)
656 * A list of entities (whose owner is a struct private to the
657 * method type) that represent results passed by value.
660 /* These macros define the suffixes for the types and entities used
661 to represent value parameters / results. */
662 #define VALUE_PARAMS_SUFFIX "val_param"
663 #define VALUE_RESS_SUFFIX "val_res"
665 /** Create a new method type.
667 * @param name the name (ident) of this type
668 * @param n_param the number of parameters
669 * @param n_res the number of results
671 * The arrays for the parameter and result types are not initialized by
674 type *new_type_method (ident *name, int n_param, int n_res);
676 /** Create a new method type with debug information.
678 * @param name the name (ident) of this type
679 * @param n_param the number of parameters
680 * @param n_res the number of results
681 * @param db user defined debug information
683 * The arrays for the parameter and result types are not initialized by
686 type *new_d_type_method (ident *name, int n_param, int n_res, dbg_info* db);
688 /* -- manipulate private fields of method. -- */
690 /** Returns the number of parameters of this method. */
691 int get_method_n_params (const type *method);
693 /** Returns the type of the parameter at position pos of a method. */
694 type *get_method_param_type(type *method, int pos);
695 /** Sets the type of the parameter at position pos of a method.
696 Also changes the type in the pass-by-value representation by just
697 changing the type of the corresponding entity if the representation is constructed. */
698 void set_method_param_type(type *method, int pos, type* tp);
699 /** Returns an entity that represents the copied value argument. Only necessary
700 for compounds passed by value. This information is constructed only on demand. */
701 entity *get_method_value_param_ent(type *method, int pos);
703 * Returns a type that represents the copied value arguments.
705 type *get_method_value_param_type(const type *method);
707 /** Returns the number of results of a method type. */
708 int get_method_n_ress (const type *method);
709 /** Returns the return type of a method type at position pos. */
710 type *get_method_res_type(type *method, int pos);
711 /** Sets the type of the result at position pos of a method.
712 Also changes the type in the pass-by-value representation by just
713 changing the type of the corresponding entity if the representation is constructed. */
714 void set_method_res_type(type *method, int pos, type* tp);
715 /** Returns an entity that represents the copied value result. Only necessary
716 for compounds passed by value. This information is constructed only on demand. */
717 entity *get_method_value_res_ent(type *method, int pos);
720 * Returns a type that represents the copied value results.
722 type *get_method_value_res_type(const type *method);
725 * This enum flags the variadicity of methods (methods with a
726 * variable amount of arguments (e.g. C's printf). Default is
729 typedef enum variadicity {
730 variadicity_non_variadic, /**< non variadic */
731 variadicity_variadic /**< variadic */
734 /** Returns the null-terminated name of this variadicity. */
735 const char *get_variadicity_name(variadicity vari);
737 /** Returns the variadicity of a method. */
738 variadicity get_method_variadicity(const type *method);
740 /** Sets the variadicity of a method. */
741 void set_method_variadicity(type *method, variadicity vari);
744 * Returns the first variadic parameter index of a type.
745 * If this index was NOT set, the index of the last parameter
746 * of the method type plus one is returned for variadic functions.
747 * Non-variadic function types always return -1 here.
749 int get_method_first_variadic_param_index(const type *method);
752 * Sets the first variadic parameter index. This allows to specify
753 * a complete call type (containing the type of all parameters)
754 * but still have the knowledge, which parameter must be passed as
757 void set_method_first_variadic_param_index(type *method, int index);
759 /** Returns true if a type is a method type. */
760 int is_Method_type (const type *method);
763 * @page union_type Representation of a union type.
765 * The union type represents union types.
766 * - n_types: Number of unioned types.
767 * - members: Entities for unioned types. Fixed length array.
768 * This is a dynamic list that can be grown with an "add_" function,
771 /** Creates a new type union. */
772 type *new_type_union (ident *name);
774 /** Creates a new type union with debug information. */
775 type *new_d_type_union (ident *name, dbg_info* db);
777 /* --- manipulate private fields of struct --- */
779 /** Returns the number of unioned types of this union */
780 int get_union_n_members (const type *uni);
782 /** Adds a new entity to a union type */
783 void add_union_member (type *uni, entity *member);
785 /** Returns the entity at position pos of a union */
786 entity *get_union_member (const type *uni, int pos);
788 /** Overwrites a entity at position pos in a union type. */
789 void set_union_member (type *uni, int pos, entity *member);
791 /** Finds member in the list of members and removes it. */
792 void remove_union_member (type *uni, entity *member);
794 /** Returns true if a type is a union type. */
795 int is_Union_type (const type *uni);
798 * @page array_type Representation of an array type
800 * The array type represents rectangular multi dimensional arrays.
801 * The constants representing the bounds must be allocated to
802 * get_const_code_irg() by setting current_ir_graph accordingly.
804 * - n_dimensions: Number of array dimensions.
805 * - *lower_bound: Lower bounds of dimensions. Usually all 0.
806 * - *upper_bound: Upper bounds or dimensions.
807 * - *element_type: The type of the array elements.
808 * - *element_ent: An entity for the array elements to be used for
809 * element selection with Sel.
811 * Do we need several entities? One might want
812 * to select a dimension and not a single element in case of multi
813 * dimensional arrays.
816 /** Create a new type array.
818 * Sets n_dimension to dimension and all dimension entries to NULL.
819 * Initializes order to the order of the dimensions.
820 * The entity for array elements is built automatically.
821 * Set dimension sizes after call to constructor with set_* routines.
823 type *new_type_array (ident *name, int n_dimensions,
826 /** Create a new type array with debug information.
828 * Sets n_dimension to dimension and all dimension entries to NULL.
829 * Initializes order to the order of the dimensions.
830 * The entity for array elements is built automatically.
831 * Set dimension sizes after call to constructor with set_* routines.
832 * A legal array type must have at least one dimension set.
834 type *new_d_type_array (ident *name, int n_dimensions,
835 type *element_type, dbg_info* db);
837 /* --- manipulate private fields of array type --- */
839 /** Returns the number of array dimensions of this type. */
840 int get_array_n_dimensions (const type *array);
843 * Allocates Const nodes of mode_I for one array dimension.
844 * Upper bound in Firm is the element next to the last, i.e. [lower,upper[
846 void set_array_bounds_int (type *array, int dimension, int lower_bound,
849 * Sets the bounds for one array dimension.
850 * Upper bound in Firm is the element next to the last, i.e. [lower,upper[
852 void set_array_bounds (type *array, int dimension, ir_node *lower_bound,
853 ir_node *upper_bound);
854 /** Sets the lower bound for one array dimension, i.e. [lower,upper[ */
855 void set_array_lower_bound (type *array, int dimension, ir_node *lower_bound);
857 /** Allocates Const nodes of mode_I for the lower bound of an array
858 dimension, i.e. [lower,upper[ */
859 void set_array_lower_bound_int (type *array, int dimension, int lower_bound);
861 /** Sets the upper bound for one array dimension, i.e. [lower,upper[ */
862 void set_array_upper_bound (type *array, int dimension, ir_node *upper_bound);
864 /** Allocates Const nodes of mode_I for the upper bound of an array
865 dimension, i.e. [lower,upper[. */
866 void set_array_upper_bound_int (type *array, int dimension, int upper_bound);
868 /** Returns true if lower bound != Unknown. */
869 int has_array_lower_bound (const type *array, int dimension);
870 /** Returns the lower bound of an array. */
871 ir_node * get_array_lower_bound (const type *array, int dimension);
872 /** Works only if bound is Const node with tarval that can be converted to long. */
873 long get_array_lower_bound_int (const type *array, int dimension);
874 /** returns true if lower bound != Unknown */
875 int has_array_upper_bound (const type *array, int dimension);
876 /** Returns the upper bound of an array. */
877 ir_node * get_array_upper_bound (const type *array, int dimension);
878 /** Works only if bound is Const node with tarval that can be converted to long. */
879 long get_array_upper_bound_int (const type *array, int dimension);
881 /** Sets an array dimension to a specific order. */
882 void set_array_order (type *array, int dimension, int order);
884 /** Returns the order of an array dimension. */
885 int get_array_order (const type *array, int dimension);
887 /** Find the array dimension that is placed at order ord. */
888 int find_array_dimension(const type *array, int order);
890 /** Sets the array element type. */
891 void set_array_element_type (type *array, type *tp);
893 /** Gets the array element type. */
894 type *get_array_element_type (type *array);
896 /** Sets the array element entity. */
897 void set_array_element_entity (type *array, entity *ent);
899 /** Get the array element entity. */
900 entity *get_array_element_entity (const type *array);
902 /** Returns true if a type is an array type. */
903 int is_Array_type(const type *array);
906 * @page enumeration_type Representation of an enumeration type
908 * Enumeration types need not necessarily be represented explicitly
909 * by Firm types, as the frontend can lower them to integer constants as
910 * well. For debugging purposes or similar tasks this information is useful.
912 * - *enum: The target values representing the constants used to
913 * represent individual enumerations.
914 * - *enum_nameid: Idents containing the source program name of the enumeration
917 /** Create a new type enumeration -- set the enumerators independently. */
918 type *new_type_enumeration (ident *name, int n_enums);
920 /** Create a new type enumeration with debug information -- set the enumerators independently. */
921 type *new_d_type_enumeration (ident *name, int n_enums, dbg_info* db);
923 /* --- manipulate fields of enumeration type. --- */
925 /** Returns the number of enumeration values of this enumeration */
926 int get_enumeration_n_enums (const type *enumeration);
928 /** Sets the enumeration value at a given position. */
929 void set_enumeration_enum (type *enumeration, int pos, tarval *con);
931 /** Returns the enumeration value at a given position. */
932 tarval *get_enumeration_enum (const type *enumeration, int pos);
934 /** Assign an ident to an enumeration value at a given position. */
935 void set_enumeration_nameid (type *enumeration, int pos, ident *id);
937 /** Returns the assigned ident of an enumeration value at a given position. */
938 ident *get_enumeration_nameid (const type *enumeration, int pos);
940 /** Returns the assigned name of an enumeration value at a given position. */
941 const char *get_enumeration_name(const type *enumeration, int pos);
943 /** Returns true if a type is a enumeration type. */
944 int is_Enumeration_type (const type *enumeration);
947 * @page pointer_type Representation of a pointer type
949 * The mode of the pointer type must be a reference mode.
952 * - points_to: The type of the entity this pointer points to.
955 /** Creates a new type pointer. */
956 type *new_type_pointer (ident *name, type *points_to, ir_mode *ptr_mode);
958 /** Creates a new type pointer with debug information. */
959 type *new_d_type_pointer (ident *name, type *points_to, ir_mode *ptr_mode, dbg_info* db);
961 /* --- manipulate fields of type_pointer --- */
963 /** Sets the type to which a pointer points to. */
964 void set_pointer_points_to_type (type *pointer, type *tp);
966 /** Returns the type to which a pointer points to. */
967 type *get_pointer_points_to_type (type *pointer);
969 /** Returns true if a type is a pointer type. */
970 int is_Pointer_type (const type *pointer);
972 /** Returns the first pointer type that has as points_to tp.
973 * Not efficient: O(#types).
974 * If not found returns unknown_type. */
975 type *find_pointer_type_to_type (type *tp);
978 * @page primitive_type Representation of a primitive type
980 * Primitive types are types that represent indivisible data values that
981 * map directly to modes. They don't have a private attribute. The
982 * important information they carry is held in the common mode field.
984 /** Creates a new primitive type. */
985 type *new_type_primitive (ident *name, ir_mode *mode);
987 /** Creates a new primitive type with debug information. */
988 type *new_d_type_primitive (ident *name, ir_mode *mode, dbg_info* db);
990 /** Returns true if a type is a primitive type. */
991 int is_Primitive_type (const type *primitive);
997 * This type is an auxiliary type dedicated to support type analyses.
999 * The none type represents that there is no type. The type can be used to
1000 * initialize fields of type* that actually can not contain a type or that
1001 * are initialized for an analysis. There exists exactly one type none.
1002 * This type is not on the type list in ir_prog. It is
1003 * allocated when initializing the type module.
1005 * The following values are set:
1007 * - name: "type_none"
1008 * - state: layout_fixed
1011 /** A variable that contains the only none type. */
1012 extern type *firm_none_type;
1013 /** Returns the none type */
1014 type *get_none_type(void);
1017 * @page unknown_type
1019 * This type is an auxiliary type dedicated to support type analyses.
1021 * The unknown type represents that there could be a type, but it is not
1022 * known. This type can be used to initialize fields before an analysis (not known
1023 * yet) or to represent the top of a lattice (could not be determined). There exists
1024 * exactly one type unknown. This type is not on the type list in ir_prog. It is
1025 * allocated when initializing the type module.
1027 * The following values are set:
1029 * - name: "type_unknown"
1030 * - state: layout_fixed
1033 /** A variable that contains the only unknown type. */
1034 extern type *firm_unknown_type;
1035 /** Returns the unknown type */
1036 type *get_unknown_type(void);
1040 * Checks whether a type is atomic.
1041 * @param tp any type
1042 * @return true if type is primitive, pointer or enumeration
1044 int is_atomic_type(const type *tp);
1046 /* --- Support for compound types --- */
1049 * Gets the number of elements in a firm compound type.
1051 * This is just a comfortability function, because structs and
1052 * classes can often be treated be the same code, but they have
1053 * different access functions to their members.
1055 * @param tp The type (must be struct, union or class).
1057 * @return Number of members in the compound type.
1059 int get_compound_n_members(const type *tp);
1062 * Gets the member of a firm compound type at position pos.
1064 * @param tp The type (must be struct, union or class).
1065 * @param pos The number of the member.
1067 * @return The member entity at position pos.
1069 * @see get_compound_n_members() for justification of existence.
1071 entity *get_compound_member(const type *tp, int pos);
1074 * Checks whether a type is compound.
1076 * @param tp - any type
1078 * @return true if the type is class, structure, union or array type.
1080 int is_compound_type(const type *tp);
1083 * Checks, whether a type is a frame type
1085 int is_frame_type(const type *tp);
1088 * Makes a new frame type. Frame types are class types,
1089 * so all class access functions work.
1090 * Frame types are not in the global list of types.
1092 type *new_type_frame(ident *name);
1094 /*-----------------------------------------------------------------*/
1096 /*-----------------------------------------------------------------*/
1099 * Outputs a unique number for this type if libfirm is compiled for
1100 * debugging, (configure with --enable-debug) else returns the address
1101 * of the type cast to long.
1103 long get_type_nr(const type *tp);
1106 # endif /* _TYPE_H_ */