ring_buffer.c 79.4 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>
13
#include <linux/kmemcheck.h>
S
Steven Rostedt 已提交
14 15 16 17 18 19
#include <linux/module.h>
#include <linux/percpu.h>
#include <linux/mutex.h>
#include <linux/init.h>
#include <linux/hash.h>
#include <linux/list.h>
20
#include <linux/cpu.h>
S
Steven Rostedt 已提交
21 22
#include <linux/fs.h>

23 24
#include "trace.h"

25 26 27 28 29 30 31
/*
 * The ring buffer header is special. We must manually up keep it.
 */
int ring_buffer_print_entry_header(struct trace_seq *s)
{
	int ret;

32 33
	ret = trace_seq_printf(s, "# compressed entry header\n");
	ret = trace_seq_printf(s, "\ttype_len    :    5 bits\n");
34 35 36 37 38 39 40
	ret = trace_seq_printf(s, "\ttime_delta  :   27 bits\n");
	ret = trace_seq_printf(s, "\tarray       :   32 bits\n");
	ret = trace_seq_printf(s, "\n");
	ret = trace_seq_printf(s, "\tpadding     : type == %d\n",
			       RINGBUF_TYPE_PADDING);
	ret = trace_seq_printf(s, "\ttime_extend : type == %d\n",
			       RINGBUF_TYPE_TIME_EXTEND);
41 42
	ret = trace_seq_printf(s, "\tdata max type_len  == %d\n",
			       RINGBUF_TYPE_DATA_TYPE_LEN_MAX);
43 44 45 46

	return ret;
}

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 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114
/*
 * 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.
 *
 */

115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153
/*
 * 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,
};

154
static unsigned long ring_buffer_flags __read_mostly = RB_BUFFERS_ON;
155

156 157
#define BUF_PAGE_HDR_SIZE offsetof(struct buffer_data_page, data)

158 159 160 161 162 163 164 165
/**
 * tracing_on - enable all tracing buffers
 *
 * This function enables all tracing buffers that may have been
 * disabled with tracing_off.
 */
void tracing_on(void)
{
166
	set_bit(RB_BUFFERS_ON_BIT, &ring_buffer_flags);
167
}
168
EXPORT_SYMBOL_GPL(tracing_on);
169 170 171 172 173 174 175 176 177 178 179

/**
 * 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)
{
180 181
	clear_bit(RB_BUFFERS_ON_BIT, &ring_buffer_flags);
}
182
EXPORT_SYMBOL_GPL(tracing_off);
183 184 185 186 187

/**
 * tracing_off_permanent - permanently disable ring buffers
 *
 * This function, once called, will disable all ring buffers
W
Wenji Huang 已提交
188
 * permanently.
189 190 191 192
 */
void tracing_off_permanent(void)
{
	set_bit(RB_BUFFERS_DISABLED_BIT, &ring_buffer_flags);
193 194
}

195 196 197 198 199 200 201 202 203
/**
 * 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);

204 205
#include "trace.h"

206
#define RB_EVNT_HDR_SIZE (offsetof(struct ring_buffer_event, array))
207
#define RB_ALIGNMENT		4U
208
#define RB_MAX_SMALL_DATA	(RB_ALIGNMENT * RINGBUF_TYPE_DATA_TYPE_LEN_MAX)
209
#define RB_EVNT_MIN_SIZE	8U	/* two 32bit words */
210 211 212

/* define RINGBUF_TYPE_DATA for 'case RINGBUF_TYPE_DATA:' */
#define RINGBUF_TYPE_DATA 0 ... RINGBUF_TYPE_DATA_TYPE_LEN_MAX
S
Steven Rostedt 已提交
213 214 215 216 217 218

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

219 220
static inline int rb_null_event(struct ring_buffer_event *event)
{
221 222
	return event->type_len == RINGBUF_TYPE_PADDING
			&& event->time_delta == 0;
223 224 225 226
}

static inline int rb_discarded_event(struct ring_buffer_event *event)
{
227
	return event->type_len == RINGBUF_TYPE_PADDING && event->time_delta;
228 229 230 231
}

static void rb_event_set_padding(struct ring_buffer_event *event)
{
232
	event->type_len = RINGBUF_TYPE_PADDING;
233 234 235
	event->time_delta = 0;
}

236
static unsigned
237
rb_event_data_length(struct ring_buffer_event *event)
S
Steven Rostedt 已提交
238 239 240
{
	unsigned length;

241 242
	if (event->type_len)
		length = event->type_len * RB_ALIGNMENT;
243 244 245 246 247 248 249 250 251
	else
		length = event->array[0];
	return length + RB_EVNT_HDR_SIZE;
}

/* inline for ring buffer fast paths */
static unsigned
rb_event_length(struct ring_buffer_event *event)
{
252
	switch (event->type_len) {
S
Steven Rostedt 已提交
253
	case RINGBUF_TYPE_PADDING:
254 255 256
		if (rb_null_event(event))
			/* undefined */
			return -1;
257
		return  event->array[0] + RB_EVNT_HDR_SIZE;
S
Steven Rostedt 已提交
258 259 260 261 262 263 264 265

	case RINGBUF_TYPE_TIME_EXTEND:
		return RB_LEN_TIME_EXTEND;

	case RINGBUF_TYPE_TIME_STAMP:
		return RB_LEN_TIME_STAMP;

	case RINGBUF_TYPE_DATA:
266
		return rb_event_data_length(event);
S
Steven Rostedt 已提交
267 268 269 270 271 272 273 274 275 276 277 278 279
	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)
{
280
	unsigned length = rb_event_length(event);
281
	if (event->type_len > RINGBUF_TYPE_DATA_TYPE_LEN_MAX)
282 283 284 285 286
		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 已提交
287
}
288
EXPORT_SYMBOL_GPL(ring_buffer_event_length);
S
Steven Rostedt 已提交
289 290

/* inline for ring buffer fast paths */
291
static void *
S
Steven Rostedt 已提交
292 293
rb_event_data(struct ring_buffer_event *event)
{
294
	BUG_ON(event->type_len > RINGBUF_TYPE_DATA_TYPE_LEN_MAX);
S
Steven Rostedt 已提交
295
	/* If length is in len field, then array[0] has the data */
296
	if (event->type_len)
S
Steven Rostedt 已提交
297 298 299 300 301 302 303 304 305 306 307 308 309
		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);
}
310
EXPORT_SYMBOL_GPL(ring_buffer_event_data);
S
Steven Rostedt 已提交
311 312

#define for_each_buffer_cpu(buffer, cpu)		\
313
	for_each_cpu(cpu, buffer->cpumask)
S
Steven Rostedt 已提交
314 315 316 317 318

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

319
struct buffer_data_page {
320
	u64		 time_stamp;	/* page time stamp */
W
Wenji Huang 已提交
321
	local_t		 commit;	/* write committed index */
322 323 324 325
	unsigned char	 data[];	/* data of buffer page */
};

struct buffer_page {
326
	struct list_head list;		/* list of buffer pages */
327
	local_t		 write;		/* index for next write */
328
	unsigned	 read;		/* index for next read */
329
	local_t		 entries;	/* entries on this page */
330
	struct buffer_data_page *page;	/* Actual data page */
S
Steven Rostedt 已提交
331 332
};

333
static void rb_init_page(struct buffer_data_page *bpage)
334
{
335
	local_set(&bpage->commit, 0);
336 337
}

338 339 340 341 342 343
/**
 * 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.
 */
344 345
size_t ring_buffer_page_len(void *page)
{
346 347
	return local_read(&((struct buffer_data_page *)page)->commit)
		+ BUF_PAGE_HDR_SIZE;
348 349
}

350 351 352 353
/*
 * Also stolen from mm/slob.c. Thanks to Mathieu Desnoyers for pointing
 * this issue out.
 */
354
static void free_buffer_page(struct buffer_page *bpage)
355
{
356
	free_page((unsigned long)bpage->page);
357
	kfree(bpage);
358 359
}

S
Steven Rostedt 已提交
360 361 362 363 364 365 366 367 368 369
/*
 * 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;
}

370
#define BUF_PAGE_SIZE (PAGE_SIZE - BUF_PAGE_HDR_SIZE)
S
Steven Rostedt 已提交
371

372 373 374
/* Max payload is BUF_PAGE_SIZE - header (8bytes) */
#define BUF_MAX_DATA_SIZE (BUF_PAGE_SIZE - (sizeof(u32) * 2))

375 376 377
/* Max number of timestamps that can fit on a page */
#define RB_TIMESTAMPS_PER_PAGE	(BUF_PAGE_SIZE / RB_LEN_TIME_STAMP)

378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399
int ring_buffer_print_page_header(struct trace_seq *s)
{
	struct buffer_data_page field;
	int ret;

	ret = trace_seq_printf(s, "\tfield: u64 timestamp;\t"
			       "offset:0;\tsize:%u;\n",
			       (unsigned int)sizeof(field.time_stamp));

	ret = trace_seq_printf(s, "\tfield: local_t commit;\t"
			       "offset:%u;\tsize:%u;\n",
			       (unsigned int)offsetof(typeof(field), commit),
			       (unsigned int)sizeof(field.commit));

	ret = trace_seq_printf(s, "\tfield: char data;\t"
			       "offset:%u;\tsize:%u;\n",
			       (unsigned int)offsetof(typeof(field), data),
			       (unsigned int)BUF_PAGE_SIZE);

	return ret;
}

S
Steven Rostedt 已提交
400 401 402 403 404 405
/*
 * head_page == tail_page && head == tail then buffer is empty.
 */
struct ring_buffer_per_cpu {
	int				cpu;
	struct ring_buffer		*buffer;
S
Steven Rostedt 已提交
406
	spinlock_t			reader_lock; /* serialize readers */
407
	raw_spinlock_t			lock;
S
Steven Rostedt 已提交
408
	struct lock_class_key		lock_key;
409
	struct list_head		*pages;
410 411
	struct buffer_page		*head_page;	/* read from head */
	struct buffer_page		*tail_page;	/* write to tail */
W
Wenji Huang 已提交
412
	struct buffer_page		*commit_page;	/* committed pages */
413
	struct buffer_page		*reader_page;
414 415
	unsigned long			nmi_dropped;
	unsigned long			commit_overrun;
S
Steven Rostedt 已提交
416
	unsigned long			overrun;
417 418
	unsigned long			read;
	local_t				entries;
419 420
	local_t				committing;
	local_t				commits;
S
Steven Rostedt 已提交
421 422 423 424 425 426 427 428 429 430
	u64				write_stamp;
	u64				read_stamp;
	atomic_t			record_disabled;
};

struct ring_buffer {
	unsigned			pages;
	unsigned			flags;
	int				cpus;
	atomic_t			record_disabled;
431
	cpumask_var_t			cpumask;
S
Steven Rostedt 已提交
432

433 434
	struct lock_class_key		*reader_lock_key;

S
Steven Rostedt 已提交
435 436 437
	struct mutex			mutex;

	struct ring_buffer_per_cpu	**buffers;
438

439
#ifdef CONFIG_HOTPLUG_CPU
440 441
	struct notifier_block		cpu_notify;
#endif
442
	u64				(*clock)(void);
S
Steven Rostedt 已提交
443 444 445 446 447 448 449 450 451
};

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

