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

23
#include <asm/local.h>
24 25
#include "trace.h"

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

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

	return ret;
}

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

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

155
static unsigned long ring_buffer_flags __read_mostly = RB_BUFFERS_ON;
156

157 158
/* Used for individual buffers (after the counter) */
#define RB_BUFFER_OFF		(1 << 20)
159

160
#define BUF_PAGE_HDR_SIZE offsetof(struct buffer_data_page, data)
161 162 163 164 165

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

173
#define RB_EVNT_HDR_SIZE (offsetof(struct ring_buffer_event, array))
174
#define RB_ALIGNMENT		4U
175
#define RB_MAX_SMALL_DATA	(RB_ALIGNMENT * RINGBUF_TYPE_DATA_TYPE_LEN_MAX)
176
#define RB_EVNT_MIN_SIZE	8U	/* two 32bit words */
177

178 179 180 181 182 183 184 185
#if !defined(CONFIG_64BIT) || defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS)
# define RB_FORCE_8BYTE_ALIGNMENT	0
# define RB_ARCH_ALIGNMENT		RB_ALIGNMENT
#else
# define RB_FORCE_8BYTE_ALIGNMENT	1
# define RB_ARCH_ALIGNMENT		8U
#endif

186 187
/* define RINGBUF_TYPE_DATA for 'case RINGBUF_TYPE_DATA:' */
#define RINGBUF_TYPE_DATA 0 ... RINGBUF_TYPE_DATA_TYPE_LEN_MAX
S
Steven Rostedt 已提交
188 189 190 191 192 193

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

194 195 196
#define skip_time_extend(event) \
	((struct ring_buffer_event *)((char *)event + RB_LEN_TIME_EXTEND))

197 198
static inline int rb_null_event(struct ring_buffer_event *event)
{
199
	return event->type_len == RINGBUF_TYPE_PADDING && !event->time_delta;
200 201 202 203
}

static void rb_event_set_padding(struct ring_buffer_event *event)
{
204
	/* padding has a NULL time_delta */
205
	event->type_len = RINGBUF_TYPE_PADDING;
206 207 208
	event->time_delta = 0;
}

209
static unsigned
210
rb_event_data_length(struct ring_buffer_event *event)
S
Steven Rostedt 已提交
211 212 213
{
	unsigned length;

214 215
	if (event->type_len)
		length = event->type_len * RB_ALIGNMENT;
216 217 218 219 220
	else
		length = event->array[0];
	return length + RB_EVNT_HDR_SIZE;
}

221 222 223 224 225 226
/*
 * Return the length of the given event. Will return
 * the length of the time extend if the event is a
 * time extend.
 */
static inline unsigned
227 228
rb_event_length(struct ring_buffer_event *event)
{
229
	switch (event->type_len) {
S
Steven Rostedt 已提交
230
	case RINGBUF_TYPE_PADDING:
231 232 233
		if (rb_null_event(event))
			/* undefined */
			return -1;
234
		return  event->array[0] + RB_EVNT_HDR_SIZE;
S
Steven Rostedt 已提交
235 236 237 238 239 240 241 242

	case RINGBUF_TYPE_TIME_EXTEND:
		return RB_LEN_TIME_EXTEND;

	case RINGBUF_TYPE_TIME_STAMP:
		return RB_LEN_TIME_STAMP;

	case RINGBUF_TYPE_DATA:
243
		return rb_event_data_length(event);
S
Steven Rostedt 已提交
244 245 246 247 248 249 250
	default:
		BUG();
	}
	/* not hit */
	return 0;
}

251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267
/*
 * Return total length of time extend and data,
 *   or just the event length for all other events.
 */
static inline unsigned
rb_event_ts_length(struct ring_buffer_event *event)
{
	unsigned len = 0;

	if (event->type_len == RINGBUF_TYPE_TIME_EXTEND) {
		/* time extends include the data event after it */
		len = RB_LEN_TIME_EXTEND;
		event = skip_time_extend(event);
	}
	return len + rb_event_length(event);
}

S
Steven Rostedt 已提交
268 269 270
/**
 * ring_buffer_event_length - return the length of the event
 * @event: the event to get the length of
271 272 273 274 275 276
 *
 * Returns the size of the data load of a data event.
 * If the event is something other than a data event, it
 * returns the size of the event itself. With the exception
 * of a TIME EXTEND, where it still returns the size of the
 * data load of the data event after it.
S
Steven Rostedt 已提交
277 278 279
 */
unsigned ring_buffer_event_length(struct ring_buffer_event *event)
{
280 281 282 283 284 285
	unsigned length;

	if (event->type_len == RINGBUF_TYPE_TIME_EXTEND)
		event = skip_time_extend(event);

	length = rb_event_length(event);
286
	if (event->type_len > RINGBUF_TYPE_DATA_TYPE_LEN_MAX)
287 288 289 290 291
		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 已提交
292
}
293
EXPORT_SYMBOL_GPL(ring_buffer_event_length);
S
Steven Rostedt 已提交
294 295

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

#define for_each_buffer_cpu(buffer, cpu)		\
320
	for_each_cpu(cpu, buffer->cpumask)
S
Steven Rostedt 已提交
321 322 323 324 325

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

326 327
/* Flag when events were overwritten */
#define RB_MISSED_EVENTS	(1 << 31)
328 329
/* Missed count stored at end */
#define RB_MISSED_STORED	(1 << 30)
330

331
struct buffer_data_page {
332
	u64		 time_stamp;	/* page time stamp */
W
Wenji Huang 已提交
333
	local_t		 commit;	/* write committed index */
334 335 336
	unsigned char	 data[];	/* data of buffer page */
};

S
Steven Rostedt 已提交
337 338 339 340 341 342 343 344
/*
 * Note, the buffer_page list must be first. The buffer pages
 * are allocated in cache lines, which means that each buffer
 * page will be at the beginning of a cache line, and thus
 * the least significant bits will be zero. We use this to
 * add flags in the list struct pointers, to make the ring buffer
 * lockless.
 */
345
struct buffer_page {
346
	struct list_head list;		/* list of buffer pages */
347
	local_t		 write;		/* index for next write */
348
	unsigned	 read;		/* index for next read */
349
	local_t		 entries;	/* entries on this page */
350
	unsigned long	 real_end;	/* real end of data */
351
	struct buffer_data_page *page;	/* Actual data page */
S
Steven Rostedt 已提交
352 353
};

S
Steven Rostedt 已提交
354 355 356 357 358 359 360 361 362 363 364 365 366 367 368
/*
 * The buffer page counters, write and entries, must be reset
 * atomically when crossing page boundaries. To synchronize this
 * update, two counters are inserted into the number. One is
 * the actual counter for the write position or count on the page.
 *
 * The other is a counter of updaters. Before an update happens
 * the update partition of the counter is incremented. This will
 * allow the updater to update the counter atomically.
 *
 * The counter is 20 bits, and the state data is 12.
 */
#define RB_WRITE_MASK		0xfffff
#define RB_WRITE_INTCNT		(1 << 20)

369
static void rb_init_page(struct buffer_data_page *bpage)
370
{
371
	local_set(&bpage->commit, 0);
372 373
}

374 375 376 377 378 379
/**
 * 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.
 */
380 381
size_t ring_buffer_page_len(void *page)
{
382 383
	return local_read(&((struct buffer_data_page *)page)->commit)
		+ BUF_PAGE_HDR_SIZE;
384 385
}

386 387 388 389
/*
 * Also stolen from mm/slob.c. Thanks to Mathieu Desnoyers for pointing
 * this issue out.
 */
390
static void free_buffer_page(struct buffer_page *bpage)
391
{
392
	free_page((unsigned long)bpage->page);
393
	kfree(bpage);
394 395
}

S
Steven Rostedt 已提交
396 397 398 399 400 401 402 403 404 405
/*
 * 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;
}

406
#define BUF_PAGE_SIZE (PAGE_SIZE - BUF_PAGE_HDR_SIZE)
S
Steven Rostedt 已提交
407

408 409 410
/* Max payload is BUF_PAGE_SIZE - header (8bytes) */
#define BUF_MAX_DATA_SIZE (BUF_PAGE_SIZE - (sizeof(u32) * 2))

411 412 413 414 415 416
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"
417 418 419
			       "offset:0;\tsize:%u;\tsigned:%u;\n",
			       (unsigned int)sizeof(field.time_stamp),
			       (unsigned int)is_signed_type(u64));
420 421

	ret = trace_seq_printf(s, "\tfield: local_t commit;\t"
422
			       "offset:%u;\tsize:%u;\tsigned:%u;\n",
423
			       (unsigned int)offsetof(typeof(field), commit),
424 425
			       (unsigned int)sizeof(field.commit),
			       (unsigned int)is_signed_type(long));
426

427 428 429 430 431 432
	ret = trace_seq_printf(s, "\tfield: int overwrite;\t"
			       "offset:%u;\tsize:%u;\tsigned:%u;\n",
			       (unsigned int)offsetof(typeof(field), commit),
			       1,
			       (unsigned int)is_signed_type(long));

433
	ret = trace_seq_printf(s, "\tfield: char data;\t"
434
			       "offset:%u;\tsize:%u;\tsigned:%u;\n",
435
			       (unsigned int)offsetof(typeof(field), data),
436 437
			       (unsigned int)BUF_PAGE_SIZE,
			       (unsigned int)is_signed_type(char));
438 439 440 441

	return ret;
}

S
Steven Rostedt 已提交
442 443 444 445 446
/*
 * head_page == tail_page && head == tail then buffer is empty.
 */
struct ring_buffer_per_cpu {
	int				cpu;
447
	atomic_t			record_disabled;
S
Steven Rostedt 已提交
448
	struct ring_buffer		*buffer;
449
	raw_spinlock_t			reader_lock;	/* serialize readers */
450
	arch_spinlock_t			lock;
S
Steven Rostedt 已提交
451
	struct lock_class_key		lock_key;
452
	unsigned int			nr_pages;
453
	struct list_head		*pages;
454 455
	struct buffer_page		*head_page;	/* read from head */
	struct buffer_page		*tail_page;	/* write to tail */
W
Wenji Huang 已提交
456
	struct buffer_page		*commit_page;	/* committed pages */
457
	struct buffer_page		*reader_page;
458 459
	unsigned long			lost_events;
	unsigned long			last_overrun;
460
	local_t				entries_bytes;
S
Steven Rostedt 已提交
461 462
	local_t				commit_overrun;
	local_t				overrun;
463
	local_t				entries;
464 465
	local_t				committing;
	local_t				commits;
S
Steven Rostedt 已提交
466
	unsigned long			read;
467
	unsigned long			read_bytes;
S
Steven Rostedt 已提交
468 469
	u64				write_stamp;
	u64				read_stamp;
470 471 472
	/* ring buffer pages to update, > 0 to add, < 0 to remove */
	int				nr_pages_to_update;
	struct list_head		new_pages; /* new pages to add */
S
Steven Rostedt 已提交
473 474 475 476 477 478
};

struct ring_buffer {
	unsigned			flags;
	int				cpus;
	atomic_t			record_disabled;
479
	cpumask_var_t			cpumask;
S
Steven Rostedt 已提交
480

481 482
	struct lock_class_key		*reader_lock_key;

S
Steven Rostedt 已提交
483 484 485
	struct mutex			mutex;

	struct ring_buffer_per_cpu	**buffers;
486

487
#ifdef CONFIG_HOTPLUG_CPU
488 489
	struct notifier_block		cpu_notify;
#endif
490
	u64				(*clock)(void);
S
Steven Rostedt 已提交
491 492 493 494 495 496
};

struct ring_buffer_iter {
	struct ring_buffer_per_cpu	*cpu_buffer;
	unsigned long			head;
	struct buffer_page		*head_page;
497 498
	struct buffer_page		*cache_reader_page;
	unsigned long			cache_read;
S
Steven Rostedt 已提交
499 500 501
	u64				read_stamp;
};

502
/* buffer may be either ring_buffer or ring_buffer_per_cpu */
503 504 505 506 507 508 509 510 511 512 513 514 515
#define RB_WARN_ON(b, cond)						\
	({								\
		int _____ret = unlikely(cond);				\
		if (_____ret) {						\
			if (__same_type(*(b), struct ring_buffer_per_cpu)) { \
				struct ring_buffer_per_cpu *__b =	\
					(void *)b;			\
				atomic_inc(&__b->buffer->record_disabled); \
			} else						\
				atomic_inc(&b->record_disabled);	\
			WARN_ON(1);					\
		}							\
		_____ret;						\
S
Steven Rostedt 已提交
516
	})
517

518 519 520
/* Up this if you want to test the TIME_EXTENTS and normalization */
#define DEBUG_SHIFT 0

521
static inline u64 rb_time_stamp(struct ring_buffer *buffer)
522 523 524 525 526
{
	/* shift to debug/test normalization and TIME_EXTENTS */
	return buffer->clock() << DEBUG_SHIFT;
}

