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

22 23
#include "trace.h"

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

31 32
	ret = trace_seq_printf(s, "# compressed entry header\n");
	ret = trace_seq_printf(s, "\ttype_len    :    5 bits\n");
33 34 35 36 37 38 39
	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);
40 41
	ret = trace_seq_printf(s, "\tdata max type_len  == %d\n",
			       RINGBUF_TYPE_DATA_TYPE_LEN_MAX);
42 43 44 45

	return ret;
}

46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113
/*
 * 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.
 *
 */

114 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
/*
 * 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,
};

153
static unsigned long ring_buffer_flags __read_mostly = RB_BUFFERS_ON;
154

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

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

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

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

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

203 204
#include "trace.h"

205
#define RB_EVNT_HDR_SIZE (offsetof(struct ring_buffer_event, array))
206
#define RB_ALIGNMENT		4U
207 208 209 210
#define RB_MAX_SMALL_DATA	(RB_ALIGNMENT * RINGBUF_TYPE_DATA_TYPE_LEN_MAX)

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

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

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

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

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

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

239 240
	if (event->type_len)
		length = event->type_len * RB_ALIGNMENT;
241 242 243 244 245 246 247 248 249
	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)
{
250
	switch (event->type_len) {
S
Steven Rostedt 已提交
251
	case RINGBUF_TYPE_PADDING:
252 253 254
		if (rb_null_event(event))
			/* undefined */
			return -1;
255
		return  event->array[0] + RB_EVNT_HDR_SIZE;
S
Steven Rostedt 已提交
256 257 258 259 260 261 262 263

	case RINGBUF_TYPE_TIME_EXTEND:
		return RB_LEN_TIME_EXTEND;

	case RINGBUF_TYPE_TIME_STAMP:
		return RB_LEN_TIME_STAMP;

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

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

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

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

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

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

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

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

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

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

368
#define BUF_PAGE_SIZE (PAGE_SIZE - BUF_PAGE_HDR_SIZE)
S
Steven Rostedt 已提交
369

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

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

376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397
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 已提交
398 399 400 401 402 403
/*
 * head_page == tail_page && head == tail then buffer is empty.
 */
struct ring_buffer_per_cpu {
	int				cpu;
	struct ring_buffer		*buffer;
S
Steven Rostedt 已提交
404
	spinlock_t			reader_lock; /* serialize readers */
405
	raw_spinlock_t			lock;
S
Steven Rostedt 已提交
406 407
	struct lock_class_key		lock_key;
	struct list_head		pages;
408 409
	struct buffer_page		*head_page;	/* read from head */
	struct buffer_page		*tail_page;	/* write to tail */
W
Wenji Huang 已提交
410
	struct buffer_page		*commit_page;	/* committed pages */
411
	struct buffer_page		*reader_page;
412 413
	unsigned long			nmi_dropped;
	unsigned long			commit_overrun;
S
Steven Rostedt 已提交
414
	unsigned long			overrun;
415 416
	unsigned long			read;
	local_t				entries;
S
Steven Rostedt 已提交
417 418 419 420 421 422 423 424 425 426
	u64				write_stamp;
	u64				read_stamp;
	atomic_t			record_disabled;
};

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

429 430
	struct lock_class_key		*reader_lock_key;

S
Steven Rostedt 已提交
431 432 433
	struct mutex			mutex;

	struct ring_buffer_per_cpu	**buffers;
434

435
#ifdef CONFIG_HOTPLUG_CPU
436 437
	struct notifier_block		cpu_notify;
#endif
438
	u64				(*clock)(void);
S
Steven Rostedt 已提交
439 440 441 442 443 444 445 446 447
};

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

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

459 460 461
/* Up this if you want to test the TIME_EXTENTS and normalization */
#define DEBUG_SHIFT 0

462 463 464 465 466 467
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;
}

468 469 470 471 472
u64 ring_buffer_time_stamp(struct ring_buffer *buffer, int cpu)
{
	u64 time;

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

S
Steven Rostedt 已提交
500 501 502 503
	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 已提交
504

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

	return 0;
}

static int rb_allocate_pages(struct ring_buffer_per_cpu *cpu_buffer,
			     unsigned nr_pages)
{
	struct list_head *head = &cpu_buffer->pages;
521
	struct buffer_page *bpage, *tmp;
S
Steven Rostedt 已提交
522 523 524 525 526
	unsigned long addr;
	LIST_HEAD(pages);
	unsigned i;

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

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

	list_splice(&pages, head);

	rb_check_pages(cpu_buffer);

	return 0;

 free_pages:
547 548 549
	list_for_each_entry_safe(bpage, tmp, &pages, list) {
		list_del_init(&bpage->list);
		free_buffer_page(bpage);
S
Steven Rostedt 已提交
550 551 552 553 554 555 556 557
	}
	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;
558
	struct buffer_page *bpage;
559
	unsigned long addr;
S
Steven Rostedt 已提交
560 561 562 563 564 565 566 567 568
	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 已提交
569
	spin_lock_init(&cpu_buffer->reader_lock);
570
	lockdep_set_class(&cpu_buffer->reader_lock, buffer->reader_lock_key);
571
	cpu_buffer->lock = (raw_spinlock_t)__RAW_SPIN_LOCK_UNLOCKED;
S
Steven Rostedt 已提交
572 573
	INIT_LIST_HEAD(&cpu_buffer->pages);

574
	bpage = kzalloc_node(ALIGN(sizeof(*bpage), cache_line_size()),
575
			    GFP_KERNEL, cpu_to_node(cpu));
576
	if (!bpage)
577 578
		goto fail_free_buffer;

579
	cpu_buffer->reader_page = bpage;
580 581
	addr = __get_free_page(GFP_KERNEL);
	if (!addr)
582
		goto fail_free_reader;
583 584
	bpage->page = (void *)addr;
	rb_init_page(bpage->page);
585

586 587
	INIT_LIST_HEAD(&cpu_buffer->reader_page->list);

S
Steven Rostedt 已提交
588 589
	ret = rb_allocate_pages(cpu_buffer, buffer->pages);
	if (ret < 0)
590
		goto fail_free_reader;
S
Steven Rostedt 已提交
591 592 593

	cpu_buffer->head_page
		= list_entry(cpu_buffer->pages.next, struct buffer_page, list);
S
Steven Rostedt 已提交
594
	cpu_buffer->tail_page = cpu_buffer->commit_page = cpu_buffer->head_page;
S
Steven Rostedt 已提交
595 596 597

	return cpu_buffer;

598 599 600
 fail_free_reader:
	free_buffer_page(cpu_buffer->reader_page);

S
Steven Rostedt 已提交
601 602 603 604 605 606 607 608
 fail_free_buffer:
	kfree(cpu_buffer);
	return NULL;
}

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

611 612
	free_buffer_page(cpu_buffer->reader_page);

613 614 615
	list_for_each_entry_safe(bpage, tmp, head, list) {
		list_del_init(&bpage->list);
		free_buffer_page(bpage);
S
Steven Rostedt 已提交
616 617 618 619
	}
	kfree(cpu_buffer);
}

620 621 622 623 624 625
/*
 * Causes compile errors if the struct buffer_page gets bigger
 * than the struct page.
 */
extern int ring_buffer_page_too_big(void);

626
#ifdef CONFIG_HOTPLUG_CPU
627 628
static int rb_cpu_notify(struct notifier_block *self,
			 unsigned long action, void *hcpu);
629 630
#endif