452
/* buffer may be either ring_buffer or ring_buffer_per_cpu */
S
Steven Rostedt 已提交
453
#define RB_WARN_ON(buffer, cond)				\
S
Steven Rostedt 已提交
454 455 456
	({							\
		int _____ret = unlikely(cond);			\
		if (_____ret) {					\
S
Steven Rostedt 已提交
457 458 459
			atomic_inc(&buffer->record_disabled);	\
			WARN_ON(1);				\
		}						\
S
Steven Rostedt 已提交
460 461
		_____ret;					\
	})
462

463 464 465
/* Up this if you want to test the TIME_EXTENTS and normalization */
#define DEBUG_SHIFT 0

466 467 468 469 470 471
static inline u64 rb_time_stamp(struct ring_buffer *buffer, int cpu)
{
	/* shift to debug/test normalization and TIME_EXTENTS */
	return buffer->clock() << DEBUG_SHIFT;
}

472 473 474 475 476
u64 ring_buffer_time_stamp(struct ring_buffer *buffer, int cpu)
{
	u64 time;

	preempt_disable_notrace();
477
	time = rb_time_stamp(buffer, cpu);
478 479 480 481 482 483 484 485 486 487 488 489 490 491
	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 已提交
492 493 494 495
/**
 * check_pages - integrity check of buffer pages
 * @cpu_buffer: CPU buffer with pages to test
 *
W
Wenji Huang 已提交
496
 * As a safety measure we check to make sure the data pages have not
S
Steven Rostedt 已提交
497 498 499 500
 * been corrupted.
 */
static int rb_check_pages(struct ring_buffer_per_cpu *cpu_buffer)
{
501
	struct list_head *head = cpu_buffer->pages;
502
	struct buffer_page *bpage, *tmp;
S
Steven Rostedt 已提交
503

S
Steven Rostedt 已提交
504 505 506 507
	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 已提交
508

509
	list_for_each_entry_safe(bpage, tmp, head, list) {
S
Steven Rostedt 已提交
510
		if (RB_WARN_ON(cpu_buffer,
511
			       bpage->list.next->prev != &bpage->list))
S
Steven Rostedt 已提交
512 513
			return -1;
		if (RB_WARN_ON(cpu_buffer,
514
			       bpage->list.prev->next != &bpage->list))
S
Steven Rostedt 已提交
515
			return -1;
S
Steven Rostedt 已提交
516 517 518 519 520 521 522 523
	}

	return 0;
}

static int rb_allocate_pages(struct ring_buffer_per_cpu *cpu_buffer,
			     unsigned nr_pages)
{
524
	struct buffer_page *bpage, *tmp;
S
Steven Rostedt 已提交
525 526 527 528
	unsigned long addr;
	LIST_HEAD(pages);
	unsigned i;

529 530
	WARN_ON(!nr_pages);

S
Steven Rostedt 已提交
531
	for (i = 0; i < nr_pages; i++) {
532
		bpage = kzalloc_node(ALIGN(sizeof(*bpage), cache_line_size()),
S
Steven Rostedt 已提交
533
				    GFP_KERNEL, cpu_to_node(cpu_buffer->cpu));
534
		if (!bpage)
535
			goto free_pages;
536
		list_add(&bpage->list, &pages);
537

S
Steven Rostedt 已提交
538 539 540
		addr = __get_free_page(GFP_KERNEL);
		if (!addr)
			goto free_pages;
541 542
		bpage->page = (void *)addr;
		rb_init_page(bpage->page);
S
Steven Rostedt 已提交
543 544
	}

545 546 547 548 549 550 551
	/*
	 * The ring buffer page list is a circular list that does not
	 * start and end with a list head. All page list items point to
	 * other pages.
	 */
	cpu_buffer->pages = pages.next;
	list_del(&pages);
S
Steven Rostedt 已提交
552 553 554 555 556 557

	rb_check_pages(cpu_buffer);

	return 0;

 free_pages:
558 559 560
	list_for_each_entry_safe(bpage, tmp, &pages, list) {
		list_del_init(&bpage->list);
		free_buffer_page(bpage);
S
Steven Rostedt 已提交
561 562 563 564 565 566 567 568
	}
	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;
569
	struct buffer_page *bpage;
570
	unsigned long addr;
S
Steven Rostedt 已提交
571 572 573 574 575 576 577 578 579
	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 已提交
580
	spin_lock_init(&cpu_buffer->reader_lock);
581
	lockdep_set_class(&cpu_buffer->reader_lock, buffer->reader_lock_key);
582
	cpu_buffer->lock = (raw_spinlock_t)__RAW_SPIN_LOCK_UNLOCKED;
S
Steven Rostedt 已提交
583

584
	bpage = kzalloc_node(ALIGN(sizeof(*bpage), cache_line_size()),
585
			    GFP_KERNEL, cpu_to_node(cpu));
586
	if (!bpage)
587 588
		goto fail_free_buffer;

589
	cpu_buffer->reader_page = bpage;
590 591
	addr = __get_free_page(GFP_KERNEL);
	if (!addr)
592
		goto fail_free_reader;
593 594
	bpage->page = (void *)addr;
	rb_init_page(bpage->page);
595

596 597
	INIT_LIST_HEAD(&cpu_buffer->reader_page->list);

S
Steven Rostedt 已提交
598 599
	ret = rb_allocate_pages(cpu_buffer, buffer->pages);
	if (ret < 0)
600
		goto fail_free_reader;
S
Steven Rostedt 已提交
601 602

	cpu_buffer->head_page
603
		= list_entry(cpu_buffer->pages, struct buffer_page, list);
S
Steven Rostedt 已提交
604
	cpu_buffer->tail_page = cpu_buffer->commit_page = cpu_buffer->head_page;
S
Steven Rostedt 已提交
605 606 607

	return cpu_buffer;

608 609 610
 fail_free_reader:
	free_buffer_page(cpu_buffer->reader_page);

S
Steven Rostedt 已提交
611 612 613 614 615 616 617
 fail_free_buffer:
	kfree(cpu_buffer);
	return NULL;
}

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

621 622
	free_buffer_page(cpu_buffer->reader_page);

623 624 625 626 627 628
	if (head) {
		list_for_each_entry_safe(bpage, tmp, head, list) {
			list_del_init(&bpage->list);
			free_buffer_page(bpage);
		}
		bpage = list_entry(head, struct buffer_page, list);
629
		free_buffer_page(bpage);
S
Steven Rostedt 已提交
630
	}
631

S
Steven Rostedt 已提交
632 633 634
	kfree(cpu_buffer);
}

635
#ifdef CONFIG_HOTPLUG_CPU
636 637
static int rb_cpu_notify(struct notifier_block *self,
			 unsigned long action, void *hcpu);
638 639
#endif

S
Steven Rostedt 已提交
640 641
/**
 * ring_buffer_alloc - allocate a new ring_buffer
642
 * @size: the size in bytes per cpu that is needed.
S
Steven Rostedt 已提交
643 644 645 646 647 648 649
 * @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.
 */
650 651
struct ring_buffer *__ring_buffer_alloc(unsigned long size, unsigned flags,
					struct lock_class_key *key)
S
Steven Rostedt 已提交
652 653 654 655 656 657 658 659 660 661 662
{
	struct ring_buffer *buffer;
	int bsize;
	int cpu;

	/* keep it in its own cache line */
	buffer = kzalloc(ALIGN(sizeof(*buffer), cache_line_size()),
			 GFP_KERNEL);
	if (!buffer)
		return NULL;

663 664 665
	if (!alloc_cpumask_var(&buffer->cpumask, GFP_KERNEL))
		goto fail_free_buffer;

S
Steven Rostedt 已提交
666 667
	buffer->pages = DIV_ROUND_UP(size, BUF_PAGE_SIZE);
	buffer->flags = flags;
668
	buffer->clock = trace_clock_local;
669
	buffer->reader_lock_key = key;
S
Steven Rostedt 已提交
670 671

	/* need at least two pages */
672 673
	if (buffer->pages < 2)
		buffer->pages = 2;
S
Steven Rostedt 已提交
674

675 676 677 678 679 680
	/*
	 * 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
681 682
	get_online_cpus();
	cpumask_copy(buffer->cpumask, cpu_online_mask);
683 684 685
#else
	cpumask_copy(buffer->cpumask, cpu_possible_mask);
#endif
S
Steven Rostedt 已提交
686 687 688 689 690 691
	buffer->cpus = nr_cpu_ids;

	bsize = sizeof(void *) * nr_cpu_ids;
	buffer->buffers = kzalloc(ALIGN(bsize, cache_line_size()),
				  GFP_KERNEL);
	if (!buffer->buffers)
692
		goto fail_free_cpumask;
S
Steven Rostedt 已提交
693 694 695 696 697 698 699 700

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

701
#ifdef CONFIG_HOTPLUG_CPU
702 703 704 705 706 707
	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 已提交
708 709 710 711 712 713 714 715 716 717 718
	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);

719 720
 fail_free_cpumask:
	free_cpumask_var(buffer->cpumask);
721
	put_online_cpus();
722

S
Steven Rostedt 已提交
723 724 725 726
 fail_free_buffer:
	kfree(buffer);
	return NULL;
}
727
EXPORT_SYMBOL_GPL(__ring_buffer_alloc);
S
Steven Rostedt 已提交
728 729 730 731 732 733 734 735 736 737

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

738 739
	get_online_cpus();

740
#ifdef CONFIG_HOTPLUG_CPU
741 742 743
	unregister_cpu_notifier(&buffer->cpu_notify);
#endif

S
Steven Rostedt 已提交
744 745 746
	for_each_buffer_cpu(buffer, cpu)
		rb_free_cpu_buffer(buffer->buffers[cpu]);

747 748
	put_online_cpus();

749 750
	free_cpumask_var(buffer->cpumask);

S
Steven Rostedt 已提交
751 752
	kfree(buffer);
}
753
EXPORT_SYMBOL_GPL(ring_buffer_free);
S
Steven Rostedt 已提交
754

755 756 757 758 759 760
void ring_buffer_set_clock(struct ring_buffer *buffer,
			   u64 (*clock)(void))
{
	buffer->clock = clock;
}

S
Steven Rostedt 已提交
761 762 763 764 765
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)
{
766
	struct buffer_page *bpage;
S
Steven Rostedt 已提交
767 768 769 770 771 772 773
	struct list_head *p;
	unsigned i;

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

	for (i = 0; i < nr_pages; i++) {
774
		if (RB_WARN_ON(cpu_buffer, list_empty(cpu_buffer->pages)))
S
Steven Rostedt 已提交
775
			return;
776
		p = cpu_buffer->pages->next;
777 778 779
		bpage = list_entry(p, struct buffer_page, list);
		list_del_init(&bpage->list);
		free_buffer_page(bpage);
S
Steven Rostedt 已提交
780
	}
781
	if (RB_WARN_ON(cpu_buffer, list_empty(cpu_buffer->pages)))
S
Steven Rostedt 已提交
782
		return;
S
Steven Rostedt 已提交
783 784 785 786 787 788 789 790 791 792 793 794 795

	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)
{
796
	struct buffer_page *bpage;
S
Steven Rostedt 已提交
797 798 799 800 801 802 803
	struct list_head *p;
	unsigned i;

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

	for (i = 0; i < nr_pages; i++) {
S
Steven Rostedt 已提交
804 805
		if (RB_WARN_ON(cpu_buffer, list_empty(pages)))
			return;
S
Steven Rostedt 已提交
806
		p = pages->next;
807 808
		bpage = list_entry(p, struct buffer_page, list);
		list_del_init(&bpage->list);
809
		list_add_tail(&bpage->list, cpu_buffer->pages);
S
Steven Rostedt 已提交
810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835
	}
	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;
836
	struct buffer_page *bpage, *tmp;
S
Steven Rostedt 已提交
837 838 839 840 841
	unsigned long buffer_size;
	unsigned long addr;
	LIST_HEAD(pages);
	int i, cpu;

842 843 844 845 846 847
	/*
	 * Always succeed at resizing a non-existent buffer:
	 */
	if (!buffer)
		return size;

S
Steven Rostedt 已提交
848 849 850 851 852 853 854 855 856 857 858 859
	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);