527 528 529 530 531
u64 ring_buffer_time_stamp(struct ring_buffer *buffer, int cpu)
{
	u64 time;

	preempt_disable_notrace();
532
	time = rb_time_stamp(buffer);
533 534 535 536 537 538 539 540 541 542 543 544 545 546
	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 已提交
547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 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 634 635 636
/*
 * Making the ring buffer lockless makes things tricky.
 * Although writes only happen on the CPU that they are on,
 * and they only need to worry about interrupts. Reads can
 * happen on any CPU.
 *
 * The reader page is always off the ring buffer, but when the
 * reader finishes with a page, it needs to swap its page with
 * a new one from the buffer. The reader needs to take from
 * the head (writes go to the tail). But if a writer is in overwrite
 * mode and wraps, it must push the head page forward.
 *
 * Here lies the problem.
 *
 * The reader must be careful to replace only the head page, and
 * not another one. As described at the top of the file in the
 * ASCII art, the reader sets its old page to point to the next
 * page after head. It then sets the page after head to point to
 * the old reader page. But if the writer moves the head page
 * during this operation, the reader could end up with the tail.
 *
 * We use cmpxchg to help prevent this race. We also do something
 * special with the page before head. We set the LSB to 1.
 *
 * When the writer must push the page forward, it will clear the
 * bit that points to the head page, move the head, and then set
 * the bit that points to the new head page.
 *
 * We also don't want an interrupt coming in and moving the head
 * page on another writer. Thus we use the second LSB to catch
 * that too. Thus:
 *
 * head->list->prev->next        bit 1          bit 0
 *                              -------        -------
 * Normal page                     0              0
 * Points to head page             0              1
 * New head page                   1              0
 *
 * Note we can not trust the prev pointer of the head page, because:
 *
 * +----+       +-----+        +-----+
 * |    |------>|  T  |---X--->|  N  |
 * |    |<------|     |        |     |
 * +----+       +-----+        +-----+
 *   ^                           ^ |
 *   |          +-----+          | |
 *   +----------|  R  |----------+ |
 *              |     |<-----------+
 *              +-----+
 *
 * Key:  ---X-->  HEAD flag set in pointer
 *         T      Tail page
 *         R      Reader page
 *         N      Next page
 *
 * (see __rb_reserve_next() to see where this happens)
 *
 *  What the above shows is that the reader just swapped out
 *  the reader page with a page in the buffer, but before it
 *  could make the new header point back to the new page added
 *  it was preempted by a writer. The writer moved forward onto
 *  the new page added by the reader and is about to move forward
 *  again.
 *
 *  You can see, it is legitimate for the previous pointer of
 *  the head (or any page) not to point back to itself. But only
 *  temporarially.
 */

#define RB_PAGE_NORMAL		0UL
#define RB_PAGE_HEAD		1UL
#define RB_PAGE_UPDATE		2UL


#define RB_FLAG_MASK		3UL

/* PAGE_MOVED is not part of the mask */
#define RB_PAGE_MOVED		4UL

/*
 * rb_list_head - remove any bit
 */
static struct list_head *rb_list_head(struct list_head *list)
{
	unsigned long val = (unsigned long)list;

	return (struct list_head *)(val & ~RB_FLAG_MASK);
}

/*
637
 * rb_is_head_page - test if the given page is the head page
S
Steven Rostedt 已提交
638 639 640 641 642 643
 *
 * Because the reader may move the head_page pointer, we can
 * not trust what the head page is (it may be pointing to
 * the reader page). But if the next page is a header page,
 * its flags will be non zero.
 */
644
static inline int
S
Steven Rostedt 已提交
645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736
rb_is_head_page(struct ring_buffer_per_cpu *cpu_buffer,
		struct buffer_page *page, struct list_head *list)
{
	unsigned long val;

	val = (unsigned long)list->next;

	if ((val & ~RB_FLAG_MASK) != (unsigned long)&page->list)
		return RB_PAGE_MOVED;

	return val & RB_FLAG_MASK;
}

/*
 * rb_is_reader_page
 *
 * The unique thing about the reader page, is that, if the
 * writer is ever on it, the previous pointer never points
 * back to the reader page.
 */
static int rb_is_reader_page(struct buffer_page *page)
{
	struct list_head *list = page->list.prev;

	return rb_list_head(list->next) != &page->list;
}

/*
 * rb_set_list_to_head - set a list_head to be pointing to head.
 */
static void rb_set_list_to_head(struct ring_buffer_per_cpu *cpu_buffer,
				struct list_head *list)
{
	unsigned long *ptr;

	ptr = (unsigned long *)&list->next;
	*ptr |= RB_PAGE_HEAD;
	*ptr &= ~RB_PAGE_UPDATE;
}

/*
 * rb_head_page_activate - sets up head page
 */
static void rb_head_page_activate(struct ring_buffer_per_cpu *cpu_buffer)
{
	struct buffer_page *head;

	head = cpu_buffer->head_page;
	if (!head)
		return;

	/*
	 * Set the previous list pointer to have the HEAD flag.
	 */
	rb_set_list_to_head(cpu_buffer, head->list.prev);
}

static void rb_list_head_clear(struct list_head *list)
{
	unsigned long *ptr = (unsigned long *)&list->next;

	*ptr &= ~RB_FLAG_MASK;
}

/*
 * rb_head_page_dactivate - clears head page ptr (for free list)
 */
static void
rb_head_page_deactivate(struct ring_buffer_per_cpu *cpu_buffer)
{
	struct list_head *hd;

	/* Go through the whole list and clear any pointers found. */
	rb_list_head_clear(cpu_buffer->pages);

	list_for_each(hd, cpu_buffer->pages)
		rb_list_head_clear(hd);
}

static int rb_head_page_set(struct ring_buffer_per_cpu *cpu_buffer,
			    struct buffer_page *head,
			    struct buffer_page *prev,
			    int old_flag, int new_flag)
{
	struct list_head *list;
	unsigned long val = (unsigned long)&head->list;
	unsigned long ret;

	list = &prev->list;

	val &= ~RB_FLAG_MASK;

737 738
	ret = cmpxchg((unsigned long *)&list->next,
		      val | old_flag, val | new_flag);
S
Steven Rostedt 已提交
739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829

	/* check if the reader took the page */
	if ((ret & ~RB_FLAG_MASK) != val)
		return RB_PAGE_MOVED;

	return ret & RB_FLAG_MASK;
}

static int rb_head_page_set_update(struct ring_buffer_per_cpu *cpu_buffer,
				   struct buffer_page *head,
				   struct buffer_page *prev,
				   int old_flag)
{
	return rb_head_page_set(cpu_buffer, head, prev,
				old_flag, RB_PAGE_UPDATE);
}

static int rb_head_page_set_head(struct ring_buffer_per_cpu *cpu_buffer,
				 struct buffer_page *head,
				 struct buffer_page *prev,
				 int old_flag)
{
	return rb_head_page_set(cpu_buffer, head, prev,
				old_flag, RB_PAGE_HEAD);
}

static int rb_head_page_set_normal(struct ring_buffer_per_cpu *cpu_buffer,
				   struct buffer_page *head,
				   struct buffer_page *prev,
				   int old_flag)
{
	return rb_head_page_set(cpu_buffer, head, prev,
				old_flag, RB_PAGE_NORMAL);
}

static inline void rb_inc_page(struct ring_buffer_per_cpu *cpu_buffer,
			       struct buffer_page **bpage)
{
	struct list_head *p = rb_list_head((*bpage)->list.next);

	*bpage = list_entry(p, struct buffer_page, list);
}

static struct buffer_page *
rb_set_head_page(struct ring_buffer_per_cpu *cpu_buffer)
{
	struct buffer_page *head;
	struct buffer_page *page;
	struct list_head *list;
	int i;

	if (RB_WARN_ON(cpu_buffer, !cpu_buffer->head_page))
		return NULL;

	/* sanity check */
	list = cpu_buffer->pages;
	if (RB_WARN_ON(cpu_buffer, rb_list_head(list->prev->next) != list))
		return NULL;

	page = head = cpu_buffer->head_page;
	/*
	 * It is possible that the writer moves the header behind
	 * where we started, and we miss in one loop.
	 * A second loop should grab the header, but we'll do
	 * three loops just because I'm paranoid.
	 */
	for (i = 0; i < 3; i++) {
		do {
			if (rb_is_head_page(cpu_buffer, page, page->list.prev)) {
				cpu_buffer->head_page = page;
				return page;
			}
			rb_inc_page(cpu_buffer, &page);
		} while (page != head);
	}

	RB_WARN_ON(cpu_buffer, 1);

	return NULL;
}

static int rb_head_page_replace(struct buffer_page *old,
				struct buffer_page *new)
{
	unsigned long *ptr = (unsigned long *)&old->list.prev->next;
	unsigned long val;
	unsigned long ret;

	val = *ptr & ~RB_FLAG_MASK;
	val |= RB_PAGE_HEAD;

830
	ret = cmpxchg(ptr, val, (unsigned long)&new->list);
S
Steven Rostedt 已提交
831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880

	return ret == val;
}

/*
 * rb_tail_page_update - move the tail page forward
 *
 * Returns 1 if moved tail page, 0 if someone else did.
 */
static int rb_tail_page_update(struct ring_buffer_per_cpu *cpu_buffer,
			       struct buffer_page *tail_page,
			       struct buffer_page *next_page)
{
	struct buffer_page *old_tail;
	unsigned long old_entries;
	unsigned long old_write;
	int ret = 0;

	/*
	 * The tail page now needs to be moved forward.
	 *
	 * We need to reset the tail page, but without messing
	 * with possible erasing of data brought in by interrupts
	 * that have moved the tail page and are currently on it.
	 *
	 * We add a counter to the write field to denote this.
	 */
	old_write = local_add_return(RB_WRITE_INTCNT, &next_page->write);
	old_entries = local_add_return(RB_WRITE_INTCNT, &next_page->entries);

	/*
	 * Just make sure we have seen our old_write and synchronize
	 * with any interrupts that come in.
	 */
	barrier();

	/*
	 * 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) {
		/* Zero the write counter */
		unsigned long val = old_write & ~RB_WRITE_MASK;
		unsigned long eval = old_entries & ~RB_WRITE_MASK;

		/*
		 * This will only succeed if an interrupt did
		 * not come in and change it. In which case, we
		 * do not want to modify it.
881 882 883 884 885
		 *
		 * We add (void) to let the compiler know that we do not care
		 * about the return value of these functions. We use the
		 * cmpxchg to only update if an interrupt did not already
		 * do it for us. If the cmpxchg fails, we don't care.
S
Steven Rostedt 已提交
886
		 */
887 888
		(void)local_cmpxchg(&next_page->write, old_write, val);
		(void)local_cmpxchg(&next_page->entries, old_entries, eval);
S
Steven Rostedt 已提交
889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930

		/*
		 * No need to worry about races with clearing out the commit.
		 * it only can increment when a commit takes place. But that
		 * only happens in the outer most nested commit.
		 */
		local_set(&next_page->page->commit, 0);

		old_tail = cmpxchg(&cpu_buffer->tail_page,
				   tail_page, next_page);

		if (old_tail == tail_page)
			ret = 1;
	}

	return ret;
}

static int rb_check_bpage(struct ring_buffer_per_cpu *cpu_buffer,
			  struct buffer_page *bpage)
{
	unsigned long val = (unsigned long)bpage;

	if (RB_WARN_ON(cpu_buffer, val & RB_FLAG_MASK))
		return 1;

	return 0;
}

/**
 * rb_check_list - make sure a pointer to a list has the last bits zero
 */
static int rb_check_list(struct ring_buffer_per_cpu *cpu_buffer,
			 struct list_head *list)
{
	if (RB_WARN_ON(cpu_buffer, rb_list_head(list->prev) != list->prev))
		return 1;
	if (RB_WARN_ON(cpu_buffer, rb_list_head(list->next) != list->next))
		return 1;
	return 0;
}

S
Steven Rostedt 已提交
931 932 933 934
/**
 * check_pages - integrity check of buffer pages
 * @cpu_buffer: CPU buffer with pages to test
 *
W
Wenji Huang 已提交
935
 * As a safety measure we check to make sure the data pages have not
S
Steven Rostedt 已提交
936 937 938 939
 * been corrupted.
 */
static int rb_check_pages(struct ring_buffer_per_cpu *cpu_buffer)
{
940
	struct list_head *head = cpu_buffer->pages;
941
	struct buffer_page *bpage, *tmp;
S
Steven Rostedt 已提交
942

S
Steven Rostedt 已提交
943 944
	rb_head_page_deactivate(cpu_buffer);

S
Steven Rostedt 已提交
945 946 947 948
	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 已提交
949

S
Steven Rostedt 已提交
950 951 952
	if (rb_check_list(cpu_buffer, head))
		return -1;

953
	list_for_each_entry_safe(bpage, tmp, head, list) {
S
Steven Rostedt 已提交
954
		if (RB_WARN_ON(cpu_buffer,
955
			       bpage->list.next->prev != &bpage->list))
S
Steven Rostedt 已提交
956 957
			return -1;
		if (RB_WARN_ON(cpu_buffer,
958
			       bpage->list.prev->next != &bpage->list))
S
Steven Rostedt 已提交
959
			return -1;
S
Steven Rostedt 已提交
960 961
		if (rb_check_list(cpu_buffer, &bpage->list))
			return -1;
S
Steven Rostedt 已提交
962 963
	}

S
Steven Rostedt 已提交
964 965
	rb_head_page_activate(cpu_buffer);

S
Steven Rostedt 已提交
966 967 968
	return 0;
}

969
static int __rb_allocate_pages(int nr_pages, struct list_head *pages, int cpu)
S
Steven Rostedt 已提交
970
{
971
	int i;
972
	struct buffer_page *bpage, *tmp;
973

S
Steven Rostedt 已提交
974
	for (i = 0; i < nr_pages; i++) {
975
		struct page *page;
976 977 978 979 980
		/*
		 * __GFP_NORETRY flag makes sure that the allocation fails
		 * gracefully without invoking oom-killer and the system is
		 * not destabilized.
		 */
981
		bpage = kzalloc_node(ALIGN(sizeof(*bpage), cache_line_size()),
982
				    GFP_KERNEL | __GFP_NORETRY,
983
				    cpu_to_node(cpu));
984
		if (!bpage)
985
			goto free_pages;
S
Steven Rostedt 已提交
986

987
		list_add(&bpage->list, pages);
S
Steven Rostedt 已提交
988

989
		page = alloc_pages_node(cpu_to_node(cpu),
990
					GFP_KERNEL | __GFP_NORETRY, 0);
991
		if (!page)
S
Steven Rostedt 已提交
992
			goto free_pages;
993
		bpage->page = page_address(page);
994
		rb_init_page(bpage->page);
S
Steven Rostedt 已提交
995 996
	}

997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017
	return 0;

free_pages:
	list_for_each_entry_safe(bpage, tmp, pages, list) {
		list_del_init(&bpage->list);
		free_buffer_page(bpage);
	}

	return -ENOMEM;
}

static int rb_allocate_pages(struct ring_buffer_per_cpu *cpu_buffer,
			     unsigned nr_pages)
{
	LIST_HEAD(pages);

	WARN_ON(!nr_pages);

	if (__rb_allocate_pages(nr_pages, &pages, cpu_buffer->cpu))
		return -ENOMEM;

1018 1019 1020 1021 1022 1023 1024
	/*
	 * The ring buffer page list is a circular list that does not
	 * start and end with a list head. All page list items point to
	 * other pages.
	 */
	cpu_buffer->pages = pages.next;
	list_del(&pages);
S
Steven Rostedt 已提交
1025

1026 1027
	cpu_buffer->nr_pages = nr_pages;

S
Steven Rostedt 已提交
1028 1029 1030 1031 1032 1033
	rb_check_pages(cpu_buffer);

	return 0;
}

static struct ring_buffer_per_cpu *
1034
rb_allocate_cpu_buffer(struct ring_buffer *buffer, int nr_pages, int cpu)
S
Steven Rostedt 已提交
1035 1036
{
	struct ring_buffer_per_cpu *cpu_buffer;
1037
	struct buffer_page *bpage;
1038
	struct page *page;
S
Steven Rostedt 已提交
1039 1040 1041 1042 1043 1044 1045 1046 1047
	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;
1048
	raw_spin_lock_init(&cpu_buffer->reader_lock);
1049
	lockdep_set_class(&cpu_buffer->reader_lock, buffer->reader_lock_key);
1050
	cpu_buffer->lock = (arch_spinlock_t)__ARCH_SPIN_LOCK_UNLOCKED;
S
Steven Rostedt 已提交
1051

1052
	bpage = kzalloc_node(ALIGN(sizeof(*bpage), cache_line_size()),
1053
			    GFP_KERNEL, cpu_to_node(cpu));
1054
	if (!bpage)
1055 1056
		goto fail_free_buffer;

S
Steven Rostedt 已提交
1057 1058
	rb_check_bpage(cpu_buffer, bpage);

1059
	cpu_buffer->reader_page = bpage;
1060 1061
	page = alloc_pages_node(cpu_to_node(cpu), GFP_KERNEL, 0);
	if (!page)
1062
		goto fail_free_reader;
1063
	bpage->page = page_address(page);
1064
	rb_init_page(bpage->page);
1065

1066 1067
	INIT_LIST_HEAD(&cpu_buffer->reader_page->list);

1068
	ret = rb_allocate_pages(cpu_buffer, nr_pages);
S
Steven Rostedt 已提交
1069
	if (ret < 0)
1070
		goto fail_free_reader;
S
Steven Rostedt 已提交
1071 1072

	cpu_buffer->head_page
1073
		= list_entry(cpu_buffer->pages, struct buffer_page, list);
S
Steven Rostedt 已提交
1074
	cpu_buffer->tail_page = cpu_buffer->commit_page = cpu_buffer->head_page;
S
Steven Rostedt 已提交
1075

S
Steven Rostedt 已提交
1076 1077
	rb_head_page_activate(cpu_buffer);

S
Steven Rostedt 已提交
1078 1079
	return cpu_buffer;

1080 1081 1082
 fail_free_reader:
	free_buffer_page(cpu_buffer->reader_page);

S
Steven Rostedt 已提交
1083 1084 1085 1086 1087 1088 1089
 fail_free_buffer:
	kfree(cpu_buffer);
	return NULL;
}

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

1093 1094
	free_buffer_page(cpu_buffer->reader_page);

S
Steven Rostedt 已提交
1095 1096
	rb_head_page_deactivate(cpu_buffer);

1097 1098 1099 1100 1101 1102
	if (head) {
		list_for_each_entry_safe(bpage, tmp, head, list) {
			list_del_init(&bpage->list);
			free_buffer_page(bpage);
		}
		bpage = list_entry(head, struct buffer_page, list);
1103
		free_buffer_page(bpage);
S
Steven Rostedt 已提交
1104
	}
1105

S
Steven Rostedt 已提交
1106 1107 1108
	kfree(cpu_buffer);
}

1109
#ifdef CONFIG_HOTPLUG_CPU
1110 1111
static int rb_cpu_notify(struct notifier_block *self,
			 unsigned long action, void *hcpu);
1112 1113
#endif

