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