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