S
Steven Rostedt 已提交
1114 1115
/**
 * ring_buffer_alloc - allocate a new ring_buffer
1116
 * @size: the size in bytes per cpu that is needed.
S
Steven Rostedt 已提交
1117 1118 1119 1120 1121 1122 1123
 * @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.
 */
1124 1125
struct ring_buffer *__ring_buffer_alloc(unsigned long size, unsigned flags,
					struct lock_class_key *key)
S
Steven Rostedt 已提交
1126 1127 1128
{
	struct ring_buffer *buffer;
	int bsize;
1129
	int cpu, nr_pages;
S
Steven Rostedt 已提交
1130 1131 1132 1133 1134 1135 1136

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

1137 1138 1139
	if (!alloc_cpumask_var(&buffer->cpumask, GFP_KERNEL))
		goto fail_free_buffer;

1140
	nr_pages = DIV_ROUND_UP(size, BUF_PAGE_SIZE);
S
Steven Rostedt 已提交
1141
	buffer->flags = flags;
1142
	buffer->clock = trace_clock_local;
1143
	buffer->reader_lock_key = key;
S
Steven Rostedt 已提交
1144 1145

	/* need at least two pages */
1146 1147
	if (nr_pages < 2)
		nr_pages = 2;
S
Steven Rostedt 已提交
1148

1149 1150 1151 1152 1153 1154
	/*
	 * 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
1155 1156
	get_online_cpus();
	cpumask_copy(buffer->cpumask, cpu_online_mask);
1157 1158 1159
#else
	cpumask_copy(buffer->cpumask, cpu_possible_mask);
#endif
S
Steven Rostedt 已提交
1160 1161 1162 1163 1164 1165
	buffer->cpus = nr_cpu_ids;

	bsize = sizeof(void *) * nr_cpu_ids;
	buffer->buffers = kzalloc(ALIGN(bsize, cache_line_size()),
				  GFP_KERNEL);
	if (!buffer->buffers)
1166
		goto fail_free_cpumask;
S
Steven Rostedt 已提交
1167 1168 1169

	for_each_buffer_cpu(buffer, cpu) {
		buffer->buffers[cpu] =
1170
			rb_allocate_cpu_buffer(buffer, nr_pages, cpu);
S
Steven Rostedt 已提交
1171 1172 1173 1174
		if (!buffer->buffers[cpu])
			goto fail_free_buffers;
	}

1175
#ifdef CONFIG_HOTPLUG_CPU
1176 1177 1178 1179 1180 1181
	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 已提交
1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192
	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);

1193 1194
 fail_free_cpumask:
	free_cpumask_var(buffer->cpumask);
1195
	put_online_cpus();
1196

S
Steven Rostedt 已提交
1197 1198 1199 1200
 fail_free_buffer:
	kfree(buffer);
	return NULL;
}
1201
EXPORT_SYMBOL_GPL(__ring_buffer_alloc);
S
Steven Rostedt 已提交
1202 1203 1204 1205 1206 1207 1208 1209 1210 1211

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

1212 1213
	get_online_cpus();

1214
#ifdef CONFIG_HOTPLUG_CPU
1215 1216 1217
	unregister_cpu_notifier(&buffer->cpu_notify);
#endif

S
Steven Rostedt 已提交
1218 1219 1220
	for_each_buffer_cpu(buffer, cpu)
		rb_free_cpu_buffer(buffer->buffers[cpu]);

1221 1222
	put_online_cpus();

1223
	kfree(buffer->buffers);
1224 1225
	free_cpumask_var(buffer->cpumask);

S
Steven Rostedt 已提交
1226 1227
	kfree(buffer);
}
1228
EXPORT_SYMBOL_GPL(ring_buffer_free);
S
Steven Rostedt 已提交
1229

1230 1231 1232 1233 1234 1235
void ring_buffer_set_clock(struct ring_buffer *buffer,
			   u64 (*clock)(void))
{
	buffer->clock = clock;
}

S
Steven Rostedt 已提交
1236 1237 1238 1239 1240
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)
{
1241
	struct buffer_page *bpage;
S
Steven Rostedt 已提交
1242 1243 1244
	struct list_head *p;
	unsigned i;

1245
	raw_spin_lock_irq(&cpu_buffer->reader_lock);
S
Steven Rostedt 已提交
1246 1247
	rb_head_page_deactivate(cpu_buffer);

S
Steven Rostedt 已提交
1248
	for (i = 0; i < nr_pages; i++) {
1249
		if (RB_WARN_ON(cpu_buffer, list_empty(cpu_buffer->pages)))
J
Julia Lawall 已提交
1250
			goto out;
1251
		p = cpu_buffer->pages->next;
1252 1253 1254
		bpage = list_entry(p, struct buffer_page, list);
		list_del_init(&bpage->list);
		free_buffer_page(bpage);
S
Steven Rostedt 已提交
1255
	}
1256
	if (RB_WARN_ON(cpu_buffer, list_empty(cpu_buffer->pages)))
J
Julia Lawall 已提交
1257
		goto out;
S
Steven Rostedt 已提交
1258 1259 1260 1261

	rb_reset_cpu(cpu_buffer);
	rb_check_pages(cpu_buffer);

J
Julia Lawall 已提交
1262
out:
1263
	raw_spin_unlock_irq(&cpu_buffer->reader_lock);
S
Steven Rostedt 已提交
1264 1265 1266 1267 1268 1269
}

static void
rb_insert_pages(struct ring_buffer_per_cpu *cpu_buffer,
		struct list_head *pages, unsigned nr_pages)
{
1270
	struct buffer_page *bpage;
S
Steven Rostedt 已提交
1271 1272 1273
	struct list_head *p;
	unsigned i;

1274
	raw_spin_lock_irq(&cpu_buffer->reader_lock);
S
Steven Rostedt 已提交
1275 1276
	rb_head_page_deactivate(cpu_buffer);

S
Steven Rostedt 已提交
1277
	for (i = 0; i < nr_pages; i++) {
S
Steven Rostedt 已提交
1278
		if (RB_WARN_ON(cpu_buffer, list_empty(pages)))
J
Julia Lawall 已提交
1279
			goto out;
S
Steven Rostedt 已提交
1280
		p = pages->next;
1281 1282
		bpage = list_entry(p, struct buffer_page, list);
		list_del_init(&bpage->list);
1283
		list_add_tail(&bpage->list, cpu_buffer->pages);
S
Steven Rostedt 已提交
1284 1285 1286 1287
	}
	rb_reset_cpu(cpu_buffer);
	rb_check_pages(cpu_buffer);

J
Julia Lawall 已提交
1288
out:
1289
	raw_spin_unlock_irq(&cpu_buffer->reader_lock);
S
Steven Rostedt 已提交
1290 1291
}

1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303
static void update_pages_handler(struct ring_buffer_per_cpu *cpu_buffer)
{
	if (cpu_buffer->nr_pages_to_update > 0)
		rb_insert_pages(cpu_buffer, &cpu_buffer->new_pages,
				cpu_buffer->nr_pages_to_update);
	else
		rb_remove_pages(cpu_buffer, -cpu_buffer->nr_pages_to_update);
	cpu_buffer->nr_pages += cpu_buffer->nr_pages_to_update;
	/* reset this value */
	cpu_buffer->nr_pages_to_update = 0;
}

S
Steven Rostedt 已提交
1304 1305 1306 1307 1308 1309 1310 1311 1312
/**
 * ring_buffer_resize - resize the ring buffer
 * @buffer: the buffer to resize.
 * @size: the new size.
 *
 * Minimum size is 2 * BUF_PAGE_SIZE.
 *
 * Returns -1 on failure.
 */
1313 1314
int ring_buffer_resize(struct ring_buffer *buffer, unsigned long size,
			int cpu_id)
S
Steven Rostedt 已提交
1315 1316
{
	struct ring_buffer_per_cpu *cpu_buffer;
1317 1318
	unsigned nr_pages;
	int cpu;
S
Steven Rostedt 已提交
1319

1320 1321 1322 1323 1324 1325
	/*
	 * Always succeed at resizing a non-existent buffer:
	 */
	if (!buffer)
		return size;

S
Steven Rostedt 已提交
1326 1327 1328 1329 1330 1331 1332
	size = DIV_ROUND_UP(size, BUF_PAGE_SIZE);
	size *= BUF_PAGE_SIZE;

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

1333 1334 1335 1336 1337
	atomic_inc(&buffer->record_disabled);

	/* Make sure all writers are done with this buffer. */
	synchronize_sched();

S
Steven Rostedt 已提交
1338
	mutex_lock(&buffer->mutex);
1339
	get_online_cpus();
S
Steven Rostedt 已提交
1340 1341 1342

	nr_pages = DIV_ROUND_UP(size, BUF_PAGE_SIZE);

1343 1344
	if (cpu_id == RING_BUFFER_ALL_CPUS) {
		/* calculate the pages to update */
S
Steven Rostedt 已提交
1345 1346 1347
		for_each_buffer_cpu(buffer, cpu) {
			cpu_buffer = buffer->buffers[cpu];

1348 1349
			cpu_buffer->nr_pages_to_update = nr_pages -
							cpu_buffer->nr_pages;
1350

1351 1352 1353 1354 1355
			/*
			 * nothing more to do for removing pages or no update
			 */
			if (cpu_buffer->nr_pages_to_update <= 0)
				continue;
S
Steven Rostedt 已提交
1356

1357
			/*
1358 1359
			 * to add pages, make sure all new pages can be
			 * allocated without receiving ENOMEM
1360
			 */
1361 1362 1363 1364 1365
			INIT_LIST_HEAD(&cpu_buffer->new_pages);
			if (__rb_allocate_pages(cpu_buffer->nr_pages_to_update,
						&cpu_buffer->new_pages, cpu))
				/* not enough memory for new pages */
				goto no_mem;
S
Steven Rostedt 已提交
1366 1367
		}

1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378
		/* wait for all the updates to complete */
		for_each_buffer_cpu(buffer, cpu) {
			cpu_buffer = buffer->buffers[cpu];
			if (cpu_buffer->nr_pages_to_update) {
				update_pages_handler(cpu_buffer);
			}
		}
	} else {
		cpu_buffer = buffer->buffers[cpu_id];
		if (nr_pages == cpu_buffer->nr_pages)
			goto out;
S
Steven Rostedt 已提交
1379

1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390
		cpu_buffer->nr_pages_to_update = nr_pages -
						cpu_buffer->nr_pages;

		INIT_LIST_HEAD(&cpu_buffer->new_pages);
		if (cpu_buffer->nr_pages_to_update > 0 &&
			__rb_allocate_pages(cpu_buffer->nr_pages_to_update,
						&cpu_buffer->new_pages, cpu_id))
			goto no_mem;

		update_pages_handler(cpu_buffer);
	}
S
Steven Rostedt 已提交
1391 1392

 out:
1393
	put_online_cpus();
S
Steven Rostedt 已提交
1394 1395
	mutex_unlock(&buffer->mutex);

1396 1397
	atomic_dec(&buffer->record_disabled);

S
Steven Rostedt 已提交
1398 1399
	return size;

1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412
 no_mem:
	for_each_buffer_cpu(buffer, cpu) {
		struct buffer_page *bpage, *tmp;
		cpu_buffer = buffer->buffers[cpu];
		/* reset this number regardless */
		cpu_buffer->nr_pages_to_update = 0;
		if (list_empty(&cpu_buffer->new_pages))
			continue;
		list_for_each_entry_safe(bpage, tmp, &cpu_buffer->new_pages,
					list) {
			list_del_init(&bpage->list);
			free_buffer_page(bpage);
		}
S
Steven Rostedt 已提交
1413
	}
1414
	put_online_cpus();
1415
	mutex_unlock(&buffer->mutex);
1416
	atomic_dec(&buffer->record_disabled);
S
Steven Rostedt 已提交
1417 1418
	return -ENOMEM;
}
1419
EXPORT_SYMBOL_GPL(ring_buffer_resize);
S
Steven Rostedt 已提交
1420

1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431
void ring_buffer_change_overwrite(struct ring_buffer *buffer, int val)
{
	mutex_lock(&buffer->mutex);
	if (val)
		buffer->flags |= RB_FL_OVERWRITE;
	else
		buffer->flags &= ~RB_FL_OVERWRITE;
	mutex_unlock(&buffer->mutex);
}
EXPORT_SYMBOL_GPL(ring_buffer_change_overwrite);

S
Steven Rostedt 已提交
1432
static inline void *
1433
__rb_data_page_index(struct buffer_data_page *bpage, unsigned index)
S
Steven Rostedt 已提交
1434
{
1435
	return bpage->data + index;
S
Steven Rostedt 已提交
1436 1437
}

1438
static inline void *__rb_page_index(struct buffer_page *bpage, unsigned index)
S
Steven Rostedt 已提交
1439
{
1440
	return bpage->page->data + index;
S
Steven Rostedt 已提交
1441 1442 1443
}

static inline struct ring_buffer_event *
1444
rb_reader_event(struct ring_buffer_per_cpu *cpu_buffer)
S
Steven Rostedt 已提交
1445
{
1446 1447 1448 1449
	return __rb_page_index(cpu_buffer->reader_page,
			       cpu_buffer->reader_page->read);
}

S
Steven Rostedt 已提交
1450 1451 1452
static inline struct ring_buffer_event *
rb_iter_head_event(struct ring_buffer_iter *iter)
{
1453
	return __rb_page_index(iter->head_page, iter->head);
S
Steven Rostedt 已提交
1454 1455
}

S
Steven Rostedt 已提交
1456
static inline unsigned long rb_page_write(struct buffer_page *bpage)
S
Steven Rostedt 已提交
1457
{
S
Steven Rostedt 已提交
1458
	return local_read(&bpage->write) & RB_WRITE_MASK;
S
Steven Rostedt 已提交
1459 1460 1461 1462
}

static inline unsigned rb_page_commit(struct buffer_page *bpage)
{
1463
	return local_read(&bpage->page->commit);
S
Steven Rostedt 已提交
1464 1465
}

S
Steven Rostedt 已提交
1466 1467 1468 1469 1470
static inline unsigned long rb_page_entries(struct buffer_page *bpage)
{
	return local_read(&bpage->entries) & RB_WRITE_MASK;
}

L
Lucas De Marchi 已提交
1471
/* Size is determined by what has been committed */
S
Steven Rostedt 已提交
1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487
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_event_index(struct ring_buffer_event *event)
{
	unsigned long addr = (unsigned long)event;

1488
	return (addr & ~PAGE_MASK) - BUF_PAGE_HDR_SIZE;
S
Steven Rostedt 已提交
1489 1490
}

1491
static inline int
1492 1493
rb_event_is_commit(struct ring_buffer_per_cpu *cpu_buffer,
		   struct ring_buffer_event *event)
S
Steven Rostedt 已提交
1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504
{
	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;
}

