include blktrace_api.h in headers_install
[linux-2.6.git] / include / linux / blktrace_api.h
1 #ifndef BLKTRACE_H
2 #define BLKTRACE_H
3
4 #ifdef __KERNEL__
5 #include <linux/blkdev.h>
6 #include <linux/relay.h>
7 #endif
8
9 /*
10  * Trace categories
11  */
12 enum blktrace_cat {
13         BLK_TC_READ     = 1 << 0,       /* reads */
14         BLK_TC_WRITE    = 1 << 1,       /* writes */
15         BLK_TC_BARRIER  = 1 << 2,       /* barrier */
16         BLK_TC_SYNC     = 1 << 3,       /* sync IO */
17         BLK_TC_QUEUE    = 1 << 4,       /* queueing/merging */
18         BLK_TC_REQUEUE  = 1 << 5,       /* requeueing */
19         BLK_TC_ISSUE    = 1 << 6,       /* issue */
20         BLK_TC_COMPLETE = 1 << 7,       /* completions */
21         BLK_TC_FS       = 1 << 8,       /* fs requests */
22         BLK_TC_PC       = 1 << 9,       /* pc requests */
23         BLK_TC_NOTIFY   = 1 << 10,      /* special message */
24         BLK_TC_AHEAD    = 1 << 11,      /* readahead */
25         BLK_TC_META     = 1 << 12,      /* metadata */
26         BLK_TC_DISCARD  = 1 << 13,      /* discard requests */
27
28         BLK_TC_END      = 1 << 15,      /* only 16-bits, reminder */
29 };
30
31 #define BLK_TC_SHIFT            (16)
32 #define BLK_TC_ACT(act)         ((act) << BLK_TC_SHIFT)
33
34 /*
35  * Basic trace actions
36  */
37 enum blktrace_act {
38         __BLK_TA_QUEUE = 1,             /* queued */
39         __BLK_TA_BACKMERGE,             /* back merged to existing rq */
40         __BLK_TA_FRONTMERGE,            /* front merge to existing rq */
41         __BLK_TA_GETRQ,                 /* allocated new request */
42         __BLK_TA_SLEEPRQ,               /* sleeping on rq allocation */
43         __BLK_TA_REQUEUE,               /* request requeued */
44         __BLK_TA_ISSUE,                 /* sent to driver */
45         __BLK_TA_COMPLETE,              /* completed by driver */
46         __BLK_TA_PLUG,                  /* queue was plugged */
47         __BLK_TA_UNPLUG_IO,             /* queue was unplugged by io */
48         __BLK_TA_UNPLUG_TIMER,          /* queue was unplugged by timer */
49         __BLK_TA_INSERT,                /* insert request */
50         __BLK_TA_SPLIT,                 /* bio was split */
51         __BLK_TA_BOUNCE,                /* bio was bounced */
52         __BLK_TA_REMAP,                 /* bio was remapped */
53         __BLK_TA_ABORT,                 /* request aborted */
54 };
55
56 /*
57  * Notify events.
58  */
59 enum blktrace_notify {
60         __BLK_TN_PROCESS = 0,           /* establish pid/name mapping */
61         __BLK_TN_TIMESTAMP,             /* include system clock */
62         __BLK_TN_MESSAGE,               /* Character string message */
63 };
64
65
66 /*
67  * Trace actions in full. Additionally, read or write is masked
68  */
69 #define BLK_TA_QUEUE            (__BLK_TA_QUEUE | BLK_TC_ACT(BLK_TC_QUEUE))
70 #define BLK_TA_BACKMERGE        (__BLK_TA_BACKMERGE | BLK_TC_ACT(BLK_TC_QUEUE))
71 #define BLK_TA_FRONTMERGE       (__BLK_TA_FRONTMERGE | BLK_TC_ACT(BLK_TC_QUEUE))
72 #define BLK_TA_GETRQ            (__BLK_TA_GETRQ | BLK_TC_ACT(BLK_TC_QUEUE))
73 #define BLK_TA_SLEEPRQ          (__BLK_TA_SLEEPRQ | BLK_TC_ACT(BLK_TC_QUEUE))
74 #define BLK_TA_REQUEUE          (__BLK_TA_REQUEUE | BLK_TC_ACT(BLK_TC_REQUEUE))
75 #define BLK_TA_ISSUE            (__BLK_TA_ISSUE | BLK_TC_ACT(BLK_TC_ISSUE))
76 #define BLK_TA_COMPLETE         (__BLK_TA_COMPLETE| BLK_TC_ACT(BLK_TC_COMPLETE))
77 #define BLK_TA_PLUG             (__BLK_TA_PLUG | BLK_TC_ACT(BLK_TC_QUEUE))
78 #define BLK_TA_UNPLUG_IO        (__BLK_TA_UNPLUG_IO | BLK_TC_ACT(BLK_TC_QUEUE))
79 #define BLK_TA_UNPLUG_TIMER     (__BLK_TA_UNPLUG_TIMER | BLK_TC_ACT(BLK_TC_QUEUE))
80 #define BLK_TA_INSERT           (__BLK_TA_INSERT | BLK_TC_ACT(BLK_TC_QUEUE))
81 #define BLK_TA_SPLIT            (__BLK_TA_SPLIT)
82 #define BLK_TA_BOUNCE           (__BLK_TA_BOUNCE)
83 #define BLK_TA_REMAP            (__BLK_TA_REMAP | BLK_TC_ACT(BLK_TC_QUEUE))
84 #define BLK_TA_ABORT            (__BLK_TA_ABORT | BLK_TC_ACT(BLK_TC_QUEUE))
85
86 #define BLK_TN_PROCESS          (__BLK_TN_PROCESS | BLK_TC_ACT(BLK_TC_NOTIFY))
87 #define BLK_TN_TIMESTAMP        (__BLK_TN_TIMESTAMP | BLK_TC_ACT(BLK_TC_NOTIFY))
88 #define BLK_TN_MESSAGE          (__BLK_TN_MESSAGE | BLK_TC_ACT(BLK_TC_NOTIFY))
89
90 #define BLK_IO_TRACE_MAGIC      0x65617400
91 #define BLK_IO_TRACE_VERSION    0x07
92
93 /*
94  * The trace itself
95  */
96 struct blk_io_trace {
97         __u32 magic;            /* MAGIC << 8 | version */
98         __u32 sequence;         /* event number */
99         __u64 time;             /* in microseconds */
100         __u64 sector;           /* disk offset */
101         __u32 bytes;            /* transfer length */
102         __u32 action;           /* what happened */
103         __u32 pid;              /* who did it */
104         __u32 device;           /* device number */
105         __u32 cpu;              /* on what cpu did it happen */
106         __u16 error;            /* completion error */
107         __u16 pdu_len;          /* length of data after this trace */
108 };
109
110 /*
111  * The remap event
112  */
113 struct blk_io_trace_remap {
114         __be32 device;
115         __be32 device_from;
116         __be64 sector;
117 };
118
119 enum {
120         Blktrace_setup = 1,
121         Blktrace_running,
122         Blktrace_stopped,
123 };
124
125 /*
126  * User setup structure passed with BLKTRACESTART
127  */
128 struct blk_user_trace_setup {
129 #ifdef __KERNEL__
130         char name[BDEVNAME_SIZE];       /* output */
131 #else
132         char name[32];                  /* output */
133 #endif
134         __u16 act_mask;                 /* input */
135         __u32 buf_size;                 /* input */
136         __u32 buf_nr;                   /* input */
137         __u64 start_lba;
138         __u64 end_lba;
139         __u32 pid;
140 };
141
142 #ifdef __KERNEL__
143 #if defined(CONFIG_BLK_DEV_IO_TRACE)
144 struct blk_trace {
145         int trace_state;
146         struct rchan *rchan;
147         unsigned long *sequence;
148         unsigned char *msg_data;
149         u16 act_mask;
150         u64 start_lba;
151         u64 end_lba;
152         u32 pid;
153         u32 dev;
154         struct dentry *dir;
155         struct dentry *dropped_file;
156         struct dentry *msg_file;
157         atomic_t dropped;
158 };
159
160 extern int blk_trace_ioctl(struct block_device *, unsigned, char __user *);
161 extern void blk_trace_shutdown(struct request_queue *);
162 extern void __blk_add_trace(struct blk_trace *, sector_t, int, int, u32, int, int, void *);
163 extern int do_blk_trace_setup(struct request_queue *q,
164         char *name, dev_t dev, struct blk_user_trace_setup *buts);
165 extern void __trace_note_message(struct blk_trace *, const char *fmt, ...);
166
167 /**
168  * blk_add_trace_msg - Add a (simple) message to the blktrace stream
169  * @q:          queue the io is for
170  * @fmt:        format to print message in
171  * args...      Variable argument list for format
172  *
173  * Description:
174  *     Records a (simple) message onto the blktrace stream.
175  *
176  *     NOTE: BLK_TN_MAX_MSG characters are output at most.
177  *     NOTE: Can not use 'static inline' due to presence of var args...
178  *
179  **/
180 #define blk_add_trace_msg(q, fmt, ...)                                  \
181         do {                                                            \
182                 struct blk_trace *bt = (q)->blk_trace;                  \
183                 if (unlikely(bt))                                       \
184                         __trace_note_message(bt, fmt, ##__VA_ARGS__);   \
185         } while (0)
186 #define BLK_TN_MAX_MSG          128
187
188 /**
189  * blk_add_trace_rq - Add a trace for a request oriented action
190  * @q:          queue the io is for
191  * @rq:         the source request
192  * @what:       the action
193  *
194  * Description:
195  *     Records an action against a request. Will log the bio offset + size.
196  *
197  **/
198 static inline void blk_add_trace_rq(struct request_queue *q, struct request *rq,
199                                     u32 what)
200 {
201         struct blk_trace *bt = q->blk_trace;
202         int rw = rq->cmd_flags & 0x03;
203
204         if (likely(!bt))
205                 return;
206
207         if (blk_discard_rq(rq))
208                 rw |= (1 << BIO_RW_DISCARD);
209
210         if (blk_pc_request(rq)) {
211                 what |= BLK_TC_ACT(BLK_TC_PC);
212                 __blk_add_trace(bt, 0, rq->data_len, rw, what, rq->errors, sizeof(rq->cmd), rq->cmd);
213         } else  {
214                 what |= BLK_TC_ACT(BLK_TC_FS);
215                 __blk_add_trace(bt, rq->hard_sector, rq->hard_nr_sectors << 9, rw, what, rq->errors, 0, NULL);
216         }
217 }
218
219 /**
220  * blk_add_trace_bio - Add a trace for a bio oriented action
221  * @q:          queue the io is for
222  * @bio:        the source bio
223  * @what:       the action
224  *
225  * Description:
226  *     Records an action against a bio. Will log the bio offset + size.
227  *
228  **/
229 static inline void blk_add_trace_bio(struct request_queue *q, struct bio *bio,
230                                      u32 what)
231 {
232         struct blk_trace *bt = q->blk_trace;
233
234         if (likely(!bt))
235                 return;
236
237         __blk_add_trace(bt, bio->bi_sector, bio->bi_size, bio->bi_rw, what, !bio_flagged(bio, BIO_UPTODATE), 0, NULL);
238 }
239
240 /**
241  * blk_add_trace_generic - Add a trace for a generic action
242  * @q:          queue the io is for
243  * @bio:        the source bio
244  * @rw:         the data direction
245  * @what:       the action
246  *
247  * Description:
248  *     Records a simple trace
249  *
250  **/
251 static inline void blk_add_trace_generic(struct request_queue *q,
252                                          struct bio *bio, int rw, u32 what)
253 {
254         struct blk_trace *bt = q->blk_trace;
255
256         if (likely(!bt))
257                 return;
258
259         if (bio)
260                 blk_add_trace_bio(q, bio, what);
261         else
262                 __blk_add_trace(bt, 0, 0, rw, what, 0, 0, NULL);
263 }
264
265 /**
266  * blk_add_trace_pdu_int - Add a trace for a bio with an integer payload
267  * @q:          queue the io is for
268  * @what:       the action
269  * @bio:        the source bio
270  * @pdu:        the integer payload
271  *
272  * Description:
273  *     Adds a trace with some integer payload. This might be an unplug
274  *     option given as the action, with the depth at unplug time given
275  *     as the payload
276  *
277  **/
278 static inline void blk_add_trace_pdu_int(struct request_queue *q, u32 what,
279                                          struct bio *bio, unsigned int pdu)
280 {
281         struct blk_trace *bt = q->blk_trace;
282         __be64 rpdu = cpu_to_be64(pdu);
283
284         if (likely(!bt))
285                 return;
286
287         if (bio)
288                 __blk_add_trace(bt, bio->bi_sector, bio->bi_size, bio->bi_rw, what, !bio_flagged(bio, BIO_UPTODATE), sizeof(rpdu), &rpdu);
289         else
290                 __blk_add_trace(bt, 0, 0, 0, what, 0, sizeof(rpdu), &rpdu);
291 }
292
293 /**
294  * blk_add_trace_remap - Add a trace for a remap operation
295  * @q:          queue the io is for
296  * @bio:        the source bio
297  * @dev:        target device
298  * @from:       source sector
299  * @to:         target sector
300  *
301  * Description:
302  *     Device mapper or raid target sometimes need to split a bio because
303  *     it spans a stripe (or similar). Add a trace for that action.
304  *
305  **/
306 static inline void blk_add_trace_remap(struct request_queue *q, struct bio *bio,
307                                        dev_t dev, sector_t from, sector_t to)
308 {
309         struct blk_trace *bt = q->blk_trace;
310         struct blk_io_trace_remap r;
311
312         if (likely(!bt))
313                 return;
314
315         r.device = cpu_to_be32(dev);
316         r.device_from = cpu_to_be32(bio->bi_bdev->bd_dev);
317         r.sector = cpu_to_be64(to);
318
319         __blk_add_trace(bt, from, bio->bi_size, bio->bi_rw, BLK_TA_REMAP, !bio_flagged(bio, BIO_UPTODATE), sizeof(r), &r);
320 }
321
322 extern int blk_trace_setup(struct request_queue *q, char *name, dev_t dev,
323                            char __user *arg);
324 extern int blk_trace_startstop(struct request_queue *q, int start);
325 extern int blk_trace_remove(struct request_queue *q);
326
327 #else /* !CONFIG_BLK_DEV_IO_TRACE */
328 #define blk_trace_ioctl(bdev, cmd, arg)         (-ENOTTY)
329 #define blk_trace_shutdown(q)                   do { } while (0)
330 #define blk_add_trace_rq(q, rq, what)           do { } while (0)
331 #define blk_add_trace_bio(q, rq, what)          do { } while (0)
332 #define blk_add_trace_generic(q, rq, rw, what)  do { } while (0)
333 #define blk_add_trace_pdu_int(q, what, bio, pdu)        do { } while (0)
334 #define blk_add_trace_remap(q, bio, dev, f, t)  do {} while (0)
335 #define do_blk_trace_setup(q, name, dev, buts)  (-ENOTTY)
336 #define blk_trace_setup(q, name, dev, arg)      (-ENOTTY)
337 #define blk_trace_startstop(q, start)           (-ENOTTY)
338 #define blk_trace_remove(q)                     (-ENOTTY)
339 #define blk_add_trace_msg(q, fmt, ...)          do { } while (0)
340
341 #endif /* CONFIG_BLK_DEV_IO_TRACE */
342 #endif /* __KERNEL__ */
343 #endif