tep_set_flag(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_set_flag, tep_clear_flag, tep_test_flag - Manage flags of
       trace event parser context.

SYNOPSIS         top

       #include <event-parse.h>

       enum tep_flag {
               TEP_NSEC_OUTPUT,
               TEP_DISABLE_SYS_PLUGINS,
               TEP_DISABLE_PLUGINS
       };
       void tep_set_flag(struct tep_handle *tep, enum tep_flag flag);
       void tep_clear_flag(struct tep_handle *tep, enum tep_flag flag);
       bool tep_test_flag(struct tep_handle *tep, enum tep_flag flag);

DESCRIPTION         top

       Trace event parser context flags are defined in enum tep_flag:

           TEP_NSEC_OUTPUT - print event’s timestamp in nano seconds, instead of micro seconds.
           TEP_DISABLE_SYS_PLUGINS - disable plugins, located in system’s plugin
                                   directory. This directory is defined at library compile
                                   time, and usually depends on library installation
                                   prefix: (install_preffix)/lib/traceevent/plugins
           TEP_DISABLE_PLUGINS - disable all library plugins:
                                   - in system’s plugin directory
                                   - in directory, defined by the environment variable TRACEEVENT_PLUGIN_DIR
                                   - in user’s home directory, ~/.traceevent/plugins

       Note: plugin related flags must me set before calling
       tep_load_plugins() API.

       The tep_set_flag() function sets flag to tep context.

       The tep_clear_flag() function clears flag from tep context.

       The tep_test_flag() function tests if flag is set to tep context.

RETURN VALUE         top

       tep_test_flag() function returns true if flag is set, false
       otherwise.

EXAMPLE         top

           #include <event-parse.h>
           ...
           struct tep_handle *tep = tep_alloc();
           ...
           /* Print timestamps in nanoseconds */
           tep_set_flag(tep,  TEP_NSEC_OUTPUT);
           ...
           if (tep_test_flag(tep, TEP_NSEC_OUTPUT)) {
                   /* print timestamps in nanoseconds */
           } else {
                   /* print timestamps in microseconds */
           }
           ...
           /* Print timestamps in microseconds */
           tep_clear_flag(tep, TEP_NSEC_OUTPUT);
           ...

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)

Pages that refer to this page: tep_load_plugins(3)