ring_buffer.c 53 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220
  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. #include "trace.h"
  19. /* Global flag to disable all recording to ring buffers */
  20. static int ring_buffers_off __read_mostly;
  21. /**
  22. * tracing_on - enable all tracing buffers
  23. *
  24. * This function enables all tracing buffers that may have been
  25. * disabled with tracing_off.
  26. */
  27. void tracing_on(void)
  28. {
  29. ring_buffers_off = 0;
  30. }
  31. EXPORT_SYMBOL_GPL(tracing_on);
  32. /**
  33. * tracing_off - turn off all tracing buffers
  34. *
  35. * This function stops all tracing buffers from recording data.
  36. * It does not disable any overhead the tracers themselves may
  37. * be causing. This function simply causes all recording to
  38. * the ring buffers to fail.
  39. */
  40. void tracing_off(void)
  41. {
  42. ring_buffers_off = 1;
  43. }
  44. EXPORT_SYMBOL_GPL(tracing_off);
  45. /* Up this if you want to test the TIME_EXTENTS and normalization */
  46. #define DEBUG_SHIFT 0
  47. /* FIXME!!! */
  48. u64 ring_buffer_time_stamp(int cpu)
  49. {
  50. u64 time;
  51. preempt_disable_notrace();
  52. /* shift to debug/test normalization and TIME_EXTENTS */
  53. time = sched_clock() << DEBUG_SHIFT;
  54. preempt_enable_notrace();
  55. return time;
  56. }
  57. EXPORT_SYMBOL_GPL(ring_buffer_time_stamp);
  58. void ring_buffer_normalize_time_stamp(int cpu, u64 *ts)
  59. {
  60. /* Just stupid testing the normalize function and deltas */
  61. *ts >>= DEBUG_SHIFT;
  62. }
  63. EXPORT_SYMBOL_GPL(ring_buffer_normalize_time_stamp);
  64. #define RB_EVNT_HDR_SIZE (sizeof(struct ring_buffer_event))
  65. #define RB_ALIGNMENT_SHIFT 2
  66. #define RB_ALIGNMENT (1 << RB_ALIGNMENT_SHIFT)
  67. #define RB_MAX_SMALL_DATA 28
  68. enum {
  69. RB_LEN_TIME_EXTEND = 8,
  70. RB_LEN_TIME_STAMP = 16,
  71. };
  72. /* inline for ring buffer fast paths */
  73. static inline unsigned
  74. rb_event_length(struct ring_buffer_event *event)
  75. {
  76. unsigned length;
  77. switch (event->type) {
  78. case RINGBUF_TYPE_PADDING:
  79. /* undefined */
  80. return -1;
  81. case RINGBUF_TYPE_TIME_EXTEND:
  82. return RB_LEN_TIME_EXTEND;
  83. case RINGBUF_TYPE_TIME_STAMP:
  84. return RB_LEN_TIME_STAMP;
  85. case RINGBUF_TYPE_DATA:
  86. if (event->len)
  87. length = event->len << RB_ALIGNMENT_SHIFT;
  88. else
  89. length = event->array[0];
  90. return length + RB_EVNT_HDR_SIZE;
  91. default:
  92. BUG();
  93. }
  94. /* not hit */
  95. return 0;
  96. }
  97. /**
  98. * ring_buffer_event_length - return the length of the event
  99. * @event: the event to get the length of
  100. */
  101. unsigned ring_buffer_event_length(struct ring_buffer_event *event)
  102. {
  103. return rb_event_length(event);
  104. }
  105. EXPORT_SYMBOL_GPL(ring_buffer_event_length);
  106. /* inline for ring buffer fast paths */
  107. static inline void *
  108. rb_event_data(struct ring_buffer_event *event)
  109. {
  110. BUG_ON(event->type != RINGBUF_TYPE_DATA);
  111. /* If length is in len field, then array[0] has the data */
  112. if (event->len)
  113. return (void *)&event->array[0];
  114. /* Otherwise length is in array[0] and array[1] has the data */
  115. return (void *)&event->array[1];
  116. }
  117. /**
  118. * ring_buffer_event_data - return the data of the event
  119. * @event: the event to get the data from
  120. */
  121. void *ring_buffer_event_data(struct ring_buffer_event *event)
  122. {
  123. return rb_event_data(event);
  124. }
  125. EXPORT_SYMBOL_GPL(ring_buffer_event_data);
  126. #define for_each_buffer_cpu(buffer, cpu) \
  127. for_each_cpu_mask(cpu, buffer->cpumask)
  128. #define TS_SHIFT 27
  129. #define TS_MASK ((1ULL << TS_SHIFT) - 1)
  130. #define TS_DELTA_TEST (~TS_MASK)
  131. /*
  132. * This hack stolen from mm/slob.c.
  133. * We can store per page timing information in the page frame of the page.
  134. * Thanks to Peter Zijlstra for suggesting this idea.
  135. */
  136. struct buffer_page {
  137. u64 time_stamp; /* page time stamp */
  138. local_t write; /* index for next write */
  139. local_t commit; /* write commited index */
  140. unsigned read; /* index for next read */
  141. struct list_head list; /* list of free pages */
  142. void *page; /* Actual data page */
  143. };
  144. /*
  145. * Also stolen from mm/slob.c. Thanks to Mathieu Desnoyers for pointing
  146. * this issue out.
  147. */
  148. static inline void free_buffer_page(struct buffer_page *bpage)
  149. {
  150. if (bpage->page)
  151. free_page((unsigned long)bpage->page);
  152. kfree(bpage);
  153. }
  154. /*
  155. * We need to fit the time_stamp delta into 27 bits.
  156. */
  157. static inline int test_time_stamp(u64 delta)
  158. {
  159. if (delta & TS_DELTA_TEST)
  160. return 1;
  161. return 0;
  162. }
  163. #define BUF_PAGE_SIZE PAGE_SIZE
  164. /*
  165. * head_page == tail_page && head == tail then buffer is empty.
  166. */
  167. struct ring_buffer_per_cpu {
  168. int cpu;
  169. struct ring_buffer *buffer;
  170. spinlock_t lock;
  171. struct lock_class_key lock_key;
  172. struct list_head pages;
  173. struct buffer_page *head_page; /* read from head */
  174. struct buffer_page *tail_page; /* write to tail */
  175. struct buffer_page *commit_page; /* commited pages */
  176. struct buffer_page *reader_page;
  177. unsigned long overrun;
  178. unsigned long entries;
  179. u64 write_stamp;
  180. u64 read_stamp;
  181. atomic_t record_disabled;
  182. };
  183. struct ring_buffer {
  184. unsigned long size;
  185. unsigned pages;
  186. unsigned flags;
  187. int cpus;
  188. cpumask_t cpumask;
  189. atomic_t record_disabled;
  190. struct mutex mutex;
  191. struct ring_buffer_per_cpu **buffers;
  192. };
  193. struct ring_buffer_iter {
  194. struct ring_buffer_per_cpu *cpu_buffer;
  195. unsigned long head;
  196. struct buffer_page *head_page;
  197. u64 read_stamp;
  198. };
  199. #define RB_WARN_ON(buffer, cond) \
  200. do { \
  201. if (unlikely(cond)) { \
  202. atomic_inc(&buffer->record_disabled); \
  203. WARN_ON(1); \
  204. } \
  205. } while (0)
  206. #define RB_WARN_ON_RET(buffer, cond) \
  207. do { \
  208. if (unlikely(cond)) { \
  209. atomic_inc(&buffer->record_disabled); \
  210. WARN_ON(1); \
  211. return -1; \
  212. } \
  213. } while (0)
  214. #define RB_WARN_ON_ONCE(buffer, cond) \
  215. do { \
  216. static int once; \
  217. if (unlikely(cond) && !once) { \
  218. once++; \
  219. atomic_inc(&buffer->record_disabled); \
  220. WARN_ON(1); \
  221. } \
  222. } while (0)
  223. /**
  224. * check_pages - integrity check of buffer pages
  225. * @cpu_buffer: CPU buffer with pages to test
  226. *
  227. * As a safty measure we check to make sure the data pages have not
  228. * been corrupted.
  229. */
  230. static int rb_check_pages(struct ring_buffer_per_cpu *cpu_buffer)
  231. {
  232. struct list_head *head = &cpu_buffer->pages;
  233. struct buffer_page *page, *tmp;
  234. RB_WARN_ON_RET(cpu_buffer, head->next->prev != head);
  235. RB_WARN_ON_RET(cpu_buffer, head->prev->next != head);
  236. list_for_each_entry_safe(page, tmp, head, list) {
  237. RB_WARN_ON_RET(cpu_buffer,
  238. page->list.next->prev != &page->list);
  239. RB_WARN_ON_RET(cpu_buffer,
  240. page->list.prev->next != &page->list);
  241. }
  242. return 0;
  243. }
  244. static int rb_allocate_pages(struct ring_buffer_per_cpu *cpu_buffer,
  245. unsigned nr_pages)
  246. {
  247. struct list_head *head = &cpu_buffer->pages;
  248. struct buffer_page *page, *tmp;
  249. unsigned long addr;
  250. LIST_HEAD(pages);
  251. unsigned i;
  252. for (i = 0; i < nr_pages; i++) {
  253. page = kzalloc_node(ALIGN(sizeof(*page), cache_line_size()),
  254. GFP_KERNEL, cpu_to_node(cpu_buffer->cpu));
  255. if (!page)
  256. goto free_pages;
  257. list_add(&page->list, &pages);
  258. addr = __get_free_page(GFP_KERNEL);
  259. if (!addr)
  260. goto free_pages;
  261. page->page = (void *)addr;
  262. }
  263. list_splice(&pages, head);
  264. rb_check_pages(cpu_buffer);
  265. return 0;
  266. free_pages:
  267. list_for_each_entry_safe(page, tmp, &pages, list) {
  268. list_del_init(&page->list);
  269. free_buffer_page(page);
  270. }
  271. return -ENOMEM;
  272. }
  273. static struct ring_buffer_per_cpu *
  274. rb_allocate_cpu_buffer(struct ring_buffer *buffer, int cpu)
  275. {
  276. struct ring_buffer_per_cpu *cpu_buffer;
  277. struct buffer_page *page;
  278. unsigned long addr;
  279. int ret;
  280. cpu_buffer = kzalloc_node(ALIGN(sizeof(*cpu_buffer), cache_line_size()),
  281. GFP_KERNEL, cpu_to_node(cpu));
  282. if (!cpu_buffer)
  283. return NULL;
  284. cpu_buffer->cpu = cpu;
  285. cpu_buffer->buffer = buffer;
  286. spin_lock_init(&cpu_buffer->lock);
  287. INIT_LIST_HEAD(&cpu_buffer->pages);
  288. page = kzalloc_node(ALIGN(sizeof(*page), cache_line_size()),
  289. GFP_KERNEL, cpu_to_node(cpu));
  290. if (!page)
  291. goto fail_free_buffer;
  292. cpu_buffer->reader_page = page;
  293. addr = __get_free_page(GFP_KERNEL);
  294. if (!addr)
  295. goto fail_free_reader;
  296. page->page = (void *)addr;
  297. INIT_LIST_HEAD(&cpu_buffer->reader_page->list);
  298. ret = rb_allocate_pages(cpu_buffer, buffer->pages);
  299. if (ret < 0)
  300. goto fail_free_reader;
  301. cpu_buffer->head_page
  302. = list_entry(cpu_buffer->pages.next, struct buffer_page, list);
  303. cpu_buffer->tail_page = cpu_buffer->commit_page = cpu_buffer->head_page;
  304. return cpu_buffer;
  305. fail_free_reader:
  306. free_buffer_page(cpu_buffer->reader_page);
  307. fail_free_buffer:
  308. kfree(cpu_buffer);
  309. return NULL;
  310. }
  311. static void rb_free_cpu_buffer(struct ring_buffer_per_cpu *cpu_buffer)
  312. {
  313. struct list_head *head = &cpu_buffer->pages;
  314. struct buffer_page *page, *tmp;
  315. list_del_init(&cpu_buffer->reader_page->list);
  316. free_buffer_page(cpu_buffer->reader_page);
  317. list_for_each_entry_safe(page, tmp, head, list) {
  318. list_del_init(&page->list);
  319. free_buffer_page(page);
  320. }
  321. kfree(cpu_buffer);
  322. }
  323. /*
  324. * Causes compile errors if the struct buffer_page gets bigger
  325. * than the struct page.
  326. */
  327. extern int ring_buffer_page_too_big(void);
  328. /**
  329. * ring_buffer_alloc - allocate a new ring_buffer
  330. * @size: the size in bytes per cpu that is needed.
  331. * @flags: attributes to set for the ring buffer.
  332. *
  333. * Currently the only flag that is available is the RB_FL_OVERWRITE
  334. * flag. This flag means that the buffer will overwrite old data
  335. * when the buffer wraps. If this flag is not set, the buffer will
  336. * drop data when the tail hits the head.
  337. */
  338. struct ring_buffer *ring_buffer_alloc(unsigned long size, unsigned flags)
  339. {
  340. struct ring_buffer *buffer;
  341. int bsize;
  342. int cpu;
  343. /* Paranoid! Optimizes out when all is well */
  344. if (sizeof(struct buffer_page) > sizeof(struct page))
  345. ring_buffer_page_too_big();
  346. /* keep it in its own cache line */
  347. buffer = kzalloc(ALIGN(sizeof(*buffer), cache_line_size()),
  348. GFP_KERNEL);
  349. if (!buffer)
  350. return NULL;
  351. buffer->pages = DIV_ROUND_UP(size, BUF_PAGE_SIZE);
  352. buffer->flags = flags;
  353. /* need at least two pages */
  354. if (buffer->pages == 1)
  355. buffer->pages++;
  356. buffer->cpumask = cpu_possible_map;
  357. buffer->cpus = nr_cpu_ids;
  358. bsize = sizeof(void *) * nr_cpu_ids;
  359. buffer->buffers = kzalloc(ALIGN(bsize, cache_line_size()),
  360. GFP_KERNEL);
  361. if (!buffer->buffers)
  362. goto fail_free_buffer;
  363. for_each_buffer_cpu(buffer, cpu) {
  364. buffer->buffers[cpu] =
  365. rb_allocate_cpu_buffer(buffer, cpu);
  366. if (!buffer->buffers[cpu])
  367. goto fail_free_buffers;
  368. }
  369. mutex_init(&buffer->mutex);
  370. return buffer;
  371. fail_free_buffers:
  372. for_each_buffer_cpu(buffer, cpu) {
  373. if (buffer->buffers[cpu])
  374. rb_free_cpu_buffer(buffer->buffers[cpu]);
  375. }
  376. kfree(buffer->buffers);
  377. fail_free_buffer:
  378. kfree(buffer);
  379. return NULL;
  380. }
  381. EXPORT_SYMBOL_GPL(ring_buffer_alloc);
  382. /**
  383. * ring_buffer_free - free a ring buffer.
  384. * @buffer: the buffer to free.
  385. */
  386. void
  387. ring_buffer_free(struct ring_buffer *buffer)
  388. {
  389. int cpu;
  390. for_each_buffer_cpu(buffer, cpu)
  391. rb_free_cpu_buffer(buffer->buffers[cpu]);
  392. kfree(buffer);
  393. }
  394. EXPORT_SYMBOL_GPL(ring_buffer_free);
  395. static void rb_reset_cpu(struct ring_buffer_per_cpu *cpu_buffer);
  396. static void
  397. rb_remove_pages(struct ring_buffer_per_cpu *cpu_buffer, unsigned nr_pages)
  398. {
  399. struct buffer_page *page;
  400. struct list_head *p;
  401. unsigned i;
  402. atomic_inc(&cpu_buffer->record_disabled);
  403. synchronize_sched();
  404. for (i = 0; i < nr_pages; i++) {
  405. BUG_ON(list_empty(&cpu_buffer->pages));
  406. p = cpu_buffer->pages.next;
  407. page = list_entry(p, struct buffer_page, list);
  408. list_del_init(&page->list);
  409. free_buffer_page(page);
  410. }
  411. BUG_ON(list_empty(&cpu_buffer->pages));
  412. rb_reset_cpu(cpu_buffer);
  413. rb_check_pages(cpu_buffer);
  414. atomic_dec(&cpu_buffer->record_disabled);
  415. }
  416. static void
  417. rb_insert_pages(struct ring_buffer_per_cpu *cpu_buffer,
  418. struct list_head *pages, unsigned nr_pages)
  419. {
  420. struct buffer_page *page;
  421. struct list_head *p;
  422. unsigned i;
  423. atomic_inc(&cpu_buffer->record_disabled);
  424. synchronize_sched();
  425. for (i = 0; i < nr_pages; i++) {
  426. BUG_ON(list_empty(pages));
  427. p = pages->next;
  428. page = list_entry(p, struct buffer_page, list);
  429. list_del_init(&page->list);
  430. list_add_tail(&page->list, &cpu_buffer->pages);
  431. }
  432. rb_reset_cpu(cpu_buffer);
  433. rb_check_pages(cpu_buffer);
  434. atomic_dec(&cpu_buffer->record_disabled);
  435. }
  436. /**
  437. * ring_buffer_resize - resize the ring buffer
  438. * @buffer: the buffer to resize.
  439. * @size: the new size.
  440. *
  441. * The tracer is responsible for making sure that the buffer is
  442. * not being used while changing the size.
  443. * Note: We may be able to change the above requirement by using
  444. * RCU synchronizations.
  445. *
  446. * Minimum size is 2 * BUF_PAGE_SIZE.
  447. *
  448. * Returns -1 on failure.
  449. */
  450. int ring_buffer_resize(struct ring_buffer *buffer, unsigned long size)
  451. {
  452. struct ring_buffer_per_cpu *cpu_buffer;
  453. unsigned nr_pages, rm_pages, new_pages;
  454. struct buffer_page *page, *tmp;
  455. unsigned long buffer_size;
  456. unsigned long addr;
  457. LIST_HEAD(pages);
  458. int i, cpu;
  459. /*
  460. * Always succeed at resizing a non-existent buffer:
  461. */
  462. if (!buffer)
  463. return size;
  464. size = DIV_ROUND_UP(size, BUF_PAGE_SIZE);
  465. size *= BUF_PAGE_SIZE;
  466. buffer_size = buffer->pages * BUF_PAGE_SIZE;
  467. /* we need a minimum of two pages */
  468. if (size < BUF_PAGE_SIZE * 2)
  469. size = BUF_PAGE_SIZE * 2;
  470. if (size == buffer_size)
  471. return size;
  472. mutex_lock(&buffer->mutex);
  473. nr_pages = DIV_ROUND_UP(size, BUF_PAGE_SIZE);
  474. if (size < buffer_size) {
  475. /* easy case, just free pages */
  476. BUG_ON(nr_pages >= buffer->pages);
  477. rm_pages = buffer->pages - nr_pages;
  478. for_each_buffer_cpu(buffer, cpu) {
  479. cpu_buffer = buffer->buffers[cpu];
  480. rb_remove_pages(cpu_buffer, rm_pages);
  481. }
  482. goto out;
  483. }
  484. /*
  485. * This is a bit more difficult. We only want to add pages
  486. * when we can allocate enough for all CPUs. We do this
  487. * by allocating all the pages and storing them on a local
  488. * link list. If we succeed in our allocation, then we
  489. * add these pages to the cpu_buffers. Otherwise we just free
  490. * them all and return -ENOMEM;
  491. */
  492. BUG_ON(nr_pages <= buffer->pages);
  493. new_pages = nr_pages - buffer->pages;
  494. for_each_buffer_cpu(buffer, cpu) {
  495. for (i = 0; i < new_pages; i++) {
  496. page = kzalloc_node(ALIGN(sizeof(*page),
  497. cache_line_size()),
  498. GFP_KERNEL, cpu_to_node(cpu));
  499. if (!page)
  500. goto free_pages;
  501. list_add(&page->list, &pages);
  502. addr = __get_free_page(GFP_KERNEL);
  503. if (!addr)
  504. goto free_pages;
  505. page->page = (void *)addr;
  506. }
  507. }
  508. for_each_buffer_cpu(buffer, cpu) {
  509. cpu_buffer = buffer->buffers[cpu];
  510. rb_insert_pages(cpu_buffer, &pages, new_pages);
  511. }
  512. BUG_ON(!list_empty(&pages));
  513. out:
  514. buffer->pages = nr_pages;
  515. mutex_unlock(&buffer->mutex);
  516. return size;
  517. free_pages:
  518. list_for_each_entry_safe(page, tmp, &pages, list) {
  519. list_del_init(&page->list);
  520. free_buffer_page(page);
  521. }
  522. mutex_unlock(&buffer->mutex);
  523. return -ENOMEM;
  524. }
  525. EXPORT_SYMBOL_GPL(ring_buffer_resize);
  526. static inline int rb_null_event(struct ring_buffer_event *event)
  527. {
  528. return event->type == RINGBUF_TYPE_PADDING;
  529. }
  530. static inline void *__rb_page_index(struct buffer_page *page, unsigned index)
  531. {
  532. return page->page + index;
  533. }
  534. static inline struct ring_buffer_event *
  535. rb_reader_event(struct ring_buffer_per_cpu *cpu_buffer)
  536. {
  537. return __rb_page_index(cpu_buffer->reader_page,
  538. cpu_buffer->reader_page->read);
  539. }
  540. static inline struct ring_buffer_event *
  541. rb_head_event(struct ring_buffer_per_cpu *cpu_buffer)
  542. {
  543. return __rb_page_index(cpu_buffer->head_page,
  544. cpu_buffer->head_page->read);
  545. }
  546. static inline struct ring_buffer_event *
  547. rb_iter_head_event(struct ring_buffer_iter *iter)
  548. {
  549. return __rb_page_index(iter->head_page, iter->head);
  550. }
  551. static inline unsigned rb_page_write(struct buffer_page *bpage)
  552. {
  553. return local_read(&bpage->write);
  554. }
  555. static inline unsigned rb_page_commit(struct buffer_page *bpage)
  556. {
  557. return local_read(&bpage->commit);
  558. }
  559. /* Size is determined by what has been commited */
  560. static inline unsigned rb_page_size(struct buffer_page *bpage)
  561. {
  562. return rb_page_commit(bpage);
  563. }
  564. static inline unsigned
  565. rb_commit_index(struct ring_buffer_per_cpu *cpu_buffer)
  566. {
  567. return rb_page_commit(cpu_buffer->commit_page);
  568. }
  569. static inline unsigned rb_head_size(struct ring_buffer_per_cpu *cpu_buffer)
  570. {
  571. return rb_page_commit(cpu_buffer->head_page);
  572. }
  573. /*
  574. * When the tail hits the head and the buffer is in overwrite mode,
  575. * the head jumps to the next page and all content on the previous
  576. * page is discarded. But before doing so, we update the overrun
  577. * variable of the buffer.
  578. */
  579. static void rb_update_overflow(struct ring_buffer_per_cpu *cpu_buffer)
  580. {
  581. struct ring_buffer_event *event;
  582. unsigned long head;
  583. for (head = 0; head < rb_head_size(cpu_buffer);
  584. head += rb_event_length(event)) {
  585. event = __rb_page_index(cpu_buffer->head_page, head);
  586. BUG_ON(rb_null_event(event));
  587. /* Only count data entries */
  588. if (event->type != RINGBUF_TYPE_DATA)
  589. continue;
  590. cpu_buffer->overrun++;
  591. cpu_buffer->entries--;
  592. }
  593. }
  594. static inline void rb_inc_page(struct ring_buffer_per_cpu *cpu_buffer,
  595. struct buffer_page **page)
  596. {
  597. struct list_head *p = (*page)->list.next;
  598. if (p == &cpu_buffer->pages)
  599. p = p->next;
  600. *page = list_entry(p, struct buffer_page, list);
  601. }
  602. static inline unsigned
  603. rb_event_index(struct ring_buffer_event *event)
  604. {
  605. unsigned long addr = (unsigned long)event;
  606. return (addr & ~PAGE_MASK) - (PAGE_SIZE - BUF_PAGE_SIZE);
  607. }
  608. static inline int
  609. rb_is_commit(struct ring_buffer_per_cpu *cpu_buffer,
  610. struct ring_buffer_event *event)
  611. {
  612. unsigned long addr = (unsigned long)event;
  613. unsigned long index;
  614. index = rb_event_index(event);
  615. addr &= PAGE_MASK;
  616. return cpu_buffer->commit_page->page == (void *)addr &&
  617. rb_commit_index(cpu_buffer) == index;
  618. }
  619. static inline void
  620. rb_set_commit_event(struct ring_buffer_per_cpu *cpu_buffer,
  621. struct ring_buffer_event *event)
  622. {
  623. unsigned long addr = (unsigned long)event;
  624. unsigned long index;
  625. index = rb_event_index(event);
  626. addr &= PAGE_MASK;
  627. while (cpu_buffer->commit_page->page != (void *)addr) {
  628. RB_WARN_ON(cpu_buffer,
  629. cpu_buffer->commit_page == cpu_buffer->tail_page);
  630. cpu_buffer->commit_page->commit =
  631. cpu_buffer->commit_page->write;
  632. rb_inc_page(cpu_buffer, &cpu_buffer->commit_page);
  633. cpu_buffer->write_stamp = cpu_buffer->commit_page->time_stamp;
  634. }
  635. /* Now set the commit to the event's index */
  636. local_set(&cpu_buffer->commit_page->commit, index);
  637. }
  638. static inline void
  639. rb_set_commit_to_write(struct ring_buffer_per_cpu *cpu_buffer)
  640. {
  641. /*
  642. * We only race with interrupts and NMIs on this CPU.
  643. * If we own the commit event, then we can commit
  644. * all others that interrupted us, since the interruptions
  645. * are in stack format (they finish before they come
  646. * back to us). This allows us to do a simple loop to
  647. * assign the commit to the tail.
  648. */
  649. while (cpu_buffer->commit_page != cpu_buffer->tail_page) {
  650. cpu_buffer->commit_page->commit =
  651. cpu_buffer->commit_page->write;
  652. rb_inc_page(cpu_buffer, &cpu_buffer->commit_page);
  653. cpu_buffer->write_stamp = cpu_buffer->commit_page->time_stamp;
  654. /* add barrier to keep gcc from optimizing too much */
  655. barrier();
  656. }
  657. while (rb_commit_index(cpu_buffer) !=
  658. rb_page_write(cpu_buffer->commit_page)) {
  659. cpu_buffer->commit_page->commit =
  660. cpu_buffer->commit_page->write;
  661. barrier();
  662. }
  663. }
  664. static void rb_reset_reader_page(struct ring_buffer_per_cpu *cpu_buffer)
  665. {
  666. cpu_buffer->read_stamp = cpu_buffer->reader_page->time_stamp;
  667. cpu_buffer->reader_page->read = 0;
  668. }
  669. static inline void rb_inc_iter(struct ring_buffer_iter *iter)
  670. {
  671. struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;
  672. /*
  673. * The iterator could be on the reader page (it starts there).
  674. * But the head could have moved, since the reader was
  675. * found. Check for this case and assign the iterator
  676. * to the head page instead of next.
  677. */
  678. if (iter->head_page == cpu_buffer->reader_page)
  679. iter->head_page = cpu_buffer->head_page;
  680. else
  681. rb_inc_page(cpu_buffer, &iter->head_page);
  682. iter->read_stamp = iter->head_page->time_stamp;
  683. iter->head = 0;
  684. }
  685. /**
  686. * ring_buffer_update_event - update event type and data
  687. * @event: the even to update
  688. * @type: the type of event
  689. * @length: the size of the event field in the ring buffer
  690. *
  691. * Update the type and data fields of the event. The length
  692. * is the actual size that is written to the ring buffer,
  693. * and with this, we can determine what to place into the
  694. * data field.
  695. */
  696. static inline void
  697. rb_update_event(struct ring_buffer_event *event,
  698. unsigned type, unsigned length)
  699. {
  700. event->type = type;
  701. switch (type) {
  702. case RINGBUF_TYPE_PADDING:
  703. break;
  704. case RINGBUF_TYPE_TIME_EXTEND:
  705. event->len =
  706. (RB_LEN_TIME_EXTEND + (RB_ALIGNMENT-1))
  707. >> RB_ALIGNMENT_SHIFT;
  708. break;
  709. case RINGBUF_TYPE_TIME_STAMP:
  710. event->len =
  711. (RB_LEN_TIME_STAMP + (RB_ALIGNMENT-1))
  712. >> RB_ALIGNMENT_SHIFT;
  713. break;
  714. case RINGBUF_TYPE_DATA:
  715. length -= RB_EVNT_HDR_SIZE;
  716. if (length > RB_MAX_SMALL_DATA) {
  717. event->len = 0;
  718. event->array[0] = length;
  719. } else
  720. event->len =
  721. (length + (RB_ALIGNMENT-1))
  722. >> RB_ALIGNMENT_SHIFT;
  723. break;
  724. default:
  725. BUG();
  726. }
  727. }
  728. static inline unsigned rb_calculate_event_length(unsigned length)
  729. {
  730. struct ring_buffer_event event; /* Used only for sizeof array */
  731. /* zero length can cause confusions */
  732. if (!length)
  733. length = 1;
  734. if (length > RB_MAX_SMALL_DATA)
  735. length += sizeof(event.array[0]);
  736. length += RB_EVNT_HDR_SIZE;
  737. length = ALIGN(length, RB_ALIGNMENT);
  738. return length;
  739. }
  740. static struct ring_buffer_event *
  741. __rb_reserve_next(struct ring_buffer_per_cpu *cpu_buffer,
  742. unsigned type, unsigned long length, u64 *ts)
  743. {
  744. struct buffer_page *tail_page, *head_page, *reader_page;
  745. unsigned long tail, write;
  746. struct ring_buffer *buffer = cpu_buffer->buffer;
  747. struct ring_buffer_event *event;
  748. unsigned long flags;
  749. tail_page = cpu_buffer->tail_page;
  750. write = local_add_return(length, &tail_page->write);
  751. tail = write - length;
  752. /* See if we shot pass the end of this buffer page */
  753. if (write > BUF_PAGE_SIZE) {
  754. struct buffer_page *next_page = tail_page;
  755. spin_lock_irqsave(&cpu_buffer->lock, flags);
  756. rb_inc_page(cpu_buffer, &next_page);
  757. head_page = cpu_buffer->head_page;
  758. reader_page = cpu_buffer->reader_page;
  759. /* we grabbed the lock before incrementing */
  760. RB_WARN_ON(cpu_buffer, next_page == reader_page);
  761. /*
  762. * If for some reason, we had an interrupt storm that made
  763. * it all the way around the buffer, bail, and warn
  764. * about it.
  765. */
  766. if (unlikely(next_page == cpu_buffer->commit_page)) {
  767. WARN_ON_ONCE(1);
  768. goto out_unlock;
  769. }
  770. if (next_page == head_page) {
  771. if (!(buffer->flags & RB_FL_OVERWRITE)) {
  772. /* reset write */
  773. if (tail <= BUF_PAGE_SIZE)
  774. local_set(&tail_page->write, tail);
  775. goto out_unlock;
  776. }
  777. /* tail_page has not moved yet? */
  778. if (tail_page == cpu_buffer->tail_page) {
  779. /* count overflows */
  780. rb_update_overflow(cpu_buffer);
  781. rb_inc_page(cpu_buffer, &head_page);
  782. cpu_buffer->head_page = head_page;
  783. cpu_buffer->head_page->read = 0;
  784. }
  785. }
  786. /*
  787. * If the tail page is still the same as what we think
  788. * it is, then it is up to us to update the tail
  789. * pointer.
  790. */
  791. if (tail_page == cpu_buffer->tail_page) {
  792. local_set(&next_page->write, 0);
  793. local_set(&next_page->commit, 0);
  794. cpu_buffer->tail_page = next_page;
  795. /* reread the time stamp */
  796. *ts = ring_buffer_time_stamp(cpu_buffer->cpu);
  797. cpu_buffer->tail_page->time_stamp = *ts;
  798. }
  799. /*
  800. * The actual tail page has moved forward.
  801. */
  802. if (tail < BUF_PAGE_SIZE) {
  803. /* Mark the rest of the page with padding */
  804. event = __rb_page_index(tail_page, tail);
  805. event->type = RINGBUF_TYPE_PADDING;
  806. }
  807. if (tail <= BUF_PAGE_SIZE)
  808. /* Set the write back to the previous setting */
  809. local_set(&tail_page->write, tail);
  810. /*
  811. * If this was a commit entry that failed,
  812. * increment that too
  813. */
  814. if (tail_page == cpu_buffer->commit_page &&
  815. tail == rb_commit_index(cpu_buffer)) {
  816. rb_set_commit_to_write(cpu_buffer);
  817. }
  818. spin_unlock_irqrestore(&cpu_buffer->lock, flags);
  819. /* fail and let the caller try again */
  820. return ERR_PTR(-EAGAIN);
  821. }
  822. /* We reserved something on the buffer */
  823. BUG_ON(write > BUF_PAGE_SIZE);
  824. event = __rb_page_index(tail_page, tail);
  825. rb_update_event(event, type, length);
  826. /*
  827. * If this is a commit and the tail is zero, then update
  828. * this page's time stamp.
  829. */
  830. if (!tail && rb_is_commit(cpu_buffer, event))
  831. cpu_buffer->commit_page->time_stamp = *ts;
  832. return event;
  833. out_unlock:
  834. spin_unlock_irqrestore(&cpu_buffer->lock, flags);
  835. return NULL;
  836. }
  837. static int
  838. rb_add_time_stamp(struct ring_buffer_per_cpu *cpu_buffer,
  839. u64 *ts, u64 *delta)
  840. {
  841. struct ring_buffer_event *event;
  842. static int once;
  843. int ret;
  844. if (unlikely(*delta > (1ULL << 59) && !once++)) {
  845. printk(KERN_WARNING "Delta way too big! %llu"
  846. " ts=%llu write stamp = %llu\n",
  847. (unsigned long long)*delta,
  848. (unsigned long long)*ts,
  849. (unsigned long long)cpu_buffer->write_stamp);
  850. WARN_ON(1);
  851. }
  852. /*
  853. * The delta is too big, we to add a
  854. * new timestamp.
  855. */
  856. event = __rb_reserve_next(cpu_buffer,
  857. RINGBUF_TYPE_TIME_EXTEND,
  858. RB_LEN_TIME_EXTEND,
  859. ts);
  860. if (!event)
  861. return -EBUSY;
  862. if (PTR_ERR(event) == -EAGAIN)
  863. return -EAGAIN;
  864. /* Only a commited time event can update the write stamp */
  865. if (rb_is_commit(cpu_buffer, event)) {
  866. /*
  867. * If this is the first on the page, then we need to
  868. * update the page itself, and just put in a zero.
  869. */
  870. if (rb_event_index(event)) {
  871. event->time_delta = *delta & TS_MASK;
  872. event->array[0] = *delta >> TS_SHIFT;
  873. } else {
  874. cpu_buffer->commit_page->time_stamp = *ts;
  875. event->time_delta = 0;
  876. event->array[0] = 0;
  877. }
  878. cpu_buffer->write_stamp = *ts;
  879. /* let the caller know this was the commit */
  880. ret = 1;
  881. } else {
  882. /* Darn, this is just wasted space */
  883. event->time_delta = 0;
  884. event->array[0] = 0;
  885. ret = 0;
  886. }
  887. *delta = 0;
  888. return ret;
  889. }
  890. static struct ring_buffer_event *
  891. rb_reserve_next_event(struct ring_buffer_per_cpu *cpu_buffer,
  892. unsigned type, unsigned long length)
  893. {
  894. struct ring_buffer_event *event;
  895. u64 ts, delta;
  896. int commit = 0;
  897. int nr_loops = 0;
  898. again:
  899. /*
  900. * We allow for interrupts to reenter here and do a trace.
  901. * If one does, it will cause this original code to loop
  902. * back here. Even with heavy interrupts happening, this
  903. * should only happen a few times in a row. If this happens
  904. * 1000 times in a row, there must be either an interrupt
  905. * storm or we have something buggy.
  906. * Bail!
  907. */
  908. if (unlikely(++nr_loops > 1000)) {
  909. RB_WARN_ON(cpu_buffer, 1);
  910. return NULL;
  911. }
  912. ts = ring_buffer_time_stamp(cpu_buffer->cpu);
  913. /*
  914. * Only the first commit can update the timestamp.
  915. * Yes there is a race here. If an interrupt comes in
  916. * just after the conditional and it traces too, then it
  917. * will also check the deltas. More than one timestamp may
  918. * also be made. But only the entry that did the actual
  919. * commit will be something other than zero.
  920. */
  921. if (cpu_buffer->tail_page == cpu_buffer->commit_page &&
  922. rb_page_write(cpu_buffer->tail_page) ==
  923. rb_commit_index(cpu_buffer)) {
  924. delta = ts - cpu_buffer->write_stamp;
  925. /* make sure this delta is calculated here */
  926. barrier();
  927. /* Did the write stamp get updated already? */
  928. if (unlikely(ts < cpu_buffer->write_stamp))
  929. delta = 0;
  930. if (test_time_stamp(delta)) {
  931. commit = rb_add_time_stamp(cpu_buffer, &ts, &delta);
  932. if (commit == -EBUSY)
  933. return NULL;
  934. if (commit == -EAGAIN)
  935. goto again;
  936. RB_WARN_ON(cpu_buffer, commit < 0);
  937. }
  938. } else
  939. /* Non commits have zero deltas */
  940. delta = 0;
  941. event = __rb_reserve_next(cpu_buffer, type, length, &ts);
  942. if (PTR_ERR(event) == -EAGAIN)
  943. goto again;
  944. if (!event) {
  945. if (unlikely(commit))
  946. /*
  947. * Ouch! We needed a timestamp and it was commited. But
  948. * we didn't get our event reserved.
  949. */
  950. rb_set_commit_to_write(cpu_buffer);
  951. return NULL;
  952. }
  953. /*
  954. * If the timestamp was commited, make the commit our entry
  955. * now so that we will update it when needed.
  956. */
  957. if (commit)
  958. rb_set_commit_event(cpu_buffer, event);
  959. else if (!rb_is_commit(cpu_buffer, event))
  960. delta = 0;
  961. event->time_delta = delta;
  962. return event;
  963. }
  964. static DEFINE_PER_CPU(int, rb_need_resched);
  965. /**
  966. * ring_buffer_lock_reserve - reserve a part of the buffer
  967. * @buffer: the ring buffer to reserve from
  968. * @length: the length of the data to reserve (excluding event header)
  969. * @flags: a pointer to save the interrupt flags
  970. *
  971. * Returns a reseverd event on the ring buffer to copy directly to.
  972. * The user of this interface will need to get the body to write into
  973. * and can use the ring_buffer_event_data() interface.
  974. *
  975. * The length is the length of the data needed, not the event length
  976. * which also includes the event header.
  977. *
  978. * Must be paired with ring_buffer_unlock_commit, unless NULL is returned.
  979. * If NULL is returned, then nothing has been allocated or locked.
  980. */
  981. struct ring_buffer_event *
  982. ring_buffer_lock_reserve(struct ring_buffer *buffer,
  983. unsigned long length,
  984. unsigned long *flags)
  985. {
  986. struct ring_buffer_per_cpu *cpu_buffer;
  987. struct ring_buffer_event *event;
  988. int cpu, resched;
  989. if (ring_buffers_off)
  990. return NULL;
  991. if (atomic_read(&buffer->record_disabled))
  992. return NULL;
  993. /* If we are tracing schedule, we don't want to recurse */
  994. resched = need_resched();
  995. preempt_disable_notrace();
  996. cpu = raw_smp_processor_id();
  997. if (!cpu_isset(cpu, buffer->cpumask))
  998. goto out;
  999. cpu_buffer = buffer->buffers[cpu];
  1000. if (atomic_read(&cpu_buffer->record_disabled))
  1001. goto out;
  1002. length = rb_calculate_event_length(length);
  1003. if (length > BUF_PAGE_SIZE)
  1004. goto out;
  1005. event = rb_reserve_next_event(cpu_buffer, RINGBUF_TYPE_DATA, length);
  1006. if (!event)
  1007. goto out;
  1008. /*
  1009. * Need to store resched state on this cpu.
  1010. * Only the first needs to.
  1011. */
  1012. if (preempt_count() == 1)
  1013. per_cpu(rb_need_resched, cpu) = resched;
  1014. return event;
  1015. out:
  1016. if (resched)
  1017. preempt_enable_no_resched_notrace();
  1018. else
  1019. preempt_enable_notrace();
  1020. return NULL;
  1021. }
  1022. EXPORT_SYMBOL_GPL(ring_buffer_lock_reserve);
  1023. static void rb_commit(struct ring_buffer_per_cpu *cpu_buffer,
  1024. struct ring_buffer_event *event)
  1025. {
  1026. cpu_buffer->entries++;
  1027. /* Only process further if we own the commit */
  1028. if (!rb_is_commit(cpu_buffer, event))
  1029. return;
  1030. cpu_buffer->write_stamp += event->time_delta;
  1031. rb_set_commit_to_write(cpu_buffer);
  1032. }
  1033. /**
  1034. * ring_buffer_unlock_commit - commit a reserved
  1035. * @buffer: The buffer to commit to
  1036. * @event: The event pointer to commit.
  1037. * @flags: the interrupt flags received from ring_buffer_lock_reserve.
  1038. *
  1039. * This commits the data to the ring buffer, and releases any locks held.
  1040. *
  1041. * Must be paired with ring_buffer_lock_reserve.
  1042. */
  1043. int ring_buffer_unlock_commit(struct ring_buffer *buffer,
  1044. struct ring_buffer_event *event,
  1045. unsigned long flags)
  1046. {
  1047. struct ring_buffer_per_cpu *cpu_buffer;
  1048. int cpu = raw_smp_processor_id();
  1049. cpu_buffer = buffer->buffers[cpu];
  1050. rb_commit(cpu_buffer, event);
  1051. /*
  1052. * Only the last preempt count needs to restore preemption.
  1053. */
  1054. if (preempt_count() == 1) {
  1055. if (per_cpu(rb_need_resched, cpu))
  1056. preempt_enable_no_resched_notrace();
  1057. else
  1058. preempt_enable_notrace();
  1059. } else
  1060. preempt_enable_no_resched_notrace();
  1061. return 0;
  1062. }
  1063. EXPORT_SYMBOL_GPL(ring_buffer_unlock_commit);
  1064. /**
  1065. * ring_buffer_write - write data to the buffer without reserving
  1066. * @buffer: The ring buffer to write to.
  1067. * @length: The length of the data being written (excluding the event header)
  1068. * @data: The data to write to the buffer.
  1069. *
  1070. * This is like ring_buffer_lock_reserve and ring_buffer_unlock_commit as
  1071. * one function. If you already have the data to write to the buffer, it
  1072. * may be easier to simply call this function.
  1073. *
  1074. * Note, like ring_buffer_lock_reserve, the length is the length of the data
  1075. * and not the length of the event which would hold the header.
  1076. */
  1077. int ring_buffer_write(struct ring_buffer *buffer,
  1078. unsigned long length,
  1079. void *data)
  1080. {
  1081. struct ring_buffer_per_cpu *cpu_buffer;
  1082. struct ring_buffer_event *event;
  1083. unsigned long event_length;
  1084. void *body;
  1085. int ret = -EBUSY;
  1086. int cpu, resched;
  1087. if (ring_buffers_off)
  1088. return -EBUSY;
  1089. if (atomic_read(&buffer->record_disabled))
  1090. return -EBUSY;
  1091. resched = need_resched();
  1092. preempt_disable_notrace();
  1093. cpu = raw_smp_processor_id();
  1094. if (!cpu_isset(cpu, buffer->cpumask))
  1095. goto out;
  1096. cpu_buffer = buffer->buffers[cpu];
  1097. if (atomic_read(&cpu_buffer->record_disabled))
  1098. goto out;
  1099. event_length = rb_calculate_event_length(length);
  1100. event = rb_reserve_next_event(cpu_buffer,
  1101. RINGBUF_TYPE_DATA, event_length);
  1102. if (!event)
  1103. goto out;
  1104. body = rb_event_data(event);
  1105. memcpy(body, data, length);
  1106. rb_commit(cpu_buffer, event);
  1107. ret = 0;
  1108. out:
  1109. if (resched)
  1110. preempt_enable_no_resched_notrace();
  1111. else
  1112. preempt_enable_notrace();
  1113. return ret;
  1114. }
  1115. EXPORT_SYMBOL_GPL(ring_buffer_write);
  1116. static inline int rb_per_cpu_empty(struct ring_buffer_per_cpu *cpu_buffer)
  1117. {
  1118. struct buffer_page *reader = cpu_buffer->reader_page;
  1119. struct buffer_page *head = cpu_buffer->head_page;
  1120. struct buffer_page *commit = cpu_buffer->commit_page;
  1121. return reader->read == rb_page_commit(reader) &&
  1122. (commit == reader ||
  1123. (commit == head &&
  1124. head->read == rb_page_commit(commit)));
  1125. }
  1126. /**
  1127. * ring_buffer_record_disable - stop all writes into the buffer
  1128. * @buffer: The ring buffer to stop writes to.
  1129. *
  1130. * This prevents all writes to the buffer. Any attempt to write
  1131. * to the buffer after this will fail and return NULL.
  1132. *
  1133. * The caller should call synchronize_sched() after this.
  1134. */
  1135. void ring_buffer_record_disable(struct ring_buffer *buffer)
  1136. {
  1137. atomic_inc(&buffer->record_disabled);
  1138. }
  1139. EXPORT_SYMBOL_GPL(ring_buffer_record_disable);
  1140. /**
  1141. * ring_buffer_record_enable - enable writes to the buffer
  1142. * @buffer: The ring buffer to enable writes
  1143. *
  1144. * Note, multiple disables will need the same number of enables
  1145. * to truely enable the writing (much like preempt_disable).
  1146. */
  1147. void ring_buffer_record_enable(struct ring_buffer *buffer)
  1148. {
  1149. atomic_dec(&buffer->record_disabled);
  1150. }
  1151. EXPORT_SYMBOL_GPL(ring_buffer_record_enable);
  1152. /**
  1153. * ring_buffer_record_disable_cpu - stop all writes into the cpu_buffer
  1154. * @buffer: The ring buffer to stop writes to.
  1155. * @cpu: The CPU buffer to stop
  1156. *
  1157. * This prevents all writes to the buffer. Any attempt to write
  1158. * to the buffer after this will fail and return NULL.
  1159. *
  1160. * The caller should call synchronize_sched() after this.
  1161. */
  1162. void ring_buffer_record_disable_cpu(struct ring_buffer *buffer, int cpu)
  1163. {
  1164. struct ring_buffer_per_cpu *cpu_buffer;
  1165. if (!cpu_isset(cpu, buffer->cpumask))
  1166. return;
  1167. cpu_buffer = buffer->buffers[cpu];
  1168. atomic_inc(&cpu_buffer->record_disabled);
  1169. }
  1170. EXPORT_SYMBOL_GPL(ring_buffer_record_disable_cpu);
  1171. /**
  1172. * ring_buffer_record_enable_cpu - enable writes to the buffer
  1173. * @buffer: The ring buffer to enable writes
  1174. * @cpu: The CPU to enable.
  1175. *
  1176. * Note, multiple disables will need the same number of enables
  1177. * to truely enable the writing (much like preempt_disable).
  1178. */
  1179. void ring_buffer_record_enable_cpu(struct ring_buffer *buffer, int cpu)
  1180. {
  1181. struct ring_buffer_per_cpu *cpu_buffer;
  1182. if (!cpu_isset(cpu, buffer->cpumask))
  1183. return;
  1184. cpu_buffer = buffer->buffers[cpu];
  1185. atomic_dec(&cpu_buffer->record_disabled);
  1186. }
  1187. EXPORT_SYMBOL_GPL(ring_buffer_record_enable_cpu);
  1188. /**
  1189. * ring_buffer_entries_cpu - get the number of entries in a cpu buffer
  1190. * @buffer: The ring buffer
  1191. * @cpu: The per CPU buffer to get the entries from.
  1192. */
  1193. unsigned long ring_buffer_entries_cpu(struct ring_buffer *buffer, int cpu)
  1194. {
  1195. struct ring_buffer_per_cpu *cpu_buffer;
  1196. if (!cpu_isset(cpu, buffer->cpumask))
  1197. return 0;
  1198. cpu_buffer = buffer->buffers[cpu];
  1199. return cpu_buffer->entries;
  1200. }
  1201. EXPORT_SYMBOL_GPL(ring_buffer_entries_cpu);
  1202. /**
  1203. * ring_buffer_overrun_cpu - get the number of overruns in a cpu_buffer
  1204. * @buffer: The ring buffer
  1205. * @cpu: The per CPU buffer to get the number of overruns from
  1206. */
  1207. unsigned long ring_buffer_overrun_cpu(struct ring_buffer *buffer, int cpu)
  1208. {
  1209. struct ring_buffer_per_cpu *cpu_buffer;
  1210. if (!cpu_isset(cpu, buffer->cpumask))
  1211. return 0;
  1212. cpu_buffer = buffer->buffers[cpu];
  1213. return cpu_buffer->overrun;
  1214. }
  1215. EXPORT_SYMBOL_GPL(ring_buffer_overrun_cpu);
  1216. /**
  1217. * ring_buffer_entries - get the number of entries in a buffer
  1218. * @buffer: The ring buffer
  1219. *
  1220. * Returns the total number of entries in the ring buffer
  1221. * (all CPU entries)
  1222. */
  1223. unsigned long ring_buffer_entries(struct ring_buffer *buffer)
  1224. {
  1225. struct ring_buffer_per_cpu *cpu_buffer;
  1226. unsigned long entries = 0;
  1227. int cpu;
  1228. /* if you care about this being correct, lock the buffer */
  1229. for_each_buffer_cpu(buffer, cpu) {
  1230. cpu_buffer = buffer->buffers[cpu];
  1231. entries += cpu_buffer->entries;
  1232. }
  1233. return entries;
  1234. }
  1235. EXPORT_SYMBOL_GPL(ring_buffer_entries);
  1236. /**
  1237. * ring_buffer_overrun_cpu - get the number of overruns in buffer
  1238. * @buffer: The ring buffer
  1239. *
  1240. * Returns the total number of overruns in the ring buffer
  1241. * (all CPU entries)
  1242. */
  1243. unsigned long ring_buffer_overruns(struct ring_buffer *buffer)
  1244. {
  1245. struct ring_buffer_per_cpu *cpu_buffer;
  1246. unsigned long overruns = 0;
  1247. int cpu;
  1248. /* if you care about this being correct, lock the buffer */
  1249. for_each_buffer_cpu(buffer, cpu) {
  1250. cpu_buffer = buffer->buffers[cpu];
  1251. overruns += cpu_buffer->overrun;
  1252. }
  1253. return overruns;
  1254. }
  1255. EXPORT_SYMBOL_GPL(ring_buffer_overruns);
  1256. /**
  1257. * ring_buffer_iter_reset - reset an iterator
  1258. * @iter: The iterator to reset
  1259. *
  1260. * Resets the iterator, so that it will start from the beginning
  1261. * again.
  1262. */
  1263. void ring_buffer_iter_reset(struct ring_buffer_iter *iter)
  1264. {
  1265. struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;
  1266. /* Iterator usage is expected to have record disabled */
  1267. if (list_empty(&cpu_buffer->reader_page->list)) {
  1268. iter->head_page = cpu_buffer->head_page;
  1269. iter->head = cpu_buffer->head_page->read;
  1270. } else {
  1271. iter->head_page = cpu_buffer->reader_page;
  1272. iter->head = cpu_buffer->reader_page->read;
  1273. }
  1274. if (iter->head)
  1275. iter->read_stamp = cpu_buffer->read_stamp;
  1276. else
  1277. iter->read_stamp = iter->head_page->time_stamp;
  1278. }
  1279. EXPORT_SYMBOL_GPL(ring_buffer_iter_reset);
  1280. /**
  1281. * ring_buffer_iter_empty - check if an iterator has no more to read
  1282. * @iter: The iterator to check
  1283. */
  1284. int ring_buffer_iter_empty(struct ring_buffer_iter *iter)
  1285. {
  1286. struct ring_buffer_per_cpu *cpu_buffer;
  1287. cpu_buffer = iter->cpu_buffer;
  1288. return iter->head_page == cpu_buffer->commit_page &&
  1289. iter->head == rb_commit_index(cpu_buffer);
  1290. }
  1291. EXPORT_SYMBOL_GPL(ring_buffer_iter_empty);
  1292. static void
  1293. rb_update_read_stamp(struct ring_buffer_per_cpu *cpu_buffer,
  1294. struct ring_buffer_event *event)
  1295. {
  1296. u64 delta;
  1297. switch (event->type) {
  1298. case RINGBUF_TYPE_PADDING:
  1299. return;
  1300. case RINGBUF_TYPE_TIME_EXTEND:
  1301. delta = event->array[0];
  1302. delta <<= TS_SHIFT;
  1303. delta += event->time_delta;
  1304. cpu_buffer->read_stamp += delta;
  1305. return;
  1306. case RINGBUF_TYPE_TIME_STAMP:
  1307. /* FIXME: not implemented */
  1308. return;
  1309. case RINGBUF_TYPE_DATA:
  1310. cpu_buffer->read_stamp += event->time_delta;
  1311. return;
  1312. default:
  1313. BUG();
  1314. }
  1315. return;
  1316. }
  1317. static void
  1318. rb_update_iter_read_stamp(struct ring_buffer_iter *iter,
  1319. struct ring_buffer_event *event)
  1320. {
  1321. u64 delta;
  1322. switch (event->type) {
  1323. case RINGBUF_TYPE_PADDING:
  1324. return;
  1325. case RINGBUF_TYPE_TIME_EXTEND:
  1326. delta = event->array[0];
  1327. delta <<= TS_SHIFT;
  1328. delta += event->time_delta;
  1329. iter->read_stamp += delta;
  1330. return;
  1331. case RINGBUF_TYPE_TIME_STAMP:
  1332. /* FIXME: not implemented */
  1333. return;
  1334. case RINGBUF_TYPE_DATA:
  1335. iter->read_stamp += event->time_delta;
  1336. return;
  1337. default:
  1338. BUG();
  1339. }
  1340. return;
  1341. }
  1342. static struct buffer_page *
  1343. rb_get_reader_page(struct ring_buffer_per_cpu *cpu_buffer)
  1344. {
  1345. struct buffer_page *reader = NULL;
  1346. unsigned long flags;
  1347. int nr_loops = 0;
  1348. spin_lock_irqsave(&cpu_buffer->lock, flags);
  1349. again:
  1350. /*
  1351. * This should normally only loop twice. But because the
  1352. * start of the reader inserts an empty page, it causes
  1353. * a case where we will loop three times. There should be no
  1354. * reason to loop four times (that I know of).
  1355. */
  1356. if (unlikely(++nr_loops > 3)) {
  1357. RB_WARN_ON(cpu_buffer, 1);
  1358. reader = NULL;
  1359. goto out;
  1360. }
  1361. reader = cpu_buffer->reader_page;
  1362. /* If there's more to read, return this page */
  1363. if (cpu_buffer->reader_page->read < rb_page_size(reader))
  1364. goto out;
  1365. /* Never should we have an index greater than the size */
  1366. RB_WARN_ON(cpu_buffer,
  1367. cpu_buffer->reader_page->read > rb_page_size(reader));
  1368. /* check if we caught up to the tail */
  1369. reader = NULL;
  1370. if (cpu_buffer->commit_page == cpu_buffer->reader_page)
  1371. goto out;
  1372. /*
  1373. * Splice the empty reader page into the list around the head.
  1374. * Reset the reader page to size zero.
  1375. */
  1376. reader = cpu_buffer->head_page;
  1377. cpu_buffer->reader_page->list.next = reader->list.next;
  1378. cpu_buffer->reader_page->list.prev = reader->list.prev;
  1379. local_set(&cpu_buffer->reader_page->write, 0);
  1380. local_set(&cpu_buffer->reader_page->commit, 0);
  1381. /* Make the reader page now replace the head */
  1382. reader->list.prev->next = &cpu_buffer->reader_page->list;
  1383. reader->list.next->prev = &cpu_buffer->reader_page->list;
  1384. /*
  1385. * If the tail is on the reader, then we must set the head
  1386. * to the inserted page, otherwise we set it one before.
  1387. */
  1388. cpu_buffer->head_page = cpu_buffer->reader_page;
  1389. if (cpu_buffer->commit_page != reader)
  1390. rb_inc_page(cpu_buffer, &cpu_buffer->head_page);
  1391. /* Finally update the reader page to the new head */
  1392. cpu_buffer->reader_page = reader;
  1393. rb_reset_reader_page(cpu_buffer);
  1394. goto again;
  1395. out:
  1396. spin_unlock_irqrestore(&cpu_buffer->lock, flags);
  1397. return reader;
  1398. }
  1399. static void rb_advance_reader(struct ring_buffer_per_cpu *cpu_buffer)
  1400. {
  1401. struct ring_buffer_event *event;
  1402. struct buffer_page *reader;
  1403. unsigned length;
  1404. reader = rb_get_reader_page(cpu_buffer);
  1405. /* This function should not be called when buffer is empty */
  1406. BUG_ON(!reader);
  1407. event = rb_reader_event(cpu_buffer);
  1408. if (event->type == RINGBUF_TYPE_DATA)
  1409. cpu_buffer->entries--;
  1410. rb_update_read_stamp(cpu_buffer, event);
  1411. length = rb_event_length(event);
  1412. cpu_buffer->reader_page->read += length;
  1413. }
  1414. static void rb_advance_iter(struct ring_buffer_iter *iter)
  1415. {
  1416. struct ring_buffer *buffer;
  1417. struct ring_buffer_per_cpu *cpu_buffer;
  1418. struct ring_buffer_event *event;
  1419. unsigned length;
  1420. cpu_buffer = iter->cpu_buffer;
  1421. buffer = cpu_buffer->buffer;
  1422. /*
  1423. * Check if we are at the end of the buffer.
  1424. */
  1425. if (iter->head >= rb_page_size(iter->head_page)) {
  1426. BUG_ON(iter->head_page == cpu_buffer->commit_page);
  1427. rb_inc_iter(iter);
  1428. return;
  1429. }
  1430. event = rb_iter_head_event(iter);
  1431. length = rb_event_length(event);
  1432. /*
  1433. * This should not be called to advance the header if we are
  1434. * at the tail of the buffer.
  1435. */
  1436. BUG_ON((iter->head_page == cpu_buffer->commit_page) &&
  1437. (iter->head + length > rb_commit_index(cpu_buffer)));
  1438. rb_update_iter_read_stamp(iter, event);
  1439. iter->head += length;
  1440. /* check for end of page padding */
  1441. if ((iter->head >= rb_page_size(iter->head_page)) &&
  1442. (iter->head_page != cpu_buffer->commit_page))
  1443. rb_advance_iter(iter);
  1444. }
  1445. /**
  1446. * ring_buffer_peek - peek at the next event to be read
  1447. * @buffer: The ring buffer to read
  1448. * @cpu: The cpu to peak at
  1449. * @ts: The timestamp counter of this event.
  1450. *
  1451. * This will return the event that will be read next, but does
  1452. * not consume the data.
  1453. */
  1454. struct ring_buffer_event *
  1455. ring_buffer_peek(struct ring_buffer *buffer, int cpu, u64 *ts)
  1456. {
  1457. struct ring_buffer_per_cpu *cpu_buffer;
  1458. struct ring_buffer_event *event;
  1459. struct buffer_page *reader;
  1460. int nr_loops = 0;
  1461. if (!cpu_isset(cpu, buffer->cpumask))
  1462. return NULL;
  1463. cpu_buffer = buffer->buffers[cpu];
  1464. again:
  1465. /*
  1466. * We repeat when a timestamp is encountered. It is possible
  1467. * to get multiple timestamps from an interrupt entering just
  1468. * as one timestamp is about to be written. The max times
  1469. * that this can happen is the number of nested interrupts we
  1470. * can have. Nesting 10 deep of interrupts is clearly
  1471. * an anomaly.
  1472. */
  1473. if (unlikely(++nr_loops > 10)) {
  1474. RB_WARN_ON(cpu_buffer, 1);
  1475. return NULL;
  1476. }
  1477. reader = rb_get_reader_page(cpu_buffer);
  1478. if (!reader)
  1479. return NULL;
  1480. event = rb_reader_event(cpu_buffer);
  1481. switch (event->type) {
  1482. case RINGBUF_TYPE_PADDING:
  1483. RB_WARN_ON(cpu_buffer, 1);
  1484. rb_advance_reader(cpu_buffer);
  1485. return NULL;
  1486. case RINGBUF_TYPE_TIME_EXTEND:
  1487. /* Internal data, OK to advance */
  1488. rb_advance_reader(cpu_buffer);
  1489. goto again;
  1490. case RINGBUF_TYPE_TIME_STAMP:
  1491. /* FIXME: not implemented */
  1492. rb_advance_reader(cpu_buffer);
  1493. goto again;
  1494. case RINGBUF_TYPE_DATA:
  1495. if (ts) {
  1496. *ts = cpu_buffer->read_stamp + event->time_delta;
  1497. ring_buffer_normalize_time_stamp(cpu_buffer->cpu, ts);
  1498. }
  1499. return event;
  1500. default:
  1501. BUG();
  1502. }
  1503. return NULL;
  1504. }
  1505. EXPORT_SYMBOL_GPL(ring_buffer_peek);
  1506. /**
  1507. * ring_buffer_iter_peek - peek at the next event to be read
  1508. * @iter: The ring buffer iterator
  1509. * @ts: The timestamp counter of this event.
  1510. *
  1511. * This will return the event that will be read next, but does
  1512. * not increment the iterator.
  1513. */
  1514. struct ring_buffer_event *
  1515. ring_buffer_iter_peek(struct ring_buffer_iter *iter, u64 *ts)
  1516. {
  1517. struct ring_buffer *buffer;
  1518. struct ring_buffer_per_cpu *cpu_buffer;
  1519. struct ring_buffer_event *event;
  1520. int nr_loops = 0;
  1521. if (ring_buffer_iter_empty(iter))
  1522. return NULL;
  1523. cpu_buffer = iter->cpu_buffer;
  1524. buffer = cpu_buffer->buffer;
  1525. again:
  1526. /*
  1527. * We repeat when a timestamp is encountered. It is possible
  1528. * to get multiple timestamps from an interrupt entering just
  1529. * as one timestamp is about to be written. The max times
  1530. * that this can happen is the number of nested interrupts we
  1531. * can have. Nesting 10 deep of interrupts is clearly
  1532. * an anomaly.
  1533. */
  1534. if (unlikely(++nr_loops > 10)) {
  1535. RB_WARN_ON(cpu_buffer, 1);
  1536. return NULL;
  1537. }
  1538. if (rb_per_cpu_empty(cpu_buffer))
  1539. return NULL;
  1540. event = rb_iter_head_event(iter);
  1541. switch (event->type) {
  1542. case RINGBUF_TYPE_PADDING:
  1543. rb_inc_iter(iter);
  1544. goto again;
  1545. case RINGBUF_TYPE_TIME_EXTEND:
  1546. /* Internal data, OK to advance */
  1547. rb_advance_iter(iter);
  1548. goto again;
  1549. case RINGBUF_TYPE_TIME_STAMP:
  1550. /* FIXME: not implemented */
  1551. rb_advance_iter(iter);
  1552. goto again;
  1553. case RINGBUF_TYPE_DATA:
  1554. if (ts) {
  1555. *ts = iter->read_stamp + event->time_delta;
  1556. ring_buffer_normalize_time_stamp(cpu_buffer->cpu, ts);
  1557. }
  1558. return event;
  1559. default:
  1560. BUG();
  1561. }
  1562. return NULL;
  1563. }
  1564. EXPORT_SYMBOL_GPL(ring_buffer_iter_peek);
  1565. /**
  1566. * ring_buffer_consume - return an event and consume it
  1567. * @buffer: The ring buffer to get the next event from
  1568. *
  1569. * Returns the next event in the ring buffer, and that event is consumed.
  1570. * Meaning, that sequential reads will keep returning a different event,
  1571. * and eventually empty the ring buffer if the producer is slower.
  1572. */
  1573. struct ring_buffer_event *
  1574. ring_buffer_consume(struct ring_buffer *buffer, int cpu, u64 *ts)
  1575. {
  1576. struct ring_buffer_per_cpu *cpu_buffer;
  1577. struct ring_buffer_event *event;
  1578. if (!cpu_isset(cpu, buffer->cpumask))
  1579. return NULL;
  1580. event = ring_buffer_peek(buffer, cpu, ts);
  1581. if (!event)
  1582. return NULL;
  1583. cpu_buffer = buffer->buffers[cpu];
  1584. rb_advance_reader(cpu_buffer);
  1585. return event;
  1586. }
  1587. EXPORT_SYMBOL_GPL(ring_buffer_consume);
  1588. /**
  1589. * ring_buffer_read_start - start a non consuming read of the buffer
  1590. * @buffer: The ring buffer to read from
  1591. * @cpu: The cpu buffer to iterate over
  1592. *
  1593. * This starts up an iteration through the buffer. It also disables
  1594. * the recording to the buffer until the reading is finished.
  1595. * This prevents the reading from being corrupted. This is not
  1596. * a consuming read, so a producer is not expected.
  1597. *
  1598. * Must be paired with ring_buffer_finish.
  1599. */
  1600. struct ring_buffer_iter *
  1601. ring_buffer_read_start(struct ring_buffer *buffer, int cpu)
  1602. {
  1603. struct ring_buffer_per_cpu *cpu_buffer;
  1604. struct ring_buffer_iter *iter;
  1605. unsigned long flags;
  1606. if (!cpu_isset(cpu, buffer->cpumask))
  1607. return NULL;
  1608. iter = kmalloc(sizeof(*iter), GFP_KERNEL);
  1609. if (!iter)
  1610. return NULL;
  1611. cpu_buffer = buffer->buffers[cpu];
  1612. iter->cpu_buffer = cpu_buffer;
  1613. atomic_inc(&cpu_buffer->record_disabled);
  1614. synchronize_sched();
  1615. spin_lock_irqsave(&cpu_buffer->lock, flags);
  1616. ring_buffer_iter_reset(iter);
  1617. spin_unlock_irqrestore(&cpu_buffer->lock, flags);
  1618. return iter;
  1619. }
  1620. EXPORT_SYMBOL_GPL(ring_buffer_read_start);
  1621. /**
  1622. * ring_buffer_finish - finish reading the iterator of the buffer
  1623. * @iter: The iterator retrieved by ring_buffer_start
  1624. *
  1625. * This re-enables the recording to the buffer, and frees the
  1626. * iterator.
  1627. */
  1628. void
  1629. ring_buffer_read_finish(struct ring_buffer_iter *iter)
  1630. {
  1631. struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;
  1632. atomic_dec(&cpu_buffer->record_disabled);
  1633. kfree(iter);
  1634. }
  1635. EXPORT_SYMBOL_GPL(ring_buffer_read_finish);
  1636. /**
  1637. * ring_buffer_read - read the next item in the ring buffer by the iterator
  1638. * @iter: The ring buffer iterator
  1639. * @ts: The time stamp of the event read.
  1640. *
  1641. * This reads the next event in the ring buffer and increments the iterator.
  1642. */
  1643. struct ring_buffer_event *
  1644. ring_buffer_read(struct ring_buffer_iter *iter, u64 *ts)
  1645. {
  1646. struct ring_buffer_event *event;
  1647. event = ring_buffer_iter_peek(iter, ts);
  1648. if (!event)
  1649. return NULL;
  1650. rb_advance_iter(iter);
  1651. return event;
  1652. }
  1653. EXPORT_SYMBOL_GPL(ring_buffer_read);
  1654. /**
  1655. * ring_buffer_size - return the size of the ring buffer (in bytes)
  1656. * @buffer: The ring buffer.
  1657. */
  1658. unsigned long ring_buffer_size(struct ring_buffer *buffer)
  1659. {
  1660. return BUF_PAGE_SIZE * buffer->pages;
  1661. }
  1662. EXPORT_SYMBOL_GPL(ring_buffer_size);
  1663. static void
  1664. rb_reset_cpu(struct ring_buffer_per_cpu *cpu_buffer)
  1665. {
  1666. cpu_buffer->head_page
  1667. = list_entry(cpu_buffer->pages.next, struct buffer_page, list);
  1668. local_set(&cpu_buffer->head_page->write, 0);
  1669. local_set(&cpu_buffer->head_page->commit, 0);
  1670. cpu_buffer->head_page->read = 0;
  1671. cpu_buffer->tail_page = cpu_buffer->head_page;
  1672. cpu_buffer->commit_page = cpu_buffer->head_page;
  1673. INIT_LIST_HEAD(&cpu_buffer->reader_page->list);
  1674. local_set(&cpu_buffer->reader_page->write, 0);
  1675. local_set(&cpu_buffer->reader_page->commit, 0);
  1676. cpu_buffer->reader_page->read = 0;
  1677. cpu_buffer->overrun = 0;
  1678. cpu_buffer->entries = 0;
  1679. }
  1680. /**
  1681. * ring_buffer_reset_cpu - reset a ring buffer per CPU buffer
  1682. * @buffer: The ring buffer to reset a per cpu buffer of
  1683. * @cpu: The CPU buffer to be reset
  1684. */
  1685. void ring_buffer_reset_cpu(struct ring_buffer *buffer, int cpu)
  1686. {
  1687. struct ring_buffer_per_cpu *cpu_buffer = buffer->buffers[cpu];
  1688. unsigned long flags;
  1689. if (!cpu_isset(cpu, buffer->cpumask))
  1690. return;
  1691. spin_lock_irqsave(&cpu_buffer->lock, flags);
  1692. rb_reset_cpu(cpu_buffer);
  1693. spin_unlock_irqrestore(&cpu_buffer->lock, flags);
  1694. }
  1695. EXPORT_SYMBOL_GPL(ring_buffer_reset_cpu);
  1696. /**
  1697. * ring_buffer_reset - reset a ring buffer
  1698. * @buffer: The ring buffer to reset all cpu buffers
  1699. */
  1700. void ring_buffer_reset(struct ring_buffer *buffer)
  1701. {
  1702. int cpu;
  1703. for_each_buffer_cpu(buffer, cpu)
  1704. ring_buffer_reset_cpu(buffer, cpu);
  1705. }
  1706. EXPORT_SYMBOL_GPL(ring_buffer_reset);
  1707. /**
  1708. * rind_buffer_empty - is the ring buffer empty?
  1709. * @buffer: The ring buffer to test
  1710. */
  1711. int ring_buffer_empty(struct ring_buffer *buffer)
  1712. {
  1713. struct ring_buffer_per_cpu *cpu_buffer;
  1714. int cpu;
  1715. /* yes this is racy, but if you don't like the race, lock the buffer */
  1716. for_each_buffer_cpu(buffer, cpu) {
  1717. cpu_buffer = buffer->buffers[cpu];
  1718. if (!rb_per_cpu_empty(cpu_buffer))
  1719. return 0;
  1720. }
  1721. return 1;
  1722. }
  1723. EXPORT_SYMBOL_GPL(ring_buffer_empty);
  1724. /**
  1725. * ring_buffer_empty_cpu - is a cpu buffer of a ring buffer empty?
  1726. * @buffer: The ring buffer
  1727. * @cpu: The CPU buffer to test
  1728. */
  1729. int ring_buffer_empty_cpu(struct ring_buffer *buffer, int cpu)
  1730. {
  1731. struct ring_buffer_per_cpu *cpu_buffer;
  1732. if (!cpu_isset(cpu, buffer->cpumask))
  1733. return 1;
  1734. cpu_buffer = buffer->buffers[cpu];
  1735. return rb_per_cpu_empty(cpu_buffer);
  1736. }
  1737. EXPORT_SYMBOL_GPL(ring_buffer_empty_cpu);
  1738. /**
  1739. * ring_buffer_swap_cpu - swap a CPU buffer between two ring buffers
  1740. * @buffer_a: One buffer to swap with
  1741. * @buffer_b: The other buffer to swap with
  1742. *
  1743. * This function is useful for tracers that want to take a "snapshot"
  1744. * of a CPU buffer and has another back up buffer lying around.
  1745. * it is expected that the tracer handles the cpu buffer not being
  1746. * used at the moment.
  1747. */
  1748. int ring_buffer_swap_cpu(struct ring_buffer *buffer_a,
  1749. struct ring_buffer *buffer_b, int cpu)
  1750. {
  1751. struct ring_buffer_per_cpu *cpu_buffer_a;
  1752. struct ring_buffer_per_cpu *cpu_buffer_b;
  1753. if (!cpu_isset(cpu, buffer_a->cpumask) ||
  1754. !cpu_isset(cpu, buffer_b->cpumask))
  1755. return -EINVAL;
  1756. /* At least make sure the two buffers are somewhat the same */
  1757. if (buffer_a->size != buffer_b->size ||
  1758. buffer_a->pages != buffer_b->pages)
  1759. return -EINVAL;
  1760. cpu_buffer_a = buffer_a->buffers[cpu];
  1761. cpu_buffer_b = buffer_b->buffers[cpu];
  1762. /*
  1763. * We can't do a synchronize_sched here because this
  1764. * function can be called in atomic context.
  1765. * Normally this will be called from the same CPU as cpu.
  1766. * If not it's up to the caller to protect this.
  1767. */
  1768. atomic_inc(&cpu_buffer_a->record_disabled);
  1769. atomic_inc(&cpu_buffer_b->record_disabled);
  1770. buffer_a->buffers[cpu] = cpu_buffer_b;
  1771. buffer_b->buffers[cpu] = cpu_buffer_a;
  1772. cpu_buffer_b->buffer = buffer_a;
  1773. cpu_buffer_a->buffer = buffer_b;
  1774. atomic_dec(&cpu_buffer_a->record_disabled);
  1775. atomic_dec(&cpu_buffer_b->record_disabled);
  1776. return 0;
  1777. }
  1778. EXPORT_SYMBOL_GPL(ring_buffer_swap_cpu);
  1779. static ssize_t
  1780. rb_simple_read(struct file *filp, char __user *ubuf,
  1781. size_t cnt, loff_t *ppos)
  1782. {
  1783. int *p = filp->private_data;
  1784. char buf[64];
  1785. int r;
  1786. /* !ring_buffers_off == tracing_on */
  1787. r = sprintf(buf, "%d\n", !*p);
  1788. return simple_read_from_buffer(ubuf, cnt, ppos, buf, r);
  1789. }
  1790. static ssize_t
  1791. rb_simple_write(struct file *filp, const char __user *ubuf,
  1792. size_t cnt, loff_t *ppos)
  1793. {
  1794. int *p = filp->private_data;
  1795. char buf[64];
  1796. long val;
  1797. int ret;
  1798. if (cnt >= sizeof(buf))
  1799. return -EINVAL;
  1800. if (copy_from_user(&buf, ubuf, cnt))
  1801. return -EFAULT;
  1802. buf[cnt] = 0;
  1803. ret = strict_strtoul(buf, 10, &val);
  1804. if (ret < 0)
  1805. return ret;
  1806. /* !ring_buffers_off == tracing_on */
  1807. *p = !val;
  1808. (*ppos)++;
  1809. return cnt;
  1810. }
  1811. static struct file_operations rb_simple_fops = {
  1812. .open = tracing_open_generic,
  1813. .read = rb_simple_read,
  1814. .write = rb_simple_write,
  1815. };
  1816. static __init int rb_init_debugfs(void)
  1817. {
  1818. struct dentry *d_tracer;
  1819. struct dentry *entry;
  1820. d_tracer = tracing_init_dentry();
  1821. entry = debugfs_create_file("tracing_on", 0644, d_tracer,
  1822. &ring_buffers_off, &rb_simple_fops);
  1823. if (!entry)
  1824. pr_warning("Could not create debugfs 'tracing_on' entry\n");
  1825. return 0;
  1826. }
  1827. fs_initcall(rb_init_debugfs);