nsz Git - libfirm/blob - include/libfirm/be.h

   1 /*
   2  * Copyright (C) 1995-2007 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 "archop.h"
  32 #include "lowering.h"
  33 #include "dbginfo.h"
  34 #include "iroptimize.h"
  35
  36 #include <libcore/lc_timing.h>
  37
  38 #define LC_STOP_AND_RESET_TIMER(timer) do { lc_timer_stop(timer); lc_timer_reset(timer); } while(0)
  39
  40 /** For inline assembler: get a register from a name and encode it into a backend specific value. */
  41 typedef unsigned (get_register_fkt)(const char *reg);
  42
  43 /**
  44  * This structure contains parameters that should be
  45  * propagated to the libFirm parameter set.
  46  */
  47 typedef struct backend_params {
  48         /** if set, the backend cannot handle DWORD access */
  49         unsigned do_dw_lowering:1;
  50         /** if set, the backend supports inline assembly */
  51         unsigned support_inline_asm:1;
  52
  53         /** Additional opcodes settings. */
  54         const arch_ops_info *arch_op_settings;
  55
  56         /** Settings for architecture dependent optimizations */
  57         const arch_dep_params_t *dep_param;
  58
  59         /** the architecture specific intrinsic function creator */
  60         create_intrinsic_fkt *arch_create_intrinsic_fkt;
  61
  62         /** the context parameter for the create intrinsic function */
  63         void *create_intrinsic_ctx;
  64
  65         /** backend settings for if-conversion */
  66         const opt_if_conv_info_t *if_conv_info;
  67
  68         /** get the backend specific register encoding for a register name */
  69         get_register_fkt *get_register_from_name;
  70 } backend_params;
  71
  72 /**
  73  * Register the Firm backend command line options.
  74  */
  75 void be_opt_register(void);
  76
  77 /**
  78  * Parse one backend argument.
  79  */
  80 int be_parse_arg(const char *arg);
  81
  82 /**
  83  * Initialize the Firm backend. Must be run BEFORE init_firm()!
  84  *
  85  * @return libFirm configuration parameters for the selected
  86  *         backend
  87  */
  88 const backend_params *be_init(void);
  89
  90 /**
  91  * Main interface to the frontend.
  92  */
  93 void be_main(FILE *file_handle, const char *cup_name);
  94
  95 /** The type of the debug info retriever function. */
  96 typedef const char *(*retrieve_dbg_func)(const dbg_info *dbg, unsigned *line);
  97
  98 /**
  99  * Sets a debug info retriever.
 100  *
 101  * @param func   the debug retriever function.
 102  */
 103 void be_set_debug_retrieve(retrieve_dbg_func func);
 104
 105 /**
 106  * Retrieve the debug info.
 107  */
 108 const char *be_retrieve_dbg_info(const dbg_info *dbg, unsigned *line);
 109
 110 typedef struct be_main_env_t be_main_env_t;
 111 typedef struct be_options_t  be_options_t;
 112
 113 #endif /* FIRM_BE_MAIN_H */