Commit | Line | Data |
---|---|---|
bb2ec1b3 | 1 | /* Header file for GDB compile command and supporting functions. |
61baf725 | 2 | Copyright (C) 2014-2017 Free Software Foundation, Inc. |
bb2ec1b3 TT |
3 | |
4 | This program is free software; you can redistribute it and/or modify | |
5 | it under the terms of the GNU General Public License as published by | |
6 | the Free Software Foundation; either version 3 of the License, or | |
7 | (at your option) any later version. | |
8 | ||
9 | This program is distributed in the hope that it will be useful, | |
10 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
11 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
12 | GNU General Public License for more details. | |
13 | ||
14 | You should have received a copy of the GNU General Public License | |
15 | along with this program. If not, see <http://www.gnu.org/licenses/>. */ | |
16 | ||
17 | #ifndef GDB_COMPILE_INTERNAL_H | |
18 | #define GDB_COMPILE_INTERNAL_H | |
19 | ||
20 | #include "hashtab.h" | |
21 | #include "gcc-c-interface.h" | |
8d297bbf PA |
22 | #include "common/enum-flags.h" |
23 | ||
24 | /* enum-flags wrapper. */ | |
25 | DEF_ENUM_FLAGS_TYPE (enum gcc_qualifiers, gcc_qualifiers_flags); | |
bb2ec1b3 TT |
26 | |
27 | /* Debugging flag for the "compile" family of commands. */ | |
28 | ||
29 | extern int compile_debug; | |
30 | ||
31 | struct block; | |
32 | ||
33 | /* An object of this type holds state associated with a given | |
34 | compilation job. */ | |
35 | ||
36 | struct compile_instance | |
37 | { | |
38 | /* The GCC front end. */ | |
39 | ||
40 | struct gcc_base_context *fe; | |
41 | ||
42 | /* The "scope" of this compilation. */ | |
43 | ||
44 | enum compile_i_scope_types scope; | |
45 | ||
46 | /* The block in which an expression is being parsed. */ | |
47 | ||
48 | const struct block *block; | |
49 | ||
50 | /* Specify "-std=gnu11", "-std=gnu++11" or similar. These options are put | |
51 | after CU's DW_AT_producer compilation options to override them. */ | |
52 | ||
53 | const char *gcc_target_options; | |
54 | ||
55 | /* How to destroy this object. */ | |
56 | ||
57 | void (*destroy) (struct compile_instance *); | |
58 | }; | |
59 | ||
60 | /* A subclass of compile_instance that is specific to the C front | |
61 | end. */ | |
62 | struct compile_c_instance | |
63 | { | |
64 | /* Base class. Note that the base class vtable actually points to a | |
65 | gcc_c_fe_vtable. */ | |
66 | ||
67 | struct compile_instance base; | |
68 | ||
69 | /* Map from gdb types to gcc types. */ | |
70 | ||
71 | htab_t type_map; | |
72 | ||
73 | /* Map from gdb symbols to gcc error messages to emit. */ | |
74 | ||
75 | htab_t symbol_err_map; | |
76 | }; | |
77 | ||
78 | /* A helper macro that takes a compile_c_instance and returns its | |
79 | corresponding gcc_c_context. */ | |
80 | ||
81 | #define C_CTX(I) ((struct gcc_c_context *) ((I)->base.fe)) | |
82 | ||
83 | /* Define header and footers for different scopes. */ | |
84 | ||
85 | /* A simple scope just declares a function named "_gdb_expr", takes no | |
86 | arguments and returns no value. */ | |
87 | ||
88 | #define COMPILE_I_SIMPLE_REGISTER_STRUCT_TAG "__gdb_regs" | |
89 | #define COMPILE_I_SIMPLE_REGISTER_ARG_NAME "__regs" | |
90 | #define COMPILE_I_SIMPLE_REGISTER_DUMMY "_dummy" | |
36de76f9 JK |
91 | #define COMPILE_I_PRINT_OUT_ARG_TYPE "void *" |
92 | #define COMPILE_I_PRINT_OUT_ARG "__gdb_out_param" | |
93 | #define COMPILE_I_EXPR_VAL "__gdb_expr_val" | |
94 | #define COMPILE_I_EXPR_PTR_TYPE "__gdb_expr_ptr_type" | |
bb2ec1b3 TT |
95 | |
96 | /* Call gdbarch_register_name (GDBARCH, REGNUM) and convert its result | |
97 | to a form suitable for the compiler source. The register names | |
98 | should not clash with inferior defined macros. Returned pointer is | |
99 | never NULL. Returned pointer needs to be deallocated by xfree. */ | |
100 | ||
101 | extern char *compile_register_name_mangled (struct gdbarch *gdbarch, | |
102 | int regnum); | |
103 | ||
104 | /* Convert compiler source register name to register number of | |
105 | GDBARCH. Returned value is always >= 0, function throws an error | |
106 | for non-matching REG_NAME. */ | |
107 | ||
108 | extern int compile_register_name_demangle (struct gdbarch *gdbarch, | |
109 | const char *reg_name); | |
110 | ||
111 | /* Convert a gdb type, TYPE, to a GCC type. CONTEXT is used to do the | |
112 | actual conversion. The new GCC type is returned. */ | |
113 | ||
114 | struct type; | |
115 | extern gcc_type convert_type (struct compile_c_instance *context, | |
116 | struct type *type); | |
117 | ||
118 | /* A callback suitable for use as the GCC C symbol oracle. */ | |
119 | ||
120 | extern gcc_c_oracle_function gcc_convert_symbol; | |
121 | ||
122 | /* A callback suitable for use as the GCC C address oracle. */ | |
123 | ||
124 | extern gcc_c_symbol_address_function gcc_symbol_address; | |
125 | ||
126 | /* Instantiate a GDB object holding state for the GCC context FE. The | |
127 | new object is returned. */ | |
128 | ||
129 | extern struct compile_instance *new_compile_instance (struct gcc_c_context *fe); | |
130 | ||
131 | /* Emit code to compute the address for all the local variables in | |
132 | scope at PC in BLOCK. Returns a malloc'd vector, indexed by gdb | |
133 | register number, where each element indicates if the corresponding | |
134 | register is needed to compute a local variable. */ | |
135 | ||
136 | extern unsigned char *generate_c_for_variable_locations | |
137 | (struct compile_c_instance *compiler, | |
d7e74731 | 138 | string_file &stream, |
bb2ec1b3 TT |
139 | struct gdbarch *gdbarch, |
140 | const struct block *block, | |
141 | CORE_ADDR pc); | |
142 | ||
143 | /* Get the GCC mode attribute value for a given type size. */ | |
144 | ||
145 | extern const char *c_get_mode_for_size (int size); | |
146 | ||
147 | /* Given a dynamic property, return an xmallocd name that is used to | |
148 | represent its size. The result must be freed by the caller. The | |
149 | contents of the resulting string will be the same each time for | |
150 | each call with the same argument. */ | |
151 | ||
152 | struct dynamic_prop; | |
153 | extern char *c_get_range_decl_name (const struct dynamic_prop *prop); | |
154 | ||
aaee65ae PA |
155 | /* Type used to hold and pass around the source and object file names |
156 | to use for compilation. */ | |
157 | class compile_file_names | |
158 | { | |
159 | public: | |
160 | compile_file_names (std::string source_file, std::string object_file) | |
161 | : m_source_file (source_file), m_object_file (object_file) | |
162 | {} | |
163 | ||
164 | /* Provide read-only views only. Return 'const char *' instead of | |
165 | std::string to avoid having to use c_str() everywhere in client | |
166 | code. */ | |
167 | ||
168 | const char *source_file () const | |
169 | { return m_source_file.c_str (); } | |
170 | ||
171 | const char *object_file () const | |
172 | { return m_object_file.c_str (); } | |
173 | ||
174 | private: | |
175 | /* Storage for the file names. */ | |
176 | std::string m_source_file; | |
177 | std::string m_object_file; | |
178 | }; | |
179 | ||
bb2ec1b3 | 180 | #endif /* GDB_COMPILE_INTERNAL_H */ |