X-Git-Url: http://nsz.repo.hu/git/?a=blobdiff_plain;f=include%2Flibfirm%2Ffirm_types.h;h=3c5a1d2ec0b046a2960ae4761d0906d85007cc16;hb=3a35ad5729f045e01df1608fbd21780e285ba43a;hp=fbf73f759877235ba9fa42bff03deb94955162d1;hpb=a3e63495da14d138b0cfea237c17f814ffd343b1;p=libfirm diff --git a/include/libfirm/firm_types.h b/include/libfirm/firm_types.h index fbf73f759..3c5a1d2ec 100644 --- a/include/libfirm/firm_types.h +++ b/include/libfirm/firm_types.h @@ -1,5 +1,5 @@ /* - * Copyright (C) 1995-2008 University of Karlsruhe. All right reserved. + * Copyright (C) 1995-2010 University of Karlsruhe. All right reserved. * * This file is part of libFirm. * @@ -21,58 +21,117 @@ * @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 const 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; -typedef struct tarval 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 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; +/** @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 execfreq + * Execution Frequency Analysis Results */ +typedef struct ir_exec_freq ir_exec_freq; +/** @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 ident_if_t ident_if_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; -/* 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 @@ -89,8 +148,83 @@ typedef struct ir_settings_if_conv_t ir_settings_if_conv_t; */ typedef ir_node *uninitialized_local_variable_func_t(ir_graph *irg, ir_mode *mode, int pos); -/** op_pin_state_pinned states. */ -typedef enum { +#ifdef __cplusplus +# define ENUM_BITSET(type) \ + extern "C++" { \ + static inline type operator ~ (type a) { return (type)~(int)a; } \ + static inline type operator & (type a, type b) { return (type)((int)a & (int)b); } \ + static inline type operator &= (type& a, type b) { return a = (type)((int)a & (int)b); } \ + static inline type operator ^ (type a, type b) { return (type)((int)a ^ (int)b); } \ + static inline type operator ^= (type& a, type b) { return a = (type)((int)a ^ (int)b); } \ + static inline type operator | (type a, type b) { return (type)((int)a | (int)b); } \ + 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 + +#ifdef __cplusplus +# define ENUM_COUNTABLE(type) \ + extern "C++" { \ + static inline type operator ++(type& a) { return a = (type)((int)a + 1); } \ + 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 { + ir_relation_false = 0, /**< always false */ + ir_relation_equal = 1u << 0, /**< equal */ + ir_relation_less = 1u << 1, /**< less */ + ir_relation_greater = 1u << 2, /**< greater */ + ir_relation_unordered = 1u << 3, /**< unordered */ + ir_relation_less_equal = ir_relation_equal|ir_relation_less, /**< less or equal */ + ir_relation_greater_equal = ir_relation_equal|ir_relation_greater, /**< greater or equal */ + 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, /**< 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 */ + ir_relation_unordered_less_greater = ir_relation_unordered|ir_relation_less|ir_relation_greater, /**< unordered, less or greater ('not equal' for floatingpoint numbers) */ + ir_relation_true = ir_relation_equal|ir_relation_less|ir_relation_greater|ir_relation_unordered, /**< always true */ +} 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_throws_exception = 1U << 3, /**< fragile op throws exception (and + produces X_regular and X_except + values) */ +} ir_cons_flags; +ENUM_BITSET(ir_cons_flags) + +/** + * @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. */ op_pin_state_exc_pinned, /**< Node must be remain in this basic block if it can throw an @@ -100,27 +234,36 @@ typedef enum { } op_pin_state; /** + * @ingroup Cond * A type to express conditional jump predictions. */ -typedef enum { +typedef enum cond_jmp_predicate { COND_JMP_PRED_NONE, /**< No jump prediction. Default. */ COND_JMP_PRED_TRUE, /**< The True case is predicted. */ COND_JMP_PRED_FALSE /**< The False case is predicted. */ } 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 { +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. @@ -141,14 +284,16 @@ typedef enum { 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. */ -} mtp_additional_property; +} 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. @@ -162,9 +307,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. */ @@ -172,21 +320,28 @@ typedef union symconst_symbol { ir_enum_const *enum_p; /**< The enumeration constant of a SymConst. */ } symconst_symbol; -/** The allocation place. */ -typedef enum { +/** + * @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. */ -typedef struct { +/** 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. */ -typedef enum { +/** 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 */ ir_bk_return_address, /**< GCC __builtin_return_address() */ @@ -201,17 +356,34 @@ typedef enum { 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 + * Possible return values of value_classify(). + */ +typedef enum ir_value_classify_sign { + value_classified_unknown = 0, /**< could not classify */ + value_classified_positive = 1, /**< value is positive, i.e. >= 0 */ + value_classified_negative = -1 /**< value is negative, i.e. <= 0 if + no signed zero exists or < 0 else */ +} ir_value_classify_sign; + +/** + * This enumeration flags the volatility of entities and Loads/Stores. */ -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 */ -}; +typedef enum { + volatility_non_volatile, /**< The entity is not volatile. Default. */ + volatility_is_volatile /**< The entity is volatile. */ +} ir_volatility; + +/** + * This enumeration flags the align of Loads/Stores. + */ +typedef enum { + align_is_aligned = 0, /**< The entity is aligned. Default */ + align_non_aligned, /**< The entity is not aligned. */ +} ir_align; #include "end.h"