Skip to contentSkip to conversation

Selectable disassembler

PATCH In review Arnaldo Carvalho de Melo 4 participants 17 messages Nov 11, 2024 – Jan 23, 2025 perf events

lore
Share & tools
lore

Arnaldo Carvalho de Melo

author maintainer
#0 lore raw

cover Selectable disassembler

From: Arnaldo Carvalho de Melo <[email protected]>

Hi,

While trying to see source code in the 'perf annotate' output I
noticed that for some reason this is done nowadays only with the 'objdump' method, and that there was no way to specify which of the included methods should be tried first, this patch series is an attempt at addressing that.

After it is processed I plan to add 'perf test' entries to
compare the output of the disassemblers, to help in detecting regressions or problems with the libraries those methods use.

It is available at:

https://git.kernel.org/pub/scm/linux/kernel/git/acme/linux.git perf-disasm-selectable

https://git.kernel.org/pub/scm/linux/kernel/git/acme/linux.git/log/?h=perf-disasm-selectable

- Arnaldo

Arnaldo Carvalho de Melo (3):
perf disasm: Introduce symbol__disassemble_objdump() perf disasm: Define stubs for the LLVM and capstone disassemblers perf disasm: Allow configuring what disassemblers to use

 tools/perf/Documentation/perf-config.txt |  13 ++
 tools/perf/util/annotate.c               |   6 +
 tools/perf/util/annotate.h               |   6 +
 tools/perf/util/disasm.c                 | 261 ++++++++++++++++-------
 4 files changed, 204 insertions(+), 82 deletions(-)
Signature · 1 line
2.47.0
author maintainer
#1 lore raw

PATCH 1/3 perf disasm: Introduce symbol__disassemble_objdump()

From: Arnaldo Carvalho de Melo <[email protected]>

With the first disassemble method in perf, the parsing of objdump output, just like we have for llvm and capstone.

This paves the way to allow the user to specify what disassemblers are preferred and to also to at some point allow building without the objdump method.

Cc Adrian Hunter <[email protected]>
Cc Athira Rajeev <[email protected]>
Cc Ian Rogers <[email protected]>
Cc Jiri Olsa <[email protected]>
Cc Kan Liang <[email protected]>
Cc Namhyung Kim <[email protected]>
Cc Steinar H. Gunderson <[email protected]>
---
 tools/perf/util/disasm.c | 168 ++++++++++++++++++++-------------------
 1 file changed, 88 insertions(+), 80 deletions(-)
tools/perf/util/disasm.c +88 -80
index a525b80b934fdb5f..36cf61602c17fe69 100644
@@ -2045,17 +2045,14 @@ static char *expand_tabs(char *line, char **storage, size_t *storage_len)
 	return new_line;
 }
 
-int symbol__disassemble(struct symbol *sym, struct annotate_args *args)
+static int symbol__disassemble_objdump(const char *filename, struct symbol *sym,
+				       struct annotate_args *args)
 {
 	struct annotation_options *opts = &annotate_opts;
 	struct map *map = args->ms.map;
 	struct dso *dso = map__dso(map);
 	char *command;
 	FILE *file;
-	char symfs_filename[PATH_MAX];
-	struct kcore_extract kce;
-	bool delete_extract = false;
-	bool decomp = false;
 	int lineno = 0;
 	char *fileloc = NULL;
 	int nline;
@@ -2070,77 +2067,7 @@ int symbol__disassemble(struct symbol *sym, struct annotate_args *args)
 		NULL,
 	};
 	struct child_process objdump_process;
-	int err = dso__disassemble_filename(dso, symfs_filename, sizeof(symfs_filename));
-
-	if (err)
-		return err;
-
-	pr_debug("%s: filename=%s, sym=%s, start=%#" PRIx64 ", end=%#" PRIx64 "\n", __func__,
-		 symfs_filename, sym->name, map__unmap_ip(map, sym->start),
-		 map__unmap_ip(map, sym->end));
-
-	pr_debug("annotating [%p] %30s : [%p] %30s\n",
-		 dso, dso__long_name(dso), sym, sym->name);
-
-	if (dso__binary_type(dso) == DSO_BINARY_TYPE__BPF_PROG_INFO) {
-		return symbol__disassemble_bpf(sym, args);
-	} else if (dso__binary_type(dso) == DSO_BINARY_TYPE__BPF_IMAGE) {
-		return symbol__disassemble_bpf_image(sym, args);
-	} else if (dso__binary_type(dso) == DSO_BINARY_TYPE__NOT_FOUND) {
-		return -1;
-	} else if (dso__is_kcore(dso)) {
-		kce.kcore_filename = symfs_filename;
-		kce.addr = map__rip_2objdump(map, sym->start);
-		kce.offs = sym->start;
-		kce.len = sym->end - sym->start;
-		if (!kcore_extract__create(&kce)) {
-			delete_extract = true;
-			strlcpy(symfs_filename, kce.extract_filename,
-				sizeof(symfs_filename));
-		}
-	} else if (dso__needs_decompress(dso)) {
-		char tmp[KMOD_DECOMP_LEN];
-
-		if (dso__decompress_kmodule_path(dso, symfs_filename,
-						 tmp, sizeof(tmp)) < 0)
-			return -1;
-
-		decomp = true;
-		strcpy(symfs_filename, tmp);
-	}
-
-	/*
-	 * For powerpc data type profiling, use the dso__data_read_offset
-	 * to read raw instruction directly and interpret the binary code
-	 * to understand instructions and register fields. For sort keys as
-	 * type and typeoff, disassemble to mnemonic notation is
-	 * not required in case of powerpc.
-	 */
-	if (arch__is(args->arch, "powerpc")) {
-		extern const char *sort_order;
-
-		if (sort_order && !strstr(sort_order, "sym")) {
-			err = symbol__disassemble_raw(symfs_filename, sym, args);
-			if (err == 0)
-				goto out_remove_tmp;
-#ifdef HAVE_LIBCAPSTONE_SUPPORT
-			err = symbol__disassemble_capstone_powerpc(symfs_filename, sym, args);
-			if (err == 0)
-				goto out_remove_tmp;
-#endif
-		}
-	}
-
-#ifdef HAVE_LIBLLVM_SUPPORT
-	err = symbol__disassemble_llvm(symfs_filename, sym, args);
-	if (err == 0)
-		goto out_remove_tmp;
-#endif
-#ifdef HAVE_LIBCAPSTONE_SUPPORT
-	err = symbol__disassemble_capstone(symfs_filename, sym, args);
-	if (err == 0)
-		goto out_remove_tmp;
-#endif
+	int err;
 
 	err = asprintf(&command,
 		 "%s %s%s --start-address=0x%016" PRIx64
@@ -2163,13 +2090,13 @@ int symbol__disassemble(struct symbol *sym, struct annotate_args *args)
 
 	if (err < 0) {
 		pr_err("Failure allocating memory for the command to run\n");
-		goto out_remove_tmp;
+		return err;
 	}
 
 	pr_debug("Executing: %s\n", command);
 
 	objdump_argv[2] = command;
-	objdump_argv[4] = symfs_filename;
+	objdump_argv[4] = filename;
 
 	/* Create a pipe to read from for stdout */
 	memset(&objdump_process, 0, sizeof(objdump_process));
@@ -2207,8 +2134,8 @@ int symbol__disassemble(struct symbol *sym, struct annotate_args *args)
 			break;
 
 		/* Skip lines containing "filename:" */
-		match = strstr(line, symfs_filename);
-		if (match && match[strlen(symfs_filename)] == ':')
+		match = strstr(line, filename);
+		if (match && match[strlen(filename)] == ':')
 			continue;
 
 		expanded_line = strim(line);
@@ -2253,6 +2180,87 @@ int symbol__disassemble(struct symbol *sym, struct annotate_args *args)
 
 out_free_command:
 	free(command);
+	return err;
+}
+
+int symbol__disassemble(struct symbol *sym, struct annotate_args *args)
+{
+	struct map *map = args->ms.map;
+	struct dso *dso = map__dso(map);
+	char symfs_filename[PATH_MAX];
+	bool delete_extract = false;
+	struct kcore_extract kce;
+	bool decomp = false;
+	int err = dso__disassemble_filename(dso, symfs_filename, sizeof(symfs_filename));
+
+	if (err)
+		return err;
+
+	pr_debug("%s: filename=%s, sym=%s, start=%#" PRIx64 ", end=%#" PRIx64 "\n", __func__,
+		 symfs_filename, sym->name, map__unmap_ip(map, sym->start),
+		 map__unmap_ip(map, sym->end));
+
+	pr_debug("annotating [%p] %30s : [%p] %30s\n", dso, dso__long_name(dso), sym, sym->name);
+
+	if (dso__binary_type(dso) == DSO_BINARY_TYPE__BPF_PROG_INFO) {
+		return symbol__disassemble_bpf(sym, args);
+	} else if (dso__binary_type(dso) == DSO_BINARY_TYPE__BPF_IMAGE) {
+		return symbol__disassemble_bpf_image(sym, args);
+	} else if (dso__binary_type(dso) == DSO_BINARY_TYPE__NOT_FOUND) {
+		return -1;
+	} else if (dso__is_kcore(dso)) {
+		kce.addr = map__rip_2objdump(map, sym->start);
+		kce.kcore_filename = symfs_filename;
+		kce.len = sym->end - sym->start;
+		kce.offs = sym->start;
+
+		if (!kcore_extract__create(&kce)) {
+			delete_extract = true;
+			strlcpy(symfs_filename, kce.extract_filename, sizeof(symfs_filename));
+		}
+	} else if (dso__needs_decompress(dso)) {
+		char tmp[KMOD_DECOMP_LEN];
+
+		if (dso__decompress_kmodule_path(dso, symfs_filename, tmp, sizeof(tmp)) < 0)
+			return -1;
+
+		decomp = true;
+		strcpy(symfs_filename, tmp);
+	}
+
+	/*
+	 * For powerpc data type profiling, use the dso__data_read_offset to
+	 * read raw instruction directly and interpret the binary code to
+	 * understand instructions and register fields. For sort keys as type
+	 * and typeoff, disassemble to mnemonic notation is not required in
+	 * case of powerpc.
+	 */
+	if (arch__is(args->arch, "powerpc")) {
+		extern const char *sort_order;
+
+		if (sort_order && !strstr(sort_order, "sym")) {
+			err = symbol__disassemble_raw(symfs_filename, sym, args);
+			if (err == 0)
+				goto out_remove_tmp;
+#ifdef HAVE_LIBCAPSTONE_SUPPORT
+			err = symbol__disassemble_capstone_powerpc(symfs_filename, sym, args);
+			if (err == 0)
+				goto out_remove_tmp;
+#endif
+		}
+	}
+
+#ifdef HAVE_LIBLLVM_SUPPORT
+	err = symbol__disassemble_llvm(symfs_filename, sym, args);
+	if (err == 0)
+		goto out_remove_tmp;
+#endif
+#ifdef HAVE_LIBCAPSTONE_SUPPORT
+	err = symbol__disassemble_capstone(symfs_filename, sym, args);
+	if (err == 0)
+		goto out_remove_tmp;
+#endif
+	err = symbol__disassemble_objdump(symfs_filename, sym, args);
 
 out_remove_tmp:
 	if (decomp)
Signature · 1 line
2.47.0
reviewer Acked-by on v1 1/3
#2 lore raw

Re: [PATCH 1/3] perf disasm: Introduce symbol__disassemble_objdump()

Quoted 10 lines · Arnaldo Carvalho de Melo

From: Arnaldo Carvalho de Melo <[email protected]>

With the first disassemble method in perf, the parsing of objdump output, just like we have for llvm and capstone.

This paves the way to allow the user to specify what disassemblers are preferred and to also to at some point allow building without the objdump method.

Quoted 8 lines
Cc Adrian Hunter <[email protected]>
Cc Athira Rajeev <[email protected]>
Cc Ian Rogers <[email protected]>
Cc Jiri Olsa <[email protected]>
Cc Kan Liang <[email protected]>
Cc Namhyung Kim <[email protected]>
Cc Steinar H. Gunderson <[email protected]>

Nit below relating to a pre-existing condition in the code.

Quoted 209 lines
---
 tools/perf/util/disasm.c | 168 ++++++++++++++++++++-------------------
 1 file changed, 88 insertions(+), 80 deletions(-)
tools/perf/util/disasm.c +78 -80
index a525b80b934fdb5f..36cf61602c17fe69 100644
@@ -2045,17 +2045,14 @@ static char *expand_tabs(char *line, char **storage, size_t *storage_len)
        return new_line;
 }
 
-int symbol__disassemble(struct symbol *sym, struct annotate_args *args)
+static int symbol__disassemble_objdump(const char *filename, struct symbol *sym,
+                                      struct annotate_args *args)
 {
        struct annotation_options *opts = &annotate_opts;
        struct map *map = args->ms.map;
        struct dso *dso = map__dso(map);
        char *command;
        FILE *file;
-       char symfs_filename[PATH_MAX];
-       struct kcore_extract kce;
-       bool delete_extract = false;
-       bool decomp = false;
        int lineno = 0;
        char *fileloc = NULL;
        int nline;
@@ -2070,77 +2067,7 @@ int symbol__disassemble(struct symbol *sym, struct annotate_args *args)
                NULL,
        };
        struct child_process objdump_process;
