ring_buffer.c 41 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746
  1. /*
  2. * Generic ring buffer
  3. *
  4. * Copyright (C) 2008 Steven Rostedt <srostedt@redhat.com>
  5. */
  6. #include <linux/ring_buffer.h>
  7. #include <linux/spinlock.h>
  8. #include <linux/debugfs.h>
  9. #include <linux/uaccess.h>
  10. #include <linux/module.h>
  11. #include <linux/percpu.h>
  12. #include <linux/mutex.h>
  13. #include <linux/sched.h> /* used for sched_clock() (for now) */
  14. #include <linux/init.h>
  15. #include <linux/hash.h>
  16. #include <linux/list.h>
  17. #include <linux/fs.h>
  18. /* Up this if you want to test the TIME_EXTENTS and normalization */
  19. #define DEBUG_SHIFT 0
  20. /* FIXME!!! */
  21. u64 ring_buffer_time_stamp(int cpu)
  22. {
  23. /* shift to debug/test normalization and TIME_EXTENTS */
  24. return sched_clock() << DEBUG_SHIFT;
  25. }
  26. void ring_buffer_normalize_time_stamp(int cpu, u64 *ts)
  27. {
  28. /* Just stupid testing the normalize function and deltas */
  29. *ts >>= DEBUG_SHIFT;
  30. }
  31. #define RB_EVNT_HDR_SIZE (sizeof(struct ring_buffer_event))
  32. #define RB_ALIGNMENT_SHIFT 2
  33. #define RB_ALIGNMENT (1 << RB_ALIGNMENT_SHIFT)
  34. #define RB_MAX_SMALL_DATA 28
  35. enum {
  36. RB_LEN_TIME_EXTEND = 8,
  37. RB_LEN_TIME_STAMP = 16,
  38. };
  39. /* inline for ring buffer fast paths */
  40. static inline unsigned
  41. rb_event_length(struct ring_buffer_event *event)
  42. {
  43. unsigned length;
  44. switch (event->type) {
  45. case RINGBUF_TYPE_PADDING:
  46. /* undefined */
  47. return -1;
  48. case RINGBUF_TYPE_TIME_EXTEND:
  49. return RB_LEN_TIME_EXTEND;
  50. case RINGBUF_TYPE_TIME_STAMP:
  51. return RB_LEN_TIME_STAMP;
  52. case RINGBUF_TYPE_DATA:
  53. if (event->len)
  54. length = event->len << RB_ALIGNMENT_SHIFT;
  55. else
  56. length = event->array[0];
  57. return length + RB_EVNT_HDR_SIZE;
  58. default:
  59. BUG();
  60. }
  61. /* not hit */
  62. return 0;
  63. }
  64. /**
  65. * ring_buffer_event_length - return the length of the event
  66. * @event: the event to get the length of
  67. */
  68. unsigned ring_buffer_event_length(struct ring_buffer_event *event)
  69. {
  70. return rb_event_length(event);
  71. }
  72. /* inline for ring buffer fast paths */
  73. static inline void *
  74. rb_event_data(struct ring_buffer_event *event)
  75. {
  76. BUG_ON(event->type != RINGBUF_TYPE_DATA);
  77. /* If length is in len field, then array[0] has the data */
  78. if (event->len)
  79. return (void *)&event->array[0];
  80. /* Otherwise length is in array[0] and array[1] has the data */
  81. return (void *)&event->array[1];
  82. }
  83. /**
  84. * ring_buffer_event_data - return the data of the event
  85. * @event: the event to get the data from
  86. */
  87. void *ring_buffer_event_data(struct ring_buffer_event *event)
  88. {
  89. return rb_event_data(event);
  90. }
  91. #define for_each_buffer_cpu(buffer, cpu) \
  92. for_each_cpu_mask(cpu, buffer->cpumask)
  93. #define TS_SHIFT 27
  94. #define TS_MASK ((1ULL << TS_SHIFT) - 1)
  95. #define TS_DELTA_TEST (~TS_MASK)
  96. /*
  97. * This hack stolen from mm/slob.c.
  98. * We can store per page timing information in the page frame of the page.
  99. * Thanks to Peter Zijlstra for suggesting this idea.
  100. */
  101. struct buffer_page {
  102. u64 time_stamp; /* page time stamp */
  103. unsigned size; /* size of page data */
  104. struct list_head list; /* list of free pages */
  105. void *page; /* Actual data page */
  106. };
  107. /*
  108. * Also stolen from mm/slob.c. Thanks to Mathieu Desnoyers for pointing
  109. * this issue out.
  110. */
  111. static inline void free_buffer_page(struct buffer_page *bpage)
  112. {
  113. if (bpage->page)
  114. __free_page(bpage->page);
  115. kfree(bpage);
  116. }
  117. /*
  118. * We need to fit the time_stamp delta into 27 bits.
  119. */
  120. static inline int test_time_stamp(u64 delta)
  121. {
  122. if (delta & TS_DELTA_TEST)
  123. return 1;
  124. return 0;
  125. }
  126. #define BUF_PAGE_SIZE PAGE_SIZE
  127. /*
  128. * head_page == tail_page && head == tail then buffer is empty.
  129. */
  130. struct ring_buffer_per_cpu {
  131. int cpu;
  132. struct ring_buffer *buffer;
  133. spinlock_t lock;
  134. struct lock_class_key lock_key;
  135. struct list_head pages;
  136. unsigned long head; /* read from head */
  137. unsigned long tail; /* write to tail */
  138. unsigned long reader;
  139. struct buffer_page *head_page;
  140. struct buffer_page *tail_page;
  141. struct buffer_page *reader_page;
  142. unsigned long overrun;
  143. unsigned long entries;
  144. u64 write_stamp;
  145. u64 read_stamp;
  146. atomic_t record_disabled;
  147. };
  148. struct ring_buffer {
  149. unsigned long size;
  150. unsigned pages;
  151. unsigned flags;
  152. int cpus;
  153. cpumask_t cpumask;
  154. atomic_t record_disabled;
  155. struct mutex mutex;
  156. struct ring_buffer_per_cpu **buffers;
  157. };
  158. struct ring_buffer_iter {
  159. struct ring_buffer_per_cpu *cpu_buffer;
  160. unsigned long head;
  161. struct buffer_page *head_page;
  162. u64 read_stamp;
  163. };
  164. #define RB_WARN_ON(buffer, cond) \
  165. if (unlikely(cond)) { \
  166. atomic_inc(&buffer->record_disabled); \
  167. WARN_ON(1); \
  168. return -1; \
  169. }
  170. /**
  171. * check_pages - integrity check of buffer pages
  172. * @cpu_buffer: CPU buffer with pages to test
  173. *
  174. * As a safty measure we check to make sure the data pages have not
  175. * been corrupted.
  176. */
  177. static int rb_check_pages(struct ring_buffer_per_cpu *cpu_buffer)
  178. {
  179. struct list_head *head = &cpu_buffer->pages;
  180. struct buffer_page *page, *tmp;
  181. RB_WARN_ON(cpu_buffer, head->next->prev != head);
  182. RB_WARN_ON(cpu_buffer, head->prev->next != head);
  183. list_for_each_entry_safe(page, tmp, head, list) {
  184. RB_WARN_ON(cpu_buffer, page->list.next->prev != &page->list);
  185. RB_WARN_ON(cpu_buffer, page->list.prev->next != &page->list);
  186. }
  187. return 0;
  188. }
  189. static unsigned rb_head_size(struct ring_buffer_per_cpu *cpu_buffer)
  190. {
  191. return cpu_buffer->head_page->size;
  192. }
  193. static int rb_allocate_pages(struct ring_buffer_per_cpu *cpu_buffer,
  194. unsigned nr_pages)
  195. {
  196. struct list_head *head = &cpu_buffer->pages;
  197. struct buffer_page *page, *tmp;
  198. unsigned long addr;
  199. LIST_HEAD(pages);
  200. unsigned i;
  201. for (i = 0; i < nr_pages; i++) {
  202. page = kzalloc_node(ALIGN(sizeof(*page), cache_line_size()),
  203. GFP_KERNEL, cpu_to_node(i));
  204. if (!page)
  205. goto free_pages;
  206. list_add(&page->list, &pages);
  207. addr = __get_free_page(GFP_KERNEL);
  208. if (!addr)
  209. goto free_pages;
  210. page->page = (void *)addr;
  211. }
  212. list_splice(&pages, head);
  213. rb_check_pages(cpu_buffer);
  214. return 0;
  215. free_pages:
  216. list_for_each_entry_safe(page, tmp, &pages, list) {
  217. list_del_init(&page->list);
  218. free_buffer_page(page);
  219. }
  220. return -ENOMEM;
  221. }
  222. static struct ring_buffer_per_cpu *
  223. rb_allocate_cpu_buffer(struct ring_buffer *buffer, int cpu)
  224. {
  225. struct ring_buffer_per_cpu *cpu_buffer;
  226. struct buffer_page *page;
  227. unsigned long addr;
  228. int ret;
  229. cpu_buffer = kzalloc_node(ALIGN(sizeof(*cpu_buffer), cache_line_size()),
  230. GFP_KERNEL, cpu_to_node(cpu));
  231. if (!cpu_buffer)
  232. return NULL;
  233. cpu_buffer->cpu = cpu;
  234. cpu_buffer->buffer = buffer;
  235. spin_lock_init(&cpu_buffer->lock);
  236. INIT_LIST_HEAD(&cpu_buffer->pages);
  237. page = kzalloc_node(ALIGN(sizeof(*page), cache_line_size()),
  238. GFP_KERNEL, cpu_to_node(cpu));
  239. if (!page)
  240. goto fail_free_buffer;
  241. cpu_buffer->reader_page = page;
  242. addr = __get_free_page(GFP_KERNEL);
  243. if (!addr)
  244. goto fail_free_reader;
  245. page->page = (void *)addr;
  246. INIT_LIST_HEAD(&cpu_buffer->reader_page->list);
  247. cpu_buffer->reader_page->size = 0;
  248. ret = rb_allocate_pages(cpu_buffer, buffer->pages);
  249. if (ret < 0)
  250. goto fail_free_reader;
  251. cpu_buffer->head_page
  252. = list_entry(cpu_buffer->pages.next, struct buffer_page, list);
  253. cpu_buffer->tail_page
  254. = list_entry(cpu_buffer->pages.next, struct buffer_page, list);
  255. return cpu_buffer;
  256. fail_free_reader:
  257. free_buffer_page(cpu_buffer->reader_page);
  258. fail_free_buffer:
  259. kfree(cpu_buffer);
  260. return NULL;
  261. }
  262. static void rb_free_cpu_buffer(struct ring_buffer_per_cpu *cpu_buffer)
  263. {
  264. struct list_head *head = &cpu_buffer->pages;
  265. struct buffer_page *page, *tmp;
  266. list_del_init(&cpu_buffer->reader_page->list);
  267. free_buffer_page(cpu_buffer->reader_page);
  268. list_for_each_entry_safe(page, tmp, head, list) {
  269. list_del_init(&page->list);
  270. free_buffer_page(page);
  271. }
  272. kfree(cpu_buffer);
  273. }
  274. /*
  275. * Causes compile errors if the struct buffer_page gets bigger
  276. * than the struct page.
  277. */
  278. extern int ring_buffer_page_too_big(void);
  279. /**
  280. * ring_buffer_alloc - allocate a new ring_buffer
  281. * @size: the size in bytes that is needed.
  282. * @flags: attributes to set for the ring buffer.
  283. *
  284. * Currently the only flag that is available is the RB_FL_OVERWRITE
  285. * flag. This flag means that the buffer will overwrite old data
  286. * when the buffer wraps. If this flag is not set, the buffer will
  287. * drop data when the tail hits the head.
  288. */
  289. struct ring_buffer *ring_buffer_alloc(unsigned long size, unsigned flags)
  290. {
  291. struct ring_buffer *buffer;
  292. int bsize;
  293. int cpu;
  294. /* Paranoid! Optimizes out when all is well */
  295. if (sizeof(struct buffer_page) > sizeof(struct page))
  296. ring_buffer_page_too_big();
  297. /* keep it in its own cache line */
  298. buffer = kzalloc(ALIGN(sizeof(*buffer), cache_line_size()),
  299. GFP_KERNEL);
  300. if (!buffer)
  301. return NULL;
  302. buffer->pages = DIV_ROUND_UP(size, BUF_PAGE_SIZE);
  303. buffer->flags = flags;
  304. /* need at least two pages */
  305. if (buffer->pages == 1)
  306. buffer->pages++;
  307. buffer->cpumask = cpu_possible_map;
  308. buffer->cpus = nr_cpu_ids;
  309. bsize = sizeof(void *) * nr_cpu_ids;
  310. buffer->buffers = kzalloc(ALIGN(bsize, cache_line_size()),
  311. GFP_KERNEL);
  312. if (!buffer->buffers)
  313. goto fail_free_buffer;
  314. for_each_buffer_cpu(buffer, cpu) {
  315. buffer->buffers[cpu] =
  316. rb_allocate_cpu_buffer(buffer, cpu);
  317. if (!buffer->buffers[cpu])
  318. goto fail_free_buffers;
  319. }
  320. mutex_init(&buffer->mutex);
  321. return buffer;
  322. fail_free_buffers:
  323. for_each_buffer_cpu(buffer, cpu) {
  324. if (buffer->buffers[cpu])
  325. rb_free_cpu_buffer(buffer->buffers[cpu]);
  326. }
  327. kfree(buffer->buffers);
  328. fail_free_buffer:
  329. kfree(buffer);
  330. return NULL;
  331. }
  332. /**
  333. * ring_buffer_free - free a ring buffer.
  334. * @buffer: the buffer to free.
  335. */
  336. void
  337. ring_buffer_free(struct ring_buffer *buffer)
  338. {
  339. int cpu;
  340. for_each_buffer_cpu(buffer, cpu)
  341. rb_free_cpu_buffer(buffer->buffers[cpu]);
  342. kfree(buffer);
  343. }
  344. static void rb_reset_cpu(struct ring_buffer_per_cpu *cpu_buffer);
  345. static void
  346. rb_remove_pages(struct ring_buffer_per_cpu *cpu_buffer, unsigned nr_pages)
  347. {
  348. struct buffer_page *page;
  349. struct list_head *p;
  350. unsigned i;
  351. atomic_inc(&cpu_buffer->record_disabled);
  352. synchronize_sched();
  353. for (i = 0; i < nr_pages; i++) {
  354. BUG_ON(list_empty(&cpu_buffer->pages));
  355. p = cpu_buffer->pages.next;
  356. page = list_entry(p, struct buffer_page, list);
  357. list_del_init(&page->list);
  358. free_buffer_page(page);
  359. }
  360. BUG_ON(list_empty(&cpu_buffer->pages));
  361. rb_reset_cpu(cpu_buffer);
  362. rb_check_pages(cpu_buffer);
  363. atomic_dec(&cpu_buffer->record_disabled);
  364. }
  365. static void
  366. rb_insert_pages(struct ring_buffer_per_cpu *cpu_buffer,
  367. struct list_head *pages, unsigned nr_pages)
  368. {
  369. struct buffer_page *page;
  370. struct list_head *p;
  371. unsigned i;
  372. atomic_inc(&cpu_buffer->record_disabled);
  373. synchronize_sched();
  374. for (i = 0; i < nr_pages; i++) {
  375. BUG_ON(list_empty(pages));
  376. p = pages->next;
  377. page = list_entry(p, struct buffer_page, list);
  378. list_del_init(&page->list);
  379. list_add_tail(&page->list, &cpu_buffer->pages);
  380. }
  381. rb_reset_cpu(cpu_buffer);
  382. rb_check_pages(cpu_buffer);
  383. atomic_dec(&cpu_buffer->record_disabled);
  384. }
  385. /**
  386. * ring_buffer_resize - resize the ring buffer
  387. * @buffer: the buffer to resize.
  388. * @size: the new size.
  389. *
  390. * The tracer is responsible for making sure that the buffer is
  391. * not being used while changing the size.
  392. * Note: We may be able to change the above requirement by using
  393. * RCU synchronizations.
  394. *
  395. * Minimum size is 2 * BUF_PAGE_SIZE.
  396. *
  397. * Returns -1 on failure.
  398. */
  399. int ring_buffer_resize(struct ring_buffer *buffer, unsigned long size)
  400. {
  401. struct ring_buffer_per_cpu *cpu_buffer;
  402. unsigned nr_pages, rm_pages, new_pages;
  403. struct buffer_page *page, *tmp;
  404. unsigned long buffer_size;
  405. unsigned long addr;
  406. LIST_HEAD(pages);
  407. int i, cpu;
  408. size = DIV_ROUND_UP(size, BUF_PAGE_SIZE);
  409. size *= BUF_PAGE_SIZE;
  410. buffer_size = buffer->pages * BUF_PAGE_SIZE;
  411. /* we need a minimum of two pages */
  412. if (size < BUF_PAGE_SIZE * 2)
  413. size = BUF_PAGE_SIZE * 2;
  414. if (size == buffer_size)
  415. return size;
  416. mutex_lock(&buffer->mutex);
  417. nr_pages = DIV_ROUND_UP(size, BUF_PAGE_SIZE);
  418. if (size < buffer_size) {
  419. /* easy case, just free pages */
  420. BUG_ON(nr_pages >= buffer->pages);
  421. rm_pages = buffer->pages - nr_pages;
  422. for_each_buffer_cpu(buffer, cpu) {
  423. cpu_buffer = buffer->buffers[cpu];
  424. rb_remove_pages(cpu_buffer, rm_pages);
  425. }
  426. goto out;
  427. }
  428. /*
  429. * This is a bit more difficult. We only want to add pages
  430. * when we can allocate enough for all CPUs. We do this
  431. * by allocating all the pages and storing them on a local
  432. * link list. If we succeed in our allocation, then we
  433. * add these pages to the cpu_buffers. Otherwise we just free
  434. * them all and return -ENOMEM;
  435. */
  436. BUG_ON(nr_pages <= buffer->pages);
  437. new_pages = nr_pages - buffer->pages;
  438. for_each_buffer_cpu(buffer, cpu) {
  439. for (i = 0; i < new_pages; i++) {
  440. page = kzalloc_node(ALIGN(sizeof(*page),
  441. cache_line_size()),
  442. GFP_KERNEL, cpu_to_node(cpu));
  443. if (!page)
  444. goto free_pages;
  445. list_add(&page->list, &pages);
  446. addr = __get_free_page(GFP_KERNEL);
  447. if (!addr)
  448. goto free_pages;
  449. page->page = (void *)addr;
  450. }
  451. }
  452. for_each_buffer_cpu(buffer, cpu) {
  453. cpu_buffer = buffer->buffers[cpu];
  454. rb_insert_pages(cpu_buffer, &pages, new_pages);
  455. }
  456. BUG_ON(!list_empty(&pages));
  457. out:
  458. buffer->pages = nr_pages;
  459. mutex_unlock(&buffer->mutex);
  460. return size;
  461. free_pages:
  462. list_for_each_entry_safe(page, tmp, &pages, list) {
  463. list_del_init(&page->list);
  464. free_buffer_page(page);
  465. }
  466. return -ENOMEM;
  467. }
  468. static inline int rb_per_cpu_empty(struct ring_buffer_per_cpu *cpu_buffer)
  469. {
  470. return (cpu_buffer->reader == cpu_buffer->reader_page->size &&
  471. (cpu_buffer->tail_page == cpu_buffer->reader_page ||
  472. (cpu_buffer->tail_page == cpu_buffer->head_page &&
  473. cpu_buffer->head == cpu_buffer->tail)));
  474. }
  475. static inline int rb_null_event(struct ring_buffer_event *event)
  476. {
  477. return event->type == RINGBUF_TYPE_PADDING;
  478. }
  479. static inline void *rb_page_index(struct buffer_page *page, unsigned index)
  480. {
  481. return page->page + index;
  482. }
  483. static inline struct ring_buffer_event *
  484. rb_reader_event(struct ring_buffer_per_cpu *cpu_buffer)
  485. {
  486. return rb_page_index(cpu_buffer->reader_page,
  487. cpu_buffer->reader);
  488. }
  489. static inline struct ring_buffer_event *
  490. rb_iter_head_event(struct ring_buffer_iter *iter)
  491. {
  492. return rb_page_index(iter->head_page,
  493. iter->head);
  494. }
  495. /*
  496. * When the tail hits the head and the buffer is in overwrite mode,
  497. * the head jumps to the next page and all content on the previous
  498. * page is discarded. But before doing so, we update the overrun
  499. * variable of the buffer.
  500. */
  501. static void rb_update_overflow(struct ring_buffer_per_cpu *cpu_buffer)
  502. {
  503. struct ring_buffer_event *event;
  504. unsigned long head;
  505. for (head = 0; head < rb_head_size(cpu_buffer);
  506. head += rb_event_length(event)) {
  507. event = rb_page_index(cpu_buffer->head_page, head);
  508. BUG_ON(rb_null_event(event));
  509. /* Only count data entries */
  510. if (event->type != RINGBUF_TYPE_DATA)
  511. continue;
  512. cpu_buffer->overrun++;
  513. cpu_buffer->entries--;
  514. }
  515. }
  516. static inline void rb_inc_page(struct ring_buffer_per_cpu *cpu_buffer,
  517. struct buffer_page **page)
  518. {
  519. struct list_head *p = (*page)->list.next;
  520. if (p == &cpu_buffer->pages)
  521. p = p->next;
  522. *page = list_entry(p, struct buffer_page, list);
  523. }
  524. static inline void
  525. rb_add_stamp(struct ring_buffer_per_cpu *cpu_buffer, u64 *ts)
  526. {
  527. cpu_buffer->tail_page->time_stamp = *ts;
  528. cpu_buffer->write_stamp = *ts;
  529. }
  530. static void rb_reset_head_page(struct ring_buffer_per_cpu *cpu_buffer)
  531. {
  532. cpu_buffer->head = 0;
  533. }
  534. static void rb_reset_reader_page(struct ring_buffer_per_cpu *cpu_buffer)
  535. {
  536. cpu_buffer->read_stamp = cpu_buffer->reader_page->time_stamp;
  537. cpu_buffer->reader = 0;
  538. }
  539. static inline void rb_inc_iter(struct ring_buffer_iter *iter)
  540. {
  541. struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;
  542. /*
  543. * The iterator could be on the reader page (it starts there).
  544. * But the head could have moved, since the reader was
  545. * found. Check for this case and assign the iterator
  546. * to the head page instead of next.
  547. */
  548. if (iter->head_page == cpu_buffer->reader_page)
  549. iter->head_page = cpu_buffer->head_page;
  550. else
  551. rb_inc_page(cpu_buffer, &iter->head_page);
  552. iter->read_stamp = iter->head_page->time_stamp;
  553. iter->head = 0;
  554. }
  555. /**
  556. * ring_buffer_update_event - update event type and data
  557. * @event: the even to update
  558. * @type: the type of event
  559. * @length: the size of the event field in the ring buffer
  560. *
  561. * Update the type and data fields of the event. The length
  562. * is the actual size that is written to the ring buffer,
  563. * and with this, we can determine what to place into the
  564. * data field.
  565. */
  566. static inline void
  567. rb_update_event(struct ring_buffer_event *event,
  568. unsigned type, unsigned length)
  569. {
  570. event->type = type;
  571. switch (type) {
  572. case RINGBUF_TYPE_PADDING:
  573. break;
  574. case RINGBUF_TYPE_TIME_EXTEND:
  575. event->len =
  576. (RB_LEN_TIME_EXTEND + (RB_ALIGNMENT-1))
  577. >> RB_ALIGNMENT_SHIFT;
  578. break;
  579. case RINGBUF_TYPE_TIME_STAMP:
  580. event->len =
  581. (RB_LEN_TIME_STAMP + (RB_ALIGNMENT-1))
  582. >> RB_ALIGNMENT_SHIFT;
  583. break;
  584. case RINGBUF_TYPE_DATA:
  585. length -= RB_EVNT_HDR_SIZE;
  586. if (length > RB_MAX_SMALL_DATA) {
  587. event->len = 0;
  588. event->array[0] = length;
  589. } else
  590. event->len =
  591. (length + (RB_ALIGNMENT-1))
  592. >> RB_ALIGNMENT_SHIFT;
  593. break;
  594. default:
  595. BUG();
  596. }
  597. }
  598. static inline unsigned rb_calculate_event_length(unsigned length)
  599. {
  600. struct ring_buffer_event event; /* Used only for sizeof array */
  601. /* zero length can cause confusions */
  602. if (!length)
  603. length = 1;
  604. if (length > RB_MAX_SMALL_DATA)
  605. length += sizeof(event.array[0]);
  606. length += RB_EVNT_HDR_SIZE;
  607. length = ALIGN(length, RB_ALIGNMENT);
  608. return length;
  609. }
  610. static struct ring_buffer_event *
  611. __rb_reserve_next(struct ring_buffer_per_cpu *cpu_buffer,
  612. unsigned type, unsigned long length, u64 *ts)
  613. {
  614. struct buffer_page *tail_page, *head_page, *reader_page;
  615. unsigned long tail;
  616. struct ring_buffer *buffer = cpu_buffer->buffer;
  617. struct ring_buffer_event *event;
  618. /* No locking needed for tail page */
  619. tail_page = cpu_buffer->tail_page;
  620. tail = cpu_buffer->tail;
  621. if (tail + length > BUF_PAGE_SIZE) {
  622. struct buffer_page *next_page = tail_page;
  623. spin_lock(&cpu_buffer->lock);
  624. rb_inc_page(cpu_buffer, &next_page);
  625. head_page = cpu_buffer->head_page;
  626. reader_page = cpu_buffer->reader_page;
  627. /* we grabbed the lock before incrementing */
  628. WARN_ON(next_page == reader_page);
  629. if (next_page == head_page) {
  630. if (!(buffer->flags & RB_FL_OVERWRITE)) {
  631. spin_unlock(&cpu_buffer->lock);
  632. return NULL;
  633. }
  634. /* count overflows */
  635. rb_update_overflow(cpu_buffer);
  636. rb_inc_page(cpu_buffer, &head_page);
  637. cpu_buffer->head_page = head_page;
  638. rb_reset_head_page(cpu_buffer);
  639. }
  640. if (tail != BUF_PAGE_SIZE) {
  641. event = rb_page_index(tail_page, tail);
  642. /* page padding */
  643. event->type = RINGBUF_TYPE_PADDING;
  644. }
  645. tail_page->size = tail;
  646. tail_page = next_page;
  647. tail_page->size = 0;
  648. tail = 0;
  649. cpu_buffer->tail_page = tail_page;
  650. cpu_buffer->tail = tail;
  651. rb_add_stamp(cpu_buffer, ts);
  652. spin_unlock(&cpu_buffer->lock);
  653. }
  654. BUG_ON(tail + length > BUF_PAGE_SIZE);
  655. event = rb_page_index(tail_page, tail);
  656. rb_update_event(event, type, length);
  657. return event;
  658. }
  659. static int
  660. rb_add_time_stamp(struct ring_buffer_per_cpu *cpu_buffer,
  661. u64 *ts, u64 *delta)
  662. {
  663. struct ring_buffer_event *event;
  664. static int once;
  665. if (unlikely(*delta > (1ULL << 59) && !once++)) {
  666. printk(KERN_WARNING "Delta way too big! %llu"
  667. " ts=%llu write stamp = %llu\n",
  668. *delta, *ts, cpu_buffer->write_stamp);
  669. WARN_ON(1);
  670. }
  671. /*
  672. * The delta is too big, we to add a
  673. * new timestamp.
  674. */
  675. event = __rb_reserve_next(cpu_buffer,
  676. RINGBUF_TYPE_TIME_EXTEND,
  677. RB_LEN_TIME_EXTEND,
  678. ts);
  679. if (!event)
  680. return -1;
  681. /* check to see if we went to the next page */
  682. if (cpu_buffer->tail) {
  683. /* Still on same page, update timestamp */
  684. event->time_delta = *delta & TS_MASK;
  685. event->array[0] = *delta >> TS_SHIFT;
  686. /* commit the time event */
  687. cpu_buffer->tail +=
  688. rb_event_length(event);
  689. cpu_buffer->write_stamp = *ts;
  690. *delta = 0;
  691. }
  692. return 0;
  693. }
  694. static struct ring_buffer_event *
  695. rb_reserve_next_event(struct ring_buffer_per_cpu *cpu_buffer,
  696. unsigned type, unsigned long length)
  697. {
  698. struct ring_buffer_event *event;
  699. u64 ts, delta;
  700. ts = ring_buffer_time_stamp(cpu_buffer->cpu);
  701. if (cpu_buffer->tail) {
  702. delta = ts - cpu_buffer->write_stamp;
  703. if (test_time_stamp(delta)) {
  704. int ret;
  705. ret = rb_add_time_stamp(cpu_buffer, &ts, &delta);
  706. if (ret < 0)
  707. return NULL;
  708. }
  709. } else {
  710. spin_lock(&cpu_buffer->lock);
  711. rb_add_stamp(cpu_buffer, &ts);
  712. spin_unlock(&cpu_buffer->lock);
  713. delta = 0;
  714. }
  715. event = __rb_reserve_next(cpu_buffer, type, length, &ts);
  716. if (!event)
  717. return NULL;
  718. /* If the reserve went to the next page, our delta is zero */
  719. if (!cpu_buffer->tail)
  720. delta = 0;
  721. event->time_delta = delta;
  722. return event;
  723. }
  724. /**
  725. * ring_buffer_lock_reserve - reserve a part of the buffer
  726. * @buffer: the ring buffer to reserve from
  727. * @length: the length of the data to reserve (excluding event header)
  728. * @flags: a pointer to save the interrupt flags
  729. *
  730. * Returns a reseverd event on the ring buffer to copy directly to.
  731. * The user of this interface will need to get the body to write into
  732. * and can use the ring_buffer_event_data() interface.
  733. *
  734. * The length is the length of the data needed, not the event length
  735. * which also includes the event header.
  736. *
  737. * Must be paired with ring_buffer_unlock_commit, unless NULL is returned.
  738. * If NULL is returned, then nothing has been allocated or locked.
  739. */
  740. struct ring_buffer_event *
  741. ring_buffer_lock_reserve(struct ring_buffer *buffer,
  742. unsigned long length,
  743. unsigned long *flags)
  744. {
  745. struct ring_buffer_per_cpu *cpu_buffer;
  746. struct ring_buffer_event *event;
  747. int cpu;
  748. if (atomic_read(&buffer->record_disabled))
  749. return NULL;
  750. local_irq_save(*flags);
  751. cpu = raw_smp_processor_id();
  752. if (!cpu_isset(cpu, buffer->cpumask))
  753. goto out;
  754. cpu_buffer = buffer->buffers[cpu];
  755. if (atomic_read(&cpu_buffer->record_disabled))
  756. goto out;
  757. length = rb_calculate_event_length(length);
  758. if (length > BUF_PAGE_SIZE)
  759. return NULL;
  760. event = rb_reserve_next_event(cpu_buffer, RINGBUF_TYPE_DATA, length);
  761. if (!event)
  762. goto out;
  763. return event;
  764. out:
  765. local_irq_restore(*flags);
  766. return NULL;
  767. }
  768. static void rb_commit(struct ring_buffer_per_cpu *cpu_buffer,
  769. struct ring_buffer_event *event)
  770. {
  771. cpu_buffer->tail += rb_event_length(event);
  772. cpu_buffer->tail_page->size = cpu_buffer->tail;
  773. cpu_buffer->write_stamp += event->time_delta;
  774. cpu_buffer->entries++;
  775. }
  776. /**
  777. * ring_buffer_unlock_commit - commit a reserved
  778. * @buffer: The buffer to commit to
  779. * @event: The event pointer to commit.
  780. * @flags: the interrupt flags received from ring_buffer_lock_reserve.
  781. *
  782. * This commits the data to the ring buffer, and releases any locks held.
  783. *
  784. * Must be paired with ring_buffer_lock_reserve.
  785. */
  786. int ring_buffer_unlock_commit(struct ring_buffer *buffer,
  787. struct ring_buffer_event *event,
  788. unsigned long flags)
  789. {
  790. struct ring_buffer_per_cpu *cpu_buffer;
  791. int cpu = raw_smp_processor_id();
  792. cpu_buffer = buffer->buffers[cpu];
  793. rb_commit(cpu_buffer, event);
  794. local_irq_restore(flags);
  795. return 0;
  796. }
  797. /**
  798. * ring_buffer_write - write data to the buffer without reserving
  799. * @buffer: The ring buffer to write to.
  800. * @length: The length of the data being written (excluding the event header)
  801. * @data: The data to write to the buffer.
  802. *
  803. * This is like ring_buffer_lock_reserve and ring_buffer_unlock_commit as
  804. * one function. If you already have the data to write to the buffer, it
  805. * may be easier to simply call this function.
  806. *
  807. * Note, like ring_buffer_lock_reserve, the length is the length of the data
  808. * and not the length of the event which would hold the header.
  809. */
  810. int ring_buffer_write(struct ring_buffer *buffer,
  811. unsigned long length,
  812. void *data)
  813. {
  814. struct ring_buffer_per_cpu *cpu_buffer;
  815. struct ring_buffer_event *event;
  816. unsigned long event_length, flags;
  817. void *body;
  818. int ret = -EBUSY;
  819. int cpu;
  820. if (atomic_read(&buffer->record_disabled))
  821. return -EBUSY;
  822. local_irq_save(flags);
  823. cpu = raw_smp_processor_id();
  824. if (!cpu_isset(cpu, buffer->cpumask))
  825. goto out;
  826. cpu_buffer = buffer->buffers[cpu];
  827. if (atomic_read(&cpu_buffer->record_disabled))
  828. goto out;
  829. event_length = rb_calculate_event_length(length);
  830. event = rb_reserve_next_event(cpu_buffer,
  831. RINGBUF_TYPE_DATA, event_length);
  832. if (!event)
  833. goto out;
  834. body = rb_event_data(event);
  835. memcpy(body, data, length);
  836. rb_commit(cpu_buffer, event);
  837. ret = 0;
  838. out:
  839. local_irq_restore(flags);
  840. return ret;
  841. }
  842. /**
  843. * ring_buffer_record_disable - stop all writes into the buffer
  844. * @buffer: The ring buffer to stop writes to.
  845. *
  846. * This prevents all writes to the buffer. Any attempt to write
  847. * to the buffer after this will fail and return NULL.
  848. *
  849. * The caller should call synchronize_sched() after this.
  850. */
  851. void ring_buffer_record_disable(struct ring_buffer *buffer)
  852. {
  853. atomic_inc(&buffer->record_disabled);
  854. }
  855. /**
  856. * ring_buffer_record_enable - enable writes to the buffer
  857. * @buffer: The ring buffer to enable writes
  858. *
  859. * Note, multiple disables will need the same number of enables
  860. * to truely enable the writing (much like preempt_disable).
  861. */
  862. void ring_buffer_record_enable(struct ring_buffer *buffer)
  863. {
  864. atomic_dec(&buffer->record_disabled);
  865. }
  866. /**
  867. * ring_buffer_record_disable_cpu - stop all writes into the cpu_buffer
  868. * @buffer: The ring buffer to stop writes to.
  869. * @cpu: The CPU buffer to stop
  870. *
  871. * This prevents all writes to the buffer. Any attempt to write
  872. * to the buffer after this will fail and return NULL.
  873. *
  874. * The caller should call synchronize_sched() after this.
  875. */
  876. void ring_buffer_record_disable_cpu(struct ring_buffer *buffer, int cpu)
  877. {
  878. struct ring_buffer_per_cpu *cpu_buffer;
  879. if (!cpu_isset(cpu, buffer->cpumask))
  880. return;
  881. cpu_buffer = buffer->buffers[cpu];
  882. atomic_inc(&cpu_buffer->record_disabled);
  883. }
  884. /**
  885. * ring_buffer_record_enable_cpu - enable writes to the buffer
  886. * @buffer: The ring buffer to enable writes
  887. * @cpu: The CPU to enable.
  888. *
  889. * Note, multiple disables will need the same number of enables
  890. * to truely enable the writing (much like preempt_disable).
  891. */
  892. void ring_buffer_record_enable_cpu(struct ring_buffer *buffer, int cpu)
  893. {
  894. struct ring_buffer_per_cpu *cpu_buffer;
  895. if (!cpu_isset(cpu, buffer->cpumask))
  896. return;
  897. cpu_buffer = buffer->buffers[cpu];
  898. atomic_dec(&cpu_buffer->record_disabled);
  899. }
  900. /**
  901. * ring_buffer_entries_cpu - get the number of entries in a cpu buffer
  902. * @buffer: The ring buffer
  903. * @cpu: The per CPU buffer to get the entries from.
  904. */
  905. unsigned long ring_buffer_entries_cpu(struct ring_buffer *buffer, int cpu)
  906. {
  907. struct ring_buffer_per_cpu *cpu_buffer;
  908. if (!cpu_isset(cpu, buffer->cpumask))
  909. return 0;
  910. cpu_buffer = buffer->buffers[cpu];
  911. return cpu_buffer->entries;
  912. }
  913. /**
  914. * ring_buffer_overrun_cpu - get the number of overruns in a cpu_buffer
  915. * @buffer: The ring buffer
  916. * @cpu: The per CPU buffer to get the number of overruns from
  917. */
  918. unsigned long ring_buffer_overrun_cpu(struct ring_buffer *buffer, int cpu)
  919. {
  920. struct ring_buffer_per_cpu *cpu_buffer;
  921. if (!cpu_isset(cpu, buffer->cpumask))
  922. return 0;
  923. cpu_buffer = buffer->buffers[cpu];
  924. return cpu_buffer->overrun;
  925. }
  926. /**
  927. * ring_buffer_entries - get the number of entries in a buffer
  928. * @buffer: The ring buffer
  929. *
  930. * Returns the total number of entries in the ring buffer
  931. * (all CPU entries)
  932. */
  933. unsigned long ring_buffer_entries(struct ring_buffer *buffer)
  934. {
  935. struct ring_buffer_per_cpu *cpu_buffer;
  936. unsigned long entries = 0;
  937. int cpu;
  938. /* if you care about this being correct, lock the buffer */
  939. for_each_buffer_cpu(buffer, cpu) {
  940. cpu_buffer = buffer->buffers[cpu];
  941. entries += cpu_buffer->entries;
  942. }
  943. return entries;
  944. }
  945. /**
  946. * ring_buffer_overrun_cpu - get the number of overruns in buffer
  947. * @buffer: The ring buffer
  948. *
  949. * Returns the total number of overruns in the ring buffer
  950. * (all CPU entries)
  951. */
  952. unsigned long ring_buffer_overruns(struct ring_buffer *buffer)
  953. {
  954. struct ring_buffer_per_cpu *cpu_buffer;
  955. unsigned long overruns = 0;
  956. int cpu;
  957. /* if you care about this being correct, lock the buffer */
  958. for_each_buffer_cpu(buffer, cpu) {
  959. cpu_buffer = buffer->buffers[cpu];
  960. overruns += cpu_buffer->overrun;
  961. }
  962. return overruns;
  963. }
  964. /**
  965. * ring_buffer_iter_reset - reset an iterator
  966. * @iter: The iterator to reset
  967. *
  968. * Resets the iterator, so that it will start from the beginning
  969. * again.
  970. */
  971. void ring_buffer_iter_reset(struct ring_buffer_iter *iter)
  972. {
  973. struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;
  974. /* Iterator usage is expected to have record disabled */
  975. if (list_empty(&cpu_buffer->reader_page->list)) {
  976. iter->head_page = cpu_buffer->head_page;
  977. iter->head = cpu_buffer->head;
  978. } else {
  979. iter->head_page = cpu_buffer->reader_page;
  980. iter->head = cpu_buffer->reader;
  981. }
  982. if (iter->head)
  983. iter->read_stamp = cpu_buffer->read_stamp;
  984. else
  985. iter->read_stamp = iter->head_page->time_stamp;
  986. }
  987. /**
  988. * ring_buffer_iter_empty - check if an iterator has no more to read
  989. * @iter: The iterator to check
  990. */
  991. int ring_buffer_iter_empty(struct ring_buffer_iter *iter)
  992. {
  993. struct ring_buffer_per_cpu *cpu_buffer;
  994. cpu_buffer = iter->cpu_buffer;
  995. return iter->head_page == cpu_buffer->tail_page &&
  996. iter->head == cpu_buffer->tail;
  997. }
  998. static void
  999. rb_update_read_stamp(struct ring_buffer_per_cpu *cpu_buffer,
  1000. struct ring_buffer_event *event)
  1001. {
  1002. u64 delta;
  1003. switch (event->type) {
  1004. case RINGBUF_TYPE_PADDING:
  1005. return;
  1006. case RINGBUF_TYPE_TIME_EXTEND:
  1007. delta = event->array[0];
  1008. delta <<= TS_SHIFT;
  1009. delta += event->time_delta;
  1010. cpu_buffer->read_stamp += delta;
  1011. return;
  1012. case RINGBUF_TYPE_TIME_STAMP:
  1013. /* FIXME: not implemented */
  1014. return;
  1015. case RINGBUF_TYPE_DATA:
  1016. cpu_buffer->read_stamp += event->time_delta;
  1017. return;
  1018. default:
  1019. BUG();
  1020. }
  1021. return;
  1022. }
  1023. static void
  1024. rb_update_iter_read_stamp(struct ring_buffer_iter *iter,
  1025. struct ring_buffer_event *event)
  1026. {
  1027. u64 delta;
  1028. switch (event->type) {
  1029. case RINGBUF_TYPE_PADDING:
  1030. return;
  1031. case RINGBUF_TYPE_TIME_EXTEND:
  1032. delta = event->array[0];
  1033. delta <<= TS_SHIFT;
  1034. delta += event->time_delta;
  1035. iter->read_stamp += delta;
  1036. return;
  1037. case RINGBUF_TYPE_TIME_STAMP:
  1038. /* FIXME: not implemented */
  1039. return;
  1040. case RINGBUF_TYPE_DATA:
  1041. iter->read_stamp += event->time_delta;
  1042. return;
  1043. default:
  1044. BUG();
  1045. }
  1046. return;
  1047. }
  1048. static struct buffer_page *
  1049. rb_get_reader_page(struct ring_buffer_per_cpu *cpu_buffer)
  1050. {
  1051. struct buffer_page *reader = NULL;
  1052. unsigned long flags;
  1053. spin_lock_irqsave(&cpu_buffer->lock, flags);
  1054. again:
  1055. reader = cpu_buffer->reader_page;
  1056. /* If there's more to read, return this page */
  1057. if (cpu_buffer->reader < reader->size)
  1058. goto out;
  1059. /* Never should we have an index greater than the size */
  1060. WARN_ON(cpu_buffer->reader > reader->size);
  1061. /* check if we caught up to the tail */
  1062. reader = NULL;
  1063. if (cpu_buffer->tail_page == cpu_buffer->reader_page)
  1064. goto out;
  1065. /*
  1066. * Splice the empty reader page into the list around the head.
  1067. * Reset the reader page to size zero.
  1068. */
  1069. reader = cpu_buffer->head_page;
  1070. cpu_buffer->reader_page->list.next = reader->list.next;
  1071. cpu_buffer->reader_page->list.prev = reader->list.prev;
  1072. cpu_buffer->reader_page->size = 0;
  1073. /* Make the reader page now replace the head */
  1074. reader->list.prev->next = &cpu_buffer->reader_page->list;
  1075. reader->list.next->prev = &cpu_buffer->reader_page->list;
  1076. /*
  1077. * If the tail is on the reader, then we must set the head
  1078. * to the inserted page, otherwise we set it one before.
  1079. */
  1080. cpu_buffer->head_page = cpu_buffer->reader_page;
  1081. if (cpu_buffer->tail_page != reader)
  1082. rb_inc_page(cpu_buffer, &cpu_buffer->head_page);
  1083. /* Finally update the reader page to the new head */
  1084. cpu_buffer->reader_page = reader;
  1085. rb_reset_reader_page(cpu_buffer);
  1086. goto again;
  1087. out:
  1088. spin_unlock_irqrestore(&cpu_buffer->lock, flags);
  1089. return reader;
  1090. }
  1091. static void rb_advance_reader(struct ring_buffer_per_cpu *cpu_buffer)
  1092. {
  1093. struct ring_buffer_event *event;
  1094. struct buffer_page *reader;
  1095. unsigned length;
  1096. reader = rb_get_reader_page(cpu_buffer);
  1097. /* This function should not be called when buffer is empty */
  1098. BUG_ON(!reader);
  1099. event = rb_reader_event(cpu_buffer);
  1100. if (event->type == RINGBUF_TYPE_DATA)
  1101. cpu_buffer->entries--;
  1102. rb_update_read_stamp(cpu_buffer, event);
  1103. length = rb_event_length(event);
  1104. cpu_buffer->reader += length;
  1105. }
  1106. static void rb_advance_iter(struct ring_buffer_iter *iter)
  1107. {
  1108. struct ring_buffer *buffer;
  1109. struct ring_buffer_per_cpu *cpu_buffer;
  1110. struct ring_buffer_event *event;
  1111. unsigned length;
  1112. cpu_buffer = iter->cpu_buffer;
  1113. buffer = cpu_buffer->buffer;
  1114. /*
  1115. * Check if we are at the end of the buffer.
  1116. */
  1117. if (iter->head >= iter->head_page->size) {
  1118. BUG_ON(iter->head_page == cpu_buffer->tail_page);
  1119. rb_inc_iter(iter);
  1120. return;
  1121. }
  1122. event = rb_iter_head_event(iter);
  1123. length = rb_event_length(event);
  1124. /*
  1125. * This should not be called to advance the header if we are
  1126. * at the tail of the buffer.
  1127. */
  1128. BUG_ON((iter->head_page == cpu_buffer->tail_page) &&
  1129. (iter->head + length > cpu_buffer->tail));
  1130. rb_update_iter_read_stamp(iter, event);
  1131. iter->head += length;
  1132. /* check for end of page padding */
  1133. if ((iter->head >= iter->head_page->size) &&
  1134. (iter->head_page != cpu_buffer->tail_page))
  1135. rb_advance_iter(iter);
  1136. }
  1137. /**
  1138. * ring_buffer_peek - peek at the next event to be read
  1139. * @buffer: The ring buffer to read
  1140. * @cpu: The cpu to peak at
  1141. * @ts: The timestamp counter of this event.
  1142. *
  1143. * This will return the event that will be read next, but does
  1144. * not consume the data.
  1145. */
  1146. struct ring_buffer_event *
  1147. ring_buffer_peek(struct ring_buffer *buffer, int cpu, u64 *ts)
  1148. {
  1149. struct ring_buffer_per_cpu *cpu_buffer;
  1150. struct ring_buffer_event *event;
  1151. struct buffer_page *reader;
  1152. if (!cpu_isset(cpu, buffer->cpumask))
  1153. return NULL;
  1154. cpu_buffer = buffer->buffers[cpu];
  1155. again:
  1156. reader = rb_get_reader_page(cpu_buffer);
  1157. if (!reader)
  1158. return NULL;
  1159. event = rb_reader_event(cpu_buffer);
  1160. switch (event->type) {
  1161. case RINGBUF_TYPE_PADDING:
  1162. WARN_ON(1);
  1163. rb_advance_reader(cpu_buffer);
  1164. return NULL;
  1165. case RINGBUF_TYPE_TIME_EXTEND:
  1166. /* Internal data, OK to advance */
  1167. rb_advance_reader(cpu_buffer);
  1168. goto again;
  1169. case RINGBUF_TYPE_TIME_STAMP:
  1170. /* FIXME: not implemented */
  1171. rb_advance_reader(cpu_buffer);
  1172. goto again;
  1173. case RINGBUF_TYPE_DATA:
  1174. if (ts) {
  1175. *ts = cpu_buffer->read_stamp + event->time_delta;
  1176. ring_buffer_normalize_time_stamp(cpu_buffer->cpu, ts);
  1177. }
  1178. return event;
  1179. default:
  1180. BUG();
  1181. }
  1182. return NULL;
  1183. }
  1184. /**
  1185. * ring_buffer_iter_peek - peek at the next event to be read
  1186. * @iter: The ring buffer iterator
  1187. * @ts: The timestamp counter of this event.
  1188. *
  1189. * This will return the event that will be read next, but does
  1190. * not increment the iterator.
  1191. */
  1192. struct ring_buffer_event *
  1193. ring_buffer_iter_peek(struct ring_buffer_iter *iter, u64 *ts)
  1194. {
  1195. struct ring_buffer *buffer;
  1196. struct ring_buffer_per_cpu *cpu_buffer;
  1197. struct ring_buffer_event *event;
  1198. if (ring_buffer_iter_empty(iter))
  1199. return NULL;
  1200. cpu_buffer = iter->cpu_buffer;
  1201. buffer = cpu_buffer->buffer;
  1202. again:
  1203. if (rb_per_cpu_empty(cpu_buffer))
  1204. return NULL;
  1205. event = rb_iter_head_event(iter);
  1206. switch (event->type) {
  1207. case RINGBUF_TYPE_PADDING:
  1208. rb_inc_iter(iter);
  1209. goto again;
  1210. case RINGBUF_TYPE_TIME_EXTEND:
  1211. /* Internal data, OK to advance */
  1212. rb_advance_iter(iter);
  1213. goto again;
  1214. case RINGBUF_TYPE_TIME_STAMP:
  1215. /* FIXME: not implemented */
  1216. rb_advance_iter(iter);
  1217. goto again;
  1218. case RINGBUF_TYPE_DATA:
  1219. if (ts) {
  1220. *ts = iter->read_stamp + event->time_delta;
  1221. ring_buffer_normalize_time_stamp(cpu_buffer->cpu, ts);
  1222. }
  1223. return event;
  1224. default:
  1225. BUG();
  1226. }
  1227. return NULL;
  1228. }
  1229. /**
  1230. * ring_buffer_consume - return an event and consume it
  1231. * @buffer: The ring buffer to get the next event from
  1232. *
  1233. * Returns the next event in the ring buffer, and that event is consumed.
  1234. * Meaning, that sequential reads will keep returning a different event,
  1235. * and eventually empty the ring buffer if the producer is slower.
  1236. */
  1237. struct ring_buffer_event *
  1238. ring_buffer_consume(struct ring_buffer *buffer, int cpu, u64 *ts)
  1239. {
  1240. struct ring_buffer_per_cpu *cpu_buffer;
  1241. struct ring_buffer_event *event;
  1242. if (!cpu_isset(cpu, buffer->cpumask))
  1243. return NULL;
  1244. event = ring_buffer_peek(buffer, cpu, ts);
  1245. if (!event)
  1246. return NULL;
  1247. cpu_buffer = buffer->buffers[cpu];
  1248. rb_advance_reader(cpu_buffer);
  1249. return event;
  1250. }
  1251. /**
  1252. * ring_buffer_read_start - start a non consuming read of the buffer
  1253. * @buffer: The ring buffer to read from
  1254. * @cpu: The cpu buffer to iterate over
  1255. *
  1256. * This starts up an iteration through the buffer. It also disables
  1257. * the recording to the buffer until the reading is finished.
  1258. * This prevents the reading from being corrupted. This is not
  1259. * a consuming read, so a producer is not expected.
  1260. *
  1261. * Must be paired with ring_buffer_finish.
  1262. */
  1263. struct ring_buffer_iter *
  1264. ring_buffer_read_start(struct ring_buffer *buffer, int cpu)
  1265. {
  1266. struct ring_buffer_per_cpu *cpu_buffer;
  1267. struct ring_buffer_iter *iter;
  1268. unsigned long flags;
  1269. if (!cpu_isset(cpu, buffer->cpumask))
  1270. return NULL;
  1271. iter = kmalloc(sizeof(*iter), GFP_KERNEL);
  1272. if (!iter)
  1273. return NULL;
  1274. cpu_buffer = buffer->buffers[cpu];
  1275. iter->cpu_buffer = cpu_buffer;
  1276. atomic_inc(&cpu_buffer->record_disabled);
  1277. synchronize_sched();
  1278. spin_lock_irqsave(&cpu_buffer->lock, flags);
  1279. ring_buffer_iter_reset(iter);
  1280. spin_unlock_irqrestore(&cpu_buffer->lock, flags);
  1281. return iter;
  1282. }
  1283. /**
  1284. * ring_buffer_finish - finish reading the iterator of the buffer
  1285. * @iter: The iterator retrieved by ring_buffer_start
  1286. *
  1287. * This re-enables the recording to the buffer, and frees the
  1288. * iterator.
  1289. */
  1290. void
  1291. ring_buffer_read_finish(struct ring_buffer_iter *iter)
  1292. {
  1293. struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;
  1294. atomic_dec(&cpu_buffer->record_disabled);
  1295. kfree(iter);
  1296. }
  1297. /**
  1298. * ring_buffer_read - read the next item in the ring buffer by the iterator
  1299. * @iter: The ring buffer iterator
  1300. * @ts: The time stamp of the event read.
  1301. *
  1302. * This reads the next event in the ring buffer and increments the iterator.
  1303. */
  1304. struct ring_buffer_event *
  1305. ring_buffer_read(struct ring_buffer_iter *iter, u64 *ts)
  1306. {
  1307. struct ring_buffer_event *event;
  1308. event = ring_buffer_iter_peek(iter, ts);
  1309. if (!event)
  1310. return NULL;
  1311. rb_advance_iter(iter);
  1312. return event;
  1313. }
  1314. /**
  1315. * ring_buffer_size - return the size of the ring buffer (in bytes)
  1316. * @buffer: The ring buffer.
  1317. */
  1318. unsigned long ring_buffer_size(struct ring_buffer *buffer)
  1319. {
  1320. return BUF_PAGE_SIZE * buffer->pages;
  1321. }
  1322. static void
  1323. rb_reset_cpu(struct ring_buffer_per_cpu *cpu_buffer)
  1324. {
  1325. cpu_buffer->head_page
  1326. = list_entry(cpu_buffer->pages.next, struct buffer_page, list);
  1327. cpu_buffer->head_page->size = 0;
  1328. cpu_buffer->tail_page = cpu_buffer->head_page;
  1329. cpu_buffer->tail_page->size = 0;
  1330. INIT_LIST_HEAD(&cpu_buffer->reader_page->list);
  1331. cpu_buffer->reader_page->size = 0;
  1332. cpu_buffer->head = cpu_buffer->tail = cpu_buffer->reader = 0;
  1333. cpu_buffer->overrun = 0;
  1334. cpu_buffer->entries = 0;
  1335. }
  1336. /**
  1337. * ring_buffer_reset_cpu - reset a ring buffer per CPU buffer
  1338. * @buffer: The ring buffer to reset a per cpu buffer of
  1339. * @cpu: The CPU buffer to be reset
  1340. */
  1341. void ring_buffer_reset_cpu(struct ring_buffer *buffer, int cpu)
  1342. {
  1343. struct ring_buffer_per_cpu *cpu_buffer = buffer->buffers[cpu];
  1344. unsigned long flags;
  1345. if (!cpu_isset(cpu, buffer->cpumask))
  1346. return;
  1347. spin_lock_irqsave(&cpu_buffer->lock, flags);
  1348. rb_reset_cpu(cpu_buffer);
  1349. spin_unlock_irqrestore(&cpu_buffer->lock, flags);
  1350. }
  1351. /**
  1352. * ring_buffer_reset - reset a ring buffer
  1353. * @buffer: The ring buffer to reset all cpu buffers
  1354. */
  1355. void ring_buffer_reset(struct ring_buffer *buffer)
  1356. {
  1357. int cpu;
  1358. for_each_buffer_cpu(buffer, cpu)
  1359. ring_buffer_reset_cpu(buffer, cpu);
  1360. }
  1361. /**
  1362. * rind_buffer_empty - is the ring buffer empty?
  1363. * @buffer: The ring buffer to test
  1364. */
  1365. int ring_buffer_empty(struct ring_buffer *buffer)
  1366. {
  1367. struct ring_buffer_per_cpu *cpu_buffer;
  1368. int cpu;
  1369. /* yes this is racy, but if you don't like the race, lock the buffer */
  1370. for_each_buffer_cpu(buffer, cpu) {
  1371. cpu_buffer = buffer->buffers[cpu];
  1372. if (!rb_per_cpu_empty(cpu_buffer))
  1373. return 0;
  1374. }
  1375. return 1;
  1376. }
  1377. /**
  1378. * ring_buffer_empty_cpu - is a cpu buffer of a ring buffer empty?
  1379. * @buffer: The ring buffer
  1380. * @cpu: The CPU buffer to test
  1381. */
  1382. int ring_buffer_empty_cpu(struct ring_buffer *buffer, int cpu)
  1383. {
  1384. struct ring_buffer_per_cpu *cpu_buffer;
  1385. if (!cpu_isset(cpu, buffer->cpumask))
  1386. return 1;
  1387. cpu_buffer = buffer->buffers[cpu];
  1388. return rb_per_cpu_empty(cpu_buffer);
  1389. }
  1390. /**
  1391. * ring_buffer_swap_cpu - swap a CPU buffer between two ring buffers
  1392. * @buffer_a: One buffer to swap with
  1393. * @buffer_b: The other buffer to swap with
  1394. *
  1395. * This function is useful for tracers that want to take a "snapshot"
  1396. * of a CPU buffer and has another back up buffer lying around.
  1397. * it is expected that the tracer handles the cpu buffer not being
  1398. * used at the moment.
  1399. */
  1400. int ring_buffer_swap_cpu(struct ring_buffer *buffer_a,
  1401. struct ring_buffer *buffer_b, int cpu)
  1402. {
  1403. struct ring_buffer_per_cpu *cpu_buffer_a;
  1404. struct ring_buffer_per_cpu *cpu_buffer_b;
  1405. if (!cpu_isset(cpu, buffer_a->cpumask) ||
  1406. !cpu_isset(cpu, buffer_b->cpumask))
  1407. return -EINVAL;
  1408. /* At least make sure the two buffers are somewhat the same */
  1409. if (buffer_a->size != buffer_b->size ||
  1410. buffer_a->pages != buffer_b->pages)
  1411. return -EINVAL;
  1412. cpu_buffer_a = buffer_a->buffers[cpu];
  1413. cpu_buffer_b = buffer_b->buffers[cpu];
  1414. /*
  1415. * We can't do a synchronize_sched here because this
  1416. * function can be called in atomic context.
  1417. * Normally this will be called from the same CPU as cpu.
  1418. * If not it's up to the caller to protect this.
  1419. */
  1420. atomic_inc(&cpu_buffer_a->record_disabled);
  1421. atomic_inc(&cpu_buffer_b->record_disabled);
  1422. buffer_a->buffers[cpu] = cpu_buffer_b;
  1423. buffer_b->buffers[cpu] = cpu_buffer_a;
  1424. cpu_buffer_b->buffer = buffer_a;
  1425. cpu_buffer_a->buffer = buffer_b;
  1426. atomic_dec(&cpu_buffer_a->record_disabled);
  1427. atomic_dec(&cpu_buffer_b->record_disabled);
  1428. return 0;
  1429. }