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