S
Steven Rostedt 已提交
631 632
/**
 * ring_buffer_alloc - allocate a new ring_buffer
633
 * @size: the size in bytes per cpu that is needed.
S
Steven Rostedt 已提交
634 635 636 637 638 639 640
 * @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.
 */
641 642
struct ring_buffer *__ring_buffer_alloc(unsigned long size, unsigned flags,
					struct lock_class_key *key)
S
Steven Rostedt 已提交
643 644 645 646 647
{
	struct ring_buffer *buffer;
	int bsize;
	int cpu;

648 649 650 651 652
	/* Paranoid! Optimizes out when all is well */
	if (sizeof(struct buffer_page) > sizeof(struct page))
		ring_buffer_page_too_big();


S
Steven Rostedt 已提交
653 654 655 656 657 658
	/* keep it in its own cache line */
	buffer = kzalloc(ALIGN(sizeof(*buffer), cache_line_size()),
			 GFP_KERNEL);
	if (!buffer)
		return NULL;

659 660 661
	if (!alloc_cpumask_var(&buffer->cpumask, GFP_KERNEL))
		goto fail_free_buffer;

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

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

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

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

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

697
#ifdef CONFIG_HOTPLUG_CPU
698 699 700 701 702 703
	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 已提交
704 705 706 707 708 709 710 711 712 713 714
	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);

715 716
 fail_free_cpumask:
	free_cpumask_var(buffer->cpumask);
717
	put_online_cpus();
718

S
Steven Rostedt 已提交
719 720 721 722
 fail_free_buffer:
	kfree(buffer);
	return NULL;
}
723
EXPORT_SYMBOL_GPL(__ring_buffer_alloc);
S
Steven Rostedt 已提交
724 725 726 727 728 729 730 731 732 733

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

734 735
	get_online_cpus();

736
#ifdef CONFIG_HOTPLUG_CPU
737 738 739
	unregister_cpu_notifier(&buffer->cpu_notify);
#endif

S
Steven Rostedt 已提交
740 741 742
	for_each_buffer_cpu(buffer, cpu)
		rb_free_cpu_buffer(buffer->buffers[cpu]);

743 744
	put_online_cpus();

745 746
	free_cpumask_var(buffer->cpumask);

S
Steven Rostedt 已提交
747 748
	kfree(buffer);
}
749
EXPORT_SYMBOL_GPL(ring_buffer_free);
S
Steven Rostedt 已提交
750

751 752 753 754 755 756
void ring_buffer_set_clock(struct ring_buffer *buffer,
			   u64 (*clock)(void))
{
	buffer->clock = clock;
}

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

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

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

	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)
{
792
	struct buffer_page *bpage;
S
Steven Rostedt 已提交
793 794 795 796 797 798 799
	struct list_head *p;
	unsigned i;

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

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

838 839 840 841 842 843
	/*
	 * Always succeed at resizing a non-existent buffer:
	 */
	if (!buffer)
		return size;

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

	nr_pages = DIV_ROUND_UP(size, BUF_PAGE_SIZE);

	if (size < buffer_size) {

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

		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;
	 */
883 884
	if (RB_WARN_ON(buffer, nr_pages <= buffer->pages))
		goto out_fail;
885

S
Steven Rostedt 已提交
886 887 888 889
	new_pages = nr_pages - buffer->pages;

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

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

909 910
	if (RB_WARN_ON(buffer, !list_empty(&pages)))
		goto out_fail;
S
Steven Rostedt 已提交
911 912 913

 out:
	buffer->pages = nr_pages;
914
	put_online_cpus();
S
Steven Rostedt 已提交
915 916 917 918 919
	mutex_unlock(&buffer->mutex);

	return size;

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

	/*
	 * 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 已提交
936
}
937
EXPORT_SYMBOL_GPL(ring_buffer_resize);
S
Steven Rostedt 已提交
938

S
Steven Rostedt 已提交
939
static inline void *
940
__rb_data_page_index(struct buffer_data_page *bpage, unsigned index)
S
Steven Rostedt 已提交
941
{
942
	return bpage->data + index;
S
Steven Rostedt 已提交
943 944
}

945
static inline void *__rb_page_index(struct buffer_page *bpage, unsigned index)
S
Steven Rostedt 已提交
946
{
947
	return bpage->page->data + index;
S
Steven Rostedt 已提交
948 949 950
}

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

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

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

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

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

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

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

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

1016
static inline int
S
Steven Rostedt 已提交
1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029
rb_is_commit(struct ring_buffer_per_cpu *cpu_buffer,
	     struct ring_buffer_event *event)
{
	unsigned long addr = (unsigned long)event;
	unsigned long index;

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

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

1030
static void
S
Steven Rostedt 已提交
1031 1032
rb_set_commit_event(struct ring_buffer_per_cpu *cpu_buffer,
		    struct ring_buffer_event *event)
S
Steven Rostedt 已提交
1033
{
S
Steven Rostedt 已提交
1034 1035 1036 1037 1038 1039 1040
	unsigned long addr = (unsigned long)event;
	unsigned long index;

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

	while (cpu_buffer->commit_page->page != (void *)addr) {
S
Steven Rostedt 已提交
1041 1042 1043
		if (RB_WARN_ON(cpu_buffer,
			  cpu_buffer->commit_page == cpu_buffer->tail_page))
			return;
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
	}

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

1055
static void
S
Steven Rostedt 已提交
1056
rb_set_commit_to_write(struct ring_buffer_per_cpu *cpu_buffer)
S
Steven Rostedt 已提交
1057
{
S
Steven Rostedt 已提交
1058 1059 1060 1061 1062 1063 1064 1065
	/*
	 * 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.
	 */
1066
 again:
S
Steven Rostedt 已提交
1067
	while (cpu_buffer->commit_page != cpu_buffer->tail_page) {
1068
		cpu_buffer->commit_page->page->commit =
S
Steven Rostedt 已提交
1069 1070
			cpu_buffer->commit_page->write;
		rb_inc_page(cpu_buffer, &cpu_buffer->commit_page);
1071 1072
		cpu_buffer->write_stamp =
			cpu_buffer->commit_page->page->time_stamp;
S
Steven Rostedt 已提交
1073 1074 1075 1076 1077
		/* add barrier to keep gcc from optimizing too much */
		barrier();
	}
	while (rb_commit_index(cpu_buffer) !=
	       rb_page_write(cpu_buffer->commit_page)) {
1078
		cpu_buffer->commit_page->page->commit =
S
Steven Rostedt 已提交
1079 1080 1081
			cpu_buffer->commit_page->write;
		barrier();
	}
1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092

	/* 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 已提交
1093 1094
}

1095
static void rb_reset_reader_page(struct ring_buffer_per_cpu *cpu_buffer)
S
Steven Rostedt 已提交
1096
{
1097
	cpu_buffer->read_stamp = cpu_buffer->reader_page->page->time_stamp;
1098
	cpu_buffer->reader_page->read = 0;
1099 1100
}

1101
static void rb_inc_iter(struct ring_buffer_iter *iter)
1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115
{
	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);

1116
	iter->read_stamp = iter->head_page->page->time_stamp;
S
Steven Rostedt 已提交
1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130
	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.
 */
1131
static void
S
Steven Rostedt 已提交
1132 1133 1134
rb_update_event(struct ring_buffer_event *event,
			 unsigned type, unsigned length)
{
1135
	event->type_len = type;
S
Steven Rostedt 已提交
1136 1137 1138 1139 1140 1141 1142 1143

	switch (type) {

	case RINGBUF_TYPE_PADDING:
	case RINGBUF_TYPE_TIME_EXTEND:
	case RINGBUF_TYPE_TIME_STAMP:
		break;

1144
	case 0:
S
Steven Rostedt 已提交
1145
		length -= RB_EVNT_HDR_SIZE;
1146
		if (length > RB_MAX_SMALL_DATA)
S
Steven Rostedt 已提交
1147
			event->array[0] = length;
1148 1149
		else
			event->type_len = DIV_ROUND_UP(length, RB_ALIGNMENT);
S
Steven Rostedt 已提交
1150 1151 1152 1153 1154 1155
		break;
	default:
		BUG();
	}
}

1156
static unsigned rb_calculate_event_length(unsigned length)
S
Steven Rostedt 已提交
1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172
{
	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;
}

1173

S
Steven Rostedt 已提交
1174
static struct ring_buffer_event *
1175 1176 1177 1178
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 已提交
1179
{
1180
	struct buffer_page *next_page, *head_page, *reader_page;
S
Steven Rostedt 已提交
1181 1182
	struct ring_buffer *buffer = cpu_buffer->buffer;
	struct ring_buffer_event *event;
1183
	bool lock_taken = false;
1184
	unsigned long flags;
1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 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

	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 */
1263
		*ts = rb_time_stamp(buffer, cpu_buffer->cpu);
1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275
		cpu_buffer->tail_page->page->time_stamp = *ts;
	}

	/*
	 * The actual tail page has moved forward.
	 */
	if (tail < BUF_PAGE_SIZE) {
		/* Mark the rest of the page with padding */
		event = __rb_page_index(tail_page, tail);
		rb_event_set_padding(event);
	}

1276 1277
	/* Set the write back to the previous setting */
	local_sub(length, &tail_page->write);
1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293

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

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

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

1294
 out_reset:
1295
	/* reset write */
1296
	local_sub(length, &tail_page->write);
1297

1298 1299
	if (likely(lock_taken))
		__raw_spin_unlock(&cpu_buffer->lock);
1300
	local_irq_restore(flags);
S
Steven Rostedt 已提交
1301
	return NULL;
S
Steven Rostedt 已提交
1302 1303
}

1304 1305 1306 1307 1308 1309 1310 1311 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 1337 1338 1339 1340 1341 1342 1343 1344 1345
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 */

	if (RB_WARN_ON(cpu_buffer, write > BUF_PAGE_SIZE))
		return NULL;

	event = __rb_page_index(tail_page, tail);
	rb_update_event(event, type, length);

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

	/*
	 * If this is a commit and the tail is zero, then update
	 * this page's time stamp.
	 */
	if (!tail && rb_is_commit(cpu_buffer, event))
		cpu_buffer->commit_page->page->time_stamp = *ts;

	return event;
}

