dcache.c 89 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462
  1. /*
  2. * fs/dcache.c
  3. *
  4. * Complete reimplementation
  5. * (C) 1997 Thomas Schoebel-Theuer,
  6. * with heavy changes by Linus Torvalds
  7. */
  8. /*
  9. * Notes on the allocation strategy:
  10. *
  11. * The dcache is a master of the icache - whenever a dcache entry
  12. * exists, the inode will always exist. "iput()" is done either when
  13. * the dcache entry is deleted or garbage collected.
  14. */
  15. #include <linux/syscalls.h>
  16. #include <linux/string.h>
  17. #include <linux/mm.h>
  18. #include <linux/fs.h>
  19. #include <linux/fsnotify.h>
  20. #include <linux/slab.h>
  21. #include <linux/init.h>
  22. #include <linux/hash.h>
  23. #include <linux/cache.h>
  24. #include <linux/export.h>
  25. #include <linux/mount.h>
  26. #include <linux/file.h>
  27. #include <asm/uaccess.h>
  28. #include <linux/security.h>
  29. #include <linux/seqlock.h>
  30. #include <linux/swap.h>
  31. #include <linux/bootmem.h>
  32. #include <linux/fs_struct.h>
  33. #include <linux/hardirq.h>
  34. #include <linux/bit_spinlock.h>
  35. #include <linux/rculist_bl.h>
  36. #include <linux/prefetch.h>
  37. #include <linux/ratelimit.h>
  38. #include <linux/list_lru.h>
  39. #include <linux/kasan.h>
  40. #include "internal.h"
  41. #include "mount.h"
  42. /*
  43. * Usage:
  44. * dcache->d_inode->i_lock protects:
  45. * - i_dentry, d_u.d_alias, d_inode of aliases
  46. * dcache_hash_bucket lock protects:
  47. * - the dcache hash table
  48. * s_anon bl list spinlock protects:
  49. * - the s_anon list (see __d_drop)
  50. * dentry->d_sb->s_dentry_lru_lock protects:
  51. * - the dcache lru lists and counters
  52. * d_lock protects:
  53. * - d_flags
  54. * - d_name
  55. * - d_lru
  56. * - d_count
  57. * - d_unhashed()
  58. * - d_parent and d_subdirs
  59. * - childrens' d_child and d_parent
  60. * - d_u.d_alias, d_inode
  61. *
  62. * Ordering:
  63. * dentry->d_inode->i_lock
  64. * dentry->d_lock
  65. * dentry->d_sb->s_dentry_lru_lock
  66. * dcache_hash_bucket lock
  67. * s_anon lock
  68. *
  69. * If there is an ancestor relationship:
  70. * dentry->d_parent->...->d_parent->d_lock
  71. * ...
  72. * dentry->d_parent->d_lock
  73. * dentry->d_lock
  74. *
  75. * If no ancestor relationship:
  76. * if (dentry1 < dentry2)
  77. * dentry1->d_lock
  78. * dentry2->d_lock
  79. */
  80. int sysctl_vfs_cache_pressure __read_mostly = 100;
  81. EXPORT_SYMBOL_GPL(sysctl_vfs_cache_pressure);
  82. __cacheline_aligned_in_smp DEFINE_SEQLOCK(rename_lock);
  83. EXPORT_SYMBOL(rename_lock);
  84. static struct kmem_cache *dentry_cache __read_mostly;
  85. /*
  86. * This is the single most critical data structure when it comes
  87. * to the dcache: the hashtable for lookups. Somebody should try
  88. * to make this good - I've just made it work.
  89. *
  90. * This hash-function tries to avoid losing too many bits of hash
  91. * information, yet avoid using a prime hash-size or similar.
  92. */
  93. static unsigned int d_hash_mask __read_mostly;
  94. static unsigned int d_hash_shift __read_mostly;
  95. static struct hlist_bl_head *dentry_hashtable __read_mostly;
  96. static inline struct hlist_bl_head *d_hash(const struct dentry *parent,
  97. unsigned int hash)
  98. {
  99. hash += (unsigned long) parent / L1_CACHE_BYTES;
  100. return dentry_hashtable + hash_32(hash, d_hash_shift);
  101. }
  102. /* Statistics gathering. */
  103. struct dentry_stat_t dentry_stat = {
  104. .age_limit = 45,
  105. };
  106. static DEFINE_PER_CPU(long, nr_dentry);
  107. static DEFINE_PER_CPU(long, nr_dentry_unused);
  108. #if defined(CONFIG_SYSCTL) && defined(CONFIG_PROC_FS)
  109. /*
  110. * Here we resort to our own counters instead of using generic per-cpu counters
  111. * for consistency with what the vfs inode code does. We are expected to harvest
  112. * better code and performance by having our own specialized counters.
  113. *
  114. * Please note that the loop is done over all possible CPUs, not over all online
  115. * CPUs. The reason for this is that we don't want to play games with CPUs going
  116. * on and off. If one of them goes off, we will just keep their counters.
  117. *
  118. * glommer: See cffbc8a for details, and if you ever intend to change this,
  119. * please update all vfs counters to match.
  120. */
  121. static long get_nr_dentry(void)
  122. {
  123. int i;
  124. long sum = 0;
  125. for_each_possible_cpu(i)
  126. sum += per_cpu(nr_dentry, i);
  127. return sum < 0 ? 0 : sum;
  128. }
  129. static long get_nr_dentry_unused(void)
  130. {
  131. int i;
  132. long sum = 0;
  133. for_each_possible_cpu(i)
  134. sum += per_cpu(nr_dentry_unused, i);
  135. return sum < 0 ? 0 : sum;
  136. }
  137. int proc_nr_dentry(struct ctl_table *table, int write, void __user *buffer,
  138. size_t *lenp, loff_t *ppos)
  139. {
  140. dentry_stat.nr_dentry = get_nr_dentry();
  141. dentry_stat.nr_unused = get_nr_dentry_unused();
  142. return proc_doulongvec_minmax(table, write, buffer, lenp, ppos);
  143. }
  144. #endif
  145. /*
  146. * Compare 2 name strings, return 0 if they match, otherwise non-zero.
  147. * The strings are both count bytes long, and count is non-zero.
  148. */
  149. #ifdef CONFIG_DCACHE_WORD_ACCESS
  150. #include <asm/word-at-a-time.h>
  151. /*
  152. * NOTE! 'cs' and 'scount' come from a dentry, so it has a
  153. * aligned allocation for this particular component. We don't
  154. * strictly need the load_unaligned_zeropad() safety, but it
  155. * doesn't hurt either.
  156. *
  157. * In contrast, 'ct' and 'tcount' can be from a pathname, and do
  158. * need the careful unaligned handling.
  159. */
  160. static inline int dentry_string_cmp(const unsigned char *cs, const unsigned char *ct, unsigned tcount)
  161. {
  162. unsigned long a,b,mask;
  163. for (;;) {
  164. a = *(unsigned long *)cs;
  165. b = load_unaligned_zeropad(ct);
  166. if (tcount < sizeof(unsigned long))
  167. break;
  168. if (unlikely(a != b))
  169. return 1;
  170. cs += sizeof(unsigned long);
  171. ct += sizeof(unsigned long);
  172. tcount -= sizeof(unsigned long);
  173. if (!tcount)
  174. return 0;
  175. }
  176. mask = bytemask_from_count(tcount);
  177. return unlikely(!!((a ^ b) & mask));
  178. }
  179. #else
  180. static inline int dentry_string_cmp(const unsigned char *cs, const unsigned char *ct, unsigned tcount)
  181. {
  182. do {
  183. if (*cs != *ct)
  184. return 1;
  185. cs++;
  186. ct++;
  187. tcount--;
  188. } while (tcount);
  189. return 0;
  190. }
  191. #endif
  192. static inline int dentry_cmp(const struct dentry *dentry, const unsigned char *ct, unsigned tcount)
  193. {
  194. const unsigned char *cs;
  195. /*
  196. * Be careful about RCU walk racing with rename:
  197. * use ACCESS_ONCE to fetch the name pointer.
  198. *
  199. * NOTE! Even if a rename will mean that the length
  200. * was not loaded atomically, we don't care. The
  201. * RCU walk will check the sequence count eventually,
  202. * and catch it. And we won't overrun the buffer,
  203. * because we're reading the name pointer atomically,
  204. * and a dentry name is guaranteed to be properly
  205. * terminated with a NUL byte.
  206. *
  207. * End result: even if 'len' is wrong, we'll exit
  208. * early because the data cannot match (there can
  209. * be no NUL in the ct/tcount data)
  210. */
  211. cs = ACCESS_ONCE(dentry->d_name.name);
  212. smp_read_barrier_depends();
  213. return dentry_string_cmp(cs, ct, tcount);
  214. }
  215. struct external_name {
  216. union {
  217. atomic_t count;
  218. struct rcu_head head;
  219. } u;
  220. unsigned char name[];
  221. };
  222. static inline struct external_name *external_name(struct dentry *dentry)
  223. {
  224. return container_of(dentry->d_name.name, struct external_name, name[0]);
  225. }
  226. static void __d_free(struct rcu_head *head)
  227. {
  228. struct dentry *dentry = container_of(head, struct dentry, d_u.d_rcu);
  229. kmem_cache_free(dentry_cache, dentry);
  230. }
  231. static void __d_free_external(struct rcu_head *head)
  232. {
  233. struct dentry *dentry = container_of(head, struct dentry, d_u.d_rcu);
  234. kfree(external_name(dentry));
  235. kmem_cache_free(dentry_cache, dentry);
  236. }
  237. static inline int dname_external(const struct dentry *dentry)
  238. {
  239. return dentry->d_name.name != dentry->d_iname;
  240. }
  241. /*
  242. * Make sure other CPUs see the inode attached before the type is set.
  243. */
  244. static inline void __d_set_inode_and_type(struct dentry *dentry,
  245. struct inode *inode,
  246. unsigned type_flags)
  247. {
  248. unsigned flags;
  249. dentry->d_inode = inode;
  250. smp_wmb();
  251. flags = READ_ONCE(dentry->d_flags);
  252. flags &= ~(DCACHE_ENTRY_TYPE | DCACHE_FALLTHRU);
  253. flags |= type_flags;
  254. WRITE_ONCE(dentry->d_flags, flags);
  255. }
  256. /*
  257. * Ideally, we want to make sure that other CPUs see the flags cleared before
  258. * the inode is detached, but this is really a violation of RCU principles
  259. * since the ordering suggests we should always set inode before flags.
  260. *
  261. * We should instead replace or discard the entire dentry - but that sucks
  262. * performancewise on mass deletion/rename.
  263. */
  264. static inline void __d_clear_type_and_inode(struct dentry *dentry)
  265. {
  266. unsigned flags = READ_ONCE(dentry->d_flags);
  267. flags &= ~(DCACHE_ENTRY_TYPE | DCACHE_FALLTHRU);
  268. WRITE_ONCE(dentry->d_flags, flags);
  269. smp_wmb();
  270. dentry->d_inode = NULL;
  271. }
  272. static void dentry_free(struct dentry *dentry)
  273. {
  274. WARN_ON(!hlist_unhashed(&dentry->d_u.d_alias));
  275. if (unlikely(dname_external(dentry))) {
  276. struct external_name *p = external_name(dentry);
  277. if (likely(atomic_dec_and_test(&p->u.count))) {
  278. call_rcu(&dentry->d_u.d_rcu, __d_free_external);
  279. return;
  280. }
  281. }
  282. /* if dentry was never visible to RCU, immediate free is OK */
  283. if (!(dentry->d_flags & DCACHE_RCUACCESS))
  284. __d_free(&dentry->d_u.d_rcu);
  285. else
  286. call_rcu(&dentry->d_u.d_rcu, __d_free);
  287. }
  288. /**
  289. * dentry_rcuwalk_invalidate - invalidate in-progress rcu-walk lookups
  290. * @dentry: the target dentry
  291. * After this call, in-progress rcu-walk path lookup will fail. This
  292. * should be called after unhashing, and after changing d_inode (if
  293. * the dentry has not already been unhashed).
  294. */
  295. static inline void dentry_rcuwalk_invalidate(struct dentry *dentry)
  296. {
  297. lockdep_assert_held(&dentry->d_lock);
  298. /* Go through am invalidation barrier */
  299. write_seqcount_invalidate(&dentry->d_seq);
  300. }
  301. /*
  302. * Release the dentry's inode, using the filesystem
  303. * d_iput() operation if defined. Dentry has no refcount
  304. * and is unhashed.
  305. */
  306. static void dentry_iput(struct dentry * dentry)
  307. __releases(dentry->d_lock)
  308. __releases(dentry->d_inode->i_lock)
  309. {
  310. struct inode *inode = dentry->d_inode;
  311. if (inode) {
  312. __d_clear_type_and_inode(dentry);
  313. hlist_del_init(&dentry->d_u.d_alias);
  314. spin_unlock(&dentry->d_lock);
  315. spin_unlock(&inode->i_lock);
  316. if (!inode->i_nlink)
  317. fsnotify_inoderemove(inode);
  318. if (dentry->d_op && dentry->d_op->d_iput)
  319. dentry->d_op->d_iput(dentry, inode);
  320. else
  321. iput(inode);
  322. } else {
  323. spin_unlock(&dentry->d_lock);
  324. }
  325. }
  326. /*
  327. * Release the dentry's inode, using the filesystem
  328. * d_iput() operation if defined. dentry remains in-use.
  329. */
  330. static void dentry_unlink_inode(struct dentry * dentry)
  331. __releases(dentry->d_lock)
  332. __releases(dentry->d_inode->i_lock)
  333. {
  334. struct inode *inode = dentry->d_inode;
  335. __d_clear_type_and_inode(dentry);
  336. hlist_del_init(&dentry->d_u.d_alias);
  337. dentry_rcuwalk_invalidate(dentry);
  338. spin_unlock(&dentry->d_lock);
  339. spin_unlock(&inode->i_lock);
  340. if (!inode->i_nlink)
  341. fsnotify_inoderemove(inode);
  342. if (dentry->d_op && dentry->d_op->d_iput)
  343. dentry->d_op->d_iput(dentry, inode);
  344. else
  345. iput(inode);
  346. }
  347. /*
  348. * The DCACHE_LRU_LIST bit is set whenever the 'd_lru' entry
  349. * is in use - which includes both the "real" per-superblock
  350. * LRU list _and_ the DCACHE_SHRINK_LIST use.
  351. *
  352. * The DCACHE_SHRINK_LIST bit is set whenever the dentry is
  353. * on the shrink list (ie not on the superblock LRU list).
  354. *
  355. * The per-cpu "nr_dentry_unused" counters are updated with
  356. * the DCACHE_LRU_LIST bit.
  357. *
  358. * These helper functions make sure we always follow the
  359. * rules. d_lock must be held by the caller.
  360. */
  361. #define D_FLAG_VERIFY(dentry,x) WARN_ON_ONCE(((dentry)->d_flags & (DCACHE_LRU_LIST | DCACHE_SHRINK_LIST)) != (x))
  362. static void d_lru_add(struct dentry *dentry)
  363. {
  364. D_FLAG_VERIFY(dentry, 0);
  365. dentry->d_flags |= DCACHE_LRU_LIST;
  366. this_cpu_inc(nr_dentry_unused);
  367. WARN_ON_ONCE(!list_lru_add(&dentry->d_sb->s_dentry_lru, &dentry->d_lru));
  368. }
  369. static void d_lru_del(struct dentry *dentry)
  370. {
  371. D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
  372. dentry->d_flags &= ~DCACHE_LRU_LIST;
  373. this_cpu_dec(nr_dentry_unused);
  374. WARN_ON_ONCE(!list_lru_del(&dentry->d_sb->s_dentry_lru, &dentry->d_lru));
  375. }
  376. static void d_shrink_del(struct dentry *dentry)
  377. {
  378. D_FLAG_VERIFY(dentry, DCACHE_SHRINK_LIST | DCACHE_LRU_LIST);
  379. list_del_init(&dentry->d_lru);
  380. dentry->d_flags &= ~(DCACHE_SHRINK_LIST | DCACHE_LRU_LIST);
  381. this_cpu_dec(nr_dentry_unused);
  382. }
  383. static void d_shrink_add(struct dentry *dentry, struct list_head *list)
  384. {
  385. D_FLAG_VERIFY(dentry, 0);
  386. list_add(&dentry->d_lru, list);
  387. dentry->d_flags |= DCACHE_SHRINK_LIST | DCACHE_LRU_LIST;
  388. this_cpu_inc(nr_dentry_unused);
  389. }
  390. /*
  391. * These can only be called under the global LRU lock, ie during the
  392. * callback for freeing the LRU list. "isolate" removes it from the
  393. * LRU lists entirely, while shrink_move moves it to the indicated
  394. * private list.
  395. */
  396. static void d_lru_isolate(struct list_lru_one *lru, struct dentry *dentry)
  397. {
  398. D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
  399. dentry->d_flags &= ~DCACHE_LRU_LIST;
  400. this_cpu_dec(nr_dentry_unused);
  401. list_lru_isolate(lru, &dentry->d_lru);
  402. }
  403. static void d_lru_shrink_move(struct list_lru_one *lru, struct dentry *dentry,
  404. struct list_head *list)
  405. {
  406. D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
  407. dentry->d_flags |= DCACHE_SHRINK_LIST;
  408. list_lru_isolate_move(lru, &dentry->d_lru, list);
  409. }
  410. /*
  411. * dentry_lru_(add|del)_list) must be called with d_lock held.
  412. */
  413. static void dentry_lru_add(struct dentry *dentry)
  414. {
  415. if (unlikely(!(dentry->d_flags & DCACHE_LRU_LIST)))
  416. d_lru_add(dentry);
  417. }
  418. /**
  419. * d_drop - drop a dentry
  420. * @dentry: dentry to drop
  421. *
  422. * d_drop() unhashes the entry from the parent dentry hashes, so that it won't
  423. * be found through a VFS lookup any more. Note that this is different from
  424. * deleting the dentry - d_delete will try to mark the dentry negative if
  425. * possible, giving a successful _negative_ lookup, while d_drop will
  426. * just make the cache lookup fail.
  427. *
  428. * d_drop() is used mainly for stuff that wants to invalidate a dentry for some
  429. * reason (NFS timeouts or autofs deletes).
  430. *
  431. * __d_drop requires dentry->d_lock.
  432. */
  433. void __d_drop(struct dentry *dentry)
  434. {
  435. if (!d_unhashed(dentry)) {
  436. struct hlist_bl_head *b;
  437. /*
  438. * Hashed dentries are normally on the dentry hashtable,
  439. * with the exception of those newly allocated by
  440. * d_obtain_alias, which are always IS_ROOT:
  441. */
  442. if (unlikely(IS_ROOT(dentry)))
  443. b = &dentry->d_sb->s_anon;
  444. else
  445. b = d_hash(dentry->d_parent, dentry->d_name.hash);
  446. hlist_bl_lock(b);
  447. __hlist_bl_del(&dentry->d_hash);
  448. dentry->d_hash.pprev = NULL;
  449. hlist_bl_unlock(b);
  450. dentry_rcuwalk_invalidate(dentry);
  451. }
  452. }
  453. EXPORT_SYMBOL(__d_drop);
  454. void d_drop(struct dentry *dentry)
  455. {
  456. spin_lock(&dentry->d_lock);
  457. __d_drop(dentry);
  458. spin_unlock(&dentry->d_lock);
  459. }
  460. EXPORT_SYMBOL(d_drop);
  461. static void __dentry_kill(struct dentry *dentry)
  462. {
  463. struct dentry *parent = NULL;
  464. bool can_free = true;
  465. if (!IS_ROOT(dentry))
  466. parent = dentry->d_parent;
  467. /*
  468. * The dentry is now unrecoverably dead to the world.
  469. */
  470. lockref_mark_dead(&dentry->d_lockref);
  471. /*
  472. * inform the fs via d_prune that this dentry is about to be
  473. * unhashed and destroyed.
  474. */
  475. if (dentry->d_flags & DCACHE_OP_PRUNE)
  476. dentry->d_op->d_prune(dentry);
  477. if (dentry->d_flags & DCACHE_LRU_LIST) {
  478. if (!(dentry->d_flags & DCACHE_SHRINK_LIST))
  479. d_lru_del(dentry);
  480. }
  481. /* if it was on the hash then remove it */
  482. __d_drop(dentry);
  483. __list_del_entry(&dentry->d_child);
  484. /*
  485. * Inform d_walk() that we are no longer attached to the
  486. * dentry tree
  487. */
  488. dentry->d_flags |= DCACHE_DENTRY_KILLED;
  489. if (parent)
  490. spin_unlock(&parent->d_lock);
  491. dentry_iput(dentry);
  492. /*
  493. * dentry_iput drops the locks, at which point nobody (except
  494. * transient RCU lookups) can reach this dentry.
  495. */
  496. BUG_ON(dentry->d_lockref.count > 0);
  497. this_cpu_dec(nr_dentry);
  498. if (dentry->d_op && dentry->d_op->d_release)
  499. dentry->d_op->d_release(dentry);
  500. spin_lock(&dentry->d_lock);
  501. if (dentry->d_flags & DCACHE_SHRINK_LIST) {
  502. dentry->d_flags |= DCACHE_MAY_FREE;
  503. can_free = false;
  504. }
  505. spin_unlock(&dentry->d_lock);
  506. if (likely(can_free))
  507. dentry_free(dentry);
  508. }
  509. /*
  510. * Finish off a dentry we've decided to kill.
  511. * dentry->d_lock must be held, returns with it unlocked.
  512. * If ref is non-zero, then decrement the refcount too.
  513. * Returns dentry requiring refcount drop, or NULL if we're done.
  514. */
  515. static struct dentry *dentry_kill(struct dentry *dentry)
  516. __releases(dentry->d_lock)
  517. {
  518. struct inode *inode = dentry->d_inode;
  519. struct dentry *parent = NULL;
  520. if (inode && unlikely(!spin_trylock(&inode->i_lock)))
  521. goto failed;
  522. if (!IS_ROOT(dentry)) {
  523. parent = dentry->d_parent;
  524. if (unlikely(!spin_trylock(&parent->d_lock))) {
  525. if (inode)
  526. spin_unlock(&inode->i_lock);
  527. goto failed;
  528. }
  529. }
  530. __dentry_kill(dentry);
  531. return parent;
  532. failed:
  533. spin_unlock(&dentry->d_lock);
  534. cpu_relax();
  535. return dentry; /* try again with same dentry */
  536. }
  537. static inline struct dentry *lock_parent(struct dentry *dentry)
  538. {
  539. struct dentry *parent = dentry->d_parent;
  540. if (IS_ROOT(dentry))
  541. return NULL;
  542. if (unlikely(dentry->d_lockref.count < 0))
  543. return NULL;
  544. if (likely(spin_trylock(&parent->d_lock)))
  545. return parent;
  546. rcu_read_lock();
  547. spin_unlock(&dentry->d_lock);
  548. again:
  549. parent = ACCESS_ONCE(dentry->d_parent);
  550. spin_lock(&parent->d_lock);
  551. /*
  552. * We can't blindly lock dentry until we are sure
  553. * that we won't violate the locking order.
  554. * Any changes of dentry->d_parent must have
  555. * been done with parent->d_lock held, so
  556. * spin_lock() above is enough of a barrier
  557. * for checking if it's still our child.
  558. */
  559. if (unlikely(parent != dentry->d_parent)) {
  560. spin_unlock(&parent->d_lock);
  561. goto again;
  562. }
  563. rcu_read_unlock();
  564. if (parent != dentry)
  565. spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
  566. else
  567. parent = NULL;
  568. return parent;
  569. }
  570. /*
  571. * Try to do a lockless dput(), and return whether that was successful.
  572. *
  573. * If unsuccessful, we return false, having already taken the dentry lock.
  574. *
  575. * The caller needs to hold the RCU read lock, so that the dentry is
  576. * guaranteed to stay around even if the refcount goes down to zero!
  577. */
  578. static inline bool fast_dput(struct dentry *dentry)
  579. {
  580. int ret;
  581. unsigned int d_flags;
  582. /*
  583. * If we have a d_op->d_delete() operation, we sould not
  584. * let the dentry count go to zero, so use "put__or_lock".
  585. */
  586. if (unlikely(dentry->d_flags & DCACHE_OP_DELETE))
  587. return lockref_put_or_lock(&dentry->d_lockref);
  588. /*
  589. * .. otherwise, we can try to just decrement the
  590. * lockref optimistically.
  591. */
  592. ret = lockref_put_return(&dentry->d_lockref);
  593. /*
  594. * If the lockref_put_return() failed due to the lock being held
  595. * by somebody else, the fast path has failed. We will need to
  596. * get the lock, and then check the count again.
  597. */
  598. if (unlikely(ret < 0)) {
  599. spin_lock(&dentry->d_lock);
  600. if (dentry->d_lockref.count > 1) {
  601. dentry->d_lockref.count--;
  602. spin_unlock(&dentry->d_lock);
  603. return 1;
  604. }
  605. return 0;
  606. }
  607. /*
  608. * If we weren't the last ref, we're done.
  609. */
  610. if (ret)
  611. return 1;
  612. /*
  613. * Careful, careful. The reference count went down
  614. * to zero, but we don't hold the dentry lock, so
  615. * somebody else could get it again, and do another
  616. * dput(), and we need to not race with that.
  617. *
  618. * However, there is a very special and common case
  619. * where we don't care, because there is nothing to
  620. * do: the dentry is still hashed, it does not have
  621. * a 'delete' op, and it's referenced and already on
  622. * the LRU list.
  623. *
  624. * NOTE! Since we aren't locked, these values are
  625. * not "stable". However, it is sufficient that at
  626. * some point after we dropped the reference the
  627. * dentry was hashed and the flags had the proper
  628. * value. Other dentry users may have re-gotten
  629. * a reference to the dentry and change that, but
  630. * our work is done - we can leave the dentry
  631. * around with a zero refcount.
  632. */
  633. smp_rmb();
  634. d_flags = ACCESS_ONCE(dentry->d_flags);
  635. d_flags &= DCACHE_REFERENCED | DCACHE_LRU_LIST;
  636. /* Nothing to do? Dropping the reference was all we needed? */
  637. if (d_flags == (DCACHE_REFERENCED | DCACHE_LRU_LIST) && !d_unhashed(dentry))
  638. return 1;
  639. /*
  640. * Not the fast normal case? Get the lock. We've already decremented
  641. * the refcount, but we'll need to re-check the situation after
  642. * getting the lock.
  643. */
  644. spin_lock(&dentry->d_lock);
  645. /*
  646. * Did somebody else grab a reference to it in the meantime, and
  647. * we're no longer the last user after all? Alternatively, somebody
  648. * else could have killed it and marked it dead. Either way, we
  649. * don't need to do anything else.
  650. */
  651. if (dentry->d_lockref.count) {
  652. spin_unlock(&dentry->d_lock);
  653. return 1;
  654. }
  655. /*
  656. * Re-get the reference we optimistically dropped. We hold the
  657. * lock, and we just tested that it was zero, so we can just
  658. * set it to 1.
  659. */
  660. dentry->d_lockref.count = 1;
  661. return 0;
  662. }
  663. /*
  664. * This is dput
  665. *
  666. * This is complicated by the fact that we do not want to put
  667. * dentries that are no longer on any hash chain on the unused
  668. * list: we'd much rather just get rid of them immediately.
  669. *
  670. * However, that implies that we have to traverse the dentry
  671. * tree upwards to the parents which might _also_ now be
  672. * scheduled for deletion (it may have been only waiting for
  673. * its last child to go away).
  674. *
  675. * This tail recursion is done by hand as we don't want to depend
  676. * on the compiler to always get this right (gcc generally doesn't).
  677. * Real recursion would eat up our stack space.
  678. */
  679. /*
  680. * dput - release a dentry
  681. * @dentry: dentry to release
  682. *
  683. * Release a dentry. This will drop the usage count and if appropriate
  684. * call the dentry unlink method as well as removing it from the queues and
  685. * releasing its resources. If the parent dentries were scheduled for release
  686. * they too may now get deleted.
  687. */
  688. void dput(struct dentry *dentry)
  689. {
  690. if (unlikely(!dentry))
  691. return;
  692. repeat:
  693. rcu_read_lock();
  694. if (likely(fast_dput(dentry))) {
  695. rcu_read_unlock();
  696. return;
  697. }
  698. /* Slow case: now with the dentry lock held */
  699. rcu_read_unlock();
  700. /* Unreachable? Get rid of it */
  701. if (unlikely(d_unhashed(dentry)))
  702. goto kill_it;
  703. if (unlikely(dentry->d_flags & DCACHE_OP_DELETE)) {
  704. if (dentry->d_op->d_delete(dentry))
  705. goto kill_it;
  706. }
  707. if (!(dentry->d_flags & DCACHE_REFERENCED))
  708. dentry->d_flags |= DCACHE_REFERENCED;
  709. dentry_lru_add(dentry);
  710. dentry->d_lockref.count--;
  711. spin_unlock(&dentry->d_lock);
  712. return;
  713. kill_it:
  714. dentry = dentry_kill(dentry);
  715. if (dentry)
  716. goto repeat;
  717. }
  718. EXPORT_SYMBOL(dput);
  719. /* This must be called with d_lock held */
  720. static inline void __dget_dlock(struct dentry *dentry)
  721. {
  722. dentry->d_lockref.count++;
  723. }
  724. static inline void __dget(struct dentry *dentry)
  725. {
  726. lockref_get(&dentry->d_lockref);
  727. }
  728. struct dentry *dget_parent(struct dentry *dentry)
  729. {
  730. int gotref;
  731. struct dentry *ret;
  732. /*
  733. * Do optimistic parent lookup without any
  734. * locking.
  735. */
  736. rcu_read_lock();
  737. ret = ACCESS_ONCE(dentry->d_parent);
  738. gotref = lockref_get_not_zero(&ret->d_lockref);
  739. rcu_read_unlock();
  740. if (likely(gotref)) {
  741. if (likely(ret == ACCESS_ONCE(dentry->d_parent)))
  742. return ret;
  743. dput(ret);
  744. }
  745. repeat:
  746. /*
  747. * Don't need rcu_dereference because we re-check it was correct under
  748. * the lock.
  749. */
  750. rcu_read_lock();
  751. ret = dentry->d_parent;
  752. spin_lock(&ret->d_lock);
  753. if (unlikely(ret != dentry->d_parent)) {
  754. spin_unlock(&ret->d_lock);
  755. rcu_read_unlock();
  756. goto repeat;
  757. }
  758. rcu_read_unlock();
  759. BUG_ON(!ret->d_lockref.count);
  760. ret->d_lockref.count++;
  761. spin_unlock(&ret->d_lock);
  762. return ret;
  763. }
  764. EXPORT_SYMBOL(dget_parent);
  765. /**
  766. * d_find_alias - grab a hashed alias of inode
  767. * @inode: inode in question
  768. *
  769. * If inode has a hashed alias, or is a directory and has any alias,
  770. * acquire the reference to alias and return it. Otherwise return NULL.
  771. * Notice that if inode is a directory there can be only one alias and
  772. * it can be unhashed only if it has no children, or if it is the root
  773. * of a filesystem, or if the directory was renamed and d_revalidate
  774. * was the first vfs operation to notice.
  775. *
  776. * If the inode has an IS_ROOT, DCACHE_DISCONNECTED alias, then prefer
  777. * any other hashed alias over that one.
  778. */
  779. static struct dentry *__d_find_alias(struct inode *inode)
  780. {
  781. struct dentry *alias, *discon_alias;
  782. again:
  783. discon_alias = NULL;
  784. hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
  785. spin_lock(&alias->d_lock);
  786. if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
  787. if (IS_ROOT(alias) &&
  788. (alias->d_flags & DCACHE_DISCONNECTED)) {
  789. discon_alias = alias;
  790. } else {
  791. __dget_dlock(alias);
  792. spin_unlock(&alias->d_lock);
  793. return alias;
  794. }
  795. }
  796. spin_unlock(&alias->d_lock);
  797. }
  798. if (discon_alias) {
  799. alias = discon_alias;
  800. spin_lock(&alias->d_lock);
  801. if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
  802. __dget_dlock(alias);
  803. spin_unlock(&alias->d_lock);
  804. return alias;
  805. }
  806. spin_unlock(&alias->d_lock);
  807. goto again;
  808. }
  809. return NULL;
  810. }
  811. struct dentry *d_find_alias(struct inode *inode)
  812. {
  813. struct dentry *de = NULL;
  814. if (!hlist_empty(&inode->i_dentry)) {
  815. spin_lock(&inode->i_lock);
  816. de = __d_find_alias(inode);
  817. spin_unlock(&inode->i_lock);
  818. }
  819. return de;
  820. }
  821. EXPORT_SYMBOL(d_find_alias);
  822. /*
  823. * Try to kill dentries associated with this inode.
  824. * WARNING: you must own a reference to inode.
  825. */
  826. void d_prune_aliases(struct inode *inode)
  827. {
  828. struct dentry *dentry;
  829. restart:
  830. spin_lock(&inode->i_lock);
  831. hlist_for_each_entry(dentry, &inode->i_dentry, d_u.d_alias) {
  832. spin_lock(&dentry->d_lock);
  833. if (!dentry->d_lockref.count) {
  834. struct dentry *parent = lock_parent(dentry);
  835. if (likely(!dentry->d_lockref.count)) {
  836. __dentry_kill(dentry);
  837. dput(parent);
  838. goto restart;
  839. }
  840. if (parent)
  841. spin_unlock(&parent->d_lock);
  842. }
  843. spin_unlock(&dentry->d_lock);
  844. }
  845. spin_unlock(&inode->i_lock);
  846. }
  847. EXPORT_SYMBOL(d_prune_aliases);
  848. static void shrink_dentry_list(struct list_head *list)
  849. {
  850. struct dentry *dentry, *parent;
  851. while (!list_empty(list)) {
  852. struct inode *inode;
  853. dentry = list_entry(list->prev, struct dentry, d_lru);
  854. spin_lock(&dentry->d_lock);
  855. parent = lock_parent(dentry);
  856. /*
  857. * The dispose list is isolated and dentries are not accounted
  858. * to the LRU here, so we can simply remove it from the list
  859. * here regardless of whether it is referenced or not.
  860. */
  861. d_shrink_del(dentry);
  862. /*
  863. * We found an inuse dentry which was not removed from
  864. * the LRU because of laziness during lookup. Do not free it.
  865. */
  866. if (dentry->d_lockref.count > 0) {
  867. spin_unlock(&dentry->d_lock);
  868. if (parent)
  869. spin_unlock(&parent->d_lock);
  870. continue;
  871. }
  872. if (unlikely(dentry->d_flags & DCACHE_DENTRY_KILLED)) {
  873. bool can_free = dentry->d_flags & DCACHE_MAY_FREE;
  874. spin_unlock(&dentry->d_lock);
  875. if (parent)
  876. spin_unlock(&parent->d_lock);
  877. if (can_free)
  878. dentry_free(dentry);
  879. continue;
  880. }
  881. inode = dentry->d_inode;
  882. if (inode && unlikely(!spin_trylock(&inode->i_lock))) {
  883. d_shrink_add(dentry, list);
  884. spin_unlock(&dentry->d_lock);
  885. if (parent)
  886. spin_unlock(&parent->d_lock);
  887. continue;
  888. }
  889. __dentry_kill(dentry);
  890. /*
  891. * We need to prune ancestors too. This is necessary to prevent
  892. * quadratic behavior of shrink_dcache_parent(), but is also
  893. * expected to be beneficial in reducing dentry cache
  894. * fragmentation.
  895. */
  896. dentry = parent;
  897. while (dentry && !lockref_put_or_lock(&dentry->d_lockref)) {
  898. parent = lock_parent(dentry);
  899. if (dentry->d_lockref.count != 1) {
  900. dentry->d_lockref.count--;
  901. spin_unlock(&dentry->d_lock);
  902. if (parent)
  903. spin_unlock(&parent->d_lock);
  904. break;
  905. }
  906. inode = dentry->d_inode; /* can't be NULL */
  907. if (unlikely(!spin_trylock(&inode->i_lock))) {
  908. spin_unlock(&dentry->d_lock);
  909. if (parent)
  910. spin_unlock(&parent->d_lock);
  911. cpu_relax();
  912. continue;
  913. }
  914. __dentry_kill(dentry);
  915. dentry = parent;
  916. }
  917. }
  918. }
  919. static enum lru_status dentry_lru_isolate(struct list_head *item,
  920. struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
  921. {
  922. struct list_head *freeable = arg;
  923. struct dentry *dentry = container_of(item, struct dentry, d_lru);
  924. /*
  925. * we are inverting the lru lock/dentry->d_lock here,
  926. * so use a trylock. If we fail to get the lock, just skip
  927. * it
  928. */
  929. if (!spin_trylock(&dentry->d_lock))
  930. return LRU_SKIP;
  931. /*
  932. * Referenced dentries are still in use. If they have active
  933. * counts, just remove them from the LRU. Otherwise give them
  934. * another pass through the LRU.
  935. */
  936. if (dentry->d_lockref.count) {
  937. d_lru_isolate(lru, dentry);
  938. spin_unlock(&dentry->d_lock);
  939. return LRU_REMOVED;
  940. }
  941. if (dentry->d_flags & DCACHE_REFERENCED) {
  942. dentry->d_flags &= ~DCACHE_REFERENCED;
  943. spin_unlock(&dentry->d_lock);
  944. /*
  945. * The list move itself will be made by the common LRU code. At
  946. * this point, we've dropped the dentry->d_lock but keep the
  947. * lru lock. This is safe to do, since every list movement is
  948. * protected by the lru lock even if both locks are held.
  949. *
  950. * This is guaranteed by the fact that all LRU management
  951. * functions are intermediated by the LRU API calls like
  952. * list_lru_add and list_lru_del. List movement in this file
  953. * only ever occur through this functions or through callbacks
  954. * like this one, that are called from the LRU API.
  955. *
  956. * The only exceptions to this are functions like
  957. * shrink_dentry_list, and code that first checks for the
  958. * DCACHE_SHRINK_LIST flag. Those are guaranteed to be
  959. * operating only with stack provided lists after they are
  960. * properly isolated from the main list. It is thus, always a
  961. * local access.
  962. */
  963. return LRU_ROTATE;
  964. }
  965. d_lru_shrink_move(lru, dentry, freeable);
  966. spin_unlock(&dentry->d_lock);
  967. return LRU_REMOVED;
  968. }
  969. /**
  970. * prune_dcache_sb - shrink the dcache
  971. * @sb: superblock
  972. * @sc: shrink control, passed to list_lru_shrink_walk()
  973. *
  974. * Attempt to shrink the superblock dcache LRU by @sc->nr_to_scan entries. This
  975. * is done when we need more memory and called from the superblock shrinker
  976. * function.
  977. *
  978. * This function may fail to free any resources if all the dentries are in
  979. * use.
  980. */
  981. long prune_dcache_sb(struct super_block *sb, struct shrink_control *sc)
  982. {
  983. LIST_HEAD(dispose);
  984. long freed;
  985. freed = list_lru_shrink_walk(&sb->s_dentry_lru, sc,
  986. dentry_lru_isolate, &dispose);
  987. shrink_dentry_list(&dispose);
  988. return freed;
  989. }
  990. static enum lru_status dentry_lru_isolate_shrink(struct list_head *item,
  991. struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
  992. {
  993. struct list_head *freeable = arg;
  994. struct dentry *dentry = container_of(item, struct dentry, d_lru);
  995. /*
  996. * we are inverting the lru lock/dentry->d_lock here,
  997. * so use a trylock. If we fail to get the lock, just skip
  998. * it
  999. */
  1000. if (!spin_trylock(&dentry->d_lock))
  1001. return LRU_SKIP;
  1002. d_lru_shrink_move(lru, dentry, freeable);
  1003. spin_unlock(&dentry->d_lock);
  1004. return LRU_REMOVED;
  1005. }
  1006. /**
  1007. * shrink_dcache_sb - shrink dcache for a superblock
  1008. * @sb: superblock
  1009. *
  1010. * Shrink the dcache for the specified super block. This is used to free
  1011. * the dcache before unmounting a file system.
  1012. */
  1013. void shrink_dcache_sb(struct super_block *sb)
  1014. {
  1015. long freed;
  1016. do {
  1017. LIST_HEAD(dispose);
  1018. freed = list_lru_walk(&sb->s_dentry_lru,
  1019. dentry_lru_isolate_shrink, &dispose, UINT_MAX);
  1020. this_cpu_sub(nr_dentry_unused, freed);
  1021. shrink_dentry_list(&dispose);
  1022. } while (freed > 0);
  1023. }
  1024. EXPORT_SYMBOL(shrink_dcache_sb);
  1025. /**
  1026. * enum d_walk_ret - action to talke during tree walk
  1027. * @D_WALK_CONTINUE: contrinue walk
  1028. * @D_WALK_QUIT: quit walk
  1029. * @D_WALK_NORETRY: quit when retry is needed
  1030. * @D_WALK_SKIP: skip this dentry and its children
  1031. */
  1032. enum d_walk_ret {
  1033. D_WALK_CONTINUE,
  1034. D_WALK_QUIT,
  1035. D_WALK_NORETRY,
  1036. D_WALK_SKIP,
  1037. };
  1038. /**
  1039. * d_walk - walk the dentry tree
  1040. * @parent: start of walk
  1041. * @data: data passed to @enter() and @finish()
  1042. * @enter: callback when first entering the dentry
  1043. * @finish: callback when successfully finished the walk
  1044. *
  1045. * The @enter() and @finish() callbacks are called with d_lock held.
  1046. */
  1047. static void d_walk(struct dentry *parent, void *data,
  1048. enum d_walk_ret (*enter)(void *, struct dentry *),
  1049. void (*finish)(void *))
  1050. {
  1051. struct dentry *this_parent;
  1052. struct list_head *next;
  1053. unsigned seq = 0;
  1054. enum d_walk_ret ret;
  1055. bool retry = true;
  1056. again:
  1057. read_seqbegin_or_lock(&rename_lock, &seq);
  1058. this_parent = parent;
  1059. spin_lock(&this_parent->d_lock);
  1060. ret = enter(data, this_parent);
  1061. switch (ret) {
  1062. case D_WALK_CONTINUE:
  1063. break;
  1064. case D_WALK_QUIT:
  1065. case D_WALK_SKIP:
  1066. goto out_unlock;
  1067. case D_WALK_NORETRY:
  1068. retry = false;
  1069. break;
  1070. }
  1071. repeat:
  1072. next = this_parent->d_subdirs.next;
  1073. resume:
  1074. while (next != &this_parent->d_subdirs) {
  1075. struct list_head *tmp = next;
  1076. struct dentry *dentry = list_entry(tmp, struct dentry, d_child);
  1077. next = tmp->next;
  1078. spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
  1079. ret = enter(data, dentry);
  1080. switch (ret) {
  1081. case D_WALK_CONTINUE:
  1082. break;
  1083. case D_WALK_QUIT:
  1084. spin_unlock(&dentry->d_lock);
  1085. goto out_unlock;
  1086. case D_WALK_NORETRY:
  1087. retry = false;
  1088. break;
  1089. case D_WALK_SKIP:
  1090. spin_unlock(&dentry->d_lock);
  1091. continue;
  1092. }
  1093. if (!list_empty(&dentry->d_subdirs)) {
  1094. spin_unlock(&this_parent->d_lock);
  1095. spin_release(&dentry->d_lock.dep_map, 1, _RET_IP_);
  1096. this_parent = dentry;
  1097. spin_acquire(&this_parent->d_lock.dep_map, 0, 1, _RET_IP_);
  1098. goto repeat;
  1099. }
  1100. spin_unlock(&dentry->d_lock);
  1101. }
  1102. /*
  1103. * All done at this level ... ascend and resume the search.
  1104. */
  1105. rcu_read_lock();
  1106. ascend:
  1107. if (this_parent != parent) {
  1108. struct dentry *child = this_parent;
  1109. this_parent = child->d_parent;
  1110. spin_unlock(&child->d_lock);
  1111. spin_lock(&this_parent->d_lock);
  1112. /* might go back up the wrong parent if we have had a rename. */
  1113. if (need_seqretry(&rename_lock, seq))
  1114. goto rename_retry;
  1115. /* go into the first sibling still alive */
  1116. do {
  1117. next = child->d_child.next;
  1118. if (next == &this_parent->d_subdirs)
  1119. goto ascend;
  1120. child = list_entry(next, struct dentry, d_child);
  1121. } while (unlikely(child->d_flags & DCACHE_DENTRY_KILLED));
  1122. rcu_read_unlock();
  1123. goto resume;
  1124. }
  1125. if (need_seqretry(&rename_lock, seq))
  1126. goto rename_retry;
  1127. rcu_read_unlock();
  1128. if (finish)
  1129. finish(data);
  1130. out_unlock:
  1131. spin_unlock(&this_parent->d_lock);
  1132. done_seqretry(&rename_lock, seq);
  1133. return;
  1134. rename_retry:
  1135. spin_unlock(&this_parent->d_lock);
  1136. rcu_read_unlock();
  1137. BUG_ON(seq & 1);
  1138. if (!retry)
  1139. return;
  1140. seq = 1;
  1141. goto again;
  1142. }
  1143. /*
  1144. * Search for at least 1 mount point in the dentry's subdirs.
  1145. * We descend to the next level whenever the d_subdirs
  1146. * list is non-empty and continue searching.
  1147. */
  1148. static enum d_walk_ret check_mount(void *data, struct dentry *dentry)
  1149. {
  1150. int *ret = data;
  1151. if (d_mountpoint(dentry)) {
  1152. *ret = 1;
  1153. return D_WALK_QUIT;
  1154. }
  1155. return D_WALK_CONTINUE;
  1156. }
  1157. /**
  1158. * have_submounts - check for mounts over a dentry
  1159. * @parent: dentry to check.
  1160. *
  1161. * Return true if the parent or its subdirectories contain
  1162. * a mount point
  1163. */
  1164. int have_submounts(struct dentry *parent)
  1165. {
  1166. int ret = 0;
  1167. d_walk(parent, &ret, check_mount, NULL);
  1168. return ret;
  1169. }
  1170. EXPORT_SYMBOL(have_submounts);
  1171. /*
  1172. * Called by mount code to set a mountpoint and check if the mountpoint is
  1173. * reachable (e.g. NFS can unhash a directory dentry and then the complete
  1174. * subtree can become unreachable).
  1175. *
  1176. * Only one of d_invalidate() and d_set_mounted() must succeed. For
  1177. * this reason take rename_lock and d_lock on dentry and ancestors.
  1178. */
  1179. int d_set_mounted(struct dentry *dentry)
  1180. {
  1181. struct dentry *p;
  1182. int ret = -ENOENT;
  1183. write_seqlock(&rename_lock);
  1184. for (p = dentry->d_parent; !IS_ROOT(p); p = p->d_parent) {
  1185. /* Need exclusion wrt. d_invalidate() */
  1186. spin_lock(&p->d_lock);
  1187. if (unlikely(d_unhashed(p))) {
  1188. spin_unlock(&p->d_lock);
  1189. goto out;
  1190. }
  1191. spin_unlock(&p->d_lock);
  1192. }
  1193. spin_lock(&dentry->d_lock);
  1194. if (!d_unlinked(dentry)) {
  1195. dentry->d_flags |= DCACHE_MOUNTED;
  1196. ret = 0;
  1197. }
  1198. spin_unlock(&dentry->d_lock);
  1199. out:
  1200. write_sequnlock(&rename_lock);
  1201. return ret;
  1202. }
  1203. /*
  1204. * Search the dentry child list of the specified parent,
  1205. * and move any unused dentries to the end of the unused
  1206. * list for prune_dcache(). We descend to the next level
  1207. * whenever the d_subdirs list is non-empty and continue
  1208. * searching.
  1209. *
  1210. * It returns zero iff there are no unused children,
  1211. * otherwise it returns the number of children moved to
  1212. * the end of the unused list. This may not be the total
  1213. * number of unused children, because select_parent can
  1214. * drop the lock and return early due to latency
  1215. * constraints.
  1216. */
  1217. struct select_data {
  1218. struct dentry *start;
  1219. struct list_head dispose;
  1220. int found;
  1221. };
  1222. static enum d_walk_ret select_collect(void *_data, struct dentry *dentry)
  1223. {
  1224. struct select_data *data = _data;
  1225. enum d_walk_ret ret = D_WALK_CONTINUE;
  1226. if (data->start == dentry)
  1227. goto out;
  1228. if (dentry->d_flags & DCACHE_SHRINK_LIST) {
  1229. data->found++;
  1230. } else {
  1231. if (dentry->d_flags & DCACHE_LRU_LIST)
  1232. d_lru_del(dentry);
  1233. if (!dentry->d_lockref.count) {
  1234. d_shrink_add(dentry, &data->dispose);
  1235. data->found++;
  1236. }
  1237. }
  1238. /*
  1239. * We can return to the caller if we have found some (this
  1240. * ensures forward progress). We'll be coming back to find
  1241. * the rest.
  1242. */
  1243. if (!list_empty(&data->dispose))
  1244. ret = need_resched() ? D_WALK_QUIT : D_WALK_NORETRY;
  1245. out:
  1246. return ret;
  1247. }
  1248. /**
  1249. * shrink_dcache_parent - prune dcache
  1250. * @parent: parent of entries to prune
  1251. *
  1252. * Prune the dcache to remove unused children of the parent dentry.
  1253. */
  1254. void shrink_dcache_parent(struct dentry *parent)
  1255. {
  1256. for (;;) {
  1257. struct select_data data;
  1258. INIT_LIST_HEAD(&data.dispose);
  1259. data.start = parent;
  1260. data.found = 0;
  1261. d_walk(parent, &data, select_collect, NULL);
  1262. if (!data.found)
  1263. break;
  1264. shrink_dentry_list(&data.dispose);
  1265. cond_resched();
  1266. }
  1267. }
  1268. EXPORT_SYMBOL(shrink_dcache_parent);
  1269. static enum d_walk_ret umount_check(void *_data, struct dentry *dentry)
  1270. {
  1271. /* it has busy descendents; complain about those instead */
  1272. if (!list_empty(&dentry->d_subdirs))
  1273. return D_WALK_CONTINUE;
  1274. /* root with refcount 1 is fine */
  1275. if (dentry == _data && dentry->d_lockref.count == 1)
  1276. return D_WALK_CONTINUE;
  1277. printk(KERN_ERR "BUG: Dentry %p{i=%lx,n=%pd} "
  1278. " still in use (%d) [unmount of %s %s]\n",
  1279. dentry,
  1280. dentry->d_inode ?
  1281. dentry->d_inode->i_ino : 0UL,
  1282. dentry,
  1283. dentry->d_lockref.count,
  1284. dentry->d_sb->s_type->name,
  1285. dentry->d_sb->s_id);
  1286. WARN_ON(1);
  1287. return D_WALK_CONTINUE;
  1288. }
  1289. static void do_one_tree(struct dentry *dentry)
  1290. {
  1291. shrink_dcache_parent(dentry);
  1292. d_walk(dentry, dentry, umount_check, NULL);
  1293. d_drop(dentry);
  1294. dput(dentry);
  1295. }
  1296. /*
  1297. * destroy the dentries attached to a superblock on unmounting
  1298. */
  1299. void shrink_dcache_for_umount(struct super_block *sb)
  1300. {
  1301. struct dentry *dentry;
  1302. WARN(down_read_trylock(&sb->s_umount), "s_umount should've been locked");
  1303. dentry = sb->s_root;
  1304. sb->s_root = NULL;
  1305. do_one_tree(dentry);
  1306. while (!hlist_bl_empty(&sb->s_anon)) {
  1307. dentry = dget(hlist_bl_entry(hlist_bl_first(&sb->s_anon), struct dentry, d_hash));
  1308. do_one_tree(dentry);
  1309. }
  1310. }
  1311. struct detach_data {
  1312. struct select_data select;
  1313. struct dentry *mountpoint;
  1314. };
  1315. static enum d_walk_ret detach_and_collect(void *_data, struct dentry *dentry)
  1316. {
  1317. struct detach_data *data = _data;
  1318. if (d_mountpoint(dentry)) {
  1319. __dget_dlock(dentry);
  1320. data->mountpoint = dentry;
  1321. return D_WALK_QUIT;
  1322. }
  1323. return select_collect(&data->select, dentry);
  1324. }
  1325. static void check_and_drop(void *_data)
  1326. {
  1327. struct detach_data *data = _data;
  1328. if (!data->mountpoint && !data->select.found)
  1329. __d_drop(data->select.start);
  1330. }
  1331. /**
  1332. * d_invalidate - detach submounts, prune dcache, and drop
  1333. * @dentry: dentry to invalidate (aka detach, prune and drop)
  1334. *
  1335. * no dcache lock.
  1336. *
  1337. * The final d_drop is done as an atomic operation relative to
  1338. * rename_lock ensuring there are no races with d_set_mounted. This
  1339. * ensures there are no unhashed dentries on the path to a mountpoint.
  1340. */
  1341. void d_invalidate(struct dentry *dentry)
  1342. {
  1343. /*
  1344. * If it's already been dropped, return OK.
  1345. */
  1346. spin_lock(&dentry->d_lock);
  1347. if (d_unhashed(dentry)) {
  1348. spin_unlock(&dentry->d_lock);
  1349. return;
  1350. }
  1351. spin_unlock(&dentry->d_lock);
  1352. /* Negative dentries can be dropped without further checks */
  1353. if (!dentry->d_inode) {
  1354. d_drop(dentry);
  1355. return;
  1356. }
  1357. for (;;) {
  1358. struct detach_data data;
  1359. data.mountpoint = NULL;
  1360. INIT_LIST_HEAD(&data.select.dispose);
  1361. data.select.start = dentry;
  1362. data.select.found = 0;
  1363. d_walk(dentry, &data, detach_and_collect, check_and_drop);
  1364. if (data.select.found)
  1365. shrink_dentry_list(&data.select.dispose);
  1366. if (data.mountpoint) {
  1367. detach_mounts(data.mountpoint);
  1368. dput(data.mountpoint);
  1369. }
  1370. if (!data.mountpoint && !data.select.found)
  1371. break;
  1372. cond_resched();
  1373. }
  1374. }
  1375. EXPORT_SYMBOL(d_invalidate);
  1376. /**
  1377. * __d_alloc - allocate a dcache entry
  1378. * @sb: filesystem it will belong to
  1379. * @name: qstr of the name
  1380. *
  1381. * Allocates a dentry. It returns %NULL if there is insufficient memory
  1382. * available. On a success the dentry is returned. The name passed in is
  1383. * copied and the copy passed in may be reused after this call.
  1384. */
  1385. struct dentry *__d_alloc(struct super_block *sb, const struct qstr *name)
  1386. {
  1387. struct dentry *dentry;
  1388. char *dname;
  1389. dentry = kmem_cache_alloc(dentry_cache, GFP_KERNEL);
  1390. if (!dentry)
  1391. return NULL;
  1392. /*
  1393. * We guarantee that the inline name is always NUL-terminated.
  1394. * This way the memcpy() done by the name switching in rename
  1395. * will still always have a NUL at the end, even if we might
  1396. * be overwriting an internal NUL character
  1397. */
  1398. dentry->d_iname[DNAME_INLINE_LEN-1] = 0;
  1399. if (name->len > DNAME_INLINE_LEN-1) {
  1400. size_t size = offsetof(struct external_name, name[1]);
  1401. struct external_name *p = kmalloc(size + name->len, GFP_KERNEL);
  1402. if (!p) {
  1403. kmem_cache_free(dentry_cache, dentry);
  1404. return NULL;
  1405. }
  1406. atomic_set(&p->u.count, 1);
  1407. dname = p->name;
  1408. if (IS_ENABLED(CONFIG_DCACHE_WORD_ACCESS))
  1409. kasan_unpoison_shadow(dname,
  1410. round_up(name->len + 1, sizeof(unsigned long)));
  1411. } else {
  1412. dname = dentry->d_iname;
  1413. }
  1414. dentry->d_name.len = name->len;
  1415. dentry->d_name.hash = name->hash;
  1416. memcpy(dname, name->name, name->len);
  1417. dname[name->len] = 0;
  1418. /* Make sure we always see the terminating NUL character */
  1419. smp_wmb();
  1420. dentry->d_name.name = dname;
  1421. dentry->d_lockref.count = 1;
  1422. dentry->d_flags = 0;
  1423. spin_lock_init(&dentry->d_lock);
  1424. seqcount_init(&dentry->d_seq);
  1425. dentry->d_inode = NULL;
  1426. dentry->d_parent = dentry;
  1427. dentry->d_sb = sb;
  1428. dentry->d_op = NULL;
  1429. dentry->d_fsdata = NULL;
  1430. INIT_HLIST_BL_NODE(&dentry->d_hash);
  1431. INIT_LIST_HEAD(&dentry->d_lru);
  1432. INIT_LIST_HEAD(&dentry->d_subdirs);
  1433. INIT_HLIST_NODE(&dentry->d_u.d_alias);
  1434. INIT_LIST_HEAD(&dentry->d_child);
  1435. d_set_d_op(dentry, dentry->d_sb->s_d_op);
  1436. this_cpu_inc(nr_dentry);
  1437. return dentry;
  1438. }
  1439. /**
  1440. * d_alloc - allocate a dcache entry
  1441. * @parent: parent of entry to allocate
  1442. * @name: qstr of the name
  1443. *
  1444. * Allocates a dentry. It returns %NULL if there is insufficient memory
  1445. * available. On a success the dentry is returned. The name passed in is
  1446. * copied and the copy passed in may be reused after this call.
  1447. */
  1448. struct dentry *d_alloc(struct dentry * parent, const struct qstr *name)
  1449. {
  1450. struct dentry *dentry = __d_alloc(parent->d_sb, name);
  1451. if (!dentry)
  1452. return NULL;
  1453. spin_lock(&parent->d_lock);
  1454. /*
  1455. * don't need child lock because it is not subject
  1456. * to concurrency here
  1457. */
  1458. __dget_dlock(parent);
  1459. dentry->d_parent = parent;
  1460. list_add(&dentry->d_child, &parent->d_subdirs);
  1461. spin_unlock(&parent->d_lock);
  1462. return dentry;
  1463. }
  1464. EXPORT_SYMBOL(d_alloc);
  1465. /**
  1466. * d_alloc_pseudo - allocate a dentry (for lookup-less filesystems)
  1467. * @sb: the superblock
  1468. * @name: qstr of the name
  1469. *
  1470. * For a filesystem that just pins its dentries in memory and never
  1471. * performs lookups at all, return an unhashed IS_ROOT dentry.
  1472. */
  1473. struct dentry *d_alloc_pseudo(struct super_block *sb, const struct qstr *name)
  1474. {
  1475. return __d_alloc(sb, name);
  1476. }
  1477. EXPORT_SYMBOL(d_alloc_pseudo);
  1478. struct dentry *d_alloc_name(struct dentry *parent, const char *name)
  1479. {
  1480. struct qstr q;
  1481. q.name = name;
  1482. q.len = strlen(name);
  1483. q.hash = full_name_hash(q.name, q.len);
  1484. return d_alloc(parent, &q);
  1485. }
  1486. EXPORT_SYMBOL(d_alloc_name);
  1487. void d_set_d_op(struct dentry *dentry, const struct dentry_operations *op)
  1488. {
  1489. WARN_ON_ONCE(dentry->d_op);
  1490. WARN_ON_ONCE(dentry->d_flags & (DCACHE_OP_HASH |
  1491. DCACHE_OP_COMPARE |
  1492. DCACHE_OP_REVALIDATE |
  1493. DCACHE_OP_WEAK_REVALIDATE |
  1494. DCACHE_OP_DELETE |
  1495. DCACHE_OP_SELECT_INODE));
  1496. dentry->d_op = op;
  1497. if (!op)
  1498. return;
  1499. if (op->d_hash)
  1500. dentry->d_flags |= DCACHE_OP_HASH;
  1501. if (op->d_compare)
  1502. dentry->d_flags |= DCACHE_OP_COMPARE;
  1503. if (op->d_revalidate)
  1504. dentry->d_flags |= DCACHE_OP_REVALIDATE;
  1505. if (op->d_weak_revalidate)
  1506. dentry->d_flags |= DCACHE_OP_WEAK_REVALIDATE;
  1507. if (op->d_delete)
  1508. dentry->d_flags |= DCACHE_OP_DELETE;
  1509. if (op->d_prune)
  1510. dentry->d_flags |= DCACHE_OP_PRUNE;
  1511. if (op->d_select_inode)
  1512. dentry->d_flags |= DCACHE_OP_SELECT_INODE;
  1513. }
  1514. EXPORT_SYMBOL(d_set_d_op);
  1515. /*
  1516. * d_set_fallthru - Mark a dentry as falling through to a lower layer
  1517. * @dentry - The dentry to mark
  1518. *
  1519. * Mark a dentry as falling through to the lower layer (as set with
  1520. * d_pin_lower()). This flag may be recorded on the medium.
  1521. */
  1522. void d_set_fallthru(struct dentry *dentry)
  1523. {
  1524. spin_lock(&dentry->d_lock);
  1525. dentry->d_flags |= DCACHE_FALLTHRU;
  1526. spin_unlock(&dentry->d_lock);
  1527. }
  1528. EXPORT_SYMBOL(d_set_fallthru);
  1529. static unsigned d_flags_for_inode(struct inode *inode)
  1530. {
  1531. unsigned add_flags = DCACHE_REGULAR_TYPE;
  1532. if (!inode)
  1533. return DCACHE_MISS_TYPE;
  1534. if (S_ISDIR(inode->i_mode)) {
  1535. add_flags = DCACHE_DIRECTORY_TYPE;
  1536. if (unlikely(!(inode->i_opflags & IOP_LOOKUP))) {
  1537. if (unlikely(!inode->i_op->lookup))
  1538. add_flags = DCACHE_AUTODIR_TYPE;
  1539. else
  1540. inode->i_opflags |= IOP_LOOKUP;
  1541. }
  1542. goto type_determined;
  1543. }
  1544. if (unlikely(!(inode->i_opflags & IOP_NOFOLLOW))) {
  1545. if (unlikely(inode->i_op->follow_link)) {
  1546. add_flags = DCACHE_SYMLINK_TYPE;
  1547. goto type_determined;
  1548. }
  1549. inode->i_opflags |= IOP_NOFOLLOW;
  1550. }
  1551. if (unlikely(!S_ISREG(inode->i_mode)))
  1552. add_flags = DCACHE_SPECIAL_TYPE;
  1553. type_determined:
  1554. if (unlikely(IS_AUTOMOUNT(inode)))
  1555. add_flags |= DCACHE_NEED_AUTOMOUNT;
  1556. return add_flags;
  1557. }
  1558. static void __d_instantiate(struct dentry *dentry, struct inode *inode)
  1559. {
  1560. unsigned add_flags = d_flags_for_inode(inode);
  1561. spin_lock(&dentry->d_lock);
  1562. if (inode)
  1563. hlist_add_head(&dentry->d_u.d_alias, &inode->i_dentry);
  1564. __d_set_inode_and_type(dentry, inode, add_flags);
  1565. dentry_rcuwalk_invalidate(dentry);
  1566. spin_unlock(&dentry->d_lock);
  1567. fsnotify_d_instantiate(dentry, inode);
  1568. }
  1569. /**
  1570. * d_instantiate - fill in inode information for a dentry
  1571. * @entry: dentry to complete
  1572. * @inode: inode to attach to this dentry
  1573. *
  1574. * Fill in inode information in the entry.
  1575. *
  1576. * This turns negative dentries into productive full members
  1577. * of society.
  1578. *
  1579. * NOTE! This assumes that the inode count has been incremented
  1580. * (or otherwise set) by the caller to indicate that it is now
  1581. * in use by the dcache.
  1582. */
  1583. void d_instantiate(struct dentry *entry, struct inode * inode)
  1584. {
  1585. BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
  1586. if (inode)
  1587. spin_lock(&inode->i_lock);
  1588. __d_instantiate(entry, inode);
  1589. if (inode)
  1590. spin_unlock(&inode->i_lock);
  1591. security_d_instantiate(entry, inode);
  1592. }
  1593. EXPORT_SYMBOL(d_instantiate);
  1594. /**
  1595. * d_instantiate_unique - instantiate a non-aliased dentry
  1596. * @entry: dentry to instantiate
  1597. * @inode: inode to attach to this dentry
  1598. *
  1599. * Fill in inode information in the entry. On success, it returns NULL.
  1600. * If an unhashed alias of "entry" already exists, then we return the
  1601. * aliased dentry instead and drop one reference to inode.
  1602. *
  1603. * Note that in order to avoid conflicts with rename() etc, the caller
  1604. * had better be holding the parent directory semaphore.
  1605. *
  1606. * This also assumes that the inode count has been incremented
  1607. * (or otherwise set) by the caller to indicate that it is now
  1608. * in use by the dcache.
  1609. */
  1610. static struct dentry *__d_instantiate_unique(struct dentry *entry,
  1611. struct inode *inode)
  1612. {
  1613. struct dentry *alias;
  1614. int len = entry->d_name.len;
  1615. const char *name = entry->d_name.name;
  1616. unsigned int hash = entry->d_name.hash;
  1617. if (!inode) {
  1618. __d_instantiate(entry, NULL);
  1619. return NULL;
  1620. }
  1621. hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
  1622. /*
  1623. * Don't need alias->d_lock here, because aliases with
  1624. * d_parent == entry->d_parent are not subject to name or
  1625. * parent changes, because the parent inode i_mutex is held.
  1626. */
  1627. if (alias->d_name.hash != hash)
  1628. continue;
  1629. if (alias->d_parent != entry->d_parent)
  1630. continue;
  1631. if (alias->d_name.len != len)
  1632. continue;
  1633. if (dentry_cmp(alias, name, len))
  1634. continue;
  1635. __dget(alias);
  1636. return alias;
  1637. }
  1638. __d_instantiate(entry, inode);
  1639. return NULL;
  1640. }
  1641. struct dentry *d_instantiate_unique(struct dentry *entry, struct inode *inode)
  1642. {
  1643. struct dentry *result;
  1644. BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
  1645. if (inode)
  1646. spin_lock(&inode->i_lock);
  1647. result = __d_instantiate_unique(entry, inode);
  1648. if (inode)
  1649. spin_unlock(&inode->i_lock);
  1650. if (!result) {
  1651. security_d_instantiate(entry, inode);
  1652. return NULL;
  1653. }
  1654. BUG_ON(!d_unhashed(result));
  1655. iput(inode);
  1656. return result;
  1657. }
  1658. EXPORT_SYMBOL(d_instantiate_unique);
  1659. /**
  1660. * d_instantiate_no_diralias - instantiate a non-aliased dentry
  1661. * @entry: dentry to complete
  1662. * @inode: inode to attach to this dentry
  1663. *
  1664. * Fill in inode information in the entry. If a directory alias is found, then
  1665. * return an error (and drop inode). Together with d_materialise_unique() this
  1666. * guarantees that a directory inode may never have more than one alias.
  1667. */
  1668. int d_instantiate_no_diralias(struct dentry *entry, struct inode *inode)
  1669. {
  1670. BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
  1671. spin_lock(&inode->i_lock);
  1672. if (S_ISDIR(inode->i_mode) && !hlist_empty(&inode->i_dentry)) {
  1673. spin_unlock(&inode->i_lock);
  1674. iput(inode);
  1675. return -EBUSY;
  1676. }
  1677. __d_instantiate(entry, inode);
  1678. spin_unlock(&inode->i_lock);
  1679. security_d_instantiate(entry, inode);
  1680. return 0;
  1681. }
  1682. EXPORT_SYMBOL(d_instantiate_no_diralias);
  1683. struct dentry *d_make_root(struct inode *root_inode)
  1684. {
  1685. struct dentry *res = NULL;
  1686. if (root_inode) {
  1687. static const struct qstr name = QSTR_INIT("/", 1);
  1688. res = __d_alloc(root_inode->i_sb, &name);
  1689. if (res)
  1690. d_instantiate(res, root_inode);
  1691. else
  1692. iput(root_inode);
  1693. }
  1694. return res;
  1695. }
  1696. EXPORT_SYMBOL(d_make_root);
  1697. static struct dentry * __d_find_any_alias(struct inode *inode)
  1698. {
  1699. struct dentry *alias;
  1700. if (hlist_empty(&inode->i_dentry))
  1701. return NULL;
  1702. alias = hlist_entry(inode->i_dentry.first, struct dentry, d_u.d_alias);
  1703. __dget(alias);
  1704. return alias;
  1705. }
  1706. /**
  1707. * d_find_any_alias - find any alias for a given inode
  1708. * @inode: inode to find an alias for
  1709. *
  1710. * If any aliases exist for the given inode, take and return a
  1711. * reference for one of them. If no aliases exist, return %NULL.
  1712. */
  1713. struct dentry *d_find_any_alias(struct inode *inode)
  1714. {
  1715. struct dentry *de;
  1716. spin_lock(&inode->i_lock);
  1717. de = __d_find_any_alias(inode);
  1718. spin_unlock(&inode->i_lock);
  1719. return de;
  1720. }
  1721. EXPORT_SYMBOL(d_find_any_alias);
  1722. static struct dentry *__d_obtain_alias(struct inode *inode, int disconnected)
  1723. {
  1724. static const struct qstr anonstring = QSTR_INIT("/", 1);
  1725. struct dentry *tmp;
  1726. struct dentry *res;
  1727. unsigned add_flags;
  1728. if (!inode)
  1729. return ERR_PTR(-ESTALE);
  1730. if (IS_ERR(inode))
  1731. return ERR_CAST(inode);
  1732. res = d_find_any_alias(inode);
  1733. if (res)
  1734. goto out_iput;
  1735. tmp = __d_alloc(inode->i_sb, &anonstring);
  1736. if (!tmp) {
  1737. res = ERR_PTR(-ENOMEM);
  1738. goto out_iput;
  1739. }
  1740. spin_lock(&inode->i_lock);
  1741. res = __d_find_any_alias(inode);
  1742. if (res) {
  1743. spin_unlock(&inode->i_lock);
  1744. dput(tmp);
  1745. goto out_iput;
  1746. }
  1747. /* attach a disconnected dentry */
  1748. add_flags = d_flags_for_inode(inode);
  1749. if (disconnected)
  1750. add_flags |= DCACHE_DISCONNECTED;
  1751. spin_lock(&tmp->d_lock);
  1752. __d_set_inode_and_type(tmp, inode, add_flags);
  1753. hlist_add_head(&tmp->d_u.d_alias, &inode->i_dentry);
  1754. hlist_bl_lock(&tmp->d_sb->s_anon);
  1755. hlist_bl_add_head(&tmp->d_hash, &tmp->d_sb->s_anon);
  1756. hlist_bl_unlock(&tmp->d_sb->s_anon);
  1757. spin_unlock(&tmp->d_lock);
  1758. spin_unlock(&inode->i_lock);
  1759. security_d_instantiate(tmp, inode);
  1760. return tmp;
  1761. out_iput:
  1762. if (res && !IS_ERR(res))
  1763. security_d_instantiate(res, inode);
  1764. iput(inode);
  1765. return res;
  1766. }
  1767. /**
  1768. * d_obtain_alias - find or allocate a DISCONNECTED dentry for a given inode
  1769. * @inode: inode to allocate the dentry for
  1770. *
  1771. * Obtain a dentry for an inode resulting from NFS filehandle conversion or
  1772. * similar open by handle operations. The returned dentry may be anonymous,
  1773. * or may have a full name (if the inode was already in the cache).
  1774. *
  1775. * When called on a directory inode, we must ensure that the inode only ever
  1776. * has one dentry. If a dentry is found, that is returned instead of
  1777. * allocating a new one.
  1778. *
  1779. * On successful return, the reference to the inode has been transferred
  1780. * to the dentry. In case of an error the reference on the inode is released.
  1781. * To make it easier to use in export operations a %NULL or IS_ERR inode may
  1782. * be passed in and the error will be propagated to the return value,
  1783. * with a %NULL @inode replaced by ERR_PTR(-ESTALE).
  1784. */
  1785. struct dentry *d_obtain_alias(struct inode *inode)
  1786. {
  1787. return __d_obtain_alias(inode, 1);
  1788. }
  1789. EXPORT_SYMBOL(d_obtain_alias);
  1790. /**
  1791. * d_obtain_root - find or allocate a dentry for a given inode
  1792. * @inode: inode to allocate the dentry for
  1793. *
  1794. * Obtain an IS_ROOT dentry for the root of a filesystem.
  1795. *
  1796. * We must ensure that directory inodes only ever have one dentry. If a
  1797. * dentry is found, that is returned instead of allocating a new one.
  1798. *
  1799. * On successful return, the reference to the inode has been transferred
  1800. * to the dentry. In case of an error the reference on the inode is
  1801. * released. A %NULL or IS_ERR inode may be passed in and will be the
  1802. * error will be propagate to the return value, with a %NULL @inode
  1803. * replaced by ERR_PTR(-ESTALE).
  1804. */
  1805. struct dentry *d_obtain_root(struct inode *inode)
  1806. {
  1807. return __d_obtain_alias(inode, 0);
  1808. }
  1809. EXPORT_SYMBOL(d_obtain_root);
  1810. /**
  1811. * d_add_ci - lookup or allocate new dentry with case-exact name
  1812. * @inode: the inode case-insensitive lookup has found
  1813. * @dentry: the negative dentry that was passed to the parent's lookup func
  1814. * @name: the case-exact name to be associated with the returned dentry
  1815. *
  1816. * This is to avoid filling the dcache with case-insensitive names to the
  1817. * same inode, only the actual correct case is stored in the dcache for
  1818. * case-insensitive filesystems.
  1819. *
  1820. * For a case-insensitive lookup match and if the the case-exact dentry
  1821. * already exists in in the dcache, use it and return it.
  1822. *
  1823. * If no entry exists with the exact case name, allocate new dentry with
  1824. * the exact case, and return the spliced entry.
  1825. */
  1826. struct dentry *d_add_ci(struct dentry *dentry, struct inode *inode,
  1827. struct qstr *name)
  1828. {
  1829. struct dentry *found;
  1830. struct dentry *new;
  1831. /*
  1832. * First check if a dentry matching the name already exists,
  1833. * if not go ahead and create it now.
  1834. */
  1835. found = d_hash_and_lookup(dentry->d_parent, name);
  1836. if (!found) {
  1837. new = d_alloc(dentry->d_parent, name);
  1838. if (!new) {
  1839. found = ERR_PTR(-ENOMEM);
  1840. } else {
  1841. found = d_splice_alias(inode, new);
  1842. if (found) {
  1843. dput(new);
  1844. return found;
  1845. }
  1846. return new;
  1847. }
  1848. }
  1849. iput(inode);
  1850. return found;
  1851. }
  1852. EXPORT_SYMBOL(d_add_ci);
  1853. /*
  1854. * Do the slow-case of the dentry name compare.
  1855. *
  1856. * Unlike the dentry_cmp() function, we need to atomically
  1857. * load the name and length information, so that the
  1858. * filesystem can rely on them, and can use the 'name' and
  1859. * 'len' information without worrying about walking off the
  1860. * end of memory etc.
  1861. *
  1862. * Thus the read_seqcount_retry() and the "duplicate" info
  1863. * in arguments (the low-level filesystem should not look
  1864. * at the dentry inode or name contents directly, since
  1865. * rename can change them while we're in RCU mode).
  1866. */
  1867. enum slow_d_compare {
  1868. D_COMP_OK,
  1869. D_COMP_NOMATCH,
  1870. D_COMP_SEQRETRY,
  1871. };
  1872. static noinline enum slow_d_compare slow_dentry_cmp(
  1873. const struct dentry *parent,
  1874. struct dentry *dentry,
  1875. unsigned int seq,
  1876. const struct qstr *name)
  1877. {
  1878. int tlen = dentry->d_name.len;
  1879. const char *tname = dentry->d_name.name;
  1880. if (read_seqcount_retry(&dentry->d_seq, seq)) {
  1881. cpu_relax();
  1882. return D_COMP_SEQRETRY;
  1883. }
  1884. if (parent->d_op->d_compare(parent, dentry, tlen, tname, name))
  1885. return D_COMP_NOMATCH;
  1886. return D_COMP_OK;
  1887. }
  1888. /**
  1889. * __d_lookup_rcu - search for a dentry (racy, store-free)
  1890. * @parent: parent dentry
  1891. * @name: qstr of name we wish to find
  1892. * @seqp: returns d_seq value at the point where the dentry was found
  1893. * Returns: dentry, or NULL
  1894. *
  1895. * __d_lookup_rcu is the dcache lookup function for rcu-walk name
  1896. * resolution (store-free path walking) design described in
  1897. * Documentation/filesystems/path-lookup.txt.
  1898. *
  1899. * This is not to be used outside core vfs.
  1900. *
  1901. * __d_lookup_rcu must only be used in rcu-walk mode, ie. with vfsmount lock
  1902. * held, and rcu_read_lock held. The returned dentry must not be stored into
  1903. * without taking d_lock and checking d_seq sequence count against @seq
  1904. * returned here.
  1905. *
  1906. * A refcount may be taken on the found dentry with the d_rcu_to_refcount
  1907. * function.
  1908. *
  1909. * Alternatively, __d_lookup_rcu may be called again to look up the child of
  1910. * the returned dentry, so long as its parent's seqlock is checked after the
  1911. * child is looked up. Thus, an interlocking stepping of sequence lock checks
  1912. * is formed, giving integrity down the path walk.
  1913. *
  1914. * NOTE! The caller *has* to check the resulting dentry against the sequence
  1915. * number we've returned before using any of the resulting dentry state!
  1916. */
  1917. struct dentry *__d_lookup_rcu(const struct dentry *parent,
  1918. const struct qstr *name,
  1919. unsigned *seqp)
  1920. {
  1921. u64 hashlen = name->hash_len;
  1922. const unsigned char *str = name->name;
  1923. struct hlist_bl_head *b = d_hash(parent, hashlen_hash(hashlen));
  1924. struct hlist_bl_node *node;
  1925. struct dentry *dentry;
  1926. /*
  1927. * Note: There is significant duplication with __d_lookup_rcu which is
  1928. * required to prevent single threaded performance regressions
  1929. * especially on architectures where smp_rmb (in seqcounts) are costly.
  1930. * Keep the two functions in sync.
  1931. */
  1932. /*
  1933. * The hash list is protected using RCU.
  1934. *
  1935. * Carefully use d_seq when comparing a candidate dentry, to avoid
  1936. * races with d_move().
  1937. *
  1938. * It is possible that concurrent renames can mess up our list
  1939. * walk here and result in missing our dentry, resulting in the
  1940. * false-negative result. d_lookup() protects against concurrent
  1941. * renames using rename_lock seqlock.
  1942. *
  1943. * See Documentation/filesystems/path-lookup.txt for more details.
  1944. */
  1945. hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
  1946. unsigned seq;
  1947. seqretry:
  1948. /*
  1949. * The dentry sequence count protects us from concurrent
  1950. * renames, and thus protects parent and name fields.
  1951. *
  1952. * The caller must perform a seqcount check in order
  1953. * to do anything useful with the returned dentry.
  1954. *
  1955. * NOTE! We do a "raw" seqcount_begin here. That means that
  1956. * we don't wait for the sequence count to stabilize if it
  1957. * is in the middle of a sequence change. If we do the slow
  1958. * dentry compare, we will do seqretries until it is stable,
  1959. * and if we end up with a successful lookup, we actually
  1960. * want to exit RCU lookup anyway.
  1961. */
  1962. seq = raw_seqcount_begin(&dentry->d_seq);
  1963. if (dentry->d_parent != parent)
  1964. continue;
  1965. if (d_unhashed(dentry))
  1966. continue;
  1967. if (unlikely(parent->d_flags & DCACHE_OP_COMPARE)) {
  1968. if (dentry->d_name.hash != hashlen_hash(hashlen))
  1969. continue;
  1970. *seqp = seq;
  1971. switch (slow_dentry_cmp(parent, dentry, seq, name)) {
  1972. case D_COMP_OK:
  1973. return dentry;
  1974. case D_COMP_NOMATCH:
  1975. continue;
  1976. default:
  1977. goto seqretry;
  1978. }
  1979. }
  1980. if (dentry->d_name.hash_len != hashlen)
  1981. continue;
  1982. *seqp = seq;
  1983. if (!dentry_cmp(dentry, str, hashlen_len(hashlen)))
  1984. return dentry;
  1985. }
  1986. return NULL;
  1987. }
  1988. /**
  1989. * d_lookup - search for a dentry
  1990. * @parent: parent dentry
  1991. * @name: qstr of name we wish to find
  1992. * Returns: dentry, or NULL
  1993. *
  1994. * d_lookup searches the children of the parent dentry for the name in
  1995. * question. If the dentry is found its reference count is incremented and the
  1996. * dentry is returned. The caller must use dput to free the entry when it has
  1997. * finished using it. %NULL is returned if the dentry does not exist.
  1998. */
  1999. struct dentry *d_lookup(const struct dentry *parent, const struct qstr *name)
  2000. {
  2001. struct dentry *dentry;
  2002. unsigned seq;
  2003. do {
  2004. seq = read_seqbegin(&rename_lock);
  2005. dentry = __d_lookup(parent, name);
  2006. if (dentry)
  2007. break;
  2008. } while (read_seqretry(&rename_lock, seq));
  2009. return dentry;
  2010. }
  2011. EXPORT_SYMBOL(d_lookup);
  2012. /**
  2013. * __d_lookup - search for a dentry (racy)
  2014. * @parent: parent dentry
  2015. * @name: qstr of name we wish to find
  2016. * Returns: dentry, or NULL
  2017. *
  2018. * __d_lookup is like d_lookup, however it may (rarely) return a
  2019. * false-negative result due to unrelated rename activity.
  2020. *
  2021. * __d_lookup is slightly faster by avoiding rename_lock read seqlock,
  2022. * however it must be used carefully, eg. with a following d_lookup in
  2023. * the case of failure.
  2024. *
  2025. * __d_lookup callers must be commented.
  2026. */
  2027. struct dentry *__d_lookup(const struct dentry *parent, const struct qstr *name)
  2028. {
  2029. unsigned int len = name->len;
  2030. unsigned int hash = name->hash;
  2031. const unsigned char *str = name->name;
  2032. struct hlist_bl_head *b = d_hash(parent, hash);
  2033. struct hlist_bl_node *node;
  2034. struct dentry *found = NULL;
  2035. struct dentry *dentry;
  2036. /*
  2037. * Note: There is significant duplication with __d_lookup_rcu which is
  2038. * required to prevent single threaded performance regressions
  2039. * especially on architectures where smp_rmb (in seqcounts) are costly.
  2040. * Keep the two functions in sync.
  2041. */
  2042. /*
  2043. * The hash list is protected using RCU.
  2044. *
  2045. * Take d_lock when comparing a candidate dentry, to avoid races
  2046. * with d_move().
  2047. *
  2048. * It is possible that concurrent renames can mess up our list
  2049. * walk here and result in missing our dentry, resulting in the
  2050. * false-negative result. d_lookup() protects against concurrent
  2051. * renames using rename_lock seqlock.
  2052. *
  2053. * See Documentation/filesystems/path-lookup.txt for more details.
  2054. */
  2055. rcu_read_lock();
  2056. hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
  2057. if (dentry->d_name.hash != hash)
  2058. continue;
  2059. spin_lock(&dentry->d_lock);
  2060. if (dentry->d_parent != parent)
  2061. goto next;
  2062. if (d_unhashed(dentry))
  2063. goto next;
  2064. /*
  2065. * It is safe to compare names since d_move() cannot
  2066. * change the qstr (protected by d_lock).
  2067. */
  2068. if (parent->d_flags & DCACHE_OP_COMPARE) {
  2069. int tlen = dentry->d_name.len;
  2070. const char *tname = dentry->d_name.name;
  2071. if (parent->d_op->d_compare(parent, dentry, tlen, tname, name))
  2072. goto next;
  2073. } else {
  2074. if (dentry->d_name.len != len)
  2075. goto next;
  2076. if (dentry_cmp(dentry, str, len))
  2077. goto next;
  2078. }
  2079. dentry->d_lockref.count++;
  2080. found = dentry;
  2081. spin_unlock(&dentry->d_lock);
  2082. break;
  2083. next:
  2084. spin_unlock(&dentry->d_lock);
  2085. }
  2086. rcu_read_unlock();
  2087. return found;
  2088. }
  2089. /**
  2090. * d_hash_and_lookup - hash the qstr then search for a dentry
  2091. * @dir: Directory to search in
  2092. * @name: qstr of name we wish to find
  2093. *
  2094. * On lookup failure NULL is returned; on bad name - ERR_PTR(-error)
  2095. */
  2096. struct dentry *d_hash_and_lookup(struct dentry *dir, struct qstr *name)
  2097. {
  2098. /*
  2099. * Check for a fs-specific hash function. Note that we must
  2100. * calculate the standard hash first, as the d_op->d_hash()
  2101. * routine may choose to leave the hash value unchanged.
  2102. */
  2103. name->hash = full_name_hash(name->name, name->len);
  2104. if (dir->d_flags & DCACHE_OP_HASH) {
  2105. int err = dir->d_op->d_hash(dir, name);
  2106. if (unlikely(err < 0))
  2107. return ERR_PTR(err);
  2108. }
  2109. return d_lookup(dir, name);
  2110. }
  2111. EXPORT_SYMBOL(d_hash_and_lookup);
  2112. /*
  2113. * When a file is deleted, we have two options:
  2114. * - turn this dentry into a negative dentry
  2115. * - unhash this dentry and free it.
  2116. *
  2117. * Usually, we want to just turn this into
  2118. * a negative dentry, but if anybody else is
  2119. * currently using the dentry or the inode
  2120. * we can't do that and we fall back on removing
  2121. * it from the hash queues and waiting for
  2122. * it to be deleted later when it has no users
  2123. */
  2124. /**
  2125. * d_delete - delete a dentry
  2126. * @dentry: The dentry to delete
  2127. *
  2128. * Turn the dentry into a negative dentry if possible, otherwise
  2129. * remove it from the hash queues so it can be deleted later
  2130. */
  2131. void d_delete(struct dentry * dentry)
  2132. {
  2133. struct inode *inode;
  2134. int isdir = 0;
  2135. /*
  2136. * Are we the only user?
  2137. */
  2138. again:
  2139. spin_lock(&dentry->d_lock);
  2140. inode = dentry->d_inode;
  2141. isdir = S_ISDIR(inode->i_mode);
  2142. if (dentry->d_lockref.count == 1) {
  2143. if (!spin_trylock(&inode->i_lock)) {
  2144. spin_unlock(&dentry->d_lock);
  2145. cpu_relax();
  2146. goto again;
  2147. }
  2148. dentry->d_flags &= ~DCACHE_CANT_MOUNT;
  2149. dentry_unlink_inode(dentry);
  2150. fsnotify_nameremove(dentry, isdir);
  2151. return;
  2152. }
  2153. if (!d_unhashed(dentry))
  2154. __d_drop(dentry);
  2155. spin_unlock(&dentry->d_lock);
  2156. fsnotify_nameremove(dentry, isdir);
  2157. }
  2158. EXPORT_SYMBOL(d_delete);
  2159. static void __d_rehash(struct dentry * entry, struct hlist_bl_head *b)
  2160. {
  2161. BUG_ON(!d_unhashed(entry));
  2162. hlist_bl_lock(b);
  2163. entry->d_flags |= DCACHE_RCUACCESS;
  2164. hlist_bl_add_head_rcu(&entry->d_hash, b);
  2165. hlist_bl_unlock(b);
  2166. }
  2167. static void _d_rehash(struct dentry * entry)
  2168. {
  2169. __d_rehash(entry, d_hash(entry->d_parent, entry->d_name.hash));
  2170. }
  2171. /**
  2172. * d_rehash - add an entry back to the hash
  2173. * @entry: dentry to add to the hash
  2174. *
  2175. * Adds a dentry to the hash according to its name.
  2176. */
  2177. void d_rehash(struct dentry * entry)
  2178. {
  2179. spin_lock(&entry->d_lock);
  2180. _d_rehash(entry);
  2181. spin_unlock(&entry->d_lock);
  2182. }
  2183. EXPORT_SYMBOL(d_rehash);
  2184. /**
  2185. * dentry_update_name_case - update case insensitive dentry with a new name
  2186. * @dentry: dentry to be updated
  2187. * @name: new name
  2188. *
  2189. * Update a case insensitive dentry with new case of name.
  2190. *
  2191. * dentry must have been returned by d_lookup with name @name. Old and new
  2192. * name lengths must match (ie. no d_compare which allows mismatched name
  2193. * lengths).
  2194. *
  2195. * Parent inode i_mutex must be held over d_lookup and into this call (to
  2196. * keep renames and concurrent inserts, and readdir(2) away).
  2197. */
  2198. void dentry_update_name_case(struct dentry *dentry, struct qstr *name)
  2199. {
  2200. BUG_ON(!mutex_is_locked(&dentry->d_parent->d_inode->i_mutex));
  2201. BUG_ON(dentry->d_name.len != name->len); /* d_lookup gives this */
  2202. spin_lock(&dentry->d_lock);
  2203. write_seqcount_begin(&dentry->d_seq);
  2204. memcpy((unsigned char *)dentry->d_name.name, name->name, name->len);
  2205. write_seqcount_end(&dentry->d_seq);
  2206. spin_unlock(&dentry->d_lock);
  2207. }
  2208. EXPORT_SYMBOL(dentry_update_name_case);
  2209. static void swap_names(struct dentry *dentry, struct dentry *target)
  2210. {
  2211. if (unlikely(dname_external(target))) {
  2212. if (unlikely(dname_external(dentry))) {
  2213. /*
  2214. * Both external: swap the pointers
  2215. */
  2216. swap(target->d_name.name, dentry->d_name.name);
  2217. } else {
  2218. /*
  2219. * dentry:internal, target:external. Steal target's
  2220. * storage and make target internal.
  2221. */
  2222. memcpy(target->d_iname, dentry->d_name.name,
  2223. dentry->d_name.len + 1);
  2224. dentry->d_name.name = target->d_name.name;
  2225. target->d_name.name = target->d_iname;
  2226. }
  2227. } else {
  2228. if (unlikely(dname_external(dentry))) {
  2229. /*
  2230. * dentry:external, target:internal. Give dentry's
  2231. * storage to target and make dentry internal
  2232. */
  2233. memcpy(dentry->d_iname, target->d_name.name,
  2234. target->d_name.len + 1);
  2235. target->d_name.name = dentry->d_name.name;
  2236. dentry->d_name.name = dentry->d_iname;
  2237. } else {
  2238. /*
  2239. * Both are internal.
  2240. */
  2241. unsigned int i;
  2242. BUILD_BUG_ON(!IS_ALIGNED(DNAME_INLINE_LEN, sizeof(long)));
  2243. kmemcheck_mark_initialized(dentry->d_iname, DNAME_INLINE_LEN);
  2244. kmemcheck_mark_initialized(target->d_iname, DNAME_INLINE_LEN);
  2245. for (i = 0; i < DNAME_INLINE_LEN / sizeof(long); i++) {
  2246. swap(((long *) &dentry->d_iname)[i],
  2247. ((long *) &target->d_iname)[i]);
  2248. }
  2249. }
  2250. }
  2251. swap(dentry->d_name.hash_len, target->d_name.hash_len);
  2252. }
  2253. static void copy_name(struct dentry *dentry, struct dentry *target)
  2254. {
  2255. struct external_name *old_name = NULL;
  2256. if (unlikely(dname_external(dentry)))
  2257. old_name = external_name(dentry);
  2258. if (unlikely(dname_external(target))) {
  2259. atomic_inc(&external_name(target)->u.count);
  2260. dentry->d_name = target->d_name;
  2261. } else {
  2262. memcpy(dentry->d_iname, target->d_name.name,
  2263. target->d_name.len + 1);
  2264. dentry->d_name.name = dentry->d_iname;
  2265. dentry->d_name.hash_len = target->d_name.hash_len;
  2266. }
  2267. if (old_name && likely(atomic_dec_and_test(&old_name->u.count)))
  2268. kfree_rcu(old_name, u.head);
  2269. }
  2270. static void dentry_lock_for_move(struct dentry *dentry, struct dentry *target)
  2271. {
  2272. /*
  2273. * XXXX: do we really need to take target->d_lock?
  2274. */
  2275. if (IS_ROOT(dentry) || dentry->d_parent == target->d_parent)
  2276. spin_lock(&target->d_parent->d_lock);
  2277. else {
  2278. if (d_ancestor(dentry->d_parent, target->d_parent)) {
  2279. spin_lock(&dentry->d_parent->d_lock);
  2280. spin_lock_nested(&target->d_parent->d_lock,
  2281. DENTRY_D_LOCK_NESTED);
  2282. } else {
  2283. spin_lock(&target->d_parent->d_lock);
  2284. spin_lock_nested(&dentry->d_parent->d_lock,
  2285. DENTRY_D_LOCK_NESTED);
  2286. }
  2287. }
  2288. if (target < dentry) {
  2289. spin_lock_nested(&target->d_lock, 2);
  2290. spin_lock_nested(&dentry->d_lock, 3);
  2291. } else {
  2292. spin_lock_nested(&dentry->d_lock, 2);
  2293. spin_lock_nested(&target->d_lock, 3);
  2294. }
  2295. }
  2296. static void dentry_unlock_for_move(struct dentry *dentry, struct dentry *target)
  2297. {
  2298. if (target->d_parent != dentry->d_parent)
  2299. spin_unlock(&dentry->d_parent->d_lock);
  2300. if (target->d_parent != target)
  2301. spin_unlock(&target->d_parent->d_lock);
  2302. spin_unlock(&target->d_lock);
  2303. spin_unlock(&dentry->d_lock);
  2304. }
  2305. /*
  2306. * When switching names, the actual string doesn't strictly have to
  2307. * be preserved in the target - because we're dropping the target
  2308. * anyway. As such, we can just do a simple memcpy() to copy over
  2309. * the new name before we switch, unless we are going to rehash
  2310. * it. Note that if we *do* unhash the target, we are not allowed
  2311. * to rehash it without giving it a new name/hash key - whether
  2312. * we swap or overwrite the names here, resulting name won't match
  2313. * the reality in filesystem; it's only there for d_path() purposes.
  2314. * Note that all of this is happening under rename_lock, so the
  2315. * any hash lookup seeing it in the middle of manipulations will
  2316. * be discarded anyway. So we do not care what happens to the hash
  2317. * key in that case.
  2318. */
  2319. /*
  2320. * __d_move - move a dentry
  2321. * @dentry: entry to move
  2322. * @target: new dentry
  2323. * @exchange: exchange the two dentries
  2324. *
  2325. * Update the dcache to reflect the move of a file name. Negative
  2326. * dcache entries should not be moved in this way. Caller must hold
  2327. * rename_lock, the i_mutex of the source and target directories,
  2328. * and the sb->s_vfs_rename_mutex if they differ. See lock_rename().
  2329. */
  2330. static void __d_move(struct dentry *dentry, struct dentry *target,
  2331. bool exchange)
  2332. {
  2333. if (!dentry->d_inode)
  2334. printk(KERN_WARNING "VFS: moving negative dcache entry\n");
  2335. BUG_ON(d_ancestor(dentry, target));
  2336. BUG_ON(d_ancestor(target, dentry));
  2337. dentry_lock_for_move(dentry, target);
  2338. write_seqcount_begin(&dentry->d_seq);
  2339. write_seqcount_begin_nested(&target->d_seq, DENTRY_D_LOCK_NESTED);
  2340. /* __d_drop does write_seqcount_barrier, but they're OK to nest. */
  2341. /*
  2342. * Move the dentry to the target hash queue. Don't bother checking
  2343. * for the same hash queue because of how unlikely it is.
  2344. */
  2345. __d_drop(dentry);
  2346. __d_rehash(dentry, d_hash(target->d_parent, target->d_name.hash));
  2347. /*
  2348. * Unhash the target (d_delete() is not usable here). If exchanging
  2349. * the two dentries, then rehash onto the other's hash queue.
  2350. */
  2351. __d_drop(target);
  2352. if (exchange) {
  2353. __d_rehash(target,
  2354. d_hash(dentry->d_parent, dentry->d_name.hash));
  2355. }
  2356. /* Switch the names.. */
  2357. if (exchange)
  2358. swap_names(dentry, target);
  2359. else
  2360. copy_name(dentry, target);
  2361. /* ... and switch them in the tree */
  2362. if (IS_ROOT(dentry)) {
  2363. /* splicing a tree */
  2364. dentry->d_parent = target->d_parent;
  2365. target->d_parent = target;
  2366. list_del_init(&target->d_child);
  2367. list_move(&dentry->d_child, &dentry->d_parent->d_subdirs);
  2368. } else {
  2369. /* swapping two dentries */
  2370. swap(dentry->d_parent, target->d_parent);
  2371. list_move(&target->d_child, &target->d_parent->d_subdirs);
  2372. list_move(&dentry->d_child, &dentry->d_parent->d_subdirs);
  2373. if (exchange)
  2374. fsnotify_d_move(target);
  2375. fsnotify_d_move(dentry);
  2376. }
  2377. write_seqcount_end(&target->d_seq);
  2378. write_seqcount_end(&dentry->d_seq);
  2379. dentry_unlock_for_move(dentry, target);
  2380. }
  2381. /*
  2382. * d_move - move a dentry
  2383. * @dentry: entry to move
  2384. * @target: new dentry
  2385. *
  2386. * Update the dcache to reflect the move of a file name. Negative
  2387. * dcache entries should not be moved in this way. See the locking
  2388. * requirements for __d_move.
  2389. */
  2390. void d_move(struct dentry *dentry, struct dentry *target)
  2391. {
  2392. write_seqlock(&rename_lock);
  2393. __d_move(dentry, target, false);
  2394. write_sequnlock(&rename_lock);
  2395. }
  2396. EXPORT_SYMBOL(d_move);
  2397. /*
  2398. * d_exchange - exchange two dentries
  2399. * @dentry1: first dentry
  2400. * @dentry2: second dentry
  2401. */
  2402. void d_exchange(struct dentry *dentry1, struct dentry *dentry2)
  2403. {
  2404. write_seqlock(&rename_lock);
  2405. WARN_ON(!dentry1->d_inode);
  2406. WARN_ON(!dentry2->d_inode);
  2407. WARN_ON(IS_ROOT(dentry1));
  2408. WARN_ON(IS_ROOT(dentry2));
  2409. __d_move(dentry1, dentry2, true);
  2410. write_sequnlock(&rename_lock);
  2411. }
  2412. /**
  2413. * d_ancestor - search for an ancestor
  2414. * @p1: ancestor dentry
  2415. * @p2: child dentry
  2416. *
  2417. * Returns the ancestor dentry of p2 which is a child of p1, if p1 is
  2418. * an ancestor of p2, else NULL.
  2419. */
  2420. struct dentry *d_ancestor(struct dentry *p1, struct dentry *p2)
  2421. {
  2422. struct dentry *p;
  2423. for (p = p2; !IS_ROOT(p); p = p->d_parent) {
  2424. if (p->d_parent == p1)
  2425. return p;
  2426. }
  2427. return NULL;
  2428. }
  2429. /*
  2430. * This helper attempts to cope with remotely renamed directories
  2431. *
  2432. * It assumes that the caller is already holding
  2433. * dentry->d_parent->d_inode->i_mutex, inode->i_lock and rename_lock
  2434. *
  2435. * Note: If ever the locking in lock_rename() changes, then please
  2436. * remember to update this too...
  2437. */
  2438. static int __d_unalias(struct inode *inode,
  2439. struct dentry *dentry, struct dentry *alias)
  2440. {
  2441. struct mutex *m1 = NULL, *m2 = NULL;
  2442. int ret = -ESTALE;
  2443. /* If alias and dentry share a parent, then no extra locks required */
  2444. if (alias->d_parent == dentry->d_parent)
  2445. goto out_unalias;
  2446. /* See lock_rename() */
  2447. if (!mutex_trylock(&dentry->d_sb->s_vfs_rename_mutex))
  2448. goto out_err;
  2449. m1 = &dentry->d_sb->s_vfs_rename_mutex;
  2450. if (!mutex_trylock(&alias->d_parent->d_inode->i_mutex))
  2451. goto out_err;
  2452. m2 = &alias->d_parent->d_inode->i_mutex;
  2453. out_unalias:
  2454. __d_move(alias, dentry, false);
  2455. ret = 0;
  2456. out_err:
  2457. spin_unlock(&inode->i_lock);
  2458. if (m2)
  2459. mutex_unlock(m2);
  2460. if (m1)
  2461. mutex_unlock(m1);
  2462. return ret;
  2463. }
  2464. /**
  2465. * d_splice_alias - splice a disconnected dentry into the tree if one exists
  2466. * @inode: the inode which may have a disconnected dentry
  2467. * @dentry: a negative dentry which we want to point to the inode.
  2468. *
  2469. * If inode is a directory and has an IS_ROOT alias, then d_move that in
  2470. * place of the given dentry and return it, else simply d_add the inode
  2471. * to the dentry and return NULL.
  2472. *
  2473. * If a non-IS_ROOT directory is found, the filesystem is corrupt, and
  2474. * we should error out: directories can't have multiple aliases.
  2475. *
  2476. * This is needed in the lookup routine of any filesystem that is exportable
  2477. * (via knfsd) so that we can build dcache paths to directories effectively.
  2478. *
  2479. * If a dentry was found and moved, then it is returned. Otherwise NULL
  2480. * is returned. This matches the expected return value of ->lookup.
  2481. *
  2482. * Cluster filesystems may call this function with a negative, hashed dentry.
  2483. * In that case, we know that the inode will be a regular file, and also this
  2484. * will only occur during atomic_open. So we need to check for the dentry
  2485. * being already hashed only in the final case.
  2486. */
  2487. struct dentry *d_splice_alias(struct inode *inode, struct dentry *dentry)
  2488. {
  2489. if (IS_ERR(inode))
  2490. return ERR_CAST(inode);
  2491. BUG_ON(!d_unhashed(dentry));
  2492. if (!inode) {
  2493. __d_instantiate(dentry, NULL);
  2494. goto out;
  2495. }
  2496. spin_lock(&inode->i_lock);
  2497. if (S_ISDIR(inode->i_mode)) {
  2498. struct dentry *new = __d_find_any_alias(inode);
  2499. if (unlikely(new)) {
  2500. write_seqlock(&rename_lock);
  2501. if (unlikely(d_ancestor(new, dentry))) {
  2502. write_sequnlock(&rename_lock);
  2503. spin_unlock(&inode->i_lock);
  2504. dput(new);
  2505. new = ERR_PTR(-ELOOP);
  2506. pr_warn_ratelimited(
  2507. "VFS: Lookup of '%s' in %s %s"
  2508. " would have caused loop\n",
  2509. dentry->d_name.name,
  2510. inode->i_sb->s_type->name,
  2511. inode->i_sb->s_id);
  2512. } else if (!IS_ROOT(new)) {
  2513. int err = __d_unalias(inode, dentry, new);
  2514. write_sequnlock(&rename_lock);
  2515. if (err) {
  2516. dput(new);
  2517. new = ERR_PTR(err);
  2518. }
  2519. } else {
  2520. __d_move(new, dentry, false);
  2521. write_sequnlock(&rename_lock);
  2522. spin_unlock(&inode->i_lock);
  2523. security_d_instantiate(new, inode);
  2524. }
  2525. iput(inode);
  2526. return new;
  2527. }
  2528. }
  2529. /* already taking inode->i_lock, so d_add() by hand */
  2530. __d_instantiate(dentry, inode);
  2531. spin_unlock(&inode->i_lock);
  2532. out:
  2533. security_d_instantiate(dentry, inode);
  2534. d_rehash(dentry);
  2535. return NULL;
  2536. }
  2537. EXPORT_SYMBOL(d_splice_alias);
  2538. static int prepend(char **buffer, int *buflen, const char *str, int namelen)
  2539. {
  2540. *buflen -= namelen;
  2541. if (*buflen < 0)
  2542. return -ENAMETOOLONG;
  2543. *buffer -= namelen;
  2544. memcpy(*buffer, str, namelen);
  2545. return 0;
  2546. }
  2547. /**
  2548. * prepend_name - prepend a pathname in front of current buffer pointer
  2549. * @buffer: buffer pointer
  2550. * @buflen: allocated length of the buffer
  2551. * @name: name string and length qstr structure
  2552. *
  2553. * With RCU path tracing, it may race with d_move(). Use ACCESS_ONCE() to
  2554. * make sure that either the old or the new name pointer and length are
  2555. * fetched. However, there may be mismatch between length and pointer.
  2556. * The length cannot be trusted, we need to copy it byte-by-byte until
  2557. * the length is reached or a null byte is found. It also prepends "/" at
  2558. * the beginning of the name. The sequence number check at the caller will
  2559. * retry it again when a d_move() does happen. So any garbage in the buffer
  2560. * due to mismatched pointer and length will be discarded.
  2561. *
  2562. * Data dependency barrier is needed to make sure that we see that terminating
  2563. * NUL. Alpha strikes again, film at 11...
  2564. */
  2565. static int prepend_name(char **buffer, int *buflen, struct qstr *name)
  2566. {
  2567. const char *dname = ACCESS_ONCE(name->name);
  2568. u32 dlen = ACCESS_ONCE(name->len);
  2569. char *p;
  2570. smp_read_barrier_depends();
  2571. *buflen -= dlen + 1;
  2572. if (*buflen < 0)
  2573. return -ENAMETOOLONG;
  2574. p = *buffer -= dlen + 1;
  2575. *p++ = '/';
  2576. while (dlen--) {
  2577. char c = *dname++;
  2578. if (!c)
  2579. break;
  2580. *p++ = c;
  2581. }
  2582. return 0;
  2583. }
  2584. /**
  2585. * prepend_path - Prepend path string to a buffer
  2586. * @path: the dentry/vfsmount to report
  2587. * @root: root vfsmnt/dentry
  2588. * @buffer: pointer to the end of the buffer
  2589. * @buflen: pointer to buffer length
  2590. *
  2591. * The function will first try to write out the pathname without taking any
  2592. * lock other than the RCU read lock to make sure that dentries won't go away.
  2593. * It only checks the sequence number of the global rename_lock as any change
  2594. * in the dentry's d_seq will be preceded by changes in the rename_lock
  2595. * sequence number. If the sequence number had been changed, it will restart
  2596. * the whole pathname back-tracing sequence again by taking the rename_lock.
  2597. * In this case, there is no need to take the RCU read lock as the recursive
  2598. * parent pointer references will keep the dentry chain alive as long as no
  2599. * rename operation is performed.
  2600. */
  2601. static int prepend_path(const struct path *path,
  2602. const struct path *root,
  2603. char **buffer, int *buflen)
  2604. {
  2605. struct dentry *dentry;
  2606. struct vfsmount *vfsmnt;
  2607. struct mount *mnt;
  2608. int error = 0;
  2609. unsigned seq, m_seq = 0;
  2610. char *bptr;
  2611. int blen;
  2612. rcu_read_lock();
  2613. restart_mnt:
  2614. read_seqbegin_or_lock(&mount_lock, &m_seq);
  2615. seq = 0;
  2616. rcu_read_lock();
  2617. restart:
  2618. bptr = *buffer;
  2619. blen = *buflen;
  2620. error = 0;
  2621. dentry = path->dentry;
  2622. vfsmnt = path->mnt;
  2623. mnt = real_mount(vfsmnt);
  2624. read_seqbegin_or_lock(&rename_lock, &seq);
  2625. while (dentry != root->dentry || vfsmnt != root->mnt) {
  2626. struct dentry * parent;
  2627. if (dentry == vfsmnt->mnt_root || IS_ROOT(dentry)) {
  2628. struct mount *parent = ACCESS_ONCE(mnt->mnt_parent);
  2629. /* Global root? */
  2630. if (mnt != parent) {
  2631. dentry = ACCESS_ONCE(mnt->mnt_mountpoint);
  2632. mnt = parent;
  2633. vfsmnt = &mnt->mnt;
  2634. continue;
  2635. }
  2636. if (!error)
  2637. error = is_mounted(vfsmnt) ? 1 : 2;
  2638. break;
  2639. }
  2640. parent = dentry->d_parent;
  2641. prefetch(parent);
  2642. error = prepend_name(&bptr, &blen, &dentry->d_name);
  2643. if (error)
  2644. break;
  2645. dentry = parent;
  2646. }
  2647. if (!(seq & 1))
  2648. rcu_read_unlock();
  2649. if (need_seqretry(&rename_lock, seq)) {
  2650. seq = 1;
  2651. goto restart;
  2652. }
  2653. done_seqretry(&rename_lock, seq);
  2654. if (!(m_seq & 1))
  2655. rcu_read_unlock();
  2656. if (need_seqretry(&mount_lock, m_seq)) {
  2657. m_seq = 1;
  2658. goto restart_mnt;
  2659. }
  2660. done_seqretry(&mount_lock, m_seq);
  2661. if (error >= 0 && bptr == *buffer) {
  2662. if (--blen < 0)
  2663. error = -ENAMETOOLONG;
  2664. else
  2665. *--bptr = '/';
  2666. }
  2667. *buffer = bptr;
  2668. *buflen = blen;
  2669. return error;
  2670. }
  2671. /**
  2672. * __d_path - return the path of a dentry
  2673. * @path: the dentry/vfsmount to report
  2674. * @root: root vfsmnt/dentry
  2675. * @buf: buffer to return value in
  2676. * @buflen: buffer length
  2677. *
  2678. * Convert a dentry into an ASCII path name.
  2679. *
  2680. * Returns a pointer into the buffer or an error code if the
  2681. * path was too long.
  2682. *
  2683. * "buflen" should be positive.
  2684. *
  2685. * If the path is not reachable from the supplied root, return %NULL.
  2686. */
  2687. char *__d_path(const struct path *path,
  2688. const struct path *root,
  2689. char *buf, int buflen)
  2690. {
  2691. char *res = buf + buflen;
  2692. int error;
  2693. prepend(&res, &buflen, "\0", 1);
  2694. error = prepend_path(path, root, &res, &buflen);
  2695. if (error < 0)
  2696. return ERR_PTR(error);
  2697. if (error > 0)
  2698. return NULL;
  2699. return res;
  2700. }
  2701. char *d_absolute_path(const struct path *path,
  2702. char *buf, int buflen)
  2703. {
  2704. struct path root = {};
  2705. char *res = buf + buflen;
  2706. int error;
  2707. prepend(&res, &buflen, "\0", 1);
  2708. error = prepend_path(path, &root, &res, &buflen);
  2709. if (error > 1)
  2710. error = -EINVAL;
  2711. if (error < 0)
  2712. return ERR_PTR(error);
  2713. return res;
  2714. }
  2715. /*
  2716. * same as __d_path but appends "(deleted)" for unlinked files.
  2717. */
  2718. static int path_with_deleted(const struct path *path,
  2719. const struct path *root,
  2720. char **buf, int *buflen)
  2721. {
  2722. prepend(buf, buflen, "\0", 1);
  2723. if (d_unlinked(path->dentry)) {
  2724. int error = prepend(buf, buflen, " (deleted)", 10);
  2725. if (error)
  2726. return error;
  2727. }
  2728. return prepend_path(path, root, buf, buflen);
  2729. }
  2730. static int prepend_unreachable(char **buffer, int *buflen)
  2731. {
  2732. return prepend(buffer, buflen, "(unreachable)", 13);
  2733. }
  2734. static void get_fs_root_rcu(struct fs_struct *fs, struct path *root)
  2735. {
  2736. unsigned seq;
  2737. do {
  2738. seq = read_seqcount_begin(&fs->seq);
  2739. *root = fs->root;
  2740. } while (read_seqcount_retry(&fs->seq, seq));
  2741. }
  2742. /**
  2743. * d_path - return the path of a dentry
  2744. * @path: path to report
  2745. * @buf: buffer to return value in
  2746. * @buflen: buffer length
  2747. *
  2748. * Convert a dentry into an ASCII path name. If the entry has been deleted
  2749. * the string " (deleted)" is appended. Note that this is ambiguous.
  2750. *
  2751. * Returns a pointer into the buffer or an error code if the path was
  2752. * too long. Note: Callers should use the returned pointer, not the passed
  2753. * in buffer, to use the name! The implementation often starts at an offset
  2754. * into the buffer, and may leave 0 bytes at the start.
  2755. *
  2756. * "buflen" should be positive.
  2757. */
  2758. char *d_path(const struct path *path, char *buf, int buflen)
  2759. {
  2760. char *res = buf + buflen;
  2761. struct path root;
  2762. int error;
  2763. /*
  2764. * We have various synthetic filesystems that never get mounted. On
  2765. * these filesystems dentries are never used for lookup purposes, and
  2766. * thus don't need to be hashed. They also don't need a name until a
  2767. * user wants to identify the object in /proc/pid/fd/. The little hack
  2768. * below allows us to generate a name for these objects on demand:
  2769. *
  2770. * Some pseudo inodes are mountable. When they are mounted
  2771. * path->dentry == path->mnt->mnt_root. In that case don't call d_dname
  2772. * and instead have d_path return the mounted path.
  2773. */
  2774. if (path->dentry->d_op && path->dentry->d_op->d_dname &&
  2775. (!IS_ROOT(path->dentry) || path->dentry != path->mnt->mnt_root))
  2776. return path->dentry->d_op->d_dname(path->dentry, buf, buflen);
  2777. rcu_read_lock();
  2778. get_fs_root_rcu(current->fs, &root);
  2779. error = path_with_deleted(path, &root, &res, &buflen);
  2780. rcu_read_unlock();
  2781. if (error < 0)
  2782. res = ERR_PTR(error);
  2783. return res;
  2784. }
  2785. EXPORT_SYMBOL(d_path);
  2786. /*
  2787. * Helper function for dentry_operations.d_dname() members
  2788. */
  2789. char *dynamic_dname(struct dentry *dentry, char *buffer, int buflen,
  2790. const char *fmt, ...)
  2791. {
  2792. va_list args;
  2793. char temp[64];
  2794. int sz;
  2795. va_start(args, fmt);
  2796. sz = vsnprintf(temp, sizeof(temp), fmt, args) + 1;
  2797. va_end(args);
  2798. if (sz > sizeof(temp) || sz > buflen)
  2799. return ERR_PTR(-ENAMETOOLONG);
  2800. buffer += buflen - sz;
  2801. return memcpy(buffer, temp, sz);
  2802. }
  2803. char *simple_dname(struct dentry *dentry, char *buffer, int buflen)
  2804. {
  2805. char *end = buffer + buflen;
  2806. /* these dentries are never renamed, so d_lock is not needed */
  2807. if (prepend(&end, &buflen, " (deleted)", 11) ||
  2808. prepend(&end, &buflen, dentry->d_name.name, dentry->d_name.len) ||
  2809. prepend(&end, &buflen, "/", 1))
  2810. end = ERR_PTR(-ENAMETOOLONG);
  2811. return end;
  2812. }
  2813. EXPORT_SYMBOL(simple_dname);
  2814. /*
  2815. * Write full pathname from the root of the filesystem into the buffer.
  2816. */
  2817. static char *__dentry_path(struct dentry *d, char *buf, int buflen)
  2818. {
  2819. struct dentry *dentry;
  2820. char *end, *retval;
  2821. int len, seq = 0;
  2822. int error = 0;
  2823. if (buflen < 2)
  2824. goto Elong;
  2825. rcu_read_lock();
  2826. restart:
  2827. dentry = d;
  2828. end = buf + buflen;
  2829. len = buflen;
  2830. prepend(&end, &len, "\0", 1);
  2831. /* Get '/' right */
  2832. retval = end-1;
  2833. *retval = '/';
  2834. read_seqbegin_or_lock(&rename_lock, &seq);
  2835. while (!IS_ROOT(dentry)) {
  2836. struct dentry *parent = dentry->d_parent;
  2837. prefetch(parent);
  2838. error = prepend_name(&end, &len, &dentry->d_name);
  2839. if (error)
  2840. break;
  2841. retval = end;
  2842. dentry = parent;
  2843. }
  2844. if (!(seq & 1))
  2845. rcu_read_unlock();
  2846. if (need_seqretry(&rename_lock, seq)) {
  2847. seq = 1;
  2848. goto restart;
  2849. }
  2850. done_seqretry(&rename_lock, seq);
  2851. if (error)
  2852. goto Elong;
  2853. return retval;
  2854. Elong:
  2855. return ERR_PTR(-ENAMETOOLONG);
  2856. }
  2857. char *dentry_path_raw(struct dentry *dentry, char *buf, int buflen)
  2858. {
  2859. return __dentry_path(dentry, buf, buflen);
  2860. }
  2861. EXPORT_SYMBOL(dentry_path_raw);
  2862. char *dentry_path(struct dentry *dentry, char *buf, int buflen)
  2863. {
  2864. char *p = NULL;
  2865. char *retval;
  2866. if (d_unlinked(dentry)) {
  2867. p = buf + buflen;
  2868. if (prepend(&p, &buflen, "//deleted", 10) != 0)
  2869. goto Elong;
  2870. buflen++;
  2871. }
  2872. retval = __dentry_path(dentry, buf, buflen);
  2873. if (!IS_ERR(retval) && p)
  2874. *p = '/'; /* restore '/' overriden with '\0' */
  2875. return retval;
  2876. Elong:
  2877. return ERR_PTR(-ENAMETOOLONG);
  2878. }
  2879. static void get_fs_root_and_pwd_rcu(struct fs_struct *fs, struct path *root,
  2880. struct path *pwd)
  2881. {
  2882. unsigned seq;
  2883. do {
  2884. seq = read_seqcount_begin(&fs->seq);
  2885. *root = fs->root;
  2886. *pwd = fs->pwd;
  2887. } while (read_seqcount_retry(&fs->seq, seq));
  2888. }
  2889. /*
  2890. * NOTE! The user-level library version returns a
  2891. * character pointer. The kernel system call just
  2892. * returns the length of the buffer filled (which
  2893. * includes the ending '\0' character), or a negative
  2894. * error value. So libc would do something like
  2895. *
  2896. * char *getcwd(char * buf, size_t size)
  2897. * {
  2898. * int retval;
  2899. *
  2900. * retval = sys_getcwd(buf, size);
  2901. * if (retval >= 0)
  2902. * return buf;
  2903. * errno = -retval;
  2904. * return NULL;
  2905. * }
  2906. */
  2907. SYSCALL_DEFINE2(getcwd, char __user *, buf, unsigned long, size)
  2908. {
  2909. int error;
  2910. struct path pwd, root;
  2911. char *page = __getname();
  2912. if (!page)
  2913. return -ENOMEM;
  2914. rcu_read_lock();
  2915. get_fs_root_and_pwd_rcu(current->fs, &root, &pwd);
  2916. error = -ENOENT;
  2917. if (!d_unlinked(pwd.dentry)) {
  2918. unsigned long len;
  2919. char *cwd = page + PATH_MAX;
  2920. int buflen = PATH_MAX;
  2921. prepend(&cwd, &buflen, "\0", 1);
  2922. error = prepend_path(&pwd, &root, &cwd, &buflen);
  2923. rcu_read_unlock();
  2924. if (error < 0)
  2925. goto out;
  2926. /* Unreachable from current root */
  2927. if (error > 0) {
  2928. error = prepend_unreachable(&cwd, &buflen);
  2929. if (error)
  2930. goto out;
  2931. }
  2932. error = -ERANGE;
  2933. len = PATH_MAX + page - cwd;
  2934. if (len <= size) {
  2935. error = len;
  2936. if (copy_to_user(buf, cwd, len))
  2937. error = -EFAULT;
  2938. }
  2939. } else {
  2940. rcu_read_unlock();
  2941. }
  2942. out:
  2943. __putname(page);
  2944. return error;
  2945. }
  2946. /*
  2947. * Test whether new_dentry is a subdirectory of old_dentry.
  2948. *
  2949. * Trivially implemented using the dcache structure
  2950. */
  2951. /**
  2952. * is_subdir - is new dentry a subdirectory of old_dentry
  2953. * @new_dentry: new dentry
  2954. * @old_dentry: old dentry
  2955. *
  2956. * Returns 1 if new_dentry is a subdirectory of the parent (at any depth).
  2957. * Returns 0 otherwise.
  2958. * Caller must ensure that "new_dentry" is pinned before calling is_subdir()
  2959. */
  2960. int is_subdir(struct dentry *new_dentry, struct dentry *old_dentry)
  2961. {
  2962. int result;
  2963. unsigned seq;
  2964. if (new_dentry == old_dentry)
  2965. return 1;
  2966. do {
  2967. /* for restarting inner loop in case of seq retry */
  2968. seq = read_seqbegin(&rename_lock);
  2969. /*
  2970. * Need rcu_readlock to protect against the d_parent trashing
  2971. * due to d_move
  2972. */
  2973. rcu_read_lock();
  2974. if (d_ancestor(old_dentry, new_dentry))
  2975. result = 1;
  2976. else
  2977. result = 0;
  2978. rcu_read_unlock();
  2979. } while (read_seqretry(&rename_lock, seq));
  2980. return result;
  2981. }
  2982. static enum d_walk_ret d_genocide_kill(void *data, struct dentry *dentry)
  2983. {
  2984. struct dentry *root = data;
  2985. if (dentry != root) {
  2986. if (d_unhashed(dentry) || !dentry->d_inode)
  2987. return D_WALK_SKIP;
  2988. if (!(dentry->d_flags & DCACHE_GENOCIDE)) {
  2989. dentry->d_flags |= DCACHE_GENOCIDE;
  2990. dentry->d_lockref.count--;
  2991. }
  2992. }
  2993. return D_WALK_CONTINUE;
  2994. }
  2995. void d_genocide(struct dentry *parent)
  2996. {
  2997. d_walk(parent, parent, d_genocide_kill, NULL);
  2998. }
  2999. void d_tmpfile(struct dentry *dentry, struct inode *inode)
  3000. {
  3001. inode_dec_link_count(inode);
  3002. BUG_ON(dentry->d_name.name != dentry->d_iname ||
  3003. !hlist_unhashed(&dentry->d_u.d_alias) ||
  3004. !d_unlinked(dentry));
  3005. spin_lock(&dentry->d_parent->d_lock);
  3006. spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
  3007. dentry->d_name.len = sprintf(dentry->d_iname, "#%llu",
  3008. (unsigned long long)inode->i_ino);
  3009. spin_unlock(&dentry->d_lock);
  3010. spin_unlock(&dentry->d_parent->d_lock);
  3011. d_instantiate(dentry, inode);
  3012. }
  3013. EXPORT_SYMBOL(d_tmpfile);
  3014. static __initdata unsigned long dhash_entries;
  3015. static int __init set_dhash_entries(char *str)
  3016. {
  3017. if (!str)
  3018. return 0;
  3019. dhash_entries = simple_strtoul(str, &str, 0);
  3020. return 1;
  3021. }
  3022. __setup("dhash_entries=", set_dhash_entries);
  3023. static void __init dcache_init_early(void)
  3024. {
  3025. unsigned int loop;
  3026. /* If hashes are distributed across NUMA nodes, defer
  3027. * hash allocation until vmalloc space is available.
  3028. */
  3029. if (hashdist)
  3030. return;
  3031. dentry_hashtable =
  3032. alloc_large_system_hash("Dentry cache",
  3033. sizeof(struct hlist_bl_head),
  3034. dhash_entries,
  3035. 13,
  3036. HASH_EARLY,
  3037. &d_hash_shift,
  3038. &d_hash_mask,
  3039. 0,
  3040. 0);
  3041. for (loop = 0; loop < (1U << d_hash_shift); loop++)
  3042. INIT_HLIST_BL_HEAD(dentry_hashtable + loop);
  3043. }
  3044. static void __init dcache_init(void)
  3045. {
  3046. unsigned int loop;
  3047. /*
  3048. * A constructor could be added for stable state like the lists,
  3049. * but it is probably not worth it because of the cache nature
  3050. * of the dcache.
  3051. */
  3052. dentry_cache = KMEM_CACHE(dentry,
  3053. SLAB_RECLAIM_ACCOUNT|SLAB_PANIC|SLAB_MEM_SPREAD);
  3054. /* Hash may have been set up in dcache_init_early */
  3055. if (!hashdist)
  3056. return;
  3057. dentry_hashtable =
  3058. alloc_large_system_hash("Dentry cache",
  3059. sizeof(struct hlist_bl_head),
  3060. dhash_entries,
  3061. 13,
  3062. 0,
  3063. &d_hash_shift,
  3064. &d_hash_mask,
  3065. 0,
  3066. 0);
  3067. for (loop = 0; loop < (1U << d_hash_shift); loop++)
  3068. INIT_HLIST_BL_HEAD(dentry_hashtable + loop);
  3069. }
  3070. /* SLAB cache for __getname() consumers */
  3071. struct kmem_cache *names_cachep __read_mostly;
  3072. EXPORT_SYMBOL(names_cachep);
  3073. EXPORT_SYMBOL(d_genocide);
  3074. void __init vfs_caches_init_early(void)
  3075. {
  3076. dcache_init_early();
  3077. inode_init_early();
  3078. }
  3079. void __init vfs_caches_init(unsigned long mempages)
  3080. {
  3081. unsigned long reserve;
  3082. /* Base hash sizes on available memory, with a reserve equal to
  3083. 150% of current kernel size */
  3084. reserve = min((mempages - nr_free_pages()) * 3/2, mempages - 1);
  3085. mempages -= reserve;
  3086. names_cachep = kmem_cache_create("names_cache", PATH_MAX, 0,
  3087. SLAB_HWCACHE_ALIGN|SLAB_PANIC, NULL);
  3088. dcache_init();
  3089. inode_init();
  3090. files_init(mempages);
  3091. mnt_init();
  3092. bdev_cache_init();
  3093. chrdev_init();
  3094. }