1505
static void
S
Steven Rostedt 已提交
1506
rb_set_commit_to_write(struct ring_buffer_per_cpu *cpu_buffer)
S
Steven Rostedt 已提交
1507
{
S
Steven Rostedt 已提交
1508 1509
	unsigned long max_count;

S
Steven Rostedt 已提交
1510 1511 1512 1513 1514 1515 1516 1517
	/*
	 * 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.
	 */
1518
 again:
1519
	max_count = cpu_buffer->nr_pages * 100;
S
Steven Rostedt 已提交
1520

S
Steven Rostedt 已提交
1521
	while (cpu_buffer->commit_page != cpu_buffer->tail_page) {
S
Steven Rostedt 已提交
1522 1523 1524 1525 1526 1527 1528
		if (RB_WARN_ON(cpu_buffer, !(--max_count)))
			return;
		if (RB_WARN_ON(cpu_buffer,
			       rb_is_reader_page(cpu_buffer->tail_page)))
			return;
		local_set(&cpu_buffer->commit_page->page->commit,
			  rb_page_write(cpu_buffer->commit_page));
S
Steven Rostedt 已提交
1529
		rb_inc_page(cpu_buffer, &cpu_buffer->commit_page);
1530 1531
		cpu_buffer->write_stamp =
			cpu_buffer->commit_page->page->time_stamp;
S
Steven Rostedt 已提交
1532 1533 1534 1535 1536
		/* add barrier to keep gcc from optimizing too much */
		barrier();
	}
	while (rb_commit_index(cpu_buffer) !=
	       rb_page_write(cpu_buffer->commit_page)) {
S
Steven Rostedt 已提交
1537 1538 1539 1540 1541 1542

		local_set(&cpu_buffer->commit_page->page->commit,
			  rb_page_write(cpu_buffer->commit_page));
		RB_WARN_ON(cpu_buffer,
			   local_read(&cpu_buffer->commit_page->page->commit) &
			   ~RB_WRITE_MASK);
S
Steven Rostedt 已提交
1543 1544
		barrier();
	}
1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555

	/* 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 已提交
1556 1557
}

1558
static void rb_reset_reader_page(struct ring_buffer_per_cpu *cpu_buffer)
S
Steven Rostedt 已提交
1559
{
1560
	cpu_buffer->read_stamp = cpu_buffer->reader_page->page->time_stamp;
1561
	cpu_buffer->reader_page->read = 0;
1562 1563
}

1564
static void rb_inc_iter(struct ring_buffer_iter *iter)
1565 1566 1567 1568 1569 1570 1571 1572 1573 1574
{
	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)
S
Steven Rostedt 已提交
1575
		iter->head_page = rb_set_head_page(cpu_buffer);
1576 1577 1578
	else
		rb_inc_page(cpu_buffer, &iter->head_page);

1579
	iter->read_stamp = iter->head_page->page->time_stamp;
S
Steven Rostedt 已提交
1580 1581 1582
	iter->head = 0;
}

1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601
/* Slow path, do not inline */
static noinline struct ring_buffer_event *
rb_add_time_stamp(struct ring_buffer_event *event, u64 delta)
{
	event->type_len = RINGBUF_TYPE_TIME_EXTEND;

	/* Not the first event on the page? */
	if (rb_event_index(event)) {
		event->time_delta = delta & TS_MASK;
		event->array[0] = delta >> TS_SHIFT;
	} else {
		/* nope, just zero it */
		event->time_delta = 0;
		event->array[0] = 0;
	}

	return skip_time_extend(event);
}

S
Steven Rostedt 已提交
1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612
/**
 * 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.
 */
1613
static void
1614 1615 1616
rb_update_event(struct ring_buffer_per_cpu *cpu_buffer,
		struct ring_buffer_event *event, unsigned length,
		int add_timestamp, u64 delta)
S
Steven Rostedt 已提交
1617
{
1618 1619 1620
	/* Only a commit updates the timestamp */
	if (unlikely(!rb_event_is_commit(cpu_buffer, event)))
		delta = 0;
S
Steven Rostedt 已提交
1621

1622 1623 1624 1625 1626 1627 1628 1629
	/*
	 * If we need to add a timestamp, then we
	 * add it to the start of the resevered space.
	 */
	if (unlikely(add_timestamp)) {
		event = rb_add_time_stamp(event, delta);
		length -= RB_LEN_TIME_EXTEND;
		delta = 0;
S
Steven Rostedt 已提交
1630
	}
1631 1632 1633 1634 1635 1636 1637 1638

	event->time_delta = delta;
	length -= RB_EVNT_HDR_SIZE;
	if (length > RB_MAX_SMALL_DATA || RB_FORCE_8BYTE_ALIGNMENT) {
		event->type_len = 0;
		event->array[0] = length;
	} else
		event->type_len = DIV_ROUND_UP(length, RB_ALIGNMENT);
S
Steven Rostedt 已提交
1639 1640
}

S
Steven Rostedt 已提交
1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686
/*
 * rb_handle_head_page - writer hit the head page
 *
 * Returns: +1 to retry page
 *           0 to continue
 *          -1 on error
 */
static int
rb_handle_head_page(struct ring_buffer_per_cpu *cpu_buffer,
		    struct buffer_page *tail_page,
		    struct buffer_page *next_page)
{
	struct buffer_page *new_head;
	int entries;
	int type;
	int ret;

	entries = rb_page_entries(next_page);

	/*
	 * The hard part is here. We need to move the head
	 * forward, and protect against both readers on
	 * other CPUs and writers coming in via interrupts.
	 */
	type = rb_head_page_set_update(cpu_buffer, next_page, tail_page,
				       RB_PAGE_HEAD);

	/*
	 * type can be one of four:
	 *  NORMAL - an interrupt already moved it for us
	 *  HEAD   - we are the first to get here.
	 *  UPDATE - we are the interrupt interrupting
	 *           a current move.
	 *  MOVED  - a reader on another CPU moved the next
	 *           pointer to its reader page. Give up
	 *           and try again.
	 */

	switch (type) {
	case RB_PAGE_HEAD:
		/*
		 * We changed the head to UPDATE, thus
		 * it is our responsibility to update
		 * the counters.
		 */
		local_add(entries, &cpu_buffer->overrun);
1687
		local_sub(BUF_PAGE_SIZE, &cpu_buffer->entries_bytes);
S
Steven Rostedt 已提交
1688 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 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798

		/*
		 * The entries will be zeroed out when we move the
		 * tail page.
		 */

		/* still more to do */
		break;

	case RB_PAGE_UPDATE:
		/*
		 * This is an interrupt that interrupt the
		 * previous update. Still more to do.
		 */
		break;
	case RB_PAGE_NORMAL:
		/*
		 * An interrupt came in before the update
		 * and processed this for us.
		 * Nothing left to do.
		 */
		return 1;
	case RB_PAGE_MOVED:
		/*
		 * The reader is on another CPU and just did
		 * a swap with our next_page.
		 * Try again.
		 */
		return 1;
	default:
		RB_WARN_ON(cpu_buffer, 1); /* WTF??? */
		return -1;
	}

	/*
	 * Now that we are here, the old head pointer is
	 * set to UPDATE. This will keep the reader from
	 * swapping the head page with the reader page.
	 * The reader (on another CPU) will spin till
	 * we are finished.
	 *
	 * We just need to protect against interrupts
	 * doing the job. We will set the next pointer
	 * to HEAD. After that, we set the old pointer
	 * to NORMAL, but only if it was HEAD before.
	 * otherwise we are an interrupt, and only
	 * want the outer most commit to reset it.
	 */
	new_head = next_page;
	rb_inc_page(cpu_buffer, &new_head);

	ret = rb_head_page_set_head(cpu_buffer, new_head, next_page,
				    RB_PAGE_NORMAL);

	/*
	 * Valid returns are:
	 *  HEAD   - an interrupt came in and already set it.
	 *  NORMAL - One of two things:
	 *            1) We really set it.
	 *            2) A bunch of interrupts came in and moved
	 *               the page forward again.
	 */
	switch (ret) {
	case RB_PAGE_HEAD:
	case RB_PAGE_NORMAL:
		/* OK */
		break;
	default:
		RB_WARN_ON(cpu_buffer, 1);
		return -1;
	}

	/*
	 * It is possible that an interrupt came in,
	 * set the head up, then more interrupts came in
	 * and moved it again. When we get back here,
	 * the page would have been set to NORMAL but we
	 * just set it back to HEAD.
	 *
	 * How do you detect this? Well, if that happened
	 * the tail page would have moved.
	 */
	if (ret == RB_PAGE_NORMAL) {
		/*
		 * If the tail had moved passed next, then we need
		 * to reset the pointer.
		 */
		if (cpu_buffer->tail_page != tail_page &&
		    cpu_buffer->tail_page != next_page)
			rb_head_page_set_normal(cpu_buffer, new_head,
						next_page,
						RB_PAGE_HEAD);
	}

	/*
	 * If this was the outer most commit (the one that
	 * changed the original pointer from HEAD to UPDATE),
	 * then it is up to us to reset it to NORMAL.
	 */
	if (type == RB_PAGE_HEAD) {
		ret = rb_head_page_set_normal(cpu_buffer, next_page,
					      tail_page,
					      RB_PAGE_UPDATE);
		if (RB_WARN_ON(cpu_buffer,
			       ret != RB_PAGE_UPDATE))
			return -1;
	}

	return 0;
}

1799
static unsigned rb_calculate_event_length(unsigned length)
S
Steven Rostedt 已提交
1800 1801 1802 1803 1804 1805 1806
{
	struct ring_buffer_event event; /* Used only for sizeof array */

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

1807
	if (length > RB_MAX_SMALL_DATA || RB_FORCE_8BYTE_ALIGNMENT)
S
Steven Rostedt 已提交
1808 1809 1810
		length += sizeof(event.array[0]);

	length += RB_EVNT_HDR_SIZE;
1811
	length = ALIGN(length, RB_ARCH_ALIGNMENT);
S
Steven Rostedt 已提交
1812 1813 1814 1815

	return length;
}

1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827
static inline void
rb_reset_tail(struct ring_buffer_per_cpu *cpu_buffer,
	      struct buffer_page *tail_page,
	      unsigned long tail, unsigned long length)
{
	struct ring_buffer_event *event;

	/*
	 * Only the event that crossed the page boundary
	 * must fill the old tail_page with padding.
	 */
	if (tail >= BUF_PAGE_SIZE) {
1828 1829 1830 1831 1832 1833 1834 1835
		/*
		 * If the page was filled, then we still need
		 * to update the real_end. Reset it to zero
		 * and the reader will ignore it.
		 */
		if (tail == BUF_PAGE_SIZE)
			tail_page->real_end = 0;

1836 1837 1838 1839 1840
		local_sub(length, &tail_page->write);
		return;
	}

	event = __rb_page_index(tail_page, tail);
1841
	kmemcheck_annotate_bitfield(event, bitfield);
1842

1843 1844 1845
	/* account for padding bytes */
	local_add(BUF_PAGE_SIZE - tail, &cpu_buffer->entries_bytes);

1846 1847 1848 1849 1850 1851 1852
	/*
	 * Save the original length to the meta data.
	 * This will be used by the reader to add lost event
	 * counter.
	 */
	tail_page->real_end = tail;

1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884
	/*
	 * If this event is bigger than the minimum size, then
	 * we need to be careful that we don't subtract the
	 * write counter enough to allow another writer to slip
	 * in on this page.
	 * We put in a discarded commit instead, to make sure
	 * that this space is not used again.
	 *
	 * If we are less than the minimum size, we don't need to
	 * worry about it.
	 */
	if (tail > (BUF_PAGE_SIZE - RB_EVNT_MIN_SIZE)) {
		/* No room for any events */

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

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

	/* Put in a discarded event */
	event->array[0] = (BUF_PAGE_SIZE - tail) - RB_EVNT_HDR_SIZE;
	event->type_len = RINGBUF_TYPE_PADDING;
	/* time delta must be non zero */
	event->time_delta = 1;

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

1886 1887 1888 1889
/*
 * This is the slow path, force gcc not to inline it.
 */
static noinline struct ring_buffer_event *
1890 1891
rb_move_tail(struct ring_buffer_per_cpu *cpu_buffer,
	     unsigned long length, unsigned long tail,
1892
	     struct buffer_page *tail_page, u64 ts)
S
Steven Rostedt 已提交
1893
{
1894
	struct buffer_page *commit_page = cpu_buffer->commit_page;
S
Steven Rostedt 已提交
1895
	struct ring_buffer *buffer = cpu_buffer->buffer;
S
Steven Rostedt 已提交
1896 1897
	struct buffer_page *next_page;
	int ret;
1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908

	next_page = tail_page;

	rb_inc_page(cpu_buffer, &next_page);

	/*
	 * 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)) {
S
Steven Rostedt 已提交
1909
		local_inc(&cpu_buffer->commit_overrun);
1910 1911 1912
		goto out_reset;
	}

S
Steven Rostedt 已提交
1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927
	/*
	 * This is where the fun begins!
	 *
	 * We are fighting against races between a reader that
	 * could be on another CPU trying to swap its reader
	 * page with the buffer head.
	 *
	 * We are also fighting against interrupts coming in and
	 * moving the head or tail on us as well.
	 *
	 * If the next page is the head page then we have filled
	 * the buffer, unless the commit page is still on the
	 * reader page.
	 */
	if (rb_is_head_page(cpu_buffer, next_page, &tail_page->list)) {
1928

S
Steven Rostedt 已提交
1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965
		/*
		 * If the commit is not on the reader page, then
		 * move the header page.
		 */
		if (!rb_is_reader_page(cpu_buffer->commit_page)) {
			/*
			 * If we are not in overwrite mode,
			 * this is easy, just stop here.
			 */
			if (!(buffer->flags & RB_FL_OVERWRITE))
				goto out_reset;

			ret = rb_handle_head_page(cpu_buffer,
						  tail_page,
						  next_page);
			if (ret < 0)
				goto out_reset;
			if (ret)
				goto out_again;
		} else {
			/*
			 * We need to be careful here too. The
			 * commit page could still be on the reader
			 * page. We could have a small buffer, and
			 * have filled up the buffer with events
			 * from interrupts and such, and wrapped.
			 *
			 * Note, if the tail page is also the on the
			 * reader_page, we let it move out.
			 */
			if (unlikely((cpu_buffer->commit_page !=
				      cpu_buffer->tail_page) &&
				     (cpu_buffer->commit_page ==
				      cpu_buffer->reader_page))) {
				local_inc(&cpu_buffer->commit_overrun);
				goto out_reset;
			}
1966 1967 1968
		}
	}

S
Steven Rostedt 已提交
1969 1970 1971 1972 1973 1974
	ret = rb_tail_page_update(cpu_buffer, tail_page, next_page);
	if (ret) {
		/*
		 * Nested commits always have zero deltas, so
		 * just reread the time stamp
		 */
1975 1976
		ts = rb_time_stamp(buffer);
		next_page->page->time_stamp = ts;
1977 1978
	}

S
Steven Rostedt 已提交
1979
 out_again:
1980

S
Steven Rostedt 已提交
1981
	rb_reset_tail(cpu_buffer, tail_page, tail, length);
1982 1983 1984 1985

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

1986
 out_reset:
1987
	/* reset write */
1988
	rb_reset_tail(cpu_buffer, tail_page, tail, length);
1989

S
Steven Rostedt 已提交
1990
	return NULL;
S
Steven Rostedt 已提交
1991 1992
}

1993 1994
static struct ring_buffer_event *
__rb_reserve_next(struct ring_buffer_per_cpu *cpu_buffer,
1995 1996
		  unsigned long length, u64 ts,
		  u64 delta, int add_timestamp)
1997
{
1998
	struct buffer_page *tail_page;
1999 2000 2001
	struct ring_buffer_event *event;
	unsigned long tail, write;

2002 2003 2004 2005 2006 2007 2008 2009
	/*
	 * If the time delta since the last event is too big to
	 * hold in the time field of the event, then we append a
	 * TIME EXTEND event ahead of the data event.
	 */
	if (unlikely(add_timestamp))
		length += RB_LEN_TIME_EXTEND;

2010 2011
	tail_page = cpu_buffer->tail_page;
	write = local_add_return(length, &tail_page->write);
S
Steven Rostedt 已提交
2012 2013 2014

	/* set write to only the index of the write */
	write &= RB_WRITE_MASK;
2015 2016 2017
	tail = write - length;

	/* See if we shot pass the end of this buffer page */
2018
	if (unlikely(write > BUF_PAGE_SIZE))
2019
		return rb_move_tail(cpu_buffer, length, tail,
2020
				    tail_page, ts);
2021 2022 2023 2024

	/* We reserved something on the buffer */

	event = __rb_page_index(tail_page, tail);
2025
	kmemcheck_annotate_bitfield(event, bitfield);
2026
	rb_update_event(cpu_buffer, event, length, add_timestamp, delta);
2027

2028
	local_inc(&tail_page->entries);
2029 2030

	/*
2031 2032
	 * If this is the first commit on the page, then update
	 * its timestamp.
2033
	 */
2034
	if (!tail)
2035
		tail_page->page->time_stamp = ts;
2036

2037 2038 2039
	/* account for these added bytes */
	local_add(length, &cpu_buffer->entries_bytes);

2040 2041 2042
	return event;
}

2043 2044 2045 2046 2047 2048 2049 2050 2051 2052
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);
2053
	old_index = new_index + rb_event_ts_length(event);
2054 2055 2056 2057 2058 2059
	addr = (unsigned long)event;
	addr &= PAGE_MASK;

	bpage = cpu_buffer->tail_page;

	if (bpage->page == (void *)addr && rb_page_write(bpage) == old_index) {
S
Steven Rostedt 已提交
2060 2061
		unsigned long write_mask =
			local_read(&bpage->write) & ~RB_WRITE_MASK;
2062
		unsigned long event_length = rb_event_length(event);
2063 2064 2065 2066 2067 2068
		/*
		 * 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.
		 */
S
Steven Rostedt 已提交
2069 2070
		old_index += write_mask;
		new_index += write_mask;
2071
		index = local_cmpxchg(&bpage->write, old_index, new_index);
2072 2073 2074
		if (index == old_index) {
			/* update counters */
			local_sub(event_length, &cpu_buffer->entries_bytes);
2075
			return 1;
2076
		}
2077 2078 2079 2080 2081 2082
	}

	/* could not discard */
	return 0;
}

2083 2084 2085 2086 2087 2088
static void rb_start_commit(struct ring_buffer_per_cpu *cpu_buffer)
{
	local_inc(&cpu_buffer->committing);
	local_inc(&cpu_buffer->commits);
}

2089
static inline void rb_end_commit(struct ring_buffer_per_cpu *cpu_buffer)
2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120
{
	unsigned long commits;

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

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

	local_dec(&cpu_buffer->committing);

	/* synchronize with interrupts */
	barrier();

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

S
Steven Rostedt 已提交
2121
static struct ring_buffer_event *
2122 2123
rb_reserve_next_event(struct ring_buffer *buffer,
		      struct ring_buffer_per_cpu *cpu_buffer,
2124
		      unsigned long length)
S
Steven Rostedt 已提交
2125 2126
{
	struct ring_buffer_event *event;
2127
	u64 ts, delta;
2128
	int nr_loops = 0;
2129
	int add_timestamp;
2130
	u64 diff;
S
Steven Rostedt 已提交
2131

2132 2133
	rb_start_commit(cpu_buffer);

2134
#ifdef CONFIG_RING_BUFFER_ALLOW_SWAP
2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146
	/*
	 * Due to the ability to swap a cpu buffer from a buffer
	 * it is possible it was swapped before we committed.
	 * (committing stops a swap). We check for it here and
	 * if it happened, we have to fail the write.
	 */
	barrier();
	if (unlikely(ACCESS_ONCE(cpu_buffer->buffer) != buffer)) {
		local_dec(&cpu_buffer->committing);
		local_dec(&cpu_buffer->commits);
		return NULL;
	}
2147
#endif
2148

2149
	length = rb_calculate_event_length(length);
S
Steven Rostedt 已提交
2150
 again:
2151 2152 2153
	add_timestamp = 0;
	delta = 0;

2154 2155 2156 2157 2158 2159 2160 2161 2162
	/*
	 * 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 已提交
2163
	if (RB_WARN_ON(cpu_buffer, ++nr_loops > 1000))
2164
		goto out_fail;
2165

2166
	ts = rb_time_stamp(cpu_buffer->buffer);
2167
	diff = ts - cpu_buffer->write_stamp;
S
Steven Rostedt 已提交
2168

2169 2170
	/* make sure this diff is calculated here */
	barrier();
S
Steven Rostedt 已提交
2171

2172 2173
	/* Did the write stamp get updated already? */
	if (likely(ts >= cpu_buffer->write_stamp)) {
2174 2175
		delta = diff;
		if (unlikely(test_time_stamp(delta))) {
2176 2177 2178 2179
			int local_clock_stable = 1;
#ifdef CONFIG_HAVE_UNSTABLE_SCHED_CLOCK
			local_clock_stable = sched_clock_stable;
#endif
2180
			WARN_ONCE(delta > (1ULL << 59),
2181
				  KERN_WARNING "Delta way too big! %llu ts=%llu write stamp = %llu\n%s",
2182 2183
				  (unsigned long long)delta,
				  (unsigned long long)ts,
2184 2185 2186 2187 2188
				  (unsigned long long)cpu_buffer->write_stamp,
				  local_clock_stable ? "" :
				  "If you just came from a suspend/resume,\n"
				  "please switch to the trace global clock:\n"
				  "  echo global > /sys/kernel/debug/tracing/trace_clock\n");
2189
			add_timestamp = 1;
S
Steven Rostedt 已提交
2190
		}
2191
	}
S
Steven Rostedt 已提交
2192

2193 2194
	event = __rb_reserve_next(cpu_buffer, length, ts,
				  delta, add_timestamp);
2195
	if (unlikely(PTR_ERR(event) == -EAGAIN))
S
Steven Rostedt 已提交
2196 2197
		goto again;

2198 2199
	if (!event)
		goto out_fail;
S
Steven Rostedt 已提交
2200 2201

	return event;
2202 2203 2204 2205

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

2208 2209
#ifdef CONFIG_TRACING

2210
#define TRACE_RECURSIVE_DEPTH 16
2211

2212 2213
/* Keep this code out of the fast path cache */
static noinline void trace_recursive_fail(void)
2214
{
2215 2216
	/* Disable all tracing before we do anything else */
	tracing_off_permanent();
2217

S
Steven Rostedt 已提交
2218
	printk_once(KERN_WARNING "Tracing recursion: depth[%ld]:"
2219
		    "HC[%lu]:SC[%lu]:NMI[%lu]\n",
2220
		    trace_recursion_buffer(),
2221 2222 2223
		    hardirq_count() >> HARDIRQ_SHIFT,
		    softirq_count() >> SOFTIRQ_SHIFT,
		    in_nmi());
2224

2225
	WARN_ON_ONCE(1);
2226 2227 2228 2229
}

static inline int trace_recursive_lock(void)
{
2230
	trace_recursion_inc();
2231

2232
	if (likely(trace_recursion_buffer() < TRACE_RECURSIVE_DEPTH))
2233 2234 2235 2236
		return 0;

	trace_recursive_fail();

2237
	return -1;
2238 2239
}

2240
static inline void trace_recursive_unlock(void)
2241
{
2242
	WARN_ON_ONCE(!trace_recursion_buffer());
2243

2244
	trace_recursion_dec();
2245 2246
}

2247 2248 2249 2250 2251 2252 2253
#else

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

#endif

S
Steven Rostedt 已提交
2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269
/**
 * 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 *
2270
ring_buffer_lock_reserve(struct ring_buffer *buffer, unsigned long length)
S
Steven Rostedt 已提交
2271 2272 2273
{
	struct ring_buffer_per_cpu *cpu_buffer;
	struct ring_buffer_event *event;
2274
	int cpu;
S
Steven Rostedt 已提交
2275

2276
	if (ring_buffer_flags != RB_BUFFERS_ON)
2277 2278
		return NULL;

S
Steven Rostedt 已提交
2279
	/* If we are tracing schedule, we don't want to recurse */
2280
	preempt_disable_notrace();
S
Steven Rostedt 已提交
2281

2282 2283 2284
	if (atomic_read(&buffer->record_disabled))
		goto out_nocheck;

2285 2286 2287
	if (trace_recursive_lock())
		goto out_nocheck;

S
Steven Rostedt 已提交
2288 2289
	cpu = raw_smp_processor_id();

2290
	if (!cpumask_test_cpu(cpu, buffer->cpumask))
2291
		goto out;
S
Steven Rostedt 已提交
2292 2293 2294 2295

	cpu_buffer = buffer->buffers[cpu];

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

2298
	if (length > BUF_MAX_DATA_SIZE)
S
Steven Rostedt 已提交
2299
		goto out;
S
Steven Rostedt 已提交
2300

2301
	event = rb_reserve_next_event(buffer, cpu_buffer, length);
S
Steven Rostedt 已提交
2302
	if (!event)
2303
		goto out;
S
Steven Rostedt 已提交
2304 2305 2306

	return event;

2307
 out:
2308 2309 2310
	trace_recursive_unlock();

 out_nocheck:
2311
	preempt_enable_notrace();
S
Steven Rostedt 已提交
2312 2313
	return NULL;
}
2314
EXPORT_SYMBOL_GPL(ring_buffer_lock_reserve);
S
Steven Rostedt 已提交
2315

2316 2317
static void
rb_update_write_stamp(struct ring_buffer_per_cpu *cpu_buffer,
S
Steven Rostedt 已提交
2318 2319
		      struct ring_buffer_event *event)
{
2320 2321
	u64 delta;

2322 2323 2324 2325
	/*
	 * The event first in the commit queue updates the
	 * time stamp.
	 */
2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341
	if (rb_event_is_commit(cpu_buffer, event)) {
		/*
		 * A commit event that is first on a page
		 * updates the write timestamp with the page stamp
		 */
		if (!rb_event_index(event))
			cpu_buffer->write_stamp =
				cpu_buffer->commit_page->page->time_stamp;
		else if (event->type_len == RINGBUF_TYPE_TIME_EXTEND) {
			delta = event->array[0];
			delta <<= TS_SHIFT;
			delta += event->time_delta;
			cpu_buffer->write_stamp += delta;
		} else
			cpu_buffer->write_stamp += event->time_delta;
	}
2342
}
S
Steven Rostedt 已提交
2343

2344 2345 2346 2347 2348
static void rb_commit(struct ring_buffer_per_cpu *cpu_buffer,
		      struct ring_buffer_event *event)
{
	local_inc(&cpu_buffer->entries);
	rb_update_write_stamp(cpu_buffer, event);
2349
	rb_end_commit(cpu_buffer);
S
Steven Rostedt 已提交
2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361
}

/**
 * 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,
2362
			      struct ring_buffer_event *event)
S
Steven Rostedt 已提交
2363 2364 2365 2366 2367 2368 2369 2370
{
	struct ring_buffer_per_cpu *cpu_buffer;
	int cpu = raw_smp_processor_id();

	cpu_buffer = buffer->buffers[cpu];

	rb_commit(cpu_buffer, event);

2371 2372
	trace_recursive_unlock();

2373
	preempt_enable_notrace();
S
Steven Rostedt 已提交
2374 2375 2376

	return 0;
}
2377
EXPORT_SYMBOL_GPL(ring_buffer_unlock_commit);
S
Steven Rostedt 已提交
2378

2379 2380
static inline void rb_event_discard(struct ring_buffer_event *event)
{
2381 2382 2383
	if (event->type_len == RINGBUF_TYPE_TIME_EXTEND)
		event = skip_time_extend(event);

2384 2385 2386
	/* 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;
2387 2388 2389 2390 2391
	/* time delta must be non zero */
	if (!event->time_delta)
		event->time_delta = 1;
}

2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 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
/*
 * Decrement the entries to the page that an event is on.
 * The event does not even need to exist, only the pointer
 * to the page it is on. This may only be called before the commit
 * takes place.
 */
static inline void
rb_decrement_entry(struct ring_buffer_per_cpu *cpu_buffer,
		   struct ring_buffer_event *event)
{
	unsigned long addr = (unsigned long)event;
	struct buffer_page *bpage = cpu_buffer->commit_page;
	struct buffer_page *start;

	addr &= PAGE_MASK;

	/* Do the likely case first */
	if (likely(bpage->page == (void *)addr)) {
		local_dec(&bpage->entries);
		return;
	}

	/*
	 * Because the commit page may be on the reader page we
	 * start with the next page and check the end loop there.
	 */
	rb_inc_page(cpu_buffer, &bpage);
	start = bpage;
	do {
		if (bpage->page == (void *)addr) {
			local_dec(&bpage->entries);
			return;
		}
		rb_inc_page(cpu_buffer, &bpage);
	} while (bpage != start);

	/* commit not part of this buffer?? */
	RB_WARN_ON(cpu_buffer, 1);
}

2432 2433 2434 2435 2436
/**
 * ring_buffer_commit_discard - discard an event that has not been committed
 * @buffer: the ring buffer
 * @event: non committed event to discard
 *
2437 2438 2439 2440 2441 2442
 * Sometimes an 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.
 *
 * This function only works if it is called before the the item has been
 * committed. It will try to free the event from the ring buffer
2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457
 * 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 */
2458
	rb_event_discard(event);
2459

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

2463 2464 2465 2466 2467
	/*
	 * This must only be called if the event has not been
	 * committed yet. Thus we can assume that preemption
	 * is still disabled.
	 */
2468
	RB_WARN_ON(buffer, !local_read(&cpu_buffer->committing));
2469

2470
	rb_decrement_entry(cpu_buffer, event);
2471
	if (rb_try_to_discard(cpu_buffer, event))
2472
		goto out;
2473 2474 2475

	/*
	 * The commit is still visible by the reader, so we
2476
	 * must still update the timestamp.
2477
	 */
2478
	rb_update_write_stamp(cpu_buffer, event);
2479
 out:
2480
	rb_end_commit(cpu_buffer);
2481

2482 2483
	trace_recursive_unlock();

2484
	preempt_enable_notrace();
2485 2486 2487 2488

}
EXPORT_SYMBOL_GPL(ring_buffer_discard_commit);

