From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) by sourceware.org (Postfix) with ESMTPS id E9FC3385781C for ; Wed, 16 Feb 2022 20:53:47 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.1 sourceware.org E9FC3385781C Received: from mail-wr1-f69.google.com (mail-wr1-f69.google.com [209.85.221.69]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-342-zc7_8-_fNtaXTjCfLzxZcA-1; Wed, 16 Feb 2022 15:53:40 -0500 X-MC-Unique: zc7_8-_fNtaXTjCfLzxZcA-1 Received: by mail-wr1-f69.google.com with SMTP id v17-20020adfc5d1000000b001e6405c2b56so1520306wrg.7 for ; Wed, 16 Feb 2022 12:53:40 -0800 (PST) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=gvyf6RwMcSET/5VFr0i3xsOEZzf/BmcGDTr3+DIKFbs=; b=p5RZyEg8WAGJxyNKOSC5R5AL2rrv+T3A/lUcYaKelVXUQOx3OE4tJ6X3F77Ej8WM34 twUyXyINMTzR1MEM0a3Kzj3lCs+1CoNM2/+yU1+EZcEz7jnA0bbp+3rsfhMY2uLa/vcv PLIwIcuR6X1qlJXp5le3V9B3s1gk7OT0SCScCNvDr1ijP00Rwe7zvrOOd587K9KSaS/B IESbC3u4g9xsbNM1KTmXkvcbOUHIf1BIYFV3idek/cJck7XA2O7uNXap+YUF5ij9LlU/ BiaWDQmOleF4Pv+mZGB8VAouQg/z4jcUYGxXT0yesQxI80k3DTd8W2SIGX9xKd/eQH+A FpKw== X-Gm-Message-State: AOAM531KFnBprEDEsQZs19qej02VR8TCC+n59R9ODhMDPVeb3W2Dc7Z4 Gnph4E10Z2jfPtu4+oMddCYjWRrTKUpApAGSNpO7bQOyBiWovtiNirbe9FyC+IwJuKycgQMWpya Zji+iOcOFRqTWQngJ60owx/8sBsBJG/c8bNoGkXO3TgaHBELifSvSBPEEXct+uKI8bDnmfw== X-Received: by 2002:a05:6000:1107:b0:1e3:31af:6efd with SMTP id z7-20020a056000110700b001e331af6efdmr3744510wrw.618.1645044818636; Wed, 16 Feb 2022 12:53:38 -0800 (PST) X-Google-Smtp-Source: ABdhPJzGTOmsWD6u7ed9jmJ9qOSG7N84kV3O/JBB/cS6z2g0/sWL0lBm7ALJnl30XOY6J4x+WSV/fg== X-Received: by 2002:a05:6000:1107:b0:1e3:31af:6efd with SMTP id z7-20020a056000110700b001e331af6efdmr3744473wrw.618.1645044817709; Wed, 16 Feb 2022 12:53:37 -0800 (PST) Received: from localhost (host86-134-151-224.range86-134.btcentralplus.com. [86.134.151.224]) by smtp.gmail.com with ESMTPSA id y16sm237951wrp.1.2022.02.16.12.53.36 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 16 Feb 2022 12:53:37 -0800 (PST) From: Andrew Burgess To: binutils@sourceware.org Cc: Andrew Burgess Subject: [PATCH 1/3] objdump/opcodes: add syntax highlighting to disassembler output Date: Wed, 16 Feb 2022 20:53:29 +0000 Message-Id: X-Mailer: git-send-email 2.25.4 In-Reply-To: References: MIME-Version: 1.0 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: 8bit Content-Type: text/plain; charset="US-ASCII" X-Spam-Status: No, score=-10.4 required=5.0 tests=BAYES_00, DKIM_INVALID, DKIM_SIGNED, GIT_PATCH_0, KAM_DMARC_NONE, KAM_DMARC_STATUS, KAM_SOMETLD_ARE_BAD_TLD, PDS_OTHER_BAD_TLD, RCVD_IN_BARRACUDACENTRAL, RCVD_IN_DNSWL_LOW, SPF_HELO_NONE, SPF_NONE, TXREP, T_SCC_BODY_TEXT_LINE autolearn=ham autolearn_force=no version=3.4.4 X-Spam-Checker-Version: SpamAssassin 3.4.4 (2020-01-24) on server2.sourceware.org X-BeenThere: binutils@sourceware.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Binutils mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 16 Feb 2022 20:53:51 -0000 This commit adds the _option_ of having disassembler output syntax highlighted in objdump. This option is _off_ by default. The new command line options are: --disassembler-color=off # The default. --disassembler-color=color --disassembler-color=extended-color I have implemented two colour modes, using the same option names as we use of --visualize-jumps, a basic 8-color mode ("color"), and an extended 8bit color mode ("extended-color"). The syntax highlighting requires that each targets disassembler be updated; each time the disassembler produces some output we now pass through an additional parameter indicating what style should be applied to the text. As updating all target disassemblers is a large task, the old API is maintained. And so, a user of the disassembler (i.e. objdump, gdb) must provide two functions, the current non-styled print function, and a new, styled print function. I don't currently have a plan for converting every single target disassembler, my hope is that interested folk will update the disassemblers they are interested in. But it is possible some might never get updated. In this initial series I intend to convert the RISC-V disassembler completely, and also do a partial conversion of the x86 disassembler. Hopefully having the x86 disassembler at least partial converted will allow more people to try this out easily and provide feedback. In this commit I have focused on objdump. The changes to GDB at this point are the bare minimum required to get things compiling, GDB makes no use of the styling information to provide any colors, that will come later, if this commit is accepted. This first commit in the series doesn't convert any target disassemblers at all (the next two commits will update some targets), so after this commit, the only color you will see in the disassembler output, is that produced from objdump itself, e.g. from objdump_print_addr_with_sym, where we print an address and a symbol name, these are now printed with styling information, and so will have colors applied (if the option is on). Finally, my ability to pick "good" colors is ... well, terrible. I'm in no way committed to the colors I've picked here, so I encourage people to suggest new colors, or wait for this commit to land, and then patch the choice of colors. I do have an idea about using possibly an environment variable to allow the objdump colors to be customised, but I haven't done anything like that in this commit, the color choices are just fixed in the code for now. binutils/ChangeLog: * NEWS: Mention new feature. * doc/binutils.texi (objdump): Describe --disassembler-color option. * objdump.c (disassembler_color): New global. (disassembler_extended_color): Likewise. (disassembler_in_comment): Likewise. (usage): Mention --disassembler-color option. (long_options): Add --disassembler-color option. (objdump_print_value): Use fprintf_styled_func instead of fprintf_func. (objdump_print_symname): Likewise. (objdump_print_addr_with_sym): Likewise. (objdump_color_for_disassembler_style): New function. (objdump_styled_sprintf): New function. (fprintf_styled): New function. (disassemble_jumps): Use disassemble_set_printf, and reset disassembler_in_comment. (null_styled_print): New function. (disassemble_bytes): Use disassemble_set_printf, and reset disassembler_in_comment. (disassemble_data): Update init_disassemble_info call. (main): Handle --disassembler-color option. include/ChangeLog: * dis-asm.h (enum disassembler_style): New enum. (struct disassemble_info): Add fprintf_styled_func field, and created_styled_output field. (disassemble_set_printf): Declare. (init_disassemble_info): Add additional parameter. (INIT_DISASSEMBLE_INFO): Add additional parameter. opcodes/ChangeLog: * dis-init.c (init_disassemble_info): Take extra parameter, initialize the new fprintf_styled_func and created_styled_output fields. * disassembler.c (disassemble_set_printf): New function definition. --- binutils/NEWS | 4 + binutils/doc/binutils.texi | 11 ++ binutils/objdump.c | 245 ++++++++++++++++++++++++++++++++----- gdb/disasm.c | 34 ++++- gdb/disasm.h | 7 ++ include/dis-asm.h | 62 +++++++++- opcodes/dis-init.c | 5 +- opcodes/disassemble.c | 13 ++ 8 files changed, 341 insertions(+), 40 deletions(-) diff --git a/binutils/NEWS b/binutils/NEWS index c188b469a77..3476deb096f 100644 --- a/binutils/NEWS +++ b/binutils/NEWS @@ -1,5 +1,9 @@ -*- text -*- +* objdump now supports syntax highlighting of disassembler output for some + architectures. Use the --disassembler-color=MODE command line flag, with + mode being either off, color, or extended-color. + Changes in 2.38: * elfedit: Add --output-abiversion option to update ABIVERSION. diff --git a/binutils/doc/binutils.texi b/binutils/doc/binutils.texi index 288974be386..9d3b558a0be 100644 --- a/binutils/doc/binutils.texi +++ b/binutils/doc/binutils.texi @@ -2268,6 +2268,7 @@ [@option{--prefix-strip=}@var{level}] [@option{--insn-width=}@var{width}] [@option{--visualize-jumps[=color|=extended-color|=off]} + [@option{--disassembler-color=[color|extended-color|off]} [@option{-U} @var{method}] [@option{--unicode=}@var{method}] [@option{-V}|@option{--version}] [@option{-H}|@option{--help}] @@ -2805,6 +2806,16 @@ after it has previously been enabled then use @option{visualize-jumps=off}. +@item --disassembler-color=[color|extended-color|off] +Apply syntax highlighting to the disassembler output. The +@option{color} argument adds color using simple terminal colors. +Alternatively the @option{extended-color} argument will use 8bit +colors, but these might not work on all terminals. + +If it is necessary to disable the @option{--disassembler-color} option +after it has previously been enabled then use +@option{--disassembler-color=off}. + @item -W[lLiaprmfFsoORtUuTgAckK] @itemx --dwarf[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=str-offsets,=loc,=Ranges,=pubtypes,=trace_info,=trace_abbrev,=trace_aranges,=gdb_index,=addr,=cu_index,=links,=follow-links] @include debug.options.texi diff --git a/binutils/objdump.c b/binutils/objdump.c index 24e91869bfd..97e3b1d6115 100644 --- a/binutils/objdump.c +++ b/binutils/objdump.c @@ -130,10 +130,19 @@ static bool visualize_jumps = false; /* --visualize-jumps. */ static bool color_output = false; /* --visualize-jumps=color. */ static bool extended_color_output = false; /* --visualize-jumps=extended-color. */ static int process_links = false; /* --process-links. */ +static bool disassembler_color = false; /* --disassembler-color=color. */ +static bool disassembler_extended_color = false; /* --disassembler-color=extended-color. */ static int dump_any_debugging; static int demangle_flags = DMGL_ANSI | DMGL_PARAMS; +/* This is reset to false each time we enter the disassembler, and set true + when the disassembler emits something in the dis_style_comment_start + style. Once this is true, all further output on that line is done in + the comment style. This only has an effect when disassembler coloring + is turned on. */ +static bool disassembler_in_comment = false; + /* A structure to record the sections mentioned in -j switches. */ struct only { @@ -388,6 +397,10 @@ usage (FILE *stream, int status) Use extended 8-bit color codes\n")); fprintf (stream, _("\ --visualize-jumps=off Disable jump visualization\n\n")); + fprintf (stream, _("\ + --disassembler-color=off Disable disassembler color output.\n\n")); + fprintf (stream, _("\ + --disassembler-color=color Use basic colors in disassembler output.\n\n")); list_supported_targets (program_name, stream); list_supported_architectures (program_name, stream); @@ -429,7 +442,8 @@ enum option_values OPTION_CTF, OPTION_CTF_PARENT, #endif - OPTION_VISUALIZE_JUMPS + OPTION_VISUALIZE_JUMPS, + OPTION_DISASSEMBLER_COLOR }; static struct option long_options[]= @@ -495,6 +509,7 @@ static struct option long_options[]= {"version", no_argument, NULL, 'V'}, {"visualize-jumps", optional_argument, 0, OPTION_VISUALIZE_JUMPS}, {"wide", no_argument, NULL, 'w'}, + {"disassembler-color", required_argument, NULL, OPTION_DISASSEMBLER_COLOR}, {NULL, no_argument, NULL, 0} }; @@ -1238,7 +1253,7 @@ objdump_print_value (bfd_vma vma, struct disassemble_info *inf, if (*p == '\0') --p; } - (*inf->fprintf_func) (inf->stream, "%s", p); + (*inf->fprintf_styled_func) (inf->stream, dis_style_address, "%s", p); } /* Print the name of a symbol. */ @@ -1272,10 +1287,11 @@ objdump_print_symname (bfd *abfd, struct disassemble_info *inf, if (inf != NULL) { - (*inf->fprintf_func) (inf->stream, "%s", name); + (*inf->fprintf_styled_func) (inf->stream, dis_style_symbol, "%s", name); if (version_string && *version_string != '\0') - (*inf->fprintf_func) (inf->stream, hidden ? "@%s" : "@@%s", - version_string); + (*inf->fprintf_styled_func) (inf->stream, dis_style_symbol, + hidden ? "@%s" : "@@%s", + version_string); } else { @@ -1537,31 +1553,33 @@ objdump_print_addr_with_sym (bfd *abfd, asection *sec, asymbol *sym, if (!no_addresses) { objdump_print_value (vma, inf, skip_zeroes); - (*inf->fprintf_func) (inf->stream, " "); + (*inf->fprintf_styled_func) (inf->stream, dis_style_text, " "); } if (sym == NULL) { bfd_vma secaddr; - (*inf->fprintf_func) (inf->stream, "<%s", - sanitize_string (bfd_section_name (sec))); + (*inf->fprintf_styled_func) (inf->stream, dis_style_text,"<"); + (*inf->fprintf_styled_func) (inf->stream, dis_style_symbol, "%s", + sanitize_string (bfd_section_name (sec))); secaddr = bfd_section_vma (sec); if (vma < secaddr) { - (*inf->fprintf_func) (inf->stream, "-0x"); + (*inf->fprintf_styled_func) (inf->stream, dis_style_immediate, + "-0x"); objdump_print_value (secaddr - vma, inf, true); } else if (vma > secaddr) { - (*inf->fprintf_func) (inf->stream, "+0x"); + (*inf->fprintf_styled_func) (inf->stream, dis_style_immediate, "+0x"); objdump_print_value (vma - secaddr, inf, true); } - (*inf->fprintf_func) (inf->stream, ">"); + (*inf->fprintf_styled_func) (inf->stream, dis_style_text, ">"); } else { - (*inf->fprintf_func) (inf->stream, "<"); + (*inf->fprintf_styled_func) (inf->stream, dis_style_text, "<"); objdump_print_symname (abfd, inf, sym); @@ -1578,21 +1596,22 @@ objdump_print_addr_with_sym (bfd *abfd, asection *sec, asymbol *sym, ; else if (bfd_asymbol_value (sym) > vma) { - (*inf->fprintf_func) (inf->stream, "-0x"); + (*inf->fprintf_styled_func) (inf->stream, dis_style_immediate,"-0x"); objdump_print_value (bfd_asymbol_value (sym) - vma, inf, true); } else if (vma > bfd_asymbol_value (sym)) { - (*inf->fprintf_func) (inf->stream, "+0x"); + (*inf->fprintf_styled_func) (inf->stream, dis_style_immediate, "+0x"); objdump_print_value (vma - bfd_asymbol_value (sym), inf, true); } - (*inf->fprintf_func) (inf->stream, ">"); + (*inf->fprintf_styled_func) (inf->stream, dis_style_text, ">"); } if (display_file_offsets) - inf->fprintf_func (inf->stream, _(" (File Offset: 0x%lx)"), - (long int)(sec->filepos + (vma - sec->vma))); + inf->fprintf_styled_func (inf->stream, dis_style_text, + _(" (File Offset: 0x%lx)"), + (long int)(sec->filepos + (vma - sec->vma))); } /* Print an address (VMA), symbolically if possible. @@ -2119,6 +2138,139 @@ objdump_sprintf (SFILE *f, const char *format, ...) return n; } +/* Return an integer greater than, or equal to zero, representing the color + for STYLE, or -1 if no color should be used. */ + +static int +objdump_color_for_disassembler_style (enum disassembler_style style) +{ + int color = -1; + + if (style == dis_style_comment_start) + disassembler_in_comment = true; + + if (disassembler_color) + { + if (disassembler_in_comment) + return color; + + switch (style) + { + case dis_style_symbol: color = 32; break; + case dis_style_mnemonic: color = 33; break; + case dis_style_register: color = 34; break; + case dis_style_address: + case dis_style_immediate: color = 35; break; + default: + case dis_style_text: color = -1; break; + } + } + else if (disassembler_extended_color) + { + if (disassembler_in_comment) + return 250; + + switch (style) + { + case dis_style_symbol: color = 40; break; + case dis_style_mnemonic: color = 142; break; + case dis_style_register: color = 27; break; + case dis_style_address: + case dis_style_immediate: color = 134; break; + default: + case dis_style_text: color = -1; break; + } + } + + return color; +} + +/* Like objdump_sprintf, but add in escape sequences to highlight the + content according to STYLE. */ + +static int ATTRIBUTE_PRINTF_3 +objdump_styled_sprintf (SFILE *f, enum disassembler_style style, + const char *format, ...) +{ + size_t n; + va_list args; + int color = objdump_color_for_disassembler_style (style); + + if (color >= 0) + { + while (1) + { + size_t space = f->alloc - f->pos; + + if (disassembler_color) + n = snprintf (f->buffer + f->pos, space, "\033[%dm", color); + else + n = snprintf (f->buffer + f->pos, space, "\033[38;5;%dm", color); + if (space > n) + break; + + f->alloc = (f->alloc + n) * 2; + f->buffer = (char *) xrealloc (f->buffer, f->alloc); + } + f->pos += n; + } + + while (1) + { + size_t space = f->alloc - f->pos; + + va_start (args, format); + n = vsnprintf (f->buffer + f->pos, space, format, args); + va_end (args); + + if (space > n) + break; + + f->alloc = (f->alloc + n) * 2; + f->buffer = (char *) xrealloc (f->buffer, f->alloc); + } + f->pos += n; + + if (color >= 0) + { + while (1) + { + size_t space = f->alloc - f->pos; + + n = snprintf (f->buffer + f->pos, space, "\033[0m"); + + if (space > n) + break; + + f->alloc = (f->alloc + n) * 2; + f->buffer = (char *) xrealloc (f->buffer, f->alloc); + } + f->pos += n; + } + + return n; +} + +/* We discard the styling information here. This function is only used + when objdump is printing auxiliary information, the symbol headers, and + disassembly address, or the bytes of the disassembled instruction. We + don't (currently) apply styling to any of this stuff, so, for now, just + print the content with no additional style added. */ + +static int ATTRIBUTE_PRINTF_3 +fprintf_styled (FILE *f, enum disassembler_style style ATTRIBUTE_UNUSED, + const char *fmt, ...) +{ + int res; + va_list ap; + + va_start (ap, fmt); + res = vfprintf (f, fmt, ap); + va_end (ap); + + return res; +} + /* Code for generating (colored) diagrams of control flow start and end points. */ @@ -2550,8 +2702,8 @@ disassemble_jumps (struct disassemble_info * inf, sfile.pos = 0; inf->insn_info_valid = 0; - inf->fprintf_func = (fprintf_ftype) objdump_sprintf; - inf->stream = &sfile; + disassemble_set_printf (inf, &sfile, (fprintf_ftype) objdump_sprintf, + (fprintf_styled_ftype) objdump_styled_sprintf); addr_offset = start_offset; while (addr_offset < stop_offset) @@ -2613,6 +2765,7 @@ disassemble_jumps (struct disassemble_info * inf, /* Extract jump information. */ inf->insn_info_valid = 0; + disassembler_in_comment = false; octets = (*disassemble_fn) (section->vma + addr_offset, inf); /* Test if a jump was detected. */ if (inf->insn_info_valid @@ -2633,9 +2786,8 @@ disassemble_jumps (struct disassemble_info * inf, addr_offset += octets / opb; } - inf->fprintf_func = (fprintf_ftype) fprintf; - inf->stream = stdout; - + disassemble_set_printf (inf, (void *) stdout, (fprintf_ftype) fprintf, + (fprintf_styled_ftype) fprintf_styled); free (sfile.buffer); /* Merge jumps. */ @@ -2728,6 +2880,17 @@ null_print (const void * stream ATTRIBUTE_UNUSED, const char * format ATTRIBUTE_ return 1; } +/* Like null_print, but takes the extra STYLE argument. As this is not + going to print anything, the extra argument is just ignored. */ + +static int +null_styled_print (const void * stream ATTRIBUTE_UNUSED, + enum disassembler_style style ATTRIBUTE_UNUSED, + const char * format ATTRIBUTE_UNUSED, ...) +{ + return 1; +} + /* Print out jump visualization. */ static void @@ -2938,8 +3101,9 @@ disassemble_bytes (struct disassemble_info *inf, int insn_size; sfile.pos = 0; - inf->fprintf_func = (fprintf_ftype) objdump_sprintf; - inf->stream = &sfile; + disassemble_set_printf + (inf, &sfile, (fprintf_ftype) objdump_sprintf, + (fprintf_styled_ftype) objdump_styled_sprintf); inf->bytes_per_line = 0; inf->bytes_per_chunk = 0; inf->flags = ((disassemble_all ? DISASSEMBLE_DATA : 0) @@ -2981,10 +3145,15 @@ disassemble_bytes (struct disassemble_info *inf, twice, but we only do this when there is a high probability that there is a reloc that will affect the instruction. */ - inf->fprintf_func = (fprintf_ftype) null_print; + disassemble_set_printf + (inf, inf->stream, (fprintf_ftype) null_print, + (fprintf_styled_ftype) null_styled_print); insn_size = disassemble_fn (section->vma + addr_offset, inf); - inf->fprintf_func = (fprintf_ftype) objdump_sprintf; + disassemble_set_printf + (inf, inf->stream, + (fprintf_ftype) objdump_sprintf, + (fprintf_styled_ftype) objdump_styled_sprintf); } } @@ -3009,12 +3178,13 @@ disassemble_bytes (struct disassemble_info *inf, inf->stop_vma = section->vma + stop_offset; inf->stop_offset = stop_offset; + disassembler_in_comment = false; insn_size = (*disassemble_fn) (section->vma + addr_offset, inf); octets = insn_size; inf->stop_vma = 0; - inf->fprintf_func = (fprintf_ftype) fprintf; - inf->stream = stdout; + disassemble_set_printf (inf, stdout, (fprintf_ftype) fprintf, + (fprintf_styled_ftype) fprintf_styled); if (insn_width == 0 && inf->bytes_per_line != 0) octets_per_line = inf->bytes_per_line; if (insn_size < (int) opb) @@ -3575,8 +3745,9 @@ disassemble_section (bfd *abfd, asection *section, void *inf) sf.alloc = strlen (sym->name) + 40; sf.buffer = (char*) xmalloc (sf.alloc); sf.pos = 0; - di.fprintf_func = (fprintf_ftype) objdump_sprintf; - di.stream = &sf; + disassemble_set_printf + (&di, &sf, (fprintf_ftype) objdump_sprintf, + (fprintf_styled_ftype) objdump_styled_sprintf); objdump_print_symname (abfd, &di, sym); @@ -3645,8 +3816,8 @@ disassemble_data (bfd *abfd) ++sorted_symcount; } - init_disassemble_info (&disasm_info, stdout, (fprintf_ftype) fprintf); - + init_disassemble_info (&disasm_info, stdout, (fprintf_ftype) fprintf, + (fprintf_styled_ftype) fprintf_styled); disasm_info.application_data = (void *) &aux; aux.abfd = abfd; aux.require_sec = false; @@ -5487,6 +5658,16 @@ main (int argc, char **argv) nonfatal (_("unrecognized argument to --visualize-option")); } break; + case OPTION_DISASSEMBLER_COLOR: + if (streq (optarg, "off")) + disassembler_color = false; + else if (streq (optarg, "color")) + disassembler_color = true; + else if (streq (optarg, "extended-color")) + disassembler_extended_color = true; + else + nonfatal (_("unrecognized argument to --disassembler-color")); + break; case 'E': if (strcmp (optarg, "B") == 0) endian = BFD_ENDIAN_BIG; diff --git a/gdb/disasm.c b/gdb/disasm.c index b4cde801cb0..a1ab4d71cdd 100644 --- a/gdb/disasm.c +++ b/gdb/disasm.c @@ -177,6 +177,22 @@ gdb_disassembler::dis_asm_fprintf (void *stream, const char *format, ...) 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); + vfprintf_filtered ((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) @@ -787,7 +803,8 @@ gdb_disassembler::gdb_disassembler (struct gdbarch *gdbarch, && file->can_emit_style_escape ()), m_dest (file) { - init_disassemble_info (&m_di, &m_buffer, dis_asm_fprintf); + 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; @@ -954,12 +971,25 @@ 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); + init_disassemble_info (dinfo, nullptr, gdb_disasm_null_printf, + gdb_disasm_null_styled_printf); } /* Initialize a struct disassemble_info for gdb_buffered_insn_length. diff --git a/gdb/disasm.h b/gdb/disasm.h index 399afc5ae71..b71cd097a16 100644 --- a/gdb/disasm.h +++ b/gdb/disasm.h @@ -110,6 +110,13 @@ class gdb_disassembler 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); diff --git a/include/dis-asm.h b/include/dis-asm.h index 317592448a2..c80cd378817 100644 --- a/include/dis-asm.h +++ b/include/dis-asm.h @@ -35,8 +35,6 @@ extern "C" { #include #include "bfd.h" - typedef int (*fprintf_ftype) (void *, const char*, ...) ATTRIBUTE_FPTR_PRINTF_2; - enum dis_insn_type { dis_noninsn, /* Not a valid instruction. */ @@ -49,6 +47,50 @@ enum dis_insn_type dis_dref2 /* Two data references in instruction. */ }; +/* When printing styled disassembler output, this describes what style + should be used. */ + +enum disassembler_style +{ + /* This is the default style, use this for any additional syntax + (e.g. commas between operands, brackets, etc), or just as a default if + no other style seems appropriate. */ + dis_style_text, + + /* Use this for all instruction mnemonics. */ + dis_style_mnemonic, + + /* Use this for any register names. */ + dis_style_register, + + /* Use this for any immediates that are _not_ addresses. This would + include immediates that are going to be added to addresses, + e.g. branch offsets, or load offsets. */ + dis_style_immediate, + + /* The style for the numerical representation of an absolute address. + Anything that is an address offset should use the immediate style. */ + dis_style_address, + + /* The style for a symbol's name. The numerical address of a symbol + should use the address style above, this style is reserved for the + name. */ + dis_style_symbol, + + /* The start of a comment that runs to the end of the line. Anything + printed after a comment start might be styled differently, + e.g. everything might be styled as a comment, regardless of the + actual style used. The disassembler itself should not try to adjust + the style emitted for comment content, e.g. an address emitted within + a comment should still be given dis_style_address, in this way it is + up to the user of the disassembler to decide how comments should be + styled. */ + dis_style_comment_start +}; + +typedef int (*fprintf_ftype) (void *, const char*, ...) ATTRIBUTE_FPTR_PRINTF_2; +typedef int (*fprintf_styled_ftype) (void *, enum disassembler_style, const char*, ...) ATTRIBUTE_FPTR_PRINTF_3; + /* This struct is passed into the instruction decoding routine, and is passed back out into each callback. The various fields are used for conveying information from your main routine into your callbacks, @@ -62,6 +104,7 @@ enum dis_insn_type typedef struct disassemble_info { fprintf_ftype fprintf_func; + fprintf_styled_ftype fprintf_styled_func; void *stream; void *application_data; @@ -228,6 +271,9 @@ typedef struct disassemble_info disassembling such as the way mapping symbols are found on AArch64. */ bfd_vma stop_offset; + /* Set to true if the disassembler applied styling to the output, + otherwise, set to false. */ + bool created_styled_output; } disassemble_info; /* This struct is used to pass information about valid disassembler @@ -337,6 +383,10 @@ extern void disassemble_init_for_target (struct disassemble_info *); /* Tidy any memory allocated by targets, such as info->private_data. */ extern void disassemble_free_target (struct disassemble_info *); +/* Set the basic disassembler print functions. */ +extern void disassemble_set_printf (struct disassemble_info *, void *, + fprintf_ftype, fprintf_styled_ftype); + /* Document any target specific options available from the disassembler. */ extern void disassembler_usage (FILE *); @@ -394,11 +444,13 @@ extern bool generic_symbol_is_valid /* Method to initialize a disassemble_info struct. This should be called by all applications creating such a struct. */ extern void init_disassemble_info (struct disassemble_info *dinfo, void *stream, - fprintf_ftype fprintf_func); + fprintf_ftype fprintf_func, + fprintf_styled_ftype fprintf_styled_func); /* For compatibility with existing code. */ -#define INIT_DISASSEMBLE_INFO(INFO, STREAM, FPRINTF_FUNC) \ - init_disassemble_info (&(INFO), (STREAM), (fprintf_ftype) (FPRINTF_FUNC)) +#define INIT_DISASSEMBLE_INFO(INFO, STREAM, FPRINTF_FUNC, FPRINTF_STYLED_FUNC) \ + init_disassemble_info (&(INFO), (STREAM), (fprintf_ftype) (FPRINTF_FUNC), \ + (fprintf_styled_ftype) (FPRINTF_STYLED_FUNC)) #ifdef __cplusplus } diff --git a/opcodes/dis-init.c b/opcodes/dis-init.c index 0b171c0f36d..59039ef8b11 100644 --- a/opcodes/dis-init.c +++ b/opcodes/dis-init.c @@ -25,7 +25,8 @@ void init_disassemble_info (struct disassemble_info *info, void *stream, - fprintf_ftype fprintf_func) + fprintf_ftype fprintf_func, + fprintf_styled_ftype fprintf_styled_func) { memset (info, 0, sizeof (*info)); @@ -35,6 +36,7 @@ init_disassemble_info (struct disassemble_info *info, void *stream, info->endian_code = info->endian; info->octets_per_byte = 1; info->fprintf_func = fprintf_func; + info->fprintf_styled_func = fprintf_styled_func; info->stream = stream; info->read_memory_func = buffer_read_memory; info->memory_error_func = perror_memory; @@ -42,5 +44,6 @@ init_disassemble_info (struct disassemble_info *info, void *stream, info->symbol_at_address_func = generic_symbol_at_address; info->symbol_is_valid = generic_symbol_is_valid; info->display_endian = BFD_ENDIAN_UNKNOWN; + info->created_styled_output = false; } diff --git a/opcodes/disassemble.c b/opcodes/disassemble.c index e613935eff8..15df49ea331 100644 --- a/opcodes/disassemble.c +++ b/opcodes/disassemble.c @@ -860,3 +860,16 @@ opcodes_assert (const char *file, int line) opcodes_error_handler (_("Please report this bug")); abort (); } + +/* Set the stream, and the styled and unstyled printf functions within + INFO. */ + +void +disassemble_set_printf (struct disassemble_info *info, void *stream, + fprintf_ftype unstyled_printf, + fprintf_styled_ftype styled_printf) +{ + info->stream = stream; + info->fprintf_func = unstyled_printf; + info->fprintf_styled_func = styled_printf; +} -- 2.25.4