GNU Linux-libre 4.9.294-gnu1
[releases.git] / include / linux / blktrace_api.h
1 #ifndef BLKTRACE_H
2 #define BLKTRACE_H
3
4 #include <linux/blkdev.h>
5 #include <linux/relay.h>
6 #include <linux/compat.h>
7 #include <uapi/linux/blktrace_api.h>
8 #include <linux/list.h>
9
10 #if defined(CONFIG_BLK_DEV_IO_TRACE)
11
12 #include <linux/sysfs.h>
13
14 struct blk_trace {
15         int trace_state;
16         struct rchan *rchan;
17         unsigned long __percpu *sequence;
18         unsigned char __percpu *msg_data;
19         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;
26         struct dentry *msg_file;
27         struct list_head running_list;
28         atomic_t dropped;
29 };
30
31 extern int blk_trace_ioctl(struct block_device *, unsigned, char __user *);
32 extern void blk_trace_shutdown(struct request_queue *);
33 extern int do_blk_trace_setup(struct request_queue *q, char *name,
34                               dev_t dev, struct block_device *bdev,
35                               struct blk_user_trace_setup *buts);
36 extern __printf(2, 3)
37 void __trace_note_message(struct blk_trace *, const char *fmt, ...);
38
39 /**
40  * blk_add_trace_msg - Add a (simple) message to the blktrace stream
41  * @q:          queue the io is for
42  * @fmt:        format to print message in
43  * args...      Variable argument list for format
44  *
45  * Description:
46  *     Records a (simple) message onto the blktrace stream.
47  *
48  *     NOTE: BLK_TN_MAX_MSG characters are output at most.
49  *     NOTE: Can not use 'static inline' due to presence of var args...
50  *
51  **/
52 #define blk_add_trace_msg(q, fmt, ...)                                  \
53         do {                                                            \
54                 struct blk_trace *bt;                                   \
55                                                                         \
56                 rcu_read_lock();                                        \
57                 bt = rcu_dereference((q)->blk_trace);                   \
58                 if (unlikely(bt))                                       \
59                         __trace_note_message(bt, fmt, ##__VA_ARGS__);   \
60                 rcu_read_unlock();                                      \
61         } while (0)
62 #define BLK_TN_MAX_MSG          128
63
64 static inline bool blk_trace_note_message_enabled(struct request_queue *q)
65 {
66         struct blk_trace *bt;
67         bool ret;
68
69         rcu_read_lock();
70         bt = rcu_dereference(q->blk_trace);
71         ret = bt && (bt->act_mask & BLK_TC_NOTIFY);
72         rcu_read_unlock();
73         return ret;
74 }
75
76 extern void blk_add_driver_data(struct request_queue *q, struct request *rq,
77                                 void *data, size_t len);
78 extern int blk_trace_setup(struct request_queue *q, char *name, dev_t dev,
79                            struct block_device *bdev,
80                            char __user *arg);
81 extern int blk_trace_startstop(struct request_queue *q, int start);
82 extern int blk_trace_remove(struct request_queue *q);
83 extern void blk_trace_remove_sysfs(struct device *dev);
84 extern int blk_trace_init_sysfs(struct device *dev);
85
86 extern struct attribute_group blk_trace_attr_group;
87
88 #else /* !CONFIG_BLK_DEV_IO_TRACE */
89 # define blk_trace_ioctl(bdev, cmd, arg)                (-ENOTTY)
90 # define blk_trace_shutdown(q)                          do { } while (0)
91 # define do_blk_trace_setup(q, name, dev, bdev, buts)   (-ENOTTY)
92 # define blk_add_driver_data(q, rq, data, len)          do {} while (0)
93 # define blk_trace_setup(q, name, dev, bdev, arg)       (-ENOTTY)
94 # define blk_trace_startstop(q, start)                  (-ENOTTY)
95 # define blk_trace_remove(q)                            (-ENOTTY)
96 # define blk_add_trace_msg(q, fmt, ...)                 do { } while (0)
97 # define blk_trace_remove_sysfs(dev)                    do { } while (0)
98 # define blk_trace_note_message_enabled(q)              (false)
99 static inline int blk_trace_init_sysfs(struct device *dev)
100 {
101         return 0;
102 }
103
104 #endif /* CONFIG_BLK_DEV_IO_TRACE */
105
106 #ifdef CONFIG_COMPAT
107
108 struct compat_blk_user_trace_setup {
109         char name[BLKTRACE_BDEV_SIZE];
110         u16 act_mask;
111         u32 buf_size;
112         u32 buf_nr;
113         compat_u64 start_lba;
114         compat_u64 end_lba;
115         u32 pid;
116 };
117 #define BLKTRACESETUP32 _IOWR(0x12, 115, struct compat_blk_user_trace_setup)
118
119 #endif
120
121 #if defined(CONFIG_EVENT_TRACING) && defined(CONFIG_BLOCK)
122
123 static inline int blk_cmd_buf_len(struct request *rq)
124 {
125         return (rq->cmd_type == REQ_TYPE_BLOCK_PC) ? rq->cmd_len * 3 : 1;
126 }
127
128 extern void blk_dump_cmd(char *buf, struct request *rq);
129 extern void blk_fill_rwbs(char *rwbs, int op, u32 rw, int bytes);
130
131 #endif /* CONFIG_EVENT_TRACING && CONFIG_BLOCK */
132
133 #endif