ring_buffer.c 63.3 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/ftrace_irq.h>
S
Steven Rostedt 已提交
8 9 10 11 12 13 14 15 16 17 18 19
#include <linux/spinlock.h>
#include <linux/debugfs.h>
#include <linux/uaccess.h>
#include <linux/module.h>
#include <linux/percpu.h>
#include <linux/mutex.h>
#include <linux/sched.h>	/* used for sched_clock() (for now) */
#include <linux/init.h>
#include <linux/hash.h>
#include <linux/list.h>
#include <linux/fs.h>

20 21
#include "trace.h"

22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50
/*
 * 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.
 */
static DEFINE_PER_CPU(int, rb_in_nmi);

void ftrace_nmi_enter(void)
{
	__get_cpu_var(rb_in_nmi)++;
	/* call arch specific handler too */
	arch_ftrace_nmi_enter();
}

void ftrace_nmi_exit(void)
{
	arch_ftrace_nmi_exit();
	__get_cpu_var(rb_in_nmi)--;
	/* NMIs are not recursive */
	WARN_ON_ONCE(__get_cpu_var(rb_in_nmi));
}


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

static long ring_buffer_flags __read_mostly = RB_BUFFERS_ON;
91 92 93 94 95 96 97 98 99

/**
 * tracing_on - enable all tracing buffers
 *
 * This function enables all tracing buffers that may have been
 * disabled with tracing_off.
 */
void tracing_on(void)
{
100
	set_bit(RB_BUFFERS_ON_BIT, &ring_buffer_flags);
101
}
102
EXPORT_SYMBOL_GPL(tracing_on);
103 104 105 106 107 108 109 110 111 112 113

/**
 * 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)
{
114 115
	clear_bit(RB_BUFFERS_ON_BIT, &ring_buffer_flags);
}
116
EXPORT_SYMBOL_GPL(tracing_off);
117 118 119 120 121 122 123 124 125 126

/**
 * tracing_off_permanent - permanently disable ring buffers
 *
 * This function, once called, will disable all ring buffers
 * permanenty.
 */
void tracing_off_permanent(void)
{
	set_bit(RB_BUFFERS_DISABLED_BIT, &ring_buffer_flags);
127 128
}

129 130
#include "trace.h"

S
Steven Rostedt 已提交
131 132 133 134 135 136
/* Up this if you want to test the TIME_EXTENTS and normalization */
#define DEBUG_SHIFT 0

/* FIXME!!! */
u64 ring_buffer_time_stamp(int cpu)
{
137 138 139
	u64 time;

	preempt_disable_notrace();
S
Steven Rostedt 已提交
140
	/* shift to debug/test normalization and TIME_EXTENTS */
141
	time = sched_clock() << DEBUG_SHIFT;
142
	preempt_enable_no_resched_notrace();
143 144

	return time;
S
Steven Rostedt 已提交
145
}
146
EXPORT_SYMBOL_GPL(ring_buffer_time_stamp);
S
Steven Rostedt 已提交
147 148 149 150 151 152

void ring_buffer_normalize_time_stamp(int cpu, u64 *ts)
{
	/* Just stupid testing the normalize function and deltas */
	*ts >>= DEBUG_SHIFT;
}
153
EXPORT_SYMBOL_GPL(ring_buffer_normalize_time_stamp);
S
Steven Rostedt 已提交
154 155

#define RB_EVNT_HDR_SIZE (sizeof(struct ring_buffer_event))
156
#define RB_ALIGNMENT		4U
S
Steven Rostedt 已提交
157 158 159 160 161 162 163 164
#define RB_MAX_SMALL_DATA	28

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

/* inline for ring buffer fast paths */
165
static unsigned
S
Steven Rostedt 已提交
166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182
rb_event_length(struct ring_buffer_event *event)
{
	unsigned length;

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

	case RINGBUF_TYPE_TIME_EXTEND:
		return RB_LEN_TIME_EXTEND;

	case RINGBUF_TYPE_TIME_STAMP:
		return RB_LEN_TIME_STAMP;

	case RINGBUF_TYPE_DATA:
		if (event->len)
183
			length = event->len * RB_ALIGNMENT;
S
Steven Rostedt 已提交
184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199
		else
			length = event->array[0];
		return length + RB_EVNT_HDR_SIZE;
	default:
		BUG();
	}
	/* not hit */
	return 0;
}

/**
 * ring_buffer_event_length - return the length of the event
 * @event: the event to get the length of
 */
unsigned ring_buffer_event_length(struct ring_buffer_event *event)
{
200 201 202 203 204 205 206
	unsigned length = rb_event_length(event);
	if (event->type != RINGBUF_TYPE_DATA)
		return length;
	length -= RB_EVNT_HDR_SIZE;
	if (length > RB_MAX_SMALL_DATA + sizeof(event->array[0]))
                length -= sizeof(event->array[0]);
	return length;
S
Steven Rostedt 已提交
207
}
208
EXPORT_SYMBOL_GPL(ring_buffer_event_length);
S
Steven Rostedt 已提交
209 210

/* inline for ring buffer fast paths */
211
static void *
S
Steven Rostedt 已提交
212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229
rb_event_data(struct ring_buffer_event *event)
{
	BUG_ON(event->type != RINGBUF_TYPE_DATA);
	/* If length is in len field, then array[0] has the data */
	if (event->len)
		return (void *)&event->array[0];
	/* Otherwise length is in array[0] and array[1] has the data */
	return (void *)&event->array[1];
}

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

#define for_each_buffer_cpu(buffer, cpu)		\
233
	for_each_cpu(cpu, buffer->cpumask)
S
Steven Rostedt 已提交
234 235 236 237 238

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

239
struct buffer_data_page {
240
	u64		 time_stamp;	/* page time stamp */
S
Steven Rostedt 已提交
241
	local_t		 commit;	/* write commited index */
242 243 244 245 246
	unsigned char	 data[];	/* data of buffer page */
};

struct buffer_page {
	local_t		 write;		/* index for next write */
247
	unsigned	 read;		/* index for next read */
248
	struct list_head list;		/* list of free pages */
249
	struct buffer_data_page *page;	/* Actual data page */
S
Steven Rostedt 已提交
250 251
};

252
static void rb_init_page(struct buffer_data_page *bpage)
253
{
254
	local_set(&bpage->commit, 0);
255 256
}

257 258 259 260
/*
 * Also stolen from mm/slob.c. Thanks to Mathieu Desnoyers for pointing
 * this issue out.
 */
261
static void free_buffer_page(struct buffer_page *bpage)
262
{
263
	free_page((unsigned long)bpage->page);
264
	kfree(bpage);
265 266
}

S
Steven Rostedt 已提交
267 268 269 270 271 272 273 274 275 276
/*
 * 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;
}

277
#define BUF_PAGE_SIZE (PAGE_SIZE - offsetof(struct buffer_data_page, data))
S
Steven Rostedt 已提交
278 279 280 281 282 283 284

/*
 * head_page == tail_page && head == tail then buffer is empty.
 */
struct ring_buffer_per_cpu {
	int				cpu;
	struct ring_buffer		*buffer;
S
Steven Rostedt 已提交
285
	spinlock_t			reader_lock; /* serialize readers */
286
	raw_spinlock_t			lock;
S
Steven Rostedt 已提交
287 288
	struct lock_class_key		lock_key;
	struct list_head		pages;
289 290
	struct buffer_page		*head_page;	/* read from head */
	struct buffer_page		*tail_page;	/* write to tail */
S
Steven Rostedt 已提交
291
	struct buffer_page		*commit_page;	/* commited pages */
292
	struct buffer_page		*reader_page;
S
Steven Rostedt 已提交
293 294 295 296 297 298 299 300 301 302 303
	unsigned long			overrun;
	unsigned long			entries;
	u64				write_stamp;
	u64				read_stamp;
	atomic_t			record_disabled;
};

struct ring_buffer {
	unsigned			pages;
	unsigned			flags;
	int				cpus;
304
	cpumask_var_t			cpumask;
S
Steven Rostedt 已提交
305 306 307 308 309 310 311 312 313 314 315 316 317 318
	atomic_t			record_disabled;

	struct mutex			mutex;

	struct ring_buffer_per_cpu	**buffers;
};

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