860
	get_online_cpus();
S
Steven Rostedt 已提交
861 862 863 864 865 866

	nr_pages = DIV_ROUND_UP(size, BUF_PAGE_SIZE);

	if (size < buffer_size) {

		/* easy case, just free pages */
867 868
		if (RB_WARN_ON(buffer, nr_pages >= buffer->pages))
			goto out_fail;
S
Steven Rostedt 已提交
869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886

		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;
	 */
887 888
	if (RB_WARN_ON(buffer, nr_pages <= buffer->pages))
		goto out_fail;
889

S
Steven Rostedt 已提交
890 891 892 893
	new_pages = nr_pages - buffer->pages;

	for_each_buffer_cpu(buffer, cpu) {
		for (i = 0; i < new_pages; i++) {
894
			bpage = kzalloc_node(ALIGN(sizeof(*bpage),
895 896
						  cache_line_size()),
					    GFP_KERNEL, cpu_to_node(cpu));
897
			if (!bpage)
898
				goto free_pages;
899
			list_add(&bpage->list, &pages);
S
Steven Rostedt 已提交
900 901 902
			addr = __get_free_page(GFP_KERNEL);
			if (!addr)
				goto free_pages;
903 904
			bpage->page = (void *)addr;
			rb_init_page(bpage->page);
S
Steven Rostedt 已提交
905 906 907 908 909 910 911 912
		}
	}

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

913 914
	if (RB_WARN_ON(buffer, !list_empty(&pages)))
		goto out_fail;
S
Steven Rostedt 已提交
915 916 917

 out:
	buffer->pages = nr_pages;
918
	put_online_cpus();
S
Steven Rostedt 已提交
919 920 921 922 923
	mutex_unlock(&buffer->mutex);

	return size;

 free_pages:
924 925 926
	list_for_each_entry_safe(bpage, tmp, &pages, list) {
		list_del_init(&bpage->list);
		free_buffer_page(bpage);
S
Steven Rostedt 已提交
927
	}
928
	put_online_cpus();
929
	mutex_unlock(&buffer->mutex);
S
Steven Rostedt 已提交
930
	return -ENOMEM;
931 932 933 934 935 936 937 938 939

	/*
	 * 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 已提交
940
}
941
EXPORT_SYMBOL_GPL(ring_buffer_resize);
S
Steven Rostedt 已提交
942

S
Steven Rostedt 已提交
943
static inline void *
944
__rb_data_page_index(struct buffer_data_page *bpage, unsigned index)
S
Steven Rostedt 已提交
945
{
946
	return bpage->data + index;
S
Steven Rostedt 已提交
947 948
}

949
static inline void *__rb_page_index(struct buffer_page *bpage, unsigned index)
S
Steven Rostedt 已提交
950
{
951
	return bpage->page->data + index;
S
Steven Rostedt 已提交
952 953 954
}

static inline struct ring_buffer_event *
955
rb_reader_event(struct ring_buffer_per_cpu *cpu_buffer)
S
Steven Rostedt 已提交
956
{
957 958 959 960 961 962 963 964 965
	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 已提交
966 967 968 969 970
}

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

S
Steven Rostedt 已提交
974 975 976 977 978 979 980
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)
{
981
	return local_read(&bpage->page->commit);
S
Steven Rostedt 已提交
982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000
}

/* 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 已提交
1001
static inline void rb_inc_page(struct ring_buffer_per_cpu *cpu_buffer,
1002
			       struct buffer_page **bpage)
S
Steven Rostedt 已提交
1003
{
1004
	struct list_head *p = (*bpage)->list.next;
S
Steven Rostedt 已提交
1005

1006
	*bpage = list_entry(p, struct buffer_page, list);
S
Steven Rostedt 已提交
1007 1008
}

S
Steven Rostedt 已提交
1009 1010 1011 1012 1013
static inline unsigned
rb_event_index(struct ring_buffer_event *event)
{
	unsigned long addr = (unsigned long)event;

1014
	return (addr & ~PAGE_MASK) - BUF_PAGE_HDR_SIZE;
S
Steven Rostedt 已提交
1015 1016
}

1017
static inline int
1018 1019
rb_event_is_commit(struct ring_buffer_per_cpu *cpu_buffer,
		   struct ring_buffer_event *event)
S
Steven Rostedt 已提交
1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030
{
	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;
}

1031
static void
S
Steven Rostedt 已提交
1032
rb_set_commit_to_write(struct ring_buffer_per_cpu *cpu_buffer)
S
Steven Rostedt 已提交
1033
{
S
Steven Rostedt 已提交
1034 1035 1036 1037 1038 1039 1040 1041
	/*
	 * 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.
	 */
1042
 again:
S
Steven Rostedt 已提交
1043
	while (cpu_buffer->commit_page != cpu_buffer->tail_page) {
1044
		cpu_buffer->commit_page->page->commit =
S
Steven Rostedt 已提交
1045 1046
			cpu_buffer->commit_page->write;
		rb_inc_page(cpu_buffer, &cpu_buffer->commit_page);
1047 1048
		cpu_buffer->write_stamp =
			cpu_buffer->commit_page->page->time_stamp;
S
Steven Rostedt 已提交
1049 1050 1051 1052 1053
		/* add barrier to keep gcc from optimizing too much */
		barrier();
	}
	while (rb_commit_index(cpu_buffer) !=
	       rb_page_write(cpu_buffer->commit_page)) {
1054
		cpu_buffer->commit_page->page->commit =
S
Steven Rostedt 已提交
1055 1056 1057
			cpu_buffer->commit_page->write;
		barrier();
	}
1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068

	/* 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 已提交
1069 1070
}

1071
static void rb_reset_reader_page(struct ring_buffer_per_cpu *cpu_buffer)
S
Steven Rostedt 已提交
1072
{
1073
	cpu_buffer->read_stamp = cpu_buffer->reader_page->page->time_stamp;
1074
	cpu_buffer->reader_page->read = 0;
1075 1076
}

1077
static void rb_inc_iter(struct ring_buffer_iter *iter)
1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091
{
	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);

1092
	iter->read_stamp = iter->head_page->page->time_stamp;
S
Steven Rostedt 已提交
1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106
	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.
 */
1107
static void
S
Steven Rostedt 已提交
1108 1109 1110
rb_update_event(struct ring_buffer_event *event,
			 unsigned type, unsigned length)
{
1111
	event->type_len = type;
S
Steven Rostedt 已提交
1112 1113 1114 1115 1116 1117 1118 1119

	switch (type) {

	case RINGBUF_TYPE_PADDING:
	case RINGBUF_TYPE_TIME_EXTEND:
	case RINGBUF_TYPE_TIME_STAMP:
		break;

1120
	case 0:
S
Steven Rostedt 已提交
1121
		length -= RB_EVNT_HDR_SIZE;
1122
		if (length > RB_MAX_SMALL_DATA)
S
Steven Rostedt 已提交
1123
			event->array[0] = length;
1124 1125
		else
			event->type_len = DIV_ROUND_UP(length, RB_ALIGNMENT);
S
Steven Rostedt 已提交
1126 1127 1128 1129 1130 1131
		break;
	default:
		BUG();
	}
}

1132
static unsigned rb_calculate_event_length(unsigned length)
S
Steven Rostedt 已提交
1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148
{
	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;
}

1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165
static inline void
rb_reset_tail(struct ring_buffer_per_cpu *cpu_buffer,
	      struct buffer_page *tail_page,
	      unsigned long tail, unsigned long length)
{
	struct ring_buffer_event *event;

	/*
	 * Only the event that crossed the page boundary
	 * must fill the old tail_page with padding.
	 */
	if (tail >= BUF_PAGE_SIZE) {
		local_sub(length, &tail_page->write);
		return;
	}

	event = __rb_page_index(tail_page, tail);
1166
	kmemcheck_annotate_bitfield(event, bitfield);
1167 1168 1169 1170 1171 1172 1173 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

	/*
	 * If this event is bigger than the minimum size, then
	 * we need to be careful that we don't subtract the
	 * write counter enough to allow another writer to slip
	 * in on this page.
	 * We put in a discarded commit instead, to make sure
	 * that this space is not used again.
	 *
	 * If we are less than the minimum size, we don't need to
	 * worry about it.
	 */
	if (tail > (BUF_PAGE_SIZE - RB_EVNT_MIN_SIZE)) {
		/* No room for any events */

		/* Mark the rest of the page with padding */
		rb_event_set_padding(event);

		/* Set the write back to the previous setting */
		local_sub(length, &tail_page->write);
		return;
	}

	/* Put in a discarded event */
	event->array[0] = (BUF_PAGE_SIZE - tail) - RB_EVNT_HDR_SIZE;
	event->type_len = RINGBUF_TYPE_PADDING;
	/* time delta must be non zero */
	event->time_delta = 1;
	/* Account for this as an entry */
	local_inc(&tail_page->entries);
	local_inc(&cpu_buffer->entries);

	/* Set write to end of buffer */
	length = (tail + length) - BUF_PAGE_SIZE;
	local_sub(length, &tail_page->write);
}
1203

S
Steven Rostedt 已提交
1204
static struct ring_buffer_event *
1205 1206 1207 1208
rb_move_tail(struct ring_buffer_per_cpu *cpu_buffer,
	     unsigned long length, unsigned long tail,
	     struct buffer_page *commit_page,
	     struct buffer_page *tail_page, u64 *ts)
S
Steven Rostedt 已提交
1209
{
1210
	struct buffer_page *next_page, *head_page, *reader_page;
S
Steven Rostedt 已提交
1211
	struct ring_buffer *buffer = cpu_buffer->buffer;
1212
	bool lock_taken = false;
1213
	unsigned long flags;
1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291

	next_page = tail_page;

	local_irq_save(flags);
	/*
	 * 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.
	 *
	 * 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.
	 */
	if (unlikely(in_nmi())) {
		if (!__raw_spin_trylock(&cpu_buffer->lock)) {
			cpu_buffer->nmi_dropped++;
			goto out_reset;
		}
	} else
		__raw_spin_lock(&cpu_buffer->lock);

	lock_taken = true;

	rb_inc_page(cpu_buffer, &next_page);

	head_page = cpu_buffer->head_page;
	reader_page = cpu_buffer->reader_page;

	/* we grabbed the lock before incrementing */
	if (RB_WARN_ON(cpu_buffer, next_page == reader_page))
		goto out_reset;

	/*
	 * If for some reason, we had an interrupt storm that made
	 * it all the way around the buffer, bail, and warn
	 * about it.
	 */
	if (unlikely(next_page == commit_page)) {
		cpu_buffer->commit_overrun++;
		goto out_reset;
	}

	if (next_page == head_page) {
		if (!(buffer->flags & RB_FL_OVERWRITE))
			goto out_reset;

		/* tail_page has not moved yet? */
		if (tail_page == cpu_buffer->tail_page) {
			/* count overflows */
			cpu_buffer->overrun +=
				local_read(&head_page->entries);

			rb_inc_page(cpu_buffer, &head_page);
			cpu_buffer->head_page = head_page;
			cpu_buffer->head_page->read = 0;
		}
	}

	/*
	 * 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);
		local_set(&next_page->entries, 0);
		local_set(&next_page->page->commit, 0);
		cpu_buffer->tail_page = next_page;

		/* reread the time stamp */
1292
		*ts = rb_time_stamp(buffer, cpu_buffer->cpu);
1293 1294 1295
		cpu_buffer->tail_page->page->time_stamp = *ts;
	}

1296
	rb_reset_tail(cpu_buffer, tail_page, tail, length);
1297 1298 1299 1300 1301 1302 1303

	__raw_spin_unlock(&cpu_buffer->lock);
	local_irq_restore(flags);

	/* fail and let the caller try again */
	return ERR_PTR(-EAGAIN);

1304
 out_reset:
1305
	/* reset write */
1306
	rb_reset_tail(cpu_buffer, tail_page, tail, length);
1307

1308 1309
	if (likely(lock_taken))
		__raw_spin_unlock(&cpu_buffer->lock);
1310
	local_irq_restore(flags);
S
Steven Rostedt 已提交
1311
	return NULL;
S
Steven Rostedt 已提交
1312 1313
}

