Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit edbe9817 authored by Jiri Olsa's avatar Jiri Olsa Committed by Arnaldo Carvalho de Melo
Browse files

perf data: Add perf data to CTF conversion support 

Adding 'perf data convert' to convert perf data file into different
format. This patch adds support for CTF format conversion.

To convert perf.data into CTF run:
  $ perf data convert --to-ctf=./ctf-data/
  [ perf data convert: Converted 'perf.data' into CTF data './ctf-data/' ]
  [ perf data convert: Converted and wrote 11.268 MB (100230 samples) ]

The command will create CTF metadata out of perf.data file (or one
specified via -i option) and then convert all sample events into single
CTF stream.

Each sample_type bit is translated into separated CTF event field apart
from following exceptions:

  PERF_SAMPLE_RAW          - added in next patch
  PERF_SAMPLE_READ         - TODO
  PERF_SAMPLE_CALLCHAIN    - TODO
  PERF_SAMPLE_BRANCH_STACK - TODO
  PERF_SAMPLE_REGS_USER    - TODO
  PERF_SAMPLE_STACK_USER   - TODO

  $ perf --debug=data-convert=2 data convert ...

The converted CTF data could be analyzed by CTF tools, like babletrace
or tracecompass [1].

  $ babeltrace ./ctf-data/
  [03:19:13.962125533] (+?.?????????) cycles: { }, { ip = 0xFFFFFFFF8105443A, tid = 20714, pid = 20714, period = 1 }
  [03:19:13.962130001] (+0.000004468) cycles: { }, { ip = 0xFFFFFFFF8105443A, tid = 20714, pid = 20714, period = 1 }
  [03:19:13.962131936] (+0.000001935) cycles: { }, { ip = 0xFFFFFFFF8105443A, tid = 20714, pid = 20714, period = 8 }
  [03:19:13.962133732] (+0.000001796) cycles: { }, { ip = 0xFFFFFFFF8105443A, tid = 20714, pid = 20714, period = 114 }
  [03:19:13.962135557] (+0.000001825) cycles: { }, { ip = 0xFFFFFFFF8105443A, tid = 20714, pid = 20714, period = 2087 }
  [03:19:13.962137627] (+0.000002070) cycles: { }, { ip = 0xFFFFFFFF81361938, tid = 20714, pid = 20714, period = 37582 }
  [03:19:13.962161091] (+0.000023464) cycles: { }, { ip = 0xFFFFFFFF8124218F, tid = 20714, pid = 20714, period = 600246 }
  [03:19:13.962517569] (+0.000356478) cycles: { }, { ip = 0xFFFFFFFF811A75DB, tid = 20714, pid = 20714, period = 1325731 }
  [03:19:13.969518008] (+0.007000439) cycles: { }, { ip = 0x34080917B2, tid = 20714, pid = 20714, period = 1144298 }

The following members to the ctf-environment were decided to be added to
distinguish and specify perf CTF data:

  - domain

    It says "kernel" because it contains a kernel trace (not to be
    confused with a user space like lttng-ust does)

  - tracer_name

    It says perf. This can be used to distinguish between lttng and perf
    CTF based trace.

  - version

    The kernel version from stream. In addition to release, this is what
    it looks like on a Debian kernel:

      release = "3.14-1-amd64";
      version = "3.14.0";

[1] http://projects.eclipse.org/projects/tools.tracecompass



Signed-off-by: default avatarJiri Olsa <jolsa@kernel.org>
Acked-by: default avatarNamhyung Kim <namhyung@kernel.org>
Reviewed-by: default avatarDavid Ahern <dsahern@gmail.com>
Tested-by: default avatarArnaldo Carvalho de Melo <acme@redhat.com>
Cc: Frederic Weisbecker <fweisbec@gmail.com>
Cc: Jeremie Galarneau <jgalar@efficios.com>
Cc: Paul Mackerras <paulus@samba.org>
Cc: Peter Zijlstra <peterz@infradead.org>
Cc: Sebastian Andrzej Siewior <bigeasy@linutronix.de>
Cc: Tom Zanussi <tzanussi@gmail.com>
Cc: Wang Nan <wangnan0@huawei.com>
Link: http://lkml.kernel.org/r/1424470628-5969-4-git-send-email-jolsa@kernel.org


Signed-off-by: default avatarSebastian Andrzej Siewior <bigeasy@linutronix.de>
Signed-off-by: default avatarArnaldo Carvalho de Melo <acme@redhat.com>
parent 2245bf14