-       int err = dso__disassemble_filename(dso, symfs_filename, sizeof(symfs_filename));
-
-       if (err)
-               return err;
-
-       pr_debug("%s: filename=%s, sym=%s, start=%#" PRIx64 ", end=%#" PRIx64 "\n", __func__,
-                symfs_filename, sym->name, map__unmap_ip(map, sym->start),
-                map__unmap_ip(map, sym->end));
-
-       pr_debug("annotating [%p] %30s : [%p] %30s\n",
-                dso, dso__long_name(dso), sym, sym->name);
-
-       if (dso__binary_type(dso) == DSO_BINARY_TYPE__BPF_PROG_INFO) {
-               return symbol__disassemble_bpf(sym, args);
-       } else if (dso__binary_type(dso) == DSO_BINARY_TYPE__BPF_IMAGE) {
-               return symbol__disassemble_bpf_image(sym, args);
-       } else if (dso__binary_type(dso) == DSO_BINARY_TYPE__NOT_FOUND) {
-               return -1;
-       } else if (dso__is_kcore(dso)) {
-               kce.kcore_filename = symfs_filename;
-               kce.addr = map__rip_2objdump(map, sym->start);
-               kce.offs = sym->start;
-               kce.len = sym->end - sym->start;
-               if (!kcore_extract__create(&kce)) {
-                       delete_extract = true;
-                       strlcpy(symfs_filename, kce.extract_filename,
-                               sizeof(symfs_filename));
-               }
-       } else if (dso__needs_decompress(dso)) {
-               char tmp[KMOD_DECOMP_LEN];
-
-               if (dso__decompress_kmodule_path(dso, symfs_filename,
-                                                tmp, sizeof(tmp)) < 0)
-                       return -1;
-
-               decomp = true;
-               strcpy(symfs_filename, tmp);
-       }
-
-       /*
-        * For powerpc data type profiling, use the dso__data_read_offset
-        * to read raw instruction directly and interpret the binary code
-        * to understand instructions and register fields. For sort keys as
-        * type and typeoff, disassemble to mnemonic notation is
-        * not required in case of powerpc.
-        */
-       if (arch__is(args->arch, "powerpc")) {
-               extern const char *sort_order;
-
-               if (sort_order && !strstr(sort_order, "sym")) {
-                       err = symbol__disassemble_raw(symfs_filename, sym, args);
-                       if (err == 0)
-                               goto out_remove_tmp;
-#ifdef HAVE_LIBCAPSTONE_SUPPORT
-                       err = symbol__disassemble_capstone_powerpc(symfs_filename, sym, args);
-                       if (err == 0)
-                               goto out_remove_tmp;
-#endif
-               }
-       }
-
-#ifdef HAVE_LIBLLVM_SUPPORT
-       err = symbol__disassemble_llvm(symfs_filename, sym, args);
-       if (err == 0)
-               goto out_remove_tmp;
-#endif
-#ifdef HAVE_LIBCAPSTONE_SUPPORT
-       err = symbol__disassemble_capstone(symfs_filename, sym, args);
-       if (err == 0)
-               goto out_remove_tmp;
-#endif
+       int err;
 
        err = asprintf(&command,
                 "%s %s%s --start-address=0x%016" PRIx64
@@ -2163,13 +2090,13 @@ int symbol__disassemble(struct symbol *sym, struct annotate_args *args)
 
        if (err < 0) {
                pr_err("Failure allocating memory for the command to run\n");
-               goto out_remove_tmp;
+               return err;
        }
 
        pr_debug("Executing: %s\n", command);
 
        objdump_argv[2] = command;
-       objdump_argv[4] = symfs_filename;
+       objdump_argv[4] = filename;
 
        /* Create a pipe to read from for stdout */
        memset(&objdump_process, 0, sizeof(objdump_process));
@@ -2207,8 +2134,8 @@ int symbol__disassemble(struct symbol *sym, struct annotate_args *args)
                        break;
 
                /* Skip lines containing "filename:" */
-               match = strstr(line, symfs_filename);
-               if (match && match[strlen(symfs_filename)] == ':')
+               match = strstr(line, filename);
+               if (match && match[strlen(filename)] == ':')
                        continue;
 
                expanded_line = strim(line);
@@ -2253,6 +2180,87 @@ int symbol__disassemble(struct symbol *sym, struct annotate_args *args)
 
 out_free_command:
        free(command);
+       return err;
+}
+
+int symbol__disassemble(struct symbol *sym, struct annotate_args *args)
+{
+       struct map *map = args->ms.map;
+       struct dso *dso = map__dso(map);
+       char symfs_filename[PATH_MAX];
+       bool delete_extract = false;
+       struct kcore_extract kce;
+       bool decomp = false;
+       int err = dso__disassemble_filename(dso, symfs_filename, sizeof(symfs_filename));
+
+       if (err)
+               return err;
+
+       pr_debug("%s: filename=%s, sym=%s, start=%#" PRIx64 ", end=%#" PRIx64 "\n", __func__,
+                symfs_filename, sym->name, map__unmap_ip(map, sym->start),
+                map__unmap_ip(map, sym->end));
+
+       pr_debug("annotating [%p] %30s : [%p] %30s\n", dso, dso__long_name(dso), sym, sym->name);
+
+       if (dso__binary_type(dso) == DSO_BINARY_TYPE__BPF_PROG_INFO) {
+               return symbol__disassemble_bpf(sym, args);
+       } else if (dso__binary_type(dso) == DSO_BINARY_TYPE__BPF_IMAGE) {
+               return symbol__disassemble_bpf_image(sym, args);
+       } else if (dso__binary_type(dso) == DSO_BINARY_TYPE__NOT_FOUND) {
+               return -1;
+       } else if (dso__is_kcore(dso)) {
+               kce.addr = map__rip_2objdump(map, sym->start);
+               kce.kcore_filename = symfs_filename;
+               kce.len = sym->end - sym->start;
+               kce.offs = sym->start;
+
+               if (!kcore_extract__create(&kce)) {
+                       delete_extract = true;
+                       strlcpy(symfs_filename, kce.extract_filename, sizeof(symfs_filename));
+               }
+       } else if (dso__needs_decompress(dso)) {
+               char tmp[KMOD_DECOMP_LEN];
+
+               if (dso__decompress_kmodule_path(dso, symfs_filename, tmp, sizeof(tmp)) < 0)
+                       return -1;
+
+               decomp = true;
+               strcpy(symfs_filename, tmp);
+       }
+
+       /*
+        * For powerpc data type profiling, use the dso__data_read_offset to
+        * read raw instruction directly and interpret the binary code to
+        * understand instructions and register fields. For sort keys as type
+        * and typeoff, disassemble to mnemonic notation is not required in
+        * case of powerpc.
+        */
+       if (arch__is(args->arch, "powerpc")) {
+               extern const char *sort_order;
+
+               if (sort_order && !strstr(sort_order, "sym")) {
+                       err = symbol__disassemble_raw(symfs_filename, sym, args);
+                       if (err == 0)
+                               goto out_remove_tmp;
+#ifdef HAVE_LIBCAPSTONE_SUPPORT
+                       err = symbol__disassemble_capstone_powerpc(symfs_filename, sym, args);
+                       if (err == 0)
+                               goto out_remove_tmp;
+#endif
+               }
+       }
+
+#ifdef HAVE_LIBLLVM_SUPPORT

tools/perf/util/disasm.c int symbol__disassemble(struct symbol *sym, struct annotate_args *args) · line 2263

Quoted 10 lines
tools/perf/util/disasm.c +10 -0
+       err = symbol__disassemble_llvm(symfs_filename, sym, args);
+       if (err == 0)
+               goto out_remove_tmp;
+#endif
+#ifdef HAVE_LIBCAPSTONE_SUPPORT
+       err = symbol__disassemble_capstone(symfs_filename, sym, args);
+       if (err == 0)
+               goto out_remove_tmp;
+#endif
+       err = symbol__disassemble_objdump(symfs_filename, sym, args);

This sure does read like the symbol will be disassembled 3 times if those ifdefs are defined. Is there anyway to make the code look more intuitive?

Thanks,
Ian

Quoted 6 lines
tools/perf/util/disasm.c +0 -1
 out_remove_tmp:
        if (decomp)
--

2.47.0

author maintainer
#3 lore raw

Re: [PATCH 1/3] perf disasm: Introduce symbol__disassemble_objdump()

Quoted 24 lines · Ian Rogers
Quoted 10 lines · Arnaldo Carvalho de Melo

From: Arnaldo Carvalho de Melo <[email protected]>

With the first disassemble method in perf, the parsing of objdump output, just like we have for llvm and capstone.

This paves the way to allow the user to specify what disassemblers are preferred and to also to at some point allow building without the objdump method.

Quoted 8 lines
Cc Adrian Hunter <[email protected]>
Cc Athira Rajeev <[email protected]>
Cc Ian Rogers <[email protected]>
Cc Jiri Olsa <[email protected]>
Cc Kan Liang <[email protected]>
Cc Namhyung Kim <[email protected]>
Cc Steinar H. Gunderson <[email protected]>

Nit below relating to a pre-existing condition in the code.

<SNIP>

Quoted 7 lines
Quoted 7 lines
tools/perf/util/disasm.c +7 -0
+#ifdef HAVE_LIBLLVM_SUPPORT
+       err = symbol__disassemble_llvm(symfs_filename, sym, args);
+       if (err == 0)
+               goto out_remove_tmp;
+#endif
+#ifdef HAVE_LIBCAPSTONE_SUPPORT
+       err = symbol__disassemble_capstone(symfs_filename, sym, args);
Quoted 8 lines

tools/perf/util/disasm.c int symbol__disassemble(struct symbol *sym, struct annotate_args *args) · line 2263

Quoted 4 lines
tools/perf/util/disasm.c +4 -0
+       if (err == 0)
+               goto out_remove_tmp;
+#endif
+       err = symbol__disassemble_objdump(symfs_filename, sym, args);

This sure does read like the symbol will be disassembled 3 times if those ifdefs are defined. Is there anyway to make the code look more intuitive?

This will end up being rewritten, the end result is a loop where the list of disassemblers to try is iterated and as soon as one succeeeds (returns zero), the loop is exited.

- Arnaldo

author maintainer
#4 lore raw

PATCH 2/3 perf disasm: Define stubs for the LLVM and capstone disassemblers

In reply to Arnaldo Carvalho de Melo

From: Arnaldo Carvalho de Melo <[email protected]>

This reduces the number of ifdefs in the main symbol__disassemble() method and paves the way for allowing the user to configure the disassemblers of preference.

Cc Adrian Hunter <[email protected]>
Cc Athira Rajeev <[email protected]>
Cc Ian Rogers <[email protected]>
Cc Jiri Olsa <[email protected]>
Cc Kan Liang <[email protected]>
Cc Namhyung Kim <[email protected]>
Cc Steinar H. Gunderson <[email protected]>
---
 tools/perf/util/disasm.c | 40 ++++++++++++++++++++++++++++++++--------
 1 file changed, 32 insertions(+), 8 deletions(-)
tools/perf/util/disasm.c +32 -8
index 36cf61602c17fe69..83df1da20a7b16cd 100644
@@ -1422,6 +1422,13 @@ read_symbol(const char *filename, struct map *map, struct symbol *sym,
 	free(buf);
 	return NULL;
 }
+#else // defined(HAVE_LIBCAPSTONE_SUPPORT) || defined(HAVE_LIBLLVM_SUPPORT)
+static void symbol__disassembler_missing(const char *disassembler, const char *filename,
+					 struct symbol *sym)
+{
+	pr_debug("The %s disassembler isn't linked in for %s in %s\n",
+		 disassembler, sym->name, filename);
+}
 #endif
 
 #ifdef HAVE_LIBCAPSTONE_SUPPORT
@@ -1715,7 +1722,20 @@ static int symbol__disassemble_capstone(char *filename, struct symbol *sym,
 	count = -1;
 	goto out;
 }
-#endif
+#else // HAVE_LIBCAPSTONE_SUPPORT
+static int symbol__disassemble_capstone(char *filename, struct symbol *sym,
+					struct annotate_args *args)
+	symbol__disassembler_missing("capstone", filename, sym);
+	return -1;
+}
+
+static int symbol__disassemble_capstone_powerpc(char *filename, struct symbol *sym,
+						struct annotate_args *args __maybe_unused)
+{
+	symbol__disassembler_missing("capstone powerpc", filename, sym);
+	return -1;
+}
+#endif // HAVE_LIBCAPSTONE_SUPPORT
 
 static int symbol__disassemble_raw(char *filename, struct symbol *sym,
 					struct annotate_args *args)
@@ -1983,7 +2003,14 @@ static int symbol__disassemble_llvm(char *filename, struct symbol *sym,
 	free(line_storage);
 	return ret;
 }