1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377
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 已提交
1378 1379 1380 1381 1382 1383
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 已提交
1384
	int ret;
S
Steven Rostedt 已提交
1385 1386 1387 1388

	if (unlikely(*delta > (1ULL << 59) && !once++)) {
		printk(KERN_WARNING "Delta way too big! %llu"
		       " ts=%llu write stamp = %llu\n",
1389 1390 1391
		       (unsigned long long)*delta,
		       (unsigned long long)*ts,
		       (unsigned long long)cpu_buffer->write_stamp);
S
Steven Rostedt 已提交
1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403
		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 已提交
1404
		return -EBUSY;
S
Steven Rostedt 已提交
1405

S
Steven Rostedt 已提交
1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418
	if (PTR_ERR(event) == -EAGAIN)
		return -EAGAIN;

	/* Only a commited time event can update the write stamp */
	if (rb_is_commit(cpu_buffer, event)) {
		/*
		 * If this is the first on the page, then we need to
		 * update the page itself, and just put in a zero.
		 */
		if (rb_event_index(event)) {
			event->time_delta = *delta & TS_MASK;
			event->array[0] = *delta >> TS_SHIFT;
		} else {
1419
			cpu_buffer->commit_page->page->time_stamp = *ts;
1420 1421 1422 1423 1424 1425
			/* 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 已提交
1426
		}
S
Steven Rostedt 已提交
1427
		cpu_buffer->write_stamp = *ts;
S
Steven Rostedt 已提交
1428 1429 1430
		/* let the caller know this was the commit */
		ret = 1;
	} else {
1431 1432 1433 1434 1435 1436 1437
		/* 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;
			ret = 0;
		}
S
Steven Rostedt 已提交
1438 1439
	}

S
Steven Rostedt 已提交
1440 1441 1442
	*delta = 0;

	return ret;
S
Steven Rostedt 已提交
1443 1444 1445 1446
}

static struct ring_buffer_event *
rb_reserve_next_event(struct ring_buffer_per_cpu *cpu_buffer,
1447
		      unsigned long length)
S
Steven Rostedt 已提交
1448 1449
{
	struct ring_buffer_event *event;
1450
	u64 ts, delta = 0;
S
Steven Rostedt 已提交
1451
	int commit = 0;
1452
	int nr_loops = 0;
S
Steven Rostedt 已提交
1453

1454
	length = rb_calculate_event_length(length);
S
Steven Rostedt 已提交
1455
 again:
1456 1457 1458 1459 1460 1461 1462 1463 1464
	/*
	 * 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 已提交
1465
	if (RB_WARN_ON(cpu_buffer, ++nr_loops > 1000))
1466 1467
		return NULL;

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

S
Steven Rostedt 已提交
1470 1471 1472 1473 1474 1475 1476 1477
	/*
	 * 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.
	 */
1478 1479 1480
	if (likely(cpu_buffer->tail_page == cpu_buffer->commit_page &&
		   rb_page_write(cpu_buffer->tail_page) ==
		   rb_commit_index(cpu_buffer))) {
1481
		u64 diff;
S
Steven Rostedt 已提交
1482

1483
		diff = ts - cpu_buffer->write_stamp;
S
Steven Rostedt 已提交
1484

1485
		/* make sure this diff is calculated here */
S
Steven Rostedt 已提交
1486 1487 1488 1489
		barrier();

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

1492 1493
		delta = diff;
		if (unlikely(test_time_stamp(delta))) {
S
Steven Rostedt 已提交
1494

S
Steven Rostedt 已提交
1495 1496
			commit = rb_add_time_stamp(cpu_buffer, &ts, &delta);
			if (commit == -EBUSY)
S
Steven Rostedt 已提交
1497
				return NULL;
S
Steven Rostedt 已提交
1498 1499 1500 1501 1502

			if (commit == -EAGAIN)
				goto again;

			RB_WARN_ON(cpu_buffer, commit < 0);
S
Steven Rostedt 已提交
1503
		}
1504
	}
S
Steven Rostedt 已提交
1505

1506
 get_event:
1507
	event = __rb_reserve_next(cpu_buffer, 0, length, &ts);
1508
	if (unlikely(PTR_ERR(event) == -EAGAIN))
S
Steven Rostedt 已提交
1509 1510 1511 1512 1513 1514 1515 1516 1517
		goto again;

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

S
Steven Rostedt 已提交
1521 1522 1523 1524
	/*
	 * If the timestamp was commited, make the commit our entry
	 * now so that we will update it when needed.
	 */
1525
	if (unlikely(commit))
S
Steven Rostedt 已提交
1526 1527
		rb_set_commit_event(cpu_buffer, event);
	else if (!rb_is_commit(cpu_buffer, event))
S
Steven Rostedt 已提交
1528 1529 1530 1531 1532 1533 1534
		delta = 0;

	event->time_delta = delta;

	return event;
}

1535
#define TRACE_RECURSIVE_DEPTH 16
1536 1537 1538

static int trace_recursive_lock(void)
{
1539
	current->trace_recursion++;
1540

1541 1542
	if (likely(current->trace_recursion < TRACE_RECURSIVE_DEPTH))
		return 0;
1543

1544 1545
	/* Disable all tracing before we do anything else */
	tracing_off_permanent();
1546

S
Steven Rostedt 已提交
1547
	printk_once(KERN_WARNING "Tracing recursion: depth[%ld]:"
1548 1549 1550 1551 1552
		    "HC[%lu]:SC[%lu]:NMI[%lu]\n",
		    current->trace_recursion,
		    hardirq_count() >> HARDIRQ_SHIFT,
		    softirq_count() >> SOFTIRQ_SHIFT,
		    in_nmi());
1553

1554 1555
	WARN_ON_ONCE(1);
	return -1;
1556 1557 1558 1559
}

static void trace_recursive_unlock(void)
{
1560
	WARN_ON_ONCE(!current->trace_recursion);
1561

1562
	current->trace_recursion--;
1563 1564
}

S
Steven Rostedt 已提交
1565 1566
static DEFINE_PER_CPU(int, rb_need_resched);

S
Steven Rostedt 已提交
1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582
/**
 * 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 *
1583
ring_buffer_lock_reserve(struct ring_buffer *buffer, unsigned long length)
S
Steven Rostedt 已提交
1584 1585 1586
{
	struct ring_buffer_per_cpu *cpu_buffer;
	struct ring_buffer_event *event;
S
Steven Rostedt 已提交
1587
	int cpu, resched;
S
Steven Rostedt 已提交
1588

1589
	if (ring_buffer_flags != RB_BUFFERS_ON)
1590 1591
		return NULL;

S
Steven Rostedt 已提交
1592 1593 1594
	if (atomic_read(&buffer->record_disabled))
		return NULL;

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

1598 1599 1600
	if (trace_recursive_lock())
		goto out_nocheck;

S
Steven Rostedt 已提交
1601 1602
	cpu = raw_smp_processor_id();

1603
	if (!cpumask_test_cpu(cpu, buffer->cpumask))
1604
		goto out;
S
Steven Rostedt 已提交
1605 1606 1607 1608

	cpu_buffer = buffer->buffers[cpu];

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

1611
	if (length > BUF_MAX_DATA_SIZE)
S
Steven Rostedt 已提交
1612
		goto out;
S
Steven Rostedt 已提交
1613

1614
	event = rb_reserve_next_event(cpu_buffer, length);
S
Steven Rostedt 已提交
1615
	if (!event)
1616
		goto out;
S
Steven Rostedt 已提交
1617

S
Steven Rostedt 已提交
1618 1619 1620 1621 1622 1623 1624 1625
	/*
	 * 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 已提交
1626 1627
	return event;

1628
 out:
1629 1630 1631
	trace_recursive_unlock();

 out_nocheck:
1632
	ftrace_preempt_enable(resched);
S
Steven Rostedt 已提交
1633 1634
	return NULL;
}
1635
EXPORT_SYMBOL_GPL(ring_buffer_lock_reserve);
S
Steven Rostedt 已提交
1636 1637 1638 1639

static void rb_commit(struct ring_buffer_per_cpu *cpu_buffer,
		      struct ring_buffer_event *event)
{
1640
	local_inc(&cpu_buffer->entries);
S
Steven Rostedt 已提交
1641 1642 1643 1644 1645 1646 1647 1648

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

	cpu_buffer->write_stamp += event->time_delta;

	rb_set_commit_to_write(cpu_buffer);
S
Steven Rostedt 已提交
1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660
}

/**
 * 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,
1661
			      struct ring_buffer_event *event)
S
Steven Rostedt 已提交
1662 1663 1664 1665 1666 1667 1668 1669
{
	struct ring_buffer_per_cpu *cpu_buffer;
	int cpu = raw_smp_processor_id();

	cpu_buffer = buffer->buffers[cpu];

	rb_commit(cpu_buffer, event);

1670 1671
	trace_recursive_unlock();

S
Steven Rostedt 已提交
1672 1673 1674
	/*
	 * Only the last preempt count needs to restore preemption.
	 */
1675 1676 1677
	if (preempt_count() == 1)
		ftrace_preempt_enable(per_cpu(rb_need_resched, cpu));
	else
S
Steven Rostedt 已提交
1678
		preempt_enable_no_resched_notrace();
S
Steven Rostedt 已提交
1679 1680 1681

	return 0;
}
1682
EXPORT_SYMBOL_GPL(ring_buffer_unlock_commit);
S
Steven Rostedt 已提交
1683

1684 1685
static inline void rb_event_discard(struct ring_buffer_event *event)
{
1686 1687 1688
	/* 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;
1689 1690 1691 1692 1693
	/* time delta must be non zero */
	if (!event->time_delta)
		event->time_delta = 1;
}

1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707
/**
 * 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)
{
1708
	rb_event_discard(event);
1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734
}
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 */
1735
	rb_event_discard(event);
1736 1737 1738 1739 1740 1741

	/*
	 * This must only be called if the event has not been
	 * committed yet. Thus we can assume that preemption
	 * is still disabled.
	 */
1742
	RB_WARN_ON(buffer, preemptible());
1743 1744 1745 1746

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

1747 1748
	if (!rb_try_to_discard(cpu_buffer, event))
		goto out;
1749 1750 1751 1752 1753

	/*
	 * The commit is still visible by the reader, so we
	 * must increment entries.
	 */
1754
	local_inc(&cpu_buffer->entries);
1755 1756 1757 1758 1759 1760 1761 1762 1763
 out:
	/*
	 * If a write came in and pushed the tail page
	 * we still need to update the commit pointer
	 * if we were the commit.
	 */
	if (rb_is_commit(cpu_buffer, event))
		rb_set_commit_to_write(cpu_buffer);

1764 1765
	trace_recursive_unlock();

1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776
	/*
	 * 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 已提交
1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797
/**
 * 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 已提交
1798
	int cpu, resched;
S
Steven Rostedt 已提交
1799

1800
	if (ring_buffer_flags != RB_BUFFERS_ON)
1801 1802
		return -EBUSY;

S
Steven Rostedt 已提交
1803 1804 1805
	if (atomic_read(&buffer->record_disabled))
		return -EBUSY;

1806
	resched = ftrace_preempt_disable();
S
Steven Rostedt 已提交
1807

S
Steven Rostedt 已提交
1808 1809
	cpu = raw_smp_processor_id();

1810
	if (!cpumask_test_cpu(cpu, buffer->cpumask))
1811
		goto out;
S
Steven Rostedt 已提交
1812 1813 1814 1815 1816 1817

	cpu_buffer = buffer->buffers[cpu];

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

1818 1819 1820 1821
	if (length > BUF_MAX_DATA_SIZE)
		goto out;

	event = rb_reserve_next_event(cpu_buffer, length);
S
Steven Rostedt 已提交
1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832
	if (!event)
		goto out;

	body = rb_event_data(event);

	memcpy(body, data, length);

	rb_commit(cpu_buffer, event);

	ret = 0;
 out:
1833
	ftrace_preempt_enable(resched);
S
Steven Rostedt 已提交
1834 1835 1836

	return ret;
}
1837
EXPORT_SYMBOL_GPL(ring_buffer_write);
S
Steven Rostedt 已提交
1838

1839
static int rb_per_cpu_empty(struct ring_buffer_per_cpu *cpu_buffer)
S
Steven Rostedt 已提交
1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850
{
	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 已提交
1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863
/**
 * 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);
}
1864
EXPORT_SYMBOL_GPL(ring_buffer_record_disable);
S
Steven Rostedt 已提交
1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876

/**
 * 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);
}
1877
EXPORT_SYMBOL_GPL(ring_buffer_record_enable);
S
Steven Rostedt 已提交
1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892

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

1893
	if (!cpumask_test_cpu(cpu, buffer->cpumask))
1894
		return;
S
Steven Rostedt 已提交
1895 1896 1897 1898

	cpu_buffer = buffer->buffers[cpu];
	atomic_inc(&cpu_buffer->record_disabled);
}
1899
EXPORT_SYMBOL_GPL(ring_buffer_record_disable_cpu);
S
Steven Rostedt 已提交
1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912

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

1913
	if (!cpumask_test_cpu(cpu, buffer->cpumask))
1914
		return;
S
Steven Rostedt 已提交
1915 1916 1917 1918

	cpu_buffer = buffer->buffers[cpu];
	atomic_dec(&cpu_buffer->record_disabled);
}
1919
EXPORT_SYMBOL_GPL(ring_buffer_record_enable_cpu);
S
Steven Rostedt 已提交
1920 1921 1922 1923 1924 1925 1926 1927 1928

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

1931
	if (!cpumask_test_cpu(cpu, buffer->cpumask))
1932
		return 0;
S
Steven Rostedt 已提交
1933 1934

	cpu_buffer = buffer->buffers[cpu];
1935 1936
	ret = (local_read(&cpu_buffer->entries) - cpu_buffer->overrun)
		- cpu_buffer->read;
1937 1938

	return ret;
S
Steven Rostedt 已提交
1939
}
1940
EXPORT_SYMBOL_GPL(ring_buffer_entries_cpu);
S
Steven Rostedt 已提交
1941 1942 1943 1944 1945 1946 1947 1948 1949

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

1952
	if (!cpumask_test_cpu(cpu, buffer->cpumask))
1953
		return 0;
S
Steven Rostedt 已提交
1954 1955

	cpu_buffer = buffer->buffers[cpu];
1956 1957 1958
	ret = cpu_buffer->overrun;

	return ret;
S
Steven Rostedt 已提交
1959
}
1960
EXPORT_SYMBOL_GPL(ring_buffer_overrun_cpu);
S
Steven Rostedt 已提交
1961

1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002
/**
 * 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 已提交
2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018
/**
 * 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];
2019 2020
		entries += (local_read(&cpu_buffer->entries) -
			    cpu_buffer->overrun) - cpu_buffer->read;
S
Steven Rostedt 已提交
2021 2022 2023 2024
	}

	return entries;
}
2025
EXPORT_SYMBOL_GPL(ring_buffer_entries);
S
Steven Rostedt 已提交
2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047

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

2050
static void rb_iter_reset(struct ring_buffer_iter *iter)
S
Steven Rostedt 已提交
2051 2052 2053
{
	struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;

2054 2055 2056
	/* Iterator usage is expected to have record disabled */
	if (list_empty(&cpu_buffer->reader_page->list)) {
		iter->head_page = cpu_buffer->head_page;
2057
		iter->head = cpu_buffer->head_page->read;
2058 2059
	} else {
		iter->head_page = cpu_buffer->reader_page;
2060
		iter->head = cpu_buffer->reader_page->read;
2061 2062 2063 2064
	}
	if (iter->head)
		iter->read_stamp = cpu_buffer->read_stamp;
	else
2065
		iter->read_stamp = iter->head_page->page->time_stamp;
2066
}
S
Steven Rostedt 已提交
2067

