ring_buffer.c 68.9 KB
Newer Older
S
Steven Rostedt 已提交
1 2 3 4 5 6
/*
 * Generic ring buffer
 *
 * Copyright (C) 2008 Steven Rostedt <srostedt@redhat.com>
 */
#include <linux/ring_buffer.h>
7
#include <linux/trace_clock.h>
8
#include <linux/ftrace_irq.h>
S
Steven Rostedt 已提交
9 10 11
#include <linux/spinlock.h>
#include <linux/debugfs.h>
#include <linux/uaccess.h>
12
#include <linux/hardirq.h>
S
Steven Rostedt 已提交
13 14 15 16 17 18
#include <linux/module.h>
#include <linux/percpu.h>
#include <linux/mutex.h>
#include <linux/init.h>
#include <linux/hash.h>
#include <linux/list.h>
19
#include <linux/cpu.h>
S
Steven Rostedt 已提交
20 21
#include <linux/fs.h>

22 23
#include "trace.h"

24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91
/*
 * The ring buffer is made up of a list of pages. A separate list of pages is
 * allocated for each CPU. A writer may only write to a buffer that is
 * associated with the CPU it is currently executing on.  A reader may read
 * from any per cpu buffer.
 *
 * The reader is special. For each per cpu buffer, the reader has its own
 * reader page. When a reader has read the entire reader page, this reader
 * page is swapped with another page in the ring buffer.
 *
 * Now, as long as the writer is off the reader page, the reader can do what
 * ever it wants with that page. The writer will never write to that page
 * again (as long as it is out of the ring buffer).
 *
 * Here's some silly ASCII art.
 *
 *   +------+
 *   |reader|          RING BUFFER
 *   |page  |
 *   +------+        +---+   +---+   +---+
 *                   |   |-->|   |-->|   |
 *                   +---+   +---+   +---+
 *                     ^               |
 *                     |               |
 *                     +---------------+
 *
 *
 *   +------+
 *   |reader|          RING BUFFER
 *   |page  |------------------v
 *   +------+        +---+   +---+   +---+
 *                   |   |-->|   |-->|   |
 *                   +---+   +---+   +---+
 *                     ^               |
 *                     |               |
 *                     +---------------+
 *
 *
 *   +------+
 *   |reader|          RING BUFFER
 *   |page  |------------------v
 *   +------+        +---+   +---+   +---+
 *      ^            |   |-->|   |-->|   |
 *      |            +---+   +---+   +---+
 *      |                              |
 *      |                              |
 *      +------------------------------+
 *
 *
 *   +------+
 *   |buffer|          RING BUFFER
 *   |page  |------------------v
 *   +------+        +---+   +---+   +---+
 *      ^            |   |   |   |-->|   |
 *      |   New      +---+   +---+   +---+
 *      |  Reader------^               |
 *      |   page                       |
 *      +------------------------------+
 *
 *
 * After we make this swap, the reader can hand this page off to the splice
 * code and be done with it. It can even allocate a new page if it needs to
 * and swap that into the ring buffer.
 *
 * We will be using cmpxchg soon to make all this lockless.
 *
 */

92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130
/*
 * A fast way to enable or disable all ring buffers is to
 * call tracing_on or tracing_off. Turning off the ring buffers
 * prevents all ring buffers from being recorded to.
 * Turning this switch on, makes it OK to write to the
 * ring buffer, if the ring buffer is enabled itself.
 *
 * There's three layers that must be on in order to write
 * to the ring buffer.
 *
 * 1) This global flag must be set.
 * 2) The ring buffer must be enabled for recording.
 * 3) The per cpu buffer must be enabled for recording.
 *
 * In case of an anomaly, this global flag has a bit set that
 * will permantly disable all ring buffers.
 */

/*
 * Global flag to disable all recording to ring buffers
 *  This has two bits: ON, DISABLED
 *
 *  ON   DISABLED
 * ---- ----------
 *   0      0        : ring buffers are off
 *   1      0        : ring buffers are on
 *   X      1        : ring buffers are permanently disabled
 */

enum {
	RB_BUFFERS_ON_BIT	= 0,
	RB_BUFFERS_DISABLED_BIT	= 1,
};

enum {
	RB_BUFFERS_ON		= 1 << RB_BUFFERS_ON_BIT,
	RB_BUFFERS_DISABLED	= 1 << RB_BUFFERS_DISABLED_BIT,
};

131
static unsigned long ring_buffer_flags __read_mostly = RB_BUFFERS_ON;
132

133 134
#define BUF_PAGE_HDR_SIZE offsetof(struct buffer_data_page, data)

135 136 137 138 139 140 141 142
/**
 * tracing_on - enable all tracing buffers
 *
 * This function enables all tracing buffers that may have been
 * disabled with tracing_off.
 */
void tracing_on(void)
{
143
	set_bit(RB_BUFFERS_ON_BIT, &ring_buffer_flags);
144
}
145
EXPORT_SYMBOL_GPL(tracing_on);
146 147 148 149 150 151 152 153 154 155 156

/**
 * tracing_off - turn off all tracing buffers
 *
 * This function stops all tracing buffers from recording data.
 * It does not disable any overhead the tracers themselves may
 * be causing. This function simply causes all recording to
 * the ring buffers to fail.
 */
void tracing_off(void)
{
157 158
	clear_bit(RB_BUFFERS_ON_BIT, &ring_buffer_flags);
}
159
EXPORT_SYMBOL_GPL(tracing_off);
160 161 162 163 164

/**
 * tracing_off_permanent - permanently disable ring buffers
 *
 * This function, once called, will disable all ring buffers
W
Wenji Huang 已提交
165
 * permanently.
166 167 168 169
 */
void tracing_off_permanent(void)
{
	set_bit(RB_BUFFERS_DISABLED_BIT, &ring_buffer_flags);
170 171
}

172 173 174 175 176 177 178 179 180
/**
 * tracing_is_on - show state of ring buffers enabled
 */
int tracing_is_on(void)
{
	return ring_buffer_flags == RB_BUFFERS_ON;
}
EXPORT_SYMBOL_GPL(tracing_is_on);

181 182
#include "trace.h"

183
#define RB_EVNT_HDR_SIZE (offsetof(struct ring_buffer_event, array))
184
#define RB_ALIGNMENT		4U
S
Steven Rostedt 已提交
185 186 187 188 189 190 191 192
#define RB_MAX_SMALL_DATA	28

enum {
	RB_LEN_TIME_EXTEND = 8,
	RB_LEN_TIME_STAMP = 16,
};

/* inline for ring buffer fast paths */
193
static unsigned
S
Steven Rostedt 已提交
194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210
rb_event_length(struct ring_buffer_event *event)
{
	unsigned length;

	switch (event->type) {
	case RINGBUF_TYPE_PADDING:
		/* undefined */
		return -1;

	case RINGBUF_TYPE_TIME_EXTEND:
		return RB_LEN_TIME_EXTEND;

	case RINGBUF_TYPE_TIME_STAMP:
		return RB_LEN_TIME_STAMP;

	case RINGBUF_TYPE_DATA:
		if (event->len)
211
			length = event->len * RB_ALIGNMENT;
S
Steven Rostedt 已提交
212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227
		else
			length = event->array[0];
		return length + RB_EVNT_HDR_SIZE;
	default:
		BUG();
	}
	/* not hit */
	return 0;
}

/**
 * ring_buffer_event_length - return the length of the event
 * @event: the event to get the length of
 */
unsigned ring_buffer_event_length(struct ring_buffer_event *event)
{
228 229 230 231 232 233 234
	unsigned length = rb_event_length(event);
	if (event->type != RINGBUF_TYPE_DATA)
		return length;
	length -= RB_EVNT_HDR_SIZE;
	if (length > RB_MAX_SMALL_DATA + sizeof(event->array[0]))
                length -= sizeof(event->array[0]);
	return length;
S
Steven Rostedt 已提交
235
}
236
EXPORT_SYMBOL_GPL(ring_buffer_event_length);
S
Steven Rostedt 已提交
237 238

/* inline for ring buffer fast paths */
239
static void *
S
Steven Rostedt 已提交
240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257
rb_event_data(struct ring_buffer_event *event)
{
	BUG_ON(event->type != RINGBUF_TYPE_DATA);
	/* If length is in len field, then array[0] has the data */
	if (event->len)
		return (void *)&event->array[0];
	/* Otherwise length is in array[0] and array[1] has the data */
	return (void *)&event->array[1];
}

/**
 * ring_buffer_event_data - return the data of the event
 * @event: the event to get the data from
 */
void *ring_buffer_event_data(struct ring_buffer_event *event)
{
	return rb_event_data(event);
}
258
EXPORT_SYMBOL_GPL(ring_buffer_event_data);
S
Steven Rostedt 已提交
259 260

#define for_each_buffer_cpu(buffer, cpu)		\
261
	for_each_cpu(cpu, buffer->cpumask)
S
Steven Rostedt 已提交
262 263 264 265 266

#define TS_SHIFT	27
#define TS_MASK		((1ULL << TS_SHIFT) - 1)
#define TS_DELTA_TEST	(~TS_MASK)

267
struct buffer_data_page {
268
	u64		 time_stamp;	/* page time stamp */
W
Wenji Huang 已提交
269
	local_t		 commit;	/* write committed index */
270 271 272 273 274
	unsigned char	 data[];	/* data of buffer page */
};

struct buffer_page {
	local_t		 write;		/* index for next write */
275
	unsigned	 read;		/* index for next read */
276
	struct list_head list;		/* list of free pages */
277
	struct buffer_data_page *page;	/* Actual data page */
S
Steven Rostedt 已提交
278 279
};

280
static void rb_init_page(struct buffer_data_page *bpage)
281
{
282
	local_set(&bpage->commit, 0);
283 284
}

285 286 287 288 289 290
/**
 * ring_buffer_page_len - the size of data on the page.
 * @page: The page to read
 *
 * Returns the amount of data on the page, including buffer page header.
 */
291 292
size_t ring_buffer_page_len(void *page)
{
293 294
	return local_read(&((struct buffer_data_page *)page)->commit)
		+ BUF_PAGE_HDR_SIZE;
295 296
}

297 298 299 300
/*
 * Also stolen from mm/slob.c. Thanks to Mathieu Desnoyers for pointing
 * this issue out.
 */
301
static void free_buffer_page(struct buffer_page *bpage)
302
{
303
	free_page((unsigned long)bpage->page);
304
	kfree(bpage);
305 306
}

S
Steven Rostedt 已提交
307 308 309 310 311 312 313 314 315 316
/*
 * We need to fit the time_stamp delta into 27 bits.
 */
static inline int test_time_stamp(u64 delta)
{
	if (delta & TS_DELTA_TEST)
		return 1;
	return 0;
}

317
#define BUF_PAGE_SIZE (PAGE_SIZE - BUF_PAGE_HDR_SIZE)
S
Steven Rostedt 已提交
318 319 320 321 322 323 324

/*
 * head_page == tail_page && head == tail then buffer is empty.
 */
struct ring_buffer_per_cpu {
	int				cpu;
	struct ring_buffer		*buffer;
S
Steven Rostedt 已提交
325
	spinlock_t			reader_lock; /* serialize readers */
326
	raw_spinlock_t			lock;
S
Steven Rostedt 已提交
327 328
	struct lock_class_key		lock_key;
	struct list_head		pages;
329 330
	struct buffer_page		*head_page;	/* read from head */
	struct buffer_page		*tail_page;	/* write to tail */
W
Wenji Huang 已提交
331
	struct buffer_page		*commit_page;	/* committed pages */
332
	struct buffer_page		*reader_page;
S
Steven Rostedt 已提交
333 334 335 336 337 338 339 340 341 342 343 344
	unsigned long			overrun;
	unsigned long			entries;
	u64				write_stamp;
	u64				read_stamp;
	atomic_t			record_disabled;
};

struct ring_buffer {
	unsigned			pages;
	unsigned			flags;
	int				cpus;
	atomic_t			record_disabled;
345
	cpumask_var_t			cpumask;
S
Steven Rostedt 已提交
346 347 348 349

	struct mutex			mutex;

	struct ring_buffer_per_cpu	**buffers;
350

351
#ifdef CONFIG_HOTPLUG_CPU
352 353
	struct notifier_block		cpu_notify;
#endif
354
	u64				(*clock)(void);
S
Steven Rostedt 已提交
355 356 357 358 359 360 361 362 363
};

struct ring_buffer_iter {
	struct ring_buffer_per_cpu	*cpu_buffer;
	unsigned long			head;
	struct buffer_page		*head_page;
	u64				read_stamp;
};

364
/* buffer may be either ring_buffer or ring_buffer_per_cpu */
S
Steven Rostedt 已提交
365
#define RB_WARN_ON(buffer, cond)				\
S
Steven Rostedt 已提交
366 367 368
	({							\
		int _____ret = unlikely(cond);			\
		if (_____ret) {					\
S
Steven Rostedt 已提交
369 370 371
			atomic_inc(&buffer->record_disabled);	\
			WARN_ON(1);				\
		}						\
S
Steven Rostedt 已提交
372 373
		_____ret;					\
	})
374

375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398
/* Up this if you want to test the TIME_EXTENTS and normalization */
#define DEBUG_SHIFT 0

u64 ring_buffer_time_stamp(struct ring_buffer *buffer, int cpu)
{
	u64 time;

	preempt_disable_notrace();
	/* shift to debug/test normalization and TIME_EXTENTS */
	time = buffer->clock() << DEBUG_SHIFT;
	preempt_enable_no_resched_notrace();

	return time;
}
EXPORT_SYMBOL_GPL(ring_buffer_time_stamp);

void ring_buffer_normalize_time_stamp(struct ring_buffer *buffer,
				      int cpu, u64 *ts)
{
	/* Just stupid testing the normalize function and deltas */
	*ts >>= DEBUG_SHIFT;
}
EXPORT_SYMBOL_GPL(ring_buffer_normalize_time_stamp);

