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/slab.h>
25 #include <linux/debugfs.h>
26 #include <linux/export.h>
27 #include <linux/time.h>
28 #include <linux/uaccess.h>
30 #include <trace/events/block.h>
32 #include "trace_output.h"
34 #ifdef CONFIG_BLK_DEV_IO_TRACE
36 static unsigned int blktrace_seq __read_mostly = 1;
38 static struct trace_array *blk_tr;
39 static bool blk_tracer_enabled __read_mostly;
41 /* Select an alternative, minimalistic output than the original one */
42 #define TRACE_BLK_OPT_CLASSIC 0x1
44 static struct tracer_opt blk_tracer_opts[] = {
45 /* Default disable the minimalistic output */
46 { TRACER_OPT(blk_classic, TRACE_BLK_OPT_CLASSIC) },
50 static struct tracer_flags blk_tracer_flags = {
52 .opts = blk_tracer_opts,
55 /* Global reference count of probes */
56 static atomic_t blk_probes_ref = ATOMIC_INIT(0);
58 static void blk_register_tracepoints(void);
59 static void blk_unregister_tracepoints(void);
62 * Send out a notify message.
64 static void trace_note(struct blk_trace *bt, pid_t pid, int action,
65 const void *data, size_t len)
67 struct blk_io_trace *t;
68 struct ring_buffer_event *event = NULL;
69 struct ring_buffer *buffer = NULL;
71 int cpu = smp_processor_id();
72 bool blk_tracer = blk_tracer_enabled;
75 buffer = blk_tr->trace_buffer.buffer;
77 event = trace_buffer_lock_reserve(buffer, TRACE_BLK,
82 t = ring_buffer_event_data(event);
89 t = relay_reserve(bt->rchan, sizeof(*t) + len);
91 t->magic = BLK_IO_TRACE_MAGIC | BLK_IO_TRACE_VERSION;
92 t->time = ktime_to_ns(ktime_get());
99 memcpy((void *) t + sizeof(*t), data, len);
102 trace_buffer_unlock_commit(buffer, event, 0, pc);
107 * Send out a notify for this process, if we haven't done so since a trace
110 static void trace_note_tsk(struct blk_trace *bt, struct task_struct *tsk)
112 tsk->btrace_seq = blktrace_seq;
113 trace_note(bt, tsk->pid, BLK_TN_PROCESS, tsk->comm, sizeof(tsk->comm));
116 static void trace_note_time(struct blk_trace *bt)
122 getnstimeofday(&now);
123 words[0] = now.tv_sec;
124 words[1] = now.tv_nsec;
126 local_irq_save(flags);
127 trace_note(bt, 0, BLK_TN_TIMESTAMP, words, sizeof(words));
128 local_irq_restore(flags);
131 void __trace_note_message(struct blk_trace *bt, const char *fmt, ...)
138 if (unlikely(bt->trace_state != Blktrace_running &&
139 !blk_tracer_enabled))
143 * If the BLK_TC_NOTIFY action mask isn't set, don't send any note
144 * message to the trace.
146 if (!(bt->act_mask & BLK_TC_NOTIFY))
149 local_irq_save(flags);
150 buf = this_cpu_ptr(bt->msg_data);
152 n = vscnprintf(buf, BLK_TN_MAX_MSG, fmt, args);
155 trace_note(bt, 0, BLK_TN_MESSAGE, buf, n);
156 local_irq_restore(flags);
158 EXPORT_SYMBOL_GPL(__trace_note_message);
160 static int act_log_check(struct blk_trace *bt, u32 what, sector_t sector,
163 if (((bt->act_mask << BLK_TC_SHIFT) & what) == 0)
165 if (sector && (sector < bt->start_lba || sector > bt->end_lba))
167 if (bt->pid && pid != bt->pid)
174 * Data direction bit lookup
176 static const u32 ddir_act[2] = { BLK_TC_ACT(BLK_TC_READ),
177 BLK_TC_ACT(BLK_TC_WRITE) };
179 #define BLK_TC_RAHEAD BLK_TC_AHEAD
181 /* The ilog2() calls fall out because they're constant */
182 #define MASK_TC_BIT(rw, __name) ((rw & REQ_ ## __name) << \
183 (ilog2(BLK_TC_ ## __name) + BLK_TC_SHIFT - __REQ_ ## __name))
186 * The worker for the various blk_add_trace*() types. Fills out a
187 * blk_io_trace structure and places it in a per-cpu subbuffer.
189 static void __blk_add_trace(struct blk_trace *bt, sector_t sector, int bytes,
190 int rw, u32 what, int error, int pdu_len, void *pdu_data)
192 struct task_struct *tsk = current;
193 struct ring_buffer_event *event = NULL;
194 struct ring_buffer *buffer = NULL;
195 struct blk_io_trace *t;
196 unsigned long flags = 0;
197 unsigned long *sequence;
200 bool blk_tracer = blk_tracer_enabled;
202 if (unlikely(bt->trace_state != Blktrace_running && !blk_tracer))
205 what |= ddir_act[rw & WRITE];
206 what |= MASK_TC_BIT(rw, SYNC);
207 what |= MASK_TC_BIT(rw, RAHEAD);
208 what |= MASK_TC_BIT(rw, META);
209 what |= MASK_TC_BIT(rw, DISCARD);
210 what |= MASK_TC_BIT(rw, FLUSH);
211 what |= MASK_TC_BIT(rw, FUA);
214 if (act_log_check(bt, what, sector, pid))
216 cpu = raw_smp_processor_id();
219 tracing_record_cmdline(current);
221 buffer = blk_tr->trace_buffer.buffer;
222 pc = preempt_count();
223 event = trace_buffer_lock_reserve(buffer, TRACE_BLK,
224 sizeof(*t) + pdu_len,
228 t = ring_buffer_event_data(event);
233 * A word about the locking here - we disable interrupts to reserve
234 * some space in the relay per-cpu buffer, to prevent an irq
235 * from coming in and stepping on our toes.
237 local_irq_save(flags);
239 if (unlikely(tsk->btrace_seq != blktrace_seq))
240 trace_note_tsk(bt, tsk);
242 t = relay_reserve(bt->rchan, sizeof(*t) + pdu_len);
244 sequence = per_cpu_ptr(bt->sequence, cpu);
246 t->magic = BLK_IO_TRACE_MAGIC | BLK_IO_TRACE_VERSION;
247 t->sequence = ++(*sequence);
248 t->time = ktime_to_ns(ktime_get());
251 * These two are not needed in ftrace as they are in the
252 * generic trace_entry, filled by tracing_generic_entry_update,
253 * but for the trace_event->bin() synthesizer benefit we do it
264 t->pdu_len = pdu_len;
267 memcpy((void *) t + sizeof(*t), pdu_data, pdu_len);
270 trace_buffer_unlock_commit(buffer, event, 0, pc);
275 local_irq_restore(flags);
278 static struct dentry *blk_tree_root;
279 static DEFINE_MUTEX(blk_tree_mutex);
281 static void blk_trace_free(struct blk_trace *bt)
283 debugfs_remove(bt->msg_file);
284 debugfs_remove(bt->dropped_file);
285 relay_close(bt->rchan);
286 debugfs_remove(bt->dir);
287 free_percpu(bt->sequence);
288 free_percpu(bt->msg_data);
292 static void blk_trace_cleanup(struct blk_trace *bt)
295 if (atomic_dec_and_test(&blk_probes_ref))
296 blk_unregister_tracepoints();
299 int blk_trace_remove(struct request_queue *q)
301 struct blk_trace *bt;
303 bt = xchg(&q->blk_trace, NULL);
307 if (bt->trace_state != Blktrace_running)
308 blk_trace_cleanup(bt);
312 EXPORT_SYMBOL_GPL(blk_trace_remove);
314 static ssize_t blk_dropped_read(struct file *filp, char __user *buffer,
315 size_t count, loff_t *ppos)
317 struct blk_trace *bt = filp->private_data;
320 snprintf(buf, sizeof(buf), "%u\n", atomic_read(&bt->dropped));
322 return simple_read_from_buffer(buffer, count, ppos, buf, strlen(buf));
325 static const struct file_operations blk_dropped_fops = {
326 .owner = THIS_MODULE,
328 .read = blk_dropped_read,
329 .llseek = default_llseek,
332 static ssize_t blk_msg_write(struct file *filp, const char __user *buffer,
333 size_t count, loff_t *ppos)
336 struct blk_trace *bt;
338 if (count >= BLK_TN_MAX_MSG)
341 msg = kmalloc(count + 1, GFP_KERNEL);
345 if (copy_from_user(msg, buffer, count)) {
351 bt = filp->private_data;
352 __trace_note_message(bt, "%s", msg);
358 static const struct file_operations blk_msg_fops = {
359 .owner = THIS_MODULE,
361 .write = blk_msg_write,
362 .llseek = noop_llseek,
366 * Keep track of how many times we encountered a full subbuffer, to aid
367 * the user space app in telling how many lost events there were.
369 static int blk_subbuf_start_callback(struct rchan_buf *buf, void *subbuf,
370 void *prev_subbuf, size_t prev_padding)
372 struct blk_trace *bt;
374 if (!relay_buf_full(buf))
377 bt = buf->chan->private_data;
378 atomic_inc(&bt->dropped);
382 static int blk_remove_buf_file_callback(struct dentry *dentry)
384 debugfs_remove(dentry);
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,
405 static void blk_trace_setup_lba(struct blk_trace *bt,
406 struct block_device *bdev)
408 struct hd_struct *part = NULL;
411 part = bdev->bd_part;
414 bt->start_lba = part->start_sect;
415 bt->end_lba = part->start_sect + part->nr_sects;
423 * Setup everything required to start tracing
425 int do_blk_trace_setup(struct request_queue *q, char *name, dev_t dev,
426 struct block_device *bdev,
427 struct blk_user_trace_setup *buts)
429 struct blk_trace *old_bt, *bt = NULL;
430 struct dentry *dir = NULL;
433 if (!buts->buf_size || !buts->buf_nr)
436 strncpy(buts->name, name, BLKTRACE_BDEV_SIZE);
437 buts->name[BLKTRACE_BDEV_SIZE - 1] = '\0';
440 * some device names have larger paths - convert the slashes
441 * to underscores for this to work as expected
443 for (i = 0; i < strlen(buts->name); i++)
444 if (buts->name[i] == '/')
447 bt = kzalloc(sizeof(*bt), GFP_KERNEL);
452 bt->sequence = alloc_percpu(unsigned long);
456 bt->msg_data = __alloc_percpu(BLK_TN_MAX_MSG, __alignof__(char));
462 mutex_lock(&blk_tree_mutex);
463 if (!blk_tree_root) {
464 blk_tree_root = debugfs_create_dir("block", NULL);
465 if (!blk_tree_root) {
466 mutex_unlock(&blk_tree_mutex);
470 mutex_unlock(&blk_tree_mutex);
472 dir = debugfs_create_dir(buts->name, blk_tree_root);
479 atomic_set(&bt->dropped, 0);
482 bt->dropped_file = debugfs_create_file("dropped", 0444, dir, bt,
484 if (!bt->dropped_file)
487 bt->msg_file = debugfs_create_file("msg", 0222, dir, bt, &blk_msg_fops);
491 bt->rchan = relay_open("trace", dir, buts->buf_size,
492 buts->buf_nr, &blk_relay_callbacks, bt);
496 bt->act_mask = buts->act_mask;
498 bt->act_mask = (u16) -1;
500 blk_trace_setup_lba(bt, bdev);
502 /* overwrite with user settings */
504 bt->start_lba = buts->start_lba;
506 bt->end_lba = buts->end_lba;
509 bt->trace_state = Blktrace_setup;
512 old_bt = xchg(&q->blk_trace, bt);
514 (void) xchg(&q->blk_trace, old_bt);
518 if (atomic_inc_return(&blk_probes_ref) == 1)
519 blk_register_tracepoints();
527 int blk_trace_setup(struct request_queue *q, char *name, dev_t dev,
528 struct block_device *bdev,
531 struct blk_user_trace_setup buts;
534 ret = copy_from_user(&buts, arg, sizeof(buts));
538 ret = do_blk_trace_setup(q, name, dev, bdev, &buts);
542 if (copy_to_user(arg, &buts, sizeof(buts))) {
548 EXPORT_SYMBOL_GPL(blk_trace_setup);
550 #if defined(CONFIG_COMPAT) && defined(CONFIG_X86_64)
551 static int compat_blk_trace_setup(struct request_queue *q, char *name,
552 dev_t dev, struct block_device *bdev,
555 struct blk_user_trace_setup buts;
556 struct compat_blk_user_trace_setup cbuts;
559 if (copy_from_user(&cbuts, arg, sizeof(cbuts)))
562 buts = (struct blk_user_trace_setup) {
563 .act_mask = cbuts.act_mask,
564 .buf_size = cbuts.buf_size,
565 .buf_nr = cbuts.buf_nr,
566 .start_lba = cbuts.start_lba,
567 .end_lba = cbuts.end_lba,
570 memcpy(&buts.name, &cbuts.name, 32);
572 ret = do_blk_trace_setup(q, name, dev, bdev, &buts);
576 if (copy_to_user(arg, &buts.name, 32)) {
585 int blk_trace_startstop(struct request_queue *q, int start)
588 struct blk_trace *bt = q->blk_trace;
594 * For starting a trace, we can transition from a setup or stopped
595 * trace. For stopping a trace, the state must be running
599 if (bt->trace_state == Blktrace_setup ||
600 bt->trace_state == Blktrace_stopped) {
603 bt->trace_state = Blktrace_running;
609 if (bt->trace_state == Blktrace_running) {
610 bt->trace_state = Blktrace_stopped;
611 relay_flush(bt->rchan);
618 EXPORT_SYMBOL_GPL(blk_trace_startstop);
621 * blk_trace_ioctl: - handle the ioctls associated with tracing
622 * @bdev: the block device
623 * @cmd: the ioctl cmd
624 * @arg: the argument data, if any
627 int blk_trace_ioctl(struct block_device *bdev, unsigned cmd, char __user *arg)
629 struct request_queue *q;
631 char b[BDEVNAME_SIZE];
633 q = bdev_get_queue(bdev);
637 mutex_lock(&bdev->bd_mutex);
642 ret = blk_trace_setup(q, b, bdev->bd_dev, bdev, arg);
644 #if defined(CONFIG_COMPAT) && defined(CONFIG_X86_64)
645 case BLKTRACESETUP32:
647 ret = compat_blk_trace_setup(q, b, bdev->bd_dev, bdev, arg);
653 ret = blk_trace_startstop(q, start);
655 case BLKTRACETEARDOWN:
656 ret = blk_trace_remove(q);
663 mutex_unlock(&bdev->bd_mutex);
668 * blk_trace_shutdown: - stop and cleanup trace structures
669 * @q: the request queue associated with the device
672 void blk_trace_shutdown(struct request_queue *q)
675 blk_trace_startstop(q, 0);
685 * blk_add_trace_rq - Add a trace for a request oriented action
686 * @q: queue the io is for
687 * @rq: the source request
688 * @nr_bytes: number of completed bytes
692 * Records an action against a request. Will log the bio offset + size.
695 static void blk_add_trace_rq(struct request_queue *q, struct request *rq,
696 unsigned int nr_bytes, u32 what)
698 struct blk_trace *bt = q->blk_trace;
703 if (rq->cmd_type == REQ_TYPE_BLOCK_PC) {
704 what |= BLK_TC_ACT(BLK_TC_PC);
705 __blk_add_trace(bt, 0, nr_bytes, rq->cmd_flags,
706 what, rq->errors, rq->cmd_len, rq->cmd);
708 what |= BLK_TC_ACT(BLK_TC_FS);
709 __blk_add_trace(bt, blk_rq_pos(rq), nr_bytes,
710 rq->cmd_flags, what, rq->errors, 0, NULL);
714 static void blk_add_trace_rq_abort(void *ignore,
715 struct request_queue *q, struct request *rq)
717 blk_add_trace_rq(q, rq, blk_rq_bytes(rq), BLK_TA_ABORT);
720 static void blk_add_trace_rq_insert(void *ignore,
721 struct request_queue *q, struct request *rq)
723 blk_add_trace_rq(q, rq, blk_rq_bytes(rq), BLK_TA_INSERT);
726 static void blk_add_trace_rq_issue(void *ignore,
727 struct request_queue *q, struct request *rq)
729 blk_add_trace_rq(q, rq, blk_rq_bytes(rq), BLK_TA_ISSUE);
732 static void blk_add_trace_rq_requeue(void *ignore,
733 struct request_queue *q,
736 blk_add_trace_rq(q, rq, blk_rq_bytes(rq), BLK_TA_REQUEUE);
739 static void blk_add_trace_rq_complete(void *ignore,
740 struct request_queue *q,
742 unsigned int nr_bytes)
744 blk_add_trace_rq(q, rq, nr_bytes, BLK_TA_COMPLETE);
748 * blk_add_trace_bio - Add a trace for a bio oriented action
749 * @q: queue the io is for
750 * @bio: the source bio
752 * @error: error, if any
755 * Records an action against a bio. Will log the bio offset + size.
758 static void blk_add_trace_bio(struct request_queue *q, struct bio *bio,
761 struct blk_trace *bt = q->blk_trace;
766 if (!error && !bio_flagged(bio, BIO_UPTODATE))
769 __blk_add_trace(bt, bio->bi_sector, bio->bi_size, bio->bi_rw, what,
773 static void blk_add_trace_bio_bounce(void *ignore,
774 struct request_queue *q, struct bio *bio)
776 blk_add_trace_bio(q, bio, BLK_TA_BOUNCE, 0);
779 static void blk_add_trace_bio_complete(void *ignore,
780 struct request_queue *q, struct bio *bio,
783 blk_add_trace_bio(q, bio, BLK_TA_COMPLETE, error);
786 static void blk_add_trace_bio_backmerge(void *ignore,
787 struct request_queue *q,
791 blk_add_trace_bio(q, bio, BLK_TA_BACKMERGE, 0);
794 static void blk_add_trace_bio_frontmerge(void *ignore,
795 struct request_queue *q,
799 blk_add_trace_bio(q, bio, BLK_TA_FRONTMERGE, 0);
802 static void blk_add_trace_bio_queue(void *ignore,
803 struct request_queue *q, struct bio *bio)
805 blk_add_trace_bio(q, bio, BLK_TA_QUEUE, 0);
808 static void blk_add_trace_getrq(void *ignore,
809 struct request_queue *q,
810 struct bio *bio, int rw)
813 blk_add_trace_bio(q, bio, BLK_TA_GETRQ, 0);
815 struct blk_trace *bt = q->blk_trace;
818 __blk_add_trace(bt, 0, 0, rw, BLK_TA_GETRQ, 0, 0, NULL);
823 static void blk_add_trace_sleeprq(void *ignore,
824 struct request_queue *q,
825 struct bio *bio, int rw)
828 blk_add_trace_bio(q, bio, BLK_TA_SLEEPRQ, 0);
830 struct blk_trace *bt = q->blk_trace;
833 __blk_add_trace(bt, 0, 0, rw, BLK_TA_SLEEPRQ,
838 static void blk_add_trace_plug(void *ignore, struct request_queue *q)
840 struct blk_trace *bt = q->blk_trace;
843 __blk_add_trace(bt, 0, 0, 0, BLK_TA_PLUG, 0, 0, NULL);
846 static void blk_add_trace_unplug(void *ignore, struct request_queue *q,
847 unsigned int depth, bool explicit)
849 struct blk_trace *bt = q->blk_trace;
852 __be64 rpdu = cpu_to_be64(depth);
856 what = BLK_TA_UNPLUG_IO;
858 what = BLK_TA_UNPLUG_TIMER;
860 __blk_add_trace(bt, 0, 0, 0, what, 0, sizeof(rpdu), &rpdu);
864 static void blk_add_trace_split(void *ignore,
865 struct request_queue *q, struct bio *bio,
868 struct blk_trace *bt = q->blk_trace;
871 __be64 rpdu = cpu_to_be64(pdu);
873 __blk_add_trace(bt, bio->bi_sector, bio->bi_size, bio->bi_rw,
874 BLK_TA_SPLIT, !bio_flagged(bio, BIO_UPTODATE),
875 sizeof(rpdu), &rpdu);
880 * blk_add_trace_bio_remap - Add a trace for a bio-remap operation
881 * @ignore: trace callback data parameter (not used)
882 * @q: queue the io is for
883 * @bio: the source bio
884 * @dev: target device
885 * @from: source sector
888 * Device mapper or raid target sometimes need to split a bio because
889 * it spans a stripe (or similar). Add a trace for that action.
892 static void blk_add_trace_bio_remap(void *ignore,
893 struct request_queue *q, struct bio *bio,
894 dev_t dev, sector_t from)
896 struct blk_trace *bt = q->blk_trace;
897 struct blk_io_trace_remap r;
902 r.device_from = cpu_to_be32(dev);
903 r.device_to = cpu_to_be32(bio->bi_bdev->bd_dev);
904 r.sector_from = cpu_to_be64(from);
906 __blk_add_trace(bt, bio->bi_sector, bio->bi_size, bio->bi_rw,
907 BLK_TA_REMAP, !bio_flagged(bio, BIO_UPTODATE),
912 * blk_add_trace_rq_remap - Add a trace for a request-remap operation
913 * @ignore: trace callback data parameter (not used)
914 * @q: queue the io is for
915 * @rq: the source request
916 * @dev: target device
917 * @from: source sector
920 * Device mapper remaps request to other devices.
921 * Add a trace for that action.
924 static void blk_add_trace_rq_remap(void *ignore,
925 struct request_queue *q,
926 struct request *rq, dev_t dev,
929 struct blk_trace *bt = q->blk_trace;
930 struct blk_io_trace_remap r;
935 r.device_from = cpu_to_be32(dev);
936 r.device_to = cpu_to_be32(disk_devt(rq->rq_disk));
937 r.sector_from = cpu_to_be64(from);
939 __blk_add_trace(bt, blk_rq_pos(rq), blk_rq_bytes(rq),
940 rq_data_dir(rq), BLK_TA_REMAP, !!rq->errors,
945 * blk_add_driver_data - Add binary message with driver-specific data
946 * @q: queue the io is for
948 * @data: driver-specific data
949 * @len: length of driver-specific data
952 * Some drivers might want to write driver-specific data per request.
955 void blk_add_driver_data(struct request_queue *q,
957 void *data, size_t len)
959 struct blk_trace *bt = q->blk_trace;
964 if (rq->cmd_type == REQ_TYPE_BLOCK_PC)
965 __blk_add_trace(bt, 0, blk_rq_bytes(rq), 0,
966 BLK_TA_DRV_DATA, rq->errors, len, data);
968 __blk_add_trace(bt, blk_rq_pos(rq), blk_rq_bytes(rq), 0,
969 BLK_TA_DRV_DATA, rq->errors, len, data);
971 EXPORT_SYMBOL_GPL(blk_add_driver_data);
973 static void blk_register_tracepoints(void)
977 ret = register_trace_block_rq_abort(blk_add_trace_rq_abort, NULL);
979 ret = register_trace_block_rq_insert(blk_add_trace_rq_insert, NULL);
981 ret = register_trace_block_rq_issue(blk_add_trace_rq_issue, NULL);
983 ret = register_trace_block_rq_requeue(blk_add_trace_rq_requeue, NULL);
985 ret = register_trace_block_rq_complete(blk_add_trace_rq_complete, NULL);
987 ret = register_trace_block_bio_bounce(blk_add_trace_bio_bounce, NULL);
989 ret = register_trace_block_bio_complete(blk_add_trace_bio_complete, NULL);
991 ret = register_trace_block_bio_backmerge(blk_add_trace_bio_backmerge, NULL);
993 ret = register_trace_block_bio_frontmerge(blk_add_trace_bio_frontmerge, NULL);
995 ret = register_trace_block_bio_queue(blk_add_trace_bio_queue, NULL);
997 ret = register_trace_block_getrq(blk_add_trace_getrq, NULL);
999 ret = register_trace_block_sleeprq(blk_add_trace_sleeprq, NULL);
1001 ret = register_trace_block_plug(blk_add_trace_plug, NULL);
1003 ret = register_trace_block_unplug(blk_add_trace_unplug, NULL);
1005 ret = register_trace_block_split(blk_add_trace_split, NULL);
1007 ret = register_trace_block_bio_remap(blk_add_trace_bio_remap, NULL);
1009 ret = register_trace_block_rq_remap(blk_add_trace_rq_remap, NULL);
1013 static void blk_unregister_tracepoints(void)
1015 unregister_trace_block_rq_remap(blk_add_trace_rq_remap, NULL);
1016 unregister_trace_block_bio_remap(blk_add_trace_bio_remap, NULL);
1017 unregister_trace_block_split(blk_add_trace_split, NULL);
1018 unregister_trace_block_unplug(blk_add_trace_unplug, NULL);
1019 unregister_trace_block_plug(blk_add_trace_plug, NULL);
1020 unregister_trace_block_sleeprq(blk_add_trace_sleeprq, NULL);
1021 unregister_trace_block_getrq(blk_add_trace_getrq, NULL);
1022 unregister_trace_block_bio_queue(blk_add_trace_bio_queue, NULL);
1023 unregister_trace_block_bio_frontmerge(blk_add_trace_bio_frontmerge, NULL);
1024 unregister_trace_block_bio_backmerge(blk_add_trace_bio_backmerge, NULL);
1025 unregister_trace_block_bio_complete(blk_add_trace_bio_complete, NULL);
1026 unregister_trace_block_bio_bounce(blk_add_trace_bio_bounce, NULL);
1027 unregister_trace_block_rq_complete(blk_add_trace_rq_complete, NULL);
1028 unregister_trace_block_rq_requeue(blk_add_trace_rq_requeue, NULL);
1029 unregister_trace_block_rq_issue(blk_add_trace_rq_issue, NULL);
1030 unregister_trace_block_rq_insert(blk_add_trace_rq_insert, NULL);
1031 unregister_trace_block_rq_abort(blk_add_trace_rq_abort, NULL);
1033 tracepoint_synchronize_unregister();
1037 * struct blk_io_tracer formatting routines
1040 static void fill_rwbs(char *rwbs, const struct blk_io_trace *t)
1043 int tc = t->action >> BLK_TC_SHIFT;
1045 if (t->action == BLK_TN_MESSAGE) {
1050 if (tc & BLK_TC_FLUSH)
1053 if (tc & BLK_TC_DISCARD)
1055 else if (tc & BLK_TC_WRITE)
1062 if (tc & BLK_TC_FUA)
1064 if (tc & BLK_TC_AHEAD)
1066 if (tc & BLK_TC_SYNC)
1068 if (tc & BLK_TC_META)
1075 const struct blk_io_trace *te_blk_io_trace(const struct trace_entry *ent)
1077 return (const struct blk_io_trace *)ent;
1080 static inline const void *pdu_start(const struct trace_entry *ent)
1082 return te_blk_io_trace(ent) + 1;
1085 static inline u32 t_action(const struct trace_entry *ent)
1087 return te_blk_io_trace(ent)->action;
1090 static inline u32 t_bytes(const struct trace_entry *ent)
1092 return te_blk_io_trace(ent)->bytes;
1095 static inline u32 t_sec(const struct trace_entry *ent)
1097 return te_blk_io_trace(ent)->bytes >> 9;
1100 static inline unsigned long long t_sector(const struct trace_entry *ent)
1102 return te_blk_io_trace(ent)->sector;
1105 static inline __u16 t_error(const struct trace_entry *ent)
1107 return te_blk_io_trace(ent)->error;
1110 static __u64 get_pdu_int(const struct trace_entry *ent)
1112 const __u64 *val = pdu_start(ent);
1113 return be64_to_cpu(*val);
1116 static void get_pdu_remap(const struct trace_entry *ent,
1117 struct blk_io_trace_remap *r)
1119 const struct blk_io_trace_remap *__r = pdu_start(ent);
1120 __u64 sector_from = __r->sector_from;
1122 r->device_from = be32_to_cpu(__r->device_from);
1123 r->device_to = be32_to_cpu(__r->device_to);
1124 r->sector_from = be64_to_cpu(sector_from);
1127 typedef int (blk_log_action_t) (struct trace_iterator *iter, const char *act);
1129 static int blk_log_action_classic(struct trace_iterator *iter, const char *act)
1131 char rwbs[RWBS_LEN];
1132 unsigned long long ts = iter->ts;
1133 unsigned long nsec_rem = do_div(ts, NSEC_PER_SEC);
1134 unsigned secs = (unsigned long)ts;
1135 const struct blk_io_trace *t = te_blk_io_trace(iter->ent);
1139 return trace_seq_printf(&iter->seq,
1140 "%3d,%-3d %2d %5d.%09lu %5u %2s %3s ",
1141 MAJOR(t->device), MINOR(t->device), iter->cpu,
1142 secs, nsec_rem, iter->ent->pid, act, rwbs);
1145 static int blk_log_action(struct trace_iterator *iter, const char *act)
1147 char rwbs[RWBS_LEN];
1148 const struct blk_io_trace *t = te_blk_io_trace(iter->ent);
1151 return trace_seq_printf(&iter->seq, "%3d,%-3d %2s %3s ",
1152 MAJOR(t->device), MINOR(t->device), act, rwbs);
1155 static int blk_log_dump_pdu(struct trace_seq *s, const struct trace_entry *ent)
1157 const unsigned char *pdu_buf;
1161 pdu_buf = pdu_start(ent);
1162 pdu_len = te_blk_io_trace(ent)->pdu_len;
1167 /* find the last zero that needs to be printed */
1168 for (end = pdu_len - 1; end >= 0; end--)
1173 if (!trace_seq_putc(s, '('))
1176 for (i = 0; i < pdu_len; i++) {
1178 ret = trace_seq_printf(s, "%s%02x",
1179 i == 0 ? "" : " ", pdu_buf[i]);
1184 * stop when the rest is just zeroes and indicate so
1185 * with a ".." appended
1187 if (i == end && end != pdu_len - 1)
1188 return trace_seq_puts(s, " ..) ");
1191 return trace_seq_puts(s, ") ");
1194 static int blk_log_generic(struct trace_seq *s, const struct trace_entry *ent)
1196 char cmd[TASK_COMM_LEN];
1198 trace_find_cmdline(ent->pid, cmd);
1200 if (t_action(ent) & BLK_TC_ACT(BLK_TC_PC)) {
1203 ret = trace_seq_printf(s, "%u ", t_bytes(ent));
1206 ret = blk_log_dump_pdu(s, ent);
1209 return trace_seq_printf(s, "[%s]\n", cmd);
1212 return trace_seq_printf(s, "%llu + %u [%s]\n",
1213 t_sector(ent), t_sec(ent), cmd);
1214 return trace_seq_printf(s, "[%s]\n", cmd);
1218 static int blk_log_with_error(struct trace_seq *s,
1219 const struct trace_entry *ent)
1221 if (t_action(ent) & BLK_TC_ACT(BLK_TC_PC)) {
1224 ret = blk_log_dump_pdu(s, ent);
1226 return trace_seq_printf(s, "[%d]\n", t_error(ent));
1230 return trace_seq_printf(s, "%llu + %u [%d]\n",
1232 t_sec(ent), t_error(ent));
1233 return trace_seq_printf(s, "%llu [%d]\n",
1234 t_sector(ent), t_error(ent));
1238 static int blk_log_remap(struct trace_seq *s, const struct trace_entry *ent)
1240 struct blk_io_trace_remap r = { .device_from = 0, };
1242 get_pdu_remap(ent, &r);
1243 return trace_seq_printf(s, "%llu + %u <- (%d,%d) %llu\n",
1244 t_sector(ent), t_sec(ent),
1245 MAJOR(r.device_from), MINOR(r.device_from),
1246 (unsigned long long)r.sector_from);
1249 static int blk_log_plug(struct trace_seq *s, const struct trace_entry *ent)
1251 char cmd[TASK_COMM_LEN];
1253 trace_find_cmdline(ent->pid, cmd);
1255 return trace_seq_printf(s, "[%s]\n", cmd);
1258 static int blk_log_unplug(struct trace_seq *s, const struct trace_entry *ent)
1260 char cmd[TASK_COMM_LEN];
1262 trace_find_cmdline(ent->pid, cmd);
1264 return trace_seq_printf(s, "[%s] %llu\n", cmd, get_pdu_int(ent));
1267 static int blk_log_split(struct trace_seq *s, const struct trace_entry *ent)
1269 char cmd[TASK_COMM_LEN];
1271 trace_find_cmdline(ent->pid, cmd);
1273 return trace_seq_printf(s, "%llu / %llu [%s]\n", t_sector(ent),
1274 get_pdu_int(ent), cmd);
1277 static int blk_log_msg(struct trace_seq *s, const struct trace_entry *ent)
1280 const struct blk_io_trace *t = te_blk_io_trace(ent);
1282 ret = trace_seq_putmem(s, t + 1, t->pdu_len);
1284 return trace_seq_putc(s, '\n');
1289 * struct tracer operations
1292 static void blk_tracer_print_header(struct seq_file *m)
1294 if (!(blk_tracer_flags.val & TRACE_BLK_OPT_CLASSIC))
1296 seq_puts(m, "# DEV CPU TIMESTAMP PID ACT FLG\n"
1300 static void blk_tracer_start(struct trace_array *tr)
1302 blk_tracer_enabled = true;
1305 static int blk_tracer_init(struct trace_array *tr)
1308 blk_tracer_start(tr);
1312 static void blk_tracer_stop(struct trace_array *tr)
1314 blk_tracer_enabled = false;
1317 static void blk_tracer_reset(struct trace_array *tr)
1319 blk_tracer_stop(tr);
1322 static const struct {
1324 int (*print)(struct trace_seq *s, const struct trace_entry *ent);
1326 [__BLK_TA_QUEUE] = {{ "Q", "queue" }, blk_log_generic },
1327 [__BLK_TA_BACKMERGE] = {{ "M", "backmerge" }, blk_log_generic },
1328 [__BLK_TA_FRONTMERGE] = {{ "F", "frontmerge" }, blk_log_generic },
1329 [__BLK_TA_GETRQ] = {{ "G", "getrq" }, blk_log_generic },
1330 [__BLK_TA_SLEEPRQ] = {{ "S", "sleeprq" }, blk_log_generic },
1331 [__BLK_TA_REQUEUE] = {{ "R", "requeue" }, blk_log_with_error },
1332 [__BLK_TA_ISSUE] = {{ "D", "issue" }, blk_log_generic },
1333 [__BLK_TA_COMPLETE] = {{ "C", "complete" }, blk_log_with_error },
1334 [__BLK_TA_PLUG] = {{ "P", "plug" }, blk_log_plug },
1335 [__BLK_TA_UNPLUG_IO] = {{ "U", "unplug_io" }, blk_log_unplug },
1336 [__BLK_TA_UNPLUG_TIMER] = {{ "UT", "unplug_timer" }, blk_log_unplug },
1337 [__BLK_TA_INSERT] = {{ "I", "insert" }, blk_log_generic },
1338 [__BLK_TA_SPLIT] = {{ "X", "split" }, blk_log_split },
1339 [__BLK_TA_BOUNCE] = {{ "B", "bounce" }, blk_log_generic },
1340 [__BLK_TA_REMAP] = {{ "A", "remap" }, blk_log_remap },
1343 static enum print_line_t print_one_line(struct trace_iterator *iter,
1346 struct trace_seq *s = &iter->seq;
1347 const struct blk_io_trace *t;
1351 blk_log_action_t *log_action;
1353 t = te_blk_io_trace(iter->ent);
1354 what = t->action & ((1 << BLK_TC_SHIFT) - 1);
1355 long_act = !!(trace_flags & TRACE_ITER_VERBOSE);
1356 log_action = classic ? &blk_log_action_classic : &blk_log_action;
1358 if (t->action == BLK_TN_MESSAGE) {
1359 ret = log_action(iter, long_act ? "message" : "m");
1361 ret = blk_log_msg(s, iter->ent);
1365 if (unlikely(what == 0 || what >= ARRAY_SIZE(what2act)))
1366 ret = trace_seq_printf(s, "Unknown action %x\n", what);
1368 ret = log_action(iter, what2act[what].act[long_act]);
1370 ret = what2act[what].print(s, iter->ent);
1373 return ret ? TRACE_TYPE_HANDLED : TRACE_TYPE_PARTIAL_LINE;
1376 static enum print_line_t blk_trace_event_print(struct trace_iterator *iter,
1377 int flags, struct trace_event *event)
1379 return print_one_line(iter, false);
1382 static int blk_trace_synthesize_old_trace(struct trace_iterator *iter)
1384 struct trace_seq *s = &iter->seq;
1385 struct blk_io_trace *t = (struct blk_io_trace *)iter->ent;
1386 const int offset = offsetof(struct blk_io_trace, sector);
1387 struct blk_io_trace old = {
1388 .magic = BLK_IO_TRACE_MAGIC | BLK_IO_TRACE_VERSION,
1392 if (!trace_seq_putmem(s, &old, offset))
1394 return trace_seq_putmem(s, &t->sector,
1395 sizeof(old) - offset + t->pdu_len);
1398 static enum print_line_t
1399 blk_trace_event_print_binary(struct trace_iterator *iter, int flags,
1400 struct trace_event *event)
1402 return blk_trace_synthesize_old_trace(iter) ?
1403 TRACE_TYPE_HANDLED : TRACE_TYPE_PARTIAL_LINE;
1406 static enum print_line_t blk_tracer_print_line(struct trace_iterator *iter)
1408 if (!(blk_tracer_flags.val & TRACE_BLK_OPT_CLASSIC))
1409 return TRACE_TYPE_UNHANDLED;
1411 return print_one_line(iter, true);
1414 static int blk_tracer_set_flag(u32 old_flags, u32 bit, int set)
1416 /* don't output context-info for blk_classic output */
1417 if (bit == TRACE_BLK_OPT_CLASSIC) {
1419 trace_flags &= ~TRACE_ITER_CONTEXT_INFO;
1421 trace_flags |= TRACE_ITER_CONTEXT_INFO;
1426 static struct tracer blk_tracer __read_mostly = {
1428 .init = blk_tracer_init,
1429 .reset = blk_tracer_reset,
1430 .start = blk_tracer_start,
1431 .stop = blk_tracer_stop,
1432 .print_header = blk_tracer_print_header,
1433 .print_line = blk_tracer_print_line,
1434 .flags = &blk_tracer_flags,
1435 .set_flag = blk_tracer_set_flag,
1438 static struct trace_event_functions trace_blk_event_funcs = {
1439 .trace = blk_trace_event_print,
1440 .binary = blk_trace_event_print_binary,
1443 static struct trace_event trace_blk_event = {
1445 .funcs = &trace_blk_event_funcs,
1448 static int __init init_blk_tracer(void)
1450 if (!register_ftrace_event(&trace_blk_event)) {
1451 pr_warning("Warning: could not register block events\n");
1455 if (register_tracer(&blk_tracer) != 0) {
1456 pr_warning("Warning: could not register the block tracer\n");
1457 unregister_ftrace_event(&trace_blk_event);
1464 device_initcall(init_blk_tracer);
1466 static int blk_trace_remove_queue(struct request_queue *q)
1468 struct blk_trace *bt;
1470 bt = xchg(&q->blk_trace, NULL);
1474 if (atomic_dec_and_test(&blk_probes_ref))
1475 blk_unregister_tracepoints();
1482 * Setup everything required to start tracing
1484 static int blk_trace_setup_queue(struct request_queue *q,
1485 struct block_device *bdev)
1487 struct blk_trace *old_bt, *bt = NULL;
1490 bt = kzalloc(sizeof(*bt), GFP_KERNEL);
1494 bt->msg_data = __alloc_percpu(BLK_TN_MAX_MSG, __alignof__(char));
1498 bt->dev = bdev->bd_dev;
1499 bt->act_mask = (u16)-1;
1501 blk_trace_setup_lba(bt, bdev);
1503 old_bt = xchg(&q->blk_trace, bt);
1504 if (old_bt != NULL) {
1505 (void)xchg(&q->blk_trace, old_bt);
1510 if (atomic_inc_return(&blk_probes_ref) == 1)
1511 blk_register_tracepoints();
1520 * sysfs interface to enable and configure tracing
1523 static ssize_t sysfs_blk_trace_attr_show(struct device *dev,
1524 struct device_attribute *attr,
1526 static ssize_t sysfs_blk_trace_attr_store(struct device *dev,
1527 struct device_attribute *attr,
1528 const char *buf, size_t count);
1529 #define BLK_TRACE_DEVICE_ATTR(_name) \
1530 DEVICE_ATTR(_name, S_IRUGO | S_IWUSR, \
1531 sysfs_blk_trace_attr_show, \
1532 sysfs_blk_trace_attr_store)
1534 static BLK_TRACE_DEVICE_ATTR(enable);
1535 static BLK_TRACE_DEVICE_ATTR(act_mask);
1536 static BLK_TRACE_DEVICE_ATTR(pid);
1537 static BLK_TRACE_DEVICE_ATTR(start_lba);
1538 static BLK_TRACE_DEVICE_ATTR(end_lba);
1540 static struct attribute *blk_trace_attrs[] = {
1541 &dev_attr_enable.attr,
1542 &dev_attr_act_mask.attr,
1544 &dev_attr_start_lba.attr,
1545 &dev_attr_end_lba.attr,
1549 struct attribute_group blk_trace_attr_group = {
1551 .attrs = blk_trace_attrs,
1554 static const struct {
1558 { BLK_TC_READ, "read" },
1559 { BLK_TC_WRITE, "write" },
1560 { BLK_TC_FLUSH, "flush" },
1561 { BLK_TC_SYNC, "sync" },
1562 { BLK_TC_QUEUE, "queue" },
1563 { BLK_TC_REQUEUE, "requeue" },
1564 { BLK_TC_ISSUE, "issue" },
1565 { BLK_TC_COMPLETE, "complete" },
1566 { BLK_TC_FS, "fs" },
1567 { BLK_TC_PC, "pc" },
1568 { BLK_TC_AHEAD, "ahead" },
1569 { BLK_TC_META, "meta" },
1570 { BLK_TC_DISCARD, "discard" },
1571 { BLK_TC_DRV_DATA, "drv_data" },
1572 { BLK_TC_FUA, "fua" },
1575 static int blk_trace_str2mask(const char *str)
1579 char *buf, *s, *token;
1581 buf = kstrdup(str, GFP_KERNEL);
1587 token = strsep(&s, ",");
1594 for (i = 0; i < ARRAY_SIZE(mask_maps); i++) {
1595 if (strcasecmp(token, mask_maps[i].str) == 0) {
1596 mask |= mask_maps[i].mask;
1600 if (i == ARRAY_SIZE(mask_maps)) {
1610 static ssize_t blk_trace_mask2str(char *buf, int mask)
1615 for (i = 0; i < ARRAY_SIZE(mask_maps); i++) {
1616 if (mask & mask_maps[i].mask) {
1617 p += sprintf(p, "%s%s",
1618 (p == buf) ? "" : ",", mask_maps[i].str);
1626 static struct request_queue *blk_trace_get_queue(struct block_device *bdev)
1628 if (bdev->bd_disk == NULL)
1631 return bdev_get_queue(bdev);
1634 static ssize_t sysfs_blk_trace_attr_show(struct device *dev,
1635 struct device_attribute *attr,
1638 struct hd_struct *p = dev_to_part(dev);
1639 struct request_queue *q;
1640 struct block_device *bdev;
1641 ssize_t ret = -ENXIO;
1643 bdev = bdget(part_devt(p));
1647 q = blk_trace_get_queue(bdev);
1651 mutex_lock(&bdev->bd_mutex);
1653 if (attr == &dev_attr_enable) {
1654 ret = sprintf(buf, "%u\n", !!q->blk_trace);
1655 goto out_unlock_bdev;
1658 if (q->blk_trace == NULL)
1659 ret = sprintf(buf, "disabled\n");
1660 else if (attr == &dev_attr_act_mask)
1661 ret = blk_trace_mask2str(buf, q->blk_trace->act_mask);
1662 else if (attr == &dev_attr_pid)
1663 ret = sprintf(buf, "%u\n", q->blk_trace->pid);
1664 else if (attr == &dev_attr_start_lba)
1665 ret = sprintf(buf, "%llu\n", q->blk_trace->start_lba);
1666 else if (attr == &dev_attr_end_lba)
1667 ret = sprintf(buf, "%llu\n", q->blk_trace->end_lba);
1670 mutex_unlock(&bdev->bd_mutex);
1677 static ssize_t sysfs_blk_trace_attr_store(struct device *dev,
1678 struct device_attribute *attr,
1679 const char *buf, size_t count)
1681 struct block_device *bdev;
1682 struct request_queue *q;
1683 struct hd_struct *p;
1685 ssize_t ret = -EINVAL;
1690 if (attr == &dev_attr_act_mask) {
1691 if (sscanf(buf, "%llx", &value) != 1) {
1692 /* Assume it is a list of trace category names */
1693 ret = blk_trace_str2mask(buf);
1698 } else if (sscanf(buf, "%llu", &value) != 1)
1703 p = dev_to_part(dev);
1704 bdev = bdget(part_devt(p));
1708 q = blk_trace_get_queue(bdev);
1712 mutex_lock(&bdev->bd_mutex);
1714 if (attr == &dev_attr_enable) {
1716 ret = blk_trace_setup_queue(q, bdev);
1718 ret = blk_trace_remove_queue(q);
1719 goto out_unlock_bdev;
1723 if (q->blk_trace == NULL)
1724 ret = blk_trace_setup_queue(q, bdev);
1727 if (attr == &dev_attr_act_mask)
1728 q->blk_trace->act_mask = value;
1729 else if (attr == &dev_attr_pid)
1730 q->blk_trace->pid = value;
1731 else if (attr == &dev_attr_start_lba)
1732 q->blk_trace->start_lba = value;
1733 else if (attr == &dev_attr_end_lba)
1734 q->blk_trace->end_lba = value;
1738 mutex_unlock(&bdev->bd_mutex);
1742 return ret ? ret : count;
1745 int blk_trace_init_sysfs(struct device *dev)
1747 return sysfs_create_group(&dev->kobj, &blk_trace_attr_group);
1750 void blk_trace_remove_sysfs(struct device *dev)
1752 sysfs_remove_group(&dev->kobj, &blk_trace_attr_group);
1755 #endif /* CONFIG_BLK_DEV_IO_TRACE */
1757 #ifdef CONFIG_EVENT_TRACING
1759 void blk_dump_cmd(char *buf, struct request *rq)
1762 int len = rq->cmd_len;
1763 unsigned char *cmd = rq->cmd;
1765 if (rq->cmd_type != REQ_TYPE_BLOCK_PC) {
1770 for (end = len - 1; end >= 0; end--)
1775 for (i = 0; i < len; i++) {
1776 buf += sprintf(buf, "%s%02x", i == 0 ? "" : " ", cmd[i]);
1777 if (i == end && end != len - 1) {
1778 sprintf(buf, " ..");
1784 void blk_fill_rwbs(char *rwbs, u32 rw, int bytes)
1793 else if (rw & REQ_DISCARD)
1802 if (rw & REQ_RAHEAD)
1808 if (rw & REQ_SECURE)
1813 EXPORT_SYMBOL_GPL(blk_fill_rwbs);
1815 #endif /* CONFIG_EVENT_TRACING */