[blktrace.git] / blktrace_api.h

#ifndef BLKTRACEAPI_H
#define BLKTRACEAPI_H

#include <asm/types.h>

/*
 * Trace categories
 */
enum {
	BLK_TC_READ	= 1 << 0,	/* reads */
	BLK_TC_WRITE	= 1 << 1,	/* writes */
	BLK_TC_BARRIER	= 1 << 2,	/* barrier */
	BLK_TC_SYNC	= 1 << 3,	/* sync */
	BLK_TC_QUEUE	= 1 << 4,	/* queueing/merging */
	BLK_TC_REQUEUE	= 1 << 5,	/* requeueing */
	BLK_TC_ISSUE	= 1 << 6,	/* issue */
	BLK_TC_COMPLETE	= 1 << 7,	/* completions */
	BLK_TC_FS	= 1 << 8,	/* fs requests */
	BLK_TC_PC	= 1 << 9,	/* pc requests */
	BLK_TC_NOTIFY	= 1 << 10,	/* special message */
	BLK_TC_AHEAD	= 1 << 11,	/* readahead */
	BLK_TC_META	= 1 << 12,	/* metadata */
	BLK_TC_DISCARD	= 1 << 13,	/* discard requests */
	BLK_TC_DRV_DATA	= 1 << 14,	/* binary driver data */

	BLK_TC_END	= 1 << 15,	/* only 16-bits, reminder */
};

#define BLK_TC_SHIFT		(16)
#define BLK_TC_ACT(act)		((act) << BLK_TC_SHIFT)

/*
 * Basic trace actions
 */
enum {
	__BLK_TA_QUEUE = 1,		/* queued */
	__BLK_TA_BACKMERGE,		/* back merged to existing rq */
	__BLK_TA_FRONTMERGE,		/* front merge to existing rq */
	__BLK_TA_GETRQ,			/* allocated new request */
	__BLK_TA_SLEEPRQ,		/* sleeping on rq allocation */
	__BLK_TA_REQUEUE,		/* request requeued */
	__BLK_TA_ISSUE,			/* sent to driver */
	__BLK_TA_COMPLETE,		/* completed by driver */
	__BLK_TA_PLUG,			/* queue was plugged */
	__BLK_TA_UNPLUG_IO,		/* queue was unplugged by io */
	__BLK_TA_UNPLUG_TIMER,		/* queue was unplugged by timer */
	__BLK_TA_INSERT,		/* insert request */
	__BLK_TA_SPLIT,			/* bio was split */
	__BLK_TA_BOUNCE,		/* bio was bounced */
	__BLK_TA_REMAP,			/* bio was remapped */
	__BLK_TA_ABORT,			/* request aborted */
	__BLK_TA_DRV_DATA,		/* binary driver data */
};

/*
 * Notify events.
 */
enum blktrace_notify {
	__BLK_TN_PROCESS = 0,		/* establish pid/name mapping */
	__BLK_TN_TIMESTAMP,		/* include system clock */
	__BLK_TN_MESSAGE,               /* Character string message */
};

/*
 * Trace actions in full. Additionally, read or write is masked
 */
