ring_buffer.c 62 KB

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