-#endif
+#else // HAVE_LIBLLVM_SUPPORT
+static int symbol__disassemble_llvm(char *filename, struct symbol *sym,
+				    struct annotate_args *args __maybe_unused)
+{
+	symbol__disassembler_missing("LLVM", filename, sym);
+	return -1;
+}
+#endif // HAVE_LIBLLVM_SUPPORT
 
 /*
  * Possibly create a new version of line with tabs expanded. Returns the
@@ -2242,24 +2269,21 @@ int symbol__disassemble(struct symbol *sym, struct annotate_args *args)
 			err = symbol__disassemble_raw(symfs_filename, sym, args);
 			if (err == 0)
 				goto out_remove_tmp;
-#ifdef HAVE_LIBCAPSTONE_SUPPORT
+
 			err = symbol__disassemble_capstone_powerpc(symfs_filename, sym, args);
 			if (err == 0)
 				goto out_remove_tmp;
-#endif
 		}
 	}
 
-#ifdef HAVE_LIBLLVM_SUPPORT
 	err = symbol__disassemble_llvm(symfs_filename, sym, args);
 	if (err == 0)
 		goto out_remove_tmp;
-#endif
-#ifdef HAVE_LIBCAPSTONE_SUPPORT
+
 	err = symbol__disassemble_capstone(symfs_filename, sym, args);
 	if (err == 0)
 		goto out_remove_tmp;
-#endif
+
 	err = symbol__disassemble_objdump(symfs_filename, sym, args);
 
 out_remove_tmp:
Signature · 1 line
2.47.0
reviewer Acked-by on v1 2/3
#5 lore raw

Re: [PATCH 2/3] perf disasm: Define stubs for the LLVM and capstone disassemblers

Quoted 7 lines · Arnaldo Carvalho de Melo

From: Arnaldo Carvalho de Melo <[email protected]>

This reduces the number of ifdefs in the main symbol__disassemble() method and paves the way for allowing the user to configure the disassemblers of preference.

Quoted 8 lines
Cc Adrian Hunter <[email protected]>
Cc Athira Rajeev <[email protected]>
Cc Ian Rogers <[email protected]>
Cc Jiri Olsa <[email protected]>
Cc Kan Liang <[email protected]>
Cc Namhyung Kim <[email protected]>
Cc Steinar H. Gunderson <[email protected]>

Style nit below.

Quoted 9 lines
---
 tools/perf/util/disasm.c | 40 ++++++++++++++++++++++++++++++++--------
 1 file changed, 32 insertions(+), 8 deletions(-)
tools/perf/util/disasm.c +0 -0
index 36cf61602c17fe69..83df1da20a7b16cd 100644

tools/perf/util/disasm.c read_symbol(const char *filename, struct map *map, struct symbol *sym, · line 1431

Quoted 10 lines
tools/perf/util/disasm.c +7 -0
@@ -1422,6 +1422,13 @@ read_symbol(const char *filename, struct map *map, struct symbol *sym,
        free(buf);
        return NULL;
 }
+#else // defined(HAVE_LIBCAPSTONE_SUPPORT) || defined(HAVE_LIBLLVM_SUPPORT)
+static void symbol__disassembler_missing(const char *disassembler, const char *filename,
+                                        struct symbol *sym)
+{
+       pr_debug("The %s disassembler isn't linked in for %s in %s\n",
+                disassembler, sym->name, filename);
+}

I can see why you're doing this but it seems overkill to have a function just for the sake of 1 pr_debug. The #ifdefs make this look like it could be doing more. Perhaps the style:

```
static int symbol__disassemble_capstone(char *filename, struct symbol
*sym, struct annotate_args *args)
{
#ifndef HAVE_LIBCAPSTONE_SUPPORT
    pr_debug("The capstone disassembler isn't linked in for %s in
%s\n", sym->name, filename);
    return -1;
#else
    ...
#endif
}
```

Would be preferable as the #ifdef's scope is more limited, you don't need to hunt around for 1 of 3 functions, etc.

Thanks,
Ian

Quoted 72 lines
tools/perf/util/disasm.c +25 -9
 #endif
 
 #ifdef HAVE_LIBCAPSTONE_SUPPORT
@@ -1715,7 +1722,20 @@ static int symbol__disassemble_capstone(char *filename, struct symbol *sym,
        count = -1;
        goto out;
 }
-#endif
+#else // HAVE_LIBCAPSTONE_SUPPORT
+static int symbol__disassemble_capstone(char *filename, struct symbol *sym,
+                                       struct annotate_args *args)
+       symbol__disassembler_missing("capstone", filename, sym);
+       return -1;
+}
+
+static int symbol__disassemble_capstone_powerpc(char *filename, struct symbol *sym,
+                                               struct annotate_args *args __maybe_unused)
+{
+       symbol__disassembler_missing("capstone powerpc", filename, sym);
+       return -1;
+}
+#endif // HAVE_LIBCAPSTONE_SUPPORT
 
 static int symbol__disassemble_raw(char *filename, struct symbol *sym,
                                        struct annotate_args *args)
@@ -1983,7 +2003,14 @@ static int symbol__disassemble_llvm(char *filename, struct symbol *sym,
        free(line_storage);
        return ret;
 }
-#endif
+#else // HAVE_LIBLLVM_SUPPORT
+static int symbol__disassemble_llvm(char *filename, struct symbol *sym,
+                                   struct annotate_args *args __maybe_unused)
+{
+       symbol__disassembler_missing("LLVM", filename, sym);
+       return -1;
+}
+#endif // HAVE_LIBLLVM_SUPPORT
 
 /*
  * Possibly create a new version of line with tabs expanded. Returns the
@@ -2242,24 +2269,21 @@ int symbol__disassemble(struct symbol *sym, struct annotate_args *args)
                        err = symbol__disassemble_raw(symfs_filename, sym, args);
                        if (err == 0)
                                goto out_remove_tmp;
-#ifdef HAVE_LIBCAPSTONE_SUPPORT
+
                        err = symbol__disassemble_capstone_powerpc(symfs_filename, sym, args);
                        if (err == 0)
                                goto out_remove_tmp;
-#endif
                }
        }
 
-#ifdef HAVE_LIBLLVM_SUPPORT
        err = symbol__disassemble_llvm(symfs_filename, sym, args);
        if (err == 0)
                goto out_remove_tmp;
-#endif
-#ifdef HAVE_LIBCAPSTONE_SUPPORT
+
        err = symbol__disassemble_capstone(symfs_filename, sym, args);
        if (err == 0)
                goto out_remove_tmp;
-#endif
+
        err = symbol__disassemble_objdump(symfs_filename, sym, args);
 
 out_remove_tmp:
--

2.47.0

author maintainer
#6 lore raw

Re: [PATCH 2/3] perf disasm: Define stubs for the LLVM and capstone disassemblers

Quoted 18 lines · Ian Rogers
Quoted 7 lines · Arnaldo Carvalho de Melo

From: Arnaldo Carvalho de Melo <[email protected]>

This reduces the number of ifdefs in the main symbol__disassemble() method and paves the way for allowing the user to configure the disassemblers of preference.

Quoted 8 lines
Cc Adrian Hunter <[email protected]>
Cc Athira Rajeev <[email protected]>
Cc Ian Rogers <[email protected]>
Cc Jiri Olsa <[email protected]>
Cc Kan Liang <[email protected]>
Cc Namhyung Kim <[email protected]>
Cc Steinar H. Gunderson <[email protected]>
Quoted 1 line

Thanks

Quoted 17 lines

Style nit below.

Quoted 15 lines
---
 tools/perf/util/disasm.c | 40 ++++++++++++++++++++++++++++++++--------
 1 file changed, 32 insertions(+), 8 deletions(-)
tools/perf/util/disasm.c +3 -0
index 36cf61602c17fe69..83df1da20a7b16cd 100644
@@ -1422,6 +1422,13 @@ read_symbol(const char *filename, struct map *map, struct symbol *sym,
        free(buf);
        return NULL;
 }
+#else // defined(HAVE_LIBCAPSTONE_SUPPORT) || defined(HAVE_LIBLLVM_SUPPORT)
+static void symbol__disassembler_missing(const char *disassembler, const char *filename,
+                                        struct symbol *sym)
Quoted 8 lines

tools/perf/util/disasm.c read_symbol(const char *filename, struct map *map, struct symbol *sym, · line 1431

Quoted 4 lines
tools/perf/util/disasm.c +4 -0
+{
+       pr_debug("The %s disassembler isn't linked in for %s in %s\n",
+                disassembler, sym->name, filename);
+}

I can see why you're doing this but it seems overkill to have a function just for the sake of 1 pr_debug. The #ifdefs make this look like it could be doing more. Perhaps the style:

Well, I wrote it like that, then had to cut'n't paste that thing to use it, ended up with two callers, three when we make objdump a build time selection, unsure if we will end up with more disassemblers.

- Arnaldo

Quoted 91 lines
```
static int symbol__disassemble_capstone(char *filename, struct symbol
*sym, struct annotate_args *args)
{
#ifndef HAVE_LIBCAPSTONE_SUPPORT
    pr_debug("The capstone disassembler isn't linked in for %s in
%s\n", sym->name, filename);
    return -1;
#else
    ...
#endif
}
```

Would be preferable as the #ifdef's scope is more limited, you don't need to hunt around for 1 of 3 functions, etc.

Thanks,
Ian

Quoted 72 lines
tools/perf/util/disasm.c +25 -9
 #endif
 
 #ifdef HAVE_LIBCAPSTONE_SUPPORT
@@ -1715,7 +1722,20 @@ static int symbol__disassemble_capstone(char *filename, struct symbol *sym,
        count = -1;
        goto out;
 }
-#endif
+#else // HAVE_LIBCAPSTONE_SUPPORT
+static int symbol__disassemble_capstone(char *filename, struct symbol *sym,
+                                       struct annotate_args *args)
+       symbol__disassembler_missing("capstone", filename, sym);
+       return -1;
+}
+
+static int symbol__disassemble_capstone_powerpc(char *filename, struct symbol *sym,
+                                               struct annotate_args *args __maybe_unused)
+{
+       symbol__disassembler_missing("capstone powerpc", filename, sym);
+       return -1;
+}
+#endif // HAVE_LIBCAPSTONE_SUPPORT
 
 static int symbol__disassemble_raw(char *filename, struct symbol *sym,
                                        struct annotate_args *args)
@@ -1983,7 +2003,14 @@ static int symbol__disassemble_llvm(char *filename, struct symbol *sym,
        free(line_storage);
        return ret;
 }
-#endif
+#else // HAVE_LIBLLVM_SUPPORT
+static int symbol__disassemble_llvm(char *filename, struct symbol *sym,
+                                   struct annotate_args *args __maybe_unused)
+{
+       symbol__disassembler_missing("LLVM", filename, sym);
+       return -1;
+}
+#endif // HAVE_LIBLLVM_SUPPORT
 
 /*
  * Possibly create a new version of line with tabs expanded. Returns the
@@ -2242,24 +2269,21 @@ int symbol__disassemble(struct symbol *sym, struct annotate_args *args)
                        err = symbol__disassemble_raw(symfs_filename, sym, args);
                        if (err == 0)
                                goto out_remove_tmp;
-#ifdef HAVE_LIBCAPSTONE_SUPPORT
+
                        err = symbol__disassemble_capstone_powerpc(symfs_filename, sym, args);
                        if (err == 0)
                                goto out_remove_tmp;
-#endif
                }
        }
 
-#ifdef HAVE_LIBLLVM_SUPPORT
        err = symbol__disassemble_llvm(symfs_filename, sym, args);
        if (err == 0)
                goto out_remove_tmp;
-#endif
-#ifdef HAVE_LIBCAPSTONE_SUPPORT
+
        err = symbol__disassemble_capstone(symfs_filename, sym, args);
        if (err == 0)
                goto out_remove_tmp;
-#endif
+
        err = symbol__disassemble_objdump(symfs_filename, sym, args);
 
 out_remove_tmp:
--

2.47.0

#7 lore raw

Re: [PATCH 2/3] perf disasm: Define stubs for the LLVM and capstone disassemblers

In reply to Arnaldo Carvalho de Melo
Quoted 41 lines · Arnaldo Carvalho de Melo

From: Arnaldo Carvalho de Melo <[email protected]>

This reduces the number of ifdefs in the main symbol__disassemble() method and paves the way for allowing the user to configure the disassemblers of preference.

Cc Adrian Hunter <[email protected]>
Cc Athira Rajeev <[email protected]>
Cc Ian Rogers <[email protected]>
Cc Jiri Olsa <[email protected]>
Cc Kan Liang <[email protected]>
Cc Namhyung Kim <[email protected]>
Cc Steinar H. Gunderson <[email protected]>

---
tools/perf/util/disasm.c | 40 ++++++++++++++++++++++++++++++++--------

1 file changed, 32 insertions(+), 8 deletions(-)
tools/perf/util/disasm.c +7 -0
index 36cf61602c17fe69..83df1da20a7b16cd 100644
@@ -1422,6 +1422,13 @@ read_symbol(const char *filename, struct map *map, struct symbol *sym,
 	free(buf);
 	return NULL;
 }
+#else // defined(HAVE_LIBCAPSTONE_SUPPORT) || defined(HAVE_LIBLLVM_SUPPORT)
+static void symbol__disassembler_missing(const char *disassembler, const char *filename,
+					 struct symbol *sym)
+{
+	pr_debug("The %s disassembler isn't linked in for %s in %s\n",
+		 disassembler, sym->name, filename);
+}
 #endif
 
 #ifdef HAVE_LIBCAPSTONE_SUPPORT

tools/perf/util/disasm.c static int symbol__disassemble_capstone(char *filename, struct symbol *sym, · line 1730

Quoted 10 lines
tools/perf/util/disasm.c +6 -1
@@ -1715,7 +1722,20 @@ static int symbol__disassemble_capstone(char *filename, struct symbol *sym,
 	count = -1;
 	goto out;
 }
-#endif
+#else // HAVE_LIBCAPSTONE_SUPPORT
+static int symbol__disassemble_capstone(char *filename, struct symbol *sym,
+					struct annotate_args *args)
+	symbol__disassembler_missing("capstone", filename, sym);
+	return -1;
+}

Hi Arnaldo
I was testing this change in powerpc setup I see below compilation error

CC util/disasm.o
util/disasm.c: In function ‘symbol__disassemble_capstone’:
util/disasm.c:1728:9: error: expected declaration specifiers before ‘symbol__disassembler_missing’
1728 | symbol__disassembler_missing("capstone", filename, sym);
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~
util/disasm.c:1729:9: error: expected declaration specifiers before ‘return’
1729 | return -1;
| ^~~~~~
util/disasm.c:1730:1: error: expected declaration specifiers before ‘}’ token
1730 | }

Below patch fixes the issue

tools/perf/util/disasm.c +2 -1
index df6c172c9c7f..da22b6ab9ecf 100644
@@ -1724,7 +1724,8 @@ static int symbol__disassemble_capstone(char *filename, struct symbol *sym,
 }
 #else // HAVE_LIBCAPSTONE_SUPPORT
 static int symbol__disassemble_capstone(char *filename, struct symbol *sym,
-                    struct annotate_args *args)
+                    struct annotate_args *args __maybe_unused)
+{
    symbol__disassembler_missing("capstone", filename, sym);
    return -1;
 }

I tried with tmp.perf-tools-next , I have tested the above patch fixes the compilation error

Thanks
Aditya Bodkhe

Quoted 59 lines
tools/perf/util/disasm.c +19 -7
+
+static int symbol__disassemble_capstone_powerpc(char *filename, struct symbol *sym,
+						struct annotate_args *args __maybe_unused)
+{
+	symbol__disassembler_missing("capstone powerpc", filename, sym);
+	return -1;
+}
+#endif // HAVE_LIBCAPSTONE_SUPPORT
 
 static int symbol__disassemble_raw(char *filename, struct symbol *sym,
 					struct annotate_args *args)
@@ -1983,7 +2003,14 @@ static int symbol__disassemble_llvm(char *filename, struct symbol *sym,
 	free(line_storage);
 	return ret;
 }
-#endif
+#else // HAVE_LIBLLVM_SUPPORT
+static int symbol__disassemble_llvm(char *filename, struct symbol *sym,
+				    struct annotate_args *args __maybe_unused)
+{
+	symbol__disassembler_missing("LLVM", filename, sym);
+	return -1;
+}
+#endif // HAVE_LIBLLVM_SUPPORT
 
 /*
 * Possibly create a new version of line with tabs expanded. Returns the
@@ -2242,24 +2269,21 @@ int symbol__disassemble(struct symbol *sym, struct annotate_args *args)
 			err = symbol__disassemble_raw(symfs_filename, sym, args);
 			if (err == 0)
 				goto out_remove_tmp;
-#ifdef HAVE_LIBCAPSTONE_SUPPORT
+
 			err = symbol__disassemble_capstone_powerpc(symfs_filename, sym, args);
 			if (err == 0)
 				goto out_remove_tmp;
-#endif
 		}
 	}
 
-#ifdef HAVE_LIBLLVM_SUPPORT
 	err = symbol__disassemble_llvm(symfs_filename, sym, args);
 	if (err == 0)
 		goto out_remove_tmp;
-#endif
-#ifdef HAVE_LIBCAPSTONE_SUPPORT
+
 	err = symbol__disassemble_capstone(symfs_filename, sym, args);
 	if (err == 0)
 		goto out_remove_tmp;
-#endif
+
 	err = symbol__disassemble_objdump(symfs_filename, sym, args);
 

out_remove_tmp:

Signature · 1 line
2.47.0
author maintainer Acked-by Ian Rogers
#8 lore raw

Re: [PATCH 2/3] perf disasm: Define stubs for the LLVM and capstone disassemblers

Quoted 11 lines · Aditya Bodkhe

Hi Arnaldo
I was testing this change in powerpc setup I see below compilation error

CC util/disasm.o
util/disasm.c: In function ‘symbol__disassemble_capstone’:
util/disasm.c:1728:9: error: expected declaration specifiers before ‘symbol__disassembler_missing’

 1728 |     symbol__disassembler_missing("capstone", filename, sym);
   |     ^~~~~~~~~~~~~~~~~~~~~~~~~~~~
util/disasm.c:1729:9: error: expected declaration specifiers before ‘return’
 1729 |     return -1;
   |     ^~~~~~
Quoted 4 lines

util/disasm.c:1730:1: error: expected declaration specifiers before ‘}’ token
1730 | }

Below patch fixes the issue

Thanks, I've folded your fix into the patch since it is still in the tmp.perf-tools-next branch, added a note to the patch to give you and Masami credit, both sent fixes that I had to slightly adjust:

----
perf disasm: Define stubs for the LLVM and capstone disassemblers

This reduces the number of ifdefs in the main symbol__disassemble() method and paves the way for allowing the user to configure the disassemblers of preference.

Cc Adrian Hunter <[email protected]>
Cc Aditya Bodkhe <[email protected]>
Cc Athira Rajeev <[email protected]>
Cc Jiri Olsa <[email protected]>
Cc Kan Liang <[email protected]>
Cc Masami Hiramatsu (Google) <[email protected]>
Cc Namhyung Kim <[email protected]>
Cc Steinar H. Gunderson <[email protected]>
[ Applied fixes from Masami Hiramatsu and Aditya Bodkhe for when capstone devel files are not available ]

----

Quoted 79 lines
tools/perf/util/disasm.c +2 -1
index df6c172c9c7f..da22b6ab9ecf 100644
@@ -1724,7 +1724,8 @@ static int symbol__disassemble_capstone(char *filename, struct symbol *sym,
 }
 #else // HAVE_LIBCAPSTONE_SUPPORT
 static int symbol__disassemble_capstone(char *filename, struct symbol *sym,
-                    struct annotate_args *args)
+                    struct annotate_args *args __maybe_unused)
+{
    symbol__disassembler_missing("capstone", filename, sym);
    return -1;
 }

I tried with tmp.perf-tools-next , I have tested the above patch fixes the compilation error

Thanks
Aditya Bodkhe

Quoted 59 lines
(quoted diff) +8 -0
+
+static int symbol__disassemble_capstone_powerpc(char *filename, struct symbol *sym,
+						struct annotate_args *args __maybe_unused)
+{
+	symbol__disassembler_missing("capstone powerpc", filename, sym);
+	return -1;
+}
+#endif // HAVE_LIBCAPSTONE_SUPPORT

static int symbol__disassemble_raw(char *filename, struct symbol *sym,
struct annotate_args *args)

(quoted diff) +11 -7
@@ -1983,7 +2003,14 @@ static int symbol__disassemble_llvm(char *filename, struct symbol *sym,
 	free(line_storage);
 	return ret;
 }
-#endif
+#else // HAVE_LIBLLVM_SUPPORT
+static int symbol__disassemble_llvm(char *filename, struct symbol *sym,
+				    struct annotate_args *args __maybe_unused)
+{
+	symbol__disassembler_missing("LLVM", filename, sym);
+	return -1;
+}
+#endif // HAVE_LIBLLVM_SUPPORT
 
 /*
 * Possibly create a new version of line with tabs expanded. Returns the
@@ -2242,24 +2269,21 @@ int symbol__disassemble(struct symbol *sym, struct annotate_args *args)
 			err = symbol__disassemble_raw(symfs_filename, sym, args);
 			if (err == 0)
 				goto out_remove_tmp;
-#ifdef HAVE_LIBCAPSTONE_SUPPORT
+
 			err = symbol__disassemble_capstone_powerpc(symfs_filename, sym, args);
 			if (err == 0)
 				goto out_remove_tmp;
-#endif
 		}
 	}
 
-#ifdef HAVE_LIBLLVM_SUPPORT
 	err = symbol__disassemble_llvm(symfs_filename, sym, args);
 	if (err == 0)
 		goto out_remove_tmp;
-#endif
-#ifdef HAVE_LIBCAPSTONE_SUPPORT
+
 	err = symbol__disassemble_capstone(symfs_filename, sym, args);
 	if (err == 0)
 		goto out_remove_tmp;
-#endif
+
 	err = symbol__disassemble_objdump(symfs_filename, sym, args);
 

out_remove_tmp:

Signature · 1 line
2.47.0
Tested-by
#9 lore raw

Re: [PATCH 2/3] perf disasm: Define stubs for the LLVM and capstone disassemblers

Quoted 25 lines · Arnaldo Carvalho de Melo
Quoted 14 lines · Aditya Bodkhe

Hi Arnaldo
I was testing this change in powerpc setup I see below compilation error

CC util/disasm.o
util/disasm.c: In function ‘symbol__disassemble_capstone’:
util/disasm.c:1728:9: error: expected declaration specifiers before ‘symbol__disassembler_missing’
1728 | symbol__disassembler_missing("capstone", filename, sym);
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~
util/disasm.c:1729:9: error: expected declaration specifiers before ‘return’
1729 | return -1;
| ^~~~~~
util/disasm.c:1730:1: error: expected declaration specifiers before ‘}’ token
1730 | }

Quoted 1 line

Below patch fixes the issue

Thanks, I've folded your fix into the patch since it is still in the tmp.perf-tools-next branch, added a note to the patch to give you and Masami credit, both sent fixes that I had to slightly adjust:

Quoted 7 lines

----
perf disasm: Define stubs for the LLVM and capstone disassemblers

This reduces the number of ifdefs in the main symbol__disassemble() method and paves the way for allowing the user to configure the disassemblers of preference.

Hi Arnaldo

Thanks for adding the fixes. I tested with tmp.perf-tools-next and it compiles fine

Tested-by Aditya Bodkhe <[email protected] <mailto:[email protected]>>
Quoted 92 lines
Cc Adrian Hunter <[email protected]>
Cc Aditya Bodkhe <[email protected]>
Cc Athira Rajeev <[email protected]>
Cc Jiri Olsa <[email protected]>
Cc Kan Liang <[email protected]>
Cc Masami Hiramatsu (Google) <[email protected]>
Cc Namhyung Kim <[email protected]>
Cc Steinar H. Gunderson <[email protected]>
[ Applied fixes from Masami Hiramatsu and Aditya Bodkhe for when capstone devel files are not available ]

----

Quoted 76 lines
tools/perf/util/disasm.c +2 -1
index df6c172c9c7f..da22b6ab9ecf 100644
@@ -1724,7 +1724,8 @@ static int symbol__disassemble_capstone(char *filename, struct symbol *sym,
 }
 #else // HAVE_LIBCAPSTONE_SUPPORT
 static int symbol__disassemble_capstone(char *filename, struct symbol *sym,
-                    struct annotate_args *args)
+                    struct annotate_args *args __maybe_unused)
+{
   symbol__disassembler_missing("capstone", filename, sym);
   return -1;
 }

I tried with tmp.perf-tools-next , I have tested the above patch fixes the compilation error

Thanks
Aditya Bodkhe

Quoted 57 lines
(quoted diff) +8 -0
+
+static int symbol__disassemble_capstone_powerpc(char *filename, struct symbol *sym,
+ struct annotate_args *args __maybe_unused)
+{
+ symbol__disassembler_missing("capstone powerpc", filename, sym);
+ return -1;
+}
+#endif // HAVE_LIBCAPSTONE_SUPPORT

static int symbol__disassemble_raw(char *filename, struct symbol *sym, struct annotate_args *args)

(quoted diff) +11 -7
@@ -1983,7 +2003,14 @@ static int symbol__disassemble_llvm(char *filename, struct symbol *sym,
 free(line_storage);
 return ret;
 }
-#endif
+#else // HAVE_LIBLLVM_SUPPORT
+static int symbol__disassemble_llvm(char *filename, struct symbol *sym,
+     struct annotate_args *args __maybe_unused)
+{
+ symbol__disassembler_missing("LLVM", filename, sym);
+ return -1;
+}
+#endif // HAVE_LIBLLVM_SUPPORT
 
 /*
 * Possibly create a new version of line with tabs expanded. Returns the
@@ -2242,24 +2269,21 @@ int symbol__disassemble(struct symbol *sym, struct annotate_args *args)
 err = symbol__disassemble_raw(symfs_filename, sym, args);
 if (err == 0)
 goto out_remove_tmp;
-#ifdef HAVE_LIBCAPSTONE_SUPPORT
+
 err = symbol__disassemble_capstone_powerpc(symfs_filename, sym, args);
 if (err == 0)
 goto out_remove_tmp;
-#endif
 }
 }
 
-#ifdef HAVE_LIBLLVM_SUPPORT
 err = symbol__disassemble_llvm(symfs_filename, sym, args);
 if (err == 0)
 goto out_remove_tmp;
-#endif
-#ifdef HAVE_LIBCAPSTONE_SUPPORT
+
 err = symbol__disassemble_capstone(symfs_filename, sym, args);
 if (err == 0)
 goto out_remove_tmp;
-#endif
+
 err = symbol__disassemble_objdump(symfs_filename, sym, args);
 

out_remove_tmp:

Signature · 1 line
2.47.0
author maintainer
#10 lore raw

PATCH 3/3 perf disasm: Allow configuring what disassemblers to use

In reply to Arnaldo Carvalho de Melo

From: Arnaldo Carvalho de Melo <[email protected]>

The perf tools annotation code used for a long time parsing the output of binutils's objdump (or its reimplementations, like llvm's) to then parse and augment it with samples, allow navigation, etc.

More recently disassemblers from the capstone and llvm (libraries, not parsing the output of tools using those libraries to mimic binutils's objdump output) were introduced.

So when all those methods are available, there is a static preference for a series of attempts of disassembling a binary, with the 'llvm, capstone, objdump' sequence being hard coded.

This patch allows users to change that sequence, specifying via a 'perf config' 'annotate.disassemblers' entry which and in what order disassemblers should be attempted.

As alluded to in the comments in the source code of this series, this flexibility is useful for users and developers alike, elliminating the requirement to rebuild the tool with some specific set of libraries to see how the output of disassembling would be for one of these methods.

  root@x1:~# rm -f ~/.perfconfig
  root@x1:~# perf annotate -v --stdio2 update_load_avg
  <SNIP>
  symbol__disassemble:
    filename=/usr/lib/debug/lib/modules/6.11.4-201.fc40.x86_64/vmlinux,
    sym=update_load_avg, start=0xffffffffb6148fe0, en>
  annotating [0x6ff7170]
    /usr/lib/debug/lib/modules/6.11.4-201.fc40.x86_64/vmlinux :
    [0x7407ca0] update_load_avg
  Disassembled with llvm
  annotate.disassemblers=llvm,capstone,objdump
  Samples: 66  of event 'cpu_atom/cycles/P', 10000 Hz,
	Event count (approx.): 5185444, [percent: local period]
  update_load_avg()
    /usr/lib/debug/lib/modules/6.11.4-201.fc40.x86_64/vmlinux
  Percent       0xffffffff81148fe0 <update_load_avg>:
     1.61         pushq   %r15
                  pushq   %r14
     1.00         pushq   %r13
                  movl    %edx,%r13d
     1.90         pushq   %r12
                  pushq   %rbp
                  movq    %rsi,%rbp
                  pushq   %rbx
                  movq    %rdi,%rbx
                  subq    $0x18,%rsp
    15.14         movl    0x1a4(%rdi),%eax
  root@x1:~# perf config annotate.disassemblers=capstone
  root@x1:~# cat ~/.perfconfig
  # this file is auto-generated.
  [annotate]
	  disassemblers = capstone
  root@x1:~#
  root@x1:~# perf annotate -v --stdio2 update_load_avg
  <SNIP>
  Disassembled with capstone
  annotate.disassemblers=capstone
  Samples: 66  of event 'cpu_atom/cycles/P', 10000 Hz,
  Event count (approx.): 5185444, [percent: local period]
  update_load_avg()
  /usr/lib/debug/lib/modules/6.11.4-201.fc40.x86_64/vmlinux
  Percent       0xffffffff81148fe0 <update_load_avg>:
     1.61         pushq   %r15
                  pushq   %r14
     1.00         pushq   %r13
                  movl    %edx,%r13d
     1.90         pushq   %r12
                  pushq   %rbp
                  movq    %rsi,%rbp
                  pushq   %rbx
                  movq    %rdi,%rbx
                  subq    $0x18,%rsp
    15.14         movl    0x1a4(%rdi),%eax
  root@x1:~# perf config annotate.disassemblers=objdump,capstone
  root@x1:~# perf config annotate.disassemblers
  annotate.disassemblers=objdump,capstone
  root@x1:~# cat ~/.perfconfig
  # this file is auto-generated.
  [annotate]
	  disassemblers = objdump,capstone
  root@x1:~# perf annotate -v --stdio2 update_load_avg
  Executing: objdump  --start-address=0xffffffff81148fe0 \
		      --stop-address=0xffffffff811497aa  \
		      -d --no-show-raw-insn -S -C "$1"
  Disassembled with objdump
  annotate.disassemblers=objdump,capstone
  Samples: 66  of event 'cpu_atom/cycles/P', 10000 Hz,
  Event count (approx.): 5185444, [percent: local period]
  update_load_avg()
  /usr/lib/debug/lib/modules/6.11.4-201.fc40.x86_64/vmlinux
  Percent
                Disassembly of section .text:

                ffffffff81148fe0 <update_load_avg>:
                #define DO_ATTACH       0x4

                ffffffff81148fe0 <update_load_avg>:
                #define DO_ATTACH       0x4
                #define DO_DETACH       0x8

                /* Update task and its cfs_rq load average */
                static inline void update_load_avg(struct cfs_rq *cfs_rq,
						   struct sched_entity *se,
						   int flags)
                {
     1.61         push   %r15
                  push   %r14
     1.00         push   %r13
                  mov    %edx,%r13d
     1.90         push   %r12
                  push   %rbp
                  mov    %rsi,%rbp
                  push   %rbx
                  mov    %rdi,%rbx
                  sub    $0x18,%rsp
                }

                /* rq->task_clock normalized against any time
		   this cfs_rq has spent throttled */
                static inline u64 cfs_rq_clock_pelt(struct cfs_rq *cfs_rq)
                {
                if (unlikely(cfs_rq->throttle_count))
    15.14         mov    0x1a4(%rdi),%eax

root@x1:~#

After adding a way to select the disassembler from the command line a 'perf test' comparing the output of the various diassemblers should be introduced, to test these codebases.

Cc Adrian Hunter <[email protected]>
Cc Athira Rajeev <[email protected]>
Cc Ian Rogers <[email protected]>
Cc Jiri Olsa <[email protected]>
Cc Kan Liang <[email protected]>
Cc Namhyung Kim <[email protected]>
Cc Steinar H. Gunderson <[email protected]>
---
 tools/perf/Documentation/perf-config.txt | 13 ++++
 tools/perf/util/annotate.c               |  6 ++
 tools/perf/util/annotate.h               |  6 ++
 tools/perf/util/disasm.c                 | 77 ++++++++++++++++++++++--
 4 files changed, 96 insertions(+), 6 deletions(-)
tools/perf/Documentation/perf-config.txt +13 -0
index 379f9d7a8ab11a02..1f668d4724e3749a 100644
@@ -247,6 +247,19 @@ annotate.*::
 	These are in control of addresses, jump function, source code
 	in lines of assembly code from a specific program.
 
+	annotate.disassemblers::
+		Choose the disassembler to use: "objdump", "llvm",  "capstone",
+		if not specified it will first try, if available, the "llvm" one,
+		then, if it fails, "capstone", and finally the original "objdump"
+		based one.
+
+		Choosing a different one is useful when handling some feature that
+		is known to be best support at some point by one of the options,
+		to compare the output when in doubt about some bug, etc.
+
+		This can be a list, in order of preference, the first one that works
+		finishes the process.
+
 	annotate.addr2line::
 		addr2line binary to use for file names and line numbers.
 
tools/perf/util/annotate.c +6 -0
index b1d98da79be8b2b0..32e15c9f53f3c0a3 100644
@@ -2116,6 +2116,12 @@ static int annotation__config(const char *var, const char *value, void *data)
 			opt->offset_level = ANNOTATION__MAX_OFFSET_LEVEL;
 		else if (opt->offset_level < ANNOTATION__MIN_OFFSET_LEVEL)
 			opt->offset_level = ANNOTATION__MIN_OFFSET_LEVEL;
+	} else if (!strcmp(var, "annotate.disassemblers")) {
+		opt->disassemblers_str = strdup(value);
+		if (!opt->disassemblers_str) {
+			pr_err("Not enough memory for annotate.disassemblers\n");
+			return -1;
+		}
 	} else if (!strcmp(var, "annotate.hide_src_code")) {
 		opt->hide_src_code = perf_config_bool("hide_src_code", value);
 	} else if (!strcmp(var, "annotate.jump_arrows")) {
tools/perf/util/annotate.h +6 -0
index 8b9e05a1932f2f9e..194a05cbc506e4da 100644
@@ -34,6 +34,9 @@ struct annotated_data_type;
 #define ANNOTATION__BR_CNTR_WIDTH 30
 #define ANNOTATION_DUMMY_LEN	256
 
+// llvm, capstone, objdump
+#define MAX_DISASSEMBLERS 3
+
 struct annotation_options {
 	bool hide_src_code,
 	     use_offset,
@@ -49,11 +52,14 @@ struct annotation_options {
 	     annotate_src,
 	     full_addr;
 	u8   offset_level;
+	u8   nr_disassemblers;
 	int  min_pcnt;
 	int  max_lines;
 	int  context;
 	char *objdump_path;
 	char *disassembler_style;
+	const char *disassemblers_str;
+	const char *disassemblers[MAX_DISASSEMBLERS];
 	const char *prefix;
 	const char *prefix_strip;
 	unsigned int percent_type;
tools/perf/util/disasm.c +71 -6

100 lines not on this page · raw message

Signature · 1 line
2.47.0
reviewer Acked-by on v1 3/3
#11 lore raw

Re: [PATCH 3/3] perf disasm: Allow configuring what disassemblers to use

Quoted 7 lines · Arnaldo Carvalho de Melo

From: Arnaldo Carvalho de Melo <[email protected]>

The perf tools annotation code used for a long time parsing the output of binutils's objdump (or its reimplementations, like llvm's) to then parse and augment it with samples, allow navigation, etc.

Quoted 7 lines

More recently disassemblers from the capstone and llvm (libraries, not parsing the output of tools using those libraries to mimic binutils's objdump output) were introduced.

So when all those methods are available, there is a static preference for a series of attempts of disassembling a binary, with the 'llvm, capstone, objdump' sequence being hard coded.

So it LLVM is the preference can we just switch to using the LLVM ELF libraries, etc? :-) I was a bit surprised to see LLVM as preferable to capstone, which feels more agnostic in the LLVM vs GCC/binutils wars. Fwiw, I'm happy with LLVM being the preference.

Quoted 120 lines

This patch allows users to change that sequence, specifying via a 'perf config' 'annotate.disassemblers' entry which and in what order disassemblers should be attempted.

As alluded to in the comments in the source code of this series, this flexibility is useful for users and developers alike, elliminating the requirement to rebuild the tool with some specific set of libraries to see how the output of disassembling would be for one of these methods.

  root@x1:~# rm -f ~/.perfconfig
  root@x1:~# perf annotate -v --stdio2 update_load_avg
  <SNIP>
  symbol__disassemble:
    filename=/usr/lib/debug/lib/modules/6.11.4-201.fc40.x86_64/vmlinux,
    sym=update_load_avg, start=0xffffffffb6148fe0, en>
  annotating [0x6ff7170]
    /usr/lib/debug/lib/modules/6.11.4-201.fc40.x86_64/vmlinux :
    [0x7407ca0] update_load_avg
  Disassembled with llvm
  annotate.disassemblers=llvm,capstone,objdump
  Samples: 66  of event 'cpu_atom/cycles/P', 10000 Hz,
        Event count (approx.): 5185444, [percent: local period]
  update_load_avg()
    /usr/lib/debug/lib/modules/6.11.4-201.fc40.x86_64/vmlinux
  Percent       0xffffffff81148fe0 <update_load_avg>:
     1.61         pushq   %r15
                  pushq   %r14
     1.00         pushq   %r13
                  movl    %edx,%r13d
     1.90         pushq   %r12
                  pushq   %rbp
                  movq    %rsi,%rbp
                  pushq   %rbx
                  movq    %rdi,%rbx
                  subq    $0x18,%rsp
    15.14         movl    0x1a4(%rdi),%eax
  root@x1:~# perf config annotate.disassemblers=capstone
  root@x1:~# cat ~/.perfconfig
  # this file is auto-generated.
  [annotate]
          disassemblers = capstone
  root@x1:~#
  root@x1:~# perf annotate -v --stdio2 update_load_avg
  <SNIP>
  Disassembled with capstone
  annotate.disassemblers=capstone
  Samples: 66  of event 'cpu_atom/cycles/P', 10000 Hz,
  Event count (approx.): 5185444, [percent: local period]
  update_load_avg()
  /usr/lib/debug/lib/modules/6.11.4-201.fc40.x86_64/vmlinux
  Percent       0xffffffff81148fe0 <update_load_avg>:
     1.61         pushq   %r15
                  pushq   %r14
     1.00         pushq   %r13
                  movl    %edx,%r13d
     1.90         pushq   %r12
                  pushq   %rbp
                  movq    %rsi,%rbp
                  pushq   %rbx
                  movq    %rdi,%rbx
                  subq    $0x18,%rsp
    15.14         movl    0x1a4(%rdi),%eax
  root@x1:~# perf config annotate.disassemblers=objdump,capstone
  root@x1:~# perf config annotate.disassemblers
  annotate.disassemblers=objdump,capstone
  root@x1:~# cat ~/.perfconfig
  # this file is auto-generated.
  [annotate]
          disassemblers = objdump,capstone
  root@x1:~# perf annotate -v --stdio2 update_load_avg
  Executing: objdump  --start-address=0xffffffff81148fe0 \
                      --stop-address=0xffffffff811497aa  \
                      -d --no-show-raw-insn -S -C "$1"
  Disassembled with objdump
  annotate.disassemblers=objdump,capstone
  Samples: 66  of event 'cpu_atom/cycles/P', 10000 Hz,
  Event count (approx.): 5185444, [percent: local period]
  update_load_avg()
  /usr/lib/debug/lib/modules/6.11.4-201.fc40.x86_64/vmlinux
  Percent
                Disassembly of section .text:

                ffffffff81148fe0 <update_load_avg>:
                #define DO_ATTACH       0x4

                ffffffff81148fe0 <update_load_avg>:
                #define DO_ATTACH       0x4
                #define DO_DETACH       0x8

                /* Update task and its cfs_rq load average */
                static inline void update_load_avg(struct cfs_rq *cfs_rq,
                                                   struct sched_entity *se,
                                                   int flags)
                {
     1.61         push   %r15
                  push   %r14
     1.00         push   %r13
                  mov    %edx,%r13d
     1.90         push   %r12
                  push   %rbp
                  mov    %rsi,%rbp
                  push   %rbx
                  mov    %rdi,%rbx
                  sub    $0x18,%rsp
                }

                /* rq->task_clock normalized against any time
                   this cfs_rq has spent throttled */
                static inline u64 cfs_rq_clock_pelt(struct cfs_rq *cfs_rq)
                {
                if (unlikely(cfs_rq->throttle_count))
    15.14         mov    0x1a4(%rdi),%eax

root@x1:~#

After adding a way to select the disassembler from the command line a 'perf test' comparing the output of the various diassemblers should be introduced, to test these codebases.

Quoted 8 lines
Cc Adrian Hunter <[email protected]>
Cc Athira Rajeev <[email protected]>
Cc Ian Rogers <[email protected]>
Cc Jiri Olsa <[email protected]>
Cc Kan Liang <[email protected]>
Cc Namhyung Kim <[email protected]>
Cc Steinar H. Gunderson <[email protected]>

Thanks,
Ian

Quoted 186 lines
---
 tools/perf/Documentation/perf-config.txt | 13 ++++
 tools/perf/util/annotate.c               |  6 ++
 tools/perf/util/annotate.h               |  6 ++
 tools/perf/util/disasm.c                 | 77 ++++++++++++++++++++++--
 4 files changed, 96 insertions(+), 6 deletions(-)
tools/perf/Documentation/perf-config.txt +13 -0
index 379f9d7a8ab11a02..1f668d4724e3749a 100644
@@ -247,6 +247,19 @@ annotate.*::
        These are in control of addresses, jump function, source code
        in lines of assembly code from a specific program.
 
+       annotate.disassemblers::
+               Choose the disassembler to use: "objdump", "llvm",  "capstone",
+               if not specified it will first try, if available, the "llvm" one,
+               then, if it fails, "capstone", and finally the original "objdump"
+               based one.
+
+               Choosing a different one is useful when handling some feature that
+               is known to be best support at some point by one of the options,
+               to compare the output when in doubt about some bug, etc.
+
+               This can be a list, in order of preference, the first one that works
+               finishes the process.
+
        annotate.addr2line::
                addr2line binary to use for file names and line numbers.
 
tools/perf/util/annotate.c +6 -0
index b1d98da79be8b2b0..32e15c9f53f3c0a3 100644
@@ -2116,6 +2116,12 @@ static int annotation__config(const char *var, const char *value, void *data)
                        opt->offset_level = ANNOTATION__MAX_OFFSET_LEVEL;
                else if (opt->offset_level < ANNOTATION__MIN_OFFSET_LEVEL)
                        opt->offset_level = ANNOTATION__MIN_OFFSET_LEVEL;
+       } else if (!strcmp(var, "annotate.disassemblers")) {
+               opt->disassemblers_str = strdup(value);
+               if (!opt->disassemblers_str) {
+                       pr_err("Not enough memory for annotate.disassemblers\n");
+                       return -1;
+               }
        } else if (!strcmp(var, "annotate.hide_src_code")) {
                opt->hide_src_code = perf_config_bool("hide_src_code", value);
        } else if (!strcmp(var, "annotate.jump_arrows")) {
tools/perf/util/annotate.h +6 -0
index 8b9e05a1932f2f9e..194a05cbc506e4da 100644
@@ -34,6 +34,9 @@ struct annotated_data_type;
 #define ANNOTATION__BR_CNTR_WIDTH 30
 #define ANNOTATION_DUMMY_LEN   256
 
+// llvm, capstone, objdump
+#define MAX_DISASSEMBLERS 3
+
 struct annotation_options {
        bool hide_src_code,
             use_offset,
@@ -49,11 +52,14 @@ struct annotation_options {
             annotate_src,
             full_addr;
        u8   offset_level;
+       u8   nr_disassemblers;
        int  min_pcnt;
        int  max_lines;
        int  context;
        char *objdump_path;
        char *disassembler_style;
+       const char *disassemblers_str;
+       const char *disassemblers[MAX_DISASSEMBLERS];
        const char *prefix;
        const char *prefix_strip;
        unsigned int percent_type;
tools/perf/util/disasm.c +71 -7
index 83df1da20a7b16cd..df6c172c9c7f86d9 100644
@@ -2210,13 +2210,65 @@ static int symbol__disassemble_objdump(const char *filename, struct symbol *sym,
        return err;
 }
 
+static int annotation_options__init_disassemblers(struct annotation_options *options)
+{
+       char *disassembler;
+
+       if (options->disassemblers_str == NULL) {
+               const char *default_disassemblers_str =
+#ifdef HAVE_LIBLLVM_SUPPORT
+                               "llvm,"
+#endif
+#ifdef HAVE_LIBCAPSTONE_SUPPORT
+                               "capstone,"
+#endif
+                               "objdump";
+
+               options->disassemblers_str = strdup(default_disassemblers_str);
+               if (!options->disassemblers_str)
+                       goto out_enomem;
+       }
+
+       disassembler = strdup(options->disassemblers_str);
+       if (disassembler == NULL)
+               goto out_enomem;
+
+       while (1) {
+               char *comma = strchr(disassembler, ',');
+
+               if (comma != NULL)
+                       *comma = '\0';
+
+               options->disassemblers[options->nr_disassemblers++] = strim(disassembler);
+
+               if (comma == NULL)
+                       break;
+
+               disassembler = comma + 1;
+
+               if (options->nr_disassemblers >= MAX_DISASSEMBLERS) {
+                       pr_debug("annotate.disassemblers can have at most %d entries, ignoring \"%s\"\n",
+                                MAX_DISASSEMBLERS, disassembler);
+                       break;
+               }
+       }
+
+       return 0;
+
+out_enomem:
+       pr_err("Not enough memory for annotate.disassemblers\n");
+       return -1;
+}
+
 int symbol__disassemble(struct symbol *sym, struct annotate_args *args)
 {
+       struct annotation_options *options = args->options;
        struct map *map = args->ms.map;
        struct dso *dso = map__dso(map);
        char symfs_filename[PATH_MAX];
        bool delete_extract = false;
        struct kcore_extract kce;
+       const char *disassembler;
        bool decomp = false;
        int err = dso__disassemble_filename(dso, symfs_filename, sizeof(symfs_filename));
 
@@ -2276,16 +2328,29 @@ int symbol__disassemble(struct symbol *sym, struct annotate_args *args)
                }
        }
 
-       err = symbol__disassemble_llvm(symfs_filename, sym, args);
-       if (err == 0)
+       err = annotation_options__init_disassemblers(options);
+       if (err)
                goto out_remove_tmp;
 
-       err = symbol__disassemble_capstone(symfs_filename, sym, args);
-       if (err == 0)
-               goto out_remove_tmp;
+       err = -1;
 
-       err = symbol__disassemble_objdump(symfs_filename, sym, args);
+       for (int i = 0; i < options->nr_disassemblers && err != 0; ++i) {
+               disassembler = options->disassemblers[i];
 
+               if (!strcmp(disassembler, "llvm"))
+                       err = symbol__disassemble_llvm(symfs_filename, sym, args);
+               else if (!strcmp(disassembler, "capstone"))
+                       err = symbol__disassemble_capstone(symfs_filename, sym, args);
+               else if (!strcmp(disassembler, "objdump"))
+                       err = symbol__disassemble_objdump(symfs_filename, sym, args);
+               else
+                       pr_debug("Unknown disassembler %s, skipping...\n", disassembler);
+       }
+
+       if (err == 0) {
+               pr_debug("Disassembled with %s\nannotate.disassemblers=%s\n",
+                        disassembler, options->disassemblers_str);
+       }
 out_remove_tmp:
        if (decomp)
                unlink(symfs_filename);
--

2.47.0

author maintainer
#12 lore raw

Re: [PATCH 3/3] perf disasm: Allow configuring what disassemblers to use

Quoted 9 lines · Ian Rogers
Quoted 7 lines · Arnaldo Carvalho de Melo

The perf tools annotation code used for a long time parsing the output of binutils's objdump (or its reimplementations, like llvm's) to then parse and augment it with samples, allow navigation, etc.

More recently disassemblers from the capstone and llvm (libraries, not parsing the output of tools using those libraries to mimic binutils's objdump output) were introduced.

Quoted 6 lines
Quoted 3 lines

So when all those methods are available, there is a static preference for a series of attempts of disassembling a binary, with the 'llvm, capstone, objdump' sequence being hard coded.

So it LLVM is the preference can we just switch to using the LLVM ELF libraries, etc? :-) I was a bit surprised to see LLVM as preferable to

I'd have to look up the discussion to see how this ended up being the default when LLVM is available, but when I wanted to have source code intermixed with it and noticed that the LLVM output doesn't have it, that lead me to try to make this selectable so that we can go from one to the other when needing something not available in one of them.

On my todo list, and here Steinar could help, is to check if we an have source code intermixed with the llvm based disassembler, like we have with the objdump based one.

Quoted 2 lines

capstone, which feels more agnostic in the LLVM vs GCC/binutils wars. Fwiw, I'm happy with LLVM being the preference.

<SNIP>

Quoted 13 lines
Quoted 4 lines

After adding a way to select the disassembler from the command line a 'perf test' comparing the output of the various diassemblers should be introduced, to test these codebases.

Quoted 8 lines
Cc Adrian Hunter <[email protected]>
Cc Athira Rajeev <[email protected]>
Cc Ian Rogers <[email protected]>
Cc Jiri Olsa <[email protected]>
Cc Kan Liang <[email protected]>
Cc Namhyung Kim <[email protected]>
Cc Steinar H. Gunderson <[email protected]>
Quoted 1 line

Thanks!

- Arnaldo

#13 lore raw

Re: [PATCH 3/3] perf disasm: Allow configuring what disassemblers to use

Quoted 3 lines · Arnaldo Carvalho de Melo

On my todo list, and here Steinar could help, is to check if we an have source code intermixed with the llvm based disassembler, like we have with the objdump based one.

I am no LLVM expert; the only time I ever touched it was for perf :-)

TBH I'm not entirely sure what functionality this is, though; I don't think I've ever gotten perf to list source code for me, ever (in the ~15 years I've used it). I can give --line-numbers (and optionally --inlines) to objdump and then look up the line numbers by hand with an editor, but the actual source? Is there some way perf can attribute the samples back to individual source code lines the way some other profilers can (i.e., showing the source instead of instructions)?

I would assume that LLVM has some way of outputting line numbers (presumably by parsing debug information), since llvm-objdump supports --line-numbers, but that's perhaps not what you're asking about?

/* Steinar */

author maintainer
#14 lore raw

Re: [PATCH 3/3] perf disasm: Allow configuring what disassemblers to use

Quoted 6 lines · Steinar H. Gunderson
Quoted 3 lines · Arnaldo Carvalho de Melo

On my todo list, and here Steinar could help, is to check if we an have source code intermixed with the llvm based disassembler, like we have with the objdump based one.

I am no LLVM expert; the only time I ever touched it was for perf :-)