319
/* buffer may be either ring_buffer or ring_buffer_per_cpu */
S
Steven Rostedt 已提交
320
#define RB_WARN_ON(buffer, cond)				\
S
Steven Rostedt 已提交
321 322 323
	({							\
		int _____ret = unlikely(cond);			\
		if (_____ret) {					\
S
Steven Rostedt 已提交
324 325 326
			atomic_inc(&buffer->record_disabled);	\
			WARN_ON(1);				\
		}						\
S
Steven Rostedt 已提交
327 328
		_____ret;					\
	})
329

S
Steven Rostedt 已提交
330 331 332 333 334 335 336 337 338 339
/**
 * check_pages - integrity check of buffer pages
 * @cpu_buffer: CPU buffer with pages to test
 *
 * As a safty measure we check to make sure the data pages have not
 * been corrupted.
 */
static int rb_check_pages(struct ring_buffer_per_cpu *cpu_buffer)
{
	struct list_head *head = &cpu_buffer->pages;
340
	struct buffer_page *bpage, *tmp;
S
Steven Rostedt 已提交
341

S
Steven Rostedt 已提交
342 343 344 345
	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 已提交
346

347
	list_for_each_entry_safe(bpage, tmp, head, list) {
S
Steven Rostedt 已提交
348
		if (RB_WARN_ON(cpu_buffer,
349
			       bpage->list.next->prev != &bpage->list))
S
Steven Rostedt 已提交
350 351
			return -1;
		if (RB_WARN_ON(cpu_buffer,
352
			       bpage->list.prev->next != &bpage->list))
S
Steven Rostedt 已提交
353
			return -1;
S
Steven Rostedt 已提交
354 355 356 357 358 359 360 361 362
	}

	return 0;
}

static int rb_allocate_pages(struct ring_buffer_per_cpu *cpu_buffer,
			     unsigned nr_pages)
{
	struct list_head *head = &cpu_buffer->pages;
363
	struct buffer_page *bpage, *tmp;
S
Steven Rostedt 已提交
364 365 366 367 368
	unsigned long addr;
	LIST_HEAD(pages);
	unsigned i;

	for (i = 0; i < nr_pages; i++) {
369
		bpage = kzalloc_node(ALIGN(sizeof(*bpage), cache_line_size()),
S
Steven Rostedt 已提交
370
				    GFP_KERNEL, cpu_to_node(cpu_buffer->cpu));
371
		if (!bpage)
372
			goto free_pages;
373
		list_add(&bpage->list, &pages);
374

S
Steven Rostedt 已提交
375 376 377
		addr = __get_free_page(GFP_KERNEL);
		if (!addr)
			goto free_pages;
378 379
		bpage->page = (void *)addr;
		rb_init_page(bpage->page);
S
Steven Rostedt 已提交
380 381 382 383 384 385 386 387 388
	}

	list_splice(&pages, head);

	rb_check_pages(cpu_buffer);

	return 0;

 free_pages:
389 390 391
	list_for_each_entry_safe(bpage, tmp, &pages, list) {
		list_del_init(&bpage->list);
		free_buffer_page(bpage);
S
Steven Rostedt 已提交
392 393 394 395 396 397 398 399
	}
	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;
400
	struct buffer_page *bpage;
401
	unsigned long addr;
S
Steven Rostedt 已提交
402 403 404 405 406 407 408 409 410
	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 已提交
411
	spin_lock_init(&cpu_buffer->reader_lock);
412
	cpu_buffer->lock = (raw_spinlock_t)__RAW_SPIN_LOCK_UNLOCKED;
S
Steven Rostedt 已提交
413 414
	INIT_LIST_HEAD(&cpu_buffer->pages);

415
	bpage = kzalloc_node(ALIGN(sizeof(*bpage), cache_line_size()),
416
			    GFP_KERNEL, cpu_to_node(cpu));
417
	if (!bpage)
418 419
		goto fail_free_buffer;

420
	cpu_buffer->reader_page = bpage;
421 422
	addr = __get_free_page(GFP_KERNEL);
	if (!addr)
423
		goto fail_free_reader;
424 425
	bpage->page = (void *)addr;
	rb_init_page(bpage->page);
426

427 428
	INIT_LIST_HEAD(&cpu_buffer->reader_page->list);

S
Steven Rostedt 已提交
429 430
	ret = rb_allocate_pages(cpu_buffer, buffer->pages);
	if (ret < 0)
431
		goto fail_free_reader;
S
Steven Rostedt 已提交
432 433 434

	cpu_buffer->head_page
		= list_entry(cpu_buffer->pages.next, struct buffer_page, list);
S
Steven Rostedt 已提交
435
	cpu_buffer->tail_page = cpu_buffer->commit_page = cpu_buffer->head_page;
S
Steven Rostedt 已提交
436 437 438

	return cpu_buffer;

439 440 441
 fail_free_reader:
	free_buffer_page(cpu_buffer->reader_page);

S
Steven Rostedt 已提交
442 443 444 445 446 447 448 449
 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;
450
	struct buffer_page *bpage, *tmp;
S
Steven Rostedt 已提交
451

452 453 454
	list_del_init(&cpu_buffer->reader_page->list);
	free_buffer_page(cpu_buffer->reader_page);

455 456 457
	list_for_each_entry_safe(bpage, tmp, head, list) {
		list_del_init(&bpage->list);
		free_buffer_page(bpage);
S
Steven Rostedt 已提交
458 459 460 461
	}
	kfree(cpu_buffer);
}

462 463 464 465 466 467
/*
 * Causes compile errors if the struct buffer_page gets bigger
 * than the struct page.
 */
extern int ring_buffer_page_too_big(void);

S
Steven Rostedt 已提交
468 469
/**
 * ring_buffer_alloc - allocate a new ring_buffer
470
 * @size: the size in bytes per cpu that is needed.
S
Steven Rostedt 已提交
471 472 473 474 475 476 477 478 479 480 481 482 483
 * @flags: attributes to set for the ring buffer.
 *
 * Currently the only flag that is available is the RB_FL_OVERWRITE
 * flag. This flag means that the buffer will overwrite old data
 * when the buffer wraps. If this flag is not set, the buffer will
 * drop data when the tail hits the head.
 */
struct ring_buffer *ring_buffer_alloc(unsigned long size, unsigned flags)
{
	struct ring_buffer *buffer;
	int bsize;
	int cpu;

484 485 486 487 488
	/* Paranoid! Optimizes out when all is well */
	if (sizeof(struct buffer_page) > sizeof(struct page))
		ring_buffer_page_too_big();


S
Steven Rostedt 已提交
489 490 491 492 493 494
	/* keep it in its own cache line */
	buffer = kzalloc(ALIGN(sizeof(*buffer), cache_line_size()),
			 GFP_KERNEL);
	if (!buffer)
		return NULL;

495 496 497
	if (!alloc_cpumask_var(&buffer->cpumask, GFP_KERNEL))
		goto fail_free_buffer;

S
Steven Rostedt 已提交
498 499 500 501 502 503 504
	buffer->pages = DIV_ROUND_UP(size, BUF_PAGE_SIZE);
	buffer->flags = flags;

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

505
	cpumask_copy(buffer->cpumask, cpu_possible_mask);
S
Steven Rostedt 已提交
506 507 508 509 510 511
	buffer->cpus = nr_cpu_ids;

	bsize = sizeof(void *) * nr_cpu_ids;
	buffer->buffers = kzalloc(ALIGN(bsize, cache_line_size()),
				  GFP_KERNEL);
	if (!buffer->buffers)
512
		goto fail_free_cpumask;
S
Steven Rostedt 已提交
513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531

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

	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);

532 533 534
 fail_free_cpumask:
	free_cpumask_var(buffer->cpumask);

S
Steven Rostedt 已提交
535 536 537 538
 fail_free_buffer:
	kfree(buffer);
	return NULL;
}
539
EXPORT_SYMBOL_GPL(ring_buffer_alloc);
S
Steven Rostedt 已提交
540 541 542 543 544 545 546 547 548 549 550 551 552

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

	for_each_buffer_cpu(buffer, cpu)
		rb_free_cpu_buffer(buffer->buffers[cpu]);

553 554
	free_cpumask_var(buffer->cpumask);

