nfsargs.h revision 1828
1/* 2 * Copyright (c) 1989, 1993 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 * 3. All advertising materials mentioning features or use of this software 17 * must display the following acknowledgement: 18 * This product includes software developed by the University of 19 * California, Berkeley and its contributors. 20 * 4. Neither the name of the University nor the names of its contributors 21 * may be used to endorse or promote products derived from this software 22 * without specific prior written permission. 23 * 24 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 27 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 34 * SUCH DAMAGE. 35 * 36 * @(#)nfs.h 8.1 (Berkeley) 6/10/93 37 * $Id: nfs.h,v 1.2 1994/08/02 07:52:04 davidg Exp $ 38 */ 39 40/* 41 * Tunable constants for nfs 42 */ 43 44#define NFS_MAXIOVEC 34 45#define NFS_HZ 25 /* Ticks per second for NFS timeouts */ 46#define NFS_TIMEO (1*NFS_HZ) /* Default timeout = 1 second */ 47#define NFS_MINTIMEO (1*NFS_HZ) /* Min timeout to use */ 48#define NFS_MAXTIMEO (60*NFS_HZ) /* Max timeout to backoff to */ 49#define NFS_MINIDEMTIMEO (5*NFS_HZ) /* Min timeout for non-idempotent ops*/ 50#define NFS_MAXREXMIT 100 /* Stop counting after this many */ 51#define NFS_MAXWINDOW 1024 /* Max number of outstanding requests */ 52#define NFS_RETRANS 10 /* Num of retrans for soft mounts */ 53#define NFS_MAXGRPS 16 /* Max. size of groups list */ 54#ifndef NFS_MINATTRTIMO 55#define NFS_MINATTRTIMO 5 /* Attribute cache timeout in sec */ 56#endif 57#ifndef NFS_MAXATTRTIMO 58#define NFS_MAXATTRTIMO 60 59#endif 60#define NFS_WSIZE 8192 /* Def. write data size <= 8192 */ 61#define NFS_RSIZE 8192 /* Def. read data size <= 8192 */ 62#define NFS_DEFRAHEAD 1 /* Def. read ahead # blocks */ 63#define NFS_MAXRAHEAD 4 /* Max. read ahead # blocks */ 64#define NFS_MAXREADDIR NFS_MAXDATA /* Max. size of directory read */ 65#define NFS_MAXUIDHASH 64 /* Max. # of hashed uid entries/mp */ 66#define NFS_MAXASYNCDAEMON 20 /* Max. number async_daemons runable */ 67#define NFS_DIRBLKSIZ 1024 /* Size of an NFS directory block */ 68#define NMOD(a) ((a) % nfs_asyncdaemons) 69 70/* 71 * Set the attribute timeout based on how recently the file has been modified. 72 */ 73#define NFS_ATTRTIMEO(np) \ 74 ((((np)->n_flag & NMODIFIED) || \ 75 (time.tv_sec - (np)->n_mtime) / 10 < NFS_MINATTRTIMO) ? NFS_MINATTRTIMO : \ 76 ((time.tv_sec - (np)->n_mtime) / 10 > NFS_MAXATTRTIMO ? NFS_MAXATTRTIMO : \ 77 (time.tv_sec - (np)->n_mtime) / 10)) 78 79/* 80 * Structures for the nfssvc(2) syscall. Not that anyone but nfsd and mount_nfs 81 * should ever try and use it. 82 */ 83struct nfsd_args { 84 int sock; /* Socket to serve */ 85 caddr_t name; /* Client address for connection based sockets */ 86 int namelen; /* Length of name */ 87}; 88 89struct nfsd_srvargs { 90 struct nfsd *nsd_nfsd; /* Pointer to in kernel nfsd struct */ 91 uid_t nsd_uid; /* Effective uid mapped to cred */ 92 u_long nsd_haddr; /* Ip address of client */ 93 struct ucred nsd_cr; /* Cred. uid maps to */ 94 int nsd_authlen; /* Length of auth string (ret) */ 95 char *nsd_authstr; /* Auth string (ret) */ 96}; 97 98struct nfsd_cargs { 99 char *ncd_dirp; /* Mount dir path */ 100 uid_t ncd_authuid; /* Effective uid */ 101 int ncd_authtype; /* Type of authenticator */ 102 int ncd_authlen; /* Length of authenticator string */ 103 char *ncd_authstr; /* Authenticator string */ 104}; 105 106/* 107 * Stats structure 108 */ 109struct nfsstats { 110 int attrcache_hits; 111 int attrcache_misses; 112 int lookupcache_hits; 113 int lookupcache_misses; 114 int direofcache_hits; 115 int direofcache_misses; 116 int biocache_reads; 117 int read_bios; 118 int read_physios; 119 int biocache_writes; 120 int write_bios; 121 int write_physios; 122 int biocache_readlinks; 123 int readlink_bios; 124 int biocache_readdirs; 125 int readdir_bios; 126 int rpccnt[NFS_NPROCS]; 127 int rpcretries; 128 int srvrpccnt[NFS_NPROCS]; 129 int srvrpc_errs; 130 int srv_errs; 131 int rpcrequests; 132 int rpctimeouts; 133 int rpcunexpected; 134 int rpcinvalid; 135 int srvcache_inproghits; 136 int srvcache_idemdonehits; 137 int srvcache_nonidemdonehits; 138 int srvcache_misses; 139 int srvnqnfs_leases; 140 int srvnqnfs_maxleases; 141 int srvnqnfs_getleases; 142}; 143 144/* 145 * Flags for nfssvc() system call. 146 */ 147#define NFSSVC_BIOD 0x002 148#define NFSSVC_NFSD 0x004 149#define NFSSVC_ADDSOCK 0x008 150#define NFSSVC_AUTHIN 0x010 151#define NFSSVC_GOTAUTH 0x040 152#define NFSSVC_AUTHINFAIL 0x080 153#define NFSSVC_MNTD 0x100 154 155/* 156 * The set of signals the interrupt an I/O in progress for NFSMNT_INT mounts. 157 * What should be in this set is open to debate, but I believe that since 158 * I/O system calls on ufs are never interrupted by signals the set should 159 * be minimal. My reasoning is that many current programs that use signals 160 * such as SIGALRM will not expect file I/O system calls to be interrupted 161 * by them and break. 162 */ 163#ifdef KERNEL 164#define NFSINT_SIGMASK (sigmask(SIGINT)|sigmask(SIGTERM)|sigmask(SIGKILL)| \ 165 sigmask(SIGHUP)|sigmask(SIGQUIT)) 166 167/* 168 * Socket errors ignored for connectionless sockets?? 169 * For now, ignore them all 170 */ 171#define NFSIGNORE_SOERROR(s, e) \ 172 ((e) != EINTR && (e) != ERESTART && (e) != EWOULDBLOCK && \ 173 ((s) & PR_CONNREQUIRED) == 0) 174 175/* 176 * Nfs outstanding request list element 177 */ 178struct nfsreq { 179 struct nfsreq *r_next; 180 struct nfsreq *r_prev; 181 struct mbuf *r_mreq; 182 struct mbuf *r_mrep; 183 struct mbuf *r_md; 184 caddr_t r_dpos; 185 struct nfsmount *r_nmp; 186 struct vnode *r_vp; 187 u_long r_xid; 188 int r_flags; /* flags on request, see below */ 189 int r_retry; /* max retransmission count */ 190 int r_rexmit; /* current retrans count */ 191 int r_timer; /* tick counter on reply */ 192 int r_procnum; /* NFS procedure number */ 193 int r_rtt; /* RTT for rpc */ 194 struct proc *r_procp; /* Proc that did I/O system call */ 195}; 196 197/* Flag values for r_flags */ 198#define R_TIMING 0x01 /* timing request (in mntp) */ 199#define R_SENT 0x02 /* request has been sent */ 200#define R_SOFTTERM 0x04 /* soft mnt, too many retries */ 201#define R_INTR 0x08 /* intr mnt, signal pending */ 202#define R_SOCKERR 0x10 /* Fatal error on socket */ 203#define R_TPRINTFMSG 0x20 /* Did a tprintf msg. */ 204#define R_MUSTRESEND 0x40 /* Must resend request */ 205#define R_GETONEREP 0x80 /* Probe for one reply only */ 206 207struct nfsstats nfsstats; 208 209/* 210 * A list of nfssvc_sock structures is maintained with all the sockets 211 * that require service by the nfsd. 212 * The nfsuid structs hang off of the nfssvc_sock structs in both lru 213 * and uid hash lists. 214 */ 215#define NUIDHASHSIZ 32 216#define NUIDHASH(uid) ((uid) & (NUIDHASHSIZ - 1)) 217 218/* 219 * Network address hash list element 220 */ 221union nethostaddr { 222 u_long had_inetaddr; 223 struct mbuf *had_nam; 224}; 225 226struct nfsuid { 227 struct nfsuid *nu_lrunext; /* MUST be first */ 228 struct nfsuid *nu_lruprev; 229 struct nfsuid *nu_hnext; 230 struct nfsuid *nu_hprev; 231 int nu_flag; /* Flags */ 232 uid_t nu_uid; /* Uid mapped by this entry */ 233 union nethostaddr nu_haddr; /* Host addr. for dgram sockets */ 234 struct ucred nu_cr; /* Cred uid mapped to */ 235}; 236 237#define nu_inetaddr nu_haddr.had_inetaddr 238#define nu_nam nu_haddr.had_nam 239/* Bits for nu_flag */ 240#define NU_INETADDR 0x1 241 242struct nfssvc_sock { 243 struct nfsuid *ns_lrunext; /* MUST be first */ 244 struct nfsuid *ns_lruprev; 245 struct nfssvc_sock *ns_next; 246 struct nfssvc_sock *ns_prev; 247 int ns_flag; 248 u_long ns_sref; 249 struct file *ns_fp; 250 struct socket *ns_so; 251 int ns_solock; 252 struct mbuf *ns_nam; 253 int ns_cc; 254 struct mbuf *ns_raw; 255 struct mbuf *ns_rawend; 256 int ns_reclen; 257 struct mbuf *ns_rec; 258 struct mbuf *ns_recend; 259 int ns_numuids; 260 struct nfsuid *ns_uidh[NUIDHASHSIZ]; 261}; 262 263/* Bits for "ns_flag" */ 264#define SLP_VALID 0x01 265#define SLP_DOREC 0x02 266#define SLP_NEEDQ 0x04 267#define SLP_DISCONN 0x08 268#define SLP_GETSTREAM 0x10 269#define SLP_INIT 0x20 270#define SLP_WANTINIT 0x40 271 272#define SLP_ALLFLAGS 0xff 273 274/* 275 * One of these structures is allocated for each nfsd. 276 */ 277struct nfsd { 278 struct nfsd *nd_next; /* Must be first */ 279 struct nfsd *nd_prev; 280 int nd_flag; /* NFSD_ flags */ 281 struct nfssvc_sock *nd_slp; /* Current socket */ 282 struct mbuf *nd_nam; /* Client addr for datagram req. */ 283 struct mbuf *nd_mrep; /* Req. mbuf list */ 284 struct mbuf *nd_md; 285 caddr_t nd_dpos; /* Position in list */ 286 int nd_procnum; /* RPC procedure number */ 287 u_long nd_retxid; /* RPC xid */ 288 int nd_repstat; /* Reply status value */ 289 struct ucred nd_cr; /* Credentials for req. */ 290 int nd_nqlflag; /* Leasing flag */ 291 int nd_duration; /* Lease duration */ 292 int nd_authlen; /* Authenticator len */ 293 u_char nd_authstr[RPCAUTH_MAXSIZ]; /* Authenticator data */ 294 struct proc *nd_procp; /* Proc ptr */ 295}; 296 297#define NFSD_WAITING 0x01 298#define NFSD_CHECKSLP 0x02 299#define NFSD_REQINPROG 0x04 300#define NFSD_NEEDAUTH 0x08 301#define NFSD_AUTHFAIL 0x10 302#endif /* KERNEL */ 303