gdb/disasm.h

   1 /* Disassemble support for GDB.
   2    Copyright (C) 2002-2020 Free Software Foundation, Inc.
   3
   4    This file is part of GDB.
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 3 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  18
  19 #ifndef DISASM_H
  20 #define DISASM_H
  21
  22 #include "dis-asm.h"
  23 #include "gdbsupport/enum-flags.h"
  24
  25 enum gdb_disassembly_flag
  26   {
  27     DISASSEMBLY_SOURCE_DEPRECATED = (0x1 << 0),
  28     DISASSEMBLY_RAW_INSN = (0x1 << 1),
  29     DISASSEMBLY_OMIT_FNAME = (0x1 << 2),
  30     DISASSEMBLY_FILENAME = (0x1 << 3),
  31     DISASSEMBLY_OMIT_PC = (0x1 << 4),
  32     DISASSEMBLY_SOURCE = (0x1 << 5),
  33     DISASSEMBLY_SPECULATIVE = (0x1 << 6),
  34   };
  35 DEF_ENUM_FLAGS_TYPE (enum gdb_disassembly_flag, gdb_disassembly_flags);
  36
  37 struct gdbarch;
  38 struct ui_out;
  39 struct ui_file;
  40
  41 class gdb_disassembler
  42 {
  43   using di_read_memory_ftype = decltype (disassemble_info::read_memory_func);
  44
  45 public:
  46   gdb_disassembler (struct gdbarch *gdbarch, struct ui_file *file)
  47     : gdb_disassembler (gdbarch, file, dis_asm_read_memory)
  48   {}
  49
  50   int print_insn (CORE_ADDR memaddr, int *branch_delay_insns = NULL);
  51
  52   /* Return the gdbarch of gdb_disassembler.  */
  53   struct gdbarch *arch ()
  54   { return m_gdbarch; }
  55
  56 protected:
  57   gdb_disassembler (struct gdbarch *gdbarch, struct ui_file *file,
  58                     di_read_memory_ftype func);
  59
  60   struct ui_file *stream ()
  61   { return (struct ui_file *) m_di.stream; }
  62
  63 private:
  64   struct gdbarch *m_gdbarch;
  65
  66   /* Stores data required for disassembling instructions in
  67      opcodes.  */
  68   struct disassemble_info m_di;
  69
  70   /* If we own the string in `m_di.disassembler_options', we do so
  71      using this field.  */
  72   std::string m_disassembler_options_holder;
  73
  74   CORE_ADDR m_err_memaddr;
  75
  76   static int dis_asm_read_memory (bfd_vma memaddr, gdb_byte *myaddr,
  77                                   unsigned int len,
  78                                   struct disassemble_info *info);
  79   static void dis_asm_memory_error (int err, bfd_vma memaddr,
  80                                     struct disassemble_info *info);
  81   static void dis_asm_print_address (bfd_vma addr,
  82                                      struct disassemble_info *info);
  83 };
  84
  85 /* An instruction to be disassembled.  */
  86
  87 struct disasm_insn
  88 {
  89   /* The address of the memory containing the instruction.  */
  90   CORE_ADDR addr;
  91
  92   /* An optional instruction number.  If non-zero, it is printed first.  */
  93   unsigned int number;
  94
  95   /* True if the instruction was executed speculatively.  */
  96   unsigned int is_speculative:1;
  97 };
  98
  99 extern void gdb_disassembly (struct gdbarch *gdbarch, struct ui_out *uiout,
 100                              gdb_disassembly_flags flags, int how_many,
 101                              CORE_ADDR low, CORE_ADDR high);
 102
 103 /* Print the instruction at address MEMADDR in debugged memory,
 104    on STREAM.  Returns the length of the instruction, in bytes,
 105    and, if requested, the number of branch delay slot instructions.  */
 106
 107 extern int gdb_print_insn (struct gdbarch *gdbarch, CORE_ADDR memaddr,
 108                            struct ui_file *stream, int *branch_delay_insns);
 109
 110 /* Class used to pretty-print instructions.  */
 111
 112 class gdb_pretty_print_disassembler
 113 {
 114 public:
 115   explicit gdb_pretty_print_disassembler (struct gdbarch *gdbarch,
 116                                           struct ui_out *uiout)
 117     : m_uiout (uiout),
 118       m_insn_stb (uiout->can_emit_style_escape ()),
 119       m_di (gdbarch, &m_insn_stb)
 120   {}
 121
 122   /* Prints the instruction INSN into the saved ui_out and returns the
 123      length of the printed instruction in bytes.  */
 124   int pretty_print_insn (const struct disasm_insn *insn,
 125                          gdb_disassembly_flags flags);
 126
 127 private:
 128   /* Returns the architecture used for disassembling.  */
 129   struct gdbarch *arch () { return m_di.arch (); }
 130
 131   /* The ui_out that is used by pretty_print_insn.  */
 132   struct ui_out *m_uiout;
 133
 134   /* The buffer used to build the instruction string.  The
 135      disassembler is initialized with this stream.  */
 136   string_file m_insn_stb;
 137
 138   /* The disassembler used for instruction printing.  */
 139   gdb_disassembler m_di;
 140
 141   /* The buffer used to build the raw opcodes string.  */
 142   string_file m_opcode_stb;
 143 };
 144
 145 /* Return the length in bytes of the instruction at address MEMADDR in
 146    debugged memory.  */
 147
 148 extern int gdb_insn_length (struct gdbarch *gdbarch, CORE_ADDR memaddr);
 149
 150 /* Return the length in bytes of INSN, originally at MEMADDR.  MAX_LEN
 151    is the size of the buffer containing INSN.  */
 152
 153 extern int gdb_buffered_insn_length (struct gdbarch *gdbarch,
 154                                      const gdb_byte *insn, int max_len,
 155                                      CORE_ADDR memaddr);
 156
 157 /* Returns GDBARCH's disassembler options.  */
 158
 159 extern char *get_disassembler_options (struct gdbarch *gdbarch);
 160
 161 /* Sets the active gdbarch's disassembler options to OPTIONS.  */
 162
 163 extern void set_disassembler_options (char *options);
 164
 165 #endif