1 /* Disassemble support for GDB.
2 Copyright (C) 2002-2019 Free Software Foundation, Inc.
4 This file is part of GDB.
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.
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.
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/>. */
23 #include "common/enum-flags.h"
25 enum gdb_disassembly_flag
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),
35 DEF_ENUM_FLAGS_TYPE (enum gdb_disassembly_flag
, gdb_disassembly_flags
);
41 class gdb_disassembler
43 using di_read_memory_ftype
= decltype (disassemble_info::read_memory_func
);
46 gdb_disassembler (struct gdbarch
*gdbarch
, struct ui_file
*file
)
47 : gdb_disassembler (gdbarch
, file
, dis_asm_read_memory
)
50 int print_insn (CORE_ADDR memaddr
, int *branch_delay_insns
= NULL
);
52 /* Return the gdbarch of gdb_disassembler. */
53 struct gdbarch
*arch ()
57 gdb_disassembler (struct gdbarch
*gdbarch
, struct ui_file
*file
,
58 di_read_memory_ftype func
);
60 struct ui_file
*stream ()
61 { return (struct ui_file
*) m_di
.stream
; }
64 struct gdbarch
*m_gdbarch
;
66 /* Stores data required for disassembling instructions in
68 struct disassemble_info m_di
;
70 /* If we own the string in `m_di.disassembler_options', we do so
72 std::string m_disassembler_options_holder
;
74 CORE_ADDR m_err_memaddr
;
76 static int dis_asm_read_memory (bfd_vma memaddr
, gdb_byte
*myaddr
,
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
);
85 /* An instruction to be disassembled. */
89 /* The address of the memory containing the instruction. */
92 /* An optional instruction number. If non-zero, it is printed first. */
95 /* True if the instruction was executed speculatively. */
96 unsigned int is_speculative
:1;
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
);
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. */
107 extern int gdb_print_insn (struct gdbarch
*gdbarch
, CORE_ADDR memaddr
,
108 struct ui_file
*stream
, int *branch_delay_insns
);
110 /* Class used to pretty-print instructions. */
112 class gdb_pretty_print_disassembler
115 explicit gdb_pretty_print_disassembler (struct gdbarch
*gdbarch
)
116 : m_di (gdbarch
, &m_insn_stb
)
119 /* Prints the instruction INSN into UIOUT and returns the length of
120 the printed instruction in bytes. */
121 int pretty_print_insn (struct ui_out
*uiout
, const struct disasm_insn
*insn
,
122 gdb_disassembly_flags flags
);
125 /* Returns the architecture used for disassembling. */
126 struct gdbarch
*arch () { return m_di
.arch (); }
128 /* The disassembler used for instruction printing. */
129 gdb_disassembler m_di
;
131 /* The buffer used to build the instruction string. The
132 disassembler is initialized with this stream. */
133 string_file m_insn_stb
;
135 /* The buffer used to build the raw opcodes string. */
136 string_file m_opcode_stb
;
139 /* Return the length in bytes of the instruction at address MEMADDR in
142 extern int gdb_insn_length (struct gdbarch
*gdbarch
, CORE_ADDR memaddr
);
144 /* Return the length in bytes of INSN, originally at MEMADDR. MAX_LEN
145 is the size of the buffer containing INSN. */
147 extern int gdb_buffered_insn_length (struct gdbarch
*gdbarch
,
148 const gdb_byte
*insn
, int max_len
,
151 /* Returns GDBARCH's disassembler options. */
153 extern char *get_disassembler_options (struct gdbarch
*gdbarch
);
155 /* Sets the active gdbarch's disassembler options to OPTIONS. */
157 extern void set_disassembler_options (char *options
);