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