gdb/annotate.c

   1 /* Annotation routines for GDB.
   2    Copyright (C) 1986-2019 Free Software Foundation, Inc.
   3
   4    This file is part of GDB.
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 3 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  18
  19 #include "defs.h"
  20 #include "annotate.h"
  21 #include "value.h"
  22 #include "target.h"
  23 #include "gdbtypes.h"
  24 #include "breakpoint.h"
  25 #include "observable.h"
  26 #include "inferior.h"
  27 #include "infrun.h"
  28 #include "top.h"
  29 #include "source.h"
  30 #include "objfiles.h"
  31 \f
  32
  33 /* Prototypes for local functions.  */
  34
  35 static void print_value_flags (struct type *);
  36
  37 static void breakpoint_changed (struct breakpoint *b);
  38
  39
  40 void (*deprecated_annotate_signalled_hook) (void);
  41 void (*deprecated_annotate_signal_hook) (void);
  42
  43 /* Booleans indicating whether we've emitted certain notifications.
  44    Used to suppress useless repeated notifications until the next time
  45    we're ready to accept more commands.  Reset whenever a prompt is
  46    displayed.  */
  47 static int frames_invalid_emitted;
  48 static int breakpoints_invalid_emitted;
  49
  50 static void
  51 print_value_flags (struct type *t)
  52 {
  53   if (can_dereference (t))
  54     printf_filtered (("*"));
  55   else
  56     printf_filtered (("-"));
  57 }
  58
  59 static void
  60 annotate_breakpoints_invalid (void)
  61 {
  62   if (annotation_level == 2
  63       && (!breakpoints_invalid_emitted
  64           || current_ui->prompt_state != PROMPT_BLOCKED))
  65     {
  66       target_terminal::scoped_restore_terminal_state term_state;
  67       target_terminal::ours_for_output ();
  68
  69       printf_unfiltered (("\n\032\032breakpoints-invalid\n"));
  70       breakpoints_invalid_emitted = 1;
  71     }
  72 }
  73
  74 void
  75 annotate_breakpoint (int num)
  76 {
  77   if (annotation_level > 1)
  78     printf_filtered (("\n\032\032breakpoint %d\n"), num);
  79 }
  80
  81 void
  82 annotate_catchpoint (int num)
  83 {
  84   if (annotation_level > 1)
  85     printf_filtered (("\n\032\032catchpoint %d\n"), num);
  86 }
  87
  88 void
  89 annotate_watchpoint (int num)
  90 {
  91   if (annotation_level > 1)
  92     printf_filtered (("\n\032\032watchpoint %d\n"), num);
  93 }
  94
  95 void
  96 annotate_starting (void)
  97 {
  98   if (annotation_level > 1)
  99     printf_filtered (("\n\032\032starting\n"));
 100 }
 101
 102 void
 103 annotate_stopped (void)
 104 {
 105   if (annotation_level > 1)
 106     printf_filtered (("\n\032\032stopped\n"));
 107 }
 108
 109 void
 110 annotate_exited (int exitstatus)
 111 {
 112   if (annotation_level > 1)
 113     printf_filtered (("\n\032\032exited %d\n"), exitstatus);
 114 }
 115
 116 void
 117 annotate_signalled (void)
 118 {
 119   if (deprecated_annotate_signalled_hook)
 120     deprecated_annotate_signalled_hook ();
 121
 122   if (annotation_level > 1)
 123     printf_filtered (("\n\032\032signalled\n"));
 124 }
 125
 126 void
 127 annotate_signal_name (void)
 128 {
 129   if (annotation_level == 2)
 130     printf_filtered (("\n\032\032signal-name\n"));
 131 }
 132
 133 void
 134 annotate_signal_name_end (void)
 135 {
 136   if (annotation_level == 2)
 137     printf_filtered (("\n\032\032signal-name-end\n"));
 138 }
 139
 140 void
 141 annotate_signal_string (void)
 142 {
 143   if (annotation_level == 2)
 144     printf_filtered (("\n\032\032signal-string\n"));
 145 }
 146
 147 void
 148 annotate_signal_string_end (void)
 149 {
 150   if (annotation_level == 2)
 151     printf_filtered (("\n\032\032signal-string-end\n"));
 152 }
 153
 154 void
 155 annotate_signal (void)
 156 {
 157   if (deprecated_annotate_signal_hook)
 158     deprecated_annotate_signal_hook ();
 159
 160   if (annotation_level > 1)
 161     printf_filtered (("\n\032\032signal\n"));
 162 }
 163 \f
 164 void
 165 annotate_breakpoints_headers (void)
 166 {
 167   if (annotation_level == 2)
 168     printf_filtered (("\n\032\032breakpoints-headers\n"));
 169 }
 170
 171 void
 172 annotate_field (int num)
 173 {
 174   if (annotation_level == 2)
 175     printf_filtered (("\n\032\032field %d\n"), num);
 176 }
 177
 178 void
 179 annotate_breakpoints_table (void)
 180 {
 181   if (annotation_level == 2)
 182     printf_filtered (("\n\032\032breakpoints-table\n"));
 183 }
 184
 185 void
 186 annotate_record (void)
 187 {
 188   if (annotation_level == 2)
 189     printf_filtered (("\n\032\032record\n"));
 190 }
 191
 192 void
 193 annotate_breakpoints_table_end (void)
 194 {
 195   if (annotation_level == 2)
 196     printf_filtered (("\n\032\032breakpoints-table-end\n"));
 197 }
 198
 199 void
 200 annotate_frames_invalid (void)
 201 {
 202   if (annotation_level == 2
 203       && (!frames_invalid_emitted
 204           || current_ui->prompt_state != PROMPT_BLOCKED))
 205     {
 206       target_terminal::scoped_restore_terminal_state term_state;
 207       target_terminal::ours_for_output ();
 208
 209       printf_unfiltered (("\n\032\032frames-invalid\n"));
 210       frames_invalid_emitted = 1;
 211     }
 212 }
 213
 214 void
 215 annotate_new_thread (void)
 216 {
 217   if (annotation_level > 1)
 218     {
 219       printf_unfiltered (("\n\032\032new-thread\n"));
 220     }
 221 }
 222
 223 void
 224 annotate_thread_changed (void)
 225 {
 226   if (annotation_level > 1)
 227     {
 228       printf_unfiltered (("\n\032\032thread-changed\n"));
 229     }
 230 }
 231
 232 /* Emit notification on thread exit.  */
 233
 234 static void
 235 annotate_thread_exited (struct thread_info *t, int silent)
 236 {
 237   if (annotation_level > 1)
 238     {
 239       printf_filtered(("\n\032\032thread-exited,"
 240                        "id=\"%d\",group-id=\"i%d\"\n"),
 241                       t->global_num, t->inf->num);
 242     }
 243 }
 244
 245 void
 246 annotate_field_begin (struct type *type)
 247 {
 248   if (annotation_level == 2)
 249     {
 250       printf_filtered (("\n\032\032field-begin "));
 251       print_value_flags (type);
 252       printf_filtered (("\n"));
 253     }
 254 }
 255
 256 void
 257 annotate_field_name_end (void)
 258 {
 259   if (annotation_level == 2)
 260     printf_filtered (("\n\032\032field-name-end\n"));
 261 }
 262
 263 void
 264 annotate_field_value (void)
 265 {
 266   if (annotation_level == 2)
 267     printf_filtered (("\n\032\032field-value\n"));
 268 }
 269
 270 void
 271 annotate_field_end (void)
 272 {
 273   if (annotation_level == 2)
 274     printf_filtered (("\n\032\032field-end\n"));
 275 }
 276 \f
 277 void
 278 annotate_quit (void)
 279 {
 280   if (annotation_level > 1)
 281     printf_filtered (("\n\032\032quit\n"));
 282 }
 283
 284 void
 285 annotate_error (void)
 286 {
 287   if (annotation_level > 1)
 288     printf_filtered (("\n\032\032error\n"));
 289 }
 290
 291 void
 292 annotate_error_begin (void)
 293 {
 294   if (annotation_level > 1)
 295     fprintf_filtered (gdb_stderr, "\n\032\032error-begin\n");
 296 }
 297
 298 void
 299 annotate_value_history_begin (int histindex, struct type *type)
 300 {
 301   if (annotation_level == 2)
 302     {
 303       printf_filtered (("\n\032\032value-history-begin %d "), histindex);
 304       print_value_flags (type);
 305       printf_filtered (("\n"));
 306     }
 307 }
 308
 309 void
 310 annotate_value_begin (struct type *type)
 311 {
 312   if (annotation_level == 2)
 313     {
 314       printf_filtered (("\n\032\032value-begin "));
 315       print_value_flags (type);
 316       printf_filtered (("\n"));
 317     }
 318 }
 319
 320 void
 321 annotate_value_history_value (void)
 322 {
 323   if (annotation_level == 2)
 324     printf_filtered (("\n\032\032value-history-value\n"));
 325 }
 326
 327 void
 328 annotate_value_history_end (void)
 329 {
 330   if (annotation_level == 2)
 331     printf_filtered (("\n\032\032value-history-end\n"));
 332 }
 333
 334 void
 335 annotate_value_end (void)
 336 {
 337   if (annotation_level == 2)
 338     printf_filtered (("\n\032\032value-end\n"));
 339 }
 340
 341 void
 342 annotate_display_begin (void)
 343 {
 344   if (annotation_level == 2)
 345     printf_filtered (("\n\032\032display-begin\n"));
 346 }
 347
 348 void
 349 annotate_display_number_end (void)
 350 {
 351   if (annotation_level == 2)
 352     printf_filtered (("\n\032\032display-number-end\n"));
 353 }
 354
 355 void
 356 annotate_display_format (void)
 357 {
 358   if (annotation_level == 2)
 359     printf_filtered (("\n\032\032display-format\n"));
 360 }
 361
 362 void
 363 annotate_display_expression (void)
 364 {
 365   if (annotation_level == 2)
 366     printf_filtered (("\n\032\032display-expression\n"));
 367 }
 368
 369 void
 370 annotate_display_expression_end (void)
 371 {
 372   if (annotation_level == 2)
 373     printf_filtered (("\n\032\032display-expression-end\n"));
 374 }
 375
 376 void
 377 annotate_display_value (void)
 378 {
 379   if (annotation_level == 2)
 380     printf_filtered (("\n\032\032display-value\n"));
 381 }
 382
 383 void
 384 annotate_display_end (void)
 385 {
 386   if (annotation_level == 2)
 387     printf_filtered (("\n\032\032display-end\n"));
 388 }
 389
 390 void
 391 annotate_arg_begin (void)
 392 {
 393   if (annotation_level == 2)
 394     printf_filtered (("\n\032\032arg-begin\n"));
 395 }
 396
 397 void
 398 annotate_arg_name_end (void)
 399 {
 400   if (annotation_level == 2)
 401     printf_filtered (("\n\032\032arg-name-end\n"));
 402 }
 403
 404 void
 405 annotate_arg_value (struct type *type)
 406 {
 407   if (annotation_level == 2)
 408     {
 409       printf_filtered (("\n\032\032arg-value "));
 410       print_value_flags (type);
 411       printf_filtered (("\n"));
 412     }
 413 }
 414
 415 void
 416 annotate_arg_end (void)
 417 {
 418   if (annotation_level == 2)
 419     printf_filtered (("\n\032\032arg-end\n"));
 420 }
 421
 422 static void
 423 annotate_source (const char *filename, int line, int character, int mid,
 424                  struct gdbarch *gdbarch, CORE_ADDR pc)
 425 {
 426   if (annotation_level > 1)
 427     printf_filtered (("\n\032\032source "));
 428   else
 429     printf_filtered (("\032\032"));
 430
 431   printf_filtered (("%s:%d:%d:%s:%s\n"), filename, line, character,
 432                    mid ? "middle" : "beg", paddress (gdbarch, pc));
 433 }
 434
 435 /* See annotate.h.  */
 436
 437 bool
 438 annotate_source_line (struct symtab *s, int line, int mid_statement,
 439                       CORE_ADDR pc)
 440 {
 441   if (annotation_level > 0)
 442     {
 443       if (s->line_charpos == nullptr)
 444         open_source_file_with_line_charpos (s);
 445       if (s->fullname == nullptr)
 446         return false;
 447       /* Don't index off the end of the line_charpos array.  */
 448       if (line > s->nlines)
 449         return false;
 450
 451       annotate_source (s->fullname, line, s->line_charpos[line - 1],
 452                        mid_statement, get_objfile_arch (SYMTAB_OBJFILE (s)),
 453                        pc);
 454       return true;
 455     }
 456   return false;
 457 }
 458
 459
 460 void
 461 annotate_frame_begin (int level, struct gdbarch *gdbarch, CORE_ADDR pc)
 462 {
 463   if (annotation_level > 1)
 464     printf_filtered (("\n\032\032frame-begin %d %s\n"),
 465                      level, paddress (gdbarch, pc));
 466 }
 467
 468 void
 469 annotate_function_call (void)
 470 {
 471   if (annotation_level == 2)
 472     printf_filtered (("\n\032\032function-call\n"));
 473 }
 474
 475 void
 476 annotate_signal_handler_caller (void)
 477 {
 478   if (annotation_level == 2)
 479     printf_filtered (("\n\032\032signal-handler-caller\n"));
 480 }
 481
 482 void
 483 annotate_frame_address (void)
 484 {
 485   if (annotation_level == 2)
 486     printf_filtered (("\n\032\032frame-address\n"));
 487 }
 488
 489 void
 490 annotate_frame_address_end (void)
 491 {
 492   if (annotation_level == 2)
 493     printf_filtered (("\n\032\032frame-address-end\n"));
 494 }
 495
 496 void
 497 annotate_frame_function_name (void)
 498 {
 499   if (annotation_level == 2)
 500     printf_filtered (("\n\032\032frame-function-name\n"));
 501 }
 502
 503 void
 504 annotate_frame_args (void)
 505 {
 506   if (annotation_level == 2)
 507     printf_filtered (("\n\032\032frame-args\n"));
 508 }
 509
 510 void
 511 annotate_frame_source_begin (void)
 512 {
 513   if (annotation_level == 2)
 514     printf_filtered (("\n\032\032frame-source-begin\n"));
 515 }
 516
 517 void
 518 annotate_frame_source_file (void)
 519 {
 520   if (annotation_level == 2)
 521     printf_filtered (("\n\032\032frame-source-file\n"));
 522 }
 523
 524 void
 525 annotate_frame_source_file_end (void)
 526 {
 527   if (annotation_level == 2)
 528     printf_filtered (("\n\032\032frame-source-file-end\n"));
 529 }
 530
 531 void
 532 annotate_frame_source_line (void)
 533 {
 534   if (annotation_level == 2)
 535     printf_filtered (("\n\032\032frame-source-line\n"));
 536 }
 537
 538 void
 539 annotate_frame_source_end (void)
 540 {
 541   if (annotation_level == 2)
 542     printf_filtered (("\n\032\032frame-source-end\n"));
 543 }
 544
 545 void
 546 annotate_frame_where (void)
 547 {
 548   if (annotation_level == 2)
 549     printf_filtered (("\n\032\032frame-where\n"));
 550 }
 551
 552 void
 553 annotate_frame_end (void)
 554 {
 555   if (annotation_level == 2)
 556     printf_filtered (("\n\032\032frame-end\n"));
 557 }
 558 \f
 559 void
 560 annotate_array_section_begin (int idx, struct type *elttype)
 561 {
 562   if (annotation_level == 2)
 563     {
 564       printf_filtered (("\n\032\032array-section-begin %d "), idx);
 565       print_value_flags (elttype);
 566       printf_filtered (("\n"));
 567     }
 568 }
 569
 570 void
 571 annotate_elt_rep (unsigned int repcount)
 572 {
 573   if (annotation_level == 2)
 574     printf_filtered (("\n\032\032elt-rep %u\n"), repcount);
 575 }
 576
 577 void
 578 annotate_elt_rep_end (void)
 579 {
 580   if (annotation_level == 2)
 581     printf_filtered (("\n\032\032elt-rep-end\n"));
 582 }
 583
 584 void
 585 annotate_elt (void)
 586 {
 587   if (annotation_level == 2)
 588     printf_filtered (("\n\032\032elt\n"));
 589 }
 590
 591 void
 592 annotate_array_section_end (void)
 593 {
 594   if (annotation_level == 2)
 595     printf_filtered (("\n\032\032array-section-end\n"));
 596 }
 597
 598 /* Called when GDB is about to display the prompt.  Used to reset
 599    annotation suppression whenever we're ready to accept new
 600    frontend/user commands.  */
 601
 602 void
 603 annotate_display_prompt (void)
 604 {
 605   frames_invalid_emitted = 0;
 606   breakpoints_invalid_emitted = 0;
 607 }
 608
 609 static void
 610 breakpoint_changed (struct breakpoint *b)
 611 {
 612   if (b->number <= 0)
 613     return;
 614
 615   annotate_breakpoints_invalid ();
 616 }
 617
 618 void
 619 _initialize_annotate (void)
 620 {
 621   gdb::observers::breakpoint_created.attach (breakpoint_changed);
 622   gdb::observers::breakpoint_deleted.attach (breakpoint_changed);
 623   gdb::observers::breakpoint_modified.attach (breakpoint_changed);
 624   gdb::observers::thread_exit.attach (annotate_thread_exited);
 625 }