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