workqueue.c 126 KB

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