workqueue.c 103 KB

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