gdb/reverse.c

   1 /* Reverse execution and reverse debugging.
   2
   3    Copyright (C) 2006-2023 Free Software Foundation, Inc.
   4
   5    This file is part of GDB.
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 3 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  19
  20 #include "defs.h"
  21 #include "target.h"
  22 #include "top.h"
  23 #include "cli/cli-cmds.h"
  24 #include "cli/cli-decode.h"
  25 #include "cli/cli-utils.h"
  26 #include "inferior.h"
  27 #include "infrun.h"
  28 #include "regcache.h"
  29
  30 /* User interface:
  31    reverse-step, reverse-next etc.  */
  32
  33 /* exec_reverse_once -- accepts an arbitrary gdb command (string),
  34    and executes it with exec-direction set to 'reverse'.
  35
  36    Used to implement reverse-next etc. commands.  */
  37
  38 static void
  39 exec_reverse_once (const char *cmd, const char *args, int from_tty)
  40 {
  41   enum exec_direction_kind dir = execution_direction;
  42
  43   if (dir == EXEC_REVERSE)
  44     error (_("Already in reverse mode.  Use '%s' or 'set exec-dir forward'."),
  45            cmd);
  46
  47   if (!target_can_execute_reverse ())
  48     error (_("Target %s does not support this command."), target_shortname ());
  49
  50   std::string reverse_command = string_printf ("%s %s", cmd, args ? args : "");
  51   scoped_restore restore_exec_dir
  52     = make_scoped_restore (&execution_direction, EXEC_REVERSE);
  53   execute_command (reverse_command.c_str (), from_tty);
  54 }
  55
  56 static void
  57 reverse_step (const char *args, int from_tty)
  58 {
  59   exec_reverse_once ("step", args, from_tty);
  60 }
  61
  62 static void
  63 reverse_stepi (const char *args, int from_tty)
  64 {
  65   exec_reverse_once ("stepi", args, from_tty);
  66 }
  67
  68 static void
  69 reverse_next (const char *args, int from_tty)
  70 {
  71   exec_reverse_once ("next", args, from_tty);
  72 }
  73
  74 static void
  75 reverse_nexti (const char *args, int from_tty)
  76 {
  77   exec_reverse_once ("nexti", args, from_tty);
  78 }
  79
  80 static void
  81 reverse_continue (const char *args, int from_tty)
  82 {
  83   exec_reverse_once ("continue", args, from_tty);
  84 }
  85
  86 static void
  87 reverse_finish (const char *args, int from_tty)
  88 {
  89   exec_reverse_once ("finish", args, from_tty);
  90 }
  91
  92 /* Data structures for a bookmark list.  */
  93
  94 struct bookmark {
  95   int number = 0;
  96   CORE_ADDR pc = 0;
  97   struct symtab_and_line sal;
  98   gdb::unique_xmalloc_ptr<gdb_byte> opaque_data;
  99 };
 100
 101 static std::vector<struct bookmark> all_bookmarks;
 102 static int bookmark_count;
 103
 104 /* save_bookmark_command -- implement "bookmark" command.
 105    Call target method to get a bookmark identifier.
 106    Insert bookmark identifier into list.
 107
 108    Identifier will be a malloc string (gdb_byte *).
 109    Up to us to free it as required.  */
 110
 111 static void
 112 save_bookmark_command (const char *args, int from_tty)
 113 {
 114   /* Get target's idea of a bookmark.  */
 115   gdb_byte *bookmark_id = target_get_bookmark (args, from_tty);
 116   struct gdbarch *gdbarch = get_current_regcache ()->arch ();
 117
 118   /* CR should not cause another identical bookmark.  */
 119   dont_repeat ();
 120
 121   if (bookmark_id == NULL)
 122     error (_("target_get_bookmark failed."));
 123
 124   /* Set up a bookmark struct.  */
 125   all_bookmarks.emplace_back ();
 126   bookmark &b = all_bookmarks.back ();
 127   b.number = ++bookmark_count;
 128   b.pc = regcache_read_pc (get_current_regcache ());
 129   b.sal = find_pc_line (b.pc, 0);
 130   b.sal.pspace = get_frame_program_space (get_current_frame ());
 131   b.opaque_data.reset (bookmark_id);
 132
 133   gdb_printf (_("Saved bookmark %d at %s\n"), b.number,
 134               paddress (gdbarch, b.sal.pc));
 135 }
 136
 137 /* Implement "delete bookmark" command.  */
 138
 139 static bool
 140 delete_one_bookmark (int num)
 141 {
 142   /* Find bookmark with corresponding number.  */
 143   for (auto iter = all_bookmarks.begin ();
 144        iter != all_bookmarks.end ();
 145        ++iter)
 146     {
 147       if (iter->number == num)
 148         {
 149           all_bookmarks.erase (iter);
 150           return true;
 151         }
 152     }
 153   return false;
 154 }
 155
 156 static void
 157 delete_all_bookmarks ()
 158 {
 159   all_bookmarks.clear ();
 160 }
 161
 162 static void
 163 delete_bookmark_command (const char *args, int from_tty)
 164 {
 165   if (all_bookmarks.empty ())
 166     {
 167       warning (_("No bookmarks."));
 168       return;
 169     }
 170
 171   if (args == NULL || args[0] == '\0')
 172     {
 173       if (from_tty && !query (_("Delete all bookmarks? ")))
 174         return;
 175       delete_all_bookmarks ();
 176       return;
 177     }
 178
 179   number_or_range_parser parser (args);
 180   while (!parser.finished ())
 181     {
 182       int num = parser.get_number ();
 183       if (!delete_one_bookmark (num))
 184         /* Not found.  */
 185         warning (_("No bookmark #%d."), num);
 186     }
 187 }
 188
 189 /* Implement "goto-bookmark" command.  */
 190
 191 static void
 192 goto_bookmark_command (const char *args, int from_tty)
 193 {
 194   unsigned long num;
 195   const char *p = args;
 196
 197   if (args == NULL || args[0] == '\0')
 198     error (_("Command requires an argument."));
 199
 200   if (startswith (args, "start")
 201       || startswith (args, "begin")
 202       || startswith (args, "end"))
 203     {
 204       /* Special case.  Give target opportunity to handle.  */
 205       target_goto_bookmark ((gdb_byte *) args, from_tty);
 206       return;
 207     }
 208
 209   if (args[0] == '\'' || args[0] == '\"')
 210     {
 211       /* Special case -- quoted string.  Pass on to target.  */
 212       if (args[strlen (args) - 1] != args[0])
 213         error (_("Unbalanced quotes: %s"), args);
 214       target_goto_bookmark ((gdb_byte *) args, from_tty);
 215       return;
 216     }
 217
 218   /* General case.  Bookmark identified by bookmark number.  */
 219   num = get_number (&args);
 220
 221   if (num == 0)
 222     error (_("goto-bookmark: invalid bookmark number '%s'."), p);
 223
 224   for (const bookmark &iter : all_bookmarks)
 225     {
 226       if (iter.number == num)
 227         {
 228           /* Found.  Send to target method.  */
 229           target_goto_bookmark (iter.opaque_data.get (), from_tty);
 230           return;
 231         }
 232     }
 233   /* Not found.  */
 234   error (_("goto-bookmark: no bookmark found for '%s'."), p);
 235 }
 236
 237 static int
 238 bookmark_1 (int bnum)
 239 {
 240   struct gdbarch *gdbarch = get_current_regcache ()->arch ();
 241   int matched = 0;
 242
 243   for (const bookmark &iter : all_bookmarks)
 244     {
 245       if (bnum == -1 || bnum == iter.number)
 246         {
 247           gdb_printf ("   %d       %s    '%s'\n",
 248                       iter.number,
 249                       paddress (gdbarch, iter.pc),
 250                       iter.opaque_data.get ());
 251           matched++;
 252         }
 253     }
 254
 255   if (bnum > 0 && matched == 0)
 256     gdb_printf ("No bookmark #%d\n", bnum);
 257
 258   return matched;
 259 }
 260
 261 /* Implement "info bookmarks" command.  */
 262
 263 static void
 264 info_bookmarks_command (const char *args, int from_tty)
 265 {
 266   if (all_bookmarks.empty ())
 267     gdb_printf (_("No bookmarks.\n"));
 268   else if (args == NULL || *args == '\0')
 269     bookmark_1 (-1);
 270   else
 271     {
 272       number_or_range_parser parser (args);
 273       while (!parser.finished ())
 274         {
 275           int bnum = parser.get_number ();
 276           bookmark_1 (bnum);
 277         }
 278     }
 279 }
 280
 281 void _initialize_reverse ();
 282 void
 283 _initialize_reverse ()
 284 {
 285   cmd_list_element *reverse_step_cmd
 286    = add_com ("reverse-step", class_run, reverse_step, _("\
 287 Step program backward until it reaches the beginning of another source line.\n\
 288 Argument N means do this N times (or till program stops for another reason)."));
 289   add_com_alias ("rs", reverse_step_cmd, class_run, 1);
 290
 291   cmd_list_element *reverse_next_cmd
 292     = add_com ("reverse-next", class_run, reverse_next, _("\
 293 Step program backward, proceeding through subroutine calls.\n\
 294 Like the \"reverse-step\" command as long as subroutine calls do not happen;\n\
 295 when they do, the call is treated as one instruction.\n\
 296 Argument N means do this N times (or till program stops for another reason)."));
 297   add_com_alias ("rn", reverse_next_cmd, class_run, 1);
 298
 299   cmd_list_element *reverse_stepi_cmd
 300     = add_com ("reverse-stepi", class_run, reverse_stepi, _("\
 301 Step backward exactly one instruction.\n\
 302 Argument N means do this N times (or till program stops for another reason)."));
 303   add_com_alias ("rsi", reverse_stepi_cmd, class_run, 0);
 304
 305   cmd_list_element *reverse_nexti_cmd
 306     = add_com ("reverse-nexti", class_run, reverse_nexti, _("\
 307 Step backward one instruction, but proceed through called subroutines.\n\
 308 Argument N means do this N times (or till program stops for another reason)."));
 309   add_com_alias ("rni", reverse_nexti_cmd, class_run, 0);
 310
 311   cmd_list_element *reverse_continue_cmd
 312     = add_com ("reverse-continue", class_run, reverse_continue, _("\
 313 Continue program being debugged but run it in reverse.\n\
 314 If proceeding from breakpoint, a number N may be used as an argument,\n\
 315 which means to set the ignore count of that breakpoint to N - 1 (so that\n\
 316 the breakpoint won't break until the Nth time it is reached)."));
 317   add_com_alias ("rc", reverse_continue_cmd, class_run, 0);
 318
 319   add_com ("reverse-finish", class_run, reverse_finish, _("\
 320 Execute backward until just before selected stack frame is called."));
 321
 322   add_com ("bookmark", class_bookmark, save_bookmark_command, _("\
 323 Set a bookmark in the program's execution history.\n\
 324 A bookmark represents a point in the execution history \n\
 325 that can be returned to at a later point in the debug session."));
 326   add_info ("bookmarks", info_bookmarks_command, _("\
 327 Status of user-settable bookmarks.\n\
 328 Bookmarks are user-settable markers representing a point in the \n\
 329 execution history that can be returned to later in the same debug \n\
 330 session."));
 331   add_cmd ("bookmark", class_bookmark, delete_bookmark_command, _("\
 332 Delete a bookmark from the bookmark list.\n\
 333 Argument is a bookmark number or numbers,\n\
 334  or no argument to delete all bookmarks."),
 335            &deletelist);
 336   add_com ("goto-bookmark", class_bookmark, goto_bookmark_command, _("\
 337 Go to an earlier-bookmarked point in the program's execution history.\n\
 338 Argument is the bookmark number of a bookmark saved earlier by using \n\
 339 the 'bookmark' command, or the special arguments:\n\
 340   start (beginning of recording)\n\
 341   end   (end of recording)"));
 342 }