1 /* Reverse execution and reverse debugging.
3 Copyright (C) 2006-2024 Free Software Foundation, Inc.
5 This file is part of GDB.
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.
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.
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/>. */
23 #include "cli/cli-cmds.h"
24 #include "cli/cli-decode.h"
25 #include "cli/cli-utils.h"
31 reverse-step, reverse-next etc. */
33 /* exec_reverse_once -- accepts an arbitrary gdb command (string),
34 and executes it with exec-direction set to 'reverse'.
36 Used to implement reverse-next etc. commands. */
39 exec_reverse_once (const char *cmd
, const char *args
, int from_tty
)
41 enum exec_direction_kind dir
= execution_direction
;
43 if (dir
== EXEC_REVERSE
)
44 error (_("Already in reverse mode. Use '%s' or 'set exec-dir forward'."),
47 if (!target_can_execute_reverse ())
48 error (_("Target %s does not support this command."), target_shortname ());
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
);
57 reverse_step (const char *args
, int from_tty
)
59 exec_reverse_once ("step", args
, from_tty
);
63 reverse_stepi (const char *args
, int from_tty
)
65 exec_reverse_once ("stepi", args
, from_tty
);
69 reverse_next (const char *args
, int from_tty
)
71 exec_reverse_once ("next", args
, from_tty
);
75 reverse_nexti (const char *args
, int from_tty
)
77 exec_reverse_once ("nexti", args
, from_tty
);
81 reverse_continue (const char *args
, int from_tty
)
83 exec_reverse_once ("continue", args
, from_tty
);
87 reverse_finish (const char *args
, int from_tty
)
89 exec_reverse_once ("finish", args
, from_tty
);
92 /* Data structures for a bookmark list. */
97 struct symtab_and_line sal
;
98 gdb::unique_xmalloc_ptr
<gdb_byte
> opaque_data
;
101 static std::vector
<struct bookmark
> all_bookmarks
;
102 static int bookmark_count
;
104 /* save_bookmark_command -- implement "bookmark" command.
105 Call target method to get a bookmark identifier.
106 Insert bookmark identifier into list.
108 Identifier will be a malloc string (gdb_byte *).
109 Up to us to free it as required. */
112 save_bookmark_command (const char *args
, int from_tty
)
114 /* Get target's idea of a bookmark. */
115 gdb_byte
*bookmark_id
= target_get_bookmark (args
, from_tty
);
116 regcache
*regcache
= get_thread_regcache (inferior_thread ());
117 gdbarch
*gdbarch
= regcache
->arch ();
119 /* CR should not cause another identical bookmark. */
122 if (bookmark_id
== NULL
)
123 error (_("target_get_bookmark failed."));
125 /* Set up a bookmark struct. */
126 all_bookmarks
.emplace_back ();
127 bookmark
&b
= all_bookmarks
.back ();
128 b
.number
= ++bookmark_count
;
129 b
.pc
= regcache_read_pc (regcache
);
130 b
.sal
= find_pc_line (b
.pc
, 0);
131 b
.sal
.pspace
= get_frame_program_space (get_current_frame ());
132 b
.opaque_data
.reset (bookmark_id
);
134 gdb_printf (_("Saved bookmark %d at %s\n"), b
.number
,
135 paddress (gdbarch
, b
.sal
.pc
));
138 /* Implement "delete bookmark" command. */
141 delete_one_bookmark (int num
)
143 /* Find bookmark with corresponding number. */
144 for (auto iter
= all_bookmarks
.begin ();
145 iter
!= all_bookmarks
.end ();
148 if (iter
->number
== num
)
150 all_bookmarks
.erase (iter
);
158 delete_all_bookmarks ()
160 all_bookmarks
.clear ();
164 delete_bookmark_command (const char *args
, int from_tty
)
166 if (all_bookmarks
.empty ())
168 warning (_("No bookmarks."));
172 if (args
== NULL
|| args
[0] == '\0')
174 if (from_tty
&& !query (_("Delete all bookmarks? ")))
176 delete_all_bookmarks ();
180 number_or_range_parser
parser (args
);
181 while (!parser
.finished ())
183 int num
= parser
.get_number ();
184 if (!delete_one_bookmark (num
))
186 warning (_("No bookmark #%d."), num
);
190 /* Implement "goto-bookmark" command. */
193 goto_bookmark_command (const char *args
, int from_tty
)
196 const char *p
= args
;
198 if (args
== NULL
|| args
[0] == '\0')
199 error (_("Command requires an argument."));
201 if (startswith (args
, "start")
202 || startswith (args
, "begin")
203 || startswith (args
, "end"))
205 /* Special case. Give target opportunity to handle. */
206 target_goto_bookmark ((gdb_byte
*) args
, from_tty
);
210 if (args
[0] == '\'' || args
[0] == '\"')
212 /* Special case -- quoted string. Pass on to target. */
213 if (args
[strlen (args
) - 1] != args
[0])
214 error (_("Unbalanced quotes: %s"), args
);
215 target_goto_bookmark ((gdb_byte
*) args
, from_tty
);
219 /* General case. Bookmark identified by bookmark number. */
220 num
= get_number (&args
);
223 error (_("goto-bookmark: invalid bookmark number '%s'."), p
);
225 for (const bookmark
&iter
: all_bookmarks
)
227 if (iter
.number
== num
)
229 /* Found. Send to target method. */
230 target_goto_bookmark (iter
.opaque_data
.get (), from_tty
);
235 error (_("goto-bookmark: no bookmark found for '%s'."), p
);
239 bookmark_1 (int bnum
)
241 gdbarch
*gdbarch
= get_thread_regcache (inferior_thread ())->arch ();
244 for (const bookmark
&iter
: all_bookmarks
)
246 if (bnum
== -1 || bnum
== iter
.number
)
248 gdb_printf (" %d %s '%s'\n",
250 paddress (gdbarch
, iter
.pc
),
251 iter
.opaque_data
.get ());
256 if (bnum
> 0 && matched
== 0)
257 gdb_printf ("No bookmark #%d\n", bnum
);
262 /* Implement "info bookmarks" command. */
265 info_bookmarks_command (const char *args
, int from_tty
)
267 if (all_bookmarks
.empty ())
268 gdb_printf (_("No bookmarks.\n"));
269 else if (args
== NULL
|| *args
== '\0')
273 number_or_range_parser
parser (args
);
274 while (!parser
.finished ())
276 int bnum
= parser
.get_number ();
282 void _initialize_reverse ();
284 _initialize_reverse ()
286 cmd_list_element
*reverse_step_cmd
287 = add_com ("reverse-step", class_run
, reverse_step
, _("\
288 Step program backward until it reaches the beginning of another source line.\n\
289 Argument N means do this N times (or till program stops for another reason)."));
290 add_com_alias ("rs", reverse_step_cmd
, class_run
, 1);
292 cmd_list_element
*reverse_next_cmd
293 = add_com ("reverse-next", class_run
, reverse_next
, _("\
294 Step program backward, proceeding through subroutine calls.\n\
295 Like the \"reverse-step\" command as long as subroutine calls do not happen;\n\
296 when they do, the call is treated as one instruction.\n\
297 Argument N means do this N times (or till program stops for another reason)."));
298 add_com_alias ("rn", reverse_next_cmd
, class_run
, 1);
300 cmd_list_element
*reverse_stepi_cmd
301 = add_com ("reverse-stepi", class_run
, reverse_stepi
, _("\
302 Step backward exactly one instruction.\n\
303 Argument N means do this N times (or till program stops for another reason)."));
304 add_com_alias ("rsi", reverse_stepi_cmd
, class_run
, 0);
306 cmd_list_element
*reverse_nexti_cmd
307 = add_com ("reverse-nexti", class_run
, reverse_nexti
, _("\
308 Step backward one instruction, but proceed through called subroutines.\n\
309 Argument N means do this N times (or till program stops for another reason)."));
310 add_com_alias ("rni", reverse_nexti_cmd
, class_run
, 0);
312 cmd_list_element
*reverse_continue_cmd
313 = add_com ("reverse-continue", class_run
, reverse_continue
, _("\
314 Continue program being debugged but run it in reverse.\n\
315 If proceeding from breakpoint, a number N may be used as an argument,\n\
316 which means to set the ignore count of that breakpoint to N - 1 (so that\n\
317 the breakpoint won't break until the Nth time it is reached)."));
318 add_com_alias ("rc", reverse_continue_cmd
, class_run
, 0);
320 add_com ("reverse-finish", class_run
, reverse_finish
, _("\
321 Execute backward until just before selected stack frame is called."));
323 add_com ("bookmark", class_bookmark
, save_bookmark_command
, _("\
324 Set a bookmark in the program's execution history.\n\
325 A bookmark represents a point in the execution history \n\
326 that can be returned to at a later point in the debug session."));
327 add_info ("bookmarks", info_bookmarks_command
, _("\
328 Status of user-settable bookmarks.\n\
329 Bookmarks are user-settable markers representing a point in the \n\
330 execution history that can be returned to later in the same debug \n\
332 add_cmd ("bookmark", class_bookmark
, delete_bookmark_command
, _("\
333 Delete a bookmark from the bookmark list.\n\
334 Argument is a bookmark number or numbers,\n\
335 or no argument to delete all bookmarks."),
337 add_com ("goto-bookmark", class_bookmark
, goto_bookmark_command
, _("\
338 Go to an earlier-bookmarked point in the program's execution history.\n\
339 Argument is the bookmark number of a bookmark saved earlier by using \n\
340 the 'bookmark' command, or the special arguments:\n\
341 start (beginning of recording)\n\
342 end (end of recording)"));