blob: 61b405a25653ea77d121713f173a4ebbe245fc0c [file] [log] [blame]
Jens Axboefb7b71a2007-05-15 08:44:04 +02001#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, /* 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
24 BLK_TC_END = 1 << 15, /* only 16-bits, reminder */
25};
26
27#define BLK_TC_SHIFT (16)
28#define BLK_TC_ACT(act) ((act) << BLK_TC_SHIFT)
29
30/*
31 * Basic trace actions
32 */
33enum {
34 __BLK_TA_QUEUE = 1, /* queued */
35 __BLK_TA_BACKMERGE, /* back merged to existing rq */
36 __BLK_TA_FRONTMERGE, /* front merge to existing rq */
37 __BLK_TA_GETRQ, /* allocated new request */
38 __BLK_TA_SLEEPRQ, /* sleeping on rq allocation */
39 __BLK_TA_REQUEUE, /* request requeued */
40 __BLK_TA_ISSUE, /* sent to driver */
41 __BLK_TA_COMPLETE, /* completed by driver */
42 __BLK_TA_PLUG, /* queue was plugged */
43 __BLK_TA_UNPLUG_IO, /* queue was unplugged by io */
44 __BLK_TA_UNPLUG_TIMER, /* queue was unplugged by timer */
45 __BLK_TA_INSERT, /* insert request */
46 __BLK_TA_SPLIT, /* bio was split */
47 __BLK_TA_BOUNCE, /* bio was bounced */
48 __BLK_TA_REMAP, /* bio was remapped */
49};
50
51/*
52 * Notify events.
53 */
54enum blktrace_notify {
55 __BLK_TN_PROCESS = 0, /* establish pid/name mapping */
56 __BLK_TN_TIMESTAMP, /* include system clock */
57};
58
59/*
60 * Trace actions in full. Additionally, read or write is masked
61 */
62#define BLK_TA_QUEUE (__BLK_TA_QUEUE | BLK_TC_ACT(BLK_TC_QUEUE))
63#define BLK_TA_BACKMERGE (__BLK_TA_BACKMERGE | BLK_TC_ACT(BLK_TC_QUEUE))
64#define BLK_TA_FRONTMERGE (__BLK_TA_FRONTMERGE | BLK_TC_ACT(BLK_TC_QUEUE))
65#define BLK_TA_GETRQ (__BLK_TA_GETRQ | BLK_TC_ACT(BLK_TC_QUEUE))
66#define BLK_TA_SLEEPRQ (__BLK_TA_SLEEPRQ | BLK_TC_ACT(BLK_TC_QUEUE))
67#define BLK_TA_REQUEUE (__BLK_TA_REQUEUE | BLK_TC_ACT(BLK_TC_REQUEUE))
68#define BLK_TA_ISSUE (__BLK_TA_ISSUE | BLK_TC_ACT(BLK_TC_ISSUE))
69#define BLK_TA_COMPLETE (__BLK_TA_COMPLETE| BLK_TC_ACT(BLK_TC_COMPLETE))
70#define BLK_TA_PLUG (__BLK_TA_PLUG | BLK_TC_ACT(BLK_TC_QUEUE))
71#define BLK_TA_UNPLUG_IO (__BLK_TA_UNPLUG_IO | BLK_TC_ACT(BLK_TC_QUEUE))
72#define BLK_TA_UNPLUG_TIMER (__BLK_TA_UNPLUG_TIMER | BLK_TC_ACT(BLK_TC_QUEUE))
73#define BLK_TA_INSERT (__BLK_TA_INSERT | BLK_TC_ACT(BLK_TC_QUEUE))
74#define BLK_TA_SPLIT (__BLK_TA_SPLIT)
75#define BLK_TA_BOUNCE (__BLK_TA_BOUNCE)
76#define BLK_TA_REMAP (__BLK_TA_REMAP | BLK_TC_ACT(BLK_TC_QUEUE))
77
78#define BLK_TN_PROCESS (__BLK_TN_PROCESS | BLK_TC_ACT(BLK_TC_NOTIFY))
79#define BLK_TN_TIMESTAMP (__BLK_TN_TIMESTAMP | BLK_TC_ACT(BLK_TC_NOTIFY))
80
81#define BLK_IO_TRACE_MAGIC 0x65617400
82#define BLK_IO_TRACE_VERSION 0x07
83
84/*
85 * The trace itself
86 */
87struct blk_io_trace {
88 __u32 magic; /* MAGIC << 8 | version */
89 __u32 sequence; /* event number */
90 __u64 time; /* in nanoseconds */
91 __u64 sector; /* disk offset */
92 __u32 bytes; /* transfer length */
93 __u32 action; /* what happened */
94 __u32 pid; /* who did it */
95 __u32 device; /* device identifier (dev_t) */
96 __u32 cpu; /* on what cpu did it happen */
97 __u16 error; /* completion error */
98 __u16 pdu_len; /* length of data after this trace */
99};
100
101/*
102 * The remap event
103 */
104struct blk_io_trace_remap {
105 __u32 device;
106 __u32 device_from;
107 __u64 sector;
108};
109
110/*
111 * User setup structure passed with BLKSTARTTRACE
112 */
113struct blk_user_trace_setup {
114 char name[32]; /* output */
115 __u16 act_mask; /* input */
116 __u32 buf_size; /* input */
117 __u32 buf_nr; /* input */
118 __u64 start_lba;
119 __u64 end_lba;
120 __u32 pid;
121};
122
123#define BLKTRACESETUP _IOWR(0x12,115,struct blk_user_trace_setup)
124#define BLKTRACESTART _IO(0x12,116)
125#define BLKTRACESTOP _IO(0x12,117)
126#define BLKTRACETEARDOWN _IO(0x12,118)
127
128#endif