kernel/trace/blktrace.c

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