From: Arnaldo Carvalho de Melo <acme@kernel.org>
To: Ingo Molnar <mingo@kernel.org>, Thomas Gleixner <tglx@linutronix.de>
Cc: Jiri Olsa <jolsa@kernel.org>, Namhyung Kim <namhyung@kernel.org>,
Clark Williams <williams@redhat.com>,
linux-kernel@vger.kernel.org, linux-perf-users@vger.kernel.org,
Tzvetomir Stoyanov <tstoyanov@vmware.com>,
Andrew Morton <akpm@linux-foundation.org>,
Jiri Olsa <jolsa@redhat.com>,
linux-trace-devel@vger.kernel.org,
Steven Rostedt <rostedt@goodmis.org>,
Arnaldo Carvalho de Melo <acme@redhat.com>
Subject: [PATCH 08/66] libtraceevent: Man pages for libtraceevent event print related API
Date: Wed, 25 Sep 2019 21:31:46 -0300 [thread overview]
Message-ID: <20190926003244.13962-9-acme@kernel.org> (raw)
In-Reply-To: <20190926003244.13962-1-acme@kernel.org>
From: Tzvetomir Stoyanov <tstoyanov@vmware.com>
Added new man page, describing tep_print_event() libtraceevent API.
Signed-off-by: Tzvetomir Stoyanov <tstoyanov@vmware.com>
Cc: Andrew Morton <akpm@linux-foundation.org>
Cc: Jiri Olsa <jolsa@redhat.com>
Cc: Namhyung Kim <namhyung@kernel.org>
Cc: linux-trace-devel@vger.kernel.org
Link: http://lore.kernel.org/linux-trace-devel/20190801075012.22098-1-tz.stoyanov@gmail.com
Link: http://lore.kernel.org/lkml/20190919212541.553160178@goodmis.org
Signed-off-by: Steven Rostedt (VMware) <rostedt@goodmis.org>
Signed-off-by: Arnaldo Carvalho de Melo <acme@redhat.com>
---
.../libtraceevent-event_print.txt | 130 ++++++++++++++++++
1 file changed, 130 insertions(+)
create mode 100644 tools/lib/traceevent/Documentation/libtraceevent-event_print.txt
diff --git a/tools/lib/traceevent/Documentation/libtraceevent-event_print.txt b/tools/lib/traceevent/Documentation/libtraceevent-event_print.txt
new file mode 100644
index 000000000000..2c6a61811118
--- /dev/null
+++ b/tools/lib/traceevent/Documentation/libtraceevent-event_print.txt
@@ -0,0 +1,130 @@
+libtraceevent(3)
+================
+
+NAME
+----
+tep_print_event - Writes event information into a trace sequence.
+
+SYNOPSIS
+--------
+[verse]
+--
+*#include <event-parse.h>*
+*#include <trace-seq.h>*
+
+void *tep_print_event*(struct tep_handle pass:[*]_tep_, struct trace_seqpass:[*]_s_, struct tep_record pass:[*]_record_, const char pass:[*]_fmt_, _..._)
+--
+
+DESCRIPTION
+-----------
+
+The _tep_print_event()_ function parses the event information of the given
+_record_ and writes it into the trace sequence _s_, according to the format
+string _fmt_. The desired information is specified after the format string.
+The _fmt_ is printf-like format string, following arguments are supported:
+[verse]
+--
+ TEP_PRINT_PID, "%d" - PID of the event.
+ TEP_PRINT_CPU, "%d" - Event CPU.
+ TEP_PRINT_COMM, "%s" - Event command string.
+ TEP_PRINT_NAME, "%s" - Event name.
+ TEP_PRINT_LATENCY, "%s" - Latency of the event. It prints 4 or more
+ fields - interrupt state, scheduling state,
+ current context, and preemption count.
+ Field 1 is the interrupt enabled state:
+ d : Interrupts are disabled
+ . : Interrupts are enabled
+ X : The architecture does not support this
+ information
+ Field 2 is the "need resched" state.
+ N : The task is set to call the scheduler when
+ possible, as another higher priority task
+ may need to be scheduled in.
+ . : The task is not set to call the scheduler.
+ Field 3 is the context state.
+ . : Normal context
+ s : Soft interrupt context
+ h : Hard interrupt context
+ H : Hard interrupt context which triggered
+ during soft interrupt context.
+ z : NMI context
+ Z : NMI context which triggered during hard
+ interrupt context
+ Field 4 is the preemption count.
+ . : The preempt count is zero.
+ On preemptible kernels (where the task can be scheduled
+ out in arbitrary locations while in kernel context), the
+ preempt count, when non zero, will prevent the kernel
+ from scheduling out the current task. The preempt count
+ number is displayed when it is not zero.
+ Depending on the kernel, it may show other fields
+ (lock depth, or migration disabled, which are unique to
+ specialized kernels).
+ TEP_PRINT_TIME, %d - event time stamp. A divisor and precision can be
+ specified as part of this format string:
+ "%precision.divisord". Example:
+ "%3.1000d" - divide the time by 1000 and print the first
+ 3 digits before the dot. Thus, the time stamp
+ "123456000" will be printed as "123.456"
+ TEP_PRINT_INFO, "%s" - event information.
+ TEP_PRINT_INFO_RAW, "%s" - event information, in raw format.
+
+--
+EXAMPLE
+-------
+[source,c]
+--
+#include <event-parse.h>
+#include <trace-seq.h>
+...
+struct trace_seq seq;
+trace_seq_init(&seq);
+struct tep_handle *tep = tep_alloc();
+...
+void print_my_event(struct tep_record *record)
+{
+ trace_seq_reset(&seq);
+ tep_print_event(tep, s, record, "%16s-%-5d [%03d] %s %6.1000d %s %s",
+ TEP_PRINT_COMM, TEP_PRINT_PID, TEP_PRINT_CPU,
+ TEP_PRINT_LATENCY, TEP_PRINT_TIME, TEP_PRINT_NAME,
+ TEP_PRINT_INFO);
+}
+...
+--
+
+FILES
+-----
+[verse]
+--
+*event-parse.h*
+ Header file to include in order to have access to the library APIs.
+*trace-seq.h*
+ Header file to include in order to have access to trace sequences related APIs.
+ Trace sequences are used to allow a function to call several other functions
+ to create a string of data to use.
+*-ltraceevent*
+ Linker switch to add when building a program that uses the library.
+--
+
+SEE ALSO
+--------
+_libtraceevent(3)_, _trace-cmd(1)_
+
+AUTHOR
+------
+[verse]
+--
+*Steven Rostedt* <rostedt@goodmis.org>, author of *libtraceevent*.
+*Tzvetomir Stoyanov* <tz.stoyanov@gmail.com>, author of this man page.
+--
+REPORTING BUGS
+--------------
+Report bugs to <linux-trace-devel@vger.kernel.org>
+
+LICENSE
+-------
+libtraceevent is Free Software licensed under the GNU LGPL 2.1
+
+RESOURCES
+---------
+https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
--
2.21.0
next prev parent reply other threads:[~2019-09-26 0:33 UTC|newest]
Thread overview: 70+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-09-26 0:31 [GIT PULL] perf/core improvements and fixes Arnaldo Carvalho de Melo
2019-09-26 0:31 ` [PATCH 01/66] perf record: Fix priv level with branch sampling for paranoid=2 Arnaldo Carvalho de Melo
2019-09-26 0:31 ` [PATCH 02/66] perf record: Move restricted maps check to after a possible fallback to not collect kernel samples Arnaldo Carvalho de Melo
2019-09-26 0:31 ` [PATCH 03/66] perf vendor events amd: Add L3 cache events for Family 17h Arnaldo Carvalho de Melo
2019-09-26 0:31 ` [PATCH 04/66] perf vendor events amd: Remove redundant '[' Arnaldo Carvalho de Melo
2019-09-26 0:31 ` [PATCH 05/66] perf vendor events: Minor fixes to the README Arnaldo Carvalho de Melo
2019-09-26 0:31 ` [PATCH 06/66] perf list: Allow plurals for metric, metricgroup Arnaldo Carvalho de Melo
2019-09-26 0:31 ` [PATCH 07/66] libtraceevent: Round up in tep_print_event() time precision Arnaldo Carvalho de Melo
2019-09-26 0:31 ` Arnaldo Carvalho de Melo [this message]
2019-09-26 0:31 ` [PATCH 09/66] libtraceevent: Man pages fix, rename tep_ref_get() to tep_get_ref() Arnaldo Carvalho de Melo
2019-09-26 0:31 ` [PATCH 10/66] libtraceevent: Man pages fix, changes in event printing APIs Arnaldo Carvalho de Melo
2019-09-26 0:31 ` [PATCH 11/66] libtraceevent: Add tep_get_event() in event-parse.h Arnaldo Carvalho de Melo
2019-09-26 0:31 ` [PATCH 12/66] libtraceevent: Move traceevent plugins in its own subdirectory Arnaldo Carvalho de Melo
2019-09-26 0:31 ` [PATCH 13/66] libtraceevent: Man pages for tep plugins APIs Arnaldo Carvalho de Melo
2019-09-26 0:31 ` [PATCH 14/66] tools: Add missing stdio.h include to asm/bug.h header Arnaldo Carvalho de Melo
2019-09-26 0:31 ` [PATCH 15/66] perf tools: Rename 'struct perf_mmap' to 'struct mmap' Arnaldo Carvalho de Melo
2019-09-26 0:31 ` [PATCH 16/66] perf tools: Rename perf_evlist__mmap() to evlist__mmap() Arnaldo Carvalho de Melo
2019-09-26 0:31 ` [PATCH 17/66] perf tools: Rename perf_evlist__munmap() to evlist__munmap() Arnaldo Carvalho de Melo
2019-09-26 0:31 ` [PATCH 18/66] perf tools: Rename perf_evlist__alloc_mmap() to evlist__alloc_mmap() Arnaldo Carvalho de Melo
2019-09-26 0:31 ` [PATCH 19/66] perf tools: Rename perf_evlist__exit() to evlist__exit() Arnaldo Carvalho de Melo
2019-09-26 0:31 ` [PATCH 20/66] perf tools: Rename perf_evlist__purge() to evlist__purge() Arnaldo Carvalho de Melo
2019-09-26 0:31 ` [PATCH 21/66] libperf: Link libapi.a in libperf.so Arnaldo Carvalho de Melo
2019-09-26 0:32 ` [PATCH 22/66] perf evlist: Adopt backwards ring buffer state enum Arnaldo Carvalho de Melo
2019-09-26 0:32 ` [PATCH 23/66] libperf: Add perf_mmap struct Arnaldo Carvalho de Melo
2019-09-26 0:32 ` [PATCH 24/66] libperf: Add 'mask' to struct perf_mmap Arnaldo Carvalho de Melo
2019-09-26 0:32 ` [PATCH 25/66] libperf: Add 'fd' " Arnaldo Carvalho de Melo
2019-09-26 0:32 ` [PATCH 26/66] libperf: Add 'cpu' " Arnaldo Carvalho de Melo
2019-09-26 0:32 ` [PATCH 27/66] libperf: Add 'refcnt' " Arnaldo Carvalho de Melo
2019-09-26 0:32 ` [PATCH 28/66] libperf: Add prev/start/end " Arnaldo Carvalho de Melo
2019-09-26 0:32 ` [PATCH 29/66] libperf: Add 'overwrite' to 'struct perf_mmap' Arnaldo Carvalho de Melo
2019-09-26 0:32 ` [PATCH 30/66] libperf: Add 'event_copy' " Arnaldo Carvalho de Melo
2019-09-26 0:32 ` [PATCH 31/66] libperf: Add 'flush' " Arnaldo Carvalho de Melo
2019-09-26 0:32 ` [PATCH 32/66] libperf: Move 'system_wide' from 'struct evsel' to 'struct perf_evsel' Arnaldo Carvalho de Melo
2019-09-26 0:32 ` [PATCH 33/66] libperf: Move 'nr_mmaps' from 'struct evlist' to 'struct perf_evlist' Arnaldo Carvalho de Melo
2019-09-26 0:32 ` [PATCH 34/66] libperf: Move 'mmap_len' " Arnaldo Carvalho de Melo
2019-09-26 0:32 ` [PATCH 35/66] libperf: Move 'pollfd' " Arnaldo Carvalho de Melo
2019-09-26 0:32 ` [PATCH 36/66] libperf: Add missing 'struct xyarray' forward declaration Arnaldo Carvalho de Melo
2019-09-26 0:32 ` [PATCH 37/66] libperf: Move 'sample_id' from 'struct evsel' to 'struct perf_evsel' Arnaldo Carvalho de Melo
2019-09-26 0:32 ` [PATCH 38/66] libperf: Move 'id' " Arnaldo Carvalho de Melo
2019-09-26 0:32 ` [PATCH 39/66] libperf: Move 'ids' " Arnaldo Carvalho de Melo
2019-09-26 0:32 ` [PATCH 40/66] libperf: Move 'heads' from 'struct evlist' to 'struct perf_evlist' Arnaldo Carvalho de Melo
2019-09-26 0:32 ` [PATCH 41/66] libperf: Add perf_evsel__alloc_id/perf_evsel__free_id functions Arnaldo Carvalho de Melo
2019-09-26 0:32 ` [PATCH 42/66] libperf: Add perf_evlist__first()/last() functions Arnaldo Carvalho de Melo
2019-09-26 0:32 ` [PATCH 43/66] libperf: Add perf_evlist__read_format() function Arnaldo Carvalho de Melo
2019-09-26 0:32 ` [PATCH 44/66] libperf: Add perf_evlist__id_add() function Arnaldo Carvalho de Melo
2019-09-26 0:32 ` [PATCH 45/66] libperf: Add perf_evlist__id_add_fd() function Arnaldo Carvalho de Melo
2019-09-26 0:32 ` [PATCH 46/66] libperf: Move 'page_size' global variable to libperf Arnaldo Carvalho de Melo
2019-09-26 0:32 ` [PATCH 47/66] perf tools: No need to include internal/lib.h from util/util.h Arnaldo Carvalho de Melo
2019-09-26 0:32 ` [PATCH 48/66] libperf: Use sys/types.h to get ssize_t, not unistd.h Arnaldo Carvalho de Melo
2019-09-26 0:32 ` [PATCH 49/66] libperf: Add libperf dependency for tests targets Arnaldo Carvalho de Melo
2019-09-26 0:32 ` [PATCH 50/66] libperf: Merge libperf_set_print() into libperf_init() Arnaldo Carvalho de Melo
2019-09-26 0:32 ` [PATCH 51/66] libperf: Add libperf_init() call to the tests Arnaldo Carvalho de Melo
2019-09-26 0:32 ` [PATCH 52/66] libperf: Add perf_evlist__alloc_pollfd() function Arnaldo Carvalho de Melo
2019-09-26 0:32 ` [PATCH 53/66] libperf: Add perf_evlist__add_pollfd() function Arnaldo Carvalho de Melo
2019-09-26 0:32 ` [PATCH 54/66] libperf: Add perf_evlist__poll() function Arnaldo Carvalho de Melo
2019-09-26 0:32 ` [PATCH 55/66] perf copyfile: Move copyfile routines to separate files Arnaldo Carvalho de Melo
2019-09-26 0:32 ` [PATCH 56/66] perf evsel: Remove need for symbol_conf in evsel_fprintf.c Arnaldo Carvalho de Melo
2019-09-26 0:32 ` [PATCH 57/66] perf evsel: Introduce evsel_fprintf.h Arnaldo Carvalho de Melo
2019-09-26 11:15 ` Jiri Olsa
2019-09-26 15:06 ` Arnaldo Carvalho de Melo
2019-09-26 0:32 ` [PATCH 58/66] perf evlist: Remove unused perf_evlist__fprintf() method Arnaldo Carvalho de Melo
2019-09-26 0:32 ` [PATCH 59/66] perf evsel: Move config terms to a separate header Arnaldo Carvalho de Melo
2019-09-26 0:32 ` [PATCH 60/66] perf tools: Replace needless mmap.h with what is needed, event.h Arnaldo Carvalho de Melo
2019-09-26 0:32 ` [PATCH 61/66] perf stat: Fix free memory access / memory leaks in metrics Arnaldo Carvalho de Melo
2019-09-26 0:32 ` [PATCH 62/66] perf evlist: Fix access of freed id arrays Arnaldo Carvalho de Melo
2019-09-26 0:32 ` [PATCH 63/66] perf vendor events: Remove P8 HW events which are not supported Arnaldo Carvalho de Melo
2019-09-26 0:32 ` [PATCH 64/66] perf jvmti: Include JVMTI support for s390 Arnaldo Carvalho de Melo
2019-09-26 0:32 ` [PATCH 65/66] perf build: Add detection of java-11-openjdk-devel package Arnaldo Carvalho de Melo
2019-09-26 0:32 ` [PATCH 66/66] perf parser: Remove needless include directives Arnaldo Carvalho de Melo
2019-09-26 5:55 ` [GIT PULL] perf/core improvements and fixes Ingo Molnar
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20190926003244.13962-9-acme@kernel.org \
--to=acme@kernel.org \
--cc=acme@redhat.com \
--cc=akpm@linux-foundation.org \
--cc=jolsa@kernel.org \
--cc=jolsa@redhat.com \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-perf-users@vger.kernel.org \
--cc=linux-trace-devel@vger.kernel.org \
--cc=mingo@kernel.org \
--cc=namhyung@kernel.org \
--cc=rostedt@goodmis.org \
--cc=tglx@linutronix.de \
--cc=tstoyanov@vmware.com \
--cc=williams@redhat.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).