S
Steven Rostedt 已提交
2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509
/**
 * 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;
2510
	int cpu;
S
Steven Rostedt 已提交
2511

2512
	if (ring_buffer_flags != RB_BUFFERS_ON)
2513 2514
		return -EBUSY;

2515
	preempt_disable_notrace();
S
Steven Rostedt 已提交
2516

2517 2518 2519
	if (atomic_read(&buffer->record_disabled))
		goto out;

S
Steven Rostedt 已提交
2520 2521
	cpu = raw_smp_processor_id();

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

	cpu_buffer = buffer->buffers[cpu];

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

2530 2531 2532
	if (length > BUF_MAX_DATA_SIZE)
		goto out;

2533
	event = rb_reserve_next_event(buffer, cpu_buffer, length);
S
Steven Rostedt 已提交
2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544
	if (!event)
		goto out;

	body = rb_event_data(event);

	memcpy(body, data, length);

	rb_commit(cpu_buffer, event);

	ret = 0;
 out:
2545
	preempt_enable_notrace();
S
Steven Rostedt 已提交
2546 2547 2548

	return ret;
}
2549
EXPORT_SYMBOL_GPL(ring_buffer_write);
S
Steven Rostedt 已提交
2550

2551
static int rb_per_cpu_empty(struct ring_buffer_per_cpu *cpu_buffer)
S
Steven Rostedt 已提交
2552 2553
{
	struct buffer_page *reader = cpu_buffer->reader_page;
S
Steven Rostedt 已提交
2554
	struct buffer_page *head = rb_set_head_page(cpu_buffer);
S
Steven Rostedt 已提交
2555 2556
	struct buffer_page *commit = cpu_buffer->commit_page;

S
Steven Rostedt 已提交
2557 2558 2559 2560
	/* In case of error, head will be NULL */
	if (unlikely(!head))
		return 1;

S
Steven Rostedt 已提交
2561 2562 2563 2564 2565 2566
	return reader->read == rb_page_commit(reader) &&
		(commit == reader ||
		 (commit == head &&
		  head->read == rb_page_commit(commit)));
}

S
Steven Rostedt 已提交
2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579
/**
 * 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);
}
2580
EXPORT_SYMBOL_GPL(ring_buffer_record_disable);
S
Steven Rostedt 已提交
2581 2582 2583 2584 2585 2586

/**
 * 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
2587
 * to truly enable the writing (much like preempt_disable).
S
Steven Rostedt 已提交
2588 2589 2590 2591 2592
 */
void ring_buffer_record_enable(struct ring_buffer *buffer)
{
	atomic_dec(&buffer->record_disabled);
}
2593
EXPORT_SYMBOL_GPL(ring_buffer_record_enable);
S
Steven Rostedt 已提交
2594

2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651
/**
 * ring_buffer_record_off - 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.
 *
 * This is different than ring_buffer_record_disable() as
 * it works like an on/off switch, where as the disable() verison
 * must be paired with a enable().
 */
void ring_buffer_record_off(struct ring_buffer *buffer)
{
	unsigned int rd;
	unsigned int new_rd;

	do {
		rd = atomic_read(&buffer->record_disabled);
		new_rd = rd | RB_BUFFER_OFF;
	} while (atomic_cmpxchg(&buffer->record_disabled, rd, new_rd) != rd);
}
EXPORT_SYMBOL_GPL(ring_buffer_record_off);

