diff mbox series

[23/52] perf report: Add 'symoff' sort key

Message ID 20231110000012.3538610-24-namhyung@kernel.org
State New
Headers
Series perf tools: Introduce data type profiling (v2) |

Commit Message

Namhyung Kim Nov. 9, 2023, 11:59 p.m. UTC 
  The symoff sort key is to print symbol and offset of sample.  This is
useful for data type profiling to show exact instruction in the function
which refers the data.

  $ perf report -s type,sym,typeoff,symoff --hierarchy
  ...
  #       Overhead  Data Type / Symbol / Data Type Offset / Symbol Offset
  # ..............  .....................................................
  #
      1.23%         struct cfs_rq
        0.84%         update_blocked_averages
          0.19%         struct cfs_rq +336 (leaf_cfs_rq_list.next)
             0.19%         [k] update_blocked_averages+0x96
          0.19%         struct cfs_rq +0 (load.weight)
             0.14%         [k] update_blocked_averages+0x104
             0.04%         [k] update_blocked_averages+0x31c
          0.17%         struct cfs_rq +404 (throttle_count)
             0.12%         [k] update_blocked_averages+0x9d
             0.05%         [k] update_blocked_averages+0x1f9
          0.08%         struct cfs_rq +272 (propagate)
             0.07%         [k] update_blocked_averages+0x3d3
             0.02%         [k] update_blocked_averages+0x45b
  ...

Signed-off-by: Namhyung Kim <namhyung@kernel.org>
---
 tools/perf/Documentation/perf-report.txt |  1 +
 tools/perf/util/hist.h                   |  1 +
 tools/perf/util/sort.c                   | 47 ++++++++++++++++++++++++
 tools/perf/util/sort.h                   |  1 +
 4 files changed, 50 insertions(+)

Comments

Arnaldo Carvalho de Melo Dec. 23, 2023, 2:29 p.m. UTC | #1 
Em Thu, Nov 09, 2023 at 03:59:42PM -0800, Namhyung Kim escreveu:
> The symoff sort key is to print symbol and offset of sample.  This is
> useful for data type profiling to show exact instruction in the function
> which refers the data.

Cool, perhaps we can add a "symoffexcerpt" that would print a few lines
of assembly/source before and after that offset so that we save having
to go from there to the annotate view, or even jump to the annotate view
when pressing 'A' (annotate) on top of that line in the TUI.

- Arnaldo
 
