tep_parse_header_page(3) — Linux manual page

LIBTRACEEVENT(3)          libtraceevent Manual          LIBTRACEEVENT(3)

NAME

       tep_parse_header_page - Parses the data stored in the header
       page.

SYNOPSIS

       #include <event-parse.h>

       int tep_parse_header_page(struct tep_handle *tep, char *buf, unsigned long size, int long_size);

DESCRIPTION

       The tep_parse_header_page() function parses the header page data
       from buf, and initializes the tep, trace event parser context,
       with it. The buffer buf is with size, and is supposed to be
       copied from tracefs/events/header_page.

       Some old kernels do not have header page info, in this case the
       tep_parse_header_page() function can be called with size equal to
       0. The tep context is initialized with default values. The
       long_size can be used in this use case, to set the size of a long
       integer to be used.

RETURN VALUE

       The tep_parse_header_page() function returns 0 in case of
       success, or -1 in case of an error.

EXAMPLE

           #include <event-parse.h>
           ...
           struct tep_handle *tep = tep_alloc();
           ...
           char *buf;
           int size;
           buf = read_file("/sys/kernel/tracing/events/header_page", &size);
           if (tep_parse_header_page(tep, buf, size, sizeof(unsigned long)) != 0) {
                   /* Failed to parse the header page */
           }
           ...

FILES

           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

       libtraceevent(3), trace-cmd(1)

AUTHOR

           Steven Rostedt <rostedt@goodmis.org[1]>, author of libtraceevent.
           Tzvetomir Stoyanov <tz.stoyanov@gmail.com[2]>, author of this man page.

REPORTING BUGS

       Report bugs to <linux-trace-devel@vger.kernel.org[3]>

LICENSE

       libtraceevent is Free Software licensed under the GNU LGPL 2.1

RESOURCES

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

NOTES

        1. rostedt@goodmis.org
           mailto:rostedt@goodmis.org

        2. tz.stoyanov@gmail.com
           mailto:tz.stoyanov@gmail.com

        3. linux-trace-devel@vger.kernel.org
           mailto:linux-trace-devel@vger.kernel.org

COLOPHON

       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 man-pages@man7.org

libtraceevent 1.7.3            09/24/2023               LIBTRACEEVENT(3)