nsz Git - libfirm/blob - include/libfirm/firm_types.h

   1 /*
   2  * Copyright (C) 1995-2010 University of Karlsruhe.  All right reserved.
   3  *
   4  * This file is part of libFirm.
   5  *
   6  * This file may be distributed and/or modified under the terms of the
   7  * GNU General Public License version 2 as published by the Free Software
   8  * Foundation and appearing in the file LICENSE.GPL included in the
   9  * packaging of this file.
  10  *
  11  * Licensees holding valid libFirm Professional Edition licenses may use
  12  * this file in accordance with the libFirm Commercial License.
  13  * Agreement provided with the Software.
  14  *
  15  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
  16  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  17  * PURPOSE.
  18  */
  19
  20 /**
  21  * @file
  22  * @brief      Definition of opaque firm types
  23  * @author     Michael Beck
  24  */
  25 #ifndef FIRM_COMMON_FIRM_TYPES_H
  26 #define FIRM_COMMON_FIRM_TYPES_H
  27
  28 #include "begin.h"
  29
  30 typedef unsigned long ir_visited_t;
  31 typedef unsigned long ir_exc_region_t;
  32 typedef unsigned long ir_label_t;
  33
  34 typedef struct dbg_info             dbg_info,            *dbg_info_ptr;
  35 typedef struct type_dbg_info        type_dbg_info,       *type_dbg_info_ptr;
  36 typedef struct ident                ident,               *ir_ident_ptr;
  37 typedef struct ir_node              ir_node,             *ir_node_ptr;
  38 typedef struct ir_op                ir_op,               *ir_op_ptr;
  39 typedef struct ir_mode              ir_mode,             *ir_mode_ptr;
  40 typedef struct ir_edge_t            ir_edge_t,           *ir_edge_ptr;
  41 typedef struct ir_heights_t         ir_heights_t;
  42 typedef struct ir_tarval            ir_tarval,           *ir_tarval_ptr;
  43 typedef struct ir_enum_const        ir_enum_const,       *ir_enum_const_ptr;
  44 typedef struct ir_type              ir_type,             *ir_type_ptr;
  45 typedef struct ir_graph             ir_graph,            *ir_graph_ptr;
  46 typedef struct ir_prog              ir_prog,             *ir_prog_ptr;
  47 typedef struct ir_loop              ir_loop,             *ir_loop_ptr;
  48 typedef struct ir_region            ir_region,           *ir_region_ptr;
  49 typedef struct ir_entity            ir_entity,           *ir_entity_ptr;
  50 typedef struct ir_extblk            ir_extblk,           *ir_extblk_ptr;
  51 typedef struct ir_exec_freq         ir_exec_freq,        *ir_exec_freq_ptr;
  52 typedef struct ir_cdep              ir_cdep,             *ir_cdep_ptr;
  53 typedef struct sn_entry             *seqno_t;
  54 typedef struct arch_irn_ops_t       arch_irn_ops_t;
  55 typedef struct ir_graph_pass_t      ir_graph_pass_t;
  56 typedef struct ir_prog_pass_t       ir_prog_pass_t;
  57
  58 typedef struct ir_graph_pass_manager_t      ir_graph_pass_manager_t;
  59 typedef struct ir_prog_pass_manager_t       ir_prog_pass_manager_t;
  60
  61 typedef union  ir_initializer_t     ir_initializer_t,    *ir_initializer_ptr;
  62
  63 typedef void irg_walk_func(ir_node *, void *);
  64 typedef void irg_reg_walk_func(ir_region *, void *);
  65
  66 /**
  67  * A switch table mapping integer numbers to proj-numbers of a Switch-node.
  68  * Entries map a continuous range of integer numbers to a proj-number.
  69  * There must never be two different entries matching the same integer number.
  70  */
  71 typedef struct ir_switch_table  ir_switch_table;
  72
  73 /* Needed for MSVC to suppress warnings because it doest NOT handle const right. */
  74 typedef const ir_node *ir_node_cnst_ptr;
  75
  76 /* states */
  77
  78 /**
  79  * This function is called, whenever a local variable is used before definition
  80  *
  81  * @param irg       the IR graph on which this happens
  82  * @param mode      the mode of the local var
  83  * @param pos       position chosen be the frontend for this variable (n_loc)
  84  *
  85  * @return a firm node of mode @p mode that initializes the var at position pos
  86  *
  87  * @note
  88  *      Do not return NULL!
  89  *      If this function is not set, FIRM will create a const node with tarval BAD.
  90  *      Use set_irg_loc_description()/get_irg_loc_description() to assign additional
  91  *      informations to local variables.
  92  */
  93 typedef ir_node *uninitialized_local_variable_func_t(ir_graph *irg, ir_mode *mode, int pos);
  94
  95 #ifdef __cplusplus
  96 # define ENUM_BITSET(type) \
  97         extern "C++" { \
  98                 static inline type operator ~  (type  a)         { return     (type)~(int)a;           } \
  99                 static inline type operator &  (type  a, type b) { return     (type)((int)a & (int)b); } \
 100                 static inline type operator &= (type& a, type b) { return a = (type)((int)a & (int)b); } \
 101                 static inline type operator ^  (type  a, type b) { return     (type)((int)a ^ (int)b); } \
 102                 static inline type operator ^= (type& a, type b) { return a = (type)((int)a ^ (int)b); } \
 103                 static inline type operator |  (type  a, type b) { return     (type)((int)a | (int)b); } \
 104                 static inline type operator |= (type& a, type b) { return a = (type)((int)a | (int)b); } \
 105         }
 106 #else
 107 # define ENUM_BITSET(type)
 108 #endif
 109
 110 #ifdef __cplusplus
 111 # define ENUM_COUNTABLE(type) \
 112         extern "C++" { \
 113                 static inline type operator ++(type& a) { return a = (type)((int)a + 1); } \
 114                 static inline type operator --(type& a) { return a = (type)((int)a - 1); } \
 115         }
 116 #else
 117 # define ENUM_COUNTABLE(type)
 118 #endif
 119
 120 /**
 121  * Relations for comparing numbers
 122  */
 123 typedef enum ir_relation {
 124         ir_relation_false              = 0,       /**< always false */
 125         ir_relation_equal              = 1u << 0, /**< equal */
 126         ir_relation_less               = 1u << 1, /**< less */
 127         ir_relation_greater            = 1u << 2, /**< greater */
 128         ir_relation_unordered          = 1u << 3, /**< unordered */
 129         ir_relation_less_equal         = ir_relation_equal|ir_relation_less,    /**< less or equal */
 130         ir_relation_greater_equal      = ir_relation_equal|ir_relation_greater, /**< greater or equal */
 131         ir_relation_less_greater       = ir_relation_less|ir_relation_greater,  /** less or greater ('not equal' for integer numbers) */
 132         ir_relation_less_equal_greater = ir_relation_equal|ir_relation_less|ir_relation_greater, /**< less equal or greater ('not unordered') */
 133         ir_relation_unordered_equal    = ir_relation_unordered|ir_relation_equal, /**< unordered or equal */
 134         ir_relation_unordered_less     = ir_relation_unordered|ir_relation_less,  /**< unordered or less */
 135         ir_relation_unordered_less_equal = ir_relation_unordered|ir_relation_less|ir_relation_equal, /**< unordered, less or equal */
 136         ir_relation_unordered_greater    = ir_relation_unordered|ir_relation_greater, /**< unordered or greater */
 137         ir_relation_unordered_greater_equal = ir_relation_unordered|ir_relation_greater|ir_relation_equal, /**< unordered, greater or equal */
 138         ir_relation_unordered_less_greater  = ir_relation_unordered|ir_relation_less|ir_relation_greater, /**< unordered, less or greater ('not equal' for floatingpoint numbers) */
 139         ir_relation_true                    = ir_relation_equal|ir_relation_less|ir_relation_greater|ir_relation_unordered, /**< always true */
 140 } ir_relation;
 141 ENUM_BITSET(ir_relation)
 142
 143 /**
 144  * constrained flags for memory operations.
 145  */
 146 typedef enum ir_cons_flags {
 147         cons_none             = 0,        /**< No constrains. */
 148         cons_volatile         = 1U << 0,  /**< Memory operation is volatile. */
 149         cons_unaligned        = 1U << 1,  /**< Memory operation is unaligned. */
 150         cons_floats           = 1U << 2,  /**< Memory operation can float. */
 151         cons_throws_exception = 1U << 3,  /**< fragile op throws exception (and
 152                                                produces X_regular and X_except
 153                                                values) */
 154 } ir_cons_flags;
 155 ENUM_BITSET(ir_cons_flags)
 156
 157 /** op_pin_state_pinned states. */
 158 typedef enum op_pin_state {
 159         op_pin_state_floats = 0,    /**< Nodes of this opcode can be placed in any basic block. */
 160         op_pin_state_pinned = 1,    /**< Nodes must remain in this basic block. */
 161         op_pin_state_exc_pinned,    /**< Node must be remain in this basic block if it can throw an
 162                                          exception, else can float. Used internally. */
 163         op_pin_state_mem_pinned     /**< Node must be remain in this basic block if it can throw an
 164                                          exception or uses memory, else can float. Used internally. */
 165 } op_pin_state;
 166
 167 /**
 168  * A type to express conditional jump predictions.
 169  */
 170 typedef enum cond_jmp_predicate {
 171         COND_JMP_PRED_NONE,        /**< No jump prediction. Default. */
 172         COND_JMP_PRED_TRUE,        /**< The True case is predicted. */
 173         COND_JMP_PRED_FALSE        /**< The False case is predicted. */
 174 } cond_jmp_predicate;
 175
 176 /**
 177  * Additional method type properties:
 178  * Tell about special properties of a method type. Some
 179  * of these may be discovered by analyses.
 180  */
 181 typedef enum mtp_additional_properties {
 182         mtp_no_property            = 0x00000000, /**< no additional properties, default */
 183         mtp_property_const         = 0x00000001, /**< This method did not access memory and calculates
 184                                                       its return values solely from its parameters.
 185                                                       The only observable effect of a const function must be its
 186                                                       return value. So they must not exhibit infinite loops or wait
 187                                                       for user input. The return value must not depend on any
 188                                                       global variables/state.
 189                                                       GCC: __attribute__((const)). */
 190         mtp_property_pure          = 0x00000002, /**< This method did NOT write to memory and calculates
 191                                                       its return values solely from its parameters and
 192                                                       the memory they points to (or global vars).
 193                                                       The only observable effect of a const function must be its
 194                                                       return value. So they must not exhibit infinite loops or wait
 195                                                       for user input.
 196                                                       GCC: __attribute__((pure)). */
 197         mtp_property_noreturn      = 0x00000004, /**< This method did not return due to an aborting system
 198                                                       call.
 199                                                       GCC: __attribute__((noreturn)). */
 200         mtp_property_nothrow       = 0x00000008, /**< This method cannot throw an exception.
 201                                                       GCC: __attribute__((nothrow)). */
 202         mtp_property_naked         = 0x00000010, /**< This method is naked.
 203                                                       GCC: __attribute__((naked)). */
 204         mtp_property_malloc        = 0x00000020, /**< This method returns newly allocate memory.
 205                                                       GCC: __attribute__((malloc)). */
 206         mtp_property_returns_twice = 0x00000040, /**< This method can return more than one (typically setjmp).
 207                                                   GCC: __attribute__((returns_twice)). */
 208         mtp_property_intrinsic     = 0x00000080, /**< This method is intrinsic. It is expected that
 209                                                       a lowering phase will remove all calls to it. */
 210         mtp_property_runtime       = 0x00000100, /**< This method represents a runtime routine. */
 211         mtp_property_private       = 0x00000200, /**< All method invocations are known, the backend is free to
 212                                                       optimize the call in any possible way. */
 213         mtp_property_has_loop      = 0x00000400, /**< Set, if this method contains one possible endless loop. */
 214         mtp_property_inherited     = (1<<31)     /**< Internal. Used only in irg's, means property is
 215                                                       inherited from type. */
 216 } mtp_additional_properties;
 217 ENUM_BITSET(mtp_additional_properties)
 218
 219 /**  This enum names the different kinds of symbolic Constants represented by
 220  * SymConst.  The content of the attribute symconst_symbol depends on this tag.
 221  * Use the proper access routine after testing this flag. */
 222 typedef enum symconst_kind {
 223         symconst_type_size,   /**< The SymConst is the size of the given type.
 224                                    symconst_symbol is type *. */
 225         symconst_type_align,  /**< The SymConst is the alignment of the given type.
 226                                    symconst_symbol is type *. */
 227         symconst_addr_ent,    /**< The SymConst is a symbolic pointer to be filled in
 228                                    by the linker.  The pointer is represented by an entity.
 229                                    symconst_symbol is entity *. */
 230         symconst_ofs_ent,     /**< The SymConst is the offset of its entity in the entities
 231                                    owner type. */
 232         symconst_enum_const   /**< The SymConst is a enumeration constant of an
 233                                    enumeration type. */
 234 } symconst_kind;
 235
 236 /** SymConst attribute.
 237  *
 238  *  This union contains the symbolic information represented by the node.
 239  */
 240 typedef union symconst_symbol {
 241         ir_type       *type_p;    /**< The type of a SymConst. */
 242         ir_entity     *entity_p;  /**< The entity of a SymConst. */
 243         ir_enum_const *enum_p;    /**< The enumeration constant of a SymConst. */
 244 } symconst_symbol;
 245
 246 /** The allocation place. */
 247 typedef enum ir_where_alloc {
 248         stack_alloc,          /**< Alloc allocates the object on the stack. */
 249         heap_alloc            /**< Alloc allocates the object on the heap. */
 250 } ir_where_alloc;
 251
 252 /** A input/output constraint attribute. */
 253 typedef struct ir_asm_constraint {
 254         unsigned       pos;           /**< The inputs/output position for this constraint. */
 255         ident          *constraint;   /**< The constraint for this input/output. */
 256         ir_mode        *mode;         /**< The mode of the constraint. */
 257 } ir_asm_constraint;
 258
 259 /** Supported libFirm builtins. */
 260 typedef enum ir_builtin_kind {
 261         ir_bk_trap,                   /**< GCC __builtin_trap(): insert trap */
 262         ir_bk_debugbreak,             /**< MS __debugbreak(): insert debug break */
 263         ir_bk_return_address,         /**< GCC __builtin_return_address() */
 264         ir_bk_frame_address,          /**< GCC __builtin_frame_address() */
 265         ir_bk_prefetch,               /**< GCC __builtin_prefetch() */
 266         ir_bk_ffs,                    /**< GCC __builtin_ffs(): find first (least) significant 1 bit */
 267         ir_bk_clz,                    /**< GCC __builtin_clz(): count leading zero */
 268         ir_bk_ctz,                    /**< GCC __builtin_ctz(): count trailing zero */
 269         ir_bk_popcount,               /**< GCC __builtin_popcount(): population count */
 270         ir_bk_parity,                 /**< GCC __builtin_parity(): parity */
 271         ir_bk_bswap,                  /**< byte swap */
 272         ir_bk_inport,                 /**< in port */
 273         ir_bk_outport,                /**< out port */
 274         ir_bk_inner_trampoline,       /**< address of a trampoline for GCC inner functions */
 275         ir_bk_last = ir_bk_inner_trampoline,
 276 } ir_builtin_kind;
 277
 278 /**
 279  * Possible return values of value_classify().
 280  */
 281 typedef enum ir_value_classify_sign {
 282         value_classified_unknown  = 0,   /**< could not classify */
 283         value_classified_positive = 1,   /**< value is positive, i.e. >= 0 */
 284         value_classified_negative = -1   /**< value is negative, i.e. <= 0 if
 285                                               no signed zero exists or < 0 else */
 286 } ir_value_classify_sign;
 287
 288 /**
 289  * This enumeration flags the volatility of entities and Loads/Stores.
 290  */
 291 typedef enum {
 292         volatility_non_volatile,    /**< The entity is not volatile. Default. */
 293         volatility_is_volatile      /**< The entity is volatile. */
 294 } ir_volatility;
 295
 296 /**
 297  * This enumeration flags the align of Loads/Stores.
 298  */
 299 typedef enum {
 300         align_is_aligned = 0, /**< The entity is aligned. Default */
 301         align_non_aligned,    /**< The entity is not aligned. */
 302 } ir_align;
 303
 304 #include "end.h"
 305
 306 #endif