S
Steven Rostedt 已提交
555 556
	kfree(buffer);
}
557
EXPORT_SYMBOL_GPL(ring_buffer_free);
S
Steven Rostedt 已提交
558 559 560 561 562 563

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)
{
564
	struct buffer_page *bpage;
S
Steven Rostedt 已提交
565 566 567 568 569 570 571
	struct list_head *p;
	unsigned i;

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

	for (i = 0; i < nr_pages; i++) {
S
Steven Rostedt 已提交
572 573
		if (RB_WARN_ON(cpu_buffer, list_empty(&cpu_buffer->pages)))
			return;
S
Steven Rostedt 已提交
574
		p = cpu_buffer->pages.next;
575 576 577
		bpage = list_entry(p, struct buffer_page, list);
		list_del_init(&bpage->list);
		free_buffer_page(bpage);
S
Steven Rostedt 已提交
578
	}
S
Steven Rostedt 已提交
579 580
	if (RB_WARN_ON(cpu_buffer, list_empty(&cpu_buffer->pages)))
		return;
S
Steven Rostedt 已提交
581 582 583 584 585 586 587 588 589 590 591 592 593

	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)
{
594
	struct buffer_page *bpage;
S
Steven Rostedt 已提交
595 596 597 598 599 600 601
	struct list_head *p;
	unsigned i;

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

	for (i = 0; i < nr_pages; i++) {
S
Steven Rostedt 已提交
602 603
		if (RB_WARN_ON(cpu_buffer, list_empty(pages)))
			return;
S
Steven Rostedt 已提交
604
		p = pages->next;
605 606 607
		bpage = list_entry(p, struct buffer_page, list);
		list_del_init(&bpage->list);
		list_add_tail(&bpage->list, &cpu_buffer->pages);
S
Steven Rostedt 已提交
608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633
	}
	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;
634
	struct buffer_page *bpage, *tmp;
S
Steven Rostedt 已提交
635 636 637 638 639
	unsigned long buffer_size;
	unsigned long addr;
	LIST_HEAD(pages);
	int i, cpu;

640 641 642 643 644 645
	/*
	 * Always succeed at resizing a non-existent buffer:
	 */
	if (!buffer)
		return size;

S
Steven Rostedt 已提交
646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663
	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);

	nr_pages = DIV_ROUND_UP(size, BUF_PAGE_SIZE);

	if (size < buffer_size) {

		/* easy case, just free pages */
S
Steven Rostedt 已提交
664 665 666 667
		if (RB_WARN_ON(buffer, nr_pages >= buffer->pages)) {
			mutex_unlock(&buffer->mutex);
			return -1;
		}
S
Steven Rostedt 已提交
668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685

		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;
	 */
S
Steven Rostedt 已提交
686 687 688 689
	if (RB_WARN_ON(buffer, nr_pages <= buffer->pages)) {
		mutex_unlock(&buffer->mutex);
		return -1;
	}
690

S
Steven Rostedt 已提交
691 692 693 694
	new_pages = nr_pages - buffer->pages;

	for_each_buffer_cpu(buffer, cpu) {
		for (i = 0; i < new_pages; i++) {
695
			bpage = kzalloc_node(ALIGN(sizeof(*bpage),
696 697
						  cache_line_size()),
					    GFP_KERNEL, cpu_to_node(cpu));
698
			if (!bpage)
699
				goto free_pages;
700
			list_add(&bpage->list, &pages);
S
Steven Rostedt 已提交
701 702 703
			addr = __get_free_page(GFP_KERNEL);
			if (!addr)
				goto free_pages;
704 705
			bpage->page = (void *)addr;
			rb_init_page(bpage->page);
S
Steven Rostedt 已提交
706 707 708 709 710 711 712 713
		}
	}

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

S
Steven Rostedt 已提交
714 715 716 717
	if (RB_WARN_ON(buffer, !list_empty(&pages))) {
		mutex_unlock(&buffer->mutex);
		return -1;
	}
S
Steven Rostedt 已提交
718 719 720 721 722 723 724 725

 out:
	buffer->pages = nr_pages;
	mutex_unlock(&buffer->mutex);

	return size;

 free_pages:
726 727 728
	list_for_each_entry_safe(bpage, tmp, &pages, list) {
		list_del_init(&bpage->list);
		free_buffer_page(bpage);
S
Steven Rostedt 已提交
729
	}
730
	mutex_unlock(&buffer->mutex);
S
Steven Rostedt 已提交
731 732
	return -ENOMEM;
}
733
EXPORT_SYMBOL_GPL(ring_buffer_resize);
S
Steven Rostedt 已提交
734 735 736 737 738 739

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

S
Steven Rostedt 已提交
740
static inline void *
741
__rb_data_page_index(struct buffer_data_page *bpage, unsigned index)
S
Steven Rostedt 已提交
742
{
743
	return bpage->data + index;
S
Steven Rostedt 已提交
744 745
}

746
static inline void *__rb_page_index(struct buffer_page *bpage, unsigned index)
S
Steven Rostedt 已提交
747
{
748
	return bpage->page->data + index;
S
Steven Rostedt 已提交
749 750 751
}

static inline struct ring_buffer_event *
752
rb_reader_event(struct ring_buffer_per_cpu *cpu_buffer)
S
Steven Rostedt 已提交
753
{
754 755 756 757 758 759 760 761 762
	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 已提交
763 764 765 766 767
}

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

S
Steven Rostedt 已提交
771 772 773 774 775 776 777
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)
{
778
	return local_read(&bpage->page->commit);
S
Steven Rostedt 已提交
779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797
}

/* 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 已提交
798 799 800 801 802 803 804 805 806 807 808 809 810 811
/*
 * When the tail hits the head and the buffer is in overwrite mode,
 * the head jumps to the next page and all content on the previous
 * page is discarded. But before doing so, we update the overrun
 * variable of the buffer.
 */
static void rb_update_overflow(struct ring_buffer_per_cpu *cpu_buffer)
{
	struct ring_buffer_event *event;
	unsigned long head;

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

812
		event = __rb_page_index(cpu_buffer->head_page, head);
S
Steven Rostedt 已提交
813 814
		if (RB_WARN_ON(cpu_buffer, rb_null_event(event)))
			return;
S
Steven Rostedt 已提交
815 816 817 818 819 820 821 822 823
		/* Only count data entries */
		if (event->type != RINGBUF_TYPE_DATA)
			continue;
		cpu_buffer->overrun++;
		cpu_buffer->entries--;
	}
}

static inline void rb_inc_page(struct ring_buffer_per_cpu *cpu_buffer,
824
			       struct buffer_page **bpage)
S
Steven Rostedt 已提交
825
{
826
	struct list_head *p = (*bpage)->list.next;
S
Steven Rostedt 已提交
827 828 829 830

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

831
	*bpage = list_entry(p, struct buffer_page, list);
S
Steven Rostedt 已提交
832 833
}

S
Steven Rostedt 已提交
834 835 836 837 838 839 840 841
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);
}

842
static int
S
Steven Rostedt 已提交
843 844 845 846 847 848 849 850 851 852 853 854 855
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;
}

856
static void
S
Steven Rostedt 已提交
857 858
rb_set_commit_event(struct ring_buffer_per_cpu *cpu_buffer,
		    struct ring_buffer_event *event)
S
Steven Rostedt 已提交
859
{
S
Steven Rostedt 已提交
860 861 862 863 864 865 866
	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 已提交
867 868 869
		if (RB_WARN_ON(cpu_buffer,
			  cpu_buffer->commit_page == cpu_buffer->tail_page))
			return;
870
		cpu_buffer->commit_page->page->commit =
S
Steven Rostedt 已提交
871 872
			cpu_buffer->commit_page->write;
		rb_inc_page(cpu_buffer, &cpu_buffer->commit_page);
873 874
		cpu_buffer->write_stamp =
			cpu_buffer->commit_page->page->time_stamp;
S
Steven Rostedt 已提交
875 876 877
	}

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