2068 2069 2070 2071 2072 2073 2074 2075 2076
/**
 * 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)
{
2077
	struct ring_buffer_per_cpu *cpu_buffer;
2078 2079
	unsigned long flags;

2080 2081 2082 2083 2084
	if (!iter)
		return;

	cpu_buffer = iter->cpu_buffer;

2085 2086
	spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
	rb_iter_reset(iter);
S
Steven Rostedt 已提交
2087
	spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
S
Steven Rostedt 已提交
2088
}
2089
EXPORT_SYMBOL_GPL(ring_buffer_iter_reset);
S
Steven Rostedt 已提交
2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100

/**
 * 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 已提交
2101 2102
	return iter->head_page == cpu_buffer->commit_page &&
		iter->head == rb_commit_index(cpu_buffer);
S
Steven Rostedt 已提交
2103
}
2104
EXPORT_SYMBOL_GPL(ring_buffer_iter_empty);
S
Steven Rostedt 已提交
2105 2106 2107 2108 2109 2110 2111

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

2112
	switch (event->type_len) {
S
Steven Rostedt 已提交
2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142
	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;

2143
	switch (event->type_len) {
S
Steven Rostedt 已提交
2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167
	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;
}

2168 2169
static struct buffer_page *
rb_get_reader_page(struct ring_buffer_per_cpu *cpu_buffer)
S
Steven Rostedt 已提交
2170
{
2171 2172
	struct buffer_page *reader = NULL;
	unsigned long flags;
2173
	int nr_loops = 0;
2174

2175 2176
	local_irq_save(flags);
	__raw_spin_lock(&cpu_buffer->lock);
2177 2178

 again:
2179 2180 2181 2182 2183 2184
	/*
	 * 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 已提交
2185
	if (RB_WARN_ON(cpu_buffer, ++nr_loops > 3)) {
2186 2187 2188 2189
		reader = NULL;
		goto out;
	}

2190 2191 2192
	reader = cpu_buffer->reader_page;

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

	/* Never should we have an index greater than the size */
