1 /* 2 * Copyright (c) 1989, 1993, 1995 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.4 (Berkeley) 5/1/95 37 * $FreeBSD: src/sys/nfs/nfs.h,v 1.53.2.5 2002/02/20 01:35:34 iedowse Exp $ 38 * $DragonFly: src/sys/vfs/nfs/nfs.h,v 1.21 2008/09/17 21:44:24 dillon Exp $ 39 */ 40 41 #ifndef _NFS_NFS_H_ 42 #define _NFS_NFS_H_ 43 44 #ifdef _KERNEL 45 #include "opt_nfs.h" 46 #endif 47 48 #include <sys/vnode.h> 49 #include <sys/mutex.h> 50 #include <sys/thread.h> 51 52 /* 53 * Tunable constants for nfs 54 */ 55 56 #define NFS_MAXIOVEC 34 57 #define NFS_TICKINTVL 200 /* Desired time for a tick (msec) */ 58 #define NFS_HZ (hz / nfs_ticks) /* Ticks/sec */ 59 #define NFS_TIMEO (1 * NFS_HZ) /* Default timeout = 1 second */ 60 #define NFS_MINTIMEO (1 * NFS_HZ) /* Min timeout to use */ 61 #define NFS_MAXTIMEO (60 * NFS_HZ) /* Max timeout to backoff to */ 62 #define NFS_MINIDEMTIMEO (5 * NFS_HZ) /* Min timeout for non-idempotent ops*/ 63 #define NFS_MAXREXMIT 100 /* Stop counting after this many */ 64 #define NFS_MAXWINDOW 1024 /* Max number of outstanding requests */ 65 #define NFS_RETRANS 10 /* Num of retrans for soft mounts */ 66 #define NFS_MAXGRPS 16 /* Max. size of groups list */ 67 #ifndef NFS_MINATTRTIMO 68 #define NFS_MINATTRTIMO 3 /* VREG attrib cache timeout in sec */ 69 #endif 70 #ifndef NFS_DEFATTRTIMO 71 #define NFS_DEFATTRTIMO 10 /* VREG attrib cache timeout in sec */ 72 #endif 73 #ifndef NFS_MAXATTRTIMO 74 #define NFS_MAXATTRTIMO 60 75 #endif 76 #ifndef NFS_MINDIRATTRTIMO 77 #define NFS_MINDIRATTRTIMO 30 /* VDIR attrib cache timeout in sec */ 78 #endif 79 #ifndef NFS_MAXDIRATTRTIMO 80 #define NFS_MAXDIRATTRTIMO 60 81 #endif 82 #ifndef NFS_DEADTHRESH 83 #define NFS_DEADTHRESH NFS_NEVERDEAD 84 #endif 85 #define NFS_NEVERDEAD 9 86 #define NFS_WSIZE 8192 /* Def. write data size <= 8192 */ 87 #define NFS_RSIZE 8192 /* Def. read data size <= 8192 */ 88 #define NFS_READDIRSIZE 8192 /* Def. readdir size */ 89 #define NFS_DEFRAHEAD 6 /* Def. read ahead # blocks */ 90 #define NFS_MAXRAHEAD 32 /* Max. read ahead # blocks */ 91 #define NFS_MAXASYNCBIO 64 /* Max. asynchronous BIOs */ 92 #define NFS_MAXUIDHASH 64 /* Max. # of hashed uid entries/mp */ 93 #define NFS_MAXGATHERDELAY 100 /* Max. write gather delay (msec) */ 94 #ifndef NFS_GATHERDELAY 95 #define NFS_GATHERDELAY 20 /* Default write gather delay (msec) */ 96 #endif 97 #define NFS_DIRBLKSIZ 4096 /* Must be a multiple of DIRBLKSIZ */ 98 #ifdef _KERNEL 99 #define DIRBLKSIZ 512 /* XXX we used to use ufs's DIRBLKSIZ */ 100 #endif 101 102 #define NFS_ASYSCALE 256 103 #define NFS_MINASYNC_SCALED (4 * NFS_ASYSCALE) 104 #define NFS_MAXASYNC_SCALED (NFS_MAXASYNCBIO * NFS_ASYSCALE) 105 106 /* 107 * Oddballs 108 */ 109 #define NMOD(a) ((a) % nfs_asyncdaemons) 110 #define NFS_CMPFH(n, f, s) \ 111 ((n)->n_fhsize == (s) && !bcmp((caddr_t)(n)->n_fhp, (caddr_t)(f), (s))) 112 #define NFS_ISV3(v) (VFSTONFS((v)->v_mount)->nm_flag & NFSMNT_NFSV3) 113 #define NFS_SRVMAXDATA(n) \ 114 (((n)->nd_flag & ND_NFSV3) ? (((n)->nd_nam2) ? \ 115 NFS_MAXDGRAMDATA : NFS_MAXDATA) : NFS_V2MAXDATA) 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 * Arguments to mount NFS 127 */ 128 #define NFS_ARGSVERSION 3 /* change when nfs_args changes */ 129 struct nfs_args { 130 int version; /* args structure version number */ 131 struct sockaddr *addr; /* file server address */ 132 int addrlen; /* length of address */ 133 int sotype; /* Socket type */ 134 int proto; /* and Protocol */ 135 u_char *fh; /* File handle to be mounted */ 136 int fhsize; /* Size, in bytes, of fh */ 137 int flags; /* flags */ 138 int wsize; /* write size in bytes */ 139 int rsize; /* read size in bytes */ 140 int readdirsize; /* readdir size in bytes */ 141 int timeo; /* initial timeout in .1 secs */ 142 int retrans; /* times to retry send */ 143 int maxgrouplist; /* Max. size of group list */ 144 int readahead; /* # of blocks to readahead */ 145 int unused01; /* Term (sec) of lease */ 146 int deadthresh; /* Retrans threshold */ 147 char *hostname; /* server's name */ 148 int acregmin; /* cache attrs for reg files min time */ 149 int acregmax; /* cache attrs for reg files max time */ 150 int acdirmin; /* cache attrs for dirs min time */ 151 int acdirmax; /* cache attrs for dirs max time */ 152 }; 153 154 /* 155 * NFS mount option flags 156 */ 157 #define NFSMNT_SOFT 0x00000001 /* soft mount (hard is default) */ 158 #define NFSMNT_WSIZE 0x00000002 /* set write size */ 159 #define NFSMNT_RSIZE 0x00000004 /* set read size */ 160 #define NFSMNT_TIMEO 0x00000008 /* set initial timeout */ 161 #define NFSMNT_RETRANS 0x00000010 /* set number of request retries */ 162 #define NFSMNT_MAXGRPS 0x00000020 /* set maximum grouplist size */ 163 #define NFSMNT_INT 0x00000040 /* allow interrupts on hard mount */ 164 #define NFSMNT_NOCONN 0x00000080 /* Don't Connect the socket */ 165 #define NFSMNT_FORCE 0x00000100 /* Forced unmount */ 166 #define NFSMNT_NFSV3 0x00000200 /* Use NFS Version 3 protocol */ 167 #define NFSMNT_KERB 0x00000400 /* Use Kerberos authentication */ 168 #define NFSMNT_DUMBTIMR 0x00000800 /* Don't estimate rtt dynamically */ 169 #define NFSMNT_CACHE 0x00001000 /* enable swapcache */ 170 #define NFSMNT_READAHEAD 0x00002000 /* set read ahead */ 171 #define NFSMNT_DEADTHRESH 0x00004000 /* set dead server retry thresh */ 172 #define NFSMNT_RESVPORT 0x00008000 /* Allocate a reserved port */ 173 #define NFSMNT_RDIRPLUS 0x00010000 /* Use Readdirplus for V3 */ 174 #define NFSMNT_READDIRSIZE 0x00020000 /* Set readdir size */ 175 #define NFSMNT_ACREGMIN 0x00040000 176 #define NFSMNT_ACREGMAX 0x00080000 177 #define NFSMNT_ACDIRMIN 0x00100000 178 #define NFSMNT_ACDIRMAX 0x00200000 179 180 #define NFSSTA_HASWRITEVERF 0x00040000 /* Has write verifier for V3 */ 181 #define NFSSTA_GOTPATHCONF 0x00080000 /* Got the V3 pathconf info */ 182 #define NFSSTA_GOTFSINFO 0x00100000 /* Got the V3 fsinfo */ 183 #define NFSSTA_MNTD 0x00200000 /* Mnt server for mnt point */ 184 #define NFSSTA_DISMINPROG 0x00400000 /* Dismount in progress */ 185 #define NFSSTA_DISMNT 0x00800000 /* Dismounted */ 186 #define NFSSTA_SENDSPACE 0x01000000 /* Printed sendspace warning */ 187 #define NFSSTA_UNUSED25 0x02000000 188 #define NFSSTA_UNUSED26 0x04000000 189 #define NFSSTA_UNUSED27 0x08000000 190 #define NFSSTA_WAITAUTH 0x10000000 /* Wait for authentication */ 191 #define NFSSTA_HASAUTH 0x20000000 /* Has authenticator */ 192 #define NFSSTA_WANTAUTH 0x40000000 /* Wants an authenticator */ 193 #define NFSSTA_AUTHERR 0x80000000 /* Authentication error */ 194 195 /* 196 * Structures for the nfssvc(2) syscall. Not that anyone but nfsd and mount_nfs 197 * should ever try and use it. 198 */ 199 struct nfsd_args { 200 int sock; /* Socket to serve */ 201 caddr_t name; /* Client addr for connection based sockets */ 202 int namelen; /* Length of name */ 203 }; 204 205 struct nfsd_srvargs { 206 struct nfsd *nsd_nfsd; /* Pointer to in kernel nfsd struct */ 207 uid_t nsd_uid; /* Effective uid mapped to cred */ 208 u_int32_t nsd_haddr; /* Ip address of client */ 209 struct ucred nsd_cr; /* Cred. uid maps to */ 210 u_int nsd_authlen; /* Length of auth string (ret) */ 211 u_char *nsd_authstr; /* Auth string (ret) */ 212 u_int nsd_verflen; /* and the verfier */ 213 u_char *nsd_verfstr; 214 struct timeval nsd_timestamp; /* timestamp from verifier */ 215 u_int32_t nsd_ttl; /* credential ttl (sec) */ 216 NFSKERBKEY_T nsd_key; /* Session key */ 217 }; 218 219 struct nfsd_cargs { 220 char *ncd_dirp; /* Mount dir path */ 221 uid_t ncd_authuid; /* Effective uid */ 222 int ncd_authtype; /* Type of authenticator */ 223 u_int ncd_authlen; /* Length of authenticator string */ 224 u_char *ncd_authstr; /* Authenticator string */ 225 u_int ncd_verflen; /* and the verifier */ 226 u_char *ncd_verfstr; 227 NFSKERBKEY_T ncd_key; /* Session key */ 228 }; 229 230 /* 231 * XXX to allow amd to include nfs.h without nfsproto.h 232 */ 233 #ifdef NFS_NPROCS 234 /* 235 * Stats structure 236 */ 237 struct nfsstats { 238 int attrcache_hits; 239 int attrcache_misses; 240 int lookupcache_hits; 241 int lookupcache_misses; 242 int direofcache_hits; 243 int direofcache_misses; 244 int biocache_reads; 245 int read_bios; 246 int read_physios; 247 int biocache_writes; 248 int write_bios; 249 int write_physios; 250 int biocache_readlinks; 251 int readlink_bios; 252 int biocache_readdirs; 253 int readdir_bios; 254 int rpccnt[NFS_NPROCS]; 255 int rpcretries; 256 int srvrpccnt[NFS_NPROCS]; 257 int srvrpc_errs; 258 int srv_errs; 259 int rpcrequests; 260 int rpctimeouts; 261 int rpcunexpected; 262 int rpcinvalid; 263 int srvcache_inproghits; 264 int srvcache_idemdonehits; 265 int srvcache_nonidemdonehits; 266 int srvcache_misses; 267 int srvnqnfs_leases; 268 int srvnqnfs_maxleases; 269 int srvnqnfs_getleases; 270 int srvvop_writes; 271 int accesscache_hits; 272 int accesscache_misses; 273 }; 274 #endif 275 276 /* 277 * Flags for nfssvc() system call. 278 */ 279 #define NFSSVC_BIOD 0x002 280 #define NFSSVC_NFSD 0x004 281 #define NFSSVC_ADDSOCK 0x008 282 #define NFSSVC_AUTHIN 0x010 283 #define NFSSVC_GOTAUTH 0x040 284 #define NFSSVC_AUTHINFAIL 0x080 285 #define NFSSVC_MNTD 0x100 286 287 /* 288 * fs.nfs sysctl(3) identifiers 289 */ 290 #define NFS_NFSSTATS 1 /* struct: struct nfsstats */ 291 #define NFS_NFSPRIVPORT 2 /* int: prohibit nfs to resvports */ 292 293 #define FS_NFS_NAMES { \ 294 { 0, 0 }, \ 295 { "nfsstats", CTLTYPE_STRUCT }, \ 296 { "nfsprivport", CTLTYPE_INT }, \ 297 } 298 299 #ifdef _KERNEL 300 301 #ifdef MALLOC_DECLARE 302 MALLOC_DECLARE(M_NFSREQ); 303 MALLOC_DECLARE(M_NFSDIROFF); 304 MALLOC_DECLARE(M_NFSRVDESC); 305 MALLOC_DECLARE(M_NFSUID); 306 MALLOC_DECLARE(M_NFSD); 307 MALLOC_DECLARE(M_NFSBIGFH); 308 MALLOC_DECLARE(M_NFSHASH); 309 #endif 310 311 extern struct objcache *nfsmount_objcache; 312 313 extern struct callout nfs_timer_handle; 314 extern int nfs_async; 315 extern int nfs_maxasyncbio; 316 extern int nfs_soreserve; 317 318 struct uio; 319 struct buf; 320 struct bio; 321 struct vattr; 322 struct nlookupdata; 323 324 /* 325 * The set of signals the interrupt an I/O in progress for NFSMNT_INT mounts. 326 * What should be in this set is open to debate, but I believe that since 327 * I/O system calls on ufs are never interrupted by signals the set should 328 * be minimal. My reasoning is that many current programs that use signals 329 * such as SIGALRM will not expect file I/O system calls to be interrupted 330 * by them and break. 331 */ 332 #define NFSINT_SIGMASK(set) \ 333 (SIGISMEMBER(set, SIGINT) || SIGISMEMBER(set, SIGTERM) || \ 334 SIGISMEMBER(set, SIGHUP) || SIGISMEMBER(set, SIGKILL) || \ 335 SIGISMEMBER(set, SIGQUIT)) 336 337 /* 338 * Socket errors ignored for connectionless sockets?? 339 * For now, ignore them all 340 */ 341 #define NFSIGNORE_SOERROR(s, e) \ 342 ((e) != EINTR && (e) != ERESTART && (e) != EWOULDBLOCK && \ 343 ((s) & PR_CONNREQUIRED) == 0) 344 345 struct nfsm_info; 346 347 /* 348 * Nfs outstanding request list element 349 */ 350 struct nfsreq { 351 TAILQ_ENTRY(nfsreq) r_chain; 352 struct nfsm_info *r_info; 353 struct mtx_link r_link; 354 struct mbuf *r_mreq; 355 struct mbuf *r_mrep; 356 struct mbuf *r_md; 357 caddr_t r_dpos; 358 struct nfsmount *r_nmp; 359 struct vnode *r_vp; 360 u_int32_t r_xid; 361 int r_flags; /* flags on request, see below */ 362 int r_retry; /* max retransmission count */ 363 int r_rexmit; /* current retrans count */ 364 int r_timer; /* tick counter on reply */ 365 u_int32_t r_procnum; /* NFS procedure number */ 366 int r_rtt; /* RTT for rpc */ 367 struct thread *r_td; /* Thread that did I/O system call */ 368 struct mbuf *r_mrest; 369 struct mbuf *r_mheadend; 370 struct mbuf **r_mrp; 371 struct mbuf **r_mdp; 372 caddr_t *r_dposp; 373 int r_mrest_len; 374 int r_failed_auth; 375 NFSKERBKEY_T r_key; 376 struct ucred *r_cred; 377 }; 378 379 /* 380 * Flag values for r_flags 381 * 382 * R_TIMING - Timer is active on request. If timer goes off the 383 * request's retransmit counter will bump and it will 384 * be flagged NEEDSXMIT to retransmit. 385 * 386 * R_SENT - Indicates that the request was sent the first time. 387 * This stays set unless we want to repeat a first-time 388 * styled transmit sequence. 389 * 390 * R_NEEDSXMIT - The request needs a [re]transmission. It will still 391 * be sitting on nm_reqq if synchronous, otherwise it 392 * will be moved to nm_reqtxq. 393 * 394 * R_ASYNC - Indicates an asynchronous request, which modifies the 395 * behavior of how it is dealt with. 396 * 397 * R_LOCKED - Prevents the request from being moved between queues 398 * e.g. by the timer or by the async thread. 399 */ 400 #define R_TIMING 0x0001 /* timing request (in mntp) */ 401 #define R_SENT 0x0002 /* request has been sent */ 402 #define R_SOFTTERM 0x0004 /* soft mnt, too many retries */ 403 #define R_INTR 0x0008 /* intr mnt, signal pending */ 404 #define R_SOCKERR 0x0010 /* Fatal error on socket */ 405 #define R_TPRINTFMSG 0x0020 /* Did a tprintf msg. */ 406 #define R_NEEDSXMIT 0x0040 /* Needs [re]transmission */ 407 #define R_ASYNC 0x0080 /* Asynchronous mechanics */ 408 #define R_ONREQQ 0x0100 /* On primary request queue */ 409 #define R_LOCKED 0x0200 /* Locked by the someone */ 410 #define R_WANTED 0x0400 /* Someone wants access */ 411 412 /* 413 * A list of nfssvc_sock structures is maintained with all the sockets 414 * that require service by the nfsd. 415 * The nfsuid structs hang off of the nfssvc_sock structs in both lru 416 * and uid hash lists. 417 */ 418 #ifndef NFS_UIDHASHSIZ 419 #define NFS_UIDHASHSIZ 29 /* Tune the size of nfssvc_sock with this */ 420 #endif 421 #define NUIDHASH(sock, uid) \ 422 (&(sock)->ns_uidhashtbl[(uid) % NFS_UIDHASHSIZ]) 423 #ifndef NFS_WDELAYHASHSIZ 424 #define NFS_WDELAYHASHSIZ 16 /* and with this */ 425 #endif 426 #define NWDELAYHASH(sock, f) \ 427 (&(sock)->ns_wdelayhashtbl[(*((u_int32_t *)(f))) % NFS_WDELAYHASHSIZ]) 428 #ifndef NFS_MUIDHASHSIZ 429 #define NFS_MUIDHASHSIZ 63 /* Tune the size of nfsmount with this */ 430 #endif 431 #define NMUIDHASH(nmp, uid) \ 432 (&(nmp)->nm_uidhashtbl[(uid) % NFS_MUIDHASHSIZ]) 433 434 /* 435 * Network address hash list element 436 */ 437 union nethostaddr { 438 u_int32_t had_inetaddr; 439 struct sockaddr *had_nam; 440 }; 441 442 struct nfsuid { 443 TAILQ_ENTRY(nfsuid) nu_lru; /* LRU chain */ 444 LIST_ENTRY(nfsuid) nu_hash; /* Hash list */ 445 int nu_flag; /* Flags */ 446 union nethostaddr nu_haddr; /* Host addr. for dgram sockets */ 447 struct ucred nu_cr; /* Cred uid mapped to */ 448 time_t nu_expire; /* Expiry time (time_uptime) */ 449 struct timeval nu_timestamp; /* Kerb. timestamp */ 450 u_int32_t nu_nickname; /* Nickname on server */ 451 NFSKERBKEY_T nu_key; /* and session key */ 452 }; 453 454 #define nu_inetaddr nu_haddr.had_inetaddr 455 #define nu_nam nu_haddr.had_nam 456 /* Bits for nu_flag */ 457 #define NU_INETADDR 0x1 458 #define NU_NAM 0x2 459 #define NU_NETFAM(u) (((u)->nu_flag & NU_INETADDR) ? AF_INET : AF_ISO) 460 461 struct nfsrv_rec { 462 STAILQ_ENTRY(nfsrv_rec) nr_link; 463 struct sockaddr *nr_address; 464 struct mbuf *nr_packet; 465 }; 466 467 struct nfssvc_sock { 468 TAILQ_ENTRY(nfssvc_sock) ns_chain; /* List of all nfssvc_sock's */ 469 TAILQ_HEAD(, nfsuid) ns_uidlruhead; 470 struct file *ns_fp; 471 struct socket *ns_so; 472 struct sockaddr *ns_nam; 473 struct mbuf *ns_raw; 474 struct mbuf *ns_rawend; 475 STAILQ_HEAD(, nfsrv_rec) ns_rec; 476 struct mbuf *ns_frag; 477 int ns_numrec; 478 u_int32_t ns_flag; 479 u_int32_t ns_needq_upcall; 480 struct mtx ns_solock; 481 int ns_cc; 482 int ns_reclen; 483 int ns_numuids; 484 u_int32_t ns_sref; 485 LIST_HEAD(, nfsrv_descript) ns_tq; /* Write gather lists */ 486 LIST_HEAD(, nfsuid) ns_uidhashtbl[NFS_UIDHASHSIZ]; 487 LIST_HEAD(nfsrvw_delayhash, nfsrv_descript) ns_wdelayhashtbl[NFS_WDELAYHASHSIZ]; 488 struct lwkt_token ns_token; 489 }; 490 491 /* Bits for "ns_flag" */ 492 #define SLP_VALID 0x0001 493 #define SLP_DOREC 0x0002 /* socket holding at least one record */ 494 #define SLP_NEEDQ 0x0004 /* socket needs general rx processing */ 495 #define SLP_DISCONN 0x0008 496 #define SLP_GETSTREAM 0x0010 /* receive stream interlock */ 497 #define SLP_LASTFRAG 0x0020 498 499 #define SLP_ALLFLAGS 0xff 500 #define SLP_ACTION_MASK (SLP_NEEDQ | SLP_DOREC | SLP_DISCONN) 501 502 extern TAILQ_HEAD(nfssvc_sockhead, nfssvc_sock) nfssvc_sockhead; 503 extern int nfssvc_sockhead_flag; 504 extern TAILQ_HEAD(nfsmount_head, nfsmount) nfs_mountq; 505 506 #define SLP_INIT 0x01 507 #define SLP_WANTINIT 0x02 508 509 /* 510 * One of these structures is allocated for each nfsd. 511 */ 512 struct nfsd { 513 TAILQ_ENTRY(nfsd) nfsd_chain; /* List of all nfsd's */ 514 int nfsd_flag; /* NFSD_ flags */ 515 struct nfssvc_sock *nfsd_slp; /* Current socket */ 516 int nfsd_authlen; /* Authenticator len */ 517 u_char nfsd_authstr[RPCAUTH_MAXSIZ]; /* Authenticator data */ 518 int nfsd_verflen; /* and the Verifier */ 519 u_char nfsd_verfstr[RPCVERF_MAXSIZ]; 520 struct thread *nfsd_td; /* thread ptr */ 521 struct nfsrv_descript *nfsd_nd; /* Associated nfsrv_descript */ 522 }; 523 524 /* Bits for "nfsd_flag" */ 525 #define NFSD_WAITING 0x01 526 #define NFSD_REQINPROG 0x02 527 #define NFSD_NEEDAUTH 0x04 528 #define NFSD_AUTHFAIL 0x08 529 530 /* Bits for loadattrcache */ 531 #define NFS_LATTR_NOSHRINK 0x01 532 #define NFS_LATTR_NOMTIMECHECK 0x02 533 534 #define NFSRV_RECLIMIT(slp) ((slp)->ns_numrec >= nfsd_waiting + 4) 535 536 /* 537 * This structure is used by the server for describing each request. 538 * Some fields are used only when write request gathering is performed. 539 */ 540 struct nfsrv_descript { 541 u_quad_t nd_time; /* Write deadline (usec) */ 542 off_t nd_off; /* Start byte offset */ 543 off_t nd_eoff; /* and end byte offset */ 544 LIST_ENTRY(nfsrv_descript) nd_hash; /* Hash list */ 545 LIST_ENTRY(nfsrv_descript) nd_tq; /* and timer list */ 546 LIST_HEAD(,nfsrv_descript) nd_coalesce; /* coalesced writes */ 547 struct mbuf *nd_mrep; /* Request mbuf list */ 548 struct mbuf *nd_md; /* Current dissect mbuf */ 549 struct mbuf *nd_mreq; /* Reply mbuf list */ 550 struct sockaddr *nd_nam; /* and socket addr */ 551 struct sockaddr *nd_nam2; /* return socket addr */ 552 caddr_t nd_dpos; /* Current dissect pos */ 553 u_int32_t nd_procnum; /* RPC # */ 554 int nd_stable; /* storage type */ 555 int nd_flag; /* nd_flag */ 556 int nd_len; /* Length of this write */ 557 int nd_repstat; /* Reply status */ 558 u_int32_t nd_retxid; /* Reply xid */ 559 struct timeval nd_starttime; /* Time RPC initiated */ 560 fhandle_t nd_fh; /* File handle */ 561 struct ucred nd_cr; /* Credentials */ 562 }; 563 564 /* Bits for "nd_flag" */ 565 #define ND_READ 0x01 566 #define ND_WRITE 0x02 567 #define ND_CHECK 0x04 568 #define ND_NFSV3 0x08 569 #define ND_UNUSED010 0x10 570 #define ND_KERBNICK 0x20 571 #define ND_KERBFULL 0x40 572 #define ND_KERBAUTH (ND_KERBNICK | ND_KERBFULL) 573 574 extern TAILQ_HEAD(nfsd_head, nfsd) nfsd_head; 575 extern int nfsd_head_flag; 576 extern int nfsd_waiting; 577 #define NFSD_CHECKSLP 0x01 578 579 /* 580 * These macros compare nfsrv_descript structures. 581 */ 582 #define NFSW_CONTIG(o, n) \ 583 ((o)->nd_eoff >= (n)->nd_off && \ 584 !bcmp((caddr_t)&(o)->nd_fh, (caddr_t)&(n)->nd_fh, NFSX_V3FH)) 585 586 #define NFSW_SAMECRED(o, n) \ 587 (((o)->nd_flag & ND_KERBAUTH) == ((n)->nd_flag & ND_KERBAUTH) && \ 588 !bcmp((caddr_t)&(o)->nd_cr, (caddr_t)&(n)->nd_cr, \ 589 sizeof (struct ucred))) 590 591 /* 592 * Defines for WebNFS 593 */ 594 595 #define WEBNFS_ESC_CHAR '%' 596 #define WEBNFS_SPECCHAR_START 0x80 597 598 #define WEBNFS_NATIVE_CHAR 0x80 599 /* 600 * .. 601 * Possibly more here in the future. 602 */ 603 604 /* 605 * Macro for converting escape characters in WebNFS pathnames. 606 * Should really be in libkern. 607 */ 608 609 #define HEXTOC(c) \ 610 ((c) >= 'a' ? ((c) - ('a' - 10)) : \ 611 ((c) >= 'A' ? ((c) - ('A' - 10)) : ((c) - '0'))) 612 #define HEXSTRTOI(p) \ 613 ((HEXTOC(p[0]) << 4) + HEXTOC(p[1])) 614 615 #ifdef NFS_DEBUG 616 617 extern int nfs_debug; 618 #define NFS_DEBUG_ASYNCIO 1 /* asynchronous i/o */ 619 #define NFS_DEBUG_WG 2 /* server write gathering */ 620 #define NFS_DEBUG_RC 4 /* server request caching */ 621 622 #define NFS_DPF(cat, args) \ 623 do { \ 624 if (nfs_debug & NFS_DEBUG_##cat) kprintf args; \ 625 } while (0) 626 627 #else 628 629 #define NFS_DPF(cat, args) 630 631 #endif 632 633 extern u_int32_t nfs_xdrneg1; 634 extern u_int32_t rpc_reply, rpc_msgdenied, rpc_mismatch, rpc_vers; 635 extern u_int32_t rpc_auth_unix, rpc_msgaccepted, rpc_call, rpc_autherr; 636 extern u_int32_t rpc_auth_kerb; 637 extern u_int32_t nfs_prog, nfs_true, nfs_false; 638 extern struct nfsstats nfsstats; 639 extern nfstype nfsv2_type[9]; 640 extern nfstype nfsv3_type[9]; 641 extern int nfsv2_procid[NFS_NPROCS]; 642 extern enum vtype nv3tov_type[8]; 643 extern int nfsv3_procid[NFS_NPROCS]; 644 extern int nfs_ticks; 645 extern struct nfsrtt nfsrtt; 646 extern int nfsrtton; 647 extern int nfsrvw_procrastinate; 648 extern int nfsrvw_procrastinate_v3; 649 extern int32_t (*nfsrv3_procs[NFS_NPROCS]) (struct nfsrv_descript *nd, 650 struct nfssvc_sock *slp, 651 struct thread *td, 652 struct mbuf **mreqp); 653 654 extern struct nfsv3_diskless nfsv3_diskless; 655 extern struct lwkt_token nfs_token; 656 657 u_quad_t nfs_curusec (void); 658 int nfs_init (struct vfsconf *vfsp); 659 int nfs_uninit (struct vfsconf *vfsp); 660 int nfs_reply (struct nfsmount *nmp, struct nfsreq *); 661 int nfs_getreq (struct nfsrv_descript *,struct nfsd *,int); 662 int nfs_send (struct socket *, struct sockaddr *, struct mbuf *, 663 struct nfsreq *); 664 int nfs_rephead (int, struct nfsrv_descript *, struct nfssvc_sock *, 665 int, struct mbuf **, struct mbuf **, caddr_t *); 666 int nfs_sndlock (struct nfsmount *, struct nfsreq *); 667 void nfs_sndunlock (struct nfsmount *); 668 int nfs_slplock (struct nfssvc_sock *, int); 669 void nfs_slpunlock (struct nfssvc_sock *); 670 int nfs_disct (struct mbuf **, caddr_t *, int, int, caddr_t *); 671 int nfs_vinvalbuf (struct vnode *, int, int); 672 int nfs_readrpc_uio (struct vnode *, struct uio *); 673 void nfs_readrpc_bio (struct vnode *, struct bio *); 674 int nfs_writerpc_uio (struct vnode *, struct uio *, int *, int *); 675 void nfs_writerpc_bio (struct vnode *, struct bio *); 676 int nfs_commitrpc_uio (struct vnode *vp, u_quad_t offset, int cnt, 677 struct thread *td); 678 void nfs_commitrpc_bio (struct vnode *vp, struct bio *); 679 int nfs_readdirrpc_uio (struct vnode *, struct uio *); 680 void nfs_startio(struct vnode *vp, struct bio *, struct thread *); 681 int nfs_doio(struct vnode *vp, struct bio *, struct thread *); 682 void nfs_asyncio(struct vnode *vp, struct bio *bio); 683 int nfs_asyncok(struct nfsmount *nmp); 684 685 int nfs_readlinkrpc_uio (struct vnode *, struct uio *); 686 int nfs_sigintr (struct nfsmount *, struct nfsreq *, struct thread *); 687 int nfs_readdirplusrpc_uio (struct vnode *, struct uio *); 688 int netaddr_match (int, union nethostaddr *, struct sockaddr *); 689 690 int nfs_loadattrcache (struct vnode *, struct mbuf **, caddr_t *, 691 struct vattr *, int); 692 int nfs_namei (struct nlookupdata *, struct ucred *, int, 693 struct vnode **, struct vnode **, fhandle_t *, int, 694 struct nfssvc_sock *, struct sockaddr *, struct mbuf **, 695 caddr_t *, struct vnode **, struct thread *, int, int); 696 void nfsrv_initcache (void); 697 int nfs_getauth (struct nfsmount *, struct nfsreq *, struct ucred *, 698 char **, int *, char *, int *, NFSKERBKEY_T); 699 int nfs_getnickauth (struct nfsmount *, struct ucred *, char **, 700 int *, char *, int); 701 int nfs_savenickauth (struct nfsmount *, struct ucred *, int, 702 NFSKERBKEY_T, struct mbuf **, char **, 703 struct mbuf *); 704 int nfs_adv (struct mbuf **, caddr_t *, int, int); 705 void nfs_nhinit (void); 706 int nfs_nmcancelreqs (struct nfsmount *); 707 void nfs_timer_callout (void*); 708 int nfsrv_dorec (struct nfssvc_sock *, struct nfsd *, 709 struct nfsrv_descript **); 710 int nfsrv_getcache (struct nfsrv_descript *, struct nfssvc_sock *, 711 struct mbuf **); 712 void nfsrv_updatecache (struct nfsrv_descript *, int, struct mbuf *); 713 void nfsrv_cleancache (void); 714 int nfs_connect (struct nfsmount *, struct nfsreq *); 715 void nfs_disconnect (struct nfsmount *); 716 void nfs_safedisconnect (struct nfsmount *); 717 int nfs_getattrcache (struct vnode *, struct vattr *); 718 int nfs_bioread (struct vnode *, struct uio *, int); 719 void nfsrv_init (int); 720 void nfs_clearcommit (struct mount *); 721 int nfsrv_errmap (struct nfsrv_descript *, int); 722 void nfsrvw_sort (gid_t *, int); 723 void nfsrv_setcred (struct ucred *, struct ucred *); 724 int nfsrv_object_create (struct vnode *); 725 void nfsrv_wakenfsd (struct nfssvc_sock *slp, int nparallel); 726 int nfsrv_writegather (struct nfsrv_descript **, struct nfssvc_sock *, 727 struct thread *, struct mbuf **); 728 int nfs_fsinfo (struct nfsmount *, struct vnode *, struct thread *p); 729 730 int nfsrv3_access (struct nfsrv_descript *nfsd, 731 struct nfssvc_sock *slp, 732 struct thread *td, struct mbuf **mrq); 733 int nfsrv_commit (struct nfsrv_descript *nfsd, struct nfssvc_sock *slp, 734 struct thread *td, struct mbuf **mrq); 735 int nfsrv_create (struct nfsrv_descript *nfsd, struct nfssvc_sock *slp, 736 struct thread *td, struct mbuf **mrq); 737 int nfsrv_fhtovp (fhandle_t *, int, struct mount **, struct vnode **, 738 struct ucred *, struct nfssvc_sock *, 739 struct sockaddr *, int *, int, int); 740 int nfsrv_setpublicfs (struct mount *, struct netexport *, 741 struct export_args *); 742 int nfs_ispublicfh (fhandle_t *); 743 int nfsrv_fsinfo (struct nfsrv_descript *nfsd, struct nfssvc_sock *slp, 744 struct thread *td, struct mbuf **mrq); 745 int nfsrv_getattr (struct nfsrv_descript *nfsd, struct nfssvc_sock *slp, 746 struct thread *td, struct mbuf **mrq); 747 int nfsrv_link (struct nfsrv_descript *nfsd, struct nfssvc_sock *slp, 748 struct thread *td, struct mbuf **mrq); 749 int nfsrv_lookup (struct nfsrv_descript *nfsd, struct nfssvc_sock *slp, 750 struct thread *td, struct mbuf **mrq); 751 int nfsrv_mkdir (struct nfsrv_descript *nfsd, struct nfssvc_sock *slp, 752 struct thread *td, struct mbuf **mrq); 753 int nfsrv_mknod (struct nfsrv_descript *nfsd, struct nfssvc_sock *slp, 754 struct thread *td, struct mbuf **mrq); 755 int nfsrv_noop (struct nfsrv_descript *nfsd, struct nfssvc_sock *slp, 756 struct thread *td, struct mbuf **mrq); 757 int nfsrv_null (struct nfsrv_descript *nfsd, struct nfssvc_sock *slp, 758 struct thread *td, struct mbuf **mrq); 759 int nfsrv_pathconf (struct nfsrv_descript *nfsd, 760 struct nfssvc_sock *slp, struct thread *td, 761 struct mbuf **mrq); 762 int nfsrv_read (struct nfsrv_descript *nfsd, struct nfssvc_sock *slp, 763 struct thread *td, struct mbuf **mrq); 764 int nfsrv_readdir (struct nfsrv_descript *nfsd, 765 struct nfssvc_sock *slp, 766 struct thread *td, struct mbuf **mrq); 767 int nfsrv_readdirplus (struct nfsrv_descript *nfsd, 768 struct nfssvc_sock *slp, struct thread *td, 769 struct mbuf **mrq); 770 int nfsrv_readlink (struct nfsrv_descript *nfsd, 771 struct nfssvc_sock *slp, struct thread *td, 772 struct mbuf **mrq); 773 int nfsrv_remove (struct nfsrv_descript *nfsd, struct nfssvc_sock *slp, 774 struct thread *td, struct mbuf **mrq); 775 int nfsrv_rename (struct nfsrv_descript *nfsd, struct nfssvc_sock *slp, 776 struct thread *td, struct mbuf **mrq); 777 int nfsrv_rmdir (struct nfsrv_descript *nfsd, struct nfssvc_sock *slp, 778 struct thread *td, struct mbuf **mrq); 779 int nfsrv_setattr (struct nfsrv_descript *nfsd, 780 struct nfssvc_sock *slp, 781 struct thread *td, struct mbuf **mrq); 782 int nfsrv_statfs (struct nfsrv_descript *nfsd, 783 struct nfssvc_sock *slp, 784 struct thread *td, struct mbuf **mrq); 785 int nfsrv_symlink (struct nfsrv_descript *nfsd, 786 struct nfssvc_sock *slp, 787 struct thread *td, struct mbuf **mrq); 788 int nfsrv_write (struct nfsrv_descript *nfsd, struct nfssvc_sock *slp, 789 struct thread *td, struct mbuf **mrq); 790 void nfsrv_rcv (struct socket *so, void *arg, int waitflag); 791 void nfsrv_rcv_upcall (struct socket *so, void *arg, int waitflag); 792 void nfsrv_slpderef (struct nfssvc_sock *slp); 793 void nfsrv_slpref (struct nfssvc_sock *slp); 794 int nfs_meta_setsize (struct vnode *vp, struct thread *td, 795 off_t nbase, int trivial); 796 int nfs_clientd(struct nfsmount *nmp, struct ucred *cred, 797 struct nfsd_cargs *ncd, int flag, caddr_t argp, 798 struct thread *td); 799 void nfssvc_iod_reader(void *arg); 800 void nfssvc_iod_writer(void *arg); 801 void nfssvc_iod_stop1(struct nfsmount *nmp); 802 void nfssvc_iod_stop2(struct nfsmount *nmp); 803 void nfssvc_iod_writer_wakeup(struct nfsmount *nmp); 804 void nfssvc_iod_reader_wakeup(struct nfsmount *nmp); 805 806 #endif /* _KERNEL */ 807 808 #endif 809