[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_FLUSH	= 1 << 2,	/* flush */
	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_FUA	= 1 << 15,	/* fua requests */

	BLK_TC_END	= 1 << 15,	/* we've run out of bits! */
};

#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 */
	__BLK_TA_CGROUP = 1 << 8,
};

/*
 * 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 */
	__BLK_TN_CGROUP = __BLK_TA_CGROUP,
};

/*
 * 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_from;
	__u32 device_to;
	__u64 sector_from;
};

/*
 * Payload with originating cgroup info
 */
struct blk_io_cgroup_payload {
	__u32 ino;
	__u32 gen;
};

/*
 * 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
	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_FLUSH = 1 << 2, /* flush */
	13	BLK_TC_SYNC = 1 << 3, /* sync */
	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 */
	20	BLK_TC_NOTIFY = 1 << 10, /* special message */
	21	BLK_TC_AHEAD = 1 << 11, /* readahead */
	22	BLK_TC_META = 1 << 12, /* metadata */
	23	BLK_TC_DISCARD = 1 << 13, /* discard requests */
	24	BLK_TC_DRV_DATA = 1 << 14, /* binary driver data */
	25	BLK_TC_FUA = 1 << 15, /* fua requests */
	26
	27	BLK_TC_END = 1 << 15, /* we've run out of bits! */
	28	};
	29
	30	#define BLK_TC_SHIFT (16)
	31	#define BLK_TC_ACT(act) ((act) << BLK_TC_SHIFT)
	32
	33	/*
	34	* Basic trace actions
	35	*/
	36	enum {
	37	__BLK_TA_QUEUE = 1, /* queued */
	38	__BLK_TA_BACKMERGE, /* back merged to existing rq */
	39	__BLK_TA_FRONTMERGE, /* front merge to existing rq */
	40	__BLK_TA_GETRQ, /* allocated new request */
	41	__BLK_TA_SLEEPRQ, /* sleeping on rq allocation */
	42	__BLK_TA_REQUEUE, /* request requeued */
	43	__BLK_TA_ISSUE, /* sent to driver */
	44	__BLK_TA_COMPLETE, /* completed by driver */
	45	__BLK_TA_PLUG, /* queue was plugged */
	46	__BLK_TA_UNPLUG_IO, /* queue was unplugged by io */
	47	__BLK_TA_UNPLUG_TIMER, /* queue was unplugged by timer */
	48	__BLK_TA_INSERT, /* insert request */
	49	__BLK_TA_SPLIT, /* bio was split */
	50	__BLK_TA_BOUNCE, /* bio was bounced */
	51	__BLK_TA_REMAP, /* bio was remapped */
	52	__BLK_TA_ABORT, /* request aborted */
	53	__BLK_TA_DRV_DATA, /* binary driver data */
	54	__BLK_TA_CGROUP = 1 << 8,
	55	};
	56
	57	/*
	58	* Notify events.
	59	*/
	60	enum blktrace_notify {
	61	__BLK_TN_PROCESS = 0, /* establish pid/name mapping */
	62	__BLK_TN_TIMESTAMP, /* include system clock */
	63	__BLK_TN_MESSAGE, /* Character string message */
	64	__BLK_TN_CGROUP = __BLK_TA_CGROUP,
	65	};
	66
	67	/*
	68	* Trace actions in full. Additionally, read or write is masked
	69	*/
	70	#define BLK_TA_QUEUE (__BLK_TA_QUEUE \| BLK_TC_ACT(BLK_TC_QUEUE))
	71	#define BLK_TA_BACKMERGE (__BLK_TA_BACKMERGE \| BLK_TC_ACT(BLK_TC_QUEUE))
	72	#define BLK_TA_FRONTMERGE (__BLK_TA_FRONTMERGE \| BLK_TC_ACT(BLK_TC_QUEUE))
	73	#define BLK_TA_GETRQ (__BLK_TA_GETRQ \| BLK_TC_ACT(BLK_TC_QUEUE))
	74	#define BLK_TA_SLEEPRQ (__BLK_TA_SLEEPRQ \| BLK_TC_ACT(BLK_TC_QUEUE))
	75	#define BLK_TA_REQUEUE (__BLK_TA_REQUEUE \| BLK_TC_ACT(BLK_TC_REQUEUE))
	76	#define BLK_TA_ISSUE (__BLK_TA_ISSUE \| BLK_TC_ACT(BLK_TC_ISSUE))
	77	#define BLK_TA_COMPLETE (__BLK_TA_COMPLETE\| BLK_TC_ACT(BLK_TC_COMPLETE))
	78	#define BLK_TA_PLUG (__BLK_TA_PLUG \| BLK_TC_ACT(BLK_TC_QUEUE))
	79	#define BLK_TA_UNPLUG_IO (__BLK_TA_UNPLUG_IO \| BLK_TC_ACT(BLK_TC_QUEUE))
	80	#define BLK_TA_UNPLUG_TIMER (__BLK_TA_UNPLUG_TIMER \| BLK_TC_ACT(BLK_TC_QUEUE))
	81	#define BLK_TA_INSERT (__BLK_TA_INSERT \| BLK_TC_ACT(BLK_TC_QUEUE))
	82	#define BLK_TA_SPLIT (__BLK_TA_SPLIT)
	83	#define BLK_TA_BOUNCE (__BLK_TA_BOUNCE)
	84	#define BLK_TA_REMAP (__BLK_TA_REMAP \| BLK_TC_ACT(BLK_TC_QUEUE))
	85	#define BLK_TA_ABORT (__BLK_TA_ABORT \| BLK_TC_ACT(BLK_TC_QUEUE))
	86	#define BLK_TA_DRV_DATA (__BLK_TA_DRV_DATA \| BLK_TC_ACT(BLK_TC_DRV_DATA))
	87
	88	#define BLK_TN_PROCESS (__BLK_TN_PROCESS \| BLK_TC_ACT(BLK_TC_NOTIFY))
	89	#define BLK_TN_TIMESTAMP (__BLK_TN_TIMESTAMP \| BLK_TC_ACT(BLK_TC_NOTIFY))
	90	#define BLK_TN_MESSAGE (__BLK_TN_MESSAGE \| BLK_TC_ACT(BLK_TC_NOTIFY))
	91
	92	#define BLK_IO_TRACE_MAGIC 0x65617400
	93	#define BLK_IO_TRACE_VERSION 0x07
	94
	95	/*
	96	* The trace itself
	97	*/
	98	struct blk_io_trace {
	99	__u32 magic; /* MAGIC << 8 \| version */
	100	__u32 sequence; /* event number */
	101	__u64 time; /* in nanoseconds */
	102	__u64 sector; /* disk offset */
	103	__u32 bytes; /* transfer length */
	104	__u32 action; /* what happened */
	105	__u32 pid; /* who did it */
	106	__u32 device; /* device identifier (dev_t) */
	107	__u32 cpu; /* on what cpu did it happen */
	108	__u16 error; /* completion error */
	109	__u16 pdu_len; /* length of data after this trace */
	110	};
	111
	112	/*
	113	* The remap event
	114	*/
	115	struct blk_io_trace_remap {
	116	__u32 device_from;
	117	__u32 device_to;
	118	__u64 sector_from;
	119	};
	120
	121	/*
	122	* Payload with originating cgroup info
	123	*/
	124	struct blk_io_cgroup_payload {
	125	__u32 ino;
	126	__u32 gen;
	127	};
	128
	129	/*
	130	* User setup structure passed with BLKSTARTTRACE
	131	*/
	132	struct blk_user_trace_setup {
	133	char name[32]; /* output */
	134	__u16 act_mask; /* input */
	135	__u32 buf_size; /* input */
	136	__u32 buf_nr; /* input */
	137	__u64 start_lba;
	138	__u64 end_lba;
	139	__u32 pid;
	140	};
	141
	142	#define BLKTRACESETUP _IOWR(0x12,115,struct blk_user_trace_setup)
	143	#define BLKTRACESTART _IO(0x12,116)
	144	#define BLKTRACESTOP _IO(0x12,117)
	145	#define BLKTRACETEARDOWN _IO(0x12,118)
	146
	147	#endif