/*
- * Copyright (C) 1995-2007 University of Karlsruhe. All right reserved.
+ * Copyright (C) 1995-2008 University of Karlsruhe. All right reserved.
*
* This file is part of libFirm.
*
* WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE.
*/
+
+/**
+ * @file
+ * @brief Declarations for functions and datastructures to represent types
+ */
#ifndef FIRM_TYPEREP_H
#define FIRM_TYPEREP_H
+#include <stdlib.h>
#include "firm_types.h"
+#include "begin.h"
+
/**
* @page entity Entity representation
*
*
* - owner: A compound type this entity is a part of.
* - type: The type of this entity.
- * - name: The string that represents this entity in the source program. * - allocation: A flag saying whether the entity is dynamically or statically * allocated (values: dynamic_allocated, static_allocated,
- * automatic_allocated).
- * - visibility: A flag indicating the visibility of this entity (values: local,
- * external_visible, external_allocated)
- * - variability: A flag indicating the variability of this entity (values:
- * uninitialized, initialized, part_constant, constant)
- * - volatility: @@@
+ * - name: The string that represents this entity in the source program
+ * - linkage: A flag indicating how the linker treats a symbol
* - offset: The offset of the entity within the compound object in bytes. Only set
* if the owner in the state "layout_fixed".
* - offset_bits_remainder: The offset bit remainder of a bitfield entity (in a compound)
* - link: A void* to associate some additional information with the entity.
* - irg: If the entity is a method this is the ir graph that represents the
* code of the method.
- * - peculiarity: The peculiarity of the entity. If the entity is a method this
- * indicates whether the entity represents
- * a real method or whether it only exists to describe an interface.
- * In that case there nowhere exists code for this entity and this entity
- * is never dynamically used in the code.
- * Values: description, existent. Default: existent.
* - visited: visited flag. Master flag is type_visited.
*
* These fields can only be accessed via access functions.
* @see ir_type, ir_entity
*/
-/** This enumeration flags the visibility of entities and types.
- *
- * This is necessary for partial compilation.
- * We rely on the ordering of the flags.
+/**
+ * Visibility classed for entities.
*/
typedef enum {
- visibility_local, /**< The entity is only visible locally. This is the default for
- entities.
- The type is only visible locally. All instances are allocated
- locally, and no pointer to entities of this type are passed
- out of this compilation unit. */
- visibility_external_visible, /**< The entity is visible to other external program parts, but
- it is defined here. It may not be optimized away. The entity must
- be static_allocated.
- For types: entities of this type can be accessed externally. No
- instances of this type are allocated externally. */
- visibility_external_allocated /**< The entity is defined and allocated externally. This compilation
- must not allocate memory for this entity. The entity must
- be static_allocated. This can also be an external defined
- method.
- For types: entities of this type are allocated and accessed from
- external code. Default for types. */
+ /**
+ * The entity is visible outside the compilation unit, but it is defined
+ * here.
+ */
+ ir_visibility_default,
+ /**
+ * The entity is local to the compilation unit.
+ * A local entity is not visible in other compilation units.
+ * Note that the entity might still be accessed indirectly from other units
+ * through pointers.
+ */
+ ir_visibility_local,
+ /**
+ * The entity is defined outside the compilation unit but potentially used
+ * here.
+ */
+ ir_visibility_external,
+ /**
+ * This has the same semantic as visibility_local. Additionally the symbol is
+ * completely hidden from the linker (it only appears in the assembly).
+ * While visibility_local is probably still visible to debuggers,
+ * visibility_private symbols aren't and probably won't appear in the object
+ * files
+ */
+ ir_visibility_private
} ir_visibility;
-/** This enumeration flags the peculiarity of entities and types. */
-typedef enum {
- peculiarity_description, /**< Represents only a description. The entity/type is never
- allocated, no code/data exists for this entity/type.
- @@@ eventually rename to descriptive (adjective as the others!)*/
- peculiarity_inherited, /**< Describes explicitly that other entities are
- inherited to the owner of this entity.
- Overwrites must refer to at least one other
- entity. If this is a method entity there exists
- no irg for this entity, only for one of the
- overwritten ones.
- Only for entity. */
- peculiarity_existent /**< The entity/type (can) exist.
- @@@ eventually rename to 'real' i.e., 'echt'
- This serves better as opposition to description _and_ inherited.*/
-} ir_peculiarity;
-
/**
- * Additional method type properties:
- * Tell about special properties of a method type. Some
- * of these may be discovered by analyses.
+ * linkage specifies how the linker treats symbols
*/
typedef enum {
- mtp_no_property = 0x00000000, /**< no additional properties, default */
- mtp_property_const = 0x00000001, /**< This method did not access memory and calculates
- its return values solely from its parameters.
- GCC: __attribute__((const)). */
- mtp_property_pure = 0x00000002, /**< This method did NOT write to memory and calculates
- its return values solely from its parameters and
- the memory they points to (or global vars).
- GCC: __attribute__((pure)). */
- mtp_property_noreturn = 0x00000004, /**< This method did not return due to an aborting system
- call.
- GCC: __attribute__((noreturn)). */
- mtp_property_nothrow = 0x00000008, /**< This method cannot throw an exception.
- GCC: __attribute__((nothrow)). */
- mtp_property_naked = 0x00000010, /**< This method is naked.
- GCC: __attribute__((naked)). */
- mtp_property_malloc = 0x00000020, /**< This method returns newly allocate memory.
- GCC: __attribute__((malloc)). */
- mtp_property_intrinsic = 0x00000040, /**< This method is intrinsic. It is expected that
- a lowering phase will remove all calls to it. */
- mtp_property_runtime = 0x00000080, /**< This method represents a runtime routine. */
- mtp_property_private = 0x00000100, /**< All method invocations are known, the backend is free to
- optimize the call in any possible way. */
- mtp_property_inherited = (1<<31) /**< Internal. Used only in irg's, means property is
- inherited from type. */
-} mtp_additional_property;
+ IR_LINKAGE_DEFAULT = 0,
+ /**
+ * A symbol whose definition won't change in a program.
+ * Optimisation might replace loads from this entity with constants.
+ * Also most linkers put such data in a constant segment which is shared
+ * between multiple running instances of the same application.
+ */
+ IR_LINKAGE_CONSTANT = 1 << 0,
+ /**
+ * The entity is a weak symbol.
+ * A weak symbol is overridden by a non-weak symbol if one exists.
+ * Most linkers only support the IR_LINKAGE_WEAK in combination with
+ * IR_LINKAGE_MERGE.
+ */
+ IR_LINKAGE_WEAK = 1 << 1,
+ /**
+ * The entity may be removed when it isn't referenced anywhere in the
+ * compilation unit even if it is exported (non-local).
+ * Typically used for C++ instantiated template code (,,COMDAT'' section).
+ */
+ IR_LINKAGE_GARBAGE_COLLECT = 1 << 2,
+ /**
+ * The linker will try to merge entities with same name from different
+ * compilation units. This is the usual behaviour for global variables
+ * without explicit initialisation in C (``COMMON'' symbols). It's also
+ * typically used in C++ for instantiated template code (,,COMDAT'' section)
+ */
+ IR_LINKAGE_MERGE = 1 << 3,
+ /**
+ * Some entity uses are potentially hidden from the compiler.
+ * (For example because they happen in an asm("") statement. This flag
+ * should be set for __attribute__((used)) in C code).
+ * Setting this flag prohibits that the compiler making assumptions about
+ * read/write behaviour to global variables or changing calling conventions
+ * from cdecl to fastcall.
+ */
+ IR_LINKAGE_HIDDEN_USER = 1 << 4
+} ir_linkage;
+
+/**
+ * Return the visibility class of an entity
+ */
+FIRM_API ir_visibility get_entity_visibility(const ir_entity *entity);
+
+/**
+ * Set visibility class of an entity
+ */
+FIRM_API void set_entity_visibility(ir_entity *entity, ir_visibility visibility);
+
+/**
+ * Return 1 if the entity is visible outside the current compilation unit
+ * or to unknown callers (like asm statements).
+ * (The entity might still be accessible indirectly through pointers)
+ * This is a convenience function and does the same as
+ * get_entity_visibility(entity) != ir_visibility_local ||
+ * (get_entity_linkage(entity) & IR_LINKAGE_HIDDEN_USER)
+ */
+FIRM_API int entity_is_externally_visible(const ir_entity *entity);
+
+/**
+ * Return 1 if the entity has a definition (initializer) in the current
+ * compilation unit
+ */
+FIRM_API int entity_has_definition(const ir_entity *entity);
/**
* Creates a new entity.
* value is a pointer to the method.
* Visibility is local, offset -1, and it is not volatile.
*/
-ir_entity *new_entity(ir_type *owner, ident *name, ir_type *tp);
+FIRM_API ir_entity *new_entity(ir_type *owner, ident *name, ir_type *tp);
/**
* Creates a new entity.
* value is a pointer to the method.
* Visibility is local, offset -1, and it is not volatile.
*/
-ir_entity *new_d_entity(ir_type *owner, ident *name, ir_type *tp, dbg_info *db);
+FIRM_API ir_entity *new_d_entity(ir_type *owner, ident *name, ir_type *tp,
+ dbg_info *db);
/**
* Copies the entity if the new_owner is different from the
* Automatically inserts the new entity as a member of owner.
* Resets the overwrites/overwritten_by fields.
* Keeps the old atomic value.
- * @@@ Maybe we should change this. If peculiarity of a method
- * is existent, we should add a new SymConst that points to
- * itself and not to the origin. Right now we have to change
- * the peculiarity and then set a new atomic value by hand.
*/
-ir_entity *copy_entity_own(ir_entity *old, ir_type *new_owner);
+FIRM_API ir_entity *copy_entity_own(ir_entity *old, ir_type *new_owner);
/**
* Copies the entity if the new_name is different from the
* The mangled name ld_name is set to NULL.
* Overwrites relation is copied from old.
*/
-ir_entity *copy_entity_name(ir_entity *old, ident *new_name);
+FIRM_API ir_entity *copy_entity_name(ir_entity *old, ident *new_name);
/**
* Frees the entity.
* The owner will still contain the pointer to this
* entity, as well as all other references!
*/
-void free_entity(ir_entity *ent);
+FIRM_API void free_entity(ir_entity *ent);
/** Returns the name of an entity. */
-const char *get_entity_name(const ir_entity *ent);
+FIRM_API const char *get_entity_name(const ir_entity *ent);
/** Returns the ident of an entity. */
-ident *get_entity_ident(const ir_entity *ent);
+FIRM_API ident *get_entity_ident(const ir_entity *ent);
/** Sets the ident of the entity. */
-void set_entity_ident(ir_entity *ent, ident *id);
+FIRM_API void set_entity_ident(ir_entity *ent, ident *id);
/** Returns the mangled name of the entity.
*
* Else it generates a name with mangle_entity()
* and remembers this new name internally.
*/
-ident *get_entity_ld_ident(ir_entity *ent);
+FIRM_API ident *get_entity_ld_ident(const ir_entity *ent);
/** Sets the mangled name of the entity. */
-void set_entity_ld_ident(ir_entity *ent, ident *ld_ident);
+FIRM_API void set_entity_ld_ident(ir_entity *ent, ident *ld_ident);
/** Returns the mangled name of the entity as a string. */
-const char *get_entity_ld_name(ir_entity *ent);
+FIRM_API const char *get_entity_ld_name(const ir_entity *ent);
/** Returns the owner of the entity. */
-ir_type *get_entity_owner(ir_entity *ent);
+FIRM_API ir_type *get_entity_owner(const ir_entity *ent);
-/** Sets the owner field in entity to owner. Don't forget to add
- ent to owner!! */
-void set_entity_owner(ir_entity *ent, ir_type *owner);
+/**
+ * Sets the owner field in entity to owner.
+ * Automatically removes entity from old owner type and adds it to the new
+ * one.
+ */
+FIRM_API void set_entity_owner(ir_entity *ent, ir_type *owner);
/** Returns the type of an entity. */
-ir_type *get_entity_type(ir_entity *ent);
+FIRM_API ir_type *get_entity_type(const ir_entity *ent);
/** Sets the type of an entity. */
-void set_entity_type(ir_entity *ent, ir_type *tp);
-
-/** The allocation type. */
-typedef enum {
- allocation_automatic, /**< The entity is allocated during runtime, implicitly
- as component of a compound type. This is the default. */
- allocation_parameter, /**< The entity is a parameter. It is also automatic allocated.
- We distinguish the allocation of parameters from the allocation
- of local variables as their placement depends on the calling
- conventions. */
- allocation_dynamic, /**< The entity is allocated during runtime, explicitly
- by an Alloc node. */
- allocation_static /**< The entity is allocated statically. We can use a
- Const as address of the entity. This is the default for methods. */
-} ir_allocation;
-
-/** Returns the allocation type of an entity. */
-ir_allocation get_entity_allocation(const ir_entity *ent);
+FIRM_API void set_entity_type(ir_entity *ent, ir_type *tp);
-/** Sets the allocation type of an entity. */
-void set_entity_allocation(ir_entity *ent, ir_allocation al);
+/** Returns the linkage of an entity. */
+FIRM_API ir_linkage get_entity_linkage(const ir_entity *entity);
-/** Return the name of the allocation type. */
-const char *get_allocation_name(ir_allocation vis);
+/** Sets the linkage of an entity. */
+FIRM_API void set_entity_linkage(ir_entity *entity, ir_linkage linkage);
+FIRM_API void add_entity_linkage(ir_entity *entity, ir_linkage linkage);
+FIRM_API void remove_entity_linkage(ir_entity *entity, ir_linkage linkage);
-/** Returns the visibility of an entity. */
-ir_visibility get_entity_visibility(const ir_entity *ent);
-
-/** Sets the visibility of an entity. */
-void set_entity_visibility(ir_entity *ent, ir_visibility vis);
-
-/** Return the name of the visibility */
-const char *get_visibility_name(ir_visibility vis);
-
-/** This enumeration flags the variability of entities. */
+/**
+ * This enumeration flags the volatility of entities and Loads/Stores.
+ * @deprecated
+ */
typedef enum {
- variability_uninitialized, /**< The content of the entity is completely unknown. Default. */
- variability_initialized, /**< After allocation the entity is initialized with the
- value given somewhere in the entity. */
- variability_part_constant, /**< For entities of compound types.
- The members of the entity are mixed constant,
- initialized or uninitialized. */
- variability_constant /**< The entity is constant. */
-} ir_variability;
-
-/** Returns the variability of an entity. */
-ir_variability get_entity_variability(const ir_entity *ent);
+ volatility_non_volatile, /**< The entity is not volatile. Default. */
+ volatility_is_volatile /**< The entity is volatile. */
+} ir_volatility;
-/** Sets the variability of an entity. */
-void set_entity_variability(ir_entity *ent, ir_variability var);
+/**
+ * Returns the volatility of an entity.
+ * @deprecated
+ */
+FIRM_API ir_volatility get_entity_volatility(const ir_entity *ent);
-/** Return the name of the variability. */
-const char *get_variability_name(ir_variability var);
+/**
+ * Sets the volatility of an entity.
+ * @deprecated
+ */
+FIRM_API void set_entity_volatility(ir_entity *ent, ir_volatility vol);
-/** This enumeration flags the volatility of entities. */
-typedef enum {
- volatility_non_volatile, /**< The entity is not volatile. Default. */
- volatility_is_volatile /**< The entity is volatile */
-} ir_volatility;
+/** Return the name of the volatility. */
+FIRM_API const char *get_volatility_name(ir_volatility var);
-/** Returns the volatility of an entity. */
-ir_volatility get_entity_volatility(const ir_entity *ent);
+/** Returns alignment of entity in bytes */
+FIRM_API unsigned get_entity_alignment(const ir_entity *entity);
-/** Sets the volatility of an entity. */
-void set_entity_volatility(ir_entity *ent, ir_volatility vol);
+/** Allows you to override the type alignment for an entity.
+ * @param entity the entity
+ * @param alignment alignment in bytes
+ */
+FIRM_API void set_entity_alignment(ir_entity *entity, unsigned alignment);
-/** Return the name of the volatility. */
-const char *get_volatility_name(ir_volatility var);
-/** This enumeration flags the stickyness of an entity. */
+/**
+ * This enumeration flags the align of Loads/Stores.
+ * @deprecated
+ */
typedef enum {
- stickyness_unsticky, /**< The entity can be removed from
- the program, unless contraindicated
- by other attributes. Default. */
- stickyness_sticky /**< The entity must remain in the
- program in any case. */
-} ir_stickyness;
+ align_non_aligned, /**< The entity is not aligned. */
+ align_is_aligned /**< The entity is aligned. Default */
+} ir_align;
+
+/**
+ * Returns indication wether entity is aligned in memory.
+ * @deprecated
+ */
+FIRM_API ir_align get_entity_aligned(const ir_entity *ent);
-/** Get the entity's stickyness. */
-ir_stickyness get_entity_stickyness(const ir_entity *ent);
+/**
+ * Sets indication wether entity is aligned in memory
+ * @deprecated
+ */
+FIRM_API void set_entity_aligned(ir_entity *ent, ir_align a);
-/** Set the entity's stickyness. */
-void set_entity_stickyness(ir_entity *ent, ir_stickyness stickyness);
+/** Return the name of the alignment. */
+FIRM_API const char *get_align_name(ir_align a);
/** Returns the offset of an entity (in a compound) in bytes. Only set if layout = fixed. */
-int get_entity_offset(const ir_entity *ent);
+FIRM_API int get_entity_offset(const ir_entity *ent);
/** Sets the offset of an entity (in a compound) in bytes. */
-void set_entity_offset(ir_entity *ent, int offset);
+FIRM_API void set_entity_offset(ir_entity *ent, int offset);
/** Returns the offset bit remainder of a bitfield entity (in a compound) in bits. Only set if layout = fixed. */
-unsigned char get_entity_offset_bits_remainder(const ir_entity *ent);
+FIRM_API unsigned char get_entity_offset_bits_remainder(const ir_entity *ent);
/** Sets the offset bit remainder of a bitfield entity (in a compound) in bits. */
-void set_entity_offset_bits_remainder(ir_entity *ent, unsigned char offset);
+FIRM_API void set_entity_offset_bits_remainder(ir_entity *ent,
+ unsigned char offset);
/** Returns the stored intermediate information. */
-void *get_entity_link(const ir_entity *ent);
+FIRM_API void *get_entity_link(const ir_entity *ent);
/** Stores new intermediate information. */
-void set_entity_link(ir_entity *ent, void *l);
+FIRM_API void set_entity_link(ir_entity *ent, void *l);
/* -- Fields of method entities -- */
/** The entity knows the corresponding irg if the entity is a method.
- This allows to get from a Call to the called irg.
- Only entities of peculiarity "existent" can have a corresponding irg,
- else the field is fixed to NULL. (Get returns NULL, set asserts.) */
-ir_graph *get_entity_irg(const ir_entity *ent);
-void set_entity_irg(ir_entity *ent, ir_graph *irg);
+ This allows to get from a Call to the called irg. */
+FIRM_API ir_graph *get_entity_irg(const ir_entity *ent);
+FIRM_API void set_entity_irg(ir_entity *ent, ir_graph *irg);
+
+/** A reserved value for "not yet set". */
+#define IR_VTABLE_NUM_NOT_SET ((unsigned)(-1))
/** Gets the entity vtable number. */
-unsigned get_entity_vtable_number(const ir_entity *ent);
+FIRM_API unsigned get_entity_vtable_number(const ir_entity *ent);
/** Sets the entity vtable number. */
-void set_entity_vtable_number(ir_entity *ent, unsigned vtable_number);
-
-/** Return the peculiarity of an entity. */
-ir_peculiarity get_entity_peculiarity(const ir_entity *ent);
-
-/** Sets the peculiarity of an entity. */
-void set_entity_peculiarity(ir_entity *ent, ir_peculiarity pec);
-
-/** Checks if an entity cannot be overridden anymore. */
-int is_entity_final(const ir_entity *ent);
+FIRM_API void set_entity_vtable_number(ir_entity *ent, unsigned vtable_number);
-/** Sets/resets the final flag of an entity. */
-void set_entity_final(ir_entity *ent, int final);
+/** Set label number of an entity with code type */
+FIRM_API void set_entity_label(ir_entity *ent, ir_label_t label);
+/** Return label number of an entity with code type */
+FIRM_API ir_label_t get_entity_label(const ir_entity *ent);
/** Checks if an entity is compiler generated. */
-int is_entity_compiler_generated(const ir_entity *ent);
+FIRM_API int is_entity_compiler_generated(const ir_entity *ent);
/** Sets/resets the compiler generated flag. */
-void set_entity_compiler_generated(ir_entity *ent, int flag);
-
-/** Checks if an entity is marked by the backend. */
-int is_entity_backend_marked(const ir_entity *ent);
-
-/** Sets/resets the backend marker flag. */
-void set_entity_backend_marked(ir_entity *ent, int flag);
+FIRM_API void set_entity_compiler_generated(ir_entity *ent, int flag);
/**
- * The state of the address_taken flag.
+ * Bitfield type indicating the way an entity is used.
*/
typedef enum {
- ir_address_not_taken = 0, /**< The address is NOT taken. */
- ir_address_taken_unknown = 1, /**< The state of the address taken flag is unknown. */
- ir_address_taken = 2 /**< The address IS taken. */
-} ir_address_taken_state;
-
-/** Return the state of the address taken flag of an entity. */
-ir_address_taken_state get_entity_address_taken(const ir_entity *ent);
+ ir_usage_none = 0, /**< This entity is unused. */
+ ir_usage_address_taken = 1 << 0, /**< The address of this entity was taken. */
+ ir_usage_write = 1 << 1, /**< The entity was written to. */
+ ir_usage_read = 1 << 2, /**< The entity was read. */
+ ir_usage_reinterpret_cast = 1 << 3, /**< The entity was read but with a wrong mode
+ (an implicit reinterpret cast) */
+ /** Unknown access */
+ ir_usage_unknown
+ = ir_usage_address_taken | ir_usage_write | ir_usage_read
+ | ir_usage_reinterpret_cast
+} ir_entity_usage;
+
+/** Return the entity usage */
+FIRM_API ir_entity_usage get_entity_usage(const ir_entity *ent);
/** Sets/resets the state of the address taken flag of an entity. */
-void set_entity_address_taken(ir_entity *ent, ir_address_taken_state flag);
+FIRM_API void set_entity_usage(ir_entity *ent, ir_entity_usage flag);
-/** Return the name of the address_taken state. */
-const char *get_address_taken_state_name(ir_address_taken_state state);
+/**
+ * Returns the debug information of an entity.
+ *
+ * @param ent The entity.
+ */
+FIRM_API dbg_info *get_entity_dbg_info(const ir_entity *ent);
+
+/**
+ * Sets the debug information of an entity.
+ *
+ * @param ent The entity.
+ * @param db The debug info.
+ */
+FIRM_API void set_entity_dbg_info(ir_entity *ent, dbg_info *db);
/* -- Representation of constant values of entities -- */
/**
* @deprecated This function is not used by libFirm and stays here
* only as a helper for the old Jack frontend.
*/
-int is_irn_const_expression(ir_node *n);
+FIRM_API int is_irn_const_expression(ir_node *n);
/**
* Copies a Firm subgraph that complies to the restrictions for
- * constant expressions to current_block in current_ir_graph.
+ * constant expressions to block.
*
* @param dbg debug info for all newly created nodes
* @param n the node
* Set current_ir_graph to get_const_code_irg() to generate a constant
* expression.
*/
-ir_node *copy_const_value(dbg_info *dbg, ir_node *n);
+FIRM_API ir_node *copy_const_value(dbg_info *dbg, ir_node *n, ir_node *to_block);
/* Set has no effect for existent entities of type method. */
-ir_node *get_atomic_ent_value(ir_entity *ent);
-void set_atomic_ent_value(ir_entity *ent, ir_node *val);
+FIRM_API ir_node *get_atomic_ent_value(ir_entity *ent);
+FIRM_API void set_atomic_ent_value(ir_entity *ent, ir_node *val);
-/** Creates a new compound graph path. */
-compound_graph_path *new_compound_graph_path(ir_type *tp, int length);
+/** the kind (type) of an initializer */
+typedef enum ir_initializer_kind_t {
+ /** initializer containing an ir_node from the const-code irg */
+ IR_INITIALIZER_CONST,
+ /** initializer containing a tarval */
+ IR_INITIALIZER_TARVAL,
+ /** initializes type with default values (usually 0) */
+ IR_INITIALIZER_NULL,
+ /** list of initializers used to initializer a compound or array type */
+ IR_INITIALIZER_COMPOUND
+} ir_initializer_kind_t;
-/** Returns non-zero if an object is a compound graph path */
-int is_compound_graph_path(const void *thing);
+/** returns kind of an initializer */
+FIRM_API ir_initializer_kind_t get_initializer_kind(const ir_initializer_t *initializer);
-/** Frees a graph path object */
-void free_compound_graph_path (compound_graph_path *gr);
+/** Return the name of the initializer kind. */
+FIRM_API const char *get_initializer_kind_name(ir_initializer_kind_t ini);
-/** Returns the length of a graph path */
-int get_compound_graph_path_length(const compound_graph_path *gr);
+/**
+ * returns the null initializer (there's only one instance of it in a program )
+ */
+FIRM_API ir_initializer_t *get_initializer_null(void);
-ir_entity *get_compound_graph_path_node(const compound_graph_path *gr, int pos);
-void set_compound_graph_path_node(compound_graph_path *gr, int pos, ir_entity *node);
-int get_compound_graph_path_array_index(const compound_graph_path *gr, int pos);
-void set_compound_graph_path_array_index(compound_graph_path *gr, int pos, int index);
+/**
+ * creates an initializer containing a reference to a node on the const-code
+ * irg.
+ */
+FIRM_API ir_initializer_t *create_initializer_const(ir_node *value);
-/** Checks whether the path up to pos is correct. If the path contains a NULL,
- * assumes the path is not complete and returns non-zero. */
-int is_proper_compound_graph_path(compound_graph_path *gr, int pos);
+/** creates an initializer containing a single tarval value */
+FIRM_API ir_initializer_t *create_initializer_tarval(ir_tarval *tv);
-/* A value of a compound entity is a pair of a value and the description of the
- corresponding access path to the member of the compound. */
-void add_compound_ent_value_w_path(ir_entity *ent, ir_node *val, compound_graph_path *path);
-void set_compound_ent_value_w_path(ir_entity *ent, ir_node *val, compound_graph_path *path, int pos);
-/** Returns the number of constant values needed to initialize the entity.
- *
- * Asserts if the entity has variability_uninitialized.
- * */
-int get_compound_ent_n_values(ir_entity *ent);
-/** Returns a constant value given the position. */
-ir_node *get_compound_ent_value(ir_entity *ent, int pos);
-/** Returns the access path for value at position pos. */
-compound_graph_path *get_compound_ent_value_path(ir_entity *ent, int pos);
-/** Returns a constant value given the access path.
- * The path must contain array indices for all array element entities. */
-ir_node *get_compound_ent_value_by_path(ir_entity *ent, compound_graph_path *path);
+/** return value contained in a const initializer */
+FIRM_API ir_node *get_initializer_const_value(const ir_initializer_t *initializer);
-/** Removes all constant entries where the path ends at value_ent. Does not
- free the memory of the paths. (The same path might be used for several
- constant entities. */
-void remove_compound_ent_value(ir_entity *ent, ir_entity *value_ent);
+/** return value contained in a tarval initializer */
+FIRM_API ir_tarval *get_initializer_tarval_value(const ir_initializer_t *initialzier);
-/* Some languages support only trivial access paths, i.e., the member is a
- direct, atomic member of the constant entities type. In this case the
- corresponding entity can be accessed directly. The following functions
- allow direct access. */
+/** creates a compound initializer which holds @p n_entries entries */
+FIRM_API ir_initializer_t *create_initializer_compound(unsigned n_entries);
-/** Generates a Path with length 1.
- Beware: Has a bad runtime for array elements (O(|array|) and should be
- avoided there. Use add_compound_ent_value_w_path() instead and create
- the path manually. */
-void add_compound_ent_value(ir_entity *ent, ir_node *val, ir_entity *member);
+/** returns the number of entries in a compound initializer */
+FIRM_API unsigned get_initializer_compound_n_entries(const ir_initializer_t *initializer);
-/** Returns the last member in the path */
-ir_entity *get_compound_ent_value_member(ir_entity *ent, int pos);
+/** sets entry with index @p index to the initializer @p value */
+FIRM_API void set_initializer_compound_value(ir_initializer_t *initializer,
+ unsigned index,
+ ir_initializer_t *value);
-/** Sets the path at pos 0 */
-void set_compound_ent_value(ir_entity *ent, ir_node *val, ir_entity *member, int pos);
+/** returns the value with index @p index of a compound initializer */
+FIRM_API ir_initializer_t *get_initializer_compound_value(
+ const ir_initializer_t *initializer, unsigned index);
-/** Initializes the entity ent which must be of a one dimensional
- array type with the values given in the values array.
- The array must have a lower and an upper bound. Keeps the
- order of values. Does not test whether the number of values
- fits into the given array size. Does not test whether the
- values have the proper mode for the array. */
-void set_array_entity_values(ir_entity *ent, tarval **values, int num_vals);
+/** Sets the new style initializers of an entity. */
+FIRM_API void set_entity_initializer(ir_entity *entity, ir_initializer_t *initializer);
-/**
- * Return the offset in bits from the last byte address.
- *
- * This requires that the layout of all concerned types is fixed.
- *
- * @param ent Any entity of compound type with at least pos initialization values.
- * @param pos The position of the value for which the offset is requested.
- */
-int get_compound_ent_value_offset_bit_remainder(ir_entity *ent, int pos);
+/** Returns true, if an entity has new style initializers. */
+FIRM_API int has_entity_initializer(const ir_entity *entity);
-/** Return the overall offset of value at position pos in bytes.
- *
- * This requires that the layout of all concerned types is fixed.
- * Asserts if bit offset is not byte aligned.
- *
- * @param ent Any entity of compound type with at least pos initialization values.
- * @param pos The position of the value for which the offset is requested.
- */
-int get_compound_ent_value_offset_bytes(ir_entity *ent, int pos);
+/** Return the new style initializers of an entity. */
+FIRM_API ir_initializer_t *get_entity_initializer(const ir_entity *entity);
/* --- Fields of entities with a class type as owner --- */
/* Overwrites is a field that specifies that an access to the overwritten
that is passed to it. Lowering of the Sel node must assure this.
Overwrittenby is the inverse of overwrites. Both add routines add
both relations, they only differ in the order of arguments. */
-void add_entity_overwrites (ir_entity *ent, ir_entity *overwritten);
-int get_entity_n_overwrites (ir_entity *ent);
-int get_entity_overwrites_index(ir_entity *ent, ir_entity *overwritten);
-ir_entity *get_entity_overwrites (ir_entity *ent, int pos);
-void set_entity_overwrites (ir_entity *ent, int pos, ir_entity *overwritten);
-void remove_entity_overwrites(ir_entity *ent, ir_entity *overwritten);
+FIRM_API void add_entity_overwrites(ir_entity *ent, ir_entity *overwritten);
+FIRM_API int get_entity_n_overwrites(const ir_entity *ent);
+FIRM_API int get_entity_overwrites_index(const ir_entity *ent, ir_entity *overwritten);
+FIRM_API ir_entity *get_entity_overwrites(const ir_entity *ent, int pos);
+FIRM_API void set_entity_overwrites(ir_entity *ent, int pos, ir_entity *overwritten);
+FIRM_API void remove_entity_overwrites(ir_entity *ent, ir_entity *overwritten);
-void add_entity_overwrittenby (ir_entity *ent, ir_entity *overwrites);
-int get_entity_n_overwrittenby (ir_entity *ent);
-int get_entity_overwrittenby_index(ir_entity *ent, ir_entity *overwrites);
-ir_entity *get_entity_overwrittenby (ir_entity *ent, int pos);
-void set_entity_overwrittenby (ir_entity *ent, int pos, ir_entity *overwrites);
-void remove_entity_overwrittenby(ir_entity *ent, ir_entity *overwrites);
+FIRM_API int get_entity_n_overwrittenby(const ir_entity *ent);
+FIRM_API int get_entity_overwrittenby_index(const ir_entity *ent, ir_entity *overwrites);
+FIRM_API ir_entity *get_entity_overwrittenby(const ir_entity *ent, int pos);
+FIRM_API void set_entity_overwrittenby(ir_entity *ent, int pos, ir_entity *overwrites);
+FIRM_API void remove_entity_overwrittenby(ir_entity *ent, ir_entity *overwrites);
/**
* Checks whether a pointer points to an entity.
* @return
* true if the thing is an entity, else false
*/
-int is_entity (const void *thing);
+FIRM_API int is_entity(const void *thing);
/** Returns true if the type of the entity is a primitive, pointer
* enumeration or method type.
*
- * @Note This is a different classification than from is_primitive_type().
+ * @note This is a different classification than from is_primitive_type().
*/
-int is_atomic_entity(ir_entity *ent);
+FIRM_API int is_atomic_entity(const ir_entity *ent);
/** Returns true if the type of the entity is a class, structure,
array or union type. */
-int is_compound_entity(ir_entity *ent);
+FIRM_API int is_compound_entity(const ir_entity *ent);
/** Returns true if the type of the entity is a Method type. */
-int is_method_entity(ir_entity *ent);
-
-/** Returns non-zero if ent1 and ent2 have are equal except for their owner.
- Two entities are equal if
- - they have the same type (the same C-struct)
- - ...?
-*/
-int equal_entity(ir_entity *ent1, ir_entity *ent2);
+FIRM_API int is_method_entity(const ir_entity *ent);
/** Outputs a unique number for this entity if libfirm is compiled for
* debugging, (configure with --enable-debug) else returns the address
* of the type cast to long.
*/
-long get_entity_nr(const ir_entity *ent);
+FIRM_API long get_entity_nr(const ir_entity *ent);
/** Returns the entities visited count. */
-unsigned long get_entity_visited(ir_entity *ent);
+FIRM_API ir_visited_t get_entity_visited(const ir_entity *ent);
/** Sets the entities visited count. */
-void set_entity_visited(ir_entity *ent, unsigned long num);
+FIRM_API void set_entity_visited(ir_entity *ent, ir_visited_t num);
/** Sets visited field in entity to entity_visited. */
-void mark_entity_visited(ir_entity *ent);
+FIRM_API void mark_entity_visited(ir_entity *ent);
/** Returns true if this entity was visited. */
-int entity_visited(ir_entity *ent);
+FIRM_API int entity_visited(const ir_entity *ent);
/** Returns true if this entity was not visited. */
-int entity_not_visited(ir_entity *ent);
+FIRM_API int entity_not_visited(const ir_entity *ent);
/**
* Returns the mask of the additional entity properties.
* set_entity_additional_properties() or
* set_entity_additional_property().
*/
-unsigned get_entity_additional_properties(ir_entity *ent);
+FIRM_API unsigned get_entity_additional_properties(const ir_entity *ent);
/** Sets the mask of the additional graph properties. */
-void set_entity_additional_properties(ir_entity *ent, unsigned property_mask);
+FIRM_API void set_entity_additional_properties(ir_entity *ent,
+ unsigned property_mask);
/** Sets one additional graph property. */
-void set_entity_additional_property(ir_entity *ent, mtp_additional_property flag);
+FIRM_API void set_entity_additional_property(ir_entity *ent,
+ mtp_additional_property flag);
/** Returns the class type that this type info entity represents or NULL
if ent is no type info entity. */
-ir_type *get_entity_repr_class(const ir_entity *ent);
+FIRM_API ir_type *get_entity_repr_class(const ir_entity *ent);
/**
* @page unknown_entity The Unknown entity
* - ld_name = "unknown_entity"
* - owner = unknown_type
* - type = unknown_type
- * - allocation = allocation_automatic
- * - visibility = visibility_external_allocated
* - offset = -1
- * - variability = variability_uninitialized
* - value = SymConst(unknown_entity)
* - values = NULL
* - val_paths = NULL
- * - peculiarity = peculiarity_existent
* - volatility = volatility_non_volatile
* - stickyness = stickyness_unsticky
* - ld_name = NULL
* - irg = NULL
* - link = NULL
*/
-/* A variable that contains the only unknown entity. */
-extern ir_entity *unknown_entity;
+
+/** A variable that contains the only unknown entity. */
+FIRM_API ir_entity *unknown_entity;
/** Returns the @link unknown_entity unknown entity @endlink. */
-ir_entity *get_unknown_entity(void);
+FIRM_API ir_entity *get_unknown_entity(void);
/** Encodes how a pointer parameter is accessed. */
typedef enum acc_bits {
- ptr_access_none = 0, /**< no access */
- ptr_access_read = 1, /**< read access */
- ptr_access_write = 2, /**< write access */
- ptr_access_rw = ptr_access_read|ptr_access_write, /**< read AND write access */
- ptr_access_store = 4, /**< the pointer is stored */
- ptr_access_all = ptr_access_rw|ptr_access_store /**< all possible access */
+ ptr_access_none = 0, /**< no access */
+ ptr_access_read = 1, /**< read access */
+ ptr_access_write = 2, /**< write access */
+ ptr_access_rw = ptr_access_read|ptr_access_write, /**< read AND write access */
+ ptr_access_store = 4, /**< the pointer is stored */
+ ptr_access_all = ptr_access_rw|ptr_access_store /**< all possible access */
} ptr_access_kind;
#define IS_READ(a) ((a) & ptr_access_read)
#define IS_WRITTEN(a) ((a) & ptr_access_write)
#define IS_STORED(a) ((a) & ptr_access_store)
-/**
- * Supported image sections.
- * Currently only methods can be placed in different sections.
- */
-typedef enum {
- section_text, /**< The code segment. This is the default for methods. */
- section_constructors /**< The constructor section. */
-} ir_img_section;
-
-/** Returns the section of a method. */
-ir_img_section get_method_img_section(const ir_entity *method);
-
-/** Sets the section of a method. */
-void set_method_img_section(ir_entity *method, ir_img_section section);
-
-
-
-
/**
* @page tyop type operations
* This module specifies the kinds of types available in firm.
* arrays, enumerations, pointers and primitive types.
* Special types with own opcodes are the id type, a type representing an unknown
* type and a type used to specify that something has no type.
- *
- * @see type.h
*/
/**
tpo_enumeration, /**< An enumeration type. */
tpo_pointer, /**< A pointer type. */
tpo_primitive, /**< A primitive type. */
- tpo_id, /**< Special Id tag used for type replacement. */
+ tpo_code, /**< a piece of code (a basic block) */
tpo_none, /**< Special type for the None type. */
tpo_unknown, /**< Special code for the Unknown type. */
- tpo_max /* not a type opcode */
+ tpo_last = tpo_unknown /* not a type opcode */
} tp_opcode;
/**
* this is only the kind name, an enum for case-switching and some
* internal values.
*
- * @see get_tpop_name(), get_tpop_code(), get_tpop_ident()
+ * @see get_tpop_name(), get_tpop_code()
*/
typedef struct tp_op tp_op;
* Returns the string for the type opcode.
*
* @param op The type opcode to get the string from.
- * @return a string. (@todo Null terminated?)
+ * @return a string.
*/
-const char *get_tpop_name (const tp_op *op);
+FIRM_API const char *get_tpop_name(const tp_op *op);
/**
* Returns an enum for the type opcode.
* @param op The type opcode to get the enum from.
* @return the enum.
*/
-tp_opcode get_tpop_code (const tp_op *op);
-
-/**
- * Returns the ident for the type opcode.
- *
- * @param op The type opcode to get the ident from.
- * @return The ident.
- */
-ident *get_tpop_ident (const tp_op *op);
+FIRM_API tp_opcode get_tpop_code(const tp_op *op);
/**
* This type opcode marks that the corresponding type is a class type.
* This struct is dynamically allocated but constant for the lifetime
* of the library.
*/
-extern tp_op *type_class;
-tp_op *get_tpop_class(void);
+FIRM_API const tp_op *type_class;
+FIRM_API const tp_op *get_tpop_class(void);
/**
* This type opcode marks that the corresponding type is a compound type
* This struct is dynamically allocated but constant for the lifetime
* of the library.
*/
-extern tp_op *type_struct;
-tp_op *get_tpop_struct(void);
+FIRM_API const tp_op *type_struct;
+FIRM_API const tp_op *get_tpop_struct(void);
/**
* This type opcode marks that the corresponding type is a method type.
* This struct is dynamically allocated but constant for the lifetime
* of the library.
*/
-extern tp_op *type_method;
-tp_op *get_tpop_method(void);
+FIRM_API const tp_op *type_method;
+FIRM_API const tp_op *get_tpop_method(void);
/**
* This type opcode marks that the corresponding type is a union type.
* This struct is dynamically allocated but constant for the lifetime
* of the library.
*/
-extern tp_op *type_union;
-tp_op *get_tpop_union(void);
+FIRM_API const tp_op *type_union;
+FIRM_API const tp_op *get_tpop_union(void);
/**
* This type opcode marks that the corresponding type is an array type.
* This struct is dynamically allocated but constant for the lifetime
* of the library.
*/
-extern tp_op *type_array;
-tp_op *get_tpop_array(void);
+FIRM_API const tp_op *type_array;
+FIRM_API const tp_op *get_tpop_array(void);
/**
* This type opcode marks that the corresponding type is an enumeration type.
* This struct is dynamically allocated but constant for the lifetime
* of the library.
*/
-extern tp_op *type_enumeration;
-tp_op *get_tpop_enumeration(void);
+FIRM_API const tp_op *type_enumeration;
+FIRM_API const tp_op *get_tpop_enumeration(void);
/**
* This type opcode marks that the corresponding type is a pointer type.
* This struct is dynamically allocated but constant for the lifetime
* of the library.
*/
-extern tp_op *type_pointer;
-tp_op *get_tpop_pointer(void);
+FIRM_API const tp_op *type_pointer;
+FIRM_API const tp_op *get_tpop_pointer(void);
/**
* This type opcode marks that the corresponding type is a primitive type.
* This struct is dynamically allocated but constant for the lifetime
* of the library.
*/
-extern tp_op *type_primitive;
-tp_op *get_tpop_primitive(void);
+FIRM_API const tp_op *type_primitive;
+FIRM_API const tp_op *get_tpop_primitive(void);
/**
- * This type opcode is an auxiliary opcode dedicated to support transformations
- * of the type structure.
- *
- * If a type is changed to another type with another
- * opcode the new type will be allocated with new memory. All nodes refering
- * to the old type need to be changed to refer to the new one. This is simplified
- * by turning the old type into an id type that merely forwards to the new type
- * that now replaces the old one.
- * type_ids should never be visible out of the type module. All access routines
- * should automatically check for type_id and eventually follow the forward in
- * type_id. Two types are exchanged by a call to exchange_types.
- * If a type_id is visible externally report this as bug. If it is assured that
- * this never happens this extern variable can be moved to tpop_t.h.
- * This struct is dynamically allocated but constant for the lifetime
- * of the library.
+ * The code type is used to mark pieces of code (basic blocks)
*/
-extern tp_op *type_id;
-tp_op *get_tpop_id(void);
+FIRM_API const tp_op *tpop_code;
+FIRM_API const tp_op *get_tpop_code_type(void);
/**
* This type opcode is an auxiliary opcode dedicated to support type analyses.
* contain a type or that are initialized for an analysis. There exists exactly
* one type with this opcode.
*/
-extern tp_op *tpop_none;
-tp_op *get_tpop_none(void);
+FIRM_API const tp_op *tpop_none;
+FIRM_API const tp_op *get_tpop_none(void);
/**
* This type opcode is an auxiliary opcode dedicated to support type analyses.
* yet) or to represent the top of a lattice (could not be determined). There exists
* exactly one type with this opcode.
*/
-extern tp_op *tpop_unknown;
-tp_op *get_tpop_unknown(void);
+FIRM_API const tp_op *tpop_unknown;
+FIRM_API const tp_op *get_tpop_unknown(void);
/* ----------------------------------------------------------------------- */
/* Classify pairs of types/entities in the inheritance relations. */
* a subclass of high. I.e, we search in all subtypes of high for low.
* @@@ this can be implemented more efficient if we know the set of all
* subclasses of high. */
-int is_SubClass_of(ir_type *low, ir_type *high);
+FIRM_API int is_SubClass_of(ir_type *low, ir_type *high);
/** Subclass check for pointers to classes.
*
* many as possible). If the remaining types are both class types
* and subclasses, returns true, else false. Can also be called with
* two class types. */
-int is_SubClass_ptr_of(ir_type *low, ir_type *high);
+FIRM_API int is_SubClass_ptr_of(ir_type *low, ir_type *high);
/** Returns true if high is superclass of low.
*
/** Returns true if high is (transitive) overwritten by low.
*
* Returns false if high == low. */
-int is_overwritten_by(ir_entity *high, ir_entity *low);
+FIRM_API int is_overwritten_by(ir_entity *high, ir_entity *low);
/** Resolve polymorphism in the inheritance relation.
*
* Returns the dynamically referenced entity if the static entity and the
* dynamic type are given.
* Searches downwards in overwritten tree. */
-ir_entity *resolve_ent_polymorphy(ir_type *dynamic_class, ir_entity* static_ent);
+FIRM_API ir_entity *resolve_ent_polymorphy(ir_type *dynamic_class,
+ ir_entity* static_ent);
/* ----------------------------------------------------------------------- */
/* Resolve implicit inheritance. */
*
* Returns an ident that consists of the name of type followed by an
* underscore and the name (not ld_name) of the entity. */
-ident *default_mangle_inherited_name(ir_entity *ent, ir_type *clss);
+FIRM_API ident *default_mangle_inherited_name(const ir_entity *ent,
+ const ir_type *clss);
/** Type of argument functions for inheritance resolver.
*
* used.
* @param clss The class type in which the new entity will be placed.
*/
-typedef ident *mangle_inherited_name_func(ir_entity *ent, ir_type *clss);
+typedef ident *mangle_inherited_name_func(const ir_entity *ent,
+ const ir_type *clss);
/** Resolve implicit inheritance.
*
* The name of the new entity is generated with the function passed.
* If the function is NULL, the default_mangle_inherited_name() is
* used.
- *
- * This function was moved here from firmlower 3/2005.
*/
-void resolve_inheritance(mangle_inherited_name_func *mfunc);
+FIRM_API void resolve_inheritance(mangle_inherited_name_func *mfunc);
/* ----------------------------------------------------------------------- */
/* Do the sets contain the node itself? I assume NOT! */
/* ----------------------------------------------------------------------- */
-/** The state of the transitive closure.
- *
- * @todo: we could manage the state for each relation separately. Invalidating
- * the entity relations does not mean invalidating the class relation. */
+/**
+ * The state of the transitive closure.
+ */
typedef enum {
inh_transitive_closure_none, /**< Closure is not computed, can not be accessed. */
inh_transitive_closure_valid, /**< Closure computed and valid. */
inh_transitive_closure_max /**< Invalid value. */
} inh_transitive_closure_state;
-void set_irp_inh_transitive_closure_state(inh_transitive_closure_state s);
-void invalidate_irp_inh_transitive_closure_state(void);
-inh_transitive_closure_state get_irp_inh_transitive_closure_state(void);
+FIRM_API void set_irp_inh_transitive_closure_state(inh_transitive_closure_state s);
+FIRM_API void invalidate_irp_inh_transitive_closure_state(void);
+FIRM_API inh_transitive_closure_state get_irp_inh_transitive_closure_state(void);
/** Compute transitive closure of the subclass/superclass and
* overwrites/overwrittenby relation.
*
- * This function walks over the ir (O(#types+#entities)) to compute the
+ * This function walks over the ir (O(\#types+\#entities)) to compute the
* transitive closure. */
-void compute_inh_transitive_closure(void);
+FIRM_API void compute_inh_transitive_closure(void);
/** Free memory occupied by the transitive closure information. */
-void free_inh_transitive_closure(void);
+FIRM_API void free_inh_transitive_closure(void);
/* - subtype ------------------------------------------------------------- */
/** Iterate over all transitive subtypes. */
-ir_type *get_class_trans_subtype_first(ir_type *tp);
-ir_type *get_class_trans_subtype_next (ir_type *tp);
-int is_class_trans_subtype (ir_type *tp, ir_type *subtp);
+FIRM_API ir_type *get_class_trans_subtype_first(const ir_type *tp);
+FIRM_API ir_type *get_class_trans_subtype_next(const ir_type *tp);
+FIRM_API int is_class_trans_subtype(const ir_type *tp, const ir_type *subtp);
/* - supertype ----------------------------------------------------------- */
/** Iterate over all transitive supertypes. */
-ir_type *get_class_trans_supertype_first(ir_type *tp);
-ir_type *get_class_trans_supertype_next (ir_type *tp);
+FIRM_API ir_type *get_class_trans_supertype_first(const ir_type *tp);
+FIRM_API ir_type *get_class_trans_supertype_next(const ir_type *tp);
/* - overwrittenby ------------------------------------------------------- */
/** Iterate over all entities that transitive overwrite this entities. */
-ir_entity *get_entity_trans_overwrittenby_first(ir_entity *ent);
-ir_entity *get_entity_trans_overwrittenby_next (ir_entity *ent);
+FIRM_API ir_entity *get_entity_trans_overwrittenby_first(const ir_entity *ent);
+FIRM_API ir_entity *get_entity_trans_overwrittenby_next(const ir_entity *ent);
/* - overwrites ---------------------------------------------------------- */
/** Iterate over all transitive overwritten entities. */
-ir_entity *get_entity_trans_overwrites_first(ir_entity *ent);
-ir_entity *get_entity_trans_overwrites_next (ir_entity *ent);
+FIRM_API ir_entity *get_entity_trans_overwrites_first(const ir_entity *ent);
+FIRM_API ir_entity *get_entity_trans_overwrites_next(const ir_entity *ent);
/* ----------------------------------------------------------------------- */
* relation. Example: (A)(new C()).
* any: Cast operations do not conform with the transitive inheritance
* relation. Example: (B2)(new B1())
- *
- * @see: tropt.h
*/
/* ----------------------------------------------------------------------- */
ir_class_casts_normalized = 2, /**< Class casts conform to inheritance edges. */
ir_class_casts_state_max
} ir_class_cast_state;
-char *get_class_cast_state_string(ir_class_cast_state s);
+FIRM_API const char *get_class_cast_state_string(ir_class_cast_state s);
-void set_irg_class_cast_state(ir_graph *irg, ir_class_cast_state s);
-ir_class_cast_state get_irg_class_cast_state(ir_graph *irg);
-void set_irp_class_cast_state(ir_class_cast_state s);
-ir_class_cast_state get_irp_class_cast_state(void);
+FIRM_API void set_irg_class_cast_state(ir_graph *irg,
+ ir_class_cast_state s);
+FIRM_API ir_class_cast_state get_irg_class_cast_state(const ir_graph *irg);
+FIRM_API void set_irp_class_cast_state(ir_class_cast_state s);
+FIRM_API ir_class_cast_state get_irp_class_cast_state(void);
/** Verify the class cast state of an irg.
*
- * Asserts if state is to high, outputs warning if state is to low
+ * Asserts if state is to high, outputs debug warning if state is to low
* and firm verbosity is set.
*/
-void verify_irg_class_cast_state(ir_graph *irg);
+FIRM_API void verify_irg_class_cast_state(ir_graph *irg);
/**
- * possible trvrfy() error codes
+ * possible trverify() error codes
*/
-enum trvrfy_error_codes {
+enum trverify_error_codes {
no_error = 0, /**< no error */
error_ent_not_cont, /**< overwritten entity not in superclass */
error_null_mem, /**< compound contains NULL member */
* @return
* 0 if no error encountered
*/
-int check_type(ir_type *tp);
+FIRM_API int check_type(ir_type *tp);
/**
* Check an entity. Currently, we check only if initialized constants
*
* @return
* 0 if no error encountered
- * != 0 a trvrfy_error_codes code
+ * != 0 a trverify_error_codes code
*/
-int check_entity(ir_entity *ent);
+FIRM_API int check_entity(ir_entity *ent);
/**
* Walks the type information and performs a set of sanity checks.
* 0 if graph is correct
* else error code.
*/
-int tr_vrfy(void);
-
-/**
- * If NDEBUG is defined performs nothing, else calls the tr_vrfy() function.
- */
-#ifdef NDEBUG
-#define TR_VRFY() 0
-#else
-#define TR_VRFY() tr_vrfy()
-#endif
-
-/**
- *
- * @file typegmod.h
- * This module supplies routines that support changing the type graph.
- */
-
-/** Replaces one type by the other.
- *
- * Old type is replaced by new_type. All references to old_type
- * now point to new_type. The memory for the old type is destroyed,
- * but still used. Therefore it is not freed.
- * All referenced to this memory will be lost after a certain while.
- * An exception is the list of types in irp (irprog.h).
- * In the future there might be a routine to recover the memory, but
- * this will be at considerable runtime cost.
- *
- * @param old_type - The old type that shall be replaced by the new type.
- * @param new_type - The new type that will replace old_type.
- *
- */
-void exchange_types(ir_type *old_type, ir_type *new_type);
-
-/** Skip id types until a useful type is reached.
- *
- * @param tp - A type of arbitrary kind.
- *
- * @return
- * tp if it is not an id type.
- * If tp is an id type returns the real type it stands for.
- */
-ir_type *skip_tid(ir_type *tp);
+FIRM_API int tr_verify(void);
/**
* @page type representation of types
* Types are different from the modes defined in irmode: Types are
* on the level of the programming language, modes at the level of
* the target processor.
- *
- * @see tpop.h
*/
-#include "typerep.h"
-
/** Frees all entities associated with a type.
* Does not free the array entity.
* Warning: ensure these entities are not referenced anywhere else.
*/
-void free_type_entities(ir_type *tp);
+FIRM_API void free_type_entities(ir_type *tp);
/** Frees the memory used by the type.
*
* param subtypes of method types!!! Make sure these are not
* referenced any more. Further make sure there is no pointer type
* that refers to this type. */
-void free_type(ir_type *tp);
+FIRM_API void free_type(ir_type *tp);
-const tp_op*get_type_tpop(const ir_type *tp);
-ident* get_type_tpop_nameid(const ir_type *tp);
-const char* get_type_tpop_name(const ir_type *tp);
-tp_opcode get_type_tpop_code(const ir_type *tp);
+FIRM_API const tp_op *get_type_tpop(const ir_type *tp);
+FIRM_API ident *get_type_tpop_nameid(const ir_type *tp);
+FIRM_API const char *get_type_tpop_name(const ir_type *tp);
+FIRM_API tp_opcode get_type_tpop_code(const ir_type *tp);
-ident* get_type_ident(const ir_type *tp);
-void set_type_ident(ir_type *tp, ident* id);
-const char* get_type_name(const ir_type *tp);
-
-/** The visibility of a type.
- *
- * The visibility of a type indicates, whether entities of this type
- * are accessed or allocated in external code.
- *
- * An entity of a type is allocated in external code, if the external
- * code declares a variable of this type, or dynamically allocates
- * an entity of this type. If the external code declares a (compound)
- * type, that contains entities of this type, the visibility also
- * must be external_allocated.
- *
- * The visibility must be higher than that of all entities, if the
- * type is a compound. Here it is questionable, what happens with
- * static entities. If these are accessed external by direct reference,
- * (a static call to a method, that is also in the dispatch table)
- * it should not affect the visibility of the type.
- *
- *
- * @@@ Do we need a visibility for types?
- * I change the layout of types radically when doing type splitting.
- * I need to know, which fields of classes are accessed in the RTS,
- * e.g., [_length. I may not move [_length to the split part.
- * The layout though, is a property of the type.
- *
- * One could also think of changing the mode of a type ...
- *
- * But, we could also output macros to access the fields, e.g.,
- * ACCESS_[_length (X) X->length // conventional
- * ACCESS_[_length (X) X->_split_ref->length // with type splitting
- *
- * For now I implement this function, that returns the visibility
- * based on the visibility of the entities of a compound ...
- *
- * This function returns visibility_external_visible if one or more
- * entities of a compound type have visibility_external_visible.
- * Entities of types are never visibility_external_allocated (right?).
- * Else returns visibility_local.
+/**
+ * construct a string representing the type.
+ * This uses the info retrieved by the type_dbg_info if available.
+ * Otherwise it tries to create an approximate textual representation of the
+ * type.
+ * Keep in mind that this representation is not unique for each type,
+ * might abstract away some details. The main intention of this is creating
+ * human redable strings giving an idea of the type.
*/
-ir_visibility get_type_visibility(const ir_type *tp);
-void set_type_visibility(ir_type *tp, ir_visibility v);
-
-
+FIRM_API void ir_print_type(char *buffer, size_t buffer_size,
+ const ir_type *tp);
/** The state of the type layout. */
typedef enum {
- layout_undefined, /**< The layout of this type is not defined.
- Address computation to access fields is not
- possible, fields must be accessed by Sel
- nodes. Enumeration constants might be undefined.
- This is the default value except for
- pointer, primitive and method types. */
- layout_fixed /**< The layout is fixed, all component/member entities
- have an offset assigned. Size of the type is known.
- Arrays can be accessed by explicit address
- computation. Enumeration constants must be defined.
- Default for pointer, primitive and method types. */
-} type_state;
+ layout_undefined, /**< The layout of this type is not defined.
+ Address computation to access fields is not
+ possible, fields must be accessed by Sel
+ nodes. Enumeration constants might be undefined.
+ This is the default value except for
+ pointer, primitive and method types. */
+ layout_fixed /**< The layout is fixed, all component/member entities
+ have an offset assigned. Size of the type is known.
+ Arrays can be accessed by explicit address
+ computation. Enumeration constants must be defined.
+ Default for pointer, primitive and method types. */
+} ir_type_state;
/** Returns a human readable string for the enum entry. */
-const char *get_type_state_name(type_state s);
+FIRM_API const char *get_type_state_name(ir_type_state s);
/** Returns the type layout state of a type. */
-type_state get_type_state(const ir_type *tp);
+FIRM_API ir_type_state get_type_state(const ir_type *tp);
/** Sets the type layout state of a type.
*
* For primitives, pointer and method types the layout is always fixed.
* This call is legal but has no effect.
*/
-void set_type_state(ir_type *tp, type_state state);
+FIRM_API void set_type_state(ir_type *tp, ir_type_state state);
/** Returns the mode of a type.
*
* Returns NULL for all non atomic types.
*/
-ir_mode* get_type_mode(const ir_type *tp);
+FIRM_API ir_mode *get_type_mode(const ir_type *tp);
/** Sets the mode of a type.
*
* Only has an effect on primitive, enumeration and pointer types.
*/
-void set_type_mode(ir_type *tp, ir_mode* m);
-
-/** Returns the size of a type in bytes, returns -1 if the size is NOT
- * a byte size, i.e. not dividable by 8. */
-int get_type_size_bytes(const ir_type *tp);
+FIRM_API void set_type_mode(ir_type *tp, ir_mode* m);
-/** Returns the size of a type in bits. */
-int get_type_size_bits(const ir_type *tp);
+/** Returns the size of a type in bytes. */
+FIRM_API unsigned get_type_size_bytes(const ir_type *tp);
/** Sets the size of a type in bytes.
*
* For primitive, enumeration, pointer and method types the size
* is always fixed. This call is legal but has no effect.
*/
-void set_type_size_bytes(ir_type *tp, int size);
+FIRM_API void set_type_size_bytes(ir_type *tp, unsigned size);
-/** Sets the size of a type in bits.
- *
- * For primitive, enumeration, pointer and method types the size
- * is always fixed. This call is legal but has no effect.
- */
-void set_type_size_bits(ir_type *tp, int size);
-
-/** Returns the alignment of a type in bytes.
- *
- * Returns -1 if the alignment is NOT
- * a byte size, i.e. not dividable by 8. Calls get_type_alignment_bits(). */
-int get_type_alignment_bytes(ir_type *tp);
+/** Returns the alignment of a type in bytes. */
+FIRM_API unsigned get_type_alignment_bytes(ir_type *tp);
/** Returns the alignment of a type in bits.
*
* -#.) compound types have the alignment of there biggest member.
* -#.) array types have the alignment of there element type.
* -#.) method types return 0 here.
- * -#.) all other types return 8 here (i.e. aligned at byte).
- */
-int get_type_alignment_bits(ir_type *tp);
-
-/** Sets the alignment of a type in bytes. */
-void set_type_alignment_bytes(ir_type *tp, int size);
-
-/** Sets the alignment of a type in bits.
- *
- * For method types the alignment is always fixed.
- * This call is legal but has no effect.
+ * -#.) all other types return 1 here (i.e. aligned at byte).
*/
-void set_type_alignment_bits(ir_type *tp, int size);
+FIRM_API void set_type_alignment_bytes(ir_type *tp, unsigned align);
/** Returns the visited count of a type. */
-unsigned long get_type_visited(const ir_type *tp);
+FIRM_API ir_visited_t get_type_visited(const ir_type *tp);
/** Sets the visited count of a type to num. */
-void set_type_visited(ir_type *tp, unsigned long num);
+FIRM_API void set_type_visited(ir_type *tp, ir_visited_t num);
/** Sets visited field in type to type_visited. */
-void mark_type_visited(ir_type *tp);
+FIRM_API void mark_type_visited(ir_type *tp);
/** Returns non-zero if the type is already visited */
-int type_visited(const ir_type *tp);
+FIRM_API int type_visited(const ir_type *tp);
/** Returns non-zero if the type is not yet visited */
-int type_not_visited(const ir_type *tp);
+FIRM_API int type_not_visited(const ir_type *tp);
/** Returns the associated link field of a type. */
-void* get_type_link(const ir_type *tp);
+FIRM_API void *get_type_link(const ir_type *tp);
/** Sets the associated link field of a type. */
-void set_type_link(ir_type *tp, void *l);
+FIRM_API void set_type_link(ir_type *tp, void *l);
/**
* Visited flag to traverse the type information.
*
* @see typewalk
*/
-void set_master_type_visited(unsigned long val);
-unsigned long get_master_type_visited(void);
-void inc_master_type_visited(void);
+FIRM_API void set_master_type_visited(ir_visited_t val);
+FIRM_API ir_visited_t get_master_type_visited(void);
+FIRM_API void inc_master_type_visited(void);
+
+/**
+ * Sets the debug information of a type.
+ *
+ * @param tp The type.
+ * @param db The debug info.
+ */
+FIRM_API void set_type_dbg_info(ir_type *tp, type_dbg_info *db);
+
+/**
+ * Returns the debug information of a type.
+ *
+ * @param tp The type.
+ */
+FIRM_API type_dbg_info *get_type_dbg_info(const ir_type *tp);
/**
* Checks whether a pointer points to a type.
* @return
* true if the thing is a type, else false
*/
-int is_type(const void *thing);
+FIRM_API int is_type(const void *thing);
/**
* Checks whether two types are structurally equal.
* - the same supertypes -- the C-pointers are compared --> no recursive call.
* - the same number of subtypes. Subtypes are not compared,
* as this could cause a cyclic test.
- * - the same peculiarity
* - they are structure types and have the same members
* - they are method types and have
* - the same parameter types
* - the same element type
* - they are enumeration types and have the same enumerator names
* - they are pointer types and have the identical points_to type
- * (i.e., the same C-struct to represent the type, type_id is skipped.
+ * (i.e., the same C-struct to represent the type.
* This is to avoid endless recursions; with pointer types cyclic
* type graphs are possible.)
*/
-int equal_type(ir_type *typ1, ir_type *typ2);
+FIRM_API int equal_type(ir_type *typ1, ir_type *typ2);
/**
* Checks whether two types are structural comparable.
* @return smaller than the points_to type of lt.
*
*/
-int smaller_type(ir_type *st, ir_type *lt);
+FIRM_API int smaller_type(ir_type *st, ir_type *lt);
/**
* @page class_type Representation of a class type
*
* - supertypes: A list of direct superclasses.
*
- * - peculiarity: The peculiarity of this class. If the class is of peculiarity
- * "description" it only is a description of requirements to a class,
- * as, e.g., a Java interface. The class will never be allocated.
- * Peculiarity inherited is only possible for entities. An entity
- * is of peculiarity inherited if the compiler generated the entity
- * to explicitly resolve inheritance. An inherited method entity has
- * no value for irg.
- * Values: description, existent, inherited. Default: existent.
- *
* - type_info: An entity representing the type information of this class.
* This entity can be of arbitrari type, Firm did not use it yet.
* It allows to express the coupling of a type with an entity
*/
/** Creates a new class type. */
-ir_type *new_type_class (ident *name);
+FIRM_API ir_type *new_type_class(ident *name);
/** Creates a new class type with debug information. */
-ir_type *new_d_type_class (ident *name, dbg_info *db);
+FIRM_API ir_type *new_d_type_class(ident *name, type_dbg_info *db);
/* --- manipulate private fields of class type --- */
-/** Adds the entity as member of the class. */
-void add_class_member (ir_type *clss, ir_entity *member);
+/** return identifier of the class type */
+FIRM_API ident *get_class_ident(const ir_type *clss);
+
+/** return identifier of the class type */
+FIRM_API const char *get_class_name(const ir_type *clss);
/** Returns the number of members of this class. */
-int get_class_n_members (const ir_type *clss);
+FIRM_API int get_class_n_members(const ir_type *clss);
/** Returns the member at position pos, 0 <= pos < n_member */
-ir_entity *get_class_member (const ir_type *clss, int pos);
+FIRM_API ir_entity *get_class_member(const ir_type *clss, int pos);
/** Returns index of mem in clss, -1 if not contained. */
-int get_class_member_index(const ir_type *clss, ir_entity *mem);
+FIRM_API int get_class_member_index(const ir_type *clss, ir_entity *mem);
/** Finds the member with name 'name'. If several members with the same
* name returns one of them. Returns NULL if no member found. */
-ir_entity *get_class_member_by_name(ir_type *clss, ident *name);
+FIRM_API ir_entity *get_class_member_by_name(ir_type *clss, ident *name);
/** Overwrites the member at position pos, 0 <= pos < n_member with
* the passed entity. */
-void set_class_member (ir_type *clss, ir_entity *member, int pos);
+FIRM_API void set_class_member(ir_type *clss, ir_entity *member, int pos);
/** Replaces complete member list in class type by the list passed.
*
* Copies the list passed. This function is necessary to reduce the number of members.
* members is an array of entities, num the size of this array. Sets all
* owners of the members passed to clss. */
-void set_class_members (ir_type *clss, ir_entity *members[], int arity);
-
-/** Finds member in the list of members and removes it.
- *
- * Shrinks the member list, so iterate from the end!!!
- * Does not deallocate the entity. */
-void remove_class_member(ir_type *clss, ir_entity *member);
+FIRM_API void set_class_members(ir_type *clss, ir_entity *members[], int arity);
/** Adds subtype as subtype to clss.
*
* Checks whether clss is a supertype of subtype. If not
* adds also clss as supertype to subtype. */
-void add_class_subtype (ir_type *clss, ir_type *subtype);
+FIRM_API void add_class_subtype(ir_type *clss, ir_type *subtype);
/** Returns the number of subtypes */
-int get_class_n_subtypes (const ir_type *clss);
+FIRM_API int get_class_n_subtypes(const ir_type *clss);
/** Gets the subtype at position pos, 0 <= pos < n_subtype. */
-ir_type *get_class_subtype (ir_type *clss, int pos);
+FIRM_API ir_type *get_class_subtype(ir_type *clss, int pos);
/** Returns the index to access subclass as subtype of class.
*
* If subclass is no direct subtype of class returns -1.
*/
-int get_class_subtype_index(ir_type *clss, const ir_type *subclass);
+FIRM_API int get_class_subtype_index(ir_type *clss, const ir_type *subclass);
/** Sets the subtype at position pos, 0 <= pos < n_subtype.
*
* Does not set the corresponding supertype relation for subtype: this might
* be a different position! */
-void set_class_subtype (ir_type *clss, ir_type *subtype, int pos);
+FIRM_API void set_class_subtype(ir_type *clss, ir_type *subtype, int pos);
/** Finds subtype in the list of subtypes and removes it */
-void remove_class_subtype(ir_type *clss, ir_type *subtype);
+FIRM_API void remove_class_subtype(ir_type *clss, ir_type *subtype);
/* Convenience macros */
#define add_class_derived_type(clss, drvtype) add_class_subtype(clss, drvtype)
*
* Checks whether clss is a subtype of supertype. If not
* adds also clss as subtype to supertype. */
-void add_class_supertype (ir_type *clss, ir_type *supertype);
+FIRM_API void add_class_supertype(ir_type *clss, ir_type *supertype);
/** Returns the number of supertypes */
-int get_class_n_supertypes (const ir_type *clss);
+FIRM_API int get_class_n_supertypes(const ir_type *clss);
/** Returns the index to access superclass as supertype of class.
*
* If superclass is no direct supertype of class returns -1.
*/
-int get_class_supertype_index(ir_type *clss, ir_type *super_clss);
+FIRM_API int get_class_supertype_index(ir_type *clss, ir_type *super_clss);
/** Gets the supertype at position pos, 0 <= pos < n_supertype. */
-ir_type *get_class_supertype (ir_type *clss, int pos);
+FIRM_API ir_type *get_class_supertype(ir_type *clss, int pos);
/** Sets the supertype at position pos, 0 <= pos < n_supertype.
*
* Does not set the corresponding subtype relation for supertype: this might
* be at a different position! */
-void set_class_supertype (ir_type *clss, ir_type *supertype, int pos);
+FIRM_API void set_class_supertype(ir_type *clss, ir_type *supertype, int pos);
/** Finds supertype in the list of supertypes and removes it */
-void remove_class_supertype(ir_type *clss, ir_type *supertype);
-
-/** Convenience macro */
-#define add_class_base_type(clss, basetype) add_class_supertype(clss, basetype)
-#define get_class_n_base_types(clss) get_class_n_supertypes(clss)
-#define get_class_base_type_index(clss, base_clss) get_class_supertype_index(clss, base_clss)
-#define get_class_base_type(clss, pos) get_class_supertype(clss, pos)
-#define set_class_base_type(clss, basetype, pos) set_class_supertype(clss, basetype, pos)
-#define remove_class_base_type(clss, basetype) remove_class_supertype(clss, basetype)
+FIRM_API void remove_class_supertype(ir_type *clss, ir_type *supertype);
/** Convenience macro */
#define add_class_base_type(clss, basetype) add_class_supertype(clss, basetype)
#define set_class_base_type(clss, basetype, pos) set_class_supertype(clss, basetype, pos)
#define remove_class_base_type(clss, basetype) remove_class_supertype(clss, basetype)
-/** Returns a human readable string for a peculiarity. */
-const char *get_peculiarity_name(ir_peculiarity p);
-
-/** Returns the peculiarity of the class. */
-ir_peculiarity get_class_peculiarity (const ir_type *clss);
-/** Sets the peculiarity of the class. */
-void set_class_peculiarity (ir_type *clss, ir_peculiarity pec);
-
/** Returns the type info entity of a class. */
-ir_entity *get_class_type_info(const ir_type *clss);
+FIRM_API ir_entity *get_class_type_info(const ir_type *clss);
/** Set a type info entity for the class. */
-void set_class_type_info(ir_type *clss, ir_entity *ent);
+FIRM_API void set_class_type_info(ir_type *clss, ir_entity *ent);
/** Returns the size of the virtual function table. */
-unsigned get_class_vtable_size(const ir_type *clss);
+FIRM_API unsigned get_class_vtable_size(const ir_type *clss);
/** Sets a new size of the virtual function table. */
-void set_class_vtable_size(ir_type *clss, unsigned size);
+FIRM_API void set_class_vtable_size(ir_type *clss, unsigned size);
/** Returns non-zero if a class is final. */
-int is_class_final(const ir_type *clss);
+FIRM_API int is_class_final(const ir_type *clss);
/** Sets the class final flag. */
-void set_class_final(ir_type *clss, int flag);
+FIRM_API void set_class_final(ir_type *clss, int flag);
/** Return non-zero if a class is an interface */
-int is_class_interface(const ir_type *clss);
+FIRM_API int is_class_interface(const ir_type *clss);
/** Sets the class interface flag. */
-void set_class_interface(ir_type *clss, int flag);
+FIRM_API void set_class_interface(ir_type *clss, int flag);
/** Return non-zero if a class is an abstract class. */
-int is_class_abstract(const ir_type *clss);
+FIRM_API int is_class_abstract(const ir_type *clss);
/** Sets the class abstract flag. */
-void set_class_abstract(ir_type *clss, int flag);
-
-/** Set and get a class' dfn --
- @todo This is an undocumented field, subject to change! */
-void set_class_dfn (ir_type *clss, int dfn);
-int get_class_dfn (const ir_type *clss);
+FIRM_API void set_class_abstract(ir_type *clss, int flag);
/** Returns true if a type is a class type. */
-int is_Class_type(const ir_type *clss);
+FIRM_API int is_Class_type(const ir_type *clss);
/**
* @page struct_type Representation of a struct type
* but not shrinked.
*/
/** Creates a new type struct */
-ir_type *new_type_struct (ident *name);
+FIRM_API ir_type *new_type_struct(ident *name);
/** Creates a new type struct with debug information. */
-ir_type *new_d_type_struct (ident *name, dbg_info* db);
+FIRM_API ir_type *new_d_type_struct(ident *name, type_dbg_info* db);
/* --- manipulate private fields of struct --- */
-/** Adds the entity as member of the struct. */
-void add_struct_member (ir_type *strct, ir_entity *member);
+/** return struct identifier */
+FIRM_API ident *get_struct_ident(const ir_type *strct);
+
+/** return struct identifier as c-string*/
+FIRM_API const char *get_struct_name(const ir_type *strct);
/** Returns the number of members of this struct. */
-int get_struct_n_members (const ir_type *strct);
+FIRM_API int get_struct_n_members(const ir_type *strct);
/** Returns the member at position pos, 0 <= pos < n_member */
-ir_entity *get_struct_member (const ir_type *strct, int pos);
+FIRM_API ir_entity *get_struct_member(const ir_type *strct, int pos);
/** Returns index of member in strct, -1 if not contained. */
-int get_struct_member_index(const ir_type *strct, ir_entity *member);
+FIRM_API int get_struct_member_index(const ir_type *strct, ir_entity *member);
/** Overwrites the member at position pos, 0 <= pos < n_member with
the passed entity. */
-void set_struct_member (ir_type *strct, int pos, ir_entity *member);
-
-/** Finds member in the list of members and removes it. */
-void remove_struct_member (ir_type *strct, ir_entity *member);
+FIRM_API void set_struct_member(ir_type *strct, int pos, ir_entity *member);
/** Returns true if a type is a struct type. */
-int is_Struct_type(const ir_type *strct);
+FIRM_API int is_Struct_type(const ir_type *strct);
/**
* @page method_type Representation of a method type
/** Create a new method type.
*
- * @param name the name (ident) of this type
* @param n_param the number of parameters
* @param n_res the number of results
*
* The arrays for the parameter and result types are not initialized by
* the constructor.
*/
-ir_type *new_type_method (ident *name, int n_param, int n_res);
+FIRM_API ir_type *new_type_method(int n_param, int n_res);
/** Create a new method type with debug information.
*
- * @param name the name (ident) of this type
* @param n_param the number of parameters
* @param n_res the number of results
* @param db user defined debug information
* The arrays for the parameter and result types are not initialized by
* the constructor.
*/
-ir_type *new_d_type_method (ident *name, int n_param, int n_res, dbg_info* db);
+FIRM_API ir_type *new_d_type_method(int n_param, int n_res, type_dbg_info *db);
/* -- manipulate private fields of method. -- */
/** Returns the number of parameters of this method. */
-int get_method_n_params (const ir_type *method);
+FIRM_API int get_method_n_params(const ir_type *method);
/** Returns the type of the parameter at position pos of a method. */
-ir_type *get_method_param_type(ir_type *method, int pos);
+FIRM_API ir_type *get_method_param_type(ir_type *method, int pos);
/** Sets the type of the parameter at position pos of a method.
Also changes the type in the pass-by-value representation by just
changing the type of the corresponding entity if the representation is constructed. */
-void set_method_param_type(ir_type *method, int pos, ir_type *tp);
+FIRM_API void set_method_param_type(ir_type *method, int pos, ir_type *tp);
/** Returns an entity that represents the copied value argument. Only necessary
for compounds passed by value. This information is constructed only on demand. */
-ir_entity *get_method_value_param_ent(ir_type *method, int pos);
+FIRM_API ir_entity *get_method_value_param_ent(ir_type *method, int pos);
+/**
+ * Sets the type that represents the copied value arguments.
+ */
+FIRM_API void set_method_value_param_type(ir_type *method, ir_type *tp);
/**
* Returns a type that represents the copied value arguments if one
* was allocated, else NULL.
*/
-ir_type *get_method_value_param_type(const ir_type *method);
+FIRM_API ir_type *get_method_value_param_type(const ir_type *method);
/** Returns an ident representing the parameters name. Returns NULL if not set.
For debug support only. */
-ident *get_method_param_ident(ir_type *method, int pos);
+FIRM_API ident *get_method_param_ident(ir_type *method, int pos);
/** Returns a string representing the parameters name. Returns NULL if not set.
For debug support only. */
-const char *get_method_param_name(ir_type *method, int pos);
+FIRM_API const char *get_method_param_name(ir_type *method, int pos);
/** Sets an ident representing the parameters name. For debug support only. */
-void set_method_param_ident(ir_type *method, int pos, ident *id);
+FIRM_API void set_method_param_ident(ir_type *method, int pos, ident *id);
/** Returns the number of results of a method type. */
-int get_method_n_ress (const ir_type *method);
+FIRM_API int get_method_n_ress(const ir_type *method);
/** Returns the return type of a method type at position pos. */
-ir_type *get_method_res_type(ir_type *method, int pos);
+FIRM_API ir_type *get_method_res_type(ir_type *method, int pos);
/** Sets the type of the result at position pos of a method.
Also changes the type in the pass-by-value representation by just
changing the type of the corresponding entity if the representation is constructed. */
-void set_method_res_type(ir_type *method, int pos, ir_type *tp);
+FIRM_API void set_method_res_type(ir_type *method, int pos, ir_type *tp);
/** Returns an entity that represents the copied value result. Only necessary
for compounds passed by value. This information is constructed only on demand. */
-ir_entity *get_method_value_res_ent(ir_type *method, int pos);
+FIRM_API ir_entity *get_method_value_res_ent(ir_type *method, int pos);
/**
* Returns a type that represents the copied value results.
*/
-ir_type *get_method_value_res_type(const ir_type *method);
+FIRM_API ir_type *get_method_value_res_type(const ir_type *method);
/**
* This enum flags the variadicity of methods (methods with a
* variable amount of arguments (e.g. C's printf). Default is
* non_variadic.
*/
-typedef enum variadicity {
- variadicity_non_variadic, /**< non variadic */
- variadicity_variadic /**< variadic */
-} variadicity;
+typedef enum ir_variadicity {
+ variadicity_non_variadic, /**< non variadic */
+ variadicity_variadic /**< variadic */
+} ir_variadicity;
/** Returns the null-terminated name of this variadicity. */
-const char *get_variadicity_name(variadicity vari);
+FIRM_API const char *get_variadicity_name(ir_variadicity vari);
/** Returns the variadicity of a method. */
-variadicity get_method_variadicity(const ir_type *method);
+FIRM_API ir_variadicity get_method_variadicity(const ir_type *method);
/** Sets the variadicity of a method. */
-void set_method_variadicity(ir_type *method, variadicity vari);
+FIRM_API void set_method_variadicity(ir_type *method, ir_variadicity vari);
/**
* Returns the first variadic parameter index of a type.
* of the method type plus one is returned for variadic functions.
* Non-variadic function types always return -1 here.
*/
-int get_method_first_variadic_param_index(const ir_type *method);
+FIRM_API int get_method_first_variadic_param_index(const ir_type *method);
/**
* Sets the first variadic parameter index. This allows to specify
* but still have the knowledge, which parameter must be passed as
* variadic one.
*/
-void set_method_first_variadic_param_index(ir_type *method, int index);
+FIRM_API void set_method_first_variadic_param_index(ir_type *method, int index);
/** Returns the mask of the additional graph properties. */
-unsigned get_method_additional_properties(const ir_type *method);
+FIRM_API unsigned get_method_additional_properties(const ir_type *method);
/** Sets the mask of the additional graph properties. */
-void set_method_additional_properties(ir_type *method, unsigned property_mask);
+FIRM_API void set_method_additional_properties(ir_type *method,
+ unsigned property_mask);
/** Sets one additional graph property. */
-void set_method_additional_property(ir_type *method, mtp_additional_property flag);
+FIRM_API void set_method_additional_property(ir_type *method,
+ mtp_additional_property flag);
/**
* Calling conventions: lower 24 bits are the number of register parameters,
* upper 8 encode the calling conventions.
*/
typedef enum {
- cc_reg_param = 0x01000000, /**< Transmit parameters in registers, else the stack is used.
- This flag may be set as default on some architectures. */
- cc_last_on_top = 0x02000000, /**< The last non-register parameter is transmitted on top of
- the stack. This is equivalent to the pascal
- calling convention. If this flag is not set, the first
- non-register parameter is used (stdcall or cdecl
- calling convention) */
- cc_callee_clear_stk = 0x04000000, /**< The callee clears the stack. This forbids variadic
- function calls (stdcall). */
- cc_this_call = 0x08000000, /**< The first parameter is a this pointer and is transmitted
- in a special way. */
-
- cc_bits = (0xFF << 24) /**< the calling convention bits */
+ cc_reg_param = 0x01000000, /**< Transmit parameters in registers, else the stack is used.
+ This flag may be set as default on some architectures. */
+ cc_last_on_top = 0x02000000, /**< The last non-register parameter is transmitted on top of
+ the stack. This is equivalent to the pascal
+ calling convention. If this flag is not set, the first
+ non-register parameter is used (stdcall or cdecl
+ calling convention) */
+ cc_callee_clear_stk = 0x04000000, /**< The callee clears the stack. This forbids variadic
+ function calls (stdcall). */
+ cc_this_call = 0x08000000, /**< The first parameter is a this pointer and is transmitted
+ in a special way. */
+ cc_compound_ret = 0x10000000, /**< The method returns a compound type. */
+ cc_frame_on_caller_stk = 0x20000000, /**< The method did not allocate an own stack frame, instead the
+ caller must reserve size on its own stack. */
+ cc_fpreg_param = 0x40000000, /**< Transmit floating point parameters in registers, else the stack is used. */
+ cc_bits = (0xFF << 24)/**< The calling convention bits. */
} calling_convention;
/* some often used cases: made as defines because firmjni cannot handle two
/** fastcall calling convention */
#define cc_fastcall_set (cc_reg_param|cc_callee_clear_stk)
-/** Returns the default calling convention for method types. */
-unsigned get_default_cc_mask(void);
-
/**
* check for the CDECL calling convention
*/
#define SET_FASTCALL(cc_mask) (((cc_mask) & ~cc_bits) | cc_fastcall_set)
/** Returns the calling convention of an entities graph. */
-unsigned get_method_calling_convention(const ir_type *method);
+FIRM_API unsigned get_method_calling_convention(const ir_type *method);
/** Sets the calling convention of an entities graph. */
-void set_method_calling_convention(ir_type *method, unsigned cc_mask);
+FIRM_API void set_method_calling_convention(ir_type *method, unsigned cc_mask);
/** Returns the number of registers parameters, 0 means default. */
-unsigned get_method_n_regparams(ir_type *method);
+FIRM_API unsigned get_method_n_regparams(ir_type *method);
/** Sets the number of registers parameters, 0 means default. */
-void set_method_n_regparams(ir_type *method, unsigned n_regs);
+FIRM_API void set_method_n_regparams(ir_type *method, unsigned n_regs);
/** Returns true if a type is a method type. */
-int is_Method_type (const ir_type *method);
+FIRM_API int is_Method_type(const ir_type *method);
/**
* @page union_type Representation of a union (variant) type.
* but not shrinked.
*/
/** Creates a new type union. */
-ir_type *new_type_union (ident *name);
+FIRM_API ir_type *new_type_union(ident *name);
/** Creates a new type union with debug information. */
-ir_type *new_d_type_union (ident *name, dbg_info* db);
+FIRM_API ir_type *new_d_type_union(ident *name, type_dbg_info* db);
/* --- manipulate private fields of struct --- */
-/** Returns the number of unioned types of this union */
-int get_union_n_members (const ir_type *uni);
+/** return union identifier */
+FIRM_API ident *get_union_ident(const ir_type *uni);
+
+/** return union identifier as c-string */
+FIRM_API const char *get_union_name(const ir_type *uni);
-/** Adds a new entity to a union type */
-void add_union_member (ir_type *uni, ir_entity *member);
+/** Returns the number of unioned types of this union */
+FIRM_API int get_union_n_members(const ir_type *uni);
/** Returns the entity at position pos of a union */
-ir_entity *get_union_member (const ir_type *uni, int pos);
+FIRM_API ir_entity *get_union_member(const ir_type *uni, int pos);
/** Returns index of member in uni, -1 if not contained. */
-int get_union_member_index(const ir_type *uni, ir_entity *member);
+FIRM_API int get_union_member_index(const ir_type *uni, ir_entity *member);
/** Overwrites a entity at position pos in a union type. */
-void set_union_member (ir_type *uni, int pos, ir_entity *member);
-
-/** Finds member in the list of members and removes it. */
-void remove_union_member (ir_type *uni, ir_entity *member);
+FIRM_API void set_union_member(ir_type *uni, int pos, ir_entity *member);
/** Returns true if a type is a union type. */
-int is_Union_type (const ir_type *uni);
+FIRM_API int is_Union_type(const ir_type *uni);
/**
* @page array_type Representation of an array type
* - *element_type: The type of the array elements.
* - *element_ent: An entity for the array elements to be used for
* element selection with Sel.
- * @todo
- * Do we need several entities? One might want
- * to select a dimension and not a single element in case of multi
- * dimensional arrays.
*/
/** Create a new type array.
* The entity for array elements is built automatically.
* Set dimension sizes after call to constructor with set_* routines.
*/
-ir_type *new_type_array (ident *name, int n_dimensions,
- ir_type *element_type);
+FIRM_API ir_type *new_type_array(int n_dims, ir_type *element_type);
/** Create a new type array with debug information.
*
* Set dimension sizes after call to constructor with set_* routines.
* A legal array type must have at least one dimension set.
*/
-ir_type *new_d_type_array (ident *name, int n_dimensions,
- ir_type *element_type, dbg_info* db);
+FIRM_API ir_type *new_d_type_array(int n_dims, ir_type *element_type,
+ type_dbg_info* db);
/* --- manipulate private fields of array type --- */
/** Returns the number of array dimensions of this type. */
-int get_array_n_dimensions (const ir_type *array);
+FIRM_API int get_array_n_dimensions(const ir_type *array);
/**
* Allocates Const nodes of mode_Is for one array dimension.
* Upper bound in Firm is the element next to the last, i.e. [lower,upper[
*/
-void set_array_bounds_int (ir_type *array, int dimension, int lower_bound,
- int upper_bound);
+FIRM_API void set_array_bounds_int(ir_type *array, int dimension,
+ int lower_bound, int upper_bound);
/**
* Sets the bounds for one array dimension.
* Upper bound in Firm is the element next to the last, i.e. [lower,upper[
*/
-void set_array_bounds (ir_type *array, int dimension, ir_node *lower_bound,
- ir_node *upper_bound);
+FIRM_API void set_array_bounds(ir_type *array, int dimension,
+ ir_node *lower_bound, ir_node *upper_bound);
/** Sets the lower bound for one array dimension, i.e. [lower,upper[ */
-void set_array_lower_bound (ir_type *array, int dimension, ir_node *lower_bound);
+FIRM_API void set_array_lower_bound(ir_type *array, int dimension,
+ ir_node *lower_bound);
/** Allocates Const nodes of mode_Is for the lower bound of an array
dimension, i.e. [lower,upper[ */
-void set_array_lower_bound_int (ir_type *array, int dimension, int lower_bound);
+FIRM_API void set_array_lower_bound_int(ir_type *array, int dimension,
+ int lower_bound);
/** Sets the upper bound for one array dimension, i.e. [lower,upper[ */
-void set_array_upper_bound (ir_type *array, int dimension, ir_node *upper_bound);
+FIRM_API void set_array_upper_bound(ir_type *array, int dimension,
+ ir_node *upper_bound);
/** Allocates Const nodes of mode_Is for the upper bound of an array
dimension, i.e. [lower,upper[. */
-void set_array_upper_bound_int (ir_type *array, int dimension, int upper_bound);
+FIRM_API void set_array_upper_bound_int(ir_type *array, int dimension,
+ int upper_bound);
/** Returns true if lower bound != Unknown. */
-int has_array_lower_bound (const ir_type *array, int dimension);
+FIRM_API int has_array_lower_bound(const ir_type *array, int dimension);
/** Returns the lower bound of an array. */
-ir_node * get_array_lower_bound (const ir_type *array, int dimension);
+FIRM_API ir_node *get_array_lower_bound(const ir_type *array, int dimension);
/** Works only if bound is Const node with tarval that can be converted to long. */
-long get_array_lower_bound_int (const ir_type *array, int dimension);
+FIRM_API long get_array_lower_bound_int(const ir_type *array, int dimension);
/** returns true if lower bound != Unknown */
-int has_array_upper_bound (const ir_type *array, int dimension);
+FIRM_API int has_array_upper_bound(const ir_type *array, int dimension);
/** Returns the upper bound of an array. */
-ir_node * get_array_upper_bound (const ir_type *array, int dimension);
+FIRM_API ir_node *get_array_upper_bound(const ir_type *array, int dimension);
/** Works only if bound is Const node with tarval that can be converted to long. */
-long get_array_upper_bound_int (const ir_type *array, int dimension);
+FIRM_API long get_array_upper_bound_int(const ir_type *array, int dimension);
/** Sets an array dimension to a specific order. */
-void set_array_order (ir_type *array, int dimension, int order);
+FIRM_API void set_array_order(ir_type *array, int dimension, int order);
/** Returns the order of an array dimension. */
-int get_array_order (const ir_type *array, int dimension);
+FIRM_API int get_array_order(const ir_type *array, int dimension);
/** Find the array dimension that is placed at order order. */
-int find_array_dimension(const ir_type *array, int order);
+FIRM_API int find_array_dimension(const ir_type *array, int order);
/** Sets the array element type. */
-void set_array_element_type (ir_type *array, ir_type* tp);
+FIRM_API void set_array_element_type(ir_type *array, ir_type* tp);
/** Gets the array element type. */
-ir_type *get_array_element_type (ir_type *array);
+FIRM_API ir_type *get_array_element_type(const ir_type *array);
/** Sets the array element entity. */
-void set_array_element_entity (ir_type *array, ir_entity *ent);
+FIRM_API void set_array_element_entity(ir_type *array, ir_entity *ent);
/** Get the array element entity. */
-ir_entity *get_array_element_entity (const ir_type *array);
+FIRM_API ir_entity *get_array_element_entity(const ir_type *array);
/** Returns true if a type is an array type. */
-int is_Array_type(const ir_type *array);
+FIRM_API int is_Array_type(const ir_type *array);
/**
* @page enumeration_type Representation of an enumeration type
*/
/** Create a new type enumeration -- set the enumerators independently. */
-ir_type *new_type_enumeration(ident *name, int n_enums);
+FIRM_API ir_type *new_type_enumeration(ident *name, int n_enums);
/** Create a new type enumeration with debug information -- set the enumerators independently. */
-ir_type *new_d_type_enumeration(ident *name, int n_enums, dbg_info *db);
+FIRM_API ir_type *new_d_type_enumeration(ident *name, int n_enums,
+ type_dbg_info *db);
/* --- manipulate fields of enumeration type. --- */
+/** return enumeration identifier */
+FIRM_API ident *get_enumeration_ident(const ir_type *enumeration);
+
+/** return enumeration identifier as c-string */
+FIRM_API const char *get_enumeration_name(const ir_type *enumeration);
+
/** Set an enumeration constant to a enumeration type at a given position. */
-void set_enumeration_const(ir_type *enumeration, int pos, ident *nameid, tarval *con);
+FIRM_API void set_enumeration_const(ir_type *enumeration, int pos,
+ ident *nameid, ir_tarval *con);
/** Returns the number of enumeration values of this enumeration */
-int get_enumeration_n_enums(const ir_type *enumeration);
+FIRM_API int get_enumeration_n_enums(const ir_type *enumeration);
/** Returns the enumeration constant at a given position. */
-ir_enum_const *get_enumeration_const(const ir_type *enumeration, int pos);
+FIRM_API ir_enum_const *get_enumeration_const(const ir_type *enumeration,
+ int pos);
/** Returns the enumeration type owner of an enumeration constant. */
-ir_type *get_enumeration_owner(const ir_enum_const *enum_cnst);
+FIRM_API ir_type *get_enumeration_owner(const ir_enum_const *enum_cnst);
/** Sets the enumeration constant value. */
-void set_enumeration_value(ir_enum_const *enum_cnst, tarval *con);
+FIRM_API void set_enumeration_value(ir_enum_const *enum_cnst, ir_tarval *con);
/** Returns the enumeration constant value. */
-tarval *get_enumeration_value(const ir_enum_const *enum_cnst);
+FIRM_API ir_tarval *get_enumeration_value(const ir_enum_const *enum_cnst);
/** Assign an ident to an enumeration constant. */
-void set_enumeration_nameid(ir_enum_const *enum_cnst, ident *id);
+FIRM_API void set_enumeration_nameid(ir_enum_const *enum_cnst, ident *id);
/** Returns the assigned ident of an enumeration constant. */
-ident *get_enumeration_nameid(const ir_enum_const *enum_cnst);
+FIRM_API ident *get_enumeration_const_nameid(const ir_enum_const *enum_cnst);
/** Returns the assigned name of an enumeration constant. */
-const char *get_enumeration_name(const ir_enum_const *enum_cnst);
+FIRM_API const char *get_enumeration_const_name(const ir_enum_const *enum_cnst);
/** Returns true if a type is a enumeration type. */
-int is_Enumeration_type(const ir_type *enumeration);
+FIRM_API int is_Enumeration_type(const ir_type *enumeration);
/**
* @page pointer_type Representation of a pointer type
*
- * The mode of the pointer type must be a reference mode.
- *
* Pointer types:
* - points_to: The type of the entity this pointer points to.
*/
/** Creates a new type pointer. */
-ir_type *new_type_pointer (ident *name, ir_type *points_to, ir_mode *ptr_mode);
+FIRM_API ir_type *new_type_pointer(ir_type *points_to);
/** Creates a new type pointer with debug information. */
-ir_type *new_d_type_pointer (ident *name, ir_type *points_to, ir_mode *ptr_mode, dbg_info* db);
+FIRM_API ir_type *new_d_type_pointer(ir_type *points_to, type_dbg_info* db);
/* --- manipulate fields of type_pointer --- */
/** Sets the type to which a pointer points to. */
-void set_pointer_points_to_type (ir_type *pointer, ir_type *tp);
+FIRM_API void set_pointer_points_to_type(ir_type *pointer, ir_type *tp);
/** Returns the type to which a pointer points to. */
-ir_type *get_pointer_points_to_type (ir_type *pointer);
+FIRM_API ir_type *get_pointer_points_to_type(const ir_type *pointer);
/** Returns true if a type is a pointer type. */
-int is_Pointer_type (const ir_type *pointer);
+FIRM_API int is_Pointer_type(const ir_type *pointer);
/** Returns the first pointer type that has as points_to tp.
- * Not efficient: O(#types).
+ * Not efficient: O(\#types).
* If not found returns firm_unknown_type. */
-ir_type *find_pointer_type_to_type (ir_type *tp);
+FIRM_API ir_type *find_pointer_type_to_type(ir_type *tp);
/**
* @page primitive_type Representation of a primitive type
* important information they carry is held in the common mode field.
*/
/** Creates a new primitive type. */
-ir_type *new_type_primitive(ident *name, ir_mode *mode);
+FIRM_API ir_type *new_type_primitive(ir_mode *mode);
/** Creates a new primitive type with debug information. */
-ir_type *new_d_type_primitive(ident *name, ir_mode *mode, dbg_info* db);
+FIRM_API ir_type *new_d_type_primitive(ir_mode *mode, type_dbg_info* db);
/** Returns true if a type is a primitive type. */
-int is_Primitive_type(const ir_type *primitive);
+FIRM_API int is_Primitive_type(const ir_type *primitive);
+/** Return the base type of a primitive (bitfield) type or NULL if none. */
+FIRM_API ir_type *get_primitive_base_type(const ir_type *tp);
+
+/** Sets the base type of a primitive (bitfield) type. */
+FIRM_API void set_primitive_base_type(ir_type *tp, ir_type *base_tp);
/**
* @page none_type The None type
* - size: 0
*/
/** A variable that contains the only none type. */
-extern ir_type *firm_none_type;
+FIRM_API ir_type *firm_none_type;
+
+/** A variable that contains the only code type. */
+FIRM_API ir_type *firm_code_type;
/** Returns the none type. */
-ir_type *get_none_type(void);
+FIRM_API ir_type *get_none_type(void);
+/** Returns the code type. */
+FIRM_API ir_type *get_code_type(void);
/**
* @page unknown_type The Unknown type
* - size: 0
*/
/** A variable that contains the only unknown type. */
-extern ir_type *firm_unknown_type;
+FIRM_API ir_type *firm_unknown_type;
/** Returns the unknown type. */
-ir_type *get_unknown_type(void);
+FIRM_API ir_type *get_unknown_type(void);
/**
* @param tp any type
* @return true if type is primitive, pointer or enumeration
*/
-int is_atomic_type(const ir_type *tp);
+FIRM_API int is_atomic_type(const ir_type *tp);
/* --- Support for compound types --- */
+/**
+ * Gets the identifier of a compound type
+ */
+FIRM_API ident *get_compound_ident(const ir_type *tp);
+
+/** return compound identifier as c-string */
+FIRM_API const char *get_compound_name(const ir_type *tp);
+
/**
* Gets the number of elements in a Firm compound type.
*
*
* @return Number of members in the compound type.
*/
-int get_compound_n_members(const ir_type *tp);
+FIRM_API int get_compound_n_members(const ir_type *tp);
/**
* Gets the member of a Firm compound type at position pos.
* @param pos The number of the member.
*
* @return The member entity at position pos.
- *
- * @see get_compound_n_members() for justification of existence.
*/
-ir_entity *get_compound_member(const ir_type *tp, int pos);
+FIRM_API ir_entity *get_compound_member(const ir_type *tp, int pos);
/** Returns index of member in tp, -1 if not contained. */
-int get_compound_member_index(const ir_type *tp, ir_entity *member);
+FIRM_API int get_compound_member_index(const ir_type *tp, ir_entity *member);
+
+/**
+ * layout members of a struct/union or class type in a default way.
+ */
+FIRM_API void default_layout_compound_type(ir_type *tp);
/**
* Checks whether a type is a compound type.
*
* @return true if the type is class, structure, union or array type.
*/
-int is_compound_type(const ir_type *tp);
+FIRM_API int is_compound_type(const ir_type *tp);
+
+/**
+ * Checks wether a type is a code type.
+ */
+FIRM_API int is_code_type(const ir_type *tp);
/**
* Checks, whether a type is a frame type.
*/
-int is_frame_type(const ir_type *tp);
+FIRM_API int is_frame_type(const ir_type *tp);
/**
* Checks, whether a type is a value parameter type.
*/
-int is_value_param_type(const ir_type *tp);
+FIRM_API int is_value_param_type(const ir_type *tp);
/**
* Checks, whether a type is a lowered type.
*/
-int is_lowered_type(const ir_type *tp);
+FIRM_API int is_lowered_type(const ir_type *tp);
+
+/**
+ * Makes a new value type. Value types are struct types,
+ * so all struct access functions work.
+ * Value types are not in the global list of types.
+ */
+FIRM_API ir_type *new_type_value(void);
/**
* Makes a new frame type. Frame types are class types,
* so all class access functions work.
* Frame types are not in the global list of types.
*/
-ir_type *new_type_frame(ident *name);
+FIRM_API ir_type *new_type_frame(void);
+
+/**
+ * Makes a clone of a frame type.
+ * Sets entity links from old frame entities to new onces and
+ * vice versa.
+ */
+FIRM_API ir_type *clone_frame_type(ir_type *type);
/**
* Sets a lowered type for a type. This sets both associations
* and marks lowered_type as a "lowered" one.
*/
-void set_lowered_type(ir_type *tp, ir_type *lowered_type);
+FIRM_API void set_lowered_type(ir_type *tp, ir_type *lowered_type);
/**
* Gets the lowered/unlowered type of a type or NULL if this type
* has no lowered/unlowered one.
*/
-ir_type *get_associated_type(const ir_type *tp);
+FIRM_API ir_type *get_associated_type(const ir_type *tp);
/**
* Allocate an area of size bytes aligned at alignment
*
* @return the entity representing the area
*/
-ir_entity *frame_alloc_area(ir_type *frame_type, int size, int alignment, int at_start);
+FIRM_API ir_entity *frame_alloc_area(ir_type *frame_type, int size,
+ unsigned alignment, int at_start);
/*-----------------------------------------------------------------*/
/** Debug aides **/
* debugging, (configure with --enable-debug) else returns the address
* of the type cast to long.
*/
-long get_type_nr(const ir_type *tp);
+FIRM_API long get_type_nr(const ir_type *tp);
/* ------------------------------------------------------------------------ */
*/
typedef int (compare_types_func_t)(const void *tp1, const void *tp2);
-/** Compares two types by their name.
- *
- * Compares the opcode and the name of the types. If these are
- * equal returns 0, else non-zero.
- */
-int compare_names (const void *tp1, const void *tp2);
-
-/** Compares two types strict.
- *
- * returns 0 if tp1 == tp2, else non-zero
- */
-int compare_strict (const void *tp1, const void *tp2);
-
-/* ------------------------------------------------------------------------ */
-
-/** Type for a function that computes a hash value for a type.
- *
- * @param tp The type to compute a hash for.
- */
-typedef int (hash_types_func_t)(ir_type *tp);
-
-/** Computes a hash value by the type name.
- *
- * Uses the name of the type and the type opcode to compute the hash.
- */
-int firm_hash_name (ir_type *tp);
-
/* ------------------------------------------------------------------------ */
-/** Finalize type construction.
- *
- * Indicate that a type is so far completed that it can be
- * distinguished from other types. Mature_type hashes the type into a
- * table. It uses the function in compare_types_func to compare the
- * types.
- *
- * If it finds a type identical to tp it returns this type. It turns
- * tp into the Id type. All places formerly pointing to tp will now
- * point to the found type. All entities of tp now refer to the found
- * type as their owner, but they are not a member of this type. This
- * is invalid firm -- the entities must be replaced by entities of the
- * found type. The Id type will be removed from the representation
- * automatically, but within an unknown time span. It occupies memory
- * for this time.
- *
- * @param tp The type to mature.
- */
-ir_type * mature_type(ir_type *tp);
-
-/** Finalize type construction.
- *
- * Indicate that a type is so far completed that it can be
- * distinguished from other types. Mature_type hashes the type into a
- * table. It uses the function in compare_types_func to compare the
- * types.
- *
- * If it finds a type identical to tp it returns this type. It frees
- * type tp and all its entities.
- *
- * @param tp The type to mature.
- */
-ir_type * mature_type_free(ir_type *tp);
-
-/** Finalize type construction.
- *
- * Indicate that a type is so far completed that it can be
- * distinguished from other types. Mature_type hashes the type into a
- * table. It uses the function in compare_types_func to compare the
- * types.
- *
- * If it find a type identical to tp it returns this type. It frees
- * the entities and turns the type into an Id type. All places
- * formerly pointing to tp will now point to the found type. The Id
- * type will be removed from the representation automatically, but
- * within an unknown time span. It occupies memory for this time.
- *
- * @param tp The type to mature.
- */
-ir_type * mature_type_free_entities(ir_type *tp);
-
-/**
- * The interface type for the type identify module;
- */
-typedef struct _type_identify_if_t {
- compare_types_func_t *cmp; /**< The function that should be used to compare two types.
- If NULL, compare_strict() will be used. */
- hash_types_func_t *hash; /**< The function that should be used to calculate a hash
- value of a type. If NULL, hash_name() will be used. */
-} type_identify_if_t;
-
-/**
- * Initialise the type identifier module.
- *
- * @param ti_if The interface functions for this module.
- *
- * If the parameter ti_if is NULL, the default functions compare_strict() and
- * firm_hash_name() will be used.
- */
-void init_type_identify(type_identify_if_t *ti_if);
-
/** A data type to treat types and entities as the same. */
typedef union {
- ir_type *typ; /**< points to a type */
- ir_entity *ent; /**< points to an entity */
+ ir_type *typ; /**< points to a type */
+ ir_entity *ent; /**< points to an entity */
} type_or_ent;
/** Type of argument functions for type walkers.
* @param tore points to the visited type or entity
* @param env free environment pointer
*/
-typedef void type_walk_func(type_or_ent *tore, void *env);
+typedef void type_walk_func(type_or_ent tore, void *env);
/** The class walk function
*
* types/entities are created during the traversal these will
* be visited, too.
* Does not touch frame types or types for value params ... */
-void type_walk(type_walk_func *pre, type_walk_func *post, void *env);
+FIRM_API void type_walk(type_walk_func *pre, type_walk_func *post, void *env);
+
+/** Touches every type, entity, frame type, and value param type in
+ * unspecified order (also all segment types). */
+FIRM_API void type_walk_prog(type_walk_func *pre, type_walk_func *post,
+ void *env);
/** Walks over all type information reachable from an ir graph.
*
* Walks over all type information reachable from irg, i.e., starts a
* type walk at the irgs entity, the irgs frame type and all types and
* entities that are attributes to firm nodes. */
-void type_walk_irg(ir_graph *irg, type_walk_func *pre, type_walk_func *post,
- void *env);
+FIRM_API void type_walk_irg(ir_graph *irg, type_walk_func *pre,
+ type_walk_func *post, void *env);
/**
- Touches every class in specified order:
- - first the super class
- - second the class itself
- - third the sub classes. If new classes are created
- during the traversal these will be visited, too.
-
- @todo should be named class-walk
-
- @deprecated will be removed?
-*/
-void type_walk_super2sub(type_walk_func *pre, type_walk_func *post, void *env);
+ * Touches every class in specified order:
+ * - first the super class
+ * - second the class itself
+ * - third the sub classes. If new classes are created
+ * during the traversal these will be visited, too.
+ *
+ * @deprecated will be removed?
+ */
+FIRM_API void type_walk_super2sub(type_walk_func *pre, type_walk_func *post,
+ void *env);
/** Walker for class types in inheritance order.
*
* visiting all superclasses.
*
* The arguments pre, post, env may be NULL. */
-void type_walk_super(type_walk_func *pre, type_walk_func *post, void *env);
+FIRM_API void type_walk_super(type_walk_func *pre, type_walk_func *post,
+ void *env);
/** Same as type_walk_super2sub, but visits only class types.
Executes pre for a class if all superclasses have been visited.
Then iterates to subclasses. Executes post after return from
subclass.
Does not visit global type, frame types.
-
- @bug ?? something is wrong with this.
*/
-void class_walk_super2sub(class_walk_func *pre, class_walk_func *post,
- void *env);
+FIRM_API void class_walk_super2sub(class_walk_func *pre, class_walk_func *post,
+ void *env);
/**
* the entity walk function. A function type for entity walkers.
* @param doit the entity walker function
* @param env environment, will be passed to the walker function
*/
-void walk_types_entities(ir_type *tp, entity_walk_func *doit, void *env);
+FIRM_API void walk_types_entities(ir_type *tp, entity_walk_func *doit,
+ void *env);
+
+/**
+ * If we have the closed world assumption, we can calculate the
+ * finalization of classes and entities by inspecting the class hierarchy.
+ * After this is done, all classes and entities that are not overridden
+ * anymore have the final property set.
+ */
+FIRM_API void types_calc_finalization(void);
+
+/** @deprecated */
+FIRM_API ir_visibility get_type_visibility(const ir_type *tp);
+/** @deprecated */
+FIRM_API void set_type_visibility(ir_type *tp, ir_visibility v);
+
+/** @deprecated */
+typedef enum {
+ allocation_automatic,
+ allocation_parameter,
+ allocation_dynamic,
+ allocation_static
+} ir_allocation;
+/** @deprecated */
+FIRM_API ir_allocation get_entity_allocation(const ir_entity *ent);
+/** @deprecated */
+FIRM_API void set_entity_allocation(ir_entity *ent, ir_allocation al);
+
+/** @deprecated */
+typedef enum {
+ peculiarity_existent,
+ peculiarity_description,
+ peculiarity_inherited
+} ir_peculiarity;
+/** @deprecated */
+FIRM_API ir_peculiarity get_entity_peculiarity(const ir_entity *ent);
+/** @deprecated */
+FIRM_API void set_entity_peculiarity(ir_entity *ent, ir_peculiarity pec);
+
+/** @deprecated */
+FIRM_API int is_entity_final(const ir_entity *ent);
+/** @deprecated */
+FIRM_API void set_entity_final(ir_entity *ent, int final);
+
+/** @deprecated */
+FIRM_API ir_peculiarity get_class_peculiarity(const ir_type *clss);
+/** @deprecated */
+FIRM_API void set_class_peculiarity(ir_type *clss, ir_peculiarity pec);
+
+#include "end.h"
#endif
projects / libfirm / blobdiff