881
static void
S
Steven Rostedt 已提交
882
rb_set_commit_to_write(struct ring_buffer_per_cpu *cpu_buffer)
S
Steven Rostedt 已提交
883
{
S
Steven Rostedt 已提交
884 885 886 887 888 889 890 891
	/*
	 * 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.
	 */
892
 again:
S
Steven Rostedt 已提交
893
	while (cpu_buffer->commit_page != cpu_buffer->tail_page) {
894
		cpu_buffer->commit_page->page->commit =
S
Steven Rostedt 已提交
895 896
			cpu_buffer->commit_page->write;
		rb_inc_page(cpu_buffer, &cpu_buffer->commit_page);
897 898
		cpu_buffer->write_stamp =
			cpu_buffer->commit_page->page->time_stamp;
S
Steven Rostedt 已提交
899 900 901 902 903
		/* add barrier to keep gcc from optimizing too much */
		barrier();
	}
	while (rb_commit_index(cpu_buffer) !=
	       rb_page_write(cpu_buffer->commit_page)) {
904
		cpu_buffer->commit_page->page->commit =
S
Steven Rostedt 已提交
905 906 907
			cpu_buffer->commit_page->write;
		barrier();
	}
908 909 910 911 912 913 914 915 916 917 918

	/* 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 已提交
919 920
}

921
static void rb_reset_reader_page(struct ring_buffer_per_cpu *cpu_buffer)
S
Steven Rostedt 已提交
922
{
923
	cpu_buffer->read_stamp = cpu_buffer->reader_page->page->time_stamp;
924
	cpu_buffer->reader_page->read = 0;
925 926
}

927
static void rb_inc_iter(struct ring_buffer_iter *iter)
928 929 930 931 932 933 934 935 936 937 938 939 940 941
{
	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);

942
	iter->read_stamp = iter->head_page->page->time_stamp;
S
Steven Rostedt 已提交
943 944 945 946 947 948 949 950 951 952 953 954 955 956
	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.
 */
957
static void
S
Steven Rostedt 已提交
958 959 960 961 962 963 964 965 966 967 968
rb_update_event(struct ring_buffer_event *event,
			 unsigned type, unsigned length)
{
	event->type = type;

	switch (type) {

	case RINGBUF_TYPE_PADDING:
		break;

	case RINGBUF_TYPE_TIME_EXTEND:
969
		event->len = DIV_ROUND_UP(RB_LEN_TIME_EXTEND, RB_ALIGNMENT);
S
Steven Rostedt 已提交
970 971 972
		break;

	case RINGBUF_TYPE_TIME_STAMP:
973
		event->len = DIV_ROUND_UP(RB_LEN_TIME_STAMP, RB_ALIGNMENT);
S
Steven Rostedt 已提交
974 975 976 977 978 979 980 981
		break;

	case RINGBUF_TYPE_DATA:
		length -= RB_EVNT_HDR_SIZE;
		if (length > RB_MAX_SMALL_DATA) {
			event->len = 0;
			event->array[0] = length;
		} else
982
			event->len = DIV_ROUND_UP(length, RB_ALIGNMENT);
S
Steven Rostedt 已提交
983 984 985 986 987 988
		break;
	default:
		BUG();
	}
}

989
static unsigned rb_calculate_event_length(unsigned length)
S
Steven Rostedt 已提交
990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009
{
	struct ring_buffer_event event; /* Used only for sizeof array */

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

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

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

	return length;
}

static struct ring_buffer_event *
__rb_reserve_next(struct ring_buffer_per_cpu *cpu_buffer,
		  unsigned type, unsigned long length, u64 *ts)
{
1010
	struct buffer_page *tail_page, *head_page, *reader_page, *commit_page;
S
Steven Rostedt 已提交
1011
	unsigned long tail, write;
S
Steven Rostedt 已提交
1012 1013
	struct ring_buffer *buffer = cpu_buffer->buffer;
	struct ring_buffer_event *event;
S
Steven Rostedt 已提交
1014
	unsigned long flags;
1015
	bool lock_taken = false;
S
Steven Rostedt 已提交
1016

1017 1018 1019
	commit_page = cpu_buffer->commit_page;
	/* we just need to protect against interrupts */
	barrier();
S
Steven Rostedt 已提交
1020
	tail_page = cpu_buffer->tail_page;
S
Steven Rostedt 已提交
1021 1022
	write = local_add_return(length, &tail_page->write);
	tail = write - length;
S
Steven Rostedt 已提交
1023

S
Steven Rostedt 已提交
1024 1025
	/* See if we shot pass the end of this buffer page */
	if (write > BUF_PAGE_SIZE) {
S
Steven Rostedt 已提交
1026 1027
		struct buffer_page *next_page = tail_page;

1028
		local_irq_save(flags);
1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041
		/*
		 * 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(__get_cpu_var(rb_in_nmi))) {
			if (!__raw_spin_trylock(&cpu_buffer->lock))
				goto out_unlock;
		} else
			__raw_spin_lock(&cpu_buffer->lock);

		lock_taken = true;
S
Steven Rostedt 已提交
1042

S
Steven Rostedt 已提交
1043 1044
		rb_inc_page(cpu_buffer, &next_page);

1045 1046 1047 1048
		head_page = cpu_buffer->head_page;
		reader_page = cpu_buffer->reader_page;

		/* we grabbed the lock before incrementing */
S
Steven Rostedt 已提交
1049 1050
		if (RB_WARN_ON(cpu_buffer, next_page == reader_page))
			goto out_unlock;
S
Steven Rostedt 已提交
1051 1052 1053 1054 1055 1056

		/*
		 * If for some reason, we had an interrupt storm that made
		 * it all the way around the buffer, bail, and warn
		 * about it.
		 */
1057
		if (unlikely(next_page == commit_page)) {
S
Steven Rostedt 已提交
1058 1059 1060
			WARN_ON_ONCE(1);
			goto out_unlock;
		}
1061

S
Steven Rostedt 已提交
1062
		if (next_page == head_page) {
1063
			if (!(buffer->flags & RB_FL_OVERWRITE))
S
Steven Rostedt 已提交
1064
				goto out_unlock;
S
Steven Rostedt 已提交
1065

S
Steven Rostedt 已提交
1066 1067 1068 1069 1070 1071 1072 1073 1074 1075
			/* tail_page has not moved yet? */
			if (tail_page == cpu_buffer->tail_page) {
				/* count overflows */
				rb_update_overflow(cpu_buffer);

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

S
Steven Rostedt 已提交
1077 1078 1079 1080 1081 1082 1083
		/*
		 * 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);
1084
			local_set(&next_page->page->commit, 0);
S
Steven Rostedt 已提交
1085 1086 1087 1088
			cpu_buffer->tail_page = next_page;

			/* reread the time stamp */
			*ts = ring_buffer_time_stamp(cpu_buffer->cpu);
1089
			cpu_buffer->tail_page->page->time_stamp = *ts;
S
Steven Rostedt 已提交
1090 1091
		}

S
Steven Rostedt 已提交
1092 1093 1094 1095 1096
		/*
		 * The actual tail page has moved forward.
		 */
		if (tail < BUF_PAGE_SIZE) {
			/* Mark the rest of the page with padding */
1097
			event = __rb_page_index(tail_page, tail);
S
Steven Rostedt 已提交
1098 1099 1100
			event->type = RINGBUF_TYPE_PADDING;
		}

S
Steven Rostedt 已提交
1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113
		if (tail <= BUF_PAGE_SIZE)
			/* Set the write back to the previous setting */
			local_set(&tail_page->write, tail);

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

1114 1115
		__raw_spin_unlock(&cpu_buffer->lock);
		local_irq_restore(flags);
S
Steven Rostedt 已提交
1116 1117 1118

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

S
Steven Rostedt 已提交
1121 1122
	/* We reserved something on the buffer */

S
Steven Rostedt 已提交
1123 1124
	if (RB_WARN_ON(cpu_buffer, write > BUF_PAGE_SIZE))
		return NULL;
S
Steven Rostedt 已提交
1125

1126
	event = __rb_page_index(tail_page, tail);
S
Steven Rostedt 已提交
1127 1128
	rb_update_event(event, type, length);

S
Steven Rostedt 已提交
1129 1130 1131 1132 1133
	/*
	 * 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))
1134
		cpu_buffer->commit_page->page->time_stamp = *ts;
S
Steven Rostedt 已提交
1135

S
Steven Rostedt 已提交
1136
	return event;
S
Steven Rostedt 已提交
1137 1138

 out_unlock:
1139 1140 1141 1142
	/* reset write */
	if (tail <= BUF_PAGE_SIZE)
		local_set(&tail_page->write, tail);

1143 1144
	if (likely(lock_taken))
		__raw_spin_unlock(&cpu_buffer->lock);
1145
	local_irq_restore(flags);
S
Steven Rostedt 已提交
1146
	return NULL;
S
Steven Rostedt 已提交
1147 1148 1149 1150 1151 1152 1153 1154
}

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 已提交
1155
	int ret;
S
Steven Rostedt 已提交
1156 1157 1158 1159

	if (unlikely(*delta > (1ULL << 59) && !once++)) {
		printk(KERN_WARNING "Delta way too big! %llu"
		       " ts=%llu write stamp = %llu\n",
1160 1161 1162
		       (unsigned long long)*delta,
		       (unsigned long long)*ts,
		       (unsigned long long)cpu_buffer->write_stamp);
S
Steven Rostedt 已提交
1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174
		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 已提交
1175
		return -EBUSY;
S
Steven Rostedt 已提交
1176

S
Steven Rostedt 已提交
1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189
	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 {
1190
			cpu_buffer->commit_page->page->time_stamp = *ts;
S
Steven Rostedt 已提交
1191 1192 1193
			event->time_delta = 0;
			event->array[0] = 0;
		}
S
Steven Rostedt 已提交
1194
		cpu_buffer->write_stamp = *ts;
S
Steven Rostedt 已提交
1195 1196 1197 1198 1199 1200 1201
		/* let the caller know this was the commit */
		ret = 1;
	} else {
		/* Darn, this is just wasted space */
		event->time_delta = 0;
		event->array[0] = 0;
		ret = 0;
S
Steven Rostedt 已提交
1202 1203
	}

S
Steven Rostedt 已提交
1204 1205 1206
	*delta = 0;

	return ret;
S
Steven Rostedt 已提交
1207 1208 1209 1210 1211 1212 1213 1214
}

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

S
Steven Rostedt 已提交
1218
 again:
1219 1220 1221 1222 1223 1224 1225 1226 1227
	/*
	 * 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 已提交
1228
	if (RB_WARN_ON(cpu_buffer, ++nr_loops > 1000))
1229 1230
		return NULL;

S
Steven Rostedt 已提交
1231 1232
	ts = ring_buffer_time_stamp(cpu_buffer->cpu);

S
Steven Rostedt 已提交
1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244
	/*
	 * Only the first commit can update the timestamp.
	 * Yes there is a race here. If an interrupt comes in
	 * just after the conditional and it traces too, then it
	 * will also check the deltas. More than one timestamp may
	 * also be made. But only the entry that did the actual
	 * commit will be something other than zero.
	 */
	if (cpu_buffer->tail_page == cpu_buffer->commit_page &&
	    rb_page_write(cpu_buffer->tail_page) ==
	    rb_commit_index(cpu_buffer)) {

S
Steven Rostedt 已提交
1245 1246
		delta = ts - cpu_buffer->write_stamp;

S
Steven Rostedt 已提交
1247 1248 1249 1250 1251
		/* make sure this delta is calculated here */
		barrier();

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

S
Steven Rostedt 已提交
1254 1255
		if (test_time_stamp(delta)) {

S
Steven Rostedt 已提交
1256 1257 1258
			commit = rb_add_time_stamp(cpu_buffer, &ts, &delta);

			if (commit == -EBUSY)
S
Steven Rostedt 已提交
1259
				return NULL;
S
Steven Rostedt 已提交
1260 1261 1262 1263 1264

			if (commit == -EAGAIN)
				goto again;

			RB_WARN_ON(cpu_buffer, commit < 0);
S
Steven Rostedt 已提交
1265
		}
S
Steven Rostedt 已提交
1266 1267
	} else
		/* Non commits have zero deltas */
S
Steven Rostedt 已提交
1268 1269 1270
		delta = 0;

	event = __rb_reserve_next(cpu_buffer, type, length, &ts);
S
Steven Rostedt 已提交
1271 1272 1273 1274 1275 1276 1277 1278 1279 1280
	if (PTR_ERR(event) == -EAGAIN)
		goto again;

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

S
Steven Rostedt 已提交
1284 1285 1286 1287 1288 1289 1290
	/*
	 * If the timestamp was commited, make the commit our entry
	 * now so that we will update it when needed.
	 */
	if (commit)
		rb_set_commit_event(cpu_buffer, event);
	else if (!rb_is_commit(cpu_buffer, event))
S
Steven Rostedt 已提交
1291 1292 1293 1294 1295 1296 1297
		delta = 0;

	event->time_delta = delta;

	return event;
}

S
Steven Rostedt 已提交
1298 1299
static DEFINE_PER_CPU(int, rb_need_resched);

S
Steven Rostedt 已提交
1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322
/**
 * 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)
 * @flags: a pointer to save the interrupt flags
 *
 * 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 *
ring_buffer_lock_reserve(struct ring_buffer *buffer,
			 unsigned long length,
			 unsigned long *flags)
{
	struct ring_buffer_per_cpu *cpu_buffer;
	struct ring_buffer_event *event;
S
Steven Rostedt 已提交
1323
	int cpu, resched;
S
Steven Rostedt 已提交
1324

1325
	if (ring_buffer_flags != RB_BUFFERS_ON)
1326 1327
		return NULL;

S
Steven Rostedt 已提交
1328 1329 1330
	if (atomic_read(&buffer->record_disabled))
		return NULL;

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

S
Steven Rostedt 已提交
1334 1335
	cpu = raw_smp_processor_id();

1336
	if (!cpumask_test_cpu(cpu, buffer->cpumask))
1337
		goto out;
S
Steven Rostedt 已提交
1338 1339 1340 1341

	cpu_buffer = buffer->buffers[cpu];

	if (atomic_read(&cpu_buffer->record_disabled))
1342
		goto out;
S
Steven Rostedt 已提交
1343 1344 1345

	length = rb_calculate_event_length(length);
	if (length > BUF_PAGE_SIZE)
S
Steven Rostedt 已提交
1346
		goto out;
S
Steven Rostedt 已提交
1347 1348 1349

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

S
Steven Rostedt 已提交
1352 1353 1354 1355 1356 1357 1358 1359
	/*
	 * 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 已提交
1360 1361
	return event;

1362
 out:
1363
	ftrace_preempt_enable(resched);
S
Steven Rostedt 已提交
1364 1365
	return NULL;
}
1366
EXPORT_SYMBOL_GPL(ring_buffer_lock_reserve);
S
Steven Rostedt 已提交
1367 1368 1369 1370 1371

static void rb_commit(struct ring_buffer_per_cpu *cpu_buffer,
		      struct ring_buffer_event *event)
{
	cpu_buffer->entries++;
S
Steven Rostedt 已提交
1372 1373 1374 1375 1376 1377 1378 1379

	/* 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 已提交
1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402
}

/**
 * ring_buffer_unlock_commit - commit a reserved
 * @buffer: The buffer to commit to
 * @event: The event pointer to commit.
 * @flags: the interrupt flags received from ring_buffer_lock_reserve.
 *
 * 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,
			      struct ring_buffer_event *event,
			      unsigned long flags)
{
	struct ring_buffer_per_cpu *cpu_buffer;
	int cpu = raw_smp_processor_id();

	cpu_buffer = buffer->buffers[cpu];

	rb_commit(cpu_buffer, event);

S
Steven Rostedt 已提交
1403 1404 1405
	/*
	 * Only the last preempt count needs to restore preemption.
	 */
1406 1407 1408
	if (preempt_count() == 1)
		ftrace_preempt_enable(per_cpu(rb_need_resched, cpu));
	else
S
Steven Rostedt 已提交
1409
		preempt_enable_no_resched_notrace();
S
Steven Rostedt 已提交
1410 1411 1412

	return 0;
}
1413
EXPORT_SYMBOL_GPL(ring_buffer_unlock_commit);
S
Steven Rostedt 已提交
1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433

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

