blob: 416bf62d6d4649211926fc713cbbb152a2d3653d [file] [log] [blame]
Jens Axboe2056a782006-03-23 20:00:26 +01001#ifndef BLKTRACE_H
2#define BLKTRACE_H
3
Jaswinder Singh Rajput4502b802009-01-30 20:36:52 +05304#include <linux/types.h>
Sven Schuetzc0ddffa2008-09-26 10:58:02 +02005#ifdef __KERNEL__
Jens Axboe2056a782006-03-23 20:00:26 +01006#include <linux/blkdev.h>
7#include <linux/relay.h>
Sven Schuetzc0ddffa2008-09-26 10:58:02 +02008#endif
Jens Axboe2056a782006-03-23 20:00:26 +01009
10/*
11 * Trace categories
12 */
13enum blktrace_cat {
14 BLK_TC_READ = 1 << 0, /* reads */
15 BLK_TC_WRITE = 1 << 1, /* writes */
16 BLK_TC_BARRIER = 1 << 2, /* barrier */
Nathan Scottfc0a75c2006-07-06 09:56:30 +020017 BLK_TC_SYNC = 1 << 3, /* sync IO */
Jens Axboe93dbb392009-02-16 10:25:40 +010018 BLK_TC_SYNCIO = BLK_TC_SYNC,
Jens Axboe2056a782006-03-23 20:00:26 +010019 BLK_TC_QUEUE = 1 << 4, /* queueing/merging */
20 BLK_TC_REQUEUE = 1 << 5, /* requeueing */
21 BLK_TC_ISSUE = 1 << 6, /* issue */
22 BLK_TC_COMPLETE = 1 << 7, /* completions */
23 BLK_TC_FS = 1 << 8, /* fs requests */
24 BLK_TC_PC = 1 << 9, /* pc requests */
25 BLK_TC_NOTIFY = 1 << 10, /* special message */
Nathan Scott40359cc2006-07-06 10:03:28 +020026 BLK_TC_AHEAD = 1 << 11, /* readahead */
Jens Axboe7457e6e2006-07-23 02:12:01 +020027 BLK_TC_META = 1 << 12, /* metadata */
David Woodhouse27b29e82008-08-10 11:21:57 +010028 BLK_TC_DISCARD = 1 << 13, /* discard requests */
Stefan Raspl756f8242008-10-16 08:23:21 +020029 BLK_TC_DRV_DATA = 1 << 14, /* binary per-driver data */
Jens Axboe2056a782006-03-23 20:00:26 +010030
31 BLK_TC_END = 1 << 15, /* only 16-bits, reminder */
32};
33
34#define BLK_TC_SHIFT (16)
35#define BLK_TC_ACT(act) ((act) << BLK_TC_SHIFT)
36
37/*
38 * Basic trace actions
39 */
40enum blktrace_act {
41 __BLK_TA_QUEUE = 1, /* queued */
42 __BLK_TA_BACKMERGE, /* back merged to existing rq */
43 __BLK_TA_FRONTMERGE, /* front merge to existing rq */
44 __BLK_TA_GETRQ, /* allocated new request */
45 __BLK_TA_SLEEPRQ, /* sleeping on rq allocation */
46 __BLK_TA_REQUEUE, /* request requeued */
47 __BLK_TA_ISSUE, /* sent to driver */
48 __BLK_TA_COMPLETE, /* completed by driver */
49 __BLK_TA_PLUG, /* queue was plugged */
50 __BLK_TA_UNPLUG_IO, /* queue was unplugged by io */
51 __BLK_TA_UNPLUG_TIMER, /* queue was unplugged by timer */
52 __BLK_TA_INSERT, /* insert request */
53 __BLK_TA_SPLIT, /* bio was split */
54 __BLK_TA_BOUNCE, /* bio was bounced */
55 __BLK_TA_REMAP, /* bio was remapped */
Mike Anderson11914a52008-09-13 20:31:27 +020056 __BLK_TA_ABORT, /* request aborted */
Stefan Raspl756f8242008-10-16 08:23:21 +020057 __BLK_TA_DRV_DATA, /* driver-specific binary data */
Jens Axboe2056a782006-03-23 20:00:26 +010058};
59
60/*
Olaf Kirchbe1c6342006-12-01 10:39:12 +010061 * Notify events.
62 */
63enum blktrace_notify {
64 __BLK_TN_PROCESS = 0, /* establish pid/name mapping */
65 __BLK_TN_TIMESTAMP, /* include system clock */
Alan D. Brunelle9d5f09a2008-05-27 14:54:41 +020066 __BLK_TN_MESSAGE, /* Character string message */
Olaf Kirchbe1c6342006-12-01 10:39:12 +010067};
68
69
70/*
Jens Axboe2056a782006-03-23 20:00:26 +010071 * 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))
Mike Anderson11914a52008-09-13 20:31:27 +020088#define BLK_TA_ABORT (__BLK_TA_ABORT | BLK_TC_ACT(BLK_TC_QUEUE))
Stefan Raspl756f8242008-10-16 08:23:21 +020089#define BLK_TA_DRV_DATA (__BLK_TA_DRV_DATA | BLK_TC_ACT(BLK_TC_DRV_DATA))
Jens Axboe2056a782006-03-23 20:00:26 +010090
Olaf Kirchbe1c6342006-12-01 10:39:12 +010091#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))
Alan D. Brunelle9d5f09a2008-05-27 14:54:41 +020093#define BLK_TN_MESSAGE (__BLK_TN_MESSAGE | BLK_TC_ACT(BLK_TC_NOTIFY))
Olaf Kirchbe1c6342006-12-01 10:39:12 +010094
Jens Axboe2056a782006-03-23 20:00:26 +010095#define BLK_IO_TRACE_MAGIC 0x65617400
96#define BLK_IO_TRACE_VERSION 0x07
97
98/*
99 * The trace itself
100 */
101struct blk_io_trace {
Sven Schuetzc0ddffa2008-09-26 10:58:02 +0200102 __u32 magic; /* MAGIC << 8 | version */
103 __u32 sequence; /* event number */
104 __u64 time; /* in microseconds */
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 */
Jens Axboe2056a782006-03-23 20:00:26 +0100113};
114
115/*
116 * The remap event
117 */
118struct blk_io_trace_remap {
Alan D. Brunellec7149d62007-08-07 15:30:23 +0200119 __be32 device_from;
Alan D. Brunellea42aaa32009-05-04 16:27:26 -0400120 __be32 device_to;
121 __be64 sector_from;
Jens Axboe2056a782006-03-23 20:00:26 +0100122};
123
124enum {
125 Blktrace_setup = 1,
126 Blktrace_running,
127 Blktrace_stopped,
128};
129
Jens Axboe0497b342008-10-01 16:16:25 +0200130#define BLKTRACE_BDEV_SIZE 32
131
Sven Schuetzc0ddffa2008-09-26 10:58:02 +0200132/*
133 * User setup structure passed with BLKTRACESTART
134 */
135struct blk_user_trace_setup {
Jens Axboe0497b342008-10-01 16:16:25 +0200136 char name[BLKTRACE_BDEV_SIZE]; /* output */
Sven Schuetzc0ddffa2008-09-26 10:58:02 +0200137 __u16 act_mask; /* input */
138 __u32 buf_size; /* input */
139 __u32 buf_nr; /* input */
140 __u64 start_lba;
141 __u64 end_lba;
142 __u32 pid;
143};
144
145#ifdef __KERNEL__
146#if defined(CONFIG_BLK_DEV_IO_TRACE)
Arnaldo Carvalho de Melo157f9c02009-01-26 15:00:56 -0200147
148#include <linux/sysfs.h>
149
Jens Axboe2056a782006-03-23 20:00:26 +0100150struct blk_trace {
151 int trace_state;
152 struct rchan *rchan;
Tejun Heo43cf38e2010-02-02 14:38:57 +0900153 unsigned long __percpu *sequence;
154 unsigned char __percpu *msg_data;
Jens Axboe2056a782006-03-23 20:00:26 +0100155 u16 act_mask;
156 u64 start_lba;
157 u64 end_lba;
158 u32 pid;
159 u32 dev;
160 struct dentry *dir;
161 struct dentry *dropped_file;
Alan D. Brunelle02c62302008-06-11 09:12:52 +0200162 struct dentry *msg_file;
Jens Axboe2056a782006-03-23 20:00:26 +0100163 atomic_t dropped;
164};
165
Jens Axboe2056a782006-03-23 20:00:26 +0100166extern int blk_trace_ioctl(struct block_device *, unsigned, char __user *);
Jens Axboe165125e2007-07-24 09:28:11 +0200167extern void blk_trace_shutdown(struct request_queue *);
Shawn Dud0deef52009-04-14 13:58:56 +0800168extern int do_blk_trace_setup(struct request_queue *q, char *name,
169 dev_t dev, struct block_device *bdev,
170 struct blk_user_trace_setup *buts);
Alan D. Brunelle9d5f09a2008-05-27 14:54:41 +0200171extern void __trace_note_message(struct blk_trace *, const char *fmt, ...);
Arnd Bergmann171044d42007-10-09 13:23:53 +0200172
Alan D. Brunelle9d5f09a2008-05-27 14:54:41 +0200173/**
174 * blk_add_trace_msg - Add a (simple) message to the blktrace stream
175 * @q: queue the io is for
176 * @fmt: format to print message in
177 * args... Variable argument list for format
178 *
179 * Description:
180 * Records a (simple) message onto the blktrace stream.
181 *
182 * NOTE: BLK_TN_MAX_MSG characters are output at most.
183 * NOTE: Can not use 'static inline' due to presence of var args...
184 *
185 **/
186#define blk_add_trace_msg(q, fmt, ...) \
187 do { \
188 struct blk_trace *bt = (q)->blk_trace; \
189 if (unlikely(bt)) \
190 __trace_note_message(bt, fmt, ##__VA_ARGS__); \
191 } while (0)
Jens Axboe64565912008-05-28 14:45:33 +0200192#define BLK_TN_MAX_MSG 128
Jens Axboe2056a782006-03-23 20:00:26 +0100193
Arnaldo Carvalho de Melo5f3ea372008-10-30 08:34:33 +0100194extern void blk_add_driver_data(struct request_queue *q, struct request *rq,
195 void *data, size_t len);
Martin K. Petersen7da975a2008-01-29 19:12:06 +0100196extern int blk_trace_setup(struct request_queue *q, char *name, dev_t dev,
Shawn Dud0deef52009-04-14 13:58:56 +0800197 struct block_device *bdev,
Christof Schmitt6da127a2008-01-11 10:09:43 +0100198 char __user *arg);
Martin K. Petersen7da975a2008-01-29 19:12:06 +0100199extern int blk_trace_startstop(struct request_queue *q, int start);
200extern int blk_trace_remove(struct request_queue *q);
Zdenek Kabelac48c0d4d2009-09-25 06:19:26 +0200201extern void blk_trace_remove_sysfs(struct device *dev);
Li Zefan1d54ad62009-04-14 14:00:05 +0800202extern int blk_trace_init_sysfs(struct device *dev);
Christof Schmitt6da127a2008-01-11 10:09:43 +0100203
Arnaldo Carvalho de Melo157f9c02009-01-26 15:00:56 -0200204extern struct attribute_group blk_trace_attr_group;
205
Jens Axboe2056a782006-03-23 20:00:26 +0100206#else /* !CONFIG_BLK_DEV_IO_TRACE */
Shawn Dud0deef52009-04-14 13:58:56 +0800207# define blk_trace_ioctl(bdev, cmd, arg) (-ENOTTY)
208# define blk_trace_shutdown(q) do { } while (0)
209# define do_blk_trace_setup(q, name, dev, bdev, buts) (-ENOTTY)
210# define blk_add_driver_data(q, rq, data, len) do {} while (0)
211# define blk_trace_setup(q, name, dev, bdev, arg) (-ENOTTY)
212# define blk_trace_startstop(q, start) (-ENOTTY)
213# define blk_trace_remove(q) (-ENOTTY)
214# define blk_add_trace_msg(q, fmt, ...) do { } while (0)
Jun'ichi Nomurab0da3f02009-10-01 21:16:13 +0200215# define blk_trace_remove_sysfs(dev) do { } while (0)
Li Zefan1d54ad62009-04-14 14:00:05 +0800216static inline int blk_trace_init_sysfs(struct device *dev)
217{
218 return 0;
219}
220
Jens Axboe2056a782006-03-23 20:00:26 +0100221#endif /* CONFIG_BLK_DEV_IO_TRACE */
Shawn Dud0deef52009-04-14 13:58:56 +0800222
Li Zefanf1db4572009-06-10 10:06:24 +0800223#if defined(CONFIG_EVENT_TRACING) && defined(CONFIG_BLOCK)
Li Zefan55782132009-06-09 13:43:05 +0800224
225static inline int blk_cmd_buf_len(struct request *rq)
226{
227 return blk_pc_request(rq) ? rq->cmd_len * 3 : 1;
228}
229
230extern void blk_dump_cmd(char *buf, struct request *rq);
231extern void blk_fill_rwbs(char *rwbs, u32 rw, int bytes);
232extern void blk_fill_rwbs_rq(char *rwbs, struct request *rq);
233
Li Zefanf1db4572009-06-10 10:06:24 +0800234#endif /* CONFIG_EVENT_TRACING && CONFIG_BLOCK */
Li Zefan55782132009-06-09 13:43:05 +0800235
Arnd Bergmann171044d42007-10-09 13:23:53 +0200236#endif /* __KERNEL__ */
Jens Axboe2056a782006-03-23 20:00:26 +0100237#endif