X-Git-Url: https://git.libre-soc.org/?a=blobdiff_plain;f=gdb%2Fdisasm.c;h=f2df5ef7bc5b7c3e07f13cf8eda85c09abbcf4e7;hb=202be274a41a912f705141d9fb3574f4b0d415e1;hp=164939b58826ded1b08455b22b2e558188676275;hpb=39ef2f6256737db92f5d60fa201fe0b301bb8100;p=binutils-gdb.git diff --git a/gdb/disasm.c b/gdb/disasm.c index 164939b5882..f2df5ef7bc5 100644 --- a/gdb/disasm.c +++ b/gdb/disasm.c @@ -1,6 +1,6 @@ /* Disassemble support for GDB. - Copyright (C) 2000-2019 Free Software Foundation, Inc. + Copyright (C) 2000-2022 Free Software Foundation, Inc. This file is part of GDB. @@ -39,7 +39,7 @@ /* This variable is used to hold the prospective disassembler_options value which is set by the "set disassembler_options" command. */ -static char *prospective_options = NULL; +static std::string prospective_options; /* This structure is used to store line number information for the deprecated /m option. @@ -148,7 +148,7 @@ gdb_disassembler::dis_asm_memory_error (int err, bfd_vma memaddr, gdb_disassembler *self = static_cast(info->application_data); - self->m_err_memaddr = memaddr; + self->m_err_memaddr.emplace (memaddr); } /* Wrapper of print_address. */ @@ -163,6 +163,36 @@ gdb_disassembler::dis_asm_print_address (bfd_vma addr, print_address (self->arch (), addr, self->stream ()); } +/* Format disassembler output to STREAM. */ + +int +gdb_disassembler::dis_asm_fprintf (void *stream, const char *format, ...) +{ + va_list args; + + va_start (args, format); + gdb_vprintf ((struct ui_file *) stream, format, args); + va_end (args); + /* Something non -ve. */ + return 0; +} + +/* See disasm.h. */ + +int +gdb_disassembler::dis_asm_styled_fprintf (void *stream, + enum disassembler_style style, + const char *format, ...) +{ + va_list args; + + va_start (args, format); + gdb_vprintf ((struct ui_file *) stream, format, args); + va_end (args); + /* Something non -ve. */ + return 0; +} + static bool line_is_less_than (const deprecated_dis_line_entry &mle1, const deprecated_dis_line_entry &mle2) @@ -175,15 +205,15 @@ line_is_less_than (const deprecated_dis_line_entry &mle1, { if (mle1.start_pc != mle2.start_pc) val = mle1.start_pc < mle2.start_pc; - else - val = mle1.line < mle2.line; + else + val = mle1.line < mle2.line; } else { if (mle1.line != mle2.line) val = mle1.line < mle2.line; else - val = mle1.start_pc < mle2.start_pc; + val = mle1.start_pc < mle2.start_pc; } return val; } @@ -238,13 +268,13 @@ gdb_pretty_print_disassembler::pretty_print_insn (const struct disasm_insn *insn std::string name, filename; bool omit_fname = ((flags & DISASSEMBLY_OMIT_FNAME) != 0); if (!build_address_symbolic (gdbarch, pc, false, omit_fname, &name, - &offset, &filename, &line, &unmapped)) + &offset, &filename, &line, &unmapped)) { /* We don't care now about line, filename and unmapped. But we might in the future. */ m_uiout->text (" <"); if (!omit_fname) - m_uiout->field_string ("func-name", name.c_str (), + m_uiout->field_string ("func-name", name, function_name_style.style ()); /* For negative offsets, avoid displaying them as +-N; the sign of the offset takes the place of the "+" here. */ @@ -256,8 +286,40 @@ gdb_pretty_print_disassembler::pretty_print_insn (const struct disasm_insn *insn else m_uiout->text (":\t"); + /* Clear the buffer into which we will disassemble the instruction. */ m_insn_stb.clear (); + /* A helper function to write the M_INSN_STB buffer, followed by a + newline. This can be called in a couple of situations. */ + auto write_out_insn_buffer = [&] () + { + m_uiout->field_stream ("inst", m_insn_stb); + m_uiout->text ("\n"); + }; + + try + { + /* Now we can disassemble the instruction. If the disassembler + returns a negative value this indicates an error and is handled + within the print_insn call, resulting in an exception being + thrown. Returning zero makes no sense, as this indicates we + disassembled something successfully, but it was something of no + size? */ + size = m_di.print_insn (pc); + gdb_assert (size > 0); + } + catch (const gdb_exception &ex) + { + /* An exception was thrown while disassembling the instruction. + However, the disassembler might still have written something + out, so ensure that we flush the instruction buffer before + rethrowing the exception. We can't perform this write from an + object destructor as the write itself might throw an exception + if the pager kicks in, and the user selects quit. */ + write_out_insn_buffer (); + throw ex; + } + if (flags & DISASSEMBLY_RAW_INSN) { CORE_ADDR end_pc; @@ -268,7 +330,6 @@ gdb_pretty_print_disassembler::pretty_print_insn (const struct disasm_insn *insn write them out in a single go for the MI. */ m_opcode_stb.clear (); - size = m_di.print_insn (pc); end_pc = pc + size; for (;pc < end_pc; ++pc) @@ -281,12 +342,10 @@ gdb_pretty_print_disassembler::pretty_print_insn (const struct disasm_insn *insn m_uiout->field_stream ("opcodes", m_opcode_stb); m_uiout->text ("\t"); } - else - size = m_di.print_insn (pc); - m_uiout->field_stream ("inst", m_insn_stb); + /* Disassembly was a success, write out the instruction buffer. */ + write_out_insn_buffer (); } - m_uiout->text ("\n"); return size; } @@ -350,10 +409,10 @@ do_mixed_source_and_assembly_deprecated int num_displayed = 0; print_source_lines_flags psl_flags = 0; - gdb_assert (symtab != NULL && SYMTAB_LINETABLE (symtab) != NULL); + gdb_assert (symtab != nullptr && symtab->linetable () != nullptr); - nlines = SYMTAB_LINETABLE (symtab)->nitems; - le = SYMTAB_LINETABLE (symtab)->item; + nlines = symtab->linetable ()->nitems; + le = symtab->linetable ()->item; if (flags & DISASSEMBLY_FILENAME) psl_flags |= PRINT_SOURCE_LINES_FILENAME; @@ -460,7 +519,7 @@ do_mixed_source_and_assembly_deprecated how_many, flags, NULL); /* When we've reached the end of the mle array, or we've seen the last - assembly range for this source line, close out the list/tuple. */ + assembly range for this source line, close out the list/tuple. */ if (i == (newlines - 1) || mle[i + 1].line > mle[i].line) { inner_list_emitter.reset (); @@ -492,7 +551,7 @@ do_mixed_source_and_assembly (struct gdbarch *gdbarch, struct symtab *last_symtab; int last_line; - gdb_assert (main_symtab != NULL && SYMTAB_LINETABLE (main_symtab) != NULL); + gdb_assert (main_symtab != NULL && main_symtab->linetable () != NULL); /* First pass: collect the list of all source files and lines. We do this so that we can only print lines containing code once. @@ -510,8 +569,8 @@ do_mixed_source_and_assembly (struct gdbarch *gdbarch, line after the opening brace. We still want to print this opening brace. first_le is used to implement this. */ - nlines = SYMTAB_LINETABLE (main_symtab)->nitems; - le = SYMTAB_LINETABLE (main_symtab)->item; + nlines = main_symtab->linetable ()->nitems; + le = main_symtab->linetable ()->item; first_le = NULL; /* Skip all the preceding functions. */ @@ -711,21 +770,6 @@ do_assembly_only (struct gdbarch *gdbarch, struct ui_out *uiout, dump_insns (gdbarch, uiout, low, high, how_many, flags, NULL); } -/* Initialize the disassemble info struct ready for the specified - stream. */ - -static int ATTRIBUTE_PRINTF (2, 3) -fprintf_disasm (void *stream, const char *format, ...) -{ - va_list args; - - va_start (args, format); - vfprintf_filtered ((struct ui_file *) stream, format, args); - va_end (args); - /* Something non -ve. */ - return 0; -} - /* Combine implicit and user disassembler options and return them in a newly-created string. */ @@ -755,9 +799,12 @@ gdb_disassembler::gdb_disassembler (struct gdbarch *gdbarch, struct ui_file *file, di_read_memory_ftype read_memory_func) : m_gdbarch (gdbarch), - m_err_memaddr (0) + m_buffer (!use_ext_lang_colorization_p && disassembler_styling + && file->can_emit_style_escape ()), + m_dest (file) { - init_disassemble_info (&m_di, file, fprintf_disasm); + init_disassemble_info (&m_di, &m_buffer, dis_asm_fprintf, + dis_asm_styled_fprintf); 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; @@ -781,16 +828,77 @@ gdb_disassembler::gdb_disassembler (struct gdbarch *gdbarch, disassemble_init_for_target (&m_di); } +gdb_disassembler::~gdb_disassembler () +{ + disassemble_free_target (&m_di); +} + +/* See disasm.h. */ + +bool gdb_disassembler::use_ext_lang_colorization_p = true; + +/* See disasm.h. */ + int gdb_disassembler::print_insn (CORE_ADDR memaddr, int *branch_delay_insns) { - m_err_memaddr = 0; + m_err_memaddr.reset (); + m_buffer.clear (); int length = gdbarch_print_insn (arch (), memaddr, &m_di); + /* If we have successfully disassembled an instruction, styling is on, we + think that the extension language might be able to perform styling for + us, and the destination can support styling, then lets call into the + extension languages in order to style this output. */ + if (length > 0 && disassembler_styling + && use_ext_lang_colorization_p + && m_dest->can_emit_style_escape ()) + { + gdb::optional ext_contents; + ext_contents = ext_lang_colorize_disasm (m_buffer.string (), arch ()); + if (ext_contents.has_value ()) + m_buffer = std::move (*ext_contents); + else + { + /* The extension language failed to add styling to the + disassembly output. Set the static flag so that next time we + disassemble we don't even bother attempting to use the + extension language for styling. */ + use_ext_lang_colorization_p = false; + + /* The instruction we just disassembled, and the extension + languages failed to style, might have otherwise had some + minimal styling applied by GDB. To regain that styling we + need to recreate m_buffer, but this time with styling support. + + To do this we perform an in-place new, but this time turn on + the styling support, then we can re-disassembly the + instruction, and gain any minimal styling GDB might add. */ + gdb_static_assert ((std::is_same::value)); + gdb_assert (!m_buffer.term_out ()); + m_buffer.~string_file (); + new (&m_buffer) string_file (true); + length = gdbarch_print_insn (arch (), memaddr, &m_di); + gdb_assert (length > 0); + } + } + + /* Push any disassemble output to the real destination stream. We do + this even if the disassembler reported failure (-1) as the + disassembler may have printed something to its output stream. */ + m_di.fprintf_func (m_dest, "%s", m_buffer.c_str ()); + + /* If the disassembler failed then report an appropriate error. */ if (length < 0) - memory_error (TARGET_XFER_E_IO, m_err_memaddr); + { + if (m_err_memaddr.has_value ()) + memory_error (TARGET_XFER_E_IO, *m_err_memaddr); + else + error (_("unknown disassembler error (error = %d)"), length); + } if (branch_delay_insns != NULL) { @@ -813,8 +921,8 @@ gdb_disassembly (struct gdbarch *gdbarch, struct ui_out *uiout, /* Assume symtab is valid for whole PC range. */ symtab = find_pc_line_symtab (low); - if (symtab != NULL && SYMTAB_LINETABLE (symtab) != NULL) - nlines = SYMTAB_LINETABLE (symtab)->nitems; + if (symtab != NULL && symtab->linetable () != NULL) + nlines = symtab->linetable ()->nitems; if (!(flags & (DISASSEMBLY_SOURCE_DEPRECATED | DISASSEMBLY_SOURCE)) || nlines <= 0) @@ -854,16 +962,36 @@ gdb_insn_length (struct gdbarch *gdbarch, CORE_ADDR addr) return gdb_print_insn (gdbarch, addr, &null_stream, NULL); } -/* fprintf-function for gdb_buffered_insn_length. This function is a - nop, we don't want to print anything, we just want to compute the - length of the insn. */ +/* An fprintf-function for use by the disassembler when we know we don't + want to print anything. Always returns success. */ static int ATTRIBUTE_PRINTF (2, 3) -gdb_buffered_insn_length_fprintf (void *stream, const char *format, ...) +gdb_disasm_null_printf (void *stream, const char *format, ...) { return 0; } +/* An fprintf-function for use by the disassembler when we know we don't + want to print anything, and the disassembler is using style. Always + returns success. */ + +static int ATTRIBUTE_PRINTF (3, 4) +gdb_disasm_null_styled_printf (void *stream, + enum disassembler_style style, + const char *format, ...) +{ + return 0; +} + +/* See disasm.h. */ + +void +init_disassemble_info_for_no_printing (struct disassemble_info *dinfo) +{ + init_disassemble_info (dinfo, nullptr, gdb_disasm_null_printf, + gdb_disasm_null_styled_printf); +} + /* Initialize a struct disassemble_info for gdb_buffered_insn_length. Upon return, *DISASSEMBLER_OPTIONS_HOLDER owns the string pointed to by DI.DISASSEMBLER_OPTIONS. */ @@ -875,7 +1003,7 @@ gdb_buffered_insn_length_init_dis (struct gdbarch *gdbarch, CORE_ADDR addr, std::string *disassembler_options_holder) { - init_disassemble_info (di, NULL, gdb_buffered_insn_length_fprintf); + init_disassemble_info_for_no_printing (di); /* init_disassemble_info installs buffer_read_memory, etc. so we don't need to do that here. @@ -908,7 +1036,9 @@ gdb_buffered_insn_length (struct gdbarch *gdbarch, gdb_buffered_insn_length_init_dis (gdbarch, &di, insn, max_len, addr, &disassembler_options_holder); - return gdbarch_print_insn (gdbarch, addr, &di); + int result = gdbarch_print_insn (gdbarch, addr, &di); + disassemble_free_target (&di); + return result; } char * @@ -921,13 +1051,16 @@ get_disassembler_options (struct gdbarch *gdbarch) } void -set_disassembler_options (char *prospective_options) +set_disassembler_options (const char *prospective_options) { struct gdbarch *gdbarch = get_current_arch (); char **disassembler_options = gdbarch_disassembler_options (gdbarch); const disasm_options_and_args_t *valid_options_and_args; const disasm_options_t *valid_options; - char *options = remove_whitespace_and_extra_commas (prospective_options); + gdb::unique_xmalloc_ptr prospective_options_local + = make_unique_xstrdup (prospective_options); + char *options = remove_whitespace_and_extra_commas + (prospective_options_local.get ()); const char *opt; /* Allow all architectures, even ones that do not support 'set disassembler', @@ -945,7 +1078,7 @@ set_disassembler_options (char *prospective_options) valid_options_and_args = gdbarch_valid_disassembler_options (gdbarch); if (valid_options_and_args == NULL) { - fprintf_filtered (gdb_stderr, _("\ + gdb_printf (gdb_stderr, _("\ 'set disassembler-options ...' is not supported on this architecture.\n")); return; } @@ -981,9 +1114,9 @@ set_disassembler_options (char *prospective_options) break; if (valid_options->name[i] == NULL) { - fprintf_filtered (gdb_stderr, - _("Invalid disassembler option value: '%s'.\n"), - opt); + gdb_printf (gdb_stderr, + _("Invalid disassembler option value: '%s'.\n"), + opt); return; } } @@ -996,7 +1129,7 @@ static void set_disassembler_options_sfunc (const char *args, int from_tty, struct cmd_list_element *c) { - set_disassembler_options (prospective_options); + set_disassembler_options (prospective_options.c_str ()); } static void @@ -1012,22 +1145,22 @@ show_disassembler_options_sfunc (struct ui_file *file, int from_tty, if (options == NULL) options = ""; - fprintf_filtered (file, _("The current disassembler options are '%s'\n\n"), - options); + gdb_printf (file, _("The current disassembler options are '%s'\n\n"), + options); valid_options_and_args = gdbarch_valid_disassembler_options (gdbarch); if (valid_options_and_args == NULL) { - fputs_filtered (_("There are no disassembler options available " - "for this architecture.\n"), - file); + gdb_puts (_("There are no disassembler options available " + "for this architecture.\n"), + file); return; } valid_options = &valid_options_and_args->options; - fprintf_filtered (file, _("\ + gdb_printf (file, _("\ The following disassembler options are supported for use with the\n\ 'set disassembler-options OPTION [,OPTION]...' command:\n")); @@ -1035,7 +1168,7 @@ The following disassembler options are supported for use with the\n\ { size_t i, max_len = 0; - fprintf_filtered (file, "\n"); + gdb_printf (file, "\n"); /* Compute the length of the longest option name. */ for (i = 0; valid_options->name[i] != NULL; i++) @@ -1050,35 +1183,35 @@ The following disassembler options are supported for use with the\n\ for (i = 0, max_len++; valid_options->name[i] != NULL; i++) { - fprintf_filtered (file, " %s", valid_options->name[i]); + gdb_printf (file, " %s", valid_options->name[i]); if (valid_options->arg != NULL && valid_options->arg[i] != NULL) - fprintf_filtered (file, "%s", valid_options->arg[i]->name); + gdb_printf (file, "%s", valid_options->arg[i]->name); if (valid_options->description[i] != NULL) { size_t len = strlen (valid_options->name[i]); if (valid_options->arg != NULL && valid_options->arg[i] != NULL) len += strlen (valid_options->arg[i]->name); - fprintf_filtered (file, "%*c %s", (int) (max_len - len), ' ', - valid_options->description[i]); + gdb_printf (file, "%*c %s", (int) (max_len - len), ' ', + valid_options->description[i]); } - fprintf_filtered (file, "\n"); + gdb_printf (file, "\n"); } } else { size_t i; - fprintf_filtered (file, " "); + gdb_printf (file, " "); for (i = 0; valid_options->name[i] != NULL; i++) { - fprintf_filtered (file, "%s", valid_options->name[i]); + gdb_printf (file, "%s", valid_options->name[i]); if (valid_options->arg != NULL && valid_options->arg[i] != NULL) - fprintf_filtered (file, "%s", valid_options->arg[i]->name); + gdb_printf (file, "%s", valid_options->arg[i]->name); if (valid_options->name[i + 1] != NULL) - fprintf_filtered (file, ", "); - wrap_here (" "); + gdb_printf (file, ", "); + file->wrap_here (2); } - fprintf_filtered (file, "\n"); + gdb_printf (file, "\n"); } valid_args = valid_options_and_args->args; @@ -1088,15 +1221,15 @@ The following disassembler options are supported for use with the\n\ for (i = 0; valid_args[i].name != NULL; i++) { - fprintf_filtered (file, _("\n\ + gdb_printf (file, _("\n\ For the options above, the following values are supported for \"%s\":\n "), - valid_args[i].name); + valid_args[i].name); for (j = 0; valid_args[i].values[j] != NULL; j++) { - fprintf_filtered (file, " %s", valid_args[i].values[j]); - wrap_here (" "); + gdb_printf (file, " %s", valid_args[i].values[j]); + file->wrap_here (3); } - fprintf_filtered (file, "\n"); + gdb_printf (file, "\n"); } } } @@ -1128,14 +1261,14 @@ disassembler_options_completer (struct cmd_list_element *ignore, /* Initialization code. */ +void _initialize_disasm (); void -_initialize_disasm (void) +_initialize_disasm () { - struct cmd_list_element *cmd; - /* Add the command that controls the disassembler options. */ - cmd = add_setshow_string_noescape_cmd ("disassembler-options", no_class, - &prospective_options, _("\ + set_show_commands set_show_disas_opts + = add_setshow_string_noescape_cmd ("disassembler-options", no_class, + &prospective_options, _("\ Set the disassembler options.\n\ Usage: set disassembler-options OPTION [,OPTION]...\n\n\ See: 'show disassembler-options' for valid option values."), _("\ @@ -1143,5 +1276,5 @@ Show the disassembler options."), NULL, set_disassembler_options_sfunc, show_disassembler_options_sfunc, &setlist, &showlist); - set_cmd_completer (cmd, disassembler_options_completer); + set_cmd_completer (set_show_disas_opts.set, disassembler_options_completer); }