X-Git-Url: http://nsz.repo.hu/git/?a=blobdiff_plain;ds=sidebyside;f=include%2Flibfirm%2Ffirm_types.h;h=b794538c09b9c6cb1deae9ae8705c8965904b3c3;hb=cb2216c4f25f3999bf5718e7a2cb4523263fa474;hp=93041148239c1b544a657c5a6f7869ca04212ca1;hpb=a8eca43d4d35aea313aa36271ed07db5ba0817bb;p=libfirm diff --git a/include/libfirm/firm_types.h b/include/libfirm/firm_types.h index 930411482..b794538c0 100644 --- a/include/libfirm/firm_types.h +++ b/include/libfirm/firm_types.h @@ -27,57 +27,100 @@ #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; +/** A label in the code (usually attached to a @ref Block) */ typedef unsigned long ir_label_t; -/** @ingroup dbg_info */ +/** @ingroup dbg_info + * Source Reference */ typedef struct dbg_info dbg_info; -/** @ingroup dbg_info */ +/** @ingroup dbg_info + * Source Type Reference */ typedef struct type_dbg_info type_dbg_info; -/** @ingroup ir_ident */ +/** @ingroup ir_ident + * Identifier */ typedef struct ident ident; -/** @ingroup ir_node */ +/** @ingroup ir_node + * Procedure Graph Node */ typedef struct ir_node ir_node; -/** @ingroup ir_op */ +/** @ingroup ir_op + * Node Opcode */ typedef struct ir_op ir_op; -/** @ingroup ir_mode */ +/** @ingroup ir_mode + * SSA Value mode */ typedef struct ir_mode ir_mode; -/** @ingroup iredges */ +/** @ingroup iredges + * Dynamic Reverse Edge */ typedef struct ir_edge_t ir_edge_t; -/** @ingroup ir_heights */ +/** @ingroup ir_heights + * Computed graph Heights */ typedef struct ir_heights_t ir_heights_t; -/** @ingroup ir_tarval */ +/** @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 */ +/** @ingroup ir_type + * Type */ typedef struct ir_type ir_type; -/** @ingroup ir_graph */ +/** @ingroup ir_graph + * Procedure Grpah */ typedef struct ir_graph ir_graph; -/** @ingroup ir_prog */ +/** @ingroup ir_prog + * Program */ typedef struct ir_prog ir_prog; -/** @ingroup ir_loop */ +/** @ingroup ir_loop + * Loop */ typedef struct ir_loop ir_loop; -/** @ingroup ir_entity */ +/** @ingroup ir_entity + * Entity */ typedef struct ir_entity ir_entity; -typedef struct ir_extblk ir_extblk; -/** @ingroup execfreq */ -typedef struct ir_exec_freq ir_exec_freq; -/** @ingroup ir_cdep */ +/** @ingroup ir_cdep + * Control Dependence Analysis Results */ typedef struct ir_cdep ir_cdep; -/** @ingroup ir_op */ +/** @ingroup be + * Target Architecture specific node operations */ typedef struct arch_irn_ops_t arch_irn_ops_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; -/** @ingroup ir_initializer */ +/** @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 *); /** + * @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. @@ -85,6 +128,7 @@ typedef void irg_walk_func(ir_node *, void *); 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 @@ -95,7 +139,7 @@ typedef struct ir_switch_table ir_switch_table; * * @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. */ @@ -113,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 @@ -123,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 { @@ -150,6 +203,7 @@ typedef enum ir_relation { ENUM_BITSET(ir_relation) /** + * @ingroup ir_node * constrained flags for memory operations. */ typedef enum ir_cons_flags { @@ -163,7 +217,10 @@ typedef enum ir_cons_flags { } 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. */ @@ -174,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 { @@ -183,51 +241,67 @@ 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_size, /**< The SymConst is the size of the given type. symconst_symbol is type *. */ @@ -242,7 +316,9 @@ 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 @@ -253,8 +329,9 @@ 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. */