#define BLK_TA_QUEUE		(__BLK_TA_QUEUE | BLK_TC_ACT(BLK_TC_QUEUE))
#define BLK_TA_BACKMERGE	(__BLK_TA_BACKMERGE | BLK_TC_ACT(BLK_TC_QUEUE))
#define BLK_TA_FRONTMERGE	(__BLK_TA_FRONTMERGE | BLK_TC_ACT(BLK_TC_QUEUE))
#define	BLK_TA_GETRQ		(__BLK_TA_GETRQ | BLK_TC_ACT(BLK_TC_QUEUE))
#define	BLK_TA_SLEEPRQ		(__BLK_TA_SLEEPRQ | BLK_TC_ACT(BLK_TC_QUEUE))
#define	BLK_TA_REQUEUE		(__BLK_TA_REQUEUE | BLK_TC_ACT(BLK_TC_REQUEUE))
#define BLK_TA_ISSUE		(__BLK_TA_ISSUE | BLK_TC_ACT(BLK_TC_ISSUE))
#define BLK_TA_COMPLETE		(__BLK_TA_COMPLETE| BLK_TC_ACT(BLK_TC_COMPLETE))
#define BLK_TA_PLUG		(__BLK_TA_PLUG | BLK_TC_ACT(BLK_TC_QUEUE))
#define BLK_TA_UNPLUG_IO	(__BLK_TA_UNPLUG_IO | BLK_TC_ACT(BLK_TC_QUEUE))
#define BLK_TA_UNPLUG_TIMER	(__BLK_TA_UNPLUG_TIMER | BLK_TC_ACT(BLK_TC_QUEUE))
#define BLK_TA_INSERT		(__BLK_TA_INSERT | BLK_TC_ACT(BLK_TC_QUEUE))
#define BLK_TA_SPLIT		(__BLK_TA_SPLIT)
#define BLK_TA_BOUNCE		(__BLK_TA_BOUNCE)
#define BLK_TA_REMAP		(__BLK_TA_REMAP | BLK_TC_ACT(BLK_TC_QUEUE))
#define BLK_TA_ABORT		(__BLK_TA_ABORT | BLK_TC_ACT(BLK_TC_QUEUE))
#define BLK_TA_DRV_DATA		(__BLK_TA_DRV_DATA | BLK_TC_ACT(BLK_TC_DRV_DATA))

#define BLK_TN_PROCESS		(__BLK_TN_PROCESS | BLK_TC_ACT(BLK_TC_NOTIFY))
#define BLK_TN_TIMESTAMP	(__BLK_TN_TIMESTAMP | BLK_TC_ACT(BLK_TC_NOTIFY))
#define BLK_TN_MESSAGE		(__BLK_TN_MESSAGE | BLK_TC_ACT(BLK_TC_NOTIFY))

#define BLK_IO_TRACE_MAGIC	0x65617400
#define BLK_IO_TRACE_VERSION	0x07

/*
 * The trace itself
 */
struct blk_io_trace {
	__u32 magic;		/* MAGIC << 8 | version */
	__u32 sequence;		/* event number */
	__u64 time;		/* in nanoseconds */
	__u64 sector;		/* disk offset */
	__u32 bytes;		/* transfer length */
	__u32 action;		/* what happened */
	__u32 pid;		/* who did it */
	__u32 device;		/* device identifier (dev_t) */
	__u32 cpu;		/* on what cpu did it happen */
	__u16 error;		/* completion error */
	__u16 pdu_len;		/* length of data after this trace */
};

/*
 * The remap event
 */
struct blk_io_trace_remap {
	__u32 device;
	__u32 device_from;
	__u64 sector;
};

/*
 * User setup structure passed with BLKSTARTTRACE
 */
struct blk_user_trace_setup {
	char name[32];			/* output */
	__u16 act_mask;			/* input */
	__u32 buf_size;			/* input */
	__u32 buf_nr;			/* input */
	__u64 start_lba;
	__u64 end_lba;
	__u32 pid;
};

#define BLKTRACESETUP _IOWR(0x12,115,struct blk_user_trace_setup)
#define BLKTRACESTART _IO(0x12,116)
#define BLKTRACESTOP _IO(0x12,117)
#define BLKTRACETEARDOWN _IO(0x12,118)

