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