1 /* Process record and replay target for GDB, the GNU debugger.
3 Copyright (C) 2008-2018 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)
65 return find_target_at (record_stratum);
68 /* Check that recording is active. Throw an error, if it isn't. */
70 static struct target_ops *
71 require_record_target (void)
75 t = find_record_target ();
77 error (_("No record target is currently active.\n"
78 "Use one of the \"target record-<tab><tab>\" commands first."));
88 /* Check if a record target is already running. */
89 if (find_record_target () != NULL)
90 error (_("The process is already being recorded. Use \"record stop\" to "
91 "stop recording first."));
97 record_start (const char *method, const char *format, int from_tty)
102 execute_command_to_string ("record", from_tty);
104 error (_("Invalid format."));
106 else if (strcmp (method, "full") == 0)
109 execute_command_to_string ("record full", from_tty);
111 error (_("Invalid format."));
113 else if (strcmp (method, "btrace") == 0)
116 execute_command_to_string ("record btrace", from_tty);
117 else if (strcmp (format, "bts") == 0)
118 execute_command_to_string ("record btrace bts", from_tty);
119 else if (strcmp (format, "pt") == 0)
120 execute_command_to_string ("record btrace pt", from_tty);
122 error (_("Invalid format."));
125 error (_("Invalid method."));
131 record_stop (int from_tty)
133 execute_command_to_string ("record stop", from_tty);
139 record_read_memory (struct gdbarch *gdbarch,
140 CORE_ADDR memaddr, gdb_byte *myaddr,
143 int ret = target_read_memory (memaddr, myaddr, len);
146 DEBUG ("error reading memory at addr %s len = %ld.\n",
147 paddress (gdbarch, memaddr), (long) len);
152 /* Stop recording. */
155 record_stop (struct target_ops *t)
157 DEBUG ("stop %s", t->to_shortname);
159 t->to_stop_recording (t);
162 /* Unpush the record target. */
165 record_unpush (struct target_ops *t)
167 DEBUG ("unpush %s", t->to_shortname);
175 record_disconnect (struct target_ops *t, const char *args, int from_tty)
177 gdb_assert (t->to_stratum == record_stratum);
179 DEBUG ("disconnect %s", t->to_shortname);
184 target_disconnect (args, from_tty);
190 record_detach (struct target_ops *t, const char *args, int from_tty)
192 gdb_assert (t->to_stratum == record_stratum);
194 DEBUG ("detach %s", t->to_shortname);
199 target_detach (args, from_tty);
205 record_mourn_inferior (struct target_ops *t)
207 gdb_assert (t->to_stratum == record_stratum);
209 DEBUG ("mourn inferior %s", t->to_shortname);
211 /* It is safer to not stop recording. Resources will be freed when
212 threads are discarded. */
215 target_mourn_inferior (inferior_ptid);
221 record_kill (struct target_ops *t)
223 gdb_assert (t->to_stratum == record_stratum);
225 DEBUG ("kill %s", t->to_shortname);
227 /* It is safer to not stop recording. Resources will be freed when
228 threads are discarded. */
237 record_check_stopped_by_breakpoint (const address_space *aspace,
239 enum target_stop_reason *reason)
241 if (breakpoint_inserted_here_p (aspace, pc))
243 if (hardware_breakpoint_inserted_here_p (aspace, pc))
244 *reason = TARGET_STOPPED_BY_HW_BREAKPOINT;
246 *reason = TARGET_STOPPED_BY_SW_BREAKPOINT;
250 *reason = TARGET_STOPPED_BY_NO_REASON;
254 /* Implement "show record debug" command. */
257 show_record_debug (struct ui_file *file, int from_tty,
258 struct cmd_list_element *c, const char *value)
260 fprintf_filtered (file, _("Debugging of process record target is %s.\n"),
264 /* Alias for "target record". */
267 cmd_record_start (const char *args, int from_tty)
269 execute_command ("target record-full", from_tty);
272 /* Truncate the record log from the present point
273 of replay until the end. */
276 cmd_record_delete (const char *args, int from_tty)
278 require_record_target ();
280 if (!target_record_is_replaying (inferior_ptid))
282 printf_unfiltered (_("Already at end of record list.\n"));
286 if (!target_supports_delete_record ())
288 printf_unfiltered (_("The current record target does not support "
289 "this operation.\n"));
293 if (!from_tty || query (_("Delete the log from this point forward "
294 "and begin to record the running message "
296 target_delete_record ();
299 /* Implement the "stoprecord" or "record stop" command. */
302 cmd_record_stop (const char *args, int from_tty)
304 struct target_ops *t;
306 t = require_record_target ();
311 printf_unfiltered (_("Process record is stopped and all execution "
312 "logs are deleted.\n"));
314 observer_notify_record_changed (current_inferior (), 0, NULL, NULL);
317 /* The "set record" command. */
320 set_record_command (const char *args, int from_tty)
322 printf_unfiltered (_("\"set record\" must be followed "
323 "by an apporpriate subcommand.\n"));
324 help_list (set_record_cmdlist, "set record ", all_commands, gdb_stdout);
327 /* The "show record" command. */
330 show_record_command (const char *args, int from_tty)
332 cmd_show_list (show_record_cmdlist, from_tty, "");
335 /* The "info record" command. */
338 info_record_command (const char *args, int from_tty)
340 struct target_ops *t;
342 t = find_record_target ();
345 printf_filtered (_("No record target is currently active.\n"));
349 printf_filtered (_("Active record target: %s\n"), t->to_shortname);
350 t->to_info_record (t);
353 /* The "record save" command. */
356 cmd_record_save (const char *args, int from_tty)
358 const char *recfilename;
359 char recfilename_buffer[40];
361 require_record_target ();
363 if (args != NULL && *args != 0)
367 /* Default recfile name is "gdb_record.PID". */
368 xsnprintf (recfilename_buffer, sizeof (recfilename_buffer),
369 "gdb_record.%d", ptid_get_pid (inferior_ptid));
370 recfilename = recfilename_buffer;
373 target_save_record (recfilename);
379 record_goto (const char *arg)
383 if (arg == NULL || *arg == '\0')
384 error (_("Command requires an argument (insn number to go to)."));
386 insn = parse_and_eval_long (arg);
388 require_record_target ();
389 target_goto_record (insn);
392 /* "record goto" command. Argument is an instruction number,
393 as given by "info record".
395 Rewinds the recording (forward or backward) to the given instruction. */
398 cmd_record_goto (const char *arg, int from_tty)
403 /* The "record goto begin" command. */
406 cmd_record_goto_begin (const char *arg, int from_tty)
408 if (arg != NULL && *arg != '\0')
409 error (_("Junk after argument: %s."), arg);
411 require_record_target ();
412 target_goto_record_begin ();
415 /* The "record goto end" command. */
418 cmd_record_goto_end (const char *arg, int from_tty)
420 if (arg != NULL && *arg != '\0')
421 error (_("Junk after argument: %s."), arg);
423 require_record_target ();
424 target_goto_record_end ();
427 /* Read an instruction number from an argument string. */
430 get_insn_number (const char **arg)
433 const char *begin, *end, *pos;
436 pos = skip_spaces (begin);
439 error (_("Expected positive number, got: %s."), pos);
441 number = strtoulst (pos, &end, 10);
443 *arg += (end - begin);
448 /* Read a context size from an argument string. */
451 get_context_size (const char **arg)
456 pos = skip_spaces (*arg);
459 error (_("Expected positive number, got: %s."), pos);
461 long result = strtol (pos, &end, 10);
466 /* Complain about junk at the end of an argument string. */
469 no_chunk (const char *arg)
472 error (_("Junk after argument: %s."), arg);
475 /* Read instruction-history modifiers from an argument string. */
477 static gdb_disassembly_flags
478 get_insn_history_modifiers (const char **arg)
480 gdb_disassembly_flags modifiers;
494 error (_("Missing modifier."));
496 for (; *args; ++args)
508 modifiers |= DISASSEMBLY_SOURCE;
509 modifiers |= DISASSEMBLY_FILENAME;
512 modifiers |= DISASSEMBLY_RAW_INSN;
515 modifiers |= DISASSEMBLY_OMIT_FNAME;
518 modifiers |= DISASSEMBLY_OMIT_PC;
521 error (_("Invalid modifier: %c."), *args);
525 args = skip_spaces (args);
528 /* Update the argument string. */
534 /* The "set record instruction-history-size / set record
535 function-call-history-size" commands are unsigned, with UINT_MAX
536 meaning unlimited. The target interfaces works with signed int
537 though, to indicate direction, so map "unlimited" to INT_MAX, which
538 is about the same as unlimited in practice. If the user does have
539 a log that huge, she can fetch it in chunks across several requests,
540 but she'll likely have other problems first... */
543 command_size_to_target_size (unsigned int size)
545 gdb_assert (size <= INT_MAX || size == UINT_MAX);
547 if (size == UINT_MAX)
553 /* The "record instruction-history" command. */
556 cmd_record_insn_history (const char *arg, int from_tty)
558 require_record_target ();
560 gdb_disassembly_flags flags = get_insn_history_modifiers (&arg);
562 int size = command_size_to_target_size (record_insn_history_size);
564 if (arg == NULL || *arg == 0 || strcmp (arg, "+") == 0)
565 target_insn_history (size, flags);
566 else if (strcmp (arg, "-") == 0)
567 target_insn_history (-size, flags);
572 begin = get_insn_number (&arg);
576 arg = skip_spaces (++arg);
581 size = get_context_size (&arg);
585 target_insn_history_from (begin, size, flags);
587 else if (*arg == '-')
590 size = get_context_size (&arg);
594 target_insn_history_from (begin, -size, flags);
598 end = get_insn_number (&arg);
602 target_insn_history_range (begin, end, flags);
609 target_insn_history_from (begin, size, flags);
616 /* Read function-call-history modifiers from an argument string. */
619 get_call_history_modifiers (const char **arg)
635 error (_("Missing modifier."));
637 for (; *args; ++args)
648 modifiers |= RECORD_PRINT_SRC_LINE;
651 modifiers |= RECORD_PRINT_INSN_RANGE;
654 modifiers |= RECORD_PRINT_INDENT_CALLS;
657 error (_("Invalid modifier: %c."), *args);
661 args = skip_spaces (args);
664 /* Update the argument string. */
670 /* The "record function-call-history" command. */
673 cmd_record_call_history (const char *arg, int from_tty)
677 require_record_target ();
679 flags = get_call_history_modifiers (&arg);
681 size = command_size_to_target_size (record_call_history_size);
683 if (arg == NULL || *arg == 0 || strcmp (arg, "+") == 0)
684 target_call_history (size, flags);
685 else if (strcmp (arg, "-") == 0)
686 target_call_history (-size, flags);
691 begin = get_insn_number (&arg);
695 arg = skip_spaces (++arg);
700 size = get_context_size (&arg);
704 target_call_history_from (begin, size, flags);
706 else if (*arg == '-')
709 size = get_context_size (&arg);
713 target_call_history_from (begin, -size, flags);
717 end = get_insn_number (&arg);
721 target_call_history_range (begin, end, flags);
728 target_call_history_from (begin, size, flags);
735 /* Helper for "set record instruction-history-size" and "set record
736 function-call-history-size" input validation. COMMAND_VAR is the
737 variable registered in the command as control variable. *SETTING
738 is the real setting the command allows changing. */
741 validate_history_size (unsigned int *command_var, unsigned int *setting)
743 if (*command_var != UINT_MAX && *command_var > INT_MAX)
745 unsigned int new_value = *command_var;
747 /* Restore previous value. */
748 *command_var = *setting;
749 error (_("integer %u out of range"), new_value);
752 /* Commit new value. */
753 *setting = *command_var;
756 /* Called by do_setshow_command. We only want values in the
757 [0..INT_MAX] range, while the command's machinery accepts
758 [0..UINT_MAX]. See command_size_to_target_size. */
761 set_record_insn_history_size (const char *args, int from_tty,
762 struct cmd_list_element *c)
764 validate_history_size (&record_insn_history_size_setshow_var,
765 &record_insn_history_size);
768 /* Called by do_setshow_command. We only want values in the
769 [0..INT_MAX] range, while the command's machinery accepts
770 [0..UINT_MAX]. See command_size_to_target_size. */
773 set_record_call_history_size (const char *args, int from_tty,
774 struct cmd_list_element *c)
776 validate_history_size (&record_call_history_size_setshow_var,
777 &record_call_history_size);
781 _initialize_record (void)
783 struct cmd_list_element *c;
785 add_setshow_zuinteger_cmd ("record", no_class, &record_debug,
786 _("Set debugging of record/replay feature."),
787 _("Show debugging of record/replay feature."),
788 _("When enabled, debugging output for "
789 "record/replay feature is displayed."),
790 NULL, show_record_debug, &setdebuglist,
793 add_setshow_uinteger_cmd ("instruction-history-size", no_class,
794 &record_insn_history_size_setshow_var, _("\
795 Set number of instructions to print in \"record instruction-history\"."), _("\
796 Show number of instructions to print in \"record instruction-history\"."), _("\
797 A size of \"unlimited\" means unlimited instructions. The default is 10."),
798 set_record_insn_history_size, NULL,
799 &set_record_cmdlist, &show_record_cmdlist);
801 add_setshow_uinteger_cmd ("function-call-history-size", no_class,
802 &record_call_history_size_setshow_var, _("\
803 Set number of function to print in \"record function-call-history\"."), _("\
804 Show number of functions to print in \"record function-call-history\"."), _("\
805 A size of \"unlimited\" means unlimited lines. The default is 10."),
806 set_record_call_history_size, NULL,
807 &set_record_cmdlist, &show_record_cmdlist);
809 c = add_prefix_cmd ("record", class_obscure, cmd_record_start,
810 _("Start recording."),
811 &record_cmdlist, "record ", 0, &cmdlist);
812 set_cmd_completer (c, filename_completer);
814 add_com_alias ("rec", "record", class_obscure, 1);
815 add_prefix_cmd ("record", class_support, set_record_command,
816 _("Set record options"), &set_record_cmdlist,
817 "set record ", 0, &setlist);
818 add_alias_cmd ("rec", "record", class_obscure, 1, &setlist);
819 add_prefix_cmd ("record", class_support, show_record_command,
820 _("Show record options"), &show_record_cmdlist,
821 "show record ", 0, &showlist);
822 add_alias_cmd ("rec", "record", class_obscure, 1, &showlist);
823 add_prefix_cmd ("record", class_support, info_record_command,
824 _("Info record options"), &info_record_cmdlist,
825 "info record ", 0, &infolist);
826 add_alias_cmd ("rec", "record", class_obscure, 1, &infolist);
828 c = add_cmd ("save", class_obscure, cmd_record_save,
829 _("Save the execution log to a file.\n\
830 Argument is optional filename.\n\
831 Default filename is 'gdb_record.<process_id>'."),
833 set_cmd_completer (c, filename_completer);
835 add_cmd ("delete", class_obscure, cmd_record_delete,
836 _("Delete the rest of execution log and start recording it anew."),
838 add_alias_cmd ("d", "delete", class_obscure, 1, &record_cmdlist);
839 add_alias_cmd ("del", "delete", class_obscure, 1, &record_cmdlist);
841 add_cmd ("stop", class_obscure, cmd_record_stop,
842 _("Stop the record/replay target."),
844 add_alias_cmd ("s", "stop", class_obscure, 1, &record_cmdlist);
846 add_prefix_cmd ("goto", class_obscure, cmd_record_goto, _("\
847 Restore the program to its state at instruction number N.\n\
848 Argument is instruction number, as shown by 'info record'."),
849 &record_goto_cmdlist, "record goto ", 1, &record_cmdlist);
851 add_cmd ("begin", class_obscure, cmd_record_goto_begin,
852 _("Go to the beginning of the execution log."),
853 &record_goto_cmdlist);
854 add_alias_cmd ("start", "begin", class_obscure, 1, &record_goto_cmdlist);
856 add_cmd ("end", class_obscure, cmd_record_goto_end,
857 _("Go to the end of the execution log."),
858 &record_goto_cmdlist);
860 add_cmd ("instruction-history", class_obscure, cmd_record_insn_history, _("\
861 Print disassembled instructions stored in the execution log.\n\
862 With a /m or /s modifier, source lines are included (if available).\n\
863 With a /r modifier, raw instructions in hex are included.\n\
864 With a /f modifier, function names are omitted.\n\
865 With a /p modifier, current position markers are omitted.\n\
866 With no argument, disassembles ten more instructions after the previous \
868 \"record instruction-history -\" disassembles ten instructions before a \
869 previous disassembly.\n\
870 One argument specifies an instruction number as shown by 'info record', and \
871 ten instructions are disassembled after that instruction.\n\
872 Two arguments with comma between them specify starting and ending instruction \
873 numbers to disassemble.\n\
874 If the second argument is preceded by '+' or '-', it specifies the distance \
875 from the first argument.\n\
876 The number of instructions to disassemble can be defined with \"set record \
877 instruction-history-size\"."),
880 add_cmd ("function-call-history", class_obscure, cmd_record_call_history, _("\
881 Prints the execution history at function granularity.\n\
882 It prints one line for each sequence of instructions that belong to the same \
884 Without modifiers, it prints the function name.\n\
885 With a /l modifier, the source file and line number range is included.\n\
886 With a /i modifier, the instruction number range is included.\n\
887 With a /c modifier, the output is indented based on the call stack depth.\n\
888 With no argument, prints ten more lines after the previous ten-line print.\n\
889 \"record function-call-history -\" prints ten lines before a previous ten-line \
891 One argument specifies a function number as shown by 'info record', and \
892 ten lines are printed after that function.\n\
893 Two arguments with comma between them specify a range of functions to print.\n\
894 If the second argument is preceded by '+' or '-', it specifies the distance \
895 from the first argument.\n\
896 The number of functions to print can be defined with \"set record \
897 function-call-history-size\"."),
900 /* Sync command control variables. */
901 record_insn_history_size_setshow_var = record_insn_history_size;
902 record_call_history_size_setshow_var = record_call_history_size;