ring_buffer.c 63 KB

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