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