1 /* Reverse execution and reverse debugging.
3 Copyright (C) 2006-2012 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/>. */
21 #include "gdb_string.h"
24 #include "cli/cli-cmds.h"
25 #include "cli/cli-decode.h"
26 #include "cli/cli-utils.h"
31 reverse-step, reverse-next etc. */
34 exec_direction_default (void *notused)
36 /* Return execution direction to default state. */
37 execution_direction = EXEC_FORWARD;
40 /* exec_reverse_once -- accepts an arbitrary gdb command (string),
41 and executes it with exec-direction set to 'reverse'.
43 Used to implement reverse-next etc. commands. */
46 exec_reverse_once (char *cmd, char *args, int from_tty)
48 char *reverse_command;
49 enum exec_direction_kind dir = execution_direction;
50 struct cleanup *old_chain;
52 if (dir == EXEC_REVERSE)
53 error (_("Already in reverse mode. Use '%s' or 'set exec-dir forward'."),
56 if (!target_can_execute_reverse)
57 error (_("Target %s does not support this command."), target_shortname);
59 reverse_command = xstrprintf ("%s %s", cmd, args ? args : "");
60 old_chain = make_cleanup (exec_direction_default, NULL);
61 make_cleanup (xfree, reverse_command);
62 execution_direction = EXEC_REVERSE;
63 execute_command (reverse_command, from_tty);
64 do_cleanups (old_chain);
68 reverse_step (char *args, int from_tty)
70 exec_reverse_once ("step", args, from_tty);
74 reverse_stepi (char *args, int from_tty)
76 exec_reverse_once ("stepi", args, from_tty);
80 reverse_next (char *args, int from_tty)
82 exec_reverse_once ("next", args, from_tty);
86 reverse_nexti (char *args, int from_tty)
88 exec_reverse_once ("nexti", args, from_tty);
92 reverse_continue (char *args, int from_tty)
94 exec_reverse_once ("continue", args, from_tty);
98 reverse_finish (char *args, int from_tty)
100 exec_reverse_once ("finish", args, from_tty);
103 /* Data structures for a bookmark list. */
106 struct bookmark *next;
109 struct symtab_and_line sal;
110 gdb_byte *opaque_data;
113 static struct bookmark *bookmark_chain;
114 static int bookmark_count;
116 #define ALL_BOOKMARKS(B) for ((B) = bookmark_chain; (B); (B) = (B)->next)
118 #define ALL_BOOKMARKS_SAFE(B,TMP) \
119 for ((B) = bookmark_chain; \
120 (B) ? ((TMP) = (B)->next, 1) : 0; \
123 /* save_bookmark_command -- implement "bookmark" command.
124 Call target method to get a bookmark identifier.
125 Insert bookmark identifier into list.
127 Identifier will be a malloc string (gdb_byte *).
128 Up to us to free it as required. */
131 save_bookmark_command (char *args, int from_tty)
133 /* Get target's idea of a bookmark. */
134 gdb_byte *bookmark_id = target_get_bookmark (args, from_tty);
135 struct bookmark *b, *b1;
136 struct gdbarch *gdbarch = get_regcache_arch (get_current_regcache ());
138 /* CR should not cause another identical bookmark. */
141 if (bookmark_id == NULL)
142 error (_("target_get_bookmark failed."));
144 /* Set up a bookmark struct. */
145 b = xcalloc (1, sizeof (struct bookmark));
146 b->number = ++bookmark_count;
148 b->pc = regcache_read_pc (get_current_regcache ());
149 b->sal = find_pc_line (b->pc, 0);
150 b->sal.pspace = get_frame_program_space (get_current_frame ());
151 b->opaque_data = bookmark_id;
154 /* Add this bookmark to the end of the chain, so that a list
155 of bookmarks will come out in order of increasing numbers. */
166 printf_filtered (_("Saved bookmark %d at %s\n"), b->number,
167 paddress (gdbarch, b->sal.pc));
170 /* Implement "delete bookmark" command. */
173 delete_one_bookmark (int num)
175 struct bookmark *b1, *b;
177 /* Find bookmark with corresponding number. */
179 if (b->number == num)
182 /* Special case, first item in list. */
183 if (b == bookmark_chain)
184 bookmark_chain = b->next;
186 /* Find bookmark preceding "marked" one, so we can unlink. */
192 /* Found designated bookmark. Unlink and delete. */
196 xfree (b->opaque_data);
198 return 1; /* success */
200 return 0; /* failure */
204 delete_all_bookmarks (void)
206 struct bookmark *b, *b1;
208 ALL_BOOKMARKS_SAFE (b, b1)
210 xfree (b->opaque_data);
213 bookmark_chain = NULL;
217 delete_bookmark_command (char *args, int from_tty)
221 struct get_number_or_range_state state;
223 if (bookmark_chain == NULL)
225 warning (_("No bookmarks."));
229 if (args == NULL || args[0] == '\0')
231 if (from_tty && !query (_("Delete all bookmarks? ")))
233 delete_all_bookmarks ();
237 init_number_or_range (&state, args);
238 while (!state.finished)
240 num = get_number_or_range (&state);
241 if (!delete_one_bookmark (num))
243 warning (_("No bookmark #%d."), num);
247 /* Implement "goto-bookmark" command. */
250 goto_bookmark_command (char *args, int from_tty)
255 if (args == NULL || args[0] == '\0')
256 error (_("Command requires an argument."));
258 if (strncmp (args, "start", strlen ("start")) == 0
259 || strncmp (args, "begin", strlen ("begin")) == 0
260 || strncmp (args, "end", strlen ("end")) == 0)
262 /* Special case. Give target opportunity to handle. */
263 target_goto_bookmark (args, from_tty);
267 if (args[0] == '\'' || args[0] == '\"')
269 /* Special case -- quoted string. Pass on to target. */
270 if (args[strlen (args) - 1] != args[0])
271 error (_("Unbalanced quotes: %s"), args);
272 target_goto_bookmark (args, from_tty);
276 /* General case. Bookmark identified by bookmark number. */
277 num = get_number (&args);
279 if (b->number == num)
284 /* Found. Send to target method. */
285 target_goto_bookmark (b->opaque_data, from_tty);
289 error (_("goto-bookmark: no bookmark found for '%s'."), args);
293 bookmark_1 (int bnum)
295 struct gdbarch *gdbarch = get_regcache_arch (get_current_regcache ());
301 if (bnum == -1 || bnum == b->number)
303 printf_filtered (" %d %s '%s'\n",
305 paddress (gdbarch, b->pc),
311 if (bnum > 0 && matched == 0)
312 printf_filtered ("No bookmark #%d\n", bnum);
317 /* Implement "info bookmarks" command. */
320 bookmarks_info (char *args, int from_tty)
325 printf_filtered (_("No bookmarks.\n"));
326 else if (args == NULL || *args == '\0')
330 struct get_number_or_range_state state;
332 init_number_or_range (&state, args);
333 while (!state.finished)
335 bnum = get_number_or_range (&state);
342 /* Provide a prototype to silence -Wmissing-prototypes. */
343 extern initialize_file_ftype _initialize_reverse;
346 _initialize_reverse (void)
348 add_com ("reverse-step", class_run, reverse_step, _("\
349 Step program backward until it reaches the beginning of another source line.\n\
350 Argument N means do this N times (or till program stops for another reason).")
352 add_com_alias ("rs", "reverse-step", class_alias, 1);
354 add_com ("reverse-next", class_run, reverse_next, _("\
355 Step program backward, proceeding through subroutine calls.\n\
356 Like the \"reverse-step\" command as long as subroutine calls do not happen;\n\
357 when they do, the call is treated as one instruction.\n\
358 Argument N means do this N times (or till program stops for another reason).")
360 add_com_alias ("rn", "reverse-next", class_alias, 1);
362 add_com ("reverse-stepi", class_run, reverse_stepi, _("\
363 Step backward exactly one instruction.\n\
364 Argument N means do this N times (or till program stops for another reason).")
366 add_com_alias ("rsi", "reverse-stepi", class_alias, 0);
368 add_com ("reverse-nexti", class_run, reverse_nexti, _("\
369 Step backward one instruction, but proceed through called subroutines.\n\
370 Argument N means do this N times (or till program stops for another reason).")
372 add_com_alias ("rni", "reverse-nexti", class_alias, 0);
374 add_com ("reverse-continue", class_run, reverse_continue, _("\
375 Continue program being debugged but run it in reverse.\n\
376 If proceeding from breakpoint, a number N may be used as an argument,\n\
377 which means to set the ignore count of that breakpoint to N - 1 (so that\n\
378 the breakpoint won't break until the Nth time it is reached)."));
379 add_com_alias ("rc", "reverse-continue", class_alias, 0);
381 add_com ("reverse-finish", class_run, reverse_finish, _("\
382 Execute backward until just before selected stack frame is called."));
384 add_com ("bookmark", class_bookmark, save_bookmark_command, _("\
385 Set a bookmark in the program's execution history.\n\
386 A bookmark represents a point in the execution history \n\
387 that can be returned to at a later point in the debug session."));
388 add_info ("bookmarks", bookmarks_info, _("\
389 Status of user-settable bookmarks.\n\
390 Bookmarks are user-settable markers representing a point in the \n\
391 execution history that can be returned to later in the same debug \n\
393 add_cmd ("bookmark", class_bookmark, delete_bookmark_command, _("\
394 Delete a bookmark from the bookmark list.\n\
395 Argument is a bookmark number or numbers,\n\
396 or no argument to delete all bookmarks.\n"),
398 add_com ("goto-bookmark", class_bookmark, goto_bookmark_command, _("\
399 Go to an earlier-bookmarked point in the program's execution history.\n\
400 Argument is the bookmark number of a bookmark saved earlier by using \n\
401 the 'bookmark' command, or the special arguments:\n\
402 start (beginning of recording)\n\
403 end (end of recording)\n"));