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