S
Steven Rostedt 已提交
399 400 401 402
/**
 * check_pages - integrity check of buffer pages
 * @cpu_buffer: CPU buffer with pages to test
 *
W
Wenji Huang 已提交
403
 * As a safety measure we check to make sure the data pages have not
S
Steven Rostedt 已提交
404 405 406 407 408
 * been corrupted.
 */
static int rb_check_pages(struct ring_buffer_per_cpu *cpu_buffer)
{
	struct list_head *head = &cpu_buffer->pages;
409
	struct buffer_page *bpage, *tmp;
S
Steven Rostedt 已提交
410

S
Steven Rostedt 已提交
411 412 413 414
	if (RB_WARN_ON(cpu_buffer, head->next->prev != head))
		return -1;
	if (RB_WARN_ON(cpu_buffer, head->prev->next != head))
		return -1;
S
Steven Rostedt 已提交
415

416
	list_for_each_entry_safe(bpage, tmp, head, list) {
S
Steven Rostedt 已提交
417
		if (RB_WARN_ON(cpu_buffer,
418
			       bpage->list.next->prev != &bpage->list))
S
Steven Rostedt 已提交
419 420
			return -1;
		if (RB_WARN_ON(cpu_buffer,
421
			       bpage->list.prev->next != &bpage->list))
S
Steven Rostedt 已提交
422
			return -1;
S
Steven Rostedt 已提交
423 424 425 426 427 428 429 430 431
	}

	return 0;
}

static int rb_allocate_pages(struct ring_buffer_per_cpu *cpu_buffer,
			     unsigned nr_pages)
{
	struct list_head *head = &cpu_buffer->pages;
432
	struct buffer_page *bpage, *tmp;
S
Steven Rostedt 已提交
433 434 435 436 437
	unsigned long addr;
	LIST_HEAD(pages);
	unsigned i;

	for (i = 0; i < nr_pages; i++) {
438
		bpage = kzalloc_node(ALIGN(sizeof(*bpage), cache_line_size()),
S
Steven Rostedt 已提交
439
				    GFP_KERNEL, cpu_to_node(cpu_buffer->cpu));
440
		if (!bpage)
441
			goto free_pages;
442
		list_add(&bpage->list, &pages);
443

S
Steven Rostedt 已提交
444 445 446
		addr = __get_free_page(GFP_KERNEL);
		if (!addr)
			goto free_pages;
447 448
		bpage->page = (void *)addr;
		rb_init_page(bpage->page);
S
Steven Rostedt 已提交
449 450 451 452 453 454 455 456 457
	}

	list_splice(&pages, head);

	rb_check_pages(cpu_buffer);

	return 0;

 free_pages:
458 459 460
	list_for_each_entry_safe(bpage, tmp, &pages, list) {
		list_del_init(&bpage->list);
		free_buffer_page(bpage);
S
Steven Rostedt 已提交
461 462 463 464 465 466 467 468
	}
	return -ENOMEM;
}

static struct ring_buffer_per_cpu *
rb_allocate_cpu_buffer(struct ring_buffer *buffer, int cpu)
{
	struct ring_buffer_per_cpu *cpu_buffer;
469
	struct buffer_page *bpage;
470
	unsigned long addr;
S
Steven Rostedt 已提交
471 472 473 474 475 476 477 478 479
	int ret;

	cpu_buffer = kzalloc_node(ALIGN(sizeof(*cpu_buffer), cache_line_size()),
				  GFP_KERNEL, cpu_to_node(cpu));
	if (!cpu_buffer)
		return NULL;

	cpu_buffer->cpu = cpu;
	cpu_buffer->buffer = buffer;
S
Steven Rostedt 已提交
480
	spin_lock_init(&cpu_buffer->reader_lock);
481
	cpu_buffer->lock = (raw_spinlock_t)__RAW_SPIN_LOCK_UNLOCKED;
S
Steven Rostedt 已提交
482 483
	INIT_LIST_HEAD(&cpu_buffer->pages);

484
	bpage = kzalloc_node(ALIGN(sizeof(*bpage), cache_line_size()),
485
			    GFP_KERNEL, cpu_to_node(cpu));
486
	if (!bpage)
487 488
		goto fail_free_buffer;

489
	cpu_buffer->reader_page = bpage;
490 491
	addr = __get_free_page(GFP_KERNEL);
	if (!addr)
492
		goto fail_free_reader;
493 494
	bpage->page = (void *)addr;
	rb_init_page(bpage->page);
495

496 497
	INIT_LIST_HEAD(&cpu_buffer->reader_page->list);

S
Steven Rostedt 已提交
498 499
	ret = rb_allocate_pages(cpu_buffer, buffer->pages);
	if (ret < 0)
500
		goto fail_free_reader;
S
Steven Rostedt 已提交
501 502 503

	cpu_buffer->head_page
		= list_entry(cpu_buffer->pages.next, struct buffer_page, list);
S
Steven Rostedt 已提交
504
	cpu_buffer->tail_page = cpu_buffer->commit_page = cpu_buffer->head_page;
S
Steven Rostedt 已提交
505 506 507

	return cpu_buffer;

508 509 510
 fail_free_reader:
	free_buffer_page(cpu_buffer->reader_page);

S
Steven Rostedt 已提交
511 512 513 514 515 516 517 518
 fail_free_buffer:
	kfree(cpu_buffer);
	return NULL;
}

static void rb_free_cpu_buffer(struct ring_buffer_per_cpu *cpu_buffer)
{
	struct list_head *head = &cpu_buffer->pages;
519
	struct buffer_page *bpage, *tmp;
S
Steven Rostedt 已提交
520

521 522 523
	list_del_init(&cpu_buffer->reader_page->list);
	free_buffer_page(cpu_buffer->reader_page);

524 525 526
	list_for_each_entry_safe(bpage, tmp, head, list) {
		list_del_init(&bpage->list);
		free_buffer_page(bpage);
S
Steven Rostedt 已提交
527 528 529 530
	}
	kfree(cpu_buffer);
}

531 532 533 534 535 536
/*
 * Causes compile errors if the struct buffer_page gets bigger
 * than the struct page.
 */
extern int ring_buffer_page_too_big(void);

537
#ifdef CONFIG_HOTPLUG_CPU
538 539
static int rb_cpu_notify(struct notifier_block *self,
			 unsigned long action, void *hcpu);
540 541
#endif

S
Steven Rostedt 已提交
542 543
/**
 * ring_buffer_alloc - allocate a new ring_buffer
544
 * @size: the size in bytes per cpu that is needed.
S
Steven Rostedt 已提交
545 546 547 548 549 550 551 552 553 554 555 556 557
 * @flags: attributes to set for the ring buffer.
 *
 * Currently the only flag that is available is the RB_FL_OVERWRITE
 * flag. This flag means that the buffer will overwrite old data
 * when the buffer wraps. If this flag is not set, the buffer will
 * drop data when the tail hits the head.
 */
struct ring_buffer *ring_buffer_alloc(unsigned long size, unsigned flags)
{
	struct ring_buffer *buffer;
	int bsize;
	int cpu;

558 559 560 561 562
	/* Paranoid! Optimizes out when all is well */
	if (sizeof(struct buffer_page) > sizeof(struct page))
		ring_buffer_page_too_big();


S
Steven Rostedt 已提交
563 564 565 566 567 568
	/* keep it in its own cache line */
	buffer = kzalloc(ALIGN(sizeof(*buffer), cache_line_size()),
			 GFP_KERNEL);
	if (!buffer)
		return NULL;

569 570 571
	if (!alloc_cpumask_var(&buffer->cpumask, GFP_KERNEL))
		goto fail_free_buffer;

S
Steven Rostedt 已提交
572 573
	buffer->pages = DIV_ROUND_UP(size, BUF_PAGE_SIZE);
	buffer->flags = flags;
574
	buffer->clock = trace_clock_local;
S
Steven Rostedt 已提交
575 576 577 578 579

	/* need at least two pages */
	if (buffer->pages == 1)
		buffer->pages++;

580 581 582 583 584 585
	/*
	 * In case of non-hotplug cpu, if the ring-buffer is allocated
	 * in early initcall, it will not be notified of secondary cpus.
	 * In that off case, we need to allocate for all possible cpus.
	 */
#ifdef CONFIG_HOTPLUG_CPU
586 587
	get_online_cpus();
	cpumask_copy(buffer->cpumask, cpu_online_mask);
588 589 590
#else
	cpumask_copy(buffer->cpumask, cpu_possible_mask);
#endif
S
Steven Rostedt 已提交
591 592 593 594 595 596
	buffer->cpus = nr_cpu_ids;

	bsize = sizeof(void *) * nr_cpu_ids;
	buffer->buffers = kzalloc(ALIGN(bsize, cache_line_size()),
				  GFP_KERNEL);
	if (!buffer->buffers)
597
		goto fail_free_cpumask;
S
Steven Rostedt 已提交
598 599 600 601 602 603 604 605

	for_each_buffer_cpu(buffer, cpu) {
		buffer->buffers[cpu] =
			rb_allocate_cpu_buffer(buffer, cpu);
		if (!buffer->buffers[cpu])
			goto fail_free_buffers;
	}

606
#ifdef CONFIG_HOTPLUG_CPU
607 608 609 610 611 612
	buffer->cpu_notify.notifier_call = rb_cpu_notify;
	buffer->cpu_notify.priority = 0;
	register_cpu_notifier(&buffer->cpu_notify);
#endif

	put_online_cpus();
S
Steven Rostedt 已提交
613 614 615 616 617 618 619 620 621 622 623
	mutex_init(&buffer->mutex);

	return buffer;

 fail_free_buffers:
	for_each_buffer_cpu(buffer, cpu) {
		if (buffer->buffers[cpu])
			rb_free_cpu_buffer(buffer->buffers[cpu]);
	}
	kfree(buffer->buffers);

624 625
 fail_free_cpumask:
	free_cpumask_var(buffer->cpumask);
626
	put_online_cpus();
627

S
Steven Rostedt 已提交
628 629 630 631
 fail_free_buffer:
	kfree(buffer);
	return NULL;
}
632
EXPORT_SYMBOL_GPL(ring_buffer_alloc);
S
Steven Rostedt 已提交
633 634 635 636 637 638 639 640 641 642

/**
 * ring_buffer_free - free a ring buffer.
 * @buffer: the buffer to free.
 */
void
ring_buffer_free(struct ring_buffer *buffer)
{
	int cpu;

643 644
	get_online_cpus();

645
#ifdef CONFIG_HOTPLUG_CPU
646 647 648
	unregister_cpu_notifier(&buffer->cpu_notify);
#endif

S
Steven Rostedt 已提交
649 650 651
	for_each_buffer_cpu(buffer, cpu)
		rb_free_cpu_buffer(buffer->buffers[cpu]);

652 653
	put_online_cpus();

654 655
	free_cpumask_var(buffer->cpumask);

S
Steven Rostedt 已提交
656 657
	kfree(buffer);
}
658
EXPORT_SYMBOL_GPL(ring_buffer_free);
S
Steven Rostedt 已提交
659

660 661 662 663 664 665
void ring_buffer_set_clock(struct ring_buffer *buffer,
			   u64 (*clock)(void))
{
	buffer->clock = clock;
}

S
Steven Rostedt 已提交
666 667 668 669 670
static void rb_reset_cpu(struct ring_buffer_per_cpu *cpu_buffer);

static void
rb_remove_pages(struct ring_buffer_per_cpu *cpu_buffer, unsigned nr_pages)
{
671
	struct buffer_page *bpage;
S
Steven Rostedt 已提交
672 673 674 675 676 677 678
	struct list_head *p;
	unsigned i;

	atomic_inc(&cpu_buffer->record_disabled);
	synchronize_sched();

	for (i = 0; i < nr_pages; i++) {
S
Steven Rostedt 已提交
679 680
		if (RB_WARN_ON(cpu_buffer, list_empty(&cpu_buffer->pages)))
			return;
S
Steven Rostedt 已提交
681
		p = cpu_buffer->pages.next;
682 683 684
		bpage = list_entry(p, struct buffer_page, list);
		list_del_init(&bpage->list);
		free_buffer_page(bpage);
S
Steven Rostedt 已提交
685
	}
S
Steven Rostedt 已提交
686 687
	if (RB_WARN_ON(cpu_buffer, list_empty(&cpu_buffer->pages)))
		return;
S
Steven Rostedt 已提交
688 689 690 691 692 693 694 695 696 697 698 699 700

	rb_reset_cpu(cpu_buffer);

	rb_check_pages(cpu_buffer);

	atomic_dec(&cpu_buffer->record_disabled);

}

static void
rb_insert_pages(struct ring_buffer_per_cpu *cpu_buffer,
		struct list_head *pages, unsigned nr_pages)
{
701
	struct buffer_page *bpage;
S
Steven Rostedt 已提交
702 703 704 705 706 707 708
	struct list_head *p;
	unsigned i;

	atomic_inc(&cpu_buffer->record_disabled);
	synchronize_sched();

	for (i = 0; i < nr_pages; i++) {
S
Steven Rostedt 已提交
709 710
		if (RB_WARN_ON(cpu_buffer, list_empty(pages)))
			return;
S
Steven Rostedt 已提交
711
		p = pages->next;
712 713 714
		bpage = list_entry(p, struct buffer_page, list);
		list_del_init(&bpage->list);
		list_add_tail(&bpage->list, &cpu_buffer->pages);
S
Steven Rostedt 已提交
715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740
	}
	rb_reset_cpu(cpu_buffer);

	rb_check_pages(cpu_buffer);

	atomic_dec(&cpu_buffer->record_disabled);
}

/**
 * ring_buffer_resize - resize the ring buffer
 * @buffer: the buffer to resize.
 * @size: the new size.
 *
 * The tracer is responsible for making sure that the buffer is
 * not being used while changing the size.
 * Note: We may be able to change the above requirement by using
 *  RCU synchronizations.
 *
 * Minimum size is 2 * BUF_PAGE_SIZE.
 *
 * Returns -1 on failure.
 */
