This is the mail archive of the
gdb-patches@sourceware.org
mailing list for the GDB project.
save-tracepoints is broken with the TUI; TUI + 'set logging' doesn't work (PR9217)
- From: Pedro Alves <pedro at codesourcery dot com>
- To: gdb-patches at sourceware dot org
- Date: Sun, 18 Apr 2010 01:15:11 +0100
- Subject: save-tracepoints is broken with the TUI; TUI + 'set logging' doesn't work (PR9217)
I noticed today that the `save-tracepoints' (and the future `save breakpoints')
command is broken when used from the TUI. In the normal CLI:
(top-gdb) trace main
Tracepoint 4 at 0x4573d3: file ../../src/gdb/gdb.c, line 28.
(top-gdb) actions
Enter actions for tracepoint 4, one per line.
End with a line saying just "end".
>collect $regs
>end
(top-gdb) save-tracepoints foofoo
Tracepoints saved to file 'foofoo'.
(top-gdb) shell cat foofoo
trace main
actions
collect $regs
end
Okay, all is fine. Now switch to the TUI:
(top-gdb) save-tracepoints foofoo
collect $regs
Tracepoints saved to file 'foofoo'.
???, "collect $regs" went to the screen instead of the file?
Let's confirm:
(top-gdb) shell cat foofoo
trace main
actions
end
Indeed...
The problem is that save-tracepoints does:
ui_out_redirect (uiout, fp);
TRY_CATCH (ex, RETURN_MASK_ERROR)
{
print_command_lines (uiout, tp->commands->commands, 2);
}
ui_out_redirect (uiout, NULL);
but, the TUI ui-out doesn't implement ui_out_redirect. It
just looks like it was forgotten when cli_redirect was added
a few years ago.
Looking at tui/tui-out.c reveals that it's mostly a wholesave
copy of cli-out.c, with a few callbacks doing extra things, and
a few things renamed (s/cli/tui). So instead of copying cli_redirect
to tui-out.c (which does fix the problem) and adding to
the duplication, I'm actually getting rid of the whole duplication
by making tui-out.c inherit and extend cli-out.c. I can't resist
deleting code!
While looking at this, I also noticed that tui_resume
is doing:
stream = cli_out_set_stream (tui_old_uiout, gdb_stdout);
But, cli_out_set_stream expects a real CLI uiout. This
happens to work by chance, because the only field of
cli_out_data cli_out_set_stream touches is at the same
offset as the equivalent field of tui-out.c's ui_out_data.
This is fixed automagically by the inheritance.
After writing the patch, I realized that I'm also fixing
"set logging" when the TUI is active. It didn't work
precisely because the tui.out.c didn't implement
ui_out_redirect:
<activate the TUI>
(gdb) set logging on
Copying output to gdb.txt.
warning: Current output protocol does not support redirection
(gdb)
and indeed, logging didn't work. This is PR9217. It works now.
I've applied the patch below. Tested on x86_64-linux.
--
Pedro Alves
2010-04-18 Pedro Alves <pedro@codesourcery.com>
PR tui/9217
* tui/tui-out.c: Include cli-out.h.
(tui_table_begin, tui_table_body, tui_table_end, tui_table_header)
(tui_begin, tui_end, tui_field_int, tui_field_skip)
(tui_field_string, tui_field_fmt, tui_spaces, tui_text)
(tui_message, tui_wrap_hint, tui_flush): Delete forward
declarations.
(struct ui_out_data): Rename to...
(struct tui_ui_out_data): ... this. Remove `stream' and
`suppress_output' fields, and inherit cli_ui_out_data.
(tui_out_data): New typedef.
(tui_ui_out_impl): Don't initialize fields staticaly.
(tui_table_begin, tui_table_body, tui_table_end, tui_table_header)
(tui_begin, tui_end): Delete.
(tui_field_int): Adjust to delegate most work to the base type.
(tui_field_skip): Delete.
(tui_field_string, tui_field_fmt): Adjust comment. Adjust to
delegate most work to the base type.
(tui_spaces): Delete.
(tui_text): Adjust to delegate most work to the base type.
(tui_message): Delete.
(tui_wrap_hint): Delete.
(tui_flush): Delete.
(out_field_fmt): Delete.
(field_separator): Delete.
(tui_out_new): Adjust to initialize the base type.
(_initialize_tui_out): Initialize tui_ui_out_impl.
* cli-out.c (struct ui_out_data): Moved out to cli-out.h, renamed
cli_ui_out_data.
(cli_out_data): Adjust.
(cli_ui_out_impl): Make extern.
(cli_table_header, cli_field_int, cli_field_skip): Use
uo_field_string instead of cli_field_string.
(cli_redirect): Adjust to use cli_out_data.
(cli_out_data_ctor): New.
(cli_out_new): Use it.
* cli-out.h (struct ui_file): Remove forward declaration.
(struct cli_ui_out_data): New, moved from cli-out.c, and renamed.
(cli_ui_out_impl): Declare.
(cli_out_data_ctor): Declare.
* ui-out.c (struct ui_out) <data>: Change type to void pointer.
(uo_field_string): No longer static.
(ui_out_data): Change return type to void pointer.
(ui_out_new): Change `data' parameter type to void pointer.
* ui-out.h (struct ui_out_data): Don't forward declare.
(ui_out_data): Change return type to void pointer.
(ui_out_new): Change `data' parameter type to void pointer.
(uo_field_string): Declare.
---
gdb/cli-out.c | 47 ++++---
gdb/cli-out.h | 18 ++
gdb/tui/tui-out.c | 351 +++++++-----------------------------------------------
gdb/ui-out.c | 10 -
gdb/ui-out.h | 8 -
5 files changed, 99 insertions(+), 335 deletions(-)
Index: src/gdb/tui/tui-out.c
===================================================================
--- src.orig/gdb/tui/tui-out.c 2010-04-17 23:13:42.000000000 +0100
+++ src/gdb/tui/tui-out.c 2010-04-17 23:15:14.000000000 +0100
@@ -23,195 +23,37 @@
#include "defs.h"
#include "ui-out.h"
+#include "cli-out.h"
#include "tui.h"
#include "gdb_string.h"
#include "gdb_assert.h"
-struct ui_out_data
+struct tui_ui_out_data
{
- struct ui_file *stream;
- int suppress_output;
+ struct cli_ui_out_data base;
+
int line;
int start_of_line;
};
-typedef struct ui_out_data tui_out_data;
-
-/* These are the CLI output functions. */
-
-static void tui_table_begin (struct ui_out *uiout,
- int nbrofcols, int nr_rows,
- const char *tblid);
-static void tui_table_body (struct ui_out *uiout);
-static void tui_table_end (struct ui_out *uiout);
-static void tui_table_header (struct ui_out *uiout,
- int width, enum ui_align alig,
- const char *col_name,
- const char *colhdr);
-static void tui_begin (struct ui_out *uiout,
- enum ui_out_type type,
- int level, const char *lstid);
-static void tui_end (struct ui_out *uiout,
- enum ui_out_type type, int level);
-static void tui_field_int (struct ui_out *uiout,
- int fldno, int width,
- enum ui_align alig,
- const char *fldname, int value);
-static void tui_field_skip (struct ui_out *uiout,
- int fldno, int width,
- enum ui_align alig,
- const char *fldname);
-static void tui_field_string (struct ui_out *uiout,
- int fldno, int width,
- enum ui_align alig,
- const char *fldname,
- const char *string);
-static void tui_field_fmt (struct ui_out *uiout, int fldno,
- int width, enum ui_align align,
- const char *fldname,
- const char *format,
- va_list args)
- ATTR_FORMAT (printf, 6, 0);
-static void tui_spaces (struct ui_out *uiout, int numspaces);
-static void tui_text (struct ui_out *uiout, const char *string);
-static void tui_message (struct ui_out *uiout, int verbosity,
- const char *format, va_list args)
- ATTR_FORMAT (printf, 3, 0);
-static void tui_wrap_hint (struct ui_out *uiout,
- char *identstring);
-static void tui_flush (struct ui_out *uiout);
-
-/* This is the CLI ui-out implementation functions vector. */
-
-/* FIXME: This can be initialized dynamically after default is set to
- handle initial output in main.c. */
-
-static struct ui_out_impl tui_ui_out_impl = {
- tui_table_begin,
- tui_table_body,
- tui_table_end,
- tui_table_header,
- tui_begin,
- tui_end,
- tui_field_int,
- tui_field_skip,
- tui_field_string,
- tui_field_fmt,
- tui_spaces,
- tui_text,
- tui_message,
- tui_wrap_hint,
- tui_flush,
- NULL,
- 0, /* Does not need MI hacks (i.e. needs CLI hacks). */
-};
-
-/* Prototypes for local functions. */
-
-extern void _initialize_tui_out (void);
-
-static void field_separator (void);
-
-static void out_field_fmt (struct ui_out *uiout,
- int fldno,
- const char *fldname,
- const char *format,...)
- ATTR_FORMAT (printf, 4, 5);
-
-/* local variables */
-
-/* (none yet) */
-
-/* Mark beginning of a table. */
-
-void
-tui_table_begin (struct ui_out *uiout,
- int nbrofcols,
- int nr_rows,
- const char *tblid)
-{
- tui_out_data *data = ui_out_data (uiout);
- if (nr_rows == 0)
- data->suppress_output = 1;
- else
- /* Only the table suppresses the output and, fortunately, a table
- is not a recursive data structure. */
- gdb_assert (data->suppress_output == 0);
-}
-
-/* Mark beginning of a table body. */
-
-void
-tui_table_body (struct ui_out *uiout)
-{
- tui_out_data *data = ui_out_data (uiout);
- if (data->suppress_output)
- return;
- /* First, close the table header line. */
- tui_text (uiout, "\n");
-}
-
-/* Mark end of a table. */
-
-void
-tui_table_end (struct ui_out *uiout)
-{
- tui_out_data *data = ui_out_data (uiout);
- data->suppress_output = 0;
-}
+typedef struct tui_ui_out_data tui_out_data;
-/* Specify table header. */
+/* This is the TUI ui-out implementation functions vector. It is
+ initialized below in _initialize_tui_out, inheriting the CLI
+ version, and overriding a few methods. */
-void
-tui_table_header (struct ui_out *uiout,
- int width,
- enum ui_align alignment,
- const char *col_name,
- const char *colhdr)
-{
- tui_out_data *data = ui_out_data (uiout);
- if (data->suppress_output)
- return;
- tui_field_string (uiout, 0, width, alignment, 0, colhdr);
-}
-
-/* Mark beginning of a list. */
-
-void
-tui_begin (struct ui_out *uiout,
- enum ui_out_type type,
- int level,
- const char *id)
-{
- tui_out_data *data = ui_out_data (uiout);
- if (data->suppress_output)
- return;
-}
-
-/* Mark end of a list. */
-
-void
-tui_end (struct ui_out *uiout,
- enum ui_out_type type,
- int level)
-{
- tui_out_data *data = ui_out_data (uiout);
- if (data->suppress_output)
- return;
-}
+static struct ui_out_impl tui_ui_out_impl;
/* Output an int field. */
-void
+static void
tui_field_int (struct ui_out *uiout,
int fldno, int width,
enum ui_align alignment,
const char *fldname,
int value)
{
- char buffer[20]; /* FIXME: how many chars long a %d can become? */
-
tui_out_data *data = ui_out_data (uiout);
- if (data->suppress_output)
+ if (data->base.suppress_output)
return;
/* Don't print line number, keep it for later. */
@@ -222,39 +64,23 @@ tui_field_int (struct ui_out *uiout,
return;
}
data->start_of_line ++;
- sprintf (buffer, "%d", value);
- tui_field_string (uiout, fldno, width, alignment, fldname, buffer);
-}
-
-/* Used to ommit a field. */
-void
-tui_field_skip (struct ui_out *uiout,
- int fldno, int width,
- enum ui_align alignment,
- const char *fldname)
-{
- tui_out_data *data = ui_out_data (uiout);
- if (data->suppress_output)
- return;
- tui_field_string (uiout, fldno, width, alignment, fldname, "");
+ (*cli_ui_out_impl.field_int) (uiout, fldno,
+ width, alignment, fldname, value);
}
-/* Other specific tui_field_* end up here so alignment and field
- separators are both handled by tui_field_string. */
+/* Other cli_field_* end up here so alignment and field separators are
+ both handled by tui_field_string. */
-void
+static void
tui_field_string (struct ui_out *uiout,
int fldno, int width,
enum ui_align align,
const char *fldname,
const char *string)
{
- int before = 0;
- int after = 0;
-
tui_out_data *data = ui_out_data (uiout);
- if (data->suppress_output)
+ if (data->base.suppress_output)
return;
if (fldname && data->line > 0 && strcmp (fldname, "file") == 0)
@@ -267,44 +93,16 @@ tui_field_string (struct ui_out *uiout,
return;
}
- data->start_of_line ++;
- if ((align != ui_noalign) && string)
- {
- before = width - strlen (string);
- if (before <= 0)
- before = 0;
- else
- {
- if (align == ui_right)
- after = 0;
- else if (align == ui_left)
- {
- after = before;
- before = 0;
- }
- else
- /* ui_center */
- {
- after = before / 2;
- before -= after;
- }
- }
- }
-
- if (before)
- ui_out_spaces (uiout, before);
- if (string)
- out_field_fmt (uiout, fldno, fldname, "%s", string);
- if (after)
- ui_out_spaces (uiout, after);
+ data->start_of_line++;
- if (align != ui_noalign)
- field_separator ();
+ (*cli_ui_out_impl.field_string) (uiout, fldno,
+ width, align,
+ fldname, string);
}
/* This is the only field function that does not align. */
-void
+static void
tui_field_fmt (struct ui_out *uiout, int fldno,
int width, enum ui_align align,
const char *fldname,
@@ -312,30 +110,21 @@ tui_field_fmt (struct ui_out *uiout, int
va_list args)
{
tui_out_data *data = ui_out_data (uiout);
- if (data->suppress_output)
+ if (data->base.suppress_output)
return;
- data->start_of_line ++;
- vfprintf_filtered (data->stream, format, args);
-
- if (align != ui_noalign)
- field_separator ();
-}
+ data->start_of_line++;
-void
-tui_spaces (struct ui_out *uiout, int numspaces)
-{
- tui_out_data *data = ui_out_data (uiout);
- if (data->suppress_output)
- return;
- print_spaces_filtered (numspaces, data->stream);
+ (*cli_ui_out_impl.field_fmt) (uiout, fldno,
+ width, align,
+ fldname, format, args);
}
-void
+static void
tui_text (struct ui_out *uiout, const char *string)
{
tui_out_data *data = ui_out_data (uiout);
- if (data->suppress_output)
+ if (data->base.suppress_output)
return;
data->start_of_line ++;
if (data->line > 0)
@@ -349,86 +138,40 @@ tui_text (struct ui_out *uiout, const ch
}
if (strchr (string, '\n'))
data->start_of_line = 0;
- fputs_filtered (string, data->stream);
-}
-
-void
-tui_message (struct ui_out *uiout,
- int verbosity,
- const char *format,
- va_list args)
-{
- tui_out_data *data = ui_out_data (uiout);
- if (data->suppress_output)
- return;
- if (ui_out_get_verblvl (uiout) >= verbosity)
- vfprintf_unfiltered (data->stream, format, args);
-}
-void
-tui_wrap_hint (struct ui_out *uiout, char *identstring)
-{
- tui_out_data *data = ui_out_data (uiout);
- if (data->suppress_output)
- return;
- wrap_here (identstring);
+ (*cli_ui_out_impl.text) (uiout, string);
}
-void
-tui_flush (struct ui_out *uiout)
-{
- tui_out_data *data = ui_out_data (uiout);
- gdb_flush (data->stream);
-}
-
-/* Local functions. */
-
-/* Like tui_field_fmt, but takes a variable number of args and makes a
- va_list and does not insert a separator. */
-
-/* VARARGS */
-static void
-out_field_fmt (struct ui_out *uiout,
- int fldno,
- const char *fldname,
- const char *format,...)
-{
- tui_out_data *data = ui_out_data (uiout);
- va_list args;
-
- va_start (args, format);
- vfprintf_filtered (data->stream, format, args);
-
- va_end (args);
-}
-
-/* Access to ui_out format private members. */
-
-static void
-field_separator (void)
-{
- tui_out_data *data = ui_out_data (uiout);
- fputc_filtered (' ', data->stream);
-}
-
-/* Initalize private members at startup. */
-
struct ui_out *
tui_out_new (struct ui_file *stream)
{
int flags = 0;
tui_out_data *data = XMALLOC (tui_out_data);
- data->stream = stream;
- data->suppress_output = 0;
+
+ /* Initialize base "class". */
+ cli_out_data_ctor (&data->base, stream);
+
+ /* Initialize our fields. */
data->line = -1;
data->start_of_line = 0;
+
return ui_out_new (&tui_ui_out_impl, data, flags);
}
/* Standard gdb initialization hook. */
+
+extern void _initialize_tui_out (void);
+
void
_initialize_tui_out (void)
{
- /* Nothing needs to be done. */
+/* Inherit the CLI version. */
+ tui_ui_out_impl = cli_ui_out_impl;
+
+ /* Override a few methods. */
+ tui_ui_out_impl.field_int = tui_field_int;
+ tui_ui_out_impl.field_string = tui_field_string;
+ tui_ui_out_impl.field_fmt = tui_field_fmt;
+ tui_ui_out_impl.text = tui_text;
}
Index: src/gdb/cli-out.c
===================================================================
--- src.orig/gdb/cli-out.c 2010-04-17 23:13:42.000000000 +0100
+++ src/gdb/cli-out.c 2010-04-17 23:32:31.000000000 +0100
@@ -27,13 +27,7 @@
#include "gdb_string.h"
#include "gdb_assert.h"
-struct ui_out_data
- {
- struct ui_file *stream;
- struct ui_file *original_stream;
- int suppress_output;
- };
-typedef struct ui_out_data cli_out_data;
+typedef struct cli_ui_out_data cli_out_data;
/* These are the CLI output functions */
@@ -72,7 +66,7 @@ static int cli_redirect (struct ui_out *
/* FIXME: This can be initialized dynamically after default is set to
handle initial output in main.c */
-static struct ui_out_impl cli_ui_out_impl =
+struct ui_out_impl cli_ui_out_impl =
{
cli_table_begin,
cli_table_body,
@@ -103,10 +97,6 @@ static void out_field_fmt (struct ui_out
const char *fldname,
const char *format,...) ATTR_FORMAT (printf, 4, 5);
-/* local variables */
-
-/* (none yet) */
-
/* Mark beginning of a table */
void
@@ -154,7 +144,10 @@ cli_table_header (struct ui_out *uiout,
cli_out_data *data = ui_out_data (uiout);
if (data->suppress_output)
return;
- cli_field_string (uiout, 0, width, alignment, 0, colhdr);
+
+ /* Always go through the function pointer (virtual function call).
+ We may have been extended. */
+ uo_field_string (uiout, 0, width, alignment, 0, colhdr);
}
/* Mark beginning of a list */
@@ -195,7 +188,10 @@ cli_field_int (struct ui_out *uiout, int
if (data->suppress_output)
return;
sprintf (buffer, "%d", value);
- cli_field_string (uiout, fldno, width, alignment, fldname, buffer);
+
+ /* Always go through the function pointer (virtual function call).
+ We may have been extended. */
+ uo_field_string (uiout, fldno, width, alignment, fldname, buffer);
}
/* used to ommit a field */
@@ -208,7 +204,10 @@ cli_field_skip (struct ui_out *uiout, in
cli_out_data *data = ui_out_data (uiout);
if (data->suppress_output)
return;
- cli_field_string (uiout, fldno, width, alignment, fldname, "");
+
+ /* Always go through the function pointer (virtual function call).
+ We may have been extended. */
+ uo_field_string (uiout, fldno, width, alignment, fldname, "");
}
/* other specific cli_field_* end up here so alignment and field
@@ -330,7 +329,7 @@ cli_flush (struct ui_out *uiout)
int
cli_redirect (struct ui_out *uiout, struct ui_file *outstream)
{
- struct ui_out_data *data = ui_out_data (uiout);
+ cli_out_data *data = ui_out_data (uiout);
if (outstream != NULL)
{
data->original_stream = data->stream;
@@ -374,7 +373,17 @@ field_separator (void)
fputc_filtered (' ', data->stream);
}
-/* Initalize private members at startup. */
+/* Constructor for a `cli_out_data' object. */
+
+void
+cli_out_data_ctor (cli_out_data *self, struct ui_file *stream)
+{
+ self->stream = stream;
+ self->original_stream = NULL;
+ self->suppress_output = 0;
+}
+
+/* Initialize private members at startup. */
struct ui_out *
cli_out_new (struct ui_file *stream)
@@ -382,9 +391,7 @@ cli_out_new (struct ui_file *stream)
int flags = ui_source_list;
cli_out_data *data = XMALLOC (cli_out_data);
- data->stream = stream;
- data->original_stream = NULL;
- data->suppress_output = 0;
+ cli_out_data_ctor (data, stream);
return ui_out_new (&cli_ui_out_impl, data, flags);
}
Index: src/gdb/cli-out.h
===================================================================
--- src.orig/gdb/cli-out.h 2010-04-17 23:13:42.000000000 +0100
+++ src/gdb/cli-out.h 2010-04-17 23:15:14.000000000 +0100
@@ -21,10 +21,26 @@
#ifndef CLI_OUT_H
#define CLI_OUT_H
-struct ui_file;
+#include "ui-out.h"
+
+/* These are exported so that they can be extended by other `ui_out'
+ implementations, like TUI's. */
+
+struct cli_ui_out_data
+ {
+ struct ui_file *stream;
+ struct ui_file *original_stream;
+ int suppress_output;
+ };
+
+extern struct ui_out_impl cli_ui_out_impl;
+
extern struct ui_out *cli_out_new (struct ui_file *stream);
+extern void cli_out_data_ctor (struct cli_ui_out_data *data,
+ struct ui_file *stream);
+
extern struct ui_file *cli_out_set_stream (struct ui_out *uiout,
struct ui_file *stream);
Index: src/gdb/ui-out.c
===================================================================
--- src.orig/gdb/ui-out.c 2010-04-17 23:13:42.000000000 +0100
+++ src/gdb/ui-out.c 2010-04-17 23:15:14.000000000 +0100
@@ -100,7 +100,7 @@ struct ui_out
int flags;
/* specific implementation of ui-out */
struct ui_out_impl *impl;
- struct ui_out_data *data;
+ void *data;
/* Sub structure tracking the ui-out depth. */
int level;
@@ -242,9 +242,6 @@ static void uo_field_int (struct ui_out
enum ui_align align, const char *fldname, int value);
static void uo_field_skip (struct ui_out *uiout, int fldno, int width,
enum ui_align align, const char *fldname);
-static void uo_field_string (struct ui_out *uiout, int fldno, int width,
- enum ui_align align, const char *fldname,
- const char *string);
static void uo_field_fmt (struct ui_out *uiout, int fldno, int width,
enum ui_align align, const char *fldname,
const char *format, va_list args)
@@ -1137,7 +1134,7 @@ ui_out_get_field_separator (struct ui_ou
/* Access to ui-out members data */
-struct ui_out_data *
+void *
ui_out_data (struct ui_out *uiout)
{
return uiout->data;
@@ -1146,8 +1143,7 @@ ui_out_data (struct ui_out *uiout)
/* initalize private members at startup */
struct ui_out *
-ui_out_new (struct ui_out_impl *impl,
- struct ui_out_data *data,
+ui_out_new (struct ui_out_impl *impl, void *data,
int flags)
{
struct ui_out *uiout = XMALLOC (struct ui_out);
Index: src/gdb/ui-out.h
===================================================================
--- src.orig/gdb/ui-out.h 2010-04-17 23:13:42.000000000 +0100
+++ src/gdb/ui-out.h 2010-04-17 23:15:14.000000000 +0100
@@ -27,7 +27,6 @@
/* The ui_out structure */
struct ui_out;
-struct ui_out_data;
struct ui_file;
/* the current ui_out */
@@ -264,13 +263,16 @@ struct ui_out_impl
int is_mi_like_p;
};
-extern struct ui_out_data *ui_out_data (struct ui_out *uiout);
+extern void *ui_out_data (struct ui_out *uiout);
+extern void uo_field_string (struct ui_out *uiout, int fldno, int width,
+ enum ui_align align, const char *fldname,
+ const char *string);
/* Create a ui_out object */
extern struct ui_out *ui_out_new (struct ui_out_impl *impl,
- struct ui_out_data *data,
+ void *data,
int flags);
/* Redirect the ouptut of a ui_out object temporarily. */