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