1 /*-
2 * SPDX-License-Identifier: BSD-3-Clause
3 *
4 * Copyright (c) 1989, 1993
5 * The Regents of the University of California. All rights reserved.
6 *
7 * This code is derived from software contributed to Berkeley by
8 * Rick Macklem at The University of Guelph.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
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.
21 *
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
32 * SUCH DAMAGE.
33 *
34 * from nfs_node.c 8.6 (Berkeley) 5/22/95
35 */
36
37 #include <sys/cdefs.h>
38 __FBSDID("$FreeBSD$");
39
40 #include <sys/param.h>
41 #include <sys/systm.h>
42 #include <sys/fcntl.h>
43 #include <sys/lock.h>
44 #include <sys/malloc.h>
45 #include <sys/mount.h>
46 #include <sys/namei.h>
47 #include <sys/proc.h>
48 #include <sys/socket.h>
49 #include <sys/sysctl.h>
50 #include <sys/taskqueue.h>
51 #include <sys/vnode.h>
52
53 #include <vm/uma.h>
54
55 #include <fs/nfs/nfsport.h>
56 #include <fs/nfsclient/nfsnode.h>
57 #include <fs/nfsclient/nfsmount.h>
58 #include <fs/nfsclient/nfs.h>
59 #include <fs/nfsclient/nfs_kdtrace.h>
60
61 #include <nfs/nfs_lock.h>
62
63 extern struct vop_vector newnfs_vnodeops;
64 extern struct buf_ops buf_ops_newnfs;
65 MALLOC_DECLARE(M_NEWNFSREQ);
66
67 uma_zone_t newnfsnode_zone;
68
69 const char nfs_vnode_tag[] = "nfs";
70
71 static void nfs_freesillyrename(void *arg, __unused int pending);
72
73 void
74 ncl_nhinit(void)
75 {
76
77 newnfsnode_zone = uma_zcreate("NCLNODE", sizeof(struct nfsnode), NULL,
78 NULL, NULL, NULL, UMA_ALIGN_PTR, 0);
79 }
80
81 void
82 ncl_nhuninit(void)
83 {
84 uma_zdestroy(newnfsnode_zone);
85 }
86
87 /*
88 * ONLY USED FOR THE ROOT DIRECTORY. nfscl_nget() does the rest. If this
89 * function is going to be used to get Regular Files, code must be added
90 * to fill in the "struct nfsv4node".
91 * Look up a vnode/nfsnode by file handle.
92 * Callers must check for mount points!!
93 * In all cases, a pointer to a
94 * nfsnode structure is returned.
95 */
96 int
97 ncl_nget(struct mount *mntp, u_int8_t *fhp, int fhsize, struct nfsnode **npp,
98 int lkflags)
99 {
100 struct thread *td = curthread; /* XXX */
101 struct nfsnode *np;
102 struct vnode *vp;
103 struct vnode *nvp;
104 int error;
105 u_int hash;
106 struct nfsmount *nmp;
107 struct nfsfh *nfhp;
108
109 nmp = VFSTONFS(mntp);
110 *npp = NULL;
111
112 hash = fnv_32_buf(fhp, fhsize, FNV1_32_INIT);
113
114 nfhp = malloc(sizeof (struct nfsfh) + fhsize,
115 M_NFSFH, M_WAITOK);
116 bcopy(fhp, &nfhp->nfh_fh[0], fhsize);
117 nfhp->nfh_len = fhsize;
118 error = vfs_hash_get(mntp, hash, lkflags,
119 td, &nvp, newnfs_vncmpf, nfhp);
120 free(nfhp, M_NFSFH);
121 if (error)
122 return (error);
123 if (nvp != NULL) {
124 *npp = VTONFS(nvp);
125 return (0);
126 }
127 np = uma_zalloc(newnfsnode_zone, M_WAITOK | M_ZERO);
128
129 error = getnewvnode(nfs_vnode_tag, mntp, &newnfs_vnodeops, &nvp);
130 if (error) {
131 uma_zfree(newnfsnode_zone, np);
132 return (error);
133 }
134 vp = nvp;
135 KASSERT(vp->v_bufobj.bo_bsize != 0, ("ncl_nget: bo_bsize == 0"));
136 vp->v_bufobj.bo_ops = &buf_ops_newnfs;
137 vp->v_data = np;
138 np->n_vnode = vp;
139 /*
140 * Initialize the mutex even if the vnode is going to be a loser.
141 * This simplifies the logic in reclaim, which can then unconditionally
142 * destroy the mutex (in the case of the loser, or if hash_insert
143 * happened to return an error no special casing is needed).
144 */
145 mtx_init(&np->n_mtx, "NEWNFSnode lock", NULL, MTX_DEF | MTX_DUPOK);
146 lockinit(&np->n_excl, PVFS, "nfsupg", VLKTIMEOUT, LK_NOSHARE |
147 LK_CANRECURSE);
148
149 /*
150 * NFS supports recursive and shared locking.
151 */
152 lockmgr(vp->v_vnlock, LK_EXCLUSIVE | LK_NOWITNESS, NULL);
153 VN_LOCK_AREC(vp);
154 VN_LOCK_ASHARE(vp);
155 /*
156 * Are we getting the root? If so, make sure the vnode flags
157 * are correct
158 */
159 if ((fhsize == nmp->nm_fhsize) &&
160 !bcmp(fhp, nmp->nm_fh, fhsize)) {
161 if (vp->v_type == VNON)
162 vp->v_type = VDIR;
163 vp->v_vflag |= VV_ROOT;
164 }
165
166 vp->v_vflag |= VV_VMSIZEVNLOCK;
167
168 np->n_fhp = malloc(sizeof (struct nfsfh) + fhsize,
169 M_NFSFH, M_WAITOK);
170 bcopy(fhp, np->n_fhp->nfh_fh, fhsize);
171 np->n_fhp->nfh_len = fhsize;
172 error = insmntque(vp, mntp);
173 if (error != 0) {
174 *npp = NULL;
175 free(np->n_fhp, M_NFSFH);
176 mtx_destroy(&np->n_mtx);
177 lockdestroy(&np->n_excl);
178 uma_zfree(newnfsnode_zone, np);
179 return (error);
180 }
181 vn_set_state(vp, VSTATE_CONSTRUCTED);
182 error = vfs_hash_insert(vp, hash, lkflags,
183 td, &nvp, newnfs_vncmpf, np->n_fhp);
184 if (error)
185 return (error);
186 if (nvp != NULL) {
187 *npp = VTONFS(nvp);
188 /* vfs_hash_insert() vput()'s the losing vnode */
189 return (0);
190 }
191 *npp = np;
192
193 return (0);
194 }
195
196 /*
197 * Do the vrele(sp->s_dvp) as a separate task in order to avoid a
198 * deadlock because of a LOR when vrele() locks the directory vnode.
199 */
200 static void
201 nfs_freesillyrename(void *arg, __unused int pending)
202 {
203 struct sillyrename *sp;
204
205 sp = arg;
206 vrele(sp->s_dvp);
207 free(sp, M_NEWNFSREQ);
208 }
209
210 static void
211 ncl_releasesillyrename(struct vnode *vp, struct thread *td)
212 {
213 struct nfsnode *np;
214 struct sillyrename *sp;
215
216 ASSERT_VOP_ELOCKED(vp, "releasesillyrename");
217 np = VTONFS(vp);
218 NFSASSERTNODE(np);
219 if (vp->v_type != VDIR) {
220 sp = np->n_sillyrename;
221 np->n_sillyrename = NULL;
222 } else
223 sp = NULL;
224 if (sp != NULL) {
225 NFSUNLOCKNODE(np);
226 (void) ncl_vinvalbuf(vp, 0, td, 1);
227 /*
228 * Remove the silly file that was rename'd earlier
229 */
230 ncl_removeit(sp, vp);
231 crfree(sp->s_cred);
232 TASK_INIT(&sp->s_task, 0, nfs_freesillyrename, sp);
233 taskqueue_enqueue(taskqueue_thread, &sp->s_task);
234 NFSLOCKNODE(np);
235 }
236 }
237
238 int
239 ncl_inactive(struct vop_inactive_args *ap)
240 {
241 struct vnode *vp = ap->a_vp;
242 struct nfsnode *np;
243 struct thread *td;
244 boolean_t retv;
245
246 td = curthread;
247 np = VTONFS(vp);
248 if (NFS_ISV4(vp) && vp->v_type == VREG) {
249 NFSLOCKNODE(np);
250 np->n_openstateid = NULL;
251 NFSUNLOCKNODE(np);
252 /*
253 * Since mmap()'d files do I/O after VOP_CLOSE(), the NFSv4
254 * Close operations are delayed until now. Any dirty
255 * buffers/pages must be flushed before the close, so that the
256 * stateid is available for the writes.
257 */
258 if (vp->v_object != NULL) {
259 VM_OBJECT_WLOCK(vp->v_object);
260 retv = vm_object_page_clean(vp->v_object, 0, 0,
261 OBJPC_SYNC);
262 VM_OBJECT_WUNLOCK(vp->v_object);
263 } else
264 retv = TRUE;
265 if (retv == TRUE) {
266 (void)ncl_flush(vp, MNT_WAIT, td, 1, 0);
267 (void)nfsrpc_close(vp, 1, td);
268 }
269 }
270
271 NFSLOCKNODE(np);
272 ncl_releasesillyrename(vp, td);
273
274 /*
275 * NMODIFIED means that there might be dirty/stale buffers
276 * associated with the NFS vnode.
277 * NDSCOMMIT means that the file is on a pNFS server and commits
278 * should be done to the DS.
279 * None of the other flags are meaningful after the vnode is unused.
280 */
281 np->n_flag &= (NMODIFIED | NDSCOMMIT);
282 NFSUNLOCKNODE(np);
283 return (0);
284 }
285
286 /*
287 * Reclaim an nfsnode so that it can be used for other purposes.
288 */
289 int
290 ncl_reclaim(struct vop_reclaim_args *ap)
291 {
292 struct vnode *vp = ap->a_vp;
293 struct nfsnode *np = VTONFS(vp);
294 struct nfsdmap *dp, *dp2;
295 struct thread *td;
296 struct mount *mp;
297
298 td = curthread;
299 mp = vp->v_mount;
300
301 /*
302 * If the NLM is running, give it a chance to abort pending
303 * locks.
304 */
305 if (nfs_reclaim_p != NULL)
306 nfs_reclaim_p(ap);
307
308 NFSLOCKNODE(np);
309 ncl_releasesillyrename(vp, td);
310
311 if (NFS_ISV4(vp) && vp->v_type == VREG) {
312 np->n_openstateid = NULL;
313 NFSUNLOCKNODE(np);
314 /*
315 * We can now safely close any remaining NFSv4 Opens for
316 * this file. Most opens will have already been closed by
317 * ncl_inactive(), but there are cases where it is not
318 * called, so we need to do it again here.
319 */
320 (void) nfsrpc_close(vp, 1, td);
321 /*
322 * It it unlikely a delegation will still exist, but
323 * if one does, it must be returned before calling
324 * vfs_hash_remove(), since it cannot be recalled once the
325 * nfs node is no longer available.
326 */
327 MNT_ILOCK(mp);
328 if ((mp->mnt_kern_flag & MNTK_UNMOUNTF) == 0) {
329 MNT_IUNLOCK(mp);
330 nfscl_delegreturnvp(vp, td);
331 } else
332 MNT_IUNLOCK(mp);
333 } else
334 NFSUNLOCKNODE(np);
335
336 vfs_hash_remove(vp);
337
338 /*
339 * Call nfscl_reclaimnode() to save attributes in the delegation,
340 * as required.
341 */
342 if (vp->v_type == VREG)
343 nfscl_reclaimnode(vp);
344
345 /*
346 * Free up any directory cookie structures and
347 * large file handle structures that might be associated with
348 * this nfs node.
349 */
350 if (vp->v_type == VDIR) {
351 dp = LIST_FIRST(&np->n_cookies);
352 while (dp) {
353 dp2 = dp;
354 dp = LIST_NEXT(dp, ndm_list);
355 free(dp2, M_NFSDIROFF);
356 }
357 }
358 if (np->n_writecred != NULL)
359 crfree(np->n_writecred);
360 free(np->n_fhp, M_NFSFH);
361 if (np->n_v4 != NULL)
362 free(np->n_v4, M_NFSV4NODE);
363 mtx_destroy(&np->n_mtx);
364 lockdestroy(&np->n_excl);
365 uma_zfree(newnfsnode_zone, vp->v_data);
366 vp->v_data = NULL;
367 return (0);
368 }
369
370 /*
371 * Invalidate both the access and attribute caches for this vnode.
372 */
373 void
374 ncl_invalcaches(struct vnode *vp)
375 {
376 struct nfsnode *np = VTONFS(vp);
377 int i;
378
379 NFSLOCKNODE(np);
380 for (i = 0; i < NFS_ACCESSCACHESIZE; i++)
381 np->n_accesscache[i].stamp = 0;
382 KDTRACE_NFS_ACCESSCACHE_FLUSH_DONE(vp);
383 np->n_attrstamp = 0;
384 KDTRACE_NFS_ATTRCACHE_FLUSH_DONE(vp);
385 NFSUNLOCKNODE(np);
386 }
Cache object: aaad652cfd78bb61194b09aa06c3703d
|