blktrace.c 42.7 KB
Newer Older
1
/*
2
 * Copyright (C) 2006 Jens Axboe <axboe@kernel.dk>
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 */
#include <linux/kernel.h>
#include <linux/blkdev.h>
#include <linux/blktrace_api.h>
#include <linux/percpu.h>
#include <linux/init.h>
#include <linux/mutex.h>
24
#include <linux/slab.h>
25
#include <linux/debugfs.h>
26
#include <linux/export.h>
27
#include <linux/time.h>
28
#include <linux/uaccess.h>
29
#include <linux/list.h>
30 31 32

#include <trace/events/block.h>

33
#include "trace_output.h"
34

35 36
#ifdef CONFIG_BLK_DEV_IO_TRACE

37 38
static unsigned int blktrace_seq __read_mostly = 1;

39
static struct trace_array *blk_tr;
40
static bool blk_tracer_enabled __read_mostly;
41

42 43 44
static LIST_HEAD(running_trace_list);
static __cacheline_aligned_in_smp DEFINE_SPINLOCK(running_trace_lock);

45
/* Select an alternative, minimalistic output than the original one */
46
#define TRACE_BLK_OPT_CLASSIC	0x1
47 48 49

static struct tracer_opt blk_tracer_opts[] = {
	/* Default disable the minimalistic output */
50
	{ TRACER_OPT(blk_classic, TRACE_BLK_OPT_CLASSIC) },
51 52 53 54 55 56 57 58
	{ }
};

static struct tracer_flags blk_tracer_flags = {
	.val  = 0,
	.opts = blk_tracer_opts,
};

59 60 61
/* Global reference count of probes */
static atomic_t blk_probes_ref = ATOMIC_INIT(0);

L
Li Zefan 已提交
62
static void blk_register_tracepoints(void);
63 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,
		       const void *data, size_t len)
70 71
{
	struct blk_io_trace *t;
72
	struct ring_buffer_event *event = NULL;
73
	struct ring_buffer *buffer = NULL;
74 75 76 77 78
	int pc = 0;
	int cpu = smp_processor_id();
	bool blk_tracer = blk_tracer_enabled;

	if (blk_tracer) {
79
		buffer = blk_tr->trace_buffer.buffer;
80
		pc = preempt_count();
81
		event = trace_buffer_lock_reserve(buffer, TRACE_BLK,
82 83 84 85 86 87 88
						  sizeof(*t) + len,
						  0, pc);
		if (!event)
			return;
		t = ring_buffer_event_data(event);
		goto record_it;
	}
89

90 91 92
	if (!bt->rchan)
		return;

93
	t = relay_reserve(bt->rchan, sizeof(*t) + len);
94 95
	if (t) {
		t->magic = BLK_IO_TRACE_MAGIC | BLK_IO_TRACE_VERSION;
I
Ingo Molnar 已提交
96
		t->time = ktime_to_ns(ktime_get());
97
record_it:
98 99 100 101 102 103
		t->device = bt->dev;
		t->action = action;
		t->pid = pid;
		t->cpu = cpu;
		t->pdu_len = len;
		memcpy((void *) t + sizeof(*t), data, len);
104 105

		if (blk_tracer)
106
			trace_buffer_unlock_commit(buffer, event, 0, pc);
107
	}
108 109
}

110 111 112 113
/*
 * Send out a notify for this process, if we haven't done so since a trace
 * started
 */
114
static void trace_note_tsk(struct task_struct *tsk)
115
{
116 117 118
	unsigned long flags;
	struct blk_trace *bt;

119
	tsk->btrace_seq = blktrace_seq;
120 121 122 123 124 125
	spin_lock_irqsave(&running_trace_lock, flags);
	list_for_each_entry(bt, &running_trace_list, running_list) {
		trace_note(bt, tsk->pid, BLK_TN_PROCESS, tsk->comm,
			   sizeof(tsk->comm));
	}
	spin_unlock_irqrestore(&running_trace_lock, flags);
126
}
127

128 129 130 131 132 133 134 135 136 137 138 139 140
static void trace_note_time(struct blk_trace *bt)
{
	struct timespec now;
	unsigned long flags;
	u32 words[2];

	getnstimeofday(&now);
	words[0] = now.tv_sec;
	words[1] = now.tv_nsec;

	local_irq_save(flags);
	trace_note(bt, 0, BLK_TN_TIMESTAMP, words, sizeof(words));
	local_irq_restore(flags);
141 142
}

143 144 145 146
void __trace_note_message(struct blk_trace *bt, const char *fmt, ...)
{
	int n;
	va_list args;
147
	unsigned long flags;
148
	char *buf;
149

150 151
	if (unlikely(bt->trace_state != Blktrace_running &&
		     !blk_tracer_enabled))
152 153
		return;

154 155 156 157 158 159 160
	/*
	 * If the BLK_TC_NOTIFY action mask isn't set, don't send any note
	 * message to the trace.
	 */
	if (!(bt->act_mask & BLK_TC_NOTIFY))
		return;

161
	local_irq_save(flags);
162
	buf = this_cpu_ptr(bt->msg_data);
163
	va_start(args, fmt);
164
	n = vscnprintf(buf, BLK_TN_MAX_MSG, fmt, args);
165 166
	va_end(args);

167
	trace_note(bt, 0, BLK_TN_MESSAGE, buf, n);
168
	local_irq_restore(flags);
169 170 171
}
EXPORT_SYMBOL_GPL(__trace_note_message);

172 173 174 175 176
static int act_log_check(struct blk_trace *bt, u32 what, sector_t sector,
			 pid_t pid)
{
	if (((bt->act_mask << BLK_TC_SHIFT) & what) == 0)
		return 1;
177
	if (sector && (sector < bt->start_lba || sector > bt->end_lba))
178 179 180 181 182 183 184 185 186 187
		return 1;
	if (bt->pid && pid != bt->pid)
		return 1;

	return 0;
}

/*
 * Data direction bit lookup
 */
L
Li Zefan 已提交
188 189
static const u32 ddir_act[2] = { BLK_TC_ACT(BLK_TC_READ),
				 BLK_TC_ACT(BLK_TC_WRITE) };
190

191 192
#define BLK_TC_RAHEAD		BLK_TC_AHEAD

