binutils-gdb/gdb/target-debug.h
Pedro Alves 65c459abeb Thread options & clone events (core + remote)
A previous patch taught GDB about a new TARGET_WAITKIND_THREAD_CLONED
event kind, and made the Linux target report clone events.

A following patch will teach Linux GDBserver to do the same thing.

However, for remote debugging, it wouldn't be ideal for GDBserver to
report every clone event to GDB, when GDB only cares about such events
in some specific situations.  Reporting clone events all the time
would be potentially chatty.  We don't enable thread create/exit
events all the time for the same reason.  Instead we have the
QThreadEvents packet.  QThreadEvents is target-wide, though.

This patch makes GDB instead explicitly request that the target
reports clone events or not, on a per-thread basis.

In order to be able to do that with GDBserver, we need a new remote
protocol feature.  Since a following patch will want to enable thread
exit events on per-thread basis too, the packet introduced here is
more generic than just for clone events.  It lets you enable/disable a
set of options at once, modelled on Linux ptrace's PTRACE_SETOPTIONS.

IOW, this commit introduces a new QThreadOptions packet, that lets you
specify a set of per-thread event options you want to enable.  The
packet accepts a list of options/thread-id pairs, similarly to vCont,
processed left to right, with the options field being a number
interpreted as a bit mask of options.  The only option defined in this
commit is GDB_THREAD_OPTION_CLONE (0x1), which ask the remote target
to report clone events.  Another patch later in the series will
introduce another option.

For example, this packet sets option "1" (clone events) on thread
p1000.2345:

  QThreadOptions;1:p1000.2345

and this clears options for all threads of process 1000, and then sets
option "1" (clone events) on thread p1000.2345:

  QThreadOptions;0:p1000.-1;1:p1000.2345

This clears options of all threads of all processes:

  QThreadOptions;0

The target reports the set of supported options by including
"QThreadOptions=<supported options>" in its qSupported response.

infrun is then tweaked to enable GDB_THREAD_OPTION_CLONE when stepping
over a breakpoint.

Unlike PTRACE_SETOPTIONS, fork/vfork/clone children do NOT inherit
their parent's thread options.  This is so that GDB can send e.g.,
"QThreadOptions;0;1:TID" without worrying about threads it doesn't
know about yet.

Documentation for this new remote protocol feature is included in a
documentation patch later in the series.

Bug: https://sourceware.org/bugzilla/show_bug.cgi?id=19675
Bug: https://sourceware.org/bugzilla/show_bug.cgi?id=27830
Reviewed-By: Andrew Burgess <aburgess@redhat.com>
Change-Id: Ie41e5093b2573f14cf6ac41b0b5804eba75be37e
2023-11-13 14:16:09 +00:00

268 lines
10 KiB
C++
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

