/* * Copyright (c) 2000-2018 Apple Inc. All rights reserved. * * @APPLE_OSREFERENCE_LICENSE_HEADER_START@ * * This file contains Original Code and/or Modifications of Original Code * as defined in and that are subject to the Apple Public Source License * Version 2.0 (the 'License'). You may not use this file except in * compliance with the License. The rights granted to you under the License * may not be used to create, or enable the creation or redistribution of, * unlawful or unlicensed copies of an Apple operating system, or to * circumvent, violate, or enable the circumvention or violation of, any * terms of an Apple operating system software license agreement. * * Please obtain a copy of the License at * http://www.opensource.apple.com/apsl/ and read it before using this file. * * The Original Code and all software distributed under the License are * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. * Please see the License for the specific language governing rights and * limitations under the License. * * @APPLE_OSREFERENCE_LICENSE_HEADER_END@ */ /* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */ /* * Copyright (c) 1989, 1993, 1995 * The Regents of the University of California. All rights reserved. * * This code is derived from software contributed to Berkeley by * Rick Macklem at The University of Guelph. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * 3. All advertising materials mentioning features or use of this software * must display the following acknowledgement: * This product includes software developed by the University of * California, Berkeley and its contributors. * 4. Neither the name of the University nor the names of its contributors * may be used to endorse or promote products derived from this software * without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * SUCH DAMAGE. * * @(#)nfs.h 8.4 (Berkeley) 5/1/95 * FreeBSD-Id: nfs.h,v 1.32 1997/10/12 20:25:38 phk Exp $ */ #ifndef _NFS_NFS_H_ #define _NFS_NFS_H_ #include #include #include #include #include #include #include #ifdef __APPLE_API_PRIVATE /* * Tunable constants for nfs */ #define NFS_TICKINTVL 5 /* Desired time for a tick (msec) */ #define NFS_HZ (hz / nfs_ticks) /* Ticks/sec */ extern int nfs_ticks; #define NFS_TIMEO (1 * NFS_HZ) /* Default timeout = 1 second */ #define NFS_MINTIMEO (1 * NFS_HZ) /* Min timeout to use */ #define NFS_MAXTIMEO (60 * NFS_HZ) /* Max timeout to backoff to */ #define NFS_MINIDEMTIMEO (5 * NFS_HZ) /* Min timeout for non-idempotent ops*/ #define NFS_MAXREXMIT 100 /* Stop counting after this many */ #define NFS_RETRANS 10 /* Num of retrans for soft mounts */ #define NFS_TRYLATERDEL 4 /* Initial try later delay (sec) */ #define NFS_MAXGRPS 16U /* Max. size of groups list */ #define NFS_MINATTRTIMO 5 /* Attribute cache timeout in sec */ #define NFS_MAXATTRTIMO 60 #define NFS_MINDIRATTRTIMO 5 /* directory attribute cache timeout in sec */ #define NFS_MAXDIRATTRTIMO 60 #define NFS_MAXPORT 0xffff #define NFS_IOSIZE (1024 * 1024) /* suggested I/O size */ #define NFS_RWSIZE 32768 /* Def. read/write data size <= 32K */ #define NFS_WSIZE NFS_RWSIZE /* Def. write data size <= 32K */ #define NFS_RSIZE NFS_RWSIZE /* Def. read data size <= 32K */ #define NFS_DGRAM_WSIZE 8192 /* UDP Def. write data size <= 8K */ #define NFS_DGRAM_RSIZE 8192 /* UDP Def. read data size <= 8K */ #define NFS_READDIRSIZE 32768 /* Def. readdir size */ #define NFS_DEFRAHEAD 16 /* Def. read ahead # blocks */ #define NFS_MAXRAHEAD 128 /* Max. read ahead # blocks */ #define NFS_DEFMAXASYNCWRITES 128 /* Def. max # concurrent async write RPCs */ #define NFS_DEFASYNCTHREAD 16 /* Def. # nfsiod threads */ #define NFS_MAXASYNCTHREAD 64 /* max # nfsiod threads */ #define NFS_ASYNCTHREADMAXIDLE 60 /* Seconds before idle nfsiods are reaped */ #define NFS_DEFSTATFSRATELIMIT 10 /* Def. max # statfs RPCs per second */ #define NFS_REQUESTDELAY 10 /* ms interval to check request queue */ #define NFSRV_MAXWGATHERDELAY 100 /* Max. write gather delay (msec) */ #ifndef NFSRV_WGATHERDELAY #define NFSRV_WGATHERDELAY 1 /* Default write gather delay (msec) */ #endif #define NFS_DIRBLKSIZ 4096 /* size of NFS directory buffers */ /* default values for unresponsive mount timeouts */ #define NFS_TPRINTF_INITIAL_DELAY 5 #define NFS_TPRINTF_DELAY 30 /* NFS client mount timeouts */ #define NFS_MOUNT_TIMEOUT 30 #define NFS_MOUNT_QUICK_TIMEOUT 8 /* * Oddballs */ #define NFS_CMPFH(n, f, s) \ ((n)->n_fhsize == (s) && !bcmp((caddr_t)(n)->n_fhp, (caddr_t)(f), (s))) #define NFSRV_NDMAXDATA(n) \ (((n)->nd_vers == NFS_VER3) ? (((n)->nd_nam2) ? \ NFS_MAXDGRAMDATA : NFSRV_MAXDATA) : NFS_V2MAXDATA) #define NFS_PORT_INVALID(port) \ (((port) > NFS_MAXPORT) || ((port) < 0)) /* * The IO_METASYNC flag should be implemented for local file systems. * (Until then, it is nothin at all.) */ #ifndef IO_METASYNC #define IO_METASYNC 0 #endif /* * Expected allocation sizes for major data structures. If the actual size * of the structure exceeds these sizes, then malloc() will be allocating * almost twice the memory required. This is used in nfs_init() to warn * the sysadmin that the size of a structure should be reduced. * (These sizes are always a power of 2. If the kernel malloc() changes * to one that does not allocate space in powers of 2 size, then this all * becomes bunk!). * Note that some of these structures come out of their own nfs zones. */ #define NFS_NODEALLOC 1024 #define NFS_MNTALLOC 2048 #define NFS_SVCALLOC 512 #define NFS_ARGSVERSION_XDR 88 /* NFS mount args are in XDR format */ #define NFS_XDRARGS_VERSION_0 0 #define NFS_MATTR_BITMAP_LEN 2 /* length of mount attributes bitmap */ #define NFS_MFLAG_BITMAP_LEN 1 /* length of mount flags bitmap */ /* NFS mount attributes */ #define NFS_MATTR_FLAGS 0 /* mount flags (NFS_MATTR_*) */ #define NFS_MATTR_NFS_VERSION 1 /* NFS protocol version */ #define NFS_MATTR_NFS_MINOR_VERSION 2 /* NFS protocol minor version */ #define NFS_MATTR_READ_SIZE 3 /* READ RPC size */ #define NFS_MATTR_WRITE_SIZE 4 /* WRITE RPC size */ #define NFS_MATTR_READDIR_SIZE 5 /* READDIR RPC size */ #define NFS_MATTR_READAHEAD 6 /* block readahead count */ #define NFS_MATTR_ATTRCACHE_REG_MIN 7 /* minimum attribute cache time */ #define NFS_MATTR_ATTRCACHE_REG_MAX 8 /* maximum attribute cache time */ #define NFS_MATTR_ATTRCACHE_DIR_MIN 9 /* minimum attribute cache time for dirs */ #define NFS_MATTR_ATTRCACHE_DIR_MAX 10 /* maximum attribute cache time for dirs */ #define NFS_MATTR_LOCK_MODE 11 /* advisory file locking mode (NFS_LOCK_MODE_*) */ #define NFS_MATTR_SECURITY 12 /* RPC security flavors to use */ #define NFS_MATTR_MAX_GROUP_LIST 13 /* max # of RPC AUTH_SYS groups */ #define NFS_MATTR_SOCKET_TYPE 14 /* socket transport type as a netid-like string */ #define NFS_MATTR_NFS_PORT 15 /* port # to use for NFS protocol */ #define NFS_MATTR_MOUNT_PORT 16 /* port # to use for MOUNT protocol */ #define NFS_MATTR_REQUEST_TIMEOUT 17 /* initial RPC request timeout value */ #define NFS_MATTR_SOFT_RETRY_COUNT 18 /* max RPC retransmissions for soft mounts */ #define NFS_MATTR_DEAD_TIMEOUT 19 /* how long until unresponsive mount is considered dead */ #define NFS_MATTR_FH 20 /* file handle for mount directory */ #define NFS_MATTR_FS_LOCATIONS 21 /* list of locations for the file system */ #define NFS_MATTR_MNTFLAGS 22 /* VFS mount flags (MNT_*) */ #define NFS_MATTR_MNTFROM 23 /* fixed string to use for "f_mntfromname" */ #define NFS_MATTR_REALM 24 /* Realm to authenticate with */ #define NFS_MATTR_PRINCIPAL 25 /* GSS principal to authenticate with */ #define NFS_MATTR_SVCPRINCIPAL 26 /* GSS principal to authenticate to, the server principal */ #define NFS_MATTR_NFS_VERSION_RANGE 27 /* Packed version range to try */ #define NFS_MATTR_KERB_ETYPE 28 /* Enctype to use for kerberos mounts */ #define NFS_MATTR_LOCAL_NFS_PORT 29 /* Unix domain socket for NFS protocol */ #define NFS_MATTR_LOCAL_MOUNT_PORT 30 /* Unix domain socket for MOUNT protocol */ #define NFS_MATTR_SET_MOUNT_OWNER 31 /* Set owner of mount point */ #define NFS_MATTR_READLINK_NOCACHE 32 /* Readlink nocache mode */ #define NFS_MATTR_ATTRCACHE_ROOTDIR_MIN 33 /* minimum attribute cache time for root dir */ #define NFS_MATTR_ATTRCACHE_ROOTDIR_MAX 34 /* maximum attribute cache time for root dir */ #define NFS_MATTR_ACCESS_CACHE 35 /* Access cache size */ /* NFS mount flags */ #define NFS_MFLAG_SOFT 0 /* soft mount (requests fail if unresponsive) */ #define NFS_MFLAG_INTR 1 /* allow operations to be interrupted */ #define NFS_MFLAG_RESVPORT 2 /* use a reserved port */ #define NFS_MFLAG_NOCONNECT 3 /* don't connect the socket (UDP) */ #define NFS_MFLAG_DUMBTIMER 4 /* don't estimate RTT dynamically */ #define NFS_MFLAG_CALLUMNT 5 /* call MOUNTPROC_UMNT on unmount */ #define NFS_MFLAG_RDIRPLUS 6 /* request additional info when reading directories */ #define NFS_MFLAG_NONEGNAMECACHE 7 /* don't do negative name caching */ #define NFS_MFLAG_MUTEJUKEBOX 8 /* don't treat jukebox errors as unresponsive */ #define NFS_MFLAG_EPHEMERAL 9 /* ephemeral (mirror) mount */ #define NFS_MFLAG_NOCALLBACK 10 /* don't provide callback RPC service */ #define NFS_MFLAG_NAMEDATTR 11 /* don't use named attributes */ #define NFS_MFLAG_NOACL 12 /* don't support ACLs */ #define NFS_MFLAG_ACLONLY 13 /* only support ACLs - not mode */ #define NFS_MFLAG_NFC 14 /* send NFC strings */ #define NFS_MFLAG_NOQUOTA 15 /* don't support QUOTA requests */ #define NFS_MFLAG_MNTUDP 16 /* MOUNT protocol should use UDP */ #define NFS_MFLAG_MNTQUICK 17 /* use short timeouts while mounting */ #define NFS_MFLAG_NOOPAQUE_AUTH 19 /* don't make the mount AUTH_OPAQUE. Used by V3 */ #define NFS_MFLAG_SKIP_RENEW 20 /* don't send OP_RENEW when no files are opened. Used by V4 */ /* Macros for packing and unpacking packed versions */ #define PVER2MAJOR(M) ((uint32_t)(((M) >> 16) & 0xffff)) #define PVER2MINOR(m) ((uint32_t)((m) & 0xffff)) #define VER2PVER(M, m) ((uint32_t)((M) << 16) | ((m) & 0xffff)) /* NFS advisory file locking modes */ #define NFS_LOCK_MODE_ENABLED 0 /* advisory file locking enabled */ #define NFS_LOCK_MODE_DISABLED 1 /* do not support advisory file locking */ #define NFS_LOCK_MODE_LOCAL 2 /* perform advisory file locking locally */ #define NFS_STRLEN_INT(str) \ (int)strnlen(str, INT_MAX) #define NFS_UIO_ADDIOV(a_uio, a_baseaddr, a_length) \ assert(a_length <= UINT32_MAX); uio_addiov(a_uio, a_baseaddr, (uint32_t)(a_length)); #define NFS_BZERO(off, bytes) \ do { \ uint32_t bytes32 = bytes > UINT32_MAX ? UINT32_MAX : (uint32_t)(bytes); \ bzero(off, bytes32); \ if (bytes > UINT32_MAX) { \ bzero(off + bytes32, (uint32_t)(bytes - UINT32_MAX)); \ } \ } while(0); #define NFS_ZFREE(zone, ptr) \ do { \ if ((ptr)) { \ zfree((zone), (ptr)); \ (ptr) = NULL; \ } \ } while (0); \ /* Supported encryption types for kerberos session keys */ typedef enum nfs_supported_kerberos_etypes { NFS_DES3_CBC_SHA1_KD = 16, NFS_AES128_CTS_HMAC_SHA1_96 = 17, NFS_AES256_CTS_HMAC_SHA1_96 = 18 } nfs_supported_kerberos_etypes; /* Structure to hold an array of kerberos enctypes to allow on a mount */ #define NFS_MAX_ETYPES 3 struct nfs_etype { uint32_t count; uint32_t selected; /* index in etypes that is being used. Set to count if nothing has been selected */ nfs_supported_kerberos_etypes etypes[NFS_MAX_ETYPES]; }; /* * Old-style arguments to mount NFS */ #define NFS_ARGSVERSION 6 /* change when nfs_args changes */ struct nfs_args { int version; /* args structure version number */ struct sockaddr *addr; /* file server address */ uint8_t addrlen; /* length of address */ int sotype; /* Socket type */ int proto; /* and Protocol */ u_char *fh; /* File handle to be mounted */ int fhsize; /* Size, in bytes, of fh */ int flags; /* flags */ int wsize; /* write size in bytes */ int rsize; /* read size in bytes */ int readdirsize; /* readdir size in bytes */ int timeo; /* initial timeout in .1 secs */ int retrans; /* times to retry send */ int maxgrouplist; /* Max. size of group list */ int readahead; /* # of blocks to readahead */ int leaseterm; /* obsolete: Term (sec) of lease */ int deadthresh; /* obsolete: Retrans threshold */ char *hostname; /* server's name */ /* NFS_ARGSVERSION 3 ends here */ int acregmin; /* reg file min attr cache timeout */ int acregmax; /* reg file max attr cache timeout */ int acdirmin; /* dir min attr cache timeout */ int acdirmax; /* dir max attr cache timeout */ /* NFS_ARGSVERSION 4 ends here */ uint32_t auth; /* security mechanism flavor */ /* NFS_ARGSVERSION 5 ends here */ uint32_t deadtimeout; /* secs until unresponsive mount considered dead */ }; /* incremental size additions in each version of nfs_args */ #define NFS_ARGSVERSION4_INCSIZE (4 * sizeof(int)) #define NFS_ARGSVERSION5_INCSIZE (sizeof(uint32_t)) #define NFS_ARGSVERSION6_INCSIZE (sizeof(uint32_t)) /* * Old-style NFS mount option flags */ #define NFSMNT_SOFT 0x00000001 /* soft mount (hard is default) */ #define NFSMNT_WSIZE 0x00000002 /* set write size */ #define NFSMNT_RSIZE 0x00000004 /* set read size */ #define NFSMNT_TIMEO 0x00000008 /* set initial timeout */ #define NFSMNT_RETRANS 0x00000010 /* set number of request retries */ #define NFSMNT_MAXGRPS 0x00000020 /* set maximum grouplist size */ #define NFSMNT_INT 0x00000040 /* allow interrupts on hard mount */ #define NFSMNT_NOCONN 0x00000080 /* Don't Connect the socket */ #define NFSMNT_NONEGNAMECACHE 0x00000100 /* Don't do negative name caching */ #define NFSMNT_NFSV3 0x00000200 /* Use NFS Version 3 protocol */ #define NFSMNT_NFSV4 0x00000400 /* Use NFS Version 4 protocol */ #define NFSMNT_DUMBTIMR 0x00000800 /* Don't estimate rtt dynamically */ #define NFSMNT_DEADTIMEOUT 0x00001000 /* unmount after a period of unresponsiveness */ #define NFSMNT_READAHEAD 0x00002000 /* set read ahead */ #define NFSMNT_CALLUMNT 0x00004000 /* call MOUNTPROC_UMNT on unmount */ #define NFSMNT_RESVPORT 0x00008000 /* Allocate a reserved port */ #define NFSMNT_RDIRPLUS 0x00010000 /* Use Readdirplus for V3 */ #define NFSMNT_READDIRSIZE 0x00020000 /* Set readdir size */ #define NFSMNT_NOLOCKS 0x00040000 /* don't support file locking */ #define NFSMNT_LOCALLOCKS 0x00080000 /* do file locking locally on client */ #define NFSMNT_ACREGMIN 0x00100000 /* reg min attr cache timeout */ #define NFSMNT_ACREGMAX 0x00200000 /* reg max attr cache timeout */ #define NFSMNT_ACDIRMIN 0x00400000 /* dir min attr cache timeout */ #define NFSMNT_ACDIRMAX 0x00800000 /* dir max attr cache timeout */ #define NFSMNT_SECFLAVOR 0x01000000 /* Use security flavor */ #define NFSMNT_SECSYSOK 0x02000000 /* Server can support auth sys */ #define NFSMNT_MUTEJUKEBOX 0x04000000 /* don't treat jukebox errors as unresponsive */ #define NFSMNT_NOQUOTA 0x08000000 /* don't support QUOTA requests */ /* * fs.nfs sysctl(3) NFS_MOUNTINFO defines */ #define NFS_MOUNT_INFO_VERSION 0 /* nfsstat mount information version */ #define NFS_MIATTR_BITMAP_LEN 1 /* length of mount info attributes bitmap */ #define NFS_MIFLAG_BITMAP_LEN 1 /* length of mount info flags bitmap */ /* NFS mount info attributes */ #define NFS_MIATTR_FLAGS 0 /* mount info flags bitmap (MIFLAG_*) */ #define NFS_MIATTR_ORIG_ARGS 1 /* original mount args passed into mount call */ #define NFS_MIATTR_CUR_ARGS 2 /* current mount args values */ #define NFS_MIATTR_CUR_LOC_INDEX 3 /* current fs location index */ /* NFS mount info flags */ #define NFS_MIFLAG_DEAD 0 /* mount is dead */ #define NFS_MIFLAG_NOTRESP 1 /* server is unresponsive */ #define NFS_MIFLAG_RECOVERY 2 /* mount in recovery */ /* * Structures for the nfssvc(2) syscall. Not that anyone but nfsd * should ever try and use it. */ struct nfsd_args { int sock; /* Socket to serve */ caddr_t name; /* Client addr for connection based sockets */ int namelen; /* Length of name */ }; /* * NFS Server File Handle structures */ /* NFS export handle identifies which NFS export */ #define NFS_FH_VERSION 0x4e580000 /* 'NX00' */ struct nfs_exphandle { uint32_t nxh_version; /* data structure version */ uint32_t nxh_fsid; /* File System Export ID */ uint32_t nxh_expid; /* Export ID */ uint16_t nxh_flags; /* export handle flags */ uint8_t nxh_reserved; /* future use */ uint32_t nxh_fidlen; /* length of File ID */ }; /* nxh_flags */ #define NXHF_INVALIDFH 0x0001 /* file handle is invalid */ #define NFS_MAX_FID_SIZE (NFS_MAX_FH_SIZE - sizeof(struct nfs_exphandle)) #define NFSV4_MAX_FID_SIZE (NFSV4_MAX_FH_SIZE - sizeof(struct nfs_exphandle)) #define NFSV3_MAX_FID_SIZE (NFSV3_MAX_FH_SIZE - sizeof(struct nfs_exphandle)) #define NFSV2_MAX_FID_SIZE (NFSV2_MAX_FH_SIZE - sizeof(struct nfs_exphandle)) /* NFS server internal view of fhandle_t */ /* The first sizeof(fhandle_t) bytes must match what goes into fhandle_t. */ /* (fhp is used to allow use of an external buffer) */ struct nfs_filehandle { uint32_t nfh_len; /* total length of file handle */ struct nfs_exphandle nfh_xh; /* export handle */ unsigned char nfh_fid[NFS_MAX_FID_SIZE]; /* File ID */ unsigned char *nfh_fhp; /* pointer to file handle */ }; /* * NFS export data structures */ /* Structure to hold an array of security flavors */ #define NX_MAX_SEC_FLAVORS 5 struct nfs_sec { int count; uint32_t flavors[NX_MAX_SEC_FLAVORS]; }; struct nfs_export_net_args { uint32_t nxna_flags; /* export flags */ struct xucred nxna_cred; /* mapped credential for root/all user */ struct sockaddr_storage nxna_addr; /* net address to which exported */ struct sockaddr_storage nxna_mask; /* mask for net address */ struct nfs_sec nxna_sec; /* security mechanism flavors */ }; struct nfs_export_args { uint32_t nxa_fsid; /* export FS ID */ uint32_t nxa_expid; /* export ID */ char *nxa_fspath; /* export FS path */ char *nxa_exppath; /* export sub-path */ uint32_t nxa_flags; /* export arg flags */ uint32_t nxa_netcount; /* #entries in ex_nets array */ struct nfs_export_net_args *nxa_nets; /* array of net args */ }; /* nfs export arg flags */ #define NXA_DELETE 0x0001 /* delete the specified export(s) */ #define NXA_ADD 0x0002 /* add the specified export(s) */ #define NXA_REPLACE 0x0003 /* delete and add the specified export(s) */ #define NXA_DELETE_ALL 0x0004 /* delete all exports */ #define NXA_OFFLINE 0x0008 /* export is offline */ #define NXA_CHECK 0x0010 /* check if exportable */ /* export option flags */ #define NX_READONLY 0x0001 /* exported read-only */ #define NX_DEFAULTEXPORT 0x0002 /* exported to the world */ #define NX_MAPROOT 0x0004 /* map root access to anon credential */ #define NX_MAPALL 0x0008 /* map all access to anon credential */ #define NX_32BITCLIENTS 0x0020 /* restrict directory cookies to 32 bits */ #define NX_OFFLINE 0x0040 /* export is offline */ #define NX_MANGLEDNAMES 0x0080 /* export will return mangled names for names > 255 bytes */ /* * fs.nfs sysctl(3) export stats record structures */ #define NFS_EXPORT_STAT_REC_VERSION 1 /* export stat record version */ #define NFS_USER_STAT_REC_VERSION 1 /* active user list record version */ /* descriptor describing following records */ struct nfs_export_stat_desc { uint32_t rec_vers; /* version of export stat records */ uint64_t rec_count; /* total record count */ }__attribute__((__packed__)); /* export stat record containing path and stat counters */ struct nfs_export_stat_rec { char path[RPCMNT_PATHLEN + 1]; uint64_t ops; /* Count of NFS Requests received for this export */ uint64_t bytes_read; /* Count of bytes read from this export */ uint64_t bytes_written; /* Count of bytes written to this export */ }__attribute__((__packed__)); /* Active user list stat buffer descriptor */ struct nfs_user_stat_desc { uint32_t rec_vers; /* version of active user stat records */ uint32_t rec_count; /* total record count */ }__attribute__((__packed__)); /* Active user list user stat record format */ struct nfs_user_stat_user_rec { u_char rec_type; uid_t uid; struct sockaddr_storage sock; uint64_t ops; uint64_t bytes_read; uint64_t bytes_written; time_t tm_start; time_t tm_last; }__attribute__((__packed__)); /* Active user list path record format */ struct nfs_user_stat_path_rec { u_char rec_type; char path[RPCMNT_PATHLEN + 1]; }__attribute__((__packed__)); /* Defines for rec_type field of * nfs_user_stat_rec & nfs_user_stat_rec * data structures */ #define NFS_USER_STAT_USER_REC 0 #define NFS_USER_STAT_PATH_REC 1 typedef struct nfserr_info { const char * nei_name; const int nei_error; const int nei_index; } nfserr_info_t; /* * NFS Common Errors */ #define NFSERR_INFO_COMMON \ { "NFS_OK", NFS_OK, 0 }, \ { "ERR_PERM", NFSERR_PERM, 1 }, \ { "ERR_NOENT", NFSERR_NOENT, 2 }, \ { "ERR_IO", NFSERR_IO, 3 }, \ { "ERR_NXIO", NFSERR_NXIO, 4 }, \ { "ERR_ACCES", NFSERR_ACCES, 5 }, \ { "ERR_EXIST", NFSERR_EXIST, 6 }, \ { "ERR_XDEV", NFSERR_XDEV, 7 }, \ { "ERR_NODEV", NFSERR_NODEV, 8 }, \ { "ERR_NOTDIR", NFSERR_NOTDIR, 9 }, \ { "ERR_ISDIR", NFSERR_ISDIR, 10 }, \ { "ERR_INVAL", NFSERR_INVAL, 11 }, \ { "ERR_FBIG", NFSERR_FBIG, 12 }, \ { "ERR_NOSPC", NFSERR_NOSPC, 13 }, \ { "ERR_ROFS", NFSERR_ROFS, 14 }, \ { "ERR_MLINK", NFSERR_MLINK, 15 }, \ { "ERR_NAMETOL", NFSERR_NAMETOL, 16 }, \ { "ERR_NOTEMPTY", NFSERR_NOTEMPTY, 17 }, \ { "ERR_DQUOT", NFSERR_DQUOT, 18 }, \ { "ERR_STALE", NFSERR_STALE, 19 }, \ { "ERR_REMOTE", NFSERR_REMOTE, 20 }, \ { "ERR_WFLUSH", NFSERR_WFLUSH, 21 }, \ { "ERR_BADHANDLE", NFSERR_BADHANDLE, 22 }, \ { "ERR_NOT_SYNC", NFSERR_NOT_SYNC, 23 }, \ { "ERR_BAD_COOKIE", NFSERR_BAD_COOKIE, 24 }, \ { "ERR_NOTSUPP", NFSERR_NOTSUPP, 25 }, \ { "ERR_TOOSMALL", NFSERR_TOOSMALL, 26 }, \ { "ERR_SERVERFAULT", NFSERR_SERVERFAULT, 27 }, \ { "ERR_BADTYPE", NFSERR_BADTYPE, 28 }, \ { "ERR_DELAY", NFSERR_DELAY, 29 } #define NFSERR_INFO_COMMON_SIZE 30 /* * NFSv4 Errors */ #define NFSERR_INFO_V4 \ /* NFSv4 Errors */ \ { "ERR_SAME", NFSERR_SAME, 0 }, \ { "ERR_DENIED", NFSERR_DENIED, 1 }, \ { "ERR_EXPIRED", NFSERR_EXPIRED, 2 }, \ { "ERR_LOCKED", NFSERR_LOCKED, 3 }, \ { "ERR_GRACE", NFSERR_GRACE, 4 }, \ { "ERR_FHEXPIRED", NFSERR_FHEXPIRED, 5 }, \ { "ERR_SHARE_DENIED", NFSERR_SHARE_DENIED, 6 }, \ { "ERR_WRONGSEC", NFSERR_WRONGSEC, 7 }, \ { "ERR_CLID_INUSE", NFSERR_CLID_INUSE, 8 }, \ { "ERR_RESOURCE", NFSERR_RESOURCE, 9 }, \ { "ERR_MOVED", NFSERR_MOVED, 10 }, \ { "ERR_NOFILEHANDLE", NFSERR_NOFILEHANDLE, 11 }, \ { "ERR_MINOR_VERS_MISMATCH", NFSERR_MINOR_VERS_MISMATCH, 12 }, \ { "ERR_STALE_CLIENTID", NFSERR_STALE_CLIENTID, 13 }, \ { "ERR_STALE_STATEID", NFSERR_STALE_STATEID, 14 }, \ { "ERR_OLD_STATEID", NFSERR_OLD_STATEID, 15 }, \ { "ERR_BAD_STATEID", NFSERR_BAD_STATEID, 16 }, \ { "ERR_BAD_SEQID", NFSERR_BAD_SEQID, 17 }, \ { "ERR_NOT_SAME", NFSERR_NOT_SAME, 18 }, \ { "ERR_LOCK_RANGE", NFSERR_LOCK_RANGE, 19 }, \ { "ERR_SYMLINK", NFSERR_SYMLINK, 20 }, \ { "ERR_RESTOREFH", NFSERR_RESTOREFH, 21 }, \ { "ERR_LEASE_MOVED", NFSERR_LEASE_MOVED, 22 }, \ { "ERR_ATTRNOTSUPP", NFSERR_ATTRNOTSUPP, 23 }, \ { "ERR_NO_GRACE", NFSERR_NO_GRACE, 24 }, \ { "ERR_RECLAIM_BAD", NFSERR_RECLAIM_BAD, 25 }, \ { "ERR_RECLAIM_CONFLICT", NFSERR_RECLAIM_CONFLICT, 26 }, \ { "ERR_BADXDR", NFSERR_BADXDR, 27 }, \ { "ERR_LOCKS_HELD", NFSERR_LOCKS_HELD, 28 }, \ { "ERR_OPENMODE", NFSERR_OPENMODE, 29 }, \ { "ERR_BADOWNER", NFSERR_BADOWNER, 30 }, \ { "ERR_BADCHAR", NFSERR_BADCHAR, 31 }, \ { "ERR_BADNAME", NFSERR_BADNAME, 32 }, \ { "ERR_BAD_RANGE", NFSERR_BAD_RANGE, 33 }, \ { "ERR_LOCK_NOTSUPP", NFSERR_LOCK_NOTSUPP, 34 }, \ { "ERR_OP_ILLEGAL", NFSERR_OP_ILLEGAL, 35 }, \ { "ERR_DEADLOCK", NFSERR_DEADLOCK, 36 }, \ { "ERR_FILE_OPEN", NFSERR_FILE_OPEN, 37 }, \ { "ERR_ADMIN_REVOKED", NFSERR_ADMIN_REVOKED, 38 }, \ { "ERR_CB_PATH_DOWN", NFSERR_CB_PATH_DOWN, 39 } , \ /* NFSv4.1 Errors */ \ { "ERR_BADIOMODE", NFSERR_BADIOMODE, 40} , \ { "ERR_BADLAYOUT", NFSERR_BADLAYOUT, 41 } , \ { "ERR_BADSESSIONDIGEST", NFSERR_BADSESSIONDIGEST, 42 } , \ { "ERR_BADSESSION", NFSERR_BADSESSION, 43 } , \ { "ERR_BADSLOT", NFSERR_BADSLOT, 44 } , \ { "ERR_COMPLETEALREADY", NFSERR_COMPLETEALREADY, 45 } , \ { "ERR_NOTBNDTOSESS", NFSERR_NOTBNDTOSESS, 46 } , \ { "ERR_DELEGALREADYWANT", NFSERR_DELEGALREADYWANT, 47 } , \ { "ERR_BACKCHANBUSY", NFSERR_BACKCHANBUSY, 48 } , \ { "ERR_LAYOUTTRYLATER", NFSERR_LAYOUTTRYLATER, 49 } , \ { "ERR_LAYOUTUNAVAIL", NFSERR_LAYOUTUNAVAIL, 50 } , \ { "ERR_NOMATCHLAYOUT", NFSERR_NOMATCHLAYOUT, 51 } , \ { "ERR_RECALLCONFLICT", NFSERR_RECALLCONFLICT, 52 } , \ { "ERR_UNKNLAYOUTTYPE", NFSERR_UNKNLAYOUTTYPE, 53 } , \ { "ERR_SEQMISORDERED", NFSERR_SEQMISORDERED, 54 } , \ { "ERR_SEQUENCEPOS", NFSERR_SEQUENCEPOS, 55 } , \ { "ERR_REQTOOBIG", NFSERR_REQTOOBIG, 56 } , \ { "ERR_REPTOOBIG", NFSERR_REPTOOBIG, 57 } , \ { "ERR_REPTOOBIGTOCACHE", NFSERR_REPTOOBIGTOCACHE, 58 } , \ { "ERR_RETRYUNCACHEDREP", NFSERR_RETRYUNCACHEDREP, 59 } , \ { "ERR_UNSAFECOMPOUND", NFSERR_UNSAFECOMPOUND, 60 } , \ { "ERR_TOOMANYOPS", NFSERR_TOOMANYOPS, 61 } , \ { "ERR_OPNOTINSESS", NFSERR_OPNOTINSESS, 62 } , \ { "ERR_HASHALGUNSUPP", NFSERR_HASHALGUNSUPP, 63 } , \ { "ERR_CLIENTIDBUSY", NFSERR_CLIENTIDBUSY, 64 } , \ { "ERR_PNFSIOHOLE", NFSERR_PNFSIOHOLE, 65 } , \ { "ERR_SEQFALSERETRY", NFSERR_SEQFALSERETRY, 66 } , \ { "ERR_BADHIGHSLOT", NFSERR_BADHIGHSLOT, 67 } , \ { "ERR_DEADSESSION", NFSERR_DEADSESSION, 68 } , \ { "ERR_ENCRALGUNSUPP", NFSERR_ENCRALGUNSUPP, 69 } , \ { "ERR_PNFSNOLAYOUT", NFSERR_PNFSNOLAYOUT, 70 } , \ { "ERR_NOTONLYOP", NFSERR_NOTONLYOP, 71 } , \ { "ERR_WRONGCRED", NFSERR_WRONGCRED, 72 } , \ { "ERR_WRONGTYPE", NFSERR_WRONGTYPE, 73 } , \ { "ERR_DIRDELEGUNAVAIL", NFSERR_DIRDELEGUNAVAIL, 74 } , \ { "ERR_REJECTDELEG", NFSERR_REJECTDELEG, 75 } , \ { "ERR_RETURNCONFLICT", NFSERR_RETURNCONFLICT, 76 } , \ { "ERR_DELEGREVOKED", NFSERR_DELEGREVOKED, 77 } #define NFSERR_INFO_V4_SIZE 40 #define NFSERR_INFO_V41_SIZE 78 /* * XXX to allow amd to include nfs.h without nfsproto.h */ #ifdef NFS_NPROCS /* * Stats structure */ struct nfsclntstats { uint64_t attrcache_hits; uint64_t attrcache_misses; uint64_t lookupcache_hits; uint64_t lookupcache_misses; uint64_t direofcache_hits; uint64_t direofcache_misses; uint64_t accesscache_hits; uint64_t accesscache_misses; uint64_t biocache_reads; uint64_t read_bios; uint64_t read_physios; uint64_t biocache_writes; uint64_t write_bios; uint64_t write_physios; uint64_t biocache_readlinks; uint64_t readlink_bios; uint64_t biocache_readdirs; uint64_t readdir_bios; uint64_t rpccntv3[NFS_NPROCS]; struct { uint64_t nlm_lock; uint64_t nlm_test; uint64_t nlm_unlock; } nlmcnt; // NFSv3 only uint64_t opcntv4[NFS_V41_OP_COUNT]; uint64_t cbopcntv4[NFS_V41_OP_CB_COUNT]; uint64_t rpcretries; uint64_t rpcrequests; uint64_t rpctimeouts; uint64_t rpcunexpected; uint64_t rpcinvalid; uint64_t pageins; uint64_t pageouts; struct { uint64_t errs_common[NFSERR_INFO_COMMON_SIZE]; uint64_t errs_v4[NFSERR_INFO_V41_SIZE]; uint64_t errs_unknown; } nfs_errs; }; struct nfsrvstats { uint64_t srvrpccntv3[NFS_NPROCS]; uint64_t srvrpc_errs; uint64_t srv_errs; uint64_t srvcache_inproghits; uint64_t srvcache_idemdonehits; uint64_t srvcache_nonidemdonehits; uint64_t srvcache_misses; uint64_t srvvop_writes; struct { uint64_t errs_common[NFSERR_INFO_COMMON_SIZE]; uint64_t errs_unknown; } nfs_errs; }; #endif /* * Flags for nfssvc() system call. */ #define NFSSVC_NFSD 0x004 #define NFSSVC_ADDSOCK 0x008 #define NFSSVC_EXPORTSTATS 0x010 /* gets exported directory stats */ #define NFSSVC_USERSTATS 0x020 /* gets exported directory active user stats */ #define NFSSVC_USERCOUNT 0x040 /* gets current count of active nfs users */ #define NFSSVC_ZEROSTATS 0x080 /* zero nfs server statistics */ #define NFSSVC_SRVSTATS 0x100 /* struct: struct nfsrvstats */ #define NFSSVC_EXPORT 0x200 /* * The structure that lockd hands the kernel for each lock answer. */ #define LOCKD_ANS_VERSION 2 struct lockd_ans { int la_version; /* lockd_ans version */ int la_errno; /* return status */ u_int64_t la_xid; /* unique message transaction ID */ int la_flags; /* answer flags */ pid_t la_pid; /* pid of lock requester/owner */ off_t la_start; /* lock starting offset */ off_t la_len; /* lock length */ int la_fh_len; /* The file handle length. */ u_int8_t la_fh[NFSV3_MAX_FH_SIZE];/* The file handle. */ }; /* * The structure that lockd hands the kernel for each notify. */ #define LOCKD_NOTIFY_VERSION 1 struct lockd_notify { int ln_version; /* lockd_notify version */ int ln_flags; /* notify flags */ int ln_pad; /* (for alignment) */ int ln_addrcount; /* # of addresss */ struct sockaddr_storage *ln_addr; /* List of addresses. */ }; #include /* for guid_t below */ #define MAXIDNAMELEN 1024 struct nfs_testmapid { uint32_t ntm_lookup; /* lookup name 2 id or id 2 name */ uint32_t ntm_grpflag; /* Is this a group or user maping */ uint32_t ntm_id; /* id to map or return */ uint32_t pad; guid_t ntm_guid; /* intermidiate guid used in conversion */ char ntm_name[MAXIDNAMELEN]; /* name to map or return */ }; #define NTM_ID2NAME 0 #define NTM_NAME2ID 1 #define NTM_NAME2GUID 2 #define NTM_GUID2NAME 3 /* * Flags for nfsclnt() system call. */ #define NFSCLNT_LOCKDANS _IOW('n', 101, struct lockd_ans) #define NFSCLNT_LOCKDNOTIFY _IOW('n', 102, struct lockd_notify) #define NFSCLNT_TESTIDMAP _IOWR('n', 103, struct nfs_testmapid) /* nfsclnt() system call character device */ #define NFSCLNT_DEVICE "nfsclnt" /* nfsclnt() system call */ int nfsclnt(unsigned long request, void *argstructp); /* * fs.nfs sysctl(3) identifiers */ #define NFS_NFSSTATS 1 /* struct: struct nfsclntstats */ #define NFS_MOUNTINFO 6 /* gets information about an NFS mount */ #define NFS_NFSZEROSTATS 7 /* zero nfs client statistics */ #ifndef NFS_WDELAYHASHSIZ #define NFS_WDELAYHASHSIZ 16 /* and with this */ #endif #endif /* __APPLE_API_PRIVATE */ #endif