gdb/record-btrace.c

   1 /* Branch trace support for GDB, the GNU debugger.
   2
   3    Copyright (C) 2013-2014 Free Software Foundation, Inc.
   4
   5    Contributed by Intel Corp. <markus.t.metzger@intel.com>
   6
   7    This file is part of GDB.
   8
   9    This program is free software; you can redistribute it and/or modify
  10    it under the terms of the GNU General Public License as published by
  11    the Free Software Foundation; either version 3 of the License, or
  12    (at your option) any later version.
  13
  14    This program is distributed in the hope that it will be useful,
  15    but WITHOUT ANY WARRANTY; without even the implied warranty of
  16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17    GNU General Public License for more details.
  18
  19    You should have received a copy of the GNU General Public License
  20    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  21
  22 #include "defs.h"
  23 #include "record.h"
  24 #include "gdbthread.h"
  25 #include "target.h"
  26 #include "gdbcmd.h"
  27 #include "disasm.h"
  28 #include "observer.h"
  29 #include "exceptions.h"
  30 #include "cli/cli-utils.h"
  31 #include "source.h"
  32 #include "ui-out.h"
  33 #include "symtab.h"
  34 #include "filenames.h"
  35
  36 /* The target_ops of record-btrace.  */
  37 static struct target_ops record_btrace_ops;
  38
  39 /* A new thread observer enabling branch tracing for the new thread.  */
  40 static struct observer *record_btrace_thread_observer;
  41
  42 /* Print a record-btrace debug message.  Use do ... while (0) to avoid
  43    ambiguities when used in if statements.  */
  44
  45 #define DEBUG(msg, args...)                                             \
  46   do                                                                    \
  47     {                                                                   \
  48       if (record_debug != 0)                                            \
  49         fprintf_unfiltered (gdb_stdlog,                                 \
  50                             "[record-btrace] " msg "\n", ##args);       \
  51     }                                                                   \
  52   while (0)
  53
  54
  55 /* Update the branch trace for the current thread and return a pointer to its
  56    branch trace information struct.
  57
  58    Throws an error if there is no thread or no trace.  This function never
  59    returns NULL.  */
  60
  61 static struct btrace_thread_info *
  62 require_btrace (void)
  63 {
  64   struct thread_info *tp;
  65   struct btrace_thread_info *btinfo;
  66
  67   DEBUG ("require");
  68
  69   tp = find_thread_ptid (inferior_ptid);
  70   if (tp == NULL)
  71     error (_("No thread."));
  72
  73   btrace_fetch (tp);
  74
  75   btinfo = &tp->btrace;
  76
  77   if (btinfo->begin == NULL)
  78     error (_("No trace."));
  79
  80   return btinfo;
  81 }
  82
  83 /* Enable branch tracing for one thread.  Warn on errors.  */
  84
  85 static void
  86 record_btrace_enable_warn (struct thread_info *tp)
  87 {
  88   volatile struct gdb_exception error;
  89
  90   TRY_CATCH (error, RETURN_MASK_ERROR)
  91     btrace_enable (tp);
  92
  93   if (error.message != NULL)
  94     warning ("%s", error.message);
  95 }
  96
  97 /* Callback function to disable branch tracing for one thread.  */
  98
  99 static void
 100 record_btrace_disable_callback (void *arg)
 101 {
 102   struct thread_info *tp;
 103
 104   tp = arg;
 105
 106   btrace_disable (tp);
 107 }
 108
 109 /* Enable automatic tracing of new threads.  */
 110
 111 static void
 112 record_btrace_auto_enable (void)
 113 {
 114   DEBUG ("attach thread observer");
 115
 116   record_btrace_thread_observer
 117     = observer_attach_new_thread (record_btrace_enable_warn);
 118 }
 119
 120 /* Disable automatic tracing of new threads.  */
 121
 122 static void
 123 record_btrace_auto_disable (void)
 124 {
 125   /* The observer may have been detached, already.  */
 126   if (record_btrace_thread_observer == NULL)
 127     return;
 128
 129   DEBUG ("detach thread observer");
 130
 131   observer_detach_new_thread (record_btrace_thread_observer);
 132   record_btrace_thread_observer = NULL;
 133 }
 134
 135 /* The to_open method of target record-btrace.  */
 136
 137 static void
 138 record_btrace_open (char *args, int from_tty)
 139 {
 140   struct cleanup *disable_chain;
 141   struct thread_info *tp;
 142
 143   DEBUG ("open");
 144
 145   record_preopen ();
 146
 147   if (!target_has_execution)
 148     error (_("The program is not being run."));
 149
 150   if (!target_supports_btrace ())
 151     error (_("Target does not support branch tracing."));
 152
 153   gdb_assert (record_btrace_thread_observer == NULL);
 154
 155   disable_chain = make_cleanup (null_cleanup, NULL);
 156   ALL_THREADS (tp)
 157     if (args == NULL || *args == 0 || number_is_in_list (args, tp->num))
 158       {
 159         btrace_enable (tp);
 160
 161         make_cleanup (record_btrace_disable_callback, tp);
 162       }
 163
 164   record_btrace_auto_enable ();
 165
 166   push_target (&record_btrace_ops);
 167
 168   observer_notify_record_changed (current_inferior (),  1);
 169
 170   discard_cleanups (disable_chain);
 171 }
 172
 173 /* The to_stop_recording method of target record-btrace.  */
 174
 175 static void
 176 record_btrace_stop_recording (void)
 177 {
 178   struct thread_info *tp;
 179
 180   DEBUG ("stop recording");
 181
 182   record_btrace_auto_disable ();
 183
 184   ALL_THREADS (tp)
 185     if (tp->btrace.target != NULL)
 186       btrace_disable (tp);
 187 }
 188
 189 /* The to_close method of target record-btrace.  */
 190
 191 static void
 192 record_btrace_close (void)
 193 {
 194   /* Make sure automatic recording gets disabled even if we did not stop
 195      recording before closing the record-btrace target.  */
 196   record_btrace_auto_disable ();
 197
 198   /* We already stopped recording.  */
 199 }
 200
 201 /* The to_info_record method of target record-btrace.  */
 202
 203 static void
 204 record_btrace_info (void)
 205 {
 206   struct btrace_thread_info *btinfo;
 207   struct thread_info *tp;
 208   unsigned int insns, calls;
 209
 210   DEBUG ("info");
 211
 212   tp = find_thread_ptid (inferior_ptid);
 213   if (tp == NULL)
 214     error (_("No thread."));
 215
 216   btrace_fetch (tp);
 217
 218   insns = 0;
 219   calls = 0;
 220
 221   btinfo = &tp->btrace;
 222   if (btinfo->begin != NULL)
 223     {
 224       struct btrace_call_iterator call;
 225       struct btrace_insn_iterator insn;
 226
 227       btrace_call_end (&call, btinfo);
 228       btrace_call_prev (&call, 1);
 229       calls = btrace_call_number (&call) + 1;
 230
 231       btrace_insn_end (&insn, btinfo);
 232       btrace_insn_prev (&insn, 1);
 233       insns = btrace_insn_number (&insn) + 1;
 234     }
 235
 236   printf_unfiltered (_("Recorded %u instructions in %u functions for thread "
 237                        "%d (%s).\n"), insns, calls, tp->num,
 238                      target_pid_to_str (tp->ptid));
 239 }
 240
 241 /* Print an unsigned int.  */
 242
 243 static void
 244 ui_out_field_uint (struct ui_out *uiout, const char *fld, unsigned int val)
 245 {
 246   ui_out_field_fmt (uiout, fld, "%u", val);
 247 }
 248
 249 /* Disassemble a section of the recorded instruction trace.  */
 250
 251 static void
 252 btrace_insn_history (struct ui_out *uiout,
 253                      const struct btrace_insn_iterator *begin,
 254                      const struct btrace_insn_iterator *end, int flags)
 255 {
 256   struct gdbarch *gdbarch;
 257   struct btrace_insn_iterator it;
 258
 259   DEBUG ("itrace (0x%x): [%u; %u)", flags, btrace_insn_number (begin),
 260          btrace_insn_number (end));
 261
 262   gdbarch = target_gdbarch ();
 263
 264   for (it = *begin; btrace_insn_cmp (&it, end) != 0; btrace_insn_next (&it, 1))
 265     {
 266       const struct btrace_insn *insn;
 267
 268       insn = btrace_insn_get (&it);
 269
 270       /* Print the instruction index.  */
 271       ui_out_field_uint (uiout, "index", btrace_insn_number (&it));
 272       ui_out_text (uiout, "\t");
 273
 274       /* Disassembly with '/m' flag may not produce the expected result.
 275          See PR gdb/11833.  */
 276       gdb_disassembly (gdbarch, uiout, NULL, flags, 1, insn->pc, insn->pc + 1);
 277     }
 278 }
 279
 280 /* The to_insn_history method of target record-btrace.  */
 281
 282 static void
 283 record_btrace_insn_history (int size, int flags)
 284 {
 285   struct btrace_thread_info *btinfo;
 286   struct btrace_insn_history *history;
 287   struct btrace_insn_iterator begin, end;
 288   struct cleanup *uiout_cleanup;
 289   struct ui_out *uiout;
 290   unsigned int context, covered;
 291
 292   uiout = current_uiout;
 293   uiout_cleanup = make_cleanup_ui_out_tuple_begin_end (uiout,
 294                                                        "insn history");
 295   context = abs (size);
 296   if (context == 0)
 297     error (_("Bad record instruction-history-size."));
 298
 299   btinfo = require_btrace ();
 300   history = btinfo->insn_history;
 301   if (history == NULL)
 302     {
 303       /* No matter the direction, we start with the tail of the trace.  */
 304       btrace_insn_end (&begin, btinfo);
 305       end = begin;
 306
 307       DEBUG ("insn-history (0x%x): %d", flags, size);
 308
 309       covered = btrace_insn_prev (&begin, context);
 310     }
 311   else
 312     {
 313       begin = history->begin;
 314       end = history->end;
 315
 316       DEBUG ("insn-history (0x%x): %d, prev: [%u; %u)", flags, size,
 317              btrace_insn_number (&begin), btrace_insn_number (&end));
 318
 319       if (size < 0)
 320         {
 321           end = begin;
 322           covered = btrace_insn_prev (&begin, context);
 323         }
 324       else
 325         {
 326           begin = end;
 327           covered = btrace_insn_next (&end, context);
 328         }
 329     }
 330
 331   if (covered > 0)
 332     btrace_insn_history (uiout, &begin, &end, flags);
 333   else
 334     {
 335       if (size < 0)
 336         printf_unfiltered (_("At the start of the branch trace record.\n"));
 337       else
 338         printf_unfiltered (_("At the end of the branch trace record.\n"));
 339     }
 340
 341   btrace_set_insn_history (btinfo, &begin, &end);
 342   do_cleanups (uiout_cleanup);
 343 }
 344
 345 /* The to_insn_history_range method of target record-btrace.  */
 346
 347 static void
 348 record_btrace_insn_history_range (ULONGEST from, ULONGEST to, int flags)
 349 {
 350   struct btrace_thread_info *btinfo;
 351   struct btrace_insn_history *history;
 352   struct btrace_insn_iterator begin, end;
 353   struct cleanup *uiout_cleanup;
 354   struct ui_out *uiout;
 355   unsigned int low, high;
 356   int found;
 357
 358   uiout = current_uiout;
 359   uiout_cleanup = make_cleanup_ui_out_tuple_begin_end (uiout,
 360                                                        "insn history");
 361   low = from;
 362   high = to;
 363
 364   DEBUG ("insn-history (0x%x): [%u; %u)", flags, low, high);
 365
 366   /* Check for wrap-arounds.  */
 367   if (low != from || high != to)
 368     error (_("Bad range."));
 369
 370   if (high <= low)
 371     error (_("Bad range."));
 372
 373   btinfo = require_btrace ();
 374
 375   found = btrace_find_insn_by_number (&begin, btinfo, low);
 376   if (found == 0)
 377     error (_("Range out of bounds."));
 378
 379   /* Silently truncate the range, if necessary.  */
 380   found = btrace_find_insn_by_number (&end, btinfo, high);
 381   if (found == 0)
 382     btrace_insn_end (&end, btinfo);
 383
 384   btrace_insn_history (uiout, &begin, &end, flags);
 385   btrace_set_insn_history (btinfo, &begin, &end);
 386
 387   do_cleanups (uiout_cleanup);
 388 }
 389
 390 /* The to_insn_history_from method of target record-btrace.  */
 391
 392 static void
 393 record_btrace_insn_history_from (ULONGEST from, int size, int flags)
 394 {
 395   ULONGEST begin, end, context;
 396
 397   context = abs (size);
 398
 399   if (size < 0)
 400     {
 401       end = from;
 402
 403       if (from < context)
 404         begin = 0;
 405       else
 406         begin = from - context;
 407     }
 408   else
 409     {
 410       begin = from;
 411       end = from + context;
 412
 413       /* Check for wrap-around.  */
 414       if (end < begin)
 415         end = ULONGEST_MAX;
 416     }
 417
 418   record_btrace_insn_history_range (begin, end, flags);
 419 }
 420
 421 /* Print the instruction number range for a function call history line.  */
 422
 423 static void
 424 btrace_call_history_insn_range (struct ui_out *uiout,
 425                                 const struct btrace_function *bfun)
 426 {
 427   unsigned int begin, end, size;
 428
 429   size = VEC_length (btrace_insn_s, bfun->insn);
 430   gdb_assert (size > 0);
 431
 432   begin = bfun->insn_offset;
 433   end = begin + size - 1;
 434
 435   ui_out_field_uint (uiout, "insn begin", begin);
 436   ui_out_text (uiout, "-");
 437   ui_out_field_uint (uiout, "insn end", end);
 438 }
 439
 440 /* Print the source line information for a function call history line.  */
 441
 442 static void
 443 btrace_call_history_src_line (struct ui_out *uiout,
 444                               const struct btrace_function *bfun)
 445 {
 446   struct symbol *sym;
 447   int begin, end;
 448
 449   sym = bfun->sym;
 450   if (sym == NULL)
 451     return;
 452
 453   ui_out_field_string (uiout, "file",
 454                        symtab_to_filename_for_display (sym->symtab));
 455
 456   begin = bfun->lbegin;
 457   end = bfun->lend;
 458
 459   if (end < begin)
 460     return;
 461
 462   ui_out_text (uiout, ":");
 463   ui_out_field_int (uiout, "min line", begin);
 464
 465   if (end == begin)
 466     return;
 467
 468   ui_out_text (uiout, "-");
 469   ui_out_field_int (uiout, "max line", end);
 470 }
 471
 472 /* Disassemble a section of the recorded function trace.  */
 473
 474 static void
 475 btrace_call_history (struct ui_out *uiout,
 476                      const struct btrace_call_iterator *begin,
 477                      const struct btrace_call_iterator *end,
 478                      enum record_print_flag flags)
 479 {
 480   struct btrace_call_iterator it;
 481
 482   DEBUG ("ftrace (0x%x): [%u; %u)", flags, btrace_call_number (begin),
 483          btrace_call_number (end));
 484
 485   for (it = *begin; btrace_call_cmp (&it, end) < 0; btrace_call_next (&it, 1))
 486     {
 487       const struct btrace_function *bfun;
 488       struct minimal_symbol *msym;
 489       struct symbol *sym;
 490
 491       bfun = btrace_call_get (&it);
 492       msym = bfun->msym;
 493       sym = bfun->sym;
 494
 495       /* Print the function index.  */
 496       ui_out_field_uint (uiout, "index", bfun->number);
 497       ui_out_text (uiout, "\t");
 498
 499       if ((flags & RECORD_PRINT_INSN_RANGE) != 0)
 500         {
 501           btrace_call_history_insn_range (uiout, bfun);
 502           ui_out_text (uiout, "\t");
 503         }
 504
 505       if ((flags & RECORD_PRINT_SRC_LINE) != 0)
 506         {
 507           btrace_call_history_src_line (uiout, bfun);
 508           ui_out_text (uiout, "\t");
 509         }
 510
 511       if (sym != NULL)
 512         ui_out_field_string (uiout, "function", SYMBOL_PRINT_NAME (sym));
 513       else if (msym != NULL)
 514         ui_out_field_string (uiout, "function", SYMBOL_PRINT_NAME (msym));
 515
 516       ui_out_text (uiout, "\n");
 517     }
 518 }
 519
 520 /* The to_call_history method of target record-btrace.  */
 521
 522 static void
 523 record_btrace_call_history (int size, int flags)
 524 {
 525   struct btrace_thread_info *btinfo;
 526   struct btrace_call_history *history;
 527   struct btrace_call_iterator begin, end;
 528   struct cleanup *uiout_cleanup;
 529   struct ui_out *uiout;
 530   unsigned int context, covered;
 531
 532   uiout = current_uiout;
 533   uiout_cleanup = make_cleanup_ui_out_tuple_begin_end (uiout,
 534                                                        "insn history");
 535   context = abs (size);
 536   if (context == 0)
 537     error (_("Bad record function-call-history-size."));
 538
 539   btinfo = require_btrace ();
 540   history = btinfo->call_history;
 541   if (history == NULL)
 542     {
 543       /* No matter the direction, we start with the tail of the trace.  */
 544       btrace_call_end (&begin, btinfo);
 545       end = begin;
 546
 547       DEBUG ("call-history (0x%x): %d", flags, size);
 548
 549       covered = btrace_call_prev (&begin, context);
 550     }
 551   else
 552     {
 553       begin = history->begin;
 554       end = history->end;
 555
 556       DEBUG ("call-history (0x%x): %d, prev: [%u; %u)", flags, size,
 557              btrace_call_number (&begin), btrace_call_number (&end));
 558
 559       if (size < 0)
 560         {
 561           end = begin;
 562           covered = btrace_call_prev (&begin, context);
 563         }
 564       else
 565         {
 566           begin = end;
 567           covered = btrace_call_next (&end, context);
 568         }
 569     }
 570
 571   if (covered > 0)
 572     btrace_call_history (uiout, &begin, &end, flags);
 573   else
 574     {
 575       if (size < 0)
 576         printf_unfiltered (_("At the start of the branch trace record.\n"));
 577       else
 578         printf_unfiltered (_("At the end of the branch trace record.\n"));
 579     }
 580
 581   btrace_set_call_history (btinfo, &begin, &end);
 582   do_cleanups (uiout_cleanup);
 583 }
 584
 585 /* The to_call_history_range method of target record-btrace.  */
 586
 587 static void
 588 record_btrace_call_history_range (ULONGEST from, ULONGEST to, int flags)
 589 {
 590   struct btrace_thread_info *btinfo;
 591   struct btrace_call_history *history;
 592   struct btrace_call_iterator begin, end;
 593   struct cleanup *uiout_cleanup;
 594   struct ui_out *uiout;
 595   unsigned int low, high;
 596   int found;
 597
 598   uiout = current_uiout;
 599   uiout_cleanup = make_cleanup_ui_out_tuple_begin_end (uiout,
 600                                                        "func history");
 601   low = from;
 602   high = to;
 603
 604   DEBUG ("call-history (0x%x): [%u; %u)", flags, low, high);
 605
 606   /* Check for wrap-arounds.  */
 607   if (low != from || high != to)
 608     error (_("Bad range."));
 609
 610   if (high <= low)
 611     error (_("Bad range."));
 612
 613   btinfo = require_btrace ();
 614
 615   found = btrace_find_call_by_number (&begin, btinfo, low);
 616   if (found == 0)
 617     error (_("Range out of bounds."));
 618
 619   /* Silently truncate the range, if necessary.  */
 620   found = btrace_find_call_by_number (&end, btinfo, high);
 621   if (found == 0)
 622     btrace_call_end (&end, btinfo);
 623
 624   btrace_call_history (uiout, &begin, &end, flags);
 625   btrace_set_call_history (btinfo, &begin, &end);
 626
 627   do_cleanups (uiout_cleanup);
 628 }
 629
 630 /* The to_call_history_from method of target record-btrace.  */
 631
 632 static void
 633 record_btrace_call_history_from (ULONGEST from, int size, int flags)
 634 {
 635   ULONGEST begin, end, context;
 636
 637   context = abs (size);
 638
 639   if (size < 0)
 640     {
 641       end = from;
 642
 643       if (from < context)
 644         begin = 0;
 645       else
 646         begin = from - context;
 647     }
 648   else
 649     {
 650       begin = from;
 651       end = from + context;
 652
 653       /* Check for wrap-around.  */
 654       if (end < begin)
 655         end = ULONGEST_MAX;
 656     }
 657
 658   record_btrace_call_history_range (begin, end, flags);
 659 }
 660
 661 /* Initialize the record-btrace target ops.  */
 662
 663 static void
 664 init_record_btrace_ops (void)
 665 {
 666   struct target_ops *ops;
 667
 668   ops = &record_btrace_ops;
 669   ops->to_shortname = "record-btrace";
 670   ops->to_longname = "Branch tracing target";
 671   ops->to_doc = "Collect control-flow trace and provide the execution history.";
 672   ops->to_open = record_btrace_open;
 673   ops->to_close = record_btrace_close;
 674   ops->to_detach = record_detach;
 675   ops->to_disconnect = record_disconnect;
 676   ops->to_mourn_inferior = record_mourn_inferior;
 677   ops->to_kill = record_kill;
 678   ops->to_create_inferior = find_default_create_inferior;
 679   ops->to_stop_recording = record_btrace_stop_recording;
 680   ops->to_info_record = record_btrace_info;
 681   ops->to_insn_history = record_btrace_insn_history;
 682   ops->to_insn_history_from = record_btrace_insn_history_from;
 683   ops->to_insn_history_range = record_btrace_insn_history_range;
 684   ops->to_call_history = record_btrace_call_history;
 685   ops->to_call_history_from = record_btrace_call_history_from;
 686   ops->to_call_history_range = record_btrace_call_history_range;
 687   ops->to_stratum = record_stratum;
 688   ops->to_magic = OPS_MAGIC;
 689 }
 690
 691 /* Alias for "target record".  */
 692
 693 static void
 694 cmd_record_btrace_start (char *args, int from_tty)
 695 {
 696   if (args != NULL && *args != 0)
 697     error (_("Invalid argument."));
 698
 699   execute_command ("target record-btrace", from_tty);
 700 }
 701
 702 void _initialize_record_btrace (void);
 703
 704 /* Initialize btrace commands.  */
 705
 706 void
 707 _initialize_record_btrace (void)
 708 {
 709   add_cmd ("btrace", class_obscure, cmd_record_btrace_start,
 710            _("Start branch trace recording."),
 711            &record_cmdlist);
 712   add_alias_cmd ("b", "btrace", class_obscure, 1, &record_cmdlist);
 713
 714   init_record_btrace_ops ();
 715   add_target (&record_btrace_ops);
 716 }