tep_event_common_fields - Man Page

Get a list of fields for an event.

Synopsis

#include <event-parse.h>

struct tep_format_field **tep_event_common_fields(struct tep_event *event);
struct tep_format_field **tep_event_fields(struct tep_event *event);

Description

The tep_event_common_fields() function returns an array of pointers to common fields for the event. The array is allocated in the function and must be freed by free(). The last element of the array is NULL.

The tep_event_fields() function returns an array of pointers to event specific fields for the event. The array is allocated in the function and must be freed by free(). The last element of the array is NULL.

Return Value

Both tep_event_common_fields() and tep_event_fields() functions return an array of pointers to tep_format_field structures in case of success, or NULL in case of an error.

Example

#include <event-parse.h>
...
struct tep_handle *tep = tep_alloc();
...
int i;
struct tep_format_field **fields;
struct tep_event *event = tep_find_event_by_name(tep, "kvm", "kvm_exit");
if (event != NULL) {
        fields = tep_event_common_fields(event);
        if (fields != NULL) {
                i = 0;
                while (fields[i]) {
                        /*
                          walk through the list of the common fields
                          of the kvm_exit event
                        */
                        i++;
                }
                free(fields);
        }
        fields = tep_event_fields(event);
        if (fields != NULL) {
                i = 0;
                while (fields[i]) {
                        /*
                          walk through the list of the event specific
                          fields of the kvm_exit event
                        */
                        i++;
                }
                free(fields);
        }
}
...

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

Referenced By

The man page tep_event_fields(3) is an alias of tep_event_common_fields(3).

02/08/2021 libtraceevent 1.1.1 libtraceevent Manual