1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336
static struct ring_buffer_event *
__rb_reserve_next(struct ring_buffer_per_cpu *cpu_buffer,
		  unsigned type, unsigned long length, u64 *ts)
{
	struct buffer_page *tail_page, *commit_page;
	struct ring_buffer_event *event;
	unsigned long tail, write;

	commit_page = cpu_buffer->commit_page;
	/* we just need to protect against interrupts */
	barrier();
	tail_page = cpu_buffer->tail_page;
	write = local_add_return(length, &tail_page->write);
	tail = write - length;

	/* See if we shot pass the end of this buffer page */
	if (write > BUF_PAGE_SIZE)
		return rb_move_tail(cpu_buffer, length, tail,
				    commit_page, tail_page, ts);

	/* We reserved something on the buffer */

	event = __rb_page_index(tail_page, tail);
1337
	kmemcheck_annotate_bitfield(event, bitfield);
1338 1339 1340 1341 1342 1343 1344
	rb_update_event(event, type, length);

	/* The passed in type is zero for DATA */
	if (likely(!type))
		local_inc(&tail_page->entries);

	/*
1345 1346
	 * If this is the first commit on the page, then update
	 * its timestamp.
1347
	 */
1348 1349
	if (!tail)
		tail_page->page->time_stamp = *ts;
1350 1351 1352 1353

	return event;
}

1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385
static inline int
rb_try_to_discard(struct ring_buffer_per_cpu *cpu_buffer,
		  struct ring_buffer_event *event)
{
	unsigned long new_index, old_index;
	struct buffer_page *bpage;
	unsigned long index;
	unsigned long addr;

	new_index = rb_event_index(event);
	old_index = new_index + rb_event_length(event);
	addr = (unsigned long)event;
	addr &= PAGE_MASK;

	bpage = cpu_buffer->tail_page;

	if (bpage->page == (void *)addr && rb_page_write(bpage) == old_index) {
		/*
		 * This is on the tail page. It is possible that
		 * a write could come in and move the tail page
		 * and write to the next page. That is fine
		 * because we just shorten what is on this page.
		 */
		index = local_cmpxchg(&bpage->write, old_index, new_index);
		if (index == old_index)
			return 1;
	}

	/* could not discard */
	return 0;
}

S
Steven Rostedt 已提交
1386 1387 1388 1389 1390 1391
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 已提交
1392
	int ret;
S
Steven Rostedt 已提交
1393 1394 1395 1396

	if (unlikely(*delta > (1ULL << 59) && !once++)) {
		printk(KERN_WARNING "Delta way too big! %llu"
		       " ts=%llu write stamp = %llu\n",
1397 1398 1399
		       (unsigned long long)*delta,
		       (unsigned long long)*ts,
		       (unsigned long long)cpu_buffer->write_stamp);
S
Steven Rostedt 已提交
1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411
		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 已提交
1412
		return -EBUSY;
S
Steven Rostedt 已提交
1413

S
Steven Rostedt 已提交
1414 1415 1416 1417
	if (PTR_ERR(event) == -EAGAIN)
		return -EAGAIN;

	/* Only a commited time event can update the write stamp */
1418
	if (rb_event_is_commit(cpu_buffer, event)) {
S
Steven Rostedt 已提交
1419
		/*
1420 1421 1422
		 * If this is the first on the page, then it was
		 * updated with the page itself. Try to discard it
		 * and if we can't just make it zero.
S
Steven Rostedt 已提交
1423 1424 1425 1426 1427
		 */
		if (rb_event_index(event)) {
			event->time_delta = *delta & TS_MASK;
			event->array[0] = *delta >> TS_SHIFT;
		} else {
1428 1429 1430 1431 1432 1433
			/* try to discard, since we do not need this */
			if (!rb_try_to_discard(cpu_buffer, event)) {
				/* nope, just zero it */
				event->time_delta = 0;
				event->array[0] = 0;
			}
S
Steven Rostedt 已提交
1434
		}
S
Steven Rostedt 已提交
1435
		cpu_buffer->write_stamp = *ts;
S
Steven Rostedt 已提交
1436 1437 1438
		/* let the caller know this was the commit */
		ret = 1;
	} else {
1439 1440 1441 1442 1443 1444
		/* Try to discard the event */
		if (!rb_try_to_discard(cpu_buffer, event)) {
			/* Darn, this is just wasted space */
			event->time_delta = 0;
			event->array[0] = 0;
		}
1445
		ret = 0;
S
Steven Rostedt 已提交
1446 1447
	}

S
Steven Rostedt 已提交
1448 1449 1450
	*delta = 0;

	return ret;
S
Steven Rostedt 已提交
1451 1452
}

1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 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 1490
static void rb_start_commit(struct ring_buffer_per_cpu *cpu_buffer)
{
	local_inc(&cpu_buffer->committing);
	local_inc(&cpu_buffer->commits);
}

static void rb_end_commit(struct ring_buffer_per_cpu *cpu_buffer)
{
	unsigned long commits;

	if (RB_WARN_ON(cpu_buffer,
		       !local_read(&cpu_buffer->committing)))
		return;

 again:
	commits = local_read(&cpu_buffer->commits);
	/* synchronize with interrupts */
	barrier();
	if (local_read(&cpu_buffer->committing) == 1)
		rb_set_commit_to_write(cpu_buffer);

	local_dec(&cpu_buffer->committing);

	/* synchronize with interrupts */
	barrier();

	/*
	 * Need to account for interrupts coming in between the
	 * updating of the commit page and the clearing of the
	 * committing counter.
	 */
	if (unlikely(local_read(&cpu_buffer->commits) != commits) &&
	    !local_read(&cpu_buffer->committing)) {
		local_inc(&cpu_buffer->committing);
		goto again;
	}
}

S
Steven Rostedt 已提交
1491 1492
static struct ring_buffer_event *
rb_reserve_next_event(struct ring_buffer_per_cpu *cpu_buffer,
1493
		      unsigned long length)
S
Steven Rostedt 已提交
1494 1495
{
	struct ring_buffer_event *event;
1496
	u64 ts, delta = 0;
S
Steven Rostedt 已提交
1497
	int commit = 0;
1498
	int nr_loops = 0;
S
Steven Rostedt 已提交
1499

1500 1501
	rb_start_commit(cpu_buffer);

1502
	length = rb_calculate_event_length(length);
S
Steven Rostedt 已提交
1503
 again:
1504 1505 1506 1507 1508 1509 1510 1511 1512
	/*
	 * 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 已提交
1513
	if (RB_WARN_ON(cpu_buffer, ++nr_loops > 1000))
1514
		goto out_fail;
1515

1516
	ts = rb_time_stamp(cpu_buffer->buffer, cpu_buffer->cpu);
S
Steven Rostedt 已提交
1517

S
Steven Rostedt 已提交
1518 1519 1520 1521 1522 1523 1524 1525
	/*
	 * 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.
	 */
1526 1527 1528
	if (likely(cpu_buffer->tail_page == cpu_buffer->commit_page &&
		   rb_page_write(cpu_buffer->tail_page) ==
		   rb_commit_index(cpu_buffer))) {
1529
		u64 diff;
S
Steven Rostedt 已提交
1530

1531
		diff = ts - cpu_buffer->write_stamp;
S
Steven Rostedt 已提交
1532

1533
		/* make sure this diff is calculated here */
S
Steven Rostedt 已提交
1534 1535 1536 1537
		barrier();

		/* Did the write stamp get updated already? */
		if (unlikely(ts < cpu_buffer->write_stamp))
1538
			goto get_event;
S
Steven Rostedt 已提交
1539

1540 1541
		delta = diff;
		if (unlikely(test_time_stamp(delta))) {
S
Steven Rostedt 已提交
1542

S
Steven Rostedt 已提交
1543 1544
			commit = rb_add_time_stamp(cpu_buffer, &ts, &delta);
			if (commit == -EBUSY)
1545
				goto out_fail;
S
Steven Rostedt 已提交
1546 1547 1548 1549 1550

			if (commit == -EAGAIN)
				goto again;

			RB_WARN_ON(cpu_buffer, commit < 0);
S
Steven Rostedt 已提交
1551
		}
1552
	}
S
Steven Rostedt 已提交
1553

1554
 get_event:
1555
	event = __rb_reserve_next(cpu_buffer, 0, length, &ts);
1556
	if (unlikely(PTR_ERR(event) == -EAGAIN))
S
Steven Rostedt 已提交
1557 1558
		goto again;

1559 1560
	if (!event)
		goto out_fail;
S
Steven Rostedt 已提交
1561

1562
	if (!rb_event_is_commit(cpu_buffer, event))
S
Steven Rostedt 已提交
1563 1564 1565 1566 1567
		delta = 0;

	event->time_delta = delta;

	return event;
1568 1569 1570 1571

 out_fail:
	rb_end_commit(cpu_buffer);
	return NULL;
S
Steven Rostedt 已提交
1572 1573
}

1574 1575
#ifdef CONFIG_TRACING

1576
#define TRACE_RECURSIVE_DEPTH 16
1577 1578 1579

