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