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