lib/traceevent/kbuffer.h

0001 /* SPDX-License-Identifier: LGPL-2.1 */
0002 /*
0003  * Copyright (C) 2012 Red Hat Inc, Steven Rostedt <srostedt@redhat.com>
0004  *
0005  */
0006 #ifndef _KBUFFER_H
0007 #define _KBUFFER_H
0008
0009 #ifndef TS_SHIFT
0010 #define TS_SHIFT        27
0011 #endif
0012
0013 enum kbuffer_endian {
0014     KBUFFER_ENDIAN_BIG,
0015     KBUFFER_ENDIAN_LITTLE,
0016 };
0017
0018 enum kbuffer_long_size {
0019     KBUFFER_LSIZE_4,
0020     KBUFFER_LSIZE_8,
0021 };
0022
0023 enum {
0024     KBUFFER_TYPE_PADDING        = 29,
0025     KBUFFER_TYPE_TIME_EXTEND    = 30,
0026     KBUFFER_TYPE_TIME_STAMP     = 31,
0027 };
0028
0029 struct kbuffer;
0030
0031 struct kbuffer *kbuffer_alloc(enum kbuffer_long_size size, enum kbuffer_endian endian);
0032 void kbuffer_free(struct kbuffer *kbuf);
0033 int kbuffer_load_subbuffer(struct kbuffer *kbuf, void *subbuffer);
0034 void *kbuffer_read_event(struct kbuffer *kbuf, unsigned long long *ts);
0035 void *kbuffer_next_event(struct kbuffer *kbuf, unsigned long long *ts);
0036 unsigned long long kbuffer_timestamp(struct kbuffer *kbuf);
0037 unsigned long long kbuffer_subbuf_timestamp(struct kbuffer *kbuf, void *subbuf);
0038 unsigned int kbuffer_ptr_delta(struct kbuffer *kbuf, void *ptr);
0039
0040 void *kbuffer_translate_data(int swap, void *data, unsigned int *size);
0041
0042 void *kbuffer_read_at_offset(struct kbuffer *kbuf, int offset, unsigned long long *ts);
0043
0044 int kbuffer_curr_index(struct kbuffer *kbuf);
0045
0046 int kbuffer_curr_offset(struct kbuffer *kbuf);
0047 int kbuffer_curr_size(struct kbuffer *kbuf);
0048 int kbuffer_event_size(struct kbuffer *kbuf);
0049 int kbuffer_missed_events(struct kbuffer *kbuf);
0050 int kbuffer_subbuffer_size(struct kbuffer *kbuf);
0051
0052 void kbuffer_set_old_format(struct kbuffer *kbuf);
0053 int kbuffer_start_of_data(struct kbuffer *kbuf);
0054
0055 /* Debugging */
0056
0057 struct kbuffer_raw_info {
0058     int         type;
0059     int         length;
0060     unsigned long long  delta;
0061     void            *next;
0062 };
0063
0064 /* Read raw data */
0065 struct kbuffer_raw_info *kbuffer_raw_get(struct kbuffer *kbuf, void *subbuf,
0066                      struct kbuffer_raw_info *info);
0067
0068 #endif /* _K_BUFFER_H */