S
Steven Rostedt 已提交
2197 2198 2199
	if (RB_WARN_ON(cpu_buffer,
		       cpu_buffer->reader_page->read > rb_page_size(reader)))
		goto out;
2200 2201 2202

	/* check if we caught up to the tail */
	reader = NULL;
S
Steven Rostedt 已提交
2203
	if (cpu_buffer->commit_page == cpu_buffer->reader_page)
2204
		goto out;
S
Steven Rostedt 已提交
2205 2206

	/*
2207 2208
	 * Splice the empty reader page into the list around the head.
	 * Reset the reader page to size zero.
S
Steven Rostedt 已提交
2209 2210
	 */

2211 2212 2213
	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 已提交
2214 2215

	local_set(&cpu_buffer->reader_page->write, 0);
2216
	local_set(&cpu_buffer->reader_page->entries, 0);
2217
	local_set(&cpu_buffer->reader_page->page->commit, 0);
S
Steven Rostedt 已提交
2218

2219 2220 2221
	/* 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 已提交
2222 2223

	/*
2224 2225
	 * 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 已提交
2226
	 */
2227
	cpu_buffer->head_page = cpu_buffer->reader_page;
S
Steven Rostedt 已提交
2228

S
Steven Rostedt 已提交
2229
	if (cpu_buffer->commit_page != reader)
2230 2231 2232 2233 2234 2235 2236 2237 2238
		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:
2239 2240
	__raw_spin_unlock(&cpu_buffer->lock);
	local_irq_restore(flags);
2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251

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

2253
	/* This function should not be called when buffer is empty */
S
Steven Rostedt 已提交
2254 2255
	if (RB_WARN_ON(cpu_buffer, !reader))
		return;
S
Steven Rostedt 已提交
2256