int ring_buffer_resize(struct ring_buffer *buffer, unsigned long size)
{
	struct ring_buffer_per_cpu *cpu_buffer;
	unsigned nr_pages, rm_pages, new_pages;
741
	struct buffer_page *bpage, *tmp;
S
Steven Rostedt 已提交
742 743 744 745 746
	unsigned long buffer_size;
	unsigned long addr;
	LIST_HEAD(pages);
	int i, cpu;

747 748 749 750 751 752
	/*
	 * Always succeed at resizing a non-existent buffer:
	 */
	if (!buffer)
		return size;

S
Steven Rostedt 已提交
753 754 755 756 757 758 759 760 761 762 763 764
	size = DIV_ROUND_UP(size, BUF_PAGE_SIZE);
	size *= BUF_PAGE_SIZE;
	buffer_size = buffer->pages * BUF_PAGE_SIZE;

	/* we need a minimum of two pages */
	if (size < BUF_PAGE_SIZE * 2)
		size = BUF_PAGE_SIZE * 2;

	if (size == buffer_size)
		return size;

	mutex_lock(&buffer->mutex);
765
	get_online_cpus();
S
Steven Rostedt 已提交
766 767 768 769 770 771

	nr_pages = DIV_ROUND_UP(size, BUF_PAGE_SIZE);

	if (size < buffer_size) {

		/* easy case, just free pages */
772 773
		if (RB_WARN_ON(buffer, nr_pages >= buffer->pages))
			goto out_fail;
S
Steven Rostedt 已提交
774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791

		rm_pages = buffer->pages - nr_pages;

		for_each_buffer_cpu(buffer, cpu) {
			cpu_buffer = buffer->buffers[cpu];
			rb_remove_pages(cpu_buffer, rm_pages);
		}
		goto out;
	}

	/*
	 * This is a bit more difficult. We only want to add pages
	 * when we can allocate enough for all CPUs. We do this
	 * by allocating all the pages and storing them on a local
	 * link list. If we succeed in our allocation, then we
	 * add these pages to the cpu_buffers. Otherwise we just free
	 * them all and return -ENOMEM;
	 */
792 793
	if (RB_WARN_ON(buffer, nr_pages <= buffer->pages))
		goto out_fail;
794

S
Steven Rostedt 已提交
795 796 797 798
	new_pages = nr_pages - buffer->pages;

	for_each_buffer_cpu(buffer, cpu) {
		for (i = 0; i < new_pages; i++) {
799
			bpage = kzalloc_node(ALIGN(sizeof(*bpage),
800 801
						  cache_line_size()),
					    GFP_KERNEL, cpu_to_node(cpu));
802
			if (!bpage)
803
				goto free_pages;
804
			list_add(&bpage->list, &pages);
S
Steven Rostedt 已提交
805 806 807
			addr = __get_free_page(GFP_KERNEL);
			if (!addr)
				goto free_pages;
808 809
			bpage->page = (void *)addr;
			rb_init_page(bpage->page);
S
Steven Rostedt 已提交
810 811 812 813 814 815 816 817
		}
	}

	for_each_buffer_cpu(buffer, cpu) {
		cpu_buffer = buffer->buffers[cpu];
		rb_insert_pages(cpu_buffer, &pages, new_pages);
	}

818 819
	if (RB_WARN_ON(buffer, !list_empty(&pages)))
		goto out_fail;
S
Steven Rostedt 已提交
820 821 822

 out:
	buffer->pages = nr_pages;
823
	put_online_cpus();
S
Steven Rostedt 已提交
824 825 826 827 828
	mutex_unlock(&buffer->mutex);

	return size;

 free_pages:
829 830 831
	list_for_each_entry_safe(bpage, tmp, &pages, list) {
		list_del_init(&bpage->list);
		free_buffer_page(bpage);
S
Steven Rostedt 已提交
832
	}
833
	put_online_cpus();
834
	mutex_unlock(&buffer->mutex);
S
Steven Rostedt 已提交
835
	return -ENOMEM;
836 837 838 839 840 841 842 843 844

	/*
	 * Something went totally wrong, and we are too paranoid
	 * to even clean up the mess.
	 */
 out_fail:
	put_online_cpus();
	mutex_unlock(&buffer->mutex);
	return -1;
S
Steven Rostedt 已提交
845
}
846
EXPORT_SYMBOL_GPL(ring_buffer_resize);
S
Steven Rostedt 已提交
847 848 849 850 851 852

static inline int rb_null_event(struct ring_buffer_event *event)
{
	return event->type == RINGBUF_TYPE_PADDING;
}

S
Steven Rostedt 已提交
853
static inline void *
854
__rb_data_page_index(struct buffer_data_page *bpage, unsigned index)
S
Steven Rostedt 已提交
855
{
856
	return bpage->data + index;
S
Steven Rostedt 已提交
857 858
}

859
static inline void *__rb_page_index(struct buffer_page *bpage, unsigned index)
S
Steven Rostedt 已提交
860
{
861
	return bpage->page->data + index;
S
Steven Rostedt 已提交
862 863 864
}

static inline struct ring_buffer_event *
865
rb_reader_event(struct ring_buffer_per_cpu *cpu_buffer)
S
Steven Rostedt 已提交
866
{
867 868 869 870 871 872 873 874 875
	return __rb_page_index(cpu_buffer->reader_page,
			       cpu_buffer->reader_page->read);
}

static inline struct ring_buffer_event *
rb_head_event(struct ring_buffer_per_cpu *cpu_buffer)
{
	return __rb_page_index(cpu_buffer->head_page,
			       cpu_buffer->head_page->read);
S
Steven Rostedt 已提交
876 877 878 879 880
}

static inline struct ring_buffer_event *
rb_iter_head_event(struct ring_buffer_iter *iter)
{
881
	return __rb_page_index(iter->head_page, iter->head);
S
Steven Rostedt 已提交
882 883
}

S
Steven Rostedt 已提交
884 885 886 887 888 889 890
static inline unsigned rb_page_write(struct buffer_page *bpage)
{
	return local_read(&bpage->write);
}

static inline unsigned rb_page_commit(struct buffer_page *bpage)
{
891
	return local_read(&bpage->page->commit);
S
Steven Rostedt 已提交
892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910
}

/* Size is determined by what has been commited */
static inline unsigned rb_page_size(struct buffer_page *bpage)
{
	return rb_page_commit(bpage);
}

static inline unsigned
rb_commit_index(struct ring_buffer_per_cpu *cpu_buffer)
{
	return rb_page_commit(cpu_buffer->commit_page);
}

static inline unsigned rb_head_size(struct ring_buffer_per_cpu *cpu_buffer)
{
	return rb_page_commit(cpu_buffer->head_page);
}

S
Steven Rostedt 已提交
911 912 913 914 915 916 917 918 919 920 921 922 923 924
/*
 * When the tail hits the head and the buffer is in overwrite mode,
 * the head jumps to the next page and all content on the previous
 * page is discarded. But before doing so, we update the overrun
 * variable of the buffer.
 */
static void rb_update_overflow(struct ring_buffer_per_cpu *cpu_buffer)
{
	struct ring_buffer_event *event;
	unsigned long head;

	for (head = 0; head < rb_head_size(cpu_buffer);
	     head += rb_event_length(event)) {

925
		event = __rb_page_index(cpu_buffer->head_page, head);
S
Steven Rostedt 已提交
926 927
		if (RB_WARN_ON(cpu_buffer, rb_null_event(event)))
			return;
S
Steven Rostedt 已提交
928 929 930 931 932 933 934 935 936
		/* Only count data entries */
		if (event->type != RINGBUF_TYPE_DATA)
			continue;
		cpu_buffer->overrun++;
		cpu_buffer->entries--;
	}
}

static inline void rb_inc_page(struct ring_buffer_per_cpu *cpu_buffer,
937
			       struct buffer_page **bpage)
S
Steven Rostedt 已提交
938
{
939
	struct list_head *p = (*bpage)->list.next;
S
Steven Rostedt 已提交
940 941 942 943

	if (p == &cpu_buffer->pages)
		p = p->next;

944
	*bpage = list_entry(p, struct buffer_page, list);
S
Steven Rostedt 已提交
945 946
}

S
Steven Rostedt 已提交
947 948 949 950 951 952 953 954
static inline unsigned
rb_event_index(struct ring_buffer_event *event)
{
	unsigned long addr = (unsigned long)event;

	return (addr & ~PAGE_MASK) - (PAGE_SIZE - BUF_PAGE_SIZE);
}

955
static int
S
Steven Rostedt 已提交
956 957 958 959 960 961 962 963 964 965 966 967 968
rb_is_commit(struct ring_buffer_per_cpu *cpu_buffer,
	     struct ring_buffer_event *event)
{
	unsigned long addr = (unsigned long)event;
	unsigned long index;

	index = rb_event_index(event);
	addr &= PAGE_MASK;

	return cpu_buffer->commit_page->page == (void *)addr &&
		rb_commit_index(cpu_buffer) == index;
}

969
static void
S
Steven Rostedt 已提交
970 971
rb_set_commit_event(struct ring_buffer_per_cpu *cpu_buffer,
		    struct ring_buffer_event *event)
S
Steven Rostedt 已提交
972
{
S
Steven Rostedt 已提交
973 974 975 976 977 978 979
	unsigned long addr = (unsigned long)event;
	unsigned long index;

	index = rb_event_index(event);
	addr &= PAGE_MASK;

	while (cpu_buffer->commit_page->page != (void *)addr) {
S
Steven Rostedt 已提交
980 981 982
		if (RB_WARN_ON(cpu_buffer,
			  cpu_buffer->commit_page == cpu_buffer->tail_page))
			return;
983
		cpu_buffer->commit_page->page->commit =
S
Steven Rostedt 已提交
984 985
			cpu_buffer->commit_page->write;
		rb_inc_page(cpu_buffer, &cpu_buffer->commit_page);
986 987
		cpu_buffer->write_stamp =
			cpu_buffer->commit_page->page->time_stamp;
S
Steven Rostedt 已提交
988 989 990
	}

	/* Now set the commit to the event's index */
991
	local_set(&cpu_buffer->commit_page->page->commit, index);
S
Steven Rostedt 已提交
992 993
}

994
static void
S
Steven Rostedt 已提交
995
rb_set_commit_to_write(struct ring_buffer_per_cpu *cpu_buffer)
S
Steven Rostedt 已提交
996
{
S
Steven Rostedt 已提交
997 998 999 1000 1001 1002 1003 1004
	/*
	 * We only race with interrupts and NMIs on this CPU.
	 * If we own the commit event, then we can commit
	 * all others that interrupted us, since the interruptions
	 * are in stack format (they finish before they come
	 * back to us). This allows us to do a simple loop to
	 * assign the commit to the tail.
	 */
1005
 again:
S
Steven Rostedt 已提交
1006
	while (cpu_buffer->commit_page != cpu_buffer->tail_page) {
1007
		cpu_buffer->commit_page->page->commit =
S
Steven Rostedt 已提交
1008 1009
			cpu_buffer->commit_page->write;
		rb_inc_page(cpu_buffer, &cpu_buffer->commit_page);
1010 1011
		cpu_buffer->write_stamp =
			cpu_buffer->commit_page->page->time_stamp;
S
Steven Rostedt 已提交
1012 1013 1014 1015 1016
		/* add barrier to keep gcc from optimizing too much */
		barrier();
	}
	while (rb_commit_index(cpu_buffer) !=
	       rb_page_write(cpu_buffer->commit_page)) {
1017
		cpu_buffer->commit_page->page->commit =
S
Steven Rostedt 已提交
1018 1019 1020
			cpu_buffer->commit_page->write;
		barrier();
	}
1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031

	/* again, keep gcc from optimizing */
	barrier();

	/*
	 * If an interrupt came in just after the first while loop
	 * and pushed the tail page forward, we will be left with
	 * a dangling commit that will never go forward.
	 */
	if (unlikely(cpu_buffer->commit_page != cpu_buffer->tail_page))
		goto again;
S
Steven Rostedt 已提交
1032 1033
}

1034
static void rb_reset_reader_page(struct ring_buffer_per_cpu *cpu_buffer)
S
Steven Rostedt 已提交
1035
{
1036
	cpu_buffer->read_stamp = cpu_buffer->reader_page->page->time_stamp;
1037
	cpu_buffer->reader_page->read = 0;
1038 1039
}

1040
static void rb_inc_iter(struct ring_buffer_iter *iter)
1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054
{
	struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;

	/*
	 * The iterator could be on the reader page (it starts there).
	 * But the head could have moved, since the reader was
	 * found. Check for this case and assign the iterator
	 * to the head page instead of next.
	 */
	if (iter->head_page == cpu_buffer->reader_page)
		iter->head_page = cpu_buffer->head_page;
	else
		rb_inc_page(cpu_buffer, &iter->head_page);

1055
	iter->read_stamp = iter->head_page->page->time_stamp;
S
Steven Rostedt 已提交
1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069
	iter->head = 0;
}

/**
 * ring_buffer_update_event - update event type and data
 * @event: the even to update
 * @type: the type of event
 * @length: the size of the event field in the ring buffer
 *
 * Update the type and data fields of the event. The length
 * is the actual size that is written to the ring buffer,
 * and with this, we can determine what to place into the
 * data field.
 */