1439
	if (ring_buffer_flags != RB_BUFFERS_ON)
1440 1441
		return -EBUSY;

S
Steven Rostedt 已提交
1442 1443 1444
	if (atomic_read(&buffer->record_disabled))
		return -EBUSY;

1445
	resched = ftrace_preempt_disable();
S
Steven Rostedt 已提交
1446

S
Steven Rostedt 已提交
1447 1448
	cpu = raw_smp_processor_id();

1449
	if (!cpumask_test_cpu(cpu, buffer->cpumask))
1450
		goto out;
S
Steven Rostedt 已提交
1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470

	cpu_buffer = buffer->buffers[cpu];

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

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

	body = rb_event_data(event);

	memcpy(body, data, length);

	rb_commit(cpu_buffer, event);

	ret = 0;
 out:
1471
	ftrace_preempt_enable(resched);
S
Steven Rostedt 已提交
1472 1473 1474

	return ret;
}
1475
EXPORT_SYMBOL_GPL(ring_buffer_write);
S
Steven Rostedt 已提交
1476

1477
static int rb_per_cpu_empty(struct ring_buffer_per_cpu *cpu_buffer)
S
Steven Rostedt 已提交
1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488
{
	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 已提交
1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501
/**
 * 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);
}
1502
EXPORT_SYMBOL_GPL(ring_buffer_record_disable);
S
Steven Rostedt 已提交
1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514

/**
 * 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);
}
1515
EXPORT_SYMBOL_GPL(ring_buffer_record_enable);
S
Steven Rostedt 已提交
1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530

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

1531
	if (!cpumask_test_cpu(cpu, buffer->cpumask))
S
Steven Rostedt 已提交
1532 1533 1534 1535 1536
		return;

	cpu_buffer = buffer->buffers[cpu];
	atomic_inc(&cpu_buffer->record_disabled);
}
1537
EXPORT_SYMBOL_GPL(ring_buffer_record_disable_cpu);
S
Steven Rostedt 已提交
1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550

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

1551
	if (!cpumask_test_cpu(cpu, buffer->cpumask))
S
Steven Rostedt 已提交
1552 1553 1554 1555 1556
		return;

	cpu_buffer = buffer->buffers[cpu];
	atomic_dec(&cpu_buffer->record_disabled);
}
1557
EXPORT_SYMBOL_GPL(ring_buffer_record_enable_cpu);
S
Steven Rostedt 已提交
1558 1559 1560 1561 1562 1563 1564 1565 1566 1567

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

1568
	if (!cpumask_test_cpu(cpu, buffer->cpumask))
S
Steven Rostedt 已提交
1569 1570 1571 1572 1573
		return 0;

	cpu_buffer = buffer->buffers[cpu];
	return cpu_buffer->entries;
}
1574
EXPORT_SYMBOL_GPL(ring_buffer_entries_cpu);
S
Steven Rostedt 已提交
1575 1576 1577 1578 1579 1580 1581 1582 1583 1584

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

1585
	if (!cpumask_test_cpu(cpu, buffer->cpumask))
S
Steven Rostedt 已提交
1586 1587 1588 1589 1590
		return 0;

	cpu_buffer = buffer->buffers[cpu];
	return cpu_buffer->overrun;
}
1591
EXPORT_SYMBOL_GPL(ring_buffer_overrun_cpu);
S
Steven Rostedt 已提交
1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613

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

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

	return entries;
}
1614
EXPORT_SYMBOL_GPL(ring_buffer_entries);
S
Steven Rostedt 已提交
1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636

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

1639
static void rb_iter_reset(struct ring_buffer_iter *iter)
S
Steven Rostedt 已提交
1640 1641 1642
{
	struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;

1643 1644 1645
	/* Iterator usage is expected to have record disabled */
	if (list_empty(&cpu_buffer->reader_page->list)) {
		iter->head_page = cpu_buffer->head_page;
1646
		iter->head = cpu_buffer->head_page->read;
1647 1648
	} else {
		iter->head_page = cpu_buffer->reader_page;
1649
		iter->head = cpu_buffer->reader_page->read;
1650 1651 1652 1653
	}
	if (iter->head)
		iter->read_stamp = cpu_buffer->read_stamp;
	else
1654
		iter->read_stamp = iter->head_page->page->time_stamp;
1655
}
S
Steven Rostedt 已提交
1656

