mirror of
https://github.com/bminor/binutils-gdb.git
synced 2025-11-16 12:34:43 +00: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>
130 lines
3.1 KiB
C++
130 lines
3.1 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/>. */
|
|
|
|
#include <chrono>
|
|
|
|
#if !defined (IN_PROCESS_AGENT)
|
|
bool remote_debug = false;
|
|
|
|
bool suppressed_remote_debug = false;
|
|
#endif
|
|
|
|
/* Output file for debugging. Default to standard error. */
|
|
static FILE *debug_file = stderr;
|
|
|
|
/* See debug.h. */
|
|
bool debug_threads;
|
|
|
|
/* Include timestamps in debugging output. */
|
|
int debug_timestamp;
|
|
|
|
#if !defined (IN_PROCESS_AGENT)
|
|
|
|
/* See debug.h. */
|
|
|
|
void
|
|
debug_set_output (const char *new_debug_file)
|
|
{
|
|
/* Close any existing file and reset to standard error. */
|
|
if (debug_file != stderr)
|
|
{
|
|
fclose (debug_file);
|
|
}
|
|
debug_file = stderr;
|
|
|
|
/* Catch empty filenames. */
|
|
if (new_debug_file == nullptr || strlen (new_debug_file) == 0)
|
|
return;
|
|
|
|
FILE *fptr = fopen (new_debug_file, "w");
|
|
|
|
if (fptr == nullptr)
|
|
{
|
|
debug_printf ("Cannot open %s for writing. %s. Switching to stderr.\n",
|
|
new_debug_file, safe_strerror (errno));
|
|
return;
|
|
}
|
|
|
|
debug_file = fptr;
|
|
}
|
|
|
|
#endif
|
|
|
|
/* See gdbsupport/common-debug.h. */
|
|
|
|
int debug_print_depth = 0;
|
|
|
|
/* Print a debugging message.
|
|
If the text begins a new line it is preceded by a timestamp.
|
|
We don't get fancy with newline checking, we just check whether the
|
|
previous call ended with "\n". */
|
|
|
|
void
|
|
debug_vprintf (const char *format, va_list ap)
|
|
{
|
|
#if !defined (IN_PROCESS_AGENT)
|
|
/* N.B. Not thread safe, and can't be used, as is, with IPA. */
|
|
static int new_line = 1;
|
|
|
|
if (debug_timestamp && new_line)
|
|
{
|
|
using namespace std::chrono;
|
|
|
|
steady_clock::time_point now = steady_clock::now ();
|
|
seconds s = duration_cast<seconds> (now.time_since_epoch ());
|
|
microseconds us = duration_cast<microseconds> (now.time_since_epoch ()) - s;
|
|
|
|
fprintf (debug_file, "%ld.%06ld ", (long) s.count (), (long) us.count ());
|
|
}
|
|
#endif
|
|
|
|
vfprintf (debug_file, format, ap);
|
|
|
|
#if !defined (IN_PROCESS_AGENT)
|
|
if (*format)
|
|
new_line = format[strlen (format) - 1] == '\n';
|
|
#endif
|
|
}
|
|
|
|
/* Flush debugging output.
|
|
This is called, for example, when starting an inferior to ensure all debug
|
|
output thus far appears before any inferior output. */
|
|
|
|
void
|
|
debug_flush (void)
|
|
{
|
|
fflush (debug_file);
|
|
}
|
|
|
|
/* See debug.h. */
|
|
|
|
ssize_t
|
|
debug_write (const void *buf, size_t nbyte)
|
|
{
|
|
int fd = fileno (debug_file);
|
|
return write (fd, buf, nbyte);
|
|
}
|
|
|
|
/* See debug.h. */
|
|
|
|
void
|
|
suppress_next_putpkt_log ()
|
|
{
|
|
suppressed_remote_debug = true;
|
|
}
|