2257 2258
	event = rb_reader_event(cpu_buffer);

2259 2260
	if (event->type_len <= RINGBUF_TYPE_DATA_TYPE_LEN_MAX
			|| rb_discarded_event(event))
2261
		cpu_buffer->read++;
2262 2263 2264 2265

	rb_update_read_stamp(cpu_buffer, event);

	length = rb_event_length(event);
2266
	cpu_buffer->reader_page->read += length;
S
Steven Rostedt 已提交
2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281
}

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 已提交
2282
	if (iter->head >= rb_page_size(iter->head_page)) {
2283 2284
		/* discarded commits can make the page empty */
		if (iter->head_page == cpu_buffer->commit_page)
S
Steven Rostedt 已提交
2285
			return;
2286
		rb_inc_iter(iter);
S
Steven Rostedt 已提交
2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297
		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 已提交
2298
	if (RB_WARN_ON(cpu_buffer,
2299
		       (iter->head_page == cpu_buffer->commit_page) &&
S
Steven Rostedt 已提交
2300 2301
		       (iter->head + length > rb_commit_index(cpu_buffer))))
		return;
S
Steven Rostedt 已提交
2302 2303 2304 2305 2306 2307

	rb_update_iter_read_stamp(iter, event);

	iter->head += length;

	/* check for end of page padding */
S
Steven Rostedt 已提交
2308 2309
	if ((iter->head >= rb_page_size(iter->head_page)) &&
	    (iter->head_page != cpu_buffer->commit_page))
S
Steven Rostedt 已提交
2310 2311 2312
		rb_advance_iter(iter);
}

S
Steven Rostedt 已提交
2313 2314
static struct ring_buffer_event *
rb_buffer_peek(struct ring_buffer *buffer, int cpu, u64 *ts)
S
Steven Rostedt 已提交
2315 2316 2317
{
	struct ring_buffer_per_cpu *cpu_buffer;
	struct ring_buffer_event *event;
2318
	struct buffer_page *reader;
2319
	int nr_loops = 0;
S
Steven Rostedt 已提交
2320 2321 2322 2323

	cpu_buffer = buffer->buffers[cpu];

 again:
2324 2325 2326
	/*
	 * We repeat when a timestamp is encountered. It is possible
	 * to get multiple timestamps from an interrupt entering just
2327 2328
	 * 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.
2329
	 */
2330
	if (RB_WARN_ON(cpu_buffer, ++nr_loops > RB_TIMESTAMPS_PER_PAGE))
2331 2332
		return NULL;

2333 2334
	reader = rb_get_reader_page(cpu_buffer);
	if (!reader)
S
Steven Rostedt 已提交
2335 2336
		return NULL;

2337
	event = rb_reader_event(cpu_buffer);
S
Steven Rostedt 已提交
2338

2339
	switch (event->type_len) {
S
Steven Rostedt 已提交
2340
	case RINGBUF_TYPE_PADDING:
2341 2342 2343 2344 2345 2346 2347 2348 2349 2350
		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.
		 */
2351
		rb_advance_reader(cpu_buffer);
2352
		return event;
S
Steven Rostedt 已提交
2353 2354 2355

	case RINGBUF_TYPE_TIME_EXTEND:
		/* Internal data, OK to advance */
2356
		rb_advance_reader(cpu_buffer);
S
Steven Rostedt 已提交
2357 2358 2359 2360
		goto again;

	case RINGBUF_TYPE_TIME_STAMP:
		/* FIXME: not implemented */
2361
		rb_advance_reader(cpu_buffer);
S
Steven Rostedt 已提交
2362 2363 2364 2365 2366
		goto again;

	case RINGBUF_TYPE_DATA:
		if (ts) {
			*ts = cpu_buffer->read_stamp + event->time_delta;
2367 2368
			ring_buffer_normalize_time_stamp(buffer,
							 cpu_buffer->cpu, ts);
S
Steven Rostedt 已提交
2369 2370 2371 2372 2373 2374 2375 2376 2377
		}
		return event;

	default:
		BUG();
	}

	return NULL;
}
2378
EXPORT_SYMBOL_GPL(ring_buffer_peek);
S
Steven Rostedt 已提交
2379

S
Steven Rostedt 已提交
2380 2381
static struct ring_buffer_event *
rb_iter_peek(struct ring_buffer_iter *iter, u64 *ts)
S
Steven Rostedt 已提交
2382 2383 2384 2385
{
	struct ring_buffer *buffer;
	struct ring_buffer_per_cpu *cpu_buffer;
	struct ring_buffer_event *event;
2386
	int nr_loops = 0;
S
Steven Rostedt 已提交
2387 2388 2389 2390 2391 2392 2393 2394

	if (ring_buffer_iter_empty(iter))
		return NULL;

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

 again:
2395
	/*
2396 2397 2398 2399 2400 2401
	 * 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.
2402
	 */
2403
	if (RB_WARN_ON(cpu_buffer, ++nr_loops > RB_TIMESTAMPS_PER_PAGE))
2404 2405
		return NULL;

S
Steven Rostedt 已提交
2406 2407 2408 2409 2410
	if (rb_per_cpu_empty(cpu_buffer))
		return NULL;

	event = rb_iter_head_event(iter);

2411
	switch (event->type_len) {
S
Steven Rostedt 已提交
2412
	case RINGBUF_TYPE_PADDING:
2413 2414 2415 2416 2417 2418
		if (rb_null_event(event)) {
			rb_inc_iter(iter);
			goto again;
		}
		rb_advance_iter(iter);
		return event;
S
Steven Rostedt 已提交
2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432

	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;
2433 2434
			ring_buffer_normalize_time_stamp(buffer,
							 cpu_buffer->cpu, ts);
S
Steven Rostedt 已提交
2435 2436 2437 2438 2439 2440 2441 2442 2443
		}
		return event;

	default:
		BUG();
	}

	return NULL;
}
2444
EXPORT_SYMBOL_GPL(ring_buffer_iter_peek);
S
Steven Rostedt 已提交
2445

S
Steven Rostedt 已提交
2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458
/**
 * 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];
2459
	struct ring_buffer_event *event;
S
Steven Rostedt 已提交
2460 2461
	unsigned long flags;

2462
	if (!cpumask_test_cpu(cpu, buffer->cpumask))
2463
		return NULL;
2464

2465
 again:
S
Steven Rostedt 已提交
2466 2467 2468 2469
	spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
	event = rb_buffer_peek(buffer, cpu, ts);
	spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);

2470
	if (event && event->type_len == RINGBUF_TYPE_PADDING) {
2471 2472 2473 2474
		cpu_relax();
		goto again;
	}

S
Steven Rostedt 已提交
2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492
	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;

2493
 again:
S
Steven Rostedt 已提交
2494 2495 2496 2497
	spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
	event = rb_iter_peek(iter, ts);
	spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);

2498
	if (event && event->type_len == RINGBUF_TYPE_PADDING) {
2499 2500 2501 2502
		cpu_relax();
		goto again;
	}

S
Steven Rostedt 已提交
2503 2504 2505
	return event;
}

S
Steven Rostedt 已提交
2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516
/**
 * 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)
{
2517 2518
	struct ring_buffer_per_cpu *cpu_buffer;
	struct ring_buffer_event *event = NULL;
S
Steven Rostedt 已提交
2519
	unsigned long flags;
S
Steven Rostedt 已提交
2520

2521
 again:
2522 2523 2524
	/* might be called in atomic */
	preempt_disable();

