ring_buffer.c 55 KB

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