block: merge struct block_device and struct hd_struct
[linux-2.6-microblaze.git] / kernel / trace / blktrace.c
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * Copyright (C) 2006 Jens Axboe <axboe@kernel.dk>
4  *
5  */
6
7 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
8
9 #include <linux/kernel.h>
10 #include <linux/blkdev.h>
11 #include <linux/blktrace_api.h>
12 #include <linux/percpu.h>
13 #include <linux/init.h>
14 #include <linux/mutex.h>
15 #include <linux/slab.h>
16 #include <linux/debugfs.h>
17 #include <linux/export.h>
18 #include <linux/time.h>
19 #include <linux/uaccess.h>
20 #include <linux/list.h>
21 #include <linux/blk-cgroup.h>
22
23 #include "../../block/blk.h"
24
25 #include <trace/events/block.h>
26
27 #include "trace_output.h"
28
29 #ifdef CONFIG_BLK_DEV_IO_TRACE
30
31 static unsigned int blktrace_seq __read_mostly = 1;
32
33 static struct trace_array *blk_tr;
34 static bool blk_tracer_enabled __read_mostly;
35
36 static LIST_HEAD(running_trace_list);
37 static __cacheline_aligned_in_smp DEFINE_SPINLOCK(running_trace_lock);
38
39 /* Select an alternative, minimalistic output than the original one */
40 #define TRACE_BLK_OPT_CLASSIC   0x1
41 #define TRACE_BLK_OPT_CGROUP    0x2
42 #define TRACE_BLK_OPT_CGNAME    0x4
43
44 static struct tracer_opt blk_tracer_opts[] = {
45         /* Default disable the minimalistic output */
46         { TRACER_OPT(blk_classic, TRACE_BLK_OPT_CLASSIC) },
47 #ifdef CONFIG_BLK_CGROUP
48         { TRACER_OPT(blk_cgroup, TRACE_BLK_OPT_CGROUP) },
49         { TRACER_OPT(blk_cgname, TRACE_BLK_OPT_CGNAME) },
50 #endif
51         { }
52 };
53
54 static struct tracer_flags blk_tracer_flags = {
55         .val  = 0,
56         .opts = blk_tracer_opts,
57 };
58
59 /* Global reference count of probes */
60 static DEFINE_MUTEX(blk_probe_mutex);
61 static int blk_probes_ref;
62
63 static void blk_register_tracepoints(void);
64 static void blk_unregister_tracepoints(void);
65
66 /*
67  * Send out a notify message.
68  */
69 static void trace_note(struct blk_trace *bt, pid_t pid, int action,
70                        const void *data, size_t len, u64 cgid)
71 {
72         struct blk_io_trace *t;
73         struct ring_buffer_event *event = NULL;
74         struct trace_buffer *buffer = NULL;
75         int pc = 0;
76         int cpu = smp_processor_id();
77         bool blk_tracer = blk_tracer_enabled;
78         ssize_t cgid_len = cgid ? sizeof(cgid) : 0;
79
80         if (blk_tracer) {
81                 buffer = blk_tr->array_buffer.buffer;
82                 pc = preempt_count();
83                 event = trace_buffer_lock_reserve(buffer, TRACE_BLK,
84                                                   sizeof(*t) + len + cgid_len,
85                                                   0, pc);
86                 if (!event)
87                         return;
88                 t = ring_buffer_event_data(event);
89                 goto record_it;
90         }
91
92         if (!bt->rchan)
93                 return;
94
95         t = relay_reserve(bt->rchan, sizeof(*t) + len + cgid_len);
96         if (t) {
97                 t->magic = BLK_IO_TRACE_MAGIC | BLK_IO_TRACE_VERSION;
98                 t->time = ktime_to_ns(ktime_get());
99 record_it:
100                 t->device = bt->dev;
101                 t->action = action | (cgid ? __BLK_TN_CGROUP : 0);
102                 t->pid = pid;
103                 t->cpu = cpu;
104                 t->pdu_len = len + cgid_len;
105                 if (cgid_len)
106                         memcpy((void *)t + sizeof(*t), &cgid, cgid_len);
107                 memcpy((void *) t + sizeof(*t) + cgid_len, data, len);
108
109                 if (blk_tracer)
110                         trace_buffer_unlock_commit(blk_tr, buffer, event, 0, pc);
111         }
112 }
113
114 /*
115  * Send out a notify for this process, if we haven't done so since a trace
116  * started
117  */
118 static void trace_note_tsk(struct task_struct *tsk)
119 {
120         unsigned long flags;
121         struct blk_trace *bt;
122
123         tsk->btrace_seq = blktrace_seq;
124         spin_lock_irqsave(&running_trace_lock, flags);
125         list_for_each_entry(bt, &running_trace_list, running_list) {
126                 trace_note(bt, tsk->pid, BLK_TN_PROCESS, tsk->comm,
127                            sizeof(tsk->comm), 0);
128         }
129         spin_unlock_irqrestore(&running_trace_lock, flags);
130 }
131
132 static void trace_note_time(struct blk_trace *bt)
133 {
134         struct timespec64 now;
135         unsigned long flags;
136         u32 words[2];
137
138         /* need to check user space to see if this breaks in y2038 or y2106 */
139         ktime_get_real_ts64(&now);
140         words[0] = (u32)now.tv_sec;
141         words[1] = now.tv_nsec;
142
143         local_irq_save(flags);
144         trace_note(bt, 0, BLK_TN_TIMESTAMP, words, sizeof(words), 0);
145         local_irq_restore(flags);
146 }
147
148 void __trace_note_message(struct blk_trace *bt, struct blkcg *blkcg,
149         const char *fmt, ...)
150 {
151         int n;
152         va_list args;
153         unsigned long flags;
154         char *buf;
155
156         if (unlikely(bt->trace_state != Blktrace_running &&
157                      !blk_tracer_enabled))
158                 return;
159
160         /*
161          * If the BLK_TC_NOTIFY action mask isn't set, don't send any note
162          * message to the trace.
163          */
164         if (!(bt->act_mask & BLK_TC_NOTIFY))
165                 return;
166
167         local_irq_save(flags);
168         buf = this_cpu_ptr(bt->msg_data);
169         va_start(args, fmt);
170         n = vscnprintf(buf, BLK_TN_MAX_MSG, fmt, args);
171         va_end(args);
172
173         if (!(blk_tracer_flags.val & TRACE_BLK_OPT_CGROUP))
174                 blkcg = NULL;
175 #ifdef CONFIG_BLK_CGROUP
176         trace_note(bt, current->pid, BLK_TN_MESSAGE, buf, n,
177                    blkcg ? cgroup_id(blkcg->css.cgroup) : 1);
178 #else
179         trace_note(bt, current->pid, BLK_TN_MESSAGE, buf, n, 0);
180 #endif
181         local_irq_restore(flags);
182 }
183 EXPORT_SYMBOL_GPL(__trace_note_message);
184
185 static int act_log_check(struct blk_trace *bt, u32 what, sector_t sector,
186                          pid_t pid)
187 {
188         if (((bt->act_mask << BLK_TC_SHIFT) & what) == 0)
189                 return 1;
190         if (sector && (sector < bt->start_lba || sector > bt->end_lba))
191                 return 1;
192         if (bt->pid && pid != bt->pid)
193                 return 1;
194
195         return 0;
196 }
197
198 /*
199  * Data direction bit lookup
200  */
201 static const u32 ddir_act[2] = { BLK_TC_ACT(BLK_TC_READ),
202                                  BLK_TC_ACT(BLK_TC_WRITE) };
203
204 #define BLK_TC_RAHEAD           BLK_TC_AHEAD
205 #define BLK_TC_PREFLUSH         BLK_TC_FLUSH
206
207 /* The ilog2() calls fall out because they're constant */
208 #define MASK_TC_BIT(rw, __name) ((rw & REQ_ ## __name) << \
209           (ilog2(BLK_TC_ ## __name) + BLK_TC_SHIFT - __REQ_ ## __name))
210
211 /*
212  * The worker for the various blk_add_trace*() types. Fills out a
213  * blk_io_trace structure and places it in a per-cpu subbuffer.
214  */
215 static void __blk_add_trace(struct blk_trace *bt, sector_t sector, int bytes,
216                      int op, int op_flags, u32 what, int error, int pdu_len,
217                      void *pdu_data, u64 cgid)
218 {
219         struct task_struct *tsk = current;
220         struct ring_buffer_event *event = NULL;
221         struct trace_buffer *buffer = NULL;
222         struct blk_io_trace *t;
223         unsigned long flags = 0;
224         unsigned long *sequence;
225         pid_t pid;
226         int cpu, pc = 0;
227         bool blk_tracer = blk_tracer_enabled;
228         ssize_t cgid_len = cgid ? sizeof(cgid) : 0;
229
230         if (unlikely(bt->trace_state != Blktrace_running && !blk_tracer))
231                 return;
232
233         what |= ddir_act[op_is_write(op) ? WRITE : READ];
234         what |= MASK_TC_BIT(op_flags, SYNC);
235         what |= MASK_TC_BIT(op_flags, RAHEAD);
236         what |= MASK_TC_BIT(op_flags, META);
237         what |= MASK_TC_BIT(op_flags, PREFLUSH);
238         what |= MASK_TC_BIT(op_flags, FUA);
239         if (op == REQ_OP_DISCARD || op == REQ_OP_SECURE_ERASE)
240                 what |= BLK_TC_ACT(BLK_TC_DISCARD);
241         if (op == REQ_OP_FLUSH)
242                 what |= BLK_TC_ACT(BLK_TC_FLUSH);
243         if (cgid)
244                 what |= __BLK_TA_CGROUP;
245
246         pid = tsk->pid;
247         if (act_log_check(bt, what, sector, pid))
248                 return;
249         cpu = raw_smp_processor_id();
250
251         if (blk_tracer) {
252                 tracing_record_cmdline(current);
253
254                 buffer = blk_tr->array_buffer.buffer;
255                 pc = preempt_count();
256                 event = trace_buffer_lock_reserve(buffer, TRACE_BLK,
257                                                   sizeof(*t) + pdu_len + cgid_len,
258                                                   0, pc);
259                 if (!event)
260                         return;
261                 t = ring_buffer_event_data(event);
262                 goto record_it;
263         }
264
265         if (unlikely(tsk->btrace_seq != blktrace_seq))
266                 trace_note_tsk(tsk);
267
268         /*
269          * A word about the locking here - we disable interrupts to reserve
270          * some space in the relay per-cpu buffer, to prevent an irq
271          * from coming in and stepping on our toes.
272          */
273         local_irq_save(flags);
274         t = relay_reserve(bt->rchan, sizeof(*t) + pdu_len + cgid_len);
275         if (t) {
276                 sequence = per_cpu_ptr(bt->sequence, cpu);
277
278                 t->magic = BLK_IO_TRACE_MAGIC | BLK_IO_TRACE_VERSION;
279                 t->sequence = ++(*sequence);
280                 t->time = ktime_to_ns(ktime_get());
281 record_it:
282                 /*
283                  * These two are not needed in ftrace as they are in the
284                  * generic trace_entry, filled by tracing_generic_entry_update,
285                  * but for the trace_event->bin() synthesizer benefit we do it
286                  * here too.
287                  */
288                 t->cpu = cpu;
289                 t->pid = pid;
290
291                 t->sector = sector;
292                 t->bytes = bytes;
293                 t->action = what;
294                 t->device = bt->dev;
295                 t->error = error;
296                 t->pdu_len = pdu_len + cgid_len;
297
298                 if (cgid_len)
299                         memcpy((void *)t + sizeof(*t), &cgid, cgid_len);
300                 if (pdu_len)
301                         memcpy((void *)t + sizeof(*t) + cgid_len, pdu_data, pdu_len);
302
303                 if (blk_tracer) {
304                         trace_buffer_unlock_commit(blk_tr, buffer, event, 0, pc);
305                         return;
306                 }
307         }
308
309         local_irq_restore(flags);
310 }
311
312 static void blk_trace_free(struct blk_trace *bt)
313 {
314         debugfs_remove(bt->msg_file);
315         debugfs_remove(bt->dropped_file);
316         relay_close(bt->rchan);
317         debugfs_remove(bt->dir);
318         free_percpu(bt->sequence);
319         free_percpu(bt->msg_data);
320         kfree(bt);
321 }
322
323 static void get_probe_ref(void)
324 {
325         mutex_lock(&blk_probe_mutex);
326         if (++blk_probes_ref == 1)
327                 blk_register_tracepoints();
328         mutex_unlock(&blk_probe_mutex);
329 }
330
331 static void put_probe_ref(void)
332 {
333         mutex_lock(&blk_probe_mutex);
334         if (!--blk_probes_ref)
335                 blk_unregister_tracepoints();
336         mutex_unlock(&blk_probe_mutex);
337 }
338
339 static void blk_trace_cleanup(struct blk_trace *bt)
340 {
341         synchronize_rcu();
342         blk_trace_free(bt);
343         put_probe_ref();
344 }
345
346 static int __blk_trace_remove(struct request_queue *q)
347 {
348         struct blk_trace *bt;
349
350         bt = rcu_replace_pointer(q->blk_trace, NULL,
351                                  lockdep_is_held(&q->debugfs_mutex));
352         if (!bt)
353                 return -EINVAL;
354
355         if (bt->trace_state != Blktrace_running)
356                 blk_trace_cleanup(bt);
357
358         return 0;
359 }
360
361 int blk_trace_remove(struct request_queue *q)
362 {
363         int ret;
364
365         mutex_lock(&q->debugfs_mutex);
366         ret = __blk_trace_remove(q);
367         mutex_unlock(&q->debugfs_mutex);
368
369         return ret;
370 }
371 EXPORT_SYMBOL_GPL(blk_trace_remove);
372
373 static ssize_t blk_dropped_read(struct file *filp, char __user *buffer,
374                                 size_t count, loff_t *ppos)
375 {
376         struct blk_trace *bt = filp->private_data;
377         char buf[16];
378
379         snprintf(buf, sizeof(buf), "%u\n", atomic_read(&bt->dropped));
380
381         return simple_read_from_buffer(buffer, count, ppos, buf, strlen(buf));
382 }
383
384 static const struct file_operations blk_dropped_fops = {
385         .owner =        THIS_MODULE,
386         .open =         simple_open,
387         .read =         blk_dropped_read,
388         .llseek =       default_llseek,
389 };
390
391 static ssize_t blk_msg_write(struct file *filp, const char __user *buffer,
392                                 size_t count, loff_t *ppos)
393 {
394         char *msg;
395         struct blk_trace *bt;
396
397         if (count >= BLK_TN_MAX_MSG)
398                 return -EINVAL;
399
400         msg = memdup_user_nul(buffer, count);
401         if (IS_ERR(msg))
402                 return PTR_ERR(msg);
403
404         bt = filp->private_data;
405         __trace_note_message(bt, NULL, "%s", msg);
406         kfree(msg);
407
408         return count;
409 }
410
411 static const struct file_operations blk_msg_fops = {
412         .owner =        THIS_MODULE,
413         .open =         simple_open,
414         .write =        blk_msg_write,
415         .llseek =       noop_llseek,
416 };
417
418 /*
419  * Keep track of how many times we encountered a full subbuffer, to aid
420  * the user space app in telling how many lost events there were.
421  */
422 static int blk_subbuf_start_callback(struct rchan_buf *buf, void *subbuf,
423                                      void *prev_subbuf, size_t prev_padding)
424 {
425         struct blk_trace *bt;
426
427         if (!relay_buf_full(buf))
428                 return 1;
429
430         bt = buf->chan->private_data;
431         atomic_inc(&bt->dropped);
432         return 0;
433 }
434
435 static int blk_remove_buf_file_callback(struct dentry *dentry)
436 {
437         debugfs_remove(dentry);
438
439         return 0;
440 }
441
442 static struct dentry *blk_create_buf_file_callback(const char *filename,
443                                                    struct dentry *parent,
444                                                    umode_t mode,
445                                                    struct rchan_buf *buf,
446                                                    int *is_global)
447 {
448         return debugfs_create_file(filename, mode, parent, buf,
449                                         &relay_file_operations);
450 }
451
452 static struct rchan_callbacks blk_relay_callbacks = {
453         .subbuf_start           = blk_subbuf_start_callback,
454         .create_buf_file        = blk_create_buf_file_callback,
455         .remove_buf_file        = blk_remove_buf_file_callback,
456 };
457
458 static void blk_trace_setup_lba(struct blk_trace *bt,
459                                 struct block_device *bdev)
460 {
461         if (bdev) {
462                 bt->start_lba = bdev->bd_start_sect;
463                 bt->end_lba = bdev->bd_start_sect + bdev_nr_sectors(bdev);
464         } else {
465                 bt->start_lba = 0;
466                 bt->end_lba = -1ULL;
467         }
468 }
469
470 /*
471  * Setup everything required to start tracing
472  */
473 static int do_blk_trace_setup(struct request_queue *q, char *name, dev_t dev,
474                               struct block_device *bdev,
475                               struct blk_user_trace_setup *buts)
476 {
477         struct blk_trace *bt = NULL;
478         struct dentry *dir = NULL;
479         int ret;
480
481         lockdep_assert_held(&q->debugfs_mutex);
482
483         if (!buts->buf_size || !buts->buf_nr)
484                 return -EINVAL;
485
486         strncpy(buts->name, name, BLKTRACE_BDEV_SIZE);
487         buts->name[BLKTRACE_BDEV_SIZE - 1] = '\0';
488
489         /*
490          * some device names have larger paths - convert the slashes
491          * to underscores for this to work as expected
492          */
493         strreplace(buts->name, '/', '_');
494
495         /*
496          * bdev can be NULL, as with scsi-generic, this is a helpful as
497          * we can be.
498          */
499         if (rcu_dereference_protected(q->blk_trace,
500                                       lockdep_is_held(&q->debugfs_mutex))) {
501                 pr_warn("Concurrent blktraces are not allowed on %s\n",
502                         buts->name);
503                 return -EBUSY;
504         }
505
506         bt = kzalloc(sizeof(*bt), GFP_KERNEL);
507         if (!bt)
508                 return -ENOMEM;
509
510         ret = -ENOMEM;
511         bt->sequence = alloc_percpu(unsigned long);
512         if (!bt->sequence)
513                 goto err;
514
515         bt->msg_data = __alloc_percpu(BLK_TN_MAX_MSG, __alignof__(char));
516         if (!bt->msg_data)
517                 goto err;
518
519         /*
520          * When tracing the whole disk reuse the existing debugfs directory
521          * created by the block layer on init. For partitions block devices,
522          * and scsi-generic block devices we create a temporary new debugfs
523          * directory that will be removed once the trace ends.
524          */
525         if (bdev && !bdev_is_partition(bdev))
526                 dir = q->debugfs_dir;
527         else
528                 bt->dir = dir = debugfs_create_dir(buts->name, blk_debugfs_root);
529
530         /*
531          * As blktrace relies on debugfs for its interface the debugfs directory
532          * is required, contrary to the usual mantra of not checking for debugfs
533          * files or directories.
534          */
535         if (IS_ERR_OR_NULL(dir)) {
536                 pr_warn("debugfs_dir not present for %s so skipping\n",
537                         buts->name);
538                 ret = -ENOENT;
539                 goto err;
540         }
541
542         bt->dev = dev;
543         atomic_set(&bt->dropped, 0);
544         INIT_LIST_HEAD(&bt->running_list);
545
546         ret = -EIO;
547         bt->dropped_file = debugfs_create_file("dropped", 0444, dir, bt,
548                                                &blk_dropped_fops);
549
550         bt->msg_file = debugfs_create_file("msg", 0222, dir, bt, &blk_msg_fops);
551
552         bt->rchan = relay_open("trace", dir, buts->buf_size,
553                                 buts->buf_nr, &blk_relay_callbacks, bt);
554         if (!bt->rchan)
555                 goto err;
556
557         bt->act_mask = buts->act_mask;
558         if (!bt->act_mask)
559                 bt->act_mask = (u16) -1;
560
561         blk_trace_setup_lba(bt, bdev);
562
563         /* overwrite with user settings */
564         if (buts->start_lba)
565                 bt->start_lba = buts->start_lba;
566         if (buts->end_lba)
567                 bt->end_lba = buts->end_lba;
568
569         bt->pid = buts->pid;
570         bt->trace_state = Blktrace_setup;
571
572         rcu_assign_pointer(q->blk_trace, bt);
573         get_probe_ref();
574
575         ret = 0;
576 err:
577         if (ret)
578                 blk_trace_free(bt);
579         return ret;
580 }
581
582 static int __blk_trace_setup(struct request_queue *q, char *name, dev_t dev,
583                              struct block_device *bdev, char __user *arg)
584 {
585         struct blk_user_trace_setup buts;
586         int ret;
587
588         ret = copy_from_user(&buts, arg, sizeof(buts));
589         if (ret)
590                 return -EFAULT;
591
592         ret = do_blk_trace_setup(q, name, dev, bdev, &buts);
593         if (ret)
594                 return ret;
595
596         if (copy_to_user(arg, &buts, sizeof(buts))) {
597                 __blk_trace_remove(q);
598                 return -EFAULT;
599         }
600         return 0;
601 }
602
603 int blk_trace_setup(struct request_queue *q, char *name, dev_t dev,
604                     struct block_device *bdev,
605                     char __user *arg)
606 {
607         int ret;
608
609         mutex_lock(&q->debugfs_mutex);
610         ret = __blk_trace_setup(q, name, dev, bdev, arg);
611         mutex_unlock(&q->debugfs_mutex);
612
613         return ret;
614 }
615 EXPORT_SYMBOL_GPL(blk_trace_setup);
616
617 #if defined(CONFIG_COMPAT) && defined(CONFIG_X86_64)
618 static int compat_blk_trace_setup(struct request_queue *q, char *name,
619                                   dev_t dev, struct block_device *bdev,
620                                   char __user *arg)
621 {
622         struct blk_user_trace_setup buts;
623         struct compat_blk_user_trace_setup cbuts;
624         int ret;
625
626         if (copy_from_user(&cbuts, arg, sizeof(cbuts)))
627                 return -EFAULT;
628
629         buts = (struct blk_user_trace_setup) {
630                 .act_mask = cbuts.act_mask,
631                 .buf_size = cbuts.buf_size,
632                 .buf_nr = cbuts.buf_nr,
633                 .start_lba = cbuts.start_lba,
634                 .end_lba = cbuts.end_lba,
635                 .pid = cbuts.pid,
636         };
637
638         ret = do_blk_trace_setup(q, name, dev, bdev, &buts);
639         if (ret)
640                 return ret;
641
642         if (copy_to_user(arg, &buts.name, ARRAY_SIZE(buts.name))) {
643                 __blk_trace_remove(q);
644                 return -EFAULT;
645         }
646
647         return 0;
648 }
649 #endif
650
651 static int __blk_trace_startstop(struct request_queue *q, int start)
652 {
653         int ret;
654         struct blk_trace *bt;
655
656         bt = rcu_dereference_protected(q->blk_trace,
657                                        lockdep_is_held(&q->debugfs_mutex));
658         if (bt == NULL)
659                 return -EINVAL;
660
661         /*
662          * For starting a trace, we can transition from a setup or stopped
663          * trace. For stopping a trace, the state must be running
664          */
665         ret = -EINVAL;
666         if (start) {
667                 if (bt->trace_state == Blktrace_setup ||
668                     bt->trace_state == Blktrace_stopped) {
669                         blktrace_seq++;
670                         smp_mb();
671                         bt->trace_state = Blktrace_running;
672                         spin_lock_irq(&running_trace_lock);
673                         list_add(&bt->running_list, &running_trace_list);
674                         spin_unlock_irq(&running_trace_lock);
675
676                         trace_note_time(bt);
677                         ret = 0;
678                 }
679         } else {
680                 if (bt->trace_state == Blktrace_running) {
681                         bt->trace_state = Blktrace_stopped;
682                         spin_lock_irq(&running_trace_lock);
683                         list_del_init(&bt->running_list);
684                         spin_unlock_irq(&running_trace_lock);
685                         relay_flush(bt->rchan);
686                         ret = 0;
687                 }
688         }
689
690         return ret;
691 }
692
693 int blk_trace_startstop(struct request_queue *q, int start)
694 {
695         int ret;
696
697         mutex_lock(&q->debugfs_mutex);
698         ret = __blk_trace_startstop(q, start);
699         mutex_unlock(&q->debugfs_mutex);
700
701         return ret;
702 }
703 EXPORT_SYMBOL_GPL(blk_trace_startstop);
704
705 /*
706  * When reading or writing the blktrace sysfs files, the references to the
707  * opened sysfs or device files should prevent the underlying block device
708  * from being removed. So no further delete protection is really needed.
709  */
710
711 /**
712  * blk_trace_ioctl: - handle the ioctls associated with tracing
713  * @bdev:       the block device
714  * @cmd:        the ioctl cmd
715  * @arg:        the argument data, if any
716  *
717  **/
718 int blk_trace_ioctl(struct block_device *bdev, unsigned cmd, char __user *arg)
719 {
720         struct request_queue *q;
721         int ret, start = 0;
722         char b[BDEVNAME_SIZE];
723
724         q = bdev_get_queue(bdev);
725         if (!q)
726                 return -ENXIO;
727
728         mutex_lock(&q->debugfs_mutex);
729
730         switch (cmd) {
731         case BLKTRACESETUP:
732                 bdevname(bdev, b);
733                 ret = __blk_trace_setup(q, b, bdev->bd_dev, bdev, arg);
734                 break;
735 #if defined(CONFIG_COMPAT) && defined(CONFIG_X86_64)
736         case BLKTRACESETUP32:
737                 bdevname(bdev, b);
738                 ret = compat_blk_trace_setup(q, b, bdev->bd_dev, bdev, arg);
739                 break;
740 #endif
741         case BLKTRACESTART:
742                 start = 1;
743                 fallthrough;
744         case BLKTRACESTOP:
745                 ret = __blk_trace_startstop(q, start);
746                 break;
747         case BLKTRACETEARDOWN:
748                 ret = __blk_trace_remove(q);
749                 break;
750         default:
751                 ret = -ENOTTY;
752                 break;
753         }
754
755         mutex_unlock(&q->debugfs_mutex);
756         return ret;
757 }
758
759 /**
760  * blk_trace_shutdown: - stop and cleanup trace structures
761  * @q:    the request queue associated with the device
762  *
763  **/
764 void blk_trace_shutdown(struct request_queue *q)
765 {
766         mutex_lock(&q->debugfs_mutex);
767         if (rcu_dereference_protected(q->blk_trace,
768                                       lockdep_is_held(&q->debugfs_mutex))) {
769                 __blk_trace_startstop(q, 0);
770                 __blk_trace_remove(q);
771         }
772
773         mutex_unlock(&q->debugfs_mutex);
774 }
775
776 #ifdef CONFIG_BLK_CGROUP
777 static u64 blk_trace_bio_get_cgid(struct request_queue *q, struct bio *bio)
778 {
779         struct blk_trace *bt;
780
781         /* We don't use the 'bt' value here except as an optimization... */
782         bt = rcu_dereference_protected(q->blk_trace, 1);
783         if (!bt || !(blk_tracer_flags.val & TRACE_BLK_OPT_CGROUP))
784                 return 0;
785
786         if (!bio->bi_blkg)
787                 return 0;
788         return cgroup_id(bio_blkcg(bio)->css.cgroup);
789 }
790 #else
791 static u64 blk_trace_bio_get_cgid(struct request_queue *q, struct bio *bio)
792 {
793         return 0;
794 }
795 #endif
796
797 static u64
798 blk_trace_request_get_cgid(struct request_queue *q, struct request *rq)
799 {
800         if (!rq->bio)
801                 return 0;
802         /* Use the first bio */
803         return blk_trace_bio_get_cgid(q, rq->bio);
804 }
805
806 /*
807  * blktrace probes
808  */
809
810 /**
811  * blk_add_trace_rq - Add a trace for a request oriented action
812  * @rq:         the source request
813  * @error:      return status to log
814  * @nr_bytes:   number of completed bytes
815  * @what:       the action
816  * @cgid:       the cgroup info
817  *
818  * Description:
819  *     Records an action against a request. Will log the bio offset + size.
820  *
821  **/
822 static void blk_add_trace_rq(struct request *rq, int error,
823                              unsigned int nr_bytes, u32 what, u64 cgid)
824 {
825         struct blk_trace *bt;
826
827         rcu_read_lock();
828         bt = rcu_dereference(rq->q->blk_trace);
829         if (likely(!bt)) {
830                 rcu_read_unlock();
831                 return;
832         }
833
834         if (blk_rq_is_passthrough(rq))
835                 what |= BLK_TC_ACT(BLK_TC_PC);
836         else
837                 what |= BLK_TC_ACT(BLK_TC_FS);
838
839         __blk_add_trace(bt, blk_rq_trace_sector(rq), nr_bytes, req_op(rq),
840                         rq->cmd_flags, what, error, 0, NULL, cgid);
841         rcu_read_unlock();
842 }
843
844 static void blk_add_trace_rq_insert(void *ignore,
845                                     struct request_queue *q, struct request *rq)
846 {
847         blk_add_trace_rq(rq, 0, blk_rq_bytes(rq), BLK_TA_INSERT,
848                          blk_trace_request_get_cgid(q, rq));
849 }
850
851 static void blk_add_trace_rq_issue(void *ignore,
852                                    struct request_queue *q, struct request *rq)
853 {
854         blk_add_trace_rq(rq, 0, blk_rq_bytes(rq), BLK_TA_ISSUE,
855                          blk_trace_request_get_cgid(q, rq));
856 }
857
858 static void blk_add_trace_rq_merge(void *ignore,
859                                    struct request_queue *q, struct request *rq)
860 {
861         blk_add_trace_rq(rq, 0, blk_rq_bytes(rq), BLK_TA_BACKMERGE,
862                          blk_trace_request_get_cgid(q, rq));
863 }
864
865 static void blk_add_trace_rq_requeue(void *ignore,
866                                      struct request_queue *q,
867                                      struct request *rq)
868 {
869         blk_add_trace_rq(rq, 0, blk_rq_bytes(rq), BLK_TA_REQUEUE,
870                          blk_trace_request_get_cgid(q, rq));
871 }
872
873 static void blk_add_trace_rq_complete(void *ignore, struct request *rq,
874                         int error, unsigned int nr_bytes)
875 {
876         blk_add_trace_rq(rq, error, nr_bytes, BLK_TA_COMPLETE,
877                          blk_trace_request_get_cgid(rq->q, rq));
878 }
879
880 /**
881  * blk_add_trace_bio - Add a trace for a bio oriented action
882  * @q:          queue the io is for
883  * @bio:        the source bio
884  * @what:       the action
885  * @error:      error, if any
886  *
887  * Description:
888  *     Records an action against a bio. Will log the bio offset + size.
889  *
890  **/
891 static void blk_add_trace_bio(struct request_queue *q, struct bio *bio,
892                               u32 what, int error)
893 {
894         struct blk_trace *bt;
895
896         rcu_read_lock();
897         bt = rcu_dereference(q->blk_trace);
898         if (likely(!bt)) {
899                 rcu_read_unlock();
900                 return;
901         }
902
903         __blk_add_trace(bt, bio->bi_iter.bi_sector, bio->bi_iter.bi_size,
904                         bio_op(bio), bio->bi_opf, what, error, 0, NULL,
905                         blk_trace_bio_get_cgid(q, bio));
906         rcu_read_unlock();
907 }
908
909 static void blk_add_trace_bio_bounce(void *ignore,
910                                      struct request_queue *q, struct bio *bio)
911 {
912         blk_add_trace_bio(q, bio, BLK_TA_BOUNCE, 0);
913 }
914
915 static void blk_add_trace_bio_complete(void *ignore,
916                                        struct request_queue *q, struct bio *bio)
917 {
918         blk_add_trace_bio(q, bio, BLK_TA_COMPLETE,
919                           blk_status_to_errno(bio->bi_status));
920 }
921
922 static void blk_add_trace_bio_backmerge(void *ignore,
923                                         struct request_queue *q,
924                                         struct request *rq,
925                                         struct bio *bio)
926 {
927         blk_add_trace_bio(q, bio, BLK_TA_BACKMERGE, 0);
928 }
929
930 static void blk_add_trace_bio_frontmerge(void *ignore,
931                                          struct request_queue *q,
932                                          struct request *rq,
933                                          struct bio *bio)
934 {
935         blk_add_trace_bio(q, bio, BLK_TA_FRONTMERGE, 0);
936 }
937
938 static void blk_add_trace_bio_queue(void *ignore,
939                                     struct request_queue *q, struct bio *bio)
940 {
941         blk_add_trace_bio(q, bio, BLK_TA_QUEUE, 0);
942 }
943
944 static void blk_add_trace_getrq(void *ignore,
945                                 struct request_queue *q,
946                                 struct bio *bio, int rw)
947 {
948         if (bio)
949                 blk_add_trace_bio(q, bio, BLK_TA_GETRQ, 0);
950         else {
951                 struct blk_trace *bt;
952
953                 rcu_read_lock();
954                 bt = rcu_dereference(q->blk_trace);
955                 if (bt)
956                         __blk_add_trace(bt, 0, 0, rw, 0, BLK_TA_GETRQ, 0, 0,
957                                         NULL, 0);
958                 rcu_read_unlock();
959         }
960 }
961
962
963 static void blk_add_trace_sleeprq(void *ignore,
964                                   struct request_queue *q,
965                                   struct bio *bio, int rw)
966 {
967         if (bio)
968                 blk_add_trace_bio(q, bio, BLK_TA_SLEEPRQ, 0);
969         else {
970                 struct blk_trace *bt;
971
972                 rcu_read_lock();
973                 bt = rcu_dereference(q->blk_trace);
974                 if (bt)
975                         __blk_add_trace(bt, 0, 0, rw, 0, BLK_TA_SLEEPRQ,
976                                         0, 0, NULL, 0);
977                 rcu_read_unlock();
978         }
979 }
980
981 static void blk_add_trace_plug(void *ignore, struct request_queue *q)
982 {
983         struct blk_trace *bt;
984
985         rcu_read_lock();
986         bt = rcu_dereference(q->blk_trace);
987         if (bt)
988                 __blk_add_trace(bt, 0, 0, 0, 0, BLK_TA_PLUG, 0, 0, NULL, 0);
989         rcu_read_unlock();
990 }
991
992 static void blk_add_trace_unplug(void *ignore, struct request_queue *q,
993                                     unsigned int depth, bool explicit)
994 {
995         struct blk_trace *bt;
996
997         rcu_read_lock();
998         bt = rcu_dereference(q->blk_trace);
999         if (bt) {
1000                 __be64 rpdu = cpu_to_be64(depth);
1001                 u32 what;
1002
1003                 if (explicit)
1004                         what = BLK_TA_UNPLUG_IO;
1005                 else
1006                         what = BLK_TA_UNPLUG_TIMER;
1007
1008                 __blk_add_trace(bt, 0, 0, 0, 0, what, 0, sizeof(rpdu), &rpdu, 0);
1009         }
1010         rcu_read_unlock();
1011 }
1012
1013 static void blk_add_trace_split(void *ignore,
1014                                 struct request_queue *q, struct bio *bio,
1015                                 unsigned int pdu)
1016 {
1017         struct blk_trace *bt;
1018
1019         rcu_read_lock();
1020         bt = rcu_dereference(q->blk_trace);
1021         if (bt) {
1022                 __be64 rpdu = cpu_to_be64(pdu);
1023
1024                 __blk_add_trace(bt, bio->bi_iter.bi_sector,
1025                                 bio->bi_iter.bi_size, bio_op(bio), bio->bi_opf,
1026                                 BLK_TA_SPLIT,
1027                                 blk_status_to_errno(bio->bi_status),
1028                                 sizeof(rpdu), &rpdu,
1029                                 blk_trace_bio_get_cgid(q, bio));
1030         }
1031         rcu_read_unlock();
1032 }
1033
1034 /**
1035  * blk_add_trace_bio_remap - Add a trace for a bio-remap operation
1036  * @ignore:     trace callback data parameter (not used)
1037  * @q:          queue the io is for
1038  * @bio:        the source bio
1039  * @dev:        target device
1040  * @from:       source sector
1041  *
1042  * Description:
1043  *     Device mapper or raid target sometimes need to split a bio because
1044  *     it spans a stripe (or similar). Add a trace for that action.
1045  *
1046  **/
1047 static void blk_add_trace_bio_remap(void *ignore,
1048                                     struct request_queue *q, struct bio *bio,
1049                                     dev_t dev, sector_t from)
1050 {
1051         struct blk_trace *bt;
1052         struct blk_io_trace_remap r;
1053
1054         rcu_read_lock();
1055         bt = rcu_dereference(q->blk_trace);
1056         if (likely(!bt)) {
1057                 rcu_read_unlock();
1058                 return;
1059         }
1060
1061         r.device_from = cpu_to_be32(dev);
1062         r.device_to   = cpu_to_be32(bio_dev(bio));
1063         r.sector_from = cpu_to_be64(from);
1064
1065         __blk_add_trace(bt, bio->bi_iter.bi_sector, bio->bi_iter.bi_size,
1066                         bio_op(bio), bio->bi_opf, BLK_TA_REMAP,
1067                         blk_status_to_errno(bio->bi_status),
1068                         sizeof(r), &r, blk_trace_bio_get_cgid(q, bio));
1069         rcu_read_unlock();
1070 }
1071
1072 /**
1073  * blk_add_trace_rq_remap - Add a trace for a request-remap operation
1074  * @ignore:     trace callback data parameter (not used)
1075  * @q:          queue the io is for
1076  * @rq:         the source request
1077  * @dev:        target device
1078  * @from:       source sector
1079  *
1080  * Description:
1081  *     Device mapper remaps request to other devices.
1082  *     Add a trace for that action.
1083  *
1084  **/
1085 static void blk_add_trace_rq_remap(void *ignore,
1086                                    struct request_queue *q,
1087                                    struct request *rq, dev_t dev,
1088                                    sector_t from)
1089 {
1090         struct blk_trace *bt;
1091         struct blk_io_trace_remap r;
1092
1093         rcu_read_lock();
1094         bt = rcu_dereference(q->blk_trace);
1095         if (likely(!bt)) {
1096                 rcu_read_unlock();
1097                 return;
1098         }
1099
1100         r.device_from = cpu_to_be32(dev);
1101         r.device_to   = cpu_to_be32(disk_devt(rq->rq_disk));
1102         r.sector_from = cpu_to_be64(from);
1103
1104         __blk_add_trace(bt, blk_rq_pos(rq), blk_rq_bytes(rq),
1105                         rq_data_dir(rq), 0, BLK_TA_REMAP, 0,
1106                         sizeof(r), &r, blk_trace_request_get_cgid(q, rq));
1107         rcu_read_unlock();
1108 }
1109
1110 /**
1111  * blk_add_driver_data - Add binary message with driver-specific data
1112  * @q:          queue the io is for
1113  * @rq:         io request
1114  * @data:       driver-specific data
1115  * @len:        length of driver-specific data
1116  *
1117  * Description:
1118  *     Some drivers might want to write driver-specific data per request.
1119  *
1120  **/
1121 void blk_add_driver_data(struct request_queue *q,
1122                          struct request *rq,
1123                          void *data, size_t len)
1124 {
1125         struct blk_trace *bt;
1126
1127         rcu_read_lock();
1128         bt = rcu_dereference(q->blk_trace);
1129         if (likely(!bt)) {
1130                 rcu_read_unlock();
1131                 return;
1132         }
1133
1134         __blk_add_trace(bt, blk_rq_trace_sector(rq), blk_rq_bytes(rq), 0, 0,
1135                                 BLK_TA_DRV_DATA, 0, len, data,
1136                                 blk_trace_request_get_cgid(q, rq));
1137         rcu_read_unlock();
1138 }
1139 EXPORT_SYMBOL_GPL(blk_add_driver_data);
1140
1141 static void blk_register_tracepoints(void)
1142 {
1143         int ret;
1144
1145         ret = register_trace_block_rq_insert(blk_add_trace_rq_insert, NULL);
1146         WARN_ON(ret);
1147         ret = register_trace_block_rq_issue(blk_add_trace_rq_issue, NULL);
1148         WARN_ON(ret);
1149         ret = register_trace_block_rq_merge(blk_add_trace_rq_merge, NULL);
1150         WARN_ON(ret);
1151         ret = register_trace_block_rq_requeue(blk_add_trace_rq_requeue, NULL);
1152         WARN_ON(ret);
1153         ret = register_trace_block_rq_complete(blk_add_trace_rq_complete, NULL);
1154         WARN_ON(ret);
1155         ret = register_trace_block_bio_bounce(blk_add_trace_bio_bounce, NULL);
1156         WARN_ON(ret);
1157         ret = register_trace_block_bio_complete(blk_add_trace_bio_complete, NULL);
1158         WARN_ON(ret);
1159         ret = register_trace_block_bio_backmerge(blk_add_trace_bio_backmerge, NULL);
1160         WARN_ON(ret);
1161         ret = register_trace_block_bio_frontmerge(blk_add_trace_bio_frontmerge, NULL);
1162         WARN_ON(ret);
1163         ret = register_trace_block_bio_queue(blk_add_trace_bio_queue, NULL);
1164         WARN_ON(ret);
1165         ret = register_trace_block_getrq(blk_add_trace_getrq, NULL);
1166         WARN_ON(ret);
1167         ret = register_trace_block_sleeprq(blk_add_trace_sleeprq, NULL);
1168         WARN_ON(ret);
1169         ret = register_trace_block_plug(blk_add_trace_plug, NULL);
1170         WARN_ON(ret);
1171         ret = register_trace_block_unplug(blk_add_trace_unplug, NULL);
1172         WARN_ON(ret);
1173         ret = register_trace_block_split(blk_add_trace_split, NULL);
1174         WARN_ON(ret);
1175         ret = register_trace_block_bio_remap(blk_add_trace_bio_remap, NULL);
1176         WARN_ON(ret);
1177         ret = register_trace_block_rq_remap(blk_add_trace_rq_remap, NULL);
1178         WARN_ON(ret);
1179 }
1180
1181 static void blk_unregister_tracepoints(void)
1182 {
1183         unregister_trace_block_rq_remap(blk_add_trace_rq_remap, NULL);
1184         unregister_trace_block_bio_remap(blk_add_trace_bio_remap, NULL);
1185         unregister_trace_block_split(blk_add_trace_split, NULL);
1186         unregister_trace_block_unplug(blk_add_trace_unplug, NULL);
1187         unregister_trace_block_plug(blk_add_trace_plug, NULL);
1188         unregister_trace_block_sleeprq(blk_add_trace_sleeprq, NULL);
1189         unregister_trace_block_getrq(blk_add_trace_getrq, NULL);
1190         unregister_trace_block_bio_queue(blk_add_trace_bio_queue, NULL);
1191         unregister_trace_block_bio_frontmerge(blk_add_trace_bio_frontmerge, NULL);
1192         unregister_trace_block_bio_backmerge(blk_add_trace_bio_backmerge, NULL);
1193         unregister_trace_block_bio_complete(blk_add_trace_bio_complete, NULL);
1194         unregister_trace_block_bio_bounce(blk_add_trace_bio_bounce, NULL);
1195         unregister_trace_block_rq_complete(blk_add_trace_rq_complete, NULL);
1196         unregister_trace_block_rq_requeue(blk_add_trace_rq_requeue, NULL);
1197         unregister_trace_block_rq_merge(blk_add_trace_rq_merge, NULL);
1198         unregister_trace_block_rq_issue(blk_add_trace_rq_issue, NULL);
1199         unregister_trace_block_rq_insert(blk_add_trace_rq_insert, NULL);
1200
1201         tracepoint_synchronize_unregister();
1202 }
1203
1204 /*
1205  * struct blk_io_tracer formatting routines
1206  */
1207
1208 static void fill_rwbs(char *rwbs, const struct blk_io_trace *t)
1209 {
1210         int i = 0;
1211         int tc = t->action >> BLK_TC_SHIFT;
1212
1213         if ((t->action & ~__BLK_TN_CGROUP) == BLK_TN_MESSAGE) {
1214                 rwbs[i++] = 'N';
1215                 goto out;
1216         }
1217
1218         if (tc & BLK_TC_FLUSH)
1219                 rwbs[i++] = 'F';
1220
1221         if (tc & BLK_TC_DISCARD)
1222                 rwbs[i++] = 'D';
1223         else if (tc & BLK_TC_WRITE)
1224                 rwbs[i++] = 'W';
1225         else if (t->bytes)
1226                 rwbs[i++] = 'R';
1227         else
1228                 rwbs[i++] = 'N';
1229
1230         if (tc & BLK_TC_FUA)
1231                 rwbs[i++] = 'F';
1232         if (tc & BLK_TC_AHEAD)
1233                 rwbs[i++] = 'A';
1234         if (tc & BLK_TC_SYNC)
1235                 rwbs[i++] = 'S';
1236         if (tc & BLK_TC_META)
1237                 rwbs[i++] = 'M';
1238 out:
1239         rwbs[i] = '\0';
1240 }
1241
1242 static inline
1243 const struct blk_io_trace *te_blk_io_trace(const struct trace_entry *ent)
1244 {
1245         return (const struct blk_io_trace *)ent;
1246 }
1247
1248 static inline const void *pdu_start(const struct trace_entry *ent, bool has_cg)
1249 {
1250         return (void *)(te_blk_io_trace(ent) + 1) + (has_cg ? sizeof(u64) : 0);
1251 }
1252
1253 static inline u64 t_cgid(const struct trace_entry *ent)
1254 {
1255         return *(u64 *)(te_blk_io_trace(ent) + 1);
1256 }
1257
1258 static inline int pdu_real_len(const struct trace_entry *ent, bool has_cg)
1259 {
1260         return te_blk_io_trace(ent)->pdu_len - (has_cg ? sizeof(u64) : 0);
1261 }
1262
1263 static inline u32 t_action(const struct trace_entry *ent)
1264 {
1265         return te_blk_io_trace(ent)->action;
1266 }
1267
1268 static inline u32 t_bytes(const struct trace_entry *ent)
1269 {
1270         return te_blk_io_trace(ent)->bytes;
1271 }
1272
1273 static inline u32 t_sec(const struct trace_entry *ent)
1274 {
1275         return te_blk_io_trace(ent)->bytes >> 9;
1276 }
1277
1278 static inline unsigned long long t_sector(const struct trace_entry *ent)
1279 {
1280         return te_blk_io_trace(ent)->sector;
1281 }
1282
1283 static inline __u16 t_error(const struct trace_entry *ent)
1284 {
1285         return te_blk_io_trace(ent)->error;
1286 }
1287
1288 static __u64 get_pdu_int(const struct trace_entry *ent, bool has_cg)
1289 {
1290         const __be64 *val = pdu_start(ent, has_cg);
1291         return be64_to_cpu(*val);
1292 }
1293
1294 typedef void (blk_log_action_t) (struct trace_iterator *iter, const char *act,
1295         bool has_cg);
1296
1297 static void blk_log_action_classic(struct trace_iterator *iter, const char *act,
1298         bool has_cg)
1299 {
1300         char rwbs[RWBS_LEN];
1301         unsigned long long ts  = iter->ts;
1302         unsigned long nsec_rem = do_div(ts, NSEC_PER_SEC);
1303         unsigned secs          = (unsigned long)ts;
1304         const struct blk_io_trace *t = te_blk_io_trace(iter->ent);
1305
1306         fill_rwbs(rwbs, t);
1307
1308         trace_seq_printf(&iter->seq,
1309                          "%3d,%-3d %2d %5d.%09lu %5u %2s %3s ",
1310                          MAJOR(t->device), MINOR(t->device), iter->cpu,
1311                          secs, nsec_rem, iter->ent->pid, act, rwbs);
1312 }
1313
1314 static void blk_log_action(struct trace_iterator *iter, const char *act,
1315         bool has_cg)
1316 {
1317         char rwbs[RWBS_LEN];
1318         const struct blk_io_trace *t = te_blk_io_trace(iter->ent);
1319
1320         fill_rwbs(rwbs, t);
1321         if (has_cg) {
1322                 u64 id = t_cgid(iter->ent);
1323
1324                 if (blk_tracer_flags.val & TRACE_BLK_OPT_CGNAME) {
1325                         char blkcg_name_buf[NAME_MAX + 1] = "<...>";
1326
1327                         cgroup_path_from_kernfs_id(id, blkcg_name_buf,
1328                                 sizeof(blkcg_name_buf));
1329                         trace_seq_printf(&iter->seq, "%3d,%-3d %s %2s %3s ",
1330                                  MAJOR(t->device), MINOR(t->device),
1331                                  blkcg_name_buf, act, rwbs);
1332                 } else {
1333                         /*
1334                          * The cgid portion used to be "INO,GEN".  Userland
1335                          * builds a FILEID_INO32_GEN fid out of them and
1336                          * opens the cgroup using open_by_handle_at(2).
1337                          * While 32bit ino setups are still the same, 64bit
1338                          * ones now use the 64bit ino as the whole ID and
1339                          * no longer use generation.
1340                          *
1341                          * Regarldess of the content, always output
1342                          * "LOW32,HIGH32" so that FILEID_INO32_GEN fid can
1343                          * be mapped back to @id on both 64 and 32bit ino
1344                          * setups.  See __kernfs_fh_to_dentry().
1345                          */
1346                         trace_seq_printf(&iter->seq,
1347                                  "%3d,%-3d %llx,%-llx %2s %3s ",
1348                                  MAJOR(t->device), MINOR(t->device),
1349                                  id & U32_MAX, id >> 32, act, rwbs);
1350                 }
1351         } else
1352                 trace_seq_printf(&iter->seq, "%3d,%-3d %2s %3s ",
1353                                  MAJOR(t->device), MINOR(t->device), act, rwbs);
1354 }
1355
1356 static void blk_log_dump_pdu(struct trace_seq *s,
1357         const struct trace_entry *ent, bool has_cg)
1358 {
1359         const unsigned char *pdu_buf;
1360         int pdu_len;
1361         int i, end;
1362
1363         pdu_buf = pdu_start(ent, has_cg);
1364         pdu_len = pdu_real_len(ent, has_cg);
1365
1366         if (!pdu_len)
1367                 return;
1368
1369         /* find the last zero that needs to be printed */
1370         for (end = pdu_len - 1; end >= 0; end--)
1371                 if (pdu_buf[end])
1372                         break;
1373         end++;
1374
1375         trace_seq_putc(s, '(');
1376
1377         for (i = 0; i < pdu_len; i++) {
1378
1379                 trace_seq_printf(s, "%s%02x",
1380                                  i == 0 ? "" : " ", pdu_buf[i]);
1381
1382                 /*
1383                  * stop when the rest is just zeroes and indicate so
1384                  * with a ".." appended
1385                  */
1386                 if (i == end && end != pdu_len - 1) {
1387                         trace_seq_puts(s, " ..) ");
1388                         return;
1389                 }
1390         }
1391
1392         trace_seq_puts(s, ") ");
1393 }
1394
1395 static void blk_log_generic(struct trace_seq *s, const struct trace_entry *ent, bool has_cg)
1396 {
1397         char cmd[TASK_COMM_LEN];
1398
1399         trace_find_cmdline(ent->pid, cmd);
1400
1401         if (t_action(ent) & BLK_TC_ACT(BLK_TC_PC)) {
1402                 trace_seq_printf(s, "%u ", t_bytes(ent));
1403                 blk_log_dump_pdu(s, ent, has_cg);
1404                 trace_seq_printf(s, "[%s]\n", cmd);
1405         } else {
1406                 if (t_sec(ent))
1407                         trace_seq_printf(s, "%llu + %u [%s]\n",
1408                                                 t_sector(ent), t_sec(ent), cmd);
1409                 else
1410                         trace_seq_printf(s, "[%s]\n", cmd);
1411         }
1412 }
1413
1414 static void blk_log_with_error(struct trace_seq *s,
1415                               const struct trace_entry *ent, bool has_cg)
1416 {
1417         if (t_action(ent) & BLK_TC_ACT(BLK_TC_PC)) {
1418                 blk_log_dump_pdu(s, ent, has_cg);
1419                 trace_seq_printf(s, "[%d]\n", t_error(ent));
1420         } else {
1421                 if (t_sec(ent))
1422                         trace_seq_printf(s, "%llu + %u [%d]\n",
1423                                          t_sector(ent),
1424                                          t_sec(ent), t_error(ent));
1425                 else
1426                         trace_seq_printf(s, "%llu [%d]\n",
1427                                          t_sector(ent), t_error(ent));
1428         }
1429 }
1430
1431 static void blk_log_remap(struct trace_seq *s, const struct trace_entry *ent, bool has_cg)
1432 {
1433         const struct blk_io_trace_remap *__r = pdu_start(ent, has_cg);
1434
1435         trace_seq_printf(s, "%llu + %u <- (%d,%d) %llu\n",
1436                          t_sector(ent), t_sec(ent),
1437                          MAJOR(be32_to_cpu(__r->device_from)),
1438                          MINOR(be32_to_cpu(__r->device_from)),
1439                          be64_to_cpu(__r->sector_from));
1440 }
1441
1442 static void blk_log_plug(struct trace_seq *s, const struct trace_entry *ent, bool has_cg)
1443 {
1444         char cmd[TASK_COMM_LEN];
1445
1446         trace_find_cmdline(ent->pid, cmd);
1447
1448         trace_seq_printf(s, "[%s]\n", cmd);
1449 }
1450
1451 static void blk_log_unplug(struct trace_seq *s, const struct trace_entry *ent, bool has_cg)
1452 {
1453         char cmd[TASK_COMM_LEN];
1454
1455         trace_find_cmdline(ent->pid, cmd);
1456
1457         trace_seq_printf(s, "[%s] %llu\n", cmd, get_pdu_int(ent, has_cg));
1458 }
1459
1460 static void blk_log_split(struct trace_seq *s, const struct trace_entry *ent, bool has_cg)
1461 {
1462         char cmd[TASK_COMM_LEN];
1463
1464         trace_find_cmdline(ent->pid, cmd);
1465
1466         trace_seq_printf(s, "%llu / %llu [%s]\n", t_sector(ent),
1467                          get_pdu_int(ent, has_cg), cmd);
1468 }
1469
1470 static void blk_log_msg(struct trace_seq *s, const struct trace_entry *ent,
1471                         bool has_cg)
1472 {
1473
1474         trace_seq_putmem(s, pdu_start(ent, has_cg),
1475                 pdu_real_len(ent, has_cg));
1476         trace_seq_putc(s, '\n');
1477 }
1478
1479 /*
1480  * struct tracer operations
1481  */
1482
1483 static void blk_tracer_print_header(struct seq_file *m)
1484 {
1485         if (!(blk_tracer_flags.val & TRACE_BLK_OPT_CLASSIC))
1486                 return;
1487         seq_puts(m, "# DEV   CPU TIMESTAMP     PID ACT FLG\n"
1488                     "#  |     |     |           |   |   |\n");
1489 }
1490
1491 static void blk_tracer_start(struct trace_array *tr)
1492 {
1493         blk_tracer_enabled = true;
1494 }
1495
1496 static int blk_tracer_init(struct trace_array *tr)
1497 {
1498         blk_tr = tr;
1499         blk_tracer_start(tr);
1500         return 0;
1501 }
1502
1503 static void blk_tracer_stop(struct trace_array *tr)
1504 {
1505         blk_tracer_enabled = false;
1506 }
1507
1508 static void blk_tracer_reset(struct trace_array *tr)
1509 {
1510         blk_tracer_stop(tr);
1511 }
1512
1513 static const struct {
1514         const char *act[2];
1515         void       (*print)(struct trace_seq *s, const struct trace_entry *ent,
1516                             bool has_cg);
1517 } what2act[] = {
1518         [__BLK_TA_QUEUE]        = {{  "Q", "queue" },      blk_log_generic },
1519         [__BLK_TA_BACKMERGE]    = {{  "M", "backmerge" },  blk_log_generic },
1520         [__BLK_TA_FRONTMERGE]   = {{  "F", "frontmerge" }, blk_log_generic },
1521         [__BLK_TA_GETRQ]        = {{  "G", "getrq" },      blk_log_generic },
1522         [__BLK_TA_SLEEPRQ]      = {{  "S", "sleeprq" },    blk_log_generic },
1523         [__BLK_TA_REQUEUE]      = {{  "R", "requeue" },    blk_log_with_error },
1524         [__BLK_TA_ISSUE]        = {{  "D", "issue" },      blk_log_generic },
1525         [__BLK_TA_COMPLETE]     = {{  "C", "complete" },   blk_log_with_error },
1526         [__BLK_TA_PLUG]         = {{  "P", "plug" },       blk_log_plug },
1527         [__BLK_TA_UNPLUG_IO]    = {{  "U", "unplug_io" },  blk_log_unplug },
1528         [__BLK_TA_UNPLUG_TIMER] = {{ "UT", "unplug_timer" }, blk_log_unplug },
1529         [__BLK_TA_INSERT]       = {{  "I", "insert" },     blk_log_generic },
1530         [__BLK_TA_SPLIT]        = {{  "X", "split" },      blk_log_split },
1531         [__BLK_TA_BOUNCE]       = {{  "B", "bounce" },     blk_log_generic },
1532         [__BLK_TA_REMAP]        = {{  "A", "remap" },      blk_log_remap },
1533 };
1534
1535 static enum print_line_t print_one_line(struct trace_iterator *iter,
1536                                         bool classic)
1537 {
1538         struct trace_array *tr = iter->tr;
1539         struct trace_seq *s = &iter->seq;
1540         const struct blk_io_trace *t;
1541         u16 what;
1542         bool long_act;
1543         blk_log_action_t *log_action;
1544         bool has_cg;
1545
1546         t          = te_blk_io_trace(iter->ent);
1547         what       = (t->action & ((1 << BLK_TC_SHIFT) - 1)) & ~__BLK_TA_CGROUP;
1548         long_act   = !!(tr->trace_flags & TRACE_ITER_VERBOSE);
1549         log_action = classic ? &blk_log_action_classic : &blk_log_action;
1550         has_cg     = t->action & __BLK_TA_CGROUP;
1551
1552         if ((t->action & ~__BLK_TN_CGROUP) == BLK_TN_MESSAGE) {
1553                 log_action(iter, long_act ? "message" : "m", has_cg);
1554                 blk_log_msg(s, iter->ent, has_cg);
1555                 return trace_handle_return(s);
1556         }
1557
1558         if (unlikely(what == 0 || what >= ARRAY_SIZE(what2act)))
1559                 trace_seq_printf(s, "Unknown action %x\n", what);
1560         else {
1561                 log_action(iter, what2act[what].act[long_act], has_cg);
1562                 what2act[what].print(s, iter->ent, has_cg);
1563         }
1564
1565         return trace_handle_return(s);
1566 }
1567
1568 static enum print_line_t blk_trace_event_print(struct trace_iterator *iter,
1569                                                int flags, struct trace_event *event)
1570 {
1571         return print_one_line(iter, false);
1572 }
1573
1574 static void blk_trace_synthesize_old_trace(struct trace_iterator *iter)
1575 {
1576         struct trace_seq *s = &iter->seq;
1577         struct blk_io_trace *t = (struct blk_io_trace *)iter->ent;
1578         const int offset = offsetof(struct blk_io_trace, sector);
1579         struct blk_io_trace old = {
1580                 .magic    = BLK_IO_TRACE_MAGIC | BLK_IO_TRACE_VERSION,
1581                 .time     = iter->ts,
1582         };
1583
1584         trace_seq_putmem(s, &old, offset);
1585         trace_seq_putmem(s, &t->sector,
1586                          sizeof(old) - offset + t->pdu_len);
1587 }
1588
1589 static enum print_line_t
1590 blk_trace_event_print_binary(struct trace_iterator *iter, int flags,
1591                              struct trace_event *event)
1592 {
1593         blk_trace_synthesize_old_trace(iter);
1594
1595         return trace_handle_return(&iter->seq);
1596 }
1597
1598 static enum print_line_t blk_tracer_print_line(struct trace_iterator *iter)
1599 {
1600         if (!(blk_tracer_flags.val & TRACE_BLK_OPT_CLASSIC))
1601                 return TRACE_TYPE_UNHANDLED;
1602
1603         return print_one_line(iter, true);
1604 }
1605
1606 static int
1607 blk_tracer_set_flag(struct trace_array *tr, u32 old_flags, u32 bit, int set)
1608 {
1609         /* don't output context-info for blk_classic output */
1610         if (bit == TRACE_BLK_OPT_CLASSIC) {
1611                 if (set)
1612                         tr->trace_flags &= ~TRACE_ITER_CONTEXT_INFO;
1613                 else
1614                         tr->trace_flags |= TRACE_ITER_CONTEXT_INFO;
1615         }
1616         return 0;
1617 }
1618
1619 static struct tracer blk_tracer __read_mostly = {
1620         .name           = "blk",
1621         .init           = blk_tracer_init,
1622         .reset          = blk_tracer_reset,
1623         .start          = blk_tracer_start,
1624         .stop           = blk_tracer_stop,
1625         .print_header   = blk_tracer_print_header,
1626         .print_line     = blk_tracer_print_line,
1627         .flags          = &blk_tracer_flags,
1628         .set_flag       = blk_tracer_set_flag,
1629 };
1630
1631 static struct trace_event_functions trace_blk_event_funcs = {
1632         .trace          = blk_trace_event_print,
1633         .binary         = blk_trace_event_print_binary,
1634 };
1635
1636 static struct trace_event trace_blk_event = {
1637         .type           = TRACE_BLK,
1638         .funcs          = &trace_blk_event_funcs,
1639 };
1640
1641 static int __init init_blk_tracer(void)
1642 {
1643         if (!register_trace_event(&trace_blk_event)) {
1644                 pr_warn("Warning: could not register block events\n");
1645                 return 1;
1646         }
1647
1648         if (register_tracer(&blk_tracer) != 0) {
1649                 pr_warn("Warning: could not register the block tracer\n");
1650                 unregister_trace_event(&trace_blk_event);
1651                 return 1;
1652         }
1653
1654         return 0;
1655 }
1656
1657 device_initcall(init_blk_tracer);
1658
1659 static int blk_trace_remove_queue(struct request_queue *q)
1660 {
1661         struct blk_trace *bt;
1662
1663         bt = rcu_replace_pointer(q->blk_trace, NULL,
1664                                  lockdep_is_held(&q->debugfs_mutex));
1665         if (bt == NULL)
1666                 return -EINVAL;
1667
1668         put_probe_ref();
1669         synchronize_rcu();
1670         blk_trace_free(bt);
1671         return 0;
1672 }
1673
1674 /*
1675  * Setup everything required to start tracing
1676  */
1677 static int blk_trace_setup_queue(struct request_queue *q,
1678                                  struct block_device *bdev)
1679 {
1680         struct blk_trace *bt = NULL;
1681         int ret = -ENOMEM;
1682
1683         bt = kzalloc(sizeof(*bt), GFP_KERNEL);
1684         if (!bt)
1685                 return -ENOMEM;
1686
1687         bt->msg_data = __alloc_percpu(BLK_TN_MAX_MSG, __alignof__(char));
1688         if (!bt->msg_data)
1689                 goto free_bt;
1690
1691         bt->dev = bdev->bd_dev;
1692         bt->act_mask = (u16)-1;
1693
1694         blk_trace_setup_lba(bt, bdev);
1695
1696         rcu_assign_pointer(q->blk_trace, bt);
1697         get_probe_ref();
1698         return 0;
1699
1700 free_bt:
1701         blk_trace_free(bt);
1702         return ret;
1703 }
1704
1705 /*
1706  * sysfs interface to enable and configure tracing
1707  */
1708
1709 static ssize_t sysfs_blk_trace_attr_show(struct device *dev,
1710                                          struct device_attribute *attr,
1711                                          char *buf);
1712 static ssize_t sysfs_blk_trace_attr_store(struct device *dev,
1713                                           struct device_attribute *attr,
1714                                           const char *buf, size_t count);
1715 #define BLK_TRACE_DEVICE_ATTR(_name) \
1716         DEVICE_ATTR(_name, S_IRUGO | S_IWUSR, \
1717                     sysfs_blk_trace_attr_show, \
1718                     sysfs_blk_trace_attr_store)
1719
1720 static BLK_TRACE_DEVICE_ATTR(enable);
1721 static BLK_TRACE_DEVICE_ATTR(act_mask);
1722 static BLK_TRACE_DEVICE_ATTR(pid);
1723 static BLK_TRACE_DEVICE_ATTR(start_lba);
1724 static BLK_TRACE_DEVICE_ATTR(end_lba);
1725
1726 static struct attribute *blk_trace_attrs[] = {
1727         &dev_attr_enable.attr,
1728         &dev_attr_act_mask.attr,
1729         &dev_attr_pid.attr,
1730         &dev_attr_start_lba.attr,
1731         &dev_attr_end_lba.attr,
1732         NULL
1733 };
1734
1735 struct attribute_group blk_trace_attr_group = {
1736         .name  = "trace",
1737         .attrs = blk_trace_attrs,
1738 };
1739
1740 static const struct {
1741         int mask;
1742         const char *str;
1743 } mask_maps[] = {
1744         { BLK_TC_READ,          "read"          },
1745         { BLK_TC_WRITE,         "write"         },
1746         { BLK_TC_FLUSH,         "flush"         },
1747         { BLK_TC_SYNC,          "sync"          },
1748         { BLK_TC_QUEUE,         "queue"         },
1749         { BLK_TC_REQUEUE,       "requeue"       },
1750         { BLK_TC_ISSUE,         "issue"         },
1751         { BLK_TC_COMPLETE,      "complete"      },
1752         { BLK_TC_FS,            "fs"            },
1753         { BLK_TC_PC,            "pc"            },
1754         { BLK_TC_NOTIFY,        "notify"        },
1755         { BLK_TC_AHEAD,         "ahead"         },
1756         { BLK_TC_META,          "meta"          },
1757         { BLK_TC_DISCARD,       "discard"       },
1758         { BLK_TC_DRV_DATA,      "drv_data"      },
1759         { BLK_TC_FUA,           "fua"           },
1760 };
1761
1762 static int blk_trace_str2mask(const char *str)
1763 {
1764         int i;
1765         int mask = 0;
1766         char *buf, *s, *token;
1767
1768         buf = kstrdup(str, GFP_KERNEL);
1769         if (buf == NULL)
1770                 return -ENOMEM;
1771         s = strstrip(buf);
1772
1773         while (1) {
1774                 token = strsep(&s, ",");
1775                 if (token == NULL)
1776                         break;
1777
1778                 if (*token == '\0')
1779                         continue;
1780
1781                 for (i = 0; i < ARRAY_SIZE(mask_maps); i++) {
1782                         if (strcasecmp(token, mask_maps[i].str) == 0) {
1783                                 mask |= mask_maps[i].mask;
1784                                 break;
1785                         }
1786                 }
1787                 if (i == ARRAY_SIZE(mask_maps)) {
1788                         mask = -EINVAL;
1789                         break;
1790                 }
1791         }
1792         kfree(buf);
1793
1794         return mask;
1795 }
1796
1797 static ssize_t blk_trace_mask2str(char *buf, int mask)
1798 {
1799         int i;
1800         char *p = buf;
1801
1802         for (i = 0; i < ARRAY_SIZE(mask_maps); i++) {
1803                 if (mask & mask_maps[i].mask) {
1804                         p += sprintf(p, "%s%s",
1805                                     (p == buf) ? "" : ",", mask_maps[i].str);
1806                 }
1807         }
1808         *p++ = '\n';
1809
1810         return p - buf;
1811 }
1812
1813 static ssize_t sysfs_blk_trace_attr_show(struct device *dev,
1814                                          struct device_attribute *attr,
1815                                          char *buf)
1816 {
1817         struct block_device *bdev = dev_to_bdev(dev);
1818         struct request_queue *q = bdev_get_queue(bdev);
1819         struct blk_trace *bt;
1820         ssize_t ret = -ENXIO;
1821
1822         mutex_lock(&q->debugfs_mutex);
1823
1824         bt = rcu_dereference_protected(q->blk_trace,
1825                                        lockdep_is_held(&q->debugfs_mutex));
1826         if (attr == &dev_attr_enable) {
1827                 ret = sprintf(buf, "%u\n", !!bt);
1828                 goto out_unlock_bdev;
1829         }
1830
1831         if (bt == NULL)
1832                 ret = sprintf(buf, "disabled\n");
1833         else if (attr == &dev_attr_act_mask)
1834                 ret = blk_trace_mask2str(buf, bt->act_mask);
1835         else if (attr == &dev_attr_pid)
1836                 ret = sprintf(buf, "%u\n", bt->pid);
1837         else if (attr == &dev_attr_start_lba)
1838                 ret = sprintf(buf, "%llu\n", bt->start_lba);
1839         else if (attr == &dev_attr_end_lba)
1840                 ret = sprintf(buf, "%llu\n", bt->end_lba);
1841
1842 out_unlock_bdev:
1843         mutex_unlock(&q->debugfs_mutex);
1844         return ret;
1845 }
1846
1847 static ssize_t sysfs_blk_trace_attr_store(struct device *dev,
1848                                           struct device_attribute *attr,
1849                                           const char *buf, size_t count)
1850 {
1851         struct block_device *bdev = dev_to_bdev(dev);
1852         struct request_queue *q = bdev_get_queue(bdev);
1853         struct blk_trace *bt;
1854         u64 value;
1855         ssize_t ret = -EINVAL;
1856
1857         if (count == 0)
1858                 goto out;
1859
1860         if (attr == &dev_attr_act_mask) {
1861                 if (kstrtoull(buf, 0, &value)) {
1862                         /* Assume it is a list of trace category names */
1863                         ret = blk_trace_str2mask(buf);
1864                         if (ret < 0)
1865                                 goto out;
1866                         value = ret;
1867                 }
1868         } else {
1869                 if (kstrtoull(buf, 0, &value))
1870                         goto out;
1871         }
1872
1873         mutex_lock(&q->debugfs_mutex);
1874
1875         bt = rcu_dereference_protected(q->blk_trace,
1876                                        lockdep_is_held(&q->debugfs_mutex));
1877         if (attr == &dev_attr_enable) {
1878                 if (!!value == !!bt) {
1879                         ret = 0;
1880                         goto out_unlock_bdev;
1881                 }
1882                 if (value)
1883                         ret = blk_trace_setup_queue(q, bdev);
1884                 else
1885                         ret = blk_trace_remove_queue(q);
1886                 goto out_unlock_bdev;
1887         }
1888
1889         ret = 0;
1890         if (bt == NULL) {
1891                 ret = blk_trace_setup_queue(q, bdev);
1892                 bt = rcu_dereference_protected(q->blk_trace,
1893                                 lockdep_is_held(&q->debugfs_mutex));
1894         }
1895
1896         if (ret == 0) {
1897                 if (attr == &dev_attr_act_mask)
1898                         bt->act_mask = value;
1899                 else if (attr == &dev_attr_pid)
1900                         bt->pid = value;
1901                 else if (attr == &dev_attr_start_lba)
1902                         bt->start_lba = value;
1903                 else if (attr == &dev_attr_end_lba)
1904                         bt->end_lba = value;
1905         }
1906
1907 out_unlock_bdev:
1908         mutex_unlock(&q->debugfs_mutex);
1909 out:
1910         return ret ? ret : count;
1911 }
1912
1913 int blk_trace_init_sysfs(struct device *dev)
1914 {
1915         return sysfs_create_group(&dev->kobj, &blk_trace_attr_group);
1916 }
1917
1918 void blk_trace_remove_sysfs(struct device *dev)
1919 {
1920         sysfs_remove_group(&dev->kobj, &blk_trace_attr_group);
1921 }
1922
1923 #endif /* CONFIG_BLK_DEV_IO_TRACE */
1924
1925 #ifdef CONFIG_EVENT_TRACING
1926
1927 void blk_fill_rwbs(char *rwbs, unsigned int op, int bytes)
1928 {
1929         int i = 0;
1930
1931         if (op & REQ_PREFLUSH)
1932                 rwbs[i++] = 'F';
1933
1934         switch (op & REQ_OP_MASK) {
1935         case REQ_OP_WRITE:
1936         case REQ_OP_WRITE_SAME:
1937                 rwbs[i++] = 'W';
1938                 break;
1939         case REQ_OP_DISCARD:
1940                 rwbs[i++] = 'D';
1941                 break;
1942         case REQ_OP_SECURE_ERASE:
1943                 rwbs[i++] = 'D';
1944                 rwbs[i++] = 'E';
1945                 break;
1946         case REQ_OP_FLUSH:
1947                 rwbs[i++] = 'F';
1948                 break;
1949         case REQ_OP_READ:
1950                 rwbs[i++] = 'R';
1951                 break;
1952         default:
1953                 rwbs[i++] = 'N';
1954         }
1955
1956         if (op & REQ_FUA)
1957                 rwbs[i++] = 'F';
1958         if (op & REQ_RAHEAD)
1959                 rwbs[i++] = 'A';
1960         if (op & REQ_SYNC)
1961                 rwbs[i++] = 'S';
1962         if (op & REQ_META)
1963                 rwbs[i++] = 'M';
1964
1965         rwbs[i] = '\0';
1966 }
1967 EXPORT_SYMBOL_GPL(blk_fill_rwbs);
1968
1969 #endif /* CONFIG_EVENT_TRACING */
1970