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 #ifdef __cplusplus
  30 extern "C" {
  31 #endif
  32
  33 #include <stdio.h>
  34 #include "irarch.h"
  35 #include "lowering.h"
  36
  37 typedef enum {
  38         ASM_CONSTRAINT_FLAG_SUPPORTS_REGISTER     = 0x0001,
  39         ASM_CONSTRAINT_FLAG_SUPPORTS_MEMOP        = 0x0002,
  40         ASM_CONSTRAINT_FLAG_SUPPORTS_IMMEDIATE    = 0x0004,
  41         ASM_CONSTRAINT_FLAG_NO_SUPPORT            = 0x0008,
  42         ASM_CONSTRAINT_FLAG_MODIFIER_WRITE        = 0x0010,
  43         ASM_CONSTRAINT_FLAG_MODIFIER_NO_WRITE     = 0x0020,
  44         ASM_CONSTRAINT_FLAG_MODIFIER_READ         = 0x0040,
  45         ASM_CONSTRAINT_FLAG_MODIFIER_NO_READ      = 0x0080,
  46         ASM_CONSTRAINT_FLAG_MODIFIER_EARLYCLOBBER = 0x0100,
  47         ASM_CONSTRAINT_FLAG_MODIFIER_COMMUTATIVE  = 0x0200,
  48         ASM_CONSTRAINT_FLAG_INVALID               = 0x8000
  49 } asm_constraint_flags_t;
  50
  51 /**
  52  * Build a Trampoline for the closure.
  53  * @param block       the block where to build the trampoline
  54  * @param mem         memory
  55  * @param trampoline  address of a trampoline region
  56  * @param env         address of the environment
  57  * @param callee      address of the function to call
  58  *
  59  * @return modified memory
  60  */
  61 typedef ir_node *(create_trampoline_fkt)(ir_node *block, ir_node *mem, ir_node *trampoline, ir_node *env, ir_node *callee);
  62
  63 /**
  64  * This structure contains parameters that should be
  65  * propagated to the libFirm parameter set.
  66  */
  67 typedef struct backend_params {
  68         /** If set, the backend cannot handle DWORD access. */
  69         unsigned do_dw_lowering:1;
  70         /** If set, the backend supports inline assembly. */
  71         unsigned support_inline_asm:1;
  72
  73         /** Settings for architecture dependent optimizations. */
  74         const ir_settings_arch_dep_t *dep_param;
  75
  76         /** The architecture specific intrinsic function creator. */
  77         create_intrinsic_fkt *arch_create_intrinsic_fkt;
  78
  79         /** The context parameter for the create intrinsic function. */
  80         void *create_intrinsic_ctx;
  81
  82         /** Backend settings for if-conversion. */
  83         const ir_settings_if_conv_t *if_conv_info;
  84
  85         /**
  86          * some backends like x87 can only do arithmetic in a specific float
  87          * mode (but convert to/from other float modes).
  88          */
  89         ir_mode *mode_float_arithmetic;
  90
  91         /** Size of the trampoline code. */
  92         unsigned trampoline_size;
  93
  94         /** Alignment of the trampoline code. */
  95         unsigned trampoline_align;
  96
  97         /** If non-zero, build the trampoline. */
  98         create_trampoline_fkt *build_trampoline;
  99
 100         /** Alignment of stack parameters */
 101         unsigned stack_param_align;
 102 } backend_params;
 103
 104 /**
 105  * Register the Firm backend command line options.
 106  */
 107 void be_opt_register(void);
 108
 109 /**
 110  * Parse one backend argument.
 111  */
 112 int be_parse_arg(const char *arg);
 113
 114 /**
 115  * Return the backend configuration parameter.
 116  *
 117  * @return libFirm configuration parameters for the selected
 118  *         backend
 119  */
 120 const backend_params *be_get_backend_param(void);
 121
 122 /**
 123  * Main interface to the frontend.
 124  */
 125 void be_main(FILE *output, const char *compilation_unit_name);
 126
 127 /**
 128  * parse assembler constraint strings and returns flags (so the frontend knows
 129  * which operands are inputs/outputs and whether memory is required)
 130  */
 131 asm_constraint_flags_t be_parse_asm_constraints(const char *constraints);
 132
 133 /**
 134  * tests whether a string is a valid clobber in an ASM instruction
 135  */
 136 int be_is_valid_clobber(const char *clobber);
 137
 138 typedef struct be_main_env_t be_main_env_t;
 139 typedef struct be_options_t  be_options_t;
 140
 141 #ifdef __cplusplus
 142 }
 143 #endif
 144
 145 #endif