/**
 * ring_buffer_record_on - restart writes into the buffer
 * @buffer: The ring buffer to start writes to.
 *
 * This enables all writes to the buffer that was disabled by
 * ring_buffer_record_off().
 *
 * This is different than ring_buffer_record_enable() as
 * it works like an on/off switch, where as the enable() verison
 * must be paired with a disable().
 */
void ring_buffer_record_on(struct ring_buffer *buffer)
{
	unsigned int rd;
	unsigned int new_rd;

	do {
		rd = atomic_read(&buffer->record_disabled);
		new_rd = rd & ~RB_BUFFER_OFF;
	} while (atomic_cmpxchg(&buffer->record_disabled, rd, new_rd) != rd);
}
EXPORT_SYMBOL_GPL(ring_buffer_record_on);

/**
 * ring_buffer_record_is_on - return true if the ring buffer can write
 * @buffer: The ring buffer to see if write is enabled
 *
 * Returns true if the ring buffer is in a state that it accepts writes.
 */
int ring_buffer_record_is_on(struct ring_buffer *buffer)
{
	return !atomic_read(&buffer->record_disabled);
}

S
Steven Rostedt 已提交
2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665
/**
 * 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;

2666
	if (!cpumask_test_cpu(cpu, buffer->cpumask))
2667
		return;
S
Steven Rostedt 已提交
2668 2669 2670 2671

	cpu_buffer = buffer->buffers[cpu];
	atomic_inc(&cpu_buffer->record_disabled);
}
2672
EXPORT_SYMBOL_GPL(ring_buffer_record_disable_cpu);
S
Steven Rostedt 已提交
2673 2674 2675 2676 2677 2678 2679

/**
 * 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
2680
 * to truly enable the writing (much like preempt_disable).
S
Steven Rostedt 已提交
2681 2682 2683 2684 2685
 */
void ring_buffer_record_enable_cpu(struct ring_buffer *buffer, int cpu)
{
	struct ring_buffer_per_cpu *cpu_buffer;

2686
	if (!cpumask_test_cpu(cpu, buffer->cpumask))
2687
		return;
S
Steven Rostedt 已提交
2688 2689 2690 2691

	cpu_buffer = buffer->buffers[cpu];
	atomic_dec(&cpu_buffer->record_disabled);
}
2692
EXPORT_SYMBOL_GPL(ring_buffer_record_enable_cpu);
S
Steven Rostedt 已提交
2693

2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706
/*
 * The total entries in the ring buffer is the running counter
 * of entries entered into the ring buffer, minus the sum of
 * the entries read from the ring buffer and the number of
 * entries that were overwritten.
 */
static inline unsigned long
rb_num_of_entries(struct ring_buffer_per_cpu *cpu_buffer)
{
	return local_read(&cpu_buffer->entries) -
		(local_read(&cpu_buffer->overrun) + cpu_buffer->read);
}

2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722
/**
 * ring_buffer_oldest_event_ts - get the oldest event timestamp from the buffer
 * @buffer: The ring buffer
 * @cpu: The per CPU buffer to read from.
 */
unsigned long ring_buffer_oldest_event_ts(struct ring_buffer *buffer, int cpu)
{
	unsigned long flags;
	struct ring_buffer_per_cpu *cpu_buffer;
	struct buffer_page *bpage;
	unsigned long ret;

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

	cpu_buffer = buffer->buffers[cpu];
2723
	raw_spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
2724 2725 2726 2727 2728 2729 2730 2731 2732
	/*
	 * if the tail is on reader_page, oldest time stamp is on the reader
	 * page
	 */
	if (cpu_buffer->tail_page == cpu_buffer->reader_page)
		bpage = cpu_buffer->reader_page;
	else
		bpage = rb_set_head_page(cpu_buffer);
	ret = bpage->page->time_stamp;
2733
	raw_spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758

	return ret;
}
EXPORT_SYMBOL_GPL(ring_buffer_oldest_event_ts);

/**
 * ring_buffer_bytes_cpu - get the number of bytes consumed in a cpu buffer
 * @buffer: The ring buffer
 * @cpu: The per CPU buffer to read from.
 */
unsigned long ring_buffer_bytes_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 = local_read(&cpu_buffer->entries_bytes) - cpu_buffer->read_bytes;

	return ret;
}
EXPORT_SYMBOL_GPL(ring_buffer_bytes_cpu);

S
Steven Rostedt 已提交
2759 2760 2761 2762 2763 2764 2765 2766 2767
/**
 * 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;

2768
	if (!cpumask_test_cpu(cpu, buffer->cpumask))
2769
		return 0;
S
Steven Rostedt 已提交
2770 2771

	cpu_buffer = buffer->buffers[cpu];
2772

2773
	return rb_num_of_entries(cpu_buffer);
S
Steven Rostedt 已提交
2774
}
2775
EXPORT_SYMBOL_GPL(ring_buffer_entries_cpu);
S
Steven Rostedt 已提交
2776 2777 2778 2779 2780 2781 2782 2783 2784

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

2787
	if (!cpumask_test_cpu(cpu, buffer->cpumask))
2788
		return 0;
S
Steven Rostedt 已提交
2789 2790

	cpu_buffer = buffer->buffers[cpu];
S
Steven Rostedt 已提交
2791
	ret = local_read(&cpu_buffer->overrun);
2792 2793

	return ret;
S
Steven Rostedt 已提交
2794
}
2795
EXPORT_SYMBOL_GPL(ring_buffer_overrun_cpu);
S
Steven Rostedt 已提交
2796

2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811
/**
 * 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];
S
Steven Rostedt 已提交
2812
	ret = local_read(&cpu_buffer->commit_overrun);
2813 2814 2815 2816 2817

	return ret;
}
EXPORT_SYMBOL_GPL(ring_buffer_commit_overrun_cpu);

S
Steven Rostedt 已提交
2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833
/**
 * 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];
2834
		entries += rb_num_of_entries(cpu_buffer);
S
Steven Rostedt 已提交
2835 2836 2837 2838
	}

	return entries;
}
2839
EXPORT_SYMBOL_GPL(ring_buffer_entries);
S
Steven Rostedt 已提交
2840 2841

/**
2842
 * ring_buffer_overruns - get the number of overruns in buffer
S
Steven Rostedt 已提交
2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856
 * @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];
S
Steven Rostedt 已提交
2857
		overruns += local_read(&cpu_buffer->overrun);
S
Steven Rostedt 已提交
2858 2859 2860 2861
	}

	return overruns;
}
2862
EXPORT_SYMBOL_GPL(ring_buffer_overruns);
S
Steven Rostedt 已提交
2863

2864
static void rb_iter_reset(struct ring_buffer_iter *iter)
S
Steven Rostedt 已提交
2865 2866 2867
{
	struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;

2868 2869
	/* Iterator usage is expected to have record disabled */
	if (list_empty(&cpu_buffer->reader_page->list)) {
S
Steven Rostedt 已提交
2870 2871 2872 2873
		iter->head_page = rb_set_head_page(cpu_buffer);
		if (unlikely(!iter->head_page))
			return;
		iter->head = iter->head_page->read;
2874 2875
	} else {
		iter->head_page = cpu_buffer->reader_page;
2876
		iter->head = cpu_buffer->reader_page->read;
2877 2878 2879 2880
	}
	if (iter->head)
		iter->read_stamp = cpu_buffer->read_stamp;
	else
2881
		iter->read_stamp = iter->head_page->page->time_stamp;
2882 2883
	iter->cache_reader_page = cpu_buffer->reader_page;
	iter->cache_read = cpu_buffer->read;
2884
}
S
Steven Rostedt 已提交
2885

2886 2887 2888 2889 2890 2891 2892 2893 2894
/**
 * 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)
{
2895
	struct ring_buffer_per_cpu *cpu_buffer;
2896 2897
	unsigned long flags;

2898 2899 2900 2901 2902
	if (!iter)
		return;

	cpu_buffer = iter->cpu_buffer;

2903
	raw_spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
2904
	rb_iter_reset(iter);
2905
	raw_spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
S
Steven Rostedt 已提交
2906
}
2907
EXPORT_SYMBOL_GPL(ring_buffer_iter_reset);
S
Steven Rostedt 已提交
2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918

/**
 * 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 已提交
2919 2920
	return iter->head_page == cpu_buffer->commit_page &&
		iter->head == rb_commit_index(cpu_buffer);
S
Steven Rostedt 已提交
2921
}
2922
EXPORT_SYMBOL_GPL(ring_buffer_iter_empty);
S
Steven Rostedt 已提交
2923 2924 2925 2926 2927 2928 2929

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

2930
	switch (event->type_len) {
S
Steven Rostedt 已提交
2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960
	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;

2961
	switch (event->type_len) {
S
Steven Rostedt 已提交
2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985
	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;
}

2986 2987
static struct buffer_page *
rb_get_reader_page(struct ring_buffer_per_cpu *cpu_buffer)
S
Steven Rostedt 已提交
2988
{
2989
	struct buffer_page *reader = NULL;
2990
	unsigned long overwrite;
2991
	unsigned long flags;
2992
	int nr_loops = 0;
S
Steven Rostedt 已提交
2993
	int ret;
2994

2995
	local_irq_save(flags);
2996
	arch_spin_lock(&cpu_buffer->lock);
2997 2998

 again:
2999 3000 3001 3002 3003 3004
	/*
	 * 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 已提交
3005
	if (RB_WARN_ON(cpu_buffer, ++nr_loops > 3)) {
3006 3007 3008 3009
		reader = NULL;
		goto out;
	}

3010 3011 3012
	reader = cpu_buffer->reader_page;

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

	/* Never should we have an index greater than the size */
S
Steven Rostedt 已提交
3017 3018 3019
	if (RB_WARN_ON(cpu_buffer,
		       cpu_buffer->reader_page->read > rb_page_size(reader)))
		goto out;
3020 3021 3022

	/* check if we caught up to the tail */
	reader = NULL;
S
Steven Rostedt 已提交
3023
	if (cpu_buffer->commit_page == cpu_buffer->reader_page)
3024
		goto out;
S
Steven Rostedt 已提交
3025 3026

	/*
3027
	 * Reset the reader page to size zero.
S
Steven Rostedt 已提交
3028
	 */
S
Steven Rostedt 已提交
3029 3030 3031
	local_set(&cpu_buffer->reader_page->write, 0);
	local_set(&cpu_buffer->reader_page->entries, 0);
	local_set(&cpu_buffer->reader_page->page->commit, 0);
3032
	cpu_buffer->reader_page->real_end = 0;
S
Steven Rostedt 已提交
3033

S
Steven Rostedt 已提交
3034 3035 3036 3037 3038
 spin:
	/*
	 * Splice the empty reader page into the list around the head.
	 */
	reader = rb_set_head_page(cpu_buffer);
3039
	cpu_buffer->reader_page->list.next = rb_list_head(reader->list.next);
3040
	cpu_buffer->reader_page->list.prev = reader->list.prev;
S
Steven Rostedt 已提交
3041

3042 3043 3044
	/*
	 * cpu_buffer->pages just needs to point to the buffer, it
	 *  has no specific buffer page to point to. Lets move it out
L
Lucas De Marchi 已提交
3045
	 *  of our way so we don't accidentally swap it.
3046 3047 3048
	 */
	cpu_buffer->pages = reader->list.prev;

S
Steven Rostedt 已提交
3049 3050
	/* The reader page will be pointing to the new head */
	rb_set_list_to_head(cpu_buffer, &cpu_buffer->reader_page->list);
S
Steven Rostedt 已提交
3051

3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063
	/*
	 * We want to make sure we read the overruns after we set up our
	 * pointers to the next object. The writer side does a
	 * cmpxchg to cross pages which acts as the mb on the writer
	 * side. Note, the reader will constantly fail the swap
	 * while the writer is updating the pointers, so this
	 * guarantees that the overwrite recorded here is the one we
	 * want to compare with the last_overrun.
	 */
	smp_mb();
	overwrite = local_read(&(cpu_buffer->overrun));

S
Steven Rostedt 已提交
3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075
	/*
	 * Here's the tricky part.
	 *
	 * We need to move the pointer past the header page.
	 * But we can only do that if a writer is not currently
	 * moving it. The page before the header page has the
	 * flag bit '1' set if it is pointing to the page we want.
	 * but if the writer is in the process of moving it
	 * than it will be '2' or already moved '0'.
	 */

	ret = rb_head_page_replace(reader, cpu_buffer->reader_page);
S
Steven Rostedt 已提交
3076 3077

	/*
S
Steven Rostedt 已提交
3078
	 * If we did not convert it, then we must try again.
S
Steven Rostedt 已提交
3079
	 */
S
Steven Rostedt 已提交
3080 3081
	if (!ret)
		goto spin;
S
Steven Rostedt 已提交
3082

S
Steven Rostedt 已提交
3083 3084 3085 3086 3087
	/*
	 * Yeah! We succeeded in replacing the page.
	 *
	 * Now make the new head point back to the reader page.
	 */
3088
	rb_list_head(reader->list.next)->prev = &cpu_buffer->reader_page->list;
S
Steven Rostedt 已提交
3089
	rb_inc_page(cpu_buffer, &cpu_buffer->head_page);
3090 3091 3092 3093 3094

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

3095 3096 3097 3098 3099
	if (overwrite != cpu_buffer->last_overrun) {
		cpu_buffer->lost_events = overwrite - cpu_buffer->last_overrun;
		cpu_buffer->last_overrun = overwrite;
	}

3100 3101 3102
	goto again;

 out:
3103
	arch_spin_unlock(&cpu_buffer->lock);
3104
	local_irq_restore(flags);
3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115

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

3117
	/* This function should not be called when buffer is empty */
S
Steven Rostedt 已提交
3118 3119
	if (RB_WARN_ON(cpu_buffer, !reader))
		return;
S
Steven Rostedt 已提交
3120

3121 3122
	event = rb_reader_event(cpu_buffer);

3123
	if (event->type_len <= RINGBUF_TYPE_DATA_TYPE_LEN_MAX)
3124
		cpu_buffer->read++;
3125 3126 3127 3128

	rb_update_read_stamp(cpu_buffer, event);

	length = rb_event_length(event);
3129
	cpu_buffer->reader_page->read += length;
S
Steven Rostedt 已提交
3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142
}

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

	cpu_buffer = iter->cpu_buffer;

	/*
	 * Check if we are at the end of the buffer.
	 */
S
Steven Rostedt 已提交
3143
	if (iter->head >= rb_page_size(iter->head_page)) {
3144 3145
		/* discarded commits can make the page empty */
		if (iter->head_page == cpu_buffer->commit_page)
S
Steven Rostedt 已提交
3146
			return;
3147
		rb_inc_iter(iter);
S
Steven Rostedt 已提交
3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158
		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 已提交
3159
	if (RB_WARN_ON(cpu_buffer,
3160
		       (iter->head_page == cpu_buffer->commit_page) &&
S
Steven Rostedt 已提交
3161 3162
		       (iter->head + length > rb_commit_index(cpu_buffer))))
		return;
S
Steven Rostedt 已提交
3163 3164 3165 3166 3167 3168

	rb_update_iter_read_stamp(iter, event);

	iter->head += length;

	/* check for end of page padding */
S
Steven Rostedt 已提交
3169 3170
	if ((iter->head >= rb_page_size(iter->head_page)) &&
	    (iter->head_page != cpu_buffer->commit_page))
S
Steven Rostedt 已提交
3171 3172 3173
		rb_advance_iter(iter);
}

3174 3175 3176 3177 3178
static int rb_lost_events(struct ring_buffer_per_cpu *cpu_buffer)
{
	return cpu_buffer->lost_events;
}

S
Steven Rostedt 已提交
3179
static struct ring_buffer_event *
3180 3181
rb_buffer_peek(struct ring_buffer_per_cpu *cpu_buffer, u64 *ts,
	       unsigned long *lost_events)
