blktrace.c 42 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833
  1. /*
  2. * Copyright (C) 2006 Jens Axboe <axboe@kernel.dk>
  3. *
  4. * This program is free software; you can redistribute it and/or modify
  5. * it under the terms of the GNU General Public License version 2 as
  6. * published by the Free Software Foundation.
  7. *
  8. * This program is distributed in the hope that it will be useful,
  9. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11. * GNU General Public License for more details.
  12. *
  13. * You should have received a copy of the GNU General Public License
  14. * along with this program; if not, write to the Free Software
  15. * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  16. *
  17. */
  18. #include <linux/kernel.h>
  19. #include <linux/blkdev.h>
  20. #include <linux/blktrace_api.h>
  21. #include <linux/percpu.h>
  22. #include <linux/init.h>
  23. #include <linux/mutex.h>
  24. #include <linux/slab.h>
  25. #include <linux/debugfs.h>
  26. #include <linux/export.h>
  27. #include <linux/time.h>
  28. #include <linux/uaccess.h>
  29. #include <trace/events/block.h>
  30. #include "trace_output.h"
  31. #ifdef CONFIG_BLK_DEV_IO_TRACE
  32. static unsigned int blktrace_seq __read_mostly = 1;
  33. static struct trace_array *blk_tr;
  34. static bool blk_tracer_enabled __read_mostly;
  35. /* Select an alternative, minimalistic output than the original one */
  36. #define TRACE_BLK_OPT_CLASSIC 0x1
  37. static struct tracer_opt blk_tracer_opts[] = {
  38. /* Default disable the minimalistic output */
  39. { TRACER_OPT(blk_classic, TRACE_BLK_OPT_CLASSIC) },
  40. { }
  41. };
  42. static struct tracer_flags blk_tracer_flags = {
  43. .val = 0,
  44. .opts = blk_tracer_opts,
  45. };
  46. /* Global reference count of probes */
  47. static atomic_t blk_probes_ref = ATOMIC_INIT(0);
  48. static void blk_register_tracepoints(void);
  49. static void blk_unregister_tracepoints(void);
  50. /*
  51. * Send out a notify message.
  52. */
  53. static void trace_note(struct blk_trace *bt, pid_t pid, int action,
  54. const void *data, size_t len)
  55. {
  56. struct blk_io_trace *t;
  57. struct ring_buffer_event *event = NULL;
  58. struct ring_buffer *buffer = NULL;
  59. int pc = 0;
  60. int cpu = smp_processor_id();
  61. bool blk_tracer = blk_tracer_enabled;
  62. if (blk_tracer) {
  63. buffer = blk_tr->buffer;
  64. pc = preempt_count();
  65. event = trace_buffer_lock_reserve(buffer, TRACE_BLK,
  66. sizeof(*t) + len,
  67. 0, pc);
  68. if (!event)
  69. return;
  70. t = ring_buffer_event_data(event);
  71. goto record_it;
  72. }
  73. if (!bt->rchan)
  74. return;
  75. t = relay_reserve(bt->rchan, sizeof(*t) + len);
  76. if (t) {
  77. t->magic = BLK_IO_TRACE_MAGIC | BLK_IO_TRACE_VERSION;
  78. t->time = ktime_to_ns(ktime_get());
  79. record_it:
  80. t->device = bt->dev;
  81. t->action = action;
  82. t->pid = pid;
  83. t->cpu = cpu;
  84. t->pdu_len = len;
  85. memcpy((void *) t + sizeof(*t), data, len);
  86. if (blk_tracer)
  87. trace_buffer_unlock_commit(buffer, event, 0, pc);
  88. }
  89. }
  90. /*
  91. * Send out a notify for this process, if we haven't done so since a trace
  92. * started
  93. */
  94. static void trace_note_tsk(struct blk_trace *bt, struct task_struct *tsk)
  95. {
  96. tsk->btrace_seq = blktrace_seq;
  97. trace_note(bt, tsk->pid, BLK_TN_PROCESS, tsk->comm, sizeof(tsk->comm));
  98. }
  99. static void trace_note_time(struct blk_trace *bt)
  100. {
  101. struct timespec now;
  102. unsigned long flags;
  103. u32 words[2];
  104. getnstimeofday(&now);
  105. words[0] = now.tv_sec;
  106. words[1] = now.tv_nsec;
  107. local_irq_save(flags);
  108. trace_note(bt, 0, BLK_TN_TIMESTAMP, words, sizeof(words));
  109. local_irq_restore(flags);
  110. }
  111. void __trace_note_message(struct blk_trace *bt, const char *fmt, ...)
  112. {
  113. int n;
  114. va_list args;
  115. unsigned long flags;
  116. char *buf;
  117. if (unlikely(bt->trace_state != Blktrace_running &&
  118. !blk_tracer_enabled))
  119. return;
  120. /*
  121. * If the BLK_TC_NOTIFY action mask isn't set, don't send any note
  122. * message to the trace.
  123. */
  124. if (!(bt->act_mask & BLK_TC_NOTIFY))
  125. return;
  126. local_irq_save(flags);
  127. buf = this_cpu_ptr(bt->msg_data);
  128. va_start(args, fmt);
  129. n = vscnprintf(buf, BLK_TN_MAX_MSG, fmt, args);
  130. va_end(args);
  131. trace_note(bt, 0, BLK_TN_MESSAGE, buf, n);
  132. local_irq_restore(flags);
  133. }
  134. EXPORT_SYMBOL_GPL(__trace_note_message);
  135. static int act_log_check(struct blk_trace *bt, u32 what, sector_t sector,
  136. pid_t pid)
  137. {
  138. if (((bt->act_mask << BLK_TC_SHIFT) & what) == 0)
  139. return 1;
  140. if (sector && (sector < bt->start_lba || sector > bt->end_lba))
  141. return 1;
  142. if (bt->pid && pid != bt->pid)
  143. return 1;
  144. return 0;
  145. }
  146. /*
  147. * Data direction bit lookup
  148. */
  149. static const u32 ddir_act[2] = { BLK_TC_ACT(BLK_TC_READ),
  150. BLK_TC_ACT(BLK_TC_WRITE) };
  151. #define BLK_TC_RAHEAD BLK_TC_AHEAD
  152. /* The ilog2() calls fall out because they're constant */
  153. #define MASK_TC_BIT(rw, __name) ((rw & REQ_ ## __name) << \
  154. (ilog2(BLK_TC_ ## __name) + BLK_TC_SHIFT - __REQ_ ## __name))
  155. /*
  156. * The worker for the various blk_add_trace*() types. Fills out a
  157. * blk_io_trace structure and places it in a per-cpu subbuffer.
  158. */
  159. static void __blk_add_trace(struct blk_trace *bt, sector_t sector, int bytes,
  160. int rw, u32 what, int error, int pdu_len, void *pdu_data)
  161. {
  162. struct task_struct *tsk = current;
  163. struct ring_buffer_event *event = NULL;
  164. struct ring_buffer *buffer = NULL;
  165. struct blk_io_trace *t;
  166. unsigned long flags = 0;
  167. unsigned long *sequence;
  168. pid_t pid;
  169. int cpu, pc = 0;
  170. bool blk_tracer = blk_tracer_enabled;
  171. if (unlikely(bt->trace_state != Blktrace_running && !blk_tracer))
  172. return;
  173. what |= ddir_act[rw & WRITE];
  174. what |= MASK_TC_BIT(rw, SYNC);
  175. what |= MASK_TC_BIT(rw, RAHEAD);
  176. what |= MASK_TC_BIT(rw, META);
  177. what |= MASK_TC_BIT(rw, DISCARD);
  178. what |= MASK_TC_BIT(rw, FLUSH);
  179. what |= MASK_TC_BIT(rw, FUA);
  180. pid = tsk->pid;
  181. if (act_log_check(bt, what, sector, pid))
  182. return;
  183. cpu = raw_smp_processor_id();
  184. if (blk_tracer) {
  185. tracing_record_cmdline(current);
  186. buffer = blk_tr->buffer;
  187. pc = preempt_count();
  188. event = trace_buffer_lock_reserve(buffer, TRACE_BLK,
  189. sizeof(*t) + pdu_len,
  190. 0, pc);
  191. if (!event)
  192. return;
  193. t = ring_buffer_event_data(event);
  194. goto record_it;
  195. }
  196. /*
  197. * A word about the locking here - we disable interrupts to reserve
  198. * some space in the relay per-cpu buffer, to prevent an irq
  199. * from coming in and stepping on our toes.
  200. */
  201. local_irq_save(flags);
  202. if (unlikely(tsk->btrace_seq != blktrace_seq))
  203. trace_note_tsk(bt, tsk);
  204. t = relay_reserve(bt->rchan, sizeof(*t) + pdu_len);
  205. if (t) {
  206. sequence = per_cpu_ptr(bt->sequence, cpu);
  207. t->magic = BLK_IO_TRACE_MAGIC | BLK_IO_TRACE_VERSION;
  208. t->sequence = ++(*sequence);
  209. t->time = ktime_to_ns(ktime_get());
  210. record_it:
  211. /*
  212. * These two are not needed in ftrace as they are in the
  213. * generic trace_entry, filled by tracing_generic_entry_update,
  214. * but for the trace_event->bin() synthesizer benefit we do it
  215. * here too.
  216. */
  217. t->cpu = cpu;
  218. t->pid = pid;
  219. t->sector = sector;
  220. t->bytes = bytes;
  221. t->action = what;
  222. t->device = bt->dev;
  223. t->error = error;
  224. t->pdu_len = pdu_len;
  225. if (pdu_len)
  226. memcpy((void *) t + sizeof(*t), pdu_data, pdu_len);
  227. if (blk_tracer) {
  228. trace_buffer_unlock_commit(buffer, event, 0, pc);
  229. return;
  230. }
  231. }
  232. local_irq_restore(flags);
  233. }
  234. static struct dentry *blk_tree_root;
  235. static DEFINE_MUTEX(blk_tree_mutex);
  236. static void blk_trace_free(struct blk_trace *bt)
  237. {
  238. debugfs_remove(bt->msg_file);
  239. debugfs_remove(bt->dropped_file);
  240. relay_close(bt->rchan);
  241. debugfs_remove(bt->dir);
  242. free_percpu(bt->sequence);
  243. free_percpu(bt->msg_data);
  244. kfree(bt);
  245. }
  246. static void blk_trace_cleanup(struct blk_trace *bt)
  247. {
  248. blk_trace_free(bt);
  249. if (atomic_dec_and_test(&blk_probes_ref))
  250. blk_unregister_tracepoints();
  251. }
  252. int blk_trace_remove(struct request_queue *q)
  253. {
  254. struct blk_trace *bt;
  255. bt = xchg(&q->blk_trace, NULL);
  256. if (!bt)
  257. return -EINVAL;
  258. if (bt->trace_state != Blktrace_running)
  259. blk_trace_cleanup(bt);
  260. return 0;
  261. }
  262. EXPORT_SYMBOL_GPL(blk_trace_remove);
  263. static ssize_t blk_dropped_read(struct file *filp, char __user *buffer,
  264. size_t count, loff_t *ppos)
  265. {
  266. struct blk_trace *bt = filp->private_data;
  267. char buf[16];
  268. snprintf(buf, sizeof(buf), "%u\n", atomic_read(&bt->dropped));
  269. return simple_read_from_buffer(buffer, count, ppos, buf, strlen(buf));
  270. }
  271. static const struct file_operations blk_dropped_fops = {
  272. .owner = THIS_MODULE,
  273. .open = simple_open,
  274. .read = blk_dropped_read,
  275. .llseek = default_llseek,
  276. };
  277. static ssize_t blk_msg_write(struct file *filp, const char __user *buffer,
  278. size_t count, loff_t *ppos)
  279. {
  280. char *msg;
  281. struct blk_trace *bt;
  282. if (count >= BLK_TN_MAX_MSG)
  283. return -EINVAL;
  284. msg = kmalloc(count + 1, GFP_KERNEL);
  285. if (msg == NULL)
  286. return -ENOMEM;
  287. if (copy_from_user(msg, buffer, count)) {
  288. kfree(msg);
  289. return -EFAULT;
  290. }
  291. msg[count] = '\0';
  292. bt = filp->private_data;
  293. __trace_note_message(bt, "%s", msg);
  294. kfree(msg);
  295. return count;
  296. }
  297. static const struct file_operations blk_msg_fops = {
  298. .owner = THIS_MODULE,
  299. .open = simple_open,
  300. .write = blk_msg_write,
  301. .llseek = noop_llseek,
  302. };
  303. /*
  304. * Keep track of how many times we encountered a full subbuffer, to aid
  305. * the user space app in telling how many lost events there were.
  306. */
  307. static int blk_subbuf_start_callback(struct rchan_buf *buf, void *subbuf,
  308. void *prev_subbuf, size_t prev_padding)
  309. {
  310. struct blk_trace *bt;
  311. if (!relay_buf_full(buf))
  312. return 1;
  313. bt = buf->chan->private_data;
  314. atomic_inc(&bt->dropped);
  315. return 0;
  316. }
  317. static int blk_remove_buf_file_callback(struct dentry *dentry)
  318. {
  319. debugfs_remove(dentry);
  320. return 0;
  321. }
  322. static struct dentry *blk_create_buf_file_callback(const char *filename,
  323. struct dentry *parent,
  324. umode_t mode,
  325. struct rchan_buf *buf,
  326. int *is_global)
  327. {
  328. return debugfs_create_file(filename, mode, parent, buf,
  329. &relay_file_operations);
  330. }
  331. static struct rchan_callbacks blk_relay_callbacks = {
  332. .subbuf_start = blk_subbuf_start_callback,
  333. .create_buf_file = blk_create_buf_file_callback,
  334. .remove_buf_file = blk_remove_buf_file_callback,
  335. };
  336. static void blk_trace_setup_lba(struct blk_trace *bt,
  337. struct block_device *bdev)
  338. {
  339. struct hd_struct *part = NULL;
  340. if (bdev)
  341. part = bdev->bd_part;
  342. if (part) {
  343. bt->start_lba = part->start_sect;
  344. bt->end_lba = part->start_sect + part->nr_sects;
  345. } else {
  346. bt->start_lba = 0;
  347. bt->end_lba = -1ULL;
  348. }
  349. }
  350. /*
  351. * Setup everything required to start tracing
  352. */
  353. int do_blk_trace_setup(struct request_queue *q, char *name, dev_t dev,
  354. struct block_device *bdev,
  355. struct blk_user_trace_setup *buts)
  356. {
  357. struct blk_trace *old_bt, *bt = NULL;
  358. struct dentry *dir = NULL;
  359. int ret, i;
  360. if (!buts->buf_size || !buts->buf_nr)
  361. return -EINVAL;
  362. strncpy(buts->name, name, BLKTRACE_BDEV_SIZE);
  363. buts->name[BLKTRACE_BDEV_SIZE - 1] = '\0';
  364. /*
  365. * some device names have larger paths - convert the slashes
  366. * to underscores for this to work as expected
  367. */
  368. for (i = 0; i < strlen(buts->name); i++)
  369. if (buts->name[i] == '/')
  370. buts->name[i] = '_';
  371. bt = kzalloc(sizeof(*bt), GFP_KERNEL);
  372. if (!bt)
  373. return -ENOMEM;
  374. ret = -ENOMEM;
  375. bt->sequence = alloc_percpu(unsigned long);
  376. if (!bt->sequence)
  377. goto err;
  378. bt->msg_data = __alloc_percpu(BLK_TN_MAX_MSG, __alignof__(char));
  379. if (!bt->msg_data)
  380. goto err;
  381. ret = -ENOENT;
  382. mutex_lock(&blk_tree_mutex);
  383. if (!blk_tree_root) {
  384. blk_tree_root = debugfs_create_dir("block", NULL);
  385. if (!blk_tree_root) {
  386. mutex_unlock(&blk_tree_mutex);
  387. goto err;
  388. }
  389. }
  390. mutex_unlock(&blk_tree_mutex);
  391. dir = debugfs_create_dir(buts->name, blk_tree_root);
  392. if (!dir)
  393. goto err;
  394. bt->dir = dir;
  395. bt->dev = dev;
  396. atomic_set(&bt->dropped, 0);
  397. ret = -EIO;
  398. bt->dropped_file = debugfs_create_file("dropped", 0444, dir, bt,
  399. &blk_dropped_fops);
  400. if (!bt->dropped_file)
  401. goto err;
  402. bt->msg_file = debugfs_create_file("msg", 0222, dir, bt, &blk_msg_fops);
  403. if (!bt->msg_file)
  404. goto err;
  405. bt->rchan = relay_open("trace", dir, buts->buf_size,
  406. buts->buf_nr, &blk_relay_callbacks, bt);
  407. if (!bt->rchan)
  408. goto err;
  409. bt->act_mask = buts->act_mask;
  410. if (!bt->act_mask)
  411. bt->act_mask = (u16) -1;
  412. blk_trace_setup_lba(bt, bdev);
  413. /* overwrite with user settings */
  414. if (buts->start_lba)
  415. bt->start_lba = buts->start_lba;
  416. if (buts->end_lba)
  417. bt->end_lba = buts->end_lba;
  418. bt->pid = buts->pid;
  419. bt->trace_state = Blktrace_setup;
  420. ret = -EBUSY;
  421. old_bt = xchg(&q->blk_trace, bt);
  422. if (old_bt) {
  423. (void) xchg(&q->blk_trace, old_bt);
  424. goto err;
  425. }
  426. if (atomic_inc_return(&blk_probes_ref) == 1)
  427. blk_register_tracepoints();
  428. return 0;
  429. err:
  430. blk_trace_free(bt);
  431. return ret;
  432. }
  433. int blk_trace_setup(struct request_queue *q, char *name, dev_t dev,
  434. struct block_device *bdev,
  435. char __user *arg)
  436. {
  437. struct blk_user_trace_setup buts;
  438. int ret;
  439. ret = copy_from_user(&buts, arg, sizeof(buts));
  440. if (ret)
  441. return -EFAULT;
  442. ret = do_blk_trace_setup(q, name, dev, bdev, &buts);
  443. if (ret)
  444. return ret;
  445. if (copy_to_user(arg, &buts, sizeof(buts))) {
  446. blk_trace_remove(q);
  447. return -EFAULT;
  448. }
  449. return 0;
  450. }
  451. EXPORT_SYMBOL_GPL(blk_trace_setup);
  452. #if defined(CONFIG_COMPAT) && defined(CONFIG_X86_64)
  453. static int compat_blk_trace_setup(struct request_queue *q, char *name,
  454. dev_t dev, struct block_device *bdev,
  455. char __user *arg)
  456. {
  457. struct blk_user_trace_setup buts;
  458. struct compat_blk_user_trace_setup cbuts;
  459. int ret;
  460. if (copy_from_user(&cbuts, arg, sizeof(cbuts)))
  461. return -EFAULT;
  462. buts = (struct blk_user_trace_setup) {
  463. .act_mask = cbuts.act_mask,
  464. .buf_size = cbuts.buf_size,
  465. .buf_nr = cbuts.buf_nr,
  466. .start_lba = cbuts.start_lba,
  467. .end_lba = cbuts.end_lba,
  468. .pid = cbuts.pid,
  469. };
  470. memcpy(&buts.name, &cbuts.name, 32);
  471. ret = do_blk_trace_setup(q, name, dev, bdev, &buts);
  472. if (ret)
  473. return ret;
  474. if (copy_to_user(arg, &buts.name, 32)) {
  475. blk_trace_remove(q);
  476. return -EFAULT;
  477. }
  478. return 0;
  479. }
  480. #endif
  481. int blk_trace_startstop(struct request_queue *q, int start)
  482. {
  483. int ret;
  484. struct blk_trace *bt = q->blk_trace;
  485. if (bt == NULL)
  486. return -EINVAL;
  487. /*
  488. * For starting a trace, we can transition from a setup or stopped
  489. * trace. For stopping a trace, the state must be running
  490. */
  491. ret = -EINVAL;
  492. if (start) {
  493. if (bt->trace_state == Blktrace_setup ||
  494. bt->trace_state == Blktrace_stopped) {
  495. blktrace_seq++;
  496. smp_mb();
  497. bt->trace_state = Blktrace_running;
  498. trace_note_time(bt);
  499. ret = 0;
  500. }
  501. } else {
  502. if (bt->trace_state == Blktrace_running) {
  503. bt->trace_state = Blktrace_stopped;
  504. relay_flush(bt->rchan);
  505. ret = 0;
  506. }
  507. }
  508. return ret;
  509. }
  510. EXPORT_SYMBOL_GPL(blk_trace_startstop);
  511. /**
  512. * blk_trace_ioctl: - handle the ioctls associated with tracing
  513. * @bdev: the block device
  514. * @cmd: the ioctl cmd
  515. * @arg: the argument data, if any
  516. *
  517. **/
  518. int blk_trace_ioctl(struct block_device *bdev, unsigned cmd, char __user *arg)
  519. {
  520. struct request_queue *q;
  521. int ret, start = 0;
  522. char b[BDEVNAME_SIZE];
  523. q = bdev_get_queue(bdev);
  524. if (!q)
  525. return -ENXIO;
  526. mutex_lock(&bdev->bd_mutex);
  527. switch (cmd) {
  528. case BLKTRACESETUP:
  529. bdevname(bdev, b);
  530. ret = blk_trace_setup(q, b, bdev->bd_dev, bdev, arg);
  531. break;
  532. #if defined(CONFIG_COMPAT) && defined(CONFIG_X86_64)
  533. case BLKTRACESETUP32:
  534. bdevname(bdev, b);
  535. ret = compat_blk_trace_setup(q, b, bdev->bd_dev, bdev, arg);
  536. break;
  537. #endif
  538. case BLKTRACESTART:
  539. start = 1;
  540. case BLKTRACESTOP:
  541. ret = blk_trace_startstop(q, start);
  542. break;
  543. case BLKTRACETEARDOWN:
  544. ret = blk_trace_remove(q);
  545. break;
  546. default:
  547. ret = -ENOTTY;
  548. break;
  549. }
  550. mutex_unlock(&bdev->bd_mutex);
  551. return ret;
  552. }
  553. /**
  554. * blk_trace_shutdown: - stop and cleanup trace structures
  555. * @q: the request queue associated with the device
  556. *
  557. **/
  558. void blk_trace_shutdown(struct request_queue *q)
  559. {
  560. if (q->blk_trace) {
  561. blk_trace_startstop(q, 0);
  562. blk_trace_remove(q);
  563. }
  564. }
  565. /*
  566. * blktrace probes
  567. */
  568. /**
  569. * blk_add_trace_rq - Add a trace for a request oriented action
  570. * @q: queue the io is for
  571. * @rq: the source request
  572. * @what: the action
  573. *
  574. * Description:
  575. * Records an action against a request. Will log the bio offset + size.
  576. *
  577. **/
  578. static void blk_add_trace_rq(struct request_queue *q, struct request *rq,
  579. u32 what)
  580. {
  581. struct blk_trace *bt = q->blk_trace;
  582. if (likely(!bt))
  583. return;
  584. if (rq->cmd_type == REQ_TYPE_BLOCK_PC) {
  585. what |= BLK_TC_ACT(BLK_TC_PC);
  586. __blk_add_trace(bt, 0, blk_rq_bytes(rq), rq->cmd_flags,
  587. what, rq->errors, rq->cmd_len, rq->cmd);
  588. } else {
  589. what |= BLK_TC_ACT(BLK_TC_FS);
  590. __blk_add_trace(bt, blk_rq_pos(rq), blk_rq_bytes(rq),
  591. rq->cmd_flags, what, rq->errors, 0, NULL);
  592. }
  593. }
  594. static void blk_add_trace_rq_abort(void *ignore,
  595. struct request_queue *q, struct request *rq)
  596. {
  597. blk_add_trace_rq(q, rq, BLK_TA_ABORT);
  598. }
  599. static void blk_add_trace_rq_insert(void *ignore,
  600. struct request_queue *q, struct request *rq)
  601. {
  602. blk_add_trace_rq(q, rq, BLK_TA_INSERT);
  603. }
  604. static void blk_add_trace_rq_issue(void *ignore,
  605. struct request_queue *q, struct request *rq)
  606. {
  607. blk_add_trace_rq(q, rq, BLK_TA_ISSUE);
  608. }
  609. static void blk_add_trace_rq_requeue(void *ignore,
  610. struct request_queue *q,
  611. struct request *rq)
  612. {
  613. blk_add_trace_rq(q, rq, BLK_TA_REQUEUE);
  614. }
  615. static void blk_add_trace_rq_complete(void *ignore,
  616. struct request_queue *q,
  617. struct request *rq)
  618. {
  619. struct blk_trace *bt = q->blk_trace;
  620. /* if control ever passes through here, it's a request based driver */
  621. if (unlikely(bt && !bt->rq_based))
  622. bt->rq_based = true;
  623. blk_add_trace_rq(q, rq, BLK_TA_COMPLETE);
  624. }
  625. /**
  626. * blk_add_trace_bio - Add a trace for a bio oriented action
  627. * @q: queue the io is for
  628. * @bio: the source bio
  629. * @what: the action
  630. * @error: error, if any
  631. *
  632. * Description:
  633. * Records an action against a bio. Will log the bio offset + size.
  634. *
  635. **/
  636. static void blk_add_trace_bio(struct request_queue *q, struct bio *bio,
  637. u32 what, int error)
  638. {
  639. struct blk_trace *bt = q->blk_trace;
  640. if (likely(!bt))
  641. return;
  642. if (!error && !bio_flagged(bio, BIO_UPTODATE))
  643. error = EIO;
  644. __blk_add_trace(bt, bio->bi_sector, bio->bi_size, bio->bi_rw, what,
  645. error, 0, NULL);
  646. }
  647. static void blk_add_trace_bio_bounce(void *ignore,
  648. struct request_queue *q, struct bio *bio)
  649. {
  650. blk_add_trace_bio(q, bio, BLK_TA_BOUNCE, 0);
  651. }
  652. static void blk_add_trace_bio_complete(void *ignore, struct bio *bio, int error)
  653. {
  654. struct request_queue *q;
  655. struct blk_trace *bt;
  656. if (!bio->bi_bdev)
  657. return;
  658. q = bdev_get_queue(bio->bi_bdev);
  659. bt = q->blk_trace;
  660. /*
  661. * Request based drivers will generate both rq and bio completions.
  662. * Ignore bio ones.
  663. */
  664. if (likely(!bt) || bt->rq_based)
  665. return;
  666. blk_add_trace_bio(q, bio, BLK_TA_COMPLETE, error);
  667. }
  668. static void blk_add_trace_bio_backmerge(void *ignore,
  669. struct request_queue *q,
  670. struct request *rq,
  671. struct bio *bio)
  672. {
  673. blk_add_trace_bio(q, bio, BLK_TA_BACKMERGE, 0);
  674. }
  675. static void blk_add_trace_bio_frontmerge(void *ignore,
  676. struct request_queue *q,
  677. struct request *rq,
  678. struct bio *bio)
  679. {
  680. blk_add_trace_bio(q, bio, BLK_TA_FRONTMERGE, 0);
  681. }
  682. static void blk_add_trace_bio_queue(void *ignore,
  683. struct request_queue *q, struct bio *bio)
  684. {
  685. blk_add_trace_bio(q, bio, BLK_TA_QUEUE, 0);
  686. }
  687. static void blk_add_trace_getrq(void *ignore,
  688. struct request_queue *q,
  689. struct bio *bio, int rw)
  690. {
  691. if (bio)
  692. blk_add_trace_bio(q, bio, BLK_TA_GETRQ, 0);
  693. else {
  694. struct blk_trace *bt = q->blk_trace;
  695. if (bt)
  696. __blk_add_trace(bt, 0, 0, rw, BLK_TA_GETRQ, 0, 0, NULL);
  697. }
  698. }
  699. static void blk_add_trace_sleeprq(void *ignore,
  700. struct request_queue *q,
  701. struct bio *bio, int rw)
  702. {
  703. if (bio)
  704. blk_add_trace_bio(q, bio, BLK_TA_SLEEPRQ, 0);
  705. else {
  706. struct blk_trace *bt = q->blk_trace;
  707. if (bt)
  708. __blk_add_trace(bt, 0, 0, rw, BLK_TA_SLEEPRQ,
  709. 0, 0, NULL);
  710. }
  711. }
  712. static void blk_add_trace_plug(void *ignore, struct request_queue *q)
  713. {
  714. struct blk_trace *bt = q->blk_trace;
  715. if (bt)
  716. __blk_add_trace(bt, 0, 0, 0, BLK_TA_PLUG, 0, 0, NULL);
  717. }
  718. static void blk_add_trace_unplug(void *ignore, struct request_queue *q,
  719. unsigned int depth, bool explicit)
  720. {
  721. struct blk_trace *bt = q->blk_trace;
  722. if (bt) {
  723. __be64 rpdu = cpu_to_be64(depth);
  724. u32 what;
  725. if (explicit)
  726. what = BLK_TA_UNPLUG_IO;
  727. else
  728. what = BLK_TA_UNPLUG_TIMER;
  729. __blk_add_trace(bt, 0, 0, 0, what, 0, sizeof(rpdu), &rpdu);
  730. }
  731. }
  732. static void blk_add_trace_split(void *ignore,
  733. struct request_queue *q, struct bio *bio,
  734. unsigned int pdu)
  735. {
  736. struct blk_trace *bt = q->blk_trace;
  737. if (bt) {
  738. __be64 rpdu = cpu_to_be64(pdu);
  739. __blk_add_trace(bt, bio->bi_sector, bio->bi_size, bio->bi_rw,
  740. BLK_TA_SPLIT, !bio_flagged(bio, BIO_UPTODATE),
  741. sizeof(rpdu), &rpdu);
  742. }
  743. }
  744. /**
  745. * blk_add_trace_bio_remap - Add a trace for a bio-remap operation
  746. * @ignore: trace callback data parameter (not used)
  747. * @q: queue the io is for
  748. * @bio: the source bio
  749. * @dev: target device
  750. * @from: source sector
  751. *
  752. * Description:
  753. * Device mapper or raid target sometimes need to split a bio because
  754. * it spans a stripe (or similar). Add a trace for that action.
  755. *
  756. **/
  757. static void blk_add_trace_bio_remap(void *ignore,
  758. struct request_queue *q, struct bio *bio,
  759. dev_t dev, sector_t from)
  760. {
  761. struct blk_trace *bt = q->blk_trace;
  762. struct blk_io_trace_remap r;
  763. if (likely(!bt))
  764. return;
  765. r.device_from = cpu_to_be32(dev);
  766. r.device_to = cpu_to_be32(bio->bi_bdev->bd_dev);
  767. r.sector_from = cpu_to_be64(from);
  768. __blk_add_trace(bt, bio->bi_sector, bio->bi_size, bio->bi_rw,
  769. BLK_TA_REMAP, !bio_flagged(bio, BIO_UPTODATE),
  770. sizeof(r), &r);
  771. }
  772. /**
  773. * blk_add_trace_rq_remap - Add a trace for a request-remap operation
  774. * @ignore: trace callback data parameter (not used)
  775. * @q: queue the io is for
  776. * @rq: the source request
  777. * @dev: target device
  778. * @from: source sector
  779. *
  780. * Description:
  781. * Device mapper remaps request to other devices.
  782. * Add a trace for that action.
  783. *
  784. **/
  785. static void blk_add_trace_rq_remap(void *ignore,
  786. struct request_queue *q,
  787. struct request *rq, dev_t dev,
  788. sector_t from)
  789. {
  790. struct blk_trace *bt = q->blk_trace;
  791. struct blk_io_trace_remap r;
  792. if (likely(!bt))
  793. return;
  794. r.device_from = cpu_to_be32(dev);
  795. r.device_to = cpu_to_be32(disk_devt(rq->rq_disk));
  796. r.sector_from = cpu_to_be64(from);
  797. __blk_add_trace(bt, blk_rq_pos(rq), blk_rq_bytes(rq),
  798. rq_data_dir(rq), BLK_TA_REMAP, !!rq->errors,
  799. sizeof(r), &r);
  800. }
  801. /**
  802. * blk_add_driver_data - Add binary message with driver-specific data
  803. * @q: queue the io is for
  804. * @rq: io request
  805. * @data: driver-specific data
  806. * @len: length of driver-specific data
  807. *
  808. * Description:
  809. * Some drivers might want to write driver-specific data per request.
  810. *
  811. **/
  812. void blk_add_driver_data(struct request_queue *q,
  813. struct request *rq,
  814. void *data, size_t len)
  815. {
  816. struct blk_trace *bt = q->blk_trace;
  817. if (likely(!bt))
  818. return;
  819. if (rq->cmd_type == REQ_TYPE_BLOCK_PC)
  820. __blk_add_trace(bt, 0, blk_rq_bytes(rq), 0,
  821. BLK_TA_DRV_DATA, rq->errors, len, data);
  822. else
  823. __blk_add_trace(bt, blk_rq_pos(rq), blk_rq_bytes(rq), 0,
  824. BLK_TA_DRV_DATA, rq->errors, len, data);
  825. }
  826. EXPORT_SYMBOL_GPL(blk_add_driver_data);
  827. static void blk_register_tracepoints(void)
  828. {
  829. int ret;
  830. ret = register_trace_block_rq_abort(blk_add_trace_rq_abort, NULL);
  831. WARN_ON(ret);
  832. ret = register_trace_block_rq_insert(blk_add_trace_rq_insert, NULL);
  833. WARN_ON(ret);
  834. ret = register_trace_block_rq_issue(blk_add_trace_rq_issue, NULL);
  835. WARN_ON(ret);
  836. ret = register_trace_block_rq_requeue(blk_add_trace_rq_requeue, NULL);
  837. WARN_ON(ret);
  838. ret = register_trace_block_rq_complete(blk_add_trace_rq_complete, NULL);
  839. WARN_ON(ret);
  840. ret = register_trace_block_bio_bounce(blk_add_trace_bio_bounce, NULL);
  841. WARN_ON(ret);
  842. ret = register_trace_block_bio_complete(blk_add_trace_bio_complete, NULL);
  843. WARN_ON(ret);
  844. ret = register_trace_block_bio_backmerge(blk_add_trace_bio_backmerge, NULL);
  845. WARN_ON(ret);
  846. ret = register_trace_block_bio_frontmerge(blk_add_trace_bio_frontmerge, NULL);
  847. WARN_ON(ret);
  848. ret = register_trace_block_bio_queue(blk_add_trace_bio_queue, NULL);
  849. WARN_ON(ret);
  850. ret = register_trace_block_getrq(blk_add_trace_getrq, NULL);
  851. WARN_ON(ret);
  852. ret = register_trace_block_sleeprq(blk_add_trace_sleeprq, NULL);
  853. WARN_ON(ret);
  854. ret = register_trace_block_plug(blk_add_trace_plug, NULL);
  855. WARN_ON(ret);
  856. ret = register_trace_block_unplug(blk_add_trace_unplug, NULL);
  857. WARN_ON(ret);
  858. ret = register_trace_block_split(blk_add_trace_split, NULL);
  859. WARN_ON(ret);
  860. ret = register_trace_block_bio_remap(blk_add_trace_bio_remap, NULL);
  861. WARN_ON(ret);
  862. ret = register_trace_block_rq_remap(blk_add_trace_rq_remap, NULL);
  863. WARN_ON(ret);
  864. }
  865. static void blk_unregister_tracepoints(void)
  866. {
  867. unregister_trace_block_rq_remap(blk_add_trace_rq_remap, NULL);
  868. unregister_trace_block_bio_remap(blk_add_trace_bio_remap, NULL);
  869. unregister_trace_block_split(blk_add_trace_split, NULL);
  870. unregister_trace_block_unplug(blk_add_trace_unplug, NULL);
  871. unregister_trace_block_plug(blk_add_trace_plug, NULL);
  872. unregister_trace_block_sleeprq(blk_add_trace_sleeprq, NULL);
  873. unregister_trace_block_getrq(blk_add_trace_getrq, NULL);
  874. unregister_trace_block_bio_queue(blk_add_trace_bio_queue, NULL);
  875. unregister_trace_block_bio_frontmerge(blk_add_trace_bio_frontmerge, NULL);
  876. unregister_trace_block_bio_backmerge(blk_add_trace_bio_backmerge, NULL);
  877. unregister_trace_block_bio_complete(blk_add_trace_bio_complete, NULL);
  878. unregister_trace_block_bio_bounce(blk_add_trace_bio_bounce, NULL);
  879. unregister_trace_block_rq_complete(blk_add_trace_rq_complete, NULL);
  880. unregister_trace_block_rq_requeue(blk_add_trace_rq_requeue, NULL);
  881. unregister_trace_block_rq_issue(blk_add_trace_rq_issue, NULL);
  882. unregister_trace_block_rq_insert(blk_add_trace_rq_insert, NULL);
  883. unregister_trace_block_rq_abort(blk_add_trace_rq_abort, NULL);
  884. tracepoint_synchronize_unregister();
  885. }
  886. /*
  887. * struct blk_io_tracer formatting routines
  888. */
  889. static void fill_rwbs(char *rwbs, const struct blk_io_trace *t)
  890. {
  891. int i = 0;
  892. int tc = t->action >> BLK_TC_SHIFT;
  893. if (t->action == BLK_TN_MESSAGE) {
  894. rwbs[i++] = 'N';
  895. goto out;
  896. }
  897. if (tc & BLK_TC_FLUSH)
  898. rwbs[i++] = 'F';
  899. if (tc & BLK_TC_DISCARD)
  900. rwbs[i++] = 'D';
  901. else if (tc & BLK_TC_WRITE)
  902. rwbs[i++] = 'W';
  903. else if (t->bytes)
  904. rwbs[i++] = 'R';
  905. else
  906. rwbs[i++] = 'N';
  907. if (tc & BLK_TC_FUA)
  908. rwbs[i++] = 'F';
  909. if (tc & BLK_TC_AHEAD)
  910. rwbs[i++] = 'A';
  911. if (tc & BLK_TC_SYNC)
  912. rwbs[i++] = 'S';
  913. if (tc & BLK_TC_META)
  914. rwbs[i++] = 'M';
  915. out:
  916. rwbs[i] = '\0';
  917. }
  918. static inline
  919. const struct blk_io_trace *te_blk_io_trace(const struct trace_entry *ent)
  920. {
  921. return (const struct blk_io_trace *)ent;
  922. }
  923. static inline const void *pdu_start(const struct trace_entry *ent)
  924. {
  925. return te_blk_io_trace(ent) + 1;
  926. }
  927. static inline u32 t_action(const struct trace_entry *ent)
  928. {
  929. return te_blk_io_trace(ent)->action;
  930. }
  931. static inline u32 t_bytes(const struct trace_entry *ent)
  932. {
  933. return te_blk_io_trace(ent)->bytes;
  934. }
  935. static inline u32 t_sec(const struct trace_entry *ent)
  936. {
  937. return te_blk_io_trace(ent)->bytes >> 9;
  938. }
  939. static inline unsigned long long t_sector(const struct trace_entry *ent)
  940. {
  941. return te_blk_io_trace(ent)->sector;
  942. }
  943. static inline __u16 t_error(const struct trace_entry *ent)
  944. {
  945. return te_blk_io_trace(ent)->error;
  946. }
  947. static __u64 get_pdu_int(const struct trace_entry *ent)
  948. {
  949. const __u64 *val = pdu_start(ent);
  950. return be64_to_cpu(*val);
  951. }
  952. static void get_pdu_remap(const struct trace_entry *ent,
  953. struct blk_io_trace_remap *r)
  954. {
  955. const struct blk_io_trace_remap *__r = pdu_start(ent);
  956. __u64 sector_from = __r->sector_from;
  957. r->device_from = be32_to_cpu(__r->device_from);
  958. r->device_to = be32_to_cpu(__r->device_to);
  959. r->sector_from = be64_to_cpu(sector_from);
  960. }
  961. typedef int (blk_log_action_t) (struct trace_iterator *iter, const char *act);
  962. static int blk_log_action_classic(struct trace_iterator *iter, const char *act)
  963. {
  964. char rwbs[RWBS_LEN];
  965. unsigned long long ts = iter->ts;
  966. unsigned long nsec_rem = do_div(ts, NSEC_PER_SEC);
  967. unsigned secs = (unsigned long)ts;
  968. const struct blk_io_trace *t = te_blk_io_trace(iter->ent);
  969. fill_rwbs(rwbs, t);
  970. return trace_seq_printf(&iter->seq,
  971. "%3d,%-3d %2d %5d.%09lu %5u %2s %3s ",
  972. MAJOR(t->device), MINOR(t->device), iter->cpu,
  973. secs, nsec_rem, iter->ent->pid, act, rwbs);
  974. }
  975. static int blk_log_action(struct trace_iterator *iter, const char *act)
  976. {
  977. char rwbs[RWBS_LEN];
  978. const struct blk_io_trace *t = te_blk_io_trace(iter->ent);
  979. fill_rwbs(rwbs, t);
  980. return trace_seq_printf(&iter->seq, "%3d,%-3d %2s %3s ",
  981. MAJOR(t->device), MINOR(t->device), act, rwbs);
  982. }
  983. static int blk_log_dump_pdu(struct trace_seq *s, const struct trace_entry *ent)
  984. {
  985. const unsigned char *pdu_buf;
  986. int pdu_len;
  987. int i, end, ret;
  988. pdu_buf = pdu_start(ent);
  989. pdu_len = te_blk_io_trace(ent)->pdu_len;
  990. if (!pdu_len)
  991. return 1;
  992. /* find the last zero that needs to be printed */
  993. for (end = pdu_len - 1; end >= 0; end--)
  994. if (pdu_buf[end])
  995. break;
  996. end++;
  997. if (!trace_seq_putc(s, '('))
  998. return 0;
  999. for (i = 0; i < pdu_len; i++) {
  1000. ret = trace_seq_printf(s, "%s%02x",
  1001. i == 0 ? "" : " ", pdu_buf[i]);
  1002. if (!ret)
  1003. return ret;
  1004. /*
  1005. * stop when the rest is just zeroes and indicate so
  1006. * with a ".." appended
  1007. */
  1008. if (i == end && end != pdu_len - 1)
  1009. return trace_seq_puts(s, " ..) ");
  1010. }
  1011. return trace_seq_puts(s, ") ");
  1012. }
  1013. static int blk_log_generic(struct trace_seq *s, const struct trace_entry *ent)
  1014. {
  1015. char cmd[TASK_COMM_LEN];
  1016. trace_find_cmdline(ent->pid, cmd);
  1017. if (t_action(ent) & BLK_TC_ACT(BLK_TC_PC)) {
  1018. int ret;
  1019. ret = trace_seq_printf(s, "%u ", t_bytes(ent));
  1020. if (!ret)
  1021. return 0;
  1022. ret = blk_log_dump_pdu(s, ent);
  1023. if (!ret)
  1024. return 0;
  1025. return trace_seq_printf(s, "[%s]\n", cmd);
  1026. } else {
  1027. if (t_sec(ent))
  1028. return trace_seq_printf(s, "%llu + %u [%s]\n",
  1029. t_sector(ent), t_sec(ent), cmd);
  1030. return trace_seq_printf(s, "[%s]\n", cmd);
  1031. }
  1032. }
  1033. static int blk_log_with_error(struct trace_seq *s,
  1034. const struct trace_entry *ent)
  1035. {
  1036. if (t_action(ent) & BLK_TC_ACT(BLK_TC_PC)) {
  1037. int ret;
  1038. ret = blk_log_dump_pdu(s, ent);
  1039. if (ret)
  1040. return trace_seq_printf(s, "[%d]\n", t_error(ent));
  1041. return 0;
  1042. } else {
  1043. if (t_sec(ent))
  1044. return trace_seq_printf(s, "%llu + %u [%d]\n",
  1045. t_sector(ent),
  1046. t_sec(ent), t_error(ent));
  1047. return trace_seq_printf(s, "%llu [%d]\n",
  1048. t_sector(ent), t_error(ent));
  1049. }
  1050. }
  1051. static int blk_log_remap(struct trace_seq *s, const struct trace_entry *ent)
  1052. {
  1053. struct blk_io_trace_remap r = { .device_from = 0, };
  1054. get_pdu_remap(ent, &r);
  1055. return trace_seq_printf(s, "%llu + %u <- (%d,%d) %llu\n",
  1056. t_sector(ent), t_sec(ent),
  1057. MAJOR(r.device_from), MINOR(r.device_from),
  1058. (unsigned long long)r.sector_from);
  1059. }
  1060. static int blk_log_plug(struct trace_seq *s, const struct trace_entry *ent)
  1061. {
  1062. char cmd[TASK_COMM_LEN];
  1063. trace_find_cmdline(ent->pid, cmd);
  1064. return trace_seq_printf(s, "[%s]\n", cmd);
  1065. }
  1066. static int blk_log_unplug(struct trace_seq *s, const struct trace_entry *ent)
  1067. {
  1068. char cmd[TASK_COMM_LEN];
  1069. trace_find_cmdline(ent->pid, cmd);
  1070. return trace_seq_printf(s, "[%s] %llu\n", cmd, get_pdu_int(ent));
  1071. }
  1072. static int blk_log_split(struct trace_seq *s, const struct trace_entry *ent)
  1073. {
  1074. char cmd[TASK_COMM_LEN];
  1075. trace_find_cmdline(ent->pid, cmd);
  1076. return trace_seq_printf(s, "%llu / %llu [%s]\n", t_sector(ent),
  1077. get_pdu_int(ent), cmd);
  1078. }
  1079. static int blk_log_msg(struct trace_seq *s, const struct trace_entry *ent)
  1080. {
  1081. int ret;
  1082. const struct blk_io_trace *t = te_blk_io_trace(ent);
  1083. ret = trace_seq_putmem(s, t + 1, t->pdu_len);
  1084. if (ret)
  1085. return trace_seq_putc(s, '\n');
  1086. return ret;
  1087. }
  1088. /*
  1089. * struct tracer operations
  1090. */
  1091. static void blk_tracer_print_header(struct seq_file *m)
  1092. {
  1093. if (!(blk_tracer_flags.val & TRACE_BLK_OPT_CLASSIC))
  1094. return;
  1095. seq_puts(m, "# DEV CPU TIMESTAMP PID ACT FLG\n"
  1096. "# | | | | | |\n");
  1097. }
  1098. static void blk_tracer_start(struct trace_array *tr)
  1099. {
  1100. blk_tracer_enabled = true;
  1101. }
  1102. static int blk_tracer_init(struct trace_array *tr)
  1103. {
  1104. blk_tr = tr;
  1105. blk_tracer_start(tr);
  1106. return 0;
  1107. }
  1108. static void blk_tracer_stop(struct trace_array *tr)
  1109. {
  1110. blk_tracer_enabled = false;
  1111. }
  1112. static void blk_tracer_reset(struct trace_array *tr)
  1113. {
  1114. blk_tracer_stop(tr);
  1115. }
  1116. static const struct {
  1117. const char *act[2];
  1118. int (*print)(struct trace_seq *s, const struct trace_entry *ent);
  1119. } what2act[] = {
  1120. [__BLK_TA_QUEUE] = {{ "Q", "queue" }, blk_log_generic },
  1121. [__BLK_TA_BACKMERGE] = {{ "M", "backmerge" }, blk_log_generic },
  1122. [__BLK_TA_FRONTMERGE] = {{ "F", "frontmerge" }, blk_log_generic },
  1123. [__BLK_TA_GETRQ] = {{ "G", "getrq" }, blk_log_generic },
  1124. [__BLK_TA_SLEEPRQ] = {{ "S", "sleeprq" }, blk_log_generic },
  1125. [__BLK_TA_REQUEUE] = {{ "R", "requeue" }, blk_log_with_error },
  1126. [__BLK_TA_ISSUE] = {{ "D", "issue" }, blk_log_generic },
  1127. [__BLK_TA_COMPLETE] = {{ "C", "complete" }, blk_log_with_error },
  1128. [__BLK_TA_PLUG] = {{ "P", "plug" }, blk_log_plug },
  1129. [__BLK_TA_UNPLUG_IO] = {{ "U", "unplug_io" }, blk_log_unplug },
  1130. [__BLK_TA_UNPLUG_TIMER] = {{ "UT", "unplug_timer" }, blk_log_unplug },
  1131. [__BLK_TA_INSERT] = {{ "I", "insert" }, blk_log_generic },
  1132. [__BLK_TA_SPLIT] = {{ "X", "split" }, blk_log_split },
  1133. [__BLK_TA_BOUNCE] = {{ "B", "bounce" }, blk_log_generic },
  1134. [__BLK_TA_REMAP] = {{ "A", "remap" }, blk_log_remap },
  1135. };
  1136. static enum print_line_t print_one_line(struct trace_iterator *iter,
  1137. bool classic)
  1138. {
  1139. struct trace_seq *s = &iter->seq;
  1140. const struct blk_io_trace *t;
  1141. u16 what;
  1142. int ret;
  1143. bool long_act;
  1144. blk_log_action_t *log_action;
  1145. t = te_blk_io_trace(iter->ent);
  1146. what = t->action & ((1 << BLK_TC_SHIFT) - 1);
  1147. long_act = !!(trace_flags & TRACE_ITER_VERBOSE);
  1148. log_action = classic ? &blk_log_action_classic : &blk_log_action;
  1149. if (t->action == BLK_TN_MESSAGE) {
  1150. ret = log_action(iter, long_act ? "message" : "m");
  1151. if (ret)
  1152. ret = blk_log_msg(s, iter->ent);
  1153. goto out;
  1154. }
  1155. if (unlikely(what == 0 || what >= ARRAY_SIZE(what2act)))
  1156. ret = trace_seq_printf(s, "Unknown action %x\n", what);
  1157. else {
  1158. ret = log_action(iter, what2act[what].act[long_act]);
  1159. if (ret)
  1160. ret = what2act[what].print(s, iter->ent);
  1161. }
  1162. out:
  1163. return ret ? TRACE_TYPE_HANDLED : TRACE_TYPE_PARTIAL_LINE;
  1164. }
  1165. static enum print_line_t blk_trace_event_print(struct trace_iterator *iter,
  1166. int flags, struct trace_event *event)
  1167. {
  1168. return print_one_line(iter, false);
  1169. }
  1170. static int blk_trace_synthesize_old_trace(struct trace_iterator *iter)
  1171. {
  1172. struct trace_seq *s = &iter->seq;
  1173. struct blk_io_trace *t = (struct blk_io_trace *)iter->ent;
  1174. const int offset = offsetof(struct blk_io_trace, sector);
  1175. struct blk_io_trace old = {
  1176. .magic = BLK_IO_TRACE_MAGIC | BLK_IO_TRACE_VERSION,
  1177. .time = iter->ts,
  1178. };
  1179. if (!trace_seq_putmem(s, &old, offset))
  1180. return 0;
  1181. return trace_seq_putmem(s, &t->sector,
  1182. sizeof(old) - offset + t->pdu_len);
  1183. }
  1184. static enum print_line_t
  1185. blk_trace_event_print_binary(struct trace_iterator *iter, int flags,
  1186. struct trace_event *event)
  1187. {
  1188. return blk_trace_synthesize_old_trace(iter) ?
  1189. TRACE_TYPE_HANDLED : TRACE_TYPE_PARTIAL_LINE;
  1190. }
  1191. static enum print_line_t blk_tracer_print_line(struct trace_iterator *iter)
  1192. {
  1193. if (!(blk_tracer_flags.val & TRACE_BLK_OPT_CLASSIC))
  1194. return TRACE_TYPE_UNHANDLED;
  1195. return print_one_line(iter, true);
  1196. }
  1197. static int blk_tracer_set_flag(u32 old_flags, u32 bit, int set)
  1198. {
  1199. /* don't output context-info for blk_classic output */
  1200. if (bit == TRACE_BLK_OPT_CLASSIC) {
  1201. if (set)
  1202. trace_flags &= ~TRACE_ITER_CONTEXT_INFO;
  1203. else
  1204. trace_flags |= TRACE_ITER_CONTEXT_INFO;
  1205. }
  1206. return 0;
  1207. }
  1208. static struct tracer blk_tracer __read_mostly = {
  1209. .name = "blk",
  1210. .init = blk_tracer_init,
  1211. .reset = blk_tracer_reset,
  1212. .start = blk_tracer_start,
  1213. .stop = blk_tracer_stop,
  1214. .print_header = blk_tracer_print_header,
  1215. .print_line = blk_tracer_print_line,
  1216. .flags = &blk_tracer_flags,
  1217. .set_flag = blk_tracer_set_flag,
  1218. };
  1219. static struct trace_event_functions trace_blk_event_funcs = {
  1220. .trace = blk_trace_event_print,
  1221. .binary = blk_trace_event_print_binary,
  1222. };
  1223. static struct trace_event trace_blk_event = {
  1224. .type = TRACE_BLK,
  1225. .funcs = &trace_blk_event_funcs,
  1226. };
  1227. static int __init init_blk_tracer(void)
  1228. {
  1229. if (!register_ftrace_event(&trace_blk_event)) {
  1230. pr_warning("Warning: could not register block events\n");
  1231. return 1;
  1232. }
  1233. if (register_tracer(&blk_tracer) != 0) {
  1234. pr_warning("Warning: could not register the block tracer\n");
  1235. unregister_ftrace_event(&trace_blk_event);
  1236. return 1;
  1237. }
  1238. return 0;
  1239. }
  1240. device_initcall(init_blk_tracer);
  1241. static int blk_trace_remove_queue(struct request_queue *q)
  1242. {
  1243. struct blk_trace *bt;
  1244. bt = xchg(&q->blk_trace, NULL);
  1245. if (bt == NULL)
  1246. return -EINVAL;
  1247. if (atomic_dec_and_test(&blk_probes_ref))
  1248. blk_unregister_tracepoints();
  1249. blk_trace_free(bt);
  1250. return 0;
  1251. }
  1252. /*
  1253. * Setup everything required to start tracing
  1254. */
  1255. static int blk_trace_setup_queue(struct request_queue *q,
  1256. struct block_device *bdev)
  1257. {
  1258. struct blk_trace *old_bt, *bt = NULL;
  1259. int ret = -ENOMEM;
  1260. bt = kzalloc(sizeof(*bt), GFP_KERNEL);
  1261. if (!bt)
  1262. return -ENOMEM;
  1263. bt->msg_data = __alloc_percpu(BLK_TN_MAX_MSG, __alignof__(char));
  1264. if (!bt->msg_data)
  1265. goto free_bt;
  1266. bt->dev = bdev->bd_dev;
  1267. bt->act_mask = (u16)-1;
  1268. blk_trace_setup_lba(bt, bdev);
  1269. old_bt = xchg(&q->blk_trace, bt);
  1270. if (old_bt != NULL) {
  1271. (void)xchg(&q->blk_trace, old_bt);
  1272. ret = -EBUSY;
  1273. goto free_bt;
  1274. }
  1275. if (atomic_inc_return(&blk_probes_ref) == 1)
  1276. blk_register_tracepoints();
  1277. return 0;
  1278. free_bt:
  1279. blk_trace_free(bt);
  1280. return ret;
  1281. }
  1282. /*
  1283. * sysfs interface to enable and configure tracing
  1284. */
  1285. static ssize_t sysfs_blk_trace_attr_show(struct device *dev,
  1286. struct device_attribute *attr,
  1287. char *buf);
  1288. static ssize_t sysfs_blk_trace_attr_store(struct device *dev,
  1289. struct device_attribute *attr,
  1290. const char *buf, size_t count);
  1291. #define BLK_TRACE_DEVICE_ATTR(_name) \
  1292. DEVICE_ATTR(_name, S_IRUGO | S_IWUSR, \
  1293. sysfs_blk_trace_attr_show, \
  1294. sysfs_blk_trace_attr_store)
  1295. static BLK_TRACE_DEVICE_ATTR(enable);
  1296. static BLK_TRACE_DEVICE_ATTR(act_mask);
  1297. static BLK_TRACE_DEVICE_ATTR(pid);
  1298. static BLK_TRACE_DEVICE_ATTR(start_lba);
  1299. static BLK_TRACE_DEVICE_ATTR(end_lba);
  1300. static struct attribute *blk_trace_attrs[] = {
  1301. &dev_attr_enable.attr,
  1302. &dev_attr_act_mask.attr,
  1303. &dev_attr_pid.attr,
  1304. &dev_attr_start_lba.attr,
  1305. &dev_attr_end_lba.attr,
  1306. NULL
  1307. };
  1308. struct attribute_group blk_trace_attr_group = {
  1309. .name = "trace",
  1310. .attrs = blk_trace_attrs,
  1311. };
  1312. static const struct {
  1313. int mask;
  1314. const char *str;
  1315. } mask_maps[] = {
  1316. { BLK_TC_READ, "read" },
  1317. { BLK_TC_WRITE, "write" },
  1318. { BLK_TC_FLUSH, "flush" },
  1319. { BLK_TC_SYNC, "sync" },
  1320. { BLK_TC_QUEUE, "queue" },
  1321. { BLK_TC_REQUEUE, "requeue" },
  1322. { BLK_TC_ISSUE, "issue" },
  1323. { BLK_TC_COMPLETE, "complete" },
  1324. { BLK_TC_FS, "fs" },
  1325. { BLK_TC_PC, "pc" },
  1326. { BLK_TC_AHEAD, "ahead" },
  1327. { BLK_TC_META, "meta" },
  1328. { BLK_TC_DISCARD, "discard" },
  1329. { BLK_TC_DRV_DATA, "drv_data" },
  1330. { BLK_TC_FUA, "fua" },
  1331. };
  1332. static int blk_trace_str2mask(const char *str)
  1333. {
  1334. int i;
  1335. int mask = 0;
  1336. char *buf, *s, *token;
  1337. buf = kstrdup(str, GFP_KERNEL);
  1338. if (buf == NULL)
  1339. return -ENOMEM;
  1340. s = strstrip(buf);
  1341. while (1) {
  1342. token = strsep(&s, ",");
  1343. if (token == NULL)
  1344. break;
  1345. if (*token == '\0')
  1346. continue;
  1347. for (i = 0; i < ARRAY_SIZE(mask_maps); i++) {
  1348. if (strcasecmp(token, mask_maps[i].str) == 0) {
  1349. mask |= mask_maps[i].mask;
  1350. break;
  1351. }
  1352. }
  1353. if (i == ARRAY_SIZE(mask_maps)) {
  1354. mask = -EINVAL;
  1355. break;
  1356. }
  1357. }
  1358. kfree(buf);
  1359. return mask;
  1360. }
  1361. static ssize_t blk_trace_mask2str(char *buf, int mask)
  1362. {
  1363. int i;
  1364. char *p = buf;
  1365. for (i = 0; i < ARRAY_SIZE(mask_maps); i++) {
  1366. if (mask & mask_maps[i].mask) {
  1367. p += sprintf(p, "%s%s",
  1368. (p == buf) ? "" : ",", mask_maps[i].str);
  1369. }
  1370. }
  1371. *p++ = '\n';
  1372. return p - buf;
  1373. }
  1374. static struct request_queue *blk_trace_get_queue(struct block_device *bdev)
  1375. {
  1376. if (bdev->bd_disk == NULL)
  1377. return NULL;
  1378. return bdev_get_queue(bdev);
  1379. }
  1380. static ssize_t sysfs_blk_trace_attr_show(struct device *dev,
  1381. struct device_attribute *attr,
  1382. char *buf)
  1383. {
  1384. struct hd_struct *p = dev_to_part(dev);
  1385. struct request_queue *q;
  1386. struct block_device *bdev;
  1387. ssize_t ret = -ENXIO;
  1388. bdev = bdget(part_devt(p));
  1389. if (bdev == NULL)
  1390. goto out;
  1391. q = blk_trace_get_queue(bdev);
  1392. if (q == NULL)
  1393. goto out_bdput;
  1394. mutex_lock(&bdev->bd_mutex);
  1395. if (attr == &dev_attr_enable) {
  1396. ret = sprintf(buf, "%u\n", !!q->blk_trace);
  1397. goto out_unlock_bdev;
  1398. }
  1399. if (q->blk_trace == NULL)
  1400. ret = sprintf(buf, "disabled\n");
  1401. else if (attr == &dev_attr_act_mask)
  1402. ret = blk_trace_mask2str(buf, q->blk_trace->act_mask);
  1403. else if (attr == &dev_attr_pid)
  1404. ret = sprintf(buf, "%u\n", q->blk_trace->pid);
  1405. else if (attr == &dev_attr_start_lba)
  1406. ret = sprintf(buf, "%llu\n", q->blk_trace->start_lba);
  1407. else if (attr == &dev_attr_end_lba)
  1408. ret = sprintf(buf, "%llu\n", q->blk_trace->end_lba);
  1409. out_unlock_bdev:
  1410. mutex_unlock(&bdev->bd_mutex);
  1411. out_bdput:
  1412. bdput(bdev);
  1413. out:
  1414. return ret;
  1415. }
  1416. static ssize_t sysfs_blk_trace_attr_store(struct device *dev,
  1417. struct device_attribute *attr,
  1418. const char *buf, size_t count)
  1419. {
  1420. struct block_device *bdev;
  1421. struct request_queue *q;
  1422. struct hd_struct *p;
  1423. u64 value;
  1424. ssize_t ret = -EINVAL;
  1425. if (count == 0)
  1426. goto out;
  1427. if (attr == &dev_attr_act_mask) {
  1428. if (sscanf(buf, "%llx", &value) != 1) {
  1429. /* Assume it is a list of trace category names */
  1430. ret = blk_trace_str2mask(buf);
  1431. if (ret < 0)
  1432. goto out;
  1433. value = ret;
  1434. }
  1435. } else if (sscanf(buf, "%llu", &value) != 1)
  1436. goto out;
  1437. ret = -ENXIO;
  1438. p = dev_to_part(dev);
  1439. bdev = bdget(part_devt(p));
  1440. if (bdev == NULL)
  1441. goto out;
  1442. q = blk_trace_get_queue(bdev);
  1443. if (q == NULL)
  1444. goto out_bdput;
  1445. mutex_lock(&bdev->bd_mutex);
  1446. if (attr == &dev_attr_enable) {
  1447. if (value)
  1448. ret = blk_trace_setup_queue(q, bdev);
  1449. else
  1450. ret = blk_trace_remove_queue(q);
  1451. goto out_unlock_bdev;
  1452. }
  1453. ret = 0;
  1454. if (q->blk_trace == NULL)
  1455. ret = blk_trace_setup_queue(q, bdev);
  1456. if (ret == 0) {
  1457. if (attr == &dev_attr_act_mask)
  1458. q->blk_trace->act_mask = value;
  1459. else if (attr == &dev_attr_pid)
  1460. q->blk_trace->pid = value;
  1461. else if (attr == &dev_attr_start_lba)
  1462. q->blk_trace->start_lba = value;
  1463. else if (attr == &dev_attr_end_lba)
  1464. q->blk_trace->end_lba = value;
  1465. }
  1466. out_unlock_bdev:
  1467. mutex_unlock(&bdev->bd_mutex);
  1468. out_bdput:
  1469. bdput(bdev);
  1470. out:
  1471. return ret ? ret : count;
  1472. }
  1473. int blk_trace_init_sysfs(struct device *dev)
  1474. {
  1475. return sysfs_create_group(&dev->kobj, &blk_trace_attr_group);
  1476. }
  1477. void blk_trace_remove_sysfs(struct device *dev)
  1478. {
  1479. sysfs_remove_group(&dev->kobj, &blk_trace_attr_group);
  1480. }
  1481. #endif /* CONFIG_BLK_DEV_IO_TRACE */
  1482. #ifdef CONFIG_EVENT_TRACING
  1483. void blk_dump_cmd(char *buf, struct request *rq)
  1484. {
  1485. int i, end;
  1486. int len = rq->cmd_len;
  1487. unsigned char *cmd = rq->cmd;
  1488. if (rq->cmd_type != REQ_TYPE_BLOCK_PC) {
  1489. buf[0] = '\0';
  1490. return;
  1491. }
  1492. for (end = len - 1; end >= 0; end--)
  1493. if (cmd[end])
  1494. break;
  1495. end++;
  1496. for (i = 0; i < len; i++) {
  1497. buf += sprintf(buf, "%s%02x", i == 0 ? "" : " ", cmd[i]);
  1498. if (i == end && end != len - 1) {
  1499. sprintf(buf, " ..");
  1500. break;
  1501. }
  1502. }
  1503. }
  1504. void blk_fill_rwbs(char *rwbs, u32 rw, int bytes)
  1505. {
  1506. int i = 0;
  1507. if (rw & REQ_FLUSH)
  1508. rwbs[i++] = 'F';
  1509. if (rw & WRITE)
  1510. rwbs[i++] = 'W';
  1511. else if (rw & REQ_DISCARD)
  1512. rwbs[i++] = 'D';
  1513. else if (bytes)
  1514. rwbs[i++] = 'R';
  1515. else
  1516. rwbs[i++] = 'N';
  1517. if (rw & REQ_FUA)
  1518. rwbs[i++] = 'F';
  1519. if (rw & REQ_RAHEAD)
  1520. rwbs[i++] = 'A';
  1521. if (rw & REQ_SYNC)
  1522. rwbs[i++] = 'S';
  1523. if (rw & REQ_META)
  1524. rwbs[i++] = 'M';
  1525. if (rw & REQ_SECURE)
  1526. rwbs[i++] = 'E';
  1527. rwbs[i] = '\0';
  1528. }
  1529. #endif /* CONFIG_EVENT_TRACING */