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