2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 1989, 1993, 1995
5 * The Regents of the University of California. All rights reserved.
7 * This code is derived from software contributed to Berkeley by
8 * Poul-Henning Kamp of the FreeBSD Project.
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 3. Neither the name of the University nor the names of its contributors
19 * may be used to endorse or promote products derived from this software
20 * without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 * @(#)vfs_cache.c 8.5 (Berkeley) 3/22/95
37 #include <sys/cdefs.h>
38 __FBSDID("$FreeBSD$");
41 #include "opt_ktrace.h"
43 #include <sys/param.h>
44 #include <sys/systm.h>
45 #include <sys/capsicum.h>
46 #include <sys/counter.h>
47 #include <sys/filedesc.h>
48 #include <sys/fnv_hash.h>
49 #include <sys/kernel.h>
52 #include <sys/malloc.h>
53 #include <sys/fcntl.h>
55 #include <sys/mount.h>
56 #include <sys/namei.h>
62 #include <sys/syscallsubr.h>
63 #include <sys/sysctl.h>
64 #include <sys/sysproto.h>
65 #include <sys/vnode.h>
68 #include <sys/ktrace.h>
71 #include <machine/_inttypes.h>
74 #include <sys/capsicum.h>
76 #include <security/audit/audit.h>
77 #include <security/mac/mac_framework.h>
86 * High level overview of name caching in the VFS layer.
88 * Originally caching was implemented as part of UFS, later extracted to allow
89 * use by other filesystems. A decision was made to make it optional and
90 * completely detached from the rest of the kernel, which comes with limitations
91 * outlined near the end of this comment block.
93 * This fundamental choice needs to be revisited. In the meantime, the current
94 * state is described below. Significance of all notable routines is explained
95 * in comments placed above their implementation. Scattered thoroughout the
96 * file are TODO comments indicating shortcomings which can be fixed without
97 * reworking everything (most of the fixes will likely be reusable). Various
98 * details are omitted from this explanation to not clutter the overview, they
99 * have to be checked by reading the code and associated commentary.
101 * Keep in mind that it's individual path components which are cached, not full
102 * paths. That is, for a fully cached path "foo/bar/baz" there are 3 entries,
105 * I. Data organization
107 * Entries are described by "struct namecache" objects and stored in a hash
108 * table. See cache_get_hash for more information.
110 * "struct vnode" contains pointers to source entries (names which can be found
111 * when traversing through said vnode), destination entries (names of that
112 * vnode (see "Limitations" for a breakdown on the subject) and a pointer to
115 * The (directory vnode; name) tuple reliably determines the target entry if
118 * Since there are no small locks at this time (all are 32 bytes in size on
119 * LP64), the code works around the problem by introducing lock arrays to
120 * protect hash buckets and vnode lists.
122 * II. Filesystem integration
124 * Filesystems participating in name caching do the following:
125 * - set vop_lookup routine to vfs_cache_lookup
126 * - set vop_cachedlookup to whatever can perform the lookup if the above fails
127 * - if they support lockless lookup (see below), vop_fplookup_vexec and
128 * vop_fplookup_symlink are set along with the MNTK_FPLOOKUP flag on the
130 * - call cache_purge or cache_vop_* routines to eliminate stale entries as
132 * - call cache_enter to add entries depending on the MAKEENTRY flag
134 * With the above in mind, there are 2 entry points when doing lookups:
135 * - ... -> namei -> cache_fplookup -- this is the default
136 * - ... -> VOP_LOOKUP -> vfs_cache_lookup -- normally only called by namei
137 * should the above fail
139 * Example code flow how an entry is added:
140 * ... -> namei -> cache_fplookup -> cache_fplookup_noentry -> VOP_LOOKUP ->
141 * vfs_cache_lookup -> VOP_CACHEDLOOKUP -> ufs_lookup_ino -> cache_enter
143 * III. Performance considerations
145 * For lockless case forward lookup avoids any writes to shared areas apart
146 * from the terminal path component. In other words non-modifying lookups of
147 * different files don't suffer any scalability problems in the namecache.
148 * Looking up the same file is limited by VFS and goes beyond the scope of this
151 * At least on amd64 the single-threaded bottleneck for long paths is hashing
152 * (see cache_get_hash). There are cases where the code issues acquire fence
153 * multiple times, they can be combined on architectures which suffer from it.
155 * For locked case each encountered vnode has to be referenced and locked in
156 * order to be handed out to the caller (normally that's namei). This
157 * introduces significant hit single-threaded and serialization multi-threaded.
159 * Reverse lookup (e.g., "getcwd") fully scales provided it is fully cached --
160 * avoids any writes to shared areas to any components.
162 * Unrelated insertions are partially serialized on updating the global entry
163 * counter and possibly serialized on colliding bucket or vnode locks.
167 * Note not everything has an explicit dtrace probe nor it should have, thus
168 * some of the one-liners below depend on implementation details.
172 * # Check what lookups failed to be handled in a lockless manner. Column 1 is
173 * # line number, column 2 is status code (see cache_fpl_status)
174 * dtrace -n 'vfs:fplookup:lookup:done { @[arg1, arg2] = count(); }'
176 * # Lengths of names added by binary name
177 * dtrace -n 'fbt::cache_enter_time:entry { @[execname] = quantize(args[2]->cn_namelen); }'
179 * # Same as above but only those which exceed 64 characters
180 * dtrace -n 'fbt::cache_enter_time:entry /args[2]->cn_namelen > 64/ { @[execname] = quantize(args[2]->cn_namelen); }'
182 * # Who is performing lookups with spurious slashes (e.g., "foo//bar") and what
184 * dtrace -n 'fbt::cache_fplookup_skip_slashes:entry { @[execname, stringof(args[0]->cnp->cn_pnbuf)] = count(); }'
186 * V. Limitations and implementation defects
188 * - since it is possible there is no entry for an open file, tools like
189 * "procstat" may fail to resolve fd -> vnode -> path to anything
190 * - even if a filesystem adds an entry, it may get purged (e.g., due to memory
191 * shortage) in which case the above problem applies
192 * - hardlinks are not tracked, thus if a vnode is reachable in more than one
193 * way, resolving a name may return a different path than the one used to
194 * open it (even if said path is still valid)
195 * - by default entries are not added for newly created files
196 * - adding an entry may need to evict negative entry first, which happens in 2
197 * distinct places (evicting on lookup, adding in a later VOP) making it
198 * impossible to simply reuse it
199 * - there is a simple scheme to evict negative entries as the cache is approaching
200 * its capacity, but it is very unclear if doing so is a good idea to begin with
201 * - vnodes are subject to being recycled even if target inode is left in memory,
202 * which loses the name cache entries when it perhaps should not. in case of tmpfs
203 * names get duplicated -- kept by filesystem itself and namecache separately
204 * - struct namecache has a fixed size and comes in 2 variants, often wasting space.
205 * now hard to replace with malloc due to dependence on SMR.
206 * - lack of better integration with the kernel also turns nullfs into a layered
207 * filesystem instead of something which can take advantage of caching
210 static SYSCTL_NODE(_vfs, OID_AUTO, cache, CTLFLAG_RW | CTLFLAG_MPSAFE, 0,
213 SDT_PROVIDER_DECLARE(vfs);
214 SDT_PROBE_DEFINE3(vfs, namecache, enter, done, "struct vnode *", "char *",
216 SDT_PROBE_DEFINE3(vfs, namecache, enter, duplicate, "struct vnode *", "char *",
218 SDT_PROBE_DEFINE2(vfs, namecache, enter_negative, done, "struct vnode *",
220 SDT_PROBE_DEFINE2(vfs, namecache, fullpath_smr, hit, "struct vnode *",
222 SDT_PROBE_DEFINE4(vfs, namecache, fullpath_smr, miss, "struct vnode *",
223 "struct namecache *", "int", "int");
224 SDT_PROBE_DEFINE1(vfs, namecache, fullpath, entry, "struct vnode *");
225 SDT_PROBE_DEFINE3(vfs, namecache, fullpath, hit, "struct vnode *",
226 "char *", "struct vnode *");
227 SDT_PROBE_DEFINE1(vfs, namecache, fullpath, miss, "struct vnode *");
228 SDT_PROBE_DEFINE3(vfs, namecache, fullpath, return, "int",
229 "struct vnode *", "char *");
230 SDT_PROBE_DEFINE3(vfs, namecache, lookup, hit, "struct vnode *", "char *",
232 SDT_PROBE_DEFINE2(vfs, namecache, lookup, hit__negative,
233 "struct vnode *", "char *");
234 SDT_PROBE_DEFINE2(vfs, namecache, lookup, miss, "struct vnode *",
236 SDT_PROBE_DEFINE2(vfs, namecache, removecnp, hit, "struct vnode *",
237 "struct componentname *");
238 SDT_PROBE_DEFINE2(vfs, namecache, removecnp, miss, "struct vnode *",
239 "struct componentname *");
240 SDT_PROBE_DEFINE3(vfs, namecache, purge, done, "struct vnode *", "size_t", "size_t");
241 SDT_PROBE_DEFINE1(vfs, namecache, purge, batch, "int");
242 SDT_PROBE_DEFINE1(vfs, namecache, purge_negative, done, "struct vnode *");
243 SDT_PROBE_DEFINE1(vfs, namecache, purgevfs, done, "struct mount *");
244 SDT_PROBE_DEFINE3(vfs, namecache, zap, done, "struct vnode *", "char *",
246 SDT_PROBE_DEFINE2(vfs, namecache, zap_negative, done, "struct vnode *",
248 SDT_PROBE_DEFINE2(vfs, namecache, evict_negative, done, "struct vnode *",
250 SDT_PROBE_DEFINE1(vfs, namecache, symlink, alloc__fail, "size_t");
252 SDT_PROBE_DEFINE3(vfs, fplookup, lookup, done, "struct nameidata", "int", "bool");
253 SDT_PROBE_DECLARE(vfs, namei, lookup, entry);
254 SDT_PROBE_DECLARE(vfs, namei, lookup, return);
256 static char __read_frequently cache_fast_lookup_enabled = true;
259 * This structure describes the elements in the cache of recent
260 * names looked up by namei.
266 _Static_assert(sizeof(struct negstate) <= sizeof(struct vnode *),
267 "the state must fit in a union with a pointer without growing it");
270 LIST_ENTRY(namecache) nc_src; /* source vnode list */
271 TAILQ_ENTRY(namecache) nc_dst; /* destination vnode list */
272 CK_SLIST_ENTRY(namecache) nc_hash;/* hash chain */
273 struct vnode *nc_dvp; /* vnode of parent of name */
275 struct vnode *nu_vp; /* vnode the name refers to */
276 struct negstate nu_neg;/* negative entry state */
278 u_char nc_flag; /* flag bits */
279 u_char nc_nlen; /* length of name */
280 char nc_name[0]; /* segment name + nul */
284 * struct namecache_ts repeats struct namecache layout up to the
286 * struct namecache_ts is used in place of struct namecache when time(s) need
287 * to be stored. The nc_dotdottime field is used when a cache entry is mapping
288 * both a non-dotdot directory name plus dotdot for the directory's
291 * See below for alignment requirement.
293 struct namecache_ts {
294 struct timespec nc_time; /* timespec provided by fs */
295 struct timespec nc_dotdottime; /* dotdot timespec provided by fs */
296 int nc_ticks; /* ticks value when entry was added */
298 struct namecache nc_nc;
301 TAILQ_HEAD(cache_freebatch, namecache);
304 * At least mips n32 performs 64-bit accesses to timespec as found
305 * in namecache_ts and requires them to be aligned. Since others
306 * may be in the same spot suffer a little bit and enforce the
307 * alignment for everyone. Note this is a nop for 64-bit platforms.
309 #define CACHE_ZONE_ALIGNMENT UMA_ALIGNOF(time_t)
312 * TODO: the initial value of CACHE_PATH_CUTOFF was inherited from the
313 * 4.4 BSD codebase. Later on struct namecache was tweaked to become
314 * smaller and the value was bumped to retain the total size, but it
315 * was never re-evaluated for suitability. A simple test counting
316 * lengths during package building shows that the value of 45 covers
317 * about 86% of all added entries, reaching 99% at 65.
319 * Regardless of the above, use of dedicated zones instead of malloc may be
320 * inducing additional waste. This may be hard to address as said zones are
321 * tied to VFS SMR. Even if retaining them, the current split should be
325 #define CACHE_PATH_CUTOFF 45
326 #define CACHE_LARGE_PAD 6
328 #define CACHE_PATH_CUTOFF 41
329 #define CACHE_LARGE_PAD 2
332 #define CACHE_ZONE_SMALL_SIZE (offsetof(struct namecache, nc_name) + CACHE_PATH_CUTOFF + 1)
333 #define CACHE_ZONE_SMALL_TS_SIZE (offsetof(struct namecache_ts, nc_nc) + CACHE_ZONE_SMALL_SIZE)
334 #define CACHE_ZONE_LARGE_SIZE (offsetof(struct namecache, nc_name) + NAME_MAX + 1 + CACHE_LARGE_PAD)
335 #define CACHE_ZONE_LARGE_TS_SIZE (offsetof(struct namecache_ts, nc_nc) + CACHE_ZONE_LARGE_SIZE)
337 _Static_assert((CACHE_ZONE_SMALL_SIZE % (CACHE_ZONE_ALIGNMENT + 1)) == 0, "bad zone size");
338 _Static_assert((CACHE_ZONE_SMALL_TS_SIZE % (CACHE_ZONE_ALIGNMENT + 1)) == 0, "bad zone size");
339 _Static_assert((CACHE_ZONE_LARGE_SIZE % (CACHE_ZONE_ALIGNMENT + 1)) == 0, "bad zone size");
340 _Static_assert((CACHE_ZONE_LARGE_TS_SIZE % (CACHE_ZONE_ALIGNMENT + 1)) == 0, "bad zone size");
342 #define nc_vp n_un.nu_vp
343 #define nc_neg n_un.nu_neg
346 * Flags in namecache.nc_flag
348 #define NCF_WHITE 0x01
349 #define NCF_ISDOTDOT 0x02
352 #define NCF_DVDROP 0x10
353 #define NCF_NEGATIVE 0x20
354 #define NCF_INVALID 0x40
358 * Flags in negstate.neg_flag
362 static bool cache_neg_evict_cond(u_long lnumcache);
365 * Mark an entry as invalid.
367 * This is called before it starts getting deconstructed.
370 cache_ncp_invalidate(struct namecache *ncp)
373 KASSERT((ncp->nc_flag & NCF_INVALID) == 0,
374 ("%s: entry %p already invalid", __func__, ncp));
375 atomic_store_char(&ncp->nc_flag, ncp->nc_flag | NCF_INVALID);
376 atomic_thread_fence_rel();
380 * Check whether the entry can be safely used.
382 * All places which elide locks are supposed to call this after they are
383 * done with reading from an entry.
385 #define cache_ncp_canuse(ncp) ({ \
386 struct namecache *_ncp = (ncp); \
389 atomic_thread_fence_acq(); \
390 _nc_flag = atomic_load_char(&_ncp->nc_flag); \
391 __predict_true((_nc_flag & (NCF_INVALID | NCF_WIP)) == 0); \
395 * Like the above but also checks NCF_WHITE.
397 #define cache_fpl_neg_ncp_canuse(ncp) ({ \
398 struct namecache *_ncp = (ncp); \
401 atomic_thread_fence_acq(); \
402 _nc_flag = atomic_load_char(&_ncp->nc_flag); \
403 __predict_true((_nc_flag & (NCF_INVALID | NCF_WIP | NCF_WHITE)) == 0); \
408 static SYSCTL_NODE(_vfs_cache, OID_AUTO, param, CTLFLAG_RW | CTLFLAG_MPSAFE, 0,
409 "Name cache parameters");
411 static u_int __read_mostly ncsize; /* the size as computed on creation or resizing */
412 SYSCTL_UINT(_vfs_cache_param, OID_AUTO, size, CTLFLAG_RW, &ncsize, 0,
413 "Total namecache capacity");
415 u_int ncsizefactor = 2;
416 SYSCTL_UINT(_vfs_cache_param, OID_AUTO, sizefactor, CTLFLAG_RW, &ncsizefactor, 0,
417 "Size factor for namecache");
419 static u_long __read_mostly ncnegfactor = 5; /* ratio of negative entries */
420 SYSCTL_ULONG(_vfs_cache_param, OID_AUTO, negfactor, CTLFLAG_RW, &ncnegfactor, 0,
421 "Ratio of negative namecache entries");
424 * Negative entry % of namecache capacity above which automatic eviction is allowed.
426 * Check cache_neg_evict_cond for details.
428 static u_int ncnegminpct = 3;
430 static u_int __read_mostly neg_min; /* the above recomputed against ncsize */
431 SYSCTL_UINT(_vfs_cache_param, OID_AUTO, negmin, CTLFLAG_RD, &neg_min, 0,
432 "Negative entry count above which automatic eviction is allowed");
435 * Structures associated with name caching.
437 #define NCHHASH(hash) \
438 (&nchashtbl[(hash) & nchash])
439 static __read_mostly CK_SLIST_HEAD(nchashhead, namecache) *nchashtbl;/* Hash Table */
440 static u_long __read_mostly nchash; /* size of hash table */
441 SYSCTL_ULONG(_debug, OID_AUTO, nchash, CTLFLAG_RD, &nchash, 0,
442 "Size of namecache hash table");
443 static u_long __exclusive_cache_line numneg; /* number of negative entries allocated */
444 static u_long __exclusive_cache_line numcache;/* number of cache entries allocated */
446 struct nchstats nchstats; /* cache effectiveness statistics */
448 static bool __read_mostly cache_rename_add = true;
449 SYSCTL_BOOL(_vfs, OID_AUTO, cache_rename_add, CTLFLAG_RW,
450 &cache_rename_add, 0, "");
452 static u_int __exclusive_cache_line neg_cycle;
455 #define numneglists (ncneghash + 1)
458 struct mtx nl_evict_lock;
459 struct mtx nl_lock __aligned(CACHE_LINE_SIZE);
460 TAILQ_HEAD(, namecache) nl_list;
461 TAILQ_HEAD(, namecache) nl_hotlist;
463 } __aligned(CACHE_LINE_SIZE);
465 static struct neglist neglists[numneglists];
467 static inline struct neglist *
468 NCP2NEGLIST(struct namecache *ncp)
471 return (&neglists[(((uintptr_t)(ncp) >> 8) & ncneghash)]);
474 static inline struct negstate *
475 NCP2NEGSTATE(struct namecache *ncp)
478 MPASS(atomic_load_char(&ncp->nc_flag) & NCF_NEGATIVE);
479 return (&ncp->nc_neg);
482 #define numbucketlocks (ncbuckethash + 1)
483 static u_int __read_mostly ncbuckethash;
484 static struct mtx_padalign __read_mostly *bucketlocks;
485 #define HASH2BUCKETLOCK(hash) \
486 ((struct mtx *)(&bucketlocks[((hash) & ncbuckethash)]))
488 #define numvnodelocks (ncvnodehash + 1)
489 static u_int __read_mostly ncvnodehash;
490 static struct mtx __read_mostly *vnodelocks;
491 static inline struct mtx *
492 VP2VNODELOCK(struct vnode *vp)
495 return (&vnodelocks[(((uintptr_t)(vp) >> 8) & ncvnodehash)]);
499 cache_out_ts(struct namecache *ncp, struct timespec *tsp, int *ticksp)
501 struct namecache_ts *ncp_ts;
503 KASSERT((ncp->nc_flag & NCF_TS) != 0 ||
504 (tsp == NULL && ticksp == NULL),
510 ncp_ts = __containerof(ncp, struct namecache_ts, nc_nc);
511 *tsp = ncp_ts->nc_time;
512 *ticksp = ncp_ts->nc_ticks;
516 static int __read_mostly doingcache = 1; /* 1 => enable the cache */
517 SYSCTL_INT(_debug, OID_AUTO, vfscache, CTLFLAG_RW, &doingcache, 0,
518 "VFS namecache enabled");
521 /* Export size information to userland */
522 SYSCTL_INT(_debug_sizeof, OID_AUTO, namecache, CTLFLAG_RD, SYSCTL_NULL_INT_PTR,
523 sizeof(struct namecache), "sizeof(struct namecache)");
526 * The new name cache statistics
528 static SYSCTL_NODE(_vfs_cache, OID_AUTO, stats, CTLFLAG_RW | CTLFLAG_MPSAFE, 0,
529 "Name cache statistics");
531 #define STATNODE_ULONG(name, varname, descr) \
532 SYSCTL_ULONG(_vfs_cache_stats, OID_AUTO, name, CTLFLAG_RD, &varname, 0, descr);
533 #define STATNODE_COUNTER(name, varname, descr) \
534 static COUNTER_U64_DEFINE_EARLY(varname); \
535 SYSCTL_COUNTER_U64(_vfs_cache_stats, OID_AUTO, name, CTLFLAG_RD, &varname, \
537 STATNODE_ULONG(neg, numneg, "Number of negative cache entries");
538 STATNODE_ULONG(count, numcache, "Number of cache entries");
539 STATNODE_COUNTER(heldvnodes, numcachehv, "Number of namecache entries with vnodes held");
540 STATNODE_COUNTER(drops, numdrops, "Number of dropped entries due to reaching the limit");
541 STATNODE_COUNTER(dothits, dothits, "Number of '.' hits");
542 STATNODE_COUNTER(dotdothis, dotdothits, "Number of '..' hits");
543 STATNODE_COUNTER(miss, nummiss, "Number of cache misses");
544 STATNODE_COUNTER(misszap, nummisszap, "Number of cache misses we do not want to cache");
545 STATNODE_COUNTER(posszaps, numposzaps,
546 "Number of cache hits (positive) we do not want to cache");
547 STATNODE_COUNTER(poshits, numposhits, "Number of cache hits (positive)");
548 STATNODE_COUNTER(negzaps, numnegzaps,
549 "Number of cache hits (negative) we do not want to cache");
550 STATNODE_COUNTER(neghits, numneghits, "Number of cache hits (negative)");
551 /* These count for vn_getcwd(), too. */
552 STATNODE_COUNTER(fullpathcalls, numfullpathcalls, "Number of fullpath search calls");
553 STATNODE_COUNTER(fullpathfail1, numfullpathfail1, "Number of fullpath search errors (ENOTDIR)");
554 STATNODE_COUNTER(fullpathfail2, numfullpathfail2,
555 "Number of fullpath search errors (VOP_VPTOCNP failures)");
556 STATNODE_COUNTER(fullpathfail4, numfullpathfail4, "Number of fullpath search errors (ENOMEM)");
557 STATNODE_COUNTER(fullpathfound, numfullpathfound, "Number of successful fullpath calls");
558 STATNODE_COUNTER(symlinktoobig, symlinktoobig, "Number of times symlink did not fit the cache");
561 * Debug or developer statistics.
563 static SYSCTL_NODE(_vfs_cache, OID_AUTO, debug, CTLFLAG_RW | CTLFLAG_MPSAFE, 0,
564 "Name cache debugging");
565 #define DEBUGNODE_ULONG(name, varname, descr) \
566 SYSCTL_ULONG(_vfs_cache_debug, OID_AUTO, name, CTLFLAG_RD, &varname, 0, descr);
567 #define DEBUGNODE_COUNTER(name, varname, descr) \
568 static COUNTER_U64_DEFINE_EARLY(varname); \
569 SYSCTL_COUNTER_U64(_vfs_cache_debug, OID_AUTO, name, CTLFLAG_RD, &varname, \
571 DEBUGNODE_COUNTER(zap_bucket_relock_success, zap_bucket_relock_success,
572 "Number of successful removals after relocking");
573 static long zap_bucket_fail;
574 DEBUGNODE_ULONG(zap_bucket_fail, zap_bucket_fail, "");
575 static long zap_bucket_fail2;
576 DEBUGNODE_ULONG(zap_bucket_fail2, zap_bucket_fail2, "");
577 static long cache_lock_vnodes_cel_3_failures;
578 DEBUGNODE_ULONG(vnodes_cel_3_failures, cache_lock_vnodes_cel_3_failures,
579 "Number of times 3-way vnode locking failed");
581 static void cache_zap_locked(struct namecache *ncp);
582 static int vn_fullpath_any_smr(struct vnode *vp, struct vnode *rdir, char *buf,
583 char **retbuf, size_t *buflen, size_t addend);
584 static int vn_fullpath_any(struct vnode *vp, struct vnode *rdir, char *buf,
585 char **retbuf, size_t *buflen);
586 static int vn_fullpath_dir(struct vnode *vp, struct vnode *rdir, char *buf,
587 char **retbuf, size_t *len, size_t addend);
589 static MALLOC_DEFINE(M_VFSCACHE, "vfscache", "VFS name cache entries");
592 cache_assert_vlp_locked(struct mtx *vlp)
596 mtx_assert(vlp, MA_OWNED);
600 cache_assert_vnode_locked(struct vnode *vp)
604 vlp = VP2VNODELOCK(vp);
605 cache_assert_vlp_locked(vlp);
609 * Directory vnodes with entries are held for two reasons:
610 * 1. make them less of a target for reclamation in vnlru
611 * 2. suffer smaller performance penalty in locked lookup as requeieing is avoided
613 * It will be feasible to stop doing it altogether if all filesystems start
614 * supporting lockless lookup.
617 cache_hold_vnode(struct vnode *vp)
620 cache_assert_vnode_locked(vp);
621 VNPASS(LIST_EMPTY(&vp->v_cache_src), vp);
623 counter_u64_add(numcachehv, 1);
627 cache_drop_vnode(struct vnode *vp)
631 * Called after all locks are dropped, meaning we can't assert
632 * on the state of v_cache_src.
635 counter_u64_add(numcachehv, -1);
641 static uma_zone_t __read_mostly cache_zone_small;
642 static uma_zone_t __read_mostly cache_zone_small_ts;
643 static uma_zone_t __read_mostly cache_zone_large;
644 static uma_zone_t __read_mostly cache_zone_large_ts;
647 cache_symlink_alloc(size_t size, int flags)
650 if (size < CACHE_ZONE_SMALL_SIZE) {
651 return (uma_zalloc_smr(cache_zone_small, flags));
653 if (size < CACHE_ZONE_LARGE_SIZE) {
654 return (uma_zalloc_smr(cache_zone_large, flags));
656 counter_u64_add(symlinktoobig, 1);
657 SDT_PROBE1(vfs, namecache, symlink, alloc__fail, size);
662 cache_symlink_free(char *string, size_t size)
665 MPASS(string != NULL);
666 KASSERT(size < CACHE_ZONE_LARGE_SIZE,
667 ("%s: size %zu too big", __func__, size));
669 if (size < CACHE_ZONE_SMALL_SIZE) {
670 uma_zfree_smr(cache_zone_small, string);
673 if (size < CACHE_ZONE_LARGE_SIZE) {
674 uma_zfree_smr(cache_zone_large, string);
677 __assert_unreachable();
680 static struct namecache *
681 cache_alloc_uma(int len, bool ts)
683 struct namecache_ts *ncp_ts;
684 struct namecache *ncp;
686 if (__predict_false(ts)) {
687 if (len <= CACHE_PATH_CUTOFF)
688 ncp_ts = uma_zalloc_smr(cache_zone_small_ts, M_WAITOK);
690 ncp_ts = uma_zalloc_smr(cache_zone_large_ts, M_WAITOK);
691 ncp = &ncp_ts->nc_nc;
693 if (len <= CACHE_PATH_CUTOFF)
694 ncp = uma_zalloc_smr(cache_zone_small, M_WAITOK);
696 ncp = uma_zalloc_smr(cache_zone_large, M_WAITOK);
702 cache_free_uma(struct namecache *ncp)
704 struct namecache_ts *ncp_ts;
706 if (__predict_false(ncp->nc_flag & NCF_TS)) {
707 ncp_ts = __containerof(ncp, struct namecache_ts, nc_nc);
708 if (ncp->nc_nlen <= CACHE_PATH_CUTOFF)
709 uma_zfree_smr(cache_zone_small_ts, ncp_ts);
711 uma_zfree_smr(cache_zone_large_ts, ncp_ts);
713 if (ncp->nc_nlen <= CACHE_PATH_CUTOFF)
714 uma_zfree_smr(cache_zone_small, ncp);
716 uma_zfree_smr(cache_zone_large, ncp);
720 static struct namecache *
721 cache_alloc(int len, bool ts)
726 * Avoid blowout in namecache entries.
729 * 1. filesystems may end up trying to add an already existing entry
730 * (for example this can happen after a cache miss during concurrent
731 * lookup), in which case we will call cache_neg_evict despite not
733 * 2. the routine may fail to free anything and no provisions are made
734 * to make it try harder (see the inside for failure modes)
735 * 3. it only ever looks at negative entries.
737 lnumcache = atomic_fetchadd_long(&numcache, 1) + 1;
738 if (cache_neg_evict_cond(lnumcache)) {
739 lnumcache = atomic_load_long(&numcache);
741 if (__predict_false(lnumcache >= ncsize)) {
742 atomic_subtract_long(&numcache, 1);
743 counter_u64_add(numdrops, 1);
746 return (cache_alloc_uma(len, ts));
750 cache_free(struct namecache *ncp)
754 if ((ncp->nc_flag & NCF_DVDROP) != 0) {
755 cache_drop_vnode(ncp->nc_dvp);
758 atomic_subtract_long(&numcache, 1);
762 cache_free_batch(struct cache_freebatch *batch)
764 struct namecache *ncp, *nnp;
768 if (TAILQ_EMPTY(batch))
770 TAILQ_FOREACH_SAFE(ncp, batch, nc_dst, nnp) {
771 if ((ncp->nc_flag & NCF_DVDROP) != 0) {
772 cache_drop_vnode(ncp->nc_dvp);
777 atomic_subtract_long(&numcache, i);
779 SDT_PROBE1(vfs, namecache, purge, batch, i);
785 * The code was made to use FNV in 2001 and this choice needs to be revisited.
787 * Short summary of the difficulty:
788 * The longest name which can be inserted is NAME_MAX characters in length (or
789 * 255 at the time of writing this comment), while majority of names used in
790 * practice are significantly shorter (mostly below 10). More importantly
791 * majority of lookups performed find names are even shorter than that.
793 * This poses a problem where hashes which do better than FNV past word size
794 * (or so) tend to come with additional overhead when finalizing the result,
795 * making them noticeably slower for the most commonly used range.
797 * Consider a path like: /usr/obj/usr/src/sys/amd64/GENERIC/vnode_if.c
799 * When looking it up the most time consuming part by a large margin (at least
800 * on amd64) is hashing. Replacing FNV with something which pessimizes short
801 * input would make the slowest part stand out even more.
805 * TODO: With the value stored we can do better than computing the hash based
809 cache_prehash(struct vnode *vp)
812 vp->v_nchash = fnv_32_buf(&vp, sizeof(vp), FNV1_32_INIT);
816 cache_get_hash(char *name, u_char len, struct vnode *dvp)
819 return (fnv_32_buf(name, len, dvp->v_nchash));
823 cache_get_hash_iter_start(struct vnode *dvp)
826 return (dvp->v_nchash);
830 cache_get_hash_iter(char c, uint32_t hash)
833 return (fnv_32_buf(&c, 1, hash));
837 cache_get_hash_iter_finish(uint32_t hash)
843 static inline struct nchashhead *
844 NCP2BUCKET(struct namecache *ncp)
848 hash = cache_get_hash(ncp->nc_name, ncp->nc_nlen, ncp->nc_dvp);
849 return (NCHHASH(hash));
852 static inline struct mtx *
853 NCP2BUCKETLOCK(struct namecache *ncp)
857 hash = cache_get_hash(ncp->nc_name, ncp->nc_nlen, ncp->nc_dvp);
858 return (HASH2BUCKETLOCK(hash));
863 cache_assert_bucket_locked(struct namecache *ncp)
867 blp = NCP2BUCKETLOCK(ncp);
868 mtx_assert(blp, MA_OWNED);
872 cache_assert_bucket_unlocked(struct namecache *ncp)
876 blp = NCP2BUCKETLOCK(ncp);
877 mtx_assert(blp, MA_NOTOWNED);
880 #define cache_assert_bucket_locked(x) do { } while (0)
881 #define cache_assert_bucket_unlocked(x) do { } while (0)
884 #define cache_sort_vnodes(x, y) _cache_sort_vnodes((void **)(x), (void **)(y))
886 _cache_sort_vnodes(void **p1, void **p2)
890 MPASS(*p1 != NULL || *p2 != NULL);
900 cache_lock_all_buckets(void)
904 for (i = 0; i < numbucketlocks; i++)
905 mtx_lock(&bucketlocks[i]);
909 cache_unlock_all_buckets(void)
913 for (i = 0; i < numbucketlocks; i++)
914 mtx_unlock(&bucketlocks[i]);
918 cache_lock_all_vnodes(void)
922 for (i = 0; i < numvnodelocks; i++)
923 mtx_lock(&vnodelocks[i]);
927 cache_unlock_all_vnodes(void)
931 for (i = 0; i < numvnodelocks; i++)
932 mtx_unlock(&vnodelocks[i]);
936 cache_trylock_vnodes(struct mtx *vlp1, struct mtx *vlp2)
939 cache_sort_vnodes(&vlp1, &vlp2);
942 if (!mtx_trylock(vlp1))
945 if (!mtx_trylock(vlp2)) {
955 cache_lock_vnodes(struct mtx *vlp1, struct mtx *vlp2)
958 MPASS(vlp1 != NULL || vlp2 != NULL);
968 cache_unlock_vnodes(struct mtx *vlp1, struct mtx *vlp2)
971 MPASS(vlp1 != NULL || vlp2 != NULL);
980 sysctl_nchstats(SYSCTL_HANDLER_ARGS)
982 struct nchstats snap;
984 if (req->oldptr == NULL)
985 return (SYSCTL_OUT(req, 0, sizeof(snap)));
988 snap.ncs_goodhits = counter_u64_fetch(numposhits);
989 snap.ncs_neghits = counter_u64_fetch(numneghits);
990 snap.ncs_badhits = counter_u64_fetch(numposzaps) +
991 counter_u64_fetch(numnegzaps);
992 snap.ncs_miss = counter_u64_fetch(nummisszap) +
993 counter_u64_fetch(nummiss);
995 return (SYSCTL_OUT(req, &snap, sizeof(snap)));
997 SYSCTL_PROC(_vfs_cache, OID_AUTO, nchstats, CTLTYPE_OPAQUE | CTLFLAG_RD |
998 CTLFLAG_MPSAFE, 0, 0, sysctl_nchstats, "LU",
999 "VFS cache effectiveness statistics");
1002 cache_recalc_neg_min(u_int val)
1005 neg_min = (ncsize * val) / 100;
1009 sysctl_negminpct(SYSCTL_HANDLER_ARGS)
1015 error = sysctl_handle_int(oidp, &val, 0, req);
1016 if (error != 0 || req->newptr == NULL)
1019 if (val == ncnegminpct)
1021 if (val < 0 || val > 99)
1024 cache_recalc_neg_min(val);
1028 SYSCTL_PROC(_vfs_cache_param, OID_AUTO, negminpct,
1029 CTLTYPE_INT | CTLFLAG_MPSAFE | CTLFLAG_RW, NULL, 0, sysctl_negminpct,
1030 "I", "Negative entry \% of namecache capacity above which automatic eviction is allowed");
1034 * Grab an atomic snapshot of the name cache hash chain lengths
1036 static SYSCTL_NODE(_debug, OID_AUTO, hashstat,
1037 CTLFLAG_RW | CTLFLAG_MPSAFE, NULL,
1038 "hash table stats");
1041 sysctl_debug_hashstat_rawnchash(SYSCTL_HANDLER_ARGS)
1043 struct nchashhead *ncpp;
1044 struct namecache *ncp;
1045 int i, error, n_nchash, *cntbuf;
1048 n_nchash = nchash + 1; /* nchash is max index, not count */
1049 if (req->oldptr == NULL)
1050 return SYSCTL_OUT(req, 0, n_nchash * sizeof(int));
1051 cntbuf = malloc(n_nchash * sizeof(int), M_TEMP, M_ZERO | M_WAITOK);
1052 cache_lock_all_buckets();
1053 if (n_nchash != nchash + 1) {
1054 cache_unlock_all_buckets();
1055 free(cntbuf, M_TEMP);
1058 /* Scan hash tables counting entries */
1059 for (ncpp = nchashtbl, i = 0; i < n_nchash; ncpp++, i++)
1060 CK_SLIST_FOREACH(ncp, ncpp, nc_hash)
1062 cache_unlock_all_buckets();
1063 for (error = 0, i = 0; i < n_nchash; i++)
1064 if ((error = SYSCTL_OUT(req, &cntbuf[i], sizeof(int))) != 0)
1066 free(cntbuf, M_TEMP);
1069 SYSCTL_PROC(_debug_hashstat, OID_AUTO, rawnchash, CTLTYPE_INT|CTLFLAG_RD|
1070 CTLFLAG_MPSAFE, 0, 0, sysctl_debug_hashstat_rawnchash, "S,int",
1071 "nchash chain lengths");
1074 sysctl_debug_hashstat_nchash(SYSCTL_HANDLER_ARGS)
1077 struct nchashhead *ncpp;
1078 struct namecache *ncp;
1080 int count, maxlength, used, pct;
1083 return SYSCTL_OUT(req, 0, 4 * sizeof(int));
1085 cache_lock_all_buckets();
1086 n_nchash = nchash + 1; /* nchash is max index, not count */
1090 /* Scan hash tables for applicable entries */
1091 for (ncpp = nchashtbl; n_nchash > 0; n_nchash--, ncpp++) {
1093 CK_SLIST_FOREACH(ncp, ncpp, nc_hash) {
1098 if (maxlength < count)
1101 n_nchash = nchash + 1;
1102 cache_unlock_all_buckets();
1103 pct = (used * 100) / (n_nchash / 100);
1104 error = SYSCTL_OUT(req, &n_nchash, sizeof(n_nchash));
1107 error = SYSCTL_OUT(req, &used, sizeof(used));
1110 error = SYSCTL_OUT(req, &maxlength, sizeof(maxlength));
1113 error = SYSCTL_OUT(req, &pct, sizeof(pct));
1118 SYSCTL_PROC(_debug_hashstat, OID_AUTO, nchash, CTLTYPE_INT|CTLFLAG_RD|
1119 CTLFLAG_MPSAFE, 0, 0, sysctl_debug_hashstat_nchash, "I",
1120 "nchash statistics (number of total/used buckets, maximum chain length, usage percentage)");
1124 * Negative entries management
1126 * Various workloads create plenty of negative entries and barely use them
1127 * afterwards. Moreover malicious users can keep performing bogus lookups
1128 * adding even more entries. For example "make tinderbox" as of writing this
1129 * comment ends up with 2.6M namecache entries in total, 1.2M of which are
1132 * As such, a rather aggressive eviction method is needed. The currently
1133 * employed method is a placeholder.
1135 * Entries are split over numneglists separate lists, each of which is further
1136 * split into hot and cold entries. Entries get promoted after getting a hit.
1137 * Eviction happens on addition of new entry.
1139 static SYSCTL_NODE(_vfs_cache, OID_AUTO, neg, CTLFLAG_RW | CTLFLAG_MPSAFE, 0,
1140 "Name cache negative entry statistics");
1142 SYSCTL_ULONG(_vfs_cache_neg, OID_AUTO, count, CTLFLAG_RD, &numneg, 0,
1143 "Number of negative cache entries");
1145 static COUNTER_U64_DEFINE_EARLY(neg_created);
1146 SYSCTL_COUNTER_U64(_vfs_cache_neg, OID_AUTO, created, CTLFLAG_RD, &neg_created,
1147 "Number of created negative entries");
1149 static COUNTER_U64_DEFINE_EARLY(neg_evicted);
1150 SYSCTL_COUNTER_U64(_vfs_cache_neg, OID_AUTO, evicted, CTLFLAG_RD, &neg_evicted,
1151 "Number of evicted negative entries");
1153 static COUNTER_U64_DEFINE_EARLY(neg_evict_skipped_empty);
1154 SYSCTL_COUNTER_U64(_vfs_cache_neg, OID_AUTO, evict_skipped_empty, CTLFLAG_RD,
1155 &neg_evict_skipped_empty,
1156 "Number of times evicting failed due to lack of entries");
1158 static COUNTER_U64_DEFINE_EARLY(neg_evict_skipped_missed);
1159 SYSCTL_COUNTER_U64(_vfs_cache_neg, OID_AUTO, evict_skipped_missed, CTLFLAG_RD,
1160 &neg_evict_skipped_missed,
1161 "Number of times evicting failed due to target entry disappearing");
1163 static COUNTER_U64_DEFINE_EARLY(neg_evict_skipped_contended);
1164 SYSCTL_COUNTER_U64(_vfs_cache_neg, OID_AUTO, evict_skipped_contended, CTLFLAG_RD,
1165 &neg_evict_skipped_contended,
1166 "Number of times evicting failed due to contention");
1168 SYSCTL_COUNTER_U64(_vfs_cache_neg, OID_AUTO, hits, CTLFLAG_RD, &numneghits,
1169 "Number of cache hits (negative)");
1172 sysctl_neg_hot(SYSCTL_HANDLER_ARGS)
1177 for (i = 0; i < numneglists; i++)
1178 out += neglists[i].nl_hotnum;
1180 return (SYSCTL_OUT(req, &out, sizeof(out)));
1182 SYSCTL_PROC(_vfs_cache_neg, OID_AUTO, hot, CTLTYPE_INT | CTLFLAG_RD |
1183 CTLFLAG_MPSAFE, 0, 0, sysctl_neg_hot, "I",
1184 "Number of hot negative entries");
1187 cache_neg_init(struct namecache *ncp)
1189 struct negstate *ns;
1191 ncp->nc_flag |= NCF_NEGATIVE;
1192 ns = NCP2NEGSTATE(ncp);
1195 counter_u64_add(neg_created, 1);
1198 #define CACHE_NEG_PROMOTION_THRESH 2
1201 cache_neg_hit_prep(struct namecache *ncp)
1203 struct negstate *ns;
1206 ns = NCP2NEGSTATE(ncp);
1207 n = atomic_load_char(&ns->neg_hit);
1209 if (n >= CACHE_NEG_PROMOTION_THRESH)
1211 if (atomic_fcmpset_8(&ns->neg_hit, &n, n + 1))
1214 return (n + 1 == CACHE_NEG_PROMOTION_THRESH);
1218 * Nothing to do here but it is provided for completeness as some
1219 * cache_neg_hit_prep callers may end up returning without even
1220 * trying to promote.
1222 #define cache_neg_hit_abort(ncp) do { } while (0)
1225 cache_neg_hit_finish(struct namecache *ncp)
1228 SDT_PROBE2(vfs, namecache, lookup, hit__negative, ncp->nc_dvp, ncp->nc_name);
1229 counter_u64_add(numneghits, 1);
1233 * Move a negative entry to the hot list.
1236 cache_neg_promote_locked(struct namecache *ncp)
1239 struct negstate *ns;
1241 ns = NCP2NEGSTATE(ncp);
1242 nl = NCP2NEGLIST(ncp);
1243 mtx_assert(&nl->nl_lock, MA_OWNED);
1244 if ((ns->neg_flag & NEG_HOT) == 0) {
1245 TAILQ_REMOVE(&nl->nl_list, ncp, nc_dst);
1246 TAILQ_INSERT_TAIL(&nl->nl_hotlist, ncp, nc_dst);
1248 ns->neg_flag |= NEG_HOT;
1253 * Move a hot negative entry to the cold list.
1256 cache_neg_demote_locked(struct namecache *ncp)
1259 struct negstate *ns;
1261 ns = NCP2NEGSTATE(ncp);
1262 nl = NCP2NEGLIST(ncp);
1263 mtx_assert(&nl->nl_lock, MA_OWNED);
1264 MPASS(ns->neg_flag & NEG_HOT);
1265 TAILQ_REMOVE(&nl->nl_hotlist, ncp, nc_dst);
1266 TAILQ_INSERT_TAIL(&nl->nl_list, ncp, nc_dst);
1268 ns->neg_flag &= ~NEG_HOT;
1269 atomic_store_char(&ns->neg_hit, 0);
1273 * Move a negative entry to the hot list if it matches the lookup.
1275 * We have to take locks, but they may be contended and in the worst
1276 * case we may need to go off CPU. We don't want to spin within the
1277 * smr section and we can't block with it. Exiting the section means
1278 * the found entry could have been evicted. We are going to look it
1282 cache_neg_promote_cond(struct vnode *dvp, struct componentname *cnp,
1283 struct namecache *oncp, uint32_t hash)
1285 struct namecache *ncp;
1289 nl = NCP2NEGLIST(oncp);
1291 mtx_lock(&nl->nl_lock);
1293 * For hash iteration.
1298 * Avoid all surprises by only succeeding if we got the same entry and
1299 * bailing completely otherwise.
1300 * XXX There are no provisions to keep the vnode around, meaning we may
1301 * end up promoting a negative entry for a *new* vnode and returning
1302 * ENOENT on its account. This is the error we want to return anyway
1303 * and promotion is harmless.
1305 * In particular at this point there can be a new ncp which matches the
1306 * search but hashes to a different neglist.
1308 CK_SLIST_FOREACH(ncp, (NCHHASH(hash)), nc_hash) {
1314 * No match to begin with.
1316 if (__predict_false(ncp == NULL)) {
1321 * The newly found entry may be something different...
1323 if (!(ncp->nc_dvp == dvp && ncp->nc_nlen == cnp->cn_namelen &&
1324 !bcmp(ncp->nc_name, cnp->cn_nameptr, ncp->nc_nlen))) {
1329 * ... and not even negative.
1331 nc_flag = atomic_load_char(&ncp->nc_flag);
1332 if ((nc_flag & NCF_NEGATIVE) == 0) {
1336 if (!cache_ncp_canuse(ncp)) {
1340 cache_neg_promote_locked(ncp);
1341 cache_neg_hit_finish(ncp);
1343 mtx_unlock(&nl->nl_lock);
1347 mtx_unlock(&nl->nl_lock);
1352 cache_neg_promote(struct namecache *ncp)
1356 nl = NCP2NEGLIST(ncp);
1357 mtx_lock(&nl->nl_lock);
1358 cache_neg_promote_locked(ncp);
1359 mtx_unlock(&nl->nl_lock);
1363 cache_neg_insert(struct namecache *ncp)
1367 MPASS(ncp->nc_flag & NCF_NEGATIVE);
1368 cache_assert_bucket_locked(ncp);
1369 nl = NCP2NEGLIST(ncp);
1370 mtx_lock(&nl->nl_lock);
1371 TAILQ_INSERT_TAIL(&nl->nl_list, ncp, nc_dst);
1372 mtx_unlock(&nl->nl_lock);
1373 atomic_add_long(&numneg, 1);
1377 cache_neg_remove(struct namecache *ncp)
1380 struct negstate *ns;
1382 cache_assert_bucket_locked(ncp);
1383 nl = NCP2NEGLIST(ncp);
1384 ns = NCP2NEGSTATE(ncp);
1385 mtx_lock(&nl->nl_lock);
1386 if ((ns->neg_flag & NEG_HOT) != 0) {
1387 TAILQ_REMOVE(&nl->nl_hotlist, ncp, nc_dst);
1390 TAILQ_REMOVE(&nl->nl_list, ncp, nc_dst);
1392 mtx_unlock(&nl->nl_lock);
1393 atomic_subtract_long(&numneg, 1);
1396 static struct neglist *
1397 cache_neg_evict_select_list(void)
1402 c = atomic_fetchadd_int(&neg_cycle, 1) + 1;
1403 nl = &neglists[c % numneglists];
1404 if (!mtx_trylock(&nl->nl_evict_lock)) {
1405 counter_u64_add(neg_evict_skipped_contended, 1);
1411 static struct namecache *
1412 cache_neg_evict_select_entry(struct neglist *nl)
1414 struct namecache *ncp, *lncp;
1415 struct negstate *ns, *lns;
1418 mtx_assert(&nl->nl_evict_lock, MA_OWNED);
1419 mtx_assert(&nl->nl_lock, MA_OWNED);
1420 ncp = TAILQ_FIRST(&nl->nl_list);
1424 lns = NCP2NEGSTATE(lncp);
1425 for (i = 1; i < 4; i++) {
1426 ncp = TAILQ_NEXT(ncp, nc_dst);
1429 ns = NCP2NEGSTATE(ncp);
1430 if (ns->neg_hit < lns->neg_hit) {
1439 cache_neg_evict(void)
1441 struct namecache *ncp, *ncp2;
1450 nl = cache_neg_evict_select_list();
1455 mtx_lock(&nl->nl_lock);
1456 ncp = TAILQ_FIRST(&nl->nl_hotlist);
1458 cache_neg_demote_locked(ncp);
1460 ncp = cache_neg_evict_select_entry(nl);
1462 counter_u64_add(neg_evict_skipped_empty, 1);
1463 mtx_unlock(&nl->nl_lock);
1464 mtx_unlock(&nl->nl_evict_lock);
1467 nlen = ncp->nc_nlen;
1469 hash = cache_get_hash(ncp->nc_name, nlen, dvp);
1470 dvlp = VP2VNODELOCK(dvp);
1471 blp = HASH2BUCKETLOCK(hash);
1472 mtx_unlock(&nl->nl_lock);
1473 mtx_unlock(&nl->nl_evict_lock);
1477 * Note that since all locks were dropped above, the entry may be
1478 * gone or reallocated to be something else.
1480 CK_SLIST_FOREACH(ncp2, (NCHHASH(hash)), nc_hash) {
1481 if (ncp2 == ncp && ncp2->nc_dvp == dvp &&
1482 ncp2->nc_nlen == nlen && (ncp2->nc_flag & NCF_NEGATIVE) != 0)
1486 counter_u64_add(neg_evict_skipped_missed, 1);
1490 MPASS(dvlp == VP2VNODELOCK(ncp->nc_dvp));
1491 MPASS(blp == NCP2BUCKETLOCK(ncp));
1492 SDT_PROBE2(vfs, namecache, evict_negative, done, ncp->nc_dvp,
1494 cache_zap_locked(ncp);
1495 counter_u64_add(neg_evicted, 1);
1506 * Maybe evict a negative entry to create more room.
1508 * The ncnegfactor parameter limits what fraction of the total count
1509 * can comprise of negative entries. However, if the cache is just
1510 * warming up this leads to excessive evictions. As such, ncnegminpct
1511 * (recomputed to neg_min) dictates whether the above should be
1514 * Try evicting if the cache is close to full capacity regardless of
1515 * other considerations.
1518 cache_neg_evict_cond(u_long lnumcache)
1522 if (ncsize - 1000 < lnumcache)
1524 lnumneg = atomic_load_long(&numneg);
1525 if (lnumneg < neg_min)
1527 if (lnumneg * ncnegfactor < lnumcache)
1530 return (cache_neg_evict());
1534 * cache_zap_locked():
1536 * Removes a namecache entry from cache, whether it contains an actual
1537 * pointer to a vnode or if it is just a negative cache entry.
1540 cache_zap_locked(struct namecache *ncp)
1542 struct nchashhead *ncpp;
1543 struct vnode *dvp, *vp;
1548 if (!(ncp->nc_flag & NCF_NEGATIVE))
1549 cache_assert_vnode_locked(vp);
1550 cache_assert_vnode_locked(dvp);
1551 cache_assert_bucket_locked(ncp);
1553 cache_ncp_invalidate(ncp);
1555 ncpp = NCP2BUCKET(ncp);
1556 CK_SLIST_REMOVE(ncpp, ncp, namecache, nc_hash);
1557 if (!(ncp->nc_flag & NCF_NEGATIVE)) {
1558 SDT_PROBE3(vfs, namecache, zap, done, dvp, ncp->nc_name, vp);
1559 TAILQ_REMOVE(&vp->v_cache_dst, ncp, nc_dst);
1560 if (ncp == vp->v_cache_dd) {
1561 atomic_store_ptr(&vp->v_cache_dd, NULL);
1564 SDT_PROBE2(vfs, namecache, zap_negative, done, dvp, ncp->nc_name);
1565 cache_neg_remove(ncp);
1567 if (ncp->nc_flag & NCF_ISDOTDOT) {
1568 if (ncp == dvp->v_cache_dd) {
1569 atomic_store_ptr(&dvp->v_cache_dd, NULL);
1572 LIST_REMOVE(ncp, nc_src);
1573 if (LIST_EMPTY(&dvp->v_cache_src)) {
1574 ncp->nc_flag |= NCF_DVDROP;
1580 cache_zap_negative_locked_vnode_kl(struct namecache *ncp, struct vnode *vp)
1584 MPASS(ncp->nc_dvp == vp);
1585 MPASS(ncp->nc_flag & NCF_NEGATIVE);
1586 cache_assert_vnode_locked(vp);
1588 blp = NCP2BUCKETLOCK(ncp);
1590 cache_zap_locked(ncp);
1595 cache_zap_locked_vnode_kl2(struct namecache *ncp, struct vnode *vp,
1598 struct mtx *pvlp, *vlp1, *vlp2, *to_unlock;
1601 MPASS(vp == ncp->nc_dvp || vp == ncp->nc_vp);
1602 cache_assert_vnode_locked(vp);
1604 if (ncp->nc_flag & NCF_NEGATIVE) {
1605 if (*vlpp != NULL) {
1609 cache_zap_negative_locked_vnode_kl(ncp, vp);
1613 pvlp = VP2VNODELOCK(vp);
1614 blp = NCP2BUCKETLOCK(ncp);
1615 vlp1 = VP2VNODELOCK(ncp->nc_dvp);
1616 vlp2 = VP2VNODELOCK(ncp->nc_vp);
1618 if (*vlpp == vlp1 || *vlpp == vlp2) {
1622 if (*vlpp != NULL) {
1626 cache_sort_vnodes(&vlp1, &vlp2);
1631 if (!mtx_trylock(vlp1))
1637 cache_zap_locked(ncp);
1639 if (to_unlock != NULL)
1640 mtx_unlock(to_unlock);
1647 MPASS(*vlpp == NULL);
1653 * If trylocking failed we can get here. We know enough to take all needed locks
1654 * in the right order and re-lookup the entry.
1657 cache_zap_unlocked_bucket(struct namecache *ncp, struct componentname *cnp,
1658 struct vnode *dvp, struct mtx *dvlp, struct mtx *vlp, uint32_t hash,
1661 struct namecache *rncp;
1663 cache_assert_bucket_unlocked(ncp);
1665 cache_sort_vnodes(&dvlp, &vlp);
1666 cache_lock_vnodes(dvlp, vlp);
1668 CK_SLIST_FOREACH(rncp, (NCHHASH(hash)), nc_hash) {
1669 if (rncp == ncp && rncp->nc_dvp == dvp &&
1670 rncp->nc_nlen == cnp->cn_namelen &&
1671 !bcmp(rncp->nc_name, cnp->cn_nameptr, rncp->nc_nlen))
1675 cache_zap_locked(rncp);
1677 cache_unlock_vnodes(dvlp, vlp);
1678 counter_u64_add(zap_bucket_relock_success, 1);
1683 cache_unlock_vnodes(dvlp, vlp);
1687 static int __noinline
1688 cache_zap_locked_bucket(struct namecache *ncp, struct componentname *cnp,
1689 uint32_t hash, struct mtx *blp)
1691 struct mtx *dvlp, *vlp;
1694 cache_assert_bucket_locked(ncp);
1696 dvlp = VP2VNODELOCK(ncp->nc_dvp);
1698 if (!(ncp->nc_flag & NCF_NEGATIVE))
1699 vlp = VP2VNODELOCK(ncp->nc_vp);
1700 if (cache_trylock_vnodes(dvlp, vlp) == 0) {
1701 cache_zap_locked(ncp);
1703 cache_unlock_vnodes(dvlp, vlp);
1709 return (cache_zap_unlocked_bucket(ncp, cnp, dvp, dvlp, vlp, hash, blp));
1712 static __noinline int
1713 cache_remove_cnp(struct vnode *dvp, struct componentname *cnp)
1715 struct namecache *ncp;
1717 struct mtx *dvlp, *dvlp2;
1721 if (cnp->cn_namelen == 2 &&
1722 cnp->cn_nameptr[0] == '.' && cnp->cn_nameptr[1] == '.') {
1723 dvlp = VP2VNODELOCK(dvp);
1727 ncp = dvp->v_cache_dd;
1732 SDT_PROBE2(vfs, namecache, removecnp, miss, dvp, cnp);
1735 if ((ncp->nc_flag & NCF_ISDOTDOT) != 0) {
1736 if (!cache_zap_locked_vnode_kl2(ncp, dvp, &dvlp2))
1738 MPASS(dvp->v_cache_dd == NULL);
1744 atomic_store_ptr(&dvp->v_cache_dd, NULL);
1749 SDT_PROBE2(vfs, namecache, removecnp, hit, dvp, cnp);
1753 hash = cache_get_hash(cnp->cn_nameptr, cnp->cn_namelen, dvp);
1754 blp = HASH2BUCKETLOCK(hash);
1756 if (CK_SLIST_EMPTY(NCHHASH(hash)))
1761 CK_SLIST_FOREACH(ncp, (NCHHASH(hash)), nc_hash) {
1762 if (ncp->nc_dvp == dvp && ncp->nc_nlen == cnp->cn_namelen &&
1763 !bcmp(ncp->nc_name, cnp->cn_nameptr, ncp->nc_nlen))
1772 error = cache_zap_locked_bucket(ncp, cnp, hash, blp);
1773 if (__predict_false(error != 0)) {
1777 counter_u64_add(numposzaps, 1);
1778 SDT_PROBE2(vfs, namecache, removecnp, hit, dvp, cnp);
1782 counter_u64_add(nummisszap, 1);
1783 SDT_PROBE2(vfs, namecache, removecnp, miss, dvp, cnp);
1787 static int __noinline
1788 cache_lookup_dot(struct vnode *dvp, struct vnode **vpp, struct componentname *cnp,
1789 struct timespec *tsp, int *ticksp)
1794 counter_u64_add(dothits, 1);
1795 SDT_PROBE3(vfs, namecache, lookup, hit, dvp, ".", *vpp);
1802 * When we lookup "." we still can be asked to lock it
1805 ltype = cnp->cn_lkflags & LK_TYPE_MASK;
1806 if (ltype != VOP_ISLOCKED(*vpp)) {
1807 if (ltype == LK_EXCLUSIVE) {
1808 vn_lock(*vpp, LK_UPGRADE | LK_RETRY);
1809 if (VN_IS_DOOMED((*vpp))) {
1810 /* forced unmount */
1816 vn_lock(*vpp, LK_DOWNGRADE | LK_RETRY);
1821 static int __noinline
1822 cache_lookup_dotdot(struct vnode *dvp, struct vnode **vpp, struct componentname *cnp,
1823 struct timespec *tsp, int *ticksp)
1825 struct namecache_ts *ncp_ts;
1826 struct namecache *ncp;
1832 MPASS((cnp->cn_flags & ISDOTDOT) != 0);
1834 if ((cnp->cn_flags & MAKEENTRY) == 0) {
1835 cache_remove_cnp(dvp, cnp);
1839 counter_u64_add(dotdothits, 1);
1841 dvlp = VP2VNODELOCK(dvp);
1843 ncp = dvp->v_cache_dd;
1845 SDT_PROBE2(vfs, namecache, lookup, miss, dvp, "..");
1849 if ((ncp->nc_flag & NCF_ISDOTDOT) != 0) {
1850 if (ncp->nc_flag & NCF_NEGATIVE)
1857 goto negative_success;
1858 SDT_PROBE3(vfs, namecache, lookup, hit, dvp, "..", *vpp);
1859 cache_out_ts(ncp, tsp, ticksp);
1860 if ((ncp->nc_flag & (NCF_ISDOTDOT | NCF_DTS)) ==
1861 NCF_DTS && tsp != NULL) {
1862 ncp_ts = __containerof(ncp, struct namecache_ts, nc_nc);
1863 *tsp = ncp_ts->nc_dotdottime;
1867 ltype = VOP_ISLOCKED(dvp);
1869 vs = vget_prep(*vpp);
1871 error = vget_finish(*vpp, cnp->cn_lkflags, vs);
1872 vn_lock(dvp, ltype | LK_RETRY);
1873 if (VN_IS_DOOMED(dvp)) {
1885 if (__predict_false(cnp->cn_nameiop == CREATE)) {
1886 if (cnp->cn_flags & ISLASTCN) {
1887 counter_u64_add(numnegzaps, 1);
1888 cache_zap_negative_locked_vnode_kl(ncp, dvp);
1895 whiteout = (ncp->nc_flag & NCF_WHITE);
1896 cache_out_ts(ncp, tsp, ticksp);
1897 if (cache_neg_hit_prep(ncp))
1898 cache_neg_promote(ncp);
1900 cache_neg_hit_finish(ncp);
1903 cnp->cn_flags |= ISWHITEOUT;
1908 * Lookup a name in the name cache
1912 * - dvp: Parent directory in which to search.
1913 * - vpp: Return argument. Will contain desired vnode on cache hit.
1914 * - cnp: Parameters of the name search. The most interesting bits of
1915 * the cn_flags field have the following meanings:
1916 * - MAKEENTRY: If clear, free an entry from the cache rather than look
1918 * - ISDOTDOT: Must be set if and only if cn_nameptr == ".."
1919 * - tsp: Return storage for cache timestamp. On a successful (positive
1920 * or negative) lookup, tsp will be filled with any timespec that
1921 * was stored when this cache entry was created. However, it will
1922 * be clear for "." entries.
1923 * - ticks: Return storage for alternate cache timestamp. On a successful
1924 * (positive or negative) lookup, it will contain the ticks value
1925 * that was current when the cache entry was created, unless cnp
1928 * Either both tsp and ticks have to be provided or neither of them.
1932 * - -1: A positive cache hit. vpp will contain the desired vnode.
1933 * - ENOENT: A negative cache hit, or dvp was recycled out from under us due
1934 * to a forced unmount. vpp will not be modified. If the entry
1935 * is a whiteout, then the ISWHITEOUT flag will be set in
1937 * - 0: A cache miss. vpp will not be modified.
1941 * On a cache hit, vpp will be returned locked and ref'd. If we're looking up
1942 * .., dvp is unlocked. If we're looking up . an extra ref is taken, but the
1943 * lock is not recursively acquired.
1945 static int __noinline
1946 cache_lookup_fallback(struct vnode *dvp, struct vnode **vpp, struct componentname *cnp,
1947 struct timespec *tsp, int *ticksp)
1949 struct namecache *ncp;
1956 MPASS((cnp->cn_flags & ISDOTDOT) == 0);
1957 MPASS((cnp->cn_flags & (MAKEENTRY | NC_KEEPPOSENTRY)) != 0);
1960 hash = cache_get_hash(cnp->cn_nameptr, cnp->cn_namelen, dvp);
1961 blp = HASH2BUCKETLOCK(hash);
1964 CK_SLIST_FOREACH(ncp, (NCHHASH(hash)), nc_hash) {
1965 if (ncp->nc_dvp == dvp && ncp->nc_nlen == cnp->cn_namelen &&
1966 !bcmp(ncp->nc_name, cnp->cn_nameptr, ncp->nc_nlen))
1970 if (__predict_false(ncp == NULL)) {
1972 SDT_PROBE2(vfs, namecache, lookup, miss, dvp, cnp->cn_nameptr);
1973 counter_u64_add(nummiss, 1);
1977 if (ncp->nc_flag & NCF_NEGATIVE)
1978 goto negative_success;
1980 counter_u64_add(numposhits, 1);
1982 SDT_PROBE3(vfs, namecache, lookup, hit, dvp, ncp->nc_name, *vpp);
1983 cache_out_ts(ncp, tsp, ticksp);
1985 vs = vget_prep(*vpp);
1987 error = vget_finish(*vpp, cnp->cn_lkflags, vs);
1995 * We don't get here with regular lookup apart from corner cases.
1997 if (__predict_true(cnp->cn_nameiop == CREATE)) {
1998 if (cnp->cn_flags & ISLASTCN) {
1999 counter_u64_add(numnegzaps, 1);
2000 error = cache_zap_locked_bucket(ncp, cnp, hash, blp);
2001 if (__predict_false(error != 0)) {
2010 whiteout = (ncp->nc_flag & NCF_WHITE);
2011 cache_out_ts(ncp, tsp, ticksp);
2012 if (cache_neg_hit_prep(ncp))
2013 cache_neg_promote(ncp);
2015 cache_neg_hit_finish(ncp);
2018 cnp->cn_flags |= ISWHITEOUT;
2023 cache_lookup(struct vnode *dvp, struct vnode **vpp, struct componentname *cnp,
2024 struct timespec *tsp, int *ticksp)
2026 struct namecache *ncp;
2030 bool whiteout, neg_promote;
2033 MPASS((tsp == NULL && ticksp == NULL) || (tsp != NULL && ticksp != NULL));
2036 if (__predict_false(!doingcache)) {
2037 cnp->cn_flags &= ~MAKEENTRY;
2042 if (__predict_false(cnp->cn_nameptr[0] == '.')) {
2043 if (cnp->cn_namelen == 1)
2044 return (cache_lookup_dot(dvp, vpp, cnp, tsp, ticksp));
2045 if (cnp->cn_namelen == 2 && cnp->cn_nameptr[1] == '.')
2046 return (cache_lookup_dotdot(dvp, vpp, cnp, tsp, ticksp));
2049 MPASS((cnp->cn_flags & ISDOTDOT) == 0);
2051 if ((cnp->cn_flags & (MAKEENTRY | NC_KEEPPOSENTRY)) == 0) {
2052 cache_remove_cnp(dvp, cnp);
2056 hash = cache_get_hash(cnp->cn_nameptr, cnp->cn_namelen, dvp);
2059 CK_SLIST_FOREACH(ncp, (NCHHASH(hash)), nc_hash) {
2060 if (ncp->nc_dvp == dvp && ncp->nc_nlen == cnp->cn_namelen &&
2061 !bcmp(ncp->nc_name, cnp->cn_nameptr, ncp->nc_nlen))
2065 if (__predict_false(ncp == NULL)) {
2067 SDT_PROBE2(vfs, namecache, lookup, miss, dvp, cnp->cn_nameptr);
2068 counter_u64_add(nummiss, 1);
2072 nc_flag = atomic_load_char(&ncp->nc_flag);
2073 if (nc_flag & NCF_NEGATIVE)
2074 goto negative_success;
2076 counter_u64_add(numposhits, 1);
2078 SDT_PROBE3(vfs, namecache, lookup, hit, dvp, ncp->nc_name, *vpp);
2079 cache_out_ts(ncp, tsp, ticksp);
2081 if (!cache_ncp_canuse(ncp)) {
2086 vs = vget_prep_smr(*vpp);
2088 if (__predict_false(vs == VGET_NONE)) {
2092 error = vget_finish(*vpp, cnp->cn_lkflags, vs);
2099 if (cnp->cn_nameiop == CREATE) {
2100 if (cnp->cn_flags & ISLASTCN) {
2106 cache_out_ts(ncp, tsp, ticksp);
2107 whiteout = (atomic_load_char(&ncp->nc_flag) & NCF_WHITE);
2108 neg_promote = cache_neg_hit_prep(ncp);
2109 if (!cache_ncp_canuse(ncp)) {
2110 cache_neg_hit_abort(ncp);
2116 if (!cache_neg_promote_cond(dvp, cnp, ncp, hash))
2119 cache_neg_hit_finish(ncp);
2123 cnp->cn_flags |= ISWHITEOUT;
2126 return (cache_lookup_fallback(dvp, vpp, cnp, tsp, ticksp));
2129 struct celockstate {
2133 CTASSERT((nitems(((struct celockstate *)0)->vlp) == 3));
2134 CTASSERT((nitems(((struct celockstate *)0)->blp) == 2));
2137 cache_celockstate_init(struct celockstate *cel)
2140 bzero(cel, sizeof(*cel));
2144 cache_lock_vnodes_cel(struct celockstate *cel, struct vnode *vp,
2147 struct mtx *vlp1, *vlp2;
2149 MPASS(cel->vlp[0] == NULL);
2150 MPASS(cel->vlp[1] == NULL);
2151 MPASS(cel->vlp[2] == NULL);
2153 MPASS(vp != NULL || dvp != NULL);
2155 vlp1 = VP2VNODELOCK(vp);
2156 vlp2 = VP2VNODELOCK(dvp);
2157 cache_sort_vnodes(&vlp1, &vlp2);
2168 cache_unlock_vnodes_cel(struct celockstate *cel)
2171 MPASS(cel->vlp[0] != NULL || cel->vlp[1] != NULL);
2173 if (cel->vlp[0] != NULL)
2174 mtx_unlock(cel->vlp[0]);
2175 if (cel->vlp[1] != NULL)
2176 mtx_unlock(cel->vlp[1]);
2177 if (cel->vlp[2] != NULL)
2178 mtx_unlock(cel->vlp[2]);
2182 cache_lock_vnodes_cel_3(struct celockstate *cel, struct vnode *vp)
2187 cache_assert_vlp_locked(cel->vlp[0]);
2188 cache_assert_vlp_locked(cel->vlp[1]);
2189 MPASS(cel->vlp[2] == NULL);
2192 vlp = VP2VNODELOCK(vp);
2195 if (vlp >= cel->vlp[1]) {
2198 if (mtx_trylock(vlp))
2200 cache_lock_vnodes_cel_3_failures++;
2201 cache_unlock_vnodes_cel(cel);
2202 if (vlp < cel->vlp[0]) {
2204 mtx_lock(cel->vlp[0]);
2205 mtx_lock(cel->vlp[1]);
2207 if (cel->vlp[0] != NULL)
2208 mtx_lock(cel->vlp[0]);
2210 mtx_lock(cel->vlp[1]);
2220 cache_lock_buckets_cel(struct celockstate *cel, struct mtx *blp1,
2224 MPASS(cel->blp[0] == NULL);
2225 MPASS(cel->blp[1] == NULL);
2227 cache_sort_vnodes(&blp1, &blp2);
2238 cache_unlock_buckets_cel(struct celockstate *cel)
2241 if (cel->blp[0] != NULL)
2242 mtx_unlock(cel->blp[0]);
2243 mtx_unlock(cel->blp[1]);
2247 * Lock part of the cache affected by the insertion.
2249 * This means vnodelocks for dvp, vp and the relevant bucketlock.
2250 * However, insertion can result in removal of an old entry. In this
2251 * case we have an additional vnode and bucketlock pair to lock.
2253 * That is, in the worst case we have to lock 3 vnodes and 2 bucketlocks, while
2254 * preserving the locking order (smaller address first).
2257 cache_enter_lock(struct celockstate *cel, struct vnode *dvp, struct vnode *vp,
2260 struct namecache *ncp;
2261 struct mtx *blps[2];
2264 blps[0] = HASH2BUCKETLOCK(hash);
2267 cache_lock_vnodes_cel(cel, dvp, vp);
2268 if (vp == NULL || vp->v_type != VDIR)
2270 ncp = atomic_load_consume_ptr(&vp->v_cache_dd);
2273 nc_flag = atomic_load_char(&ncp->nc_flag);
2274 if ((nc_flag & NCF_ISDOTDOT) == 0)
2276 MPASS(ncp->nc_dvp == vp);
2277 blps[1] = NCP2BUCKETLOCK(ncp);
2278 if ((nc_flag & NCF_NEGATIVE) != 0)
2280 if (cache_lock_vnodes_cel_3(cel, ncp->nc_vp))
2283 * All vnodes got re-locked. Re-validate the state and if
2284 * nothing changed we are done. Otherwise restart.
2286 if (ncp == vp->v_cache_dd &&
2287 (ncp->nc_flag & NCF_ISDOTDOT) != 0 &&
2288 blps[1] == NCP2BUCKETLOCK(ncp) &&
2289 VP2VNODELOCK(ncp->nc_vp) == cel->vlp[2])
2291 cache_unlock_vnodes_cel(cel);
2296 cache_lock_buckets_cel(cel, blps[0], blps[1]);
2300 cache_enter_lock_dd(struct celockstate *cel, struct vnode *dvp, struct vnode *vp,
2303 struct namecache *ncp;
2304 struct mtx *blps[2];
2307 blps[0] = HASH2BUCKETLOCK(hash);
2310 cache_lock_vnodes_cel(cel, dvp, vp);
2311 ncp = atomic_load_consume_ptr(&dvp->v_cache_dd);
2314 nc_flag = atomic_load_char(&ncp->nc_flag);
2315 if ((nc_flag & NCF_ISDOTDOT) == 0)
2317 MPASS(ncp->nc_dvp == dvp);
2318 blps[1] = NCP2BUCKETLOCK(ncp);
2319 if ((nc_flag & NCF_NEGATIVE) != 0)
2321 if (cache_lock_vnodes_cel_3(cel, ncp->nc_vp))
2323 if (ncp == dvp->v_cache_dd &&
2324 (ncp->nc_flag & NCF_ISDOTDOT) != 0 &&
2325 blps[1] == NCP2BUCKETLOCK(ncp) &&
2326 VP2VNODELOCK(ncp->nc_vp) == cel->vlp[2])
2328 cache_unlock_vnodes_cel(cel);
2333 cache_lock_buckets_cel(cel, blps[0], blps[1]);
2337 cache_enter_unlock(struct celockstate *cel)
2340 cache_unlock_buckets_cel(cel);
2341 cache_unlock_vnodes_cel(cel);
2344 static void __noinline
2345 cache_enter_dotdot_prep(struct vnode *dvp, struct vnode *vp,
2346 struct componentname *cnp)
2348 struct celockstate cel;
2349 struct namecache *ncp;
2353 if (atomic_load_ptr(&dvp->v_cache_dd) == NULL)
2355 len = cnp->cn_namelen;
2356 cache_celockstate_init(&cel);
2357 hash = cache_get_hash(cnp->cn_nameptr, len, dvp);
2358 cache_enter_lock_dd(&cel, dvp, vp, hash);
2359 ncp = dvp->v_cache_dd;
2360 if (ncp != NULL && (ncp->nc_flag & NCF_ISDOTDOT)) {
2361 KASSERT(ncp->nc_dvp == dvp, ("wrong isdotdot parent"));
2362 cache_zap_locked(ncp);
2366 atomic_store_ptr(&dvp->v_cache_dd, NULL);
2367 cache_enter_unlock(&cel);
2373 * Add an entry to the cache.
2376 cache_enter_time(struct vnode *dvp, struct vnode *vp, struct componentname *cnp,
2377 struct timespec *tsp, struct timespec *dtsp)
2379 struct celockstate cel;
2380 struct namecache *ncp, *n2, *ndd;
2381 struct namecache_ts *ncp_ts;
2382 struct nchashhead *ncpp;
2387 KASSERT(cnp->cn_namelen <= NAME_MAX,
2388 ("%s: passed len %ld exceeds NAME_MAX (%d)", __func__, cnp->cn_namelen,
2392 * Not everything doing this is weeded out yet.
2394 VNPASS(dvp != vp, dvp);
2396 VNPASS(!VN_IS_DOOMED(dvp), dvp);
2397 VNPASS(dvp->v_type != VNON, dvp);
2399 VNPASS(!VN_IS_DOOMED(vp), vp);
2400 VNPASS(vp->v_type != VNON, vp);
2404 if (__predict_false(!doingcache))
2409 if (__predict_false(cnp->cn_nameptr[0] == '.')) {
2410 if (cnp->cn_namelen == 1)
2412 if (cnp->cn_namelen == 2 && cnp->cn_nameptr[1] == '.') {
2413 cache_enter_dotdot_prep(dvp, vp, cnp);
2414 flag = NCF_ISDOTDOT;
2418 ncp = cache_alloc(cnp->cn_namelen, tsp != NULL);
2422 cache_celockstate_init(&cel);
2427 * Calculate the hash key and setup as much of the new
2428 * namecache entry as possible before acquiring the lock.
2430 ncp->nc_flag = flag | NCF_WIP;
2433 cache_neg_init(ncp);
2436 ncp_ts = __containerof(ncp, struct namecache_ts, nc_nc);
2437 ncp_ts->nc_time = *tsp;
2438 ncp_ts->nc_ticks = ticks;
2439 ncp_ts->nc_nc.nc_flag |= NCF_TS;
2441 ncp_ts->nc_dotdottime = *dtsp;
2442 ncp_ts->nc_nc.nc_flag |= NCF_DTS;
2445 len = ncp->nc_nlen = cnp->cn_namelen;
2446 hash = cache_get_hash(cnp->cn_nameptr, len, dvp);
2447 memcpy(ncp->nc_name, cnp->cn_nameptr, len);
2448 ncp->nc_name[len] = '\0';
2449 cache_enter_lock(&cel, dvp, vp, hash);
2452 * See if this vnode or negative entry is already in the cache
2453 * with this name. This can happen with concurrent lookups of
2454 * the same path name.
2456 ncpp = NCHHASH(hash);
2457 CK_SLIST_FOREACH(n2, ncpp, nc_hash) {
2458 if (n2->nc_dvp == dvp &&
2459 n2->nc_nlen == cnp->cn_namelen &&
2460 !bcmp(n2->nc_name, cnp->cn_nameptr, n2->nc_nlen)) {
2461 MPASS(cache_ncp_canuse(n2));
2462 if ((n2->nc_flag & NCF_NEGATIVE) != 0)
2464 ("%s: found entry pointing to a different vnode (%p != %p) ; name [%s]",
2465 __func__, NULL, vp, cnp->cn_nameptr));
2467 KASSERT(n2->nc_vp == vp,
2468 ("%s: found entry pointing to a different vnode (%p != %p) ; name [%s]",
2469 __func__, n2->nc_vp, vp, cnp->cn_nameptr));
2471 * Entries are supposed to be immutable unless in the
2472 * process of getting destroyed. Accommodating for
2473 * changing timestamps is possible but not worth it.
2474 * This should be harmless in terms of correctness, in
2475 * the worst case resulting in an earlier expiration.
2476 * Alternatively, the found entry can be replaced
2479 MPASS((n2->nc_flag & (NCF_TS | NCF_DTS)) == (ncp->nc_flag & (NCF_TS | NCF_DTS)));
2482 KASSERT((n2->nc_flag & NCF_TS) != 0,
2484 n2_ts = __containerof(n2, struct namecache_ts, nc_nc);
2485 n2_ts->nc_time = ncp_ts->nc_time;
2486 n2_ts->nc_ticks = ncp_ts->nc_ticks;
2488 n2_ts->nc_dotdottime = ncp_ts->nc_dotdottime;
2489 n2_ts->nc_nc.nc_flag |= NCF_DTS;
2493 SDT_PROBE3(vfs, namecache, enter, duplicate, dvp, ncp->nc_name,
2495 goto out_unlock_free;
2499 if (flag == NCF_ISDOTDOT) {
2501 * See if we are trying to add .. entry, but some other lookup
2502 * has populated v_cache_dd pointer already.
2504 if (dvp->v_cache_dd != NULL)
2505 goto out_unlock_free;
2506 KASSERT(vp == NULL || vp->v_type == VDIR,
2507 ("wrong vnode type %p", vp));
2508 atomic_thread_fence_rel();
2509 atomic_store_ptr(&dvp->v_cache_dd, ncp);
2513 if (flag != NCF_ISDOTDOT) {
2515 * For this case, the cache entry maps both the
2516 * directory name in it and the name ".." for the
2517 * directory's parent.
2519 if ((ndd = vp->v_cache_dd) != NULL) {
2520 if ((ndd->nc_flag & NCF_ISDOTDOT) != 0)
2521 cache_zap_locked(ndd);
2525 atomic_thread_fence_rel();
2526 atomic_store_ptr(&vp->v_cache_dd, ncp);
2527 } else if (vp->v_type != VDIR) {
2528 if (vp->v_cache_dd != NULL) {
2529 atomic_store_ptr(&vp->v_cache_dd, NULL);
2534 if (flag != NCF_ISDOTDOT) {
2535 if (LIST_EMPTY(&dvp->v_cache_src)) {
2536 cache_hold_vnode(dvp);
2538 LIST_INSERT_HEAD(&dvp->v_cache_src, ncp, nc_src);
2542 * If the entry is "negative", we place it into the
2543 * "negative" cache queue, otherwise, we place it into the
2544 * destination vnode's cache entries queue.
2547 TAILQ_INSERT_HEAD(&vp->v_cache_dst, ncp, nc_dst);
2548 SDT_PROBE3(vfs, namecache, enter, done, dvp, ncp->nc_name,
2551 if (cnp->cn_flags & ISWHITEOUT)
2552 atomic_store_char(&ncp->nc_flag, ncp->nc_flag | NCF_WHITE);
2553 cache_neg_insert(ncp);
2554 SDT_PROBE2(vfs, namecache, enter_negative, done, dvp,
2559 * Insert the new namecache entry into the appropriate chain
2560 * within the cache entries table.
2562 CK_SLIST_INSERT_HEAD(ncpp, ncp, nc_hash);
2564 atomic_thread_fence_rel();
2566 * Mark the entry as fully constructed.
2567 * It is immutable past this point until its removal.
2569 atomic_store_char(&ncp->nc_flag, ncp->nc_flag & ~NCF_WIP);
2571 cache_enter_unlock(&cel);
2576 cache_enter_unlock(&cel);
2582 * A variant of the above accepting flags.
2584 * - VFS_CACHE_DROPOLD -- if a conflicting entry is found, drop it.
2586 * TODO: this routine is a hack. It blindly removes the old entry, even if it
2587 * happens to match and it is doing it in an inefficient manner. It was added
2588 * to accomodate NFS which runs into a case where the target for a given name
2589 * may change from under it. Note this does nothing to solve the following
2590 * race: 2 callers of cache_enter_time_flags pass a different target vnode for
2591 * the same [dvp, cnp]. It may be argued that code doing this is broken.
2594 cache_enter_time_flags(struct vnode *dvp, struct vnode *vp, struct componentname *cnp,
2595 struct timespec *tsp, struct timespec *dtsp, int flags)
2598 MPASS((flags & ~(VFS_CACHE_DROPOLD)) == 0);
2600 if (flags & VFS_CACHE_DROPOLD)
2601 cache_remove_cnp(dvp, cnp);
2602 cache_enter_time(dvp, vp, cnp, tsp, dtsp);
2606 cache_roundup_2(u_int val)
2610 for (res = 1; res <= val; res <<= 1)
2616 static struct nchashhead *
2617 nchinittbl(u_long elements, u_long *hashmask)
2619 struct nchashhead *hashtbl;
2622 hashsize = cache_roundup_2(elements) / 2;
2624 hashtbl = malloc((u_long)hashsize * sizeof(*hashtbl), M_VFSCACHE, M_WAITOK);
2625 for (i = 0; i < hashsize; i++)
2626 CK_SLIST_INIT(&hashtbl[i]);
2627 *hashmask = hashsize - 1;
2632 ncfreetbl(struct nchashhead *hashtbl)
2635 free(hashtbl, M_VFSCACHE);
2639 * Name cache initialization, from vfs_init() when we are booting
2642 nchinit(void *dummy __unused)
2646 cache_zone_small = uma_zcreate("S VFS Cache", CACHE_ZONE_SMALL_SIZE,
2647 NULL, NULL, NULL, NULL, CACHE_ZONE_ALIGNMENT, UMA_ZONE_ZINIT);
2648 cache_zone_small_ts = uma_zcreate("STS VFS Cache", CACHE_ZONE_SMALL_TS_SIZE,
2649 NULL, NULL, NULL, NULL, CACHE_ZONE_ALIGNMENT, UMA_ZONE_ZINIT);
2650 cache_zone_large = uma_zcreate("L VFS Cache", CACHE_ZONE_LARGE_SIZE,
2651 NULL, NULL, NULL, NULL, CACHE_ZONE_ALIGNMENT, UMA_ZONE_ZINIT);
2652 cache_zone_large_ts = uma_zcreate("LTS VFS Cache", CACHE_ZONE_LARGE_TS_SIZE,
2653 NULL, NULL, NULL, NULL, CACHE_ZONE_ALIGNMENT, UMA_ZONE_ZINIT);
2655 VFS_SMR_ZONE_SET(cache_zone_small);
2656 VFS_SMR_ZONE_SET(cache_zone_small_ts);
2657 VFS_SMR_ZONE_SET(cache_zone_large);
2658 VFS_SMR_ZONE_SET(cache_zone_large_ts);
2660 ncsize = desiredvnodes * ncsizefactor;
2661 cache_recalc_neg_min(ncnegminpct);
2662 nchashtbl = nchinittbl(desiredvnodes * 2, &nchash);
2663 ncbuckethash = cache_roundup_2(mp_ncpus * mp_ncpus) - 1;
2664 if (ncbuckethash < 7) /* arbitrarily chosen to avoid having one lock */
2666 if (ncbuckethash > nchash)
2667 ncbuckethash = nchash;
2668 bucketlocks = malloc(sizeof(*bucketlocks) * numbucketlocks, M_VFSCACHE,
2670 for (i = 0; i < numbucketlocks; i++)
2671 mtx_init(&bucketlocks[i], "ncbuc", NULL, MTX_DUPOK | MTX_RECURSE);
2672 ncvnodehash = ncbuckethash;
2673 vnodelocks = malloc(sizeof(*vnodelocks) * numvnodelocks, M_VFSCACHE,
2675 for (i = 0; i < numvnodelocks; i++)
2676 mtx_init(&vnodelocks[i], "ncvn", NULL, MTX_DUPOK | MTX_RECURSE);
2678 for (i = 0; i < numneglists; i++) {
2679 mtx_init(&neglists[i].nl_evict_lock, "ncnege", NULL, MTX_DEF);
2680 mtx_init(&neglists[i].nl_lock, "ncnegl", NULL, MTX_DEF);
2681 TAILQ_INIT(&neglists[i].nl_list);
2682 TAILQ_INIT(&neglists[i].nl_hotlist);
2685 SYSINIT(vfs, SI_SUB_VFS, SI_ORDER_SECOND, nchinit, NULL);
2688 cache_vnode_init(struct vnode *vp)
2691 LIST_INIT(&vp->v_cache_src);
2692 TAILQ_INIT(&vp->v_cache_dst);
2693 vp->v_cache_dd = NULL;
2698 * Induce transient cache misses for lockless operation in cache_lookup() by
2699 * using a temporary hash table.
2701 * This will force a fs lookup.
2703 * Synchronisation is done in 2 steps, calling vfs_smr_synchronize each time
2704 * to observe all CPUs not performing the lookup.
2707 cache_changesize_set_temp(struct nchashhead *temptbl, u_long temphash)
2710 MPASS(temphash < nchash);
2712 * Change the size. The new size is smaller and can safely be used
2713 * against the existing table. All lookups which now hash wrong will
2714 * result in a cache miss, which all callers are supposed to know how
2717 atomic_store_long(&nchash, temphash);
2718 atomic_thread_fence_rel();
2719 vfs_smr_synchronize();
2721 * At this point everyone sees the updated hash value, but they still
2722 * see the old table.
2724 atomic_store_ptr(&nchashtbl, temptbl);
2725 atomic_thread_fence_rel();
2726 vfs_smr_synchronize();
2728 * At this point everyone sees the updated table pointer and size pair.
2733 * Set the new hash table.
2735 * Similarly to cache_changesize_set_temp(), this has to synchronize against
2736 * lockless operation in cache_lookup().
2739 cache_changesize_set_new(struct nchashhead *new_tbl, u_long new_hash)
2742 MPASS(nchash < new_hash);
2744 * Change the pointer first. This wont result in out of bounds access
2745 * since the temporary table is guaranteed to be smaller.
2747 atomic_store_ptr(&nchashtbl, new_tbl);
2748 atomic_thread_fence_rel();
2749 vfs_smr_synchronize();
2751 * At this point everyone sees the updated pointer value, but they
2752 * still see the old size.
2754 atomic_store_long(&nchash, new_hash);
2755 atomic_thread_fence_rel();
2756 vfs_smr_synchronize();
2758 * At this point everyone sees the updated table pointer and size pair.
2763 cache_changesize(u_long newmaxvnodes)
2765 struct nchashhead *new_nchashtbl, *old_nchashtbl, *temptbl;
2766 u_long new_nchash, old_nchash, temphash;
2767 struct namecache *ncp;
2772 newncsize = newmaxvnodes * ncsizefactor;
2773 newmaxvnodes = cache_roundup_2(newmaxvnodes * 2);
2774 if (newmaxvnodes < numbucketlocks)
2775 newmaxvnodes = numbucketlocks;
2777 new_nchashtbl = nchinittbl(newmaxvnodes, &new_nchash);
2778 /* If same hash table size, nothing to do */
2779 if (nchash == new_nchash) {
2780 ncfreetbl(new_nchashtbl);
2784 temptbl = nchinittbl(1, &temphash);
2787 * Move everything from the old hash table to the new table.
2788 * None of the namecache entries in the table can be removed
2789 * because to do so, they have to be removed from the hash table.
2791 cache_lock_all_vnodes();
2792 cache_lock_all_buckets();
2793 old_nchashtbl = nchashtbl;
2794 old_nchash = nchash;
2795 cache_changesize_set_temp(temptbl, temphash);
2796 for (i = 0; i <= old_nchash; i++) {
2797 while ((ncp = CK_SLIST_FIRST(&old_nchashtbl[i])) != NULL) {
2798 hash = cache_get_hash(ncp->nc_name, ncp->nc_nlen,
2800 CK_SLIST_REMOVE(&old_nchashtbl[i], ncp, namecache, nc_hash);
2801 CK_SLIST_INSERT_HEAD(&new_nchashtbl[hash & new_nchash], ncp, nc_hash);
2805 cache_recalc_neg_min(ncnegminpct);
2806 cache_changesize_set_new(new_nchashtbl, new_nchash);
2807 cache_unlock_all_buckets();
2808 cache_unlock_all_vnodes();
2809 ncfreetbl(old_nchashtbl);
2814 * Remove all entries from and to a particular vnode.
2817 cache_purge_impl(struct vnode *vp)
2819 struct cache_freebatch batch;
2820 struct namecache *ncp;
2821 struct mtx *vlp, *vlp2;
2824 vlp = VP2VNODELOCK(vp);
2828 while (!LIST_EMPTY(&vp->v_cache_src)) {
2829 ncp = LIST_FIRST(&vp->v_cache_src);
2830 if (!cache_zap_locked_vnode_kl2(ncp, vp, &vlp2))
2832 TAILQ_INSERT_TAIL(&batch, ncp, nc_dst);
2834 while (!TAILQ_EMPTY(&vp->v_cache_dst)) {
2835 ncp = TAILQ_FIRST(&vp->v_cache_dst);
2836 if (!cache_zap_locked_vnode_kl2(ncp, vp, &vlp2))
2838 TAILQ_INSERT_TAIL(&batch, ncp, nc_dst);
2840 ncp = vp->v_cache_dd;
2842 KASSERT(ncp->nc_flag & NCF_ISDOTDOT,
2843 ("lost dotdot link"));
2844 if (!cache_zap_locked_vnode_kl2(ncp, vp, &vlp2))
2846 TAILQ_INSERT_TAIL(&batch, ncp, nc_dst);
2848 KASSERT(vp->v_cache_dd == NULL, ("incomplete purge"));
2852 cache_free_batch(&batch);
2856 * Opportunistic check to see if there is anything to do.
2859 cache_has_entries(struct vnode *vp)
2862 if (LIST_EMPTY(&vp->v_cache_src) && TAILQ_EMPTY(&vp->v_cache_dst) &&
2863 atomic_load_ptr(&vp->v_cache_dd) == NULL)
2869 cache_purge(struct vnode *vp)
2872 SDT_PROBE1(vfs, namecache, purge, done, vp);
2873 if (!cache_has_entries(vp))
2875 cache_purge_impl(vp);
2879 * Only to be used by vgone.
2882 cache_purge_vgone(struct vnode *vp)
2886 VNPASS(VN_IS_DOOMED(vp), vp);
2887 if (cache_has_entries(vp)) {
2888 cache_purge_impl(vp);
2893 * Serialize against a potential thread doing cache_purge.
2895 vlp = VP2VNODELOCK(vp);
2896 mtx_wait_unlocked(vlp);
2897 if (cache_has_entries(vp)) {
2898 cache_purge_impl(vp);
2905 * Remove all negative entries for a particular directory vnode.
2908 cache_purge_negative(struct vnode *vp)
2910 struct cache_freebatch batch;
2911 struct namecache *ncp, *nnp;
2914 SDT_PROBE1(vfs, namecache, purge_negative, done, vp);
2915 if (LIST_EMPTY(&vp->v_cache_src))
2918 vlp = VP2VNODELOCK(vp);
2920 LIST_FOREACH_SAFE(ncp, &vp->v_cache_src, nc_src, nnp) {
2921 if (!(ncp->nc_flag & NCF_NEGATIVE))
2923 cache_zap_negative_locked_vnode_kl(ncp, vp);
2924 TAILQ_INSERT_TAIL(&batch, ncp, nc_dst);
2927 cache_free_batch(&batch);
2931 * Entry points for modifying VOP operations.
2934 cache_vop_rename(struct vnode *fdvp, struct vnode *fvp, struct vnode *tdvp,
2935 struct vnode *tvp, struct componentname *fcnp, struct componentname *tcnp)
2938 ASSERT_VOP_IN_SEQC(fdvp);
2939 ASSERT_VOP_IN_SEQC(fvp);
2940 ASSERT_VOP_IN_SEQC(tdvp);
2942 ASSERT_VOP_IN_SEQC(tvp);
2947 KASSERT(!cache_remove_cnp(tdvp, tcnp),
2948 ("%s: lingering negative entry", __func__));
2950 cache_remove_cnp(tdvp, tcnp);
2956 * Historically renaming was always purging all revelang entries,
2957 * but that's quite wasteful. In particular turns out that in many cases
2958 * the target file is immediately accessed after rename, inducing a cache
2961 * Recode this to reduce relocking and reuse the existing entry (if any)
2962 * instead of just removing it above and allocating a new one here.
2964 if (cache_rename_add) {
2965 cache_enter(tdvp, fvp, tcnp);
2970 cache_vop_rmdir(struct vnode *dvp, struct vnode *vp)
2973 ASSERT_VOP_IN_SEQC(dvp);
2974 ASSERT_VOP_IN_SEQC(vp);
2980 * Validate that if an entry exists it matches.
2983 cache_validate(struct vnode *dvp, struct vnode *vp, struct componentname *cnp)
2985 struct namecache *ncp;
2989 hash = cache_get_hash(cnp->cn_nameptr, cnp->cn_namelen, dvp);
2990 if (CK_SLIST_EMPTY(NCHHASH(hash)))
2992 blp = HASH2BUCKETLOCK(hash);
2994 CK_SLIST_FOREACH(ncp, (NCHHASH(hash)), nc_hash) {
2995 if (ncp->nc_dvp == dvp && ncp->nc_nlen == cnp->cn_namelen &&
2996 !bcmp(ncp->nc_name, cnp->cn_nameptr, ncp->nc_nlen)) {
2997 if (ncp->nc_vp != vp)
2998 panic("%s: mismatch (%p != %p); ncp %p [%s] dvp %p\n",
2999 __func__, vp, ncp->nc_vp, ncp, ncp->nc_name, ncp->nc_dvp);
3007 * Flush all entries referencing a particular filesystem.
3010 cache_purgevfs(struct mount *mp)
3012 struct vnode *vp, *mvp;
3013 size_t visited, purged;
3015 visited = purged = 0;
3017 * Somewhat wasteful iteration over all vnodes. Would be better to
3018 * support filtering and avoid the interlock to begin with.
3020 MNT_VNODE_FOREACH_ALL(vp, mp, mvp) {
3022 if (!cache_has_entries(vp)) {
3033 SDT_PROBE3(vfs, namecache, purgevfs, done, mp, visited, purged);
3037 * Perform canonical checks and cache lookup and pass on to filesystem
3038 * through the vop_cachedlookup only if needed.
3042 vfs_cache_lookup(struct vop_lookup_args *ap)
3046 struct vnode **vpp = ap->a_vpp;
3047 struct componentname *cnp = ap->a_cnp;
3048 int flags = cnp->cn_flags;
3053 if (dvp->v_type != VDIR)
3056 if ((flags & ISLASTCN) && (dvp->v_mount->mnt_flag & MNT_RDONLY) &&
3057 (cnp->cn_nameiop == DELETE || cnp->cn_nameiop == RENAME))
3060 error = vn_dir_check_exec(dvp, cnp);
3064 error = cache_lookup(dvp, vpp, cnp, NULL, NULL);
3066 return (VOP_CACHEDLOOKUP(dvp, vpp, cnp));
3072 /* Implementation of the getcwd syscall. */
3074 sys___getcwd(struct thread *td, struct __getcwd_args *uap)
3080 buflen = uap->buflen;
3081 if (__predict_false(buflen < 2))
3083 if (buflen > MAXPATHLEN)
3084 buflen = MAXPATHLEN;
3086 buf = uma_zalloc(namei_zone, M_WAITOK);
3087 error = vn_getcwd(buf, &retbuf, &buflen);
3089 error = copyout(retbuf, uap->buf, buflen);
3090 uma_zfree(namei_zone, buf);
3095 vn_getcwd(char *buf, char **retbuf, size_t *buflen)
3101 pwd = pwd_get_smr();
3102 error = vn_fullpath_any_smr(pwd->pwd_cdir, pwd->pwd_rdir, buf, retbuf,
3104 VFS_SMR_ASSERT_NOT_ENTERED();
3106 pwd = pwd_hold(curthread);
3107 error = vn_fullpath_any(pwd->pwd_cdir, pwd->pwd_rdir, buf,
3113 if (KTRPOINT(curthread, KTR_NAMEI) && error == 0)
3120 kern___realpathat(struct thread *td, int fd, const char *path, char *buf,
3121 size_t size, int flags, enum uio_seg pathseg)
3123 struct nameidata nd;
3124 char *retbuf, *freebuf;
3129 NDINIT_ATRIGHTS(&nd, LOOKUP, FOLLOW | SAVENAME | WANTPARENT | AUDITVNODE1,
3130 pathseg, path, fd, &cap_fstat_rights, td);
3131 if ((error = namei(&nd)) != 0)
3133 error = vn_fullpath_hardlink(nd.ni_vp, nd.ni_dvp, nd.ni_cnd.cn_nameptr,
3134 nd.ni_cnd.cn_namelen, &retbuf, &freebuf, &size);
3136 error = copyout(retbuf, buf, size);
3137 free(freebuf, M_TEMP);
3144 sys___realpathat(struct thread *td, struct __realpathat_args *uap)
3147 return (kern___realpathat(td, uap->fd, uap->path, uap->buf, uap->size,
3148 uap->flags, UIO_USERSPACE));
3152 * Retrieve the full filesystem path that correspond to a vnode from the name
3153 * cache (if available)
3156 vn_fullpath(struct vnode *vp, char **retbuf, char **freebuf)
3163 if (__predict_false(vp == NULL))
3166 buflen = MAXPATHLEN;
3167 buf = malloc(buflen, M_TEMP, M_WAITOK);
3169 pwd = pwd_get_smr();
3170 error = vn_fullpath_any_smr(vp, pwd->pwd_rdir, buf, retbuf, &buflen, 0);
3171 VFS_SMR_ASSERT_NOT_ENTERED();
3173 pwd = pwd_hold(curthread);
3174 error = vn_fullpath_any(vp, pwd->pwd_rdir, buf, retbuf, &buflen);
3185 * This function is similar to vn_fullpath, but it attempts to lookup the
3186 * pathname relative to the global root mount point. This is required for the
3187 * auditing sub-system, as audited pathnames must be absolute, relative to the
3188 * global root mount point.
3191 vn_fullpath_global(struct vnode *vp, char **retbuf, char **freebuf)
3197 if (__predict_false(vp == NULL))
3199 buflen = MAXPATHLEN;
3200 buf = malloc(buflen, M_TEMP, M_WAITOK);
3202 error = vn_fullpath_any_smr(vp, rootvnode, buf, retbuf, &buflen, 0);
3203 VFS_SMR_ASSERT_NOT_ENTERED();
3205 error = vn_fullpath_any(vp, rootvnode, buf, retbuf, &buflen);
3214 static struct namecache *
3215 vn_dd_from_dst(struct vnode *vp)
3217 struct namecache *ncp;
3219 cache_assert_vnode_locked(vp);
3220 TAILQ_FOREACH(ncp, &vp->v_cache_dst, nc_dst) {
3221 if ((ncp->nc_flag & NCF_ISDOTDOT) == 0)
3228 vn_vptocnp(struct vnode **vp, char *buf, size_t *buflen)
3231 struct namecache *ncp;
3235 vlp = VP2VNODELOCK(*vp);
3237 ncp = (*vp)->v_cache_dd;
3238 if (ncp != NULL && (ncp->nc_flag & NCF_ISDOTDOT) == 0) {
3239 KASSERT(ncp == vn_dd_from_dst(*vp),
3240 ("%s: mismatch for dd entry (%p != %p)", __func__,
3241 ncp, vn_dd_from_dst(*vp)));
3243 ncp = vn_dd_from_dst(*vp);
3246 if (*buflen < ncp->nc_nlen) {
3249 counter_u64_add(numfullpathfail4, 1);
3251 SDT_PROBE3(vfs, namecache, fullpath, return, error,
3255 *buflen -= ncp->nc_nlen;
3256 memcpy(buf + *buflen, ncp->nc_name, ncp->nc_nlen);
3257 SDT_PROBE3(vfs, namecache, fullpath, hit, ncp->nc_dvp,
3266 SDT_PROBE1(vfs, namecache, fullpath, miss, vp);
3269 vn_lock(*vp, LK_SHARED | LK_RETRY);
3270 error = VOP_VPTOCNP(*vp, &dvp, buf, buflen);
3273 counter_u64_add(numfullpathfail2, 1);
3274 SDT_PROBE3(vfs, namecache, fullpath, return, error, vp, NULL);
3279 if (VN_IS_DOOMED(dvp)) {
3280 /* forced unmount */
3283 SDT_PROBE3(vfs, namecache, fullpath, return, error, vp, NULL);
3287 * *vp has its use count incremented still.
3294 * Resolve a directory to a pathname.
3296 * The name of the directory can always be found in the namecache or fetched
3297 * from the filesystem. There is also guaranteed to be only one parent, meaning
3298 * we can just follow vnodes up until we find the root.
3300 * The vnode must be referenced.
3303 vn_fullpath_dir(struct vnode *vp, struct vnode *rdir, char *buf, char **retbuf,
3304 size_t *len, size_t addend)
3306 #ifdef KDTRACE_HOOKS
3307 struct vnode *startvp = vp;
3312 bool slash_prefixed;
3314 VNPASS(vp->v_type == VDIR || VN_IS_DOOMED(vp), vp);
3315 VNPASS(vp->v_usecount > 0, vp);
3319 slash_prefixed = true;
3324 slash_prefixed = false;
3329 SDT_PROBE1(vfs, namecache, fullpath, entry, vp);
3330 counter_u64_add(numfullpathcalls, 1);
3331 while (vp != rdir && vp != rootvnode) {
3333 * The vp vnode must be already fully constructed,
3334 * since it is either found in namecache or obtained
3335 * from VOP_VPTOCNP(). We may test for VV_ROOT safely
3336 * without obtaining the vnode lock.
3338 if ((vp->v_vflag & VV_ROOT) != 0) {
3339 vn_lock(vp, LK_RETRY | LK_SHARED);
3342 * With the vnode locked, check for races with
3343 * unmount, forced or not. Note that we
3344 * already verified that vp is not equal to
3345 * the root vnode, which means that
3346 * mnt_vnodecovered can be NULL only for the
3349 if (VN_IS_DOOMED(vp) ||
3350 (vp1 = vp->v_mount->mnt_vnodecovered) == NULL ||
3351 vp1->v_mountedhere != vp->v_mount) {
3354 SDT_PROBE3(vfs, namecache, fullpath, return,
3364 if (vp->v_type != VDIR) {
3366 counter_u64_add(numfullpathfail1, 1);
3368 SDT_PROBE3(vfs, namecache, fullpath, return,
3372 error = vn_vptocnp(&vp, buf, &buflen);
3378 SDT_PROBE3(vfs, namecache, fullpath, return, error,
3382 buf[--buflen] = '/';
3383 slash_prefixed = true;
3387 if (!slash_prefixed) {
3390 counter_u64_add(numfullpathfail4, 1);
3391 SDT_PROBE3(vfs, namecache, fullpath, return, ENOMEM,
3395 buf[--buflen] = '/';
3397 counter_u64_add(numfullpathfound, 1);
3400 *retbuf = buf + buflen;
3401 SDT_PROBE3(vfs, namecache, fullpath, return, 0, startvp, *retbuf);
3408 * Resolve an arbitrary vnode to a pathname.
3411 * - hardlinks are not tracked, thus if the vnode is not a directory this can
3412 * resolve to a different path than the one used to find it
3413 * - namecache is not mandatory, meaning names are not guaranteed to be added
3414 * (in which case resolving fails)
3416 static void __inline
3417 cache_rev_failed_impl(int *reason, int line)
3422 #define cache_rev_failed(var) cache_rev_failed_impl((var), __LINE__)
3425 vn_fullpath_any_smr(struct vnode *vp, struct vnode *rdir, char *buf,
3426 char **retbuf, size_t *buflen, size_t addend)
3428 #ifdef KDTRACE_HOOKS
3429 struct vnode *startvp = vp;
3433 struct namecache *ncp;
3437 #ifdef KDTRACE_HOOKS
3440 seqc_t vp_seqc, tvp_seqc;
3443 VFS_SMR_ASSERT_ENTERED();
3445 if (!atomic_load_char(&cache_fast_lookup_enabled)) {
3450 orig_buflen = *buflen;
3453 MPASS(*buflen >= 2);
3455 buf[*buflen] = '\0';
3458 if (vp == rdir || vp == rootvnode) {
3466 #ifdef KDTRACE_HOOKS
3470 ncp = NULL; /* for sdt probe down below */
3471 vp_seqc = vn_seqc_read_any(vp);
3472 if (seqc_in_modify(vp_seqc)) {
3473 cache_rev_failed(&reason);
3478 #ifdef KDTRACE_HOOKS
3481 if ((vp->v_vflag & VV_ROOT) != 0) {
3482 mp = atomic_load_ptr(&vp->v_mount);
3484 cache_rev_failed(&reason);
3487 tvp = atomic_load_ptr(&mp->mnt_vnodecovered);
3488 tvp_seqc = vn_seqc_read_any(tvp);
3489 if (seqc_in_modify(tvp_seqc)) {
3490 cache_rev_failed(&reason);
3493 if (!vn_seqc_consistent(vp, vp_seqc)) {
3494 cache_rev_failed(&reason);
3501 ncp = atomic_load_consume_ptr(&vp->v_cache_dd);
3503 cache_rev_failed(&reason);
3506 nc_flag = atomic_load_char(&ncp->nc_flag);
3507 if ((nc_flag & NCF_ISDOTDOT) != 0) {
3508 cache_rev_failed(&reason);
3511 if (ncp->nc_nlen >= *buflen) {
3512 cache_rev_failed(&reason);
3516 *buflen -= ncp->nc_nlen;
3517 memcpy(buf + *buflen, ncp->nc_name, ncp->nc_nlen);
3521 tvp_seqc = vn_seqc_read_any(tvp);
3522 if (seqc_in_modify(tvp_seqc)) {
3523 cache_rev_failed(&reason);
3526 if (!vn_seqc_consistent(vp, vp_seqc)) {
3527 cache_rev_failed(&reason);
3531 * Acquire fence provided by vn_seqc_read_any above.
3533 if (__predict_false(atomic_load_ptr(&vp->v_cache_dd) != ncp)) {
3534 cache_rev_failed(&reason);
3537 if (!cache_ncp_canuse(ncp)) {
3538 cache_rev_failed(&reason);
3543 if (vp == rdir || vp == rootvnode)
3548 *retbuf = buf + *buflen;
3549 *buflen = orig_buflen - *buflen + addend;
3550 SDT_PROBE2(vfs, namecache, fullpath_smr, hit, startvp, *retbuf);
3554 *buflen = orig_buflen;
3555 SDT_PROBE4(vfs, namecache, fullpath_smr, miss, startvp, ncp, reason, i);
3561 vn_fullpath_any(struct vnode *vp, struct vnode *rdir, char *buf, char **retbuf,
3564 size_t orig_buflen, addend;
3570 orig_buflen = *buflen;
3574 if (vp->v_type != VDIR) {
3576 buf[*buflen] = '\0';
3577 error = vn_vptocnp(&vp, buf, buflen);
3586 addend = orig_buflen - *buflen;
3589 return (vn_fullpath_dir(vp, rdir, buf, retbuf, buflen, addend));
3593 * Resolve an arbitrary vnode to a pathname (taking care of hardlinks).
3595 * Since the namecache does not track hardlinks, the caller is
3596 * expected to first look up the target vnode with SAVENAME |
3597 * WANTPARENT flags passed to namei to get dvp and vp.
3599 * Then we have 2 cases:
3600 * - if the found vnode is a directory, the path can be constructed just by
3601 * following names up the chain
3602 * - otherwise we populate the buffer with the saved name and start resolving
3606 vn_fullpath_hardlink(struct vnode *vp, struct vnode *dvp,
3607 const char *hrdl_name, size_t hrdl_name_length,
3608 char **retbuf, char **freebuf, size_t *buflen)
3618 if (*buflen > MAXPATHLEN)
3619 *buflen = MAXPATHLEN;
3621 buf = malloc(*buflen, M_TEMP, M_WAITOK);
3626 * Check for VBAD to work around the vp_crossmp bug in lookup().
3628 * For example consider tmpfs on /tmp and realpath /tmp. ni_vp will be
3629 * set to mount point's root vnode while ni_dvp will be vp_crossmp.
3630 * If the type is VDIR (like in this very case) we can skip looking
3631 * at ni_dvp in the first place. However, since vnodes get passed here
3632 * unlocked the target may transition to doomed state (type == VBAD)
3633 * before we get to evaluate the condition. If this happens, we will
3634 * populate part of the buffer and descend to vn_fullpath_dir with
3635 * vp == vp_crossmp. Prevent the problem by checking for VBAD.
3637 * This should be atomic_load(&vp->v_type) but it is illegal to take
3638 * an address of a bit field, even if said field is sized to char.
3639 * Work around the problem by reading the value into a full-sized enum
3640 * and then re-reading it with atomic_load which will still prevent
3641 * the compiler from re-reading down the road.
3644 type = atomic_load_int(&type);
3650 addend = hrdl_name_length + 2;
3651 if (*buflen < addend) {
3656 tmpbuf = buf + *buflen;
3658 memcpy(&tmpbuf[1], hrdl_name, hrdl_name_length);
3659 tmpbuf[addend - 1] = '\0';
3664 pwd = pwd_get_smr();
3665 error = vn_fullpath_any_smr(vp, pwd->pwd_rdir, buf, retbuf, buflen,
3667 VFS_SMR_ASSERT_NOT_ENTERED();
3669 pwd = pwd_hold(curthread);
3671 error = vn_fullpath_dir(vp, pwd->pwd_rdir, buf, retbuf, buflen,
3687 vn_dir_dd_ino(struct vnode *vp)
3689 struct namecache *ncp;
3694 ASSERT_VOP_LOCKED(vp, "vn_dir_dd_ino");
3695 vlp = VP2VNODELOCK(vp);
3697 TAILQ_FOREACH(ncp, &(vp->v_cache_dst), nc_dst) {
3698 if ((ncp->nc_flag & NCF_ISDOTDOT) != 0)
3701 vs = vget_prep(ddvp);
3703 if (vget_finish(ddvp, LK_SHARED | LK_NOWAIT, vs))
3712 vn_commname(struct vnode *vp, char *buf, u_int buflen)
3714 struct namecache *ncp;
3718 vlp = VP2VNODELOCK(vp);
3720 TAILQ_FOREACH(ncp, &vp->v_cache_dst, nc_dst)
3721 if ((ncp->nc_flag & NCF_ISDOTDOT) == 0)
3727 l = min(ncp->nc_nlen, buflen - 1);
3728 memcpy(buf, ncp->nc_name, l);
3735 * This function updates path string to vnode's full global path
3736 * and checks the size of the new path string against the pathlen argument.
3738 * Requires a locked, referenced vnode.
3739 * Vnode is re-locked on success or ENODEV, otherwise unlocked.
3741 * If vp is a directory, the call to vn_fullpath_global() always succeeds
3742 * because it falls back to the ".." lookup if the namecache lookup fails.
3745 vn_path_to_global_path(struct thread *td, struct vnode *vp, char *path,
3748 struct nameidata nd;
3753 ASSERT_VOP_ELOCKED(vp, __func__);
3755 /* Construct global filesystem path from vp. */
3757 error = vn_fullpath_global(vp, &rpath, &fbuf);
3764 if (strlen(rpath) >= pathlen) {
3766 error = ENAMETOOLONG;
3771 * Re-lookup the vnode by path to detect a possible rename.
3772 * As a side effect, the vnode is relocked.
3773 * If vnode was renamed, return ENOENT.
3775 NDINIT(&nd, LOOKUP, FOLLOW | LOCKLEAF | AUDITVNODE1,
3776 UIO_SYSSPACE, path, td);
3782 NDFREE(&nd, NDF_ONLY_PNBUF);
3786 strcpy(path, rpath);
3799 db_print_vpath(struct vnode *vp)
3802 while (vp != NULL) {
3803 db_printf("%p: ", vp);
3804 if (vp == rootvnode) {
3808 if (vp->v_vflag & VV_ROOT) {
3809 db_printf("<mount point>");
3810 vp = vp->v_mount->mnt_vnodecovered;
3812 struct namecache *ncp;
3816 ncp = TAILQ_FIRST(&vp->v_cache_dst);
3819 for (i = 0; i < ncp->nc_nlen; i++)
3820 db_printf("%c", *ncn++);
3833 DB_SHOW_COMMAND(vpath, db_show_vpath)
3838 db_printf("usage: show vpath <struct vnode *>\n");
3842 vp = (struct vnode *)addr;
3848 static int cache_fast_lookup = 1;
3850 #define CACHE_FPL_FAILED -2020
3853 cache_fast_lookup_enabled_recalc(void)
3859 mac_on = mac_vnode_check_lookup_enabled();
3860 mac_on |= mac_vnode_check_readlink_enabled();
3865 lookup_flag = atomic_load_int(&cache_fast_lookup);
3866 if (lookup_flag && !mac_on) {
3867 atomic_store_char(&cache_fast_lookup_enabled, true);
3869 atomic_store_char(&cache_fast_lookup_enabled, false);
3874 syscal_vfs_cache_fast_lookup(SYSCTL_HANDLER_ARGS)
3878 old = atomic_load_int(&cache_fast_lookup);
3879 error = sysctl_handle_int(oidp, arg1, arg2, req);
3880 if (error == 0 && req->newptr && old != atomic_load_int(&cache_fast_lookup))
3881 cache_fast_lookup_enabled_recalc();
3884 SYSCTL_PROC(_vfs, OID_AUTO, cache_fast_lookup, CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_MPSAFE,
3885 &cache_fast_lookup, 0, syscal_vfs_cache_fast_lookup, "IU", "");
3888 * Components of nameidata (or objects it can point to) which may
3889 * need restoring in case fast path lookup fails.
3891 struct nameidata_outer {
3896 struct nameidata_saved {
3904 struct cache_fpl_debug {
3910 struct nameidata *ndp;
3911 struct componentname *cnp;
3918 struct nameidata_saved snd;
3919 struct nameidata_outer snd_outer;
3921 enum cache_fpl_status status:8;
3927 struct cache_fpl_debug debug;
3931 static bool cache_fplookup_mp_supported(struct mount *mp);
3932 static bool cache_fplookup_is_mp(struct cache_fpl *fpl);
3933 static int cache_fplookup_cross_mount(struct cache_fpl *fpl);
3934 static int cache_fplookup_partial_setup(struct cache_fpl *fpl);
3935 static int cache_fplookup_skip_slashes(struct cache_fpl *fpl);
3936 static int cache_fplookup_trailingslash(struct cache_fpl *fpl);
3937 static void cache_fpl_pathlen_dec(struct cache_fpl *fpl);
3938 static void cache_fpl_pathlen_inc(struct cache_fpl *fpl);
3939 static void cache_fpl_pathlen_add(struct cache_fpl *fpl, size_t n);
3940 static void cache_fpl_pathlen_sub(struct cache_fpl *fpl, size_t n);
3943 cache_fpl_cleanup_cnp(struct componentname *cnp)
3946 uma_zfree(namei_zone, cnp->cn_pnbuf);
3948 cnp->cn_pnbuf = NULL;
3949 cnp->cn_nameptr = NULL;
3953 static struct vnode *
3954 cache_fpl_handle_root(struct cache_fpl *fpl)
3956 struct nameidata *ndp;
3957 struct componentname *cnp;
3962 MPASS(*(cnp->cn_nameptr) == '/');
3964 cache_fpl_pathlen_dec(fpl);
3966 if (__predict_false(*(cnp->cn_nameptr) == '/')) {
3969 cache_fpl_pathlen_dec(fpl);
3970 } while (*(cnp->cn_nameptr) == '/');
3973 return (ndp->ni_rootdir);
3977 cache_fpl_checkpoint_outer(struct cache_fpl *fpl)
3980 fpl->snd_outer.ni_pathlen = fpl->ndp->ni_pathlen;
3981 fpl->snd_outer.cn_flags = fpl->ndp->ni_cnd.cn_flags;
3985 cache_fpl_checkpoint(struct cache_fpl *fpl)
3989 fpl->snd.cn_nameptr = fpl->ndp->ni_cnd.cn_nameptr;
3990 fpl->snd.ni_pathlen = fpl->debug.ni_pathlen;
3995 cache_fpl_restore_partial(struct cache_fpl *fpl)
3998 fpl->ndp->ni_cnd.cn_flags = fpl->snd_outer.cn_flags;
4000 fpl->debug.ni_pathlen = fpl->snd.ni_pathlen;
4005 cache_fpl_restore_abort(struct cache_fpl *fpl)
4008 cache_fpl_restore_partial(fpl);
4010 * It is 0 on entry by API contract.
4012 fpl->ndp->ni_resflags = 0;
4013 fpl->ndp->ni_cnd.cn_nameptr = fpl->ndp->ni_cnd.cn_pnbuf;
4014 fpl->ndp->ni_pathlen = fpl->snd_outer.ni_pathlen;
4018 #define cache_fpl_smr_assert_entered(fpl) ({ \
4019 struct cache_fpl *_fpl = (fpl); \
4020 MPASS(_fpl->in_smr == true); \
4021 VFS_SMR_ASSERT_ENTERED(); \
4023 #define cache_fpl_smr_assert_not_entered(fpl) ({ \
4024 struct cache_fpl *_fpl = (fpl); \
4025 MPASS(_fpl->in_smr == false); \
4026 VFS_SMR_ASSERT_NOT_ENTERED(); \
4029 cache_fpl_assert_status(struct cache_fpl *fpl)
4032 switch (fpl->status) {
4033 case CACHE_FPL_STATUS_UNSET:
4034 __assert_unreachable();
4036 case CACHE_FPL_STATUS_DESTROYED:
4037 case CACHE_FPL_STATUS_ABORTED:
4038 case CACHE_FPL_STATUS_PARTIAL:
4039 case CACHE_FPL_STATUS_HANDLED:
4044 #define cache_fpl_smr_assert_entered(fpl) do { } while (0)
4045 #define cache_fpl_smr_assert_not_entered(fpl) do { } while (0)
4046 #define cache_fpl_assert_status(fpl) do { } while (0)
4049 #define cache_fpl_smr_enter_initial(fpl) ({ \
4050 struct cache_fpl *_fpl = (fpl); \
4052 _fpl->in_smr = true; \
4055 #define cache_fpl_smr_enter(fpl) ({ \
4056 struct cache_fpl *_fpl = (fpl); \
4057 MPASS(_fpl->in_smr == false); \
4059 _fpl->in_smr = true; \
4062 #define cache_fpl_smr_exit(fpl) ({ \
4063 struct cache_fpl *_fpl = (fpl); \
4064 MPASS(_fpl->in_smr == true); \
4066 _fpl->in_smr = false; \
4070 cache_fpl_aborted_early_impl(struct cache_fpl *fpl, int line)
4073 if (fpl->status != CACHE_FPL_STATUS_UNSET) {
4074 KASSERT(fpl->status == CACHE_FPL_STATUS_PARTIAL,
4075 ("%s: converting to abort from %d at %d, set at %d\n",
4076 __func__, fpl->status, line, fpl->line));
4078 cache_fpl_smr_assert_not_entered(fpl);
4079 fpl->status = CACHE_FPL_STATUS_ABORTED;
4081 return (CACHE_FPL_FAILED);
4084 #define cache_fpl_aborted_early(x) cache_fpl_aborted_early_impl((x), __LINE__)
4086 static int __noinline
4087 cache_fpl_aborted_impl(struct cache_fpl *fpl, int line)
4089 struct nameidata *ndp;
4090 struct componentname *cnp;
4095 if (fpl->status != CACHE_FPL_STATUS_UNSET) {
4096 KASSERT(fpl->status == CACHE_FPL_STATUS_PARTIAL,
4097 ("%s: converting to abort from %d at %d, set at %d\n",
4098 __func__, fpl->status, line, fpl->line));
4100 fpl->status = CACHE_FPL_STATUS_ABORTED;
4103 cache_fpl_smr_exit(fpl);
4104 cache_fpl_restore_abort(fpl);
4106 * Resolving symlinks overwrites data passed by the caller.
4109 if (ndp->ni_loopcnt > 0) {
4110 fpl->status = CACHE_FPL_STATUS_DESTROYED;
4111 cache_fpl_cleanup_cnp(cnp);
4113 return (CACHE_FPL_FAILED);
4116 #define cache_fpl_aborted(x) cache_fpl_aborted_impl((x), __LINE__)
4118 static int __noinline
4119 cache_fpl_partial_impl(struct cache_fpl *fpl, int line)
4122 KASSERT(fpl->status == CACHE_FPL_STATUS_UNSET,
4123 ("%s: setting to partial at %d, but already set to %d at %d\n",
4124 __func__, line, fpl->status, fpl->line));
4125 cache_fpl_smr_assert_entered(fpl);
4126 fpl->status = CACHE_FPL_STATUS_PARTIAL;
4128 return (cache_fplookup_partial_setup(fpl));
4131 #define cache_fpl_partial(x) cache_fpl_partial_impl((x), __LINE__)
4134 cache_fpl_handled_impl(struct cache_fpl *fpl, int line)
4137 KASSERT(fpl->status == CACHE_FPL_STATUS_UNSET,
4138 ("%s: setting to handled at %d, but already set to %d at %d\n",
4139 __func__, line, fpl->status, fpl->line));
4140 cache_fpl_smr_assert_not_entered(fpl);
4141 fpl->status = CACHE_FPL_STATUS_HANDLED;
4146 #define cache_fpl_handled(x) cache_fpl_handled_impl((x), __LINE__)
4149 cache_fpl_handled_error_impl(struct cache_fpl *fpl, int error, int line)
4152 KASSERT(fpl->status == CACHE_FPL_STATUS_UNSET,
4153 ("%s: setting to handled at %d, but already set to %d at %d\n",
4154 __func__, line, fpl->status, fpl->line));
4156 MPASS(error != CACHE_FPL_FAILED);
4157 cache_fpl_smr_assert_not_entered(fpl);
4158 fpl->status = CACHE_FPL_STATUS_HANDLED;
4162 fpl->savename = false;
4166 #define cache_fpl_handled_error(x, e) cache_fpl_handled_error_impl((x), (e), __LINE__)
4169 cache_fpl_terminated(struct cache_fpl *fpl)
4172 return (fpl->status != CACHE_FPL_STATUS_UNSET);
4175 #define CACHE_FPL_SUPPORTED_CN_FLAGS \
4176 (NC_NOMAKEENTRY | NC_KEEPPOSENTRY | LOCKLEAF | LOCKPARENT | WANTPARENT | \
4177 FAILIFEXISTS | FOLLOW | EMPTYPATH | LOCKSHARED | SAVENAME | SAVESTART | \
4178 WILLBEDIR | ISOPEN | NOMACCHECK | AUDITVNODE1 | AUDITVNODE2 | NOCAPCHECK | \
4179 OPENREAD | OPENWRITE)
4181 #define CACHE_FPL_INTERNAL_CN_FLAGS \
4182 (ISDOTDOT | MAKEENTRY | ISLASTCN)
4184 _Static_assert((CACHE_FPL_SUPPORTED_CN_FLAGS & CACHE_FPL_INTERNAL_CN_FLAGS) == 0,
4185 "supported and internal flags overlap");
4188 cache_fpl_islastcn(struct nameidata *ndp)
4191 return (*ndp->ni_next == 0);
4195 cache_fpl_istrailingslash(struct cache_fpl *fpl)
4198 MPASS(fpl->nulchar > fpl->cnp->cn_pnbuf);
4199 return (*(fpl->nulchar - 1) == '/');
4203 cache_fpl_isdotdot(struct componentname *cnp)
4206 if (cnp->cn_namelen == 2 &&
4207 cnp->cn_nameptr[1] == '.' && cnp->cn_nameptr[0] == '.')
4213 cache_can_fplookup(struct cache_fpl *fpl)
4215 struct nameidata *ndp;
4216 struct componentname *cnp;
4223 if (!atomic_load_char(&cache_fast_lookup_enabled)) {
4224 cache_fpl_aborted_early(fpl);
4227 if ((cnp->cn_flags & ~CACHE_FPL_SUPPORTED_CN_FLAGS) != 0) {
4228 cache_fpl_aborted_early(fpl);
4231 if (IN_CAPABILITY_MODE(td)) {
4232 cache_fpl_aborted_early(fpl);
4235 if (AUDITING_TD(td)) {
4236 cache_fpl_aborted_early(fpl);
4239 if (ndp->ni_startdir != NULL) {
4240 cache_fpl_aborted_early(fpl);
4246 static int __noinline
4247 cache_fplookup_dirfd(struct cache_fpl *fpl, struct vnode **vpp)
4249 struct nameidata *ndp;
4250 struct componentname *cnp;
4257 error = fgetvp_lookup_smr(ndp->ni_dirfd, ndp, vpp, &fsearch);
4258 if (__predict_false(error != 0)) {
4259 return (cache_fpl_aborted(fpl));
4261 fpl->fsearch = fsearch;
4262 if ((*vpp)->v_type != VDIR) {
4263 if (!((cnp->cn_flags & EMPTYPATH) != 0 && cnp->cn_pnbuf[0] == '\0')) {
4264 cache_fpl_smr_exit(fpl);
4265 return (cache_fpl_handled_error(fpl, ENOTDIR));
4271 static int __noinline
4272 cache_fplookup_negative_promote(struct cache_fpl *fpl, struct namecache *oncp,
4275 struct componentname *cnp;
4281 cache_fpl_smr_exit(fpl);
4282 if (cache_neg_promote_cond(dvp, cnp, oncp, hash))
4283 return (cache_fpl_handled_error(fpl, ENOENT));
4285 return (cache_fpl_aborted(fpl));
4289 * The target vnode is not supported, prepare for the slow path to take over.
4291 static int __noinline
4292 cache_fplookup_partial_setup(struct cache_fpl *fpl)
4294 struct nameidata *ndp;
4295 struct componentname *cnp;
4305 dvp_seqc = fpl->dvp_seqc;
4307 if (!pwd_hold_smr(pwd)) {
4308 return (cache_fpl_aborted(fpl));
4312 * Note that seqc is checked before the vnode is locked, so by
4313 * the time regular lookup gets to it it may have moved.
4315 * Ultimately this does not affect correctness, any lookup errors
4316 * are userspace racing with itself. It is guaranteed that any
4317 * path which ultimately gets found could also have been found
4318 * by regular lookup going all the way in absence of concurrent
4321 dvs = vget_prep_smr(dvp);
4322 cache_fpl_smr_exit(fpl);
4323 if (__predict_false(dvs == VGET_NONE)) {
4325 return (cache_fpl_aborted(fpl));
4328 vget_finish_ref(dvp, dvs);
4329 if (!vn_seqc_consistent(dvp, dvp_seqc)) {
4332 return (cache_fpl_aborted(fpl));
4335 cache_fpl_restore_partial(fpl);
4337 if (cnp->cn_nameptr != fpl->snd.cn_nameptr) {
4338 panic("%s: cn_nameptr mismatch (%p != %p) full [%s]\n", __func__,
4339 cnp->cn_nameptr, fpl->snd.cn_nameptr, cnp->cn_pnbuf);
4343 ndp->ni_startdir = dvp;
4344 cnp->cn_flags |= MAKEENTRY;
4345 if (cache_fpl_islastcn(ndp))
4346 cnp->cn_flags |= ISLASTCN;
4347 if (cache_fpl_isdotdot(cnp))
4348 cnp->cn_flags |= ISDOTDOT;
4351 * Skip potential extra slashes parsing did not take care of.
4352 * cache_fplookup_skip_slashes explains the mechanism.
4354 if (__predict_false(*(cnp->cn_nameptr) == '/')) {
4357 cache_fpl_pathlen_dec(fpl);
4358 } while (*(cnp->cn_nameptr) == '/');
4361 ndp->ni_pathlen = fpl->nulchar - cnp->cn_nameptr + 1;
4363 if (ndp->ni_pathlen != fpl->debug.ni_pathlen) {
4364 panic("%s: mismatch (%zu != %zu) nulchar %p nameptr %p [%s] ; full string [%s]\n",
4365 __func__, ndp->ni_pathlen, fpl->debug.ni_pathlen, fpl->nulchar,
4366 cnp->cn_nameptr, cnp->cn_nameptr, cnp->cn_pnbuf);
4373 cache_fplookup_final_child(struct cache_fpl *fpl, enum vgetstate tvs)
4375 struct componentname *cnp;
4382 tvp_seqc = fpl->tvp_seqc;
4384 if ((cnp->cn_flags & LOCKLEAF) != 0) {
4385 lkflags = LK_SHARED;
4386 if ((cnp->cn_flags & LOCKSHARED) == 0)
4387 lkflags = LK_EXCLUSIVE;
4388 error = vget_finish(tvp, lkflags, tvs);
4389 if (__predict_false(error != 0)) {
4390 return (cache_fpl_aborted(fpl));
4393 vget_finish_ref(tvp, tvs);
4396 if (!vn_seqc_consistent(tvp, tvp_seqc)) {
4397 if ((cnp->cn_flags & LOCKLEAF) != 0)
4401 return (cache_fpl_aborted(fpl));
4404 return (cache_fpl_handled(fpl));
4408 * They want to possibly modify the state of the namecache.
4410 static int __noinline
4411 cache_fplookup_final_modifying(struct cache_fpl *fpl)
4413 struct nameidata *ndp;
4414 struct componentname *cnp;
4416 struct vnode *dvp, *tvp;
4425 dvp_seqc = fpl->dvp_seqc;
4427 MPASS(*(cnp->cn_nameptr) != '/');
4428 MPASS(cache_fpl_islastcn(ndp));
4429 if ((cnp->cn_flags & LOCKPARENT) == 0)
4430 MPASS((cnp->cn_flags & WANTPARENT) != 0);
4431 MPASS((cnp->cn_flags & TRAILINGSLASH) == 0);
4432 MPASS(cnp->cn_nameiop == CREATE || cnp->cn_nameiop == DELETE ||
4433 cnp->cn_nameiop == RENAME);
4434 MPASS((cnp->cn_flags & MAKEENTRY) == 0);
4435 MPASS((cnp->cn_flags & ISDOTDOT) == 0);
4437 docache = (cnp->cn_flags & NOCACHE) ^ NOCACHE;
4438 if (cnp->cn_nameiop == DELETE || cnp->cn_nameiop == RENAME)
4442 * Regular lookup nulifies the slash, which we don't do here.
4443 * Don't take chances with filesystem routines seeing it for
4446 if (cache_fpl_istrailingslash(fpl)) {
4447 return (cache_fpl_partial(fpl));
4450 mp = atomic_load_ptr(&dvp->v_mount);
4451 if (__predict_false(mp == NULL)) {
4452 return (cache_fpl_aborted(fpl));
4455 if (__predict_false(mp->mnt_flag & MNT_RDONLY)) {
4456 cache_fpl_smr_exit(fpl);
4458 * Original code keeps not checking for CREATE which
4459 * might be a bug. For now let the old lookup decide.
4461 if (cnp->cn_nameiop == CREATE) {
4462 return (cache_fpl_aborted(fpl));
4464 return (cache_fpl_handled_error(fpl, EROFS));
4467 if (fpl->tvp != NULL && (cnp->cn_flags & FAILIFEXISTS) != 0) {
4468 cache_fpl_smr_exit(fpl);
4469 return (cache_fpl_handled_error(fpl, EEXIST));
4473 * Secure access to dvp; check cache_fplookup_partial_setup for
4476 * XXX At least UFS requires its lookup routine to be called for
4477 * the last path component, which leads to some level of complication
4479 * - the target routine always locks the target vnode, but our caller
4480 * may not need it locked
4481 * - some of the VOP machinery asserts that the parent is locked, which
4482 * once more may be not required
4484 * TODO: add a flag for filesystems which don't need this.
4486 dvs = vget_prep_smr(dvp);
4487 cache_fpl_smr_exit(fpl);
4488 if (__predict_false(dvs == VGET_NONE)) {
4489 return (cache_fpl_aborted(fpl));
4492 vget_finish_ref(dvp, dvs);
4493 if (!vn_seqc_consistent(dvp, dvp_seqc)) {
4495 return (cache_fpl_aborted(fpl));
4498 error = vn_lock(dvp, LK_EXCLUSIVE);
4499 if (__predict_false(error != 0)) {
4501 return (cache_fpl_aborted(fpl));
4505 cnp->cn_flags |= ISLASTCN;
4507 cnp->cn_flags |= MAKEENTRY;
4508 if (cache_fpl_isdotdot(cnp))
4509 cnp->cn_flags |= ISDOTDOT;
4510 cnp->cn_lkflags = LK_EXCLUSIVE;
4511 error = VOP_LOOKUP(dvp, &tvp, cnp);
4519 return (cache_fpl_handled_error(fpl, error));
4522 return (cache_fpl_aborted(fpl));
4526 fpl->savename = (cnp->cn_flags & SAVENAME) != 0;
4529 if ((cnp->cn_flags & SAVESTART) != 0) {
4530 ndp->ni_startdir = dvp;
4531 vrefact(ndp->ni_startdir);
4532 cnp->cn_flags |= SAVENAME;
4533 fpl->savename = true;
4535 MPASS(error == EJUSTRETURN);
4536 if ((cnp->cn_flags & LOCKPARENT) == 0) {
4539 return (cache_fpl_handled(fpl));
4543 * There are very hairy corner cases concerning various flag combinations
4544 * and locking state. In particular here we only hold one lock instead of
4547 * Skip the complexity as it is of no significance for normal workloads.
4549 if (__predict_false(tvp == dvp)) {
4552 return (cache_fpl_aborted(fpl));
4556 * If they want the symlink itself we are fine, but if they want to
4557 * follow it regular lookup has to be engaged.
4559 if (tvp->v_type == VLNK) {
4560 if ((cnp->cn_flags & FOLLOW) != 0) {
4563 return (cache_fpl_aborted(fpl));
4568 * Since we expect this to be the terminal vnode it should almost never
4571 if (__predict_false(cache_fplookup_is_mp(fpl))) {
4574 return (cache_fpl_aborted(fpl));
4577 if ((cnp->cn_flags & FAILIFEXISTS) != 0) {
4580 return (cache_fpl_handled_error(fpl, EEXIST));
4583 if ((cnp->cn_flags & LOCKLEAF) == 0) {
4587 if ((cnp->cn_flags & LOCKPARENT) == 0) {
4591 if ((cnp->cn_flags & SAVESTART) != 0) {
4592 ndp->ni_startdir = dvp;
4593 vrefact(ndp->ni_startdir);
4594 cnp->cn_flags |= SAVENAME;
4595 fpl->savename = true;
4598 return (cache_fpl_handled(fpl));
4601 static int __noinline
4602 cache_fplookup_modifying(struct cache_fpl *fpl)
4604 struct nameidata *ndp;
4608 if (!cache_fpl_islastcn(ndp)) {
4609 return (cache_fpl_partial(fpl));
4611 return (cache_fplookup_final_modifying(fpl));
4614 static int __noinline
4615 cache_fplookup_final_withparent(struct cache_fpl *fpl)
4617 struct componentname *cnp;
4618 enum vgetstate dvs, tvs;
4619 struct vnode *dvp, *tvp;
4625 dvp_seqc = fpl->dvp_seqc;
4628 MPASS((cnp->cn_flags & (LOCKPARENT|WANTPARENT)) != 0);
4631 * This is less efficient than it can be for simplicity.
4633 dvs = vget_prep_smr(dvp);
4634 if (__predict_false(dvs == VGET_NONE)) {
4635 return (cache_fpl_aborted(fpl));
4637 tvs = vget_prep_smr(tvp);
4638 if (__predict_false(tvs == VGET_NONE)) {
4639 cache_fpl_smr_exit(fpl);
4640 vget_abort(dvp, dvs);
4641 return (cache_fpl_aborted(fpl));
4644 cache_fpl_smr_exit(fpl);
4646 if ((cnp->cn_flags & LOCKPARENT) != 0) {
4647 error = vget_finish(dvp, LK_EXCLUSIVE, dvs);
4648 if (__predict_false(error != 0)) {
4649 vget_abort(tvp, tvs);
4650 return (cache_fpl_aborted(fpl));
4653 vget_finish_ref(dvp, dvs);
4656 if (!vn_seqc_consistent(dvp, dvp_seqc)) {
4657 vget_abort(tvp, tvs);
4658 if ((cnp->cn_flags & LOCKPARENT) != 0)
4662 return (cache_fpl_aborted(fpl));
4665 error = cache_fplookup_final_child(fpl, tvs);
4666 if (__predict_false(error != 0)) {
4667 MPASS(fpl->status == CACHE_FPL_STATUS_ABORTED ||
4668 fpl->status == CACHE_FPL_STATUS_DESTROYED);
4669 if ((cnp->cn_flags & LOCKPARENT) != 0)
4676 MPASS(fpl->status == CACHE_FPL_STATUS_HANDLED);
4681 cache_fplookup_final(struct cache_fpl *fpl)
4683 struct componentname *cnp;
4685 struct vnode *dvp, *tvp;
4690 dvp_seqc = fpl->dvp_seqc;
4693 MPASS(*(cnp->cn_nameptr) != '/');
4695 if (cnp->cn_nameiop != LOOKUP) {
4696 return (cache_fplookup_final_modifying(fpl));
4699 if ((cnp->cn_flags & (LOCKPARENT|WANTPARENT)) != 0)
4700 return (cache_fplookup_final_withparent(fpl));
4702 tvs = vget_prep_smr(tvp);
4703 if (__predict_false(tvs == VGET_NONE)) {
4704 return (cache_fpl_partial(fpl));
4707 if (!vn_seqc_consistent(dvp, dvp_seqc)) {
4708 cache_fpl_smr_exit(fpl);
4709 vget_abort(tvp, tvs);
4710 return (cache_fpl_aborted(fpl));
4713 cache_fpl_smr_exit(fpl);
4714 return (cache_fplookup_final_child(fpl, tvs));
4718 * Comment from locked lookup:
4719 * Check for degenerate name (e.g. / or "") which is a way of talking about a
4720 * directory, e.g. like "/." or ".".
4722 static int __noinline
4723 cache_fplookup_degenerate(struct cache_fpl *fpl)
4725 struct componentname *cnp;
4733 fpl->tvp = fpl->dvp;
4734 fpl->tvp_seqc = fpl->dvp_seqc;
4740 for (cp = cnp->cn_pnbuf; *cp != '\0'; cp++) {
4742 ("%s: encountered non-slash; string [%s]\n", __func__,
4747 if (__predict_false(cnp->cn_nameiop != LOOKUP)) {
4748 cache_fpl_smr_exit(fpl);
4749 return (cache_fpl_handled_error(fpl, EISDIR));
4752 MPASS((cnp->cn_flags & SAVESTART) == 0);
4754 if ((cnp->cn_flags & (LOCKPARENT|WANTPARENT)) != 0) {
4755 return (cache_fplookup_final_withparent(fpl));
4758 dvs = vget_prep_smr(dvp);
4759 cache_fpl_smr_exit(fpl);
4760 if (__predict_false(dvs == VGET_NONE)) {
4761 return (cache_fpl_aborted(fpl));
4764 if ((cnp->cn_flags & LOCKLEAF) != 0) {
4765 lkflags = LK_SHARED;
4766 if ((cnp->cn_flags & LOCKSHARED) == 0)
4767 lkflags = LK_EXCLUSIVE;
4768 error = vget_finish(dvp, lkflags, dvs);
4769 if (__predict_false(error != 0)) {
4770 return (cache_fpl_aborted(fpl));
4773 vget_finish_ref(dvp, dvs);
4775 return (cache_fpl_handled(fpl));
4778 static int __noinline
4779 cache_fplookup_emptypath(struct cache_fpl *fpl)
4781 struct nameidata *ndp;
4782 struct componentname *cnp;
4787 fpl->tvp = fpl->dvp;
4788 fpl->tvp_seqc = fpl->dvp_seqc;
4794 MPASS(*cnp->cn_pnbuf == '\0');
4796 if (__predict_false((cnp->cn_flags & EMPTYPATH) == 0)) {
4797 cache_fpl_smr_exit(fpl);
4798 return (cache_fpl_handled_error(fpl, ENOENT));
4801 MPASS((cnp->cn_flags & (LOCKPARENT | WANTPARENT)) == 0);
4803 tvs = vget_prep_smr(tvp);
4804 cache_fpl_smr_exit(fpl);
4805 if (__predict_false(tvs == VGET_NONE)) {
4806 return (cache_fpl_aborted(fpl));
4809 if ((cnp->cn_flags & LOCKLEAF) != 0) {
4810 lkflags = LK_SHARED;
4811 if ((cnp->cn_flags & LOCKSHARED) == 0)
4812 lkflags = LK_EXCLUSIVE;
4813 error = vget_finish(tvp, lkflags, tvs);
4814 if (__predict_false(error != 0)) {
4815 return (cache_fpl_aborted(fpl));
4818 vget_finish_ref(tvp, tvs);
4821 ndp->ni_resflags |= NIRES_EMPTYPATH;
4822 return (cache_fpl_handled(fpl));
4825 static int __noinline
4826 cache_fplookup_noentry(struct cache_fpl *fpl)
4828 struct nameidata *ndp;
4829 struct componentname *cnp;
4831 struct vnode *dvp, *tvp;
4839 dvp_seqc = fpl->dvp_seqc;
4841 MPASS((cnp->cn_flags & MAKEENTRY) == 0);
4842 MPASS((cnp->cn_flags & ISDOTDOT) == 0);
4843 MPASS(!cache_fpl_isdotdot(cnp));
4846 * Hack: delayed name len checking.
4848 if (__predict_false(cnp->cn_namelen > NAME_MAX)) {
4849 cache_fpl_smr_exit(fpl);
4850 return (cache_fpl_handled_error(fpl, ENAMETOOLONG));
4853 if (cnp->cn_nameptr[0] == '/') {
4854 return (cache_fplookup_skip_slashes(fpl));
4857 if (cnp->cn_pnbuf[0] == '\0') {
4858 return (cache_fplookup_emptypath(fpl));
4861 if (cnp->cn_nameptr[0] == '\0') {
4862 if (fpl->tvp == NULL) {
4863 return (cache_fplookup_degenerate(fpl));
4865 return (cache_fplookup_trailingslash(fpl));
4868 if (cnp->cn_nameiop != LOOKUP) {
4870 return (cache_fplookup_modifying(fpl));
4873 MPASS((cnp->cn_flags & SAVESTART) == 0);
4876 * Only try to fill in the component if it is the last one,
4877 * otherwise not only there may be several to handle but the
4878 * walk may be complicated.
4880 if (!cache_fpl_islastcn(ndp)) {
4881 return (cache_fpl_partial(fpl));
4885 * Regular lookup nulifies the slash, which we don't do here.
4886 * Don't take chances with filesystem routines seeing it for
4889 if (cache_fpl_istrailingslash(fpl)) {
4890 return (cache_fpl_partial(fpl));
4894 * Secure access to dvp; check cache_fplookup_partial_setup for
4897 dvs = vget_prep_smr(dvp);
4898 cache_fpl_smr_exit(fpl);
4899 if (__predict_false(dvs == VGET_NONE)) {
4900 return (cache_fpl_aborted(fpl));
4903 vget_finish_ref(dvp, dvs);
4904 if (!vn_seqc_consistent(dvp, dvp_seqc)) {
4906 return (cache_fpl_aborted(fpl));
4909 error = vn_lock(dvp, LK_SHARED);
4910 if (__predict_false(error != 0)) {
4912 return (cache_fpl_aborted(fpl));
4917 * TODO: provide variants which don't require locking either vnode.
4919 cnp->cn_flags |= ISLASTCN;
4920 docache = (cnp->cn_flags & NOCACHE) ^ NOCACHE;
4922 cnp->cn_flags |= MAKEENTRY;
4923 cnp->cn_lkflags = LK_SHARED;
4924 if ((cnp->cn_flags & LOCKSHARED) == 0) {
4925 cnp->cn_lkflags = LK_EXCLUSIVE;
4927 error = VOP_LOOKUP(dvp, &tvp, cnp);
4935 return (cache_fpl_handled_error(fpl, error));
4938 return (cache_fpl_aborted(fpl));
4942 if (!fpl->savename) {
4943 MPASS((cnp->cn_flags & SAVENAME) == 0);
4947 MPASS(error == EJUSTRETURN);
4948 if ((cnp->cn_flags & (WANTPARENT | LOCKPARENT)) == 0) {
4950 } else if ((cnp->cn_flags & LOCKPARENT) == 0) {
4953 return (cache_fpl_handled(fpl));
4956 if (tvp->v_type == VLNK) {
4957 if ((cnp->cn_flags & FOLLOW) != 0) {
4960 return (cache_fpl_aborted(fpl));
4964 if (__predict_false(cache_fplookup_is_mp(fpl))) {
4967 return (cache_fpl_aborted(fpl));
4970 if ((cnp->cn_flags & LOCKLEAF) == 0) {
4974 if ((cnp->cn_flags & (WANTPARENT | LOCKPARENT)) == 0) {
4976 } else if ((cnp->cn_flags & LOCKPARENT) == 0) {
4979 return (cache_fpl_handled(fpl));
4982 static int __noinline
4983 cache_fplookup_dot(struct cache_fpl *fpl)
4987 MPASS(!seqc_in_modify(fpl->dvp_seqc));
4989 * Just re-assign the value. seqc will be checked later for the first
4990 * non-dot path component in line and/or before deciding to return the
4993 fpl->tvp = fpl->dvp;
4994 fpl->tvp_seqc = fpl->dvp_seqc;
4996 counter_u64_add(dothits, 1);
4997 SDT_PROBE3(vfs, namecache, lookup, hit, fpl->dvp, ".", fpl->dvp);
5000 if (cache_fplookup_is_mp(fpl)) {
5001 error = cache_fplookup_cross_mount(fpl);
5006 static int __noinline
5007 cache_fplookup_dotdot(struct cache_fpl *fpl)
5009 struct nameidata *ndp;
5010 struct componentname *cnp;
5011 struct namecache *ncp;
5020 MPASS(cache_fpl_isdotdot(cnp));
5023 * XXX this is racy the same way regular lookup is
5025 for (pr = cnp->cn_cred->cr_prison; pr != NULL;
5027 if (dvp == pr->pr_root)
5030 if (dvp == ndp->ni_rootdir ||
5031 dvp == ndp->ni_topdir ||
5035 fpl->tvp_seqc = vn_seqc_read_any(dvp);
5036 if (seqc_in_modify(fpl->tvp_seqc)) {
5037 return (cache_fpl_aborted(fpl));
5042 if ((dvp->v_vflag & VV_ROOT) != 0) {
5045 * The opposite of climb mount is needed here.
5047 return (cache_fpl_partial(fpl));
5050 ncp = atomic_load_consume_ptr(&dvp->v_cache_dd);
5052 return (cache_fpl_aborted(fpl));
5055 nc_flag = atomic_load_char(&ncp->nc_flag);
5056 if ((nc_flag & NCF_ISDOTDOT) != 0) {
5057 if ((nc_flag & NCF_NEGATIVE) != 0)
5058 return (cache_fpl_aborted(fpl));
5059 fpl->tvp = ncp->nc_vp;
5061 fpl->tvp = ncp->nc_dvp;
5064 fpl->tvp_seqc = vn_seqc_read_any(fpl->tvp);
5065 if (seqc_in_modify(fpl->tvp_seqc)) {
5066 return (cache_fpl_partial(fpl));
5070 * Acquire fence provided by vn_seqc_read_any above.
5072 if (__predict_false(atomic_load_ptr(&dvp->v_cache_dd) != ncp)) {
5073 return (cache_fpl_aborted(fpl));
5076 if (!cache_ncp_canuse(ncp)) {
5077 return (cache_fpl_aborted(fpl));
5080 counter_u64_add(dotdothits, 1);
5084 static int __noinline
5085 cache_fplookup_neg(struct cache_fpl *fpl, struct namecache *ncp, uint32_t hash)
5087 u_char nc_flag __diagused;
5091 nc_flag = atomic_load_char(&ncp->nc_flag);
5092 MPASS((nc_flag & NCF_NEGATIVE) != 0);
5095 * If they want to create an entry we need to replace this one.
5097 if (__predict_false(fpl->cnp->cn_nameiop != LOOKUP)) {
5099 return (cache_fplookup_modifying(fpl));
5101 neg_promote = cache_neg_hit_prep(ncp);
5102 if (!cache_fpl_neg_ncp_canuse(ncp)) {
5103 cache_neg_hit_abort(ncp);
5104 return (cache_fpl_partial(fpl));
5107 return (cache_fplookup_negative_promote(fpl, ncp, hash));
5109 cache_neg_hit_finish(ncp);
5110 cache_fpl_smr_exit(fpl);
5111 return (cache_fpl_handled_error(fpl, ENOENT));
5115 * Resolve a symlink. Called by filesystem-specific routines.
5118 * ... -> cache_fplookup_symlink -> VOP_FPLOOKUP_SYMLINK -> cache_symlink_resolve
5121 cache_symlink_resolve(struct cache_fpl *fpl, const char *string, size_t len)
5123 struct nameidata *ndp;
5124 struct componentname *cnp;
5130 if (__predict_false(len == 0)) {
5134 if (__predict_false(len > MAXPATHLEN - 2)) {
5135 if (cache_fpl_istrailingslash(fpl)) {
5140 ndp->ni_pathlen = fpl->nulchar - cnp->cn_nameptr - cnp->cn_namelen + 1;
5142 if (ndp->ni_pathlen != fpl->debug.ni_pathlen) {
5143 panic("%s: mismatch (%zu != %zu) nulchar %p nameptr %p [%s] ; full string [%s]\n",
5144 __func__, ndp->ni_pathlen, fpl->debug.ni_pathlen, fpl->nulchar,
5145 cnp->cn_nameptr, cnp->cn_nameptr, cnp->cn_pnbuf);
5149 if (__predict_false(len + ndp->ni_pathlen > MAXPATHLEN)) {
5150 return (ENAMETOOLONG);
5153 if (__predict_false(ndp->ni_loopcnt++ >= MAXSYMLINKS)) {
5158 if (ndp->ni_pathlen > 1) {
5159 bcopy(ndp->ni_next, cnp->cn_pnbuf + len, ndp->ni_pathlen);
5161 if (cache_fpl_istrailingslash(fpl)) {
5163 cnp->cn_pnbuf[len] = '/';
5164 cnp->cn_pnbuf[len + 1] = '\0';
5166 cnp->cn_pnbuf[len] = '\0';
5169 bcopy(string, cnp->cn_pnbuf, len);
5171 ndp->ni_pathlen += adjust;
5172 cache_fpl_pathlen_add(fpl, adjust);
5173 cnp->cn_nameptr = cnp->cn_pnbuf;
5174 fpl->nulchar = &cnp->cn_nameptr[ndp->ni_pathlen - 1];
5179 static int __noinline
5180 cache_fplookup_symlink(struct cache_fpl *fpl)
5183 struct nameidata *ndp;
5184 struct componentname *cnp;
5185 struct vnode *dvp, *tvp;
5193 if (cache_fpl_islastcn(ndp)) {
5194 if ((cnp->cn_flags & FOLLOW) == 0) {
5195 return (cache_fplookup_final(fpl));
5199 mp = atomic_load_ptr(&dvp->v_mount);
5200 if (__predict_false(mp == NULL)) {
5201 return (cache_fpl_aborted(fpl));
5205 * Note this check races against setting the flag just like regular
5208 if (__predict_false((mp->mnt_flag & MNT_NOSYMFOLLOW) != 0)) {
5209 cache_fpl_smr_exit(fpl);
5210 return (cache_fpl_handled_error(fpl, EACCES));
5213 error = VOP_FPLOOKUP_SYMLINK(tvp, fpl);
5214 if (__predict_false(error != 0)) {
5217 return (cache_fpl_partial(fpl));
5221 cache_fpl_smr_exit(fpl);
5222 return (cache_fpl_handled_error(fpl, error));
5224 return (cache_fpl_aborted(fpl));
5228 if (*(cnp->cn_nameptr) == '/') {
5229 fpl->dvp = cache_fpl_handle_root(fpl);
5230 fpl->dvp_seqc = vn_seqc_read_any(fpl->dvp);
5231 if (seqc_in_modify(fpl->dvp_seqc)) {
5232 return (cache_fpl_aborted(fpl));
5235 * The main loop assumes that ->dvp points to a vnode belonging
5236 * to a filesystem which can do lockless lookup, but the absolute
5237 * symlink can be wandering off to one which does not.
5239 mp = atomic_load_ptr(&fpl->dvp->v_mount);
5240 if (__predict_false(mp == NULL)) {
5241 return (cache_fpl_aborted(fpl));
5243 if (!cache_fplookup_mp_supported(mp)) {
5244 cache_fpl_checkpoint(fpl);
5245 return (cache_fpl_partial(fpl));
5252 cache_fplookup_next(struct cache_fpl *fpl)
5254 struct componentname *cnp;
5255 struct namecache *ncp;
5256 struct vnode *dvp, *tvp;
5265 if (__predict_false(cnp->cn_nameptr[0] == '.')) {
5266 if (cnp->cn_namelen == 1) {
5267 return (cache_fplookup_dot(fpl));
5269 if (cnp->cn_namelen == 2 && cnp->cn_nameptr[1] == '.') {
5270 return (cache_fplookup_dotdot(fpl));
5274 MPASS(!cache_fpl_isdotdot(cnp));
5276 CK_SLIST_FOREACH(ncp, (NCHHASH(hash)), nc_hash) {
5277 if (ncp->nc_dvp == dvp && ncp->nc_nlen == cnp->cn_namelen &&
5278 !bcmp(ncp->nc_name, cnp->cn_nameptr, ncp->nc_nlen))
5282 if (__predict_false(ncp == NULL)) {
5283 return (cache_fplookup_noentry(fpl));
5286 tvp = atomic_load_ptr(&ncp->nc_vp);
5287 nc_flag = atomic_load_char(&ncp->nc_flag);
5288 if ((nc_flag & NCF_NEGATIVE) != 0) {
5289 return (cache_fplookup_neg(fpl, ncp, hash));
5292 if (!cache_ncp_canuse(ncp)) {
5293 return (cache_fpl_partial(fpl));
5297 fpl->tvp_seqc = vn_seqc_read_any(tvp);
5298 if (seqc_in_modify(fpl->tvp_seqc)) {
5299 return (cache_fpl_partial(fpl));
5302 counter_u64_add(numposhits, 1);
5303 SDT_PROBE3(vfs, namecache, lookup, hit, dvp, ncp->nc_name, tvp);
5306 if (cache_fplookup_is_mp(fpl)) {
5307 error = cache_fplookup_cross_mount(fpl);
5313 cache_fplookup_mp_supported(struct mount *mp)
5317 if ((mp->mnt_kern_flag & MNTK_FPLOOKUP) == 0)
5323 * Walk up the mount stack (if any).
5325 * Correctness is provided in the following ways:
5326 * - all vnodes are protected from freeing with SMR
5327 * - struct mount objects are type stable making them always safe to access
5328 * - stability of the particular mount is provided by busying it
5329 * - relationship between the vnode which is mounted on and the mount is
5330 * verified with the vnode sequence counter after busying
5331 * - association between root vnode of the mount and the mount is protected
5334 * From that point on we can read the sequence counter of the root vnode
5335 * and get the next mount on the stack (if any) using the same protection.
5337 * By the end of successful walk we are guaranteed the reached state was
5338 * indeed present at least at some point which matches the regular lookup.
5340 static int __noinline
5341 cache_fplookup_climb_mount(struct cache_fpl *fpl)
5343 struct mount *mp, *prev_mp;
5344 struct mount_pcpu *mpcpu, *prev_mpcpu;
5349 vp_seqc = fpl->tvp_seqc;
5351 VNPASS(vp->v_type == VDIR || vp->v_type == VBAD, vp);
5352 mp = atomic_load_ptr(&vp->v_mountedhere);
5353 if (__predict_false(mp == NULL)) {
5359 if (!vfs_op_thread_enter_crit(mp, mpcpu)) {
5360 if (prev_mp != NULL)
5361 vfs_op_thread_exit_crit(prev_mp, prev_mpcpu);
5362 return (cache_fpl_partial(fpl));
5364 if (prev_mp != NULL)
5365 vfs_op_thread_exit_crit(prev_mp, prev_mpcpu);
5366 if (!vn_seqc_consistent(vp, vp_seqc)) {
5367 vfs_op_thread_exit_crit(mp, mpcpu);
5368 return (cache_fpl_partial(fpl));
5370 if (!cache_fplookup_mp_supported(mp)) {
5371 vfs_op_thread_exit_crit(mp, mpcpu);
5372 return (cache_fpl_partial(fpl));
5374 vp = atomic_load_ptr(&mp->mnt_rootvnode);
5376 vfs_op_thread_exit_crit(mp, mpcpu);
5377 return (cache_fpl_partial(fpl));
5379 vp_seqc = vn_seqc_read_any(vp);
5380 if (seqc_in_modify(vp_seqc)) {
5381 vfs_op_thread_exit_crit(mp, mpcpu);
5382 return (cache_fpl_partial(fpl));
5386 mp = atomic_load_ptr(&vp->v_mountedhere);
5391 vfs_op_thread_exit_crit(prev_mp, prev_mpcpu);
5393 fpl->tvp_seqc = vp_seqc;
5397 static int __noinline
5398 cache_fplookup_cross_mount(struct cache_fpl *fpl)
5401 struct mount_pcpu *mpcpu;
5406 vp_seqc = fpl->tvp_seqc;
5408 VNPASS(vp->v_type == VDIR || vp->v_type == VBAD, vp);
5409 mp = atomic_load_ptr(&vp->v_mountedhere);
5410 if (__predict_false(mp == NULL)) {
5414 if (!vfs_op_thread_enter_crit(mp, mpcpu)) {
5415 return (cache_fpl_partial(fpl));
5417 if (!vn_seqc_consistent(vp, vp_seqc)) {
5418 vfs_op_thread_exit_crit(mp, mpcpu);
5419 return (cache_fpl_partial(fpl));
5421 if (!cache_fplookup_mp_supported(mp)) {
5422 vfs_op_thread_exit_crit(mp, mpcpu);
5423 return (cache_fpl_partial(fpl));
5425 vp = atomic_load_ptr(&mp->mnt_rootvnode);
5426 if (__predict_false(vp == NULL)) {
5427 vfs_op_thread_exit_crit(mp, mpcpu);
5428 return (cache_fpl_partial(fpl));
5430 vp_seqc = vn_seqc_read_any(vp);
5431 vfs_op_thread_exit_crit(mp, mpcpu);
5432 if (seqc_in_modify(vp_seqc)) {
5433 return (cache_fpl_partial(fpl));
5435 mp = atomic_load_ptr(&vp->v_mountedhere);
5436 if (__predict_false(mp != NULL)) {
5438 * There are possibly more mount points on top.
5439 * Normally this does not happen so for simplicity just start
5442 return (cache_fplookup_climb_mount(fpl));
5446 fpl->tvp_seqc = vp_seqc;
5451 * Check if a vnode is mounted on.
5454 cache_fplookup_is_mp(struct cache_fpl *fpl)
5459 return ((vn_irflag_read(vp) & VIRF_MOUNTPOINT) != 0);
5465 * The code was originally copy-pasted from regular lookup and despite
5466 * clean ups leaves performance on the table. Any modifications here
5467 * must take into account that in case off fallback the resulting
5468 * nameidata state has to be compatible with the original.
5472 * Debug ni_pathlen tracking.
5476 cache_fpl_pathlen_add(struct cache_fpl *fpl, size_t n)
5479 fpl->debug.ni_pathlen += n;
5480 KASSERT(fpl->debug.ni_pathlen <= PATH_MAX,
5481 ("%s: pathlen overflow to %zd\n", __func__, fpl->debug.ni_pathlen));
5485 cache_fpl_pathlen_sub(struct cache_fpl *fpl, size_t n)
5488 fpl->debug.ni_pathlen -= n;
5489 KASSERT(fpl->debug.ni_pathlen <= PATH_MAX,
5490 ("%s: pathlen underflow to %zd\n", __func__, fpl->debug.ni_pathlen));
5494 cache_fpl_pathlen_inc(struct cache_fpl *fpl)
5497 cache_fpl_pathlen_add(fpl, 1);
5501 cache_fpl_pathlen_dec(struct cache_fpl *fpl)
5504 cache_fpl_pathlen_sub(fpl, 1);
5508 cache_fpl_pathlen_add(struct cache_fpl *fpl, size_t n)
5513 cache_fpl_pathlen_sub(struct cache_fpl *fpl, size_t n)
5518 cache_fpl_pathlen_inc(struct cache_fpl *fpl)
5523 cache_fpl_pathlen_dec(struct cache_fpl *fpl)
5529 cache_fplookup_parse(struct cache_fpl *fpl)
5531 struct nameidata *ndp;
5532 struct componentname *cnp;
5542 * Find the end of this path component, it is either / or nul.
5544 * Store / as a temporary sentinel so that we only have one character
5545 * to test for. Pathnames tend to be short so this should not be
5546 * resulting in cache misses.
5548 * TODO: fix this to be word-sized.
5550 MPASS(&cnp->cn_nameptr[fpl->debug.ni_pathlen - 1] >= cnp->cn_pnbuf);
5551 KASSERT(&cnp->cn_nameptr[fpl->debug.ni_pathlen - 1] == fpl->nulchar,
5552 ("%s: mismatch between pathlen (%zu) and nulchar (%p != %p), string [%s]\n",
5553 __func__, fpl->debug.ni_pathlen, &cnp->cn_nameptr[fpl->debug.ni_pathlen - 1],
5554 fpl->nulchar, cnp->cn_pnbuf));
5555 KASSERT(*fpl->nulchar == '\0',
5556 ("%s: expected nul at %p; string [%s]\n", __func__, fpl->nulchar,
5558 hash = cache_get_hash_iter_start(dvp);
5559 *fpl->nulchar = '/';
5560 for (cp = cnp->cn_nameptr; *cp != '/'; cp++) {
5561 KASSERT(*cp != '\0',
5562 ("%s: encountered unexpected nul; string [%s]\n", __func__,
5564 hash = cache_get_hash_iter(*cp, hash);
5567 *fpl->nulchar = '\0';
5568 fpl->hash = cache_get_hash_iter_finish(hash);
5570 cnp->cn_namelen = cp - cnp->cn_nameptr;
5571 cache_fpl_pathlen_sub(fpl, cnp->cn_namelen);
5575 * cache_get_hash only accepts lengths up to NAME_MAX. This is fine since
5576 * we are going to fail this lookup with ENAMETOOLONG (see below).
5578 if (cnp->cn_namelen <= NAME_MAX) {
5579 if (fpl->hash != cache_get_hash(cnp->cn_nameptr, cnp->cn_namelen, dvp)) {
5580 panic("%s: mismatched hash for [%s] len %ld", __func__,
5581 cnp->cn_nameptr, cnp->cn_namelen);
5587 * Hack: we have to check if the found path component's length exceeds
5588 * NAME_MAX. However, the condition is very rarely true and check can
5589 * be elided in the common case -- if an entry was found in the cache,
5590 * then it could not have been too long to begin with.
5596 cache_fplookup_parse_advance(struct cache_fpl *fpl)
5598 struct nameidata *ndp;
5599 struct componentname *cnp;
5604 cnp->cn_nameptr = ndp->ni_next;
5605 KASSERT(*(cnp->cn_nameptr) == '/',
5606 ("%s: should have seen slash at %p ; buf %p [%s]\n", __func__,
5607 cnp->cn_nameptr, cnp->cn_pnbuf, cnp->cn_pnbuf));
5609 cache_fpl_pathlen_dec(fpl);
5613 * Skip spurious slashes in a pathname (e.g., "foo///bar") and retry.
5615 * Lockless lookup tries to elide checking for spurious slashes and should they
5616 * be present is guaranteed to fail to find an entry. In this case the caller
5617 * must check if the name starts with a slash and call this routine. It is
5618 * going to fast forward across the spurious slashes and set the state up for
5621 static int __noinline
5622 cache_fplookup_skip_slashes(struct cache_fpl *fpl)
5624 struct nameidata *ndp;
5625 struct componentname *cnp;
5630 MPASS(*(cnp->cn_nameptr) == '/');
5633 cache_fpl_pathlen_dec(fpl);
5634 } while (*(cnp->cn_nameptr) == '/');
5637 * Go back to one slash so that cache_fplookup_parse_advance has
5638 * something to skip.
5641 cache_fpl_pathlen_inc(fpl);
5644 * cache_fplookup_parse_advance starts from ndp->ni_next
5646 ndp->ni_next = cnp->cn_nameptr;
5649 * See cache_fplookup_dot.
5651 fpl->tvp = fpl->dvp;
5652 fpl->tvp_seqc = fpl->dvp_seqc;
5658 * Handle trailing slashes (e.g., "foo/").
5660 * If a trailing slash is found the terminal vnode must be a directory.
5661 * Regular lookup shortens the path by nulifying the first trailing slash and
5662 * sets the TRAILINGSLASH flag to denote this took place. There are several
5663 * checks on it performed later.
5665 * Similarly to spurious slashes, lockless lookup handles this in a speculative
5666 * manner relying on an invariant that a non-directory vnode will get a miss.
5667 * In this case cn_nameptr[0] == '\0' and cn_namelen == 0.
5669 * Thus for a path like "foo/bar/" the code unwinds the state back to "bar/"
5670 * and denotes this is the last path component, which avoids looping back.
5672 * Only plain lookups are supported for now to restrict corner cases to handle.
5674 static int __noinline
5675 cache_fplookup_trailingslash(struct cache_fpl *fpl)
5680 struct nameidata *ndp;
5681 struct componentname *cnp;
5682 struct namecache *ncp;
5684 char *cn_nameptr_orig, *cn_nameptr_slash;
5691 tvp_seqc = fpl->tvp_seqc;
5693 MPASS(fpl->dvp == fpl->tvp);
5694 KASSERT(cache_fpl_istrailingslash(fpl),
5695 ("%s: expected trailing slash at %p; string [%s]\n", __func__, fpl->nulchar - 1,
5697 KASSERT(cnp->cn_nameptr[0] == '\0',
5698 ("%s: expected nul char at %p; string [%s]\n", __func__, &cnp->cn_nameptr[0],
5700 KASSERT(cnp->cn_namelen == 0,
5701 ("%s: namelen 0 but got %ld; string [%s]\n", __func__, cnp->cn_namelen,
5703 MPASS(cnp->cn_nameptr > cnp->cn_pnbuf);
5705 if (cnp->cn_nameiop != LOOKUP) {
5706 return (cache_fpl_aborted(fpl));
5709 if (__predict_false(tvp->v_type != VDIR)) {
5710 if (!vn_seqc_consistent(tvp, tvp_seqc)) {
5711 return (cache_fpl_aborted(fpl));
5713 cache_fpl_smr_exit(fpl);
5714 return (cache_fpl_handled_error(fpl, ENOTDIR));
5718 * Denote the last component.
5720 ndp->ni_next = &cnp->cn_nameptr[0];
5721 MPASS(cache_fpl_islastcn(ndp));
5724 * Unwind trailing slashes.
5726 cn_nameptr_orig = cnp->cn_nameptr;
5727 while (cnp->cn_nameptr >= cnp->cn_pnbuf) {
5729 if (cnp->cn_nameptr[0] != '/') {
5735 * Unwind to the beginning of the path component.
5737 * Note the path may or may not have started with a slash.
5739 cn_nameptr_slash = cnp->cn_nameptr;
5740 while (cnp->cn_nameptr > cnp->cn_pnbuf) {
5742 if (cnp->cn_nameptr[0] == '/') {
5746 if (cnp->cn_nameptr[0] == '/') {
5750 cnp->cn_namelen = cn_nameptr_slash - cnp->cn_nameptr + 1;
5751 cache_fpl_pathlen_add(fpl, cn_nameptr_orig - cnp->cn_nameptr);
5752 cache_fpl_checkpoint(fpl);
5755 ni_pathlen = fpl->nulchar - cnp->cn_nameptr + 1;
5756 if (ni_pathlen != fpl->debug.ni_pathlen) {
5757 panic("%s: mismatch (%zu != %zu) nulchar %p nameptr %p [%s] ; full string [%s]\n",
5758 __func__, ni_pathlen, fpl->debug.ni_pathlen, fpl->nulchar,
5759 cnp->cn_nameptr, cnp->cn_nameptr, cnp->cn_pnbuf);
5764 * If this was a "./" lookup the parent directory is already correct.
5766 if (cnp->cn_nameptr[0] == '.' && cnp->cn_namelen == 1) {
5771 * Otherwise we need to look it up.
5774 ncp = atomic_load_consume_ptr(&tvp->v_cache_dd);
5775 if (__predict_false(ncp == NULL)) {
5776 return (cache_fpl_aborted(fpl));
5778 nc_flag = atomic_load_char(&ncp->nc_flag);
5779 if ((nc_flag & NCF_ISDOTDOT) != 0) {
5780 return (cache_fpl_aborted(fpl));
5782 fpl->dvp = ncp->nc_dvp;
5783 fpl->dvp_seqc = vn_seqc_read_any(fpl->dvp);
5784 if (seqc_in_modify(fpl->dvp_seqc)) {
5785 return (cache_fpl_aborted(fpl));
5791 * See the API contract for VOP_FPLOOKUP_VEXEC.
5793 static int __noinline
5794 cache_fplookup_failed_vexec(struct cache_fpl *fpl, int error)
5796 struct componentname *cnp;
5802 dvp_seqc = fpl->dvp_seqc;
5805 * Hack: delayed empty path checking.
5807 if (cnp->cn_pnbuf[0] == '\0') {
5808 return (cache_fplookup_emptypath(fpl));
5812 * TODO: Due to ignoring trailing slashes lookup will perform a
5813 * permission check on the last dir when it should not be doing it. It
5814 * may fail, but said failure should be ignored. It is possible to fix
5815 * it up fully without resorting to regular lookup, but for now just
5818 if (cache_fpl_istrailingslash(fpl)) {
5819 return (cache_fpl_aborted(fpl));
5823 * Hack: delayed degenerate path checking.
5825 if (cnp->cn_nameptr[0] == '\0' && fpl->tvp == NULL) {
5826 return (cache_fplookup_degenerate(fpl));
5830 * Hack: delayed name len checking.
5832 if (__predict_false(cnp->cn_namelen > NAME_MAX)) {
5833 cache_fpl_smr_exit(fpl);
5834 return (cache_fpl_handled_error(fpl, ENAMETOOLONG));
5838 * Hack: they may be looking up foo/bar, where foo is not a directory.
5839 * In such a case we need to return ENOTDIR, but we may happen to get
5840 * here with a different error.
5842 if (dvp->v_type != VDIR) {
5847 * Hack: handle O_SEARCH.
5849 * Open Group Base Specifications Issue 7, 2018 edition states:
5851 * If the access mode of the open file description associated with the
5852 * file descriptor is not O_SEARCH, the function shall check whether
5853 * directory searches are permitted using the current permissions of
5854 * the directory underlying the file descriptor. If the access mode is
5855 * O_SEARCH, the function shall not perform the check.
5858 * Regular lookup tests for the NOEXECCHECK flag for every path
5859 * component to decide whether to do the permission check. However,
5860 * since most lookups never have the flag (and when they do it is only
5861 * present for the first path component), lockless lookup only acts on
5862 * it if there is a permission problem. Here the flag is represented
5863 * with a boolean so that we don't have to clear it on the way out.
5865 * For simplicity this always aborts.
5866 * TODO: check if this is the first lookup and ignore the permission
5867 * problem. Note the flag has to survive fallback (if it happens to be
5871 return (cache_fpl_aborted(fpl));
5876 if (!vn_seqc_consistent(dvp, dvp_seqc)) {
5877 error = cache_fpl_aborted(fpl);
5879 cache_fpl_partial(fpl);
5883 if (!vn_seqc_consistent(dvp, dvp_seqc)) {
5884 error = cache_fpl_aborted(fpl);
5886 cache_fpl_smr_exit(fpl);
5887 cache_fpl_handled_error(fpl, error);
5895 cache_fplookup_impl(struct vnode *dvp, struct cache_fpl *fpl)
5897 struct nameidata *ndp;
5898 struct componentname *cnp;
5905 cache_fpl_checkpoint(fpl);
5908 * The vnode at hand is almost always stable, skip checking for it.
5909 * Worst case this postpones the check towards the end of the iteration
5913 fpl->dvp_seqc = vn_seqc_read_notmodify(fpl->dvp);
5915 mp = atomic_load_ptr(&dvp->v_mount);
5916 if (__predict_false(mp == NULL || !cache_fplookup_mp_supported(mp))) {
5917 return (cache_fpl_aborted(fpl));
5920 MPASS(fpl->tvp == NULL);
5923 cache_fplookup_parse(fpl);
5925 error = VOP_FPLOOKUP_VEXEC(fpl->dvp, cnp->cn_cred);
5926 if (__predict_false(error != 0)) {
5927 error = cache_fplookup_failed_vexec(fpl, error);
5931 error = cache_fplookup_next(fpl);
5932 if (__predict_false(cache_fpl_terminated(fpl))) {
5936 VNPASS(!seqc_in_modify(fpl->tvp_seqc), fpl->tvp);
5938 if (fpl->tvp->v_type == VLNK) {
5939 error = cache_fplookup_symlink(fpl);
5940 if (cache_fpl_terminated(fpl)) {
5944 if (cache_fpl_islastcn(ndp)) {
5945 error = cache_fplookup_final(fpl);
5949 if (!vn_seqc_consistent(fpl->dvp, fpl->dvp_seqc)) {
5950 error = cache_fpl_aborted(fpl);
5954 fpl->dvp = fpl->tvp;
5955 fpl->dvp_seqc = fpl->tvp_seqc;
5956 cache_fplookup_parse_advance(fpl);
5959 cache_fpl_checkpoint(fpl);
5966 * Fast path lookup protected with SMR and sequence counters.
5968 * Note: all VOP_FPLOOKUP_VEXEC routines have a comment referencing this one.
5970 * Filesystems can opt in by setting the MNTK_FPLOOKUP flag and meeting criteria
5973 * Traditional vnode lookup conceptually looks like this:
5979 * vn_unlock(current);
5986 * Each jump to the next vnode is safe memory-wise and atomic with respect to
5987 * any modifications thanks to holding respective locks.
5989 * The same guarantee can be provided with a combination of safe memory
5990 * reclamation and sequence counters instead. If all operations which affect
5991 * the relationship between the current vnode and the one we are looking for
5992 * also modify the counter, we can verify whether all the conditions held as
5993 * we made the jump. This includes things like permissions, mount points etc.
5994 * Counter modification is provided by enclosing relevant places in
5995 * vn_seqc_write_begin()/end() calls.
5997 * Thus this translates to:
6000 * dvp_seqc = seqc_read_any(dvp);
6001 * if (seqc_in_modify(dvp_seqc)) // someone is altering the vnode
6005 * tvp_seqc = seqc_read_any(tvp);
6006 * if (seqc_in_modify(tvp_seqc)) // someone is altering the target vnode
6008 * if (!seqc_consistent(dvp, dvp_seqc) // someone is altering the vnode
6010 * dvp = tvp; // we know nothing of importance has changed
6011 * dvp_seqc = tvp_seqc; // store the counter for the tvp iteration
6015 * vget(); // secure the vnode
6016 * if (!seqc_consistent(tvp, tvp_seqc) // final check
6018 * // at this point we know nothing has changed for any parent<->child pair
6019 * // as they were crossed during the lookup, meaning we matched the guarantee
6020 * // of the locked variant
6023 * The API contract for VOP_FPLOOKUP_VEXEC routines is as follows:
6024 * - they are called while within vfs_smr protection which they must never exit
6025 * - EAGAIN can be returned to denote checking could not be performed, it is
6026 * always valid to return it
6027 * - if the sequence counter has not changed the result must be valid
6028 * - if the sequence counter has changed both false positives and false negatives
6029 * are permitted (since the result will be rejected later)
6030 * - for simple cases of unix permission checks vaccess_vexec_smr can be used
6032 * Caveats to watch out for:
6033 * - vnodes are passed unlocked and unreferenced with nothing stopping
6034 * VOP_RECLAIM, in turn meaning that ->v_data can become NULL. It is advised
6035 * to use atomic_load_ptr to fetch it.
6036 * - the aforementioned object can also get freed, meaning absent other means it
6037 * should be protected with vfs_smr
6038 * - either safely checking permissions as they are modified or guaranteeing
6039 * their stability is left to the routine
6042 cache_fplookup(struct nameidata *ndp, enum cache_fpl_status *status,
6045 struct cache_fpl fpl;
6048 struct componentname *cnp;
6051 fpl.status = CACHE_FPL_STATUS_UNSET;
6054 fpl.cnp = cnp = &ndp->ni_cnd;
6055 MPASS(ndp->ni_lcf == 0);
6056 KASSERT ((cnp->cn_flags & CACHE_FPL_INTERNAL_CN_FLAGS) == 0,
6057 ("%s: internal flags found in cn_flags %" PRIx64, __func__,
6059 if ((cnp->cn_flags & SAVESTART) != 0) {
6060 MPASS(cnp->cn_nameiop != LOOKUP);
6062 MPASS(cnp->cn_nameptr == cnp->cn_pnbuf);
6064 if (__predict_false(!cache_can_fplookup(&fpl))) {
6065 *status = fpl.status;
6066 SDT_PROBE3(vfs, fplookup, lookup, done, ndp, fpl.line, fpl.status);
6067 return (EOPNOTSUPP);
6070 cache_fpl_checkpoint_outer(&fpl);
6072 cache_fpl_smr_enter_initial(&fpl);
6074 fpl.debug.ni_pathlen = ndp->ni_pathlen;
6076 fpl.nulchar = &cnp->cn_nameptr[ndp->ni_pathlen - 1];
6077 fpl.fsearch = false;
6078 fpl.savename = (cnp->cn_flags & SAVENAME) != 0;
6079 fpl.tvp = NULL; /* for degenerate path handling */
6081 pwd = pwd_get_smr();
6083 ndp->ni_rootdir = pwd->pwd_rdir;
6084 ndp->ni_topdir = pwd->pwd_jdir;
6086 if (cnp->cn_pnbuf[0] == '/') {
6087 dvp = cache_fpl_handle_root(&fpl);
6088 MPASS(ndp->ni_resflags == 0);
6089 ndp->ni_resflags = NIRES_ABS;
6091 if (ndp->ni_dirfd == AT_FDCWD) {
6092 dvp = pwd->pwd_cdir;
6094 error = cache_fplookup_dirfd(&fpl, &dvp);
6095 if (__predict_false(error != 0)) {
6101 SDT_PROBE4(vfs, namei, lookup, entry, dvp, cnp->cn_pnbuf, cnp->cn_flags, true);
6102 error = cache_fplookup_impl(dvp, &fpl);
6104 cache_fpl_smr_assert_not_entered(&fpl);
6105 cache_fpl_assert_status(&fpl);
6106 *status = fpl.status;
6107 if (SDT_PROBES_ENABLED()) {
6108 SDT_PROBE3(vfs, fplookup, lookup, done, ndp, fpl.line, fpl.status);
6109 if (fpl.status == CACHE_FPL_STATUS_HANDLED)
6110 SDT_PROBE4(vfs, namei, lookup, return, error, ndp->ni_vp, true,
6114 if (__predict_true(fpl.status == CACHE_FPL_STATUS_HANDLED)) {
6115 MPASS(error != CACHE_FPL_FAILED);
6117 MPASS(fpl.dvp == NULL);
6118 MPASS(fpl.tvp == NULL);
6119 MPASS(fpl.savename == false);
6121 ndp->ni_dvp = fpl.dvp;
6122 ndp->ni_vp = fpl.tvp;
6124 cnp->cn_flags |= HASBUF;
6126 cache_fpl_cleanup_cnp(cnp);