1070
static void
S
Steven Rostedt 已提交
1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081
rb_update_event(struct ring_buffer_event *event,
			 unsigned type, unsigned length)
{
	event->type = type;

	switch (type) {

	case RINGBUF_TYPE_PADDING:
		break;

	case RINGBUF_TYPE_TIME_EXTEND:
1082
		event->len = DIV_ROUND_UP(RB_LEN_TIME_EXTEND, RB_ALIGNMENT);
S
Steven Rostedt 已提交
1083 1084 1085
		break;

	case RINGBUF_TYPE_TIME_STAMP:
1086
		event->len = DIV_ROUND_UP(RB_LEN_TIME_STAMP, RB_ALIGNMENT);
S
Steven Rostedt 已提交
1087 1088 1089 1090 1091 1092 1093 1094
		break;

	case RINGBUF_TYPE_DATA:
		length -= RB_EVNT_HDR_SIZE;
		if (length > RB_MAX_SMALL_DATA) {
			event->len = 0;
			event->array[0] = length;
		} else
1095
			event->len = DIV_ROUND_UP(length, RB_ALIGNMENT);
S
Steven Rostedt 已提交
1096 1097 1098 1099 1100 1101
		break;
	default:
		BUG();
	}
}

1102
static unsigned rb_calculate_event_length(unsigned length)
S
Steven Rostedt 已提交
1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122
{
	struct ring_buffer_event event; /* Used only for sizeof array */

	/* zero length can cause confusions */
	if (!length)
		length = 1;

	if (length > RB_MAX_SMALL_DATA)
		length += sizeof(event.array[0]);

	length += RB_EVNT_HDR_SIZE;
	length = ALIGN(length, RB_ALIGNMENT);

	return length;
}

static struct ring_buffer_event *
__rb_reserve_next(struct ring_buffer_per_cpu *cpu_buffer,
		  unsigned type, unsigned long length, u64 *ts)
{
1123
	struct buffer_page *tail_page, *head_page, *reader_page, *commit_page;
S
Steven Rostedt 已提交
1124
	unsigned long tail, write;
S
Steven Rostedt 已提交
1125 1126
	struct ring_buffer *buffer = cpu_buffer->buffer;
	struct ring_buffer_event *event;
S
Steven Rostedt 已提交
1127
	unsigned long flags;
1128
	bool lock_taken = false;
S
Steven Rostedt 已提交
1129

1130 1131 1132
	commit_page = cpu_buffer->commit_page;
	/* we just need to protect against interrupts */
	barrier();
S
Steven Rostedt 已提交
1133
	tail_page = cpu_buffer->tail_page;
S
Steven Rostedt 已提交
1134 1135
	write = local_add_return(length, &tail_page->write);
	tail = write - length;
S
Steven Rostedt 已提交
1136

S
Steven Rostedt 已提交
1137 1138
	/* See if we shot pass the end of this buffer page */
	if (write > BUF_PAGE_SIZE) {
S
Steven Rostedt 已提交
1139 1140
		struct buffer_page *next_page = tail_page;

1141
		local_irq_save(flags);
1142
		/*
1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153
		 * Since the write to the buffer is still not
		 * fully lockless, we must be careful with NMIs.
		 * The locks in the writers are taken when a write
		 * crosses to a new page. The locks protect against
		 * races with the readers (this will soon be fixed
		 * with a lockless solution).
		 *
		 * Because we can not protect against NMIs, and we
		 * want to keep traces reentrant, we need to manage
		 * what happens when we are in an NMI.
		 *
1154 1155 1156 1157 1158
		 * NMIs can happen after we take the lock.
		 * If we are in an NMI, only take the lock
		 * if it is not already taken. Otherwise
		 * simply fail.
		 */
1159
		if (unlikely(in_nmi())) {
1160
			if (!__raw_spin_trylock(&cpu_buffer->lock))
1161
				goto out_reset;
1162 1163 1164 1165
		} else
			__raw_spin_lock(&cpu_buffer->lock);

		lock_taken = true;
S
Steven Rostedt 已提交
1166

S
Steven Rostedt 已提交
1167 1168
		rb_inc_page(cpu_buffer, &next_page);

1169 1170 1171 1172
		head_page = cpu_buffer->head_page;
		reader_page = cpu_buffer->reader_page;

		/* we grabbed the lock before incrementing */
S
Steven Rostedt 已提交
1173
		if (RB_WARN_ON(cpu_buffer, next_page == reader_page))
1174
			goto out_reset;
S
Steven Rostedt 已提交
1175 1176 1177 1178 1179 1180

		/*
		 * If for some reason, we had an interrupt storm that made
		 * it all the way around the buffer, bail, and warn
		 * about it.
		 */
1181
		if (unlikely(next_page == commit_page)) {
S
Steven Rostedt 已提交
1182
			WARN_ON_ONCE(1);
1183
			goto out_reset;
S
Steven Rostedt 已提交
1184
		}
1185

S
Steven Rostedt 已提交
1186
		if (next_page == head_page) {
1187
			if (!(buffer->flags & RB_FL_OVERWRITE))
1188
				goto out_reset;
S
Steven Rostedt 已提交
1189

S
Steven Rostedt 已提交
1190 1191 1192 1193 1194 1195 1196 1197 1198 1199
			/* tail_page has not moved yet? */
			if (tail_page == cpu_buffer->tail_page) {
				/* count overflows */
				rb_update_overflow(cpu_buffer);

				rb_inc_page(cpu_buffer, &head_page);
				cpu_buffer->head_page = head_page;
				cpu_buffer->head_page->read = 0;
			}
		}
S
Steven Rostedt 已提交
1200

S
Steven Rostedt 已提交
1201 1202 1203 1204 1205 1206 1207
		/*
		 * If the tail page is still the same as what we think
		 * it is, then it is up to us to update the tail
		 * pointer.
		 */
		if (tail_page == cpu_buffer->tail_page) {
			local_set(&next_page->write, 0);
1208
			local_set(&next_page->page->commit, 0);
S
Steven Rostedt 已提交
1209 1210 1211
			cpu_buffer->tail_page = next_page;

			/* reread the time stamp */
1212
			*ts = ring_buffer_time_stamp(buffer, cpu_buffer->cpu);
1213
			cpu_buffer->tail_page->page->time_stamp = *ts;
S
Steven Rostedt 已提交
1214 1215
		}

S
Steven Rostedt 已提交
1216 1217 1218 1219 1220
		/*
		 * The actual tail page has moved forward.
		 */
		if (tail < BUF_PAGE_SIZE) {
			/* Mark the rest of the page with padding */
1221
			event = __rb_page_index(tail_page, tail);
S
Steven Rostedt 已提交
1222 1223 1224
			event->type = RINGBUF_TYPE_PADDING;
		}

S
Steven Rostedt 已提交
1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237
		if (tail <= BUF_PAGE_SIZE)
			/* Set the write back to the previous setting */
			local_set(&tail_page->write, tail);

		/*
		 * If this was a commit entry that failed,
		 * increment that too
		 */
		if (tail_page == cpu_buffer->commit_page &&
		    tail == rb_commit_index(cpu_buffer)) {
			rb_set_commit_to_write(cpu_buffer);
		}

1238 1239
		__raw_spin_unlock(&cpu_buffer->lock);
		local_irq_restore(flags);
S
Steven Rostedt 已提交
1240 1241 1242

		/* fail and let the caller try again */
		return ERR_PTR(-EAGAIN);
S
Steven Rostedt 已提交
1243 1244
	}

S
Steven Rostedt 已提交
1245 1246
	/* We reserved something on the buffer */

S
Steven Rostedt 已提交
1247 1248
	if (RB_WARN_ON(cpu_buffer, write > BUF_PAGE_SIZE))
		return NULL;
S
Steven Rostedt 已提交
1249

1250
	event = __rb_page_index(tail_page, tail);
S
Steven Rostedt 已提交
1251 1252
	rb_update_event(event, type, length);

S
Steven Rostedt 已提交
1253 1254 1255 1256 1257
	/*
	 * If this is a commit and the tail is zero, then update
	 * this page's time stamp.
	 */
	if (!tail && rb_is_commit(cpu_buffer, event))
1258
		cpu_buffer->commit_page->page->time_stamp = *ts;
S
Steven Rostedt 已提交
1259

S
Steven Rostedt 已提交
1260
	return event;
S
Steven Rostedt 已提交
1261

1262
 out_reset:
1263 1264 1265 1266
	/* reset write */
	if (tail <= BUF_PAGE_SIZE)
		local_set(&tail_page->write, tail);

1267 1268
	if (likely(lock_taken))
		__raw_spin_unlock(&cpu_buffer->lock);
1269
	local_irq_restore(flags);
S
Steven Rostedt 已提交
1270
	return NULL;
S
Steven Rostedt 已提交
1271 1272 1273 1274 1275 1276 1277 1278
}

static int
rb_add_time_stamp(struct ring_buffer_per_cpu *cpu_buffer,
		  u64 *ts, u64 *delta)
{
	struct ring_buffer_event *event;
	static int once;
S
Steven Rostedt 已提交
1279
	int ret;
S
Steven Rostedt 已提交
1280 1281 1282 1283

	if (unlikely(*delta > (1ULL << 59) && !once++)) {
		printk(KERN_WARNING "Delta way too big! %llu"
		       " ts=%llu write stamp = %llu\n",
1284 1285 1286
		       (unsigned long long)*delta,
		       (unsigned long long)*ts,
		       (unsigned long long)cpu_buffer->write_stamp);
S
Steven Rostedt 已提交
1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298
		WARN_ON(1);
	}

	/*
	 * The delta is too big, we to add a
	 * new timestamp.
	 */
	event = __rb_reserve_next(cpu_buffer,
				  RINGBUF_TYPE_TIME_EXTEND,
				  RB_LEN_TIME_EXTEND,
				  ts);
	if (!event)
S
Steven Rostedt 已提交
1299
		return -EBUSY;
S
Steven Rostedt 已提交
1300

S
Steven Rostedt 已提交
1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313
	if (PTR_ERR(event) == -EAGAIN)
		return -EAGAIN;

	/* Only a commited time event can update the write stamp */
	if (rb_is_commit(cpu_buffer, event)) {
		/*
		 * If this is the first on the page, then we need to
		 * update the page itself, and just put in a zero.
		 */
		if (rb_event_index(event)) {
			event->time_delta = *delta & TS_MASK;
			event->array[0] = *delta >> TS_SHIFT;
		} else {
1314
			cpu_buffer->commit_page->page->time_stamp = *ts;
S
Steven Rostedt 已提交
1315 1316 1317
			event->time_delta = 0;
			event->array[0] = 0;
		}
S
Steven Rostedt 已提交
1318
		cpu_buffer->write_stamp = *ts;
S
Steven Rostedt 已提交
1319 1320 1321 1322 1323 1324 1325
		/* let the caller know this was the commit */
		ret = 1;
	} else {
		/* Darn, this is just wasted space */
		event->time_delta = 0;
		event->array[0] = 0;
		ret = 0;
S
Steven Rostedt 已提交
1326 1327
	}

S
Steven Rostedt 已提交
1328 1329 1330
	*delta = 0;

	return ret;
S
Steven Rostedt 已提交
1331 1332 1333 1334 1335 1336 1337 1338
}

static struct ring_buffer_event *
rb_reserve_next_event(struct ring_buffer_per_cpu *cpu_buffer,
		      unsigned type, unsigned long length)
{
	struct ring_buffer_event *event;
	u64 ts, delta;
S
Steven Rostedt 已提交
1339
	int commit = 0;
1340
	int nr_loops = 0;
S
Steven Rostedt 已提交
1341

S
Steven Rostedt 已提交
1342
 again:
1343 1344 1345 1346 1347 1348 1349 1350 1351
	/*
	 * We allow for interrupts to reenter here and do a trace.
	 * If one does, it will cause this original code to loop
	 * back here. Even with heavy interrupts happening, this
	 * should only happen a few times in a row. If this happens
	 * 1000 times in a row, there must be either an interrupt
	 * storm or we have something buggy.
	 * Bail!
	 */
S
Steven Rostedt 已提交
1352
	if (RB_WARN_ON(cpu_buffer, ++nr_loops > 1000))
1353 1354
		return NULL;

1355
	ts = ring_buffer_time_stamp(cpu_buffer->buffer, cpu_buffer->cpu);
S
Steven Rostedt 已提交
1356

S
Steven Rostedt 已提交
1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368
	/*
	 * Only the first commit can update the timestamp.
	 * Yes there is a race here. If an interrupt comes in
	 * just after the conditional and it traces too, then it
	 * will also check the deltas. More than one timestamp may
	 * also be made. But only the entry that did the actual
	 * commit will be something other than zero.
	 */
	if (cpu_buffer->tail_page == cpu_buffer->commit_page &&
	    rb_page_write(cpu_buffer->tail_page) ==
	    rb_commit_index(cpu_buffer)) {

S
Steven Rostedt 已提交
1369 1370
		delta = ts - cpu_buffer->write_stamp;

S
Steven Rostedt 已提交
1371 1372 1373 1374 1375
		/* make sure this delta is calculated here */
		barrier();

		/* Did the write stamp get updated already? */
		if (unlikely(ts < cpu_buffer->write_stamp))
1376
			delta = 0;
S
Steven Rostedt 已提交
1377

S
Steven Rostedt 已提交
1378 1379
		if (test_time_stamp(delta)) {

S
Steven Rostedt 已提交
1380 1381 1382
			commit = rb_add_time_stamp(cpu_buffer, &ts, &delta);

			if (commit == -EBUSY)
S
Steven Rostedt 已提交
1383
				return NULL;
S
Steven Rostedt 已提交
1384 1385 1386 1387 1388

			if (commit == -EAGAIN)
				goto again;

			RB_WARN_ON(cpu_buffer, commit < 0);
S
Steven Rostedt 已提交
1389
		}
S
Steven Rostedt 已提交
1390 1391
	} else
		/* Non commits have zero deltas */
S
Steven Rostedt 已提交
1392 1393 1394
		delta = 0;

	event = __rb_reserve_next(cpu_buffer, type, length, &ts);
S
Steven Rostedt 已提交
1395 1396 1397 1398 1399 1400 1401 1402 1403 1404
	if (PTR_ERR(event) == -EAGAIN)
		goto again;

	if (!event) {
		if (unlikely(commit))
			/*
			 * Ouch! We needed a timestamp and it was commited. But
			 * we didn't get our event reserved.
			 */
			rb_set_commit_to_write(cpu_buffer);
S
Steven Rostedt 已提交
1405
		return NULL;
S
Steven Rostedt 已提交
1406
	}
S
Steven Rostedt 已提交
1407

S
Steven Rostedt 已提交
1408 1409 1410 1411 1412 1413 1414
	/*
	 * If the timestamp was commited, make the commit our entry
	 * now so that we will update it when needed.
	 */
	if (commit)
		rb_set_commit_event(cpu_buffer, event);
	else if (!rb_is_commit(cpu_buffer, event))
S
Steven Rostedt 已提交
1415 1416 1417 1418 1419 1420 1421
		delta = 0;

	event->time_delta = delta;

	return event;
}

