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