1 /* Header file for GDB compile command and supporting functions.
2 Copyright (C) 2014-2018 Free Software Foundation, Inc.
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.
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.
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/>. */
17 #ifndef GDB_COMPILE_INTERNAL_H
18 #define GDB_COMPILE_INTERNAL_H
21 #include "gcc-c-interface.h"
22 #include "common/enum-flags.h"
24 /* enum-flags wrapper. */
25 DEF_ENUM_FLAGS_TYPE (enum gcc_qualifiers
, gcc_qualifiers_flags
);
27 /* Debugging flag for the "compile" family of commands. */
29 extern int compile_debug
;
33 /* An object of this type holds state associated with a given
36 struct compile_instance
38 /* The GCC front end. */
40 struct gcc_base_context
*fe
;
42 /* The "scope" of this compilation. */
44 enum compile_i_scope_types scope
;
46 /* The block in which an expression is being parsed. */
48 const struct block
*block
;
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. */
53 const char *gcc_target_options
;
55 /* How to destroy this object. */
57 void (*destroy
) (struct compile_instance
*);
60 /* A subclass of compile_instance that is specific to the C front
62 struct compile_c_instance
64 /* Base class. Note that the base class vtable actually points to a
67 struct compile_instance base
;
69 /* Map from gdb types to gcc types. */
73 /* Map from gdb symbols to gcc error messages to emit. */
75 htab_t symbol_err_map
;
78 /* A helper macro that takes a compile_c_instance and returns its
79 corresponding gcc_c_context. */
81 #define C_CTX(I) ((struct gcc_c_context *) ((I)->base.fe))
83 /* Define header and footers for different scopes. */
85 /* A simple scope just declares a function named "_gdb_expr", takes no
86 arguments and returns no value. */
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"
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"
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. */
100 extern std::string
compile_register_name_mangled (struct gdbarch
*gdbarch
,
103 /* Convert compiler source register name to register number of
104 GDBARCH. Returned value is always >= 0, function throws an error
105 for non-matching REG_NAME. */
107 extern int compile_register_name_demangle (struct gdbarch
*gdbarch
,
108 const char *reg_name
);
110 /* Convert a gdb type, TYPE, to a GCC type. CONTEXT is used to do the
111 actual conversion. The new GCC type is returned. */
114 extern gcc_type
convert_type (struct compile_c_instance
*context
,
117 /* A callback suitable for use as the GCC C symbol oracle. */
119 extern gcc_c_oracle_function gcc_convert_symbol
;
121 /* A callback suitable for use as the GCC C address oracle. */
123 extern gcc_c_symbol_address_function gcc_symbol_address
;
125 /* Instantiate a GDB object holding state for the GCC context FE. The
126 new object is returned. */
128 extern struct compile_instance
*new_compile_instance (struct gcc_c_context
*fe
);
130 /* Emit code to compute the address for all the local variables in
131 scope at PC in BLOCK. Returns a vector, indexed by gdb register
132 number, where each element indicates if the corresponding register
133 is needed to compute a local variable. */
135 extern gdb::unique_xmalloc_ptr
<unsigned char>
136 generate_c_for_variable_locations
137 (struct compile_c_instance
*compiler
,
139 struct gdbarch
*gdbarch
,
140 const struct block
*block
,
143 /* Get the GCC mode attribute value for a given type size. */
145 extern const char *c_get_mode_for_size (int size
);
147 /* Given a dynamic property, return a name that is used to represent
148 its size. The contents of the resulting string will be the same
149 each time for each call with the same argument. */
152 extern std::string
c_get_range_decl_name (const struct dynamic_prop
*prop
);
154 /* Type used to hold and pass around the source and object file names
155 to use for compilation. */
156 class compile_file_names
159 compile_file_names (std::string source_file
, std::string object_file
)
160 : m_source_file (source_file
), m_object_file (object_file
)
163 /* Provide read-only views only. Return 'const char *' instead of
164 std::string to avoid having to use c_str() everywhere in client
167 const char *source_file () const
168 { return m_source_file
.c_str (); }
170 const char *object_file () const
171 { return m_object_file
.c_str (); }
174 /* Storage for the file names. */
175 std::string m_source_file
;
176 std::string m_object_file
;
179 #endif /* GDB_COMPILE_INTERNAL_H */