S
Steven Rostedt 已提交
1422 1423
static DEFINE_PER_CPU(int, rb_need_resched);

S
Steven Rostedt 已提交
1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439
/**
 * ring_buffer_lock_reserve - reserve a part of the buffer
 * @buffer: the ring buffer to reserve from
 * @length: the length of the data to reserve (excluding event header)
 *
 * Returns a reseverd event on the ring buffer to copy directly to.
 * The user of this interface will need to get the body to write into
 * and can use the ring_buffer_event_data() interface.
 *
 * The length is the length of the data needed, not the event length
 * which also includes the event header.
 *
 * Must be paired with ring_buffer_unlock_commit, unless NULL is returned.
 * If NULL is returned, then nothing has been allocated or locked.
 */
struct ring_buffer_event *
1440
ring_buffer_lock_reserve(struct ring_buffer *buffer, unsigned long length)
S
Steven Rostedt 已提交
1441 1442 1443
{
	struct ring_buffer_per_cpu *cpu_buffer;
	struct ring_buffer_event *event;
S
Steven Rostedt 已提交
1444
	int cpu, resched;
S
Steven Rostedt 已提交
1445

1446
	if (ring_buffer_flags != RB_BUFFERS_ON)
1447 1448
		return NULL;

S
Steven Rostedt 已提交
1449 1450 1451
	if (atomic_read(&buffer->record_disabled))
		return NULL;

S
Steven Rostedt 已提交
1452
	/* If we are tracing schedule, we don't want to recurse */
1453
	resched = ftrace_preempt_disable();
S
Steven Rostedt 已提交
1454

S
Steven Rostedt 已提交
1455 1456
	cpu = raw_smp_processor_id();

1457
	if (!cpumask_test_cpu(cpu, buffer->cpumask))
1458
		goto out;
S
Steven Rostedt 已提交
1459 1460 1461 1462

	cpu_buffer = buffer->buffers[cpu];

	if (atomic_read(&cpu_buffer->record_disabled))
1463
		goto out;
S
Steven Rostedt 已提交
1464 1465 1466

	length = rb_calculate_event_length(length);
	if (length > BUF_PAGE_SIZE)
S
Steven Rostedt 已提交
1467
		goto out;
S
Steven Rostedt 已提交
1468 1469 1470

	event = rb_reserve_next_event(cpu_buffer, RINGBUF_TYPE_DATA, length);
	if (!event)
1471
		goto out;
S
Steven Rostedt 已提交
1472

S
Steven Rostedt 已提交
1473 1474 1475 1476 1477 1478 1479 1480
	/*
	 * Need to store resched state on this cpu.
	 * Only the first needs to.
	 */

	if (preempt_count() == 1)
		per_cpu(rb_need_resched, cpu) = resched;

S
Steven Rostedt 已提交
1481 1482
	return event;

1483
 out:
1484
	ftrace_preempt_enable(resched);
S
Steven Rostedt 已提交
1485 1486
	return NULL;
}
1487
EXPORT_SYMBOL_GPL(ring_buffer_lock_reserve);
S
Steven Rostedt 已提交
1488 1489 1490 1491 1492

static void rb_commit(struct ring_buffer_per_cpu *cpu_buffer,
		      struct ring_buffer_event *event)
{
	cpu_buffer->entries++;
S
Steven Rostedt 已提交
1493 1494 1495 1496 1497 1498 1499 1500

	/* Only process further if we own the commit */
	if (!rb_is_commit(cpu_buffer, event))
		return;

	cpu_buffer->write_stamp += event->time_delta;

	rb_set_commit_to_write(cpu_buffer);
S
Steven Rostedt 已提交
1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512
}

/**
 * ring_buffer_unlock_commit - commit a reserved
 * @buffer: The buffer to commit to
 * @event: The event pointer to commit.
 *
 * This commits the data to the ring buffer, and releases any locks held.
 *
 * Must be paired with ring_buffer_lock_reserve.
 */
int ring_buffer_unlock_commit(struct ring_buffer *buffer,
1513
			      struct ring_buffer_event *event)
S
Steven Rostedt 已提交
1514 1515 1516 1517 1518 1519 1520 1521
{
	struct ring_buffer_per_cpu *cpu_buffer;
	int cpu = raw_smp_processor_id();

	cpu_buffer = buffer->buffers[cpu];

	rb_commit(cpu_buffer, event);

S
Steven Rostedt 已提交
1522 1523 1524
	/*
	 * Only the last preempt count needs to restore preemption.
	 */
1525 1526 1527
	if (preempt_count() == 1)
		ftrace_preempt_enable(per_cpu(rb_need_resched, cpu));
	else
S
Steven Rostedt 已提交
1528
		preempt_enable_no_resched_notrace();
S
Steven Rostedt 已提交
1529 1530 1531

	return 0;
}
1532
EXPORT_SYMBOL_GPL(ring_buffer_unlock_commit);
S
Steven Rostedt 已提交
1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552

/**
 * ring_buffer_write - write data to the buffer without reserving
 * @buffer: The ring buffer to write to.
 * @length: The length of the data being written (excluding the event header)
 * @data: The data to write to the buffer.
 *
 * This is like ring_buffer_lock_reserve and ring_buffer_unlock_commit as
 * one function. If you already have the data to write to the buffer, it
 * may be easier to simply call this function.
 *
 * Note, like ring_buffer_lock_reserve, the length is the length of the data
 * and not the length of the event which would hold the header.
 */
int ring_buffer_write(struct ring_buffer *buffer,
			unsigned long length,
			void *data)
{
	struct ring_buffer_per_cpu *cpu_buffer;
	struct ring_buffer_event *event;
S
Steven Rostedt 已提交
1553
	unsigned long event_length;
S
Steven Rostedt 已提交
1554 1555
	void *body;
	int ret = -EBUSY;
S
Steven Rostedt 已提交
1556
	int cpu, resched;
S
Steven Rostedt 已提交
1557

1558
	if (ring_buffer_flags != RB_BUFFERS_ON)
1559 1560
		return -EBUSY;

S
Steven Rostedt 已提交
1561 1562 1563
	if (atomic_read(&buffer->record_disabled))
		return -EBUSY;

1564
	resched = ftrace_preempt_disable();
S
Steven Rostedt 已提交
1565

S
Steven Rostedt 已提交
1566 1567
	cpu = raw_smp_processor_id();

1568
	if (!cpumask_test_cpu(cpu, buffer->cpumask))
1569
		goto out;
S
Steven Rostedt 已提交
1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589

	cpu_buffer = buffer->buffers[cpu];

	if (atomic_read(&cpu_buffer->record_disabled))
		goto out;

	event_length = rb_calculate_event_length(length);
	event = rb_reserve_next_event(cpu_buffer,
				      RINGBUF_TYPE_DATA, event_length);
	if (!event)
		goto out;

	body = rb_event_data(event);

	memcpy(body, data, length);

	rb_commit(cpu_buffer, event);

	ret = 0;
 out:
1590
	ftrace_preempt_enable(resched);
S
Steven Rostedt 已提交
1591 1592 1593

	return ret;
}
1594
EXPORT_SYMBOL_GPL(ring_buffer_write);
S
Steven Rostedt 已提交
1595

1596
static int rb_per_cpu_empty(struct ring_buffer_per_cpu *cpu_buffer)
S
Steven Rostedt 已提交
1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607
{
	struct buffer_page *reader = cpu_buffer->reader_page;
	struct buffer_page *head = cpu_buffer->head_page;
	struct buffer_page *commit = cpu_buffer->commit_page;

	return reader->read == rb_page_commit(reader) &&
		(commit == reader ||
		 (commit == head &&
		  head->read == rb_page_commit(commit)));
}

S
Steven Rostedt 已提交
1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620
/**
 * ring_buffer_record_disable - stop all writes into the buffer
 * @buffer: The ring buffer to stop writes to.
 *
 * This prevents all writes to the buffer. Any attempt to write
 * to the buffer after this will fail and return NULL.
 *
 * The caller should call synchronize_sched() after this.
 */
void ring_buffer_record_disable(struct ring_buffer *buffer)
{
	atomic_inc(&buffer->record_disabled);
}
1621
EXPORT_SYMBOL_GPL(ring_buffer_record_disable);
S
Steven Rostedt 已提交
1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633

/**
 * ring_buffer_record_enable - enable writes to the buffer
 * @buffer: The ring buffer to enable writes
 *
 * Note, multiple disables will need the same number of enables
 * to truely enable the writing (much like preempt_disable).
 */
void ring_buffer_record_enable(struct ring_buffer *buffer)
{
	atomic_dec(&buffer->record_disabled);
}
1634
EXPORT_SYMBOL_GPL(ring_buffer_record_enable);
S
Steven Rostedt 已提交
1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649

/**
 * ring_buffer_record_disable_cpu - stop all writes into the cpu_buffer
 * @buffer: The ring buffer to stop writes to.
 * @cpu: The CPU buffer to stop
 *
 * This prevents all writes to the buffer. Any attempt to write
 * to the buffer after this will fail and return NULL.
 *
 * The caller should call synchronize_sched() after this.
 */
void ring_buffer_record_disable_cpu(struct ring_buffer *buffer, int cpu)
{
	struct ring_buffer_per_cpu *cpu_buffer;

1650
	if (!cpumask_test_cpu(cpu, buffer->cpumask))
1651
		return;
S
Steven Rostedt 已提交
1652 1653 1654 1655

	cpu_buffer = buffer->buffers[cpu];
	atomic_inc(&cpu_buffer->record_disabled);
}
1656
EXPORT_SYMBOL_GPL(ring_buffer_record_disable_cpu);
S
Steven Rostedt 已提交
1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669

/**
 * ring_buffer_record_enable_cpu - enable writes to the buffer
 * @buffer: The ring buffer to enable writes
 * @cpu: The CPU to enable.
 *
 * Note, multiple disables will need the same number of enables
 * to truely enable the writing (much like preempt_disable).
 */
void ring_buffer_record_enable_cpu(struct ring_buffer *buffer, int cpu)
{
	struct ring_buffer_per_cpu *cpu_buffer;

1670
	if (!cpumask_test_cpu(cpu, buffer->cpumask))
1671
		return;
S
Steven Rostedt 已提交
1672 1673 1674 1675

	cpu_buffer = buffer->buffers[cpu];
	atomic_dec(&cpu_buffer->record_disabled);
}
1676
EXPORT_SYMBOL_GPL(ring_buffer_record_enable_cpu);
S
Steven Rostedt 已提交
1677 1678 1679 1680 1681 1682 1683 1684 1685

/**
 * ring_buffer_entries_cpu - get the number of entries in a cpu buffer
 * @buffer: The ring buffer
 * @cpu: The per CPU buffer to get the entries from.
 */
unsigned long ring_buffer_entries_cpu(struct ring_buffer *buffer, int cpu)
{
	struct ring_buffer_per_cpu *cpu_buffer;
1686
	unsigned long ret;
S
Steven Rostedt 已提交
1687

1688
	if (!cpumask_test_cpu(cpu, buffer->cpumask))
1689
		return 0;
S
Steven Rostedt 已提交
1690 1691

	cpu_buffer = buffer->buffers[cpu];
1692 1693 1694
	ret = cpu_buffer->entries;

	return ret;
S
Steven Rostedt 已提交
1695
}
1696
EXPORT_SYMBOL_GPL(ring_buffer_entries_cpu);
S
Steven Rostedt 已提交
1697 1698 1699 1700 1701 1702 1703 1704 1705

/**
 * ring_buffer_overrun_cpu - get the number of overruns in a cpu_buffer
 * @buffer: The ring buffer
 * @cpu: The per CPU buffer to get the number of overruns from
 */
unsigned long ring_buffer_overrun_cpu(struct ring_buffer *buffer, int cpu)
{
	struct ring_buffer_per_cpu *cpu_buffer;
1706
	unsigned long ret;
S
Steven Rostedt 已提交
1707

1708
	if (!cpumask_test_cpu(cpu, buffer->cpumask))
1709
		return 0;
S
Steven Rostedt 已提交
1710 1711

	cpu_buffer = buffer->buffers[cpu];
1712 1713 1714
	ret = cpu_buffer->overrun;

	return ret;
S
Steven Rostedt 已提交
1715
}
1716
EXPORT_SYMBOL_GPL(ring_buffer_overrun_cpu);
S
Steven Rostedt 已提交
1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738

/**
 * ring_buffer_entries - get the number of entries in a buffer
 * @buffer: The ring buffer
 *
 * Returns the total number of entries in the ring buffer
 * (all CPU entries)
 */
unsigned long ring_buffer_entries(struct ring_buffer *buffer)
{
	struct ring_buffer_per_cpu *cpu_buffer;
	unsigned long entries = 0;
	int cpu;

	/* if you care about this being correct, lock the buffer */
	for_each_buffer_cpu(buffer, cpu) {
		cpu_buffer = buffer->buffers[cpu];
		entries += cpu_buffer->entries;
	}

	return entries;
}
1739
EXPORT_SYMBOL_GPL(ring_buffer_entries);
S
Steven Rostedt 已提交
1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761

