2 * Copyright (C) 1995-2011 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
28 #include "firm_types.h"
33 * @page entity Entity representation
35 * An entity is the representation of program known objects in Firm.
36 * The primary concept of entities is to represent members of complex
37 * types, i.e., fields and methods of classes. As not all programming
38 * language model all variables and methods as members of some class,
39 * the concept of entities is extended to cover also local and global
40 * variables, and arbitrary procedures.
42 * An entity always specifies the type of the object it represents and
43 * the type of the object it is a part of, the owner of the entity.
44 * Originally this is the type of the class of which the entity is a
46 * The owner of local variables is the procedure they are defined in.
47 * The owner of global variables and procedures visible in the whole
48 * program is a universally defined class type "GlobalType". The owner
49 * of procedures defined in the scope of an other procedure is the
50 * enclosing procedure.
52 * The type ir_entity is an abstract data type to represent program entities.
53 * If contains the following attributes:
55 * - owner: A compound type this entity is a part of.
56 * - type: The type of this entity.
57 * - name: The string that represents this entity in the source program
58 * - linkage: A flag indicating how the linker treats a symbol
59 * - offset: The offset of the entity within the compound object in bytes. Only set
60 * if the owner in the state "layout_fixed".
61 * - offset_bits_remainder: The offset bit remainder of a bitfield entity (in a compound)
62 * in bits. Only set if the owner in the state "layout_fixed".
63 * - overwrites: A list of entities overwritten by this entity. This list is only
64 * existent if the owner of this entity is a class. The members in
65 * this list must be entities of super classes.
66 * - overwrittenby: A list of entities that overwrite this entity. This list is only
67 * existent if the owner of this entity is a class. The members in
68 * this list must be entities of sub classes.
69 * - link: A void* to associate some additional information with the entity.
70 * - irg: If the entity is a method this is the ir graph that represents the
72 * - visited: visited flag. Master flag is type_visited.
74 * These fields can only be accessed via access functions.
76 * @see ir_type, ir_entity
80 * Visibility classed for entities.
84 * The entity is visible outside the compilation unit, but it is defined
87 ir_visibility_default,
89 * The entity is local to the compilation unit.
90 * A local entity is not visible in other compilation units.
91 * Note that the entity might still be accessed indirectly from other units
96 * The entity is defined outside the compilation unit but potentially used
99 ir_visibility_external,
101 * This has the same semantic as visibility_local. Additionally the symbol is
102 * completely hidden from the linker (it only appears in the assembly).
103 * While visibility_local is probably still visible to debuggers,
104 * visibility_private symbols aren't and probably won't appear in the object
107 ir_visibility_private
111 * linkage specifies how the linker treats symbols
113 typedef enum ir_linkage {
114 IR_LINKAGE_DEFAULT = 0,
116 * A symbol whose definition won't change in a program.
117 * Optimisation might replace loads from this entity with constants.
118 * Also most linkers put such data in a constant segment which is shared
119 * between multiple running instances of the same application.
121 IR_LINKAGE_CONSTANT = 1 << 0,
123 * The entity is a weak symbol.
124 * A weak symbol is overridden by a non-weak symbol if one exists.
125 * Most linkers only support the IR_LINKAGE_WEAK in combination with
128 IR_LINKAGE_WEAK = 1 << 1,
130 * The entity may be removed when it isn't referenced anywhere in the
131 * compilation unit even if it is exported (non-local).
132 * Typically used for C++ instantiated template code (,,COMDAT'' section).
134 IR_LINKAGE_GARBAGE_COLLECT = 1 << 2,
136 * The linker will try to merge entities with same name from different
137 * compilation units. This is the usual behaviour for global variables
138 * without explicit initialisation in C (``COMMON'' symbols). It's also
139 * typically used in C++ for instantiated template code (,,COMDAT'' section)
141 IR_LINKAGE_MERGE = 1 << 3,
143 * Some entity uses are potentially hidden from the compiler.
144 * (For example because they happen in an asm("") statement. This flag
145 * should be set for __attribute__((used)) in C code).
146 * Setting this flag prohibits that the compiler making assumptions about
147 * read/write behaviour to global variables or changing calling conventions
148 * from cdecl to fastcall.
150 IR_LINKAGE_HIDDEN_USER = 1 << 4
152 ENUM_BITSET(ir_linkage)
155 * Return the visibility class of an entity
157 FIRM_API ir_visibility get_entity_visibility(const ir_entity *entity);
160 * Set visibility class of an entity
162 FIRM_API void set_entity_visibility(ir_entity *entity, ir_visibility visibility);
165 * Return 1 if the entity is visible outside the current compilation unit
166 * or to unknown callers (like asm statements).
167 * (The entity might still be accessible indirectly through pointers)
168 * This is a convenience function and does the same as
169 * get_entity_visibility(entity) != ir_visibility_local ||
170 * (get_entity_linkage(entity) & IR_LINKAGE_HIDDEN_USER)
172 FIRM_API int entity_is_externally_visible(const ir_entity *entity);
175 * Return 1 if the entity has a definition (initializer) in the current
178 FIRM_API int entity_has_definition(const ir_entity *entity);
181 * Creates a new entity.
183 * Automatically inserts the entity as a member of owner.
184 * Entity is automatic_allocated and uninitialized except if the type
185 * is type_method, then it is static_allocated and constant. The constant
186 * value is a pointer to the method.
187 * Visibility is local, offset -1, and it is not volatile.
189 FIRM_API ir_entity *new_entity(ir_type *owner, ident *name, ir_type *tp);
192 * Creates a new entity.
194 * Automatically inserts the entity as a member of owner.
195 * The entity is automatic allocated and uninitialized except if the type
196 * is type_method, then it is static allocated and constant. The constant
197 * value is a pointer to the method.
198 * Visibility is local, offset -1, and it is not volatile.
200 FIRM_API ir_entity *new_d_entity(ir_type *owner, ident *name, ir_type *tp,
204 * Copies the entity if the new_owner is different from the
205 * owner of the old entity, else returns the old entity.
207 * Automatically inserts the new entity as a member of owner.
208 * Resets the overwrites/overwritten_by fields.
209 * Keeps the old atomic value.
211 FIRM_API ir_entity *copy_entity_own(ir_entity *old, ir_type *new_owner);
214 * Copies the entity if the new_name is different from the
215 * name of the old entity, else returns the old entity.
217 * Automatically inserts the new entity as a member of owner.
218 * The mangled name ld_name is set to NULL.
219 * Overwrites relation is copied from old.
221 FIRM_API ir_entity *copy_entity_name(ir_entity *old, ident *new_name);
226 * The owner will still contain the pointer to this
227 * entity, as well as all other references!
229 FIRM_API void free_entity(ir_entity *ent);
231 /** Returns the name of an entity. */
232 FIRM_API const char *get_entity_name(const ir_entity *ent);
234 /** Returns the ident of an entity. */
235 FIRM_API ident *get_entity_ident(const ir_entity *ent);
237 /** Sets the ident of the entity. */
238 FIRM_API void set_entity_ident(ir_entity *ent, ident *id);
240 /** Returns the mangled name of the entity.
242 * If the mangled name is set it returns the existing name.
243 * Else it generates a name with mangle_entity()
244 * and remembers this new name internally.
246 FIRM_API ident *get_entity_ld_ident(const ir_entity *ent);
248 /** Sets the mangled name of the entity. */
249 FIRM_API void set_entity_ld_ident(ir_entity *ent, ident *ld_ident);
251 /** Returns the mangled name of the entity as a string. */
252 FIRM_API const char *get_entity_ld_name(const ir_entity *ent);
254 /** returns 1 if the entity has an ld_ident set explicitely */
255 FIRM_API int entity_has_ld_ident(const ir_entity *entity);
257 /** Returns the owner of the entity. */
258 FIRM_API ir_type *get_entity_owner(const ir_entity *ent);
261 * Sets the owner field in entity to owner.
262 * Automatically removes entity from old owner type and adds it to the new
265 FIRM_API void set_entity_owner(ir_entity *ent, ir_type *owner);
267 /** Returns the type of an entity. */
268 FIRM_API ir_type *get_entity_type(const ir_entity *ent);
270 /** Sets the type of an entity. */
271 FIRM_API void set_entity_type(ir_entity *ent, ir_type *tp);
273 /** Returns the linkage of an entity. */
274 FIRM_API ir_linkage get_entity_linkage(const ir_entity *entity);
276 /** Sets the linkage of an entity. */
277 FIRM_API void set_entity_linkage(ir_entity *entity, ir_linkage linkage);
278 FIRM_API void add_entity_linkage(ir_entity *entity, ir_linkage linkage);
279 FIRM_API void remove_entity_linkage(ir_entity *entity, ir_linkage linkage);
282 * Returns the volatility of an entity.
285 FIRM_API ir_volatility get_entity_volatility(const ir_entity *ent);
288 * Sets the volatility of an entity.
291 FIRM_API void set_entity_volatility(ir_entity *ent, ir_volatility vol);
293 /** Return the name of the volatility. */
294 FIRM_API const char *get_volatility_name(ir_volatility var);
296 /** Returns alignment of entity in bytes */
297 FIRM_API unsigned get_entity_alignment(const ir_entity *entity);
299 /** Allows you to override the type alignment for an entity.
300 * @param entity the entity
301 * @param alignment alignment in bytes
303 FIRM_API void set_entity_alignment(ir_entity *entity, unsigned alignment);
307 * Returns indication whether entity is aligned in memory.
310 FIRM_API ir_align get_entity_aligned(const ir_entity *ent);
313 * Sets indication whether entity is aligned in memory
316 FIRM_API void set_entity_aligned(ir_entity *ent, ir_align a);
318 /** Return the name of the alignment. */
319 FIRM_API const char *get_align_name(ir_align a);
321 /** Returns the offset of an entity (in a compound) in bytes. Only set if layout = fixed. */
322 FIRM_API int get_entity_offset(const ir_entity *ent);
324 /** Sets the offset of an entity (in a compound) in bytes. */
325 FIRM_API void set_entity_offset(ir_entity *ent, int offset);
327 /** Returns the offset bit remainder of a bitfield entity (in a compound) in bits. Only set if layout = fixed. */
328 FIRM_API unsigned char get_entity_offset_bits_remainder(const ir_entity *ent);
330 /** Sets the offset bit remainder of a bitfield entity (in a compound) in bits. */
331 FIRM_API void set_entity_offset_bits_remainder(ir_entity *ent,
332 unsigned char offset);
334 /** Returns the stored intermediate information. */
335 FIRM_API void *get_entity_link(const ir_entity *ent);
337 /** Stores new intermediate information. */
338 FIRM_API void set_entity_link(ir_entity *ent, void *l);
340 /* -- Fields of method entities -- */
341 /** The entity knows the corresponding irg if the entity is a method.
342 This allows to get from a Call to the called irg. */
343 FIRM_API ir_graph *get_entity_irg(const ir_entity *ent);
344 FIRM_API void set_entity_irg(ir_entity *ent, ir_graph *irg);
346 /** A reserved value for "not yet set". */
347 #define IR_VTABLE_NUM_NOT_SET ((unsigned)(-1))
349 /** Gets the entity vtable number. */
350 FIRM_API unsigned get_entity_vtable_number(const ir_entity *ent);
352 /** Sets the entity vtable number. */
353 FIRM_API void set_entity_vtable_number(ir_entity *ent, unsigned vtable_number);
355 /** Set label number of an entity with code type */
356 FIRM_API void set_entity_label(ir_entity *ent, ir_label_t label);
357 /** Return label number of an entity with code type */
358 FIRM_API ir_label_t get_entity_label(const ir_entity *ent);
360 /** Checks if an entity is compiler generated. */
361 FIRM_API int is_entity_compiler_generated(const ir_entity *ent);
363 /** Sets/resets the compiler generated flag. */
364 FIRM_API void set_entity_compiler_generated(ir_entity *ent, int flag);
367 * Bitfield type indicating the way an entity is used.
370 ir_usage_none = 0, /**< This entity is unused. */
371 ir_usage_address_taken = 1 << 0, /**< The address of this entity was taken. */
372 ir_usage_write = 1 << 1, /**< The entity was written to. */
373 ir_usage_read = 1 << 2, /**< The entity was read. */
374 ir_usage_reinterpret_cast = 1 << 3, /**< The entity was read but with a wrong mode
375 (an implicit reinterpret cast) */
376 /** Unknown access */
378 = ir_usage_address_taken | ir_usage_write | ir_usage_read
379 | ir_usage_reinterpret_cast
382 /** Return the entity usage */
383 FIRM_API ir_entity_usage get_entity_usage(const ir_entity *ent);
385 /** Sets/resets the state of the address taken flag of an entity. */
386 FIRM_API void set_entity_usage(ir_entity *ent, ir_entity_usage flag);
389 * Returns the debug information of an entity.
391 * @param ent The entity.
393 FIRM_API dbg_info *get_entity_dbg_info(const ir_entity *ent);
396 * Sets the debug information of an entity.
398 * @param ent The entity.
399 * @param db The debug info.
401 FIRM_API void set_entity_dbg_info(ir_entity *ent, dbg_info *db);
403 /* -- Representation of constant values of entities -- */
405 * Returns true if the the node is representable as code on
408 * @deprecated This function is not used by libFirm and stays here
409 * only as a helper for the old Jack frontend.
411 FIRM_API int is_irn_const_expression(ir_node *n);
414 * Copies a Firm subgraph that complies to the restrictions for
415 * constant expressions to block.
417 * @param dbg debug info for all newly created nodes
419 * @param to_block block to copy to
421 FIRM_API ir_node *copy_const_value(dbg_info *dbg, ir_node *n, ir_node *to_block);
423 /* Set has no effect for existent entities of type method. */
424 FIRM_API ir_node *get_atomic_ent_value(ir_entity *ent);
425 FIRM_API void set_atomic_ent_value(ir_entity *ent, ir_node *val);
427 /** the kind (type) of an initializer */
428 typedef enum ir_initializer_kind_t {
429 /** initializer containing an ir_node from the const-code irg */
430 IR_INITIALIZER_CONST,
431 /** initializer containing a tarval */
432 IR_INITIALIZER_TARVAL,
433 /** initializes type with default values (usually 0) */
435 /** list of initializers used to initializer a compound or array type */
436 IR_INITIALIZER_COMPOUND
437 } ir_initializer_kind_t;
439 /** returns kind of an initializer */
440 FIRM_API ir_initializer_kind_t get_initializer_kind(const ir_initializer_t *initializer);
442 /** Return the name of the initializer kind. */
443 FIRM_API const char *get_initializer_kind_name(ir_initializer_kind_t ini);
446 * returns the null initializer (there's only one instance of it in a program )
448 FIRM_API ir_initializer_t *get_initializer_null(void);
451 * creates an initializer containing a reference to a node on the const-code
454 FIRM_API ir_initializer_t *create_initializer_const(ir_node *value);
456 /** creates an initializer containing a single tarval value */
457 FIRM_API ir_initializer_t *create_initializer_tarval(ir_tarval *tv);
459 /** return value contained in a const initializer */
460 FIRM_API ir_node *get_initializer_const_value(const ir_initializer_t *initializer);
462 /** return value contained in a tarval initializer */
463 FIRM_API ir_tarval *get_initializer_tarval_value(const ir_initializer_t *initialzier);
465 /** creates a compound initializer which holds @p n_entries entries */
466 FIRM_API ir_initializer_t *create_initializer_compound(size_t n_entries);
468 /** returns the number of entries in a compound initializer */
469 FIRM_API size_t get_initializer_compound_n_entries(const ir_initializer_t *initializer);
471 /** sets entry with index @p index to the initializer @p value */
472 FIRM_API void set_initializer_compound_value(ir_initializer_t *initializer,
474 ir_initializer_t *value);
476 /** returns the value with index @p index of a compound initializer */
477 FIRM_API ir_initializer_t *get_initializer_compound_value(
478 const ir_initializer_t *initializer, size_t index);
480 /** Sets the new style initializers of an entity. */
481 FIRM_API void set_entity_initializer(ir_entity *entity, ir_initializer_t *initializer);
483 /** Returns true, if an entity has new style initializers. */
484 FIRM_API int has_entity_initializer(const ir_entity *entity);
486 /** Return the new style initializers of an entity. */
487 FIRM_API ir_initializer_t *get_entity_initializer(const ir_entity *entity);
489 /* --- Fields of entities with a class type as owner --- */
490 /* Overwrites is a field that specifies that an access to the overwritten
491 entity in the supertype must use this entity. It's a list as with
492 multiple inheritance several entities can be overwritten. This field
493 is mostly useful for method entities.
494 If a Sel node selects an entity that is overwritten by other entities it
495 must return a pointer to the entity of the dynamic type of the pointer
496 that is passed to it. Lowering of the Sel node must assure this.
497 Overwrittenby is the inverse of overwrites. Both add routines add
498 both relations, they only differ in the order of arguments. */
499 FIRM_API void add_entity_overwrites(ir_entity *ent, ir_entity *overwritten);
500 FIRM_API size_t get_entity_n_overwrites(const ir_entity *ent);
501 FIRM_API size_t get_entity_overwrites_index(const ir_entity *ent, ir_entity *overwritten);
502 FIRM_API ir_entity *get_entity_overwrites(const ir_entity *ent, size_t pos);
503 FIRM_API void set_entity_overwrites(ir_entity *ent, size_t pos, ir_entity *overwritten);
504 FIRM_API void remove_entity_overwrites(ir_entity *ent, ir_entity *overwritten);
506 FIRM_API size_t get_entity_n_overwrittenby(const ir_entity *ent);
507 FIRM_API size_t get_entity_overwrittenby_index(const ir_entity *ent, ir_entity *overwrites);
508 FIRM_API ir_entity *get_entity_overwrittenby(const ir_entity *ent, size_t pos);
509 FIRM_API void set_entity_overwrittenby(ir_entity *ent, size_t pos, ir_entity *overwrites);
510 FIRM_API void remove_entity_overwrittenby(ir_entity *ent, ir_entity *overwrites);
513 * Checks whether a pointer points to an entity.
515 * @param thing an arbitrary pointer
518 * true if the thing is an entity, else false
520 FIRM_API int is_entity(const void *thing);
522 /** Returns true if the type of the entity is a primitive, pointer
523 * enumeration or method type.
525 * @note This is a different classification than from is_primitive_type().
527 FIRM_API int is_atomic_entity(const ir_entity *ent);
528 /** Returns true if the type of the entity is a class, structure,
529 array or union type. */
530 FIRM_API int is_compound_entity(const ir_entity *ent);
531 /** Returns true if the type of the entity is a Method type. */
532 FIRM_API int is_method_entity(const ir_entity *ent);
534 /** Outputs a unique number for this entity if libfirm is compiled for
535 * debugging, (configure with --enable-debug) else returns the address
536 * of the type cast to long.
538 FIRM_API long get_entity_nr(const ir_entity *ent);
540 /** Returns the entities visited count. */
541 FIRM_API ir_visited_t get_entity_visited(const ir_entity *ent);
543 /** Sets the entities visited count. */
544 FIRM_API void set_entity_visited(ir_entity *ent, ir_visited_t num);
546 /** Sets visited field in entity to entity_visited. */
547 FIRM_API void mark_entity_visited(ir_entity *ent);
549 /** Returns true if this entity was visited. */
550 FIRM_API int entity_visited(const ir_entity *ent);
552 /** Returns true if this entity was not visited. */
553 FIRM_API int entity_not_visited(const ir_entity *ent);
556 * Returns the mask of the additional entity properties.
557 * The properties are automatically inherited from the irg if available
558 * or from the method type if they were not set using
559 * set_entity_additional_properties() or
560 * set_entity_additional_property().
562 FIRM_API mtp_additional_properties get_entity_additional_properties(const ir_entity *ent);
564 /** Sets the mask of the additional graph properties. */
565 FIRM_API void set_entity_additional_properties(ir_entity *ent,
566 mtp_additional_properties prop);
568 /** Sets additional graph properties. */
569 FIRM_API void add_entity_additional_properties(ir_entity *ent,
570 mtp_additional_properties flag);
572 /** Returns the class type that this type info entity represents or NULL
573 if ent is no type info entity. */
574 FIRM_API ir_type *get_entity_repr_class(const ir_entity *ent);
577 * @page unknown_entity The Unknown entity
579 * This entity is an auxiliary entity dedicated to support analyses.
581 * The unknown entity represents that there could be an entity, but it is not
582 * known. This entity can be used to initialize fields before an analysis (not known
583 * yet) or to represent the top of a lattice (could not be determined). There exists
584 * exactly one entity unknown. This entity has as owner and as type the unknown type. It is
585 * allocated when initializing the entity module.
587 * The entity can take the role of any entity, also methods. It returns default
588 * values in these cases.
590 * The following values are set:
592 * - name = "unknown_entity"
593 * - ld_name = "unknown_entity"
594 * - owner = unknown_type
595 * - type = unknown_type
597 * - value = SymConst(unknown_entity)
600 * - volatility = volatility_non_volatile
601 * - stickyness = stickyness_unsticky
603 * - overwrites = NULL
604 * - overwrittenby = NULL
609 /** A variable that contains the only unknown entity. */
610 FIRM_API ir_entity *unknown_entity;
612 /** Returns the @link unknown_entity unknown entity @endlink. */
613 FIRM_API ir_entity *get_unknown_entity(void);
615 /** Encodes how a pointer parameter is accessed. */
616 typedef enum ptr_access_kind {
617 ptr_access_none = 0, /**< no access */
618 ptr_access_read = 1, /**< read access */
619 ptr_access_write = 2, /**< write access */
620 ptr_access_rw = ptr_access_read|ptr_access_write, /**< read AND write access */
621 ptr_access_store = 4, /**< the pointer is stored */
622 ptr_access_all = ptr_access_rw|ptr_access_store /**< all possible access */
624 ENUM_BITSET(ptr_access_kind)
626 #define IS_READ(a) ((a) & ptr_access_read)
627 #define IS_WRITTEN(a) ((a) & ptr_access_write)
628 #define IS_STORED(a) ((a) & ptr_access_store)
631 * @page tyop type operations
632 * This module specifies the kinds of types available in firm.
634 * They are called type opcodes. These include classes, structs, methods, unions,
635 * arrays, enumerations, pointers and primitive types.
636 * Special types with own opcodes are the id type, a type representing an unknown
637 * type and a type used to specify that something has no type.
641 * An enum for the type kinds.
642 * For each type kind exists a typecode to identify it.
645 tpo_uninitialized = 0, /* not a type opcode */
646 tpo_class, /**< A class type. */
647 tpo_struct, /**< A struct type. */
648 tpo_method, /**< A method type. */
649 tpo_union, /**< An union type. */
650 tpo_array, /**< An array type. */
651 tpo_enumeration, /**< An enumeration type. */
652 tpo_pointer, /**< A pointer type. */
653 tpo_primitive, /**< A primitive type. */
654 tpo_code, /**< a piece of code (a basic block) */
655 tpo_none, /**< Special type for the None type. */
656 tpo_unknown, /**< Special code for the Unknown type. */
657 tpo_last = tpo_unknown /* not a type opcode */
661 * A structure containing information about a kind of type.
662 * A structure containing information about a kind of type. So far
663 * this is only the kind name, an enum for case-switching and some
666 * @see get_tpop_name(), get_tpop_code()
668 typedef struct tp_op tp_op;
672 * Returns the string for the type opcode.
674 * @param op The type opcode to get the string from.
677 FIRM_API const char *get_tpop_name(const tp_op *op);
680 * Returns an enum for the type opcode.
682 * @param op The type opcode to get the enum from.
685 FIRM_API tp_opcode get_tpop_code(const tp_op *op);
688 * This type opcode marks that the corresponding type is a class type.
690 * Consequently the type refers to supertypes, subtypes and entities.
691 * Entities can be any fields, but also methods.
692 * @@@ value class or not???
693 * This struct is dynamically allocated but constant for the lifetime
696 FIRM_API const tp_op *type_class;
697 FIRM_API const tp_op *get_tpop_class(void);
700 * This type opcode marks that the corresponding type is a compound type
703 * Consequently the type refers to a list of entities
704 * which may not be methods (but pointers to methods).
705 * This struct is dynamically allocated but constant for the lifetime
708 FIRM_API const tp_op *type_struct;
709 FIRM_API const tp_op *get_tpop_struct(void);
712 * This type opcode marks that the corresponding type is a method type.
714 * Consequently it refers to a list of arguments and results.
715 * This struct is dynamically allocated but constant for the lifetime
718 FIRM_API const tp_op *type_method;
719 FIRM_API const tp_op *get_tpop_method(void);
722 * This type opcode marks that the corresponding type is a union type.
724 * Consequently it refers to a list of unioned types.
725 * This struct is dynamically allocated but constant for the lifetime
728 FIRM_API const tp_op *type_union;
729 FIRM_API const tp_op *get_tpop_union(void);
732 * This type opcode marks that the corresponding type is an array type.
734 * Consequently it contains a list of dimensions (lower and upper bounds)
735 * and an element type.
736 * This struct is dynamically allocated but constant for the lifetime
739 FIRM_API const tp_op *type_array;
740 FIRM_API const tp_op *get_tpop_array(void);
743 * This type opcode marks that the corresponding type is an enumeration type.
745 * Consequently it contains a list of idents for the enumeration identifiers
746 * and a list of target values that are the constants used to implement
748 * This struct is dynamically allocated but constant for the lifetime
751 FIRM_API const tp_op *type_enumeration;
752 FIRM_API const tp_op *get_tpop_enumeration(void);
755 * This type opcode marks that the corresponding type is a pointer type.
757 * It contains a reference to the type the pointer points to.
758 * This struct is dynamically allocated but constant for the lifetime
761 FIRM_API const tp_op *type_pointer;
762 FIRM_API const tp_op *get_tpop_pointer(void);
765 * This type opcode marks that the corresponding type is a primitive type.
767 * Primitive types are types that are directly mapped to target machine
769 * This struct is dynamically allocated but constant for the lifetime
772 FIRM_API const tp_op *type_primitive;
773 FIRM_API const tp_op *get_tpop_primitive(void);
776 * The code type is used to mark pieces of code (basic blocks)
778 FIRM_API const tp_op *tpop_code;
779 FIRM_API const tp_op *get_tpop_code_type(void);
782 * This type opcode is an auxiliary opcode dedicated to support type analyses.
784 * Types with this opcode represents that there is no type.
785 * The type can be used to initialize fields of the type* that actually can not
786 * contain a type or that are initialized for an analysis. There exists exactly
787 * one type with this opcode.
789 FIRM_API const tp_op *tpop_none;
790 FIRM_API const tp_op *get_tpop_none(void);
793 * This type opcode is an auxiliary opcode dedicated to support type analyses.
795 * Types with this opcode represents that there could be a type, but it is not
796 * known. This type can be used to initialize fields before an analysis (not known
797 * yet) or to represent the top of a lattice (could not be determined). There exists
798 * exactly one type with this opcode.
800 FIRM_API const tp_op *tpop_unknown;
801 FIRM_API const tp_op *get_tpop_unknown(void);
803 /* ----------------------------------------------------------------------- */
804 /* Classify pairs of types/entities in the inheritance relations. */
805 /* ----------------------------------------------------------------------- */
807 /** Returns true if low is subclass of high.
809 * Low is a subclass of high if low == high or if low is a subclass of
810 * a subclass of high. I.e, we search in all subtypes of high for low.
811 * @@@ this can be implemented more efficient if we know the set of all
812 * subclasses of high. */
813 FIRM_API int is_SubClass_of(ir_type *low, ir_type *high);
815 /** Subclass check for pointers to classes.
817 * Dereferences at both types the same amount of pointer types (as
818 * many as possible). If the remaining types are both class types
819 * and subclasses, returns true, else false. Can also be called with
820 * two class types. */
821 FIRM_API int is_SubClass_ptr_of(ir_type *low, ir_type *high);
823 /** Returns true if high is superclass of low.
825 * Low is a subclass of high if low == high or if low is a subclass of
826 * a subclass of high. I.e, we search in all subtypes of high for low.
827 * @@@ this can be implemented more efficient if we know the set of all
828 * subclasses of high. */
829 #define is_SuperClass_of(high, low) is_SubClass_of(low, high)
831 /** Superclass check for pointers to classes.
833 * Dereferences at both types the same amount of pointer types (as
834 * many as possible). If the remaining types are both class types
835 * and superclasses, returns true, else false. Can also be called with
836 * two class types. */
837 #define is_SuperClass_ptr_of(low, high) is_SubClass_ptr_of(high, low)
839 /** Returns true if high is (transitive) overwritten by low.
841 * Returns false if high == low. */
842 FIRM_API int is_overwritten_by(ir_entity *high, ir_entity *low);
844 /** Resolve polymorphism in the inheritance relation.
846 * Returns the dynamically referenced entity if the static entity and the
847 * dynamic type are given.
848 * Searches downwards in overwritten tree. */
849 FIRM_API ir_entity *resolve_ent_polymorphy(ir_type *dynamic_class,
850 ir_entity* static_ent);
852 /* ----------------------------------------------------------------------- */
853 /* Resolve implicit inheritance. */
854 /* ----------------------------------------------------------------------- */
856 /** Default name mangling for inherited entities.
858 * Returns an ident that consists of the name of type followed by an
859 * underscore and the name (not ld_name) of the entity. */
860 FIRM_API ident *default_mangle_inherited_name(const ir_entity *ent,
861 const ir_type *clss);
863 /** Type of argument functions for inheritance resolver.
865 * @param ent The entity in the super type that will be overwritten
866 * by the newly generated entity, for which this name is
868 * @param clss The class type in which the new entity will be placed.
870 typedef ident *mangle_inherited_name_func(const ir_entity *ent,
871 const ir_type *clss);
873 /** Resolve implicit inheritance.
875 * Resolves the implicit inheritance supplied by firm. Firm defines,
876 * that each entity that is not overwritten in a subclass is
877 * inherited to this subclass without change implicitly. This
878 * function generates entities that explicitly represent this
879 * inheritance. It generates for each entity overwriting entities in
880 * all subclasses of the owner of the entity, if the entity is not
881 * overwritten in that subclass.
883 * The name of the new entity is generated with the function passed.
884 * If the function is NULL, the default_mangle_inherited_name() is
887 FIRM_API void resolve_inheritance(mangle_inherited_name_func *mfunc);
890 /* ----------------------------------------------------------------------- */
891 /* The transitive closure of the subclass/superclass and */
892 /* overwrites/overwrittenby relation. */
894 /* A walk over the ir (O(#types+#entities)) computes the transitive */
895 /* closure. Adding a new type/entity or changing the basic relations in */
896 /* some other way invalidates the transitive closure, i.e., it is not */
897 /* updated by the basic functions. */
899 /* The transitive edges are held in a set, not in an array as the */
900 /* underlying relation. */
902 /* Do the sets contain the node itself? I assume NOT! */
903 /* ----------------------------------------------------------------------- */
906 * The state of the transitive closure.
909 inh_transitive_closure_none, /**< Closure is not computed, can not be accessed. */
910 inh_transitive_closure_valid, /**< Closure computed and valid. */
911 inh_transitive_closure_invalid, /**< Closure invalid, but can be accessed. */
912 inh_transitive_closure_max /**< Invalid value. */
913 } inh_transitive_closure_state;
915 FIRM_API void set_irp_inh_transitive_closure_state(inh_transitive_closure_state s);
916 FIRM_API void invalidate_irp_inh_transitive_closure_state(void);
917 FIRM_API inh_transitive_closure_state get_irp_inh_transitive_closure_state(void);
920 /** Compute transitive closure of the subclass/superclass and
921 * overwrites/overwrittenby relation.
923 * This function walks over the ir (O(\#types+\#entities)) to compute the
924 * transitive closure. */
925 FIRM_API void compute_inh_transitive_closure(void);
927 /** Free memory occupied by the transitive closure information. */
928 FIRM_API void free_inh_transitive_closure(void);
931 /* - subtype ------------------------------------------------------------- */
933 /** Iterate over all transitive subtypes. */
934 FIRM_API ir_type *get_class_trans_subtype_first(const ir_type *tp);
935 FIRM_API ir_type *get_class_trans_subtype_next(const ir_type *tp);
936 FIRM_API int is_class_trans_subtype(const ir_type *tp, const ir_type *subtp);
938 /* - supertype ----------------------------------------------------------- */
940 /** Iterate over all transitive supertypes. */
941 FIRM_API ir_type *get_class_trans_supertype_first(const ir_type *tp);
942 FIRM_API ir_type *get_class_trans_supertype_next(const ir_type *tp);
944 /* - overwrittenby ------------------------------------------------------- */
946 /** Iterate over all entities that transitive overwrite this entities. */
947 FIRM_API ir_entity *get_entity_trans_overwrittenby_first(const ir_entity *ent);
948 FIRM_API ir_entity *get_entity_trans_overwrittenby_next(const ir_entity *ent);
950 /* - overwrites ---------------------------------------------------------- */
952 /** Iterate over all transitive overwritten entities. */
953 FIRM_API ir_entity *get_entity_trans_overwrites_first(const ir_entity *ent);
954 FIRM_API ir_entity *get_entity_trans_overwrites_next(const ir_entity *ent);
957 /* ----------------------------------------------------------------------- */
958 /** The state of Cast operations that cast class types or pointers to class
961 * The state expresses, how far Cast operations conform with the class
965 * class B1 extends A {}
966 * class B2 extends A {}
967 * class C extends B1 {}
968 * normalized: Cast operations conform with the inheritance relation.
969 * I.e., the type of the operand of a Cast is either a super= or a sub-
970 * type of the type casted to. Example: (A)((B2) (new C())).
971 * transitive: Cast operations conform with the transitive inheritance
972 * relation. Example: (A)(new C()).
973 * any: Cast operations do not conform with the transitive inheritance
974 * relation. Example: (B2)(new B1())
976 /* ----------------------------------------------------------------------- */
978 /** Flags for class cast state.
980 * The state in irp is always smaller or equal to the state of any
983 * We rely on the ordering of the enum. */
985 ir_class_casts_any = 0, /**< There are class casts that do not cast in conformance with
986 the class hierarchy. @@@ So far this does not happen in Firm. */
987 ir_class_casts_transitive = 1, /**< Class casts conform to transitive inheritance edges. Default. */
988 ir_class_casts_normalized = 2, /**< Class casts conform to inheritance edges. */
989 ir_class_casts_state_max
990 } ir_class_cast_state;
991 FIRM_API const char *get_class_cast_state_string(ir_class_cast_state s);
993 FIRM_API void set_irg_class_cast_state(ir_graph *irg,
994 ir_class_cast_state s);
995 FIRM_API ir_class_cast_state get_irg_class_cast_state(const ir_graph *irg);
996 FIRM_API void set_irp_class_cast_state(ir_class_cast_state s);
997 FIRM_API ir_class_cast_state get_irp_class_cast_state(void);
999 /** Verify the class cast state of an irg.
1001 * Asserts if state is to high, outputs debug warning if state is to low
1002 * and firm verbosity is set.
1004 FIRM_API void verify_irg_class_cast_state(ir_graph *irg);
1007 * possible trverify() error codes
1009 enum trverify_error_codes {
1010 no_error = 0, /**< no error */
1011 error_ent_not_cont, /**< overwritten entity not in superclass */
1012 error_null_mem, /**< compound contains NULL member */
1013 error_const_on_wrong_irg, /**< constant placed on wrong IRG */
1014 error_existent_entity_without_irg, /**< Method entities with pecularity_exist must have an irg */
1015 error_wrong_ent_overwrites, /**< number of entity overwrites exceeds number of class overwrites */
1016 error_inherited_ent_without_const, /**< inherited method entity not pointing to existent entity */
1017 error_glob_ent_allocation, /**< wrong allocation of a global entity */
1018 error_ent_const_mode, /**< Mode of constant in entity did not match entities type. */
1019 error_ent_wrong_owner /**< Mode of constant in entity did not match entities type. */
1026 * 0 if no error encountered
1028 FIRM_API int check_type(ir_type *tp);
1031 * Check an entity. Currently, we check only if initialized constants
1032 * are build on the const irg graph.
1035 * 0 if no error encountered
1036 * != 0 a trverify_error_codes code
1038 FIRM_API int check_entity(ir_entity *ent);
1041 * Walks the type information and performs a set of sanity checks.
1043 * Currently, the following checks are executed:
1044 * - values of initialized entities must be allocated on the constant IRG
1045 * - class types: doesn't have NULL members
1046 * - class types: all overwrites are existent in the super type
1049 * 0 if graph is correct
1052 FIRM_API int tr_verify(void);
1055 * @page type representation of types
1057 * Datastructure to hold type information.
1059 * This module supplies a datastructure to represent all types
1060 * known in the compiled program. This includes types specified
1061 * in the program as well as types defined by the language. In the
1062 * view of the intermediate representation there is no difference
1063 * between these types. Finally it specifies some auxiliary types.
1065 * There exist several kinds of types, arranged by the structure of
1066 * the type. A type is described by a set of attributes. Some of
1067 * these attributes are common to all types, others depend on the
1070 * Types are different from the modes defined in irmode: Types are
1071 * on the level of the programming language, modes at the level of
1072 * the target processor.
1075 /** Frees all entities associated with a type.
1076 * Does not free the array entity.
1077 * Warning: ensure these entities are not referenced anywhere else.
1079 FIRM_API void free_type_entities(ir_type *tp);
1081 /** Frees the memory used by the type.
1083 * Removes the type from the type list. Does not free the entities
1084 * belonging to the type, except for the array element entity. Does
1085 * not free if tp is "none" or "unknown". Frees entities in value
1086 * param subtypes of method types!!! Make sure these are not
1087 * referenced any more. Further make sure there is no pointer type
1088 * that refers to this type. */
1089 FIRM_API void free_type(ir_type *tp);
1091 FIRM_API const tp_op *get_type_tpop(const ir_type *tp);
1092 FIRM_API ident *get_type_tpop_nameid(const ir_type *tp);
1093 FIRM_API const char *get_type_tpop_name(const ir_type *tp);
1094 FIRM_API tp_opcode get_type_tpop_code(const ir_type *tp);
1097 * construct a string representing the type.
1098 * This uses the info retrieved by the type_dbg_info if available.
1099 * Otherwise it tries to create an approximate textual representation of the
1101 * Keep in mind that this representation is not unique for each type,
1102 * might abstract away some details. The main intention of this is creating
1103 * human redable strings giving an idea of the type.
1105 FIRM_API void ir_print_type(char *buffer, size_t buffer_size,
1108 /** The state of the type layout. */
1110 layout_undefined, /**< The layout of this type is not defined.
1111 Address computation to access fields is not
1112 possible, fields must be accessed by Sel
1113 nodes. Enumeration constants might be undefined.
1114 This is the default value except for
1115 pointer, primitive and method types. */
1116 layout_fixed /**< The layout is fixed, all component/member entities
1117 have an offset assigned. Size of the type is known.
1118 Arrays can be accessed by explicit address
1119 computation. Enumeration constants must be defined.
1120 Default for pointer, primitive and method types. */
1123 /** Returns a human readable string for the enum entry. */
1124 FIRM_API const char *get_type_state_name(ir_type_state s);
1126 /** Returns the type layout state of a type. */
1127 FIRM_API ir_type_state get_type_state(const ir_type *tp);
1129 /** Sets the type layout state of a type.
1131 * For primitives, pointer and method types the layout is always fixed.
1132 * This call is legal but has no effect.
1134 FIRM_API void set_type_state(ir_type *tp, ir_type_state state);
1136 /** Returns the mode of a type.
1138 * Returns NULL for all non atomic types.
1140 FIRM_API ir_mode *get_type_mode(const ir_type *tp);
1142 /** Sets the mode of a type.
1144 * Only has an effect on primitive, enumeration and pointer types.
1146 FIRM_API void set_type_mode(ir_type *tp, ir_mode* m);
1148 /** Returns the size of a type in bytes. */
1149 FIRM_API unsigned get_type_size_bytes(const ir_type *tp);
1151 /** Sets the size of a type in bytes.
1153 * For primitive, enumeration, pointer and method types the size
1154 * is always fixed. This call is legal but has no effect.
1156 FIRM_API void set_type_size_bytes(ir_type *tp, unsigned size);
1158 /** Returns the alignment of a type in bytes. */
1159 FIRM_API unsigned get_type_alignment_bytes(ir_type *tp);
1161 /** Returns the alignment of a type in bits.
1163 * If the alignment of a type is
1164 * not set, it is calculated here according to the following rules:
1165 * -#.) if a type has a mode, the alignment is the mode size.
1166 * -#.) compound types have the alignment of there biggest member.
1167 * -#.) array types have the alignment of there element type.
1168 * -#.) method types return 0 here.
1169 * -#.) all other types return 1 here (i.e. aligned at byte).
1171 FIRM_API void set_type_alignment_bytes(ir_type *tp, unsigned align);
1173 /** Returns the visited count of a type. */
1174 FIRM_API ir_visited_t get_type_visited(const ir_type *tp);
1175 /** Sets the visited count of a type to num. */
1176 FIRM_API void set_type_visited(ir_type *tp, ir_visited_t num);
1177 /** Sets visited field in type to type_visited. */
1178 FIRM_API void mark_type_visited(ir_type *tp);
1179 /** Returns non-zero if the type is already visited */
1180 FIRM_API int type_visited(const ir_type *tp);
1181 /** Returns non-zero if the type is not yet visited */
1182 FIRM_API int type_not_visited(const ir_type *tp);
1184 /** Returns the associated link field of a type. */
1185 FIRM_API void *get_type_link(const ir_type *tp);
1186 /** Sets the associated link field of a type. */
1187 FIRM_API void set_type_link(ir_type *tp, void *l);
1190 * Visited flag to traverse the type information.
1192 * Increase this flag by one before traversing the type information
1193 * using inc_master_type_visited().
1194 * Mark type nodes as visited by mark_type_visited(ir_type).
1195 * Check whether node was already visited by type_visited(ir_type)
1196 * and type_not_visited(ir_type).
1197 * Or use the function to walk all types.
1201 FIRM_API void set_master_type_visited(ir_visited_t val);
1202 FIRM_API ir_visited_t get_master_type_visited(void);
1203 FIRM_API void inc_master_type_visited(void);
1206 * Sets the debug information of a type.
1208 * @param tp The type.
1209 * @param db The debug info.
1211 FIRM_API void set_type_dbg_info(ir_type *tp, type_dbg_info *db);
1214 * Returns the debug information of a type.
1216 * @param tp The type.
1218 FIRM_API type_dbg_info *get_type_dbg_info(const ir_type *tp);
1221 * Checks whether a pointer points to a type.
1223 * @param thing an arbitrary pointer
1226 * true if the thing is a type, else false
1228 FIRM_API int is_type(const void *thing);
1231 * Checks whether two types are structurally equal.
1233 * @param typ1 the first type
1234 * @param typ2 the second type
1237 * true if the types are equal, else false.
1239 * Types are equal if :
1240 * - they are the same type kind
1241 * - they have the same name
1242 * - they have the same mode (if applicable)
1243 * - they have the same type_state and, ev., the same size
1244 * - they are class types and have:
1245 * - the same members (see same_entity in entity.h)
1246 * - the same supertypes -- the C-pointers are compared --> no recursive call.
1247 * - the same number of subtypes. Subtypes are not compared,
1248 * as this could cause a cyclic test.
1249 * - they are structure types and have the same members
1250 * - they are method types and have
1251 * - the same parameter types
1252 * - the same result types
1253 * - they are union types and have the same members
1254 * - they are array types and have
1255 * - the same number of dimensions
1256 * - the same dimension bounds
1257 * - the same dimension order
1258 * - the same element type
1259 * - they are enumeration types and have the same enumerator names
1260 * - they are pointer types and have the identical points_to type
1261 * (i.e., the same C-struct to represent the type.
1262 * This is to avoid endless recursions; with pointer types cyclic
1263 * type graphs are possible.)
1265 FIRM_API int equal_type(ir_type *typ1, ir_type *typ2);
1268 * Checks whether two types are structural comparable.
1270 * @param st pointer type
1271 * @param lt pointer type
1274 * true if type st is smaller than type lt, i.e. whenever
1275 * lt is expected a st can be used.
1277 * - they are the same type kind
1278 * - mode(st) < mode (lt) (if applicable)
1279 * - they are class types and st is (transitive) subtype of lt,
1280 * - they are structure types and
1281 * - the members of st have exactly one counterpart in lt with the same name,
1282 * - the counterpart has a bigger type.
1283 * - they are method types and have
1284 * - the same number of parameter and result types,
1285 * - the parameter types of st are smaller than those of lt,
1286 * - the result types of st are smaller than those of lt
1287 * - they are union types and have the members of st have exactly one
1288 * @return counterpart in lt and the type is smaller
1289 * - they are array types and have
1290 * - the same number of dimensions
1291 * - all bounds of lt are bound of st
1292 * - the same dimension order
1293 * - the same element type
1295 * - the element type of st is smaller than that of lt
1296 * - the element types have the same size and fixed layout.
1297 * - they are enumeration types and have the same enumerator names
1298 * - they are pointer types and have the points_to type of st is
1299 * @return smaller than the points_to type of lt.
1302 FIRM_API int smaller_type(ir_type *st, ir_type *lt);
1305 * @page class_type Representation of a class type
1307 * If the type opcode is set to type_class the type represents class
1308 * types. A list of fields and methods is associated with a class.
1309 * Further a class can inherit from and bequest to other classes.
1311 * The following attributes are private to this type kind:
1312 * - member: All entities belonging to this class. This are method entities
1313 * which have type_method or fields that can have any of the
1314 * following type kinds: type_class, type_struct, type_union,
1315 * type_array, type_enumeration, type_pointer, type_primitive.
1317 * The following two are dynamic lists that can be grown with an "add_" function,
1320 * - subtypes: A list of direct subclasses.
1322 * - supertypes: A list of direct superclasses.
1324 * - type_info: An entity representing the type information of this class.
1325 * This entity can be of arbitrari type, Firm did not use it yet.
1326 * It allows to express the coupling of a type with an entity
1327 * representing this type. This information is useful for lowering
1328 * of InstOf and TypeChk nodes. Default: NULL
1330 * - vtable_size: The size of this class virtual function table.
1333 * - final: A final class is always a leaf in the class hierarchy. Final
1334 * classes cannot be super classes of other ones. As this information
1335 * can only be computed in whole world compilations, we allow to
1336 * set this flag. It is used in optimizations if get_opt_closed_world()
1337 * is false. Default: false
1339 * - interface: The class represents an interface. This flag can be set to distinguish
1340 * between interfaces, abstract classes and other classes that all may
1341 * have the peculiarity peculiarity_description. Depending on this flag
1342 * the lowering might do different actions. Default: false
1344 * - abstract : The class represents an abstract class. This flag can be set to distinguish
1345 * between interfaces, abstract classes and other classes that all may
1346 * have the peculiarity peculiarity_description. Depending on this flag
1347 * the lowering might do different actions. Default: false
1350 /** Creates a new class type. */
1351 FIRM_API ir_type *new_type_class(ident *name);
1353 /** Creates a new class type with debug information. */
1354 FIRM_API ir_type *new_d_type_class(ident *name, type_dbg_info *db);
1356 /* --- manipulate private fields of class type --- */
1358 /** return identifier of the class type */
1359 FIRM_API ident *get_class_ident(const ir_type *clss);
1361 /** return identifier of the class type */
1362 FIRM_API const char *get_class_name(const ir_type *clss);
1364 /** Returns the number of members of this class. */
1365 FIRM_API size_t get_class_n_members(const ir_type *clss);
1367 /** Returns the member at position pos, 0 <= pos < n_member */
1368 FIRM_API ir_entity *get_class_member(const ir_type *clss, size_t pos);
1370 #define INVALID_MEMBER_INDEX ((size_t)-1)
1372 /** Returns index of mem in clss, INVALID_MEMBER_INDEX if not contained. */
1373 FIRM_API size_t get_class_member_index(const ir_type *clss, ir_entity *mem);
1375 /** Finds the member with name 'name'. If several members with the same
1376 * name returns one of them. Returns NULL if no member found. */
1377 FIRM_API ir_entity *get_class_member_by_name(ir_type *clss, ident *name);
1379 /** Adds subtype as subtype to clss.
1381 * Checks whether clss is a supertype of subtype. If not
1382 * adds also clss as supertype to subtype. */
1383 FIRM_API void add_class_subtype(ir_type *clss, ir_type *subtype);
1385 /** Returns the number of subtypes */
1386 FIRM_API size_t get_class_n_subtypes(const ir_type *clss);
1388 /** Gets the subtype at position pos, 0 <= pos < n_subtype. */
1389 FIRM_API ir_type *get_class_subtype(ir_type *clss, size_t pos);
1391 /** Returns the index to access subclass as subtype of class.
1393 * If subclass is no direct subtype of class returns -1.
1395 FIRM_API size_t get_class_subtype_index(ir_type *clss, const ir_type *subclass);
1397 /** Sets the subtype at position pos, 0 <= pos < n_subtype.
1399 * Does not set the corresponding supertype relation for subtype: this might
1400 * be a different position! */
1401 FIRM_API void set_class_subtype(ir_type *clss, ir_type *subtype, size_t pos);
1403 /** Finds subtype in the list of subtypes and removes it */
1404 FIRM_API void remove_class_subtype(ir_type *clss, ir_type *subtype);
1406 /* Convenience macros */
1407 #define add_class_derived_type(clss, drvtype) add_class_subtype(clss, drvtype)
1408 #define get_class_n_derived_types(clss) get_class_n_subtypes(clss)
1409 #define get_class_derived_type(clss, pos) get_class_subtype(clss, pos)
1410 #define get_class_derived_type_index(clss, drvtype) get_class_subtype_index(clss, drvtype)
1411 #define set_class_derived_type(clss, drvtype, pos) set_class_subtype(clss, drvtype, pos)
1412 #define remove_class_derived_type(clss, drvtype) remove_class_subtype(clss, drvtype)
1414 /** Adds supertype as supertype to class.
1416 * Checks whether clss is a subtype of supertype. If not
1417 * adds also clss as subtype to supertype. */
1418 FIRM_API void add_class_supertype(ir_type *clss, ir_type *supertype);
1420 /** Returns the number of supertypes */
1421 FIRM_API size_t get_class_n_supertypes(const ir_type *clss);
1423 /** Returns the index to access superclass as supertype of class.
1425 * If superclass is no direct supertype of class returns -1.
1427 FIRM_API size_t get_class_supertype_index(ir_type *clss, ir_type *super_clss);
1429 /** Gets the supertype at position pos, 0 <= pos < n_supertype. */
1430 FIRM_API ir_type *get_class_supertype(ir_type *clss, size_t pos);
1432 /** Sets the supertype at position pos, 0 <= pos < n_supertype.
1434 * Does not set the corresponding subtype relation for supertype: this might
1435 * be at a different position! */
1436 FIRM_API void set_class_supertype(ir_type *clss, ir_type *supertype, size_t pos);
1438 /** Finds supertype in the list of supertypes and removes it */
1439 FIRM_API void remove_class_supertype(ir_type *clss, ir_type *supertype);
1441 /** Convenience macro */
1442 #define add_class_base_type(clss, basetype) add_class_supertype(clss, basetype)
1443 #define get_class_n_base_types(clss) get_class_n_supertypes(clss)
1444 #define get_class_base_type_index(clss, base_clss) get_class_supertype_index(clss, base_clss)
1445 #define get_class_base_type(clss, pos) get_class_supertype(clss, pos)
1446 #define set_class_base_type(clss, basetype, pos) set_class_supertype(clss, basetype, pos)
1447 #define remove_class_base_type(clss, basetype) remove_class_supertype(clss, basetype)
1449 /** Returns the type info entity of a class. */
1450 FIRM_API ir_entity *get_class_type_info(const ir_type *clss);
1452 /** Set a type info entity for the class. */
1453 FIRM_API void set_class_type_info(ir_type *clss, ir_entity *ent);
1455 /** Returns the size of the virtual function table. */
1456 FIRM_API unsigned get_class_vtable_size(const ir_type *clss);
1458 /** Sets a new size of the virtual function table. */
1459 FIRM_API void set_class_vtable_size(ir_type *clss, unsigned size);
1461 /** Returns non-zero if a class is final. */
1462 FIRM_API int is_class_final(const ir_type *clss);
1464 /** Sets the class final flag. */
1465 FIRM_API void set_class_final(ir_type *clss, int flag);
1467 /** Return non-zero if a class is an interface */
1468 FIRM_API int is_class_interface(const ir_type *clss);
1470 /** Sets the class interface flag. */
1471 FIRM_API void set_class_interface(ir_type *clss, int flag);
1473 /** Return non-zero if a class is an abstract class. */
1474 FIRM_API int is_class_abstract(const ir_type *clss);
1476 /** Sets the class abstract flag. */
1477 FIRM_API void set_class_abstract(ir_type *clss, int flag);
1479 /** Returns true if a type is a class type. */
1480 FIRM_API int is_Class_type(const ir_type *clss);
1483 * @page struct_type Representation of a struct type
1485 * A struct type represents aggregate types that consist of a list
1488 * The following attributes are private to this type kind:
1489 * - member: All entities belonging to this class. This are the fields
1490 * that can have any of the following types: type_class,
1491 * type_struct, type_union, type_array, type_enumeration,
1492 * type_pointer, type_primitive.
1493 * This is a dynamic list that can be grown with an "add_" function,
1495 * This is a dynamic list that can be grown with an "add_" function,
1498 /** Creates a new type struct */
1499 FIRM_API ir_type *new_type_struct(ident *name);
1500 /** Creates a new type struct with debug information. */
1501 FIRM_API ir_type *new_d_type_struct(ident *name, type_dbg_info* db);
1503 /* --- manipulate private fields of struct --- */
1505 /** return struct identifier */
1506 FIRM_API ident *get_struct_ident(const ir_type *strct);
1508 /** return struct identifier as c-string*/
1509 FIRM_API const char *get_struct_name(const ir_type *strct);
1511 /** Returns the number of members of this struct. */
1512 FIRM_API size_t get_struct_n_members(const ir_type *strct);
1514 /** Returns the member at position pos, pos < n_member */
1515 FIRM_API ir_entity *get_struct_member(const ir_type *strct, size_t pos);
1517 /** Returns index of member in strct, -1 if not contained. */
1518 FIRM_API size_t get_struct_member_index(const ir_type *strct, ir_entity *member);
1520 /** Returns true if a type is a struct type. */
1521 FIRM_API int is_Struct_type(const ir_type *strct);
1524 * @page method_type Representation of a method type
1526 * A method type represents a method, function or procedure type.
1527 * It contains a list of the parameter and result types, as these
1528 * are part of the type description. These lists should not
1529 * be changed by a optimization, as a change creates a new method
1530 * type. Therefore optimizations should allocated new method types.
1531 * The set_ routines are only for construction by a frontend.
1533 * - n_params: Number of parameters to the procedure.
1534 * A procedure in FIRM has only call by value parameters.
1536 * - param_type: A list with the types of parameters. This list is ordered.
1537 * The nth type in this list corresponds to the nth element
1538 * in the parameter tuple that is a result of the start node.
1539 * (See ircons.h for more information.)
1541 * - value_param_ents
1542 * A list of entities (whose owner is a struct private to the
1543 * method type) that represent parameters passed by value.
1545 * - n_res: The number of results of the method. In general, procedures
1546 * have zero results, functions one.
1548 * - res_type: A list with the types of parameters. This list is ordered.
1549 * The nth type in this list corresponds to the nth input to
1550 * Return nodes. (See ircons.h for more information.)
1553 /* These macros define the suffixes for the types and entities used
1554 to represent value parameters / results. */
1555 #define VALUE_PARAMS_SUFFIX "val_param"
1556 #define VALUE_RESS_SUFFIX "val_res"
1558 /** Create a new method type.
1560 * @param n_param the number of parameters
1561 * @param n_res the number of results
1563 * The arrays for the parameter and result types are not initialized by
1566 FIRM_API ir_type *new_type_method(size_t n_param, size_t n_res);
1568 /** Create a new method type with debug information.
1570 * @param n_param the number of parameters
1571 * @param n_res the number of results
1572 * @param db user defined debug information
1574 * The arrays for the parameter and result types are not initialized by
1577 FIRM_API ir_type *new_d_type_method(size_t n_param, size_t n_res,
1580 /* -- manipulate private fields of method. -- */
1582 /** Returns the number of parameters of this method. */
1583 FIRM_API size_t get_method_n_params(const ir_type *method);
1585 /** Returns the type of the parameter at position pos of a method. */
1586 FIRM_API ir_type *get_method_param_type(ir_type *method, size_t pos);
1587 /** Sets the type of the parameter at position pos of a method.
1588 Also changes the type in the pass-by-value representation by just
1589 changing the type of the corresponding entity if the representation is constructed. */
1590 FIRM_API void set_method_param_type(ir_type *method, size_t pos, ir_type *tp);
1591 /** Returns an entity that represents the copied value argument. Only necessary
1592 for compounds passed by value. This information is constructed only on demand. */
1593 FIRM_API ir_entity *get_method_value_param_ent(ir_type *method, size_t pos);
1595 * Sets the type that represents the copied value arguments.
1597 FIRM_API void set_method_value_param_type(ir_type *method, ir_type *tp);
1599 * Returns a type that represents the copied value arguments if one
1600 * was allocated, else NULL.
1602 FIRM_API ir_type *get_method_value_param_type(const ir_type *method);
1603 /** Returns the number of results of a method type. */
1604 FIRM_API size_t get_method_n_ress(const ir_type *method);
1605 /** Returns the return type of a method type at position pos. */
1606 FIRM_API ir_type *get_method_res_type(ir_type *method, size_t pos);
1607 /** Sets the type of the result at position pos of a method.
1608 Also changes the type in the pass-by-value representation by just
1609 changing the type of the corresponding entity if the representation is constructed. */
1610 FIRM_API void set_method_res_type(ir_type *method, size_t pos, ir_type *tp);
1613 * This enum flags the variadicity of methods (methods with a
1614 * variable amount of arguments (e.g. C's printf). Default is
1617 typedef enum ir_variadicity {
1618 variadicity_non_variadic, /**< non variadic */
1619 variadicity_variadic /**< variadic */
1622 /** Returns the null-terminated name of this variadicity. */
1623 FIRM_API const char *get_variadicity_name(ir_variadicity vari);
1625 /** Returns the variadicity of a method. */
1626 FIRM_API ir_variadicity get_method_variadicity(const ir_type *method);
1628 /** Sets the variadicity of a method. */
1629 FIRM_API void set_method_variadicity(ir_type *method, ir_variadicity vari);
1631 /** Returns the mask of the additional graph properties. */
1632 FIRM_API mtp_additional_properties get_method_additional_properties(const ir_type *method);
1634 /** Sets the mask of the additional graph properties. */
1635 FIRM_API void set_method_additional_properties(ir_type *method,
1636 mtp_additional_properties property_mask);
1638 /** Sets one additional graph property. */
1639 FIRM_API void add_method_additional_properties(ir_type *method,
1640 mtp_additional_properties flag);
1643 * Calling conventions: lower 24 bits are the number of register parameters,
1644 * upper 8 encode the calling conventions.
1647 cc_reg_param = 0x01000000, /**< Transmit parameters in registers, else the stack is used.
1648 This flag may be set as default on some architectures. */
1649 cc_last_on_top = 0x02000000, /**< The last non-register parameter is transmitted on top of
1650 the stack. This is equivalent to the pascal
1651 calling convention. If this flag is not set, the first
1652 non-register parameter is used (stdcall or cdecl
1653 calling convention) */
1654 cc_callee_clear_stk = 0x04000000, /**< The callee clears the stack. This forbids variadic
1655 function calls (stdcall). */
1656 cc_this_call = 0x08000000, /**< The first parameter is a this pointer and is transmitted
1657 in a special way. */
1658 cc_compound_ret = 0x10000000, /**< The method returns a compound type. */
1659 cc_frame_on_caller_stk = 0x20000000, /**< The method did not allocate an own stack frame, instead the
1660 caller must reserve size on its own stack. */
1661 cc_fpreg_param = 0x40000000, /**< Transmit floating point parameters in registers, else the stack is used. */
1662 cc_bits = (0xFF << 24)/**< The calling convention bits. */
1663 } calling_convention;
1665 /* some often used cases: made as defines because firmjni cannot handle two
1666 equal enum values. */
1668 /** cdecl calling convention */
1669 #define cc_cdecl_set (0)
1670 /** stdcall calling convention */
1671 #define cc_stdcall_set cc_callee_clear_stk
1672 /** fastcall calling convention */
1673 #define cc_fastcall_set (cc_reg_param|cc_callee_clear_stk)
1676 * check for the CDECL calling convention
1678 #define IS_CDECL(cc_mask) (((cc_mask) & cc_bits) == cc_cdecl_set)
1681 * check for the STDCALL calling convention
1683 #define IS_STDCALL(cc_mask) (((cc_mask) & cc_bits) == cc_stdcall_set)
1686 * check for the FASTCALL calling convention
1688 #define IS_FASTCALL(cc_mask) (((cc_mask) & cc_bits) == cc_fastcall_set)
1691 * Sets the CDECL convention bits.
1693 #define SET_CDECL(cc_mask) (((cc_mask) & ~cc_bits) | cc_cdecl_set)
1696 * Set. the STDCALL convention bits.
1698 #define SET_STDCALL(cc_mask) (((cc_mask) & ~cc_bits) | cc_stdcall_set)
1701 * Sets the FASTCALL convention bits.
1703 #define SET_FASTCALL(cc_mask) (((cc_mask) & ~cc_bits) | cc_fastcall_set)
1705 /** Returns the calling convention of an entities graph. */
1706 FIRM_API unsigned get_method_calling_convention(const ir_type *method);
1708 /** Sets the calling convention of an entities graph. */
1709 FIRM_API void set_method_calling_convention(ir_type *method, unsigned cc_mask);
1711 /** Returns the number of registers parameters, 0 means default. */
1712 FIRM_API unsigned get_method_n_regparams(ir_type *method);
1714 /** Sets the number of registers parameters, 0 means default. */
1715 FIRM_API void set_method_n_regparams(ir_type *method, unsigned n_regs);
1717 /** Returns true if a type is a method type. */
1718 FIRM_API int is_Method_type(const ir_type *method);
1721 * @page union_type Representation of a union (variant) type.
1723 * The union type represents union types. Note that this representation
1724 * resembles the C union type. For tagged variant types like in Pascal or Modula
1725 * a combination of a struct and a union type must be used.
1727 * - n_types: Number of unioned types.
1728 * - members: Entities for unioned types. Fixed length array.
1729 * This is a dynamic list that can be grown with an "add_" function,
1732 /** Creates a new type union. */
1733 FIRM_API ir_type *new_type_union(ident *name);
1735 /** Creates a new type union with debug information. */
1736 FIRM_API ir_type *new_d_type_union(ident *name, type_dbg_info* db);
1738 /* --- manipulate private fields of struct --- */
1740 /** return union identifier */
1741 FIRM_API ident *get_union_ident(const ir_type *uni);
1743 /** return union identifier as c-string */
1744 FIRM_API const char *get_union_name(const ir_type *uni);
1746 /** Returns the number of unioned types of this union */
1747 FIRM_API size_t get_union_n_members(const ir_type *uni);
1749 /** Returns the entity at position pos of a union */
1750 FIRM_API ir_entity *get_union_member(const ir_type *uni, size_t pos);
1752 /** Returns index of member in uni, -1 if not contained. */
1753 FIRM_API size_t get_union_member_index(const ir_type *uni, ir_entity *member);
1755 /** Returns true if a type is a union type. */
1756 FIRM_API int is_Union_type(const ir_type *uni);
1759 * @page array_type Representation of an array type
1761 * The array type represents rectangular multi dimensional arrays.
1762 * The constants representing the bounds must be allocated to
1763 * get_const_code_irg() by setting current_ir_graph accordingly.
1765 * - n_dimensions: Number of array dimensions.
1766 * - *lower_bound: Lower bounds of dimensions. Usually all 0.
1767 * - *upper_bound: Upper bounds or dimensions.
1768 * - *element_type: The type of the array elements.
1769 * - *element_ent: An entity for the array elements to be used for
1770 * element selection with Sel.
1773 /** Create a new type array.
1775 * Sets n_dimension to dimension and all dimension entries to NULL.
1776 * Initializes order to the order of the dimensions.
1777 * The entity for array elements is built automatically.
1778 * Set dimension sizes after call to constructor with set_* routines.
1780 FIRM_API ir_type *new_type_array(int n_dims, ir_type *element_type);
1782 /** Create a new type array with debug information.
1784 * Sets n_dimension to dimension and all dimension entries to NULL.
1785 * Initializes order to the order of the dimensions.
1786 * The entity for array elements is built automatically.
1787 * Set dimension sizes after call to constructor with set_* routines.
1788 * A legal array type must have at least one dimension set.
1790 FIRM_API ir_type *new_d_type_array(int n_dims, ir_type *element_type,
1793 /* --- manipulate private fields of array type --- */
1795 /** Returns the number of array dimensions of this type. */
1796 FIRM_API size_t get_array_n_dimensions(const ir_type *array);
1799 * Allocates Const nodes of mode_Is for one array dimension.
1800 * Upper bound in Firm is the element next to the last, i.e. [lower,upper[
1802 FIRM_API void set_array_bounds_int(ir_type *array, size_t dimension,
1803 int lower_bound, int upper_bound);
1805 * Sets the bounds for one array dimension.
1806 * Upper bound in Firm is the element next to the last, i.e. [lower,upper[
1808 FIRM_API void set_array_bounds(ir_type *array, size_t dimension,
1809 ir_node *lower_bound, ir_node *upper_bound);
1810 /** Sets the lower bound for one array dimension, i.e. [lower,upper[ */
1811 FIRM_API void set_array_lower_bound(ir_type *array, size_t dimension,
1812 ir_node *lower_bound);
1814 /** Allocates Const nodes of mode_Is for the lower bound of an array
1815 dimension, i.e. [lower,upper[ */
1816 FIRM_API void set_array_lower_bound_int(ir_type *array, size_t dimension,
1819 /** Sets the upper bound for one array dimension, i.e. [lower,upper[ */
1820 FIRM_API void set_array_upper_bound(ir_type *array, size_t dimension,
1821 ir_node *upper_bound);
1823 /** Allocates Const nodes of mode_Is for the upper bound of an array
1824 dimension, i.e. [lower,upper[. */
1825 FIRM_API void set_array_upper_bound_int(ir_type *array, size_t dimension,
1828 /** Returns true if lower bound != Unknown. */
1829 FIRM_API int has_array_lower_bound(const ir_type *array, size_t dimension);
1830 /** Returns the lower bound of an array. */
1831 FIRM_API ir_node *get_array_lower_bound(const ir_type *array, size_t dimension);
1832 /** Works only if bound is Const node with tarval that can be converted to long. */
1833 FIRM_API long get_array_lower_bound_int(const ir_type *array, size_t dimension);
1834 /** returns true if lower bound != Unknown */
1835 FIRM_API int has_array_upper_bound(const ir_type *array, size_t dimension);
1836 /** Returns the upper bound of an array. */
1837 FIRM_API ir_node *get_array_upper_bound(const ir_type *array, size_t dimension);
1838 /** Works only if bound is Const node with tarval that can be converted to long. */
1839 FIRM_API long get_array_upper_bound_int(const ir_type *array, size_t dimension);
1841 /** Sets an array dimension to a specific order. */
1842 FIRM_API void set_array_order(ir_type *array, size_t dimension, int order);
1844 /** Returns the order of an array dimension. */
1845 FIRM_API int get_array_order(const ir_type *array, size_t dimension);
1847 /** Find the array dimension that is placed at order order. */
1848 FIRM_API size_t find_array_dimension(const ir_type *array, int order);
1850 /** Sets the array element type. */
1851 FIRM_API void set_array_element_type(ir_type *array, ir_type* tp);
1853 /** Gets the array element type. */
1854 FIRM_API ir_type *get_array_element_type(const ir_type *array);
1856 /** Sets the array element entity. */
1857 FIRM_API void set_array_element_entity(ir_type *array, ir_entity *ent);
1859 /** Get the array element entity. */
1860 FIRM_API ir_entity *get_array_element_entity(const ir_type *array);
1862 /** Returns true if a type is an array type. */
1863 FIRM_API int is_Array_type(const ir_type *array);
1866 * @page enumeration_type Representation of an enumeration type
1868 * Enumeration types need not necessarily be represented explicitly
1869 * by Firm types, as the frontend can lower them to integer constants as
1870 * well. For debugging purposes or similar tasks this information is useful.
1871 * The type state layout_fixed is set, if all enumeration constant have
1872 * there tarvals assigned. Until then
1874 * - *const: The target values representing the constants used to
1875 * represent individual enumerations.
1878 /** Create a new type enumeration -- set the enumerators independently. */
1879 FIRM_API ir_type *new_type_enumeration(ident *name, size_t n_enums);
1881 /** Create a new type enumeration with debug information -- set the enumerators independently. */
1882 FIRM_API ir_type *new_d_type_enumeration(ident *name, size_t n_enums,
1885 /* --- manipulate fields of enumeration type. --- */
1887 /** return enumeration identifier */
1888 FIRM_API ident *get_enumeration_ident(const ir_type *enumeration);
1890 /** return enumeration identifier as c-string */
1891 FIRM_API const char *get_enumeration_name(const ir_type *enumeration);
1893 /** Set an enumeration constant to a enumeration type at a given position. */
1894 FIRM_API void set_enumeration_const(ir_type *enumeration, size_t pos,
1895 ident *nameid, ir_tarval *con);
1897 /** Returns the number of enumeration values of this enumeration */
1898 FIRM_API size_t get_enumeration_n_enums(const ir_type *enumeration);
1900 /** Returns the enumeration constant at a given position. */
1901 FIRM_API ir_enum_const *get_enumeration_const(const ir_type *enumeration,
1904 /** Returns the enumeration type owner of an enumeration constant. */
1905 FIRM_API ir_type *get_enumeration_owner(const ir_enum_const *enum_cnst);
1907 /** Sets the enumeration constant value. */
1908 FIRM_API void set_enumeration_value(ir_enum_const *enum_cnst, ir_tarval *con);
1910 /** Returns the enumeration constant value. */
1911 FIRM_API ir_tarval *get_enumeration_value(const ir_enum_const *enum_cnst);
1913 /** Assign an ident to an enumeration constant. */
1914 FIRM_API void set_enumeration_nameid(ir_enum_const *enum_cnst, ident *id);
1916 /** Returns the assigned ident of an enumeration constant. */
1917 FIRM_API ident *get_enumeration_const_nameid(const ir_enum_const *enum_cnst);
1919 /** Returns the assigned name of an enumeration constant. */
1920 FIRM_API const char *get_enumeration_const_name(const ir_enum_const *enum_cnst);
1922 /** Returns true if a type is a enumeration type. */
1923 FIRM_API int is_Enumeration_type(const ir_type *enumeration);
1926 * @page pointer_type Representation of a pointer type
1929 * - points_to: The type of the entity this pointer points to.
1932 /** Creates a new type pointer. */
1933 FIRM_API ir_type *new_type_pointer(ir_type *points_to);
1935 /** Creates a new type pointer with debug information. */
1936 FIRM_API ir_type *new_d_type_pointer(ir_type *points_to, type_dbg_info* db);
1938 /* --- manipulate fields of type_pointer --- */
1940 /** Sets the type to which a pointer points to. */
1941 FIRM_API void set_pointer_points_to_type(ir_type *pointer, ir_type *tp);
1943 /** Returns the type to which a pointer points to. */
1944 FIRM_API ir_type *get_pointer_points_to_type(const ir_type *pointer);
1946 /** Returns true if a type is a pointer type. */
1947 FIRM_API int is_Pointer_type(const ir_type *pointer);
1949 /** Returns the first pointer type that has as points_to tp.
1950 * Not efficient: O(\#types).
1951 * If not found returns firm_unknown_type. */
1952 FIRM_API ir_type *find_pointer_type_to_type(ir_type *tp);
1955 * @page primitive_type Representation of a primitive type
1957 * Primitive types are types that represent atomic data values that
1958 * map directly to modes. They don't have private attributes. The
1959 * important information they carry is held in the common mode field.
1961 /** Creates a new primitive type. */
1962 FIRM_API ir_type *new_type_primitive(ir_mode *mode);
1964 /** Creates a new primitive type with debug information. */
1965 FIRM_API ir_type *new_d_type_primitive(ir_mode *mode, type_dbg_info* db);
1967 /** Returns true if a type is a primitive type. */
1968 FIRM_API int is_Primitive_type(const ir_type *primitive);
1970 /** Return the base type of a primitive (bitfield) type or NULL if none. */
1971 FIRM_API ir_type *get_primitive_base_type(const ir_type *tp);
1973 /** Sets the base type of a primitive (bitfield) type. */
1974 FIRM_API void set_primitive_base_type(ir_type *tp, ir_type *base_tp);
1977 * @page none_type The None type
1979 * This type is an auxiliary type dedicated to support type analyses.
1981 * The none type represents that there is no type. The type can be used to
1982 * initialize fields of type* that actually can not contain a type or that
1983 * are initialized for an analysis. There exists exactly one type none.
1984 * This type is not on the type list in ir_prog. It is
1985 * allocated when initializing the type module.
1987 * The following values are set:
1989 * - name: "type_none"
1990 * - state: layout_fixed
1993 /** A variable that contains the only none type. */
1994 FIRM_API ir_type *firm_none_type;
1996 /** A variable that contains the only code type. */
1997 FIRM_API ir_type *firm_code_type;
1999 /** Returns the none type. */
2000 FIRM_API ir_type *get_none_type(void);
2001 /** Returns the code type. */
2002 FIRM_API ir_type *get_code_type(void);
2005 * @page unknown_type The Unknown type
2007 * This type is an auxiliary type dedicated to support type analyses.
2009 * The unknown type represents that there could be a type, but it is not
2010 * known. This type can be used to initialize fields before an analysis (not known
2011 * yet) or to represent the top of a lattice (could not be determined). There exists
2012 * exactly one type unknown. This type is not on the type list in ir_prog. It is
2013 * allocated when initializing the type module.
2015 * The following values are set:
2017 * - name: "type_unknown"
2018 * - state: layout_fixed
2021 /** A variable that contains the only unknown type. */
2022 FIRM_API ir_type *firm_unknown_type;
2024 /** Returns the unknown type. */
2025 FIRM_API ir_type *get_unknown_type(void);
2029 * Checks whether a type is atomic.
2030 * @param tp any type
2031 * @return true if type is primitive, pointer or enumeration
2033 FIRM_API int is_atomic_type(const ir_type *tp);
2035 /* --- Support for compound types --- */
2038 * Gets the identifier of a compound type
2040 FIRM_API ident *get_compound_ident(const ir_type *tp);
2042 /** return compound identifier as c-string */
2043 FIRM_API const char *get_compound_name(const ir_type *tp);
2046 * Gets the number of elements in a Firm compound type.
2048 * This is just a comfortability function, because structs and
2049 * classes can often be treated be the same code, but they have
2050 * different access functions to their members.
2052 * @param tp The type (must be struct, union or class).
2054 * @return Number of members in the compound type.
2056 FIRM_API size_t get_compound_n_members(const ir_type *tp);
2059 * Gets the member of a Firm compound type at position pos.
2061 * @param tp The type (must be struct, union or class).
2062 * @param pos The number of the member.
2064 * @return The member entity at position pos.
2066 FIRM_API ir_entity *get_compound_member(const ir_type *tp, size_t pos);
2068 /** Returns index of member in tp, -1 if not contained. */
2069 FIRM_API size_t get_compound_member_index(const ir_type *tp, ir_entity *member);
2071 /** Remove a member from a compound type. */
2072 FIRM_API void remove_compound_member(ir_type *compound, ir_entity *entity);
2075 * layout members of a struct/union or class type in a default way.
2077 FIRM_API void default_layout_compound_type(ir_type *tp);
2080 * Checks whether a type is a compound type.
2082 * @param tp - any type
2084 * @return true if the type is class, structure, union or array type.
2086 FIRM_API int is_compound_type(const ir_type *tp);
2089 * Checks whether a type is a code type.
2091 FIRM_API int is_code_type(const ir_type *tp);
2094 * Checks, whether a type is a frame type.
2096 FIRM_API int is_frame_type(const ir_type *tp);
2099 * Checks, whether a type is a value parameter type.
2101 FIRM_API int is_value_param_type(const ir_type *tp);
2104 * Makes a new value type. Value types are struct types,
2105 * so all struct access functions work.
2106 * Value types are not in the global list of types.
2108 FIRM_API ir_type *new_type_value(void);
2111 * Makes a new frame type. Frame types are class types,
2112 * so all class access functions work.
2113 * Frame types are not in the global list of types.
2115 FIRM_API ir_type *new_type_frame(void);
2118 * Makes a clone of a frame type.
2119 * Sets entity links from old frame entities to new onces and
2122 FIRM_API ir_type *clone_frame_type(ir_type *type);
2125 * Allocate an area of size bytes aligned at alignment
2126 * at the start or the end of a frame type.
2127 * The frame type must already have a fixed layout.
2129 * @param frame_type a frame type
2130 * @param size the size of the entity
2131 * @param alignment the alignment of the entity
2132 * @param at_start if true, put the area at the frame type's start, else at end
2134 * @return the entity representing the area
2136 FIRM_API ir_entity *frame_alloc_area(ir_type *frame_type, int size,
2137 unsigned alignment, int at_start);
2139 /*-----------------------------------------------------------------*/
2141 /*-----------------------------------------------------------------*/
2144 * Outputs a unique number for this type if libfirm is compiled for
2145 * debugging, (configure with --enable-debug) else returns the address
2146 * of the type cast to long.
2148 FIRM_API long get_type_nr(const ir_type *tp);
2150 /* ------------------------------------------------------------------------ */
2152 /** Type for a function that compares two types.
2154 * @param tp1 The first type to compare.
2155 * @param tp2 The second type to compare.
2157 typedef int (compare_types_func_t)(const void *tp1, const void *tp2);
2159 /* ------------------------------------------------------------------------ */
2161 /** A data type to treat types and entities as the same. */
2163 ir_type *typ; /**< points to a type */
2164 ir_entity *ent; /**< points to an entity */
2167 /** Type of argument functions for type walkers.
2169 * @param tore points to the visited type or entity
2170 * @param env free environment pointer
2172 typedef void type_walk_func(type_or_ent tore, void *env);
2174 /** The class walk function
2176 * @param clss points to the visited class
2177 * @param env free environment pointer
2179 typedef void class_walk_func(ir_type *clss, void *env);
2181 /** Touches every type and entity in unspecified order. If new
2182 * types/entities are created during the traversal these will
2184 * Does not touch frame types or types for value params ... */
2185 FIRM_API void type_walk(type_walk_func *pre, type_walk_func *post, void *env);
2187 /** Touches every type, entity, frame type, and value param type in
2188 * unspecified order (also all segment types). */
2189 FIRM_API void type_walk_prog(type_walk_func *pre, type_walk_func *post,
2192 /** Walks over all type information reachable from an ir graph.
2194 * Walks over all type information reachable from irg, i.e., starts a
2195 * type walk at the irgs entity, the irgs frame type and all types and
2196 * entities that are attributes to firm nodes. */
2197 FIRM_API void type_walk_irg(ir_graph *irg, type_walk_func *pre,
2198 type_walk_func *post, void *env);
2201 * Touches every class in specified order:
2202 * - first the super class
2203 * - second the class itself
2204 * - third the sub classes. If new classes are created
2205 * during the traversal these will be visited, too.
2207 * @deprecated will be removed?
2209 FIRM_API void type_walk_super2sub(type_walk_func *pre, type_walk_func *post,
2212 /** Walker for class types in inheritance order.
2214 * Touches every class in specified order:
2215 * - first the super class
2216 * - second the class itself
2217 * If new classes are created during the traversal these
2218 * will be visited, too.
2219 * Starts the walk at arbitrary classes.
2220 * Executes pre when first visiting a class. Executes post after
2221 * visiting all superclasses.
2223 * The arguments pre, post, env may be NULL. */
2224 FIRM_API void type_walk_super(type_walk_func *pre, type_walk_func *post,
2227 /** Same as type_walk_super2sub, but visits only class types.
2228 Executes pre for a class if all superclasses have been visited.
2229 Then iterates to subclasses. Executes post after return from
2231 Does not visit global type, frame types.
2233 FIRM_API void class_walk_super2sub(class_walk_func *pre, class_walk_func *post,
2237 * the entity walk function. A function type for entity walkers.
2239 * @param ent points to the visited entity
2240 * @param env free environment pointer
2242 typedef void entity_walk_func(ir_entity *ent, void *env);
2245 * Walks over all entities in the type.
2247 * @param tp the type
2248 * @param doit the entity walker function
2249 * @param env environment, will be passed to the walker function
2251 FIRM_API void walk_types_entities(ir_type *tp, entity_walk_func *doit,
2255 * If we have the closed world assumption, we can calculate the
2256 * finalization of classes and entities by inspecting the class hierarchy.
2257 * After this is done, all classes and entities that are not overridden
2258 * anymore have the final property set.
2260 FIRM_API void types_calc_finalization(void);
2263 FIRM_API ir_visibility get_type_visibility(const ir_type *tp);
2265 FIRM_API void set_type_visibility(ir_type *tp, ir_visibility v);
2269 allocation_automatic,
2270 allocation_parameter,
2275 FIRM_API ir_allocation get_entity_allocation(const ir_entity *ent);
2277 FIRM_API void set_entity_allocation(ir_entity *ent, ir_allocation al);
2281 peculiarity_existent,
2282 peculiarity_description,
2283 peculiarity_inherited
2286 FIRM_API ir_peculiarity get_entity_peculiarity(const ir_entity *ent);
2288 FIRM_API void set_entity_peculiarity(ir_entity *ent, ir_peculiarity pec);
2291 FIRM_API int is_entity_final(const ir_entity *ent);
2293 FIRM_API void set_entity_final(ir_entity *ent, int final);
2296 FIRM_API ir_peculiarity get_class_peculiarity(const ir_type *clss);
2298 FIRM_API void set_class_peculiarity(ir_type *clss, ir_peculiarity pec);