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

   1 /*
   2  * Copyright (C) 1995-2008 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 typedef unsigned long ir_visited_t;
  30 typedef unsigned long ir_exc_region_t;
  31 typedef unsigned long ir_label_t;
  32
  33 typedef struct dbg_info             dbg_info,            *dbg_info_ptr;
  34 typedef struct type_dbg_info        type_dbg_info;
  35 typedef const struct _ident         ident,               *ir_ident_ptr;
  36 typedef struct ir_node              ir_node,             *ir_node_ptr;
  37 typedef struct ir_op                ir_op,               *ir_op_ptr;
  38 typedef struct ir_mode              ir_mode,             *ir_mode_ptr;
  39 typedef struct _ir_edge_t           ir_edge_t,           *ir_edge_ptr;
  40 typedef struct tarval               tarval,              *ir_tarval_ptr;
  41 typedef struct ir_enum_const        ir_enum_const,       *ir_enum_const_ptr;
  42 typedef struct ir_type              ir_type,             *ir_type_ptr;
  43 typedef struct ir_graph             ir_graph,            *ir_graph_ptr;
  44 typedef struct ir_prog              ir_prog,             *ir_prog_ptr;
  45 typedef struct ir_loop              ir_loop,             *ir_loop_ptr;
  46 typedef struct ir_region            ir_region,           *ir_region_ptr;
  47 typedef struct ir_reg_tree          ir_reg_tree,         *ir_reg_tree_ptr;
  48 typedef struct ir_entity            ir_entity,           *ir_entity_ptr;
  49 typedef struct _ir_phase            ir_phase,            *ir_phase_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 ident_if_t           ident_if_t;
  56 typedef struct type_identify_if_t   type_identify_if_t;
  57 typedef struct ir_graph_pass_t      ir_graph_pass_t;
  58 typedef struct ir_prog_pass_t       ir_prog_pass_t;
  59
  60 typedef struct ir_graph_pass_manager_t      ir_graph_pass_manager_t;
  61 typedef struct ir_prog_pass_manager_t       ir_prog_pass_manager_t;
  62
  63 typedef union  ir_initializer_t     ir_initializer_t,    *ir_initializer_ptr;
  64
  65 typedef void irg_walk_func(ir_node *, void *);
  66 typedef void irg_reg_walk_func(ir_region *, void *);
  67
  68 /* settings */
  69 typedef struct ir_settings_arch_dep_t ir_settings_arch_dep_t;
  70 typedef struct ir_settings_if_conv_t  ir_settings_if_conv_t;
  71
  72 /* states */
  73
  74 /** The state of the interprocedural view.
  75  *
  76  * This value indicates the state of the interprocedural view.
  77  */
  78 typedef enum {
  79         ip_view_no,       /**< The interprocedural view is not constructed.  There are no
  80                                view specific nodes (EndReg, Filter, Break ...) in any graph.  */
  81         ip_view_valid,    /**< The interprocedural view is valid.  */
  82         ip_view_invalid   /**< The interprocedural view is invalid.  Specific nodes are
  83                                all still in the representation, but the graph is no more complete. */
  84 } ip_view_state;
  85
  86 /**
  87  * This function is called, whenever a local variable is used before definition
  88  *
  89  * @param irg       the IR graph on which this happens
  90  * @param mode      the mode of the local var
  91  * @param pos       position chosen be the frontend for this variable (n_loc)
  92  *
  93  * @return a firm node of mode @p mode that initializes the var at position pos
  94  *
  95  * @note
  96  *      Do not return NULL!
  97  *      If this function is not set, FIRM will create a const node with tarval BAD.
  98  *      Use set_irg_loc_description()/get_irg_loc_description() to assign additional
  99  *      informations to local variables.
 100  */
 101 typedef ir_node *uninitialized_local_variable_func_t(ir_graph *irg, ir_mode *mode, int pos);
 102
 103 /** op_pin_state_pinned states. */
 104 typedef enum {
 105         op_pin_state_floats = 0,    /**< Nodes of this opcode can be placed in any basic block. */
 106         op_pin_state_pinned = 1,    /**< Nodes must remain in this basic block. */
 107         op_pin_state_exc_pinned,    /**< Node must be remain in this basic block if it can throw an
 108                                          exception, else can float. Used internally. */
 109         op_pin_state_mem_pinned     /**< Node must be remain in this basic block if it can throw an
 110                                          exception or uses memory, else can float. Used internally. */
 111 } op_pin_state;
 112
 113 /**
 114  * Additional method type properties:
 115  * Tell about special properties of a method type. Some
 116  * of these may be discovered by analyses.
 117  */
 118 typedef enum {
 119         mtp_no_property            = 0x00000000, /**< no additional properties, default */
 120         mtp_property_const         = 0x00000001, /**< This method did not access memory and calculates
 121                                                       its return values solely from its parameters.
 122                                                       GCC: __attribute__((const)). */
 123         mtp_property_pure          = 0x00000002, /**< This method did NOT write to memory and calculates
 124                                                       its return values solely from its parameters and
 125                                                       the memory they points to (or global vars).
 126                                                       GCC: __attribute__((pure)). */
 127         mtp_property_noreturn      = 0x00000004, /**< This method did not return due to an aborting system
 128                                                       call.
 129                                                       GCC: __attribute__((noreturn)). */
 130         mtp_property_nothrow       = 0x00000008, /**< This method cannot throw an exception.
 131                                                       GCC: __attribute__((nothrow)). */
 132         mtp_property_naked         = 0x00000010, /**< This method is naked.
 133                                                       GCC: __attribute__((naked)). */
 134         mtp_property_malloc        = 0x00000020, /**< This method returns newly allocate memory.
 135                                                       GCC: __attribute__((malloc)). */
 136         mtp_property_weak          = 0x00000040, /**< This method is weak. It is expected that
 137                                                       GCC: __attribute__((weak)). */
 138         mtp_property_returns_twice = 0x00000080, /**< This method can return more than one (typically setjmp).
 139                                                   GCC: __attribute__((returns_twice)). */
 140         mtp_property_intrinsic     = 0x00000100, /**< This method is intrinsic. It is expected that
 141                                                       a lowering phase will remove all calls to it. */
 142         mtp_property_runtime       = 0x00000200, /**< This method represents a runtime routine. */
 143         mtp_property_private       = 0x00000400, /**< All method invocations are known, the backend is free to
 144                                                       optimize the call in any possible way. */
 145         mtp_property_has_loop      = 0x00000800, /**< Set, if this method contains one possible endless loop. */
 146         mtp_property_inherited     = (1<<31)     /**< Internal. Used only in irg's, means property is
 147                                                       inherited from type. */
 148 } mtp_additional_property;
 149
 150 /**  This enum names the three different kinds of symbolic Constants
 151      represented by SymConst.  The content of the attribute type_or_id
 152      depends on this tag.  Use the proper access routine after testing
 153      this flag. */
 154 typedef enum {
 155         symconst_type_tag,    /**< The SymConst is a type tag for the given type.
 156                                    symconst_symbol is type *. */
 157         symconst_type_size,   /**< The SymConst is the size of the given type.
 158                                    symconst_symbol is type *. */
 159         symconst_type_align,  /**< The SymConst is the alignment of the given type.
 160                                    symconst_symbol is type *. */
 161         symconst_addr_name,   /**< The SymConst is a symbolic pointer to be filled in
 162                                    by the linker.  The pointer is represented by a string.
 163                                    symconst_symbol is ident *. */
 164         symconst_addr_ent,    /**< The SymConst is a symbolic pointer to be filled in
 165                                    by the linker.  The pointer is represented by an entity.
 166                                    symconst_symbol is entity *. */
 167         symconst_ofs_ent,     /**< The SymConst is the offset of its entity in the entities
 168                                    owner type. */
 169         symconst_enum_const   /**< The SymConst is a enumeration constant of an
 170                                    enumeration type. */
 171 } symconst_kind;
 172
 173 /** SymConst attribute.
 174  *
 175  *  This union contains the symbolic information represented by the node.
 176  */
 177 typedef union symconst_symbol {
 178         ir_type       *type_p;    /**< The type of a SymConst. */
 179         ident         *ident_p;   /**< The ident of a SymConst. */
 180         ir_entity     *entity_p;  /**< The entity of a SymConst. */
 181         ir_enum_const *enum_p;    /**< The enumeration constant of a SymConst. */
 182 } symconst_symbol;
 183
 184 /**
 185  * Projection numbers for Cmp are defined several times.
 186  * The bit patterns are used for various tests, so don't change.
 187  * The "unordered" values are possible results of comparing
 188  * floating point numbers.
 189  * Note that the encoding is imported, so do NOT change the order.
 190  */
 191 typedef enum {
 192         pn_Cmp_False = 0,                             /**< false */
 193         pn_Cmp_Eq    = 1,                             /**< equal */
 194         pn_Cmp_Lt    = 2,                             /**< less */
 195         pn_Cmp_Le    = pn_Cmp_Eq|pn_Cmp_Lt,           /**< less or equal */
 196         pn_Cmp_Gt    = 4,                             /**< greater */
 197         pn_Cmp_Ge    = pn_Cmp_Eq|pn_Cmp_Gt,           /**< greater or equal */
 198         pn_Cmp_Lg    = pn_Cmp_Lt|pn_Cmp_Gt,           /**< less or greater */
 199         pn_Cmp_Leg   = pn_Cmp_Lt|pn_Cmp_Eq|pn_Cmp_Gt, /**< less, equal or greater = ordered */
 200         pn_Cmp_Uo    = 8,                             /**< unordered */
 201         pn_Cmp_Ue    = pn_Cmp_Uo|pn_Cmp_Eq,           /**< unordered or equal */
 202         pn_Cmp_Ul    = pn_Cmp_Uo|pn_Cmp_Lt,           /**< unordered or less */
 203         pn_Cmp_Ule   = pn_Cmp_Uo|pn_Cmp_Eq|pn_Cmp_Lt, /**< unordered, less or equal */
 204         pn_Cmp_Ug    = pn_Cmp_Uo|pn_Cmp_Gt,           /**< unordered or greater */
 205         pn_Cmp_Uge   = pn_Cmp_Uo|pn_Cmp_Eq|pn_Cmp_Gt, /**< unordered, greater or equal */
 206         pn_Cmp_Ne    = pn_Cmp_Uo|pn_Cmp_Lt|pn_Cmp_Gt, /**< unordered, less or greater = not equal */
 207         pn_Cmp_True  = 15                             /**< true */
 208         /* not_mask = Leg*/   /* bits to flip to negate comparison * @@ hack for JNI interface */
 209 } pn_Cmp;   /* Projection numbers for Cmp */
 210
 211 /** The allocation place. */
 212 typedef enum {
 213         stack_alloc,          /**< Alloc allocates the object on the stack. */
 214         heap_alloc            /**< Alloc allocates the object on the heap. */
 215 } ir_where_alloc;
 216
 217 /** A input/output constraint attribute. */
 218 typedef struct {
 219         unsigned       pos;           /**< The inputs/output position for this constraint. */
 220         ident          *constraint;   /**< The constraint for this input/output. */
 221         ir_mode        *mode;         /**< The mode of the constraint. */
 222 } ir_asm_constraint;
 223
 224 /** Supported libFirm builtins. */
 225 typedef enum {
 226         ir_bk_trap,                   /**< GCC __builtin_trap(): insert trap */
 227         ir_bk_debugbreak,             /**< MS __debugbreak(): insert debug break */
 228         ir_bk_return_address,         /**< GCC __builtin_return_address() */
 229         ir_bk_frame_address,          /**< GCC __builtin_frame_address() */
 230         ir_bk_prefetch,               /**< GCC __builtin_prefetch() */
 231         ir_bk_ffs,                    /**< GCC __builtin_ffs(): find first (least) significant 1 bit */
 232         ir_bk_clz,                    /**< GCC __builtin_clz(): count leading zero */
 233         ir_bk_ctz,                    /**< GCC __builtin_ctz(): count trailing zero */
 234         ir_bk_popcount,               /**< GCC __builtin_popcount(): population count */
 235         ir_bk_parity,                 /**< GCC __builtin_parity(): parity */
 236         ir_bk_bswap,                  /**< byte swap */
 237         ir_bk_inport,                 /**< in port */
 238         ir_bk_outport,                /**< out port */
 239         ir_bk_inner_trampoline,       /**< address of a trampoline for GCC inner functions */
 240 } ir_builtin_kind;
 241
 242 #endif