nsz Git - libfirm/blob - include/libfirm/be.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       Generic backend types and interfaces.
  23  * @author      Sebastian Hack
  24  */
  25 #ifndef FIRM_BE_MAIN_H
  26 #define FIRM_BE_MAIN_H
  27
  28 #include <stdio.h>
  29 #include "irarch.h"
  30 #include "lowering.h"
  31 #include "iroptimize.h"
  32 #include "begin.h"
  33
  34 /**
  35  * @defgroup be  Code Generation
  36  *
  37  * Code Generation (backend) produces machine-code.
  38  * @{
  39  */
  40
  41 /**
  42  * flags categorizing assembler constraint specifications
  43  */
  44 typedef enum asm_constraint_flags_t {
  45         ASM_CONSTRAINT_FLAG_NONE                  = 0, /**< no constraints */
  46         /** input/output can be in a register */
  47         ASM_CONSTRAINT_FLAG_SUPPORTS_REGISTER     = 1u << 0,
  48         /** input/output can be read/written to/from a memory address */
  49         ASM_CONSTRAINT_FLAG_SUPPORTS_MEMOP        = 1u << 1,
  50         /** input can be encoded as an immediate number */
  51         ASM_CONSTRAINT_FLAG_SUPPORTS_IMMEDIATE    = 1u << 2,
  52         /** the constraint is not supported yet by libFirm */
  53         ASM_CONSTRAINT_FLAG_NO_SUPPORT            = 1u << 3,
  54         /** The input is also written to */
  55         ASM_CONSTRAINT_FLAG_MODIFIER_WRITE        = 1u << 4,
  56         /** the input is not written to */
  57         ASM_CONSTRAINT_FLAG_MODIFIER_NO_WRITE     = 1u << 5,
  58         /** the input is read */
  59         ASM_CONSTRAINT_FLAG_MODIFIER_READ         = 1u << 6,
  60         /** the input is not read */
  61         ASM_CONSTRAINT_FLAG_MODIFIER_NO_READ      = 1u << 7,
  62         /** the value is modified before all inputs to the asm block
  63          * are handled. */
  64         ASM_CONSTRAINT_FLAG_MODIFIER_EARLYCLOBBER = 1u << 8,
  65         /** This operand and the following operand are commutative */
  66         ASM_CONSTRAINT_FLAG_MODIFIER_COMMUTATIVE  = 1u << 9,
  67         /** invalid constraint (due to parse error) */
  68         ASM_CONSTRAINT_FLAG_INVALID               = 1u << 10
  69 } asm_constraint_flags_t;
  70 ENUM_BITSET(asm_constraint_flags_t)
  71
  72 /**
  73  * Build a Trampoline for the closure.
  74  * @param block       the block where to build the trampoline
  75  * @param mem         memory
  76  * @param trampoline  address of a trampoline region
  77  * @param env         address of the environment
  78  * @param callee      address of the function to call
  79  *
  80  * @return modified memory
  81  */
  82 typedef ir_node *(create_trampoline_fkt)(ir_node *block, ir_node *mem, ir_node *trampoline, ir_node *env, ir_node *callee);
  83
  84 /**
  85  * This structure contains parameters that should be
  86  * propagated to the libFirm parameter set.
  87  */
  88 typedef struct backend_params {
  89         /** If set, the backend supports inline assembly. */
  90         unsigned support_inline_asm:1;
  91         /** If set, the backend supports Rotl nodes */
  92         unsigned support_rotl:1;
  93         /** the backend uses big-endian byte ordering if set, else little endian */
  94         unsigned byte_order_big_endian:1;
  95         /** whether the architecure can natively handle modulo shift modes.
  96          * If this is true, then you can assume that shifting in modes with
  97          * module_shift==machine_size (if mode size is <= machine_size) is efficient
  98          */
  99         unsigned modulo_shift_efficient:1;
 100         /** whether the architecure can natively handle modulo shift modes.
 101          * If this is true, then you can assume that shifting without modulo shift
 102          * is efficient
 103          */
 104         unsigned non_modulo_shift_efficient:1;
 105
 106         /** Settings for architecture dependent optimizations. */
 107         const ir_settings_arch_dep_t *dep_param;
 108
 109         /** Backend settings for if-conversion. */
 110         arch_allow_ifconv_func allow_ifconv;
 111
 112         /** size of machine words. This is usually the size of the general purpose
 113          * integer registers. */
 114         unsigned machine_size;
 115
 116         /**
 117          * some backends like x87 can only do arithmetic in a specific float
 118          * mode (load/store are still done in the "normal" float/double modes).
 119          */
 120         ir_mode *mode_float_arithmetic;
 121
 122         /**
 123          * type used for long long or NULL if none available.
 124          */
 125         ir_type *type_long_long;
 126
 127         /**
 128          * type used for unsigned long long or NULL if none available
 129          */
 130         ir_type *type_unsigned_long_long;
 131
 132         /**
 133          * type used for long double or NULL if none available.
 134          */
 135         ir_type *type_long_double;
 136
 137         /** Size of the trampoline code. */
 138         unsigned trampoline_size;
 139
 140         /** Alignment of the trampoline code. */
 141         unsigned trampoline_align;
 142
 143         /** If non-zero, build the trampoline. */
 144         create_trampoline_fkt *build_trampoline;
 145
 146         /** Alignment of stack parameters */
 147         unsigned stack_param_align;
 148 } backend_params;
 149
 150 /**
 151  * Parse one backend argument.
 152  */
 153 FIRM_API int be_parse_arg(const char *arg);
 154
 155 /**
 156  * Returns the backend configuration parameter.
 157  *
 158  * @return libFirm configuration parameters for the selected
 159  *         backend
 160  */
 161 FIRM_API const backend_params *be_get_backend_param(void);
 162
 163 /**
 164  * Lowers current program for the target architecture.
 165  * This must be run once before using be_main. The idea here is that the backend
 166  * can perform lowerings like doubleword-lowering, ABI adjustments or
 167  * implementation of boolean values, if-conversion, with target specific
 168  * settings.
 169  * The resulting graph is still a "normal" firm-graph on which you can and
 170  * should perform further architecture-neutral optimisations before be_main.
 171  */
 172 FIRM_API void be_lower_for_target(void);
 173
 174 /**
 175  * Creates an ir_prog pass which performs lowerings necessary for the target
 176  * architecture. (Calling backend_params->lower_for_target)
 177  */
 178 FIRM_API ir_prog_pass_t *lower_for_target_pass(const char *name);
 179
 180 /**
 181  * Main interface to the frontend.
 182  */
 183 FIRM_API void be_main(FILE *output, const char *compilation_unit_name);
 184
 185 /**
 186  * parse assembler constraint strings and returns flags (so the frontend knows
 187  * which operands are inputs/outputs and whether memory is required)
 188  */
 189 FIRM_API asm_constraint_flags_t be_parse_asm_constraints(const char *constraints);
 190
 191 /**
 192  * tests whether a string is a valid clobber in an ASM instruction
 193  */
 194 FIRM_API int be_is_valid_clobber(const char *clobber);
 195
 196 /** @} */
 197
 198 #include "end.h"
 199
 200 #endif