xref: /OK3568_Linux_fs/kernel/include/uapi/linux/blktrace_api.h (revision 4882a59341e53eb6f0b4789bf948001014eff981) 
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
2*4882a593Smuzhiyun #ifndef _UAPIBLKTRACE_H
3*4882a593Smuzhiyun #define _UAPIBLKTRACE_H
4*4882a593Smuzhiyun 
5*4882a593Smuzhiyun #include <linux/types.h>
6*4882a593Smuzhiyun 
7*4882a593Smuzhiyun /*
8*4882a593Smuzhiyun  * Trace categories
9*4882a593Smuzhiyun  */
10*4882a593Smuzhiyun enum blktrace_cat {
11*4882a593Smuzhiyun 	BLK_TC_READ	= 1 << 0,	/* reads */
12*4882a593Smuzhiyun 	BLK_TC_WRITE	= 1 << 1,	/* writes */
13*4882a593Smuzhiyun 	BLK_TC_FLUSH	= 1 << 2,	/* flush */
14*4882a593Smuzhiyun 	BLK_TC_SYNC	= 1 << 3,	/* sync IO */
15*4882a593Smuzhiyun 	BLK_TC_SYNCIO	= BLK_TC_SYNC,
16*4882a593Smuzhiyun 	BLK_TC_QUEUE	= 1 << 4,	/* queueing/merging */
17*4882a593Smuzhiyun 	BLK_TC_REQUEUE	= 1 << 5,	/* requeueing */
18*4882a593Smuzhiyun 	BLK_TC_ISSUE	= 1 << 6,	/* issue */
19*4882a593Smuzhiyun 	BLK_TC_COMPLETE	= 1 << 7,	/* completions */
20*4882a593Smuzhiyun 	BLK_TC_FS	= 1 << 8,	/* fs requests */
21*4882a593Smuzhiyun 	BLK_TC_PC	= 1 << 9,	/* pc requests */
22*4882a593Smuzhiyun 	BLK_TC_NOTIFY	= 1 << 10,	/* special message */
23*4882a593Smuzhiyun 	BLK_TC_AHEAD	= 1 << 11,	/* readahead */
24*4882a593Smuzhiyun 	BLK_TC_META	= 1 << 12,	/* metadata */
25*4882a593Smuzhiyun 	BLK_TC_DISCARD	= 1 << 13,	/* discard requests */
26*4882a593Smuzhiyun 	BLK_TC_DRV_DATA	= 1 << 14,	/* binary per-driver data */
27*4882a593Smuzhiyun 	BLK_TC_FUA	= 1 << 15,	/* fua requests */
28*4882a593Smuzhiyun 
29*4882a593Smuzhiyun 	BLK_TC_END	= 1 << 15,	/* we've run out of bits! */
30*4882a593Smuzhiyun };
31*4882a593Smuzhiyun 
32*4882a593Smuzhiyun #define BLK_TC_SHIFT		(16)
33*4882a593Smuzhiyun #define BLK_TC_ACT(act)		((act) << BLK_TC_SHIFT)
34*4882a593Smuzhiyun 
35*4882a593Smuzhiyun /*
36*4882a593Smuzhiyun  * Basic trace actions
37*4882a593Smuzhiyun  */
38*4882a593Smuzhiyun enum blktrace_act {
39*4882a593Smuzhiyun 	__BLK_TA_QUEUE = 1,		/* queued */
40*4882a593Smuzhiyun 	__BLK_TA_BACKMERGE,		/* back merged to existing rq */
41*4882a593Smuzhiyun 	__BLK_TA_FRONTMERGE,		/* front merge to existing rq */
42*4882a593Smuzhiyun 	__BLK_TA_GETRQ,			/* allocated new request */
43*4882a593Smuzhiyun 	__BLK_TA_SLEEPRQ,		/* sleeping on rq allocation */
44*4882a593Smuzhiyun 	__BLK_TA_REQUEUE,		/* request requeued */
45*4882a593Smuzhiyun 	__BLK_TA_ISSUE,			/* sent to driver */
46*4882a593Smuzhiyun 	__BLK_TA_COMPLETE,		/* completed by driver */
47*4882a593Smuzhiyun 	__BLK_TA_PLUG,			/* queue was plugged */
48*4882a593Smuzhiyun 	__BLK_TA_UNPLUG_IO,		/* queue was unplugged by io */
49*4882a593Smuzhiyun 	__BLK_TA_UNPLUG_TIMER,		/* queue was unplugged by timer */
50*4882a593Smuzhiyun 	__BLK_TA_INSERT,		/* insert request */
51*4882a593Smuzhiyun 	__BLK_TA_SPLIT,			/* bio was split */
52*4882a593Smuzhiyun 	__BLK_TA_BOUNCE,		/* bio was bounced */
53*4882a593Smuzhiyun 	__BLK_TA_REMAP,			/* bio was remapped */
54*4882a593Smuzhiyun 	__BLK_TA_ABORT,			/* request aborted */
55*4882a593Smuzhiyun 	__BLK_TA_DRV_DATA,		/* driver-specific binary data */
56*4882a593Smuzhiyun 	__BLK_TA_CGROUP = 1 << 8,	/* from a cgroup*/
57*4882a593Smuzhiyun };
58*4882a593Smuzhiyun 
59*4882a593Smuzhiyun /*
60*4882a593Smuzhiyun  * Notify events.
61*4882a593Smuzhiyun  */
62*4882a593Smuzhiyun enum blktrace_notify {
63*4882a593Smuzhiyun 	__BLK_TN_PROCESS = 0,		/* establish pid/name mapping */
64*4882a593Smuzhiyun 	__BLK_TN_TIMESTAMP,		/* include system clock */
65*4882a593Smuzhiyun 	__BLK_TN_MESSAGE,		/* Character string message */
66*4882a593Smuzhiyun 	__BLK_TN_CGROUP = __BLK_TA_CGROUP, /* from a cgroup */
67*4882a593Smuzhiyun };
68*4882a593Smuzhiyun 
69*4882a593Smuzhiyun 
70*4882a593Smuzhiyun /*
71*4882a593Smuzhiyun  * Trace actions in full. Additionally, read or write is masked
72*4882a593Smuzhiyun  */
73*4882a593Smuzhiyun #define BLK_TA_QUEUE		(__BLK_TA_QUEUE | BLK_TC_ACT(BLK_TC_QUEUE))
74*4882a593Smuzhiyun #define BLK_TA_BACKMERGE	(__BLK_TA_BACKMERGE | BLK_TC_ACT(BLK_TC_QUEUE))
75*4882a593Smuzhiyun #define BLK_TA_FRONTMERGE	(__BLK_TA_FRONTMERGE | BLK_TC_ACT(BLK_TC_QUEUE))
76*4882a593Smuzhiyun #define	BLK_TA_GETRQ		(__BLK_TA_GETRQ | BLK_TC_ACT(BLK_TC_QUEUE))
77*4882a593Smuzhiyun #define	BLK_TA_SLEEPRQ		(__BLK_TA_SLEEPRQ | BLK_TC_ACT(BLK_TC_QUEUE))
78*4882a593Smuzhiyun #define	BLK_TA_REQUEUE		(__BLK_TA_REQUEUE | BLK_TC_ACT(BLK_TC_REQUEUE))
79*4882a593Smuzhiyun #define BLK_TA_ISSUE		(__BLK_TA_ISSUE | BLK_TC_ACT(BLK_TC_ISSUE))
80*4882a593Smuzhiyun #define BLK_TA_COMPLETE		(__BLK_TA_COMPLETE| BLK_TC_ACT(BLK_TC_COMPLETE))
81*4882a593Smuzhiyun #define BLK_TA_PLUG		(__BLK_TA_PLUG | BLK_TC_ACT(BLK_TC_QUEUE))
82*4882a593Smuzhiyun #define BLK_TA_UNPLUG_IO	(__BLK_TA_UNPLUG_IO | BLK_TC_ACT(BLK_TC_QUEUE))
83*4882a593Smuzhiyun #define BLK_TA_UNPLUG_TIMER	(__BLK_TA_UNPLUG_TIMER | BLK_TC_ACT(BLK_TC_QUEUE))
84*4882a593Smuzhiyun #define BLK_TA_INSERT		(__BLK_TA_INSERT | BLK_TC_ACT(BLK_TC_QUEUE))
85*4882a593Smuzhiyun #define BLK_TA_SPLIT		(__BLK_TA_SPLIT)
86*4882a593Smuzhiyun #define BLK_TA_BOUNCE		(__BLK_TA_BOUNCE)
87*4882a593Smuzhiyun #define BLK_TA_REMAP		(__BLK_TA_REMAP | BLK_TC_ACT(BLK_TC_QUEUE))
88*4882a593Smuzhiyun #define BLK_TA_ABORT		(__BLK_TA_ABORT | BLK_TC_ACT(BLK_TC_QUEUE))
89*4882a593Smuzhiyun #define BLK_TA_DRV_DATA	(__BLK_TA_DRV_DATA | BLK_TC_ACT(BLK_TC_DRV_DATA))
90*4882a593Smuzhiyun 
91*4882a593Smuzhiyun #define BLK_TN_PROCESS		(__BLK_TN_PROCESS | BLK_TC_ACT(BLK_TC_NOTIFY))
92*4882a593Smuzhiyun #define BLK_TN_TIMESTAMP	(__BLK_TN_TIMESTAMP | BLK_TC_ACT(BLK_TC_NOTIFY))
93*4882a593Smuzhiyun #define BLK_TN_MESSAGE		(__BLK_TN_MESSAGE | BLK_TC_ACT(BLK_TC_NOTIFY))
94*4882a593Smuzhiyun 
95*4882a593Smuzhiyun #define BLK_IO_TRACE_MAGIC	0x65617400
96*4882a593Smuzhiyun #define BLK_IO_TRACE_VERSION	0x07
97*4882a593Smuzhiyun 
98*4882a593Smuzhiyun /*
99*4882a593Smuzhiyun  * The trace itself
100*4882a593Smuzhiyun  */
101*4882a593Smuzhiyun struct blk_io_trace {
102*4882a593Smuzhiyun 	__u32 magic;		/* MAGIC << 8 | version */
103*4882a593Smuzhiyun 	__u32 sequence;		/* event number */
104*4882a593Smuzhiyun 	__u64 time;		/* in nanoseconds */
105*4882a593Smuzhiyun 	__u64 sector;		/* disk offset */
106*4882a593Smuzhiyun 	__u32 bytes;		/* transfer length */
107*4882a593Smuzhiyun 	__u32 action;		/* what happened */
108*4882a593Smuzhiyun 	__u32 pid;		/* who did it */
109*4882a593Smuzhiyun 	__u32 device;		/* device number */
110*4882a593Smuzhiyun 	__u32 cpu;		/* on what cpu did it happen */
111*4882a593Smuzhiyun 	__u16 error;		/* completion error */
112*4882a593Smuzhiyun 	__u16 pdu_len;		/* length of data after this trace */
113*4882a593Smuzhiyun 	/* cgroup id will be stored here if exists */
114*4882a593Smuzhiyun };
115*4882a593Smuzhiyun 
116*4882a593Smuzhiyun /*
117*4882a593Smuzhiyun  * The remap event
118*4882a593Smuzhiyun  */
119*4882a593Smuzhiyun struct blk_io_trace_remap {
120*4882a593Smuzhiyun 	__be32 device_from;
121*4882a593Smuzhiyun 	__be32 device_to;
122*4882a593Smuzhiyun 	__be64 sector_from;
123*4882a593Smuzhiyun };
124*4882a593Smuzhiyun 
125*4882a593Smuzhiyun enum {
126*4882a593Smuzhiyun 	Blktrace_setup = 1,
127*4882a593Smuzhiyun 	Blktrace_running,
128*4882a593Smuzhiyun 	Blktrace_stopped,
129*4882a593Smuzhiyun };
130*4882a593Smuzhiyun 
131*4882a593Smuzhiyun #define BLKTRACE_BDEV_SIZE	32
132*4882a593Smuzhiyun 
133*4882a593Smuzhiyun /*
134*4882a593Smuzhiyun  * User setup structure passed with BLKTRACESETUP
135*4882a593Smuzhiyun  */
136*4882a593Smuzhiyun struct blk_user_trace_setup {
137*4882a593Smuzhiyun 	char name[BLKTRACE_BDEV_SIZE];	/* output */
138*4882a593Smuzhiyun 	__u16 act_mask;			/* input */
139*4882a593Smuzhiyun 	__u32 buf_size;			/* input */
140*4882a593Smuzhiyun 	__u32 buf_nr;			/* input */
141*4882a593Smuzhiyun 	__u64 start_lba;
142*4882a593Smuzhiyun 	__u64 end_lba;
143*4882a593Smuzhiyun 	__u32 pid;
144*4882a593Smuzhiyun };
145*4882a593Smuzhiyun 
146*4882a593Smuzhiyun #endif /* _UAPIBLKTRACE_H */
147