/* $NetBSD: nfs_syscalls.c,v 1.164 2024/07/05 04:31:54 rin Exp $ */
/*
* Copyright (c) 1989, 1993
* The Regents of the University of California. All rights reserved.
*
* This code is derived from software contributed to Berkeley by
* Rick Macklem at The University of Guelph.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. Neither the name of the University nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
* @(#)nfs_syscalls.c 8.5 (Berkeley) 3/30/95
*/
if (n->nfsd_cookie < *k)
return -1;
if (n->nfsd_cookie > *k)
return +1;
return 0;
}
/*
* nfsd_bake_cookie(nfsd)
*
* Bake a cookie for nfsd, hang it on the tree of nfsds, and
* return a userland-safe pointer nfsdu neatly packed for
* transport in struct nfsd_srvargs::nsd_nfsd.
*/
static struct nfsd *
nfsd_bake_cookie(struct nfsd *nfsd)
{
KASSERT(mutex_owned(&nfsd_lock));
do {
nfsd->nfsd_cookie = cprng_fast32();
} while (nfsd->nfsd_cookie == 0 ||
rb_tree_insert_node(&nfsd_tree, nfsd) != nfsd);
/*
* nfsd_get(nfsdu)
*
* Return the struct nfsd pointer for the userland nfsdu cookie,
* as stored in struct nfsd_srvargs::nsd_nfsd, or NULL if nfsdu is
* not a current valid nfsd cookie.
*
* Caller MUST NOT hold nfsd_lock. Caller MUST NOT pass (struct
* nfsd *)(uintptr_t)0, which is the sentinel value for no nfsd
* cookie, for which the caller should check first.
*/
static struct nfsd *
nfsd_get(struct nfsd *nfsdu)
{
uintptr_t cookie = (uintptr_t)nfsdu;
uint32_t key;
struct nfsd *nfsd;
/*
* Nfs server pseudo system call for the nfsd's
* Based on the flag value it either:
* - adds a socket to the selection list
* - remains in the kernel as an nfsd
* - remains in the kernel as an nfsiod
*/
int
sys_nfssvc(struct lwp *l, const struct sys_nfssvc_args *uap, register_t *retval)
{
/* {
syscallarg(int) flag;
syscallarg(void *) argp;
} */
int flag = SCARG(uap, flag);
void *argp = SCARG(uap, argp);
/*
* Adds a socket to the list for servicing by nfsds.
*/
int
nfssvc_addsock(file_t *fp, struct mbuf *mynam)
{
int siz;
struct nfssvc_sock *slp;
struct socket *so;
struct nfssvc_sock *tslp;
int error;
int val;
so = fp->f_socket;
tslp = (struct nfssvc_sock *)0;
/*
* Add it to the list, as required.
*/
if (so->so_proto->pr_protocol == IPPROTO_UDP) {
if (so->so_proto->pr_domain->dom_family == AF_INET6)
tslp = nfs_udp6sock;
else {
tslp = nfs_udpsock;
if (tslp->ns_flags & SLP_VALID) {
m_freem(mynam);
return (EPERM);
}
}
}
if (so->so_type == SOCK_STREAM)
siz = NFS_MAXPACKET + sizeof (u_long);
else
siz = NFS_MAXPACKET;
solock(so);
error = soreserve(so, siz, siz);
sounlock(so);
if (error) {
m_freem(mynam);
return (error);
}
/*
* Set protocol specific options { for now TCP only } and
* reserve some space. For datagram sockets, this can get called
* repeatedly for the same socket, but that isn't harmful.
*/
if (so->so_type == SOCK_STREAM) {
val = 1;
so_setsockopt(NULL, so, SOL_SOCKET, SO_KEEPALIVE, &val,
sizeof(val));
}
if ((so->so_proto->pr_domain->dom_family == AF_INET ||
so->so_proto->pr_domain->dom_family == AF_INET6) &&
so->so_proto->pr_protocol == IPPROTO_TCP) {
val = 1;
so_setsockopt(NULL, so, IPPROTO_TCP, TCP_NODELAY, &val,
sizeof(val));
}
solock(so);
so->so_rcv.sb_flags &= ~SB_NOINTR;
so->so_rcv.sb_timeo = 0;
so->so_snd.sb_flags &= ~SB_NOINTR;
so->so_snd.sb_timeo = 0;
sounlock(so);
if (tslp) {
slp = tslp;
} else {
slp = nfsrv_sockalloc();
}
slp->ns_so = so;
slp->ns_nam = mynam;
mutex_enter(&fp->f_lock);
fp->f_count++;
mutex_exit(&fp->f_lock);
slp->ns_fp = fp;
slp->ns_flags = SLP_VALID;
slp->ns_aflags = SLP_A_NEEDQ;
slp->ns_gflags = 0;
slp->ns_sflags = 0;
solock(so);
so->so_upcallarg = (void *)slp;
so->so_upcall = nfsrv_soupcall;
so->so_rcv.sb_flags |= SB_UPCALL;
sounlock(so);
nfsrv_wakenfsd(slp);
return (0);
}
/*
* Called by nfssvc() for nfsds. Just loops around servicing rpc requests
* until it is killed by a signal.
*/
static int
nfssvc_nfsd(struct nfssvc_copy_ops *ops, struct nfsd_srvargs *nsd,
void *argp, struct lwp *l)
{
struct timeval tv;
struct mbuf *m;
struct nfssvc_sock *slp;
struct nfsd *nfsd;
struct nfsrv_descript *nd = NULL;
struct mbuf *mreq;
u_quad_t cur_usec;
int error = 0, cacherep, siz, sotype, writes_todo;
struct proc *p = l->l_proc;
bool doreinit;
#ifndef nolint
cacherep = RC_DOIT;
writes_todo = 0;
#endif
/*
* If userland didn't provide an nfsd cookie, bake a fresh one;
* if they did provide one, look it up.
*/
if ((uintptr_t)nsd->nsd_nfsd == 0) {
nfsd = kmem_alloc(sizeof(*nfsd), KM_SLEEP);
memset(nfsd, 0, sizeof (struct nfsd));
cv_init(&nfsd->nfsd_cv, "nfsd");
nfsd->nfsd_procp = p;
mutex_enter(&nfsd_lock);
while ((nfssvc_sockhead_flag & SLP_INIT) != 0) {
KASSERT(nfs_numnfsd == 0);
cv_wait(&nfsd_initcv, &nfsd_lock);
}
nsd->nsd_nfsd = nfsd_bake_cookie(nfsd);
nfs_numnfsd++;
mutex_exit(&nfsd_lock);
} else if ((nfsd = nfsd_get(nsd->nsd_nfsd)) == NULL) {
return (EINVAL);
}
KASSERT(nfsd != NULL);
KASSERT(nsd->nsd_nfsd != (struct nfsd *)(uintptr_t)0);
/*
* Loop getting rpc requests until SIGKILL.
*/
for (;;) {
bool dummy;
/*
* Loop to get all the write rpc relies that have been
* gathered together.
*/
do {
switch (cacherep) {
case RC_DOIT:
mreq = NULL;
netexport_rdlock();
if (writes_todo || nd == NULL ||
(!(nd->nd_flag & ND_NFSV3) &&
nd->nd_procnum == NFSPROC_WRITE &&
nfsrvw_procrastinate > 0))
error = nfsrv_writegather(&nd, slp,
l, &mreq);
else
error =
(*(nfsrv3_procs[nd->nd_procnum]))
(nd, slp, l, &mreq);
netexport_rdunlock();
if (mreq == NULL) {
if (nd != NULL) {
if (nd->nd_nam2)
m_free(nd->nd_nam2);
}
break;
}
if (error) {
nfsstats.srv_errs++;
if (nd) {
nfsrv_updatecache(nd, false,
mreq);
m_freem(nd->nd_nam2);
}
break;
}
if (nd) {
nfsstats.srvrpccnt[nd->nd_procnum]++;
nfsrv_updatecache(nd, true, mreq);
nd->nd_mrep = NULL;
}
/* FALLTHROUGH */
case RC_REPLY:
m = mreq;
siz = 0;
while (m) {
siz += m->m_len;
m = m->m_next;
}
if (siz <= 0 || siz > NFS_MAXPACKET) {
printf("mbuf siz=%d\n",siz);
panic("Bad nfs svc reply");
}
m = mreq;
m->m_pkthdr.len = siz;
m_reset_rcvif(m);
/*
* For stream protocols, prepend a Sun RPC
* Record Mark.
*/
if (sotype == SOCK_STREAM) {
M_PREPEND(m, NFSX_UNSIGNED, M_WAIT);
*mtod(m, u_int32_t *) =
htonl(0x80000000 | siz);
}
if (nd) {
nd->nd_mreq = m;
if (nfsrtton) {
nfsd_rt(slp->ns_so->so_type, nd,
cacherep);
}
error = nfsdsock_sendreply(slp, nd);
nd = NULL;
}
if (error == EPIPE)
nfsrv_zapsock(slp);
if (error == EINTR || error == ERESTART) {
nfsd->nfsd_slp = NULL;
nfsrv_slpderef(slp);
goto done;
}
break;
case RC_DROPIT:
if (nd) {
if (nfsrtton)
nfsd_rt(sotype, nd, cacherep);
m_freem(nd->nd_mrep);
m_freem(nd->nd_nam2);
}
break;
}
if (nd) {
nfsdreq_free(nd);
nd = NULL;
}
/*
* Check to see if there are outstanding writes that
* need to be serviced.
*/
getmicrotime(&tv);
cur_usec = (u_quad_t)tv.tv_sec * 1000000 +
(u_quad_t)tv.tv_usec;
mutex_enter(&nfsd_lock);
if (LIST_FIRST(&slp->ns_tq) &&
LIST_FIRST(&slp->ns_tq)->nd_time <= cur_usec) {
cacherep = RC_DOIT;
writes_todo = 1;
} else
writes_todo = 0;
mutex_exit(&nfsd_lock);
} while (writes_todo);
if (nfsrv_dorec(slp, nfsd, &nd, &dummy)) {
nfsd->nfsd_slp = NULL;
nfsrv_slpderef(slp);
}
}
done:
mutex_enter(&nfsd_lock);
nfsd_toss_cookie(nfsd);
doreinit = --nfs_numnfsd == 0;
if (doreinit)
nfssvc_sockhead_flag |= SLP_INIT;
mutex_exit(&nfsd_lock);
cv_destroy(&nfsd->nfsd_cv);
kmem_free(nfsd, sizeof(*nfsd));
KASSERT(nsd->nsd_nfsd != (struct nfsd *)(uintptr_t)0);
nsd->nsd_nfsd = (struct nfsd *)(uintptr_t)0;
if (doreinit)
nfsrv_init(true); /* Reinitialize everything */
return (error);
}
/*
* Shut down a socket associated with an nfssvc_sock structure.
* Should be called with the send lock set, if required.
* The trick here is to increment the sref at the start, so that the nfsds
* will stop using it and clear ns_flag at the end so that it will not be
* reassigned during cleanup.
*
* called at splsoftnet.
*/
void
nfsrv_zapsock(struct nfssvc_sock *slp)
{
struct nfsuid *nuidp, *nnuidp;
struct nfsrv_descript *nwp;
struct socket *so;
struct mbuf *m;
if (nfsdsock_drain(slp)) {
return;
}
mutex_enter(&nfsd_lock);
if (slp->ns_gflags & SLP_G_DOREC) {
TAILQ_REMOVE(&nfssvc_sockpending, slp, ns_pending);
slp->ns_gflags &= ~SLP_G_DOREC;
}
mutex_exit(&nfsd_lock);
m_freem(slp->ns_raw);
m = slp->ns_rec;
while (m != NULL) {
struct mbuf *n;
n = m->m_nextpkt;
m_freem(m);
m = n;
}
/* XXX what about freeing ns_frag ? */
for (nuidp = TAILQ_FIRST(&slp->ns_uidlruhead); nuidp != 0;
nuidp = nnuidp) {
nnuidp = TAILQ_NEXT(nuidp, nu_lru);
LIST_REMOVE(nuidp, nu_hash);
TAILQ_REMOVE(&slp->ns_uidlruhead, nuidp, nu_lru);
if (nuidp->nu_flag & NU_NAM)
m_freem(nuidp->nu_nam);
kmem_free(nuidp, sizeof(*nuidp));
}
mutex_enter(&nfsd_lock);
while ((nwp = LIST_FIRST(&slp->ns_tq)) != NULL) {
LIST_REMOVE(nwp, nd_tq);
mutex_exit(&nfsd_lock);
nfsdreq_free(nwp);
mutex_enter(&nfsd_lock);
}
mutex_exit(&nfsd_lock);
}
/*
* Derefence a server socket structure. If it has no more references and
* is no longer valid, you can throw it away.
*/
void
nfsrv_slpderef(struct nfssvc_sock *slp)
{
uint32_t ref;
if (slp->ns_nam)
m_free(slp->ns_nam);
nfsrv_sockfree(slp);
} else
mutex_exit(&nfsd_lock);
}
/*
* Initialize the data structures for the server.
* Handshake with any new nfsds starting up to avoid any chance of
* corruption.
*/
void
nfsrv_init(int terminating)
{
struct nfssvc_sock *slp;
if (!terminating) {
mutex_init(&nfsd_lock, MUTEX_DRIVER, IPL_SOFTNET);
cv_init(&nfsd_initcv, "nfsdinit");
}