mirror of
https://sourceware.org/git/binutils-gdb.git
synced 2025-03-31 14:11:36 +08:00
792b26bb0c
When started with the --debug=remote flag, gdbserver enables the debug logs for the received and sent remote packets. If the packet contents are too long or contain verbatim binary data, printing the contents may create noise in the logs or even distortion in the terminal output. Introduce a function, `suppress_next_putpkt_log`, that allows omitting the contents of a sent package in the logs. This can be useful when a certain packet handler knows that it is sending binary data. My first attempt was to implement this mechanism by passing an extra parameter to putpt_binary_1 that could be controlled by the caller, putpkt_binary or putpkt. However, all qxfer handlers, regardless of whether they send binary or ascii data, cause the data to be sent via putpkt_binary. Hence, the solution was going to be either too suppressive or too intrusive. I opted for the approach where a package handler would suppress the log explicitly. Approved-By: Tom Tromey <tom@tromey.com>
73 lines
2.3 KiB
C
73 lines
2.3 KiB
C
/* Debugging routines for the remote server for GDB.
|
|
Copyright (C) 2014-2024 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 GDBSERVER_DEBUG_H
|
|
#define GDBSERVER_DEBUG_H
|
|
|
|
#if !defined (IN_PROCESS_AGENT)
|
|
extern bool remote_debug;
|
|
|
|
/* If true, do not print the packet content sent with the next putpkt.
|
|
This flag is reset to false after each putpkt logging. Useful to
|
|
omit printing binary packet contents. */
|
|
extern bool suppressed_remote_debug;
|
|
|
|
/* Print a "remote" debug statement. */
|
|
|
|
#define remote_debug_printf(fmt, ...) \
|
|
debug_prefixed_printf_cond (remote_debug, \
|
|
"remote", fmt, ##__VA_ARGS__)
|
|
|
|
/* Switch all debug output to DEBUG_FILE. If DEBUG_FILE is nullptr or an
|
|
empty string, or if the file cannot be opened, then debug output is sent to
|
|
stderr. */
|
|
void debug_set_output (const char *debug_file);
|
|
#endif
|
|
|
|
extern int using_threads;
|
|
|
|
/* Enable miscellaneous debugging output. The name is historical - it
|
|
was originally used to debug LinuxThreads support. */
|
|
|
|
extern bool debug_threads;
|
|
|
|
/* Print a "threads" debug statement. */
|
|
|
|
#define threads_debug_printf(fmt, ...) \
|
|
debug_prefixed_printf_cond (debug_threads, \
|
|
"threads", fmt, ##__VA_ARGS__)
|
|
|
|
/* Print "threads" enter/exit debug statements. */
|
|
|
|
#define THREADS_SCOPED_DEBUG_ENTER_EXIT \
|
|
scoped_debug_enter_exit (debug_threads, "threads")
|
|
|
|
extern int debug_timestamp;
|
|
|
|
void debug_flush (void);
|
|
|
|
/* Async signal safe debug output function that calls write directly. */
|
|
ssize_t debug_write (const void *buf, size_t nbyte);
|
|
|
|
/* Suppress the next putpkt debug log by omitting the packet contents.
|
|
Useful to reduce the logs when sending binary packets. */
|
|
|
|
void suppress_next_putpkt_log ();
|
|
|
|
#endif /* GDBSERVER_DEBUG_H */
|