Commit 14cbfbeb authored by Namhyung Kim's avatar Namhyung Kim Committed by Arnaldo Carvalho de Melo
Browse files

perf report: Show random usage tip on the help line 



Currently perf report only shows a help message "For a higher level
overview, try: perf report --sort comm,dso" unconditionally (even if
the sort keys were used).  Add more help tips and show randomly.

Load tips from ${prefix}/share/doc/perf-tip/tips.txt file.

  $ perf report | tail
      0.10%  swapper  [kernel.vmlinux]   [k] irq_exit
      0.09%  swapper  [kernel.vmlinux]   [k] flush_smp_call_function_queue
      0.08%  swapper  [kernel.vmlinux]   [k] native_write_msr_safe
      0.03%  swapper  [kernel.vmlinux]   [k] group_sched_in
      0.01%  perf     [kernel.vmlinux]   [k] native_write_msr_safe

  #
  # (Tip: Search options using a keyword: perf report -h <keyword>)
  #

Signed-off-by: default avatarNamhyung Kim <namhyung@kernel.org>
Acked-by: default avatarIngo Molnar <mingo@kernel.org>
Cc: Andi Kleen <andi@firstfloor.org>
Cc: David Ahern <dsahern@gmail.com>
Cc: Jiri Olsa <jolsa@kernel.org>
Cc: Masami Hiramatsu <masami.hiramatsu.pt@hitachi.com>
Cc: Peter Zijlstra <peterz@infradead.org>
Cc: Stephane Eranian <eranian@google.com>
Cc: Wang Nan <wangnan0@huawei.com>
Link: http://lkml.kernel.org/r/1452166913-27046-1-git-send-email-namhyung@kernel.org


[ Renamed it to perf_tip() and the parameter dirname to dirpath to fix the build on older distros ]
Signed-off-by: default avatarArnaldo Carvalho de Melo <acme@redhat.com>
parent fc284be9

tools/perf/Build

+1 −0
Original line number Diff line number Diff line
@@ -41,6 +41,7 @@ CFLAGS_perf.o += -DPERF_HTML_PATH="BUILD_STR($(htmldir_SQ))" \ 
			      -DPREFIX="BUILD_STR($(prefix_SQ))"		\

			      -include $(OUTPUT)PERF-VERSION-FILE

CFLAGS_builtin-trace.o	   += -DSTRACE_GROUPS_DIR="BUILD_STR($(STRACE_GROUPS_DIR_SQ))"

CFLAGS_builtin-report.o	   += -DTIPDIR="BUILD_STR($(tipdir_SQ))"



libperf-y += util/

libperf-y += arch/

tools/perf/Documentation/tips.txt

0 → 100644
+14 −0
Original line number Diff line number Diff line 
For a higher level overview, try: perf report --sort comm,dso

Sample related events with: perf record -e '{cycles,instructions}:S'

Compare performance results with: perf diff [<old file> <new file>]

Boolean options have negative forms, e.g.: perf report --no-children

Customize output of perf script with: perf script -F event,ip,sym

Generate a script for your data: perf script -g <lang>

Save output of perf stat using: perf stat record <target workload>

Create an archive with symtabs to analyse on other machine: perf archive

Search options using a keyword: perf report -h <keyword>

Use parent filter to see specific call path: perf report -p <regex>

List events using substring match: perf list <keyword>

To see list of saved events and attributes: perf evlist -v

Use --symfs <dir> if your symbol files are in non-standard locations

To see callchains in a more compact form: perf report -g folded

tools/perf/Makefile.perf

+3 −0
Original line number Diff line number Diff line
@@ -567,6 +567,9 @@ endif 
	$(call QUIET_INSTALL, perf_completion-script) \

		$(INSTALL) -d -m 755 '$(DESTDIR_SQ)$(sysconfdir_SQ)/bash_completion.d'; \

		$(INSTALL) perf-completion.sh '$(DESTDIR_SQ)$(sysconfdir_SQ)/bash_completion.d/perf'

	$(call QUIET_INSTALL, perf-tip) \

		$(INSTALL) -d -m 755 '$(DESTDIR_SQ)$(tip_instdir_SQ)'; \

		$(INSTALL) Documentation/tips.txt -t '$(DESTDIR_SQ)$(tip_instdir_SQ)'



install-tests: all install-gtk

	$(call QUIET_INSTALL, tests) \

tools/perf/builtin-report.c

+1 −1
Original line number Diff line number Diff line
@@ -433,7 +433,7 @@ static int report__browse_hists(struct report *rep) 
	int ret;

	struct perf_session *session = rep->session;

	struct perf_evlist *evlist = session->evlist;

	const char *help = "For a higher level overview, try: perf report --sort comm,dso";

	const char *help = perf_tip(TIPDIR);



	switch (use_browser) {

	case 1:

tools/perf/config/Makefile

+6 −0
Original line number Diff line number Diff line
@@ -691,6 +691,7 @@ sharedir = $(prefix)/share 
template_dir = share/perf-core/templates

STRACE_GROUPS_DIR = share/perf-core/strace/groups

htmldir = share/doc/perf-doc

tipdir = share/doc/perf-tip

ifeq ($(prefix),/usr)

sysconfdir = /etc

ETC_PERFCONFIG = $(sysconfdir)/perfconfig
@@ -717,6 +718,7 @@ infodir_SQ = $(subst ','\'',$(infodir)) 
perfexecdir_SQ = $(subst ','\'',$(perfexecdir))

template_dir_SQ = $(subst ','\'',$(template_dir))

htmldir_SQ = $(subst ','\'',$(htmldir))

tipdir_SQ = $(subst ','\'',$(tipdir))

prefix_SQ = $(subst ','\'',$(prefix))

sysconfdir_SQ = $(subst ','\'',$(sysconfdir))

libdir_SQ = $(subst ','\'',$(libdir))
@@ -724,12 +726,15 @@ libdir_SQ = $(subst ','\'',$(libdir)) 
ifneq ($(filter /%,$(firstword $(perfexecdir))),)

perfexec_instdir = $(perfexecdir)

STRACE_GROUPS_INSTDIR = $(STRACE_GROUPS_DIR)

tip_instdir = $(tipdir)

else

perfexec_instdir = $(prefix)/$(perfexecdir)

STRACE_GROUPS_INSTDIR = $(prefix)/$(STRACE_GROUPS_DIR)

tip_instdir = $(prefix)/$(tipdir)

endif

perfexec_instdir_SQ = $(subst ','\'',$(perfexec_instdir))

STRACE_GROUPS_INSTDIR_SQ = $(subst ','\'',$(STRACE_GROUPS_INSTDIR))

tip_instdir_SQ = $(subst ','\'',$(tip_instdir))



# If we install to $(HOME) we keep the traceevent default:

# $(HOME)/.traceevent/plugins
@@ -770,6 +775,7 @@ $(call detected_var,ETC_PERFCONFIG_SQ) 
$(call detected_var,STRACE_GROUPS_DIR_SQ)

$(call detected_var,prefix_SQ)

$(call detected_var,perfexecdir_SQ)

$(call detected_var,tipdir_SQ)

$(call detected_var,LIBDIR)

$(call detected_var,GTK_CFLAGS)

$(call detected_var,PERL_EMBED_CCOPTS)

CRA Git | Maintained and supported by SUSTech CRA and CCSE