binutils-gdb/gdb/mi/mi-out.c
Simon Marchi b4be1b0648 Fix MI output for multi-location breakpoints
New in v2:

- Addressed comments about doc, updated the MI version table
- New doc for the Breakpoint information format
- New -fix-multi-location-breakpoint-output command, with associated
  doc, test and NEWS updated accordingly
- Fixed the output, the locations list is now actually in the tuple
  representing the breakpoint.

Various MI commands or events related to breakpoints output invalid MI
records when printing information about a multi-location breakpoint.
For example:

    -break-insert allo
    ^done,bkpt={...,addr="<MULTIPLE>",...},{number="1.1",...},{number="1.2",...}

The problem is that according to the syntax [1], the top-level elements
are of type "result" and should be of the form "variable=value".

This patch changes the output to wrap the locations in a list:

    ^done,bkpt={...,addr="<MULTIPLE>",locations=[{number="1.1",...},{number="1.2",...}]}

The events =breakpoint-created, =breakpoint-modified, as well as the
-break-info command also suffer from this (and maybe others I didn't
find).

Since this is a breaking change for MI, we have to deal somehow with
backwards compatibility.  The approach taken by this patch is to bump
the MI version, use the new syntax in MI3 while retaining the old syntax
in MI2.  Frontends are expected to use a precise MI version (-i=mi2), so
if they do that they should be unaffected.

The patch also adds the command -fix-multi-location-breakpoint-output,
which front ends can use to enable this behavior with MI <= 2.

[1] https://sourceware.org/gdb/onlinedocs/gdb/GDB_002fMI-Output-Syntax.html#GDB_002fMI-Output-Syntax

gdb/ChangeLog:

	* NEWS: Mention that the new default MI version is 3.  Mention
	changes to the output of commands and events that deal with
	multi-location breakpoints.
	* breakpoint.c: Include "mi/mi-out.h".
	(print_one_breakpoint): Change output syntax if using MI version
	>= 3.
	* mi/mi-main.h (mi_cmd_fix_multi_location_breakpoint_output):
	New.
	(mi_multi_location_breakpoint_output_fixed): New.
	* mi/mi-main.c (fix_multi_location_breakpoint_output): New.
	(mi_cmd_fix_multi_location_breakpoint_output): New.
	(mi_multi_location_breakpoint_output_fixed): New.
	* mi/mi-cmds.c (mi_cmds): Register command
	-fix-multi-location-breakpoint-output.
	* mi/mi-out.c (mi_out_new): Instantiate version 3 when using
	interpreter "mi".

gdb/testsuite/ChangeLog:

	* mi-breakpoint-location-ena-dis.exp: Rename to ...
	* mi-breakpoint-multiple-locations.exp: ... this.
	(make_breakpoints_pattern): New proc.
	(do_test): Add mi_version parameter, test -break-insert,
	-break-info and	=breakpoint-created.

gdb/doc/ChangeLog:

	* gdb.texinfo (Mode Options): Mention mi3.
	(Interpreters): Likewise.
	(GDB/MI Development and Front Ends): Add entry for MI 3 in
	version table.  Document -fix-multi-location-breakpoint-output.
	(GDB/MI Breakpoint Information): Document format of breakpoint
	location output.
2019-03-13 15:14:36 -04:00

342 lines
6.8 KiB
C

