GDB (xrefs)
Loading...
Searching...
No Matches
target-debug.h
Go to the documentation of this file.
1/* GDB target debugging macros
2
3 Copyright (C) 2014-2023 Free Software Foundation, Inc.
4
5 This file is part of GDB.
6
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
11
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
16
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
19
20#ifndef TARGET_DEBUG_H
21#define TARGET_DEBUG_H
22
23/* Printers for the debug target. Each prints an object of a given
24 type to a string that needn't be freed. Most printers are macros,
25 for brevity, but a few are static functions where more complicated
26 behavior is needed.
27
28 References to these printers are automatically generated by
29 make-target-delegates. See the generated file target-delegates.c.
30
31 In a couple cases, a special printing function is defined and then
32 used via the TARGET_DEBUG_PRINTER macro. See target.h.
33
34 A few methods still have some explicit targetdebug code in
35 target.c. In most cases this is because target delegation hasn't
36 been done for the method; but individual cases vary. For instance,
37 target_store_registers does some special register printing that is
38 more simply done there, and target_xfer_partial additionally
39 bypasses the debug target. */
40
41
42/* Helper macro. */
43
44#define target_debug_do_print(E) \
45 gdb_puts ((E), gdb_stdlog);
46
47#define target_debug_print_target_object(X) \
48 target_debug_do_print (plongest (X))
49#define target_debug_print_CORE_ADDR(X) \
50 target_debug_do_print (core_addr_to_string (X))
51#define target_debug_print_const_char_p(X) \
52 target_debug_do_print (((X) ? (X) : "(null)"))
53#define target_debug_print_char_p(X) \
54 target_debug_do_print (((X) ? (X) : "(null)"))
55#define target_debug_print_int(X) \
56 target_debug_do_print (plongest (X))
57#define target_debug_print_bool(X) \
58 target_debug_do_print ((X) ? "true" : "false")
59#define target_debug_print_long(X) \
60 target_debug_do_print (plongest (X))
61#define target_debug_print_target_xfer_status(X) \
62 target_debug_do_print (plongest (X))
63#define target_debug_print_exec_direction_kind(X) \
64 target_debug_do_print (plongest (X))
65#define target_debug_print_trace_find_type(X) \
66 target_debug_do_print (plongest (X))
67#define target_debug_print_btrace_read_type(X) \
68 target_debug_do_print (plongest (X))
69#define target_debug_print_btrace_error(X) \
70 target_debug_do_print (plongest (X))
71#define target_debug_print_ptid_t(X) \
72 target_debug_do_print (plongest (X.pid ()))
73#define target_debug_print_gdbarch_p(X) \
74 target_debug_do_print (gdbarch_bfd_arch_info (X)->printable_name)
75#define target_debug_print_const_gdb_byte_p(X) \
76 target_debug_do_print (host_address_to_string (X))
77#define target_debug_print_gdb_byte_p(X) \
78 target_debug_do_print (host_address_to_string (X))
79#define target_debug_print_const_gdb_byte_pp(X) \
80 target_debug_do_print (host_address_to_string (*(X)))
81#define target_debug_print_gdb_signal(X) \
82 target_debug_do_print (gdb_signal_to_name (X))
83#define target_debug_print_ULONGEST(X) \
84 target_debug_do_print (hex_string (X))
85#define target_debug_print_ULONGEST_p(X) \
86 target_debug_do_print (hex_string (*(X)))
87#define target_debug_print_LONGEST(X) \
88 target_debug_do_print (phex (X, 0))
89#define target_debug_print_LONGEST_p(X) \
90 target_debug_do_print (phex (*(X), 0))
91#define target_debug_print_address_space_p(X) \
92 target_debug_do_print (plongest ((X)->num ()))
93#define target_debug_print_bp_target_info_p(X) \
94 target_debug_do_print (core_addr_to_string ((X)->placed_address))
95#define target_debug_print_expression_p(X) \
96 target_debug_do_print (host_address_to_string (X))
97#define target_debug_print_CORE_ADDR_p(X) \
98 target_debug_do_print (core_addr_to_string (*(X)))
99#define target_debug_print_int_p(X) \
100 target_debug_do_print (plongest (*(X)))
101#define target_debug_print_regcache_p(X) \
102 target_debug_do_print (host_address_to_string (X))
103#define target_debug_print_thread_info_p(X) \
104 target_debug_do_print (host_address_to_string (X))
105#define target_debug_print_ui_file_p(X) \
106 target_debug_do_print (host_address_to_string (X))
107#define target_debug_print_const_target_section_table_p(X) \
108 target_debug_do_print (host_address_to_string (X))
109#define target_debug_print_void_p(X) \
110 target_debug_do_print (host_address_to_string (X))
111#define target_debug_print_find_memory_region_ftype(X) \
112 target_debug_do_print (host_address_to_string (X))
113#define target_debug_print_bfd_p(X) \
114 target_debug_do_print (host_address_to_string (X))
115#define target_debug_print_std_vector_mem_region(X) \
116 target_debug_do_print (host_address_to_string (X.data ()))
117#define target_debug_print_std_vector_static_tracepoint_marker(X) \
118 target_debug_do_print (host_address_to_string (X.data ()))
119#define target_debug_print_const_target_desc_p(X) \
120 target_debug_do_print (host_address_to_string (X))
121#define target_debug_print_bp_location_p(X) \
122 target_debug_do_print (host_address_to_string (X))
123#define target_debug_print_const_trace_state_variable_r(X) \
124 target_debug_do_print (host_address_to_string (&X))
125#define target_debug_print_trace_status_p(X) \
126 target_debug_do_print (host_address_to_string (X))
127#define target_debug_print_breakpoint_p(X) \
128 target_debug_do_print (host_address_to_string (X))
129#define target_debug_print_tracepoint_p(X) \
130 target_debug_do_print (host_address_to_string (X))
131#define target_debug_print_uploaded_tp_p(X) \
132 target_debug_do_print (host_address_to_string (X))
133#define target_debug_print_uploaded_tp_pp(X) \
134 target_debug_do_print (host_address_to_string (X))
135#define target_debug_print_uploaded_tsv_pp(X) \
136 target_debug_do_print (host_address_to_string (X))
137#define target_debug_print_static_tracepoint_marker_p(X) \
138 target_debug_do_print (host_address_to_string (X))
139#define target_debug_print_btrace_target_info_p(X) \
140 target_debug_do_print (host_address_to_string (X))
141#define target_debug_print_const_frame_unwind_p(X) \
142 target_debug_do_print (host_address_to_string (X))
143#define target_debug_print_btrace_data_p(X) \
144 target_debug_do_print (host_address_to_string (X))
145#define target_debug_print_record_method(X) \
146 target_debug_do_print (plongest (X))
147#define target_debug_print_const_btrace_config_p(X) \
148 target_debug_do_print (host_address_to_string (X))
149#define target_debug_print_const_btrace_target_info_p(X) \
150 target_debug_do_print (host_address_to_string (X))
151#define target_debug_print_target_hw_bp_type(X) \
152 target_debug_do_print (plongest (X))
153#define target_debug_print_bptype(X) \
154 target_debug_do_print (plongest (X))
155#define target_debug_print_inferior_p(X) \
156 target_debug_do_print (host_address_to_string (X))
157#define target_debug_print_remove_bp_reason(X) \
158 target_debug_do_print (plongest (X))
159#define target_debug_print_gdb_disassembly_flags(X) \
160 target_debug_do_print (plongest (X))
161#define target_debug_print_traceframe_info_up(X) \
162 target_debug_do_print (host_address_to_string (X.get ()))
163#define target_debug_print_gdb_array_view_const_int(X) \
164 target_debug_do_print (host_address_to_string (X.data ()))
165#define target_debug_print_record_print_flags(X) \
166 target_debug_do_print (plongest (X))
167#define target_debug_print_thread_control_capabilities(X) \
168 target_debug_do_print (plongest (X))
169#define target_debug_print_thread_info_p(X) \
170 target_debug_do_print (host_address_to_string (X))
171#define target_debug_print_std_string(X) \
172 target_debug_do_print ((X).c_str ())
173#define target_debug_print_gdb_byte_vector(X) \
174 target_debug_do_print (host_address_to_string (X.data ()))
175#define target_debug_print_gdb_unique_xmalloc_ptr_char(X) \
176 target_debug_do_print (X.get ())
177#define target_debug_print_target_waitkind(X) \
178 target_debug_do_print (pulongest (X))
179
180static void
185
186
187
188/* Macros or functions that are used via TARGET_DEBUG_PRINTER. */
189
190#define target_debug_print_step(X) \
191 target_debug_do_print ((X) ? "step" : "continue")
192
193static void
194target_debug_print_target_wait_flags (target_wait_flags options)
195{
196 std::string str = target_options_to_string (options);
197
198 gdb_puts (str.c_str (), gdb_stdlog);
199}
200
201static void
202target_debug_print_signals (gdb::array_view<const unsigned char> sigs)
203{
204 gdb_puts ("{", gdb_stdlog);
205
206 for (size_t i = 0; i < sigs.size (); i++)
207 if (sigs[i] != 0)
208 {
209 gdb_printf (gdb_stdlog, " %s",
210 gdb_signal_to_name ((enum gdb_signal) i));
211 }
212 gdb_puts (" }", gdb_stdlog);
213}
214
215static void
217{
218 gdb_printf (gdb_stdlog, "%s", pulongest (size));
219}
220
221static void
222target_debug_print_gdb_array_view_const_gdb_byte (gdb::array_view<const gdb_byte> vector)
223{
224 gdb_puts ("{", gdb_stdlog);
225
226 for (size_t i = 0; i < vector.size (); i++)
227 {
228 gdb_printf (gdb_stdlog, " %s",
229 phex_nz (vector[i], 1));
230 }
231 gdb_puts (" }", gdb_stdlog);
232}
233
234static void
239
240static void
245
246static void
247target_debug_print_x86_xsave_layout (const x86_xsave_layout &layout)
248{
249 gdb_puts ("{", gdb_stdlog);
250 gdb_printf (gdb_stdlog, " sizeof_xsave=%d", layout.sizeof_xsave);
251#define POFFS(region) \
252 if (layout.region##_offset != 0) \
253 gdb_printf (gdb_stdlog, ", %s_offset=%d", #region, \
254 layout.region##_offset)
255 POFFS(avx);
256 POFFS(bndregs);
257 POFFS(bndcfg);
258 POFFS(k);
259 POFFS(zmm_h);
260 POFFS(zmm);
261 POFFS(pkru);
262#undef POFFS
263 gdb_puts (" }", gdb_stdlog);
264}
265#endif /* TARGET_DEBUG_H */
mach_port_t mach_port_t name mach_port_t mach_port_t name kern_return_t int status
Definition gnu-nat.c:1790
size_t size
Definition go32-nat.c:239
#define POFFS(region)
static void target_debug_print_gdb_array_view_const_gdb_byte(gdb::array_view< const gdb_byte > vector)
static void target_debug_print_target_waitstatus_p(struct target_waitstatus *status)
static void target_debug_print_size_t(size_t size)
static void target_debug_print_target_wait_flags(target_wait_flags options)
static void target_debug_print_gdb_byte_vector_r(gdb::byte_vector &vector)
static void target_debug_print_const_gdb_byte_vector_r(const gdb::byte_vector &vector)
static void target_debug_print_x86_xsave_layout(const x86_xsave_layout &layout)
static void target_debug_print_signals(gdb::array_view< const unsigned char > sigs)
std::string target_options_to_string(target_wait_flags target_options)
Definition target.c:3912
void gdb_printf(struct ui_file *stream, const char *format,...)
Definition utils.c:1886
void gdb_puts(const char *linebuffer, struct ui_file *stream)
Definition utils.c:1809
#define gdb_stdlog
Definition utils.h:190