2 * Copyright (C) 2006 Jens Axboe <axboe@kernel.dk>
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.
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.
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
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/debugfs.h>
25 #include <linux/time.h>
26 #include <trace/block.h>
27 #include <linux/uaccess.h>
28 #include "trace_output.h"
30 static unsigned int blktrace_seq __read_mostly = 1;
32 static struct trace_array *blk_tr;
33 static bool blk_tracer_enabled __read_mostly;
35 /* Select an alternative, minimalistic output than the original one */
36 #define TRACE_BLK_OPT_CLASSIC 0x1
38 static struct tracer_opt blk_tracer_opts[] = {
39 /* Default disable the minimalistic output */
40 { TRACER_OPT(blk_classic, TRACE_BLK_OPT_CLASSIC) },
44 static struct tracer_flags blk_tracer_flags = {
46 .opts = blk_tracer_opts,
49 /* Global reference count of probes */
50 static atomic_t blk_probes_ref = ATOMIC_INIT(0);
52 static void blk_register_tracepoints(void);
53 static void blk_unregister_tracepoints(void);
56 * Send out a notify message.
58 static void trace_note(struct blk_trace *bt, pid_t pid, int action,
59 const void *data, size_t len)
61 struct blk_io_trace *t;
62 struct ring_buffer_event *event = NULL;
64 int cpu = smp_processor_id();
65 bool blk_tracer = blk_tracer_enabled;
69 event = trace_buffer_lock_reserve(blk_tr, TRACE_BLK,
74 t = ring_buffer_event_data(event);
81 t = relay_reserve(bt->rchan, sizeof(*t) + len);
83 t->magic = BLK_IO_TRACE_MAGIC | BLK_IO_TRACE_VERSION;
84 t->time = ktime_to_ns(ktime_get());
91 memcpy((void *) t + sizeof(*t), data, len);
94 trace_buffer_unlock_commit(blk_tr, event, 0, pc);
99 * Send out a notify for this process, if we haven't done so since a trace
102 static void trace_note_tsk(struct blk_trace *bt, struct task_struct *tsk)
104 tsk->btrace_seq = blktrace_seq;
105 trace_note(bt, tsk->pid, BLK_TN_PROCESS, tsk->comm, sizeof(tsk->comm));
108 static void trace_note_time(struct blk_trace *bt)
114 getnstimeofday(&now);
115 words[0] = now.tv_sec;
116 words[1] = now.tv_nsec;
118 local_irq_save(flags);
119 trace_note(bt, 0, BLK_TN_TIMESTAMP, words, sizeof(words));
120 local_irq_restore(flags);
123 void __trace_note_message(struct blk_trace *bt, const char *fmt, ...)
130 if (unlikely(bt->trace_state != Blktrace_running &&
131 !blk_tracer_enabled))
134 local_irq_save(flags);
135 buf = per_cpu_ptr(bt->msg_data, smp_processor_id());
137 n = vscnprintf(buf, BLK_TN_MAX_MSG, fmt, args);
140 trace_note(bt, 0, BLK_TN_MESSAGE, buf, n);
141 local_irq_restore(flags);
143 EXPORT_SYMBOL_GPL(__trace_note_message);
145 static int act_log_check(struct blk_trace *bt, u32 what, sector_t sector,
148 if (((bt->act_mask << BLK_TC_SHIFT) & what) == 0)
150 if (sector < bt->start_lba || sector > bt->end_lba)
152 if (bt->pid && pid != bt->pid)
159 * Data direction bit lookup
161 static const u32 ddir_act[2] = { BLK_TC_ACT(BLK_TC_READ),
162 BLK_TC_ACT(BLK_TC_WRITE) };
164 /* The ilog2() calls fall out because they're constant */
165 #define MASK_TC_BIT(rw, __name) ((rw & (1 << BIO_RW_ ## __name)) << \
166 (ilog2(BLK_TC_ ## __name) + BLK_TC_SHIFT - BIO_RW_ ## __name))
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.
172 static void __blk_add_trace(struct blk_trace *bt, sector_t sector, int bytes,
173 int rw, u32 what, int error, int pdu_len, void *pdu_data)
175 struct task_struct *tsk = current;
176 struct ring_buffer_event *event = NULL;
177 struct blk_io_trace *t;
178 unsigned long flags = 0;
179 unsigned long *sequence;
182 bool blk_tracer = blk_tracer_enabled;
184 if (unlikely(bt->trace_state != Blktrace_running && !blk_tracer))
187 what |= ddir_act[rw & WRITE];
188 what |= MASK_TC_BIT(rw, BARRIER);
189 what |= MASK_TC_BIT(rw, SYNCIO);
190 what |= MASK_TC_BIT(rw, AHEAD);
191 what |= MASK_TC_BIT(rw, META);
192 what |= MASK_TC_BIT(rw, DISCARD);
195 if (unlikely(act_log_check(bt, what, sector, pid)))
197 cpu = raw_smp_processor_id();
200 tracing_record_cmdline(current);
202 pc = preempt_count();
203 event = trace_buffer_lock_reserve(blk_tr, TRACE_BLK,
204 sizeof(*t) + pdu_len,
208 t = ring_buffer_event_data(event);
213 * A word about the locking here - we disable interrupts to reserve
214 * some space in the relay per-cpu buffer, to prevent an irq
215 * from coming in and stepping on our toes.
217 local_irq_save(flags);
219 if (unlikely(tsk->btrace_seq != blktrace_seq))
220 trace_note_tsk(bt, tsk);
222 t = relay_reserve(bt->rchan, sizeof(*t) + pdu_len);
224 sequence = per_cpu_ptr(bt->sequence, cpu);
226 t->magic = BLK_IO_TRACE_MAGIC | BLK_IO_TRACE_VERSION;
227 t->sequence = ++(*sequence);
228 t->time = ktime_to_ns(ktime_get());
231 * These two are not needed in ftrace as they are in the
232 * generic trace_entry, filled by tracing_generic_entry_update,
233 * but for the trace_event->bin() synthesizer benefit we do it
244 t->pdu_len = pdu_len;
247 memcpy((void *) t + sizeof(*t), pdu_data, pdu_len);
250 trace_buffer_unlock_commit(blk_tr, event, 0, pc);
255 local_irq_restore(flags);
258 static struct dentry *blk_tree_root;
259 static DEFINE_MUTEX(blk_tree_mutex);
261 static void blk_trace_free(struct blk_trace *bt)
263 debugfs_remove(bt->msg_file);
264 debugfs_remove(bt->dropped_file);
265 relay_close(bt->rchan);
266 free_percpu(bt->sequence);
267 free_percpu(bt->msg_data);
271 static void blk_trace_cleanup(struct blk_trace *bt)
274 if (atomic_dec_and_test(&blk_probes_ref))
275 blk_unregister_tracepoints();
278 int blk_trace_remove(struct request_queue *q)
280 struct blk_trace *bt;
282 bt = xchg(&q->blk_trace, NULL);
286 if (bt->trace_state != Blktrace_running)
287 blk_trace_cleanup(bt);
291 EXPORT_SYMBOL_GPL(blk_trace_remove);
293 static int blk_dropped_open(struct inode *inode, struct file *filp)
295 filp->private_data = inode->i_private;
300 static ssize_t blk_dropped_read(struct file *filp, char __user *buffer,
301 size_t count, loff_t *ppos)
303 struct blk_trace *bt = filp->private_data;
306 snprintf(buf, sizeof(buf), "%u\n", atomic_read(&bt->dropped));
308 return simple_read_from_buffer(buffer, count, ppos, buf, strlen(buf));
311 static const struct file_operations blk_dropped_fops = {
312 .owner = THIS_MODULE,
313 .open = blk_dropped_open,
314 .read = blk_dropped_read,
317 static int blk_msg_open(struct inode *inode, struct file *filp)
319 filp->private_data = inode->i_private;
324 static ssize_t blk_msg_write(struct file *filp, const char __user *buffer,
325 size_t count, loff_t *ppos)
328 struct blk_trace *bt;
330 if (count > BLK_TN_MAX_MSG)
333 msg = kmalloc(count, GFP_KERNEL);
337 if (copy_from_user(msg, buffer, count)) {
342 bt = filp->private_data;
343 __trace_note_message(bt, "%s", msg);
349 static const struct file_operations blk_msg_fops = {
350 .owner = THIS_MODULE,
351 .open = blk_msg_open,
352 .write = blk_msg_write,
356 * Keep track of how many times we encountered a full subbuffer, to aid
357 * the user space app in telling how many lost events there were.
359 static int blk_subbuf_start_callback(struct rchan_buf *buf, void *subbuf,
360 void *prev_subbuf, size_t prev_padding)
362 struct blk_trace *bt;
364 if (!relay_buf_full(buf))
367 bt = buf->chan->private_data;
368 atomic_inc(&bt->dropped);
372 static int blk_remove_buf_file_callback(struct dentry *dentry)
374 struct dentry *parent = dentry->d_parent;
375 debugfs_remove(dentry);
378 * this will fail for all but the last file, but that is ok. what we
379 * care about is the top level buts->name directory going away, when
380 * the last trace file is gone. Then we don't have to rmdir() that
381 * manually on trace stop, so it nicely solves the issue with
382 * force killing of running traces.
385 debugfs_remove(parent);
389 static struct dentry *blk_create_buf_file_callback(const char *filename,
390 struct dentry *parent,
392 struct rchan_buf *buf,
395 return debugfs_create_file(filename, mode, parent, buf,
396 &relay_file_operations);
399 static struct rchan_callbacks blk_relay_callbacks = {
400 .subbuf_start = blk_subbuf_start_callback,
401 .create_buf_file = blk_create_buf_file_callback,
402 .remove_buf_file = blk_remove_buf_file_callback,
406 * Setup everything required to start tracing
408 int do_blk_trace_setup(struct request_queue *q, char *name, dev_t dev,
409 struct blk_user_trace_setup *buts)
411 struct blk_trace *old_bt, *bt = NULL;
412 struct dentry *dir = NULL;
415 if (!buts->buf_size || !buts->buf_nr)
418 strncpy(buts->name, name, BLKTRACE_BDEV_SIZE);
419 buts->name[BLKTRACE_BDEV_SIZE - 1] = '\0';
422 * some device names have larger paths - convert the slashes
423 * to underscores for this to work as expected
425 for (i = 0; i < strlen(buts->name); i++)
426 if (buts->name[i] == '/')
429 bt = kzalloc(sizeof(*bt), GFP_KERNEL);
434 bt->sequence = alloc_percpu(unsigned long);
438 bt->msg_data = __alloc_percpu(BLK_TN_MAX_MSG, __alignof__(char));
444 mutex_lock(&blk_tree_mutex);
445 if (!blk_tree_root) {
446 blk_tree_root = debugfs_create_dir("block", NULL);
447 if (!blk_tree_root) {
448 mutex_unlock(&blk_tree_mutex);
452 mutex_unlock(&blk_tree_mutex);
454 dir = debugfs_create_dir(buts->name, blk_tree_root);
461 atomic_set(&bt->dropped, 0);
464 bt->dropped_file = debugfs_create_file("dropped", 0444, dir, bt,
466 if (!bt->dropped_file)
469 bt->msg_file = debugfs_create_file("msg", 0222, dir, bt, &blk_msg_fops);
473 bt->rchan = relay_open("trace", dir, buts->buf_size,
474 buts->buf_nr, &blk_relay_callbacks, bt);
478 bt->act_mask = buts->act_mask;
480 bt->act_mask = (u16) -1;
482 bt->start_lba = buts->start_lba;
483 bt->end_lba = buts->end_lba;
488 bt->trace_state = Blktrace_setup;
491 old_bt = xchg(&q->blk_trace, bt);
493 (void) xchg(&q->blk_trace, old_bt);
497 if (atomic_inc_return(&blk_probes_ref) == 1)
498 blk_register_tracepoints();
506 int blk_trace_setup(struct request_queue *q, char *name, dev_t dev,
509 struct blk_user_trace_setup buts;
512 ret = copy_from_user(&buts, arg, sizeof(buts));
516 ret = do_blk_trace_setup(q, name, dev, &buts);
520 if (copy_to_user(arg, &buts, sizeof(buts)))
525 EXPORT_SYMBOL_GPL(blk_trace_setup);
527 int blk_trace_startstop(struct request_queue *q, int start)
530 struct blk_trace *bt = q->blk_trace;
536 * For starting a trace, we can transition from a setup or stopped
537 * trace. For stopping a trace, the state must be running
541 if (bt->trace_state == Blktrace_setup ||
542 bt->trace_state == Blktrace_stopped) {
545 bt->trace_state = Blktrace_running;
551 if (bt->trace_state == Blktrace_running) {
552 bt->trace_state = Blktrace_stopped;
553 relay_flush(bt->rchan);
560 EXPORT_SYMBOL_GPL(blk_trace_startstop);
563 * blk_trace_ioctl: - handle the ioctls associated with tracing
564 * @bdev: the block device
565 * @cmd: the ioctl cmd
566 * @arg: the argument data, if any
569 int blk_trace_ioctl(struct block_device *bdev, unsigned cmd, char __user *arg)
571 struct request_queue *q;
573 char b[BDEVNAME_SIZE];
575 q = bdev_get_queue(bdev);
579 mutex_lock(&bdev->bd_mutex);
584 ret = blk_trace_setup(q, b, bdev->bd_dev, arg);
589 ret = blk_trace_startstop(q, start);
591 case BLKTRACETEARDOWN:
592 ret = blk_trace_remove(q);
599 mutex_unlock(&bdev->bd_mutex);
604 * blk_trace_shutdown: - stop and cleanup trace structures
605 * @q: the request queue associated with the device
608 void blk_trace_shutdown(struct request_queue *q)
611 blk_trace_startstop(q, 0);
621 * blk_add_trace_rq - Add a trace for a request oriented action
622 * @q: queue the io is for
623 * @rq: the source request
627 * Records an action against a request. Will log the bio offset + size.
630 static void blk_add_trace_rq(struct request_queue *q, struct request *rq,
633 struct blk_trace *bt = q->blk_trace;
634 int rw = rq->cmd_flags & 0x03;
639 if (blk_discard_rq(rq))
640 rw |= (1 << BIO_RW_DISCARD);
642 if (blk_pc_request(rq)) {
643 what |= BLK_TC_ACT(BLK_TC_PC);
644 __blk_add_trace(bt, 0, rq->data_len, rw, what, rq->errors,
645 sizeof(rq->cmd), rq->cmd);
647 what |= BLK_TC_ACT(BLK_TC_FS);
648 __blk_add_trace(bt, rq->hard_sector, rq->hard_nr_sectors << 9,
649 rw, what, rq->errors, 0, NULL);
653 static void blk_add_trace_rq_abort(struct request_queue *q, struct request *rq)
655 blk_add_trace_rq(q, rq, BLK_TA_ABORT);
658 static void blk_add_trace_rq_insert(struct request_queue *q, struct request *rq)
660 blk_add_trace_rq(q, rq, BLK_TA_INSERT);
663 static void blk_add_trace_rq_issue(struct request_queue *q, struct request *rq)
665 blk_add_trace_rq(q, rq, BLK_TA_ISSUE);
668 static void blk_add_trace_rq_requeue(struct request_queue *q,
671 blk_add_trace_rq(q, rq, BLK_TA_REQUEUE);
674 static void blk_add_trace_rq_complete(struct request_queue *q,
677 blk_add_trace_rq(q, rq, BLK_TA_COMPLETE);
681 * blk_add_trace_bio - Add a trace for a bio oriented action
682 * @q: queue the io is for
683 * @bio: the source bio
687 * Records an action against a bio. Will log the bio offset + size.
690 static void blk_add_trace_bio(struct request_queue *q, struct bio *bio,
693 struct blk_trace *bt = q->blk_trace;
698 __blk_add_trace(bt, bio->bi_sector, bio->bi_size, bio->bi_rw, what,
699 !bio_flagged(bio, BIO_UPTODATE), 0, NULL);
702 static void blk_add_trace_bio_bounce(struct request_queue *q, struct bio *bio)
704 blk_add_trace_bio(q, bio, BLK_TA_BOUNCE);
707 static void blk_add_trace_bio_complete(struct request_queue *q, struct bio *bio)
709 blk_add_trace_bio(q, bio, BLK_TA_COMPLETE);
712 static void blk_add_trace_bio_backmerge(struct request_queue *q,
715 blk_add_trace_bio(q, bio, BLK_TA_BACKMERGE);
718 static void blk_add_trace_bio_frontmerge(struct request_queue *q,
721 blk_add_trace_bio(q, bio, BLK_TA_FRONTMERGE);
724 static void blk_add_trace_bio_queue(struct request_queue *q, struct bio *bio)
726 blk_add_trace_bio(q, bio, BLK_TA_QUEUE);
729 static void blk_add_trace_getrq(struct request_queue *q,
730 struct bio *bio, int rw)
733 blk_add_trace_bio(q, bio, BLK_TA_GETRQ);
735 struct blk_trace *bt = q->blk_trace;
738 __blk_add_trace(bt, 0, 0, rw, BLK_TA_GETRQ, 0, 0, NULL);
743 static void blk_add_trace_sleeprq(struct request_queue *q,
744 struct bio *bio, int rw)
747 blk_add_trace_bio(q, bio, BLK_TA_SLEEPRQ);
749 struct blk_trace *bt = q->blk_trace;
752 __blk_add_trace(bt, 0, 0, rw, BLK_TA_SLEEPRQ,
757 static void blk_add_trace_plug(struct request_queue *q)
759 struct blk_trace *bt = q->blk_trace;
762 __blk_add_trace(bt, 0, 0, 0, BLK_TA_PLUG, 0, 0, NULL);
765 static void blk_add_trace_unplug_io(struct request_queue *q)
767 struct blk_trace *bt = q->blk_trace;
770 unsigned int pdu = q->rq.count[READ] + q->rq.count[WRITE];
771 __be64 rpdu = cpu_to_be64(pdu);
773 __blk_add_trace(bt, 0, 0, 0, BLK_TA_UNPLUG_IO, 0,
774 sizeof(rpdu), &rpdu);
778 static void blk_add_trace_unplug_timer(struct request_queue *q)
780 struct blk_trace *bt = q->blk_trace;
783 unsigned int pdu = q->rq.count[READ] + q->rq.count[WRITE];
784 __be64 rpdu = cpu_to_be64(pdu);
786 __blk_add_trace(bt, 0, 0, 0, BLK_TA_UNPLUG_TIMER, 0,
787 sizeof(rpdu), &rpdu);
791 static void blk_add_trace_split(struct request_queue *q, struct bio *bio,
794 struct blk_trace *bt = q->blk_trace;
797 __be64 rpdu = cpu_to_be64(pdu);
799 __blk_add_trace(bt, bio->bi_sector, bio->bi_size, bio->bi_rw,
800 BLK_TA_SPLIT, !bio_flagged(bio, BIO_UPTODATE),
801 sizeof(rpdu), &rpdu);
806 * blk_add_trace_remap - Add a trace for a remap operation
807 * @q: queue the io is for
808 * @bio: the source bio
809 * @dev: target device
810 * @from: source sector
814 * Device mapper or raid target sometimes need to split a bio because
815 * it spans a stripe (or similar). Add a trace for that action.
818 static void blk_add_trace_remap(struct request_queue *q, struct bio *bio,
819 dev_t dev, sector_t from, sector_t to)
821 struct blk_trace *bt = q->blk_trace;
822 struct blk_io_trace_remap r;
827 r.device = cpu_to_be32(dev);
828 r.device_from = cpu_to_be32(bio->bi_bdev->bd_dev);
829 r.sector = cpu_to_be64(to);
831 __blk_add_trace(bt, from, bio->bi_size, bio->bi_rw, BLK_TA_REMAP,
832 !bio_flagged(bio, BIO_UPTODATE), sizeof(r), &r);
836 * blk_add_driver_data - Add binary message with driver-specific data
837 * @q: queue the io is for
839 * @data: driver-specific data
840 * @len: length of driver-specific data
843 * Some drivers might want to write driver-specific data per request.
846 void blk_add_driver_data(struct request_queue *q,
848 void *data, size_t len)
850 struct blk_trace *bt = q->blk_trace;
855 if (blk_pc_request(rq))
856 __blk_add_trace(bt, 0, rq->data_len, 0, BLK_TA_DRV_DATA,
857 rq->errors, len, data);
859 __blk_add_trace(bt, rq->hard_sector, rq->hard_nr_sectors << 9,
860 0, BLK_TA_DRV_DATA, rq->errors, len, data);
862 EXPORT_SYMBOL_GPL(blk_add_driver_data);
864 static void blk_register_tracepoints(void)
868 ret = register_trace_block_rq_abort(blk_add_trace_rq_abort);
870 ret = register_trace_block_rq_insert(blk_add_trace_rq_insert);
872 ret = register_trace_block_rq_issue(blk_add_trace_rq_issue);
874 ret = register_trace_block_rq_requeue(blk_add_trace_rq_requeue);
876 ret = register_trace_block_rq_complete(blk_add_trace_rq_complete);
878 ret = register_trace_block_bio_bounce(blk_add_trace_bio_bounce);
880 ret = register_trace_block_bio_complete(blk_add_trace_bio_complete);
882 ret = register_trace_block_bio_backmerge(blk_add_trace_bio_backmerge);
884 ret = register_trace_block_bio_frontmerge(blk_add_trace_bio_frontmerge);
886 ret = register_trace_block_bio_queue(blk_add_trace_bio_queue);
888 ret = register_trace_block_getrq(blk_add_trace_getrq);
890 ret = register_trace_block_sleeprq(blk_add_trace_sleeprq);
892 ret = register_trace_block_plug(blk_add_trace_plug);
894 ret = register_trace_block_unplug_timer(blk_add_trace_unplug_timer);
896 ret = register_trace_block_unplug_io(blk_add_trace_unplug_io);
898 ret = register_trace_block_split(blk_add_trace_split);
900 ret = register_trace_block_remap(blk_add_trace_remap);
904 static void blk_unregister_tracepoints(void)
906 unregister_trace_block_remap(blk_add_trace_remap);
907 unregister_trace_block_split(blk_add_trace_split);
908 unregister_trace_block_unplug_io(blk_add_trace_unplug_io);
909 unregister_trace_block_unplug_timer(blk_add_trace_unplug_timer);
910 unregister_trace_block_plug(blk_add_trace_plug);
911 unregister_trace_block_sleeprq(blk_add_trace_sleeprq);
912 unregister_trace_block_getrq(blk_add_trace_getrq);
913 unregister_trace_block_bio_queue(blk_add_trace_bio_queue);
914 unregister_trace_block_bio_frontmerge(blk_add_trace_bio_frontmerge);
915 unregister_trace_block_bio_backmerge(blk_add_trace_bio_backmerge);
916 unregister_trace_block_bio_complete(blk_add_trace_bio_complete);
917 unregister_trace_block_bio_bounce(blk_add_trace_bio_bounce);
918 unregister_trace_block_rq_complete(blk_add_trace_rq_complete);
919 unregister_trace_block_rq_requeue(blk_add_trace_rq_requeue);
920 unregister_trace_block_rq_issue(blk_add_trace_rq_issue);
921 unregister_trace_block_rq_insert(blk_add_trace_rq_insert);
922 unregister_trace_block_rq_abort(blk_add_trace_rq_abort);
924 tracepoint_synchronize_unregister();
928 * struct blk_io_tracer formatting routines
931 static void fill_rwbs(char *rwbs, const struct blk_io_trace *t)
934 int tc = t->action >> BLK_TC_SHIFT;
936 if (t->action == BLK_TN_MESSAGE) {
941 if (tc & BLK_TC_DISCARD)
943 else if (tc & BLK_TC_WRITE)
950 if (tc & BLK_TC_AHEAD)
952 if (tc & BLK_TC_BARRIER)
954 if (tc & BLK_TC_SYNC)
956 if (tc & BLK_TC_META)
963 const struct blk_io_trace *te_blk_io_trace(const struct trace_entry *ent)
965 return (const struct blk_io_trace *)ent;
968 static inline const void *pdu_start(const struct trace_entry *ent)
970 return te_blk_io_trace(ent) + 1;
973 static inline u32 t_sec(const struct trace_entry *ent)
975 return te_blk_io_trace(ent)->bytes >> 9;
978 static inline unsigned long long t_sector(const struct trace_entry *ent)
980 return te_blk_io_trace(ent)->sector;
983 static inline __u16 t_error(const struct trace_entry *ent)
985 return te_blk_io_trace(ent)->error;
988 static __u64 get_pdu_int(const struct trace_entry *ent)
990 const __u64 *val = pdu_start(ent);
991 return be64_to_cpu(*val);
994 static void get_pdu_remap(const struct trace_entry *ent,
995 struct blk_io_trace_remap *r)
997 const struct blk_io_trace_remap *__r = pdu_start(ent);
998 __u64 sector = __r->sector;
1000 r->device = be32_to_cpu(__r->device);
1001 r->device_from = be32_to_cpu(__r->device_from);
1002 r->sector = be64_to_cpu(sector);
1005 typedef int (blk_log_action_t) (struct trace_iterator *iter, const char *act);
1007 static int blk_log_action_classic(struct trace_iterator *iter, const char *act)
1010 unsigned long long ts = iter->ts;
1011 unsigned long nsec_rem = do_div(ts, NSEC_PER_SEC);
1012 unsigned secs = (unsigned long)ts;
1013 const struct blk_io_trace *t = te_blk_io_trace(iter->ent);
1017 return trace_seq_printf(&iter->seq,
1018 "%3d,%-3d %2d %5d.%09lu %5u %2s %3s ",
1019 MAJOR(t->device), MINOR(t->device), iter->cpu,
1020 secs, nsec_rem, iter->ent->pid, act, rwbs);
1023 static int blk_log_action(struct trace_iterator *iter, const char *act)
1026 const struct blk_io_trace *t = te_blk_io_trace(iter->ent);
1029 return trace_seq_printf(&iter->seq, "%3d,%-3d %2s %3s ",
1030 MAJOR(t->device), MINOR(t->device), act, rwbs);
1033 static int blk_log_generic(struct trace_seq *s, const struct trace_entry *ent)
1035 char cmd[TASK_COMM_LEN];
1037 trace_find_cmdline(ent->pid, cmd);
1040 return trace_seq_printf(s, "%llu + %u [%s]\n",
1041 t_sector(ent), t_sec(ent), cmd);
1042 return trace_seq_printf(s, "[%s]\n", cmd);
1045 static int blk_log_with_error(struct trace_seq *s,
1046 const struct trace_entry *ent)
1049 return trace_seq_printf(s, "%llu + %u [%d]\n", t_sector(ent),
1050 t_sec(ent), t_error(ent));
1051 return trace_seq_printf(s, "%llu [%d]\n", t_sector(ent), t_error(ent));
1054 static int blk_log_remap(struct trace_seq *s, const struct trace_entry *ent)
1056 struct blk_io_trace_remap r = { .device = 0, };
1058 get_pdu_remap(ent, &r);
1059 return trace_seq_printf(s, "%llu + %u <- (%d,%d) %llu\n",
1061 t_sec(ent), MAJOR(r.device), MINOR(r.device),
1062 (unsigned long long)r.sector);
1065 static int blk_log_plug(struct trace_seq *s, const struct trace_entry *ent)
1067 char cmd[TASK_COMM_LEN];
1069 trace_find_cmdline(ent->pid, cmd);
1071 return trace_seq_printf(s, "[%s]\n", cmd);
1074 static int blk_log_unplug(struct trace_seq *s, const struct trace_entry *ent)
1076 char cmd[TASK_COMM_LEN];
1078 trace_find_cmdline(ent->pid, cmd);
1080 return trace_seq_printf(s, "[%s] %llu\n", cmd, get_pdu_int(ent));
1083 static int blk_log_split(struct trace_seq *s, const struct trace_entry *ent)
1085 char cmd[TASK_COMM_LEN];
1087 trace_find_cmdline(ent->pid, cmd);
1089 return trace_seq_printf(s, "%llu / %llu [%s]\n", t_sector(ent),
1090 get_pdu_int(ent), cmd);
1093 static int blk_log_msg(struct trace_seq *s, const struct trace_entry *ent)
1096 const struct blk_io_trace *t = te_blk_io_trace(ent);
1098 ret = trace_seq_putmem(s, t + 1, t->pdu_len);
1100 return trace_seq_putc(s, '\n');
1105 * struct tracer operations
1108 static void blk_tracer_print_header(struct seq_file *m)
1110 if (!(blk_tracer_flags.val & TRACE_BLK_OPT_CLASSIC))
1112 seq_puts(m, "# DEV CPU TIMESTAMP PID ACT FLG\n"
1116 static void blk_tracer_start(struct trace_array *tr)
1118 blk_tracer_enabled = true;
1119 trace_flags &= ~TRACE_ITER_CONTEXT_INFO;
1122 static int blk_tracer_init(struct trace_array *tr)
1125 blk_tracer_start(tr);
1129 static void blk_tracer_stop(struct trace_array *tr)
1131 blk_tracer_enabled = false;
1132 trace_flags |= TRACE_ITER_CONTEXT_INFO;
1135 static void blk_tracer_reset(struct trace_array *tr)
1137 blk_tracer_stop(tr);
1140 static const struct {
1142 int (*print)(struct trace_seq *s, const struct trace_entry *ent);
1144 [__BLK_TA_QUEUE] = {{ "Q", "queue" }, blk_log_generic },
1145 [__BLK_TA_BACKMERGE] = {{ "M", "backmerge" }, blk_log_generic },
1146 [__BLK_TA_FRONTMERGE] = {{ "F", "frontmerge" }, blk_log_generic },
1147 [__BLK_TA_GETRQ] = {{ "G", "getrq" }, blk_log_generic },
1148 [__BLK_TA_SLEEPRQ] = {{ "S", "sleeprq" }, blk_log_generic },
1149 [__BLK_TA_REQUEUE] = {{ "R", "requeue" }, blk_log_with_error },
1150 [__BLK_TA_ISSUE] = {{ "D", "issue" }, blk_log_generic },
1151 [__BLK_TA_COMPLETE] = {{ "C", "complete" }, blk_log_with_error },
1152 [__BLK_TA_PLUG] = {{ "P", "plug" }, blk_log_plug },
1153 [__BLK_TA_UNPLUG_IO] = {{ "U", "unplug_io" }, blk_log_unplug },
1154 [__BLK_TA_UNPLUG_TIMER] = {{ "UT", "unplug_timer" }, blk_log_unplug },
1155 [__BLK_TA_INSERT] = {{ "I", "insert" }, blk_log_generic },
1156 [__BLK_TA_SPLIT] = {{ "X", "split" }, blk_log_split },
1157 [__BLK_TA_BOUNCE] = {{ "B", "bounce" }, blk_log_generic },
1158 [__BLK_TA_REMAP] = {{ "A", "remap" }, blk_log_remap },
1161 static enum print_line_t print_one_line(struct trace_iterator *iter,
1164 struct trace_seq *s = &iter->seq;
1165 const struct blk_io_trace *t;
1169 blk_log_action_t *log_action;
1171 t = te_blk_io_trace(iter->ent);
1172 what = t->action & ((1 << BLK_TC_SHIFT) - 1);
1173 long_act = !!(trace_flags & TRACE_ITER_VERBOSE);
1174 log_action = classic ? &blk_log_action_classic : &blk_log_action;
1176 if (t->action == BLK_TN_MESSAGE) {
1177 ret = log_action(iter, long_act ? "message" : "m");
1179 ret = blk_log_msg(s, iter->ent);
1183 if (unlikely(what == 0 || what >= ARRAY_SIZE(what2act)))
1184 ret = trace_seq_printf(s, "Bad pc action %x\n", what);
1186 ret = log_action(iter, what2act[what].act[long_act]);
1188 ret = what2act[what].print(s, iter->ent);
1191 return ret ? TRACE_TYPE_HANDLED : TRACE_TYPE_PARTIAL_LINE;
1194 static enum print_line_t blk_trace_event_print(struct trace_iterator *iter,
1197 if (!trace_print_context(iter))
1198 return TRACE_TYPE_PARTIAL_LINE;
1200 return print_one_line(iter, false);
1203 static int blk_trace_synthesize_old_trace(struct trace_iterator *iter)
1205 struct trace_seq *s = &iter->seq;
1206 struct blk_io_trace *t = (struct blk_io_trace *)iter->ent;
1207 const int offset = offsetof(struct blk_io_trace, sector);
1208 struct blk_io_trace old = {
1209 .magic = BLK_IO_TRACE_MAGIC | BLK_IO_TRACE_VERSION,
1213 if (!trace_seq_putmem(s, &old, offset))
1215 return trace_seq_putmem(s, &t->sector,
1216 sizeof(old) - offset + t->pdu_len);
1219 static enum print_line_t
1220 blk_trace_event_print_binary(struct trace_iterator *iter, int flags)
1222 return blk_trace_synthesize_old_trace(iter) ?
1223 TRACE_TYPE_HANDLED : TRACE_TYPE_PARTIAL_LINE;
1226 static enum print_line_t blk_tracer_print_line(struct trace_iterator *iter)
1228 if (!(blk_tracer_flags.val & TRACE_BLK_OPT_CLASSIC))
1229 return TRACE_TYPE_UNHANDLED;
1231 return print_one_line(iter, true);
1234 static struct tracer blk_tracer __read_mostly = {
1236 .init = blk_tracer_init,
1237 .reset = blk_tracer_reset,
1238 .start = blk_tracer_start,
1239 .stop = blk_tracer_stop,
1240 .print_header = blk_tracer_print_header,
1241 .print_line = blk_tracer_print_line,
1242 .flags = &blk_tracer_flags,
1245 static struct trace_event trace_blk_event = {
1247 .trace = blk_trace_event_print,
1248 .binary = blk_trace_event_print_binary,
1251 static int __init init_blk_tracer(void)
1253 if (!register_ftrace_event(&trace_blk_event)) {
1254 pr_warning("Warning: could not register block events\n");
1258 if (register_tracer(&blk_tracer) != 0) {
1259 pr_warning("Warning: could not register the block tracer\n");
1260 unregister_ftrace_event(&trace_blk_event);
1267 device_initcall(init_blk_tracer);
1269 static int blk_trace_remove_queue(struct request_queue *q)
1271 struct blk_trace *bt;
1273 bt = xchg(&q->blk_trace, NULL);
1277 if (atomic_dec_and_test(&blk_probes_ref))
1278 blk_unregister_tracepoints();
1285 * Setup everything required to start tracing
1287 static int blk_trace_setup_queue(struct request_queue *q, dev_t dev)
1289 struct blk_trace *old_bt, *bt = NULL;
1292 bt = kzalloc(sizeof(*bt), GFP_KERNEL);
1296 bt->msg_data = __alloc_percpu(BLK_TN_MAX_MSG, __alignof__(char));
1301 bt->act_mask = (u16)-1;
1302 bt->end_lba = -1ULL;
1304 old_bt = xchg(&q->blk_trace, bt);
1305 if (old_bt != NULL) {
1306 (void)xchg(&q->blk_trace, old_bt);
1311 if (atomic_inc_return(&blk_probes_ref) == 1)
1312 blk_register_tracepoints();
1321 * sysfs interface to enable and configure tracing
1324 static ssize_t sysfs_blk_trace_attr_show(struct device *dev,
1325 struct device_attribute *attr,
1327 static ssize_t sysfs_blk_trace_attr_store(struct device *dev,
1328 struct device_attribute *attr,
1329 const char *buf, size_t count);
1330 #define BLK_TRACE_DEVICE_ATTR(_name) \
1331 DEVICE_ATTR(_name, S_IRUGO | S_IWUSR, \
1332 sysfs_blk_trace_attr_show, \
1333 sysfs_blk_trace_attr_store)
1335 static BLK_TRACE_DEVICE_ATTR(enable);
1336 static BLK_TRACE_DEVICE_ATTR(act_mask);
1337 static BLK_TRACE_DEVICE_ATTR(pid);
1338 static BLK_TRACE_DEVICE_ATTR(start_lba);
1339 static BLK_TRACE_DEVICE_ATTR(end_lba);
1341 static struct attribute *blk_trace_attrs[] = {
1342 &dev_attr_enable.attr,
1343 &dev_attr_act_mask.attr,
1345 &dev_attr_start_lba.attr,
1346 &dev_attr_end_lba.attr,
1350 struct attribute_group blk_trace_attr_group = {
1352 .attrs = blk_trace_attrs,
1355 static const struct {
1359 { BLK_TC_READ, "read" },
1360 { BLK_TC_WRITE, "write" },
1361 { BLK_TC_BARRIER, "barrier" },
1362 { BLK_TC_SYNC, "sync" },
1363 { BLK_TC_QUEUE, "queue" },
1364 { BLK_TC_REQUEUE, "requeue" },
1365 { BLK_TC_ISSUE, "issue" },
1366 { BLK_TC_COMPLETE, "complete" },
1367 { BLK_TC_FS, "fs" },
1368 { BLK_TC_PC, "pc" },
1369 { BLK_TC_AHEAD, "ahead" },
1370 { BLK_TC_META, "meta" },
1371 { BLK_TC_DISCARD, "discard" },
1372 { BLK_TC_DRV_DATA, "drv_data" },
1375 static int blk_trace_str2mask(const char *str)
1381 s = kstrdup(str, GFP_KERNEL);
1387 token = strsep(&s, ",");
1394 for (i = 0; i < ARRAY_SIZE(mask_maps); i++) {
1395 if (strcasecmp(token, mask_maps[i].str) == 0) {
1396 mask |= mask_maps[i].mask;
1400 if (i == ARRAY_SIZE(mask_maps)) {
1410 static ssize_t blk_trace_mask2str(char *buf, int mask)
1415 for (i = 0; i < ARRAY_SIZE(mask_maps); i++) {
1416 if (mask & mask_maps[i].mask) {
1417 p += sprintf(p, "%s%s",
1418 (p == buf) ? "" : ",", mask_maps[i].str);
1426 static struct request_queue *blk_trace_get_queue(struct block_device *bdev)
1428 if (bdev->bd_disk == NULL)
1431 return bdev_get_queue(bdev);
1434 static ssize_t sysfs_blk_trace_attr_show(struct device *dev,
1435 struct device_attribute *attr,
1438 struct hd_struct *p = dev_to_part(dev);
1439 struct request_queue *q;
1440 struct block_device *bdev;
1441 ssize_t ret = -ENXIO;
1444 bdev = bdget(part_devt(p));
1446 goto out_unlock_kernel;
1448 q = blk_trace_get_queue(bdev);
1452 mutex_lock(&bdev->bd_mutex);
1454 if (attr == &dev_attr_enable) {
1455 ret = sprintf(buf, "%u\n", !!q->blk_trace);
1456 goto out_unlock_bdev;
1459 if (q->blk_trace == NULL)
1460 ret = sprintf(buf, "disabled\n");
1461 else if (attr == &dev_attr_act_mask)
1462 ret = blk_trace_mask2str(buf, q->blk_trace->act_mask);
1463 else if (attr == &dev_attr_pid)
1464 ret = sprintf(buf, "%u\n", q->blk_trace->pid);
1465 else if (attr == &dev_attr_start_lba)
1466 ret = sprintf(buf, "%llu\n", q->blk_trace->start_lba);
1467 else if (attr == &dev_attr_end_lba)
1468 ret = sprintf(buf, "%llu\n", q->blk_trace->end_lba);
1471 mutex_unlock(&bdev->bd_mutex);
1479 static ssize_t sysfs_blk_trace_attr_store(struct device *dev,
1480 struct device_attribute *attr,
1481 const char *buf, size_t count)
1483 struct block_device *bdev;
1484 struct request_queue *q;
1485 struct hd_struct *p;
1487 ssize_t ret = -EINVAL;
1492 if (attr == &dev_attr_act_mask) {
1493 if (sscanf(buf, "%llx", &value) != 1) {
1494 /* Assume it is a list of trace category names */
1495 ret = blk_trace_str2mask(buf);
1500 } else if (sscanf(buf, "%llu", &value) != 1)
1506 p = dev_to_part(dev);
1507 bdev = bdget(part_devt(p));
1509 goto out_unlock_kernel;
1511 q = blk_trace_get_queue(bdev);
1515 mutex_lock(&bdev->bd_mutex);
1517 if (attr == &dev_attr_enable) {
1519 ret = blk_trace_setup_queue(q, bdev->bd_dev);
1521 ret = blk_trace_remove_queue(q);
1522 goto out_unlock_bdev;
1526 if (q->blk_trace == NULL)
1527 ret = blk_trace_setup_queue(q, bdev->bd_dev);
1530 if (attr == &dev_attr_act_mask)
1531 q->blk_trace->act_mask = value;
1532 else if (attr == &dev_attr_pid)
1533 q->blk_trace->pid = value;
1534 else if (attr == &dev_attr_start_lba)
1535 q->blk_trace->start_lba = value;
1536 else if (attr == &dev_attr_end_lba)
1537 q->blk_trace->end_lba = value;
1541 mutex_unlock(&bdev->bd_mutex);
1547 return ret ? ret : count;