2 * Copyright (c) 2009 Rick Macklem, University of Guelph
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 #include <sys/cdefs.h>
29 __FBSDID("$FreeBSD$");
32 * These functions implement the client side state handling for NFSv4.
33 * NFSv4 state handling:
34 * - A lockowner is used to determine lock contention, so it
35 * corresponds directly to a Posix pid. (1 to 1 mapping)
36 * - The correct granularity of an OpenOwner is not nearly so
37 * obvious. An OpenOwner does the following:
38 * - provides a serial sequencing of Open/Close/Lock-with-new-lockowner
39 * - is used to check for Open/Share contention (not applicable to
40 * this client, since all Opens are Deny_None)
41 * As such, I considered both extreme.
42 * 1 OpenOwner per ClientID - Simple to manage, but fully serializes
43 * all Open, Close and Lock (with a new lockowner) Ops.
44 * 1 OpenOwner for each Open - This one results in an OpenConfirm for
45 * every Open, for most servers.
46 * So, I chose to use the same mapping as I did for LockOwnwers.
47 * The main concern here is that you can end up with multiple Opens
48 * for the same File Handle, but on different OpenOwners (opens
49 * inherited from parents, grandparents...) and you do not know
50 * which of these the vnodeop close applies to. This is handled by
51 * delaying the Close Op(s) until all of the Opens have been closed.
52 * (It is not yet obvious if this is the correct granularity.)
53 * - How the code handles serialization:
54 * - For the ClientId, it uses an exclusive lock while getting its
55 * SetClientId and during recovery. Otherwise, it uses a shared
56 * lock via a reference count.
57 * - For the rest of the data structures, it uses an SMP mutex
58 * (once the nfs client is SMP safe) and doesn't sleep while
59 * manipulating the linked lists.
60 * - The serialization of Open/Close/Lock/LockU falls out in the
61 * "wash", since OpenOwners and LockOwners are both mapped from
62 * Posix pid. In other words, there is only one Posix pid using
63 * any given owner, so that owner is serialized. (If you change
64 * the granularity of the OpenOwner, then code must be added to
65 * serialize Ops on the OpenOwner.)
66 * - When to get rid of OpenOwners and LockOwners.
67 * - The function nfscl_cleanup_common() is executed after a process exits.
68 * It goes through the client list looking for all Open and Lock Owners.
69 * When one is found, it is marked "defunct" or in the case of
70 * an OpenOwner without any Opens, freed.
71 * The renew thread scans for defunct Owners and gets rid of them,
72 * if it can. The LockOwners will also be deleted when the
73 * associated Open is closed.
74 * - If the LockU or Close Op(s) fail during close in a way
75 * that could be recovered upon retry, they are relinked to the
76 * ClientId's defunct open list and retried by the renew thread
77 * until they succeed or an unmount/recovery occurs.
78 * (Since we are done with them, they do not need to be recovered.)
82 #include <fs/nfs/nfsport.h>
87 extern struct nfsstats newnfsstats;
88 extern struct nfsreqhead nfsd_reqq;
89 extern u_int32_t newnfs_false, newnfs_true;
90 extern int nfscl_debuglevel;
94 struct nfsclhead nfsclhead; /* Head of clientid list */
95 int nfscl_deleghighwater = NFSCLDELEGHIGHWATER;
96 int nfscl_layouthighwater = NFSCLLAYOUTHIGHWATER;
97 #endif /* !APPLEKEXT */
99 static int nfscl_delegcnt = 0;
100 static int nfscl_layoutcnt = 0;
101 static int nfscl_getopen(struct nfsclownerhead *, u_int8_t *, int, u_int8_t *,
102 u_int8_t *, u_int32_t, struct nfscllockowner **, struct nfsclopen **);
103 static void nfscl_clrelease(struct nfsclclient *);
104 static void nfscl_cleanclient(struct nfsclclient *);
105 static void nfscl_expireclient(struct nfsclclient *, struct nfsmount *,
106 struct ucred *, NFSPROC_T *);
107 static int nfscl_expireopen(struct nfsclclient *, struct nfsclopen *,
108 struct nfsmount *, struct ucred *, NFSPROC_T *);
109 static void nfscl_recover(struct nfsclclient *, struct ucred *, NFSPROC_T *);
110 static void nfscl_insertlock(struct nfscllockowner *, struct nfscllock *,
111 struct nfscllock *, int);
112 static int nfscl_updatelock(struct nfscllockowner *, struct nfscllock **,
113 struct nfscllock **, int);
114 static void nfscl_delegreturnall(struct nfsclclient *, NFSPROC_T *);
115 static u_int32_t nfscl_nextcbident(void);
116 static mount_t nfscl_getmnt(int, uint8_t *, u_int32_t, struct nfsclclient **);
117 static struct nfsclclient *nfscl_getclnt(u_int32_t);
118 static struct nfsclclient *nfscl_getclntsess(uint8_t *);
119 static struct nfscldeleg *nfscl_finddeleg(struct nfsclclient *, u_int8_t *,
121 static void nfscl_retoncloselayout(struct nfsclclient *, uint8_t *, int);
122 static void nfscl_reldevinfo_locked(struct nfscldevinfo *);
123 static struct nfscllayout *nfscl_findlayout(struct nfsclclient *, u_int8_t *,
125 static struct nfscldevinfo *nfscl_finddevinfo(struct nfsclclient *, uint8_t *);
126 static int nfscl_checkconflict(struct nfscllockownerhead *, struct nfscllock *,
127 u_int8_t *, struct nfscllock **);
128 static void nfscl_freealllocks(struct nfscllockownerhead *, int);
129 static int nfscl_localconflict(struct nfsclclient *, u_int8_t *, int,
130 struct nfscllock *, u_int8_t *, struct nfscldeleg *, struct nfscllock **);
131 static void nfscl_newopen(struct nfsclclient *, struct nfscldeleg *,
132 struct nfsclowner **, struct nfsclowner **, struct nfsclopen **,
133 struct nfsclopen **, u_int8_t *, u_int8_t *, int, int *);
134 static int nfscl_moveopen(vnode_t , struct nfsclclient *,
135 struct nfsmount *, struct nfsclopen *, struct nfsclowner *,
136 struct nfscldeleg *, struct ucred *, NFSPROC_T *);
137 static void nfscl_totalrecall(struct nfsclclient *);
138 static int nfscl_relock(vnode_t , struct nfsclclient *, struct nfsmount *,
139 struct nfscllockowner *, struct nfscllock *, struct ucred *, NFSPROC_T *);
140 static int nfscl_tryopen(struct nfsmount *, vnode_t , u_int8_t *, int,
141 u_int8_t *, int, u_int32_t, struct nfsclopen *, u_int8_t *, int,
142 struct nfscldeleg **, int, u_int32_t, struct ucred *, NFSPROC_T *);
143 static int nfscl_trylock(struct nfsmount *, vnode_t , u_int8_t *,
144 int, struct nfscllockowner *, int, int, u_int64_t, u_int64_t, short,
145 struct ucred *, NFSPROC_T *);
146 static int nfsrpc_reopen(struct nfsmount *, u_int8_t *, int, u_int32_t,
147 struct nfsclopen *, struct nfscldeleg **, struct ucred *, NFSPROC_T *);
148 static void nfscl_freedeleg(struct nfscldeleghead *, struct nfscldeleg *);
149 static int nfscl_errmap(struct nfsrv_descript *, u_int32_t);
150 static void nfscl_cleanup_common(struct nfsclclient *, u_int8_t *);
151 static int nfscl_recalldeleg(struct nfsclclient *, struct nfsmount *,
152 struct nfscldeleg *, vnode_t, struct ucred *, NFSPROC_T *, int);
153 static void nfscl_freeopenowner(struct nfsclowner *, int);
154 static void nfscl_cleandeleg(struct nfscldeleg *);
155 static int nfscl_trydelegreturn(struct nfscldeleg *, struct ucred *,
156 struct nfsmount *, NFSPROC_T *);
157 static void nfscl_emptylockowner(struct nfscllockowner *,
158 struct nfscllockownerfhhead *);
159 static void nfscl_mergeflayouts(struct nfsclflayouthead *,
160 struct nfsclflayouthead *);
161 static int nfscl_layoutrecall(int, struct nfscllayout *, uint32_t, uint64_t,
162 uint64_t, uint32_t, struct nfsclrecalllayout *);
163 static int nfscl_seq(uint32_t, uint32_t);
164 static void nfscl_layoutreturn(struct nfsmount *, struct nfscllayout *,
165 struct ucred *, NFSPROC_T *);
166 static void nfscl_dolayoutcommit(struct nfsmount *, struct nfscllayout *,
167 struct ucred *, NFSPROC_T *);
169 static short nfscberr_null[] = {
174 static short nfscberr_getattr[] = {
183 static short nfscberr_recall[] = {
193 static short *nfscl_cberrmap[] = {
201 #define NETFAMILY(clp) \
202 (((clp)->nfsc_flags & NFSCLFLAGS_AFINET6) ? AF_INET6 : AF_INET)
205 * Called for an open operation.
206 * If the nfhp argument is NULL, just get an openowner.
209 nfscl_open(vnode_t vp, u_int8_t *nfhp, int fhlen, u_int32_t amode, int usedeleg,
210 struct ucred *cred, NFSPROC_T *p, struct nfsclowner **owpp,
211 struct nfsclopen **opp, int *newonep, int *retp, int lockit)
213 struct nfsclclient *clp;
214 struct nfsclowner *owp, *nowp;
215 struct nfsclopen *op = NULL, *nop = NULL;
216 struct nfscldeleg *dp;
217 struct nfsclownerhead *ohp;
218 u_int8_t own[NFSV4CL_LOCKNAMELEN];
229 * Might need one or both of these, so MALLOC them now, to
230 * avoid a tsleep() in MALLOC later.
232 MALLOC(nowp, struct nfsclowner *, sizeof (struct nfsclowner),
233 M_NFSCLOWNER, M_WAITOK);
235 MALLOC(nop, struct nfsclopen *, sizeof (struct nfsclopen) +
236 fhlen - 1, M_NFSCLOPEN, M_WAITOK);
237 ret = nfscl_getcl(vnode_mount(vp), cred, p, 1, &clp);
239 FREE((caddr_t)nowp, M_NFSCLOWNER);
241 FREE((caddr_t)nop, M_NFSCLOPEN);
246 * Get the Open iff it already exists.
247 * If none found, add the new one or return error, depending upon
250 nfscl_filllockowner(p->td_proc, own, F_POSIX);
253 /* First check the delegation list */
254 if (nfhp != NULL && usedeleg) {
255 LIST_FOREACH(dp, NFSCLDELEGHASH(clp, nfhp, fhlen), nfsdl_hash) {
256 if (dp->nfsdl_fhlen == fhlen &&
257 !NFSBCMP(nfhp, dp->nfsdl_fh, fhlen)) {
258 if (!(amode & NFSV4OPEN_ACCESSWRITE) ||
259 (dp->nfsdl_flags & NFSCLDL_WRITE))
268 ohp = &dp->nfsdl_owner;
270 ohp = &clp->nfsc_owner;
271 /* Now, search for an openowner */
272 LIST_FOREACH(owp, ohp, nfsow_list) {
273 if (!NFSBCMP(owp->nfsow_owner, own, NFSV4CL_LOCKNAMELEN))
278 * Create a new open, as required.
280 nfscl_newopen(clp, dp, &owp, &nowp, &op, &nop, own, nfhp, fhlen,
284 * Now, check the mode on the open and return the appropriate
288 if (nfhp != NULL && dp != NULL && nop == NULL)
289 /* new local open on delegation */
290 *retp = NFSCLOPEN_SETCRED;
292 *retp = NFSCLOPEN_OK;
294 if (op != NULL && (amode & ~(op->nfso_mode))) {
295 op->nfso_mode |= amode;
296 if (retp != NULL && dp == NULL)
297 *retp = NFSCLOPEN_DOOPEN;
301 * Serialize modifications to the open owner for multiple threads
302 * within the same process using a read/write sleep lock.
305 nfscl_lockexcl(&owp->nfsow_rwlock, NFSCLSTATEMUTEXPTR);
308 FREE((caddr_t)nowp, M_NFSCLOWNER);
310 FREE((caddr_t)nop, M_NFSCLOPEN);
319 * Create a new open, as required.
322 nfscl_newopen(struct nfsclclient *clp, struct nfscldeleg *dp,
323 struct nfsclowner **owpp, struct nfsclowner **nowpp, struct nfsclopen **opp,
324 struct nfsclopen **nopp, u_int8_t *own, u_int8_t *fhp, int fhlen,
327 struct nfsclowner *owp = *owpp, *nowp;
328 struct nfsclopen *op, *nop;
338 if (owp == NULL && nowp != NULL) {
339 NFSBCOPY(own, nowp->nfsow_owner, NFSV4CL_LOCKNAMELEN);
340 LIST_INIT(&nowp->nfsow_open);
341 nowp->nfsow_clp = clp;
342 nowp->nfsow_seqid = 0;
343 nowp->nfsow_defunct = 0;
344 nfscl_lockinit(&nowp->nfsow_rwlock);
346 newnfsstats.cllocalopenowners++;
347 LIST_INSERT_HEAD(&dp->nfsdl_owner, nowp, nfsow_list);
349 newnfsstats.clopenowners++;
350 LIST_INSERT_HEAD(&clp->nfsc_owner, nowp, nfsow_list);
358 /* If an fhp has been specified, create an Open as well. */
360 /* and look for the correct open, based upon FH */
361 LIST_FOREACH(op, &owp->nfsow_open, nfso_list) {
362 if (op->nfso_fhlen == fhlen &&
363 !NFSBCMP(op->nfso_fh, fhp, fhlen))
366 if (op == NULL && nop != NULL) {
369 nop->nfso_opencnt = 0;
370 nop->nfso_posixlock = 1;
371 nop->nfso_fhlen = fhlen;
372 NFSBCOPY(fhp, nop->nfso_fh, fhlen);
373 LIST_INIT(&nop->nfso_lock);
374 nop->nfso_stateid.seqid = 0;
375 nop->nfso_stateid.other[0] = 0;
376 nop->nfso_stateid.other[1] = 0;
377 nop->nfso_stateid.other[2] = 0;
379 TAILQ_REMOVE(&clp->nfsc_deleg, dp, nfsdl_list);
380 TAILQ_INSERT_HEAD(&clp->nfsc_deleg, dp,
382 dp->nfsdl_timestamp = NFSD_MONOSEC + 120;
383 newnfsstats.cllocalopens++;
385 newnfsstats.clopens++;
387 LIST_INSERT_HEAD(&owp->nfsow_open, nop, nfso_list);
399 * Called to find/add a delegation to a client.
402 nfscl_deleg(mount_t mp, struct nfsclclient *clp, u_int8_t *nfhp,
403 int fhlen, struct ucred *cred, NFSPROC_T *p, struct nfscldeleg **dpp)
405 struct nfscldeleg *dp = *dpp, *tdp;
408 * First, if we have received a Read delegation for a file on a
409 * read/write file system, just return it, because they aren't
412 if (mp != NULL && dp != NULL && !NFSMNT_RDONLY(mp) &&
413 (dp->nfsdl_flags & NFSCLDL_READ)) {
414 (void) nfscl_trydelegreturn(dp, cred, VFSTONFS(mp), p);
415 FREE((caddr_t)dp, M_NFSCLDELEG);
420 /* Look for the correct deleg, based upon FH */
422 tdp = nfscl_finddeleg(clp, nfhp, fhlen);
426 return (NFSERR_BADSTATEID);
429 TAILQ_INSERT_HEAD(&clp->nfsc_deleg, dp, nfsdl_list);
430 LIST_INSERT_HEAD(NFSCLDELEGHASH(clp, nfhp, fhlen), dp,
432 dp->nfsdl_timestamp = NFSD_MONOSEC + 120;
433 newnfsstats.cldelegates++;
437 * Delegation already exists, what do we do if a new one??
440 printf("Deleg already exists!\n");
441 FREE((caddr_t)dp, M_NFSCLDELEG);
452 * Find a delegation for this file handle. Return NULL upon failure.
454 static struct nfscldeleg *
455 nfscl_finddeleg(struct nfsclclient *clp, u_int8_t *fhp, int fhlen)
457 struct nfscldeleg *dp;
459 LIST_FOREACH(dp, NFSCLDELEGHASH(clp, fhp, fhlen), nfsdl_hash) {
460 if (dp->nfsdl_fhlen == fhlen &&
461 !NFSBCMP(dp->nfsdl_fh, fhp, fhlen))
468 * Get a stateid for an I/O operation. First, look for an open and iff
469 * found, return either a lockowner stateid or the open stateid.
470 * If no Open is found, just return error and the special stateid of all zeros.
473 nfscl_getstateid(vnode_t vp, u_int8_t *nfhp, int fhlen, u_int32_t mode,
474 int fords, struct ucred *cred, NFSPROC_T *p, nfsv4stateid_t *stateidp,
477 struct nfsclclient *clp;
478 struct nfsclowner *owp;
479 struct nfsclopen *op = NULL;
480 struct nfscllockowner *lp;
481 struct nfscldeleg *dp;
483 u_int8_t own[NFSV4CL_LOCKNAMELEN];
488 * Initially, just set the special stateid of all zeros.
489 * (Don't do this for a DS, since the special stateid can't be used.)
493 stateidp->other[0] = 0;
494 stateidp->other[1] = 0;
495 stateidp->other[2] = 0;
497 if (vnode_vtype(vp) != VREG)
501 clp = nfscl_findcl(VFSTONFS(vnode_mount(vp)));
508 * Wait for recovery to complete.
510 while ((clp->nfsc_flags & NFSCLFLAGS_RECVRINPROG))
511 (void) nfsmsleep(&clp->nfsc_flags, NFSCLSTATEMUTEXPTR,
512 PZERO, "nfsrecvr", NULL);
515 * First, look for a delegation.
517 LIST_FOREACH(dp, NFSCLDELEGHASH(clp, nfhp, fhlen), nfsdl_hash) {
518 if (dp->nfsdl_fhlen == fhlen &&
519 !NFSBCMP(nfhp, dp->nfsdl_fh, fhlen)) {
520 if (!(mode & NFSV4OPEN_ACCESSWRITE) ||
521 (dp->nfsdl_flags & NFSCLDL_WRITE)) {
522 stateidp->seqid = dp->nfsdl_stateid.seqid;
523 stateidp->other[0] = dp->nfsdl_stateid.other[0];
524 stateidp->other[1] = dp->nfsdl_stateid.other[1];
525 stateidp->other[2] = dp->nfsdl_stateid.other[2];
526 if (!(np->n_flag & NDELEGRECALL)) {
527 TAILQ_REMOVE(&clp->nfsc_deleg, dp,
529 TAILQ_INSERT_HEAD(&clp->nfsc_deleg, dp,
531 dp->nfsdl_timestamp = NFSD_MONOSEC +
533 dp->nfsdl_rwlock.nfslock_usecnt++;
534 *lckpp = (void *)&dp->nfsdl_rwlock;
545 * If p != NULL, we want to search the parentage tree
546 * for a matching OpenOwner and use that.
548 nfscl_filllockowner(p->td_proc, own, F_POSIX);
550 error = nfscl_getopen(&clp->nfsc_owner, nfhp, fhlen, own, own,
552 if (error == 0 && lp != NULL && fords == 0) {
553 /* Don't return a lock stateid for a DS. */
555 lp->nfsl_stateid.seqid;
557 lp->nfsl_stateid.other[0];
559 lp->nfsl_stateid.other[1];
561 lp->nfsl_stateid.other[2];
567 /* If not found, just look for any OpenOwner that will work. */
569 owp = LIST_FIRST(&clp->nfsc_owner);
570 while (!done && owp != NULL) {
571 LIST_FOREACH(op, &owp->nfsow_open, nfso_list) {
572 if (op->nfso_fhlen == fhlen &&
573 !NFSBCMP(op->nfso_fh, nfhp, fhlen) &&
574 (mode & op->nfso_mode) == mode) {
580 owp = LIST_NEXT(owp, nfsow_list);
587 * For read aheads or write behinds, use the open cred.
588 * A read ahead or write behind is indicated by p == NULL.
591 newnfs_copycred(&op->nfso_cred, cred);
595 * No lock stateid, so return the open stateid.
597 stateidp->seqid = op->nfso_stateid.seqid;
598 stateidp->other[0] = op->nfso_stateid.other[0];
599 stateidp->other[1] = op->nfso_stateid.other[1];
600 stateidp->other[2] = op->nfso_stateid.other[2];
606 * Search for a matching file, mode and, optionally, lockowner.
609 nfscl_getopen(struct nfsclownerhead *ohp, u_int8_t *nfhp, int fhlen,
610 u_int8_t *openown, u_int8_t *lockown, u_int32_t mode,
611 struct nfscllockowner **lpp, struct nfsclopen **opp)
613 struct nfsclowner *owp;
614 struct nfsclopen *op, *rop, *rop2;
615 struct nfscllockowner *lp;
621 * rop will be set to the open to be returned. There are three
622 * variants of this, all for an open of the correct file:
623 * 1 - A match of lockown.
624 * 2 - A match of the openown, when no lockown match exists.
625 * 3 - A match for any open, if no openown or lockown match exists.
626 * Looking for #2 over #3 probably isn't necessary, but since
627 * RFC3530 is vague w.r.t. the relationship between openowners and
628 * lockowners, I think this is the safer way to go.
633 /* Search the client list */
634 owp = LIST_FIRST(ohp);
635 while (owp != NULL && keep_looping != 0) {
636 /* and look for the correct open */
637 op = LIST_FIRST(&owp->nfsow_open);
638 while (op != NULL && keep_looping != 0) {
639 if (op->nfso_fhlen == fhlen &&
640 !NFSBCMP(op->nfso_fh, nfhp, fhlen)
641 && (op->nfso_mode & mode) == mode) {
643 /* Now look for a matching lockowner. */
644 LIST_FOREACH(lp, &op->nfso_lock,
646 if (!NFSBCMP(lp->nfsl_owner,
648 NFSV4CL_LOCKNAMELEN)) {
656 if (rop == NULL && !NFSBCMP(owp->nfsow_owner,
657 openown, NFSV4CL_LOCKNAMELEN)) {
665 op = LIST_NEXT(op, nfso_list);
667 owp = LIST_NEXT(owp, nfsow_list);
678 * Release use of an open owner. Called when open operations are done
679 * with the open owner.
682 nfscl_ownerrelease(struct nfsclowner *owp, __unused int error,
683 __unused int candelete, int unlocked)
690 nfscl_lockunlock(&owp->nfsow_rwlock);
691 nfscl_clrelease(owp->nfsow_clp);
696 * Release use of an open structure under an open owner.
699 nfscl_openrelease(struct nfsclopen *op, int error, int candelete)
701 struct nfsclclient *clp;
702 struct nfsclowner *owp;
708 nfscl_lockunlock(&owp->nfsow_rwlock);
709 clp = owp->nfsow_clp;
710 if (error && candelete && op->nfso_opencnt == 0)
711 nfscl_freeopen(op, 0);
712 nfscl_clrelease(clp);
717 * Called to get a clientid structure. It will optionally lock the
718 * client data structures to do the SetClientId/SetClientId_confirm,
719 * but will release that lock and return the clientid with a refernce
721 * If the "cred" argument is NULL, a new clientid should not be created.
722 * If the "p" argument is NULL, a SetClientID/SetClientIDConfirm cannot
724 * The start_renewthread argument tells nfscl_getcl() to start a renew
725 * thread if this creates a new clp.
726 * It always clpp with a reference count on it, unless returning an error.
729 nfscl_getcl(struct mount *mp, struct ucred *cred, NFSPROC_T *p,
730 int start_renewthread, struct nfsclclient **clpp)
732 struct nfsclclient *clp;
733 struct nfsclclient *newclp = NULL;
734 struct nfsmount *nmp;
735 char uuid[HOSTUUIDLEN];
736 int igotlock = 0, error, trystalecnt, clidinusedelay, i;
741 getcredhostuuid(cred, uuid, sizeof uuid);
742 idlen = strlen(uuid);
744 idlen += sizeof (u_int64_t);
746 idlen += sizeof (u_int64_t) + 16; /* 16 random bytes */
747 MALLOC(newclp, struct nfsclclient *,
748 sizeof (struct nfsclclient) + idlen - 1, M_NFSCLCLIENT,
753 * If a forced dismount is already in progress, don't
754 * allocate a new clientid and get out now. For the case where
755 * clp != NULL, this is a harmless optimization.
757 if ((mp->mnt_kern_flag & MNTK_UNMOUNTF) != 0) {
760 free(newclp, M_NFSCLCLIENT);
765 if (newclp == NULL) {
770 clp->nfsc_idlen = idlen;
771 LIST_INIT(&clp->nfsc_owner);
772 TAILQ_INIT(&clp->nfsc_deleg);
773 TAILQ_INIT(&clp->nfsc_layout);
774 LIST_INIT(&clp->nfsc_devinfo);
775 for (i = 0; i < NFSCLDELEGHASHSIZE; i++)
776 LIST_INIT(&clp->nfsc_deleghash[i]);
777 for (i = 0; i < NFSCLLAYOUTHASHSIZE; i++)
778 LIST_INIT(&clp->nfsc_layouthash[i]);
779 clp->nfsc_flags = NFSCLFLAGS_INITED;
780 clp->nfsc_clientidrev = 1;
781 clp->nfsc_cbident = nfscl_nextcbident();
782 nfscl_fillclid(nmp->nm_clval, uuid, clp->nfsc_id,
784 LIST_INSERT_HEAD(&nfsclhead, clp, nfsc_list);
788 if (start_renewthread != 0)
789 nfscl_start_renewthread(clp);
793 free(newclp, M_NFSCLCLIENT);
796 while ((clp->nfsc_flags & NFSCLFLAGS_HASCLIENTID) == 0 && !igotlock &&
797 (mp->mnt_kern_flag & MNTK_UNMOUNTF) == 0)
798 igotlock = nfsv4_lock(&clp->nfsc_lock, 1, NULL,
799 NFSCLSTATEMUTEXPTR, mp);
802 * Call nfsv4_lock() with "iwantlock == 0" so that it will
803 * wait for a pending exclusive lock request. This gives the
804 * exclusive lock request priority over this shared lock
806 * An exclusive lock on nfsc_lock is used mainly for server
809 nfsv4_lock(&clp->nfsc_lock, 0, NULL, NFSCLSTATEMUTEXPTR, mp);
810 nfsv4_getref(&clp->nfsc_lock, NULL, NFSCLSTATEMUTEXPTR, mp);
812 if (igotlock == 0 && (mp->mnt_kern_flag & MNTK_UNMOUNTF) != 0) {
814 * Both nfsv4_lock() and nfsv4_getref() know to check
815 * for MNTK_UNMOUNTF and return without sleeping to
816 * wait for the exclusive lock to be released, since it
817 * might be held by nfscl_umount() and we need to get out
818 * now for that case and not wait until nfscl_umount()
827 * If it needs a clientid, do the setclientid now.
829 if ((clp->nfsc_flags & NFSCLFLAGS_HASCLIENTID) == 0) {
831 panic("nfscl_clget");
832 if (p == NULL || cred == NULL) {
834 nfsv4_unlock(&clp->nfsc_lock, 0);
839 * If RFC3530 Sec. 14.2.33 is taken literally,
840 * NFSERR_CLIDINUSE will be returned persistently for the
841 * case where a new mount of the same file system is using
842 * a different principal. In practice, NFSERR_CLIDINUSE is
843 * only returned when there is outstanding unexpired state
844 * on the clientid. As such, try for twice the lease
845 * interval, if we know what that is. Otherwise, make a
847 * The case of returning NFSERR_STALECLIENTID is far less
848 * likely, but might occur if there is a significant delay
849 * between doing the SetClientID and SetClientIDConfirm Ops,
850 * such that the server throws away the clientid before
851 * receiving the SetClientIDConfirm.
853 if (clp->nfsc_renew > 0)
854 clidinusedelay = NFSCL_LEASE(clp->nfsc_renew) * 2;
856 clidinusedelay = 120;
859 error = nfsrpc_setclient(nmp, clp, 0, cred, p);
860 if (error == NFSERR_STALECLIENTID ||
861 error == NFSERR_STALEDONTRECOVER ||
862 error == NFSERR_BADSESSION ||
863 error == NFSERR_CLIDINUSE) {
864 (void) nfs_catnap(PZERO, error, "nfs_setcl");
866 } while (((error == NFSERR_STALECLIENTID ||
867 error == NFSERR_BADSESSION ||
868 error == NFSERR_STALEDONTRECOVER) && --trystalecnt > 0) ||
869 (error == NFSERR_CLIDINUSE && --clidinusedelay > 0));
872 nfsv4_unlock(&clp->nfsc_lock, 0);
876 clp->nfsc_flags |= NFSCLFLAGS_HASCLIENTID;
880 nfsv4_unlock(&clp->nfsc_lock, 1);
889 * Get a reference to a clientid and return it, if valid.
891 APPLESTATIC struct nfsclclient *
892 nfscl_findcl(struct nfsmount *nmp)
894 struct nfsclclient *clp;
897 if (clp == NULL || !(clp->nfsc_flags & NFSCLFLAGS_HASCLIENTID))
903 * Release the clientid structure. It may be locked or reference counted.
906 nfscl_clrelease(struct nfsclclient *clp)
909 if (clp->nfsc_lock.nfslock_lock & NFSV4LOCK_LOCK)
910 nfsv4_unlock(&clp->nfsc_lock, 0);
912 nfsv4_relref(&clp->nfsc_lock);
916 * External call for nfscl_clrelease.
919 nfscl_clientrelease(struct nfsclclient *clp)
923 if (clp->nfsc_lock.nfslock_lock & NFSV4LOCK_LOCK)
924 nfsv4_unlock(&clp->nfsc_lock, 0);
926 nfsv4_relref(&clp->nfsc_lock);
931 * Called when wanting to lock a byte region.
934 nfscl_getbytelock(vnode_t vp, u_int64_t off, u_int64_t len,
935 short type, struct ucred *cred, NFSPROC_T *p, struct nfsclclient *rclp,
936 int recovery, void *id, int flags, u_int8_t *rownp, u_int8_t *ropenownp,
937 struct nfscllockowner **lpp, int *newonep, int *donelocallyp)
939 struct nfscllockowner *lp;
940 struct nfsclopen *op;
941 struct nfsclclient *clp;
942 struct nfscllockowner *nlp;
943 struct nfscllock *nlop, *otherlop;
944 struct nfscldeleg *dp = NULL, *ldp = NULL;
945 struct nfscllockownerhead *lhp = NULL;
947 u_int8_t own[NFSV4CL_LOCKNAMELEN], *ownp, openown[NFSV4CL_LOCKNAMELEN];
949 int error = 0, ret, donelocally = 0;
952 /* For Lock Ops, the open mode doesn't matter, so use 0 to match any. */
961 * Might need these, so MALLOC them now, to
962 * avoid a tsleep() in MALLOC later.
964 MALLOC(nlp, struct nfscllockowner *,
965 sizeof (struct nfscllockowner), M_NFSCLLOCKOWNER, M_WAITOK);
966 MALLOC(otherlop, struct nfscllock *,
967 sizeof (struct nfscllock), M_NFSCLLOCK, M_WAITOK);
968 MALLOC(nlop, struct nfscllock *,
969 sizeof (struct nfscllock), M_NFSCLLOCK, M_WAITOK);
970 nlop->nfslo_type = type;
971 nlop->nfslo_first = off;
972 if (len == NFS64BITSSET) {
973 nlop->nfslo_end = NFS64BITSSET;
975 nlop->nfslo_end = off + len;
976 if (nlop->nfslo_end <= nlop->nfslo_first)
977 error = NFSERR_INVAL;
984 error = nfscl_getcl(vnode_mount(vp), cred, p, 1, &clp);
987 FREE((caddr_t)nlp, M_NFSCLLOCKOWNER);
988 FREE((caddr_t)otherlop, M_NFSCLLOCK);
989 FREE((caddr_t)nlop, M_NFSCLLOCK);
996 openownp = ropenownp;
998 nfscl_filllockowner(id, own, flags);
1000 nfscl_filllockowner(p->td_proc, openown, F_POSIX);
1006 * First, search for a delegation. If one exists for this file,
1007 * the lock can be done locally against it, so long as there
1008 * isn't a local lock conflict.
1010 ldp = dp = nfscl_finddeleg(clp, np->n_fhp->nfh_fh,
1011 np->n_fhp->nfh_len);
1012 /* Just sanity check for correct type of delegation */
1013 if (dp != NULL && ((dp->nfsdl_flags &
1014 (NFSCLDL_RECALL | NFSCLDL_DELEGRET)) != 0 ||
1016 (dp->nfsdl_flags & NFSCLDL_WRITE) == 0)))
1020 /* Now, find an open and maybe a lockowner. */
1021 ret = nfscl_getopen(&dp->nfsdl_owner, np->n_fhp->nfh_fh,
1022 np->n_fhp->nfh_len, openownp, ownp, mode, NULL, &op);
1024 ret = nfscl_getopen(&clp->nfsc_owner,
1025 np->n_fhp->nfh_fh, np->n_fhp->nfh_len, openownp,
1026 ownp, mode, NULL, &op);
1028 lhp = &dp->nfsdl_lock;
1029 TAILQ_REMOVE(&clp->nfsc_deleg, dp, nfsdl_list);
1030 TAILQ_INSERT_HEAD(&clp->nfsc_deleg, dp, nfsdl_list);
1031 dp->nfsdl_timestamp = NFSD_MONOSEC + 120;
1039 * Get the related Open and maybe lockowner.
1041 error = nfscl_getopen(&clp->nfsc_owner,
1042 np->n_fhp->nfh_fh, np->n_fhp->nfh_len, openownp,
1043 ownp, mode, &lp, &op);
1045 lhp = &op->nfso_lock;
1047 if (!error && !recovery)
1048 error = nfscl_localconflict(clp, np->n_fhp->nfh_fh,
1049 np->n_fhp->nfh_len, nlop, ownp, ldp, NULL);
1052 nfscl_clrelease(clp);
1055 FREE((caddr_t)nlp, M_NFSCLLOCKOWNER);
1056 FREE((caddr_t)otherlop, M_NFSCLLOCK);
1057 FREE((caddr_t)nlop, M_NFSCLLOCK);
1062 * Ok, see if a lockowner exists and create one, as required.
1065 LIST_FOREACH(lp, lhp, nfsl_list) {
1066 if (!NFSBCMP(lp->nfsl_owner, ownp, NFSV4CL_LOCKNAMELEN))
1070 NFSBCOPY(ownp, nlp->nfsl_owner, NFSV4CL_LOCKNAMELEN);
1072 NFSBCOPY(ropenownp, nlp->nfsl_openowner,
1073 NFSV4CL_LOCKNAMELEN);
1075 NFSBCOPY(op->nfso_own->nfsow_owner, nlp->nfsl_openowner,
1076 NFSV4CL_LOCKNAMELEN);
1077 nlp->nfsl_seqid = 0;
1078 nlp->nfsl_lockflags = flags;
1079 nlp->nfsl_inprog = NULL;
1080 nfscl_lockinit(&nlp->nfsl_rwlock);
1081 LIST_INIT(&nlp->nfsl_lock);
1083 nlp->nfsl_open = NULL;
1084 newnfsstats.cllocallockowners++;
1086 nlp->nfsl_open = op;
1087 newnfsstats.cllockowners++;
1089 LIST_INSERT_HEAD(lhp, nlp, nfsl_list);
1096 * Now, update the byte ranges for locks.
1098 ret = nfscl_updatelock(lp, &nlop, &otherlop, donelocally);
1104 nfscl_clrelease(clp);
1107 * Serial modifications on the lock owner for multiple threads
1108 * for the same process using a read/write lock.
1111 nfscl_lockexcl(&lp->nfsl_rwlock, NFSCLSTATEMUTEXPTR);
1117 FREE((caddr_t)nlp, M_NFSCLLOCKOWNER);
1119 FREE((caddr_t)nlop, M_NFSCLLOCK);
1121 FREE((caddr_t)otherlop, M_NFSCLLOCK);
1128 * Called to unlock a byte range, for LockU.
1131 nfscl_relbytelock(vnode_t vp, u_int64_t off, u_int64_t len,
1132 __unused struct ucred *cred, NFSPROC_T *p, int callcnt,
1133 struct nfsclclient *clp, void *id, int flags,
1134 struct nfscllockowner **lpp, int *dorpcp)
1136 struct nfscllockowner *lp;
1137 struct nfsclowner *owp;
1138 struct nfsclopen *op;
1139 struct nfscllock *nlop, *other_lop = NULL;
1140 struct nfscldeleg *dp;
1142 u_int8_t own[NFSV4CL_LOCKNAMELEN];
1150 * Might need these, so MALLOC them now, to
1151 * avoid a tsleep() in MALLOC later.
1153 MALLOC(nlop, struct nfscllock *,
1154 sizeof (struct nfscllock), M_NFSCLLOCK, M_WAITOK);
1155 nlop->nfslo_type = F_UNLCK;
1156 nlop->nfslo_first = off;
1157 if (len == NFS64BITSSET) {
1158 nlop->nfslo_end = NFS64BITSSET;
1160 nlop->nfslo_end = off + len;
1161 if (nlop->nfslo_end <= nlop->nfslo_first) {
1162 FREE((caddr_t)nlop, M_NFSCLLOCK);
1163 return (NFSERR_INVAL);
1167 MALLOC(other_lop, struct nfscllock *,
1168 sizeof (struct nfscllock), M_NFSCLLOCK, M_WAITOK);
1171 nfscl_filllockowner(id, own, flags);
1175 dp = nfscl_finddeleg(clp, np->n_fhp->nfh_fh,
1176 np->n_fhp->nfh_len);
1179 * First, unlock any local regions on a delegation.
1182 /* Look for this lockowner. */
1183 LIST_FOREACH(lp, &dp->nfsdl_lock, nfsl_list) {
1184 if (!NFSBCMP(lp->nfsl_owner, own,
1185 NFSV4CL_LOCKNAMELEN))
1189 /* Use other_lop, so nlop is still available */
1190 (void)nfscl_updatelock(lp, &other_lop, NULL, 1);
1194 * Now, find a matching open/lockowner that hasn't already been done,
1195 * as marked by nfsl_inprog.
1199 LIST_FOREACH(owp, &clp->nfsc_owner, nfsow_list) {
1200 LIST_FOREACH(op, &owp->nfsow_open, nfso_list) {
1201 if (op->nfso_fhlen == np->n_fhp->nfh_len &&
1202 !NFSBCMP(op->nfso_fh, np->n_fhp->nfh_fh, op->nfso_fhlen)) {
1203 LIST_FOREACH(lp, &op->nfso_lock, nfsl_list) {
1204 if (lp->nfsl_inprog == NULL &&
1205 !NFSBCMP(lp->nfsl_owner, own,
1206 NFSV4CL_LOCKNAMELEN)) {
1220 ret = nfscl_updatelock(lp, &nlop, NULL, 0);
1224 * Serial modifications on the lock owner for multiple
1225 * threads for the same process using a read/write lock.
1227 lp->nfsl_inprog = p;
1228 nfscl_lockexcl(&lp->nfsl_rwlock, NFSCLSTATEMUTEXPTR);
1233 FREE((caddr_t)nlop, M_NFSCLLOCK);
1235 FREE((caddr_t)other_lop, M_NFSCLLOCK);
1240 * Release all lockowners marked in progess for this process and file.
1243 nfscl_releasealllocks(struct nfsclclient *clp, vnode_t vp, NFSPROC_T *p,
1244 void *id, int flags)
1246 struct nfsclowner *owp;
1247 struct nfsclopen *op;
1248 struct nfscllockowner *lp;
1250 u_int8_t own[NFSV4CL_LOCKNAMELEN];
1253 nfscl_filllockowner(id, own, flags);
1255 LIST_FOREACH(owp, &clp->nfsc_owner, nfsow_list) {
1256 LIST_FOREACH(op, &owp->nfsow_open, nfso_list) {
1257 if (op->nfso_fhlen == np->n_fhp->nfh_len &&
1258 !NFSBCMP(op->nfso_fh, np->n_fhp->nfh_fh, op->nfso_fhlen)) {
1259 LIST_FOREACH(lp, &op->nfso_lock, nfsl_list) {
1260 if (lp->nfsl_inprog == p &&
1261 !NFSBCMP(lp->nfsl_owner, own,
1262 NFSV4CL_LOCKNAMELEN)) {
1263 lp->nfsl_inprog = NULL;
1264 nfscl_lockunlock(&lp->nfsl_rwlock);
1270 nfscl_clrelease(clp);
1275 * Called to find out if any bytes within the byte range specified are
1276 * write locked by the calling process. Used to determine if flushing
1277 * is required before a LockU.
1278 * If in doubt, return 1, so the flush will occur.
1281 nfscl_checkwritelocked(vnode_t vp, struct flock *fl,
1282 struct ucred *cred, NFSPROC_T *p, void *id, int flags)
1284 struct nfsclowner *owp;
1285 struct nfscllockowner *lp;
1286 struct nfsclopen *op;
1287 struct nfsclclient *clp;
1288 struct nfscllock *lop;
1289 struct nfscldeleg *dp;
1292 u_int8_t own[NFSV4CL_LOCKNAMELEN];
1296 switch (fl->l_whence) {
1300 * Caller is responsible for adding any necessary offset
1301 * when SEEK_CUR is used.
1306 off = np->n_size + fl->l_start;
1311 if (fl->l_len != 0) {
1312 end = off + fl->l_len;
1319 error = nfscl_getcl(vnode_mount(vp), cred, p, 1, &clp);
1322 nfscl_filllockowner(id, own, flags);
1326 * First check the delegation locks.
1328 dp = nfscl_finddeleg(clp, np->n_fhp->nfh_fh, np->n_fhp->nfh_len);
1330 LIST_FOREACH(lp, &dp->nfsdl_lock, nfsl_list) {
1331 if (!NFSBCMP(lp->nfsl_owner, own,
1332 NFSV4CL_LOCKNAMELEN))
1336 LIST_FOREACH(lop, &lp->nfsl_lock, nfslo_list) {
1337 if (lop->nfslo_first >= end)
1339 if (lop->nfslo_end <= off)
1341 if (lop->nfslo_type == F_WRLCK) {
1342 nfscl_clrelease(clp);
1351 * Now, check state against the server.
1353 LIST_FOREACH(owp, &clp->nfsc_owner, nfsow_list) {
1354 LIST_FOREACH(op, &owp->nfsow_open, nfso_list) {
1355 if (op->nfso_fhlen == np->n_fhp->nfh_len &&
1356 !NFSBCMP(op->nfso_fh, np->n_fhp->nfh_fh, op->nfso_fhlen)) {
1357 LIST_FOREACH(lp, &op->nfso_lock, nfsl_list) {
1358 if (!NFSBCMP(lp->nfsl_owner, own,
1359 NFSV4CL_LOCKNAMELEN))
1363 LIST_FOREACH(lop, &lp->nfsl_lock, nfslo_list) {
1364 if (lop->nfslo_first >= end)
1366 if (lop->nfslo_end <= off)
1368 if (lop->nfslo_type == F_WRLCK) {
1369 nfscl_clrelease(clp);
1378 nfscl_clrelease(clp);
1384 * Release a byte range lock owner structure.
1387 nfscl_lockrelease(struct nfscllockowner *lp, int error, int candelete)
1389 struct nfsclclient *clp;
1394 clp = lp->nfsl_open->nfso_own->nfsow_clp;
1395 if (error != 0 && candelete &&
1396 (lp->nfsl_rwlock.nfslock_lock & NFSV4LOCK_WANTED) == 0)
1397 nfscl_freelockowner(lp, 0);
1399 nfscl_lockunlock(&lp->nfsl_rwlock);
1400 nfscl_clrelease(clp);
1405 * Free up an open structure and any associated byte range lock structures.
1408 nfscl_freeopen(struct nfsclopen *op, int local)
1411 LIST_REMOVE(op, nfso_list);
1412 nfscl_freealllocks(&op->nfso_lock, local);
1413 FREE((caddr_t)op, M_NFSCLOPEN);
1415 newnfsstats.cllocalopens--;
1417 newnfsstats.clopens--;
1421 * Free up all lock owners and associated locks.
1424 nfscl_freealllocks(struct nfscllockownerhead *lhp, int local)
1426 struct nfscllockowner *lp, *nlp;
1428 LIST_FOREACH_SAFE(lp, lhp, nfsl_list, nlp) {
1429 if ((lp->nfsl_rwlock.nfslock_lock & NFSV4LOCK_WANTED))
1431 nfscl_freelockowner(lp, local);
1436 * Called for an Open when NFSERR_EXPIRED is received from the server.
1437 * If there are no byte range locks nor a Share Deny lost, try to do a
1438 * fresh Open. Otherwise, free the open.
1441 nfscl_expireopen(struct nfsclclient *clp, struct nfsclopen *op,
1442 struct nfsmount *nmp, struct ucred *cred, NFSPROC_T *p)
1444 struct nfscllockowner *lp;
1445 struct nfscldeleg *dp;
1446 int mustdelete = 0, error;
1449 * Look for any byte range lock(s).
1451 LIST_FOREACH(lp, &op->nfso_lock, nfsl_list) {
1452 if (!LIST_EMPTY(&lp->nfsl_lock)) {
1459 * If no byte range lock(s) nor a Share deny, try to re-open.
1461 if (!mustdelete && (op->nfso_mode & NFSLCK_DENYBITS) == 0) {
1462 newnfs_copycred(&op->nfso_cred, cred);
1464 error = nfsrpc_reopen(nmp, op->nfso_fh,
1465 op->nfso_fhlen, op->nfso_mode, op, &dp, cred, p);
1469 FREE((caddr_t)dp, M_NFSCLDELEG);
1474 nfscl_deleg(nmp->nm_mountp, clp, op->nfso_fh,
1475 op->nfso_fhlen, cred, p, &dp);
1479 * If a byte range lock or Share deny or couldn't re-open, free it.
1482 nfscl_freeopen(op, 0);
1483 return (mustdelete);
1487 * Free up an open owner structure.
1490 nfscl_freeopenowner(struct nfsclowner *owp, int local)
1493 LIST_REMOVE(owp, nfsow_list);
1494 FREE((caddr_t)owp, M_NFSCLOWNER);
1496 newnfsstats.cllocalopenowners--;
1498 newnfsstats.clopenowners--;
1502 * Free up a byte range lock owner structure.
1505 nfscl_freelockowner(struct nfscllockowner *lp, int local)
1507 struct nfscllock *lop, *nlop;
1509 LIST_REMOVE(lp, nfsl_list);
1510 LIST_FOREACH_SAFE(lop, &lp->nfsl_lock, nfslo_list, nlop) {
1511 nfscl_freelock(lop, local);
1513 FREE((caddr_t)lp, M_NFSCLLOCKOWNER);
1515 newnfsstats.cllocallockowners--;
1517 newnfsstats.cllockowners--;
1521 * Free up a byte range lock structure.
1524 nfscl_freelock(struct nfscllock *lop, int local)
1527 LIST_REMOVE(lop, nfslo_list);
1528 FREE((caddr_t)lop, M_NFSCLLOCK);
1530 newnfsstats.cllocallocks--;
1532 newnfsstats.cllocks--;
1536 * Clean out the state related to a delegation.
1539 nfscl_cleandeleg(struct nfscldeleg *dp)
1541 struct nfsclowner *owp, *nowp;
1542 struct nfsclopen *op;
1544 LIST_FOREACH_SAFE(owp, &dp->nfsdl_owner, nfsow_list, nowp) {
1545 op = LIST_FIRST(&owp->nfsow_open);
1547 if (LIST_NEXT(op, nfso_list) != NULL)
1548 panic("nfscleandel");
1549 nfscl_freeopen(op, 1);
1551 nfscl_freeopenowner(owp, 1);
1553 nfscl_freealllocks(&dp->nfsdl_lock, 1);
1557 * Free a delegation.
1560 nfscl_freedeleg(struct nfscldeleghead *hdp, struct nfscldeleg *dp)
1563 TAILQ_REMOVE(hdp, dp, nfsdl_list);
1564 LIST_REMOVE(dp, nfsdl_hash);
1565 FREE((caddr_t)dp, M_NFSCLDELEG);
1566 newnfsstats.cldelegates--;
1571 * Free up all state related to this client structure.
1574 nfscl_cleanclient(struct nfsclclient *clp)
1576 struct nfsclowner *owp, *nowp;
1577 struct nfsclopen *op, *nop;
1579 /* Now, all the OpenOwners, etc. */
1580 LIST_FOREACH_SAFE(owp, &clp->nfsc_owner, nfsow_list, nowp) {
1581 LIST_FOREACH_SAFE(op, &owp->nfsow_open, nfso_list, nop) {
1582 nfscl_freeopen(op, 0);
1584 nfscl_freeopenowner(owp, 0);
1589 * Called when an NFSERR_EXPIRED is received from the server.
1592 nfscl_expireclient(struct nfsclclient *clp, struct nfsmount *nmp,
1593 struct ucred *cred, NFSPROC_T *p)
1595 struct nfsclowner *owp, *nowp, *towp;
1596 struct nfsclopen *op, *nop, *top;
1597 struct nfscldeleg *dp, *ndp;
1598 int ret, printed = 0;
1601 * First, merge locally issued Opens into the list for the server.
1603 dp = TAILQ_FIRST(&clp->nfsc_deleg);
1604 while (dp != NULL) {
1605 ndp = TAILQ_NEXT(dp, nfsdl_list);
1606 owp = LIST_FIRST(&dp->nfsdl_owner);
1607 while (owp != NULL) {
1608 nowp = LIST_NEXT(owp, nfsow_list);
1609 op = LIST_FIRST(&owp->nfsow_open);
1611 if (LIST_NEXT(op, nfso_list) != NULL)
1613 LIST_FOREACH(towp, &clp->nfsc_owner, nfsow_list) {
1614 if (!NFSBCMP(towp->nfsow_owner, owp->nfsow_owner,
1615 NFSV4CL_LOCKNAMELEN))
1619 /* Merge opens in */
1620 LIST_FOREACH(top, &towp->nfsow_open, nfso_list) {
1621 if (top->nfso_fhlen == op->nfso_fhlen &&
1622 !NFSBCMP(top->nfso_fh, op->nfso_fh,
1624 top->nfso_mode |= op->nfso_mode;
1625 top->nfso_opencnt += op->nfso_opencnt;
1630 /* Just add the open to the owner list */
1631 LIST_REMOVE(op, nfso_list);
1632 op->nfso_own = towp;
1633 LIST_INSERT_HEAD(&towp->nfsow_open, op, nfso_list);
1634 newnfsstats.cllocalopens--;
1635 newnfsstats.clopens++;
1638 /* Just add the openowner to the client list */
1639 LIST_REMOVE(owp, nfsow_list);
1640 owp->nfsow_clp = clp;
1641 LIST_INSERT_HEAD(&clp->nfsc_owner, owp, nfsow_list);
1642 newnfsstats.cllocalopenowners--;
1643 newnfsstats.clopenowners++;
1644 newnfsstats.cllocalopens--;
1645 newnfsstats.clopens++;
1650 if (!printed && !LIST_EMPTY(&dp->nfsdl_lock)) {
1652 printf("nfsv4 expired locks lost\n");
1654 nfscl_cleandeleg(dp);
1655 nfscl_freedeleg(&clp->nfsc_deleg, dp);
1658 if (!TAILQ_EMPTY(&clp->nfsc_deleg))
1662 * Now, try and reopen against the server.
1664 LIST_FOREACH_SAFE(owp, &clp->nfsc_owner, nfsow_list, nowp) {
1665 owp->nfsow_seqid = 0;
1666 LIST_FOREACH_SAFE(op, &owp->nfsow_open, nfso_list, nop) {
1667 ret = nfscl_expireopen(clp, op, nmp, cred, p);
1668 if (ret && !printed) {
1670 printf("nfsv4 expired locks lost\n");
1673 if (LIST_EMPTY(&owp->nfsow_open))
1674 nfscl_freeopenowner(owp, 0);
1679 * This function must be called after the process represented by "own" has
1680 * exited. Must be called with CLSTATE lock held.
1683 nfscl_cleanup_common(struct nfsclclient *clp, u_int8_t *own)
1685 struct nfsclowner *owp, *nowp;
1686 struct nfscllockowner *lp, *nlp;
1687 struct nfscldeleg *dp;
1689 /* First, get rid of local locks on delegations. */
1690 TAILQ_FOREACH(dp, &clp->nfsc_deleg, nfsdl_list) {
1691 LIST_FOREACH_SAFE(lp, &dp->nfsdl_lock, nfsl_list, nlp) {
1692 if (!NFSBCMP(lp->nfsl_owner, own, NFSV4CL_LOCKNAMELEN)) {
1693 if ((lp->nfsl_rwlock.nfslock_lock & NFSV4LOCK_WANTED))
1695 nfscl_freelockowner(lp, 1);
1699 owp = LIST_FIRST(&clp->nfsc_owner);
1700 while (owp != NULL) {
1701 nowp = LIST_NEXT(owp, nfsow_list);
1702 if (!NFSBCMP(owp->nfsow_owner, own,
1703 NFSV4CL_LOCKNAMELEN)) {
1705 * If there are children that haven't closed the
1706 * file descriptors yet, the opens will still be
1707 * here. For that case, let the renew thread clear
1708 * out the OpenOwner later.
1710 if (LIST_EMPTY(&owp->nfsow_open))
1711 nfscl_freeopenowner(owp, 0);
1713 owp->nfsow_defunct = 1;
1720 * Find open/lock owners for processes that have exited.
1723 nfscl_cleanupkext(struct nfsclclient *clp, struct nfscllockownerfhhead *lhp)
1725 struct nfsclowner *owp, *nowp;
1726 struct nfsclopen *op;
1727 struct nfscllockowner *lp, *nlp;
1731 LIST_FOREACH_SAFE(owp, &clp->nfsc_owner, nfsow_list, nowp) {
1732 LIST_FOREACH(op, &owp->nfsow_open, nfso_list) {
1733 LIST_FOREACH_SAFE(lp, &op->nfso_lock, nfsl_list, nlp) {
1734 if (LIST_EMPTY(&lp->nfsl_lock))
1735 nfscl_emptylockowner(lp, lhp);
1738 if (nfscl_procdoesntexist(owp->nfsow_owner))
1739 nfscl_cleanup_common(clp, owp->nfsow_owner);
1742 NFSPROCLISTUNLOCK();
1746 * Take the empty lock owner and move it to the local lhp list if the
1747 * associated process no longer exists.
1750 nfscl_emptylockowner(struct nfscllockowner *lp,
1751 struct nfscllockownerfhhead *lhp)
1753 struct nfscllockownerfh *lfhp, *mylfhp;
1754 struct nfscllockowner *nlp;
1757 /* If not a Posix lock owner, just return. */
1758 if ((lp->nfsl_lockflags & F_POSIX) == 0)
1764 * First, search to see if this lock owner is already in the list.
1765 * If it is, then the associated process no longer exists.
1767 SLIST_FOREACH(lfhp, lhp, nfslfh_list) {
1768 if (lfhp->nfslfh_len == lp->nfsl_open->nfso_fhlen &&
1769 !NFSBCMP(lfhp->nfslfh_fh, lp->nfsl_open->nfso_fh,
1772 LIST_FOREACH(nlp, &lfhp->nfslfh_lock, nfsl_list)
1773 if (!NFSBCMP(nlp->nfsl_owner, lp->nfsl_owner,
1774 NFSV4CL_LOCKNAMELEN))
1777 /* If not found, check if process still exists. */
1778 if (fnd_it == 0 && nfscl_procdoesntexist(lp->nfsl_owner) == 0)
1781 /* Move the lock owner over to the local list. */
1782 if (mylfhp == NULL) {
1783 mylfhp = malloc(sizeof(struct nfscllockownerfh), M_TEMP,
1787 mylfhp->nfslfh_len = lp->nfsl_open->nfso_fhlen;
1788 NFSBCOPY(lp->nfsl_open->nfso_fh, mylfhp->nfslfh_fh,
1789 mylfhp->nfslfh_len);
1790 LIST_INIT(&mylfhp->nfslfh_lock);
1791 SLIST_INSERT_HEAD(lhp, mylfhp, nfslfh_list);
1793 LIST_REMOVE(lp, nfsl_list);
1794 LIST_INSERT_HEAD(&mylfhp->nfslfh_lock, lp, nfsl_list);
1797 static int fake_global; /* Used to force visibility of MNTK_UNMOUNTF */
1799 * Called from nfs umount to free up the clientid.
1802 nfscl_umount(struct nfsmount *nmp, NFSPROC_T *p)
1804 struct nfsclclient *clp;
1809 * For the case that matters, this is the thread that set
1810 * MNTK_UNMOUNTF, so it will see it set. The code that follows is
1811 * done to ensure that any thread executing nfscl_getcl() after
1812 * this time, will see MNTK_UNMOUNTF set. nfscl_getcl() uses the
1813 * mutex for NFSLOCKCLSTATE(), so it is "m" for the following
1814 * explanation, courtesy of Alan Cox.
1815 * What follows is a snippet from Alan Cox's email at:
1816 * http://docs.FreeBSD.org/cgi/
1817 * mid.cgi?BANLkTikR3d65zPHo9==08ZfJ2vmqZucEvw
1819 * 1. Set MNTK_UNMOUNTF
1820 * 2. Acquire a standard FreeBSD mutex "m".
1821 * 3. Update some data structures.
1822 * 4. Release mutex "m".
1824 * Then, other threads that acquire "m" after step 4 has occurred will
1825 * see MNTK_UNMOUNTF as set. But, other threads that beat thread X to
1826 * step 2 may or may not see MNTK_UNMOUNTF as set.
1829 if ((nmp->nm_mountp->mnt_kern_flag & MNTK_UNMOUNTF) != 0) {
1837 if ((clp->nfsc_flags & NFSCLFLAGS_INITED) == 0)
1838 panic("nfscl umount");
1841 * First, handshake with the nfscl renew thread, to terminate
1844 clp->nfsc_flags |= NFSCLFLAGS_UMOUNT;
1845 while (clp->nfsc_flags & NFSCLFLAGS_HASTHREAD)
1846 (void)mtx_sleep(clp, NFSCLSTATEMUTEXPTR, PWAIT,
1850 * Now, get the exclusive lock on the client state, so
1851 * that no uses of the state are still in progress.
1854 igotlock = nfsv4_lock(&clp->nfsc_lock, 1, NULL,
1855 NFSCLSTATEMUTEXPTR, NULL);
1856 } while (!igotlock);
1860 * Free up all the state. It will expire on the server, but
1861 * maybe we should do a SetClientId/SetClientIdConfirm so
1862 * the server throws it away?
1864 LIST_REMOVE(clp, nfsc_list);
1865 nfscl_delegreturnall(clp, p);
1866 cred = newnfs_getcred();
1867 if (NFSHASNFSV4N(nmp)) {
1868 (void)nfsrpc_destroysession(nmp, clp, cred, p);
1869 (void)nfsrpc_destroyclient(nmp, clp, cred, p);
1871 (void)nfsrpc_setclient(nmp, clp, 0, cred, p);
1872 nfscl_cleanclient(clp);
1875 free(clp, M_NFSCLCLIENT);
1881 * This function is called when a server replies with NFSERR_STALECLIENTID
1882 * NFSERR_STALESTATEID or NFSERR_BADSESSION. It traverses the clientid lists,
1883 * doing Opens and Locks with reclaim. If these fail, it deletes the
1884 * corresponding state.
1887 nfscl_recover(struct nfsclclient *clp, struct ucred *cred, NFSPROC_T *p)
1889 struct nfsclowner *owp, *nowp;
1890 struct nfsclopen *op, *nop;
1891 struct nfscllockowner *lp, *nlp;
1892 struct nfscllock *lop, *nlop;
1893 struct nfscldeleg *dp, *ndp, *tdp;
1894 struct nfsmount *nmp;
1895 struct ucred *tcred;
1896 struct nfsclopenhead extra_open;
1897 struct nfscldeleghead extra_deleg;
1900 u_int32_t delegtype = NFSV4OPEN_DELEGATEWRITE, mode;
1901 int i, igotlock = 0, error, trycnt, firstlock;
1902 struct nfscllayout *lyp, *nlyp;
1905 * First, lock the client structure, so everyone else will
1906 * block when trying to use state.
1909 clp->nfsc_flags |= NFSCLFLAGS_RECVRINPROG;
1911 igotlock = nfsv4_lock(&clp->nfsc_lock, 1, NULL,
1912 NFSCLSTATEMUTEXPTR, NULL);
1913 } while (!igotlock);
1916 nmp = clp->nfsc_nmp;
1918 panic("nfscl recover");
1921 * For now, just get rid of all layouts. There may be a need
1922 * to do LayoutCommit Ops with reclaim == true later.
1924 TAILQ_FOREACH_SAFE(lyp, &clp->nfsc_layout, nfsly_list, nlyp)
1925 nfscl_freelayout(lyp);
1926 TAILQ_INIT(&clp->nfsc_layout);
1927 for (i = 0; i < NFSCLLAYOUTHASHSIZE; i++)
1928 LIST_INIT(&clp->nfsc_layouthash[i]);
1932 error = nfsrpc_setclient(nmp, clp, 1, cred, p);
1933 } while ((error == NFSERR_STALECLIENTID ||
1934 error == NFSERR_BADSESSION ||
1935 error == NFSERR_STALEDONTRECOVER) && --trycnt > 0);
1937 nfscl_cleanclient(clp);
1939 clp->nfsc_flags &= ~(NFSCLFLAGS_HASCLIENTID |
1940 NFSCLFLAGS_RECOVER | NFSCLFLAGS_RECVRINPROG);
1941 wakeup(&clp->nfsc_flags);
1942 nfsv4_unlock(&clp->nfsc_lock, 0);
1946 clp->nfsc_flags |= NFSCLFLAGS_HASCLIENTID;
1947 clp->nfsc_flags &= ~NFSCLFLAGS_RECOVER;
1950 * Mark requests already queued on the server, so that they don't
1951 * initiate another recovery cycle. Any requests already in the
1952 * queue that handle state information will have the old stale
1953 * clientid/stateid and will get a NFSERR_STALESTATEID,
1954 * NFSERR_STALECLIENTID or NFSERR_BADSESSION reply from the server.
1955 * This will be translated to NFSERR_STALEDONTRECOVER when
1956 * R_DONTRECOVER is set.
1959 TAILQ_FOREACH(rep, &nfsd_reqq, r_chain) {
1960 if (rep->r_nmp == nmp)
1961 rep->r_flags |= R_DONTRECOVER;
1966 * Now, mark all delegations "need reclaim".
1968 TAILQ_FOREACH(dp, &clp->nfsc_deleg, nfsdl_list)
1969 dp->nfsdl_flags |= NFSCLDL_NEEDRECLAIM;
1971 TAILQ_INIT(&extra_deleg);
1972 LIST_INIT(&extra_open);
1974 * Now traverse the state lists, doing Open and Lock Reclaims.
1976 tcred = newnfs_getcred();
1977 owp = LIST_FIRST(&clp->nfsc_owner);
1978 while (owp != NULL) {
1979 nowp = LIST_NEXT(owp, nfsow_list);
1980 owp->nfsow_seqid = 0;
1981 op = LIST_FIRST(&owp->nfsow_open);
1982 while (op != NULL) {
1983 nop = LIST_NEXT(op, nfso_list);
1984 if (error != NFSERR_NOGRACE) {
1985 /* Search for a delegation to reclaim with the open */
1986 TAILQ_FOREACH(dp, &clp->nfsc_deleg, nfsdl_list) {
1987 if (!(dp->nfsdl_flags & NFSCLDL_NEEDRECLAIM))
1989 if ((dp->nfsdl_flags & NFSCLDL_WRITE)) {
1990 mode = NFSV4OPEN_ACCESSWRITE;
1991 delegtype = NFSV4OPEN_DELEGATEWRITE;
1993 mode = NFSV4OPEN_ACCESSREAD;
1994 delegtype = NFSV4OPEN_DELEGATEREAD;
1996 if ((op->nfso_mode & mode) == mode &&
1997 op->nfso_fhlen == dp->nfsdl_fhlen &&
1998 !NFSBCMP(op->nfso_fh, dp->nfsdl_fh, op->nfso_fhlen))
2003 delegtype = NFSV4OPEN_DELEGATENONE;
2004 newnfs_copycred(&op->nfso_cred, tcred);
2005 error = nfscl_tryopen(nmp, NULL, op->nfso_fh,
2006 op->nfso_fhlen, op->nfso_fh, op->nfso_fhlen,
2007 op->nfso_mode, op, NULL, 0, &ndp, 1, delegtype,
2010 /* Handle any replied delegation */
2011 if (ndp != NULL && ((ndp->nfsdl_flags & NFSCLDL_WRITE)
2012 || NFSMNT_RDONLY(nmp->nm_mountp))) {
2013 if ((ndp->nfsdl_flags & NFSCLDL_WRITE))
2014 mode = NFSV4OPEN_ACCESSWRITE;
2016 mode = NFSV4OPEN_ACCESSREAD;
2017 TAILQ_FOREACH(dp, &clp->nfsc_deleg, nfsdl_list) {
2018 if (!(dp->nfsdl_flags & NFSCLDL_NEEDRECLAIM))
2020 if ((op->nfso_mode & mode) == mode &&
2021 op->nfso_fhlen == dp->nfsdl_fhlen &&
2022 !NFSBCMP(op->nfso_fh, dp->nfsdl_fh,
2024 dp->nfsdl_stateid = ndp->nfsdl_stateid;
2025 dp->nfsdl_sizelimit = ndp->nfsdl_sizelimit;
2026 dp->nfsdl_ace = ndp->nfsdl_ace;
2027 dp->nfsdl_change = ndp->nfsdl_change;
2028 dp->nfsdl_flags &= ~NFSCLDL_NEEDRECLAIM;
2029 if ((ndp->nfsdl_flags & NFSCLDL_RECALL))
2030 dp->nfsdl_flags |= NFSCLDL_RECALL;
2031 FREE((caddr_t)ndp, M_NFSCLDELEG);
2038 TAILQ_INSERT_HEAD(&extra_deleg, ndp, nfsdl_list);
2040 /* and reclaim all byte range locks */
2041 lp = LIST_FIRST(&op->nfso_lock);
2042 while (lp != NULL) {
2043 nlp = LIST_NEXT(lp, nfsl_list);
2046 lop = LIST_FIRST(&lp->nfsl_lock);
2047 while (lop != NULL) {
2048 nlop = LIST_NEXT(lop, nfslo_list);
2049 if (lop->nfslo_end == NFS64BITSSET)
2052 len = lop->nfslo_end - lop->nfslo_first;
2053 if (error != NFSERR_NOGRACE)
2054 error = nfscl_trylock(nmp, NULL,
2055 op->nfso_fh, op->nfso_fhlen, lp,
2056 firstlock, 1, lop->nfslo_first, len,
2057 lop->nfslo_type, tcred, p);
2059 nfscl_freelock(lop, 0);
2064 /* If no locks, but a lockowner, just delete it. */
2065 if (LIST_EMPTY(&lp->nfsl_lock))
2066 nfscl_freelockowner(lp, 0);
2070 nfscl_freeopen(op, 0);
2079 * Now, try and get any delegations not yet reclaimed by cobbling
2080 * to-gether an appropriate open.
2083 dp = TAILQ_FIRST(&clp->nfsc_deleg);
2084 while (dp != NULL) {
2085 ndp = TAILQ_NEXT(dp, nfsdl_list);
2086 if ((dp->nfsdl_flags & NFSCLDL_NEEDRECLAIM)) {
2088 MALLOC(nowp, struct nfsclowner *,
2089 sizeof (struct nfsclowner), M_NFSCLOWNER, M_WAITOK);
2091 * Name must be as long an largest possible
2092 * NFSV4CL_LOCKNAMELEN. 12 for now.
2094 NFSBCOPY("RECLAIMDELEG", nowp->nfsow_owner,
2095 NFSV4CL_LOCKNAMELEN);
2096 LIST_INIT(&nowp->nfsow_open);
2097 nowp->nfsow_clp = clp;
2098 nowp->nfsow_seqid = 0;
2099 nowp->nfsow_defunct = 0;
2100 nfscl_lockinit(&nowp->nfsow_rwlock);
2103 if (error != NFSERR_NOGRACE) {
2104 MALLOC(nop, struct nfsclopen *, sizeof (struct nfsclopen) +
2105 dp->nfsdl_fhlen - 1, M_NFSCLOPEN, M_WAITOK);
2106 nop->nfso_own = nowp;
2107 if ((dp->nfsdl_flags & NFSCLDL_WRITE)) {
2108 nop->nfso_mode = NFSV4OPEN_ACCESSWRITE;
2109 delegtype = NFSV4OPEN_DELEGATEWRITE;
2111 nop->nfso_mode = NFSV4OPEN_ACCESSREAD;
2112 delegtype = NFSV4OPEN_DELEGATEREAD;
2114 nop->nfso_opencnt = 0;
2115 nop->nfso_posixlock = 1;
2116 nop->nfso_fhlen = dp->nfsdl_fhlen;
2117 NFSBCOPY(dp->nfsdl_fh, nop->nfso_fh, dp->nfsdl_fhlen);
2118 LIST_INIT(&nop->nfso_lock);
2119 nop->nfso_stateid.seqid = 0;
2120 nop->nfso_stateid.other[0] = 0;
2121 nop->nfso_stateid.other[1] = 0;
2122 nop->nfso_stateid.other[2] = 0;
2123 newnfs_copycred(&dp->nfsdl_cred, tcred);
2124 newnfs_copyincred(tcred, &nop->nfso_cred);
2126 error = nfscl_tryopen(nmp, NULL, nop->nfso_fh,
2127 nop->nfso_fhlen, nop->nfso_fh, nop->nfso_fhlen,
2128 nop->nfso_mode, nop, NULL, 0, &tdp, 1,
2129 delegtype, tcred, p);
2131 if ((tdp->nfsdl_flags & NFSCLDL_WRITE))
2132 mode = NFSV4OPEN_ACCESSWRITE;
2134 mode = NFSV4OPEN_ACCESSREAD;
2135 if ((nop->nfso_mode & mode) == mode &&
2136 nop->nfso_fhlen == tdp->nfsdl_fhlen &&
2137 !NFSBCMP(nop->nfso_fh, tdp->nfsdl_fh,
2139 dp->nfsdl_stateid = tdp->nfsdl_stateid;
2140 dp->nfsdl_sizelimit = tdp->nfsdl_sizelimit;
2141 dp->nfsdl_ace = tdp->nfsdl_ace;
2142 dp->nfsdl_change = tdp->nfsdl_change;
2143 dp->nfsdl_flags &= ~NFSCLDL_NEEDRECLAIM;
2144 if ((tdp->nfsdl_flags & NFSCLDL_RECALL))
2145 dp->nfsdl_flags |= NFSCLDL_RECALL;
2146 FREE((caddr_t)tdp, M_NFSCLDELEG);
2148 TAILQ_INSERT_HEAD(&extra_deleg, tdp, nfsdl_list);
2154 FREE((caddr_t)nop, M_NFSCLOPEN);
2156 * Couldn't reclaim it, so throw the state
2159 nfscl_cleandeleg(dp);
2160 nfscl_freedeleg(&clp->nfsc_deleg, dp);
2162 LIST_INSERT_HEAD(&extra_open, nop, nfso_list);
2169 * Now, get rid of extra Opens and Delegations.
2171 LIST_FOREACH_SAFE(op, &extra_open, nfso_list, nop) {
2173 newnfs_copycred(&op->nfso_cred, tcred);
2174 error = nfscl_tryclose(op, tcred, nmp, p);
2175 if (error == NFSERR_GRACE)
2176 (void) nfs_catnap(PZERO, error, "nfsexcls");
2177 } while (error == NFSERR_GRACE);
2178 LIST_REMOVE(op, nfso_list);
2179 FREE((caddr_t)op, M_NFSCLOPEN);
2182 FREE((caddr_t)nowp, M_NFSCLOWNER);
2184 TAILQ_FOREACH_SAFE(dp, &extra_deleg, nfsdl_list, ndp) {
2186 newnfs_copycred(&dp->nfsdl_cred, tcred);
2187 error = nfscl_trydelegreturn(dp, tcred, nmp, p);
2188 if (error == NFSERR_GRACE)
2189 (void) nfs_catnap(PZERO, error, "nfsexdlg");
2190 } while (error == NFSERR_GRACE);
2191 TAILQ_REMOVE(&extra_deleg, dp, nfsdl_list);
2192 FREE((caddr_t)dp, M_NFSCLDELEG);
2195 /* For NFSv4.1 or later, do a RECLAIM_COMPLETE. */
2196 if (NFSHASNFSV4N(nmp))
2197 (void)nfsrpc_reclaimcomplete(nmp, cred, p);
2200 clp->nfsc_flags &= ~NFSCLFLAGS_RECVRINPROG;
2201 wakeup(&clp->nfsc_flags);
2202 nfsv4_unlock(&clp->nfsc_lock, 0);
2208 * This function is called when a server replies with NFSERR_EXPIRED.
2209 * It deletes all state for the client and does a fresh SetClientId/confirm.
2210 * XXX Someday it should post a signal to the process(es) that hold the
2211 * state, so they know that lock state has been lost.
2214 nfscl_hasexpired(struct nfsclclient *clp, u_int32_t clidrev, NFSPROC_T *p)
2216 struct nfsmount *nmp;
2218 int igotlock = 0, error, trycnt;
2221 * If the clientid has gone away or a new SetClientid has already
2222 * been done, just return ok.
2224 if (clp == NULL || clidrev != clp->nfsc_clientidrev)
2228 * First, lock the client structure, so everyone else will
2229 * block when trying to use state. Also, use NFSCLFLAGS_EXPIREIT so
2230 * that only one thread does the work.
2233 clp->nfsc_flags |= NFSCLFLAGS_EXPIREIT;
2235 igotlock = nfsv4_lock(&clp->nfsc_lock, 1, NULL,
2236 NFSCLSTATEMUTEXPTR, NULL);
2237 } while (!igotlock && (clp->nfsc_flags & NFSCLFLAGS_EXPIREIT));
2238 if ((clp->nfsc_flags & NFSCLFLAGS_EXPIREIT) == 0) {
2240 nfsv4_unlock(&clp->nfsc_lock, 0);
2244 clp->nfsc_flags |= NFSCLFLAGS_RECVRINPROG;
2247 nmp = clp->nfsc_nmp;
2249 panic("nfscl expired");
2250 cred = newnfs_getcred();
2253 error = nfsrpc_setclient(nmp, clp, 0, cred, p);
2254 } while ((error == NFSERR_STALECLIENTID ||
2255 error == NFSERR_BADSESSION ||
2256 error == NFSERR_STALEDONTRECOVER) && --trycnt > 0);
2259 * Clear out any state.
2261 nfscl_cleanclient(clp);
2263 clp->nfsc_flags &= ~(NFSCLFLAGS_HASCLIENTID |
2264 NFSCLFLAGS_RECOVER);
2267 * Expire the state for the client.
2269 nfscl_expireclient(clp, nmp, cred, p);
2271 clp->nfsc_flags |= NFSCLFLAGS_HASCLIENTID;
2272 clp->nfsc_flags &= ~NFSCLFLAGS_RECOVER;
2274 clp->nfsc_flags &= ~(NFSCLFLAGS_EXPIREIT | NFSCLFLAGS_RECVRINPROG);
2275 wakeup(&clp->nfsc_flags);
2276 nfsv4_unlock(&clp->nfsc_lock, 0);
2283 * This function inserts a lock in the list after insert_lop.
2286 nfscl_insertlock(struct nfscllockowner *lp, struct nfscllock *new_lop,
2287 struct nfscllock *insert_lop, int local)
2290 if ((struct nfscllockowner *)insert_lop == lp)
2291 LIST_INSERT_HEAD(&lp->nfsl_lock, new_lop, nfslo_list);
2293 LIST_INSERT_AFTER(insert_lop, new_lop, nfslo_list);
2295 newnfsstats.cllocallocks++;
2297 newnfsstats.cllocks++;
2301 * This function updates the locking for a lock owner and given file. It
2302 * maintains a list of lock ranges ordered on increasing file offset that
2303 * are NFSCLLOCK_READ or NFSCLLOCK_WRITE and non-overlapping (aka POSIX style).
2304 * It always adds new_lop to the list and sometimes uses the one pointed
2306 * Returns 1 if the locks were modified, 0 otherwise.
2309 nfscl_updatelock(struct nfscllockowner *lp, struct nfscllock **new_lopp,
2310 struct nfscllock **other_lopp, int local)
2312 struct nfscllock *new_lop = *new_lopp;
2313 struct nfscllock *lop, *tlop, *ilop;
2314 struct nfscllock *other_lop;
2315 int unlock = 0, modified = 0;
2319 * Work down the list until the lock is merged.
2321 if (new_lop->nfslo_type == F_UNLCK)
2323 ilop = (struct nfscllock *)lp;
2324 lop = LIST_FIRST(&lp->nfsl_lock);
2325 while (lop != NULL) {
2327 * Only check locks for this file that aren't before the start of
2330 if (lop->nfslo_end >= new_lop->nfslo_first) {
2331 if (new_lop->nfslo_end < lop->nfslo_first) {
2333 * If the new lock ends before the start of the
2334 * current lock's range, no merge, just insert
2339 if (new_lop->nfslo_type == lop->nfslo_type ||
2340 (new_lop->nfslo_first <= lop->nfslo_first &&
2341 new_lop->nfslo_end >= lop->nfslo_end)) {
2343 * This lock can be absorbed by the new lock/unlock.
2344 * This happens when it covers the entire range
2345 * of the old lock or is contiguous
2346 * with the old lock and is of the same type or an
2349 if (new_lop->nfslo_type != lop->nfslo_type ||
2350 new_lop->nfslo_first != lop->nfslo_first ||
2351 new_lop->nfslo_end != lop->nfslo_end)
2353 if (lop->nfslo_first < new_lop->nfslo_first)
2354 new_lop->nfslo_first = lop->nfslo_first;
2355 if (lop->nfslo_end > new_lop->nfslo_end)
2356 new_lop->nfslo_end = lop->nfslo_end;
2358 lop = LIST_NEXT(lop, nfslo_list);
2359 nfscl_freelock(tlop, local);
2364 * All these cases are for contiguous locks that are not the
2365 * same type, so they can't be merged.
2367 if (new_lop->nfslo_first <= lop->nfslo_first) {
2369 * This case is where the new lock overlaps with the
2370 * first part of the old lock. Move the start of the
2371 * old lock to just past the end of the new lock. The
2372 * new lock will be inserted in front of the old, since
2373 * ilop hasn't been updated. (We are done now.)
2375 if (lop->nfslo_first != new_lop->nfslo_end) {
2376 lop->nfslo_first = new_lop->nfslo_end;
2381 if (new_lop->nfslo_end >= lop->nfslo_end) {
2383 * This case is where the new lock overlaps with the
2384 * end of the old lock's range. Move the old lock's
2385 * end to just before the new lock's first and insert
2386 * the new lock after the old lock.
2387 * Might not be done yet, since the new lock could
2388 * overlap further locks with higher ranges.
2390 if (lop->nfslo_end != new_lop->nfslo_first) {
2391 lop->nfslo_end = new_lop->nfslo_first;
2395 lop = LIST_NEXT(lop, nfslo_list);
2399 * The final case is where the new lock's range is in the
2400 * middle of the current lock's and splits the current lock
2401 * up. Use *other_lopp to handle the second part of the
2402 * split old lock range. (We are done now.)
2403 * For unlock, we use new_lop as other_lop and tmp, since
2404 * other_lop and new_lop are the same for this case.
2405 * We noted the unlock case above, so we don't need
2406 * new_lop->nfslo_type any longer.
2408 tmp = new_lop->nfslo_first;
2410 other_lop = new_lop;
2413 other_lop = *other_lopp;
2416 other_lop->nfslo_first = new_lop->nfslo_end;
2417 other_lop->nfslo_end = lop->nfslo_end;
2418 other_lop->nfslo_type = lop->nfslo_type;
2419 lop->nfslo_end = tmp;
2420 nfscl_insertlock(lp, other_lop, lop, local);
2426 lop = LIST_NEXT(lop, nfslo_list);
2432 * Insert the new lock in the list at the appropriate place.
2435 nfscl_insertlock(lp, new_lop, ilop, local);
2443 * This function must be run as a kernel thread.
2444 * It does Renew Ops and recovery, when required.
2447 nfscl_renewthread(struct nfsclclient *clp, NFSPROC_T *p)
2449 struct nfsclowner *owp, *nowp;
2450 struct nfsclopen *op;
2451 struct nfscllockowner *lp, *nlp;
2452 struct nfscldeleghead dh;
2453 struct nfscldeleg *dp, *ndp;
2456 int error, cbpathdown, islept, igotlock, ret, clearok;
2457 uint32_t recover_done_time = 0;
2459 static time_t prevsec = 0;
2460 struct nfscllockownerfh *lfhp, *nlfhp;
2461 struct nfscllockownerfhhead lfh;
2462 struct nfscllayout *lyp, *nlyp;
2463 struct nfscldevinfo *dip, *ndip;
2464 struct nfscllayouthead rlh;
2465 struct nfsclrecalllayout *recallp;
2466 struct nfsclds *dsp;
2468 cred = newnfs_getcred();
2470 clp->nfsc_flags |= NFSCLFLAGS_HASTHREAD;
2473 newnfs_setroot(cred);
2475 if (clp->nfsc_flags & NFSCLFLAGS_RECOVER) {
2477 * Only allow one recover within 1/2 of the lease
2478 * duration (nfsc_renew).
2480 if (recover_done_time < NFSD_MONOSEC) {
2481 recover_done_time = NFSD_MONOSEC +
2483 NFSCL_DEBUG(1, "Doing recovery..\n");
2484 nfscl_recover(clp, cred, p);
2486 NFSCL_DEBUG(1, "Clear Recovery dt=%u ms=%jd\n",
2487 recover_done_time, (intmax_t)NFSD_MONOSEC);
2489 clp->nfsc_flags &= ~NFSCLFLAGS_RECOVER;
2493 if (clp->nfsc_expire <= NFSD_MONOSEC &&
2494 (clp->nfsc_flags & NFSCLFLAGS_HASCLIENTID)) {
2495 clp->nfsc_expire = NFSD_MONOSEC + clp->nfsc_renew;
2496 clidrev = clp->nfsc_clientidrev;
2497 error = nfsrpc_renew(clp, NULL, cred, p);
2498 if (error == NFSERR_CBPATHDOWN)
2500 else if (error == NFSERR_STALECLIENTID ||
2501 error == NFSERR_BADSESSION) {
2503 clp->nfsc_flags |= NFSCLFLAGS_RECOVER;
2505 } else if (error == NFSERR_EXPIRED)
2506 (void) nfscl_hasexpired(clp, clidrev, p);
2510 if (NFSHASNFSV4N(clp->nfsc_nmp)) {
2511 /* Do renews for any DS sessions. */
2512 NFSLOCKMNT(clp->nfsc_nmp);
2513 /* Skip first entry, since the MDS is handled above. */
2514 dsp = TAILQ_FIRST(&clp->nfsc_nmp->nm_sess);
2516 dsp = TAILQ_NEXT(dsp, nfsclds_list);
2517 while (dsp != NULL) {
2518 if (dsp->nfsclds_expire <= NFSD_MONOSEC &&
2519 dsp->nfsclds_sess.nfsess_defunct == 0) {
2520 dsp->nfsclds_expire = NFSD_MONOSEC +
2522 NFSUNLOCKMNT(clp->nfsc_nmp);
2523 (void)nfsrpc_renew(clp, dsp, cred, p);
2526 dsp = TAILQ_NEXT(dsp, nfsclds_list);
2528 NFSUNLOCKMNT(clp->nfsc_nmp);
2534 /* It's a Total Recall! */
2535 nfscl_totalrecall(clp);
2538 * Now, handle defunct owners.
2540 LIST_FOREACH_SAFE(owp, &clp->nfsc_owner, nfsow_list, nowp) {
2541 if (LIST_EMPTY(&owp->nfsow_open)) {
2542 if (owp->nfsow_defunct != 0)
2543 nfscl_freeopenowner(owp, 0);
2548 * Do the recall on any delegations. To avoid trouble, always
2549 * come back up here after having slept.
2553 dp = TAILQ_FIRST(&clp->nfsc_deleg);
2554 while (dp != NULL) {
2555 ndp = TAILQ_NEXT(dp, nfsdl_list);
2556 if ((dp->nfsdl_flags & NFSCLDL_RECALL)) {
2558 * Wait for outstanding I/O ops to be done.
2560 if (dp->nfsdl_rwlock.nfslock_usecnt > 0) {
2562 nfsv4_unlock(&clp->nfsc_lock, 0);
2565 dp->nfsdl_rwlock.nfslock_lock |=
2567 (void) nfsmsleep(&dp->nfsdl_rwlock,
2568 NFSCLSTATEMUTEXPTR, PZERO, "nfscld",
2573 igotlock = nfsv4_lock(&clp->nfsc_lock, 1,
2574 &islept, NFSCLSTATEMUTEXPTR, NULL);
2579 newnfs_copycred(&dp->nfsdl_cred, cred);
2580 ret = nfscl_recalldeleg(clp, clp->nfsc_nmp, dp,
2583 nfscl_cleandeleg(dp);
2584 TAILQ_REMOVE(&clp->nfsc_deleg, dp,
2586 LIST_REMOVE(dp, nfsdl_hash);
2587 TAILQ_INSERT_HEAD(&dh, dp, nfsdl_list);
2589 newnfsstats.cldelegates--;
2597 * Clear out old delegations, if we are above the high water
2598 * mark. Only clear out ones with no state related to them.
2599 * The tailq list is in LRU order.
2601 dp = TAILQ_LAST(&clp->nfsc_deleg, nfscldeleghead);
2602 while (nfscl_delegcnt > nfscl_deleghighwater && dp != NULL) {
2603 ndp = TAILQ_PREV(dp, nfscldeleghead, nfsdl_list);
2604 if (dp->nfsdl_rwlock.nfslock_usecnt == 0 &&
2605 dp->nfsdl_rwlock.nfslock_lock == 0 &&
2606 dp->nfsdl_timestamp < NFSD_MONOSEC &&
2607 (dp->nfsdl_flags & (NFSCLDL_RECALL | NFSCLDL_ZAPPED |
2608 NFSCLDL_NEEDRECLAIM | NFSCLDL_DELEGRET)) == 0) {
2610 LIST_FOREACH(owp, &dp->nfsdl_owner, nfsow_list) {
2611 op = LIST_FIRST(&owp->nfsow_open);
2618 LIST_FOREACH(lp, &dp->nfsdl_lock, nfsl_list) {
2619 if (!LIST_EMPTY(&lp->nfsl_lock)) {
2626 TAILQ_REMOVE(&clp->nfsc_deleg, dp, nfsdl_list);
2627 LIST_REMOVE(dp, nfsdl_hash);
2628 TAILQ_INSERT_HEAD(&dh, dp, nfsdl_list);
2630 newnfsstats.cldelegates--;
2636 nfsv4_unlock(&clp->nfsc_lock, 0);
2639 * Do the recall on any layouts. To avoid trouble, always
2640 * come back up here after having slept.
2644 TAILQ_FOREACH_SAFE(lyp, &clp->nfsc_layout, nfsly_list, nlyp) {
2645 if ((lyp->nfsly_flags & NFSLY_RECALL) != 0) {
2647 * Wait for outstanding I/O ops to be done.
2649 if (lyp->nfsly_lock.nfslock_usecnt > 0 ||
2650 (lyp->nfsly_lock.nfslock_lock &
2651 NFSV4LOCK_LOCK) != 0) {
2652 lyp->nfsly_lock.nfslock_lock |=
2654 (void)nfsmsleep(&lyp->nfsly_lock,
2655 NFSCLSTATEMUTEXPTR, PZERO, "nfslyp",
2659 /* Move the layout to the recall list. */
2660 TAILQ_REMOVE(&clp->nfsc_layout, lyp,
2662 LIST_REMOVE(lyp, nfsly_hash);
2663 TAILQ_INSERT_HEAD(&rlh, lyp, nfsly_list);
2665 /* Handle any layout commits. */
2666 if (!NFSHASNOLAYOUTCOMMIT(clp->nfsc_nmp) &&
2667 (lyp->nfsly_flags & NFSLY_WRITTEN) != 0) {
2668 lyp->nfsly_flags &= ~NFSLY_WRITTEN;
2670 NFSCL_DEBUG(3, "do layoutcommit\n");
2671 nfscl_dolayoutcommit(clp->nfsc_nmp, lyp,
2679 /* Now, look for stale layouts. */
2680 lyp = TAILQ_LAST(&clp->nfsc_layout, nfscllayouthead);
2681 while (lyp != NULL) {
2682 nlyp = TAILQ_PREV(lyp, nfscllayouthead, nfsly_list);
2683 if (lyp->nfsly_timestamp < NFSD_MONOSEC &&
2684 (lyp->nfsly_flags & NFSLY_RECALL) == 0 &&
2685 lyp->nfsly_lock.nfslock_usecnt == 0 &&
2686 lyp->nfsly_lock.nfslock_lock == 0) {
2687 NFSCL_DEBUG(4, "ret stale lay=%d\n",
2689 recallp = malloc(sizeof(*recallp),
2690 M_NFSLAYRECALL, M_NOWAIT);
2691 if (recallp == NULL)
2693 (void)nfscl_layoutrecall(NFSLAYOUTRETURN_FILE,
2694 lyp, NFSLAYOUTIOMODE_ANY, 0, UINT64_MAX,
2695 lyp->nfsly_stateid.seqid, recallp);
2701 * Free up any unreferenced device info structures.
2703 LIST_FOREACH_SAFE(dip, &clp->nfsc_devinfo, nfsdi_list, ndip) {
2704 if (dip->nfsdi_layoutrefs == 0 &&
2705 dip->nfsdi_refcnt == 0) {
2706 NFSCL_DEBUG(4, "freeing devinfo\n");
2707 LIST_REMOVE(dip, nfsdi_list);
2708 nfscl_freedevinfo(dip);
2713 /* Do layout return(s), as required. */
2714 TAILQ_FOREACH_SAFE(lyp, &rlh, nfsly_list, nlyp) {
2715 TAILQ_REMOVE(&rlh, lyp, nfsly_list);
2716 NFSCL_DEBUG(4, "ret layout\n");
2717 nfscl_layoutreturn(clp->nfsc_nmp, lyp, cred, p);
2718 nfscl_freelayout(lyp);
2722 * Delegreturn any delegations cleaned out or recalled.
2724 TAILQ_FOREACH_SAFE(dp, &dh, nfsdl_list, ndp) {
2725 newnfs_copycred(&dp->nfsdl_cred, cred);
2726 (void) nfscl_trydelegreturn(dp, cred, clp->nfsc_nmp, p);
2727 TAILQ_REMOVE(&dh, dp, nfsdl_list);
2728 FREE((caddr_t)dp, M_NFSCLDELEG);
2733 * Call nfscl_cleanupkext() once per second to check for
2734 * open/lock owners where the process has exited.
2736 mytime = NFSD_MONOSEC;
2737 if (prevsec != mytime) {
2739 nfscl_cleanupkext(clp, &lfh);
2743 * Do a ReleaseLockOwner for all lock owners where the
2744 * associated process no longer exists, as found by
2745 * nfscl_cleanupkext().
2747 newnfs_setroot(cred);
2748 SLIST_FOREACH_SAFE(lfhp, &lfh, nfslfh_list, nlfhp) {
2749 LIST_FOREACH_SAFE(lp, &lfhp->nfslfh_lock, nfsl_list,
2751 (void)nfsrpc_rellockown(clp->nfsc_nmp, lp,
2752 lfhp->nfslfh_fh, lfhp->nfslfh_len, cred,
2754 nfscl_freelockowner(lp, 0);
2761 if ((clp->nfsc_flags & NFSCLFLAGS_RECOVER) == 0)
2762 (void)mtx_sleep(clp, NFSCLSTATEMUTEXPTR, PWAIT, "nfscl",
2764 if (clp->nfsc_flags & NFSCLFLAGS_UMOUNT) {
2765 clp->nfsc_flags &= ~NFSCLFLAGS_HASTHREAD;
2768 wakeup((caddr_t)clp);
2776 * Initiate state recovery. Called when NFSERR_STALECLIENTID,
2777 * NFSERR_STALESTATEID or NFSERR_BADSESSION is received.
2780 nfscl_initiate_recovery(struct nfsclclient *clp)
2786 clp->nfsc_flags |= NFSCLFLAGS_RECOVER;
2788 wakeup((caddr_t)clp);
2792 * Dump out the state stuff for debugging.
2795 nfscl_dumpstate(struct nfsmount *nmp, int openowner, int opens,
2796 int lockowner, int locks)
2798 struct nfsclclient *clp;
2799 struct nfsclowner *owp;
2800 struct nfsclopen *op;
2801 struct nfscllockowner *lp;
2802 struct nfscllock *lop;
2803 struct nfscldeleg *dp;
2807 printf("nfscl dumpstate NULL clp\n");
2811 TAILQ_FOREACH(dp, &clp->nfsc_deleg, nfsdl_list) {
2812 LIST_FOREACH(owp, &dp->nfsdl_owner, nfsow_list) {
2813 if (openowner && !LIST_EMPTY(&owp->nfsow_open))
2814 printf("owner=0x%x 0x%x 0x%x 0x%x seqid=%d\n",
2815 owp->nfsow_owner[0], owp->nfsow_owner[1],
2816 owp->nfsow_owner[2], owp->nfsow_owner[3],
2818 LIST_FOREACH(op, &owp->nfsow_open, nfso_list) {
2820 printf("open st=0x%x 0x%x 0x%x cnt=%d fh12=0x%x\n",
2821 op->nfso_stateid.other[0], op->nfso_stateid.other[1],
2822 op->nfso_stateid.other[2], op->nfso_opencnt,
2824 LIST_FOREACH(lp, &op->nfso_lock, nfsl_list) {
2826 printf("lckown=0x%x 0x%x 0x%x 0x%x seqid=%d st=0x%x 0x%x 0x%x\n",
2827 lp->nfsl_owner[0], lp->nfsl_owner[1],
2828 lp->nfsl_owner[2], lp->nfsl_owner[3],
2830 lp->nfsl_stateid.other[0], lp->nfsl_stateid.other[1],
2831 lp->nfsl_stateid.other[2]);
2832 LIST_FOREACH(lop, &lp->nfsl_lock, nfslo_list) {
2835 printf("lck typ=%d fst=%ju end=%ju\n",
2836 lop->nfslo_type, (intmax_t)lop->nfslo_first,
2837 (intmax_t)lop->nfslo_end);
2839 printf("lck typ=%d fst=%qd end=%qd\n",
2840 lop->nfslo_type, lop->nfslo_first,
2848 LIST_FOREACH(owp, &clp->nfsc_owner, nfsow_list) {
2849 if (openowner && !LIST_EMPTY(&owp->nfsow_open))
2850 printf("owner=0x%x 0x%x 0x%x 0x%x seqid=%d\n",
2851 owp->nfsow_owner[0], owp->nfsow_owner[1],
2852 owp->nfsow_owner[2], owp->nfsow_owner[3],
2854 LIST_FOREACH(op, &owp->nfsow_open, nfso_list) {
2856 printf("open st=0x%x 0x%x 0x%x cnt=%d fh12=0x%x\n",
2857 op->nfso_stateid.other[0], op->nfso_stateid.other[1],
2858 op->nfso_stateid.other[2], op->nfso_opencnt,
2860 LIST_FOREACH(lp, &op->nfso_lock, nfsl_list) {
2862 printf("lckown=0x%x 0x%x 0x%x 0x%x seqid=%d st=0x%x 0x%x 0x%x\n",
2863 lp->nfsl_owner[0], lp->nfsl_owner[1],
2864 lp->nfsl_owner[2], lp->nfsl_owner[3],
2866 lp->nfsl_stateid.other[0], lp->nfsl_stateid.other[1],
2867 lp->nfsl_stateid.other[2]);
2868 LIST_FOREACH(lop, &lp->nfsl_lock, nfslo_list) {
2871 printf("lck typ=%d fst=%ju end=%ju\n",
2872 lop->nfslo_type, (intmax_t)lop->nfslo_first,
2873 (intmax_t)lop->nfslo_end);
2875 printf("lck typ=%d fst=%qd end=%qd\n",
2876 lop->nfslo_type, lop->nfslo_first,
2887 * Check for duplicate open owners and opens.
2888 * (Only used as a diagnostic aid.)
2891 nfscl_dupopen(vnode_t vp, int dupopens)
2893 struct nfsclclient *clp;
2894 struct nfsclowner *owp, *owp2;
2895 struct nfsclopen *op, *op2;
2898 clp = VFSTONFS(vnode_mount(vp))->nm_clp;
2900 printf("nfscl dupopen NULL clp\n");
2903 nfhp = VTONFS(vp)->n_fhp;
2907 * First, search for duplicate owners.
2908 * These should never happen!
2910 LIST_FOREACH(owp2, &clp->nfsc_owner, nfsow_list) {
2911 LIST_FOREACH(owp, &clp->nfsc_owner, nfsow_list) {
2913 !NFSBCMP(owp->nfsow_owner, owp2->nfsow_owner,
2914 NFSV4CL_LOCKNAMELEN)) {
2916 printf("DUP OWNER\n");
2917 nfscl_dumpstate(VFSTONFS(vnode_mount(vp)), 1, 1, 0, 0);
2924 * Now, search for duplicate stateids.
2925 * These shouldn't happen, either.
2927 LIST_FOREACH(owp2, &clp->nfsc_owner, nfsow_list) {
2928 LIST_FOREACH(op2, &owp2->nfsow_open, nfso_list) {
2929 LIST_FOREACH(owp, &clp->nfsc_owner, nfsow_list) {
2930 LIST_FOREACH(op, &owp->nfsow_open, nfso_list) {
2932 (op->nfso_stateid.other[0] != 0 ||
2933 op->nfso_stateid.other[1] != 0 ||
2934 op->nfso_stateid.other[2] != 0) &&
2935 op->nfso_stateid.other[0] == op2->nfso_stateid.other[0] &&
2936 op->nfso_stateid.other[1] == op2->nfso_stateid.other[1] &&
2937 op->nfso_stateid.other[2] == op2->nfso_stateid.other[2]) {
2939 printf("DUP STATEID\n");
2940 nfscl_dumpstate(VFSTONFS(vnode_mount(vp)), 1, 1, 0,
2950 * Now search for duplicate opens.
2951 * Duplicate opens for the same owner
2952 * should never occur. Other duplicates are
2953 * possible and are checked for if "dupopens"
2956 LIST_FOREACH(owp2, &clp->nfsc_owner, nfsow_list) {
2957 LIST_FOREACH(op2, &owp2->nfsow_open, nfso_list) {
2958 if (nfhp->nfh_len == op2->nfso_fhlen &&
2959 !NFSBCMP(nfhp->nfh_fh, op2->nfso_fh, nfhp->nfh_len)) {
2960 LIST_FOREACH(owp, &clp->nfsc_owner, nfsow_list) {
2961 LIST_FOREACH(op, &owp->nfsow_open, nfso_list) {
2962 if (op != op2 && nfhp->nfh_len == op->nfso_fhlen &&
2963 !NFSBCMP(nfhp->nfh_fh, op->nfso_fh, nfhp->nfh_len) &&
2964 (!NFSBCMP(op->nfso_own->nfsow_owner,
2965 op2->nfso_own->nfsow_owner, NFSV4CL_LOCKNAMELEN) ||
2967 if (!NFSBCMP(op->nfso_own->nfsow_owner,
2968 op2->nfso_own->nfsow_owner, NFSV4CL_LOCKNAMELEN)) {
2970 printf("BADDUP OPEN\n");
2973 printf("DUP OPEN\n");
2975 nfscl_dumpstate(VFSTONFS(vnode_mount(vp)), 1, 1,
2988 * During close, find an open that needs to be dereferenced and
2989 * dereference it. If there are no more opens for this file,
2990 * log a message to that effect.
2991 * Opens aren't actually Close'd until VOP_INACTIVE() is performed
2992 * on the file's vnode.
2993 * This is the safe way, since it is difficult to identify
2994 * which open the close is for and I/O can be performed after the
2995 * close(2) system call when a file is mmap'd.
2996 * If it returns 0 for success, there will be a referenced
2997 * clp returned via clpp.
3000 nfscl_getclose(vnode_t vp, struct nfsclclient **clpp)
3002 struct nfsclclient *clp;
3003 struct nfsclowner *owp;
3004 struct nfsclopen *op;
3005 struct nfscldeleg *dp;
3009 error = nfscl_getcl(vnode_mount(vp), NULL, NULL, 1, &clp);
3014 nfhp = VTONFS(vp)->n_fhp;
3018 * First, look for one under a delegation that was locally issued
3019 * and just decrement the opencnt for it. Since all my Opens against
3020 * the server are DENY_NONE, I don't see a problem with hanging
3021 * onto them. (It is much easier to use one of the extant Opens
3022 * that I already have on the server when a Delegation is recalled
3023 * than to do fresh Opens.) Someday, I might need to rethink this, but.
3025 dp = nfscl_finddeleg(clp, nfhp->nfh_fh, nfhp->nfh_len);
3027 LIST_FOREACH(owp, &dp->nfsdl_owner, nfsow_list) {
3028 op = LIST_FIRST(&owp->nfsow_open);
3031 * Since a delegation is for a file, there
3032 * should never be more than one open for
3035 if (LIST_NEXT(op, nfso_list) != NULL)
3036 panic("nfscdeleg opens");
3037 if (notdecr && op->nfso_opencnt > 0) {
3046 /* Now process the opens against the server. */
3047 LIST_FOREACH(owp, &clp->nfsc_owner, nfsow_list) {
3048 LIST_FOREACH(op, &owp->nfsow_open, nfso_list) {
3049 if (op->nfso_fhlen == nfhp->nfh_len &&
3050 !NFSBCMP(op->nfso_fh, nfhp->nfh_fh,
3052 /* Found an open, decrement cnt if possible */
3053 if (notdecr && op->nfso_opencnt > 0) {
3058 * There are more opens, so just return.
3060 if (op->nfso_opencnt > 0) {
3069 printf("nfscl: never fnd open\n");
3074 nfscl_doclose(vnode_t vp, struct nfsclclient **clpp, NFSPROC_T *p)
3076 struct nfsclclient *clp;
3077 struct nfsclowner *owp, *nowp;
3078 struct nfsclopen *op;
3079 struct nfscldeleg *dp;
3083 error = nfscl_getcl(vnode_mount(vp), NULL, NULL, 1, &clp);
3088 nfhp = VTONFS(vp)->n_fhp;
3091 * First get rid of the local Open structures, which should be no
3094 dp = nfscl_finddeleg(clp, nfhp->nfh_fh, nfhp->nfh_len);
3096 LIST_FOREACH_SAFE(owp, &dp->nfsdl_owner, nfsow_list, nowp) {
3097 op = LIST_FIRST(&owp->nfsow_open);
3099 KASSERT((op->nfso_opencnt == 0),
3100 ("nfscl: bad open cnt on deleg"));
3101 nfscl_freeopen(op, 1);
3103 nfscl_freeopenowner(owp, 1);
3107 /* Return any layouts marked return on close. */
3108 nfscl_retoncloselayout(clp, nfhp->nfh_fh, nfhp->nfh_len);
3110 /* Now process the opens against the server. */
3112 LIST_FOREACH(owp, &clp->nfsc_owner, nfsow_list) {
3113 op = LIST_FIRST(&owp->nfsow_open);
3114 while (op != NULL) {
3115 if (op->nfso_fhlen == nfhp->nfh_len &&
3116 !NFSBCMP(op->nfso_fh, nfhp->nfh_fh,
3118 /* Found an open, close it. */
3119 KASSERT((op->nfso_opencnt == 0),
3120 ("nfscl: bad open cnt on server"));
3122 nfsrpc_doclose(VFSTONFS(vnode_mount(vp)), op,
3127 op = LIST_NEXT(op, nfso_list);
3135 * Return all delegations on this client.
3136 * (Must be called with client sleep lock.)
3139 nfscl_delegreturnall(struct nfsclclient *clp, NFSPROC_T *p)
3141 struct nfscldeleg *dp, *ndp;
3144 cred = newnfs_getcred();
3145 TAILQ_FOREACH_SAFE(dp, &clp->nfsc_deleg, nfsdl_list, ndp) {
3146 nfscl_cleandeleg(dp);
3147 (void) nfscl_trydelegreturn(dp, cred, clp->nfsc_nmp, p);
3148 nfscl_freedeleg(&clp->nfsc_deleg, dp);
3154 * Do a callback RPC.
3157 nfscl_docb(struct nfsrv_descript *nd, NFSPROC_T *p)
3159 int clist, gotseq_ok, i, j, k, op, rcalls;
3161 struct nfsclclient *clp;
3162 struct nfscldeleg *dp = NULL;
3163 int numops, taglen = -1, error = 0, trunc;
3164 u_int32_t minorvers = 0, retops = 0, *retopsp = NULL, *repp, cbident;
3165 u_char tag[NFSV4_SMALLSTR + 1], *tagstr;
3171 nfsattrbit_t attrbits, rattrbits;
3172 nfsv4stateid_t stateid;
3173 uint32_t seqid, slotid = 0, highslot, cachethis;
3174 uint8_t sessionid[NFSX_V4SESSIONID];
3176 struct nfscllayout *lyp;
3177 uint64_t filesid[2], len, off;
3178 int changed, gotone, laytype, recalltype;
3180 struct nfsclrecalllayout *recallp = NULL;
3181 struct nfsclsession *tsep;
3185 NFSM_DISSECT(tl, u_int32_t *, NFSX_UNSIGNED);
3186 taglen = fxdr_unsigned(int, *tl);
3191 if (taglen <= NFSV4_SMALLSTR)
3194 tagstr = malloc(taglen + 1, M_TEMP, M_WAITOK);
3195 error = nfsrv_mtostr(nd, tagstr, taglen);
3197 if (taglen > NFSV4_SMALLSTR)
3198 free(tagstr, M_TEMP);
3202 (void) nfsm_strtom(nd, tag, taglen);
3203 if (taglen > NFSV4_SMALLSTR) {
3204 free(tagstr, M_TEMP);
3206 NFSM_BUILD(retopsp, u_int32_t *, NFSX_UNSIGNED);
3207 NFSM_DISSECT(tl, u_int32_t *, 3 * NFSX_UNSIGNED);
3208 minorvers = fxdr_unsigned(u_int32_t, *tl++);
3209 if (minorvers != NFSV4_MINORVERSION && minorvers != NFSV41_MINORVERSION)
3210 nd->nd_repstat = NFSERR_MINORVERMISMATCH;
3211 cbident = fxdr_unsigned(u_int32_t, *tl++);
3215 numops = fxdr_unsigned(int, *tl);
3217 * Loop around doing the sub ops.
3219 for (i = 0; i < numops; i++) {
3220 NFSM_DISSECT(tl, u_int32_t *, NFSX_UNSIGNED);
3221 NFSM_BUILD(repp, u_int32_t *, 2 * NFSX_UNSIGNED);
3223 op = fxdr_unsigned(int, *tl);
3224 if (op < NFSV4OP_CBGETATTR ||
3225 (op > NFSV4OP_CBRECALL && minorvers == NFSV4_MINORVERSION) ||
3226 (op > NFSV4OP_CBNOTIFYDEVID &&
3227 minorvers == NFSV41_MINORVERSION)) {
3228 nd->nd_repstat = NFSERR_OPILLEGAL;
3229 *repp = nfscl_errmap(nd, minorvers);
3233 nd->nd_procnum = op;
3234 if (op < NFSV4OP_CBNOPS)
3235 newnfsstats.cbrpccnt[nd->nd_procnum]++;
3237 case NFSV4OP_CBGETATTR:
3238 NFSCL_DEBUG(4, "cbgetattr\n");
3241 error = nfsm_getfh(nd, &nfhp);
3243 error = nfsrv_getattrbits(nd, &attrbits,
3245 if (error == 0 && i == 0 &&
3246 minorvers != NFSV4_MINORVERSION)
3247 error = NFSERR_OPNOTINSESS;
3249 mp = nfscl_getmnt(minorvers, sessionid, cbident,
3252 error = NFSERR_SERVERFAULT;
3255 error = nfscl_ngetreopen(mp, nfhp->nfh_fh,
3256 nfhp->nfh_len, p, &np);
3261 NFSZERO_ATTRBIT(&rattrbits);
3263 dp = nfscl_finddeleg(clp, nfhp->nfh_fh,
3266 if (NFSISSET_ATTRBIT(&attrbits,
3269 va.va_size = np->n_size;
3273 NFSSETBIT_ATTRBIT(&rattrbits,
3276 if (NFSISSET_ATTRBIT(&attrbits,
3277 NFSATTRBIT_CHANGE)) {
3281 (np->n_flag & NDELEGMOD))
3283 NFSSETBIT_ATTRBIT(&rattrbits,
3287 error = NFSERR_SERVERFAULT;
3295 FREE((caddr_t)nfhp, M_NFSFH);
3297 (void) nfsv4_fillattr(nd, NULL, NULL, NULL, &va,
3298 NULL, 0, &rattrbits, NULL, p, 0, 0, 0, 0,
3301 case NFSV4OP_CBRECALL:
3302 NFSCL_DEBUG(4, "cbrecall\n");
3303 NFSM_DISSECT(tl, u_int32_t *, NFSX_STATEID +
3305 stateid.seqid = *tl++;
3306 NFSBCOPY((caddr_t)tl, (caddr_t)stateid.other,
3308 tl += (NFSX_STATEIDOTHER / NFSX_UNSIGNED);
3309 trunc = fxdr_unsigned(int, *tl);
3310 error = nfsm_getfh(nd, &nfhp);
3311 if (error == 0 && i == 0 &&
3312 minorvers != NFSV4_MINORVERSION)
3313 error = NFSERR_OPNOTINSESS;
3316 if (minorvers == NFSV4_MINORVERSION)
3317 clp = nfscl_getclnt(cbident);
3319 clp = nfscl_getclntsess(sessionid);
3321 dp = nfscl_finddeleg(clp, nfhp->nfh_fh,
3323 if (dp != NULL && (dp->nfsdl_flags &
3324 NFSCLDL_DELEGRET) == 0) {
3327 wakeup((caddr_t)clp);
3330 error = NFSERR_SERVERFAULT;
3335 FREE((caddr_t)nfhp, M_NFSFH);
3337 case NFSV4OP_CBLAYOUTRECALL:
3338 NFSCL_DEBUG(4, "cblayrec\n");
3340 NFSM_DISSECT(tl, uint32_t *, 4 * NFSX_UNSIGNED);
3341 laytype = fxdr_unsigned(int, *tl++);
3342 iomode = fxdr_unsigned(uint32_t, *tl++);
3343 if (newnfs_true == *tl++)
3347 recalltype = fxdr_unsigned(int, *tl);
3348 recallp = malloc(sizeof(*recallp), M_NFSLAYRECALL,
3350 if (laytype != NFSLAYOUT_NFSV4_1_FILES)
3351 error = NFSERR_NOMATCHLAYOUT;
3352 else if (recalltype == NFSLAYOUTRETURN_FILE) {
3353 error = nfsm_getfh(nd, &nfhp);
3354 NFSCL_DEBUG(4, "retfile getfh=%d\n", error);
3357 NFSM_DISSECT(tl, u_int32_t *, 2 * NFSX_HYPER +
3359 off = fxdr_hyper(tl); tl += 2;
3360 len = fxdr_hyper(tl); tl += 2;
3361 stateid.seqid = fxdr_unsigned(uint32_t, *tl++);
3362 NFSBCOPY(tl, stateid.other, NFSX_STATEIDOTHER);
3363 if (minorvers == NFSV4_MINORVERSION)
3364 error = NFSERR_NOTSUPP;
3366 error = NFSERR_OPNOTINSESS;
3369 clp = nfscl_getclntsess(sessionid);
3370 NFSCL_DEBUG(4, "cbly clp=%p\n", clp);
3372 lyp = nfscl_findlayout(clp,
3375 NFSCL_DEBUG(4, "cblyp=%p\n",
3379 NFSLY_FILES) != 0 &&
3380 !NFSBCMP(stateid.other,
3381 lyp->nfsly_stateid.other,
3382 NFSX_STATEIDOTHER)) {
3396 NFSERR_NOMATCHLAYOUT;
3398 error = NFSERR_NOMATCHLAYOUT;
3401 free(nfhp, M_NFSFH);
3402 } else if (recalltype == NFSLAYOUTRETURN_FSID) {
3403 NFSM_DISSECT(tl, uint32_t *, 2 * NFSX_HYPER);
3404 filesid[0] = fxdr_hyper(tl); tl += 2;
3405 filesid[1] = fxdr_hyper(tl); tl += 2;
3408 clp = nfscl_getclntsess(sessionid);
3410 TAILQ_FOREACH(lyp, &clp->nfsc_layout,
3412 if (lyp->nfsly_filesid[0] ==
3414 lyp->nfsly_filesid[1] ==
3421 lyp->nfsly_stateid.seqid,
3430 error = NFSERR_NOMATCHLAYOUT;
3432 error = NFSERR_NOMATCHLAYOUT;
3434 } else if (recalltype == NFSLAYOUTRETURN_ALL) {
3437 clp = nfscl_getclntsess(sessionid);
3439 TAILQ_FOREACH(lyp, &clp->nfsc_layout,
3441 error = nfscl_layoutrecall(
3442 recalltype, lyp, iomode, 0,
3444 lyp->nfsly_stateid.seqid,
3452 error = NFSERR_NOMATCHLAYOUT;
3454 error = NFSERR_NOMATCHLAYOUT;
3457 error = NFSERR_NOMATCHLAYOUT;
3458 if (recallp != NULL) {
3459 free(recallp, M_NFSLAYRECALL);
3463 case NFSV4OP_CBSEQUENCE:
3464 NFSM_DISSECT(tl, uint32_t *, NFSX_V4SESSIONID +
3466 bcopy(tl, sessionid, NFSX_V4SESSIONID);
3467 tl += NFSX_V4SESSIONID / NFSX_UNSIGNED;
3468 seqid = fxdr_unsigned(uint32_t, *tl++);
3469 slotid = fxdr_unsigned(uint32_t, *tl++);
3470 highslot = fxdr_unsigned(uint32_t, *tl++);
3472 /* Throw away the referring call stuff. */
3473 clist = fxdr_unsigned(int, *tl);
3474 for (j = 0; j < clist; j++) {
3475 NFSM_DISSECT(tl, uint32_t *, NFSX_V4SESSIONID +
3477 tl += NFSX_V4SESSIONID / NFSX_UNSIGNED;
3478 rcalls = fxdr_unsigned(int, *tl);
3479 for (k = 0; k < rcalls; k++) {
3480 NFSM_DISSECT(tl, uint32_t *,
3486 clp = nfscl_getclntsess(sessionid);
3488 error = NFSERR_SERVERFAULT;
3490 error = NFSERR_SEQUENCEPOS;
3492 tsep = nfsmnt_mdssession(clp->nfsc_nmp);
3493 error = nfsv4_seqsession(seqid, slotid,
3494 highslot, tsep->nfsess_cbslots, &rep,
3495 tsep->nfsess_backslots);
3501 NFSCL_DEBUG(4, "Got cbretry\n");
3502 m_freem(nd->nd_mreq);
3507 NFSM_BUILD(tl, uint32_t *,
3508 NFSX_V4SESSIONID + 4 * NFSX_UNSIGNED);
3509 bcopy(sessionid, tl, NFSX_V4SESSIONID);
3510 tl += NFSX_V4SESSIONID / NFSX_UNSIGNED;
3511 *tl++ = txdr_unsigned(seqid);
3512 *tl++ = txdr_unsigned(slotid);
3513 *tl++ = txdr_unsigned(NFSV4_CBSLOTS - 1);
3514 *tl = txdr_unsigned(NFSV4_CBSLOTS - 1);
3518 if (i == 0 && minorvers == NFSV41_MINORVERSION)
3519 error = NFSERR_OPNOTINSESS;
3521 NFSCL_DEBUG(1, "unsupp callback %d\n", op);
3522 error = NFSERR_NOTSUPP;
3527 if (error == EBADRPC || error == NFSERR_BADXDR) {
3528 nd->nd_repstat = NFSERR_BADXDR;
3530 nd->nd_repstat = error;
3535 if (nd->nd_repstat) {
3536 *repp = nfscl_errmap(nd, minorvers);
3539 *repp = 0; /* NFS4_OK */
3542 if (recallp != NULL)
3543 free(recallp, M_NFSLAYRECALL);
3545 if (error == EBADRPC || error == NFSERR_BADXDR)
3546 nd->nd_repstat = NFSERR_BADXDR;
3548 printf("nfsv4 comperr1=%d\n", error);
3551 NFSM_BUILD(tl, u_int32_t *, 2 * NFSX_UNSIGNED);
3555 *retopsp = txdr_unsigned(retops);
3557 *nd->nd_errp = nfscl_errmap(nd, minorvers);
3559 if (gotseq_ok != 0) {
3560 rep = m_copym(nd->nd_mreq, 0, M_COPYALL, M_WAITOK);
3562 clp = nfscl_getclntsess(sessionid);
3564 tsep = nfsmnt_mdssession(clp->nfsc_nmp);
3565 nfsv4_seqsess_cacherep(slotid, tsep->nfsess_cbslots,
3576 * Generate the next cbident value. Basically just increment a static value
3577 * and then check that it isn't already in the list, if it has wrapped around.
3580 nfscl_nextcbident(void)
3582 struct nfsclclient *clp;
3584 static u_int32_t nextcbident = 0;
3585 static int haswrapped = 0;
3588 if (nextcbident == 0)
3592 * Search the clientid list for one already using this cbident.
3597 LIST_FOREACH(clp, &nfsclhead, nfsc_list) {
3598 if (clp->nfsc_cbident == nextcbident) {
3608 return (nextcbident);
3612 * Get the mount point related to a given cbident or session and busy it.
3615 nfscl_getmnt(int minorvers, uint8_t *sessionid, u_int32_t cbident,
3616 struct nfsclclient **clpp)
3618 struct nfsclclient *clp;
3621 struct nfsclsession *tsep;
3625 LIST_FOREACH(clp, &nfsclhead, nfsc_list) {
3626 tsep = nfsmnt_mdssession(clp->nfsc_nmp);
3627 if (minorvers == NFSV4_MINORVERSION) {
3628 if (clp->nfsc_cbident == cbident)
3630 } else if (!NFSBCMP(tsep->nfsess_sessionid, sessionid,
3638 mp = clp->nfsc_nmp->nm_mountp;
3641 error = vfs_busy(mp, 0);
3650 * Get the clientid pointer related to a given cbident.
3652 static struct nfsclclient *
3653 nfscl_getclnt(u_int32_t cbident)
3655 struct nfsclclient *clp;
3657 LIST_FOREACH(clp, &nfsclhead, nfsc_list)
3658 if (clp->nfsc_cbident == cbident)
3664 * Get the clientid pointer related to a given sessionid.
3666 static struct nfsclclient *
3667 nfscl_getclntsess(uint8_t *sessionid)
3669 struct nfsclclient *clp;
3670 struct nfsclsession *tsep;
3672 LIST_FOREACH(clp, &nfsclhead, nfsc_list) {
3673 tsep = nfsmnt_mdssession(clp->nfsc_nmp);
3674 if (!NFSBCMP(tsep->nfsess_sessionid, sessionid,
3682 * Search for a lock conflict locally on the client. A conflict occurs if
3683 * - not same owner and overlapping byte range and at least one of them is
3684 * a write lock or this is an unlock.
3687 nfscl_localconflict(struct nfsclclient *clp, u_int8_t *fhp, int fhlen,
3688 struct nfscllock *nlop, u_int8_t *own, struct nfscldeleg *dp,
3689 struct nfscllock **lopp)
3691 struct nfsclowner *owp;
3692 struct nfsclopen *op;
3696 ret = nfscl_checkconflict(&dp->nfsdl_lock, nlop, own, lopp);
3700 LIST_FOREACH(owp, &clp->nfsc_owner, nfsow_list) {
3701 LIST_FOREACH(op, &owp->nfsow_open, nfso_list) {
3702 if (op->nfso_fhlen == fhlen &&
3703 !NFSBCMP(op->nfso_fh, fhp, fhlen)) {
3704 ret = nfscl_checkconflict(&op->nfso_lock, nlop,
3715 nfscl_checkconflict(struct nfscllockownerhead *lhp, struct nfscllock *nlop,
3716 u_int8_t *own, struct nfscllock **lopp)
3718 struct nfscllockowner *lp;
3719 struct nfscllock *lop;
3721 LIST_FOREACH(lp, lhp, nfsl_list) {
3722 if (NFSBCMP(lp->nfsl_owner, own, NFSV4CL_LOCKNAMELEN)) {
3723 LIST_FOREACH(lop, &lp->nfsl_lock, nfslo_list) {
3724 if (lop->nfslo_first >= nlop->nfslo_end)
3726 if (lop->nfslo_end <= nlop->nfslo_first)
3728 if (lop->nfslo_type == F_WRLCK ||
3729 nlop->nfslo_type == F_WRLCK ||
3730 nlop->nfslo_type == F_UNLCK) {
3733 return (NFSERR_DENIED);
3742 * Check for a local conflicting lock.
3745 nfscl_lockt(vnode_t vp, struct nfsclclient *clp, u_int64_t off,
3746 u_int64_t len, struct flock *fl, NFSPROC_T *p, void *id, int flags)
3748 struct nfscllock *lop, nlck;
3749 struct nfscldeleg *dp;
3751 u_int8_t own[NFSV4CL_LOCKNAMELEN];
3754 nlck.nfslo_type = fl->l_type;
3755 nlck.nfslo_first = off;
3756 if (len == NFS64BITSSET) {
3757 nlck.nfslo_end = NFS64BITSSET;
3759 nlck.nfslo_end = off + len;
3760 if (nlck.nfslo_end <= nlck.nfslo_first)
3761 return (NFSERR_INVAL);
3764 nfscl_filllockowner(id, own, flags);
3766 dp = nfscl_finddeleg(clp, np->n_fhp->nfh_fh, np->n_fhp->nfh_len);
3767 error = nfscl_localconflict(clp, np->n_fhp->nfh_fh, np->n_fhp->nfh_len,
3768 &nlck, own, dp, &lop);
3770 fl->l_whence = SEEK_SET;
3771 fl->l_start = lop->nfslo_first;
3772 if (lop->nfslo_end == NFS64BITSSET)
3775 fl->l_len = lop->nfslo_end - lop->nfslo_first;
3776 fl->l_pid = (pid_t)0;
3777 fl->l_type = lop->nfslo_type;
3778 error = -1; /* no RPC required */
3779 } else if (dp != NULL && ((dp->nfsdl_flags & NFSCLDL_WRITE) ||
3780 fl->l_type == F_RDLCK)) {
3782 * The delegation ensures that there isn't a conflicting
3783 * lock on the server, so return -1 to indicate an RPC
3786 fl->l_type = F_UNLCK;
3794 * Handle Recall of a delegation.
3795 * The clp must be exclusive locked when this is called.
3798 nfscl_recalldeleg(struct nfsclclient *clp, struct nfsmount *nmp,
3799 struct nfscldeleg *dp, vnode_t vp, struct ucred *cred, NFSPROC_T *p,
3800 int called_from_renewthread)
3802 struct nfsclowner *owp, *lowp, *nowp;
3803 struct nfsclopen *op, *lop;
3804 struct nfscllockowner *lp;
3805 struct nfscllock *lckp;
3807 int error = 0, ret, gotvp = 0;
3811 * First, get a vnode for the file. This is needed to do RPCs.
3813 ret = nfscl_ngetreopen(nmp->nm_mountp, dp->nfsdl_fh,
3814 dp->nfsdl_fhlen, p, &np);
3817 * File isn't open, so nothing to move over to the
3827 dp->nfsdl_flags &= ~NFSCLDL_MODTIMESET;
3830 * Ok, if it's a write delegation, flush data to the server, so
3831 * that close/open consistency is retained.
3835 if ((dp->nfsdl_flags & NFSCLDL_WRITE) && (np->n_flag & NMODIFIED)) {
3836 np->n_flag |= NDELEGRECALL;
3838 ret = ncl_flush(vp, MNT_WAIT, cred, p, 1,
3839 called_from_renewthread);
3841 np->n_flag &= ~NDELEGRECALL;
3843 NFSINVALATTRCACHE(np);
3845 if (ret == EIO && called_from_renewthread != 0) {
3847 * If the flush failed with EIO for the renew thread,
3848 * return now, so that the dirty buffer will be flushed
3857 * Now, for each openowner with opens issued locally, move them
3858 * over to state against the server.
3860 LIST_FOREACH(lowp, &dp->nfsdl_owner, nfsow_list) {
3861 lop = LIST_FIRST(&lowp->nfsow_open);
3863 if (LIST_NEXT(lop, nfso_list) != NULL)
3864 panic("nfsdlg mult opens");
3866 * Look for the same openowner against the server.
3868 LIST_FOREACH(owp, &clp->nfsc_owner, nfsow_list) {
3869 if (!NFSBCMP(lowp->nfsow_owner,
3870 owp->nfsow_owner, NFSV4CL_LOCKNAMELEN)) {
3871 newnfs_copycred(&dp->nfsdl_cred, cred);
3872 ret = nfscl_moveopen(vp, clp, nmp, lop,
3874 if (ret == NFSERR_STALECLIENTID ||
3875 ret == NFSERR_STALEDONTRECOVER ||
3876 ret == NFSERR_BADSESSION) {
3882 nfscl_freeopen(lop, 1);
3891 * If no openowner found, create one and get an open
3895 MALLOC(nowp, struct nfsclowner *,
3896 sizeof (struct nfsclowner), M_NFSCLOWNER,
3898 nfscl_newopen(clp, NULL, &owp, &nowp, &op,
3899 NULL, lowp->nfsow_owner, dp->nfsdl_fh,
3900 dp->nfsdl_fhlen, NULL);
3901 newnfs_copycred(&dp->nfsdl_cred, cred);
3902 ret = nfscl_moveopen(vp, clp, nmp, lop,
3905 nfscl_freeopenowner(owp, 0);
3906 if (ret == NFSERR_STALECLIENTID ||
3907 ret == NFSERR_STALEDONTRECOVER ||
3908 ret == NFSERR_BADSESSION) {
3914 nfscl_freeopen(lop, 1);
3924 * Now, get byte range locks for any locks done locally.
3926 LIST_FOREACH(lp, &dp->nfsdl_lock, nfsl_list) {
3927 LIST_FOREACH(lckp, &lp->nfsl_lock, nfslo_list) {
3928 newnfs_copycred(&dp->nfsdl_cred, cred);
3929 ret = nfscl_relock(vp, clp, nmp, lp, lckp, cred, p);
3930 if (ret == NFSERR_STALESTATEID ||
3931 ret == NFSERR_STALEDONTRECOVER ||
3932 ret == NFSERR_STALECLIENTID ||
3933 ret == NFSERR_BADSESSION) {
3948 * Move a locally issued open over to an owner on the state list.
3949 * SIDE EFFECT: If it needs to sleep (do an rpc), it unlocks clstate and
3950 * returns with it unlocked.
3953 nfscl_moveopen(vnode_t vp, struct nfsclclient *clp, struct nfsmount *nmp,
3954 struct nfsclopen *lop, struct nfsclowner *owp, struct nfscldeleg *dp,
3955 struct ucred *cred, NFSPROC_T *p)
3957 struct nfsclopen *op, *nop;
3958 struct nfscldeleg *ndp;
3960 int error = 0, newone;
3963 * First, look for an appropriate open, If found, just increment the
3966 LIST_FOREACH(op, &owp->nfsow_open, nfso_list) {
3967 if ((op->nfso_mode & lop->nfso_mode) == lop->nfso_mode &&
3968 op->nfso_fhlen == lop->nfso_fhlen &&
3969 !NFSBCMP(op->nfso_fh, lop->nfso_fh, op->nfso_fhlen)) {
3970 op->nfso_opencnt += lop->nfso_opencnt;
3971 nfscl_freeopen(lop, 1);
3976 /* No appropriate open, so we have to do one against the server. */
3978 MALLOC(nop, struct nfsclopen *, sizeof (struct nfsclopen) +
3979 lop->nfso_fhlen - 1, M_NFSCLOPEN, M_WAITOK);
3981 nfscl_newopen(clp, NULL, &owp, NULL, &op, &nop, owp->nfsow_owner,
3982 lop->nfso_fh, lop->nfso_fhlen, &newone);
3984 error = nfscl_tryopen(nmp, vp, np->n_v4->n4_data, np->n_v4->n4_fhlen,
3985 lop->nfso_fh, lop->nfso_fhlen, lop->nfso_mode, op,
3986 NFS4NODENAME(np->n_v4), np->n_v4->n4_namelen, &ndp, 0, 0, cred, p);
3989 nfscl_freeopen(op, 0);
3992 newnfs_copyincred(cred, &op->nfso_cred);
3993 op->nfso_mode |= lop->nfso_mode;
3994 op->nfso_opencnt += lop->nfso_opencnt;
3995 nfscl_freeopen(lop, 1);
3998 FREE((caddr_t)nop, M_NFSCLOPEN);
4001 * What should I do with the returned delegation, since the
4002 * delegation is being recalled? For now, just printf and
4005 printf("Moveopen returned deleg\n");
4006 FREE((caddr_t)ndp, M_NFSCLDELEG);
4012 * Recall all delegations on this client.
4015 nfscl_totalrecall(struct nfsclclient *clp)
4017 struct nfscldeleg *dp;
4019 TAILQ_FOREACH(dp, &clp->nfsc_deleg, nfsdl_list) {
4020 if ((dp->nfsdl_flags & NFSCLDL_DELEGRET) == 0)
4021 dp->nfsdl_flags |= NFSCLDL_RECALL;
4026 * Relock byte ranges. Called for delegation recall and state expiry.
4029 nfscl_relock(vnode_t vp, struct nfsclclient *clp, struct nfsmount *nmp,
4030 struct nfscllockowner *lp, struct nfscllock *lop, struct ucred *cred,
4033 struct nfscllockowner *nlp;
4036 u_int32_t clidrev = 0;
4037 int error, newone, donelocally;
4039 off = lop->nfslo_first;
4040 len = lop->nfslo_end - lop->nfslo_first;
4041 error = nfscl_getbytelock(vp, off, len, lop->nfslo_type, cred, p,
4042 clp, 1, NULL, lp->nfsl_lockflags, lp->nfsl_owner,
4043 lp->nfsl_openowner, &nlp, &newone, &donelocally);
4044 if (error || donelocally)
4046 if (nmp->nm_clp != NULL)
4047 clidrev = nmp->nm_clp->nfsc_clientidrev;
4050 nfhp = VTONFS(vp)->n_fhp;
4051 error = nfscl_trylock(nmp, vp, nfhp->nfh_fh,
4052 nfhp->nfh_len, nlp, newone, 0, off,
4053 len, lop->nfslo_type, cred, p);
4055 nfscl_freelockowner(nlp, 0);
4060 * Called to re-open a file. Basically get a vnode for the file handle
4061 * and then call nfsrpc_openrpc() to do the rest.
4064 nfsrpc_reopen(struct nfsmount *nmp, u_int8_t *fhp, int fhlen,
4065 u_int32_t mode, struct nfsclopen *op, struct nfscldeleg **dpp,
4066 struct ucred *cred, NFSPROC_T *p)
4072 error = nfscl_ngetreopen(nmp->nm_mountp, fhp, fhlen, p, &np);
4076 if (np->n_v4 != NULL) {
4077 error = nfscl_tryopen(nmp, vp, np->n_v4->n4_data,
4078 np->n_v4->n4_fhlen, fhp, fhlen, mode, op,
4079 NFS4NODENAME(np->n_v4), np->n_v4->n4_namelen, dpp, 0, 0,
4089 * Try an open against the server. Just call nfsrpc_openrpc(), retrying while
4090 * NFSERR_DELAY. Also, try system credentials, if the passed in credentials
4094 nfscl_tryopen(struct nfsmount *nmp, vnode_t vp, u_int8_t *fhp, int fhlen,
4095 u_int8_t *newfhp, int newfhlen, u_int32_t mode, struct nfsclopen *op,
4096 u_int8_t *name, int namelen, struct nfscldeleg **ndpp,
4097 int reclaim, u_int32_t delegtype, struct ucred *cred, NFSPROC_T *p)
4102 error = nfsrpc_openrpc(nmp, vp, fhp, fhlen, newfhp, newfhlen,
4103 mode, op, name, namelen, ndpp, reclaim, delegtype, cred, p,
4105 if (error == NFSERR_DELAY)
4106 (void) nfs_catnap(PZERO, error, "nfstryop");
4107 } while (error == NFSERR_DELAY);
4108 if (error == EAUTH || error == EACCES) {
4109 /* Try again using system credentials */
4110 newnfs_setroot(cred);
4112 error = nfsrpc_openrpc(nmp, vp, fhp, fhlen, newfhp,
4113 newfhlen, mode, op, name, namelen, ndpp, reclaim,
4114 delegtype, cred, p, 1, 0);
4115 if (error == NFSERR_DELAY)
4116 (void) nfs_catnap(PZERO, error, "nfstryop");
4117 } while (error == NFSERR_DELAY);
4123 * Try a byte range lock. Just loop on nfsrpc_lock() while it returns
4124 * NFSERR_DELAY. Also, retry with system credentials, if the provided
4128 nfscl_trylock(struct nfsmount *nmp, vnode_t vp, u_int8_t *fhp,
4129 int fhlen, struct nfscllockowner *nlp, int newone, int reclaim,
4130 u_int64_t off, u_int64_t len, short type, struct ucred *cred, NFSPROC_T *p)
4132 struct nfsrv_descript nfsd, *nd = &nfsd;
4136 error = nfsrpc_lock(nd, nmp, vp, fhp, fhlen, nlp, newone,
4137 reclaim, off, len, type, cred, p, 0);
4138 if (!error && nd->nd_repstat == NFSERR_DELAY)
4139 (void) nfs_catnap(PZERO, (int)nd->nd_repstat,
4141 } while (!error && nd->nd_repstat == NFSERR_DELAY);
4143 error = nd->nd_repstat;
4144 if (error == EAUTH || error == EACCES) {
4145 /* Try again using root credentials */
4146 newnfs_setroot(cred);
4148 error = nfsrpc_lock(nd, nmp, vp, fhp, fhlen, nlp,
4149 newone, reclaim, off, len, type, cred, p, 1);
4150 if (!error && nd->nd_repstat == NFSERR_DELAY)
4151 (void) nfs_catnap(PZERO, (int)nd->nd_repstat,
4153 } while (!error && nd->nd_repstat == NFSERR_DELAY);
4155 error = nd->nd_repstat;
4161 * Try a delegreturn against the server. Just call nfsrpc_delegreturn(),
4162 * retrying while NFSERR_DELAY. Also, try system credentials, if the passed in
4166 nfscl_trydelegreturn(struct nfscldeleg *dp, struct ucred *cred,
4167 struct nfsmount *nmp, NFSPROC_T *p)
4172 error = nfsrpc_delegreturn(dp, cred, nmp, p, 0);
4173 if (error == NFSERR_DELAY)
4174 (void) nfs_catnap(PZERO, error, "nfstrydp");
4175 } while (error == NFSERR_DELAY);
4176 if (error == EAUTH || error == EACCES) {
4177 /* Try again using system credentials */
4178 newnfs_setroot(cred);
4180 error = nfsrpc_delegreturn(dp, cred, nmp, p, 1);
4181 if (error == NFSERR_DELAY)
4182 (void) nfs_catnap(PZERO, error, "nfstrydp");
4183 } while (error == NFSERR_DELAY);
4189 * Try a close against the server. Just call nfsrpc_closerpc(),
4190 * retrying while NFSERR_DELAY. Also, try system credentials, if the passed in
4194 nfscl_tryclose(struct nfsclopen *op, struct ucred *cred,
4195 struct nfsmount *nmp, NFSPROC_T *p)
4197 struct nfsrv_descript nfsd, *nd = &nfsd;
4201 error = nfsrpc_closerpc(nd, nmp, op, cred, p, 0);
4202 if (error == NFSERR_DELAY)
4203 (void) nfs_catnap(PZERO, error, "nfstrycl");
4204 } while (error == NFSERR_DELAY);
4205 if (error == EAUTH || error == EACCES) {
4206 /* Try again using system credentials */
4207 newnfs_setroot(cred);
4209 error = nfsrpc_closerpc(nd, nmp, op, cred, p, 1);
4210 if (error == NFSERR_DELAY)
4211 (void) nfs_catnap(PZERO, error, "nfstrycl");
4212 } while (error == NFSERR_DELAY);
4218 * Decide if a delegation on a file permits close without flushing writes
4219 * to the server. This might be a big performance win in some environments.
4220 * (Not useful until the client does caching on local stable storage.)
4223 nfscl_mustflush(vnode_t vp)
4225 struct nfsclclient *clp;
4226 struct nfscldeleg *dp;
4228 struct nfsmount *nmp;
4231 nmp = VFSTONFS(vnode_mount(vp));
4232 if (!NFSHASNFSV4(nmp))
4235 clp = nfscl_findcl(nmp);
4240 dp = nfscl_finddeleg(clp, np->n_fhp->nfh_fh, np->n_fhp->nfh_len);
4241 if (dp != NULL && (dp->nfsdl_flags &
4242 (NFSCLDL_WRITE | NFSCLDL_RECALL | NFSCLDL_DELEGRET)) ==
4244 (dp->nfsdl_sizelimit >= np->n_size ||
4245 !NFSHASSTRICT3530(nmp))) {
4254 * See if a (write) delegation exists for this file.
4257 nfscl_nodeleg(vnode_t vp, int writedeleg)
4259 struct nfsclclient *clp;
4260 struct nfscldeleg *dp;
4262 struct nfsmount *nmp;
4265 nmp = VFSTONFS(vnode_mount(vp));
4266 if (!NFSHASNFSV4(nmp))
4269 clp = nfscl_findcl(nmp);
4274 dp = nfscl_finddeleg(clp, np->n_fhp->nfh_fh, np->n_fhp->nfh_len);
4276 (dp->nfsdl_flags & (NFSCLDL_RECALL | NFSCLDL_DELEGRET)) == 0 &&
4277 (writedeleg == 0 || (dp->nfsdl_flags & NFSCLDL_WRITE) ==
4287 * Look for an associated delegation that should be DelegReturned.
4290 nfscl_removedeleg(vnode_t vp, NFSPROC_T *p, nfsv4stateid_t *stp)
4292 struct nfsclclient *clp;
4293 struct nfscldeleg *dp;
4294 struct nfsclowner *owp;
4295 struct nfscllockowner *lp;
4296 struct nfsmount *nmp;
4299 int igotlock = 0, triedrecall = 0, needsrecall, retcnt = 0, islept;
4301 nmp = VFSTONFS(vnode_mount(vp));
4305 * Loop around waiting for:
4306 * - outstanding I/O operations on delegations to complete
4307 * - for a delegation on vp that has state, lock the client and
4309 * - return delegation with no state
4312 clp = nfscl_findcl(nmp);
4317 dp = nfscl_finddeleg(clp, np->n_fhp->nfh_fh,
4318 np->n_fhp->nfh_len);
4321 * Wait for outstanding I/O ops to be done.
4323 if (dp->nfsdl_rwlock.nfslock_usecnt > 0) {
4325 nfsv4_unlock(&clp->nfsc_lock, 0);
4328 dp->nfsdl_rwlock.nfslock_lock |= NFSV4LOCK_WANTED;
4329 (void) nfsmsleep(&dp->nfsdl_rwlock,
4330 NFSCLSTATEMUTEXPTR, PZERO, "nfscld", NULL);
4334 LIST_FOREACH(owp, &dp->nfsdl_owner, nfsow_list) {
4335 if (!LIST_EMPTY(&owp->nfsow_open)) {
4341 LIST_FOREACH(lp, &dp->nfsdl_lock, nfsl_list) {
4342 if (!LIST_EMPTY(&lp->nfsl_lock)) {
4348 if (needsrecall && !triedrecall) {
4349 dp->nfsdl_flags |= NFSCLDL_DELEGRET;
4352 igotlock = nfsv4_lock(&clp->nfsc_lock, 1,
4353 &islept, NFSCLSTATEMUTEXPTR, NULL);
4360 cred = newnfs_getcred();
4361 newnfs_copycred(&dp->nfsdl_cred, cred);
4362 (void) nfscl_recalldeleg(clp, nmp, dp, vp, cred, p, 0);
4366 nfsv4_unlock(&clp->nfsc_lock, 0);
4370 *stp = dp->nfsdl_stateid;
4372 nfscl_cleandeleg(dp);
4373 nfscl_freedeleg(&clp->nfsc_deleg, dp);
4376 nfsv4_unlock(&clp->nfsc_lock, 0);
4383 * Look for associated delegation(s) that should be DelegReturned.
4386 nfscl_renamedeleg(vnode_t fvp, nfsv4stateid_t *fstp, int *gotfdp, vnode_t tvp,
4387 nfsv4stateid_t *tstp, int *gottdp, NFSPROC_T *p)
4389 struct nfsclclient *clp;
4390 struct nfscldeleg *dp;
4391 struct nfsclowner *owp;
4392 struct nfscllockowner *lp;
4393 struct nfsmount *nmp;
4396 int igotlock = 0, triedrecall = 0, needsrecall, retcnt = 0, islept;
4398 nmp = VFSTONFS(vnode_mount(fvp));
4403 * Loop around waiting for:
4404 * - outstanding I/O operations on delegations to complete
4405 * - for a delegation on fvp that has state, lock the client and
4407 * - return delegation(s) with no state.
4410 clp = nfscl_findcl(nmp);
4416 dp = nfscl_finddeleg(clp, np->n_fhp->nfh_fh,
4417 np->n_fhp->nfh_len);
4418 if (dp != NULL && *gotfdp == 0) {
4420 * Wait for outstanding I/O ops to be done.
4422 if (dp->nfsdl_rwlock.nfslock_usecnt > 0) {
4424 nfsv4_unlock(&clp->nfsc_lock, 0);
4427 dp->nfsdl_rwlock.nfslock_lock |= NFSV4LOCK_WANTED;
4428 (void) nfsmsleep(&dp->nfsdl_rwlock,
4429 NFSCLSTATEMUTEXPTR, PZERO, "nfscld", NULL);
4433 LIST_FOREACH(owp, &dp->nfsdl_owner, nfsow_list) {
4434 if (!LIST_EMPTY(&owp->nfsow_open)) {
4440 LIST_FOREACH(lp, &dp->nfsdl_lock, nfsl_list) {
4441 if (!LIST_EMPTY(&lp->nfsl_lock)) {
4447 if (needsrecall && !triedrecall) {
4448 dp->nfsdl_flags |= NFSCLDL_DELEGRET;
4451 igotlock = nfsv4_lock(&clp->nfsc_lock, 1,
4452 &islept, NFSCLSTATEMUTEXPTR, NULL);
4459 cred = newnfs_getcred();
4460 newnfs_copycred(&dp->nfsdl_cred, cred);
4461 (void) nfscl_recalldeleg(clp, nmp, dp, fvp, cred, p, 0);
4465 nfsv4_unlock(&clp->nfsc_lock, 0);
4469 *fstp = dp->nfsdl_stateid;
4472 nfscl_cleandeleg(dp);
4473 nfscl_freedeleg(&clp->nfsc_deleg, dp);
4476 nfsv4_unlock(&clp->nfsc_lock, 0);
4481 dp = nfscl_finddeleg(clp, np->n_fhp->nfh_fh,
4482 np->n_fhp->nfh_len);
4483 if (dp != NULL && *gottdp == 0) {
4485 * Wait for outstanding I/O ops to be done.
4487 if (dp->nfsdl_rwlock.nfslock_usecnt > 0) {
4488 dp->nfsdl_rwlock.nfslock_lock |= NFSV4LOCK_WANTED;
4489 (void) nfsmsleep(&dp->nfsdl_rwlock,
4490 NFSCLSTATEMUTEXPTR, PZERO, "nfscld", NULL);
4493 LIST_FOREACH(owp, &dp->nfsdl_owner, nfsow_list) {
4494 if (!LIST_EMPTY(&owp->nfsow_open)) {
4499 LIST_FOREACH(lp, &dp->nfsdl_lock, nfsl_list) {
4500 if (!LIST_EMPTY(&lp->nfsl_lock)) {
4505 *tstp = dp->nfsdl_stateid;
4508 nfscl_cleandeleg(dp);
4509 nfscl_freedeleg(&clp->nfsc_deleg, dp);
4518 * Get a reference on the clientid associated with the mount point.
4519 * Return 1 if success, 0 otherwise.
4522 nfscl_getref(struct nfsmount *nmp)
4524 struct nfsclclient *clp;
4527 clp = nfscl_findcl(nmp);
4532 nfsv4_getref(&clp->nfsc_lock, NULL, NFSCLSTATEMUTEXPTR, NULL);
4538 * Release a reference on a clientid acquired with the above call.
4541 nfscl_relref(struct nfsmount *nmp)
4543 struct nfsclclient *clp;
4546 clp = nfscl_findcl(nmp);
4551 nfsv4_relref(&clp->nfsc_lock);
4556 * Save the size attribute in the delegation, since the nfsnode
4560 nfscl_reclaimnode(vnode_t vp)
4562 struct nfsclclient *clp;
4563 struct nfscldeleg *dp;
4564 struct nfsnode *np = VTONFS(vp);
4565 struct nfsmount *nmp;
4567 nmp = VFSTONFS(vnode_mount(vp));
4568 if (!NFSHASNFSV4(nmp))
4571 clp = nfscl_findcl(nmp);
4576 dp = nfscl_finddeleg(clp, np->n_fhp->nfh_fh, np->n_fhp->nfh_len);
4577 if (dp != NULL && (dp->nfsdl_flags & NFSCLDL_WRITE))
4578 dp->nfsdl_size = np->n_size;
4583 * Get the saved size attribute in the delegation, since it is a
4584 * newly allocated nfsnode.
4587 nfscl_newnode(vnode_t vp)
4589 struct nfsclclient *clp;
4590 struct nfscldeleg *dp;
4591 struct nfsnode *np = VTONFS(vp);
4592 struct nfsmount *nmp;
4594 nmp = VFSTONFS(vnode_mount(vp));
4595 if (!NFSHASNFSV4(nmp))
4598 clp = nfscl_findcl(nmp);
4603 dp = nfscl_finddeleg(clp, np->n_fhp->nfh_fh, np->n_fhp->nfh_len);
4604 if (dp != NULL && (dp->nfsdl_flags & NFSCLDL_WRITE))
4605 np->n_size = dp->nfsdl_size;
4610 * If there is a valid write delegation for this file, set the modtime
4611 * to the local clock time.
4614 nfscl_delegmodtime(vnode_t vp)
4616 struct nfsclclient *clp;
4617 struct nfscldeleg *dp;
4618 struct nfsnode *np = VTONFS(vp);
4619 struct nfsmount *nmp;
4621 nmp = VFSTONFS(vnode_mount(vp));
4622 if (!NFSHASNFSV4(nmp))
4625 clp = nfscl_findcl(nmp);
4630 dp = nfscl_finddeleg(clp, np->n_fhp->nfh_fh, np->n_fhp->nfh_len);
4631 if (dp != NULL && (dp->nfsdl_flags & NFSCLDL_WRITE)) {
4632 nanotime(&dp->nfsdl_modtime);
4633 dp->nfsdl_flags |= NFSCLDL_MODTIMESET;
4639 * If there is a valid write delegation for this file with a modtime set,
4640 * put that modtime in mtime.
4643 nfscl_deleggetmodtime(vnode_t vp, struct timespec *mtime)
4645 struct nfsclclient *clp;
4646 struct nfscldeleg *dp;
4647 struct nfsnode *np = VTONFS(vp);
4648 struct nfsmount *nmp;
4650 nmp = VFSTONFS(vnode_mount(vp));
4651 if (!NFSHASNFSV4(nmp))
4654 clp = nfscl_findcl(nmp);
4659 dp = nfscl_finddeleg(clp, np->n_fhp->nfh_fh, np->n_fhp->nfh_len);
4661 (dp->nfsdl_flags & (NFSCLDL_WRITE | NFSCLDL_MODTIMESET)) ==
4662 (NFSCLDL_WRITE | NFSCLDL_MODTIMESET))
4663 *mtime = dp->nfsdl_modtime;
4668 nfscl_errmap(struct nfsrv_descript *nd, u_int32_t minorvers)
4670 short *defaulterrp, *errp;
4672 if (!nd->nd_repstat)
4674 if (nd->nd_procnum == NFSPROC_NOOP)
4675 return (txdr_unsigned(nd->nd_repstat & 0xffff));
4676 if (nd->nd_repstat == EBADRPC)
4677 return (txdr_unsigned(NFSERR_BADXDR));
4678 if (nd->nd_repstat == NFSERR_MINORVERMISMATCH ||
4679 nd->nd_repstat == NFSERR_OPILLEGAL)
4680 return (txdr_unsigned(nd->nd_repstat));
4681 if (nd->nd_repstat >= NFSERR_BADIOMODE && nd->nd_repstat < 20000 &&
4682 minorvers > NFSV4_MINORVERSION) {
4683 /* NFSv4.n error. */
4684 return (txdr_unsigned(nd->nd_repstat));
4686 if (nd->nd_procnum < NFSV4OP_CBNOPS)
4687 errp = defaulterrp = nfscl_cberrmap[nd->nd_procnum];
4689 return (txdr_unsigned(nd->nd_repstat));
4691 if (*errp == (short)nd->nd_repstat)
4692 return (txdr_unsigned(nd->nd_repstat));
4693 return (txdr_unsigned(*defaulterrp));
4697 * Called to find/add a layout to a client.
4698 * This function returns the layout with a refcnt (shared lock) upon
4699 * success (returns 0) or with no lock/refcnt on the layout when an
4700 * error is returned.
4701 * If a layout is passed in via lypp, it is locked (exclusively locked).
4704 nfscl_layout(struct nfsmount *nmp, vnode_t vp, u_int8_t *fhp, int fhlen,
4705 nfsv4stateid_t *stateidp, int retonclose,
4706 struct nfsclflayouthead *fhlp, struct nfscllayout **lypp,
4707 struct ucred *cred, NFSPROC_T *p)
4709 struct nfsclclient *clp;
4710 struct nfscllayout *lyp, *tlyp;
4711 struct nfsclflayout *flp;
4712 struct nfsnode *np = VTONFS(vp);
4714 int layout_passed_in;
4716 mp = nmp->nm_mountp;
4717 layout_passed_in = 1;
4721 layout_passed_in = 0;
4722 tlyp = malloc(sizeof(*tlyp) + fhlen - 1, M_NFSLAYOUT,
4729 if (layout_passed_in != 0)
4730 nfsv4_unlock(&lyp->nfsly_lock, 0);
4733 free(tlyp, M_NFSLAYOUT);
4738 * Although no lyp was passed in, another thread might have
4739 * allocated one. If one is found, just increment it's ref
4740 * count and return it.
4742 lyp = nfscl_findlayout(clp, fhp, fhlen);
4746 lyp->nfsly_stateid.seqid = stateidp->seqid;
4747 lyp->nfsly_stateid.other[0] = stateidp->other[0];
4748 lyp->nfsly_stateid.other[1] = stateidp->other[1];
4749 lyp->nfsly_stateid.other[2] = stateidp->other[2];
4750 lyp->nfsly_lastbyte = 0;
4751 LIST_INIT(&lyp->nfsly_flayread);
4752 LIST_INIT(&lyp->nfsly_flayrw);
4753 LIST_INIT(&lyp->nfsly_recall);
4754 lyp->nfsly_filesid[0] = np->n_vattr.na_filesid[0];
4755 lyp->nfsly_filesid[1] = np->n_vattr.na_filesid[1];
4756 lyp->nfsly_clp = clp;
4757 lyp->nfsly_flags = (retonclose != 0) ?
4758 (NFSLY_FILES | NFSLY_RETONCLOSE) : NFSLY_FILES;
4759 lyp->nfsly_fhlen = fhlen;
4760 NFSBCOPY(fhp, lyp->nfsly_fh, fhlen);
4761 TAILQ_INSERT_HEAD(&clp->nfsc_layout, lyp, nfsly_list);
4762 LIST_INSERT_HEAD(NFSCLLAYOUTHASH(clp, fhp, fhlen), lyp,
4764 lyp->nfsly_timestamp = NFSD_MONOSEC + 120;
4767 if (retonclose != 0)
4768 lyp->nfsly_flags |= NFSLY_RETONCLOSE;
4769 TAILQ_REMOVE(&clp->nfsc_layout, lyp, nfsly_list);
4770 TAILQ_INSERT_HEAD(&clp->nfsc_layout, lyp, nfsly_list);
4771 lyp->nfsly_timestamp = NFSD_MONOSEC + 120;
4773 nfsv4_getref(&lyp->nfsly_lock, NULL, NFSCLSTATEMUTEXPTR, mp);
4774 if ((mp->mnt_kern_flag & MNTK_UNMOUNTF) != 0) {
4777 free(tlyp, M_NFSLAYOUT);
4782 lyp->nfsly_stateid.seqid = stateidp->seqid;
4784 /* Merge the new list of File Layouts into the list. */
4785 flp = LIST_FIRST(fhlp);
4787 if (flp->nfsfl_iomode == NFSLAYOUTIOMODE_READ)
4788 nfscl_mergeflayouts(&lyp->nfsly_flayread, fhlp);
4790 nfscl_mergeflayouts(&lyp->nfsly_flayrw, fhlp);
4792 if (layout_passed_in != 0)
4793 nfsv4_unlock(&lyp->nfsly_lock, 1);
4796 free(tlyp, M_NFSLAYOUT);
4801 * Search for a layout by MDS file handle.
4802 * If one is found, it is returned with a refcnt (shared lock) iff
4803 * retflpp returned non-NULL and locked (exclusive locked) iff retflpp is
4806 struct nfscllayout *
4807 nfscl_getlayout(struct nfsclclient *clp, uint8_t *fhp, int fhlen,
4808 uint64_t off, struct nfsclflayout **retflpp, int *recalledp)
4810 struct nfscllayout *lyp;
4812 int error, igotlock;
4814 mp = clp->nfsc_nmp->nm_mountp;
4818 lyp = nfscl_findlayout(clp, fhp, fhlen);
4820 if ((lyp->nfsly_flags & NFSLY_RECALL) == 0) {
4821 TAILQ_REMOVE(&clp->nfsc_layout, lyp, nfsly_list);
4822 TAILQ_INSERT_HEAD(&clp->nfsc_layout, lyp, nfsly_list);
4823 lyp->nfsly_timestamp = NFSD_MONOSEC + 120;
4824 error = nfscl_findlayoutforio(lyp, off,
4825 NFSV4OPEN_ACCESSREAD, retflpp);
4827 nfsv4_getref(&lyp->nfsly_lock, NULL,
4828 NFSCLSTATEMUTEXPTR, mp);
4831 igotlock = nfsv4_lock(&lyp->nfsly_lock,
4832 1, NULL, NFSCLSTATEMUTEXPTR, mp);
4833 } while (igotlock == 0 &&
4834 (mp->mnt_kern_flag & MNTK_UNMOUNTF) == 0);
4837 if ((mp->mnt_kern_flag & MNTK_UNMOUNTF) != 0) {
4851 * Search for a layout by MDS file handle. If one is found that is marked
4852 * "return on close", delete it, since it should now be forgotten.
4855 nfscl_retoncloselayout(struct nfsclclient *clp, uint8_t *fhp, int fhlen)
4857 struct nfscllayout *lyp;
4860 lyp = nfscl_findlayout(clp, fhp, fhlen);
4861 if (lyp != NULL && (lyp->nfsly_flags & NFSLY_RETONCLOSE) != 0) {
4863 * Wait for outstanding I/O ops to be done.
4865 if (lyp->nfsly_lock.nfslock_usecnt != 0 ||
4866 lyp->nfsly_lock.nfslock_lock != 0) {
4867 lyp->nfsly_lock.nfslock_lock |= NFSV4LOCK_WANTED;
4868 (void)mtx_sleep(&lyp->nfsly_lock,
4869 NFSCLSTATEMUTEXPTR, PZERO, "nfslyc", 0);
4872 nfscl_freelayout(lyp);
4877 * Dereference a layout.
4880 nfscl_rellayout(struct nfscllayout *lyp, int exclocked)
4885 nfsv4_unlock(&lyp->nfsly_lock, 0);
4887 nfsv4_relref(&lyp->nfsly_lock);
4892 * Search for a devinfo by deviceid. If one is found, return it after
4893 * acquiring a reference count on it.
4895 struct nfscldevinfo *
4896 nfscl_getdevinfo(struct nfsclclient *clp, uint8_t *deviceid,
4897 struct nfscldevinfo *dip)
4902 dip = nfscl_finddevinfo(clp, deviceid);
4904 dip->nfsdi_refcnt++;
4910 * Dereference a devinfo structure.
4913 nfscl_reldevinfo_locked(struct nfscldevinfo *dip)
4916 dip->nfsdi_refcnt--;
4917 if (dip->nfsdi_refcnt == 0)
4918 wakeup(&dip->nfsdi_refcnt);
4922 * Dereference a devinfo structure.
4925 nfscl_reldevinfo(struct nfscldevinfo *dip)
4929 nfscl_reldevinfo_locked(dip);
4934 * Find a layout for this file handle. Return NULL upon failure.
4936 static struct nfscllayout *
4937 nfscl_findlayout(struct nfsclclient *clp, u_int8_t *fhp, int fhlen)
4939 struct nfscllayout *lyp;
4941 LIST_FOREACH(lyp, NFSCLLAYOUTHASH(clp, fhp, fhlen), nfsly_hash)
4942 if (lyp->nfsly_fhlen == fhlen &&
4943 !NFSBCMP(lyp->nfsly_fh, fhp, fhlen))
4949 * Find a devinfo for this deviceid. Return NULL upon failure.
4951 static struct nfscldevinfo *
4952 nfscl_finddevinfo(struct nfsclclient *clp, uint8_t *deviceid)
4954 struct nfscldevinfo *dip;
4956 LIST_FOREACH(dip, &clp->nfsc_devinfo, nfsdi_list)
4957 if (NFSBCMP(dip->nfsdi_deviceid, deviceid, NFSX_V4DEVICEID)
4964 * Merge the new file layout list into the main one, maintaining it in
4965 * increasing offset order.
4968 nfscl_mergeflayouts(struct nfsclflayouthead *fhlp,
4969 struct nfsclflayouthead *newfhlp)
4971 struct nfsclflayout *flp, *nflp, *prevflp, *tflp;
4973 flp = LIST_FIRST(fhlp);
4975 LIST_FOREACH_SAFE(nflp, newfhlp, nfsfl_list, tflp) {
4976 while (flp != NULL && flp->nfsfl_off < nflp->nfsfl_off) {
4978 flp = LIST_NEXT(flp, nfsfl_list);
4980 if (prevflp == NULL)
4981 LIST_INSERT_HEAD(fhlp, nflp, nfsfl_list);
4983 LIST_INSERT_AFTER(prevflp, nflp, nfsfl_list);
4989 * Add this nfscldevinfo to the client, if it doesn't already exist.
4990 * This function consumes the structure pointed at by dip, if not NULL.
4993 nfscl_adddevinfo(struct nfsmount *nmp, struct nfscldevinfo *dip,
4994 struct nfsclflayout *flp)
4996 struct nfsclclient *clp;
4997 struct nfscldevinfo *tdip;
5004 free(dip, M_NFSDEVINFO);
5007 tdip = nfscl_finddevinfo(clp, flp->nfsfl_dev);
5009 tdip->nfsdi_layoutrefs++;
5010 flp->nfsfl_devp = tdip;
5011 nfscl_reldevinfo_locked(tdip);
5014 free(dip, M_NFSDEVINFO);
5018 LIST_INSERT_HEAD(&clp->nfsc_devinfo, dip, nfsdi_list);
5019 dip->nfsdi_layoutrefs = 1;
5020 flp->nfsfl_devp = dip;
5029 * Free up a layout structure and associated file layout structure(s).
5032 nfscl_freelayout(struct nfscllayout *layp)
5034 struct nfsclflayout *flp, *nflp;
5035 struct nfsclrecalllayout *rp, *nrp;
5037 LIST_FOREACH_SAFE(flp, &layp->nfsly_flayread, nfsfl_list, nflp) {
5038 LIST_REMOVE(flp, nfsfl_list);
5039 nfscl_freeflayout(flp);
5041 LIST_FOREACH_SAFE(flp, &layp->nfsly_flayrw, nfsfl_list, nflp) {
5042 LIST_REMOVE(flp, nfsfl_list);
5043 nfscl_freeflayout(flp);
5045 LIST_FOREACH_SAFE(rp, &layp->nfsly_recall, nfsrecly_list, nrp) {
5046 LIST_REMOVE(rp, nfsrecly_list);
5047 free(rp, M_NFSLAYRECALL);
5050 free(layp, M_NFSLAYOUT);
5054 * Free up a file layout structure.
5057 nfscl_freeflayout(struct nfsclflayout *flp)
5061 for (i = 0; i < flp->nfsfl_fhcnt; i++)
5062 free(flp->nfsfl_fh[i], M_NFSFH);
5063 if (flp->nfsfl_devp != NULL)
5064 flp->nfsfl_devp->nfsdi_layoutrefs--;
5065 free(flp, M_NFSFLAYOUT);
5069 * Free up a file layout devinfo structure.
5072 nfscl_freedevinfo(struct nfscldevinfo *dip)
5075 free(dip, M_NFSDEVINFO);
5079 * Mark any layouts that match as recalled.
5082 nfscl_layoutrecall(int recalltype, struct nfscllayout *lyp, uint32_t iomode,
5083 uint64_t off, uint64_t len, uint32_t stateseqid,
5084 struct nfsclrecalllayout *recallp)
5086 struct nfsclrecalllayout *rp, *orp;
5088 recallp->nfsrecly_recalltype = recalltype;
5089 recallp->nfsrecly_iomode = iomode;
5090 recallp->nfsrecly_stateseqid = stateseqid;
5091 recallp->nfsrecly_off = off;
5092 recallp->nfsrecly_len = len;
5094 * Order the list as file returns first, followed by fsid and any
5095 * returns, both in increasing stateseqid order.
5096 * Note that the seqids wrap around, so 1 is after 0xffffffff.
5097 * (I'm not sure this is correct because I find RFC5661 confusing
5098 * on this, but hopefully it will work ok.)
5101 LIST_FOREACH(rp, &lyp->nfsly_recall, nfsrecly_list) {
5103 if ((recalltype == NFSLAYOUTRETURN_FILE &&
5104 (rp->nfsrecly_recalltype != NFSLAYOUTRETURN_FILE ||
5105 nfscl_seq(stateseqid, rp->nfsrecly_stateseqid) != 0)) ||
5106 (recalltype != NFSLAYOUTRETURN_FILE &&
5107 rp->nfsrecly_recalltype != NFSLAYOUTRETURN_FILE &&
5108 nfscl_seq(stateseqid, rp->nfsrecly_stateseqid) != 0)) {
5109 LIST_INSERT_BEFORE(rp, recallp, nfsrecly_list);
5115 LIST_INSERT_HEAD(&lyp->nfsly_recall, recallp,
5118 LIST_INSERT_AFTER(orp, recallp, nfsrecly_list);
5120 lyp->nfsly_flags |= NFSLY_RECALL;
5125 * Compare the two seqids for ordering. The trick is that the seqids can
5126 * wrap around from 0xffffffff->0, so check for the cases where one
5127 * has wrapped around.
5128 * Return 1 if seqid1 comes before seqid2, 0 otherwise.
5131 nfscl_seq(uint32_t seqid1, uint32_t seqid2)
5134 if (seqid2 > seqid1 && (seqid2 - seqid1) >= 0x7fffffff)
5135 /* seqid2 has wrapped around. */
5137 if (seqid1 > seqid2 && (seqid1 - seqid2) >= 0x7fffffff)
5138 /* seqid1 has wrapped around. */
5140 if (seqid1 <= seqid2)
5146 * Do a layout return for each of the recalls.
5149 nfscl_layoutreturn(struct nfsmount *nmp, struct nfscllayout *lyp,
5150 struct ucred *cred, NFSPROC_T *p)
5152 struct nfsclrecalllayout *rp;
5153 nfsv4stateid_t stateid;
5155 NFSBCOPY(lyp->nfsly_stateid.other, stateid.other, NFSX_STATEIDOTHER);
5156 LIST_FOREACH(rp, &lyp->nfsly_recall, nfsrecly_list) {
5157 stateid.seqid = rp->nfsrecly_stateseqid;
5158 (void)nfsrpc_layoutreturn(nmp, lyp->nfsly_fh,
5159 lyp->nfsly_fhlen, 0, NFSLAYOUT_NFSV4_1_FILES,
5160 rp->nfsrecly_iomode, rp->nfsrecly_recalltype,
5161 rp->nfsrecly_off, rp->nfsrecly_len,
5162 &stateid, 0, NULL, cred, p, NULL);
5167 * Do the layout commit for a file layout.
5170 nfscl_dolayoutcommit(struct nfsmount *nmp, struct nfscllayout *lyp,
5171 struct ucred *cred, NFSPROC_T *p)
5173 struct nfsclflayout *flp;
5177 LIST_FOREACH(flp, &lyp->nfsly_flayrw, nfsfl_list) {
5178 if (flp->nfsfl_off <= lyp->nfsly_lastbyte) {
5179 len = flp->nfsfl_end - flp->nfsfl_off;
5180 error = nfsrpc_layoutcommit(nmp, lyp->nfsly_fh,
5181 lyp->nfsly_fhlen, 0, flp->nfsfl_off, len,
5182 lyp->nfsly_lastbyte, &lyp->nfsly_stateid,
5183 NFSLAYOUT_NFSV4_1_FILES, 0, NULL, cred, p, NULL);
5184 NFSCL_DEBUG(4, "layoutcommit err=%d\n", error);
5185 if (error == NFSERR_NOTSUPP) {
5186 /* If not supported, don't bother doing it. */
5188 nmp->nm_state |= NFSSTA_NOLAYOUTCOMMIT;
5197 * Commit all layouts for a file (vnode).
5200 nfscl_layoutcommit(vnode_t vp, NFSPROC_T *p)
5202 struct nfsclclient *clp;
5203 struct nfscllayout *lyp;
5204 struct nfsnode *np = VTONFS(vp);
5206 struct nfsmount *nmp;
5208 mp = vnode_mount(vp);
5210 if (NFSHASNOLAYOUTCOMMIT(nmp))
5218 lyp = nfscl_findlayout(clp, np->n_fhp->nfh_fh, np->n_fhp->nfh_len);
5223 nfsv4_getref(&lyp->nfsly_lock, NULL, NFSCLSTATEMUTEXPTR, mp);
5224 if ((mp->mnt_kern_flag & MNTK_UNMOUNTF) != 0) {
5229 if ((lyp->nfsly_flags & NFSLY_WRITTEN) != 0) {
5230 lyp->nfsly_flags &= ~NFSLY_WRITTEN;
5232 NFSCL_DEBUG(4, "do layoutcommit2\n");
5233 nfscl_dolayoutcommit(clp->nfsc_nmp, lyp, NFSPROCCRED(p), p);
5237 nfsv4_relref(&lyp->nfsly_lock);