'\" t
.\" Title: libtraceevent
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets vsnapshot
.\" Date: 01/14/2024
.\" Manual: libtraceevent Manual
.\" Source: libtraceevent 1.8.2
.\" Language: English
.\"
.TH "LIBTRACEEVENT" "3" "01/14/2024" "libtraceevent 1\&.8\&.2" "libtraceevent Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
tep_print_event \- Writes event information into a trace sequence\&.
.SH "SYNOPSIS"
.sp
.nf
\fB#include \fR
\fB#include \fR
void \fBtep_print_event\fR(struct tep_handle *\fItep\fR, struct trace_seq*\fIs\fR, struct tep_record *\fIrecord\fR, const char *\fIfmt\fR, \fI\&...\fR)
.fi
.SH "DESCRIPTION"
.sp
The \fBtep_print_event()\fR function parses the event information of the given \fIrecord\fR and writes it into the trace sequence \fIs\fR, according to the format string \fIfmt\fR\&. The desired information is specified after the format string\&. The \fIfmt\fR is printf\-like format string, following arguments are supported:
.sp
.if n \{\
.RS 4
.\}
.nf
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\&.
.fi
.if n \{\
.RE
.\}
.SH "EXAMPLE"
.sp
.if n \{\
.RS 4
.\}
.nf
#include
#include
\&.\&.\&.
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);
}
\&.\&.\&.
.fi
.if n \{\
.RE
.\}
.SH "FILES"
.sp
.if n \{\
.RS 4
.\}
.nf
\fBevent\-parse\&.h\fR
Header file to include in order to have access to the library APIs\&.
\fBtrace\-seq\&.h\fR
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\&.
\fB\-ltraceevent\fR
Linker switch to add when building a program that uses the library\&.
.fi
.if n \{\
.RE
.\}
.SH "SEE ALSO"
.sp
\fBlibtraceevent\fR(3), \fBtrace\-cmd\fR(1)
.SH "AUTHOR"
.sp
.if n \{\
.RS 4
.\}
.nf
\fBSteven Rostedt\fR <\m[blue]\fBrostedt@goodmis\&.org\fR\m[]\&\s-2\u[1]\d\s+2>, author of \fBlibtraceevent\fR\&.
\fBTzvetomir Stoyanov\fR <\m[blue]\fBtz\&.stoyanov@gmail\&.com\fR\m[]\&\s-2\u[2]\d\s+2>, author of this man page\&.
.fi
.if n \{\
.RE
.\}
.SH "REPORTING BUGS"
.sp
Report bugs to <\m[blue]\fBlinux\-trace\-devel@vger\&.kernel\&.org\fR\m[]\&\s-2\u[3]\d\s+2>
.SH "LICENSE"
.sp
libtraceevent is Free Software licensed under the GNU LGPL 2\&.1
.SH "RESOURCES"
.sp
\m[blue]\fBhttps://git\&.kernel\&.org/pub/scm/libs/libtrace/libtraceevent\&.git/\fR\m[]
.SH "NOTES"
.IP " 1." 4
rostedt@goodmis.org
.RS 4
\%mailto:rostedt@goodmis.org
.RE
.IP " 2." 4
tz.stoyanov@gmail.com
.RS 4
\%mailto:tz.stoyanov@gmail.com
.RE
.IP " 3." 4
linux-trace-devel@vger.kernel.org
.RS 4
\%mailto:linux-trace-devel@vger.kernel.org
.RE