static int trace_recursive_lock(void)
{
1580
	current->trace_recursion++;
1581

1582 1583
	if (likely(current->trace_recursion < TRACE_RECURSIVE_DEPTH))
		return 0;
1584

1585 1586
	/* Disable all tracing before we do anything else */
	tracing_off_permanent();
1587

S
Steven Rostedt 已提交
1588
	printk_once(KERN_WARNING "Tracing recursion: depth[%ld]:"
1589 1590 1591 1592 1593
		    "HC[%lu]:SC[%lu]:NMI[%lu]\n",
		    current->trace_recursion,
		    hardirq_count() >> HARDIRQ_SHIFT,
		    softirq_count() >> SOFTIRQ_SHIFT,
		    in_nmi());
1594

1595 1596
	WARN_ON_ONCE(1);
	return -1;
1597 1598 1599 1600
}

static void trace_recursive_unlock(void)
{
1601
	WARN_ON_ONCE(!current->trace_recursion);
1602

1603
	current->trace_recursion--;
1604 1605
}

1606 1607 1608 1609 1610 1611 1612
#else

#define trace_recursive_lock()		(0)
#define trace_recursive_unlock()	do { } while (0)

#endif

S
Steven Rostedt 已提交
1613 1614
static DEFINE_PER_CPU(int, rb_need_resched);

S
Steven Rostedt 已提交
1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630
/**
 * 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 *
1631
ring_buffer_lock_reserve(struct ring_buffer *buffer, unsigned long length)
S
Steven Rostedt 已提交
1632 1633 1634
{
	struct ring_buffer_per_cpu *cpu_buffer;
	struct ring_buffer_event *event;
S
Steven Rostedt 已提交
1635
	int cpu, resched;
S
Steven Rostedt 已提交
1636

1637
	if (ring_buffer_flags != RB_BUFFERS_ON)
1638 1639
		return NULL;

S
Steven Rostedt 已提交
1640 1641 1642
	if (atomic_read(&buffer->record_disabled))
		return NULL;

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

1646 1647 1648
	if (trace_recursive_lock())
		goto out_nocheck;

S
Steven Rostedt 已提交
1649 1650
	cpu = raw_smp_processor_id();

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

	cpu_buffer = buffer->buffers[cpu];

	if (atomic_read(&cpu_buffer->record_disabled))
1657
		goto out;
S
Steven Rostedt 已提交
1658

1659
	if (length > BUF_MAX_DATA_SIZE)
S
Steven Rostedt 已提交
1660
		goto out;
S
Steven Rostedt 已提交
1661

1662
	event = rb_reserve_next_event(cpu_buffer, length);
S
Steven Rostedt 已提交
1663
	if (!event)
1664
		goto out;
S
Steven Rostedt 已提交
1665

S
Steven Rostedt 已提交
1666 1667 1668 1669 1670 1671 1672 1673
	/*
	 * 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 已提交
1674 1675
	return event;

1676
 out:
1677 1678 1679
	trace_recursive_unlock();

 out_nocheck:
1680
	ftrace_preempt_enable(resched);
S
Steven Rostedt 已提交
1681 1682
	return NULL;
}
1683
EXPORT_SYMBOL_GPL(ring_buffer_lock_reserve);
S
Steven Rostedt 已提交
1684 1685 1686 1687

static void rb_commit(struct ring_buffer_per_cpu *cpu_buffer,
		      struct ring_buffer_event *event)
{
1688
	local_inc(&cpu_buffer->entries);
S
Steven Rostedt 已提交
1689

1690 1691 1692 1693 1694 1695
	/*
	 * The event first in the commit queue updates the
	 * time stamp.
	 */
	if (rb_event_is_commit(cpu_buffer, event))
		cpu_buffer->write_stamp += event->time_delta;
S
Steven Rostedt 已提交
1696

1697
	rb_end_commit(cpu_buffer);
S
Steven Rostedt 已提交
1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709
}

/**
 * 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,
1710
			      struct ring_buffer_event *event)
S
Steven Rostedt 已提交
1711 1712 1713 1714 1715 1716 1717 1718
{
	struct ring_buffer_per_cpu *cpu_buffer;
	int cpu = raw_smp_processor_id();

	cpu_buffer = buffer->buffers[cpu];

	rb_commit(cpu_buffer, event);

1719 1720
	trace_recursive_unlock();

S
Steven Rostedt 已提交
1721 1722 1723
	/*
	 * Only the last preempt count needs to restore preemption.
	 */
1724 1725 1726
	if (preempt_count() == 1)
		ftrace_preempt_enable(per_cpu(rb_need_resched, cpu));
	else
S
Steven Rostedt 已提交
1727
		preempt_enable_no_resched_notrace();
S
Steven Rostedt 已提交
1728 1729 1730

	return 0;
}
1731
EXPORT_SYMBOL_GPL(ring_buffer_unlock_commit);
S
Steven Rostedt 已提交
1732

1733 1734
static inline void rb_event_discard(struct ring_buffer_event *event)
{
1735 1736 1737
	/* array[0] holds the actual length for the discarded event */
	event->array[0] = rb_event_data_length(event) - RB_EVNT_HDR_SIZE;
	event->type_len = RINGBUF_TYPE_PADDING;
1738 1739 1740 1741 1742
	/* time delta must be non zero */
	if (!event->time_delta)
		event->time_delta = 1;
}

1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756
/**
 * ring_buffer_event_discard - discard any event in the ring buffer
 * @event: the event to discard
 *
 * Sometimes a event that is in the ring buffer needs to be ignored.
 * This function lets the user discard an event in the ring buffer
 * and then that event will not be read later.
 *
 * Note, it is up to the user to be careful with this, and protect
 * against races. If the user discards an event that has been consumed
 * it is possible that it could corrupt the ring buffer.
 */
void ring_buffer_event_discard(struct ring_buffer_event *event)
{
1757
	rb_event_discard(event);
1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783
}
EXPORT_SYMBOL_GPL(ring_buffer_event_discard);

/**
 * ring_buffer_commit_discard - discard an event that has not been committed
 * @buffer: the ring buffer
 * @event: non committed event to discard
 *
 * This is similar to ring_buffer_event_discard but must only be
 * performed on an event that has not been committed yet. The difference
 * is that this will also try to free the event from the ring buffer
 * if another event has not been added behind it.
 *
 * If another event has been added behind it, it will set the event
 * up as discarded, and perform the commit.
 *
 * If this function is called, do not call ring_buffer_unlock_commit on
 * the event.
 */
void ring_buffer_discard_commit(struct ring_buffer *buffer,
				struct ring_buffer_event *event)
{
	struct ring_buffer_per_cpu *cpu_buffer;
	int cpu;

	/* The event is discarded regardless */
1784
	rb_event_discard(event);
1785

1786 1787 1788
	cpu = smp_processor_id();
	cpu_buffer = buffer->buffers[cpu];

1789 1790 1791 1792 1793
	/*
	 * This must only be called if the event has not been
	 * committed yet. Thus we can assume that preemption
	 * is still disabled.
	 */
1794
	RB_WARN_ON(buffer, !local_read(&cpu_buffer->committing));
1795

1796 1797
	if (!rb_try_to_discard(cpu_buffer, event))
		goto out;
1798 1799 1800 1801 1802

	/*
	 * The commit is still visible by the reader, so we
	 * must increment entries.
	 */
1803
	local_inc(&cpu_buffer->entries);
1804
 out:
1805
	rb_end_commit(cpu_buffer);
1806

1807 1808
	trace_recursive_unlock();

1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819
	/*
	 * Only the last preempt count needs to restore preemption.
	 */
	if (preempt_count() == 1)
		ftrace_preempt_enable(per_cpu(rb_need_resched, cpu));
	else
		preempt_enable_no_resched_notrace();

}
EXPORT_SYMBOL_GPL(ring_buffer_discard_commit);

S
Steven Rostedt 已提交
1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840
/**
 * 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;
	void *body;
	int ret = -EBUSY;
S
Steven Rostedt 已提交
1841
	int cpu, resched;
S
Steven Rostedt 已提交
1842

1843
	if (ring_buffer_flags != RB_BUFFERS_ON)
1844 1845
		return -EBUSY;

S
Steven Rostedt 已提交
1846 1847 1848
	if (atomic_read(&buffer->record_disabled))
		return -EBUSY;

1849
	resched = ftrace_preempt_disable();
S
Steven Rostedt 已提交
1850

S
Steven Rostedt 已提交
1851 1852
	cpu = raw_smp_processor_id();

1853
	if (!cpumask_test_cpu(cpu, buffer->cpumask))
1854
		goto out;
S
Steven Rostedt 已提交
1855 1856 1857 1858 1859 1860

	cpu_buffer = buffer->buffers[cpu];

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

1861 1862 1863 1864
	if (length > BUF_MAX_DATA_SIZE)
		goto out;

	event = rb_reserve_next_event(cpu_buffer, length);
S
Steven Rostedt 已提交
1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875
	if (!event)
		goto out;

	body = rb_event_data(event);

	memcpy(body, data, length);

	rb_commit(cpu_buffer, event);

	ret = 0;
 out:
1876
	ftrace_preempt_enable(resched);
S
Steven Rostedt 已提交
1877 1878 1879

	return ret;
}
1880
EXPORT_SYMBOL_GPL(ring_buffer_write);
S
Steven Rostedt 已提交
1881

1882
static int rb_per_cpu_empty(struct ring_buffer_per_cpu *cpu_buffer)
S
Steven Rostedt 已提交
1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893
{
	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 已提交
1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906
/**
 * 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);
}
1907
EXPORT_SYMBOL_GPL(ring_buffer_record_disable);
S
Steven Rostedt 已提交
1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919

/**
 * 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);
}
1920
EXPORT_SYMBOL_GPL(ring_buffer_record_enable);
S
Steven Rostedt 已提交
1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935

/**
 * 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;

1936
	if (!cpumask_test_cpu(cpu, buffer->cpumask))
1937
		return;
S
Steven Rostedt 已提交
1938 1939 1940 1941

	cpu_buffer = buffer->buffers[cpu];
	atomic_inc(&cpu_buffer->record_disabled);
}
1942
EXPORT_SYMBOL_GPL(ring_buffer_record_disable_cpu);
S
Steven Rostedt 已提交
1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955

/**
 * 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;

1956
	if (!cpumask_test_cpu(cpu, buffer->cpumask))
1957
		return;
S
Steven Rostedt 已提交
1958 1959 1960 1961

	cpu_buffer = buffer->buffers[cpu];
	atomic_dec(&cpu_buffer->record_disabled);
}
1962
EXPORT_SYMBOL_GPL(ring_buffer_record_enable_cpu);
S
Steven Rostedt 已提交
1963 1964 1965 1966 1967 1968 1969 1970 1971

/**
 * 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;
1972
	unsigned long ret;
S
Steven Rostedt 已提交
1973

1974
	if (!cpumask_test_cpu(cpu, buffer->cpumask))
1975
		return 0;
S
Steven Rostedt 已提交
1976 1977

	cpu_buffer = buffer->buffers[cpu];
1978 1979
	ret = (local_read(&cpu_buffer->entries) - cpu_buffer->overrun)
		- cpu_buffer->read;
1980 1981

	return ret;
S
Steven Rostedt 已提交
1982
}
1983
EXPORT_SYMBOL_GPL(ring_buffer_entries_cpu);
S
Steven Rostedt 已提交
1984 1985 1986 1987 1988 1989 1990 1991 1992

/**
 * 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;
1993
	unsigned long ret;
S
Steven Rostedt 已提交
1994

1995
	if (!cpumask_test_cpu(cpu, buffer->cpumask))
1996
		return 0;
S
Steven Rostedt 已提交
1997 1998

	cpu_buffer = buffer->buffers[cpu];
1999 2000 2001
	ret = cpu_buffer->overrun;

	return ret;
S
Steven Rostedt 已提交
2002
}
2003
EXPORT_SYMBOL_GPL(ring_buffer_overrun_cpu);
S
Steven Rostedt 已提交
2004

2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045
/**
 * ring_buffer_nmi_dropped_cpu - get the number of nmis that were dropped
 * @buffer: The ring buffer
 * @cpu: The per CPU buffer to get the number of overruns from
 */