/**
 * ring_buffer_overrun_cpu - get the number of overruns in buffer
 * @buffer: The ring buffer
 *
 * Returns the total number of overruns in the ring buffer
 * (all CPU entries)
 */
unsigned long ring_buffer_overruns(struct ring_buffer *buffer)
{
	struct ring_buffer_per_cpu *cpu_buffer;
	unsigned long overruns = 0;
	int cpu;

	/* if you care about this being correct, lock the buffer */
	for_each_buffer_cpu(buffer, cpu) {
		cpu_buffer = buffer->buffers[cpu];
		overruns += cpu_buffer->overrun;
	}

	return overruns;
}
1762
EXPORT_SYMBOL_GPL(ring_buffer_overruns);
S
Steven Rostedt 已提交
1763

1764
static void rb_iter_reset(struct ring_buffer_iter *iter)
S
Steven Rostedt 已提交
1765 1766 1767
{
	struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;

1768 1769 1770
	/* Iterator usage is expected to have record disabled */
	if (list_empty(&cpu_buffer->reader_page->list)) {
		iter->head_page = cpu_buffer->head_page;
1771
		iter->head = cpu_buffer->head_page->read;
1772 1773
	} else {
		iter->head_page = cpu_buffer->reader_page;
1774
		iter->head = cpu_buffer->reader_page->read;
1775 1776 1777 1778
	}
	if (iter->head)
		iter->read_stamp = cpu_buffer->read_stamp;
	else
1779
		iter->read_stamp = iter->head_page->page->time_stamp;
1780
}
S
Steven Rostedt 已提交
1781

1782 1783 1784 1785 1786 1787 1788 1789 1790
/**
 * ring_buffer_iter_reset - reset an iterator
 * @iter: The iterator to reset
 *
 * Resets the iterator, so that it will start from the beginning
 * again.
 */
void ring_buffer_iter_reset(struct ring_buffer_iter *iter)
{
1791
	struct ring_buffer_per_cpu *cpu_buffer;
1792 1793
	unsigned long flags;

1794 1795 1796 1797 1798
	if (!iter)
		return;

	cpu_buffer = iter->cpu_buffer;

1799 1800
	spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
	rb_iter_reset(iter);
S
Steven Rostedt 已提交
1801
	spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
S
Steven Rostedt 已提交
1802
}
1803
EXPORT_SYMBOL_GPL(ring_buffer_iter_reset);
S
Steven Rostedt 已提交
1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814

/**
 * ring_buffer_iter_empty - check if an iterator has no more to read
 * @iter: The iterator to check
 */
int ring_buffer_iter_empty(struct ring_buffer_iter *iter)
{
	struct ring_buffer_per_cpu *cpu_buffer;

	cpu_buffer = iter->cpu_buffer;

S
Steven Rostedt 已提交
1815 1816
	return iter->head_page == cpu_buffer->commit_page &&
		iter->head == rb_commit_index(cpu_buffer);
S
Steven Rostedt 已提交
1817
}
1818
EXPORT_SYMBOL_GPL(ring_buffer_iter_empty);
S
Steven Rostedt 已提交
1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881

static void
rb_update_read_stamp(struct ring_buffer_per_cpu *cpu_buffer,
		     struct ring_buffer_event *event)
{
	u64 delta;

	switch (event->type) {
	case RINGBUF_TYPE_PADDING:
		return;

	case RINGBUF_TYPE_TIME_EXTEND:
		delta = event->array[0];
		delta <<= TS_SHIFT;
		delta += event->time_delta;
		cpu_buffer->read_stamp += delta;
		return;

	case RINGBUF_TYPE_TIME_STAMP:
		/* FIXME: not implemented */
		return;

	case RINGBUF_TYPE_DATA:
		cpu_buffer->read_stamp += event->time_delta;
		return;

	default:
		BUG();
	}
	return;
}

static void
rb_update_iter_read_stamp(struct ring_buffer_iter *iter,
			  struct ring_buffer_event *event)
{
	u64 delta;

	switch (event->type) {
	case RINGBUF_TYPE_PADDING:
		return;

	case RINGBUF_TYPE_TIME_EXTEND:
		delta = event->array[0];
		delta <<= TS_SHIFT;
		delta += event->time_delta;
		iter->read_stamp += delta;
		return;

	case RINGBUF_TYPE_TIME_STAMP:
		/* FIXME: not implemented */
		return;

	case RINGBUF_TYPE_DATA:
		iter->read_stamp += event->time_delta;
		return;

	default:
		BUG();
	}
	return;
}

1882 1883
static struct buffer_page *
rb_get_reader_page(struct ring_buffer_per_cpu *cpu_buffer)
S
Steven Rostedt 已提交
1884
{
1885 1886
	struct buffer_page *reader = NULL;
	unsigned long flags;
1887
	int nr_loops = 0;
1888

1889 1890
	local_irq_save(flags);
	__raw_spin_lock(&cpu_buffer->lock);
1891 1892

 again:
1893 1894 1895 1896 1897 1898
	/*
	 * This should normally only loop twice. But because the
	 * start of the reader inserts an empty page, it causes
	 * a case where we will loop three times. There should be no
	 * reason to loop four times (that I know of).
	 */
S
Steven Rostedt 已提交
1899
	if (RB_WARN_ON(cpu_buffer, ++nr_loops > 3)) {
1900 1901 1902 1903
		reader = NULL;
		goto out;
	}

1904 1905 1906
	reader = cpu_buffer->reader_page;

	/* If there's more to read, return this page */
S
Steven Rostedt 已提交
1907
	if (cpu_buffer->reader_page->read < rb_page_size(reader))
1908 1909 1910
		goto out;

	/* Never should we have an index greater than the size */
S
Steven Rostedt 已提交
1911 1912 1913
	if (RB_WARN_ON(cpu_buffer,
		       cpu_buffer->reader_page->read > rb_page_size(reader)))
		goto out;
1914 1915 1916

	/* check if we caught up to the tail */
	reader = NULL;
S
Steven Rostedt 已提交
1917
	if (cpu_buffer->commit_page == cpu_buffer->reader_page)
1918
		goto out;
S
Steven Rostedt 已提交
1919 1920

	/*
1921 1922
	 * Splice the empty reader page into the list around the head.
	 * Reset the reader page to size zero.
S
Steven Rostedt 已提交
1923 1924
	 */

1925 1926 1927
	reader = cpu_buffer->head_page;
	cpu_buffer->reader_page->list.next = reader->list.next;
	cpu_buffer->reader_page->list.prev = reader->list.prev;
S
Steven Rostedt 已提交
1928 1929

	local_set(&cpu_buffer->reader_page->write, 0);
1930
	local_set(&cpu_buffer->reader_page->page->commit, 0);
S
Steven Rostedt 已提交
1931

1932 1933 1934
	/* Make the reader page now replace the head */
	reader->list.prev->next = &cpu_buffer->reader_page->list;
	reader->list.next->prev = &cpu_buffer->reader_page->list;
S
Steven Rostedt 已提交
1935 1936

	/*
1937 1938
	 * If the tail is on the reader, then we must set the head
	 * to the inserted page, otherwise we set it one before.
S
Steven Rostedt 已提交
1939
	 */
1940
	cpu_buffer->head_page = cpu_buffer->reader_page;
S
Steven Rostedt 已提交
1941

S
Steven Rostedt 已提交
1942
	if (cpu_buffer->commit_page != reader)
1943 1944 1945 1946 1947 1948 1949 1950 1951
		rb_inc_page(cpu_buffer, &cpu_buffer->head_page);

	/* Finally update the reader page to the new head */
	cpu_buffer->reader_page = reader;
	rb_reset_reader_page(cpu_buffer);

	goto again;

 out:
1952 1953
	__raw_spin_unlock(&cpu_buffer->lock);
	local_irq_restore(flags);
1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964

	return reader;
}

static void rb_advance_reader(struct ring_buffer_per_cpu *cpu_buffer)
{
	struct ring_buffer_event *event;
	struct buffer_page *reader;
	unsigned length;

	reader = rb_get_reader_page(cpu_buffer);
S
Steven Rostedt 已提交
1965

1966
	/* This function should not be called when buffer is empty */
S
Steven Rostedt 已提交
1967 1968
	if (RB_WARN_ON(cpu_buffer, !reader))
		return;
S
Steven Rostedt 已提交
1969

1970 1971 1972 1973 1974 1975 1976 1977
	event = rb_reader_event(cpu_buffer);

	if (event->type == RINGBUF_TYPE_DATA)
		cpu_buffer->entries--;

	rb_update_read_stamp(cpu_buffer, event);

	length = rb_event_length(event);
1978
	cpu_buffer->reader_page->read += length;
S
Steven Rostedt 已提交
1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993
}

static void rb_advance_iter(struct ring_buffer_iter *iter)
{
	struct ring_buffer *buffer;
	struct ring_buffer_per_cpu *cpu_buffer;
	struct ring_buffer_event *event;
	unsigned length;

	cpu_buffer = iter->cpu_buffer;
	buffer = cpu_buffer->buffer;

	/*
	 * Check if we are at the end of the buffer.
	 */
S
Steven Rostedt 已提交
1994
	if (iter->head >= rb_page_size(iter->head_page)) {
S
Steven Rostedt 已提交
1995 1996 1997
		if (RB_WARN_ON(buffer,
			       iter->head_page == cpu_buffer->commit_page))
			return;
1998
		rb_inc_iter(iter);
S
Steven Rostedt 已提交
1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009
		return;
	}

	event = rb_iter_head_event(iter);

	length = rb_event_length(event);

	/*
	 * This should not be called to advance the header if we are
	 * at the tail of the buffer.
	 */
S
Steven Rostedt 已提交
2010
	if (RB_WARN_ON(cpu_buffer,
2011
		       (iter->head_page == cpu_buffer->commit_page) &&
S
Steven Rostedt 已提交
2012 2013
		       (iter->head + length > rb_commit_index(cpu_buffer))))
		return;
S
Steven Rostedt 已提交
2014 2015 2016 2017 2018 2019

	rb_update_iter_read_stamp(iter, event);

	iter->head += length;

	/* check for end of page padding */
S
Steven Rostedt 已提交
2020 2021
	if ((iter->head >= rb_page_size(iter->head_page)) &&
	    (iter->head_page != cpu_buffer->commit_page))
S
Steven Rostedt 已提交
2022 2023 2024
		rb_advance_iter(iter);
}

S
Steven Rostedt 已提交
2025 2026
static struct ring_buffer_event *
rb_buffer_peek(struct ring_buffer *buffer, int cpu, u64 *ts)
S
Steven Rostedt 已提交
2027 2028 2029
{
	struct ring_buffer_per_cpu *cpu_buffer;
	struct ring_buffer_event *event;
2030
	struct buffer_page *reader;
2031
	int nr_loops = 0;
S
Steven Rostedt 已提交
2032 2033 2034 2035

	cpu_buffer = buffer->buffers[cpu];

 again:
2036 2037 2038 2039 2040 2041 2042 2043
	/*
	 * We repeat when a timestamp is encountered. It is possible
	 * to get multiple timestamps from an interrupt entering just
	 * as one timestamp is about to be written. The max times
	 * that this can happen is the number of nested interrupts we
	 * can have.  Nesting 10 deep of interrupts is clearly
	 * an anomaly.
	 */
S
Steven Rostedt 已提交
2044
	if (RB_WARN_ON(cpu_buffer, ++nr_loops > 10))
2045 2046
		return NULL;

2047 2048
	reader = rb_get_reader_page(cpu_buffer);
	if (!reader)
S
Steven Rostedt 已提交
2049 2050
		return NULL;

2051
	event = rb_reader_event(cpu_buffer);
S
Steven Rostedt 已提交
2052 2053 2054

	switch (event->type) {
	case RINGBUF_TYPE_PADDING:
S
Steven Rostedt 已提交
2055
		RB_WARN_ON(cpu_buffer, 1);
2056 2057
		rb_advance_reader(cpu_buffer);
		return NULL;
S
Steven Rostedt 已提交
2058 2059 2060

	case RINGBUF_TYPE_TIME_EXTEND:
		/* Internal data, OK to advance */
2061
		rb_advance_reader(cpu_buffer);
S
Steven Rostedt 已提交
2062 2063 2064 2065
		goto again;

	case RINGBUF_TYPE_TIME_STAMP:
		/* FIXME: not implemented */
2066
		rb_advance_reader(cpu_buffer);
S
Steven Rostedt 已提交
2067 2068 2069 2070 2071
		goto again;

	case RINGBUF_TYPE_DATA:
		if (ts) {
			*ts = cpu_buffer->read_stamp + event->time_delta;
2072 2073
			ring_buffer_normalize_time_stamp(buffer,
							 cpu_buffer->cpu, ts);
S
Steven Rostedt 已提交
2074 2075 2076 2077 2078 2079 2080 2081 2082
		}
		return event;

	default:
		BUG();
	}

	return NULL;
}
2083
EXPORT_SYMBOL_GPL(ring_buffer_peek);
S
Steven Rostedt 已提交
2084

