| 1 | /* Disassemble support for GDB. |
| 2 | Copyright (C) 2002-2018 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 "common/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 | CORE_ADDR m_err_memaddr; |
| 70 | |
| 71 | static int dis_asm_read_memory (bfd_vma memaddr, gdb_byte *myaddr, |
| 72 | unsigned int len, |
| 73 | struct disassemble_info *info); |
| 74 | static void dis_asm_memory_error (int err, bfd_vma memaddr, |
| 75 | struct disassemble_info *info); |
| 76 | static void dis_asm_print_address (bfd_vma addr, |
| 77 | struct disassemble_info *info); |
| 78 | }; |
| 79 | |
| 80 | /* An instruction to be disassembled. */ |
| 81 | |
| 82 | struct disasm_insn |
| 83 | { |
| 84 | /* The address of the memory containing the instruction. */ |
| 85 | CORE_ADDR addr; |
| 86 | |
| 87 | /* An optional instruction number. If non-zero, it is printed first. */ |
| 88 | unsigned int number; |
| 89 | |
| 90 | /* True if the instruction was executed speculatively. */ |
| 91 | unsigned int is_speculative:1; |
| 92 | }; |
| 93 | |
| 94 | extern void gdb_disassembly (struct gdbarch *gdbarch, struct ui_out *uiout, |
| 95 | gdb_disassembly_flags flags, int how_many, |
| 96 | CORE_ADDR low, CORE_ADDR high); |
| 97 | |
| 98 | /* Print the instruction at address MEMADDR in debugged memory, |
| 99 | on STREAM. Returns the length of the instruction, in bytes, |
| 100 | and, if requested, the number of branch delay slot instructions. */ |
| 101 | |
| 102 | extern int gdb_print_insn (struct gdbarch *gdbarch, CORE_ADDR memaddr, |
| 103 | struct ui_file *stream, int *branch_delay_insns); |
| 104 | |
| 105 | /* Class used to pretty-print instructions. */ |
| 106 | |
| 107 | class gdb_pretty_print_disassembler |
| 108 | { |
| 109 | public: |
| 110 | explicit gdb_pretty_print_disassembler (struct gdbarch *gdbarch) |
| 111 | : m_di (gdbarch, &m_insn_stb) |
| 112 | {} |
| 113 | |
| 114 | /* Prints the instruction INSN into UIOUT and returns the length of |
| 115 | the printed instruction in bytes. */ |
| 116 | int pretty_print_insn (struct ui_out *uiout, const struct disasm_insn *insn, |
| 117 | gdb_disassembly_flags flags); |
| 118 | |
| 119 | private: |
| 120 | /* Returns the architecture used for disassembling. */ |
| 121 | struct gdbarch *arch () { return m_di.arch (); } |
| 122 | |
| 123 | /* The disassembler used for instruction printing. */ |
| 124 | gdb_disassembler m_di; |
| 125 | |
| 126 | /* The buffer used to build the instruction string. The |
| 127 | disassembler is initialized with this stream. */ |
| 128 | string_file m_insn_stb; |
| 129 | |
| 130 | /* The buffer used to build the raw opcodes string. */ |
| 131 | string_file m_opcode_stb; |
| 132 | }; |
| 133 | |
| 134 | /* Return the length in bytes of the instruction at address MEMADDR in |
| 135 | debugged memory. */ |
| 136 | |
| 137 | extern int gdb_insn_length (struct gdbarch *gdbarch, CORE_ADDR memaddr); |
| 138 | |
| 139 | /* Return the length in bytes of INSN, originally at MEMADDR. MAX_LEN |
| 140 | is the size of the buffer containing INSN. */ |
| 141 | |
| 142 | extern int gdb_buffered_insn_length (struct gdbarch *gdbarch, |
| 143 | const gdb_byte *insn, int max_len, |
| 144 | CORE_ADDR memaddr); |
| 145 | |
| 146 | /* Returns GDBARCH's disassembler options. */ |
| 147 | |
| 148 | extern char *get_disassembler_options (struct gdbarch *gdbarch); |
| 149 | |
| 150 | /* Sets the active gdbarch's disassembler options to OPTIONS. */ |
| 151 | |
| 152 | extern void set_disassembler_options (char *options); |
| 153 | |
| 154 | #endif |