193
/* The ilog2() calls fall out because they're constant */
194 195
#define MASK_TC_BIT(rw, __name) ((rw & REQ_ ## __name) << \
	  (ilog2(BLK_TC_ ## __name) + BLK_TC_SHIFT - __REQ_ ## __name))
196 197 198 199 200

/*
 * The worker for the various blk_add_trace*() types. Fills out a
 * blk_io_trace structure and places it in a per-cpu subbuffer.
 */
201
static void __blk_add_trace(struct blk_trace *bt, sector_t sector, int bytes,
202 203 204
		     int rw, u32 what, int error, int pdu_len, void *pdu_data)
{
	struct task_struct *tsk = current;
205
	struct ring_buffer_event *event = NULL;
206
	struct ring_buffer *buffer = NULL;
207
	struct blk_io_trace *t;
208
	unsigned long flags = 0;
209 210
	unsigned long *sequence;
	pid_t pid;
211
	int cpu, pc = 0;
212
	bool blk_tracer = blk_tracer_enabled;
213

214
	if (unlikely(bt->trace_state != Blktrace_running && !blk_tracer))
215 216 217
		return;

	what |= ddir_act[rw & WRITE];
218 219
	what |= MASK_TC_BIT(rw, SYNC);
	what |= MASK_TC_BIT(rw, RAHEAD);
220 221
	what |= MASK_TC_BIT(rw, META);
	what |= MASK_TC_BIT(rw, DISCARD);
N
Namhyung Kim 已提交
222 223
	what |= MASK_TC_BIT(rw, FLUSH);
	what |= MASK_TC_BIT(rw, FUA);
224 225

	pid = tsk->pid;
226
	if (act_log_check(bt, what, sector, pid))
227
		return;
228 229
	cpu = raw_smp_processor_id();

230
	if (blk_tracer) {
231 232
		tracing_record_cmdline(current);

233
		buffer = blk_tr->trace_buffer.buffer;
234
		pc = preempt_count();
235
		event = trace_buffer_lock_reserve(buffer, TRACE_BLK,
236 237
						  sizeof(*t) + pdu_len,
						  0, pc);
238 239
		if (!event)
			return;
240
		t = ring_buffer_event_data(event);
241 242
		goto record_it;
	}
243

244 245 246
	if (unlikely(tsk->btrace_seq != blktrace_seq))
		trace_note_tsk(tsk);

247 248 249
	/*
	 * A word about the locking here - we disable interrupts to reserve
	 * some space in the relay per-cpu buffer, to prevent an irq
250
	 * from coming in and stepping on our toes.
251 252 253 254 255 256 257 258
	 */
	local_irq_save(flags);
	t = relay_reserve(bt->rchan, sizeof(*t) + pdu_len);
	if (t) {
		sequence = per_cpu_ptr(bt->sequence, cpu);

		t->magic = BLK_IO_TRACE_MAGIC | BLK_IO_TRACE_VERSION;
		t->sequence = ++(*sequence);
I
Ingo Molnar 已提交
259
		t->time = ktime_to_ns(ktime_get());
260
record_it:
261
		/*
262 263 264 265 266 267 268
		 * These two are not needed in ftrace as they are in the
		 * generic trace_entry, filled by tracing_generic_entry_update,
		 * but for the trace_event->bin() synthesizer benefit we do it
		 * here too.
		 */
		t->cpu = cpu;
		t->pid = pid;
269

270 271 272 273 274 275 276 277 278
		t->sector = sector;
		t->bytes = bytes;
		t->action = what;
		t->device = bt->dev;
		t->error = error;
		t->pdu_len = pdu_len;

		if (pdu_len)
			memcpy((void *) t + sizeof(*t), pdu_data, pdu_len);
279

280
		if (blk_tracer) {
281
			trace_buffer_unlock_commit(buffer, event, 0, pc);
282 283
			return;
		}
284 285 286 287 288 289
	}

	local_irq_restore(flags);
}

static struct dentry *blk_tree_root;
290
static DEFINE_MUTEX(blk_tree_mutex);
291

292
static void blk_trace_free(struct blk_trace *bt)
293
{
294
	debugfs_remove(bt->msg_file);
295
	debugfs_remove(bt->dropped_file);
296
	relay_close(bt->rchan);
297
	debugfs_remove(bt->dir);
298
	free_percpu(bt->sequence);
299
	free_percpu(bt->msg_data);
300
	kfree(bt);
301 302 303 304 305
}

static void blk_trace_cleanup(struct blk_trace *bt)
{
	blk_trace_free(bt);
306 307
	if (atomic_dec_and_test(&blk_probes_ref))
		blk_unregister_tracepoints();
308 309
}

310
int blk_trace_remove(struct request_queue *q)
311 312 313 314 315 316 317
{
	struct blk_trace *bt;

	bt = xchg(&q->blk_trace, NULL);
	if (!bt)
		return -EINVAL;

L
Li Zefan 已提交
318
	if (bt->trace_state != Blktrace_running)
319 320 321 322
		blk_trace_cleanup(bt);

	return 0;
}
323
EXPORT_SYMBOL_GPL(blk_trace_remove);
324 325 326 327 328 329 330 331 332 333 334 335

static ssize_t blk_dropped_read(struct file *filp, char __user *buffer,
				size_t count, loff_t *ppos)
{
	struct blk_trace *bt = filp->private_data;
	char buf[16];

	snprintf(buf, sizeof(buf), "%u\n", atomic_read(&bt->dropped));

	return simple_read_from_buffer(buffer, count, ppos, buf, strlen(buf));
}

336
static const struct file_operations blk_dropped_fops = {
337
	.owner =	THIS_MODULE,
338
	.open =		simple_open,
339
	.read =		blk_dropped_read,
340
	.llseek =	default_llseek,
341 342
};

343 344 345 346 347 348
static ssize_t blk_msg_write(struct file *filp, const char __user *buffer,
				size_t count, loff_t *ppos)
{
	char *msg;
	struct blk_trace *bt;

349
	if (count >= BLK_TN_MAX_MSG)
350 351
		return -EINVAL;

352
	msg = kmalloc(count + 1, GFP_KERNEL);
353 354 355 356 357 358 359 360
	if (msg == NULL)
		return -ENOMEM;

	if (copy_from_user(msg, buffer, count)) {
		kfree(msg);
		return -EFAULT;
	}

361
	msg[count] = '\0';
362 363 364 365 366 367 368 369 370
	bt = filp->private_data;
	__trace_note_message(bt, "%s", msg);
	kfree(msg);

	return count;
}

static const struct file_operations blk_msg_fops = {
	.owner =	THIS_MODULE,
371
	.open =		simple_open,
372
	.write =	blk_msg_write,
373
	.llseek =	noop_llseek,
374 375
};

376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395
/*
 * Keep track of how many times we encountered a full subbuffer, to aid
 * the user space app in telling how many lost events there were.
 */
static int blk_subbuf_start_callback(struct rchan_buf *buf, void *subbuf,
				     void *prev_subbuf, size_t prev_padding)
{
	struct blk_trace *bt;

	if (!relay_buf_full(buf))
		return 1;

	bt = buf->chan->private_data;
	atomic_inc(&bt->dropped);
	return 0;
}

static int blk_remove_buf_file_callback(struct dentry *dentry)
{
	debugfs_remove(dentry);
396

397 398 399 400 401
	return 0;
}

static struct dentry *blk_create_buf_file_callback(const char *filename,
						   struct dentry *parent,
A
Al Viro 已提交
402
						   umode_t mode,
403 404 405 406 407 408 409 410 411 412 413 414 415
						   struct rchan_buf *buf,
						   int *is_global)
{
	return debugfs_create_file(filename, mode, parent, buf,
					&relay_file_operations);
}

static struct rchan_callbacks blk_relay_callbacks = {
	.subbuf_start		= blk_subbuf_start_callback,
	.create_buf_file	= blk_create_buf_file_callback,
	.remove_buf_file	= blk_remove_buf_file_callback,
};

416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432
static void blk_trace_setup_lba(struct blk_trace *bt,
				struct block_device *bdev)
{
	struct hd_struct *part = NULL;

	if (bdev)
		part = bdev->bd_part;

	if (part) {
		bt->start_lba = part->start_sect;
		bt->end_lba = part->start_sect + part->nr_sects;
	} else {
		bt->start_lba = 0;
		bt->end_lba = -1ULL;
	}
}

433 434 435
/*
 * Setup everything required to start tracing
 */
436
int do_blk_trace_setup(struct request_queue *q, char *name, dev_t dev,
437 438
		       struct block_device *bdev,
		       struct blk_user_trace_setup *buts)
439 440 441 442 443
{
	struct blk_trace *old_bt, *bt = NULL;
	struct dentry *dir = NULL;
	int ret, i;

444
	if (!buts->buf_size || !buts->buf_nr)
445 446
		return -EINVAL;

447 448
	strncpy(buts->name, name, BLKTRACE_BDEV_SIZE);
	buts->name[BLKTRACE_BDEV_SIZE - 1] = '\0';
449 450 451 452 453

	/*
	 * some device names have larger paths - convert the slashes
	 * to underscores for this to work as expected
	 */
454 455 456
	for (i = 0; i < strlen(buts->name); i++)
		if (buts->name[i] == '/')
			buts->name[i] = '_';
457 458 459

	bt = kzalloc(sizeof(*bt), GFP_KERNEL);
	if (!bt)
460
		return -ENOMEM;
461

462
	ret = -ENOMEM;
463 464 465 466
	bt->sequence = alloc_percpu(unsigned long);
	if (!bt->sequence)
		goto err;

467
	bt->msg_data = __alloc_percpu(BLK_TN_MAX_MSG, __alignof__(char));
468 469 470
	if (!bt->msg_data)
		goto err;

471
	ret = -ENOENT;
472

473
	mutex_lock(&blk_tree_mutex);
474 475
	if (!blk_tree_root) {
		blk_tree_root = debugfs_create_dir("block", NULL);
476 477
		if (!blk_tree_root) {
			mutex_unlock(&blk_tree_mutex);
L
Li Zefan 已提交
478
			goto err;
479
		}
480
	}
481
	mutex_unlock(&blk_tree_mutex);
482 483 484

	dir = debugfs_create_dir(buts->name, blk_tree_root);

485 486 487 488
	if (!dir)
		goto err;

	bt->dir = dir;
489
	bt->dev = dev;
490
	atomic_set(&bt->dropped, 0);
491
	INIT_LIST_HEAD(&bt->running_list);
492 493

	ret = -EIO;
494 495
	bt->dropped_file = debugfs_create_file("dropped", 0444, dir, bt,
					       &blk_dropped_fops);
496 497 498
	if (!bt->dropped_file)
		goto err;

499 500 501 502
	bt->msg_file = debugfs_create_file("msg", 0222, dir, bt, &blk_msg_fops);
	if (!bt->msg_file)
		goto err;

503 504
	bt->rchan = relay_open("trace", dir, buts->buf_size,
				buts->buf_nr, &blk_relay_callbacks, bt);
505 506 507
	if (!bt->rchan)
		goto err;

508
	bt->act_mask = buts->act_mask;
509 510 511
	if (!bt->act_mask)
		bt->act_mask = (u16) -1;

512
	blk_trace_setup_lba(bt, bdev);
513

514 515 516 517 518 519
	/* overwrite with user settings */
	if (buts->start_lba)
		bt->start_lba = buts->start_lba;
	if (buts->end_lba)
		bt->end_lba = buts->end_lba;

520
	bt->pid = buts->pid;
521 522 523 524 525 526 527 528 529
	bt->trace_state = Blktrace_setup;

	ret = -EBUSY;
	old_bt = xchg(&q->blk_trace, bt);
	if (old_bt) {
		(void) xchg(&q->blk_trace, old_bt);
		goto err;
	}

L
Li Zefan 已提交
530
	if (atomic_inc_return(&blk_probes_ref) == 1)
531 532
		blk_register_tracepoints();

533 534
	return 0;
err:
535
	blk_trace_free(bt);
536 537
	return ret;
}
538

539
int blk_trace_setup(struct request_queue *q, char *name, dev_t dev,
540
		    struct block_device *bdev,
541
		    char __user *arg)
542 543 544 545 546 547 548 549
{
	struct blk_user_trace_setup buts;
	int ret;

	ret = copy_from_user(&buts, arg, sizeof(buts));
	if (ret)
		return -EFAULT;

550
	ret = do_blk_trace_setup(q, name, dev, bdev, &buts);
551 552 553
	if (ret)
		return ret;

554 555
	if (copy_to_user(arg, &buts, sizeof(buts))) {
		blk_trace_remove(q);
556
		return -EFAULT;
557
	}
558 559
	return 0;
}
560
EXPORT_SYMBOL_GPL(blk_trace_setup);
561

562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586
#if defined(CONFIG_COMPAT) && defined(CONFIG_X86_64)
static int compat_blk_trace_setup(struct request_queue *q, char *name,
				  dev_t dev, struct block_device *bdev,
				  char __user *arg)
{
	struct blk_user_trace_setup buts;
	struct compat_blk_user_trace_setup cbuts;
	int ret;

	if (copy_from_user(&cbuts, arg, sizeof(cbuts)))
		return -EFAULT;

	buts = (struct blk_user_trace_setup) {
		.act_mask = cbuts.act_mask,
		.buf_size = cbuts.buf_size,
		.buf_nr = cbuts.buf_nr,
		.start_lba = cbuts.start_lba,
		.end_lba = cbuts.end_lba,
		.pid = cbuts.pid,
	};

	ret = do_blk_trace_setup(q, name, dev, bdev, &buts);
	if (ret)
		return ret;

587
	if (copy_to_user(arg, &buts.name, ARRAY_SIZE(buts.name))) {
588 589 590 591 592 593 594 595
		blk_trace_remove(q);
		return -EFAULT;
	}

	return 0;
}
#endif

596
int blk_trace_startstop(struct request_queue *q, int start)
597 598
{
	int ret;
599
	struct blk_trace *bt = q->blk_trace;
600

601
	if (bt == NULL)
602 603 604 605 606 607 608 609 610 611 612 613 614
		return -EINVAL;

	/*
	 * For starting a trace, we can transition from a setup or stopped
	 * trace. For stopping a trace, the state must be running
	 */
	ret = -EINVAL;
	if (start) {
		if (bt->trace_state == Blktrace_setup ||
		    bt->trace_state == Blktrace_stopped) {
			blktrace_seq++;
			smp_mb();
			bt->trace_state = Blktrace_running;
615 616 617
			spin_lock_irq(&running_trace_lock);
			list_add(&bt->running_list, &running_trace_list);
			spin_unlock_irq(&running_trace_lock);
618 619

			trace_note_time(bt);
620 621 622 623 624
			ret = 0;
		}
	} else {
		if (bt->trace_state == Blktrace_running) {
			bt->trace_state = Blktrace_stopped;
625 626 627
			spin_lock_irq(&running_trace_lock);
			list_del_init(&bt->running_list);
			spin_unlock_irq(&running_trace_lock);
628 629 630 631 632 633 634
			relay_flush(bt->rchan);
			ret = 0;
		}
	}

	return ret;
}
635
EXPORT_SYMBOL_GPL(blk_trace_startstop);
636 637 638 639

/**
 * blk_trace_ioctl: - handle the ioctls associated with tracing
 * @bdev:	the block device
640
 * @cmd:	the ioctl cmd
641 642 643 644 645
 * @arg:	the argument data, if any
 *
 **/
int blk_trace_ioctl(struct block_device *bdev, unsigned cmd, char __user *arg)
{
646
	struct request_queue *q;
647
	int ret, start = 0;
648
	char b[BDEVNAME_SIZE];
649 650 651 652 653 654 655 656 657

	q = bdev_get_queue(bdev);
	if (!q)
		return -ENXIO;

	mutex_lock(&bdev->bd_mutex);

	switch (cmd) {
	case BLKTRACESETUP:
J
Jean Delvare 已提交
658
		bdevname(bdev, b);
659
		ret = blk_trace_setup(q, b, bdev->bd_dev, bdev, arg);
660
		break;
661 662 663 664 665 666
#if defined(CONFIG_COMPAT) && defined(CONFIG_X86_64)
	case BLKTRACESETUP32:
		bdevname(bdev, b);
		ret = compat_blk_trace_setup(q, b, bdev->bd_dev, bdev, arg);
		break;
#endif
667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688
	case BLKTRACESTART:
		start = 1;
	case BLKTRACESTOP:
		ret = blk_trace_startstop(q, start);
		break;
	case BLKTRACETEARDOWN:
		ret = blk_trace_remove(q);
		break;
	default:
		ret = -ENOTTY;
		break;
	}

	mutex_unlock(&bdev->bd_mutex);
	return ret;
}

/**
 * blk_trace_shutdown: - stop and cleanup trace structures
 * @q:    the request queue associated with the device
 *
 **/
689
void blk_trace_shutdown(struct request_queue *q)
690
{
691 692 693 694
	if (q->blk_trace) {
		blk_trace_startstop(q, 0);
		blk_trace_remove(q);
	}
695
}
696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711

/*
 * blktrace probes
 */

/**
 * blk_add_trace_rq - Add a trace for a request oriented action
 * @q:		queue the io is for
 * @rq:		the source request
 * @what:	the action
 *
 * Description:
 *     Records an action against a request. Will log the bio offset + size.
 *
 **/
static void blk_add_trace_rq(struct request_queue *q, struct request *rq,
712
			     u32 what)
713 714 715 716 717 718
{
	struct blk_trace *bt = q->blk_trace;

	if (likely(!bt))
		return;

719
	if (rq->cmd_type == REQ_TYPE_BLOCK_PC) {
720
		what |= BLK_TC_ACT(BLK_TC_PC);
721
		__blk_add_trace(bt, 0, blk_rq_bytes(rq), rq->cmd_flags,
722
				what, rq->errors, rq->cmd_len, rq->cmd);
723 724
	} else  {
		what |= BLK_TC_ACT(BLK_TC_FS);
725 726
		__blk_add_trace(bt, blk_rq_pos(rq), blk_rq_bytes(rq),
				rq->cmd_flags, what, rq->errors, 0, NULL);
727 728 729
	}
}

730 731
static void blk_add_trace_rq_abort(void *ignore,
				   struct request_queue *q, struct request *rq)
732 733 734 735
{
	blk_add_trace_rq(q, rq, BLK_TA_ABORT);
}

736 737
static void blk_add_trace_rq_insert(void *ignore,
				    struct request_queue *q, struct request *rq)
738 739 740 741
{
	blk_add_trace_rq(q, rq, BLK_TA_INSERT);
}

742 743
static void blk_add_trace_rq_issue(void *ignore,
				   struct request_queue *q, struct request *rq)
744 745 746 747
{
	blk_add_trace_rq(q, rq, BLK_TA_ISSUE);
}

748 749
static void blk_add_trace_rq_requeue(void *ignore,
				     struct request_queue *q,
750
				     struct request *rq)
751 752 753 754
{
	blk_add_trace_rq(q, rq, BLK_TA_REQUEUE);
}

755 756
static void blk_add_trace_rq_complete(void *ignore,
				      struct request_queue *q,
757
				      struct request *rq)
758 759 760 761 762 763 764 765 766
{
	blk_add_trace_rq(q, rq, BLK_TA_COMPLETE);
}

/**
 * blk_add_trace_bio - Add a trace for a bio oriented action
 * @q:		queue the io is for
 * @bio:	the source bio
 * @what:	the action
767
 * @error:	error, if any
768 769 770 771 772 773
 *
 * Description:
 *     Records an action against a bio. Will log the bio offset + size.
 *
 **/
static void blk_add_trace_bio(struct request_queue *q, struct bio *bio,
774
			      u32 what, int error)
775 776 777 778 779 780
{
	struct blk_trace *bt = q->blk_trace;

	if (likely(!bt))
		return;

781 782 783
	if (!error && !bio_flagged(bio, BIO_UPTODATE))
		error = EIO;

784 785
	__blk_add_trace(bt, bio->bi_iter.bi_sector, bio->bi_iter.bi_size,
			bio->bi_rw, what, error, 0, NULL);
786 787
}

788 789
static void blk_add_trace_bio_bounce(void *ignore,
				     struct request_queue *q, struct bio *bio)
790
{
791
	blk_add_trace_bio(q, bio, BLK_TA_BOUNCE, 0);
792 793
}

794 795 796
static void blk_add_trace_bio_complete(void *ignore,
				       struct request_queue *q, struct bio *bio,
				       int error)
797
{
798
	blk_add_trace_bio(q, bio, BLK_TA_COMPLETE, error);
799 800
}

801 802
static void blk_add_trace_bio_backmerge(void *ignore,
					struct request_queue *q,
803
					struct request *rq,
804
					struct bio *bio)
805
{
806
	blk_add_trace_bio(q, bio, BLK_TA_BACKMERGE, 0);
807 808
}

809 810
static void blk_add_trace_bio_frontmerge(void *ignore,
					 struct request_queue *q,
811
					 struct request *rq,
812
					 struct bio *bio)
813
{
814
	blk_add_trace_bio(q, bio, BLK_TA_FRONTMERGE, 0);
815 816
}

817 818
static void blk_add_trace_bio_queue(void *ignore,
				    struct request_queue *q, struct bio *bio)
819
{
820
	blk_add_trace_bio(q, bio, BLK_TA_QUEUE, 0);
821 822
}

823 824
static void blk_add_trace_getrq(void *ignore,
				struct request_queue *q,
825
				struct bio *bio, int rw)
826 827
{
	if (bio)
828
		blk_add_trace_bio(q, bio, BLK_TA_GETRQ, 0);
829 830 831 832 833 834 835 836 837
	else {
		struct blk_trace *bt = q->blk_trace;

		if (bt)
			__blk_add_trace(bt, 0, 0, rw, BLK_TA_GETRQ, 0, 0, NULL);
	}
}


838 839
static void blk_add_trace_sleeprq(void *ignore,
				  struct request_queue *q,
840
				  struct bio *bio, int rw)
841 842
{
	if (bio)
843
		blk_add_trace_bio(q, bio, BLK_TA_SLEEPRQ, 0);
844 845 846 847
	else {
		struct blk_trace *bt = q->blk_trace;

		if (bt)
848 849
			__blk_add_trace(bt, 0, 0, rw, BLK_TA_SLEEPRQ,
					0, 0, NULL);
850 851 852
	}
}

853
static void blk_add_trace_plug(void *ignore, struct request_queue *q)
854 855 856 857 858 859 860
{
	struct blk_trace *bt = q->blk_trace;

	if (bt)
		__blk_add_trace(bt, 0, 0, 0, BLK_TA_PLUG, 0, 0, NULL);
}

861 862
static void blk_add_trace_unplug(void *ignore, struct request_queue *q,
				    unsigned int depth, bool explicit)
863 864 865 866
{
	struct blk_trace *bt = q->blk_trace;

	if (bt) {
867
		__be64 rpdu = cpu_to_be64(depth);
868
		u32 what;
869

870 871 872 873 874 875
		if (explicit)
			what = BLK_TA_UNPLUG_IO;
		else
			what = BLK_TA_UNPLUG_TIMER;

		__blk_add_trace(bt, 0, 0, 0, what, 0, sizeof(rpdu), &rpdu);
876 877 878
	}
}

879 880
static void blk_add_trace_split(void *ignore,
				struct request_queue *q, struct bio *bio,
881 882 883 884 885 886 887
				unsigned int pdu)
{
	struct blk_trace *bt = q->blk_trace;

	if (bt) {
		__be64 rpdu = cpu_to_be64(pdu);

888 889 890
		__blk_add_trace(bt, bio->bi_iter.bi_sector,
				bio->bi_iter.bi_size, bio->bi_rw, BLK_TA_SPLIT,
				!bio_flagged(bio, BIO_UPTODATE),
891 892 893 894 895
				sizeof(rpdu), &rpdu);
	}
}

/**
896
 * blk_add_trace_bio_remap - Add a trace for a bio-remap operation
897
 * @ignore:	trace callback data parameter (not used)
898 899 900
 * @q:		queue the io is for
 * @bio:	the source bio
 * @dev:	target device
A
Alan D. Brunelle 已提交
901
 * @from:	source sector
902 903 904 905 906 907
 *
 * Description:
 *     Device mapper or raid target sometimes need to split a bio because
 *     it spans a stripe (or similar). Add a trace for that action.
 *
 **/
908 909 910
static void blk_add_trace_bio_remap(void *ignore,
				    struct request_queue *q, struct bio *bio,
				    dev_t dev, sector_t from)
911 912 913 914 915 916 917
{
	struct blk_trace *bt = q->blk_trace;
	struct blk_io_trace_remap r;

	if (likely(!bt))
		return;

A
Alan D. Brunelle 已提交
918 919 920
	r.device_from = cpu_to_be32(dev);
	r.device_to   = cpu_to_be32(bio->bi_bdev->bd_dev);
	r.sector_from = cpu_to_be64(from);
921

922 923 924
	__blk_add_trace(bt, bio->bi_iter.bi_sector, bio->bi_iter.bi_size,
			bio->bi_rw, BLK_TA_REMAP,
			!bio_flagged(bio, BIO_UPTODATE), sizeof(r), &r);
925 926
}

927 928
/**
 * blk_add_trace_rq_remap - Add a trace for a request-remap operation
929
 * @ignore:	trace callback data parameter (not used)
930 931 932 933 934 935 936 937 938 939
 * @q:		queue the io is for
 * @rq:		the source request
 * @dev:	target device
 * @from:	source sector
 *
 * Description:
 *     Device mapper remaps request to other devices.
 *     Add a trace for that action.
 *
 **/
940 941
static void blk_add_trace_rq_remap(void *ignore,
				   struct request_queue *q,
942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959
				   struct request *rq, dev_t dev,
				   sector_t from)
{
	struct blk_trace *bt = q->blk_trace;
	struct blk_io_trace_remap r;

	if (likely(!bt))
		return;

	r.device_from = cpu_to_be32(dev);
	r.device_to   = cpu_to_be32(disk_devt(rq->rq_disk));
	r.sector_from = cpu_to_be64(from);

	__blk_add_trace(bt, blk_rq_pos(rq), blk_rq_bytes(rq),
			rq_data_dir(rq), BLK_TA_REMAP, !!rq->errors,
			sizeof(r), &r);
}

960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979
/**
 * blk_add_driver_data - Add binary message with driver-specific data
 * @q:		queue the io is for
 * @rq:		io request
 * @data:	driver-specific data
 * @len:	length of driver-specific data
 *
 * Description:
 *     Some drivers might want to write driver-specific data per request.
 *
 **/
void blk_add_driver_data(struct request_queue *q,
			 struct request *rq,
			 void *data, size_t len)
{
	struct blk_trace *bt = q->blk_trace;

	if (likely(!bt))
		return;

980
	if (rq->cmd_type == REQ_TYPE_BLOCK_PC)
981 982
		__blk_add_trace(bt, 0, blk_rq_bytes(rq), 0,
				BLK_TA_DRV_DATA, rq->errors, len, data);
983
	else
984 985
		__blk_add_trace(bt, blk_rq_pos(rq), blk_rq_bytes(rq), 0,
				BLK_TA_DRV_DATA, rq->errors, len, data);
986 987 988
}
EXPORT_SYMBOL_GPL(blk_add_driver_data);

L
Li Zefan 已提交
989
static void blk_register_tracepoints(void)
990 991 992
{
	int ret;

993
	ret = register_trace_block_rq_abort(blk_add_trace_rq_abort, NULL);
994
	WARN_ON(ret);
995
	ret = register_trace_block_rq_insert(blk_add_trace_rq_insert, NULL);
996
	WARN_ON(ret);
997
	ret = register_trace_block_rq_issue(blk_add_trace_rq_issue, NULL);
998
	WARN_ON(ret);
999
	ret = register_trace_block_rq_requeue(blk_add_trace_rq_requeue, NULL);
1000
	WARN_ON(ret);
1001
	ret = register_trace_block_rq_complete(blk_add_trace_rq_complete, NULL);
1002
	WARN_ON(ret);
1003
	ret = register_trace_block_bio_bounce(blk_add_trace_bio_bounce, NULL);
1004
	WARN_ON(ret);
1005
	ret = register_trace_block_bio_complete(blk_add_trace_bio_complete, NULL);
1006
	WARN_ON(ret);
1007
	ret = register_trace_block_bio_backmerge(blk_add_trace_bio_backmerge, NULL);
1008
	WARN_ON(ret);
1009
	ret = register_trace_block_bio_frontmerge(blk_add_trace_bio_frontmerge, NULL);
1010
	WARN_ON(ret);
1011
	ret = register_trace_block_bio_queue(blk_add_trace_bio_queue, NULL);
1012
	WARN_ON(ret);
1013
	ret = register_trace_block_getrq(blk_add_trace_getrq, NULL);
1014
	WARN_ON(ret);
1015
	ret = register_trace_block_sleeprq(blk_add_trace_sleeprq, NULL);
1016
	WARN_ON(ret);
1017
	ret = register_trace_block_plug(blk_add_trace_plug, NULL);
1018
	WARN_ON(ret);
1019
	ret = register_trace_block_unplug(blk_add_trace_unplug, NULL);
1020
	WARN_ON(ret);
1021
	ret = register_trace_block_split(blk_add_trace_split, NULL);
1022
	WARN_ON(ret);
1023
	ret = register_trace_block_bio_remap(blk_add_trace_bio_remap, NULL);
1024
	WARN_ON(ret);
1025
	ret = register_trace_block_rq_remap(blk_add_trace_rq_remap, NULL);
1026
	WARN_ON(ret);
1027 1028 1029 1030
}

static void blk_unregister_tracepoints(void)
{
1031
	unregister_trace_block_rq_remap(blk_add_trace_rq_remap, NULL);
1032
	unregister_trace_block_bio_remap(blk_add_trace_bio_remap, NULL);
1033
	unregister_trace_block_split(blk_add_trace_split, NULL);
1034
	unregister_trace_block_unplug(blk_add_trace_unplug, NULL);
1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047
	unregister_trace_block_plug(blk_add_trace_plug, NULL);
	unregister_trace_block_sleeprq(blk_add_trace_sleeprq, NULL);
	unregister_trace_block_getrq(blk_add_trace_getrq, NULL);
	unregister_trace_block_bio_queue(blk_add_trace_bio_queue, NULL);
	unregister_trace_block_bio_frontmerge(blk_add_trace_bio_frontmerge, NULL);
	unregister_trace_block_bio_backmerge(blk_add_trace_bio_backmerge, NULL);
	unregister_trace_block_bio_complete(blk_add_trace_bio_complete, NULL);
	unregister_trace_block_bio_bounce(blk_add_trace_bio_bounce, NULL);
	unregister_trace_block_rq_complete(blk_add_trace_rq_complete, NULL);
	unregister_trace_block_rq_requeue(blk_add_trace_rq_requeue, NULL);
	unregister_trace_block_rq_issue(blk_add_trace_rq_issue, NULL);
	unregister_trace_block_rq_insert(blk_add_trace_rq_insert, NULL);
	unregister_trace_block_rq_abort(blk_add_trace_rq_abort, NULL);
1048 1049 1050

	tracepoint_synchronize_unregister();
}
1051 1052 1053 1054 1055 1056 1057

/*
 * struct blk_io_tracer formatting routines
 */

static void fill_rwbs(char *rwbs, const struct blk_io_trace *t)
{
1058
	int i = 0;
1059
	int tc = t->action >> BLK_TC_SHIFT;
1060

1061 1062 1063 1064 1065
	if (t->action == BLK_TN_MESSAGE) {
		rwbs[i++] = 'N';
		goto out;
	}

N
Namhyung Kim 已提交
1066 1067 1068
	if (tc & BLK_TC_FLUSH)
		rwbs[i++] = 'F';

1069
	if (tc & BLK_TC_DISCARD)
1070
		rwbs[i++] = 'D';
1071
	else if (tc & BLK_TC_WRITE)
1072 1073 1074 1075 1076 1077
		rwbs[i++] = 'W';
	else if (t->bytes)
		rwbs[i++] = 'R';
	else
		rwbs[i++] = 'N';

N
Namhyung Kim 已提交
1078 1079
	if (tc & BLK_TC_FUA)
		rwbs[i++] = 'F';
1080
	if (tc & BLK_TC_AHEAD)
1081
		rwbs[i++] = 'A';
1082
	if (tc & BLK_TC_SYNC)
1083
		rwbs[i++] = 'S';
1084
	if (tc & BLK_TC_META)
1085
		rwbs[i++] = 'M';
1086
out:
1087
	rwbs[i] = '\0';
1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100
}

static inline
const struct blk_io_trace *te_blk_io_trace(const struct trace_entry *ent)
{
	return (const struct blk_io_trace *)ent;
}

static inline const void *pdu_start(const struct trace_entry *ent)
{
	return te_blk_io_trace(ent) + 1;
}

1101 1102 1103 1104 1105 1106 1107 1108 1109 1110
static inline u32 t_action(const struct trace_entry *ent)
{
	return te_blk_io_trace(ent)->action;
}

static inline u32 t_bytes(const struct trace_entry *ent)
{
	return te_blk_io_trace(ent)->bytes;
}

1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122
static inline u32 t_sec(const struct trace_entry *ent)
{
	return te_blk_io_trace(ent)->bytes >> 9;
}

static inline unsigned long long t_sector(const struct trace_entry *ent)
{
	return te_blk_io_trace(ent)->sector;
}

static inline __u16 t_error(const struct trace_entry *ent)
{
L
Li Zefan 已提交
1123
	return te_blk_io_trace(ent)->error;
1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135
}

static __u64 get_pdu_int(const struct trace_entry *ent)
{
	const __u64 *val = pdu_start(ent);
	return be64_to_cpu(*val);
}

static void get_pdu_remap(const struct trace_entry *ent,
			  struct blk_io_trace_remap *r)
{
	const struct blk_io_trace_remap *__r = pdu_start(ent);
A
Alan D. Brunelle 已提交
1136
	__u64 sector_from = __r->sector_from;
1137 1138

	r->device_from = be32_to_cpu(__r->device_from);
A
Alan D. Brunelle 已提交
1139 1140
	r->device_to   = be32_to_cpu(__r->device_to);
	r->sector_from = be64_to_cpu(sector_from);
1141 1142
}

L
Li Zefan 已提交
1143 1144 1145
typedef int (blk_log_action_t) (struct trace_iterator *iter, const char *act);

static int blk_log_action_classic(struct trace_iterator *iter, const char *act)
1146
{
N
Namhyung Kim 已提交
1147
	char rwbs[RWBS_LEN];
1148 1149
	unsigned long long ts  = iter->ts;
	unsigned long nsec_rem = do_div(ts, NSEC_PER_SEC);
1150
	unsigned secs	       = (unsigned long)ts;
L
Li Zefan 已提交
1151
	const struct blk_io_trace *t = te_blk_io_trace(iter->ent);
1152 1153 1154 1155

	fill_rwbs(rwbs, t);

	return trace_seq_printf(&iter->seq,
1156
				"%3d,%-3d %2d %5d.%09lu %5u %2s %3s ",
1157
				MAJOR(t->device), MINOR(t->device), iter->cpu,
L
Li Zefan 已提交
1158
				secs, nsec_rem, iter->ent->pid, act, rwbs);
1159 1160
}

L
Li Zefan 已提交
1161
static int blk_log_action(struct trace_iterator *iter, const char *act)
1162
{
N
Namhyung Kim 已提交
1163
	char rwbs[RWBS_LEN];
L
Li Zefan 已提交
1164 1165
	const struct blk_io_trace *t = te_blk_io_trace(iter->ent);

1166
	fill_rwbs(rwbs, t);
L
Li Zefan 已提交
1167
	return trace_seq_printf(&iter->seq, "%3d,%-3d %2s %3s ",
1168 1169 1170
				MAJOR(t->device), MINOR(t->device), act, rwbs);
}

1171 1172
static int blk_log_dump_pdu(struct trace_seq *s, const struct trace_entry *ent)
{
1173
	const unsigned char *pdu_buf;
1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209
	int pdu_len;
	int i, end, ret;

	pdu_buf = pdu_start(ent);
	pdu_len = te_blk_io_trace(ent)->pdu_len;

	if (!pdu_len)
		return 1;

	/* find the last zero that needs to be printed */
	for (end = pdu_len - 1; end >= 0; end--)
		if (pdu_buf[end])
			break;
	end++;

	if (!trace_seq_putc(s, '('))
		return 0;

	for (i = 0; i < pdu_len; i++) {

		ret = trace_seq_printf(s, "%s%02x",
				       i == 0 ? "" : " ", pdu_buf[i]);
		if (!ret)
			return ret;

		/*
		 * stop when the rest is just zeroes and indicate so
		 * with a ".." appended
		 */
		if (i == end && end != pdu_len - 1)
			return trace_seq_puts(s, " ..) ");
	}

	return trace_seq_puts(s, ") ");
}

1210 1211
static int blk_log_generic(struct trace_seq *s, const struct trace_entry *ent)
{
1212 1213 1214
	char cmd[TASK_COMM_LEN];

	trace_find_cmdline(ent->pid, cmd);
1215

1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231
	if (t_action(ent) & BLK_TC_ACT(BLK_TC_PC)) {
		int ret;

		ret = trace_seq_printf(s, "%u ", t_bytes(ent));
		if (!ret)
			return 0;
		ret = blk_log_dump_pdu(s, ent);
		if (!ret)
			return 0;
		return trace_seq_printf(s, "[%s]\n", cmd);
	} else {
		if (t_sec(ent))
			return trace_seq_printf(s, "%llu + %u [%s]\n",
						t_sector(ent), t_sec(ent), cmd);
		return trace_seq_printf(s, "[%s]\n", cmd);
	}
1232 1233
}

1234 1235
static int blk_log_with_error(struct trace_seq *s,
			      const struct trace_entry *ent)
1236
{
1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251
	if (t_action(ent) & BLK_TC_ACT(BLK_TC_PC)) {
		int ret;

		ret = blk_log_dump_pdu(s, ent);
		if (ret)
			return trace_seq_printf(s, "[%d]\n", t_error(ent));
		return 0;
	} else {
		if (t_sec(ent))
			return trace_seq_printf(s, "%llu + %u [%d]\n",
						t_sector(ent),
						t_sec(ent), t_error(ent));
		return trace_seq_printf(s, "%llu [%d]\n",
					t_sector(ent), t_error(ent));
	}
1252 1253 1254 1255
}

static int blk_log_remap(struct trace_seq *s, const struct trace_entry *ent)
{
A
Alan D. Brunelle 已提交
1256
	struct blk_io_trace_remap r = { .device_from = 0, };
1257 1258 1259

	get_pdu_remap(ent, &r);
	return trace_seq_printf(s, "%llu + %u <- (%d,%d) %llu\n",
A
Alan D. Brunelle 已提交
1260 1261 1262
				t_sector(ent), t_sec(ent),
				MAJOR(r.device_from), MINOR(r.device_from),
				(unsigned long long)r.sector_from);
1263 1264 1265 1266
}

static int blk_log_plug(struct trace_seq *s, const struct trace_entry *ent)
{
1267 1268 1269 1270 1271
	char cmd[TASK_COMM_LEN];

	trace_find_cmdline(ent->pid, cmd);

	return trace_seq_printf(s, "[%s]\n", cmd);
1272 1273 1274 1275
}

static int blk_log_unplug(struct trace_seq *s, const struct trace_entry *ent)
{
1276 1277 1278 1279 1280
	char cmd[TASK_COMM_LEN];

	trace_find_cmdline(ent->pid, cmd);

	return trace_seq_printf(s, "[%s] %llu\n", cmd, get_pdu_int(ent));
1281 1282 1283 1284
}

static int blk_log_split(struct trace_seq *s, const struct trace_entry *ent)
{
1285 1286 1287 1288
	char cmd[TASK_COMM_LEN];

	trace_find_cmdline(ent->pid, cmd);

1289
	return trace_seq_printf(s, "%llu / %llu [%s]\n", t_sector(ent),
1290
				get_pdu_int(ent), cmd);
1291 1292
}

1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303
static int blk_log_msg(struct trace_seq *s, const struct trace_entry *ent)
{
	int ret;
	const struct blk_io_trace *t = te_blk_io_trace(ent);

	ret = trace_seq_putmem(s, t + 1, t->pdu_len);
	if (ret)
		return trace_seq_putc(s, '\n');
	return ret;
}

1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317
/*
 * struct tracer operations
 */

static void blk_tracer_print_header(struct seq_file *m)
{
	if (!(blk_tracer_flags.val & TRACE_BLK_OPT_CLASSIC))
		return;
	seq_puts(m, "# DEV   CPU TIMESTAMP     PID ACT FLG\n"
		    "#  |     |     |           |   |   |\n");
}

static void blk_tracer_start(struct trace_array *tr)
{
1318
	blk_tracer_enabled = true;
1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329
}

static int blk_tracer_init(struct trace_array *tr)
{
	blk_tr = tr;
	blk_tracer_start(tr);
	return 0;
}

static void blk_tracer_stop(struct trace_array *tr)
{
1330
	blk_tracer_enabled = false;
1331 1332 1333 1334 1335 1336 1337
}

static void blk_tracer_reset(struct trace_array *tr)
{
	blk_tracer_stop(tr);
}

L
Li Zefan 已提交
1338
static const struct {
1339
	const char *act[2];
1340
	int	   (*print)(struct trace_seq *s, const struct trace_entry *ent);
L
Li Zefan 已提交
1341
} what2act[] = {
1342
	[__BLK_TA_QUEUE]	= {{  "Q", "queue" },	   blk_log_generic },
1343 1344 1345 1346 1347 1348 1349 1350 1351
	[__BLK_TA_BACKMERGE]	= {{  "M", "backmerge" },  blk_log_generic },
	[__BLK_TA_FRONTMERGE]	= {{  "F", "frontmerge" }, blk_log_generic },
	[__BLK_TA_GETRQ]	= {{  "G", "getrq" },	   blk_log_generic },
	[__BLK_TA_SLEEPRQ]	= {{  "S", "sleeprq" },	   blk_log_generic },
	[__BLK_TA_REQUEUE]	= {{  "R", "requeue" },	   blk_log_with_error },
	[__BLK_TA_ISSUE]	= {{  "D", "issue" },	   blk_log_generic },
	[__BLK_TA_COMPLETE]	= {{  "C", "complete" },   blk_log_with_error },
	[__BLK_TA_PLUG]		= {{  "P", "plug" },	   blk_log_plug },
	[__BLK_TA_UNPLUG_IO]	= {{  "U", "unplug_io" },  blk_log_unplug },
1352
	[__BLK_TA_UNPLUG_TIMER]	= {{ "UT", "unplug_timer" }, blk_log_unplug },
1353 1354 1355 1356 1357 1358
	[__BLK_TA_INSERT]	= {{  "I", "insert" },	   blk_log_generic },
	[__BLK_TA_SPLIT]	= {{  "X", "split" },	   blk_log_split },
	[__BLK_TA_BOUNCE]	= {{  "B", "bounce" },	   blk_log_generic },
	[__BLK_TA_REMAP]	= {{  "A", "remap" },	   blk_log_remap },
};

L
Li Zefan 已提交
1359 1360
static enum print_line_t print_one_line(struct trace_iterator *iter,
					bool classic)
1361
{
1362
	struct trace_seq *s = &iter->seq;
L
Li Zefan 已提交
1363 1364
	const struct blk_io_trace *t;
	u16 what;
1365
	int ret;
L
Li Zefan 已提交
1366 1367
	bool long_act;
	blk_log_action_t *log_action;
1368

L
Li Zefan 已提交
1369 1370 1371 1372
	t	   = te_blk_io_trace(iter->ent);
	what	   = t->action & ((1 << BLK_TC_SHIFT) - 1);
	long_act   = !!(trace_flags & TRACE_ITER_VERBOSE);
	log_action = classic ? &blk_log_action_classic : &blk_log_action;
1373

1374 1375 1376 1377 1378 1379 1380
	if (t->action == BLK_TN_MESSAGE) {
		ret = log_action(iter, long_act ? "message" : "m");
		if (ret)
			ret = blk_log_msg(s, iter->ent);
		goto out;
	}

L
Li Zefan 已提交
1381
	if (unlikely(what == 0 || what >= ARRAY_SIZE(what2act)))
1382
		ret = trace_seq_printf(s, "Unknown action %x\n", what);
1383
	else {
L
Li Zefan 已提交
1384
		ret = log_action(iter, what2act[what].act[long_act]);
1385
		if (ret)
1386
			ret = what2act[what].print(s, iter->ent);
1387
	}
1388
out:
1389 1390 1391
	return ret ? TRACE_TYPE_HANDLED : TRACE_TYPE_PARTIAL_LINE;
}

L
Li Zefan 已提交
1392
static enum print_line_t blk_trace_event_print(struct trace_iterator *iter,
1393
					       int flags, struct trace_event *event)
L
Li Zefan 已提交
1394 1395 1396 1397
{
	return print_one_line(iter, false);
}

1398 1399 1400 1401 1402 1403 1404
static int blk_trace_synthesize_old_trace(struct trace_iterator *iter)
{
	struct trace_seq *s = &iter->seq;
	struct blk_io_trace *t = (struct blk_io_trace *)iter->ent;
	const int offset = offsetof(struct blk_io_trace, sector);
	struct blk_io_trace old = {
		.magic	  = BLK_IO_TRACE_MAGIC | BLK_IO_TRACE_VERSION,
1405
		.time     = iter->ts,
1406 1407 1408 1409 1410 1411 1412 1413
	};

	if (!trace_seq_putmem(s, &old, offset))
		return 0;
	return trace_seq_putmem(s, &t->sector,
				sizeof(old) - offset + t->pdu_len);
}

1414
static enum print_line_t
1415 1416
blk_trace_event_print_binary(struct trace_iterator *iter, int flags,
			     struct trace_event *event)
1417 1418 1419 1420 1421
{
	return blk_trace_synthesize_old_trace(iter) ?
			TRACE_TYPE_HANDLED : TRACE_TYPE_PARTIAL_LINE;
}

1422 1423 1424 1425 1426
static enum print_line_t blk_tracer_print_line(struct trace_iterator *iter)
{
	if (!(blk_tracer_flags.val & TRACE_BLK_OPT_CLASSIC))
		return TRACE_TYPE_UNHANDLED;

L
Li Zefan 已提交
1427
	return print_one_line(iter, true);
1428 1429
}

1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441
static int blk_tracer_set_flag(u32 old_flags, u32 bit, int set)
{
	/* don't output context-info for blk_classic output */
	if (bit == TRACE_BLK_OPT_CLASSIC) {
		if (set)
			trace_flags &= ~TRACE_ITER_CONTEXT_INFO;
		else
			trace_flags |= TRACE_ITER_CONTEXT_INFO;
	}
	return 0;
}

1442 1443 1444 1445 1446 1447 1448 1449 1450
static struct tracer blk_tracer __read_mostly = {
	.name		= "blk",
	.init		= blk_tracer_init,
	.reset		= blk_tracer_reset,
	.start		= blk_tracer_start,
	.stop		= blk_tracer_stop,
	.print_header	= blk_tracer_print_header,
	.print_line	= blk_tracer_print_line,
	.flags		= &blk_tracer_flags,
1451
	.set_flag	= blk_tracer_set_flag,
1452 1453
};

1454
static struct trace_event_functions trace_blk_event_funcs = {
1455
	.trace		= blk_trace_event_print,
1456
	.binary		= blk_trace_event_print_binary,
1457 1458
};

1459 1460 1461 1462 1463
static struct trace_event trace_blk_event = {
	.type		= TRACE_BLK,
	.funcs		= &trace_blk_event_funcs,
};

1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489
static int __init init_blk_tracer(void)
{
	if (!register_ftrace_event(&trace_blk_event)) {
		pr_warning("Warning: could not register block events\n");
		return 1;
	}

	if (register_tracer(&blk_tracer) != 0) {
		pr_warning("Warning: could not register the block tracer\n");
		unregister_ftrace_event(&trace_blk_event);
		return 1;
	}

	return 0;
}

device_initcall(init_blk_tracer);

static int blk_trace_remove_queue(struct request_queue *q)
{
	struct blk_trace *bt;

	bt = xchg(&q->blk_trace, NULL);
	if (bt == NULL)
		return -EINVAL;

L
Li Zefan 已提交
1490 1491 1492
	if (atomic_dec_and_test(&blk_probes_ref))
		blk_unregister_tracepoints();

1493 1494 1495
	spin_lock_irq(&running_trace_lock);
	list_del(&bt->running_list);
	spin_unlock_irq(&running_trace_lock);
1496
	blk_trace_free(bt);
1497 1498 1499 1500 1501 1502
	return 0;
}

/*
 * Setup everything required to start tracing
 */
1503 1504
static int blk_trace_setup_queue(struct request_queue *q,
				 struct block_device *bdev)
1505 1506
{
	struct blk_trace *old_bt, *bt = NULL;
1507
	int ret = -ENOMEM;
1508 1509 1510

	bt = kzalloc(sizeof(*bt), GFP_KERNEL);
	if (!bt)
L
Li Zefan 已提交
1511
		return -ENOMEM;
1512

1513 1514 1515 1516
	bt->msg_data = __alloc_percpu(BLK_TN_MAX_MSG, __alignof__(char));
	if (!bt->msg_data)
		goto free_bt;

1517
	bt->dev = bdev->bd_dev;
1518
	bt->act_mask = (u16)-1;
1519 1520

	blk_trace_setup_lba(bt, bdev);
1521 1522 1523 1524

	old_bt = xchg(&q->blk_trace, bt);
	if (old_bt != NULL) {
		(void)xchg(&q->blk_trace, old_bt);
1525 1526
		ret = -EBUSY;
		goto free_bt;
1527
	}
L
Li Zefan 已提交
1528

L
Li Zefan 已提交
1529 1530
	if (atomic_inc_return(&blk_probes_ref) == 1)
		blk_register_tracepoints();
1531
	return 0;
1532 1533 1534 1535

free_bt:
	blk_trace_free(bt);
	return ret;
1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552
}

/*
 * sysfs interface to enable and configure tracing
 */

static ssize_t sysfs_blk_trace_attr_show(struct device *dev,
					 struct device_attribute *attr,
					 char *buf);
static ssize_t sysfs_blk_trace_attr_store(struct device *dev,
					  struct device_attribute *attr,
					  const char *buf, size_t count);
#define BLK_TRACE_DEVICE_ATTR(_name) \
	DEVICE_ATTR(_name, S_IRUGO | S_IWUSR, \
		    sysfs_blk_trace_attr_show, \
		    sysfs_blk_trace_attr_store)

1553
static BLK_TRACE_DEVICE_ATTR(enable);
1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572
static BLK_TRACE_DEVICE_ATTR(act_mask);
static BLK_TRACE_DEVICE_ATTR(pid);
static BLK_TRACE_DEVICE_ATTR(start_lba);
static BLK_TRACE_DEVICE_ATTR(end_lba);

static struct attribute *blk_trace_attrs[] = {
	&dev_attr_enable.attr,
	&dev_attr_act_mask.attr,
	&dev_attr_pid.attr,
	&dev_attr_start_lba.attr,
	&dev_attr_end_lba.attr,
	NULL
};

struct attribute_group blk_trace_attr_group = {
	.name  = "trace",
	.attrs = blk_trace_attrs,
};

1573 1574 1575 1576 1577 1578
static const struct {
	int mask;
	const char *str;
} mask_maps[] = {
	{ BLK_TC_READ,		"read"		},
	{ BLK_TC_WRITE,		"write"		},
N
Namhyung Kim 已提交
1579
	{ BLK_TC_FLUSH,		"flush"		},
1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590
	{ BLK_TC_SYNC,		"sync"		},
	{ BLK_TC_QUEUE,		"queue"		},
	{ BLK_TC_REQUEUE,	"requeue"	},
	{ BLK_TC_ISSUE,		"issue"		},
	{ BLK_TC_COMPLETE,	"complete"	},
	{ BLK_TC_FS,		"fs"		},
	{ BLK_TC_PC,		"pc"		},
	{ BLK_TC_AHEAD,		"ahead"		},
	{ BLK_TC_META,		"meta"		},
	{ BLK_TC_DISCARD,	"discard"	},
	{ BLK_TC_DRV_DATA,	"drv_data"	},
N
Namhyung Kim 已提交
1591
	{ BLK_TC_FUA,		"fua"		},
1592 1593 1594
};

static int blk_trace_str2mask(const char *str)
1595
{
1596
	int i;
1597
	int mask = 0;
1598
	char *buf, *s, *token;
1599

1600 1601
	buf = kstrdup(str, GFP_KERNEL);
	if (buf == NULL)
1602
		return -ENOMEM;
1603
	s = strstrip(buf);
1604 1605

	while (1) {
1606 1607
		token = strsep(&s, ",");
		if (token == NULL)
1608 1609
			break;

1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622
		if (*token == '\0')
			continue;

		for (i = 0; i < ARRAY_SIZE(mask_maps); i++) {
			if (strcasecmp(token, mask_maps[i].str) == 0) {
				mask |= mask_maps[i].mask;
				break;
			}
		}
		if (i == ARRAY_SIZE(mask_maps)) {
			mask = -EINVAL;
			break;
		}
1623
	}
1624
	kfree(buf);
1625 1626 1627 1628

	return mask;
}

1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644
static ssize_t blk_trace_mask2str(char *buf, int mask)
{
	int i;
	char *p = buf;

	for (i = 0; i < ARRAY_SIZE(mask_maps); i++) {
		if (mask & mask_maps[i].mask) {
			p += sprintf(p, "%s%s",
				    (p == buf) ? "" : ",", mask_maps[i].str);
		}
	}
	*p++ = '\n';

	return p - buf;
}

1645 1646 1647 1648 1649 1650 1651 1652
static struct request_queue *blk_trace_get_queue(struct block_device *bdev)
{
	if (bdev->bd_disk == NULL)
		return NULL;

	return bdev_get_queue(bdev);
}

1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663
static ssize_t sysfs_blk_trace_attr_show(struct device *dev,
					 struct device_attribute *attr,
					 char *buf)
{
	struct hd_struct *p = dev_to_part(dev);
	struct request_queue *q;
	struct block_device *bdev;
	ssize_t ret = -ENXIO;

	bdev = bdget(part_devt(p));
	if (bdev == NULL)
1664
		goto out;
1665

1666
	q = blk_trace_get_queue(bdev);
1667 1668
	if (q == NULL)
		goto out_bdput;
1669

1670
	mutex_lock(&bdev->bd_mutex);
1671 1672 1673 1674 1675 1676

	if (attr == &dev_attr_enable) {
		ret = sprintf(buf, "%u\n", !!q->blk_trace);
		goto out_unlock_bdev;
	}

1677 1678 1679
	if (q->blk_trace == NULL)
		ret = sprintf(buf, "disabled\n");
	else if (attr == &dev_attr_act_mask)
1680
		ret = blk_trace_mask2str(buf, q->blk_trace->act_mask);
1681 1682 1683 1684 1685 1686
	else if (attr == &dev_attr_pid)
		ret = sprintf(buf, "%u\n", q->blk_trace->pid);
	else if (attr == &dev_attr_start_lba)
		ret = sprintf(buf, "%llu\n", q->blk_trace->start_lba);
	else if (attr == &dev_attr_end_lba)
		ret = sprintf(buf, "%llu\n", q->blk_trace->end_lba);
1687 1688

out_unlock_bdev:
1689 1690 1691
	mutex_unlock(&bdev->bd_mutex);
out_bdput:
	bdput(bdev);
1692
out:
1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703
	return ret;
}

static ssize_t sysfs_blk_trace_attr_store(struct device *dev,
					  struct device_attribute *attr,
					  const char *buf, size_t count)
{
	struct block_device *bdev;
	struct request_queue *q;
	struct hd_struct *p;
	u64 value;
1704
	ssize_t ret = -EINVAL;
1705 1706 1707 1708 1709 1710 1711

	if (count == 0)
		goto out;

	if (attr == &dev_attr_act_mask) {
		if (sscanf(buf, "%llx", &value) != 1) {
			/* Assume it is a list of trace category names */
1712 1713
			ret = blk_trace_str2mask(buf);
			if (ret < 0)
1714
				goto out;
1715
			value = ret;
1716 1717 1718 1719
		}
	} else if (sscanf(buf, "%llu", &value) != 1)
		goto out;

1720 1721
	ret = -ENXIO;

1722 1723 1724
	p = dev_to_part(dev);
	bdev = bdget(part_devt(p));
	if (bdev == NULL)
1725
		goto out;
1726

1727
	q = blk_trace_get_queue(bdev);
1728 1729 1730 1731
	if (q == NULL)
		goto out_bdput;

	mutex_lock(&bdev->bd_mutex);
1732 1733 1734

	if (attr == &dev_attr_enable) {
		if (value)
1735
			ret = blk_trace_setup_queue(q, bdev);
1736 1737 1738 1739 1740
		else
			ret = blk_trace_remove_queue(q);
		goto out_unlock_bdev;
	}

1741 1742
	ret = 0;
	if (q->blk_trace == NULL)
1743
		ret = blk_trace_setup_queue(q, bdev);
1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754

	if (ret == 0) {
		if (attr == &dev_attr_act_mask)
			q->blk_trace->act_mask = value;
		else if (attr == &dev_attr_pid)
			q->blk_trace->pid = value;
		else if (attr == &dev_attr_start_lba)
			q->blk_trace->start_lba = value;
		else if (attr == &dev_attr_end_lba)
			q->blk_trace->end_lba = value;
	}
1755 1756

out_unlock_bdev:
1757 1758 1759 1760
	mutex_unlock(&bdev->bd_mutex);
out_bdput:
	bdput(bdev);
out:
1761
	return ret ? ret : count;
1762
}
1763

1764 1765 1766 1767 1768
int blk_trace_init_sysfs(struct device *dev)
{
	return sysfs_create_group(&dev->kobj, &blk_trace_attr_group);
}

1769 1770 1771 1772 1773
void blk_trace_remove_sysfs(struct device *dev)
{
	sysfs_remove_group(&dev->kobj, &blk_trace_attr_group);
}

1774 1775 1776 1777 1778 1779 1780 1781 1782 1783
#endif /* CONFIG_BLK_DEV_IO_TRACE */

#ifdef CONFIG_EVENT_TRACING

void blk_dump_cmd(char *buf, struct request *rq)
{
	int i, end;
	int len = rq->cmd_len;
	unsigned char *cmd = rq->cmd;

1784
	if (rq->cmd_type != REQ_TYPE_BLOCK_PC) {
1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806
		buf[0] = '\0';
		return;
	}

	for (end = len - 1; end >= 0; end--)
		if (cmd[end])
			break;
	end++;

	for (i = 0; i < len; i++) {
		buf += sprintf(buf, "%s%02x", i == 0 ? "" : " ", cmd[i]);
		if (i == end && end != len - 1) {
			sprintf(buf, " ..");
			break;
		}
	}
}

void blk_fill_rwbs(char *rwbs, u32 rw, int bytes)
{
	int i = 0;

N
Namhyung Kim 已提交
1807 1808 1809
	if (rw & REQ_FLUSH)
		rwbs[i++] = 'F';

1810 1811
	if (rw & WRITE)
		rwbs[i++] = 'W';
1812
	else if (rw & REQ_DISCARD)
1813 1814 1815 1816 1817 1818
		rwbs[i++] = 'D';
	else if (bytes)
		rwbs[i++] = 'R';
	else
		rwbs[i++] = 'N';

N
Namhyung Kim 已提交
1819 1820
	if (rw & REQ_FUA)
		rwbs[i++] = 'F';
1821
	if (rw & REQ_RAHEAD)
1822
		rwbs[i++] = 'A';
1823
	if (rw & REQ_SYNC)
1824
		rwbs[i++] = 'S';
1825
	if (rw & REQ_META)
1826
		rwbs[i++] = 'M';
A
Adrian Hunter 已提交
1827 1828
	if (rw & REQ_SECURE)
		rwbs[i++] = 'E';
1829 1830 1831

	rwbs[i] = '\0';
}
K
Kent Overstreet 已提交
1832
EXPORT_SYMBOL_GPL(blk_fill_rwbs);
1833 1834 1835

#endif /* CONFIG_EVENT_TRACING */