S
Steven Rostedt 已提交
2085 2086
static struct ring_buffer_event *
rb_iter_peek(struct ring_buffer_iter *iter, u64 *ts)
S
Steven Rostedt 已提交
2087 2088 2089 2090
{
	struct ring_buffer *buffer;
	struct ring_buffer_per_cpu *cpu_buffer;
	struct ring_buffer_event *event;
2091
	int nr_loops = 0;
S
Steven Rostedt 已提交
2092 2093 2094 2095 2096 2097 2098 2099

	if (ring_buffer_iter_empty(iter))
		return NULL;

	cpu_buffer = iter->cpu_buffer;
	buffer = cpu_buffer->buffer;

 again:
2100 2101 2102 2103 2104 2105 2106 2107
	/*
	 * We repeat when a timestamp is encountered. It is possible
	 * to get multiple timestamps from an interrupt entering just
	 * as one timestamp is about to be written. The max times
	 * that this can happen is the number of nested interrupts we
	 * can have. Nesting 10 deep of interrupts is clearly
	 * an anomaly.
	 */
S
Steven Rostedt 已提交
2108
	if (RB_WARN_ON(cpu_buffer, ++nr_loops > 10))
2109 2110
		return NULL;

S
Steven Rostedt 已提交
2111 2112 2113 2114 2115 2116 2117
	if (rb_per_cpu_empty(cpu_buffer))
		return NULL;

	event = rb_iter_head_event(iter);

	switch (event->type) {
	case RINGBUF_TYPE_PADDING:
2118
		rb_inc_iter(iter);
S
Steven Rostedt 已提交
2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133
		goto again;

	case RINGBUF_TYPE_TIME_EXTEND:
		/* Internal data, OK to advance */
		rb_advance_iter(iter);
		goto again;

	case RINGBUF_TYPE_TIME_STAMP:
		/* FIXME: not implemented */
		rb_advance_iter(iter);
		goto again;

	case RINGBUF_TYPE_DATA:
		if (ts) {
			*ts = iter->read_stamp + event->time_delta;
2134 2135
			ring_buffer_normalize_time_stamp(buffer,
							 cpu_buffer->cpu, ts);
S
Steven Rostedt 已提交
2136 2137 2138 2139 2140 2141 2142 2143 2144
		}
		return event;

	default:
		BUG();
	}

	return NULL;
}
2145
EXPORT_SYMBOL_GPL(ring_buffer_iter_peek);
S
Steven Rostedt 已提交
2146

S
Steven Rostedt 已提交
2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159
/**
 * ring_buffer_peek - peek at the next event to be read
 * @buffer: The ring buffer to read
 * @cpu: The cpu to peak at
 * @ts: The timestamp counter of this event.
 *
 * This will return the event that will be read next, but does
 * not consume the data.
 */
struct ring_buffer_event *
ring_buffer_peek(struct ring_buffer *buffer, int cpu, u64 *ts)
{
	struct ring_buffer_per_cpu *cpu_buffer = buffer->buffers[cpu];
2160
	struct ring_buffer_event *event;
S
Steven Rostedt 已提交
2161 2162
	unsigned long flags;

2163
	if (!cpumask_test_cpu(cpu, buffer->cpumask))
2164
		return NULL;
2165

S
Steven Rostedt 已提交
2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194
	spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
	event = rb_buffer_peek(buffer, cpu, ts);
	spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);

	return event;
}

/**
 * ring_buffer_iter_peek - peek at the next event to be read
 * @iter: The ring buffer iterator
 * @ts: The timestamp counter of this event.
 *
 * This will return the event that will be read next, but does
 * not increment the iterator.
 */
struct ring_buffer_event *
ring_buffer_iter_peek(struct ring_buffer_iter *iter, u64 *ts)
{
	struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;
	struct ring_buffer_event *event;
	unsigned long flags;

	spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
	event = rb_iter_peek(iter, ts);
	spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);

	return event;
}

S
Steven Rostedt 已提交
2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205
/**
 * ring_buffer_consume - return an event and consume it
 * @buffer: The ring buffer to get the next event from
 *
 * Returns the next event in the ring buffer, and that event is consumed.
 * Meaning, that sequential reads will keep returning a different event,
 * and eventually empty the ring buffer if the producer is slower.
 */
struct ring_buffer_event *
ring_buffer_consume(struct ring_buffer *buffer, int cpu, u64 *ts)
{
2206 2207
	struct ring_buffer_per_cpu *cpu_buffer;
	struct ring_buffer_event *event = NULL;
S
Steven Rostedt 已提交
2208
	unsigned long flags;
S
Steven Rostedt 已提交
2209

2210 2211 2212
	/* might be called in atomic */
	preempt_disable();

2213
	if (!cpumask_test_cpu(cpu, buffer->cpumask))
2214
		goto out;
S
Steven Rostedt 已提交
2215

2216
	cpu_buffer = buffer->buffers[cpu];
S
Steven Rostedt 已提交
2217 2218 2219
	spin_lock_irqsave(&cpu_buffer->reader_lock, flags);

	event = rb_buffer_peek(buffer, cpu, ts);
S
Steven Rostedt 已提交
2220
	if (!event)
2221
		goto out_unlock;
S
Steven Rostedt 已提交
2222

2223
	rb_advance_reader(cpu_buffer);
S
Steven Rostedt 已提交
2224

2225
 out_unlock:
S
Steven Rostedt 已提交
2226 2227
	spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);

2228 2229 2230
 out:
	preempt_enable();

S
Steven Rostedt 已提交
2231 2232
	return event;
}
2233
EXPORT_SYMBOL_GPL(ring_buffer_consume);
S
Steven Rostedt 已提交
2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250

/**
 * ring_buffer_read_start - start a non consuming read of the buffer
 * @buffer: The ring buffer to read from
 * @cpu: The cpu buffer to iterate over
 *
 * This starts up an iteration through the buffer. It also disables
 * the recording to the buffer until the reading is finished.
 * This prevents the reading from being corrupted. This is not
 * a consuming read, so a producer is not expected.
 *
 * Must be paired with ring_buffer_finish.
 */
struct ring_buffer_iter *
ring_buffer_read_start(struct ring_buffer *buffer, int cpu)
{
	struct ring_buffer_per_cpu *cpu_buffer;
2251
	struct ring_buffer_iter *iter;
2252
	unsigned long flags;
S
Steven Rostedt 已提交
2253

2254
	if (!cpumask_test_cpu(cpu, buffer->cpumask))
2255
		return NULL;
S
Steven Rostedt 已提交
2256 2257 2258

	iter = kmalloc(sizeof(*iter), GFP_KERNEL);
	if (!iter)
2259
		return NULL;
S
Steven Rostedt 已提交
2260 2261 2262 2263 2264 2265 2266 2267

	cpu_buffer = buffer->buffers[cpu];

	iter->cpu_buffer = cpu_buffer;

	atomic_inc(&cpu_buffer->record_disabled);
	synchronize_sched();

S
Steven Rostedt 已提交
2268
	spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
2269
	__raw_spin_lock(&cpu_buffer->lock);
2270
	rb_iter_reset(iter);
2271
	__raw_spin_unlock(&cpu_buffer->lock);
S
Steven Rostedt 已提交
2272
	spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
S
Steven Rostedt 已提交
2273 2274 2275

	return iter;
}
2276
EXPORT_SYMBOL_GPL(ring_buffer_read_start);
S
Steven Rostedt 已提交
2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292

/**
 * ring_buffer_finish - finish reading the iterator of the buffer
 * @iter: The iterator retrieved by ring_buffer_start
 *
 * This re-enables the recording to the buffer, and frees the
 * iterator.
 */
void
ring_buffer_read_finish(struct ring_buffer_iter *iter)
{
	struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;

	atomic_dec(&cpu_buffer->record_disabled);
	kfree(iter);
}
2293
EXPORT_SYMBOL_GPL(ring_buffer_read_finish);
S
Steven Rostedt 已提交
2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305

/**
 * ring_buffer_read - read the next item in the ring buffer by the iterator
 * @iter: The ring buffer iterator
 * @ts: The time stamp of the event read.
 *
 * This reads the next event in the ring buffer and increments the iterator.
 */
struct ring_buffer_event *
ring_buffer_read(struct ring_buffer_iter *iter, u64 *ts)
{
	struct ring_buffer_event *event;
S
Steven Rostedt 已提交
2306 2307
	struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;
	unsigned long flags;
S
Steven Rostedt 已提交
2308

S
Steven Rostedt 已提交
2309 2310
	spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
	event = rb_iter_peek(iter, ts);
S
Steven Rostedt 已提交
2311
	if (!event)
S
Steven Rostedt 已提交
2312
		goto out;
S
Steven Rostedt 已提交
2313 2314

	rb_advance_iter(iter);
S
Steven Rostedt 已提交
2315 2316
 out:
	spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
S
Steven Rostedt 已提交
2317 2318 2319

	return event;
}
2320
EXPORT_SYMBOL_GPL(ring_buffer_read);
S
Steven Rostedt 已提交
2321 2322 2323 2324 2325 2326 2327 2328 2329

/**
 * ring_buffer_size - return the size of the ring buffer (in bytes)
 * @buffer: The ring buffer.
 */
unsigned long ring_buffer_size(struct ring_buffer *buffer)
{
	return BUF_PAGE_SIZE * buffer->pages;
}
2330
EXPORT_SYMBOL_GPL(ring_buffer_size);
S
Steven Rostedt 已提交
2331 2332 2333 2334 2335 2336

static void
rb_reset_cpu(struct ring_buffer_per_cpu *cpu_buffer)
{
	cpu_buffer->head_page
		= list_entry(cpu_buffer->pages.next, struct buffer_page, list);
S
Steven Rostedt 已提交
2337
	local_set(&cpu_buffer->head_page->write, 0);
2338
	local_set(&cpu_buffer->head_page->page->commit, 0);
2339

2340
	cpu_buffer->head_page->read = 0;
S
Steven Rostedt 已提交
2341 2342 2343 2344 2345 2346

	cpu_buffer->tail_page = cpu_buffer->head_page;
	cpu_buffer->commit_page = cpu_buffer->head_page;

	INIT_LIST_HEAD(&cpu_buffer->reader_page->list);
	local_set(&cpu_buffer->reader_page->write, 0);
2347
	local_set(&cpu_buffer->reader_page->page->commit, 0);
2348
	cpu_buffer->reader_page->read = 0;
S
Steven Rostedt 已提交
2349 2350 2351

	cpu_buffer->overrun = 0;
	cpu_buffer->entries = 0;
2352 2353 2354

	cpu_buffer->write_stamp = 0;
	cpu_buffer->read_stamp = 0;
S
Steven Rostedt 已提交
2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366
}

/**
 * ring_buffer_reset_cpu - reset a ring buffer per CPU buffer
 * @buffer: The ring buffer to reset a per cpu buffer of
 * @cpu: The CPU buffer to be reset
 */
void ring_buffer_reset_cpu(struct ring_buffer *buffer, int cpu)
{
	struct ring_buffer_per_cpu *cpu_buffer = buffer->buffers[cpu];
	unsigned long flags;

2367
	if (!cpumask_test_cpu(cpu, buffer->cpumask))
2368
		return;
S
Steven Rostedt 已提交
2369

S
Steven Rostedt 已提交
2370 2371
	spin_lock_irqsave(&cpu_buffer->reader_lock, flags);

2372
	__raw_spin_lock(&cpu_buffer->lock);
S
Steven Rostedt 已提交
2373 2374 2375

	rb_reset_cpu(cpu_buffer);

2376
	__raw_spin_unlock(&cpu_buffer->lock);
S
Steven Rostedt 已提交
2377 2378

	spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
S
Steven Rostedt 已提交
2379
}
2380
EXPORT_SYMBOL_GPL(ring_buffer_reset_cpu);
S
Steven Rostedt 已提交
2381 2382 2383 2384 2385 2386 2387 2388 2389 2390

/**
 * ring_buffer_reset - reset a ring buffer
 * @buffer: The ring buffer to reset all cpu buffers
 */
void ring_buffer_reset(struct ring_buffer *buffer)
{
	int cpu;

	for_each_buffer_cpu(buffer, cpu)
2391
		ring_buffer_reset_cpu(buffer, cpu);
S
Steven Rostedt 已提交
2392
}
2393
EXPORT_SYMBOL_GPL(ring_buffer_reset);
S
Steven Rostedt 已提交
2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409

/**
 * rind_buffer_empty - is the ring buffer empty?
 * @buffer: The ring buffer to test
 */
int ring_buffer_empty(struct ring_buffer *buffer)
{
	struct ring_buffer_per_cpu *cpu_buffer;
	int cpu;

	/* yes this is racy, but if you don't like the race, lock the buffer */
	for_each_buffer_cpu(buffer, cpu) {
		cpu_buffer = buffer->buffers[cpu];
		if (!rb_per_cpu_empty(cpu_buffer))
			return 0;
	}
2410

S
Steven Rostedt 已提交
2411 2412
	return 1;
}
2413
EXPORT_SYMBOL_GPL(ring_buffer_empty);
S
Steven Rostedt 已提交
2414 2415 2416 2417 2418 2419 2420 2421 2422

/**
 * ring_buffer_empty_cpu - is a cpu buffer of a ring buffer empty?
 * @buffer: The ring buffer
 * @cpu: The CPU buffer to test
 */
int ring_buffer_empty_cpu(struct ring_buffer *buffer, int cpu)
{
	struct ring_buffer_per_cpu *cpu_buffer;
2423
	int ret;
S
Steven Rostedt 已提交
2424

2425
	if (!cpumask_test_cpu(cpu, buffer->cpumask))
2426
		return 1;
S
Steven Rostedt 已提交
2427 2428

	cpu_buffer = buffer->buffers[cpu];
2429 2430 2431 2432
	ret = rb_per_cpu_empty(cpu_buffer);


	return ret;
S
Steven Rostedt 已提交
2433
}
2434
EXPORT_SYMBOL_GPL(ring_buffer_empty_cpu);
S
Steven Rostedt 已提交
2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450

/**
 * ring_buffer_swap_cpu - swap a CPU buffer between two ring buffers
 * @buffer_a: One buffer to swap with
 * @buffer_b: The other buffer to swap with
 *
 * This function is useful for tracers that want to take a "snapshot"
 * of a CPU buffer and has another back up buffer lying around.
 * it is expected that the tracer handles the cpu buffer not being
 * used at the moment.
 */
