workqueue.c 104 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842
  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 "workqueue_sched.h"
  44. enum {
  45. /* global_cwq flags */
  46. GCWQ_MANAGE_WORKERS = 1 << 0, /* need to manage workers */
  47. GCWQ_MANAGING_WORKERS = 1 << 1, /* managing workers */
  48. GCWQ_DISASSOCIATED = 1 << 2, /* cpu can't serve workers */
  49. GCWQ_FREEZING = 1 << 3, /* freeze in progress */
  50. GCWQ_HIGHPRI_PENDING = 1 << 4, /* highpri works on queue */
  51. /* worker flags */
  52. WORKER_STARTED = 1 << 0, /* started */
  53. WORKER_DIE = 1 << 1, /* die die die */
  54. WORKER_IDLE = 1 << 2, /* is idle */
  55. WORKER_PREP = 1 << 3, /* preparing to run works */
  56. WORKER_ROGUE = 1 << 4, /* not bound to any cpu */
  57. WORKER_REBIND = 1 << 5, /* mom is home, come back */
  58. WORKER_CPU_INTENSIVE = 1 << 6, /* cpu intensive */
  59. WORKER_UNBOUND = 1 << 7, /* worker is unbound */
  60. WORKER_NOT_RUNNING = WORKER_PREP | WORKER_ROGUE | WORKER_REBIND |
  61. WORKER_CPU_INTENSIVE | WORKER_UNBOUND,
  62. /* gcwq->trustee_state */
  63. TRUSTEE_START = 0, /* start */
  64. TRUSTEE_IN_CHARGE = 1, /* trustee in charge of gcwq */
  65. TRUSTEE_BUTCHER = 2, /* butcher workers */
  66. TRUSTEE_RELEASE = 3, /* release workers */
  67. TRUSTEE_DONE = 4, /* trustee is done */
  68. BUSY_WORKER_HASH_ORDER = 6, /* 64 pointers */
  69. BUSY_WORKER_HASH_SIZE = 1 << BUSY_WORKER_HASH_ORDER,
  70. BUSY_WORKER_HASH_MASK = BUSY_WORKER_HASH_SIZE - 1,
  71. MAX_IDLE_WORKERS_RATIO = 4, /* 1/4 of busy can be idle */
  72. IDLE_WORKER_TIMEOUT = 300 * HZ, /* keep idle ones for 5 mins */
  73. MAYDAY_INITIAL_TIMEOUT = HZ / 100 >= 2 ? HZ / 100 : 2,
  74. /* call for help after 10ms
  75. (min two ticks) */
  76. MAYDAY_INTERVAL = HZ / 10, /* and then every 100ms */
  77. CREATE_COOLDOWN = HZ, /* time to breath after fail */
  78. TRUSTEE_COOLDOWN = HZ / 10, /* for trustee draining */
  79. /*
  80. * Rescue workers are used only on emergencies and shared by
  81. * all cpus. Give -20.
  82. */
  83. RESCUER_NICE_LEVEL = -20,
  84. };
  85. /*
  86. * Structure fields follow one of the following exclusion rules.
  87. *
  88. * I: Modifiable by initialization/destruction paths and read-only for
  89. * everyone else.
  90. *
  91. * P: Preemption protected. Disabling preemption is enough and should
  92. * only be modified and accessed from the local cpu.
  93. *
  94. * L: gcwq->lock protected. Access with gcwq->lock held.
  95. *
  96. * X: During normal operation, modification requires gcwq->lock and
  97. * should be done only from local cpu. Either disabling preemption
  98. * on local cpu or grabbing gcwq->lock is enough for read access.
  99. * If GCWQ_DISASSOCIATED is set, it's identical to L.
  100. *
  101. * F: wq->flush_mutex protected.
  102. *
  103. * W: workqueue_lock protected.
  104. */
  105. struct global_cwq;
  106. /*
  107. * The poor guys doing the actual heavy lifting. All on-duty workers
  108. * are either serving the manager role, on idle list or on busy hash.
  109. */
  110. struct worker {
  111. /* on idle list while idle, on busy hash table while busy */
  112. union {
  113. struct list_head entry; /* L: while idle */
  114. struct hlist_node hentry; /* L: while busy */
  115. };
  116. struct work_struct *current_work; /* L: work being processed */
  117. struct cpu_workqueue_struct *current_cwq; /* L: current_work's cwq */
  118. struct list_head scheduled; /* L: scheduled works */
  119. struct task_struct *task; /* I: worker task */
  120. struct global_cwq *gcwq; /* I: the associated gcwq */
  121. /* 64 bytes boundary on 64bit, 32 on 32bit */
  122. unsigned long last_active; /* L: last active timestamp */
  123. unsigned int flags; /* X: flags */
  124. int id; /* I: worker id */
  125. struct work_struct rebind_work; /* L: rebind worker to cpu */
  126. };
  127. /*
  128. * Global per-cpu workqueue. There's one and only one for each cpu
  129. * and all works are queued and processed here regardless of their
  130. * target workqueues.
  131. */
  132. struct global_cwq {
  133. spinlock_t lock; /* the gcwq lock */
  134. struct list_head worklist; /* L: list of pending works */
  135. unsigned int cpu; /* I: the associated cpu */
  136. unsigned int flags; /* L: GCWQ_* flags */
  137. int nr_workers; /* L: total number of workers */
  138. int nr_idle; /* L: currently idle ones */
  139. /* workers are chained either in the idle_list or busy_hash */
  140. struct list_head idle_list; /* X: list of idle workers */
  141. struct hlist_head busy_hash[BUSY_WORKER_HASH_SIZE];
  142. /* L: hash of busy workers */
  143. struct timer_list idle_timer; /* L: worker idle timeout */
  144. struct timer_list mayday_timer; /* L: SOS timer for dworkers */
  145. struct ida worker_ida; /* L: for worker IDs */
  146. struct task_struct *trustee; /* L: for gcwq shutdown */
  147. unsigned int trustee_state; /* L: trustee state */
  148. wait_queue_head_t trustee_wait; /* trustee wait */
  149. struct worker *first_idle; /* L: first idle worker */
  150. } ____cacheline_aligned_in_smp;
  151. /*
  152. * The per-CPU workqueue. The lower WORK_STRUCT_FLAG_BITS of
  153. * work_struct->data are used for flags and thus cwqs need to be
  154. * aligned at two's power of the number of flag bits.
  155. */
  156. struct cpu_workqueue_struct {
  157. struct global_cwq *gcwq; /* I: the associated gcwq */
  158. struct workqueue_struct *wq; /* I: the owning workqueue */
  159. int work_color; /* L: current color */
  160. int flush_color; /* L: flushing color */
  161. int nr_in_flight[WORK_NR_COLORS];
  162. /* L: nr of in_flight works */
  163. int nr_active; /* L: nr of active works */
  164. int max_active; /* L: max active works */
  165. struct list_head delayed_works; /* L: delayed works */
  166. };
  167. /*
  168. * Structure used to wait for workqueue flush.
  169. */
  170. struct wq_flusher {
  171. struct list_head list; /* F: list of flushers */
  172. int flush_color; /* F: flush color waiting for */
  173. struct completion done; /* flush completion */
  174. };
  175. /*
  176. * All cpumasks are assumed to be always set on UP and thus can't be
  177. * used to determine whether there's something to be done.
  178. */
  179. #ifdef CONFIG_SMP
  180. typedef cpumask_var_t mayday_mask_t;
  181. #define mayday_test_and_set_cpu(cpu, mask) \
  182. cpumask_test_and_set_cpu((cpu), (mask))
  183. #define mayday_clear_cpu(cpu, mask) cpumask_clear_cpu((cpu), (mask))
  184. #define for_each_mayday_cpu(cpu, mask) for_each_cpu((cpu), (mask))
  185. #define alloc_mayday_mask(maskp, gfp) zalloc_cpumask_var((maskp), (gfp))
  186. #define free_mayday_mask(mask) free_cpumask_var((mask))
  187. #else
  188. typedef unsigned long mayday_mask_t;
  189. #define mayday_test_and_set_cpu(cpu, mask) test_and_set_bit(0, &(mask))
  190. #define mayday_clear_cpu(cpu, mask) clear_bit(0, &(mask))
  191. #define for_each_mayday_cpu(cpu, mask) if ((cpu) = 0, (mask))
  192. #define alloc_mayday_mask(maskp, gfp) true
  193. #define free_mayday_mask(mask) do { } while (0)
  194. #endif
  195. /*
  196. * The externally visible workqueue abstraction is an array of
  197. * per-CPU workqueues:
  198. */
  199. struct workqueue_struct {
  200. unsigned int flags; /* W: WQ_* flags */
  201. union {
  202. struct cpu_workqueue_struct __percpu *pcpu;
  203. struct cpu_workqueue_struct *single;
  204. unsigned long v;
  205. } cpu_wq; /* I: cwq's */
  206. struct list_head list; /* W: list of all workqueues */
  207. struct mutex flush_mutex; /* protects wq flushing */
  208. int work_color; /* F: current work color */
  209. int flush_color; /* F: current flush color */
  210. atomic_t nr_cwqs_to_flush; /* flush in progress */
  211. struct wq_flusher *first_flusher; /* F: first flusher */
  212. struct list_head flusher_queue; /* F: flush waiters */
  213. struct list_head flusher_overflow; /* F: flush overflow list */
  214. mayday_mask_t mayday_mask; /* cpus requesting rescue */
  215. struct worker *rescuer; /* I: rescue worker */
  216. int nr_drainers; /* W: drain in progress */
  217. int saved_max_active; /* W: saved cwq max_active */
  218. #ifdef CONFIG_LOCKDEP
  219. struct lockdep_map lockdep_map;
  220. #endif
  221. char name[]; /* I: workqueue name */
  222. };
  223. struct workqueue_struct *system_wq __read_mostly;
  224. struct workqueue_struct *system_long_wq __read_mostly;
  225. struct workqueue_struct *system_nrt_wq __read_mostly;
  226. struct workqueue_struct *system_unbound_wq __read_mostly;
  227. struct workqueue_struct *system_freezable_wq __read_mostly;
  228. struct workqueue_struct *system_nrt_freezable_wq __read_mostly;
  229. EXPORT_SYMBOL_GPL(system_wq);
  230. EXPORT_SYMBOL_GPL(system_long_wq);
  231. EXPORT_SYMBOL_GPL(system_nrt_wq);
  232. EXPORT_SYMBOL_GPL(system_unbound_wq);
  233. EXPORT_SYMBOL_GPL(system_freezable_wq);
  234. EXPORT_SYMBOL_GPL(system_nrt_freezable_wq);
  235. #define CREATE_TRACE_POINTS
  236. #include <trace/events/workqueue.h>
  237. #define for_each_busy_worker(worker, i, pos, gcwq) \
  238. for (i = 0; i < BUSY_WORKER_HASH_SIZE; i++) \
  239. hlist_for_each_entry(worker, pos, &gcwq->busy_hash[i], hentry)
  240. static inline int __next_gcwq_cpu(int cpu, const struct cpumask *mask,
  241. unsigned int sw)
  242. {
  243. if (cpu < nr_cpu_ids) {
  244. if (sw & 1) {
  245. cpu = cpumask_next(cpu, mask);
  246. if (cpu < nr_cpu_ids)
  247. return cpu;
  248. }
  249. if (sw & 2)
  250. return WORK_CPU_UNBOUND;
  251. }
  252. return WORK_CPU_NONE;
  253. }
  254. static inline int __next_wq_cpu(int cpu, const struct cpumask *mask,
  255. struct workqueue_struct *wq)
  256. {
  257. return __next_gcwq_cpu(cpu, mask, !(wq->flags & WQ_UNBOUND) ? 1 : 2);
  258. }
  259. /*
  260. * CPU iterators
  261. *
  262. * An extra gcwq is defined for an invalid cpu number
  263. * (WORK_CPU_UNBOUND) to host workqueues which are not bound to any
  264. * specific CPU. The following iterators are similar to
  265. * for_each_*_cpu() iterators but also considers the unbound gcwq.
  266. *
  267. * for_each_gcwq_cpu() : possible CPUs + WORK_CPU_UNBOUND
  268. * for_each_online_gcwq_cpu() : online CPUs + WORK_CPU_UNBOUND
  269. * for_each_cwq_cpu() : possible CPUs for bound workqueues,
  270. * WORK_CPU_UNBOUND for unbound workqueues
  271. */
  272. #define for_each_gcwq_cpu(cpu) \
  273. for ((cpu) = __next_gcwq_cpu(-1, cpu_possible_mask, 3); \
  274. (cpu) < WORK_CPU_NONE; \
  275. (cpu) = __next_gcwq_cpu((cpu), cpu_possible_mask, 3))
  276. #define for_each_online_gcwq_cpu(cpu) \
  277. for ((cpu) = __next_gcwq_cpu(-1, cpu_online_mask, 3); \
  278. (cpu) < WORK_CPU_NONE; \
  279. (cpu) = __next_gcwq_cpu((cpu), cpu_online_mask, 3))
  280. #define for_each_cwq_cpu(cpu, wq) \
  281. for ((cpu) = __next_wq_cpu(-1, cpu_possible_mask, (wq)); \
  282. (cpu) < WORK_CPU_NONE; \
  283. (cpu) = __next_wq_cpu((cpu), cpu_possible_mask, (wq)))
  284. #ifdef CONFIG_DEBUG_OBJECTS_WORK
  285. static struct debug_obj_descr work_debug_descr;
  286. static void *work_debug_hint(void *addr)
  287. {
  288. return ((struct work_struct *) addr)->func;
  289. }
  290. /*
  291. * fixup_init is called when:
  292. * - an active object is initialized
  293. */
  294. static int work_fixup_init(void *addr, enum debug_obj_state state)
  295. {
  296. struct work_struct *work = addr;
  297. switch (state) {
  298. case ODEBUG_STATE_ACTIVE:
  299. cancel_work_sync(work);
  300. debug_object_init(work, &work_debug_descr);
  301. return 1;
  302. default:
  303. return 0;
  304. }
  305. }
  306. /*
  307. * fixup_activate is called when:
  308. * - an active object is activated
  309. * - an unknown object is activated (might be a statically initialized object)
  310. */
  311. static int work_fixup_activate(void *addr, enum debug_obj_state state)
  312. {
  313. struct work_struct *work = addr;
  314. switch (state) {
  315. case ODEBUG_STATE_NOTAVAILABLE:
  316. /*
  317. * This is not really a fixup. The work struct was
  318. * statically initialized. We just make sure that it
  319. * is tracked in the object tracker.
  320. */
  321. if (test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work))) {
  322. debug_object_init(work, &work_debug_descr);
  323. debug_object_activate(work, &work_debug_descr);
  324. return 0;
  325. }
  326. WARN_ON_ONCE(1);
  327. return 0;
  328. case ODEBUG_STATE_ACTIVE:
  329. WARN_ON(1);
  330. default:
  331. return 0;
  332. }
  333. }
  334. /*
  335. * fixup_free is called when:
  336. * - an active object is freed
  337. */
  338. static int work_fixup_free(void *addr, enum debug_obj_state state)
  339. {
  340. struct work_struct *work = addr;
  341. switch (state) {
  342. case ODEBUG_STATE_ACTIVE:
  343. cancel_work_sync(work);
  344. debug_object_free(work, &work_debug_descr);
  345. return 1;
  346. default:
  347. return 0;
  348. }
  349. }
  350. static struct debug_obj_descr work_debug_descr = {
  351. .name = "work_struct",
  352. .debug_hint = work_debug_hint,
  353. .fixup_init = work_fixup_init,
  354. .fixup_activate = work_fixup_activate,
  355. .fixup_free = work_fixup_free,
  356. };
  357. static inline void debug_work_activate(struct work_struct *work)
  358. {
  359. debug_object_activate(work, &work_debug_descr);
  360. }
  361. static inline void debug_work_deactivate(struct work_struct *work)
  362. {
  363. debug_object_deactivate(work, &work_debug_descr);
  364. }
  365. void __init_work(struct work_struct *work, int onstack)
  366. {
  367. if (onstack)
  368. debug_object_init_on_stack(work, &work_debug_descr);
  369. else
  370. debug_object_init(work, &work_debug_descr);
  371. }
  372. EXPORT_SYMBOL_GPL(__init_work);
  373. void destroy_work_on_stack(struct work_struct *work)
  374. {
  375. debug_object_free(work, &work_debug_descr);
  376. }
  377. EXPORT_SYMBOL_GPL(destroy_work_on_stack);
  378. #else
  379. static inline void debug_work_activate(struct work_struct *work) { }
  380. static inline void debug_work_deactivate(struct work_struct *work) { }
  381. #endif
  382. /* Serializes the accesses to the list of workqueues. */
  383. static DEFINE_SPINLOCK(workqueue_lock);
  384. static LIST_HEAD(workqueues);
  385. static bool workqueue_freezing; /* W: have wqs started freezing? */
  386. /*
  387. * The almighty global cpu workqueues. nr_running is the only field
  388. * which is expected to be used frequently by other cpus via
  389. * try_to_wake_up(). Put it in a separate cacheline.
  390. */
  391. static DEFINE_PER_CPU(struct global_cwq, global_cwq);
  392. static DEFINE_PER_CPU_SHARED_ALIGNED(atomic_t, gcwq_nr_running);
  393. /*
  394. * Global cpu workqueue and nr_running counter for unbound gcwq. The
  395. * gcwq is always online, has GCWQ_DISASSOCIATED set, and all its
  396. * workers have WORKER_UNBOUND set.
  397. */
  398. static struct global_cwq unbound_global_cwq;
  399. static atomic_t unbound_gcwq_nr_running = ATOMIC_INIT(0); /* always 0 */
  400. static int worker_thread(void *__worker);
  401. static struct global_cwq *get_gcwq(unsigned int cpu)
  402. {
  403. if (cpu != WORK_CPU_UNBOUND)
  404. return &per_cpu(global_cwq, cpu);
  405. else
  406. return &unbound_global_cwq;
  407. }
  408. static atomic_t *get_gcwq_nr_running(unsigned int cpu)
  409. {
  410. if (cpu != WORK_CPU_UNBOUND)
  411. return &per_cpu(gcwq_nr_running, cpu);
  412. else
  413. return &unbound_gcwq_nr_running;
  414. }
  415. static struct cpu_workqueue_struct *get_cwq(unsigned int cpu,
  416. struct workqueue_struct *wq)
  417. {
  418. if (!(wq->flags & WQ_UNBOUND)) {
  419. if (likely(cpu < nr_cpu_ids))
  420. return per_cpu_ptr(wq->cpu_wq.pcpu, cpu);
  421. } else if (likely(cpu == WORK_CPU_UNBOUND))
  422. return wq->cpu_wq.single;
  423. return NULL;
  424. }
  425. static unsigned int work_color_to_flags(int color)
  426. {
  427. return color << WORK_STRUCT_COLOR_SHIFT;
  428. }
  429. static int get_work_color(struct work_struct *work)
  430. {
  431. return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
  432. ((1 << WORK_STRUCT_COLOR_BITS) - 1);
  433. }
  434. static int work_next_color(int color)
  435. {
  436. return (color + 1) % WORK_NR_COLORS;
  437. }
  438. /*
  439. * A work's data points to the cwq with WORK_STRUCT_CWQ set while the
  440. * work is on queue. Once execution starts, WORK_STRUCT_CWQ is
  441. * cleared and the work data contains the cpu number it was last on.
  442. *
  443. * set_work_{cwq|cpu}() and clear_work_data() can be used to set the
  444. * cwq, cpu or clear work->data. These functions should only be
  445. * called while the work is owned - ie. while the PENDING bit is set.
  446. *
  447. * get_work_[g]cwq() can be used to obtain the gcwq or cwq
  448. * corresponding to a work. gcwq is available once the work has been
  449. * queued anywhere after initialization. cwq is available only from
  450. * queueing until execution starts.
  451. */
  452. static inline void set_work_data(struct work_struct *work, unsigned long data,
  453. unsigned long flags)
  454. {
  455. BUG_ON(!work_pending(work));
  456. atomic_long_set(&work->data, data | flags | work_static(work));
  457. }
  458. static void set_work_cwq(struct work_struct *work,
  459. struct cpu_workqueue_struct *cwq,
  460. unsigned long extra_flags)
  461. {
  462. set_work_data(work, (unsigned long)cwq,
  463. WORK_STRUCT_PENDING | WORK_STRUCT_CWQ | extra_flags);
  464. }
  465. static void set_work_cpu(struct work_struct *work, unsigned int cpu)
  466. {
  467. set_work_data(work, cpu << WORK_STRUCT_FLAG_BITS, WORK_STRUCT_PENDING);
  468. }
  469. static void clear_work_data(struct work_struct *work)
  470. {
  471. set_work_data(work, WORK_STRUCT_NO_CPU, 0);
  472. }
  473. static struct cpu_workqueue_struct *get_work_cwq(struct work_struct *work)
  474. {
  475. unsigned long data = atomic_long_read(&work->data);
  476. if (data & WORK_STRUCT_CWQ)
  477. return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
  478. else
  479. return NULL;
  480. }
  481. static struct global_cwq *get_work_gcwq(struct work_struct *work)
  482. {
  483. unsigned long data = atomic_long_read(&work->data);
  484. unsigned int cpu;
  485. if (data & WORK_STRUCT_CWQ)
  486. return ((struct cpu_workqueue_struct *)
  487. (data & WORK_STRUCT_WQ_DATA_MASK))->gcwq;
  488. cpu = data >> WORK_STRUCT_FLAG_BITS;
  489. if (cpu == WORK_CPU_NONE)
  490. return NULL;
  491. BUG_ON(cpu >= nr_cpu_ids && cpu != WORK_CPU_UNBOUND);
  492. return get_gcwq(cpu);
  493. }
  494. /*
  495. * Policy functions. These define the policies on how the global
  496. * worker pool is managed. Unless noted otherwise, these functions
  497. * assume that they're being called with gcwq->lock held.
  498. */
  499. static bool __need_more_worker(struct global_cwq *gcwq)
  500. {
  501. return !atomic_read(get_gcwq_nr_running(gcwq->cpu)) ||
  502. gcwq->flags & GCWQ_HIGHPRI_PENDING;
  503. }
  504. /*
  505. * Need to wake up a worker? Called from anything but currently
  506. * running workers.
  507. */
  508. static bool need_more_worker(struct global_cwq *gcwq)
  509. {
  510. return !list_empty(&gcwq->worklist) && __need_more_worker(gcwq);
  511. }
  512. /* Can I start working? Called from busy but !running workers. */
  513. static bool may_start_working(struct global_cwq *gcwq)
  514. {
  515. return gcwq->nr_idle;
  516. }
  517. /* Do I need to keep working? Called from currently running workers. */
  518. static bool keep_working(struct global_cwq *gcwq)
  519. {
  520. atomic_t *nr_running = get_gcwq_nr_running(gcwq->cpu);
  521. return !list_empty(&gcwq->worklist) &&
  522. (atomic_read(nr_running) <= 1 ||
  523. gcwq->flags & GCWQ_HIGHPRI_PENDING);
  524. }
  525. /* Do we need a new worker? Called from manager. */
  526. static bool need_to_create_worker(struct global_cwq *gcwq)
  527. {
  528. return need_more_worker(gcwq) && !may_start_working(gcwq);
  529. }
  530. /* Do I need to be the manager? */
  531. static bool need_to_manage_workers(struct global_cwq *gcwq)
  532. {
  533. return need_to_create_worker(gcwq) || gcwq->flags & GCWQ_MANAGE_WORKERS;
  534. }
  535. /* Do we have too many workers and should some go away? */
  536. static bool too_many_workers(struct global_cwq *gcwq)
  537. {
  538. bool managing = gcwq->flags & GCWQ_MANAGING_WORKERS;
  539. int nr_idle = gcwq->nr_idle + managing; /* manager is considered idle */
  540. int nr_busy = gcwq->nr_workers - nr_idle;
  541. return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
  542. }
  543. /*
  544. * Wake up functions.
  545. */
  546. /* Return the first worker. Safe with preemption disabled */
  547. static struct worker *first_worker(struct global_cwq *gcwq)
  548. {
  549. if (unlikely(list_empty(&gcwq->idle_list)))
  550. return NULL;
  551. return list_first_entry(&gcwq->idle_list, struct worker, entry);
  552. }
  553. /**
  554. * wake_up_worker - wake up an idle worker
  555. * @gcwq: gcwq to wake worker for
  556. *
  557. * Wake up the first idle worker of @gcwq.
  558. *
  559. * CONTEXT:
  560. * spin_lock_irq(gcwq->lock).
  561. */
  562. static void wake_up_worker(struct global_cwq *gcwq)
  563. {
  564. struct worker *worker = first_worker(gcwq);
  565. if (likely(worker))
  566. wake_up_process(worker->task);
  567. }
  568. /**
  569. * wq_worker_waking_up - a worker is waking up
  570. * @task: task waking up
  571. * @cpu: CPU @task is waking up to
  572. *
  573. * This function is called during try_to_wake_up() when a worker is
  574. * being awoken.
  575. *
  576. * CONTEXT:
  577. * spin_lock_irq(rq->lock)
  578. */
  579. void wq_worker_waking_up(struct task_struct *task, unsigned int cpu)
  580. {
  581. struct worker *worker = kthread_data(task);
  582. if (!(worker->flags & WORKER_NOT_RUNNING))
  583. atomic_inc(get_gcwq_nr_running(cpu));
  584. }
  585. /**
  586. * wq_worker_sleeping - a worker is going to sleep
  587. * @task: task going to sleep
  588. * @cpu: CPU in question, must be the current CPU number
  589. *
  590. * This function is called during schedule() when a busy worker is
  591. * going to sleep. Worker on the same cpu can be woken up by
  592. * returning pointer to its task.
  593. *
  594. * CONTEXT:
  595. * spin_lock_irq(rq->lock)
  596. *
  597. * RETURNS:
  598. * Worker task on @cpu to wake up, %NULL if none.
  599. */
  600. struct task_struct *wq_worker_sleeping(struct task_struct *task,
  601. unsigned int cpu)
  602. {
  603. struct worker *worker = kthread_data(task), *to_wakeup = NULL;
  604. struct global_cwq *gcwq = get_gcwq(cpu);
  605. atomic_t *nr_running = get_gcwq_nr_running(cpu);
  606. if (worker->flags & WORKER_NOT_RUNNING)
  607. return NULL;
  608. /* this can only happen on the local cpu */
  609. BUG_ON(cpu != raw_smp_processor_id());
  610. /*
  611. * The counterpart of the following dec_and_test, implied mb,
  612. * worklist not empty test sequence is in insert_work().
  613. * Please read comment there.
  614. *
  615. * NOT_RUNNING is clear. This means that trustee is not in
  616. * charge and we're running on the local cpu w/ rq lock held
  617. * and preemption disabled, which in turn means that none else
  618. * could be manipulating idle_list, so dereferencing idle_list
  619. * without gcwq lock is safe.
  620. */
  621. if (atomic_dec_and_test(nr_running) && !list_empty(&gcwq->worklist))
  622. to_wakeup = first_worker(gcwq);
  623. return to_wakeup ? to_wakeup->task : NULL;
  624. }
  625. /**
  626. * worker_set_flags - set worker flags and adjust nr_running accordingly
  627. * @worker: self
  628. * @flags: flags to set
  629. * @wakeup: wakeup an idle worker if necessary
  630. *
  631. * Set @flags in @worker->flags and adjust nr_running accordingly. If
  632. * nr_running becomes zero and @wakeup is %true, an idle worker is
  633. * woken up.
  634. *
  635. * CONTEXT:
  636. * spin_lock_irq(gcwq->lock)
  637. */
  638. static inline void worker_set_flags(struct worker *worker, unsigned int flags,
  639. bool wakeup)
  640. {
  641. struct global_cwq *gcwq = worker->gcwq;
  642. WARN_ON_ONCE(worker->task != current);
  643. /*
  644. * If transitioning into NOT_RUNNING, adjust nr_running and
  645. * wake up an idle worker as necessary if requested by
  646. * @wakeup.
  647. */
  648. if ((flags & WORKER_NOT_RUNNING) &&
  649. !(worker->flags & WORKER_NOT_RUNNING)) {
  650. atomic_t *nr_running = get_gcwq_nr_running(gcwq->cpu);
  651. if (wakeup) {
  652. if (atomic_dec_and_test(nr_running) &&
  653. !list_empty(&gcwq->worklist))
  654. wake_up_worker(gcwq);
  655. } else
  656. atomic_dec(nr_running);
  657. }
  658. worker->flags |= flags;
  659. }
  660. /**
  661. * worker_clr_flags - clear worker flags and adjust nr_running accordingly
  662. * @worker: self
  663. * @flags: flags to clear
  664. *
  665. * Clear @flags in @worker->flags and adjust nr_running accordingly.
  666. *
  667. * CONTEXT:
  668. * spin_lock_irq(gcwq->lock)
  669. */
  670. static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
  671. {
  672. struct global_cwq *gcwq = worker->gcwq;
  673. unsigned int oflags = worker->flags;
  674. WARN_ON_ONCE(worker->task != current);
  675. worker->flags &= ~flags;
  676. /*
  677. * If transitioning out of NOT_RUNNING, increment nr_running. Note
  678. * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask
  679. * of multiple flags, not a single flag.
  680. */
  681. if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
  682. if (!(worker->flags & WORKER_NOT_RUNNING))
  683. atomic_inc(get_gcwq_nr_running(gcwq->cpu));
  684. }
  685. /**
  686. * busy_worker_head - return the busy hash head for a work
  687. * @gcwq: gcwq of interest
  688. * @work: work to be hashed
  689. *
  690. * Return hash head of @gcwq for @work.
  691. *
  692. * CONTEXT:
  693. * spin_lock_irq(gcwq->lock).
  694. *
  695. * RETURNS:
  696. * Pointer to the hash head.
  697. */
  698. static struct hlist_head *busy_worker_head(struct global_cwq *gcwq,
  699. struct work_struct *work)
  700. {
  701. const int base_shift = ilog2(sizeof(struct work_struct));
  702. unsigned long v = (unsigned long)work;
  703. /* simple shift and fold hash, do we need something better? */
  704. v >>= base_shift;
  705. v += v >> BUSY_WORKER_HASH_ORDER;
  706. v &= BUSY_WORKER_HASH_MASK;
  707. return &gcwq->busy_hash[v];
  708. }
  709. /**
  710. * __find_worker_executing_work - find worker which is executing a work
  711. * @gcwq: gcwq of interest
  712. * @bwh: hash head as returned by busy_worker_head()
  713. * @work: work to find worker for
  714. *
  715. * Find a worker which is executing @work on @gcwq. @bwh should be
  716. * the hash head obtained by calling busy_worker_head() with the same
  717. * work.
  718. *
  719. * CONTEXT:
  720. * spin_lock_irq(gcwq->lock).
  721. *
  722. * RETURNS:
  723. * Pointer to worker which is executing @work if found, NULL
  724. * otherwise.
  725. */
  726. static struct worker *__find_worker_executing_work(struct global_cwq *gcwq,
  727. struct hlist_head *bwh,
  728. struct work_struct *work)
  729. {
  730. struct worker *worker;
  731. struct hlist_node *tmp;
  732. hlist_for_each_entry(worker, tmp, bwh, hentry)
  733. if (worker->current_work == work)
  734. return worker;
  735. return NULL;
  736. }
  737. /**
  738. * find_worker_executing_work - find worker which is executing a work
  739. * @gcwq: gcwq of interest
  740. * @work: work to find worker for
  741. *
  742. * Find a worker which is executing @work on @gcwq. This function is
  743. * identical to __find_worker_executing_work() except that this
  744. * function calculates @bwh itself.
  745. *
  746. * CONTEXT:
  747. * spin_lock_irq(gcwq->lock).
  748. *
  749. * RETURNS:
  750. * Pointer to worker which is executing @work if found, NULL
  751. * otherwise.
  752. */
  753. static struct worker *find_worker_executing_work(struct global_cwq *gcwq,
  754. struct work_struct *work)
  755. {
  756. return __find_worker_executing_work(gcwq, busy_worker_head(gcwq, work),
  757. work);
  758. }
  759. /**
  760. * gcwq_determine_ins_pos - find insertion position
  761. * @gcwq: gcwq of interest
  762. * @cwq: cwq a work is being queued for
  763. *
  764. * A work for @cwq is about to be queued on @gcwq, determine insertion
  765. * position for the work. If @cwq is for HIGHPRI wq, the work is
  766. * queued at the head of the queue but in FIFO order with respect to
  767. * other HIGHPRI works; otherwise, at the end of the queue. This
  768. * function also sets GCWQ_HIGHPRI_PENDING flag to hint @gcwq that
  769. * there are HIGHPRI works pending.
  770. *
  771. * CONTEXT:
  772. * spin_lock_irq(gcwq->lock).
  773. *
  774. * RETURNS:
  775. * Pointer to inserstion position.
  776. */
  777. static inline struct list_head *gcwq_determine_ins_pos(struct global_cwq *gcwq,
  778. struct cpu_workqueue_struct *cwq)
  779. {
  780. struct work_struct *twork;
  781. if (likely(!(cwq->wq->flags & WQ_HIGHPRI)))
  782. return &gcwq->worklist;
  783. list_for_each_entry(twork, &gcwq->worklist, entry) {
  784. struct cpu_workqueue_struct *tcwq = get_work_cwq(twork);
  785. if (!(tcwq->wq->flags & WQ_HIGHPRI))
  786. break;
  787. }
  788. gcwq->flags |= GCWQ_HIGHPRI_PENDING;
  789. return &twork->entry;
  790. }
  791. /**
  792. * insert_work - insert a work into gcwq
  793. * @cwq: cwq @work belongs to
  794. * @work: work to insert
  795. * @head: insertion point
  796. * @extra_flags: extra WORK_STRUCT_* flags to set
  797. *
  798. * Insert @work which belongs to @cwq into @gcwq after @head.
  799. * @extra_flags is or'd to work_struct flags.
  800. *
  801. * CONTEXT:
  802. * spin_lock_irq(gcwq->lock).
  803. */
  804. static void insert_work(struct cpu_workqueue_struct *cwq,
  805. struct work_struct *work, struct list_head *head,
  806. unsigned int extra_flags)
  807. {
  808. struct global_cwq *gcwq = cwq->gcwq;
  809. /* we own @work, set data and link */
  810. set_work_cwq(work, cwq, extra_flags);
  811. /*
  812. * Ensure that we get the right work->data if we see the
  813. * result of list_add() below, see try_to_grab_pending().
  814. */
  815. smp_wmb();
  816. list_add_tail(&work->entry, head);
  817. /*
  818. * Ensure either worker_sched_deactivated() sees the above
  819. * list_add_tail() or we see zero nr_running to avoid workers
  820. * lying around lazily while there are works to be processed.
  821. */
  822. smp_mb();
  823. if (__need_more_worker(gcwq))
  824. wake_up_worker(gcwq);
  825. }
  826. /*
  827. * Test whether @work is being queued from another work executing on the
  828. * same workqueue. This is rather expensive and should only be used from
  829. * cold paths.
  830. */
  831. static bool is_chained_work(struct workqueue_struct *wq)
  832. {
  833. unsigned long flags;
  834. unsigned int cpu;
  835. for_each_gcwq_cpu(cpu) {
  836. struct global_cwq *gcwq = get_gcwq(cpu);
  837. struct worker *worker;
  838. struct hlist_node *pos;
  839. int i;
  840. spin_lock_irqsave(&gcwq->lock, flags);
  841. for_each_busy_worker(worker, i, pos, gcwq) {
  842. if (worker->task != current)
  843. continue;
  844. spin_unlock_irqrestore(&gcwq->lock, flags);
  845. /*
  846. * I'm @worker, no locking necessary. See if @work
  847. * is headed to the same workqueue.
  848. */
  849. return worker->current_cwq->wq == wq;
  850. }
  851. spin_unlock_irqrestore(&gcwq->lock, flags);
  852. }
  853. return false;
  854. }
  855. static void __queue_work(unsigned int cpu, struct workqueue_struct *wq,
  856. struct work_struct *work)
  857. {
  858. struct global_cwq *gcwq;
  859. struct cpu_workqueue_struct *cwq;
  860. struct list_head *worklist;
  861. unsigned int work_flags;
  862. unsigned long flags;
  863. debug_work_activate(work);
  864. /* if dying, only works from the same workqueue are allowed */
  865. if (unlikely(wq->flags & WQ_DRAINING) &&
  866. WARN_ON_ONCE(!is_chained_work(wq)))
  867. return;
  868. /* determine gcwq to use */
  869. if (!(wq->flags & WQ_UNBOUND)) {
  870. struct global_cwq *last_gcwq;
  871. if (unlikely(cpu == WORK_CPU_UNBOUND))
  872. cpu = raw_smp_processor_id();
  873. /*
  874. * It's multi cpu. If @wq is non-reentrant and @work
  875. * was previously on a different cpu, it might still
  876. * be running there, in which case the work needs to
  877. * be queued on that cpu to guarantee non-reentrance.
  878. */
  879. gcwq = get_gcwq(cpu);
  880. if (wq->flags & WQ_NON_REENTRANT &&
  881. (last_gcwq = get_work_gcwq(work)) && last_gcwq != gcwq) {
  882. struct worker *worker;
  883. spin_lock_irqsave(&last_gcwq->lock, flags);
  884. worker = find_worker_executing_work(last_gcwq, work);
  885. if (worker && worker->current_cwq->wq == wq)
  886. gcwq = last_gcwq;
  887. else {
  888. /* meh... not running there, queue here */
  889. spin_unlock_irqrestore(&last_gcwq->lock, flags);
  890. spin_lock_irqsave(&gcwq->lock, flags);
  891. }
  892. } else
  893. spin_lock_irqsave(&gcwq->lock, flags);
  894. } else {
  895. gcwq = get_gcwq(WORK_CPU_UNBOUND);
  896. spin_lock_irqsave(&gcwq->lock, flags);
  897. }
  898. /* gcwq determined, get cwq and queue */
  899. cwq = get_cwq(gcwq->cpu, wq);
  900. trace_workqueue_queue_work(cpu, cwq, work);
  901. if (WARN_ON(!list_empty(&work->entry))) {
  902. spin_unlock_irqrestore(&gcwq->lock, flags);
  903. return;
  904. }
  905. cwq->nr_in_flight[cwq->work_color]++;
  906. work_flags = work_color_to_flags(cwq->work_color);
  907. if (likely(cwq->nr_active < cwq->max_active)) {
  908. trace_workqueue_activate_work(work);
  909. cwq->nr_active++;
  910. worklist = gcwq_determine_ins_pos(gcwq, cwq);
  911. } else {
  912. work_flags |= WORK_STRUCT_DELAYED;
  913. worklist = &cwq->delayed_works;
  914. }
  915. insert_work(cwq, work, worklist, work_flags);
  916. spin_unlock_irqrestore(&gcwq->lock, flags);
  917. }
  918. /**
  919. * queue_work - queue work on a workqueue
  920. * @wq: workqueue to use
  921. * @work: work to queue
  922. *
  923. * Returns 0 if @work was already on a queue, non-zero otherwise.
  924. *
  925. * We queue the work to the CPU on which it was submitted, but if the CPU dies
  926. * it can be processed by another CPU.
  927. */
  928. int queue_work(struct workqueue_struct *wq, struct work_struct *work)
  929. {
  930. int ret;
  931. ret = queue_work_on(get_cpu(), wq, work);
  932. put_cpu();
  933. return ret;
  934. }
  935. EXPORT_SYMBOL_GPL(queue_work);
  936. /**
  937. * queue_work_on - queue work on specific cpu
  938. * @cpu: CPU number to execute work on
  939. * @wq: workqueue to use
  940. * @work: work to queue
  941. *
  942. * Returns 0 if @work was already on a queue, non-zero otherwise.
  943. *
  944. * We queue the work to a specific CPU, the caller must ensure it
  945. * can't go away.
  946. */
  947. int
  948. queue_work_on(int cpu, struct workqueue_struct *wq, struct work_struct *work)
  949. {
  950. int ret = 0;
  951. if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
  952. __queue_work(cpu, wq, work);
  953. ret = 1;
  954. }
  955. return ret;
  956. }
  957. EXPORT_SYMBOL_GPL(queue_work_on);
  958. static void delayed_work_timer_fn(unsigned long __data)
  959. {
  960. struct delayed_work *dwork = (struct delayed_work *)__data;
  961. struct cpu_workqueue_struct *cwq = get_work_cwq(&dwork->work);
  962. __queue_work(smp_processor_id(), cwq->wq, &dwork->work);
  963. }
  964. /**
  965. * queue_delayed_work - queue work on a workqueue after delay
  966. * @wq: workqueue to use
  967. * @dwork: delayable work to queue
  968. * @delay: number of jiffies to wait before queueing
  969. *
  970. * Returns 0 if @work was already on a queue, non-zero otherwise.
  971. */
  972. int queue_delayed_work(struct workqueue_struct *wq,
  973. struct delayed_work *dwork, unsigned long delay)
  974. {
  975. if (delay == 0)
  976. return queue_work(wq, &dwork->work);
  977. return queue_delayed_work_on(-1, wq, dwork, delay);
  978. }
  979. EXPORT_SYMBOL_GPL(queue_delayed_work);
  980. /**
  981. * queue_delayed_work_on - queue work on specific CPU after delay
  982. * @cpu: CPU number to execute work on
  983. * @wq: workqueue to use
  984. * @dwork: work to queue
  985. * @delay: number of jiffies to wait before queueing
  986. *
  987. * Returns 0 if @work was already on a queue, non-zero otherwise.
  988. */
  989. int queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
  990. struct delayed_work *dwork, unsigned long delay)
  991. {
  992. int ret = 0;
  993. struct timer_list *timer = &dwork->timer;
  994. struct work_struct *work = &dwork->work;
  995. if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
  996. unsigned int lcpu;
  997. BUG_ON(timer_pending(timer));
  998. BUG_ON(!list_empty(&work->entry));
  999. timer_stats_timer_set_start_info(&dwork->timer);
  1000. /*
  1001. * This stores cwq for the moment, for the timer_fn.
  1002. * Note that the work's gcwq is preserved to allow
  1003. * reentrance detection for delayed works.
  1004. */
  1005. if (!(wq->flags & WQ_UNBOUND)) {
  1006. struct global_cwq *gcwq = get_work_gcwq(work);
  1007. if (gcwq && gcwq->cpu != WORK_CPU_UNBOUND)
  1008. lcpu = gcwq->cpu;
  1009. else
  1010. lcpu = raw_smp_processor_id();
  1011. } else
  1012. lcpu = WORK_CPU_UNBOUND;
  1013. set_work_cwq(work, get_cwq(lcpu, wq), 0);
  1014. timer->expires = jiffies + delay;
  1015. timer->data = (unsigned long)dwork;
  1016. timer->function = delayed_work_timer_fn;
  1017. if (unlikely(cpu >= 0))
  1018. add_timer_on(timer, cpu);
  1019. else
  1020. add_timer(timer);
  1021. ret = 1;
  1022. }
  1023. return ret;
  1024. }
  1025. EXPORT_SYMBOL_GPL(queue_delayed_work_on);
  1026. /**
  1027. * worker_enter_idle - enter idle state
  1028. * @worker: worker which is entering idle state
  1029. *
  1030. * @worker is entering idle state. Update stats and idle timer if
  1031. * necessary.
  1032. *
  1033. * LOCKING:
  1034. * spin_lock_irq(gcwq->lock).
  1035. */
  1036. static void worker_enter_idle(struct worker *worker)
  1037. {
  1038. struct global_cwq *gcwq = worker->gcwq;
  1039. BUG_ON(worker->flags & WORKER_IDLE);
  1040. BUG_ON(!list_empty(&worker->entry) &&
  1041. (worker->hentry.next || worker->hentry.pprev));
  1042. /* can't use worker_set_flags(), also called from start_worker() */
  1043. worker->flags |= WORKER_IDLE;
  1044. gcwq->nr_idle++;
  1045. worker->last_active = jiffies;
  1046. /* idle_list is LIFO */
  1047. list_add(&worker->entry, &gcwq->idle_list);
  1048. if (likely(!(worker->flags & WORKER_ROGUE))) {
  1049. if (too_many_workers(gcwq) && !timer_pending(&gcwq->idle_timer))
  1050. mod_timer(&gcwq->idle_timer,
  1051. jiffies + IDLE_WORKER_TIMEOUT);
  1052. } else
  1053. wake_up_all(&gcwq->trustee_wait);
  1054. /*
  1055. * Sanity check nr_running. Because trustee releases gcwq->lock
  1056. * between setting %WORKER_ROGUE and zapping nr_running, the
  1057. * warning may trigger spuriously. Check iff trustee is idle.
  1058. */
  1059. WARN_ON_ONCE(gcwq->trustee_state == TRUSTEE_DONE &&
  1060. gcwq->nr_workers == gcwq->nr_idle &&
  1061. atomic_read(get_gcwq_nr_running(gcwq->cpu)));
  1062. }
  1063. /**
  1064. * worker_leave_idle - leave idle state
  1065. * @worker: worker which is leaving idle state
  1066. *
  1067. * @worker is leaving idle state. Update stats.
  1068. *
  1069. * LOCKING:
  1070. * spin_lock_irq(gcwq->lock).
  1071. */
  1072. static void worker_leave_idle(struct worker *worker)
  1073. {
  1074. struct global_cwq *gcwq = worker->gcwq;
  1075. BUG_ON(!(worker->flags & WORKER_IDLE));
  1076. worker_clr_flags(worker, WORKER_IDLE);
  1077. gcwq->nr_idle--;
  1078. list_del_init(&worker->entry);
  1079. }
  1080. /**
  1081. * worker_maybe_bind_and_lock - bind worker to its cpu if possible and lock gcwq
  1082. * @worker: self
  1083. *
  1084. * Works which are scheduled while the cpu is online must at least be
  1085. * scheduled to a worker which is bound to the cpu so that if they are
  1086. * flushed from cpu callbacks while cpu is going down, they are
  1087. * guaranteed to execute on the cpu.
  1088. *
  1089. * This function is to be used by rogue workers and rescuers to bind
  1090. * themselves to the target cpu and may race with cpu going down or
  1091. * coming online. kthread_bind() can't be used because it may put the
  1092. * worker to already dead cpu and set_cpus_allowed_ptr() can't be used
  1093. * verbatim as it's best effort and blocking and gcwq may be
  1094. * [dis]associated in the meantime.
  1095. *
  1096. * This function tries set_cpus_allowed() and locks gcwq and verifies
  1097. * the binding against GCWQ_DISASSOCIATED which is set during
  1098. * CPU_DYING and cleared during CPU_ONLINE, so if the worker enters
  1099. * idle state or fetches works without dropping lock, it can guarantee
  1100. * the scheduling requirement described in the first paragraph.
  1101. *
  1102. * CONTEXT:
  1103. * Might sleep. Called without any lock but returns with gcwq->lock
  1104. * held.
  1105. *
  1106. * RETURNS:
  1107. * %true if the associated gcwq is online (@worker is successfully
  1108. * bound), %false if offline.
  1109. */
  1110. static bool worker_maybe_bind_and_lock(struct worker *worker)
  1111. __acquires(&gcwq->lock)
  1112. {
  1113. struct global_cwq *gcwq = worker->gcwq;
  1114. struct task_struct *task = worker->task;
  1115. while (true) {
  1116. /*
  1117. * The following call may fail, succeed or succeed
  1118. * without actually migrating the task to the cpu if
  1119. * it races with cpu hotunplug operation. Verify
  1120. * against GCWQ_DISASSOCIATED.
  1121. */
  1122. if (!(gcwq->flags & GCWQ_DISASSOCIATED))
  1123. set_cpus_allowed_ptr(task, get_cpu_mask(gcwq->cpu));
  1124. spin_lock_irq(&gcwq->lock);
  1125. if (gcwq->flags & GCWQ_DISASSOCIATED)
  1126. return false;
  1127. if (task_cpu(task) == gcwq->cpu &&
  1128. cpumask_equal(&current->cpus_allowed,
  1129. get_cpu_mask(gcwq->cpu)))
  1130. return true;
  1131. spin_unlock_irq(&gcwq->lock);
  1132. /*
  1133. * We've raced with CPU hot[un]plug. Give it a breather
  1134. * and retry migration. cond_resched() is required here;
  1135. * otherwise, we might deadlock against cpu_stop trying to
  1136. * bring down the CPU on non-preemptive kernel.
  1137. */
  1138. cpu_relax();
  1139. cond_resched();
  1140. }
  1141. }
  1142. /*
  1143. * Function for worker->rebind_work used to rebind rogue busy workers
  1144. * to the associated cpu which is coming back online. This is
  1145. * scheduled by cpu up but can race with other cpu hotplug operations
  1146. * and may be executed twice without intervening cpu down.
  1147. */
  1148. static void worker_rebind_fn(struct work_struct *work)
  1149. {
  1150. struct worker *worker = container_of(work, struct worker, rebind_work);
  1151. struct global_cwq *gcwq = worker->gcwq;
  1152. if (worker_maybe_bind_and_lock(worker))
  1153. worker_clr_flags(worker, WORKER_REBIND);
  1154. spin_unlock_irq(&gcwq->lock);
  1155. }
  1156. static struct worker *alloc_worker(void)
  1157. {
  1158. struct worker *worker;
  1159. worker = kzalloc(sizeof(*worker), GFP_KERNEL);
  1160. if (worker) {
  1161. INIT_LIST_HEAD(&worker->entry);
  1162. INIT_LIST_HEAD(&worker->scheduled);
  1163. INIT_WORK(&worker->rebind_work, worker_rebind_fn);
  1164. /* on creation a worker is in !idle && prep state */
  1165. worker->flags = WORKER_PREP;
  1166. }
  1167. return worker;
  1168. }
  1169. /**
  1170. * create_worker - create a new workqueue worker
  1171. * @gcwq: gcwq the new worker will belong to
  1172. * @bind: whether to set affinity to @cpu or not
  1173. *
  1174. * Create a new worker which is bound to @gcwq. The returned worker
  1175. * can be started by calling start_worker() or destroyed using
  1176. * destroy_worker().
  1177. *
  1178. * CONTEXT:
  1179. * Might sleep. Does GFP_KERNEL allocations.
  1180. *
  1181. * RETURNS:
  1182. * Pointer to the newly created worker.
  1183. */
  1184. static struct worker *create_worker(struct global_cwq *gcwq, bool bind)
  1185. {
  1186. bool on_unbound_cpu = gcwq->cpu == WORK_CPU_UNBOUND;
  1187. struct worker *worker = NULL;
  1188. int id = -1;
  1189. spin_lock_irq(&gcwq->lock);
  1190. while (ida_get_new(&gcwq->worker_ida, &id)) {
  1191. spin_unlock_irq(&gcwq->lock);
  1192. if (!ida_pre_get(&gcwq->worker_ida, GFP_KERNEL))
  1193. goto fail;
  1194. spin_lock_irq(&gcwq->lock);
  1195. }
  1196. spin_unlock_irq(&gcwq->lock);
  1197. worker = alloc_worker();
  1198. if (!worker)
  1199. goto fail;
  1200. worker->gcwq = gcwq;
  1201. worker->id = id;
  1202. if (!on_unbound_cpu)
  1203. worker->task = kthread_create_on_node(worker_thread,
  1204. worker,
  1205. cpu_to_node(gcwq->cpu),
  1206. "kworker/%u:%d", gcwq->cpu, id);
  1207. else
  1208. worker->task = kthread_create(worker_thread, worker,
  1209. "kworker/u:%d", id);
  1210. if (IS_ERR(worker->task))
  1211. goto fail;
  1212. /*
  1213. * A rogue worker will become a regular one if CPU comes
  1214. * online later on. Make sure every worker has
  1215. * PF_THREAD_BOUND set.
  1216. */
  1217. if (bind && !on_unbound_cpu)
  1218. kthread_bind(worker->task, gcwq->cpu);
  1219. else {
  1220. worker->task->flags |= PF_THREAD_BOUND;
  1221. if (on_unbound_cpu)
  1222. worker->flags |= WORKER_UNBOUND;
  1223. }
  1224. return worker;
  1225. fail:
  1226. if (id >= 0) {
  1227. spin_lock_irq(&gcwq->lock);
  1228. ida_remove(&gcwq->worker_ida, id);
  1229. spin_unlock_irq(&gcwq->lock);
  1230. }
  1231. kfree(worker);
  1232. return NULL;
  1233. }
  1234. /**
  1235. * start_worker - start a newly created worker
  1236. * @worker: worker to start
  1237. *
  1238. * Make the gcwq aware of @worker and start it.
  1239. *
  1240. * CONTEXT:
  1241. * spin_lock_irq(gcwq->lock).
  1242. */
  1243. static void start_worker(struct worker *worker)
  1244. {
  1245. worker->flags |= WORKER_STARTED;
  1246. worker->gcwq->nr_workers++;
  1247. worker_enter_idle(worker);
  1248. wake_up_process(worker->task);
  1249. }
  1250. /**
  1251. * destroy_worker - destroy a workqueue worker
  1252. * @worker: worker to be destroyed
  1253. *
  1254. * Destroy @worker and adjust @gcwq stats accordingly.
  1255. *
  1256. * CONTEXT:
  1257. * spin_lock_irq(gcwq->lock) which is released and regrabbed.
  1258. */
  1259. static void destroy_worker(struct worker *worker)
  1260. {
  1261. struct global_cwq *gcwq = worker->gcwq;
  1262. int id = worker->id;
  1263. /* sanity check frenzy */
  1264. BUG_ON(worker->current_work);
  1265. BUG_ON(!list_empty(&worker->scheduled));
  1266. if (worker->flags & WORKER_STARTED)
  1267. gcwq->nr_workers--;
  1268. if (worker->flags & WORKER_IDLE)
  1269. gcwq->nr_idle--;
  1270. list_del_init(&worker->entry);
  1271. worker->flags |= WORKER_DIE;
  1272. spin_unlock_irq(&gcwq->lock);
  1273. kthread_stop(worker->task);
  1274. kfree(worker);
  1275. spin_lock_irq(&gcwq->lock);
  1276. ida_remove(&gcwq->worker_ida, id);
  1277. }
  1278. static void idle_worker_timeout(unsigned long __gcwq)
  1279. {
  1280. struct global_cwq *gcwq = (void *)__gcwq;
  1281. spin_lock_irq(&gcwq->lock);
  1282. if (too_many_workers(gcwq)) {
  1283. struct worker *worker;
  1284. unsigned long expires;
  1285. /* idle_list is kept in LIFO order, check the last one */
  1286. worker = list_entry(gcwq->idle_list.prev, struct worker, entry);
  1287. expires = worker->last_active + IDLE_WORKER_TIMEOUT;
  1288. if (time_before(jiffies, expires))
  1289. mod_timer(&gcwq->idle_timer, expires);
  1290. else {
  1291. /* it's been idle for too long, wake up manager */
  1292. gcwq->flags |= GCWQ_MANAGE_WORKERS;
  1293. wake_up_worker(gcwq);
  1294. }
  1295. }
  1296. spin_unlock_irq(&gcwq->lock);
  1297. }
  1298. static bool send_mayday(struct work_struct *work)
  1299. {
  1300. struct cpu_workqueue_struct *cwq = get_work_cwq(work);
  1301. struct workqueue_struct *wq = cwq->wq;
  1302. unsigned int cpu;
  1303. if (!(wq->flags & WQ_RESCUER))
  1304. return false;
  1305. /* mayday mayday mayday */
  1306. cpu = cwq->gcwq->cpu;
  1307. /* WORK_CPU_UNBOUND can't be set in cpumask, use cpu 0 instead */
  1308. if (cpu == WORK_CPU_UNBOUND)
  1309. cpu = 0;
  1310. if (!mayday_test_and_set_cpu(cpu, wq->mayday_mask))
  1311. wake_up_process(wq->rescuer->task);
  1312. return true;
  1313. }
  1314. static void gcwq_mayday_timeout(unsigned long __gcwq)
  1315. {
  1316. struct global_cwq *gcwq = (void *)__gcwq;
  1317. struct work_struct *work;
  1318. spin_lock_irq(&gcwq->lock);
  1319. if (need_to_create_worker(gcwq)) {
  1320. /*
  1321. * We've been trying to create a new worker but
  1322. * haven't been successful. We might be hitting an
  1323. * allocation deadlock. Send distress signals to
  1324. * rescuers.
  1325. */
  1326. list_for_each_entry(work, &gcwq->worklist, entry)
  1327. send_mayday(work);
  1328. }
  1329. spin_unlock_irq(&gcwq->lock);
  1330. mod_timer(&gcwq->mayday_timer, jiffies + MAYDAY_INTERVAL);
  1331. }
  1332. /**
  1333. * maybe_create_worker - create a new worker if necessary
  1334. * @gcwq: gcwq to create a new worker for
  1335. *
  1336. * Create a new worker for @gcwq if necessary. @gcwq is guaranteed to
  1337. * have at least one idle worker on return from this function. If
  1338. * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
  1339. * sent to all rescuers with works scheduled on @gcwq to resolve
  1340. * possible allocation deadlock.
  1341. *
  1342. * On return, need_to_create_worker() is guaranteed to be false and
  1343. * may_start_working() true.
  1344. *
  1345. * LOCKING:
  1346. * spin_lock_irq(gcwq->lock) which may be released and regrabbed
  1347. * multiple times. Does GFP_KERNEL allocations. Called only from
  1348. * manager.
  1349. *
  1350. * RETURNS:
  1351. * false if no action was taken and gcwq->lock stayed locked, true
  1352. * otherwise.
  1353. */
  1354. static bool maybe_create_worker(struct global_cwq *gcwq)
  1355. __releases(&gcwq->lock)
  1356. __acquires(&gcwq->lock)
  1357. {
  1358. if (!need_to_create_worker(gcwq))
  1359. return false;
  1360. restart:
  1361. spin_unlock_irq(&gcwq->lock);
  1362. /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
  1363. mod_timer(&gcwq->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
  1364. while (true) {
  1365. struct worker *worker;
  1366. worker = create_worker(gcwq, true);
  1367. if (worker) {
  1368. del_timer_sync(&gcwq->mayday_timer);
  1369. spin_lock_irq(&gcwq->lock);
  1370. start_worker(worker);
  1371. BUG_ON(need_to_create_worker(gcwq));
  1372. return true;
  1373. }
  1374. if (!need_to_create_worker(gcwq))
  1375. break;
  1376. __set_current_state(TASK_INTERRUPTIBLE);
  1377. schedule_timeout(CREATE_COOLDOWN);
  1378. if (!need_to_create_worker(gcwq))
  1379. break;
  1380. }
  1381. del_timer_sync(&gcwq->mayday_timer);
  1382. spin_lock_irq(&gcwq->lock);
  1383. if (need_to_create_worker(gcwq))
  1384. goto restart;
  1385. return true;
  1386. }
  1387. /**
  1388. * maybe_destroy_worker - destroy workers which have been idle for a while
  1389. * @gcwq: gcwq to destroy workers for
  1390. *
  1391. * Destroy @gcwq workers which have been idle for longer than
  1392. * IDLE_WORKER_TIMEOUT.
  1393. *
  1394. * LOCKING:
  1395. * spin_lock_irq(gcwq->lock) which may be released and regrabbed
  1396. * multiple times. Called only from manager.
  1397. *
  1398. * RETURNS:
  1399. * false if no action was taken and gcwq->lock stayed locked, true
  1400. * otherwise.
  1401. */
  1402. static bool maybe_destroy_workers(struct global_cwq *gcwq)
  1403. {
  1404. bool ret = false;
  1405. while (too_many_workers(gcwq)) {
  1406. struct worker *worker;
  1407. unsigned long expires;
  1408. worker = list_entry(gcwq->idle_list.prev, struct worker, entry);
  1409. expires = worker->last_active + IDLE_WORKER_TIMEOUT;
  1410. if (time_before(jiffies, expires)) {
  1411. mod_timer(&gcwq->idle_timer, expires);
  1412. break;
  1413. }
  1414. destroy_worker(worker);
  1415. ret = true;
  1416. }
  1417. return ret;
  1418. }
  1419. /**
  1420. * manage_workers - manage worker pool
  1421. * @worker: self
  1422. *
  1423. * Assume the manager role and manage gcwq worker pool @worker belongs
  1424. * to. At any given time, there can be only zero or one manager per
  1425. * gcwq. The exclusion is handled automatically by this function.
  1426. *
  1427. * The caller can safely start processing works on false return. On
  1428. * true return, it's guaranteed that need_to_create_worker() is false
  1429. * and may_start_working() is true.
  1430. *
  1431. * CONTEXT:
  1432. * spin_lock_irq(gcwq->lock) which may be released and regrabbed
  1433. * multiple times. Does GFP_KERNEL allocations.
  1434. *
  1435. * RETURNS:
  1436. * false if no action was taken and gcwq->lock stayed locked, true if
  1437. * some action was taken.
  1438. */
  1439. static bool manage_workers(struct worker *worker)
  1440. {
  1441. struct global_cwq *gcwq = worker->gcwq;
  1442. bool ret = false;
  1443. if (gcwq->flags & GCWQ_MANAGING_WORKERS)
  1444. return ret;
  1445. gcwq->flags &= ~GCWQ_MANAGE_WORKERS;
  1446. gcwq->flags |= GCWQ_MANAGING_WORKERS;
  1447. /*
  1448. * Destroy and then create so that may_start_working() is true
  1449. * on return.
  1450. */
  1451. ret |= maybe_destroy_workers(gcwq);
  1452. ret |= maybe_create_worker(gcwq);
  1453. gcwq->flags &= ~GCWQ_MANAGING_WORKERS;
  1454. /*
  1455. * The trustee might be waiting to take over the manager
  1456. * position, tell it we're done.
  1457. */
  1458. if (unlikely(gcwq->trustee))
  1459. wake_up_all(&gcwq->trustee_wait);
  1460. return ret;
  1461. }
  1462. /**
  1463. * move_linked_works - move linked works to a list
  1464. * @work: start of series of works to be scheduled
  1465. * @head: target list to append @work to
  1466. * @nextp: out paramter for nested worklist walking
  1467. *
  1468. * Schedule linked works starting from @work to @head. Work series to
  1469. * be scheduled starts at @work and includes any consecutive work with
  1470. * WORK_STRUCT_LINKED set in its predecessor.
  1471. *
  1472. * If @nextp is not NULL, it's updated to point to the next work of
  1473. * the last scheduled work. This allows move_linked_works() to be
  1474. * nested inside outer list_for_each_entry_safe().
  1475. *
  1476. * CONTEXT:
  1477. * spin_lock_irq(gcwq->lock).
  1478. */
  1479. static void move_linked_works(struct work_struct *work, struct list_head *head,
  1480. struct work_struct **nextp)
  1481. {
  1482. struct work_struct *n;
  1483. /*
  1484. * Linked worklist will always end before the end of the list,
  1485. * use NULL for list head.
  1486. */
  1487. list_for_each_entry_safe_from(work, n, NULL, entry) {
  1488. list_move_tail(&work->entry, head);
  1489. if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
  1490. break;
  1491. }
  1492. /*
  1493. * If we're already inside safe list traversal and have moved
  1494. * multiple works to the scheduled queue, the next position
  1495. * needs to be updated.
  1496. */
  1497. if (nextp)
  1498. *nextp = n;
  1499. }
  1500. static void cwq_activate_first_delayed(struct cpu_workqueue_struct *cwq)
  1501. {
  1502. struct work_struct *work = list_first_entry(&cwq->delayed_works,
  1503. struct work_struct, entry);
  1504. struct list_head *pos = gcwq_determine_ins_pos(cwq->gcwq, cwq);
  1505. trace_workqueue_activate_work(work);
  1506. move_linked_works(work, pos, NULL);
  1507. __clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
  1508. cwq->nr_active++;
  1509. }
  1510. /**
  1511. * cwq_dec_nr_in_flight - decrement cwq's nr_in_flight
  1512. * @cwq: cwq of interest
  1513. * @color: color of work which left the queue
  1514. * @delayed: for a delayed work
  1515. *
  1516. * A work either has completed or is removed from pending queue,
  1517. * decrement nr_in_flight of its cwq and handle workqueue flushing.
  1518. *
  1519. * CONTEXT:
  1520. * spin_lock_irq(gcwq->lock).
  1521. */
  1522. static void cwq_dec_nr_in_flight(struct cpu_workqueue_struct *cwq, int color,
  1523. bool delayed)
  1524. {
  1525. /* ignore uncolored works */
  1526. if (color == WORK_NO_COLOR)
  1527. return;
  1528. cwq->nr_in_flight[color]--;
  1529. if (!delayed) {
  1530. cwq->nr_active--;
  1531. if (!list_empty(&cwq->delayed_works)) {
  1532. /* one down, submit a delayed one */
  1533. if (cwq->nr_active < cwq->max_active)
  1534. cwq_activate_first_delayed(cwq);
  1535. }
  1536. }
  1537. /* is flush in progress and are we at the flushing tip? */
  1538. if (likely(cwq->flush_color != color))
  1539. return;
  1540. /* are there still in-flight works? */
  1541. if (cwq->nr_in_flight[color])
  1542. return;
  1543. /* this cwq is done, clear flush_color */
  1544. cwq->flush_color = -1;
  1545. /*
  1546. * If this was the last cwq, wake up the first flusher. It
  1547. * will handle the rest.
  1548. */
  1549. if (atomic_dec_and_test(&cwq->wq->nr_cwqs_to_flush))
  1550. complete(&cwq->wq->first_flusher->done);
  1551. }
  1552. /**
  1553. * process_one_work - process single work
  1554. * @worker: self
  1555. * @work: work to process
  1556. *
  1557. * Process @work. This function contains all the logics necessary to
  1558. * process a single work including synchronization against and
  1559. * interaction with other workers on the same cpu, queueing and
  1560. * flushing. As long as context requirement is met, any worker can
  1561. * call this function to process a work.
  1562. *
  1563. * CONTEXT:
  1564. * spin_lock_irq(gcwq->lock) which is released and regrabbed.
  1565. */
  1566. static void process_one_work(struct worker *worker, struct work_struct *work)
  1567. __releases(&gcwq->lock)
  1568. __acquires(&gcwq->lock)
  1569. {
  1570. struct cpu_workqueue_struct *cwq = get_work_cwq(work);
  1571. struct global_cwq *gcwq = cwq->gcwq;
  1572. struct hlist_head *bwh = busy_worker_head(gcwq, work);
  1573. bool cpu_intensive = cwq->wq->flags & WQ_CPU_INTENSIVE;
  1574. work_func_t f = work->func;
  1575. int work_color;
  1576. struct worker *collision;
  1577. #ifdef CONFIG_LOCKDEP
  1578. /*
  1579. * It is permissible to free the struct work_struct from
  1580. * inside the function that is called from it, this we need to
  1581. * take into account for lockdep too. To avoid bogus "held
  1582. * lock freed" warnings as well as problems when looking into
  1583. * work->lockdep_map, make a copy and use that here.
  1584. */
  1585. struct lockdep_map lockdep_map;
  1586. lockdep_copy_map(&lockdep_map, &work->lockdep_map);
  1587. #endif
  1588. /*
  1589. * A single work shouldn't be executed concurrently by
  1590. * multiple workers on a single cpu. Check whether anyone is
  1591. * already processing the work. If so, defer the work to the
  1592. * currently executing one.
  1593. */
  1594. collision = __find_worker_executing_work(gcwq, bwh, work);
  1595. if (unlikely(collision)) {
  1596. move_linked_works(work, &collision->scheduled, NULL);
  1597. return;
  1598. }
  1599. /* claim and process */
  1600. debug_work_deactivate(work);
  1601. hlist_add_head(&worker->hentry, bwh);
  1602. worker->current_work = work;
  1603. worker->current_cwq = cwq;
  1604. work_color = get_work_color(work);
  1605. /* record the current cpu number in the work data and dequeue */
  1606. set_work_cpu(work, gcwq->cpu);
  1607. list_del_init(&work->entry);
  1608. /*
  1609. * If HIGHPRI_PENDING, check the next work, and, if HIGHPRI,
  1610. * wake up another worker; otherwise, clear HIGHPRI_PENDING.
  1611. */
  1612. if (unlikely(gcwq->flags & GCWQ_HIGHPRI_PENDING)) {
  1613. struct work_struct *nwork = list_first_entry(&gcwq->worklist,
  1614. struct work_struct, entry);
  1615. if (!list_empty(&gcwq->worklist) &&
  1616. get_work_cwq(nwork)->wq->flags & WQ_HIGHPRI)
  1617. wake_up_worker(gcwq);
  1618. else
  1619. gcwq->flags &= ~GCWQ_HIGHPRI_PENDING;
  1620. }
  1621. /*
  1622. * CPU intensive works don't participate in concurrency
  1623. * management. They're the scheduler's responsibility.
  1624. */
  1625. if (unlikely(cpu_intensive))
  1626. worker_set_flags(worker, WORKER_CPU_INTENSIVE, true);
  1627. spin_unlock_irq(&gcwq->lock);
  1628. work_clear_pending(work);
  1629. lock_map_acquire_read(&cwq->wq->lockdep_map);
  1630. lock_map_acquire(&lockdep_map);
  1631. trace_workqueue_execute_start(work);
  1632. f(work);
  1633. /*
  1634. * While we must be careful to not use "work" after this, the trace
  1635. * point will only record its address.
  1636. */
  1637. trace_workqueue_execute_end(work);
  1638. lock_map_release(&lockdep_map);
  1639. lock_map_release(&cwq->wq->lockdep_map);
  1640. if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
  1641. printk(KERN_ERR "BUG: workqueue leaked lock or atomic: "
  1642. "%s/0x%08x/%d\n",
  1643. current->comm, preempt_count(), task_pid_nr(current));
  1644. printk(KERN_ERR " last function: ");
  1645. print_symbol("%s\n", (unsigned long)f);
  1646. debug_show_held_locks(current);
  1647. dump_stack();
  1648. }
  1649. spin_lock_irq(&gcwq->lock);
  1650. /* clear cpu intensive status */
  1651. if (unlikely(cpu_intensive))
  1652. worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
  1653. /* we're done with it, release */
  1654. hlist_del_init(&worker->hentry);
  1655. worker->current_work = NULL;
  1656. worker->current_cwq = NULL;
  1657. cwq_dec_nr_in_flight(cwq, work_color, false);
  1658. }
  1659. /**
  1660. * process_scheduled_works - process scheduled works
  1661. * @worker: self
  1662. *
  1663. * Process all scheduled works. Please note that the scheduled list
  1664. * may change while processing a work, so this function repeatedly
  1665. * fetches a work from the top and executes it.
  1666. *
  1667. * CONTEXT:
  1668. * spin_lock_irq(gcwq->lock) which may be released and regrabbed
  1669. * multiple times.
  1670. */
  1671. static void process_scheduled_works(struct worker *worker)
  1672. {
  1673. while (!list_empty(&worker->scheduled)) {
  1674. struct work_struct *work = list_first_entry(&worker->scheduled,
  1675. struct work_struct, entry);
  1676. process_one_work(worker, work);
  1677. }
  1678. }
  1679. /**
  1680. * worker_thread - the worker thread function
  1681. * @__worker: self
  1682. *
  1683. * The gcwq worker thread function. There's a single dynamic pool of
  1684. * these per each cpu. These workers process all works regardless of
  1685. * their specific target workqueue. The only exception is works which
  1686. * belong to workqueues with a rescuer which will be explained in
  1687. * rescuer_thread().
  1688. */
  1689. static int worker_thread(void *__worker)
  1690. {
  1691. struct worker *worker = __worker;
  1692. struct global_cwq *gcwq = worker->gcwq;
  1693. /* tell the scheduler that this is a workqueue worker */
  1694. worker->task->flags |= PF_WQ_WORKER;
  1695. woke_up:
  1696. spin_lock_irq(&gcwq->lock);
  1697. /* DIE can be set only while we're idle, checking here is enough */
  1698. if (worker->flags & WORKER_DIE) {
  1699. spin_unlock_irq(&gcwq->lock);
  1700. worker->task->flags &= ~PF_WQ_WORKER;
  1701. return 0;
  1702. }
  1703. worker_leave_idle(worker);
  1704. recheck:
  1705. /* no more worker necessary? */
  1706. if (!need_more_worker(gcwq))
  1707. goto sleep;
  1708. /* do we need to manage? */
  1709. if (unlikely(!may_start_working(gcwq)) && manage_workers(worker))
  1710. goto recheck;
  1711. /*
  1712. * ->scheduled list can only be filled while a worker is
  1713. * preparing to process a work or actually processing it.
  1714. * Make sure nobody diddled with it while I was sleeping.
  1715. */
  1716. BUG_ON(!list_empty(&worker->scheduled));
  1717. /*
  1718. * When control reaches this point, we're guaranteed to have
  1719. * at least one idle worker or that someone else has already
  1720. * assumed the manager role.
  1721. */
  1722. worker_clr_flags(worker, WORKER_PREP);
  1723. do {
  1724. struct work_struct *work =
  1725. list_first_entry(&gcwq->worklist,
  1726. struct work_struct, entry);
  1727. if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
  1728. /* optimization path, not strictly necessary */
  1729. process_one_work(worker, work);
  1730. if (unlikely(!list_empty(&worker->scheduled)))
  1731. process_scheduled_works(worker);
  1732. } else {
  1733. move_linked_works(work, &worker->scheduled, NULL);
  1734. process_scheduled_works(worker);
  1735. }
  1736. } while (keep_working(gcwq));
  1737. worker_set_flags(worker, WORKER_PREP, false);
  1738. sleep:
  1739. if (unlikely(need_to_manage_workers(gcwq)) && manage_workers(worker))
  1740. goto recheck;
  1741. /*
  1742. * gcwq->lock is held and there's no work to process and no
  1743. * need to manage, sleep. Workers are woken up only while
  1744. * holding gcwq->lock or from local cpu, so setting the
  1745. * current state before releasing gcwq->lock is enough to
  1746. * prevent losing any event.
  1747. */
  1748. worker_enter_idle(worker);
  1749. __set_current_state(TASK_INTERRUPTIBLE);
  1750. spin_unlock_irq(&gcwq->lock);
  1751. schedule();
  1752. goto woke_up;
  1753. }
  1754. /**
  1755. * rescuer_thread - the rescuer thread function
  1756. * @__wq: the associated workqueue
  1757. *
  1758. * Workqueue rescuer thread function. There's one rescuer for each
  1759. * workqueue which has WQ_RESCUER set.
  1760. *
  1761. * Regular work processing on a gcwq may block trying to create a new
  1762. * worker which uses GFP_KERNEL allocation which has slight chance of
  1763. * developing into deadlock if some works currently on the same queue
  1764. * need to be processed to satisfy the GFP_KERNEL allocation. This is
  1765. * the problem rescuer solves.
  1766. *
  1767. * When such condition is possible, the gcwq summons rescuers of all
  1768. * workqueues which have works queued on the gcwq and let them process
  1769. * those works so that forward progress can be guaranteed.
  1770. *
  1771. * This should happen rarely.
  1772. */
  1773. static int rescuer_thread(void *__wq)
  1774. {
  1775. struct workqueue_struct *wq = __wq;
  1776. struct worker *rescuer = wq->rescuer;
  1777. struct list_head *scheduled = &rescuer->scheduled;
  1778. bool is_unbound = wq->flags & WQ_UNBOUND;
  1779. unsigned int cpu;
  1780. set_user_nice(current, RESCUER_NICE_LEVEL);
  1781. repeat:
  1782. set_current_state(TASK_INTERRUPTIBLE);
  1783. if (kthread_should_stop())
  1784. return 0;
  1785. /*
  1786. * See whether any cpu is asking for help. Unbounded
  1787. * workqueues use cpu 0 in mayday_mask for CPU_UNBOUND.
  1788. */
  1789. for_each_mayday_cpu(cpu, wq->mayday_mask) {
  1790. unsigned int tcpu = is_unbound ? WORK_CPU_UNBOUND : cpu;
  1791. struct cpu_workqueue_struct *cwq = get_cwq(tcpu, wq);
  1792. struct global_cwq *gcwq = cwq->gcwq;
  1793. struct work_struct *work, *n;
  1794. __set_current_state(TASK_RUNNING);
  1795. mayday_clear_cpu(cpu, wq->mayday_mask);
  1796. /* migrate to the target cpu if possible */
  1797. rescuer->gcwq = gcwq;
  1798. worker_maybe_bind_and_lock(rescuer);
  1799. /*
  1800. * Slurp in all works issued via this workqueue and
  1801. * process'em.
  1802. */
  1803. BUG_ON(!list_empty(&rescuer->scheduled));
  1804. list_for_each_entry_safe(work, n, &gcwq->worklist, entry)
  1805. if (get_work_cwq(work) == cwq)
  1806. move_linked_works(work, scheduled, &n);
  1807. process_scheduled_works(rescuer);
  1808. /*
  1809. * Leave this gcwq. If keep_working() is %true, notify a
  1810. * regular worker; otherwise, we end up with 0 concurrency
  1811. * and stalling the execution.
  1812. */
  1813. if (keep_working(gcwq))
  1814. wake_up_worker(gcwq);
  1815. spin_unlock_irq(&gcwq->lock);
  1816. }
  1817. schedule();
  1818. goto repeat;
  1819. }
  1820. struct wq_barrier {
  1821. struct work_struct work;
  1822. struct completion done;
  1823. };
  1824. static void wq_barrier_func(struct work_struct *work)
  1825. {
  1826. struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
  1827. complete(&barr->done);
  1828. }
  1829. /**
  1830. * insert_wq_barrier - insert a barrier work
  1831. * @cwq: cwq to insert barrier into
  1832. * @barr: wq_barrier to insert
  1833. * @target: target work to attach @barr to
  1834. * @worker: worker currently executing @target, NULL if @target is not executing
  1835. *
  1836. * @barr is linked to @target such that @barr is completed only after
  1837. * @target finishes execution. Please note that the ordering
  1838. * guarantee is observed only with respect to @target and on the local
  1839. * cpu.
  1840. *
  1841. * Currently, a queued barrier can't be canceled. This is because
  1842. * try_to_grab_pending() can't determine whether the work to be
  1843. * grabbed is at the head of the queue and thus can't clear LINKED
  1844. * flag of the previous work while there must be a valid next work
  1845. * after a work with LINKED flag set.
  1846. *
  1847. * Note that when @worker is non-NULL, @target may be modified
  1848. * underneath us, so we can't reliably determine cwq from @target.
  1849. *
  1850. * CONTEXT:
  1851. * spin_lock_irq(gcwq->lock).
  1852. */
  1853. static void insert_wq_barrier(struct cpu_workqueue_struct *cwq,
  1854. struct wq_barrier *barr,
  1855. struct work_struct *target, struct worker *worker)
  1856. {
  1857. struct list_head *head;
  1858. unsigned int linked = 0;
  1859. /*
  1860. * debugobject calls are safe here even with gcwq->lock locked
  1861. * as we know for sure that this will not trigger any of the
  1862. * checks and call back into the fixup functions where we
  1863. * might deadlock.
  1864. */
  1865. INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
  1866. __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
  1867. init_completion(&barr->done);
  1868. /*
  1869. * If @target is currently being executed, schedule the
  1870. * barrier to the worker; otherwise, put it after @target.
  1871. */
  1872. if (worker)
  1873. head = worker->scheduled.next;
  1874. else {
  1875. unsigned long *bits = work_data_bits(target);
  1876. head = target->entry.next;
  1877. /* there can already be other linked works, inherit and set */
  1878. linked = *bits & WORK_STRUCT_LINKED;
  1879. __set_bit(WORK_STRUCT_LINKED_BIT, bits);
  1880. }
  1881. debug_work_activate(&barr->work);
  1882. insert_work(cwq, &barr->work, head,
  1883. work_color_to_flags(WORK_NO_COLOR) | linked);
  1884. }
  1885. /**
  1886. * flush_workqueue_prep_cwqs - prepare cwqs for workqueue flushing
  1887. * @wq: workqueue being flushed
  1888. * @flush_color: new flush color, < 0 for no-op
  1889. * @work_color: new work color, < 0 for no-op
  1890. *
  1891. * Prepare cwqs for workqueue flushing.
  1892. *
  1893. * If @flush_color is non-negative, flush_color on all cwqs should be
  1894. * -1. If no cwq has in-flight commands at the specified color, all
  1895. * cwq->flush_color's stay at -1 and %false is returned. If any cwq
  1896. * has in flight commands, its cwq->flush_color is set to
  1897. * @flush_color, @wq->nr_cwqs_to_flush is updated accordingly, cwq
  1898. * wakeup logic is armed and %true is returned.
  1899. *
  1900. * The caller should have initialized @wq->first_flusher prior to
  1901. * calling this function with non-negative @flush_color. If
  1902. * @flush_color is negative, no flush color update is done and %false
  1903. * is returned.
  1904. *
  1905. * If @work_color is non-negative, all cwqs should have the same
  1906. * work_color which is previous to @work_color and all will be
  1907. * advanced to @work_color.
  1908. *
  1909. * CONTEXT:
  1910. * mutex_lock(wq->flush_mutex).
  1911. *
  1912. * RETURNS:
  1913. * %true if @flush_color >= 0 and there's something to flush. %false
  1914. * otherwise.
  1915. */
  1916. static bool flush_workqueue_prep_cwqs(struct workqueue_struct *wq,
  1917. int flush_color, int work_color)
  1918. {
  1919. bool wait = false;
  1920. unsigned int cpu;
  1921. if (flush_color >= 0) {
  1922. BUG_ON(atomic_read(&wq->nr_cwqs_to_flush));
  1923. atomic_set(&wq->nr_cwqs_to_flush, 1);
  1924. }
  1925. for_each_cwq_cpu(cpu, wq) {
  1926. struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
  1927. struct global_cwq *gcwq = cwq->gcwq;
  1928. spin_lock_irq(&gcwq->lock);
  1929. if (flush_color >= 0) {
  1930. BUG_ON(cwq->flush_color != -1);
  1931. if (cwq->nr_in_flight[flush_color]) {
  1932. cwq->flush_color = flush_color;
  1933. atomic_inc(&wq->nr_cwqs_to_flush);
  1934. wait = true;
  1935. }
  1936. }
  1937. if (work_color >= 0) {
  1938. BUG_ON(work_color != work_next_color(cwq->work_color));
  1939. cwq->work_color = work_color;
  1940. }
  1941. spin_unlock_irq(&gcwq->lock);
  1942. }
  1943. if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_cwqs_to_flush))
  1944. complete(&wq->first_flusher->done);
  1945. return wait;
  1946. }
  1947. /**
  1948. * flush_workqueue - ensure that any scheduled work has run to completion.
  1949. * @wq: workqueue to flush
  1950. *
  1951. * Forces execution of the workqueue and blocks until its completion.
  1952. * This is typically used in driver shutdown handlers.
  1953. *
  1954. * We sleep until all works which were queued on entry have been handled,
  1955. * but we are not livelocked by new incoming ones.
  1956. */
  1957. void flush_workqueue(struct workqueue_struct *wq)
  1958. {
  1959. struct wq_flusher this_flusher = {
  1960. .list = LIST_HEAD_INIT(this_flusher.list),
  1961. .flush_color = -1,
  1962. .done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
  1963. };
  1964. int next_color;
  1965. lock_map_acquire(&wq->lockdep_map);
  1966. lock_map_release(&wq->lockdep_map);
  1967. mutex_lock(&wq->flush_mutex);
  1968. /*
  1969. * Start-to-wait phase
  1970. */
  1971. next_color = work_next_color(wq->work_color);
  1972. if (next_color != wq->flush_color) {
  1973. /*
  1974. * Color space is not full. The current work_color
  1975. * becomes our flush_color and work_color is advanced
  1976. * by one.
  1977. */
  1978. BUG_ON(!list_empty(&wq->flusher_overflow));
  1979. this_flusher.flush_color = wq->work_color;
  1980. wq->work_color = next_color;
  1981. if (!wq->first_flusher) {
  1982. /* no flush in progress, become the first flusher */
  1983. BUG_ON(wq->flush_color != this_flusher.flush_color);
  1984. wq->first_flusher = &this_flusher;
  1985. if (!flush_workqueue_prep_cwqs(wq, wq->flush_color,
  1986. wq->work_color)) {
  1987. /* nothing to flush, done */
  1988. wq->flush_color = next_color;
  1989. wq->first_flusher = NULL;
  1990. goto out_unlock;
  1991. }
  1992. } else {
  1993. /* wait in queue */
  1994. BUG_ON(wq->flush_color == this_flusher.flush_color);
  1995. list_add_tail(&this_flusher.list, &wq->flusher_queue);
  1996. flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
  1997. }
  1998. } else {
  1999. /*
  2000. * Oops, color space is full, wait on overflow queue.
  2001. * The next flush completion will assign us
  2002. * flush_color and transfer to flusher_queue.
  2003. */
  2004. list_add_tail(&this_flusher.list, &wq->flusher_overflow);
  2005. }
  2006. mutex_unlock(&wq->flush_mutex);
  2007. wait_for_completion(&this_flusher.done);
  2008. /*
  2009. * Wake-up-and-cascade phase
  2010. *
  2011. * First flushers are responsible for cascading flushes and
  2012. * handling overflow. Non-first flushers can simply return.
  2013. */
  2014. if (wq->first_flusher != &this_flusher)
  2015. return;
  2016. mutex_lock(&wq->flush_mutex);
  2017. /* we might have raced, check again with mutex held */
  2018. if (wq->first_flusher != &this_flusher)
  2019. goto out_unlock;
  2020. wq->first_flusher = NULL;
  2021. BUG_ON(!list_empty(&this_flusher.list));
  2022. BUG_ON(wq->flush_color != this_flusher.flush_color);
  2023. while (true) {
  2024. struct wq_flusher *next, *tmp;
  2025. /* complete all the flushers sharing the current flush color */
  2026. list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
  2027. if (next->flush_color != wq->flush_color)
  2028. break;
  2029. list_del_init(&next->list);
  2030. complete(&next->done);
  2031. }
  2032. BUG_ON(!list_empty(&wq->flusher_overflow) &&
  2033. wq->flush_color != work_next_color(wq->work_color));
  2034. /* this flush_color is finished, advance by one */
  2035. wq->flush_color = work_next_color(wq->flush_color);
  2036. /* one color has been freed, handle overflow queue */
  2037. if (!list_empty(&wq->flusher_overflow)) {
  2038. /*
  2039. * Assign the same color to all overflowed
  2040. * flushers, advance work_color and append to
  2041. * flusher_queue. This is the start-to-wait
  2042. * phase for these overflowed flushers.
  2043. */
  2044. list_for_each_entry(tmp, &wq->flusher_overflow, list)
  2045. tmp->flush_color = wq->work_color;
  2046. wq->work_color = work_next_color(wq->work_color);
  2047. list_splice_tail_init(&wq->flusher_overflow,
  2048. &wq->flusher_queue);
  2049. flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
  2050. }
  2051. if (list_empty(&wq->flusher_queue)) {
  2052. BUG_ON(wq->flush_color != wq->work_color);
  2053. break;
  2054. }
  2055. /*
  2056. * Need to flush more colors. Make the next flusher
  2057. * the new first flusher and arm cwqs.
  2058. */
  2059. BUG_ON(wq->flush_color == wq->work_color);
  2060. BUG_ON(wq->flush_color != next->flush_color);
  2061. list_del_init(&next->list);
  2062. wq->first_flusher = next;
  2063. if (flush_workqueue_prep_cwqs(wq, wq->flush_color, -1))
  2064. break;
  2065. /*
  2066. * Meh... this color is already done, clear first
  2067. * flusher and repeat cascading.
  2068. */
  2069. wq->first_flusher = NULL;
  2070. }
  2071. out_unlock:
  2072. mutex_unlock(&wq->flush_mutex);
  2073. }
  2074. EXPORT_SYMBOL_GPL(flush_workqueue);
  2075. /**
  2076. * drain_workqueue - drain a workqueue
  2077. * @wq: workqueue to drain
  2078. *
  2079. * Wait until the workqueue becomes empty. While draining is in progress,
  2080. * only chain queueing is allowed. IOW, only currently pending or running
  2081. * work items on @wq can queue further work items on it. @wq is flushed
  2082. * repeatedly until it becomes empty. The number of flushing is detemined
  2083. * by the depth of chaining and should be relatively short. Whine if it
  2084. * takes too long.
  2085. */
  2086. void drain_workqueue(struct workqueue_struct *wq)
  2087. {
  2088. unsigned int flush_cnt = 0;
  2089. unsigned int cpu;
  2090. /*
  2091. * __queue_work() needs to test whether there are drainers, is much
  2092. * hotter than drain_workqueue() and already looks at @wq->flags.
  2093. * Use WQ_DRAINING so that queue doesn't have to check nr_drainers.
  2094. */
  2095. spin_lock(&workqueue_lock);
  2096. if (!wq->nr_drainers++)
  2097. wq->flags |= WQ_DRAINING;
  2098. spin_unlock(&workqueue_lock);
  2099. reflush:
  2100. flush_workqueue(wq);
  2101. for_each_cwq_cpu(cpu, wq) {
  2102. struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
  2103. bool drained;
  2104. spin_lock_irq(&cwq->gcwq->lock);
  2105. drained = !cwq->nr_active && list_empty(&cwq->delayed_works);
  2106. spin_unlock_irq(&cwq->gcwq->lock);
  2107. if (drained)
  2108. continue;
  2109. if (++flush_cnt == 10 ||
  2110. (flush_cnt % 100 == 0 && flush_cnt <= 1000))
  2111. pr_warning("workqueue %s: flush on destruction isn't complete after %u tries\n",
  2112. wq->name, flush_cnt);
  2113. goto reflush;
  2114. }
  2115. spin_lock(&workqueue_lock);
  2116. if (!--wq->nr_drainers)
  2117. wq->flags &= ~WQ_DRAINING;
  2118. spin_unlock(&workqueue_lock);
  2119. }
  2120. EXPORT_SYMBOL_GPL(drain_workqueue);
  2121. static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr,
  2122. bool wait_executing)
  2123. {
  2124. struct worker *worker = NULL;
  2125. struct global_cwq *gcwq;
  2126. struct cpu_workqueue_struct *cwq;
  2127. might_sleep();
  2128. gcwq = get_work_gcwq(work);
  2129. if (!gcwq)
  2130. return false;
  2131. spin_lock_irq(&gcwq->lock);
  2132. if (!list_empty(&work->entry)) {
  2133. /*
  2134. * See the comment near try_to_grab_pending()->smp_rmb().
  2135. * If it was re-queued to a different gcwq under us, we
  2136. * are not going to wait.
  2137. */
  2138. smp_rmb();
  2139. cwq = get_work_cwq(work);
  2140. if (unlikely(!cwq || gcwq != cwq->gcwq))
  2141. goto already_gone;
  2142. } else if (wait_executing) {
  2143. worker = find_worker_executing_work(gcwq, work);
  2144. if (!worker)
  2145. goto already_gone;
  2146. cwq = worker->current_cwq;
  2147. } else
  2148. goto already_gone;
  2149. insert_wq_barrier(cwq, barr, work, worker);
  2150. spin_unlock_irq(&gcwq->lock);
  2151. /*
  2152. * If @max_active is 1 or rescuer is in use, flushing another work
  2153. * item on the same workqueue may lead to deadlock. Make sure the
  2154. * flusher is not running on the same workqueue by verifying write
  2155. * access.
  2156. */
  2157. if (cwq->wq->saved_max_active == 1 || cwq->wq->flags & WQ_RESCUER)
  2158. lock_map_acquire(&cwq->wq->lockdep_map);
  2159. else
  2160. lock_map_acquire_read(&cwq->wq->lockdep_map);
  2161. lock_map_release(&cwq->wq->lockdep_map);
  2162. return true;
  2163. already_gone:
  2164. spin_unlock_irq(&gcwq->lock);
  2165. return false;
  2166. }
  2167. /**
  2168. * flush_work - wait for a work to finish executing the last queueing instance
  2169. * @work: the work to flush
  2170. *
  2171. * Wait until @work has finished execution. This function considers
  2172. * only the last queueing instance of @work. If @work has been
  2173. * enqueued across different CPUs on a non-reentrant workqueue or on
  2174. * multiple workqueues, @work might still be executing on return on
  2175. * some of the CPUs from earlier queueing.
  2176. *
  2177. * If @work was queued only on a non-reentrant, ordered or unbound
  2178. * workqueue, @work is guaranteed to be idle on return if it hasn't
  2179. * been requeued since flush started.
  2180. *
  2181. * RETURNS:
  2182. * %true if flush_work() waited for the work to finish execution,
  2183. * %false if it was already idle.
  2184. */
  2185. bool flush_work(struct work_struct *work)
  2186. {
  2187. struct wq_barrier barr;
  2188. lock_map_acquire(&work->lockdep_map);
  2189. lock_map_release(&work->lockdep_map);
  2190. if (start_flush_work(work, &barr, true)) {
  2191. wait_for_completion(&barr.done);
  2192. destroy_work_on_stack(&barr.work);
  2193. return true;
  2194. } else
  2195. return false;
  2196. }
  2197. EXPORT_SYMBOL_GPL(flush_work);
  2198. static bool wait_on_cpu_work(struct global_cwq *gcwq, struct work_struct *work)
  2199. {
  2200. struct wq_barrier barr;
  2201. struct worker *worker;
  2202. spin_lock_irq(&gcwq->lock);
  2203. worker = find_worker_executing_work(gcwq, work);
  2204. if (unlikely(worker))
  2205. insert_wq_barrier(worker->current_cwq, &barr, work, worker);
  2206. spin_unlock_irq(&gcwq->lock);
  2207. if (unlikely(worker)) {
  2208. wait_for_completion(&barr.done);
  2209. destroy_work_on_stack(&barr.work);
  2210. return true;
  2211. } else
  2212. return false;
  2213. }
  2214. static bool wait_on_work(struct work_struct *work)
  2215. {
  2216. bool ret = false;
  2217. int cpu;
  2218. might_sleep();
  2219. lock_map_acquire(&work->lockdep_map);
  2220. lock_map_release(&work->lockdep_map);
  2221. for_each_gcwq_cpu(cpu)
  2222. ret |= wait_on_cpu_work(get_gcwq(cpu), work);
  2223. return ret;
  2224. }
  2225. /**
  2226. * flush_work_sync - wait until a work has finished execution
  2227. * @work: the work to flush
  2228. *
  2229. * Wait until @work has finished execution. On return, it's
  2230. * guaranteed that all queueing instances of @work which happened
  2231. * before this function is called are finished. In other words, if
  2232. * @work hasn't been requeued since this function was called, @work is
  2233. * guaranteed to be idle on return.
  2234. *
  2235. * RETURNS:
  2236. * %true if flush_work_sync() waited for the work to finish execution,
  2237. * %false if it was already idle.
  2238. */
  2239. bool flush_work_sync(struct work_struct *work)
  2240. {
  2241. struct wq_barrier barr;
  2242. bool pending, waited;
  2243. /* we'll wait for executions separately, queue barr only if pending */
  2244. pending = start_flush_work(work, &barr, false);
  2245. /* wait for executions to finish */
  2246. waited = wait_on_work(work);
  2247. /* wait for the pending one */
  2248. if (pending) {
  2249. wait_for_completion(&barr.done);
  2250. destroy_work_on_stack(&barr.work);
  2251. }
  2252. return pending || waited;
  2253. }
  2254. EXPORT_SYMBOL_GPL(flush_work_sync);
  2255. /*
  2256. * Upon a successful return (>= 0), the caller "owns" WORK_STRUCT_PENDING bit,
  2257. * so this work can't be re-armed in any way.
  2258. */
  2259. static int try_to_grab_pending(struct work_struct *work)
  2260. {
  2261. struct global_cwq *gcwq;
  2262. int ret = -1;
  2263. if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
  2264. return 0;
  2265. /*
  2266. * The queueing is in progress, or it is already queued. Try to
  2267. * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
  2268. */
  2269. gcwq = get_work_gcwq(work);
  2270. if (!gcwq)
  2271. return ret;
  2272. spin_lock_irq(&gcwq->lock);
  2273. if (!list_empty(&work->entry)) {
  2274. /*
  2275. * This work is queued, but perhaps we locked the wrong gcwq.
  2276. * In that case we must see the new value after rmb(), see
  2277. * insert_work()->wmb().
  2278. */
  2279. smp_rmb();
  2280. if (gcwq == get_work_gcwq(work)) {
  2281. debug_work_deactivate(work);
  2282. list_del_init(&work->entry);
  2283. cwq_dec_nr_in_flight(get_work_cwq(work),
  2284. get_work_color(work),
  2285. *work_data_bits(work) & WORK_STRUCT_DELAYED);
  2286. ret = 1;
  2287. }
  2288. }
  2289. spin_unlock_irq(&gcwq->lock);
  2290. return ret;
  2291. }
  2292. static bool __cancel_work_timer(struct work_struct *work,
  2293. struct timer_list* timer)
  2294. {
  2295. int ret;
  2296. do {
  2297. ret = (timer && likely(del_timer(timer)));
  2298. if (!ret)
  2299. ret = try_to_grab_pending(work);
  2300. wait_on_work(work);
  2301. } while (unlikely(ret < 0));
  2302. clear_work_data(work);
  2303. return ret;
  2304. }
  2305. /**
  2306. * cancel_work_sync - cancel a work and wait for it to finish
  2307. * @work: the work to cancel
  2308. *
  2309. * Cancel @work and wait for its execution to finish. This function
  2310. * can be used even if the work re-queues itself or migrates to
  2311. * another workqueue. On return from this function, @work is
  2312. * guaranteed to be not pending or executing on any CPU.
  2313. *
  2314. * cancel_work_sync(&delayed_work->work) must not be used for
  2315. * delayed_work's. Use cancel_delayed_work_sync() instead.
  2316. *
  2317. * The caller must ensure that the workqueue on which @work was last
  2318. * queued can't be destroyed before this function returns.
  2319. *
  2320. * RETURNS:
  2321. * %true if @work was pending, %false otherwise.
  2322. */
  2323. bool cancel_work_sync(struct work_struct *work)
  2324. {
  2325. return __cancel_work_timer(work, NULL);
  2326. }
  2327. EXPORT_SYMBOL_GPL(cancel_work_sync);
  2328. /**
  2329. * flush_delayed_work - wait for a dwork to finish executing the last queueing
  2330. * @dwork: the delayed work to flush
  2331. *
  2332. * Delayed timer is cancelled and the pending work is queued for
  2333. * immediate execution. Like flush_work(), this function only
  2334. * considers the last queueing instance of @dwork.
  2335. *
  2336. * RETURNS:
  2337. * %true if flush_work() waited for the work to finish execution,
  2338. * %false if it was already idle.
  2339. */
  2340. bool flush_delayed_work(struct delayed_work *dwork)
  2341. {
  2342. if (del_timer_sync(&dwork->timer))
  2343. __queue_work(raw_smp_processor_id(),
  2344. get_work_cwq(&dwork->work)->wq, &dwork->work);
  2345. return flush_work(&dwork->work);
  2346. }
  2347. EXPORT_SYMBOL(flush_delayed_work);
  2348. /**
  2349. * flush_delayed_work_sync - wait for a dwork to finish
  2350. * @dwork: the delayed work to flush
  2351. *
  2352. * Delayed timer is cancelled and the pending work is queued for
  2353. * execution immediately. Other than timer handling, its behavior
  2354. * is identical to flush_work_sync().
  2355. *
  2356. * RETURNS:
  2357. * %true if flush_work_sync() waited for the work to finish execution,
  2358. * %false if it was already idle.
  2359. */
  2360. bool flush_delayed_work_sync(struct delayed_work *dwork)
  2361. {
  2362. if (del_timer_sync(&dwork->timer))
  2363. __queue_work(raw_smp_processor_id(),
  2364. get_work_cwq(&dwork->work)->wq, &dwork->work);
  2365. return flush_work_sync(&dwork->work);
  2366. }
  2367. EXPORT_SYMBOL(flush_delayed_work_sync);
  2368. /**
  2369. * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
  2370. * @dwork: the delayed work cancel
  2371. *
  2372. * This is cancel_work_sync() for delayed works.
  2373. *
  2374. * RETURNS:
  2375. * %true if @dwork was pending, %false otherwise.
  2376. */
  2377. bool cancel_delayed_work_sync(struct delayed_work *dwork)
  2378. {
  2379. return __cancel_work_timer(&dwork->work, &dwork->timer);
  2380. }
  2381. EXPORT_SYMBOL(cancel_delayed_work_sync);
  2382. /**
  2383. * schedule_work - put work task in global workqueue
  2384. * @work: job to be done
  2385. *
  2386. * Returns zero if @work was already on the kernel-global workqueue and
  2387. * non-zero otherwise.
  2388. *
  2389. * This puts a job in the kernel-global workqueue if it was not already
  2390. * queued and leaves it in the same position on the kernel-global
  2391. * workqueue otherwise.
  2392. */
  2393. int schedule_work(struct work_struct *work)
  2394. {
  2395. return queue_work(system_wq, work);
  2396. }
  2397. EXPORT_SYMBOL(schedule_work);
  2398. /*
  2399. * schedule_work_on - put work task on a specific cpu
  2400. * @cpu: cpu to put the work task on
  2401. * @work: job to be done
  2402. *
  2403. * This puts a job on a specific cpu
  2404. */
  2405. int schedule_work_on(int cpu, struct work_struct *work)
  2406. {
  2407. return queue_work_on(cpu, system_wq, work);
  2408. }
  2409. EXPORT_SYMBOL(schedule_work_on);
  2410. /**
  2411. * schedule_delayed_work - put work task in global workqueue after delay
  2412. * @dwork: job to be done
  2413. * @delay: number of jiffies to wait or 0 for immediate execution
  2414. *
  2415. * After waiting for a given time this puts a job in the kernel-global
  2416. * workqueue.
  2417. */
  2418. int schedule_delayed_work(struct delayed_work *dwork,
  2419. unsigned long delay)
  2420. {
  2421. return queue_delayed_work(system_wq, dwork, delay);
  2422. }
  2423. EXPORT_SYMBOL(schedule_delayed_work);
  2424. /**
  2425. * schedule_delayed_work_on - queue work in global workqueue on CPU after delay
  2426. * @cpu: cpu to use
  2427. * @dwork: job to be done
  2428. * @delay: number of jiffies to wait
  2429. *
  2430. * After waiting for a given time this puts a job in the kernel-global
  2431. * workqueue on the specified CPU.
  2432. */
  2433. int schedule_delayed_work_on(int cpu,
  2434. struct delayed_work *dwork, unsigned long delay)
  2435. {
  2436. return queue_delayed_work_on(cpu, system_wq, dwork, delay);
  2437. }
  2438. EXPORT_SYMBOL(schedule_delayed_work_on);
  2439. /**
  2440. * schedule_on_each_cpu - execute a function synchronously on each online CPU
  2441. * @func: the function to call
  2442. *
  2443. * schedule_on_each_cpu() executes @func on each online CPU using the
  2444. * system workqueue and blocks until all CPUs have completed.
  2445. * schedule_on_each_cpu() is very slow.
  2446. *
  2447. * RETURNS:
  2448. * 0 on success, -errno on failure.
  2449. */
  2450. int schedule_on_each_cpu(work_func_t func)
  2451. {
  2452. int cpu;
  2453. struct work_struct __percpu *works;
  2454. works = alloc_percpu(struct work_struct);
  2455. if (!works)
  2456. return -ENOMEM;
  2457. get_online_cpus();
  2458. for_each_online_cpu(cpu) {
  2459. struct work_struct *work = per_cpu_ptr(works, cpu);
  2460. INIT_WORK(work, func);
  2461. schedule_work_on(cpu, work);
  2462. }
  2463. for_each_online_cpu(cpu)
  2464. flush_work(per_cpu_ptr(works, cpu));
  2465. put_online_cpus();
  2466. free_percpu(works);
  2467. return 0;
  2468. }
  2469. /**
  2470. * flush_scheduled_work - ensure that any scheduled work has run to completion.
  2471. *
  2472. * Forces execution of the kernel-global workqueue and blocks until its
  2473. * completion.
  2474. *
  2475. * Think twice before calling this function! It's very easy to get into
  2476. * trouble if you don't take great care. Either of the following situations
  2477. * will lead to deadlock:
  2478. *
  2479. * One of the work items currently on the workqueue needs to acquire
  2480. * a lock held by your code or its caller.
  2481. *
  2482. * Your code is running in the context of a work routine.
  2483. *
  2484. * They will be detected by lockdep when they occur, but the first might not
  2485. * occur very often. It depends on what work items are on the workqueue and
  2486. * what locks they need, which you have no control over.
  2487. *
  2488. * In most situations flushing the entire workqueue is overkill; you merely
  2489. * need to know that a particular work item isn't queued and isn't running.
  2490. * In such cases you should use cancel_delayed_work_sync() or
  2491. * cancel_work_sync() instead.
  2492. */
  2493. void flush_scheduled_work(void)
  2494. {
  2495. flush_workqueue(system_wq);
  2496. }
  2497. EXPORT_SYMBOL(flush_scheduled_work);
  2498. /**
  2499. * execute_in_process_context - reliably execute the routine with user context
  2500. * @fn: the function to execute
  2501. * @ew: guaranteed storage for the execute work structure (must
  2502. * be available when the work executes)
  2503. *
  2504. * Executes the function immediately if process context is available,
  2505. * otherwise schedules the function for delayed execution.
  2506. *
  2507. * Returns: 0 - function was executed
  2508. * 1 - function was scheduled for execution
  2509. */
  2510. int execute_in_process_context(work_func_t fn, struct execute_work *ew)
  2511. {
  2512. if (!in_interrupt()) {
  2513. fn(&ew->work);
  2514. return 0;
  2515. }
  2516. INIT_WORK(&ew->work, fn);
  2517. schedule_work(&ew->work);
  2518. return 1;
  2519. }
  2520. EXPORT_SYMBOL_GPL(execute_in_process_context);
  2521. int keventd_up(void)
  2522. {
  2523. return system_wq != NULL;
  2524. }
  2525. static int alloc_cwqs(struct workqueue_struct *wq)
  2526. {
  2527. /*
  2528. * cwqs are forced aligned according to WORK_STRUCT_FLAG_BITS.
  2529. * Make sure that the alignment isn't lower than that of
  2530. * unsigned long long.
  2531. */
  2532. const size_t size = sizeof(struct cpu_workqueue_struct);
  2533. const size_t align = max_t(size_t, 1 << WORK_STRUCT_FLAG_BITS,
  2534. __alignof__(unsigned long long));
  2535. if (!(wq->flags & WQ_UNBOUND))
  2536. wq->cpu_wq.pcpu = __alloc_percpu(size, align);
  2537. else {
  2538. void *ptr;
  2539. /*
  2540. * Allocate enough room to align cwq and put an extra
  2541. * pointer at the end pointing back to the originally
  2542. * allocated pointer which will be used for free.
  2543. */
  2544. ptr = kzalloc(size + align + sizeof(void *), GFP_KERNEL);
  2545. if (ptr) {
  2546. wq->cpu_wq.single = PTR_ALIGN(ptr, align);
  2547. *(void **)(wq->cpu_wq.single + 1) = ptr;
  2548. }
  2549. }
  2550. /* just in case, make sure it's actually aligned */
  2551. BUG_ON(!IS_ALIGNED(wq->cpu_wq.v, align));
  2552. return wq->cpu_wq.v ? 0 : -ENOMEM;
  2553. }
  2554. static void free_cwqs(struct workqueue_struct *wq)
  2555. {
  2556. if (!(wq->flags & WQ_UNBOUND))
  2557. free_percpu(wq->cpu_wq.pcpu);
  2558. else if (wq->cpu_wq.single) {
  2559. /* the pointer to free is stored right after the cwq */
  2560. kfree(*(void **)(wq->cpu_wq.single + 1));
  2561. }
  2562. }
  2563. static int wq_clamp_max_active(int max_active, unsigned int flags,
  2564. const char *name)
  2565. {
  2566. int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
  2567. if (max_active < 1 || max_active > lim)
  2568. printk(KERN_WARNING "workqueue: max_active %d requested for %s "
  2569. "is out of range, clamping between %d and %d\n",
  2570. max_active, name, 1, lim);
  2571. return clamp_val(max_active, 1, lim);
  2572. }
  2573. struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
  2574. unsigned int flags,
  2575. int max_active,
  2576. struct lock_class_key *key,
  2577. const char *lock_name, ...)
  2578. {
  2579. va_list args, args1;
  2580. struct workqueue_struct *wq;
  2581. unsigned int cpu;
  2582. size_t namelen;
  2583. /* determine namelen, allocate wq and format name */
  2584. va_start(args, lock_name);
  2585. va_copy(args1, args);
  2586. namelen = vsnprintf(NULL, 0, fmt, args) + 1;
  2587. wq = kzalloc(sizeof(*wq) + namelen, GFP_KERNEL);
  2588. if (!wq)
  2589. goto err;
  2590. vsnprintf(wq->name, namelen, fmt, args1);
  2591. va_end(args);
  2592. va_end(args1);
  2593. /*
  2594. * Workqueues which may be used during memory reclaim should
  2595. * have a rescuer to guarantee forward progress.
  2596. */
  2597. if (flags & WQ_MEM_RECLAIM)
  2598. flags |= WQ_RESCUER;
  2599. /*
  2600. * Unbound workqueues aren't concurrency managed and should be
  2601. * dispatched to workers immediately.
  2602. */
  2603. if (flags & WQ_UNBOUND)
  2604. flags |= WQ_HIGHPRI;
  2605. max_active = max_active ?: WQ_DFL_ACTIVE;
  2606. max_active = wq_clamp_max_active(max_active, flags, wq->name);
  2607. /* init wq */
  2608. wq->flags = flags;
  2609. wq->saved_max_active = max_active;
  2610. mutex_init(&wq->flush_mutex);
  2611. atomic_set(&wq->nr_cwqs_to_flush, 0);
  2612. INIT_LIST_HEAD(&wq->flusher_queue);
  2613. INIT_LIST_HEAD(&wq->flusher_overflow);
  2614. lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
  2615. INIT_LIST_HEAD(&wq->list);
  2616. if (alloc_cwqs(wq) < 0)
  2617. goto err;
  2618. for_each_cwq_cpu(cpu, wq) {
  2619. struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
  2620. struct global_cwq *gcwq = get_gcwq(cpu);
  2621. BUG_ON((unsigned long)cwq & WORK_STRUCT_FLAG_MASK);
  2622. cwq->gcwq = gcwq;
  2623. cwq->wq = wq;
  2624. cwq->flush_color = -1;
  2625. cwq->max_active = max_active;
  2626. INIT_LIST_HEAD(&cwq->delayed_works);
  2627. }
  2628. if (flags & WQ_RESCUER) {
  2629. struct worker *rescuer;
  2630. if (!alloc_mayday_mask(&wq->mayday_mask, GFP_KERNEL))
  2631. goto err;
  2632. wq->rescuer = rescuer = alloc_worker();
  2633. if (!rescuer)
  2634. goto err;
  2635. rescuer->task = kthread_create(rescuer_thread, wq, "%s",
  2636. wq->name);
  2637. if (IS_ERR(rescuer->task))
  2638. goto err;
  2639. rescuer->task->flags |= PF_THREAD_BOUND;
  2640. wake_up_process(rescuer->task);
  2641. }
  2642. /*
  2643. * workqueue_lock protects global freeze state and workqueues
  2644. * list. Grab it, set max_active accordingly and add the new
  2645. * workqueue to workqueues list.
  2646. */
  2647. spin_lock(&workqueue_lock);
  2648. if (workqueue_freezing && wq->flags & WQ_FREEZABLE)
  2649. for_each_cwq_cpu(cpu, wq)
  2650. get_cwq(cpu, wq)->max_active = 0;
  2651. list_add(&wq->list, &workqueues);
  2652. spin_unlock(&workqueue_lock);
  2653. return wq;
  2654. err:
  2655. if (wq) {
  2656. free_cwqs(wq);
  2657. free_mayday_mask(wq->mayday_mask);
  2658. kfree(wq->rescuer);
  2659. kfree(wq);
  2660. }
  2661. return NULL;
  2662. }
  2663. EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
  2664. /**
  2665. * destroy_workqueue - safely terminate a workqueue
  2666. * @wq: target workqueue
  2667. *
  2668. * Safely destroy a workqueue. All work currently pending will be done first.
  2669. */
  2670. void destroy_workqueue(struct workqueue_struct *wq)
  2671. {
  2672. unsigned int cpu;
  2673. /* drain it before proceeding with destruction */
  2674. drain_workqueue(wq);
  2675. /*
  2676. * wq list is used to freeze wq, remove from list after
  2677. * flushing is complete in case freeze races us.
  2678. */
  2679. spin_lock(&workqueue_lock);
  2680. list_del(&wq->list);
  2681. spin_unlock(&workqueue_lock);
  2682. /* sanity check */
  2683. for_each_cwq_cpu(cpu, wq) {
  2684. struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
  2685. int i;
  2686. for (i = 0; i < WORK_NR_COLORS; i++)
  2687. BUG_ON(cwq->nr_in_flight[i]);
  2688. BUG_ON(cwq->nr_active);
  2689. BUG_ON(!list_empty(&cwq->delayed_works));
  2690. }
  2691. if (wq->flags & WQ_RESCUER) {
  2692. kthread_stop(wq->rescuer->task);
  2693. free_mayday_mask(wq->mayday_mask);
  2694. kfree(wq->rescuer);
  2695. }
  2696. free_cwqs(wq);
  2697. kfree(wq);
  2698. }
  2699. EXPORT_SYMBOL_GPL(destroy_workqueue);
  2700. /**
  2701. * workqueue_set_max_active - adjust max_active of a workqueue
  2702. * @wq: target workqueue
  2703. * @max_active: new max_active value.
  2704. *
  2705. * Set max_active of @wq to @max_active.
  2706. *
  2707. * CONTEXT:
  2708. * Don't call from IRQ context.
  2709. */
  2710. void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
  2711. {
  2712. unsigned int cpu;
  2713. max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
  2714. spin_lock(&workqueue_lock);
  2715. wq->saved_max_active = max_active;
  2716. for_each_cwq_cpu(cpu, wq) {
  2717. struct global_cwq *gcwq = get_gcwq(cpu);
  2718. spin_lock_irq(&gcwq->lock);
  2719. if (!(wq->flags & WQ_FREEZABLE) ||
  2720. !(gcwq->flags & GCWQ_FREEZING))
  2721. get_cwq(gcwq->cpu, wq)->max_active = max_active;
  2722. spin_unlock_irq(&gcwq->lock);
  2723. }
  2724. spin_unlock(&workqueue_lock);
  2725. }
  2726. EXPORT_SYMBOL_GPL(workqueue_set_max_active);
  2727. /**
  2728. * workqueue_congested - test whether a workqueue is congested
  2729. * @cpu: CPU in question
  2730. * @wq: target workqueue
  2731. *
  2732. * Test whether @wq's cpu workqueue for @cpu is congested. There is
  2733. * no synchronization around this function and the test result is
  2734. * unreliable and only useful as advisory hints or for debugging.
  2735. *
  2736. * RETURNS:
  2737. * %true if congested, %false otherwise.
  2738. */
  2739. bool workqueue_congested(unsigned int cpu, struct workqueue_struct *wq)
  2740. {
  2741. struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
  2742. return !list_empty(&cwq->delayed_works);
  2743. }
  2744. EXPORT_SYMBOL_GPL(workqueue_congested);
  2745. /**
  2746. * work_cpu - return the last known associated cpu for @work
  2747. * @work: the work of interest
  2748. *
  2749. * RETURNS:
  2750. * CPU number if @work was ever queued. WORK_CPU_NONE otherwise.
  2751. */
  2752. unsigned int work_cpu(struct work_struct *work)
  2753. {
  2754. struct global_cwq *gcwq = get_work_gcwq(work);
  2755. return gcwq ? gcwq->cpu : WORK_CPU_NONE;
  2756. }
  2757. EXPORT_SYMBOL_GPL(work_cpu);
  2758. /**
  2759. * work_busy - test whether a work is currently pending or running
  2760. * @work: the work to be tested
  2761. *
  2762. * Test whether @work is currently pending or running. There is no
  2763. * synchronization around this function and the test result is
  2764. * unreliable and only useful as advisory hints or for debugging.
  2765. * Especially for reentrant wqs, the pending state might hide the
  2766. * running state.
  2767. *
  2768. * RETURNS:
  2769. * OR'd bitmask of WORK_BUSY_* bits.
  2770. */
  2771. unsigned int work_busy(struct work_struct *work)
  2772. {
  2773. struct global_cwq *gcwq = get_work_gcwq(work);
  2774. unsigned long flags;
  2775. unsigned int ret = 0;
  2776. if (!gcwq)
  2777. return false;
  2778. spin_lock_irqsave(&gcwq->lock, flags);
  2779. if (work_pending(work))
  2780. ret |= WORK_BUSY_PENDING;
  2781. if (find_worker_executing_work(gcwq, work))
  2782. ret |= WORK_BUSY_RUNNING;
  2783. spin_unlock_irqrestore(&gcwq->lock, flags);
  2784. return ret;
  2785. }
  2786. EXPORT_SYMBOL_GPL(work_busy);
  2787. /*
  2788. * CPU hotplug.
  2789. *
  2790. * There are two challenges in supporting CPU hotplug. Firstly, there
  2791. * are a lot of assumptions on strong associations among work, cwq and
  2792. * gcwq which make migrating pending and scheduled works very
  2793. * difficult to implement without impacting hot paths. Secondly,
  2794. * gcwqs serve mix of short, long and very long running works making
  2795. * blocked draining impractical.
  2796. *
  2797. * This is solved by allowing a gcwq to be detached from CPU, running
  2798. * it with unbound (rogue) workers and allowing it to be reattached
  2799. * later if the cpu comes back online. A separate thread is created
  2800. * to govern a gcwq in such state and is called the trustee of the
  2801. * gcwq.
  2802. *
  2803. * Trustee states and their descriptions.
  2804. *
  2805. * START Command state used on startup. On CPU_DOWN_PREPARE, a
  2806. * new trustee is started with this state.
  2807. *
  2808. * IN_CHARGE Once started, trustee will enter this state after
  2809. * assuming the manager role and making all existing
  2810. * workers rogue. DOWN_PREPARE waits for trustee to
  2811. * enter this state. After reaching IN_CHARGE, trustee
  2812. * tries to execute the pending worklist until it's empty
  2813. * and the state is set to BUTCHER, or the state is set
  2814. * to RELEASE.
  2815. *
  2816. * BUTCHER Command state which is set by the cpu callback after
  2817. * the cpu has went down. Once this state is set trustee
  2818. * knows that there will be no new works on the worklist
  2819. * and once the worklist is empty it can proceed to
  2820. * killing idle workers.
  2821. *
  2822. * RELEASE Command state which is set by the cpu callback if the
  2823. * cpu down has been canceled or it has come online
  2824. * again. After recognizing this state, trustee stops
  2825. * trying to drain or butcher and clears ROGUE, rebinds
  2826. * all remaining workers back to the cpu and releases
  2827. * manager role.
  2828. *
  2829. * DONE Trustee will enter this state after BUTCHER or RELEASE
  2830. * is complete.
  2831. *
  2832. * trustee CPU draining
  2833. * took over down complete
  2834. * START -----------> IN_CHARGE -----------> BUTCHER -----------> DONE
  2835. * | | ^
  2836. * | CPU is back online v return workers |
  2837. * ----------------> RELEASE --------------
  2838. */
  2839. /**
  2840. * trustee_wait_event_timeout - timed event wait for trustee
  2841. * @cond: condition to wait for
  2842. * @timeout: timeout in jiffies
  2843. *
  2844. * wait_event_timeout() for trustee to use. Handles locking and
  2845. * checks for RELEASE request.
  2846. *
  2847. * CONTEXT:
  2848. * spin_lock_irq(gcwq->lock) which may be released and regrabbed
  2849. * multiple times. To be used by trustee.
  2850. *
  2851. * RETURNS:
  2852. * Positive indicating left time if @cond is satisfied, 0 if timed
  2853. * out, -1 if canceled.
  2854. */
  2855. #define trustee_wait_event_timeout(cond, timeout) ({ \
  2856. long __ret = (timeout); \
  2857. while (!((cond) || (gcwq->trustee_state == TRUSTEE_RELEASE)) && \
  2858. __ret) { \
  2859. spin_unlock_irq(&gcwq->lock); \
  2860. __wait_event_timeout(gcwq->trustee_wait, (cond) || \
  2861. (gcwq->trustee_state == TRUSTEE_RELEASE), \
  2862. __ret); \
  2863. spin_lock_irq(&gcwq->lock); \
  2864. } \
  2865. gcwq->trustee_state == TRUSTEE_RELEASE ? -1 : (__ret); \
  2866. })
  2867. /**
  2868. * trustee_wait_event - event wait for trustee
  2869. * @cond: condition to wait for
  2870. *
  2871. * wait_event() for trustee to use. Automatically handles locking and
  2872. * checks for CANCEL request.
  2873. *
  2874. * CONTEXT:
  2875. * spin_lock_irq(gcwq->lock) which may be released and regrabbed
  2876. * multiple times. To be used by trustee.
  2877. *
  2878. * RETURNS:
  2879. * 0 if @cond is satisfied, -1 if canceled.
  2880. */
  2881. #define trustee_wait_event(cond) ({ \
  2882. long __ret1; \
  2883. __ret1 = trustee_wait_event_timeout(cond, MAX_SCHEDULE_TIMEOUT);\
  2884. __ret1 < 0 ? -1 : 0; \
  2885. })
  2886. static int __cpuinit trustee_thread(void *__gcwq)
  2887. {
  2888. struct global_cwq *gcwq = __gcwq;
  2889. struct worker *worker;
  2890. struct work_struct *work;
  2891. struct hlist_node *pos;
  2892. long rc;
  2893. int i;
  2894. BUG_ON(gcwq->cpu != smp_processor_id());
  2895. spin_lock_irq(&gcwq->lock);
  2896. /*
  2897. * Claim the manager position and make all workers rogue.
  2898. * Trustee must be bound to the target cpu and can't be
  2899. * cancelled.
  2900. */
  2901. BUG_ON(gcwq->cpu != smp_processor_id());
  2902. rc = trustee_wait_event(!(gcwq->flags & GCWQ_MANAGING_WORKERS));
  2903. BUG_ON(rc < 0);
  2904. gcwq->flags |= GCWQ_MANAGING_WORKERS;
  2905. list_for_each_entry(worker, &gcwq->idle_list, entry)
  2906. worker->flags |= WORKER_ROGUE;
  2907. for_each_busy_worker(worker, i, pos, gcwq)
  2908. worker->flags |= WORKER_ROGUE;
  2909. /*
  2910. * Call schedule() so that we cross rq->lock and thus can
  2911. * guarantee sched callbacks see the rogue flag. This is
  2912. * necessary as scheduler callbacks may be invoked from other
  2913. * cpus.
  2914. */
  2915. spin_unlock_irq(&gcwq->lock);
  2916. schedule();
  2917. spin_lock_irq(&gcwq->lock);
  2918. /*
  2919. * Sched callbacks are disabled now. Zap nr_running. After
  2920. * this, nr_running stays zero and need_more_worker() and
  2921. * keep_working() are always true as long as the worklist is
  2922. * not empty.
  2923. */
  2924. atomic_set(get_gcwq_nr_running(gcwq->cpu), 0);
  2925. spin_unlock_irq(&gcwq->lock);
  2926. del_timer_sync(&gcwq->idle_timer);
  2927. spin_lock_irq(&gcwq->lock);
  2928. /*
  2929. * We're now in charge. Notify and proceed to drain. We need
  2930. * to keep the gcwq running during the whole CPU down
  2931. * procedure as other cpu hotunplug callbacks may need to
  2932. * flush currently running tasks.
  2933. */
  2934. gcwq->trustee_state = TRUSTEE_IN_CHARGE;
  2935. wake_up_all(&gcwq->trustee_wait);
  2936. /*
  2937. * The original cpu is in the process of dying and may go away
  2938. * anytime now. When that happens, we and all workers would
  2939. * be migrated to other cpus. Try draining any left work. We
  2940. * want to get it over with ASAP - spam rescuers, wake up as
  2941. * many idlers as necessary and create new ones till the
  2942. * worklist is empty. Note that if the gcwq is frozen, there
  2943. * may be frozen works in freezable cwqs. Don't declare
  2944. * completion while frozen.
  2945. */
  2946. while (gcwq->nr_workers != gcwq->nr_idle ||
  2947. gcwq->flags & GCWQ_FREEZING ||
  2948. gcwq->trustee_state == TRUSTEE_IN_CHARGE) {
  2949. int nr_works = 0;
  2950. list_for_each_entry(work, &gcwq->worklist, entry) {
  2951. send_mayday(work);
  2952. nr_works++;
  2953. }
  2954. list_for_each_entry(worker, &gcwq->idle_list, entry) {
  2955. if (!nr_works--)
  2956. break;
  2957. wake_up_process(worker->task);
  2958. }
  2959. if (need_to_create_worker(gcwq)) {
  2960. spin_unlock_irq(&gcwq->lock);
  2961. worker = create_worker(gcwq, false);
  2962. spin_lock_irq(&gcwq->lock);
  2963. if (worker) {
  2964. worker->flags |= WORKER_ROGUE;
  2965. start_worker(worker);
  2966. }
  2967. }
  2968. /* give a breather */
  2969. if (trustee_wait_event_timeout(false, TRUSTEE_COOLDOWN) < 0)
  2970. break;
  2971. }
  2972. /*
  2973. * Either all works have been scheduled and cpu is down, or
  2974. * cpu down has already been canceled. Wait for and butcher
  2975. * all workers till we're canceled.
  2976. */
  2977. do {
  2978. rc = trustee_wait_event(!list_empty(&gcwq->idle_list));
  2979. while (!list_empty(&gcwq->idle_list))
  2980. destroy_worker(list_first_entry(&gcwq->idle_list,
  2981. struct worker, entry));
  2982. } while (gcwq->nr_workers && rc >= 0);
  2983. /*
  2984. * At this point, either draining has completed and no worker
  2985. * is left, or cpu down has been canceled or the cpu is being
  2986. * brought back up. There shouldn't be any idle one left.
  2987. * Tell the remaining busy ones to rebind once it finishes the
  2988. * currently scheduled works by scheduling the rebind_work.
  2989. */
  2990. WARN_ON(!list_empty(&gcwq->idle_list));
  2991. for_each_busy_worker(worker, i, pos, gcwq) {
  2992. struct work_struct *rebind_work = &worker->rebind_work;
  2993. /*
  2994. * Rebind_work may race with future cpu hotplug
  2995. * operations. Use a separate flag to mark that
  2996. * rebinding is scheduled.
  2997. */
  2998. worker->flags |= WORKER_REBIND;
  2999. worker->flags &= ~WORKER_ROGUE;
  3000. /* queue rebind_work, wq doesn't matter, use the default one */
  3001. if (test_and_set_bit(WORK_STRUCT_PENDING_BIT,
  3002. work_data_bits(rebind_work)))
  3003. continue;
  3004. debug_work_activate(rebind_work);
  3005. insert_work(get_cwq(gcwq->cpu, system_wq), rebind_work,
  3006. worker->scheduled.next,
  3007. work_color_to_flags(WORK_NO_COLOR));
  3008. }
  3009. /* relinquish manager role */
  3010. gcwq->flags &= ~GCWQ_MANAGING_WORKERS;
  3011. /* notify completion */
  3012. gcwq->trustee = NULL;
  3013. gcwq->trustee_state = TRUSTEE_DONE;
  3014. wake_up_all(&gcwq->trustee_wait);
  3015. spin_unlock_irq(&gcwq->lock);
  3016. return 0;
  3017. }
  3018. /**
  3019. * wait_trustee_state - wait for trustee to enter the specified state
  3020. * @gcwq: gcwq the trustee of interest belongs to
  3021. * @state: target state to wait for
  3022. *
  3023. * Wait for the trustee to reach @state. DONE is already matched.
  3024. *
  3025. * CONTEXT:
  3026. * spin_lock_irq(gcwq->lock) which may be released and regrabbed
  3027. * multiple times. To be used by cpu_callback.
  3028. */
  3029. static void __cpuinit wait_trustee_state(struct global_cwq *gcwq, int state)
  3030. __releases(&gcwq->lock)
  3031. __acquires(&gcwq->lock)
  3032. {
  3033. if (!(gcwq->trustee_state == state ||
  3034. gcwq->trustee_state == TRUSTEE_DONE)) {
  3035. spin_unlock_irq(&gcwq->lock);
  3036. __wait_event(gcwq->trustee_wait,
  3037. gcwq->trustee_state == state ||
  3038. gcwq->trustee_state == TRUSTEE_DONE);
  3039. spin_lock_irq(&gcwq->lock);
  3040. }
  3041. }
  3042. static int __devinit workqueue_cpu_callback(struct notifier_block *nfb,
  3043. unsigned long action,
  3044. void *hcpu)
  3045. {
  3046. unsigned int cpu = (unsigned long)hcpu;
  3047. struct global_cwq *gcwq = get_gcwq(cpu);
  3048. struct task_struct *new_trustee = NULL;
  3049. struct worker *uninitialized_var(new_worker);
  3050. unsigned long flags;
  3051. action &= ~CPU_TASKS_FROZEN;
  3052. switch (action) {
  3053. case CPU_DOWN_PREPARE:
  3054. new_trustee = kthread_create(trustee_thread, gcwq,
  3055. "workqueue_trustee/%d\n", cpu);
  3056. if (IS_ERR(new_trustee))
  3057. return notifier_from_errno(PTR_ERR(new_trustee));
  3058. kthread_bind(new_trustee, cpu);
  3059. /* fall through */
  3060. case CPU_UP_PREPARE:
  3061. BUG_ON(gcwq->first_idle);
  3062. new_worker = create_worker(gcwq, false);
  3063. if (!new_worker) {
  3064. if (new_trustee)
  3065. kthread_stop(new_trustee);
  3066. return NOTIFY_BAD;
  3067. }
  3068. }
  3069. /* some are called w/ irq disabled, don't disturb irq status */
  3070. spin_lock_irqsave(&gcwq->lock, flags);
  3071. switch (action) {
  3072. case CPU_DOWN_PREPARE:
  3073. /* initialize trustee and tell it to acquire the gcwq */
  3074. BUG_ON(gcwq->trustee || gcwq->trustee_state != TRUSTEE_DONE);
  3075. gcwq->trustee = new_trustee;
  3076. gcwq->trustee_state = TRUSTEE_START;
  3077. wake_up_process(gcwq->trustee);
  3078. wait_trustee_state(gcwq, TRUSTEE_IN_CHARGE);
  3079. /* fall through */
  3080. case CPU_UP_PREPARE:
  3081. BUG_ON(gcwq->first_idle);
  3082. gcwq->first_idle = new_worker;
  3083. break;
  3084. case CPU_DYING:
  3085. /*
  3086. * Before this, the trustee and all workers except for
  3087. * the ones which are still executing works from
  3088. * before the last CPU down must be on the cpu. After
  3089. * this, they'll all be diasporas.
  3090. */
  3091. gcwq->flags |= GCWQ_DISASSOCIATED;
  3092. break;
  3093. case CPU_POST_DEAD:
  3094. gcwq->trustee_state = TRUSTEE_BUTCHER;
  3095. /* fall through */
  3096. case CPU_UP_CANCELED:
  3097. destroy_worker(gcwq->first_idle);
  3098. gcwq->first_idle = NULL;
  3099. break;
  3100. case CPU_DOWN_FAILED:
  3101. case CPU_ONLINE:
  3102. gcwq->flags &= ~GCWQ_DISASSOCIATED;
  3103. if (gcwq->trustee_state != TRUSTEE_DONE) {
  3104. gcwq->trustee_state = TRUSTEE_RELEASE;
  3105. wake_up_process(gcwq->trustee);
  3106. wait_trustee_state(gcwq, TRUSTEE_DONE);
  3107. }
  3108. /*
  3109. * Trustee is done and there might be no worker left.
  3110. * Put the first_idle in and request a real manager to
  3111. * take a look.
  3112. */
  3113. spin_unlock_irq(&gcwq->lock);
  3114. kthread_bind(gcwq->first_idle->task, cpu);
  3115. spin_lock_irq(&gcwq->lock);
  3116. gcwq->flags |= GCWQ_MANAGE_WORKERS;
  3117. start_worker(gcwq->first_idle);
  3118. gcwq->first_idle = NULL;
  3119. break;
  3120. }
  3121. spin_unlock_irqrestore(&gcwq->lock, flags);
  3122. return notifier_from_errno(0);
  3123. }
  3124. #ifdef CONFIG_SMP
  3125. struct work_for_cpu {
  3126. struct completion completion;
  3127. long (*fn)(void *);
  3128. void *arg;
  3129. long ret;
  3130. };
  3131. static int do_work_for_cpu(void *_wfc)
  3132. {
  3133. struct work_for_cpu *wfc = _wfc;
  3134. wfc->ret = wfc->fn(wfc->arg);
  3135. complete(&wfc->completion);
  3136. return 0;
  3137. }
  3138. /**
  3139. * work_on_cpu - run a function in user context on a particular cpu
  3140. * @cpu: the cpu to run on
  3141. * @fn: the function to run
  3142. * @arg: the function arg
  3143. *
  3144. * This will return the value @fn returns.
  3145. * It is up to the caller to ensure that the cpu doesn't go offline.
  3146. * The caller must not hold any locks which would prevent @fn from completing.
  3147. */
  3148. long work_on_cpu(unsigned int cpu, long (*fn)(void *), void *arg)
  3149. {
  3150. struct task_struct *sub_thread;
  3151. struct work_for_cpu wfc = {
  3152. .completion = COMPLETION_INITIALIZER_ONSTACK(wfc.completion),
  3153. .fn = fn,
  3154. .arg = arg,
  3155. };
  3156. sub_thread = kthread_create(do_work_for_cpu, &wfc, "work_for_cpu");
  3157. if (IS_ERR(sub_thread))
  3158. return PTR_ERR(sub_thread);
  3159. kthread_bind(sub_thread, cpu);
  3160. wake_up_process(sub_thread);
  3161. wait_for_completion(&wfc.completion);
  3162. return wfc.ret;
  3163. }
  3164. EXPORT_SYMBOL_GPL(work_on_cpu);
  3165. #endif /* CONFIG_SMP */
  3166. #ifdef CONFIG_FREEZER
  3167. /**
  3168. * freeze_workqueues_begin - begin freezing workqueues
  3169. *
  3170. * Start freezing workqueues. After this function returns, all freezable
  3171. * workqueues will queue new works to their frozen_works list instead of
  3172. * gcwq->worklist.
  3173. *
  3174. * CONTEXT:
  3175. * Grabs and releases workqueue_lock and gcwq->lock's.
  3176. */
  3177. void freeze_workqueues_begin(void)
  3178. {
  3179. unsigned int cpu;
  3180. spin_lock(&workqueue_lock);
  3181. BUG_ON(workqueue_freezing);
  3182. workqueue_freezing = true;
  3183. for_each_gcwq_cpu(cpu) {
  3184. struct global_cwq *gcwq = get_gcwq(cpu);
  3185. struct workqueue_struct *wq;
  3186. spin_lock_irq(&gcwq->lock);
  3187. BUG_ON(gcwq->flags & GCWQ_FREEZING);
  3188. gcwq->flags |= GCWQ_FREEZING;
  3189. list_for_each_entry(wq, &workqueues, list) {
  3190. struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
  3191. if (cwq && wq->flags & WQ_FREEZABLE)
  3192. cwq->max_active = 0;
  3193. }
  3194. spin_unlock_irq(&gcwq->lock);
  3195. }
  3196. spin_unlock(&workqueue_lock);
  3197. }
  3198. /**
  3199. * freeze_workqueues_busy - are freezable workqueues still busy?
  3200. *
  3201. * Check whether freezing is complete. This function must be called
  3202. * between freeze_workqueues_begin() and thaw_workqueues().
  3203. *
  3204. * CONTEXT:
  3205. * Grabs and releases workqueue_lock.
  3206. *
  3207. * RETURNS:
  3208. * %true if some freezable workqueues are still busy. %false if freezing
  3209. * is complete.
  3210. */
  3211. bool freeze_workqueues_busy(void)
  3212. {
  3213. unsigned int cpu;
  3214. bool busy = false;
  3215. spin_lock(&workqueue_lock);
  3216. BUG_ON(!workqueue_freezing);
  3217. for_each_gcwq_cpu(cpu) {
  3218. struct workqueue_struct *wq;
  3219. /*
  3220. * nr_active is monotonically decreasing. It's safe
  3221. * to peek without lock.
  3222. */
  3223. list_for_each_entry(wq, &workqueues, list) {
  3224. struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
  3225. if (!cwq || !(wq->flags & WQ_FREEZABLE))
  3226. continue;
  3227. BUG_ON(cwq->nr_active < 0);
  3228. if (cwq->nr_active) {
  3229. busy = true;
  3230. goto out_unlock;
  3231. }
  3232. }
  3233. }
  3234. out_unlock:
  3235. spin_unlock(&workqueue_lock);
  3236. return busy;
  3237. }
  3238. /**
  3239. * thaw_workqueues - thaw workqueues
  3240. *
  3241. * Thaw workqueues. Normal queueing is restored and all collected
  3242. * frozen works are transferred to their respective gcwq worklists.
  3243. *
  3244. * CONTEXT:
  3245. * Grabs and releases workqueue_lock and gcwq->lock's.
  3246. */
  3247. void thaw_workqueues(void)
  3248. {
  3249. unsigned int cpu;
  3250. spin_lock(&workqueue_lock);
  3251. if (!workqueue_freezing)
  3252. goto out_unlock;
  3253. for_each_gcwq_cpu(cpu) {
  3254. struct global_cwq *gcwq = get_gcwq(cpu);
  3255. struct workqueue_struct *wq;
  3256. spin_lock_irq(&gcwq->lock);
  3257. BUG_ON(!(gcwq->flags & GCWQ_FREEZING));
  3258. gcwq->flags &= ~GCWQ_FREEZING;
  3259. list_for_each_entry(wq, &workqueues, list) {
  3260. struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
  3261. if (!cwq || !(wq->flags & WQ_FREEZABLE))
  3262. continue;
  3263. /* restore max_active and repopulate worklist */
  3264. cwq->max_active = wq->saved_max_active;
  3265. while (!list_empty(&cwq->delayed_works) &&
  3266. cwq->nr_active < cwq->max_active)
  3267. cwq_activate_first_delayed(cwq);
  3268. }
  3269. wake_up_worker(gcwq);
  3270. spin_unlock_irq(&gcwq->lock);
  3271. }
  3272. workqueue_freezing = false;
  3273. out_unlock:
  3274. spin_unlock(&workqueue_lock);
  3275. }
  3276. #endif /* CONFIG_FREEZER */
  3277. static int __init init_workqueues(void)
  3278. {
  3279. unsigned int cpu;
  3280. int i;
  3281. cpu_notifier(workqueue_cpu_callback, CPU_PRI_WORKQUEUE);
  3282. /* initialize gcwqs */
  3283. for_each_gcwq_cpu(cpu) {
  3284. struct global_cwq *gcwq = get_gcwq(cpu);
  3285. spin_lock_init(&gcwq->lock);
  3286. INIT_LIST_HEAD(&gcwq->worklist);
  3287. gcwq->cpu = cpu;
  3288. gcwq->flags |= GCWQ_DISASSOCIATED;
  3289. INIT_LIST_HEAD(&gcwq->idle_list);
  3290. for (i = 0; i < BUSY_WORKER_HASH_SIZE; i++)
  3291. INIT_HLIST_HEAD(&gcwq->busy_hash[i]);
  3292. init_timer_deferrable(&gcwq->idle_timer);
  3293. gcwq->idle_timer.function = idle_worker_timeout;
  3294. gcwq->idle_timer.data = (unsigned long)gcwq;
  3295. setup_timer(&gcwq->mayday_timer, gcwq_mayday_timeout,
  3296. (unsigned long)gcwq);
  3297. ida_init(&gcwq->worker_ida);
  3298. gcwq->trustee_state = TRUSTEE_DONE;
  3299. init_waitqueue_head(&gcwq->trustee_wait);
  3300. }
  3301. /* create the initial worker */
  3302. for_each_online_gcwq_cpu(cpu) {
  3303. struct global_cwq *gcwq = get_gcwq(cpu);
  3304. struct worker *worker;
  3305. if (cpu != WORK_CPU_UNBOUND)
  3306. gcwq->flags &= ~GCWQ_DISASSOCIATED;
  3307. worker = create_worker(gcwq, true);
  3308. BUG_ON(!worker);
  3309. spin_lock_irq(&gcwq->lock);
  3310. start_worker(worker);
  3311. spin_unlock_irq(&gcwq->lock);
  3312. }
  3313. system_wq = alloc_workqueue("events", 0, 0);
  3314. system_long_wq = alloc_workqueue("events_long", 0, 0);
  3315. system_nrt_wq = alloc_workqueue("events_nrt", WQ_NON_REENTRANT, 0);
  3316. system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
  3317. WQ_UNBOUND_MAX_ACTIVE);
  3318. system_freezable_wq = alloc_workqueue("events_freezable",
  3319. WQ_FREEZABLE, 0);
  3320. system_nrt_freezable_wq = alloc_workqueue("events_nrt_freezable",
  3321. WQ_NON_REENTRANT | WQ_FREEZABLE, 0);
  3322. BUG_ON(!system_wq || !system_long_wq || !system_nrt_wq ||
  3323. !system_unbound_wq || !system_freezable_wq ||
  3324. !system_nrt_freezable_wq);
  3325. return 0;
  3326. }
  3327. early_initcall(init_workqueues);