[linux-2.6-block.git] / include / linux / blktrace_api.h

#ifndef BLKTRACE_H
#define BLKTRACE_H

#include <linux/blkdev.h>
#include <linux/relay.h>
#include <linux/compat.h>
#include <uapi/linux/blktrace_api.h>
#include <linux/list.h>

#if defined(CONFIG_BLK_DEV_IO_TRACE)

#include <linux/sysfs.h>

struct blk_trace {
	int trace_state;
	struct rchan *rchan;
	unsigned long __percpu *sequence;
	unsigned char __percpu *msg_data;
	u16 act_mask;
	u64 start_lba;
	u64 end_lba;
	u32 pid;
	u32 dev;
	struct dentry *dir;
	struct dentry *dropped_file;
	struct dentry *msg_file;
	struct list_head running_list;
	atomic_t dropped;
};

extern int blk_trace_ioctl(struct block_device *, unsigned, char __user *);
extern void blk_trace_shutdown(struct request_queue *);
extern int do_blk_trace_setup(struct request_queue *q, char *name,
			      dev_t dev, struct block_device *bdev,
			      struct blk_user_trace_setup *buts);
extern __printf(2, 3)
void __trace_note_message(struct blk_trace *, const char *fmt, ...);

/**
 * blk_add_trace_msg - Add a (simple) message to the blktrace stream
 * @q:		queue the io is for
 * @fmt:	format to print message in
 * args...	Variable argument list for format
 *
 * Description:
 *     Records a (simple) message onto the blktrace stream.
 *
 *     NOTE: BLK_TN_MAX_MSG characters are output at most.
 *     NOTE: Can not use 'static inline' due to presence of var args...
 *
 **/
#define blk_add_trace_msg(q, fmt, ...)					\
	do {								\
		struct blk_trace *bt = (q)->blk_trace;			\
		if (unlikely(bt))					\
			__trace_note_message(bt, fmt, ##__VA_ARGS__);	\
	} while (0)
#define BLK_TN_MAX_MSG		128

static inline bool blk_trace_note_message_enabled(struct request_queue *q)
{
	struct blk_trace *bt = q->blk_trace;
	if (likely(!bt))
		return false;
	return bt->act_mask & BLK_TC_NOTIFY;
}

extern void blk_add_driver_data(struct request_queue *q, struct request *rq,
				void *data, size_t len);
extern int blk_trace_setup(struct request_queue *q, char *name, dev_t dev,
			   struct block_device *bdev,
			   char __user *arg);
extern int blk_trace_startstop(struct request_queue *q, int start);
extern int blk_trace_remove(struct request_queue *q);
extern void blk_trace_remove_sysfs(struct device *dev);
extern int blk_trace_init_sysfs(struct device *dev);

extern struct attribute_group blk_trace_attr_group;

#else /* !CONFIG_BLK_DEV_IO_TRACE */
# define blk_trace_ioctl(bdev, cmd, arg)		(-ENOTTY)
# define blk_trace_shutdown(q)				do { } while (0)
# define do_blk_trace_setup(q, name, dev, bdev, buts)	(-ENOTTY)
# define blk_add_driver_data(q, rq, data, len)		do {} while (0)
# define blk_trace_setup(q, name, dev, bdev, arg)	(-ENOTTY)
# define blk_trace_startstop(q, start)			(-ENOTTY)
# define blk_trace_remove(q)				(-ENOTTY)
# define blk_add_trace_msg(q, fmt, ...)			do { } while (0)
# define blk_trace_remove_sysfs(dev)			do { } while (0)
# define blk_trace_note_message_enabled(q)		(false)
static inline int blk_trace_init_sysfs(struct device *dev)
{
	return 0;
}

#endif /* CONFIG_BLK_DEV_IO_TRACE */

#ifdef CONFIG_COMPAT

struct compat_blk_user_trace_setup {
	char name[BLKTRACE_BDEV_SIZE];
	u16 act_mask;
	u32 buf_size;
	u32 buf_nr;
	compat_u64 start_lba;
	compat_u64 end_lba;
	u32 pid;
};
#define BLKTRACESETUP32 _IOWR(0x12, 115, struct compat_blk_user_trace_setup)

#endif

#if defined(CONFIG_EVENT_TRACING) && defined(CONFIG_BLOCK)

static inline int blk_cmd_buf_len(struct request *rq)
{
	return (rq->cmd_type == REQ_TYPE_BLOCK_PC) ? rq->cmd_len * 3 : 1;
}

extern void blk_dump_cmd(char *buf, struct request *rq);
extern void blk_fill_rwbs(char *rwbs, u32 rw, int bytes);

#endif /* CONFIG_EVENT_TRACING && CONFIG_BLOCK */

#endif
Commit	Line	Data
2056a782 JA	1	#ifndef BLKTRACE_H
	2	#define BLKTRACE_H
	3
2056a782 JA	4	#include <linux/blkdev.h>
2056a782 JA	5	#include <linux/relay.h>
62c2a7d9	6	#include <linux/compat.h>
607ca46e	7	#include <uapi/linux/blktrace_api.h>
a404d557	8	#include <linux/list.h>
c0ddffa8	9
c0ddffa8	10	#if defined(CONFIG_BLK_DEV_IO_TRACE)
157f9c00 ACM	11
	12	#include <linux/sysfs.h>
	13
2056a782 JA	14	struct blk_trace {
	15	int trace_state;
	16	struct rchan *rchan;
43cf38eb TH	17	unsigned long __percpu *sequence;
43cf38eb TH	18	unsigned char __percpu *msg_data;
2056a782 JA	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;
02c62304	26	struct dentry *msg_file;
a404d557	27	struct list_head running_list;
2056a782 JA	28	atomic_t dropped;
	29	};
	30
2056a782	31	extern int blk_trace_ioctl(struct block_device , unsigned, char __user );
165125e1	32	extern void blk_trace_shutdown(struct request_queue *);
d0deef5b SD	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);
b9075fa9	36	extern __printf(2, 3)
08e8138a	37	void __trace_note_message(struct blk_trace , const char fmt, ...);
171044d4	38
9d5f09a4 AB	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 = (q)->blk_trace; \
	55	if (unlikely(bt)) \
	56	__trace_note_message(bt, fmt, ##__VA_ARGS__); \
	57	} while (0)