1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670
/**
 * 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)
{
	struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;
	unsigned long flags;

	spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
	rb_iter_reset(iter);
S
Steven Rostedt 已提交
1671
	spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
S
Steven Rostedt 已提交
1672
}
1673
EXPORT_SYMBOL_GPL(ring_buffer_iter_reset);
S
Steven Rostedt 已提交
1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684

/**
 * 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 已提交
1685 1686
	return iter->head_page == cpu_buffer->commit_page &&
		iter->head == rb_commit_index(cpu_buffer);
S
Steven Rostedt 已提交
1687
}
1688
EXPORT_SYMBOL_GPL(ring_buffer_iter_empty);
S
Steven Rostedt 已提交
1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 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 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751

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

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

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

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

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

	default:
		BUG();
	}
	return;
}

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

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

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

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

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

	default:
		BUG();
	}
	return;
}

1752 1753
static struct buffer_page *
rb_get_reader_page(struct ring_buffer_per_cpu *cpu_buffer)
S
Steven Rostedt 已提交
1754
{
1755 1756
	struct buffer_page *reader = NULL;
	unsigned long flags;
1757
	int nr_loops = 0;
1758

1759 1760
	local_irq_save(flags);
	__raw_spin_lock(&cpu_buffer->lock);
1761 1762

 again:
1763 1764 1765 1766 1767 1768
	/*
	 * 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 已提交
1769
	if (RB_WARN_ON(cpu_buffer, ++nr_loops > 3)) {
1770 1771 1772 1773
		reader = NULL;
		goto out;
	}

1774 1775 1776
	reader = cpu_buffer->reader_page;

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

	/* Never should we have an index greater than the size */
S
Steven Rostedt 已提交
1781 1782 1783
	if (RB_WARN_ON(cpu_buffer,
		       cpu_buffer->reader_page->read > rb_page_size(reader)))
		goto out;
1784 1785 1786

	/* check if we caught up to the tail */
	reader = NULL;
S
Steven Rostedt 已提交
1787
	if (cpu_buffer->commit_page == cpu_buffer->reader_page)
1788
		goto out;
S
Steven Rostedt 已提交
1789 1790

	/*
1791 1792
	 * Splice the empty reader page into the list around the head.
	 * Reset the reader page to size zero.
S
Steven Rostedt 已提交
1793 1794
	 */

1795 1796 1797
	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 已提交
1798 1799

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

1802 1803 1804
	/* 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 已提交
1805 1806

	/*
1807 1808
	 * 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 已提交
1809
	 */
1810
	cpu_buffer->head_page = cpu_buffer->reader_page;
S
Steven Rostedt 已提交
1811

S
Steven Rostedt 已提交
1812
	if (cpu_buffer->commit_page != reader)
1813 1814 1815 1816 1817 1818 1819 1820 1821
		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:
1822 1823
	__raw_spin_unlock(&cpu_buffer->lock);
	local_irq_restore(flags);
1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834

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

1836
	/* This function should not be called when buffer is empty */
S
Steven Rostedt 已提交
1837 1838
	if (RB_WARN_ON(cpu_buffer, !reader))
		return;
S
Steven Rostedt 已提交
1839

1840 1841 1842 1843 1844 1845 1846 1847
	event = rb_reader_event(cpu_buffer);

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

	rb_update_read_stamp(cpu_buffer, event);

	length = rb_event_length(event);
1848
	cpu_buffer->reader_page->read += length;
S
Steven Rostedt 已提交
1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863
}

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 已提交
1864
	if (iter->head >= rb_page_size(iter->head_page)) {
S
Steven Rostedt 已提交
1865 1866 1867
		if (RB_WARN_ON(buffer,
			       iter->head_page == cpu_buffer->commit_page))
			return;
1868
		rb_inc_iter(iter);
S
Steven Rostedt 已提交
1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879
		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 已提交
1880
	if (RB_WARN_ON(cpu_buffer,
1881
		       (iter->head_page == cpu_buffer->commit_page) &&
S
Steven Rostedt 已提交
1882 1883
		       (iter->head + length > rb_commit_index(cpu_buffer))))
		return;
S
Steven Rostedt 已提交
1884 1885 1886 1887 1888 1889

	rb_update_iter_read_stamp(iter, event);

	iter->head += length;

	/* check for end of page padding */
S
Steven Rostedt 已提交
1890 1891
	if ((iter->head >= rb_page_size(iter->head_page)) &&
	    (iter->head_page != cpu_buffer->commit_page))
S
Steven Rostedt 已提交
1892 1893 1894
		rb_advance_iter(iter);
}

