Update copyright year in gdbarch.sh doc/gdb.texinfo and doc/refcard.tex
[binutils-gdb.git] / gdb / record.c
blob51d2a94a2bf7ffff2997e0881675fc2110320acf
1 /* Process record and replay target for GDB, the GNU debugger.
3 Copyright (C) 2008-2020 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/>. */
20 #include "defs.h"
21 #include "gdbcmd.h"
22 #include "completer.h"
23 #include "record.h"
24 #include "observable.h"
25 #include "inferior.h"
26 #include "gdbsupport/common-utils.h"
27 #include "cli/cli-utils.h"
28 #include "disasm.h"
30 #include <ctype.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
40 validation. */
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...) \
57 if (record_debug) \
58 fprintf_unfiltered (gdb_stdlog, "record: " msg "\n", ##args)
60 /* See record.h. */
62 struct target_ops *
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)
73 struct target_ops *t;
75 t = find_record_target ();
76 if (t == NULL)
77 error (_("No record target is currently active.\n"
78 "Use one of the \"target record-<TAB><TAB>\" commands first."));
80 return t;
83 /* See record.h. */
85 void
86 record_preopen (void)
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."));
94 /* See record.h. */
96 void
97 record_start (const char *method, const char *format, int from_tty)
99 if (method == NULL)
101 if (format == NULL)
102 execute_command_to_string ("record", from_tty, false);
103 else
104 error (_("Invalid format."));
106 else if (strcmp (method, "full") == 0)
108 if (format == NULL)
109 execute_command_to_string ("record full", from_tty, false);
110 else
111 error (_("Invalid format."));
113 else if (strcmp (method, "btrace") == 0)
115 if (format == NULL)
116 execute_command_to_string ("record btrace", from_tty, false);
117 else if (strcmp (format, "bts") == 0)
118 execute_command_to_string ("record btrace bts", from_tty, false);
119 else if (strcmp (format, "pt") == 0)
120 execute_command_to_string ("record btrace pt", from_tty, false);
121 else
122 error (_("Invalid format."));
124 else
125 error (_("Invalid method."));
128 /* See record.h. */
130 void
131 record_stop (int from_tty)
133 execute_command_to_string ("record stop", from_tty, false);
136 /* See record.h. */
139 record_read_memory (struct gdbarch *gdbarch,
140 CORE_ADDR memaddr, gdb_byte *myaddr,
141 ssize_t len)
143 int ret = target_read_memory (memaddr, myaddr, len);
145 if (ret != 0)
146 DEBUG ("error reading memory at addr %s len = %ld.\n",
147 paddress (gdbarch, memaddr), (long) len);
149 return ret;
152 /* Stop recording. */
154 static void
155 record_stop (struct target_ops *t)
157 DEBUG ("stop %s", t->shortname ());
159 t->stop_recording ();
162 /* Unpush the record target. */
164 static void
165 record_unpush (struct target_ops *t)
167 DEBUG ("unpush %s", t->shortname ());
169 unpush_target (t);
172 /* See record.h. */
174 void
175 record_disconnect (struct target_ops *t, const char *args, int from_tty)
177 gdb_assert (t->stratum () == record_stratum);
179 DEBUG ("disconnect %s", t->shortname ());
181 record_stop (t);
182 record_unpush (t);
184 target_disconnect (args, from_tty);
187 /* See record.h. */
189 void
190 record_detach (struct target_ops *t, inferior *inf, int from_tty)
192 gdb_assert (t->stratum () == record_stratum);
194 DEBUG ("detach %s", t->shortname ());
196 record_stop (t);
197 record_unpush (t);
199 target_detach (inf, from_tty);
202 /* See record.h. */
204 void
205 record_mourn_inferior (struct target_ops *t)
207 gdb_assert (t->stratum () == record_stratum);
209 DEBUG ("mourn inferior %s", t->shortname ());
211 /* It is safer to not stop recording. Resources will be freed when
212 threads are discarded. */
213 record_unpush (t);
215 target_mourn_inferior (inferior_ptid);
218 /* See record.h. */
220 void
221 record_kill (struct target_ops *t)
223 gdb_assert (t->stratum () == record_stratum);
225 DEBUG ("kill %s", t->shortname ());
227 /* It is safer to not stop recording. Resources will be freed when
228 threads are discarded. */
229 record_unpush (t);
231 target_kill ();
234 /* See record.h. */
237 record_check_stopped_by_breakpoint (const address_space *aspace,
238 CORE_ADDR pc,
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;
245 else
246 *reason = TARGET_STOPPED_BY_SW_BREAKPOINT;
247 return 1;
250 *reason = TARGET_STOPPED_BY_NO_REASON;
251 return 0;
254 /* Implement "show record debug" command. */
256 static void
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"),
261 value);
264 /* Alias for "target record". */
266 static void
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. */
275 static void
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"));
283 return;
286 if (!target_supports_delete_record ())
288 printf_unfiltered (_("The current record target does not support "
289 "this operation.\n"));
290 return;
293 if (!from_tty || query (_("Delete the log from this point forward "
294 "and begin to record the running message "
295 "at current PC?")))
296 target_delete_record ();
299 /* Implement the "stoprecord" or "record stop" command. */
301 static void
302 cmd_record_stop (const char *args, int from_tty)
304 struct target_ops *t;
306 t = require_record_target ();
308 record_stop (t);
309 record_unpush (t);
311 printf_unfiltered (_("Process record is stopped and all execution "
312 "logs are deleted.\n"));
314 gdb::observers::record_changed.notify (current_inferior (), 0, NULL, NULL);
317 /* The "set record" command. */
319 static void
320 set_record_command (const char *args, int from_tty)
322 printf_unfiltered (_("\"set record\" must be followed "
323 "by an appropriate subcommand.\n"));
324 help_list (set_record_cmdlist, "set record ", all_commands, gdb_stdout);
327 /* The "show record" command. */
329 static void
330 show_record_command (const char *args, int from_tty)
332 cmd_show_list (show_record_cmdlist, from_tty, "");
335 /* The "info record" command. */
337 static void
338 info_record_command (const char *args, int from_tty)
340 struct target_ops *t;
342 t = find_record_target ();
343 if (t == NULL)
345 printf_filtered (_("No record target is currently active.\n"));
346 return;
349 printf_filtered (_("Active record target: %s\n"), t->shortname ());
350 t->info_record ();
353 /* The "record save" command. */
355 static void
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)
364 recfilename = args;
365 else
367 /* Default recfile name is "gdb_record.PID". */
368 xsnprintf (recfilename_buffer, sizeof (recfilename_buffer),
369 "gdb_record.%d", inferior_ptid.pid ());
370 recfilename = recfilename_buffer;
373 target_save_record (recfilename);
376 /* See record.h. */
378 void
379 record_goto (const char *arg)
381 ULONGEST insn;
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. */
397 static void
398 cmd_record_goto (const char *arg, int from_tty)
400 record_goto (arg);
403 /* The "record goto begin" command. */
405 static void
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. */
417 static void
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. */
429 static ULONGEST
430 get_insn_number (const char **arg)
432 ULONGEST number;
433 const char *begin, *end, *pos;
435 begin = *arg;
436 pos = skip_spaces (begin);
438 if (!isdigit (*pos))
439 error (_("Expected positive number, got: %s."), pos);
441 number = strtoulst (pos, &end, 10);
443 *arg += (end - begin);
445 return number;
448 /* Read a context size from an argument string. */
450 static int
451 get_context_size (const char **arg)
453 const char *pos;
454 char *end;
456 pos = skip_spaces (*arg);
458 if (!isdigit (*pos))
459 error (_("Expected positive number, got: %s."), pos);
461 long result = strtol (pos, &end, 10);
462 *arg = end;
463 return result;
466 /* Complain about junk at the end of an argument string. */
468 static void
469 no_chunk (const char *arg)
471 if (*arg != 0)
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;
481 const char *args;
483 modifiers = 0;
484 args = *arg;
486 if (args == NULL)
487 return modifiers;
489 while (*args == '/')
491 ++args;
493 if (*args == '\0')
494 error (_("Missing modifier."));
496 for (; *args; ++args)
498 if (isspace (*args))
499 break;
501 if (*args == '/')
502 continue;
504 switch (*args)
506 case 'm':
507 case 's':
508 modifiers |= DISASSEMBLY_SOURCE;
509 modifiers |= DISASSEMBLY_FILENAME;
510 break;
511 case 'r':
512 modifiers |= DISASSEMBLY_RAW_INSN;
513 break;
514 case 'f':
515 modifiers |= DISASSEMBLY_OMIT_FNAME;
516 break;
517 case 'p':
518 modifiers |= DISASSEMBLY_OMIT_PC;
519 break;
520 default:
521 error (_("Invalid modifier: %c."), *args);
525 args = skip_spaces (args);
528 /* Update the argument string. */
529 *arg = args;
531 return modifiers;
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... */
542 static int
543 command_size_to_target_size (unsigned int size)
545 gdb_assert (size <= INT_MAX || size == UINT_MAX);
547 if (size == UINT_MAX)
548 return INT_MAX;
549 else
550 return size;
553 /* The "record instruction-history" command. */
555 static void
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);
568 else
570 ULONGEST begin, end;
572 begin = get_insn_number (&arg);
574 if (*arg == ',')
576 arg = skip_spaces (++arg);
578 if (*arg == '+')
580 arg += 1;
581 size = get_context_size (&arg);
583 no_chunk (arg);
585 target_insn_history_from (begin, size, flags);
587 else if (*arg == '-')
589 arg += 1;
590 size = get_context_size (&arg);
592 no_chunk (arg);
594 target_insn_history_from (begin, -size, flags);
596 else
598 end = get_insn_number (&arg);
600 no_chunk (arg);
602 target_insn_history_range (begin, end, flags);
605 else
607 no_chunk (arg);
609 target_insn_history_from (begin, size, flags);
612 dont_repeat ();
616 /* Read function-call-history modifiers from an argument string. */
618 static record_print_flags
619 get_call_history_modifiers (const char **arg)
621 record_print_flags modifiers = 0;
622 const char *args = *arg;
624 if (args == NULL)
625 return modifiers;
627 while (*args == '/')
629 ++args;
631 if (*args == '\0')
632 error (_("Missing modifier."));
634 for (; *args; ++args)
636 if (isspace (*args))
637 break;
639 if (*args == '/')
640 continue;
642 switch (*args)
644 case 'l':
645 modifiers |= RECORD_PRINT_SRC_LINE;
646 break;
647 case 'i':
648 modifiers |= RECORD_PRINT_INSN_RANGE;
649 break;
650 case 'c':
651 modifiers |= RECORD_PRINT_INDENT_CALLS;
652 break;
653 default:
654 error (_("Invalid modifier: %c."), *args);
658 args = skip_spaces (args);
661 /* Update the argument string. */
662 *arg = args;
664 return modifiers;
667 /* The "record function-call-history" command. */
669 static void
670 cmd_record_call_history (const char *arg, int from_tty)
672 require_record_target ();
674 record_print_flags flags = get_call_history_modifiers (&arg);
676 int size = command_size_to_target_size (record_call_history_size);
678 if (arg == NULL || *arg == 0 || strcmp (arg, "+") == 0)
679 target_call_history (size, flags);
680 else if (strcmp (arg, "-") == 0)
681 target_call_history (-size, flags);
682 else
684 ULONGEST begin, end;
686 begin = get_insn_number (&arg);
688 if (*arg == ',')
690 arg = skip_spaces (++arg);
692 if (*arg == '+')
694 arg += 1;
695 size = get_context_size (&arg);
697 no_chunk (arg);
699 target_call_history_from (begin, size, flags);
701 else if (*arg == '-')
703 arg += 1;
704 size = get_context_size (&arg);
706 no_chunk (arg);
708 target_call_history_from (begin, -size, flags);
710 else
712 end = get_insn_number (&arg);
714 no_chunk (arg);
716 target_call_history_range (begin, end, flags);
719 else
721 no_chunk (arg);
723 target_call_history_from (begin, size, flags);
726 dont_repeat ();
730 /* Helper for "set record instruction-history-size" and "set record
731 function-call-history-size" input validation. COMMAND_VAR is the
732 variable registered in the command as control variable. *SETTING
733 is the real setting the command allows changing. */
735 static void
736 validate_history_size (unsigned int *command_var, unsigned int *setting)
738 if (*command_var != UINT_MAX && *command_var > INT_MAX)
740 unsigned int new_value = *command_var;
742 /* Restore previous value. */
743 *command_var = *setting;
744 error (_("integer %u out of range"), new_value);
747 /* Commit new value. */
748 *setting = *command_var;
751 /* Called by do_setshow_command. We only want values in the
752 [0..INT_MAX] range, while the command's machinery accepts
753 [0..UINT_MAX]. See command_size_to_target_size. */
755 static void
756 set_record_insn_history_size (const char *args, int from_tty,
757 struct cmd_list_element *c)
759 validate_history_size (&record_insn_history_size_setshow_var,
760 &record_insn_history_size);
763 /* Called by do_setshow_command. We only want values in the
764 [0..INT_MAX] range, while the command's machinery accepts
765 [0..UINT_MAX]. See command_size_to_target_size. */
767 static void
768 set_record_call_history_size (const char *args, int from_tty,
769 struct cmd_list_element *c)
771 validate_history_size (&record_call_history_size_setshow_var,
772 &record_call_history_size);
775 void
776 _initialize_record (void)
778 struct cmd_list_element *c;
780 add_setshow_zuinteger_cmd ("record", no_class, &record_debug,
781 _("Set debugging of record/replay feature."),
782 _("Show debugging of record/replay feature."),
783 _("When enabled, debugging output for "
784 "record/replay feature is displayed."),
785 NULL, show_record_debug, &setdebuglist,
786 &showdebuglist);
788 add_setshow_uinteger_cmd ("instruction-history-size", no_class,
789 &record_insn_history_size_setshow_var, _("\
790 Set number of instructions to print in \"record instruction-history\"."), _("\
791 Show number of instructions to print in \"record instruction-history\"."), _("\
792 A size of \"unlimited\" means unlimited instructions. The default is 10."),
793 set_record_insn_history_size, NULL,
794 &set_record_cmdlist, &show_record_cmdlist);
796 add_setshow_uinteger_cmd ("function-call-history-size", no_class,
797 &record_call_history_size_setshow_var, _("\
798 Set number of function to print in \"record function-call-history\"."), _("\
799 Show number of functions to print in \"record function-call-history\"."), _("\
800 A size of \"unlimited\" means unlimited lines. The default is 10."),
801 set_record_call_history_size, NULL,
802 &set_record_cmdlist, &show_record_cmdlist);
804 c = add_prefix_cmd ("record", class_obscure, cmd_record_start,
805 _("Start recording."),
806 &record_cmdlist, "record ", 0, &cmdlist);
807 set_cmd_completer (c, filename_completer);
809 add_com_alias ("rec", "record", class_obscure, 1);
810 add_prefix_cmd ("record", class_support, set_record_command,
811 _("Set record options."), &set_record_cmdlist,
812 "set record ", 0, &setlist);
813 add_alias_cmd ("rec", "record", class_obscure, 1, &setlist);
814 add_prefix_cmd ("record", class_support, show_record_command,
815 _("Show record options."), &show_record_cmdlist,
816 "show record ", 0, &showlist);
817 add_alias_cmd ("rec", "record", class_obscure, 1, &showlist);
818 add_prefix_cmd ("record", class_support, info_record_command,
819 _("Info record options."), &info_record_cmdlist,
820 "info record ", 0, &infolist);
821 add_alias_cmd ("rec", "record", class_obscure, 1, &infolist);
823 c = add_cmd ("save", class_obscure, cmd_record_save,
824 _("Save the execution log to a file.\n\
825 Usage: record save [FILENAME]\n\
826 Default filename is 'gdb_record.PROCESS_ID'."),
827 &record_cmdlist);
828 set_cmd_completer (c, filename_completer);
830 add_cmd ("delete", class_obscure, cmd_record_delete,
831 _("Delete the rest of execution log and start recording it anew."),
832 &record_cmdlist);
833 add_alias_cmd ("d", "delete", class_obscure, 1, &record_cmdlist);
834 add_alias_cmd ("del", "delete", class_obscure, 1, &record_cmdlist);
836 add_cmd ("stop", class_obscure, cmd_record_stop,
837 _("Stop the record/replay target."),
838 &record_cmdlist);
839 add_alias_cmd ("s", "stop", class_obscure, 1, &record_cmdlist);
841 add_prefix_cmd ("goto", class_obscure, cmd_record_goto, _("\
842 Restore the program to its state at instruction number N.\n\
843 Argument is instruction number, as shown by 'info record'."),
844 &record_goto_cmdlist, "record goto ", 1, &record_cmdlist);
846 add_cmd ("begin", class_obscure, cmd_record_goto_begin,
847 _("Go to the beginning of the execution log."),
848 &record_goto_cmdlist);
849 add_alias_cmd ("start", "begin", class_obscure, 1, &record_goto_cmdlist);
851 add_cmd ("end", class_obscure, cmd_record_goto_end,
852 _("Go to the end of the execution log."),
853 &record_goto_cmdlist);
855 add_cmd ("instruction-history", class_obscure, cmd_record_insn_history, _("\
856 Print disassembled instructions stored in the execution log.\n\
857 With a /m or /s modifier, source lines are included (if available).\n\
858 With a /r modifier, raw instructions in hex are included.\n\
859 With a /f modifier, function names are omitted.\n\
860 With a /p modifier, current position markers are omitted.\n\
861 With no argument, disassembles ten more instructions after the previous \
862 disassembly.\n\
863 \"record instruction-history -\" disassembles ten instructions before a \
864 previous disassembly.\n\
865 One argument specifies an instruction number as shown by 'info record', and \
866 ten instructions are disassembled after that instruction.\n\
867 Two arguments with comma between them specify starting and ending instruction \
868 numbers to disassemble.\n\
869 If the second argument is preceded by '+' or '-', it specifies the distance \
870 from the first argument.\n\
871 The number of instructions to disassemble can be defined with \"set record \
872 instruction-history-size\"."),
873 &record_cmdlist);
875 add_cmd ("function-call-history", class_obscure, cmd_record_call_history, _("\
876 Prints the execution history at function granularity.\n\
877 It prints one line for each sequence of instructions that belong to the same \
878 function.\n\
879 Without modifiers, it prints the function name.\n\
880 With a /l modifier, the source file and line number range is included.\n\
881 With a /i modifier, the instruction number range is included.\n\
882 With a /c modifier, the output is indented based on the call stack depth.\n\
883 With no argument, prints ten more lines after the previous ten-line print.\n\
884 \"record function-call-history -\" prints ten lines before a previous ten-line \
885 print.\n\
886 One argument specifies a function number as shown by 'info record', and \
887 ten lines are printed after that function.\n\
888 Two arguments with comma between them specify a range of functions to print.\n\
889 If the second argument is preceded by '+' or '-', it specifies the distance \
890 from the first argument.\n\
891 The number of functions to print can be defined with \"set record \
892 function-call-history-size\"."),
893 &record_cmdlist);
895 /* Sync command control variables. */
896 record_insn_history_size_setshow_var = record_insn_history_size;
897 record_call_history_size_setshow_var = record_call_history_size;