S
Steven Rostedt 已提交
3182 3183
{
	struct ring_buffer_event *event;
3184
	struct buffer_page *reader;
3185
	int nr_loops = 0;
S
Steven Rostedt 已提交
3186 3187

 again:
3188
	/*
3189 3190 3191 3192
	 * We repeat when a time extend is encountered.
	 * Since the time extend is always attached to a data event,
	 * we should never loop more than once.
	 * (We never hit the following condition more than twice).
3193
	 */
3194
	if (RB_WARN_ON(cpu_buffer, ++nr_loops > 2))
3195 3196
		return NULL;

3197 3198
	reader = rb_get_reader_page(cpu_buffer);
	if (!reader)
S
Steven Rostedt 已提交
3199 3200
		return NULL;

3201
	event = rb_reader_event(cpu_buffer);
S
Steven Rostedt 已提交
3202

3203
	switch (event->type_len) {
S
Steven Rostedt 已提交
3204
	case RINGBUF_TYPE_PADDING:
3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215
		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.
		 */
		return event;
S
Steven Rostedt 已提交
3216 3217 3218

	case RINGBUF_TYPE_TIME_EXTEND:
		/* Internal data, OK to advance */
3219
		rb_advance_reader(cpu_buffer);
S
Steven Rostedt 已提交
3220 3221 3222 3223
		goto again;

	case RINGBUF_TYPE_TIME_STAMP:
		/* FIXME: not implemented */
3224
		rb_advance_reader(cpu_buffer);
S
Steven Rostedt 已提交
3225 3226 3227 3228 3229
		goto again;

	case RINGBUF_TYPE_DATA:
		if (ts) {
			*ts = cpu_buffer->read_stamp + event->time_delta;
3230
			ring_buffer_normalize_time_stamp(cpu_buffer->buffer,
3231
							 cpu_buffer->cpu, ts);
S
Steven Rostedt 已提交
3232
		}
3233 3234
		if (lost_events)
			*lost_events = rb_lost_events(cpu_buffer);
S
Steven Rostedt 已提交
3235 3236 3237 3238 3239 3240 3241 3242
		return event;

	default:
		BUG();
	}

	return NULL;
}
3243
EXPORT_SYMBOL_GPL(ring_buffer_peek);
S
Steven Rostedt 已提交
3244

S
Steven Rostedt 已提交
3245 3246
static struct ring_buffer_event *
rb_iter_peek(struct ring_buffer_iter *iter, u64 *ts)
S
Steven Rostedt 已提交
3247 3248 3249 3250
{
	struct ring_buffer *buffer;
	struct ring_buffer_per_cpu *cpu_buffer;
	struct ring_buffer_event *event;
3251
	int nr_loops = 0;
S
Steven Rostedt 已提交
3252 3253 3254 3255

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

3256 3257 3258 3259 3260 3261 3262 3263 3264
	/*
	 * Check if someone performed a consuming read to
	 * the buffer. A consuming read invalidates the iterator
	 * and we need to reset the iterator in this case.
	 */
	if (unlikely(iter->cache_read != cpu_buffer->read ||
		     iter->cache_reader_page != cpu_buffer->reader_page))
		rb_iter_reset(iter);

S
Steven Rostedt 已提交
3265
 again:
3266 3267 3268
	if (ring_buffer_iter_empty(iter))
		return NULL;

3269
	/*
3270 3271 3272 3273
	 * We repeat when a time extend is encountered.
	 * Since the time extend is always attached to a data event,
	 * we should never loop more than once.
	 * (We never hit the following condition more than twice).
3274
	 */
3275
	if (RB_WARN_ON(cpu_buffer, ++nr_loops > 2))
3276 3277
		return NULL;

S
Steven Rostedt 已提交
3278 3279 3280
	if (rb_per_cpu_empty(cpu_buffer))
		return NULL;

3281 3282 3283 3284 3285
	if (iter->head >= local_read(&iter->head_page->page->commit)) {
		rb_inc_iter(iter);
		goto again;
	}

S
Steven Rostedt 已提交
3286 3287
	event = rb_iter_head_event(iter);

3288
	switch (event->type_len) {
S
Steven Rostedt 已提交
3289
	case RINGBUF_TYPE_PADDING:
3290 3291 3292 3293 3294 3295
		if (rb_null_event(event)) {
			rb_inc_iter(iter);
			goto again;
		}
		rb_advance_iter(iter);
		return event;
S
Steven Rostedt 已提交
3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309

	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;
3310 3311
			ring_buffer_normalize_time_stamp(buffer,
							 cpu_buffer->cpu, ts);
S
Steven Rostedt 已提交
3312 3313 3314 3315 3316 3317 3318 3319 3320
		}
		return event;

	default:
		BUG();
	}

	return NULL;
}
3321
EXPORT_SYMBOL_GPL(ring_buffer_iter_peek);
S
Steven Rostedt 已提交
3322

3323 3324 3325 3326 3327 3328 3329 3330
static inline int rb_ok_to_lock(void)
{
	/*
	 * If an NMI die dumps out the content of the ring buffer
	 * do not grab locks. We also permanently disable the ring
	 * buffer too. A one time deal is all you get from reading
	 * the ring buffer from an NMI.
	 */
3331
	if (likely(!in_nmi()))
3332 3333 3334 3335 3336 3337
		return 1;

	tracing_off_permanent();
	return 0;
}

S
Steven Rostedt 已提交
3338 3339 3340 3341 3342
/**
 * 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.
3343
 * @lost_events: a variable to store if events were lost (may be NULL)
S
Steven Rostedt 已提交
3344 3345 3346 3347 3348
 *
 * This will return the event that will be read next, but does
 * not consume the data.
 */
struct ring_buffer_event *
3349 3350
ring_buffer_peek(struct ring_buffer *buffer, int cpu, u64 *ts,
		 unsigned long *lost_events)
S
Steven Rostedt 已提交
3351 3352
{
	struct ring_buffer_per_cpu *cpu_buffer = buffer->buffers[cpu];
3353
	struct ring_buffer_event *event;
S
Steven Rostedt 已提交
3354
	unsigned long flags;
3355
	int dolock;
S
Steven Rostedt 已提交
3356

3357
	if (!cpumask_test_cpu(cpu, buffer->cpumask))
3358
		return NULL;
3359

3360
	dolock = rb_ok_to_lock();
3361
 again:
3362 3363
	local_irq_save(flags);
	if (dolock)
3364
		raw_spin_lock(&cpu_buffer->reader_lock);
3365
	event = rb_buffer_peek(cpu_buffer, ts, lost_events);
3366 3367
	if (event && event->type_len == RINGBUF_TYPE_PADDING)
		rb_advance_reader(cpu_buffer);
3368
	if (dolock)
3369
		raw_spin_unlock(&cpu_buffer->reader_lock);
3370
	local_irq_restore(flags);
S
Steven Rostedt 已提交
3371

3372
	if (event && event->type_len == RINGBUF_TYPE_PADDING)
3373 3374
		goto again;

S
Steven Rostedt 已提交
3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392
	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;

3393
 again:
3394
	raw_spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
S
Steven Rostedt 已提交
3395
	event = rb_iter_peek(iter, ts);
3396
	raw_spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
S
Steven Rostedt 已提交
3397

3398
	if (event && event->type_len == RINGBUF_TYPE_PADDING)
3399 3400
		goto again;

S
Steven Rostedt 已提交
3401 3402 3403
	return event;
}

S
Steven Rostedt 已提交
3404 3405 3406
/**
 * ring_buffer_consume - return an event and consume it
 * @buffer: The ring buffer to get the next event from
3407 3408 3409
 * @cpu: the cpu to read the buffer from
 * @ts: a variable to store the timestamp (may be NULL)
 * @lost_events: a variable to store if events were lost (may be NULL)
S
Steven Rostedt 已提交
3410 3411 3412 3413 3414 3415
 *
 * 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 *
3416 3417
ring_buffer_consume(struct ring_buffer *buffer, int cpu, u64 *ts,
		    unsigned long *lost_events)
S
Steven Rostedt 已提交
3418
{
3419 3420
	struct ring_buffer_per_cpu *cpu_buffer;
	struct ring_buffer_event *event = NULL;
S
Steven Rostedt 已提交
3421
	unsigned long flags;
3422 3423 3424
	int dolock;

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

3426
 again:
3427 3428 3429
	/* might be called in atomic */
	preempt_disable();

3430
	if (!cpumask_test_cpu(cpu, buffer->cpumask))
3431
		goto out;
S
Steven Rostedt 已提交
3432

3433
	cpu_buffer = buffer->buffers[cpu];
3434 3435
	local_irq_save(flags);
	if (dolock)
3436
		raw_spin_lock(&cpu_buffer->reader_lock);
S
Steven Rostedt 已提交
3437

3438 3439 3440
	event = rb_buffer_peek(cpu_buffer, ts, lost_events);
	if (event) {
		cpu_buffer->lost_events = 0;
3441
		rb_advance_reader(cpu_buffer);
3442
	}
S
Steven Rostedt 已提交
3443

3444
	if (dolock)
3445
		raw_spin_unlock(&cpu_buffer->reader_lock);
3446
	local_irq_restore(flags);
S
Steven Rostedt 已提交
3447

3448 3449 3450
 out:
	preempt_enable();

3451
	if (event && event->type_len == RINGBUF_TYPE_PADDING)
3452 3453
		goto again;

S
Steven Rostedt 已提交
3454 3455
	return event;
}
3456
EXPORT_SYMBOL_GPL(ring_buffer_consume);
S
Steven Rostedt 已提交
3457 3458

/**
3459
 * ring_buffer_read_prepare - Prepare for a non consuming read of the buffer
S
Steven Rostedt 已提交
3460 3461 3462
 * @buffer: The ring buffer to read from
 * @cpu: The cpu buffer to iterate over
 *
3463 3464 3465
 * This performs the initial preparations necessary to iterate
 * through the buffer.  Memory is allocated, buffer recording
 * is disabled, and the iterator pointer is returned to the caller.
S
Steven Rostedt 已提交
3466
 *
3467 3468 3469 3470 3471 3472 3473 3474 3475 3476
 * Disabling buffer recordng prevents the reading from being
 * corrupted. This is not a consuming read, so a producer is not
 * expected.
 *
 * After a sequence of ring_buffer_read_prepare calls, the user is
 * expected to make at least one call to ring_buffer_prepare_sync.
 * Afterwards, ring_buffer_read_start is invoked to get things going
 * for real.
 *
 * This overall must be paired with ring_buffer_finish.
S
Steven Rostedt 已提交
3477 3478
 */
struct ring_buffer_iter *
3479
ring_buffer_read_prepare(struct ring_buffer *buffer, int cpu)
S
Steven Rostedt 已提交
3480 3481
{
	struct ring_buffer_per_cpu *cpu_buffer;
3482
	struct ring_buffer_iter *iter;
S
Steven Rostedt 已提交
3483

3484
	if (!cpumask_test_cpu(cpu, buffer->cpumask))
3485
		return NULL;
S
Steven Rostedt 已提交
3486 3487 3488

	iter = kmalloc(sizeof(*iter), GFP_KERNEL);
	if (!iter)
3489
		return NULL;
S
Steven Rostedt 已提交
3490 3491 3492 3493 3494 3495

	cpu_buffer = buffer->buffers[cpu];

	iter->cpu_buffer = cpu_buffer;

	atomic_inc(&cpu_buffer->record_disabled);
3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510

	return iter;
}
EXPORT_SYMBOL_GPL(ring_buffer_read_prepare);

/**
 * ring_buffer_read_prepare_sync - Synchronize a set of prepare calls
 *
 * All previously invoked ring_buffer_read_prepare calls to prepare
 * iterators will be synchronized.  Afterwards, read_buffer_read_start
 * calls on those iterators are allowed.
 */
void
ring_buffer_read_prepare_sync(void)
{
S
Steven Rostedt 已提交
3511
	synchronize_sched();
3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535
}
EXPORT_SYMBOL_GPL(ring_buffer_read_prepare_sync);

/**
 * ring_buffer_read_start - start a non consuming read of the buffer
 * @iter: The iterator returned by ring_buffer_read_prepare
 *
 * This finalizes the startup of an iteration through the buffer.
 * The iterator comes from a call to ring_buffer_read_prepare and
 * an intervening ring_buffer_read_prepare_sync must have been
 * performed.
 *
 * Must be paired with ring_buffer_finish.
 */
void
ring_buffer_read_start(struct ring_buffer_iter *iter)
{
	struct ring_buffer_per_cpu *cpu_buffer;
	unsigned long flags;

	if (!iter)
		return;

	cpu_buffer = iter->cpu_buffer;
S
Steven Rostedt 已提交
3536

3537
	raw_spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
3538
	arch_spin_lock(&cpu_buffer->lock);
3539
	rb_iter_reset(iter);
3540
	arch_spin_unlock(&cpu_buffer->lock);
3541
	raw_spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
S
Steven Rostedt 已提交
3542
}
3543
EXPORT_SYMBOL_GPL(ring_buffer_read_start);
S
Steven Rostedt 已提交
3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559

/**
 * 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);
}
3560
EXPORT_SYMBOL_GPL(ring_buffer_read_finish);
S
Steven Rostedt 已提交
3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572

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

3576
	raw_spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
3577
 again:
S
Steven Rostedt 已提交
3578
	event = rb_iter_peek(iter, ts);
S
Steven Rostedt 已提交
3579
	if (!event)
S
Steven Rostedt 已提交
3580
		goto out;
S
Steven Rostedt 已提交
3581

3582 3583 3584
	if (event->type_len == RINGBUF_TYPE_PADDING)
		goto again;

S
Steven Rostedt 已提交
3585
	rb_advance_iter(iter);
S
Steven Rostedt 已提交
3586
 out:
3587
	raw_spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
S
Steven Rostedt 已提交
3588 3589 3590

	return event;
}
3591
EXPORT_SYMBOL_GPL(ring_buffer_read);
S
Steven Rostedt 已提交
3592 3593 3594 3595 3596

/**
 * ring_buffer_size - return the size of the ring buffer (in bytes)
 * @buffer: The ring buffer.
 */
3597
unsigned long ring_buffer_size(struct ring_buffer *buffer, int cpu)
S
Steven Rostedt 已提交
3598
{
3599 3600 3601 3602 3603 3604 3605 3606 3607 3608
	/*
	 * Earlier, this method returned
	 *	BUF_PAGE_SIZE * buffer->nr_pages
	 * Since the nr_pages field is now removed, we have converted this to
	 * return the per cpu buffer value.
	 */
	if (!cpumask_test_cpu(cpu, buffer->cpumask))
		return 0;

	return BUF_PAGE_SIZE * buffer->buffers[cpu]->nr_pages;
S
Steven Rostedt 已提交
3609
}
3610
EXPORT_SYMBOL_GPL(ring_buffer_size);
S
Steven Rostedt 已提交
3611 3612 3613 3614

static void
rb_reset_cpu(struct ring_buffer_per_cpu *cpu_buffer)
{
S
Steven Rostedt 已提交
3615 3616
	rb_head_page_deactivate(cpu_buffer);

S
Steven Rostedt 已提交
3617
	cpu_buffer->head_page
3618
		= list_entry(cpu_buffer->pages, struct buffer_page, list);
S
Steven Rostedt 已提交
3619
	local_set(&cpu_buffer->head_page->write, 0);
3620
	local_set(&cpu_buffer->head_page->entries, 0);
3621
	local_set(&cpu_buffer->head_page->page->commit, 0);
3622

3623
	cpu_buffer->head_page->read = 0;
S
Steven Rostedt 已提交
3624 3625 3626 3627 3628 3629

	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);
3630
	local_set(&cpu_buffer->reader_page->entries, 0);
3631
	local_set(&cpu_buffer->reader_page->page->commit, 0);
3632
	cpu_buffer->reader_page->read = 0;
S
Steven Rostedt 已提交
3633

S
Steven Rostedt 已提交
3634
	local_set(&cpu_buffer->commit_overrun, 0);
3635
	local_set(&cpu_buffer->entries_bytes, 0);
S
Steven Rostedt 已提交
3636
	local_set(&cpu_buffer->overrun, 0);
