workqueue.c 124 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535
  1. /*
  2. * kernel/workqueue.c - generic async execution with shared worker pool
  3. *
  4. * Copyright (C) 2002 Ingo Molnar
  5. *
  6. * Derived from the taskqueue/keventd code by:
  7. * David Woodhouse <dwmw2@infradead.org>
  8. * Andrew Morton
  9. * Kai Petzke <wpp@marie.physik.tu-berlin.de>
  10. * Theodore Ts'o <tytso@mit.edu>
  11. *
  12. * Made to use alloc_percpu by Christoph Lameter.
  13. *
  14. * Copyright (C) 2010 SUSE Linux Products GmbH
  15. * Copyright (C) 2010 Tejun Heo <tj@kernel.org>
  16. *
  17. * This is the generic async execution mechanism. Work items as are
  18. * executed in process context. The worker pool is shared and
  19. * automatically managed. There is one worker pool for each CPU and
  20. * one extra for works which are better served by workers which are
  21. * not bound to any specific CPU.
  22. *
  23. * Please read Documentation/workqueue.txt for details.
  24. */
  25. #include <linux/export.h>
  26. #include <linux/kernel.h>
  27. #include <linux/sched.h>
  28. #include <linux/init.h>
  29. #include <linux/signal.h>
  30. #include <linux/completion.h>
  31. #include <linux/workqueue.h>
  32. #include <linux/slab.h>
  33. #include <linux/cpu.h>
  34. #include <linux/notifier.h>
  35. #include <linux/kthread.h>
  36. #include <linux/hardirq.h>
  37. #include <linux/mempolicy.h>
  38. #include <linux/freezer.h>
  39. #include <linux/kallsyms.h>
  40. #include <linux/debug_locks.h>
  41. #include <linux/lockdep.h>
  42. #include <linux/idr.h>
  43. #include <linux/jhash.h>
  44. #include <linux/hashtable.h>
  45. #include <linux/rculist.h>
  46. #include <linux/nodemask.h>
  47. #include "workqueue_internal.h"
  48. enum {
  49. /*
  50. * worker_pool flags
  51. *
  52. * A bound pool is either associated or disassociated with its CPU.
  53. * While associated (!DISASSOCIATED), all workers are bound to the
  54. * CPU and none has %WORKER_UNBOUND set and concurrency management
  55. * is in effect.
  56. *
  57. * While DISASSOCIATED, the cpu may be offline and all workers have
  58. * %WORKER_UNBOUND set and concurrency management disabled, and may
  59. * be executing on any CPU. The pool behaves as an unbound one.
  60. *
  61. * Note that DISASSOCIATED should be flipped only while holding
  62. * manager_mutex to avoid changing binding state while
  63. * create_worker() is in progress.
  64. */
  65. POOL_MANAGE_WORKERS = 1 << 0, /* need to manage workers */
  66. POOL_DISASSOCIATED = 1 << 2, /* cpu can't serve workers */
  67. POOL_FREEZING = 1 << 3, /* freeze in progress */
  68. /* worker flags */
  69. WORKER_STARTED = 1 << 0, /* started */
  70. WORKER_DIE = 1 << 1, /* die die die */
  71. WORKER_IDLE = 1 << 2, /* is idle */
  72. WORKER_PREP = 1 << 3, /* preparing to run works */
  73. WORKER_CPU_INTENSIVE = 1 << 6, /* cpu intensive */
  74. WORKER_UNBOUND = 1 << 7, /* worker is unbound */
  75. WORKER_REBOUND = 1 << 8, /* worker was rebound */
  76. WORKER_NOT_RUNNING = WORKER_PREP | WORKER_CPU_INTENSIVE |
  77. WORKER_UNBOUND | WORKER_REBOUND,
  78. NR_STD_WORKER_POOLS = 2, /* # standard pools per cpu */
  79. UNBOUND_POOL_HASH_ORDER = 6, /* hashed by pool->attrs */
  80. BUSY_WORKER_HASH_ORDER = 6, /* 64 pointers */
  81. MAX_IDLE_WORKERS_RATIO = 4, /* 1/4 of busy can be idle */
  82. IDLE_WORKER_TIMEOUT = 300 * HZ, /* keep idle ones for 5 mins */
  83. MAYDAY_INITIAL_TIMEOUT = HZ / 100 >= 2 ? HZ / 100 : 2,
  84. /* call for help after 10ms
  85. (min two ticks) */
  86. MAYDAY_INTERVAL = HZ / 10, /* and then every 100ms */
  87. CREATE_COOLDOWN = HZ, /* time to breath after fail */
  88. /*
  89. * Rescue workers are used only on emergencies and shared by
  90. * all cpus. Give -20.
  91. */
  92. RESCUER_NICE_LEVEL = -20,
  93. HIGHPRI_NICE_LEVEL = -20,
  94. };
  95. /*
  96. * Structure fields follow one of the following exclusion rules.
  97. *
  98. * I: Modifiable by initialization/destruction paths and read-only for
  99. * everyone else.
  100. *
  101. * P: Preemption protected. Disabling preemption is enough and should
  102. * only be modified and accessed from the local cpu.
  103. *
  104. * L: pool->lock protected. Access with pool->lock held.
  105. *
  106. * X: During normal operation, modification requires pool->lock and should
  107. * be done only from local cpu. Either disabling preemption on local
  108. * cpu or grabbing pool->lock is enough for read access. If
  109. * POOL_DISASSOCIATED is set, it's identical to L.
  110. *
  111. * MG: pool->manager_mutex and pool->lock protected. Writes require both
  112. * locks. Reads can happen under either lock.
  113. *
  114. * PL: wq_pool_mutex protected.
  115. *
  116. * PR: wq_pool_mutex protected for writes. Sched-RCU protected for reads.
  117. *
  118. * WQ: wq->mutex protected.
  119. *
  120. * WR: wq->mutex protected for writes. Sched-RCU protected for reads.
  121. *
  122. * MD: wq_mayday_lock protected.
  123. */
  124. /* struct worker is defined in workqueue_internal.h */
  125. struct worker_pool {
  126. spinlock_t lock; /* the pool lock */
  127. int cpu; /* I: the associated cpu */
  128. int node; /* I: the associated node ID */
  129. int id; /* I: pool ID */
  130. unsigned int flags; /* X: flags */
  131. struct list_head worklist; /* L: list of pending works */
  132. int nr_workers; /* L: total number of workers */
  133. /* nr_idle includes the ones off idle_list for rebinding */
  134. int nr_idle; /* L: currently idle ones */
  135. struct list_head idle_list; /* X: list of idle workers */
  136. struct timer_list idle_timer; /* L: worker idle timeout */
  137. struct timer_list mayday_timer; /* L: SOS timer for workers */
  138. /* a workers is either on busy_hash or idle_list, or the manager */
  139. DECLARE_HASHTABLE(busy_hash, BUSY_WORKER_HASH_ORDER);
  140. /* L: hash of busy workers */
  141. /* see manage_workers() for details on the two manager mutexes */
  142. struct mutex manager_arb; /* manager arbitration */
  143. struct mutex manager_mutex; /* manager exclusion */
  144. struct idr worker_idr; /* MG: worker IDs and iteration */
  145. struct workqueue_attrs *attrs; /* I: worker attributes */
  146. struct hlist_node hash_node; /* PL: unbound_pool_hash node */
  147. int refcnt; /* PL: refcnt for unbound pools */
  148. /*
  149. * The current concurrency level. As it's likely to be accessed
  150. * from other CPUs during try_to_wake_up(), put it in a separate
  151. * cacheline.
  152. */
  153. atomic_t nr_running ____cacheline_aligned_in_smp;
  154. /*
  155. * Destruction of pool is sched-RCU protected to allow dereferences
  156. * from get_work_pool().
  157. */
  158. struct rcu_head rcu;
  159. } ____cacheline_aligned_in_smp;
  160. /*
  161. * The per-pool workqueue. While queued, the lower WORK_STRUCT_FLAG_BITS
  162. * of work_struct->data are used for flags and the remaining high bits
  163. * point to the pwq; thus, pwqs need to be aligned at two's power of the
  164. * number of flag bits.
  165. */
  166. struct pool_workqueue {
  167. struct worker_pool *pool; /* I: the associated pool */
  168. struct workqueue_struct *wq; /* I: the owning workqueue */
  169. int work_color; /* L: current color */
  170. int flush_color; /* L: flushing color */
  171. int refcnt; /* L: reference count */
  172. int nr_in_flight[WORK_NR_COLORS];
  173. /* L: nr of in_flight works */
  174. int nr_active; /* L: nr of active works */
  175. int max_active; /* L: max active works */
  176. struct list_head delayed_works; /* L: delayed works */
  177. struct list_head pwqs_node; /* WR: node on wq->pwqs */
  178. struct list_head mayday_node; /* MD: node on wq->maydays */
  179. /*
  180. * Release of unbound pwq is punted to system_wq. See put_pwq()
  181. * and pwq_unbound_release_workfn() for details. pool_workqueue
  182. * itself is also sched-RCU protected so that the first pwq can be
  183. * determined without grabbing wq->mutex.
  184. */
  185. struct work_struct unbound_release_work;
  186. struct rcu_head rcu;
  187. } __aligned(1 << WORK_STRUCT_FLAG_BITS);
  188. /*
  189. * Structure used to wait for workqueue flush.
  190. */
  191. struct wq_flusher {
  192. struct list_head list; /* WQ: list of flushers */
  193. int flush_color; /* WQ: flush color waiting for */
  194. struct completion done; /* flush completion */
  195. };
  196. struct wq_device;
  197. /*
  198. * The externally visible workqueue. It relays the issued work items to
  199. * the appropriate worker_pool through its pool_workqueues.
  200. */
  201. struct workqueue_struct {
  202. unsigned int flags; /* WQ: WQ_* flags */
  203. struct pool_workqueue __percpu *cpu_pwqs; /* I: per-cpu pwq's */
  204. struct list_head pwqs; /* WR: all pwqs of this wq */
  205. struct list_head list; /* PL: list of all workqueues */
  206. struct mutex mutex; /* protects this wq */
  207. int work_color; /* WQ: current work color */
  208. int flush_color; /* WQ: current flush color */
  209. atomic_t nr_pwqs_to_flush; /* flush in progress */
  210. struct wq_flusher *first_flusher; /* WQ: first flusher */
  211. struct list_head flusher_queue; /* WQ: flush waiters */
  212. struct list_head flusher_overflow; /* WQ: flush overflow list */
  213. struct list_head maydays; /* MD: pwqs requesting rescue */
  214. struct worker *rescuer; /* I: rescue worker */
  215. int nr_drainers; /* WQ: drain in progress */
  216. int saved_max_active; /* WQ: saved pwq max_active */
  217. #ifdef CONFIG_SYSFS
  218. struct wq_device *wq_dev; /* I: for sysfs interface */
  219. #endif
  220. #ifdef CONFIG_LOCKDEP
  221. struct lockdep_map lockdep_map;
  222. #endif
  223. char name[]; /* I: workqueue name */
  224. };
  225. static struct kmem_cache *pwq_cache;
  226. static int wq_numa_tbl_len; /* highest possible NUMA node id + 1 */
  227. static cpumask_var_t *wq_numa_possible_cpumask;
  228. /* possible CPUs of each node */
  229. static bool wq_numa_enabled; /* unbound NUMA affinity enabled */
  230. static DEFINE_MUTEX(wq_pool_mutex); /* protects pools and workqueues list */
  231. static DEFINE_SPINLOCK(wq_mayday_lock); /* protects wq->maydays list */
  232. static LIST_HEAD(workqueues); /* PL: list of all workqueues */
  233. static bool workqueue_freezing; /* PL: have wqs started freezing? */
  234. /* the per-cpu worker pools */
  235. static DEFINE_PER_CPU_SHARED_ALIGNED(struct worker_pool [NR_STD_WORKER_POOLS],
  236. cpu_worker_pools);
  237. static DEFINE_IDR(worker_pool_idr); /* PR: idr of all pools */
  238. /* PL: hash of all unbound pools keyed by pool->attrs */
  239. static DEFINE_HASHTABLE(unbound_pool_hash, UNBOUND_POOL_HASH_ORDER);
  240. /* I: attributes used when instantiating standard unbound pools on demand */
  241. static struct workqueue_attrs *unbound_std_wq_attrs[NR_STD_WORKER_POOLS];
  242. struct workqueue_struct *system_wq __read_mostly;
  243. EXPORT_SYMBOL_GPL(system_wq);
  244. struct workqueue_struct *system_highpri_wq __read_mostly;
  245. EXPORT_SYMBOL_GPL(system_highpri_wq);
  246. struct workqueue_struct *system_long_wq __read_mostly;
  247. EXPORT_SYMBOL_GPL(system_long_wq);
  248. struct workqueue_struct *system_unbound_wq __read_mostly;
  249. EXPORT_SYMBOL_GPL(system_unbound_wq);
  250. struct workqueue_struct *system_freezable_wq __read_mostly;
  251. EXPORT_SYMBOL_GPL(system_freezable_wq);
  252. static int worker_thread(void *__worker);
  253. static void copy_workqueue_attrs(struct workqueue_attrs *to,
  254. const struct workqueue_attrs *from);
  255. #define CREATE_TRACE_POINTS
  256. #include <trace/events/workqueue.h>
  257. #define assert_rcu_or_pool_mutex() \
  258. rcu_lockdep_assert(rcu_read_lock_sched_held() || \
  259. lockdep_is_held(&wq_pool_mutex), \
  260. "sched RCU or wq_pool_mutex should be held")
  261. #define assert_rcu_or_wq_mutex(wq) \
  262. rcu_lockdep_assert(rcu_read_lock_sched_held() || \
  263. lockdep_is_held(&wq->mutex), \
  264. "sched RCU or wq->mutex should be held")
  265. #ifdef CONFIG_LOCKDEP
  266. #define assert_manager_or_pool_lock(pool) \
  267. WARN_ONCE(debug_locks && \
  268. !lockdep_is_held(&(pool)->manager_mutex) && \
  269. !lockdep_is_held(&(pool)->lock), \
  270. "pool->manager_mutex or ->lock should be held")
  271. #else
  272. #define assert_manager_or_pool_lock(pool) do { } while (0)
  273. #endif
  274. #define for_each_cpu_worker_pool(pool, cpu) \
  275. for ((pool) = &per_cpu(cpu_worker_pools, cpu)[0]; \
  276. (pool) < &per_cpu(cpu_worker_pools, cpu)[NR_STD_WORKER_POOLS]; \
  277. (pool)++)
  278. /**
  279. * for_each_pool - iterate through all worker_pools in the system
  280. * @pool: iteration cursor
  281. * @pi: integer used for iteration
  282. *
  283. * This must be called either with wq_pool_mutex held or sched RCU read
  284. * locked. If the pool needs to be used beyond the locking in effect, the
  285. * caller is responsible for guaranteeing that the pool stays online.
  286. *
  287. * The if/else clause exists only for the lockdep assertion and can be
  288. * ignored.
  289. */
  290. #define for_each_pool(pool, pi) \
  291. idr_for_each_entry(&worker_pool_idr, pool, pi) \
  292. if (({ assert_rcu_or_pool_mutex(); false; })) { } \
  293. else
  294. /**
  295. * for_each_pool_worker - iterate through all workers of a worker_pool
  296. * @worker: iteration cursor
  297. * @wi: integer used for iteration
  298. * @pool: worker_pool to iterate workers of
  299. *
  300. * This must be called with either @pool->manager_mutex or ->lock held.
  301. *
  302. * The if/else clause exists only for the lockdep assertion and can be
  303. * ignored.
  304. */
  305. #define for_each_pool_worker(worker, wi, pool) \
  306. idr_for_each_entry(&(pool)->worker_idr, (worker), (wi)) \
  307. if (({ assert_manager_or_pool_lock((pool)); false; })) { } \
  308. else
  309. /**
  310. * for_each_pwq - iterate through all pool_workqueues of the specified workqueue
  311. * @pwq: iteration cursor
  312. * @wq: the target workqueue
  313. *
  314. * This must be called either with wq->mutex held or sched RCU read locked.
  315. * If the pwq needs to be used beyond the locking in effect, the caller is
  316. * responsible for guaranteeing that the pwq stays online.
  317. *
  318. * The if/else clause exists only for the lockdep assertion and can be
  319. * ignored.
  320. */
  321. #define for_each_pwq(pwq, wq) \
  322. list_for_each_entry_rcu((pwq), &(wq)->pwqs, pwqs_node) \
  323. if (({ assert_rcu_or_wq_mutex(wq); false; })) { } \
  324. else
  325. #ifdef CONFIG_DEBUG_OBJECTS_WORK
  326. static struct debug_obj_descr work_debug_descr;
  327. static void *work_debug_hint(void *addr)
  328. {
  329. return ((struct work_struct *) addr)->func;
  330. }
  331. /*
  332. * fixup_init is called when:
  333. * - an active object is initialized
  334. */
  335. static int work_fixup_init(void *addr, enum debug_obj_state state)
  336. {
  337. struct work_struct *work = addr;
  338. switch (state) {
  339. case ODEBUG_STATE_ACTIVE:
  340. cancel_work_sync(work);
  341. debug_object_init(work, &work_debug_descr);
  342. return 1;
  343. default:
  344. return 0;
  345. }
  346. }
  347. /*
  348. * fixup_activate is called when:
  349. * - an active object is activated
  350. * - an unknown object is activated (might be a statically initialized object)
  351. */
  352. static int work_fixup_activate(void *addr, enum debug_obj_state state)
  353. {
  354. struct work_struct *work = addr;
  355. switch (state) {
  356. case ODEBUG_STATE_NOTAVAILABLE:
  357. /*
  358. * This is not really a fixup. The work struct was
  359. * statically initialized. We just make sure that it
  360. * is tracked in the object tracker.
  361. */
  362. if (test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work))) {
  363. debug_object_init(work, &work_debug_descr);
  364. debug_object_activate(work, &work_debug_descr);
  365. return 0;
  366. }
  367. WARN_ON_ONCE(1);
  368. return 0;
  369. case ODEBUG_STATE_ACTIVE:
  370. WARN_ON(1);
  371. default:
  372. return 0;
  373. }
  374. }
  375. /*
  376. * fixup_free is called when:
  377. * - an active object is freed
  378. */
  379. static int work_fixup_free(void *addr, enum debug_obj_state state)
  380. {
  381. struct work_struct *work = addr;
  382. switch (state) {
  383. case ODEBUG_STATE_ACTIVE:
  384. cancel_work_sync(work);
  385. debug_object_free(work, &work_debug_descr);
  386. return 1;
  387. default:
  388. return 0;
  389. }
  390. }
  391. static struct debug_obj_descr work_debug_descr = {
  392. .name = "work_struct",
  393. .debug_hint = work_debug_hint,
  394. .fixup_init = work_fixup_init,
  395. .fixup_activate = work_fixup_activate,
  396. .fixup_free = work_fixup_free,
  397. };
  398. static inline void debug_work_activate(struct work_struct *work)
  399. {
  400. debug_object_activate(work, &work_debug_descr);
  401. }
  402. static inline void debug_work_deactivate(struct work_struct *work)
  403. {
  404. debug_object_deactivate(work, &work_debug_descr);
  405. }
  406. void __init_work(struct work_struct *work, int onstack)
  407. {
  408. if (onstack)
  409. debug_object_init_on_stack(work, &work_debug_descr);
  410. else
  411. debug_object_init(work, &work_debug_descr);
  412. }
  413. EXPORT_SYMBOL_GPL(__init_work);
  414. void destroy_work_on_stack(struct work_struct *work)
  415. {
  416. debug_object_free(work, &work_debug_descr);
  417. }
  418. EXPORT_SYMBOL_GPL(destroy_work_on_stack);
  419. #else
  420. static inline void debug_work_activate(struct work_struct *work) { }
  421. static inline void debug_work_deactivate(struct work_struct *work) { }
  422. #endif
  423. /* allocate ID and assign it to @pool */
  424. static int worker_pool_assign_id(struct worker_pool *pool)
  425. {
  426. int ret;
  427. lockdep_assert_held(&wq_pool_mutex);
  428. do {
  429. if (!idr_pre_get(&worker_pool_idr, GFP_KERNEL))
  430. return -ENOMEM;
  431. ret = idr_get_new(&worker_pool_idr, pool, &pool->id);
  432. } while (ret == -EAGAIN);
  433. return ret;
  434. }
  435. /**
  436. * first_pwq - return the first pool_workqueue of the specified workqueue
  437. * @wq: the target workqueue
  438. *
  439. * This must be called either with wq->mutex held or sched RCU read locked.
  440. * If the pwq needs to be used beyond the locking in effect, the caller is
  441. * responsible for guaranteeing that the pwq stays online.
  442. */
  443. static struct pool_workqueue *first_pwq(struct workqueue_struct *wq)
  444. {
  445. assert_rcu_or_wq_mutex(wq);
  446. return list_first_or_null_rcu(&wq->pwqs, struct pool_workqueue,
  447. pwqs_node);
  448. }
  449. static unsigned int work_color_to_flags(int color)
  450. {
  451. return color << WORK_STRUCT_COLOR_SHIFT;
  452. }
  453. static int get_work_color(struct work_struct *work)
  454. {
  455. return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
  456. ((1 << WORK_STRUCT_COLOR_BITS) - 1);
  457. }
  458. static int work_next_color(int color)
  459. {
  460. return (color + 1) % WORK_NR_COLORS;
  461. }
  462. /*
  463. * While queued, %WORK_STRUCT_PWQ is set and non flag bits of a work's data
  464. * contain the pointer to the queued pwq. Once execution starts, the flag
  465. * is cleared and the high bits contain OFFQ flags and pool ID.
  466. *
  467. * set_work_pwq(), set_work_pool_and_clear_pending(), mark_work_canceling()
  468. * and clear_work_data() can be used to set the pwq, pool or clear
  469. * work->data. These functions should only be called while the work is
  470. * owned - ie. while the PENDING bit is set.
  471. *
  472. * get_work_pool() and get_work_pwq() can be used to obtain the pool or pwq
  473. * corresponding to a work. Pool is available once the work has been
  474. * queued anywhere after initialization until it is sync canceled. pwq is
  475. * available only while the work item is queued.
  476. *
  477. * %WORK_OFFQ_CANCELING is used to mark a work item which is being
  478. * canceled. While being canceled, a work item may have its PENDING set
  479. * but stay off timer and worklist for arbitrarily long and nobody should
  480. * try to steal the PENDING bit.
  481. */
  482. static inline void set_work_data(struct work_struct *work, unsigned long data,
  483. unsigned long flags)
  484. {
  485. WARN_ON_ONCE(!work_pending(work));
  486. atomic_long_set(&work->data, data | flags | work_static(work));
  487. }
  488. static void set_work_pwq(struct work_struct *work, struct pool_workqueue *pwq,
  489. unsigned long extra_flags)
  490. {
  491. set_work_data(work, (unsigned long)pwq,
  492. WORK_STRUCT_PENDING | WORK_STRUCT_PWQ | extra_flags);
  493. }
  494. static void set_work_pool_and_keep_pending(struct work_struct *work,
  495. int pool_id)
  496. {
  497. set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT,
  498. WORK_STRUCT_PENDING);
  499. }
  500. static void set_work_pool_and_clear_pending(struct work_struct *work,
  501. int pool_id)
  502. {
  503. /*
  504. * The following wmb is paired with the implied mb in
  505. * test_and_set_bit(PENDING) and ensures all updates to @work made
  506. * here are visible to and precede any updates by the next PENDING
  507. * owner.
  508. */
  509. smp_wmb();
  510. set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, 0);
  511. }
  512. static void clear_work_data(struct work_struct *work)
  513. {
  514. smp_wmb(); /* see set_work_pool_and_clear_pending() */
  515. set_work_data(work, WORK_STRUCT_NO_POOL, 0);
  516. }
  517. static struct pool_workqueue *get_work_pwq(struct work_struct *work)
  518. {
  519. unsigned long data = atomic_long_read(&work->data);
  520. if (data & WORK_STRUCT_PWQ)
  521. return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
  522. else
  523. return NULL;
  524. }
  525. /**
  526. * get_work_pool - return the worker_pool a given work was associated with
  527. * @work: the work item of interest
  528. *
  529. * Return the worker_pool @work was last associated with. %NULL if none.
  530. *
  531. * Pools are created and destroyed under wq_pool_mutex, and allows read
  532. * access under sched-RCU read lock. As such, this function should be
  533. * called under wq_pool_mutex or with preemption disabled.
  534. *
  535. * All fields of the returned pool are accessible as long as the above
  536. * mentioned locking is in effect. If the returned pool needs to be used
  537. * beyond the critical section, the caller is responsible for ensuring the
  538. * returned pool is and stays online.
  539. */
  540. static struct worker_pool *get_work_pool(struct work_struct *work)
  541. {
  542. unsigned long data = atomic_long_read(&work->data);
  543. int pool_id;
  544. assert_rcu_or_pool_mutex();
  545. if (data & WORK_STRUCT_PWQ)
  546. return ((struct pool_workqueue *)
  547. (data & WORK_STRUCT_WQ_DATA_MASK))->pool;
  548. pool_id = data >> WORK_OFFQ_POOL_SHIFT;
  549. if (pool_id == WORK_OFFQ_POOL_NONE)
  550. return NULL;
  551. return idr_find(&worker_pool_idr, pool_id);
  552. }
  553. /**
  554. * get_work_pool_id - return the worker pool ID a given work is associated with
  555. * @work: the work item of interest
  556. *
  557. * Return the worker_pool ID @work was last associated with.
  558. * %WORK_OFFQ_POOL_NONE if none.
  559. */
  560. static int get_work_pool_id(struct work_struct *work)
  561. {
  562. unsigned long data = atomic_long_read(&work->data);
  563. if (data & WORK_STRUCT_PWQ)
  564. return ((struct pool_workqueue *)
  565. (data & WORK_STRUCT_WQ_DATA_MASK))->pool->id;
  566. return data >> WORK_OFFQ_POOL_SHIFT;
  567. }
  568. static void mark_work_canceling(struct work_struct *work)
  569. {
  570. unsigned long pool_id = get_work_pool_id(work);
  571. pool_id <<= WORK_OFFQ_POOL_SHIFT;
  572. set_work_data(work, pool_id | WORK_OFFQ_CANCELING, WORK_STRUCT_PENDING);
  573. }
  574. static bool work_is_canceling(struct work_struct *work)
  575. {
  576. unsigned long data = atomic_long_read(&work->data);
  577. return !(data & WORK_STRUCT_PWQ) && (data & WORK_OFFQ_CANCELING);
  578. }
  579. /*
  580. * Policy functions. These define the policies on how the global worker
  581. * pools are managed. Unless noted otherwise, these functions assume that
  582. * they're being called with pool->lock held.
  583. */
  584. static bool __need_more_worker(struct worker_pool *pool)
  585. {
  586. return !atomic_read(&pool->nr_running);
  587. }
  588. /*
  589. * Need to wake up a worker? Called from anything but currently
  590. * running workers.
  591. *
  592. * Note that, because unbound workers never contribute to nr_running, this
  593. * function will always return %true for unbound pools as long as the
  594. * worklist isn't empty.
  595. */
  596. static bool need_more_worker(struct worker_pool *pool)
  597. {
  598. return !list_empty(&pool->worklist) && __need_more_worker(pool);
  599. }
  600. /* Can I start working? Called from busy but !running workers. */
  601. static bool may_start_working(struct worker_pool *pool)
  602. {
  603. return pool->nr_idle;
  604. }
  605. /* Do I need to keep working? Called from currently running workers. */
  606. static bool keep_working(struct worker_pool *pool)
  607. {
  608. return !list_empty(&pool->worklist) &&
  609. atomic_read(&pool->nr_running) <= 1;
  610. }
  611. /* Do we need a new worker? Called from manager. */
  612. static bool need_to_create_worker(struct worker_pool *pool)
  613. {
  614. return need_more_worker(pool) && !may_start_working(pool);
  615. }
  616. /* Do I need to be the manager? */
  617. static bool need_to_manage_workers(struct worker_pool *pool)
  618. {
  619. return need_to_create_worker(pool) ||
  620. (pool->flags & POOL_MANAGE_WORKERS);
  621. }
  622. /* Do we have too many workers and should some go away? */
  623. static bool too_many_workers(struct worker_pool *pool)
  624. {
  625. bool managing = mutex_is_locked(&pool->manager_arb);
  626. int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
  627. int nr_busy = pool->nr_workers - nr_idle;
  628. /*
  629. * nr_idle and idle_list may disagree if idle rebinding is in
  630. * progress. Never return %true if idle_list is empty.
  631. */
  632. if (list_empty(&pool->idle_list))
  633. return false;
  634. return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
  635. }
  636. /*
  637. * Wake up functions.
  638. */
  639. /* Return the first worker. Safe with preemption disabled */
  640. static struct worker *first_worker(struct worker_pool *pool)
  641. {
  642. if (unlikely(list_empty(&pool->idle_list)))
  643. return NULL;
  644. return list_first_entry(&pool->idle_list, struct worker, entry);
  645. }
  646. /**
  647. * wake_up_worker - wake up an idle worker
  648. * @pool: worker pool to wake worker from
  649. *
  650. * Wake up the first idle worker of @pool.
  651. *
  652. * CONTEXT:
  653. * spin_lock_irq(pool->lock).
  654. */
  655. static void wake_up_worker(struct worker_pool *pool)
  656. {
  657. struct worker *worker = first_worker(pool);
  658. if (likely(worker))
  659. wake_up_process(worker->task);
  660. }
  661. /**
  662. * wq_worker_waking_up - a worker is waking up
  663. * @task: task waking up
  664. * @cpu: CPU @task is waking up to
  665. *
  666. * This function is called during try_to_wake_up() when a worker is
  667. * being awoken.
  668. *
  669. * CONTEXT:
  670. * spin_lock_irq(rq->lock)
  671. */
  672. void wq_worker_waking_up(struct task_struct *task, int cpu)
  673. {
  674. struct worker *worker = kthread_data(task);
  675. if (!(worker->flags & WORKER_NOT_RUNNING)) {
  676. WARN_ON_ONCE(worker->pool->cpu != cpu);
  677. atomic_inc(&worker->pool->nr_running);
  678. }
  679. }
  680. /**
  681. * wq_worker_sleeping - a worker is going to sleep
  682. * @task: task going to sleep
  683. * @cpu: CPU in question, must be the current CPU number
  684. *
  685. * This function is called during schedule() when a busy worker is
  686. * going to sleep. Worker on the same cpu can be woken up by
  687. * returning pointer to its task.
  688. *
  689. * CONTEXT:
  690. * spin_lock_irq(rq->lock)
  691. *
  692. * RETURNS:
  693. * Worker task on @cpu to wake up, %NULL if none.
  694. */
  695. struct task_struct *wq_worker_sleeping(struct task_struct *task, int cpu)
  696. {
  697. struct worker *worker = kthread_data(task), *to_wakeup = NULL;
  698. struct worker_pool *pool;
  699. /*
  700. * Rescuers, which may not have all the fields set up like normal
  701. * workers, also reach here, let's not access anything before
  702. * checking NOT_RUNNING.
  703. */
  704. if (worker->flags & WORKER_NOT_RUNNING)
  705. return NULL;
  706. pool = worker->pool;
  707. /* this can only happen on the local cpu */
  708. if (WARN_ON_ONCE(cpu != raw_smp_processor_id()))
  709. return NULL;
  710. /*
  711. * The counterpart of the following dec_and_test, implied mb,
  712. * worklist not empty test sequence is in insert_work().
  713. * Please read comment there.
  714. *
  715. * NOT_RUNNING is clear. This means that we're bound to and
  716. * running on the local cpu w/ rq lock held and preemption
  717. * disabled, which in turn means that none else could be
  718. * manipulating idle_list, so dereferencing idle_list without pool
  719. * lock is safe.
  720. */
  721. if (atomic_dec_and_test(&pool->nr_running) &&
  722. !list_empty(&pool->worklist))
  723. to_wakeup = first_worker(pool);
  724. return to_wakeup ? to_wakeup->task : NULL;
  725. }
  726. /**
  727. * worker_set_flags - set worker flags and adjust nr_running accordingly
  728. * @worker: self
  729. * @flags: flags to set
  730. * @wakeup: wakeup an idle worker if necessary
  731. *
  732. * Set @flags in @worker->flags and adjust nr_running accordingly. If
  733. * nr_running becomes zero and @wakeup is %true, an idle worker is
  734. * woken up.
  735. *
  736. * CONTEXT:
  737. * spin_lock_irq(pool->lock)
  738. */
  739. static inline void worker_set_flags(struct worker *worker, unsigned int flags,
  740. bool wakeup)
  741. {
  742. struct worker_pool *pool = worker->pool;
  743. WARN_ON_ONCE(worker->task != current);
  744. /*
  745. * If transitioning into NOT_RUNNING, adjust nr_running and
  746. * wake up an idle worker as necessary if requested by
  747. * @wakeup.
  748. */
  749. if ((flags & WORKER_NOT_RUNNING) &&
  750. !(worker->flags & WORKER_NOT_RUNNING)) {
  751. if (wakeup) {
  752. if (atomic_dec_and_test(&pool->nr_running) &&
  753. !list_empty(&pool->worklist))
  754. wake_up_worker(pool);
  755. } else
  756. atomic_dec(&pool->nr_running);
  757. }
  758. worker->flags |= flags;
  759. }
  760. /**
  761. * worker_clr_flags - clear worker flags and adjust nr_running accordingly
  762. * @worker: self
  763. * @flags: flags to clear
  764. *
  765. * Clear @flags in @worker->flags and adjust nr_running accordingly.
  766. *
  767. * CONTEXT:
  768. * spin_lock_irq(pool->lock)
  769. */
  770. static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
  771. {
  772. struct worker_pool *pool = worker->pool;
  773. unsigned int oflags = worker->flags;
  774. WARN_ON_ONCE(worker->task != current);
  775. worker->flags &= ~flags;
  776. /*
  777. * If transitioning out of NOT_RUNNING, increment nr_running. Note
  778. * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask
  779. * of multiple flags, not a single flag.
  780. */
  781. if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
  782. if (!(worker->flags & WORKER_NOT_RUNNING))
  783. atomic_inc(&pool->nr_running);
  784. }
  785. /**
  786. * find_worker_executing_work - find worker which is executing a work
  787. * @pool: pool of interest
  788. * @work: work to find worker for
  789. *
  790. * Find a worker which is executing @work on @pool by searching
  791. * @pool->busy_hash which is keyed by the address of @work. For a worker
  792. * to match, its current execution should match the address of @work and
  793. * its work function. This is to avoid unwanted dependency between
  794. * unrelated work executions through a work item being recycled while still
  795. * being executed.
  796. *
  797. * This is a bit tricky. A work item may be freed once its execution
  798. * starts and nothing prevents the freed area from being recycled for
  799. * another work item. If the same work item address ends up being reused
  800. * before the original execution finishes, workqueue will identify the
  801. * recycled work item as currently executing and make it wait until the
  802. * current execution finishes, introducing an unwanted dependency.
  803. *
  804. * This function checks the work item address and work function to avoid
  805. * false positives. Note that this isn't complete as one may construct a
  806. * work function which can introduce dependency onto itself through a
  807. * recycled work item. Well, if somebody wants to shoot oneself in the
  808. * foot that badly, there's only so much we can do, and if such deadlock
  809. * actually occurs, it should be easy to locate the culprit work function.
  810. *
  811. * CONTEXT:
  812. * spin_lock_irq(pool->lock).
  813. *
  814. * RETURNS:
  815. * Pointer to worker which is executing @work if found, NULL
  816. * otherwise.
  817. */
  818. static struct worker *find_worker_executing_work(struct worker_pool *pool,
  819. struct work_struct *work)
  820. {
  821. struct worker *worker;
  822. hash_for_each_possible(pool->busy_hash, worker, hentry,
  823. (unsigned long)work)
  824. if (worker->current_work == work &&
  825. worker->current_func == work->func)
  826. return worker;
  827. return NULL;
  828. }
  829. /**
  830. * move_linked_works - move linked works to a list
  831. * @work: start of series of works to be scheduled
  832. * @head: target list to append @work to
  833. * @nextp: out paramter for nested worklist walking
  834. *
  835. * Schedule linked works starting from @work to @head. Work series to
  836. * be scheduled starts at @work and includes any consecutive work with
  837. * WORK_STRUCT_LINKED set in its predecessor.
  838. *
  839. * If @nextp is not NULL, it's updated to point to the next work of
  840. * the last scheduled work. This allows move_linked_works() to be
  841. * nested inside outer list_for_each_entry_safe().
  842. *
  843. * CONTEXT:
  844. * spin_lock_irq(pool->lock).
  845. */
  846. static void move_linked_works(struct work_struct *work, struct list_head *head,
  847. struct work_struct **nextp)
  848. {
  849. struct work_struct *n;
  850. /*
  851. * Linked worklist will always end before the end of the list,
  852. * use NULL for list head.
  853. */
  854. list_for_each_entry_safe_from(work, n, NULL, entry) {
  855. list_move_tail(&work->entry, head);
  856. if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
  857. break;
  858. }
  859. /*
  860. * If we're already inside safe list traversal and have moved
  861. * multiple works to the scheduled queue, the next position
  862. * needs to be updated.
  863. */
  864. if (nextp)
  865. *nextp = n;
  866. }
  867. /**
  868. * get_pwq - get an extra reference on the specified pool_workqueue
  869. * @pwq: pool_workqueue to get
  870. *
  871. * Obtain an extra reference on @pwq. The caller should guarantee that
  872. * @pwq has positive refcnt and be holding the matching pool->lock.
  873. */
  874. static void get_pwq(struct pool_workqueue *pwq)
  875. {
  876. lockdep_assert_held(&pwq->pool->lock);
  877. WARN_ON_ONCE(pwq->refcnt <= 0);
  878. pwq->refcnt++;
  879. }
  880. /**
  881. * put_pwq - put a pool_workqueue reference
  882. * @pwq: pool_workqueue to put
  883. *
  884. * Drop a reference of @pwq. If its refcnt reaches zero, schedule its
  885. * destruction. The caller should be holding the matching pool->lock.
  886. */
  887. static void put_pwq(struct pool_workqueue *pwq)
  888. {
  889. lockdep_assert_held(&pwq->pool->lock);
  890. if (likely(--pwq->refcnt))
  891. return;
  892. if (WARN_ON_ONCE(!(pwq->wq->flags & WQ_UNBOUND)))
  893. return;
  894. /*
  895. * @pwq can't be released under pool->lock, bounce to
  896. * pwq_unbound_release_workfn(). This never recurses on the same
  897. * pool->lock as this path is taken only for unbound workqueues and
  898. * the release work item is scheduled on a per-cpu workqueue. To
  899. * avoid lockdep warning, unbound pool->locks are given lockdep
  900. * subclass of 1 in get_unbound_pool().
  901. */
  902. schedule_work(&pwq->unbound_release_work);
  903. }
  904. static void pwq_activate_delayed_work(struct work_struct *work)
  905. {
  906. struct pool_workqueue *pwq = get_work_pwq(work);
  907. trace_workqueue_activate_work(work);
  908. move_linked_works(work, &pwq->pool->worklist, NULL);
  909. __clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
  910. pwq->nr_active++;
  911. }
  912. static void pwq_activate_first_delayed(struct pool_workqueue *pwq)
  913. {
  914. struct work_struct *work = list_first_entry(&pwq->delayed_works,
  915. struct work_struct, entry);
  916. pwq_activate_delayed_work(work);
  917. }
  918. /**
  919. * pwq_dec_nr_in_flight - decrement pwq's nr_in_flight
  920. * @pwq: pwq of interest
  921. * @color: color of work which left the queue
  922. *
  923. * A work either has completed or is removed from pending queue,
  924. * decrement nr_in_flight of its pwq and handle workqueue flushing.
  925. *
  926. * CONTEXT:
  927. * spin_lock_irq(pool->lock).
  928. */
  929. static void pwq_dec_nr_in_flight(struct pool_workqueue *pwq, int color)
  930. {
  931. /* uncolored work items don't participate in flushing or nr_active */
  932. if (color == WORK_NO_COLOR)
  933. goto out_put;
  934. pwq->nr_in_flight[color]--;
  935. pwq->nr_active--;
  936. if (!list_empty(&pwq->delayed_works)) {
  937. /* one down, submit a delayed one */
  938. if (pwq->nr_active < pwq->max_active)
  939. pwq_activate_first_delayed(pwq);
  940. }
  941. /* is flush in progress and are we at the flushing tip? */
  942. if (likely(pwq->flush_color != color))
  943. goto out_put;
  944. /* are there still in-flight works? */
  945. if (pwq->nr_in_flight[color])
  946. goto out_put;
  947. /* this pwq is done, clear flush_color */
  948. pwq->flush_color = -1;
  949. /*
  950. * If this was the last pwq, wake up the first flusher. It
  951. * will handle the rest.
  952. */
  953. if (atomic_dec_and_test(&pwq->wq->nr_pwqs_to_flush))
  954. complete(&pwq->wq->first_flusher->done);
  955. out_put:
  956. put_pwq(pwq);
  957. }
  958. /**
  959. * try_to_grab_pending - steal work item from worklist and disable irq
  960. * @work: work item to steal
  961. * @is_dwork: @work is a delayed_work
  962. * @flags: place to store irq state
  963. *
  964. * Try to grab PENDING bit of @work. This function can handle @work in any
  965. * stable state - idle, on timer or on worklist. Return values are
  966. *
  967. * 1 if @work was pending and we successfully stole PENDING
  968. * 0 if @work was idle and we claimed PENDING
  969. * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry
  970. * -ENOENT if someone else is canceling @work, this state may persist
  971. * for arbitrarily long
  972. *
  973. * On >= 0 return, the caller owns @work's PENDING bit. To avoid getting
  974. * interrupted while holding PENDING and @work off queue, irq must be
  975. * disabled on entry. This, combined with delayed_work->timer being
  976. * irqsafe, ensures that we return -EAGAIN for finite short period of time.
  977. *
  978. * On successful return, >= 0, irq is disabled and the caller is
  979. * responsible for releasing it using local_irq_restore(*@flags).
  980. *
  981. * This function is safe to call from any context including IRQ handler.
  982. */
  983. static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
  984. unsigned long *flags)
  985. {
  986. struct worker_pool *pool;
  987. struct pool_workqueue *pwq;
  988. local_irq_save(*flags);
  989. /* try to steal the timer if it exists */
  990. if (is_dwork) {
  991. struct delayed_work *dwork = to_delayed_work(work);
  992. /*
  993. * dwork->timer is irqsafe. If del_timer() fails, it's
  994. * guaranteed that the timer is not queued anywhere and not
  995. * running on the local CPU.
  996. */
  997. if (likely(del_timer(&dwork->timer)))
  998. return 1;
  999. }
  1000. /* try to claim PENDING the normal way */
  1001. if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
  1002. return 0;
  1003. /*
  1004. * The queueing is in progress, or it is already queued. Try to
  1005. * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
  1006. */
  1007. pool = get_work_pool(work);
  1008. if (!pool)
  1009. goto fail;
  1010. spin_lock(&pool->lock);
  1011. /*
  1012. * work->data is guaranteed to point to pwq only while the work
  1013. * item is queued on pwq->wq, and both updating work->data to point
  1014. * to pwq on queueing and to pool on dequeueing are done under
  1015. * pwq->pool->lock. This in turn guarantees that, if work->data
  1016. * points to pwq which is associated with a locked pool, the work
  1017. * item is currently queued on that pool.
  1018. */
  1019. pwq = get_work_pwq(work);
  1020. if (pwq && pwq->pool == pool) {
  1021. debug_work_deactivate(work);
  1022. /*
  1023. * A delayed work item cannot be grabbed directly because
  1024. * it might have linked NO_COLOR work items which, if left
  1025. * on the delayed_list, will confuse pwq->nr_active
  1026. * management later on and cause stall. Make sure the work
  1027. * item is activated before grabbing.
  1028. */
  1029. if (*work_data_bits(work) & WORK_STRUCT_DELAYED)
  1030. pwq_activate_delayed_work(work);
  1031. list_del_init(&work->entry);
  1032. pwq_dec_nr_in_flight(get_work_pwq(work), get_work_color(work));
  1033. /* work->data points to pwq iff queued, point to pool */
  1034. set_work_pool_and_keep_pending(work, pool->id);
  1035. spin_unlock(&pool->lock);
  1036. return 1;
  1037. }
  1038. spin_unlock(&pool->lock);
  1039. fail:
  1040. local_irq_restore(*flags);
  1041. if (work_is_canceling(work))
  1042. return -ENOENT;
  1043. cpu_relax();
  1044. return -EAGAIN;
  1045. }
  1046. /**
  1047. * insert_work - insert a work into a pool
  1048. * @pwq: pwq @work belongs to
  1049. * @work: work to insert
  1050. * @head: insertion point
  1051. * @extra_flags: extra WORK_STRUCT_* flags to set
  1052. *
  1053. * Insert @work which belongs to @pwq after @head. @extra_flags is or'd to
  1054. * work_struct flags.
  1055. *
  1056. * CONTEXT:
  1057. * spin_lock_irq(pool->lock).
  1058. */
  1059. static void insert_work(struct pool_workqueue *pwq, struct work_struct *work,
  1060. struct list_head *head, unsigned int extra_flags)
  1061. {
  1062. struct worker_pool *pool = pwq->pool;
  1063. /* we own @work, set data and link */
  1064. set_work_pwq(work, pwq, extra_flags);
  1065. list_add_tail(&work->entry, head);
  1066. get_pwq(pwq);
  1067. /*
  1068. * Ensure either wq_worker_sleeping() sees the above
  1069. * list_add_tail() or we see zero nr_running to avoid workers lying
  1070. * around lazily while there are works to be processed.
  1071. */
  1072. smp_mb();
  1073. if (__need_more_worker(pool))
  1074. wake_up_worker(pool);
  1075. }
  1076. /*
  1077. * Test whether @work is being queued from another work executing on the
  1078. * same workqueue.
  1079. */
  1080. static bool is_chained_work(struct workqueue_struct *wq)
  1081. {
  1082. struct worker *worker;
  1083. worker = current_wq_worker();
  1084. /*
  1085. * Return %true iff I'm a worker execuing a work item on @wq. If
  1086. * I'm @worker, it's safe to dereference it without locking.
  1087. */
  1088. return worker && worker->current_pwq->wq == wq;
  1089. }
  1090. static void __queue_work(int cpu, struct workqueue_struct *wq,
  1091. struct work_struct *work)
  1092. {
  1093. struct pool_workqueue *pwq;
  1094. struct worker_pool *last_pool;
  1095. struct list_head *worklist;
  1096. unsigned int work_flags;
  1097. unsigned int req_cpu = cpu;
  1098. /*
  1099. * While a work item is PENDING && off queue, a task trying to
  1100. * steal the PENDING will busy-loop waiting for it to either get
  1101. * queued or lose PENDING. Grabbing PENDING and queueing should
  1102. * happen with IRQ disabled.
  1103. */
  1104. WARN_ON_ONCE(!irqs_disabled());
  1105. debug_work_activate(work);
  1106. /* if dying, only works from the same workqueue are allowed */
  1107. if (unlikely(wq->flags & __WQ_DRAINING) &&
  1108. WARN_ON_ONCE(!is_chained_work(wq)))
  1109. return;
  1110. retry:
  1111. /* pwq which will be used unless @work is executing elsewhere */
  1112. if (!(wq->flags & WQ_UNBOUND)) {
  1113. if (cpu == WORK_CPU_UNBOUND)
  1114. cpu = raw_smp_processor_id();
  1115. pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
  1116. } else {
  1117. pwq = first_pwq(wq);
  1118. }
  1119. /*
  1120. * If @work was previously on a different pool, it might still be
  1121. * running there, in which case the work needs to be queued on that
  1122. * pool to guarantee non-reentrancy.
  1123. */
  1124. last_pool = get_work_pool(work);
  1125. if (last_pool && last_pool != pwq->pool) {
  1126. struct worker *worker;
  1127. spin_lock(&last_pool->lock);
  1128. worker = find_worker_executing_work(last_pool, work);
  1129. if (worker && worker->current_pwq->wq == wq) {
  1130. pwq = worker->current_pwq;
  1131. } else {
  1132. /* meh... not running there, queue here */
  1133. spin_unlock(&last_pool->lock);
  1134. spin_lock(&pwq->pool->lock);
  1135. }
  1136. } else {
  1137. spin_lock(&pwq->pool->lock);
  1138. }
  1139. /*
  1140. * pwq is determined and locked. For unbound pools, we could have
  1141. * raced with pwq release and it could already be dead. If its
  1142. * refcnt is zero, repeat pwq selection. Note that pwqs never die
  1143. * without another pwq replacing it as the first pwq or while a
  1144. * work item is executing on it, so the retying is guaranteed to
  1145. * make forward-progress.
  1146. */
  1147. if (unlikely(!pwq->refcnt)) {
  1148. if (wq->flags & WQ_UNBOUND) {
  1149. spin_unlock(&pwq->pool->lock);
  1150. cpu_relax();
  1151. goto retry;
  1152. }
  1153. /* oops */
  1154. WARN_ONCE(true, "workqueue: per-cpu pwq for %s on cpu%d has 0 refcnt",
  1155. wq->name, cpu);
  1156. }
  1157. /* pwq determined, queue */
  1158. trace_workqueue_queue_work(req_cpu, pwq, work);
  1159. if (WARN_ON(!list_empty(&work->entry))) {
  1160. spin_unlock(&pwq->pool->lock);
  1161. return;
  1162. }
  1163. pwq->nr_in_flight[pwq->work_color]++;
  1164. work_flags = work_color_to_flags(pwq->work_color);
  1165. if (likely(pwq->nr_active < pwq->max_active)) {
  1166. trace_workqueue_activate_work(work);
  1167. pwq->nr_active++;
  1168. worklist = &pwq->pool->worklist;
  1169. } else {
  1170. work_flags |= WORK_STRUCT_DELAYED;
  1171. worklist = &pwq->delayed_works;
  1172. }
  1173. insert_work(pwq, work, worklist, work_flags);
  1174. spin_unlock(&pwq->pool->lock);
  1175. }
  1176. /**
  1177. * queue_work_on - queue work on specific cpu
  1178. * @cpu: CPU number to execute work on
  1179. * @wq: workqueue to use
  1180. * @work: work to queue
  1181. *
  1182. * Returns %false if @work was already on a queue, %true otherwise.
  1183. *
  1184. * We queue the work to a specific CPU, the caller must ensure it
  1185. * can't go away.
  1186. */
  1187. bool queue_work_on(int cpu, struct workqueue_struct *wq,
  1188. struct work_struct *work)
  1189. {
  1190. bool ret = false;
  1191. unsigned long flags;
  1192. local_irq_save(flags);
  1193. if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
  1194. __queue_work(cpu, wq, work);
  1195. ret = true;
  1196. }
  1197. local_irq_restore(flags);
  1198. return ret;
  1199. }
  1200. EXPORT_SYMBOL_GPL(queue_work_on);
  1201. void delayed_work_timer_fn(unsigned long __data)
  1202. {
  1203. struct delayed_work *dwork = (struct delayed_work *)__data;
  1204. /* should have been called from irqsafe timer with irq already off */
  1205. __queue_work(dwork->cpu, dwork->wq, &dwork->work);
  1206. }
  1207. EXPORT_SYMBOL(delayed_work_timer_fn);
  1208. static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
  1209. struct delayed_work *dwork, unsigned long delay)
  1210. {
  1211. struct timer_list *timer = &dwork->timer;
  1212. struct work_struct *work = &dwork->work;
  1213. WARN_ON_ONCE(timer->function != delayed_work_timer_fn ||
  1214. timer->data != (unsigned long)dwork);
  1215. WARN_ON_ONCE(timer_pending(timer));
  1216. WARN_ON_ONCE(!list_empty(&work->entry));
  1217. /*
  1218. * If @delay is 0, queue @dwork->work immediately. This is for
  1219. * both optimization and correctness. The earliest @timer can
  1220. * expire is on the closest next tick and delayed_work users depend
  1221. * on that there's no such delay when @delay is 0.
  1222. */
  1223. if (!delay) {
  1224. __queue_work(cpu, wq, &dwork->work);
  1225. return;
  1226. }
  1227. timer_stats_timer_set_start_info(&dwork->timer);
  1228. dwork->wq = wq;
  1229. dwork->cpu = cpu;
  1230. timer->expires = jiffies + delay;
  1231. if (unlikely(cpu != WORK_CPU_UNBOUND))
  1232. add_timer_on(timer, cpu);
  1233. else
  1234. add_timer(timer);
  1235. }
  1236. /**
  1237. * queue_delayed_work_on - queue work on specific CPU after delay
  1238. * @cpu: CPU number to execute work on
  1239. * @wq: workqueue to use
  1240. * @dwork: work to queue
  1241. * @delay: number of jiffies to wait before queueing
  1242. *
  1243. * Returns %false if @work was already on a queue, %true otherwise. If
  1244. * @delay is zero and @dwork is idle, it will be scheduled for immediate
  1245. * execution.
  1246. */
  1247. bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
  1248. struct delayed_work *dwork, unsigned long delay)
  1249. {
  1250. struct work_struct *work = &dwork->work;
  1251. bool ret = false;
  1252. unsigned long flags;
  1253. /* read the comment in __queue_work() */
  1254. local_irq_save(flags);
  1255. if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
  1256. __queue_delayed_work(cpu, wq, dwork, delay);
  1257. ret = true;
  1258. }
  1259. local_irq_restore(flags);
  1260. return ret;
  1261. }
  1262. EXPORT_SYMBOL_GPL(queue_delayed_work_on);
  1263. /**
  1264. * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
  1265. * @cpu: CPU number to execute work on
  1266. * @wq: workqueue to use
  1267. * @dwork: work to queue
  1268. * @delay: number of jiffies to wait before queueing
  1269. *
  1270. * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
  1271. * modify @dwork's timer so that it expires after @delay. If @delay is
  1272. * zero, @work is guaranteed to be scheduled immediately regardless of its
  1273. * current state.
  1274. *
  1275. * Returns %false if @dwork was idle and queued, %true if @dwork was
  1276. * pending and its timer was modified.
  1277. *
  1278. * This function is safe to call from any context including IRQ handler.
  1279. * See try_to_grab_pending() for details.
  1280. */
  1281. bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
  1282. struct delayed_work *dwork, unsigned long delay)
  1283. {
  1284. unsigned long flags;
  1285. int ret;
  1286. do {
  1287. ret = try_to_grab_pending(&dwork->work, true, &flags);
  1288. } while (unlikely(ret == -EAGAIN));
  1289. if (likely(ret >= 0)) {
  1290. __queue_delayed_work(cpu, wq, dwork, delay);
  1291. local_irq_restore(flags);
  1292. }
  1293. /* -ENOENT from try_to_grab_pending() becomes %true */
  1294. return ret;
  1295. }
  1296. EXPORT_SYMBOL_GPL(mod_delayed_work_on);
  1297. /**
  1298. * worker_enter_idle - enter idle state
  1299. * @worker: worker which is entering idle state
  1300. *
  1301. * @worker is entering idle state. Update stats and idle timer if
  1302. * necessary.
  1303. *
  1304. * LOCKING:
  1305. * spin_lock_irq(pool->lock).
  1306. */
  1307. static void worker_enter_idle(struct worker *worker)
  1308. {
  1309. struct worker_pool *pool = worker->pool;
  1310. if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) ||
  1311. WARN_ON_ONCE(!list_empty(&worker->entry) &&
  1312. (worker->hentry.next || worker->hentry.pprev)))
  1313. return;
  1314. /* can't use worker_set_flags(), also called from start_worker() */
  1315. worker->flags |= WORKER_IDLE;
  1316. pool->nr_idle++;
  1317. worker->last_active = jiffies;
  1318. /* idle_list is LIFO */
  1319. list_add(&worker->entry, &pool->idle_list);
  1320. if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
  1321. mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
  1322. /*
  1323. * Sanity check nr_running. Because wq_unbind_fn() releases
  1324. * pool->lock between setting %WORKER_UNBOUND and zapping
  1325. * nr_running, the warning may trigger spuriously. Check iff
  1326. * unbind is not in progress.
  1327. */
  1328. WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
  1329. pool->nr_workers == pool->nr_idle &&
  1330. atomic_read(&pool->nr_running));
  1331. }
  1332. /**
  1333. * worker_leave_idle - leave idle state
  1334. * @worker: worker which is leaving idle state
  1335. *
  1336. * @worker is leaving idle state. Update stats.
  1337. *
  1338. * LOCKING:
  1339. * spin_lock_irq(pool->lock).
  1340. */
  1341. static void worker_leave_idle(struct worker *worker)
  1342. {
  1343. struct worker_pool *pool = worker->pool;
  1344. if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE)))
  1345. return;
  1346. worker_clr_flags(worker, WORKER_IDLE);
  1347. pool->nr_idle--;
  1348. list_del_init(&worker->entry);
  1349. }
  1350. /**
  1351. * worker_maybe_bind_and_lock - try to bind %current to worker_pool and lock it
  1352. * @pool: target worker_pool
  1353. *
  1354. * Bind %current to the cpu of @pool if it is associated and lock @pool.
  1355. *
  1356. * Works which are scheduled while the cpu is online must at least be
  1357. * scheduled to a worker which is bound to the cpu so that if they are
  1358. * flushed from cpu callbacks while cpu is going down, they are
  1359. * guaranteed to execute on the cpu.
  1360. *
  1361. * This function is to be used by unbound workers and rescuers to bind
  1362. * themselves to the target cpu and may race with cpu going down or
  1363. * coming online. kthread_bind() can't be used because it may put the
  1364. * worker to already dead cpu and set_cpus_allowed_ptr() can't be used
  1365. * verbatim as it's best effort and blocking and pool may be
  1366. * [dis]associated in the meantime.
  1367. *
  1368. * This function tries set_cpus_allowed() and locks pool and verifies the
  1369. * binding against %POOL_DISASSOCIATED which is set during
  1370. * %CPU_DOWN_PREPARE and cleared during %CPU_ONLINE, so if the worker
  1371. * enters idle state or fetches works without dropping lock, it can
  1372. * guarantee the scheduling requirement described in the first paragraph.
  1373. *
  1374. * CONTEXT:
  1375. * Might sleep. Called without any lock but returns with pool->lock
  1376. * held.
  1377. *
  1378. * RETURNS:
  1379. * %true if the associated pool is online (@worker is successfully
  1380. * bound), %false if offline.
  1381. */
  1382. static bool worker_maybe_bind_and_lock(struct worker_pool *pool)
  1383. __acquires(&pool->lock)
  1384. {
  1385. while (true) {
  1386. /*
  1387. * The following call may fail, succeed or succeed
  1388. * without actually migrating the task to the cpu if
  1389. * it races with cpu hotunplug operation. Verify
  1390. * against POOL_DISASSOCIATED.
  1391. */
  1392. if (!(pool->flags & POOL_DISASSOCIATED))
  1393. set_cpus_allowed_ptr(current, pool->attrs->cpumask);
  1394. spin_lock_irq(&pool->lock);
  1395. if (pool->flags & POOL_DISASSOCIATED)
  1396. return false;
  1397. if (task_cpu(current) == pool->cpu &&
  1398. cpumask_equal(&current->cpus_allowed, pool->attrs->cpumask))
  1399. return true;
  1400. spin_unlock_irq(&pool->lock);
  1401. /*
  1402. * We've raced with CPU hot[un]plug. Give it a breather
  1403. * and retry migration. cond_resched() is required here;
  1404. * otherwise, we might deadlock against cpu_stop trying to
  1405. * bring down the CPU on non-preemptive kernel.
  1406. */
  1407. cpu_relax();
  1408. cond_resched();
  1409. }
  1410. }
  1411. static struct worker *alloc_worker(void)
  1412. {
  1413. struct worker *worker;
  1414. worker = kzalloc(sizeof(*worker), GFP_KERNEL);
  1415. if (worker) {
  1416. INIT_LIST_HEAD(&worker->entry);
  1417. INIT_LIST_HEAD(&worker->scheduled);
  1418. /* on creation a worker is in !idle && prep state */
  1419. worker->flags = WORKER_PREP;
  1420. }
  1421. return worker;
  1422. }
  1423. /**
  1424. * create_worker - create a new workqueue worker
  1425. * @pool: pool the new worker will belong to
  1426. *
  1427. * Create a new worker which is bound to @pool. The returned worker
  1428. * can be started by calling start_worker() or destroyed using
  1429. * destroy_worker().
  1430. *
  1431. * CONTEXT:
  1432. * Might sleep. Does GFP_KERNEL allocations.
  1433. *
  1434. * RETURNS:
  1435. * Pointer to the newly created worker.
  1436. */
  1437. static struct worker *create_worker(struct worker_pool *pool)
  1438. {
  1439. struct worker *worker = NULL;
  1440. int id = -1;
  1441. char id_buf[16];
  1442. lockdep_assert_held(&pool->manager_mutex);
  1443. /*
  1444. * ID is needed to determine kthread name. Allocate ID first
  1445. * without installing the pointer.
  1446. */
  1447. idr_preload(GFP_KERNEL);
  1448. spin_lock_irq(&pool->lock);
  1449. id = idr_alloc(&pool->worker_idr, NULL, 0, 0, GFP_NOWAIT);
  1450. spin_unlock_irq(&pool->lock);
  1451. idr_preload_end();
  1452. if (id < 0)
  1453. goto fail;
  1454. worker = alloc_worker();
  1455. if (!worker)
  1456. goto fail;
  1457. worker->pool = pool;
  1458. worker->id = id;
  1459. if (pool->cpu >= 0)
  1460. snprintf(id_buf, sizeof(id_buf), "%d:%d%s", pool->cpu, id,
  1461. pool->attrs->nice < 0 ? "H" : "");
  1462. else
  1463. snprintf(id_buf, sizeof(id_buf), "u%d:%d", pool->id, id);
  1464. worker->task = kthread_create_on_node(worker_thread, worker, pool->node,
  1465. "kworker/%s", id_buf);
  1466. if (IS_ERR(worker->task))
  1467. goto fail;
  1468. /*
  1469. * set_cpus_allowed_ptr() will fail if the cpumask doesn't have any
  1470. * online CPUs. It'll be re-applied when any of the CPUs come up.
  1471. */
  1472. set_user_nice(worker->task, pool->attrs->nice);
  1473. set_cpus_allowed_ptr(worker->task, pool->attrs->cpumask);
  1474. /* prevent userland from meddling with cpumask of workqueue workers */
  1475. worker->task->flags |= PF_NO_SETAFFINITY;
  1476. /*
  1477. * The caller is responsible for ensuring %POOL_DISASSOCIATED
  1478. * remains stable across this function. See the comments above the
  1479. * flag definition for details.
  1480. */
  1481. if (pool->flags & POOL_DISASSOCIATED)
  1482. worker->flags |= WORKER_UNBOUND;
  1483. /* successful, commit the pointer to idr */
  1484. spin_lock_irq(&pool->lock);
  1485. idr_replace(&pool->worker_idr, worker, worker->id);
  1486. spin_unlock_irq(&pool->lock);
  1487. return worker;
  1488. fail:
  1489. if (id >= 0) {
  1490. spin_lock_irq(&pool->lock);
  1491. idr_remove(&pool->worker_idr, id);
  1492. spin_unlock_irq(&pool->lock);
  1493. }
  1494. kfree(worker);
  1495. return NULL;
  1496. }
  1497. /**
  1498. * start_worker - start a newly created worker
  1499. * @worker: worker to start
  1500. *
  1501. * Make the pool aware of @worker and start it.
  1502. *
  1503. * CONTEXT:
  1504. * spin_lock_irq(pool->lock).
  1505. */
  1506. static void start_worker(struct worker *worker)
  1507. {
  1508. worker->flags |= WORKER_STARTED;
  1509. worker->pool->nr_workers++;
  1510. worker_enter_idle(worker);
  1511. wake_up_process(worker->task);
  1512. }
  1513. /**
  1514. * create_and_start_worker - create and start a worker for a pool
  1515. * @pool: the target pool
  1516. *
  1517. * Grab the managership of @pool and create and start a new worker for it.
  1518. */
  1519. static int create_and_start_worker(struct worker_pool *pool)
  1520. {
  1521. struct worker *worker;
  1522. mutex_lock(&pool->manager_mutex);
  1523. worker = create_worker(pool);
  1524. if (worker) {
  1525. spin_lock_irq(&pool->lock);
  1526. start_worker(worker);
  1527. spin_unlock_irq(&pool->lock);
  1528. }
  1529. mutex_unlock(&pool->manager_mutex);
  1530. return worker ? 0 : -ENOMEM;
  1531. }
  1532. /**
  1533. * destroy_worker - destroy a workqueue worker
  1534. * @worker: worker to be destroyed
  1535. *
  1536. * Destroy @worker and adjust @pool stats accordingly.
  1537. *
  1538. * CONTEXT:
  1539. * spin_lock_irq(pool->lock) which is released and regrabbed.
  1540. */
  1541. static void destroy_worker(struct worker *worker)
  1542. {
  1543. struct worker_pool *pool = worker->pool;
  1544. lockdep_assert_held(&pool->manager_mutex);
  1545. lockdep_assert_held(&pool->lock);
  1546. /* sanity check frenzy */
  1547. if (WARN_ON(worker->current_work) ||
  1548. WARN_ON(!list_empty(&worker->scheduled)))
  1549. return;
  1550. if (worker->flags & WORKER_STARTED)
  1551. pool->nr_workers--;
  1552. if (worker->flags & WORKER_IDLE)
  1553. pool->nr_idle--;
  1554. list_del_init(&worker->entry);
  1555. worker->flags |= WORKER_DIE;
  1556. idr_remove(&pool->worker_idr, worker->id);
  1557. spin_unlock_irq(&pool->lock);
  1558. kthread_stop(worker->task);
  1559. kfree(worker);
  1560. spin_lock_irq(&pool->lock);
  1561. }
  1562. static void idle_worker_timeout(unsigned long __pool)
  1563. {
  1564. struct worker_pool *pool = (void *)__pool;
  1565. spin_lock_irq(&pool->lock);
  1566. if (too_many_workers(pool)) {
  1567. struct worker *worker;
  1568. unsigned long expires;
  1569. /* idle_list is kept in LIFO order, check the last one */
  1570. worker = list_entry(pool->idle_list.prev, struct worker, entry);
  1571. expires = worker->last_active + IDLE_WORKER_TIMEOUT;
  1572. if (time_before(jiffies, expires))
  1573. mod_timer(&pool->idle_timer, expires);
  1574. else {
  1575. /* it's been idle for too long, wake up manager */
  1576. pool->flags |= POOL_MANAGE_WORKERS;
  1577. wake_up_worker(pool);
  1578. }
  1579. }
  1580. spin_unlock_irq(&pool->lock);
  1581. }
  1582. static void send_mayday(struct work_struct *work)
  1583. {
  1584. struct pool_workqueue *pwq = get_work_pwq(work);
  1585. struct workqueue_struct *wq = pwq->wq;
  1586. lockdep_assert_held(&wq_mayday_lock);
  1587. if (!wq->rescuer)
  1588. return;
  1589. /* mayday mayday mayday */
  1590. if (list_empty(&pwq->mayday_node)) {
  1591. list_add_tail(&pwq->mayday_node, &wq->maydays);
  1592. wake_up_process(wq->rescuer->task);
  1593. }
  1594. }
  1595. static void pool_mayday_timeout(unsigned long __pool)
  1596. {
  1597. struct worker_pool *pool = (void *)__pool;
  1598. struct work_struct *work;
  1599. spin_lock_irq(&wq_mayday_lock); /* for wq->maydays */
  1600. spin_lock(&pool->lock);
  1601. if (need_to_create_worker(pool)) {
  1602. /*
  1603. * We've been trying to create a new worker but
  1604. * haven't been successful. We might be hitting an
  1605. * allocation deadlock. Send distress signals to
  1606. * rescuers.
  1607. */
  1608. list_for_each_entry(work, &pool->worklist, entry)
  1609. send_mayday(work);
  1610. }
  1611. spin_unlock(&pool->lock);
  1612. spin_unlock_irq(&wq_mayday_lock);
  1613. mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
  1614. }
  1615. /**
  1616. * maybe_create_worker - create a new worker if necessary
  1617. * @pool: pool to create a new worker for
  1618. *
  1619. * Create a new worker for @pool if necessary. @pool is guaranteed to
  1620. * have at least one idle worker on return from this function. If
  1621. * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
  1622. * sent to all rescuers with works scheduled on @pool to resolve
  1623. * possible allocation deadlock.
  1624. *
  1625. * On return, need_to_create_worker() is guaranteed to be %false and
  1626. * may_start_working() %true.
  1627. *
  1628. * LOCKING:
  1629. * spin_lock_irq(pool->lock) which may be released and regrabbed
  1630. * multiple times. Does GFP_KERNEL allocations. Called only from
  1631. * manager.
  1632. *
  1633. * RETURNS:
  1634. * %false if no action was taken and pool->lock stayed locked, %true
  1635. * otherwise.
  1636. */
  1637. static bool maybe_create_worker(struct worker_pool *pool)
  1638. __releases(&pool->lock)
  1639. __acquires(&pool->lock)
  1640. {
  1641. if (!need_to_create_worker(pool))
  1642. return false;
  1643. restart:
  1644. spin_unlock_irq(&pool->lock);
  1645. /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
  1646. mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
  1647. while (true) {
  1648. struct worker *worker;
  1649. worker = create_worker(pool);
  1650. if (worker) {
  1651. del_timer_sync(&pool->mayday_timer);
  1652. spin_lock_irq(&pool->lock);
  1653. start_worker(worker);
  1654. if (WARN_ON_ONCE(need_to_create_worker(pool)))
  1655. goto restart;
  1656. return true;
  1657. }
  1658. if (!need_to_create_worker(pool))
  1659. break;
  1660. __set_current_state(TASK_INTERRUPTIBLE);
  1661. schedule_timeout(CREATE_COOLDOWN);
  1662. if (!need_to_create_worker(pool))
  1663. break;
  1664. }
  1665. del_timer_sync(&pool->mayday_timer);
  1666. spin_lock_irq(&pool->lock);
  1667. if (need_to_create_worker(pool))
  1668. goto restart;
  1669. return true;
  1670. }
  1671. /**
  1672. * maybe_destroy_worker - destroy workers which have been idle for a while
  1673. * @pool: pool to destroy workers for
  1674. *
  1675. * Destroy @pool workers which have been idle for longer than
  1676. * IDLE_WORKER_TIMEOUT.
  1677. *
  1678. * LOCKING:
  1679. * spin_lock_irq(pool->lock) which may be released and regrabbed
  1680. * multiple times. Called only from manager.
  1681. *
  1682. * RETURNS:
  1683. * %false if no action was taken and pool->lock stayed locked, %true
  1684. * otherwise.
  1685. */
  1686. static bool maybe_destroy_workers(struct worker_pool *pool)
  1687. {
  1688. bool ret = false;
  1689. while (too_many_workers(pool)) {
  1690. struct worker *worker;
  1691. unsigned long expires;
  1692. worker = list_entry(pool->idle_list.prev, struct worker, entry);
  1693. expires = worker->last_active + IDLE_WORKER_TIMEOUT;
  1694. if (time_before(jiffies, expires)) {
  1695. mod_timer(&pool->idle_timer, expires);
  1696. break;
  1697. }
  1698. destroy_worker(worker);
  1699. ret = true;
  1700. }
  1701. return ret;
  1702. }
  1703. /**
  1704. * manage_workers - manage worker pool
  1705. * @worker: self
  1706. *
  1707. * Assume the manager role and manage the worker pool @worker belongs
  1708. * to. At any given time, there can be only zero or one manager per
  1709. * pool. The exclusion is handled automatically by this function.
  1710. *
  1711. * The caller can safely start processing works on false return. On
  1712. * true return, it's guaranteed that need_to_create_worker() is false
  1713. * and may_start_working() is true.
  1714. *
  1715. * CONTEXT:
  1716. * spin_lock_irq(pool->lock) which may be released and regrabbed
  1717. * multiple times. Does GFP_KERNEL allocations.
  1718. *
  1719. * RETURNS:
  1720. * spin_lock_irq(pool->lock) which may be released and regrabbed
  1721. * multiple times. Does GFP_KERNEL allocations.
  1722. */
  1723. static bool manage_workers(struct worker *worker)
  1724. {
  1725. struct worker_pool *pool = worker->pool;
  1726. bool ret = false;
  1727. /*
  1728. * Managership is governed by two mutexes - manager_arb and
  1729. * manager_mutex. manager_arb handles arbitration of manager role.
  1730. * Anyone who successfully grabs manager_arb wins the arbitration
  1731. * and becomes the manager. mutex_trylock() on pool->manager_arb
  1732. * failure while holding pool->lock reliably indicates that someone
  1733. * else is managing the pool and the worker which failed trylock
  1734. * can proceed to executing work items. This means that anyone
  1735. * grabbing manager_arb is responsible for actually performing
  1736. * manager duties. If manager_arb is grabbed and released without
  1737. * actual management, the pool may stall indefinitely.
  1738. *
  1739. * manager_mutex is used for exclusion of actual management
  1740. * operations. The holder of manager_mutex can be sure that none
  1741. * of management operations, including creation and destruction of
  1742. * workers, won't take place until the mutex is released. Because
  1743. * manager_mutex doesn't interfere with manager role arbitration,
  1744. * it is guaranteed that the pool's management, while may be
  1745. * delayed, won't be disturbed by someone else grabbing
  1746. * manager_mutex.
  1747. */
  1748. if (!mutex_trylock(&pool->manager_arb))
  1749. return ret;
  1750. /*
  1751. * With manager arbitration won, manager_mutex would be free in
  1752. * most cases. trylock first without dropping @pool->lock.
  1753. */
  1754. if (unlikely(!mutex_trylock(&pool->manager_mutex))) {
  1755. spin_unlock_irq(&pool->lock);
  1756. mutex_lock(&pool->manager_mutex);
  1757. ret = true;
  1758. }
  1759. pool->flags &= ~POOL_MANAGE_WORKERS;
  1760. /*
  1761. * Destroy and then create so that may_start_working() is true
  1762. * on return.
  1763. */
  1764. ret |= maybe_destroy_workers(pool);
  1765. ret |= maybe_create_worker(pool);
  1766. mutex_unlock(&pool->manager_mutex);
  1767. mutex_unlock(&pool->manager_arb);
  1768. return ret;
  1769. }
  1770. /**
  1771. * process_one_work - process single work
  1772. * @worker: self
  1773. * @work: work to process
  1774. *
  1775. * Process @work. This function contains all the logics necessary to
  1776. * process a single work including synchronization against and
  1777. * interaction with other workers on the same cpu, queueing and
  1778. * flushing. As long as context requirement is met, any worker can
  1779. * call this function to process a work.
  1780. *
  1781. * CONTEXT:
  1782. * spin_lock_irq(pool->lock) which is released and regrabbed.
  1783. */
  1784. static void process_one_work(struct worker *worker, struct work_struct *work)
  1785. __releases(&pool->lock)
  1786. __acquires(&pool->lock)
  1787. {
  1788. struct pool_workqueue *pwq = get_work_pwq(work);
  1789. struct worker_pool *pool = worker->pool;
  1790. bool cpu_intensive = pwq->wq->flags & WQ_CPU_INTENSIVE;
  1791. int work_color;
  1792. struct worker *collision;
  1793. #ifdef CONFIG_LOCKDEP
  1794. /*
  1795. * It is permissible to free the struct work_struct from
  1796. * inside the function that is called from it, this we need to
  1797. * take into account for lockdep too. To avoid bogus "held
  1798. * lock freed" warnings as well as problems when looking into
  1799. * work->lockdep_map, make a copy and use that here.
  1800. */
  1801. struct lockdep_map lockdep_map;
  1802. lockdep_copy_map(&lockdep_map, &work->lockdep_map);
  1803. #endif
  1804. /*
  1805. * Ensure we're on the correct CPU. DISASSOCIATED test is
  1806. * necessary to avoid spurious warnings from rescuers servicing the
  1807. * unbound or a disassociated pool.
  1808. */
  1809. WARN_ON_ONCE(!(worker->flags & WORKER_UNBOUND) &&
  1810. !(pool->flags & POOL_DISASSOCIATED) &&
  1811. raw_smp_processor_id() != pool->cpu);
  1812. /*
  1813. * A single work shouldn't be executed concurrently by
  1814. * multiple workers on a single cpu. Check whether anyone is
  1815. * already processing the work. If so, defer the work to the
  1816. * currently executing one.
  1817. */
  1818. collision = find_worker_executing_work(pool, work);
  1819. if (unlikely(collision)) {
  1820. move_linked_works(work, &collision->scheduled, NULL);
  1821. return;
  1822. }
  1823. /* claim and dequeue */
  1824. debug_work_deactivate(work);
  1825. hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work);
  1826. worker->current_work = work;
  1827. worker->current_func = work->func;
  1828. worker->current_pwq = pwq;
  1829. work_color = get_work_color(work);
  1830. list_del_init(&work->entry);
  1831. /*
  1832. * CPU intensive works don't participate in concurrency
  1833. * management. They're the scheduler's responsibility.
  1834. */
  1835. if (unlikely(cpu_intensive))
  1836. worker_set_flags(worker, WORKER_CPU_INTENSIVE, true);
  1837. /*
  1838. * Unbound pool isn't concurrency managed and work items should be
  1839. * executed ASAP. Wake up another worker if necessary.
  1840. */
  1841. if ((worker->flags & WORKER_UNBOUND) && need_more_worker(pool))
  1842. wake_up_worker(pool);
  1843. /*
  1844. * Record the last pool and clear PENDING which should be the last
  1845. * update to @work. Also, do this inside @pool->lock so that
  1846. * PENDING and queued state changes happen together while IRQ is
  1847. * disabled.
  1848. */
  1849. set_work_pool_and_clear_pending(work, pool->id);
  1850. spin_unlock_irq(&pool->lock);
  1851. lock_map_acquire_read(&pwq->wq->lockdep_map);
  1852. lock_map_acquire(&lockdep_map);
  1853. trace_workqueue_execute_start(work);
  1854. worker->current_func(work);
  1855. /*
  1856. * While we must be careful to not use "work" after this, the trace
  1857. * point will only record its address.
  1858. */
  1859. trace_workqueue_execute_end(work);
  1860. lock_map_release(&lockdep_map);
  1861. lock_map_release(&pwq->wq->lockdep_map);
  1862. if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
  1863. pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
  1864. " last function: %pf\n",
  1865. current->comm, preempt_count(), task_pid_nr(current),
  1866. worker->current_func);
  1867. debug_show_held_locks(current);
  1868. dump_stack();
  1869. }
  1870. spin_lock_irq(&pool->lock);
  1871. /* clear cpu intensive status */
  1872. if (unlikely(cpu_intensive))
  1873. worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
  1874. /* we're done with it, release */
  1875. hash_del(&worker->hentry);
  1876. worker->current_work = NULL;
  1877. worker->current_func = NULL;
  1878. worker->current_pwq = NULL;
  1879. pwq_dec_nr_in_flight(pwq, work_color);
  1880. }
  1881. /**
  1882. * process_scheduled_works - process scheduled works
  1883. * @worker: self
  1884. *
  1885. * Process all scheduled works. Please note that the scheduled list
  1886. * may change while processing a work, so this function repeatedly
  1887. * fetches a work from the top and executes it.
  1888. *
  1889. * CONTEXT:
  1890. * spin_lock_irq(pool->lock) which may be released and regrabbed
  1891. * multiple times.
  1892. */
  1893. static void process_scheduled_works(struct worker *worker)
  1894. {
  1895. while (!list_empty(&worker->scheduled)) {
  1896. struct work_struct *work = list_first_entry(&worker->scheduled,
  1897. struct work_struct, entry);
  1898. process_one_work(worker, work);
  1899. }
  1900. }
  1901. /**
  1902. * worker_thread - the worker thread function
  1903. * @__worker: self
  1904. *
  1905. * The worker thread function. All workers belong to a worker_pool -
  1906. * either a per-cpu one or dynamic unbound one. These workers process all
  1907. * work items regardless of their specific target workqueue. The only
  1908. * exception is work items which belong to workqueues with a rescuer which
  1909. * will be explained in rescuer_thread().
  1910. */
  1911. static int worker_thread(void *__worker)
  1912. {
  1913. struct worker *worker = __worker;
  1914. struct worker_pool *pool = worker->pool;
  1915. /* tell the scheduler that this is a workqueue worker */
  1916. worker->task->flags |= PF_WQ_WORKER;
  1917. woke_up:
  1918. spin_lock_irq(&pool->lock);
  1919. /* am I supposed to die? */
  1920. if (unlikely(worker->flags & WORKER_DIE)) {
  1921. spin_unlock_irq(&pool->lock);
  1922. WARN_ON_ONCE(!list_empty(&worker->entry));
  1923. worker->task->flags &= ~PF_WQ_WORKER;
  1924. return 0;
  1925. }
  1926. worker_leave_idle(worker);
  1927. recheck:
  1928. /* no more worker necessary? */
  1929. if (!need_more_worker(pool))
  1930. goto sleep;
  1931. /* do we need to manage? */
  1932. if (unlikely(!may_start_working(pool)) && manage_workers(worker))
  1933. goto recheck;
  1934. /*
  1935. * ->scheduled list can only be filled while a worker is
  1936. * preparing to process a work or actually processing it.
  1937. * Make sure nobody diddled with it while I was sleeping.
  1938. */
  1939. WARN_ON_ONCE(!list_empty(&worker->scheduled));
  1940. /*
  1941. * Finish PREP stage. We're guaranteed to have at least one idle
  1942. * worker or that someone else has already assumed the manager
  1943. * role. This is where @worker starts participating in concurrency
  1944. * management if applicable and concurrency management is restored
  1945. * after being rebound. See rebind_workers() for details.
  1946. */
  1947. worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND);
  1948. do {
  1949. struct work_struct *work =
  1950. list_first_entry(&pool->worklist,
  1951. struct work_struct, entry);
  1952. if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
  1953. /* optimization path, not strictly necessary */
  1954. process_one_work(worker, work);
  1955. if (unlikely(!list_empty(&worker->scheduled)))
  1956. process_scheduled_works(worker);
  1957. } else {
  1958. move_linked_works(work, &worker->scheduled, NULL);
  1959. process_scheduled_works(worker);
  1960. }
  1961. } while (keep_working(pool));
  1962. worker_set_flags(worker, WORKER_PREP, false);
  1963. sleep:
  1964. if (unlikely(need_to_manage_workers(pool)) && manage_workers(worker))
  1965. goto recheck;
  1966. /*
  1967. * pool->lock is held and there's no work to process and no need to
  1968. * manage, sleep. Workers are woken up only while holding
  1969. * pool->lock or from local cpu, so setting the current state
  1970. * before releasing pool->lock is enough to prevent losing any
  1971. * event.
  1972. */
  1973. worker_enter_idle(worker);
  1974. __set_current_state(TASK_INTERRUPTIBLE);
  1975. spin_unlock_irq(&pool->lock);
  1976. schedule();
  1977. goto woke_up;
  1978. }
  1979. /**
  1980. * rescuer_thread - the rescuer thread function
  1981. * @__rescuer: self
  1982. *
  1983. * Workqueue rescuer thread function. There's one rescuer for each
  1984. * workqueue which has WQ_MEM_RECLAIM set.
  1985. *
  1986. * Regular work processing on a pool may block trying to create a new
  1987. * worker which uses GFP_KERNEL allocation which has slight chance of
  1988. * developing into deadlock if some works currently on the same queue
  1989. * need to be processed to satisfy the GFP_KERNEL allocation. This is
  1990. * the problem rescuer solves.
  1991. *
  1992. * When such condition is possible, the pool summons rescuers of all
  1993. * workqueues which have works queued on the pool and let them process
  1994. * those works so that forward progress can be guaranteed.
  1995. *
  1996. * This should happen rarely.
  1997. */
  1998. static int rescuer_thread(void *__rescuer)
  1999. {
  2000. struct worker *rescuer = __rescuer;
  2001. struct workqueue_struct *wq = rescuer->rescue_wq;
  2002. struct list_head *scheduled = &rescuer->scheduled;
  2003. set_user_nice(current, RESCUER_NICE_LEVEL);
  2004. /*
  2005. * Mark rescuer as worker too. As WORKER_PREP is never cleared, it
  2006. * doesn't participate in concurrency management.
  2007. */
  2008. rescuer->task->flags |= PF_WQ_WORKER;
  2009. repeat:
  2010. set_current_state(TASK_INTERRUPTIBLE);
  2011. if (kthread_should_stop()) {
  2012. __set_current_state(TASK_RUNNING);
  2013. rescuer->task->flags &= ~PF_WQ_WORKER;
  2014. return 0;
  2015. }
  2016. /* see whether any pwq is asking for help */
  2017. spin_lock_irq(&wq_mayday_lock);
  2018. while (!list_empty(&wq->maydays)) {
  2019. struct pool_workqueue *pwq = list_first_entry(&wq->maydays,
  2020. struct pool_workqueue, mayday_node);
  2021. struct worker_pool *pool = pwq->pool;
  2022. struct work_struct *work, *n;
  2023. __set_current_state(TASK_RUNNING);
  2024. list_del_init(&pwq->mayday_node);
  2025. spin_unlock_irq(&wq_mayday_lock);
  2026. /* migrate to the target cpu if possible */
  2027. worker_maybe_bind_and_lock(pool);
  2028. rescuer->pool = pool;
  2029. /*
  2030. * Slurp in all works issued via this workqueue and
  2031. * process'em.
  2032. */
  2033. WARN_ON_ONCE(!list_empty(&rescuer->scheduled));
  2034. list_for_each_entry_safe(work, n, &pool->worklist, entry)
  2035. if (get_work_pwq(work) == pwq)
  2036. move_linked_works(work, scheduled, &n);
  2037. process_scheduled_works(rescuer);
  2038. /*
  2039. * Leave this pool. If keep_working() is %true, notify a
  2040. * regular worker; otherwise, we end up with 0 concurrency
  2041. * and stalling the execution.
  2042. */
  2043. if (keep_working(pool))
  2044. wake_up_worker(pool);
  2045. rescuer->pool = NULL;
  2046. spin_unlock(&pool->lock);
  2047. spin_lock(&wq_mayday_lock);
  2048. }
  2049. spin_unlock_irq(&wq_mayday_lock);
  2050. /* rescuers should never participate in concurrency management */
  2051. WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING));
  2052. schedule();
  2053. goto repeat;
  2054. }
  2055. struct wq_barrier {
  2056. struct work_struct work;
  2057. struct completion done;
  2058. };
  2059. static void wq_barrier_func(struct work_struct *work)
  2060. {
  2061. struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
  2062. complete(&barr->done);
  2063. }
  2064. /**
  2065. * insert_wq_barrier - insert a barrier work
  2066. * @pwq: pwq to insert barrier into
  2067. * @barr: wq_barrier to insert
  2068. * @target: target work to attach @barr to
  2069. * @worker: worker currently executing @target, NULL if @target is not executing
  2070. *
  2071. * @barr is linked to @target such that @barr is completed only after
  2072. * @target finishes execution. Please note that the ordering
  2073. * guarantee is observed only with respect to @target and on the local
  2074. * cpu.
  2075. *
  2076. * Currently, a queued barrier can't be canceled. This is because
  2077. * try_to_grab_pending() can't determine whether the work to be
  2078. * grabbed is at the head of the queue and thus can't clear LINKED
  2079. * flag of the previous work while there must be a valid next work
  2080. * after a work with LINKED flag set.
  2081. *
  2082. * Note that when @worker is non-NULL, @target may be modified
  2083. * underneath us, so we can't reliably determine pwq from @target.
  2084. *
  2085. * CONTEXT:
  2086. * spin_lock_irq(pool->lock).
  2087. */
  2088. static void insert_wq_barrier(struct pool_workqueue *pwq,
  2089. struct wq_barrier *barr,
  2090. struct work_struct *target, struct worker *worker)
  2091. {
  2092. struct list_head *head;
  2093. unsigned int linked = 0;
  2094. /*
  2095. * debugobject calls are safe here even with pool->lock locked
  2096. * as we know for sure that this will not trigger any of the
  2097. * checks and call back into the fixup functions where we
  2098. * might deadlock.
  2099. */
  2100. INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
  2101. __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
  2102. init_completion(&barr->done);
  2103. /*
  2104. * If @target is currently being executed, schedule the
  2105. * barrier to the worker; otherwise, put it after @target.
  2106. */
  2107. if (worker)
  2108. head = worker->scheduled.next;
  2109. else {
  2110. unsigned long *bits = work_data_bits(target);
  2111. head = target->entry.next;
  2112. /* there can already be other linked works, inherit and set */
  2113. linked = *bits & WORK_STRUCT_LINKED;
  2114. __set_bit(WORK_STRUCT_LINKED_BIT, bits);
  2115. }
  2116. debug_work_activate(&barr->work);
  2117. insert_work(pwq, &barr->work, head,
  2118. work_color_to_flags(WORK_NO_COLOR) | linked);
  2119. }
  2120. /**
  2121. * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing
  2122. * @wq: workqueue being flushed
  2123. * @flush_color: new flush color, < 0 for no-op
  2124. * @work_color: new work color, < 0 for no-op
  2125. *
  2126. * Prepare pwqs for workqueue flushing.
  2127. *
  2128. * If @flush_color is non-negative, flush_color on all pwqs should be
  2129. * -1. If no pwq has in-flight commands at the specified color, all
  2130. * pwq->flush_color's stay at -1 and %false is returned. If any pwq
  2131. * has in flight commands, its pwq->flush_color is set to
  2132. * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq
  2133. * wakeup logic is armed and %true is returned.
  2134. *
  2135. * The caller should have initialized @wq->first_flusher prior to
  2136. * calling this function with non-negative @flush_color. If
  2137. * @flush_color is negative, no flush color update is done and %false
  2138. * is returned.
  2139. *
  2140. * If @work_color is non-negative, all pwqs should have the same
  2141. * work_color which is previous to @work_color and all will be
  2142. * advanced to @work_color.
  2143. *
  2144. * CONTEXT:
  2145. * mutex_lock(wq->mutex).
  2146. *
  2147. * RETURNS:
  2148. * %true if @flush_color >= 0 and there's something to flush. %false
  2149. * otherwise.
  2150. */
  2151. static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq,
  2152. int flush_color, int work_color)
  2153. {
  2154. bool wait = false;
  2155. struct pool_workqueue *pwq;
  2156. if (flush_color >= 0) {
  2157. WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush));
  2158. atomic_set(&wq->nr_pwqs_to_flush, 1);
  2159. }
  2160. for_each_pwq(pwq, wq) {
  2161. struct worker_pool *pool = pwq->pool;
  2162. spin_lock_irq(&pool->lock);
  2163. if (flush_color >= 0) {
  2164. WARN_ON_ONCE(pwq->flush_color != -1);
  2165. if (pwq->nr_in_flight[flush_color]) {
  2166. pwq->flush_color = flush_color;
  2167. atomic_inc(&wq->nr_pwqs_to_flush);
  2168. wait = true;
  2169. }
  2170. }
  2171. if (work_color >= 0) {
  2172. WARN_ON_ONCE(work_color != work_next_color(pwq->work_color));
  2173. pwq->work_color = work_color;
  2174. }
  2175. spin_unlock_irq(&pool->lock);
  2176. }
  2177. if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush))
  2178. complete(&wq->first_flusher->done);
  2179. return wait;
  2180. }
  2181. /**
  2182. * flush_workqueue - ensure that any scheduled work has run to completion.
  2183. * @wq: workqueue to flush
  2184. *
  2185. * This function sleeps until all work items which were queued on entry
  2186. * have finished execution, but it is not livelocked by new incoming ones.
  2187. */
  2188. void flush_workqueue(struct workqueue_struct *wq)
  2189. {
  2190. struct wq_flusher this_flusher = {
  2191. .list = LIST_HEAD_INIT(this_flusher.list),
  2192. .flush_color = -1,
  2193. .done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
  2194. };
  2195. int next_color;
  2196. lock_map_acquire(&wq->lockdep_map);
  2197. lock_map_release(&wq->lockdep_map);
  2198. mutex_lock(&wq->mutex);
  2199. /*
  2200. * Start-to-wait phase
  2201. */
  2202. next_color = work_next_color(wq->work_color);
  2203. if (next_color != wq->flush_color) {
  2204. /*
  2205. * Color space is not full. The current work_color
  2206. * becomes our flush_color and work_color is advanced
  2207. * by one.
  2208. */
  2209. WARN_ON_ONCE(!list_empty(&wq->flusher_overflow));
  2210. this_flusher.flush_color = wq->work_color;
  2211. wq->work_color = next_color;
  2212. if (!wq->first_flusher) {
  2213. /* no flush in progress, become the first flusher */
  2214. WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
  2215. wq->first_flusher = &this_flusher;
  2216. if (!flush_workqueue_prep_pwqs(wq, wq->flush_color,
  2217. wq->work_color)) {
  2218. /* nothing to flush, done */
  2219. wq->flush_color = next_color;
  2220. wq->first_flusher = NULL;
  2221. goto out_unlock;
  2222. }
  2223. } else {
  2224. /* wait in queue */
  2225. WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color);
  2226. list_add_tail(&this_flusher.list, &wq->flusher_queue);
  2227. flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
  2228. }
  2229. } else {
  2230. /*
  2231. * Oops, color space is full, wait on overflow queue.
  2232. * The next flush completion will assign us
  2233. * flush_color and transfer to flusher_queue.
  2234. */
  2235. list_add_tail(&this_flusher.list, &wq->flusher_overflow);
  2236. }
  2237. mutex_unlock(&wq->mutex);
  2238. wait_for_completion(&this_flusher.done);
  2239. /*
  2240. * Wake-up-and-cascade phase
  2241. *
  2242. * First flushers are responsible for cascading flushes and
  2243. * handling overflow. Non-first flushers can simply return.
  2244. */
  2245. if (wq->first_flusher != &this_flusher)
  2246. return;
  2247. mutex_lock(&wq->mutex);
  2248. /* we might have raced, check again with mutex held */
  2249. if (wq->first_flusher != &this_flusher)
  2250. goto out_unlock;
  2251. wq->first_flusher = NULL;
  2252. WARN_ON_ONCE(!list_empty(&this_flusher.list));
  2253. WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
  2254. while (true) {
  2255. struct wq_flusher *next, *tmp;
  2256. /* complete all the flushers sharing the current flush color */
  2257. list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
  2258. if (next->flush_color != wq->flush_color)
  2259. break;
  2260. list_del_init(&next->list);
  2261. complete(&next->done);
  2262. }
  2263. WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) &&
  2264. wq->flush_color != work_next_color(wq->work_color));
  2265. /* this flush_color is finished, advance by one */
  2266. wq->flush_color = work_next_color(wq->flush_color);
  2267. /* one color has been freed, handle overflow queue */
  2268. if (!list_empty(&wq->flusher_overflow)) {
  2269. /*
  2270. * Assign the same color to all overflowed
  2271. * flushers, advance work_color and append to
  2272. * flusher_queue. This is the start-to-wait
  2273. * phase for these overflowed flushers.
  2274. */
  2275. list_for_each_entry(tmp, &wq->flusher_overflow, list)
  2276. tmp->flush_color = wq->work_color;
  2277. wq->work_color = work_next_color(wq->work_color);
  2278. list_splice_tail_init(&wq->flusher_overflow,
  2279. &wq->flusher_queue);
  2280. flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
  2281. }
  2282. if (list_empty(&wq->flusher_queue)) {
  2283. WARN_ON_ONCE(wq->flush_color != wq->work_color);
  2284. break;
  2285. }
  2286. /*
  2287. * Need to flush more colors. Make the next flusher
  2288. * the new first flusher and arm pwqs.
  2289. */
  2290. WARN_ON_ONCE(wq->flush_color == wq->work_color);
  2291. WARN_ON_ONCE(wq->flush_color != next->flush_color);
  2292. list_del_init(&next->list);
  2293. wq->first_flusher = next;
  2294. if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1))
  2295. break;
  2296. /*
  2297. * Meh... this color is already done, clear first
  2298. * flusher and repeat cascading.
  2299. */
  2300. wq->first_flusher = NULL;
  2301. }
  2302. out_unlock:
  2303. mutex_unlock(&wq->mutex);
  2304. }
  2305. EXPORT_SYMBOL_GPL(flush_workqueue);
  2306. /**
  2307. * drain_workqueue - drain a workqueue
  2308. * @wq: workqueue to drain
  2309. *
  2310. * Wait until the workqueue becomes empty. While draining is in progress,
  2311. * only chain queueing is allowed. IOW, only currently pending or running
  2312. * work items on @wq can queue further work items on it. @wq is flushed
  2313. * repeatedly until it becomes empty. The number of flushing is detemined
  2314. * by the depth of chaining and should be relatively short. Whine if it
  2315. * takes too long.
  2316. */
  2317. void drain_workqueue(struct workqueue_struct *wq)
  2318. {
  2319. unsigned int flush_cnt = 0;
  2320. struct pool_workqueue *pwq;
  2321. /*
  2322. * __queue_work() needs to test whether there are drainers, is much
  2323. * hotter than drain_workqueue() and already looks at @wq->flags.
  2324. * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers.
  2325. */
  2326. mutex_lock(&wq->mutex);
  2327. if (!wq->nr_drainers++)
  2328. wq->flags |= __WQ_DRAINING;
  2329. mutex_unlock(&wq->mutex);
  2330. reflush:
  2331. flush_workqueue(wq);
  2332. mutex_lock(&wq->mutex);
  2333. for_each_pwq(pwq, wq) {
  2334. bool drained;
  2335. spin_lock_irq(&pwq->pool->lock);
  2336. drained = !pwq->nr_active && list_empty(&pwq->delayed_works);
  2337. spin_unlock_irq(&pwq->pool->lock);
  2338. if (drained)
  2339. continue;
  2340. if (++flush_cnt == 10 ||
  2341. (flush_cnt % 100 == 0 && flush_cnt <= 1000))
  2342. pr_warn("workqueue %s: drain_workqueue() isn't complete after %u tries\n",
  2343. wq->name, flush_cnt);
  2344. mutex_unlock(&wq->mutex);
  2345. goto reflush;
  2346. }
  2347. if (!--wq->nr_drainers)
  2348. wq->flags &= ~__WQ_DRAINING;
  2349. mutex_unlock(&wq->mutex);
  2350. }
  2351. EXPORT_SYMBOL_GPL(drain_workqueue);
  2352. static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr)
  2353. {
  2354. struct worker *worker = NULL;
  2355. struct worker_pool *pool;
  2356. struct pool_workqueue *pwq;
  2357. might_sleep();
  2358. local_irq_disable();
  2359. pool = get_work_pool(work);
  2360. if (!pool) {
  2361. local_irq_enable();
  2362. return false;
  2363. }
  2364. spin_lock(&pool->lock);
  2365. /* see the comment in try_to_grab_pending() with the same code */
  2366. pwq = get_work_pwq(work);
  2367. if (pwq) {
  2368. if (unlikely(pwq->pool != pool))
  2369. goto already_gone;
  2370. } else {
  2371. worker = find_worker_executing_work(pool, work);
  2372. if (!worker)
  2373. goto already_gone;
  2374. pwq = worker->current_pwq;
  2375. }
  2376. insert_wq_barrier(pwq, barr, work, worker);
  2377. spin_unlock_irq(&pool->lock);
  2378. /*
  2379. * If @max_active is 1 or rescuer is in use, flushing another work
  2380. * item on the same workqueue may lead to deadlock. Make sure the
  2381. * flusher is not running on the same workqueue by verifying write
  2382. * access.
  2383. */
  2384. if (pwq->wq->saved_max_active == 1 || pwq->wq->rescuer)
  2385. lock_map_acquire(&pwq->wq->lockdep_map);
  2386. else
  2387. lock_map_acquire_read(&pwq->wq->lockdep_map);
  2388. lock_map_release(&pwq->wq->lockdep_map);
  2389. return true;
  2390. already_gone:
  2391. spin_unlock_irq(&pool->lock);
  2392. return false;
  2393. }
  2394. /**
  2395. * flush_work - wait for a work to finish executing the last queueing instance
  2396. * @work: the work to flush
  2397. *
  2398. * Wait until @work has finished execution. @work is guaranteed to be idle
  2399. * on return if it hasn't been requeued since flush started.
  2400. *
  2401. * RETURNS:
  2402. * %true if flush_work() waited for the work to finish execution,
  2403. * %false if it was already idle.
  2404. */
  2405. bool flush_work(struct work_struct *work)
  2406. {
  2407. struct wq_barrier barr;
  2408. lock_map_acquire(&work->lockdep_map);
  2409. lock_map_release(&work->lockdep_map);
  2410. if (start_flush_work(work, &barr)) {
  2411. wait_for_completion(&barr.done);
  2412. destroy_work_on_stack(&barr.work);
  2413. return true;
  2414. } else {
  2415. return false;
  2416. }
  2417. }
  2418. EXPORT_SYMBOL_GPL(flush_work);
  2419. static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
  2420. {
  2421. unsigned long flags;
  2422. int ret;
  2423. do {
  2424. ret = try_to_grab_pending(work, is_dwork, &flags);
  2425. /*
  2426. * If someone else is canceling, wait for the same event it
  2427. * would be waiting for before retrying.
  2428. */
  2429. if (unlikely(ret == -ENOENT))
  2430. flush_work(work);
  2431. } while (unlikely(ret < 0));
  2432. /* tell other tasks trying to grab @work to back off */
  2433. mark_work_canceling(work);
  2434. local_irq_restore(flags);
  2435. flush_work(work);
  2436. clear_work_data(work);
  2437. return ret;
  2438. }
  2439. /**
  2440. * cancel_work_sync - cancel a work and wait for it to finish
  2441. * @work: the work to cancel
  2442. *
  2443. * Cancel @work and wait for its execution to finish. This function
  2444. * can be used even if the work re-queues itself or migrates to
  2445. * another workqueue. On return from this function, @work is
  2446. * guaranteed to be not pending or executing on any CPU.
  2447. *
  2448. * cancel_work_sync(&delayed_work->work) must not be used for
  2449. * delayed_work's. Use cancel_delayed_work_sync() instead.
  2450. *
  2451. * The caller must ensure that the workqueue on which @work was last
  2452. * queued can't be destroyed before this function returns.
  2453. *
  2454. * RETURNS:
  2455. * %true if @work was pending, %false otherwise.
  2456. */
  2457. bool cancel_work_sync(struct work_struct *work)
  2458. {
  2459. return __cancel_work_timer(work, false);
  2460. }
  2461. EXPORT_SYMBOL_GPL(cancel_work_sync);
  2462. /**
  2463. * flush_delayed_work - wait for a dwork to finish executing the last queueing
  2464. * @dwork: the delayed work to flush
  2465. *
  2466. * Delayed timer is cancelled and the pending work is queued for
  2467. * immediate execution. Like flush_work(), this function only
  2468. * considers the last queueing instance of @dwork.
  2469. *
  2470. * RETURNS:
  2471. * %true if flush_work() waited for the work to finish execution,
  2472. * %false if it was already idle.
  2473. */
  2474. bool flush_delayed_work(struct delayed_work *dwork)
  2475. {
  2476. local_irq_disable();
  2477. if (del_timer_sync(&dwork->timer))
  2478. __queue_work(dwork->cpu, dwork->wq, &dwork->work);
  2479. local_irq_enable();
  2480. return flush_work(&dwork->work);
  2481. }
  2482. EXPORT_SYMBOL(flush_delayed_work);
  2483. /**
  2484. * cancel_delayed_work - cancel a delayed work
  2485. * @dwork: delayed_work to cancel
  2486. *
  2487. * Kill off a pending delayed_work. Returns %true if @dwork was pending
  2488. * and canceled; %false if wasn't pending. Note that the work callback
  2489. * function may still be running on return, unless it returns %true and the
  2490. * work doesn't re-arm itself. Explicitly flush or use
  2491. * cancel_delayed_work_sync() to wait on it.
  2492. *
  2493. * This function is safe to call from any context including IRQ handler.
  2494. */
  2495. bool cancel_delayed_work(struct delayed_work *dwork)
  2496. {
  2497. unsigned long flags;
  2498. int ret;
  2499. do {
  2500. ret = try_to_grab_pending(&dwork->work, true, &flags);
  2501. } while (unlikely(ret == -EAGAIN));
  2502. if (unlikely(ret < 0))
  2503. return false;
  2504. set_work_pool_and_clear_pending(&dwork->work,
  2505. get_work_pool_id(&dwork->work));
  2506. local_irq_restore(flags);
  2507. return ret;
  2508. }
  2509. EXPORT_SYMBOL(cancel_delayed_work);
  2510. /**
  2511. * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
  2512. * @dwork: the delayed work cancel
  2513. *
  2514. * This is cancel_work_sync() for delayed works.
  2515. *
  2516. * RETURNS:
  2517. * %true if @dwork was pending, %false otherwise.
  2518. */
  2519. bool cancel_delayed_work_sync(struct delayed_work *dwork)
  2520. {
  2521. return __cancel_work_timer(&dwork->work, true);
  2522. }
  2523. EXPORT_SYMBOL(cancel_delayed_work_sync);
  2524. /**
  2525. * schedule_on_each_cpu - execute a function synchronously on each online CPU
  2526. * @func: the function to call
  2527. *
  2528. * schedule_on_each_cpu() executes @func on each online CPU using the
  2529. * system workqueue and blocks until all CPUs have completed.
  2530. * schedule_on_each_cpu() is very slow.
  2531. *
  2532. * RETURNS:
  2533. * 0 on success, -errno on failure.
  2534. */
  2535. int schedule_on_each_cpu(work_func_t func)
  2536. {
  2537. int cpu;
  2538. struct work_struct __percpu *works;
  2539. works = alloc_percpu(struct work_struct);
  2540. if (!works)
  2541. return -ENOMEM;
  2542. get_online_cpus();
  2543. for_each_online_cpu(cpu) {
  2544. struct work_struct *work = per_cpu_ptr(works, cpu);
  2545. INIT_WORK(work, func);
  2546. schedule_work_on(cpu, work);
  2547. }
  2548. for_each_online_cpu(cpu)
  2549. flush_work(per_cpu_ptr(works, cpu));
  2550. put_online_cpus();
  2551. free_percpu(works);
  2552. return 0;
  2553. }
  2554. /**
  2555. * flush_scheduled_work - ensure that any scheduled work has run to completion.
  2556. *
  2557. * Forces execution of the kernel-global workqueue and blocks until its
  2558. * completion.
  2559. *
  2560. * Think twice before calling this function! It's very easy to get into
  2561. * trouble if you don't take great care. Either of the following situations
  2562. * will lead to deadlock:
  2563. *
  2564. * One of the work items currently on the workqueue needs to acquire
  2565. * a lock held by your code or its caller.
  2566. *
  2567. * Your code is running in the context of a work routine.
  2568. *
  2569. * They will be detected by lockdep when they occur, but the first might not
  2570. * occur very often. It depends on what work items are on the workqueue and
  2571. * what locks they need, which you have no control over.
  2572. *
  2573. * In most situations flushing the entire workqueue is overkill; you merely
  2574. * need to know that a particular work item isn't queued and isn't running.
  2575. * In such cases you should use cancel_delayed_work_sync() or
  2576. * cancel_work_sync() instead.
  2577. */
  2578. void flush_scheduled_work(void)
  2579. {
  2580. flush_workqueue(system_wq);
  2581. }
  2582. EXPORT_SYMBOL(flush_scheduled_work);
  2583. /**
  2584. * execute_in_process_context - reliably execute the routine with user context
  2585. * @fn: the function to execute
  2586. * @ew: guaranteed storage for the execute work structure (must
  2587. * be available when the work executes)
  2588. *
  2589. * Executes the function immediately if process context is available,
  2590. * otherwise schedules the function for delayed execution.
  2591. *
  2592. * Returns: 0 - function was executed
  2593. * 1 - function was scheduled for execution
  2594. */
  2595. int execute_in_process_context(work_func_t fn, struct execute_work *ew)
  2596. {
  2597. if (!in_interrupt()) {
  2598. fn(&ew->work);
  2599. return 0;
  2600. }
  2601. INIT_WORK(&ew->work, fn);
  2602. schedule_work(&ew->work);
  2603. return 1;
  2604. }
  2605. EXPORT_SYMBOL_GPL(execute_in_process_context);
  2606. #ifdef CONFIG_SYSFS
  2607. /*
  2608. * Workqueues with WQ_SYSFS flag set is visible to userland via
  2609. * /sys/bus/workqueue/devices/WQ_NAME. All visible workqueues have the
  2610. * following attributes.
  2611. *
  2612. * per_cpu RO bool : whether the workqueue is per-cpu or unbound
  2613. * max_active RW int : maximum number of in-flight work items
  2614. *
  2615. * Unbound workqueues have the following extra attributes.
  2616. *
  2617. * id RO int : the associated pool ID
  2618. * nice RW int : nice value of the workers
  2619. * cpumask RW mask : bitmask of allowed CPUs for the workers
  2620. */
  2621. struct wq_device {
  2622. struct workqueue_struct *wq;
  2623. struct device dev;
  2624. };
  2625. static struct workqueue_struct *dev_to_wq(struct device *dev)
  2626. {
  2627. struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
  2628. return wq_dev->wq;
  2629. }
  2630. static ssize_t wq_per_cpu_show(struct device *dev,
  2631. struct device_attribute *attr, char *buf)
  2632. {
  2633. struct workqueue_struct *wq = dev_to_wq(dev);
  2634. return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND));
  2635. }
  2636. static ssize_t wq_max_active_show(struct device *dev,
  2637. struct device_attribute *attr, char *buf)
  2638. {
  2639. struct workqueue_struct *wq = dev_to_wq(dev);
  2640. return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active);
  2641. }
  2642. static ssize_t wq_max_active_store(struct device *dev,
  2643. struct device_attribute *attr,
  2644. const char *buf, size_t count)
  2645. {
  2646. struct workqueue_struct *wq = dev_to_wq(dev);
  2647. int val;
  2648. if (sscanf(buf, "%d", &val) != 1 || val <= 0)
  2649. return -EINVAL;
  2650. workqueue_set_max_active(wq, val);
  2651. return count;
  2652. }
  2653. static struct device_attribute wq_sysfs_attrs[] = {
  2654. __ATTR(per_cpu, 0444, wq_per_cpu_show, NULL),
  2655. __ATTR(max_active, 0644, wq_max_active_show, wq_max_active_store),
  2656. __ATTR_NULL,
  2657. };
  2658. static ssize_t wq_pool_id_show(struct device *dev,
  2659. struct device_attribute *attr, char *buf)
  2660. {
  2661. struct workqueue_struct *wq = dev_to_wq(dev);
  2662. struct worker_pool *pool;
  2663. int written;
  2664. rcu_read_lock_sched();
  2665. pool = first_pwq(wq)->pool;
  2666. written = scnprintf(buf, PAGE_SIZE, "%d\n", pool->id);
  2667. rcu_read_unlock_sched();
  2668. return written;
  2669. }
  2670. static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr,
  2671. char *buf)
  2672. {
  2673. struct workqueue_struct *wq = dev_to_wq(dev);
  2674. int written;
  2675. rcu_read_lock_sched();
  2676. written = scnprintf(buf, PAGE_SIZE, "%d\n",
  2677. first_pwq(wq)->pool->attrs->nice);
  2678. rcu_read_unlock_sched();
  2679. return written;
  2680. }
  2681. /* prepare workqueue_attrs for sysfs store operations */
  2682. static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq)
  2683. {
  2684. struct workqueue_attrs *attrs;
  2685. attrs = alloc_workqueue_attrs(GFP_KERNEL);
  2686. if (!attrs)
  2687. return NULL;
  2688. rcu_read_lock_sched();
  2689. copy_workqueue_attrs(attrs, first_pwq(wq)->pool->attrs);
  2690. rcu_read_unlock_sched();
  2691. return attrs;
  2692. }
  2693. static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr,
  2694. const char *buf, size_t count)
  2695. {
  2696. struct workqueue_struct *wq = dev_to_wq(dev);
  2697. struct workqueue_attrs *attrs;
  2698. int ret;
  2699. attrs = wq_sysfs_prep_attrs(wq);
  2700. if (!attrs)
  2701. return -ENOMEM;
  2702. if (sscanf(buf, "%d", &attrs->nice) == 1 &&
  2703. attrs->nice >= -20 && attrs->nice <= 19)
  2704. ret = apply_workqueue_attrs(wq, attrs);
  2705. else
  2706. ret = -EINVAL;
  2707. free_workqueue_attrs(attrs);
  2708. return ret ?: count;
  2709. }
  2710. static ssize_t wq_cpumask_show(struct device *dev,
  2711. struct device_attribute *attr, char *buf)
  2712. {
  2713. struct workqueue_struct *wq = dev_to_wq(dev);
  2714. int written;
  2715. rcu_read_lock_sched();
  2716. written = cpumask_scnprintf(buf, PAGE_SIZE,
  2717. first_pwq(wq)->pool->attrs->cpumask);
  2718. rcu_read_unlock_sched();
  2719. written += scnprintf(buf + written, PAGE_SIZE - written, "\n");
  2720. return written;
  2721. }
  2722. static ssize_t wq_cpumask_store(struct device *dev,
  2723. struct device_attribute *attr,
  2724. const char *buf, size_t count)
  2725. {
  2726. struct workqueue_struct *wq = dev_to_wq(dev);
  2727. struct workqueue_attrs *attrs;
  2728. int ret;
  2729. attrs = wq_sysfs_prep_attrs(wq);
  2730. if (!attrs)
  2731. return -ENOMEM;
  2732. ret = cpumask_parse(buf, attrs->cpumask);
  2733. if (!ret)
  2734. ret = apply_workqueue_attrs(wq, attrs);
  2735. free_workqueue_attrs(attrs);
  2736. return ret ?: count;
  2737. }
  2738. static struct device_attribute wq_sysfs_unbound_attrs[] = {
  2739. __ATTR(pool_id, 0444, wq_pool_id_show, NULL),
  2740. __ATTR(nice, 0644, wq_nice_show, wq_nice_store),
  2741. __ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store),
  2742. __ATTR_NULL,
  2743. };
  2744. static struct bus_type wq_subsys = {
  2745. .name = "workqueue",
  2746. .dev_attrs = wq_sysfs_attrs,
  2747. };
  2748. static int __init wq_sysfs_init(void)
  2749. {
  2750. return subsys_virtual_register(&wq_subsys, NULL);
  2751. }
  2752. core_initcall(wq_sysfs_init);
  2753. static void wq_device_release(struct device *dev)
  2754. {
  2755. struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
  2756. kfree(wq_dev);
  2757. }
  2758. /**
  2759. * workqueue_sysfs_register - make a workqueue visible in sysfs
  2760. * @wq: the workqueue to register
  2761. *
  2762. * Expose @wq in sysfs under /sys/bus/workqueue/devices.
  2763. * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set
  2764. * which is the preferred method.
  2765. *
  2766. * Workqueue user should use this function directly iff it wants to apply
  2767. * workqueue_attrs before making the workqueue visible in sysfs; otherwise,
  2768. * apply_workqueue_attrs() may race against userland updating the
  2769. * attributes.
  2770. *
  2771. * Returns 0 on success, -errno on failure.
  2772. */
  2773. int workqueue_sysfs_register(struct workqueue_struct *wq)
  2774. {
  2775. struct wq_device *wq_dev;
  2776. int ret;
  2777. /*
  2778. * Adjusting max_active or creating new pwqs by applyting
  2779. * attributes breaks ordering guarantee. Disallow exposing ordered
  2780. * workqueues.
  2781. */
  2782. if (WARN_ON(wq->flags & __WQ_ORDERED))
  2783. return -EINVAL;
  2784. wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL);
  2785. if (!wq_dev)
  2786. return -ENOMEM;
  2787. wq_dev->wq = wq;
  2788. wq_dev->dev.bus = &wq_subsys;
  2789. wq_dev->dev.init_name = wq->name;
  2790. wq_dev->dev.release = wq_device_release;
  2791. /*
  2792. * unbound_attrs are created separately. Suppress uevent until
  2793. * everything is ready.
  2794. */
  2795. dev_set_uevent_suppress(&wq_dev->dev, true);
  2796. ret = device_register(&wq_dev->dev);
  2797. if (ret) {
  2798. kfree(wq_dev);
  2799. wq->wq_dev = NULL;
  2800. return ret;
  2801. }
  2802. if (wq->flags & WQ_UNBOUND) {
  2803. struct device_attribute *attr;
  2804. for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) {
  2805. ret = device_create_file(&wq_dev->dev, attr);
  2806. if (ret) {
  2807. device_unregister(&wq_dev->dev);
  2808. wq->wq_dev = NULL;
  2809. return ret;
  2810. }
  2811. }
  2812. }
  2813. kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD);
  2814. return 0;
  2815. }
  2816. /**
  2817. * workqueue_sysfs_unregister - undo workqueue_sysfs_register()
  2818. * @wq: the workqueue to unregister
  2819. *
  2820. * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister.
  2821. */
  2822. static void workqueue_sysfs_unregister(struct workqueue_struct *wq)
  2823. {
  2824. struct wq_device *wq_dev = wq->wq_dev;
  2825. if (!wq->wq_dev)
  2826. return;
  2827. wq->wq_dev = NULL;
  2828. device_unregister(&wq_dev->dev);
  2829. }
  2830. #else /* CONFIG_SYSFS */
  2831. static void workqueue_sysfs_unregister(struct workqueue_struct *wq) { }
  2832. #endif /* CONFIG_SYSFS */
  2833. /**
  2834. * free_workqueue_attrs - free a workqueue_attrs
  2835. * @attrs: workqueue_attrs to free
  2836. *
  2837. * Undo alloc_workqueue_attrs().
  2838. */
  2839. void free_workqueue_attrs(struct workqueue_attrs *attrs)
  2840. {
  2841. if (attrs) {
  2842. free_cpumask_var(attrs->cpumask);
  2843. kfree(attrs);
  2844. }
  2845. }
  2846. /**
  2847. * alloc_workqueue_attrs - allocate a workqueue_attrs
  2848. * @gfp_mask: allocation mask to use
  2849. *
  2850. * Allocate a new workqueue_attrs, initialize with default settings and
  2851. * return it. Returns NULL on failure.
  2852. */
  2853. struct workqueue_attrs *alloc_workqueue_attrs(gfp_t gfp_mask)
  2854. {
  2855. struct workqueue_attrs *attrs;
  2856. attrs = kzalloc(sizeof(*attrs), gfp_mask);
  2857. if (!attrs)
  2858. goto fail;
  2859. if (!alloc_cpumask_var(&attrs->cpumask, gfp_mask))
  2860. goto fail;
  2861. cpumask_copy(attrs->cpumask, cpu_possible_mask);
  2862. return attrs;
  2863. fail:
  2864. free_workqueue_attrs(attrs);
  2865. return NULL;
  2866. }
  2867. static void copy_workqueue_attrs(struct workqueue_attrs *to,
  2868. const struct workqueue_attrs *from)
  2869. {
  2870. to->nice = from->nice;
  2871. cpumask_copy(to->cpumask, from->cpumask);
  2872. }
  2873. /* hash value of the content of @attr */
  2874. static u32 wqattrs_hash(const struct workqueue_attrs *attrs)
  2875. {
  2876. u32 hash = 0;
  2877. hash = jhash_1word(attrs->nice, hash);
  2878. hash = jhash(cpumask_bits(attrs->cpumask),
  2879. BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash);
  2880. return hash;
  2881. }
  2882. /* content equality test */
  2883. static bool wqattrs_equal(const struct workqueue_attrs *a,
  2884. const struct workqueue_attrs *b)
  2885. {
  2886. if (a->nice != b->nice)
  2887. return false;
  2888. if (!cpumask_equal(a->cpumask, b->cpumask))
  2889. return false;
  2890. return true;
  2891. }
  2892. /**
  2893. * init_worker_pool - initialize a newly zalloc'd worker_pool
  2894. * @pool: worker_pool to initialize
  2895. *
  2896. * Initiailize a newly zalloc'd @pool. It also allocates @pool->attrs.
  2897. * Returns 0 on success, -errno on failure. Even on failure, all fields
  2898. * inside @pool proper are initialized and put_unbound_pool() can be called
  2899. * on @pool safely to release it.
  2900. */
  2901. static int init_worker_pool(struct worker_pool *pool)
  2902. {
  2903. spin_lock_init(&pool->lock);
  2904. pool->id = -1;
  2905. pool->cpu = -1;
  2906. pool->node = NUMA_NO_NODE;
  2907. pool->flags |= POOL_DISASSOCIATED;
  2908. INIT_LIST_HEAD(&pool->worklist);
  2909. INIT_LIST_HEAD(&pool->idle_list);
  2910. hash_init(pool->busy_hash);
  2911. init_timer_deferrable(&pool->idle_timer);
  2912. pool->idle_timer.function = idle_worker_timeout;
  2913. pool->idle_timer.data = (unsigned long)pool;
  2914. setup_timer(&pool->mayday_timer, pool_mayday_timeout,
  2915. (unsigned long)pool);
  2916. mutex_init(&pool->manager_arb);
  2917. mutex_init(&pool->manager_mutex);
  2918. idr_init(&pool->worker_idr);
  2919. INIT_HLIST_NODE(&pool->hash_node);
  2920. pool->refcnt = 1;
  2921. /* shouldn't fail above this point */
  2922. pool->attrs = alloc_workqueue_attrs(GFP_KERNEL);
  2923. if (!pool->attrs)
  2924. return -ENOMEM;
  2925. return 0;
  2926. }
  2927. static void rcu_free_pool(struct rcu_head *rcu)
  2928. {
  2929. struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu);
  2930. idr_destroy(&pool->worker_idr);
  2931. free_workqueue_attrs(pool->attrs);
  2932. kfree(pool);
  2933. }
  2934. /**
  2935. * put_unbound_pool - put a worker_pool
  2936. * @pool: worker_pool to put
  2937. *
  2938. * Put @pool. If its refcnt reaches zero, it gets destroyed in sched-RCU
  2939. * safe manner. get_unbound_pool() calls this function on its failure path
  2940. * and this function should be able to release pools which went through,
  2941. * successfully or not, init_worker_pool().
  2942. *
  2943. * Should be called with wq_pool_mutex held.
  2944. */
  2945. static void put_unbound_pool(struct worker_pool *pool)
  2946. {
  2947. struct worker *worker;
  2948. lockdep_assert_held(&wq_pool_mutex);
  2949. if (--pool->refcnt)
  2950. return;
  2951. /* sanity checks */
  2952. if (WARN_ON(!(pool->flags & POOL_DISASSOCIATED)) ||
  2953. WARN_ON(!list_empty(&pool->worklist)))
  2954. return;
  2955. /* release id and unhash */
  2956. if (pool->id >= 0)
  2957. idr_remove(&worker_pool_idr, pool->id);
  2958. hash_del(&pool->hash_node);
  2959. /*
  2960. * Become the manager and destroy all workers. Grabbing
  2961. * manager_arb prevents @pool's workers from blocking on
  2962. * manager_mutex.
  2963. */
  2964. mutex_lock(&pool->manager_arb);
  2965. mutex_lock(&pool->manager_mutex);
  2966. spin_lock_irq(&pool->lock);
  2967. while ((worker = first_worker(pool)))
  2968. destroy_worker(worker);
  2969. WARN_ON(pool->nr_workers || pool->nr_idle);
  2970. spin_unlock_irq(&pool->lock);
  2971. mutex_unlock(&pool->manager_mutex);
  2972. mutex_unlock(&pool->manager_arb);
  2973. /* shut down the timers */
  2974. del_timer_sync(&pool->idle_timer);
  2975. del_timer_sync(&pool->mayday_timer);
  2976. /* sched-RCU protected to allow dereferences from get_work_pool() */
  2977. call_rcu_sched(&pool->rcu, rcu_free_pool);
  2978. }
  2979. /**
  2980. * get_unbound_pool - get a worker_pool with the specified attributes
  2981. * @attrs: the attributes of the worker_pool to get
  2982. *
  2983. * Obtain a worker_pool which has the same attributes as @attrs, bump the
  2984. * reference count and return it. If there already is a matching
  2985. * worker_pool, it will be used; otherwise, this function attempts to
  2986. * create a new one. On failure, returns NULL.
  2987. *
  2988. * Should be called with wq_pool_mutex held.
  2989. */
  2990. static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs)
  2991. {
  2992. u32 hash = wqattrs_hash(attrs);
  2993. struct worker_pool *pool;
  2994. int node;
  2995. lockdep_assert_held(&wq_pool_mutex);
  2996. /* do we already have a matching pool? */
  2997. hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) {
  2998. if (wqattrs_equal(pool->attrs, attrs)) {
  2999. pool->refcnt++;
  3000. goto out_unlock;
  3001. }
  3002. }
  3003. /* nope, create a new one */
  3004. pool = kzalloc(sizeof(*pool), GFP_KERNEL);
  3005. if (!pool || init_worker_pool(pool) < 0)
  3006. goto fail;
  3007. if (workqueue_freezing)
  3008. pool->flags |= POOL_FREEZING;
  3009. lockdep_set_subclass(&pool->lock, 1); /* see put_pwq() */
  3010. copy_workqueue_attrs(pool->attrs, attrs);
  3011. /* if cpumask is contained inside a NUMA node, we belong to that node */
  3012. if (wq_numa_enabled) {
  3013. for_each_node(node) {
  3014. if (cpumask_subset(pool->attrs->cpumask,
  3015. wq_numa_possible_cpumask[node])) {
  3016. pool->node = node;
  3017. break;
  3018. }
  3019. }
  3020. }
  3021. if (worker_pool_assign_id(pool) < 0)
  3022. goto fail;
  3023. /* create and start the initial worker */
  3024. if (create_and_start_worker(pool) < 0)
  3025. goto fail;
  3026. /* install */
  3027. hash_add(unbound_pool_hash, &pool->hash_node, hash);
  3028. out_unlock:
  3029. return pool;
  3030. fail:
  3031. if (pool)
  3032. put_unbound_pool(pool);
  3033. return NULL;
  3034. }
  3035. static void rcu_free_pwq(struct rcu_head *rcu)
  3036. {
  3037. kmem_cache_free(pwq_cache,
  3038. container_of(rcu, struct pool_workqueue, rcu));
  3039. }
  3040. /*
  3041. * Scheduled on system_wq by put_pwq() when an unbound pwq hits zero refcnt
  3042. * and needs to be destroyed.
  3043. */
  3044. static void pwq_unbound_release_workfn(struct work_struct *work)
  3045. {
  3046. struct pool_workqueue *pwq = container_of(work, struct pool_workqueue,
  3047. unbound_release_work);
  3048. struct workqueue_struct *wq = pwq->wq;
  3049. struct worker_pool *pool = pwq->pool;
  3050. bool is_last;
  3051. if (WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND)))
  3052. return;
  3053. /*
  3054. * Unlink @pwq. Synchronization against wq->mutex isn't strictly
  3055. * necessary on release but do it anyway. It's easier to verify
  3056. * and consistent with the linking path.
  3057. */
  3058. mutex_lock(&wq->mutex);
  3059. list_del_rcu(&pwq->pwqs_node);
  3060. is_last = list_empty(&wq->pwqs);
  3061. mutex_unlock(&wq->mutex);
  3062. mutex_lock(&wq_pool_mutex);
  3063. put_unbound_pool(pool);
  3064. mutex_unlock(&wq_pool_mutex);
  3065. call_rcu_sched(&pwq->rcu, rcu_free_pwq);
  3066. /*
  3067. * If we're the last pwq going away, @wq is already dead and no one
  3068. * is gonna access it anymore. Free it.
  3069. */
  3070. if (is_last)
  3071. kfree(wq);
  3072. }
  3073. /**
  3074. * pwq_adjust_max_active - update a pwq's max_active to the current setting
  3075. * @pwq: target pool_workqueue
  3076. *
  3077. * If @pwq isn't freezing, set @pwq->max_active to the associated
  3078. * workqueue's saved_max_active and activate delayed work items
  3079. * accordingly. If @pwq is freezing, clear @pwq->max_active to zero.
  3080. */
  3081. static void pwq_adjust_max_active(struct pool_workqueue *pwq)
  3082. {
  3083. struct workqueue_struct *wq = pwq->wq;
  3084. bool freezable = wq->flags & WQ_FREEZABLE;
  3085. /* for @wq->saved_max_active */
  3086. lockdep_assert_held(&wq->mutex);
  3087. /* fast exit for non-freezable wqs */
  3088. if (!freezable && pwq->max_active == wq->saved_max_active)
  3089. return;
  3090. spin_lock_irq(&pwq->pool->lock);
  3091. if (!freezable || !(pwq->pool->flags & POOL_FREEZING)) {
  3092. pwq->max_active = wq->saved_max_active;
  3093. while (!list_empty(&pwq->delayed_works) &&
  3094. pwq->nr_active < pwq->max_active)
  3095. pwq_activate_first_delayed(pwq);
  3096. /*
  3097. * Need to kick a worker after thawed or an unbound wq's
  3098. * max_active is bumped. It's a slow path. Do it always.
  3099. */
  3100. wake_up_worker(pwq->pool);
  3101. } else {
  3102. pwq->max_active = 0;
  3103. }
  3104. spin_unlock_irq(&pwq->pool->lock);
  3105. }
  3106. static void init_and_link_pwq(struct pool_workqueue *pwq,
  3107. struct workqueue_struct *wq,
  3108. struct worker_pool *pool,
  3109. struct pool_workqueue **p_last_pwq)
  3110. {
  3111. BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK);
  3112. pwq->pool = pool;
  3113. pwq->wq = wq;
  3114. pwq->flush_color = -1;
  3115. pwq->refcnt = 1;
  3116. INIT_LIST_HEAD(&pwq->delayed_works);
  3117. INIT_LIST_HEAD(&pwq->mayday_node);
  3118. INIT_WORK(&pwq->unbound_release_work, pwq_unbound_release_workfn);
  3119. mutex_lock(&wq->mutex);
  3120. /*
  3121. * Set the matching work_color. This is synchronized with
  3122. * wq->mutex to avoid confusing flush_workqueue().
  3123. */
  3124. if (p_last_pwq)
  3125. *p_last_pwq = first_pwq(wq);
  3126. pwq->work_color = wq->work_color;
  3127. /* sync max_active to the current setting */
  3128. pwq_adjust_max_active(pwq);
  3129. /* link in @pwq */
  3130. list_add_rcu(&pwq->pwqs_node, &wq->pwqs);
  3131. mutex_unlock(&wq->mutex);
  3132. }
  3133. /**
  3134. * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue
  3135. * @wq: the target workqueue
  3136. * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs()
  3137. *
  3138. * Apply @attrs to an unbound workqueue @wq. If @attrs doesn't match the
  3139. * current attributes, a new pwq is created and made the first pwq which
  3140. * will serve all new work items. Older pwqs are released as in-flight
  3141. * work items finish. Note that a work item which repeatedly requeues
  3142. * itself back-to-back will stay on its current pwq.
  3143. *
  3144. * Performs GFP_KERNEL allocations. Returns 0 on success and -errno on
  3145. * failure.
  3146. */
  3147. int apply_workqueue_attrs(struct workqueue_struct *wq,
  3148. const struct workqueue_attrs *attrs)
  3149. {
  3150. struct workqueue_attrs *new_attrs;
  3151. struct pool_workqueue *pwq = NULL, *last_pwq;
  3152. struct worker_pool *pool;
  3153. int ret;
  3154. /* only unbound workqueues can change attributes */
  3155. if (WARN_ON(!(wq->flags & WQ_UNBOUND)))
  3156. return -EINVAL;
  3157. /* creating multiple pwqs breaks ordering guarantee */
  3158. if (WARN_ON((wq->flags & __WQ_ORDERED) && !list_empty(&wq->pwqs)))
  3159. return -EINVAL;
  3160. /* make a copy of @attrs and sanitize it */
  3161. new_attrs = alloc_workqueue_attrs(GFP_KERNEL);
  3162. if (!new_attrs)
  3163. goto enomem;
  3164. copy_workqueue_attrs(new_attrs, attrs);
  3165. cpumask_and(new_attrs->cpumask, new_attrs->cpumask, cpu_possible_mask);
  3166. mutex_lock(&wq_pool_mutex);
  3167. pwq = kmem_cache_zalloc(pwq_cache, GFP_KERNEL);
  3168. if (!pwq) {
  3169. mutex_unlock(&wq_pool_mutex);
  3170. goto enomem;
  3171. }
  3172. pool = get_unbound_pool(new_attrs);
  3173. if (!pool) {
  3174. mutex_unlock(&wq_pool_mutex);
  3175. goto enomem;
  3176. }
  3177. mutex_unlock(&wq_pool_mutex);
  3178. init_and_link_pwq(pwq, wq, pool, &last_pwq);
  3179. if (last_pwq) {
  3180. spin_lock_irq(&last_pwq->pool->lock);
  3181. put_pwq(last_pwq);
  3182. spin_unlock_irq(&last_pwq->pool->lock);
  3183. }
  3184. ret = 0;
  3185. /* fall through */
  3186. out_free:
  3187. free_workqueue_attrs(new_attrs);
  3188. return ret;
  3189. enomem:
  3190. kmem_cache_free(pwq_cache, pwq);
  3191. ret = -ENOMEM;
  3192. goto out_free;
  3193. }
  3194. static int alloc_and_link_pwqs(struct workqueue_struct *wq)
  3195. {
  3196. bool highpri = wq->flags & WQ_HIGHPRI;
  3197. int cpu;
  3198. if (!(wq->flags & WQ_UNBOUND)) {
  3199. wq->cpu_pwqs = alloc_percpu(struct pool_workqueue);
  3200. if (!wq->cpu_pwqs)
  3201. return -ENOMEM;
  3202. for_each_possible_cpu(cpu) {
  3203. struct pool_workqueue *pwq =
  3204. per_cpu_ptr(wq->cpu_pwqs, cpu);
  3205. struct worker_pool *cpu_pools =
  3206. per_cpu(cpu_worker_pools, cpu);
  3207. init_and_link_pwq(pwq, wq, &cpu_pools[highpri], NULL);
  3208. }
  3209. return 0;
  3210. } else {
  3211. return apply_workqueue_attrs(wq, unbound_std_wq_attrs[highpri]);
  3212. }
  3213. }
  3214. static int wq_clamp_max_active(int max_active, unsigned int flags,
  3215. const char *name)
  3216. {
  3217. int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
  3218. if (max_active < 1 || max_active > lim)
  3219. pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
  3220. max_active, name, 1, lim);
  3221. return clamp_val(max_active, 1, lim);
  3222. }
  3223. struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
  3224. unsigned int flags,
  3225. int max_active,
  3226. struct lock_class_key *key,
  3227. const char *lock_name, ...)
  3228. {
  3229. va_list args, args1;
  3230. struct workqueue_struct *wq;
  3231. struct pool_workqueue *pwq;
  3232. size_t namelen;
  3233. /* determine namelen, allocate wq and format name */
  3234. va_start(args, lock_name);
  3235. va_copy(args1, args);
  3236. namelen = vsnprintf(NULL, 0, fmt, args) + 1;
  3237. wq = kzalloc(sizeof(*wq) + namelen, GFP_KERNEL);
  3238. if (!wq)
  3239. return NULL;
  3240. vsnprintf(wq->name, namelen, fmt, args1);
  3241. va_end(args);
  3242. va_end(args1);
  3243. max_active = max_active ?: WQ_DFL_ACTIVE;
  3244. max_active = wq_clamp_max_active(max_active, flags, wq->name);
  3245. /* init wq */
  3246. wq->flags = flags;
  3247. wq->saved_max_active = max_active;
  3248. mutex_init(&wq->mutex);
  3249. atomic_set(&wq->nr_pwqs_to_flush, 0);
  3250. INIT_LIST_HEAD(&wq->pwqs);
  3251. INIT_LIST_HEAD(&wq->flusher_queue);
  3252. INIT_LIST_HEAD(&wq->flusher_overflow);
  3253. INIT_LIST_HEAD(&wq->maydays);
  3254. lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
  3255. INIT_LIST_HEAD(&wq->list);
  3256. if (alloc_and_link_pwqs(wq) < 0)
  3257. goto err_free_wq;
  3258. /*
  3259. * Workqueues which may be used during memory reclaim should
  3260. * have a rescuer to guarantee forward progress.
  3261. */
  3262. if (flags & WQ_MEM_RECLAIM) {
  3263. struct worker *rescuer;
  3264. rescuer = alloc_worker();
  3265. if (!rescuer)
  3266. goto err_destroy;
  3267. rescuer->rescue_wq = wq;
  3268. rescuer->task = kthread_create(rescuer_thread, rescuer, "%s",
  3269. wq->name);
  3270. if (IS_ERR(rescuer->task)) {
  3271. kfree(rescuer);
  3272. goto err_destroy;
  3273. }
  3274. wq->rescuer = rescuer;
  3275. rescuer->task->flags |= PF_NO_SETAFFINITY;
  3276. wake_up_process(rescuer->task);
  3277. }
  3278. if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq))
  3279. goto err_destroy;
  3280. /*
  3281. * wq_pool_mutex protects global freeze state and workqueues list.
  3282. * Grab it, adjust max_active and add the new @wq to workqueues
  3283. * list.
  3284. */
  3285. mutex_lock(&wq_pool_mutex);
  3286. mutex_lock(&wq->mutex);
  3287. for_each_pwq(pwq, wq)
  3288. pwq_adjust_max_active(pwq);
  3289. mutex_unlock(&wq->mutex);
  3290. list_add(&wq->list, &workqueues);
  3291. mutex_unlock(&wq_pool_mutex);
  3292. return wq;
  3293. err_free_wq:
  3294. kfree(wq);
  3295. return NULL;
  3296. err_destroy:
  3297. destroy_workqueue(wq);
  3298. return NULL;
  3299. }
  3300. EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
  3301. /**
  3302. * destroy_workqueue - safely terminate a workqueue
  3303. * @wq: target workqueue
  3304. *
  3305. * Safely destroy a workqueue. All work currently pending will be done first.
  3306. */
  3307. void destroy_workqueue(struct workqueue_struct *wq)
  3308. {
  3309. struct pool_workqueue *pwq;
  3310. /* drain it before proceeding with destruction */
  3311. drain_workqueue(wq);
  3312. /* sanity checks */
  3313. mutex_lock(&wq->mutex);
  3314. for_each_pwq(pwq, wq) {
  3315. int i;
  3316. for (i = 0; i < WORK_NR_COLORS; i++) {
  3317. if (WARN_ON(pwq->nr_in_flight[i])) {
  3318. mutex_unlock(&wq->mutex);
  3319. return;
  3320. }
  3321. }
  3322. if (WARN_ON(pwq->refcnt > 1) ||
  3323. WARN_ON(pwq->nr_active) ||
  3324. WARN_ON(!list_empty(&pwq->delayed_works))) {
  3325. mutex_unlock(&wq->mutex);
  3326. return;
  3327. }
  3328. }
  3329. mutex_unlock(&wq->mutex);
  3330. /*
  3331. * wq list is used to freeze wq, remove from list after
  3332. * flushing is complete in case freeze races us.
  3333. */
  3334. mutex_lock(&wq_pool_mutex);
  3335. list_del_init(&wq->list);
  3336. mutex_unlock(&wq_pool_mutex);
  3337. workqueue_sysfs_unregister(wq);
  3338. if (wq->rescuer) {
  3339. kthread_stop(wq->rescuer->task);
  3340. kfree(wq->rescuer);
  3341. wq->rescuer = NULL;
  3342. }
  3343. if (!(wq->flags & WQ_UNBOUND)) {
  3344. /*
  3345. * The base ref is never dropped on per-cpu pwqs. Directly
  3346. * free the pwqs and wq.
  3347. */
  3348. free_percpu(wq->cpu_pwqs);
  3349. kfree(wq);
  3350. } else {
  3351. /*
  3352. * We're the sole accessor of @wq at this point. Directly
  3353. * access the first pwq and put the base ref. As both pwqs
  3354. * and pools are sched-RCU protected, the lock operations
  3355. * are safe. @wq will be freed when the last pwq is
  3356. * released.
  3357. */
  3358. pwq = list_first_entry(&wq->pwqs, struct pool_workqueue,
  3359. pwqs_node);
  3360. spin_lock_irq(&pwq->pool->lock);
  3361. put_pwq(pwq);
  3362. spin_unlock_irq(&pwq->pool->lock);
  3363. }
  3364. }
  3365. EXPORT_SYMBOL_GPL(destroy_workqueue);
  3366. /**
  3367. * workqueue_set_max_active - adjust max_active of a workqueue
  3368. * @wq: target workqueue
  3369. * @max_active: new max_active value.
  3370. *
  3371. * Set max_active of @wq to @max_active.
  3372. *
  3373. * CONTEXT:
  3374. * Don't call from IRQ context.
  3375. */
  3376. void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
  3377. {
  3378. struct pool_workqueue *pwq;
  3379. /* disallow meddling with max_active for ordered workqueues */
  3380. if (WARN_ON(wq->flags & __WQ_ORDERED))
  3381. return;
  3382. max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
  3383. mutex_lock(&wq->mutex);
  3384. wq->saved_max_active = max_active;
  3385. for_each_pwq(pwq, wq)
  3386. pwq_adjust_max_active(pwq);
  3387. mutex_unlock(&wq->mutex);
  3388. }
  3389. EXPORT_SYMBOL_GPL(workqueue_set_max_active);
  3390. /**
  3391. * current_is_workqueue_rescuer - is %current workqueue rescuer?
  3392. *
  3393. * Determine whether %current is a workqueue rescuer. Can be used from
  3394. * work functions to determine whether it's being run off the rescuer task.
  3395. */
  3396. bool current_is_workqueue_rescuer(void)
  3397. {
  3398. struct worker *worker = current_wq_worker();
  3399. return worker && worker->rescue_wq;
  3400. }
  3401. /**
  3402. * workqueue_congested - test whether a workqueue is congested
  3403. * @cpu: CPU in question
  3404. * @wq: target workqueue
  3405. *
  3406. * Test whether @wq's cpu workqueue for @cpu is congested. There is
  3407. * no synchronization around this function and the test result is
  3408. * unreliable and only useful as advisory hints or for debugging.
  3409. *
  3410. * RETURNS:
  3411. * %true if congested, %false otherwise.
  3412. */
  3413. bool workqueue_congested(int cpu, struct workqueue_struct *wq)
  3414. {
  3415. struct pool_workqueue *pwq;
  3416. bool ret;
  3417. rcu_read_lock_sched();
  3418. if (!(wq->flags & WQ_UNBOUND))
  3419. pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
  3420. else
  3421. pwq = first_pwq(wq);
  3422. ret = !list_empty(&pwq->delayed_works);
  3423. rcu_read_unlock_sched();
  3424. return ret;
  3425. }
  3426. EXPORT_SYMBOL_GPL(workqueue_congested);
  3427. /**
  3428. * work_busy - test whether a work is currently pending or running
  3429. * @work: the work to be tested
  3430. *
  3431. * Test whether @work is currently pending or running. There is no
  3432. * synchronization around this function and the test result is
  3433. * unreliable and only useful as advisory hints or for debugging.
  3434. *
  3435. * RETURNS:
  3436. * OR'd bitmask of WORK_BUSY_* bits.
  3437. */
  3438. unsigned int work_busy(struct work_struct *work)
  3439. {
  3440. struct worker_pool *pool;
  3441. unsigned long flags;
  3442. unsigned int ret = 0;
  3443. if (work_pending(work))
  3444. ret |= WORK_BUSY_PENDING;
  3445. local_irq_save(flags);
  3446. pool = get_work_pool(work);
  3447. if (pool) {
  3448. spin_lock(&pool->lock);
  3449. if (find_worker_executing_work(pool, work))
  3450. ret |= WORK_BUSY_RUNNING;
  3451. spin_unlock(&pool->lock);
  3452. }
  3453. local_irq_restore(flags);
  3454. return ret;
  3455. }
  3456. EXPORT_SYMBOL_GPL(work_busy);
  3457. /*
  3458. * CPU hotplug.
  3459. *
  3460. * There are two challenges in supporting CPU hotplug. Firstly, there
  3461. * are a lot of assumptions on strong associations among work, pwq and
  3462. * pool which make migrating pending and scheduled works very
  3463. * difficult to implement without impacting hot paths. Secondly,
  3464. * worker pools serve mix of short, long and very long running works making
  3465. * blocked draining impractical.
  3466. *
  3467. * This is solved by allowing the pools to be disassociated from the CPU
  3468. * running as an unbound one and allowing it to be reattached later if the
  3469. * cpu comes back online.
  3470. */
  3471. static void wq_unbind_fn(struct work_struct *work)
  3472. {
  3473. int cpu = smp_processor_id();
  3474. struct worker_pool *pool;
  3475. struct worker *worker;
  3476. int wi;
  3477. for_each_cpu_worker_pool(pool, cpu) {
  3478. WARN_ON_ONCE(cpu != smp_processor_id());
  3479. mutex_lock(&pool->manager_mutex);
  3480. spin_lock_irq(&pool->lock);
  3481. /*
  3482. * We've blocked all manager operations. Make all workers
  3483. * unbound and set DISASSOCIATED. Before this, all workers
  3484. * except for the ones which are still executing works from
  3485. * before the last CPU down must be on the cpu. After
  3486. * this, they may become diasporas.
  3487. */
  3488. for_each_pool_worker(worker, wi, pool)
  3489. worker->flags |= WORKER_UNBOUND;
  3490. pool->flags |= POOL_DISASSOCIATED;
  3491. spin_unlock_irq(&pool->lock);
  3492. mutex_unlock(&pool->manager_mutex);
  3493. }
  3494. /*
  3495. * Call schedule() so that we cross rq->lock and thus can guarantee
  3496. * sched callbacks see the %WORKER_UNBOUND flag. This is necessary
  3497. * as scheduler callbacks may be invoked from other cpus.
  3498. */
  3499. schedule();
  3500. /*
  3501. * Sched callbacks are disabled now. Zap nr_running. After this,
  3502. * nr_running stays zero and need_more_worker() and keep_working()
  3503. * are always true as long as the worklist is not empty. Pools on
  3504. * @cpu now behave as unbound (in terms of concurrency management)
  3505. * pools which are served by workers tied to the CPU.
  3506. *
  3507. * On return from this function, the current worker would trigger
  3508. * unbound chain execution of pending work items if other workers
  3509. * didn't already.
  3510. */
  3511. for_each_cpu_worker_pool(pool, cpu)
  3512. atomic_set(&pool->nr_running, 0);
  3513. }
  3514. /**
  3515. * rebind_workers - rebind all workers of a pool to the associated CPU
  3516. * @pool: pool of interest
  3517. *
  3518. * @pool->cpu is coming online. Rebind all workers to the CPU.
  3519. */
  3520. static void rebind_workers(struct worker_pool *pool)
  3521. {
  3522. struct worker *worker;
  3523. int wi;
  3524. lockdep_assert_held(&pool->manager_mutex);
  3525. /*
  3526. * Restore CPU affinity of all workers. As all idle workers should
  3527. * be on the run-queue of the associated CPU before any local
  3528. * wake-ups for concurrency management happen, restore CPU affinty
  3529. * of all workers first and then clear UNBOUND. As we're called
  3530. * from CPU_ONLINE, the following shouldn't fail.
  3531. */
  3532. for_each_pool_worker(worker, wi, pool)
  3533. WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
  3534. pool->attrs->cpumask) < 0);
  3535. spin_lock_irq(&pool->lock);
  3536. for_each_pool_worker(worker, wi, pool) {
  3537. unsigned int worker_flags = worker->flags;
  3538. /*
  3539. * A bound idle worker should actually be on the runqueue
  3540. * of the associated CPU for local wake-ups targeting it to
  3541. * work. Kick all idle workers so that they migrate to the
  3542. * associated CPU. Doing this in the same loop as
  3543. * replacing UNBOUND with REBOUND is safe as no worker will
  3544. * be bound before @pool->lock is released.
  3545. */
  3546. if (worker_flags & WORKER_IDLE)
  3547. wake_up_process(worker->task);
  3548. /*
  3549. * We want to clear UNBOUND but can't directly call
  3550. * worker_clr_flags() or adjust nr_running. Atomically
  3551. * replace UNBOUND with another NOT_RUNNING flag REBOUND.
  3552. * @worker will clear REBOUND using worker_clr_flags() when
  3553. * it initiates the next execution cycle thus restoring
  3554. * concurrency management. Note that when or whether
  3555. * @worker clears REBOUND doesn't affect correctness.
  3556. *
  3557. * ACCESS_ONCE() is necessary because @worker->flags may be
  3558. * tested without holding any lock in
  3559. * wq_worker_waking_up(). Without it, NOT_RUNNING test may
  3560. * fail incorrectly leading to premature concurrency
  3561. * management operations.
  3562. */
  3563. WARN_ON_ONCE(!(worker_flags & WORKER_UNBOUND));
  3564. worker_flags |= WORKER_REBOUND;
  3565. worker_flags &= ~WORKER_UNBOUND;
  3566. ACCESS_ONCE(worker->flags) = worker_flags;
  3567. }
  3568. spin_unlock_irq(&pool->lock);
  3569. }
  3570. /**
  3571. * restore_unbound_workers_cpumask - restore cpumask of unbound workers
  3572. * @pool: unbound pool of interest
  3573. * @cpu: the CPU which is coming up
  3574. *
  3575. * An unbound pool may end up with a cpumask which doesn't have any online
  3576. * CPUs. When a worker of such pool get scheduled, the scheduler resets
  3577. * its cpus_allowed. If @cpu is in @pool's cpumask which didn't have any
  3578. * online CPU before, cpus_allowed of all its workers should be restored.
  3579. */
  3580. static void restore_unbound_workers_cpumask(struct worker_pool *pool, int cpu)
  3581. {
  3582. static cpumask_t cpumask;
  3583. struct worker *worker;
  3584. int wi;
  3585. lockdep_assert_held(&pool->manager_mutex);
  3586. /* is @cpu allowed for @pool? */
  3587. if (!cpumask_test_cpu(cpu, pool->attrs->cpumask))
  3588. return;
  3589. /* is @cpu the only online CPU? */
  3590. cpumask_and(&cpumask, pool->attrs->cpumask, cpu_online_mask);
  3591. if (cpumask_weight(&cpumask) != 1)
  3592. return;
  3593. /* as we're called from CPU_ONLINE, the following shouldn't fail */
  3594. for_each_pool_worker(worker, wi, pool)
  3595. WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
  3596. pool->attrs->cpumask) < 0);
  3597. }
  3598. /*
  3599. * Workqueues should be brought up before normal priority CPU notifiers.
  3600. * This will be registered high priority CPU notifier.
  3601. */
  3602. static int __cpuinit workqueue_cpu_up_callback(struct notifier_block *nfb,
  3603. unsigned long action,
  3604. void *hcpu)
  3605. {
  3606. int cpu = (unsigned long)hcpu;
  3607. struct worker_pool *pool;
  3608. int pi;
  3609. switch (action & ~CPU_TASKS_FROZEN) {
  3610. case CPU_UP_PREPARE:
  3611. for_each_cpu_worker_pool(pool, cpu) {
  3612. if (pool->nr_workers)
  3613. continue;
  3614. if (create_and_start_worker(pool) < 0)
  3615. return NOTIFY_BAD;
  3616. }
  3617. break;
  3618. case CPU_DOWN_FAILED:
  3619. case CPU_ONLINE:
  3620. mutex_lock(&wq_pool_mutex);
  3621. for_each_pool(pool, pi) {
  3622. mutex_lock(&pool->manager_mutex);
  3623. if (pool->cpu == cpu) {
  3624. spin_lock_irq(&pool->lock);
  3625. pool->flags &= ~POOL_DISASSOCIATED;
  3626. spin_unlock_irq(&pool->lock);
  3627. rebind_workers(pool);
  3628. } else if (pool->cpu < 0) {
  3629. restore_unbound_workers_cpumask(pool, cpu);
  3630. }
  3631. mutex_unlock(&pool->manager_mutex);
  3632. }
  3633. mutex_unlock(&wq_pool_mutex);
  3634. break;
  3635. }
  3636. return NOTIFY_OK;
  3637. }
  3638. /*
  3639. * Workqueues should be brought down after normal priority CPU notifiers.
  3640. * This will be registered as low priority CPU notifier.
  3641. */
  3642. static int __cpuinit workqueue_cpu_down_callback(struct notifier_block *nfb,
  3643. unsigned long action,
  3644. void *hcpu)
  3645. {
  3646. int cpu = (unsigned long)hcpu;
  3647. struct work_struct unbind_work;
  3648. switch (action & ~CPU_TASKS_FROZEN) {
  3649. case CPU_DOWN_PREPARE:
  3650. /* unbinding should happen on the local CPU */
  3651. INIT_WORK_ONSTACK(&unbind_work, wq_unbind_fn);
  3652. queue_work_on(cpu, system_highpri_wq, &unbind_work);
  3653. flush_work(&unbind_work);
  3654. break;
  3655. }
  3656. return NOTIFY_OK;
  3657. }
  3658. #ifdef CONFIG_SMP
  3659. struct work_for_cpu {
  3660. struct work_struct work;
  3661. long (*fn)(void *);
  3662. void *arg;
  3663. long ret;
  3664. };
  3665. static void work_for_cpu_fn(struct work_struct *work)
  3666. {
  3667. struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
  3668. wfc->ret = wfc->fn(wfc->arg);
  3669. }
  3670. /**
  3671. * work_on_cpu - run a function in user context on a particular cpu
  3672. * @cpu: the cpu to run on
  3673. * @fn: the function to run
  3674. * @arg: the function arg
  3675. *
  3676. * This will return the value @fn returns.
  3677. * It is up to the caller to ensure that the cpu doesn't go offline.
  3678. * The caller must not hold any locks which would prevent @fn from completing.
  3679. */
  3680. long work_on_cpu(int cpu, long (*fn)(void *), void *arg)
  3681. {
  3682. struct work_for_cpu wfc = { .fn = fn, .arg = arg };
  3683. INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
  3684. schedule_work_on(cpu, &wfc.work);
  3685. flush_work(&wfc.work);
  3686. return wfc.ret;
  3687. }
  3688. EXPORT_SYMBOL_GPL(work_on_cpu);
  3689. #endif /* CONFIG_SMP */
  3690. #ifdef CONFIG_FREEZER
  3691. /**
  3692. * freeze_workqueues_begin - begin freezing workqueues
  3693. *
  3694. * Start freezing workqueues. After this function returns, all freezable
  3695. * workqueues will queue new works to their delayed_works list instead of
  3696. * pool->worklist.
  3697. *
  3698. * CONTEXT:
  3699. * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
  3700. */
  3701. void freeze_workqueues_begin(void)
  3702. {
  3703. struct worker_pool *pool;
  3704. struct workqueue_struct *wq;
  3705. struct pool_workqueue *pwq;
  3706. int pi;
  3707. mutex_lock(&wq_pool_mutex);
  3708. WARN_ON_ONCE(workqueue_freezing);
  3709. workqueue_freezing = true;
  3710. /* set FREEZING */
  3711. for_each_pool(pool, pi) {
  3712. spin_lock_irq(&pool->lock);
  3713. WARN_ON_ONCE(pool->flags & POOL_FREEZING);
  3714. pool->flags |= POOL_FREEZING;
  3715. spin_unlock_irq(&pool->lock);
  3716. }
  3717. list_for_each_entry(wq, &workqueues, list) {
  3718. mutex_lock(&wq->mutex);
  3719. for_each_pwq(pwq, wq)
  3720. pwq_adjust_max_active(pwq);
  3721. mutex_unlock(&wq->mutex);
  3722. }
  3723. mutex_unlock(&wq_pool_mutex);
  3724. }
  3725. /**
  3726. * freeze_workqueues_busy - are freezable workqueues still busy?
  3727. *
  3728. * Check whether freezing is complete. This function must be called
  3729. * between freeze_workqueues_begin() and thaw_workqueues().
  3730. *
  3731. * CONTEXT:
  3732. * Grabs and releases wq_pool_mutex.
  3733. *
  3734. * RETURNS:
  3735. * %true if some freezable workqueues are still busy. %false if freezing
  3736. * is complete.
  3737. */
  3738. bool freeze_workqueues_busy(void)
  3739. {
  3740. bool busy = false;
  3741. struct workqueue_struct *wq;
  3742. struct pool_workqueue *pwq;
  3743. mutex_lock(&wq_pool_mutex);
  3744. WARN_ON_ONCE(!workqueue_freezing);
  3745. list_for_each_entry(wq, &workqueues, list) {
  3746. if (!(wq->flags & WQ_FREEZABLE))
  3747. continue;
  3748. /*
  3749. * nr_active is monotonically decreasing. It's safe
  3750. * to peek without lock.
  3751. */
  3752. rcu_read_lock_sched();
  3753. for_each_pwq(pwq, wq) {
  3754. WARN_ON_ONCE(pwq->nr_active < 0);
  3755. if (pwq->nr_active) {
  3756. busy = true;
  3757. rcu_read_unlock_sched();
  3758. goto out_unlock;
  3759. }
  3760. }
  3761. rcu_read_unlock_sched();
  3762. }
  3763. out_unlock:
  3764. mutex_unlock(&wq_pool_mutex);
  3765. return busy;
  3766. }
  3767. /**
  3768. * thaw_workqueues - thaw workqueues
  3769. *
  3770. * Thaw workqueues. Normal queueing is restored and all collected
  3771. * frozen works are transferred to their respective pool worklists.
  3772. *
  3773. * CONTEXT:
  3774. * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
  3775. */
  3776. void thaw_workqueues(void)
  3777. {
  3778. struct workqueue_struct *wq;
  3779. struct pool_workqueue *pwq;
  3780. struct worker_pool *pool;
  3781. int pi;
  3782. mutex_lock(&wq_pool_mutex);
  3783. if (!workqueue_freezing)
  3784. goto out_unlock;
  3785. /* clear FREEZING */
  3786. for_each_pool(pool, pi) {
  3787. spin_lock_irq(&pool->lock);
  3788. WARN_ON_ONCE(!(pool->flags & POOL_FREEZING));
  3789. pool->flags &= ~POOL_FREEZING;
  3790. spin_unlock_irq(&pool->lock);
  3791. }
  3792. /* restore max_active and repopulate worklist */
  3793. list_for_each_entry(wq, &workqueues, list) {
  3794. mutex_lock(&wq->mutex);
  3795. for_each_pwq(pwq, wq)
  3796. pwq_adjust_max_active(pwq);
  3797. mutex_unlock(&wq->mutex);
  3798. }
  3799. workqueue_freezing = false;
  3800. out_unlock:
  3801. mutex_unlock(&wq_pool_mutex);
  3802. }
  3803. #endif /* CONFIG_FREEZER */
  3804. static void __init wq_numa_init(void)
  3805. {
  3806. cpumask_var_t *tbl;
  3807. int node, cpu;
  3808. /* determine NUMA pwq table len - highest node id + 1 */
  3809. for_each_node(node)
  3810. wq_numa_tbl_len = max(wq_numa_tbl_len, node + 1);
  3811. if (num_possible_nodes() <= 1)
  3812. return;
  3813. /*
  3814. * We want masks of possible CPUs of each node which isn't readily
  3815. * available. Build one from cpu_to_node() which should have been
  3816. * fully initialized by now.
  3817. */
  3818. tbl = kzalloc(wq_numa_tbl_len * sizeof(tbl[0]), GFP_KERNEL);
  3819. BUG_ON(!tbl);
  3820. for_each_node(node)
  3821. BUG_ON(!alloc_cpumask_var_node(&tbl[node], GFP_KERNEL, node));
  3822. for_each_possible_cpu(cpu) {
  3823. node = cpu_to_node(cpu);
  3824. if (WARN_ON(node == NUMA_NO_NODE)) {
  3825. pr_warn("workqueue: NUMA node mapping not available for cpu%d, disabling NUMA support\n", cpu);
  3826. /* happens iff arch is bonkers, let's just proceed */
  3827. return;
  3828. }
  3829. cpumask_set_cpu(cpu, tbl[node]);
  3830. }
  3831. wq_numa_possible_cpumask = tbl;
  3832. wq_numa_enabled = true;
  3833. }
  3834. static int __init init_workqueues(void)
  3835. {
  3836. int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL };
  3837. int i, cpu;
  3838. /* make sure we have enough bits for OFFQ pool ID */
  3839. BUILD_BUG_ON((1LU << (BITS_PER_LONG - WORK_OFFQ_POOL_SHIFT)) <
  3840. WORK_CPU_END * NR_STD_WORKER_POOLS);
  3841. WARN_ON(__alignof__(struct pool_workqueue) < __alignof__(long long));
  3842. pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC);
  3843. cpu_notifier(workqueue_cpu_up_callback, CPU_PRI_WORKQUEUE_UP);
  3844. hotcpu_notifier(workqueue_cpu_down_callback, CPU_PRI_WORKQUEUE_DOWN);
  3845. wq_numa_init();
  3846. /* initialize CPU pools */
  3847. for_each_possible_cpu(cpu) {
  3848. struct worker_pool *pool;
  3849. i = 0;
  3850. for_each_cpu_worker_pool(pool, cpu) {
  3851. BUG_ON(init_worker_pool(pool));
  3852. pool->cpu = cpu;
  3853. cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu));
  3854. pool->attrs->nice = std_nice[i++];
  3855. pool->node = cpu_to_node(cpu);
  3856. /* alloc pool ID */
  3857. mutex_lock(&wq_pool_mutex);
  3858. BUG_ON(worker_pool_assign_id(pool));
  3859. mutex_unlock(&wq_pool_mutex);
  3860. }
  3861. }
  3862. /* create the initial worker */
  3863. for_each_online_cpu(cpu) {
  3864. struct worker_pool *pool;
  3865. for_each_cpu_worker_pool(pool, cpu) {
  3866. pool->flags &= ~POOL_DISASSOCIATED;
  3867. BUG_ON(create_and_start_worker(pool) < 0);
  3868. }
  3869. }
  3870. /* create default unbound wq attrs */
  3871. for (i = 0; i < NR_STD_WORKER_POOLS; i++) {
  3872. struct workqueue_attrs *attrs;
  3873. BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
  3874. attrs->nice = std_nice[i];
  3875. unbound_std_wq_attrs[i] = attrs;
  3876. }
  3877. system_wq = alloc_workqueue("events", 0, 0);
  3878. system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
  3879. system_long_wq = alloc_workqueue("events_long", 0, 0);
  3880. system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
  3881. WQ_UNBOUND_MAX_ACTIVE);
  3882. system_freezable_wq = alloc_workqueue("events_freezable",
  3883. WQ_FREEZABLE, 0);
  3884. BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
  3885. !system_unbound_wq || !system_freezable_wq);
  3886. return 0;
  3887. }
  3888. early_initcall(init_workqueues);