unsigned long ring_buffer_nmi_dropped_cpu(struct ring_buffer *buffer, int cpu)
{
	struct ring_buffer_per_cpu *cpu_buffer;
	unsigned long ret;

	if (!cpumask_test_cpu(cpu, buffer->cpumask))
		return 0;

	cpu_buffer = buffer->buffers[cpu];
	ret = cpu_buffer->nmi_dropped;

	return ret;
}
EXPORT_SYMBOL_GPL(ring_buffer_nmi_dropped_cpu);

/**
 * ring_buffer_commit_overrun_cpu - get the number of overruns caused by commits
 * @buffer: The ring buffer
 * @cpu: The per CPU buffer to get the number of overruns from
 */
unsigned long
ring_buffer_commit_overrun_cpu(struct ring_buffer *buffer, int cpu)
{
	struct ring_buffer_per_cpu *cpu_buffer;
	unsigned long ret;

	if (!cpumask_test_cpu(cpu, buffer->cpumask))
		return 0;

	cpu_buffer = buffer->buffers[cpu];
	ret = cpu_buffer->commit_overrun;

	return ret;
}
EXPORT_SYMBOL_GPL(ring_buffer_commit_overrun_cpu);

S
Steven Rostedt 已提交
2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061
/**
 * 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];
2062 2063
		entries += (local_read(&cpu_buffer->entries) -
			    cpu_buffer->overrun) - cpu_buffer->read;
S
Steven Rostedt 已提交
2064 2065 2066 2067
	}

	return entries;
}
2068
EXPORT_SYMBOL_GPL(ring_buffer_entries);
S
Steven Rostedt 已提交
2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090

/**
 * 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;
}
2091
EXPORT_SYMBOL_GPL(ring_buffer_overruns);
S
Steven Rostedt 已提交
2092

2093
static void rb_iter_reset(struct ring_buffer_iter *iter)
S
Steven Rostedt 已提交
2094 2095 2096
{
	struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;

2097 2098 2099
	/* Iterator usage is expected to have record disabled */
	if (list_empty(&cpu_buffer->reader_page->list)) {
		iter->head_page = cpu_buffer->head_page;
2100
		iter->head = cpu_buffer->head_page->read;
2101 2102
	} else {
		iter->head_page = cpu_buffer->reader_page;
2103
		iter->head = cpu_buffer->reader_page->read;
2104 2105 2106 2107
	}
	if (iter->head)
		iter->read_stamp = cpu_buffer->read_stamp;
	else
2108
		iter->read_stamp = iter->head_page->page->time_stamp;
2109
}
S
Steven Rostedt 已提交
2110

2111 2112 2113 2114 2115 2116 2117 2118 2119
/**
 * 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)
{
2120
	struct ring_buffer_per_cpu *cpu_buffer;
2121 2122
	unsigned long flags;

2123 2124 2125 2126 2127
	if (!iter)
		return;

	cpu_buffer = iter->cpu_buffer;

2128 2129
	spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
	rb_iter_reset(iter);
S
Steven Rostedt 已提交
2130
	spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
S
Steven Rostedt 已提交
2131
}
2132
EXPORT_SYMBOL_GPL(ring_buffer_iter_reset);
S
Steven Rostedt 已提交
2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143

/**
 * 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 已提交
2144 2145
	return iter->head_page == cpu_buffer->commit_page &&
		iter->head == rb_commit_index(cpu_buffer);
S
Steven Rostedt 已提交
2146
}
2147
EXPORT_SYMBOL_GPL(ring_buffer_iter_empty);
S
Steven Rostedt 已提交
2148 2149 2150 2151 2152 2153 2154

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

2155
	switch (event->type_len) {
S
Steven Rostedt 已提交
2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185
	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;

2186
	switch (event->type_len) {
S
Steven Rostedt 已提交
2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210
	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;
}

2211 2212
static struct buffer_page *
rb_get_reader_page(struct ring_buffer_per_cpu *cpu_buffer)
S
Steven Rostedt 已提交
2213
{
2214 2215
	struct buffer_page *reader = NULL;
	unsigned long flags;
2216
	int nr_loops = 0;
2217

2218 2219
	local_irq_save(flags);
	__raw_spin_lock(&cpu_buffer->lock);
2220 2221

 again:
2222 2223 2224 2225 2226 2227
	/*
	 * 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 已提交
2228
	if (RB_WARN_ON(cpu_buffer, ++nr_loops > 3)) {
2229 2230 2231 2232
		reader = NULL;
		goto out;
	}

2233 2234 2235
	reader = cpu_buffer->reader_page;

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

	/* Never should we have an index greater than the size */
S
Steven Rostedt 已提交
2240 2241 2242
	if (RB_WARN_ON(cpu_buffer,
		       cpu_buffer->reader_page->read > rb_page_size(reader)))
		goto out;
2243 2244 2245

	/* check if we caught up to the tail */
	reader = NULL;
S
Steven Rostedt 已提交
2246
	if (cpu_buffer->commit_page == cpu_buffer->reader_page)
2247
		goto out;
S
Steven Rostedt 已提交
2248 2249

	/*
2250 2251
	 * Splice the empty reader page into the list around the head.
	 * Reset the reader page to size zero.
S
Steven Rostedt 已提交
2252 2253
	 */

2254 2255 2256
	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 已提交
2257

2258 2259 2260 2261 2262 2263 2264
	/*
	 * cpu_buffer->pages just needs to point to the buffer, it
	 *  has no specific buffer page to point to. Lets move it out
	 *  of our way so we don't accidently swap it.
	 */
	cpu_buffer->pages = reader->list.prev;

S
Steven Rostedt 已提交
2265
	local_set(&cpu_buffer->reader_page->write, 0);
2266
	local_set(&cpu_buffer->reader_page->entries, 0);
2267
	local_set(&cpu_buffer->reader_page->page->commit, 0);
S
Steven Rostedt 已提交
2268

2269 2270 2271
	/* 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 已提交
2272 2273

	/*
2274 2275
	 * 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 已提交
2276
	 */
2277
	cpu_buffer->head_page = cpu_buffer->reader_page;
S
Steven Rostedt 已提交
2278

S
Steven Rostedt 已提交
2279
	if (cpu_buffer->commit_page != reader)
2280 2281 2282 2283 2284 2285 2286 2287 2288
		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:
2289 2290
	__raw_spin_unlock(&cpu_buffer->lock);
	local_irq_restore(flags);
2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301

	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 已提交
2302

2303
	/* This function should not be called when buffer is empty */
S
Steven Rostedt 已提交
2304 2305
	if (RB_WARN_ON(cpu_buffer, !reader))
		return;
S
Steven Rostedt 已提交
2306

2307 2308
	event = rb_reader_event(cpu_buffer);

2309 2310
	if (event->type_len <= RINGBUF_TYPE_DATA_TYPE_LEN_MAX
			|| rb_discarded_event(event))
2311
		cpu_buffer->read++;
2312 2313 2314 2315

	rb_update_read_stamp(cpu_buffer, event);

	length = rb_event_length(event);
2316
	cpu_buffer->reader_page->read += length;
S
Steven Rostedt 已提交
2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331
}

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 已提交
2332
	if (iter->head >= rb_page_size(iter->head_page)) {
2333 2334
		/* discarded commits can make the page empty */
		if (iter->head_page == cpu_buffer->commit_page)
S
Steven Rostedt 已提交
2335
			return;
2336
		rb_inc_iter(iter);
S
Steven Rostedt 已提交
2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347
		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 已提交
2348
	if (RB_WARN_ON(cpu_buffer,
2349
		       (iter->head_page == cpu_buffer->commit_page) &&
S
Steven Rostedt 已提交
2350 2351
		       (iter->head + length > rb_commit_index(cpu_buffer))))
		return;
S
Steven Rostedt 已提交
2352 2353 2354 2355 2356 2357

	rb_update_iter_read_stamp(iter, event);

	iter->head += length;

	/* check for end of page padding */
S
Steven Rostedt 已提交
2358 2359
	if ((iter->head >= rb_page_size(iter->head_page)) &&
	    (iter->head_page != cpu_buffer->commit_page))
S
Steven Rostedt 已提交
2360 2361 2362
		rb_advance_iter(iter);
}

S
Steven Rostedt 已提交
2363 2364
static struct ring_buffer_event *
rb_buffer_peek(struct ring_buffer *buffer, int cpu, u64 *ts)
S
Steven Rostedt 已提交
2365 2366 2367
{
	struct ring_buffer_per_cpu *cpu_buffer;
	struct ring_buffer_event *event;
2368
	struct buffer_page *reader;
2369
	int nr_loops = 0;
S
Steven Rostedt 已提交
2370 2371 2372 2373

	cpu_buffer = buffer->buffers[cpu];

 again:
2374 2375 2376
	/*
	 * We repeat when a timestamp is encountered. It is possible
	 * to get multiple timestamps from an interrupt entering just
2377 2378
	 * as one timestamp is about to be written, or from discarded
	 * commits. The most that we can have is the number on a single page.
2379
	 */
2380
	if (RB_WARN_ON(cpu_buffer, ++nr_loops > RB_TIMESTAMPS_PER_PAGE))
2381 2382
		return NULL;

2383 2384
	reader = rb_get_reader_page(cpu_buffer);
	if (!reader)
S
Steven Rostedt 已提交
2385 2386
		return NULL;

2387
	event = rb_reader_event(cpu_buffer);
S
Steven Rostedt 已提交
2388

2389
	switch (event->type_len) {
S
Steven Rostedt 已提交
2390
	case RINGBUF_TYPE_PADDING:
2391 2392 2393 2394 2395 2396 2397 2398 2399 2400
		if (rb_null_event(event))
			RB_WARN_ON(cpu_buffer, 1);
		/*
		 * Because the writer could be discarding every
		 * event it creates (which would probably be bad)
		 * if we were to go back to "again" then we may never
		 * catch up, and will trigger the warn on, or lock
		 * the box. Return the padding, and we will release
		 * the current locks, and try again.
		 */
2401
		rb_advance_reader(cpu_buffer);
2402
		return event;
S
Steven Rostedt 已提交
2403 2404 2405

	case RINGBUF_TYPE_TIME_EXTEND:
		/* Internal data, OK to advance */
2406
		rb_advance_reader(cpu_buffer);
S
Steven Rostedt 已提交
2407 2408 2409 2410
		goto again;

	case RINGBUF_TYPE_TIME_STAMP:
		/* FIXME: not implemented */
2411
		rb_advance_reader(cpu_buffer);
S
Steven Rostedt 已提交
2412 2413 2414 2415 2416
		goto again;

	case RINGBUF_TYPE_DATA:
		if (ts) {
			*ts = cpu_buffer->read_stamp + event->time_delta;
2417 2418
			ring_buffer_normalize_time_stamp(buffer,
							 cpu_buffer->cpu, ts);
S
Steven Rostedt 已提交
2419 2420 2421 2422 2423 2424 2425 2426 2427
		}
		return event;

	default:
		BUG();
	}

	return NULL;
}
2428
EXPORT_SYMBOL_GPL(ring_buffer_peek);
S
Steven Rostedt 已提交
2429

