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