bsd/nfs/nfs.h

   1 /*
   2  * Copyright (c) 2000-2014 Apple Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28 /* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
  29 /*
  30  * Copyright (c) 1989, 1993, 1995
  31  *      The Regents of the University of California.  All rights reserved.
  32  *
  33  * This code is derived from software contributed to Berkeley by
  34  * Rick Macklem at The University of Guelph.
  35  *
  36  * Redistribution and use in source and binary forms, with or without
  37  * modification, are permitted provided that the following conditions
  38  * are met:
  39  * 1. Redistributions of source code must retain the above copyright
  40  *    notice, this list of conditions and the following disclaimer.
  41  * 2. Redistributions in binary form must reproduce the above copyright
  42  *    notice, this list of conditions and the following disclaimer in the
  43  *    documentation and/or other materials provided with the distribution.
  44  * 3. All advertising materials mentioning features or use of this software
  45  *    must display the following acknowledgement:
  46  *      This product includes software developed by the University of
  47  *      California, Berkeley and its contributors.
  48  * 4. Neither the name of the University nor the names of its contributors
  49  *    may be used to endorse or promote products derived from this software
  50  *    without specific prior written permission.
  51  *
  52  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  53  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  54  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  55  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  56  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  57  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  58  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  59  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  60  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  61  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  62  * SUCH DAMAGE.
  63  *
  64  *      @(#)nfs.h       8.4 (Berkeley) 5/1/95
  65  * FreeBSD-Id: nfs.h,v 1.32 1997/10/12 20:25:38 phk Exp $
  66  */
  67
  68 #ifndef _NFS_NFS_H_
  69 #define _NFS_NFS_H_
  70
  71 #include <sys/appleapiopts.h>
  72 #include <sys/cdefs.h>
  73
  74 #ifdef __APPLE_API_PRIVATE
  75 /*
  76  * Tunable constants for nfs
  77  */
  78
  79 #define NFS_TICKINTVL   5               /* Desired time for a tick (msec) */
  80 #define NFS_HZ          (hz / nfs_ticks) /* Ticks/sec */
  81 extern int nfs_ticks;
  82 #define NFS_TIMEO       (1 * NFS_HZ)    /* Default timeout = 1 second */
  83 #define NFS_MINTIMEO    (1 * NFS_HZ)    /* Min timeout to use */
  84 #define NFS_MAXTIMEO    (60 * NFS_HZ)   /* Max timeout to backoff to */
  85 #define NFS_MINIDEMTIMEO (5 * NFS_HZ)   /* Min timeout for non-idempotent ops*/
  86 #define NFS_MAXREXMIT   100             /* Stop counting after this many */
  87 #define NFS_RETRANS     10              /* Num of retrans for soft mounts */
  88 #define NFS_TRYLATERDEL 4               /* Initial try later delay (sec) */
  89 #define NFS_MAXGRPS     16U             /* Max. size of groups list */
  90 #define NFS_MINATTRTIMO 5               /* Attribute cache timeout in sec */
  91 #define NFS_MAXATTRTIMO 60
  92 #define NFS_MINDIRATTRTIMO 5            /* directory attribute cache timeout in sec */
  93 #define NFS_MAXDIRATTRTIMO 60
  94 #define NFS_IOSIZE      (1024 * 1024)   /* suggested I/O size */
  95 #define NFS_RWSIZE      32768           /* Def. read/write data size <= 32K */
  96 #define NFS_WSIZE       NFS_RWSIZE      /* Def. write data size <= 32K */
  97 #define NFS_RSIZE       NFS_RWSIZE      /* Def. read data size <= 32K */
  98 #define NFS_DGRAM_WSIZE 8192            /* UDP Def. write data size <= 8K */
  99 #define NFS_DGRAM_RSIZE 8192            /* UDP Def. read data size <= 8K */
 100 #define NFS_READDIRSIZE 32768           /* Def. readdir size */
 101 #define NFS_DEFRAHEAD   16              /* Def. read ahead # blocks */
 102 #define NFS_MAXRAHEAD   128             /* Max. read ahead # blocks */
 103 #define NFS_DEFMAXASYNCWRITES   128     /* Def. max # concurrent async write RPCs */
 104 #define NFS_DEFASYNCTHREAD      16      /* Def. # nfsiod threads */
 105 #define NFS_MAXASYNCTHREAD      64      /* max # nfsiod threads */
 106 #define NFS_ASYNCTHREADMAXIDLE  60      /* Seconds before idle nfsiods are reaped */
 107 #define NFS_DEFSTATFSRATELIMIT  10      /* Def. max # statfs RPCs per second */
 108 #define NFS_REQUESTDELAY        10      /* ms interval to check request queue */
 109 #define NFSRV_DEADSOCKDELAY     5       /* Seconds before dead sockets are reaped */
 110 #define NFSRV_MAXWGATHERDELAY   100     /* Max. write gather delay (msec) */
 111 #ifndef NFSRV_WGATHERDELAY
 112 #define NFSRV_WGATHERDELAY      1       /* Default write gather delay (msec) */
 113 #endif
 114 #define NFS_DIRBLKSIZ   4096            /* size of NFS directory buffers */
 115 #if defined(KERNEL) && !defined(DIRBLKSIZ)
 116 #define DIRBLKSIZ       512             /* XXX we used to use ufs's DIRBLKSIZ */
 117                                         /* can't be larger than NFS_FABLKSIZE */
 118 #endif
 119
 120 /* default values for unresponsive mount timeouts */
 121 #define NFS_TPRINTF_INITIAL_DELAY       12
 122 #define NFS_TPRINTF_DELAY               30
 123
 124 /*
 125  * Oddballs
 126  */
 127 #define NFS_CMPFH(n, f, s) \
 128         ((n)->n_fhsize == (s) && !bcmp((caddr_t)(n)->n_fhp, (caddr_t)(f), (s)))
 129 #define NFSRV_NDMAXDATA(n) \
 130                 (((n)->nd_vers == NFS_VER3) ? (((n)->nd_nam2) ? \
 131                  NFS_MAXDGRAMDATA : NFSRV_MAXDATA) : NFS_V2MAXDATA)
 132
 133 /*
 134  * The IO_METASYNC flag should be implemented for local file systems.
 135  * (Until then, it is nothin at all.)
 136  */
 137 #ifndef IO_METASYNC
 138 #define IO_METASYNC     0
 139 #endif
 140
 141 /*
 142  * Expected allocation sizes for major data structures. If the actual size
 143  * of the structure exceeds these sizes, then malloc() will be allocating
 144  * almost twice the memory required. This is used in nfs_init() to warn
 145  * the sysadmin that the size of a structure should be reduced.
 146  * (These sizes are always a power of 2. If the kernel malloc() changes
 147  *  to one that does not allocate space in powers of 2 size, then this all
 148  *  becomes bunk!).
 149  * Note that some of these structures come out of their own nfs zones.
 150  */
 151 #define NFS_NODEALLOC   1024
 152 #define NFS_MNTALLOC    1024
 153 #define NFS_SVCALLOC    512
 154
 155 #define NFS_ARGSVERSION_XDR     88      /* NFS mount args are in XDR format */
 156
 157 #define NFS_XDRARGS_VERSION_0   0
 158 #define NFS_MATTR_BITMAP_LEN    1               /* length of mount attributes bitmap */
 159 #define NFS_MFLAG_BITMAP_LEN    1               /* length of mount flags bitmap */
 160
 161 /* NFS mount attributes */
 162 #define NFS_MATTR_FLAGS                 0       /* mount flags (NFS_MATTR_*) */
 163 #define NFS_MATTR_NFS_VERSION           1       /* NFS protocol version */
 164 #define NFS_MATTR_NFS_MINOR_VERSION     2       /* NFS protocol minor version */
 165 #define NFS_MATTR_READ_SIZE             3       /* READ RPC size */
 166 #define NFS_MATTR_WRITE_SIZE            4       /* WRITE RPC size */
 167 #define NFS_MATTR_READDIR_SIZE          5       /* READDIR RPC size */
 168 #define NFS_MATTR_READAHEAD             6       /* block readahead count */
 169 #define NFS_MATTR_ATTRCACHE_REG_MIN     7       /* minimum attribute cache time */
 170 #define NFS_MATTR_ATTRCACHE_REG_MAX     8       /* maximum attribute cache time */
 171 #define NFS_MATTR_ATTRCACHE_DIR_MIN     9       /* minimum attribute cache time for dirs */
 172 #define NFS_MATTR_ATTRCACHE_DIR_MAX     10      /* maximum attribute cache time for dirs */
 173 #define NFS_MATTR_LOCK_MODE             11      /* advisory file locking mode (NFS_LOCK_MODE_*) */
 174 #define NFS_MATTR_SECURITY              12      /* RPC security flavors to use */
 175 #define NFS_MATTR_MAX_GROUP_LIST        13      /* max # of RPC AUTH_SYS groups */
 176 #define NFS_MATTR_SOCKET_TYPE           14      /* socket transport type as a netid-like string */
 177 #define NFS_MATTR_NFS_PORT              15      /* port # to use for NFS protocol */
 178 #define NFS_MATTR_MOUNT_PORT            16      /* port # to use for MOUNT protocol */
 179 #define NFS_MATTR_REQUEST_TIMEOUT       17      /* initial RPC request timeout value */
 180 #define NFS_MATTR_SOFT_RETRY_COUNT      18      /* max RPC retransmissions for soft mounts */
 181 #define NFS_MATTR_DEAD_TIMEOUT          19      /* how long until unresponsive mount is considered dead */
 182 #define NFS_MATTR_FH                    20      /* file handle for mount directory */
 183 #define NFS_MATTR_FS_LOCATIONS          21      /* list of locations for the file system */
 184 #define NFS_MATTR_MNTFLAGS              22      /* VFS mount flags (MNT_*) */
 185 #define NFS_MATTR_MNTFROM               23      /* fixed string to use for "f_mntfromname" */
 186 #define NFS_MATTR_REALM                 24      /* Realm to authenticate with */
 187 #define NFS_MATTR_PRINCIPAL             25      /* GSS principal to authenticate with */
 188 #define NFS_MATTR_SVCPRINCIPAL          26      /* GSS principal to authenticate to, the server principal */
 189
 190 /* NFS mount flags */
 191 #define NFS_MFLAG_SOFT                  0       /* soft mount (requests fail if unresponsive) */
 192 #define NFS_MFLAG_INTR                  1       /* allow operations to be interrupted */
 193 #define NFS_MFLAG_RESVPORT              2       /* use a reserved port */
 194 #define NFS_MFLAG_NOCONNECT             3       /* don't connect the socket (UDP) */
 195 #define NFS_MFLAG_DUMBTIMER             4       /* don't estimate RTT dynamically */
 196 #define NFS_MFLAG_CALLUMNT              5       /* call MOUNTPROC_UMNT on unmount */
 197 #define NFS_MFLAG_RDIRPLUS              6       /* request additional info when reading directories */
 198 #define NFS_MFLAG_NONEGNAMECACHE        7       /* don't do negative name caching */
 199 #define NFS_MFLAG_MUTEJUKEBOX           8       /* don't treat jukebox errors as unresponsive */
 200 #define NFS_MFLAG_EPHEMERAL             9       /* ephemeral (mirror) mount */
 201 #define NFS_MFLAG_NOCALLBACK            10      /* don't provide callback RPC service */
 202 #define NFS_MFLAG_NONAMEDATTR           11      /* don't use named attributes */
 203 #define NFS_MFLAG_NOACL                 12      /* don't support ACLs */
 204 #define NFS_MFLAG_ACLONLY               13      /* only support ACLs - not mode */
 205 #define NFS_MFLAG_NFC                   14      /* send NFC strings */
 206 #define NFS_MFLAG_NOQUOTA               15      /* don't support QUOTA requests */
 207 #define NFS_MFLAG_MNTUDP                16      /* MOUNT protocol should use UDP */
 208 #define NFS_MFLAG_MNTQUICK              17      /* use short timeouts while mounting */
 209
 210 /* NFS advisory file locking modes */
 211 #define NFS_LOCK_MODE_ENABLED           0       /* advisory file locking enabled */
 212 #define NFS_LOCK_MODE_DISABLED          1       /* do not support advisory file locking */
 213 #define NFS_LOCK_MODE_LOCAL             2       /* perform advisory file locking locally */
 214
 215 /*
 216  * Old-style arguments to mount NFS
 217  */
 218 #define NFS_ARGSVERSION 6               /* change when nfs_args changes */
 219 struct nfs_args {
 220         int             version;        /* args structure version number */
 221 #ifdef KERNEL
 222         user32_addr_t addr;             /* file server address */
 223 #else
 224         struct sockaddr *addr;          /* file server address */
 225 #endif
 226         int             addrlen;        /* length of address */
 227         int             sotype;         /* Socket type */
 228         int             proto;          /* and Protocol */
 229 #ifdef KERNEL
 230         user32_addr_t fh;               /* File handle to be mounted */
 231 #else
 232         u_char          *fh;            /* File handle to be mounted */
 233 #endif
 234         int             fhsize;         /* Size, in bytes, of fh */
 235         int             flags;          /* flags */
 236         int             wsize;          /* write size in bytes */
 237         int             rsize;          /* read size in bytes */
 238         int             readdirsize;    /* readdir size in bytes */
 239         int             timeo;          /* initial timeout in .1 secs */
 240         int             retrans;        /* times to retry send */
 241         int             maxgrouplist;   /* Max. size of group list */
 242         int             readahead;      /* # of blocks to readahead */
 243         int             leaseterm;      /* obsolete: Term (sec) of lease */
 244         int             deadthresh;     /* obsolete: Retrans threshold */
 245 #ifdef KERNEL
 246         user32_addr_t hostname; /* server's name */
 247 #else
 248         char            *hostname;      /* server's name */
 249 #endif
 250         /* NFS_ARGSVERSION 3 ends here */
 251         int             acregmin;       /* reg file min attr cache timeout */
 252         int             acregmax;       /* reg file max attr cache timeout */
 253         int             acdirmin;       /* dir min attr cache timeout */
 254         int             acdirmax;       /* dir max attr cache timeout */
 255         /* NFS_ARGSVERSION 4 ends here */
 256         uint32_t        auth;           /* security mechanism flavor */
 257         /* NFS_ARGSVERSION 5 ends here */
 258         uint32_t        deadtimeout;    /* secs until unresponsive mount considered dead */
 259 };
 260
 261 /* incremental size additions in each version of nfs_args */
 262 #define NFS_ARGSVERSION4_INCSIZE        (4 * sizeof(int))
 263 #define NFS_ARGSVERSION5_INCSIZE        (sizeof(uint32_t))
 264 #define NFS_ARGSVERSION6_INCSIZE        (sizeof(uint32_t))
 265
 266 #ifdef KERNEL
 267 /* LP64 version of nfs_args.  all pointers and longs
 268  * grow when we're dealing with a 64-bit process.
 269  * WARNING - keep in sync with nfs_args
 270  */
 271 struct user_nfs_args {
 272         int             version;        /* args structure version number */
 273         user_addr_t     addr __attribute((aligned(8)));         /* file server address */
 274         int             addrlen;        /* length of address */
 275         int             sotype;         /* Socket type */
 276         int             proto;          /* and Protocol */
 277         user_addr_t     fh __attribute((aligned(8)));           /* File handle to be mounted */
 278         int             fhsize;         /* Size, in bytes, of fh */
 279         int             flags;          /* flags */
 280         int             wsize;          /* write size in bytes */
 281         int             rsize;          /* read size in bytes */
 282         int             readdirsize;    /* readdir size in bytes */
 283         int             timeo;          /* initial timeout in .1 secs */
 284         int             retrans;        /* times to retry send */
 285         int             maxgrouplist;   /* Max. size of group list */
 286         int             readahead;      /* # of blocks to readahead */
 287         int             leaseterm;      /* obsolete: Term (sec) of lease */
 288         int             deadthresh;     /* obsolete: Retrans threshold */
 289         user_addr_t     hostname __attribute((aligned(8)));     /* server's name */
 290         /* NFS_ARGSVERSION 3 ends here */
 291         int             acregmin;       /* reg file min attr cache timeout */
 292         int             acregmax;       /* reg file max attr cache timeout */
 293         int             acdirmin;       /* dir min attr cache timeout */
 294         int             acdirmax;       /* dir max attr cache timeout */
 295         /* NFS_ARGSVERSION 4 ends here */
 296         uint32_t        auth;           /* security mechanism flavor */
 297         /* NFS_ARGSVERSION 5 ends here */
 298         uint32_t        deadtimeout;    /* secs until unresponsive mount considered dead */
 299 };
 300 #endif // KERNEL
 301
 302 /*
 303  * Old-style NFS mount option flags
 304  */
 305 #define NFSMNT_SOFT             0x00000001  /* soft mount (hard is default) */
 306 #define NFSMNT_WSIZE            0x00000002  /* set write size */
 307 #define NFSMNT_RSIZE            0x00000004  /* set read size */
 308 #define NFSMNT_TIMEO            0x00000008  /* set initial timeout */
 309 #define NFSMNT_RETRANS          0x00000010  /* set number of request retries */
 310 #define NFSMNT_MAXGRPS          0x00000020  /* set maximum grouplist size */
 311 #define NFSMNT_INT              0x00000040  /* allow interrupts on hard mount */
 312 #define NFSMNT_NOCONN           0x00000080  /* Don't Connect the socket */
 313 #define NFSMNT_NONEGNAMECACHE   0x00000100  /* Don't do negative name caching */
 314 #define NFSMNT_NFSV3            0x00000200  /* Use NFS Version 3 protocol */
 315 #define NFSMNT_NFSV4            0x00000400  /* Use NFS Version 4 protocol */
 316 #define NFSMNT_DUMBTIMR         0x00000800  /* Don't estimate rtt dynamically */
 317 #define NFSMNT_DEADTIMEOUT      0x00001000  /* unmount after a period of unresponsiveness */
 318 #define NFSMNT_READAHEAD        0x00002000  /* set read ahead */
 319 #define NFSMNT_CALLUMNT         0x00004000  /* call MOUNTPROC_UMNT on unmount */
 320 #define NFSMNT_RESVPORT         0x00008000  /* Allocate a reserved port */
 321 #define NFSMNT_RDIRPLUS         0x00010000  /* Use Readdirplus for V3 */
 322 #define NFSMNT_READDIRSIZE      0x00020000  /* Set readdir size */
 323 #define NFSMNT_NOLOCKS          0x00040000  /* don't support file locking */
 324 #define NFSMNT_LOCALLOCKS       0x00080000  /* do file locking locally on client */
 325 #define NFSMNT_ACREGMIN         0x00100000  /* reg min attr cache timeout */
 326 #define NFSMNT_ACREGMAX         0x00200000  /* reg max attr cache timeout */
 327 #define NFSMNT_ACDIRMIN         0x00400000  /* dir min attr cache timeout */
 328 #define NFSMNT_ACDIRMAX         0x00800000  /* dir max attr cache timeout */
 329 #define NFSMNT_SECFLAVOR        0x01000000  /* Use security flavor */
 330 #define NFSMNT_SECSYSOK         0x02000000  /* Server can support auth sys */
 331 #define NFSMNT_MUTEJUKEBOX      0x04000000  /* don't treat jukebox errors as unresponsive */
 332 #define NFSMNT_NOQUOTA          0x08000000  /* don't support QUOTA requests */
 333
 334
 335 /*
 336  * fs.nfs sysctl(3) NFS_MOUNTINFO defines
 337  */
 338 #define NFS_MOUNT_INFO_VERSION  0       /* nfsstat mount information version */
 339 #define NFS_MIATTR_BITMAP_LEN   1       /* length of mount info attributes bitmap */
 340 #define NFS_MIFLAG_BITMAP_LEN   1       /* length of mount info flags bitmap */
 341
 342 /* NFS mount info attributes */
 343 #define NFS_MIATTR_FLAGS                0       /* mount info flags bitmap (MIFLAG_*) */
 344 #define NFS_MIATTR_ORIG_ARGS            1       /* original mount args passed into mount call */
 345 #define NFS_MIATTR_CUR_ARGS             2       /* current mount args values */
 346 #define NFS_MIATTR_CUR_LOC_INDEX        3       /* current fs location index */
 347
 348 /* NFS mount info flags */
 349 #define NFS_MIFLAG_DEAD         0       /* mount is dead */
 350 #define NFS_MIFLAG_NOTRESP      1       /* server is unresponsive */
 351 #define NFS_MIFLAG_RECOVERY     2       /* mount in recovery */
 352
 353
 354 /*
 355  * Structures for the nfssvc(2) syscall. Not that anyone but nfsd
 356  * should ever try and use it.
 357  */
 358 struct nfsd_args {
 359         int     sock;           /* Socket to serve */
 360 #ifdef KERNEL
 361         user32_addr_t   name;           /* Client addr for connection based sockets */
 362 #else
 363         caddr_t name;           /* Client addr for connection based sockets */
 364 #endif
 365         int     namelen;        /* Length of name */
 366 };
 367
 368 #ifdef KERNEL
 369 /* LP64 version of nfsd_args.  all pointers and longs
 370  * grow when we're dealing with a 64-bit process.
 371  * WARNING - keep in sync with nfsd_args
 372  */
 373 struct user_nfsd_args {
 374         int             sock;           /* Socket to serve */
 375         user_addr_t     name __attribute((aligned(8)));         /* Client addr for connection based sockets */
 376         int             namelen;        /* Length of name */
 377 };
 378
 379 #endif // KERNEL
 380
 381 /*
 382  * NFS Server File Handle structures
 383  */
 384
 385 /* NFS export handle identifies which NFS export */
 386 #define NFS_FH_VERSION  0x4e580000              /* 'NX00' */
 387 struct nfs_exphandle {
 388         uint32_t        nxh_version;            /* data structure version */
 389         uint32_t        nxh_fsid;               /* File System Export ID */
 390         uint32_t        nxh_expid;              /* Export ID */
 391         uint16_t        nxh_flags;              /* export handle flags */
 392         uint8_t         nxh_reserved;           /* future use */
 393         uint8_t         nxh_fidlen;             /* length of File ID */
 394 };
 395
 396 /* nxh_flags */
 397 #define NXHF_INVALIDFH          0x0001          /* file handle is invalid */
 398
 399 #define NFS_MAX_FID_SIZE        (NFS_MAX_FH_SIZE - sizeof(struct nfs_exphandle))
 400 #define NFSV4_MAX_FID_SIZE      (NFSV4_MAX_FH_SIZE - sizeof(struct nfs_exphandle))
 401 #define NFSV3_MAX_FID_SIZE      (NFSV3_MAX_FH_SIZE - sizeof(struct nfs_exphandle))
 402 #define NFSV2_MAX_FID_SIZE      (NFSV2_MAX_FH_SIZE - sizeof(struct nfs_exphandle))
 403
 404 /* NFS server internal view of fhandle_t */
 405 /* The first sizeof(fhandle_t) bytes must match what goes into fhandle_t. */
 406 /* (fhp is used to allow use of an external buffer) */
 407 struct nfs_filehandle {
 408         uint32_t                nfh_len;        /* total length of file handle */
 409         struct nfs_exphandle    nfh_xh;         /* export handle */
 410         unsigned char           nfh_fid[NFS_MAX_FID_SIZE]; /* File ID */
 411         unsigned char           *nfh_fhp;       /* pointer to file handle */
 412 };
 413
 414 /*
 415  * NFS export data structures
 416  */
 417
 418 /* Structure to hold an array of security flavors */
 419 #define NX_MAX_SEC_FLAVORS 5
 420 struct nfs_sec {
 421         int count;
 422         uint32_t flavors[NX_MAX_SEC_FLAVORS];
 423 };
 424
 425 struct nfs_export_net_args {
 426         uint32_t                nxna_flags;     /* export flags */
 427         struct xucred           nxna_cred;      /* mapped credential for root/all user */
 428         struct sockaddr_storage nxna_addr;      /* net address to which exported */
 429         struct sockaddr_storage nxna_mask;      /* mask for net address */
 430         struct nfs_sec          nxna_sec;       /* security mechanism flavors */
 431 };
 432
 433 struct nfs_export_args {
 434         uint32_t                nxa_fsid;       /* export FS ID */
 435         uint32_t                nxa_expid;      /* export ID */
 436 #ifdef KERNEL
 437         user32_addr_t           nxa_fspath;     /* export FS path */
 438         user32_addr_t           nxa_exppath;    /* export sub-path */
 439 #else
 440         char                    *nxa_fspath;    /* export FS path */
 441         char                    *nxa_exppath;   /* export sub-path */
 442 #endif
 443         uint32_t                nxa_flags;      /* export arg flags */
 444         uint32_t                nxa_netcount;   /* #entries in ex_nets array */
 445 #ifdef KERNEL
 446         user32_addr_t           nxa_nets;       /* array of net args */
 447 #else
 448         struct nfs_export_net_args *nxa_nets;   /* array of net args */
 449 #endif
 450 };
 451
 452 #ifdef KERNEL
 453 /* LP64 version of export_args */
 454
 455 struct user_nfs_export_args {
 456         uint32_t                nxa_fsid;       /* export FS ID */
 457         uint32_t                nxa_expid;      /* export ID */
 458         user_addr_t             nxa_fspath;     /* export FS path */
 459         user_addr_t             nxa_exppath;    /* export sub-path */
 460         uint32_t                nxa_flags;      /* export arg flags */
 461         uint32_t                nxa_netcount;   /* #entries in ex_nets array */
 462         user_addr_t             nxa_nets;       /* array of net args */
 463 };
 464
 465 #endif /* KERNEL */
 466
 467 /* nfs export arg flags */
 468 #define NXA_DELETE              0x0001  /* delete the specified export(s) */
 469 #define NXA_ADD                 0x0002  /* add the specified export(s) */
 470 #define NXA_REPLACE             0x0003  /* delete and add the specified export(s) */
 471 #define NXA_DELETE_ALL          0x0004  /* delete all exports */
 472 #define NXA_OFFLINE             0x0008  /* export is offline */
 473 #define NXA_CHECK               0x0010  /* check if exportable */
 474
 475 /* export option flags */
 476 #define NX_READONLY             0x0001  /* exported read-only */
 477 #define NX_DEFAULTEXPORT        0x0002  /* exported to the world */
 478 #define NX_MAPROOT              0x0004  /* map root access to anon credential */
 479 #define NX_MAPALL               0x0008  /* map all access to anon credential */
 480 #define NX_32BITCLIENTS         0x0020  /* restrict directory cookies to 32 bits */
 481 #define NX_OFFLINE              0x0040  /* export is offline */
 482 #define NX_MANGLEDNAMES         0x0080  /* export will return mangled names for names > 255 bytes */
 483
 484 /*
 485  * fs.nfs sysctl(3) export stats record structures
 486  */
 487 #define NFS_EXPORT_STAT_REC_VERSION 1   /* export stat record version */
 488 #define NFS_USER_STAT_REC_VERSION 1     /* active user list record version */
 489
 490 /* descriptor describing following records */
 491 struct nfs_export_stat_desc
 492 {
 493         uint32_t rec_vers;              /* version of export stat records */
 494         uint32_t rec_count;             /* total record count */
 495 }__attribute__((__packed__));
 496
 497 /* export stat record containing path and stat counters */
 498 struct nfs_export_stat_rec {
 499         char     path[RPCMNT_PATHLEN + 1];
 500         uint64_t ops;           /* Count of NFS Requests received for this export */
 501         uint64_t bytes_read;    /* Count of bytes read from this export */
 502         uint64_t bytes_written; /* Count of bytes written to this export */
 503 }__attribute__((__packed__));
 504
 505 /* Active user list stat buffer descriptor */
 506 struct nfs_user_stat_desc
 507 {
 508         uint32_t rec_vers;      /* version of active user stat records */
 509         uint32_t rec_count;     /* total record count */
 510 }__attribute__((__packed__));
 511
 512 /* Active user list user stat record format */
 513 struct nfs_user_stat_user_rec {
 514         u_char                  rec_type;
 515         uid_t                   uid;
 516         struct sockaddr_storage sock;
 517         uint64_t                ops;
 518         uint64_t                bytes_read;
 519         uint64_t                bytes_written;
 520         uint32_t                tm_start;
 521         uint32_t                tm_last;
 522 }__attribute__((__packed__));
 523
 524 /* Active user list path record format */
 525 struct nfs_user_stat_path_rec {
 526         u_char  rec_type;
 527         char    path[RPCMNT_PATHLEN + 1];
 528 }__attribute__((__packed__));
 529
 530 /* Defines for rec_type field of
 531  * nfs_user_stat_rec & nfs_user_stat_rec
 532  * data structures
 533  */
 534 #define NFS_USER_STAT_USER_REC  0
 535 #define NFS_USER_STAT_PATH_REC  1
 536
 537
 538 #ifdef KERNEL
 539 struct nfs_exportfs;
 540
 541 struct nfs_export_options {
 542         uint32_t                nxo_flags;      /* export options */
 543         kauth_cred_t            nxo_cred;       /* mapped credential */
 544         struct nfs_sec          nxo_sec;        /* security mechanism flavors */
 545 };
 546
 547 /* Network address lookup element and individual export options */
 548 struct nfs_netopt {
 549         struct radix_node               no_rnodes[2];   /* radix tree glue */
 550         struct nfs_export_options       no_opt;         /* export options */
 551 };
 552
 553 /* statistic counters for each exported directory
 554  *
 555  * Since 64-bit atomic operations are not available on 32-bit platforms,
 556  * 64-bit counters are implemented using 32-bit integers and 32-bit
 557  * atomic operations
 558  */
 559 typedef struct nfsstatcount64 {
 560         uint32_t        hi;
 561         uint32_t        lo;
 562 } nfsstatcount64;
 563
 564 struct nfs_export_stat_counters {
 565         struct nfsstatcount64 ops;              /* Count of NFS Requests received for this export  */
 566         struct nfsstatcount64 bytes_read;       /* Count of bytes read from this export */
 567         struct nfsstatcount64 bytes_written;    /* Count of bytes written to his export */
 568 }__attribute__((__packed__));
 569
 570 /* Macro for updating nfs export stat counters */
 571 #define NFSStatAdd64(PTR, VAL) \
 572         do { \
 573                 uint32_t NFSSA_OldValue = \
 574                 OSAddAtomic((VAL), &(PTR)->lo); \
 575                 if ((NFSSA_OldValue + (VAL)) < NFSSA_OldValue) \
 576                         OSAddAtomic(1, &(PTR)->hi); \
 577         } while (0)
 578
 579 /* Some defines for dealing with active user list stats */
 580 #define NFSRV_USER_STAT_DEF_MAX_NODES 1024      /* default active user list size limit */
 581 #define NFSRV_USER_STAT_DEF_IDLE_SEC  7200      /* default idle seconds (node no longer considered active) */
 582
 583 /* active user list globals */
 584 extern uint32_t nfsrv_user_stat_enabled;                /* enable/disable active user list */
 585 extern uint32_t nfsrv_user_stat_node_count;             /* current count of user stat nodes */
 586 extern uint32_t nfsrv_user_stat_max_idle_sec;   /* idle seconds (node no longer considered active) */
 587 extern uint32_t nfsrv_user_stat_max_nodes;              /* active user list size limit */
 588 extern lck_grp_t *nfsrv_active_user_mutex_group;
 589
 590 /* An active user node represented in the kernel */
 591 struct nfs_user_stat_node {
 592         TAILQ_ENTRY(nfs_user_stat_node) lru_link;
 593         LIST_ENTRY(nfs_user_stat_node)  hash_link;
 594         uid_t                   uid;
 595         struct sockaddr_storage sock;
 596         uint64_t                ops;
 597         uint64_t                bytes_read;
 598         uint64_t                bytes_written;
 599         uint32_t                tm_start;
 600         uint32_t                tm_last;
 601 };
 602
 603 /* Hash table for active user nodes */
 604 #define NFS_USER_STAT_HASH_SIZE 16      /* MUST be a power of 2 */
 605 #define NFS_USER_STAT_HASH(userhashtbl, uid) \
 606                 &((userhashtbl)[(uid) & (NFS_USER_STAT_HASH_SIZE - 1)])
 607
 608 TAILQ_HEAD(nfs_user_stat_lru_head, nfs_user_stat_node);
 609 LIST_HEAD(nfs_user_stat_hashtbl_head, nfs_user_stat_node);
 610
 611 /* Active user list data structure */
 612 /* One per exported directory */
 613 struct nfs_active_user_list {
 614         struct nfs_user_stat_lru_head           user_lru;
 615         struct nfs_user_stat_hashtbl_head       user_hashtbl[NFS_USER_STAT_HASH_SIZE];
 616         uint32_t                                node_count;
 617         lck_mtx_t user_mutex;
 618 };
 619
 620
 621 /* Network export information */
 622 /* one of these for each exported directory */
 623 struct nfs_export {
 624         LIST_ENTRY(nfs_export)          nx_next;        /* FS export list */
 625         LIST_ENTRY(nfs_export)          nx_hash;        /* export hash chain */
 626         struct nfs_export               *nx_parent;     /* parent export */
 627         uint32_t                        nx_id;          /* export ID */
 628         uint32_t                        nx_flags;       /* export flags */
 629         struct nfs_exportfs             *nx_fs;         /* exported file system */
 630         char                            *nx_path;       /* exported file system sub-path */
 631         struct nfs_filehandle           nx_fh;          /* export root file handle */
 632         struct nfs_export_options       nx_defopt;      /* default options */
 633         uint32_t                        nx_expcnt;      /* # exports in table */
 634         struct radix_node_head          *nx_rtable[AF_MAX+1]; /* table of exports (netopts) */
 635         struct nfs_export_stat_counters nx_stats;       /* statistic counters for this exported directory */
 636         struct nfs_active_user_list     nx_user_list;   /* Active User List for this exported directory */
 637         struct timeval                  nx_exptime;     /* time of export for write verifier */
 638 };
 639
 640 /* NFS exported file system info */
 641 /* one of these for each exported file system */
 642 struct nfs_exportfs {
 643         LIST_ENTRY(nfs_exportfs)        nxfs_next;      /* exported file system list */
 644         uint32_t                        nxfs_id;        /* exported file system ID */
 645         char                            *nxfs_path;     /* exported file system path */
 646         LIST_HEAD(,nfs_export)          nxfs_exports;   /* list of exports for this file system */
 647 };
 648
 649 extern LIST_HEAD(nfsrv_expfs_list, nfs_exportfs) nfsrv_exports;
 650 extern lck_rw_t nfsrv_export_rwlock;  // lock for export data structures
 651 #define NFSRVEXPHASHSZ  64
 652 #define NFSRVEXPHASHVAL(FSID, EXPID)    \
 653         (((FSID) >> 24) ^ ((FSID) >> 16) ^ ((FSID) >> 8) ^ (EXPID))
 654 #define NFSRVEXPHASH(FSID, EXPID)       \
 655         (&nfsrv_export_hashtbl[NFSRVEXPHASHVAL((FSID),(EXPID)) & nfsrv_export_hash])
 656 extern LIST_HEAD(nfsrv_export_hashhead, nfs_export) *nfsrv_export_hashtbl;
 657 extern u_long nfsrv_export_hash;
 658
 659 #if CONFIG_FSE
 660 /*
 661  * NFS server file mod fsevents
 662  */
 663 struct nfsrv_fmod {
 664         LIST_ENTRY(nfsrv_fmod)  fm_link;
 665         vnode_t                 fm_vp;
 666         struct vfs_context      fm_context;
 667         uint64_t                fm_deadline;
 668 };
 669
 670 #define NFSRVFMODHASHSZ 128
 671 #define NFSRVFMODHASH(vp) (((uintptr_t) vp) & nfsrv_fmod_hash)
 672 extern LIST_HEAD(nfsrv_fmod_hashhead, nfsrv_fmod) *nfsrv_fmod_hashtbl;
 673 extern u_long nfsrv_fmod_hash;
 674 extern lck_mtx_t *nfsrv_fmod_mutex;
 675 extern int nfsrv_fmod_pending, nfsrv_fsevents_enabled;
 676 #endif
 677
 678 extern int nfsrv_async, nfsrv_export_hash_size,
 679                         nfsrv_reqcache_size, nfsrv_sock_max_rec_queue_length;
 680 extern uint32_t nfsrv_gss_context_ttl;
 681 extern struct nfsstats nfsstats;
 682 #define NFS_UC_Q_DEBUG
 683 #ifdef NFS_UC_Q_DEBUG
 684 extern int nfsrv_uc_use_proxy;
 685 extern uint32_t nfsrv_uc_queue_limit;
 686 extern uint32_t nfsrv_uc_queue_max_seen;
 687 extern volatile uint32_t nfsrv_uc_queue_count;
 688 #endif
 689
 690 #endif // KERNEL
 691
 692 /*
 693  * XXX to allow amd to include nfs.h without nfsproto.h
 694  */
 695 #ifdef NFS_NPROCS
 696 /*
 697  * Stats structure
 698  */
 699 struct nfsstats {
 700         uint64_t        attrcache_hits;
 701         uint64_t        attrcache_misses;
 702         uint64_t        lookupcache_hits;
 703         uint64_t        lookupcache_misses;
 704         uint64_t        direofcache_hits;
 705         uint64_t        direofcache_misses;
 706         uint64_t        biocache_reads;
 707         uint64_t        read_bios;
 708         uint64_t        read_physios;
 709         uint64_t        biocache_writes;
 710         uint64_t        write_bios;
 711         uint64_t        write_physios;
 712         uint64_t        biocache_readlinks;
 713         uint64_t        readlink_bios;
 714         uint64_t        biocache_readdirs;
 715         uint64_t        readdir_bios;
 716         uint64_t        rpccnt[NFS_NPROCS];
 717         uint64_t        rpcretries;
 718         uint64_t        srvrpccnt[NFS_NPROCS];
 719         uint64_t        srvrpc_errs;
 720         uint64_t        srv_errs;
 721         uint64_t        rpcrequests;
 722         uint64_t        rpctimeouts;
 723         uint64_t        rpcunexpected;
 724         uint64_t        rpcinvalid;
 725         uint64_t        srvcache_inproghits;
 726         uint64_t        srvcache_idemdonehits;
 727         uint64_t        srvcache_nonidemdonehits;
 728         uint64_t        srvcache_misses;
 729         uint64_t        srvvop_writes;
 730         uint64_t        pageins;
 731         uint64_t        pageouts;
 732 };
 733 #endif
 734
 735 /*
 736  * Flags for nfssvc() system call.
 737  */
 738 #define NFSSVC_NFSD     0x004
 739 #define NFSSVC_ADDSOCK  0x008
 740 #define NFSSVC_EXPORT   0x200
 741
 742 /*
 743  * Flags for nfsclnt() system call.
 744  */
 745 #define NFSCLNT_LOCKDANS        0x200
 746 #define NFSCLNT_LOCKDNOTIFY     0x400
 747 #define NFSCLNT_TESTIDMAP       0x001
 748
 749 #include <sys/_types/_guid_t.h> /* for guid_t below */
 750 #define MAXIDNAMELEN            1024
 751 struct nfs_testmapid {
 752         uint32_t                ntm_name2id;    /* lookup name 2 id or id 2 name */
 753         uint32_t                ntm_grpflag;    /* Is this a group or user maping */
 754         uint32_t                ntm_id;         /* id to map or return */
 755         uint32_t                pad;
 756         guid_t                  ntm_guid;       /* intermidiate guid used in conversion */
 757         char                    ntm_name[MAXIDNAMELEN]; /* name to map or return */
 758 };
 759
 760 /*
 761  * fs.nfs sysctl(3) identifiers
 762  */
 763 #define NFS_NFSSTATS    1       /* struct: struct nfsstats */
 764 #define NFS_EXPORTSTATS 3       /* gets exported directory stats */
 765 #define NFS_USERSTATS   4       /* gets exported directory active user stats */
 766 #define NFS_USERCOUNT   5       /* gets current count of active nfs users */
 767 #define NFS_MOUNTINFO   6       /* gets information about an NFS mount */
 768
 769 #ifndef NFS_WDELAYHASHSIZ
 770 #define NFS_WDELAYHASHSIZ 16    /* and with this */
 771 #endif
 772
 773 #ifdef KERNEL
 774 #include <sys/kernel_types.h>
 775 #include <kern/thread_call.h>
 776 #include <sys/kdebug.h>
 777
 778 #define NFS_KERNEL_DEBUG KERNEL_DEBUG
 779
 780 /* kernel debug trace macros */
 781 #define FSDBG(A, B, C, D, E) \
 782         NFS_KERNEL_DEBUG((FSDBG_CODE(DBG_FSRW, (A))) | DBG_FUNC_NONE, \
 783                 (int)(B), (int)(C), (int)(D), (int)(E), 0)
 784 #define FSDBG_TOP(A, B, C, D, E) \
 785         NFS_KERNEL_DEBUG((FSDBG_CODE(DBG_FSRW, (A))) | DBG_FUNC_START, \
 786                 (int)(B), (int)(C), (int)(D), (int)(E), 0)
 787 #define FSDBG_BOT(A, B, C, D, E) \
 788         NFS_KERNEL_DEBUG((FSDBG_CODE(DBG_FSRW, (A))) | DBG_FUNC_END, \
 789                 (int)(B), (int)(C), (int)(D), (int)(E), 0)
 790
 791 #ifdef MALLOC_DECLARE
 792 MALLOC_DECLARE(M_NFSREQ);
 793 MALLOC_DECLARE(M_NFSMNT);
 794 MALLOC_DECLARE(M_NFSDIROFF);
 795 MALLOC_DECLARE(M_NFSRVDESC);
 796 MALLOC_DECLARE(M_NFSD);
 797 MALLOC_DECLARE(M_NFSBIGFH);
 798 #endif
 799
 800 struct vnode_attr; struct nameidata; struct dqblk; struct sockaddr_in; /* XXX */
 801 struct nfsbuf;
 802 struct nfs_vattr;
 803 struct nfs_fsattr;
 804 struct nfsnode;
 805 typedef struct nfsnode * nfsnode_t;
 806 struct nfs_open_owner;
 807 struct nfs_open_file;
 808 struct nfs_lock_owner;
 809 struct nfs_file_lock;
 810 struct nfsreq;
 811 struct nfs_rpc_record_state;
 812 struct nfs_fs_locations;
 813 struct nfs_location_index;
 814 struct nfs_socket;
 815 struct nfs_socket_search;
 816 struct nfsrv_uc_arg;
 817
 818 /*
 819  * The set of signals the interrupt an I/O in progress for NFSMNT_INT mounts.
 820  * What should be in this set is open to debate, but I believe that since
 821  * I/O system calls on ufs are never interrupted by signals the set should
 822  * be minimal. My reasoning is that many current programs that use signals
 823  * such as SIGALRM will not expect file I/O system calls to be interrupted
 824  * by them and break.
 825  */
 826 #define NFSINT_SIGMASK  (sigmask(SIGINT)|sigmask(SIGTERM)|sigmask(SIGKILL)| \
 827                          sigmask(SIGHUP)|sigmask(SIGQUIT))
 828
 829 extern size_t nfs_mbuf_mhlen, nfs_mbuf_minclsize;
 830
 831 /*
 832  * NFS mbuf chain structure used for managing the building/dissection of RPCs
 833  */
 834 struct nfsm_chain {
 835         mbuf_t          nmc_mhead;      /* mbuf chain head */
 836         mbuf_t          nmc_mcur;       /* current mbuf */
 837         caddr_t         nmc_ptr;        /* pointer into current mbuf */
 838         uint32_t        nmc_left;       /* bytes remaining in current mbuf */
 839         uint32_t        nmc_flags;      /* flags for this nfsm_chain */
 840 };
 841 #define NFSM_CHAIN_FLAG_ADD_CLUSTERS    0x1     /* always add mbuf clusters */
 842
 843 /*
 844  * Each retransmission of an RPCSEC_GSS request
 845  * has an additional sequence number.
 846  */
 847 struct gss_seq {
 848         SLIST_ENTRY(gss_seq)    gss_seqnext;
 849         uint32_t                gss_seqnum;
 850 };
 851
 852 /*
 853  * async NFS request callback info
 854  */
 855 struct nfsreq_cbinfo {
 856         void                    (*rcb_func)(struct nfsreq *);   /* async request callback function */
 857         struct nfsbuf           *rcb_bp;                        /* buffer I/O RPC is for */
 858         uint32_t                rcb_args[3];                    /* additional callback args */
 859 };
 860
 861 /*
 862  * Arguments to use if a request needs to call SECINFO to handle a WRONGSEC error
 863  *
 864  * If only node is set, use the parent file handle and this node's name; otherwise,
 865  * use any file handle and name provided.
 866  */
 867 struct nfsreq_secinfo_args {
 868         nfsnode_t               rsia_np;                /* the node */
 869         const char              *rsia_name;             /* alternate name string */
 870         u_char                  *rsia_fh;               /* alternate file handle */
 871         uint32_t                rsia_namelen;           /* length of string */
 872         uint32_t                rsia_fhsize;            /* length of fh */
 873 };
 874 #define NFSREQ_SECINFO_SET(SI, NP, FH, FHSIZE, NAME, NAMELEN) \
 875         do { \
 876                 (SI)->rsia_np = (NP); \
 877                 (SI)->rsia_fh = (FH); \
 878                 (SI)->rsia_fhsize = (FHSIZE); \
 879                 (SI)->rsia_name = (NAME); \
 880                 (SI)->rsia_namelen = (NAMELEN); \
 881         } while (0)
 882
 883 /*
 884  * NFS outstanding request list element
 885  */
 886 struct nfsreq {
 887         lck_mtx_t               r_mtx;          /* NFS request mutex */
 888         TAILQ_ENTRY(nfsreq)     r_chain;        /* request queue chain */
 889         TAILQ_ENTRY(nfsreq)     r_achain;       /* mount's async I/O request queue chain */
 890         TAILQ_ENTRY(nfsreq)     r_rchain;       /* mount's async I/O resend queue chain */
 891         TAILQ_ENTRY(nfsreq)     r_cchain;       /* mount's cwnd queue chain */
 892         mbuf_t                  r_mrest;        /* request body mbufs */
 893         mbuf_t                  r_mhead;        /* request header mbufs */
 894         struct nfsm_chain       r_nmrep;        /* reply mbufs */
 895         nfsnode_t               r_np;           /* NFS node */
 896         struct nfsmount         *r_nmp;         /* NFS mount point */
 897         uint64_t                r_xid;          /* RPC transaction ID */
 898         uint32_t                r_procnum;      /* NFS procedure number */
 899         uint32_t                r_mreqlen;      /* request length */
 900         int                     r_flags;        /* flags on request, see below */
 901         int                     r_lflags;       /* flags protected by list mutex, see below */
 902         int                     r_refs;         /* # outstanding references */
 903         uint8_t                 r_delay;        /* delay to use for jukebox error */
 904         uint8_t                 r_retry;        /* max retransmission count */
 905         uint8_t                 r_rexmit;       /* current retrans count */
 906         int                     r_rtt;          /* RTT for rpc */
 907         thread_t                r_thread;       /* thread that did I/O system call */
 908         kauth_cred_t            r_cred;         /* credential used for request */
 909         time_t                  r_start;        /* request start time */
 910         time_t                  r_lastmsg;      /* time of last tprintf */
 911         time_t                  r_resendtime;   /* time of next jukebox error resend */
 912         struct nfs_gss_clnt_ctx *r_gss_ctx;     /* RPCSEC_GSS context */
 913         SLIST_HEAD(, gss_seq)   r_gss_seqlist;  /* RPCSEC_GSS sequence numbers */
 914         uint32_t                r_gss_argoff;   /* RPCSEC_GSS offset to args */
 915         uint32_t                r_gss_arglen;   /* RPCSEC_GSS arg length */
 916         uint32_t                r_auth;         /* security flavor request sent with */
 917         uint32_t                *r_wrongsec;    /* wrongsec: other flavors to try */
 918         int                     r_error;        /* request error */
 919         struct nfsreq_cbinfo    r_callback;     /* callback info */
 920         struct nfsreq_secinfo_args r_secinfo;   /* secinfo args */
 921 };
 922
 923 /*
 924  * Queue head for nfsreq's
 925  */
 926 TAILQ_HEAD(nfs_reqqhead, nfsreq);
 927 extern struct nfs_reqqhead nfs_reqq;
 928 extern lck_grp_t *nfs_request_grp;
 929
 930 #define R_XID32(x)      ((x) & 0xffffffff)
 931
 932 #define NFSNOLIST       ((void *)0x0badcafe)    /* sentinel value for nfs lists */
 933 #define NFSREQNOLIST    NFSNOLIST               /* sentinel value for nfsreq lists */
 934 #define NFSIODCOMPLETING        ((void *)0x10d) /* sentinel value for iod processing
 935                                                    async I/O w/callback being completed */
 936
 937 /* Flag values for r_flags */
 938 #define R_TIMING        0x00000001      /* timing request (in mntp) */
 939 #define R_CWND          0x00000002      /* request accounted for in congestion window */
 940 #define R_SOFTTERM      0x00000004      /* request terminated (e.g. soft mnt) */
 941 #define R_RESTART       0x00000008      /* RPC should be restarted. */
 942 #define R_INITTED       0x00000010      /* request has been initialized */
 943 #define R_TPRINTFMSG    0x00000020      /* Did a tprintf msg. */
 944 #define R_MUSTRESEND    0x00000040      /* Must resend request */
 945 #define R_ALLOCATED     0x00000080      /* request was allocated */
 946 #define R_SENT          0x00000100      /* request has been sent */
 947 #define R_WAITSENT      0x00000200      /* someone is waiting for request to be sent */
 948 #define R_RESENDERR     0x00000400      /* resend failed */
 949 #define R_JBTPRINTFMSG  0x00000800      /* Did a tprintf msg for jukebox error */
 950 #define R_ASYNC         0x00001000      /* async request */
 951 #define R_ASYNCWAIT     0x00002000      /* async request now being waited on */
 952 #define R_RESENDQ       0x00004000      /* async request currently on resendq */
 953 #define R_SENDING       0x00008000      /* request currently being sent */
 954 #define R_SOFT          0x00010000      /* request is soft - don't retry or reconnect */
 955
 956 #define R_NOINTR        0x20000000      /* request should not be interupted by a signal */
 957 #define R_RECOVER       0x40000000      /* a state recovery RPC - during NFSSTA_RECOVER */
 958 #define R_SETUP         0x80000000      /* a setup RPC - during (re)connection */
 959 #define R_OPTMASK       0xe0000000      /* mask of all RPC option flags */
 960
 961 /* Flag values for r_lflags */
 962 #define RL_BUSY         0x0001          /* Locked. */
 963 #define RL_WAITING      0x0002          /* Someone waiting for lock. */
 964 #define RL_QUEUED       0x0004          /* request is on the queue */
 965
 966 extern u_int32_t nfs_xid, nfs_xidwrap;
 967 extern int nfs_iosize, nfs_allow_async, nfs_statfs_rate_limit;
 968 extern int nfs_access_cache_timeout, nfs_access_delete, nfs_access_dotzfs, nfs_access_for_getattr;
 969 extern int nfs_lockd_mounts, nfs_lockd_request_sent, nfs_single_des;
 970 extern int nfs_tprintf_initial_delay, nfs_tprintf_delay;
 971 extern int nfsiod_thread_count, nfsiod_thread_max, nfs_max_async_writes;
 972 extern int nfs_idmap_ctrl, nfs_callback_port;
 973 extern int nfs_is_mobile, nfs_readlink_nocache;
 974 extern uint32_t nfs_squishy_flags;
 975 extern uint32_t nfs_debug_ctl;
 976
 977 /* bits for nfs_idmap_ctrl: */
 978 #define NFS_IDMAP_CTRL_USE_IDMAP_SERVICE                0x00000001 /* use the ID mapping service */
 979 #define NFS_IDMAP_CTRL_FALLBACK_NO_COMMON_IDS           0x00000002 /* fallback should NOT handle common IDs like "root" and "nobody" */
 980 #define NFS_IDMAP_CTRL_FALLBACK_NO_WELLKNOWN_IDS        0x00000004 /* fallback should NOT handle the well known "XXX@" IDs */
 981 #define NFS_IDMAP_CTRL_UNKNOWN_IS_99                    0x00000008 /* for unknown IDs use uid/gid 99 instead of -2/nobody */
 982 #define NFS_IDMAP_CTRL_COMPARE_RESULTS                  0x00000010 /* compare results of ID mapping service and fallback */
 983 #define NFS_IDMAP_CTRL_LOG_FAILED_MAPPINGS              0x00000020 /* log failed ID mapping attempts */
 984 #define NFS_IDMAP_CTRL_LOG_SUCCESSFUL_MAPPINGS          0x00000040 /* log successful ID mapping attempts */
 985
 986 #define NFSIOD_MAX      (MIN(nfsiod_thread_max, NFS_MAXASYNCTHREAD))
 987
 988 struct nfs_dulookup {
 989         int du_flags;                   /* state of ._ lookup */
 990 #define NFS_DULOOKUP_DOIT       0x1
 991 #define NFS_DULOOKUP_INPROG     0x2
 992         struct componentname du_cn;     /* ._ name being looked up */
 993         struct nfsreq du_req;           /* NFS request for lookup */
 994         char du_smallname[48];          /* buffer for small names */
 995 };
 996
 997 /*
 998  * One nfsrv_sock structure is maintained for each socket the
 999  * server is servicing requests on.
1000  */
1001 struct nfsrv_sock {
1002         TAILQ_ENTRY(nfsrv_sock) ns_chain;       /* List of all nfsrv_sock's */
1003         TAILQ_ENTRY(nfsrv_sock) ns_svcq;        /* List of sockets needing servicing */
1004         TAILQ_ENTRY(nfsrv_sock) ns_wgq;         /* List of sockets with a pending write gather */
1005         struct nfsrv_uc_arg *ns_ua;             /* Opaque pointer to upcall */
1006         lck_rw_t        ns_rwlock;              /* lock for most fields */
1007         socket_t        ns_so;
1008         mbuf_t          ns_nam;
1009         mbuf_t          ns_raw;
1010         mbuf_t          ns_rawend;
1011         mbuf_t          ns_rec;
1012         mbuf_t          ns_recend;
1013         mbuf_t          ns_frag;
1014         int             ns_flag;
1015         int             ns_sotype;
1016         int             ns_cc;
1017         int             ns_reclen;
1018         int             ns_reccnt;
1019         u_int32_t               ns_sref;
1020         time_t          ns_timestamp;           /* socket timestamp */
1021         lck_mtx_t       ns_wgmutex;             /* mutex for write gather fields */
1022         u_quad_t        ns_wgtime;              /* next Write deadline (usec) */
1023         LIST_HEAD(, nfsrv_descript) ns_tq;      /* Write gather lists */
1024         LIST_HEAD(nfsrv_wg_delayhash, nfsrv_descript) ns_wdelayhashtbl[NFS_WDELAYHASHSIZ];
1025 };
1026
1027 /* Bits for "ns_flag" */
1028 #define SLP_VALID       0x0001 /* nfs sock valid */
1029 #define SLP_DOREC       0x0002 /* nfs sock has received data to process */
1030 #define SLP_NEEDQ       0x0004 /* network socket has data to receive */
1031 #define SLP_DISCONN     0x0008 /* socket needs to be zapped */
1032 #define SLP_GETSTREAM   0x0010 /* currently in nfsrv_getstream() */
1033 #define SLP_LASTFRAG    0x0020 /* on last fragment of RPC record */
1034 #define SLP_DOWRITES    0x0040 /* nfs sock has gathered writes to service */
1035 #define SLP_WORKTODO    0x004e /* mask of all "work to do" flags */
1036 #define SLP_ALLFLAGS    0x007f
1037 #define SLP_WAITQ       0x4000 /* nfs sock is on the wait queue */
1038 #define SLP_WORKQ       0x8000 /* nfs sock is on the work queue */
1039 #define SLP_QUEUED      0xc000 /* nfs sock is on a queue */
1040
1041 #define SLPNOLIST ((struct nfsrv_sock *)0xdeadbeef)     /* sentinel value for sockets not in the nfsrv_sockwg list */
1042
1043 extern struct nfsrv_sock *nfsrv_udpsock, *nfsrv_udp6sock;
1044
1045 /*
1046  * global NFS server socket lists:
1047  *
1048  * nfsrv_socklist - list of all sockets (ns_chain)
1049  * nfsrv_sockwait - sockets w/new data waiting to be worked on (ns_svcq)
1050  * nfsrv_sockwork - sockets being worked on which may have more work to do (ns_svcq)
1051  * nfsrv_sockwg - sockets with pending write gather input (ns_wgq)
1052  */
1053 extern TAILQ_HEAD(nfsrv_sockhead, nfsrv_sock) nfsrv_socklist, nfsrv_deadsocklist,
1054                                                 nfsrv_sockwg, nfsrv_sockwait, nfsrv_sockwork;
1055
1056 /* lock groups for nfsrv_sock's */
1057 extern lck_grp_t *nfsrv_slp_rwlock_group;
1058 extern lck_grp_t *nfsrv_slp_mutex_group;
1059
1060 /*
1061  * One of these structures is allocated for each nfsd.
1062  */
1063 struct nfsd {
1064         TAILQ_ENTRY(nfsd)       nfsd_chain;     /* List of all nfsd's */
1065         TAILQ_ENTRY(nfsd)       nfsd_queue;     /* List of waiting nfsd's */
1066         int                     nfsd_flag;      /* NFSD_ flags */
1067         struct nfsrv_sock       *nfsd_slp;      /* Current socket */
1068         struct nfsrv_descript   *nfsd_nd;       /* Associated nfsrv_descript */
1069 };
1070
1071 /* Bits for "nfsd_flag" */
1072 #define NFSD_WAITING    0x01
1073 #define NFSD_REQINPROG  0x02
1074
1075 /*
1076  * This structure is used by the server for describing each request.
1077  * Some fields are used only when write request gathering is performed.
1078  */
1079 struct nfsrv_descript {
1080         u_quad_t                nd_time;        /* Write deadline (usec) */
1081         off_t                   nd_off;         /* Start byte offset */
1082         off_t                   nd_eoff;        /* and end byte offset */
1083         LIST_ENTRY(nfsrv_descript) nd_hash;     /* Hash list */
1084         LIST_ENTRY(nfsrv_descript) nd_tq;       /* and timer list */
1085         LIST_HEAD(,nfsrv_descript) nd_coalesce; /* coalesced writes */
1086         struct nfsm_chain       nd_nmreq;       /* Request mbuf chain */
1087         mbuf_t                  nd_mrep;        /* Reply mbuf list (WG) */
1088         mbuf_t                  nd_nam;         /* and socket addr */
1089         mbuf_t                  nd_nam2;        /* return socket addr */
1090         u_int32_t               nd_procnum;     /* RPC # */
1091         int                     nd_stable;      /* storage type */
1092         int                     nd_vers;        /* NFS version */
1093         int                     nd_len;         /* Length of this write */
1094         int                     nd_repstat;     /* Reply status */
1095         u_int32_t                       nd_retxid;      /* Reply xid */
1096         struct timeval          nd_starttime;   /* Time RPC initiated */
1097         struct nfs_filehandle   nd_fh;          /* File handle */
1098         uint32_t                nd_sec;         /* Security flavor */
1099         struct nfs_gss_svc_ctx  *nd_gss_context;/* RPCSEC_GSS context */
1100         uint32_t                nd_gss_seqnum;  /* RPCSEC_GSS seq num */
1101         mbuf_t                  nd_gss_mb;      /* RPCSEC_GSS results mbuf */
1102         kauth_cred_t            nd_cr;          /* Credentials */
1103 };
1104
1105 extern TAILQ_HEAD(nfsd_head, nfsd) nfsd_head, nfsd_queue;
1106
1107 /* mutex for nfs server */
1108 extern lck_mtx_t *nfsd_mutex;
1109 extern int nfsd_thread_count, nfsd_thread_max;
1110
1111 /* request list mutex */
1112 extern lck_mtx_t *nfs_request_mutex;
1113 extern int nfs_request_timer_on;
1114
1115 /* mutex for nfs client globals */
1116 extern lck_mtx_t *nfs_global_mutex;
1117
1118 /* NFSv4 callback globals */
1119 extern int nfs4_callback_timer_on;
1120 extern in_port_t nfs4_cb_port, nfs4_cb_port6;
1121
1122 /* nfs timer call structures */
1123 extern thread_call_t    nfs_request_timer_call;
1124 extern thread_call_t    nfs_buf_timer_call;
1125 extern thread_call_t    nfs4_callback_timer_call;
1126 extern thread_call_t    nfsrv_deadsock_timer_call;
1127 #if CONFIG_FSE
1128 extern thread_call_t    nfsrv_fmod_timer_call;
1129 #endif
1130
1131 __BEGIN_DECLS
1132
1133 nfstype vtonfs_type(enum vtype, int);
1134 enum vtype nfstov_type(nfstype, int);
1135 int     vtonfsv2_mode(enum vtype, mode_t);
1136
1137 void    nfs_mbuf_init(void);
1138
1139 void    nfs_nhinit(void);
1140 void    nfs_nhinit_finish(void);
1141 u_long  nfs_hash(u_char *, int);
1142
1143 int     nfs4_init_clientid(struct nfsmount *);
1144 int     nfs4_setclientid(struct nfsmount *);
1145 int     nfs4_renew(struct nfsmount *, int);
1146 void    nfs4_renew_timer(void *, void *);
1147 void    nfs4_mount_callback_setup(struct nfsmount *);
1148 void    nfs4_mount_callback_shutdown(struct nfsmount *);
1149 void    nfs4_cb_accept(socket_t, void *, int);
1150 void    nfs4_cb_rcv(socket_t, void *, int);
1151 void    nfs4_callback_timer(void *, void *);
1152 int     nfs4_secinfo_rpc(struct nfsmount *, struct nfsreq_secinfo_args *, kauth_cred_t, uint32_t *, int *);
1153 int     nfs4_get_fs_locations(struct nfsmount *, nfsnode_t, u_char *, int, const char *, vfs_context_t, struct nfs_fs_locations *);
1154 void    nfs_fs_locations_cleanup(struct nfs_fs_locations *);
1155 void    nfs4_default_attrs_for_referral_trigger(nfsnode_t, char *, int, struct nfs_vattr *, fhandle_t *);
1156
1157 int     nfs_sockaddr_cmp(struct sockaddr *, struct sockaddr *);
1158 int     nfs_connect(struct nfsmount *, int, int);
1159 void    nfs_disconnect(struct nfsmount *);
1160 void    nfs_need_reconnect(struct nfsmount *);
1161 void    nfs_mount_sock_thread_wake(struct nfsmount *);
1162 int     nfs_mount_check_dead_timeout(struct nfsmount *);
1163 int     nfs_mount_gone(struct nfsmount *);
1164 void    nfs_mount_rele(struct nfsmount *);
1165 void    nfs_mount_zombie(struct nfsmount *, int);
1166 void    nfs_mount_make_zombie(struct nfsmount *);
1167
1168 void    nfs_rpc_record_state_init(struct nfs_rpc_record_state *);
1169 void    nfs_rpc_record_state_cleanup(struct nfs_rpc_record_state *);
1170 int     nfs_rpc_record_read(socket_t, struct nfs_rpc_record_state *, int, int *, mbuf_t *);
1171
1172 int     nfs_getattr(nfsnode_t, struct nfs_vattr *, vfs_context_t, int);
1173 int     nfs_getattrcache(nfsnode_t, struct nfs_vattr *, int);
1174 int     nfs_loadattrcache(nfsnode_t, struct nfs_vattr *, u_int64_t *, int);
1175 int     nfs_attrcachetimeout(nfsnode_t);
1176
1177 int     nfs_buf_page_inval(vnode_t vp, off_t offset);
1178 int     nfs_vinvalbuf(vnode_t, int, vfs_context_t, int);
1179 int     nfs_vinvalbuf2(vnode_t, int, thread_t, kauth_cred_t, int);
1180 int     nfs_vinvalbuf_internal(nfsnode_t, int, thread_t, kauth_cred_t, int, int);
1181 void    nfs_wait_bufs(nfsnode_t);
1182
1183 int     nfs_request_create(nfsnode_t, mount_t, struct nfsm_chain *, int, thread_t, kauth_cred_t, struct nfsreq **);
1184 void    nfs_request_destroy(struct nfsreq *);
1185 void    nfs_request_ref(struct nfsreq *, int);
1186 void    nfs_request_rele(struct nfsreq *);
1187 int     nfs_request_add_header(struct nfsreq *);
1188 int     nfs_request_send(struct nfsreq *, int);
1189 void    nfs_request_wait(struct nfsreq *);
1190 int     nfs_request_finish(struct nfsreq *, struct nfsm_chain *, int *);
1191 int     nfs_request(nfsnode_t, mount_t, struct nfsm_chain *, int, vfs_context_t, struct nfsreq_secinfo_args *, struct nfsm_chain *, u_int64_t *, int *);
1192 int     nfs_request2(nfsnode_t, mount_t, struct nfsm_chain *, int, thread_t, kauth_cred_t, struct nfsreq_secinfo_args *, int, struct nfsm_chain *, u_int64_t *, int *);
1193 int     nfs_request_gss(mount_t, struct nfsm_chain *, thread_t, kauth_cred_t, int, struct nfs_gss_clnt_ctx *, struct nfsm_chain *, int *);
1194 int     nfs_request_async(nfsnode_t, mount_t, struct nfsm_chain *, int, thread_t, kauth_cred_t, struct nfsreq_secinfo_args *, int, struct nfsreq_cbinfo *, struct nfsreq **);
1195 int     nfs_request_async_finish(struct nfsreq *, struct nfsm_chain *, u_int64_t *, int *);
1196 void    nfs_request_async_cancel(struct nfsreq *);
1197 void    nfs_request_timer(void *, void *);
1198 int     nfs_request_using_gss(struct nfsreq *);
1199 void    nfs_get_xid(uint64_t *);
1200 int     nfs_sigintr(struct nfsmount *, struct nfsreq *, thread_t, int);
1201 int     nfs_noremotehang(thread_t);
1202
1203 int     nfs_send(struct nfsreq *, int);
1204 int     nfs_sndlock(struct nfsreq *);
1205 void    nfs_sndunlock(struct nfsreq *);
1206
1207 int     nfs_uaddr2sockaddr(const char *, struct sockaddr *);
1208
1209 int     nfs_aux_request(struct nfsmount *, thread_t, struct sockaddr *, socket_t, int, mbuf_t, uint32_t, int, int, struct nfsm_chain *);
1210 int     nfs_portmap_lookup(struct nfsmount *, vfs_context_t, struct sockaddr *, socket_t, uint32_t, uint32_t, uint32_t, int);
1211
1212 void    nfs_location_next(struct nfs_fs_locations *, struct nfs_location_index *);
1213 int     nfs_location_index_cmp(struct nfs_location_index *, struct nfs_location_index *);
1214 void    nfs_location_mntfromname(struct nfs_fs_locations *, struct nfs_location_index, char *, int, int);
1215 int     nfs_socket_create(struct nfsmount *, struct sockaddr *, int, in_port_t, uint32_t, uint32_t, int, struct nfs_socket **);
1216 void    nfs_socket_destroy(struct nfs_socket *);
1217 void    nfs_socket_options(struct nfsmount *, struct nfs_socket *);
1218 void    nfs_connect_upcall(socket_t, void *, int);
1219 int     nfs_connect_error_class(int);
1220 int     nfs_connect_search_loop(struct nfsmount *, struct nfs_socket_search *);
1221 void    nfs_socket_search_update_error(struct nfs_socket_search *, int);
1222 void    nfs_socket_search_cleanup(struct nfs_socket_search *);
1223 void    nfs_mount_connect_thread(void *, __unused wait_result_t);
1224
1225 int     nfs_lookitup(nfsnode_t, char *, int, vfs_context_t, nfsnode_t *);
1226 void    nfs_dulookup_init(struct nfs_dulookup *, nfsnode_t, const char *, int, vfs_context_t);
1227 void    nfs_dulookup_start(struct nfs_dulookup *, nfsnode_t, vfs_context_t);
1228 void    nfs_dulookup_finish(struct nfs_dulookup *, nfsnode_t, vfs_context_t);
1229 int     nfs_dir_buf_cache_lookup(nfsnode_t, nfsnode_t *, struct componentname *, vfs_context_t, int);
1230 int     nfs_dir_buf_search(struct nfsbuf *, struct componentname *, fhandle_t *, struct nfs_vattr *, uint64_t *, time_t *, daddr64_t *, int);
1231 void    nfs_name_cache_purge(nfsnode_t, nfsnode_t, struct componentname *, vfs_context_t);
1232
1233 uint32_t nfs4_ace_nfstype_to_vfstype(uint32_t, int *);
1234 uint32_t nfs4_ace_vfstype_to_nfstype(uint32_t, int *);
1235 uint32_t nfs4_ace_nfsflags_to_vfsflags(uint32_t);
1236 uint32_t nfs4_ace_vfsflags_to_nfsflags(uint32_t);
1237 uint32_t nfs4_ace_nfsmask_to_vfsrights(uint32_t);
1238 uint32_t nfs4_ace_vfsrights_to_nfsmask(uint32_t);
1239 int nfs4_id2guid(char *, guid_t *, int);
1240 int nfs4_guid2id(guid_t *, char *, int *, int);
1241
1242 int     nfs_parsefattr(struct nfsm_chain *, int, struct nfs_vattr *);
1243 int     nfs4_parsefattr(struct nfsm_chain *, struct nfs_fsattr *, struct nfs_vattr *, fhandle_t *, struct dqblk *, struct nfs_fs_locations *);
1244 void    nfs_vattr_set_supported(uint32_t *, struct vnode_attr *);
1245 void    nfs_vattr_set_bitmap(struct nfsmount *, uint32_t *, struct vnode_attr *);
1246 void    nfs3_pathconf_cache(struct nfsmount *, struct nfs_fsattr *);
1247 int     nfs3_mount_rpc(struct nfsmount *, struct sockaddr *, int, int, char *, vfs_context_t, int, fhandle_t *, struct nfs_sec *);
1248 void    nfs3_umount_rpc(struct nfsmount *, vfs_context_t, int);
1249 int     nfs_node_access_slot(nfsnode_t, uid_t, int);
1250 void    nfs_vnode_notify(nfsnode_t, uint32_t);
1251
1252 void    nfs_avoid_needless_id_setting_on_create(nfsnode_t, struct vnode_attr *, vfs_context_t);
1253 int     nfs4_create_rpc(vfs_context_t, nfsnode_t, struct componentname *, struct vnode_attr *, int, char *, nfsnode_t *);
1254 int     nfs_open_state_set_busy(nfsnode_t, thread_t);
1255 void    nfs_open_state_clear_busy(nfsnode_t);
1256 struct nfs_open_owner *nfs_open_owner_find(struct nfsmount *, kauth_cred_t, int);
1257 void    nfs_open_owner_destroy(struct nfs_open_owner *);
1258 void    nfs_open_owner_ref(struct nfs_open_owner *);
1259 void    nfs_open_owner_rele(struct nfs_open_owner *);
1260 int     nfs_open_owner_set_busy(struct nfs_open_owner *, thread_t);
1261 void    nfs_open_owner_clear_busy(struct nfs_open_owner *);
1262 void    nfs_owner_seqid_increment(struct nfs_open_owner *, struct nfs_lock_owner *, int);
1263 int     nfs_open_file_find(nfsnode_t, struct nfs_open_owner *, struct nfs_open_file **, uint32_t, uint32_t, int);
1264 int     nfs_open_file_find_internal(nfsnode_t, struct nfs_open_owner *, struct nfs_open_file **, uint32_t, uint32_t, int);
1265 void    nfs_open_file_destroy(struct nfs_open_file *);
1266 int     nfs_open_file_set_busy(struct nfs_open_file *, thread_t);
1267 void    nfs_open_file_clear_busy(struct nfs_open_file *);
1268 void    nfs_open_file_add_open(struct nfs_open_file *, uint32_t, uint32_t, int);
1269 void    nfs_open_file_remove_open_find(struct nfs_open_file *, uint32_t, uint32_t, uint32_t *, uint32_t *, int*);
1270 void    nfs_open_file_remove_open(struct nfs_open_file *, uint32_t, uint32_t);
1271 void    nfs_get_stateid(nfsnode_t, thread_t, kauth_cred_t, nfs_stateid *);
1272 int     nfs4_open(nfsnode_t, struct nfs_open_file *, uint32_t, uint32_t, vfs_context_t);
1273 int     nfs4_open_delegated(nfsnode_t, struct nfs_open_file *, uint32_t, uint32_t, vfs_context_t);
1274 int     nfs_close(nfsnode_t, struct nfs_open_file *, uint32_t, uint32_t, vfs_context_t);
1275 int     nfs_check_for_locks(struct nfs_open_owner *, struct nfs_open_file *);
1276 int     nfs4_reopen(struct nfs_open_file *, thread_t);
1277 int     nfs4_open_rpc(struct nfs_open_file *, vfs_context_t, struct componentname *, struct vnode_attr *, vnode_t, vnode_t *, int, int, int);
1278 int     nfs4_open_rpc_internal(struct nfs_open_file *, vfs_context_t, thread_t, kauth_cred_t, struct componentname *, struct vnode_attr *, vnode_t, vnode_t *, int, int, int);
1279 int     nfs4_open_confirm_rpc(struct nfsmount *, nfsnode_t, u_char *, int, struct nfs_open_owner *, nfs_stateid *, thread_t, kauth_cred_t, struct nfs_vattr *, uint64_t *);
1280 int     nfs4_open_reopen_rpc(struct nfs_open_file *, thread_t, kauth_cred_t, struct componentname *, vnode_t, vnode_t *, int, int);
1281 int     nfs4_open_reclaim_rpc(struct nfs_open_file *, int, int);
1282 int     nfs4_claim_delegated_open_rpc(struct nfs_open_file *, int, int, int);
1283 int     nfs4_claim_delegated_state_for_open_file(struct nfs_open_file *, int);
1284 int     nfs4_claim_delegated_state_for_node(nfsnode_t, int);
1285 int     nfs4_open_downgrade_rpc(nfsnode_t, struct nfs_open_file *, vfs_context_t);
1286 int     nfs4_close_rpc(nfsnode_t, struct nfs_open_file *, thread_t, kauth_cred_t, int);
1287 void    nfs4_delegation_return_enqueue(nfsnode_t);
1288 int     nfs4_delegation_return(nfsnode_t, int, thread_t, kauth_cred_t);
1289 int     nfs4_delegreturn_rpc(struct nfsmount *, u_char *, int, struct nfs_stateid *, int, thread_t, kauth_cred_t);
1290 void    nfs_release_open_state_for_node(nfsnode_t, int);
1291 void    nfs_revoke_open_state_for_node(nfsnode_t);
1292 struct nfs_lock_owner *nfs_lock_owner_find(nfsnode_t, proc_t, int);
1293 void    nfs_lock_owner_destroy(struct nfs_lock_owner *);
1294 void    nfs_lock_owner_ref(struct nfs_lock_owner *);
1295 void    nfs_lock_owner_rele(struct nfs_lock_owner *);
1296 int     nfs_lock_owner_set_busy(struct nfs_lock_owner *, thread_t);
1297 void    nfs_lock_owner_clear_busy(struct nfs_lock_owner *);
1298 void    nfs_lock_owner_insert_held_lock(struct nfs_lock_owner *, struct nfs_file_lock *);
1299 struct nfs_file_lock *nfs_file_lock_alloc(struct nfs_lock_owner *);
1300 void    nfs_file_lock_destroy(struct nfs_file_lock *);
1301 int     nfs_file_lock_conflict(struct nfs_file_lock *, struct nfs_file_lock *, int *);
1302 int     nfs4_lock_rpc(nfsnode_t, struct nfs_open_file *, struct nfs_file_lock *, int, int, thread_t, kauth_cred_t);
1303 int     nfs_unlock_rpc(nfsnode_t, struct nfs_lock_owner *, int, uint64_t, uint64_t, thread_t, kauth_cred_t, int);
1304 int     nfs_advlock_getlock(nfsnode_t, struct nfs_lock_owner *, struct flock *, uint64_t, uint64_t, vfs_context_t);
1305 int     nfs_advlock_setlock(nfsnode_t, struct nfs_open_file *, struct nfs_lock_owner *, int, uint64_t, uint64_t, int, short, vfs_context_t);
1306 int     nfs_advlock_unlock(nfsnode_t, struct nfs_open_file *, struct nfs_lock_owner *, uint64_t, uint64_t, int, vfs_context_t);
1307
1308 nfsnode_t nfs4_named_attr_dir_get(nfsnode_t, int, vfs_context_t);
1309 int     nfs4_named_attr_get(nfsnode_t, struct componentname *, uint32_t, int, vfs_context_t, nfsnode_t *, struct nfs_open_file **);
1310 int     nfs4_named_attr_remove(nfsnode_t, nfsnode_t, const char *, vfs_context_t);
1311
1312 int     nfs_mount_state_in_use_start(struct nfsmount *, thread_t);
1313 int     nfs_mount_state_in_use_end(struct nfsmount *, int);
1314 int     nfs_mount_state_error_should_restart(int);
1315 int     nfs_mount_state_error_delegation_lost(int);
1316 uint    nfs_mount_state_max_restarts(struct nfsmount *);
1317 int     nfs_mount_state_wait_for_recovery(struct nfsmount *);
1318 void    nfs_need_recover(struct nfsmount *nmp, int error);
1319 void    nfs_recover(struct nfsmount *);
1320
1321 int     nfs_vnop_access(struct vnop_access_args *);
1322 int     nfs_vnop_remove(struct vnop_remove_args *);
1323 int     nfs_vnop_read(struct vnop_read_args *);
1324 int     nfs_vnop_write(struct vnop_write_args *);
1325 int     nfs_vnop_open(struct vnop_open_args *);
1326 int     nfs_vnop_close(struct vnop_close_args *);
1327 int     nfs_vnop_advlock(struct vnop_advlock_args *);
1328 int     nfs_vnop_mmap(struct vnop_mmap_args *);
1329 int     nfs_vnop_mnomap(struct vnop_mnomap_args *);
1330
1331 int     nfs4_vnop_create(struct vnop_create_args *);
1332 int     nfs4_vnop_mknod(struct vnop_mknod_args *);
1333 int     nfs4_vnop_close(struct vnop_close_args *);
1334 int     nfs4_vnop_getattr(struct vnop_getattr_args *);
1335 int     nfs4_vnop_link(struct vnop_link_args *);
1336 int     nfs4_vnop_mkdir(struct vnop_mkdir_args *);
1337 int     nfs4_vnop_rmdir(struct vnop_rmdir_args *);
1338 int     nfs4_vnop_symlink(struct vnop_symlink_args *);
1339 int     nfs4_vnop_getxattr(struct vnop_getxattr_args *);
1340 int     nfs4_vnop_setxattr(struct vnop_setxattr_args *);
1341 int     nfs4_vnop_removexattr(struct vnop_removexattr_args *);
1342 int     nfs4_vnop_listxattr(struct vnop_listxattr_args *);
1343 #if NAMEDSTREAMS
1344 int     nfs4_vnop_getnamedstream(struct vnop_getnamedstream_args *);
1345 int     nfs4_vnop_makenamedstream(struct vnop_makenamedstream_args *);
1346 int     nfs4_vnop_removenamedstream(struct vnop_removenamedstream_args *);
1347 #endif
1348
1349 int     nfs_read_rpc(nfsnode_t, uio_t, vfs_context_t);
1350 int     nfs_write_rpc(nfsnode_t, uio_t, vfs_context_t, int *, uint64_t *);
1351 int     nfs_write_rpc2(nfsnode_t, uio_t, thread_t, kauth_cred_t, int *, uint64_t *);
1352
1353 int     nfs3_access_rpc(nfsnode_t, u_int32_t *, int, vfs_context_t);
1354 int     nfs4_access_rpc(nfsnode_t, u_int32_t *, int, vfs_context_t);
1355 int     nfs3_getattr_rpc(nfsnode_t, mount_t, u_char *, size_t, int, vfs_context_t, struct nfs_vattr *, u_int64_t *);
1356 int     nfs4_getattr_rpc(nfsnode_t, mount_t, u_char *, size_t, int, vfs_context_t, struct nfs_vattr *, u_int64_t *);
1357 int     nfs3_setattr_rpc(nfsnode_t, struct vnode_attr *, vfs_context_t);
1358 int     nfs4_setattr_rpc(nfsnode_t, struct vnode_attr *, vfs_context_t);
1359 int     nfs3_read_rpc_async(nfsnode_t, off_t, size_t, thread_t, kauth_cred_t, struct nfsreq_cbinfo *, struct nfsreq **);
1360 int     nfs4_read_rpc_async(nfsnode_t, off_t, size_t, thread_t, kauth_cred_t, struct nfsreq_cbinfo *, struct nfsreq **);
1361 int     nfs3_read_rpc_async_finish(nfsnode_t, struct nfsreq *, uio_t, size_t *, int *);
1362 int     nfs4_read_rpc_async_finish(nfsnode_t, struct nfsreq *, uio_t, size_t *, int *);
1363 int     nfs3_write_rpc_async(nfsnode_t, uio_t, size_t, thread_t, kauth_cred_t, int, struct nfsreq_cbinfo *, struct nfsreq **);
1364 int     nfs4_write_rpc_async(nfsnode_t, uio_t, size_t, thread_t, kauth_cred_t, int, struct nfsreq_cbinfo *, struct nfsreq **);
1365 int     nfs3_write_rpc_async_finish(nfsnode_t, struct nfsreq *, int *, size_t *, uint64_t *);
1366 int     nfs4_write_rpc_async_finish(nfsnode_t, struct nfsreq *, int *, size_t *, uint64_t *);
1367 int     nfs3_readdir_rpc(nfsnode_t, struct nfsbuf *, vfs_context_t);
1368 int     nfs4_readdir_rpc(nfsnode_t, struct nfsbuf *, vfs_context_t);
1369 int     nfs3_readlink_rpc(nfsnode_t, char *, uint32_t *, vfs_context_t);
1370 int     nfs4_readlink_rpc(nfsnode_t, char *, uint32_t *, vfs_context_t);
1371 int     nfs3_commit_rpc(nfsnode_t, uint64_t, uint64_t, kauth_cred_t, uint64_t);
1372 int     nfs4_commit_rpc(nfsnode_t, uint64_t, uint64_t, kauth_cred_t, uint64_t);
1373 int     nfs3_lookup_rpc_async(nfsnode_t, char *, int, vfs_context_t, struct nfsreq **);
1374 int     nfs4_lookup_rpc_async(nfsnode_t, char *, int, vfs_context_t, struct nfsreq **);
1375 int     nfs3_lookup_rpc_async_finish(nfsnode_t, char *, int, vfs_context_t, struct nfsreq *, u_int64_t *, fhandle_t *, struct nfs_vattr *);
1376 int     nfs4_lookup_rpc_async_finish(nfsnode_t, char *, int, vfs_context_t, struct nfsreq *, u_int64_t *, fhandle_t *, struct nfs_vattr *);
1377 int     nfs3_remove_rpc(nfsnode_t, char *, int, thread_t, kauth_cred_t);
1378 int     nfs4_remove_rpc(nfsnode_t, char *, int, thread_t, kauth_cred_t);
1379 int     nfs3_rename_rpc(nfsnode_t, char *, int, nfsnode_t, char *, int, vfs_context_t);
1380 int     nfs4_rename_rpc(nfsnode_t, char *, int, nfsnode_t, char *, int, vfs_context_t);
1381 int     nfs3_pathconf_rpc(nfsnode_t, struct nfs_fsattr *, vfs_context_t);
1382 int     nfs4_pathconf_rpc(nfsnode_t, struct nfs_fsattr *, vfs_context_t);
1383 int     nfs3_setlock_rpc(nfsnode_t, struct nfs_open_file *, struct nfs_file_lock *, int, int, thread_t, kauth_cred_t);
1384 int     nfs4_setlock_rpc(nfsnode_t, struct nfs_open_file *, struct nfs_file_lock *, int, int, thread_t, kauth_cred_t);
1385 int     nfs3_unlock_rpc(nfsnode_t, struct nfs_lock_owner *, int, uint64_t, uint64_t, int, thread_t, kauth_cred_t);
1386 int     nfs4_unlock_rpc(nfsnode_t, struct nfs_lock_owner *, int, uint64_t, uint64_t, int, thread_t, kauth_cred_t);
1387 int     nfs3_getlock_rpc(nfsnode_t, struct nfs_lock_owner *, struct flock *, uint64_t, uint64_t, vfs_context_t);
1388 int     nfs4_getlock_rpc(nfsnode_t, struct nfs_lock_owner *, struct flock *, uint64_t, uint64_t, vfs_context_t);
1389
1390 void    nfsrv_active_user_list_reclaim(void);
1391 void    nfsrv_cleancache(void);
1392 void    nfsrv_cleanup(void);
1393 int     nfsrv_credcheck(struct nfsrv_descript *, vfs_context_t, struct nfs_export *,
1394                         struct nfs_export_options *);
1395 void    nfsrv_deadsock_timer(void *, void *);
1396 int     nfsrv_dorec(struct nfsrv_sock *, struct nfsd *, struct nfsrv_descript **);
1397 int     nfsrv_errmap(struct nfsrv_descript *, int);
1398 int     nfsrv_export(struct user_nfs_export_args *, vfs_context_t);
1399 int     nfsrv_fhmatch(struct nfs_filehandle *, struct nfs_filehandle *);
1400 int     nfsrv_fhtovp(struct nfs_filehandle *, struct nfsrv_descript *, vnode_t *,
1401                         struct nfs_export **, struct nfs_export_options **);
1402 #if CONFIG_FSE
1403 void    nfsrv_fmod_timer(void *, void *);
1404 #endif
1405 int     nfsrv_getcache(struct nfsrv_descript *, struct nfsrv_sock *, mbuf_t *);
1406 void    nfsrv_group_sort(gid_t *, int);
1407 void    nfsrv_init(void);
1408 void    nfsrv_initcache(void);
1409 int     nfsrv_is_initialized(void);
1410 int     nfsrv_namei(struct nfsrv_descript *, vfs_context_t, struct nameidata *,
1411                         struct nfs_filehandle *, vnode_t *,
1412                         struct nfs_export **, struct nfs_export_options **);
1413 void    nfsrv_rcv(socket_t, void *, int);
1414 void    nfsrv_rcv_locked(socket_t, struct nfsrv_sock *, int);
1415 int     nfsrv_rephead(struct nfsrv_descript *, struct nfsrv_sock *, struct nfsm_chain *, size_t);
1416 int     nfsrv_send(struct nfsrv_sock *, mbuf_t, mbuf_t);
1417 void    nfsrv_updatecache(struct nfsrv_descript *, int, mbuf_t);
1418 void    nfsrv_update_user_stat(struct nfs_export *, struct nfsrv_descript *, uid_t, u_int, u_int, u_int);
1419 int     nfsrv_vptofh(struct nfs_export *, int, struct nfs_filehandle *,
1420                         vnode_t, vfs_context_t, struct nfs_filehandle *);
1421 void    nfsrv_wakenfsd(struct nfsrv_sock *);
1422 void    nfsrv_wg_timer(void *, void *);
1423 int     nfsrv_writegather(struct nfsrv_descript **, struct nfsrv_sock *,
1424                                vfs_context_t, mbuf_t *);
1425
1426 int     nfsrv_access(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *);
1427 int     nfsrv_commit(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *);
1428 int     nfsrv_create(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *);
1429 int     nfsrv_fsinfo(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *);
1430 int     nfsrv_getattr(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *);
1431 int     nfsrv_link(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *);
1432 int     nfsrv_lookup(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *);
1433 int     nfsrv_mkdir(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *);
1434 int     nfsrv_mknod(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *);
1435 int     nfsrv_noop(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *);
1436 int     nfsrv_null(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *);
1437 int     nfsrv_pathconf(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *);
1438 int     nfsrv_read(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *);
1439 int     nfsrv_readdir(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *);
1440 int     nfsrv_readdirplus(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *);
1441 int     nfsrv_readlink(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *);
1442 int     nfsrv_remove(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *);
1443 int     nfsrv_rename(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *);
1444 int     nfsrv_rmdir(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *);
1445 int     nfsrv_setattr(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *);
1446 int     nfsrv_statfs(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *);
1447 int     nfsrv_symlink(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *);
1448 int     nfsrv_write(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *);
1449
1450 void    nfs_interval_timer_start(thread_call_t, int);
1451 int     nfs_use_cache(struct nfsmount *);
1452 void    nfs_up(struct nfsmount *, thread_t, int, const char *);
1453 void    nfs_down(struct nfsmount *, thread_t, int, int, const char *, int);
1454 int     nfs_msg(thread_t, const char *, const char *, int);
1455
1456 int     nfs_mountroot(void);
1457 struct nfs_diskless;
1458 int     nfs_boot_init(struct nfs_diskless *);
1459 int     nfs_boot_getfh(struct nfs_diskless *, int, int);
1460
1461 #if CONFIG_TRIGGERS
1462 resolver_result_t nfs_mirror_mount_trigger_resolve(vnode_t, const struct componentname *, enum path_operation, int, void *, vfs_context_t);
1463 resolver_result_t nfs_mirror_mount_trigger_unresolve(vnode_t, int, void *, vfs_context_t);
1464 resolver_result_t nfs_mirror_mount_trigger_rearm(vnode_t, int, void *, vfs_context_t);
1465 int     nfs_mirror_mount_domount(vnode_t, vnode_t, vfs_context_t);
1466 void    nfs_ephemeral_mount_harvester_start(void);
1467 void    nfs_ephemeral_mount_harvester(__unused void *arg, __unused wait_result_t wr);
1468 #endif
1469
1470 /* socket upcall interfaces */
1471 void nfsrv_uc_init(void);
1472 void nfsrv_uc_cleanup(void);
1473 void nfsrv_uc_addsock(struct nfsrv_sock *, int);
1474 void nfsrv_uc_dequeue(struct nfsrv_sock *);
1475
1476 /* Debug support */
1477 #define NFS_DEBUG_LEVEL   (nfs_debug_ctl & 0xf)
1478 #define NFS_DEBUG_FACILITY ((nfs_debug_ctl >> 4) & 0xff)
1479 #define NFS_DEBUG_FLAGS ((nfs_debug_ctl >> 12) & 0xff)
1480 #define NFS_DEBUG_VALUE ((nfs_debug_ctl >> 20) & 0xfff)
1481 #define NFS_FAC_SOCK    0x01
1482 #define NFS_FAC_STATE   0x02
1483 #define NFS_FAC_NODE    0x04
1484 #define NFS_FAC_VNOP    0x08
1485 #define NFS_FAC_BIO     0x10
1486 #define NFS_FAC_GSS     0x20
1487 #define NFS_FAC_VFS     0x40
1488
1489 #define NFS_DBG(fac, lev, fmt, ...) \
1490         if (__builtin_expect(NFS_DEBUG_LEVEL, 0)) nfs_printf(fac, lev, "%s: %d: " fmt, __func__, __LINE__, ## __VA_ARGS__)
1491
1492 void nfs_printf(int, int, const char *, ...) __printflike(3,4);
1493 int  nfs_mountopts(struct nfsmount *, char *, int);
1494
1495 __END_DECLS
1496
1497 #endif  /* KERNEL */
1498 #endif /* __APPLE_API_PRIVATE */
1499
1500 #endif