S
Steven Rostedt 已提交
1895 1896
static struct ring_buffer_event *
rb_buffer_peek(struct ring_buffer *buffer, int cpu, u64 *ts)
S
Steven Rostedt 已提交
1897 1898 1899
{
	struct ring_buffer_per_cpu *cpu_buffer;
	struct ring_buffer_event *event;
1900
	struct buffer_page *reader;
1901
	int nr_loops = 0;
S
Steven Rostedt 已提交
1902

1903
	if (!cpumask_test_cpu(cpu, buffer->cpumask))
S
Steven Rostedt 已提交
1904 1905 1906 1907 1908
		return NULL;

	cpu_buffer = buffer->buffers[cpu];

 again:
1909 1910 1911 1912 1913 1914 1915 1916
	/*
	 * We repeat when a timestamp is encountered. It is possible
	 * to get multiple timestamps from an interrupt entering just
	 * as one timestamp is about to be written. The max times
	 * that this can happen is the number of nested interrupts we
	 * can have.  Nesting 10 deep of interrupts is clearly
	 * an anomaly.
	 */
S
Steven Rostedt 已提交
1917
	if (RB_WARN_ON(cpu_buffer, ++nr_loops > 10))
1918 1919
		return NULL;

1920 1921
	reader = rb_get_reader_page(cpu_buffer);
	if (!reader)
S
Steven Rostedt 已提交
1922 1923
		return NULL;

1924
	event = rb_reader_event(cpu_buffer);
S
Steven Rostedt 已提交
1925 1926 1927

	switch (event->type) {
	case RINGBUF_TYPE_PADDING:
S
Steven Rostedt 已提交
1928
		RB_WARN_ON(cpu_buffer, 1);
1929 1930
		rb_advance_reader(cpu_buffer);
		return NULL;
S
Steven Rostedt 已提交
1931 1932 1933

	case RINGBUF_TYPE_TIME_EXTEND:
		/* Internal data, OK to advance */
1934
		rb_advance_reader(cpu_buffer);
S
Steven Rostedt 已提交
1935 1936 1937 1938
		goto again;

	case RINGBUF_TYPE_TIME_STAMP:
		/* FIXME: not implemented */
1939
		rb_advance_reader(cpu_buffer);
S
Steven Rostedt 已提交
1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954
		goto again;

	case RINGBUF_TYPE_DATA:
		if (ts) {
			*ts = cpu_buffer->read_stamp + event->time_delta;
			ring_buffer_normalize_time_stamp(cpu_buffer->cpu, ts);
		}
		return event;

	default:
		BUG();
	}

	return NULL;
}
1955
EXPORT_SYMBOL_GPL(ring_buffer_peek);
S
Steven Rostedt 已提交
1956

S
Steven Rostedt 已提交
1957 1958
static struct ring_buffer_event *
rb_iter_peek(struct ring_buffer_iter *iter, u64 *ts)
S
Steven Rostedt 已提交
1959 1960 1961 1962
{
	struct ring_buffer *buffer;
	struct ring_buffer_per_cpu *cpu_buffer;
	struct ring_buffer_event *event;
1963
	int nr_loops = 0;
S
Steven Rostedt 已提交
1964 1965 1966 1967 1968 1969 1970 1971

	if (ring_buffer_iter_empty(iter))
		return NULL;

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

 again:
1972 1973 1974 1975 1976 1977 1978 1979
	/*
	 * We repeat when a timestamp is encountered. It is possible
	 * to get multiple timestamps from an interrupt entering just
	 * as one timestamp is about to be written. The max times
	 * that this can happen is the number of nested interrupts we
	 * can have. Nesting 10 deep of interrupts is clearly
	 * an anomaly.
	 */
S
Steven Rostedt 已提交
1980
	if (RB_WARN_ON(cpu_buffer, ++nr_loops > 10))
1981 1982
		return NULL;

S
Steven Rostedt 已提交
1983 1984 1985 1986 1987 1988 1989
	if (rb_per_cpu_empty(cpu_buffer))
		return NULL;

	event = rb_iter_head_event(iter);

	switch (event->type) {
	case RINGBUF_TYPE_PADDING:
1990
		rb_inc_iter(iter);
S
Steven Rostedt 已提交
1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015
		goto again;

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

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

	case RINGBUF_TYPE_DATA:
		if (ts) {
			*ts = iter->read_stamp + event->time_delta;
			ring_buffer_normalize_time_stamp(cpu_buffer->cpu, ts);
		}
		return event;

	default:
		BUG();
	}

	return NULL;
}
2016
EXPORT_SYMBOL_GPL(ring_buffer_iter_peek);
S
Steven Rostedt 已提交
2017

S
Steven Rostedt 已提交
2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062
/**
 * 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];
	struct ring_buffer_event *event;
	unsigned long flags;

	spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
	event = rb_buffer_peek(buffer, cpu, ts);
	spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);

	return event;
}

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

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

	return event;
}

S
Steven Rostedt 已提交
2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073
/**
 * 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)
{
S
Steven Rostedt 已提交
2074
	struct ring_buffer_per_cpu *cpu_buffer = buffer->buffers[cpu];
S
Steven Rostedt 已提交
2075
	struct ring_buffer_event *event;
S
Steven Rostedt 已提交
2076
	unsigned long flags;
S
Steven Rostedt 已提交
2077

2078
	if (!cpumask_test_cpu(cpu, buffer->cpumask))
S
Steven Rostedt 已提交
2079 2080
		return NULL;

S
Steven Rostedt 已提交
2081 2082 2083
	spin_lock_irqsave(&cpu_buffer->reader_lock, flags);

	event = rb_buffer_peek(buffer, cpu, ts);
S
Steven Rostedt 已提交
2084
	if (!event)
S
Steven Rostedt 已提交
2085
		goto out;
S
Steven Rostedt 已提交
2086

2087
	rb_advance_reader(cpu_buffer);
S
Steven Rostedt 已提交
2088

S
Steven Rostedt 已提交
2089 2090 2091
 out:
	spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);

S
Steven Rostedt 已提交
2092 2093
	return event;
}
2094
EXPORT_SYMBOL_GPL(ring_buffer_consume);
S
Steven Rostedt 已提交
2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112

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

2115
	if (!cpumask_test_cpu(cpu, buffer->cpumask))
S
Steven Rostedt 已提交
2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128
		return NULL;

	iter = kmalloc(sizeof(*iter), GFP_KERNEL);
	if (!iter)
		return NULL;

	cpu_buffer = buffer->buffers[cpu];

	iter->cpu_buffer = cpu_buffer;

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

S
Steven Rostedt 已提交
2129
	spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
2130
	__raw_spin_lock(&cpu_buffer->lock);
2131
	rb_iter_reset(iter);
2132
	__raw_spin_unlock(&cpu_buffer->lock);
S
Steven Rostedt 已提交
2133
	spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
S
Steven Rostedt 已提交
2134 2135 2136

	return iter;
}
2137
EXPORT_SYMBOL_GPL(ring_buffer_read_start);
S
Steven Rostedt 已提交
2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153

/**
 * 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);
}
2154
EXPORT_SYMBOL_GPL(ring_buffer_read_finish);
S
Steven Rostedt 已提交
2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166

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

S
Steven Rostedt 已提交
2170 2171
	spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
	event = rb_iter_peek(iter, ts);
S
Steven Rostedt 已提交
2172
	if (!event)
S
Steven Rostedt 已提交
2173
		goto out;
S
Steven Rostedt 已提交
2174 2175

	rb_advance_iter(iter);
S
Steven Rostedt 已提交
2176 2177
 out:
	spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
S
Steven Rostedt 已提交
2178 2179 2180

	return event;
}
2181
EXPORT_SYMBOL_GPL(ring_buffer_read);
S
Steven Rostedt 已提交
2182 2183 2184 2185 2186 2187 2188 2189 2190

/**
 * 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;
}
2191
EXPORT_SYMBOL_GPL(ring_buffer_size);
S
Steven Rostedt 已提交
2192 2193 2194 2195 2196 2197

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 已提交
2198
	local_set(&cpu_buffer->head_page->write, 0);
2199
	local_set(&cpu_buffer->head_page->page->commit, 0);
2200

2201
	cpu_buffer->head_page->read = 0;
S
Steven Rostedt 已提交
2202 2203 2204 2205 2206 2207

	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);
2208
	local_set(&cpu_buffer->reader_page->page->commit, 0);
2209
	cpu_buffer->reader_page->read = 0;
S
Steven Rostedt 已提交
2210 2211 2212

	cpu_buffer->overrun = 0;
	cpu_buffer->entries = 0;
2213 2214 2215

	cpu_buffer->write_stamp = 0;
	cpu_buffer->read_stamp = 0;
S
Steven Rostedt 已提交
2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227
}

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

2228
	if (!cpumask_test_cpu(cpu, buffer->cpumask))
S
Steven Rostedt 已提交
2229 2230
		return;

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

2233
	__raw_spin_lock(&cpu_buffer->lock);
S
Steven Rostedt 已提交
2234 2235 2236

	rb_reset_cpu(cpu_buffer);

2237
	__raw_spin_unlock(&cpu_buffer->lock);
S
Steven Rostedt 已提交
2238 2239

	spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
S
Steven Rostedt 已提交
2240
}
2241
EXPORT_SYMBOL_GPL(ring_buffer_reset_cpu);
S
Steven Rostedt 已提交
2242 2243 2244 2245 2246 2247 2248 2249 2250 2251

/**
 * 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)
2252
		ring_buffer_reset_cpu(buffer, cpu);
S
Steven Rostedt 已提交
2253
}
2254
EXPORT_SYMBOL_GPL(ring_buffer_reset);
S
Steven Rostedt 已提交
2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272

/**
 * 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;
	}
	return 1;
}
2273
EXPORT_SYMBOL_GPL(ring_buffer_empty);
S
Steven Rostedt 已提交
2274 2275 2276 2277 2278 2279 2280 2281 2282 2283

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

2284
	if (!cpumask_test_cpu(cpu, buffer->cpumask))
S
Steven Rostedt 已提交
2285 2286 2287 2288 2289
		return 1;

	cpu_buffer = buffer->buffers[cpu];
	return rb_per_cpu_empty(cpu_buffer);
}
2290
EXPORT_SYMBOL_GPL(ring_buffer_empty_cpu);
S
Steven Rostedt 已提交
2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307

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

2308 2309
	if (!cpumask_test_cpu(cpu, buffer_a->cpumask) ||
	    !cpumask_test_cpu(cpu, buffer_b->cpumask))
S
Steven Rostedt 已提交
2310 2311 2312
		return -EINVAL;

	/* At least make sure the two buffers are somewhat the same */
