ring_buffer.c 112 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368
  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_completion;
  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. rb_head_page_deactivate(cpu_buffer);
  824. if (RB_WARN_ON(cpu_buffer, head->next->prev != head))
  825. return -1;
  826. if (RB_WARN_ON(cpu_buffer, head->prev->next != head))
  827. return -1;
  828. if (rb_check_list(cpu_buffer, head))
  829. return -1;
  830. list_for_each_entry_safe(bpage, tmp, head, list) {
  831. if (RB_WARN_ON(cpu_buffer,
  832. bpage->list.next->prev != &bpage->list))
  833. return -1;
  834. if (RB_WARN_ON(cpu_buffer,
  835. bpage->list.prev->next != &bpage->list))
  836. return -1;
  837. if (rb_check_list(cpu_buffer, &bpage->list))
  838. return -1;
  839. }
  840. rb_head_page_activate(cpu_buffer);
  841. return 0;
  842. }
  843. static int __rb_allocate_pages(int nr_pages, struct list_head *pages, int cpu)
  844. {
  845. int i;
  846. struct buffer_page *bpage, *tmp;
  847. for (i = 0; i < nr_pages; i++) {
  848. struct page *page;
  849. /*
  850. * __GFP_NORETRY flag makes sure that the allocation fails
  851. * gracefully without invoking oom-killer and the system is
  852. * not destabilized.
  853. */
  854. bpage = kzalloc_node(ALIGN(sizeof(*bpage), cache_line_size()),
  855. GFP_KERNEL | __GFP_NORETRY,
  856. cpu_to_node(cpu));
  857. if (!bpage)
  858. goto free_pages;
  859. list_add(&bpage->list, pages);
  860. page = alloc_pages_node(cpu_to_node(cpu),
  861. GFP_KERNEL | __GFP_NORETRY, 0);
  862. if (!page)
  863. goto free_pages;
  864. bpage->page = page_address(page);
  865. rb_init_page(bpage->page);
  866. }
  867. return 0;
  868. free_pages:
  869. list_for_each_entry_safe(bpage, tmp, pages, list) {
  870. list_del_init(&bpage->list);
  871. free_buffer_page(bpage);
  872. }
  873. return -ENOMEM;
  874. }
  875. static int rb_allocate_pages(struct ring_buffer_per_cpu *cpu_buffer,
  876. unsigned nr_pages)
  877. {
  878. LIST_HEAD(pages);
  879. WARN_ON(!nr_pages);
  880. if (__rb_allocate_pages(nr_pages, &pages, cpu_buffer->cpu))
  881. return -ENOMEM;
  882. /*
  883. * The ring buffer page list is a circular list that does not
  884. * start and end with a list head. All page list items point to
  885. * other pages.
  886. */
  887. cpu_buffer->pages = pages.next;
  888. list_del(&pages);
  889. cpu_buffer->nr_pages = nr_pages;
  890. rb_check_pages(cpu_buffer);
  891. return 0;
  892. }
  893. static struct ring_buffer_per_cpu *
  894. rb_allocate_cpu_buffer(struct ring_buffer *buffer, int nr_pages, int cpu)
  895. {
  896. struct ring_buffer_per_cpu *cpu_buffer;
  897. struct buffer_page *bpage;
  898. struct page *page;
  899. int ret;
  900. cpu_buffer = kzalloc_node(ALIGN(sizeof(*cpu_buffer), cache_line_size()),
  901. GFP_KERNEL, cpu_to_node(cpu));
  902. if (!cpu_buffer)
  903. return NULL;
  904. cpu_buffer->cpu = cpu;
  905. cpu_buffer->buffer = buffer;
  906. raw_spin_lock_init(&cpu_buffer->reader_lock);
  907. lockdep_set_class(&cpu_buffer->reader_lock, buffer->reader_lock_key);
  908. cpu_buffer->lock = (arch_spinlock_t)__ARCH_SPIN_LOCK_UNLOCKED;
  909. INIT_WORK(&cpu_buffer->update_pages_work, update_pages_handler);
  910. init_completion(&cpu_buffer->update_completion);
  911. bpage = kzalloc_node(ALIGN(sizeof(*bpage), cache_line_size()),
  912. GFP_KERNEL, cpu_to_node(cpu));
  913. if (!bpage)
  914. goto fail_free_buffer;
  915. rb_check_bpage(cpu_buffer, bpage);
  916. cpu_buffer->reader_page = bpage;
  917. page = alloc_pages_node(cpu_to_node(cpu), GFP_KERNEL, 0);
  918. if (!page)
  919. goto fail_free_reader;
  920. bpage->page = page_address(page);
  921. rb_init_page(bpage->page);
  922. INIT_LIST_HEAD(&cpu_buffer->reader_page->list);
  923. ret = rb_allocate_pages(cpu_buffer, nr_pages);
  924. if (ret < 0)
  925. goto fail_free_reader;
  926. cpu_buffer->head_page
  927. = list_entry(cpu_buffer->pages, struct buffer_page, list);
  928. cpu_buffer->tail_page = cpu_buffer->commit_page = cpu_buffer->head_page;
  929. rb_head_page_activate(cpu_buffer);
  930. return cpu_buffer;
  931. fail_free_reader:
  932. free_buffer_page(cpu_buffer->reader_page);
  933. fail_free_buffer:
  934. kfree(cpu_buffer);
  935. return NULL;
  936. }
  937. static void rb_free_cpu_buffer(struct ring_buffer_per_cpu *cpu_buffer)
  938. {
  939. struct list_head *head = cpu_buffer->pages;
  940. struct buffer_page *bpage, *tmp;
  941. free_buffer_page(cpu_buffer->reader_page);
  942. rb_head_page_deactivate(cpu_buffer);
  943. if (head) {
  944. list_for_each_entry_safe(bpage, tmp, head, list) {
  945. list_del_init(&bpage->list);
  946. free_buffer_page(bpage);
  947. }
  948. bpage = list_entry(head, struct buffer_page, list);
  949. free_buffer_page(bpage);
  950. }
  951. kfree(cpu_buffer);
  952. }
  953. #ifdef CONFIG_HOTPLUG_CPU
  954. static int rb_cpu_notify(struct notifier_block *self,
  955. unsigned long action, void *hcpu);
  956. #endif
  957. /**
  958. * ring_buffer_alloc - allocate a new ring_buffer
  959. * @size: the size in bytes per cpu that is needed.
  960. * @flags: attributes to set for the ring buffer.
  961. *
  962. * Currently the only flag that is available is the RB_FL_OVERWRITE
  963. * flag. This flag means that the buffer will overwrite old data
  964. * when the buffer wraps. If this flag is not set, the buffer will
  965. * drop data when the tail hits the head.
  966. */
  967. struct ring_buffer *__ring_buffer_alloc(unsigned long size, unsigned flags,
  968. struct lock_class_key *key)
  969. {
  970. struct ring_buffer *buffer;
  971. int bsize;
  972. int cpu, nr_pages;
  973. /* keep it in its own cache line */
  974. buffer = kzalloc(ALIGN(sizeof(*buffer), cache_line_size()),
  975. GFP_KERNEL);
  976. if (!buffer)
  977. return NULL;
  978. if (!alloc_cpumask_var(&buffer->cpumask, GFP_KERNEL))
  979. goto fail_free_buffer;
  980. nr_pages = DIV_ROUND_UP(size, BUF_PAGE_SIZE);
  981. buffer->flags = flags;
  982. buffer->clock = trace_clock_local;
  983. buffer->reader_lock_key = key;
  984. /* need at least two pages */
  985. if (nr_pages < 2)
  986. nr_pages = 2;
  987. /*
  988. * In case of non-hotplug cpu, if the ring-buffer is allocated
  989. * in early initcall, it will not be notified of secondary cpus.
  990. * In that off case, we need to allocate for all possible cpus.
  991. */
  992. #ifdef CONFIG_HOTPLUG_CPU
  993. get_online_cpus();
  994. cpumask_copy(buffer->cpumask, cpu_online_mask);
  995. #else
  996. cpumask_copy(buffer->cpumask, cpu_possible_mask);
  997. #endif
  998. buffer->cpus = nr_cpu_ids;
  999. bsize = sizeof(void *) * nr_cpu_ids;
  1000. buffer->buffers = kzalloc(ALIGN(bsize, cache_line_size()),
  1001. GFP_KERNEL);
  1002. if (!buffer->buffers)
  1003. goto fail_free_cpumask;
  1004. for_each_buffer_cpu(buffer, cpu) {
  1005. buffer->buffers[cpu] =
  1006. rb_allocate_cpu_buffer(buffer, nr_pages, cpu);
  1007. if (!buffer->buffers[cpu])
  1008. goto fail_free_buffers;
  1009. }
  1010. #ifdef CONFIG_HOTPLUG_CPU
  1011. buffer->cpu_notify.notifier_call = rb_cpu_notify;
  1012. buffer->cpu_notify.priority = 0;
  1013. register_cpu_notifier(&buffer->cpu_notify);
  1014. #endif
  1015. put_online_cpus();
  1016. mutex_init(&buffer->mutex);
  1017. return buffer;
  1018. fail_free_buffers:
  1019. for_each_buffer_cpu(buffer, cpu) {
  1020. if (buffer->buffers[cpu])
  1021. rb_free_cpu_buffer(buffer->buffers[cpu]);
  1022. }
  1023. kfree(buffer->buffers);
  1024. fail_free_cpumask:
  1025. free_cpumask_var(buffer->cpumask);
  1026. put_online_cpus();
  1027. fail_free_buffer:
  1028. kfree(buffer);
  1029. return NULL;
  1030. }
  1031. EXPORT_SYMBOL_GPL(__ring_buffer_alloc);
  1032. /**
  1033. * ring_buffer_free - free a ring buffer.
  1034. * @buffer: the buffer to free.
  1035. */
  1036. void
  1037. ring_buffer_free(struct ring_buffer *buffer)
  1038. {
  1039. int cpu;
  1040. get_online_cpus();
  1041. #ifdef CONFIG_HOTPLUG_CPU
  1042. unregister_cpu_notifier(&buffer->cpu_notify);
  1043. #endif
  1044. for_each_buffer_cpu(buffer, cpu)
  1045. rb_free_cpu_buffer(buffer->buffers[cpu]);
  1046. put_online_cpus();
  1047. kfree(buffer->buffers);
  1048. free_cpumask_var(buffer->cpumask);
  1049. kfree(buffer);
  1050. }
  1051. EXPORT_SYMBOL_GPL(ring_buffer_free);
  1052. void ring_buffer_set_clock(struct ring_buffer *buffer,
  1053. u64 (*clock)(void))
  1054. {
  1055. buffer->clock = clock;
  1056. }
  1057. static void rb_reset_cpu(struct ring_buffer_per_cpu *cpu_buffer);
  1058. static inline unsigned long rb_page_entries(struct buffer_page *bpage)
  1059. {
  1060. return local_read(&bpage->entries) & RB_WRITE_MASK;
  1061. }
  1062. static inline unsigned long rb_page_write(struct buffer_page *bpage)
  1063. {
  1064. return local_read(&bpage->write) & RB_WRITE_MASK;
  1065. }
  1066. static int
  1067. rb_remove_pages(struct ring_buffer_per_cpu *cpu_buffer, unsigned int nr_pages)
  1068. {
  1069. struct list_head *tail_page, *to_remove, *next_page;
  1070. struct buffer_page *to_remove_page, *tmp_iter_page;
  1071. struct buffer_page *last_page, *first_page;
  1072. unsigned int nr_removed;
  1073. unsigned long head_bit;
  1074. int page_entries;
  1075. head_bit = 0;
  1076. raw_spin_lock_irq(&cpu_buffer->reader_lock);
  1077. atomic_inc(&cpu_buffer->record_disabled);
  1078. /*
  1079. * We don't race with the readers since we have acquired the reader
  1080. * lock. We also don't race with writers after disabling recording.
  1081. * This makes it easy to figure out the first and the last page to be
  1082. * removed from the list. We unlink all the pages in between including
  1083. * the first and last pages. This is done in a busy loop so that we
  1084. * lose the least number of traces.
  1085. * The pages are freed after we restart recording and unlock readers.
  1086. */
  1087. tail_page = &cpu_buffer->tail_page->list;
  1088. /*
  1089. * tail page might be on reader page, we remove the next page
  1090. * from the ring buffer
  1091. */
  1092. if (cpu_buffer->tail_page == cpu_buffer->reader_page)
  1093. tail_page = rb_list_head(tail_page->next);
  1094. to_remove = tail_page;
  1095. /* start of pages to remove */
  1096. first_page = list_entry(rb_list_head(to_remove->next),
  1097. struct buffer_page, list);
  1098. for (nr_removed = 0; nr_removed < nr_pages; nr_removed++) {
  1099. to_remove = rb_list_head(to_remove)->next;
  1100. head_bit |= (unsigned long)to_remove & RB_PAGE_HEAD;
  1101. }
  1102. next_page = rb_list_head(to_remove)->next;
  1103. /*
  1104. * Now we remove all pages between tail_page and next_page.
  1105. * Make sure that we have head_bit value preserved for the
  1106. * next page
  1107. */
  1108. tail_page->next = (struct list_head *)((unsigned long)next_page |
  1109. head_bit);
  1110. next_page = rb_list_head(next_page);
  1111. next_page->prev = tail_page;
  1112. /* make sure pages points to a valid page in the ring buffer */
  1113. cpu_buffer->pages = next_page;
  1114. /* update head page */
  1115. if (head_bit)
  1116. cpu_buffer->head_page = list_entry(next_page,
  1117. struct buffer_page, list);
  1118. /*
  1119. * change read pointer to make sure any read iterators reset
  1120. * themselves
  1121. */
  1122. cpu_buffer->read = 0;
  1123. /* pages are removed, resume tracing and then free the pages */
  1124. atomic_dec(&cpu_buffer->record_disabled);
  1125. raw_spin_unlock_irq(&cpu_buffer->reader_lock);
  1126. RB_WARN_ON(cpu_buffer, list_empty(cpu_buffer->pages));
  1127. /* last buffer page to remove */
  1128. last_page = list_entry(rb_list_head(to_remove), struct buffer_page,
  1129. list);
  1130. tmp_iter_page = first_page;
  1131. do {
  1132. to_remove_page = tmp_iter_page;
  1133. rb_inc_page(cpu_buffer, &tmp_iter_page);
  1134. /* update the counters */
  1135. page_entries = rb_page_entries(to_remove_page);
  1136. if (page_entries) {
  1137. /*
  1138. * If something was added to this page, it was full
  1139. * since it is not the tail page. So we deduct the
  1140. * bytes consumed in ring buffer from here.
  1141. * No need to update overruns, since this page is
  1142. * deleted from ring buffer and its entries are
  1143. * already accounted for.
  1144. */
  1145. local_sub(BUF_PAGE_SIZE, &cpu_buffer->entries_bytes);
  1146. }
  1147. /*
  1148. * We have already removed references to this list item, just
  1149. * free up the buffer_page and its page
  1150. */
  1151. free_buffer_page(to_remove_page);
  1152. nr_removed--;
  1153. } while (to_remove_page != last_page);
  1154. RB_WARN_ON(cpu_buffer, nr_removed);
  1155. return nr_removed == 0;
  1156. }
  1157. static int
  1158. rb_insert_pages(struct ring_buffer_per_cpu *cpu_buffer)
  1159. {
  1160. struct list_head *pages = &cpu_buffer->new_pages;
  1161. int retries, success;
  1162. raw_spin_lock_irq(&cpu_buffer->reader_lock);
  1163. /*
  1164. * We are holding the reader lock, so the reader page won't be swapped
  1165. * in the ring buffer. Now we are racing with the writer trying to
  1166. * move head page and the tail page.
  1167. * We are going to adapt the reader page update process where:
  1168. * 1. We first splice the start and end of list of new pages between
  1169. * the head page and its previous page.
  1170. * 2. We cmpxchg the prev_page->next to point from head page to the
  1171. * start of new pages list.
  1172. * 3. Finally, we update the head->prev to the end of new list.
  1173. *
  1174. * We will try this process 10 times, to make sure that we don't keep
  1175. * spinning.
  1176. */
  1177. retries = 10;
  1178. success = 0;
  1179. while (retries--) {
  1180. struct list_head *head_page, *prev_page, *r;
  1181. struct list_head *last_page, *first_page;
  1182. struct list_head *head_page_with_bit;
  1183. head_page = &rb_set_head_page(cpu_buffer)->list;
  1184. prev_page = head_page->prev;
  1185. first_page = pages->next;
  1186. last_page = pages->prev;
  1187. head_page_with_bit = (struct list_head *)
  1188. ((unsigned long)head_page | RB_PAGE_HEAD);
  1189. last_page->next = head_page_with_bit;
  1190. first_page->prev = prev_page;
  1191. r = cmpxchg(&prev_page->next, head_page_with_bit, first_page);
  1192. if (r == head_page_with_bit) {
  1193. /*
  1194. * yay, we replaced the page pointer to our new list,
  1195. * now, we just have to update to head page's prev
  1196. * pointer to point to end of list
  1197. */
  1198. head_page->prev = last_page;
  1199. success = 1;
  1200. break;
  1201. }
  1202. }
  1203. if (success)
  1204. INIT_LIST_HEAD(pages);
  1205. /*
  1206. * If we weren't successful in adding in new pages, warn and stop
  1207. * tracing
  1208. */
  1209. RB_WARN_ON(cpu_buffer, !success);
  1210. raw_spin_unlock_irq(&cpu_buffer->reader_lock);
  1211. /* free pages if they weren't inserted */
  1212. if (!success) {
  1213. struct buffer_page *bpage, *tmp;
  1214. list_for_each_entry_safe(bpage, tmp, &cpu_buffer->new_pages,
  1215. list) {
  1216. list_del_init(&bpage->list);
  1217. free_buffer_page(bpage);
  1218. }
  1219. }
  1220. return success;
  1221. }
  1222. static void rb_update_pages(struct ring_buffer_per_cpu *cpu_buffer)
  1223. {
  1224. int success;
  1225. if (cpu_buffer->nr_pages_to_update > 0)
  1226. success = rb_insert_pages(cpu_buffer);
  1227. else
  1228. success = rb_remove_pages(cpu_buffer,
  1229. -cpu_buffer->nr_pages_to_update);
  1230. if (success)
  1231. cpu_buffer->nr_pages += cpu_buffer->nr_pages_to_update;
  1232. }
  1233. static void update_pages_handler(struct work_struct *work)
  1234. {
  1235. struct ring_buffer_per_cpu *cpu_buffer = container_of(work,
  1236. struct ring_buffer_per_cpu, update_pages_work);
  1237. rb_update_pages(cpu_buffer);
  1238. complete(&cpu_buffer->update_completion);
  1239. }
  1240. /**
  1241. * ring_buffer_resize - resize the ring buffer
  1242. * @buffer: the buffer to resize.
  1243. * @size: the new size.
  1244. *
  1245. * Minimum size is 2 * BUF_PAGE_SIZE.
  1246. *
  1247. * Returns 0 on success and < 0 on failure.
  1248. */
  1249. int ring_buffer_resize(struct ring_buffer *buffer, unsigned long size,
  1250. int cpu_id)
  1251. {
  1252. struct ring_buffer_per_cpu *cpu_buffer;
  1253. unsigned nr_pages;
  1254. int cpu, err = 0;
  1255. /*
  1256. * Always succeed at resizing a non-existent buffer:
  1257. */
  1258. if (!buffer)
  1259. return size;
  1260. size = DIV_ROUND_UP(size, BUF_PAGE_SIZE);
  1261. size *= BUF_PAGE_SIZE;
  1262. /* we need a minimum of two pages */
  1263. if (size < BUF_PAGE_SIZE * 2)
  1264. size = BUF_PAGE_SIZE * 2;
  1265. nr_pages = DIV_ROUND_UP(size, BUF_PAGE_SIZE);
  1266. /*
  1267. * Don't succeed if resizing is disabled, as a reader might be
  1268. * manipulating the ring buffer and is expecting a sane state while
  1269. * this is true.
  1270. */
  1271. if (atomic_read(&buffer->resize_disabled))
  1272. return -EBUSY;
  1273. /* prevent another thread from changing buffer sizes */
  1274. mutex_lock(&buffer->mutex);
  1275. if (cpu_id == RING_BUFFER_ALL_CPUS) {
  1276. /* calculate the pages to update */
  1277. for_each_buffer_cpu(buffer, cpu) {
  1278. cpu_buffer = buffer->buffers[cpu];
  1279. cpu_buffer->nr_pages_to_update = nr_pages -
  1280. cpu_buffer->nr_pages;
  1281. /*
  1282. * nothing more to do for removing pages or no update
  1283. */
  1284. if (cpu_buffer->nr_pages_to_update <= 0)
  1285. continue;
  1286. /*
  1287. * to add pages, make sure all new pages can be
  1288. * allocated without receiving ENOMEM
  1289. */
  1290. INIT_LIST_HEAD(&cpu_buffer->new_pages);
  1291. if (__rb_allocate_pages(cpu_buffer->nr_pages_to_update,
  1292. &cpu_buffer->new_pages, cpu)) {
  1293. /* not enough memory for new pages */
  1294. err = -ENOMEM;
  1295. goto out_err;
  1296. }
  1297. }
  1298. get_online_cpus();
  1299. /*
  1300. * Fire off all the required work handlers
  1301. * Look out for offline CPUs
  1302. */
  1303. for_each_buffer_cpu(buffer, cpu) {
  1304. cpu_buffer = buffer->buffers[cpu];
  1305. if (!cpu_buffer->nr_pages_to_update ||
  1306. !cpu_online(cpu))
  1307. continue;
  1308. schedule_work_on(cpu, &cpu_buffer->update_pages_work);
  1309. }
  1310. /*
  1311. * This loop is for the CPUs that are not online.
  1312. * We can't schedule anything on them, but it's not necessary
  1313. * since we can change their buffer sizes without any race.
  1314. */
  1315. for_each_buffer_cpu(buffer, cpu) {
  1316. cpu_buffer = buffer->buffers[cpu];
  1317. if (!cpu_buffer->nr_pages_to_update ||
  1318. cpu_online(cpu))
  1319. continue;
  1320. rb_update_pages(cpu_buffer);
  1321. }
  1322. /* wait for all the updates to complete */
  1323. for_each_buffer_cpu(buffer, cpu) {
  1324. cpu_buffer = buffer->buffers[cpu];
  1325. if (!cpu_buffer->nr_pages_to_update ||
  1326. !cpu_online(cpu))
  1327. continue;
  1328. wait_for_completion(&cpu_buffer->update_completion);
  1329. /* reset this value */
  1330. cpu_buffer->nr_pages_to_update = 0;
  1331. }
  1332. put_online_cpus();
  1333. } else {
  1334. cpu_buffer = buffer->buffers[cpu_id];
  1335. if (nr_pages == cpu_buffer->nr_pages)
  1336. goto out;
  1337. cpu_buffer->nr_pages_to_update = nr_pages -
  1338. cpu_buffer->nr_pages;
  1339. INIT_LIST_HEAD(&cpu_buffer->new_pages);
  1340. if (cpu_buffer->nr_pages_to_update > 0 &&
  1341. __rb_allocate_pages(cpu_buffer->nr_pages_to_update,
  1342. &cpu_buffer->new_pages, cpu_id)) {
  1343. err = -ENOMEM;
  1344. goto out_err;
  1345. }
  1346. get_online_cpus();
  1347. if (cpu_online(cpu_id)) {
  1348. schedule_work_on(cpu_id,
  1349. &cpu_buffer->update_pages_work);
  1350. wait_for_completion(&cpu_buffer->update_completion);
  1351. } else
  1352. rb_update_pages(cpu_buffer);
  1353. put_online_cpus();
  1354. /* reset this value */
  1355. cpu_buffer->nr_pages_to_update = 0;
  1356. }
  1357. out:
  1358. /*
  1359. * The ring buffer resize can happen with the ring buffer
  1360. * enabled, so that the update disturbs the tracing as little
  1361. * as possible. But if the buffer is disabled, we do not need
  1362. * to worry about that, and we can take the time to verify
  1363. * that the buffer is not corrupt.
  1364. */
  1365. if (atomic_read(&buffer->record_disabled)) {
  1366. atomic_inc(&buffer->record_disabled);
  1367. /*
  1368. * Even though the buffer was disabled, we must make sure
  1369. * that it is truly disabled before calling rb_check_pages.
  1370. * There could have been a race between checking
  1371. * record_disable and incrementing it.
  1372. */
  1373. synchronize_sched();
  1374. for_each_buffer_cpu(buffer, cpu) {
  1375. cpu_buffer = buffer->buffers[cpu];
  1376. rb_check_pages(cpu_buffer);
  1377. }
  1378. atomic_dec(&buffer->record_disabled);
  1379. }
  1380. mutex_unlock(&buffer->mutex);
  1381. return size;
  1382. out_err:
  1383. for_each_buffer_cpu(buffer, cpu) {
  1384. struct buffer_page *bpage, *tmp;
  1385. cpu_buffer = buffer->buffers[cpu];
  1386. cpu_buffer->nr_pages_to_update = 0;
  1387. if (list_empty(&cpu_buffer->new_pages))
  1388. continue;
  1389. list_for_each_entry_safe(bpage, tmp, &cpu_buffer->new_pages,
  1390. list) {
  1391. list_del_init(&bpage->list);
  1392. free_buffer_page(bpage);
  1393. }
  1394. }
  1395. mutex_unlock(&buffer->mutex);
  1396. return err;
  1397. }
  1398. EXPORT_SYMBOL_GPL(ring_buffer_resize);
  1399. void ring_buffer_change_overwrite(struct ring_buffer *buffer, int val)
  1400. {
  1401. mutex_lock(&buffer->mutex);
  1402. if (val)
  1403. buffer->flags |= RB_FL_OVERWRITE;
  1404. else
  1405. buffer->flags &= ~RB_FL_OVERWRITE;
  1406. mutex_unlock(&buffer->mutex);
  1407. }
  1408. EXPORT_SYMBOL_GPL(ring_buffer_change_overwrite);
  1409. static inline void *
  1410. __rb_data_page_index(struct buffer_data_page *bpage, unsigned index)
  1411. {
  1412. return bpage->data + index;
  1413. }
  1414. static inline void *__rb_page_index(struct buffer_page *bpage, unsigned index)
  1415. {
  1416. return bpage->page->data + index;
  1417. }
  1418. static inline struct ring_buffer_event *
  1419. rb_reader_event(struct ring_buffer_per_cpu *cpu_buffer)
  1420. {
  1421. return __rb_page_index(cpu_buffer->reader_page,
  1422. cpu_buffer->reader_page->read);
  1423. }
  1424. static inline struct ring_buffer_event *
  1425. rb_iter_head_event(struct ring_buffer_iter *iter)
  1426. {
  1427. return __rb_page_index(iter->head_page, iter->head);
  1428. }
  1429. static inline unsigned rb_page_commit(struct buffer_page *bpage)
  1430. {
  1431. return local_read(&bpage->page->commit);
  1432. }
  1433. /* Size is determined by what has been committed */
  1434. static inline unsigned rb_page_size(struct buffer_page *bpage)
  1435. {
  1436. return rb_page_commit(bpage);
  1437. }
  1438. static inline unsigned
  1439. rb_commit_index(struct ring_buffer_per_cpu *cpu_buffer)
  1440. {
  1441. return rb_page_commit(cpu_buffer->commit_page);
  1442. }
  1443. static inline unsigned
  1444. rb_event_index(struct ring_buffer_event *event)
  1445. {
  1446. unsigned long addr = (unsigned long)event;
  1447. return (addr & ~PAGE_MASK) - BUF_PAGE_HDR_SIZE;
  1448. }
  1449. static inline int
  1450. rb_event_is_commit(struct ring_buffer_per_cpu *cpu_buffer,
  1451. struct ring_buffer_event *event)
  1452. {
  1453. unsigned long addr = (unsigned long)event;
  1454. unsigned long index;
  1455. index = rb_event_index(event);
  1456. addr &= PAGE_MASK;
  1457. return cpu_buffer->commit_page->page == (void *)addr &&
  1458. rb_commit_index(cpu_buffer) == index;
  1459. }
  1460. static void
  1461. rb_set_commit_to_write(struct ring_buffer_per_cpu *cpu_buffer)
  1462. {
  1463. unsigned long max_count;
  1464. /*
  1465. * We only race with interrupts and NMIs on this CPU.
  1466. * If we own the commit event, then we can commit
  1467. * all others that interrupted us, since the interruptions
  1468. * are in stack format (they finish before they come
  1469. * back to us). This allows us to do a simple loop to
  1470. * assign the commit to the tail.
  1471. */
  1472. again:
  1473. max_count = cpu_buffer->nr_pages * 100;
  1474. while (cpu_buffer->commit_page != cpu_buffer->tail_page) {
  1475. if (RB_WARN_ON(cpu_buffer, !(--max_count)))
  1476. return;
  1477. if (RB_WARN_ON(cpu_buffer,
  1478. rb_is_reader_page(cpu_buffer->tail_page)))
  1479. return;
  1480. local_set(&cpu_buffer->commit_page->page->commit,
  1481. rb_page_write(cpu_buffer->commit_page));
  1482. rb_inc_page(cpu_buffer, &cpu_buffer->commit_page);
  1483. cpu_buffer->write_stamp =
  1484. cpu_buffer->commit_page->page->time_stamp;
  1485. /* add barrier to keep gcc from optimizing too much */
  1486. barrier();
  1487. }
  1488. while (rb_commit_index(cpu_buffer) !=
  1489. rb_page_write(cpu_buffer->commit_page)) {
  1490. local_set(&cpu_buffer->commit_page->page->commit,
  1491. rb_page_write(cpu_buffer->commit_page));
  1492. RB_WARN_ON(cpu_buffer,
  1493. local_read(&cpu_buffer->commit_page->page->commit) &
  1494. ~RB_WRITE_MASK);
  1495. barrier();
  1496. }
  1497. /* again, keep gcc from optimizing */
  1498. barrier();
  1499. /*
  1500. * If an interrupt came in just after the first while loop
  1501. * and pushed the tail page forward, we will be left with
  1502. * a dangling commit that will never go forward.
  1503. */
  1504. if (unlikely(cpu_buffer->commit_page != cpu_buffer->tail_page))
  1505. goto again;
  1506. }
  1507. static void rb_reset_reader_page(struct ring_buffer_per_cpu *cpu_buffer)
  1508. {
  1509. cpu_buffer->read_stamp = cpu_buffer->reader_page->page->time_stamp;
  1510. cpu_buffer->reader_page->read = 0;
  1511. }
  1512. static void rb_inc_iter(struct ring_buffer_iter *iter)
  1513. {
  1514. struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;
  1515. /*
  1516. * The iterator could be on the reader page (it starts there).
  1517. * But the head could have moved, since the reader was
  1518. * found. Check for this case and assign the iterator
  1519. * to the head page instead of next.
  1520. */
  1521. if (iter->head_page == cpu_buffer->reader_page)
  1522. iter->head_page = rb_set_head_page(cpu_buffer);
  1523. else
  1524. rb_inc_page(cpu_buffer, &iter->head_page);
  1525. iter->read_stamp = iter->head_page->page->time_stamp;
  1526. iter->head = 0;
  1527. }
  1528. /* Slow path, do not inline */
  1529. static noinline struct ring_buffer_event *
  1530. rb_add_time_stamp(struct ring_buffer_event *event, u64 delta)
  1531. {
  1532. event->type_len = RINGBUF_TYPE_TIME_EXTEND;
  1533. /* Not the first event on the page? */
  1534. if (rb_event_index(event)) {
  1535. event->time_delta = delta & TS_MASK;
  1536. event->array[0] = delta >> TS_SHIFT;
  1537. } else {
  1538. /* nope, just zero it */
  1539. event->time_delta = 0;
  1540. event->array[0] = 0;
  1541. }
  1542. return skip_time_extend(event);
  1543. }
  1544. /**
  1545. * ring_buffer_update_event - update event type and data
  1546. * @event: the even to update
  1547. * @type: the type of event
  1548. * @length: the size of the event field in the ring buffer
  1549. *
  1550. * Update the type and data fields of the event. The length
  1551. * is the actual size that is written to the ring buffer,
  1552. * and with this, we can determine what to place into the
  1553. * data field.
  1554. */
  1555. static void
  1556. rb_update_event(struct ring_buffer_per_cpu *cpu_buffer,
  1557. struct ring_buffer_event *event, unsigned length,
  1558. int add_timestamp, u64 delta)
  1559. {
  1560. /* Only a commit updates the timestamp */
  1561. if (unlikely(!rb_event_is_commit(cpu_buffer, event)))
  1562. delta = 0;
  1563. /*
  1564. * If we need to add a timestamp, then we
  1565. * add it to the start of the resevered space.
  1566. */
  1567. if (unlikely(add_timestamp)) {
  1568. event = rb_add_time_stamp(event, delta);
  1569. length -= RB_LEN_TIME_EXTEND;
  1570. delta = 0;
  1571. }
  1572. event->time_delta = delta;
  1573. length -= RB_EVNT_HDR_SIZE;
  1574. if (length > RB_MAX_SMALL_DATA || RB_FORCE_8BYTE_ALIGNMENT) {
  1575. event->type_len = 0;
  1576. event->array[0] = length;
  1577. } else
  1578. event->type_len = DIV_ROUND_UP(length, RB_ALIGNMENT);
  1579. }
  1580. /*
  1581. * rb_handle_head_page - writer hit the head page
  1582. *
  1583. * Returns: +1 to retry page
  1584. * 0 to continue
  1585. * -1 on error
  1586. */
  1587. static int
  1588. rb_handle_head_page(struct ring_buffer_per_cpu *cpu_buffer,
  1589. struct buffer_page *tail_page,
  1590. struct buffer_page *next_page)
  1591. {
  1592. struct buffer_page *new_head;
  1593. int entries;
  1594. int type;
  1595. int ret;
  1596. entries = rb_page_entries(next_page);
  1597. /*
  1598. * The hard part is here. We need to move the head
  1599. * forward, and protect against both readers on
  1600. * other CPUs and writers coming in via interrupts.
  1601. */
  1602. type = rb_head_page_set_update(cpu_buffer, next_page, tail_page,
  1603. RB_PAGE_HEAD);
  1604. /*
  1605. * type can be one of four:
  1606. * NORMAL - an interrupt already moved it for us
  1607. * HEAD - we are the first to get here.
  1608. * UPDATE - we are the interrupt interrupting
  1609. * a current move.
  1610. * MOVED - a reader on another CPU moved the next
  1611. * pointer to its reader page. Give up
  1612. * and try again.
  1613. */
  1614. switch (type) {
  1615. case RB_PAGE_HEAD:
  1616. /*
  1617. * We changed the head to UPDATE, thus
  1618. * it is our responsibility to update
  1619. * the counters.
  1620. */
  1621. local_add(entries, &cpu_buffer->overrun);
  1622. local_sub(BUF_PAGE_SIZE, &cpu_buffer->entries_bytes);
  1623. /*
  1624. * The entries will be zeroed out when we move the
  1625. * tail page.
  1626. */
  1627. /* still more to do */
  1628. break;
  1629. case RB_PAGE_UPDATE:
  1630. /*
  1631. * This is an interrupt that interrupt the
  1632. * previous update. Still more to do.
  1633. */
  1634. break;
  1635. case RB_PAGE_NORMAL:
  1636. /*
  1637. * An interrupt came in before the update
  1638. * and processed this for us.
  1639. * Nothing left to do.
  1640. */
  1641. return 1;
  1642. case RB_PAGE_MOVED:
  1643. /*
  1644. * The reader is on another CPU and just did
  1645. * a swap with our next_page.
  1646. * Try again.
  1647. */
  1648. return 1;
  1649. default:
  1650. RB_WARN_ON(cpu_buffer, 1); /* WTF??? */
  1651. return -1;
  1652. }
  1653. /*
  1654. * Now that we are here, the old head pointer is
  1655. * set to UPDATE. This will keep the reader from
  1656. * swapping the head page with the reader page.
  1657. * The reader (on another CPU) will spin till
  1658. * we are finished.
  1659. *
  1660. * We just need to protect against interrupts
  1661. * doing the job. We will set the next pointer
  1662. * to HEAD. After that, we set the old pointer
  1663. * to NORMAL, but only if it was HEAD before.
  1664. * otherwise we are an interrupt, and only
  1665. * want the outer most commit to reset it.
  1666. */
  1667. new_head = next_page;
  1668. rb_inc_page(cpu_buffer, &new_head);
  1669. ret = rb_head_page_set_head(cpu_buffer, new_head, next_page,
  1670. RB_PAGE_NORMAL);
  1671. /*
  1672. * Valid returns are:
  1673. * HEAD - an interrupt came in and already set it.
  1674. * NORMAL - One of two things:
  1675. * 1) We really set it.
  1676. * 2) A bunch of interrupts came in and moved
  1677. * the page forward again.
  1678. */
  1679. switch (ret) {
  1680. case RB_PAGE_HEAD:
  1681. case RB_PAGE_NORMAL:
  1682. /* OK */
  1683. break;
  1684. default:
  1685. RB_WARN_ON(cpu_buffer, 1);
  1686. return -1;
  1687. }
  1688. /*
  1689. * It is possible that an interrupt came in,
  1690. * set the head up, then more interrupts came in
  1691. * and moved it again. When we get back here,
  1692. * the page would have been set to NORMAL but we
  1693. * just set it back to HEAD.
  1694. *
  1695. * How do you detect this? Well, if that happened
  1696. * the tail page would have moved.
  1697. */
  1698. if (ret == RB_PAGE_NORMAL) {
  1699. /*
  1700. * If the tail had moved passed next, then we need
  1701. * to reset the pointer.
  1702. */
  1703. if (cpu_buffer->tail_page != tail_page &&
  1704. cpu_buffer->tail_page != next_page)
  1705. rb_head_page_set_normal(cpu_buffer, new_head,
  1706. next_page,
  1707. RB_PAGE_HEAD);
  1708. }
  1709. /*
  1710. * If this was the outer most commit (the one that
  1711. * changed the original pointer from HEAD to UPDATE),
  1712. * then it is up to us to reset it to NORMAL.
  1713. */
  1714. if (type == RB_PAGE_HEAD) {
  1715. ret = rb_head_page_set_normal(cpu_buffer, next_page,
  1716. tail_page,
  1717. RB_PAGE_UPDATE);
  1718. if (RB_WARN_ON(cpu_buffer,
  1719. ret != RB_PAGE_UPDATE))
  1720. return -1;
  1721. }
  1722. return 0;
  1723. }
  1724. static unsigned rb_calculate_event_length(unsigned length)
  1725. {
  1726. struct ring_buffer_event event; /* Used only for sizeof array */
  1727. /* zero length can cause confusions */
  1728. if (!length)
  1729. length = 1;
  1730. if (length > RB_MAX_SMALL_DATA || RB_FORCE_8BYTE_ALIGNMENT)
  1731. length += sizeof(event.array[0]);
  1732. length += RB_EVNT_HDR_SIZE;
  1733. length = ALIGN(length, RB_ARCH_ALIGNMENT);
  1734. return length;
  1735. }
  1736. static inline void
  1737. rb_reset_tail(struct ring_buffer_per_cpu *cpu_buffer,
  1738. struct buffer_page *tail_page,
  1739. unsigned long tail, unsigned long length)
  1740. {
  1741. struct ring_buffer_event *event;
  1742. /*
  1743. * Only the event that crossed the page boundary
  1744. * must fill the old tail_page with padding.
  1745. */
  1746. if (tail >= BUF_PAGE_SIZE) {
  1747. /*
  1748. * If the page was filled, then we still need
  1749. * to update the real_end. Reset it to zero
  1750. * and the reader will ignore it.
  1751. */
  1752. if (tail == BUF_PAGE_SIZE)
  1753. tail_page->real_end = 0;
  1754. local_sub(length, &tail_page->write);
  1755. return;
  1756. }
  1757. event = __rb_page_index(tail_page, tail);
  1758. kmemcheck_annotate_bitfield(event, bitfield);
  1759. /* account for padding bytes */
  1760. local_add(BUF_PAGE_SIZE - tail, &cpu_buffer->entries_bytes);
  1761. /*
  1762. * Save the original length to the meta data.
  1763. * This will be used by the reader to add lost event
  1764. * counter.
  1765. */
  1766. tail_page->real_end = tail;
  1767. /*
  1768. * If this event is bigger than the minimum size, then
  1769. * we need to be careful that we don't subtract the
  1770. * write counter enough to allow another writer to slip
  1771. * in on this page.
  1772. * We put in a discarded commit instead, to make sure
  1773. * that this space is not used again.
  1774. *
  1775. * If we are less than the minimum size, we don't need to
  1776. * worry about it.
  1777. */
  1778. if (tail > (BUF_PAGE_SIZE - RB_EVNT_MIN_SIZE)) {
  1779. /* No room for any events */
  1780. /* Mark the rest of the page with padding */
  1781. rb_event_set_padding(event);
  1782. /* Set the write back to the previous setting */
  1783. local_sub(length, &tail_page->write);
  1784. return;
  1785. }
  1786. /* Put in a discarded event */
  1787. event->array[0] = (BUF_PAGE_SIZE - tail) - RB_EVNT_HDR_SIZE;
  1788. event->type_len = RINGBUF_TYPE_PADDING;
  1789. /* time delta must be non zero */
  1790. event->time_delta = 1;
  1791. /* Set write to end of buffer */
  1792. length = (tail + length) - BUF_PAGE_SIZE;
  1793. local_sub(length, &tail_page->write);
  1794. }
  1795. /*
  1796. * This is the slow path, force gcc not to inline it.
  1797. */
  1798. static noinline struct ring_buffer_event *
  1799. rb_move_tail(struct ring_buffer_per_cpu *cpu_buffer,
  1800. unsigned long length, unsigned long tail,
  1801. struct buffer_page *tail_page, u64 ts)
  1802. {
  1803. struct buffer_page *commit_page = cpu_buffer->commit_page;
  1804. struct ring_buffer *buffer = cpu_buffer->buffer;
  1805. struct buffer_page *next_page;
  1806. int ret;
  1807. next_page = tail_page;
  1808. rb_inc_page(cpu_buffer, &next_page);
  1809. /*
  1810. * If for some reason, we had an interrupt storm that made
  1811. * it all the way around the buffer, bail, and warn
  1812. * about it.
  1813. */
  1814. if (unlikely(next_page == commit_page)) {
  1815. local_inc(&cpu_buffer->commit_overrun);
  1816. goto out_reset;
  1817. }
  1818. /*
  1819. * This is where the fun begins!
  1820. *
  1821. * We are fighting against races between a reader that
  1822. * could be on another CPU trying to swap its reader
  1823. * page with the buffer head.
  1824. *
  1825. * We are also fighting against interrupts coming in and
  1826. * moving the head or tail on us as well.
  1827. *
  1828. * If the next page is the head page then we have filled
  1829. * the buffer, unless the commit page is still on the
  1830. * reader page.
  1831. */
  1832. if (rb_is_head_page(cpu_buffer, next_page, &tail_page->list)) {
  1833. /*
  1834. * If the commit is not on the reader page, then
  1835. * move the header page.
  1836. */
  1837. if (!rb_is_reader_page(cpu_buffer->commit_page)) {
  1838. /*
  1839. * If we are not in overwrite mode,
  1840. * this is easy, just stop here.
  1841. */
  1842. if (!(buffer->flags & RB_FL_OVERWRITE))
  1843. goto out_reset;
  1844. ret = rb_handle_head_page(cpu_buffer,
  1845. tail_page,
  1846. next_page);
  1847. if (ret < 0)
  1848. goto out_reset;
  1849. if (ret)
  1850. goto out_again;
  1851. } else {
  1852. /*
  1853. * We need to be careful here too. The
  1854. * commit page could still be on the reader
  1855. * page. We could have a small buffer, and
  1856. * have filled up the buffer with events
  1857. * from interrupts and such, and wrapped.
  1858. *
  1859. * Note, if the tail page is also the on the
  1860. * reader_page, we let it move out.
  1861. */
  1862. if (unlikely((cpu_buffer->commit_page !=
  1863. cpu_buffer->tail_page) &&
  1864. (cpu_buffer->commit_page ==
  1865. cpu_buffer->reader_page))) {
  1866. local_inc(&cpu_buffer->commit_overrun);
  1867. goto out_reset;
  1868. }
  1869. }
  1870. }
  1871. ret = rb_tail_page_update(cpu_buffer, tail_page, next_page);
  1872. if (ret) {
  1873. /*
  1874. * Nested commits always have zero deltas, so
  1875. * just reread the time stamp
  1876. */
  1877. ts = rb_time_stamp(buffer);
  1878. next_page->page->time_stamp = ts;
  1879. }
  1880. out_again:
  1881. rb_reset_tail(cpu_buffer, tail_page, tail, length);
  1882. /* fail and let the caller try again */
  1883. return ERR_PTR(-EAGAIN);
  1884. out_reset:
  1885. /* reset write */
  1886. rb_reset_tail(cpu_buffer, tail_page, tail, length);
  1887. return NULL;
  1888. }
  1889. static struct ring_buffer_event *
  1890. __rb_reserve_next(struct ring_buffer_per_cpu *cpu_buffer,
  1891. unsigned long length, u64 ts,
  1892. u64 delta, int add_timestamp)
  1893. {
  1894. struct buffer_page *tail_page;
  1895. struct ring_buffer_event *event;
  1896. unsigned long tail, write;
  1897. /*
  1898. * If the time delta since the last event is too big to
  1899. * hold in the time field of the event, then we append a
  1900. * TIME EXTEND event ahead of the data event.
  1901. */
  1902. if (unlikely(add_timestamp))
  1903. length += RB_LEN_TIME_EXTEND;
  1904. tail_page = cpu_buffer->tail_page;
  1905. write = local_add_return(length, &tail_page->write);
  1906. /* set write to only the index of the write */
  1907. write &= RB_WRITE_MASK;
  1908. tail = write - length;
  1909. /* See if we shot pass the end of this buffer page */
  1910. if (unlikely(write > BUF_PAGE_SIZE))
  1911. return rb_move_tail(cpu_buffer, length, tail,
  1912. tail_page, ts);
  1913. /* We reserved something on the buffer */
  1914. event = __rb_page_index(tail_page, tail);
  1915. kmemcheck_annotate_bitfield(event, bitfield);
  1916. rb_update_event(cpu_buffer, event, length, add_timestamp, delta);
  1917. local_inc(&tail_page->entries);
  1918. /*
  1919. * If this is the first commit on the page, then update
  1920. * its timestamp.
  1921. */
  1922. if (!tail)
  1923. tail_page->page->time_stamp = ts;
  1924. /* account for these added bytes */
  1925. local_add(length, &cpu_buffer->entries_bytes);
  1926. return event;
  1927. }
  1928. static inline int
  1929. rb_try_to_discard(struct ring_buffer_per_cpu *cpu_buffer,
  1930. struct ring_buffer_event *event)
  1931. {
  1932. unsigned long new_index, old_index;
  1933. struct buffer_page *bpage;
  1934. unsigned long index;
  1935. unsigned long addr;
  1936. new_index = rb_event_index(event);
  1937. old_index = new_index + rb_event_ts_length(event);
  1938. addr = (unsigned long)event;
  1939. addr &= PAGE_MASK;
  1940. bpage = cpu_buffer->tail_page;
  1941. if (bpage->page == (void *)addr && rb_page_write(bpage) == old_index) {
  1942. unsigned long write_mask =
  1943. local_read(&bpage->write) & ~RB_WRITE_MASK;
  1944. unsigned long event_length = rb_event_length(event);
  1945. /*
  1946. * This is on the tail page. It is possible that
  1947. * a write could come in and move the tail page
  1948. * and write to the next page. That is fine
  1949. * because we just shorten what is on this page.
  1950. */
  1951. old_index += write_mask;
  1952. new_index += write_mask;
  1953. index = local_cmpxchg(&bpage->write, old_index, new_index);
  1954. if (index == old_index) {
  1955. /* update counters */
  1956. local_sub(event_length, &cpu_buffer->entries_bytes);
  1957. return 1;
  1958. }
  1959. }
  1960. /* could not discard */
  1961. return 0;
  1962. }
  1963. static void rb_start_commit(struct ring_buffer_per_cpu *cpu_buffer)
  1964. {
  1965. local_inc(&cpu_buffer->committing);
  1966. local_inc(&cpu_buffer->commits);
  1967. }
  1968. static inline void rb_end_commit(struct ring_buffer_per_cpu *cpu_buffer)
  1969. {
  1970. unsigned long commits;
  1971. if (RB_WARN_ON(cpu_buffer,
  1972. !local_read(&cpu_buffer->committing)))
  1973. return;
  1974. again:
  1975. commits = local_read(&cpu_buffer->commits);
  1976. /* synchronize with interrupts */
  1977. barrier();
  1978. if (local_read(&cpu_buffer->committing) == 1)
  1979. rb_set_commit_to_write(cpu_buffer);
  1980. local_dec(&cpu_buffer->committing);
  1981. /* synchronize with interrupts */
  1982. barrier();
  1983. /*
  1984. * Need to account for interrupts coming in between the
  1985. * updating of the commit page and the clearing of the
  1986. * committing counter.
  1987. */
  1988. if (unlikely(local_read(&cpu_buffer->commits) != commits) &&
  1989. !local_read(&cpu_buffer->committing)) {
  1990. local_inc(&cpu_buffer->committing);
  1991. goto again;
  1992. }
  1993. }
  1994. static struct ring_buffer_event *
  1995. rb_reserve_next_event(struct ring_buffer *buffer,
  1996. struct ring_buffer_per_cpu *cpu_buffer,
  1997. unsigned long length)
  1998. {
  1999. struct ring_buffer_event *event;
  2000. u64 ts, delta;
  2001. int nr_loops = 0;
  2002. int add_timestamp;
  2003. u64 diff;
  2004. rb_start_commit(cpu_buffer);
  2005. #ifdef CONFIG_RING_BUFFER_ALLOW_SWAP
  2006. /*
  2007. * Due to the ability to swap a cpu buffer from a buffer
  2008. * it is possible it was swapped before we committed.
  2009. * (committing stops a swap). We check for it here and
  2010. * if it happened, we have to fail the write.
  2011. */
  2012. barrier();
  2013. if (unlikely(ACCESS_ONCE(cpu_buffer->buffer) != buffer)) {
  2014. local_dec(&cpu_buffer->committing);
  2015. local_dec(&cpu_buffer->commits);
  2016. return NULL;
  2017. }
  2018. #endif
  2019. length = rb_calculate_event_length(length);
  2020. again:
  2021. add_timestamp = 0;
  2022. delta = 0;
  2023. /*
  2024. * We allow for interrupts to reenter here and do a trace.
  2025. * If one does, it will cause this original code to loop
  2026. * back here. Even with heavy interrupts happening, this
  2027. * should only happen a few times in a row. If this happens
  2028. * 1000 times in a row, there must be either an interrupt
  2029. * storm or we have something buggy.
  2030. * Bail!
  2031. */
  2032. if (RB_WARN_ON(cpu_buffer, ++nr_loops > 1000))
  2033. goto out_fail;
  2034. ts = rb_time_stamp(cpu_buffer->buffer);
  2035. diff = ts - cpu_buffer->write_stamp;
  2036. /* make sure this diff is calculated here */
  2037. barrier();
  2038. /* Did the write stamp get updated already? */
  2039. if (likely(ts >= cpu_buffer->write_stamp)) {
  2040. delta = diff;
  2041. if (unlikely(test_time_stamp(delta))) {
  2042. int local_clock_stable = 1;
  2043. #ifdef CONFIG_HAVE_UNSTABLE_SCHED_CLOCK
  2044. local_clock_stable = sched_clock_stable;
  2045. #endif
  2046. WARN_ONCE(delta > (1ULL << 59),
  2047. KERN_WARNING "Delta way too big! %llu ts=%llu write stamp = %llu\n%s",
  2048. (unsigned long long)delta,
  2049. (unsigned long long)ts,
  2050. (unsigned long long)cpu_buffer->write_stamp,
  2051. local_clock_stable ? "" :
  2052. "If you just came from a suspend/resume,\n"
  2053. "please switch to the trace global clock:\n"
  2054. " echo global > /sys/kernel/debug/tracing/trace_clock\n");
  2055. add_timestamp = 1;
  2056. }
  2057. }
  2058. event = __rb_reserve_next(cpu_buffer, length, ts,
  2059. delta, add_timestamp);
  2060. if (unlikely(PTR_ERR(event) == -EAGAIN))
  2061. goto again;
  2062. if (!event)
  2063. goto out_fail;
  2064. return event;
  2065. out_fail:
  2066. rb_end_commit(cpu_buffer);
  2067. return NULL;
  2068. }
  2069. #ifdef CONFIG_TRACING
  2070. #define TRACE_RECURSIVE_DEPTH 16
  2071. /* Keep this code out of the fast path cache */
  2072. static noinline void trace_recursive_fail(void)
  2073. {
  2074. /* Disable all tracing before we do anything else */
  2075. tracing_off_permanent();
  2076. printk_once(KERN_WARNING "Tracing recursion: depth[%ld]:"
  2077. "HC[%lu]:SC[%lu]:NMI[%lu]\n",
  2078. trace_recursion_buffer(),
  2079. hardirq_count() >> HARDIRQ_SHIFT,
  2080. softirq_count() >> SOFTIRQ_SHIFT,
  2081. in_nmi());
  2082. WARN_ON_ONCE(1);
  2083. }
  2084. static inline int trace_recursive_lock(void)
  2085. {
  2086. trace_recursion_inc();
  2087. if (likely(trace_recursion_buffer() < TRACE_RECURSIVE_DEPTH))
  2088. return 0;
  2089. trace_recursive_fail();
  2090. return -1;
  2091. }
  2092. static inline void trace_recursive_unlock(void)
  2093. {
  2094. WARN_ON_ONCE(!trace_recursion_buffer());
  2095. trace_recursion_dec();
  2096. }
  2097. #else
  2098. #define trace_recursive_lock() (0)
  2099. #define trace_recursive_unlock() do { } while (0)
  2100. #endif
  2101. /**
  2102. * ring_buffer_lock_reserve - reserve a part of the buffer
  2103. * @buffer: the ring buffer to reserve from
  2104. * @length: the length of the data to reserve (excluding event header)
  2105. *
  2106. * Returns a reseverd event on the ring buffer to copy directly to.
  2107. * The user of this interface will need to get the body to write into
  2108. * and can use the ring_buffer_event_data() interface.
  2109. *
  2110. * The length is the length of the data needed, not the event length
  2111. * which also includes the event header.
  2112. *
  2113. * Must be paired with ring_buffer_unlock_commit, unless NULL is returned.
  2114. * If NULL is returned, then nothing has been allocated or locked.
  2115. */
  2116. struct ring_buffer_event *
  2117. ring_buffer_lock_reserve(struct ring_buffer *buffer, unsigned long length)
  2118. {
  2119. struct ring_buffer_per_cpu *cpu_buffer;
  2120. struct ring_buffer_event *event;
  2121. int cpu;
  2122. if (ring_buffer_flags != RB_BUFFERS_ON)
  2123. return NULL;
  2124. /* If we are tracing schedule, we don't want to recurse */
  2125. preempt_disable_notrace();
  2126. if (atomic_read(&buffer->record_disabled))
  2127. goto out_nocheck;
  2128. if (trace_recursive_lock())
  2129. goto out_nocheck;
  2130. cpu = raw_smp_processor_id();
  2131. if (!cpumask_test_cpu(cpu, buffer->cpumask))
  2132. goto out;
  2133. cpu_buffer = buffer->buffers[cpu];
  2134. if (atomic_read(&cpu_buffer->record_disabled))
  2135. goto out;
  2136. if (length > BUF_MAX_DATA_SIZE)
  2137. goto out;
  2138. event = rb_reserve_next_event(buffer, cpu_buffer, length);
  2139. if (!event)
  2140. goto out;
  2141. return event;
  2142. out:
  2143. trace_recursive_unlock();
  2144. out_nocheck:
  2145. preempt_enable_notrace();
  2146. return NULL;
  2147. }
  2148. EXPORT_SYMBOL_GPL(ring_buffer_lock_reserve);
  2149. static void
  2150. rb_update_write_stamp(struct ring_buffer_per_cpu *cpu_buffer,
  2151. struct ring_buffer_event *event)
  2152. {
  2153. u64 delta;
  2154. /*
  2155. * The event first in the commit queue updates the
  2156. * time stamp.
  2157. */
  2158. if (rb_event_is_commit(cpu_buffer, event)) {
  2159. /*
  2160. * A commit event that is first on a page
  2161. * updates the write timestamp with the page stamp
  2162. */
  2163. if (!rb_event_index(event))
  2164. cpu_buffer->write_stamp =
  2165. cpu_buffer->commit_page->page->time_stamp;
  2166. else if (event->type_len == RINGBUF_TYPE_TIME_EXTEND) {
  2167. delta = event->array[0];
  2168. delta <<= TS_SHIFT;
  2169. delta += event->time_delta;
  2170. cpu_buffer->write_stamp += delta;
  2171. } else
  2172. cpu_buffer->write_stamp += event->time_delta;
  2173. }
  2174. }
  2175. static void rb_commit(struct ring_buffer_per_cpu *cpu_buffer,
  2176. struct ring_buffer_event *event)
  2177. {
  2178. local_inc(&cpu_buffer->entries);
  2179. rb_update_write_stamp(cpu_buffer, event);
  2180. rb_end_commit(cpu_buffer);
  2181. }
  2182. /**
  2183. * ring_buffer_unlock_commit - commit a reserved
  2184. * @buffer: The buffer to commit to
  2185. * @event: The event pointer to commit.
  2186. *
  2187. * This commits the data to the ring buffer, and releases any locks held.
  2188. *
  2189. * Must be paired with ring_buffer_lock_reserve.
  2190. */
  2191. int ring_buffer_unlock_commit(struct ring_buffer *buffer,
  2192. struct ring_buffer_event *event)
  2193. {
  2194. struct ring_buffer_per_cpu *cpu_buffer;
  2195. int cpu = raw_smp_processor_id();
  2196. cpu_buffer = buffer->buffers[cpu];
  2197. rb_commit(cpu_buffer, event);
  2198. trace_recursive_unlock();
  2199. preempt_enable_notrace();
  2200. return 0;
  2201. }
  2202. EXPORT_SYMBOL_GPL(ring_buffer_unlock_commit);
  2203. static inline void rb_event_discard(struct ring_buffer_event *event)
  2204. {
  2205. if (event->type_len == RINGBUF_TYPE_TIME_EXTEND)
  2206. event = skip_time_extend(event);
  2207. /* array[0] holds the actual length for the discarded event */
  2208. event->array[0] = rb_event_data_length(event) - RB_EVNT_HDR_SIZE;
  2209. event->type_len = RINGBUF_TYPE_PADDING;
  2210. /* time delta must be non zero */
  2211. if (!event->time_delta)
  2212. event->time_delta = 1;
  2213. }
  2214. /*
  2215. * Decrement the entries to the page that an event is on.
  2216. * The event does not even need to exist, only the pointer
  2217. * to the page it is on. This may only be called before the commit
  2218. * takes place.
  2219. */
  2220. static inline void
  2221. rb_decrement_entry(struct ring_buffer_per_cpu *cpu_buffer,
  2222. struct ring_buffer_event *event)
  2223. {
  2224. unsigned long addr = (unsigned long)event;
  2225. struct buffer_page *bpage = cpu_buffer->commit_page;
  2226. struct buffer_page *start;
  2227. addr &= PAGE_MASK;
  2228. /* Do the likely case first */
  2229. if (likely(bpage->page == (void *)addr)) {
  2230. local_dec(&bpage->entries);
  2231. return;
  2232. }
  2233. /*
  2234. * Because the commit page may be on the reader page we
  2235. * start with the next page and check the end loop there.
  2236. */
  2237. rb_inc_page(cpu_buffer, &bpage);
  2238. start = bpage;
  2239. do {
  2240. if (bpage->page == (void *)addr) {
  2241. local_dec(&bpage->entries);
  2242. return;
  2243. }
  2244. rb_inc_page(cpu_buffer, &bpage);
  2245. } while (bpage != start);
  2246. /* commit not part of this buffer?? */
  2247. RB_WARN_ON(cpu_buffer, 1);
  2248. }
  2249. /**
  2250. * ring_buffer_commit_discard - discard an event that has not been committed
  2251. * @buffer: the ring buffer
  2252. * @event: non committed event to discard
  2253. *
  2254. * Sometimes an event that is in the ring buffer needs to be ignored.
  2255. * This function lets the user discard an event in the ring buffer
  2256. * and then that event will not be read later.
  2257. *
  2258. * This function only works if it is called before the the item has been
  2259. * committed. It will try to free the event from the ring buffer
  2260. * if another event has not been added behind it.
  2261. *
  2262. * If another event has been added behind it, it will set the event
  2263. * up as discarded, and perform the commit.
  2264. *
  2265. * If this function is called, do not call ring_buffer_unlock_commit on
  2266. * the event.
  2267. */
  2268. void ring_buffer_discard_commit(struct ring_buffer *buffer,
  2269. struct ring_buffer_event *event)
  2270. {
  2271. struct ring_buffer_per_cpu *cpu_buffer;
  2272. int cpu;
  2273. /* The event is discarded regardless */
  2274. rb_event_discard(event);
  2275. cpu = smp_processor_id();
  2276. cpu_buffer = buffer->buffers[cpu];
  2277. /*
  2278. * This must only be called if the event has not been
  2279. * committed yet. Thus we can assume that preemption
  2280. * is still disabled.
  2281. */
  2282. RB_WARN_ON(buffer, !local_read(&cpu_buffer->committing));
  2283. rb_decrement_entry(cpu_buffer, event);
  2284. if (rb_try_to_discard(cpu_buffer, event))
  2285. goto out;
  2286. /*
  2287. * The commit is still visible by the reader, so we
  2288. * must still update the timestamp.
  2289. */
  2290. rb_update_write_stamp(cpu_buffer, event);
  2291. out:
  2292. rb_end_commit(cpu_buffer);
  2293. trace_recursive_unlock();
  2294. preempt_enable_notrace();
  2295. }
  2296. EXPORT_SYMBOL_GPL(ring_buffer_discard_commit);
  2297. /**
  2298. * ring_buffer_write - write data to the buffer without reserving
  2299. * @buffer: The ring buffer to write to.
  2300. * @length: The length of the data being written (excluding the event header)
  2301. * @data: The data to write to the buffer.
  2302. *
  2303. * This is like ring_buffer_lock_reserve and ring_buffer_unlock_commit as
  2304. * one function. If you already have the data to write to the buffer, it
  2305. * may be easier to simply call this function.
  2306. *
  2307. * Note, like ring_buffer_lock_reserve, the length is the length of the data
  2308. * and not the length of the event which would hold the header.
  2309. */
  2310. int ring_buffer_write(struct ring_buffer *buffer,
  2311. unsigned long length,
  2312. void *data)
  2313. {
  2314. struct ring_buffer_per_cpu *cpu_buffer;
  2315. struct ring_buffer_event *event;
  2316. void *body;
  2317. int ret = -EBUSY;
  2318. int cpu;
  2319. if (ring_buffer_flags != RB_BUFFERS_ON)
  2320. return -EBUSY;
  2321. preempt_disable_notrace();
  2322. if (atomic_read(&buffer->record_disabled))
  2323. goto out;
  2324. cpu = raw_smp_processor_id();
  2325. if (!cpumask_test_cpu(cpu, buffer->cpumask))
  2326. goto out;
  2327. cpu_buffer = buffer->buffers[cpu];
  2328. if (atomic_read(&cpu_buffer->record_disabled))
  2329. goto out;
  2330. if (length > BUF_MAX_DATA_SIZE)
  2331. goto out;
  2332. event = rb_reserve_next_event(buffer, cpu_buffer, length);
  2333. if (!event)
  2334. goto out;
  2335. body = rb_event_data(event);
  2336. memcpy(body, data, length);
  2337. rb_commit(cpu_buffer, event);
  2338. ret = 0;
  2339. out:
  2340. preempt_enable_notrace();
  2341. return ret;
  2342. }
  2343. EXPORT_SYMBOL_GPL(ring_buffer_write);
  2344. static int rb_per_cpu_empty(struct ring_buffer_per_cpu *cpu_buffer)
  2345. {
  2346. struct buffer_page *reader = cpu_buffer->reader_page;
  2347. struct buffer_page *head = rb_set_head_page(cpu_buffer);
  2348. struct buffer_page *commit = cpu_buffer->commit_page;
  2349. /* In case of error, head will be NULL */
  2350. if (unlikely(!head))
  2351. return 1;
  2352. return reader->read == rb_page_commit(reader) &&
  2353. (commit == reader ||
  2354. (commit == head &&
  2355. head->read == rb_page_commit(commit)));
  2356. }
  2357. /**
  2358. * ring_buffer_record_disable - stop all writes into the buffer
  2359. * @buffer: The ring buffer to stop writes to.
  2360. *
  2361. * This prevents all writes to the buffer. Any attempt to write
  2362. * to the buffer after this will fail and return NULL.
  2363. *
  2364. * The caller should call synchronize_sched() after this.
  2365. */
  2366. void ring_buffer_record_disable(struct ring_buffer *buffer)
  2367. {
  2368. atomic_inc(&buffer->record_disabled);
  2369. }
  2370. EXPORT_SYMBOL_GPL(ring_buffer_record_disable);
  2371. /**
  2372. * ring_buffer_record_enable - enable writes to the buffer
  2373. * @buffer: The ring buffer to enable writes
  2374. *
  2375. * Note, multiple disables will need the same number of enables
  2376. * to truly enable the writing (much like preempt_disable).
  2377. */
  2378. void ring_buffer_record_enable(struct ring_buffer *buffer)
  2379. {
  2380. atomic_dec(&buffer->record_disabled);
  2381. }
  2382. EXPORT_SYMBOL_GPL(ring_buffer_record_enable);
  2383. /**
  2384. * ring_buffer_record_off - stop all writes into the buffer
  2385. * @buffer: The ring buffer to stop writes to.
  2386. *
  2387. * This prevents all writes to the buffer. Any attempt to write
  2388. * to the buffer after this will fail and return NULL.
  2389. *
  2390. * This is different than ring_buffer_record_disable() as
  2391. * it works like an on/off switch, where as the disable() verison
  2392. * must be paired with a enable().
  2393. */
  2394. void ring_buffer_record_off(struct ring_buffer *buffer)
  2395. {
  2396. unsigned int rd;
  2397. unsigned int new_rd;
  2398. do {
  2399. rd = atomic_read(&buffer->record_disabled);
  2400. new_rd = rd | RB_BUFFER_OFF;
  2401. } while (atomic_cmpxchg(&buffer->record_disabled, rd, new_rd) != rd);
  2402. }
  2403. EXPORT_SYMBOL_GPL(ring_buffer_record_off);
  2404. /**
  2405. * ring_buffer_record_on - restart writes into the buffer
  2406. * @buffer: The ring buffer to start writes to.
  2407. *
  2408. * This enables all writes to the buffer that was disabled by
  2409. * ring_buffer_record_off().
  2410. *
  2411. * This is different than ring_buffer_record_enable() as
  2412. * it works like an on/off switch, where as the enable() verison
  2413. * must be paired with a disable().
  2414. */
  2415. void ring_buffer_record_on(struct ring_buffer *buffer)
  2416. {
  2417. unsigned int rd;
  2418. unsigned int new_rd;
  2419. do {
  2420. rd = atomic_read(&buffer->record_disabled);
  2421. new_rd = rd & ~RB_BUFFER_OFF;
  2422. } while (atomic_cmpxchg(&buffer->record_disabled, rd, new_rd) != rd);
  2423. }
  2424. EXPORT_SYMBOL_GPL(ring_buffer_record_on);
  2425. /**
  2426. * ring_buffer_record_is_on - return true if the ring buffer can write
  2427. * @buffer: The ring buffer to see if write is enabled
  2428. *
  2429. * Returns true if the ring buffer is in a state that it accepts writes.
  2430. */
  2431. int ring_buffer_record_is_on(struct ring_buffer *buffer)
  2432. {
  2433. return !atomic_read(&buffer->record_disabled);
  2434. }
  2435. /**
  2436. * ring_buffer_record_disable_cpu - stop all writes into the cpu_buffer
  2437. * @buffer: The ring buffer to stop writes to.
  2438. * @cpu: The CPU buffer to stop
  2439. *
  2440. * This prevents all writes to the buffer. Any attempt to write
  2441. * to the buffer after this will fail and return NULL.
  2442. *
  2443. * The caller should call synchronize_sched() after this.
  2444. */
  2445. void ring_buffer_record_disable_cpu(struct ring_buffer *buffer, int cpu)
  2446. {
  2447. struct ring_buffer_per_cpu *cpu_buffer;
  2448. if (!cpumask_test_cpu(cpu, buffer->cpumask))
  2449. return;
  2450. cpu_buffer = buffer->buffers[cpu];
  2451. atomic_inc(&cpu_buffer->record_disabled);
  2452. }
  2453. EXPORT_SYMBOL_GPL(ring_buffer_record_disable_cpu);
  2454. /**
  2455. * ring_buffer_record_enable_cpu - enable writes to the buffer
  2456. * @buffer: The ring buffer to enable writes
  2457. * @cpu: The CPU to enable.
  2458. *
  2459. * Note, multiple disables will need the same number of enables
  2460. * to truly enable the writing (much like preempt_disable).
  2461. */
  2462. void ring_buffer_record_enable_cpu(struct ring_buffer *buffer, int cpu)
  2463. {
  2464. struct ring_buffer_per_cpu *cpu_buffer;
  2465. if (!cpumask_test_cpu(cpu, buffer->cpumask))
  2466. return;
  2467. cpu_buffer = buffer->buffers[cpu];
  2468. atomic_dec(&cpu_buffer->record_disabled);
  2469. }
  2470. EXPORT_SYMBOL_GPL(ring_buffer_record_enable_cpu);
  2471. /*
  2472. * The total entries in the ring buffer is the running counter
  2473. * of entries entered into the ring buffer, minus the sum of
  2474. * the entries read from the ring buffer and the number of
  2475. * entries that were overwritten.
  2476. */
  2477. static inline unsigned long
  2478. rb_num_of_entries(struct ring_buffer_per_cpu *cpu_buffer)
  2479. {
  2480. return local_read(&cpu_buffer->entries) -
  2481. (local_read(&cpu_buffer->overrun) + cpu_buffer->read);
  2482. }
  2483. /**
  2484. * ring_buffer_oldest_event_ts - get the oldest event timestamp from the buffer
  2485. * @buffer: The ring buffer
  2486. * @cpu: The per CPU buffer to read from.
  2487. */
  2488. unsigned long ring_buffer_oldest_event_ts(struct ring_buffer *buffer, int cpu)
  2489. {
  2490. unsigned long flags;
  2491. struct ring_buffer_per_cpu *cpu_buffer;
  2492. struct buffer_page *bpage;
  2493. unsigned long ret;
  2494. if (!cpumask_test_cpu(cpu, buffer->cpumask))
  2495. return 0;
  2496. cpu_buffer = buffer->buffers[cpu];
  2497. raw_spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
  2498. /*
  2499. * if the tail is on reader_page, oldest time stamp is on the reader
  2500. * page
  2501. */
  2502. if (cpu_buffer->tail_page == cpu_buffer->reader_page)
  2503. bpage = cpu_buffer->reader_page;
  2504. else
  2505. bpage = rb_set_head_page(cpu_buffer);
  2506. ret = bpage->page->time_stamp;
  2507. raw_spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
  2508. return ret;
  2509. }
  2510. EXPORT_SYMBOL_GPL(ring_buffer_oldest_event_ts);
  2511. /**
  2512. * ring_buffer_bytes_cpu - get the number of bytes consumed in a cpu buffer
  2513. * @buffer: The ring buffer
  2514. * @cpu: The per CPU buffer to read from.
  2515. */
  2516. unsigned long ring_buffer_bytes_cpu(struct ring_buffer *buffer, int cpu)
  2517. {
  2518. struct ring_buffer_per_cpu *cpu_buffer;
  2519. unsigned long ret;
  2520. if (!cpumask_test_cpu(cpu, buffer->cpumask))
  2521. return 0;
  2522. cpu_buffer = buffer->buffers[cpu];
  2523. ret = local_read(&cpu_buffer->entries_bytes) - cpu_buffer->read_bytes;
  2524. return ret;
  2525. }
  2526. EXPORT_SYMBOL_GPL(ring_buffer_bytes_cpu);
  2527. /**
  2528. * ring_buffer_entries_cpu - get the number of entries in a cpu buffer
  2529. * @buffer: The ring buffer
  2530. * @cpu: The per CPU buffer to get the entries from.
  2531. */
  2532. unsigned long ring_buffer_entries_cpu(struct ring_buffer *buffer, int cpu)
  2533. {
  2534. struct ring_buffer_per_cpu *cpu_buffer;
  2535. if (!cpumask_test_cpu(cpu, buffer->cpumask))
  2536. return 0;
  2537. cpu_buffer = buffer->buffers[cpu];
  2538. return rb_num_of_entries(cpu_buffer);
  2539. }
  2540. EXPORT_SYMBOL_GPL(ring_buffer_entries_cpu);
  2541. /**
  2542. * ring_buffer_overrun_cpu - get the number of overruns in a cpu_buffer
  2543. * @buffer: The ring buffer
  2544. * @cpu: The per CPU buffer to get the number of overruns from
  2545. */
  2546. unsigned long ring_buffer_overrun_cpu(struct ring_buffer *buffer, int cpu)
  2547. {
  2548. struct ring_buffer_per_cpu *cpu_buffer;
  2549. unsigned long ret;
  2550. if (!cpumask_test_cpu(cpu, buffer->cpumask))
  2551. return 0;
  2552. cpu_buffer = buffer->buffers[cpu];
  2553. ret = local_read(&cpu_buffer->overrun);
  2554. return ret;
  2555. }
  2556. EXPORT_SYMBOL_GPL(ring_buffer_overrun_cpu);
  2557. /**
  2558. * ring_buffer_commit_overrun_cpu - get the number of overruns caused by commits
  2559. * @buffer: The ring buffer
  2560. * @cpu: The per CPU buffer to get the number of overruns from
  2561. */
  2562. unsigned long
  2563. ring_buffer_commit_overrun_cpu(struct ring_buffer *buffer, int cpu)
  2564. {
  2565. struct ring_buffer_per_cpu *cpu_buffer;
  2566. unsigned long ret;
  2567. if (!cpumask_test_cpu(cpu, buffer->cpumask))
  2568. return 0;
  2569. cpu_buffer = buffer->buffers[cpu];
  2570. ret = local_read(&cpu_buffer->commit_overrun);
  2571. return ret;
  2572. }
  2573. EXPORT_SYMBOL_GPL(ring_buffer_commit_overrun_cpu);
  2574. /**
  2575. * ring_buffer_entries - get the number of entries in a buffer
  2576. * @buffer: The ring buffer
  2577. *
  2578. * Returns the total number of entries in the ring buffer
  2579. * (all CPU entries)
  2580. */
  2581. unsigned long ring_buffer_entries(struct ring_buffer *buffer)
  2582. {
  2583. struct ring_buffer_per_cpu *cpu_buffer;
  2584. unsigned long entries = 0;
  2585. int cpu;
  2586. /* if you care about this being correct, lock the buffer */
  2587. for_each_buffer_cpu(buffer, cpu) {
  2588. cpu_buffer = buffer->buffers[cpu];
  2589. entries += rb_num_of_entries(cpu_buffer);
  2590. }
  2591. return entries;
  2592. }
  2593. EXPORT_SYMBOL_GPL(ring_buffer_entries);
  2594. /**
  2595. * ring_buffer_overruns - get the number of overruns in buffer
  2596. * @buffer: The ring buffer
  2597. *
  2598. * Returns the total number of overruns in the ring buffer
  2599. * (all CPU entries)
  2600. */
  2601. unsigned long ring_buffer_overruns(struct ring_buffer *buffer)
  2602. {
  2603. struct ring_buffer_per_cpu *cpu_buffer;
  2604. unsigned long overruns = 0;
  2605. int cpu;
  2606. /* if you care about this being correct, lock the buffer */
  2607. for_each_buffer_cpu(buffer, cpu) {
  2608. cpu_buffer = buffer->buffers[cpu];
  2609. overruns += local_read(&cpu_buffer->overrun);
  2610. }
  2611. return overruns;
  2612. }
  2613. EXPORT_SYMBOL_GPL(ring_buffer_overruns);
  2614. static void rb_iter_reset(struct ring_buffer_iter *iter)
  2615. {
  2616. struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;
  2617. /* Iterator usage is expected to have record disabled */
  2618. if (list_empty(&cpu_buffer->reader_page->list)) {
  2619. iter->head_page = rb_set_head_page(cpu_buffer);
  2620. if (unlikely(!iter->head_page))
  2621. return;
  2622. iter->head = iter->head_page->read;
  2623. } else {
  2624. iter->head_page = cpu_buffer->reader_page;
  2625. iter->head = cpu_buffer->reader_page->read;
  2626. }
  2627. if (iter->head)
  2628. iter->read_stamp = cpu_buffer->read_stamp;
  2629. else
  2630. iter->read_stamp = iter->head_page->page->time_stamp;
  2631. iter->cache_reader_page = cpu_buffer->reader_page;
  2632. iter->cache_read = cpu_buffer->read;
  2633. }
  2634. /**
  2635. * ring_buffer_iter_reset - reset an iterator
  2636. * @iter: The iterator to reset
  2637. *
  2638. * Resets the iterator, so that it will start from the beginning
  2639. * again.
  2640. */
  2641. void ring_buffer_iter_reset(struct ring_buffer_iter *iter)
  2642. {
  2643. struct ring_buffer_per_cpu *cpu_buffer;
  2644. unsigned long flags;
  2645. if (!iter)
  2646. return;
  2647. cpu_buffer = iter->cpu_buffer;
  2648. raw_spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
  2649. rb_iter_reset(iter);
  2650. raw_spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
  2651. }
  2652. EXPORT_SYMBOL_GPL(ring_buffer_iter_reset);
  2653. /**
  2654. * ring_buffer_iter_empty - check if an iterator has no more to read
  2655. * @iter: The iterator to check
  2656. */
  2657. int ring_buffer_iter_empty(struct ring_buffer_iter *iter)
  2658. {
  2659. struct ring_buffer_per_cpu *cpu_buffer;
  2660. cpu_buffer = iter->cpu_buffer;
  2661. return iter->head_page == cpu_buffer->commit_page &&
  2662. iter->head == rb_commit_index(cpu_buffer);
  2663. }
  2664. EXPORT_SYMBOL_GPL(ring_buffer_iter_empty);
  2665. static void
  2666. rb_update_read_stamp(struct ring_buffer_per_cpu *cpu_buffer,
  2667. struct ring_buffer_event *event)
  2668. {
  2669. u64 delta;
  2670. switch (event->type_len) {
  2671. case RINGBUF_TYPE_PADDING:
  2672. return;
  2673. case RINGBUF_TYPE_TIME_EXTEND:
  2674. delta = event->array[0];
  2675. delta <<= TS_SHIFT;
  2676. delta += event->time_delta;
  2677. cpu_buffer->read_stamp += delta;
  2678. return;
  2679. case RINGBUF_TYPE_TIME_STAMP:
  2680. /* FIXME: not implemented */
  2681. return;
  2682. case RINGBUF_TYPE_DATA:
  2683. cpu_buffer->read_stamp += event->time_delta;
  2684. return;
  2685. default:
  2686. BUG();
  2687. }
  2688. return;
  2689. }
  2690. static void
  2691. rb_update_iter_read_stamp(struct ring_buffer_iter *iter,
  2692. struct ring_buffer_event *event)
  2693. {
  2694. u64 delta;
  2695. switch (event->type_len) {
  2696. case RINGBUF_TYPE_PADDING:
  2697. return;
  2698. case RINGBUF_TYPE_TIME_EXTEND:
  2699. delta = event->array[0];
  2700. delta <<= TS_SHIFT;
  2701. delta += event->time_delta;
  2702. iter->read_stamp += delta;
  2703. return;
  2704. case RINGBUF_TYPE_TIME_STAMP:
  2705. /* FIXME: not implemented */
  2706. return;
  2707. case RINGBUF_TYPE_DATA:
  2708. iter->read_stamp += event->time_delta;
  2709. return;
  2710. default:
  2711. BUG();
  2712. }
  2713. return;
  2714. }
  2715. static struct buffer_page *
  2716. rb_get_reader_page(struct ring_buffer_per_cpu *cpu_buffer)
  2717. {
  2718. struct buffer_page *reader = NULL;
  2719. unsigned long overwrite;
  2720. unsigned long flags;
  2721. int nr_loops = 0;
  2722. int ret;
  2723. local_irq_save(flags);
  2724. arch_spin_lock(&cpu_buffer->lock);
  2725. again:
  2726. /*
  2727. * This should normally only loop twice. But because the
  2728. * start of the reader inserts an empty page, it causes
  2729. * a case where we will loop three times. There should be no
  2730. * reason to loop four times (that I know of).
  2731. */
  2732. if (RB_WARN_ON(cpu_buffer, ++nr_loops > 3)) {
  2733. reader = NULL;
  2734. goto out;
  2735. }
  2736. reader = cpu_buffer->reader_page;
  2737. /* If there's more to read, return this page */
  2738. if (cpu_buffer->reader_page->read < rb_page_size(reader))
  2739. goto out;
  2740. /* Never should we have an index greater than the size */
  2741. if (RB_WARN_ON(cpu_buffer,
  2742. cpu_buffer->reader_page->read > rb_page_size(reader)))
  2743. goto out;
  2744. /* check if we caught up to the tail */
  2745. reader = NULL;
  2746. if (cpu_buffer->commit_page == cpu_buffer->reader_page)
  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