2525
	if (!cpumask_test_cpu(cpu, buffer->cpumask))
2526
		goto out;
S
Steven Rostedt 已提交
2527

2528
	cpu_buffer = buffer->buffers[cpu];
S
Steven Rostedt 已提交
2529 2530 2531
	spin_lock_irqsave(&cpu_buffer->reader_lock, flags);

	event = rb_buffer_peek(buffer, cpu, ts);
S
Steven Rostedt 已提交
2532
	if (!event)
2533
		goto out_unlock;
S
Steven Rostedt 已提交
2534

2535
	rb_advance_reader(cpu_buffer);
S
Steven Rostedt 已提交
2536

2537
 out_unlock:
S
Steven Rostedt 已提交
2538 2539
	spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);

2540 2541 2542
 out:
	preempt_enable();

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

S
Steven Rostedt 已提交
2548 2549
	return event;
}
2550
EXPORT_SYMBOL_GPL(ring_buffer_consume);
S
Steven Rostedt 已提交
2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567

/**
 * 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;
2568
	struct ring_buffer_iter *iter;
2569
	unsigned long flags;
S
Steven Rostedt 已提交
2570

2571
	if (!cpumask_test_cpu(cpu, buffer->cpumask))
2572
		return NULL;
S
Steven Rostedt 已提交
2573 2574 2575

	iter = kmalloc(sizeof(*iter), GFP_KERNEL);
	if (!iter)
2576
		return NULL;
S
Steven Rostedt 已提交
2577 2578 2579 2580 2581 2582 2583 2584

	cpu_buffer = buffer->buffers[cpu];

	iter->cpu_buffer = cpu_buffer;

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

S
Steven Rostedt 已提交
2585
	spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
2586
	__raw_spin_lock(&cpu_buffer->lock);
2587
	rb_iter_reset(iter);
2588
	__raw_spin_unlock(&cpu_buffer->lock);
S
Steven Rostedt 已提交
2589
	spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
S
Steven Rostedt 已提交
2590 2591 2592

	return iter;
}
2593
EXPORT_SYMBOL_GPL(ring_buffer_read_start);
S
Steven Rostedt 已提交
2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609

/**
 * 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);
}
2610
EXPORT_SYMBOL_GPL(ring_buffer_read_finish);
S
Steven Rostedt 已提交
2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622

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

2626
 again:
S
Steven Rostedt 已提交
2627 2628
	spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
	event = rb_iter_peek(iter, ts);
S
Steven Rostedt 已提交
2629
	if (!event)
S
Steven Rostedt 已提交
2630
		goto out;
S
Steven Rostedt 已提交
2631 2632

	rb_advance_iter(iter);
S
Steven Rostedt 已提交
2633 2634
 out:
	spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
S
Steven Rostedt 已提交
2635

2636
	if (event && event->type_len == RINGBUF_TYPE_PADDING) {
2637 2638 2639 2640
		cpu_relax();
		goto again;
	}

S
Steven Rostedt 已提交
2641 2642
	return event;
}
2643
EXPORT_SYMBOL_GPL(ring_buffer_read);
S
Steven Rostedt 已提交
2644 2645 2646 2647 2648 2649 2650 2651 2652

/**
 * 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;
}
2653
EXPORT_SYMBOL_GPL(ring_buffer_size);
S
Steven Rostedt 已提交
2654 2655 2656 2657 2658 2659

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

2664
	cpu_buffer->head_page->read = 0;
S
Steven Rostedt 已提交
2665 2666 2667 2668 2669 2670

	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);
2671
	local_set(&cpu_buffer->reader_page->entries, 0);
2672
	local_set(&cpu_buffer->reader_page->page->commit, 0);
2673
	cpu_buffer->reader_page->read = 0;
S
Steven Rostedt 已提交
2674

2675 2676
	cpu_buffer->nmi_dropped = 0;
	cpu_buffer->commit_overrun = 0;
S
Steven Rostedt 已提交
2677
	cpu_buffer->overrun = 0;
2678 2679
	cpu_buffer->read = 0;
	local_set(&cpu_buffer->entries, 0);
2680 2681 2682

	cpu_buffer->write_stamp = 0;
	cpu_buffer->read_stamp = 0;
S
Steven Rostedt 已提交
2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694
}

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

2695
	if (!cpumask_test_cpu(cpu, buffer->cpumask))
2696
		return;
S
Steven Rostedt 已提交
2697

2698 2699
	atomic_inc(&cpu_buffer->record_disabled);

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

2702
	__raw_spin_lock(&cpu_buffer->lock);
S
Steven Rostedt 已提交
2703 2704 2705

	rb_reset_cpu(cpu_buffer);

2706
	__raw_spin_unlock(&cpu_buffer->lock);
S
Steven Rostedt 已提交
2707 2708

	spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
2709 2710

	atomic_dec(&cpu_buffer->record_disabled);
S
Steven Rostedt 已提交
2711
}
2712
EXPORT_SYMBOL_GPL(ring_buffer_reset_cpu);
S
Steven Rostedt 已提交
2713 2714 2715 2716 2717 2718 2719 2720 2721 2722

/**
 * 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)
2723
		ring_buffer_reset_cpu(buffer, cpu);
S
Steven Rostedt 已提交
2724
}
2725
EXPORT_SYMBOL_GPL(ring_buffer_reset);
S
Steven Rostedt 已提交
2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741

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

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

S
Steven Rostedt 已提交
2743 2744
	return 1;
}
2745
EXPORT_SYMBOL_GPL(ring_buffer_empty);
S
Steven Rostedt 已提交
2746 2747 2748 2749 2750 2751 2752 2753 2754

/**
 * 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;
2755
	int ret;
S
Steven Rostedt 已提交
2756

2757
	if (!cpumask_test_cpu(cpu, buffer->cpumask))
2758
		return 1;
S
Steven Rostedt 已提交
2759 2760

	cpu_buffer = buffer->buffers[cpu];
2761 2762 2763 2764
	ret = rb_per_cpu_empty(cpu_buffer);


	return ret;
S
Steven Rostedt 已提交
2765
}
2766
EXPORT_SYMBOL_GPL(ring_buffer_empty_cpu);
S
Steven Rostedt 已提交
2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782

/**
 * 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;
2783 2784
	int ret = -EINVAL;

2785 2786
	if (!cpumask_test_cpu(cpu, buffer_a->cpumask) ||
	    !cpumask_test_cpu(cpu, buffer_b->cpumask))
2787
		goto out;
S
Steven Rostedt 已提交
2788 2789

	/* At least make sure the two buffers are somewhat the same */
2790
	if (buffer_a->pages != buffer_b->pages)
2791 2792 2793
		goto out;

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

2795
	if (ring_buffer_flags != RB_BUFFERS_ON)
2796
		goto out;
2797 2798

	if (atomic_read(&buffer_a->record_disabled))
2799
		goto out;
2800 2801

	if (atomic_read(&buffer_b->record_disabled))
2802
		goto out;
2803

S
Steven Rostedt 已提交
2804 2805 2806
	cpu_buffer_a = buffer_a->buffers[cpu];
	cpu_buffer_b = buffer_b->buffers[cpu];

2807
	if (atomic_read(&cpu_buffer_a->record_disabled))
2808
		goto out;
2809 2810

	if (atomic_read(&cpu_buffer_b->record_disabled))
2811
		goto out;
2812