#endif
Commit	Line	Data
6fe4709e JA	1	#ifndef BLKTRACEAPI_H
	2	#define BLKTRACEAPI_H
	3
	4	#include <asm/types.h>
	5
	6	/*
	7	* Trace categories
	8	*/
	9	enum {
	10	BLK_TC_READ = 1 << 0, /* reads */
	11	BLK_TC_WRITE = 1 << 1, /* writes */
	12	BLK_TC_BARRIER = 1 << 2, /* barrier */
f86990ed	13	BLK_TC_SYNC = 1 << 3, /* sync */
6fe4709e JA	14	BLK_TC_QUEUE = 1 << 4, /* queueing/merging */
	15	BLK_TC_REQUEUE = 1 << 5, /* requeueing */
	16	BLK_TC_ISSUE = 1 << 6, /* issue */
	17	BLK_TC_COMPLETE = 1 << 7, /* completions */
	18	BLK_TC_FS = 1 << 8, /* fs requests */
	19	BLK_TC_PC = 1 << 9, /* pc requests */
bfc70ad5	20	BLK_TC_NOTIFY = 1 << 10, /* special message */
f86990ed	21	BLK_TC_AHEAD = 1 << 11, /* readahead */
711e4d25	22	BLK_TC_META = 1 << 12, /* metadata */
37081bf5	23	BLK_TC_DISCARD = 1 << 13, /* discard requests */
c54b9dd9	24	BLK_TC_DRV_DATA = 1 << 14, /* binary driver data */
6fe4709e JA	25
	26	BLK_TC_END = 1 << 15, /* only 16-bits, reminder */
	27	};
	28
	29	#define BLK_TC_SHIFT (16)
	30	#define BLK_TC_ACT(act) ((act) << BLK_TC_SHIFT)
	31
	32	/*
	33	* Basic trace actions
	34	*/
	35	enum {
	36	__BLK_TA_QUEUE = 1, /* queued */
	37	__BLK_TA_BACKMERGE, /* back merged to existing rq */
	38	__BLK_TA_FRONTMERGE, /* front merge to existing rq */
	39	__BLK_TA_GETRQ, /* allocated new request */
	40	__BLK_TA_SLEEPRQ, /* sleeping on rq allocation */
	41	__BLK_TA_REQUEUE, /* request requeued */
	42	__BLK_TA_ISSUE, /* sent to driver */
	43	__BLK_TA_COMPLETE, /* completed by driver */
88b1a526	44	__BLK_TA_PLUG, /* queue was plugged */
3639a11e JA	45	__BLK_TA_UNPLUG_IO, /* queue was unplugged by io */
3639a11e JA	46	__BLK_TA_UNPLUG_TIMER, /* queue was unplugged by timer */
b6076a9b	47	__BLK_TA_INSERT, /* insert request */
93f1c611 JA	48	__BLK_TA_SPLIT, /* bio was split */
93f1c611 JA	49	__BLK_TA_BOUNCE, /* bio was bounced */
a8f30e64	50	__BLK_TA_REMAP, /* bio was remapped */
b3ee499d	51	__BLK_TA_ABORT, /* request aborted */
c54b9dd9	52	__BLK_TA_DRV_DATA, /* binary driver data */
6fe4709e JA	53	};
6fe4709e JA	54
7bd4fd0a OK	55	/*
	56	* Notify events.
	57	*/
	58	enum blktrace_notify {
	59	__BLK_TN_PROCESS = 0, /* establish pid/name mapping */
	60	__BLK_TN_TIMESTAMP, /* include system clock */
1a15f6a8	61	__BLK_TN_MESSAGE, /* Character string message */
7bd4fd0a OK	62	};
7bd4fd0a OK	63
6fe4709e JA	64	/*
	65	* Trace actions in full. Additionally, read or write is masked
	66	*/
	67	#define BLK_TA_QUEUE (__BLK_TA_QUEUE \| BLK_TC_ACT(BLK_TC_QUEUE))
	68	#define BLK_TA_BACKMERGE (__BLK_TA_BACKMERGE \| BLK_TC_ACT(BLK_TC_QUEUE))
	69	#define BLK_TA_FRONTMERGE (__BLK_TA_FRONTMERGE \| BLK_TC_ACT(BLK_TC_QUEUE))
	70	#define BLK_TA_GETRQ (__BLK_TA_GETRQ \| BLK_TC_ACT(BLK_TC_QUEUE))
	71	#define BLK_TA_SLEEPRQ (__BLK_TA_SLEEPRQ \| BLK_TC_ACT(BLK_TC_QUEUE))
	72	#define BLK_TA_REQUEUE (__BLK_TA_REQUEUE \| BLK_TC_ACT(BLK_TC_REQUEUE))
	73	#define BLK_TA_ISSUE (__BLK_TA_ISSUE \| BLK_TC_ACT(BLK_TC_ISSUE))
	74	#define BLK_TA_COMPLETE (__BLK_TA_COMPLETE\| BLK_TC_ACT(BLK_TC_COMPLETE))
