440 lines
15 KiB
C
440 lines
15 KiB
C
/*
|
|
* Copyright (c) 1989, 1993, 1995
|
|
* 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. All advertising materials mentioning features or use of this software
|
|
* must display the following acknowledgement:
|
|
* This product includes software developed by the University of
|
|
* California, Berkeley and its contributors.
|
|
* 4. 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.h 8.4 (Berkeley) 5/1/95
|
|
* $FreeBSD$
|
|
*/
|
|
|
|
#ifndef _NFSSERVER_NFS_H_
|
|
#define _NFSSERVER_NFS_H_
|
|
|
|
#ifdef _KERNEL
|
|
#include "opt_nfs.h"
|
|
#endif
|
|
|
|
/*
|
|
* Tunable constants for nfs
|
|
*/
|
|
|
|
#define NFS_TICKINTVL 5 /* Desired time for a tick (msec) */
|
|
#define NFS_HZ (hz / nfs_ticks) /* Ticks/sec */
|
|
#define NFS_TIMEO (1 * NFS_HZ) /* Default timeout = 1 second */
|
|
#define NFS_MINTIMEO (1 * NFS_HZ) /* Min timeout to use */
|
|
#define NFS_MAXTIMEO (60 * NFS_HZ) /* Max timeout to backoff to */
|
|
#define NFS_MINIDEMTIMEO (5 * NFS_HZ) /* Min timeout for non-idempotent ops*/
|
|
#define NFS_MAXUIDHASH 64 /* Max. # of hashed uid entries/mp */
|
|
#ifndef NFS_GATHERDELAY
|
|
#define NFS_GATHERDELAY 10 /* Default write gather delay (msec) */
|
|
#endif
|
|
#ifdef _KERNEL
|
|
#define DIRBLKSIZ 512 /* XXX we used to use ufs's DIRBLKSIZ */
|
|
#endif
|
|
|
|
/*
|
|
* Oddballs
|
|
*/
|
|
#define NFS_SRVMAXDATA(n) \
|
|
(((n)->nd_flag & ND_NFSV3) ? (((n)->nd_nam2) ? \
|
|
NFS_MAXDGRAMDATA : NFS_MAXDATA) : NFS_V2MAXDATA)
|
|
|
|
/*
|
|
* XXX
|
|
* The B_INVAFTERWRITE flag should be set to whatever is required by the
|
|
* buffer cache code to say "Invalidate the block after it is written back".
|
|
*/
|
|
#define B_INVAFTERWRITE B_NOCACHE
|
|
|
|
/*
|
|
* The IO_METASYNC flag should be implemented for local file systems.
|
|
* (Until then, it is nothin at all.)
|
|
*/
|
|
#ifndef IO_METASYNC
|
|
#define IO_METASYNC 0
|
|
#endif
|
|
|
|
|
|
/* NFS state flags XXX -Wunused */
|
|
#define NFSRV_SNDLOCK 0x01000000 /* Send socket lock */
|
|
#define NFSRV_WANTSND 0x02000000 /* Want above */
|
|
|
|
/*
|
|
* Structures for the nfssvc(2) syscall. Not that anyone but nfsd and mount_nfs
|
|
* should ever try and use it.
|
|
*/
|
|
struct nfsd_args {
|
|
int sock; /* Socket to serve */
|
|
caddr_t name; /* Client addr for connection based sockets */
|
|
int namelen; /* Length of name */
|
|
};
|
|
|
|
struct nfsd_srvargs {
|
|
struct nfsd *nsd_nfsd; /* Pointer to in kernel nfsd struct */
|
|
uid_t nsd_uid; /* Effective uid mapped to cred */
|
|
u_int32_t nsd_haddr; /* Ip address of client */
|
|
struct xucred nsd_cr; /* Cred. uid maps to */
|
|
u_int nsd_authlen; /* Length of auth string (ret) */
|
|
u_char *nsd_authstr; /* Auth string (ret) */
|
|
u_int nsd_verflen; /* and the verfier */
|
|
u_char *nsd_verfstr;
|
|
struct timeval nsd_timestamp; /* timestamp from verifier */
|
|
u_int32_t nsd_ttl; /* credential ttl (sec) */
|
|
};
|
|
|
|
struct nfsd_cargs {
|
|
char *ncd_dirp; /* Mount dir path */
|
|
uid_t ncd_authuid; /* Effective uid */
|
|
int ncd_authtype; /* Type of authenticator */
|
|
u_int ncd_authlen; /* Length of authenticator string */
|
|
u_char *ncd_authstr; /* Authenticator string */
|
|
u_int ncd_verflen; /* and the verifier */
|
|
u_char *ncd_verfstr;
|
|
};
|
|
|
|
/*
|
|
* XXX to allow amd to include nfs.h without nfsproto.h
|
|
*/
|
|
#ifdef NFS_NPROCS
|
|
#include <nfsserver/nfsrvstats.h>
|
|
#endif
|
|
|
|
/*
|
|
* Flags for nfssvc() system call.
|
|
*/
|
|
#define NFSSVC_NFSD 0x004
|
|
#define NFSSVC_ADDSOCK 0x008
|
|
|
|
/*
|
|
* vfs.nfsrv sysctl(3) identifiers
|
|
*/
|
|
#define NFS_NFSRVSTATS 1 /* struct: struct nfsrvstats */
|
|
#define NFS_NFSPRIVPORT 2 /* int: prohibit nfs to resvports */
|
|
|
|
#ifdef _KERNEL
|
|
|
|
#ifdef MALLOC_DECLARE
|
|
MALLOC_DECLARE(M_NFSRVDESC);
|
|
MALLOC_DECLARE(M_NFSD);
|
|
#endif
|
|
|
|
/* Forward declarations */
|
|
struct nfssvc_sock;
|
|
struct nfsrv_descript;
|
|
struct uio;
|
|
struct vattr;
|
|
struct nameidata;
|
|
|
|
extern struct callout_handle nfsrv_timer_handle;
|
|
extern struct nfsrvstats nfsrvstats;
|
|
|
|
extern int nfsrv_ticks;
|
|
extern int nfsrvw_procrastinate;
|
|
extern int nfsrvw_procrastinate_v3;
|
|
|
|
/* Various values converted to XDR form. */
|
|
extern u_int32_t nfsrv_nfs_false, nfsrv_nfs_true, nfsrv_nfs_xdrneg1,
|
|
nfsrv_nfs_prog;
|
|
extern u_int32_t nfsrv_rpc_reply, nfsrv_rpc_msgdenied, nfsrv_rpc_mismatch,
|
|
nfsrv_rpc_vers;
|
|
extern u_int32_t nfsrv_rpc_auth_unix, nfsrv_rpc_msgaccepted, nfsrv_rpc_call,
|
|
nfsrv_rpc_autherr;
|
|
|
|
/* Procedure table data */
|
|
extern int nfsrvv2_procid[NFS_NPROCS];
|
|
extern int nfsrv_nfsv3_procid[NFS_NPROCS];
|
|
extern int32_t (*nfsrv3_procs[NFS_NPROCS])(struct nfsrv_descript *nd,
|
|
struct nfssvc_sock *slp, struct thread *td,
|
|
struct mbuf **mreqp);
|
|
|
|
/*
|
|
* A list of nfssvc_sock structures is maintained with all the sockets
|
|
* that require service by the nfsd.
|
|
*/
|
|
#ifndef NFS_WDELAYHASHSIZ
|
|
#define NFS_WDELAYHASHSIZ 16 /* and with this */
|
|
#endif
|
|
#define NWDELAYHASH(sock, f) \
|
|
(&(sock)->ns_wdelayhashtbl[(*((u_int32_t *)(f))) % NFS_WDELAYHASHSIZ])
|
|
|
|
/*
|
|
* Network address hash list element
|
|
*/
|
|
union nethostaddr {
|
|
u_int32_t had_inetaddr;
|
|
struct sockaddr *had_nam;
|
|
};
|
|
|
|
#define nu_inetaddr nu_haddr.had_inetaddr
|
|
#define nu_nam nu_haddr.had_nam
|
|
/* Bits for nu_flag */
|
|
#define NU_INETADDR 0x1
|
|
#define NU_NAM 0x2
|
|
#define NU_NETFAM(u) (((u)->nu_flag & NU_INETADDR) ? AF_INET : AF_ISO)
|
|
|
|
struct nfsrv_rec {
|
|
STAILQ_ENTRY(nfsrv_rec) nr_link;
|
|
struct sockaddr *nr_address;
|
|
struct mbuf *nr_packet;
|
|
};
|
|
|
|
struct nfssvc_sock {
|
|
TAILQ_ENTRY(nfssvc_sock) ns_chain; /* List of all nfssvc_sock's */
|
|
struct file *ns_fp;
|
|
struct socket *ns_so;
|
|
struct sockaddr *ns_nam;
|
|
struct mbuf *ns_raw;
|
|
struct mbuf *ns_rawend;
|
|
STAILQ_HEAD(, nfsrv_rec) ns_rec;
|
|
struct mbuf *ns_frag;
|
|
int ns_flag;
|
|
int ns_solock;
|
|
int ns_cc;
|
|
int ns_reclen;
|
|
u_int32_t ns_sref;
|
|
LIST_HEAD(, nfsrv_descript) ns_tq; /* Write gather lists */
|
|
LIST_HEAD(nfsrvw_delayhash, nfsrv_descript) ns_wdelayhashtbl[NFS_WDELAYHASHSIZ];
|
|
};
|
|
|
|
/* Bits for "ns_flag" */
|
|
#define SLP_VALID 0x01
|
|
#define SLP_DOREC 0x02
|
|
#define SLP_NEEDQ 0x04
|
|
#define SLP_DISCONN 0x08
|
|
#define SLP_GETSTREAM 0x10
|
|
#define SLP_LASTFRAG 0x20
|
|
#define SLP_ALLFLAGS 0xff
|
|
|
|
extern TAILQ_HEAD(nfssvc_sockhead, nfssvc_sock) nfssvc_sockhead;
|
|
extern int nfssvc_sockhead_flag;
|
|
#define SLP_INIT 0x01
|
|
#define SLP_WANTINIT 0x02
|
|
|
|
/*
|
|
* One of these structures is allocated for each nfsd.
|
|
*/
|
|
struct nfsd {
|
|
TAILQ_ENTRY(nfsd) nfsd_chain; /* List of all nfsd's */
|
|
int nfsd_flag; /* NFSD_ flags */
|
|
struct nfssvc_sock *nfsd_slp; /* Current socket */
|
|
int nfsd_authlen; /* Authenticator len */
|
|
u_char nfsd_authstr[RPCAUTH_MAXSIZ]; /* Authenticator data */
|
|
int nfsd_verflen; /* and the Verifier */
|
|
u_char nfsd_verfstr[RPCVERF_MAXSIZ];
|
|
struct thread *nfsd_td; /* daemon thread ptr */
|
|
struct nfsrv_descript *nfsd_nd; /* Associated nfsrv_descript */
|
|
};
|
|
|
|
/* Bits for "nfsd_flag" */
|
|
#define NFSD_WAITING 0x01
|
|
#define NFSD_REQINPROG 0x02
|
|
|
|
/*
|
|
* This structure is used by the server for describing each request.
|
|
* Some fields are used only when write request gathering is performed.
|
|
*/
|
|
struct nfsrv_descript {
|
|
u_quad_t nd_time; /* Write deadline (usec) */
|
|
off_t nd_off; /* Start byte offset */
|
|
off_t nd_eoff; /* and end byte offset */
|
|
LIST_ENTRY(nfsrv_descript) nd_hash; /* Hash list */
|
|
LIST_ENTRY(nfsrv_descript) nd_tq; /* and timer list */
|
|
LIST_HEAD(, nfsrv_descript) nd_coalesce;/* coalesced writes */
|
|
struct mbuf *nd_mrep; /* Request mbuf list */
|
|
struct mbuf *nd_md; /* Current dissect mbuf */
|
|
struct mbuf *nd_mreq; /* Reply mbuf list */
|
|
struct sockaddr *nd_nam; /* and socket addr */
|
|
struct sockaddr *nd_nam2; /* return socket addr */
|
|
caddr_t nd_dpos; /* Current dissect pos */
|
|
u_int32_t nd_procnum; /* RPC # */
|
|
int nd_stable; /* storage type */
|
|
int nd_flag; /* nd_flag */
|
|
int nd_len; /* Length of this write */
|
|
int nd_repstat; /* Reply status */
|
|
u_int32_t nd_retxid; /* Reply xid */
|
|
struct timeval nd_starttime; /* Time RPC initiated */
|
|
fhandle_t nd_fh; /* File handle */
|
|
struct ucred nd_cr; /* Credentials */
|
|
};
|
|
|
|
/* Bits for "nd_flag" */
|
|
#define ND_NFSV3 0x08
|
|
|
|
extern TAILQ_HEAD(nfsd_head, nfsd) nfsd_head;
|
|
extern int nfsd_head_flag;
|
|
#define NFSD_CHECKSLP 0x01
|
|
|
|
/*
|
|
* These macros compare nfsrv_descript structures.
|
|
*/
|
|
#define NFSW_CONTIG(o, n) \
|
|
((o)->nd_eoff >= (n)->nd_off && \
|
|
!bcmp((caddr_t)&(o)->nd_fh, (caddr_t)&(n)->nd_fh, NFSX_V3FH))
|
|
|
|
#define NFSW_SAMECRED(o, n) \
|
|
(!bcmp((caddr_t)&(o)->nd_cr, (caddr_t)&(n)->nd_cr, \
|
|
sizeof (struct ucred)))
|
|
|
|
/*
|
|
* Defines for WebNFS
|
|
*/
|
|
|
|
#define WEBNFS_ESC_CHAR '%'
|
|
#define WEBNFS_SPECCHAR_START 0x80
|
|
|
|
#define WEBNFS_NATIVE_CHAR 0x80
|
|
/*
|
|
* ..
|
|
* Possibly more here in the future.
|
|
*/
|
|
|
|
/*
|
|
* Macro for converting escape characters in WebNFS pathnames.
|
|
* Should really be in libkern.
|
|
*/
|
|
|
|
#define HEXTOC(c) \
|
|
((c) >= 'a' ? ((c) - ('a' - 10)) : \
|
|
((c) >= 'A' ? ((c) - ('A' - 10)) : ((c) - '0')))
|
|
#define HEXSTRTOI(p) \
|
|
((HEXTOC(p[0]) << 4) + HEXTOC(p[1]))
|
|
|
|
#ifdef NFS_DEBUG
|
|
|
|
extern int nfs_debug;
|
|
#define NFS_DEBUG_ASYNCIO 1 /* asynchronous i/o */
|
|
#define NFS_DEBUG_WG 2 /* server write gathering */
|
|
#define NFS_DEBUG_RC 4 /* server request caching */
|
|
|
|
#define NFS_DPF(cat, args) \
|
|
do { \
|
|
if (nfs_debug & NFS_DEBUG_##cat) printf args; \
|
|
} while (0)
|
|
|
|
#else
|
|
|
|
#define NFS_DPF(cat, args)
|
|
|
|
#endif
|
|
|
|
int nfs_getreq(struct nfsrv_descript *, struct nfsd *, int);
|
|
int nfsrv_send(struct socket *, struct sockaddr *, struct mbuf *);
|
|
struct mbuf *nfs_rephead(int, struct nfsrv_descript *, int, struct mbuf **,
|
|
caddr_t *);
|
|
int nfs_slplock(struct nfssvc_sock *, int);
|
|
void nfs_slpunlock(struct nfssvc_sock *);
|
|
void nfsm_srvfattr(struct nfsrv_descript *, struct vattr *,
|
|
struct nfs_fattr *);
|
|
void nfsm_srvwcc(struct nfsrv_descript *, int, struct vattr *, int,
|
|
struct vattr *, struct mbuf **, char **);
|
|
void nfsm_srvpostopattr(struct nfsrv_descript *, int, struct vattr *,
|
|
struct mbuf **, char **);
|
|
int netaddr_match(int, union nethostaddr *, struct sockaddr *);
|
|
int nfs_namei(struct nameidata *, fhandle_t *, int,
|
|
struct nfssvc_sock *, struct sockaddr *, struct mbuf **,
|
|
caddr_t *, struct vnode **, struct thread *, int);
|
|
void nfsm_adj(struct mbuf *, int, int);
|
|
int nfsm_mbuftouio(struct mbuf **, struct uio *, int, caddr_t *);
|
|
void nfsrv_initcache(void);
|
|
void nfsrv_timer(void *);
|
|
int nfsrv_dorec(struct nfssvc_sock *, struct nfsd *,
|
|
struct nfsrv_descript **);
|
|
int nfsrv_getcache(struct nfsrv_descript *, struct mbuf **);
|
|
void nfsrv_updatecache(struct nfsrv_descript *, int, struct mbuf *);
|
|
void nfsrv_cleancache(void);
|
|
void nfsrv_init(int);
|
|
int nfsrv_errmap(struct nfsrv_descript *, int);
|
|
void nfsrvw_sort(gid_t *, int);
|
|
void nfsrv_setcred(struct ucred *, struct ucred *);
|
|
int nfsrv_object_create(struct vnode *);
|
|
void nfsrv_wakenfsd(struct nfssvc_sock *slp);
|
|
int nfsrv_writegather(struct nfsrv_descript **, struct nfssvc_sock *,
|
|
struct thread *, struct mbuf **);
|
|
|
|
int nfsrv3_access(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
|
|
struct thread *td, struct mbuf **mrq);
|
|
int nfsrv_commit(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
|
|
struct thread *td, struct mbuf **mrq);
|
|
int nfsrv_create(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
|
|
struct thread *td, struct mbuf **mrq);
|
|
int nfsrv_fhtovp(fhandle_t *, int, struct vnode **, struct ucred *,
|
|
struct nfssvc_sock *, struct sockaddr *, int *, int);
|
|
int nfsrv_setpublicfs(struct mount *, struct netexport *,
|
|
struct export_args *);
|
|
int nfs_ispublicfh(fhandle_t *);
|
|
int nfsrv_fsinfo(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
|
|
struct thread *td, struct mbuf **mrq);
|
|
int nfsrv_getattr(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
|
|
struct thread *td, struct mbuf **mrq);
|
|
int nfsrv_link(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
|
|
struct thread *td, struct mbuf **mrq);
|
|
int nfsrv_lookup(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
|
|
struct thread *td, struct mbuf **mrq);
|
|
int nfsrv_mkdir(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
|
|
struct thread *td, struct mbuf **mrq);
|
|
int nfsrv_mknod(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
|
|
struct thread *td, struct mbuf **mrq);
|
|
int nfsrv_noop(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
|
|
struct thread *td, struct mbuf **mrq);
|
|
int nfsrv_null(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
|
|
struct thread *td, struct mbuf **mrq);
|
|
int nfsrv_pathconf(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
|
|
struct thread *td, struct mbuf **mrq);
|
|
int nfsrv_read(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
|
|
struct thread *td, struct mbuf **mrq);
|
|
int nfsrv_readdir(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
|
|
struct thread *td, struct mbuf **mrq);
|
|
int nfsrv_readdirplus(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
|
|
struct thread *td, struct mbuf **mrq);
|
|
int nfsrv_readlink(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
|
|
struct thread *td, struct mbuf **mrq);
|
|
int nfsrv_remove(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
|
|
struct thread *td, struct mbuf **mrq);
|
|
int nfsrv_rename(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
|
|
struct thread *td, struct mbuf **mrq);
|
|
int nfsrv_rmdir(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
|
|
struct thread *td, struct mbuf **mrq);
|
|
int nfsrv_setattr(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
|
|
struct thread *td, struct mbuf **mrq);
|
|
int nfsrv_statfs(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
|
|
struct thread *td, struct mbuf **mrq);
|
|
int nfsrv_symlink(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
|
|
struct thread *td, struct mbuf **mrq);
|
|
int nfsrv_write(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
|
|
struct thread *td, struct mbuf **mrq);
|
|
void nfsrv_rcv(struct socket *so, void *arg, int waitflag);
|
|
void nfsrv_slpderef(struct nfssvc_sock *slp);
|
|
#endif /* _KERNEL */
|
|
|
|
#endif
|