gdb: add target_ops::supports_displaced_step

[deliverable/binutils-gdb.git] / gdb / disasm.h

diff --git a/gdb/disasm.h b/gdb/disasm.h
index a91211e789f5d94cebd9c25e94f45135363ef4d6..b0f535eaa211607905b48751cb7ef71ceabb3166 100644 (file)
--- a/gdb/disasm.h
+++ b/gdb/disasm.h
@@ -1,5 +1,5 @@
 /* Disassemble support for GDB.
-   Copyright (C) 2002-2015 Free Software Foundation, Inc.
+   Copyright (C) 2002-2020 Free Software Foundation, Inc.
 
    This file is part of GDB.
 
@@ -20,24 +20,88 @@
 #define DISASM_H
 
 #include "dis-asm.h"
-
-#define DISASSEMBLY_SOURCE     (0x1 << 0)
-#define DISASSEMBLY_RAW_INSN   (0x1 << 1)
-#define DISASSEMBLY_OMIT_FNAME (0x1 << 2)
-#define DISASSEMBLY_FILENAME   (0x1 << 3)
-#define DISASSEMBLY_OMIT_PC    (0x1 << 4)
+#include "gdbsupport/enum-flags.h"
+
+enum gdb_disassembly_flag
+  {
+    DISASSEMBLY_SOURCE_DEPRECATED = (0x1 << 0),
+    DISASSEMBLY_RAW_INSN = (0x1 << 1),
+    DISASSEMBLY_OMIT_FNAME = (0x1 << 2),
+    DISASSEMBLY_FILENAME = (0x1 << 3),
+    DISASSEMBLY_OMIT_PC = (0x1 << 4),
+    DISASSEMBLY_SOURCE = (0x1 << 5),
+    DISASSEMBLY_SPECULATIVE = (0x1 << 6),
+  };
+DEF_ENUM_FLAGS_TYPE (enum gdb_disassembly_flag, gdb_disassembly_flags);
 
 struct gdbarch;
 struct ui_out;
 struct ui_file;
 
-/* Return a filled in disassemble_info object for use by gdb.  */
+class gdb_disassembler
+{
+  using di_read_memory_ftype = decltype (disassemble_info::read_memory_func);
+
+public:
+  gdb_disassembler (struct gdbarch *gdbarch, struct ui_file *file)
+    : gdb_disassembler (gdbarch, file, dis_asm_read_memory)
+  {}
+
+  ~gdb_disassembler ();
+
+  DISABLE_COPY_AND_ASSIGN (gdb_disassembler);
+
+  int print_insn (CORE_ADDR memaddr, int *branch_delay_insns = NULL);
+
+  /* Return the gdbarch of gdb_disassembler.  */
+  struct gdbarch *arch ()
+  { return m_gdbarch; }
+
+protected:
+  gdb_disassembler (struct gdbarch *gdbarch, struct ui_file *file,
+                   di_read_memory_ftype func);
+
+  struct ui_file *stream ()
+  { return (struct ui_file *) m_di.stream; }
+
+private:
+  struct gdbarch *m_gdbarch;
+
+  /* Stores data required for disassembling instructions in
+     opcodes.  */
+  struct disassemble_info m_di;
+
+  /* If we own the string in `m_di.disassembler_options', we do so
+     using this field.  */
+  std::string m_disassembler_options_holder;
+
+  CORE_ADDR m_err_memaddr;
+
+  static int dis_asm_read_memory (bfd_vma memaddr, gdb_byte *myaddr,
+                                 unsigned int len,
+                                 struct disassemble_info *info);
+  static void dis_asm_memory_error (int err, bfd_vma memaddr,
+                                   struct disassemble_info *info);
+  static void dis_asm_print_address (bfd_vma addr,
+                                    struct disassemble_info *info);
+};
+
+/* An instruction to be disassembled.  */
 
-extern struct disassemble_info gdb_disassemble_info (struct gdbarch *gdbarch,
-                                                    struct ui_file *file);
+struct disasm_insn
+{
+  /* The address of the memory containing the instruction.  */
+  CORE_ADDR addr;
+
+  /* An optional instruction number.  If non-zero, it is printed first.  */
+  unsigned int number;
+
+  /* True if the instruction was executed speculatively.  */
+  unsigned int is_speculative:1;
+};
 
 extern void gdb_disassembly (struct gdbarch *gdbarch, struct ui_out *uiout,
-                            char *file_string, int flags, int how_many,
+                            gdb_disassembly_flags flags, int how_many,
                             CORE_ADDR low, CORE_ADDR high);
 
 /* Print the instruction at address MEMADDR in debugged memory,
@@ -47,6 +111,41 @@ extern void gdb_disassembly (struct gdbarch *gdbarch, struct ui_out *uiout,
 extern int gdb_print_insn (struct gdbarch *gdbarch, CORE_ADDR memaddr,
                           struct ui_file *stream, int *branch_delay_insns);
 
+/* Class used to pretty-print instructions.  */
+
+class gdb_pretty_print_disassembler
+{
+public:
+  explicit gdb_pretty_print_disassembler (struct gdbarch *gdbarch,
+                                         struct ui_out *uiout)
+    : m_uiout (uiout),
+      m_insn_stb (uiout->can_emit_style_escape ()),
+      m_di (gdbarch, &m_insn_stb)
+  {}
+
+  /* Prints the instruction INSN into the saved ui_out and returns the
+     length of the printed instruction in bytes.  */
+  int pretty_print_insn (const struct disasm_insn *insn,
+                        gdb_disassembly_flags flags);
+
+private:
+  /* Returns the architecture used for disassembling.  */
+  struct gdbarch *arch () { return m_di.arch (); }
+
+  /* The ui_out that is used by pretty_print_insn.  */
+  struct ui_out *m_uiout;
+
+  /* The buffer used to build the instruction string.  The
+     disassembler is initialized with this stream.  */
+  string_file m_insn_stb;
+
+  /* The disassembler used for instruction printing.  */
+  gdb_disassembler m_di;
+
+  /* The buffer used to build the raw opcodes string.  */
+  string_file m_opcode_stb;
+};
+
 /* Return the length in bytes of the instruction at address MEMADDR in
    debugged memory.  */
 
@@ -59,4 +158,12 @@ extern int gdb_buffered_insn_length (struct gdbarch *gdbarch,
                                     const gdb_byte *insn, int max_len,
                                     CORE_ADDR memaddr);
 
+/* Returns GDBARCH's disassembler options.  */
+
+extern char *get_disassembler_options (struct gdbarch *gdbarch);
+
+/* Sets the active gdbarch's disassembler options to OPTIONS.  */
+
+extern void set_disassembler_options (char *options);
+
 #endif