Added Beck's VC obstack version. Updated VC project
[libfirm] / 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 <stdbool.h>
35 #include "irarch.h"
36 #include "archop.h"
37 #include "lowering.h"
38
39 typedef enum {
40         ASM_CONSTRAINT_FLAG_SUPPORTS_REGISTER     = 0x0001,
41         ASM_CONSTRAINT_FLAG_SUPPORTS_MEMOP        = 0x0002,
42         ASM_CONSTRAINT_FLAG_SUPPORTS_IMMEDIATE    = 0x0004,
43         ASM_CONSTRAINT_FLAG_NO_SUPPORT            = 0x0008,
44         ASM_CONSTRAINT_FLAG_MODIFIER_WRITE        = 0x0010,
45         ASM_CONSTRAINT_FLAG_MODIFIER_NO_WRITE     = 0x0020,
46         ASM_CONSTRAINT_FLAG_MODIFIER_READ         = 0x0040,
47         ASM_CONSTRAINT_FLAG_MODIFIER_NO_READ      = 0x0080,
48         ASM_CONSTRAINT_FLAG_MODIFIER_EARLYCLOBBER = 0x0100,
49         ASM_CONSTRAINT_FLAG_MODIFIER_COMMUTATIVE  = 0x0200,
50         ASM_CONSTRAINT_FLAG_INVALID               = 0x8000
51 } asm_constraint_flags_t;
52
53 /**
54  * This structure contains parameters that should be
55  * propagated to the libFirm parameter set.
56  */
57 typedef struct backend_params {
58         /** If set, the backend cannot handle DWORD access. */
59         unsigned do_dw_lowering:1;
60         /** If set, the backend supports inline assembly. */
61         unsigned support_inline_asm:1;
62         /** If set, the target architecture use an immediate floating point mode. */
63         unsigned has_imm_fp_mode:1;
64
65         /** Additional opcodes settings. */
66         const arch_ops_info *arch_op_settings;
67
68         /** Settings for architecture dependent optimizations. */
69         const ir_settings_arch_dep_t *dep_param;
70
71         /** The architecture specific intrinsic function creator. */
72         create_intrinsic_fkt *arch_create_intrinsic_fkt;
73
74         /** The context parameter for the create intrinsic function. */
75         void *create_intrinsic_ctx;
76
77         /** Backend settings for if-conversion. */
78         const ir_settings_if_conv_t *if_conv_info;
79
80         /** The immediate floating point mode. Temporaries are calculated using
81          * this mode. */
82         ir_mode *imm_fp_mode;
83 } backend_params;
84
85 /**
86  * Register the Firm backend command line options.
87  */
88 void be_opt_register(void);
89
90 /**
91  * Parse one backend argument.
92  */
93 int be_parse_arg(const char *arg);
94
95 /**
96  * Return the backend configuration parameter.
97  *
98  * @return libFirm configuration parameters for the selected
99  *         backend
100  */
101 const backend_params *be_get_backend_param(void);
102
103 /**
104  * Main interface to the frontend.
105  */
106 void be_main(FILE *output, const char *compilation_unit_name);
107
108 /**
109  * parse assembler constraint strings and returns flags (so the frontend knows
110  * which operands are inputs/outputs and wether memory is required)
111  */
112 asm_constraint_flags_t be_parse_asm_constraints(const char *constraints);
113
114 /**
115  * tests wether a string is a valid clobber in an asm instruction
116  */
117 bool be_is_valid_clobber(const char *clobber);
118
119 typedef struct be_main_env_t be_main_env_t;
120 typedef struct be_options_t  be_options_t;
121
122 #ifdef __cplusplus
123 }
124 #endif
125
126 #endif