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