gdb/disasm.h

   1 /* Disassemble support for GDB.
   2    Copyright (C) 2002-2017 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
  24 #define DISASSEMBLY_SOURCE_DEPRECATED (0x1 << 0)
  25 #define DISASSEMBLY_RAW_INSN    (0x1 << 1)
  26 #define DISASSEMBLY_OMIT_FNAME  (0x1 << 2)
  27 #define DISASSEMBLY_FILENAME    (0x1 << 3)
  28 #define DISASSEMBLY_OMIT_PC     (0x1 << 4)
  29 #define DISASSEMBLY_SOURCE      (0x1 << 5)
  30 #define DISASSEMBLY_SPECULATIVE (0x1 << 6)
  31
  32 struct gdbarch;
  33 struct ui_out;
  34 struct ui_file;
  35
  36 class gdb_disassembler
  37 {
  38   using di_read_memory_ftype = decltype (disassemble_info::read_memory_func);
  39
  40 public:
  41   gdb_disassembler (struct gdbarch *gdbarch, struct ui_file *file)
  42     : gdb_disassembler (gdbarch, file, dis_asm_read_memory)
  43   {}
  44
  45   int print_insn (CORE_ADDR memaddr, int *branch_delay_insns = NULL);
  46
  47   /* Return the gdbarch of gdb_disassembler.  */
  48   struct gdbarch *arch ()
  49   { return m_gdbarch; }
  50
  51 protected:
  52   gdb_disassembler (struct gdbarch *gdbarch, struct ui_file *file,
  53                     di_read_memory_ftype func);
  54
  55   struct ui_file *stream ()
  56   { return (struct ui_file *) m_di.stream; }
  57
  58 private:
  59   struct gdbarch *m_gdbarch;
  60
  61   /* Stores data required for disassembling instructions in
  62      opcodes.  */
  63   struct disassemble_info m_di;
  64   CORE_ADDR m_err_memaddr;
  65
  66   static int dis_asm_read_memory (bfd_vma memaddr, gdb_byte *myaddr,
  67                                   unsigned int len,
  68                                   struct disassemble_info *info);
  69   static void dis_asm_memory_error (int err, bfd_vma memaddr,
  70                                     struct disassemble_info *info);
  71   static void dis_asm_print_address (bfd_vma addr,
  72                                      struct disassemble_info *info);
  73 };
  74
  75 /* An instruction to be disassembled.  */
  76
  77 struct disasm_insn
  78 {
  79   /* The address of the memory containing the instruction.  */
  80   CORE_ADDR addr;
  81
  82   /* An optional instruction number.  If non-zero, it is printed first.  */
  83   unsigned int number;
  84
  85   /* True if the instruction was executed speculatively.  */
  86   unsigned int is_speculative:1;
  87 };
  88
  89 extern void gdb_disassembly (struct gdbarch *gdbarch, struct ui_out *uiout,
  90                              int flags, int how_many,
  91                              CORE_ADDR low, CORE_ADDR high);
  92
  93 /* Print the instruction at address MEMADDR in debugged memory,
  94    on STREAM.  Returns the length of the instruction, in bytes,
  95    and, if requested, the number of branch delay slot instructions.  */
  96
  97 extern int gdb_print_insn (struct gdbarch *gdbarch, CORE_ADDR memaddr,
  98                            struct ui_file *stream, int *branch_delay_insns);
  99
 100 /* Class used to pretty-print instructions.  */
 101
 102 class gdb_pretty_print_disassembler
 103 {
 104 public:
 105   explicit gdb_pretty_print_disassembler (struct gdbarch *gdbarch)
 106     : m_di (gdbarch, &m_insn_stb)
 107   {}
 108
 109   /* Prints the instruction INSN into UIOUT and returns the length of
 110      the printed instruction in bytes.  */
 111   int pretty_print_insn (struct ui_out *uiout, const struct disasm_insn *insn,
 112                          int flags);
 113
 114 private:
 115   /* Returns the architecture used for disassembling.  */
 116   struct gdbarch *arch () { return m_di.arch (); }
 117
 118   /* The disassembler used for instruction printing.  */
 119   gdb_disassembler m_di;
 120
 121   /* The buffer used to build the instruction string.  The
 122      disassembler is initialized with this stream.  */
 123   string_file m_insn_stb;
 124
 125   /* The buffer used to build the raw opcodes string.  */
 126   string_file m_opcode_stb;
 127 };
 128
 129 /* Return the length in bytes of the instruction at address MEMADDR in
 130    debugged memory.  */
 131
 132 extern int gdb_insn_length (struct gdbarch *gdbarch, CORE_ADDR memaddr);
 133
 134 /* Return the length in bytes of INSN, originally at MEMADDR.  MAX_LEN
 135    is the size of the buffer containing INSN.  */
 136
 137 extern int gdb_buffered_insn_length (struct gdbarch *gdbarch,
 138                                      const gdb_byte *insn, int max_len,
 139                                      CORE_ADDR memaddr);
 140
 141 /* Returns GDBARCH's disassembler options.  */
 142
 143 extern char *get_disassembler_options (struct gdbarch *gdbarch);
 144
 145 /* Sets the active gdbarch's disassembler options to OPTIONS.  */
 146
 147 extern void set_disassembler_options (char *options);
 148
 149 #endif