88b1a526	75	#define BLK_TA_PLUG (__BLK_TA_PLUG \| BLK_TC_ACT(BLK_TC_QUEUE))
3639a11e JA	76	#define BLK_TA_UNPLUG_IO (__BLK_TA_UNPLUG_IO \| BLK_TC_ACT(BLK_TC_QUEUE))
3639a11e JA	77	#define BLK_TA_UNPLUG_TIMER (__BLK_TA_UNPLUG_TIMER \| BLK_TC_ACT(BLK_TC_QUEUE))
b6076a9b	78	#define BLK_TA_INSERT (__BLK_TA_INSERT \| BLK_TC_ACT(BLK_TC_QUEUE))
93f1c611 JA	79	#define BLK_TA_SPLIT (__BLK_TA_SPLIT)
93f1c611 JA	80	#define BLK_TA_BOUNCE (__BLK_TA_BOUNCE)
a8f30e64	81	#define BLK_TA_REMAP (__BLK_TA_REMAP \| BLK_TC_ACT(BLK_TC_QUEUE))
b3ee499d	82	#define BLK_TA_ABORT (__BLK_TA_ABORT \| BLK_TC_ACT(BLK_TC_QUEUE))
c54b9dd9	83	#define BLK_TA_DRV_DATA (__BLK_TA_DRV_DATA \| BLK_TC_ACT(BLK_TC_DRV_DATA))
6fe4709e	84
7bd4fd0a OK	85	#define BLK_TN_PROCESS (__BLK_TN_PROCESS \| BLK_TC_ACT(BLK_TC_NOTIFY))
7bd4fd0a OK	86	#define BLK_TN_TIMESTAMP (__BLK_TN_TIMESTAMP \| BLK_TC_ACT(BLK_TC_NOTIFY))
1a15f6a8	87	#define BLK_TN_MESSAGE (__BLK_TN_MESSAGE \| BLK_TC_ACT(BLK_TC_NOTIFY))
7bd4fd0a	88
6fe4709e	89	#define BLK_IO_TRACE_MAGIC 0x65617400
bfc70ad5	90	#define BLK_IO_TRACE_VERSION 0x07
6fe4709e JA	91
	92	/*
	93	* The trace itself
	94	*/
	95	struct blk_io_trace {
	96	__u32 magic; /* MAGIC << 8 \| version */
	97	__u32 sequence; /* event number */
f8fd8985	98	__u64 time; /* in nanoseconds */
6fe4709e JA	99	__u64 sector; /* disk offset */
	100	__u32 bytes; /* transfer length */
	101	__u32 action; /* what happened */
	102	__u32 pid; /* who did it */
bfc70ad5	103	__u32 device; /* device identifier (dev_t) */
654aaa52	104	__u32 cpu; /* on what cpu did it happen */
6fe4709e JA	105	__u16 error; /* completion error */
	106	__u16 pdu_len; /* length of data after this trace */
	107	};
	108
a8f30e64 JA	109	/*
	110	* The remap event
	111	*/
	112	struct blk_io_trace_remap {
	113	__u32 device;
97d13fb0	114	__u32 device_from;
a8f30e64 JA	115	__u64 sector;
	116	};
	117
6fe4709e JA	118	/*
	119	* User setup structure passed with BLKSTARTTRACE
	120	*/
	121	struct blk_user_trace_setup {
	122	char name[32]; /* output */
	123	__u16 act_mask; /* input */
	124	__u32 buf_size; /* input */
	125	__u32 buf_nr; /* input */
6c8d81e4 JA	126	__u64 start_lba;
	127	__u64 end_lba;
	128	__u32 pid;
6fe4709e JA	129	};
6fe4709e JA	130
ed71a31e JA	131	#define BLKTRACESETUP _IOWR(0x12,115,struct blk_user_trace_setup)
	132	#define BLKTRACESTART _IO(0x12,116)
	133	#define BLKTRACESTOP _IO(0x12,117)
	134	#define BLKTRACETEARDOWN _IO(0x12,118)
6fe4709e JA	135
6fe4709e JA	136	#endif