binutils-gdb/gdb/cli-out.h
Aaron Merey 519d634396 gdb: Buffer output streams during events that might download debuginfo
Introduce new ui_file buffering_file to temporarily collect output
written to gdb_std* output streams during print_thread, print_frame_info
and print_stop_event.

This ensures that output during these functions is not interrupted
by debuginfod progress messages.

With the addition of deferred debuginfo downloading it is possible
for download progress messages to print during these events.
Without any intervention we can end up with poorly formatted output:

    (gdb) backtrace
    [...]
    #8  0x00007fbe8af7d7cf in pygi_invoke_c_callable (Downloading separate debug info for /lib64/libpython3.11.so.1.0
    function_cache=0x561221b224d0, state=<optimized out>...

To fix this we buffer writes to gdb_std* output streams while allowing
debuginfod progress messages to skip the buffers and print to the
underlying output streams immediately.  Buffered output is then written
to the output streams.  This ensures that progress messages print first,
followed by uninterrupted frame/thread/stop info:

    (gdb) backtrace
    [...]
    Downloading separate debug info for /lib64/libpython3.11.so.1.0
    #8  0x00007fbe8af7d7cf in pygi_invoke_c_callable (function_cache=0x561221b224d0, state=<optimized out>...

Co-Authored-By: Andrew Burgess <aburgess@redhat.com>
Approved-By: Andrew Burgess <aburgess@redhat.com>
2024-01-19 00:18:00 -05:00

116 lines
3.7 KiB
C++

/* Output generating routines for GDB CLI.
Copyright (C) 1999-2024 Free Software Foundation, Inc.
Contributed by Cygnus Solutions.
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 CLI_OUT_H
#define CLI_OUT_H
#include "ui-out.h"
#include <chrono>
#include <vector>
class cli_ui_out : public ui_out
{
public:
explicit cli_ui_out (ui_file *stream, ui_out_flags flags = ui_source_list);
virtual ~cli_ui_out ();
ui_file *set_stream (ui_file *stream);
bool can_emit_style_escape () const override;
ui_file *current_stream () const override
{ return m_streams.back (); }
protected:
virtual void do_table_begin (int nbrofcols, int nr_rows,
const char *tblid) override;
virtual void do_table_body () override;
virtual void do_table_end () override;
virtual void do_table_header (int width, ui_align align,
const std::string &col_name,
const std::string &col_hdr) override;
/* Note: level 0 is the top-level so LEVEL is always greater than
zero. */
virtual void do_begin (ui_out_type type, const char *id) override;
virtual void do_end (ui_out_type type) override;
virtual void do_field_signed (int fldno, int width, ui_align align,
const char *fldname, LONGEST value) override;
virtual void do_field_unsigned (int fldno, int width, ui_align align,
const char *fldname, ULONGEST value)
override;
virtual void do_field_skip (int fldno, int width, ui_align align,
const char *fldname) override;
virtual void do_field_string (int fldno, int width, ui_align align,
const char *fldname,
const char *string,
const ui_file_style &style) override;
virtual void do_field_fmt (int fldno, int width, ui_align align,
const char *fldname, const ui_file_style &style,
const char *format, va_list args)
override ATTRIBUTE_PRINTF (7, 0);
virtual void do_spaces (int numspaces) override;
virtual void do_text (const char *string) override;
virtual void do_message (const ui_file_style &style,
const char *format, va_list args) override
ATTRIBUTE_PRINTF (3,0);
virtual void do_wrap_hint (int indent) override;
virtual void do_flush () override;
virtual void do_redirect (struct ui_file *outstream) override;
virtual void do_progress_start () override;
virtual void do_progress_notify (const std::string &, const char *,
double, double) override;
virtual void do_progress_end () override;
bool suppress_output ()
{ return m_suppress_output; }
private:
void field_separator ();
std::vector<ui_file *> m_streams;
bool m_suppress_output;
/* The state of a recent progress update. */
struct cli_progress_info
{
/* Position of the progress indicator. */
int pos;
/* The current state. */
progress_update::state state;
/* Progress indicator's time of last update. */
std::chrono::steady_clock::time_point last_update;
cli_progress_info ()
: pos (0), state (progress_update::START)
{}
};
/* Stack of progress info. */
std::vector<cli_progress_info> m_progress_info;
void clear_progress_notify ();
};
extern void cli_display_match_list (char **matches, int len, int max);
#endif