blktrace_api.h 8.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290
  1. #ifndef BLKTRACE_H
  2. #define BLKTRACE_H
  3. #include <linux/blkdev.h>
  4. #include <linux/relay.h>
  5. /*
  6. * Trace categories
  7. */
  8. enum blktrace_cat {
  9. BLK_TC_READ = 1 << 0, /* reads */
  10. BLK_TC_WRITE = 1 << 1, /* writes */
  11. BLK_TC_BARRIER = 1 << 2, /* barrier */
  12. BLK_TC_SYNC = 1 << 3, /* sync IO */
  13. BLK_TC_QUEUE = 1 << 4, /* queueing/merging */
  14. BLK_TC_REQUEUE = 1 << 5, /* requeueing */
  15. BLK_TC_ISSUE = 1 << 6, /* issue */
  16. BLK_TC_COMPLETE = 1 << 7, /* completions */
  17. BLK_TC_FS = 1 << 8, /* fs requests */
  18. BLK_TC_PC = 1 << 9, /* pc requests */
  19. BLK_TC_NOTIFY = 1 << 10, /* special message */
  20. BLK_TC_AHEAD = 1 << 11, /* readahead */
  21. BLK_TC_META = 1 << 12, /* metadata */
  22. BLK_TC_END = 1 << 15, /* only 16-bits, reminder */
  23. };
  24. #define BLK_TC_SHIFT (16)
  25. #define BLK_TC_ACT(act) ((act) << BLK_TC_SHIFT)
  26. /*
  27. * Basic trace actions
  28. */
  29. enum blktrace_act {
  30. __BLK_TA_QUEUE = 1, /* queued */
  31. __BLK_TA_BACKMERGE, /* back merged to existing rq */
  32. __BLK_TA_FRONTMERGE, /* front merge to existing rq */
  33. __BLK_TA_GETRQ, /* allocated new request */
  34. __BLK_TA_SLEEPRQ, /* sleeping on rq allocation */
  35. __BLK_TA_REQUEUE, /* request requeued */
  36. __BLK_TA_ISSUE, /* sent to driver */
  37. __BLK_TA_COMPLETE, /* completed by driver */
  38. __BLK_TA_PLUG, /* queue was plugged */
  39. __BLK_TA_UNPLUG_IO, /* queue was unplugged by io */
  40. __BLK_TA_UNPLUG_TIMER, /* queue was unplugged by timer */
  41. __BLK_TA_INSERT, /* insert request */
  42. __BLK_TA_SPLIT, /* bio was split */
  43. __BLK_TA_BOUNCE, /* bio was bounced */
  44. __BLK_TA_REMAP, /* bio was remapped */
  45. };
  46. /*
  47. * Notify events.
  48. */
  49. enum blktrace_notify {
  50. __BLK_TN_PROCESS = 0, /* establish pid/name mapping */
  51. __BLK_TN_TIMESTAMP, /* include system clock */
  52. };
  53. /*
  54. * Trace actions in full. Additionally, read or write is masked
  55. */
  56. #define BLK_TA_QUEUE (__BLK_TA_QUEUE | BLK_TC_ACT(BLK_TC_QUEUE))
  57. #define BLK_TA_BACKMERGE (__BLK_TA_BACKMERGE | BLK_TC_ACT(BLK_TC_QUEUE))
  58. #define BLK_TA_FRONTMERGE (__BLK_TA_FRONTMERGE | BLK_TC_ACT(BLK_TC_QUEUE))
  59. #define BLK_TA_GETRQ (__BLK_TA_GETRQ | BLK_TC_ACT(BLK_TC_QUEUE))
  60. #define BLK_TA_SLEEPRQ (__BLK_TA_SLEEPRQ | BLK_TC_ACT(BLK_TC_QUEUE))
  61. #define BLK_TA_REQUEUE (__BLK_TA_REQUEUE | BLK_TC_ACT(BLK_TC_REQUEUE))
  62. #define BLK_TA_ISSUE (__BLK_TA_ISSUE | BLK_TC_ACT(BLK_TC_ISSUE))
  63. #define BLK_TA_COMPLETE (__BLK_TA_COMPLETE| BLK_TC_ACT(BLK_TC_COMPLETE))
  64. #define BLK_TA_PLUG (__BLK_TA_PLUG | BLK_TC_ACT(BLK_TC_QUEUE))
  65. #define BLK_TA_UNPLUG_IO (__BLK_TA_UNPLUG_IO | BLK_TC_ACT(BLK_TC_QUEUE))
  66. #define BLK_TA_UNPLUG_TIMER (__BLK_TA_UNPLUG_TIMER | BLK_TC_ACT(BLK_TC_QUEUE))
  67. #define BLK_TA_INSERT (__BLK_TA_INSERT | BLK_TC_ACT(BLK_TC_QUEUE))
  68. #define BLK_TA_SPLIT (__BLK_TA_SPLIT)
  69. #define BLK_TA_BOUNCE (__BLK_TA_BOUNCE)
  70. #define BLK_TA_REMAP (__BLK_TA_REMAP | BLK_TC_ACT(BLK_TC_QUEUE))
  71. #define BLK_TN_PROCESS (__BLK_TN_PROCESS | BLK_TC_ACT(BLK_TC_NOTIFY))
  72. #define BLK_TN_TIMESTAMP (__BLK_TN_TIMESTAMP | BLK_TC_ACT(BLK_TC_NOTIFY))
  73. #define BLK_IO_TRACE_MAGIC 0x65617400
  74. #define BLK_IO_TRACE_VERSION 0x07
  75. /*
  76. * The trace itself
  77. */
  78. struct blk_io_trace {
  79. u32 magic; /* MAGIC << 8 | version */
  80. u32 sequence; /* event number */
  81. u64 time; /* in microseconds */
  82. u64 sector; /* disk offset */
  83. u32 bytes; /* transfer length */
  84. u32 action; /* what happened */
  85. u32 pid; /* who did it */
  86. u32 device; /* device number */
  87. u32 cpu; /* on what cpu did it happen */
  88. u16 error; /* completion error */
  89. u16 pdu_len; /* length of data after this trace */
  90. };
  91. /*
  92. * The remap event
  93. */
  94. struct blk_io_trace_remap {
  95. __be32 device;
  96. u32 __pad;
  97. __be64 sector;
  98. };
  99. enum {
  100. Blktrace_setup = 1,
  101. Blktrace_running,
  102. Blktrace_stopped,
  103. };
  104. struct blk_trace {
  105. int trace_state;
  106. struct rchan *rchan;
  107. unsigned long *sequence;
  108. u16 act_mask;
  109. u64 start_lba;
  110. u64 end_lba;
  111. u32 pid;
  112. u32 dev;
  113. struct dentry *dir;
  114. struct dentry *dropped_file;
  115. atomic_t dropped;
  116. };
  117. /*
  118. * User setup structure passed with BLKTRACESTART
  119. */
  120. struct blk_user_trace_setup {
  121. char name[BDEVNAME_SIZE]; /* output */
  122. u16 act_mask; /* input */
  123. u32 buf_size; /* input */
  124. u32 buf_nr; /* input */
  125. u64 start_lba;
  126. u64 end_lba;
  127. u32 pid;
  128. };
  129. #if defined(CONFIG_BLK_DEV_IO_TRACE)
  130. extern int blk_trace_ioctl(struct block_device *, unsigned, char __user *);
  131. extern void blk_trace_shutdown(request_queue_t *);
  132. extern void __blk_add_trace(struct blk_trace *, sector_t, int, int, u32, int, int, void *);
  133. /**
  134. * blk_add_trace_rq - Add a trace for a request oriented action
  135. * @q: queue the io is for
  136. * @rq: the source request
  137. * @what: the action
  138. *
  139. * Description:
  140. * Records an action against a request. Will log the bio offset + size.
  141. *
  142. **/
  143. static inline void blk_add_trace_rq(struct request_queue *q, struct request *rq,
  144. u32 what)
  145. {
  146. struct blk_trace *bt = q->blk_trace;
  147. int rw = rq->cmd_flags & 0x03;
  148. if (likely(!bt))
  149. return;
  150. if (blk_pc_request(rq)) {
  151. what |= BLK_TC_ACT(BLK_TC_PC);
  152. __blk_add_trace(bt, 0, rq->data_len, rw, what, rq->errors, sizeof(rq->cmd), rq->cmd);
  153. } else {
  154. what |= BLK_TC_ACT(BLK_TC_FS);
  155. __blk_add_trace(bt, rq->hard_sector, rq->hard_nr_sectors << 9, rw, what, rq->errors, 0, NULL);
  156. }
  157. }
  158. /**
  159. * blk_add_trace_bio - Add a trace for a bio oriented action
  160. * @q: queue the io is for
  161. * @bio: the source bio
  162. * @what: the action
  163. *
  164. * Description:
  165. * Records an action against a bio. Will log the bio offset + size.
  166. *
  167. **/
  168. static inline void blk_add_trace_bio(struct request_queue *q, struct bio *bio,
  169. u32 what)
  170. {
  171. struct blk_trace *bt = q->blk_trace;
  172. if (likely(!bt))
  173. return;
  174. __blk_add_trace(bt, bio->bi_sector, bio->bi_size, bio->bi_rw, what, !bio_flagged(bio, BIO_UPTODATE), 0, NULL);
  175. }
  176. /**
  177. * blk_add_trace_generic - Add a trace for a generic action
  178. * @q: queue the io is for
  179. * @bio: the source bio
  180. * @rw: the data direction
  181. * @what: the action
  182. *
  183. * Description:
  184. * Records a simple trace
  185. *
  186. **/
  187. static inline void blk_add_trace_generic(struct request_queue *q,
  188. struct bio *bio, int rw, u32 what)
  189. {
  190. struct blk_trace *bt = q->blk_trace;
  191. if (likely(!bt))
  192. return;
  193. if (bio)
  194. blk_add_trace_bio(q, bio, what);
  195. else
  196. __blk_add_trace(bt, 0, 0, rw, what, 0, 0, NULL);
  197. }
  198. /**
  199. * blk_add_trace_pdu_int - Add a trace for a bio with an integer payload
  200. * @q: queue the io is for
  201. * @what: the action
  202. * @bio: the source bio
  203. * @pdu: the integer payload
  204. *
  205. * Description:
  206. * Adds a trace with some integer payload. This might be an unplug
  207. * option given as the action, with the depth at unplug time given
  208. * as the payload
  209. *
  210. **/
  211. static inline void blk_add_trace_pdu_int(struct request_queue *q, u32 what,
  212. struct bio *bio, unsigned int pdu)
  213. {
  214. struct blk_trace *bt = q->blk_trace;
  215. __be64 rpdu = cpu_to_be64(pdu);
  216. if (likely(!bt))
  217. return;
  218. if (bio)
  219. __blk_add_trace(bt, bio->bi_sector, bio->bi_size, bio->bi_rw, what, !bio_flagged(bio, BIO_UPTODATE), sizeof(rpdu), &rpdu);
  220. else
  221. __blk_add_trace(bt, 0, 0, 0, what, 0, sizeof(rpdu), &rpdu);
  222. }
  223. /**
  224. * blk_add_trace_remap - Add a trace for a remap operation
  225. * @q: queue the io is for
  226. * @bio: the source bio
  227. * @dev: target device
  228. * @from: source sector
  229. * @to: target sector
  230. *
  231. * Description:
  232. * Device mapper or raid target sometimes need to split a bio because
  233. * it spans a stripe (or similar). Add a trace for that action.
  234. *
  235. **/
  236. static inline void blk_add_trace_remap(struct request_queue *q, struct bio *bio,
  237. dev_t dev, sector_t from, sector_t to)
  238. {
  239. struct blk_trace *bt = q->blk_trace;
  240. struct blk_io_trace_remap r;
  241. if (likely(!bt))
  242. return;
  243. r.device = cpu_to_be32(dev);
  244. r.sector = cpu_to_be64(to);
  245. __blk_add_trace(bt, from, bio->bi_size, bio->bi_rw, BLK_TA_REMAP, !bio_flagged(bio, BIO_UPTODATE), sizeof(r), &r);
  246. }
  247. #else /* !CONFIG_BLK_DEV_IO_TRACE */
  248. #define blk_trace_ioctl(bdev, cmd, arg) (-ENOTTY)
  249. #define blk_trace_shutdown(q) do { } while (0)
  250. #define blk_add_trace_rq(q, rq, what) do { } while (0)
  251. #define blk_add_trace_bio(q, rq, what) do { } while (0)
  252. #define blk_add_trace_generic(q, rq, rw, what) do { } while (0)
  253. #define blk_add_trace_pdu_int(q, what, bio, pdu) do { } while (0)
  254. #define blk_add_trace_remap(q, bio, dev, f, t) do {} while (0)
  255. #endif /* CONFIG_BLK_DEV_IO_TRACE */
  256. #endif