]> git.saurik.com Git - apple/xnu.git/blame - bsd/nfs/nfs.h
xnu-1228.0.2.tar.gz
[apple/xnu.git] / bsd / nfs / nfs.h
CommitLineData
1c79356b 1/*
2d21ac55 2 * Copyright (c) 2000-2007 Apple Inc. All rights reserved.
5d5c5d0d 3 *
2d21ac55 4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b 5 *
2d21ac55
A
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. The rights granted to you under the License
10 * may not be used to create, or enable the creation or redistribution of,
11 * unlawful or unlicensed copies of an Apple operating system, or to
12 * circumvent, violate, or enable the circumvention or violation of, any
13 * terms of an Apple operating system software license agreement.
8f6c56a5 14 *
2d21ac55
A
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
17 *
18 * The Original Code and all software distributed under the License are
19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
8f6c56a5
A
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55
A
22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23 * Please see the License for the specific language governing rights and
24 * limitations under the License.
8f6c56a5 25 *
2d21ac55 26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b
A
27 */
28/* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
29/*
30 * Copyright (c) 1989, 1993, 1995
31 * The Regents of the University of California. All rights reserved.
32 *
33 * This code is derived from software contributed to Berkeley by
34 * Rick Macklem at The University of Guelph.
35 *
36 * Redistribution and use in source and binary forms, with or without
37 * modification, are permitted provided that the following conditions
38 * are met:
39 * 1. Redistributions of source code must retain the above copyright
40 * notice, this list of conditions and the following disclaimer.
41 * 2. Redistributions in binary form must reproduce the above copyright
42 * notice, this list of conditions and the following disclaimer in the
43 * documentation and/or other materials provided with the distribution.
44 * 3. All advertising materials mentioning features or use of this software
45 * must display the following acknowledgement:
46 * This product includes software developed by the University of
47 * California, Berkeley and its contributors.
48 * 4. Neither the name of the University nor the names of its contributors
49 * may be used to endorse or promote products derived from this software
50 * without specific prior written permission.
51 *
52 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
53 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
54 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
55 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
56 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
57 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
58 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
59 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
60 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
61 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
62 * SUCH DAMAGE.
63 *
64 * @(#)nfs.h 8.4 (Berkeley) 5/1/95
65 * FreeBSD-Id: nfs.h,v 1.32 1997/10/12 20:25:38 phk Exp $
66 */
67
68#ifndef _NFS_NFS_H_
69#define _NFS_NFS_H_
70
9bccf70c 71#include <sys/appleapiopts.h>
91447636 72#include <sys/cdefs.h>
9bccf70c
A
73
74#ifdef __APPLE_API_PRIVATE
1c79356b
A
75/*
76 * Tunable constants for nfs
77 */
78
1c79356b
A
79#define NFS_TICKINTVL 5 /* Desired time for a tick (msec) */
80#define NFS_HZ (hz / nfs_ticks) /* Ticks/sec */
2d21ac55 81__private_extern__ int nfs_ticks;
1c79356b
A
82#define NFS_TIMEO (1 * NFS_HZ) /* Default timeout = 1 second */
83#define NFS_MINTIMEO (1 * NFS_HZ) /* Min timeout to use */
84#define NFS_MAXTIMEO (60 * NFS_HZ) /* Max timeout to backoff to */
85#define NFS_MINIDEMTIMEO (5 * NFS_HZ) /* Min timeout for non-idempotent ops*/
86#define NFS_MAXREXMIT 100 /* Stop counting after this many */
1c79356b 87#define NFS_RETRANS 10 /* Num of retrans for soft mounts */
2d21ac55 88#define NFS_TRYLATERDEL 4 /* Initial try later delay (sec) */
1c79356b 89#define NFS_MAXGRPS 16 /* Max. size of groups list */
1c79356b 90#define NFS_MINATTRTIMO 5 /* Attribute cache timeout in sec */
1c79356b 91#define NFS_MAXATTRTIMO 60
91447636 92#define NFS_MINDIRATTRTIMO 5 /* directory attribute cache timeout in sec */
91447636 93#define NFS_MAXDIRATTRTIMO 60
2d21ac55
A
94#define NFS_IOSIZE (1024 * 1024) /* suggested I/O size */
95#define NFS_RWSIZE 32768 /* Def. read/write data size <= 32K */
96#define NFS_WSIZE NFS_RWSIZE /* Def. write data size <= 32K */
97#define NFS_RSIZE NFS_RWSIZE /* Def. read data size <= 32K */
55e303ae
A
98#define NFS_DGRAM_WSIZE 8192 /* UDP Def. write data size <= 8K */
99#define NFS_DGRAM_RSIZE 8192 /* UDP Def. read data size <= 8K */
1c79356b 100#define NFS_READDIRSIZE 8192 /* Def. readdir size */
2d21ac55
A
101#define NFS_DEFRAHEAD 16 /* Def. read ahead # blocks */
102#define NFS_MAXRAHEAD 128 /* Max. read ahead # blocks */
103#define NFS_DEFMAXASYNCWRITES 128 /* Def. max # concurrent async write RPCs */
104#define NFS_DEFASYNCTHREAD 16 /* Def. # nfsiod threads */
105#define NFS_MAXASYNCTHREAD 64 /* max # nfsiod threads */
106#define NFS_ASYNCTHREADMAXIDLE 60 /* Seconds before idle nfsiods are reaped */
107#define NFS_DEFSTATFSRATELIMIT 10 /* Def. max # statfs RPCs per second */
108#define NFS_REQUESTDELAY 10 /* ms interval to check request queue */
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) */
1c79356b
A
113#endif
114#define NFS_DIRBLKSIZ 4096 /* Must be a multiple of DIRBLKSIZ */
55e303ae
A
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
1c79356b 119
2d21ac55
A
120/* default values for unresponsive mount timeouts */
121#define NFS_TPRINTF_INITIAL_DELAY 12
122#define NFS_TPRINTF_DELAY 30
123
1c79356b
A
124/*
125 * Oddballs
126 */
1c79356b
A
127#define NFS_CMPFH(n, f, s) \
128 ((n)->n_fhsize == (s) && !bcmp((caddr_t)(n)->n_fhp, (caddr_t)(f), (s)))
1c79356b 129#define NFS_SRVMAXDATA(n) \
2d21ac55 130 (((n)->nd_vers == NFS_VER3) ? (((n)->nd_nam2) ? \
1c79356b
A
131 NFS_MAXDGRAMDATA : NFS_MAXDATA) : NFS_V2MAXDATA)
132
1c79356b
A
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
1c79356b
A
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 there own nfs zones.
150*/
151#define NFS_NODEALLOC 512
152#define NFS_MNTALLOC 512
153#define NFS_SVCALLOC 256
1c79356b
A
154
155/*
156 * Arguments to mount NFS
157 */
2d21ac55 158#define NFS_ARGSVERSION 5 /* change when nfs_args changes */
1c79356b
A
159struct nfs_args {
160 int version; /* args structure version number */
161 struct sockaddr *addr; /* file server address */
162 int addrlen; /* length of address */
163 int sotype; /* Socket type */
164 int proto; /* and Protocol */
165 u_char *fh; /* File handle to be mounted */
166 int fhsize; /* Size, in bytes, of fh */
167 int flags; /* flags */
168 int wsize; /* write size in bytes */
169 int rsize; /* read size in bytes */
170 int readdirsize; /* readdir size in bytes */
171 int timeo; /* initial timeout in .1 secs */
172 int retrans; /* times to retry send */
173 int maxgrouplist; /* Max. size of group list */
174 int readahead; /* # of blocks to readahead */
91447636
A
175 int leaseterm; /* obsolete: Term (sec) of lease */
176 int deadthresh; /* obsolete: Retrans threshold */
177 char *hostname; /* server's name */
178 /* NFS_ARGSVERSION 3 ends here */
179 int acregmin; /* reg file min attr cache timeout */
180 int acregmax; /* reg file max attr cache timeout */
181 int acdirmin; /* dir min attr cache timeout */
182 int acdirmax; /* dir max attr cache timeout */
2d21ac55
A
183 /* NFS_ARGSVERSION 4 ends here */
184 uint32_t auth; /* security mechanism flavor */
185};
186struct nfs_args4 {
187 int version; /* args structure version number */
188 struct sockaddr *addr; /* file server address */
189 int addrlen; /* length of address */
190 int sotype; /* Socket type */
191 int proto; /* and Protocol */
192 u_char *fh; /* File handle to be mounted */
193 int fhsize; /* Size, in bytes, of fh */
194 int flags; /* flags */
195 int wsize; /* write size in bytes */
196 int rsize; /* read size in bytes */
197 int readdirsize; /* readdir size in bytes */
198 int timeo; /* initial timeout in .1 secs */
199 int retrans; /* times to retry send */
200 int maxgrouplist; /* Max. size of group list */
201 int readahead; /* # of blocks to readahead */
202 int leaseterm; /* obsolete: Term (sec) of lease */
203 int deadthresh; /* obsolete: Retrans threshold */
204 char *hostname; /* server's name */
205 /* NFS_ARGSVERSION 3 ends here */
206 int acregmin; /* reg file min attr cache timeout */
207 int acregmax; /* reg file max attr cache timeout */
208 int acdirmin; /* dir min attr cache timeout */
209 int acdirmax; /* dir max attr cache timeout */
91447636
A
210};
211
212struct nfs_args3 {
213 int version; /* args structure version number */
214 struct sockaddr *addr; /* file server address */
215 int addrlen; /* length of address */
216 int sotype; /* Socket type */
217 int proto; /* and Protocol */
218 u_char *fh; /* File handle to be mounted */
219 int fhsize; /* Size, in bytes, of fh */
220 int flags; /* flags */
221 int wsize; /* write size in bytes */
222 int rsize; /* read size in bytes */
223 int readdirsize; /* readdir size in bytes */
224 int timeo; /* initial timeout in .1 secs */
225 int retrans; /* times to retry send */
226 int maxgrouplist; /* Max. size of group list */
227 int readahead; /* # of blocks to readahead */
228 int leaseterm; /* obsolete: Term (sec) of lease */
229 int deadthresh; /* obsolete: Retrans threshold */
1c79356b
A
230 char *hostname; /* server's name */
231};
232
91447636
A
233#ifdef KERNEL
234/* LP64 version of nfs_args. all pointers and longs
235 * grow when we're dealing with a 64-bit process.
236 * WARNING - keep in sync with nfs_args
237 */
91447636
A
238struct user_nfs_args {
239 int version; /* args structure version number */
0c530ab8 240 user_addr_t addr __attribute((aligned(8))); /* file server address */
91447636
A
241 int addrlen; /* length of address */
242 int sotype; /* Socket type */
243 int proto; /* and Protocol */
0c530ab8 244 user_addr_t fh __attribute((aligned(8))); /* File handle to be mounted */
91447636
A
245 int fhsize; /* Size, in bytes, of fh */
246 int flags; /* flags */
247 int wsize; /* write size in bytes */
248 int rsize; /* read size in bytes */
249 int readdirsize; /* readdir size in bytes */
250 int timeo; /* initial timeout in .1 secs */
251 int retrans; /* times to retry send */
252 int maxgrouplist; /* Max. size of group list */
253 int readahead; /* # of blocks to readahead */
254 int leaseterm; /* obsolete: Term (sec) of lease */
255 int deadthresh; /* obsolete: Retrans threshold */
0c530ab8 256 user_addr_t hostname __attribute((aligned(8))); /* server's name */
91447636
A
257 /* NFS_ARGSVERSION 3 ends here */
258 int acregmin; /* reg file min attr cache timeout */
259 int acregmax; /* reg file max attr cache timeout */
260 int acdirmin; /* dir min attr cache timeout */
261 int acdirmax; /* dir max attr cache timeout */
2d21ac55
A
262 /* NFS_ARGSVERSION 4 ends here */
263 uint32_t auth; /* security mechanism flavor */
264};
265struct user_nfs_args4 {
266 int version; /* args structure version number */
267 user_addr_t addr __attribute((aligned(8))); /* file server address */
268 int addrlen; /* length of address */
269 int sotype; /* Socket type */
270 int proto; /* and Protocol */
271 user_addr_t fh __attribute((aligned(8))); /* File handle to be mounted */
272 int fhsize; /* Size, in bytes, of fh */
273 int flags; /* flags */
274 int wsize; /* write size in bytes */
275 int rsize; /* read size in bytes */
276 int readdirsize; /* readdir size in bytes */
277 int timeo; /* initial timeout in .1 secs */
278 int retrans; /* times to retry send */
279 int maxgrouplist; /* Max. size of group list */
280 int readahead; /* # of blocks to readahead */
281 int leaseterm; /* obsolete: Term (sec) of lease */
282 int deadthresh; /* obsolete: Retrans threshold */
283 user_addr_t hostname __attribute((aligned(8))); /* server's name */
284 /* NFS_ARGSVERSION 3 ends here */
285 int acregmin; /* reg file min attr cache timeout */
286 int acregmax; /* reg file max attr cache timeout */
287 int acdirmin; /* dir min attr cache timeout */
288 int acdirmax; /* dir max attr cache timeout */
91447636
A
289};
290struct user_nfs_args3 {
291 int version; /* args structure version number */
0c530ab8 292 user_addr_t addr __attribute((aligned(8))); /* file server address */
91447636
A
293 int addrlen; /* length of address */
294 int sotype; /* Socket type */
295 int proto; /* and Protocol */
0c530ab8 296 user_addr_t fh __attribute((aligned(8))); /* File handle to be mounted */
91447636
A
297 int fhsize; /* Size, in bytes, of fh */
298 int flags; /* flags */
299 int wsize; /* write size in bytes */
300 int rsize; /* read size in bytes */
301 int readdirsize; /* readdir size in bytes */
302 int timeo; /* initial timeout in .1 secs */
303 int retrans; /* times to retry send */
304 int maxgrouplist; /* Max. size of group list */
305 int readahead; /* # of blocks to readahead */
306 int leaseterm; /* obsolete: Term (sec) of lease */
307 int deadthresh; /* obsolete: Retrans threshold */
0c530ab8 308 user_addr_t hostname __attribute((aligned(8))); /* server's name */
91447636
A
309};
310
91447636
A
311#endif // KERNEL
312
1c79356b
A
313/*
314 * NFS mount option flags
315 */
316#define NFSMNT_SOFT 0x00000001 /* soft mount (hard is default) */
317#define NFSMNT_WSIZE 0x00000002 /* set write size */
318#define NFSMNT_RSIZE 0x00000004 /* set read size */
319#define NFSMNT_TIMEO 0x00000008 /* set initial timeout */
320#define NFSMNT_RETRANS 0x00000010 /* set number of request retries */
321#define NFSMNT_MAXGRPS 0x00000020 /* set maximum grouplist size */
322#define NFSMNT_INT 0x00000040 /* allow interrupts on hard mount */
323#define NFSMNT_NOCONN 0x00000080 /* Don't Connect the socket */
2d21ac55 324#define NFSMNT_NONEGNAMECACHE 0x00000100 /* Don't do negative name caching */
1c79356b 325#define NFSMNT_NFSV3 0x00000200 /* Use NFS Version 3 protocol */
2d21ac55 326#define NFSMNT_NFSV4 0x00000400 /* Use NFS Version 4 protocol */
1c79356b 327#define NFSMNT_DUMBTIMR 0x00000800 /* Don't estimate rtt dynamically */
2d21ac55 328// #define NFSMNT_UNUSED 0x00001000 /* unused */
1c79356b 329#define NFSMNT_READAHEAD 0x00002000 /* set read ahead */
2d21ac55 330// #define NFSMNT_UNUSED 0x00004000 /* unused */
1c79356b
A
331#define NFSMNT_RESVPORT 0x00008000 /* Allocate a reserved port */
332#define NFSMNT_RDIRPLUS 0x00010000 /* Use Readdirplus for V3 */
333#define NFSMNT_READDIRSIZE 0x00020000 /* Set readdir size */
55e303ae 334#define NFSMNT_NOLOCKS 0x00040000 /* don't support file locking */
2d21ac55 335#define NFSMNT_LOCALLOCKS 0x00080000 /* do file locking locally on client */
91447636
A
336#define NFSMNT_ACREGMIN 0x00100000 /* reg min attr cache timeout */
337#define NFSMNT_ACREGMAX 0x00200000 /* reg max attr cache timeout */
338#define NFSMNT_ACDIRMIN 0x00400000 /* dir min attr cache timeout */
339#define NFSMNT_ACDIRMAX 0x00800000 /* dir max attr cache timeout */
2d21ac55
A
340#define NFSMNT_SECFLAVOR 0x01000000 /* Use security flavor */
341#define NFSMNT_SECGIVEN 0x02000000 /* A sec= mount option was given */
55e303ae 342
91447636 343/*
2d21ac55 344 * Structures for the nfssvc(2) syscall. Not that anyone but nfsd
1c79356b
A
345 * should ever try and use it.
346 */
347struct nfsd_args {
348 int sock; /* Socket to serve */
349 caddr_t name; /* Client addr for connection based sockets */
350 int namelen; /* Length of name */
351};
352
91447636
A
353#ifdef KERNEL
354/* LP64 version of nfsd_args. all pointers and longs
355 * grow when we're dealing with a 64-bit process.
356 * WARNING - keep in sync with nfsd_args
357 */
91447636
A
358struct user_nfsd_args {
359 int sock; /* Socket to serve */
0c530ab8 360 user_addr_t name __attribute((aligned(8))); /* Client addr for connection based sockets */
91447636
A
361 int namelen; /* Length of name */
362};
363
91447636
A
364#endif // KERNEL
365
91447636
A
366/*
367 * NFS Server File Handle structures
368 */
369
370/* NFS export handle identifies which NFS export */
371#define NFS_FH_VERSION 0x4e580000 /* 'NX00' */
372struct nfs_exphandle {
373 uint32_t nxh_version; /* data structure version */
374 uint32_t nxh_fsid; /* File System Export ID */
375 uint32_t nxh_expid; /* Export ID */
376 uint16_t nxh_flags; /* export handle flags */
377 uint8_t nxh_reserved; /* future use */
378 uint8_t nxh_fidlen; /* length of File ID */
379};
380
381/* nxh_flags */
382#define NXHF_INVALIDFH 0x0001 /* file handle is invalid */
383
384#define NFS_MAX_FID_SIZE (NFS_MAX_FH_SIZE - sizeof(struct nfs_exphandle))
2d21ac55
A
385#define NFSV4_MAX_FID_SIZE (NFSV4_MAX_FH_SIZE - sizeof(struct nfs_exphandle))
386#define NFSV3_MAX_FID_SIZE (NFSV3_MAX_FH_SIZE - sizeof(struct nfs_exphandle))
91447636
A
387#define NFSV2_MAX_FID_SIZE (NFSV2_MAX_FH_SIZE - sizeof(struct nfs_exphandle))
388
389/* NFS server internal view of fhandle_t */
2d21ac55
A
390/* The first sizeof(fhandle_t) bytes must match what goes into fhandle_t. */
391/* (fhp is used to allow use of an external buffer) */
91447636 392struct nfs_filehandle {
2d21ac55 393 uint32_t nfh_len; /* total length of file handle */
91447636
A
394 struct nfs_exphandle nfh_xh; /* export handle */
395 unsigned char nfh_fid[NFS_MAX_FID_SIZE]; /* File ID */
2d21ac55 396 unsigned char *nfh_fhp; /* pointer to file handle */
91447636
A
397};
398
399/*
400 * NFS export data structures
401 */
402
2d21ac55
A
403/* Structure to hold an array of security flavors */
404#define NX_MAX_SEC_FLAVORS 5
405struct nfs_sec {
406 int count;
407 uint32_t flavors[NX_MAX_SEC_FLAVORS];
408};
409
91447636
A
410struct nfs_export_net_args {
411 uint32_t nxna_flags; /* export flags */
412 struct xucred nxna_cred; /* mapped credential for root/all user */
413 struct sockaddr_storage nxna_addr; /* net address to which exported */
414 struct sockaddr_storage nxna_mask; /* mask for net address */
2d21ac55 415 struct nfs_sec nxna_sec; /* security mechanism flavors */
91447636
A
416};
417
418struct nfs_export_args {
419 uint32_t nxa_fsid; /* export FS ID */
420 uint32_t nxa_expid; /* export ID */
421 char *nxa_fspath; /* export FS path */
422 char *nxa_exppath; /* export sub-path */
423 uint32_t nxa_flags; /* export arg flags */
424 uint32_t nxa_netcount; /* #entries in ex_nets array */
425 struct nfs_export_net_args *nxa_nets; /* array of net args */
426};
427
428#ifdef KERNEL
429/* LP64 version of export_args */
430
91447636
A
431struct user_nfs_export_args {
432 uint32_t nxa_fsid; /* export FS ID */
433 uint32_t nxa_expid; /* export ID */
434 user_addr_t nxa_fspath; /* export FS path */
435 user_addr_t nxa_exppath; /* export sub-path */
436 uint32_t nxa_flags; /* export arg flags */
437 uint32_t nxa_netcount; /* #entries in ex_nets array */
438 user_addr_t nxa_nets; /* array of net args */
439};
440
91447636
A
441#endif /* KERNEL */
442
443/* nfs export arg flags */
444#define NXA_DELETE 0x0001 /* delete the specified export(s) */
445#define NXA_ADD 0x0002 /* add the specified export(s) */
446#define NXA_REPLACE 0x0003 /* delete and add the specified export(s) */
3a60a9f5 447#define NXA_DELETE_ALL 0x0004 /* delete all exports */
2d21ac55 448#define NXA_OFFLINE 0x0008 /* export is offline */
91447636
A
449
450/* export option flags */
451#define NX_READONLY 0x0001 /* exported read-only */
452#define NX_DEFAULTEXPORT 0x0002 /* exported to the world */
453#define NX_MAPROOT 0x0004 /* map root access to anon credential */
454#define NX_MAPALL 0x0008 /* map all access to anon credential */
3a60a9f5 455#define NX_32BITCLIENTS 0x0020 /* restrict directory cookies to 32 bits */
2d21ac55
A
456#define NX_OFFLINE 0x0040 /* export is offline */
457
458/*
459 * fs.nfs sysctl(3) export stats record structures
460 */
461#define NFS_EXPORT_STAT_REC_VERSION 1 /* export stat record version */
462#define NFS_USER_STAT_REC_VERSION 1 /* active user list record version */
463
464/* descriptor describing following records */
465struct nfs_export_stat_desc
466{
467 uint32_t rec_vers; /* version of export stat records */
468 uint32_t rec_count; /* total record count */
469}__attribute__((__packed__));
470
471/* export stat record containing path and stat counters */
472struct nfs_export_stat_rec {
473 char path[RPCMNT_PATHLEN + 1];
474 uint64_t ops; /* Count of NFS Requests received for this export */
475 uint64_t bytes_read; /* Count of bytes read from this export */
476 uint64_t bytes_written; /* Count of bytes written to this export */
477}__attribute__((__packed__));
478
479/* Active user list stat buffer descriptor */
480struct nfs_user_stat_desc
481{
482 uint32_t rec_vers; /* version of active user stat records */
483 uint32_t rec_count; /* total record count */
484}__attribute__((__packed__));
485
486/* Active user list user stat record format */
487struct nfs_user_stat_user_rec {
488 u_char rec_type;
489 uid_t uid;
490 struct sockaddr_storage sock;
491 uint64_t ops;
492 uint64_t bytes_read;
493 uint64_t bytes_written;
494 uint32_t tm_start;
495 uint32_t tm_last;
496}__attribute__((__packed__));
497
498/* Active user list path record format */
499struct nfs_user_stat_path_rec {
500 u_char rec_type;
501 char path[RPCMNT_PATHLEN + 1];
502}__attribute__((__packed__));
503
504/* Defines for rec_type field of
505 * nfs_user_stat_rec & nfs_user_stat_rec
506 * data structures
507 */
508#define NFS_USER_STAT_USER_REC 0
509#define NFS_USER_STAT_PATH_REC 1
510
91447636
A
511
512#ifdef KERNEL
513struct nfs_exportfs;
514
515struct nfs_export_options {
516 uint32_t nxo_flags; /* export options */
517 kauth_cred_t nxo_cred; /* mapped credential */
2d21ac55 518 struct nfs_sec nxo_sec; /* security mechanism flavors */
91447636
A
519};
520
521/* Network address lookup element and individual export options */
522struct nfs_netopt {
523 struct radix_node no_rnodes[2]; /* radix tree glue */
524 struct nfs_export_options no_opt; /* export options */
525};
526
2d21ac55
A
527/* statistic counters for each exported directory
528 *
529 * Since 64-bit atomic operations are not available on 32-bit platforms,
530 * 64-bit counters are implemented using 32-bit integers and 32-bit
531 * atomic operations
532 */
533typedef struct nfsstatcount64 {
534 uint32_t hi;
535 uint32_t lo;
536} nfsstatcount64;
537
538struct nfs_export_stat_counters {
539 struct nfsstatcount64 ops; /* Count of NFS Requests received for this export */
540 struct nfsstatcount64 bytes_read; /* Count of bytes read from this export */
541 struct nfsstatcount64 bytes_written; /* Count of bytes written to his export */
542}__attribute__((__packed__));
543
544/* Macro for updating nfs export stat counters */
545#define NFSStatAdd64(PTR, VAL) \
546 do { \
547 uint32_t NFSSA_OldValue = \
548 OSAddAtomic((VAL), (SInt32*)&(PTR)->lo); \
549 if ((NFSSA_OldValue + (VAL)) < NFSSA_OldValue) \
550 OSAddAtomic(1, (SInt32*)&(PTR)->hi); \
551 } while (0)
552
553/* Some defines for dealing with active user list stats */
554#define NFSRV_USER_STAT_DEF_MAX_NODES 1024 /* default active user list size limit */
555#define NFSRV_USER_STAT_DEF_IDLE_SEC 7200 /* default idle seconds (node no longer considered active) */
556
557/* active user list globals */
558__private_extern__ uint32_t nfsrv_user_stat_enabled; /* enable/disable active user list */
559__private_extern__ uint32_t nfsrv_user_stat_node_count; /* current count of user stat nodes */
560__private_extern__ uint32_t nfsrv_user_stat_max_idle_sec; /* idle seconds (node no longer considered active) */
561__private_extern__ uint32_t nfsrv_user_stat_max_nodes; /* active user list size limit */
562__private_extern__ lck_grp_t *nfsrv_active_user_mutex_group;
563
564/* An active user node represented in the kernel */
565struct nfs_user_stat_node {
566 TAILQ_ENTRY(nfs_user_stat_node) lru_link;
567 LIST_ENTRY(nfs_user_stat_node) hash_link;
568 uid_t uid;
569 struct sockaddr_storage sock;
570 uint64_t ops;
571 uint64_t bytes_read;
572 uint64_t bytes_written;
573 uint32_t tm_start;
574 uint32_t tm_last;
575};
576
577/* Hash table for active user nodes */
578#define NFS_USER_STAT_HASH_SIZE 16 /* MUST be a power of 2 */
579#define NFS_USER_STAT_HASH(userhashtbl, uid) \
580 &((userhashtbl)[(uid) & (NFS_USER_STAT_HASH_SIZE - 1)])
581
582TAILQ_HEAD(nfs_user_stat_lru_head, nfs_user_stat_node);
583LIST_HEAD(nfs_user_stat_hashtbl_head, nfs_user_stat_node);
584
585/* Active user list data structure */
586/* One per exported directory */
587struct nfs_active_user_list {
588 struct nfs_user_stat_lru_head user_lru;
589 struct nfs_user_stat_hashtbl_head user_hashtbl[NFS_USER_STAT_HASH_SIZE];
590 uint32_t node_count;
591 lck_mtx_t user_mutex;
592};
593
594
91447636
A
595/* Network export information */
596/* one of these for each exported directory */
597struct nfs_export {
598 LIST_ENTRY(nfs_export) nx_next; /* FS export list */
599 LIST_ENTRY(nfs_export) nx_hash; /* export hash chain */
600 struct nfs_export *nx_parent; /* parent export */
601 uint32_t nx_id; /* export ID */
602 uint32_t nx_flags; /* export flags */
603 struct nfs_exportfs *nx_fs; /* exported file system */
604 char *nx_path; /* exported file system sub-path */
605 struct nfs_filehandle nx_fh; /* export root file handle */
606 struct nfs_export_options nx_defopt; /* default options */
607 uint32_t nx_expcnt; /* # exports in table */
608 struct radix_node_head *nx_rtable[AF_MAX+1]; /* table of exports (netopts) */
2d21ac55
A
609 struct nfs_export_stat_counters nx_stats; /* statistic counters for this exported directory */
610 struct nfs_active_user_list nx_user_list; /* Active User List for this exported directory */
611 struct timeval nx_exptime; /* time of export for write verifier */
91447636
A
612};
613
614/* NFS exported file system info */
615/* one of these for each exported file system */
616struct nfs_exportfs {
617 LIST_ENTRY(nfs_exportfs) nxfs_next; /* exported file system list */
618 uint32_t nxfs_id; /* exported file system ID */
619 char *nxfs_path; /* exported file system path */
620 LIST_HEAD(,nfs_export) nxfs_exports; /* list of exports for this file system */
621};
622
2d21ac55
A
623__private_extern__ LIST_HEAD(nfsrv_expfs_list, nfs_exportfs) nfsrv_exports;
624__private_extern__ lck_rw_t nfsrv_export_rwlock; // lock for export data structures
625#define NFSRVEXPHASHVAL(FSID, EXPID) \
91447636 626 (((FSID) >> 24) ^ ((FSID) >> 16) ^ ((FSID) >> 8) ^ (EXPID))
2d21ac55
A
627#define NFSRVEXPHASH(FSID, EXPID) \
628 (&nfsrv_export_hashtbl[NFSRVEXPHASHVAL((FSID),(EXPID)) & nfsrv_export_hash])
629__private_extern__ LIST_HEAD(nfsrv_export_hashhead, nfs_export) *nfsrv_export_hashtbl;
630__private_extern__ u_long nfsrv_export_hash;
631
632/*
633 * NFS server file mod fsevents
634 */
635struct nfsrv_fmod {
636 LIST_ENTRY(nfsrv_fmod) fm_link;
637 vnode_t fm_vp;
638 struct vfs_context fm_context;
639 uint64_t fm_deadline;
640};
641
642#define NFSRVFMODHASHSZ 128
643#define NFSRVFMODHASH(vp) (((u_long) vp) & nfsrv_fmod_hash)
644__private_extern__ LIST_HEAD(nfsrv_fmod_hashhead, nfsrv_fmod) *nfsrv_fmod_hashtbl;
645__private_extern__ u_long nfsrv_fmod_hash;
646__private_extern__ lck_mtx_t *nfsrv_fmod_mutex;
647__private_extern__ int nfsrv_fmod_pending, nfsrv_fsevents_enabled;
648__private_extern__ int nfsrv_async, nfsrv_reqcache_size, nfsrv_sock_max_rec_queue_length;
649
650__private_extern__ struct nfsstats nfsstats;
91447636
A
651
652#endif // KERNEL
653
1c79356b
A
654/*
655 * XXX to allow amd to include nfs.h without nfsproto.h
656 */
657#ifdef NFS_NPROCS
658/*
659 * Stats structure
660 */
661struct nfsstats {
662 int attrcache_hits;
663 int attrcache_misses;
664 int lookupcache_hits;
665 int lookupcache_misses;
666 int direofcache_hits;
667 int direofcache_misses;
668 int biocache_reads;
669 int read_bios;
670 int read_physios;
671 int biocache_writes;
672 int write_bios;
673 int write_physios;
674 int biocache_readlinks;
675 int readlink_bios;
676 int biocache_readdirs;
677 int readdir_bios;
678 int rpccnt[NFS_NPROCS];
679 int rpcretries;
680 int srvrpccnt[NFS_NPROCS];
681 int srvrpc_errs;
682 int srv_errs;
683 int rpcrequests;
684 int rpctimeouts;
685 int rpcunexpected;
686 int rpcinvalid;
687 int srvcache_inproghits;
688 int srvcache_idemdonehits;
689 int srvcache_nonidemdonehits;
690 int srvcache_misses;
1c79356b
A
691 int srvvop_writes;
692 int pageins;
693 int pageouts;
694};
695#endif
696
697/*
698 * Flags for nfssvc() system call.
699 */
1c79356b
A
700#define NFSSVC_NFSD 0x004
701#define NFSSVC_ADDSOCK 0x008
91447636 702#define NFSSVC_EXPORT 0x200
1c79356b 703
55e303ae
A
704/*
705 * Flags for nfsclnt() system call.
706 */
707#define NFSCLNT_LOCKDANS 0x200
55e303ae 708
1c79356b
A
709/*
710 * fs.nfs sysctl(3) identifiers
711 */
2d21ac55
A
712#define NFS_NFSSTATS 1 /* struct: struct nfsstats */
713#define NFS_EXPORTSTATS 3 /* gets exported directory stats */
714#define NFS_USERSTATS 4 /* gets exported directory active user stats */
715#define NFS_USERCOUNT 5 /* gets current count of active nfs users */
1c79356b 716
1c79356b
A
717#ifndef NFS_WDELAYHASHSIZ
718#define NFS_WDELAYHASHSIZ 16 /* and with this */
719#endif
720
1c79356b 721#ifdef KERNEL
91447636 722#include <sys/kernel_types.h>
2d21ac55
A
723#include <kern/thread_call.h>
724#include <sys/kdebug.h>
725
726#define NFS_KERNEL_DEBUG KERNEL_DEBUG
727
728/* kernel debug trace macros */
729#define FSDBG(A, B, C, D, E) \
730 NFS_KERNEL_DEBUG((FSDBG_CODE(DBG_FSRW, (A))) | DBG_FUNC_NONE, \
731 (int)(B), (int)(C), (int)(D), (int)(E), 0)
732#define FSDBG_TOP(A, B, C, D, E) \
733 NFS_KERNEL_DEBUG((FSDBG_CODE(DBG_FSRW, (A))) | DBG_FUNC_START, \
734 (int)(B), (int)(C), (int)(D), (int)(E), 0)
735#define FSDBG_BOT(A, B, C, D, E) \
736 NFS_KERNEL_DEBUG((FSDBG_CODE(DBG_FSRW, (A))) | DBG_FUNC_END, \
737 (int)(B), (int)(C), (int)(D), (int)(E), 0)
1c79356b
A
738
739#ifdef MALLOC_DECLARE
740MALLOC_DECLARE(M_NFSREQ);
741MALLOC_DECLARE(M_NFSMNT);
742MALLOC_DECLARE(M_NFSDIROFF);
743MALLOC_DECLARE(M_NFSRVDESC);
1c79356b
A
744MALLOC_DECLARE(M_NFSD);
745MALLOC_DECLARE(M_NFSBIGFH);
746#endif
747
2d21ac55 748struct uio; struct vnode_attr; struct nameidata; struct dqblk; /* XXX */
55e303ae 749struct nfsbuf;
91447636 750struct nfs_vattr;
2d21ac55 751struct nfs_fsattr;
91447636 752struct nfsnode;
2d21ac55
A
753typedef struct nfsnode * nfsnode_t;
754struct nfsreq;
1c79356b 755
2d21ac55
A
756/*
757 * The set of signals the interrupt an I/O in progress for NFSMNT_INT mounts.
758 * What should be in this set is open to debate, but I believe that since
759 * I/O system calls on ufs are never interrupted by signals the set should
760 * be minimal. My reasoning is that many current programs that use signals
761 * such as SIGALRM will not expect file I/O system calls to be interrupted
762 * by them and break.
763 */
1c79356b
A
764#define NFSINT_SIGMASK (sigmask(SIGINT)|sigmask(SIGTERM)|sigmask(SIGKILL)| \
765 sigmask(SIGHUP)|sigmask(SIGQUIT))
766
2d21ac55
A
767__private_extern__ size_t nfs_mbuf_mhlen, nfs_mbuf_minclsize;
768
769/*
770 * NFS mbuf chain structure used for managing the building/dissection of RPCs
771 */
772struct nfsm_chain {
773 mbuf_t nmc_mhead; /* mbuf chain head */
774 mbuf_t nmc_mcur; /* current mbuf */
775 caddr_t nmc_ptr; /* pointer into current mbuf */
776 uint32_t nmc_left; /* bytes remaining in current mbuf */
777 uint32_t nmc_flags; /* flags for this nfsm_chain */
778};
779#define NFSM_CHAIN_FLAG_ADD_CLUSTERS 0x1 /* always add mbuf clusters */
91447636 780
1c79356b 781/*
2d21ac55
A
782 * Each retransmission of an RPCSEC_GSS request
783 * has an additional sequence number.
1c79356b 784 */
2d21ac55
A
785struct gss_seq {
786 SLIST_ENTRY(gss_seq) gss_seqnext;
787 uint32_t gss_seqnum;
788};
1c79356b
A
789
790/*
2d21ac55
A
791 * async NFS request callback info
792 */
793struct nfsreq_cbinfo {
794 void (*rcb_func)(struct nfsreq *); /* async request callback function */
795 struct nfsbuf *rcb_bp; /* buffer I/O RPC is for */
796 uint32_t rcb_args[2]; /* additional callback args */
797};
798
799/*
800 * NFS outstanding request list element
1c79356b
A
801 */
802struct nfsreq {
2d21ac55
A
803 lck_mtx_t r_mtx; /* NFS request mutex */
804 TAILQ_ENTRY(nfsreq) r_chain; /* request queue chain */
805 TAILQ_ENTRY(nfsreq) r_achain; /* mount's async I/O request queue chain */
806 TAILQ_ENTRY(nfsreq) r_rchain; /* mount's async I/O resend queue chain */
807 TAILQ_ENTRY(nfsreq) r_cchain; /* mount's cwnd queue chain */
808 mbuf_t r_mrest; /* request body mbufs */
809 mbuf_t r_mhead; /* request header mbufs */
810 struct nfsm_chain r_nmrep; /* reply mbufs */
811 nfsnode_t r_np; /* NFS node */
812 struct nfsmount *r_nmp; /* NFS mount point */
813 uint64_t r_xid; /* RPC transaction ID */
814 uint32_t r_procnum; /* NFS procedure number */
815 u_long r_mreqlen; /* request length */
816 int r_flags; /* flags on request, see below */
817 int r_lflags; /* flags protected by list mutex, see below */
818 int r_refs; /* # outstanding references */
819 uint8_t r_delay; /* delay to use for jukebox error */
820 uint8_t r_retry; /* max retransmission count */
821 uint8_t r_rexmit; /* current retrans count */
822 int r_rtt; /* RTT for rpc */
823 thread_t r_thread; /* thread that did I/O system call */
824 kauth_cred_t r_cred; /* credential used for request */
825 long r_start; /* request start time */
826 long r_lastmsg; /* time of last tprintf */
827 long r_resendtime; /* time of next jukebox error resend */
828 struct nfs_gss_clnt_ctx *r_gss_ctx; /* RPCSEC_GSS context */
829 SLIST_HEAD(, gss_seq) r_gss_seqlist; /* RPCSEC_GSS sequence numbers */
830 uint32_t r_gss_argoff; /* RPCSEC_GSS offset to args */
831 uint32_t r_gss_arglen; /* RPCSEC_GSS arg length */
832 int r_error; /* request error */
833 struct nfsreq_cbinfo r_callback; /* callback info */
1c79356b
A
834};
835
836/*
837 * Queue head for nfsreq's
838 */
2d21ac55
A
839TAILQ_HEAD(nfs_reqqhead, nfsreq);
840__private_extern__ struct nfs_reqqhead nfs_reqq;
841__private_extern__ lck_grp_t *nfs_request_grp;
842
843#define R_XID32(x) ((x) & 0xffffffff)
844
845#define NFSREQNOLIST ((struct nfsreq *)0xdeadbeef) /* sentinel value for nfsreq lists */
1c79356b
A
846
847/* Flag values for r_flags */
55e303ae 848#define R_TIMING 0x0001 /* timing request (in mntp) */
2d21ac55
A
849#define R_CWND 0x0002 /* request accounted for in congestion window */
850#define R_SOFTTERM 0x0004 /* request terminated (e.g. soft mnt) */
851#define R_RESTART 0x0008 /* RPC should be restarted. */
852#define R_INITTED 0x0010 /* request has been initialized */
55e303ae
A
853#define R_TPRINTFMSG 0x0020 /* Did a tprintf msg. */
854#define R_MUSTRESEND 0x0040 /* Must resend request */
2d21ac55
A
855#define R_ALLOCATED 0x0080 /* request was allocated */
856#define R_SENT 0x0100 /* request has been sent */
857#define R_WAITSENT 0x0200 /* someone is waiting for request to be sent */
858#define R_RESENDERR 0x0400 /* resend failed */
859#define R_JBTPRINTFMSG 0x0800 /* Did a tprintf msg for jukebox error */
860#define R_ASYNC 0x1000 /* async request */
861#define R_ASYNCWAIT 0x2000 /* async request now being waited on */
862#define R_RESENDQ 0x4000 /* async request currently on resendq */
863
864#define R_SETUP 0x8000 /* a setup RPC - during (re)connection */
865#define R_OPTMASK 0x8000 /* mask of all RPC option flags */
866
867/* Flag values for r_lflags */
868#define RL_BUSY 0x0001 /* Locked. */
869#define RL_WAITING 0x0002 /* Someone waiting for lock. */
870#define RL_QUEUED 0x0004 /* request is on the queue */
871
872__private_extern__ u_long nfs_xid, nfs_xidwrap;
873__private_extern__ int nfs_iosize, nfs_access_cache_timeout, nfs_allow_async, nfs_statfs_rate_limit;
874__private_extern__ int nfs_lockd_mounts, nfs_lockd_request_sent;
875__private_extern__ int nfs_tprintf_initial_delay, nfs_tprintf_delay;
876__private_extern__ int nfsiod_thread_count, nfsiod_thread_max, nfs_max_async_writes;
877
878#define NFSIOD_MAX (MIN(nfsiod_thread_max, NFS_MAXASYNCTHREAD))
879
880struct nfs_dulookup {
881 int du_flags; /* state of ._ lookup */
882#define NFS_DULOOKUP_DOIT 0x1
883#define NFS_DULOOKUP_INPROG 0x2
884 struct componentname du_cn; /* ._ name being looked up */
885 struct nfsreq du_req; /* NFS request for lookup */
886 char du_smallname[48]; /* buffer for small names */
887};
1c79356b
A
888
889/*
890 * Network address hash list element
891 */
892union nethostaddr {
893 u_long had_inetaddr;
91447636 894 mbuf_t had_nam;
1c79356b
A
895};
896
2d21ac55
A
897/*
898 * One nfsrv_sock structure is maintained for each socket the
899 * server is servicing requests on.
900 */
901struct nfsrv_sock {
902 TAILQ_ENTRY(nfsrv_sock) ns_chain; /* List of all nfsrv_sock's */
903 TAILQ_ENTRY(nfsrv_sock) ns_svcq; /* List of sockets needing servicing */
904 TAILQ_ENTRY(nfsrv_sock) ns_wgq; /* List of sockets with a pending write gather */
91447636
A
905 lck_rw_t ns_rwlock; /* lock for most fields */
906 socket_t ns_so;
907 mbuf_t ns_nam;
908 mbuf_t ns_raw;
909 mbuf_t ns_rawend;
910 mbuf_t ns_rec;
911 mbuf_t ns_recend;
912 mbuf_t ns_frag;
913 int ns_flag;
914 int ns_sotype;
1c79356b
A
915 int ns_cc;
916 int ns_reclen;
2d21ac55 917 int ns_reccnt;
1c79356b 918 u_long ns_sref;
743b1565 919 time_t ns_timestamp; /* socket timestamp */
91447636
A
920 lck_mtx_t ns_wgmutex; /* mutex for write gather fields */
921 u_quad_t ns_wgtime; /* next Write deadline (usec) */
1c79356b 922 LIST_HEAD(, nfsrv_descript) ns_tq; /* Write gather lists */
2d21ac55 923 LIST_HEAD(nfsrv_wg_delayhash, nfsrv_descript) ns_wdelayhashtbl[NFS_WDELAYHASHSIZ];
1c79356b
A
924};
925
91447636 926/* Bits for "ns_flag" */
2d21ac55
A
927#define SLP_VALID 0x0001 /* nfs sock valid */
928#define SLP_DOREC 0x0002 /* nfs sock has received data to process */
929#define SLP_NEEDQ 0x0004 /* network socket has data to receive */
930#define SLP_DISCONN 0x0008 /* socket needs to be zapped */
931#define SLP_GETSTREAM 0x0010 /* currently in nfsrv_getstream() */
932#define SLP_LASTFRAG 0x0020 /* on last fragment of RPC record */
933#define SLP_DOWRITES 0x0040 /* nfs sock has gathered writes to service */
934#define SLP_WORKTODO 0x004e /* mask of all "work to do" flags */
935#define SLP_ALLFLAGS 0x007f
936#define SLP_WAITQ 0x4000 /* nfs sock is on the wait queue */
937#define SLP_WORKQ 0x8000 /* nfs sock is on the work queue */
938#define SLP_QUEUED 0xc000 /* nfs sock is on a queue */
939
940#define SLPNOLIST ((struct nfsrv_sock *)0xdeadbeef) /* sentinel value for sockets not in the nfsrv_sockwg list */
941
942__private_extern__ struct nfsrv_sock *nfsrv_udpsock;
943
944/*
945 * global NFS server socket lists:
946 *
947 * nfsrv_socklist - list of all sockets (ns_chain)
948 * nfsrv_sockwait - sockets w/new data waiting to be worked on (ns_svcq)
949 * nfsrv_sockwork - sockets being worked on which may have more work to do (ns_svcq)
950 * nfsrv_sockwg - sockets with pending write gather input (ns_wgq)
951 */
952__private_extern__ TAILQ_HEAD(nfsrv_sockhead, nfsrv_sock) nfsrv_socklist, nfsrv_deadsocklist,
953 nfsrv_sockwg, nfsrv_sockwait, nfsrv_sockwork;
954
955/* lock groups for nfsrv_sock's */
956__private_extern__ lck_grp_t *nfsrv_slp_rwlock_group;
957__private_extern__ lck_grp_t *nfsrv_slp_mutex_group;
1c79356b
A
958
959/*
960 * One of these structures is allocated for each nfsd.
961 */
962struct nfsd {
2d21ac55
A
963 TAILQ_ENTRY(nfsd) nfsd_chain; /* List of all nfsd's */
964 TAILQ_ENTRY(nfsd) nfsd_queue; /* List of waiting nfsd's */
965 int nfsd_flag; /* NFSD_ flags */
966 struct nfsrv_sock *nfsd_slp; /* Current socket */
967 struct nfsrv_descript *nfsd_nd; /* Associated nfsrv_descript */
1c79356b
A
968};
969
970/* Bits for "nfsd_flag" */
971#define NFSD_WAITING 0x01
972#define NFSD_REQINPROG 0x02
1c79356b
A
973
974/*
975 * This structure is used by the server for describing each request.
976 * Some fields are used only when write request gathering is performed.
977 */
978struct nfsrv_descript {
979 u_quad_t nd_time; /* Write deadline (usec) */
980 off_t nd_off; /* Start byte offset */
981 off_t nd_eoff; /* and end byte offset */
982 LIST_ENTRY(nfsrv_descript) nd_hash; /* Hash list */
2d21ac55 983 LIST_ENTRY(nfsrv_descript) nd_tq; /* and timer list */
1c79356b 984 LIST_HEAD(,nfsrv_descript) nd_coalesce; /* coalesced writes */
2d21ac55
A
985 struct nfsm_chain nd_nmreq; /* Request mbuf chain */
986 mbuf_t nd_mrep; /* Reply mbuf list (WG) */
91447636
A
987 mbuf_t nd_nam; /* and socket addr */
988 mbuf_t nd_nam2; /* return socket addr */
1c79356b
A
989 u_int32_t nd_procnum; /* RPC # */
990 int nd_stable; /* storage type */
2d21ac55 991 int nd_vers; /* NFS version */
1c79356b
A
992 int nd_len; /* Length of this write */
993 int nd_repstat; /* Reply status */
994 u_long nd_retxid; /* Reply xid */
1c79356b 995 struct timeval nd_starttime; /* Time RPC initiated */
91447636 996 struct nfs_filehandle nd_fh; /* File handle */
2d21ac55
A
997 uint32_t nd_sec; /* Security flavor */
998 struct nfs_gss_svc_ctx *nd_gss_context;/* RPCSEC_GSS context */
999 uint32_t nd_gss_seqnum; /* RPCSEC_GSS seq num */
1000 mbuf_t nd_gss_mb; /* RPCSEC_GSS results mbuf */
91447636 1001 kauth_cred_t nd_cr; /* Credentials */
1c79356b
A
1002};
1003
2d21ac55 1004__private_extern__ TAILQ_HEAD(nfsd_head, nfsd) nfsd_head, nfsd_queue;
1c79356b 1005
2d21ac55
A
1006/* mutex for nfs server */
1007__private_extern__ lck_mtx_t *nfsd_mutex;
1008__private_extern__ int nfsd_thread_count, nfsd_thread_max;
1c79356b 1009
2d21ac55
A
1010/* request list mutex */
1011__private_extern__ lck_mtx_t *nfs_request_mutex;
1012__private_extern__ int nfs_request_timer_on;
1c79356b 1013
2d21ac55
A
1014/* nfs timer call structures */
1015__private_extern__ thread_call_t nfs_request_timer_call;
1016__private_extern__ thread_call_t nfs_buf_timer_call;
1017__private_extern__ thread_call_t nfsrv_deadsock_timer_call;
1018__private_extern__ thread_call_t nfsrv_fmod_timer_call;
91447636 1019
2d21ac55 1020__BEGIN_DECLS
91447636 1021
2d21ac55
A
1022nfstype vtonfs_type(enum vtype, int);
1023enum vtype nfstov_type(nfstype, int);
1024int vtonfsv2_mode(enum vtype, mode_t);
1c79356b 1025
2d21ac55 1026void nfs_mbuf_init(void);
1c79356b 1027
2d21ac55
A
1028void nfs_nhinit(void);
1029void nfs_nhinit_finish(void);
1030u_long nfs_hash(u_char *, int);
1c79356b 1031
2d21ac55
A
1032int nfs4_setclientid(struct nfsmount *);
1033void nfs4_renew_timer(void *, void *);
1034int nfs_connect(struct nfsmount *);
1035void nfs_disconnect(struct nfsmount *);
1036void nfs_mount_sock_thread_wake(struct nfsmount *);
1c79356b 1037
2d21ac55
A
1038int nfs_getattr(nfsnode_t, struct nfs_vattr *, vfs_context_t, int);
1039int nfs_getattrcache(nfsnode_t, struct nfs_vattr *, int);
1040int nfs_loadattrcache(nfsnode_t, struct nfs_vattr *, u_int64_t *, int);
1041int nfs_attrcachetimeout(nfsnode_t);
91447636 1042
2d21ac55
A
1043int nfs_buf_page_inval(vnode_t vp, off_t offset);
1044int nfs_vinvalbuf(vnode_t, int, vfs_context_t, int);
1045int nfs_vinvalbuf2(vnode_t, int, thread_t, kauth_cred_t, int);
1046
1047int nfs_request_create(nfsnode_t, mount_t, struct nfsm_chain *, int, thread_t, kauth_cred_t, struct nfsreq **);
1048void nfs_request_destroy(struct nfsreq *);
1049void nfs_request_ref(struct nfsreq *, int);
1050void nfs_request_rele(struct nfsreq *);
1051int nfs_request_add_header(struct nfsreq *);
1052int nfs_request_send(struct nfsreq *, int);
1053void nfs_request_wait(struct nfsreq *);
1054int nfs_request_finish(struct nfsreq *, struct nfsm_chain *, int *);
1055int nfs_request(nfsnode_t, mount_t, struct nfsm_chain *, int, vfs_context_t, struct nfsm_chain *, u_int64_t *, int *);
1056int nfs_request2(nfsnode_t, mount_t, struct nfsm_chain *, int, thread_t, kauth_cred_t, int, struct nfsm_chain *, u_int64_t *, int *);
1057int nfs_request_async(nfsnode_t, mount_t, struct nfsm_chain *, int, thread_t, kauth_cred_t, struct nfsreq_cbinfo *cb, struct nfsreq **);
1058int nfs_request_async_finish(struct nfsreq *, struct nfsm_chain *, u_int64_t *, int *);
1059void nfs_request_async_cancel(struct nfsreq *);
1060void nfs_request_timer(void *, void *);
1061int nfs_sigintr(struct nfsmount *, struct nfsreq *, thread_t, int);
1062int nfs_noremotehang(thread_t);
1063
1064int nfs_send(struct nfsreq *, int);
91447636
A
1065int nfs_sndlock(struct nfsreq *);
1066void nfs_sndunlock(struct nfsreq *);
2d21ac55
A
1067
1068int nfs_lookitup(nfsnode_t, char *, int, vfs_context_t, nfsnode_t *);
1069void nfs_dulookup_init(struct nfs_dulookup *, nfsnode_t, const char *, int);
1070void nfs_dulookup_start(struct nfs_dulookup *, nfsnode_t, vfs_context_t);
1071void nfs_dulookup_finish(struct nfs_dulookup *, nfsnode_t, vfs_context_t);
1072
1073int nfs_parsefattr(struct nfsm_chain *, int, struct nfs_vattr *);
1074int nfs4_parsefattr(struct nfsm_chain *, struct nfs_fsattr *, struct nfs_vattr *, fhandle_t *, struct dqblk *);
1075void nfs_vattr_set_supported(uint32_t *, struct vnode_attr *);
1076void nfs3_pathconf_cache(struct nfsmount *, struct nfs_fsattr *);
1077int nfs_node_mode_slot(nfsnode_t, uid_t, int);
1078
1079int nfs_vnop_access(struct vnop_access_args *);
1080
1081int nfs3_vnop_open(struct vnop_open_args *);
1082int nfs3_vnop_close(struct vnop_close_args *);
1083
1084int nfs4_vnop_create(struct vnop_create_args *);
1085int nfs4_vnop_mknod(struct vnop_mknod_args *);
1086int nfs4_vnop_open(struct vnop_open_args *);
1087int nfs4_vnop_close(struct vnop_close_args *);
1088int nfs4_vnop_getattr(struct vnop_getattr_args *);
1089int nfs4_vnop_link(struct vnop_link_args *);
1090int nfs4_vnop_mkdir(struct vnop_mkdir_args *);
1091int nfs4_vnop_rmdir(struct vnop_rmdir_args *);
1092int nfs4_vnop_symlink(struct vnop_symlink_args *);
1093int nfs4_vnop_advlock(struct vnop_advlock_args *ap);
1094
1095int nfs_read_rpc(nfsnode_t, struct uio *, vfs_context_t);
1096int nfs_write_rpc(nfsnode_t, struct uio *, vfs_context_t, int *, uint64_t *);
1097int nfs_write_rpc2(nfsnode_t, struct uio *, thread_t, kauth_cred_t, int *, uint64_t *);
1098
1099int nfs3_access_rpc(nfsnode_t, u_long *, vfs_context_t);
1100int nfs4_access_rpc(nfsnode_t, u_long *, vfs_context_t);
1101int nfs3_getattr_rpc(nfsnode_t, mount_t, u_char *, size_t, vfs_context_t, struct nfs_vattr *, u_int64_t *);
1102int nfs4_getattr_rpc(nfsnode_t, mount_t, u_char *, size_t, vfs_context_t, struct nfs_vattr *, u_int64_t *);
1103int nfs3_setattr_rpc(nfsnode_t, struct vnode_attr *, vfs_context_t, int);
1104int nfs4_setattr_rpc(nfsnode_t, struct vnode_attr *, vfs_context_t, int);
1105int nfs3_read_rpc_async(nfsnode_t, off_t, size_t, thread_t, kauth_cred_t, struct nfsreq_cbinfo *, struct nfsreq **);
1106int nfs4_read_rpc_async(nfsnode_t, off_t, size_t, thread_t, kauth_cred_t, struct nfsreq_cbinfo *, struct nfsreq **);
1107int nfs3_read_rpc_async_finish(nfsnode_t, struct nfsreq *, struct uio *, size_t *, int *);
1108int nfs4_read_rpc_async_finish(nfsnode_t, struct nfsreq *, struct uio *, size_t *, int *);
1109int nfs3_write_rpc_async(nfsnode_t, struct uio *, size_t, thread_t, kauth_cred_t, int, struct nfsreq_cbinfo *, struct nfsreq **);
1110int nfs4_write_rpc_async(nfsnode_t, struct uio *, size_t, thread_t, kauth_cred_t, int, struct nfsreq_cbinfo *, struct nfsreq **);
1111int nfs3_write_rpc_async_finish(nfsnode_t, struct nfsreq *, int *, size_t *, uint64_t *);
1112int nfs4_write_rpc_async_finish(nfsnode_t, struct nfsreq *, int *, size_t *, uint64_t *);
1113int nfs3_readdir_rpc(nfsnode_t, struct uio *, vfs_context_t);
1114int nfs3_readdirplus_rpc(nfsnode_t, struct uio *, vfs_context_t);
1115int nfs4_readdir_rpc(nfsnode_t, struct uio *, vfs_context_t);
1116int nfs3_readlink_rpc(nfsnode_t, char *, uint32_t *, vfs_context_t);
1117int nfs4_readlink_rpc(nfsnode_t, char *, uint32_t *, vfs_context_t);
1118int nfs3_commit_rpc(nfsnode_t, u_int64_t, u_int64_t, kauth_cred_t);
1119int nfs4_commit_rpc(nfsnode_t, u_int64_t, u_int64_t, kauth_cred_t);
1120int nfs3_lookup_rpc_async(nfsnode_t, char *, int, vfs_context_t, struct nfsreq **);
1121int nfs4_lookup_rpc_async(nfsnode_t, char *, int, vfs_context_t, struct nfsreq **);
1122int nfs3_lookup_rpc_async_finish(nfsnode_t, vfs_context_t, struct nfsreq *, u_int64_t *, fhandle_t *, struct nfs_vattr *);
1123int nfs4_lookup_rpc_async_finish(nfsnode_t, vfs_context_t, struct nfsreq *, u_int64_t *, fhandle_t *, struct nfs_vattr *);
1124int nfs3_remove_rpc(nfsnode_t, char *, int, thread_t, kauth_cred_t);
1125int nfs4_remove_rpc(nfsnode_t, char *, int, thread_t, kauth_cred_t);
1126int nfs3_rename_rpc(nfsnode_t, char *, int, nfsnode_t, char *, int, vfs_context_t);
1127int nfs4_rename_rpc(nfsnode_t, char *, int, nfsnode_t, char *, int, vfs_context_t);
1128int nfs3_pathconf_rpc(nfsnode_t, struct nfs_fsattr *, vfs_context_t);
1129int nfs4_pathconf_rpc(nfsnode_t, struct nfs_fsattr *, vfs_context_t);
1130
1131void nfsrv_active_user_list_reclaim(void);
91447636 1132void nfsrv_cleancache(void);
2d21ac55
A
1133void nfsrv_cleanup(void);
1134int nfsrv_credcheck(struct nfsrv_descript *, vfs_context_t, struct nfs_export *,
91447636 1135 struct nfs_export_options *);
2d21ac55
A
1136void nfsrv_deadsock_timer(void *, void *);
1137int nfsrv_dorec(struct nfsrv_sock *, struct nfsd *, struct nfsrv_descript **);
1138int nfsrv_errmap(struct nfsrv_descript *, int);
1139int nfsrv_export(struct user_nfs_export_args *, vfs_context_t);
1140int nfsrv_fhmatch(struct nfs_filehandle *, struct nfs_filehandle *);
1141int nfsrv_fhtovp(struct nfs_filehandle *, struct nfsrv_descript *, vnode_t *,
91447636 1142 struct nfs_export **, struct nfs_export_options **);
2d21ac55
A
1143void nfsrv_fmod_timer(void *, void *);
1144int nfsrv_getcache(struct nfsrv_descript *, struct nfsrv_sock *, mbuf_t *);
1145void nfsrv_group_sort(gid_t *, int);
1146void nfsrv_init(void);
1147void nfsrv_initcache(void);
1148int nfsrv_is_initialized(void);
1149int nfsrv_namei(struct nfsrv_descript *, vfs_context_t, struct nameidata *,
1150 struct nfs_filehandle *, vnode_t *,
1151 struct nfs_export **, struct nfs_export_options **);
1152void nfsrv_rcv(socket_t, caddr_t, int);
1153void nfsrv_rcv_locked(socket_t, struct nfsrv_sock *, int);
1154int nfsrv_rephead(struct nfsrv_descript *, struct nfsrv_sock *, struct nfsm_chain *, size_t);
1155int nfsrv_send(struct nfsrv_sock *, mbuf_t, mbuf_t);
1156void nfsrv_updatecache(struct nfsrv_descript *, int, mbuf_t);
1157void nfsrv_update_user_stat(struct nfs_export *, struct nfsrv_descript *, uid_t, u_int, u_int, u_int);
1158int nfsrv_vptofh(struct nfs_export *, int, struct nfs_filehandle *,
1159 vnode_t, vfs_context_t, struct nfs_filehandle *);
1160void nfsrv_wakenfsd(struct nfsrv_sock *);
1161void nfsrv_wg_timer(void *, void *);
1162int nfsrv_writegather(struct nfsrv_descript **, struct nfsrv_sock *,
1163 vfs_context_t, mbuf_t *);
1164
1165int nfsrv_access(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *);
1166int nfsrv_commit(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *);
1167int nfsrv_create(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *);
1168int nfsrv_fsinfo(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *);
1169int nfsrv_getattr(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *);
1170int nfsrv_link(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *);
1171int nfsrv_lookup(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *);
1172int nfsrv_mkdir(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *);
1173int nfsrv_mknod(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *);
1174int nfsrv_noop(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *);
1175int nfsrv_null(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *);
1176int nfsrv_pathconf(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *);
1177int nfsrv_read(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *);
1178int nfsrv_readdir(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *);
1179int nfsrv_readdirplus(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *);
1180int nfsrv_readlink(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *);
1181int nfsrv_remove(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *);
1182int nfsrv_rename(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *);
1183int nfsrv_rmdir(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *);
1184int nfsrv_setattr(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *);
1185int nfsrv_statfs(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *);
1186int nfsrv_symlink(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *);
1187int nfsrv_write(struct nfsrv_descript *, struct nfsrv_sock *, vfs_context_t, mbuf_t *);
1188
1189void nfs_interval_timer_start(thread_call_t, int);
1190void nfs_up(struct nfsmount *, thread_t, int, const char *);
1191void nfs_down(struct nfsmount *, thread_t, int, int, const char *);
1192
1193int nfs_mountroot(void);
91447636 1194struct nfs_diskless;
2d21ac55
A
1195int nfs_boot_init(struct nfs_diskless *);
1196int nfs_boot_getfh(struct nfs_diskless *, int, int);
91447636
A
1197
1198__END_DECLS
1c79356b
A
1199
1200#endif /* KERNEL */
9bccf70c 1201#endif /* __APPLE_API_PRIVATE */
1c79356b
A
1202
1203#endif