S
Steven Rostedt 已提交
2430 2431
static struct ring_buffer_event *
rb_iter_peek(struct ring_buffer_iter *iter, u64 *ts)
S
Steven Rostedt 已提交
2432 2433 2434 2435
{
	struct ring_buffer *buffer;
	struct ring_buffer_per_cpu *cpu_buffer;
	struct ring_buffer_event *event;
2436
	int nr_loops = 0;
S
Steven Rostedt 已提交
2437 2438 2439 2440 2441 2442 2443 2444

	if (ring_buffer_iter_empty(iter))
		return NULL;

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

 again:
2445
	/*
2446 2447 2448 2449 2450 2451
	 * We repeat when a timestamp is encountered.
	 * We can get multiple timestamps by nested interrupts or also
	 * if filtering is on (discarding commits). Since discarding
	 * commits can be frequent we can get a lot of timestamps.
	 * But we limit them by not adding timestamps if they begin
	 * at the start of a page.
2452
	 */
2453
	if (RB_WARN_ON(cpu_buffer, ++nr_loops > RB_TIMESTAMPS_PER_PAGE))
2454 2455
		return NULL;

S
Steven Rostedt 已提交
2456 2457 2458 2459 2460
	if (rb_per_cpu_empty(cpu_buffer))
		return NULL;

	event = rb_iter_head_event(iter);

2461
	switch (event->type_len) {
S
Steven Rostedt 已提交
2462
	case RINGBUF_TYPE_PADDING:
2463 2464 2465 2466 2467 2468
		if (rb_null_event(event)) {
			rb_inc_iter(iter);
			goto again;
		}
		rb_advance_iter(iter);
		return event;
S
Steven Rostedt 已提交
2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482

	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;
2483 2484
			ring_buffer_normalize_time_stamp(buffer,
							 cpu_buffer->cpu, ts);
S
Steven Rostedt 已提交
2485 2486 2487 2488 2489 2490 2491 2492 2493
		}
		return event;

	default:
		BUG();
	}

	return NULL;
}
2494
EXPORT_SYMBOL_GPL(ring_buffer_iter_peek);
S
Steven Rostedt 已提交
2495

2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510
static inline int rb_ok_to_lock(void)
{
	/*
	 * If an NMI die dumps out the content of the ring buffer
	 * do not grab locks. We also permanently disable the ring
	 * buffer too. A one time deal is all you get from reading
	 * the ring buffer from an NMI.
	 */
	if (likely(!in_nmi() && !oops_in_progress))
		return 1;

	tracing_off_permanent();
	return 0;
}

S
Steven Rostedt 已提交
2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523
/**
 * 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];
2524
	struct ring_buffer_event *event;
S
Steven Rostedt 已提交
2525
	unsigned long flags;
2526
	int dolock;
S
Steven Rostedt 已提交
2527

2528
	if (!cpumask_test_cpu(cpu, buffer->cpumask))
2529
		return NULL;
2530

2531
	dolock = rb_ok_to_lock();
2532
 again:
2533 2534 2535
	local_irq_save(flags);
	if (dolock)
		spin_lock(&cpu_buffer->reader_lock);
S
Steven Rostedt 已提交
2536
	event = rb_buffer_peek(buffer, cpu, ts);
2537 2538 2539
	if (dolock)
		spin_unlock(&cpu_buffer->reader_lock);
	local_irq_restore(flags);
S
Steven Rostedt 已提交
2540

2541
	if (event && event->type_len == RINGBUF_TYPE_PADDING) {
2542 2543 2544 2545
		cpu_relax();
		goto again;
	}

S
Steven Rostedt 已提交
2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563
	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;

2564
 again:
S
Steven Rostedt 已提交
2565 2566 2567 2568
	spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
	event = rb_iter_peek(iter, ts);
	spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);

2569
	if (event && event->type_len == RINGBUF_TYPE_PADDING) {
2570 2571 2572 2573
		cpu_relax();
		goto again;
	}

S
Steven Rostedt 已提交
2574 2575 2576
	return event;
}

S
Steven Rostedt 已提交
2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587
/**
 * 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)
{
2588 2589
	struct ring_buffer_per_cpu *cpu_buffer;
	struct ring_buffer_event *event = NULL;
S
Steven Rostedt 已提交
2590
	unsigned long flags;
2591 2592 2593
	int dolock;

	dolock = rb_ok_to_lock();
S
Steven Rostedt 已提交
2594

2595
 again:
2596 2597 2598
	/* might be called in atomic */
	preempt_disable();

2599
	if (!cpumask_test_cpu(cpu, buffer->cpumask))
2600
		goto out;
S
Steven Rostedt 已提交
2601

2602
	cpu_buffer = buffer->buffers[cpu];
2603 2604 2605
	local_irq_save(flags);
	if (dolock)
		spin_lock(&cpu_buffer->reader_lock);
S
Steven Rostedt 已提交
2606 2607

	event = rb_buffer_peek(buffer, cpu, ts);
S
Steven Rostedt 已提交
2608
	if (!event)
2609
		goto out_unlock;
S
Steven Rostedt 已提交
2610

2611
	rb_advance_reader(cpu_buffer);
S
Steven Rostedt 已提交
2612

2613
 out_unlock:
2614 2615 2616
	if (dolock)
		spin_unlock(&cpu_buffer->reader_lock);
	local_irq_restore(flags);
S
Steven Rostedt 已提交
2617

2618 2619 2620
 out:
	preempt_enable();

2621
	if (event && event->type_len == RINGBUF_TYPE_PADDING) {
2622 2623 2624 2625
		cpu_relax();
		goto again;
	}

S
Steven Rostedt 已提交
2626 2627
	return event;
}
2628
EXPORT_SYMBOL_GPL(ring_buffer_consume);
S
Steven Rostedt 已提交
2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645

/**
 * 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;
2646
	struct ring_buffer_iter *iter;
2647
	unsigned long flags;
S
Steven Rostedt 已提交
2648

2649
	if (!cpumask_test_cpu(cpu, buffer->cpumask))
2650
		return NULL;
S
Steven Rostedt 已提交
2651 2652 2653

	iter = kmalloc(sizeof(*iter), GFP_KERNEL);
	if (!iter)
2654
		return NULL;
S
Steven Rostedt 已提交
2655 2656 2657 2658 2659 2660 2661 2662

	cpu_buffer = buffer->buffers[cpu];

	iter->cpu_buffer = cpu_buffer;

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

S
Steven Rostedt 已提交
2663
	spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
2664
	__raw_spin_lock(&cpu_buffer->lock);
2665
	rb_iter_reset(iter);
2666
	__raw_spin_unlock(&cpu_buffer->lock);
S
Steven Rostedt 已提交
2667
	spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
S
Steven Rostedt 已提交
2668 2669 2670

	return iter;
}
2671
EXPORT_SYMBOL_GPL(ring_buffer_read_start);
S
Steven Rostedt 已提交
2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687

/**
 * 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);
}
2688
EXPORT_SYMBOL_GPL(ring_buffer_read_finish);
S
Steven Rostedt 已提交
2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700

/**
 * 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 已提交
2701 2702
	struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;
	unsigned long flags;
S
Steven Rostedt 已提交
2703

2704
 again:
S
Steven Rostedt 已提交
2705 2706
	spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
	event = rb_iter_peek(iter, ts);
S
Steven Rostedt 已提交
2707
	if (!event)
S
Steven Rostedt 已提交
2708
		goto out;
S
Steven Rostedt 已提交
2709 2710

	rb_advance_iter(iter);
S
Steven Rostedt 已提交
2711 2712
 out:
	spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
S
Steven Rostedt 已提交
2713

2714
	if (event && event->type_len == RINGBUF_TYPE_PADDING) {
2715 2716 2717 2718
		cpu_relax();
		goto again;
	}

S
Steven Rostedt 已提交
2719 2720
	return event;
}
2721
EXPORT_SYMBOL_GPL(ring_buffer_read);
S
Steven Rostedt 已提交
2722 2723 2724 2725 2726 2727 2728 2729 2730

/**
 * 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;
}
2731
EXPORT_SYMBOL_GPL(ring_buffer_size);
S
Steven Rostedt 已提交
2732 2733 2734 2735 2736

static void
rb_reset_cpu(struct ring_buffer_per_cpu *cpu_buffer)
{
	cpu_buffer->head_page
2737
		= list_entry(cpu_buffer->pages, struct buffer_page, list);
S
Steven Rostedt 已提交
2738
	local_set(&cpu_buffer->head_page->write, 0);
2739
	local_set(&cpu_buffer->head_page->entries, 0);
2740
	local_set(&cpu_buffer->head_page->page->commit, 0);
2741

2742
	cpu_buffer->head_page->read = 0;
S
Steven Rostedt 已提交
2743 2744 2745 2746 2747 2748

	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);
2749
	local_set(&cpu_buffer->reader_page->entries, 0);
2750
	local_set(&cpu_buffer->reader_page->page->commit, 0);
2751
	cpu_buffer->reader_page->read = 0;
S
Steven Rostedt 已提交
2752

2753 2754
	cpu_buffer->nmi_dropped = 0;
	cpu_buffer->commit_overrun = 0;
S
Steven Rostedt 已提交
2755
	cpu_buffer->overrun = 0;
2756 2757
	cpu_buffer->read = 0;
	local_set(&cpu_buffer->entries, 0);
2758 2759
	local_set(&cpu_buffer->committing, 0);
	local_set(&cpu_buffer->commits, 0);
2760 2761 2762

	cpu_buffer->write_stamp = 0;
	cpu_buffer->read_stamp = 0;
S
Steven Rostedt 已提交
2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774
}

/**
 * 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;

2775
	if (!cpumask_test_cpu(cpu, buffer->cpumask))
2776
		return;
S
Steven Rostedt 已提交
2777

2778 2779
	atomic_inc(&cpu_buffer->record_disabled);

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

2782
	__raw_spin_lock(&cpu_buffer->lock);
S
Steven Rostedt 已提交
2783 2784 2785

	rb_reset_cpu(cpu_buffer);

2786
	__raw_spin_unlock(&cpu_buffer->lock);
S
Steven Rostedt 已提交
2787 2788

	spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
2789 2790

	atomic_dec(&cpu_buffer->record_disabled);
S
Steven Rostedt 已提交
2791
}
2792
EXPORT_SYMBOL_GPL(ring_buffer_reset_cpu);
S
Steven Rostedt 已提交
2793 2794 2795 2796 2797 2798 2799 2800 2801 2802

/**
 * 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)
2803
		ring_buffer_reset_cpu(buffer, cpu);
S
Steven Rostedt 已提交
2804
}
2805
EXPORT_SYMBOL_GPL(ring_buffer_reset);
S
Steven Rostedt 已提交
2806 2807 2808 2809 2810 2811 2812 2813

/**
 * 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;
2814
	unsigned long flags;
2815
	int dolock;
S
Steven Rostedt 已提交
2816
	int cpu;
2817
	int ret;
S
Steven Rostedt 已提交
2818

2819
	dolock = rb_ok_to_lock();
S
Steven Rostedt 已提交
2820 2821 2822 2823

	/* 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];
2824 2825 2826
		local_irq_save(flags);
		if (dolock)
			spin_lock(&cpu_buffer->reader_lock);
2827
		ret = rb_per_cpu_empty(cpu_buffer);
2828 2829 2830 2831
		if (dolock)
			spin_unlock(&cpu_buffer->reader_lock);
		local_irq_restore(flags);

2832
		if (!ret)
S
Steven Rostedt 已提交
2833 2834
			return 0;
	}
2835

S
Steven Rostedt 已提交
2836 2837
	return 1;
}
2838
EXPORT_SYMBOL_GPL(ring_buffer_empty);
S
Steven Rostedt 已提交
2839 2840 2841 2842 2843 2844 2845 2846 2847

/**
 * 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;
2848
	unsigned long flags;
2849
	int dolock;
2850
	int ret;
S
Steven Rostedt 已提交
2851

2852
	if (!cpumask_test_cpu(cpu, buffer->cpumask))
2853
		return 1;
S
Steven Rostedt 已提交
2854

2855 2856
	dolock = rb_ok_to_lock();

S
Steven Rostedt 已提交
2857
	cpu_buffer = buffer->buffers[cpu];
2858 2859 2860
	local_irq_save(flags);
	if (dolock)
		spin_lock(&cpu_buffer->reader_lock);
2861
	ret = rb_per_cpu_empty(cpu_buffer);
2862 2863 2864
	if (dolock)
		spin_unlock(&cpu_buffer->reader_lock);
	local_irq_restore(flags);
2865 2866

	return ret;
S
Steven Rostedt 已提交
2867
}
2868
EXPORT_SYMBOL_GPL(ring_buffer_empty_cpu);
S
Steven Rostedt 已提交
2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884

/**
 * 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;
2885 2886
	int ret = -EINVAL;

2887 2888
	if (!cpumask_test_cpu(cpu, buffer_a->cpumask) ||
	    !cpumask_test_cpu(cpu, buffer_b->cpumask))
2889
		goto out;
S
Steven Rostedt 已提交
2890 2891

	/* At least make sure the two buffers are somewhat the same */
