gdb/record.h

   1 /* Process record and replay target for GDB, the GNU debugger.
   2
   3    Copyright (C) 2008-2024 Free Software Foundation, Inc.
   4
   5    This file is part of GDB.
   6
   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.
  11
  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.
  16
  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/>.  */
  19
  20 #ifndef RECORD_H
  21 #define RECORD_H
  22
  23 #include "target/waitstatus.h"
  24 #include "gdbsupport/enum-flags.h"
  25
  26 struct address_space;
  27 struct cmd_list_element;
  28 struct inferior;
  29
  30 extern unsigned int record_debug;
  31
  32 /* Allow record targets to add their own sub-commands.  */
  33 extern struct cmd_list_element *record_cmdlist;
  34 extern struct cmd_list_element *set_record_cmdlist;
  35 extern struct cmd_list_element *show_record_cmdlist;
  36 extern struct cmd_list_element *info_record_cmdlist;
  37
  38 /* Unwinders for some record targets.  */
  39 extern const struct frame_unwind record_btrace_frame_unwind;
  40 extern const struct frame_unwind record_btrace_tailcall_frame_unwind;
  41
  42 /* A list of different recording methods.  */
  43 enum record_method
  44 {
  45   /* No or unknown record method.  */
  46   RECORD_METHOD_NONE,
  47
  48   /* Record method "full".  */
  49   RECORD_METHOD_FULL,
  50
  51   /* Record method "btrace".  */
  52   RECORD_METHOD_BTRACE
  53 };
  54
  55 /* A list of flags specifying what record target methods should print.  */
  56 enum record_print_flag
  57 {
  58   /* Print the source file and line (if applicable).  */
  59   RECORD_PRINT_SRC_LINE = (1 << 0),
  60
  61   /* Print the instruction number range (if applicable).  */
  62   RECORD_PRINT_INSN_RANGE = (1 << 1),
  63
  64   /* Indent based on call stack depth (if applicable).  */
  65   RECORD_PRINT_INDENT_CALLS = (1 << 2)
  66 };
  67 DEF_ENUM_FLAGS_TYPE (enum record_print_flag, record_print_flags);
  68
  69 /* Determined whether the target is stopped at a software or hardware
  70    breakpoint, based on PC and the breakpoint tables.  The breakpoint
  71    type is translated to the appropriate target_stop_reason and
  72    written to REASON.  Returns true if stopped at a breakpoint, false
  73    otherwise.  */
  74
  75 extern int
  76   record_check_stopped_by_breakpoint (const address_space *aspace,
  77                                       CORE_ADDR pc,
  78                                       enum target_stop_reason *reason);
  79
  80 /* Wrapper for target_read_memory that prints a debug message if
  81    reading memory fails.  */
  82 extern int record_read_memory (struct gdbarch *gdbarch,
  83                                CORE_ADDR memaddr, gdb_byte *myaddr,
  84                                ssize_t len);
  85
  86 /* A wrapper for target_goto_record that parses ARG as a number.  */
  87 extern void record_goto (const char *arg);
  88
  89 /* The default "to_disconnect" target method for record targets.  */
  90 extern void record_disconnect (struct target_ops *, const char *, int);
  91
  92 /* The default "to_detach" target method for record targets.  */
  93 extern void record_detach (struct target_ops *, inferior *, int);
  94
  95 /* The default "to_mourn_inferior" target method for record targets.  */
  96 extern void record_mourn_inferior (struct target_ops *);
  97
  98 /* The default "to_kill" target method for record targets.  */
  99 extern void record_kill (struct target_ops *);
 100
 101 /* Find the record_stratum target in the current target stack.
 102    Returns NULL if none is found.  */
 103 extern struct target_ops *find_record_target (void);
 104
 105 /* This is to be called by record_stratum targets' open routine before
 106    it does anything.  */
 107 extern void record_preopen (void);
 108
 109 /* Start recording with the given METHOD and FORMAT.  NULL means default method
 110    or format.  Throw on failure or invalid method / format.  */
 111 extern void record_start (const char *method, const char *format,
 112                           int from_tty);
 113
 114 /* Stop recording.  Throw on failure.  */
 115 extern void record_stop (int from_tty);
 116
 117 #endif /* RECORD_H */