ring_buffer.c 55 KB

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