tep_parse_event(3) — Linux manual page

NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | EXAMPLE | FILES | SEE ALSO | AUTHOR | REPORTING BUGS | LICENSE | RESOURCES | NOTES | COLOPHON

LIBTRACEEVENT(3)          libtraceevent Manual          LIBTRACEEVENT(3)

NAME         top

       tep_parse_event, tep_parse_format - Parse the event format
       information

SYNOPSIS         top

       #include <event-parse.h>

       enum tep_errno tep_parse_event(struct tep_handle *tep, const char *buf, unsigned long size, const char *sys);
       enum tep_errno tep_parse_format(struct tep_handle *tep, struct tep_event **eventp, const char *buf, unsigned long size, const char *sys);

DESCRIPTION         top

       The tep_parse_event() function parses the event format and
       creates an event structure to quickly parse raw data for a given
       event. The tep argument is the trace event parser context. The
       created event structure is stored in the tep context. The buf
       argument is a buffer with size, where the event format data is.
       The event format data can be taken from
       tracefs/events/.../.../format files. The sys argument is the
       system of the event.

       The tep_parse_format() function does the same as
       tep_parse_event(). The only difference is in the extra eventp
       argument, where the newly created event structure is returned.

RETURN VALUE         top

       Both tep_parse_event() and tep_parse_format() functions return 0
       on success, or TEP_ERRNO__... in case of an error.

EXAMPLE         top

           #include <event-parse.h>
           ...
           struct tep_handle *tep = tep_alloc();
           ...
           char *buf;
           int size;
           struct tep_event *event = NULL;
           buf = read_file("/sys/kernel/tracing/events/ftrace/print/format", &size);
           if (tep_parse_event(tep, buf, size, "ftrace") != 0) {
                   /* Failed to parse the ftrace print format */
           }

           if (tep_parse_format(tep, &event, buf, size, "ftrace") != 0) {
                   /* Failed to parse the ftrace print format */
           }
           ...

FILES         top

           event-parse.h
                   Header file to include in order to have access to the library APIs.
           -ltraceevent
                   Linker switch to add when building a program that uses the library.

SEE ALSO         top

       libtraceevent(3), trace-cmd(1)

AUTHOR         top

           Steven Rostedt <[email protected][1]>, author of libtraceevent.
           Tzvetomir Stoyanov <[email protected][2]>, author of this man page.

REPORTING BUGS         top

       Report bugs to <[email protected][3]>

LICENSE         top

       libtraceevent is Free Software licensed under the GNU LGPL 2.1

RESOURCES         top

       https://git.kernel.org/pub/scm/libs/libtrace/libtraceevent.git/ 

NOTES         top

        1. [email protected]
           mailto:[email protected]

        2. [email protected]
           mailto:[email protected]

        3. [email protected]
           mailto:[email protected]

COLOPHON         top

       This page is part of the libtraceevent (Linux kernel trace event
       library) project.  Information about the project can be found at
       ⟨https://www.trace-cmd.org/⟩.  If you have a bug report for this
       manual page, see ⟨https://www.trace-cmd.org/⟩.  This page was
       obtained from the project's upstream Git repository
       ⟨https://git.kernel.org/pub/scm/libs/libtrace/libtraceevent.git⟩
       on 2024-06-14.  (At that time, the date of the most recent commit
       that was found in the repository was 2024-05-17.)  If you
       discover any rendering problems in this HTML version of the page,
       or you believe there is a better or more up-to-date source for
       the page, or you have corrections or improvements to the
       information in this COLOPHON (which is not part of the original
       manual page), send a mail to [email protected]

libtraceevent 1.7.3            09/24/2023               LIBTRACEEVENT(3)