ring_buffer.c 63 KB

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