void *kbuffer_read_event(struct kbuffer *kbuf, unsigned long long *ts);
void *kbuffer_next_event(struct kbuffer *kbuf, unsigned long long *ts);
void *kbuffer_read_at_offset(struct kbuffer *kbuf, int offset, unsigned long long *ts);
int kbuffer_missed_events(struct kbuffer *kbuf);
int kbuffer_event_size(struct kbuffer *kbuf);
int kbuffer_curr_size(struct kbuffer *kbuf);
int kbuffer_curr_offset(struct kbuffer *kbuf);
int kbuffer_curr_index(struct kbuffer *kbuf);
The function kbuffer_read_event() reads the next event in the
kbuf descriptor and if ts is non NULL, will place its timestamp
into it. This does not modify the kbuf descriptor, and calling
this function mulitple times will return the same result.
The function kbuffer_next_event() will return the next event in
the kbuf descriptor. It will also set the ts to the timestamp of
the returned event. NULL is returned if there are no more events
and ts will be undefined. Note, if this is called directly after
a kbuffer_load_subbuffer() then it will likely give an unexpected
result, as it will return the second event and not the first
event. Usually this function is only used to move to the next
event and to know if there’s any more events to read, and
kbuffer_read_event() is always called first.
The function kbuffer_read_at_offset() returns the event located
at a given offset from the beginning of the sub-buffer. This
offset can be retrieved by kbuffer_curr_offset(). If ts points to
an unsigned long long, then it will be set to the event at the
given offset’s timestamp.
If the sub-buffer had missed events before it, then
kbuffer_missed_events() will return the non zero. If it returns
-1, that means there were missed events, but the exact number of
missed events is unknown. If it returns a positive number, then
the number of missed events is the return value.
The kbuffer_event_size() function returns the size of the data
portion of the current event (the one that would be returned by
The kbuffer_curr_size() function returns the entire record size
of the current event (the one that would be returned by
kbuffer_read_event(). The difference here is that the return
value includes the size of the event record meta data that is not
part of what is returned by kbuffer_read_event().
The kbuffer_curr_offset() function returns the offset from the
beginning of the sub-buffer of where the current event’s meta
data for the record begins. The first event will not be at offset
zero. This offset can be used to retrieve the event with
The kbuffer_curr_index() function returns the index from the
beginning of the data portion of the sub-buffer where the current
evnet’s meta data is located. The first event will likely be
zero, but may not be if there’s a timestamp attached to it.
kbuffer_read_event() returns the event that the kbuf descriptor
is currently at, or NULL if the last event was passed (by
kbuffer_next_event() returns the next event after the current
event or NULL if there are no more events.
kbuffer_read_at_offset() returns the event at a given offset from
the start of the sub-buffer stored in kbuf, or NULL if there
exists no event. Note, offset only needs to be an offset that
lands on the record, or is at the start of it. It does not need
to be exactly at the beginning of the record.
kbuffer_missed_events() returns 0 if there were no missed events
before loaded sub-buffer. Returns -1 if there were an unknown
number of missed events, or if the number of missed events is
known, that number will be returned.
kbuffer_event_size() returns the size of the data payload of the
current event of kbuf.
kbuffer_curr_size() returns the size of the entire record of the
current event of kbuf. This includes the size of the meta data
for that record.
kbuf_curr_offset() returns the offset of the current record from
the beginning of the kbuf sub-buffer.
kbuf_curr_index() returns the index of the current record from
the beginning of the kbuf data section.
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
on 2023-06-23. (At that time, the date of the most recent commit
that was found in the repository was 2023-06-07.) 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@example.com
libtraceevent 1.7.3 06/22/2023 LIBTRACEEVENT(3)