/* GDB target debugging macros
Copyright (C) 2014-2023 Free Software Foundation, Inc.
This file is part of GDB.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>. */
#ifndef TARGET_DEBUG_H
#define TARGET_DEBUG_H
/* Printers for the debug target. Each prints an object of a given
type to a string that needn't be freed. Most printers are macros,
for brevity, but a few are static functions where more complicated
behavior is needed.
References to these printers are automatically generated by
make-target-delegates. See the generated file target-delegates.c.
In a couple cases, a special printing function is defined and then
used via the TARGET_DEBUG_PRINTER macro. See target.h.
A few methods still have some explicit targetdebug code in
target.c. In most cases this is because target delegation hasn't
been done for the method; but individual cases vary. For instance,
target_store_registers does some special register printing that is
more simply done there, and target_xfer_partial additionally
bypasses the debug target. */
/* Helper macro. */
#define target_debug_do_print(E) \
gdb_puts ((E), gdb_stdlog);
#define target_debug_print_target_object(X) \
target_debug_do_print (plongest (X))
#define target_debug_print_CORE_ADDR(X) \
target_debug_do_print (core_addr_to_string (X))
#define target_debug_print_const_char_p(X) \
target_debug_do_print (((X) ? (X) : "(null)"))
#define target_debug_print_char_p(X) \
target_debug_do_print (((X) ? (X) : "(null)"))
#define target_debug_print_int(X) \
target_debug_do_print (plongest (X))
#define target_debug_print_bool(X) \
target_debug_do_print ((X) ? "true" : "false")
#define target_debug_print_long(X) \
target_debug_do_print (plongest (X))
#define target_debug_print_target_xfer_status(X) \
target_debug_do_print (plongest (X))
#define target_debug_print_exec_direction_kind(X) \
target_debug_do_print (plongest (X))
#define target_debug_print_trace_find_type(X) \
target_debug_do_print (plongest (X))
#define target_debug_print_btrace_read_type(X) \
target_debug_do_print (plongest (X))
#define target_debug_print_btrace_error(X) \
target_debug_do_print (plongest (X))
#define target_debug_print_ptid_t(X) \
target_debug_do_print (plongest (X.pid ()))
#define target_debug_print_gdbarch_p(X) \
target_debug_do_print (gdbarch_bfd_arch_info (X)->printable_name)
#define target_debug_print_const_gdb_byte_p(X) \
target_debug_do_print (host_address_to_string (X))
#define target_debug_print_gdb_byte_p(X) \
target_debug_do_print (host_address_to_string (X))
#define target_debug_print_const_gdb_byte_pp(X) \
target_debug_do_print (host_address_to_string (*(X)))
#define target_debug_print_gdb_signal(X) \
target_debug_do_print (gdb_signal_to_name (X))
#define target_debug_print_ULONGEST(X) \
target_debug_do_print (hex_string (X))
#define target_debug_print_ULONGEST_p(X) \
target_debug_do_print (hex_string (*(X)))
#define target_debug_print_LONGEST(X) \
target_debug_do_print (phex (X, 0))
#define target_debug_print_LONGEST_p(X) \
target_debug_do_print (phex (*(X), 0))
#define target_debug_print_address_space_p(X) \
target_debug_do_print (plongest ((X)->num ()))
#define target_debug_print_bp_target_info_p(X) \
target_debug_do_print (core_addr_to_string ((X)->placed_address))
#define target_debug_print_expression_p(X) \
target_debug_do_print (host_address_to_string (X))
#define target_debug_print_CORE_ADDR_p(X) \
target_debug_do_print (core_addr_to_string (*(X)))
#define target_debug_print_int_p(X) \
target_debug_do_print (plongest (*(X)))
#define target_debug_print_regcache_p(X) \
target_debug_do_print (host_address_to_string (X))
#define target_debug_print_thread_info_p(X) \
target_debug_do_print (host_address_to_string (X))
#define target_debug_print_ui_file_p(X) \
target_debug_do_print (host_address_to_string (X))
#define target_debug_print_const_std_vector_target_section_p(X) \
target_debug_do_print (host_address_to_string (X->data ()))
#define target_debug_print_void_p(X) \
target_debug_do_print (host_address_to_string (X))
#define target_debug_print_find_memory_region_ftype(X) \
target_debug_do_print (host_address_to_string (X))
#define target_debug_print_bfd_p(X) \
target_debug_do_print (host_address_to_string (X))
#define target_debug_print_std_vector_mem_region(X) \
target_debug_do_print (host_address_to_string (X.data ()))
#define target_debug_print_std_vector_static_tracepoint_marker(X) \
target_debug_do_print (host_address_to_string (X.data ()))
#define target_debug_print_const_target_desc_p(X) \
target_debug_do_print (host_address_to_string (X))
#define target_debug_print_bp_location_p(X) \
target_debug_do_print (host_address_to_string (X))
#define target_debug_print_const_trace_state_variable_r(X) \
target_debug_do_print (host_address_to_string (&X))
#define target_debug_print_trace_status_p(X) \
target_debug_do_print (host_address_to_string (X))
#define target_debug_print_breakpoint_p(X) \
target_debug_do_print (host_address_to_string (X))
#define target_debug_print_tracepoint_p(X) \
target_debug_do_print (host_address_to_string (X))
#define target_debug_print_uploaded_tp_p(X) \
target_debug_do_print (host_address_to_string (X))
#define target_debug_print_uploaded_tp_pp(X) \
target_debug_do_print (host_address_to_string (X))
#define target_debug_print_uploaded_tsv_pp(X) \
target_debug_do_print (host_address_to_string (X))
#define target_debug_print_static_tracepoint_marker_p(X) \
target_debug_do_print (host_address_to_string (X))
#define target_debug_print_btrace_target_info_p(X) \
target_debug_do_print (host_address_to_string (X))
#define target_debug_print_const_frame_unwind_p(X) \
target_debug_do_print (host_address_to_string (X))
#define target_debug_print_btrace_data_p(X) \
target_debug_do_print (host_address_to_string (X))
#define target_debug_print_record_method(X) \
target_debug_do_print (plongest (X))
#define target_debug_print_const_btrace_config_p(X) \
target_debug_do_print (host_address_to_string (X))
#define target_debug_print_const_btrace_target_info_p(X) \
target_debug_do_print (host_address_to_string (X))
#define target_debug_print_target_hw_bp_type(X) \
target_debug_do_print (plongest (X))
#define target_debug_print_bptype(X) \
target_debug_do_print (plongest (X))
#define target_debug_print_inferior_p(X) \
target_debug_do_print (host_address_to_string (X))
#define target_debug_print_remove_bp_reason(X) \
target_debug_do_print (plongest (X))
#define target_debug_print_gdb_disassembly_flags(X) \
target_debug_do_print (plongest (X))
#define target_debug_print_traceframe_info_up(X) \
target_debug_do_print (host_address_to_string (X.get ()))
#define target_debug_print_gdb_array_view_const_int(X) \
target_debug_do_print (host_address_to_string (X.data ()))
#define target_debug_print_record_print_flags(X) \
target_debug_do_print (plongest (X))
#define target_debug_print_thread_control_capabilities(X) \
target_debug_do_print (plongest (X))
#define target_debug_print_thread_info_p(X) \
target_debug_do_print (host_address_to_string (X))
#define target_debug_print_std_string(X) \
target_debug_do_print ((X).c_str ())
#define target_debug_print_gdb_byte_vector(X) \
target_debug_do_print (host_address_to_string (X.data ()))
#define target_debug_print_gdb_unique_xmalloc_ptr_char(X) \
target_debug_do_print (X.get ())
#define target_debug_print_target_waitkind(X) \
target_debug_do_print (pulongest (X))
#define target_debug_print_gdb_thread_options(X) \
target_debug_do_print (to_string (X).c_str ())
static void
target_debug_print_target_waitstatus_p (struct target_waitstatus *status)
{
gdb_puts (status->to_string ().c_str (), gdb_stdlog);
}
/* Macros or functions that are used via TARGET_DEBUG_PRINTER. */
#define target_debug_print_step(X) \
target_debug_do_print ((X) ? "step" : "continue")
static void
target_debug_print_target_wait_flags (target_wait_flags options)
{
std::string str = target_options_to_string (options);
gdb_puts (str.c_str (), gdb_stdlog);
}
static void
target_debug_print_signals (gdb::array_view<const unsigned char> sigs)
{
gdb_puts ("{", gdb_stdlog);
for (size_t i = 0; i < sigs.size (); i++)
if (sigs[i] != 0)
{
gdb_printf (gdb_stdlog, " %s",
gdb_signal_to_name ((enum gdb_signal) i));
}
gdb_puts (" }", gdb_stdlog);
}
static void
target_debug_print_size_t (size_t size)
{
gdb_printf (gdb_stdlog, "%s", pulongest (size));
}
static void
target_debug_print_gdb_array_view_const_gdb_byte (gdb::array_view<const gdb_byte> vector)
{
gdb_puts ("{", gdb_stdlog);
for (size_t i = 0; i < vector.size (); i++)
{
gdb_printf (gdb_stdlog, " %s",
phex_nz (vector[i], 1));
}
gdb_puts (" }", gdb_stdlog);
}
static void
target_debug_print_const_gdb_byte_vector_r (const gdb::byte_vector &vector)
{
target_debug_print_gdb_array_view_const_gdb_byte (vector);
}
static void
target_debug_print_gdb_byte_vector_r (gdb::byte_vector &vector)
{
target_debug_print_const_gdb_byte_vector_r (vector);
}
static void
target_debug_print_x86_xsave_layout (const x86_xsave_layout &layout)
{
gdb_puts ("{", gdb_stdlog);
gdb_printf (gdb_stdlog, " sizeof_xsave=%d", layout.sizeof_xsave);
#define POFFS(region) \
if (layout.region##_offset != 0) \
gdb_printf (gdb_stdlog, ", %s_offset=%d", #region, \
layout.region##_offset)
POFFS(avx);
POFFS(bndregs);
POFFS(bndcfg);
POFFS(k);
POFFS(zmm_h);
POFFS(zmm);
POFFS(pkru);
#undef POFFS
gdb_puts (" }", gdb_stdlog);
}
#endif /* TARGET_DEBUG_H */