1 /* Process record and replay target for GDB, the GNU debugger.
3 Copyright (C) 2008-2014 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/>. */
22 #include "completer.h"
26 #include "common/common-utils.h"
27 #include "cli/cli-utils.h"
32 /* This is the debug switch for process record. */
33 unsigned int record_debug = 0;
35 /* The number of instructions to print in "record instruction-history". */
36 static unsigned int record_insn_history_size = 10;
38 /* The variable registered as control variable in the "record
39 instruction-history" command. Necessary for extra input
41 static unsigned int record_insn_history_size_setshow_var;
43 /* The number of functions to print in "record function-call-history". */
44 static unsigned int record_call_history_size = 10;
46 /* The variable registered as control variable in the "record
47 call-history" command. Necessary for extra input validation. */
48 static unsigned int record_call_history_size_setshow_var;
50 struct cmd_list_element *record_cmdlist = NULL;
51 struct cmd_list_element *record_goto_cmdlist = NULL;
52 struct cmd_list_element *set_record_cmdlist = NULL;
53 struct cmd_list_element *show_record_cmdlist = NULL;
54 struct cmd_list_element *info_record_cmdlist = NULL;
56 #define DEBUG(msg, args...) \
58 fprintf_unfiltered (gdb_stdlog, "record: " msg "\n", ##args)
63 find_record_target (void)
67 for (t = current_target.beneath; t != NULL; t = t->beneath)
68 if (t->to_stratum == record_stratum)
74 /* Check that recording is active. Throw an error, if it isn't. */
76 static struct target_ops *
77 require_record_target (void)
81 t = find_record_target ();
83 error (_("No record target is currently active.\n"
84 "Use one of the \"target record-<tab><tab>\" commands first."));
94 /* Check if a record target is already running. */
95 if (find_record_target () != NULL)
96 error (_("The process is already being recorded. Use \"record stop\" to "
97 "stop recording first."));
103 record_read_memory (struct gdbarch *gdbarch,
104 CORE_ADDR memaddr, gdb_byte *myaddr,
107 int ret = target_read_memory (memaddr, myaddr, len);
110 DEBUG ("error reading memory at addr %s len = %ld.\n",
111 paddress (gdbarch, memaddr), (long) len);
116 /* Stop recording. */
119 record_stop (struct target_ops *t)
121 DEBUG ("stop %s", t->to_shortname);
123 if (t->to_stop_recording != NULL)
124 t->to_stop_recording ();
127 /* Unpush the record target. */
130 record_unpush (struct target_ops *t)
132 DEBUG ("unpush %s", t->to_shortname);
140 record_disconnect (struct target_ops *t, char *args, int from_tty)
142 gdb_assert (t->to_stratum == record_stratum);
144 DEBUG ("disconnect %s", t->to_shortname);
149 target_disconnect (args, from_tty);
155 record_detach (struct target_ops *t, const char *args, int from_tty)
157 gdb_assert (t->to_stratum == record_stratum);
159 DEBUG ("detach %s", t->to_shortname);
164 target_detach (args, from_tty);
170 record_mourn_inferior (struct target_ops *t)
172 gdb_assert (t->to_stratum == record_stratum);
174 DEBUG ("mourn inferior %s", t->to_shortname);
176 /* It is safer to not stop recording. Resources will be freed when
177 threads are discarded. */
180 target_mourn_inferior ();
186 record_kill (struct target_ops *t)
188 gdb_assert (t->to_stratum == record_stratum);
190 DEBUG ("kill %s", t->to_shortname);
192 /* It is safer to not stop recording. Resources will be freed when
193 threads are discarded. */
199 /* Implement "show record debug" command. */
202 show_record_debug (struct ui_file *file, int from_tty,
203 struct cmd_list_element *c, const char *value)
205 fprintf_filtered (file, _("Debugging of process record target is %s.\n"),
209 /* Alias for "target record". */
212 cmd_record_start (char *args, int from_tty)
214 execute_command ("target record-full", from_tty);
217 /* Truncate the record log from the present point
218 of replay until the end. */
221 cmd_record_delete (char *args, int from_tty)
223 require_record_target ();
225 if (!target_record_is_replaying ())
227 printf_unfiltered (_("Already at end of record list.\n"));
231 if (!target_supports_delete_record ())
233 printf_unfiltered (_("The current record target does not support "
234 "this operation.\n"));
238 if (!from_tty || query (_("Delete the log from this point forward "
239 "and begin to record the running message "
241 target_delete_record ();
244 /* Implement the "stoprecord" or "record stop" command. */
247 cmd_record_stop (char *args, int from_tty)
249 struct target_ops *t;
251 t = require_record_target ();
256 printf_unfiltered (_("Process record is stopped and all execution "
257 "logs are deleted.\n"));
259 observer_notify_record_changed (current_inferior (), 0);
262 /* The "set record" command. */
265 set_record_command (char *args, int from_tty)
267 printf_unfiltered (_("\"set record\" must be followed "
268 "by an apporpriate subcommand.\n"));
269 help_list (set_record_cmdlist, "set record ", all_commands, gdb_stdout);
272 /* The "show record" command. */
275 show_record_command (char *args, int from_tty)
277 cmd_show_list (show_record_cmdlist, from_tty, "");
280 /* The "info record" command. */
283 info_record_command (char *args, int from_tty)
285 struct target_ops *t;
287 t = find_record_target ();
290 printf_filtered (_("No record target is currently active.\n"));
294 printf_filtered (_("Active record target: %s\n"), t->to_shortname);
295 if (t->to_info_record != NULL)
296 t->to_info_record ();
299 /* The "record save" command. */
302 cmd_record_save (char *args, int from_tty)
304 char *recfilename, recfilename_buffer[40];
306 require_record_target ();
308 if (args != NULL && *args != 0)
312 /* Default recfile name is "gdb_record.PID". */
313 xsnprintf (recfilename_buffer, sizeof (recfilename_buffer),
314 "gdb_record.%d", ptid_get_pid (inferior_ptid));
315 recfilename = recfilename_buffer;
318 target_save_record (recfilename);
321 /* "record goto" command. Argument is an instruction number,
322 as given by "info record".
324 Rewinds the recording (forward or backward) to the given instruction. */
327 cmd_record_goto (char *arg, int from_tty)
331 if (arg == NULL || *arg == '\0')
332 error (_("Command requires an argument (insn number to go to)."));
334 insn = parse_and_eval_long (arg);
336 require_record_target ();
337 target_goto_record (insn);
340 /* The "record goto begin" command. */
343 cmd_record_goto_begin (char *arg, int from_tty)
345 if (arg != NULL && *arg != '\0')
346 error (_("Junk after argument: %s."), arg);
348 require_record_target ();
349 target_goto_record_begin ();
352 /* The "record goto end" command. */
355 cmd_record_goto_end (char *arg, int from_tty)
357 if (arg != NULL && *arg != '\0')
358 error (_("Junk after argument: %s."), arg);
360 require_record_target ();
361 target_goto_record_end ();
364 /* Read an instruction number from an argument string. */
367 get_insn_number (char **arg)
370 const char *begin, *end, *pos;
373 pos = skip_spaces_const (begin);
376 error (_("Expected positive number, got: %s."), pos);
378 number = strtoulst (pos, &end, 10);
380 *arg += (end - begin);
385 /* Read a context size from an argument string. */
388 get_context_size (char **arg)
393 pos = skip_spaces (*arg);
396 error (_("Expected positive number, got: %s."), pos);
398 return strtol (pos, arg, 10);
401 /* Complain about junk at the end of an argument string. */
407 error (_("Junk after argument: %s."), arg);
410 /* Read instruction-history modifiers from an argument string. */
413 get_insn_history_modifiers (char **arg)
429 error (_("Missing modifier."));
431 for (; *args; ++args)
442 modifiers |= DISASSEMBLY_SOURCE;
443 modifiers |= DISASSEMBLY_FILENAME;
446 modifiers |= DISASSEMBLY_RAW_INSN;
449 modifiers |= DISASSEMBLY_OMIT_FNAME;
452 modifiers |= DISASSEMBLY_OMIT_PC;
455 error (_("Invalid modifier: %c."), *args);
459 args = skip_spaces (args);
462 /* Update the argument string. */
468 /* The "set record instruction-history-size / set record
469 function-call-history-size" commands are unsigned, with UINT_MAX
470 meaning unlimited. The target interfaces works with signed int
471 though, to indicate direction, so map "unlimited" to INT_MAX, which
472 is about the same as unlimited in practice. If the user does have
473 a log that huge, she can fetch it in chunks across several requests,
474 but she'll likely have other problems first... */
477 command_size_to_target_size (unsigned int size)
479 gdb_assert (size <= INT_MAX || size == UINT_MAX);
481 if (size == UINT_MAX)
487 /* The "record instruction-history" command. */
490 cmd_record_insn_history (char *arg, int from_tty)
494 require_record_target ();
496 flags = get_insn_history_modifiers (&arg);
498 size = command_size_to_target_size (record_insn_history_size);
500 if (arg == NULL || *arg == 0 || strcmp (arg, "+") == 0)
501 target_insn_history (size, flags);
502 else if (strcmp (arg, "-") == 0)
503 target_insn_history (-size, flags);
508 begin = get_insn_number (&arg);
512 arg = skip_spaces (++arg);
517 size = get_context_size (&arg);
521 target_insn_history_from (begin, size, flags);
523 else if (*arg == '-')
526 size = get_context_size (&arg);
530 target_insn_history_from (begin, -size, flags);
534 end = get_insn_number (&arg);
538 target_insn_history_range (begin, end, flags);
545 target_insn_history_from (begin, size, flags);
552 /* Read function-call-history modifiers from an argument string. */
555 get_call_history_modifiers (char **arg)
571 error (_("Missing modifier."));
573 for (; *args; ++args)
584 modifiers |= RECORD_PRINT_SRC_LINE;
587 modifiers |= RECORD_PRINT_INSN_RANGE;
590 modifiers |= RECORD_PRINT_INDENT_CALLS;
593 error (_("Invalid modifier: %c."), *args);
597 args = skip_spaces (args);
600 /* Update the argument string. */
606 /* The "record function-call-history" command. */
609 cmd_record_call_history (char *arg, int from_tty)
613 require_record_target ();
615 flags = get_call_history_modifiers (&arg);
617 size = command_size_to_target_size (record_call_history_size);
619 if (arg == NULL || *arg == 0 || strcmp (arg, "+") == 0)
620 target_call_history (size, flags);
621 else if (strcmp (arg, "-") == 0)
622 target_call_history (-size, flags);
627 begin = get_insn_number (&arg);
631 arg = skip_spaces (++arg);
636 size = get_context_size (&arg);
640 target_call_history_from (begin, size, flags);
642 else if (*arg == '-')
645 size = get_context_size (&arg);
649 target_call_history_from (begin, -size, flags);
653 end = get_insn_number (&arg);
657 target_call_history_range (begin, end, flags);
664 target_call_history_from (begin, size, flags);
671 /* Helper for "set record instruction-history-size" and "set record
672 function-call-history-size" input validation. COMMAND_VAR is the
673 variable registered in the command as control variable. *SETTING
674 is the real setting the command allows changing. */
677 validate_history_size (unsigned int *command_var, unsigned int *setting)
679 if (*command_var != UINT_MAX && *command_var > INT_MAX)
681 unsigned int new_value = *command_var;
683 /* Restore previous value. */
684 *command_var = *setting;
685 error (_("integer %u out of range"), new_value);
688 /* Commit new value. */
689 *setting = *command_var;
692 /* Called by do_setshow_command. We only want values in the
693 [0..INT_MAX] range, while the command's machinery accepts
694 [0..UINT_MAX]. See command_size_to_target_size. */
697 set_record_insn_history_size (char *args, int from_tty,
698 struct cmd_list_element *c)
700 validate_history_size (&record_insn_history_size_setshow_var,
701 &record_insn_history_size);
704 /* Called by do_setshow_command. We only want values in the
705 [0..INT_MAX] range, while the command's machinery accepts
706 [0..UINT_MAX]. See command_size_to_target_size. */
709 set_record_call_history_size (char *args, int from_tty,
710 struct cmd_list_element *c)
712 validate_history_size (&record_call_history_size_setshow_var,
713 &record_call_history_size);
716 /* Provide a prototype to silence -Wmissing-prototypes. */
717 extern initialize_file_ftype _initialize_record;
720 _initialize_record (void)
722 struct cmd_list_element *c;
724 add_setshow_zuinteger_cmd ("record", no_class, &record_debug,
725 _("Set debugging of record/replay feature."),
726 _("Show debugging of record/replay feature."),
727 _("When enabled, debugging output for "
728 "record/replay feature is displayed."),
729 NULL, show_record_debug, &setdebuglist,
732 add_setshow_uinteger_cmd ("instruction-history-size", no_class,
733 &record_insn_history_size_setshow_var, _("\
734 Set number of instructions to print in \"record instruction-history\"."), _("\
735 Show number of instructions to print in \"record instruction-history\"."), _("\
736 A size of \"unlimited\" means unlimited instructions. The default is 10."),
737 set_record_insn_history_size, NULL,
738 &set_record_cmdlist, &show_record_cmdlist);
740 add_setshow_uinteger_cmd ("function-call-history-size", no_class,
741 &record_call_history_size_setshow_var, _("\
742 Set number of function to print in \"record function-call-history\"."), _("\
743 Show number of functions to print in \"record function-call-history\"."), _("\
744 A size of \"unlimited\" means unlimited lines. The default is 10."),
745 set_record_call_history_size, NULL,
746 &set_record_cmdlist, &show_record_cmdlist);
748 c = add_prefix_cmd ("record", class_obscure, cmd_record_start,
749 _("Start recording."),
750 &record_cmdlist, "record ", 0, &cmdlist);
751 set_cmd_completer (c, filename_completer);
753 add_com_alias ("rec", "record", class_obscure, 1);
754 add_prefix_cmd ("record", class_support, set_record_command,
755 _("Set record options"), &set_record_cmdlist,
756 "set record ", 0, &setlist);
757 add_alias_cmd ("rec", "record", class_obscure, 1, &setlist);
758 add_prefix_cmd ("record", class_support, show_record_command,
759 _("Show record options"), &show_record_cmdlist,
760 "show record ", 0, &showlist);
761 add_alias_cmd ("rec", "record", class_obscure, 1, &showlist);
762 add_prefix_cmd ("record", class_support, info_record_command,
763 _("Info record options"), &info_record_cmdlist,
764 "info record ", 0, &infolist);
765 add_alias_cmd ("rec", "record", class_obscure, 1, &infolist);
767 c = add_cmd ("save", class_obscure, cmd_record_save,
768 _("Save the execution log to a file.\n\
769 Argument is optional filename.\n\
770 Default filename is 'gdb_record.<process_id>'."),
772 set_cmd_completer (c, filename_completer);
774 add_cmd ("delete", class_obscure, cmd_record_delete,
775 _("Delete the rest of execution log and start recording it anew."),
777 add_alias_cmd ("d", "delete", class_obscure, 1, &record_cmdlist);
778 add_alias_cmd ("del", "delete", class_obscure, 1, &record_cmdlist);
780 add_cmd ("stop", class_obscure, cmd_record_stop,
781 _("Stop the record/replay target."),
783 add_alias_cmd ("s", "stop", class_obscure, 1, &record_cmdlist);
785 add_prefix_cmd ("goto", class_obscure, cmd_record_goto, _("\
786 Restore the program to its state at instruction number N.\n\
787 Argument is instruction number, as shown by 'info record'."),
788 &record_goto_cmdlist, "record goto ", 1, &record_cmdlist);
790 add_cmd ("begin", class_obscure, cmd_record_goto_begin,
791 _("Go to the beginning of the execution log."),
792 &record_goto_cmdlist);
793 add_alias_cmd ("start", "begin", class_obscure, 1, &record_goto_cmdlist);
795 add_cmd ("end", class_obscure, cmd_record_goto_end,
796 _("Go to the end of the execution log."),
797 &record_goto_cmdlist);
799 add_cmd ("instruction-history", class_obscure, cmd_record_insn_history, _("\
800 Print disassembled instructions stored in the execution log.\n\
801 With a /m modifier, source lines are included (if available).\n\
802 With a /r modifier, raw instructions in hex are included.\n\
803 With a /f modifier, function names are omitted.\n\
804 With a /p modifier, current position markers are omitted.\n\
805 With no argument, disassembles ten more instructions after the previous \
807 \"record instruction-history -\" disassembles ten instructions before a \
808 previous disassembly.\n\
809 One argument specifies an instruction number as shown by 'info record', and \
810 ten instructions are disassembled after that instruction.\n\
811 Two arguments with comma between them specify starting and ending instruction \
812 numbers to disassemble.\n\
813 If the second argument is preceded by '+' or '-', it specifies the distance \
814 from the first argument.\n\
815 The number of instructions to disassemble can be defined with \"set record \
816 instruction-history-size\"."),
819 add_cmd ("function-call-history", class_obscure, cmd_record_call_history, _("\
820 Prints the execution history at function granularity.\n\
821 It prints one line for each sequence of instructions that belong to the same \
823 Without modifiers, it prints the function name.\n\
824 With a /l modifier, the source file and line number range is included.\n\
825 With a /i modifier, the instruction number range is included.\n\
826 With a /c modifier, the output is indented based on the call stack depth.\n\
827 With no argument, prints ten more lines after the previous ten-line print.\n\
828 \"record function-call-history -\" prints ten lines before a previous ten-line \
830 One argument specifies a function number as shown by 'info record', and \
831 ten lines are printed after that function.\n\
832 Two arguments with comma between them specify a range of functions to print.\n\
833 If the second argument is preceded by '+' or '-', it specifies the distance \
834 from the first argument.\n\
835 The number of functions to print can be defined with \"set record \
836 function-call-history-size\"."),
839 /* Sync command control variables. */
840 record_insn_history_size_setshow_var = record_insn_history_size;
841 record_call_history_size_setshow_var = record_call_history_size;