2 * Copyright (C) 1995-2008 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
6 * This file may be distributed and/or modified under the terms of the
7 * GNU General Public License version 2 as published by the Free Software
8 * Foundation and appearing in the file LICENSE.GPL included in the
9 * packaging of this file.
11 * Licensees holding valid libFirm Professional Edition licenses may use
12 * this file in accordance with the libFirm Commercial License.
13 * Agreement provided with the Software.
15 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * @brief Declarations for functions and datastructures to represent types
24 #ifndef FIRM_TYPEREP_H
25 #define FIRM_TYPEREP_H
27 #include "firm_types.h"
31 * @page entity Entity representation
33 * An entity is the representation of program known objects in Firm.
34 * The primary concept of entities is to represent members of complex
35 * types, i.e., fields and methods of classes. As not all programming
36 * language model all variables and methods as members of some class,
37 * the concept of entities is extended to cover also local and global
38 * variables, and arbitrary procedures.
40 * An entity always specifies the type of the object it represents and
41 * the type of the object it is a part of, the owner of the entity.
42 * Originally this is the type of the class of which the entity is a
44 * The owner of local variables is the procedure they are defined in.
45 * The owner of global variables and procedures visible in the whole
46 * program is a universally defined class type "GlobalType". The owner
47 * of procedures defined in the scope of an other procedure is the
48 * enclosing procedure.
50 * The type ir_entity is an abstract data type to represent program entities.
51 * If contains the following attributes:
53 * - owner: A compound type this entity is a part of.
54 * - type: The type of this entity.
55 * - name: The string that represents this entity in the source program
56 * - linkage: A flag indicating how the linker treats a symbol
57 * - offset: The offset of the entity within the compound object in bytes. Only set
58 * if the owner in the state "layout_fixed".
59 * - offset_bits_remainder: The offset bit remainder of a bitfield entity (in a compound)
60 * in bits. Only set if the owner in the state "layout_fixed".
61 * - overwrites: A list of entities overwritten by this entity. This list is only
62 * existent if the owner of this entity is a class. The members in
63 * this list must be entities of super classes.
64 * - overwrittenby: A list of entities that overwrite this entity. This list is only
65 * existent if the owner of this entity is a class. The members in
66 * this list must be entities of sub classes.
67 * - link: A void* to associate some additional information with the entity.
68 * - irg: If the entity is a method this is the ir graph that represents the
70 * - visited: visited flag. Master flag is type_visited.
72 * These fields can only be accessed via access functions.
74 * @see ir_type, ir_entity
78 * Visibility classed for entities.
82 * The entity is visible outside the compilation unit, but it is defined
85 ir_visibility_default,
87 * The entity is local to the compilation unit.
88 * A local entity is not visible in other compilation units.
89 * Note that the entity might still be accessed indirectly from other units
94 * The entity is defined outside the compilation unit but potentially used
97 ir_visibility_external,
99 * This has the same semantic as visibility_local. Additionally the symbol is
100 * completely hidden from the linker (it only appears in the assembly).
101 * While visibility_local is probably still visible to debuggers,
102 * visibility_private symbols aren't and probably won't appear in the object
105 ir_visibility_private
109 * linkage specifies how the linker treats symbols
112 IR_LINKAGE_DEFAULT = 0,
114 * A symbol whose definition won't change in a program.
115 * Optimisation might replace loads from this entity with constants.
116 * Also most linkers put such data in a constant segment which is shared
117 * between multiple running instances of the same application.
119 IR_LINKAGE_CONSTANT = 1 << 0,
121 * The entity is a weak symbol.
122 * A weak symbol is overridden by a non-weak symbol if one exists.
123 * Most linkers only support the IR_LINKAGE_WEAK in combination with
126 IR_LINKAGE_WEAK = 1 << 1,
128 * The entity may be removed when it isn't referenced anywhere in the
129 * compilation unit even if it is exported (non-local).
130 * Typically used for C++ instantiated template code (,,COMDAT'' section).
132 IR_LINKAGE_GARBAGE_COLLECT = 1 << 2,
134 * The linker will try to merge entities with same name from different
135 * compilation units. This is the usual behaviour for global variables
136 * without explicit initialisation in C (``COMMON'' symbols). It's also
137 * typically used in C++ for instantiated template code (,,COMDAT'' section)
139 IR_LINKAGE_MERGE = 1 << 3,
141 * Some entity uses are potentially hidden from the compiler.
142 * (For example because they happen in an asm("") statement. This flag
143 * should be set for __attribute__((used)) in C code).
144 * Setting this flag prohibits that the compiler making assumptions about
145 * read/write behaviour to global variables or changing calling conventions
146 * from cdecl to fastcall.
148 IR_LINKAGE_HIDDEN_USER = 1 << 4
152 * Return the visibility class of an entity
154 ir_visibility get_entity_visibility(const ir_entity *entity);
157 * Set visibility class of an entity
159 void set_entity_visibility(ir_entity *entity, ir_visibility visibility);
162 * Return 1 if the entity is visible outside the current compilation unit
163 * or to unknown callers (like asm statements).
164 * (The entity might still be accessible indirectly through pointers)
165 * This is a convenience function and does the same as
166 * get_entity_visibility(entity) != ir_visibility_local ||
167 * (get_entity_linkage(entity) & IR_LINKAGE_HIDDEN_USER)
169 int entity_is_externally_visible(const ir_entity *entity);
172 * Return 1 if the entity has a definition (initializer) in the current
175 int entity_has_definition(const ir_entity *entity);
178 * Creates a new entity.
180 * Automatically inserts the entity as a member of owner.
181 * Entity is automatic_allocated and uninitialized except if the type
182 * is type_method, then it is static_allocated and constant. The constant
183 * value is a pointer to the method.
184 * Visibility is local, offset -1, and it is not volatile.
186 ir_entity *new_entity(ir_type *owner, ident *name, ir_type *tp);
189 * Creates a new entity.
191 * Automatically inserts the entity as a member of owner.
192 * The entity is automatic allocated and uninitialized except if the type
193 * is type_method, then it is static allocated and constant. The constant
194 * value is a pointer to the method.
195 * Visibility is local, offset -1, and it is not volatile.
197 ir_entity *new_d_entity(ir_type *owner, ident *name, ir_type *tp, dbg_info *db);
200 * Copies the entity if the new_owner is different from the
201 * owner of the old entity, else returns the old entity.
203 * Automatically inserts the new entity as a member of owner.
204 * Resets the overwrites/overwritten_by fields.
205 * Keeps the old atomic value.
207 ir_entity *copy_entity_own(ir_entity *old, ir_type *new_owner);
210 * Copies the entity if the new_name is different from the
211 * name of the old entity, else returns the old entity.
213 * Automatically inserts the new entity as a member of owner.
214 * The mangled name ld_name is set to NULL.
215 * Overwrites relation is copied from old.
217 ir_entity *copy_entity_name(ir_entity *old, ident *new_name);
222 * The owner will still contain the pointer to this
223 * entity, as well as all other references!
225 void free_entity(ir_entity *ent);
227 /** Returns the name of an entity. */
228 const char *get_entity_name(const ir_entity *ent);
230 /** Returns the ident of an entity. */
231 ident *get_entity_ident(const ir_entity *ent);
233 /** Sets the ident of the entity. */
234 void set_entity_ident(ir_entity *ent, ident *id);
236 /** Returns the mangled name of the entity.
238 * If the mangled name is set it returns the existing name.
239 * Else it generates a name with mangle_entity()
240 * and remembers this new name internally.
242 ident *get_entity_ld_ident(const ir_entity *ent);
244 /** Sets the mangled name of the entity. */
245 void set_entity_ld_ident(ir_entity *ent, ident *ld_ident);
247 /** Returns the mangled name of the entity as a string. */
248 const char *get_entity_ld_name(const ir_entity *ent);
250 /** Returns the owner of the entity. */
251 ir_type *get_entity_owner(const ir_entity *ent);
253 /** Sets the owner field in entity to owner. Don't forget to add
255 void set_entity_owner(ir_entity *ent, ir_type *owner);
257 /** Returns the type of an entity. */
258 ir_type *get_entity_type(const ir_entity *ent);
260 /** Sets the type of an entity. */
261 void set_entity_type(ir_entity *ent, ir_type *tp);
263 /** Returns the linkage of an entity. */
264 ir_linkage get_entity_linkage(const ir_entity *entity);
266 /** Sets the linkage of an entity. */
267 void set_entity_linkage(ir_entity *entity, ir_linkage linkage);
268 void add_entity_linkage(ir_entity *entity, ir_linkage linkage);
269 void remove_entity_linkage(ir_entity *entity, ir_linkage linkage);
271 /** Returns 1 if the value of a global symbol never changes in a program */
272 int is_entity_constant(const ir_entity *ent);
275 * This enumeration flags the volatility of entities and Loads/Stores.
279 volatility_non_volatile, /**< The entity is not volatile. Default. */
280 volatility_is_volatile /**< The entity is volatile. */
284 * Returns the volatility of an entity.
287 ir_volatility get_entity_volatility(const ir_entity *ent);
290 * Sets the volatility of an entity.
293 void set_entity_volatility(ir_entity *ent, ir_volatility vol);
295 /** Return the name of the volatility. */
296 const char *get_volatility_name(ir_volatility var);
298 /** Returns alignment of entity in bytes */
299 unsigned get_entity_alignment(const ir_entity *entity);
301 /** Allows you to override the type alignment for an entity.
302 * @param alignment alignment in bytes
304 void set_entity_alignment(ir_entity *entity, unsigned alignment);
308 * This enumeration flags the align of Loads/Stores.
312 align_non_aligned, /**< The entity is not aligned. */
313 align_is_aligned /**< The entity is aligned. Default */
317 * Returns indication wether entity is aligned in memory.
320 ir_align get_entity_aligned(const ir_entity *ent);
323 * Sets indication wether entity is aligned in memory
326 void set_entity_aligned(ir_entity *ent, ir_align a);
328 /** Return the name of the alignment. */
329 const char *get_align_name(ir_align a);
331 /** Returns the offset of an entity (in a compound) in bytes. Only set if layout = fixed. */
332 int get_entity_offset(const ir_entity *ent);
334 /** Sets the offset of an entity (in a compound) in bytes. */
335 void set_entity_offset(ir_entity *ent, int offset);
337 /** Returns the offset bit remainder of a bitfield entity (in a compound) in bits. Only set if layout = fixed. */
338 unsigned char get_entity_offset_bits_remainder(const ir_entity *ent);
340 /** Sets the offset bit remainder of a bitfield entity (in a compound) in bits. */
341 void set_entity_offset_bits_remainder(ir_entity *ent, unsigned char offset);
343 /** Returns the stored intermediate information. */
344 void *get_entity_link(const ir_entity *ent);
346 /** Stores new intermediate information. */
347 void set_entity_link(ir_entity *ent, void *l);
349 /* -- Fields of method entities -- */
350 /** The entity knows the corresponding irg if the entity is a method.
351 This allows to get from a Call to the called irg. */
352 ir_graph *get_entity_irg(const ir_entity *ent);
353 void set_entity_irg(ir_entity *ent, ir_graph *irg);
355 /** Gets the entity vtable number. */
356 unsigned get_entity_vtable_number(const ir_entity *ent);
358 /** Sets the entity vtable number. */
359 void set_entity_vtable_number(ir_entity *ent, unsigned vtable_number);
361 /** Set label number of an entity with code type */
362 void set_entity_label(ir_entity *ent, ir_label_t label);
363 /** Return label number of an entity with code type */
364 ir_label_t get_entity_label(const ir_entity *ent);
366 /** Checks if an entity is compiler generated. */
367 int is_entity_compiler_generated(const ir_entity *ent);
369 /** Sets/resets the compiler generated flag. */
370 void set_entity_compiler_generated(ir_entity *ent, int flag);
373 * Bitfield type indicating the way an entity is used.
376 ir_usage_none = 0, /**< This entity is unused. */
377 ir_usage_address_taken = 1 << 0, /**< The address of this entity was taken. */
378 ir_usage_write = 1 << 1, /**< The entity was written to. */
379 ir_usage_read = 1 << 2, /**< The entity was read. */
380 ir_usage_reinterpret_cast = 1 << 3, /**< The entity was read but with a wrong mode
381 (an implicit reinterpret cast) */
382 /** Unknown access */
384 = ir_usage_address_taken | ir_usage_write | ir_usage_read
385 | ir_usage_reinterpret_cast
388 /** Return the entity usage */
389 ir_entity_usage get_entity_usage(const ir_entity *ent);
391 /** Sets/resets the state of the address taken flag of an entity. */
392 void set_entity_usage(ir_entity *ent, ir_entity_usage flag);
395 * Returns the debug information of an entity.
397 * @param ent The entity.
399 dbg_info *get_entity_dbg_info(const ir_entity *ent);
402 * Sets the debug information of an entity.
404 * @param ent The entity.
405 * @param db The debug info.
407 void set_entity_dbg_info(ir_entity *ent, dbg_info *db);
409 /* -- Representation of constant values of entities -- */
411 * Returns true if the the node is representable as code on
414 * @deprecated This function is not used by libFirm and stays here
415 * only as a helper for the old Jack frontend.
417 int is_irn_const_expression(ir_node *n);
420 * Copies a Firm subgraph that complies to the restrictions for
421 * constant expressions to current_block in current_ir_graph.
423 * @param dbg debug info for all newly created nodes
426 * Set current_ir_graph to get_const_code_irg() to generate a constant
429 ir_node *copy_const_value(dbg_info *dbg, ir_node *n);
431 /* Set has no effect for existent entities of type method. */
432 ir_node *get_atomic_ent_value(ir_entity *ent);
433 void set_atomic_ent_value(ir_entity *ent, ir_node *val);
435 /** the kind (type) of an initializer */
436 typedef enum ir_initializer_kind_t {
437 /** initializer containing an ir_node from the const-code irg */
438 IR_INITIALIZER_CONST,
439 /** initializer containing a tarval */
440 IR_INITIALIZER_TARVAL,
441 /** initializes type with default values (usually 0) */
443 /** list of initializers used to initializer a compound or array type */
444 IR_INITIALIZER_COMPOUND
445 } ir_initializer_kind_t;
447 /** returns kind of an initializer */
448 ir_initializer_kind_t get_initializer_kind(const ir_initializer_t *initializer);
450 /** Return the name of the initializer kind. */
451 const char *get_initializer_kind_name(ir_initializer_kind_t ini);
454 * returns the null initializer (there's only one instance of it in a program )
456 ir_initializer_t *get_initializer_null(void);
459 * creates an initializer containing a reference to a node on the const-code
462 ir_initializer_t *create_initializer_const(ir_node *value);
464 /** creates an initializer containing a single tarval value */
465 ir_initializer_t *create_initializer_tarval(tarval *tv);
467 /** return value contained in a const initializer */
468 ir_node *get_initializer_const_value(const ir_initializer_t *initializer);
470 /** return value contained in a tarval initializer */
471 tarval *get_initializer_tarval_value(const ir_initializer_t *initialzier);
473 /** creates a compound initializer which holds @p n_entries entries */
474 ir_initializer_t *create_initializer_compound(unsigned n_entries);
476 /** returns the number of entries in a compound initializer */
477 unsigned get_initializer_compound_n_entries(const ir_initializer_t *initializer);
479 /** sets entry with index @p index to the initializer @p value */
480 void set_initializer_compound_value(ir_initializer_t *initializer,
481 unsigned index, ir_initializer_t *value);
483 /** returns the value with index @p index of a compound initializer */
484 ir_initializer_t *get_initializer_compound_value(
485 const ir_initializer_t *initializer, unsigned index);
487 /** Sets the new style initializers of an entity. */
488 void set_entity_initializer(ir_entity *entity, ir_initializer_t *initializer);
490 /** Returns true, if an entity has new style initializers. */
491 int has_entity_initializer(const ir_entity *entity);
493 /** Return the new style initializers of an entity. */
494 ir_initializer_t *get_entity_initializer(const ir_entity *entity);
496 /* --- Fields of entities with a class type as owner --- */
497 /* Overwrites is a field that specifies that an access to the overwritten
498 entity in the supertype must use this entity. It's a list as with
499 multiple inheritance several entities can be overwritten. This field
500 is mostly useful for method entities.
501 If a Sel node selects an entity that is overwritten by other entities it
502 must return a pointer to the entity of the dynamic type of the pointer
503 that is passed to it. Lowering of the Sel node must assure this.
504 Overwrittenby is the inverse of overwrites. Both add routines add
505 both relations, they only differ in the order of arguments. */
506 void add_entity_overwrites(ir_entity *ent, ir_entity *overwritten);
507 int get_entity_n_overwrites(const ir_entity *ent);
508 int get_entity_overwrites_index(const ir_entity *ent, ir_entity *overwritten);
509 ir_entity *get_entity_overwrites(const ir_entity *ent, int pos);
510 void set_entity_overwrites(ir_entity *ent, int pos, ir_entity *overwritten);
511 void remove_entity_overwrites(ir_entity *ent, ir_entity *overwritten);
513 void add_entity_overwrittenby(ir_entity *ent, ir_entity *overwrites);
514 int get_entity_n_overwrittenby(const ir_entity *ent);
515 int get_entity_overwrittenby_index(const ir_entity *ent, ir_entity *overwrites);
516 ir_entity *get_entity_overwrittenby(const ir_entity *ent, int pos);
517 void set_entity_overwrittenby(ir_entity *ent, int pos, ir_entity *overwrites);
518 void remove_entity_overwrittenby(ir_entity *ent, ir_entity *overwrites);
521 * Checks whether a pointer points to an entity.
523 * @param thing an arbitrary pointer
526 * true if the thing is an entity, else false
528 int is_entity(const void *thing);
530 /** Returns true if the type of the entity is a primitive, pointer
531 * enumeration or method type.
533 * @note This is a different classification than from is_primitive_type().
535 int is_atomic_entity(const ir_entity *ent);
536 /** Returns true if the type of the entity is a class, structure,
537 array or union type. */
538 int is_compound_entity(const ir_entity *ent);
539 /** Returns true if the type of the entity is a Method type. */
540 int is_method_entity(const ir_entity *ent);
542 /** Outputs a unique number for this entity if libfirm is compiled for
543 * debugging, (configure with --enable-debug) else returns the address
544 * of the type cast to long.
546 long get_entity_nr(const ir_entity *ent);
548 /** Returns the entities visited count. */
549 ir_visited_t get_entity_visited(const ir_entity *ent);
551 /** Sets the entities visited count. */
552 void set_entity_visited(ir_entity *ent, ir_visited_t num);
554 /** Sets visited field in entity to entity_visited. */
555 void mark_entity_visited(ir_entity *ent);
557 /** Returns true if this entity was visited. */
558 int entity_visited(const ir_entity *ent);
560 /** Returns true if this entity was not visited. */
561 int entity_not_visited(const ir_entity *ent);
564 * Returns the mask of the additional entity properties.
565 * The properties are automatically inherited from the irg if available
566 * or from the method type if they were not set using
567 * set_entity_additional_properties() or
568 * set_entity_additional_property().
570 unsigned get_entity_additional_properties(const ir_entity *ent);
572 /** Sets the mask of the additional graph properties. */
573 void set_entity_additional_properties(ir_entity *ent, unsigned property_mask);
575 /** Sets one additional graph property. */
576 void set_entity_additional_property(ir_entity *ent, mtp_additional_property flag);
578 /** Returns the class type that this type info entity represents or NULL
579 if ent is no type info entity. */
580 ir_type *get_entity_repr_class(const ir_entity *ent);
583 * @page unknown_entity The Unknown entity
585 * This entity is an auxiliary entity dedicated to support analyses.
587 * The unknown entity represents that there could be an entity, but it is not
588 * known. This entity can be used to initialize fields before an analysis (not known
589 * yet) or to represent the top of a lattice (could not be determined). There exists
590 * exactly one entity unknown. This entity has as owner and as type the unknown type. It is
591 * allocated when initializing the entity module.
593 * The entity can take the role of any entity, also methods. It returns default
594 * values in these cases.
596 * The following values are set:
598 * - name = "unknown_entity"
599 * - ld_name = "unknown_entity"
600 * - owner = unknown_type
601 * - type = unknown_type
603 * - value = SymConst(unknown_entity)
606 * - volatility = volatility_non_volatile
607 * - stickyness = stickyness_unsticky
609 * - overwrites = NULL
610 * - overwrittenby = NULL
615 /** A variable that contains the only unknown entity. */
616 extern ir_entity *unknown_entity;
618 /** Returns the @link unknown_entity unknown entity @endlink. */
619 ir_entity *get_unknown_entity(void);
621 /** Encodes how a pointer parameter is accessed. */
622 typedef enum acc_bits {
623 ptr_access_none = 0, /**< no access */
624 ptr_access_read = 1, /**< read access */
625 ptr_access_write = 2, /**< write access */
626 ptr_access_rw = ptr_access_read|ptr_access_write, /**< read AND write access */
627 ptr_access_store = 4, /**< the pointer is stored */
628 ptr_access_all = ptr_access_rw|ptr_access_store /**< all possible access */
631 #define IS_READ(a) ((a) & ptr_access_read)
632 #define IS_WRITTEN(a) ((a) & ptr_access_write)
633 #define IS_STORED(a) ((a) & ptr_access_store)
636 * @page tyop type operations
637 * This module specifies the kinds of types available in firm.
639 * They are called type opcodes. These include classes, structs, methods, unions,
640 * arrays, enumerations, pointers and primitive types.
641 * Special types with own opcodes are the id type, a type representing an unknown
642 * type and a type used to specify that something has no type.
646 * An enum for the type kinds.
647 * For each type kind exists a typecode to identify it.
650 tpo_uninitialized = 0, /* not a type opcode */
651 tpo_class, /**< A class type. */
652 tpo_struct, /**< A struct type. */
653 tpo_method, /**< A method type. */
654 tpo_union, /**< An union type. */
655 tpo_array, /**< An array type. */
656 tpo_enumeration, /**< An enumeration type. */
657 tpo_pointer, /**< A pointer type. */
658 tpo_primitive, /**< A primitive type. */
659 tpo_code, /**< a piece of code (a basic block) */
660 tpo_none, /**< Special type for the None type. */
661 tpo_unknown, /**< Special code for the Unknown type. */
662 tpo_last = tpo_unknown /* not a type opcode */
666 * A structure containing information about a kind of type.
667 * A structure containing information about a kind of type. So far
668 * this is only the kind name, an enum for case-switching and some
671 * @see get_tpop_name(), get_tpop_code()
673 typedef struct tp_op tp_op;
677 * Returns the string for the type opcode.
679 * @param op The type opcode to get the string from.
680 * @return a string. (@todo Null terminated?)
682 const char *get_tpop_name(const tp_op *op);
685 * Returns an enum for the type opcode.
687 * @param op The type opcode to get the enum from.
690 tp_opcode get_tpop_code(const tp_op *op);
693 * This type opcode marks that the corresponding type is a class type.
695 * Consequently the type refers to supertypes, subtypes and entities.
696 * Entities can be any fields, but also methods.
697 * @@@ value class or not???
698 * This struct is dynamically allocated but constant for the lifetime
701 extern const tp_op *type_class;
702 const tp_op *get_tpop_class(void);
705 * This type opcode marks that the corresponding type is a compound type
708 * Consequently the type refers to a list of entities
709 * which may not be methods (but pointers to methods).
710 * This struct is dynamically allocated but constant for the lifetime
713 extern const tp_op *type_struct;
714 const tp_op *get_tpop_struct(void);
717 * This type opcode marks that the corresponding type is a method type.
719 * Consequently it refers to a list of arguments and results.
720 * This struct is dynamically allocated but constant for the lifetime
723 extern const tp_op *type_method;
724 const tp_op *get_tpop_method(void);
727 * This type opcode marks that the corresponding type is a union type.
729 * Consequently it refers to a list of unioned types.
730 * This struct is dynamically allocated but constant for the lifetime
733 extern const tp_op *type_union;
734 const tp_op *get_tpop_union(void);
737 * This type opcode marks that the corresponding type is an array type.
739 * Consequently it contains a list of dimensions (lower and upper bounds)
740 * and an element type.
741 * This struct is dynamically allocated but constant for the lifetime
744 extern const tp_op *type_array;
745 const tp_op *get_tpop_array(void);
748 * This type opcode marks that the corresponding type is an enumeration type.
750 * Consequently it contains a list of idents for the enumeration identifiers
751 * and a list of target values that are the constants used to implement
753 * This struct is dynamically allocated but constant for the lifetime
756 extern const tp_op *type_enumeration;
757 const tp_op *get_tpop_enumeration(void);
760 * This type opcode marks that the corresponding type is a pointer type.
762 * It contains a reference to the type the pointer points to.
763 * This struct is dynamically allocated but constant for the lifetime
766 extern const tp_op *type_pointer;
767 const tp_op *get_tpop_pointer(void);
770 * This type opcode marks that the corresponding type is a primitive type.
772 * Primitive types are types that are directly mapped to target machine
774 * This struct is dynamically allocated but constant for the lifetime
777 extern const tp_op *type_primitive;
778 const tp_op *get_tpop_primitive(void);
781 * The code type is used to mark pieces of code (basic blocks)
783 extern const tp_op *tpop_code;
784 const tp_op *get_tpop_code_type(void);
787 * This type opcode is an auxiliary opcode dedicated to support type analyses.
789 * Types with this opcode represents that there is no type.
790 * The type can be used to initialize fields of the type* that actually can not
791 * contain a type or that are initialized for an analysis. There exists exactly
792 * one type with this opcode.
794 extern const tp_op *tpop_none;
795 const tp_op *get_tpop_none(void);
798 * This type opcode is an auxiliary opcode dedicated to support type analyses.
800 * Types with this opcode represents that there could be a type, but it is not
801 * known. This type can be used to initialize fields before an analysis (not known
802 * yet) or to represent the top of a lattice (could not be determined). There exists
803 * exactly one type with this opcode.
805 extern const tp_op *tpop_unknown;
806 const tp_op *get_tpop_unknown(void);
808 /* ----------------------------------------------------------------------- */
809 /* Classify pairs of types/entities in the inheritance relations. */
810 /* ----------------------------------------------------------------------- */
812 /** Returns true if low is subclass of high.
814 * Low is a subclass of high if low == high or if low is a subclass of
815 * a subclass of high. I.e, we search in all subtypes of high for low.
816 * @@@ this can be implemented more efficient if we know the set of all
817 * subclasses of high. */
818 int is_SubClass_of(ir_type *low, ir_type *high);
820 /** Subclass check for pointers to classes.
822 * Dereferences at both types the same amount of pointer types (as
823 * many as possible). If the remaining types are both class types
824 * and subclasses, returns true, else false. Can also be called with
825 * two class types. */
826 int is_SubClass_ptr_of(ir_type *low, ir_type *high);
828 /** Returns true if high is superclass of low.
830 * Low is a subclass of high if low == high or if low is a subclass of
831 * a subclass of high. I.e, we search in all subtypes of high for low.
832 * @@@ this can be implemented more efficient if we know the set of all
833 * subclasses of high. */
834 #define is_SuperClass_of(high, low) is_SubClass_of(low, high)
836 /** Superclass check for pointers to classes.
838 * Dereferences at both types the same amount of pointer types (as
839 * many as possible). If the remaining types are both class types
840 * and superclasses, returns true, else false. Can also be called with
841 * two class types. */
842 #define is_SuperClass_ptr_of(low, high) is_SubClass_ptr_of(high, low)
844 /** Returns true if high is (transitive) overwritten by low.
846 * Returns false if high == low. */
847 int is_overwritten_by(ir_entity *high, ir_entity *low);
849 /** Resolve polymorphism in the inheritance relation.
851 * Returns the dynamically referenced entity if the static entity and the
852 * dynamic type are given.
853 * Searches downwards in overwritten tree. */
854 ir_entity *resolve_ent_polymorphy(ir_type *dynamic_class, ir_entity* static_ent);
856 /* ----------------------------------------------------------------------- */
857 /* Resolve implicit inheritance. */
858 /* ----------------------------------------------------------------------- */
860 /** Default name mangling for inherited entities.
862 * Returns an ident that consists of the name of type followed by an
863 * underscore and the name (not ld_name) of the entity. */
864 ident *default_mangle_inherited_name(const ir_entity *ent, const ir_type *clss);
866 /** Type of argument functions for inheritance resolver.
868 * @param ent The entity in the super type that will be overwritten
869 * by the newly generated entity, for which this name is
871 * @param clss The class type in which the new entity will be placed.
873 typedef ident *mangle_inherited_name_func(const ir_entity *ent, const ir_type *clss);
875 /** Resolve implicit inheritance.
877 * Resolves the implicit inheritance supplied by firm. Firm defines,
878 * that each entity that is not overwritten in a subclass is
879 * inherited to this subclass without change implicitly. This
880 * function generates entities that explicitly represent this
881 * inheritance. It generates for each entity overwriting entities in
882 * all subclasses of the owner of the entity, if the entity is not
883 * overwritten in that subclass.
885 * The name of the new entity is generated with the function passed.
886 * If the function is NULL, the default_mangle_inherited_name() is
889 * This function was moved here from firmlower 3/2005.
891 void resolve_inheritance(mangle_inherited_name_func *mfunc);
894 /* ----------------------------------------------------------------------- */
895 /* The transitive closure of the subclass/superclass and */
896 /* overwrites/overwrittenby relation. */
898 /* A walk over the ir (O(#types+#entities)) computes the transitive */
899 /* closure. Adding a new type/entity or changing the basic relations in */
900 /* some other way invalidates the transitive closure, i.e., it is not */
901 /* updated by the basic functions. */
903 /* The transitive edges are held in a set, not in an array as the */
904 /* underlying relation. */
906 /* Do the sets contain the node itself? I assume NOT! */
907 /* ----------------------------------------------------------------------- */
909 /** The state of the transitive closure.
911 * @todo: we could manage the state for each relation separately. Invalidating
912 * the entity relations does not mean invalidating the class relation. */
914 inh_transitive_closure_none, /**< Closure is not computed, can not be accessed. */
915 inh_transitive_closure_valid, /**< Closure computed and valid. */
916 inh_transitive_closure_invalid, /**< Closure invalid, but can be accessed. */
917 inh_transitive_closure_max /**< Invalid value. */
918 } inh_transitive_closure_state;
920 void set_irp_inh_transitive_closure_state(inh_transitive_closure_state s);
921 void invalidate_irp_inh_transitive_closure_state(void);
922 inh_transitive_closure_state get_irp_inh_transitive_closure_state(void);
925 /** Compute transitive closure of the subclass/superclass and
926 * overwrites/overwrittenby relation.
928 * This function walks over the ir (O(\#types+\#entities)) to compute the
929 * transitive closure. */
930 void compute_inh_transitive_closure(void);
932 /** Free memory occupied by the transitive closure information. */
933 void free_inh_transitive_closure(void);
936 /* - subtype ------------------------------------------------------------- */
938 /** Iterate over all transitive subtypes. */
939 ir_type *get_class_trans_subtype_first(const ir_type *tp);
940 ir_type *get_class_trans_subtype_next(const ir_type *tp);
941 int is_class_trans_subtype(const ir_type *tp, const ir_type *subtp);
943 /* - supertype ----------------------------------------------------------- */
945 /** Iterate over all transitive supertypes. */
946 ir_type *get_class_trans_supertype_first(const ir_type *tp);
947 ir_type *get_class_trans_supertype_next(const ir_type *tp);
949 /* - overwrittenby ------------------------------------------------------- */
951 /** Iterate over all entities that transitive overwrite this entities. */
952 ir_entity *get_entity_trans_overwrittenby_first(const ir_entity *ent);
953 ir_entity *get_entity_trans_overwrittenby_next(const ir_entity *ent);
955 /* - overwrites ---------------------------------------------------------- */
957 /** Iterate over all transitive overwritten entities. */
958 ir_entity *get_entity_trans_overwrites_first(const ir_entity *ent);
959 ir_entity *get_entity_trans_overwrites_next(const ir_entity *ent);
962 /* ----------------------------------------------------------------------- */
963 /** The state of Cast operations that cast class types or pointers to class
966 * The state expresses, how far Cast operations conform with the class
970 * class B1 extends A {}
971 * class B2 extends A {}
972 * class C extends B1 {}
973 * normalized: Cast operations conform with the inheritance relation.
974 * I.e., the type of the operand of a Cast is either a super= or a sub-
975 * type of the type casted to. Example: (A)((B2) (new C())).
976 * transitive: Cast operations conform with the transitive inheritance
977 * relation. Example: (A)(new C()).
978 * any: Cast operations do not conform with the transitive inheritance
979 * relation. Example: (B2)(new B1())
981 /* ----------------------------------------------------------------------- */
983 /** Flags for class cast state.
985 * The state in irp is always smaller or equal to the state of any
988 * We rely on the ordering of the enum. */
990 ir_class_casts_any = 0, /**< There are class casts that do not cast in conformance with
991 the class hierarchy. @@@ So far this does not happen in Firm. */
992 ir_class_casts_transitive = 1, /**< Class casts conform to transitive inheritance edges. Default. */
993 ir_class_casts_normalized = 2, /**< Class casts conform to inheritance edges. */
994 ir_class_casts_state_max
995 } ir_class_cast_state;
996 const char *get_class_cast_state_string(ir_class_cast_state s);
998 void set_irg_class_cast_state(ir_graph *irg, ir_class_cast_state s);
999 ir_class_cast_state get_irg_class_cast_state(const ir_graph *irg);
1000 void set_irp_class_cast_state(ir_class_cast_state s);
1001 ir_class_cast_state get_irp_class_cast_state(void);
1003 /** Verify the class cast state of an irg.
1005 * Asserts if state is to high, outputs debug warning if state is to low
1006 * and firm verbosity is set.
1008 void verify_irg_class_cast_state(ir_graph *irg);
1011 * possible trvrfy() error codes
1013 enum trvrfy_error_codes {
1014 no_error = 0, /**< no error */
1015 error_ent_not_cont, /**< overwritten entity not in superclass */
1016 error_null_mem, /**< compound contains NULL member */
1017 error_const_on_wrong_irg, /**< constant placed on wrong IRG */
1018 error_existent_entity_without_irg, /**< Method entities with pecularity_exist must have an irg */
1019 error_wrong_ent_overwrites, /**< number of entity overwrites exceeds number of class overwrites */
1020 error_inherited_ent_without_const, /**< inherited method entity not pointing to existent entity */
1021 error_glob_ent_allocation, /**< wrong allocation of a global entity */
1022 error_ent_const_mode, /**< Mode of constant in entity did not match entities type. */
1023 error_ent_wrong_owner /**< Mode of constant in entity did not match entities type. */
1030 * 0 if no error encountered
1032 int check_type(ir_type *tp);
1035 * Check an entity. Currently, we check only if initialized constants
1036 * are build on the const irg graph.
1039 * 0 if no error encountered
1040 * != 0 a trvrfy_error_codes code
1042 int check_entity(ir_entity *ent);
1045 * Walks the type information and performs a set of sanity checks.
1047 * Currently, the following checks are executed:
1048 * - values of initialized entities must be allocated on the constant IRG
1049 * - class types: doesn't have NULL members
1050 * - class types: all overwrites are existent in the super type
1053 * 0 if graph is correct
1059 * If NDEBUG is defined performs nothing, else calls the tr_vrfy() function.
1064 #define TR_VRFY() tr_vrfy()
1068 * @page type representation of types
1070 * Datastructure to hold type information.
1072 * This module supplies a datastructure to represent all types
1073 * known in the compiled program. This includes types specified
1074 * in the program as well as types defined by the language. In the
1075 * view of the intermediate representation there is no difference
1076 * between these types. Finally it specifies some auxiliary types.
1078 * There exist several kinds of types, arranged by the structure of
1079 * the type. A type is described by a set of attributes. Some of
1080 * these attributes are common to all types, others depend on the
1083 * Types are different from the modes defined in irmode: Types are
1084 * on the level of the programming language, modes at the level of
1085 * the target processor.
1088 /** Frees all entities associated with a type.
1089 * Does not free the array entity.
1090 * Warning: ensure these entities are not referenced anywhere else.
1092 void free_type_entities(ir_type *tp);
1094 /** Frees the memory used by the type.
1096 * Removes the type from the type list. Does not free the entities
1097 * belonging to the type, except for the array element entity. Does
1098 * not free if tp is "none" or "unknown". Frees entities in value
1099 * param subtypes of method types!!! Make sure these are not
1100 * referenced any more. Further make sure there is no pointer type
1101 * that refers to this type. */
1102 void free_type(ir_type *tp);
1104 const tp_op *get_type_tpop(const ir_type *tp);
1105 ident *get_type_tpop_nameid(const ir_type *tp);
1106 const char *get_type_tpop_name(const ir_type *tp);
1107 tp_opcode get_type_tpop_code(const ir_type *tp);
1110 * construct a string representing the type.
1111 * This uses the info retrieved by the type_dbg_info if available.
1112 * Otherwise it tries to create an approximate textual representation of the
1114 * Keep in mind that this representation is not unique for each type,
1115 * might abstract away some details. The main intention of this is creating
1116 * human redable strings giving an idea of the type.
1118 void ir_print_type(char *buffer, size_t buffer_size, const ir_type *tp);
1120 /** The state of the type layout. */
1122 layout_undefined, /**< The layout of this type is not defined.
1123 Address computation to access fields is not
1124 possible, fields must be accessed by Sel
1125 nodes. Enumeration constants might be undefined.
1126 This is the default value except for
1127 pointer, primitive and method types. */
1128 layout_fixed /**< The layout is fixed, all component/member entities
1129 have an offset assigned. Size of the type is known.
1130 Arrays can be accessed by explicit address
1131 computation. Enumeration constants must be defined.
1132 Default for pointer, primitive and method types. */
1135 /** Returns a human readable string for the enum entry. */
1136 const char *get_type_state_name(ir_type_state s);
1138 /** Returns the type layout state of a type. */
1139 ir_type_state get_type_state(const ir_type *tp);
1141 /** Sets the type layout state of a type.
1143 * For primitives, pointer and method types the layout is always fixed.
1144 * This call is legal but has no effect.
1146 void set_type_state(ir_type *tp, ir_type_state state);
1148 /** Returns the mode of a type.
1150 * Returns NULL for all non atomic types.
1152 ir_mode *get_type_mode(const ir_type *tp);
1154 /** Sets the mode of a type.
1156 * Only has an effect on primitive, enumeration and pointer types.
1158 void set_type_mode(ir_type *tp, ir_mode* m);
1160 /** Returns the size of a type in bytes. */
1161 unsigned get_type_size_bytes(const ir_type *tp);
1163 /** Sets the size of a type in bytes.
1165 * For primitive, enumeration, pointer and method types the size
1166 * is always fixed. This call is legal but has no effect.
1168 void set_type_size_bytes(ir_type *tp, unsigned size);
1170 /** Returns the alignment of a type in bytes. */
1171 unsigned get_type_alignment_bytes(ir_type *tp);
1173 /** Returns the alignment of a type in bits.
1175 * If the alignment of a type is
1176 * not set, it is calculated here according to the following rules:
1177 * -#.) if a type has a mode, the alignment is the mode size.
1178 * -#.) compound types have the alignment of there biggest member.
1179 * -#.) array types have the alignment of there element type.
1180 * -#.) method types return 0 here.
1181 * -#.) all other types return 1 here (i.e. aligned at byte).
1183 void set_type_alignment_bytes(ir_type *tp, unsigned align);
1185 /** Returns the visited count of a type. */
1186 ir_visited_t get_type_visited(const ir_type *tp);
1187 /** Sets the visited count of a type to num. */
1188 void set_type_visited(ir_type *tp, ir_visited_t num);
1189 /** Sets visited field in type to type_visited. */
1190 void mark_type_visited(ir_type *tp);
1191 /** Returns non-zero if the type is already visited */
1192 int type_visited(const ir_type *tp);
1193 /** Returns non-zero if the type is not yet visited */
1194 int type_not_visited(const ir_type *tp);
1196 /** Returns the associated link field of a type. */
1197 void *get_type_link(const ir_type *tp);
1198 /** Sets the associated link field of a type. */
1199 void set_type_link(ir_type *tp, void *l);
1202 * Visited flag to traverse the type information.
1204 * Increase this flag by one before traversing the type information
1205 * using inc_master_type_visited().
1206 * Mark type nodes as visited by mark_type_visited(ir_type).
1207 * Check whether node was already visited by type_visited(ir_type)
1208 * and type_not_visited(ir_type).
1209 * Or use the function to walk all types.
1213 void set_master_type_visited(ir_visited_t val);
1214 ir_visited_t get_master_type_visited(void);
1215 void inc_master_type_visited(void);
1218 * Sets the debug information of a type.
1220 * @param tp The type.
1221 * @param db The debug info.
1223 void set_type_dbg_info(ir_type *tp, type_dbg_info *db);
1226 * Returns the debug information of a type.
1228 * @param tp The type.
1230 type_dbg_info *get_type_dbg_info(const ir_type *tp);
1233 * Checks whether a pointer points to a type.
1235 * @param thing an arbitrary pointer
1238 * true if the thing is a type, else false
1240 int is_type(const void *thing);
1243 * Checks whether two types are structurally equal.
1245 * @param typ1 the first type
1246 * @param typ2 the second type
1249 * true if the types are equal, else false.
1251 * Types are equal if :
1252 * - they are the same type kind
1253 * - they have the same name
1254 * - they have the same mode (if applicable)
1255 * - they have the same type_state and, ev., the same size
1256 * - they are class types and have:
1257 * - the same members (see same_entity in entity.h)
1258 * - the same supertypes -- the C-pointers are compared --> no recursive call.
1259 * - the same number of subtypes. Subtypes are not compared,
1260 * as this could cause a cyclic test.
1261 * - they are structure types and have the same members
1262 * - they are method types and have
1263 * - the same parameter types
1264 * - the same result types
1265 * - they are union types and have the same members
1266 * - they are array types and have
1267 * - the same number of dimensions
1268 * - the same dimension bounds
1269 * - the same dimension order
1270 * - the same element type
1271 * - they are enumeration types and have the same enumerator names
1272 * - they are pointer types and have the identical points_to type
1273 * (i.e., the same C-struct to represent the type.
1274 * This is to avoid endless recursions; with pointer types cyclic
1275 * type graphs are possible.)
1277 int equal_type(ir_type *typ1, ir_type *typ2);
1280 * Checks whether two types are structural comparable.
1282 * @param st pointer type
1283 * @param lt pointer type
1286 * true if type st is smaller than type lt, i.e. whenever
1287 * lt is expected a st can be used.
1289 * - they are the same type kind
1290 * - mode(st) < mode (lt) (if applicable)
1291 * - they are class types and st is (transitive) subtype of lt,
1292 * - they are structure types and
1293 * - the members of st have exactly one counterpart in lt with the same name,
1294 * - the counterpart has a bigger type.
1295 * - they are method types and have
1296 * - the same number of parameter and result types,
1297 * - the parameter types of st are smaller than those of lt,
1298 * - the result types of st are smaller than those of lt
1299 * - they are union types and have the members of st have exactly one
1300 * @return counterpart in lt and the type is smaller
1301 * - they are array types and have
1302 * - the same number of dimensions
1303 * - all bounds of lt are bound of st
1304 * - the same dimension order
1305 * - the same element type
1307 * - the element type of st is smaller than that of lt
1308 * - the element types have the same size and fixed layout.
1309 * - they are enumeration types and have the same enumerator names
1310 * - they are pointer types and have the points_to type of st is
1311 * @return smaller than the points_to type of lt.
1314 int smaller_type(ir_type *st, ir_type *lt);
1317 * @page class_type Representation of a class type
1319 * If the type opcode is set to type_class the type represents class
1320 * types. A list of fields and methods is associated with a class.
1321 * Further a class can inherit from and bequest to other classes.
1323 * The following attributes are private to this type kind:
1324 * - member: All entities belonging to this class. This are method entities
1325 * which have type_method or fields that can have any of the
1326 * following type kinds: type_class, type_struct, type_union,
1327 * type_array, type_enumeration, type_pointer, type_primitive.
1329 * The following two are dynamic lists that can be grown with an "add_" function,
1332 * - subtypes: A list of direct subclasses.
1334 * - supertypes: A list of direct superclasses.
1336 * - type_info: An entity representing the type information of this class.
1337 * This entity can be of arbitrari type, Firm did not use it yet.
1338 * It allows to express the coupling of a type with an entity
1339 * representing this type. This information is useful for lowering
1340 * of InstOf and TypeChk nodes. Default: NULL
1342 * - vtable_size: The size of this class virtual function table.
1345 * - final: A final class is always a leaf in the class hierarchy. Final
1346 * classes cannot be super classes of other ones. As this information
1347 * can only be computed in whole world compilations, we allow to
1348 * set this flag. It is used in optimizations if get_opt_closed_world()
1349 * is false. Default: false
1351 * - interface: The class represents an interface. This flag can be set to distinguish
1352 * between interfaces, abstract classes and other classes that all may
1353 * have the peculiarity peculiarity_description. Depending on this flag
1354 * the lowering might do different actions. Default: false
1356 * - abstract : The class represents an abstract class. This flag can be set to distinguish
1357 * between interfaces, abstract classes and other classes that all may
1358 * have the peculiarity peculiarity_description. Depending on this flag
1359 * the lowering might do different actions. Default: false
1362 /** Creates a new class type. */
1363 ir_type *new_type_class(ident *name);
1365 /** Creates a new class type with debug information. */
1366 ir_type *new_d_type_class(ident *name, type_dbg_info *db);
1368 /* --- manipulate private fields of class type --- */
1370 /** return identifier of the class type */
1371 ident *get_class_ident(const ir_type *clss);
1373 /** return identifier of the class type */
1374 const char *get_class_name(const ir_type *clss);
1376 /** Adds the entity as member of the class. */
1377 void add_class_member(ir_type *clss, ir_entity *member);
1379 /** Returns the number of members of this class. */
1380 int get_class_n_members(const ir_type *clss);
1382 /** Returns the member at position pos, 0 <= pos < n_member */
1383 ir_entity *get_class_member(const ir_type *clss, int pos);
1385 /** Returns index of mem in clss, -1 if not contained. */
1386 int get_class_member_index(const ir_type *clss, ir_entity *mem);
1388 /** Finds the member with name 'name'. If several members with the same
1389 * name returns one of them. Returns NULL if no member found. */
1390 ir_entity *get_class_member_by_name(ir_type *clss, ident *name);
1392 /** Overwrites the member at position pos, 0 <= pos < n_member with
1393 * the passed entity. */
1394 void set_class_member(ir_type *clss, ir_entity *member, int pos);
1396 /** Replaces complete member list in class type by the list passed.
1398 * Copies the list passed. This function is necessary to reduce the number of members.
1399 * members is an array of entities, num the size of this array. Sets all
1400 * owners of the members passed to clss. */
1401 void set_class_members(ir_type *clss, ir_entity *members[], int arity);
1403 /** Finds member in the list of members and removes it.
1405 * Shrinks the member list, so iterate from the end!!!
1406 * Does not deallocate the entity. */
1407 void remove_class_member(ir_type *clss, ir_entity *member);
1410 /** Adds subtype as subtype to clss.
1412 * Checks whether clss is a supertype of subtype. If not
1413 * adds also clss as supertype to subtype. */
1414 void add_class_subtype(ir_type *clss, ir_type *subtype);
1416 /** Returns the number of subtypes */
1417 int get_class_n_subtypes(const ir_type *clss);
1419 /** Gets the subtype at position pos, 0 <= pos < n_subtype. */
1420 ir_type *get_class_subtype(ir_type *clss, int pos);
1422 /** Returns the index to access subclass as subtype of class.
1424 * If subclass is no direct subtype of class returns -1.
1426 int get_class_subtype_index(ir_type *clss, const ir_type *subclass);
1428 /** Sets the subtype at position pos, 0 <= pos < n_subtype.
1430 * Does not set the corresponding supertype relation for subtype: this might
1431 * be a different position! */
1432 void set_class_subtype(ir_type *clss, ir_type *subtype, int pos);
1434 /** Finds subtype in the list of subtypes and removes it */
1435 void remove_class_subtype(ir_type *clss, ir_type *subtype);
1437 /* Convenience macros */
1438 #define add_class_derived_type(clss, drvtype) add_class_subtype(clss, drvtype)
1439 #define get_class_n_derived_types(clss) get_class_n_subtypes(clss)
1440 #define get_class_derived_type(clss, pos) get_class_subtype(clss, pos)
1441 #define get_class_derived_type_index(clss, drvtype) get_class_subtype_index(clss, drvtype)
1442 #define set_class_derived_type(clss, drvtype, pos) set_class_subtype(clss, drvtype, pos)
1443 #define remove_class_derived_type(clss, drvtype) remove_class_subtype(clss, drvtype)
1445 /** Adds supertype as supertype to class.
1447 * Checks whether clss is a subtype of supertype. If not
1448 * adds also clss as subtype to supertype. */
1449 void add_class_supertype(ir_type *clss, ir_type *supertype);
1451 /** Returns the number of supertypes */
1452 int get_class_n_supertypes(const ir_type *clss);
1454 /** Returns the index to access superclass as supertype of class.
1456 * If superclass is no direct supertype of class returns -1.
1458 int get_class_supertype_index(ir_type *clss, ir_type *super_clss);
1460 /** Gets the supertype at position pos, 0 <= pos < n_supertype. */
1461 ir_type *get_class_supertype(ir_type *clss, int pos);
1463 /** Sets the supertype at position pos, 0 <= pos < n_supertype.
1465 * Does not set the corresponding subtype relation for supertype: this might
1466 * be at a different position! */
1467 void set_class_supertype(ir_type *clss, ir_type *supertype, int pos);
1469 /** Finds supertype in the list of supertypes and removes it */
1470 void remove_class_supertype(ir_type *clss, ir_type *supertype);
1472 /** Convenience macro */
1473 #define add_class_base_type(clss, basetype) add_class_supertype(clss, basetype)
1474 #define get_class_n_base_types(clss) get_class_n_supertypes(clss)
1475 #define get_class_base_type_index(clss, base_clss) get_class_supertype_index(clss, base_clss)
1476 #define get_class_base_type(clss, pos) get_class_supertype(clss, pos)
1477 #define set_class_base_type(clss, basetype, pos) set_class_supertype(clss, basetype, pos)
1478 #define remove_class_base_type(clss, basetype) remove_class_supertype(clss, basetype)
1480 /** Returns the type info entity of a class. */
1481 ir_entity *get_class_type_info(const ir_type *clss);
1483 /** Set a type info entity for the class. */
1484 void set_class_type_info(ir_type *clss, ir_entity *ent);
1486 /** Returns the size of the virtual function table. */
1487 unsigned get_class_vtable_size(const ir_type *clss);
1489 /** Sets a new size of the virtual function table. */
1490 void set_class_vtable_size(ir_type *clss, unsigned size);
1492 /** Returns non-zero if a class is final. */
1493 int is_class_final(const ir_type *clss);
1495 /** Sets the class final flag. */
1496 void set_class_final(ir_type *clss, int flag);
1498 /** Return non-zero if a class is an interface */
1499 int is_class_interface(const ir_type *clss);
1501 /** Sets the class interface flag. */
1502 void set_class_interface(ir_type *clss, int flag);
1504 /** Return non-zero if a class is an abstract class. */
1505 int is_class_abstract(const ir_type *clss);
1507 /** Sets the class abstract flag. */
1508 void set_class_abstract(ir_type *clss, int flag);
1510 /** Set and get a class' dfn --
1511 @todo This is an undocumented field, subject to change! */
1512 void set_class_dfn(ir_type *clss, int dfn);
1513 int get_class_dfn(const ir_type *clss);
1515 /** Returns true if a type is a class type. */
1516 int is_Class_type(const ir_type *clss);
1519 * @page struct_type Representation of a struct type
1521 * A struct type represents aggregate types that consist of a list
1524 * The following attributes are private to this type kind:
1525 * - member: All entities belonging to this class. This are the fields
1526 * that can have any of the following types: type_class,
1527 * type_struct, type_union, type_array, type_enumeration,
1528 * type_pointer, type_primitive.
1529 * This is a dynamic list that can be grown with an "add_" function,
1531 * This is a dynamic list that can be grown with an "add_" function,
1534 /** Creates a new type struct */
1535 ir_type *new_type_struct(ident *name);
1536 /** Creates a new type struct with debug information. */
1537 ir_type *new_d_type_struct(ident *name, type_dbg_info* db);
1539 /* --- manipulate private fields of struct --- */
1541 /** return struct identifier */
1542 ident *get_struct_ident(const ir_type *strct);
1544 /** return struct identifier as c-string*/
1545 const char *get_struct_name(const ir_type *strct);
1547 /** Adds the entity as member of the struct. */
1548 void add_struct_member(ir_type *strct, ir_entity *member);
1550 /** Returns the number of members of this struct. */
1551 int get_struct_n_members(const ir_type *strct);
1553 /** Returns the member at position pos, 0 <= pos < n_member */
1554 ir_entity *get_struct_member(const ir_type *strct, int pos);
1556 /** Returns index of member in strct, -1 if not contained. */
1557 int get_struct_member_index(const ir_type *strct, ir_entity *member);
1559 /** Overwrites the member at position pos, 0 <= pos < n_member with
1560 the passed entity. */
1561 void set_struct_member(ir_type *strct, int pos, ir_entity *member);
1563 /** Finds member in the list of members and removes it. */
1564 void remove_struct_member(ir_type *strct, ir_entity *member);
1566 /** Returns true if a type is a struct type. */
1567 int is_Struct_type(const ir_type *strct);
1570 * @page method_type Representation of a method type
1572 * A method type represents a method, function or procedure type.
1573 * It contains a list of the parameter and result types, as these
1574 * are part of the type description. These lists should not
1575 * be changed by a optimization, as a change creates a new method
1576 * type. Therefore optimizations should allocated new method types.
1577 * The set_ routines are only for construction by a frontend.
1579 * - n_params: Number of parameters to the procedure.
1580 * A procedure in FIRM has only call by value parameters.
1582 * - param_type: A list with the types of parameters. This list is ordered.
1583 * The nth type in this list corresponds to the nth element
1584 * in the parameter tuple that is a result of the start node.
1585 * (See ircons.h for more information.)
1587 * - value_param_ents
1588 * A list of entities (whose owner is a struct private to the
1589 * method type) that represent parameters passed by value.
1591 * - n_res: The number of results of the method. In general, procedures
1592 * have zero results, functions one.
1594 * - res_type: A list with the types of parameters. This list is ordered.
1595 * The nth type in this list corresponds to the nth input to
1596 * Return nodes. (See ircons.h for more information.)
1599 * A list of entities (whose owner is a struct private to the
1600 * method type) that represent results passed by value.
1603 /* These macros define the suffixes for the types and entities used
1604 to represent value parameters / results. */
1605 #define VALUE_PARAMS_SUFFIX "val_param"
1606 #define VALUE_RESS_SUFFIX "val_res"
1608 /** Create a new method type.
1610 * @param name the name (ident) of this type
1611 * @param n_param the number of parameters
1612 * @param n_res the number of results
1614 * The arrays for the parameter and result types are not initialized by
1617 ir_type *new_type_method(int n_param, int n_res);
1619 /** Create a new method type with debug information.
1621 * @param name the name (ident) of this type
1622 * @param n_param the number of parameters
1623 * @param n_res the number of results
1624 * @param db user defined debug information
1626 * The arrays for the parameter and result types are not initialized by
1629 ir_type *new_d_type_method(int n_param, int n_res, type_dbg_info *db);
1631 /* -- manipulate private fields of method. -- */
1633 /** Returns the number of parameters of this method. */
1634 int get_method_n_params(const ir_type *method);
1636 /** Returns the type of the parameter at position pos of a method. */
1637 ir_type *get_method_param_type(ir_type *method, int pos);
1638 /** Sets the type of the parameter at position pos of a method.
1639 Also changes the type in the pass-by-value representation by just
1640 changing the type of the corresponding entity if the representation is constructed. */
1641 void set_method_param_type(ir_type *method, int pos, ir_type *tp);
1642 /** Returns an entity that represents the copied value argument. Only necessary
1643 for compounds passed by value. This information is constructed only on demand. */
1644 ir_entity *get_method_value_param_ent(ir_type *method, int pos);
1646 * Sets the type that represents the copied value arguments.
1648 void set_method_value_param_type(ir_type *method, ir_type *tp);
1650 * Returns a type that represents the copied value arguments if one
1651 * was allocated, else NULL.
1653 ir_type *get_method_value_param_type(const ir_type *method);
1654 /** Returns an ident representing the parameters name. Returns NULL if not set.
1655 For debug support only. */
1656 ident *get_method_param_ident(ir_type *method, int pos);
1657 /** Returns a string representing the parameters name. Returns NULL if not set.
1658 For debug support only. */
1659 const char *get_method_param_name(ir_type *method, int pos);
1660 /** Sets an ident representing the parameters name. For debug support only. */
1661 void set_method_param_ident(ir_type *method, int pos, ident *id);
1663 /** Returns the number of results of a method type. */
1664 int get_method_n_ress(const ir_type *method);
1665 /** Returns the return type of a method type at position pos. */
1666 ir_type *get_method_res_type(ir_type *method, int pos);
1667 /** Sets the type of the result at position pos of a method.
1668 Also changes the type in the pass-by-value representation by just
1669 changing the type of the corresponding entity if the representation is constructed. */
1670 void set_method_res_type(ir_type *method, int pos, ir_type *tp);
1671 /** Returns an entity that represents the copied value result. Only necessary
1672 for compounds passed by value. This information is constructed only on demand. */
1673 ir_entity *get_method_value_res_ent(ir_type *method, int pos);
1676 * Returns a type that represents the copied value results.
1678 ir_type *get_method_value_res_type(const ir_type *method);
1681 * This enum flags the variadicity of methods (methods with a
1682 * variable amount of arguments (e.g. C's printf). Default is
1685 typedef enum ir_variadicity {
1686 variadicity_non_variadic, /**< non variadic */
1687 variadicity_variadic /**< variadic */
1690 /** Returns the null-terminated name of this variadicity. */
1691 const char *get_variadicity_name(ir_variadicity vari);
1693 /** Returns the variadicity of a method. */
1694 ir_variadicity get_method_variadicity(const ir_type *method);
1696 /** Sets the variadicity of a method. */
1697 void set_method_variadicity(ir_type *method, ir_variadicity vari);
1700 * Returns the first variadic parameter index of a type.
1701 * If this index was NOT set, the index of the last parameter
1702 * of the method type plus one is returned for variadic functions.
1703 * Non-variadic function types always return -1 here.
1705 int get_method_first_variadic_param_index(const ir_type *method);
1708 * Sets the first variadic parameter index. This allows to specify
1709 * a complete call type (containing the type of all parameters)
1710 * but still have the knowledge, which parameter must be passed as
1713 void set_method_first_variadic_param_index(ir_type *method, int index);
1715 /** Returns the mask of the additional graph properties. */
1716 unsigned get_method_additional_properties(const ir_type *method);
1718 /** Sets the mask of the additional graph properties. */
1719 void set_method_additional_properties(ir_type *method, unsigned property_mask);
1721 /** Sets one additional graph property. */
1722 void set_method_additional_property(ir_type *method, mtp_additional_property flag);
1725 * Calling conventions: lower 24 bits are the number of register parameters,
1726 * upper 8 encode the calling conventions.
1729 cc_reg_param = 0x01000000, /**< Transmit parameters in registers, else the stack is used.
1730 This flag may be set as default on some architectures. */
1731 cc_last_on_top = 0x02000000, /**< The last non-register parameter is transmitted on top of
1732 the stack. This is equivalent to the pascal
1733 calling convention. If this flag is not set, the first
1734 non-register parameter is used (stdcall or cdecl
1735 calling convention) */
1736 cc_callee_clear_stk = 0x04000000, /**< The callee clears the stack. This forbids variadic
1737 function calls (stdcall). */
1738 cc_this_call = 0x08000000, /**< The first parameter is a this pointer and is transmitted
1739 in a special way. */
1740 cc_compound_ret = 0x10000000, /**< The method returns a compound type. */
1741 cc_frame_on_caller_stk = 0x20000000, /**< The method did not allocate an own stack frame, instead the
1742 caller must reserve size on its own stack. */
1743 cc_fpreg_param = 0x40000000, /**< Transmit floating point parameters in registers, else the stack is used. */
1744 cc_bits = (0xFF << 24)/**< The calling convention bits. */
1745 } calling_convention;
1747 /* some often used cases: made as defines because firmjni cannot handle two
1748 equal enum values. */
1750 /** cdecl calling convention */
1751 #define cc_cdecl_set (0)
1752 /** stdcall calling convention */
1753 #define cc_stdcall_set cc_callee_clear_stk
1754 /** fastcall calling convention */
1755 #define cc_fastcall_set (cc_reg_param|cc_callee_clear_stk)
1757 /** Returns the default calling convention for method types. */
1758 unsigned get_default_cc_mask(void);
1761 * check for the CDECL calling convention
1763 #define IS_CDECL(cc_mask) (((cc_mask) & cc_bits) == cc_cdecl_set)
1766 * check for the STDCALL calling convention
1768 #define IS_STDCALL(cc_mask) (((cc_mask) & cc_bits) == cc_stdcall_set)
1771 * check for the FASTCALL calling convention
1773 #define IS_FASTCALL(cc_mask) (((cc_mask) & cc_bits) == cc_fastcall_set)
1776 * Sets the CDECL convention bits.
1778 #define SET_CDECL(cc_mask) (((cc_mask) & ~cc_bits) | cc_cdecl_set)
1781 * Set. the STDCALL convention bits.
1783 #define SET_STDCALL(cc_mask) (((cc_mask) & ~cc_bits) | cc_stdcall_set)
1786 * Sets the FASTCALL convention bits.
1788 #define SET_FASTCALL(cc_mask) (((cc_mask) & ~cc_bits) | cc_fastcall_set)
1790 /** Returns the calling convention of an entities graph. */
1791 unsigned get_method_calling_convention(const ir_type *method);
1793 /** Sets the calling convention of an entities graph. */
1794 void set_method_calling_convention(ir_type *method, unsigned cc_mask);
1796 /** Returns the number of registers parameters, 0 means default. */
1797 unsigned get_method_n_regparams(ir_type *method);
1799 /** Sets the number of registers parameters, 0 means default. */
1800 void set_method_n_regparams(ir_type *method, unsigned n_regs);
1802 /** Returns true if a type is a method type. */
1803 int is_Method_type(const ir_type *method);
1806 * @page union_type Representation of a union (variant) type.
1808 * The union type represents union types. Note that this representation
1809 * resembles the C union type. For tagged variant types like in Pascal or Modula
1810 * a combination of a struct and a union type must be used.
1812 * - n_types: Number of unioned types.
1813 * - members: Entities for unioned types. Fixed length array.
1814 * This is a dynamic list that can be grown with an "add_" function,
1817 /** Creates a new type union. */
1818 ir_type *new_type_union(ident *name);
1820 /** Creates a new type union with debug information. */
1821 ir_type *new_d_type_union(ident *name, type_dbg_info* db);
1823 /* --- manipulate private fields of struct --- */
1825 /** return union identifier */
1826 ident *get_union_ident(const ir_type *uni);
1828 /** return union identifier as c-string */
1829 const char *get_union_name(const ir_type *uni);
1831 /** Returns the number of unioned types of this union */
1832 int get_union_n_members(const ir_type *uni);
1834 /** Adds a new entity to a union type */
1835 void add_union_member(ir_type *uni, ir_entity *member);
1837 /** Returns the entity at position pos of a union */
1838 ir_entity *get_union_member(const ir_type *uni, int pos);
1840 /** Returns index of member in uni, -1 if not contained. */
1841 int get_union_member_index(const ir_type *uni, ir_entity *member);
1843 /** Overwrites a entity at position pos in a union type. */
1844 void set_union_member(ir_type *uni, int pos, ir_entity *member);
1846 /** Finds member in the list of members and removes it. */
1847 void remove_union_member(ir_type *uni, ir_entity *member);
1849 /** Returns true if a type is a union type. */
1850 int is_Union_type(const ir_type *uni);
1853 * @page array_type Representation of an array type
1855 * The array type represents rectangular multi dimensional arrays.
1856 * The constants representing the bounds must be allocated to
1857 * get_const_code_irg() by setting current_ir_graph accordingly.
1859 * - n_dimensions: Number of array dimensions.
1860 * - *lower_bound: Lower bounds of dimensions. Usually all 0.
1861 * - *upper_bound: Upper bounds or dimensions.
1862 * - *element_type: The type of the array elements.
1863 * - *element_ent: An entity for the array elements to be used for
1864 * element selection with Sel.
1866 * Do we need several entities? One might want
1867 * to select a dimension and not a single element in case of multi
1868 * dimensional arrays.
1871 /** Create a new type array.
1873 * Sets n_dimension to dimension and all dimension entries to NULL.
1874 * Initializes order to the order of the dimensions.
1875 * The entity for array elements is built automatically.
1876 * Set dimension sizes after call to constructor with set_* routines.
1878 ir_type *new_type_array(int n_dims, ir_type *element_type);
1880 /** Create a new type array with debug information.
1882 * Sets n_dimension to dimension and all dimension entries to NULL.
1883 * Initializes order to the order of the dimensions.
1884 * The entity for array elements is built automatically.
1885 * Set dimension sizes after call to constructor with set_* routines.
1886 * A legal array type must have at least one dimension set.
1888 ir_type *new_d_type_array(int n_dims, ir_type *element_type, type_dbg_info* db);
1890 /* --- manipulate private fields of array type --- */
1892 /** Returns the number of array dimensions of this type. */
1893 int get_array_n_dimensions(const ir_type *array);
1896 * Allocates Const nodes of mode_Is for one array dimension.
1897 * Upper bound in Firm is the element next to the last, i.e. [lower,upper[
1899 void set_array_bounds_int(ir_type *array, int dimension, int lower_bound,
1902 * Sets the bounds for one array dimension.
1903 * Upper bound in Firm is the element next to the last, i.e. [lower,upper[
1905 void set_array_bounds(ir_type *array, int dimension, ir_node *lower_bound,
1906 ir_node *upper_bound);
1907 /** Sets the lower bound for one array dimension, i.e. [lower,upper[ */
1908 void set_array_lower_bound(ir_type *array, int dimension, ir_node *lower_bound);
1910 /** Allocates Const nodes of mode_Is for the lower bound of an array
1911 dimension, i.e. [lower,upper[ */
1912 void set_array_lower_bound_int(ir_type *array, int dimension, int lower_bound);
1914 /** Sets the upper bound for one array dimension, i.e. [lower,upper[ */
1915 void set_array_upper_bound(ir_type *array, int dimension, ir_node *upper_bound);
1917 /** Allocates Const nodes of mode_Is for the upper bound of an array
1918 dimension, i.e. [lower,upper[. */
1919 void set_array_upper_bound_int(ir_type *array, int dimension, int upper_bound);
1921 /** Returns true if lower bound != Unknown. */
1922 int has_array_lower_bound(const ir_type *array, int dimension);
1923 /** Returns the lower bound of an array. */
1924 ir_node *get_array_lower_bound(const ir_type *array, int dimension);
1925 /** Works only if bound is Const node with tarval that can be converted to long. */
1926 long get_array_lower_bound_int(const ir_type *array, int dimension);
1927 /** returns true if lower bound != Unknown */
1928 int has_array_upper_bound(const ir_type *array, int dimension);
1929 /** Returns the upper bound of an array. */
1930 ir_node *get_array_upper_bound(const ir_type *array, int dimension);
1931 /** Works only if bound is Const node with tarval that can be converted to long. */
1932 long get_array_upper_bound_int(const ir_type *array, int dimension);
1934 /** Sets an array dimension to a specific order. */
1935 void set_array_order(ir_type *array, int dimension, int order);
1937 /** Returns the order of an array dimension. */
1938 int get_array_order(const ir_type *array, int dimension);
1940 /** Find the array dimension that is placed at order order. */
1941 int find_array_dimension(const ir_type *array, int order);
1943 /** Sets the array element type. */
1944 void set_array_element_type(ir_type *array, ir_type* tp);
1946 /** Gets the array element type. */
1947 ir_type *get_array_element_type(const ir_type *array);
1949 /** Sets the array element entity. */
1950 void set_array_element_entity(ir_type *array, ir_entity *ent);
1952 /** Get the array element entity. */
1953 ir_entity *get_array_element_entity(const ir_type *array);
1955 /** Returns true if a type is an array type. */
1956 int is_Array_type(const ir_type *array);
1959 * @page enumeration_type Representation of an enumeration type
1961 * Enumeration types need not necessarily be represented explicitly
1962 * by Firm types, as the frontend can lower them to integer constants as
1963 * well. For debugging purposes or similar tasks this information is useful.
1964 * The type state layout_fixed is set, if all enumeration constant have
1965 * there tarvals assigned. Until then
1967 * - *const: The target values representing the constants used to
1968 * represent individual enumerations.
1971 /** Create a new type enumeration -- set the enumerators independently. */
1972 ir_type *new_type_enumeration(ident *name, int n_enums);
1974 /** Create a new type enumeration with debug information -- set the enumerators independently. */
1975 ir_type *new_d_type_enumeration(ident *name, int n_enums, type_dbg_info *db);
1977 /* --- manipulate fields of enumeration type. --- */
1979 /** return enumeration identifier */
1980 ident *get_enumeration_ident(const ir_type *enumeration);
1982 /** return enumeration identifier as c-string */
1983 const char *get_enumeration_name(const ir_type *enumeration);
1985 /** Set an enumeration constant to a enumeration type at a given position. */
1986 void set_enumeration_const(ir_type *enumeration, int pos, ident *nameid, tarval *con);
1988 /** Returns the number of enumeration values of this enumeration */
1989 int get_enumeration_n_enums(const ir_type *enumeration);
1991 /** Returns the enumeration constant at a given position. */
1992 ir_enum_const *get_enumeration_const(const ir_type *enumeration, int pos);
1994 /** Returns the enumeration type owner of an enumeration constant. */
1995 ir_type *get_enumeration_owner(const ir_enum_const *enum_cnst);
1997 /** Sets the enumeration constant value. */
1998 void set_enumeration_value(ir_enum_const *enum_cnst, tarval *con);
2000 /** Returns the enumeration constant value. */
2001 tarval *get_enumeration_value(const ir_enum_const *enum_cnst);
2003 /** Assign an ident to an enumeration constant. */
2004 void set_enumeration_nameid(ir_enum_const *enum_cnst, ident *id);
2006 /** Returns the assigned ident of an enumeration constant. */
2007 ident *get_enumeration_const_nameid(const ir_enum_const *enum_cnst);
2009 /** Returns the assigned name of an enumeration constant. */
2010 const char *get_enumeration_const_name(const ir_enum_const *enum_cnst);
2012 /** Returns true if a type is a enumeration type. */
2013 int is_Enumeration_type(const ir_type *enumeration);
2016 * @page pointer_type Representation of a pointer type
2019 * - points_to: The type of the entity this pointer points to.
2022 /** Creates a new type pointer. */
2023 ir_type *new_type_pointer(ir_type *points_to);
2025 /** Creates a new type pointer with debug information. */
2026 ir_type *new_d_type_pointer(ir_type *points_to, type_dbg_info* db);
2028 /* --- manipulate fields of type_pointer --- */
2030 /** Sets the type to which a pointer points to. */
2031 void set_pointer_points_to_type(ir_type *pointer, ir_type *tp);
2033 /** Returns the type to which a pointer points to. */
2034 ir_type *get_pointer_points_to_type(const ir_type *pointer);
2036 /** Returns true if a type is a pointer type. */
2037 int is_Pointer_type(const ir_type *pointer);
2039 /** Returns the first pointer type that has as points_to tp.
2040 * Not efficient: O(\#types).
2041 * If not found returns firm_unknown_type. */
2042 ir_type *find_pointer_type_to_type(ir_type *tp);
2045 * @page primitive_type Representation of a primitive type
2047 * Primitive types are types that represent atomic data values that
2048 * map directly to modes. They don't have private attributes. The
2049 * important information they carry is held in the common mode field.
2051 /** Creates a new primitive type. */
2052 ir_type *new_type_primitive(ir_mode *mode);
2054 /** Creates a new primitive type with debug information. */
2055 ir_type *new_d_type_primitive(ir_mode *mode, type_dbg_info* db);
2057 /** Returns true if a type is a primitive type. */
2058 int is_Primitive_type(const ir_type *primitive);
2060 /** Return the base type of a primitive (bitfield) type or NULL if none. */
2061 ir_type *get_primitive_base_type(const ir_type *tp);
2063 /** Sets the base type of a primitive (bitfield) type. */
2064 void set_primitive_base_type(ir_type *tp, ir_type *base_tp);
2067 * @page none_type The None type
2069 * This type is an auxiliary type dedicated to support type analyses.
2071 * The none type represents that there is no type. The type can be used to
2072 * initialize fields of type* that actually can not contain a type or that
2073 * are initialized for an analysis. There exists exactly one type none.
2074 * This type is not on the type list in ir_prog. It is
2075 * allocated when initializing the type module.
2077 * The following values are set:
2079 * - name: "type_none"
2080 * - state: layout_fixed
2083 /** A variable that contains the only none type. */
2084 extern ir_type *firm_none_type;
2086 /** A variable that contains the only code type. */
2087 extern ir_type *firm_code_type;
2089 /** Returns the none type. */
2090 ir_type *get_none_type(void);
2091 /** Returns the code type. */
2092 ir_type *get_code_type(void);
2095 * @page unknown_type The Unknown type
2097 * This type is an auxiliary type dedicated to support type analyses.
2099 * The unknown type represents that there could be a type, but it is not
2100 * known. This type can be used to initialize fields before an analysis (not known
2101 * yet) or to represent the top of a lattice (could not be determined). There exists
2102 * exactly one type unknown. This type is not on the type list in ir_prog. It is
2103 * allocated when initializing the type module.
2105 * The following values are set:
2107 * - name: "type_unknown"
2108 * - state: layout_fixed
2111 /** A variable that contains the only unknown type. */
2112 extern ir_type *firm_unknown_type;
2114 /** Returns the unknown type. */
2115 ir_type *get_unknown_type(void);
2119 * Checks whether a type is atomic.
2120 * @param tp any type
2121 * @return true if type is primitive, pointer or enumeration
2123 int is_atomic_type(const ir_type *tp);
2125 /* --- Support for compound types --- */
2128 * Gets the identifier of a compound type
2130 ident *get_compound_ident(const ir_type *tp);
2132 /** return compound identifier as c-string */
2133 const char *get_compound_name(const ir_type *tp);
2136 * Gets the number of elements in a Firm compound type.
2138 * This is just a comfortability function, because structs and
2139 * classes can often be treated be the same code, but they have
2140 * different access functions to their members.
2142 * @param tp The type (must be struct, union or class).
2144 * @return Number of members in the compound type.
2146 int get_compound_n_members(const ir_type *tp);
2149 * Gets the member of a Firm compound type at position pos.
2151 * @param tp The type (must be struct, union or class).
2152 * @param pos The number of the member.
2154 * @return The member entity at position pos.
2156 ir_entity *get_compound_member(const ir_type *tp, int pos);
2158 /** Returns index of member in tp, -1 if not contained. */
2159 int get_compound_member_index(const ir_type *tp, ir_entity *member);
2162 * layout members of a struct/union or class type in a default way.
2164 void default_layout_compound_type(ir_type *tp);
2167 * Checks whether a type is a compound type.
2169 * @param tp - any type
2171 * @return true if the type is class, structure, union or array type.
2173 int is_compound_type(const ir_type *tp);
2176 * Checks wether a type is a code type.
2178 int is_code_type(const ir_type *tp);
2181 * Checks, whether a type is a frame type.
2183 int is_frame_type(const ir_type *tp);
2186 * Checks, whether a type is a value parameter type.
2188 int is_value_param_type(const ir_type *tp);
2191 * Checks, whether a type is a lowered type.
2193 int is_lowered_type(const ir_type *tp);
2196 * Makes a new value type. Value types are struct types,
2197 * so all struct access functions work.
2198 * Value types are not in the global list of types.
2200 ir_type *new_type_value(void);
2203 * Makes a new frame type. Frame types are class types,
2204 * so all class access functions work.
2205 * Frame types are not in the global list of types.
2207 ir_type *new_type_frame(void);
2210 * Makes a clone of a frame type.
2211 * Sets entity links from old frame entities to new onces and
2214 ir_type *clone_frame_type(ir_type *type);
2217 * Sets a lowered type for a type. This sets both associations
2218 * and marks lowered_type as a "lowered" one.
2220 void set_lowered_type(ir_type *tp, ir_type *lowered_type);
2223 * Gets the lowered/unlowered type of a type or NULL if this type
2224 * has no lowered/unlowered one.
2226 ir_type *get_associated_type(const ir_type *tp);
2229 * Allocate an area of size bytes aligned at alignment
2230 * at the start or the end of a frame type.
2231 * The frame type must already have a fixed layout.
2233 * @param frame_type a frame type
2234 * @param size the size of the entity
2235 * @param alignment the alignment of the entity
2236 * @param at_start if true, put the area at the frame type's start, else at end
2238 * @return the entity representing the area
2240 ir_entity *frame_alloc_area(ir_type *frame_type, int size, unsigned alignment, int at_start);
2242 /*-----------------------------------------------------------------*/
2244 /*-----------------------------------------------------------------*/
2247 * Outputs a unique number for this type if libfirm is compiled for
2248 * debugging, (configure with --enable-debug) else returns the address
2249 * of the type cast to long.
2251 long get_type_nr(const ir_type *tp);
2253 /* ------------------------------------------------------------------------ */
2255 /** Type for a function that compares two types.
2257 * @param tp1 The first type to compare.
2258 * @param tp2 The second type to compare.
2260 typedef int (compare_types_func_t)(const void *tp1, const void *tp2);
2262 /** Compares two types by their name.
2264 * Compares the opcode and the name of the types. If these are
2265 * equal returns 0, else non-zero.
2267 int compare_names(const void *tp1, const void *tp2);
2269 /** Compares two types strict.
2271 * returns 0 if tp1 == tp2, else non-zero
2273 int compare_strict(const void *tp1, const void *tp2);
2275 /* ------------------------------------------------------------------------ */
2277 /** Computes a hash value by the type name.
2279 * Uses the name of the type and the type opcode to compute the hash.
2281 int firm_hash_name(ir_type *tp);
2283 /* ------------------------------------------------------------------------ */
2285 /** Finalize type construction.
2287 * Indicate that a type is so far completed that it can be
2288 * distinguished from other types. Mature_type hashes the type into a
2289 * table. It uses the function in compare_types_func to compare the
2292 * If it finds a type identical to tp it returns this type. It turns
2293 * tp into the Id type. All places formerly pointing to tp will now
2294 * point to the found type. All entities of tp now refer to the found
2295 * type as their owner, but they are not a member of this type. This
2296 * is invalid firm -- the entities must be replaced by entities of the
2297 * found type. The Id type will be removed from the representation
2298 * automatically, but within an unknown time span. It occupies memory
2301 * @param tp The type to mature.
2303 ir_type *mature_type(ir_type *tp);
2305 /** Finalize type construction.
2307 * Indicate that a type is so far completed that it can be
2308 * distinguished from other types. mature_type() hashes the type into a
2309 * table. It uses the function in compare_types_func to compare the
2312 * If it finds a type identical to tp it returns this type. It frees
2313 * type tp and all its entities.
2315 * @param tp The type to mature.
2317 ir_type *mature_type_free(ir_type *tp);
2319 /** Finalize type construction.
2321 * Indicate that a type is so far completed that it can be
2322 * distinguished from other types. Mature_type hashes the type into a
2323 * table. It uses the function in compare_types_func to compare the
2326 * If it find a type identical to tp it returns this type. It frees
2327 * the entities and turns the type into an Id type. All places
2328 * formerly pointing to tp will now point to the found type. The Id
2329 * type will be removed from the representation automatically, but
2330 * within an unknown time span. It occupies memory for this time.
2332 * @param tp The type to mature.
2334 ir_type *mature_type_free_entities(ir_type *tp);
2336 /** A data type to treat types and entities as the same. */
2338 ir_type *typ; /**< points to a type */
2339 ir_entity *ent; /**< points to an entity */
2342 /** Type of argument functions for type walkers.
2344 * @param tore points to the visited type or entity
2345 * @param env free environment pointer
2347 typedef void type_walk_func(type_or_ent tore, void *env);
2349 /** The class walk function
2351 * @param clss points to the visited class
2352 * @param env free environment pointer
2354 typedef void class_walk_func(ir_type *clss, void *env);
2356 /** Touches every type and entity in unspecified order. If new
2357 * types/entities are created during the traversal these will
2359 * Does not touch frame types or types for value params ... */
2360 void type_walk(type_walk_func *pre, type_walk_func *post, void *env);
2362 /** Touches every type, entity, frame type, and value param type in
2363 * unspecified order (also all segment types). */
2364 void type_walk_prog(type_walk_func *pre, type_walk_func *post, void *env);
2366 /** Walks over all type information reachable from an ir graph.
2368 * Walks over all type information reachable from irg, i.e., starts a
2369 * type walk at the irgs entity, the irgs frame type and all types and
2370 * entities that are attributes to firm nodes. */
2371 void type_walk_irg(ir_graph *irg, type_walk_func *pre, type_walk_func *post,
2375 Touches every class in specified order:
2376 - first the super class
2377 - second the class itself
2378 - third the sub classes. If new classes are created
2379 during the traversal these will be visited, too.
2381 @todo should be named class-walk
2383 @deprecated will be removed?
2385 void type_walk_super2sub(type_walk_func *pre, type_walk_func *post, void *env);
2387 /** Walker for class types in inheritance order.
2389 * Touches every class in specified order:
2390 * - first the super class
2391 * - second the class itself
2392 * If new classes are created during the traversal these
2393 * will be visited, too.
2394 * Starts the walk at arbitrary classes.
2395 * Executes pre when first visiting a class. Executes post after
2396 * visiting all superclasses.
2398 * The arguments pre, post, env may be NULL. */
2399 void type_walk_super(type_walk_func *pre, type_walk_func *post, void *env);
2401 /** Same as type_walk_super2sub, but visits only class types.
2402 Executes pre for a class if all superclasses have been visited.
2403 Then iterates to subclasses. Executes post after return from
2405 Does not visit global type, frame types.
2407 void class_walk_super2sub(class_walk_func *pre, class_walk_func *post,
2411 * the entity walk function. A function type for entity walkers.
2413 * @param ent points to the visited entity
2414 * @param env free environment pointer
2416 typedef void entity_walk_func(ir_entity *ent, void *env);
2419 * Walks over all entities in the type.
2421 * @param tp the type
2422 * @param doit the entity walker function
2423 * @param env environment, will be passed to the walker function
2425 void walk_types_entities(ir_type *tp, entity_walk_func *doit, void *env);
2428 * If we have the closed world assumption, we can calculate the
2429 * finalization of classes and entities by inspecting the class hierarchy.
2430 * After this is done, all classes and entities that are not overridden
2431 * anymore have the final property set.
2433 void types_calc_finalization(void);
2436 ir_visibility get_type_visibility(const ir_type *tp);
2438 void set_type_visibility(ir_type *tp, ir_visibility v);
2442 allocation_automatic,
2443 allocation_parameter,
2448 ir_allocation get_entity_allocation(const ir_entity *ent);
2450 void set_entity_allocation(ir_entity *ent, ir_allocation al);
2454 peculiarity_existent,
2455 peculiarity_description,
2456 peculiarity_inherited
2459 ir_peculiarity get_entity_peculiarity(const ir_entity *ent);
2461 void set_entity_peculiarity(ir_entity *ent, ir_peculiarity pec);
2464 int is_entity_final(const ir_entity *ent);
2466 void set_entity_final(ir_entity *ent, int final);
2469 ir_peculiarity get_class_peculiarity(const ir_type *clss);
2471 void set_class_peculiarity(ir_type *clss, ir_peculiarity pec);