S
Steven Rostedt 已提交
2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830
	/*
	 * 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);

2831 2832 2833
	ret = 0;
out:
	return ret;
S
Steven Rostedt 已提交
2834
}
2835
EXPORT_SYMBOL_GPL(ring_buffer_swap_cpu);
S
Steven Rostedt 已提交
2836

S
Steven Rostedt 已提交
2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853
/**
 * 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)
{
2854
	struct buffer_data_page *bpage;
2855
	unsigned long addr;
S
Steven Rostedt 已提交
2856 2857 2858 2859 2860

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

2861
	bpage = (void *)addr;
S
Steven Rostedt 已提交
2862

2863 2864
	rb_init_page(bpage);

2865
	return bpage;
S
Steven Rostedt 已提交
2866
}
S
Steven Rostedt 已提交
2867
EXPORT_SYMBOL_GPL(ring_buffer_alloc_read_page);
S
Steven Rostedt 已提交
2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879

/**
 * 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 已提交
2880
EXPORT_SYMBOL_GPL(ring_buffer_free_read_page);
S
Steven Rostedt 已提交
2881 2882 2883 2884 2885

/**
 * 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
2886
 * @len: amount to extract
S
Steven Rostedt 已提交
2887 2888 2889 2890 2891 2892 2893 2894 2895
 * @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 已提交
2896
 *	rpage = ring_buffer_alloc_read_page(buffer);
S
Steven Rostedt 已提交
2897 2898
 *	if (!rpage)
 *		return error;
2899
 *	ret = ring_buffer_read_page(buffer, &rpage, len, cpu, 0);
2900 2901
 *	if (ret >= 0)
 *		process_page(rpage, ret);
S
Steven Rostedt 已提交
2902 2903 2904 2905 2906 2907 2908 2909 2910 2911
 *
 * 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:
2912 2913
 *  >=0 if data has been transferred, returns the offset of consumed data.
 *  <0 if no data has been transferred.
S
Steven Rostedt 已提交
2914 2915
 */
int ring_buffer_read_page(struct ring_buffer *buffer,
2916
			  void **data_page, size_t len, int cpu, int full)
S
Steven Rostedt 已提交
2917 2918 2919
{
	struct ring_buffer_per_cpu *cpu_buffer = buffer->buffers[cpu];
	struct ring_buffer_event *event;
2920
	struct buffer_data_page *bpage;
2921
	struct buffer_page *reader;
S
Steven Rostedt 已提交
2922
	unsigned long flags;
2923
	unsigned int commit;
2924
	unsigned int read;
2925
	u64 save_timestamp;
2926
	int ret = -1;
S
Steven Rostedt 已提交
2927

2928 2929 2930
	if (!cpumask_test_cpu(cpu, buffer->cpumask))
		goto out;

2931 2932 2933 2934 2935
	/*
	 * If len is not big enough to hold the page header, then
	 * we can not copy anything.
	 */
	if (len <= BUF_PAGE_HDR_SIZE)
2936
		goto out;
2937 2938 2939

	len -= BUF_PAGE_HDR_SIZE;

S
Steven Rostedt 已提交
2940
	if (!data_page)
2941
		goto out;
S
Steven Rostedt 已提交
2942

2943 2944
	bpage = *data_page;
	if (!bpage)
2945
		goto out;
S
Steven Rostedt 已提交
2946 2947 2948

	spin_lock_irqsave(&cpu_buffer->reader_lock, flags);

2949 2950
	reader = rb_get_reader_page(cpu_buffer);
	if (!reader)
2951
		goto out_unlock;
S
Steven Rostedt 已提交
2952

2953 2954 2955 2956
	event = rb_reader_event(cpu_buffer);

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

S
Steven Rostedt 已提交
2958
	/*
2959 2960 2961 2962 2963
	 * 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 已提交
2964
	 */
2965
	if (read || (len < (commit - read)) ||
2966
	    cpu_buffer->reader_page == cpu_buffer->commit_page) {
2967
		struct buffer_data_page *rpage = cpu_buffer->reader_page->page;
2968 2969
		unsigned int rpos = read;
		unsigned int pos = 0;
2970
		unsigned int size;
S
Steven Rostedt 已提交
2971 2972

		if (full)
2973
			goto out_unlock;
S
Steven Rostedt 已提交
2974

2975 2976 2977 2978 2979 2980
		if (len > (commit - read))
			len = (commit - read);

		size = rb_event_length(event);

		if (len < size)
2981
			goto out_unlock;
2982

2983 2984 2985
		/* save the current timestamp, since the user will need it */
		save_timestamp = cpu_buffer->read_stamp;

2986 2987
		/* Need to copy one event at a time */
		do {
2988
			memcpy(bpage->data + pos, rpage->data + rpos, size);
2989 2990 2991 2992

			len -= size;

			rb_advance_reader(cpu_buffer);
2993 2994
			rpos = reader->read;
			pos += size;
2995 2996 2997 2998

			event = rb_reader_event(cpu_buffer);
			size = rb_event_length(event);
		} while (len > size);
2999 3000

		/* update bpage */
3001
		local_set(&bpage->commit, pos);
3002
		bpage->time_stamp = save_timestamp;
3003

3004 3005
		/* we copied everything to the beginning */
		read = 0;
S
Steven Rostedt 已提交
3006
	} else {
3007 3008 3009
		/* update the entry counter */
		cpu_buffer->read += local_read(&reader->entries);

S
Steven Rostedt 已提交
3010
		/* swap the pages */
3011
		rb_init_page(bpage);
3012 3013 3014
		bpage = reader->page;
		reader->page = *data_page;
		local_set(&reader->write, 0);
3015
		local_set(&reader->entries, 0);
3016
		reader->read = 0;
3017
		*data_page = bpage;
S
Steven Rostedt 已提交
3018
	}
3019
	ret = read;
S
Steven Rostedt 已提交
3020

3021
 out_unlock:
S
Steven Rostedt 已提交
3022 3023
	spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);

3024
 out:
S
Steven Rostedt 已提交
3025 3026
	return ret;
}
S
Steven Rostedt 已提交
3027
EXPORT_SYMBOL_GPL(ring_buffer_read_page);
S
Steven Rostedt 已提交
3028

3029 3030 3031 3032
static ssize_t
rb_simple_read(struct file *filp, char __user *ubuf,
	       size_t cnt, loff_t *ppos)
{
3033
	unsigned long *p = filp->private_data;
3034 3035 3036
	char buf[64];
	int r;

3037 3038 3039 3040
	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));
3041 3042 3043 3044 3045 3046 3047 3048

	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)
{
3049
	unsigned long *p = filp->private_data;
3050
	char buf[64];
3051
	unsigned long val;
3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065
	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;

3066 3067 3068 3069
	if (val)
		set_bit(RB_BUFFERS_ON_BIT, p);
	else
		clear_bit(RB_BUFFERS_ON_BIT, p);
3070 3071 3072 3073 3074 3075

	(*ppos)++;

	return cnt;
}

3076
static const struct file_operations rb_simple_fops = {
3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088
	.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();

3089 3090
	trace_create_file("tracing_on", 0644, d_tracer,
			    &ring_buffer_flags, &rb_simple_fops);
3091 3092 3093 3094 3095

	return 0;
}

fs_initcall(rb_init_debugfs);
3096

3097
#ifdef CONFIG_HOTPLUG_CPU
3098 3099
static int rb_cpu_notify(struct notifier_block *self,
			 unsigned long action, void *hcpu)
3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134
{
	struct ring_buffer *buffer =
		container_of(self, struct ring_buffer, cpu_notify);
	long cpu = (long)hcpu;

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

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