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 across compilation units. It might have an
96 * Note that entities with visibility_external without initializer are
97 * assumed to be defined in another compilation unit (not like C variables
98 * which are considered 'uninitialized' in this case).
100 ir_visibility_external,
102 * The entity is local to the compilation unit.
103 * A local entity is not visible in other compilation units.
104 * Note that the entity might still be accessed indirectly from other units
109 * This has the same semantic as visibility_local. Additionally the symbol
110 * is completely hidden from the linker (it only appears in the assembly).
111 * While visibility_local is probably still visible to debuggers,
112 * visibility_private symbols aren't and probably won't appear in the object
115 ir_visibility_private,
119 * linkage specifies how the linker treats symbols
121 typedef enum ir_linkage {
122 IR_LINKAGE_DEFAULT = 0,
124 * A symbol whose definition won't change in a program.
125 * Optimisation might replace loads from this entity with constants.
126 * Also most linkers put such data in a constant segment which is shared
127 * between multiple running instances of the same application.
129 IR_LINKAGE_CONSTANT = 1 << 0,
131 * The entity is a weak symbol.
132 * A weak symbol is overridden by a non-weak symbol if one exists.
133 * Most linkers only support the IR_LINKAGE_WEAK in combination with
136 IR_LINKAGE_WEAK = 1 << 1,
138 * The entity may be removed when it isn't referenced anywhere in the
139 * compilation unit even if it is exported (non-local).
140 * Typically used for C++ instantiated template code (,,COMDAT'' section).
142 IR_LINKAGE_GARBAGE_COLLECT = 1 << 2,
144 * The linker will try to merge entities with same name from different
145 * compilation units. This is the usual behaviour for global variables
146 * without explicit initialisation in C (``COMMON'' symbols). It's also
147 * typically used in C++ for instantiated template code (,,COMDAT'' section)
149 IR_LINKAGE_MERGE = 1 << 3,
151 * Some entity uses are potentially hidden from the compiler.
152 * (For example because they happen in an asm("") statement. This flag
153 * should be set for __attribute__((used)) in C code).
154 * Setting this flag prohibits that the compiler making assumptions about
155 * read/write behaviour to global variables or changing calling conventions
156 * from cdecl to fastcall.
158 IR_LINKAGE_HIDDEN_USER = 1 << 4,
160 * Do not generate code even if the entity has a graph attached. The graph
161 * is only used for inlining. Otherwise the entity is regarded as a
162 * declaration of an externally defined entity.
163 * This linkage flag can be used to implement C99 "inline" or GNU89
166 IR_LINKAGE_NO_CODEGEN = 1 << 5,
168 ENUM_BITSET(ir_linkage)
171 * Returns the visibility class of an entity
173 FIRM_API ir_visibility get_entity_visibility(const ir_entity *entity);
176 * Sets visibility class of an entity
178 FIRM_API void set_entity_visibility(ir_entity *entity, ir_visibility visibility);
181 * Returns 1 if the entity is visible outside the current compilation unit
182 * or to unknown callers (like asm statements).
183 * (The entity might still be accessible indirectly through pointers)
184 * This is a convenience function and does the same as
185 * get_entity_visibility(entity) != ir_visibility_local ||
186 * (get_entity_linkage(entity) & IR_LINKAGE_HIDDEN_USER)
188 FIRM_API int entity_is_externally_visible(const ir_entity *entity);
191 * Returns 1 if the entity has a definition (initializer) in the current
192 * compilation unit. Note that this function returns false if
193 * IR_LINKAGE_NO_CODEGEN is set even if a graph is present.
195 FIRM_API int entity_has_definition(const ir_entity *entity);
198 * Creates a new entity.
200 * Automatically inserts the entity as a member of owner.
201 * Entity is automatic_allocated and uninitialized except if the type
202 * is type_method, then it is static_allocated and constant. The constant
203 * value is a pointer to the method.
204 * Visibility is local, offset -1, and it is not volatile.
206 FIRM_API ir_entity *new_entity(ir_type *owner, ident *name, ir_type *tp);
209 * Creates a new entity.
211 * Automatically inserts the entity as a member of owner.
212 * The entity is automatic allocated and uninitialized except if the type
213 * is type_method, then it is static allocated and constant. The constant
214 * value is a pointer to the method.
215 * Visibility is local, offset -1, and it is not volatile.
217 FIRM_API ir_entity *new_d_entity(ir_type *owner, ident *name, ir_type *tp,
221 * Creates a new entity corresponding to a function parameter.
222 * This must be created on an irgs frame_type
224 FIRM_API ir_entity *new_parameter_entity(ir_type *owner, size_t pos,
228 * Like new_parameter_entity() but with debug information.
230 FIRM_API ir_entity *new_d_parameter_entity(ir_type *owner, size_t pos,
231 ir_type *type, dbg_info *dbgi);
234 * Check an entity. Currently, we check only if initialized constants
235 * are build on the const irg graph.
237 * @return non-zero if no errors were found
239 FIRM_API int check_entity(const ir_entity *ent);
242 * Copies the entity if the new_owner is different from the
243 * owner of the old entity, else returns the old entity.
245 * Automatically inserts the new entity as a member of owner.
246 * Resets the overwrites/overwritten_by fields.
247 * Keeps the old atomic value.
249 FIRM_API ir_entity *copy_entity_own(ir_entity *old, ir_type *new_owner);
252 * Copies the entity if the new_name is different from the
253 * name of the old entity, else returns the old entity.
255 * Automatically inserts the new entity as a member of owner.
256 * The mangled name ld_name is set to NULL.
257 * Overwrites relation is copied from old.
259 FIRM_API ir_entity *copy_entity_name(ir_entity *old, ident *new_name);
264 * The owner will still contain the pointer to this
265 * entity, as well as all other references!
267 FIRM_API void free_entity(ir_entity *ent);
269 /** Returns the name of an entity. */
270 FIRM_API const char *get_entity_name(const ir_entity *ent);
272 /** Returns the ident of an entity. */
273 FIRM_API ident *get_entity_ident(const ir_entity *ent);
275 /** Sets the ident of the entity. */
276 FIRM_API void set_entity_ident(ir_entity *ent, ident *id);
278 /** Returns the mangled name of the entity.
280 * If the mangled name is set it returns the existing name.
281 * Else it generates a name with mangle_entity()
282 * and remembers this new name internally.
284 FIRM_API ident *get_entity_ld_ident(const ir_entity *ent);
286 /** Sets the mangled name of the entity. */
287 FIRM_API void set_entity_ld_ident(ir_entity *ent, ident *ld_ident);
289 /** Returns the mangled name of the entity as a string. */
290 FIRM_API const char *get_entity_ld_name(const ir_entity *ent);
292 /** returns 1 if the entity has an ld_ident set explicitely */
293 FIRM_API int entity_has_ld_ident(const ir_entity *entity);
295 /** Returns the owner of the entity. */
296 FIRM_API ir_type *get_entity_owner(const ir_entity *ent);
299 * Sets the owner field in entity to owner.
300 * Automatically removes entity from old owner type and adds it to the new
303 FIRM_API void set_entity_owner(ir_entity *ent, ir_type *owner);
305 /** Returns the type of an entity. */
306 FIRM_API ir_type *get_entity_type(const ir_entity *ent);
308 /** Sets the type of an entity. */
309 FIRM_API void set_entity_type(ir_entity *ent, ir_type *tp);
311 /** Returns the linkage of an entity. */
312 FIRM_API ir_linkage get_entity_linkage(const ir_entity *entity);
314 /** Sets the linkage flags of entity @p entity to @p linkage. */
315 FIRM_API void set_entity_linkage(ir_entity *entity, ir_linkage linkage);
316 /** Adds linkage flags @p linkage to entity @p entity. */
317 FIRM_API void add_entity_linkage(ir_entity *entity, ir_linkage linkage);
318 /** Remove linkage flags @p linkage from entity @p entity. */
319 FIRM_API void remove_entity_linkage(ir_entity *entity, ir_linkage linkage);
322 * Returns the volatility of an entity.
325 FIRM_API ir_volatility get_entity_volatility(const ir_entity *ent);
328 * Sets the volatility of an entity.
331 FIRM_API void set_entity_volatility(ir_entity *ent, ir_volatility vol);
333 /** Returns the name of the volatility. */
334 FIRM_API const char *get_volatility_name(ir_volatility var);
336 /** Returns alignment of entity in bytes */
337 FIRM_API unsigned get_entity_alignment(const ir_entity *entity);
339 /** Allows you to override the type alignment for an entity.
340 * @param entity the entity
341 * @param alignment alignment in bytes
343 FIRM_API void set_entity_alignment(ir_entity *entity, unsigned alignment);
346 * Returns indication whether entity is aligned in memory.
349 FIRM_API ir_align get_entity_aligned(const ir_entity *ent);
352 * Sets indication whether entity is aligned in memory
355 FIRM_API void set_entity_aligned(ir_entity *ent, ir_align a);
357 /** Returns the name of the alignment. */
358 FIRM_API const char *get_align_name(ir_align a);
360 /** Returns the offset of an entity (in a compound) in bytes. Only set if
362 FIRM_API int get_entity_offset(const ir_entity *ent);
364 /** Sets the offset of an entity (in a compound) in bytes. */
365 FIRM_API void set_entity_offset(ir_entity *ent, int offset);
367 /** Returns the offset bit remainder of a bitfield entity (in a compound) in
368 * bits. Only set if layout = fixed. */
369 FIRM_API unsigned char get_entity_offset_bits_remainder(const ir_entity *ent);
371 /** Sets the offset bit remainder of a bitfield entity (in a compound) in bits. */
372 FIRM_API void set_entity_offset_bits_remainder(ir_entity *ent,
373 unsigned char offset);
375 /** Returns the stored intermediate information. */
376 FIRM_API void *get_entity_link(const ir_entity *ent);
378 /** Stores new intermediate information. */
379 FIRM_API void set_entity_link(ir_entity *ent, void *l);
382 * The entity knows the corresponding irg if the entity is a method.
383 * This allows to get from a Call to the called irg.
385 FIRM_API ir_graph *get_entity_irg(const ir_entity *ent);
387 /** A reserved value for "not yet set". */
388 #define IR_VTABLE_NUM_NOT_SET ((unsigned)(-1))
390 /** Returns the entity vtable number. */
391 FIRM_API unsigned get_entity_vtable_number(const ir_entity *ent);
393 /** Sets the entity vtable number. */
394 FIRM_API void set_entity_vtable_number(ir_entity *ent, unsigned vtable_number);
396 /** Sets label number of an entity with code type */
397 FIRM_API void set_entity_label(ir_entity *ent, ir_label_t label);
398 /** Returns label number of an entity with code type */
399 FIRM_API ir_label_t get_entity_label(const ir_entity *ent);
401 /** Checks if an entity is compiler generated. */
402 FIRM_API int is_entity_compiler_generated(const ir_entity *ent);
404 /** Sets/resets the compiler generated flag. */
405 FIRM_API void set_entity_compiler_generated(ir_entity *ent, int flag);
408 * Bitfield type indicating the way an entity is used.
411 ir_usage_none = 0, /**< This entity is unused. */
412 ir_usage_address_taken = 1 << 0, /**< The address of this entity was taken. */
413 ir_usage_write = 1 << 1, /**< The entity was written to. */
414 ir_usage_read = 1 << 2, /**< The entity was read. */
415 ir_usage_reinterpret_cast = 1 << 3, /**< The entity was read but with a wrong mode
416 (an implicit reinterpret cast) */
417 /** Unknown access */
419 = ir_usage_address_taken | ir_usage_write | ir_usage_read
420 | ir_usage_reinterpret_cast
423 /** Returns the entity usage */
424 FIRM_API ir_entity_usage get_entity_usage(const ir_entity *ent);
426 /** Sets/resets the state of the address taken flag of an entity. */
427 FIRM_API void set_entity_usage(ir_entity *ent, ir_entity_usage flag);
430 * Returns the debug information of an entity.
432 * @param ent The entity.
434 FIRM_API dbg_info *get_entity_dbg_info(const ir_entity *ent);
437 * Sets the debug information of an entity.
439 * @param ent The entity.
440 * @param db The debug info.
442 FIRM_API void set_entity_dbg_info(ir_entity *ent, dbg_info *db);
445 * Sepcial parameter number which can be used for parameter entities to
446 * indicate the first non-declared parameter in a procedure with variable
448 * We assumes that all additional parameters for variable parameters are on the
449 * stack. Starting from this address you can walk the stack to find all other
452 #define IR_VA_START_PARAMETER_NUMBER ((size_t)-1)
455 * returns true if a given entity is a parameter_entity representing the
456 * address of a function parameter
458 FIRM_API int is_parameter_entity(const ir_entity *entity);
461 * returns number of parameter a parameter entitiy represents
463 FIRM_API size_t get_entity_parameter_number(const ir_entity *entity);
466 * set number of parameter an entity represents
468 FIRM_API void set_entity_parameter_number(ir_entity *entity, size_t n);
471 * Returns true if the the node is representable as code on
474 * @deprecated This function is not used by libFirm and stays here
475 * only as a helper for the old Jack frontend.
477 FIRM_API int is_irn_const_expression(ir_node *n);
480 * Copies a Firm subgraph that complies to the restrictions for
481 * constant expressions to block.
483 * @param dbg debug info for all newly created nodes
485 * @param to_block block to copy to
487 FIRM_API ir_node *copy_const_value(dbg_info *dbg, ir_node *n, ir_node *to_block);
489 /** Returns initial value of entity with atomic type @p ent. */
490 FIRM_API ir_node *get_atomic_ent_value(const ir_entity *ent);
491 /** Sets initial value of entity with atomic type @p ent to node @p val.
492 * @note @p val must be a node in the const_code graph */
493 FIRM_API void set_atomic_ent_value(ir_entity *ent, ir_node *val);
495 /** @defgroup ir_initializer Entity Initializers
499 /** the kind (type) of an initializer */
500 typedef enum ir_initializer_kind_t {
501 /** initializer containing an ir_node from the const-code irg */
502 IR_INITIALIZER_CONST,
503 /** initializer containing a tarval */
504 IR_INITIALIZER_TARVAL,
505 /** initializes type with default values (usually 0) */
507 /** list of initializers used to initializer a compound or array type */
508 IR_INITIALIZER_COMPOUND
509 } ir_initializer_kind_t;
511 /** Returns kind of an initializer */
512 FIRM_API ir_initializer_kind_t get_initializer_kind(const ir_initializer_t *initializer);
514 /** Returns the name of the initializer kind. */
515 FIRM_API const char *get_initializer_kind_name(ir_initializer_kind_t ini);
518 * Returns the null initializer (there's only one instance of it in a program )
520 FIRM_API ir_initializer_t *get_initializer_null(void);
523 * Creates an initializer containing a reference to a node on the const-code
526 FIRM_API ir_initializer_t *create_initializer_const(ir_node *value);
528 /** Creates an initializer containing a single tarval value */
529 FIRM_API ir_initializer_t *create_initializer_tarval(ir_tarval *tv);
531 /** Returns value contained in a const initializer */
532 FIRM_API ir_node *get_initializer_const_value(const ir_initializer_t *initializer);
534 /** Returns value contained in a tarval initializer */
535 FIRM_API ir_tarval *get_initializer_tarval_value(const ir_initializer_t *initialzier);
537 /** Creates a compound initializer which holds @p n_entries entries */
538 FIRM_API ir_initializer_t *create_initializer_compound(size_t n_entries);
540 /** Returns the number of entries in a compound initializer */
541 FIRM_API size_t get_initializer_compound_n_entries(const ir_initializer_t *initializer);
543 /** Sets entry with index @p index to the initializer @p value */
544 FIRM_API void set_initializer_compound_value(ir_initializer_t *initializer,
546 ir_initializer_t *value);
548 /** Returns the value with index @p index of a compound initializer */
549 FIRM_API ir_initializer_t *get_initializer_compound_value(
550 const ir_initializer_t *initializer, size_t index);
554 /** Sets the new style initializers of an entity. */
555 FIRM_API void set_entity_initializer(ir_entity *entity, ir_initializer_t *initializer);
557 /** Returns true, if an entity has new style initializers. */
558 FIRM_API int has_entity_initializer(const ir_entity *entity);
560 /** Returns the new style initializers of an entity. */
561 FIRM_API ir_initializer_t *get_entity_initializer(const ir_entity *entity);
563 /** Adds entity @p ent to the list of entities that overwrite @p overwritten. */
564 FIRM_API void add_entity_overwrites(ir_entity *ent, ir_entity *overwritten);
565 /** Returns the number of entities in the list of entities that overwrite
567 FIRM_API size_t get_entity_n_overwrites(const ir_entity *ent);
568 /** Returns index of @p overwritten in list of entities overwriting entity
570 FIRM_API size_t get_entity_overwrites_index(const ir_entity *ent,
571 ir_entity *overwritten);
572 /** Returns entry @p pos in list of entities overwriting entity @p ent. */
573 FIRM_API ir_entity *get_entity_overwrites(const ir_entity *ent, size_t pos);
574 /** Sets entry @p pos in list of entities overwriting entity @p ent. */
575 FIRM_API void set_entity_overwrites(ir_entity *ent, size_t pos,
576 ir_entity *overwritten);
577 /** Remove @p overwritten from list of entities overwriting entity @p ent. */
578 FIRM_API void remove_entity_overwrites(ir_entity *ent, ir_entity *overwritten);
580 /** Returns number of entities overwritten by @p ent. */
581 FIRM_API size_t get_entity_n_overwrittenby(const ir_entity *ent);
582 /** Returns index of @p overwrites in list of entities overwritten by entity
584 FIRM_API size_t get_entity_overwrittenby_index(const ir_entity *ent,
585 ir_entity *overwrites);
586 /** Return entry @p pos in list of entities overwritten by entity @p ent. */
587 FIRM_API ir_entity *get_entity_overwrittenby(const ir_entity *ent, size_t pos);
588 /** Sets entry @p pos in list of entities overwritten by entity @p ent. */
589 FIRM_API void set_entity_overwrittenby(ir_entity *ent, size_t pos,
590 ir_entity *overwrites);
591 /** Removes entry @p overwrites in list of entities overwritten by @p ent. */
592 FIRM_API void remove_entity_overwrittenby(ir_entity *ent,
593 ir_entity *overwrites);
596 * Checks whether a pointer points to an entity.
598 * @param thing an arbitrary pointer
601 * true if the thing is an entity, else false
603 FIRM_API int is_entity(const void *thing);
605 /** Returns true if the type of the entity is a primitive, pointer
606 * enumeration or method type.
608 * @note This is a different classification than from is_primitive_type().
610 FIRM_API int is_atomic_entity(const ir_entity *ent);
611 /** Returns true if the type of the entity is a class, structure,
612 array or union type. */
613 FIRM_API int is_compound_entity(const ir_entity *ent);
614 /** Returns true if the type of the entity is a Method type. */
615 FIRM_API int is_method_entity(const ir_entity *ent);
617 /** Outputs a unique number for this entity if libfirm is compiled for
618 * debugging, (configure with --enable-debug) else returns the address
619 * of the type cast to long.
621 FIRM_API long get_entity_nr(const ir_entity *ent);
623 /** Returns the entities visited counter.
624 * @see @ref visited_counters */
625 FIRM_API ir_visited_t get_entity_visited(const ir_entity *ent);
627 /** Sets the entities visited counter.
628 * @see @ref visited_counters */
629 FIRM_API void set_entity_visited(ir_entity *ent, ir_visited_t num);
631 /** Marks entity as visited.
632 * @see @ref visited_counters */
633 FIRM_API void mark_entity_visited(ir_entity *ent);
635 /** Returns true if this entity was visited.
636 * @see @ref visited_counters */
637 FIRM_API int entity_visited(const ir_entity *ent);
639 /** Returns true if this entity was not visited.
640 * @see @ref visited_counters */
641 FIRM_API int entity_not_visited(const ir_entity *ent);
644 * Returns the mask of the additional entity properties.
645 * The properties are automatically inherited from the irg if available
646 * or from the method type if they were not set using
647 * set_entity_additional_properties() or
648 * set_entity_additional_property().
650 FIRM_API mtp_additional_properties get_entity_additional_properties(const ir_entity *ent);
652 /** Sets the mask of the additional graph properties. */
653 FIRM_API void set_entity_additional_properties(ir_entity *ent,
654 mtp_additional_properties prop);
656 /** Sets additional graph properties. */
657 FIRM_API void add_entity_additional_properties(ir_entity *ent,
658 mtp_additional_properties flag);
660 /** Returns the class type that this type info entity represents or NULL
661 if ent is no type info entity. */
662 FIRM_API ir_type *get_entity_repr_class(const ir_entity *ent);
665 * @page unknown_entity The Unknown entity
667 * This entity is an auxiliary entity dedicated to support analyses.
669 * The unknown entity represents that there could be an entity, but it is not
670 * known. This entity can be used to initialize fields before an analysis (not known
671 * yet) or to represent the top of a lattice (could not be determined). There exists
672 * exactly one entity unknown. This entity has as owner and as type the unknown type. It is
673 * allocated when initializing the entity module.
675 * The entity can take the role of any entity, also methods. It returns default
676 * values in these cases.
678 * The following values are set:
680 * - name = "unknown_entity"
681 * - ld_name = "unknown_entity"
682 * - owner = unknown_type
683 * - type = unknown_type
685 * - value = SymConst(unknown_entity)
688 * - volatility = volatility_non_volatile
689 * - stickyness = stickyness_unsticky
691 * - overwrites = NULL
692 * - overwrittenby = NULL
697 /** Returns the @link unknown_entity unknown entity @endlink. */
698 FIRM_API ir_entity *get_unknown_entity(void);
700 /** Tests whether entity @p entity is (the) unknown entity.
701 * @returns 1 if it is the unknown entity, 0 otherwise */
702 FIRM_API int is_unknown_entity(const ir_entity *entity);
706 allocation_automatic,
707 allocation_parameter,
712 FIRM_API ir_allocation get_entity_allocation(const ir_entity *ent);
714 FIRM_API void set_entity_allocation(ir_entity *ent, ir_allocation al);
718 peculiarity_existent,
719 peculiarity_description,
720 peculiarity_inherited
723 FIRM_API ir_peculiarity get_entity_peculiarity(const ir_entity *ent);
725 FIRM_API void set_entity_peculiarity(ir_entity *ent, ir_peculiarity pec);
728 FIRM_API int is_entity_final(const ir_entity *ent);
730 FIRM_API void set_entity_final(ir_entity *ent, int final);
733 FIRM_API ir_peculiarity get_class_peculiarity(const ir_type *clss);
735 FIRM_API void set_class_peculiarity(ir_type *clss, ir_peculiarity pec);
739 /** Encodes how a pointer parameter is accessed. */
740 typedef enum ptr_access_kind {
741 ptr_access_none = 0, /**< no access */
742 ptr_access_read = 1, /**< read access */
743 ptr_access_write = 2, /**< write access */
744 ptr_access_rw = ptr_access_read|ptr_access_write, /**< read AND write access */
745 ptr_access_store = 4, /**< the pointer is stored */
746 ptr_access_all = ptr_access_rw|ptr_access_store /**< all possible access */
748 ENUM_BITSET(ptr_access_kind)
751 * @defgroup ir_type Type System
753 * Datastructure to hold type information.
755 * This module supplies a datastructure to represent all types
756 * known in the compiled program. This includes types specified
757 * in the program as well as types defined by the language. In the
758 * view of the intermediate representation there is no difference
759 * between these types. Finally it specifies some auxiliary types.
761 * There exist several kinds of types, arranged by the structure of
762 * the type. A type is described by a set of attributes. Some of
763 * these attributes are common to all types, others depend on the
766 * Types are different from the modes defined in irmode: Types are
767 * on the level of the programming language, modes at the level of
768 * the target processor.
774 * @defgroup tp_op Type Opcodes
775 * This module specifies the kinds of types available in firm.
777 * They are called type opcodes. These include classes, structs, methods, unions,
778 * arrays, enumerations, pointers and primitive types.
779 * Special types with own opcodes are the id type, a type representing an unknown
780 * type and a type used to specify that something has no type.
786 * An enum for the type kinds.
787 * For each type kind exists a typecode to identify it.
790 tpo_uninitialized = 0, /* not a type opcode */
791 tpo_class, /**< A class type. */
792 tpo_struct, /**< A struct type. */
793 tpo_method, /**< A method type. */
794 tpo_union, /**< An union type. */
795 tpo_array, /**< An array type. */
796 tpo_enumeration, /**< An enumeration type. */
797 tpo_pointer, /**< A pointer type. */
798 tpo_primitive, /**< A primitive type. */
799 tpo_code, /**< a piece of code (a basic block) */
800 tpo_none, /**< Special type for the None type. */
801 tpo_unknown, /**< Special code for the Unknown type. */
802 tpo_last = tpo_unknown /* not a type opcode */
806 * A structure containing information about a kind of type.
807 * A structure containing information about a kind of type. So far
808 * this is only the kind name, an enum for case-switching and some
811 * @see get_tpop_name(), get_tpop_code()
813 typedef struct tp_op tp_op;
817 * Returns the string for the type opcode.
819 * @param op The type opcode to get the string from.
822 FIRM_API const char *get_tpop_name(const tp_op *op);
825 * Returns an enum for the type opcode.
827 * @param op The type opcode to get the enum from.
830 FIRM_API tp_opcode get_tpop_code(const tp_op *op);
834 /** Returns true if low is subclass of high.
836 * Low is a subclass of high if low == high or if low is a subclass of
837 * a subclass of high. I.e, we search in all subtypes of high for low.
838 * @@@ this can be implemented more efficient if we know the set of all
839 * subclasses of high. */
840 FIRM_API int is_SubClass_of(ir_type *low, ir_type *high);
842 /** Subclass check for pointers to classes.
844 * Dereferences at both types the same amount of pointer types (as
845 * many as possible). If the remaining types are both class types
846 * and subclasses, returns true, else false. Can also be called with
847 * two class types. */
848 FIRM_API int is_SubClass_ptr_of(ir_type *low, ir_type *high);
850 /** Returns true if high is superclass of low.
852 * Low is a subclass of high if low == high or if low is a subclass of
853 * a subclass of high. I.e, we search in all subtypes of high for low.
854 * @@@ this can be implemented more efficient if we know the set of all
855 * subclasses of high. */
856 #define is_SuperClass_of(high, low) is_SubClass_of(low, high)
858 /** Superclass check for pointers to classes.
860 * Dereferences at both types the same amount of pointer types (as
861 * many as possible). If the remaining types are both class types
862 * and superclasses, returns true, else false. Can also be called with
863 * two class types. */
864 #define is_SuperClass_ptr_of(low, high) is_SubClass_ptr_of(high, low)
866 /** Returns true if high is (transitive) overwritten by low.
868 * Returns false if high == low. */
869 FIRM_API int is_overwritten_by(ir_entity *high, ir_entity *low);
871 /** Resolve polymorphism in the inheritance relation.
873 * Returns the dynamically referenced entity if the static entity and the
874 * dynamic type are given.
875 * Searches downwards in overwritten tree. */
876 FIRM_API ir_entity *resolve_ent_polymorphy(ir_type *dynamic_class,
877 ir_entity* static_ent);
879 /** Default name mangling for inherited entities.
881 * Returns an ident that consists of the name of type followed by an
882 * underscore and the name (not ld_name) of the entity. */
883 FIRM_API ident *default_mangle_inherited_name(const ir_entity *ent,
884 const ir_type *clss);
886 /** Type of argument functions for inheritance resolver.
888 * @param ent The entity in the super type that will be overwritten
889 * by the newly generated entity, for which this name is
891 * @param clss The class type in which the new entity will be placed.
893 typedef ident *mangle_inherited_name_func(const ir_entity *ent,
894 const ir_type *clss);
896 /** Resolve implicit inheritance.
898 * Resolves the implicit inheritance supplied by firm. Firm defines,
899 * that each entity that is not overwritten in a subclass is
900 * inherited to this subclass without change implicitly. This
901 * function generates entities that explicitly represent this
902 * inheritance. It generates for each entity overwriting entities in
903 * all subclasses of the owner of the entity, if the entity is not
904 * overwritten in that subclass.
906 * The name of the new entity is generated with the function passed.
907 * If the function is NULL, the default_mangle_inherited_name() is
910 FIRM_API void resolve_inheritance(mangle_inherited_name_func *mfunc);
913 /* ----------------------------------------------------------------------- */
914 /* The transitive closure of the subclass/superclass and */
915 /* overwrites/overwrittenby relation. */
917 /* A walk over the ir (O(#types+#entities)) computes the transitive */
918 /* closure. Adding a new type/entity or changing the basic relations in */
919 /* some other way invalidates the transitive closure, i.e., it is not */
920 /* updated by the basic functions. */
922 /* The transitive edges are held in a set, not in an array as the */
923 /* underlying relation. */
925 /* Do the sets contain the node itself? I assume NOT! */
926 /* ----------------------------------------------------------------------- */
929 * The state of the transitive closure.
932 inh_transitive_closure_none, /**< Closure is not computed, can not be accessed. */
933 inh_transitive_closure_valid, /**< Closure computed and valid. */
934 inh_transitive_closure_invalid, /**< Closure invalid, but can be accessed. */
935 inh_transitive_closure_max /**< Invalid value. */
936 } inh_transitive_closure_state;
938 /** Sets the transitive closure of sub/superclass state for the
940 FIRM_API void set_irp_inh_transitive_closure_state(inh_transitive_closure_state s);
941 /** Sets the transitive closure of sub/superclass state for the
942 * whole program to #inh_transitive_closure_invalid */
943 FIRM_API void invalidate_irp_inh_transitive_closure_state(void);
944 /** Returns the transitive closure of sub/superclass state for the
946 FIRM_API inh_transitive_closure_state get_irp_inh_transitive_closure_state(void);
948 /** Compute transitive closure of the subclass/superclass and
949 * overwrites/overwrittenby relation.
951 * This function walks over the ir (O(\#types+\#entities)) to compute the
952 * transitive closure. */
953 FIRM_API void compute_inh_transitive_closure(void);
955 /** Free memory occupied by the transitive closure information. */
956 FIRM_API void free_inh_transitive_closure(void);
958 /** Start iteration over all transitive subtypes of @p tp */
959 FIRM_API ir_type *get_class_trans_subtype_first(const ir_type *tp);
961 * Returns next type in a subtype iteration started by
962 * get_class_trans_subtype_first()
964 FIRM_API ir_type *get_class_trans_subtype_next(const ir_type *tp);
966 * Check if @p subtp is a subtype of @p tp. This function checks the full
967 * transitive closure of the subtype relation and not just direct subtyping.
968 * @return 1 if it is a subtype, 0 otherwise
970 FIRM_API int is_class_trans_subtype(const ir_type *tp, const ir_type *subtp);
972 /** Start iteration over all transitive supertypes of @p tp */
973 FIRM_API ir_type *get_class_trans_supertype_first(const ir_type *tp);
975 * Returns next type in a supertype iteration started by
976 * get_class_trans_supertype_first()
978 FIRM_API ir_type *get_class_trans_supertype_next(const ir_type *tp);
980 /** Start iteration over all entities that transitive overwrite entity @p ent.*/
981 FIRM_API ir_entity *get_entity_trans_overwrittenby_first(const ir_entity *ent);
983 * Returns next entity in a overwrittenby iteration started by
984 * get_entity_trans_overwrittenby_first()
986 FIRM_API ir_entity *get_entity_trans_overwrittenby_next(const ir_entity *ent);
988 /** Start iteration over all transitive overwritten entities, overwritten by
990 FIRM_API ir_entity *get_entity_trans_overwrites_first(const ir_entity *ent);
992 * Returns next entity in a overwrites iteration started by
993 * get_entity_trans_overwrites_first()
995 FIRM_API ir_entity *get_entity_trans_overwrites_next(const ir_entity *ent);
998 /** The state of Cast operations that cast class types or pointers to class
1001 * The state expresses, how far Cast operations conform with the class
1005 * class B1 extends A {}
1006 * class B2 extends A {}
1007 * class C extends B1 {}
1008 * normalized: Cast operations conform with the inheritance relation.
1009 * I.e., the type of the operand of a Cast is either a super= or a sub-
1010 * type of the type casted to. Example: (A)((B2) (new C())).
1011 * transitive: Cast operations conform with the transitive inheritance
1012 * relation. Example: (A)(new C()).
1013 * any: Cast operations do not conform with the transitive inheritance
1014 * relation. Example: (B2)(new B1())
1016 * Flags for class cast state.
1018 * The state in irp is always smaller or equal to the state of any
1021 * We rely on the ordering of the enum. */
1023 ir_class_casts_any = 0, /**< There are class casts that do not cast in conformance with
1024 the class hierarchy. @@@ So far this does not happen in Firm. */
1025 ir_class_casts_transitive = 1, /**< Class casts conform to transitive inheritance edges. Default. */
1026 ir_class_casts_normalized = 2, /**< Class casts conform to inheritance edges. */
1027 ir_class_casts_state_max
1028 } ir_class_cast_state;
1030 /** Sets class cast state for graph @p irg to @p state. */
1031 FIRM_API void set_irg_class_cast_state(ir_graph *irg,
1032 ir_class_cast_state state);
1033 /** Returns class cast state for graph @p irg. */
1034 FIRM_API ir_class_cast_state get_irg_class_cast_state(const ir_graph *irg);
1035 /** Sets class cast state for the whole program to @p state. */
1036 FIRM_API void set_irp_class_cast_state(ir_class_cast_state state);
1037 /** Returns class cast state for the whole program. */
1038 FIRM_API ir_class_cast_state get_irp_class_cast_state(void);
1043 * @return non-zero if no errors were found
1045 FIRM_API int check_type(const ir_type *tp);
1048 * Walks the type information and performs a set of sanity checks.
1050 * Currently, the following checks are executed:
1051 * - values of initialized entities must be allocated on the constant IRG
1052 * - class types: doesn't have NULL members
1053 * - class types: all overwrites are existent in the super type
1055 * @return 0 if no error encountered
1057 FIRM_API int tr_verify(void);
1060 * Frees the memory used by the type.
1062 * Removes the type from the type list and frees all entities
1063 * belonging to the type.
1065 FIRM_API void free_type(ir_type *tp);
1067 /** Returns type opcode of type @p tp */
1068 FIRM_API const tp_op *get_type_tpop(const ir_type *tp);
1069 /** Returns name identifier of type opcode of type @p tp */
1070 FIRM_API ident *get_type_tpop_nameid(const ir_type *tp);
1071 /** Returns name of type opcode of type @p tp */
1072 FIRM_API const char *get_type_tpop_name(const ir_type *tp);
1073 /** Returns opcode of type opcode of type @p tp */
1074 FIRM_API tp_opcode get_type_tpop_code(const ir_type *tp);
1077 * construct a string representing the type.
1078 * This uses the info retrieved by the type_dbg_info if available.
1079 * Otherwise it tries to create an approximate textual representation of the
1081 * Keep in mind that this representation is not unique for each type,
1082 * might abstract away some details. The main intention of this is creating
1083 * human redable strings giving an idea of the type.
1085 FIRM_API void ir_print_type(char *buffer, size_t buffer_size,
1088 /** The state of the type layout. */
1090 layout_undefined, /**< The layout of this type is not defined.
1091 Address computation to access fields is not
1092 possible, fields must be accessed by Sel
1093 nodes. Enumeration constants might be undefined.
1094 This is the default value except for
1095 pointer, primitive and method types. */
1096 layout_fixed /**< The layout is fixed, all component/member entities
1097 have an offset assigned. Size of the type is known.
1098 Arrays can be accessed by explicit address
1099 computation. Enumeration constants must be defined.
1100 Default for pointer, primitive and method types. */
1103 /** Returns a human readable string for the enum entry. */
1104 FIRM_API const char *get_type_state_name(ir_type_state s);
1106 /** Returns the type layout state of a type. */
1107 FIRM_API ir_type_state get_type_state(const ir_type *tp);
1109 /** Sets the type layout state of a type.
1111 * For primitives, pointer and method types the layout is always fixed.
1112 * This call is legal but has no effect.
1114 FIRM_API void set_type_state(ir_type *tp, ir_type_state state);
1116 /** Returns the mode of a type.
1118 * Returns NULL for all non atomic types.
1120 FIRM_API ir_mode *get_type_mode(const ir_type *tp);
1122 /** Sets the mode of a type.
1124 * Only has an effect on primitive, enumeration and pointer types.
1126 FIRM_API void set_type_mode(ir_type *tp, ir_mode* m);
1128 /** Returns the size of a type in bytes. */
1129 FIRM_API unsigned get_type_size_bytes(const ir_type *tp);
1131 /** Sets the size of a type in bytes.
1133 * For primitive, enumeration, pointer and method types the size
1134 * is always fixed. This call is legal but has no effect.
1136 FIRM_API void set_type_size_bytes(ir_type *tp, unsigned size);
1138 /** Returns the alignment of a type in bytes. */
1139 FIRM_API unsigned get_type_alignment_bytes(ir_type *tp);
1141 /** Sets the alignment of a type in bytes.
1143 * If the alignment of a type is
1144 * not set, it is calculated here according to the following rules:
1145 * -#.) if a type has a mode, the alignment is the mode size.
1146 * -#.) compound types have the alignment of their biggest member.
1147 * -#.) array types have the alignment of their element type.
1148 * -#.) method types return 0 here.
1149 * -#.) all other types return 1 here (i.e. aligned at byte).
1151 FIRM_API void set_type_alignment_bytes(ir_type *tp, unsigned align);
1153 /** Returns the visited counter of a type.
1154 * @see @ref visited_counters */
1155 FIRM_API ir_visited_t get_type_visited(const ir_type *tp);
1156 /** Sets the visited counter of a type to num.
1157 * @see @ref visited_counters */
1158 FIRM_API void set_type_visited(ir_type *tp, ir_visited_t num);
1159 /** Sets visited field in type to type_visited.
1160 * @see @ref visited_counters */
1161 FIRM_API void mark_type_visited(ir_type *tp);
1162 /** Returns non-zero if the type is already visited
1163 * @see @ref visited_counters */
1164 FIRM_API int type_visited(const ir_type *tp);
1165 /** Returns non-zero if the type is not yet visited
1166 * @see @ref visited_counters */
1167 FIRM_API int type_not_visited(const ir_type *tp);
1169 /** Returns the associated link field of a type. */
1170 FIRM_API void *get_type_link(const ir_type *tp);
1171 /** Sets the associated link field of a type. */
1172 FIRM_API void set_type_link(ir_type *tp, void *l);
1174 /** Increments type visited reference counter by one.
1175 * @see @ref visited_counters, mark_type_visited(), type_visited() */
1176 FIRM_API void inc_master_type_visited(void);
1177 /** Sets type visited reference counter.
1178 * @see @ref visited_counters */
1179 FIRM_API void set_master_type_visited(ir_visited_t val);
1180 /** Returns type visited reference counter.
1181 * @see @ref visited_counters */
1182 FIRM_API ir_visited_t get_master_type_visited(void);
1185 * Sets the debug information of a type.
1187 * @param tp The type.
1188 * @param db The debug info.
1190 FIRM_API void set_type_dbg_info(ir_type *tp, type_dbg_info *db);
1193 * Returns the debug information of a type.
1195 * @param tp The type.
1197 FIRM_API type_dbg_info *get_type_dbg_info(const ir_type *tp);
1200 * Checks whether a pointer points to a type.
1202 * @param thing an arbitrary pointer
1205 * true if the thing is a type, else false
1207 FIRM_API int is_type(const void *thing);
1210 * Outputs a unique number for this type if libfirm is compiled for
1211 * debugging, (configure with --enable-debug) else returns the address
1212 * of the type cast to long.
1214 FIRM_API long get_type_nr(const ir_type *tp);
1217 * Checks whether two types are structurally equal.
1219 * @param typ1 the first type
1220 * @param typ2 the second type
1223 * true if the types are equal, else false.
1225 * Types are equal if :
1226 * - they are the same type kind
1227 * - they have the same name
1228 * - they have the same mode (if applicable)
1229 * - they have the same type_state and, ev., the same size
1230 * - they are class types and have:
1231 * - the same members (see same_entity in entity.h)
1232 * - the same supertypes -- the C-pointers are compared --> no recursive call.
1233 * - the same number of subtypes. Subtypes are not compared,
1234 * as this could cause a cyclic test.
1235 * - they are structure types and have the same members
1236 * - they are method types and have
1237 * - the same parameter types
1238 * - the same result types
1239 * - they are union types and have the same members
1240 * - they are array types and have
1241 * - the same number of dimensions
1242 * - the same dimension bounds
1243 * - the same dimension order
1244 * - the same element type
1245 * - they are enumeration types and have the same enumerator names
1246 * - they are pointer types and have the identical points_to type
1247 * (i.e., the same C-struct to represent the type.
1248 * This is to avoid endless recursions; with pointer types cyclic
1249 * type graphs are possible.)
1251 FIRM_API int equal_type(ir_type *typ1, ir_type *typ2);
1254 * Checks whether two types are structural comparable.
1256 * @param st pointer type
1257 * @param lt pointer type
1260 * true if type st is smaller than type lt, i.e. whenever
1261 * lt is expected a st can be used.
1263 * - they are the same type kind
1264 * - mode(st) < mode (lt) (if applicable)
1265 * - they are class types and st is (transitive) subtype of lt,
1266 * - they are structure types and
1267 * - the members of st have exactly one counterpart in lt with the same name,
1268 * - the counterpart has a bigger type.
1269 * - they are method types and have
1270 * - the same number of parameter and result types,
1271 * - the parameter types of st are smaller than those of lt,
1272 * - the result types of st are smaller than those of lt
1273 * - they are union types and have the members of st have exactly one
1274 * @return counterpart in lt and the type is smaller
1275 * - they are array types and have
1276 * - the same number of dimensions
1277 * - all bounds of lt are bound of st
1278 * - the same dimension order
1279 * - the same element type
1281 * - the element type of st is smaller than that of lt
1282 * - the element types have the same size and fixed layout.
1283 * - they are enumeration types and have the same enumerator names
1284 * - they are pointer types and have the points_to type of st is
1285 * @return smaller than the points_to type of lt.
1288 FIRM_API int smaller_type(ir_type *st, ir_type *lt);
1291 * @ingroup compound_type
1292 * @defgroup class_type Class
1294 * If the type opcode is set to type_class the type represents class
1295 * types. A list of fields and methods is associated with a class.
1296 * Further a class can inherit from and bequest to other classes.
1298 * The following attributes are private to this type kind:
1299 * - member: All entities belonging to this class. This are method entities
1300 * which have type_method or fields that can have any of the
1301 * following type kinds: type_class, type_struct, type_union,
1302 * type_array, type_enumeration, type_pointer, type_primitive.
1304 * The following two are dynamic lists that can be grown with an "add_" function,
1307 * - subtypes: A list of direct subclasses.
1309 * - supertypes: A list of direct superclasses.
1311 * - type_info: An entity representing the type information of this class.
1312 * This entity can be of arbitrari type, Firm did not use it yet.
1313 * It allows to express the coupling of a type with an entity
1314 * representing this type. This information is useful for lowering
1315 * of InstOf and TypeChk nodes. Default: NULL
1317 * - vtable_size: The size of this class virtual function table.
1320 * - final: A final class is always a leaf in the class hierarchy. Final
1321 * classes cannot be super classes of other ones. As this information
1322 * can only be computed in whole world compilations, we allow to
1323 * set this flag. It is used in optimizations if get_opt_closed_world()
1324 * is false. Default: false
1326 * - interface: The class represents an interface. This flag can be set to distinguish
1327 * between interfaces, abstract classes and other classes that all may
1328 * have the peculiarity peculiarity_description. Depending on this flag
1329 * the lowering might do different actions. Default: false
1331 * - abstract : The class represents an abstract class. This flag can be set to distinguish
1332 * between interfaces, abstract classes and other classes that all may
1333 * have the peculiarity peculiarity_description. Depending on this flag
1334 * the lowering might do different actions. Default: false
1338 /** Creates a new class type. */
1339 FIRM_API ir_type *new_type_class(ident *name);
1341 /** Creates a new class type with debug information. */
1342 FIRM_API ir_type *new_d_type_class(ident *name, type_dbg_info *db);
1344 /** Returns identifier of the class type */
1345 FIRM_API ident *get_class_ident(const ir_type *clss);
1347 /** Returns identifier of the class type */
1348 FIRM_API const char *get_class_name(const ir_type *clss);
1350 /** Returns the number of members of this class. */
1351 FIRM_API size_t get_class_n_members(const ir_type *clss);
1353 /** Returns the member at position pos, 0 <= pos < n_member */
1354 FIRM_API ir_entity *get_class_member(const ir_type *clss, size_t pos);
1357 * Special index returned when get_class_member_index() cannot find a member.
1358 * This index is never used for actual members.
1360 #define INVALID_MEMBER_INDEX ((size_t)-1)
1362 /** Returns index of mem in clss, INVALID_MEMBER_INDEX if not contained. */
1363 FIRM_API size_t get_class_member_index(const ir_type *clss, ir_entity *mem);
1365 /** Finds the member with name 'name'. If several members with the same
1366 * name returns one of them. Returns NULL if no member found. */
1367 FIRM_API ir_entity *get_class_member_by_name(ir_type *clss, ident *name);
1369 /** Adds subtype as subtype to clss.
1371 * Checks whether clss is a supertype of subtype. If not
1372 * adds also clss as supertype to subtype. */
1373 FIRM_API void add_class_subtype(ir_type *clss, ir_type *subtype);
1375 /** Returns the number of subtypes */
1376 FIRM_API size_t get_class_n_subtypes(const ir_type *clss);
1378 /** Returns the subtype at position pos, 0 <= pos < n_subtype. */
1379 FIRM_API ir_type *get_class_subtype(ir_type *clss, size_t pos);
1381 /** Returns the index to access subclass as subtype of class.
1383 * If subclass is no direct subtype of class returns -1.
1385 FIRM_API size_t get_class_subtype_index(ir_type *clss, const ir_type *subclass);
1387 /** Sets the subtype at position pos, 0 <= pos < n_subtype.
1389 * Does not set the corresponding supertype relation for subtype: this might
1390 * be a different position! */
1391 FIRM_API void set_class_subtype(ir_type *clss, ir_type *subtype, size_t pos);
1393 /** Finds subtype in the list of subtypes and removes it */
1394 FIRM_API void remove_class_subtype(ir_type *clss, ir_type *subtype);
1396 /** Adds supertype as supertype to class.
1398 * Checks whether clss is a subtype of supertype. If not
1399 * adds also clss as subtype to supertype. */
1400 FIRM_API void add_class_supertype(ir_type *clss, ir_type *supertype);
1402 /** Returns the number of supertypes */
1403 FIRM_API size_t get_class_n_supertypes(const ir_type *clss);
1405 /** Returns the index to access superclass as supertype of class.
1407 * If superclass is no direct supertype of class returns -1.
1409 FIRM_API size_t get_class_supertype_index(ir_type *clss, ir_type *super_clss);
1411 /** Returns the supertype at position pos, 0 <= pos < n_supertype. */
1412 FIRM_API ir_type *get_class_supertype(ir_type *clss, size_t pos);
1414 /** Sets the supertype at position pos, 0 <= pos < n_supertype.
1416 * Does not set the corresponding subtype relation for supertype: this might
1417 * be at a different position! */
1418 FIRM_API void set_class_supertype(ir_type *clss, ir_type *supertype, size_t pos);
1420 /** Finds supertype in the list of supertypes and removes it */
1421 FIRM_API void remove_class_supertype(ir_type *clss, ir_type *supertype);
1423 /** Returns the type info entity of a class. */
1424 FIRM_API ir_entity *get_class_type_info(const ir_type *clss);
1426 /** Sets a type info entity for the class. */
1427 FIRM_API void set_class_type_info(ir_type *clss, ir_entity *ent);
1429 /** Returns the size of the virtual function table. */
1430 FIRM_API unsigned get_class_vtable_size(const ir_type *clss);
1432 /** Sets a new size of the virtual function table. */
1433 FIRM_API void set_class_vtable_size(ir_type *clss, unsigned size);
1435 /** Returns non-zero if a class is final. */
1436 FIRM_API int is_class_final(const ir_type *clss);
1438 /** Sets the class final flag. */
1439 FIRM_API void set_class_final(ir_type *clss, int flag);
1441 /** Returns non-zero if a class is an interface */
1442 FIRM_API int is_class_interface(const ir_type *clss);
1444 /** Sets the class interface flag. */
1445 FIRM_API void set_class_interface(ir_type *clss, int flag);
1447 /** Returns non-zero if a class is an abstract class. */
1448 FIRM_API int is_class_abstract(const ir_type *clss);
1450 /** Sets the class abstract flag. */
1451 FIRM_API void set_class_abstract(ir_type *clss, int flag);
1453 /** Returns true if a type is a class type. */
1454 FIRM_API int is_Class_type(const ir_type *clss);
1457 * This type opcode marks that the corresponding type is a class type.
1459 * Consequently the type refers to supertypes, subtypes and entities.
1460 * Entities can be any fields, but also methods.
1461 * This struct is dynamically allocated but constant for the lifetime
1464 FIRM_API const tp_op *type_class;
1465 /** Returns type opcode for class type. @see type_class */
1466 FIRM_API const tp_op *get_tpop_class(void);
1470 /** @ingroup compound_type
1471 * @defgroup struct_type Struct
1473 * A struct type represents aggregate types that consist of a list
1476 * The following attributes are private to this type kind:
1477 * - member: All entities belonging to this class. This are the fields
1478 * that can have any of the following types: type_class,
1479 * type_struct, type_union, type_array, type_enumeration,
1480 * type_pointer, type_primitive.
1481 * This is a dynamic list that can be grown with an "add_" function,
1483 * This is a dynamic list that can be grown with an "add_" function,
1488 /** Creates a new type struct */
1489 FIRM_API ir_type *new_type_struct(ident *name);
1490 /** Creates a new type struct with debug information. */
1491 FIRM_API ir_type *new_d_type_struct(ident *name, type_dbg_info* db);
1493 /** Returns struct identifier */
1494 FIRM_API ident *get_struct_ident(const ir_type *strct);
1496 /** Returns struct identifier as c-string*/
1497 FIRM_API const char *get_struct_name(const ir_type *strct);
1499 /** Returns the number of members of this struct. */
1500 FIRM_API size_t get_struct_n_members(const ir_type *strct);
1502 /** Returns the member at position pos, pos < n_member */
1503 FIRM_API ir_entity *get_struct_member(const ir_type *strct, size_t pos);
1505 /** Returns index of member in strct, -1 if not contained. */
1506 FIRM_API size_t get_struct_member_index(const ir_type *strct, ir_entity *member);
1508 /** Returns true if a type is a struct type. */
1509 FIRM_API int is_Struct_type(const ir_type *strct);
1512 * This type opcode marks that the corresponding type is a compound type
1515 * Consequently the type refers to a list of entities
1516 * which may not be methods (but pointers to methods).
1517 * This struct is dynamically allocated but constant for the lifetime
1520 FIRM_API const tp_op *type_struct;
1521 /** Returns type opcode for struct type. @see type_struct */
1522 FIRM_API const tp_op *get_tpop_struct(void);
1527 * @ingroup compound_type
1528 * @defgroup union_type Union
1530 * The union type represents union types. Note that this representation
1531 * resembles the C union type. For tagged variant types like in Pascal or
1532 * Modula a combination of a struct and a union type must be used.
1534 * - n_types: Number of unioned types.
1535 * - members: Entities for unioned types. Fixed length array.
1536 * This is a dynamic list that can be grown with an "add_"
1537 * function, but not shrinked.
1540 /** Creates a new type union. */
1541 FIRM_API ir_type *new_type_union(ident *name);
1543 /** Creates a new type union with debug information. */
1544 FIRM_API ir_type *new_d_type_union(ident *name, type_dbg_info* db);
1547 /** Returns union identifier */
1548 FIRM_API ident *get_union_ident(const ir_type *uni);
1550 /** Returns union identifier as c-string */
1551 FIRM_API const char *get_union_name(const ir_type *uni);
1553 /** Returns the number of unioned types of this union */
1554 FIRM_API size_t get_union_n_members(const ir_type *uni);
1556 /** Returns the entity at position pos of a union */
1557 FIRM_API ir_entity *get_union_member(const ir_type *uni, size_t pos);
1559 /** Returns index of member in uni, -1 if not contained. */
1560 FIRM_API size_t get_union_member_index(const ir_type *uni, ir_entity *member);
1562 /** Returns true if a type is a union type. */
1563 FIRM_API int is_Union_type(const ir_type *uni);
1566 * This type opcode marks that the corresponding type is a union type.
1568 * Consequently it refers to a list of unioned types.
1569 * This struct is dynamically allocated but constant for the lifetime
1572 FIRM_API const tp_op *type_union;
1573 /** Returns type opcode for union type. @see type_union */
1574 FIRM_API const tp_op *get_tpop_union(void);
1579 * @defgroup method_type Method
1581 * A method type represents a method, function or procedure type.
1582 * It contains a list of the parameter and result types, as these
1583 * are part of the type description. These lists should not
1584 * be changed by a optimization, as a change creates a new method
1585 * type. Therefore optimizations should allocated new method types.
1586 * The set_ routines are only for construction by a frontend.
1588 * - n_params: Number of parameters to the procedure.
1589 * A procedure in FIRM has only call by value parameters.
1591 * - param_type: A list with the types of parameters. This list is ordered.
1592 * The nth type in this list corresponds to the nth element
1593 * in the parameter tuple that is a result of the start node.
1594 * (See ircons.h for more information.)
1596 * - value_param_ents
1597 * A list of entities (whose owner is a struct private to the
1598 * method type) that represent parameters passed by value.
1600 * - n_res: The number of results of the method. In general, procedures
1601 * have zero results, functions one.
1603 * - res_type: A list with the types of parameters. This list is ordered.
1604 * The nth type in this list corresponds to the nth input to
1605 * Return nodes. (See ircons.h for more information.)
1609 /** Create a new method type.
1611 * @param n_param the number of parameters
1612 * @param n_res the number of results
1614 * The arrays for the parameter and result types are not initialized by
1617 FIRM_API ir_type *new_type_method(size_t n_param, size_t n_res);
1619 /** Create a new method type with debug information.
1621 * @param n_param the number of parameters
1622 * @param n_res the number of results
1623 * @param db user defined debug information
1625 * The arrays for the parameter and result types are not initialized by
1628 FIRM_API ir_type *new_d_type_method(size_t n_param, size_t n_res,
1631 /** Returns the number of parameters of this method. */
1632 FIRM_API size_t get_method_n_params(const ir_type *method);
1634 /** Returns the type of the parameter at position pos of a method. */
1635 FIRM_API ir_type *get_method_param_type(const ir_type *method, size_t pos);
1636 /** Sets the type of the parameter at position pos of a method.
1637 * Note: does not change the corresponding parameter entities (if there are any)
1639 FIRM_API void set_method_param_type(ir_type *method, size_t pos, ir_type *tp);
1640 /** Returns the number of results of a method type. */
1641 FIRM_API size_t get_method_n_ress(const ir_type *method);
1642 /** Returns the return type of a method type at position pos. */
1643 FIRM_API ir_type *get_method_res_type(const ir_type *method, size_t pos);
1644 /** Sets the type of the result at position pos of a method. */
1645 FIRM_API void set_method_res_type(ir_type *method, size_t pos, ir_type *tp);
1648 * This enum flags the variadicity of methods (methods with a
1649 * variable amount of arguments (e.g. C's printf). Default is
1652 typedef enum ir_variadicity {
1653 variadicity_non_variadic, /**< non variadic */
1654 variadicity_variadic /**< variadic */
1657 /** Returns the null-terminated name of this variadicity. */
1658 FIRM_API const char *get_variadicity_name(ir_variadicity vari);
1660 /** Returns the variadicity of a method. */
1661 FIRM_API ir_variadicity get_method_variadicity(const ir_type *method);
1663 /** Sets the variadicity of a method. */
1664 FIRM_API void set_method_variadicity(ir_type *method, ir_variadicity vari);
1666 /** Returns the mask of the additional graph properties. */
1667 FIRM_API mtp_additional_properties get_method_additional_properties(const ir_type *method);
1669 /** Sets the mask of the additional graph properties. */
1670 FIRM_API void set_method_additional_properties(ir_type *method,
1671 mtp_additional_properties property_mask);
1673 /** Sets one additional graph property. */
1674 FIRM_API void add_method_additional_properties(ir_type *method,
1675 mtp_additional_properties flag);
1678 * Calling conventions: lower 24 bits are the number of register parameters,
1679 * upper 8 encode the calling conventions.
1682 cc_reg_param = 0x01000000, /**< Transmit parameters in registers, else the stack is used.
1683 This flag may be set as default on some architectures. */
1684 cc_last_on_top = 0x02000000, /**< The last non-register parameter is transmitted on top of
1685 the stack. This is equivalent to the pascal
1686 calling convention. If this flag is not set, the first
1687 non-register parameter is used (stdcall or cdecl
1688 calling convention) */
1689 cc_callee_clear_stk = 0x04000000, /**< The callee clears the stack. This forbids variadic
1690 function calls (stdcall). */
1691 cc_this_call = 0x08000000, /**< The first parameter is a this pointer and is transmitted
1692 in a special way. */
1693 cc_compound_ret = 0x10000000, /**< The method returns a compound type. */
1694 cc_frame_on_caller_stk = 0x20000000, /**< The method did not allocate an own stack frame, instead the
1695 caller must reserve size on its own stack. */
1696 cc_fpreg_param = 0x40000000, /**< Transmit floating point parameters in registers, else the stack is used. */
1697 cc_bits = (0xFF << 24)/**< The calling convention bits. */
1698 } calling_convention;
1700 /** cdecl calling convention */
1701 #define cc_cdecl_set (0)
1702 /** stdcall calling convention */
1703 #define cc_stdcall_set cc_callee_clear_stk
1704 /** fastcall calling convention */
1705 #define cc_fastcall_set (cc_reg_param|cc_callee_clear_stk)
1708 * check for the CDECL calling convention
1710 #define IS_CDECL(cc_mask) (((cc_mask) & cc_bits) == cc_cdecl_set)
1713 * check for the STDCALL calling convention
1715 #define IS_STDCALL(cc_mask) (((cc_mask) & cc_bits) == cc_stdcall_set)
1718 * check for the FASTCALL calling convention
1720 #define IS_FASTCALL(cc_mask) (((cc_mask) & cc_bits) == cc_fastcall_set)
1723 * Sets the CDECL convention bits.
1725 #define SET_CDECL(cc_mask) (((cc_mask) & ~cc_bits) | cc_cdecl_set)
1728 * Sets the STDCALL convention bits.
1730 #define SET_STDCALL(cc_mask) (((cc_mask) & ~cc_bits) | cc_stdcall_set)
1733 * Sets the FASTCALL convention bits.
1735 #define SET_FASTCALL(cc_mask) (((cc_mask) & ~cc_bits) | cc_fastcall_set)
1737 /** Returns the calling convention of an entities graph. */
1738 FIRM_API unsigned get_method_calling_convention(const ir_type *method);
1740 /** Sets the calling convention of an entities graph. */
1741 FIRM_API void set_method_calling_convention(ir_type *method, unsigned cc_mask);
1743 /** Returns the number of registers parameters, 0 means default. */
1744 FIRM_API unsigned get_method_n_regparams(ir_type *method);
1746 /** Sets the number of registers parameters, 0 means default. */
1747 FIRM_API void set_method_n_regparams(ir_type *method, unsigned n_regs);
1749 /** Returns true if a type is a method type. */
1750 FIRM_API int is_Method_type(const ir_type *method);
1753 * This type opcode marks that the corresponding type is a method type.
1755 * Consequently it refers to a list of arguments and results.
1756 * This struct is dynamically allocated but constant for the lifetime
1759 FIRM_API const tp_op *type_method;
1760 /** Returns type opcode for method type @see type_method */
1761 FIRM_API const tp_op *get_tpop_method(void);
1766 * @defgroup array_type Array
1768 * The array type represents rectangular multi dimensional arrays.
1769 * The constants representing the bounds must be allocated to
1770 * get_const_code_irg() by setting current_ir_graph accordingly.
1772 * - n_dimensions: Number of array dimensions.
1773 * - *lower_bound: Lower bounds of dimensions. Usually all 0.
1774 * - *upper_bound: Upper bounds or dimensions.
1775 * - *element_type: The type of the array elements.
1776 * - *element_ent: An entity for the array elements to be used for
1777 * element selection with Sel.
1781 /** Create a new type array.
1783 * Sets n_dimension to dimension and all dimension entries to NULL.
1784 * Initializes order to the order of the dimensions.
1785 * The entity for array elements is built automatically.
1786 * Sets dimension sizes after call to constructor with set_* routines.
1788 FIRM_API ir_type *new_type_array(size_t n_dims, ir_type *element_type);
1790 /** Create a new type array with debug information.
1792 * Sets n_dimension to dimension and all dimension entries to NULL.
1793 * Initializes order to the order of the dimensions.
1794 * The entity for array elements is built automatically.
1795 * Sets dimension sizes after call to constructor with set_* routines.
1796 * A legal array type must have at least one dimension set.
1798 FIRM_API ir_type *new_d_type_array(size_t n_dims, ir_type *element_type,
1802 /** Returns the number of array dimensions of this type. */
1803 FIRM_API size_t get_array_n_dimensions(const ir_type *array);
1806 * Allocates Const nodes of mode_Is for one array dimension.
1807 * Upper bound in Firm is the element next to the last, i.e. [lower,upper[
1809 FIRM_API void set_array_bounds_int(ir_type *array, size_t dimension,
1810 int lower_bound, int upper_bound);
1812 * Sets the bounds for one array dimension.
1813 * Upper bound in Firm is the element next to the last, i.e. [lower,upper[
1815 FIRM_API void set_array_bounds(ir_type *array, size_t dimension,
1816 ir_node *lower_bound, ir_node *upper_bound);
1817 /** Sets the lower bound for one array dimension, i.e. [lower,upper[ */
1818 FIRM_API void set_array_lower_bound(ir_type *array, size_t dimension,
1819 ir_node *lower_bound);
1821 /** Allocates Const nodes of mode_Is for the lower bound of an array
1822 dimension, i.e. [lower,upper[ */
1823 FIRM_API void set_array_lower_bound_int(ir_type *array, size_t dimension,
1826 /** Sets the upper bound for one array dimension, i.e. [lower,upper[ */
1827 FIRM_API void set_array_upper_bound(ir_type *array, size_t dimension,
1828 ir_node *upper_bound);
1830 /** Allocates Const nodes of mode_Is for the upper bound of an array
1831 dimension, i.e. [lower,upper[. */
1832 FIRM_API void set_array_upper_bound_int(ir_type *array, size_t dimension,
1835 /** Returns true if lower bound != Unknown. */
1836 FIRM_API int has_array_lower_bound(const ir_type *array, size_t dimension);
1837 /** Returns the lower bound of an array. */
1838 FIRM_API ir_node *get_array_lower_bound(const ir_type *array, size_t dimension);
1839 /** Works only if bound is Const node with tarval that can be converted to long. */
1840 FIRM_API long get_array_lower_bound_int(const ir_type *array, size_t dimension);
1841 /** returns true if lower bound != Unknown */
1842 FIRM_API int has_array_upper_bound(const ir_type *array, size_t dimension);
1843 /** Returns the upper bound of an array. */
1844 FIRM_API ir_node *get_array_upper_bound(const ir_type *array, size_t dimension);
1845 /** Works only if bound is Const node with tarval that can be converted to long. */
1846 FIRM_API long get_array_upper_bound_int(const ir_type *array, size_t dimension);
1848 /** Sets an array dimension to a specific order. */
1849 FIRM_API void set_array_order(ir_type *array, size_t dimension, size_t order);
1851 /** Returns the order of an array dimension. */
1852 FIRM_API size_t get_array_order(const ir_type *array, size_t dimension);
1854 /** Find the array dimension that is placed at order order. */
1855 FIRM_API size_t find_array_dimension(const ir_type *array, size_t order);
1857 /** Sets the array element type. */
1858 FIRM_API void set_array_element_type(ir_type *array, ir_type *tp);
1860 /** Returns the array element type. */
1861 FIRM_API ir_type *get_array_element_type(const ir_type *array);
1863 /** Sets the array element entity. */
1864 FIRM_API void set_array_element_entity(ir_type *array, ir_entity *ent);
1866 /** Returns the array element entity. */
1867 FIRM_API ir_entity *get_array_element_entity(const ir_type *array);
1870 * Sets the array variable size flag.
1871 * If this flag is set then no upper/lower bounds need to be set and
1872 * get_type_size_bytes() returns -1
1874 FIRM_API void set_array_variable_size(ir_type *array, int variable_size_flag);
1877 * Returns the array variable size flag.
1878 * @see set_array_variable_size()
1880 FIRM_API int is_array_variable_size(const ir_type *array);
1882 /** Returns true if a type is an array type. */
1883 FIRM_API int is_Array_type(const ir_type *array);
1886 * This type opcode marks that the corresponding type is an array type.
1888 * Consequently it contains a list of dimensions (lower and upper bounds)
1889 * and an element type.
1890 * This struct is dynamically allocated but constant for the lifetime
1893 FIRM_API const tp_op *type_array;
1894 /** Returns type opcode for array type. @see type_array */
1895 FIRM_API const tp_op *get_tpop_array(void);
1900 * @defgroup enumeration_type Enumeration
1902 * Enumeration types need not necessarily be represented explicitly
1903 * by Firm types, as the frontend can lower them to integer constants as
1904 * well. For debugging purposes or similar tasks this information is useful.
1905 * The type state layout_fixed is set, if all enumeration constants have
1906 * their tarvals assigned. Until then
1908 * - *const: The target values representing the constants used to
1909 * represent individual enumerations.
1913 /** Create a new type enumeration -- set the enumerators independently. */
1914 FIRM_API ir_type *new_type_enumeration(ident *name, size_t n_enums);
1916 /** Create a new type enumeration with debug information -- set the enumerators independently. */
1917 FIRM_API ir_type *new_d_type_enumeration(ident *name, size_t n_enums,
1921 /** Returns enumeration identifier */
1922 FIRM_API ident *get_enumeration_ident(const ir_type *enumeration);
1924 /** Returns enumeration identifier as c-string */
1925 FIRM_API const char *get_enumeration_name(const ir_type *enumeration);
1927 /** Sets an enumeration constant to a enumeration type at a given position. */
1928 FIRM_API void set_enumeration_const(ir_type *enumeration, size_t pos,
1929 ident *nameid, ir_tarval *con);
1931 /** Returns the number of enumeration values of this enumeration */
1932 FIRM_API size_t get_enumeration_n_enums(const ir_type *enumeration);
1934 /** Returns the enumeration constant at a given position. */
1935 FIRM_API ir_enum_const *get_enumeration_const(const ir_type *enumeration,
1938 /** Returns the enumeration type owner of an enumeration constant. */
1939 FIRM_API ir_type *get_enumeration_owner(const ir_enum_const *enum_cnst);
1941 /** Sets the enumeration constant value. */
1942 FIRM_API void set_enumeration_value(ir_enum_const *enum_cnst, ir_tarval *con);
1944 /** Returns the enumeration constant value. */
1945 FIRM_API ir_tarval *get_enumeration_value(const ir_enum_const *enum_cnst);
1947 /** Assign an ident to an enumeration constant. */
1948 FIRM_API void set_enumeration_nameid(ir_enum_const *enum_cnst, ident *id);
1950 /** Returns the assigned ident of an enumeration constant. */
1951 FIRM_API ident *get_enumeration_const_nameid(const ir_enum_const *enum_cnst);
1953 /** Returns the assigned name of an enumeration constant. */
1954 FIRM_API const char *get_enumeration_const_name(const ir_enum_const *enum_cnst);
1956 /** Returns true if a type is a enumeration type. */
1957 FIRM_API int is_Enumeration_type(const ir_type *enumeration);
1960 * This type opcode marks that the corresponding type is an enumeration type.
1962 * Consequently it contains a list of idents for the enumeration identifiers
1963 * and a list of target values that are the constants used to implement
1965 * This struct is dynamically allocated but constant for the lifetime
1968 FIRM_API const tp_op *type_enumeration;
1969 /** Returns type opcode for enumeration type. @see type_enumeration */
1970 FIRM_API const tp_op *get_tpop_enumeration(void);
1975 * @defgroup pointer_type Pointer
1978 * - points_to: The type this pointer points to.
1982 /** Creates a new type pointer. */
1983 FIRM_API ir_type *new_type_pointer(ir_type *points_to);
1985 /** Creates a new type pointer with debug information. */
1986 FIRM_API ir_type *new_d_type_pointer(ir_type *points_to, type_dbg_info* db);
1989 /** Sets the type to which a pointer points to. */
1990 FIRM_API void set_pointer_points_to_type(ir_type *pointer, ir_type *tp);
1992 /** Returns the type to which a pointer points to. */
1993 FIRM_API ir_type *get_pointer_points_to_type(const ir_type *pointer);
1995 /** Returns true if a type is a pointer type. */
1996 FIRM_API int is_Pointer_type(const ir_type *pointer);
1998 /** Returns the first pointer type that has as points_to tp.
1999 * Not efficient: O(\#types).
2000 * If not found returns firm_unknown_type. */
2001 FIRM_API ir_type *find_pointer_type_to_type(ir_type *tp);
2004 * This type opcode marks that the corresponding type is a pointer type.
2006 * It contains a reference to the type the pointer points to.
2007 * This struct is dynamically allocated but constant for the lifetime
2010 FIRM_API const tp_op *type_pointer;
2011 /** Returns type opcode for pointer type. @see type_pointer */
2012 FIRM_API const tp_op *get_tpop_pointer(void);
2017 * @defgroup primitive_type Primitive
2019 * Primitive types are types that represent atomic data values that
2020 * map directly to modes. They don't have private attributes. The
2021 * important information they carry is held in the common mode field.
2024 /** Creates a new primitive type. */
2025 FIRM_API ir_type *new_type_primitive(ir_mode *mode);
2027 /** Creates a new primitive type with debug information. */
2028 FIRM_API ir_type *new_d_type_primitive(ir_mode *mode, type_dbg_info* db);
2030 /** Returns true if a type is a primitive type. */
2031 FIRM_API int is_Primitive_type(const ir_type *primitive);
2033 /** Returns the base type of a primitive (bitfield) type or NULL if none. */
2034 FIRM_API ir_type *get_primitive_base_type(const ir_type *tp);
2036 /** Sets the base type of a primitive (bitfield) type. */
2037 FIRM_API void set_primitive_base_type(ir_type *tp, ir_type *base_tp);
2040 * This type opcode marks that the corresponding type is a primitive type.
2042 * Primitive types are types that are directly mapped to target machine
2044 * This struct is dynamically allocated but constant for the lifetime
2047 FIRM_API const tp_op *type_primitive;
2048 /** Returns type opcode for primitive type. @see type_primitive */
2049 FIRM_API const tp_op *get_tpop_primitive(void);
2054 * @defgroup none_type None
2056 * This type is an auxiliary type dedicated to support type analyses.
2058 * The none type represents that there is no type. The type can be used to
2059 * initialize fields of type* that actually can not contain a type or that
2060 * are initialized for an analysis. There exists exactly one type none.
2061 * This type is not on the type list in ir_prog. It is
2062 * allocated when initializing the type module.
2064 * The following values are set:
2066 * - name: "type_none"
2067 * - state: layout_fixed
2071 /** Returns the none type. */
2072 FIRM_API ir_type *get_none_type(void);
2073 /** Checks whether type @p type is the none type. */
2074 FIRM_API int is_none_type(const ir_type *type);
2076 * This type opcode is an auxiliary opcode dedicated to support type analyses.
2078 * Types with this opcode represents that there is no type.
2079 * The type can be used to initialize fields of the type* that actually can not
2080 * contain a type or that are initialized for an analysis. There exists exactly
2081 * one type with this opcode.
2083 FIRM_API const tp_op *tpop_none;
2084 /** Returns type opcode for none type. @see tpop_none */
2085 FIRM_API const tp_op *get_tpop_none(void);
2088 /** @defgroup code_type Code
2091 /** Returns the code type. */
2092 FIRM_API ir_type *get_code_type(void);
2094 * Checks whether a type is a code type.
2096 FIRM_API int is_code_type(const ir_type *tp);
2098 * The code type is used to mark pieces of code (basic blocks)
2100 FIRM_API const tp_op *tpop_code;
2101 /** Returns type opcode for code type. @see tpop_code */
2102 FIRM_API const tp_op *get_tpop_code_type(void);
2106 * @defgroup unknown_type Unknown
2108 * This type is an auxiliary type dedicated to support type analyses.
2110 * The unknown type represents that there could be a type, but it is not
2111 * known. This type can be used to initialize fields before an analysis (not known
2112 * yet) or to represent the top of a lattice (could not be determined). There exists
2113 * exactly one type unknown. This type is not on the type list in ir_prog. It is
2114 * allocated when initializing the type module.
2116 * The following values are set:
2118 * - name: "type_unknown"
2119 * - state: layout_fixed
2123 /** Returns the unknown type. */
2124 FIRM_API ir_type *get_unknown_type(void);
2125 /** Checks whether type @p type is the unknown type */
2126 FIRM_API int is_unknown_type(const ir_type *type);
2128 * This type opcode is an auxiliary opcode dedicated to support type analyses.
2130 * Types with this opcode represents that there could be a type, but it is not
2131 * known. This type can be used to initialize fields before an analysis (not known
2132 * yet) or to represent the top of a lattice (could not be determined). There exists
2133 * exactly one type with this opcode.
2135 FIRM_API const tp_op *tpop_unknown;
2136 /** Returns type opcode for unknown type. @see tpop_unknown */
2137 FIRM_API const tp_op *get_tpop_unknown(void);
2141 * Checks whether a type is atomic.
2142 * @param tp any type
2143 * @return true if type is primitive, pointer or enumeration
2145 FIRM_API int is_atomic_type(const ir_type *tp);
2148 * @defgroup compound_type Compound
2154 * Returns the identifier of a compound type
2156 FIRM_API ident *get_compound_ident(const ir_type *tp);
2158 /** Returns compound identifier as c-string */
2159 FIRM_API const char *get_compound_name(const ir_type *tp);
2162 * Returns the number of elements in a Firm compound type.
2164 * This is just a comfortability function, because structs and
2165 * classes can often be treated be the same code, but they have
2166 * different access functions to their members.
2168 * @param tp The type (must be struct, union or class).
2170 * @return Number of members in the compound type.
2172 FIRM_API size_t get_compound_n_members(const ir_type *tp);
2175 * Returns the member of a Firm compound type at position pos.
2177 * @param tp The type (must be struct, union or class).
2178 * @param pos The number of the member.
2180 * @return The member entity at position pos.
2182 FIRM_API ir_entity *get_compound_member(const ir_type *tp, size_t pos);
2184 /** Returns index of member in tp, -1 if not contained. */
2185 FIRM_API size_t get_compound_member_index(const ir_type *tp, ir_entity *member);
2187 /** Remove a member from a compound type. */
2188 FIRM_API void remove_compound_member(ir_type *compound, ir_entity *entity);
2191 * Sets the variable size flag of a compound type.
2192 * The last member of a variable size compound type may be an array type
2193 * without explicit size. So the get_type_size_bytes() of a variable size
2194 * compound type only returns a minimum size for the type (the size if the
2195 * last members size is 0)
2197 FIRM_API void set_compound_variable_size(ir_type *compound, int variable_size);
2200 * Returns the variable size flag. @see set_compound_variable_size()
2202 FIRM_API int is_compound_variable_size(const ir_type *compound);
2205 * layout members of a struct/union or class type in a default way.
2207 FIRM_API void default_layout_compound_type(ir_type *tp);
2210 * Checks whether a type is a compound type.
2212 * @param tp - any type
2214 * @return true if the type is class, structure, union or array type.
2216 FIRM_API int is_compound_type(const ir_type *tp);
2220 /** @defgroup frame_type Frame
2225 * Makes a new frame type. Frame types are class types,
2226 * so all class access functions work.
2227 * Frame types are not in the global list of types.
2229 FIRM_API ir_type *new_type_frame(void);
2232 * Checks, whether a type is a frame type.
2234 FIRM_API int is_frame_type(const ir_type *tp);
2237 * Makes a clone of a frame type.
2238 * Sets entity links from old frame entities to new onces and
2241 FIRM_API ir_type *clone_frame_type(ir_type *type);
2244 * Allocate an area of size bytes aligned at alignment
2245 * at the start or the end of a frame type.
2246 * The frame type must already have a fixed layout.
2248 * @param frame_type a frame type
2249 * @param size the size of the entity
2250 * @param alignment the alignment of the entity
2251 * @param at_start if true, put the area at the frame type's start, else at end
2253 * @return the entity representing the area
2255 FIRM_API ir_entity *frame_alloc_area(ir_type *frame_type, int size,
2256 unsigned alignment, int at_start);
2261 * @defgroup trwalk Traversing
2265 /** Type for a function that compares two types.
2267 * @param tp1 The first type to compare.
2268 * @param tp2 The second type to compare.
2270 typedef int (compare_types_func_t)(const void *tp1, const void *tp2);
2272 /** A data type to treat types and entities as the same. */
2274 ir_type *typ; /**< points to a type */
2275 ir_entity *ent; /**< points to an entity */
2278 /** Type of argument functions for type walkers.
2280 * @param tore points to the visited type or entity
2281 * @param env free environment pointer
2283 typedef void type_walk_func(type_or_ent tore, void *env);
2285 /** The class walk function
2287 * @param clss points to the visited class
2288 * @param env free environment pointer
2290 typedef void class_walk_func(ir_type *clss, void *env);
2292 /** Touches every type and entity in unspecified order. If new
2293 * types/entities are created during the traversal these will
2295 * Does not touch frame types or types for value params ... */
2296 FIRM_API void type_walk(type_walk_func *pre, type_walk_func *post, void *env);
2298 /** Walks over all type information reachable from an ir graph.
2300 * Walks over all type information reachable from irg, i.e., starts a
2301 * type walk at the irgs entity, the irgs frame type and all types and
2302 * entities that are attributes to firm nodes. */
2303 FIRM_API void type_walk_irg(ir_graph *irg, type_walk_func *pre,
2304 type_walk_func *post, void *env);
2307 * Touches every class in specified order:
2308 * - first the super class
2309 * - second the class itself
2310 * - third the sub classes. If new classes are created
2311 * during the traversal these will be visited, too.
2313 * @deprecated will be removed?
2315 FIRM_API void type_walk_super2sub(type_walk_func *pre, type_walk_func *post,
2318 /** Walker for class types in inheritance order.
2320 * Touches every class in specified order:
2321 * - first the super class
2322 * - second the class itself
2323 * If new classes are created during the traversal these
2324 * will be visited, too.
2325 * Starts the walk at arbitrary classes.
2326 * Executes pre when first visiting a class. Executes post after
2327 * visiting all superclasses.
2329 * The arguments pre, post, env may be NULL. */
2330 FIRM_API void type_walk_super(type_walk_func *pre, type_walk_func *post,
2333 /** Same as type_walk_super2sub, but visits only class types.
2334 Executes pre for a class if all superclasses have been visited.
2335 Then iterates to subclasses. Executes post after return from
2337 Does not visit global type, frame types.
2339 FIRM_API void class_walk_super2sub(class_walk_func *pre, class_walk_func *post,
2343 * the entity walk function. A function type for entity walkers.
2345 * @param ent points to the visited entity
2346 * @param env free environment pointer
2348 typedef void entity_walk_func(ir_entity *ent, void *env);
2351 * Walks over all entities in the type.
2353 * @param tp the type
2354 * @param doit the entity walker function
2355 * @param env environment, will be passed to the walker function
2357 FIRM_API void walk_types_entities(ir_type *tp, entity_walk_func *doit,
2361 * If we have the closed world assumption, we can calculate the
2362 * finalization of classes and entities by inspecting the class hierarchy.
2363 * After this is done, all classes and entities that are not overridden
2364 * anymore have the final property set.
2366 FIRM_API void types_calc_finalization(void);
2369 FIRM_API ir_visibility get_type_visibility(const ir_type *tp);
2371 FIRM_API void set_type_visibility(ir_type *tp, ir_visibility v);