7c13f4e875
This undoes most of the changes from these commits: commitec8e2b6d30Date: Fri Jun 14 23:43:00 2019 +0100 gdb: Don't allow annotations to influence what else GDB prints commit0d3abd8cc9Date: Wed Jun 12 22:34:26 2019 +0100 gdb: Remove an update of current_source_line and current_source_symtab as a result of the discussion here: https://sourceware.org/pipermail/gdb/2020-April/048468.html Having taken time to reflect on the discussion, and reading the documentation again I believe we should revert GDB's behaviour back to how it used to be. The original concern that triggered the initial patch was that when annotations were on the current source and line were updated (inside the annotation code), while when annotations are off this update would not occur. This was incorrect, as printing the source with the call to print_source_lines does also update the current source and line. Further, the documentation here: https://sourceware.org/gdb/current/onlinedocs/gdb/Source-Annotations.html#Source-Annotations Clearly states: "The following annotation is used instead of displaying source code: ^Z^Zsource filename:line:character:middle:addr ..." So it is documented that the 'source' annotation is a replacement for, and not in addition to, actually printing the source lie. There are still a few issues that I can see, these are: 1. In source.c:info_line_command, when annotations are on we call annotate_source_line, however, if annotations are off then there is no corresponding call to print the source line. This means that a if a user uses 'info line ...' with annotations on, and then does a 'list', they will get different results than if they had done this with annotations off. 2. It bothers me that the call to annotate_source_line returns a boolean, and that this controls a call to print_source_line (in stack.c:print_frame_info). The reason for this is that the source line annotation will only print something if the file is found, and the line number is in range for the file. It seems to me like an annotation should always be printed, either one that identifies the file and line, or one that identifies the file and line GDB would like to access, but couldn't. I considered changing this, but in the end decided not too, if I extend the existing 'source' annotation to print something in all cases then I risk breaking existing UIs that rely on the file and line always being valid. If I add a new annotation then this might also break existing UIs that rely on GDB itself printing the error from within print_source_line. Given that annotations is deprecated (as I understand it) mechanism for UIs to interact with GDB (in favour of MI) I figure we should just restore the old behaviour, and leave the mini-bugs in until someone actually complains. This isn't a straight revert of the two commits mentioned above. I've left annotate_source_line instead of going back to the original identify_source_line, which lived in source.c, but was really annotation related. The API for setting the current source and line has changed since the original patches, so I updated for that change too. Finally I wrote the code in stack.c so that we avoided an extra level of indentation, which I felt made things easier to read. gdb/ChangeLog: * annotate.c (annotate_source_line): Update return type, add call to update current symtab and line. * annotate.h (annotate_source_line): Update return type, and extend header comment. * source.c (info_line_command): Check annotation_level before calling annotate_source_line. * stack.c (print_frame_info): If calling annotate_source_line returns true, then don't print any other source line information. gdb/testsuite/ChangeLog: * gdb.base/annota1.exp: Update expected results. * gdb.cp/annota2.exp: Update expected results, remove duplicate test name. * gdb.cp/annota3.exp: Update expected results.
635 lines
13 KiB
C
635 lines
13 KiB
C
/* Annotation routines for GDB.
|
||
Copyright (C) 1986-2020 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 "defs.h"
|
||
#include "annotate.h"
|
||
#include "value.h"
|
||
#include "target.h"
|
||
#include "gdbtypes.h"
|
||
#include "breakpoint.h"
|
||
#include "observable.h"
|
||
#include "inferior.h"
|
||
#include "infrun.h"
|
||
#include "top.h"
|
||
#include "source.h"
|
||
#include "objfiles.h"
|
||
#include "source-cache.h"
|
||
|
||
|
||
/* Prototypes for local functions. */
|
||
|
||
static void print_value_flags (struct type *);
|
||
|
||
static void breakpoint_changed (struct breakpoint *b);
|
||
|
||
|
||
void (*deprecated_annotate_signalled_hook) (void);
|
||
void (*deprecated_annotate_signal_hook) (void);
|
||
|
||
/* Booleans indicating whether we've emitted certain notifications.
|
||
Used to suppress useless repeated notifications until the next time
|
||
we're ready to accept more commands. Reset whenever a prompt is
|
||
displayed. */
|
||
static int frames_invalid_emitted;
|
||
static int breakpoints_invalid_emitted;
|
||
|
||
static void
|
||
print_value_flags (struct type *t)
|
||
{
|
||
if (can_dereference (t))
|
||
printf_filtered (("*"));
|
||
else
|
||
printf_filtered (("-"));
|
||
}
|
||
|
||
static void
|
||
annotate_breakpoints_invalid (void)
|
||
{
|
||
if (annotation_level == 2
|
||
&& (!breakpoints_invalid_emitted
|
||
|| current_ui->prompt_state != PROMPT_BLOCKED))
|
||
{
|
||
target_terminal::scoped_restore_terminal_state term_state;
|
||
target_terminal::ours_for_output ();
|
||
|
||
printf_unfiltered (("\n\032\032breakpoints-invalid\n"));
|
||
breakpoints_invalid_emitted = 1;
|
||
}
|
||
}
|
||
|
||
void
|
||
annotate_breakpoint (int num)
|
||
{
|
||
if (annotation_level > 1)
|
||
printf_filtered (("\n\032\032breakpoint %d\n"), num);
|
||
}
|
||
|
||
void
|
||
annotate_catchpoint (int num)
|
||
{
|
||
if (annotation_level > 1)
|
||
printf_filtered (("\n\032\032catchpoint %d\n"), num);
|
||
}
|
||
|
||
void
|
||
annotate_watchpoint (int num)
|
||
{
|
||
if (annotation_level > 1)
|
||
printf_filtered (("\n\032\032watchpoint %d\n"), num);
|
||
}
|
||
|
||
void
|
||
annotate_starting (void)
|
||
{
|
||
if (annotation_level > 1)
|
||
printf_filtered (("\n\032\032starting\n"));
|
||
}
|
||
|
||
void
|
||
annotate_stopped (void)
|
||
{
|
||
if (annotation_level > 1)
|
||
printf_filtered (("\n\032\032stopped\n"));
|
||
}
|
||
|
||
void
|
||
annotate_exited (int exitstatus)
|
||
{
|
||
if (annotation_level > 1)
|
||
printf_filtered (("\n\032\032exited %d\n"), exitstatus);
|
||
}
|
||
|
||
void
|
||
annotate_signalled (void)
|
||
{
|
||
if (deprecated_annotate_signalled_hook)
|
||
deprecated_annotate_signalled_hook ();
|
||
|
||
if (annotation_level > 1)
|
||
printf_filtered (("\n\032\032signalled\n"));
|
||
}
|
||
|
||
void
|
||
annotate_signal_name (void)
|
||
{
|
||
if (annotation_level == 2)
|
||
printf_filtered (("\n\032\032signal-name\n"));
|
||
}
|
||
|
||
void
|
||
annotate_signal_name_end (void)
|
||
{
|
||
if (annotation_level == 2)
|
||
printf_filtered (("\n\032\032signal-name-end\n"));
|
||
}
|
||
|
||
void
|
||
annotate_signal_string (void)
|
||
{
|
||
if (annotation_level == 2)
|
||
printf_filtered (("\n\032\032signal-string\n"));
|
||
}
|
||
|
||
void
|
||
annotate_signal_string_end (void)
|
||
{
|
||
if (annotation_level == 2)
|
||
printf_filtered (("\n\032\032signal-string-end\n"));
|
||
}
|
||
|
||
void
|
||
annotate_signal (void)
|
||
{
|
||
if (deprecated_annotate_signal_hook)
|
||
deprecated_annotate_signal_hook ();
|
||
|
||
if (annotation_level > 1)
|
||
printf_filtered (("\n\032\032signal\n"));
|
||
}
|
||
|
||
void
|
||
annotate_breakpoints_headers (void)
|
||
{
|
||
if (annotation_level == 2)
|
||
printf_filtered (("\n\032\032breakpoints-headers\n"));
|
||
}
|
||
|
||
void
|
||
annotate_field (int num)
|
||
{
|
||
if (annotation_level == 2)
|
||
printf_filtered (("\n\032\032field %d\n"), num);
|
||
}
|
||
|
||
void
|
||
annotate_breakpoints_table (void)
|
||
{
|
||
if (annotation_level == 2)
|
||
printf_filtered (("\n\032\032breakpoints-table\n"));
|
||
}
|
||
|
||
void
|
||
annotate_record (void)
|
||
{
|
||
if (annotation_level == 2)
|
||
printf_filtered (("\n\032\032record\n"));
|
||
}
|
||
|
||
void
|
||
annotate_breakpoints_table_end (void)
|
||
{
|
||
if (annotation_level == 2)
|
||
printf_filtered (("\n\032\032breakpoints-table-end\n"));
|
||
}
|
||
|
||
void
|
||
annotate_frames_invalid (void)
|
||
{
|
||
if (annotation_level == 2
|
||
&& (!frames_invalid_emitted
|
||
|| current_ui->prompt_state != PROMPT_BLOCKED))
|
||
{
|
||
target_terminal::scoped_restore_terminal_state term_state;
|
||
target_terminal::ours_for_output ();
|
||
|
||
printf_unfiltered (("\n\032\032frames-invalid\n"));
|
||
frames_invalid_emitted = 1;
|
||
}
|
||
}
|
||
|
||
void
|
||
annotate_new_thread (void)
|
||
{
|
||
if (annotation_level > 1)
|
||
{
|
||
printf_unfiltered (("\n\032\032new-thread\n"));
|
||
}
|
||
}
|
||
|
||
void
|
||
annotate_thread_changed (void)
|
||
{
|
||
if (annotation_level > 1)
|
||
{
|
||
printf_unfiltered (("\n\032\032thread-changed\n"));
|
||
}
|
||
}
|
||
|
||
/* Emit notification on thread exit. */
|
||
|
||
static void
|
||
annotate_thread_exited (struct thread_info *t, int silent)
|
||
{
|
||
if (annotation_level > 1)
|
||
{
|
||
printf_filtered(("\n\032\032thread-exited,"
|
||
"id=\"%d\",group-id=\"i%d\"\n"),
|
||
t->global_num, t->inf->num);
|
||
}
|
||
}
|
||
|
||
void
|
||
annotate_field_begin (struct type *type)
|
||
{
|
||
if (annotation_level == 2)
|
||
{
|
||
printf_filtered (("\n\032\032field-begin "));
|
||
print_value_flags (type);
|
||
printf_filtered (("\n"));
|
||
}
|
||
}
|
||
|
||
void
|
||
annotate_field_name_end (void)
|
||
{
|
||
if (annotation_level == 2)
|
||
printf_filtered (("\n\032\032field-name-end\n"));
|
||
}
|
||
|
||
void
|
||
annotate_field_value (void)
|
||
{
|
||
if (annotation_level == 2)
|
||
printf_filtered (("\n\032\032field-value\n"));
|
||
}
|
||
|
||
void
|
||
annotate_field_end (void)
|
||
{
|
||
if (annotation_level == 2)
|
||
printf_filtered (("\n\032\032field-end\n"));
|
||
}
|
||
|
||
void
|
||
annotate_quit (void)
|
||
{
|
||
if (annotation_level > 1)
|
||
printf_filtered (("\n\032\032quit\n"));
|
||
}
|
||
|
||
void
|
||
annotate_error (void)
|
||
{
|
||
if (annotation_level > 1)
|
||
printf_filtered (("\n\032\032error\n"));
|
||
}
|
||
|
||
void
|
||
annotate_error_begin (void)
|
||
{
|
||
if (annotation_level > 1)
|
||
fprintf_filtered (gdb_stderr, "\n\032\032error-begin\n");
|
||
}
|
||
|
||
void
|
||
annotate_value_history_begin (int histindex, struct type *type)
|
||
{
|
||
if (annotation_level == 2)
|
||
{
|
||
printf_filtered (("\n\032\032value-history-begin %d "), histindex);
|
||
print_value_flags (type);
|
||
printf_filtered (("\n"));
|
||
}
|
||
}
|
||
|
||
void
|
||
annotate_value_begin (struct type *type)
|
||
{
|
||
if (annotation_level == 2)
|
||
{
|
||
printf_filtered (("\n\032\032value-begin "));
|
||
print_value_flags (type);
|
||
printf_filtered (("\n"));
|
||
}
|
||
}
|
||
|
||
void
|
||
annotate_value_history_value (void)
|
||
{
|
||
if (annotation_level == 2)
|
||
printf_filtered (("\n\032\032value-history-value\n"));
|
||
}
|
||
|
||
void
|
||
annotate_value_history_end (void)
|
||
{
|
||
if (annotation_level == 2)
|
||
printf_filtered (("\n\032\032value-history-end\n"));
|
||
}
|
||
|
||
void
|
||
annotate_value_end (void)
|
||
{
|
||
if (annotation_level == 2)
|
||
printf_filtered (("\n\032\032value-end\n"));
|
||
}
|
||
|
||
void
|
||
annotate_display_begin (void)
|
||
{
|
||
if (annotation_level == 2)
|
||
printf_filtered (("\n\032\032display-begin\n"));
|
||
}
|
||
|
||
void
|
||
annotate_display_number_end (void)
|
||
{
|
||
if (annotation_level == 2)
|
||
printf_filtered (("\n\032\032display-number-end\n"));
|
||
}
|
||
|
||
void
|
||
annotate_display_format (void)
|
||
{
|
||
if (annotation_level == 2)
|
||
printf_filtered (("\n\032\032display-format\n"));
|
||
}
|
||
|
||
void
|
||
annotate_display_expression (void)
|
||
{
|
||
if (annotation_level == 2)
|
||
printf_filtered (("\n\032\032display-expression\n"));
|
||
}
|
||
|
||
void
|
||
annotate_display_expression_end (void)
|
||
{
|
||
if (annotation_level == 2)
|
||
printf_filtered (("\n\032\032display-expression-end\n"));
|
||
}
|
||
|
||
void
|
||
annotate_display_value (void)
|
||
{
|
||
if (annotation_level == 2)
|
||
printf_filtered (("\n\032\032display-value\n"));
|
||
}
|
||
|
||
void
|
||
annotate_display_end (void)
|
||
{
|
||
if (annotation_level == 2)
|
||
printf_filtered (("\n\032\032display-end\n"));
|
||
}
|
||
|
||
void
|
||
annotate_arg_begin (void)
|
||
{
|
||
if (annotation_level == 2)
|
||
printf_filtered (("\n\032\032arg-begin\n"));
|
||
}
|
||
|
||
void
|
||
annotate_arg_name_end (void)
|
||
{
|
||
if (annotation_level == 2)
|
||
printf_filtered (("\n\032\032arg-name-end\n"));
|
||
}
|
||
|
||
void
|
||
annotate_arg_value (struct type *type)
|
||
{
|
||
if (annotation_level == 2)
|
||
{
|
||
printf_filtered (("\n\032\032arg-value "));
|
||
print_value_flags (type);
|
||
printf_filtered (("\n"));
|
||
}
|
||
}
|
||
|
||
void
|
||
annotate_arg_end (void)
|
||
{
|
||
if (annotation_level == 2)
|
||
printf_filtered (("\n\032\032arg-end\n"));
|
||
}
|
||
|
||
static void
|
||
annotate_source (const char *filename, int line, int character, int mid,
|
||
struct gdbarch *gdbarch, CORE_ADDR pc)
|
||
{
|
||
if (annotation_level > 1)
|
||
printf_filtered (("\n\032\032source "));
|
||
else
|
||
printf_filtered (("\032\032"));
|
||
|
||
printf_filtered (("%s:%d:%d:%s:%s\n"), filename, line, character,
|
||
mid ? "middle" : "beg", paddress (gdbarch, pc));
|
||
}
|
||
|
||
/* See annotate.h. */
|
||
|
||
bool
|
||
annotate_source_line (struct symtab *s, int line, int mid_statement,
|
||
CORE_ADDR pc)
|
||
{
|
||
if (annotation_level > 0)
|
||
{
|
||
const std::vector<off_t> *offsets;
|
||
if (!g_source_cache.get_line_charpos (s, &offsets))
|
||
return false;
|
||
if (line > offsets->size ())
|
||
return false;
|
||
|
||
annotate_source (s->fullname, line, (int) (*offsets)[line - 1],
|
||
mid_statement, SYMTAB_OBJFILE (s)->arch (),
|
||
pc);
|
||
|
||
/* Update the current symtab and line. */
|
||
symtab_and_line sal;
|
||
sal.pspace = SYMTAB_PSPACE (s);
|
||
sal.symtab = s;
|
||
sal.line = line;
|
||
set_current_source_symtab_and_line (sal);
|
||
|
||
return true;
|
||
}
|
||
|
||
return false;
|
||
}
|
||
|
||
|
||
void
|
||
annotate_frame_begin (int level, struct gdbarch *gdbarch, CORE_ADDR pc)
|
||
{
|
||
if (annotation_level > 1)
|
||
printf_filtered (("\n\032\032frame-begin %d %s\n"),
|
||
level, paddress (gdbarch, pc));
|
||
}
|
||
|
||
void
|
||
annotate_function_call (void)
|
||
{
|
||
if (annotation_level == 2)
|
||
printf_filtered (("\n\032\032function-call\n"));
|
||
}
|
||
|
||
void
|
||
annotate_signal_handler_caller (void)
|
||
{
|
||
if (annotation_level == 2)
|
||
printf_filtered (("\n\032\032signal-handler-caller\n"));
|
||
}
|
||
|
||
void
|
||
annotate_frame_address (void)
|
||
{
|
||
if (annotation_level == 2)
|
||
printf_filtered (("\n\032\032frame-address\n"));
|
||
}
|
||
|
||
void
|
||
annotate_frame_address_end (void)
|
||
{
|
||
if (annotation_level == 2)
|
||
printf_filtered (("\n\032\032frame-address-end\n"));
|
||
}
|
||
|
||
void
|
||
annotate_frame_function_name (void)
|
||
{
|
||
if (annotation_level == 2)
|
||
printf_filtered (("\n\032\032frame-function-name\n"));
|
||
}
|
||
|
||
void
|
||
annotate_frame_args (void)
|
||
{
|
||
if (annotation_level == 2)
|
||
printf_filtered (("\n\032\032frame-args\n"));
|
||
}
|
||
|
||
void
|
||
annotate_frame_source_begin (void)
|
||
{
|
||
if (annotation_level == 2)
|
||
printf_filtered (("\n\032\032frame-source-begin\n"));
|
||
}
|
||
|
||
void
|
||
annotate_frame_source_file (void)
|
||
{
|
||
if (annotation_level == 2)
|
||
printf_filtered (("\n\032\032frame-source-file\n"));
|
||
}
|
||
|
||
void
|
||
annotate_frame_source_file_end (void)
|
||
{
|
||
if (annotation_level == 2)
|
||
printf_filtered (("\n\032\032frame-source-file-end\n"));
|
||
}
|
||
|
||
void
|
||
annotate_frame_source_line (void)
|
||
{
|
||
if (annotation_level == 2)
|
||
printf_filtered (("\n\032\032frame-source-line\n"));
|
||
}
|
||
|
||
void
|
||
annotate_frame_source_end (void)
|
||
{
|
||
if (annotation_level == 2)
|
||
printf_filtered (("\n\032\032frame-source-end\n"));
|
||
}
|
||
|
||
void
|
||
annotate_frame_where (void)
|
||
{
|
||
if (annotation_level == 2)
|
||
printf_filtered (("\n\032\032frame-where\n"));
|
||
}
|
||
|
||
void
|
||
annotate_frame_end (void)
|
||
{
|
||
if (annotation_level == 2)
|
||
printf_filtered (("\n\032\032frame-end\n"));
|
||
}
|
||
|
||
void
|
||
annotate_array_section_begin (int idx, struct type *elttype)
|
||
{
|
||
if (annotation_level == 2)
|
||
{
|
||
printf_filtered (("\n\032\032array-section-begin %d "), idx);
|
||
print_value_flags (elttype);
|
||
printf_filtered (("\n"));
|
||
}
|
||
}
|
||
|
||
void
|
||
annotate_elt_rep (unsigned int repcount)
|
||
{
|
||
if (annotation_level == 2)
|
||
printf_filtered (("\n\032\032elt-rep %u\n"), repcount);
|
||
}
|
||
|
||
void
|
||
annotate_elt_rep_end (void)
|
||
{
|
||
if (annotation_level == 2)
|
||
printf_filtered (("\n\032\032elt-rep-end\n"));
|
||
}
|
||
|
||
void
|
||
annotate_elt (void)
|
||
{
|
||
if (annotation_level == 2)
|
||
printf_filtered (("\n\032\032elt\n"));
|
||
}
|
||
|
||
void
|
||
annotate_array_section_end (void)
|
||
{
|
||
if (annotation_level == 2)
|
||
printf_filtered (("\n\032\032array-section-end\n"));
|
||
}
|
||
|
||
/* Called when GDB is about to display the prompt. Used to reset
|
||
annotation suppression whenever we're ready to accept new
|
||
frontend/user commands. */
|
||
|
||
void
|
||
annotate_display_prompt (void)
|
||
{
|
||
frames_invalid_emitted = 0;
|
||
breakpoints_invalid_emitted = 0;
|
||
}
|
||
|
||
static void
|
||
breakpoint_changed (struct breakpoint *b)
|
||
{
|
||
if (b->number <= 0)
|
||
return;
|
||
|
||
annotate_breakpoints_invalid ();
|
||
}
|
||
|
||
void _initialize_annotate ();
|
||
void
|
||
_initialize_annotate ()
|
||
{
|
||
gdb::observers::breakpoint_created.attach (breakpoint_changed);
|
||
gdb::observers::breakpoint_deleted.attach (breakpoint_changed);
|
||
gdb::observers::breakpoint_modified.attach (breakpoint_changed);
|
||
gdb::observers::thread_exit.attach (annotate_thread_exited);
|
||
}
|