2313
	if (buffer_a->pages != buffer_b->pages)
S
Steven Rostedt 已提交
2314 2315
		return -EINVAL;

2316 2317 2318 2319 2320 2321 2322 2323 2324
	if (ring_buffer_flags != RB_BUFFERS_ON)
		return -EAGAIN;

	if (atomic_read(&buffer_a->record_disabled))
		return -EAGAIN;

	if (atomic_read(&buffer_b->record_disabled))
		return -EAGAIN;

S
Steven Rostedt 已提交
2325 2326 2327
	cpu_buffer_a = buffer_a->buffers[cpu];
	cpu_buffer_b = buffer_b->buffers[cpu];

2328 2329 2330 2331 2332 2333
	if (atomic_read(&cpu_buffer_a->record_disabled))
		return -EAGAIN;

	if (atomic_read(&cpu_buffer_b->record_disabled))
		return -EAGAIN;

S
Steven Rostedt 已提交
2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353
	/*
	 * 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);

	return 0;
}
2354
EXPORT_SYMBOL_GPL(ring_buffer_swap_cpu);
S
Steven Rostedt 已提交
2355

S
Steven Rostedt 已提交
2356
static void rb_remove_entries(struct ring_buffer_per_cpu *cpu_buffer,
2357
			      struct buffer_data_page *bpage)
S
Steven Rostedt 已提交
2358 2359 2360 2361 2362
{
	struct ring_buffer_event *event;
	unsigned long head;

	__raw_spin_lock(&cpu_buffer->lock);
2363
	for (head = 0; head < local_read(&bpage->commit);
S
Steven Rostedt 已提交
2364 2365
	     head += rb_event_length(event)) {

2366
		event = __rb_data_page_index(bpage, head);
S
Steven Rostedt 已提交
2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394
		if (RB_WARN_ON(cpu_buffer, rb_null_event(event)))
			return;
		/* Only count data entries */
		if (event->type != RINGBUF_TYPE_DATA)
			continue;
		cpu_buffer->entries--;
	}
	__raw_spin_unlock(&cpu_buffer->lock);
}

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

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

2401
	bpage = (void *)addr;
S
Steven Rostedt 已提交
2402

2403
	return bpage;
S
Steven Rostedt 已提交
2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454
}

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

/**
 * ring_buffer_read_page - extract a page from the ring buffer
 * @buffer: buffer to extract from
 * @data_page: the page to use allocated from ring_buffer_alloc_read_page
 * @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:
 *	rpage = ring_buffer_alloc_page(buffer);
 *	if (!rpage)
 *		return error;
 *	ret = ring_buffer_read_page(buffer, &rpage, cpu, 0);
 *	if (ret)
 *		process_page(rpage);
 *
 * 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:
 *  1 if data has been transferred
 *  0 if no data has been transferred.
 */
int ring_buffer_read_page(struct ring_buffer *buffer,
			    void **data_page, int cpu, int full)
{
	struct ring_buffer_per_cpu *cpu_buffer = buffer->buffers[cpu];
	struct ring_buffer_event *event;
2455
	struct buffer_data_page *bpage;
S
Steven Rostedt 已提交
2456 2457 2458 2459 2460 2461
	unsigned long flags;
	int ret = 0;

	if (!data_page)
		return 0;

2462 2463
	bpage = *data_page;
	if (!bpage)
S
Steven Rostedt 已提交
2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489
		return 0;

	spin_lock_irqsave(&cpu_buffer->reader_lock, flags);

	/*
	 * rb_buffer_peek will get the next ring buffer if
	 * the current reader page is empty.
	 */
	event = rb_buffer_peek(buffer, cpu, NULL);
	if (!event)
		goto out;

	/* check for data */
	if (!local_read(&cpu_buffer->reader_page->page->commit))
		goto out;
	/*
	 * If the writer is already off of the read page, then simply
	 * switch the read page with the given page. Otherwise
	 * we need to copy the data from the reader to the writer.
	 */
	if (cpu_buffer->reader_page == cpu_buffer->commit_page) {
		unsigned int read = cpu_buffer->reader_page->read;

		if (full)
			goto out;
		/* The writer is still on the reader page, we must copy */
2490 2491
		bpage = cpu_buffer->reader_page->page;
		memcpy(bpage->data,
S
Steven Rostedt 已提交
2492
		       cpu_buffer->reader_page->page->data + read,
2493
		       local_read(&bpage->commit) - read);
S
Steven Rostedt 已提交
2494 2495 2496 2497 2498 2499

		/* consume what was read */
		cpu_buffer->reader_page += read;

	} else {
		/* swap the pages */
2500 2501
		rb_init_page(bpage);
		bpage = cpu_buffer->reader_page->page;
S
Steven Rostedt 已提交
2502 2503
		cpu_buffer->reader_page->page = *data_page;
		cpu_buffer->reader_page->read = 0;
2504
		*data_page = bpage;
S
Steven Rostedt 已提交
2505 2506 2507 2508
	}
	ret = 1;

	/* update the entry counter */
2509
	rb_remove_entries(cpu_buffer, bpage);
S
Steven Rostedt 已提交
2510 2511 2512 2513 2514 2515
 out:
	spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);

	return ret;
}

2516 2517 2518 2519
static ssize_t
rb_simple_read(struct file *filp, char __user *ubuf,
	       size_t cnt, loff_t *ppos)
{
2520
	long *p = filp->private_data;
2521 2522 2523
	char buf[64];
	int r;

2524 2525 2526 2527
	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));
2528 2529 2530 2531 2532 2533 2534 2535

	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)
{
2536
	long *p = filp->private_data;
2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552
	char buf[64];
	long val;
	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;

2553 2554 2555 2556
	if (val)
		set_bit(RB_BUFFERS_ON_BIT, p);
	else
		clear_bit(RB_BUFFERS_ON_BIT, p);
2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577

	(*ppos)++;

	return cnt;
}

static struct file_operations rb_simple_fops = {
	.open		= tracing_open_generic,
	.read		= rb_simple_read,
	.write		= rb_simple_write,
};


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

	d_tracer = tracing_init_dentry();

	entry = debugfs_create_file("tracing_on", 0644, d_tracer,
2578
				    &ring_buffer_flags, &rb_simple_fops);
2579 2580 2581 2582 2583 2584 2585
	if (!entry)
		pr_warning("Could not create debugfs 'tracing_on' entry\n");

	return 0;
}

fs_initcall(rb_init_debugfs);