Expert enough to get some more LLVM based features in perf ;-)

Quoted 3 lines

TBH I'm not entirely sure what functionality this is, though; I don't think I've ever gotten perf to list source code for me, ever (in the ~15 years I've used it).

I mean this:

root@number:~# uname -r
6.11.6-200.fc40.x86_64
root@number:~# rpm -q kernel-debuginfo
package kernel-debuginfo is not installed
root@number:~# rpm -qa | grep kernel-debuginfo
root@number:~# perf probe -L icmp_rcv
<icmp_rcv@/root/.cache/debuginfod_client/365ce5a0ccb899e5b203f81ed386764b3e8a6c2e/source-e181e220-#usr#src#debug#kernel-6.11.6#linux-6.11.6-200.fc40.x86_64#net#ipv4#icmp.c:0>
      0  int icmp_rcv(struct sk_buff *skb)
         {
      2  	enum skb_drop_reason reason = SKB_DROP_REASON_NOT_SPECIFIED;
         	struct rtable *rt = skb_rtable(skb);
         	struct net *net = dev_net(rt->dst.dev);
         	struct icmphdr *icmph;
         	if (!xfrm4_policy_check(NULL, XFRM_POLICY_IN, skb)) {
      8  		struct sec_path *sp = skb_sec_path(skb);
      9  		int nh;
         
         		if (!(sp && sp->xvec[sp->len - 1]->props.flags &
         				 XFRM_STATE_ICMP)) {
         			reason = SKB_DROP_REASON_XFRM_POLICY;
         			goto drop;
         		}
<SNIP>
                /*
                 *      Parse the ICMP message
                 */
         
     73         if (rt->rt_flags & (RTCF_BROADCAST | RTCF_MULTICAST)) {
                        /*
                         *      RFC 1122: 3.2.2.6 An ICMP_ECHO to broadcast MAY be
                         *        silently ignored (we let user decide with a sysctl).
                         *      RFC 1122: 3.2.2.8 An ICMP_TIMESTAMP MAY be silently
                         *        discarded if to broadcast/multicast.
                         */
     80                 if ((icmph->type == ICMP_ECHO ||
                             icmph->type == ICMP_TIMESTAMP) &&
     82                     READ_ONCE(net->ipv4.sysctl_icmp_echo_ignore_broadcasts)) {
                                reason = SKB_DROP_REASON_INVALID_PROTO;
                                goto error;
                        }
     86                 if (icmph->type != ICMP_ECHO &&
                            icmph->type != ICMP_TIMESTAMP &&
                            icmph->type != ICMP_ADDRESS &&
                            icmph->type != ICMP_ADDRESSREPLY) {
                                reason = SKB_DROP_REASON_INVALID_PROTO;
                                goto error;
                        }
                }

<SNIP>

So, source code, automatically obtained from a debuginfod server and places where one can put a probe.

Also in annotation:

root@number:~# perf record ping -f 127.0.0.1
PING 127.0.0.1 (127.0.0.1) 56(84) bytes of data.
^C 
--- 127.0.0.1 ping statistics ---
552924 packets transmitted, 552924 received, 0% packet loss, time 2192ms
rtt min/avg/max/mdev = 0.001/0.001/0.204/0.000 ms, ipg/ewma 0.003/0.002 ms
[ perf record: Woken up 1 times to write data ]
[ perf record: Captured and wrote 0.424 MB perf.data (8509 samples) ]

root@number:~#

root@number:~# perf config annotate.disassemblers=objdump
root@number:~# perf annotate  --stdio2 icmp_rcv | head -20
Samples: 1  of event 'cpu_atom/cycles/P', 4000 Hz, Event count (approx.): 2993537, [percent: local period]
icmp_rcv() /proc/kcore
Percent          
              Disassembly of section load0:
                 
              ffffffffaff60220 <load0>:
                endbr64         
                nop             
                push    %r15    
                xor     %esi,%esi
                push    %r14    
                push    %r13    
                push    %r12    
                push    %rbp    
                push    %rbx    
                mov     %rdi,%rbx
                sub     $0x8,%rsp
                mov     0x58(%rdi),%rbp

No source code, but then its objdump that is running and we don't have the debuginfo file, i.e. the objdump tool doesn't link with libdebuginfo to use the debuginfod server, so we need to install the huge kernel-debuginfo packages:

root@number:~# dnf debuginfo-install kernel

And then it works:

root@number:~# perf annotate  --stdio2 icmp_rcv
Samples: 53  of event 'cpu_core/cycles/P', 4000 Hz, Event count (approx.): 73399213, [percent: local period]
icmp_rcv() /usr/lib/debug/lib/modules/6.11.6-200.fc40.x86_64/vmlinux
Percent          
              Disassembly of section .text:
                 
              ffffffff81f60220 <icmp_rcv>:
                 
              /*          
              *       Deal with incoming ICMP packets.
              */          
              int icmp_rcv(struct sk_buff *skb)
              {           
                endbr64         
              → call    __fentry__
                push    %r15    
              __xfrm_policy_check(sk, ndir, skb, family);
              }           
                 
              static inline int xfrm_policy_check(struct sock *sk, int dir, struct sk_buff *skb, unsigned short family)
              {           
              return __xfrm_policy_check2(sk, dir, skb, family, 0);
                xor     %esi,%esi
                push    %r14    
                push    %r13    
                push    %r12    
   3.74         push    %rbp    
                push    %rbx    
                mov     %rdi,%rbx
                sub     $0x8,%rsp
              * rcu_read_lock section
              */          
              WARN_ON((skb->_skb_refdst & SKB_DST_NOREF) &&
              !rcu_read_lock_held() &&
              !rcu_read_lock_bh_held());
              return (struct dst_entry *)(skb->_skb_refdst & SKB_DST_PTRMASK);
   3.74         mov     0x58(%rdi),%rbp
                and     $0xfffffffffffffffe,%rbp
              }           
<SKIP some inlines used in icmp_rcv that don't have samples in this perf.data>
             skb_set_network_header(skb, nh);
              }           
                 
              __ICMP_INC_STATS(net, ICMP_MIB_INMSGS);
          f1:   mov     0x1f0(%r13),%rax
   9.35         incq    %gs:0x8(%rax)
              return ((skb->ip_summed == CHECKSUM_UNNECESSARY) ||
                movzbl  0x80(%rbx),%ecx
                 
              if (skb_checksum_simple_validate(skb))
                movzbl  0x83(%rbx),%eax
                mov     %ecx,%edx
                and     $0xfffffffe,%eax
                and     $0x60,%edx
                mov     %al,0x83(%rbx)
              skb->csum_valid ||
                cmp     $0x20,%dl
              ↓ je      2e5     
   1.87         cmp     $0x60,%dl
              ↓ je      2a2     
              if (skb->ip_summed == CHECKSUM_COMPLETE) {
                cmp     $0x40,%dl
              ↓ je      26e     
              skb->csum = psum;
         134:   movl    $0x0,0x8c(%rbx)
              csum = __skb_checksum_complete(skb);
                mov     %rbx,%rdi
   6.59       → call    __skb_checksum_complete
              skb->csum_valid = !csum;
                movzbl  0x83(%rbx),%edx
                test    %ax,%ax 
                sete    %cl     

5.61 and $0xfffffffe,%edx
<SKIP some more>

This kind of thing.

Quoted 5 lines

I can give --line-numbers (and optionally --inlines)
to objdump and then look up the line numbers by hand with an editor, but the actual source? Is there some way perf can attribute the samples back to individual source code lines the way some other profilers can (i.e., showing the source instead of instructions)?

You can show just instructions or instructions + source code.

There were requests but no attempt that I know of of doing just source code.

Please take a look at 'perf config --help', or directly at tools/perf/Documentation/perf-config.txt to see what you can configure to govern the annotation process, for
instance:

-------
annotate.hide_src_code::
If a program which is analyzed has source code,
this option lets 'annotate' print a list of assembly code with the source code. For example, let's see a part of a program. There're four lines. If this option is 'true', they can be printed
without source code from a program as below.

│ push %rbp
│ mov %rsp,%rbp
│ sub $0x10,%rsp
│ mov (%rdi),%rdx

But if this option is 'false', source code of the part can be also printed as below. Default is 'false'.

│ struct rb_node *rb_next(const struct rb_node *node)
│ {
│ push %rbp
│ mov %rsp,%rbp
│ sub $0x10,%rsp
│ struct rb_node *parent;
│
│ if (RB_EMPTY_NODE(node))
│ mov (%rdi),%rdx
│ return n;

This option works with tui, stdio2 browsers.
-------

Quoted 3 lines

I would assume that LLVM has some way of outputting line numbers (presumably by parsing debug information), since llvm-objdump supports --line-numbers, but that's perhaps not what you're asking about?

So, this is the command line that perf hands to objdump:

root@number:~# perf annotate  -vv --stdio2 icmp_rcv  |& grep objdump
Executing: objdump  --start-address=0xffffffff81f60220 --stop-address=0xffffffff81f605cb  -d --no-show-raw-insn -S      -C "$1"
Disassembled with objdump
annotate.disassemblers=objdump
root@number:~# strace -f -s512 -e execve -- perf annotate  -vv --stdio2 icmp_rcv |& grep objdump
[pid 24768] execve("/usr/bin/objdump", ["objdump", "--start-address=0xffffffff81f60220", "--stop-address=0xffffffff81f605cb", "-d", "--no-show-raw-insn", "-S", "-C", "/usr/lib/debug/lib/modules/6.11.6-200.fc40.x86_64/vmlinux"], 0x55efca837c50 /* 39 vars */) = 0
^C
root@number:~#

⬢ [acme@toolbox perf-tools-next]$ objdump --help |& grep -- -S
-S, --source Intermix source code with disassembly

      --file-start-context       Include context from start of file (with -S)
      --prefix=PREFIX            Add PREFIX to absolute paths for -S
      --prefix-strip=LEVEL       Strip initial directory names for -S
⬢ [acme@toolbox perf-tools-next]$ objdump --help |& grep -- -S
  -S, --source             Intermix source code with disassembly
      --file-start-context       Include context from start of file (with -S)
      --prefix=PREFIX            Add PREFIX to absolute paths for -S
      --prefix-strip=LEVEL       Strip initial directory names for -S

⬢ [acme@toolbox perf-tools-next]$

And llvm-objdump _has_ it:

⬢ [acme@toolbox perf-tools-next]$ llvm-objdump --help |& grep -- --source
--source When disassembling, display source interleaved with the disassembly. Implies --disassemble
-S Alias for --source
⬢ [acme@toolbox perf-tools-next]$

And perf allows to use llvm-objdump in the "objdump" disassembler:

⬢ [acme@toolbox perf-tools-next]$ perf annotate -h objdump

Usage: perf annotate [<options>]

--objdump <path> objdump binary to use for disassembly and annotations

⬢ [acme@toolbox perf-tools-next]$

Also via perf-config:

root@number:~# perf config annotate.objdump=llvm-objdump
root@number:~# cat ~/.perfconfig 
# this file is auto-generated.
[annotate]
	disassemblers = objdump
	objdump = llvm-objdump
root@number:~# 

And it works:

root@number:~# perf annotate --stdio2 icmp_rcv
Samples: 53  of event 'cpu_core/cycles/P', 4000 Hz, Event count (approx.): 73399213, [percent: local period]
icmp_rcv() /usr/lib/debug/lib/modules/6.11.6-200.fc40.x86_64/vmlinux
Percent          
              Disassembly of section .text:
                 
              ffffffff81f60220 <icmp_rcv>:
              ; {         
                endbr64         
              → callq   __fentry__
                pushq   %r15    
              ;       return __xfrm_policy_check2(sk, dir, skb, family, 0);
                xorl    %esi,%esi
              ; {         
                pushq   %r14    
                pushq   %r13    
                pushq   %r12    
   3.74         pushq   %rbp    
                pushq   %rbx    
                movq    %rdi,%rbx
                subq    $0x8,%rsp
              ;       return (struct dst_entry *)(skb->_skb_refdst & SKB_DST_PTRMASK);
   3.74         movq    0x58(%rdi),%rbp
                andq    $-0x2,%rbp
              ;       return rcu_dereference_protected(pnet->net, true);
                movq    (%rbp),%rax
                movq    0x118(%rax),%r13
              ;       return __xfrm_policy_check2(sk, dir, skb, family, 0);
              → callq   __xfrm_policy_check2.constprop.0

The output is different, but same instructions on a quick scan.

To double check:

root@number:~# strace -f -s512 -e execve -- perf annotate  -vv --stdio2 icmp_rcv |& grep -m3 objdump
Executing: llvm-objdump  --start-address=0xffffffff81f60220 --stop-address=0xffffffff81f605cb  -d --no-show-raw-insn -S      -C "$1"
[pid 26113] execve("/bin/sh", ["/bin/sh", "-c", "llvm-objdump  --start-address=0xffffffff81f60220 --stop-address=0xffffffff81f605cb  -d --no-show-raw-insn -S      -C \"$1\"", "--", "/usr/lib/debug/lib/modules/6.11.6-200.fc40.x86_64/vmlinux"], 0x157fa1d0 /* 39 vars */) = 0
[pid 26113] execve("/usr/bin/llvm-objdump", ["llvm-objdump", "--start-address=0xffffffff81f60220", "--stop-address=0xffffffff81f605cb", "-d", "--no-show-raw-insn", "-S", "-C", "/usr/lib/debug/lib/modules/6.11.6-200.fc40.x86_64/vmlinux"], 0x559f670e7bd0 /* 39 vars */) = 0
root@number:~#

So, in symbol__disassemble_llvm() it should look at args->options->hide_src_code and use that to ask the llvm lib to have that source code in the disasm somehow.

- Arnaldo

#15 lore raw

Re: [PATCH 3/3] perf disasm: Allow configuring what disassemblers to use

Quoted 2 lines · Arnaldo Carvalho de Melo

So, source code, automatically obtained from a debuginfod server and places where one can put a probe.

Mm, OK. Unfortunately I don't have any debuginfod stuff available on this side, but I understand the desire.

I looked at the LLVM disassembler and it _does_ insert line numbers:

                  llvm_addr2line(filename, pc, &args->fileloc,
                                 (unsigned int *)&args->line_nr, false, NULL);

But this is maybe not enough? We don't have any machinery in perf to get from the file + line number to the source ourselves? (What does capstone and the embedded binutils disassembler do?)

Quoted 4 lines

You can show just instructions or instructions + source code.

There were requests but no attempt that I know of of doing just source code.

TBH I'd love the latter, but I'm not going to sign up for doing it. :-)

/* Steinar */

reviewer
#16 lore raw

Re: [PATCH 3/3] perf disasm: Allow configuring what disassemblers to use

In reply to Arnaldo Carvalho de Melo
Quoted 248 lines · Arnaldo Carvalho de Melo

From: Arnaldo Carvalho de Melo <[email protected]>

The perf tools annotation code used for a long time parsing the output of binutils's objdump (or its reimplementations, like llvm's) to then parse and augment it with samples, allow navigation, etc.

More recently disassemblers from the capstone and llvm (libraries, not parsing the output of tools using those libraries to mimic binutils's objdump output) were introduced.

So when all those methods are available, there is a static preference for a series of attempts of disassembling a binary, with the 'llvm, capstone, objdump' sequence being hard coded.

This patch allows users to change that sequence, specifying via a 'perf config' 'annotate.disassemblers' entry which and in what order disassemblers should be attempted.

As alluded to in the comments in the source code of this series, this flexibility is useful for users and developers alike, elliminating the requirement to rebuild the tool with some specific set of libraries to see how the output of disassembling would be for one of these methods.

  root@x1:~# rm -f ~/.perfconfig
  root@x1:~# perf annotate -v --stdio2 update_load_avg
  <SNIP>
  symbol__disassemble:
    filename=/usr/lib/debug/lib/modules/6.11.4-201.fc40.x86_64/vmlinux,
    sym=update_load_avg, start=0xffffffffb6148fe0, en>
  annotating [0x6ff7170]
    /usr/lib/debug/lib/modules/6.11.4-201.fc40.x86_64/vmlinux :
    [0x7407ca0] update_load_avg
  Disassembled with llvm
  annotate.disassemblers=llvm,capstone,objdump
  Samples: 66  of event 'cpu_atom/cycles/P', 10000 Hz,
        Event count (approx.): 5185444, [percent: local period]
  update_load_avg()
    /usr/lib/debug/lib/modules/6.11.4-201.fc40.x86_64/vmlinux
  Percent       0xffffffff81148fe0 <update_load_avg>:
     1.61         pushq   %r15
                  pushq   %r14
     1.00         pushq   %r13
                  movl    %edx,%r13d
     1.90         pushq   %r12
                  pushq   %rbp
                  movq    %rsi,%rbp
                  pushq   %rbx
                  movq    %rdi,%rbx
                  subq    $0x18,%rsp
    15.14         movl    0x1a4(%rdi),%eax
  root@x1:~# perf config annotate.disassemblers=capstone
  root@x1:~# cat ~/.perfconfig
  # this file is auto-generated.
  [annotate]
          disassemblers = capstone
  root@x1:~#
  root@x1:~# perf annotate -v --stdio2 update_load_avg
  <SNIP>
  Disassembled with capstone
  annotate.disassemblers=capstone
  Samples: 66  of event 'cpu_atom/cycles/P', 10000 Hz,
  Event count (approx.): 5185444, [percent: local period]
  update_load_avg()
  /usr/lib/debug/lib/modules/6.11.4-201.fc40.x86_64/vmlinux
  Percent       0xffffffff81148fe0 <update_load_avg>:
     1.61         pushq   %r15
                  pushq   %r14
     1.00         pushq   %r13
                  movl    %edx,%r13d
     1.90         pushq   %r12
                  pushq   %rbp
                  movq    %rsi,%rbp
                  pushq   %rbx
                  movq    %rdi,%rbx
                  subq    $0x18,%rsp
    15.14         movl    0x1a4(%rdi),%eax
  root@x1:~# perf config annotate.disassemblers=objdump,capstone
  root@x1:~# perf config annotate.disassemblers
  annotate.disassemblers=objdump,capstone
  root@x1:~# cat ~/.perfconfig
  # this file is auto-generated.
  [annotate]
          disassemblers = objdump,capstone
  root@x1:~# perf annotate -v --stdio2 update_load_avg
  Executing: objdump  --start-address=0xffffffff81148fe0 \
                      --stop-address=0xffffffff811497aa  \
                      -d --no-show-raw-insn -S -C "$1"
  Disassembled with objdump
  annotate.disassemblers=objdump,capstone
  Samples: 66  of event 'cpu_atom/cycles/P', 10000 Hz,
  Event count (approx.): 5185444, [percent: local period]
  update_load_avg()
  /usr/lib/debug/lib/modules/6.11.4-201.fc40.x86_64/vmlinux
  Percent
                Disassembly of section .text:

                ffffffff81148fe0 <update_load_avg>:
                #define DO_ATTACH       0x4

                ffffffff81148fe0 <update_load_avg>:
                #define DO_ATTACH       0x4
                #define DO_DETACH       0x8

                /* Update task and its cfs_rq load average */
                static inline void update_load_avg(struct cfs_rq *cfs_rq,
                                                   struct sched_entity *se,
                                                   int flags)
                {
     1.61         push   %r15
                  push   %r14
     1.00         push   %r13
                  mov    %edx,%r13d
     1.90         push   %r12
                  push   %rbp
                  mov    %rsi,%rbp
                  push   %rbx
                  mov    %rdi,%rbx
                  sub    $0x18,%rsp
                }

                /* rq->task_clock normalized against any time
                   this cfs_rq has spent throttled */
                static inline u64 cfs_rq_clock_pelt(struct cfs_rq *cfs_rq)
                {
                if (unlikely(cfs_rq->throttle_count))
    15.14         mov    0x1a4(%rdi),%eax

root@x1:~#

After adding a way to select the disassembler from the command line a 'perf test' comparing the output of the various diassemblers should be introduced, to test these codebases.

Cc Adrian Hunter <[email protected]>
Cc Athira Rajeev <[email protected]>
Cc Ian Rogers <[email protected]>
Cc Jiri Olsa <[email protected]>
Cc Kan Liang <[email protected]>
Cc Namhyung Kim <[email protected]>
Cc Steinar H. Gunderson <[email protected]>
---
 tools/perf/Documentation/perf-config.txt | 13 ++++
 tools/perf/util/annotate.c               |  6 ++
 tools/perf/util/annotate.h               |  6 ++
 tools/perf/util/disasm.c                 | 77 ++++++++++++++++++++++--
 4 files changed, 96 insertions(+), 6 deletions(-)
tools/perf/Documentation/perf-config.txt +13 -0
index 379f9d7a8ab11a02..1f668d4724e3749a 100644
@@ -247,6 +247,19 @@ annotate.*::
        These are in control of addresses, jump function, source code
        in lines of assembly code from a specific program.
 
+       annotate.disassemblers::
+               Choose the disassembler to use: "objdump", "llvm",  "capstone",
+               if not specified it will first try, if available, the "llvm" one,
+               then, if it fails, "capstone", and finally the original "objdump"
+               based one.
+
+               Choosing a different one is useful when handling some feature that
+               is known to be best support at some point by one of the options,
+               to compare the output when in doubt about some bug, etc.
+
+               This can be a list, in order of preference, the first one that works
+               finishes the process.
+
        annotate.addr2line::
                addr2line binary to use for file names and line numbers.
 
tools/perf/util/annotate.c +6 -0
index b1d98da79be8b2b0..32e15c9f53f3c0a3 100644
@@ -2116,6 +2116,12 @@ static int annotation__config(const char *var, const char *value, void *data)
                        opt->offset_level = ANNOTATION__MAX_OFFSET_LEVEL;
                else if (opt->offset_level < ANNOTATION__MIN_OFFSET_LEVEL)
                        opt->offset_level = ANNOTATION__MIN_OFFSET_LEVEL;
+       } else if (!strcmp(var, "annotate.disassemblers")) {
+               opt->disassemblers_str = strdup(value);
+               if (!opt->disassemblers_str) {
+                       pr_err("Not enough memory for annotate.disassemblers\n");
+                       return -1;
+               }
        } else if (!strcmp(var, "annotate.hide_src_code")) {
                opt->hide_src_code = perf_config_bool("hide_src_code", value);
        } else if (!strcmp(var, "annotate.jump_arrows")) {
tools/perf/util/annotate.h +6 -0
index 8b9e05a1932f2f9e..194a05cbc506e4da 100644
@@ -34,6 +34,9 @@ struct annotated_data_type;
 #define ANNOTATION__BR_CNTR_WIDTH 30
 #define ANNOTATION_DUMMY_LEN   256
 
+// llvm, capstone, objdump
+#define MAX_DISASSEMBLERS 3
+
 struct annotation_options {
        bool hide_src_code,
             use_offset,
@@ -49,11 +52,14 @@ struct annotation_options {
             annotate_src,
             full_addr;
        u8   offset_level;
+       u8   nr_disassemblers;
        int  min_pcnt;
        int  max_lines;
        int  context;
        char *objdump_path;
        char *disassembler_style;
+       const char *disassemblers_str;
+       const char *disassemblers[MAX_DISASSEMBLERS];
        const char *prefix;
        const char *prefix_strip;
        unsigned int percent_type;
tools/perf/util/disasm.c +20 -0
index 83df1da20a7b16cd..df6c172c9c7f86d9 100644
@@ -2210,13 +2210,65 @@ static int symbol__disassemble_objdump(const char *filename, struct symbol *sym,
        return err;
 }
 
+static int annotation_options__init_disassemblers(struct annotation_options *options)
+{
+       char *disassembler;
+
+       if (options->disassemblers_str == NULL) {
+               const char *default_disassemblers_str =
+#ifdef HAVE_LIBLLVM_SUPPORT
+                               "llvm,"
+#endif
+#ifdef HAVE_LIBCAPSTONE_SUPPORT
+                               "capstone,"
+#endif
+                               "objdump";
+
+               options->disassemblers_str = strdup(default_disassemblers_str);
+               if (!options->disassemblers_str)
+                       goto out_enomem;
+       }
+
+       disassembler = strdup(options->disassemblers_str);

tools/perf/util/disasm.c static int symbol__disassemble_objdump(const char *filename, struct symbol *sym, · line 2242

Quoted 10 lines
tools/perf/util/disasm.c +10 -0
+       if (disassembler == NULL)
+               goto out_enomem;
+
+       while (1) {
+               char *comma = strchr(disassembler, ',');
+
+               if (comma != NULL)
+                       *comma = '\0';
+
+               options->disassemblers[options->nr_disassemblers++] = strim(disassembler);

Here is an array assignment.

tools/perf/util/disasm.c static int symbol__disassemble_objdump(const char *filename, struct symbol *sym, · line 2253

Quoted 11 lines
tools/perf/util/disasm.c +11 -0
+
+               if (comma == NULL)
+                       break;
+
+               disassembler = comma + 1;
+
+               if (options->nr_disassemblers >= MAX_DISASSEMBLERS) {
+                       pr_debug("annotate.disassemblers can have at most %d entries, ignoring \"%s\"\n",
+                                MAX_DISASSEMBLERS, disassembler);
+                       break;
+               }

The bound check is after the assignment.

Quoted 22 lines
tools/perf/util/disasm.c +11 -0
+       }
+
+       return 0;
+
+out_enomem:
+       pr_err("Not enough memory for annotate.disassemblers\n");
+       return -1;
+}
+
 int symbol__disassemble(struct symbol *sym, struct annotate_args *args)
 {
+       struct annotation_options *options = args->options;
        struct map *map = args->ms.map;
        struct dso *dso = map__dso(map);
        char symfs_filename[PATH_MAX];
        bool delete_extract = false;
        struct kcore_extract kce;
+       const char *disassembler;
        bool decomp = false;
        int err = dso__disassemble_filename(dso, symfs_filename, sizeof(symfs_filename));
 

tools/perf/util/disasm.c int symbol__disassemble(struct symbol *sym, struct annotate_args *args) · line 2331

Quoted 6 lines
tools/perf/util/disasm.c +1 -2
@@ -2276,16 +2328,29 @@ int symbol__disassemble(struct symbol *sym, struct annotate_args *args)
                }
        }
 
-       err = symbol__disassemble_llvm(symfs_filename, sym, args);
-       if (err == 0)
+       err = annotation_options__init_disassemblers(options);

symbol__disassemble may be called more than once so annotation_options__init_disassemblers can be called more than once yielding a buffer overflow above. I'm working on a fix which removes some of the fiddliness of using strings.

Thanks,
Ian

Quoted 32 lines
tools/perf/util/disasm.c +18 -5
+       if (err)
                goto out_remove_tmp;
 
-       err = symbol__disassemble_capstone(symfs_filename, sym, args);
-       if (err == 0)
-               goto out_remove_tmp;
+       err = -1;
 
-       err = symbol__disassemble_objdump(symfs_filename, sym, args);
+       for (int i = 0; i < options->nr_disassemblers && err != 0; ++i) {
+               disassembler = options->disassemblers[i];
 
+               if (!strcmp(disassembler, "llvm"))
+                       err = symbol__disassemble_llvm(symfs_filename, sym, args);
+               else if (!strcmp(disassembler, "capstone"))
+                       err = symbol__disassemble_capstone(symfs_filename, sym, args);
+               else if (!strcmp(disassembler, "objdump"))
+                       err = symbol__disassemble_objdump(symfs_filename, sym, args);
+               else
+                       pr_debug("Unknown disassembler %s, skipping...\n", disassembler);
+       }
+
+       if (err == 0) {
+               pr_debug("Disassembled with %s\nannotate.disassemblers=%s\n",
+                        disassembler, options->disassemblers_str);
+       }
 out_remove_tmp:
        if (decomp)
                unlink(symfs_filename);
--

2.47.0