/* MI Command Set - output generating routines.
Copyright (C) 2000-2019 Free Software Foundation, Inc.
Contributed by Cygnus Solutions (a Red Hat company).
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 "defs.h"
#include "mi-out.h"
#include <vector>
#include "interps.h"
#include "ui-out.h"
#include "utils.h"
/* Mark beginning of a table. */
void
mi_ui_out::do_table_begin (int nr_cols, int nr_rows,
const char *tblid)
{
open (tblid, ui_out_type_tuple);
do_field_int (-1, -1, ui_left, "nr_rows", nr_rows);
do_field_int (-1, -1, ui_left, "nr_cols", nr_cols);
open ("hdr", ui_out_type_list);
}
/* Mark beginning of a table body. */
void
mi_ui_out::do_table_body ()
{
/* close the table header line if there were any headers */
close (ui_out_type_list);
open ("body", ui_out_type_list);
}
/* Mark end of a table. */
void
mi_ui_out::do_table_end ()
{
close (ui_out_type_list); /* body */
close (ui_out_type_tuple);
}
/* Specify table header. */
void
mi_ui_out::do_table_header (int width, ui_align alignment,
const std::string &col_name,
const std::string &col_hdr)
{
open (NULL, ui_out_type_tuple);
do_field_int (0, 0, ui_center, "width", width);
do_field_int (0, 0, ui_center, "alignment", alignment);
do_field_string (0, 0, ui_center, "col_name", col_name.c_str (),
ui_out_style_kind::DEFAULT);
do_field_string (0, width, alignment, "colhdr", col_hdr.c_str (),
ui_out_style_kind::DEFAULT);
close (ui_out_type_tuple);
}
/* Mark beginning of a list. */
void
mi_ui_out::do_begin (ui_out_type type, const char *id)
{
open (id, type);
}
/* Mark end of a list. */
void
mi_ui_out::do_end (ui_out_type type)
{
close (type);
}
/* Output an int field. */
void
mi_ui_out::do_field_int (int fldno, int width, ui_align alignment,
const char *fldname, int value)
{
char buffer[20]; /* FIXME: how many chars long a %d can become? */
xsnprintf (buffer, sizeof (buffer), "%d", value);
do_field_string (fldno, width, alignment, fldname, buffer,
ui_out_style_kind::DEFAULT);
}
/* Used to omit a field. */
void
mi_ui_out::do_field_skip (int fldno, int width, ui_align alignment,
const char *fldname)
{
}
/* Other specific mi_field_* end up here so alignment and field
separators are both handled by mi_field_string. */
void
mi_ui_out::do_field_string (int fldno, int width, ui_align align,
const char *fldname, const char *string,
ui_out_style_kind style)
{
ui_file *stream = m_streams.back ();
field_separator ();
if (fldname)
fprintf_unfiltered (stream, "%s=", fldname);
fprintf_unfiltered (stream, "\"");
if (string)
fputstr_unfiltered (string, '"', stream);
fprintf_unfiltered (stream, "\"");
}
void
mi_ui_out::do_field_fmt (int fldno, int width, ui_align align,
const char *fldname, const char *format,
va_list args)
{
ui_file *stream = m_streams.back ();
field_separator ();
if (fldname)
fprintf_unfiltered (stream, "%s=\"", fldname);
else
fputs_unfiltered ("\"", stream);
vfprintf_unfiltered (stream, format, args);
fputs_unfiltered ("\"", stream);
}
void
mi_ui_out::do_spaces (int numspaces)
{
}
void
mi_ui_out::do_text (const char *string)
{
}
void
mi_ui_out::do_message (const char *format, va_list args)
{
}
void
mi_ui_out::do_wrap_hint (const char *identstring)
{
wrap_here (identstring);
}
void
mi_ui_out::do_flush ()
{
gdb_flush (m_streams.back ());
}
void
mi_ui_out::do_redirect (ui_file *outstream)
{
if (outstream != NULL)
m_streams.push_back (outstream);
else
m_streams.pop_back ();
}
void
mi_ui_out::field_separator ()
{
if (m_suppress_field_separator)
m_suppress_field_separator = false;
else
fputc_unfiltered (',', m_streams.back ());
}
void
mi_ui_out::open (const char *name, ui_out_type type)
{
ui_file *stream = m_streams.back ();
field_separator ();
m_suppress_field_separator = true;
if (name)
fprintf_unfiltered (stream, "%s=", name);
switch (type)
{
case ui_out_type_tuple:
fputc_unfiltered ('{', stream);
break;
case ui_out_type_list:
fputc_unfiltered ('[', stream);
break;
default:
internal_error (__FILE__, __LINE__, _("bad switch"));
}
}
void
mi_ui_out::close (ui_out_type type)
{
ui_file *stream = m_streams.back ();
switch (type)
{
case ui_out_type_tuple:
fputc_unfiltered ('}', stream);
break;
case ui_out_type_list:
fputc_unfiltered (']', stream);
break;
default:
internal_error (__FILE__, __LINE__, _("bad switch"));
}
m_suppress_field_separator = false;
}
string_file *
mi_ui_out::main_stream ()
{
gdb_assert (m_streams.size () == 1);
return (string_file *) m_streams.back ();
}
/* Clear the buffer. */
void
mi_ui_out::rewind ()
{
main_stream ()->clear ();
}
/* Dump the buffer onto the specified stream. */
void
mi_ui_out::put (ui_file *where)
{
string_file *mi_stream = main_stream ();
where->write (mi_stream->data (), mi_stream->size ());
mi_stream->clear ();
}
/* Return the current MI version. */
int
mi_ui_out::version ()
{
return m_mi_version;
}
/* Constructor for an `mi_out_data' object. */
mi_ui_out::mi_ui_out (int mi_version)
: m_suppress_field_separator (false),
m_suppress_output (false),
m_mi_version (mi_version)
{
string_file *stream = new string_file ();
m_streams.push_back (stream);
}
mi_ui_out::~mi_ui_out ()
{
}
/* See mi/mi-out.h. */
mi_ui_out *
mi_out_new (const char *mi_version)
{
if (streq (mi_version, INTERP_MI3) || streq (mi_version, INTERP_MI))
return new mi_ui_out (3);
if (streq (mi_version, INTERP_MI2))
return new mi_ui_out (2);
if (streq (mi_version, INTERP_MI1))
return new mi_ui_out (1);
return nullptr;
}
/* Helper function to return the given UIOUT as an mi_ui_out. It is an error
to call this function with an ui_out that is not an MI. */
static mi_ui_out *
as_mi_ui_out (ui_out *uiout)
{
mi_ui_out *mi_uiout = dynamic_cast<mi_ui_out *> (uiout);
gdb_assert (mi_uiout != NULL);
return mi_uiout;
}
int
mi_version (ui_out *uiout)
{
return as_mi_ui_out (uiout)->version ();
}
void
mi_out_put (ui_out *uiout, struct ui_file *stream)
{
return as_mi_ui_out (uiout)->put (stream);
}
void
mi_out_rewind (ui_out *uiout)
{
return as_mi_ui_out (uiout)->rewind ();
}