blob: d2e908586e3d50322025806a61816d1ec1b56ece [file] [log] [blame]
Jens Axboe2056a782006-03-23 20:00:26 +01001#ifndef BLKTRACE_H
2#define BLKTRACE_H
3
Jens Axboe2056a782006-03-23 20:00:26 +01004#include <linux/blkdev.h>
5#include <linux/relay.h>
Arnd Bergmann62c2a7d2010-07-07 16:51:26 +02006#include <linux/compat.h>
David Howells607ca462012-10-13 10:46:48 +01007#include <uapi/linux/blktrace_api.h>
Jan Karaa404d552013-09-17 22:30:31 +02008#include <linux/list.h>
Jens Axboe2056a782006-03-23 20:00:26 +01009
Sven Schuetzc0ddffa2008-09-26 10:58:02 +020010#if defined(CONFIG_BLK_DEV_IO_TRACE)
Arnaldo Carvalho de Melo157f9c02009-01-26 15:00:56 -020011
12#include <linux/sysfs.h>
13
Jens Axboe2056a782006-03-23 20:00:26 +010014struct blk_trace {
15 int trace_state;
16 struct rchan *rchan;
Tejun Heo43cf38e2010-02-02 14:38:57 +090017 unsigned long __percpu *sequence;
18 unsigned char __percpu *msg_data;
Jens Axboe2056a782006-03-23 20:00:26 +010019 u16 act_mask;
20 u64 start_lba;
21 u64 end_lba;
22 u32 pid;
23 u32 dev;
24 struct dentry *dir;
25 struct dentry *dropped_file;
Alan D. Brunelle02c62302008-06-11 09:12:52 +020026 struct dentry *msg_file;
Jan Karaa404d552013-09-17 22:30:31 +020027 struct list_head running_list;
Jens Axboe2056a782006-03-23 20:00:26 +010028 atomic_t dropped;
29};
30
Jens Axboe2056a782006-03-23 20:00:26 +010031extern int blk_trace_ioctl(struct block_device *, unsigned, char __user *);
Jens Axboe165125e2007-07-24 09:28:11 +020032extern void blk_trace_shutdown(struct request_queue *);
Joe Perchesb9075fa2011-10-31 17:11:33 -070033extern __printf(2, 3)
Joe Perches08e81382011-06-13 10:42:49 +020034void __trace_note_message(struct blk_trace *, const char *fmt, ...);
Arnd Bergmann171044d42007-10-09 13:23:53 +020035
Alan D. Brunelle9d5f09a2008-05-27 14:54:41 +020036/**
37 * blk_add_trace_msg - Add a (simple) message to the blktrace stream
38 * @q: queue the io is for
39 * @fmt: format to print message in
40 * args... Variable argument list for format
41 *
42 * Description:
43 * Records a (simple) message onto the blktrace stream.
44 *
45 * NOTE: BLK_TN_MAX_MSG characters are output at most.
46 * NOTE: Can not use 'static inline' due to presence of var args...
47 *
48 **/
49#define blk_add_trace_msg(q, fmt, ...) \
50 do { \
51 struct blk_trace *bt = (q)->blk_trace; \
52 if (unlikely(bt)) \
53 __trace_note_message(bt, fmt, ##__VA_ARGS__); \
54 } while (0)
Jens Axboe64565912008-05-28 14:45:33 +020055#define BLK_TN_MAX_MSG 128
Jens Axboe2056a782006-03-23 20:00:26 +010056
Shaohua Li59fa0222016-05-09 17:22:15 -070057static inline bool blk_trace_note_message_enabled(struct request_queue *q)
58{
59 struct blk_trace *bt = q->blk_trace;
60 if (likely(!bt))
61 return false;
62 return bt->act_mask & BLK_TC_NOTIFY;
63}
64
Arnaldo Carvalho de Melo5f3ea372008-10-30 08:34:33 +010065extern void blk_add_driver_data(struct request_queue *q, struct request *rq,
66 void *data, size_t len);
Martin K. Petersen7da975a2008-01-29 19:12:06 +010067extern int blk_trace_setup(struct request_queue *q, char *name, dev_t dev,
Shawn Dud0deef52009-04-14 13:58:56 +080068 struct block_device *bdev,
Christof Schmitt6da127a2008-01-11 10:09:43 +010069 char __user *arg);
Martin K. Petersen7da975a2008-01-29 19:12:06 +010070extern int blk_trace_startstop(struct request_queue *q, int start);
71extern int blk_trace_remove(struct request_queue *q);
Zdenek Kabelac48c0d4d2009-09-25 06:19:26 +020072extern void blk_trace_remove_sysfs(struct device *dev);
Li Zefan1d54ad62009-04-14 14:00:05 +080073extern int blk_trace_init_sysfs(struct device *dev);
Christof Schmitt6da127a2008-01-11 10:09:43 +010074
Arnaldo Carvalho de Melo157f9c02009-01-26 15:00:56 -020075extern struct attribute_group blk_trace_attr_group;
76
Jens Axboe2056a782006-03-23 20:00:26 +010077#else /* !CONFIG_BLK_DEV_IO_TRACE */
Shawn Dud0deef52009-04-14 13:58:56 +080078# define blk_trace_ioctl(bdev, cmd, arg) (-ENOTTY)
79# define blk_trace_shutdown(q) do { } while (0)
Shawn Dud0deef52009-04-14 13:58:56 +080080# define blk_add_driver_data(q, rq, data, len) do {} while (0)
81# define blk_trace_setup(q, name, dev, bdev, arg) (-ENOTTY)
82# define blk_trace_startstop(q, start) (-ENOTTY)
83# define blk_trace_remove(q) (-ENOTTY)
84# define blk_add_trace_msg(q, fmt, ...) do { } while (0)
Jun'ichi Nomurab0da3f02009-10-01 21:16:13 +020085# define blk_trace_remove_sysfs(dev) do { } while (0)
Shaohua Li59fa0222016-05-09 17:22:15 -070086# define blk_trace_note_message_enabled(q) (false)
Li Zefan1d54ad62009-04-14 14:00:05 +080087static inline int blk_trace_init_sysfs(struct device *dev)
88{
89 return 0;
90}
91
Jens Axboe2056a782006-03-23 20:00:26 +010092#endif /* CONFIG_BLK_DEV_IO_TRACE */
Shawn Dud0deef52009-04-14 13:58:56 +080093
Stephen Rothwell2669b192010-07-09 14:24:38 +100094#ifdef CONFIG_COMPAT
95
96struct compat_blk_user_trace_setup {
Chen Gangf8c5e942013-11-03 22:23:39 +080097 char name[BLKTRACE_BDEV_SIZE];
Stephen Rothwell2669b192010-07-09 14:24:38 +100098 u16 act_mask;
99 u32 buf_size;
100 u32 buf_nr;
101 compat_u64 start_lba;
102 compat_u64 end_lba;
103 u32 pid;
104};
105#define BLKTRACESETUP32 _IOWR(0x12, 115, struct compat_blk_user_trace_setup)
106
107#endif
108
Christoph Hellwigef295ec2016-10-28 08:48:16 -0600109extern void blk_fill_rwbs(char *rwbs, unsigned int op, int bytes);
Li Zefan55782132009-06-09 13:43:05 +0800110
Christoph Hellwig48b77ad2017-01-27 09:35:54 +0100111static inline sector_t blk_rq_trace_sector(struct request *rq)
112{
Christoph Hellwig57292b52017-01-31 16:57:29 +0100113 return blk_rq_is_passthrough(rq) ? 0 : blk_rq_pos(rq);
Christoph Hellwig48b77ad2017-01-27 09:35:54 +0100114}
115
116static inline unsigned int blk_rq_trace_nr_sectors(struct request *rq)
117{
Christoph Hellwig57292b52017-01-31 16:57:29 +0100118 return blk_rq_is_passthrough(rq) ? 0 : blk_rq_sectors(rq);
Christoph Hellwig48b77ad2017-01-27 09:35:54 +0100119}
Li Zefan55782132009-06-09 13:43:05 +0800120
Jens Axboe2056a782006-03-23 20:00:26 +0100121#endif