[PATCH] README: update to say it needs 2.6.14-rc1 or newer
[blktrace.git] / blktrace_api.h
CommitLineData
6fe4709e
JA
1#ifndef BLKTRACEAPI_H
2#define BLKTRACEAPI_H
3
4#include <asm/types.h>
5
6/*
7 * Trace categories
8 */
9enum {
10 BLK_TC_READ = 1 << 0, /* reads */
11 BLK_TC_WRITE = 1 << 1, /* writes */
12 BLK_TC_BARRIER = 1 << 2, /* barrier */
13 BLK_TC_SYNC = 1 << 3, /* barrier */
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
21 BLK_TC_END = 1 << 15, /* only 16-bits, reminder */
22};
23
24#define BLK_TC_SHIFT (16)
25#define BLK_TC_ACT(act) ((act) << BLK_TC_SHIFT)
26
27/*
28 * Basic trace actions
29 */
30enum {
31 __BLK_TA_QUEUE = 1, /* queued */
32 __BLK_TA_BACKMERGE, /* back merged to existing rq */
33 __BLK_TA_FRONTMERGE, /* front merge to existing rq */
34 __BLK_TA_GETRQ, /* allocated new request */
35 __BLK_TA_SLEEPRQ, /* sleeping on rq allocation */
36 __BLK_TA_REQUEUE, /* request requeued */
37 __BLK_TA_ISSUE, /* sent to driver */
38 __BLK_TA_COMPLETE, /* completed by driver */
88b1a526
JA
39 __BLK_TA_PLUG, /* queue was plugged */
40 __BLK_TA_UNPLUG, /* queue was unplugged */
6fe4709e
JA
41};
42
43/*
44 * Trace actions in full. Additionally, read or write is masked
45 */
46#define BLK_TA_QUEUE (__BLK_TA_QUEUE | BLK_TC_ACT(BLK_TC_QUEUE))
47#define BLK_TA_BACKMERGE (__BLK_TA_BACKMERGE | BLK_TC_ACT(BLK_TC_QUEUE))
48#define BLK_TA_FRONTMERGE (__BLK_TA_FRONTMERGE | BLK_TC_ACT(BLK_TC_QUEUE))
49#define BLK_TA_GETRQ (__BLK_TA_GETRQ | BLK_TC_ACT(BLK_TC_QUEUE))
50#define BLK_TA_SLEEPRQ (__BLK_TA_SLEEPRQ | BLK_TC_ACT(BLK_TC_QUEUE))
51#define BLK_TA_REQUEUE (__BLK_TA_REQUEUE | BLK_TC_ACT(BLK_TC_REQUEUE))
52#define BLK_TA_ISSUE (__BLK_TA_ISSUE | BLK_TC_ACT(BLK_TC_ISSUE))
53#define BLK_TA_COMPLETE (__BLK_TA_COMPLETE| BLK_TC_ACT(BLK_TC_COMPLETE))
88b1a526
JA
54#define BLK_TA_PLUG (__BLK_TA_PLUG | BLK_TC_ACT(BLK_TC_QUEUE))
55#define BLK_TA_UNPLUG (__BLK_TA_UNPLUG | BLK_TC_ACT(BLK_TC_QUEUE))
6fe4709e
JA
56
57#define BLK_IO_TRACE_MAGIC 0x65617400
e7c9f3ff 58#define BLK_IO_TRACE_VERSION 0x05
6fe4709e
JA
59
60/*
61 * The trace itself
62 */
63struct blk_io_trace {
64 __u32 magic; /* MAGIC << 8 | version */
65 __u32 sequence; /* event number */
f8fd8985 66 __u64 time; /* in nanoseconds */
6fe4709e
JA
67 __u64 sector; /* disk offset */
68 __u32 bytes; /* transfer length */
69 __u32 action; /* what happened */
70 __u32 pid; /* who did it */
654aaa52 71 __u32 cpu; /* on what cpu did it happen */
6fe4709e
JA
72 __u16 error; /* completion error */
73 __u16 pdu_len; /* length of data after this trace */
e7c9f3ff 74 __u32 device; /* device identifier (dev_t) */
654aaa52 75 char comm[16]; /* task command name (TASK_COMM_LEN) */
6fe4709e
JA
76};
77
78/*
79 * User setup structure passed with BLKSTARTTRACE
80 */
81struct blk_user_trace_setup {
82 char name[32]; /* output */
83 __u16 act_mask; /* input */
84 __u32 buf_size; /* input */
85 __u32 buf_nr; /* input */
86};
87
88#define BLKSTARTTRACE _IOWR(0x12,115,struct blk_user_trace_setup)
89#define BLKSTOPTRACE _IO(0x12,116)
90
91#endif