X-Git-Url: http://nsz.repo.hu/git/?a=blobdiff_plain;f=include%2Flibfirm%2Ffirm_types.h;h=b794538c09b9c6cb1deae9ae8705c8965904b3c3;hb=fef8dc3eff6468d7d65485af8e1ac9884c504e1a;hp=3c3657e4631b5192e73f4d0df87a3b213a2225f6;hpb=7872ad07aaad9c53b8655e3d8947065557e0cbc0;p=libfirm diff --git a/include/libfirm/firm_types.h b/include/libfirm/firm_types.h index 3c3657e46..b794538c0 100644 --- a/include/libfirm/firm_types.h +++ b/include/libfirm/firm_types.h @@ -21,61 +21,114 @@ * @file * @brief Definition of opaque firm types * @author Michael Beck - * @version $Id$ */ #ifndef FIRM_COMMON_FIRM_TYPES_H #define FIRM_COMMON_FIRM_TYPES_H #include "begin.h" +/** + * @page visited_counters Visited Counters + * A visited counter is an alternative to a visited flag for elements of a + * graph datastructure. + * A visited counter is an integer number added to the elements of a graph. + * There is also a global reference number for the whole datastructure. It is + * now possible to mark nodes by setting their visited counter to the global + * reference counter. Testing is done by comparing with the global reference + * counter. + * The advantage to simple boolean flag variables is that you can clear all + * element marks by increasing the global reference counter and don't need to + * visit the whole structure. + * This makes it more efficient when you only visit/mark a small amount of + * nodes in the graph. + */ + +/** Type for visited counters + * @see visited_counters */ typedef unsigned long ir_visited_t; -typedef unsigned long ir_exc_region_t; +/** A label in the code (usually attached to a @ref Block) */ typedef unsigned long ir_label_t; -typedef struct dbg_info dbg_info, *dbg_info_ptr; -typedef struct type_dbg_info type_dbg_info, *type_dbg_info_ptr; -typedef struct ident ident, *ir_ident_ptr; -typedef struct ir_node ir_node, *ir_node_ptr; -typedef struct ir_op ir_op, *ir_op_ptr; -typedef struct ir_mode ir_mode, *ir_mode_ptr; -typedef struct ir_edge_t ir_edge_t, *ir_edge_ptr; +/** @ingroup dbg_info + * Source Reference */ +typedef struct dbg_info dbg_info; +/** @ingroup dbg_info + * Source Type Reference */ +typedef struct type_dbg_info type_dbg_info; +/** @ingroup ir_ident + * Identifier */ +typedef struct ident ident; +/** @ingroup ir_node + * Procedure Graph Node */ +typedef struct ir_node ir_node; +/** @ingroup ir_op + * Node Opcode */ +typedef struct ir_op ir_op; +/** @ingroup ir_mode + * SSA Value mode */ +typedef struct ir_mode ir_mode; +/** @ingroup iredges + * Dynamic Reverse Edge */ +typedef struct ir_edge_t ir_edge_t; +/** @ingroup ir_heights + * Computed graph Heights */ typedef struct ir_heights_t ir_heights_t; -typedef struct ir_tarval ir_tarval, *ir_tarval_ptr; -typedef struct ir_enum_const ir_enum_const, *ir_enum_const_ptr; -typedef struct ir_type ir_type, *ir_type_ptr; -typedef struct ir_graph ir_graph, *ir_graph_ptr; -typedef struct ir_prog ir_prog, *ir_prog_ptr; -typedef struct ir_loop ir_loop, *ir_loop_ptr; -typedef struct ir_region ir_region, *ir_region_ptr; -typedef struct ir_reg_tree ir_reg_tree, *ir_reg_tree_ptr; -typedef struct ir_entity ir_entity, *ir_entity_ptr; -typedef struct ir_extblk ir_extblk, *ir_extblk_ptr; -typedef struct ir_exec_freq ir_exec_freq, *ir_exec_freq_ptr; -typedef struct ir_cdep ir_cdep, *ir_cdep_ptr; -typedef struct sn_entry *seqno_t; +/** @ingroup ir_tarval + * Target Machine Value */ +typedef struct ir_tarval ir_tarval; +/** @ingroup enumeration_type + * Enumeration constant */ +typedef struct ir_enum_const ir_enum_const; +/** @ingroup ir_type + * Type */ +typedef struct ir_type ir_type; +/** @ingroup ir_graph + * Procedure Grpah */ +typedef struct ir_graph ir_graph; +/** @ingroup ir_prog + * Program */ +typedef struct ir_prog ir_prog; +/** @ingroup ir_loop + * Loop */ +typedef struct ir_loop ir_loop; +/** @ingroup ir_entity + * Entity */ +typedef struct ir_entity ir_entity; +/** @ingroup ir_cdep + * Control Dependence Analysis Results */ +typedef struct ir_cdep ir_cdep; +/** @ingroup be + * Target Architecture specific node operations */ typedef struct arch_irn_ops_t arch_irn_ops_t; -typedef struct type_identify_if_t type_identify_if_t; +/** A graph transformation pass */ typedef struct ir_graph_pass_t ir_graph_pass_t; +/** A whole program transformation pass */ typedef struct ir_prog_pass_t ir_prog_pass_t; +/** A graph pass manager */ typedef struct ir_graph_pass_manager_t ir_graph_pass_manager_t; +/** A program pass manager */ typedef struct ir_prog_pass_manager_t ir_prog_pass_manager_t; -typedef union ir_initializer_t ir_initializer_t, *ir_initializer_ptr; +/** @ingroup ir_initializer + * Initializer (for entities) */ +typedef union ir_initializer_t ir_initializer_t; +/** + * @ingroup irgwalk + * type for graph-walk callbacks */ typedef void irg_walk_func(ir_node *, void *); -typedef void irg_reg_walk_func(ir_region *, void *); - -/* settings */ -typedef struct ir_settings_arch_dep_t ir_settings_arch_dep_t; -typedef struct ir_settings_if_conv_t ir_settings_if_conv_t; - -/* Needed for MSVC to suppress warnings because it doest NOT handle const right. */ -typedef const ir_node *ir_node_cnst_ptr; -/* states */ +/** + * @ingroup Switch + * A switch table mapping integer numbers to proj-numbers of a Switch-node. + * Entries map a continuous range of integer numbers to a proj-number. + * There must never be two different entries matching the same integer number. + */ +typedef struct ir_switch_table ir_switch_table; /** + * @ingroup ir_cons * This function is called, whenever a local variable is used before definition * * @param irg the IR graph on which this happens @@ -86,7 +139,7 @@ typedef const ir_node *ir_node_cnst_ptr; * * @note * Do not return NULL! - * If this function is not set, FIRM will create a const node with tarval BAD. + * If this function is not set, FIRM will create an Unknown node. * Use set_irg_loc_description()/get_irg_loc_description() to assign additional * informations to local variables. */ @@ -104,6 +157,10 @@ typedef ir_node *uninitialized_local_variable_func_t(ir_graph *irg, ir_mode *mod static inline type operator |= (type& a, type b) { return a = (type)((int)a | (int)b); } \ } #else +/** Marks an enum type as bitset enum. That is the enumeration values will + * probably be combined to form a (bit)set of flags. + * When compiling for C++ this macro will define the ~, &, &=, ^, ^=, | and |= + * operators for the enum values. */ # define ENUM_BITSET(type) #endif @@ -114,10 +171,15 @@ typedef ir_node *uninitialized_local_variable_func_t(ir_graph *irg, ir_mode *mod static inline type operator --(type& a) { return a = (type)((int)a - 1); } \ } #else +/** Marks an enum type as countable enum. The enumeration values will be a + * linear sequence of numbers which can be iterated through by incrementing + * by 1. + * When compiling for C++ this macro will define the ++ and -- operators. */ # define ENUM_COUNTABLE(type) #endif /** + * @ingroup ir_node * Relations for comparing numbers */ typedef enum ir_relation { @@ -131,7 +193,7 @@ typedef enum ir_relation { ir_relation_less_greater = ir_relation_less|ir_relation_greater, /** less or greater ('not equal' for integer numbers) */ ir_relation_less_equal_greater = ir_relation_equal|ir_relation_less|ir_relation_greater, /**< less equal or greater ('not unordered') */ ir_relation_unordered_equal = ir_relation_unordered|ir_relation_equal, /**< unordered or equal */ - ir_relation_unordered_less = ir_relation_unordered|ir_relation_less, /**< unorderedor less */ + ir_relation_unordered_less = ir_relation_unordered|ir_relation_less, /**< unordered or less */ ir_relation_unordered_less_equal = ir_relation_unordered|ir_relation_less|ir_relation_equal, /**< unordered, less or equal */ ir_relation_unordered_greater = ir_relation_unordered|ir_relation_greater, /**< unordered or greater */ ir_relation_unordered_greater_equal = ir_relation_unordered|ir_relation_greater|ir_relation_equal, /**< unordered, greater or equal */ @@ -141,17 +203,24 @@ typedef enum ir_relation { ENUM_BITSET(ir_relation) /** + * @ingroup ir_node * constrained flags for memory operations. */ typedef enum ir_cons_flags { - cons_none = 0, /**< No constrains. */ - cons_volatile = 1U << 0, /**< Memory operation is volatile. */ - cons_unaligned = 1U << 1, /**< Memory operation is unaligned. */ - cons_floats = 1U << 2 /**< Memory operation can float. */ + cons_none = 0, /**< No constrains. */ + cons_volatile = 1U << 0, /**< Memory operation is volatile. */ + cons_unaligned = 1U << 1, /**< Memory operation is unaligned. */ + cons_floats = 1U << 2, /**< Memory operation can float. */ + cons_throws_exception = 1U << 3, /**< fragile op throws exception (and + produces X_regular and X_except + values) */ } ir_cons_flags; ENUM_BITSET(ir_cons_flags) -/** op_pin_state_pinned states. */ +/** + * @ingroup ir_node + * pinned states. + */ typedef enum op_pin_state { op_pin_state_floats = 0, /**< Nodes of this opcode can be placed in any basic block. */ op_pin_state_pinned = 1, /**< Nodes must remain in this basic block. */ @@ -162,6 +231,7 @@ typedef enum op_pin_state { } op_pin_state; /** + * @ingroup Cond * A type to express conditional jump predictions. */ typedef enum cond_jmp_predicate { @@ -171,54 +241,68 @@ typedef enum cond_jmp_predicate { } cond_jmp_predicate; /** + * @ingroup method_type * Additional method type properties: * Tell about special properties of a method type. Some * of these may be discovered by analyses. */ typedef enum mtp_additional_properties { - 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. - The only observable effect of a const function must be its - return value. So they must not exhibit infinite loops or wait - for user input. The return value must not depend on any - global variables/state. - 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). - The only observable effect of a const function must be its - return value. So they must not exhibit infinite loops or wait - for user input. - 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_returns_twice = 0x00000040, /**< This method can return more than one (typically setjmp). - GCC: __attribute__((returns_twice)). */ - mtp_property_intrinsic = 0x00000080, /**< This method is intrinsic. It is expected that - a lowering phase will remove all calls to it. */ - mtp_property_runtime = 0x00000100, /**< This method represents a runtime routine. */ - mtp_property_private = 0x00000200, /**< All method invocations are known, the backend is free to - optimize the call in any possible way. */ - mtp_property_has_loop = 0x00000400, /**< Set, if this method contains one possible endless loop. */ - mtp_property_inherited = (1<<31) /**< Internal. Used only in irg's, means property is - inherited from type. */ + /** no additional properties */ + mtp_no_property = 0, + /** This method did not access memory and calculates its return values + * solely from its parameters. The only observable effect of a const + * function must be its return value. So they must not exhibit infinite + * loops or wait for user input. The return value must not depend on any + * global variables/state. + * GCC: __attribute__((const)). */ + mtp_property_const = 1u << 0, + /** 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). The only observable effect of a const function must be its return + * value. So they must not exhibit infinite loops or wait for user input. + * GCC: __attribute__((pure)). */ + mtp_property_pure = 1u << 1, + /** This method did not return due to an aborting system call. + * GCC: __attribute__((noreturn)). */ + mtp_property_noreturn = 1u << 2, + /** This method cannot throw an exception. GCC: __attribute__((nothrow)). */ + mtp_property_nothrow = 1u << 3, + /** This method is naked. GCC: __attribute__((naked)). */ + mtp_property_naked = 1u << 4, + /** This method returns newly allocate memory. + * GCC: __attribute__((malloc)). */ + mtp_property_malloc = 1u << 5, + /** This method can return more than one (typically setjmp). + * GCC: __attribute__((returns_twice)). */ + mtp_property_returns_twice = 1u << 6, + /** This method is intrinsic. It is expected that a lowering phase will + * remove all calls to it. */ + mtp_property_intrinsic = 1u << 7, + /** This method represents a runtime routine. */ + mtp_property_runtime = 1u << 8, + /** All method invocations are known, the backend is free to optimize the + * call in any possible way. */ + mtp_property_private = 1u << 9, + /** Set, if this method contains one possibly endless loop. */ + mtp_property_has_loop = 1u << 10, + /** try to always inline this function, even if it seems nonprofitable */ + mtp_property_always_inline = 1u << 11, + /** the function should not be inlined */ + mtp_property_noinline = 1u << 12, + /** the programmer recommends to inline the function */ + mtp_property_inline_recommended = 1u << 13, + /** stupid hack used by opt_funccall... */ + mtp_temporary = 1u << 14, } mtp_additional_properties; ENUM_BITSET(mtp_additional_properties) -/** This enum names the different kinds of symbolic Constants represented by +/** + * @ingroup SymConst + * This enum names the different kinds of symbolic Constants represented by * SymConst. The content of the attribute symconst_symbol depends on this tag. - * Use the proper access routine after testing this flag. */ + * Use the proper access routine after testing this flag. + */ typedef enum symconst_kind { - symconst_type_tag, /**< The SymConst is a type tag for the given type. - symconst_symbol is type *. */ symconst_type_size, /**< The SymConst is the size of the given type. symconst_symbol is type *. */ symconst_type_align, /**< The SymConst is the alignment of the given type. @@ -232,9 +316,12 @@ typedef enum symconst_kind { enumeration type. */ } symconst_kind; -/** SymConst attribute. +/** + * @ingroup SymConst + * SymConst attribute. * * This union contains the symbolic information represented by the node. + * @ingroup SymConst */ typedef union symconst_symbol { ir_type *type_p; /**< The type of a SymConst. */ @@ -242,20 +329,27 @@ typedef union symconst_symbol { ir_enum_const *enum_p; /**< The enumeration constant of a SymConst. */ } symconst_symbol; -/** The allocation place. */ +/** + * @ingroup Alloc + * The allocation place. + */ typedef enum ir_where_alloc { stack_alloc, /**< Alloc allocates the object on the stack. */ heap_alloc /**< Alloc allocates the object on the heap. */ } ir_where_alloc; -/** A input/output constraint attribute. */ +/** A input/output constraint attribute. + * @ingroup ASM + */ typedef struct ir_asm_constraint { unsigned pos; /**< The inputs/output position for this constraint. */ ident *constraint; /**< The constraint for this input/output. */ ir_mode *mode; /**< The mode of the constraint. */ } ir_asm_constraint; -/** Supported libFirm builtins. */ +/** Supported libFirm builtins. + * @ingroup Builtin + */ typedef enum ir_builtin_kind { ir_bk_trap, /**< GCC __builtin_trap(): insert trap */ ir_bk_debugbreak, /**< MS __debugbreak(): insert debug break */ @@ -271,18 +365,9 @@ typedef enum ir_builtin_kind { ir_bk_inport, /**< in port */ ir_bk_outport, /**< out port */ ir_bk_inner_trampoline, /**< address of a trampoline for GCC inner functions */ + ir_bk_last = ir_bk_inner_trampoline, } ir_builtin_kind; -/** - * Some projection numbers must be always equal to support automatic phi construction - */ -enum pn_generic { - pn_Generic_M = 0, /**< The memory result. */ - pn_Generic_X_regular = 1, /**< Execution result if no exception occurred. */ - pn_Generic_X_except = 2, /**< The control flow result branching to the exception handler */ - pn_Generic_other = 3 /**< First free projection number */ -}; - /** * Possible return values of value_classify(). */