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  * @version     $Id$
  25  */
  26 #ifndef FIRM_BE_MAIN_H
  27 #define FIRM_BE_MAIN_H
  28
  29 #include <stdio.h>
  30 #include "irarch.h"
  31 #include "lowering.h"
  32 #include "iroptimize.h"
  33 #include "begin.h"
  34
  35 typedef enum {
  36         ASM_CONSTRAINT_FLAG_SUPPORTS_REGISTER     = 0x0001,
  37         ASM_CONSTRAINT_FLAG_SUPPORTS_MEMOP        = 0x0002,
  38         ASM_CONSTRAINT_FLAG_SUPPORTS_IMMEDIATE    = 0x0004,
  39         ASM_CONSTRAINT_FLAG_NO_SUPPORT            = 0x0008,
  40         ASM_CONSTRAINT_FLAG_MODIFIER_WRITE        = 0x0010,
  41         ASM_CONSTRAINT_FLAG_MODIFIER_NO_WRITE     = 0x0020,
  42         ASM_CONSTRAINT_FLAG_MODIFIER_READ         = 0x0040,
  43         ASM_CONSTRAINT_FLAG_MODIFIER_NO_READ      = 0x0080,
  44         ASM_CONSTRAINT_FLAG_MODIFIER_EARLYCLOBBER = 0x0100,
  45         ASM_CONSTRAINT_FLAG_MODIFIER_COMMUTATIVE  = 0x0200,
  46         ASM_CONSTRAINT_FLAG_INVALID               = 0x8000
  47 } asm_constraint_flags_t;
  48
  49 /**
  50  * Build a Trampoline for the closure.
  51  * @param block       the block where to build the trampoline
  52  * @param mem         memory
  53  * @param trampoline  address of a trampoline region
  54  * @param env         address of the environment
  55  * @param callee      address of the function to call
  56  *
  57  * @return modified memory
  58  */
  59 typedef ir_node *(create_trampoline_fkt)(ir_node *block, ir_node *mem, ir_node *trampoline, ir_node *env, ir_node *callee);
  60
  61 /** callback where the backend performs required lowering for the target
  62  * architecture. Typical examples are transforming doubleword operations into
  63  * sequences of word operations. The callback should be invoked before the
  64  * frontend, because it is usually a good idea to perform other optimisations
  65  * after the lowering
  66  */
  67 typedef void (*lower_for_target_func)(void);
  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
  81         /** callback that performs lowerings required for target architecture */
  82         lower_for_target_func lower_for_target;
  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         /**
  91          * some backends like x87 can only do arithmetic in a specific float
  92          * mode (but convert to/from other float modes).
  93          */
  94         ir_mode *mode_float_arithmetic;
  95
  96         /** Size of the trampoline code. */
  97         unsigned trampoline_size;
  98
  99         /** Alignment of the trampoline code. */
 100         unsigned trampoline_align;
 101
 102         /** If non-zero, build the trampoline. */
 103         create_trampoline_fkt *build_trampoline;
 104
 105         /** Alignment of stack parameters */
 106         unsigned stack_param_align;
 107 } backend_params;
 108
 109 /**
 110  * Register the Firm backend command line options.
 111  */
 112 FIRM_API void be_opt_register(void);
 113
 114 /**
 115  * Parse one backend argument.
 116  */
 117 FIRM_API int be_parse_arg(const char *arg);
 118
 119 /**
 120  * Return the backend configuration parameter.
 121  *
 122  * @return libFirm configuration parameters for the selected
 123  *         backend
 124  */
 125 FIRM_API const backend_params *be_get_backend_param(void);
 126
 127 /**
 128  * Creates an ir_prog pass which performs lowerings necessary for the target
 129  * architecture. (Calling backend_params->lower_for_target)
 130  */
 131 FIRM_API ir_prog_pass_t *lower_for_target_pass(const char *name);
 132
 133 /**
 134  * Main interface to the frontend.
 135  */
 136 FIRM_API void be_main(FILE *output, const char *compilation_unit_name);
 137
 138 /**
 139  * parse assembler constraint strings and returns flags (so the frontend knows
 140  * which operands are inputs/outputs and whether memory is required)
 141  */
 142 FIRM_API asm_constraint_flags_t be_parse_asm_constraints(const char *constraints);
 143
 144 /**
 145  * tests whether a string is a valid clobber in an ASM instruction
 146  */
 147 FIRM_API int be_is_valid_clobber(const char *clobber);
 148
 149 typedef struct be_main_env_t be_main_env_t;
 150 typedef struct be_options_t  be_options_t;
 151
 152 #include "end.h"
 153
 154 #endif