int ring_buffer_swap_cpu(struct ring_buffer *buffer_a,
			 struct ring_buffer *buffer_b, int cpu)
{
	struct ring_buffer_per_cpu *cpu_buffer_a;
	struct ring_buffer_per_cpu *cpu_buffer_b;
2451 2452
	int ret = -EINVAL;

2453 2454
	if (!cpumask_test_cpu(cpu, buffer_a->cpumask) ||
	    !cpumask_test_cpu(cpu, buffer_b->cpumask))
2455
		goto out;
S
Steven Rostedt 已提交
2456 2457

	/* At least make sure the two buffers are somewhat the same */
2458
	if (buffer_a->pages != buffer_b->pages)
2459 2460 2461
		goto out;

	ret = -EAGAIN;
S
Steven Rostedt 已提交
2462

2463
	if (ring_buffer_flags != RB_BUFFERS_ON)
2464
		goto out;
2465 2466

	if (atomic_read(&buffer_a->record_disabled))
2467
		goto out;
2468 2469

	if (atomic_read(&buffer_b->record_disabled))
2470
		goto out;
2471

S
Steven Rostedt 已提交
2472 2473 2474
	cpu_buffer_a = buffer_a->buffers[cpu];
	cpu_buffer_b = buffer_b->buffers[cpu];

2475
	if (atomic_read(&cpu_buffer_a->record_disabled))
2476
		goto out;
2477 2478

	if (atomic_read(&cpu_buffer_b->record_disabled))
2479
		goto out;
2480

S
Steven Rostedt 已提交
2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498
	/*
	 * We can't do a synchronize_sched here because this
	 * function can be called in atomic context.
	 * Normally this will be called from the same CPU as cpu.
	 * If not it's up to the caller to protect this.
	 */
	atomic_inc(&cpu_buffer_a->record_disabled);
	atomic_inc(&cpu_buffer_b->record_disabled);

	buffer_a->buffers[cpu] = cpu_buffer_b;
	buffer_b->buffers[cpu] = cpu_buffer_a;

	cpu_buffer_b->buffer = buffer_a;
	cpu_buffer_a->buffer = buffer_b;

	atomic_dec(&cpu_buffer_a->record_disabled);
	atomic_dec(&cpu_buffer_b->record_disabled);

2499 2500 2501
	ret = 0;
out:
	return ret;
S
Steven Rostedt 已提交
2502
}
2503
EXPORT_SYMBOL_GPL(ring_buffer_swap_cpu);
S
Steven Rostedt 已提交
2504

S
Steven Rostedt 已提交
2505
static void rb_remove_entries(struct ring_buffer_per_cpu *cpu_buffer,
2506 2507
			      struct buffer_data_page *bpage,
			      unsigned int offset)
S
Steven Rostedt 已提交
2508 2509 2510 2511 2512
{
	struct ring_buffer_event *event;
	unsigned long head;

	__raw_spin_lock(&cpu_buffer->lock);
2513
	for (head = offset; head < local_read(&bpage->commit);
S
Steven Rostedt 已提交
2514 2515
	     head += rb_event_length(event)) {

2516
		event = __rb_data_page_index(bpage, head);
S
Steven Rostedt 已提交
2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543
		if (RB_WARN_ON(cpu_buffer, rb_null_event(event)))
			return;
		/* Only count data entries */
		if (event->type != RINGBUF_TYPE_DATA)
			continue;
		cpu_buffer->entries--;
	}
	__raw_spin_unlock(&cpu_buffer->lock);
}

/**
 * ring_buffer_alloc_read_page - allocate a page to read from buffer
 * @buffer: the buffer to allocate for.
 *
 * This function is used in conjunction with ring_buffer_read_page.
 * When reading a full page from the ring buffer, these functions
 * can be used to speed up the process. The calling function should
 * allocate a few pages first with this function. Then when it
 * needs to get pages from the ring buffer, it passes the result
 * of this function into ring_buffer_read_page, which will swap
 * the page that was allocated, with the read page of the buffer.
 *
 * Returns:
 *  The page allocated, or NULL on error.
 */
void *ring_buffer_alloc_read_page(struct ring_buffer *buffer)
{
2544
	struct buffer_data_page *bpage;
2545
	unsigned long addr;
S
Steven Rostedt 已提交
2546 2547 2548 2549 2550

	addr = __get_free_page(GFP_KERNEL);
	if (!addr)
		return NULL;

2551
	bpage = (void *)addr;
S
Steven Rostedt 已提交
2552

2553 2554
	rb_init_page(bpage);

2555
	return bpage;
S
Steven Rostedt 已提交
2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573
}

/**
 * ring_buffer_free_read_page - free an allocated read page
 * @buffer: the buffer the page was allocate for
 * @data: the page to free
 *
 * Free a page allocated from ring_buffer_alloc_read_page.
 */
void ring_buffer_free_read_page(struct ring_buffer *buffer, void *data)
{
	free_page((unsigned long)data);
}

/**
 * ring_buffer_read_page - extract a page from the ring buffer
 * @buffer: buffer to extract from
 * @data_page: the page to use allocated from ring_buffer_alloc_read_page
2574
 * @len: amount to extract
S
Steven Rostedt 已提交
2575 2576 2577 2578 2579 2580 2581 2582 2583
 * @cpu: the cpu of the buffer to extract
 * @full: should the extraction only happen when the page is full.
 *
 * This function will pull out a page from the ring buffer and consume it.
 * @data_page must be the address of the variable that was returned
 * from ring_buffer_alloc_read_page. This is because the page might be used
 * to swap with a page in the ring buffer.
 *
 * for example:
L
Lai Jiangshan 已提交
2584
 *	rpage = ring_buffer_alloc_read_page(buffer);
S
Steven Rostedt 已提交
2585 2586
 *	if (!rpage)
 *		return error;
2587
 *	ret = ring_buffer_read_page(buffer, &rpage, len, cpu, 0);
2588 2589
 *	if (ret >= 0)
 *		process_page(rpage, ret);
S
Steven Rostedt 已提交
2590 2591 2592 2593 2594 2595 2596 2597 2598 2599
 *
 * When @full is set, the function will not return true unless
 * the writer is off the reader page.
 *
 * Note: it is up to the calling functions to handle sleeps and wakeups.
 *  The ring buffer can be used anywhere in the kernel and can not
 *  blindly call wake_up. The layer that uses the ring buffer must be
 *  responsible for that.
 *
 * Returns:
2600 2601
 *  >=0 if data has been transferred, returns the offset of consumed data.
 *  <0 if no data has been transferred.
S
Steven Rostedt 已提交
2602 2603
 */
int ring_buffer_read_page(struct ring_buffer *buffer,
2604
			  void **data_page, size_t len, int cpu, int full)
S
Steven Rostedt 已提交
2605 2606 2607
{
	struct ring_buffer_per_cpu *cpu_buffer = buffer->buffers[cpu];
	struct ring_buffer_event *event;
2608
	struct buffer_data_page *bpage;
2609
	struct buffer_page *reader;
S
Steven Rostedt 已提交
2610
	unsigned long flags;
2611
	unsigned int commit;
2612
	unsigned int read;
2613
	u64 save_timestamp;
2614
	int ret = -1;
S
Steven Rostedt 已提交
2615

2616 2617 2618
	if (!cpumask_test_cpu(cpu, buffer->cpumask))
		goto out;

2619 2620 2621 2622 2623
	/*
	 * If len is not big enough to hold the page header, then
	 * we can not copy anything.
	 */
	if (len <= BUF_PAGE_HDR_SIZE)
2624
		goto out;
2625 2626 2627

	len -= BUF_PAGE_HDR_SIZE;

S
Steven Rostedt 已提交
2628
	if (!data_page)
2629
		goto out;
S
Steven Rostedt 已提交
2630

2631 2632
	bpage = *data_page;
	if (!bpage)
2633
		goto out;
S
Steven Rostedt 已提交
2634 2635 2636

	spin_lock_irqsave(&cpu_buffer->reader_lock, flags);

2637 2638
	reader = rb_get_reader_page(cpu_buffer);
	if (!reader)
2639
		goto out_unlock;
S
Steven Rostedt 已提交
2640

2641 2642 2643 2644
	event = rb_reader_event(cpu_buffer);

	read = reader->read;
	commit = rb_page_commit(reader);
2645

S
Steven Rostedt 已提交
2646
	/*
2647 2648 2649 2650 2651
	 * If this page has been partially read or
	 * if len is not big enough to read the rest of the page or
	 * a writer is still on the page, then
	 * we must copy the data from the page to the buffer.
	 * Otherwise, we can simply swap the page with the one passed in.
S
Steven Rostedt 已提交
2652
	 */
2653
	if (read || (len < (commit - read)) ||
2654
	    cpu_buffer->reader_page == cpu_buffer->commit_page) {
2655
		struct buffer_data_page *rpage = cpu_buffer->reader_page->page;
2656 2657
		unsigned int rpos = read;
		unsigned int pos = 0;
2658
		unsigned int size;
S
Steven Rostedt 已提交
2659 2660

		if (full)
2661
			goto out_unlock;
S
Steven Rostedt 已提交
2662

2663 2664 2665 2666 2667 2668
		if (len > (commit - read))
			len = (commit - read);

		size = rb_event_length(event);

		if (len < size)
2669
			goto out_unlock;
2670

2671 2672 2673
		/* save the current timestamp, since the user will need it */
		save_timestamp = cpu_buffer->read_stamp;

2674 2675
		/* Need to copy one event at a time */
		do {
2676
			memcpy(bpage->data + pos, rpage->data + rpos, size);
2677 2678 2679 2680

			len -= size;

			rb_advance_reader(cpu_buffer);
2681 2682
			rpos = reader->read;
			pos += size;
2683 2684 2685 2686

			event = rb_reader_event(cpu_buffer);
			size = rb_event_length(event);
		} while (len > size);
2687 2688

		/* update bpage */
2689
		local_set(&bpage->commit, pos);
2690
		bpage->time_stamp = save_timestamp;
2691

2692 2693
		/* we copied everything to the beginning */
		read = 0;
S
Steven Rostedt 已提交
2694 2695
	} else {
		/* swap the pages */
2696
		rb_init_page(bpage);
2697 2698 2699 2700
		bpage = reader->page;
		reader->page = *data_page;
		local_set(&reader->write, 0);
		reader->read = 0;
2701
		*data_page = bpage;
2702 2703 2704

		/* update the entry counter */
		rb_remove_entries(cpu_buffer, bpage, read);
S
Steven Rostedt 已提交
2705
	}
2706
	ret = read;
S
Steven Rostedt 已提交
2707

2708
 out_unlock:
S
Steven Rostedt 已提交
2709 2710
	spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);

2711
 out:
S
Steven Rostedt 已提交
2712 2713 2714
	return ret;
}

2715 2716 2717 2718
static ssize_t
rb_simple_read(struct file *filp, char __user *ubuf,
	       size_t cnt, loff_t *ppos)
{
2719
	unsigned long *p = filp->private_data;
2720 2721 2722
	char buf[64];
	int r;

2723 2724 2725 2726
	if (test_bit(RB_BUFFERS_DISABLED_BIT, p))
		r = sprintf(buf, "permanently disabled\n");
	else
		r = sprintf(buf, "%d\n", test_bit(RB_BUFFERS_ON_BIT, p));
2727 2728 2729 2730 2731 2732 2733 2734

	return simple_read_from_buffer(ubuf, cnt, ppos, buf, r);
}

static ssize_t
rb_simple_write(struct file *filp, const char __user *ubuf,
		size_t cnt, loff_t *ppos)
{
2735
	unsigned long *p = filp->private_data;
2736
	char buf[64];
2737
	unsigned long val;
2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751
	int ret;

	if (cnt >= sizeof(buf))
		return -EINVAL;

	if (copy_from_user(&buf, ubuf, cnt))
		return -EFAULT;

	buf[cnt] = 0;

	ret = strict_strtoul(buf, 10, &val);
	if (ret < 0)
		return ret;

2752 2753 2754 2755
	if (val)
		set_bit(RB_BUFFERS_ON_BIT, p);
	else
		clear_bit(RB_BUFFERS_ON_BIT, p);
2756 2757 2758 2759 2760 2761

	(*ppos)++;

	return cnt;
}

2762
static const struct file_operations rb_simple_fops = {
2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776
	.open		= tracing_open_generic,
	.read		= rb_simple_read,
	.write		= rb_simple_write,
};


static __init int rb_init_debugfs(void)
{
	struct dentry *d_tracer;
	struct dentry *entry;

	d_tracer = tracing_init_dentry();

	entry = debugfs_create_file("tracing_on", 0644, d_tracer,
2777
				    &ring_buffer_flags, &rb_simple_fops);
2778 2779 2780 2781 2782 2783 2784
	if (!entry)
		pr_warning("Could not create debugfs 'tracing_on' entry\n");

	return 0;
}

fs_initcall(rb_init_debugfs);
2785

2786
#ifdef CONFIG_HOTPLUG_CPU
2787 2788
static int rb_cpu_notify(struct notifier_block *self,
			 unsigned long action, void *hcpu)
2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823
{
	struct ring_buffer *buffer =
		container_of(self, struct ring_buffer, cpu_notify);
	long cpu = (long)hcpu;

	switch (action) {
	case CPU_UP_PREPARE:
	case CPU_UP_PREPARE_FROZEN:
		if (cpu_isset(cpu, *buffer->cpumask))
			return NOTIFY_OK;

		buffer->buffers[cpu] =
			rb_allocate_cpu_buffer(buffer, cpu);
		if (!buffer->buffers[cpu]) {
			WARN(1, "failed to allocate ring buffer on CPU %ld\n",
			     cpu);
			return NOTIFY_OK;
		}
		smp_wmb();
		cpu_set(cpu, *buffer->cpumask);
		break;
	case CPU_DOWN_PREPARE:
	case CPU_DOWN_PREPARE_FROZEN:
		/*
		 * Do nothing.
		 *  If we were to free the buffer, then the user would
		 *  lose any trace that was in the buffer.
		 */
		break;
	default:
		break;
	}
	return NOTIFY_OK;
}
#endif