3637
	local_set(&cpu_buffer->entries, 0);
3638 3639
	local_set(&cpu_buffer->committing, 0);
	local_set(&cpu_buffer->commits, 0);
S
Steven Rostedt 已提交
3640
	cpu_buffer->read = 0;
3641
	cpu_buffer->read_bytes = 0;
3642 3643 3644

	cpu_buffer->write_stamp = 0;
	cpu_buffer->read_stamp = 0;
S
Steven Rostedt 已提交
3645

3646 3647 3648
	cpu_buffer->lost_events = 0;
	cpu_buffer->last_overrun = 0;

S
Steven Rostedt 已提交
3649
	rb_head_page_activate(cpu_buffer);
S
Steven Rostedt 已提交
3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661
}

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

3662
	if (!cpumask_test_cpu(cpu, buffer->cpumask))
3663
		return;
S
Steven Rostedt 已提交
3664

3665 3666
	atomic_inc(&cpu_buffer->record_disabled);

3667
	raw_spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
S
Steven Rostedt 已提交
3668

3669 3670 3671
	if (RB_WARN_ON(cpu_buffer, local_read(&cpu_buffer->committing)))
		goto out;

3672
	arch_spin_lock(&cpu_buffer->lock);
S
Steven Rostedt 已提交
3673 3674 3675

	rb_reset_cpu(cpu_buffer);

3676
	arch_spin_unlock(&cpu_buffer->lock);
S
Steven Rostedt 已提交
3677

3678
 out:
3679
	raw_spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
3680 3681

	atomic_dec(&cpu_buffer->record_disabled);
S
Steven Rostedt 已提交
3682
}
3683
EXPORT_SYMBOL_GPL(ring_buffer_reset_cpu);
S
Steven Rostedt 已提交
3684 3685 3686 3687 3688 3689 3690 3691 3692 3693

/**
 * 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)
3694
		ring_buffer_reset_cpu(buffer, cpu);
S
Steven Rostedt 已提交
3695
}
3696
EXPORT_SYMBOL_GPL(ring_buffer_reset);
S
Steven Rostedt 已提交
3697 3698 3699 3700 3701 3702 3703 3704

/**
 * 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;
3705
	unsigned long flags;
3706
	int dolock;
S
Steven Rostedt 已提交
3707
	int cpu;
3708
	int ret;
S
Steven Rostedt 已提交
3709

3710
	dolock = rb_ok_to_lock();
S
Steven Rostedt 已提交
3711 3712 3713 3714

	/* 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];
3715 3716
		local_irq_save(flags);
		if (dolock)
3717
			raw_spin_lock(&cpu_buffer->reader_lock);
3718
		ret = rb_per_cpu_empty(cpu_buffer);
3719
		if (dolock)
3720
			raw_spin_unlock(&cpu_buffer->reader_lock);
3721 3722
		local_irq_restore(flags);

3723
		if (!ret)
S
Steven Rostedt 已提交
3724 3725
			return 0;
	}
3726

S
Steven Rostedt 已提交
3727 3728
	return 1;
}
3729
EXPORT_SYMBOL_GPL(ring_buffer_empty);
S
Steven Rostedt 已提交
3730 3731 3732 3733 3734 3735 3736 3737 3738

/**
 * 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;
3739
	unsigned long flags;
3740
	int dolock;
3741
	int ret;
S
Steven Rostedt 已提交
3742

3743
	if (!cpumask_test_cpu(cpu, buffer->cpumask))
3744
		return 1;
S
Steven Rostedt 已提交
3745

3746 3747
	dolock = rb_ok_to_lock();

S
Steven Rostedt 已提交
3748
	cpu_buffer = buffer->buffers[cpu];
3749 3750
	local_irq_save(flags);
	if (dolock)
3751
		raw_spin_lock(&cpu_buffer->reader_lock);
3752
	ret = rb_per_cpu_empty(cpu_buffer);
3753
	if (dolock)
3754
		raw_spin_unlock(&cpu_buffer->reader_lock);
3755
	local_irq_restore(flags);
3756 3757

	return ret;
S
Steven Rostedt 已提交
3758
}
3759
EXPORT_SYMBOL_GPL(ring_buffer_empty_cpu);
S
Steven Rostedt 已提交
3760

3761
#ifdef CONFIG_RING_BUFFER_ALLOW_SWAP
S
Steven Rostedt 已提交
3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776
/**
 * 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;
3777 3778
	int ret = -EINVAL;

3779 3780
	if (!cpumask_test_cpu(cpu, buffer_a->cpumask) ||
	    !cpumask_test_cpu(cpu, buffer_b->cpumask))
3781
		goto out;
S
Steven Rostedt 已提交
3782

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

S
Steven Rostedt 已提交
3786
	/* At least make sure the two buffers are somewhat the same */
3787
	if (cpu_buffer_a->nr_pages != cpu_buffer_b->nr_pages)
3788 3789 3790
		goto out;

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

3792
	if (ring_buffer_flags != RB_BUFFERS_ON)
3793
		goto out;
3794 3795

	if (atomic_read(&buffer_a->record_disabled))
3796
		goto out;
3797 3798

	if (atomic_read(&buffer_b->record_disabled))
3799
		goto out;
3800 3801

	if (atomic_read(&cpu_buffer_a->record_disabled))
3802
		goto out;
3803 3804

	if (atomic_read(&cpu_buffer_b->record_disabled))
3805
		goto out;
3806

S
Steven Rostedt 已提交
3807 3808 3809 3810 3811 3812 3813 3814 3815
	/*
	 * 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);

3816 3817 3818 3819 3820 3821
	ret = -EBUSY;
	if (local_read(&cpu_buffer_a->committing))
		goto out_dec;
	if (local_read(&cpu_buffer_b->committing))
		goto out_dec;

S
Steven Rostedt 已提交
3822 3823 3824 3825 3826 3827
	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;

3828 3829 3830
	ret = 0;

out_dec:
S
Steven Rostedt 已提交
3831 3832
	atomic_dec(&cpu_buffer_a->record_disabled);
	atomic_dec(&cpu_buffer_b->record_disabled);
3833 3834
out:
	return ret;
S
Steven Rostedt 已提交
3835
}
3836
EXPORT_SYMBOL_GPL(ring_buffer_swap_cpu);
3837
#endif /* CONFIG_RING_BUFFER_ALLOW_SWAP */
S
Steven Rostedt 已提交
3838

S
Steven Rostedt 已提交
3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853
/**
 * 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.
 */
3854
void *ring_buffer_alloc_read_page(struct ring_buffer *buffer, int cpu)
S
Steven Rostedt 已提交
3855
{
3856
	struct buffer_data_page *bpage;
3857
	struct page *page;
S
Steven Rostedt 已提交
3858

3859 3860
	page = alloc_pages_node(cpu_to_node(cpu),
				GFP_KERNEL | __GFP_NORETRY, 0);
3861
	if (!page)
S
Steven Rostedt 已提交
3862 3863
		return NULL;

3864
	bpage = page_address(page);
S
Steven Rostedt 已提交
3865

3866 3867
	rb_init_page(bpage);

3868
	return bpage;
S
Steven Rostedt 已提交
3869
}
S
Steven Rostedt 已提交
3870
EXPORT_SYMBOL_GPL(ring_buffer_alloc_read_page);
S
Steven Rostedt 已提交
3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882

/**
 * 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 已提交
3883
EXPORT_SYMBOL_GPL(ring_buffer_free_read_page);
S
Steven Rostedt 已提交
3884 3885 3886 3887 3888

/**
 * 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
3889
 * @len: amount to extract
S
Steven Rostedt 已提交
3890 3891 3892 3893 3894 3895 3896 3897 3898
 * @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 已提交
3899
 *	rpage = ring_buffer_alloc_read_page(buffer);
S
Steven Rostedt 已提交
3900 3901
 *	if (!rpage)
 *		return error;
3902
 *	ret = ring_buffer_read_page(buffer, &rpage, len, cpu, 0);
3903 3904
 *	if (ret >= 0)
 *		process_page(rpage, ret);
S
Steven Rostedt 已提交
3905 3906 3907 3908 3909 3910 3911 3912 3913 3914
 *
 * 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:
3915 3916
 *  >=0 if data has been transferred, returns the offset of consumed data.
 *  <0 if no data has been transferred.
S
Steven Rostedt 已提交
3917 3918
 */
int ring_buffer_read_page(struct ring_buffer *buffer,
3919
			  void **data_page, size_t len, int cpu, int full)
S
Steven Rostedt 已提交
3920 3921 3922
{
	struct ring_buffer_per_cpu *cpu_buffer = buffer->buffers[cpu];
	struct ring_buffer_event *event;
3923
	struct buffer_data_page *bpage;
3924
	struct buffer_page *reader;
3925
	unsigned long missed_events;
S
Steven Rostedt 已提交
3926
	unsigned long flags;
3927
	unsigned int commit;
3928
	unsigned int read;
3929
	u64 save_timestamp;
3930
	int ret = -1;
S
Steven Rostedt 已提交
3931

3932 3933 3934
	if (!cpumask_test_cpu(cpu, buffer->cpumask))
		goto out;

3935 3936 3937 3938 3939
	/*
	 * If len is not big enough to hold the page header, then
	 * we can not copy anything.
	 */
	if (len <= BUF_PAGE_HDR_SIZE)
3940
		goto out;
3941 3942 3943

	len -= BUF_PAGE_HDR_SIZE;

S
Steven Rostedt 已提交
3944
	if (!data_page)
3945
		goto out;
S
Steven Rostedt 已提交
3946

3947 3948
	bpage = *data_page;
	if (!bpage)
3949
		goto out;
S
Steven Rostedt 已提交
3950

3951
	raw_spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
S
Steven Rostedt 已提交
3952

3953 3954
	reader = rb_get_reader_page(cpu_buffer);
	if (!reader)
3955
		goto out_unlock;
S
Steven Rostedt 已提交
3956

3957 3958 3959 3960
	event = rb_reader_event(cpu_buffer);

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

3962
	/* Check if any events were dropped */
3963
	missed_events = cpu_buffer->lost_events;
3964

S
Steven Rostedt 已提交
3965
	/*
3966 3967 3968 3969 3970
	 * 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 已提交
3971
	 */
3972
	if (read || (len < (commit - read)) ||
3973
	    cpu_buffer->reader_page == cpu_buffer->commit_page) {
3974
		struct buffer_data_page *rpage = cpu_buffer->reader_page->page;
3975 3976
		unsigned int rpos = read;
		unsigned int pos = 0;
3977
		unsigned int size;
S
Steven Rostedt 已提交
3978 3979

		if (full)
3980
			goto out_unlock;
S
Steven Rostedt 已提交
3981

3982 3983 3984
		if (len > (commit - read))
			len = (commit - read);

3985 3986
		/* Always keep the time extend and data together */
		size = rb_event_ts_length(event);
3987 3988

		if (len < size)
3989
			goto out_unlock;
3990

3991 3992 3993
		/* save the current timestamp, since the user will need it */
		save_timestamp = cpu_buffer->read_stamp;

3994 3995
		/* Need to copy one event at a time */
		do {
3996 3997 3998 3999 4000 4001 4002
			/* We need the size of one event, because
			 * rb_advance_reader only advances by one event,
			 * whereas rb_event_ts_length may include the size of
			 * one or two events.
			 * We have already ensured there's enough space if this
			 * is a time extend. */
			size = rb_event_length(event);
4003
			memcpy(bpage->data + pos, rpage->data + rpos, size);
4004 4005 4006 4007

			len -= size;

			rb_advance_reader(cpu_buffer);
4008 4009
			rpos = reader->read;
			pos += size;
4010

4011 4012 4013
			if (rpos >= commit)
				break;

4014
			event = rb_reader_event(cpu_buffer);
4015 4016
			/* Always keep the time extend and data together */
			size = rb_event_ts_length(event);
4017
		} while (len >= size);
4018 4019

		/* update bpage */
4020
		local_set(&bpage->commit, pos);
4021
		bpage->time_stamp = save_timestamp;
4022

4023 4024
		/* we copied everything to the beginning */
		read = 0;
S
Steven Rostedt 已提交
4025
	} else {
4026
		/* update the entry counter */
S
Steven Rostedt 已提交
4027
		cpu_buffer->read += rb_page_entries(reader);
4028
		cpu_buffer->read_bytes += BUF_PAGE_SIZE;
4029

S
Steven Rostedt 已提交
4030
		/* swap the pages */
4031
		rb_init_page(bpage);
4032 4033 4034
		bpage = reader->page;
		reader->page = *data_page;
		local_set(&reader->write, 0);
4035
		local_set(&reader->entries, 0);
4036
		reader->read = 0;
4037
		*data_page = bpage;
4038 4039 4040 4041 4042 4043 4044 4045

		/*
		 * Use the real_end for the data size,
		 * This gives us a chance to store the lost events
		 * on the page.
		 */
		if (reader->real_end)
			local_set(&bpage->commit, reader->real_end);
S
Steven Rostedt 已提交
4046
	}
4047
	ret = read;
S
Steven Rostedt 已提交
4048

4049
	cpu_buffer->lost_events = 0;
4050 4051

	commit = local_read(&bpage->commit);
4052 4053 4054
	/*
	 * Set a flag in the commit field if we lost events
	 */
4055 4056 4057 4058 4059 4060 4061 4062
	if (missed_events) {
		/* If there is room at the end of the page to save the
		 * missed events, then record it there.
		 */
		if (BUF_PAGE_SIZE - commit >= sizeof(missed_events)) {
			memcpy(&bpage->data[commit], &missed_events,
			       sizeof(missed_events));
			local_add(RB_MISSED_STORED, &bpage->commit);
4063
			commit += sizeof(missed_events);
4064
		}
4065
		local_add(RB_MISSED_EVENTS, &bpage->commit);
4066
	}
4067

4068 4069 4070 4071 4072 4073
	/*
	 * This page may be off to user land. Zero it out here.
	 */
	if (commit < BUF_PAGE_SIZE)
		memset(&bpage->data[commit], 0, BUF_PAGE_SIZE - commit);

4074
 out_unlock:
4075
	raw_spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
S
Steven Rostedt 已提交
4076

4077
 out:
S
Steven Rostedt 已提交
4078 4079
	return ret;
}
S
Steven Rostedt 已提交
4080
EXPORT_SYMBOL_GPL(ring_buffer_read_page);
S
Steven Rostedt 已提交
4081

4082
#ifdef CONFIG_HOTPLUG_CPU
4083 4084
static int rb_cpu_notify(struct notifier_block *self,
			 unsigned long action, void *hcpu)
4085 4086 4087 4088
{
	struct ring_buffer *buffer =
		container_of(self, struct ring_buffer, cpu_notify);
	long cpu = (long)hcpu;
4089 4090
	int cpu_i, nr_pages_same;
	unsigned int nr_pages;
4091 4092 4093 4094

	switch (action) {
	case CPU_UP_PREPARE:
	case CPU_UP_PREPARE_FROZEN:
4095
		if (cpumask_test_cpu(cpu, buffer->cpumask))
4096 4097
			return NOTIFY_OK;

4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112
		nr_pages = 0;
		nr_pages_same = 1;
		/* check if all cpu sizes are same */
		for_each_buffer_cpu(buffer, cpu_i) {
			/* fill in the size from first enabled cpu */
			if (nr_pages == 0)
				nr_pages = buffer->buffers[cpu_i]->nr_pages;
			if (nr_pages != buffer->buffers[cpu_i]->nr_pages) {
				nr_pages_same = 0;
				break;
			}
		}
		/* allocate minimum pages, user can later expand it */
		if (!nr_pages_same)
			nr_pages = 2;
4113
		buffer->buffers[cpu] =
4114
			rb_allocate_cpu_buffer(buffer, nr_pages, cpu);
4115 4116 4117 4118 4119 4120
		if (!buffer->buffers[cpu]) {
			WARN(1, "failed to allocate ring buffer on CPU %ld\n",
			     cpu);
			return NOTIFY_OK;
		}
		smp_wmb();
4121
		cpumask_set_cpu(cpu, buffer->cpumask);
4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136
		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