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;
66 t = relay_reserve(bt->rchan, sizeof(*t) + len);
68 const int cpu = smp_processor_id();
70 t->magic = BLK_IO_TRACE_MAGIC | BLK_IO_TRACE_VERSION;
71 t->time = ktime_to_ns(ktime_get());
77 memcpy((void *) t + sizeof(*t), data, len);
82 * Send out a notify for this process, if we haven't done so since a trace
85 static void trace_note_tsk(struct blk_trace *bt, struct task_struct *tsk)
87 tsk->btrace_seq = blktrace_seq;
88 trace_note(bt, tsk->pid, BLK_TN_PROCESS, tsk->comm, sizeof(tsk->comm));
91 static void trace_note_time(struct blk_trace *bt)
98 words[0] = now.tv_sec;
99 words[1] = now.tv_nsec;
101 local_irq_save(flags);
102 trace_note(bt, 0, BLK_TN_TIMESTAMP, words, sizeof(words));
103 local_irq_restore(flags);
106 void __trace_note_message(struct blk_trace *bt, const char *fmt, ...)
113 if (blk_tracer_enabled) {
115 ftrace_vprintk(fmt, args);
123 local_irq_save(flags);
124 buf = per_cpu_ptr(bt->msg_data, smp_processor_id());
126 n = vscnprintf(buf, BLK_TN_MAX_MSG, fmt, args);
129 trace_note(bt, 0, BLK_TN_MESSAGE, buf, n);
130 local_irq_restore(flags);
132 EXPORT_SYMBOL_GPL(__trace_note_message);
134 static int act_log_check(struct blk_trace *bt, u32 what, sector_t sector,
137 if (((bt->act_mask << BLK_TC_SHIFT) & what) == 0)
139 if (sector < bt->start_lba || sector > bt->end_lba)
141 if (bt->pid && pid != bt->pid)
148 * Data direction bit lookup
150 static const u32 ddir_act[2] = { BLK_TC_ACT(BLK_TC_READ),
151 BLK_TC_ACT(BLK_TC_WRITE) };
153 /* The ilog2() calls fall out because they're constant */
154 #define MASK_TC_BIT(rw, __name) ((rw & (1 << BIO_RW_ ## __name)) << \
155 (ilog2(BLK_TC_ ## __name) + BLK_TC_SHIFT - BIO_RW_ ## __name))
158 * The worker for the various blk_add_trace*() types. Fills out a
159 * blk_io_trace structure and places it in a per-cpu subbuffer.
161 static void __blk_add_trace(struct blk_trace *bt, sector_t sector, int bytes,
162 int rw, u32 what, int error, int pdu_len, void *pdu_data)
164 struct task_struct *tsk = current;
165 struct ring_buffer_event *event = NULL;
166 struct blk_io_trace *t;
167 unsigned long flags = 0;
168 unsigned long *sequence;
172 if (unlikely(bt->trace_state != Blktrace_running &&
173 !blk_tracer_enabled))
176 what |= ddir_act[rw & WRITE];
177 what |= MASK_TC_BIT(rw, BARRIER);
178 what |= MASK_TC_BIT(rw, SYNCIO);
179 what |= MASK_TC_BIT(rw, AHEAD);
180 what |= MASK_TC_BIT(rw, META);
181 what |= MASK_TC_BIT(rw, DISCARD);
184 if (unlikely(act_log_check(bt, what, sector, pid)))
186 cpu = raw_smp_processor_id();
188 if (blk_tracer_enabled) {
189 tracing_record_cmdline(current);
191 pc = preempt_count();
192 event = trace_buffer_lock_reserve(blk_tr, TRACE_BLK,
193 sizeof(*t) + pdu_len,
197 t = ring_buffer_event_data(event);
202 * A word about the locking here - we disable interrupts to reserve
203 * some space in the relay per-cpu buffer, to prevent an irq
204 * from coming in and stepping on our toes.
206 local_irq_save(flags);
208 if (unlikely(tsk->btrace_seq != blktrace_seq))
209 trace_note_tsk(bt, tsk);
211 t = relay_reserve(bt->rchan, sizeof(*t) + pdu_len);
213 sequence = per_cpu_ptr(bt->sequence, cpu);
215 t->magic = BLK_IO_TRACE_MAGIC | BLK_IO_TRACE_VERSION;
216 t->sequence = ++(*sequence);
217 t->time = ktime_to_ns(ktime_get());
220 * These two are not needed in ftrace as they are in the
221 * generic trace_entry, filled by tracing_generic_entry_update,
222 * but for the trace_event->bin() synthesizer benefit we do it
233 t->pdu_len = pdu_len;
236 memcpy((void *) t + sizeof(*t), pdu_data, pdu_len);
238 if (blk_tracer_enabled) {
239 trace_buffer_unlock_commit(blk_tr, event, 0, pc);
244 local_irq_restore(flags);
247 static struct dentry *blk_tree_root;
248 static DEFINE_MUTEX(blk_tree_mutex);
250 static void blk_trace_free(struct blk_trace *bt)
252 debugfs_remove(bt->msg_file);
253 debugfs_remove(bt->dropped_file);
254 relay_close(bt->rchan);
255 free_percpu(bt->sequence);
256 free_percpu(bt->msg_data);
260 static void blk_trace_cleanup(struct blk_trace *bt)
263 if (atomic_dec_and_test(&blk_probes_ref))
264 blk_unregister_tracepoints();
267 int blk_trace_remove(struct request_queue *q)
269 struct blk_trace *bt;
271 bt = xchg(&q->blk_trace, NULL);
275 if (bt->trace_state != Blktrace_running)
276 blk_trace_cleanup(bt);
280 EXPORT_SYMBOL_GPL(blk_trace_remove);
282 static int blk_dropped_open(struct inode *inode, struct file *filp)
284 filp->private_data = inode->i_private;
289 static ssize_t blk_dropped_read(struct file *filp, char __user *buffer,
290 size_t count, loff_t *ppos)
292 struct blk_trace *bt = filp->private_data;
295 snprintf(buf, sizeof(buf), "%u\n", atomic_read(&bt->dropped));
297 return simple_read_from_buffer(buffer, count, ppos, buf, strlen(buf));
300 static const struct file_operations blk_dropped_fops = {
301 .owner = THIS_MODULE,
302 .open = blk_dropped_open,
303 .read = blk_dropped_read,
306 static int blk_msg_open(struct inode *inode, struct file *filp)
308 filp->private_data = inode->i_private;
313 static ssize_t blk_msg_write(struct file *filp, const char __user *buffer,
314 size_t count, loff_t *ppos)
317 struct blk_trace *bt;
319 if (count > BLK_TN_MAX_MSG)
322 msg = kmalloc(count, GFP_KERNEL);
326 if (copy_from_user(msg, buffer, count)) {
331 bt = filp->private_data;
332 __trace_note_message(bt, "%s", msg);
338 static const struct file_operations blk_msg_fops = {
339 .owner = THIS_MODULE,
340 .open = blk_msg_open,
341 .write = blk_msg_write,
345 * Keep track of how many times we encountered a full subbuffer, to aid
346 * the user space app in telling how many lost events there were.
348 static int blk_subbuf_start_callback(struct rchan_buf *buf, void *subbuf,
349 void *prev_subbuf, size_t prev_padding)
351 struct blk_trace *bt;
353 if (!relay_buf_full(buf))
356 bt = buf->chan->private_data;
357 atomic_inc(&bt->dropped);
361 static int blk_remove_buf_file_callback(struct dentry *dentry)
363 struct dentry *parent = dentry->d_parent;
364 debugfs_remove(dentry);
367 * this will fail for all but the last file, but that is ok. what we
368 * care about is the top level buts->name directory going away, when
369 * the last trace file is gone. Then we don't have to rmdir() that
370 * manually on trace stop, so it nicely solves the issue with
371 * force killing of running traces.
374 debugfs_remove(parent);
378 static struct dentry *blk_create_buf_file_callback(const char *filename,
379 struct dentry *parent,
381 struct rchan_buf *buf,
384 return debugfs_create_file(filename, mode, parent, buf,
385 &relay_file_operations);
388 static struct rchan_callbacks blk_relay_callbacks = {
389 .subbuf_start = blk_subbuf_start_callback,
390 .create_buf_file = blk_create_buf_file_callback,
391 .remove_buf_file = blk_remove_buf_file_callback,
395 * Setup everything required to start tracing
397 int do_blk_trace_setup(struct request_queue *q, char *name, dev_t dev,
398 struct blk_user_trace_setup *buts)
400 struct blk_trace *old_bt, *bt = NULL;
401 struct dentry *dir = NULL;
404 if (!buts->buf_size || !buts->buf_nr)
407 strncpy(buts->name, name, BLKTRACE_BDEV_SIZE);
408 buts->name[BLKTRACE_BDEV_SIZE - 1] = '\0';
411 * some device names have larger paths - convert the slashes
412 * to underscores for this to work as expected
414 for (i = 0; i < strlen(buts->name); i++)
415 if (buts->name[i] == '/')
418 bt = kzalloc(sizeof(*bt), GFP_KERNEL);
423 bt->sequence = alloc_percpu(unsigned long);
427 bt->msg_data = __alloc_percpu(BLK_TN_MAX_MSG, __alignof__(char));
433 mutex_lock(&blk_tree_mutex);
434 if (!blk_tree_root) {
435 blk_tree_root = debugfs_create_dir("block", NULL);
436 if (!blk_tree_root) {
437 mutex_unlock(&blk_tree_mutex);
441 mutex_unlock(&blk_tree_mutex);
443 dir = debugfs_create_dir(buts->name, blk_tree_root);
450 atomic_set(&bt->dropped, 0);
453 bt->dropped_file = debugfs_create_file("dropped", 0444, dir, bt,
455 if (!bt->dropped_file)
458 bt->msg_file = debugfs_create_file("msg", 0222, dir, bt, &blk_msg_fops);
462 bt->rchan = relay_open("trace", dir, buts->buf_size,
463 buts->buf_nr, &blk_relay_callbacks, bt);
467 bt->act_mask = buts->act_mask;
469 bt->act_mask = (u16) -1;
471 bt->start_lba = buts->start_lba;
472 bt->end_lba = buts->end_lba;
477 bt->trace_state = Blktrace_setup;
480 old_bt = xchg(&q->blk_trace, bt);
482 (void) xchg(&q->blk_trace, old_bt);
486 if (atomic_inc_return(&blk_probes_ref) == 1)
487 blk_register_tracepoints();
495 int blk_trace_setup(struct request_queue *q, char *name, dev_t dev,
498 struct blk_user_trace_setup buts;
501 ret = copy_from_user(&buts, arg, sizeof(buts));
505 ret = do_blk_trace_setup(q, name, dev, &buts);
509 if (copy_to_user(arg, &buts, sizeof(buts)))
514 EXPORT_SYMBOL_GPL(blk_trace_setup);
516 int blk_trace_startstop(struct request_queue *q, int start)
519 struct blk_trace *bt = q->blk_trace;
525 * For starting a trace, we can transition from a setup or stopped
526 * trace. For stopping a trace, the state must be running
530 if (bt->trace_state == Blktrace_setup ||
531 bt->trace_state == Blktrace_stopped) {
534 bt->trace_state = Blktrace_running;
540 if (bt->trace_state == Blktrace_running) {
541 bt->trace_state = Blktrace_stopped;
542 relay_flush(bt->rchan);
549 EXPORT_SYMBOL_GPL(blk_trace_startstop);
552 * blk_trace_ioctl: - handle the ioctls associated with tracing
553 * @bdev: the block device
554 * @cmd: the ioctl cmd
555 * @arg: the argument data, if any
558 int blk_trace_ioctl(struct block_device *bdev, unsigned cmd, char __user *arg)
560 struct request_queue *q;
562 char b[BDEVNAME_SIZE];
564 q = bdev_get_queue(bdev);
568 mutex_lock(&bdev->bd_mutex);
573 ret = blk_trace_setup(q, b, bdev->bd_dev, arg);
578 ret = blk_trace_startstop(q, start);
580 case BLKTRACETEARDOWN:
581 ret = blk_trace_remove(q);
588 mutex_unlock(&bdev->bd_mutex);
593 * blk_trace_shutdown: - stop and cleanup trace structures
594 * @q: the request queue associated with the device
597 void blk_trace_shutdown(struct request_queue *q)
600 blk_trace_startstop(q, 0);
610 * blk_add_trace_rq - Add a trace for a request oriented action
611 * @q: queue the io is for
612 * @rq: the source request
616 * Records an action against a request. Will log the bio offset + size.
619 static void blk_add_trace_rq(struct request_queue *q, struct request *rq,
622 struct blk_trace *bt = q->blk_trace;
623 int rw = rq->cmd_flags & 0x03;
628 if (blk_discard_rq(rq))
629 rw |= (1 << BIO_RW_DISCARD);
631 if (blk_pc_request(rq)) {
632 what |= BLK_TC_ACT(BLK_TC_PC);
633 __blk_add_trace(bt, 0, rq->data_len, rw, what, rq->errors,
634 sizeof(rq->cmd), rq->cmd);
636 what |= BLK_TC_ACT(BLK_TC_FS);
637 __blk_add_trace(bt, rq->hard_sector, rq->hard_nr_sectors << 9,
638 rw, what, rq->errors, 0, NULL);
642 static void blk_add_trace_rq_abort(struct request_queue *q, struct request *rq)
644 blk_add_trace_rq(q, rq, BLK_TA_ABORT);
647 static void blk_add_trace_rq_insert(struct request_queue *q, struct request *rq)
649 blk_add_trace_rq(q, rq, BLK_TA_INSERT);
652 static void blk_add_trace_rq_issue(struct request_queue *q, struct request *rq)
654 blk_add_trace_rq(q, rq, BLK_TA_ISSUE);
657 static void blk_add_trace_rq_requeue(struct request_queue *q,
660 blk_add_trace_rq(q, rq, BLK_TA_REQUEUE);
663 static void blk_add_trace_rq_complete(struct request_queue *q,
666 blk_add_trace_rq(q, rq, BLK_TA_COMPLETE);
670 * blk_add_trace_bio - Add a trace for a bio oriented action
671 * @q: queue the io is for
672 * @bio: the source bio
676 * Records an action against a bio. Will log the bio offset + size.
679 static void blk_add_trace_bio(struct request_queue *q, struct bio *bio,
682 struct blk_trace *bt = q->blk_trace;
687 __blk_add_trace(bt, bio->bi_sector, bio->bi_size, bio->bi_rw, what,
688 !bio_flagged(bio, BIO_UPTODATE), 0, NULL);
691 static void blk_add_trace_bio_bounce(struct request_queue *q, struct bio *bio)
693 blk_add_trace_bio(q, bio, BLK_TA_BOUNCE);
696 static void blk_add_trace_bio_complete(struct request_queue *q, struct bio *bio)
698 blk_add_trace_bio(q, bio, BLK_TA_COMPLETE);
701 static void blk_add_trace_bio_backmerge(struct request_queue *q,
704 blk_add_trace_bio(q, bio, BLK_TA_BACKMERGE);
707 static void blk_add_trace_bio_frontmerge(struct request_queue *q,
710 blk_add_trace_bio(q, bio, BLK_TA_FRONTMERGE);
713 static void blk_add_trace_bio_queue(struct request_queue *q, struct bio *bio)
715 blk_add_trace_bio(q, bio, BLK_TA_QUEUE);
718 static void blk_add_trace_getrq(struct request_queue *q,
719 struct bio *bio, int rw)
722 blk_add_trace_bio(q, bio, BLK_TA_GETRQ);
724 struct blk_trace *bt = q->blk_trace;
727 __blk_add_trace(bt, 0, 0, rw, BLK_TA_GETRQ, 0, 0, NULL);
732 static void blk_add_trace_sleeprq(struct request_queue *q,
733 struct bio *bio, int rw)
736 blk_add_trace_bio(q, bio, BLK_TA_SLEEPRQ);
738 struct blk_trace *bt = q->blk_trace;
741 __blk_add_trace(bt, 0, 0, rw, BLK_TA_SLEEPRQ,
746 static void blk_add_trace_plug(struct request_queue *q)
748 struct blk_trace *bt = q->blk_trace;
751 __blk_add_trace(bt, 0, 0, 0, BLK_TA_PLUG, 0, 0, NULL);
754 static void blk_add_trace_unplug_io(struct request_queue *q)
756 struct blk_trace *bt = q->blk_trace;
759 unsigned int pdu = q->rq.count[READ] + q->rq.count[WRITE];
760 __be64 rpdu = cpu_to_be64(pdu);
762 __blk_add_trace(bt, 0, 0, 0, BLK_TA_UNPLUG_IO, 0,
763 sizeof(rpdu), &rpdu);
767 static void blk_add_trace_unplug_timer(struct request_queue *q)
769 struct blk_trace *bt = q->blk_trace;
772 unsigned int pdu = q->rq.count[READ] + q->rq.count[WRITE];
773 __be64 rpdu = cpu_to_be64(pdu);
775 __blk_add_trace(bt, 0, 0, 0, BLK_TA_UNPLUG_TIMER, 0,
776 sizeof(rpdu), &rpdu);
780 static void blk_add_trace_split(struct request_queue *q, struct bio *bio,
783 struct blk_trace *bt = q->blk_trace;
786 __be64 rpdu = cpu_to_be64(pdu);
788 __blk_add_trace(bt, bio->bi_sector, bio->bi_size, bio->bi_rw,
789 BLK_TA_SPLIT, !bio_flagged(bio, BIO_UPTODATE),
790 sizeof(rpdu), &rpdu);
795 * blk_add_trace_remap - Add a trace for a remap operation
796 * @q: queue the io is for
797 * @bio: the source bio
798 * @dev: target device
799 * @from: source sector
803 * Device mapper or raid target sometimes need to split a bio because
804 * it spans a stripe (or similar). Add a trace for that action.
807 static void blk_add_trace_remap(struct request_queue *q, struct bio *bio,
808 dev_t dev, sector_t from, sector_t to)
810 struct blk_trace *bt = q->blk_trace;
811 struct blk_io_trace_remap r;
816 r.device = cpu_to_be32(dev);
817 r.device_from = cpu_to_be32(bio->bi_bdev->bd_dev);
818 r.sector = cpu_to_be64(to);
820 __blk_add_trace(bt, from, bio->bi_size, bio->bi_rw, BLK_TA_REMAP,
821 !bio_flagged(bio, BIO_UPTODATE), sizeof(r), &r);
825 * blk_add_driver_data - Add binary message with driver-specific data
826 * @q: queue the io is for
828 * @data: driver-specific data
829 * @len: length of driver-specific data
832 * Some drivers might want to write driver-specific data per request.
835 void blk_add_driver_data(struct request_queue *q,
837 void *data, size_t len)
839 struct blk_trace *bt = q->blk_trace;
844 if (blk_pc_request(rq))
845 __blk_add_trace(bt, 0, rq->data_len, 0, BLK_TA_DRV_DATA,
846 rq->errors, len, data);
848 __blk_add_trace(bt, rq->hard_sector, rq->hard_nr_sectors << 9,
849 0, BLK_TA_DRV_DATA, rq->errors, len, data);
851 EXPORT_SYMBOL_GPL(blk_add_driver_data);
853 static void blk_register_tracepoints(void)
857 ret = register_trace_block_rq_abort(blk_add_trace_rq_abort);
859 ret = register_trace_block_rq_insert(blk_add_trace_rq_insert);
861 ret = register_trace_block_rq_issue(blk_add_trace_rq_issue);
863 ret = register_trace_block_rq_requeue(blk_add_trace_rq_requeue);
865 ret = register_trace_block_rq_complete(blk_add_trace_rq_complete);
867 ret = register_trace_block_bio_bounce(blk_add_trace_bio_bounce);
869 ret = register_trace_block_bio_complete(blk_add_trace_bio_complete);
871 ret = register_trace_block_bio_backmerge(blk_add_trace_bio_backmerge);
873 ret = register_trace_block_bio_frontmerge(blk_add_trace_bio_frontmerge);
875 ret = register_trace_block_bio_queue(blk_add_trace_bio_queue);
877 ret = register_trace_block_getrq(blk_add_trace_getrq);
879 ret = register_trace_block_sleeprq(blk_add_trace_sleeprq);
881 ret = register_trace_block_plug(blk_add_trace_plug);
883 ret = register_trace_block_unplug_timer(blk_add_trace_unplug_timer);
885 ret = register_trace_block_unplug_io(blk_add_trace_unplug_io);
887 ret = register_trace_block_split(blk_add_trace_split);
889 ret = register_trace_block_remap(blk_add_trace_remap);
893 static void blk_unregister_tracepoints(void)
895 unregister_trace_block_remap(blk_add_trace_remap);
896 unregister_trace_block_split(blk_add_trace_split);
897 unregister_trace_block_unplug_io(blk_add_trace_unplug_io);
898 unregister_trace_block_unplug_timer(blk_add_trace_unplug_timer);
899 unregister_trace_block_plug(blk_add_trace_plug);
900 unregister_trace_block_sleeprq(blk_add_trace_sleeprq);
901 unregister_trace_block_getrq(blk_add_trace_getrq);
902 unregister_trace_block_bio_queue(blk_add_trace_bio_queue);
903 unregister_trace_block_bio_frontmerge(blk_add_trace_bio_frontmerge);
904 unregister_trace_block_bio_backmerge(blk_add_trace_bio_backmerge);
905 unregister_trace_block_bio_complete(blk_add_trace_bio_complete);
906 unregister_trace_block_bio_bounce(blk_add_trace_bio_bounce);
907 unregister_trace_block_rq_complete(blk_add_trace_rq_complete);
908 unregister_trace_block_rq_requeue(blk_add_trace_rq_requeue);
909 unregister_trace_block_rq_issue(blk_add_trace_rq_issue);
910 unregister_trace_block_rq_insert(blk_add_trace_rq_insert);
911 unregister_trace_block_rq_abort(blk_add_trace_rq_abort);
913 tracepoint_synchronize_unregister();
917 * struct blk_io_tracer formatting routines
920 static void fill_rwbs(char *rwbs, const struct blk_io_trace *t)
923 int tc = t->action >> BLK_TC_SHIFT;
925 if (tc & BLK_TC_DISCARD)
927 else if (tc & BLK_TC_WRITE)
934 if (tc & BLK_TC_AHEAD)
936 if (tc & BLK_TC_BARRIER)
938 if (tc & BLK_TC_SYNC)
940 if (tc & BLK_TC_META)
947 const struct blk_io_trace *te_blk_io_trace(const struct trace_entry *ent)
949 return (const struct blk_io_trace *)ent;
952 static inline const void *pdu_start(const struct trace_entry *ent)
954 return te_blk_io_trace(ent) + 1;
957 static inline u32 t_sec(const struct trace_entry *ent)
959 return te_blk_io_trace(ent)->bytes >> 9;
962 static inline unsigned long long t_sector(const struct trace_entry *ent)
964 return te_blk_io_trace(ent)->sector;
967 static inline __u16 t_error(const struct trace_entry *ent)
969 return te_blk_io_trace(ent)->error;
972 static __u64 get_pdu_int(const struct trace_entry *ent)
974 const __u64 *val = pdu_start(ent);
975 return be64_to_cpu(*val);
978 static void get_pdu_remap(const struct trace_entry *ent,
979 struct blk_io_trace_remap *r)
981 const struct blk_io_trace_remap *__r = pdu_start(ent);
982 __u64 sector = __r->sector;
984 r->device = be32_to_cpu(__r->device);
985 r->device_from = be32_to_cpu(__r->device_from);
986 r->sector = be64_to_cpu(sector);
989 static int blk_log_action_iter(struct trace_iterator *iter, const char *act)
992 unsigned long long ts = iter->ts;
993 unsigned long nsec_rem = do_div(ts, NSEC_PER_SEC);
994 unsigned secs = (unsigned long)ts;
995 const struct trace_entry *ent = iter->ent;
996 const struct blk_io_trace *t = (const struct blk_io_trace *)ent;
1000 return trace_seq_printf(&iter->seq,
1001 "%3d,%-3d %2d %5d.%09lu %5u %2s %3s ",
1002 MAJOR(t->device), MINOR(t->device), iter->cpu,
1003 secs, nsec_rem, ent->pid, act, rwbs);
1006 static int blk_log_action_seq(struct trace_seq *s, const struct blk_io_trace *t,
1011 return trace_seq_printf(s, "%3d,%-3d %2s %3s ",
1012 MAJOR(t->device), MINOR(t->device), act, rwbs);
1015 static int blk_log_generic(struct trace_seq *s, const struct trace_entry *ent)
1017 char cmd[TASK_COMM_LEN];
1019 trace_find_cmdline(ent->pid, cmd);
1022 return trace_seq_printf(s, "%llu + %u [%s]\n",
1023 t_sector(ent), t_sec(ent), cmd);
1024 return trace_seq_printf(s, "[%s]\n", cmd);
1027 static int blk_log_with_error(struct trace_seq *s,
1028 const struct trace_entry *ent)
1031 return trace_seq_printf(s, "%llu + %u [%d]\n", t_sector(ent),
1032 t_sec(ent), t_error(ent));
1033 return trace_seq_printf(s, "%llu [%d]\n", t_sector(ent), t_error(ent));
1036 static int blk_log_remap(struct trace_seq *s, const struct trace_entry *ent)
1038 struct blk_io_trace_remap r = { .device = 0, };
1040 get_pdu_remap(ent, &r);
1041 return trace_seq_printf(s, "%llu + %u <- (%d,%d) %llu\n",
1043 t_sec(ent), MAJOR(r.device), MINOR(r.device),
1044 (unsigned long long)r.sector);
1047 static int blk_log_plug(struct trace_seq *s, const struct trace_entry *ent)
1049 char cmd[TASK_COMM_LEN];
1051 trace_find_cmdline(ent->pid, cmd);
1053 return trace_seq_printf(s, "[%s]\n", cmd);
1056 static int blk_log_unplug(struct trace_seq *s, const struct trace_entry *ent)
1058 char cmd[TASK_COMM_LEN];
1060 trace_find_cmdline(ent->pid, cmd);
1062 return trace_seq_printf(s, "[%s] %llu\n", cmd, get_pdu_int(ent));
1065 static int blk_log_split(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, "%llu / %llu [%s]\n", t_sector(ent),
1072 get_pdu_int(ent), cmd);
1076 * struct tracer operations
1079 static void blk_tracer_print_header(struct seq_file *m)
1081 if (!(blk_tracer_flags.val & TRACE_BLK_OPT_CLASSIC))
1083 seq_puts(m, "# DEV CPU TIMESTAMP PID ACT FLG\n"
1087 static void blk_tracer_start(struct trace_array *tr)
1089 blk_tracer_enabled = true;
1090 trace_flags &= ~TRACE_ITER_CONTEXT_INFO;
1093 static int blk_tracer_init(struct trace_array *tr)
1096 blk_tracer_start(tr);
1100 static void blk_tracer_stop(struct trace_array *tr)
1102 blk_tracer_enabled = false;
1103 trace_flags |= TRACE_ITER_CONTEXT_INFO;
1106 static void blk_tracer_reset(struct trace_array *tr)
1108 blk_tracer_stop(tr);
1111 static const struct {
1113 int (*print)(struct trace_seq *s, const struct trace_entry *ent);
1115 [__BLK_TA_QUEUE] = {{ "Q", "queue" }, blk_log_generic },
1116 [__BLK_TA_BACKMERGE] = {{ "M", "backmerge" }, blk_log_generic },
1117 [__BLK_TA_FRONTMERGE] = {{ "F", "frontmerge" }, blk_log_generic },
1118 [__BLK_TA_GETRQ] = {{ "G", "getrq" }, blk_log_generic },
1119 [__BLK_TA_SLEEPRQ] = {{ "S", "sleeprq" }, blk_log_generic },
1120 [__BLK_TA_REQUEUE] = {{ "R", "requeue" }, blk_log_with_error },
1121 [__BLK_TA_ISSUE] = {{ "D", "issue" }, blk_log_generic },
1122 [__BLK_TA_COMPLETE] = {{ "C", "complete" }, blk_log_with_error },
1123 [__BLK_TA_PLUG] = {{ "P", "plug" }, blk_log_plug },
1124 [__BLK_TA_UNPLUG_IO] = {{ "U", "unplug_io" }, blk_log_unplug },
1125 [__BLK_TA_UNPLUG_TIMER] = {{ "UT", "unplug_timer" }, blk_log_unplug },
1126 [__BLK_TA_INSERT] = {{ "I", "insert" }, blk_log_generic },
1127 [__BLK_TA_SPLIT] = {{ "X", "split" }, blk_log_split },
1128 [__BLK_TA_BOUNCE] = {{ "B", "bounce" }, blk_log_generic },
1129 [__BLK_TA_REMAP] = {{ "A", "remap" }, blk_log_remap },
1132 static enum print_line_t blk_trace_event_print(struct trace_iterator *iter,
1135 struct trace_seq *s = &iter->seq;
1136 const struct blk_io_trace *t = (struct blk_io_trace *)iter->ent;
1137 const u16 what = t->action & ((1 << BLK_TC_SHIFT) - 1);
1140 if (!trace_print_context(iter))
1141 return TRACE_TYPE_PARTIAL_LINE;
1143 if (unlikely(what == 0 || what >= ARRAY_SIZE(what2act)))
1144 ret = trace_seq_printf(s, "Bad pc action %x\n", what);
1146 const bool long_act = !!(trace_flags & TRACE_ITER_VERBOSE);
1147 ret = blk_log_action_seq(s, t, what2act[what].act[long_act]);
1149 ret = what2act[what].print(s, iter->ent);
1152 return ret ? TRACE_TYPE_HANDLED : TRACE_TYPE_PARTIAL_LINE;
1155 static int blk_trace_synthesize_old_trace(struct trace_iterator *iter)
1157 struct trace_seq *s = &iter->seq;
1158 struct blk_io_trace *t = (struct blk_io_trace *)iter->ent;
1159 const int offset = offsetof(struct blk_io_trace, sector);
1160 struct blk_io_trace old = {
1161 .magic = BLK_IO_TRACE_MAGIC | BLK_IO_TRACE_VERSION,
1165 if (!trace_seq_putmem(s, &old, offset))
1167 return trace_seq_putmem(s, &t->sector,
1168 sizeof(old) - offset + t->pdu_len);
1171 static enum print_line_t
1172 blk_trace_event_print_binary(struct trace_iterator *iter, int flags)
1174 return blk_trace_synthesize_old_trace(iter) ?
1175 TRACE_TYPE_HANDLED : TRACE_TYPE_PARTIAL_LINE;
1178 static enum print_line_t blk_tracer_print_line(struct trace_iterator *iter)
1180 const struct blk_io_trace *t;
1184 if (!(blk_tracer_flags.val & TRACE_BLK_OPT_CLASSIC))
1185 return TRACE_TYPE_UNHANDLED;
1187 t = (const struct blk_io_trace *)iter->ent;
1188 what = t->action & ((1 << BLK_TC_SHIFT) - 1);
1190 if (unlikely(what == 0 || what >= ARRAY_SIZE(what2act)))
1191 ret = trace_seq_printf(&iter->seq, "Bad pc action %x\n", what);
1193 const bool long_act = !!(trace_flags & TRACE_ITER_VERBOSE);
1194 ret = blk_log_action_iter(iter, what2act[what].act[long_act]);
1196 ret = what2act[what].print(&iter->seq, iter->ent);
1199 return ret ? TRACE_TYPE_HANDLED : TRACE_TYPE_PARTIAL_LINE;
1202 static struct tracer blk_tracer __read_mostly = {
1204 .init = blk_tracer_init,
1205 .reset = blk_tracer_reset,
1206 .start = blk_tracer_start,
1207 .stop = blk_tracer_stop,
1208 .print_header = blk_tracer_print_header,
1209 .print_line = blk_tracer_print_line,
1210 .flags = &blk_tracer_flags,
1213 static struct trace_event trace_blk_event = {
1215 .trace = blk_trace_event_print,
1216 .binary = blk_trace_event_print_binary,
1219 static int __init init_blk_tracer(void)
1221 if (!register_ftrace_event(&trace_blk_event)) {
1222 pr_warning("Warning: could not register block events\n");
1226 if (register_tracer(&blk_tracer) != 0) {
1227 pr_warning("Warning: could not register the block tracer\n");
1228 unregister_ftrace_event(&trace_blk_event);
1235 device_initcall(init_blk_tracer);
1237 static int blk_trace_remove_queue(struct request_queue *q)
1239 struct blk_trace *bt;
1241 bt = xchg(&q->blk_trace, NULL);
1245 if (atomic_dec_and_test(&blk_probes_ref))
1246 blk_unregister_tracepoints();
1253 * Setup everything required to start tracing
1255 static int blk_trace_setup_queue(struct request_queue *q, dev_t dev)
1257 struct blk_trace *old_bt, *bt = NULL;
1259 bt = kzalloc(sizeof(*bt), GFP_KERNEL);
1264 bt->act_mask = (u16)-1;
1265 bt->end_lba = -1ULL;
1267 old_bt = xchg(&q->blk_trace, bt);
1268 if (old_bt != NULL) {
1269 (void)xchg(&q->blk_trace, old_bt);
1274 if (atomic_inc_return(&blk_probes_ref) == 1)
1275 blk_register_tracepoints();
1281 * sysfs interface to enable and configure tracing
1284 static ssize_t sysfs_blk_trace_attr_show(struct device *dev,
1285 struct device_attribute *attr,
1287 static ssize_t sysfs_blk_trace_attr_store(struct device *dev,
1288 struct device_attribute *attr,
1289 const char *buf, size_t count);
1290 #define BLK_TRACE_DEVICE_ATTR(_name) \
1291 DEVICE_ATTR(_name, S_IRUGO | S_IWUSR, \
1292 sysfs_blk_trace_attr_show, \
1293 sysfs_blk_trace_attr_store)
1295 static BLK_TRACE_DEVICE_ATTR(enable);
1296 static BLK_TRACE_DEVICE_ATTR(act_mask);
1297 static BLK_TRACE_DEVICE_ATTR(pid);
1298 static BLK_TRACE_DEVICE_ATTR(start_lba);
1299 static BLK_TRACE_DEVICE_ATTR(end_lba);
1301 static struct attribute *blk_trace_attrs[] = {
1302 &dev_attr_enable.attr,
1303 &dev_attr_act_mask.attr,
1305 &dev_attr_start_lba.attr,
1306 &dev_attr_end_lba.attr,
1310 struct attribute_group blk_trace_attr_group = {
1312 .attrs = blk_trace_attrs,
1315 static const struct {
1319 { BLK_TC_READ, "read" },
1320 { BLK_TC_WRITE, "write" },
1321 { BLK_TC_BARRIER, "barrier" },
1322 { BLK_TC_SYNC, "sync" },
1323 { BLK_TC_QUEUE, "queue" },
1324 { BLK_TC_REQUEUE, "requeue" },
1325 { BLK_TC_ISSUE, "issue" },
1326 { BLK_TC_COMPLETE, "complete" },
1327 { BLK_TC_FS, "fs" },
1328 { BLK_TC_PC, "pc" },
1329 { BLK_TC_AHEAD, "ahead" },
1330 { BLK_TC_META, "meta" },
1331 { BLK_TC_DISCARD, "discard" },
1332 { BLK_TC_DRV_DATA, "drv_data" },
1335 static int blk_trace_str2mask(const char *str)
1341 s = kstrdup(str, GFP_KERNEL);
1347 token = strsep(&s, ",");
1354 for (i = 0; i < ARRAY_SIZE(mask_maps); i++) {
1355 if (strcasecmp(token, mask_maps[i].str) == 0) {
1356 mask |= mask_maps[i].mask;
1360 if (i == ARRAY_SIZE(mask_maps)) {
1370 static ssize_t blk_trace_mask2str(char *buf, int mask)
1375 for (i = 0; i < ARRAY_SIZE(mask_maps); i++) {
1376 if (mask & mask_maps[i].mask) {
1377 p += sprintf(p, "%s%s",
1378 (p == buf) ? "" : ",", mask_maps[i].str);
1386 static struct request_queue *blk_trace_get_queue(struct block_device *bdev)
1388 if (bdev->bd_disk == NULL)
1391 return bdev_get_queue(bdev);
1394 static ssize_t sysfs_blk_trace_attr_show(struct device *dev,
1395 struct device_attribute *attr,
1398 struct hd_struct *p = dev_to_part(dev);
1399 struct request_queue *q;
1400 struct block_device *bdev;
1401 ssize_t ret = -ENXIO;
1404 bdev = bdget(part_devt(p));
1406 goto out_unlock_kernel;
1408 q = blk_trace_get_queue(bdev);
1412 mutex_lock(&bdev->bd_mutex);
1414 if (attr == &dev_attr_enable) {
1415 ret = sprintf(buf, "%u\n", !!q->blk_trace);
1416 goto out_unlock_bdev;
1419 if (q->blk_trace == NULL)
1420 ret = sprintf(buf, "disabled\n");
1421 else if (attr == &dev_attr_act_mask)
1422 ret = blk_trace_mask2str(buf, q->blk_trace->act_mask);
1423 else if (attr == &dev_attr_pid)
1424 ret = sprintf(buf, "%u\n", q->blk_trace->pid);
1425 else if (attr == &dev_attr_start_lba)
1426 ret = sprintf(buf, "%llu\n", q->blk_trace->start_lba);
1427 else if (attr == &dev_attr_end_lba)
1428 ret = sprintf(buf, "%llu\n", q->blk_trace->end_lba);
1431 mutex_unlock(&bdev->bd_mutex);
1439 static ssize_t sysfs_blk_trace_attr_store(struct device *dev,
1440 struct device_attribute *attr,
1441 const char *buf, size_t count)
1443 struct block_device *bdev;
1444 struct request_queue *q;
1445 struct hd_struct *p;
1447 ssize_t ret = -EINVAL;
1452 if (attr == &dev_attr_act_mask) {
1453 if (sscanf(buf, "%llx", &value) != 1) {
1454 /* Assume it is a list of trace category names */
1455 ret = blk_trace_str2mask(buf);
1460 } else if (sscanf(buf, "%llu", &value) != 1)
1466 p = dev_to_part(dev);
1467 bdev = bdget(part_devt(p));
1469 goto out_unlock_kernel;
1471 q = blk_trace_get_queue(bdev);
1475 mutex_lock(&bdev->bd_mutex);
1477 if (attr == &dev_attr_enable) {
1479 ret = blk_trace_setup_queue(q, bdev->bd_dev);
1481 ret = blk_trace_remove_queue(q);
1482 goto out_unlock_bdev;
1486 if (q->blk_trace == NULL)
1487 ret = blk_trace_setup_queue(q, bdev->bd_dev);
1490 if (attr == &dev_attr_act_mask)
1491 q->blk_trace->act_mask = value;
1492 else if (attr == &dev_attr_pid)
1493 q->blk_trace->pid = value;
1494 else if (attr == &dev_attr_start_lba)
1495 q->blk_trace->start_lba = value;
1496 else if (attr == &dev_attr_end_lba)
1497 q->blk_trace->end_lba = value;
1501 mutex_unlock(&bdev->bd_mutex);
1507 return ret ? ret : count;