GDB (xrefs)

compile-internal.h
Go to the documentation of this file.
1 /* Header file for GDB compile command and supporting functions.
2 Copyright (C) 2014-2018 Free Software Foundation, Inc.
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"
22 #include "common/enum-flags.h"
23
24 /* enum-flags wrapper. */
25 DEF_ENUM_FLAGS_TYPE (enum gcc_qualifiers, gcc_qualifiers_flags);
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"
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"
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. */
99
100 extern std::string compile_register_name_mangled (struct gdbarch *gdbarch,
101 int regnum);
102
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. */
106
107 extern int compile_register_name_demangle (struct gdbarch *gdbarch,
108 const char *reg_name);
109
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. */
112
113 struct type;
114 extern gcc_type convert_type (struct compile_c_instance *context,
115 struct type *type);
116
117 /* A callback suitable for use as the GCC C symbol oracle. */
118
119 extern gcc_c_oracle_function gcc_convert_symbol;
120
121 /* A callback suitable for use as the GCC C address oracle. */
122
123 extern gcc_c_symbol_address_function gcc_symbol_address;
124
125 /* Instantiate a GDB object holding state for the GCC context FE. The
126 new object is returned. */
127
128 extern struct compile_instance *new_compile_instance (struct gcc_c_context *fe);
129
130 /* Emit code to compute the address for all the local variables in
131 scope at PC in BLOCK. Returns a malloc'd vector, indexed by gdb
132 register number, where each element indicates if the corresponding
133 register is needed to compute a local variable. */
134
135 extern unsigned char *generate_c_for_variable_locations
136 (struct compile_c_instance *compiler,
137 string_file &stream,
138 struct gdbarch *gdbarch,
139 const struct block *block,
140 CORE_ADDR pc);
141
142 /* Get the GCC mode attribute value for a given type size. */
143
144 extern const char *c_get_mode_for_size (int size);
145
146 /* Given a dynamic property, return a name that is used to represent
147 its size. The contents of the resulting string will be the same
148 each time for each call with the same argument. */
149
150 struct dynamic_prop;
151 extern std::string c_get_range_decl_name (const struct dynamic_prop *prop);
152
153 /* Type used to hold and pass around the source and object file names
154 to use for compilation. */
155 class compile_file_names
156 {
157 public:
158 compile_file_names (std::string source_file, std::string object_file)
159 : m_source_file (source_file), m_object_file (object_file)
160 {}
161
162 /* Provide read-only views only. Return 'const char *' instead of
163 std::string to avoid having to use c_str() everywhere in client
164 code. */
165
166 const char *source_file () const
167 { return m_source_file.c_str (); }
168
169 const char *object_file () const
170 { return m_object_file.c_str (); }
171
172 private:
173 /* Storage for the file names. */
174 std::string m_source_file;
175 std::string m_object_file;
176 };
177
178 #endif /* GDB_COMPILE_INTERNAL_H */
gdbarch
Definition: gdbarch.c:127
string
const char * string
Definition: signals.c:50
compile_c_instance
Definition: compile-internal.h:62
CORE_ADDR
bfd_vma CORE_ADDR
Definition: common-types.h:41
compile_instance::gcc_target_options
const char * gcc_target_options
Definition: compile-internal.h:53
compile_c_instance::base
struct compile_instance base
Definition: compile-internal.h:67
compile_file_names::source_file
const char * source_file() const
Definition: compile-internal.h:166
enum-flags.h
compile_debug
int compile_debug
Definition: compile.c:57
compile_c_instance::symbol_err_map
htab_t symbol_err_map
Definition: compile-internal.h:75
c_get_range_decl_name
std::string c_get_range_decl_name(const struct dynamic_prop *prop)
Definition: compile-c-support.c:62
DEF_ENUM_FLAGS_TYPE
DEF_ENUM_FLAGS_TYPE(enum gcc_qualifiers, gcc_qualifiers_flags)
compile_i_scope_types
compile_i_scope_types
Definition: defs.h:61
dynamic_prop
Definition: gdbtypes.h:398
compile_file_names::m_object_file
std::string m_object_file
Definition: compile-internal.h:175
compile_c_instance::type_map
htab_t type_map
Definition: compile-internal.h:71
gcc_symbol_address
gcc_c_symbol_address_function gcc_symbol_address
compile_file_names::m_source_file
std::string m_source_file
Definition: compile-internal.h:174
generate_c_for_variable_locations
unsigned char * generate_c_for_variable_locations(struct compile_c_instance *compiler, string_file &stream, struct gdbarch *gdbarch, const struct block *block, CORE_ADDR pc)
Definition: compile-c-symbols.c:712
new_compile_instance
struct compile_instance * new_compile_instance(struct gcc_c_context *fe)
Definition: compile-c-types.c:449
type
Definition: gdbtypes.h:749
gcc_convert_symbol
gcc_c_oracle_function gcc_convert_symbol
regnum
int regnum
Definition: aarch64-tdep.c:77
compile_file_names
Definition: compile-internal.h:155
compile_instance
Definition: compile-internal.h:36
block
Definition: block.h:60
compile_instance::destroy
void(* destroy)(struct compile_instance *)
Definition: compile-internal.h:57
compile_file_names::compile_file_names
compile_file_names(std::string source_file, std::string object_file)
Definition: compile-internal.h:158
convert_type
gcc_type convert_type(struct compile_c_instance *context, struct type *type)
Definition: compile-c-types.c:411
compile_register_name_mangled
std::string compile_register_name_mangled(struct gdbarch *gdbarch, int regnum)
Definition: compile.c:651
compile_instance::scope
enum compile_i_scope_types scope
Definition: compile-internal.h:44
compile_instance::fe
struct gcc_base_context * fe
Definition: compile-internal.h:40
c_get_mode_for_size
const char * c_get_mode_for_size(int size)
Definition: compile-c-support.c:34
compile_instance::block
const struct block * block
Definition: compile-internal.h:48
compile_file_names::object_file
const char * object_file() const
Definition: compile-internal.h:169
size
size_t size
Definition: go32-nat.c:242
compile_register_name_demangle
int compile_register_name_demangle(struct gdbarch *gdbarch, const char *reg_name)
Definition: compile.c:661
string_file
Definition: ui-file.h:106