>   $ perf report -s type,sym,typeoff,symoff --hierarchy
>   ...
>   #       Overhead  Data Type / Symbol / Data Type Offset / Symbol Offset
>   # ..............  .....................................................
>   #
>       1.23%         struct cfs_rq
>         0.84%         update_blocked_averages
>           0.19%         struct cfs_rq +336 (leaf_cfs_rq_list.next)
>              0.19%         [k] update_blocked_averages+0x96
>           0.19%         struct cfs_rq +0 (load.weight)
>              0.14%         [k] update_blocked_averages+0x104
>              0.04%         [k] update_blocked_averages+0x31c
>           0.17%         struct cfs_rq +404 (throttle_count)
>              0.12%         [k] update_blocked_averages+0x9d
>              0.05%         [k] update_blocked_averages+0x1f9
>           0.08%         struct cfs_rq +272 (propagate)
>              0.07%         [k] update_blocked_averages+0x3d3
>              0.02%         [k] update_blocked_averages+0x45b
>   ...
> 
> Signed-off-by: Namhyung Kim <namhyung@kernel.org>
> ---
>  tools/perf/Documentation/perf-report.txt |  1 +
>  tools/perf/util/hist.h                   |  1 +
>  tools/perf/util/sort.c                   | 47 ++++++++++++++++++++++++
>  tools/perf/util/sort.h                   |  1 +
>  4 files changed, 50 insertions(+)
> 
> diff --git a/tools/perf/Documentation/perf-report.txt b/tools/perf/Documentation/perf-report.txt
> index b57eb51b47aa..38f59ac064f7 100644
> --- a/tools/perf/Documentation/perf-report.txt
> +++ b/tools/perf/Documentation/perf-report.txt
> @@ -120,6 +120,7 @@ OPTIONS
>  	- simd: Flags describing a SIMD operation. "e" for empty Arm SVE predicate. "p" for partial Arm SVE predicate
>  	- type: Data type of sample memory access.
>  	- typeoff: Offset in the data type of sample memory access.
> +	- symoff: Offset in the symbol.
>  
>  	By default, comm, dso and symbol keys are used.
>  	(i.e. --sort comm,dso,symbol)
> diff --git a/tools/perf/util/hist.h b/tools/perf/util/hist.h
> index 941176afcebc..1ce0ee262abe 100644
> --- a/tools/perf/util/hist.h
> +++ b/tools/perf/util/hist.h
> @@ -84,6 +84,7 @@ enum hist_column {
>  	HISTC_SIMD,
>  	HISTC_TYPE,
>  	HISTC_TYPE_OFFSET,
> +	HISTC_SYMBOL_OFFSET,
>  	HISTC_NR_COLS, /* Last entry */
>  };
>  
> diff --git a/tools/perf/util/sort.c b/tools/perf/util/sort.c
> index d78e680d3988..0cbbd5ba8175 100644
> --- a/tools/perf/util/sort.c
> +++ b/tools/perf/util/sort.c
> @@ -419,6 +419,52 @@ struct sort_entry sort_sym = {
>  	.se_width_idx	= HISTC_SYMBOL,
>  };
>  
> +/* --sort symoff */
> +
> +static int64_t
> +sort__symoff_cmp(struct hist_entry *left, struct hist_entry *right)
> +{
> +	int64_t ret;
> +
> +	ret = sort__sym_cmp(left, right);
> +	if (ret)
> +		return ret;
> +
> +	return left->ip - right->ip;
> +}
> +
> +static int64_t
> +sort__symoff_sort(struct hist_entry *left, struct hist_entry *right)
> +{
> +	int64_t ret;
> +
> +	ret = sort__sym_sort(left, right);
> +	if (ret)
> +		return ret;
> +
> +	return left->ip - right->ip;
> +}
> +
> +static int
> +hist_entry__symoff_snprintf(struct hist_entry *he, char *bf, size_t size, unsigned int width)
> +{
> +	struct symbol *sym = he->ms.sym;
> +
> +	if (sym == NULL)
> +		return repsep_snprintf(bf, size, "[%c] %-#.*llx", he->level, width - 4, he->ip);
> +
> +	return repsep_snprintf(bf, size, "[%c] %s+0x%llx", he->level, sym->name, he->ip - sym->start);
> +}
> +
> +struct sort_entry sort_sym_offset = {
> +	.se_header	= "Symbol Offset",
> +	.se_cmp		= sort__symoff_cmp,
> +	.se_sort	= sort__symoff_sort,
> +	.se_snprintf	= hist_entry__symoff_snprintf,
> +	.se_filter	= hist_entry__sym_filter,
> +	.se_width_idx	= HISTC_SYMBOL_OFFSET,
> +};
> +
>  /* --sort srcline */
>  
>  char *hist_entry__srcline(struct hist_entry *he)
> @@ -2335,6 +2381,7 @@ static struct sort_dimension common_sort_dimensions[] = {
>  	DIM(SORT_SIMD, "simd", sort_simd),
>  	DIM(SORT_ANNOTATE_DATA_TYPE, "type", sort_type),
>  	DIM(SORT_ANNOTATE_DATA_TYPE_OFFSET, "typeoff", sort_type_offset),
> +	DIM(SORT_SYM_OFFSET, "symoff", sort_sym_offset),
>  };
>  
>  #undef DIM
> diff --git a/tools/perf/util/sort.h b/tools/perf/util/sort.h
> index d806adcc1e1e..6f6b4189a389 100644
> --- a/tools/perf/util/sort.h
> +++ b/tools/perf/util/sort.h
> @@ -249,6 +249,7 @@ enum sort_type {
>  	SORT_SIMD,
>  	SORT_ANNOTATE_DATA_TYPE,
>  	SORT_ANNOTATE_DATA_TYPE_OFFSET,
> +	SORT_SYM_OFFSET,
>  
>  	/* branch stack specific sort keys */
>  	__SORT_BRANCH_STACK,
> -- 
> 2.42.0.869.gea05f2083d-goog
>
diff mbox series

Patch

diff --git a/tools/perf/Documentation/perf-report.txt b/tools/perf/Documentation/perf-report.txt
index b57eb51b47aa..38f59ac064f7 100644
--- a/tools/perf/Documentation/perf-report.txt
+++ b/tools/perf/Documentation/perf-report.txt
@@ -120,6 +120,7 @@  OPTIONS
 	- simd: Flags describing a SIMD operation. "e" for empty Arm SVE predicate. "p" for partial Arm SVE predicate
 	- type: Data type of sample memory access.
 	- typeoff: Offset in the data type of sample memory access.
+	- symoff: Offset in the symbol.
 
 	By default, comm, dso and symbol keys are used.
 	(i.e. --sort comm,dso,symbol)
diff --git a/tools/perf/util/hist.h b/tools/perf/util/hist.h
index 941176afcebc..1ce0ee262abe 100644
--- a/tools/perf/util/hist.h
+++ b/tools/perf/util/hist.h
@@ -84,6 +84,7 @@  enum hist_column {
 	HISTC_SIMD,
 	HISTC_TYPE,
 	HISTC_TYPE_OFFSET,
+	HISTC_SYMBOL_OFFSET,
 	HISTC_NR_COLS, /* Last entry */
 };
 
diff --git a/tools/perf/util/sort.c b/tools/perf/util/sort.c
index d78e680d3988..0cbbd5ba8175 100644
--- a/tools/perf/util/sort.c
+++ b/tools/perf/util/sort.c
@@ -419,6 +419,52 @@  struct sort_entry sort_sym = {
 	.se_width_idx	= HISTC_SYMBOL,
 };
 
+/* --sort symoff */
+
+static int64_t
+sort__symoff_cmp(struct hist_entry *left, struct hist_entry *right)
+{
+	int64_t ret;
+
+	ret = sort__sym_cmp(left, right);
+	if (ret)
+		return ret;
+
+	return left->ip - right->ip;
+}
+
+static int64_t
+sort__symoff_sort(struct hist_entry *left, struct hist_entry *right)
+{
+	int64_t ret;
+
+	ret = sort__sym_sort(left, right);
+	if (ret)
+		return ret;
+
+	return left->ip - right->ip;
+}
+
+static int
+hist_entry__symoff_snprintf(struct hist_entry *he, char *bf, size_t size, unsigned int width)
+{
+	struct symbol *sym = he->ms.sym;
+
+	if (sym == NULL)
+		return repsep_snprintf(bf, size, "[%c] %-#.*llx", he->level, width - 4, he->ip);
+
+	return repsep_snprintf(bf, size, "[%c] %s+0x%llx", he->level, sym->name, he->ip - sym->start);
+}
+
+struct sort_entry sort_sym_offset = {
+	.se_header	= "Symbol Offset",
+	.se_cmp		= sort__symoff_cmp,
+	.se_sort	= sort__symoff_sort,
+	.se_snprintf	= hist_entry__symoff_snprintf,
+	.se_filter	= hist_entry__sym_filter,
+	.se_width_idx	= HISTC_SYMBOL_OFFSET,
+};
+
 /* --sort srcline */
 
 char *hist_entry__srcline(struct hist_entry *he)
@@ -2335,6 +2381,7 @@  static struct sort_dimension common_sort_dimensions[] = {
 	DIM(SORT_SIMD, "simd", sort_simd),
 	DIM(SORT_ANNOTATE_DATA_TYPE, "type", sort_type),
 	DIM(SORT_ANNOTATE_DATA_TYPE_OFFSET, "typeoff", sort_type_offset),
+	DIM(SORT_SYM_OFFSET, "symoff", sort_sym_offset),
 };
 
 #undef DIM
diff --git a/tools/perf/util/sort.h b/tools/perf/util/sort.h
index d806adcc1e1e..6f6b4189a389 100644
--- a/tools/perf/util/sort.h
+++ b/tools/perf/util/sort.h
@@ -249,6 +249,7 @@  enum sort_type {
 	SORT_SIMD,
 	SORT_ANNOTATE_DATA_TYPE,
 	SORT_ANNOTATE_DATA_TYPE_OFFSET,
+	SORT_SYM_OFFSET,
 
 	/* branch stack specific sort keys */
 	__SORT_BRANCH_STACK,