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)
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_read_memory (struct gdbarch *gdbarch,
98 CORE_ADDR memaddr, gdb_byte *myaddr,
101 int ret = target_read_memory (memaddr, myaddr, len);
104 DEBUG ("error reading memory at addr %s len = %ld.\n",
105 paddress (gdbarch, memaddr), (long) len);
110 /* Stop recording. */
113 record_stop (struct target_ops *t)
115 DEBUG ("stop %s", t->to_shortname);
117 t->to_stop_recording (t);
120 /* Unpush the record target. */
123 record_unpush (struct target_ops *t)
125 DEBUG ("unpush %s", t->to_shortname);
133 record_disconnect (struct target_ops *t, const char *args, int from_tty)
135 gdb_assert (t->to_stratum == record_stratum);
137 DEBUG ("disconnect %s", t->to_shortname);
142 target_disconnect (args, from_tty);
148 record_detach (struct target_ops *t, const char *args, int from_tty)
150 gdb_assert (t->to_stratum == record_stratum);
152 DEBUG ("detach %s", t->to_shortname);
157 target_detach (args, from_tty);
163 record_mourn_inferior (struct target_ops *t)
165 gdb_assert (t->to_stratum == record_stratum);
167 DEBUG ("mourn inferior %s", t->to_shortname);
169 /* It is safer to not stop recording. Resources will be freed when
170 threads are discarded. */
173 target_mourn_inferior ();
179 record_kill (struct target_ops *t)
181 gdb_assert (t->to_stratum == record_stratum);
183 DEBUG ("kill %s", t->to_shortname);
185 /* It is safer to not stop recording. Resources will be freed when
186 threads are discarded. */
192 /* Implement "show record debug" command. */
195 show_record_debug (struct ui_file *file, int from_tty,
196 struct cmd_list_element *c, const char *value)
198 fprintf_filtered (file, _("Debugging of process record target is %s.\n"),
202 /* Alias for "target record". */
205 cmd_record_start (char *args, int from_tty)
207 execute_command ("target record-full", from_tty);
210 /* Truncate the record log from the present point
211 of replay until the end. */
214 cmd_record_delete (char *args, int from_tty)
216 require_record_target ();
218 if (!target_record_is_replaying ())
220 printf_unfiltered (_("Already at end of record list.\n"));
224 if (!target_supports_delete_record ())
226 printf_unfiltered (_("The current record target does not support "
227 "this operation.\n"));
231 if (!from_tty || query (_("Delete the log from this point forward "
232 "and begin to record the running message "
234 target_delete_record ();
237 /* Implement the "stoprecord" or "record stop" command. */
240 cmd_record_stop (char *args, int from_tty)
242 struct target_ops *t;
244 t = require_record_target ();
249 printf_unfiltered (_("Process record is stopped and all execution "
250 "logs are deleted.\n"));
252 observer_notify_record_changed (current_inferior (), 0);
255 /* The "set record" command. */
258 set_record_command (char *args, int from_tty)
260 printf_unfiltered (_("\"set record\" must be followed "
261 "by an apporpriate subcommand.\n"));
262 help_list (set_record_cmdlist, "set record ", all_commands, gdb_stdout);
265 /* The "show record" command. */
268 show_record_command (char *args, int from_tty)
270 cmd_show_list (show_record_cmdlist, from_tty, "");
273 /* The "info record" command. */
276 info_record_command (char *args, int from_tty)
278 struct target_ops *t;
280 t = find_record_target ();
283 printf_filtered (_("No record target is currently active.\n"));
287 printf_filtered (_("Active record target: %s\n"), t->to_shortname);
288 if (t->to_info_record != NULL)
289 t->to_info_record (t);
292 /* The "record save" command. */
295 cmd_record_save (char *args, int from_tty)
297 char *recfilename, recfilename_buffer[40];
299 require_record_target ();
301 if (args != NULL && *args != 0)
305 /* Default recfile name is "gdb_record.PID". */
306 xsnprintf (recfilename_buffer, sizeof (recfilename_buffer),
307 "gdb_record.%d", ptid_get_pid (inferior_ptid));
308 recfilename = recfilename_buffer;
311 target_save_record (recfilename);
317 record_goto (const char *arg)
321 if (arg == NULL || *arg == '\0')
322 error (_("Command requires an argument (insn number to go to)."));
324 insn = parse_and_eval_long (arg);
326 require_record_target ();
327 target_goto_record (insn);
330 /* "record goto" command. Argument is an instruction number,
331 as given by "info record".
333 Rewinds the recording (forward or backward) to the given instruction. */
336 cmd_record_goto (char *arg, int from_tty)
341 /* The "record goto begin" command. */
344 cmd_record_goto_begin (char *arg, int from_tty)
346 if (arg != NULL && *arg != '\0')
347 error (_("Junk after argument: %s."), arg);
349 require_record_target ();
350 target_goto_record_begin ();
353 /* The "record goto end" command. */
356 cmd_record_goto_end (char *arg, int from_tty)
358 if (arg != NULL && *arg != '\0')
359 error (_("Junk after argument: %s."), arg);
361 require_record_target ();
362 target_goto_record_end ();
365 /* Read an instruction number from an argument string. */
368 get_insn_number (char **arg)
371 const char *begin, *end, *pos;
374 pos = skip_spaces_const (begin);
377 error (_("Expected positive number, got: %s."), pos);
379 number = strtoulst (pos, &end, 10);
381 *arg += (end - begin);
386 /* Read a context size from an argument string. */
389 get_context_size (char **arg)
394 pos = skip_spaces (*arg);
397 error (_("Expected positive number, got: %s."), pos);
399 return strtol (pos, arg, 10);
402 /* Complain about junk at the end of an argument string. */
408 error (_("Junk after argument: %s."), arg);
411 /* Read instruction-history modifiers from an argument string. */
414 get_insn_history_modifiers (char **arg)
430 error (_("Missing modifier."));
432 for (; *args; ++args)
443 modifiers |= DISASSEMBLY_SOURCE;
444 modifiers |= DISASSEMBLY_FILENAME;
447 modifiers |= DISASSEMBLY_RAW_INSN;
450 modifiers |= DISASSEMBLY_OMIT_FNAME;
453 modifiers |= DISASSEMBLY_OMIT_PC;
456 error (_("Invalid modifier: %c."), *args);
460 args = skip_spaces (args);
463 /* Update the argument string. */
469 /* The "set record instruction-history-size / set record
470 function-call-history-size" commands are unsigned, with UINT_MAX
471 meaning unlimited. The target interfaces works with signed int
472 though, to indicate direction, so map "unlimited" to INT_MAX, which
473 is about the same as unlimited in practice. If the user does have
474 a log that huge, she can fetch it in chunks across several requests,
475 but she'll likely have other problems first... */
478 command_size_to_target_size (unsigned int size)
480 gdb_assert (size <= INT_MAX || size == UINT_MAX);
482 if (size == UINT_MAX)
488 /* The "record instruction-history" command. */
491 cmd_record_insn_history (char *arg, int from_tty)
495 require_record_target ();
497 flags = get_insn_history_modifiers (&arg);
499 size = command_size_to_target_size (record_insn_history_size);
501 if (arg == NULL || *arg == 0 || strcmp (arg, "+") == 0)
502 target_insn_history (size, flags);
503 else if (strcmp (arg, "-") == 0)
504 target_insn_history (-size, flags);
509 begin = get_insn_number (&arg);
513 arg = skip_spaces (++arg);
518 size = get_context_size (&arg);
522 target_insn_history_from (begin, size, flags);
524 else if (*arg == '-')
527 size = get_context_size (&arg);
531 target_insn_history_from (begin, -size, flags);
535 end = get_insn_number (&arg);
539 target_insn_history_range (begin, end, flags);
546 target_insn_history_from (begin, size, flags);
553 /* Read function-call-history modifiers from an argument string. */
556 get_call_history_modifiers (char **arg)
572 error (_("Missing modifier."));
574 for (; *args; ++args)
585 modifiers |= RECORD_PRINT_SRC_LINE;
588 modifiers |= RECORD_PRINT_INSN_RANGE;
591 modifiers |= RECORD_PRINT_INDENT_CALLS;
594 error (_("Invalid modifier: %c."), *args);
598 args = skip_spaces (args);
601 /* Update the argument string. */
607 /* The "record function-call-history" command. */
610 cmd_record_call_history (char *arg, int from_tty)
614 require_record_target ();
616 flags = get_call_history_modifiers (&arg);
618 size = command_size_to_target_size (record_call_history_size);
620 if (arg == NULL || *arg == 0 || strcmp (arg, "+") == 0)
621 target_call_history (size, flags);
622 else if (strcmp (arg, "-") == 0)
623 target_call_history (-size, flags);
628 begin = get_insn_number (&arg);
632 arg = skip_spaces (++arg);
637 size = get_context_size (&arg);
641 target_call_history_from (begin, size, flags);
643 else if (*arg == '-')
646 size = get_context_size (&arg);
650 target_call_history_from (begin, -size, flags);
654 end = get_insn_number (&arg);
658 target_call_history_range (begin, end, flags);
665 target_call_history_from (begin, size, flags);
672 /* Helper for "set record instruction-history-size" and "set record
673 function-call-history-size" input validation. COMMAND_VAR is the
674 variable registered in the command as control variable. *SETTING
675 is the real setting the command allows changing. */
678 validate_history_size (unsigned int *command_var, unsigned int *setting)
680 if (*command_var != UINT_MAX && *command_var > INT_MAX)
682 unsigned int new_value = *command_var;
684 /* Restore previous value. */
685 *command_var = *setting;
686 error (_("integer %u out of range"), new_value);
689 /* Commit new value. */
690 *setting = *command_var;
693 /* Called by do_setshow_command. We only want values in the
694 [0..INT_MAX] range, while the command's machinery accepts
695 [0..UINT_MAX]. See command_size_to_target_size. */
698 set_record_insn_history_size (char *args, int from_tty,
699 struct cmd_list_element *c)
701 validate_history_size (&record_insn_history_size_setshow_var,
702 &record_insn_history_size);
705 /* Called by do_setshow_command. We only want values in the
706 [0..INT_MAX] range, while the command's machinery accepts
707 [0..UINT_MAX]. See command_size_to_target_size. */
710 set_record_call_history_size (char *args, int from_tty,
711 struct cmd_list_element *c)
713 validate_history_size (&record_call_history_size_setshow_var,
714 &record_call_history_size);
717 /* Provide a prototype to silence -Wmissing-prototypes. */
718 extern initialize_file_ftype _initialize_record;
721 _initialize_record (void)
723 struct cmd_list_element *c;
725 add_setshow_zuinteger_cmd ("record", no_class, &record_debug,
726 _("Set debugging of record/replay feature."),
727 _("Show debugging of record/replay feature."),
728 _("When enabled, debugging output for "
729 "record/replay feature is displayed."),
730 NULL, show_record_debug, &setdebuglist,
733 add_setshow_uinteger_cmd ("instruction-history-size", no_class,
734 &record_insn_history_size_setshow_var, _("\
735 Set number of instructions to print in \"record instruction-history\"."), _("\
736 Show number of instructions to print in \"record instruction-history\"."), _("\
737 A size of \"unlimited\" means unlimited instructions. The default is 10."),
738 set_record_insn_history_size, NULL,
739 &set_record_cmdlist, &show_record_cmdlist);
741 add_setshow_uinteger_cmd ("function-call-history-size", no_class,
742 &record_call_history_size_setshow_var, _("\
743 Set number of function to print in \"record function-call-history\"."), _("\
744 Show number of functions to print in \"record function-call-history\"."), _("\
745 A size of \"unlimited\" means unlimited lines. The default is 10."),
746 set_record_call_history_size, NULL,
747 &set_record_cmdlist, &show_record_cmdlist);
749 c = add_prefix_cmd ("record", class_obscure, cmd_record_start,
750 _("Start recording."),
751 &record_cmdlist, "record ", 0, &cmdlist);
752 set_cmd_completer (c, filename_completer);
754 add_com_alias ("rec", "record", class_obscure, 1);
755 add_prefix_cmd ("record", class_support, set_record_command,
756 _("Set record options"), &set_record_cmdlist,
757 "set record ", 0, &setlist);
758 add_alias_cmd ("rec", "record", class_obscure, 1, &setlist);
759 add_prefix_cmd ("record", class_support, show_record_command,
760 _("Show record options"), &show_record_cmdlist,
761 "show record ", 0, &showlist);
762 add_alias_cmd ("rec", "record", class_obscure, 1, &showlist);
763 add_prefix_cmd ("record", class_support, info_record_command,
764 _("Info record options"), &info_record_cmdlist,
765 "info record ", 0, &infolist);
766 add_alias_cmd ("rec", "record", class_obscure, 1, &infolist);
768 c = add_cmd ("save", class_obscure, cmd_record_save,
769 _("Save the execution log to a file.\n\
770 Argument is optional filename.\n\
771 Default filename is 'gdb_record.<process_id>'."),
773 set_cmd_completer (c, filename_completer);
775 add_cmd ("delete", class_obscure, cmd_record_delete,
776 _("Delete the rest of execution log and start recording it anew."),
778 add_alias_cmd ("d", "delete", class_obscure, 1, &record_cmdlist);
779 add_alias_cmd ("del", "delete", class_obscure, 1, &record_cmdlist);
781 add_cmd ("stop", class_obscure, cmd_record_stop,
782 _("Stop the record/replay target."),
784 add_alias_cmd ("s", "stop", class_obscure, 1, &record_cmdlist);
786 add_prefix_cmd ("goto", class_obscure, cmd_record_goto, _("\
787 Restore the program to its state at instruction number N.\n\
788 Argument is instruction number, as shown by 'info record'."),
789 &record_goto_cmdlist, "record goto ", 1, &record_cmdlist);
791 add_cmd ("begin", class_obscure, cmd_record_goto_begin,
792 _("Go to the beginning of the execution log."),
793 &record_goto_cmdlist);
794 add_alias_cmd ("start", "begin", class_obscure, 1, &record_goto_cmdlist);
796 add_cmd ("end", class_obscure, cmd_record_goto_end,
797 _("Go to the end of the execution log."),
798 &record_goto_cmdlist);
800 add_cmd ("instruction-history", class_obscure, cmd_record_insn_history, _("\
801 Print disassembled instructions stored in the execution log.\n\
802 With a /m modifier, source lines are included (if available).\n\
803 With a /r modifier, raw instructions in hex are included.\n\
804 With a /f modifier, function names are omitted.\n\
805 With a /p modifier, current position markers are omitted.\n\
806 With no argument, disassembles ten more instructions after the previous \
808 \"record instruction-history -\" disassembles ten instructions before a \
809 previous disassembly.\n\
810 One argument specifies an instruction number as shown by 'info record', and \
811 ten instructions are disassembled after that instruction.\n\
812 Two arguments with comma between them specify starting and ending instruction \
813 numbers to disassemble.\n\
814 If the second argument is preceded by '+' or '-', it specifies the distance \
815 from the first argument.\n\
816 The number of instructions to disassemble can be defined with \"set record \
817 instruction-history-size\"."),
820 add_cmd ("function-call-history", class_obscure, cmd_record_call_history, _("\
821 Prints the execution history at function granularity.\n\
822 It prints one line for each sequence of instructions that belong to the same \
824 Without modifiers, it prints the function name.\n\
825 With a /l modifier, the source file and line number range is included.\n\
826 With a /i modifier, the instruction number range is included.\n\
827 With a /c modifier, the output is indented based on the call stack depth.\n\
828 With no argument, prints ten more lines after the previous ten-line print.\n\
829 \"record function-call-history -\" prints ten lines before a previous ten-line \
831 One argument specifies a function number as shown by 'info record', and \
832 ten lines are printed after that function.\n\
833 Two arguments with comma between them specify a range of functions to print.\n\
834 If the second argument is preceded by '+' or '-', it specifies the distance \
835 from the first argument.\n\
836 The number of functions to print can be defined with \"set record \
837 function-call-history-size\"."),
840 /* Sync command control variables. */
841 record_insn_history_size_setshow_var = record_insn_history_size;
842 record_call_history_size_setshow_var = record_call_history_size;