64565911	58	#define BLK_TN_MAX_MSG 128
2056a782	59
59fa0224 SL	60	static inline bool blk_trace_note_message_enabled(struct request_queue *q)
	61	{
	62	struct blk_trace *bt = q->blk_trace;
	63	if (likely(!bt))
	64	return false;
	65	return bt->act_mask & BLK_TC_NOTIFY;
	66	}
	67
5f3ea37c ACM	68	extern void blk_add_driver_data(struct request_queue q, struct request rq,
5f3ea37c ACM	69	void *data, size_t len);
7da975a2	70	extern int blk_trace_setup(struct request_queue q, char name, dev_t dev,
d0deef5b	71	struct block_device *bdev,
6da127ad	72	char __user *arg);
7da975a2 MP	73	extern int blk_trace_startstop(struct request_queue *q, int start);
7da975a2 MP	74	extern int blk_trace_remove(struct request_queue *q);
48c0d4d4	75	extern void blk_trace_remove_sysfs(struct device *dev);
1d54ad6d	76	extern int blk_trace_init_sysfs(struct device *dev);
6da127ad	77
157f9c00 ACM	78	extern struct attribute_group blk_trace_attr_group;
157f9c00 ACM	79
2056a782	80	#else /* !CONFIG_BLK_DEV_IO_TRACE */
d0deef5b SD	81	# define blk_trace_ioctl(bdev, cmd, arg) (-ENOTTY)
	82	# define blk_trace_shutdown(q) do { } while (0)
	83	# define do_blk_trace_setup(q, name, dev, bdev, buts) (-ENOTTY)
	84	# define blk_add_driver_data(q, rq, data, len) do {} while (0)
	85	# define blk_trace_setup(q, name, dev, bdev, arg) (-ENOTTY)
	86	# define blk_trace_startstop(q, start) (-ENOTTY)
	87	# define blk_trace_remove(q) (-ENOTTY)
	88	# define blk_add_trace_msg(q, fmt, ...) do { } while (0)
b0da3f0d	89	# define blk_trace_remove_sysfs(dev) do { } while (0)
59fa0224	90	# define blk_trace_note_message_enabled(q) (false)
1d54ad6d LZ	91	static inline int blk_trace_init_sysfs(struct device *dev)
	92	{
	93	return 0;
	94	}
	95
2056a782	96	#endif /* CONFIG_BLK_DEV_IO_TRACE */
d0deef5b	97
2669b19f SR	98	#ifdef CONFIG_COMPAT
	99
	100	struct compat_blk_user_trace_setup {
f8c5e944	101	char name[BLKTRACE_BDEV_SIZE];
2669b19f SR	102	u16 act_mask;
	103	u32 buf_size;
	104	u32 buf_nr;
	105	compat_u64 start_lba;
	106	compat_u64 end_lba;
	107	u32 pid;
	108	};
	109	#define BLKTRACESETUP32 _IOWR(0x12, 115, struct compat_blk_user_trace_setup)
	110
	111	#endif
	112
f1db457c	113	#if defined(CONFIG_EVENT_TRACING) && defined(CONFIG_BLOCK)
55782138 LZ	114
	115	static inline int blk_cmd_buf_len(struct request *rq)
	116	{
33659ebb	117	return (rq->cmd_type == REQ_TYPE_BLOCK_PC) ? rq->cmd_len * 3 : 1;
55782138 LZ	118	}
	119
	120	extern void blk_dump_cmd(char buf, struct request rq);
	121	extern void blk_fill_rwbs(char *rwbs, u32 rw, int bytes);
55782138	122
f1db457c	123	#endif /* CONFIG_EVENT_TRACING && CONFIG_BLOCK */
55782138	124
2056a782	125	#endif