ring_buffer.c 62 KB

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