Document the GDB 10.2 release in gdb/ChangeLog
[binutils-gdb.git] / gdb / record-full.c
blob8a035b2663eab04926184fa744a07d952f1df147
1 /* Process record and replay target for GDB, the GNU debugger.
3 Copyright (C) 2013-2021 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 "regcache.h"
23 #include "gdbthread.h"
24 #include "inferior.h"
25 #include "event-top.h"
26 #include "completer.h"
27 #include "arch-utils.h"
28 #include "gdbcore.h"
29 #include "exec.h"
30 #include "record.h"
31 #include "record-full.h"
32 #include "elf-bfd.h"
33 #include "gcore.h"
34 #include "gdbsupport/event-loop.h"
35 #include "inf-loop.h"
36 #include "gdb_bfd.h"
37 #include "observable.h"
38 #include "infrun.h"
39 #include "gdbsupport/gdb_unlinker.h"
40 #include "gdbsupport/byte-vector.h"
41 #include "async-event.h"
43 #include <signal.h>
45 /* This module implements "target record-full", also known as "process
46 record and replay". This target sits on top of a "normal" target
47 (a target that "has execution"), and provides a record and replay
48 functionality, including reverse debugging.
50 Target record has two modes: recording, and replaying.
52 In record mode, we intercept the resume and wait methods.
53 Whenever gdb resumes the target, we run the target in single step
54 mode, and we build up an execution log in which, for each executed
55 instruction, we record all changes in memory and register state.
56 This is invisible to the user, to whom it just looks like an
57 ordinary debugging session (except for performance degradation).
59 In replay mode, instead of actually letting the inferior run as a
60 process, we simulate its execution by playing back the recorded
61 execution log. For each instruction in the log, we simulate the
62 instruction's side effects by duplicating the changes that it would
63 have made on memory and registers. */
65 #define DEFAULT_RECORD_FULL_INSN_MAX_NUM 200000
67 #define RECORD_FULL_IS_REPLAY \
68 (record_full_list->next || ::execution_direction == EXEC_REVERSE)
70 #define RECORD_FULL_FILE_MAGIC netorder32(0x20091016)
72 /* These are the core structs of the process record functionality.
74 A record_full_entry is a record of the value change of a register
75 ("record_full_reg") or a part of memory ("record_full_mem"). And each
76 instruction must have a struct record_full_entry ("record_full_end")
77 that indicates that this is the last struct record_full_entry of this
78 instruction.
80 Each struct record_full_entry is linked to "record_full_list" by "prev"
81 and "next" pointers. */
83 struct record_full_mem_entry
85 CORE_ADDR addr;
86 int len;
87 /* Set this flag if target memory for this entry
88 can no longer be accessed. */
89 int mem_entry_not_accessible;
90 union
92 gdb_byte *ptr;
93 gdb_byte buf[sizeof (gdb_byte *)];
94 } u;
97 struct record_full_reg_entry
99 unsigned short num;
100 unsigned short len;
101 union
103 gdb_byte *ptr;
104 gdb_byte buf[2 * sizeof (gdb_byte *)];
105 } u;
108 struct record_full_end_entry
110 enum gdb_signal sigval;
111 ULONGEST insn_num;
114 enum record_full_type
116 record_full_end = 0,
117 record_full_reg,
118 record_full_mem
121 /* This is the data structure that makes up the execution log.
123 The execution log consists of a single linked list of entries
124 of type "struct record_full_entry". It is doubly linked so that it
125 can be traversed in either direction.
127 The start of the list is anchored by a struct called
128 "record_full_first". The pointer "record_full_list" either points
129 to the last entry that was added to the list (in record mode), or to
130 the next entry in the list that will be executed (in replay mode).
132 Each list element (struct record_full_entry), in addition to next
133 and prev pointers, consists of a union of three entry types: mem,
134 reg, and end. A field called "type" determines which entry type is
135 represented by a given list element.
137 Each instruction that is added to the execution log is represented
138 by a variable number of list elements ('entries'). The instruction
139 will have one "reg" entry for each register that is changed by
140 executing the instruction (including the PC in every case). It
141 will also have one "mem" entry for each memory change. Finally,
142 each instruction will have an "end" entry that separates it from
143 the changes associated with the next instruction. */
145 struct record_full_entry
147 struct record_full_entry *prev;
148 struct record_full_entry *next;
149 enum record_full_type type;
150 union
152 /* reg */
153 struct record_full_reg_entry reg;
154 /* mem */
155 struct record_full_mem_entry mem;
156 /* end */
157 struct record_full_end_entry end;
158 } u;
161 /* If true, query if PREC cannot record memory
162 change of next instruction. */
163 bool record_full_memory_query = false;
165 struct record_full_core_buf_entry
167 struct record_full_core_buf_entry *prev;
168 struct target_section *p;
169 bfd_byte *buf;
172 /* Record buf with core target. */
173 static detached_regcache *record_full_core_regbuf = NULL;
174 static target_section_table record_full_core_sections;
175 static struct record_full_core_buf_entry *record_full_core_buf_list = NULL;
177 /* The following variables are used for managing the linked list that
178 represents the execution log.
180 record_full_first is the anchor that holds down the beginning of
181 the list.
183 record_full_list serves two functions:
184 1) In record mode, it anchors the end of the list.
185 2) In replay mode, it traverses the list and points to
186 the next instruction that must be emulated.
188 record_full_arch_list_head and record_full_arch_list_tail are used
189 to manage a separate list, which is used to build up the change
190 elements of the currently executing instruction during record mode.
191 When this instruction has been completely annotated in the "arch
192 list", it will be appended to the main execution log. */
194 static struct record_full_entry record_full_first;
195 static struct record_full_entry *record_full_list = &record_full_first;
196 static struct record_full_entry *record_full_arch_list_head = NULL;
197 static struct record_full_entry *record_full_arch_list_tail = NULL;
199 /* true ask user. false auto delete the last struct record_full_entry. */
200 static bool record_full_stop_at_limit = true;
201 /* Maximum allowed number of insns in execution log. */
202 static unsigned int record_full_insn_max_num
203 = DEFAULT_RECORD_FULL_INSN_MAX_NUM;
204 /* Actual count of insns presently in execution log. */
205 static unsigned int record_full_insn_num = 0;
206 /* Count of insns logged so far (may be larger
207 than count of insns presently in execution log). */
208 static ULONGEST record_full_insn_count;
210 static const char record_longname[]
211 = N_("Process record and replay target");
212 static const char record_doc[]
213 = N_("Log program while executing and replay execution from log.");
215 /* Base class implementing functionality common to both the
216 "record-full" and "record-core" targets. */
218 class record_full_base_target : public target_ops
220 public:
221 const target_info &info () const override = 0;
223 strata stratum () const override { return record_stratum; }
225 void close () override;
226 void async (int) override;
227 ptid_t wait (ptid_t, struct target_waitstatus *, target_wait_flags) override;
228 bool stopped_by_watchpoint () override;
229 bool stopped_data_address (CORE_ADDR *) override;
231 bool stopped_by_sw_breakpoint () override;
232 bool supports_stopped_by_sw_breakpoint () override;
234 bool stopped_by_hw_breakpoint () override;
235 bool supports_stopped_by_hw_breakpoint () override;
237 bool can_execute_reverse () override;
239 /* Add bookmark target methods. */
240 gdb_byte *get_bookmark (const char *, int) override;
241 void goto_bookmark (const gdb_byte *, int) override;
242 enum exec_direction_kind execution_direction () override;
243 enum record_method record_method (ptid_t ptid) override;
244 void info_record () override;
245 void save_record (const char *filename) override;
246 bool supports_delete_record () override;
247 void delete_record () override;
248 bool record_is_replaying (ptid_t ptid) override;
249 bool record_will_replay (ptid_t ptid, int dir) override;
250 void record_stop_replaying () override;
251 void goto_record_begin () override;
252 void goto_record_end () override;
253 void goto_record (ULONGEST insn) override;
256 /* The "record-full" target. */
258 static const target_info record_full_target_info = {
259 "record-full",
260 record_longname,
261 record_doc,
264 class record_full_target final : public record_full_base_target
266 public:
267 const target_info &info () const override
268 { return record_full_target_info; }
270 void resume (ptid_t, int, enum gdb_signal) override;
271 void disconnect (const char *, int) override;
272 void detach (inferior *, int) override;
273 void mourn_inferior () override;
274 void kill () override;
275 void store_registers (struct regcache *, int) override;
276 enum target_xfer_status xfer_partial (enum target_object object,
277 const char *annex,
278 gdb_byte *readbuf,
279 const gdb_byte *writebuf,
280 ULONGEST offset, ULONGEST len,
281 ULONGEST *xfered_len) override;
282 int insert_breakpoint (struct gdbarch *,
283 struct bp_target_info *) override;
284 int remove_breakpoint (struct gdbarch *,
285 struct bp_target_info *,
286 enum remove_bp_reason) override;
289 /* The "record-core" target. */
291 static const target_info record_full_core_target_info = {
292 "record-core",
293 record_longname,
294 record_doc,
297 class record_full_core_target final : public record_full_base_target
299 public:
300 const target_info &info () const override
301 { return record_full_core_target_info; }
303 void resume (ptid_t, int, enum gdb_signal) override;
304 void disconnect (const char *, int) override;
305 void kill () override;
306 void fetch_registers (struct regcache *regcache, int regno) override;
307 void prepare_to_store (struct regcache *regcache) override;
308 void store_registers (struct regcache *, int) override;
309 enum target_xfer_status xfer_partial (enum target_object object,
310 const char *annex,
311 gdb_byte *readbuf,
312 const gdb_byte *writebuf,
313 ULONGEST offset, ULONGEST len,
314 ULONGEST *xfered_len) override;
315 int insert_breakpoint (struct gdbarch *,
316 struct bp_target_info *) override;
317 int remove_breakpoint (struct gdbarch *,
318 struct bp_target_info *,
319 enum remove_bp_reason) override;
321 bool has_execution (inferior *inf) override;
324 static record_full_target record_full_ops;
325 static record_full_core_target record_full_core_ops;
327 void
328 record_full_target::detach (inferior *inf, int from_tty)
330 record_detach (this, inf, from_tty);
333 void
334 record_full_target::disconnect (const char *args, int from_tty)
336 record_disconnect (this, args, from_tty);
339 void
340 record_full_core_target::disconnect (const char *args, int from_tty)
342 record_disconnect (this, args, from_tty);
345 void
346 record_full_target::mourn_inferior ()
348 record_mourn_inferior (this);
351 void
352 record_full_target::kill ()
354 record_kill (this);
357 /* See record-full.h. */
360 record_full_is_used (void)
362 struct target_ops *t;
364 t = find_record_target ();
365 return (t == &record_full_ops
366 || t == &record_full_core_ops);
370 /* Command lists for "set/show record full". */
371 static struct cmd_list_element *set_record_full_cmdlist;
372 static struct cmd_list_element *show_record_full_cmdlist;
374 /* Command list for "record full". */
375 static struct cmd_list_element *record_full_cmdlist;
377 static void record_full_goto_insn (struct record_full_entry *entry,
378 enum exec_direction_kind dir);
380 /* Alloc and free functions for record_full_reg, record_full_mem, and
381 record_full_end entries. */
383 /* Alloc a record_full_reg record entry. */
385 static inline struct record_full_entry *
386 record_full_reg_alloc (struct regcache *regcache, int regnum)
388 struct record_full_entry *rec;
389 struct gdbarch *gdbarch = regcache->arch ();
391 rec = XCNEW (struct record_full_entry);
392 rec->type = record_full_reg;
393 rec->u.reg.num = regnum;
394 rec->u.reg.len = register_size (gdbarch, regnum);
395 if (rec->u.reg.len > sizeof (rec->u.reg.u.buf))
396 rec->u.reg.u.ptr = (gdb_byte *) xmalloc (rec->u.reg.len);
398 return rec;
401 /* Free a record_full_reg record entry. */
403 static inline void
404 record_full_reg_release (struct record_full_entry *rec)
406 gdb_assert (rec->type == record_full_reg);
407 if (rec->u.reg.len > sizeof (rec->u.reg.u.buf))
408 xfree (rec->u.reg.u.ptr);
409 xfree (rec);
412 /* Alloc a record_full_mem record entry. */
414 static inline struct record_full_entry *
415 record_full_mem_alloc (CORE_ADDR addr, int len)
417 struct record_full_entry *rec;
419 rec = XCNEW (struct record_full_entry);
420 rec->type = record_full_mem;
421 rec->u.mem.addr = addr;
422 rec->u.mem.len = len;
423 if (rec->u.mem.len > sizeof (rec->u.mem.u.buf))
424 rec->u.mem.u.ptr = (gdb_byte *) xmalloc (len);
426 return rec;
429 /* Free a record_full_mem record entry. */
431 static inline void
432 record_full_mem_release (struct record_full_entry *rec)
434 gdb_assert (rec->type == record_full_mem);
435 if (rec->u.mem.len > sizeof (rec->u.mem.u.buf))
436 xfree (rec->u.mem.u.ptr);
437 xfree (rec);
440 /* Alloc a record_full_end record entry. */
442 static inline struct record_full_entry *
443 record_full_end_alloc (void)
445 struct record_full_entry *rec;
447 rec = XCNEW (struct record_full_entry);
448 rec->type = record_full_end;
450 return rec;
453 /* Free a record_full_end record entry. */
455 static inline void
456 record_full_end_release (struct record_full_entry *rec)
458 xfree (rec);
461 /* Free one record entry, any type.
462 Return entry->type, in case caller wants to know. */
464 static inline enum record_full_type
465 record_full_entry_release (struct record_full_entry *rec)
467 enum record_full_type type = rec->type;
469 switch (type) {
470 case record_full_reg:
471 record_full_reg_release (rec);
472 break;
473 case record_full_mem:
474 record_full_mem_release (rec);
475 break;
476 case record_full_end:
477 record_full_end_release (rec);
478 break;
480 return type;
483 /* Free all record entries in list pointed to by REC. */
485 static void
486 record_full_list_release (struct record_full_entry *rec)
488 if (!rec)
489 return;
491 while (rec->next)
492 rec = rec->next;
494 while (rec->prev)
496 rec = rec->prev;
497 record_full_entry_release (rec->next);
500 if (rec == &record_full_first)
502 record_full_insn_num = 0;
503 record_full_first.next = NULL;
505 else
506 record_full_entry_release (rec);
509 /* Free all record entries forward of the given list position. */
511 static void
512 record_full_list_release_following (struct record_full_entry *rec)
514 struct record_full_entry *tmp = rec->next;
516 rec->next = NULL;
517 while (tmp)
519 rec = tmp->next;
520 if (record_full_entry_release (tmp) == record_full_end)
522 record_full_insn_num--;
523 record_full_insn_count--;
525 tmp = rec;
529 /* Delete the first instruction from the beginning of the log, to make
530 room for adding a new instruction at the end of the log.
532 Note -- this function does not modify record_full_insn_num. */
534 static void
535 record_full_list_release_first (void)
537 struct record_full_entry *tmp;
539 if (!record_full_first.next)
540 return;
542 /* Loop until a record_full_end. */
543 while (1)
545 /* Cut record_full_first.next out of the linked list. */
546 tmp = record_full_first.next;
547 record_full_first.next = tmp->next;
548 tmp->next->prev = &record_full_first;
550 /* tmp is now isolated, and can be deleted. */
551 if (record_full_entry_release (tmp) == record_full_end)
552 break; /* End loop at first record_full_end. */
554 if (!record_full_first.next)
556 gdb_assert (record_full_insn_num == 1);
557 break; /* End loop when list is empty. */
562 /* Add a struct record_full_entry to record_full_arch_list. */
564 static void
565 record_full_arch_list_add (struct record_full_entry *rec)
567 if (record_debug > 1)
568 fprintf_unfiltered (gdb_stdlog,
569 "Process record: record_full_arch_list_add %s.\n",
570 host_address_to_string (rec));
572 if (record_full_arch_list_tail)
574 record_full_arch_list_tail->next = rec;
575 rec->prev = record_full_arch_list_tail;
576 record_full_arch_list_tail = rec;
578 else
580 record_full_arch_list_head = rec;
581 record_full_arch_list_tail = rec;
585 /* Return the value storage location of a record entry. */
586 static inline gdb_byte *
587 record_full_get_loc (struct record_full_entry *rec)
589 switch (rec->type) {
590 case record_full_mem:
591 if (rec->u.mem.len > sizeof (rec->u.mem.u.buf))
592 return rec->u.mem.u.ptr;
593 else
594 return rec->u.mem.u.buf;
595 case record_full_reg:
596 if (rec->u.reg.len > sizeof (rec->u.reg.u.buf))
597 return rec->u.reg.u.ptr;
598 else
599 return rec->u.reg.u.buf;
600 case record_full_end:
601 default:
602 gdb_assert_not_reached ("unexpected record_full_entry type");
603 return NULL;
607 /* Record the value of a register NUM to record_full_arch_list. */
610 record_full_arch_list_add_reg (struct regcache *regcache, int regnum)
612 struct record_full_entry *rec;
614 if (record_debug > 1)
615 fprintf_unfiltered (gdb_stdlog,
616 "Process record: add register num = %d to "
617 "record list.\n",
618 regnum);
620 rec = record_full_reg_alloc (regcache, regnum);
622 regcache->raw_read (regnum, record_full_get_loc (rec));
624 record_full_arch_list_add (rec);
626 return 0;
629 /* Record the value of a region of memory whose address is ADDR and
630 length is LEN to record_full_arch_list. */
633 record_full_arch_list_add_mem (CORE_ADDR addr, int len)
635 struct record_full_entry *rec;
637 if (record_debug > 1)
638 fprintf_unfiltered (gdb_stdlog,
639 "Process record: add mem addr = %s len = %d to "
640 "record list.\n",
641 paddress (target_gdbarch (), addr), len);
643 if (!addr) /* FIXME: Why? Some arch must permit it... */
644 return 0;
646 rec = record_full_mem_alloc (addr, len);
648 if (record_read_memory (target_gdbarch (), addr,
649 record_full_get_loc (rec), len))
651 record_full_mem_release (rec);
652 return -1;
655 record_full_arch_list_add (rec);
657 return 0;
660 /* Add a record_full_end type struct record_full_entry to
661 record_full_arch_list. */
664 record_full_arch_list_add_end (void)
666 struct record_full_entry *rec;
668 if (record_debug > 1)
669 fprintf_unfiltered (gdb_stdlog,
670 "Process record: add end to arch list.\n");
672 rec = record_full_end_alloc ();
673 rec->u.end.sigval = GDB_SIGNAL_0;
674 rec->u.end.insn_num = ++record_full_insn_count;
676 record_full_arch_list_add (rec);
678 return 0;
681 static void
682 record_full_check_insn_num (void)
684 if (record_full_insn_num == record_full_insn_max_num)
686 /* Ask user what to do. */
687 if (record_full_stop_at_limit)
689 if (!yquery (_("Do you want to auto delete previous execution "
690 "log entries when record/replay buffer becomes "
691 "full (record full stop-at-limit)?")))
692 error (_("Process record: stopped by user."));
693 record_full_stop_at_limit = 0;
698 /* Before inferior step (when GDB record the running message, inferior
699 only can step), GDB will call this function to record the values to
700 record_full_list. This function will call gdbarch_process_record to
701 record the running message of inferior and set them to
702 record_full_arch_list, and add it to record_full_list. */
704 static void
705 record_full_message (struct regcache *regcache, enum gdb_signal signal)
707 int ret;
708 struct gdbarch *gdbarch = regcache->arch ();
712 record_full_arch_list_head = NULL;
713 record_full_arch_list_tail = NULL;
715 /* Check record_full_insn_num. */
716 record_full_check_insn_num ();
718 /* If gdb sends a signal value to target_resume,
719 save it in the 'end' field of the previous instruction.
721 Maybe process record should record what really happened,
722 rather than what gdb pretends has happened.
724 So if Linux delivered the signal to the child process during
725 the record mode, we will record it and deliver it again in
726 the replay mode.
728 If user says "ignore this signal" during the record mode, then
729 it will be ignored again during the replay mode (no matter if
730 the user says something different, like "deliver this signal"
731 during the replay mode).
733 User should understand that nothing he does during the replay
734 mode will change the behavior of the child. If he tries,
735 then that is a user error.
737 But we should still deliver the signal to gdb during the replay,
738 if we delivered it during the recording. Therefore we should
739 record the signal during record_full_wait, not
740 record_full_resume. */
741 if (record_full_list != &record_full_first) /* FIXME better way
742 to check */
744 gdb_assert (record_full_list->type == record_full_end);
745 record_full_list->u.end.sigval = signal;
748 if (signal == GDB_SIGNAL_0
749 || !gdbarch_process_record_signal_p (gdbarch))
750 ret = gdbarch_process_record (gdbarch,
751 regcache,
752 regcache_read_pc (regcache));
753 else
754 ret = gdbarch_process_record_signal (gdbarch,
755 regcache,
756 signal);
758 if (ret > 0)
759 error (_("Process record: inferior program stopped."));
760 if (ret < 0)
761 error (_("Process record: failed to record execution log."));
763 catch (const gdb_exception &ex)
765 record_full_list_release (record_full_arch_list_tail);
766 throw;
769 record_full_list->next = record_full_arch_list_head;
770 record_full_arch_list_head->prev = record_full_list;
771 record_full_list = record_full_arch_list_tail;
773 if (record_full_insn_num == record_full_insn_max_num)
774 record_full_list_release_first ();
775 else
776 record_full_insn_num++;
779 static bool
780 record_full_message_wrapper_safe (struct regcache *regcache,
781 enum gdb_signal signal)
785 record_full_message (regcache, signal);
787 catch (const gdb_exception &ex)
789 exception_print (gdb_stderr, ex);
790 return false;
793 return true;
796 /* Set to 1 if record_full_store_registers and record_full_xfer_partial
797 doesn't need record. */
799 static int record_full_gdb_operation_disable = 0;
801 scoped_restore_tmpl<int>
802 record_full_gdb_operation_disable_set (void)
804 return make_scoped_restore (&record_full_gdb_operation_disable, 1);
807 /* Flag set to TRUE for target_stopped_by_watchpoint. */
808 static enum target_stop_reason record_full_stop_reason
809 = TARGET_STOPPED_BY_NO_REASON;
811 /* Execute one instruction from the record log. Each instruction in
812 the log will be represented by an arbitrary sequence of register
813 entries and memory entries, followed by an 'end' entry. */
815 static inline void
816 record_full_exec_insn (struct regcache *regcache,
817 struct gdbarch *gdbarch,
818 struct record_full_entry *entry)
820 switch (entry->type)
822 case record_full_reg: /* reg */
824 gdb::byte_vector reg (entry->u.reg.len);
826 if (record_debug > 1)
827 fprintf_unfiltered (gdb_stdlog,
828 "Process record: record_full_reg %s to "
829 "inferior num = %d.\n",
830 host_address_to_string (entry),
831 entry->u.reg.num);
833 regcache->cooked_read (entry->u.reg.num, reg.data ());
834 regcache->cooked_write (entry->u.reg.num, record_full_get_loc (entry));
835 memcpy (record_full_get_loc (entry), reg.data (), entry->u.reg.len);
837 break;
839 case record_full_mem: /* mem */
841 /* Nothing to do if the entry is flagged not_accessible. */
842 if (!entry->u.mem.mem_entry_not_accessible)
844 gdb::byte_vector mem (entry->u.mem.len);
846 if (record_debug > 1)
847 fprintf_unfiltered (gdb_stdlog,
848 "Process record: record_full_mem %s to "
849 "inferior addr = %s len = %d.\n",
850 host_address_to_string (entry),
851 paddress (gdbarch, entry->u.mem.addr),
852 entry->u.mem.len);
854 if (record_read_memory (gdbarch,
855 entry->u.mem.addr, mem.data (),
856 entry->u.mem.len))
857 entry->u.mem.mem_entry_not_accessible = 1;
858 else
860 if (target_write_memory (entry->u.mem.addr,
861 record_full_get_loc (entry),
862 entry->u.mem.len))
864 entry->u.mem.mem_entry_not_accessible = 1;
865 if (record_debug)
866 warning (_("Process record: error writing memory at "
867 "addr = %s len = %d."),
868 paddress (gdbarch, entry->u.mem.addr),
869 entry->u.mem.len);
871 else
873 memcpy (record_full_get_loc (entry), mem.data (),
874 entry->u.mem.len);
876 /* We've changed memory --- check if a hardware
877 watchpoint should trap. Note that this
878 presently assumes the target beneath supports
879 continuable watchpoints. On non-continuable
880 watchpoints target, we'll want to check this
881 _before_ actually doing the memory change, and
882 not doing the change at all if the watchpoint
883 traps. */
884 if (hardware_watchpoint_inserted_in_range
885 (regcache->aspace (),
886 entry->u.mem.addr, entry->u.mem.len))
887 record_full_stop_reason = TARGET_STOPPED_BY_WATCHPOINT;
892 break;
896 static void record_full_restore (void);
898 /* Asynchronous signal handle registered as event loop source for when
899 we have pending events ready to be passed to the core. */
901 static struct async_event_handler *record_full_async_inferior_event_token;
903 static void
904 record_full_async_inferior_event_handler (gdb_client_data data)
906 inferior_event_handler (INF_REG_EVENT);
909 /* Open the process record target for 'core' files. */
911 static void
912 record_full_core_open_1 (const char *name, int from_tty)
914 struct regcache *regcache = get_current_regcache ();
915 int regnum = gdbarch_num_regs (regcache->arch ());
916 int i;
918 /* Get record_full_core_regbuf. */
919 target_fetch_registers (regcache, -1);
920 record_full_core_regbuf = new detached_regcache (regcache->arch (), false);
922 for (i = 0; i < regnum; i ++)
923 record_full_core_regbuf->raw_supply (i, *regcache);
925 record_full_core_sections = build_section_table (core_bfd);
927 current_inferior ()->push_target (&record_full_core_ops);
928 record_full_restore ();
931 /* Open the process record target for 'live' processes. */
933 static void
934 record_full_open_1 (const char *name, int from_tty)
936 if (record_debug)
937 fprintf_unfiltered (gdb_stdlog, "Process record: record_full_open_1\n");
939 /* check exec */
940 if (!target_has_execution ())
941 error (_("Process record: the program is not being run."));
942 if (non_stop)
943 error (_("Process record target can't debug inferior in non-stop mode "
944 "(non-stop)."));
946 if (!gdbarch_process_record_p (target_gdbarch ()))
947 error (_("Process record: the current architecture doesn't support "
948 "record function."));
950 current_inferior ()->push_target (&record_full_ops);
953 static void record_full_init_record_breakpoints (void);
955 /* Open the process record target. */
957 static void
958 record_full_open (const char *name, int from_tty)
960 if (record_debug)
961 fprintf_unfiltered (gdb_stdlog, "Process record: record_full_open\n");
963 record_preopen ();
965 /* Reset */
966 record_full_insn_num = 0;
967 record_full_insn_count = 0;
968 record_full_list = &record_full_first;
969 record_full_list->next = NULL;
971 if (core_bfd)
972 record_full_core_open_1 (name, from_tty);
973 else
974 record_full_open_1 (name, from_tty);
976 /* Register extra event sources in the event loop. */
977 record_full_async_inferior_event_token
978 = create_async_event_handler (record_full_async_inferior_event_handler,
979 NULL, "record-full");
981 record_full_init_record_breakpoints ();
983 gdb::observers::record_changed.notify (current_inferior (), 1, "full", NULL);
986 /* "close" target method. Close the process record target. */
988 void
989 record_full_base_target::close ()
991 struct record_full_core_buf_entry *entry;
993 if (record_debug)
994 fprintf_unfiltered (gdb_stdlog, "Process record: record_full_close\n");
996 record_full_list_release (record_full_list);
998 /* Release record_full_core_regbuf. */
999 if (record_full_core_regbuf)
1001 delete record_full_core_regbuf;
1002 record_full_core_regbuf = NULL;
1005 /* Release record_full_core_buf_list. */
1006 while (record_full_core_buf_list)
1008 entry = record_full_core_buf_list;
1009 record_full_core_buf_list = record_full_core_buf_list->prev;
1010 xfree (entry);
1013 if (record_full_async_inferior_event_token)
1014 delete_async_event_handler (&record_full_async_inferior_event_token);
1017 /* "async" target method. */
1019 void
1020 record_full_base_target::async (int enable)
1022 if (enable)
1023 mark_async_event_handler (record_full_async_inferior_event_token);
1024 else
1025 clear_async_event_handler (record_full_async_inferior_event_token);
1027 beneath ()->async (enable);
1030 /* The PTID and STEP arguments last passed to
1031 record_full_target::resume. */
1032 static ptid_t record_full_resume_ptid = null_ptid;
1033 static int record_full_resume_step = 0;
1035 /* True if we've been resumed, and so each record_full_wait call should
1036 advance execution. If this is false, record_full_wait will return a
1037 TARGET_WAITKIND_IGNORE. */
1038 static int record_full_resumed = 0;
1040 /* The execution direction of the last resume we got. This is
1041 necessary for async mode. Vis (order is not strictly accurate):
1043 1. user has the global execution direction set to forward
1044 2. user does a reverse-step command
1045 3. record_full_resume is called with global execution direction
1046 temporarily switched to reverse
1047 4. GDB's execution direction is reverted back to forward
1048 5. target record notifies event loop there's an event to handle
1049 6. infrun asks the target which direction was it going, and switches
1050 the global execution direction accordingly (to reverse)
1051 7. infrun polls an event out of the record target, and handles it
1052 8. GDB goes back to the event loop, and goto #4.
1054 static enum exec_direction_kind record_full_execution_dir = EXEC_FORWARD;
1056 /* "resume" target method. Resume the process record target. */
1058 void
1059 record_full_target::resume (ptid_t ptid, int step, enum gdb_signal signal)
1061 record_full_resume_ptid = inferior_ptid;
1062 record_full_resume_step = step;
1063 record_full_resumed = 1;
1064 record_full_execution_dir = ::execution_direction;
1066 if (!RECORD_FULL_IS_REPLAY)
1068 struct gdbarch *gdbarch = target_thread_architecture (ptid);
1070 record_full_message (get_current_regcache (), signal);
1072 if (!step)
1074 /* This is not hard single step. */
1075 if (!gdbarch_software_single_step_p (gdbarch))
1077 /* This is a normal continue. */
1078 step = 1;
1080 else
1082 /* This arch supports soft single step. */
1083 if (thread_has_single_step_breakpoints_set (inferior_thread ()))
1085 /* This is a soft single step. */
1086 record_full_resume_step = 1;
1088 else
1089 step = !insert_single_step_breakpoints (gdbarch);
1093 /* Make sure the target beneath reports all signals. */
1094 target_pass_signals ({});
1096 this->beneath ()->resume (ptid, step, signal);
1099 /* We are about to start executing the inferior (or simulate it),
1100 let's register it with the event loop. */
1101 if (target_can_async_p ())
1102 target_async (1);
1105 static int record_full_get_sig = 0;
1107 /* SIGINT signal handler, registered by "wait" method. */
1109 static void
1110 record_full_sig_handler (int signo)
1112 if (record_debug)
1113 fprintf_unfiltered (gdb_stdlog, "Process record: get a signal\n");
1115 /* It will break the running inferior in replay mode. */
1116 record_full_resume_step = 1;
1118 /* It will let record_full_wait set inferior status to get the signal
1119 SIGINT. */
1120 record_full_get_sig = 1;
1123 /* "wait" target method for process record target.
1125 In record mode, the target is always run in singlestep mode
1126 (even when gdb says to continue). The wait method intercepts
1127 the stop events and determines which ones are to be passed on to
1128 gdb. Most stop events are just singlestep events that gdb is not
1129 to know about, so the wait method just records them and keeps
1130 singlestepping.
1132 In replay mode, this function emulates the recorded execution log,
1133 one instruction at a time (forward or backward), and determines
1134 where to stop. */
1136 static ptid_t
1137 record_full_wait_1 (struct target_ops *ops,
1138 ptid_t ptid, struct target_waitstatus *status,
1139 target_wait_flags options)
1141 scoped_restore restore_operation_disable
1142 = record_full_gdb_operation_disable_set ();
1144 if (record_debug)
1145 fprintf_unfiltered (gdb_stdlog,
1146 "Process record: record_full_wait "
1147 "record_full_resume_step = %d, "
1148 "record_full_resumed = %d, direction=%s\n",
1149 record_full_resume_step, record_full_resumed,
1150 record_full_execution_dir == EXEC_FORWARD
1151 ? "forward" : "reverse");
1153 if (!record_full_resumed)
1155 gdb_assert ((options & TARGET_WNOHANG) != 0);
1157 /* No interesting event. */
1158 status->kind = TARGET_WAITKIND_IGNORE;
1159 return minus_one_ptid;
1162 record_full_get_sig = 0;
1163 signal (SIGINT, record_full_sig_handler);
1165 record_full_stop_reason = TARGET_STOPPED_BY_NO_REASON;
1167 if (!RECORD_FULL_IS_REPLAY && ops != &record_full_core_ops)
1169 if (record_full_resume_step)
1171 /* This is a single step. */
1172 return ops->beneath ()->wait (ptid, status, options);
1174 else
1176 /* This is not a single step. */
1177 ptid_t ret;
1178 CORE_ADDR tmp_pc;
1179 struct gdbarch *gdbarch
1180 = target_thread_architecture (record_full_resume_ptid);
1182 while (1)
1184 ret = ops->beneath ()->wait (ptid, status, options);
1185 if (status->kind == TARGET_WAITKIND_IGNORE)
1187 if (record_debug)
1188 fprintf_unfiltered (gdb_stdlog,
1189 "Process record: record_full_wait "
1190 "target beneath not done yet\n");
1191 return ret;
1194 for (thread_info *tp : all_non_exited_threads ())
1195 delete_single_step_breakpoints (tp);
1197 if (record_full_resume_step)
1198 return ret;
1200 /* Is this a SIGTRAP? */
1201 if (status->kind == TARGET_WAITKIND_STOPPED
1202 && status->value.sig == GDB_SIGNAL_TRAP)
1204 struct regcache *regcache;
1205 enum target_stop_reason *stop_reason_p
1206 = &record_full_stop_reason;
1208 /* Yes -- this is likely our single-step finishing,
1209 but check if there's any reason the core would be
1210 interested in the event. */
1212 registers_changed ();
1213 switch_to_thread (current_inferior ()->process_target (),
1214 ret);
1215 regcache = get_current_regcache ();
1216 tmp_pc = regcache_read_pc (regcache);
1217 const struct address_space *aspace = regcache->aspace ();
1219 if (target_stopped_by_watchpoint ())
1221 /* Always interested in watchpoints. */
1223 else if (record_check_stopped_by_breakpoint (aspace, tmp_pc,
1224 stop_reason_p))
1226 /* There is a breakpoint here. Let the core
1227 handle it. */
1229 else
1231 /* This is a single-step trap. Record the
1232 insn and issue another step.
1233 FIXME: this part can be a random SIGTRAP too.
1234 But GDB cannot handle it. */
1235 int step = 1;
1237 if (!record_full_message_wrapper_safe (regcache,
1238 GDB_SIGNAL_0))
1240 status->kind = TARGET_WAITKIND_STOPPED;
1241 status->value.sig = GDB_SIGNAL_0;
1242 break;
1245 process_stratum_target *proc_target
1246 = current_inferior ()->process_target ();
1248 if (gdbarch_software_single_step_p (gdbarch))
1250 /* Try to insert the software single step breakpoint.
1251 If insert success, set step to 0. */
1252 set_executing (proc_target, inferior_ptid, false);
1253 reinit_frame_cache ();
1255 step = !insert_single_step_breakpoints (gdbarch);
1257 set_executing (proc_target, inferior_ptid, true);
1260 if (record_debug)
1261 fprintf_unfiltered (gdb_stdlog,
1262 "Process record: record_full_wait "
1263 "issuing one more step in the "
1264 "target beneath\n");
1265 ops->beneath ()->resume (ptid, step, GDB_SIGNAL_0);
1266 proc_target->commit_resumed_state = true;
1267 proc_target->commit_resumed ();
1268 proc_target->commit_resumed_state = false;
1269 continue;
1273 /* The inferior is broken by a breakpoint or a signal. */
1274 break;
1277 return ret;
1280 else
1282 switch_to_thread (current_inferior ()->process_target (),
1283 record_full_resume_ptid);
1284 struct regcache *regcache = get_current_regcache ();
1285 struct gdbarch *gdbarch = regcache->arch ();
1286 const struct address_space *aspace = regcache->aspace ();
1287 int continue_flag = 1;
1288 int first_record_full_end = 1;
1292 CORE_ADDR tmp_pc;
1294 record_full_stop_reason = TARGET_STOPPED_BY_NO_REASON;
1295 status->kind = TARGET_WAITKIND_STOPPED;
1297 /* Check breakpoint when forward execute. */
1298 if (execution_direction == EXEC_FORWARD)
1300 tmp_pc = regcache_read_pc (regcache);
1301 if (record_check_stopped_by_breakpoint (aspace, tmp_pc,
1302 &record_full_stop_reason))
1304 if (record_debug)
1305 fprintf_unfiltered (gdb_stdlog,
1306 "Process record: break at %s.\n",
1307 paddress (gdbarch, tmp_pc));
1308 goto replay_out;
1312 /* If GDB is in terminal_inferior mode, it will not get the
1313 signal. And in GDB replay mode, GDB doesn't need to be
1314 in terminal_inferior mode, because inferior will not
1315 executed. Then set it to terminal_ours to make GDB get
1316 the signal. */
1317 target_terminal::ours ();
1319 /* In EXEC_FORWARD mode, record_full_list points to the tail of prev
1320 instruction. */
1321 if (execution_direction == EXEC_FORWARD && record_full_list->next)
1322 record_full_list = record_full_list->next;
1324 /* Loop over the record_full_list, looking for the next place to
1325 stop. */
1328 /* Check for beginning and end of log. */
1329 if (execution_direction == EXEC_REVERSE
1330 && record_full_list == &record_full_first)
1332 /* Hit beginning of record log in reverse. */
1333 status->kind = TARGET_WAITKIND_NO_HISTORY;
1334 break;
1336 if (execution_direction != EXEC_REVERSE
1337 && !record_full_list->next)
1339 /* Hit end of record log going forward. */
1340 status->kind = TARGET_WAITKIND_NO_HISTORY;
1341 break;
1344 record_full_exec_insn (regcache, gdbarch, record_full_list);
1346 if (record_full_list->type == record_full_end)
1348 if (record_debug > 1)
1349 fprintf_unfiltered
1350 (gdb_stdlog,
1351 "Process record: record_full_end %s to "
1352 "inferior.\n",
1353 host_address_to_string (record_full_list));
1355 if (first_record_full_end
1356 && execution_direction == EXEC_REVERSE)
1358 /* When reverse execute, the first
1359 record_full_end is the part of current
1360 instruction. */
1361 first_record_full_end = 0;
1363 else
1365 /* In EXEC_REVERSE mode, this is the
1366 record_full_end of prev instruction. In
1367 EXEC_FORWARD mode, this is the
1368 record_full_end of current instruction. */
1369 /* step */
1370 if (record_full_resume_step)
1372 if (record_debug > 1)
1373 fprintf_unfiltered (gdb_stdlog,
1374 "Process record: step.\n");
1375 continue_flag = 0;
1378 /* check breakpoint */
1379 tmp_pc = regcache_read_pc (regcache);
1380 if (record_check_stopped_by_breakpoint
1381 (aspace, tmp_pc, &record_full_stop_reason))
1383 if (record_debug)
1384 fprintf_unfiltered (gdb_stdlog,
1385 "Process record: break "
1386 "at %s.\n",
1387 paddress (gdbarch, tmp_pc));
1389 continue_flag = 0;
1392 if (record_full_stop_reason
1393 == TARGET_STOPPED_BY_WATCHPOINT)
1395 if (record_debug)
1396 fprintf_unfiltered (gdb_stdlog,
1397 "Process record: hit hw "
1398 "watchpoint.\n");
1399 continue_flag = 0;
1401 /* Check target signal */
1402 if (record_full_list->u.end.sigval != GDB_SIGNAL_0)
1403 /* FIXME: better way to check */
1404 continue_flag = 0;
1408 if (continue_flag)
1410 if (execution_direction == EXEC_REVERSE)
1412 if (record_full_list->prev)
1413 record_full_list = record_full_list->prev;
1415 else
1417 if (record_full_list->next)
1418 record_full_list = record_full_list->next;
1422 while (continue_flag);
1424 replay_out:
1425 if (record_full_get_sig)
1426 status->value.sig = GDB_SIGNAL_INT;
1427 else if (record_full_list->u.end.sigval != GDB_SIGNAL_0)
1428 /* FIXME: better way to check */
1429 status->value.sig = record_full_list->u.end.sigval;
1430 else
1431 status->value.sig = GDB_SIGNAL_TRAP;
1433 catch (const gdb_exception &ex)
1435 if (execution_direction == EXEC_REVERSE)
1437 if (record_full_list->next)
1438 record_full_list = record_full_list->next;
1440 else
1441 record_full_list = record_full_list->prev;
1443 throw;
1447 signal (SIGINT, handle_sigint);
1449 return inferior_ptid;
1452 ptid_t
1453 record_full_base_target::wait (ptid_t ptid, struct target_waitstatus *status,
1454 target_wait_flags options)
1456 ptid_t return_ptid;
1458 clear_async_event_handler (record_full_async_inferior_event_token);
1460 return_ptid = record_full_wait_1 (this, ptid, status, options);
1461 if (status->kind != TARGET_WAITKIND_IGNORE)
1463 /* We're reporting a stop. Make sure any spurious
1464 target_wait(WNOHANG) doesn't advance the target until the
1465 core wants us resumed again. */
1466 record_full_resumed = 0;
1468 return return_ptid;
1471 bool
1472 record_full_base_target::stopped_by_watchpoint ()
1474 if (RECORD_FULL_IS_REPLAY)
1475 return record_full_stop_reason == TARGET_STOPPED_BY_WATCHPOINT;
1476 else
1477 return beneath ()->stopped_by_watchpoint ();
1480 bool
1481 record_full_base_target::stopped_data_address (CORE_ADDR *addr_p)
1483 if (RECORD_FULL_IS_REPLAY)
1484 return false;
1485 else
1486 return this->beneath ()->stopped_data_address (addr_p);
1489 /* The stopped_by_sw_breakpoint method of target record-full. */
1491 bool
1492 record_full_base_target::stopped_by_sw_breakpoint ()
1494 return record_full_stop_reason == TARGET_STOPPED_BY_SW_BREAKPOINT;
1497 /* The supports_stopped_by_sw_breakpoint method of target
1498 record-full. */
1500 bool
1501 record_full_base_target::supports_stopped_by_sw_breakpoint ()
1503 return true;
1506 /* The stopped_by_hw_breakpoint method of target record-full. */
1508 bool
1509 record_full_base_target::stopped_by_hw_breakpoint ()
1511 return record_full_stop_reason == TARGET_STOPPED_BY_HW_BREAKPOINT;
1514 /* The supports_stopped_by_sw_breakpoint method of target
1515 record-full. */
1517 bool
1518 record_full_base_target::supports_stopped_by_hw_breakpoint ()
1520 return true;
1523 /* Record registers change (by user or by GDB) to list as an instruction. */
1525 static void
1526 record_full_registers_change (struct regcache *regcache, int regnum)
1528 /* Check record_full_insn_num. */
1529 record_full_check_insn_num ();
1531 record_full_arch_list_head = NULL;
1532 record_full_arch_list_tail = NULL;
1534 if (regnum < 0)
1536 int i;
1538 for (i = 0; i < gdbarch_num_regs (regcache->arch ()); i++)
1540 if (record_full_arch_list_add_reg (regcache, i))
1542 record_full_list_release (record_full_arch_list_tail);
1543 error (_("Process record: failed to record execution log."));
1547 else
1549 if (record_full_arch_list_add_reg (regcache, regnum))
1551 record_full_list_release (record_full_arch_list_tail);
1552 error (_("Process record: failed to record execution log."));
1555 if (record_full_arch_list_add_end ())
1557 record_full_list_release (record_full_arch_list_tail);
1558 error (_("Process record: failed to record execution log."));
1560 record_full_list->next = record_full_arch_list_head;
1561 record_full_arch_list_head->prev = record_full_list;
1562 record_full_list = record_full_arch_list_tail;
1564 if (record_full_insn_num == record_full_insn_max_num)
1565 record_full_list_release_first ();
1566 else
1567 record_full_insn_num++;
1570 /* "store_registers" method for process record target. */
1572 void
1573 record_full_target::store_registers (struct regcache *regcache, int regno)
1575 if (!record_full_gdb_operation_disable)
1577 if (RECORD_FULL_IS_REPLAY)
1579 int n;
1581 /* Let user choose if he wants to write register or not. */
1582 if (regno < 0)
1584 query (_("Because GDB is in replay mode, changing the "
1585 "value of a register will make the execution "
1586 "log unusable from this point onward. "
1587 "Change all registers?"));
1588 else
1590 query (_("Because GDB is in replay mode, changing the value "
1591 "of a register will make the execution log unusable "
1592 "from this point onward. Change register %s?"),
1593 gdbarch_register_name (regcache->arch (),
1594 regno));
1596 if (!n)
1598 /* Invalidate the value of regcache that was set in function
1599 "regcache_raw_write". */
1600 if (regno < 0)
1602 int i;
1604 for (i = 0;
1605 i < gdbarch_num_regs (regcache->arch ());
1606 i++)
1607 regcache->invalidate (i);
1609 else
1610 regcache->invalidate (regno);
1612 error (_("Process record canceled the operation."));
1615 /* Destroy the record from here forward. */
1616 record_full_list_release_following (record_full_list);
1619 record_full_registers_change (regcache, regno);
1621 this->beneath ()->store_registers (regcache, regno);
1624 /* "xfer_partial" method. Behavior is conditional on
1625 RECORD_FULL_IS_REPLAY.
1626 In replay mode, we cannot write memory unles we are willing to
1627 invalidate the record/replay log from this point forward. */
1629 enum target_xfer_status
1630 record_full_target::xfer_partial (enum target_object object,
1631 const char *annex, gdb_byte *readbuf,
1632 const gdb_byte *writebuf, ULONGEST offset,
1633 ULONGEST len, ULONGEST *xfered_len)
1635 if (!record_full_gdb_operation_disable
1636 && (object == TARGET_OBJECT_MEMORY
1637 || object == TARGET_OBJECT_RAW_MEMORY) && writebuf)
1639 if (RECORD_FULL_IS_REPLAY)
1641 /* Let user choose if he wants to write memory or not. */
1642 if (!query (_("Because GDB is in replay mode, writing to memory "
1643 "will make the execution log unusable from this "
1644 "point onward. Write memory at address %s?"),
1645 paddress (target_gdbarch (), offset)))
1646 error (_("Process record canceled the operation."));
1648 /* Destroy the record from here forward. */
1649 record_full_list_release_following (record_full_list);
1652 /* Check record_full_insn_num */
1653 record_full_check_insn_num ();
1655 /* Record registers change to list as an instruction. */
1656 record_full_arch_list_head = NULL;
1657 record_full_arch_list_tail = NULL;
1658 if (record_full_arch_list_add_mem (offset, len))
1660 record_full_list_release (record_full_arch_list_tail);
1661 if (record_debug)
1662 fprintf_unfiltered (gdb_stdlog,
1663 "Process record: failed to record "
1664 "execution log.");
1665 return TARGET_XFER_E_IO;
1667 if (record_full_arch_list_add_end ())
1669 record_full_list_release (record_full_arch_list_tail);
1670 if (record_debug)
1671 fprintf_unfiltered (gdb_stdlog,
1672 "Process record: failed to record "
1673 "execution log.");
1674 return TARGET_XFER_E_IO;
1676 record_full_list->next = record_full_arch_list_head;
1677 record_full_arch_list_head->prev = record_full_list;
1678 record_full_list = record_full_arch_list_tail;
1680 if (record_full_insn_num == record_full_insn_max_num)
1681 record_full_list_release_first ();
1682 else
1683 record_full_insn_num++;
1686 return this->beneath ()->xfer_partial (object, annex, readbuf, writebuf,
1687 offset, len, xfered_len);
1690 /* This structure represents a breakpoint inserted while the record
1691 target is active. We use this to know when to install/remove
1692 breakpoints in/from the target beneath. For example, a breakpoint
1693 may be inserted while recording, but removed when not replaying nor
1694 recording. In that case, the breakpoint had not been inserted on
1695 the target beneath, so we should not try to remove it there. */
1697 struct record_full_breakpoint
1699 record_full_breakpoint (struct address_space *address_space_,
1700 CORE_ADDR addr_,
1701 bool in_target_beneath_)
1702 : address_space (address_space_),
1703 addr (addr_),
1704 in_target_beneath (in_target_beneath_)
1708 /* The address and address space the breakpoint was set at. */
1709 struct address_space *address_space;
1710 CORE_ADDR addr;
1712 /* True when the breakpoint has been also installed in the target
1713 beneath. This will be false for breakpoints set during replay or
1714 when recording. */
1715 bool in_target_beneath;
1718 /* The list of breakpoints inserted while the record target is
1719 active. */
1720 static std::vector<record_full_breakpoint> record_full_breakpoints;
1722 static void
1723 record_full_sync_record_breakpoints (struct bp_location *loc)
1725 if (loc->loc_type != bp_loc_software_breakpoint)
1726 return;
1728 if (loc->inserted)
1730 record_full_breakpoints.emplace_back
1731 (loc->target_info.placed_address_space,
1732 loc->target_info.placed_address,
1737 /* Sync existing breakpoints to record_full_breakpoints. */
1739 static void
1740 record_full_init_record_breakpoints (void)
1742 record_full_breakpoints.clear ();
1744 iterate_over_bp_locations (record_full_sync_record_breakpoints);
1747 /* Behavior is conditional on RECORD_FULL_IS_REPLAY. We will not actually
1748 insert or remove breakpoints in the real target when replaying, nor
1749 when recording. */
1752 record_full_target::insert_breakpoint (struct gdbarch *gdbarch,
1753 struct bp_target_info *bp_tgt)
1755 bool in_target_beneath = false;
1757 if (!RECORD_FULL_IS_REPLAY)
1759 /* When recording, we currently always single-step, so we don't
1760 really need to install regular breakpoints in the inferior.
1761 However, we do have to insert software single-step
1762 breakpoints, in case the target can't hardware step. To keep
1763 things simple, we always insert. */
1765 scoped_restore restore_operation_disable
1766 = record_full_gdb_operation_disable_set ();
1768 int ret = this->beneath ()->insert_breakpoint (gdbarch, bp_tgt);
1769 if (ret != 0)
1770 return ret;
1772 in_target_beneath = true;
1775 /* Use the existing entries if found in order to avoid duplication
1776 in record_full_breakpoints. */
1778 for (const record_full_breakpoint &bp : record_full_breakpoints)
1780 if (bp.addr == bp_tgt->placed_address
1781 && bp.address_space == bp_tgt->placed_address_space)
1783 gdb_assert (bp.in_target_beneath == in_target_beneath);
1784 return 0;
1788 record_full_breakpoints.emplace_back (bp_tgt->placed_address_space,
1789 bp_tgt->placed_address,
1790 in_target_beneath);
1791 return 0;
1794 /* "remove_breakpoint" method for process record target. */
1797 record_full_target::remove_breakpoint (struct gdbarch *gdbarch,
1798 struct bp_target_info *bp_tgt,
1799 enum remove_bp_reason reason)
1801 for (auto iter = record_full_breakpoints.begin ();
1802 iter != record_full_breakpoints.end ();
1803 ++iter)
1805 struct record_full_breakpoint &bp = *iter;
1807 if (bp.addr == bp_tgt->placed_address
1808 && bp.address_space == bp_tgt->placed_address_space)
1810 if (bp.in_target_beneath)
1812 scoped_restore restore_operation_disable
1813 = record_full_gdb_operation_disable_set ();
1815 int ret = this->beneath ()->remove_breakpoint (gdbarch, bp_tgt,
1816 reason);
1817 if (ret != 0)
1818 return ret;
1821 if (reason == REMOVE_BREAKPOINT)
1822 unordered_remove (record_full_breakpoints, iter);
1823 return 0;
1827 gdb_assert_not_reached ("removing unknown breakpoint");
1830 /* "can_execute_reverse" method for process record target. */
1832 bool
1833 record_full_base_target::can_execute_reverse ()
1835 return true;
1838 /* "get_bookmark" method for process record and prec over core. */
1840 gdb_byte *
1841 record_full_base_target::get_bookmark (const char *args, int from_tty)
1843 char *ret = NULL;
1845 /* Return stringified form of instruction count. */
1846 if (record_full_list && record_full_list->type == record_full_end)
1847 ret = xstrdup (pulongest (record_full_list->u.end.insn_num));
1849 if (record_debug)
1851 if (ret)
1852 fprintf_unfiltered (gdb_stdlog,
1853 "record_full_get_bookmark returns %s\n", ret);
1854 else
1855 fprintf_unfiltered (gdb_stdlog,
1856 "record_full_get_bookmark returns NULL\n");
1858 return (gdb_byte *) ret;
1861 /* "goto_bookmark" method for process record and prec over core. */
1863 void
1864 record_full_base_target::goto_bookmark (const gdb_byte *raw_bookmark,
1865 int from_tty)
1867 const char *bookmark = (const char *) raw_bookmark;
1869 if (record_debug)
1870 fprintf_unfiltered (gdb_stdlog,
1871 "record_full_goto_bookmark receives %s\n", bookmark);
1873 std::string name_holder;
1874 if (bookmark[0] == '\'' || bookmark[0] == '\"')
1876 if (bookmark[strlen (bookmark) - 1] != bookmark[0])
1877 error (_("Unbalanced quotes: %s"), bookmark);
1879 name_holder = std::string (bookmark + 1, strlen (bookmark) - 2);
1880 bookmark = name_holder.c_str ();
1883 record_goto (bookmark);
1886 enum exec_direction_kind
1887 record_full_base_target::execution_direction ()
1889 return record_full_execution_dir;
1892 /* The record_method method of target record-full. */
1894 enum record_method
1895 record_full_base_target::record_method (ptid_t ptid)
1897 return RECORD_METHOD_FULL;
1900 void
1901 record_full_base_target::info_record ()
1903 struct record_full_entry *p;
1905 if (RECORD_FULL_IS_REPLAY)
1906 printf_filtered (_("Replay mode:\n"));
1907 else
1908 printf_filtered (_("Record mode:\n"));
1910 /* Find entry for first actual instruction in the log. */
1911 for (p = record_full_first.next;
1912 p != NULL && p->type != record_full_end;
1913 p = p->next)
1916 /* Do we have a log at all? */
1917 if (p != NULL && p->type == record_full_end)
1919 /* Display instruction number for first instruction in the log. */
1920 printf_filtered (_("Lowest recorded instruction number is %s.\n"),
1921 pulongest (p->u.end.insn_num));
1923 /* If in replay mode, display where we are in the log. */
1924 if (RECORD_FULL_IS_REPLAY)
1925 printf_filtered (_("Current instruction number is %s.\n"),
1926 pulongest (record_full_list->u.end.insn_num));
1928 /* Display instruction number for last instruction in the log. */
1929 printf_filtered (_("Highest recorded instruction number is %s.\n"),
1930 pulongest (record_full_insn_count));
1932 /* Display log count. */
1933 printf_filtered (_("Log contains %u instructions.\n"),
1934 record_full_insn_num);
1936 else
1937 printf_filtered (_("No instructions have been logged.\n"));
1939 /* Display max log size. */
1940 printf_filtered (_("Max logged instructions is %u.\n"),
1941 record_full_insn_max_num);
1944 bool
1945 record_full_base_target::supports_delete_record ()
1947 return true;
1950 /* The "delete_record" target method. */
1952 void
1953 record_full_base_target::delete_record ()
1955 record_full_list_release_following (record_full_list);
1958 /* The "record_is_replaying" target method. */
1960 bool
1961 record_full_base_target::record_is_replaying (ptid_t ptid)
1963 return RECORD_FULL_IS_REPLAY;
1966 /* The "record_will_replay" target method. */
1968 bool
1969 record_full_base_target::record_will_replay (ptid_t ptid, int dir)
1971 /* We can currently only record when executing forwards. Should we be able
1972 to record when executing backwards on targets that support reverse
1973 execution, this needs to be changed. */
1975 return RECORD_FULL_IS_REPLAY || dir == EXEC_REVERSE;
1978 /* Go to a specific entry. */
1980 static void
1981 record_full_goto_entry (struct record_full_entry *p)
1983 if (p == NULL)
1984 error (_("Target insn not found."));
1985 else if (p == record_full_list)
1986 error (_("Already at target insn."));
1987 else if (p->u.end.insn_num > record_full_list->u.end.insn_num)
1989 printf_filtered (_("Go forward to insn number %s\n"),
1990 pulongest (p->u.end.insn_num));
1991 record_full_goto_insn (p, EXEC_FORWARD);
1993 else
1995 printf_filtered (_("Go backward to insn number %s\n"),
1996 pulongest (p->u.end.insn_num));
1997 record_full_goto_insn (p, EXEC_REVERSE);
2000 registers_changed ();
2001 reinit_frame_cache ();
2002 inferior_thread ()->suspend.stop_pc
2003 = regcache_read_pc (get_current_regcache ());
2004 print_stack_frame (get_selected_frame (NULL), 1, SRC_AND_LOC, 1);
2007 /* The "goto_record_begin" target method. */
2009 void
2010 record_full_base_target::goto_record_begin ()
2012 struct record_full_entry *p = NULL;
2014 for (p = &record_full_first; p != NULL; p = p->next)
2015 if (p->type == record_full_end)
2016 break;
2018 record_full_goto_entry (p);
2021 /* The "goto_record_end" target method. */
2023 void
2024 record_full_base_target::goto_record_end ()
2026 struct record_full_entry *p = NULL;
2028 for (p = record_full_list; p->next != NULL; p = p->next)
2030 for (; p!= NULL; p = p->prev)
2031 if (p->type == record_full_end)
2032 break;
2034 record_full_goto_entry (p);
2037 /* The "goto_record" target method. */
2039 void
2040 record_full_base_target::goto_record (ULONGEST target_insn)
2042 struct record_full_entry *p = NULL;
2044 for (p = &record_full_first; p != NULL; p = p->next)
2045 if (p->type == record_full_end && p->u.end.insn_num == target_insn)
2046 break;
2048 record_full_goto_entry (p);
2051 /* The "record_stop_replaying" target method. */
2053 void
2054 record_full_base_target::record_stop_replaying ()
2056 goto_record_end ();
2059 /* "resume" method for prec over corefile. */
2061 void
2062 record_full_core_target::resume (ptid_t ptid, int step,
2063 enum gdb_signal signal)
2065 record_full_resume_step = step;
2066 record_full_resumed = 1;
2067 record_full_execution_dir = ::execution_direction;
2069 /* We are about to start executing the inferior (or simulate it),
2070 let's register it with the event loop. */
2071 if (target_can_async_p ())
2072 target_async (1);
2075 /* "kill" method for prec over corefile. */
2077 void
2078 record_full_core_target::kill ()
2080 if (record_debug)
2081 fprintf_unfiltered (gdb_stdlog, "Process record: record_full_core_kill\n");
2083 current_inferior ()->unpush_target (this);
2086 /* "fetch_registers" method for prec over corefile. */
2088 void
2089 record_full_core_target::fetch_registers (struct regcache *regcache,
2090 int regno)
2092 if (regno < 0)
2094 int num = gdbarch_num_regs (regcache->arch ());
2095 int i;
2097 for (i = 0; i < num; i ++)
2098 regcache->raw_supply (i, *record_full_core_regbuf);
2100 else
2101 regcache->raw_supply (regno, *record_full_core_regbuf);
2104 /* "prepare_to_store" method for prec over corefile. */
2106 void
2107 record_full_core_target::prepare_to_store (struct regcache *regcache)
2111 /* "store_registers" method for prec over corefile. */
2113 void
2114 record_full_core_target::store_registers (struct regcache *regcache,
2115 int regno)
2117 if (record_full_gdb_operation_disable)
2118 record_full_core_regbuf->raw_supply (regno, *regcache);
2119 else
2120 error (_("You can't do that without a process to debug."));
2123 /* "xfer_partial" method for prec over corefile. */
2125 enum target_xfer_status
2126 record_full_core_target::xfer_partial (enum target_object object,
2127 const char *annex, gdb_byte *readbuf,
2128 const gdb_byte *writebuf, ULONGEST offset,
2129 ULONGEST len, ULONGEST *xfered_len)
2131 if (object == TARGET_OBJECT_MEMORY)
2133 if (record_full_gdb_operation_disable || !writebuf)
2135 for (target_section &p : record_full_core_sections)
2137 if (offset >= p.addr)
2139 struct record_full_core_buf_entry *entry;
2140 ULONGEST sec_offset;
2142 if (offset >= p.endaddr)
2143 continue;
2145 if (offset + len > p.endaddr)
2146 len = p.endaddr - offset;
2148 sec_offset = offset - p.addr;
2150 /* Read readbuf or write writebuf p, offset, len. */
2151 /* Check flags. */
2152 if (p.the_bfd_section->flags & SEC_CONSTRUCTOR
2153 || (p.the_bfd_section->flags & SEC_HAS_CONTENTS) == 0)
2155 if (readbuf)
2156 memset (readbuf, 0, len);
2158 *xfered_len = len;
2159 return TARGET_XFER_OK;
2161 /* Get record_full_core_buf_entry. */
2162 for (entry = record_full_core_buf_list; entry;
2163 entry = entry->prev)
2164 if (entry->p == &p)
2165 break;
2166 if (writebuf)
2168 if (!entry)
2170 /* Add a new entry. */
2171 entry = XNEW (struct record_full_core_buf_entry);
2172 entry->p = &p;
2173 if (!bfd_malloc_and_get_section
2174 (p.the_bfd_section->owner,
2175 p.the_bfd_section,
2176 &entry->buf))
2178 xfree (entry);
2179 return TARGET_XFER_EOF;
2181 entry->prev = record_full_core_buf_list;
2182 record_full_core_buf_list = entry;
2185 memcpy (entry->buf + sec_offset, writebuf,
2186 (size_t) len);
2188 else
2190 if (!entry)
2191 return this->beneath ()->xfer_partial (object, annex,
2192 readbuf, writebuf,
2193 offset, len,
2194 xfered_len);
2196 memcpy (readbuf, entry->buf + sec_offset,
2197 (size_t) len);
2200 *xfered_len = len;
2201 return TARGET_XFER_OK;
2205 return TARGET_XFER_E_IO;
2207 else
2208 error (_("You can't do that without a process to debug."));
2211 return this->beneath ()->xfer_partial (object, annex,
2212 readbuf, writebuf, offset, len,
2213 xfered_len);
2216 /* "insert_breakpoint" method for prec over corefile. */
2219 record_full_core_target::insert_breakpoint (struct gdbarch *gdbarch,
2220 struct bp_target_info *bp_tgt)
2222 return 0;
2225 /* "remove_breakpoint" method for prec over corefile. */
2228 record_full_core_target::remove_breakpoint (struct gdbarch *gdbarch,
2229 struct bp_target_info *bp_tgt,
2230 enum remove_bp_reason reason)
2232 return 0;
2235 /* "has_execution" method for prec over corefile. */
2237 bool
2238 record_full_core_target::has_execution (inferior *inf)
2240 return true;
2243 /* Record log save-file format
2244 Version 1 (never released)
2246 Header:
2247 4 bytes: magic number htonl(0x20090829).
2248 NOTE: be sure to change whenever this file format changes!
2250 Records:
2251 record_full_end:
2252 1 byte: record type (record_full_end, see enum record_full_type).
2253 record_full_reg:
2254 1 byte: record type (record_full_reg, see enum record_full_type).
2255 8 bytes: register id (network byte order).
2256 MAX_REGISTER_SIZE bytes: register value.
2257 record_full_mem:
2258 1 byte: record type (record_full_mem, see enum record_full_type).
2259 8 bytes: memory length (network byte order).
2260 8 bytes: memory address (network byte order).
2261 n bytes: memory value (n == memory length).
2263 Version 2
2264 4 bytes: magic number netorder32(0x20091016).
2265 NOTE: be sure to change whenever this file format changes!
2267 Records:
2268 record_full_end:
2269 1 byte: record type (record_full_end, see enum record_full_type).
2270 4 bytes: signal
2271 4 bytes: instruction count
2272 record_full_reg:
2273 1 byte: record type (record_full_reg, see enum record_full_type).
2274 4 bytes: register id (network byte order).
2275 n bytes: register value (n == actual register size).
2276 (eg. 4 bytes for x86 general registers).
2277 record_full_mem:
2278 1 byte: record type (record_full_mem, see enum record_full_type).
2279 4 bytes: memory length (network byte order).
2280 8 bytes: memory address (network byte order).
2281 n bytes: memory value (n == memory length).
2285 /* bfdcore_read -- read bytes from a core file section. */
2287 static inline void
2288 bfdcore_read (bfd *obfd, asection *osec, void *buf, int len, int *offset)
2290 int ret = bfd_get_section_contents (obfd, osec, buf, *offset, len);
2292 if (ret)
2293 *offset += len;
2294 else
2295 error (_("Failed to read %d bytes from core file %s ('%s')."),
2296 len, bfd_get_filename (obfd),
2297 bfd_errmsg (bfd_get_error ()));
2300 static inline uint64_t
2301 netorder64 (uint64_t input)
2303 uint64_t ret;
2305 store_unsigned_integer ((gdb_byte *) &ret, sizeof (ret),
2306 BFD_ENDIAN_BIG, input);
2307 return ret;
2310 static inline uint32_t
2311 netorder32 (uint32_t input)
2313 uint32_t ret;
2315 store_unsigned_integer ((gdb_byte *) &ret, sizeof (ret),
2316 BFD_ENDIAN_BIG, input);
2317 return ret;
2320 /* Restore the execution log from a core_bfd file. */
2321 static void
2322 record_full_restore (void)
2324 uint32_t magic;
2325 struct record_full_entry *rec;
2326 asection *osec;
2327 uint32_t osec_size;
2328 int bfd_offset = 0;
2329 struct regcache *regcache;
2331 /* We restore the execution log from the open core bfd,
2332 if there is one. */
2333 if (core_bfd == NULL)
2334 return;
2336 /* "record_full_restore" can only be called when record list is empty. */
2337 gdb_assert (record_full_first.next == NULL);
2339 if (record_debug)
2340 fprintf_unfiltered (gdb_stdlog, "Restoring recording from core file.\n");
2342 /* Now need to find our special note section. */
2343 osec = bfd_get_section_by_name (core_bfd, "null0");
2344 if (record_debug)
2345 fprintf_unfiltered (gdb_stdlog, "Find precord section %s.\n",
2346 osec ? "succeeded" : "failed");
2347 if (osec == NULL)
2348 return;
2349 osec_size = bfd_section_size (osec);
2350 if (record_debug)
2351 fprintf_unfiltered (gdb_stdlog, "%s", bfd_section_name (osec));
2353 /* Check the magic code. */
2354 bfdcore_read (core_bfd, osec, &magic, sizeof (magic), &bfd_offset);
2355 if (magic != RECORD_FULL_FILE_MAGIC)
2356 error (_("Version mis-match or file format error in core file %s."),
2357 bfd_get_filename (core_bfd));
2358 if (record_debug)
2359 fprintf_unfiltered (gdb_stdlog,
2360 " Reading 4-byte magic cookie "
2361 "RECORD_FULL_FILE_MAGIC (0x%s)\n",
2362 phex_nz (netorder32 (magic), 4));
2364 /* Restore the entries in recfd into record_full_arch_list_head and
2365 record_full_arch_list_tail. */
2366 record_full_arch_list_head = NULL;
2367 record_full_arch_list_tail = NULL;
2368 record_full_insn_num = 0;
2372 regcache = get_current_regcache ();
2374 while (1)
2376 uint8_t rectype;
2377 uint32_t regnum, len, signal, count;
2378 uint64_t addr;
2380 /* We are finished when offset reaches osec_size. */
2381 if (bfd_offset >= osec_size)
2382 break;
2383 bfdcore_read (core_bfd, osec, &rectype, sizeof (rectype), &bfd_offset);
2385 switch (rectype)
2387 case record_full_reg: /* reg */
2388 /* Get register number to regnum. */
2389 bfdcore_read (core_bfd, osec, &regnum,
2390 sizeof (regnum), &bfd_offset);
2391 regnum = netorder32 (regnum);
2393 rec = record_full_reg_alloc (regcache, regnum);
2395 /* Get val. */
2396 bfdcore_read (core_bfd, osec, record_full_get_loc (rec),
2397 rec->u.reg.len, &bfd_offset);
2399 if (record_debug)
2400 fprintf_unfiltered (gdb_stdlog,
2401 " Reading register %d (1 "
2402 "plus %lu plus %d bytes)\n",
2403 rec->u.reg.num,
2404 (unsigned long) sizeof (regnum),
2405 rec->u.reg.len);
2406 break;
2408 case record_full_mem: /* mem */
2409 /* Get len. */
2410 bfdcore_read (core_bfd, osec, &len,
2411 sizeof (len), &bfd_offset);
2412 len = netorder32 (len);
2414 /* Get addr. */
2415 bfdcore_read (core_bfd, osec, &addr,
2416 sizeof (addr), &bfd_offset);
2417 addr = netorder64 (addr);
2419 rec = record_full_mem_alloc (addr, len);
2421 /* Get val. */
2422 bfdcore_read (core_bfd, osec, record_full_get_loc (rec),
2423 rec->u.mem.len, &bfd_offset);
2425 if (record_debug)
2426 fprintf_unfiltered (gdb_stdlog,
2427 " Reading memory %s (1 plus "
2428 "%lu plus %lu plus %d bytes)\n",
2429 paddress (get_current_arch (),
2430 rec->u.mem.addr),
2431 (unsigned long) sizeof (addr),
2432 (unsigned long) sizeof (len),
2433 rec->u.mem.len);
2434 break;
2436 case record_full_end: /* end */
2437 rec = record_full_end_alloc ();
2438 record_full_insn_num ++;
2440 /* Get signal value. */
2441 bfdcore_read (core_bfd, osec, &signal,
2442 sizeof (signal), &bfd_offset);
2443 signal = netorder32 (signal);
2444 rec->u.end.sigval = (enum gdb_signal) signal;
2446 /* Get insn count. */
2447 bfdcore_read (core_bfd, osec, &count,
2448 sizeof (count), &bfd_offset);
2449 count = netorder32 (count);
2450 rec->u.end.insn_num = count;
2451 record_full_insn_count = count + 1;
2452 if (record_debug)
2453 fprintf_unfiltered (gdb_stdlog,
2454 " Reading record_full_end (1 + "
2455 "%lu + %lu bytes), offset == %s\n",
2456 (unsigned long) sizeof (signal),
2457 (unsigned long) sizeof (count),
2458 paddress (get_current_arch (),
2459 bfd_offset));
2460 break;
2462 default:
2463 error (_("Bad entry type in core file %s."),
2464 bfd_get_filename (core_bfd));
2465 break;
2468 /* Add rec to record arch list. */
2469 record_full_arch_list_add (rec);
2472 catch (const gdb_exception &ex)
2474 record_full_list_release (record_full_arch_list_tail);
2475 throw;
2478 /* Add record_full_arch_list_head to the end of record list. */
2479 record_full_first.next = record_full_arch_list_head;
2480 record_full_arch_list_head->prev = &record_full_first;
2481 record_full_arch_list_tail->next = NULL;
2482 record_full_list = &record_full_first;
2484 /* Update record_full_insn_max_num. */
2485 if (record_full_insn_num > record_full_insn_max_num)
2487 record_full_insn_max_num = record_full_insn_num;
2488 warning (_("Auto increase record/replay buffer limit to %u."),
2489 record_full_insn_max_num);
2492 /* Succeeded. */
2493 printf_filtered (_("Restored records from core file %s.\n"),
2494 bfd_get_filename (core_bfd));
2496 print_stack_frame (get_selected_frame (NULL), 1, SRC_AND_LOC, 1);
2499 /* bfdcore_write -- write bytes into a core file section. */
2501 static inline void
2502 bfdcore_write (bfd *obfd, asection *osec, void *buf, int len, int *offset)
2504 int ret = bfd_set_section_contents (obfd, osec, buf, *offset, len);
2506 if (ret)
2507 *offset += len;
2508 else
2509 error (_("Failed to write %d bytes to core file %s ('%s')."),
2510 len, bfd_get_filename (obfd),
2511 bfd_errmsg (bfd_get_error ()));
2514 /* Restore the execution log from a file. We use a modified elf
2515 corefile format, with an extra section for our data. */
2517 static void
2518 cmd_record_full_restore (const char *args, int from_tty)
2520 core_file_command (args, from_tty);
2521 record_full_open (args, from_tty);
2524 /* Save the execution log to a file. We use a modified elf corefile
2525 format, with an extra section for our data. */
2527 void
2528 record_full_base_target::save_record (const char *recfilename)
2530 struct record_full_entry *cur_record_full_list;
2531 uint32_t magic;
2532 struct regcache *regcache;
2533 struct gdbarch *gdbarch;
2534 int save_size = 0;
2535 asection *osec = NULL;
2536 int bfd_offset = 0;
2538 /* Open the save file. */
2539 if (record_debug)
2540 fprintf_unfiltered (gdb_stdlog, "Saving execution log to core file '%s'\n",
2541 recfilename);
2543 /* Open the output file. */
2544 gdb_bfd_ref_ptr obfd (create_gcore_bfd (recfilename));
2546 /* Arrange to remove the output file on failure. */
2547 gdb::unlinker unlink_file (recfilename);
2549 /* Save the current record entry to "cur_record_full_list". */
2550 cur_record_full_list = record_full_list;
2552 /* Get the values of regcache and gdbarch. */
2553 regcache = get_current_regcache ();
2554 gdbarch = regcache->arch ();
2556 /* Disable the GDB operation record. */
2557 scoped_restore restore_operation_disable
2558 = record_full_gdb_operation_disable_set ();
2560 /* Reverse execute to the begin of record list. */
2561 while (1)
2563 /* Check for beginning and end of log. */
2564 if (record_full_list == &record_full_first)
2565 break;
2567 record_full_exec_insn (regcache, gdbarch, record_full_list);
2569 if (record_full_list->prev)
2570 record_full_list = record_full_list->prev;
2573 /* Compute the size needed for the extra bfd section. */
2574 save_size = 4; /* magic cookie */
2575 for (record_full_list = record_full_first.next; record_full_list;
2576 record_full_list = record_full_list->next)
2577 switch (record_full_list->type)
2579 case record_full_end:
2580 save_size += 1 + 4 + 4;
2581 break;
2582 case record_full_reg:
2583 save_size += 1 + 4 + record_full_list->u.reg.len;
2584 break;
2585 case record_full_mem:
2586 save_size += 1 + 4 + 8 + record_full_list->u.mem.len;
2587 break;
2590 /* Make the new bfd section. */
2591 osec = bfd_make_section_anyway_with_flags (obfd.get (), "precord",
2592 SEC_HAS_CONTENTS
2593 | SEC_READONLY);
2594 if (osec == NULL)
2595 error (_("Failed to create 'precord' section for corefile %s: %s"),
2596 recfilename,
2597 bfd_errmsg (bfd_get_error ()));
2598 bfd_set_section_size (osec, save_size);
2599 bfd_set_section_vma (osec, 0);
2600 bfd_set_section_alignment (osec, 0);
2602 /* Save corefile state. */
2603 write_gcore_file (obfd.get ());
2605 /* Write out the record log. */
2606 /* Write the magic code. */
2607 magic = RECORD_FULL_FILE_MAGIC;
2608 if (record_debug)
2609 fprintf_unfiltered (gdb_stdlog,
2610 " Writing 4-byte magic cookie "
2611 "RECORD_FULL_FILE_MAGIC (0x%s)\n",
2612 phex_nz (magic, 4));
2613 bfdcore_write (obfd.get (), osec, &magic, sizeof (magic), &bfd_offset);
2615 /* Save the entries to recfd and forward execute to the end of
2616 record list. */
2617 record_full_list = &record_full_first;
2618 while (1)
2620 /* Save entry. */
2621 if (record_full_list != &record_full_first)
2623 uint8_t type;
2624 uint32_t regnum, len, signal, count;
2625 uint64_t addr;
2627 type = record_full_list->type;
2628 bfdcore_write (obfd.get (), osec, &type, sizeof (type), &bfd_offset);
2630 switch (record_full_list->type)
2632 case record_full_reg: /* reg */
2633 if (record_debug)
2634 fprintf_unfiltered (gdb_stdlog,
2635 " Writing register %d (1 "
2636 "plus %lu plus %d bytes)\n",
2637 record_full_list->u.reg.num,
2638 (unsigned long) sizeof (regnum),
2639 record_full_list->u.reg.len);
2641 /* Write regnum. */
2642 regnum = netorder32 (record_full_list->u.reg.num);
2643 bfdcore_write (obfd.get (), osec, &regnum,
2644 sizeof (regnum), &bfd_offset);
2646 /* Write regval. */
2647 bfdcore_write (obfd.get (), osec,
2648 record_full_get_loc (record_full_list),
2649 record_full_list->u.reg.len, &bfd_offset);
2650 break;
2652 case record_full_mem: /* mem */
2653 if (record_debug)
2654 fprintf_unfiltered (gdb_stdlog,
2655 " Writing memory %s (1 plus "
2656 "%lu plus %lu plus %d bytes)\n",
2657 paddress (gdbarch,
2658 record_full_list->u.mem.addr),
2659 (unsigned long) sizeof (addr),
2660 (unsigned long) sizeof (len),
2661 record_full_list->u.mem.len);
2663 /* Write memlen. */
2664 len = netorder32 (record_full_list->u.mem.len);
2665 bfdcore_write (obfd.get (), osec, &len, sizeof (len),
2666 &bfd_offset);
2668 /* Write memaddr. */
2669 addr = netorder64 (record_full_list->u.mem.addr);
2670 bfdcore_write (obfd.get (), osec, &addr,
2671 sizeof (addr), &bfd_offset);
2673 /* Write memval. */
2674 bfdcore_write (obfd.get (), osec,
2675 record_full_get_loc (record_full_list),
2676 record_full_list->u.mem.len, &bfd_offset);
2677 break;
2679 case record_full_end:
2680 if (record_debug)
2681 fprintf_unfiltered (gdb_stdlog,
2682 " Writing record_full_end (1 + "
2683 "%lu + %lu bytes)\n",
2684 (unsigned long) sizeof (signal),
2685 (unsigned long) sizeof (count));
2686 /* Write signal value. */
2687 signal = netorder32 (record_full_list->u.end.sigval);
2688 bfdcore_write (obfd.get (), osec, &signal,
2689 sizeof (signal), &bfd_offset);
2691 /* Write insn count. */
2692 count = netorder32 (record_full_list->u.end.insn_num);
2693 bfdcore_write (obfd.get (), osec, &count,
2694 sizeof (count), &bfd_offset);
2695 break;
2699 /* Execute entry. */
2700 record_full_exec_insn (regcache, gdbarch, record_full_list);
2702 if (record_full_list->next)
2703 record_full_list = record_full_list->next;
2704 else
2705 break;
2708 /* Reverse execute to cur_record_full_list. */
2709 while (1)
2711 /* Check for beginning and end of log. */
2712 if (record_full_list == cur_record_full_list)
2713 break;
2715 record_full_exec_insn (regcache, gdbarch, record_full_list);
2717 if (record_full_list->prev)
2718 record_full_list = record_full_list->prev;
2721 unlink_file.keep ();
2723 /* Succeeded. */
2724 printf_filtered (_("Saved core file %s with execution log.\n"),
2725 recfilename);
2728 /* record_full_goto_insn -- rewind the record log (forward or backward,
2729 depending on DIR) to the given entry, changing the program state
2730 correspondingly. */
2732 static void
2733 record_full_goto_insn (struct record_full_entry *entry,
2734 enum exec_direction_kind dir)
2736 scoped_restore restore_operation_disable
2737 = record_full_gdb_operation_disable_set ();
2738 struct regcache *regcache = get_current_regcache ();
2739 struct gdbarch *gdbarch = regcache->arch ();
2741 /* Assume everything is valid: we will hit the entry,
2742 and we will not hit the end of the recording. */
2744 if (dir == EXEC_FORWARD)
2745 record_full_list = record_full_list->next;
2749 record_full_exec_insn (regcache, gdbarch, record_full_list);
2750 if (dir == EXEC_REVERSE)
2751 record_full_list = record_full_list->prev;
2752 else
2753 record_full_list = record_full_list->next;
2754 } while (record_full_list != entry);
2757 /* Alias for "target record-full". */
2759 static void
2760 cmd_record_full_start (const char *args, int from_tty)
2762 execute_command ("target record-full", from_tty);
2765 static void
2766 set_record_full_insn_max_num (const char *args, int from_tty,
2767 struct cmd_list_element *c)
2769 if (record_full_insn_num > record_full_insn_max_num)
2771 /* Count down record_full_insn_num while releasing records from list. */
2772 while (record_full_insn_num > record_full_insn_max_num)
2774 record_full_list_release_first ();
2775 record_full_insn_num--;
2780 void _initialize_record_full ();
2781 void
2782 _initialize_record_full ()
2784 struct cmd_list_element *c;
2786 /* Init record_full_first. */
2787 record_full_first.prev = NULL;
2788 record_full_first.next = NULL;
2789 record_full_first.type = record_full_end;
2791 add_target (record_full_target_info, record_full_open);
2792 add_deprecated_target_alias (record_full_target_info, "record");
2793 add_target (record_full_core_target_info, record_full_open);
2795 add_prefix_cmd ("full", class_obscure, cmd_record_full_start,
2796 _("Start full execution recording."), &record_full_cmdlist,
2797 "record full ", 0, &record_cmdlist);
2799 c = add_cmd ("restore", class_obscure, cmd_record_full_restore,
2800 _("Restore the execution log from a file.\n\
2801 Argument is filename. File must be created with 'record save'."),
2802 &record_full_cmdlist);
2803 set_cmd_completer (c, filename_completer);
2805 /* Deprecate the old version without "full" prefix. */
2806 c = add_alias_cmd ("restore", "full restore", class_obscure, 1,
2807 &record_cmdlist);
2808 set_cmd_completer (c, filename_completer);
2809 deprecate_cmd (c, "record full restore");
2811 add_basic_prefix_cmd ("full", class_support,
2812 _("Set record options."), &set_record_full_cmdlist,
2813 "set record full ", 0, &set_record_cmdlist);
2815 add_show_prefix_cmd ("full", class_support,
2816 _("Show record options."), &show_record_full_cmdlist,
2817 "show record full ", 0, &show_record_cmdlist);
2819 /* Record instructions number limit command. */
2820 add_setshow_boolean_cmd ("stop-at-limit", no_class,
2821 &record_full_stop_at_limit, _("\
2822 Set whether record/replay stops when record/replay buffer becomes full."), _("\
2823 Show whether record/replay stops when record/replay buffer becomes full."),
2824 _("Default is ON.\n\
2825 When ON, if the record/replay buffer becomes full, ask user what to do.\n\
2826 When OFF, if the record/replay buffer becomes full,\n\
2827 delete the oldest recorded instruction to make room for each new one."),
2828 NULL, NULL,
2829 &set_record_full_cmdlist, &show_record_full_cmdlist);
2831 c = add_alias_cmd ("stop-at-limit", "full stop-at-limit", no_class, 1,
2832 &set_record_cmdlist);
2833 deprecate_cmd (c, "set record full stop-at-limit");
2835 c = add_alias_cmd ("stop-at-limit", "full stop-at-limit", no_class, 1,
2836 &show_record_cmdlist);
2837 deprecate_cmd (c, "show record full stop-at-limit");
2839 add_setshow_uinteger_cmd ("insn-number-max", no_class,
2840 &record_full_insn_max_num,
2841 _("Set record/replay buffer limit."),
2842 _("Show record/replay buffer limit."), _("\
2843 Set the maximum number of instructions to be stored in the\n\
2844 record/replay buffer. A value of either \"unlimited\" or zero means no\n\
2845 limit. Default is 200000."),
2846 set_record_full_insn_max_num,
2847 NULL, &set_record_full_cmdlist,
2848 &show_record_full_cmdlist);
2850 c = add_alias_cmd ("insn-number-max", "full insn-number-max", no_class, 1,
2851 &set_record_cmdlist);
2852 deprecate_cmd (c, "set record full insn-number-max");
2854 c = add_alias_cmd ("insn-number-max", "full insn-number-max", no_class, 1,
2855 &show_record_cmdlist);
2856 deprecate_cmd (c, "show record full insn-number-max");
2858 add_setshow_boolean_cmd ("memory-query", no_class,
2859 &record_full_memory_query, _("\
2860 Set whether query if PREC cannot record memory change of next instruction."),
2861 _("\
2862 Show whether query if PREC cannot record memory change of next instruction."),
2863 _("\
2864 Default is OFF.\n\
2865 When ON, query if PREC cannot record memory change of next instruction."),
2866 NULL, NULL,
2867 &set_record_full_cmdlist,
2868 &show_record_full_cmdlist);
2870 c = add_alias_cmd ("memory-query", "full memory-query", no_class, 1,
2871 &set_record_cmdlist);
2872 deprecate_cmd (c, "set record full memory-query");
2874 c = add_alias_cmd ("memory-query", "full memory-query", no_class, 1,
2875 &show_record_cmdlist);
2876 deprecate_cmd (c, "show record full memory-query");