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 * @defgroup ir_entity Entities
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 * Overwrites is a field that specifies that an access to the overwritten
77 * entity in the supertype must use this entity. It's a list as with
78 * multiple inheritance several entities can be overwritten. This field
79 * is mostly useful for method entities.
80 * If a Sel node selects an entity that is overwritten by other entities it
81 * must return a pointer to the entity of the dynamic type of the pointer
82 * that is passed to it. Lowering of the Sel node must assure this.
83 * Overwrittenby is the inverse of overwrites. Both add routines add
84 * both relations, they only differ in the order of arguments.
90 * Visibility classed for entities.
94 * The entity is visible outside the compilation unit, but it is defined
97 ir_visibility_default,
99 * The entity is local to the compilation unit.
100 * A local entity is not visible in other compilation units.
101 * Note that the entity might still be accessed indirectly from other units
106 * The entity is defined outside the compilation unit but potentially used
109 ir_visibility_external,
111 * This has the same semantic as visibility_local. Additionally the symbol is
112 * completely hidden from the linker (it only appears in the assembly).
113 * While visibility_local is probably still visible to debuggers,
114 * visibility_private symbols aren't and probably won't appear in the object
117 ir_visibility_private
121 * linkage specifies how the linker treats symbols
123 typedef enum ir_linkage {
124 IR_LINKAGE_DEFAULT = 0,
126 * A symbol whose definition won't change in a program.
127 * Optimisation might replace loads from this entity with constants.
128 * Also most linkers put such data in a constant segment which is shared
129 * between multiple running instances of the same application.
131 IR_LINKAGE_CONSTANT = 1 << 0,
133 * The entity is a weak symbol.
134 * A weak symbol is overridden by a non-weak symbol if one exists.
135 * Most linkers only support the IR_LINKAGE_WEAK in combination with
138 IR_LINKAGE_WEAK = 1 << 1,
140 * The entity may be removed when it isn't referenced anywhere in the
141 * compilation unit even if it is exported (non-local).
142 * Typically used for C++ instantiated template code (,,COMDAT'' section).
144 IR_LINKAGE_GARBAGE_COLLECT = 1 << 2,
146 * The linker will try to merge entities with same name from different
147 * compilation units. This is the usual behaviour for global variables
148 * without explicit initialisation in C (``COMMON'' symbols). It's also
149 * typically used in C++ for instantiated template code (,,COMDAT'' section)
151 IR_LINKAGE_MERGE = 1 << 3,
153 * Some entity uses are potentially hidden from the compiler.
154 * (For example because they happen in an asm("") statement. This flag
155 * should be set for __attribute__((used)) in C code).
156 * Setting this flag prohibits that the compiler making assumptions about
157 * read/write behaviour to global variables or changing calling conventions
158 * from cdecl to fastcall.
160 IR_LINKAGE_HIDDEN_USER = 1 << 4
162 ENUM_BITSET(ir_linkage)
165 * Return the visibility class of an entity
167 FIRM_API ir_visibility get_entity_visibility(const ir_entity *entity);
170 * Set visibility class of an entity
172 FIRM_API void set_entity_visibility(ir_entity *entity, ir_visibility visibility);
175 * Return 1 if the entity is visible outside the current compilation unit
176 * or to unknown callers (like asm statements).
177 * (The entity might still be accessible indirectly through pointers)
178 * This is a convenience function and does the same as
179 * get_entity_visibility(entity) != ir_visibility_local ||
180 * (get_entity_linkage(entity) & IR_LINKAGE_HIDDEN_USER)
182 FIRM_API int entity_is_externally_visible(const ir_entity *entity);
185 * Return 1 if the entity has a definition (initializer) in the current
188 FIRM_API int entity_has_definition(const ir_entity *entity);
191 * Creates a new entity.
193 * Automatically inserts the entity as a member of owner.
194 * Entity is automatic_allocated and uninitialized except if the type
195 * is type_method, then it is static_allocated and constant. The constant
196 * value is a pointer to the method.
197 * Visibility is local, offset -1, and it is not volatile.
199 FIRM_API ir_entity *new_entity(ir_type *owner, ident *name, ir_type *tp);
202 * Creates a new entity.
204 * Automatically inserts the entity as a member of owner.
205 * The entity is automatic allocated and uninitialized except if the type
206 * is type_method, then it is static allocated and constant. The constant
207 * value is a pointer to the method.
208 * Visibility is local, offset -1, and it is not volatile.
210 FIRM_API ir_entity *new_d_entity(ir_type *owner, ident *name, ir_type *tp,
214 * Creates a new entity corresponding to a function parameter.
215 * This must be created on an irgs frame_type
217 FIRM_API ir_entity *new_parameter_entity(ir_type *owner, size_t pos,
221 * Like new_parameter_entity() but with debug information.
223 FIRM_API ir_entity *new_d_parameter_entity(ir_type *owner, size_t pos,
224 ir_type *type, dbg_info *dbgi);
227 * Check an entity. Currently, we check only if initialized constants
228 * are build on the const irg graph.
231 * 0 if no error encountered
232 * != 0 a trverify_error_codes code
234 FIRM_API int check_entity(ir_entity *ent);
237 * Copies the entity if the new_owner is different from the
238 * owner of the old entity, else returns the old entity.
240 * Automatically inserts the new entity as a member of owner.
241 * Resets the overwrites/overwritten_by fields.
242 * Keeps the old atomic value.
244 FIRM_API ir_entity *copy_entity_own(ir_entity *old, ir_type *new_owner);
247 * Copies the entity if the new_name is different from the
248 * name of the old entity, else returns the old entity.
250 * Automatically inserts the new entity as a member of owner.
251 * The mangled name ld_name is set to NULL.
252 * Overwrites relation is copied from old.
254 FIRM_API ir_entity *copy_entity_name(ir_entity *old, ident *new_name);
259 * The owner will still contain the pointer to this
260 * entity, as well as all other references!
262 FIRM_API void free_entity(ir_entity *ent);
264 /** Returns the name of an entity. */
265 FIRM_API const char *get_entity_name(const ir_entity *ent);
267 /** Returns the ident of an entity. */
268 FIRM_API ident *get_entity_ident(const ir_entity *ent);
270 /** Sets the ident of the entity. */
271 FIRM_API void set_entity_ident(ir_entity *ent, ident *id);
273 /** Returns the mangled name of the entity.
275 * If the mangled name is set it returns the existing name.
276 * Else it generates a name with mangle_entity()
277 * and remembers this new name internally.
279 FIRM_API ident *get_entity_ld_ident(const ir_entity *ent);
281 /** Sets the mangled name of the entity. */
282 FIRM_API void set_entity_ld_ident(ir_entity *ent, ident *ld_ident);
284 /** Returns the mangled name of the entity as a string. */
285 FIRM_API const char *get_entity_ld_name(const ir_entity *ent);
287 /** returns 1 if the entity has an ld_ident set explicitely */
288 FIRM_API int entity_has_ld_ident(const ir_entity *entity);
290 /** Returns the owner of the entity. */
291 FIRM_API ir_type *get_entity_owner(const ir_entity *ent);
294 * Sets the owner field in entity to owner.
295 * Automatically removes entity from old owner type and adds it to the new
298 FIRM_API void set_entity_owner(ir_entity *ent, ir_type *owner);
300 /** Returns the type of an entity. */
301 FIRM_API ir_type *get_entity_type(const ir_entity *ent);
303 /** Sets the type of an entity. */
304 FIRM_API void set_entity_type(ir_entity *ent, ir_type *tp);
306 /** Returns the linkage of an entity. */
307 FIRM_API ir_linkage get_entity_linkage(const ir_entity *entity);
309 /** Sets the linkage of an entity. */
310 FIRM_API void set_entity_linkage(ir_entity *entity, ir_linkage linkage);
311 FIRM_API void add_entity_linkage(ir_entity *entity, ir_linkage linkage);
312 FIRM_API void remove_entity_linkage(ir_entity *entity, ir_linkage linkage);
315 * Returns the volatility of an entity.
318 FIRM_API ir_volatility get_entity_volatility(const ir_entity *ent);
321 * Sets the volatility of an entity.
324 FIRM_API void set_entity_volatility(ir_entity *ent, ir_volatility vol);
326 /** Return the name of the volatility. */
327 FIRM_API const char *get_volatility_name(ir_volatility var);
329 /** Returns alignment of entity in bytes */
330 FIRM_API unsigned get_entity_alignment(const ir_entity *entity);
332 /** Allows you to override the type alignment for an entity.
333 * @param entity the entity
334 * @param alignment alignment in bytes
336 FIRM_API void set_entity_alignment(ir_entity *entity, unsigned alignment);
340 * Returns indication whether entity is aligned in memory.
343 FIRM_API ir_align get_entity_aligned(const ir_entity *ent);
346 * Sets indication whether entity is aligned in memory
349 FIRM_API void set_entity_aligned(ir_entity *ent, ir_align a);
351 /** Return the name of the alignment. */
352 FIRM_API const char *get_align_name(ir_align a);
354 /** Returns the offset of an entity (in a compound) in bytes. Only set if layout = fixed. */
355 FIRM_API int get_entity_offset(const ir_entity *ent);
357 /** Sets the offset of an entity (in a compound) in bytes. */
358 FIRM_API void set_entity_offset(ir_entity *ent, int offset);
360 /** Returns the offset bit remainder of a bitfield entity (in a compound) in bits. Only set if layout = fixed. */
361 FIRM_API unsigned char get_entity_offset_bits_remainder(const ir_entity *ent);
363 /** Sets the offset bit remainder of a bitfield entity (in a compound) in bits. */
364 FIRM_API void set_entity_offset_bits_remainder(ir_entity *ent,
365 unsigned char offset);
367 /** Returns the stored intermediate information. */
368 FIRM_API void *get_entity_link(const ir_entity *ent);
370 /** Stores new intermediate information. */
371 FIRM_API void set_entity_link(ir_entity *ent, void *l);
374 * The entity knows the corresponding irg if the entity is a method.
375 * This allows to get from a Call to the called irg.
377 FIRM_API ir_graph *get_entity_irg(const ir_entity *ent);
379 /** A reserved value for "not yet set". */
380 #define IR_VTABLE_NUM_NOT_SET ((unsigned)(-1))
382 /** Gets the entity vtable number. */
383 FIRM_API unsigned get_entity_vtable_number(const ir_entity *ent);
385 /** Sets the entity vtable number. */
386 FIRM_API void set_entity_vtable_number(ir_entity *ent, unsigned vtable_number);
388 /** Set label number of an entity with code type */
389 FIRM_API void set_entity_label(ir_entity *ent, ir_label_t label);
390 /** Return label number of an entity with code type */
391 FIRM_API ir_label_t get_entity_label(const ir_entity *ent);
393 /** Checks if an entity is compiler generated. */
394 FIRM_API int is_entity_compiler_generated(const ir_entity *ent);
396 /** Sets/resets the compiler generated flag. */
397 FIRM_API void set_entity_compiler_generated(ir_entity *ent, int flag);
400 * Bitfield type indicating the way an entity is used.
403 ir_usage_none = 0, /**< This entity is unused. */
404 ir_usage_address_taken = 1 << 0, /**< The address of this entity was taken. */
405 ir_usage_write = 1 << 1, /**< The entity was written to. */
406 ir_usage_read = 1 << 2, /**< The entity was read. */
407 ir_usage_reinterpret_cast = 1 << 3, /**< The entity was read but with a wrong mode
408 (an implicit reinterpret cast) */
409 /** Unknown access */
411 = ir_usage_address_taken | ir_usage_write | ir_usage_read
412 | ir_usage_reinterpret_cast
415 /** Return the entity usage */
416 FIRM_API ir_entity_usage get_entity_usage(const ir_entity *ent);
418 /** Sets/resets the state of the address taken flag of an entity. */
419 FIRM_API void set_entity_usage(ir_entity *ent, ir_entity_usage flag);
422 * Returns the debug information of an entity.
424 * @param ent The entity.
426 FIRM_API dbg_info *get_entity_dbg_info(const ir_entity *ent);
429 * Sets the debug information of an entity.
431 * @param ent The entity.
432 * @param db The debug info.
434 FIRM_API void set_entity_dbg_info(ir_entity *ent, dbg_info *db);
436 #define IR_VA_START_PARAMETER_NUMBER ((size_t)-1)
439 * returns true if a given entity is a parameter_entity representing the
440 * address of a function parameter
442 FIRM_API int is_parameter_entity(const ir_entity *entity);
445 * returns number of parameter a parameter entitiy represents
447 FIRM_API size_t get_entity_parameter_number(const ir_entity *entity);
450 * set number of parameter an entity represents
452 FIRM_API void set_entity_parameter_number(ir_entity *entity, size_t n);
455 * Returns true if the the node is representable as code on
458 * @deprecated This function is not used by libFirm and stays here
459 * only as a helper for the old Jack frontend.
461 FIRM_API int is_irn_const_expression(ir_node *n);
464 * Copies a Firm subgraph that complies to the restrictions for
465 * constant expressions to block.
467 * @param dbg debug info for all newly created nodes
469 * @param to_block block to copy to
471 FIRM_API ir_node *copy_const_value(dbg_info *dbg, ir_node *n, ir_node *to_block);
473 FIRM_API ir_node *get_atomic_ent_value(ir_entity *ent);
474 FIRM_API void set_atomic_ent_value(ir_entity *ent, ir_node *val);
476 /** @defgroup ir_initializer Entity Initializers
480 /** the kind (type) of an initializer */
481 typedef enum ir_initializer_kind_t {
482 /** initializer containing an ir_node from the const-code irg */
483 IR_INITIALIZER_CONST,
484 /** initializer containing a tarval */
485 IR_INITIALIZER_TARVAL,
486 /** initializes type with default values (usually 0) */
488 /** list of initializers used to initializer a compound or array type */
489 IR_INITIALIZER_COMPOUND
490 } ir_initializer_kind_t;
492 /** returns kind of an initializer */
493 FIRM_API ir_initializer_kind_t get_initializer_kind(const ir_initializer_t *initializer);
495 /** Return the name of the initializer kind. */
496 FIRM_API const char *get_initializer_kind_name(ir_initializer_kind_t ini);
499 * returns the null initializer (there's only one instance of it in a program )
501 FIRM_API ir_initializer_t *get_initializer_null(void);
504 * creates an initializer containing a reference to a node on the const-code
507 FIRM_API ir_initializer_t *create_initializer_const(ir_node *value);
509 /** creates an initializer containing a single tarval value */
510 FIRM_API ir_initializer_t *create_initializer_tarval(ir_tarval *tv);
512 /** return value contained in a const initializer */
513 FIRM_API ir_node *get_initializer_const_value(const ir_initializer_t *initializer);
515 /** return value contained in a tarval initializer */
516 FIRM_API ir_tarval *get_initializer_tarval_value(const ir_initializer_t *initialzier);
518 /** creates a compound initializer which holds @p n_entries entries */
519 FIRM_API ir_initializer_t *create_initializer_compound(size_t n_entries);
521 /** returns the number of entries in a compound initializer */
522 FIRM_API size_t get_initializer_compound_n_entries(const ir_initializer_t *initializer);
524 /** sets entry with index @p index to the initializer @p value */
525 FIRM_API void set_initializer_compound_value(ir_initializer_t *initializer,
527 ir_initializer_t *value);
529 /** returns the value with index @p index of a compound initializer */
530 FIRM_API ir_initializer_t *get_initializer_compound_value(
531 const ir_initializer_t *initializer, size_t index);
535 /** Sets the new style initializers of an entity. */
536 FIRM_API void set_entity_initializer(ir_entity *entity, ir_initializer_t *initializer);
538 /** Returns true, if an entity has new style initializers. */
539 FIRM_API int has_entity_initializer(const ir_entity *entity);
541 /** Return the new style initializers of an entity. */
542 FIRM_API ir_initializer_t *get_entity_initializer(const ir_entity *entity);
544 FIRM_API void add_entity_overwrites(ir_entity *ent, ir_entity *overwritten);
545 FIRM_API size_t get_entity_n_overwrites(const ir_entity *ent);
546 FIRM_API size_t get_entity_overwrites_index(const ir_entity *ent, ir_entity *overwritten);
547 FIRM_API ir_entity *get_entity_overwrites(const ir_entity *ent, size_t pos);
548 FIRM_API void set_entity_overwrites(ir_entity *ent, size_t pos, ir_entity *overwritten);
549 FIRM_API void remove_entity_overwrites(ir_entity *ent, ir_entity *overwritten);
551 FIRM_API size_t get_entity_n_overwrittenby(const ir_entity *ent);
552 FIRM_API size_t get_entity_overwrittenby_index(const ir_entity *ent, ir_entity *overwrites);
553 FIRM_API ir_entity *get_entity_overwrittenby(const ir_entity *ent, size_t pos);
554 FIRM_API void set_entity_overwrittenby(ir_entity *ent, size_t pos, ir_entity *overwrites);
555 FIRM_API void remove_entity_overwrittenby(ir_entity *ent, ir_entity *overwrites);
558 * Checks whether a pointer points to an entity.
560 * @param thing an arbitrary pointer
563 * true if the thing is an entity, else false
565 FIRM_API int is_entity(const void *thing);
567 /** Returns true if the type of the entity is a primitive, pointer
568 * enumeration or method type.
570 * @note This is a different classification than from is_primitive_type().
572 FIRM_API int is_atomic_entity(const ir_entity *ent);
573 /** Returns true if the type of the entity is a class, structure,
574 array or union type. */
575 FIRM_API int is_compound_entity(const ir_entity *ent);
576 /** Returns true if the type of the entity is a Method type. */
577 FIRM_API int is_method_entity(const ir_entity *ent);
579 /** Outputs a unique number for this entity if libfirm is compiled for
580 * debugging, (configure with --enable-debug) else returns the address
581 * of the type cast to long.
583 FIRM_API long get_entity_nr(const ir_entity *ent);
585 /** Returns the entities visited count. */
586 FIRM_API ir_visited_t get_entity_visited(const ir_entity *ent);
588 /** Sets the entities visited count. */
589 FIRM_API void set_entity_visited(ir_entity *ent, ir_visited_t num);
591 /** Sets visited field in entity to entity_visited. */
592 FIRM_API void mark_entity_visited(ir_entity *ent);
594 /** Returns true if this entity was visited. */
595 FIRM_API int entity_visited(const ir_entity *ent);
597 /** Returns true if this entity was not visited. */
598 FIRM_API int entity_not_visited(const ir_entity *ent);
601 * Returns the mask of the additional entity properties.
602 * The properties are automatically inherited from the irg if available
603 * or from the method type if they were not set using
604 * set_entity_additional_properties() or
605 * set_entity_additional_property().
607 FIRM_API mtp_additional_properties get_entity_additional_properties(const ir_entity *ent);
609 /** Sets the mask of the additional graph properties. */
610 FIRM_API void set_entity_additional_properties(ir_entity *ent,
611 mtp_additional_properties prop);
613 /** Sets additional graph properties. */
614 FIRM_API void add_entity_additional_properties(ir_entity *ent,
615 mtp_additional_properties flag);
617 /** Returns the class type that this type info entity represents or NULL
618 if ent is no type info entity. */
619 FIRM_API ir_type *get_entity_repr_class(const ir_entity *ent);
622 * @page unknown_entity The Unknown entity
624 * This entity is an auxiliary entity dedicated to support analyses.
626 * The unknown entity represents that there could be an entity, but it is not
627 * known. This entity can be used to initialize fields before an analysis (not known
628 * yet) or to represent the top of a lattice (could not be determined). There exists
629 * exactly one entity unknown. This entity has as owner and as type the unknown type. It is
630 * allocated when initializing the entity module.
632 * The entity can take the role of any entity, also methods. It returns default
633 * values in these cases.
635 * The following values are set:
637 * - name = "unknown_entity"
638 * - ld_name = "unknown_entity"
639 * - owner = unknown_type
640 * - type = unknown_type
642 * - value = SymConst(unknown_entity)
645 * - volatility = volatility_non_volatile
646 * - stickyness = stickyness_unsticky
648 * - overwrites = NULL
649 * - overwrittenby = NULL
654 /** A variable that contains the only unknown entity. */
655 FIRM_API ir_entity *unknown_entity;
657 /** Returns the @link unknown_entity unknown entity @endlink. */
658 FIRM_API ir_entity *get_unknown_entity(void);
662 allocation_automatic,
663 allocation_parameter,
668 FIRM_API ir_allocation get_entity_allocation(const ir_entity *ent);
670 FIRM_API void set_entity_allocation(ir_entity *ent, ir_allocation al);
674 peculiarity_existent,
675 peculiarity_description,
676 peculiarity_inherited
679 FIRM_API ir_peculiarity get_entity_peculiarity(const ir_entity *ent);
681 FIRM_API void set_entity_peculiarity(ir_entity *ent, ir_peculiarity pec);
684 FIRM_API int is_entity_final(const ir_entity *ent);
686 FIRM_API void set_entity_final(ir_entity *ent, int final);
689 FIRM_API ir_peculiarity get_class_peculiarity(const ir_type *clss);
691 FIRM_API void set_class_peculiarity(ir_type *clss, ir_peculiarity pec);
695 /** Encodes how a pointer parameter is accessed. */
696 typedef enum ptr_access_kind {
697 ptr_access_none = 0, /**< no access */
698 ptr_access_read = 1, /**< read access */
699 ptr_access_write = 2, /**< write access */
700 ptr_access_rw = ptr_access_read|ptr_access_write, /**< read AND write access */
701 ptr_access_store = 4, /**< the pointer is stored */
702 ptr_access_all = ptr_access_rw|ptr_access_store /**< all possible access */
704 ENUM_BITSET(ptr_access_kind)
707 * @defgroup ir_type Type System
709 * Datastructure to hold type information.
711 * This module supplies a datastructure to represent all types
712 * known in the compiled program. This includes types specified
713 * in the program as well as types defined by the language. In the
714 * view of the intermediate representation there is no difference
715 * between these types. Finally it specifies some auxiliary types.
717 * There exist several kinds of types, arranged by the structure of
718 * the type. A type is described by a set of attributes. Some of
719 * these attributes are common to all types, others depend on the
722 * Types are different from the modes defined in irmode: Types are
723 * on the level of the programming language, modes at the level of
724 * the target processor.
730 * @defgroup tp_op Type Opcodes
731 * This module specifies the kinds of types available in firm.
733 * They are called type opcodes. These include classes, structs, methods, unions,
734 * arrays, enumerations, pointers and primitive types.
735 * Special types with own opcodes are the id type, a type representing an unknown
736 * type and a type used to specify that something has no type.
742 * An enum for the type kinds.
743 * For each type kind exists a typecode to identify it.
746 tpo_uninitialized = 0, /* not a type opcode */
747 tpo_class, /**< A class type. */
748 tpo_struct, /**< A struct type. */
749 tpo_method, /**< A method type. */
750 tpo_union, /**< An union type. */
751 tpo_array, /**< An array type. */
752 tpo_enumeration, /**< An enumeration type. */
753 tpo_pointer, /**< A pointer type. */
754 tpo_primitive, /**< A primitive type. */
755 tpo_code, /**< a piece of code (a basic block) */
756 tpo_none, /**< Special type for the None type. */
757 tpo_unknown, /**< Special code for the Unknown type. */
758 tpo_last = tpo_unknown /* not a type opcode */
762 * A structure containing information about a kind of type.
763 * A structure containing information about a kind of type. So far
764 * this is only the kind name, an enum for case-switching and some
767 * @see get_tpop_name(), get_tpop_code()
769 typedef struct tp_op tp_op;
773 * Returns the string for the type opcode.
775 * @param op The type opcode to get the string from.
778 FIRM_API const char *get_tpop_name(const tp_op *op);
781 * Returns an enum for the type opcode.
783 * @param op The type opcode to get the enum from.
786 FIRM_API tp_opcode get_tpop_code(const tp_op *op);
790 /** Returns true if low is subclass of high.
792 * Low is a subclass of high if low == high or if low is a subclass of
793 * a subclass of high. I.e, we search in all subtypes of high for low.
794 * @@@ this can be implemented more efficient if we know the set of all
795 * subclasses of high. */
796 FIRM_API int is_SubClass_of(ir_type *low, ir_type *high);
798 /** Subclass check for pointers to classes.
800 * Dereferences at both types the same amount of pointer types (as
801 * many as possible). If the remaining types are both class types
802 * and subclasses, returns true, else false. Can also be called with
803 * two class types. */
804 FIRM_API int is_SubClass_ptr_of(ir_type *low, ir_type *high);
806 /** Returns true if high is superclass of low.
808 * Low is a subclass of high if low == high or if low is a subclass of
809 * a subclass of high. I.e, we search in all subtypes of high for low.
810 * @@@ this can be implemented more efficient if we know the set of all
811 * subclasses of high. */
812 #define is_SuperClass_of(high, low) is_SubClass_of(low, high)
814 /** Superclass check for pointers to classes.
816 * Dereferences at both types the same amount of pointer types (as
817 * many as possible). If the remaining types are both class types
818 * and superclasses, returns true, else false. Can also be called with
819 * two class types. */
820 #define is_SuperClass_ptr_of(low, high) is_SubClass_ptr_of(high, low)
822 /** Returns true if high is (transitive) overwritten by low.
824 * Returns false if high == low. */
825 FIRM_API int is_overwritten_by(ir_entity *high, ir_entity *low);
827 /** Resolve polymorphism in the inheritance relation.
829 * Returns the dynamically referenced entity if the static entity and the
830 * dynamic type are given.
831 * Searches downwards in overwritten tree. */
832 FIRM_API ir_entity *resolve_ent_polymorphy(ir_type *dynamic_class,
833 ir_entity* static_ent);
835 /** Default name mangling for inherited entities.
837 * Returns an ident that consists of the name of type followed by an
838 * underscore and the name (not ld_name) of the entity. */
839 FIRM_API ident *default_mangle_inherited_name(const ir_entity *ent,
840 const ir_type *clss);
842 /** Type of argument functions for inheritance resolver.
844 * @param ent The entity in the super type that will be overwritten
845 * by the newly generated entity, for which this name is
847 * @param clss The class type in which the new entity will be placed.
849 typedef ident *mangle_inherited_name_func(const ir_entity *ent,
850 const ir_type *clss);
852 /** Resolve implicit inheritance.
854 * Resolves the implicit inheritance supplied by firm. Firm defines,
855 * that each entity that is not overwritten in a subclass is
856 * inherited to this subclass without change implicitly. This
857 * function generates entities that explicitly represent this
858 * inheritance. It generates for each entity overwriting entities in
859 * all subclasses of the owner of the entity, if the entity is not
860 * overwritten in that subclass.
862 * The name of the new entity is generated with the function passed.
863 * If the function is NULL, the default_mangle_inherited_name() is
866 FIRM_API void resolve_inheritance(mangle_inherited_name_func *mfunc);
869 /* ----------------------------------------------------------------------- */
870 /* The transitive closure of the subclass/superclass and */
871 /* overwrites/overwrittenby relation. */
873 /* A walk over the ir (O(#types+#entities)) computes the transitive */
874 /* closure. Adding a new type/entity or changing the basic relations in */
875 /* some other way invalidates the transitive closure, i.e., it is not */
876 /* updated by the basic functions. */
878 /* The transitive edges are held in a set, not in an array as the */
879 /* underlying relation. */
881 /* Do the sets contain the node itself? I assume NOT! */
882 /* ----------------------------------------------------------------------- */
885 * The state of the transitive closure.
888 inh_transitive_closure_none, /**< Closure is not computed, can not be accessed. */
889 inh_transitive_closure_valid, /**< Closure computed and valid. */
890 inh_transitive_closure_invalid, /**< Closure invalid, but can be accessed. */
891 inh_transitive_closure_max /**< Invalid value. */
892 } inh_transitive_closure_state;
894 FIRM_API void set_irp_inh_transitive_closure_state(inh_transitive_closure_state s);
895 FIRM_API void invalidate_irp_inh_transitive_closure_state(void);
896 FIRM_API inh_transitive_closure_state get_irp_inh_transitive_closure_state(void);
899 /** Compute transitive closure of the subclass/superclass and
900 * overwrites/overwrittenby relation.
902 * This function walks over the ir (O(\#types+\#entities)) to compute the
903 * transitive closure. */
904 FIRM_API void compute_inh_transitive_closure(void);
906 /** Free memory occupied by the transitive closure information. */
907 FIRM_API void free_inh_transitive_closure(void);
909 /** Iterate over all transitive subtypes. */
910 FIRM_API ir_type *get_class_trans_subtype_first(const ir_type *tp);
911 FIRM_API ir_type *get_class_trans_subtype_next(const ir_type *tp);
912 FIRM_API int is_class_trans_subtype(const ir_type *tp, const ir_type *subtp);
914 /** Iterate over all transitive supertypes. */
915 FIRM_API ir_type *get_class_trans_supertype_first(const ir_type *tp);
916 FIRM_API ir_type *get_class_trans_supertype_next(const ir_type *tp);
918 /** Iterate over all entities that transitive overwrite this entities. */
919 FIRM_API ir_entity *get_entity_trans_overwrittenby_first(const ir_entity *ent);
920 FIRM_API ir_entity *get_entity_trans_overwrittenby_next(const ir_entity *ent);
922 /** Iterate over all transitive overwritten entities. */
923 FIRM_API ir_entity *get_entity_trans_overwrites_first(const ir_entity *ent);
924 FIRM_API ir_entity *get_entity_trans_overwrites_next(const ir_entity *ent);
927 /** The state of Cast operations that cast class types or pointers to class
930 * The state expresses, how far Cast operations conform with the class
934 * class B1 extends A {}
935 * class B2 extends A {}
936 * class C extends B1 {}
937 * normalized: Cast operations conform with the inheritance relation.
938 * I.e., the type of the operand of a Cast is either a super= or a sub-
939 * type of the type casted to. Example: (A)((B2) (new C())).
940 * transitive: Cast operations conform with the transitive inheritance
941 * relation. Example: (A)(new C()).
942 * any: Cast operations do not conform with the transitive inheritance
943 * relation. Example: (B2)(new B1())
945 * Flags for class cast state.
947 * The state in irp is always smaller or equal to the state of any
950 * We rely on the ordering of the enum. */
952 ir_class_casts_any = 0, /**< There are class casts that do not cast in conformance with
953 the class hierarchy. @@@ So far this does not happen in Firm. */
954 ir_class_casts_transitive = 1, /**< Class casts conform to transitive inheritance edges. Default. */
955 ir_class_casts_normalized = 2, /**< Class casts conform to inheritance edges. */
956 ir_class_casts_state_max
957 } ir_class_cast_state;
959 FIRM_API void set_irg_class_cast_state(ir_graph *irg,
960 ir_class_cast_state s);
961 FIRM_API ir_class_cast_state get_irg_class_cast_state(const ir_graph *irg);
962 FIRM_API void set_irp_class_cast_state(ir_class_cast_state s);
963 FIRM_API ir_class_cast_state get_irp_class_cast_state(void);
966 * possible trverify() error codes
968 enum trverify_error_codes {
969 no_error = 0, /**< no error */
970 error_ent_not_cont, /**< overwritten entity not in superclass */
971 error_null_mem, /**< compound contains NULL member */
972 error_const_on_wrong_irg, /**< constant placed on wrong IRG */
973 error_existent_entity_without_irg, /**< Method entities with pecularity_exist must have an irg */
974 error_wrong_ent_overwrites, /**< number of entity overwrites exceeds number of class overwrites */
975 error_inherited_ent_without_const, /**< inherited method entity not pointing to existent entity */
976 error_glob_ent_allocation, /**< wrong allocation of a global entity */
977 error_ent_const_mode, /**< Mode of constant in entity did not match entities type. */
978 error_ent_wrong_owner /**< Mode of constant in entity did not match entities type. */
985 * 0 if no error encountered
987 FIRM_API int check_type(ir_type *tp);
990 * Walks the type information and performs a set of sanity checks.
992 * Currently, the following checks are executed:
993 * - values of initialized entities must be allocated on the constant IRG
994 * - class types: doesn't have NULL members
995 * - class types: all overwrites are existent in the super type
998 * 0 if graph is correct
1001 FIRM_API int tr_verify(void);
1003 /** Frees all entities associated with a type.
1004 * Does not free the array entity.
1005 * Warning: ensure these entities are not referenced anywhere else.
1007 FIRM_API void free_type_entities(ir_type *tp);
1009 /** Frees the memory used by the type.
1011 * Removes the type from the type list. Does not free the entities
1012 * belonging to the type, except for the array element entity. Does
1013 * not free if tp is "none" or "unknown". Frees entities in value
1014 * param subtypes of method types!!! Make sure these are not
1015 * referenced any more. Further make sure there is no pointer type
1016 * that refers to this type.
1018 FIRM_API void free_type(ir_type *tp);
1020 FIRM_API const tp_op *get_type_tpop(const ir_type *tp);
1021 FIRM_API ident *get_type_tpop_nameid(const ir_type *tp);
1022 FIRM_API const char *get_type_tpop_name(const ir_type *tp);
1023 FIRM_API tp_opcode get_type_tpop_code(const ir_type *tp);
1026 * construct a string representing the type.
1027 * This uses the info retrieved by the type_dbg_info if available.
1028 * Otherwise it tries to create an approximate textual representation of the
1030 * Keep in mind that this representation is not unique for each type,
1031 * might abstract away some details. The main intention of this is creating
1032 * human redable strings giving an idea of the type.
1034 FIRM_API void ir_print_type(char *buffer, size_t buffer_size,
1037 /** The state of the type layout. */
1039 layout_undefined, /**< The layout of this type is not defined.
1040 Address computation to access fields is not
1041 possible, fields must be accessed by Sel
1042 nodes. Enumeration constants might be undefined.
1043 This is the default value except for
1044 pointer, primitive and method types. */
1045 layout_fixed /**< The layout is fixed, all component/member entities
1046 have an offset assigned. Size of the type is known.
1047 Arrays can be accessed by explicit address
1048 computation. Enumeration constants must be defined.
1049 Default for pointer, primitive and method types. */
1052 /** Returns a human readable string for the enum entry. */
1053 FIRM_API const char *get_type_state_name(ir_type_state s);
1055 /** Returns the type layout state of a type. */
1056 FIRM_API ir_type_state get_type_state(const ir_type *tp);
1058 /** Sets the type layout state of a type.
1060 * For primitives, pointer and method types the layout is always fixed.
1061 * This call is legal but has no effect.
1063 FIRM_API void set_type_state(ir_type *tp, ir_type_state state);
1065 /** Returns the mode of a type.
1067 * Returns NULL for all non atomic types.
1069 FIRM_API ir_mode *get_type_mode(const ir_type *tp);
1071 /** Sets the mode of a type.
1073 * Only has an effect on primitive, enumeration and pointer types.
1075 FIRM_API void set_type_mode(ir_type *tp, ir_mode* m);
1077 /** Returns the size of a type in bytes. */
1078 FIRM_API unsigned get_type_size_bytes(const ir_type *tp);
1080 /** Sets the size of a type in bytes.
1082 * For primitive, enumeration, pointer and method types the size
1083 * is always fixed. This call is legal but has no effect.
1085 FIRM_API void set_type_size_bytes(ir_type *tp, unsigned size);
1087 /** Returns the alignment of a type in bytes. */
1088 FIRM_API unsigned get_type_alignment_bytes(ir_type *tp);
1090 /** Returns the alignment of a type in bits.
1092 * If the alignment of a type is
1093 * not set, it is calculated here according to the following rules:
1094 * -#.) if a type has a mode, the alignment is the mode size.
1095 * -#.) compound types have the alignment of there biggest member.
1096 * -#.) array types have the alignment of there element type.
1097 * -#.) method types return 0 here.
1098 * -#.) all other types return 1 here (i.e. aligned at byte).
1100 FIRM_API void set_type_alignment_bytes(ir_type *tp, unsigned align);
1102 /** Returns the visited count of a type. */
1103 FIRM_API ir_visited_t get_type_visited(const ir_type *tp);
1104 /** Sets the visited count of a type to num. */
1105 FIRM_API void set_type_visited(ir_type *tp, ir_visited_t num);
1106 /** Sets visited field in type to type_visited. */
1107 FIRM_API void mark_type_visited(ir_type *tp);
1108 /** Returns non-zero if the type is already visited */
1109 FIRM_API int type_visited(const ir_type *tp);
1110 /** Returns non-zero if the type is not yet visited */
1111 FIRM_API int type_not_visited(const ir_type *tp);
1113 /** Returns the associated link field of a type. */
1114 FIRM_API void *get_type_link(const ir_type *tp);
1115 /** Sets the associated link field of a type. */
1116 FIRM_API void set_type_link(ir_type *tp, void *l);
1119 * Visited flag to traverse the type information.
1121 * Increase this flag by one before traversing the type information
1122 * using inc_master_type_visited().
1123 * Mark type nodes as visited by mark_type_visited(ir_type).
1124 * Check whether node was already visited by type_visited(ir_type)
1125 * and type_not_visited(ir_type).
1126 * Or use the function to walk all types.
1130 FIRM_API void set_master_type_visited(ir_visited_t val);
1131 FIRM_API ir_visited_t get_master_type_visited(void);
1132 FIRM_API void inc_master_type_visited(void);
1135 * Sets the debug information of a type.
1137 * @param tp The type.
1138 * @param db The debug info.
1140 FIRM_API void set_type_dbg_info(ir_type *tp, type_dbg_info *db);
1143 * Returns the debug information of a type.
1145 * @param tp The type.
1147 FIRM_API type_dbg_info *get_type_dbg_info(const ir_type *tp);
1150 * Checks whether a pointer points to a type.
1152 * @param thing an arbitrary pointer
1155 * true if the thing is a type, else false
1157 FIRM_API int is_type(const void *thing);
1160 * Outputs a unique number for this type if libfirm is compiled for
1161 * debugging, (configure with --enable-debug) else returns the address
1162 * of the type cast to long.
1164 FIRM_API long get_type_nr(const ir_type *tp);
1167 * Checks whether two types are structurally equal.
1169 * @param typ1 the first type
1170 * @param typ2 the second type
1173 * true if the types are equal, else false.
1175 * Types are equal if :
1176 * - they are the same type kind
1177 * - they have the same name
1178 * - they have the same mode (if applicable)
1179 * - they have the same type_state and, ev., the same size
1180 * - they are class types and have:
1181 * - the same members (see same_entity in entity.h)
1182 * - the same supertypes -- the C-pointers are compared --> no recursive call.
1183 * - the same number of subtypes. Subtypes are not compared,
1184 * as this could cause a cyclic test.
1185 * - they are structure types and have the same members
1186 * - they are method types and have
1187 * - the same parameter types
1188 * - the same result types
1189 * - they are union types and have the same members
1190 * - they are array types and have
1191 * - the same number of dimensions
1192 * - the same dimension bounds
1193 * - the same dimension order
1194 * - the same element type
1195 * - they are enumeration types and have the same enumerator names
1196 * - they are pointer types and have the identical points_to type
1197 * (i.e., the same C-struct to represent the type.
1198 * This is to avoid endless recursions; with pointer types cyclic
1199 * type graphs are possible.)
1201 FIRM_API int equal_type(ir_type *typ1, ir_type *typ2);
1204 * Checks whether two types are structural comparable.
1206 * @param st pointer type
1207 * @param lt pointer type
1210 * true if type st is smaller than type lt, i.e. whenever
1211 * lt is expected a st can be used.
1213 * - they are the same type kind
1214 * - mode(st) < mode (lt) (if applicable)
1215 * - they are class types and st is (transitive) subtype of lt,
1216 * - they are structure types and
1217 * - the members of st have exactly one counterpart in lt with the same name,
1218 * - the counterpart has a bigger type.
1219 * - they are method types and have
1220 * - the same number of parameter and result types,
1221 * - the parameter types of st are smaller than those of lt,
1222 * - the result types of st are smaller than those of lt
1223 * - they are union types and have the members of st have exactly one
1224 * @return counterpart in lt and the type is smaller
1225 * - they are array types and have
1226 * - the same number of dimensions
1227 * - all bounds of lt are bound of st
1228 * - the same dimension order
1229 * - the same element type
1231 * - the element type of st is smaller than that of lt
1232 * - the element types have the same size and fixed layout.
1233 * - they are enumeration types and have the same enumerator names
1234 * - they are pointer types and have the points_to type of st is
1235 * @return smaller than the points_to type of lt.
1238 FIRM_API int smaller_type(ir_type *st, ir_type *lt);
1241 * @ingroup compound_type
1242 * @defgroup class_type Class
1244 * If the type opcode is set to type_class the type represents class
1245 * types. A list of fields and methods is associated with a class.
1246 * Further a class can inherit from and bequest to other classes.
1248 * The following attributes are private to this type kind:
1249 * - member: All entities belonging to this class. This are method entities
1250 * which have type_method or fields that can have any of the
1251 * following type kinds: type_class, type_struct, type_union,
1252 * type_array, type_enumeration, type_pointer, type_primitive.
1254 * The following two are dynamic lists that can be grown with an "add_" function,
1257 * - subtypes: A list of direct subclasses.
1259 * - supertypes: A list of direct superclasses.
1261 * - type_info: An entity representing the type information of this class.
1262 * This entity can be of arbitrari type, Firm did not use it yet.
1263 * It allows to express the coupling of a type with an entity
1264 * representing this type. This information is useful for lowering
1265 * of InstOf and TypeChk nodes. Default: NULL
1267 * - vtable_size: The size of this class virtual function table.
1270 * - final: A final class is always a leaf in the class hierarchy. Final
1271 * classes cannot be super classes of other ones. As this information
1272 * can only be computed in whole world compilations, we allow to
1273 * set this flag. It is used in optimizations if get_opt_closed_world()
1274 * is false. Default: false
1276 * - interface: The class represents an interface. This flag can be set to distinguish
1277 * between interfaces, abstract classes and other classes that all may
1278 * have the peculiarity peculiarity_description. Depending on this flag
1279 * the lowering might do different actions. Default: false
1281 * - abstract : The class represents an abstract class. This flag can be set to distinguish
1282 * between interfaces, abstract classes and other classes that all may
1283 * have the peculiarity peculiarity_description. Depending on this flag
1284 * the lowering might do different actions. Default: false
1288 /** Creates a new class type. */
1289 FIRM_API ir_type *new_type_class(ident *name);
1291 /** Creates a new class type with debug information. */
1292 FIRM_API ir_type *new_d_type_class(ident *name, type_dbg_info *db);
1294 /** return identifier of the class type */
1295 FIRM_API ident *get_class_ident(const ir_type *clss);
1297 /** return identifier of the class type */
1298 FIRM_API const char *get_class_name(const ir_type *clss);
1300 /** Returns the number of members of this class. */
1301 FIRM_API size_t get_class_n_members(const ir_type *clss);
1303 /** Returns the member at position pos, 0 <= pos < n_member */
1304 FIRM_API ir_entity *get_class_member(const ir_type *clss, size_t pos);
1306 #define INVALID_MEMBER_INDEX ((size_t)-1)
1308 /** Returns index of mem in clss, INVALID_MEMBER_INDEX if not contained. */
1309 FIRM_API size_t get_class_member_index(const ir_type *clss, ir_entity *mem);
1311 /** Finds the member with name 'name'. If several members with the same
1312 * name returns one of them. Returns NULL if no member found. */
1313 FIRM_API ir_entity *get_class_member_by_name(ir_type *clss, ident *name);
1315 /** Adds subtype as subtype to clss.
1317 * Checks whether clss is a supertype of subtype. If not
1318 * adds also clss as supertype to subtype. */
1319 FIRM_API void add_class_subtype(ir_type *clss, ir_type *subtype);
1321 /** Returns the number of subtypes */
1322 FIRM_API size_t get_class_n_subtypes(const ir_type *clss);
1324 /** Gets the subtype at position pos, 0 <= pos < n_subtype. */
1325 FIRM_API ir_type *get_class_subtype(ir_type *clss, size_t pos);
1327 /** Returns the index to access subclass as subtype of class.
1329 * If subclass is no direct subtype of class returns -1.
1331 FIRM_API size_t get_class_subtype_index(ir_type *clss, const ir_type *subclass);
1333 /** Sets the subtype at position pos, 0 <= pos < n_subtype.
1335 * Does not set the corresponding supertype relation for subtype: this might
1336 * be a different position! */
1337 FIRM_API void set_class_subtype(ir_type *clss, ir_type *subtype, size_t pos);
1339 /** Finds subtype in the list of subtypes and removes it */
1340 FIRM_API void remove_class_subtype(ir_type *clss, ir_type *subtype);
1342 /** Adds supertype as supertype to class.
1344 * Checks whether clss is a subtype of supertype. If not
1345 * adds also clss as subtype to supertype. */
1346 FIRM_API void add_class_supertype(ir_type *clss, ir_type *supertype);
1348 /** Returns the number of supertypes */
1349 FIRM_API size_t get_class_n_supertypes(const ir_type *clss);
1351 /** Returns the index to access superclass as supertype of class.
1353 * If superclass is no direct supertype of class returns -1.
1355 FIRM_API size_t get_class_supertype_index(ir_type *clss, ir_type *super_clss);
1357 /** Gets the supertype at position pos, 0 <= pos < n_supertype. */
1358 FIRM_API ir_type *get_class_supertype(ir_type *clss, size_t pos);
1360 /** Sets the supertype at position pos, 0 <= pos < n_supertype.
1362 * Does not set the corresponding subtype relation for supertype: this might
1363 * be at a different position! */
1364 FIRM_API void set_class_supertype(ir_type *clss, ir_type *supertype, size_t pos);
1366 /** Finds supertype in the list of supertypes and removes it */
1367 FIRM_API void remove_class_supertype(ir_type *clss, ir_type *supertype);
1369 /** Returns the type info entity of a class. */
1370 FIRM_API ir_entity *get_class_type_info(const ir_type *clss);
1372 /** Set a type info entity for the class. */
1373 FIRM_API void set_class_type_info(ir_type *clss, ir_entity *ent);
1375 /** Returns the size of the virtual function table. */
1376 FIRM_API unsigned get_class_vtable_size(const ir_type *clss);
1378 /** Sets a new size of the virtual function table. */
1379 FIRM_API void set_class_vtable_size(ir_type *clss, unsigned size);
1381 /** Returns non-zero if a class is final. */
1382 FIRM_API int is_class_final(const ir_type *clss);
1384 /** Sets the class final flag. */
1385 FIRM_API void set_class_final(ir_type *clss, int flag);
1387 /** Return non-zero if a class is an interface */
1388 FIRM_API int is_class_interface(const ir_type *clss);
1390 /** Sets the class interface flag. */
1391 FIRM_API void set_class_interface(ir_type *clss, int flag);
1393 /** Return non-zero if a class is an abstract class. */
1394 FIRM_API int is_class_abstract(const ir_type *clss);
1396 /** Sets the class abstract flag. */
1397 FIRM_API void set_class_abstract(ir_type *clss, int flag);
1399 /** Returns true if a type is a class type. */
1400 FIRM_API int is_Class_type(const ir_type *clss);
1403 * This type opcode marks that the corresponding type is a class type.
1405 * Consequently the type refers to supertypes, subtypes and entities.
1406 * Entities can be any fields, but also methods.
1407 * This struct is dynamically allocated but constant for the lifetime
1410 FIRM_API const tp_op *type_class;
1411 FIRM_API const tp_op *get_tpop_class(void);
1415 /** @ingroup compound_type
1416 * @defgroup struct_type Struct
1418 * A struct type represents aggregate types that consist of a list
1421 * The following attributes are private to this type kind:
1422 * - member: All entities belonging to this class. This are the fields
1423 * that can have any of the following types: type_class,
1424 * type_struct, type_union, type_array, type_enumeration,
1425 * type_pointer, type_primitive.
1426 * This is a dynamic list that can be grown with an "add_" function,
1428 * This is a dynamic list that can be grown with an "add_" function,
1433 /** Creates a new type struct */
1434 FIRM_API ir_type *new_type_struct(ident *name);
1435 /** Creates a new type struct with debug information. */
1436 FIRM_API ir_type *new_d_type_struct(ident *name, type_dbg_info* db);
1438 /** return struct identifier */
1439 FIRM_API ident *get_struct_ident(const ir_type *strct);
1441 /** return struct identifier as c-string*/
1442 FIRM_API const char *get_struct_name(const ir_type *strct);
1444 /** Returns the number of members of this struct. */
1445 FIRM_API size_t get_struct_n_members(const ir_type *strct);
1447 /** Returns the member at position pos, pos < n_member */
1448 FIRM_API ir_entity *get_struct_member(const ir_type *strct, size_t pos);
1450 /** Returns index of member in strct, -1 if not contained. */
1451 FIRM_API size_t get_struct_member_index(const ir_type *strct, ir_entity *member);
1453 /** Returns true if a type is a struct type. */
1454 FIRM_API int is_Struct_type(const ir_type *strct);
1457 * This type opcode marks that the corresponding type is a compound type
1460 * Consequently the type refers to a list of entities
1461 * which may not be methods (but pointers to methods).
1462 * This struct is dynamically allocated but constant for the lifetime
1465 FIRM_API const tp_op *type_struct;
1466 FIRM_API const tp_op *get_tpop_struct(void);
1471 * @ingroup compound_type
1472 * @defgroup union_type Union
1474 * The union type represents union types. Note that this representation
1475 * resembles the C union type. For tagged variant types like in Pascal or
1476 * Modula a combination of a struct and a union type must be used.
1478 * - n_types: Number of unioned types.
1479 * - members: Entities for unioned types. Fixed length array.
1480 * This is a dynamic list that can be grown with an "add_"
1481 * function, but not shrinked.
1484 /** Creates a new type union. */
1485 FIRM_API ir_type *new_type_union(ident *name);
1487 /** Creates a new type union with debug information. */
1488 FIRM_API ir_type *new_d_type_union(ident *name, type_dbg_info* db);
1491 /** return union identifier */
1492 FIRM_API ident *get_union_ident(const ir_type *uni);
1494 /** return union identifier as c-string */
1495 FIRM_API const char *get_union_name(const ir_type *uni);
1497 /** Returns the number of unioned types of this union */
1498 FIRM_API size_t get_union_n_members(const ir_type *uni);
1500 /** Returns the entity at position pos of a union */
1501 FIRM_API ir_entity *get_union_member(const ir_type *uni, size_t pos);
1503 /** Returns index of member in uni, -1 if not contained. */
1504 FIRM_API size_t get_union_member_index(const ir_type *uni, ir_entity *member);
1506 /** Returns true if a type is a union type. */
1507 FIRM_API int is_Union_type(const ir_type *uni);
1510 * This type opcode marks that the corresponding type is a union type.
1512 * Consequently it refers to a list of unioned types.
1513 * This struct is dynamically allocated but constant for the lifetime
1516 FIRM_API const tp_op *type_union;
1517 FIRM_API const tp_op *get_tpop_union(void);
1522 * @defgroup method_type Method
1524 * A method type represents a method, function or procedure type.
1525 * It contains a list of the parameter and result types, as these
1526 * are part of the type description. These lists should not
1527 * be changed by a optimization, as a change creates a new method
1528 * type. Therefore optimizations should allocated new method types.
1529 * The set_ routines are only for construction by a frontend.
1531 * - n_params: Number of parameters to the procedure.
1532 * A procedure in FIRM has only call by value parameters.
1534 * - param_type: A list with the types of parameters. This list is ordered.
1535 * The nth type in this list corresponds to the nth element
1536 * in the parameter tuple that is a result of the start node.
1537 * (See ircons.h for more information.)
1539 * - value_param_ents
1540 * A list of entities (whose owner is a struct private to the
1541 * method type) that represent parameters passed by value.
1543 * - n_res: The number of results of the method. In general, procedures
1544 * have zero results, functions one.
1546 * - res_type: A list with the types of parameters. This list is ordered.
1547 * The nth type in this list corresponds to the nth input to
1548 * Return nodes. (See ircons.h for more information.)
1552 /** Create a new method type.
1554 * @param n_param the number of parameters
1555 * @param n_res the number of results
1557 * The arrays for the parameter and result types are not initialized by
1560 FIRM_API ir_type *new_type_method(size_t n_param, size_t n_res);
1562 /** Create a new method type with debug information.
1564 * @param n_param the number of parameters
1565 * @param n_res the number of results
1566 * @param db user defined debug information
1568 * The arrays for the parameter and result types are not initialized by
1571 FIRM_API ir_type *new_d_type_method(size_t n_param, size_t n_res,
1574 /** Returns the number of parameters of this method. */
1575 FIRM_API size_t get_method_n_params(const ir_type *method);
1577 /** Returns the type of the parameter at position pos of a method. */
1578 FIRM_API ir_type *get_method_param_type(const ir_type *method, size_t pos);
1579 /** Sets the type of the parameter at position pos of a method.
1580 * Note: does not change the corresponding parameter entities (if there are any)
1582 FIRM_API void set_method_param_type(ir_type *method, size_t pos, ir_type *tp);
1583 /** Returns the number of results of a method type. */
1584 FIRM_API size_t get_method_n_ress(const ir_type *method);
1585 /** Returns the return type of a method type at position pos. */
1586 FIRM_API ir_type *get_method_res_type(const ir_type *method, size_t pos);
1587 /** Sets the type of the result at position pos of a method. */
1588 FIRM_API void set_method_res_type(ir_type *method, size_t pos, ir_type *tp);
1591 * This enum flags the variadicity of methods (methods with a
1592 * variable amount of arguments (e.g. C's printf). Default is
1595 typedef enum ir_variadicity {
1596 variadicity_non_variadic, /**< non variadic */
1597 variadicity_variadic /**< variadic */
1600 /** Returns the null-terminated name of this variadicity. */
1601 FIRM_API const char *get_variadicity_name(ir_variadicity vari);
1603 /** Returns the variadicity of a method. */
1604 FIRM_API ir_variadicity get_method_variadicity(const ir_type *method);
1606 /** Sets the variadicity of a method. */
1607 FIRM_API void set_method_variadicity(ir_type *method, ir_variadicity vari);
1609 /** Returns the mask of the additional graph properties. */
1610 FIRM_API mtp_additional_properties get_method_additional_properties(const ir_type *method);
1612 /** Sets the mask of the additional graph properties. */
1613 FIRM_API void set_method_additional_properties(ir_type *method,
1614 mtp_additional_properties property_mask);
1616 /** Sets one additional graph property. */
1617 FIRM_API void add_method_additional_properties(ir_type *method,
1618 mtp_additional_properties flag);
1621 * Calling conventions: lower 24 bits are the number of register parameters,
1622 * upper 8 encode the calling conventions.
1625 cc_reg_param = 0x01000000, /**< Transmit parameters in registers, else the stack is used.
1626 This flag may be set as default on some architectures. */
1627 cc_last_on_top = 0x02000000, /**< The last non-register parameter is transmitted on top of
1628 the stack. This is equivalent to the pascal
1629 calling convention. If this flag is not set, the first
1630 non-register parameter is used (stdcall or cdecl
1631 calling convention) */
1632 cc_callee_clear_stk = 0x04000000, /**< The callee clears the stack. This forbids variadic
1633 function calls (stdcall). */
1634 cc_this_call = 0x08000000, /**< The first parameter is a this pointer and is transmitted
1635 in a special way. */
1636 cc_compound_ret = 0x10000000, /**< The method returns a compound type. */
1637 cc_frame_on_caller_stk = 0x20000000, /**< The method did not allocate an own stack frame, instead the
1638 caller must reserve size on its own stack. */
1639 cc_fpreg_param = 0x40000000, /**< Transmit floating point parameters in registers, else the stack is used. */
1640 cc_bits = (0xFF << 24)/**< The calling convention bits. */
1641 } calling_convention;
1643 /** cdecl calling convention */
1644 #define cc_cdecl_set (0)
1645 /** stdcall calling convention */
1646 #define cc_stdcall_set cc_callee_clear_stk
1647 /** fastcall calling convention */
1648 #define cc_fastcall_set (cc_reg_param|cc_callee_clear_stk)
1651 * check for the CDECL calling convention
1653 #define IS_CDECL(cc_mask) (((cc_mask) & cc_bits) == cc_cdecl_set)
1656 * check for the STDCALL calling convention
1658 #define IS_STDCALL(cc_mask) (((cc_mask) & cc_bits) == cc_stdcall_set)
1661 * check for the FASTCALL calling convention
1663 #define IS_FASTCALL(cc_mask) (((cc_mask) & cc_bits) == cc_fastcall_set)
1666 * Sets the CDECL convention bits.
1668 #define SET_CDECL(cc_mask) (((cc_mask) & ~cc_bits) | cc_cdecl_set)
1671 * Set. the STDCALL convention bits.
1673 #define SET_STDCALL(cc_mask) (((cc_mask) & ~cc_bits) | cc_stdcall_set)
1676 * Sets the FASTCALL convention bits.
1678 #define SET_FASTCALL(cc_mask) (((cc_mask) & ~cc_bits) | cc_fastcall_set)
1680 /** Returns the calling convention of an entities graph. */
1681 FIRM_API unsigned get_method_calling_convention(const ir_type *method);
1683 /** Sets the calling convention of an entities graph. */
1684 FIRM_API void set_method_calling_convention(ir_type *method, unsigned cc_mask);
1686 /** Returns the number of registers parameters, 0 means default. */
1687 FIRM_API unsigned get_method_n_regparams(ir_type *method);
1689 /** Sets the number of registers parameters, 0 means default. */
1690 FIRM_API void set_method_n_regparams(ir_type *method, unsigned n_regs);
1692 /** Returns true if a type is a method type. */
1693 FIRM_API int is_Method_type(const ir_type *method);
1696 * This type opcode marks that the corresponding type is a method type.
1698 * Consequently it refers to a list of arguments and results.
1699 * This struct is dynamically allocated but constant for the lifetime
1702 FIRM_API const tp_op *type_method;
1703 FIRM_API const tp_op *get_tpop_method(void);
1708 * @defgroup array_type Array
1710 * The array type represents rectangular multi dimensional arrays.
1711 * The constants representing the bounds must be allocated to
1712 * get_const_code_irg() by setting current_ir_graph accordingly.
1714 * - n_dimensions: Number of array dimensions.
1715 * - *lower_bound: Lower bounds of dimensions. Usually all 0.
1716 * - *upper_bound: Upper bounds or dimensions.
1717 * - *element_type: The type of the array elements.
1718 * - *element_ent: An entity for the array elements to be used for
1719 * element selection with Sel.
1723 /** Create a new type array.
1725 * Sets n_dimension to dimension and all dimension entries to NULL.
1726 * Initializes order to the order of the dimensions.
1727 * The entity for array elements is built automatically.
1728 * Set dimension sizes after call to constructor with set_* routines.
1730 FIRM_API ir_type *new_type_array(size_t n_dims, ir_type *element_type);
1732 /** Create a new type array with debug information.
1734 * Sets n_dimension to dimension and all dimension entries to NULL.
1735 * Initializes order to the order of the dimensions.
1736 * The entity for array elements is built automatically.
1737 * Set dimension sizes after call to constructor with set_* routines.
1738 * A legal array type must have at least one dimension set.
1740 FIRM_API ir_type *new_d_type_array(size_t n_dims, ir_type *element_type,
1744 /** Returns the number of array dimensions of this type. */
1745 FIRM_API size_t get_array_n_dimensions(const ir_type *array);
1748 * Allocates Const nodes of mode_Is for one array dimension.
1749 * Upper bound in Firm is the element next to the last, i.e. [lower,upper[
1751 FIRM_API void set_array_bounds_int(ir_type *array, size_t dimension,
1752 int lower_bound, int upper_bound);
1754 * Sets the bounds for one array dimension.
1755 * Upper bound in Firm is the element next to the last, i.e. [lower,upper[
1757 FIRM_API void set_array_bounds(ir_type *array, size_t dimension,
1758 ir_node *lower_bound, ir_node *upper_bound);
1759 /** Sets the lower bound for one array dimension, i.e. [lower,upper[ */
1760 FIRM_API void set_array_lower_bound(ir_type *array, size_t dimension,
1761 ir_node *lower_bound);
1763 /** Allocates Const nodes of mode_Is for the lower bound of an array
1764 dimension, i.e. [lower,upper[ */
1765 FIRM_API void set_array_lower_bound_int(ir_type *array, size_t dimension,
1768 /** Sets the upper bound for one array dimension, i.e. [lower,upper[ */
1769 FIRM_API void set_array_upper_bound(ir_type *array, size_t dimension,
1770 ir_node *upper_bound);
1772 /** Allocates Const nodes of mode_Is for the upper bound of an array
1773 dimension, i.e. [lower,upper[. */
1774 FIRM_API void set_array_upper_bound_int(ir_type *array, size_t dimension,
1777 /** Returns true if lower bound != Unknown. */
1778 FIRM_API int has_array_lower_bound(const ir_type *array, size_t dimension);
1779 /** Returns the lower bound of an array. */
1780 FIRM_API ir_node *get_array_lower_bound(const ir_type *array, size_t dimension);
1781 /** Works only if bound is Const node with tarval that can be converted to long. */
1782 FIRM_API long get_array_lower_bound_int(const ir_type *array, size_t dimension);
1783 /** returns true if lower bound != Unknown */
1784 FIRM_API int has_array_upper_bound(const ir_type *array, size_t dimension);
1785 /** Returns the upper bound of an array. */
1786 FIRM_API ir_node *get_array_upper_bound(const ir_type *array, size_t dimension);
1787 /** Works only if bound is Const node with tarval that can be converted to long. */
1788 FIRM_API long get_array_upper_bound_int(const ir_type *array, size_t dimension);
1790 /** Sets an array dimension to a specific order. */
1791 FIRM_API void set_array_order(ir_type *array, size_t dimension, size_t order);
1793 /** Returns the order of an array dimension. */
1794 FIRM_API size_t get_array_order(const ir_type *array, size_t dimension);
1796 /** Find the array dimension that is placed at order order. */
1797 FIRM_API size_t find_array_dimension(const ir_type *array, size_t order);
1799 /** Sets the array element type. */
1800 FIRM_API void set_array_element_type(ir_type *array, ir_type *tp);
1802 /** Gets the array element type. */
1803 FIRM_API ir_type *get_array_element_type(const ir_type *array);
1805 /** Sets the array element entity. */
1806 FIRM_API void set_array_element_entity(ir_type *array, ir_entity *ent);
1808 /** Get the array element entity. */
1809 FIRM_API ir_entity *get_array_element_entity(const ir_type *array);
1811 /** Returns true if a type is an array type. */
1812 FIRM_API int is_Array_type(const ir_type *array);
1815 * This type opcode marks that the corresponding type is an array type.
1817 * Consequently it contains a list of dimensions (lower and upper bounds)
1818 * and an element type.
1819 * This struct is dynamically allocated but constant for the lifetime
1822 FIRM_API const tp_op *type_array;
1823 FIRM_API const tp_op *get_tpop_array(void);
1828 * @defgroup enumeration_type Enumeration
1830 * Enumeration types need not necessarily be represented explicitly
1831 * by Firm types, as the frontend can lower them to integer constants as
1832 * well. For debugging purposes or similar tasks this information is useful.
1833 * The type state layout_fixed is set, if all enumeration constant have
1834 * there tarvals assigned. Until then
1836 * - *const: The target values representing the constants used to
1837 * represent individual enumerations.
1841 /** Create a new type enumeration -- set the enumerators independently. */
1842 FIRM_API ir_type *new_type_enumeration(ident *name, size_t n_enums);
1844 /** Create a new type enumeration with debug information -- set the enumerators independently. */
1845 FIRM_API ir_type *new_d_type_enumeration(ident *name, size_t n_enums,
1849 /** return enumeration identifier */
1850 FIRM_API ident *get_enumeration_ident(const ir_type *enumeration);
1852 /** return enumeration identifier as c-string */
1853 FIRM_API const char *get_enumeration_name(const ir_type *enumeration);
1855 /** Set an enumeration constant to a enumeration type at a given position. */
1856 FIRM_API void set_enumeration_const(ir_type *enumeration, size_t pos,
1857 ident *nameid, ir_tarval *con);
1859 /** Returns the number of enumeration values of this enumeration */
1860 FIRM_API size_t get_enumeration_n_enums(const ir_type *enumeration);
1862 /** Returns the enumeration constant at a given position. */
1863 FIRM_API ir_enum_const *get_enumeration_const(const ir_type *enumeration,
1866 /** Returns the enumeration type owner of an enumeration constant. */
1867 FIRM_API ir_type *get_enumeration_owner(const ir_enum_const *enum_cnst);
1869 /** Sets the enumeration constant value. */
1870 FIRM_API void set_enumeration_value(ir_enum_const *enum_cnst, ir_tarval *con);
1872 /** Returns the enumeration constant value. */
1873 FIRM_API ir_tarval *get_enumeration_value(const ir_enum_const *enum_cnst);
1875 /** Assign an ident to an enumeration constant. */
1876 FIRM_API void set_enumeration_nameid(ir_enum_const *enum_cnst, ident *id);
1878 /** Returns the assigned ident of an enumeration constant. */
1879 FIRM_API ident *get_enumeration_const_nameid(const ir_enum_const *enum_cnst);
1881 /** Returns the assigned name of an enumeration constant. */
1882 FIRM_API const char *get_enumeration_const_name(const ir_enum_const *enum_cnst);
1884 /** Returns true if a type is a enumeration type. */
1885 FIRM_API int is_Enumeration_type(const ir_type *enumeration);
1888 * This type opcode marks that the corresponding type is an enumeration type.
1890 * Consequently it contains a list of idents for the enumeration identifiers
1891 * and a list of target values that are the constants used to implement
1893 * This struct is dynamically allocated but constant for the lifetime
1896 FIRM_API const tp_op *type_enumeration;
1897 FIRM_API const tp_op *get_tpop_enumeration(void);
1902 * @defgroup pointer_type Pointer
1905 * - points_to: The type this pointer points to.
1909 /** Creates a new type pointer. */
1910 FIRM_API ir_type *new_type_pointer(ir_type *points_to);
1912 /** Creates a new type pointer with debug information. */
1913 FIRM_API ir_type *new_d_type_pointer(ir_type *points_to, type_dbg_info* db);
1916 /** Sets the type to which a pointer points to. */
1917 FIRM_API void set_pointer_points_to_type(ir_type *pointer, ir_type *tp);
1919 /** Returns the type to which a pointer points to. */
1920 FIRM_API ir_type *get_pointer_points_to_type(const ir_type *pointer);
1922 /** Returns true if a type is a pointer type. */
1923 FIRM_API int is_Pointer_type(const ir_type *pointer);
1925 /** Returns the first pointer type that has as points_to tp.
1926 * Not efficient: O(\#types).
1927 * If not found returns firm_unknown_type. */
1928 FIRM_API ir_type *find_pointer_type_to_type(ir_type *tp);
1931 * This type opcode marks that the corresponding type is a pointer type.
1933 * It contains a reference to the type the pointer points to.
1934 * This struct is dynamically allocated but constant for the lifetime
1937 FIRM_API const tp_op *type_pointer;
1938 FIRM_API const tp_op *get_tpop_pointer(void);
1943 * @defgroup primitive_type Primitive
1945 * Primitive types are types that represent atomic data values that
1946 * map directly to modes. They don't have private attributes. The
1947 * important information they carry is held in the common mode field.
1950 /** Creates a new primitive type. */
1951 FIRM_API ir_type *new_type_primitive(ir_mode *mode);
1953 /** Creates a new primitive type with debug information. */
1954 FIRM_API ir_type *new_d_type_primitive(ir_mode *mode, type_dbg_info* db);
1956 /** Returns true if a type is a primitive type. */
1957 FIRM_API int is_Primitive_type(const ir_type *primitive);
1959 /** Return the base type of a primitive (bitfield) type or NULL if none. */
1960 FIRM_API ir_type *get_primitive_base_type(const ir_type *tp);
1962 /** Sets the base type of a primitive (bitfield) type. */
1963 FIRM_API void set_primitive_base_type(ir_type *tp, ir_type *base_tp);
1966 * This type opcode marks that the corresponding type is a primitive type.
1968 * Primitive types are types that are directly mapped to target machine
1970 * This struct is dynamically allocated but constant for the lifetime
1973 FIRM_API const tp_op *type_primitive;
1974 FIRM_API const tp_op *get_tpop_primitive(void);
1979 * @defgroup none_type None
1981 * This type is an auxiliary type dedicated to support type analyses.
1983 * The none type represents that there is no type. The type can be used to
1984 * initialize fields of type* that actually can not contain a type or that
1985 * are initialized for an analysis. There exists exactly one type none.
1986 * This type is not on the type list in ir_prog. It is
1987 * allocated when initializing the type module.
1989 * The following values are set:
1991 * - name: "type_none"
1992 * - state: layout_fixed
1996 /** A variable that contains the only none type. */
1997 FIRM_API ir_type *firm_none_type;
1998 /** Returns the none type. */
1999 FIRM_API ir_type *get_none_type(void);
2001 * This type opcode is an auxiliary opcode dedicated to support type analyses.
2003 * Types with this opcode represents that there is no type.
2004 * The type can be used to initialize fields of the type* that actually can not
2005 * contain a type or that are initialized for an analysis. There exists exactly
2006 * one type with this opcode.
2008 FIRM_API const tp_op *tpop_none;
2009 FIRM_API const tp_op *get_tpop_none(void);
2012 /** @defgroup code_type Code
2015 /** A variable that contains the only code type. */
2016 FIRM_API ir_type *firm_code_type;
2017 /** Returns the code type. */
2018 FIRM_API ir_type *get_code_type(void);
2020 * Checks whether a type is a code type.
2022 FIRM_API int is_code_type(const ir_type *tp);
2024 * The code type is used to mark pieces of code (basic blocks)
2026 FIRM_API const tp_op *tpop_code;
2027 FIRM_API const tp_op *get_tpop_code_type(void);
2031 * @defgroup unknown_type Unknown
2033 * This type is an auxiliary type dedicated to support type analyses.
2035 * The unknown type represents that there could be a type, but it is not
2036 * known. This type can be used to initialize fields before an analysis (not known
2037 * yet) or to represent the top of a lattice (could not be determined). There exists
2038 * exactly one type unknown. This type is not on the type list in ir_prog. It is
2039 * allocated when initializing the type module.
2041 * The following values are set:
2043 * - name: "type_unknown"
2044 * - state: layout_fixed
2048 /** A variable that contains the only unknown type. */
2049 FIRM_API ir_type *firm_unknown_type;
2050 /** Returns the unknown type. */
2051 FIRM_API ir_type *get_unknown_type(void);
2053 * This type opcode is an auxiliary opcode dedicated to support type analyses.
2055 * Types with this opcode represents that there could be a type, but it is not
2056 * known. This type can be used to initialize fields before an analysis (not known
2057 * yet) or to represent the top of a lattice (could not be determined). There exists
2058 * exactly one type with this opcode.
2060 FIRM_API const tp_op *tpop_unknown;
2061 FIRM_API const tp_op *get_tpop_unknown(void);
2065 * Checks whether a type is atomic.
2066 * @param tp any type
2067 * @return true if type is primitive, pointer or enumeration
2069 FIRM_API int is_atomic_type(const ir_type *tp);
2072 * @defgroup compound_type Compound
2078 * Gets the identifier of a compound type
2080 FIRM_API ident *get_compound_ident(const ir_type *tp);
2082 /** return compound identifier as c-string */
2083 FIRM_API const char *get_compound_name(const ir_type *tp);
2086 * Gets the number of elements in a Firm compound type.
2088 * This is just a comfortability function, because structs and
2089 * classes can often be treated be the same code, but they have
2090 * different access functions to their members.
2092 * @param tp The type (must be struct, union or class).
2094 * @return Number of members in the compound type.
2096 FIRM_API size_t get_compound_n_members(const ir_type *tp);
2099 * Gets the member of a Firm compound type at position pos.
2101 * @param tp The type (must be struct, union or class).
2102 * @param pos The number of the member.
2104 * @return The member entity at position pos.
2106 FIRM_API ir_entity *get_compound_member(const ir_type *tp, size_t pos);
2108 /** Returns index of member in tp, -1 if not contained. */
2109 FIRM_API size_t get_compound_member_index(const ir_type *tp, ir_entity *member);
2111 /** Remove a member from a compound type. */
2112 FIRM_API void remove_compound_member(ir_type *compound, ir_entity *entity);
2115 * layout members of a struct/union or class type in a default way.
2117 FIRM_API void default_layout_compound_type(ir_type *tp);
2120 * Checks whether a type is a compound type.
2122 * @param tp - any type
2124 * @return true if the type is class, structure, union or array type.
2126 FIRM_API int is_compound_type(const ir_type *tp);
2130 /** @defgroup frame_type Frame
2135 * Makes a new frame type. Frame types are class types,
2136 * so all class access functions work.
2137 * Frame types are not in the global list of types.
2139 FIRM_API ir_type *new_type_frame(void);
2142 * Checks, whether a type is a frame type.
2144 FIRM_API int is_frame_type(const ir_type *tp);
2147 * Makes a clone of a frame type.
2148 * Sets entity links from old frame entities to new onces and
2151 FIRM_API ir_type *clone_frame_type(ir_type *type);
2154 * Allocate an area of size bytes aligned at alignment
2155 * at the start or the end of a frame type.
2156 * The frame type must already have a fixed layout.
2158 * @param frame_type a frame type
2159 * @param size the size of the entity
2160 * @param alignment the alignment of the entity
2161 * @param at_start if true, put the area at the frame type's start, else at end
2163 * @return the entity representing the area
2165 FIRM_API ir_entity *frame_alloc_area(ir_type *frame_type, int size,
2166 unsigned alignment, int at_start);
2171 * @defgroup trwalk Traversing
2175 /** Type for a function that compares two types.
2177 * @param tp1 The first type to compare.
2178 * @param tp2 The second type to compare.
2180 typedef int (compare_types_func_t)(const void *tp1, const void *tp2);
2182 /** A data type to treat types and entities as the same. */
2184 ir_type *typ; /**< points to a type */
2185 ir_entity *ent; /**< points to an entity */
2188 /** Type of argument functions for type walkers.
2190 * @param tore points to the visited type or entity
2191 * @param env free environment pointer
2193 typedef void type_walk_func(type_or_ent tore, void *env);
2195 /** The class walk function
2197 * @param clss points to the visited class
2198 * @param env free environment pointer
2200 typedef void class_walk_func(ir_type *clss, void *env);
2202 /** Touches every type and entity in unspecified order. If new
2203 * types/entities are created during the traversal these will
2205 * Does not touch frame types or types for value params ... */
2206 FIRM_API void type_walk(type_walk_func *pre, type_walk_func *post, void *env);
2208 /** Walks over all type information reachable from an ir graph.
2210 * Walks over all type information reachable from irg, i.e., starts a
2211 * type walk at the irgs entity, the irgs frame type and all types and
2212 * entities that are attributes to firm nodes. */
2213 FIRM_API void type_walk_irg(ir_graph *irg, type_walk_func *pre,
2214 type_walk_func *post, void *env);
2217 * Touches every class in specified order:
2218 * - first the super class
2219 * - second the class itself
2220 * - third the sub classes. If new classes are created
2221 * during the traversal these will be visited, too.
2223 * @deprecated will be removed?
2225 FIRM_API void type_walk_super2sub(type_walk_func *pre, type_walk_func *post,
2228 /** Walker for class types in inheritance order.
2230 * Touches every class in specified order:
2231 * - first the super class
2232 * - second the class itself
2233 * If new classes are created during the traversal these
2234 * will be visited, too.
2235 * Starts the walk at arbitrary classes.
2236 * Executes pre when first visiting a class. Executes post after
2237 * visiting all superclasses.
2239 * The arguments pre, post, env may be NULL. */
2240 FIRM_API void type_walk_super(type_walk_func *pre, type_walk_func *post,
2243 /** Same as type_walk_super2sub, but visits only class types.
2244 Executes pre for a class if all superclasses have been visited.
2245 Then iterates to subclasses. Executes post after return from
2247 Does not visit global type, frame types.
2249 FIRM_API void class_walk_super2sub(class_walk_func *pre, class_walk_func *post,
2253 * the entity walk function. A function type for entity walkers.
2255 * @param ent points to the visited entity
2256 * @param env free environment pointer
2258 typedef void entity_walk_func(ir_entity *ent, void *env);
2261 * Walks over all entities in the type.
2263 * @param tp the type
2264 * @param doit the entity walker function
2265 * @param env environment, will be passed to the walker function
2267 FIRM_API void walk_types_entities(ir_type *tp, entity_walk_func *doit,
2271 * If we have the closed world assumption, we can calculate the
2272 * finalization of classes and entities by inspecting the class hierarchy.
2273 * After this is done, all classes and entities that are not overridden
2274 * anymore have the final property set.
2276 FIRM_API void types_calc_finalization(void);
2279 FIRM_API ir_visibility get_type_visibility(const ir_type *tp);
2281 FIRM_API void set_type_visibility(ir_type *tp, ir_visibility v);