/* Format disassembler output to STREAM. */
int
-gdb_disassembler::dis_asm_fprintf (void *stream, const char *format, ...)
+gdb_printing_disassembler::fprintf_func (void *stream,
+ const char *format, ...)
{
va_list args;
/* See disasm.h. */
int
-gdb_disassembler::dis_asm_styled_fprintf (void *stream,
- enum disassembler_style style,
- const char *format, ...)
+gdb_printing_disassembler::fprintf_styled_func (void *stream,
+ enum disassembler_style style,
+ const char *format, ...)
{
va_list args;
gdb_disassembler::gdb_disassembler (struct gdbarch *gdbarch,
struct ui_file *file,
- di_read_memory_ftype read_memory_func)
- : m_gdbarch (gdbarch),
+ read_memory_ftype func)
+ : gdb_printing_disassembler (gdbarch, &m_buffer, func,
+ dis_asm_memory_error, dis_asm_print_address),
m_buffer (!use_ext_lang_colorization_p && disassembler_styling
&& file->can_emit_style_escape ()),
m_dest (file)
+{ /* Nothing. */ }
+
+/* See disasm.h. */
+
+gdb_disassemble_info::gdb_disassemble_info
+ (struct gdbarch *gdbarch, struct ui_file *stream,
+ read_memory_ftype read_memory_func, memory_error_ftype memory_error_func,
+ print_address_ftype print_address_func, fprintf_ftype fprintf_func,
+ fprintf_styled_ftype fprintf_styled_func)
+ : m_gdbarch (gdbarch)
{
- init_disassemble_info (&m_di, &m_buffer, dis_asm_fprintf,
- dis_asm_styled_fprintf);
+ gdb_assert (fprintf_func != nullptr);
+ gdb_assert (fprintf_styled_func != nullptr);
+ init_disassemble_info (&m_di, stream, fprintf_func,
+ fprintf_styled_func);
m_di.flavour = bfd_target_unknown_flavour;
- m_di.memory_error_func = dis_asm_memory_error;
- m_di.print_address_func = dis_asm_print_address;
- /* NOTE: cagney/2003-04-28: The original code, from the old Insight
- disassembler had a local optimization here. By default it would
- access the executable file, instead of the target memory (there
- was a growing list of exceptions though). Unfortunately, the
- heuristic was flawed. Commands like "disassemble &variable"
- didn't work as they relied on the access going to the target.
- Further, it has been superseeded by trust-read-only-sections
- (although that should be superseeded by target_trust..._p()). */
- m_di.read_memory_func = read_memory_func;
+
+ /* The memory_error_func, print_address_func, and read_memory_func are
+ all initialized to a default (non-nullptr) value by the call to
+ init_disassemble_info above. If the user is overriding these fields
+ (by passing non-nullptr values) then do that now, otherwise, leave
+ these fields as the defaults. */
+ if (memory_error_func != nullptr)
+ m_di.memory_error_func = memory_error_func;
+ if (print_address_func != nullptr)
+ m_di.print_address_func = print_address_func;
+ if (read_memory_func != nullptr)
+ m_di.read_memory_func = read_memory_func;
+
m_di.arch = gdbarch_bfd_arch_info (gdbarch)->arch;
m_di.mach = gdbarch_bfd_arch_info (gdbarch)->mach;
m_di.endian = gdbarch_byte_order (gdbarch);
disassemble_init_for_target (&m_di);
}
-gdb_disassembler::~gdb_disassembler ()
+/* See disasm.h. */
+
+gdb_disassemble_info::~gdb_disassemble_info ()
{
disassemble_free_target (&m_di);
}
struct ui_out;
struct ui_file;
-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)
- {}
+/* A wrapper around a disassemble_info and a gdbarch. This is the core
+ set of data that all disassembler sub-classes will need. This class
+ doesn't actually implement the disassembling process, that is something
+ that sub-classes will do, with each sub-class doing things slightly
+ differently.
- ~gdb_disassembler ();
+ The constructor of this class is protected, you should not create
+ instances of this class directly, instead create an instance of an
+ appropriate sub-class. */
- DISABLE_COPY_AND_ASSIGN (gdb_disassembler);
-
- int print_insn (CORE_ADDR memaddr, int *branch_delay_insns = NULL);
+struct gdb_disassemble_info
+{
+ DISABLE_COPY_AND_ASSIGN (gdb_disassemble_info);
- /* Return the gdbarch of gdb_disassembler. */
+ /* Return the gdbarch we are disassembling for. */
struct gdbarch *arch ()
{ return m_gdbarch; }
+ /* Return a pointer to the disassemble_info, this will be needed for
+ passing into the libopcodes disassembler. */
+ struct disassemble_info *disasm_info ()
+ { return &m_di; }
+
protected:
- gdb_disassembler (struct gdbarch *gdbarch, struct ui_file *file,
- di_read_memory_ftype func);
+ /* Types for the function callbacks within m_di. */
+ using read_memory_ftype = decltype (disassemble_info::read_memory_func);
+ using memory_error_ftype = decltype (disassemble_info::memory_error_func);
+ using print_address_ftype = decltype (disassemble_info::print_address_func);
+ using fprintf_ftype = decltype (disassemble_info::fprintf_func);
+ using fprintf_styled_ftype = decltype (disassemble_info::fprintf_styled_func);
+
+ /* Constructor, many fields in m_di are initialized from GDBARCH. STREAM
+ is where the output of the disassembler will be written too, the
+ remaining arguments are function callbacks that are written into
+ m_di. Of these function callbacks FPRINTF_FUNC and
+ FPRINTF_STYLED_FUNC must not be nullptr. If READ_MEMORY_FUNC,
+ MEMORY_ERROR_FUNC, or PRINT_ADDRESS_FUNC are nullptr, then that field
+ within m_di is left with its default value (see the libopcodes
+ function init_disassemble_info for the defaults). */
+ gdb_disassemble_info (struct gdbarch *gdbarch,
+ struct ui_file *stream,
+ read_memory_ftype read_memory_func,
+ memory_error_ftype memory_error_func,
+ print_address_ftype print_address_func,
+ fprintf_ftype fprintf_func,
+ fprintf_styled_ftype fprintf_styled_func);
+
+ /* Destructor. */
+ virtual ~gdb_disassemble_info ();
+
+ /* The stream that disassembler output is being written too. */
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;
+private:
+ /* The architecture we are disassembling for. */
+ struct gdbarch *m_gdbarch;
+
/* If we own the string in `m_di.disassembler_options', we do so
using this field. */
std::string m_disassembler_options_holder;
+};
+
+/* A wrapper around gdb_disassemble_info. This class adds default
+ print functions that are supplied to the disassemble_info within the
+ parent class. These default print functions write to the stream, which
+ is also contained in the parent class.
+
+ As with the parent class, the constructor for this class is protected,
+ you should not create instances of this class, but create an
+ appropriate sub-class instead. */
+struct gdb_printing_disassembler : public gdb_disassemble_info
+{
+ DISABLE_COPY_AND_ASSIGN (gdb_printing_disassembler);
+
+protected:
+
+ /* Constructor. All the arguments are just passed to the parent class.
+ We also add the two print functions to the arguments passed to the
+ parent. See gdb_disassemble_info for a description of how the
+ arguments are handled. */
+ gdb_printing_disassembler (struct gdbarch *gdbarch,
+ struct ui_file *stream,
+ read_memory_ftype read_memory_func,
+ memory_error_ftype memory_error_func,
+ print_address_ftype print_address_func)
+ : gdb_disassemble_info (gdbarch, stream, read_memory_func,
+ memory_error_func, print_address_func,
+ fprintf_func, fprintf_styled_func)
+ { /* Nothing. */ }
+
+ /* Callback used as the disassemble_info's fprintf_func callback, this
+ writes to STREAM, which will be m_di.stream. */
+ static int fprintf_func (void *stream, const char *format, ...)
+ ATTRIBUTE_PRINTF(2,3);
+
+ /* Callback used as the disassemble_info's fprintf_styled_func callback,
+ this writes to STREAM, which will be m_di.stream. */
+ static int fprintf_styled_func (void *stream,
+ enum disassembler_style style,
+ const char *format, ...)
+ ATTRIBUTE_PRINTF(3,4);
+};
+
+/* A dissassembler class that provides 'print_insn', a method for
+ disassembling a single instruction to the output stream. */
+
+struct gdb_disassembler : public gdb_printing_disassembler
+{
+ gdb_disassembler (struct gdbarch *gdbarch, struct ui_file *file)
+ : gdb_disassembler (gdbarch, file, dis_asm_read_memory)
+ { /* Nothing. */ }
+
+ DISABLE_COPY_AND_ASSIGN (gdb_disassembler);
+
+ /* Disassemble a single instruction at MEMADDR to the ui_file* that was
+ passed to the constructor. If a memory error occurs while
+ disassembling this instruction then an error will be thrown. */
+ int print_insn (CORE_ADDR memaddr, int *branch_delay_insns = NULL);
+
+protected:
+ gdb_disassembler (struct gdbarch *gdbarch, struct ui_file *file,
+ read_memory_ftype func);
+
+private:
/* This member variable is given a value by calling dis_asm_memory_error.
If after calling into the libopcodes disassembler we get back a
negative value (which indicates an error), then, if this variable has
(currently just to addresses and symbols) as it goes. */
static bool use_ext_lang_colorization_p;
- static int dis_asm_fprintf (void *stream, const char *format, ...)
- ATTRIBUTE_PRINTF(2,3);
-
- /* Print formatted message to STREAM, the content can be styled based on
- STYLE if desired. */
- static int dis_asm_styled_fprintf (void *stream,
- enum disassembler_style style,
- const char *format, ...)
- ATTRIBUTE_PRINTF(3,4);
-
static int dis_asm_read_memory (bfd_vma memaddr, gdb_byte *myaddr,
unsigned int len,
struct disassemble_info *info);
projects / binutils-gdb.git / commitdiff