2892
	if (buffer_a->pages != buffer_b->pages)
2893 2894 2895
		goto out;

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

2897
	if (ring_buffer_flags != RB_BUFFERS_ON)
2898
		goto out;
2899 2900

	if (atomic_read(&buffer_a->record_disabled))
2901
		goto out;
2902 2903

	if (atomic_read(&buffer_b->record_disabled))
2904
		goto out;
2905

S
Steven Rostedt 已提交
2906 2907 2908
	cpu_buffer_a = buffer_a->buffers[cpu];
	cpu_buffer_b = buffer_b->buffers[cpu];

2909
	if (atomic_read(&cpu_buffer_a->record_disabled))
2910
		goto out;
2911 2912

	if (atomic_read(&cpu_buffer_b->record_disabled))
2913
		goto out;
2914

S
Steven Rostedt 已提交
2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932
	/*
	 * 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);

2933 2934 2935
	ret = 0;
out:
	return ret;
S
Steven Rostedt 已提交
2936
}
2937
EXPORT_SYMBOL_GPL(ring_buffer_swap_cpu);
S
Steven Rostedt 已提交
2938

S
Steven Rostedt 已提交
2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955
/**
 * 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)
{
2956
	struct buffer_data_page *bpage;
2957
	unsigned long addr;
S
Steven Rostedt 已提交
2958 2959 2960 2961 2962

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

2963
	bpage = (void *)addr;
S
Steven Rostedt 已提交
2964

2965 2966
	rb_init_page(bpage);

2967
	return bpage;
S
Steven Rostedt 已提交
2968
}
S
Steven Rostedt 已提交
2969
EXPORT_SYMBOL_GPL(ring_buffer_alloc_read_page);
S
Steven Rostedt 已提交
2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981

/**
 * 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);
}
S
Steven Rostedt 已提交
2982
EXPORT_SYMBOL_GPL(ring_buffer_free_read_page);
S
Steven Rostedt 已提交
2983 2984 2985 2986 2987

/**
 * 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
2988
 * @len: amount to extract
S
Steven Rostedt 已提交
2989 2990 2991 2992 2993 2994 2995 2996 2997
 * @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 已提交
2998
 *	rpage = ring_buffer_alloc_read_page(buffer);
S
Steven Rostedt 已提交
2999 3000
 *	if (!rpage)
 *		return error;
3001
 *	ret = ring_buffer_read_page(buffer, &rpage, len, cpu, 0);
3002 3003
 *	if (ret >= 0)
 *		process_page(rpage, ret);
S
Steven Rostedt 已提交
3004 3005 3006 3007 3008 3009 3010 3011 3012 3013
 *
 * 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:
3014 3015
 *  >=0 if data has been transferred, returns the offset of consumed data.
 *  <0 if no data has been transferred.
S
Steven Rostedt 已提交
3016 3017
 */
int ring_buffer_read_page(struct ring_buffer *buffer,
3018
			  void **data_page, size_t len, int cpu, int full)
S
Steven Rostedt 已提交
3019 3020 3021
{
	struct ring_buffer_per_cpu *cpu_buffer = buffer->buffers[cpu];
	struct ring_buffer_event *event;
3022
	struct buffer_data_page *bpage;
3023
	struct buffer_page *reader;
S
Steven Rostedt 已提交
3024
	unsigned long flags;
3025
	unsigned int commit;
3026
	unsigned int read;
3027
	u64 save_timestamp;
3028
	int ret = -1;
S
Steven Rostedt 已提交
3029

3030 3031 3032
	if (!cpumask_test_cpu(cpu, buffer->cpumask))
		goto out;

3033 3034 3035 3036 3037
	/*
	 * If len is not big enough to hold the page header, then
	 * we can not copy anything.
	 */
	if (len <= BUF_PAGE_HDR_SIZE)
3038
		goto out;
3039 3040 3041

	len -= BUF_PAGE_HDR_SIZE;

S
Steven Rostedt 已提交
3042
	if (!data_page)
3043
		goto out;
S
Steven Rostedt 已提交
3044

3045 3046
	bpage = *data_page;
	if (!bpage)
3047
		goto out;
S
Steven Rostedt 已提交
3048 3049 3050

	spin_lock_irqsave(&cpu_buffer->reader_lock, flags);

3051 3052
	reader = rb_get_reader_page(cpu_buffer);
	if (!reader)
3053
		goto out_unlock;
S
Steven Rostedt 已提交
3054

3055 3056 3057 3058
	event = rb_reader_event(cpu_buffer);

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

S
Steven Rostedt 已提交
3060
	/*
3061 3062 3063 3064 3065
	 * 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 已提交
3066
	 */
3067
	if (read || (len < (commit - read)) ||
3068
	    cpu_buffer->reader_page == cpu_buffer->commit_page) {
3069
		struct buffer_data_page *rpage = cpu_buffer->reader_page->page;
3070 3071
		unsigned int rpos = read;
		unsigned int pos = 0;
3072
		unsigned int size;
S
Steven Rostedt 已提交
3073 3074

		if (full)
3075
			goto out_unlock;
S
Steven Rostedt 已提交
3076

3077 3078 3079 3080 3081 3082
		if (len > (commit - read))
			len = (commit - read);

		size = rb_event_length(event);

		if (len < size)
3083
			goto out_unlock;
3084

3085 3086 3087
		/* save the current timestamp, since the user will need it */
		save_timestamp = cpu_buffer->read_stamp;

3088 3089
		/* Need to copy one event at a time */
		do {
3090
			memcpy(bpage->data + pos, rpage->data + rpos, size);
3091 3092 3093 3094

			len -= size;

			rb_advance_reader(cpu_buffer);
3095 3096
			rpos = reader->read;
			pos += size;
3097 3098 3099 3100

			event = rb_reader_event(cpu_buffer);
			size = rb_event_length(event);
		} while (len > size);
3101 3102

		/* update bpage */
3103
		local_set(&bpage->commit, pos);
3104
		bpage->time_stamp = save_timestamp;
3105

3106 3107
		/* we copied everything to the beginning */
		read = 0;
S
Steven Rostedt 已提交
3108
	} else {
3109 3110 3111
		/* update the entry counter */
		cpu_buffer->read += local_read(&reader->entries);

S
Steven Rostedt 已提交
3112
		/* swap the pages */
3113
		rb_init_page(bpage);
3114 3115 3116
		bpage = reader->page;
		reader->page = *data_page;
		local_set(&reader->write, 0);
3117
		local_set(&reader->entries, 0);
3118
		reader->read = 0;
3119
		*data_page = bpage;
S
Steven Rostedt 已提交
3120
	}
3121
	ret = read;
S
Steven Rostedt 已提交
3122

3123
 out_unlock:
S
Steven Rostedt 已提交
3124 3125
	spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);

3126
 out:
S
Steven Rostedt 已提交
3127 3128
	return ret;
}
S
Steven Rostedt 已提交
3129
EXPORT_SYMBOL_GPL(ring_buffer_read_page);
S
Steven Rostedt 已提交
3130

3131
#ifdef CONFIG_TRACING
3132 3133 3134 3135
static ssize_t
rb_simple_read(struct file *filp, char __user *ubuf,
	       size_t cnt, loff_t *ppos)
{
3136
	unsigned long *p = filp->private_data;
3137 3138 3139
	char buf[64];
	int r;

3140 3141 3142 3143
	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));
3144 3145 3146 3147 3148 3149 3150 3151

	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)
{
3152
	unsigned long *p = filp->private_data;
3153
	char buf[64];
3154
	unsigned long val;
3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168
	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;

3169 3170 3171 3172
	if (val)
		set_bit(RB_BUFFERS_ON_BIT, p);
	else
		clear_bit(RB_BUFFERS_ON_BIT, p);
3173 3174 3175 3176 3177 3178

	(*ppos)++;

	return cnt;
}

3179
static const struct file_operations rb_simple_fops = {
3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191
	.open		= tracing_open_generic,
	.read		= rb_simple_read,
	.write		= rb_simple_write,
};


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

	d_tracer = tracing_init_dentry();

3192 3193
	trace_create_file("tracing_on", 0644, d_tracer,
			    &ring_buffer_flags, &rb_simple_fops);
3194 3195 3196 3197 3198

	return 0;
}

fs_initcall(rb_init_debugfs);
3199
#endif
3200

3201
#ifdef CONFIG_HOTPLUG_CPU
3202 3203
static int rb_cpu_notify(struct notifier_block *self,
			 unsigned long action, void *hcpu)
3204 3205 3206 3207 3208 3209 3210 3211
{
	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:
3212
		if (cpumask_test_cpu(cpu, buffer->cpumask))
3213 3214 3215 3216 3217 3218 3219 3220 3221 3222
			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();
3223
		cpumask_set_cpu(cpu, buffer->cpumask);
3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238
		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