1 /* $OpenBSD: nfs.h,v 1.11 2001/06/25 03:28:05 csapuntz Exp $ */ 2 /* $NetBSD: nfs.h,v 1.10.4.1 1996/05/27 11:23:56 fvdl Exp $ */ 3 4 /* 5 * Copyright (c) 1989, 1993, 1995 6 * The Regents of the University of California. All rights reserved. 7 * 8 * This code is derived from software contributed to Berkeley by 9 * Rick Macklem at The University of Guelph. 10 * 11 * Redistribution and use in source and binary forms, with or without 12 * modification, are permitted provided that the following conditions 13 * are met: 14 * 1. Redistributions of source code must retain the above copyright 15 * notice, this list of conditions and the following disclaimer. 16 * 2. Redistributions in binary form must reproduce the above copyright 17 * notice, this list of conditions and the following disclaimer in the 18 * documentation and/or other materials provided with the distribution. 19 * 3. All advertising materials mentioning features or use of this software 20 * must display the following acknowledgement: 21 * This product includes software developed by the University of 22 * California, Berkeley and its contributors. 23 * 4. Neither the name of the University nor the names of its contributors 24 * may be used to endorse or promote products derived from this software 25 * without specific prior written permission. 26 * 27 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 28 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 29 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 30 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 31 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 32 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 33 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 34 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 35 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 36 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 37 * SUCH DAMAGE. 38 * 39 * @(#)nfs.h 8.4 (Berkeley) 5/1/95 40 */ 41 42 #ifndef _NFS_NFS_H_ 43 #define _NFS_NFS_H_ 44 45 /* 46 * Tunable constants for nfs 47 */ 48 49 #define NFS_MAXIOVEC 34 50 #define NFS_TICKINTVL 5 /* Desired time for a tick (msec) */ 51 #define NFS_HZ (hz / nfs_ticks) /* Ticks/sec */ 52 #define NFS_TIMEO (1 * NFS_HZ) /* Default timeout = 1 second */ 53 #define NFS_MINTIMEO (1 * NFS_HZ) /* Min timeout to use */ 54 #define NFS_MAXTIMEO (60 * NFS_HZ) /* Max timeout to backoff to */ 55 #define NFS_MINIDEMTIMEO (5 * NFS_HZ) /* Min timeout for non-idempotent ops*/ 56 #define NFS_MAXREXMIT 100 /* Stop counting after this many */ 57 #define NFS_MAXWINDOW 1024 /* Max number of outstanding requests */ 58 #define NFS_RETRANS 10 /* Num of retrans for soft mounts */ 59 #define NFS_MAXGRPS 16 /* Max. size of groups list */ 60 #ifndef NFS_MINATTRTIMO 61 #define NFS_MINATTRTIMO 5 /* Attribute cache timeout in sec */ 62 #endif 63 #ifndef NFS_MAXATTRTIMO 64 #define NFS_MAXATTRTIMO 60 65 #endif 66 #define NFS_WSIZE 8192 /* Def. write data size <= 8192 */ 67 #define NFS_RSIZE 8192 /* Def. read data size <= 8192 */ 68 #define NFS_READDIRSIZE 8192 /* Def. readdir size */ 69 #define NFS_DEFRAHEAD 1 /* Def. read ahead # blocks */ 70 #define NFS_MAXRAHEAD 4 /* Max. read ahead # blocks */ 71 #define NFS_MAXUIDHASH 64 /* Max. # of hashed uid entries/mp */ 72 #define NFS_MAXASYNCDAEMON 20 /* Max. number async_daemons runable */ 73 #define NFS_MAXGATHERDELAY 100 /* Max. write gather delay (msec) */ 74 #ifndef NFS_GATHERDELAY 75 #define NFS_GATHERDELAY 10 /* Default write gather delay (msec) */ 76 #endif 77 /* 78 * Ideally, NFS_DIRBLKSIZ should be bigger, but I've seen servers with 79 * broken NFS/ethernet drivers that won't work with anything bigger (Linux..) 80 */ 81 #define NFS_DIRBLKSIZ 1024 /* Must be a multiple of DIRBLKSIZ */ 82 #define NFS_READDIRBLKSIZ 512 /* Size of read dir blocks. XXX */ 83 84 /* 85 * Oddballs 86 */ 87 #define NMOD(a) ((a) % nfs_asyncdaemons) 88 #define NFS_CMPFH(n, f, s) \ 89 ((n)->n_fhsize == (s) && !bcmp((caddr_t)(n)->n_fhp, (caddr_t)(f), (s))) 90 #define NFS_ISV3(v) (VFSTONFS((v)->v_mount)->nm_flag & NFSMNT_NFSV3) 91 #define NFS_SRVMAXDATA(n) \ 92 (((n)->nd_flag & ND_NFSV3) ? (((n)->nd_nam2) ? \ 93 NFS_MAXDGRAMDATA : NFS_MAXDATA) : NFS_V2MAXDATA) 94 95 /* 96 * sys/malloc.h needs M_NFSDIROFF, M_NFSRVDESC and M_NFSBIGFH added. 97 * The VA_EXCLUSIVE flag should be added for va_vaflags and set for an 98 * exclusive create. 99 */ 100 #ifndef M_NFSRVDESC 101 #define M_NFSRVDESC M_TEMP 102 #endif 103 #ifndef M_NFSDIROFF 104 #define M_NFSDIROFF M_TEMP 105 #endif 106 #ifndef M_NFSBIGFH 107 #define M_NFSBIGFH M_TEMP 108 #endif 109 #ifndef VA_EXCLUSIVE 110 #define VA_EXCLUSIVE 0 111 #endif 112 113 /* 114 * The B_INVAFTERWRITE flag should be set to whatever is required by the 115 * buffer cache code to say "Invalidate the block after it is written back". 116 */ 117 #define B_INVAFTERWRITE B_INVAL 118 119 /* 120 * The IO_METASYNC flag should be implemented for local file systems. 121 * (Until then, it is nothin at all.) 122 */ 123 #ifndef IO_METASYNC 124 #define IO_METASYNC 0 125 #endif 126 127 /* 128 * Set the attribute timeout based on how recently the file has been modified. 129 */ 130 #if 0 /* replaced by nfs_attrtimeo() in nfs_subs.c */ 131 #define NFS_ATTRTIMEO(np) \ 132 ((((np)->n_flag & NMODIFIED) || \ 133 (time.tv_sec - (np)->n_mtime) / 10 < NFS_MINATTRTIMO) ? NFS_MINATTRTIMO : \ 134 ((time.tv_sec - (np)->n_mtime) / 10 > NFS_MAXATTRTIMO ? NFS_MAXATTRTIMO : \ 135 (time.tv_sec - (np)->n_mtime) / 10)) 136 #endif 137 138 /* 139 * Expected allocation sizes for major data structures. If the actual size 140 * of the structure exceeds these sizes, then malloc() will be allocating 141 * almost twice the memory required. This is used in nfs_init() to warn 142 * the sysadmin that the size of a structure should be reduced. 143 * (These sizes are always a power of 2. If the kernel malloc() changes 144 * to one that does not allocate space in powers of 2 size, then this all 145 * becomes bunk!) 146 */ 147 #define NFS_NODEALLOC 256 148 #define NFS_MNTALLOC 512 149 #define NFS_SVCALLOC 256 150 #define NFS_UIDALLOC 128 151 152 /* 153 * Structures for the nfssvc(2) syscall. Not that anyone but nfsd and mount_nfs 154 * should ever try and use it. 155 */ 156 struct nfsd_args { 157 int sock; /* Socket to serve */ 158 caddr_t name; /* Client addr for connection based sockets */ 159 int namelen; /* Length of name */ 160 }; 161 162 struct nfsd_srvargs { 163 struct nfsd *nsd_nfsd; /* Pointer to in kernel nfsd struct */ 164 uid_t nsd_uid; /* Effective uid mapped to cred */ 165 u_int32_t nsd_haddr; /* Ip address of client */ 166 struct ucred nsd_cr; /* Cred. uid maps to */ 167 int nsd_authlen; /* Length of auth string (ret) */ 168 u_char *nsd_authstr; /* Auth string (ret) */ 169 int nsd_verflen; /* and the verfier */ 170 u_char *nsd_verfstr; 171 struct timeval nsd_timestamp; /* timestamp from verifier */ 172 u_int32_t nsd_ttl; /* credential ttl (sec) */ 173 NFSKERBKEY_T nsd_key; /* Session key */ 174 }; 175 176 struct nfsd_cargs { 177 char *ncd_dirp; /* Mount dir path */ 178 uid_t ncd_authuid; /* Effective uid */ 179 int ncd_authtype; /* Type of authenticator */ 180 int ncd_authlen; /* Length of authenticator string */ 181 u_char *ncd_authstr; /* Authenticator string */ 182 int ncd_verflen; /* and the verifier */ 183 u_char *ncd_verfstr; 184 NFSKERBKEY_T ncd_key; /* Session key */ 185 }; 186 187 /* 188 * Stats structure 189 */ 190 struct nfsstats { 191 int attrcache_hits; 192 int attrcache_misses; 193 int lookupcache_hits; 194 int lookupcache_misses; 195 int direofcache_hits; 196 int direofcache_misses; 197 int biocache_reads; 198 int read_bios; 199 int read_physios; 200 int biocache_writes; 201 int write_bios; 202 int write_physios; 203 int biocache_readlinks; 204 int readlink_bios; 205 int biocache_readdirs; 206 int readdir_bios; 207 int rpccnt[NFS_NPROCS]; 208 int rpcretries; 209 int srvrpccnt[NFS_NPROCS]; 210 int srvrpc_errs; 211 int srv_errs; 212 int rpcrequests; 213 int rpctimeouts; 214 int rpcunexpected; 215 int rpcinvalid; 216 int srvcache_inproghits; 217 int srvcache_idemdonehits; 218 int srvcache_nonidemdonehits; 219 int srvcache_misses; 220 int srvnqnfs_leases; 221 int srvnqnfs_maxleases; 222 int srvnqnfs_getleases; 223 int srvvop_writes; 224 }; 225 226 /* 227 * Flags for nfssvc() system call. 228 */ 229 #define NFSSVC_BIOD 0x002 230 #define NFSSVC_NFSD 0x004 231 #define NFSSVC_ADDSOCK 0x008 232 #define NFSSVC_AUTHIN 0x010 233 #define NFSSVC_GOTAUTH 0x040 234 #define NFSSVC_AUTHINFAIL 0x080 235 #define NFSSVC_MNTD 0x100 236 237 /* 238 * fs.nfs sysctl(3) identifiers 239 */ 240 #define NFS_NFSSTATS 1 /* struct: struct nfsstats */ 241 #define NFS_NIOTHREADS 2 /* number of i/o threads */ 242 #define NFS_MAXID 3 243 244 #define FS_NFS_NAMES { \ 245 { 0, 0 }, \ 246 { "nfsstats", CTLTYPE_STRUCT }, \ 247 { "iothreads", CTLTYPE_INT } \ 248 } 249 250 /* 251 * The set of signals the interrupt an I/O in progress for NFSMNT_INT mounts. 252 * What should be in this set is open to debate, but I believe that since 253 * I/O system calls on ufs are never interrupted by signals the set should 254 * be minimal. My reasoning is that many current programs that use signals 255 * such as SIGALRM will not expect file I/O system calls to be interrupted 256 * by them and break. 257 */ 258 #ifdef _KERNEL 259 extern int nfs_niothreads; 260 261 struct uio; struct buf; struct vattr; struct nameidata; /* XXX */ 262 263 #define NFSINT_SIGMASK (sigmask(SIGINT)|sigmask(SIGTERM)|sigmask(SIGKILL)| \ 264 sigmask(SIGHUP)|sigmask(SIGQUIT)) 265 266 /* 267 * Socket errors ignored for connectionless sockets?? 268 * For now, ignore them all 269 */ 270 #define NFSIGNORE_SOERROR(s, e) \ 271 ((e) != EINTR && (e) != ERESTART && (e) != EWOULDBLOCK && \ 272 ((s) & PR_CONNREQUIRED) == 0) 273 274 /* 275 * Nfs outstanding request list element 276 */ 277 struct nfsreq { 278 TAILQ_ENTRY(nfsreq) r_chain; 279 struct mbuf *r_mreq; 280 struct mbuf *r_mrep; 281 struct mbuf *r_md; 282 caddr_t r_dpos; 283 struct nfsmount *r_nmp; 284 struct vnode *r_vp; 285 u_int32_t r_xid; 286 int r_flags; /* flags on request, see below */ 287 int r_retry; /* max retransmission count */ 288 int r_rexmit; /* current retrans count */ 289 int r_timer; /* tick counter on reply */ 290 int r_procnum; /* NFS procedure number */ 291 int r_rtt; /* RTT for rpc */ 292 struct proc *r_procp; /* Proc that did I/O system call */ 293 }; 294 295 /* 296 * Queue head for nfsreq's 297 */ 298 TAILQ_HEAD(, nfsreq) nfs_reqq; 299 300 /* Flag values for r_flags */ 301 #define R_TIMING 0x01 /* timing request (in mntp) */ 302 #define R_SENT 0x02 /* request has been sent */ 303 #define R_SOFTTERM 0x04 /* soft mnt, too many retries */ 304 #define R_INTR 0x08 /* intr mnt, signal pending */ 305 #define R_SOCKERR 0x10 /* Fatal error on socket */ 306 #define R_TPRINTFMSG 0x20 /* Did a tprintf msg. */ 307 #define R_MUSTRESEND 0x40 /* Must resend request */ 308 #define R_GETONEREP 0x80 /* Probe for one reply only */ 309 310 /* 311 * A list of nfssvc_sock structures is maintained with all the sockets 312 * that require service by the nfsd. 313 * The nfsuid structs hang off of the nfssvc_sock structs in both lru 314 * and uid hash lists. 315 */ 316 #ifndef NFS_UIDHASHSIZ 317 #define NFS_UIDHASHSIZ 29 /* Tune the size of nfssvc_sock with this */ 318 #endif 319 #define NUIDHASH(sock, uid) \ 320 (&(sock)->ns_uidhashtbl[(uid) % NFS_UIDHASHSIZ]) 321 #ifndef NFS_WDELAYHASHSIZ 322 #define NFS_WDELAYHASHSIZ 16 /* and with this */ 323 #endif 324 #define NWDELAYHASH(sock, f) \ 325 (&(sock)->ns_wdelayhashtbl[(*((u_int32_t *)(f))) % NFS_WDELAYHASHSIZ]) 326 #ifndef NFS_MUIDHASHSIZ 327 #define NFS_MUIDHASHSIZ 67 /* Tune the size of nfsmount with this */ 328 #endif 329 #define NMUIDHASH(nmp, uid) \ 330 (&(nmp)->nm_uidhashtbl[(uid) % NFS_MUIDHASHSIZ]) 331 #define NFSNOHASH(fhsum) \ 332 (&nfsnodehashtbl[(fhsum) & nfsnodehash]) 333 334 /* 335 * Network address hash list element 336 */ 337 union nethostaddr { 338 u_int32_t had_inetaddr; 339 struct mbuf *had_nam; 340 }; 341 342 struct nfsuid { 343 TAILQ_ENTRY(nfsuid) nu_lru; /* LRU chain */ 344 LIST_ENTRY(nfsuid) nu_hash; /* Hash list */ 345 int nu_flag; /* Flags */ 346 union nethostaddr nu_haddr; /* Host addr. for dgram sockets */ 347 struct ucred nu_cr; /* Cred uid mapped to */ 348 int nu_expire; /* Expiry time (sec) */ 349 struct timeval nu_timestamp; /* Kerb. timestamp */ 350 u_int32_t nu_nickname; /* Nickname on server */ 351 NFSKERBKEY_T nu_key; /* and session key */ 352 }; 353 354 #define nu_inetaddr nu_haddr.had_inetaddr 355 #define nu_nam nu_haddr.had_nam 356 /* Bits for nu_flag */ 357 #define NU_INETADDR 0x1 358 #define NU_NAM 0x2 359 #define NU_NETFAM(u) (((u)->nu_flag & NU_INETADDR) ? AF_INET : AF_ISO) 360 361 struct nfssvc_sock { 362 TAILQ_ENTRY(nfssvc_sock) ns_chain; /* List of all nfssvc_sock's */ 363 TAILQ_HEAD(, nfsuid) ns_uidlruhead; 364 struct file *ns_fp; 365 struct socket *ns_so; 366 struct mbuf *ns_nam; 367 struct mbuf *ns_raw; 368 struct mbuf *ns_rawend; 369 struct mbuf *ns_rec; 370 struct mbuf *ns_recend; 371 struct mbuf *ns_frag; 372 int ns_flag; 373 int ns_solock; 374 int ns_cc; 375 int ns_reclen; 376 int ns_numuids; 377 u_int32_t ns_sref; 378 LIST_HEAD(, nfsrv_descript) ns_tq; /* Write gather lists */ 379 LIST_HEAD(, nfsuid) ns_uidhashtbl[NFS_UIDHASHSIZ]; 380 LIST_HEAD(nfsrvw_delayhash, nfsrv_descript) ns_wdelayhashtbl[NFS_WDELAYHASHSIZ]; 381 }; 382 383 /* Bits for "ns_flag" */ 384 #define SLP_VALID 0x01 385 #define SLP_DOREC 0x02 386 #define SLP_NEEDQ 0x04 387 #define SLP_DISCONN 0x08 388 #define SLP_GETSTREAM 0x10 389 #define SLP_LASTFRAG 0x20 390 #define SLP_ALLFLAGS 0xff 391 392 TAILQ_HEAD(, nfssvc_sock) nfssvc_sockhead; 393 int nfssvc_sockhead_flag; 394 #define SLP_INIT 0x01 395 #define SLP_WANTINIT 0x02 396 397 /* 398 * One of these structures is allocated for each nfsd. 399 */ 400 struct nfsd { 401 TAILQ_ENTRY(nfsd) nfsd_chain; /* List of all nfsd's */ 402 int nfsd_flag; /* NFSD_ flags */ 403 struct nfssvc_sock *nfsd_slp; /* Current socket */ 404 int nfsd_authlen; /* Authenticator len */ 405 u_char nfsd_authstr[RPCAUTH_MAXSIZ]; /* Authenticator data */ 406 int nfsd_verflen; /* and the Verifier */ 407 u_char nfsd_verfstr[RPCVERF_MAXSIZ]; 408 struct proc *nfsd_procp; /* Proc ptr */ 409 struct nfsrv_descript *nfsd_nd; /* Associated nfsrv_descript */ 410 }; 411 412 /* Bits for "nfsd_flag" */ 413 #define NFSD_WAITING 0x01 414 #define NFSD_REQINPROG 0x02 415 #define NFSD_NEEDAUTH 0x04 416 #define NFSD_AUTHFAIL 0x08 417 418 /* 419 * This structure is used by the server for describing each request. 420 * Some fields are used only when write request gathering is performed. 421 */ 422 struct nfsrv_descript { 423 u_quad_t nd_time; /* Write deadline (usec) */ 424 off_t nd_off; /* Start byte offset */ 425 off_t nd_eoff; /* and end byte offset */ 426 LIST_ENTRY(nfsrv_descript) nd_hash; /* Hash list */ 427 LIST_ENTRY(nfsrv_descript) nd_tq; /* and timer list */ 428 LIST_HEAD(,nfsrv_descript) nd_coalesce; /* coalesced writes */ 429 struct mbuf *nd_mrep; /* Request mbuf list */ 430 struct mbuf *nd_md; /* Current dissect mbuf */ 431 struct mbuf *nd_mreq; /* Reply mbuf list */ 432 struct mbuf *nd_nam; /* and socket addr */ 433 struct mbuf *nd_nam2; /* return socket addr */ 434 caddr_t nd_dpos; /* Current dissect pos */ 435 unsigned int nd_procnum; /* RPC # */ 436 int nd_stable; /* storage type */ 437 int nd_flag; /* nd_flag */ 438 int nd_len; /* Length of this write */ 439 int nd_repstat; /* Reply status */ 440 u_int32_t nd_retxid; /* Reply xid */ 441 struct timeval nd_starttime; /* Time RPC initiated */ 442 fhandle_t nd_fh; /* File handle */ 443 struct ucred nd_cr; /* Credentials */ 444 }; 445 446 /* Bits for "nd_flag" */ 447 #define ND_READ LEASE_READ 448 #define ND_WRITE LEASE_WRITE 449 #define ND_CHECK 0x04 450 #define ND_LEASE (ND_READ | ND_WRITE | ND_CHECK) 451 #define ND_NFSV3 0x08 452 #define ND_KERBNICK 0x20 453 #define ND_KERBFULL 0x40 454 #define ND_KERBAUTH (ND_KERBNICK | ND_KERBFULL) 455 456 TAILQ_HEAD(, nfsd) nfsd_head; 457 int nfsd_head_flag; 458 #define NFSD_CHECKSLP 0x01 459 460 /* 461 * These macros compare nfsrv_descript structures. 462 */ 463 #define NFSW_CONTIG(o, n) \ 464 ((o)->nd_eoff >= (n)->nd_off && \ 465 !bcmp((caddr_t)&(o)->nd_fh, (caddr_t)&(n)->nd_fh, NFSX_V3FH)) 466 467 #define NFSW_SAMECRED(o, n) \ 468 (((o)->nd_flag & ND_KERBAUTH) == ((n)->nd_flag & ND_KERBAUTH) && \ 469 !bcmp((caddr_t)&(o)->nd_cr, (caddr_t)&(n)->nd_cr, \ 470 sizeof (struct ucred))) 471 472 #endif /* _KERNEL */ 473 #endif /* _NFS_NFS_H */ 474