xref: /freebsd/sys/fs/nfs/nfs_commonkrpc.c (revision 70e0bbedef95258a4dadc996d641a9bebd3f107d)
1 /*-
2  * Copyright (c) 1989, 1991, 1993, 1995
3  *	The Regents of the University of California.  All rights reserved.
4  *
5  * This code is derived from software contributed to Berkeley by
6  * Rick Macklem at The University of Guelph.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 4. Neither the name of the University nor the names of its contributors
17  *    may be used to endorse or promote products derived from this software
18  *    without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  * SUCH DAMAGE.
31  *
32  */
33 
34 #include <sys/cdefs.h>
35 __FBSDID("$FreeBSD$");
36 
37 /*
38  * Socket operations for use by nfs
39  */
40 
41 #include "opt_kdtrace.h"
42 #include "opt_kgssapi.h"
43 #include "opt_nfs.h"
44 
45 #include <sys/param.h>
46 #include <sys/systm.h>
47 #include <sys/kernel.h>
48 #include <sys/limits.h>
49 #include <sys/lock.h>
50 #include <sys/malloc.h>
51 #include <sys/mbuf.h>
52 #include <sys/mount.h>
53 #include <sys/mutex.h>
54 #include <sys/proc.h>
55 #include <sys/signalvar.h>
56 #include <sys/syscallsubr.h>
57 #include <sys/sysctl.h>
58 #include <sys/syslog.h>
59 #include <sys/vnode.h>
60 
61 #include <rpc/rpc.h>
62 
63 #include <kgssapi/krb5/kcrypto.h>
64 
65 #include <fs/nfs/nfsport.h>
66 
67 #ifdef KDTRACE_HOOKS
68 #include <sys/dtrace_bsd.h>
69 
70 dtrace_nfsclient_nfs23_start_probe_func_t
71 		dtrace_nfscl_nfs234_start_probe;
72 
73 dtrace_nfsclient_nfs23_done_probe_func_t
74 		dtrace_nfscl_nfs234_done_probe;
75 
76 /*
77  * Registered probes by RPC type.
78  */
79 uint32_t	nfscl_nfs2_start_probes[NFS_NPROCS + 1];
80 uint32_t	nfscl_nfs2_done_probes[NFS_NPROCS + 1];
81 
82 uint32_t	nfscl_nfs3_start_probes[NFS_NPROCS + 1];
83 uint32_t	nfscl_nfs3_done_probes[NFS_NPROCS + 1];
84 
85 uint32_t	nfscl_nfs4_start_probes[NFS_NPROCS + 1];
86 uint32_t	nfscl_nfs4_done_probes[NFS_NPROCS + 1];
87 #endif
88 
89 NFSSTATESPINLOCK;
90 NFSREQSPINLOCK;
91 extern struct nfsstats newnfsstats;
92 extern struct nfsreqhead nfsd_reqq;
93 extern int nfscl_ticks;
94 extern void (*ncl_call_invalcaches)(struct vnode *);
95 
96 static int	nfsrv_gsscallbackson = 0;
97 static int	nfs_bufpackets = 4;
98 static int	nfs_reconnects;
99 static int	nfs3_jukebox_delay = 10;
100 static int	nfs_skip_wcc_data_onerr = 1;
101 static int	nfs_keytab_enctype = ETYPE_DES_CBC_CRC;
102 
103 SYSCTL_DECL(_vfs_nfs);
104 
105 SYSCTL_INT(_vfs_nfs, OID_AUTO, bufpackets, CTLFLAG_RW, &nfs_bufpackets, 0,
106     "Buffer reservation size 2 < x < 64");
107 SYSCTL_INT(_vfs_nfs, OID_AUTO, reconnects, CTLFLAG_RD, &nfs_reconnects, 0,
108     "Number of times the nfs client has had to reconnect");
109 SYSCTL_INT(_vfs_nfs, OID_AUTO, nfs3_jukebox_delay, CTLFLAG_RW, &nfs3_jukebox_delay, 0,
110     "Number of seconds to delay a retry after receiving EJUKEBOX");
111 SYSCTL_INT(_vfs_nfs, OID_AUTO, skip_wcc_data_onerr, CTLFLAG_RW, &nfs_skip_wcc_data_onerr, 0,
112     "Disable weak cache consistency checking when server returns an error");
113 SYSCTL_INT(_vfs_nfs, OID_AUTO, keytab_enctype, CTLFLAG_RW, &nfs_keytab_enctype, 0,
114     "Encryption type for the keytab entry used by nfs");
115 
116 static void	nfs_down(struct nfsmount *, struct thread *, const char *,
117     int, int);
118 static void	nfs_up(struct nfsmount *, struct thread *, const char *,
119     int, int);
120 static int	nfs_msg(struct thread *, const char *, const char *, int);
121 
122 struct nfs_cached_auth {
123 	int		ca_refs; /* refcount, including 1 from the cache */
124 	uid_t		ca_uid;	 /* uid that corresponds to this auth */
125 	AUTH		*ca_auth; /* RPC auth handle */
126 };
127 
128 static int nfsv2_procid[NFS_V3NPROCS] = {
129 	NFSV2PROC_NULL,
130 	NFSV2PROC_GETATTR,
131 	NFSV2PROC_SETATTR,
132 	NFSV2PROC_LOOKUP,
133 	NFSV2PROC_NOOP,
134 	NFSV2PROC_READLINK,
135 	NFSV2PROC_READ,
136 	NFSV2PROC_WRITE,
137 	NFSV2PROC_CREATE,
138 	NFSV2PROC_MKDIR,
139 	NFSV2PROC_SYMLINK,
140 	NFSV2PROC_CREATE,
141 	NFSV2PROC_REMOVE,
142 	NFSV2PROC_RMDIR,
143 	NFSV2PROC_RENAME,
144 	NFSV2PROC_LINK,
145 	NFSV2PROC_READDIR,
146 	NFSV2PROC_NOOP,
147 	NFSV2PROC_STATFS,
148 	NFSV2PROC_NOOP,
149 	NFSV2PROC_NOOP,
150 	NFSV2PROC_NOOP,
151 };
152 
153 /*
154  * Initialize sockets and congestion for a new NFS connection.
155  * We do not free the sockaddr if error.
156  */
157 int
158 newnfs_connect(struct nfsmount *nmp, struct nfssockreq *nrp,
159     struct ucred *cred, NFSPROC_T *p, int callback_retry_mult)
160 {
161 	int rcvreserve, sndreserve;
162 	int pktscale;
163 	struct sockaddr *saddr;
164 	struct ucred *origcred;
165 	CLIENT *client;
166 	struct netconfig *nconf;
167 	struct socket *so;
168 	int one = 1, retries, error = 0;
169 	struct thread *td = curthread;
170 	struct timeval timo;
171 
172 	/*
173 	 * We need to establish the socket using the credentials of
174 	 * the mountpoint.  Some parts of this process (such as
175 	 * sobind() and soconnect()) will use the curent thread's
176 	 * credential instead of the socket credential.  To work
177 	 * around this, temporarily change the current thread's
178 	 * credential to that of the mountpoint.
179 	 *
180 	 * XXX: It would be better to explicitly pass the correct
181 	 * credential to sobind() and soconnect().
182 	 */
183 	origcred = td->td_ucred;
184 
185 	/*
186 	 * Use the credential in nr_cred, if not NULL.
187 	 */
188 	if (nrp->nr_cred != NULL)
189 		td->td_ucred = nrp->nr_cred;
190 	else
191 		td->td_ucred = cred;
192 	saddr = nrp->nr_nam;
193 
194 	if (saddr->sa_family == AF_INET)
195 		if (nrp->nr_sotype == SOCK_DGRAM)
196 			nconf = getnetconfigent("udp");
197 		else
198 			nconf = getnetconfigent("tcp");
199 	else
200 		if (nrp->nr_sotype == SOCK_DGRAM)
201 			nconf = getnetconfigent("udp6");
202 		else
203 			nconf = getnetconfigent("tcp6");
204 
205 	pktscale = nfs_bufpackets;
206 	if (pktscale < 2)
207 		pktscale = 2;
208 	if (pktscale > 64)
209 		pktscale = 64;
210 	/*
211 	 * soreserve() can fail if sb_max is too small, so shrink pktscale
212 	 * and try again if there is an error.
213 	 * Print a log message suggesting increasing sb_max.
214 	 * Creating a socket and doing this is necessary since, if the
215 	 * reservation sizes are too large and will make soreserve() fail,
216 	 * the connection will work until a large send is attempted and
217 	 * then it will loop in the krpc code.
218 	 */
219 	so = NULL;
220 	saddr = NFSSOCKADDR(nrp->nr_nam, struct sockaddr *);
221 	error = socreate(saddr->sa_family, &so, nrp->nr_sotype,
222 	    nrp->nr_soproto, td->td_ucred, td);
223 	if (error) {
224 		td->td_ucred = origcred;
225 		goto out;
226 	}
227 	do {
228 	    if (error != 0 && pktscale > 2)
229 		pktscale--;
230 	    if (nrp->nr_sotype == SOCK_DGRAM) {
231 		if (nmp != NULL) {
232 			sndreserve = (NFS_MAXDGRAMDATA + NFS_MAXPKTHDR) *
233 			    pktscale;
234 			rcvreserve = (NFS_MAXDGRAMDATA + NFS_MAXPKTHDR) *
235 			    pktscale;
236 		} else {
237 			sndreserve = rcvreserve = 1024 * pktscale;
238 		}
239 	    } else {
240 		if (nrp->nr_sotype != SOCK_STREAM)
241 			panic("nfscon sotype");
242 		if (nmp != NULL) {
243 			sndreserve = (NFS_MAXBSIZE + NFS_MAXPKTHDR +
244 			    sizeof (u_int32_t)) * pktscale;
245 			rcvreserve = (NFS_MAXBSIZE + NFS_MAXPKTHDR +
246 			    sizeof (u_int32_t)) * pktscale;
247 		} else {
248 			sndreserve = rcvreserve = 1024 * pktscale;
249 		}
250 	    }
251 	    error = soreserve(so, sndreserve, rcvreserve);
252 	} while (error != 0 && pktscale > 2);
253 	soclose(so);
254 	if (error) {
255 		td->td_ucred = origcred;
256 		goto out;
257 	}
258 
259 	client = clnt_reconnect_create(nconf, saddr, nrp->nr_prog,
260 	    nrp->nr_vers, sndreserve, rcvreserve);
261 	CLNT_CONTROL(client, CLSET_WAITCHAN, "newnfsreq");
262 	if (nmp != NULL) {
263 		if ((nmp->nm_flag & NFSMNT_INT))
264 			CLNT_CONTROL(client, CLSET_INTERRUPTIBLE, &one);
265 		if ((nmp->nm_flag & NFSMNT_RESVPORT))
266 			CLNT_CONTROL(client, CLSET_PRIVPORT, &one);
267 		if (NFSHASSOFT(nmp)) {
268 			if (nmp->nm_sotype == SOCK_DGRAM)
269 				/*
270 				 * For UDP, the large timeout for a reconnect
271 				 * will be set to "nm_retry * nm_timeo / 2", so
272 				 * we only want to do 2 reconnect timeout
273 				 * retries.
274 				 */
275 				retries = 2;
276 			else
277 				retries = nmp->nm_retry;
278 		} else
279 			retries = INT_MAX;
280 	} else {
281 		/*
282 		 * Three cases:
283 		 * - Null RPC callback to client
284 		 * - Non-Null RPC callback to client, wait a little longer
285 		 * - upcalls to nfsuserd and gssd (clp == NULL)
286 		 */
287 		if (callback_retry_mult == 0) {
288 			retries = NFSV4_UPCALLRETRY;
289 			CLNT_CONTROL(client, CLSET_PRIVPORT, &one);
290 		} else {
291 			retries = NFSV4_CALLBACKRETRY * callback_retry_mult;
292 		}
293 	}
294 	CLNT_CONTROL(client, CLSET_RETRIES, &retries);
295 
296 	if (nmp != NULL) {
297 		/*
298 		 * For UDP, there are 2 timeouts:
299 		 * - CLSET_RETRY_TIMEOUT sets the initial timeout for the timer
300 		 *   that does a retransmit of an RPC request using the same
301 		 *   socket and xid. This is what you normally want to do,
302 		 *   since NFS servers depend on "same xid" for their
303 		 *   Duplicate Request Cache.
304 		 * - timeout specified in CLNT_CALL_MBUF(), which specifies when
305 		 *   retransmits on the same socket should fail and a fresh
306 		 *   socket created. Each of these timeouts counts as one
307 		 *   CLSET_RETRIES as set above.
308 		 * Set the initial retransmit timeout for UDP. This timeout
309 		 * doesn't exist for TCP and the following call just fails,
310 		 * which is ok.
311 		 */
312 		timo.tv_sec = nmp->nm_timeo / NFS_HZ;
313 		timo.tv_usec = (nmp->nm_timeo % NFS_HZ) * 1000000 / NFS_HZ;
314 		CLNT_CONTROL(client, CLSET_RETRY_TIMEOUT, &timo);
315 	}
316 
317 	mtx_lock(&nrp->nr_mtx);
318 	if (nrp->nr_client != NULL) {
319 		/*
320 		 * Someone else already connected.
321 		 */
322 		CLNT_RELEASE(client);
323 	} else {
324 		nrp->nr_client = client;
325 	}
326 
327 	/*
328 	 * Protocols that do not require connections may be optionally left
329 	 * unconnected for servers that reply from a port other than NFS_PORT.
330 	 */
331 	if (nmp == NULL || (nmp->nm_flag & NFSMNT_NOCONN) == 0) {
332 		mtx_unlock(&nrp->nr_mtx);
333 		CLNT_CONTROL(client, CLSET_CONNECT, &one);
334 	} else {
335 		mtx_unlock(&nrp->nr_mtx);
336 	}
337 
338 	/* Restore current thread's credentials. */
339 	td->td_ucred = origcred;
340 
341 out:
342 	NFSEXITCODE(error);
343 	return (error);
344 }
345 
346 /*
347  * NFS disconnect. Clean up and unlink.
348  */
349 void
350 newnfs_disconnect(struct nfssockreq *nrp)
351 {
352 	CLIENT *client;
353 
354 	mtx_lock(&nrp->nr_mtx);
355 	if (nrp->nr_client != NULL) {
356 		client = nrp->nr_client;
357 		nrp->nr_client = NULL;
358 		mtx_unlock(&nrp->nr_mtx);
359 		rpc_gss_secpurge_call(client);
360 		CLNT_CLOSE(client);
361 		CLNT_RELEASE(client);
362 	} else {
363 		mtx_unlock(&nrp->nr_mtx);
364 	}
365 }
366 
367 static AUTH *
368 nfs_getauth(struct nfssockreq *nrp, int secflavour, char *clnt_principal,
369     char *srv_principal, gss_OID mech_oid, struct ucred *cred)
370 {
371 	rpc_gss_service_t svc;
372 	AUTH *auth;
373 #ifdef notyet
374 	rpc_gss_options_req_t req_options;
375 #endif
376 
377 	switch (secflavour) {
378 	case RPCSEC_GSS_KRB5:
379 	case RPCSEC_GSS_KRB5I:
380 	case RPCSEC_GSS_KRB5P:
381 		if (!mech_oid) {
382 			if (!rpc_gss_mech_to_oid_call("kerberosv5", &mech_oid))
383 				return (NULL);
384 		}
385 		if (secflavour == RPCSEC_GSS_KRB5)
386 			svc = rpc_gss_svc_none;
387 		else if (secflavour == RPCSEC_GSS_KRB5I)
388 			svc = rpc_gss_svc_integrity;
389 		else
390 			svc = rpc_gss_svc_privacy;
391 #ifdef notyet
392 		req_options.req_flags = GSS_C_MUTUAL_FLAG;
393 		req_options.time_req = 0;
394 		req_options.my_cred = GSS_C_NO_CREDENTIAL;
395 		req_options.input_channel_bindings = NULL;
396 		req_options.enc_type = nfs_keytab_enctype;
397 
398 		auth = rpc_gss_secfind_call(nrp->nr_client, cred,
399 		    clnt_principal, srv_principal, mech_oid, svc,
400 		    &req_options);
401 #else
402 		/*
403 		 * Until changes to the rpcsec_gss code are committed,
404 		 * there is no support for host based initiator
405 		 * principals. As such, that case cannot yet be handled.
406 		 */
407 		if (clnt_principal == NULL)
408 			auth = rpc_gss_secfind_call(nrp->nr_client, cred,
409 			    srv_principal, mech_oid, svc);
410 		else
411 			auth = NULL;
412 #endif
413 		if (auth != NULL)
414 			return (auth);
415 		/* fallthrough */
416 	case AUTH_SYS:
417 	default:
418 		return (authunix_create(cred));
419 
420 	}
421 }
422 
423 /*
424  * Callback from the RPC code to generate up/down notifications.
425  */
426 
427 struct nfs_feedback_arg {
428 	struct nfsmount *nf_mount;
429 	int		nf_lastmsg;	/* last tprintf */
430 	int		nf_tprintfmsg;
431 	struct thread	*nf_td;
432 };
433 
434 static void
435 nfs_feedback(int type, int proc, void *arg)
436 {
437 	struct nfs_feedback_arg *nf = (struct nfs_feedback_arg *) arg;
438 	struct nfsmount *nmp = nf->nf_mount;
439 	struct timeval now;
440 
441 	getmicrouptime(&now);
442 
443 	switch (type) {
444 	case FEEDBACK_REXMIT2:
445 	case FEEDBACK_RECONNECT:
446 		if (nf->nf_lastmsg + nmp->nm_tprintf_delay < now.tv_sec) {
447 			nfs_down(nmp, nf->nf_td,
448 			    "not responding", 0, NFSSTA_TIMEO);
449 			nf->nf_tprintfmsg = TRUE;
450 			nf->nf_lastmsg = now.tv_sec;
451 		}
452 		break;
453 
454 	case FEEDBACK_OK:
455 		nfs_up(nf->nf_mount, nf->nf_td,
456 		    "is alive again", NFSSTA_TIMEO, nf->nf_tprintfmsg);
457 		break;
458 	}
459 }
460 
461 /*
462  * newnfs_request - goes something like this
463  *	- does the rpc by calling the krpc layer
464  *	- break down rpc header and return with nfs reply
465  * nb: always frees up nd_mreq mbuf list
466  */
467 int
468 newnfs_request(struct nfsrv_descript *nd, struct nfsmount *nmp,
469     struct nfsclient *clp, struct nfssockreq *nrp, vnode_t vp,
470     struct thread *td, struct ucred *cred, u_int32_t prog, u_int32_t vers,
471     u_char *retsum, int toplevel, u_int64_t *xidp)
472 {
473 	u_int32_t *tl;
474 	time_t waituntil;
475 	int i, j, set_uid = 0, set_sigset = 0, timeo;
476 	int trycnt, error = 0, usegssname = 0, secflavour = AUTH_SYS;
477 	u_int16_t procnum;
478 	u_int trylater_delay = 1;
479 	struct nfs_feedback_arg nf;
480 	struct timeval timo, now;
481 	AUTH *auth;
482 	struct rpc_callextra ext;
483 	enum clnt_stat stat;
484 	struct nfsreq *rep = NULL;
485 	char *srv_principal = NULL;
486 	uid_t saved_uid = (uid_t)-1;
487 	sigset_t oldset;
488 
489 	if (xidp != NULL)
490 		*xidp = 0;
491 	/* Reject requests while attempting a forced unmount. */
492 	if (nmp != NULL && (nmp->nm_mountp->mnt_kern_flag & MNTK_UNMOUNTF)) {
493 		m_freem(nd->nd_mreq);
494 		return (ESTALE);
495 	}
496 
497 	/* For client side interruptible mounts, mask off the signals. */
498 	if (nmp != NULL && td != NULL && NFSHASINT(nmp)) {
499 		newnfs_set_sigmask(td, &oldset);
500 		set_sigset = 1;
501 	}
502 
503 	/*
504 	 * XXX if not already connected call nfs_connect now. Longer
505 	 * term, change nfs_mount to call nfs_connect unconditionally
506 	 * and let clnt_reconnect_create handle reconnects.
507 	 */
508 	if (nrp->nr_client == NULL)
509 		newnfs_connect(nmp, nrp, cred, td, 0);
510 
511 	/*
512 	 * For a client side mount, nmp is != NULL and clp == NULL. For
513 	 * server calls (callbacks or upcalls), nmp == NULL.
514 	 */
515 	if (clp != NULL) {
516 		NFSLOCKSTATE();
517 		if ((clp->lc_flags & LCL_GSS) && nfsrv_gsscallbackson) {
518 			secflavour = RPCSEC_GSS_KRB5;
519 			if (nd->nd_procnum != NFSPROC_NULL) {
520 				if (clp->lc_flags & LCL_GSSINTEGRITY)
521 					secflavour = RPCSEC_GSS_KRB5I;
522 				else if (clp->lc_flags & LCL_GSSPRIVACY)
523 					secflavour = RPCSEC_GSS_KRB5P;
524 			}
525 		}
526 		NFSUNLOCKSTATE();
527 	} else if (nmp != NULL && NFSHASKERB(nmp) &&
528 	     nd->nd_procnum != NFSPROC_NULL) {
529 		if (NFSHASALLGSSNAME(nmp) && nmp->nm_krbnamelen > 0)
530 			nd->nd_flag |= ND_USEGSSNAME;
531 		if ((nd->nd_flag & ND_USEGSSNAME) != 0) {
532 			/*
533 			 * If there is a client side host based credential,
534 			 * use that, otherwise use the system uid, if set.
535 			 */
536 			if (nmp->nm_krbnamelen > 0) {
537 				usegssname = 1;
538 			} else if (nmp->nm_uid != (uid_t)-1) {
539 				saved_uid = cred->cr_uid;
540 				cred->cr_uid = nmp->nm_uid;
541 				set_uid = 1;
542 			}
543 		} else if (nmp->nm_krbnamelen == 0 &&
544 		    nmp->nm_uid != (uid_t)-1 && cred->cr_uid == (uid_t)0) {
545 			/*
546 			 * If there is no host based principal name and
547 			 * the system uid is set and this is root, use the
548 			 * system uid, since root won't have user
549 			 * credentials in a credentials cache file.
550 			 */
551 			saved_uid = cred->cr_uid;
552 			cred->cr_uid = nmp->nm_uid;
553 			set_uid = 1;
554 		}
555 		if (NFSHASINTEGRITY(nmp))
556 			secflavour = RPCSEC_GSS_KRB5I;
557 		else if (NFSHASPRIVACY(nmp))
558 			secflavour = RPCSEC_GSS_KRB5P;
559 		else
560 			secflavour = RPCSEC_GSS_KRB5;
561 		srv_principal = NFSMNT_SRVKRBNAME(nmp);
562 	} else if (nmp != NULL && !NFSHASKERB(nmp) &&
563 	    nd->nd_procnum != NFSPROC_NULL &&
564 	    (nd->nd_flag & ND_USEGSSNAME) != 0) {
565 		/*
566 		 * Use the uid that did the mount when the RPC is doing
567 		 * NFSv4 system operations, as indicated by the
568 		 * ND_USEGSSNAME flag, for the AUTH_SYS case.
569 		 */
570 		saved_uid = cred->cr_uid;
571 		if (nmp->nm_uid != (uid_t)-1)
572 			cred->cr_uid = nmp->nm_uid;
573 		else
574 			cred->cr_uid = 0;
575 		set_uid = 1;
576 	}
577 
578 	if (nmp != NULL) {
579 		bzero(&nf, sizeof(struct nfs_feedback_arg));
580 		nf.nf_mount = nmp;
581 		nf.nf_td = td;
582 		getmicrouptime(&now);
583 		nf.nf_lastmsg = now.tv_sec -
584 		    ((nmp->nm_tprintf_delay)-(nmp->nm_tprintf_initial_delay));
585 	}
586 
587 	if (nd->nd_procnum == NFSPROC_NULL)
588 		auth = authnone_create();
589 	else if (usegssname)
590 		auth = nfs_getauth(nrp, secflavour, nmp->nm_krbname,
591 		    srv_principal, NULL, cred);
592 	else
593 		auth = nfs_getauth(nrp, secflavour, NULL,
594 		    srv_principal, NULL, cred);
595 	if (set_uid)
596 		cred->cr_uid = saved_uid;
597 	if (auth == NULL) {
598 		m_freem(nd->nd_mreq);
599 		if (set_sigset)
600 			newnfs_restore_sigmask(td, &oldset);
601 		return (EACCES);
602 	}
603 	bzero(&ext, sizeof(ext));
604 	ext.rc_auth = auth;
605 	if (nmp != NULL) {
606 		ext.rc_feedback = nfs_feedback;
607 		ext.rc_feedback_arg = &nf;
608 	}
609 
610 	procnum = nd->nd_procnum;
611 	if ((nd->nd_flag & ND_NFSV4) &&
612 	    nd->nd_procnum != NFSPROC_NULL &&
613 	    nd->nd_procnum != NFSV4PROC_CBCOMPOUND)
614 		procnum = NFSV4PROC_COMPOUND;
615 
616 	if (nmp != NULL) {
617 		NFSINCRGLOBAL(newnfsstats.rpcrequests);
618 
619 		/* Map the procnum to the old NFSv2 one, as required. */
620 		if ((nd->nd_flag & ND_NFSV2) != 0) {
621 			if (nd->nd_procnum < NFS_V3NPROCS)
622 				procnum = nfsv2_procid[nd->nd_procnum];
623 			else
624 				procnum = NFSV2PROC_NOOP;
625 		}
626 
627 		/*
628 		 * Now only used for the R_DONTRECOVER case, but until that is
629 		 * supported within the krpc code, I need to keep a queue of
630 		 * outstanding RPCs for nfsv4 client requests.
631 		 */
632 		if ((nd->nd_flag & ND_NFSV4) && procnum == NFSV4PROC_COMPOUND)
633 			MALLOC(rep, struct nfsreq *, sizeof(struct nfsreq),
634 			    M_NFSDREQ, M_WAITOK);
635 #ifdef KDTRACE_HOOKS
636 		if (dtrace_nfscl_nfs234_start_probe != NULL) {
637 			uint32_t probe_id;
638 			int probe_procnum;
639 
640 			if (nd->nd_flag & ND_NFSV4) {
641 				probe_id =
642 				    nfscl_nfs4_start_probes[nd->nd_procnum];
643 				probe_procnum = nd->nd_procnum;
644 			} else if (nd->nd_flag & ND_NFSV3) {
645 				probe_id = nfscl_nfs3_start_probes[procnum];
646 				probe_procnum = procnum;
647 			} else {
648 				probe_id =
649 				    nfscl_nfs2_start_probes[nd->nd_procnum];
650 				probe_procnum = procnum;
651 			}
652 			if (probe_id != 0)
653 				(dtrace_nfscl_nfs234_start_probe)
654 				    (probe_id, vp, nd->nd_mreq, cred,
655 				     probe_procnum);
656 		}
657 #endif
658 	}
659 	trycnt = 0;
660 tryagain:
661 	/*
662 	 * This timeout specifies when a new socket should be created,
663 	 * along with new xid values. For UDP, this should be done
664 	 * infrequently, since retransmits of RPC requests should normally
665 	 * use the same xid.
666 	 */
667 	if (nmp == NULL) {
668 		timo.tv_usec = 0;
669 		if (clp == NULL)
670 			timo.tv_sec = NFSV4_UPCALLTIMEO;
671 		else
672 			timo.tv_sec = NFSV4_CALLBACKTIMEO;
673 	} else {
674 		if (nrp->nr_sotype != SOCK_DGRAM) {
675 			timo.tv_usec = 0;
676 			if ((nmp->nm_flag & NFSMNT_NFSV4))
677 				timo.tv_sec = INT_MAX;
678 			else
679 				timo.tv_sec = NFS_TCPTIMEO;
680 		} else {
681 			if (NFSHASSOFT(nmp)) {
682 				/*
683 				 * CLSET_RETRIES is set to 2, so this should be
684 				 * half of the total timeout required.
685 				 */
686 				timeo = nmp->nm_retry * nmp->nm_timeo / 2;
687 				if (timeo < 1)
688 					timeo = 1;
689 				timo.tv_sec = timeo / NFS_HZ;
690 				timo.tv_usec = (timeo % NFS_HZ) * 1000000 /
691 				    NFS_HZ;
692 			} else {
693 				/* For UDP hard mounts, use a large value. */
694 				timo.tv_sec = NFS_MAXTIMEO / NFS_HZ;
695 				timo.tv_usec = 0;
696 			}
697 		}
698 
699 		if (rep != NULL) {
700 			rep->r_flags = 0;
701 			rep->r_nmp = nmp;
702 			/*
703 			 * Chain request into list of outstanding requests.
704 			 */
705 			NFSLOCKREQ();
706 			TAILQ_INSERT_TAIL(&nfsd_reqq, rep, r_chain);
707 			NFSUNLOCKREQ();
708 		}
709 	}
710 
711 	nd->nd_mrep = NULL;
712 	stat = CLNT_CALL_MBUF(nrp->nr_client, &ext, procnum, nd->nd_mreq,
713 	    &nd->nd_mrep, timo);
714 
715 	if (rep != NULL) {
716 		/*
717 		 * RPC done, unlink the request.
718 		 */
719 		NFSLOCKREQ();
720 		TAILQ_REMOVE(&nfsd_reqq, rep, r_chain);
721 		NFSUNLOCKREQ();
722 	}
723 
724 	/*
725 	 * If there was a successful reply and a tprintf msg.
726 	 * tprintf a response.
727 	 */
728 	if (stat == RPC_SUCCESS) {
729 		error = 0;
730 	} else if (stat == RPC_TIMEDOUT) {
731 		error = ETIMEDOUT;
732 	} else if (stat == RPC_VERSMISMATCH) {
733 		error = EOPNOTSUPP;
734 	} else if (stat == RPC_PROGVERSMISMATCH) {
735 		error = EPROTONOSUPPORT;
736 	} else {
737 		error = EACCES;
738 	}
739 	if (error) {
740 		m_freem(nd->nd_mreq);
741 		AUTH_DESTROY(auth);
742 		if (rep != NULL)
743 			FREE((caddr_t)rep, M_NFSDREQ);
744 		if (set_sigset)
745 			newnfs_restore_sigmask(td, &oldset);
746 		return (error);
747 	}
748 
749 	KASSERT(nd->nd_mrep != NULL, ("mrep shouldn't be NULL if no error\n"));
750 
751 	/*
752 	 * Search for any mbufs that are not a multiple of 4 bytes long
753 	 * or with m_data not longword aligned.
754 	 * These could cause pointer alignment problems, so copy them to
755 	 * well aligned mbufs.
756 	 */
757 	newnfs_realign(&nd->nd_mrep);
758 	nd->nd_md = nd->nd_mrep;
759 	nd->nd_dpos = NFSMTOD(nd->nd_md, caddr_t);
760 	nd->nd_repstat = 0;
761 	if (nd->nd_procnum != NFSPROC_NULL) {
762 		/*
763 		 * and now the actual NFS xdr.
764 		 */
765 		NFSM_DISSECT(tl, u_int32_t *, NFSX_UNSIGNED);
766 		nd->nd_repstat = fxdr_unsigned(u_int32_t, *tl);
767 		if (nd->nd_repstat != 0) {
768 			if (((nd->nd_repstat == NFSERR_DELAY ||
769 			      nd->nd_repstat == NFSERR_GRACE) &&
770 			     (nd->nd_flag & ND_NFSV4) &&
771 			     nd->nd_procnum != NFSPROC_DELEGRETURN &&
772 			     nd->nd_procnum != NFSPROC_SETATTR &&
773 			     nd->nd_procnum != NFSPROC_READ &&
774 			     nd->nd_procnum != NFSPROC_WRITE &&
775 			     nd->nd_procnum != NFSPROC_OPEN &&
776 			     nd->nd_procnum != NFSPROC_CREATE &&
777 			     nd->nd_procnum != NFSPROC_OPENCONFIRM &&
778 			     nd->nd_procnum != NFSPROC_OPENDOWNGRADE &&
779 			     nd->nd_procnum != NFSPROC_CLOSE &&
780 			     nd->nd_procnum != NFSPROC_LOCK &&
781 			     nd->nd_procnum != NFSPROC_LOCKU) ||
782 			    (nd->nd_repstat == NFSERR_DELAY &&
783 			     (nd->nd_flag & ND_NFSV4) == 0) ||
784 			    nd->nd_repstat == NFSERR_RESOURCE) {
785 				if (trylater_delay > NFS_TRYLATERDEL)
786 					trylater_delay = NFS_TRYLATERDEL;
787 				waituntil = NFSD_MONOSEC + trylater_delay;
788 				while (NFSD_MONOSEC < waituntil)
789 					(void) nfs_catnap(PZERO, 0, "nfstry");
790 				trylater_delay *= 2;
791 				m_freem(nd->nd_mrep);
792 				nd->nd_mrep = NULL;
793 				goto tryagain;
794 			}
795 
796 			/*
797 			 * If the File Handle was stale, invalidate the
798 			 * lookup cache, just in case.
799 			 * (vp != NULL implies a client side call)
800 			 */
801 			if (nd->nd_repstat == ESTALE && vp != NULL) {
802 				cache_purge(vp);
803 				if (ncl_call_invalcaches != NULL)
804 					(*ncl_call_invalcaches)(vp);
805 			}
806 		}
807 
808 		/*
809 		 * Get rid of the tag, return count, and PUTFH result for V4.
810 		 */
811 		if (nd->nd_flag & ND_NFSV4) {
812 			NFSM_DISSECT(tl, u_int32_t *, NFSX_UNSIGNED);
813 			i = fxdr_unsigned(int, *tl);
814 			error = nfsm_advance(nd, NFSM_RNDUP(i), -1);
815 			if (error)
816 				goto nfsmout;
817 			NFSM_DISSECT(tl, u_int32_t *, 3 * NFSX_UNSIGNED);
818 			i = fxdr_unsigned(int, *++tl);
819 
820 			/*
821 			 * If the first op's status is non-zero, mark that
822 			 * there is no more data to process.
823 			 */
824 			if (*++tl)
825 				nd->nd_flag |= ND_NOMOREDATA;
826 
827 			/*
828 			 * If the first op is Putfh, throw its results away
829 			 * and toss the op# and status for the first op.
830 			 */
831 			if (nmp != NULL && i == NFSV4OP_PUTFH && *tl == 0) {
832 				NFSM_DISSECT(tl,u_int32_t *,2 * NFSX_UNSIGNED);
833 				i = fxdr_unsigned(int, *tl++);
834 				j = fxdr_unsigned(int, *tl);
835 				/*
836 				 * All Compounds that do an Op that must
837 				 * be in sequence consist of NFSV4OP_PUTFH
838 				 * followed by one of these. As such, we
839 				 * can determine if the seqid# should be
840 				 * incremented, here.
841 				 */
842 				if ((i == NFSV4OP_OPEN ||
843 				     i == NFSV4OP_OPENCONFIRM ||
844 				     i == NFSV4OP_OPENDOWNGRADE ||
845 				     i == NFSV4OP_CLOSE ||
846 				     i == NFSV4OP_LOCK ||
847 				     i == NFSV4OP_LOCKU) &&
848 				    (j == 0 ||
849 				     (j != NFSERR_STALECLIENTID &&
850 				      j != NFSERR_STALESTATEID &&
851 				      j != NFSERR_BADSTATEID &&
852 				      j != NFSERR_BADSEQID &&
853 				      j != NFSERR_BADXDR &&
854 				      j != NFSERR_RESOURCE &&
855 				      j != NFSERR_NOFILEHANDLE)))
856 					nd->nd_flag |= ND_INCRSEQID;
857 				/*
858 				 * If the first op's status is non-zero, mark
859 				 * that there is no more data to process.
860 				 */
861 				if (j)
862 					nd->nd_flag |= ND_NOMOREDATA;
863 			}
864 
865 			/*
866 			 * If R_DONTRECOVER is set, replace the stale error
867 			 * reply, so that recovery isn't initiated.
868 			 */
869 			if ((nd->nd_repstat == NFSERR_STALECLIENTID ||
870 			     nd->nd_repstat == NFSERR_STALESTATEID) &&
871 			    rep != NULL && (rep->r_flags & R_DONTRECOVER))
872 				nd->nd_repstat = NFSERR_STALEDONTRECOVER;
873 		}
874 	}
875 
876 #ifdef KDTRACE_HOOKS
877 	if (nmp != NULL && dtrace_nfscl_nfs234_done_probe != NULL) {
878 		uint32_t probe_id;
879 		int probe_procnum;
880 
881 		if (nd->nd_flag & ND_NFSV4) {
882 			probe_id = nfscl_nfs4_done_probes[nd->nd_procnum];
883 			probe_procnum = nd->nd_procnum;
884 		} else if (nd->nd_flag & ND_NFSV3) {
885 			probe_id = nfscl_nfs3_done_probes[procnum];
886 			probe_procnum = procnum;
887 		} else {
888 			probe_id = nfscl_nfs2_done_probes[nd->nd_procnum];
889 			probe_procnum = procnum;
890 		}
891 		if (probe_id != 0)
892 			(dtrace_nfscl_nfs234_done_probe)(probe_id, vp,
893 			    nd->nd_mreq, cred, probe_procnum, 0);
894 	}
895 #endif
896 
897 	m_freem(nd->nd_mreq);
898 	AUTH_DESTROY(auth);
899 	if (rep != NULL)
900 		FREE((caddr_t)rep, M_NFSDREQ);
901 	if (set_sigset)
902 		newnfs_restore_sigmask(td, &oldset);
903 	return (0);
904 nfsmout:
905 	mbuf_freem(nd->nd_mrep);
906 	mbuf_freem(nd->nd_mreq);
907 	AUTH_DESTROY(auth);
908 	if (rep != NULL)
909 		FREE((caddr_t)rep, M_NFSDREQ);
910 	if (set_sigset)
911 		newnfs_restore_sigmask(td, &oldset);
912 	return (error);
913 }
914 
915 /*
916  * Mark all of an nfs mount's outstanding requests with R_SOFTTERM and
917  * wait for all requests to complete. This is used by forced unmounts
918  * to terminate any outstanding RPCs.
919  */
920 int
921 newnfs_nmcancelreqs(struct nfsmount *nmp)
922 {
923 
924 	if (nmp->nm_sockreq.nr_client != NULL)
925 		CLNT_CLOSE(nmp->nm_sockreq.nr_client);
926 	return (0);
927 }
928 
929 /*
930  * Any signal that can interrupt an NFS operation in an intr mount
931  * should be added to this set. SIGSTOP and SIGKILL cannot be masked.
932  */
933 int newnfs_sig_set[] = {
934 	SIGINT,
935 	SIGTERM,
936 	SIGHUP,
937 	SIGKILL,
938 	SIGSTOP,
939 	SIGQUIT
940 };
941 
942 /*
943  * Check to see if one of the signals in our subset is pending on
944  * the process (in an intr mount).
945  */
946 static int
947 nfs_sig_pending(sigset_t set)
948 {
949 	int i;
950 
951 	for (i = 0 ; i < sizeof(newnfs_sig_set)/sizeof(int) ; i++)
952 		if (SIGISMEMBER(set, newnfs_sig_set[i]))
953 			return (1);
954 	return (0);
955 }
956 
957 /*
958  * The set/restore sigmask functions are used to (temporarily) overwrite
959  * the process p_sigmask during an RPC call (for example). These are also
960  * used in other places in the NFS client that might tsleep().
961  */
962 void
963 newnfs_set_sigmask(struct thread *td, sigset_t *oldset)
964 {
965 	sigset_t newset;
966 	int i;
967 	struct proc *p;
968 
969 	SIGFILLSET(newset);
970 	if (td == NULL)
971 		td = curthread; /* XXX */
972 	p = td->td_proc;
973 	/* Remove the NFS set of signals from newset */
974 	PROC_LOCK(p);
975 	mtx_lock(&p->p_sigacts->ps_mtx);
976 	for (i = 0 ; i < sizeof(newnfs_sig_set)/sizeof(int) ; i++) {
977 		/*
978 		 * But make sure we leave the ones already masked
979 		 * by the process, ie. remove the signal from the
980 		 * temporary signalmask only if it wasn't already
981 		 * in p_sigmask.
982 		 */
983 		if (!SIGISMEMBER(td->td_sigmask, newnfs_sig_set[i]) &&
984 		    !SIGISMEMBER(p->p_sigacts->ps_sigignore, newnfs_sig_set[i]))
985 			SIGDELSET(newset, newnfs_sig_set[i]);
986 	}
987 	mtx_unlock(&p->p_sigacts->ps_mtx);
988 	PROC_UNLOCK(p);
989 	kern_sigprocmask(td, SIG_SETMASK, &newset, oldset, 0);
990 }
991 
992 void
993 newnfs_restore_sigmask(struct thread *td, sigset_t *set)
994 {
995 	if (td == NULL)
996 		td = curthread; /* XXX */
997 	kern_sigprocmask(td, SIG_SETMASK, set, NULL, 0);
998 }
999 
1000 /*
1001  * NFS wrapper to msleep(), that shoves a new p_sigmask and restores the
1002  * old one after msleep() returns.
1003  */
1004 int
1005 newnfs_msleep(struct thread *td, void *ident, struct mtx *mtx, int priority, char *wmesg, int timo)
1006 {
1007 	sigset_t oldset;
1008 	int error;
1009 	struct proc *p;
1010 
1011 	if ((priority & PCATCH) == 0)
1012 		return msleep(ident, mtx, priority, wmesg, timo);
1013 	if (td == NULL)
1014 		td = curthread; /* XXX */
1015 	newnfs_set_sigmask(td, &oldset);
1016 	error = msleep(ident, mtx, priority, wmesg, timo);
1017 	newnfs_restore_sigmask(td, &oldset);
1018 	p = td->td_proc;
1019 	return (error);
1020 }
1021 
1022 /*
1023  * Test for a termination condition pending on the process.
1024  * This is used for NFSMNT_INT mounts.
1025  */
1026 int
1027 newnfs_sigintr(struct nfsmount *nmp, struct thread *td)
1028 {
1029 	struct proc *p;
1030 	sigset_t tmpset;
1031 
1032 	/* Terminate all requests while attempting a forced unmount. */
1033 	if (nmp->nm_mountp->mnt_kern_flag & MNTK_UNMOUNTF)
1034 		return (EIO);
1035 	if (!(nmp->nm_flag & NFSMNT_INT))
1036 		return (0);
1037 	if (td == NULL)
1038 		return (0);
1039 	p = td->td_proc;
1040 	PROC_LOCK(p);
1041 	tmpset = p->p_siglist;
1042 	SIGSETOR(tmpset, td->td_siglist);
1043 	SIGSETNAND(tmpset, td->td_sigmask);
1044 	mtx_lock(&p->p_sigacts->ps_mtx);
1045 	SIGSETNAND(tmpset, p->p_sigacts->ps_sigignore);
1046 	mtx_unlock(&p->p_sigacts->ps_mtx);
1047 	if ((SIGNOTEMPTY(p->p_siglist) || SIGNOTEMPTY(td->td_siglist))
1048 	    && nfs_sig_pending(tmpset)) {
1049 		PROC_UNLOCK(p);
1050 		return (EINTR);
1051 	}
1052 	PROC_UNLOCK(p);
1053 	return (0);
1054 }
1055 
1056 static int
1057 nfs_msg(struct thread *td, const char *server, const char *msg, int error)
1058 {
1059 	struct proc *p;
1060 
1061 	p = td ? td->td_proc : NULL;
1062 	if (error) {
1063 		tprintf(p, LOG_INFO, "newnfs server %s: %s, error %d\n",
1064 		    server, msg, error);
1065 	} else {
1066 		tprintf(p, LOG_INFO, "newnfs server %s: %s\n", server, msg);
1067 	}
1068 	return (0);
1069 }
1070 
1071 static void
1072 nfs_down(struct nfsmount *nmp, struct thread *td, const char *msg,
1073     int error, int flags)
1074 {
1075 	if (nmp == NULL)
1076 		return;
1077 	mtx_lock(&nmp->nm_mtx);
1078 	if ((flags & NFSSTA_TIMEO) && !(nmp->nm_state & NFSSTA_TIMEO)) {
1079 		nmp->nm_state |= NFSSTA_TIMEO;
1080 		mtx_unlock(&nmp->nm_mtx);
1081 		vfs_event_signal(&nmp->nm_mountp->mnt_stat.f_fsid,
1082 		    VQ_NOTRESP, 0);
1083 	} else
1084 		mtx_unlock(&nmp->nm_mtx);
1085 	mtx_lock(&nmp->nm_mtx);
1086 	if ((flags & NFSSTA_LOCKTIMEO) && !(nmp->nm_state & NFSSTA_LOCKTIMEO)) {
1087 		nmp->nm_state |= NFSSTA_LOCKTIMEO;
1088 		mtx_unlock(&nmp->nm_mtx);
1089 		vfs_event_signal(&nmp->nm_mountp->mnt_stat.f_fsid,
1090 		    VQ_NOTRESPLOCK, 0);
1091 	} else
1092 		mtx_unlock(&nmp->nm_mtx);
1093 	nfs_msg(td, nmp->nm_mountp->mnt_stat.f_mntfromname, msg, error);
1094 }
1095 
1096 static void
1097 nfs_up(struct nfsmount *nmp, struct thread *td, const char *msg,
1098     int flags, int tprintfmsg)
1099 {
1100 	if (nmp == NULL)
1101 		return;
1102 	if (tprintfmsg) {
1103 		nfs_msg(td, nmp->nm_mountp->mnt_stat.f_mntfromname, msg, 0);
1104 	}
1105 
1106 	mtx_lock(&nmp->nm_mtx);
1107 	if ((flags & NFSSTA_TIMEO) && (nmp->nm_state & NFSSTA_TIMEO)) {
1108 		nmp->nm_state &= ~NFSSTA_TIMEO;
1109 		mtx_unlock(&nmp->nm_mtx);
1110 		vfs_event_signal(&nmp->nm_mountp->mnt_stat.f_fsid,
1111 		    VQ_NOTRESP, 1);
1112 	} else
1113 		mtx_unlock(&nmp->nm_mtx);
1114 
1115 	mtx_lock(&nmp->nm_mtx);
1116 	if ((flags & NFSSTA_LOCKTIMEO) && (nmp->nm_state & NFSSTA_LOCKTIMEO)) {
1117 		nmp->nm_state &= ~NFSSTA_LOCKTIMEO;
1118 		mtx_unlock(&nmp->nm_mtx);
1119 		vfs_event_signal(&nmp->nm_mountp->mnt_stat.f_fsid,
1120 		    VQ_NOTRESPLOCK, 1);
1121 	} else
1122 		mtx_unlock(&nmp->nm_mtx);
1123 }
1124 
1125