tools/perf/Documentation/perf-data.txt

+25 −0
Original line number Diff line number Diff line
@@ -13,3 +13,28 @@ SYNOPSIS 
DESCRIPTION

-----------

Data file related processing.



COMMANDS

--------

convert::

	Converts perf data file into another format (only CTF [1] format is support by now).

	It's possible to set data-convert debug variable to get debug messages from conversion,

	like:

	  perf --debug data-convert data convert ...



OPTIONS for 'convert'

---------------------

--to-ctf::

	Triggers the CTF conversion, specify the path of CTF data directory.



-i::

	Specify input perf data file path.



-v::

--verbose::

        Be more verbose (show counter open errors, etc).



SEE ALSO

--------

linkperf:perf[1]

[1] Common Trace Format - http://www.efficios.com/ctf

tools/perf/Documentation/perf.txt

+6 −1
Original line number Diff line number Diff line
@@ -13,11 +13,16 @@ SYNOPSIS 
OPTIONS

-------

--debug::

	Setup debug variable (just verbose for now) in value

	Setup debug variable (see list below) in value

	range (0, 10). Use like:

	  --debug verbose   # sets verbose = 1

	  --debug verbose=2 # sets verbose = 2



	List of debug variables allowed to set:

	  verbose          - general debug messages

	  ordered-events   - ordered events object debug messages

	  data-convert     - data convert command debug messages



--buildid-dir::

	Setup buildid cache directory. It has higher priority than

	buildid.dir config file option.

tools/perf/builtin-data.c

+44 −0
Original line number Diff line number Diff line
@@ -3,6 +3,7 @@ 
#include "perf.h"

#include "debug.h"

#include "parse-options.h"

#include "data-convert-bt.h"



typedef int (*data_cmd_fn_t)(int argc, const char **argv, const char *prefix);
@@ -41,7 +42,50 @@ static void print_usage(void) 
	printf("\n");

}



static const char * const data_convert_usage[] = {

	"perf data convert [<options>]",

	NULL

};



static int cmd_data_convert(int argc, const char **argv,

			    const char *prefix __maybe_unused)

{

	const char *to_ctf     = NULL;

	const struct option options[] = {

		OPT_INCR('v', "verbose", &verbose, "be more verbose"),

		OPT_STRING('i', "input", &input_name, "file", "input file name"),

#ifdef HAVE_LIBBABELTRACE_SUPPORT

		OPT_STRING(0, "to-ctf", &to_ctf, NULL, "Convert to CTF format"),

#endif

		OPT_END()

	};



#ifndef HAVE_LIBBABELTRACE_SUPPORT

	pr_err("No conversion support compiled in.\n");

	return -1;

#endif



	argc = parse_options(argc, argv, options,

			     data_convert_usage, 0);

	if (argc) {

		usage_with_options(data_convert_usage, options);

		return -1;

	}



	if (to_ctf) {

#ifdef HAVE_LIBBABELTRACE_SUPPORT

		return bt_convert__perf2ctf(input_name, to_ctf);

#else

		pr_err("The libbabeltrace support is not compiled in.\n");

		return -1;

#endif

	}



	return 0;

}



static struct data_cmd data_cmds[] = {

	{ "convert", "converts data file between formats", cmd_data_convert },

	{ NULL },

};

tools/perf/config/Makefile

+1 −0
Original line number Diff line number Diff line
@@ -713,6 +713,7 @@ ifndef NO_LIBBABELTRACE 
    CFLAGS += -DHAVE_LIBBABELTRACE_SUPPORT $(LIBBABELTRACE_CFLAGS)

    LDFLAGS += $(LIBBABELTRACE_LDFLAGS)

    EXTLIBS += -lbabeltrace-ctf

    $(call detected,CONFIG_LIBBABELTRACE)

  endif

endif

tools/perf/util/Build

+2 −0
Original line number Diff line number Diff line
@@ -88,6 +88,8 @@ libperf-$(CONFIG_DWARF) += dwarf-aux.o 
libperf-$(CONFIG_LIBDW_DWARF_UNWIND) += unwind-libdw.o

libperf-$(CONFIG_LIBUNWIND)          += unwind-libunwind.o



libperf-$(CONFIG_LIBBABELTRACE) += data-convert-bt.o



libperf-y += scripting-engines/



libperf-$(CONFIG_PERF_REGS) += perf_regs.o