ring_buffer.c 63 KB

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