ring_buffer.c 112 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370
  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/trace_clock.h>
  8. #include <linux/spinlock.h>
  9. #include <linux/debugfs.h>
  10. #include <linux/uaccess.h>
  11. #include <linux/hardirq.h>
  12. #include <linux/kmemcheck.h>
  13. #include <linux/module.h>
  14. #include <linux/percpu.h>
  15. #include <linux/mutex.h>
  16. #include <linux/slab.h>
  17. #include <linux/init.h>
  18. #include <linux/hash.h>
  19. #include <linux/list.h>
  20. #include <linux/cpu.h>
  21. #include <linux/fs.h>
  22. #include <asm/local.h>
  23. #include "trace.h"
  24. static void update_pages_handler(struct work_struct *work);
  25. /*
  26. * The ring buffer header is special. We must manually up keep it.
  27. */
  28. int ring_buffer_print_entry_header(struct trace_seq *s)
  29. {
  30. int ret;
  31. ret = trace_seq_printf(s, "# compressed entry header\n");
  32. ret = trace_seq_printf(s, "\ttype_len : 5 bits\n");
  33. ret = trace_seq_printf(s, "\ttime_delta : 27 bits\n");
  34. ret = trace_seq_printf(s, "\tarray : 32 bits\n");
  35. ret = trace_seq_printf(s, "\n");
  36. ret = trace_seq_printf(s, "\tpadding : type == %d\n",
  37. RINGBUF_TYPE_PADDING);
  38. ret = trace_seq_printf(s, "\ttime_extend : type == %d\n",
  39. RINGBUF_TYPE_TIME_EXTEND);
  40. ret = trace_seq_printf(s, "\tdata max type_len == %d\n",
  41. RINGBUF_TYPE_DATA_TYPE_LEN_MAX);
  42. return ret;
  43. }
  44. /*
  45. * The ring buffer is made up of a list of pages. A separate list of pages is
  46. * allocated for each CPU. A writer may only write to a buffer that is
  47. * associated with the CPU it is currently executing on. A reader may read
  48. * from any per cpu buffer.
  49. *
  50. * The reader is special. For each per cpu buffer, the reader has its own
  51. * reader page. When a reader has read the entire reader page, this reader
  52. * page is swapped with another page in the ring buffer.
  53. *
  54. * Now, as long as the writer is off the reader page, the reader can do what
  55. * ever it wants with that page. The writer will never write to that page
  56. * again (as long as it is out of the ring buffer).
  57. *
  58. * Here's some silly ASCII art.
  59. *
  60. * +------+
  61. * |reader| RING BUFFER
  62. * |page |
  63. * +------+ +---+ +---+ +---+
  64. * | |-->| |-->| |
  65. * +---+ +---+ +---+
  66. * ^ |
  67. * | |
  68. * +---------------+
  69. *
  70. *
  71. * +------+
  72. * |reader| RING BUFFER
  73. * |page |------------------v
  74. * +------+ +---+ +---+ +---+
  75. * | |-->| |-->| |
  76. * +---+ +---+ +---+
  77. * ^ |
  78. * | |
  79. * +---------------+
  80. *
  81. *
  82. * +------+
  83. * |reader| RING BUFFER
  84. * |page |------------------v
  85. * +------+ +---+ +---+ +---+
  86. * ^ | |-->| |-->| |
  87. * | +---+ +---+ +---+
  88. * | |
  89. * | |
  90. * +------------------------------+
  91. *
  92. *
  93. * +------+
  94. * |buffer| RING BUFFER
  95. * |page |------------------v
  96. * +------+ +---+ +---+ +---+
  97. * ^ | | | |-->| |
  98. * | New +---+ +---+ +---+
  99. * | Reader------^ |
  100. * | page |
  101. * +------------------------------+
  102. *
  103. *
  104. * After we make this swap, the reader can hand this page off to the splice
  105. * code and be done with it. It can even allocate a new page if it needs to
  106. * and swap that into the ring buffer.
  107. *
  108. * We will be using cmpxchg soon to make all this lockless.
  109. *
  110. */
  111. /*
  112. * A fast way to enable or disable all ring buffers is to
  113. * call tracing_on or tracing_off. Turning off the ring buffers
  114. * prevents all ring buffers from being recorded to.
  115. * Turning this switch on, makes it OK to write to the
  116. * ring buffer, if the ring buffer is enabled itself.
  117. *
  118. * There's three layers that must be on in order to write
  119. * to the ring buffer.
  120. *
  121. * 1) This global flag must be set.
  122. * 2) The ring buffer must be enabled for recording.
  123. * 3) The per cpu buffer must be enabled for recording.
  124. *
  125. * In case of an anomaly, this global flag has a bit set that
  126. * will permantly disable all ring buffers.
  127. */
  128. /*
  129. * Global flag to disable all recording to ring buffers
  130. * This has two bits: ON, DISABLED
  131. *
  132. * ON DISABLED
  133. * ---- ----------
  134. * 0 0 : ring buffers are off
  135. * 1 0 : ring buffers are on
  136. * X 1 : ring buffers are permanently disabled
  137. */
  138. enum {
  139. RB_BUFFERS_ON_BIT = 0,
  140. RB_BUFFERS_DISABLED_BIT = 1,
  141. };
  142. enum {
  143. RB_BUFFERS_ON = 1 << RB_BUFFERS_ON_BIT,
  144. RB_BUFFERS_DISABLED = 1 << RB_BUFFERS_DISABLED_BIT,
  145. };
  146. static unsigned long ring_buffer_flags __read_mostly = RB_BUFFERS_ON;
  147. /* Used for individual buffers (after the counter) */
  148. #define RB_BUFFER_OFF (1 << 20)
  149. #define BUF_PAGE_HDR_SIZE offsetof(struct buffer_data_page, data)
  150. /**
  151. * tracing_off_permanent - permanently disable ring buffers
  152. *
  153. * This function, once called, will disable all ring buffers
  154. * permanently.
  155. */
  156. void tracing_off_permanent(void)
  157. {
  158. set_bit(RB_BUFFERS_DISABLED_BIT, &ring_buffer_flags);
  159. }
  160. #define RB_EVNT_HDR_SIZE (offsetof(struct ring_buffer_event, array))
  161. #define RB_ALIGNMENT 4U
  162. #define RB_MAX_SMALL_DATA (RB_ALIGNMENT * RINGBUF_TYPE_DATA_TYPE_LEN_MAX)
  163. #define RB_EVNT_MIN_SIZE 8U /* two 32bit words */
  164. #if !defined(CONFIG_64BIT) || defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS)
  165. # define RB_FORCE_8BYTE_ALIGNMENT 0
  166. # define RB_ARCH_ALIGNMENT RB_ALIGNMENT
  167. #else
  168. # define RB_FORCE_8BYTE_ALIGNMENT 1
  169. # define RB_ARCH_ALIGNMENT 8U
  170. #endif
  171. /* define RINGBUF_TYPE_DATA for 'case RINGBUF_TYPE_DATA:' */
  172. #define RINGBUF_TYPE_DATA 0 ... RINGBUF_TYPE_DATA_TYPE_LEN_MAX
  173. enum {
  174. RB_LEN_TIME_EXTEND = 8,
  175. RB_LEN_TIME_STAMP = 16,
  176. };
  177. #define skip_time_extend(event) \
  178. ((struct ring_buffer_event *)((char *)event + RB_LEN_TIME_EXTEND))
  179. static inline int rb_null_event(struct ring_buffer_event *event)
  180. {
  181. return event->type_len == RINGBUF_TYPE_PADDING && !event->time_delta;
  182. }
  183. static void rb_event_set_padding(struct ring_buffer_event *event)
  184. {
  185. /* padding has a NULL time_delta */
  186. event->type_len = RINGBUF_TYPE_PADDING;
  187. event->time_delta = 0;
  188. }
  189. static unsigned
  190. rb_event_data_length(struct ring_buffer_event *event)
  191. {
  192. unsigned length;
  193. if (event->type_len)
  194. length = event->type_len * RB_ALIGNMENT;
  195. else
  196. length = event->array[0];
  197. return length + RB_EVNT_HDR_SIZE;
  198. }
  199. /*
  200. * Return the length of the given event. Will return
  201. * the length of the time extend if the event is a
  202. * time extend.
  203. */
  204. static inline unsigned
  205. rb_event_length(struct ring_buffer_event *event)
  206. {
  207. switch (event->type_len) {
  208. case RINGBUF_TYPE_PADDING:
  209. if (rb_null_event(event))
  210. /* undefined */
  211. return -1;
  212. return event->array[0] + RB_EVNT_HDR_SIZE;
  213. case RINGBUF_TYPE_TIME_EXTEND:
  214. return RB_LEN_TIME_EXTEND;
  215. case RINGBUF_TYPE_TIME_STAMP:
  216. return RB_LEN_TIME_STAMP;
  217. case RINGBUF_TYPE_DATA:
  218. return rb_event_data_length(event);
  219. default:
  220. BUG();
  221. }
  222. /* not hit */
  223. return 0;
  224. }
  225. /*
  226. * Return total length of time extend and data,
  227. * or just the event length for all other events.
  228. */
  229. static inline unsigned
  230. rb_event_ts_length(struct ring_buffer_event *event)
  231. {
  232. unsigned len = 0;
  233. if (event->type_len == RINGBUF_TYPE_TIME_EXTEND) {
  234. /* time extends include the data event after it */
  235. len = RB_LEN_TIME_EXTEND;
  236. event = skip_time_extend(event);
  237. }
  238. return len + rb_event_length(event);
  239. }
  240. /**
  241. * ring_buffer_event_length - return the length of the event
  242. * @event: the event to get the length of
  243. *
  244. * Returns the size of the data load of a data event.
  245. * If the event is something other than a data event, it
  246. * returns the size of the event itself. With the exception
  247. * of a TIME EXTEND, where it still returns the size of the
  248. * data load of the data event after it.
  249. */
  250. unsigned ring_buffer_event_length(struct ring_buffer_event *event)
  251. {
  252. unsigned length;
  253. if (event->type_len == RINGBUF_TYPE_TIME_EXTEND)
  254. event = skip_time_extend(event);
  255. length = rb_event_length(event);
  256. if (event->type_len > RINGBUF_TYPE_DATA_TYPE_LEN_MAX)
  257. return length;
  258. length -= RB_EVNT_HDR_SIZE;
  259. if (length > RB_MAX_SMALL_DATA + sizeof(event->array[0]))
  260. length -= sizeof(event->array[0]);
  261. return length;
  262. }
  263. EXPORT_SYMBOL_GPL(ring_buffer_event_length);
  264. /* inline for ring buffer fast paths */
  265. static void *
  266. rb_event_data(struct ring_buffer_event *event)
  267. {
  268. if (event->type_len == RINGBUF_TYPE_TIME_EXTEND)
  269. event = skip_time_extend(event);
  270. BUG_ON(event->type_len > RINGBUF_TYPE_DATA_TYPE_LEN_MAX);
  271. /* If length is in len field, then array[0] has the data */
  272. if (event->type_len)
  273. return (void *)&event->array[0];
  274. /* Otherwise length is in array[0] and array[1] has the data */
  275. return (void *)&event->array[1];
  276. }
  277. /**
  278. * ring_buffer_event_data - return the data of the event
  279. * @event: the event to get the data from
  280. */
  281. void *ring_buffer_event_data(struct ring_buffer_event *event)
  282. {
  283. return rb_event_data(event);
  284. }
  285. EXPORT_SYMBOL_GPL(ring_buffer_event_data);
  286. #define for_each_buffer_cpu(buffer, cpu) \
  287. for_each_cpu(cpu, buffer->cpumask)
  288. #define TS_SHIFT 27
  289. #define TS_MASK ((1ULL << TS_SHIFT) - 1)
  290. #define TS_DELTA_TEST (~TS_MASK)
  291. /* Flag when events were overwritten */
  292. #define RB_MISSED_EVENTS (1 << 31)
  293. /* Missed count stored at end */
  294. #define RB_MISSED_STORED (1 << 30)
  295. struct buffer_data_page {
  296. u64 time_stamp; /* page time stamp */
  297. local_t commit; /* write committed index */
  298. unsigned char data[]; /* data of buffer page */
  299. };
  300. /*
  301. * Note, the buffer_page list must be first. The buffer pages
  302. * are allocated in cache lines, which means that each buffer
  303. * page will be at the beginning of a cache line, and thus
  304. * the least significant bits will be zero. We use this to
  305. * add flags in the list struct pointers, to make the ring buffer
  306. * lockless.
  307. */
  308. struct buffer_page {
  309. struct list_head list; /* list of buffer pages */
  310. local_t write; /* index for next write */
  311. unsigned read; /* index for next read */
  312. local_t entries; /* entries on this page */
  313. unsigned long real_end; /* real end of data */
  314. struct buffer_data_page *page; /* Actual data page */
  315. };
  316. /*
  317. * The buffer page counters, write and entries, must be reset
  318. * atomically when crossing page boundaries. To synchronize this
  319. * update, two counters are inserted into the number. One is
  320. * the actual counter for the write position or count on the page.
  321. *
  322. * The other is a counter of updaters. Before an update happens
  323. * the update partition of the counter is incremented. This will
  324. * allow the updater to update the counter atomically.
  325. *
  326. * The counter is 20 bits, and the state data is 12.
  327. */
  328. #define RB_WRITE_MASK 0xfffff
  329. #define RB_WRITE_INTCNT (1 << 20)
  330. static void rb_init_page(struct buffer_data_page *bpage)
  331. {
  332. local_set(&bpage->commit, 0);
  333. }
  334. /**
  335. * ring_buffer_page_len - the size of data on the page.
  336. * @page: The page to read
  337. *
  338. * Returns the amount of data on the page, including buffer page header.
  339. */
  340. size_t ring_buffer_page_len(void *page)
  341. {
  342. return local_read(&((struct buffer_data_page *)page)->commit)
  343. + BUF_PAGE_HDR_SIZE;
  344. }
  345. /*
  346. * Also stolen from mm/slob.c. Thanks to Mathieu Desnoyers for pointing
  347. * this issue out.
  348. */
  349. static void free_buffer_page(struct buffer_page *bpage)
  350. {
  351. free_page((unsigned long)bpage->page);
  352. kfree(bpage);
  353. }
  354. /*
  355. * We need to fit the time_stamp delta into 27 bits.
  356. */
  357. static inline int test_time_stamp(u64 delta)
  358. {
  359. if (delta & TS_DELTA_TEST)
  360. return 1;
  361. return 0;
  362. }
  363. #define BUF_PAGE_SIZE (PAGE_SIZE - BUF_PAGE_HDR_SIZE)
  364. /* Max payload is BUF_PAGE_SIZE - header (8bytes) */
  365. #define BUF_MAX_DATA_SIZE (BUF_PAGE_SIZE - (sizeof(u32) * 2))
  366. int ring_buffer_print_page_header(struct trace_seq *s)
  367. {
  368. struct buffer_data_page field;
  369. int ret;
  370. ret = trace_seq_printf(s, "\tfield: u64 timestamp;\t"
  371. "offset:0;\tsize:%u;\tsigned:%u;\n",
  372. (unsigned int)sizeof(field.time_stamp),
  373. (unsigned int)is_signed_type(u64));
  374. ret = trace_seq_printf(s, "\tfield: local_t commit;\t"
  375. "offset:%u;\tsize:%u;\tsigned:%u;\n",
  376. (unsigned int)offsetof(typeof(field), commit),
  377. (unsigned int)sizeof(field.commit),
  378. (unsigned int)is_signed_type(long));
  379. ret = trace_seq_printf(s, "\tfield: int overwrite;\t"
  380. "offset:%u;\tsize:%u;\tsigned:%u;\n",
  381. (unsigned int)offsetof(typeof(field), commit),
  382. 1,
  383. (unsigned int)is_signed_type(long));
  384. ret = trace_seq_printf(s, "\tfield: char data;\t"
  385. "offset:%u;\tsize:%u;\tsigned:%u;\n",
  386. (unsigned int)offsetof(typeof(field), data),
  387. (unsigned int)BUF_PAGE_SIZE,
  388. (unsigned int)is_signed_type(char));
  389. return ret;
  390. }
  391. /*
  392. * head_page == tail_page && head == tail then buffer is empty.
  393. */
  394. struct ring_buffer_per_cpu {
  395. int cpu;
  396. atomic_t record_disabled;
  397. struct ring_buffer *buffer;
  398. raw_spinlock_t reader_lock; /* serialize readers */
  399. arch_spinlock_t lock;
  400. struct lock_class_key lock_key;
  401. unsigned int nr_pages;
  402. struct list_head *pages;
  403. struct buffer_page *head_page; /* read from head */
  404. struct buffer_page *tail_page; /* write to tail */
  405. struct buffer_page *commit_page; /* committed pages */
  406. struct buffer_page *reader_page;
  407. unsigned long lost_events;
  408. unsigned long last_overrun;
  409. local_t entries_bytes;
  410. local_t commit_overrun;
  411. local_t overrun;
  412. local_t entries;
  413. local_t committing;
  414. local_t commits;
  415. unsigned long read;
  416. unsigned long read_bytes;
  417. u64 write_stamp;
  418. u64 read_stamp;
  419. /* ring buffer pages to update, > 0 to add, < 0 to remove */
  420. int nr_pages_to_update;
  421. struct list_head new_pages; /* new pages to add */
  422. struct work_struct update_pages_work;
  423. struct completion update_done;
  424. };
  425. struct ring_buffer {
  426. unsigned flags;
  427. int cpus;
  428. atomic_t record_disabled;
  429. atomic_t resize_disabled;
  430. cpumask_var_t cpumask;
  431. struct lock_class_key *reader_lock_key;
  432. struct mutex mutex;
  433. struct ring_buffer_per_cpu **buffers;
  434. #ifdef CONFIG_HOTPLUG_CPU
  435. struct notifier_block cpu_notify;
  436. #endif
  437. u64 (*clock)(void);
  438. };
  439. struct ring_buffer_iter {
  440. struct ring_buffer_per_cpu *cpu_buffer;
  441. unsigned long head;
  442. struct buffer_page *head_page;
  443. struct buffer_page *cache_reader_page;
  444. unsigned long cache_read;
  445. u64 read_stamp;
  446. };
  447. /* buffer may be either ring_buffer or ring_buffer_per_cpu */
  448. #define RB_WARN_ON(b, cond) \
  449. ({ \
  450. int _____ret = unlikely(cond); \
  451. if (_____ret) { \
  452. if (__same_type(*(b), struct ring_buffer_per_cpu)) { \
  453. struct ring_buffer_per_cpu *__b = \
  454. (void *)b; \
  455. atomic_inc(&__b->buffer->record_disabled); \
  456. } else \
  457. atomic_inc(&b->record_disabled); \
  458. WARN_ON(1); \
  459. } \
  460. _____ret; \
  461. })
  462. /* Up this if you want to test the TIME_EXTENTS and normalization */
  463. #define DEBUG_SHIFT 0
  464. static inline u64 rb_time_stamp(struct ring_buffer *buffer)
  465. {
  466. /* shift to debug/test normalization and TIME_EXTENTS */
  467. return buffer->clock() << DEBUG_SHIFT;
  468. }
  469. u64 ring_buffer_time_stamp(struct ring_buffer *buffer, int cpu)
  470. {
  471. u64 time;
  472. preempt_disable_notrace();
  473. time = rb_time_stamp(buffer);
  474. preempt_enable_no_resched_notrace();
  475. return time;
  476. }
  477. EXPORT_SYMBOL_GPL(ring_buffer_time_stamp);
  478. void ring_buffer_normalize_time_stamp(struct ring_buffer *buffer,
  479. int cpu, u64 *ts)
  480. {
  481. /* Just stupid testing the normalize function and deltas */
  482. *ts >>= DEBUG_SHIFT;
  483. }
  484. EXPORT_SYMBOL_GPL(ring_buffer_normalize_time_stamp);
  485. /*
  486. * Making the ring buffer lockless makes things tricky.
  487. * Although writes only happen on the CPU that they are on,
  488. * and they only need to worry about interrupts. Reads can
  489. * happen on any CPU.
  490. *
  491. * The reader page is always off the ring buffer, but when the
  492. * reader finishes with a page, it needs to swap its page with
  493. * a new one from the buffer. The reader needs to take from
  494. * the head (writes go to the tail). But if a writer is in overwrite
  495. * mode and wraps, it must push the head page forward.
  496. *
  497. * Here lies the problem.
  498. *
  499. * The reader must be careful to replace only the head page, and
  500. * not another one. As described at the top of the file in the
  501. * ASCII art, the reader sets its old page to point to the next
  502. * page after head. It then sets the page after head to point to
  503. * the old reader page. But if the writer moves the head page
  504. * during this operation, the reader could end up with the tail.
  505. *
  506. * We use cmpxchg to help prevent this race. We also do something
  507. * special with the page before head. We set the LSB to 1.
  508. *
  509. * When the writer must push the page forward, it will clear the
  510. * bit that points to the head page, move the head, and then set
  511. * the bit that points to the new head page.
  512. *
  513. * We also don't want an interrupt coming in and moving the head
  514. * page on another writer. Thus we use the second LSB to catch
  515. * that too. Thus:
  516. *
  517. * head->list->prev->next bit 1 bit 0
  518. * ------- -------
  519. * Normal page 0 0
  520. * Points to head page 0 1
  521. * New head page 1 0
  522. *
  523. * Note we can not trust the prev pointer of the head page, because:
  524. *
  525. * +----+ +-----+ +-----+
  526. * | |------>| T |---X--->| N |
  527. * | |<------| | | |
  528. * +----+ +-----+ +-----+
  529. * ^ ^ |
  530. * | +-----+ | |
  531. * +----------| R |----------+ |
  532. * | |<-----------+
  533. * +-----+
  534. *
  535. * Key: ---X--> HEAD flag set in pointer
  536. * T Tail page
  537. * R Reader page
  538. * N Next page
  539. *
  540. * (see __rb_reserve_next() to see where this happens)
  541. *
  542. * What the above shows is that the reader just swapped out
  543. * the reader page with a page in the buffer, but before it
  544. * could make the new header point back to the new page added
  545. * it was preempted by a writer. The writer moved forward onto
  546. * the new page added by the reader and is about to move forward
  547. * again.
  548. *
  549. * You can see, it is legitimate for the previous pointer of
  550. * the head (or any page) not to point back to itself. But only
  551. * temporarially.
  552. */
  553. #define RB_PAGE_NORMAL 0UL
  554. #define RB_PAGE_HEAD 1UL
  555. #define RB_PAGE_UPDATE 2UL
  556. #define RB_FLAG_MASK 3UL
  557. /* PAGE_MOVED is not part of the mask */
  558. #define RB_PAGE_MOVED 4UL
  559. /*
  560. * rb_list_head - remove any bit
  561. */
  562. static struct list_head *rb_list_head(struct list_head *list)
  563. {
  564. unsigned long val = (unsigned long)list;
  565. return (struct list_head *)(val & ~RB_FLAG_MASK);
  566. }
  567. /*
  568. * rb_is_head_page - test if the given page is the head page
  569. *
  570. * Because the reader may move the head_page pointer, we can
  571. * not trust what the head page is (it may be pointing to
  572. * the reader page). But if the next page is a header page,
  573. * its flags will be non zero.
  574. */
  575. static inline int
  576. rb_is_head_page(struct ring_buffer_per_cpu *cpu_buffer,
  577. struct buffer_page *page, struct list_head *list)
  578. {
  579. unsigned long val;
  580. val = (unsigned long)list->next;
  581. if ((val & ~RB_FLAG_MASK) != (unsigned long)&page->list)
  582. return RB_PAGE_MOVED;
  583. return val & RB_FLAG_MASK;
  584. }
  585. /*
  586. * rb_is_reader_page
  587. *
  588. * The unique thing about the reader page, is that, if the
  589. * writer is ever on it, the previous pointer never points
  590. * back to the reader page.
  591. */
  592. static int rb_is_reader_page(struct buffer_page *page)
  593. {
  594. struct list_head *list = page->list.prev;
  595. return rb_list_head(list->next) != &page->list;
  596. }
  597. /*
  598. * rb_set_list_to_head - set a list_head to be pointing to head.
  599. */
  600. static void rb_set_list_to_head(struct ring_buffer_per_cpu *cpu_buffer,
  601. struct list_head *list)
  602. {
  603. unsigned long *ptr;
  604. ptr = (unsigned long *)&list->next;
  605. *ptr |= RB_PAGE_HEAD;
  606. *ptr &= ~RB_PAGE_UPDATE;
  607. }
  608. /*
  609. * rb_head_page_activate - sets up head page
  610. */
  611. static void rb_head_page_activate(struct ring_buffer_per_cpu *cpu_buffer)
  612. {
  613. struct buffer_page *head;
  614. head = cpu_buffer->head_page;
  615. if (!head)
  616. return;
  617. /*
  618. * Set the previous list pointer to have the HEAD flag.
  619. */
  620. rb_set_list_to_head(cpu_buffer, head->list.prev);
  621. }
  622. static void rb_list_head_clear(struct list_head *list)
  623. {
  624. unsigned long *ptr = (unsigned long *)&list->next;
  625. *ptr &= ~RB_FLAG_MASK;
  626. }
  627. /*
  628. * rb_head_page_dactivate - clears head page ptr (for free list)
  629. */
  630. static void
  631. rb_head_page_deactivate(struct ring_buffer_per_cpu *cpu_buffer)
  632. {
  633. struct list_head *hd;
  634. /* Go through the whole list and clear any pointers found. */
  635. rb_list_head_clear(cpu_buffer->pages);
  636. list_for_each(hd, cpu_buffer->pages)
  637. rb_list_head_clear(hd);
  638. }
  639. static int rb_head_page_set(struct ring_buffer_per_cpu *cpu_buffer,
  640. struct buffer_page *head,
  641. struct buffer_page *prev,
  642. int old_flag, int new_flag)
  643. {
  644. struct list_head *list;
  645. unsigned long val = (unsigned long)&head->list;
  646. unsigned long ret;
  647. list = &prev->list;
  648. val &= ~RB_FLAG_MASK;
  649. ret = cmpxchg((unsigned long *)&list->next,
  650. val | old_flag, val | new_flag);
  651. /* check if the reader took the page */
  652. if ((ret & ~RB_FLAG_MASK) != val)
  653. return RB_PAGE_MOVED;
  654. return ret & RB_FLAG_MASK;
  655. }
  656. static int rb_head_page_set_update(struct ring_buffer_per_cpu *cpu_buffer,
  657. struct buffer_page *head,
  658. struct buffer_page *prev,
  659. int old_flag)
  660. {
  661. return rb_head_page_set(cpu_buffer, head, prev,
  662. old_flag, RB_PAGE_UPDATE);
  663. }
  664. static int rb_head_page_set_head(struct ring_buffer_per_cpu *cpu_buffer,
  665. struct buffer_page *head,
  666. struct buffer_page *prev,
  667. int old_flag)
  668. {
  669. return rb_head_page_set(cpu_buffer, head, prev,
  670. old_flag, RB_PAGE_HEAD);
  671. }
  672. static int rb_head_page_set_normal(struct ring_buffer_per_cpu *cpu_buffer,
  673. struct buffer_page *head,
  674. struct buffer_page *prev,
  675. int old_flag)
  676. {
  677. return rb_head_page_set(cpu_buffer, head, prev,
  678. old_flag, RB_PAGE_NORMAL);
  679. }
  680. static inline void rb_inc_page(struct ring_buffer_per_cpu *cpu_buffer,
  681. struct buffer_page **bpage)
  682. {
  683. struct list_head *p = rb_list_head((*bpage)->list.next);
  684. *bpage = list_entry(p, struct buffer_page, list);
  685. }
  686. static struct buffer_page *
  687. rb_set_head_page(struct ring_buffer_per_cpu *cpu_buffer)
  688. {
  689. struct buffer_page *head;
  690. struct buffer_page *page;
  691. struct list_head *list;
  692. int i;
  693. if (RB_WARN_ON(cpu_buffer, !cpu_buffer->head_page))
  694. return NULL;
  695. /* sanity check */
  696. list = cpu_buffer->pages;
  697. if (RB_WARN_ON(cpu_buffer, rb_list_head(list->prev->next) != list))
  698. return NULL;
  699. page = head = cpu_buffer->head_page;
  700. /*
  701. * It is possible that the writer moves the header behind
  702. * where we started, and we miss in one loop.
  703. * A second loop should grab the header, but we'll do
  704. * three loops just because I'm paranoid.
  705. */
  706. for (i = 0; i < 3; i++) {
  707. do {
  708. if (rb_is_head_page(cpu_buffer, page, page->list.prev)) {
  709. cpu_buffer->head_page = page;
  710. return page;
  711. }
  712. rb_inc_page(cpu_buffer, &page);
  713. } while (page != head);
  714. }
  715. RB_WARN_ON(cpu_buffer, 1);
  716. return NULL;
  717. }
  718. static int rb_head_page_replace(struct buffer_page *old,
  719. struct buffer_page *new)
  720. {
  721. unsigned long *ptr = (unsigned long *)&old->list.prev->next;
  722. unsigned long val;
  723. unsigned long ret;
  724. val = *ptr & ~RB_FLAG_MASK;
  725. val |= RB_PAGE_HEAD;
  726. ret = cmpxchg(ptr, val, (unsigned long)&new->list);
  727. return ret == val;
  728. }
  729. /*
  730. * rb_tail_page_update - move the tail page forward
  731. *
  732. * Returns 1 if moved tail page, 0 if someone else did.
  733. */
  734. static int rb_tail_page_update(struct ring_buffer_per_cpu *cpu_buffer,
  735. struct buffer_page *tail_page,
  736. struct buffer_page *next_page)
  737. {
  738. struct buffer_page *old_tail;
  739. unsigned long old_entries;
  740. unsigned long old_write;
  741. int ret = 0;
  742. /*
  743. * The tail page now needs to be moved forward.
  744. *
  745. * We need to reset the tail page, but without messing
  746. * with possible erasing of data brought in by interrupts
  747. * that have moved the tail page and are currently on it.
  748. *
  749. * We add a counter to the write field to denote this.
  750. */
  751. old_write = local_add_return(RB_WRITE_INTCNT, &next_page->write);
  752. old_entries = local_add_return(RB_WRITE_INTCNT, &next_page->entries);
  753. /*
  754. * Just make sure we have seen our old_write and synchronize
  755. * with any interrupts that come in.
  756. */
  757. barrier();
  758. /*
  759. * If the tail page is still the same as what we think
  760. * it is, then it is up to us to update the tail
  761. * pointer.
  762. */
  763. if (tail_page == cpu_buffer->tail_page) {
  764. /* Zero the write counter */
  765. unsigned long val = old_write & ~RB_WRITE_MASK;
  766. unsigned long eval = old_entries & ~RB_WRITE_MASK;
  767. /*
  768. * This will only succeed if an interrupt did
  769. * not come in and change it. In which case, we
  770. * do not want to modify it.
  771. *
  772. * We add (void) to let the compiler know that we do not care
  773. * about the return value of these functions. We use the
  774. * cmpxchg to only update if an interrupt did not already
  775. * do it for us. If the cmpxchg fails, we don't care.
  776. */
  777. (void)local_cmpxchg(&next_page->write, old_write, val);
  778. (void)local_cmpxchg(&next_page->entries, old_entries, eval);
  779. /*
  780. * No need to worry about races with clearing out the commit.
  781. * it only can increment when a commit takes place. But that
  782. * only happens in the outer most nested commit.
  783. */
  784. local_set(&next_page->page->commit, 0);
  785. old_tail = cmpxchg(&cpu_buffer->tail_page,
  786. tail_page, next_page);
  787. if (old_tail == tail_page)
  788. ret = 1;
  789. }
  790. return ret;
  791. }
  792. static int rb_check_bpage(struct ring_buffer_per_cpu *cpu_buffer,
  793. struct buffer_page *bpage)
  794. {
  795. unsigned long val = (unsigned long)bpage;
  796. if (RB_WARN_ON(cpu_buffer, val & RB_FLAG_MASK))
  797. return 1;
  798. return 0;
  799. }
  800. /**
  801. * rb_check_list - make sure a pointer to a list has the last bits zero
  802. */
  803. static int rb_check_list(struct ring_buffer_per_cpu *cpu_buffer,
  804. struct list_head *list)
  805. {
  806. if (RB_WARN_ON(cpu_buffer, rb_list_head(list->prev) != list->prev))
  807. return 1;
  808. if (RB_WARN_ON(cpu_buffer, rb_list_head(list->next) != list->next))
  809. return 1;
  810. return 0;
  811. }
  812. /**
  813. * check_pages - integrity check of buffer pages
  814. * @cpu_buffer: CPU buffer with pages to test
  815. *
  816. * As a safety measure we check to make sure the data pages have not
  817. * been corrupted.
  818. */
  819. static int rb_check_pages(struct ring_buffer_per_cpu *cpu_buffer)
  820. {
  821. struct list_head *head = cpu_buffer->pages;
  822. struct buffer_page *bpage, *tmp;
  823. /* Reset the head page if it exists */
  824. if (cpu_buffer->head_page)
  825. rb_set_head_page(cpu_buffer);
  826. rb_head_page_deactivate(cpu_buffer);
  827. if (RB_WARN_ON(cpu_buffer, head->next->prev != head))
  828. return -1;
  829. if (RB_WARN_ON(cpu_buffer, head->prev->next != head))
  830. return -1;
  831. if (rb_check_list(cpu_buffer, head))
  832. return -1;
  833. list_for_each_entry_safe(bpage, tmp, head, list) {
  834. if (RB_WARN_ON(cpu_buffer,
  835. bpage->list.next->prev != &bpage->list))
  836. return -1;
  837. if (RB_WARN_ON(cpu_buffer,
  838. bpage->list.prev->next != &bpage->list))
  839. return -1;
  840. if (rb_check_list(cpu_buffer, &bpage->list))
  841. return -1;
  842. }
  843. rb_head_page_activate(cpu_buffer);
  844. return 0;
  845. }
  846. static int __rb_allocate_pages(int nr_pages, struct list_head *pages, int cpu)
  847. {
  848. int i;
  849. struct buffer_page *bpage, *tmp;
  850. for (i = 0; i < nr_pages; i++) {
  851. struct page *page;
  852. /*
  853. * __GFP_NORETRY flag makes sure that the allocation fails
  854. * gracefully without invoking oom-killer and the system is
  855. * not destabilized.
  856. */
  857. bpage = kzalloc_node(ALIGN(sizeof(*bpage), cache_line_size()),
  858. GFP_KERNEL | __GFP_NORETRY,
  859. cpu_to_node(cpu));
  860. if (!bpage)
  861. goto free_pages;
  862. list_add(&bpage->list, pages);
  863. page = alloc_pages_node(cpu_to_node(cpu),
  864. GFP_KERNEL | __GFP_NORETRY, 0);
  865. if (!page)
  866. goto free_pages;
  867. bpage->page = page_address(page);
  868. rb_init_page(bpage->page);
  869. }
  870. return 0;
  871. free_pages:
  872. list_for_each_entry_safe(bpage, tmp, pages, list) {
  873. list_del_init(&bpage->list);
  874. free_buffer_page(bpage);
  875. }
  876. return -ENOMEM;
  877. }
  878. static int rb_allocate_pages(struct ring_buffer_per_cpu *cpu_buffer,
  879. unsigned nr_pages)
  880. {
  881. LIST_HEAD(pages);
  882. WARN_ON(!nr_pages);
  883. if (__rb_allocate_pages(nr_pages, &pages, cpu_buffer->cpu))
  884. return -ENOMEM;
  885. /*
  886. * The ring buffer page list is a circular list that does not
  887. * start and end with a list head. All page list items point to
  888. * other pages.
  889. */
  890. cpu_buffer->pages = pages.next;
  891. list_del(&pages);
  892. cpu_buffer->nr_pages = nr_pages;
  893. rb_check_pages(cpu_buffer);
  894. return 0;
  895. }
  896. static struct ring_buffer_per_cpu *
  897. rb_allocate_cpu_buffer(struct ring_buffer *buffer, int nr_pages, int cpu)
  898. {
  899. struct ring_buffer_per_cpu *cpu_buffer;
  900. struct buffer_page *bpage;
  901. struct page *page;
  902. int ret;
  903. cpu_buffer = kzalloc_node(ALIGN(sizeof(*cpu_buffer), cache_line_size()),
  904. GFP_KERNEL, cpu_to_node(cpu));
  905. if (!cpu_buffer)
  906. return NULL;
  907. cpu_buffer->cpu = cpu;
  908. cpu_buffer->buffer = buffer;
  909. raw_spin_lock_init(&cpu_buffer->reader_lock);
  910. lockdep_set_class(&cpu_buffer->reader_lock, buffer->reader_lock_key);
  911. cpu_buffer->lock = (arch_spinlock_t)__ARCH_SPIN_LOCK_UNLOCKED;
  912. INIT_WORK(&cpu_buffer->update_pages_work, update_pages_handler);
  913. init_completion(&cpu_buffer->update_done);
  914. bpage = kzalloc_node(ALIGN(sizeof(*bpage), cache_line_size()),
  915. GFP_KERNEL, cpu_to_node(cpu));
  916. if (!bpage)
  917. goto fail_free_buffer;
  918. rb_check_bpage(cpu_buffer, bpage);
  919. cpu_buffer->reader_page = bpage;
  920. page = alloc_pages_node(cpu_to_node(cpu), GFP_KERNEL, 0);
  921. if (!page)
  922. goto fail_free_reader;
  923. bpage->page = page_address(page);
  924. rb_init_page(bpage->page);
  925. INIT_LIST_HEAD(&cpu_buffer->reader_page->list);
  926. INIT_LIST_HEAD(&cpu_buffer->new_pages);
  927. ret = rb_allocate_pages(cpu_buffer, nr_pages);
  928. if (ret < 0)
  929. goto fail_free_reader;
  930. cpu_buffer->head_page
  931. = list_entry(cpu_buffer->pages, struct buffer_page, list);
  932. cpu_buffer->tail_page = cpu_buffer->commit_page = cpu_buffer->head_page;
  933. rb_head_page_activate(cpu_buffer);
  934. return cpu_buffer;
  935. fail_free_reader:
  936. free_buffer_page(cpu_buffer->reader_page);
  937. fail_free_buffer:
  938. kfree(cpu_buffer);
  939. return NULL;
  940. }
  941. static void rb_free_cpu_buffer(struct ring_buffer_per_cpu *cpu_buffer)
  942. {
  943. struct list_head *head = cpu_buffer->pages;
  944. struct buffer_page *bpage, *tmp;
  945. free_buffer_page(cpu_buffer->reader_page);
  946. rb_head_page_deactivate(cpu_buffer);
  947. if (head) {
  948. list_for_each_entry_safe(bpage, tmp, head, list) {
  949. list_del_init(&bpage->list);
  950. free_buffer_page(bpage);
  951. }
  952. bpage = list_entry(head, struct buffer_page, list);
  953. free_buffer_page(bpage);
  954. }
  955. kfree(cpu_buffer);
  956. }
  957. #ifdef CONFIG_HOTPLUG_CPU
  958. static int rb_cpu_notify(struct notifier_block *self,
  959. unsigned long action, void *hcpu);
  960. #endif
  961. /**
  962. * ring_buffer_alloc - allocate a new ring_buffer
  963. * @size: the size in bytes per cpu that is needed.
  964. * @flags: attributes to set for the ring buffer.
  965. *
  966. * Currently the only flag that is available is the RB_FL_OVERWRITE
  967. * flag. This flag means that the buffer will overwrite old data
  968. * when the buffer wraps. If this flag is not set, the buffer will
  969. * drop data when the tail hits the head.
  970. */
  971. struct ring_buffer *__ring_buffer_alloc(unsigned long size, unsigned flags,
  972. struct lock_class_key *key)
  973. {
  974. struct ring_buffer *buffer;
  975. int bsize;
  976. int cpu, nr_pages;
  977. /* keep it in its own cache line */
  978. buffer = kzalloc(ALIGN(sizeof(*buffer), cache_line_size()),
  979. GFP_KERNEL);
  980. if (!buffer)
  981. return NULL;
  982. if (!alloc_cpumask_var(&buffer->cpumask, GFP_KERNEL))
  983. goto fail_free_buffer;
  984. nr_pages = DIV_ROUND_UP(size, BUF_PAGE_SIZE);
  985. buffer->flags = flags;
  986. buffer->clock = trace_clock_local;
  987. buffer->reader_lock_key = key;
  988. /* need at least two pages */
  989. if (nr_pages < 2)
  990. nr_pages = 2;
  991. /*
  992. * In case of non-hotplug cpu, if the ring-buffer is allocated
  993. * in early initcall, it will not be notified of secondary cpus.
  994. * In that off case, we need to allocate for all possible cpus.
  995. */
  996. #ifdef CONFIG_HOTPLUG_CPU
  997. get_online_cpus();
  998. cpumask_copy(buffer->cpumask, cpu_online_mask);
  999. #else
  1000. cpumask_copy(buffer->cpumask, cpu_possible_mask);
  1001. #endif
  1002. buffer->cpus = nr_cpu_ids;
  1003. bsize = sizeof(void *) * nr_cpu_ids;
  1004. buffer->buffers = kzalloc(ALIGN(bsize, cache_line_size()),
  1005. GFP_KERNEL);
  1006. if (!buffer->buffers)
  1007. goto fail_free_cpumask;
  1008. for_each_buffer_cpu(buffer, cpu) {
  1009. buffer->buffers[cpu] =
  1010. rb_allocate_cpu_buffer(buffer, nr_pages, cpu);
  1011. if (!buffer->buffers[cpu])
  1012. goto fail_free_buffers;
  1013. }
  1014. #ifdef CONFIG_HOTPLUG_CPU
  1015. buffer->cpu_notify.notifier_call = rb_cpu_notify;
  1016. buffer->cpu_notify.priority = 0;
  1017. register_cpu_notifier(&buffer->cpu_notify);
  1018. #endif
  1019. put_online_cpus();
  1020. mutex_init(&buffer->mutex);
  1021. return buffer;
  1022. fail_free_buffers:
  1023. for_each_buffer_cpu(buffer, cpu) {
  1024. if (buffer->buffers[cpu])
  1025. rb_free_cpu_buffer(buffer->buffers[cpu]);
  1026. }
  1027. kfree(buffer->buffers);
  1028. fail_free_cpumask:
  1029. free_cpumask_var(buffer->cpumask);
  1030. put_online_cpus();
  1031. fail_free_buffer:
  1032. kfree(buffer);
  1033. return NULL;
  1034. }
  1035. EXPORT_SYMBOL_GPL(__ring_buffer_alloc);
  1036. /**
  1037. * ring_buffer_free - free a ring buffer.
  1038. * @buffer: the buffer to free.
  1039. */
  1040. void
  1041. ring_buffer_free(struct ring_buffer *buffer)
  1042. {
  1043. int cpu;
  1044. get_online_cpus();
  1045. #ifdef CONFIG_HOTPLUG_CPU
  1046. unregister_cpu_notifier(&buffer->cpu_notify);
  1047. #endif
  1048. for_each_buffer_cpu(buffer, cpu)
  1049. rb_free_cpu_buffer(buffer->buffers[cpu]);
  1050. put_online_cpus();
  1051. kfree(buffer->buffers);
  1052. free_cpumask_var(buffer->cpumask);
  1053. kfree(buffer);
  1054. }
  1055. EXPORT_SYMBOL_GPL(ring_buffer_free);
  1056. void ring_buffer_set_clock(struct ring_buffer *buffer,
  1057. u64 (*clock)(void))
  1058. {
  1059. buffer->clock = clock;
  1060. }
  1061. static void rb_reset_cpu(struct ring_buffer_per_cpu *cpu_buffer);
  1062. static inline unsigned long rb_page_entries(struct buffer_page *bpage)
  1063. {
  1064. return local_read(&bpage->entries) & RB_WRITE_MASK;
  1065. }
  1066. static inline unsigned long rb_page_write(struct buffer_page *bpage)
  1067. {
  1068. return local_read(&bpage->write) & RB_WRITE_MASK;
  1069. }
  1070. static int
  1071. rb_remove_pages(struct ring_buffer_per_cpu *cpu_buffer, unsigned int nr_pages)
  1072. {
  1073. struct list_head *tail_page, *to_remove, *next_page;
  1074. struct buffer_page *to_remove_page, *tmp_iter_page;
  1075. struct buffer_page *last_page, *first_page;
  1076. unsigned int nr_removed;
  1077. unsigned long head_bit;
  1078. int page_entries;
  1079. head_bit = 0;
  1080. raw_spin_lock_irq(&cpu_buffer->reader_lock);
  1081. atomic_inc(&cpu_buffer->record_disabled);
  1082. /*
  1083. * We don't race with the readers since we have acquired the reader
  1084. * lock. We also don't race with writers after disabling recording.
  1085. * This makes it easy to figure out the first and the last page to be
  1086. * removed from the list. We unlink all the pages in between including
  1087. * the first and last pages. This is done in a busy loop so that we
  1088. * lose the least number of traces.
  1089. * The pages are freed after we restart recording and unlock readers.
  1090. */
  1091. tail_page = &cpu_buffer->tail_page->list;
  1092. /*
  1093. * tail page might be on reader page, we remove the next page
  1094. * from the ring buffer
  1095. */
  1096. if (cpu_buffer->tail_page == cpu_buffer->reader_page)
  1097. tail_page = rb_list_head(tail_page->next);
  1098. to_remove = tail_page;
  1099. /* start of pages to remove */
  1100. first_page = list_entry(rb_list_head(to_remove->next),
  1101. struct buffer_page, list);
  1102. for (nr_removed = 0; nr_removed < nr_pages; nr_removed++) {
  1103. to_remove = rb_list_head(to_remove)->next;
  1104. head_bit |= (unsigned long)to_remove & RB_PAGE_HEAD;
  1105. }
  1106. next_page = rb_list_head(to_remove)->next;
  1107. /*
  1108. * Now we remove all pages between tail_page and next_page.
  1109. * Make sure that we have head_bit value preserved for the
  1110. * next page
  1111. */
  1112. tail_page->next = (struct list_head *)((unsigned long)next_page |
  1113. head_bit);
  1114. next_page = rb_list_head(next_page);
  1115. next_page->prev = tail_page;
  1116. /* make sure pages points to a valid page in the ring buffer */
  1117. cpu_buffer->pages = next_page;
  1118. /* update head page */
  1119. if (head_bit)
  1120. cpu_buffer->head_page = list_entry(next_page,
  1121. struct buffer_page, list);
  1122. /*
  1123. * change read pointer to make sure any read iterators reset
  1124. * themselves
  1125. */
  1126. cpu_buffer->read = 0;
  1127. /* pages are removed, resume tracing and then free the pages */
  1128. atomic_dec(&cpu_buffer->record_disabled);
  1129. raw_spin_unlock_irq(&cpu_buffer->reader_lock);
  1130. RB_WARN_ON(cpu_buffer, list_empty(cpu_buffer->pages));
  1131. /* last buffer page to remove */
  1132. last_page = list_entry(rb_list_head(to_remove), struct buffer_page,
  1133. list);
  1134. tmp_iter_page = first_page;
  1135. do {
  1136. to_remove_page = tmp_iter_page;
  1137. rb_inc_page(cpu_buffer, &tmp_iter_page);
  1138. /* update the counters */
  1139. page_entries = rb_page_entries(to_remove_page);
  1140. if (page_entries) {
  1141. /*
  1142. * If something was added to this page, it was full
  1143. * since it is not the tail page. So we deduct the
  1144. * bytes consumed in ring buffer from here.
  1145. * Increment overrun to account for the lost events.
  1146. */
  1147. local_add(page_entries, &cpu_buffer->overrun);
  1148. local_sub(BUF_PAGE_SIZE, &cpu_buffer->entries_bytes);
  1149. }
  1150. /*
  1151. * We have already removed references to this list item, just
  1152. * free up the buffer_page and its page
  1153. */
  1154. free_buffer_page(to_remove_page);
  1155. nr_removed--;
  1156. } while (to_remove_page != last_page);
  1157. RB_WARN_ON(cpu_buffer, nr_removed);
  1158. return nr_removed == 0;
  1159. }
  1160. static int
  1161. rb_insert_pages(struct ring_buffer_per_cpu *cpu_buffer)
  1162. {
  1163. struct list_head *pages = &cpu_buffer->new_pages;
  1164. int retries, success;
  1165. raw_spin_lock_irq(&cpu_buffer->reader_lock);
  1166. /*
  1167. * We are holding the reader lock, so the reader page won't be swapped
  1168. * in the ring buffer. Now we are racing with the writer trying to
  1169. * move head page and the tail page.
  1170. * We are going to adapt the reader page update process where:
  1171. * 1. We first splice the start and end of list of new pages between
  1172. * the head page and its previous page.
  1173. * 2. We cmpxchg the prev_page->next to point from head page to the
  1174. * start of new pages list.
  1175. * 3. Finally, we update the head->prev to the end of new list.
  1176. *
  1177. * We will try this process 10 times, to make sure that we don't keep
  1178. * spinning.
  1179. */
  1180. retries = 10;
  1181. success = 0;
  1182. while (retries--) {
  1183. struct list_head *head_page, *prev_page, *r;
  1184. struct list_head *last_page, *first_page;
  1185. struct list_head *head_page_with_bit;
  1186. head_page = &rb_set_head_page(cpu_buffer)->list;
  1187. prev_page = head_page->prev;
  1188. first_page = pages->next;
  1189. last_page = pages->prev;
  1190. head_page_with_bit = (struct list_head *)
  1191. ((unsigned long)head_page | RB_PAGE_HEAD);
  1192. last_page->next = head_page_with_bit;
  1193. first_page->prev = prev_page;
  1194. r = cmpxchg(&prev_page->next, head_page_with_bit, first_page);
  1195. if (r == head_page_with_bit) {
  1196. /*
  1197. * yay, we replaced the page pointer to our new list,
  1198. * now, we just have to update to head page's prev
  1199. * pointer to point to end of list
  1200. */
  1201. head_page->prev = last_page;
  1202. success = 1;
  1203. break;
  1204. }
  1205. }
  1206. if (success)
  1207. INIT_LIST_HEAD(pages);
  1208. /*
  1209. * If we weren't successful in adding in new pages, warn and stop
  1210. * tracing
  1211. */
  1212. RB_WARN_ON(cpu_buffer, !success);
  1213. raw_spin_unlock_irq(&cpu_buffer->reader_lock);
  1214. /* free pages if they weren't inserted */
  1215. if (!success) {
  1216. struct buffer_page *bpage, *tmp;
  1217. list_for_each_entry_safe(bpage, tmp, &cpu_buffer->new_pages,
  1218. list) {
  1219. list_del_init(&bpage->list);
  1220. free_buffer_page(bpage);
  1221. }
  1222. }
  1223. return success;
  1224. }
  1225. static void rb_update_pages(struct ring_buffer_per_cpu *cpu_buffer)
  1226. {
  1227. int success;
  1228. if (cpu_buffer->nr_pages_to_update > 0)
  1229. success = rb_insert_pages(cpu_buffer);
  1230. else
  1231. success = rb_remove_pages(cpu_buffer,
  1232. -cpu_buffer->nr_pages_to_update);
  1233. if (success)
  1234. cpu_buffer->nr_pages += cpu_buffer->nr_pages_to_update;
  1235. }
  1236. static void update_pages_handler(struct work_struct *work)
  1237. {
  1238. struct ring_buffer_per_cpu *cpu_buffer = container_of(work,
  1239. struct ring_buffer_per_cpu, update_pages_work);
  1240. rb_update_pages(cpu_buffer);
  1241. complete(&cpu_buffer->update_done);
  1242. }
  1243. /**
  1244. * ring_buffer_resize - resize the ring buffer
  1245. * @buffer: the buffer to resize.
  1246. * @size: the new size.
  1247. *
  1248. * Minimum size is 2 * BUF_PAGE_SIZE.
  1249. *
  1250. * Returns 0 on success and < 0 on failure.
  1251. */
  1252. int ring_buffer_resize(struct ring_buffer *buffer, unsigned long size,
  1253. int cpu_id)
  1254. {
  1255. struct ring_buffer_per_cpu *cpu_buffer;
  1256. unsigned nr_pages;
  1257. int cpu, err = 0;
  1258. /*
  1259. * Always succeed at resizing a non-existent buffer:
  1260. */
  1261. if (!buffer)
  1262. return size;
  1263. /* Make sure the requested buffer exists */
  1264. if (cpu_id != RING_BUFFER_ALL_CPUS &&
  1265. !cpumask_test_cpu(cpu_id, buffer->cpumask))
  1266. return size;
  1267. size = DIV_ROUND_UP(size, BUF_PAGE_SIZE);
  1268. size *= BUF_PAGE_SIZE;
  1269. /* we need a minimum of two pages */
  1270. if (size < BUF_PAGE_SIZE * 2)
  1271. size = BUF_PAGE_SIZE * 2;
  1272. nr_pages = DIV_ROUND_UP(size, BUF_PAGE_SIZE);
  1273. /*
  1274. * Don't succeed if resizing is disabled, as a reader might be
  1275. * manipulating the ring buffer and is expecting a sane state while
  1276. * this is true.
  1277. */
  1278. if (atomic_read(&buffer->resize_disabled))
  1279. return -EBUSY;
  1280. /* prevent another thread from changing buffer sizes */
  1281. mutex_lock(&buffer->mutex);
  1282. if (cpu_id == RING_BUFFER_ALL_CPUS) {
  1283. /* calculate the pages to update */
  1284. for_each_buffer_cpu(buffer, cpu) {
  1285. cpu_buffer = buffer->buffers[cpu];
  1286. cpu_buffer->nr_pages_to_update = nr_pages -
  1287. cpu_buffer->nr_pages;
  1288. /*
  1289. * nothing more to do for removing pages or no update
  1290. */
  1291. if (cpu_buffer->nr_pages_to_update <= 0)
  1292. continue;
  1293. /*
  1294. * to add pages, make sure all new pages can be
  1295. * allocated without receiving ENOMEM
  1296. */
  1297. INIT_LIST_HEAD(&cpu_buffer->new_pages);
  1298. if (__rb_allocate_pages(cpu_buffer->nr_pages_to_update,
  1299. &cpu_buffer->new_pages, cpu)) {
  1300. /* not enough memory for new pages */
  1301. err = -ENOMEM;
  1302. goto out_err;
  1303. }
  1304. }
  1305. get_online_cpus();
  1306. /*
  1307. * Fire off all the required work handlers
  1308. * We can't schedule on offline CPUs, but it's not necessary
  1309. * since we can change their buffer sizes without any race.
  1310. */
  1311. for_each_buffer_cpu(buffer, cpu) {
  1312. cpu_buffer = buffer->buffers[cpu];
  1313. if (!cpu_buffer->nr_pages_to_update)
  1314. continue;
  1315. if (cpu_online(cpu))
  1316. schedule_work_on(cpu,
  1317. &cpu_buffer->update_pages_work);
  1318. else
  1319. rb_update_pages(cpu_buffer);
  1320. }
  1321. /* wait for all the updates to complete */
  1322. for_each_buffer_cpu(buffer, cpu) {
  1323. cpu_buffer = buffer->buffers[cpu];
  1324. if (!cpu_buffer->nr_pages_to_update)
  1325. continue;
  1326. if (cpu_online(cpu))
  1327. wait_for_completion(&cpu_buffer->update_done);
  1328. cpu_buffer->nr_pages_to_update = 0;
  1329. }
  1330. put_online_cpus();
  1331. } else {
  1332. cpu_buffer = buffer->buffers[cpu_id];
  1333. if (nr_pages == cpu_buffer->nr_pages)
  1334. goto out;
  1335. cpu_buffer->nr_pages_to_update = nr_pages -
  1336. cpu_buffer->nr_pages;
  1337. INIT_LIST_HEAD(&cpu_buffer->new_pages);
  1338. if (cpu_buffer->nr_pages_to_update > 0 &&
  1339. __rb_allocate_pages(cpu_buffer->nr_pages_to_update,
  1340. &cpu_buffer->new_pages, cpu_id)) {
  1341. err = -ENOMEM;
  1342. goto out_err;
  1343. }
  1344. get_online_cpus();
  1345. if (cpu_online(cpu_id)) {
  1346. schedule_work_on(cpu_id,
  1347. &cpu_buffer->update_pages_work);
  1348. wait_for_completion(&cpu_buffer->update_done);
  1349. } else
  1350. rb_update_pages(cpu_buffer);
  1351. cpu_buffer->nr_pages_to_update = 0;
  1352. put_online_cpus();
  1353. }
  1354. out:
  1355. /*
  1356. * The ring buffer resize can happen with the ring buffer
  1357. * enabled, so that the update disturbs the tracing as little
  1358. * as possible. But if the buffer is disabled, we do not need
  1359. * to worry about that, and we can take the time to verify
  1360. * that the buffer is not corrupt.
  1361. */
  1362. if (atomic_read(&buffer->record_disabled)) {
  1363. atomic_inc(&buffer->record_disabled);
  1364. /*
  1365. * Even though the buffer was disabled, we must make sure
  1366. * that it is truly disabled before calling rb_check_pages.
  1367. * There could have been a race between checking
  1368. * record_disable and incrementing it.
  1369. */
  1370. synchronize_sched();
  1371. for_each_buffer_cpu(buffer, cpu) {
  1372. cpu_buffer = buffer->buffers[cpu];
  1373. rb_check_pages(cpu_buffer);
  1374. }
  1375. atomic_dec(&buffer->record_disabled);
  1376. }
  1377. mutex_unlock(&buffer->mutex);
  1378. return size;
  1379. out_err:
  1380. for_each_buffer_cpu(buffer, cpu) {
  1381. struct buffer_page *bpage, *tmp;
  1382. cpu_buffer = buffer->buffers[cpu];
  1383. cpu_buffer->nr_pages_to_update = 0;
  1384. if (list_empty(&cpu_buffer->new_pages))
  1385. continue;
  1386. list_for_each_entry_safe(bpage, tmp, &cpu_buffer->new_pages,
  1387. list) {
  1388. list_del_init(&bpage->list);
  1389. free_buffer_page(bpage);
  1390. }
  1391. }
  1392. mutex_unlock(&buffer->mutex);
  1393. return err;
  1394. }
  1395. EXPORT_SYMBOL_GPL(ring_buffer_resize);
  1396. void ring_buffer_change_overwrite(struct ring_buffer *buffer, int val)
  1397. {
  1398. mutex_lock(&buffer->mutex);
  1399. if (val)
  1400. buffer->flags |= RB_FL_OVERWRITE;
  1401. else
  1402. buffer->flags &= ~RB_FL_OVERWRITE;
  1403. mutex_unlock(&buffer->mutex);
  1404. }
  1405. EXPORT_SYMBOL_GPL(ring_buffer_change_overwrite);
  1406. static inline void *
  1407. __rb_data_page_index(struct buffer_data_page *bpage, unsigned index)
  1408. {
  1409. return bpage->data + index;
  1410. }
  1411. static inline void *__rb_page_index(struct buffer_page *bpage, unsigned index)
  1412. {
  1413. return bpage->page->data + index;
  1414. }
  1415. static inline struct ring_buffer_event *
  1416. rb_reader_event(struct ring_buffer_per_cpu *cpu_buffer)
  1417. {
  1418. return __rb_page_index(cpu_buffer->reader_page,
  1419. cpu_buffer->reader_page->read);
  1420. }
  1421. static inline struct ring_buffer_event *
  1422. rb_iter_head_event(struct ring_buffer_iter *iter)
  1423. {
  1424. return __rb_page_index(iter->head_page, iter->head);
  1425. }
  1426. static inline unsigned rb_page_commit(struct buffer_page *bpage)
  1427. {
  1428. return local_read(&bpage->page->commit);
  1429. }
  1430. /* Size is determined by what has been committed */
  1431. static inline unsigned rb_page_size(struct buffer_page *bpage)
  1432. {
  1433. return rb_page_commit(bpage);
  1434. }
  1435. static inline unsigned
  1436. rb_commit_index(struct ring_buffer_per_cpu *cpu_buffer)
  1437. {
  1438. return rb_page_commit(cpu_buffer->commit_page);
  1439. }
  1440. static inline unsigned
  1441. rb_event_index(struct ring_buffer_event *event)
  1442. {
  1443. unsigned long addr = (unsigned long)event;
  1444. return (addr & ~PAGE_MASK) - BUF_PAGE_HDR_SIZE;
  1445. }
  1446. static inline int
  1447. rb_event_is_commit(struct ring_buffer_per_cpu *cpu_buffer,
  1448. struct ring_buffer_event *event)
  1449. {
  1450. unsigned long addr = (unsigned long)event;
  1451. unsigned long index;
  1452. index = rb_event_index(event);
  1453. addr &= PAGE_MASK;
  1454. return cpu_buffer->commit_page->page == (void *)addr &&
  1455. rb_commit_index(cpu_buffer) == index;
  1456. }
  1457. static void
  1458. rb_set_commit_to_write(struct ring_buffer_per_cpu *cpu_buffer)
  1459. {
  1460. unsigned long max_count;
  1461. /*
  1462. * We only race with interrupts and NMIs on this CPU.
  1463. * If we own the commit event, then we can commit
  1464. * all others that interrupted us, since the interruptions
  1465. * are in stack format (they finish before they come
  1466. * back to us). This allows us to do a simple loop to
  1467. * assign the commit to the tail.
  1468. */
  1469. again:
  1470. max_count = cpu_buffer->nr_pages * 100;
  1471. while (cpu_buffer->commit_page != cpu_buffer->tail_page) {
  1472. if (RB_WARN_ON(cpu_buffer, !(--max_count)))
  1473. return;
  1474. if (RB_WARN_ON(cpu_buffer,
  1475. rb_is_reader_page(cpu_buffer->tail_page)))
  1476. return;
  1477. local_set(&cpu_buffer->commit_page->page->commit,
  1478. rb_page_write(cpu_buffer->commit_page));
  1479. rb_inc_page(cpu_buffer, &cpu_buffer->commit_page);
  1480. cpu_buffer->write_stamp =
  1481. cpu_buffer->commit_page->page->time_stamp;
  1482. /* add barrier to keep gcc from optimizing too much */
  1483. barrier();
  1484. }
  1485. while (rb_commit_index(cpu_buffer) !=
  1486. rb_page_write(cpu_buffer->commit_page)) {
  1487. local_set(&cpu_buffer->commit_page->page->commit,
  1488. rb_page_write(cpu_buffer->commit_page));
  1489. RB_WARN_ON(cpu_buffer,
  1490. local_read(&cpu_buffer->commit_page->page->commit) &
  1491. ~RB_WRITE_MASK);
  1492. barrier();
  1493. }
  1494. /* again, keep gcc from optimizing */
  1495. barrier();
  1496. /*
  1497. * If an interrupt came in just after the first while loop
  1498. * and pushed the tail page forward, we will be left with
  1499. * a dangling commit that will never go forward.
  1500. */
  1501. if (unlikely(cpu_buffer->commit_page != cpu_buffer->tail_page))
  1502. goto again;
  1503. }
  1504. static void rb_reset_reader_page(struct ring_buffer_per_cpu *cpu_buffer)
  1505. {
  1506. cpu_buffer->read_stamp = cpu_buffer->reader_page->page->time_stamp;
  1507. cpu_buffer->reader_page->read = 0;
  1508. }
  1509. static void rb_inc_iter(struct ring_buffer_iter *iter)
  1510. {
  1511. struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;
  1512. /*
  1513. * The iterator could be on the reader page (it starts there).
  1514. * But the head could have moved, since the reader was
  1515. * found. Check for this case and assign the iterator
  1516. * to the head page instead of next.
  1517. */
  1518. if (iter->head_page == cpu_buffer->reader_page)
  1519. iter->head_page = rb_set_head_page(cpu_buffer);
  1520. else
  1521. rb_inc_page(cpu_buffer, &iter->head_page);
  1522. iter->read_stamp = iter->head_page->page->time_stamp;
  1523. iter->head = 0;
  1524. }
  1525. /* Slow path, do not inline */
  1526. static noinline struct ring_buffer_event *
  1527. rb_add_time_stamp(struct ring_buffer_event *event, u64 delta)
  1528. {
  1529. event->type_len = RINGBUF_TYPE_TIME_EXTEND;
  1530. /* Not the first event on the page? */
  1531. if (rb_event_index(event)) {
  1532. event->time_delta = delta & TS_MASK;
  1533. event->array[0] = delta >> TS_SHIFT;
  1534. } else {
  1535. /* nope, just zero it */
  1536. event->time_delta = 0;
  1537. event->array[0] = 0;
  1538. }
  1539. return skip_time_extend(event);
  1540. }
  1541. /**
  1542. * ring_buffer_update_event - update event type and data
  1543. * @event: the even to update
  1544. * @type: the type of event
  1545. * @length: the size of the event field in the ring buffer
  1546. *
  1547. * Update the type and data fields of the event. The length
  1548. * is the actual size that is written to the ring buffer,
  1549. * and with this, we can determine what to place into the
  1550. * data field.
  1551. */
  1552. static void
  1553. rb_update_event(struct ring_buffer_per_cpu *cpu_buffer,
  1554. struct ring_buffer_event *event, unsigned length,
  1555. int add_timestamp, u64 delta)
  1556. {
  1557. /* Only a commit updates the timestamp */
  1558. if (unlikely(!rb_event_is_commit(cpu_buffer, event)))
  1559. delta = 0;
  1560. /*
  1561. * If we need to add a timestamp, then we
  1562. * add it to the start of the resevered space.
  1563. */
  1564. if (unlikely(add_timestamp)) {
  1565. event = rb_add_time_stamp(event, delta);
  1566. length -= RB_LEN_TIME_EXTEND;
  1567. delta = 0;
  1568. }
  1569. event->time_delta = delta;
  1570. length -= RB_EVNT_HDR_SIZE;
  1571. if (length > RB_MAX_SMALL_DATA || RB_FORCE_8BYTE_ALIGNMENT) {
  1572. event->type_len = 0;
  1573. event->array[0] = length;
  1574. } else
  1575. event->type_len = DIV_ROUND_UP(length, RB_ALIGNMENT);
  1576. }
  1577. /*
  1578. * rb_handle_head_page - writer hit the head page
  1579. *
  1580. * Returns: +1 to retry page
  1581. * 0 to continue
  1582. * -1 on error
  1583. */
  1584. static int
  1585. rb_handle_head_page(struct ring_buffer_per_cpu *cpu_buffer,
  1586. struct buffer_page *tail_page,
  1587. struct buffer_page *next_page)
  1588. {
  1589. struct buffer_page *new_head;
  1590. int entries;
  1591. int type;
  1592. int ret;
  1593. entries = rb_page_entries(next_page);
  1594. /*
  1595. * The hard part is here. We need to move the head
  1596. * forward, and protect against both readers on
  1597. * other CPUs and writers coming in via interrupts.
  1598. */
  1599. type = rb_head_page_set_update(cpu_buffer, next_page, tail_page,
  1600. RB_PAGE_HEAD);
  1601. /*
  1602. * type can be one of four:
  1603. * NORMAL - an interrupt already moved it for us
  1604. * HEAD - we are the first to get here.
  1605. * UPDATE - we are the interrupt interrupting
  1606. * a current move.
  1607. * MOVED - a reader on another CPU moved the next
  1608. * pointer to its reader page. Give up
  1609. * and try again.
  1610. */
  1611. switch (type) {
  1612. case RB_PAGE_HEAD:
  1613. /*
  1614. * We changed the head to UPDATE, thus
  1615. * it is our responsibility to update
  1616. * the counters.
  1617. */
  1618. local_add(entries, &cpu_buffer->overrun);
  1619. local_sub(BUF_PAGE_SIZE, &cpu_buffer->entries_bytes);
  1620. /*
  1621. * The entries will be zeroed out when we move the
  1622. * tail page.
  1623. */
  1624. /* still more to do */
  1625. break;
  1626. case RB_PAGE_UPDATE:
  1627. /*
  1628. * This is an interrupt that interrupt the
  1629. * previous update. Still more to do.
  1630. */
  1631. break;
  1632. case RB_PAGE_NORMAL:
  1633. /*
  1634. * An interrupt came in before the update
  1635. * and processed this for us.
  1636. * Nothing left to do.
  1637. */
  1638. return 1;
  1639. case RB_PAGE_MOVED:
  1640. /*
  1641. * The reader is on another CPU and just did
  1642. * a swap with our next_page.
  1643. * Try again.
  1644. */
  1645. return 1;
  1646. default:
  1647. RB_WARN_ON(cpu_buffer, 1); /* WTF??? */
  1648. return -1;
  1649. }
  1650. /*
  1651. * Now that we are here, the old head pointer is
  1652. * set to UPDATE. This will keep the reader from
  1653. * swapping the head page with the reader page.
  1654. * The reader (on another CPU) will spin till
  1655. * we are finished.
  1656. *
  1657. * We just need to protect against interrupts
  1658. * doing the job. We will set the next pointer
  1659. * to HEAD. After that, we set the old pointer
  1660. * to NORMAL, but only if it was HEAD before.
  1661. * otherwise we are an interrupt, and only
  1662. * want the outer most commit to reset it.
  1663. */
  1664. new_head = next_page;
  1665. rb_inc_page(cpu_buffer, &new_head);
  1666. ret = rb_head_page_set_head(cpu_buffer, new_head, next_page,
  1667. RB_PAGE_NORMAL);
  1668. /*
  1669. * Valid returns are:
  1670. * HEAD - an interrupt came in and already set it.
  1671. * NORMAL - One of two things:
  1672. * 1) We really set it.
  1673. * 2) A bunch of interrupts came in and moved
  1674. * the page forward again.
  1675. */
  1676. switch (ret) {
  1677. case RB_PAGE_HEAD:
  1678. case RB_PAGE_NORMAL:
  1679. /* OK */
  1680. break;
  1681. default:
  1682. RB_WARN_ON(cpu_buffer, 1);
  1683. return -1;
  1684. }
  1685. /*
  1686. * It is possible that an interrupt came in,
  1687. * set the head up, then more interrupts came in
  1688. * and moved it again. When we get back here,
  1689. * the page would have been set to NORMAL but we
  1690. * just set it back to HEAD.
  1691. *
  1692. * How do you detect this? Well, if that happened
  1693. * the tail page would have moved.
  1694. */
  1695. if (ret == RB_PAGE_NORMAL) {
  1696. /*
  1697. * If the tail had moved passed next, then we need
  1698. * to reset the pointer.
  1699. */
  1700. if (cpu_buffer->tail_page != tail_page &&
  1701. cpu_buffer->tail_page != next_page)
  1702. rb_head_page_set_normal(cpu_buffer, new_head,
  1703. next_page,
  1704. RB_PAGE_HEAD);
  1705. }
  1706. /*
  1707. * If this was the outer most commit (the one that
  1708. * changed the original pointer from HEAD to UPDATE),
  1709. * then it is up to us to reset it to NORMAL.
  1710. */
  1711. if (type == RB_PAGE_HEAD) {
  1712. ret = rb_head_page_set_normal(cpu_buffer, next_page,
  1713. tail_page,
  1714. RB_PAGE_UPDATE);
  1715. if (RB_WARN_ON(cpu_buffer,
  1716. ret != RB_PAGE_UPDATE))
  1717. return -1;
  1718. }
  1719. return 0;
  1720. }
  1721. static unsigned rb_calculate_event_length(unsigned length)
  1722. {
  1723. struct ring_buffer_event event; /* Used only for sizeof array */
  1724. /* zero length can cause confusions */
  1725. if (!length)
  1726. length = 1;
  1727. if (length > RB_MAX_SMALL_DATA || RB_FORCE_8BYTE_ALIGNMENT)
  1728. length += sizeof(event.array[0]);
  1729. length += RB_EVNT_HDR_SIZE;
  1730. length = ALIGN(length, RB_ARCH_ALIGNMENT);
  1731. return length;
  1732. }
  1733. static inline void
  1734. rb_reset_tail(struct ring_buffer_per_cpu *cpu_buffer,
  1735. struct buffer_page *tail_page,
  1736. unsigned long tail, unsigned long length)
  1737. {
  1738. struct ring_buffer_event *event;
  1739. /*
  1740. * Only the event that crossed the page boundary
  1741. * must fill the old tail_page with padding.
  1742. */
  1743. if (tail >= BUF_PAGE_SIZE) {
  1744. /*
  1745. * If the page was filled, then we still need
  1746. * to update the real_end. Reset it to zero
  1747. * and the reader will ignore it.
  1748. */
  1749. if (tail == BUF_PAGE_SIZE)
  1750. tail_page->real_end = 0;
  1751. local_sub(length, &tail_page->write);
  1752. return;
  1753. }
  1754. event = __rb_page_index(tail_page, tail);
  1755. kmemcheck_annotate_bitfield(event, bitfield);
  1756. /* account for padding bytes */
  1757. local_add(BUF_PAGE_SIZE - tail, &cpu_buffer->entries_bytes);
  1758. /*
  1759. * Save the original length to the meta data.
  1760. * This will be used by the reader to add lost event
  1761. * counter.
  1762. */
  1763. tail_page->real_end = tail;
  1764. /*
  1765. * If this event is bigger than the minimum size, then
  1766. * we need to be careful that we don't subtract the
  1767. * write counter enough to allow another writer to slip
  1768. * in on this page.
  1769. * We put in a discarded commit instead, to make sure
  1770. * that this space is not used again.
  1771. *
  1772. * If we are less than the minimum size, we don't need to
  1773. * worry about it.
  1774. */
  1775. if (tail > (BUF_PAGE_SIZE - RB_EVNT_MIN_SIZE)) {
  1776. /* No room for any events */
  1777. /* Mark the rest of the page with padding */
  1778. rb_event_set_padding(event);
  1779. /* Set the write back to the previous setting */
  1780. local_sub(length, &tail_page->write);
  1781. return;
  1782. }
  1783. /* Put in a discarded event */
  1784. event->array[0] = (BUF_PAGE_SIZE - tail) - RB_EVNT_HDR_SIZE;
  1785. event->type_len = RINGBUF_TYPE_PADDING;
  1786. /* time delta must be non zero */
  1787. event->time_delta = 1;
  1788. /* Set write to end of buffer */
  1789. length = (tail + length) - BUF_PAGE_SIZE;
  1790. local_sub(length, &tail_page->write);
  1791. }
  1792. /*
  1793. * This is the slow path, force gcc not to inline it.
  1794. */
  1795. static noinline struct ring_buffer_event *
  1796. rb_move_tail(struct ring_buffer_per_cpu *cpu_buffer,
  1797. unsigned long length, unsigned long tail,
  1798. struct buffer_page *tail_page, u64 ts)
  1799. {
  1800. struct buffer_page *commit_page = cpu_buffer->commit_page;
  1801. struct ring_buffer *buffer = cpu_buffer->buffer;
  1802. struct buffer_page *next_page;
  1803. int ret;
  1804. next_page = tail_page;
  1805. rb_inc_page(cpu_buffer, &next_page);
  1806. /*
  1807. * If for some reason, we had an interrupt storm that made
  1808. * it all the way around the buffer, bail, and warn
  1809. * about it.
  1810. */
  1811. if (unlikely(next_page == commit_page)) {
  1812. local_inc(&cpu_buffer->commit_overrun);
  1813. goto out_reset;
  1814. }
  1815. /*
  1816. * This is where the fun begins!
  1817. *
  1818. * We are fighting against races between a reader that
  1819. * could be on another CPU trying to swap its reader
  1820. * page with the buffer head.
  1821. *
  1822. * We are also fighting against interrupts coming in and
  1823. * moving the head or tail on us as well.
  1824. *
  1825. * If the next page is the head page then we have filled
  1826. * the buffer, unless the commit page is still on the
  1827. * reader page.
  1828. */
  1829. if (rb_is_head_page(cpu_buffer, next_page, &tail_page->list)) {
  1830. /*
  1831. * If the commit is not on the reader page, then
  1832. * move the header page.
  1833. */
  1834. if (!rb_is_reader_page(cpu_buffer->commit_page)) {
  1835. /*
  1836. * If we are not in overwrite mode,
  1837. * this is easy, just stop here.
  1838. */
  1839. if (!(buffer->flags & RB_FL_OVERWRITE))
  1840. goto out_reset;
  1841. ret = rb_handle_head_page(cpu_buffer,
  1842. tail_page,
  1843. next_page);
  1844. if (ret < 0)
  1845. goto out_reset;
  1846. if (ret)
  1847. goto out_again;
  1848. } else {
  1849. /*
  1850. * We need to be careful here too. The
  1851. * commit page could still be on the reader
  1852. * page. We could have a small buffer, and
  1853. * have filled up the buffer with events
  1854. * from interrupts and such, and wrapped.
  1855. *
  1856. * Note, if the tail page is also the on the
  1857. * reader_page, we let it move out.
  1858. */
  1859. if (unlikely((cpu_buffer->commit_page !=
  1860. cpu_buffer->tail_page) &&
  1861. (cpu_buffer->commit_page ==
  1862. cpu_buffer->reader_page))) {
  1863. local_inc(&cpu_buffer->commit_overrun);
  1864. goto out_reset;
  1865. }
  1866. }
  1867. }
  1868. ret = rb_tail_page_update(cpu_buffer, tail_page, next_page);
  1869. if (ret) {
  1870. /*
  1871. * Nested commits always have zero deltas, so
  1872. * just reread the time stamp
  1873. */
  1874. ts = rb_time_stamp(buffer);
  1875. next_page->page->time_stamp = ts;
  1876. }
  1877. out_again:
  1878. rb_reset_tail(cpu_buffer, tail_page, tail, length);
  1879. /* fail and let the caller try again */
  1880. return ERR_PTR(-EAGAIN);
  1881. out_reset:
  1882. /* reset write */
  1883. rb_reset_tail(cpu_buffer, tail_page, tail, length);
  1884. return NULL;
  1885. }
  1886. static struct ring_buffer_event *
  1887. __rb_reserve_next(struct ring_buffer_per_cpu *cpu_buffer,
  1888. unsigned long length, u64 ts,
  1889. u64 delta, int add_timestamp)
  1890. {
  1891. struct buffer_page *tail_page;
  1892. struct ring_buffer_event *event;
  1893. unsigned long tail, write;
  1894. /*
  1895. * If the time delta since the last event is too big to
  1896. * hold in the time field of the event, then we append a
  1897. * TIME EXTEND event ahead of the data event.
  1898. */
  1899. if (unlikely(add_timestamp))
  1900. length += RB_LEN_TIME_EXTEND;
  1901. tail_page = cpu_buffer->tail_page;
  1902. write = local_add_return(length, &tail_page->write);
  1903. /* set write to only the index of the write */
  1904. write &= RB_WRITE_MASK;
  1905. tail = write - length;
  1906. /* See if we shot pass the end of this buffer page */
  1907. if (unlikely(write > BUF_PAGE_SIZE))
  1908. return rb_move_tail(cpu_buffer, length, tail,
  1909. tail_page, ts);
  1910. /* We reserved something on the buffer */
  1911. event = __rb_page_index(tail_page, tail);
  1912. kmemcheck_annotate_bitfield(event, bitfield);
  1913. rb_update_event(cpu_buffer, event, length, add_timestamp, delta);
  1914. local_inc(&tail_page->entries);
  1915. /*
  1916. * If this is the first commit on the page, then update
  1917. * its timestamp.
  1918. */
  1919. if (!tail)
  1920. tail_page->page->time_stamp = ts;
  1921. /* account for these added bytes */
  1922. local_add(length, &cpu_buffer->entries_bytes);
  1923. return event;
  1924. }
  1925. static inline int
  1926. rb_try_to_discard(struct ring_buffer_per_cpu *cpu_buffer,
  1927. struct ring_buffer_event *event)
  1928. {
  1929. unsigned long new_index, old_index;
  1930. struct buffer_page *bpage;
  1931. unsigned long index;
  1932. unsigned long addr;
  1933. new_index = rb_event_index(event);
  1934. old_index = new_index + rb_event_ts_length(event);
  1935. addr = (unsigned long)event;
  1936. addr &= PAGE_MASK;
  1937. bpage = cpu_buffer->tail_page;
  1938. if (bpage->page == (void *)addr && rb_page_write(bpage) == old_index) {
  1939. unsigned long write_mask =
  1940. local_read(&bpage->write) & ~RB_WRITE_MASK;
  1941. unsigned long event_length = rb_event_length(event);
  1942. /*
  1943. * This is on the tail page. It is possible that
  1944. * a write could come in and move the tail page
  1945. * and write to the next page. That is fine
  1946. * because we just shorten what is on this page.
  1947. */
  1948. old_index += write_mask;
  1949. new_index += write_mask;
  1950. index = local_cmpxchg(&bpage->write, old_index, new_index);
  1951. if (index == old_index) {
  1952. /* update counters */
  1953. local_sub(event_length, &cpu_buffer->entries_bytes);
  1954. return 1;
  1955. }
  1956. }
  1957. /* could not discard */
  1958. return 0;
  1959. }
  1960. static void rb_start_commit(struct ring_buffer_per_cpu *cpu_buffer)
  1961. {
  1962. local_inc(&cpu_buffer->committing);
  1963. local_inc(&cpu_buffer->commits);
  1964. }
  1965. static inline void rb_end_commit(struct ring_buffer_per_cpu *cpu_buffer)
  1966. {
  1967. unsigned long commits;
  1968. if (RB_WARN_ON(cpu_buffer,
  1969. !local_read(&cpu_buffer->committing)))
  1970. return;
  1971. again:
  1972. commits = local_read(&cpu_buffer->commits);
  1973. /* synchronize with interrupts */
  1974. barrier();
  1975. if (local_read(&cpu_buffer->committing) == 1)
  1976. rb_set_commit_to_write(cpu_buffer);
  1977. local_dec(&cpu_buffer->committing);
  1978. /* synchronize with interrupts */
  1979. barrier();
  1980. /*
  1981. * Need to account for interrupts coming in between the
  1982. * updating of the commit page and the clearing of the
  1983. * committing counter.
  1984. */
  1985. if (unlikely(local_read(&cpu_buffer->commits) != commits) &&
  1986. !local_read(&cpu_buffer->committing)) {
  1987. local_inc(&cpu_buffer->committing);
  1988. goto again;
  1989. }
  1990. }
  1991. static struct ring_buffer_event *
  1992. rb_reserve_next_event(struct ring_buffer *buffer,
  1993. struct ring_buffer_per_cpu *cpu_buffer,
  1994. unsigned long length)
  1995. {
  1996. struct ring_buffer_event *event;
  1997. u64 ts, delta;
  1998. int nr_loops = 0;
  1999. int add_timestamp;
  2000. u64 diff;
  2001. rb_start_commit(cpu_buffer);
  2002. #ifdef CONFIG_RING_BUFFER_ALLOW_SWAP
  2003. /*
  2004. * Due to the ability to swap a cpu buffer from a buffer
  2005. * it is possible it was swapped before we committed.
  2006. * (committing stops a swap). We check for it here and
  2007. * if it happened, we have to fail the write.
  2008. */
  2009. barrier();
  2010. if (unlikely(ACCESS_ONCE(cpu_buffer->buffer) != buffer)) {
  2011. local_dec(&cpu_buffer->committing);
  2012. local_dec(&cpu_buffer->commits);
  2013. return NULL;
  2014. }
  2015. #endif
  2016. length = rb_calculate_event_length(length);
  2017. again:
  2018. add_timestamp = 0;
  2019. delta = 0;
  2020. /*
  2021. * We allow for interrupts to reenter here and do a trace.
  2022. * If one does, it will cause this original code to loop
  2023. * back here. Even with heavy interrupts happening, this
  2024. * should only happen a few times in a row. If this happens
  2025. * 1000 times in a row, there must be either an interrupt
  2026. * storm or we have something buggy.
  2027. * Bail!
  2028. */
  2029. if (RB_WARN_ON(cpu_buffer, ++nr_loops > 1000))
  2030. goto out_fail;
  2031. ts = rb_time_stamp(cpu_buffer->buffer);
  2032. diff = ts - cpu_buffer->write_stamp;
  2033. /* make sure this diff is calculated here */
  2034. barrier();
  2035. /* Did the write stamp get updated already? */
  2036. if (likely(ts >= cpu_buffer->write_stamp)) {
  2037. delta = diff;
  2038. if (unlikely(test_time_stamp(delta))) {
  2039. int local_clock_stable = 1;
  2040. #ifdef CONFIG_HAVE_UNSTABLE_SCHED_CLOCK
  2041. local_clock_stable = sched_clock_stable;
  2042. #endif
  2043. WARN_ONCE(delta > (1ULL << 59),
  2044. KERN_WARNING "Delta way too big! %llu ts=%llu write stamp = %llu\n%s",
  2045. (unsigned long long)delta,
  2046. (unsigned long long)ts,
  2047. (unsigned long long)cpu_buffer->write_stamp,
  2048. local_clock_stable ? "" :
  2049. "If you just came from a suspend/resume,\n"
  2050. "please switch to the trace global clock:\n"
  2051. " echo global > /sys/kernel/debug/tracing/trace_clock\n");
  2052. add_timestamp = 1;
  2053. }
  2054. }
  2055. event = __rb_reserve_next(cpu_buffer, length, ts,
  2056. delta, add_timestamp);
  2057. if (unlikely(PTR_ERR(event) == -EAGAIN))
  2058. goto again;
  2059. if (!event)
  2060. goto out_fail;
  2061. return event;
  2062. out_fail:
  2063. rb_end_commit(cpu_buffer);
  2064. return NULL;
  2065. }
  2066. #ifdef CONFIG_TRACING
  2067. #define TRACE_RECURSIVE_DEPTH 16
  2068. /* Keep this code out of the fast path cache */
  2069. static noinline void trace_recursive_fail(void)
  2070. {
  2071. /* Disable all tracing before we do anything else */
  2072. tracing_off_permanent();
  2073. printk_once(KERN_WARNING "Tracing recursion: depth[%ld]:"
  2074. "HC[%lu]:SC[%lu]:NMI[%lu]\n",
  2075. trace_recursion_buffer(),
  2076. hardirq_count() >> HARDIRQ_SHIFT,
  2077. softirq_count() >> SOFTIRQ_SHIFT,
  2078. in_nmi());
  2079. WARN_ON_ONCE(1);
  2080. }
  2081. static inline int trace_recursive_lock(void)
  2082. {
  2083. trace_recursion_inc();
  2084. if (likely(trace_recursion_buffer() < TRACE_RECURSIVE_DEPTH))
  2085. return 0;
  2086. trace_recursive_fail();
  2087. return -1;
  2088. }
  2089. static inline void trace_recursive_unlock(void)
  2090. {
  2091. WARN_ON_ONCE(!trace_recursion_buffer());
  2092. trace_recursion_dec();
  2093. }
  2094. #else
  2095. #define trace_recursive_lock() (0)
  2096. #define trace_recursive_unlock() do { } while (0)
  2097. #endif
  2098. /**
  2099. * ring_buffer_lock_reserve - reserve a part of the buffer
  2100. * @buffer: the ring buffer to reserve from
  2101. * @length: the length of the data to reserve (excluding event header)
  2102. *
  2103. * Returns a reseverd event on the ring buffer to copy directly to.
  2104. * The user of this interface will need to get the body to write into
  2105. * and can use the ring_buffer_event_data() interface.
  2106. *
  2107. * The length is the length of the data needed, not the event length
  2108. * which also includes the event header.
  2109. *
  2110. * Must be paired with ring_buffer_unlock_commit, unless NULL is returned.
  2111. * If NULL is returned, then nothing has been allocated or locked.
  2112. */
  2113. struct ring_buffer_event *
  2114. ring_buffer_lock_reserve(struct ring_buffer *buffer, unsigned long length)
  2115. {
  2116. struct ring_buffer_per_cpu *cpu_buffer;
  2117. struct ring_buffer_event *event;
  2118. int cpu;
  2119. if (ring_buffer_flags != RB_BUFFERS_ON)
  2120. return NULL;
  2121. /* If we are tracing schedule, we don't want to recurse */
  2122. preempt_disable_notrace();
  2123. if (atomic_read(&buffer->record_disabled))
  2124. goto out_nocheck;
  2125. if (trace_recursive_lock())
  2126. goto out_nocheck;
  2127. cpu = raw_smp_processor_id();
  2128. if (!cpumask_test_cpu(cpu, buffer->cpumask))
  2129. goto out;
  2130. cpu_buffer = buffer->buffers[cpu];
  2131. if (atomic_read(&cpu_buffer->record_disabled))
  2132. goto out;
  2133. if (length > BUF_MAX_DATA_SIZE)
  2134. goto out;
  2135. event = rb_reserve_next_event(buffer, cpu_buffer, length);
  2136. if (!event)
  2137. goto out;
  2138. return event;
  2139. out:
  2140. trace_recursive_unlock();
  2141. out_nocheck:
  2142. preempt_enable_notrace();
  2143. return NULL;
  2144. }
  2145. EXPORT_SYMBOL_GPL(ring_buffer_lock_reserve);
  2146. static void
  2147. rb_update_write_stamp(struct ring_buffer_per_cpu *cpu_buffer,
  2148. struct ring_buffer_event *event)
  2149. {
  2150. u64 delta;
  2151. /*
  2152. * The event first in the commit queue updates the
  2153. * time stamp.
  2154. */
  2155. if (rb_event_is_commit(cpu_buffer, event)) {
  2156. /*
  2157. * A commit event that is first on a page
  2158. * updates the write timestamp with the page stamp
  2159. */
  2160. if (!rb_event_index(event))
  2161. cpu_buffer->write_stamp =
  2162. cpu_buffer->commit_page->page->time_stamp;
  2163. else if (event->type_len == RINGBUF_TYPE_TIME_EXTEND) {
  2164. delta = event->array[0];
  2165. delta <<= TS_SHIFT;
  2166. delta += event->time_delta;
  2167. cpu_buffer->write_stamp += delta;
  2168. } else
  2169. cpu_buffer->write_stamp += event->time_delta;
  2170. }
  2171. }
  2172. static void rb_commit(struct ring_buffer_per_cpu *cpu_buffer,
  2173. struct ring_buffer_event *event)
  2174. {
  2175. local_inc(&cpu_buffer->entries);
  2176. rb_update_write_stamp(cpu_buffer, event);
  2177. rb_end_commit(cpu_buffer);
  2178. }
  2179. /**
  2180. * ring_buffer_unlock_commit - commit a reserved
  2181. * @buffer: The buffer to commit to
  2182. * @event: The event pointer to commit.
  2183. *
  2184. * This commits the data to the ring buffer, and releases any locks held.
  2185. *
  2186. * Must be paired with ring_buffer_lock_reserve.
  2187. */
  2188. int ring_buffer_unlock_commit(struct ring_buffer *buffer,
  2189. struct ring_buffer_event *event)
  2190. {
  2191. struct ring_buffer_per_cpu *cpu_buffer;
  2192. int cpu = raw_smp_processor_id();
  2193. cpu_buffer = buffer->buffers[cpu];
  2194. rb_commit(cpu_buffer, event);
  2195. trace_recursive_unlock();
  2196. preempt_enable_notrace();
  2197. return 0;
  2198. }
  2199. EXPORT_SYMBOL_GPL(ring_buffer_unlock_commit);
  2200. static inline void rb_event_discard(struct ring_buffer_event *event)
  2201. {
  2202. if (event->type_len == RINGBUF_TYPE_TIME_EXTEND)
  2203. event = skip_time_extend(event);
  2204. /* array[0] holds the actual length for the discarded event */
  2205. event->array[0] = rb_event_data_length(event) - RB_EVNT_HDR_SIZE;
  2206. event->type_len = RINGBUF_TYPE_PADDING;
  2207. /* time delta must be non zero */
  2208. if (!event->time_delta)
  2209. event->time_delta = 1;
  2210. }
  2211. /*
  2212. * Decrement the entries to the page that an event is on.
  2213. * The event does not even need to exist, only the pointer
  2214. * to the page it is on. This may only be called before the commit
  2215. * takes place.
  2216. */
  2217. static inline void
  2218. rb_decrement_entry(struct ring_buffer_per_cpu *cpu_buffer,
  2219. struct ring_buffer_event *event)
  2220. {
  2221. unsigned long addr = (unsigned long)event;
  2222. struct buffer_page *bpage = cpu_buffer->commit_page;
  2223. struct buffer_page *start;
  2224. addr &= PAGE_MASK;
  2225. /* Do the likely case first */
  2226. if (likely(bpage->page == (void *)addr)) {
  2227. local_dec(&bpage->entries);
  2228. return;
  2229. }
  2230. /*
  2231. * Because the commit page may be on the reader page we
  2232. * start with the next page and check the end loop there.
  2233. */
  2234. rb_inc_page(cpu_buffer, &bpage);
  2235. start = bpage;
  2236. do {
  2237. if (bpage->page == (void *)addr) {
  2238. local_dec(&bpage->entries);
  2239. return;
  2240. }
  2241. rb_inc_page(cpu_buffer, &bpage);
  2242. } while (bpage != start);
  2243. /* commit not part of this buffer?? */
  2244. RB_WARN_ON(cpu_buffer, 1);
  2245. }
  2246. /**
  2247. * ring_buffer_commit_discard - discard an event that has not been committed
  2248. * @buffer: the ring buffer
  2249. * @event: non committed event to discard
  2250. *
  2251. * Sometimes an event that is in the ring buffer needs to be ignored.
  2252. * This function lets the user discard an event in the ring buffer
  2253. * and then that event will not be read later.
  2254. *
  2255. * This function only works if it is called before the the item has been
  2256. * committed. It will try to free the event from the ring buffer
  2257. * if another event has not been added behind it.
  2258. *
  2259. * If another event has been added behind it, it will set the event
  2260. * up as discarded, and perform the commit.
  2261. *
  2262. * If this function is called, do not call ring_buffer_unlock_commit on
  2263. * the event.
  2264. */
  2265. void ring_buffer_discard_commit(struct ring_buffer *buffer,
  2266. struct ring_buffer_event *event)
  2267. {
  2268. struct ring_buffer_per_cpu *cpu_buffer;
  2269. int cpu;
  2270. /* The event is discarded regardless */
  2271. rb_event_discard(event);
  2272. cpu = smp_processor_id();
  2273. cpu_buffer = buffer->buffers[cpu];
  2274. /*
  2275. * This must only be called if the event has not been
  2276. * committed yet. Thus we can assume that preemption
  2277. * is still disabled.
  2278. */
  2279. RB_WARN_ON(buffer, !local_read(&cpu_buffer->committing));
  2280. rb_decrement_entry(cpu_buffer, event);
  2281. if (rb_try_to_discard(cpu_buffer, event))
  2282. goto out;
  2283. /*
  2284. * The commit is still visible by the reader, so we
  2285. * must still update the timestamp.
  2286. */
  2287. rb_update_write_stamp(cpu_buffer, event);
  2288. out:
  2289. rb_end_commit(cpu_buffer);
  2290. trace_recursive_unlock();
  2291. preempt_enable_notrace();
  2292. }
  2293. EXPORT_SYMBOL_GPL(ring_buffer_discard_commit);
  2294. /**
  2295. * ring_buffer_write - write data to the buffer without reserving
  2296. * @buffer: The ring buffer to write to.
  2297. * @length: The length of the data being written (excluding the event header)
  2298. * @data: The data to write to the buffer.
  2299. *
  2300. * This is like ring_buffer_lock_reserve and ring_buffer_unlock_commit as
  2301. * one function. If you already have the data to write to the buffer, it
  2302. * may be easier to simply call this function.
  2303. *
  2304. * Note, like ring_buffer_lock_reserve, the length is the length of the data
  2305. * and not the length of the event which would hold the header.
  2306. */
  2307. int ring_buffer_write(struct ring_buffer *buffer,
  2308. unsigned long length,
  2309. void *data)
  2310. {
  2311. struct ring_buffer_per_cpu *cpu_buffer;
  2312. struct ring_buffer_event *event;
  2313. void *body;
  2314. int ret = -EBUSY;
  2315. int cpu;
  2316. if (ring_buffer_flags != RB_BUFFERS_ON)
  2317. return -EBUSY;
  2318. preempt_disable_notrace();
  2319. if (atomic_read(&buffer->record_disabled))
  2320. goto out;
  2321. cpu = raw_smp_processor_id();
  2322. if (!cpumask_test_cpu(cpu, buffer->cpumask))
  2323. goto out;
  2324. cpu_buffer = buffer->buffers[cpu];
  2325. if (atomic_read(&cpu_buffer->record_disabled))
  2326. goto out;
  2327. if (length > BUF_MAX_DATA_SIZE)
  2328. goto out;
  2329. event = rb_reserve_next_event(buffer, cpu_buffer, length);
  2330. if (!event)
  2331. goto out;
  2332. body = rb_event_data(event);
  2333. memcpy(body, data, length);
  2334. rb_commit(cpu_buffer, event);
  2335. ret = 0;
  2336. out:
  2337. preempt_enable_notrace();
  2338. return ret;
  2339. }
  2340. EXPORT_SYMBOL_GPL(ring_buffer_write);
  2341. static int rb_per_cpu_empty(struct ring_buffer_per_cpu *cpu_buffer)
  2342. {
  2343. struct buffer_page *reader = cpu_buffer->reader_page;
  2344. struct buffer_page *head = rb_set_head_page(cpu_buffer);
  2345. struct buffer_page *commit = cpu_buffer->commit_page;
  2346. /* In case of error, head will be NULL */
  2347. if (unlikely(!head))
  2348. return 1;
  2349. return reader->read == rb_page_commit(reader) &&
  2350. (commit == reader ||
  2351. (commit == head &&
  2352. head->read == rb_page_commit(commit)));
  2353. }
  2354. /**
  2355. * ring_buffer_record_disable - stop all writes into the buffer
  2356. * @buffer: The ring buffer to stop writes to.
  2357. *
  2358. * This prevents all writes to the buffer. Any attempt to write
  2359. * to the buffer after this will fail and return NULL.
  2360. *
  2361. * The caller should call synchronize_sched() after this.
  2362. */
  2363. void ring_buffer_record_disable(struct ring_buffer *buffer)
  2364. {
  2365. atomic_inc(&buffer->record_disabled);
  2366. }
  2367. EXPORT_SYMBOL_GPL(ring_buffer_record_disable);
  2368. /**
  2369. * ring_buffer_record_enable - enable writes to the buffer
  2370. * @buffer: The ring buffer to enable writes
  2371. *
  2372. * Note, multiple disables will need the same number of enables
  2373. * to truly enable the writing (much like preempt_disable).
  2374. */
  2375. void ring_buffer_record_enable(struct ring_buffer *buffer)
  2376. {
  2377. atomic_dec(&buffer->record_disabled);
  2378. }
  2379. EXPORT_SYMBOL_GPL(ring_buffer_record_enable);
  2380. /**
  2381. * ring_buffer_record_off - stop all writes into the buffer
  2382. * @buffer: The ring buffer to stop writes to.
  2383. *
  2384. * This prevents all writes to the buffer. Any attempt to write
  2385. * to the buffer after this will fail and return NULL.
  2386. *
  2387. * This is different than ring_buffer_record_disable() as
  2388. * it works like an on/off switch, where as the disable() verison
  2389. * must be paired with a enable().
  2390. */
  2391. void ring_buffer_record_off(struct ring_buffer *buffer)
  2392. {
  2393. unsigned int rd;
  2394. unsigned int new_rd;
  2395. do {
  2396. rd = atomic_read(&buffer->record_disabled);
  2397. new_rd = rd | RB_BUFFER_OFF;
  2398. } while (atomic_cmpxchg(&buffer->record_disabled, rd, new_rd) != rd);
  2399. }
  2400. EXPORT_SYMBOL_GPL(ring_buffer_record_off);
  2401. /**
  2402. * ring_buffer_record_on - restart writes into the buffer
  2403. * @buffer: The ring buffer to start writes to.
  2404. *
  2405. * This enables all writes to the buffer that was disabled by
  2406. * ring_buffer_record_off().
  2407. *
  2408. * This is different than ring_buffer_record_enable() as
  2409. * it works like an on/off switch, where as the enable() verison
  2410. * must be paired with a disable().
  2411. */
  2412. void ring_buffer_record_on(struct ring_buffer *buffer)
  2413. {
  2414. unsigned int rd;
  2415. unsigned int new_rd;
  2416. do {
  2417. rd = atomic_read(&buffer->record_disabled);
  2418. new_rd = rd & ~RB_BUFFER_OFF;
  2419. } while (atomic_cmpxchg(&buffer->record_disabled, rd, new_rd) != rd);
  2420. }
  2421. EXPORT_SYMBOL_GPL(ring_buffer_record_on);
  2422. /**
  2423. * ring_buffer_record_is_on - return true if the ring buffer can write
  2424. * @buffer: The ring buffer to see if write is enabled
  2425. *
  2426. * Returns true if the ring buffer is in a state that it accepts writes.
  2427. */
  2428. int ring_buffer_record_is_on(struct ring_buffer *buffer)
  2429. {
  2430. return !atomic_read(&buffer->record_disabled);
  2431. }
  2432. /**
  2433. * ring_buffer_record_disable_cpu - stop all writes into the cpu_buffer
  2434. * @buffer: The ring buffer to stop writes to.
  2435. * @cpu: The CPU buffer to stop
  2436. *
  2437. * This prevents all writes to the buffer. Any attempt to write
  2438. * to the buffer after this will fail and return NULL.
  2439. *
  2440. * The caller should call synchronize_sched() after this.
  2441. */
  2442. void ring_buffer_record_disable_cpu(struct ring_buffer *buffer, int cpu)
  2443. {
  2444. struct ring_buffer_per_cpu *cpu_buffer;
  2445. if (!cpumask_test_cpu(cpu, buffer->cpumask))
  2446. return;
  2447. cpu_buffer = buffer->buffers[cpu];
  2448. atomic_inc(&cpu_buffer->record_disabled);
  2449. }
  2450. EXPORT_SYMBOL_GPL(ring_buffer_record_disable_cpu);
  2451. /**
  2452. * ring_buffer_record_enable_cpu - enable writes to the buffer
  2453. * @buffer: The ring buffer to enable writes
  2454. * @cpu: The CPU to enable.
  2455. *
  2456. * Note, multiple disables will need the same number of enables
  2457. * to truly enable the writing (much like preempt_disable).
  2458. */
  2459. void ring_buffer_record_enable_cpu(struct ring_buffer *buffer, int cpu)
  2460. {
  2461. struct ring_buffer_per_cpu *cpu_buffer;
  2462. if (!cpumask_test_cpu(cpu, buffer->cpumask))
  2463. return;
  2464. cpu_buffer = buffer->buffers[cpu];
  2465. atomic_dec(&cpu_buffer->record_disabled);
  2466. }
  2467. EXPORT_SYMBOL_GPL(ring_buffer_record_enable_cpu);
  2468. /*
  2469. * The total entries in the ring buffer is the running counter
  2470. * of entries entered into the ring buffer, minus the sum of
  2471. * the entries read from the ring buffer and the number of
  2472. * entries that were overwritten.
  2473. */
  2474. static inline unsigned long
  2475. rb_num_of_entries(struct ring_buffer_per_cpu *cpu_buffer)
  2476. {
  2477. return local_read(&cpu_buffer->entries) -
  2478. (local_read(&cpu_buffer->overrun) + cpu_buffer->read);
  2479. }
  2480. /**
  2481. * ring_buffer_oldest_event_ts - get the oldest event timestamp from the buffer
  2482. * @buffer: The ring buffer
  2483. * @cpu: The per CPU buffer to read from.
  2484. */
  2485. unsigned long ring_buffer_oldest_event_ts(struct ring_buffer *buffer, int cpu)
  2486. {
  2487. unsigned long flags;
  2488. struct ring_buffer_per_cpu *cpu_buffer;
  2489. struct buffer_page *bpage;
  2490. unsigned long ret;
  2491. if (!cpumask_test_cpu(cpu, buffer->cpumask))
  2492. return 0;
  2493. cpu_buffer = buffer->buffers[cpu];
  2494. raw_spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
  2495. /*
  2496. * if the tail is on reader_page, oldest time stamp is on the reader
  2497. * page
  2498. */
  2499. if (cpu_buffer->tail_page == cpu_buffer->reader_page)
  2500. bpage = cpu_buffer->reader_page;
  2501. else
  2502. bpage = rb_set_head_page(cpu_buffer);
  2503. ret = bpage->page->time_stamp;
  2504. raw_spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
  2505. return ret;
  2506. }
  2507. EXPORT_SYMBOL_GPL(ring_buffer_oldest_event_ts);
  2508. /**
  2509. * ring_buffer_bytes_cpu - get the number of bytes consumed in a cpu buffer
  2510. * @buffer: The ring buffer
  2511. * @cpu: The per CPU buffer to read from.
  2512. */
  2513. unsigned long ring_buffer_bytes_cpu(struct ring_buffer *buffer, int cpu)
  2514. {
  2515. struct ring_buffer_per_cpu *cpu_buffer;
  2516. unsigned long ret;
  2517. if (!cpumask_test_cpu(cpu, buffer->cpumask))
  2518. return 0;
  2519. cpu_buffer = buffer->buffers[cpu];
  2520. ret = local_read(&cpu_buffer->entries_bytes) - cpu_buffer->read_bytes;
  2521. return ret;
  2522. }
  2523. EXPORT_SYMBOL_GPL(ring_buffer_bytes_cpu);
  2524. /**
  2525. * ring_buffer_entries_cpu - get the number of entries in a cpu buffer
  2526. * @buffer: The ring buffer
  2527. * @cpu: The per CPU buffer to get the entries from.
  2528. */
  2529. unsigned long ring_buffer_entries_cpu(struct ring_buffer *buffer, int cpu)
  2530. {
  2531. struct ring_buffer_per_cpu *cpu_buffer;
  2532. if (!cpumask_test_cpu(cpu, buffer->cpumask))
  2533. return 0;
  2534. cpu_buffer = buffer->buffers[cpu];
  2535. return rb_num_of_entries(cpu_buffer);
  2536. }
  2537. EXPORT_SYMBOL_GPL(ring_buffer_entries_cpu);
  2538. /**
  2539. * ring_buffer_overrun_cpu - get the number of overruns in a cpu_buffer
  2540. * @buffer: The ring buffer
  2541. * @cpu: The per CPU buffer to get the number of overruns from
  2542. */
  2543. unsigned long ring_buffer_overrun_cpu(struct ring_buffer *buffer, int cpu)
  2544. {
  2545. struct ring_buffer_per_cpu *cpu_buffer;
  2546. unsigned long ret;
  2547. if (!cpumask_test_cpu(cpu, buffer->cpumask))
  2548. return 0;
  2549. cpu_buffer = buffer->buffers[cpu];
  2550. ret = local_read(&cpu_buffer->overrun);
  2551. return ret;
  2552. }
  2553. EXPORT_SYMBOL_GPL(ring_buffer_overrun_cpu);
  2554. /**
  2555. * ring_buffer_commit_overrun_cpu - get the number of overruns caused by commits
  2556. * @buffer: The ring buffer
  2557. * @cpu: The per CPU buffer to get the number of overruns from
  2558. */
  2559. unsigned long
  2560. ring_buffer_commit_overrun_cpu(struct ring_buffer *buffer, int cpu)
  2561. {
  2562. struct ring_buffer_per_cpu *cpu_buffer;
  2563. unsigned long ret;
  2564. if (!cpumask_test_cpu(cpu, buffer->cpumask))
  2565. return 0;
  2566. cpu_buffer = buffer->buffers[cpu];
  2567. ret = local_read(&cpu_buffer->commit_overrun);
  2568. return ret;
  2569. }
  2570. EXPORT_SYMBOL_GPL(ring_buffer_commit_overrun_cpu);
  2571. /**
  2572. * ring_buffer_entries - get the number of entries in a buffer
  2573. * @buffer: The ring buffer
  2574. *
  2575. * Returns the total number of entries in the ring buffer
  2576. * (all CPU entries)
  2577. */
  2578. unsigned long ring_buffer_entries(struct ring_buffer *buffer)
  2579. {
  2580. struct ring_buffer_per_cpu *cpu_buffer;
  2581. unsigned long entries = 0;
  2582. int cpu;
  2583. /* if you care about this being correct, lock the buffer */
  2584. for_each_buffer_cpu(buffer, cpu) {
  2585. cpu_buffer = buffer->buffers[cpu];
  2586. entries += rb_num_of_entries(cpu_buffer);
  2587. }
  2588. return entries;
  2589. }
  2590. EXPORT_SYMBOL_GPL(ring_buffer_entries);
  2591. /**
  2592. * ring_buffer_overruns - get the number of overruns in buffer
  2593. * @buffer: The ring buffer
  2594. *
  2595. * Returns the total number of overruns in the ring buffer
  2596. * (all CPU entries)
  2597. */
  2598. unsigned long ring_buffer_overruns(struct ring_buffer *buffer)
  2599. {
  2600. struct ring_buffer_per_cpu *cpu_buffer;
  2601. unsigned long overruns = 0;
  2602. int cpu;
  2603. /* if you care about this being correct, lock the buffer */
  2604. for_each_buffer_cpu(buffer, cpu) {
  2605. cpu_buffer = buffer->buffers[cpu];
  2606. overruns += local_read(&cpu_buffer->overrun);
  2607. }
  2608. return overruns;
  2609. }
  2610. EXPORT_SYMBOL_GPL(ring_buffer_overruns);
  2611. static void rb_iter_reset(struct ring_buffer_iter *iter)
  2612. {
  2613. struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;
  2614. /* Iterator usage is expected to have record disabled */
  2615. if (list_empty(&cpu_buffer->reader_page->list)) {
  2616. iter->head_page = rb_set_head_page(cpu_buffer);
  2617. if (unlikely(!iter->head_page))
  2618. return;
  2619. iter->head = iter->head_page->read;
  2620. } else {
  2621. iter->head_page = cpu_buffer->reader_page;
  2622. iter->head = cpu_buffer->reader_page->read;
  2623. }
  2624. if (iter->head)
  2625. iter->read_stamp = cpu_buffer->read_stamp;
  2626. else
  2627. iter->read_stamp = iter->head_page->page->time_stamp;
  2628. iter->cache_reader_page = cpu_buffer->reader_page;
  2629. iter->cache_read = cpu_buffer->read;
  2630. }
  2631. /**
  2632. * ring_buffer_iter_reset - reset an iterator
  2633. * @iter: The iterator to reset
  2634. *
  2635. * Resets the iterator, so that it will start from the beginning
  2636. * again.
  2637. */
  2638. void ring_buffer_iter_reset(struct ring_buffer_iter *iter)
  2639. {
  2640. struct ring_buffer_per_cpu *cpu_buffer;
  2641. unsigned long flags;
  2642. if (!iter)
  2643. return;
  2644. cpu_buffer = iter->cpu_buffer;
  2645. raw_spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
  2646. rb_iter_reset(iter);
  2647. raw_spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
  2648. }
  2649. EXPORT_SYMBOL_GPL(ring_buffer_iter_reset);
  2650. /**
  2651. * ring_buffer_iter_empty - check if an iterator has no more to read
  2652. * @iter: The iterator to check
  2653. */
  2654. int ring_buffer_iter_empty(struct ring_buffer_iter *iter)
  2655. {
  2656. struct ring_buffer_per_cpu *cpu_buffer;
  2657. cpu_buffer = iter->cpu_buffer;
  2658. return iter->head_page == cpu_buffer->commit_page &&
  2659. iter->head == rb_commit_index(cpu_buffer);
  2660. }
  2661. EXPORT_SYMBOL_GPL(ring_buffer_iter_empty);
  2662. static void
  2663. rb_update_read_stamp(struct ring_buffer_per_cpu *cpu_buffer,
  2664. struct ring_buffer_event *event)
  2665. {
  2666. u64 delta;
  2667. switch (event->type_len) {
  2668. case RINGBUF_TYPE_PADDING:
  2669. return;
  2670. case RINGBUF_TYPE_TIME_EXTEND:
  2671. delta = event->array[0];
  2672. delta <<= TS_SHIFT;
  2673. delta += event->time_delta;
  2674. cpu_buffer->read_stamp += delta;
  2675. return;
  2676. case RINGBUF_TYPE_TIME_STAMP:
  2677. /* FIXME: not implemented */
  2678. return;
  2679. case RINGBUF_TYPE_DATA:
  2680. cpu_buffer->read_stamp += event->time_delta;
  2681. return;
  2682. default:
  2683. BUG();
  2684. }
  2685. return;
  2686. }
  2687. static void
  2688. rb_update_iter_read_stamp(struct ring_buffer_iter *iter,
  2689. struct ring_buffer_event *event)
  2690. {
  2691. u64 delta;
  2692. switch (event->type_len) {
  2693. case RINGBUF_TYPE_PADDING:
  2694. return;
  2695. case RINGBUF_TYPE_TIME_EXTEND:
  2696. delta = event->array[0];
  2697. delta <<= TS_SHIFT;
  2698. delta += event->time_delta;
  2699. iter->read_stamp += delta;
  2700. return;
  2701. case RINGBUF_TYPE_TIME_STAMP:
  2702. /* FIXME: not implemented */
  2703. return;
  2704. case RINGBUF_TYPE_DATA:
  2705. iter->read_stamp += event->time_delta;
  2706. return;
  2707. default:
  2708. BUG();
  2709. }
  2710. return;
  2711. }
  2712. static struct buffer_page *
  2713. rb_get_reader_page(struct ring_buffer_per_cpu *cpu_buffer)
  2714. {
  2715. struct buffer_page *reader = NULL;
  2716. unsigned long overwrite;
  2717. unsigned long flags;
  2718. int nr_loops = 0;
  2719. int ret;
  2720. local_irq_save(flags);
  2721. arch_spin_lock(&cpu_buffer->lock);
  2722. again:
  2723. /*
  2724. * This should normally only loop twice. But because the
  2725. * start of the reader inserts an empty page, it causes
  2726. * a case where we will loop three times. There should be no
  2727. * reason to loop four times (that I know of).
  2728. */
  2729. if (RB_WARN_ON(cpu_buffer, ++nr_loops > 3)) {
  2730. reader = NULL;
  2731. goto out;
  2732. }
  2733. reader = cpu_buffer->reader_page;
  2734. /* If there's more to read, return this page */
  2735. if (cpu_buffer->reader_page->read < rb_page_size(reader))
  2736. goto out;
  2737. /* Never should we have an index greater than the size */
  2738. if (RB_WARN_ON(cpu_buffer,
  2739. cpu_buffer->reader_page->read > rb_page_size(reader)))
  2740. goto out;
  2741. /* check if we caught up to the tail */
  2742. reader = NULL;
  2743. if (cpu_buffer->commit_page == cpu_buffer->reader_page)
  2744. goto out;
  2745. /* Don't bother swapping if the ring buffer is empty */
  2746. if (rb_num_of_entries(cpu_buffer) == 0)
  2747. goto out;
  2748. /*
  2749. * Reset the reader page to size zero.
  2750. */
  2751. local_set(&cpu_buffer->reader_page->write, 0);
  2752. local_set(&cpu_buffer->reader_page->entries, 0);
  2753. local_set(&cpu_buffer->reader_page->page->commit, 0);
  2754. cpu_buffer->reader_page->real_end = 0;
  2755. spin:
  2756. /*
  2757. * Splice the empty reader page into the list around the head.
  2758. */
  2759. reader = rb_set_head_page(cpu_buffer);
  2760. cpu_buffer->reader_page->list.next = rb_list_head(reader->list.next);
  2761. cpu_buffer->reader_page->list.prev = reader->list.prev;
  2762. /*
  2763. * cpu_buffer->pages just needs to point to the buffer, it
  2764. * has no specific buffer page to point to. Lets move it out
  2765. * of our way so we don't accidentally swap it.
  2766. */
  2767. cpu_buffer->pages = reader->list.prev;
  2768. /* The reader page will be pointing to the new head */
  2769. rb_set_list_to_head(cpu_buffer, &cpu_buffer->reader_page->list);
  2770. /*
  2771. * We want to make sure we read the overruns after we set up our
  2772. * pointers to the next object. The writer side does a
  2773. * cmpxchg to cross pages which acts as the mb on the writer
  2774. * side. Note, the reader will constantly fail the swap
  2775. * while the writer is updating the pointers, so this
  2776. * guarantees that the overwrite recorded here is the one we
  2777. * want to compare with the last_overrun.
  2778. */
  2779. smp_mb();
  2780. overwrite = local_read(&(cpu_buffer->overrun));
  2781. /*
  2782. * Here's the tricky part.
  2783. *
  2784. * We need to move the pointer past the header page.
  2785. * But we can only do that if a writer is not currently
  2786. * moving it. The page before the header page has the
  2787. * flag bit '1' set if it is pointing to the page we want.
  2788. * but if the writer is in the process of moving it
  2789. * than it will be '2' or already moved '0'.
  2790. */
  2791. ret = rb_head_page_replace(reader, cpu_buffer->reader_page);
  2792. /*
  2793. * If we did not convert it, then we must try again.
  2794. */
  2795. if (!ret)
  2796. goto spin;
  2797. /*
  2798. * Yeah! We succeeded in replacing the page.
  2799. *
  2800. * Now make the new head point back to the reader page.
  2801. */
  2802. rb_list_head(reader->list.next)->prev = &cpu_buffer->reader_page->list;
  2803. rb_inc_page(cpu_buffer, &cpu_buffer->head_page);
  2804. /* Finally update the reader page to the new head */
  2805. cpu_buffer->reader_page = reader;
  2806. rb_reset_reader_page(cpu_buffer);
  2807. if (overwrite != cpu_buffer->last_overrun) {
  2808. cpu_buffer->lost_events = overwrite - cpu_buffer->last_overrun;
  2809. cpu_buffer->last_overrun = overwrite;
  2810. }
  2811. goto again;
  2812. out:
  2813. arch_spin_unlock(&cpu_buffer->lock);
  2814. local_irq_restore(flags);
  2815. return reader;
  2816. }
  2817. static void rb_advance_reader(struct ring_buffer_per_cpu *cpu_buffer)
  2818. {
  2819. struct ring_buffer_event *event;
  2820. struct buffer_page *reader;
  2821. unsigned length;
  2822. reader = rb_get_reader_page(cpu_buffer);
  2823. /* This function should not be called when buffer is empty */
  2824. if (RB_WARN_ON(cpu_buffer, !reader))
  2825. return;
  2826. event = rb_reader_event(cpu_buffer);
  2827. if (event->type_len <= RINGBUF_TYPE_DATA_TYPE_LEN_MAX)
  2828. cpu_buffer->read++;
  2829. rb_update_read_stamp(cpu_buffer, event);
  2830. length = rb_event_length(event);
  2831. cpu_buffer->reader_page->read += length;
  2832. }
  2833. static void rb_advance_iter(struct ring_buffer_iter *iter)
  2834. {
  2835. struct ring_buffer_per_cpu *cpu_buffer;
  2836. struct ring_buffer_event *event;
  2837. unsigned length;
  2838. cpu_buffer = iter->cpu_buffer;
  2839. /*
  2840. * Check if we are at the end of the buffer.
  2841. */
  2842. if (iter->head >= rb_page_size(iter->head_page)) {
  2843. /* discarded commits can make the page empty */
  2844. if (iter->head_page == cpu_buffer->commit_page)
  2845. return;
  2846. rb_inc_iter(iter);
  2847. return;
  2848. }
  2849. event = rb_iter_head_event(iter);
  2850. length = rb_event_length(event);
  2851. /*
  2852. * This should not be called to advance the header if we are
  2853. * at the tail of the buffer.
  2854. */
  2855. if (RB_WARN_ON(cpu_buffer,
  2856. (iter->head_page == cpu_buffer->commit_page) &&
  2857. (iter->head + length > rb_commit_index(cpu_buffer))))
  2858. return;
  2859. rb_update_iter_read_stamp(iter, event);
  2860. iter->head += length;
  2861. /* check for end of page padding */
  2862. if ((iter->head >= rb_page_size(iter->head_page)) &&
  2863. (iter->head_page != cpu_buffer->commit_page))
  2864. rb_advance_iter(iter);
  2865. }
  2866. static int rb_lost_events(struct ring_buffer_per_cpu *cpu_buffer)
  2867. {
  2868. return cpu_buffer->lost_events;
  2869. }
  2870. static struct ring_buffer_event *
  2871. rb_buffer_peek(struct ring_buffer_per_cpu *cpu_buffer, u64 *ts,
  2872. unsigned long *lost_events)
  2873. {
  2874. struct ring_buffer_event *event;
  2875. struct buffer_page *reader;
  2876. int nr_loops = 0;
  2877. again:
  2878. /*
  2879. * We repeat when a time extend is encountered.
  2880. * Since the time extend is always attached to a data event,
  2881. * we should never loop more than once.
  2882. * (We never hit the following condition more than twice).
  2883. */
  2884. if (RB_WARN_ON(cpu_buffer, ++nr_loops > 2))
  2885. return NULL;
  2886. reader = rb_get_reader_page(cpu_buffer);
  2887. if (!reader)
  2888. return NULL;
  2889. event = rb_reader_event(cpu_buffer);
  2890. switch (event->type_len) {
  2891. case RINGBUF_TYPE_PADDING:
  2892. if (rb_null_event(event))
  2893. RB_WARN_ON(cpu_buffer, 1);
  2894. /*
  2895. * Because the writer could be discarding every
  2896. * event it creates (which would probably be bad)
  2897. * if we were to go back to "again" then we may never
  2898. * catch up, and will trigger the warn on, or lock
  2899. * the box. Return the padding, and we will release
  2900. * the current locks, and try again.
  2901. */
  2902. return event;
  2903. case RINGBUF_TYPE_TIME_EXTEND:
  2904. /* Internal data, OK to advance */
  2905. rb_advance_reader(cpu_buffer);
  2906. goto again;
  2907. case RINGBUF_TYPE_TIME_STAMP:
  2908. /* FIXME: not implemented */
  2909. rb_advance_reader(cpu_buffer);
  2910. goto again;
  2911. case RINGBUF_TYPE_DATA:
  2912. if (ts) {
  2913. *ts = cpu_buffer->read_stamp + event->time_delta;
  2914. ring_buffer_normalize_time_stamp(cpu_buffer->buffer,
  2915. cpu_buffer->cpu, ts);
  2916. }
  2917. if (lost_events)
  2918. *lost_events = rb_lost_events(cpu_buffer);
  2919. return event;
  2920. default:
  2921. BUG();
  2922. }
  2923. return NULL;
  2924. }
  2925. EXPORT_SYMBOL_GPL(ring_buffer_peek);
  2926. static struct ring_buffer_event *
  2927. rb_iter_peek(struct ring_buffer_iter *iter, u64 *ts)
  2928. {
  2929. struct ring_buffer *buffer;
  2930. struct ring_buffer_per_cpu *cpu_buffer;
  2931. struct ring_buffer_event *event;
  2932. int nr_loops = 0;
  2933. cpu_buffer = iter->cpu_buffer;
  2934. buffer = cpu_buffer->buffer;
  2935. /*
  2936. * Check if someone performed a consuming read to
  2937. * the buffer. A consuming read invalidates the iterator
  2938. * and we need to reset the iterator in this case.
  2939. */
  2940. if (unlikely(iter->cache_read != cpu_buffer->read ||
  2941. iter->cache_reader_page != cpu_buffer->reader_page))
  2942. rb_iter_reset(iter);
  2943. again:
  2944. if (ring_buffer_iter_empty(iter))
  2945. return NULL;
  2946. /*
  2947. * We repeat when a time extend is encountered.
  2948. * Since the time extend is always attached to a data event,
  2949. * we should never loop more than once.
  2950. * (We never hit the following condition more than twice).
  2951. */
  2952. if (RB_WARN_ON(cpu_buffer, ++nr_loops > 2))
  2953. return NULL;
  2954. if (rb_per_cpu_empty(cpu_buffer))
  2955. return NULL;
  2956. if (iter->head >= local_read(&iter->head_page->page->commit)) {
  2957. rb_inc_iter(iter);
  2958. goto again;
  2959. }
  2960. event = rb_iter_head_event(iter);
  2961. switch (event->type_len) {
  2962. case RINGBUF_TYPE_PADDING:
  2963. if (rb_null_event(event)) {
  2964. rb_inc_iter(iter);
  2965. goto again;
  2966. }
  2967. rb_advance_iter(iter);
  2968. return event;
  2969. case RINGBUF_TYPE_TIME_EXTEND:
  2970. /* Internal data, OK to advance */
  2971. rb_advance_iter(iter);
  2972. goto again;
  2973. case RINGBUF_TYPE_TIME_STAMP:
  2974. /* FIXME: not implemented */
  2975. rb_advance_iter(iter);
  2976. goto again;
  2977. case RINGBUF_TYPE_DATA:
  2978. if (ts) {
  2979. *ts = iter->read_stamp + event->time_delta;
  2980. ring_buffer_normalize_time_stamp(buffer,
  2981. cpu_buffer->cpu, ts);
  2982. }
  2983. return event;
  2984. default:
  2985. BUG();
  2986. }
  2987. return NULL;
  2988. }
  2989. EXPORT_SYMBOL_GPL(ring_buffer_iter_peek);
  2990. static inline int rb_ok_to_lock(void)
  2991. {
  2992. /*
  2993. * If an NMI die dumps out the content of the ring buffer
  2994. * do not grab locks. We also permanently disable the ring
  2995. * buffer too. A one time deal is all you get from reading
  2996. * the ring buffer from an NMI.
  2997. */
  2998. if (likely(!in_nmi()))
  2999. return 1;
  3000. tracing_off_permanent();
  3001. return 0;
  3002. }
  3003. /**
  3004. * ring_buffer_peek - peek at the next event to be read
  3005. * @buffer: The ring buffer to read
  3006. * @cpu: The cpu to peak at
  3007. * @ts: The timestamp counter of this event.
  3008. * @lost_events: a variable to store if events were lost (may be NULL)
  3009. *
  3010. * This will return the event that will be read next, but does
  3011. * not consume the data.
  3012. */
  3013. struct ring_buffer_event *
  3014. ring_buffer_peek(struct ring_buffer *buffer, int cpu, u64 *ts,
  3015. unsigned long *lost_events)
  3016. {
  3017. struct ring_buffer_per_cpu *cpu_buffer = buffer->buffers[cpu];
  3018. struct ring_buffer_event *event;
  3019. unsigned long flags;
  3020. int dolock;
  3021. if (!cpumask_test_cpu(cpu, buffer->cpumask))
  3022. return NULL;
  3023. dolock = rb_ok_to_lock();
  3024. again:
  3025. local_irq_save(flags);
  3026. if (dolock)
  3027. raw_spin_lock(&cpu_buffer->reader_lock);
  3028. event = rb_buffer_peek(cpu_buffer, ts, lost_events);
  3029. if (event && event->type_len == RINGBUF_TYPE_PADDING)
  3030. rb_advance_reader(cpu_buffer);
  3031. if (dolock)
  3032. raw_spin_unlock(&cpu_buffer->reader_lock);
  3033. local_irq_restore(flags);
  3034. if (event && event->type_len == RINGBUF_TYPE_PADDING)
  3035. goto again;
  3036. return event;
  3037. }
  3038. /**
  3039. * ring_buffer_iter_peek - peek at the next event to be read
  3040. * @iter: The ring buffer iterator
  3041. * @ts: The timestamp counter of this event.
  3042. *
  3043. * This will return the event that will be read next, but does
  3044. * not increment the iterator.
  3045. */
  3046. struct ring_buffer_event *
  3047. ring_buffer_iter_peek(struct ring_buffer_iter *iter, u64 *ts)
  3048. {
  3049. struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;
  3050. struct ring_buffer_event *event;
  3051. unsigned long flags;
  3052. again:
  3053. raw_spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
  3054. event = rb_iter_peek(iter, ts);
  3055. raw_spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
  3056. if (event && event->type_len == RINGBUF_TYPE_PADDING)
  3057. goto again;
  3058. return event;
  3059. }
  3060. /**
  3061. * ring_buffer_consume - return an event and consume it
  3062. * @buffer: The ring buffer to get the next event from
  3063. * @cpu: the cpu to read the buffer from
  3064. * @ts: a variable to store the timestamp (may be NULL)
  3065. * @lost_events: a variable to store if events were lost (may be NULL)
  3066. *
  3067. * Returns the next event in the ring buffer, and that event is consumed.
  3068. * Meaning, that sequential reads will keep returning a different event,
  3069. * and eventually empty the ring buffer if the producer is slower.
  3070. */
  3071. struct ring_buffer_event *
  3072. ring_buffer_consume(struct ring_buffer *buffer, int cpu, u64 *ts,
  3073. unsigned long *lost_events)
  3074. {
  3075. struct ring_buffer_per_cpu *cpu_buffer;
  3076. struct ring_buffer_event *event = NULL;
  3077. unsigned long flags;
  3078. int dolock;
  3079. dolock = rb_ok_to_lock();
  3080. again:
  3081. /* might be called in atomic */
  3082. preempt_disable();
  3083. if (!cpumask_test_cpu(cpu, buffer->cpumask))
  3084. goto out;
  3085. cpu_buffer = buffer->buffers[cpu];
  3086. local_irq_save(flags);
  3087. if (dolock)
  3088. raw_spin_lock(&cpu_buffer->reader_lock);
  3089. event = rb_buffer_peek(cpu_buffer, ts, lost_events);
  3090. if (event) {
  3091. cpu_buffer->lost_events = 0;
  3092. rb_advance_reader(cpu_buffer);
  3093. }
  3094. if (dolock)
  3095. raw_spin_unlock(&cpu_buffer->reader_lock);
  3096. local_irq_restore(flags);
  3097. out:
  3098. preempt_enable();
  3099. if (event && event->type_len == RINGBUF_TYPE_PADDING)
  3100. goto again;
  3101. return event;
  3102. }
  3103. EXPORT_SYMBOL_GPL(ring_buffer_consume);
  3104. /**
  3105. * ring_buffer_read_prepare - Prepare for a non consuming read of the buffer
  3106. * @buffer: The ring buffer to read from
  3107. * @cpu: The cpu buffer to iterate over
  3108. *
  3109. * This performs the initial preparations necessary to iterate
  3110. * through the buffer. Memory is allocated, buffer recording
  3111. * is disabled, and the iterator pointer is returned to the caller.
  3112. *
  3113. * Disabling buffer recordng prevents the reading from being
  3114. * corrupted. This is not a consuming read, so a producer is not
  3115. * expected.
  3116. *
  3117. * After a sequence of ring_buffer_read_prepare calls, the user is
  3118. * expected to make at least one call to ring_buffer_prepare_sync.
  3119. * Afterwards, ring_buffer_read_start is invoked to get things going
  3120. * for real.
  3121. *
  3122. * This overall must be paired with ring_buffer_finish.
  3123. */
  3124. struct ring_buffer_iter *
  3125. ring_buffer_read_prepare(struct ring_buffer *buffer, int cpu)
  3126. {
  3127. struct ring_buffer_per_cpu *cpu_buffer;
  3128. struct ring_buffer_iter *iter;
  3129. if (!cpumask_test_cpu(cpu, buffer->cpumask))
  3130. return NULL;
  3131. iter = kmalloc(sizeof(*iter), GFP_KERNEL);
  3132. if (!iter)
  3133. return NULL;
  3134. cpu_buffer = buffer->buffers[cpu];
  3135. iter->cpu_buffer = cpu_buffer;
  3136. atomic_inc(&buffer->resize_disabled);
  3137. atomic_inc(&cpu_buffer->record_disabled);
  3138. return iter;
  3139. }
  3140. EXPORT_SYMBOL_GPL(ring_buffer_read_prepare);
  3141. /**
  3142. * ring_buffer_read_prepare_sync - Synchronize a set of prepare calls
  3143. *
  3144. * All previously invoked ring_buffer_read_prepare calls to prepare
  3145. * iterators will be synchronized. Afterwards, read_buffer_read_start
  3146. * calls on those iterators are allowed.
  3147. */
  3148. void
  3149. ring_buffer_read_prepare_sync(void)
  3150. {
  3151. synchronize_sched();
  3152. }
  3153. EXPORT_SYMBOL_GPL(ring_buffer_read_prepare_sync);
  3154. /**
  3155. * ring_buffer_read_start - start a non consuming read of the buffer
  3156. * @iter: The iterator returned by ring_buffer_read_prepare
  3157. *
  3158. * This finalizes the startup of an iteration through the buffer.
  3159. * The iterator comes from a call to ring_buffer_read_prepare and
  3160. * an intervening ring_buffer_read_prepare_sync must have been
  3161. * performed.
  3162. *
  3163. * Must be paired with ring_buffer_finish.
  3164. */
  3165. void
  3166. ring_buffer_read_start(struct ring_buffer_iter *iter)
  3167. {
  3168. struct ring_buffer_per_cpu *cpu_buffer;
  3169. unsigned long flags;
  3170. if (!iter)
  3171. return;
  3172. cpu_buffer = iter->cpu_buffer;
  3173. raw_spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
  3174. arch_spin_lock(&cpu_buffer->lock);
  3175. rb_iter_reset(iter);
  3176. arch_spin_unlock(&cpu_buffer->lock);
  3177. raw_spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
  3178. }
  3179. EXPORT_SYMBOL_GPL(ring_buffer_read_start);
  3180. /**
  3181. * ring_buffer_finish - finish reading the iterator of the buffer
  3182. * @iter: The iterator retrieved by ring_buffer_start
  3183. *
  3184. * This re-enables the recording to the buffer, and frees the
  3185. * iterator.
  3186. */
  3187. void
  3188. ring_buffer_read_finish(struct ring_buffer_iter *iter)
  3189. {
  3190. struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;
  3191. /*
  3192. * Ring buffer is disabled from recording, here's a good place
  3193. * to check the integrity of the ring buffer.
  3194. */
  3195. rb_check_pages(cpu_buffer);
  3196. atomic_dec(&cpu_buffer->record_disabled);
  3197. atomic_dec(&cpu_buffer->buffer->resize_disabled);
  3198. kfree(iter);
  3199. }
  3200. EXPORT_SYMBOL_GPL(ring_buffer_read_finish);
  3201. /**
  3202. * ring_buffer_read - read the next item in the ring buffer by the iterator
  3203. * @iter: The ring buffer iterator
  3204. * @ts: The time stamp of the event read.
  3205. *
  3206. * This reads the next event in the ring buffer and increments the iterator.
  3207. */
  3208. struct ring_buffer_event *
  3209. ring_buffer_read(struct ring_buffer_iter *iter, u64 *ts)
  3210. {
  3211. struct ring_buffer_event *event;
  3212. struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;
  3213. unsigned long flags;
  3214. raw_spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
  3215. again:
  3216. event = rb_iter_peek(iter, ts);
  3217. if (!event)
  3218. goto out;
  3219. if (event->type_len == RINGBUF_TYPE_PADDING)
  3220. goto again;
  3221. rb_advance_iter(iter);
  3222. out:
  3223. raw_spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
  3224. return event;
  3225. }
  3226. EXPORT_SYMBOL_GPL(ring_buffer_read);
  3227. /**
  3228. * ring_buffer_size - return the size of the ring buffer (in bytes)
  3229. * @buffer: The ring buffer.
  3230. */
  3231. unsigned long ring_buffer_size(struct ring_buffer *buffer, int cpu)
  3232. {
  3233. /*
  3234. * Earlier, this method returned
  3235. * BUF_PAGE_SIZE * buffer->nr_pages
  3236. * Since the nr_pages field is now removed, we have converted this to
  3237. * return the per cpu buffer value.
  3238. */
  3239. if (!cpumask_test_cpu(cpu, buffer->cpumask))
  3240. return 0;
  3241. return BUF_PAGE_SIZE * buffer->buffers[cpu]->nr_pages;
  3242. }
  3243. EXPORT_SYMBOL_GPL(ring_buffer_size);
  3244. static void
  3245. rb_reset_cpu(struct ring_buffer_per_cpu *cpu_buffer)
  3246. {
  3247. rb_head_page_deactivate(cpu_buffer);
  3248. cpu_buffer->head_page
  3249. = list_entry(cpu_buffer->pages, struct buffer_page, list);
  3250. local_set(&cpu_buffer->head_page->write, 0);
  3251. local_set(&cpu_buffer->head_page->entries, 0);
  3252. local_set(&cpu_buffer->head_page->page->commit, 0);
  3253. cpu_buffer->head_page->read = 0;
  3254. cpu_buffer->tail_page = cpu_buffer->head_page;
  3255. cpu_buffer->commit_page = cpu_buffer->head_page;
  3256. INIT_LIST_HEAD(&cpu_buffer->reader_page->list);
  3257. INIT_LIST_HEAD(&cpu_buffer->new_pages);
  3258. local_set(&cpu_buffer->reader_page->write, 0);
  3259. local_set(&cpu_buffer->reader_page->entries, 0);
  3260. local_set(&cpu_buffer->reader_page->page->commit, 0);
  3261. cpu_buffer->reader_page->read = 0;
  3262. local_set(&cpu_buffer->commit_overrun, 0);
  3263. local_set(&cpu_buffer->entries_bytes, 0);
  3264. local_set(&cpu_buffer->overrun, 0);
  3265. local_set(&cpu_buffer->entries, 0);
  3266. local_set(&cpu_buffer->committing, 0);
  3267. local_set(&cpu_buffer->commits, 0);
  3268. cpu_buffer->read = 0;
  3269. cpu_buffer->read_bytes = 0;
  3270. cpu_buffer->write_stamp = 0;
  3271. cpu_buffer->read_stamp = 0;
  3272. cpu_buffer->lost_events = 0;
  3273. cpu_buffer->last_overrun = 0;
  3274. rb_head_page_activate(cpu_buffer);
  3275. }
  3276. /**
  3277. * ring_buffer_reset_cpu - reset a ring buffer per CPU buffer
  3278. * @buffer: The ring buffer to reset a per cpu buffer of
  3279. * @cpu: The CPU buffer to be reset
  3280. */
  3281. void ring_buffer_reset_cpu(struct ring_buffer *buffer, int cpu)
  3282. {
  3283. struct ring_buffer_per_cpu *cpu_buffer = buffer->buffers[cpu];
  3284. unsigned long flags;
  3285. if (!cpumask_test_cpu(cpu, buffer->cpumask))
  3286. return;
  3287. atomic_inc(&buffer->resize_disabled);
  3288. atomic_inc(&cpu_buffer->record_disabled);
  3289. /* Make sure all commits have finished */
  3290. synchronize_sched();
  3291. raw_spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
  3292. if (RB_WARN_ON(cpu_buffer, local_read(&cpu_buffer->committing)))
  3293. goto out;
  3294. arch_spin_lock(&cpu_buffer->lock);
  3295. rb_reset_cpu(cpu_buffer);
  3296. arch_spin_unlock(&cpu_buffer->lock);
  3297. out:
  3298. raw_spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
  3299. atomic_dec(&cpu_buffer->record_disabled);
  3300. atomic_dec(&buffer->resize_disabled);
  3301. }
  3302. EXPORT_SYMBOL_GPL(ring_buffer_reset_cpu);
  3303. /**
  3304. * ring_buffer_reset - reset a ring buffer
  3305. * @buffer: The ring buffer to reset all cpu buffers
  3306. */
  3307. void ring_buffer_reset(struct ring_buffer *buffer)
  3308. {
  3309. int cpu;
  3310. for_each_buffer_cpu(buffer, cpu)
  3311. ring_buffer_reset_cpu(buffer, cpu);
  3312. }
  3313. EXPORT_SYMBOL_GPL(ring_buffer_reset);
  3314. /**
  3315. * rind_buffer_empty - is the ring buffer empty?
  3316. * @buffer: The ring buffer to test
  3317. */
  3318. int ring_buffer_empty(struct ring_buffer *buffer)
  3319. {
  3320. struct ring_buffer_per_cpu *cpu_buffer;
  3321. unsigned long flags;
  3322. int dolock;
  3323. int cpu;
  3324. int ret;
  3325. dolock = rb_ok_to_lock();
  3326. /* yes this is racy, but if you don't like the race, lock the buffer */
  3327. for_each_buffer_cpu(buffer, cpu) {
  3328. cpu_buffer = buffer->buffers[cpu];
  3329. local_irq_save(flags);
  3330. if (dolock)
  3331. raw_spin_lock(&cpu_buffer->reader_lock);
  3332. ret = rb_per_cpu_empty(cpu_buffer);
  3333. if (dolock)
  3334. raw_spin_unlock(&cpu_buffer->reader_lock);
  3335. local_irq_restore(flags);
  3336. if (!ret)
  3337. return 0;
  3338. }
  3339. return 1;
  3340. }
  3341. EXPORT_SYMBOL_GPL(ring_buffer_empty);
  3342. /**
  3343. * ring_buffer_empty_cpu - is a cpu buffer of a ring buffer empty?
  3344. * @buffer: The ring buffer
  3345. * @cpu: The CPU buffer to test
  3346. */
  3347. int ring_buffer_empty_cpu(struct ring_buffer *buffer, int cpu)
  3348. {
  3349. struct ring_buffer_per_cpu *cpu_buffer;
  3350. unsigned long flags;
  3351. int dolock;
  3352. int ret;
  3353. if (!cpumask_test_cpu(cpu, buffer->cpumask))
  3354. return 1;
  3355. dolock = rb_ok_to_lock();
  3356. cpu_buffer = buffer->buffers[cpu];
  3357. local_irq_save(flags);
  3358. if (dolock)
  3359. raw_spin_lock(&cpu_buffer->reader_lock);
  3360. ret = rb_per_cpu_empty(cpu_buffer);
  3361. if (dolock)
  3362. raw_spin_unlock(&cpu_buffer->reader_lock);
  3363. local_irq_restore(flags);
  3364. return ret;
  3365. }
  3366. EXPORT_SYMBOL_GPL(ring_buffer_empty_cpu);
  3367. #ifdef CONFIG_RING_BUFFER_ALLOW_SWAP
  3368. /**
  3369. * ring_buffer_swap_cpu - swap a CPU buffer between two ring buffers
  3370. * @buffer_a: One buffer to swap with
  3371. * @buffer_b: The other buffer to swap with
  3372. *
  3373. * This function is useful for tracers that want to take a "snapshot"
  3374. * of a CPU buffer and has another back up buffer lying around.
  3375. * it is expected that the tracer handles the cpu buffer not being
  3376. * used at the moment.
  3377. */
  3378. int ring_buffer_swap_cpu(struct ring_buffer *buffer_a,
  3379. struct ring_buffer *buffer_b, int cpu)
  3380. {
  3381. struct ring_buffer_per_cpu *cpu_buffer_a;
  3382. struct ring_buffer_per_cpu *cpu_buffer_b;
  3383. int ret = -EINVAL;
  3384. if (!cpumask_test_cpu(cpu, buffer_a->cpumask) ||
  3385. !cpumask_test_cpu(cpu, buffer_b->cpumask))
  3386. goto out;
  3387. cpu_buffer_a = buffer_a->buffers[cpu];
  3388. cpu_buffer_b = buffer_b->buffers[cpu];
  3389. /* At least make sure the two buffers are somewhat the same */
  3390. if (cpu_buffer_a->nr_pages != cpu_buffer_b->nr_pages)
  3391. goto out;
  3392. ret = -EAGAIN;
  3393. if (ring_buffer_flags != RB_BUFFERS_ON)
  3394. goto out;
  3395. if (atomic_read(&buffer_a->record_disabled))
  3396. goto out;
  3397. if (atomic_read(&buffer_b->record_disabled))
  3398. goto out;
  3399. if (atomic_read(&cpu_buffer_a->record_disabled))
  3400. goto out;
  3401. if (atomic_read(&cpu_buffer_b->record_disabled))
  3402. goto out;
  3403. /*
  3404. * We can't do a synchronize_sched here because this
  3405. * function can be called in atomic context.
  3406. * Normally this will be called from the same CPU as cpu.
  3407. * If not it's up to the caller to protect this.
  3408. */
  3409. atomic_inc(&cpu_buffer_a->record_disabled);
  3410. atomic_inc(&cpu_buffer_b->record_disabled);
  3411. ret = -EBUSY;
  3412. if (local_read(&cpu_buffer_a->committing))
  3413. goto out_dec;
  3414. if (local_read(&cpu_buffer_b->committing))
  3415. goto out_dec;
  3416. buffer_a->buffers[cpu] = cpu_buffer_b;
  3417. buffer_b->buffers[cpu] = cpu_buffer_a;
  3418. cpu_buffer_b->buffer = buffer_a;
  3419. cpu_buffer_a->buffer = buffer_b;
  3420. ret = 0;
  3421. out_dec:
  3422. atomic_dec(&cpu_buffer_a->record_disabled);
  3423. atomic_dec(&cpu_buffer_b->record_disabled);
  3424. out:
  3425. return ret;
  3426. }
  3427. EXPORT_SYMBOL_GPL(ring_buffer_swap_cpu);
  3428. #endif /* CONFIG_RING_BUFFER_ALLOW_SWAP */
  3429. /**
  3430. * ring_buffer_alloc_read_page - allocate a page to read from buffer
  3431. * @buffer: the buffer to allocate for.
  3432. *
  3433. * This function is used in conjunction with ring_buffer_read_page.
  3434. * When reading a full page from the ring buffer, these functions
  3435. * can be used to speed up the process. The calling function should
  3436. * allocate a few pages first with this function. Then when it
  3437. * needs to get pages from the ring buffer, it passes the result
  3438. * of this function into ring_buffer_read_page, which will swap
  3439. * the page that was allocated, with the read page of the buffer.
  3440. *
  3441. * Returns:
  3442. * The page allocated, or NULL on error.
  3443. */
  3444. void *ring_buffer_alloc_read_page(struct ring_buffer *buffer, int cpu)
  3445. {
  3446. struct buffer_data_page *bpage;
  3447. struct page *page;
  3448. page = alloc_pages_node(cpu_to_node(cpu),
  3449. GFP_KERNEL | __GFP_NORETRY, 0);
  3450. if (!page)
  3451. return NULL;
  3452. bpage = page_address(page);
  3453. rb_init_page(bpage);
  3454. return bpage;
  3455. }
  3456. EXPORT_SYMBOL_GPL(ring_buffer_alloc_read_page);
  3457. /**
  3458. * ring_buffer_free_read_page - free an allocated read page
  3459. * @buffer: the buffer the page was allocate for
  3460. * @data: the page to free
  3461. *
  3462. * Free a page allocated from ring_buffer_alloc_read_page.
  3463. */
  3464. void ring_buffer_free_read_page(struct ring_buffer *buffer, void *data)
  3465. {
  3466. free_page((unsigned long)data);
  3467. }
  3468. EXPORT_SYMBOL_GPL(ring_buffer_free_read_page);
  3469. /**
  3470. * ring_buffer_read_page - extract a page from the ring buffer
  3471. * @buffer: buffer to extract from
  3472. * @data_page: the page to use allocated from ring_buffer_alloc_read_page
  3473. * @len: amount to extract
  3474. * @cpu: the cpu of the buffer to extract
  3475. * @full: should the extraction only happen when the page is full.
  3476. *
  3477. * This function will pull out a page from the ring buffer and consume it.
  3478. * @data_page must be the address of the variable that was returned
  3479. * from ring_buffer_alloc_read_page. This is because the page might be used
  3480. * to swap with a page in the ring buffer.
  3481. *
  3482. * for example:
  3483. * rpage = ring_buffer_alloc_read_page(buffer);
  3484. * if (!rpage)
  3485. * return error;
  3486. * ret = ring_buffer_read_page(buffer, &rpage, len, cpu, 0);
  3487. * if (ret >= 0)
  3488. * process_page(rpage, ret);
  3489. *
  3490. * When @full is set, the function will not return true unless
  3491. * the writer is off the reader page.
  3492. *
  3493. * Note: it is up to the calling functions to handle sleeps and wakeups.
  3494. * The ring buffer can be used anywhere in the kernel and can not
  3495. * blindly call wake_up. The layer that uses the ring buffer must be
  3496. * responsible for that.
  3497. *
  3498. * Returns:
  3499. * >=0 if data has been transferred, returns the offset of consumed data.
  3500. * <0 if no data has been transferred.
  3501. */
  3502. int ring_buffer_read_page(struct ring_buffer *buffer,
  3503. void **data_page, size_t len, int cpu, int full)
  3504. {
  3505. struct ring_buffer_per_cpu *cpu_buffer = buffer->buffers[cpu];
  3506. struct ring_buffer_event *event;
  3507. struct buffer_data_page *bpage;
  3508. struct buffer_page *reader;
  3509. unsigned long missed_events;
  3510. unsigned long flags;
  3511. unsigned int commit;
  3512. unsigned int read;
  3513. u64 save_timestamp;
  3514. int ret = -1;
  3515. if (!cpumask_test_cpu(cpu, buffer->cpumask))
  3516. goto out;
  3517. /*
  3518. * If len is not big enough to hold the page header, then
  3519. * we can not copy anything.
  3520. */
  3521. if (len <= BUF_PAGE_HDR_SIZE)
  3522. goto out;
  3523. len -= BUF_PAGE_HDR_SIZE;
  3524. if (!data_page)
  3525. goto out;
  3526. bpage = *data_page;
  3527. if (!bpage)
  3528. goto out;
  3529. raw_spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
  3530. reader = rb_get_reader_page(cpu_buffer);
  3531. if (!reader)
  3532. goto out_unlock;
  3533. event = rb_reader_event(cpu_buffer);
  3534. read = reader->read;
  3535. commit = rb_page_commit(reader);
  3536. /* Check if any events were dropped */
  3537. missed_events = cpu_buffer->lost_events;
  3538. /*
  3539. * If this page has been partially read or
  3540. * if len is not big enough to read the rest of the page or
  3541. * a writer is still on the page, then
  3542. * we must copy the data from the page to the buffer.
  3543. * Otherwise, we can simply swap the page with the one passed in.
  3544. */
  3545. if (read || (len < (commit - read)) ||
  3546. cpu_buffer->reader_page == cpu_buffer->commit_page) {
  3547. struct buffer_data_page *rpage = cpu_buffer->reader_page->page;
  3548. unsigned int rpos = read;
  3549. unsigned int pos = 0;
  3550. unsigned int size;
  3551. if (full)
  3552. goto out_unlock;
  3553. if (len > (commit - read))
  3554. len = (commit - read);
  3555. /* Always keep the time extend and data together */
  3556. size = rb_event_ts_length(event);
  3557. if (len < size)
  3558. goto out_unlock;
  3559. /* save the current timestamp, since the user will need it */
  3560. save_timestamp = cpu_buffer->read_stamp;
  3561. /* Need to copy one event at a time */
  3562. do {
  3563. /* We need the size of one event, because
  3564. * rb_advance_reader only advances by one event,
  3565. * whereas rb_event_ts_length may include the size of
  3566. * one or two events.
  3567. * We have already ensured there's enough space if this
  3568. * is a time extend. */
  3569. size = rb_event_length(event);
  3570. memcpy(bpage->data + pos, rpage->data + rpos, size);
  3571. len -= size;
  3572. rb_advance_reader(cpu_buffer);
  3573. rpos = reader->read;
  3574. pos += size;
  3575. if (rpos >= commit)
  3576. break;
  3577. event = rb_reader_event(cpu_buffer);
  3578. /* Always keep the time extend and data together */
  3579. size = rb_event_ts_length(event);
  3580. } while (len >= size);
  3581. /* update bpage */
  3582. local_set(&bpage->commit, pos);
  3583. bpage->time_stamp = save_timestamp;
  3584. /* we copied everything to the beginning */
  3585. read = 0;
  3586. } else {
  3587. /* update the entry counter */
  3588. cpu_buffer->read += rb_page_entries(reader);
  3589. cpu_buffer->read_bytes += BUF_PAGE_SIZE;
  3590. /* swap the pages */
  3591. rb_init_page(bpage);
  3592. bpage = reader->page;
  3593. reader->page = *data_page;
  3594. local_set(&reader->write, 0);
  3595. local_set(&reader->entries, 0);
  3596. reader->read = 0;
  3597. *data_page = bpage;
  3598. /*
  3599. * Use the real_end for the data size,
  3600. * This gives us a chance to store the lost events
  3601. * on the page.
  3602. */
  3603. if (reader->real_end)
  3604. local_set(&bpage->commit, reader->real_end);
  3605. }
  3606. ret = read;
  3607. cpu_buffer->lost_events = 0;
  3608. commit = local_read(&bpage->commit);
  3609. /*
  3610. * Set a flag in the commit field if we lost events
  3611. */
  3612. if (missed_events) {
  3613. /* If there is room at the end of the page to save the
  3614. * missed events, then record it there.
  3615. */
  3616. if (BUF_PAGE_SIZE - commit >= sizeof(missed_events)) {
  3617. memcpy(&bpage->data[commit], &missed_events,
  3618. sizeof(missed_events));
  3619. local_add(RB_MISSED_STORED, &bpage->commit);
  3620. commit += sizeof(missed_events);
  3621. }
  3622. local_add(RB_MISSED_EVENTS, &bpage->commit);
  3623. }
  3624. /*
  3625. * This page may be off to user land. Zero it out here.
  3626. */
  3627. if (commit < BUF_PAGE_SIZE)
  3628. memset(&bpage->data[commit], 0, BUF_PAGE_SIZE - commit);
  3629. out_unlock:
  3630. raw_spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
  3631. out:
  3632. return ret;
  3633. }
  3634. EXPORT_SYMBOL_GPL(ring_buffer_read_page);
  3635. #ifdef CONFIG_HOTPLUG_CPU
  3636. static int rb_cpu_notify(struct notifier_block *self,
  3637. unsigned long action, void *hcpu)
  3638. {
  3639. struct ring_buffer *buffer =
  3640. container_of(self, struct ring_buffer, cpu_notify);
  3641. long cpu = (long)hcpu;
  3642. int cpu_i, nr_pages_same;
  3643. unsigned int nr_pages;
  3644. switch (action) {
  3645. case CPU_UP_PREPARE:
  3646. case CPU_UP_PREPARE_FROZEN:
  3647. if (cpumask_test_cpu(cpu, buffer->cpumask))
  3648. return NOTIFY_OK;
  3649. nr_pages = 0;
  3650. nr_pages_same = 1;
  3651. /* check if all cpu sizes are same */
  3652. for_each_buffer_cpu(buffer, cpu_i) {
  3653. /* fill in the size from first enabled cpu */
  3654. if (nr_pages == 0)
  3655. nr_pages = buffer->buffers[cpu_i]->nr_pages;
  3656. if (nr_pages != buffer->buffers[cpu_i]->nr_pages) {
  3657. nr_pages_same = 0;
  3658. break;
  3659. }
  3660. }
  3661. /* allocate minimum pages, user can later expand it */
  3662. if (!nr_pages_same)
  3663. nr_pages = 2;
  3664. buffer->buffers[cpu] =
  3665. rb_allocate_cpu_buffer(buffer, nr_pages, cpu);
  3666. if (!buffer->buffers[cpu]) {
  3667. WARN(1, "failed to allocate ring buffer on CPU %ld\n",
  3668. cpu);
  3669. return NOTIFY_OK;
  3670. }
  3671. smp_wmb();
  3672. cpumask_set_cpu(cpu, buffer->cpumask);
  3673. break;
  3674. case CPU_DOWN_PREPARE:
  3675. case CPU_DOWN_PREPARE_FROZEN:
  3676. /*
  3677. * Do nothing.
  3678. * If we were to free the buffer, then the user would
  3679. * lose any trace that was in the buffer.
  3680. */
  3681. break;
  3682. default:
  3683. break;
  3684. }
  3685. return NOTIFY_OK;
  3686. }
  3687. #endif