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