xref: /OK3568_Linux_fs/kernel/tools/lib/traceevent/kbuffer.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: LGPL-2.1 */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * Copyright (C) 2012 Red Hat Inc, Steven Rostedt <srostedt@redhat.com>
4*4882a593Smuzhiyun  *
5*4882a593Smuzhiyun  */
6*4882a593Smuzhiyun #ifndef _KBUFFER_H
7*4882a593Smuzhiyun #define _KBUFFER_H
8*4882a593Smuzhiyun 
9*4882a593Smuzhiyun #ifndef TS_SHIFT
10*4882a593Smuzhiyun #define TS_SHIFT		27
11*4882a593Smuzhiyun #endif
12*4882a593Smuzhiyun 
13*4882a593Smuzhiyun enum kbuffer_endian {
14*4882a593Smuzhiyun 	KBUFFER_ENDIAN_BIG,
15*4882a593Smuzhiyun 	KBUFFER_ENDIAN_LITTLE,
16*4882a593Smuzhiyun };
17*4882a593Smuzhiyun 
18*4882a593Smuzhiyun enum kbuffer_long_size {
19*4882a593Smuzhiyun 	KBUFFER_LSIZE_4,
20*4882a593Smuzhiyun 	KBUFFER_LSIZE_8,
21*4882a593Smuzhiyun };
22*4882a593Smuzhiyun 
23*4882a593Smuzhiyun enum {
24*4882a593Smuzhiyun 	KBUFFER_TYPE_PADDING		= 29,
25*4882a593Smuzhiyun 	KBUFFER_TYPE_TIME_EXTEND	= 30,
26*4882a593Smuzhiyun 	KBUFFER_TYPE_TIME_STAMP		= 31,
27*4882a593Smuzhiyun };
28*4882a593Smuzhiyun 
29*4882a593Smuzhiyun struct kbuffer;
30*4882a593Smuzhiyun 
31*4882a593Smuzhiyun struct kbuffer *kbuffer_alloc(enum kbuffer_long_size size, enum kbuffer_endian endian);
32*4882a593Smuzhiyun void kbuffer_free(struct kbuffer *kbuf);
33*4882a593Smuzhiyun int kbuffer_load_subbuffer(struct kbuffer *kbuf, void *subbuffer);
34*4882a593Smuzhiyun void *kbuffer_read_event(struct kbuffer *kbuf, unsigned long long *ts);
35*4882a593Smuzhiyun void *kbuffer_next_event(struct kbuffer *kbuf, unsigned long long *ts);
36*4882a593Smuzhiyun unsigned long long kbuffer_timestamp(struct kbuffer *kbuf);
37*4882a593Smuzhiyun unsigned long long kbuffer_subbuf_timestamp(struct kbuffer *kbuf, void *subbuf);
38*4882a593Smuzhiyun unsigned int kbuffer_ptr_delta(struct kbuffer *kbuf, void *ptr);
39*4882a593Smuzhiyun 
40*4882a593Smuzhiyun void *kbuffer_translate_data(int swap, void *data, unsigned int *size);
41*4882a593Smuzhiyun 
42*4882a593Smuzhiyun void *kbuffer_read_at_offset(struct kbuffer *kbuf, int offset, unsigned long long *ts);
43*4882a593Smuzhiyun 
44*4882a593Smuzhiyun int kbuffer_curr_index(struct kbuffer *kbuf);
45*4882a593Smuzhiyun 
46*4882a593Smuzhiyun int kbuffer_curr_offset(struct kbuffer *kbuf);
47*4882a593Smuzhiyun int kbuffer_curr_size(struct kbuffer *kbuf);
48*4882a593Smuzhiyun int kbuffer_event_size(struct kbuffer *kbuf);
49*4882a593Smuzhiyun int kbuffer_missed_events(struct kbuffer *kbuf);
50*4882a593Smuzhiyun int kbuffer_subbuffer_size(struct kbuffer *kbuf);
51*4882a593Smuzhiyun 
52*4882a593Smuzhiyun void kbuffer_set_old_format(struct kbuffer *kbuf);
53*4882a593Smuzhiyun int kbuffer_start_of_data(struct kbuffer *kbuf);
54*4882a593Smuzhiyun 
55*4882a593Smuzhiyun /* Debugging */
56*4882a593Smuzhiyun 
57*4882a593Smuzhiyun struct kbuffer_raw_info {
58*4882a593Smuzhiyun 	int			type;
59*4882a593Smuzhiyun 	int			length;
60*4882a593Smuzhiyun 	unsigned long long	delta;
61*4882a593Smuzhiyun 	void			*next;
62*4882a593Smuzhiyun };
63*4882a593Smuzhiyun 
64*4882a593Smuzhiyun /* Read raw data */
65*4882a593Smuzhiyun struct kbuffer_raw_info *kbuffer_raw_get(struct kbuffer *kbuf, void *subbuf,
66*4882a593Smuzhiyun 					 struct kbuffer_raw_info *info);
67*4882a593Smuzhiyun 
68*4882a593Smuzhiyun #endif /* _K_BUFFER_H */
69