blktrace.c 42 KB

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