xref: /freebsd/sys/fs/nfs/nfsproto.h (revision 63a938566d524836885917d95bd491aa4400b181)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 1989, 1993
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  * This code is derived from software contributed to Berkeley by
8  * Rick Macklem at The University of Guelph.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. Neither the name of the University nor the names of its contributors
19  *    may be used to endorse or promote products derived from this software
20  *    without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  *
34  * $FreeBSD$
35  */
36 
37 #ifndef _NFS_NFSPROTO_H_
38 #define	_NFS_NFSPROTO_H_
39 
40 /*
41  * nfs definitions as per the Version 2, 3 and 4 specs
42  */
43 
44 /*
45  * Constants as defined in the NFS Version 2, 3 and 4 specs.
46  * "NFS: Network File System Protocol Specification" RFC1094
47  * and in the "NFS: Network File System Version 3 Protocol
48  * Specification"
49  */
50 
51 #define	NFS_PORT	2049
52 #define	NFS_PROG	100003
53 #define	NFS_CALLBCKPROG	0x40000000	/* V4 only */
54 #define	NFS_VER2	2
55 #define	NFS_VER3	3
56 #define	NFS_VER4	4
57 #define	NFS_V2MAXDATA	8192
58 #define	NFS_MAXDGRAMDATA 16384
59 #define	NFS_MAXPATHLEN	1024
60 #define	NFS_MAXNAMLEN	255
61 /*
62  * Calculating the maximum XDR overhead for an NFS RPC isn't easy.
63  * NFS_MAXPKTHDR is antiquated and assumes AUTH_SYS over UDP.
64  * NFS_MAXXDR should be sufficient for all NFS versions over TCP.
65  * It includes:
66  * - Maximum RPC message header. It can include 2 400byte authenticators plus
67  *   a machine name of unlimited length, although it is usually relatively
68  *   small.
69  * - XDR overheads for the NFSv4 compound. This can include Owner and
70  *   Owner_group strings, which are usually fairly small, but are allowed
71  *   to be up to 1024 bytes each.
72  * 4096 is overkill, but should always be sufficient.
73  */
74 #define	NFS_MAXPKTHDR	404
75 #define	NFS_MAXXDR	4096
76 #define	NFS_MAXPACKET	(NFS_SRVMAXIO + NFS_MAXXDR)
77 #define	NFS_MINPACKET	20
78 #define	NFS_FABLKSIZE	512	/* Size in bytes of a block wrt fa_blocks */
79 #define	NFSV4_MINORVERSION	0	/* V4 Minor version */
80 #define	NFSV41_MINORVERSION	1	/* V4 Minor version */
81 #define	NFSV4_CBVERS		1	/* V4 CB Version */
82 #define	NFSV41_CBVERS		4	/* V4.1 CB Version */
83 #define	NFSV4_SMALLSTR	50		/* Strings small enough for stack */
84 
85 /*
86  * This value isn't a fixed value in the RFCs.
87  * It is the maximum data size supported by NFSv3 or NFSv4 over TCP for
88  * the server.  It should be set to the I/O size preferred by ZFS or
89  * MAXBSIZE, whichever is greater.
90  * ZFS currently prefers 128K.
91  * It used to be called NFS_MAXDATA, but has been renamed to clarify that
92  * it refers to server side only and doesn't conflict with the NFS_MAXDATA
93  * defined in rpcsvc/nfs_prot.h for userland.
94  */
95 #define	NFS_SRVMAXIO	(128 * 1024)
96 
97 /* Stat numbers for rpc returns (version 2, 3 and 4) */
98 /*
99  * These numbers are hard-wired in the RFCs, so they can't be changed.
100  * The code currently assumes that the ones < 10000 are the same as
101  * sys/errno.h and that sys/errno.h will never go as high as 10000.
102  * If the value in sys/errno.h of any entry listed below is changed,
103  * the NFS code must be modified to do the mapping between them.
104  * (You can ignore NFSERR_WFLUSH, since it is never actually used.)
105  */
106 #define	NFSERR_OK		0
107 #define	NFSERR_PERM		1
108 #define	NFSERR_NOENT		2
109 #define	NFSERR_IO		5
110 #define	NFSERR_NXIO		6
111 #define	NFSERR_ACCES		13
112 #define	NFSERR_EXIST		17
113 #define	NFSERR_XDEV		18	/* Version 3, 4 only */
114 #define	NFSERR_NODEV		19
115 #define	NFSERR_NOTDIR		20
116 #define	NFSERR_ISDIR		21
117 #define	NFSERR_INVAL		22	/* Version 3, 4 only */
118 #define	NFSERR_FBIG		27
119 #define	NFSERR_NOSPC		28
120 #define	NFSERR_ROFS		30
121 #define	NFSERR_MLINK		31	/* Version 3, 4 only */
122 #define	NFSERR_NAMETOL		63
123 #define	NFSERR_NOTEMPTY		66
124 #define	NFSERR_DQUOT		69
125 #define	NFSERR_STALE		70
126 #define	NFSERR_REMOTE		71	/* Version 3 only */
127 #define	NFSERR_WFLUSH		99	/* Version 2 only */
128 #define	NFSERR_BADHANDLE	10001	/* These are Version 3, 4 only */
129 #define	NFSERR_NOT_SYNC		10002	/* Version 3 Only */
130 #define	NFSERR_BAD_COOKIE	10003
131 #define	NFSERR_NOTSUPP		10004
132 #define	NFSERR_TOOSMALL		10005
133 #define	NFSERR_SERVERFAULT	10006
134 #define	NFSERR_BADTYPE		10007
135 #define	NFSERR_DELAY		10008	/* Called NFSERR_JUKEBOX for V3 */
136 #define	NFSERR_SAME		10009	/* These are Version 4 only */
137 #define	NFSERR_DENIED		10010
138 #define	NFSERR_EXPIRED		10011
139 #define	NFSERR_LOCKED		10012
140 #define	NFSERR_GRACE		10013
141 #define	NFSERR_FHEXPIRED	10014
142 #define	NFSERR_SHAREDENIED	10015
143 #define	NFSERR_WRONGSEC		10016
144 #define	NFSERR_CLIDINUSE	10017
145 #define	NFSERR_RESOURCE		10018
146 #define	NFSERR_MOVED		10019
147 #define	NFSERR_NOFILEHANDLE	10020
148 #define	NFSERR_MINORVERMISMATCH	10021
149 #define	NFSERR_STALECLIENTID	10022
150 #define	NFSERR_STALESTATEID	10023
151 #define	NFSERR_OLDSTATEID	10024
152 #define	NFSERR_BADSTATEID	10025
153 #define	NFSERR_BADSEQID		10026
154 #define	NFSERR_NOTSAME		10027
155 #define	NFSERR_LOCKRANGE	10028
156 #define	NFSERR_SYMLINK		10029
157 #define	NFSERR_RESTOREFH	10030
158 #define	NFSERR_LEASEMOVED	10031
159 #define	NFSERR_ATTRNOTSUPP	10032
160 #define	NFSERR_NOGRACE		10033
161 #define	NFSERR_RECLAIMBAD	10034
162 #define	NFSERR_RECLAIMCONFLICT	10035
163 #define	NFSERR_BADXDR		10036
164 #define	NFSERR_LOCKSHELD	10037
165 #define	NFSERR_OPENMODE		10038
166 #define	NFSERR_BADOWNER		10039
167 #define	NFSERR_BADCHAR		10040
168 #define	NFSERR_BADNAME		10041
169 #define	NFSERR_BADRANGE		10042
170 #define	NFSERR_LOCKNOTSUPP	10043
171 #define	NFSERR_OPILLEGAL	10044
172 #define	NFSERR_DEADLOCK		10045
173 #define	NFSERR_FILEOPEN		10046
174 #define	NFSERR_ADMINREVOKED	10047
175 #define	NFSERR_CBPATHDOWN	10048
176 
177 /* NFSv4.1 specific errors. */
178 #define	NFSERR_BADIOMODE	10049
179 #define	NFSERR_BADLAYOUT	10050
180 #define	NFSERR_BADSESSIONDIGEST	10051
181 #define	NFSERR_BADSESSION	10052
182 #define	NFSERR_BADSLOT		10053
183 #define	NFSERR_COMPLETEALREADY	10054
184 #define	NFSERR_NOTBNDTOSESS	10055
185 #define	NFSERR_DELEGALREADYWANT	10056
186 #define	NFSERR_BACKCHANBUSY	10057
187 #define	NFSERR_LAYOUTTRYLATER	10058
188 #define	NFSERR_LAYOUTUNAVAIL	10059
189 #define	NFSERR_NOMATCHLAYOUT	10060
190 #define	NFSERR_RECALLCONFLICT	10061
191 #define	NFSERR_UNKNLAYOUTTYPE	10062
192 #define	NFSERR_SEQMISORDERED	10063
193 #define	NFSERR_SEQUENCEPOS	10064
194 #define	NFSERR_REQTOOBIG	10065
195 #define	NFSERR_REPTOOBIG	10066
196 #define	NFSERR_REPTOOBIGTOCACHE	10067
197 #define	NFSERR_RETRYUNCACHEDREP	10068
198 #define	NFSERR_UNSAFECOMPOUND	10069
199 #define	NFSERR_TOOMANYOPS	10070
200 #define	NFSERR_OPNOTINSESS	10071
201 #define	NFSERR_HASHALGUNSUPP	10072
202 #define	NFSERR_CLIENTIDBUSY	10074
203 #define	NFSERR_PNFSIOHOLE	10075
204 #define	NFSERR_SEQFALSERETRY	10076
205 #define	NFSERR_BADHIGHSLOT	10077
206 #define	NFSERR_DEADSESSION	10078
207 #define	NFSERR_ENCRALGUNSUPP	10079
208 #define	NFSERR_PNFSNOLAYOUT	10080
209 #define	NFSERR_NOTONLYOP	10081
210 #define	NFSERR_WRONGCRED	10082
211 #define	NFSERR_WRONGTYPE	10083
212 #define	NFSERR_DIRDELEGUNAVAIL	10084
213 #define	NFSERR_REJECTDELEG	10085
214 #define	NFSERR_RETURNCONFLICT	10086
215 #define	NFSERR_DELEGREVOKED	10087
216 
217 #define	NFSERR_STALEWRITEVERF	30001	/* Fake return for nfs_commit() */
218 #define	NFSERR_DONTREPLY	30003	/* Don't process request */
219 #define	NFSERR_RETVOID		30004	/* Return void, not error */
220 #define	NFSERR_REPLYFROMCACHE	30005	/* Reply from recent request cache */
221 #define	NFSERR_STALEDONTRECOVER	30006	/* Don't initiate recovery */
222 
223 #define	NFSERR_RPCERR		0x40000000 /* Mark an RPC layer error */
224 #define	NFSERR_AUTHERR		0x80000000 /* Mark an authentication error */
225 
226 #define	NFSERR_RPCMISMATCH	(NFSERR_RPCERR | RPC_MISMATCH)
227 #define	NFSERR_PROGUNAVAIL	(NFSERR_RPCERR | RPC_PROGUNAVAIL)
228 #define	NFSERR_PROGMISMATCH	(NFSERR_RPCERR | RPC_PROGMISMATCH)
229 #define	NFSERR_PROGNOTV4	(NFSERR_RPCERR | 0xffff)
230 #define	NFSERR_PROCUNAVAIL	(NFSERR_RPCERR | RPC_PROCUNAVAIL)
231 #define	NFSERR_GARBAGE		(NFSERR_RPCERR | RPC_GARBAGE)
232 
233 /* Sizes in bytes of various nfs rpc components */
234 #define	NFSX_UNSIGNED	4
235 #define	NFSX_HYPER	(2 * NFSX_UNSIGNED)
236 
237 /* specific to NFS Version 2 */
238 #define	NFSX_V2FH	32
239 #define	NFSX_V2FATTR	68
240 #define	NFSX_V2SATTR	32
241 #define	NFSX_V2COOKIE	4
242 #define	NFSX_V2STATFS	20
243 
244 /* specific to NFS Version 3 */
245 #define	NFSX_V3FHMAX		64	/* max. allowed by protocol */
246 #define	NFSX_V3FATTR		84
247 #define	NFSX_V3SATTR		60	/* max. all fields filled in */
248 #define	NFSX_V3SRVSATTR		(sizeof (struct nfsv3_sattr))
249 #define	NFSX_V3POSTOPATTR	(NFSX_V3FATTR + NFSX_UNSIGNED)
250 #define	NFSX_V3WCCDATA		(NFSX_V3POSTOPATTR + 8 * NFSX_UNSIGNED)
251 #define	NFSX_V3STATFS		52
252 #define	NFSX_V3FSINFO		48
253 #define	NFSX_V3PATHCONF		24
254 
255 /* specific to NFS Version 4 */
256 #define	NFSX_V4FHMAX		128
257 #define	NFSX_V4FSID		(2 * NFSX_HYPER)
258 #define	NFSX_V4SPECDATA		(2 * NFSX_UNSIGNED)
259 #define	NFSX_V4TIME		(NFSX_HYPER + NFSX_UNSIGNED)
260 #define	NFSX_V4SETTIME		(NFSX_UNSIGNED + NFSX_V4TIME)
261 #define	NFSX_V4SESSIONID	16
262 #define	NFSX_V4DEVICEID		16
263 
264 /* sizes common to multiple NFS versions */
265 #define	NFSX_FHMAX		(NFSX_V4FHMAX)
266 #define	NFSX_MYFH		(sizeof (fhandle_t)) /* size this server uses */
267 #define	NFSX_VERF 		8
268 #define	NFSX_STATEIDOTHER	12
269 #define	NFSX_STATEID		(NFSX_UNSIGNED + NFSX_STATEIDOTHER)
270 #define	NFSX_GSSH		12
271 
272 /* variants for multiple versions */
273 #define	NFSX_STATFS(v3)		((v3) ? NFSX_V3STATFS : NFSX_V2STATFS)
274 
275 /* nfs rpc procedure numbers (before version mapping) */
276 #define	NFSPROC_NULL		0
277 #define	NFSPROC_GETATTR		1
278 #define	NFSPROC_SETATTR		2
279 #define	NFSPROC_LOOKUP		3
280 #define	NFSPROC_ACCESS		4
281 #define	NFSPROC_READLINK	5
282 #define	NFSPROC_READ		6
283 #define	NFSPROC_WRITE		7
284 #define	NFSPROC_CREATE		8
285 #define	NFSPROC_MKDIR		9
286 #define	NFSPROC_SYMLINK		10
287 #define	NFSPROC_MKNOD		11
288 #define	NFSPROC_REMOVE		12
289 #define	NFSPROC_RMDIR		13
290 #define	NFSPROC_RENAME		14
291 #define	NFSPROC_LINK		15
292 #define	NFSPROC_READDIR		16
293 #define	NFSPROC_READDIRPLUS	17
294 #define	NFSPROC_FSSTAT		18
295 #define	NFSPROC_FSINFO		19
296 #define	NFSPROC_PATHCONF	20
297 #define	NFSPROC_COMMIT		21
298 
299 /*
300  * The lower numbers -> 21 are used by NFSv2 and v3. These define higher
301  * numbers used by NFSv4.
302  * NFS_V3NPROCS is one greater than the last V3 op and NFS_NPROCS is
303  * one greater than the last number.
304  */
305 #ifndef	NFS_V3NPROCS
306 #define	NFS_V3NPROCS		22
307 
308 #define	NFSPROC_LOOKUPP		22
309 #define	NFSPROC_SETCLIENTID	23
310 #define	NFSPROC_SETCLIENTIDCFRM	24
311 #define	NFSPROC_LOCK		25
312 #define	NFSPROC_LOCKU		26
313 #define	NFSPROC_OPEN		27
314 #define	NFSPROC_CLOSE		28
315 #define	NFSPROC_OPENCONFIRM	29
316 #define	NFSPROC_LOCKT		30
317 #define	NFSPROC_OPENDOWNGRADE	31
318 #define	NFSPROC_RENEW		32
319 #define	NFSPROC_PUTROOTFH	33
320 #define	NFSPROC_RELEASELCKOWN	34
321 #define	NFSPROC_DELEGRETURN	35
322 #define	NFSPROC_RETDELEGREMOVE	36
323 #define	NFSPROC_RETDELEGRENAME1	37
324 #define	NFSPROC_RETDELEGRENAME2	38
325 #define	NFSPROC_GETACL		39
326 #define	NFSPROC_SETACL		40
327 
328 /*
329  * Must be defined as one higher than the last Proc# above.
330  */
331 #define	NFSV4_NPROCS		41
332 
333 /* Additional procedures for NFSv4.1. */
334 #define	NFSPROC_EXCHANGEID	41
335 #define	NFSPROC_CREATESESSION	42
336 #define	NFSPROC_DESTROYSESSION	43
337 #define	NFSPROC_DESTROYCLIENT	44
338 #define	NFSPROC_FREESTATEID	45
339 #define	NFSPROC_LAYOUTGET	46
340 #define	NFSPROC_GETDEVICEINFO	47
341 #define	NFSPROC_LAYOUTCOMMIT	48
342 #define	NFSPROC_LAYOUTRETURN	49
343 #define	NFSPROC_RECLAIMCOMPL	50
344 #define	NFSPROC_WRITEDS		51
345 #define	NFSPROC_READDS		52
346 #define	NFSPROC_COMMITDS	53
347 #define	NFSPROC_OPENLAYGET	54
348 #define	NFSPROC_CREATELAYGET	55
349 
350 /*
351  * Must be defined as one higher than the last NFSv4.1 Proc# above.
352  */
353 #define	NFSV41_NPROCS		56
354 
355 #endif	/* NFS_V3NPROCS */
356 
357 /*
358  * Define NFS_NPROCS as NFSV4_NPROCS for the experimental kernel code.
359  */
360 #ifndef	NFS_NPROCS
361 #define	NFS_NPROCS		NFSV4_NPROCS
362 #endif
363 
364 /*
365  * NFSPROC_NOOP is a fake op# that can't be the same as any V2/3/4 Procedure
366  * or Operation#. Since the NFS V4 Op #s go higher, use NFSV42_NOPS, which
367  * is one greater than the highest Op#.
368  */
369 #define	NFSPROC_NOOP		NFSV42_NOPS
370 
371 /* Actual Version 2 procedure numbers */
372 #define	NFSV2PROC_NULL		0
373 #define	NFSV2PROC_GETATTR	1
374 #define	NFSV2PROC_SETATTR	2
375 #define	NFSV2PROC_NOOP		3
376 #define	NFSV2PROC_ROOT		NFSV2PROC_NOOP	/* Obsolete */
377 #define	NFSV2PROC_LOOKUP	4
378 #define	NFSV2PROC_READLINK	5
379 #define	NFSV2PROC_READ		6
380 #define	NFSV2PROC_WRITECACHE	NFSV2PROC_NOOP	/* Obsolete */
381 #define	NFSV2PROC_WRITE		8
382 #define	NFSV2PROC_CREATE	9
383 #define	NFSV2PROC_REMOVE	10
384 #define	NFSV2PROC_RENAME	11
385 #define	NFSV2PROC_LINK		12
386 #define	NFSV2PROC_SYMLINK	13
387 #define	NFSV2PROC_MKDIR		14
388 #define	NFSV2PROC_RMDIR		15
389 #define	NFSV2PROC_READDIR	16
390 #define	NFSV2PROC_STATFS	17
391 
392 /*
393  * V4 Procedure numbers
394  */
395 #define	NFSV4PROC_COMPOUND	1
396 #define	NFSV4PROC_CBNULL	0
397 #define	NFSV4PROC_CBCOMPOUND	1
398 
399 /*
400  * Constants used by the Version 3 and 4 protocols for various RPCs
401  */
402 #define	NFSV3SATTRTIME_DONTCHANGE	0
403 #define	NFSV3SATTRTIME_TOSERVER		1
404 #define	NFSV3SATTRTIME_TOCLIENT		2
405 
406 #define	NFSV4SATTRTIME_TOSERVER		0
407 #define	NFSV4SATTRTIME_TOCLIENT		1
408 
409 #define	NFSV4LOCKT_READ			1
410 #define	NFSV4LOCKT_WRITE		2
411 #define	NFSV4LOCKT_READW		3
412 #define	NFSV4LOCKT_WRITEW		4
413 #define	NFSV4LOCKT_RELEASE		5
414 
415 #define	NFSV4OPEN_NOCREATE		0
416 #define	NFSV4OPEN_CREATE		1
417 #define	NFSV4OPEN_CLAIMNULL		0
418 #define	NFSV4OPEN_CLAIMPREVIOUS		1
419 #define	NFSV4OPEN_CLAIMDELEGATECUR	2
420 #define	NFSV4OPEN_CLAIMDELEGATEPREV	3
421 #define	NFSV4OPEN_CLAIMFH		4
422 #define	NFSV4OPEN_CLAIMDELEGATECURFH	5
423 #define	NFSV4OPEN_CLAIMDELEGATEPREVFH	6
424 #define	NFSV4OPEN_DELEGATENONE		0
425 #define	NFSV4OPEN_DELEGATEREAD		1
426 #define	NFSV4OPEN_DELEGATEWRITE		2
427 #define	NFSV4OPEN_DELEGATENONEEXT	3
428 #define	NFSV4OPEN_LIMITSIZE		1
429 #define	NFSV4OPEN_LIMITBLOCKS		2
430 
431 /*
432  * Nfs V4 ACE stuff
433  */
434 #define	NFSV4ACE_ALLOWEDTYPE		0x00000000
435 #define	NFSV4ACE_DENIEDTYPE		0x00000001
436 #define	NFSV4ACE_AUDITTYPE		0x00000002
437 #define	NFSV4ACE_ALARMTYPE		0x00000003
438 
439 #define	NFSV4ACE_SUPALLOWED		0x00000001
440 #define	NFSV4ACE_SUPDENIED		0x00000002
441 #define	NFSV4ACE_SUPAUDIT		0x00000004
442 #define	NFSV4ACE_SUPALARM		0x00000008
443 
444 #define	NFSV4ACE_SUPTYPES	(NFSV4ACE_SUPALLOWED | NFSV4ACE_SUPDENIED)
445 
446 #define	NFSV4ACE_FILEINHERIT		0x00000001
447 #define	NFSV4ACE_DIRECTORYINHERIT	0x00000002
448 #define	NFSV4ACE_NOPROPAGATEINHERIT	0x00000004
449 #define	NFSV4ACE_INHERITONLY		0x00000008
450 #define	NFSV4ACE_SUCCESSFULACCESS	0x00000010
451 #define	NFSV4ACE_FAILEDACCESS		0x00000020
452 #define	NFSV4ACE_IDENTIFIERGROUP	0x00000040
453 
454 #define	NFSV4ACE_READDATA		0x00000001
455 #define	NFSV4ACE_LISTDIRECTORY		0x00000001
456 #define	NFSV4ACE_WRITEDATA		0x00000002
457 #define	NFSV4ACE_ADDFILE		0x00000002
458 #define	NFSV4ACE_APPENDDATA		0x00000004
459 #define	NFSV4ACE_ADDSUBDIRECTORY	0x00000004
460 #define	NFSV4ACE_READNAMEDATTR		0x00000008
461 #define	NFSV4ACE_WRITENAMEDATTR		0x00000010
462 #define	NFSV4ACE_EXECUTE		0x00000020
463 #define	NFSV4ACE_SEARCH			0x00000020
464 #define	NFSV4ACE_DELETECHILD		0x00000040
465 #define	NFSV4ACE_READATTRIBUTES		0x00000080
466 #define	NFSV4ACE_WRITEATTRIBUTES	0x00000100
467 #define	NFSV4ACE_DELETE			0x00010000
468 #define	NFSV4ACE_READACL		0x00020000
469 #define	NFSV4ACE_WRITEACL		0x00040000
470 #define	NFSV4ACE_WRITEOWNER		0x00080000
471 #define	NFSV4ACE_SYNCHRONIZE		0x00100000
472 
473 /*
474  * Here are the mappings between mode bits and acl mask bits for
475  * directories and other files.
476  * (Named attributes have not been included, since named attributes are
477  *  not yet supported.)
478  * The mailing list seems to indicate that NFSV4ACE_EXECUTE refers to
479  * searching a directory, although I can't find a statement of that in
480  * the RFC.
481  */
482 #define	NFSV4ACE_ALLFILESMASK	(NFSV4ACE_READATTRIBUTES | NFSV4ACE_READACL)
483 #define	NFSV4ACE_OWNERMASK	(NFSV4ACE_WRITEATTRIBUTES | NFSV4ACE_WRITEACL)
484 #define	NFSV4ACE_DIRREADMASK	NFSV4ACE_LISTDIRECTORY
485 #define	NFSV4ACE_DIREXECUTEMASK	NFSV4ACE_EXECUTE
486 #define	NFSV4ACE_DIRWRITEMASK	(NFSV4ACE_ADDFILE | 			\
487 		NFSV4ACE_ADDSUBDIRECTORY | NFSV4ACE_DELETECHILD)
488 #define	NFSV4ACE_READMASK	NFSV4ACE_READDATA
489 #define	NFSV4ACE_WRITEMASK	(NFSV4ACE_WRITEDATA | NFSV4ACE_APPENDDATA)
490 #define	NFSV4ACE_EXECUTEMASK	NFSV4ACE_EXECUTE
491 #define	NFSV4ACE_ALLFILEBITS	(NFSV4ACE_READMASK | NFSV4ACE_WRITEMASK | \
492 	NFSV4ACE_EXECUTEMASK | NFSV4ACE_SYNCHRONIZE)
493 #define	NFSV4ACE_ALLDIRBITS	(NFSV4ACE_DIRREADMASK | 		\
494 	NFSV4ACE_DIRWRITEMASK | NFSV4ACE_DIREXECUTEMASK)
495 #define	NFSV4ACE_AUDITMASK	0x0
496 
497 /*
498  * These GENERIC masks are not used and are no longer believed to be useful.
499  */
500 #define	NFSV4ACE_GENERICREAD		0x00120081
501 #define	NFSV4ACE_GENERICWRITE		0x00160106
502 #define	NFSV4ACE_GENERICEXECUTE		0x001200a0
503 
504 #define	NFSSTATEID_PUTALLZERO		0
505 #define	NFSSTATEID_PUTALLONE		1
506 #define	NFSSTATEID_PUTSTATEID		2
507 #define	NFSSTATEID_PUTSEQIDZERO		3
508 
509 /*
510  * Bits for share access and deny.
511  */
512 #define	NFSV4OPEN_ACCESSREAD		0x00000001
513 #define	NFSV4OPEN_ACCESSWRITE		0x00000002
514 #define	NFSV4OPEN_ACCESSBOTH		0x00000003
515 #define	NFSV4OPEN_WANTDELEGMASK		0x0000ff00
516 #define	NFSV4OPEN_WANTREADDELEG		0x00000100
517 #define	NFSV4OPEN_WANTWRITEDELEG	0x00000200
518 #define	NFSV4OPEN_WANTANYDELEG		0x00000300
519 #define	NFSV4OPEN_WANTNODELEG		0x00000400
520 #define	NFSV4OPEN_WANTCANCEL		0x00000500
521 #define	NFSV4OPEN_WANTSIGNALDELEG	0x00010000
522 #define	NFSV4OPEN_WANTPUSHDELEG		0x00020000
523 
524 #define	NFSV4OPEN_DENYNONE		0x00000000
525 #define	NFSV4OPEN_DENYREAD		0x00000001
526 #define	NFSV4OPEN_DENYWRITE		0x00000002
527 #define	NFSV4OPEN_DENYBOTH		0x00000003
528 
529 /*
530  * Delegate_none_ext reply values.
531  */
532 #define	NFSV4OPEN_NOTWANTED		0
533 #define	NFSV4OPEN_CONTENTION		1
534 #define	NFSV4OPEN_RESOURCE		2
535 #define	NFSV4OPEN_NOTSUPPFTYPE		3
536 #define	NFSV4OPEN_NOTSUPPWRITEFTYPE	4
537 #define	NFSV4OPEN_NOTSUPPUPGRADE	5
538 #define	NFSV4OPEN_NOTSUPPDOWNGRADE	6
539 #define	NFSV4OPEN_CANCELLED		7
540 #define	NFSV4OPEN_ISDIR			8
541 
542 /*
543  * Open result flags
544  * (The first four are in the spec. The rest are used internally.)
545  */
546 #define	NFSV4OPEN_RESULTCONFIRM		0x00000002
547 #define	NFSV4OPEN_LOCKTYPEPOSIX		0x00000004
548 #define	NFSV4OPEN_PRESERVEUNLINKED	0x00000008
549 #define	NFSV4OPEN_MAYNOTIFYLOCK		0x00000020
550 #define	NFSV4OPEN_RFLAGS 						\
551     (NFSV4OPEN_RESULTCONFIRM | NFSV4OPEN_LOCKTYPEPOSIX |		\
552     NFSV4OPEN_PRESERVEUNLINKED | NFSV4OPEN_MAYNOTIFYLOCK)
553 #define	NFSV4OPEN_RECALL		0x00010000
554 #define	NFSV4OPEN_READDELEGATE		0x00020000
555 #define	NFSV4OPEN_WRITEDELEGATE		0x00040000
556 #define	NFSV4OPEN_WDRESOURCE		0x00080000
557 #define	NFSV4OPEN_WDCONTENTION		0x00100000
558 #define	NFSV4OPEN_WDNOTWANTED		0x00200000
559 
560 /*
561  * NFS V4 File Handle types
562  */
563 #define	NFSV4FHTYPE_PERSISTENT		0x0
564 #define	NFSV4FHTYPE_NOEXPIREWITHOPEN	0x1
565 #define	NFSV4FHTYPE_VOLATILEANY		0x2
566 #define	NFSV4FHTYPE_VOLATILEMIGRATE	0x4
567 #define	NFSV4FHTYPE_VOLATILERENAME	0x8
568 
569 /*
570  * Maximum size of V4 opaque strings.
571  */
572 #define	NFSV4_OPAQUELIMIT	1024
573 
574 /*
575  * These are the same for V3 and V4.
576  */
577 #define	NFSACCESS_READ			0x01
578 #define	NFSACCESS_LOOKUP		0x02
579 #define	NFSACCESS_MODIFY		0x04
580 #define	NFSACCESS_EXTEND		0x08
581 #define	NFSACCESS_DELETE		0x10
582 #define	NFSACCESS_EXECUTE		0x20
583 
584 #define	NFSWRITE_UNSTABLE		0
585 #define	NFSWRITE_DATASYNC		1
586 #define	NFSWRITE_FILESYNC		2
587 
588 #define	NFSCREATE_UNCHECKED		0
589 #define	NFSCREATE_GUARDED		1
590 #define	NFSCREATE_EXCLUSIVE		2
591 #define	NFSCREATE_EXCLUSIVE41		3
592 
593 #define	NFSV3FSINFO_LINK		0x01
594 #define	NFSV3FSINFO_SYMLINK		0x02
595 #define	NFSV3FSINFO_HOMOGENEOUS		0x08
596 #define	NFSV3FSINFO_CANSETTIME		0x10
597 
598 /* Flags for Exchange ID */
599 #define	NFSV4EXCH_SUPPMOVEDREFER	0x00000001
600 #define	NFSV4EXCH_SUPPMOVEDMIGR	0x00000002
601 #define	NFSV4EXCH_BINDPRINCSTATEID	0x00000100
602 #define	NFSV4EXCH_USENONPNFS		0x00010000
603 #define	NFSV4EXCH_USEPNFSMDS		0x00020000
604 #define	NFSV4EXCH_USEPNFSDS		0x00040000
605 #define	NFSV4EXCH_MASKPNFS		0x00070000
606 #define	NFSV4EXCH_UPDCONFIRMEDRECA	0x40000000
607 #define	NFSV4EXCH_CONFIRMEDR		0x80000000
608 
609 /* State Protects */
610 #define	NFSV4EXCH_SP4NONE		0
611 #define	NFSV4EXCH_SP4MACHCRED		1
612 #define	NFSV4EXCH_SP4SSV		2
613 
614 /* Flags for Create Session */
615 #define	NFSV4CRSESS_PERSIST		0x00000001
616 #define	NFSV4CRSESS_CONNBACKCHAN	0x00000002
617 #define	NFSV4CRSESS_CONNRDMA		0x00000004
618 
619 /* Flags for Sequence */
620 #define	NFSV4SEQ_CBPATHDOWN		0x00000001
621 #define	NFSV4SEQ_CBGSSCONTEXPIRING	0x00000002
622 #define	NFSV4SEQ_CBGSSCONTEXPIRED	0x00000004
623 #define	NFSV4SEQ_EXPIREDALLSTATEREVOKED	0x00000008
624 #define	NFSV4SEQ_EXPIREDSOMESTATEREVOKED 0x00000010
625 #define	NFSV4SEQ_ADMINSTATEREVOKED	0x00000020
626 #define	NFSV4SEQ_RECALLABLESTATEREVOKED	0x00000040
627 #define	NFSV4SEQ_LEASEMOVED		0x00000080
628 #define	NFSV4SEQ_RESTARTRECLAIMNEEDED	0x00000100
629 #define	NFSV4SEQ_CBPATHDOWNSESSION	0x00000200
630 #define	NFSV4SEQ_BACKCHANNELFAULT	0x00000400
631 #define	NFSV4SEQ_DEVIDCHANGED		0x00000800
632 #define	NFSV4SEQ_DEVIDDELETED		0x00001000
633 
634 /* Flags for Layout. */
635 #define	NFSLAYOUTRETURN_FILE		1
636 #define	NFSLAYOUTRETURN_FSID		2
637 #define	NFSLAYOUTRETURN_ALL		3
638 
639 #define	NFSLAYOUT_NFSV4_1_FILES		0x1
640 #define	NFSLAYOUT_OSD2_OBJECTS		0x2
641 #define	NFSLAYOUT_BLOCK_VOLUME		0x3
642 #define	NFSLAYOUT_FLEXFILE		0x4
643 
644 #define	NFSLAYOUTIOMODE_READ		1
645 #define	NFSLAYOUTIOMODE_RW		2
646 #define	NFSLAYOUTIOMODE_ANY		3
647 
648 /* Flags for Get Device Info. */
649 #define	NFSDEVICEIDNOTIFY_CHANGEBIT	0x1
650 #define	NFSDEVICEIDNOTIFY_DELETEBIT	0x2
651 
652 /* Flags for File Layout. */
653 #define	NFSFLAYUTIL_DENSE		0x1
654 #define	NFSFLAYUTIL_COMMIT_THRU_MDS	0x2
655 
656 /* Flags for Flex File Layout. */
657 #define	NFSFLEXFLAG_NO_LAYOUTCOMMIT	0x00000001
658 #define	NFSFLEXFLAG_NOIO_MDS		0x00000002
659 #define	NFSFLEXFLAG_NO_READIO		0x00000004
660 #define	NFSFLEXFLAG_WRITE_ONEMIRROR	0x00000008
661 
662 /* Conversion macros */
663 #define	vtonfsv2_mode(t,m) 						\
664 		txdr_unsigned(((t) == VFIFO) ? MAKEIMODE(VCHR, (m)) : 	\
665 				MAKEIMODE((t), (m)))
666 #define	vtonfsv34_mode(m)	txdr_unsigned((m) & 07777)
667 #define	nfstov_mode(a)		(fxdr_unsigned(u_int16_t, (a))&07777)
668 #define	vtonfsv2_type(a)  (((u_int32_t)(a)) >= 9 ? txdr_unsigned(NFNON) : \
669 		txdr_unsigned(newnfsv2_type[((u_int32_t)(a))]))
670 #define	vtonfsv34_type(a)  (((u_int32_t)(a)) >= 9 ? txdr_unsigned(NFNON) : \
671 		txdr_unsigned(nfsv34_type[((u_int32_t)(a))]))
672 #define	nfsv2tov_type(a)	newnv2tov_type[fxdr_unsigned(u_int32_t,(a))&0x7]
673 #define	nfsv34tov_type(a)	nv34tov_type[fxdr_unsigned(u_int32_t,(a))&0x7]
674 #define	vtonfs_dtype(a)	(((u_int32_t)(a)) >= 9 ? IFTODT(VTTOIF(VNON)) : \
675 			 IFTODT(VTTOIF(a)))
676 
677 /* File types */
678 typedef enum { NFNON=0, NFREG=1, NFDIR=2, NFBLK=3, NFCHR=4, NFLNK=5,
679 	NFSOCK=6, NFFIFO=7, NFATTRDIR=8, NFNAMEDATTR=9 } nfstype;
680 
681 /* Structs for common parts of the rpc's */
682 
683 struct nfsv2_time {
684 	u_int32_t nfsv2_sec;
685 	u_int32_t nfsv2_usec;
686 };
687 typedef struct nfsv2_time	nfstime2;
688 
689 struct nfsv3_time {
690 	u_int32_t nfsv3_sec;
691 	u_int32_t nfsv3_nsec;
692 };
693 typedef struct nfsv3_time	nfstime3;
694 
695 struct nfsv4_time {
696 	u_int32_t nfsv4_highsec;
697 	u_int32_t nfsv4_sec;
698 	u_int32_t nfsv4_nsec;
699 };
700 typedef struct nfsv4_time	nfstime4;
701 
702 /*
703  * Quads are defined as arrays of 2 longs to ensure dense packing for the
704  * protocol and to facilitate xdr conversion.
705  */
706 struct nfs_uquad {
707 	u_int32_t nfsuquad[2];
708 };
709 typedef	struct nfs_uquad	nfsuint64;
710 
711 /*
712  * Used to convert between two u_longs and a u_quad_t.
713  */
714 union nfs_quadconvert {
715 	u_int32_t lval[2];
716 	u_quad_t  qval;
717 };
718 typedef union nfs_quadconvert	nfsquad_t;
719 
720 /*
721  * NFS Version 3 special file number.
722  */
723 struct nfsv3_spec {
724 	u_int32_t specdata1;
725 	u_int32_t specdata2;
726 };
727 typedef	struct nfsv3_spec	nfsv3spec;
728 
729 /*
730  * File attributes and setable attributes. These structures cover both
731  * NFS version 2 and the version 3 protocol. Note that the union is only
732  * used so that one pointer can refer to both variants. These structures
733  * go out on the wire and must be densely packed, so no quad data types
734  * are used. (all fields are longs or u_longs or structures of same)
735  * NB: You can't do sizeof(struct nfs_fattr), you must use the
736  *     NFSX_FATTR(v3) macro.
737  */
738 struct nfs_fattr {
739 	u_int32_t fa_type;
740 	u_int32_t fa_mode;
741 	u_int32_t fa_nlink;
742 	u_int32_t fa_uid;
743 	u_int32_t fa_gid;
744 	union {
745 		struct {
746 			u_int32_t nfsv2fa_size;
747 			u_int32_t nfsv2fa_blocksize;
748 			u_int32_t nfsv2fa_rdev;
749 			u_int32_t nfsv2fa_blocks;
750 			u_int32_t nfsv2fa_fsid;
751 			u_int32_t nfsv2fa_fileid;
752 			nfstime2  nfsv2fa_atime;
753 			nfstime2  nfsv2fa_mtime;
754 			nfstime2  nfsv2fa_ctime;
755 		} fa_nfsv2;
756 		struct {
757 			nfsuint64 nfsv3fa_size;
758 			nfsuint64 nfsv3fa_used;
759 			nfsv3spec nfsv3fa_rdev;
760 			nfsuint64 nfsv3fa_fsid;
761 			nfsuint64 nfsv3fa_fileid;
762 			nfstime3  nfsv3fa_atime;
763 			nfstime3  nfsv3fa_mtime;
764 			nfstime3  nfsv3fa_ctime;
765 		} fa_nfsv3;
766 	} fa_un;
767 };
768 
769 /* and some ugly defines for accessing union components */
770 #define	fa2_size		fa_un.fa_nfsv2.nfsv2fa_size
771 #define	fa2_blocksize		fa_un.fa_nfsv2.nfsv2fa_blocksize
772 #define	fa2_rdev		fa_un.fa_nfsv2.nfsv2fa_rdev
773 #define	fa2_blocks		fa_un.fa_nfsv2.nfsv2fa_blocks
774 #define	fa2_fsid		fa_un.fa_nfsv2.nfsv2fa_fsid
775 #define	fa2_fileid		fa_un.fa_nfsv2.nfsv2fa_fileid
776 #define	fa2_atime		fa_un.fa_nfsv2.nfsv2fa_atime
777 #define	fa2_mtime		fa_un.fa_nfsv2.nfsv2fa_mtime
778 #define	fa2_ctime		fa_un.fa_nfsv2.nfsv2fa_ctime
779 #define	fa3_size		fa_un.fa_nfsv3.nfsv3fa_size
780 #define	fa3_used		fa_un.fa_nfsv3.nfsv3fa_used
781 #define	fa3_rdev		fa_un.fa_nfsv3.nfsv3fa_rdev
782 #define	fa3_fsid		fa_un.fa_nfsv3.nfsv3fa_fsid
783 #define	fa3_fileid		fa_un.fa_nfsv3.nfsv3fa_fileid
784 #define	fa3_atime		fa_un.fa_nfsv3.nfsv3fa_atime
785 #define	fa3_mtime		fa_un.fa_nfsv3.nfsv3fa_mtime
786 #define	fa3_ctime		fa_un.fa_nfsv3.nfsv3fa_ctime
787 
788 #define	NFS_LINK_MAX	UINT32_MAX
789 
790 struct nfsv2_sattr {
791 	u_int32_t sa_mode;
792 	u_int32_t sa_uid;
793 	u_int32_t sa_gid;
794 	u_int32_t sa_size;
795 	nfstime2  sa_atime;
796 	nfstime2  sa_mtime;
797 };
798 
799 /*
800  * NFS Version 3 sattr structure for the new node creation case.
801  */
802 struct nfsv3_sattr {
803 	u_int32_t sa_modetrue;
804 	u_int32_t sa_mode;
805 	u_int32_t sa_uidfalse;
806 	u_int32_t sa_gidfalse;
807 	u_int32_t sa_sizefalse;
808 	u_int32_t sa_atimetype;
809 	nfstime3  sa_atime;
810 	u_int32_t sa_mtimetype;
811 	nfstime3  sa_mtime;
812 };
813 
814 /*
815  * The attribute bits used for V4.
816  * NFSATTRBIT_xxx defines the attribute# (and its bit position)
817  * NFSATTRBM_xxx is a 32bit mask with the correct bit set within the
818  *	appropriate 32bit word.
819  * NFSATTRBIT_MAX is one greater than the largest NFSATTRBIT_xxx
820  */
821 #define	NFSATTRBIT_SUPPORTEDATTRS	0
822 #define	NFSATTRBIT_TYPE			1
823 #define	NFSATTRBIT_FHEXPIRETYPE		2
824 #define	NFSATTRBIT_CHANGE		3
825 #define	NFSATTRBIT_SIZE			4
826 #define	NFSATTRBIT_LINKSUPPORT		5
827 #define	NFSATTRBIT_SYMLINKSUPPORT	6
828 #define	NFSATTRBIT_NAMEDATTR		7
829 #define	NFSATTRBIT_FSID			8
830 #define	NFSATTRBIT_UNIQUEHANDLES	9
831 #define	NFSATTRBIT_LEASETIME		10
832 #define	NFSATTRBIT_RDATTRERROR		11
833 #define	NFSATTRBIT_ACL			12
834 #define	NFSATTRBIT_ACLSUPPORT		13
835 #define	NFSATTRBIT_ARCHIVE		14
836 #define	NFSATTRBIT_CANSETTIME		15
837 #define	NFSATTRBIT_CASEINSENSITIVE	16
838 #define	NFSATTRBIT_CASEPRESERVING	17
839 #define	NFSATTRBIT_CHOWNRESTRICTED	18
840 #define	NFSATTRBIT_FILEHANDLE		19
841 #define	NFSATTRBIT_FILEID		20
842 #define	NFSATTRBIT_FILESAVAIL		21
843 #define	NFSATTRBIT_FILESFREE		22
844 #define	NFSATTRBIT_FILESTOTAL		23
845 #define	NFSATTRBIT_FSLOCATIONS		24
846 #define	NFSATTRBIT_HIDDEN		25
847 #define	NFSATTRBIT_HOMOGENEOUS		26
848 #define	NFSATTRBIT_MAXFILESIZE		27
849 #define	NFSATTRBIT_MAXLINK		28
850 #define	NFSATTRBIT_MAXNAME		29
851 #define	NFSATTRBIT_MAXREAD		30
852 #define	NFSATTRBIT_MAXWRITE		31
853 #define	NFSATTRBIT_MIMETYPE		32
854 #define	NFSATTRBIT_MODE			33
855 #define	NFSATTRBIT_NOTRUNC		34
856 #define	NFSATTRBIT_NUMLINKS		35
857 #define	NFSATTRBIT_OWNER		36
858 #define	NFSATTRBIT_OWNERGROUP		37
859 #define	NFSATTRBIT_QUOTAHARD		38
860 #define	NFSATTRBIT_QUOTASOFT		39
861 #define	NFSATTRBIT_QUOTAUSED		40
862 #define	NFSATTRBIT_RAWDEV		41
863 #define	NFSATTRBIT_SPACEAVAIL		42
864 #define	NFSATTRBIT_SPACEFREE		43
865 #define	NFSATTRBIT_SPACETOTAL		44
866 #define	NFSATTRBIT_SPACEUSED		45
867 #define	NFSATTRBIT_SYSTEM		46
868 #define	NFSATTRBIT_TIMEACCESS		47
869 #define	NFSATTRBIT_TIMEACCESSSET	48
870 #define	NFSATTRBIT_TIMEBACKUP		49
871 #define	NFSATTRBIT_TIMECREATE		50
872 #define	NFSATTRBIT_TIMEDELTA		51
873 #define	NFSATTRBIT_TIMEMETADATA		52
874 #define	NFSATTRBIT_TIMEMODIFY		53
875 #define	NFSATTRBIT_TIMEMODIFYSET	54
876 #define	NFSATTRBIT_MOUNTEDONFILEID	55
877 #define	NFSATTRBIT_DIRNOTIFDELAY	56
878 #define	NFSATTRBIT_DIRENTNOTIFDELAY	57
879 #define	NFSATTRBIT_DACL			58
880 #define	NFSATTRBIT_SACL			59
881 #define	NFSATTRBIT_CHANGEPOLICY		60
882 #define	NFSATTRBIT_FSSTATUS		61
883 #define	NFSATTRBIT_FSLAYOUTTYPE		62
884 #define	NFSATTRBIT_LAYOUTHINT		63
885 #define	NFSATTRBIT_LAYOUTTYPE		64
886 #define	NFSATTRBIT_LAYOUTBLKSIZE	65
887 #define	NFSATTRBIT_LAYOUTALIGNMENT	66
888 #define	NFSATTRBIT_FSLOCATIONSINFO	67
889 #define	NFSATTRBIT_MDSTHRESHOLD		68
890 #define	NFSATTRBIT_RETENTIONGET		69
891 #define	NFSATTRBIT_RETENTIONSET		70
892 #define	NFSATTRBIT_RETENTEVTGET		71
893 #define	NFSATTRBIT_RETENTEVTSET		72
894 #define	NFSATTRBIT_RETENTIONHOLD	73
895 #define	NFSATTRBIT_MODESETMASKED	74
896 #define	NFSATTRBIT_SUPPATTREXCLCREAT	75
897 #define	NFSATTRBIT_FSCHARSETCAP		76
898 
899 #define	NFSATTRBM_SUPPORTEDATTRS	0x00000001
900 #define	NFSATTRBM_TYPE			0x00000002
901 #define	NFSATTRBM_FHEXPIRETYPE		0x00000004
902 #define	NFSATTRBM_CHANGE		0x00000008
903 #define	NFSATTRBM_SIZE			0x00000010
904 #define	NFSATTRBM_LINKSUPPORT		0x00000020
905 #define	NFSATTRBM_SYMLINKSUPPORT	0x00000040
906 #define	NFSATTRBM_NAMEDATTR		0x00000080
907 #define	NFSATTRBM_FSID			0x00000100
908 #define	NFSATTRBM_UNIQUEHANDLES		0x00000200
909 #define	NFSATTRBM_LEASETIME		0x00000400
910 #define	NFSATTRBM_RDATTRERROR		0x00000800
911 #define	NFSATTRBM_ACL			0x00001000
912 #define	NFSATTRBM_ACLSUPPORT		0x00002000
913 #define	NFSATTRBM_ARCHIVE		0x00004000
914 #define	NFSATTRBM_CANSETTIME		0x00008000
915 #define	NFSATTRBM_CASEINSENSITIVE	0x00010000
916 #define	NFSATTRBM_CASEPRESERVING	0x00020000
917 #define	NFSATTRBM_CHOWNRESTRICTED	0x00040000
918 #define	NFSATTRBM_FILEHANDLE		0x00080000
919 #define	NFSATTRBM_FILEID		0x00100000
920 #define	NFSATTRBM_FILESAVAIL		0x00200000
921 #define	NFSATTRBM_FILESFREE		0x00400000
922 #define	NFSATTRBM_FILESTOTAL		0x00800000
923 #define	NFSATTRBM_FSLOCATIONS		0x01000000
924 #define	NFSATTRBM_HIDDEN		0x02000000
925 #define	NFSATTRBM_HOMOGENEOUS		0x04000000
926 #define	NFSATTRBM_MAXFILESIZE		0x08000000
927 #define	NFSATTRBM_MAXLINK		0x10000000
928 #define	NFSATTRBM_MAXNAME		0x20000000
929 #define	NFSATTRBM_MAXREAD		0x40000000
930 #define	NFSATTRBM_MAXWRITE		0x80000000
931 #define	NFSATTRBM_MIMETYPE		0x00000001
932 #define	NFSATTRBM_MODE			0x00000002
933 #define	NFSATTRBM_NOTRUNC		0x00000004
934 #define	NFSATTRBM_NUMLINKS		0x00000008
935 #define	NFSATTRBM_OWNER			0x00000010
936 #define	NFSATTRBM_OWNERGROUP		0x00000020
937 #define	NFSATTRBM_QUOTAHARD		0x00000040
938 #define	NFSATTRBM_QUOTASOFT		0x00000080
939 #define	NFSATTRBM_QUOTAUSED		0x00000100
940 #define	NFSATTRBM_RAWDEV		0x00000200
941 #define	NFSATTRBM_SPACEAVAIL		0x00000400
942 #define	NFSATTRBM_SPACEFREE		0x00000800
943 #define	NFSATTRBM_SPACETOTAL		0x00001000
944 #define	NFSATTRBM_SPACEUSED		0x00002000
945 #define	NFSATTRBM_SYSTEM		0x00004000
946 #define	NFSATTRBM_TIMEACCESS		0x00008000
947 #define	NFSATTRBM_TIMEACCESSSET		0x00010000
948 #define	NFSATTRBM_TIMEBACKUP		0x00020000
949 #define	NFSATTRBM_TIMECREATE		0x00040000
950 #define	NFSATTRBM_TIMEDELTA		0x00080000
951 #define	NFSATTRBM_TIMEMETADATA		0x00100000
952 #define	NFSATTRBM_TIMEMODIFY		0x00200000
953 #define	NFSATTRBM_TIMEMODIFYSET		0x00400000
954 #define	NFSATTRBM_MOUNTEDONFILEID	0x00800000
955 #define	NFSATTRBM_DIRNOTIFDELAY		0x01000000
956 #define	NFSATTRBM_DIRENTNOTIFDELAY	0x02000000
957 #define	NFSATTRBM_DACL			0x04000000
958 #define	NFSATTRBM_SACL			0x08000000
959 #define	NFSATTRBM_CHANGEPOLICY		0x10000000
960 #define	NFSATTRBM_FSSTATUS		0x20000000
961 #define	NFSATTRBM_FSLAYOUTTYPE		0x40000000
962 #define	NFSATTRBM_LAYOUTHINT		0x80000000
963 #define	NFSATTRBM_LAYOUTTYPE		0x00000001
964 #define	NFSATTRBM_LAYOUTBLKSIZE		0x00000002
965 #define	NFSATTRBM_LAYOUTALIGNMENT	0x00000004
966 #define	NFSATTRBM_FSLOCATIONSINFO	0x00000008
967 #define	NFSATTRBM_MDSTHRESHOLD		0x00000010
968 #define	NFSATTRBM_RETENTIONGET		0x00000020
969 #define	NFSATTRBM_RETENTIONSET		0x00000040
970 #define	NFSATTRBM_RETENTEVTGET		0x00000080
971 #define	NFSATTRBM_RETENTEVTSET		0x00000100
972 #define	NFSATTRBM_RETENTIONHOLD		0x00000200
973 #define	NFSATTRBM_MODESETMASKED		0x00000400
974 #define	NFSATTRBM_SUPPATTREXCLCREAT	0x00000800
975 #define	NFSATTRBM_FSCHARSETCAP		0x00001000
976 
977 #define	NFSATTRBIT_MAX			77
978 
979 /*
980  * Sets of attributes that are supported, by words in the bitmap.
981  */
982 /*
983  * NFSATTRBIT_SUPPORTED - SUPP0 - bits 0<->31
984  *			  SUPP1 - bits 32<->63
985  *			  SUPP2 - bits 64<->95
986  */
987 #define	NFSATTRBIT_SUPP0						\
988  	(NFSATTRBM_SUPPORTEDATTRS |					\
989  	NFSATTRBM_TYPE |						\
990  	NFSATTRBM_FHEXPIRETYPE |					\
991  	NFSATTRBM_CHANGE |						\
992  	NFSATTRBM_SIZE |						\
993  	NFSATTRBM_LINKSUPPORT |						\
994  	NFSATTRBM_SYMLINKSUPPORT |					\
995  	NFSATTRBM_NAMEDATTR |						\
996  	NFSATTRBM_FSID |						\
997  	NFSATTRBM_UNIQUEHANDLES |					\
998  	NFSATTRBM_LEASETIME |						\
999  	NFSATTRBM_RDATTRERROR |						\
1000  	NFSATTRBM_ACL |							\
1001  	NFSATTRBM_ACLSUPPORT |						\
1002  	NFSATTRBM_CANSETTIME |						\
1003  	NFSATTRBM_CASEINSENSITIVE |					\
1004  	NFSATTRBM_CASEPRESERVING |					\
1005  	NFSATTRBM_CHOWNRESTRICTED |					\
1006  	NFSATTRBM_FILEHANDLE |						\
1007  	NFSATTRBM_FILEID |						\
1008  	NFSATTRBM_FILESAVAIL |						\
1009  	NFSATTRBM_FILESFREE |						\
1010  	NFSATTRBM_FILESTOTAL |						\
1011 	NFSATTRBM_FSLOCATIONS |						\
1012  	NFSATTRBM_HOMOGENEOUS |						\
1013  	NFSATTRBM_MAXFILESIZE |						\
1014  	NFSATTRBM_MAXLINK |						\
1015  	NFSATTRBM_MAXNAME |						\
1016  	NFSATTRBM_MAXREAD |						\
1017  	NFSATTRBM_MAXWRITE)
1018 
1019 /*
1020  * NFSATTRBIT_S1 - subset of SUPP1 - OR of the following bits:
1021  */
1022 #define	NFSATTRBIT_S1							\
1023  	(NFSATTRBM_MODE |						\
1024  	NFSATTRBM_NOTRUNC |						\
1025  	NFSATTRBM_NUMLINKS |						\
1026  	NFSATTRBM_OWNER |						\
1027  	NFSATTRBM_OWNERGROUP |						\
1028  	NFSATTRBM_RAWDEV |						\
1029  	NFSATTRBM_SPACEAVAIL |						\
1030  	NFSATTRBM_SPACEFREE |						\
1031  	NFSATTRBM_SPACETOTAL |						\
1032  	NFSATTRBM_SPACEUSED |						\
1033  	NFSATTRBM_TIMEACCESS |						\
1034  	NFSATTRBM_TIMEDELTA |						\
1035  	NFSATTRBM_TIMEMETADATA |					\
1036  	NFSATTRBM_TIMEMODIFY |						\
1037  	NFSATTRBM_MOUNTEDONFILEID |					\
1038 	NFSATTRBM_QUOTAHARD |                        			\
1039     	NFSATTRBM_QUOTASOFT |                        			\
1040     	NFSATTRBM_QUOTAUSED)
1041 
1042 
1043 #ifdef QUOTA
1044 /*
1045  * If QUOTA OR in NFSATTRBIT_QUOTAHARD, NFSATTRBIT_QUOTASOFT and
1046  * NFSATTRBIT_QUOTAUSED.
1047  */
1048 #define	NFSATTRBIT_SUPP1	(NFSATTRBIT_S1 |			\
1049 				NFSATTRBM_QUOTAHARD |			\
1050 				NFSATTRBM_QUOTASOFT |			\
1051 				NFSATTRBM_QUOTAUSED)
1052 #else
1053 #define	NFSATTRBIT_SUPP1	NFSATTRBIT_S1
1054 #endif
1055 
1056 #define	NFSATTRBIT_SUPP2	NFSATTRBM_SUPPATTREXCLCREAT
1057 
1058 /*
1059  * NFSATTRBIT_SUPPSETONLY is the OR of NFSATTRBIT_TIMEACCESSSET and
1060  * NFSATTRBIT_TIMEMODIFYSET.
1061  */
1062 #define	NFSATTRBIT_SUPPSETONLY	 (NFSATTRBM_TIMEACCESSSET |		\
1063 				 NFSATTRBM_TIMEMODIFYSET)
1064 
1065 /*
1066  * NFSATTRBIT_SETABLE - SETABLE0 - bits 0<->31
1067  *			SETABLE1 - bits 32<->63
1068  *			SETABLE2 - bits 64<->95
1069  */
1070 #define	NFSATTRBIT_SETABLE0						\
1071 	(NFSATTRBM_SIZE |						\
1072 	NFSATTRBM_ACL)
1073 #define	NFSATTRBIT_SETABLE1						\
1074  	(NFSATTRBM_MODE |						\
1075  	NFSATTRBM_OWNER |						\
1076  	NFSATTRBM_OWNERGROUP |						\
1077  	NFSATTRBM_TIMEACCESSSET |					\
1078  	NFSATTRBM_TIMEMODIFYSET)
1079 #define	NFSATTRBIT_SETABLE2		0
1080 
1081 /*
1082  * Set of attributes that the getattr vnode op needs.
1083  * OR of the following bits.
1084  * NFSATTRBIT_GETATTR0 - bits 0<->31
1085  */
1086 #define	NFSATTRBIT_GETATTR0						\
1087  	(NFSATTRBM_SUPPORTEDATTRS |					\
1088  	NFSATTRBM_TYPE |						\
1089  	NFSATTRBM_CHANGE |						\
1090  	NFSATTRBM_SIZE |						\
1091  	NFSATTRBM_FSID |						\
1092  	NFSATTRBM_FILEID |						\
1093  	NFSATTRBM_MAXREAD)
1094 
1095 /*
1096  * NFSATTRBIT_GETATTR1 - bits 32<->63
1097  */
1098 #define	NFSATTRBIT_GETATTR1						\
1099  	(NFSATTRBM_MODE |						\
1100  	NFSATTRBM_NUMLINKS |						\
1101  	NFSATTRBM_OWNER |						\
1102  	NFSATTRBM_OWNERGROUP |						\
1103  	NFSATTRBM_RAWDEV |						\
1104  	NFSATTRBM_SPACEUSED |						\
1105  	NFSATTRBM_TIMEACCESS |						\
1106  	NFSATTRBM_TIMEMETADATA |					\
1107  	NFSATTRBM_TIMEMODIFY)
1108 
1109 /*
1110  * NFSATTRBIT_GETATTR2 - bits 64<->95
1111  */
1112 #define	NFSATTRBIT_GETATTR2		0
1113 
1114 /*
1115  * Subset of the above that the Write RPC gets.
1116  * OR of the following bits.
1117  * NFSATTRBIT_WRITEGETATTR0 - bits 0<->31
1118  */
1119 #define	NFSATTRBIT_WRITEGETATTR0					\
1120  	(NFSATTRBM_SUPPORTEDATTRS |					\
1121  	NFSATTRBM_TYPE |						\
1122  	NFSATTRBM_CHANGE |						\
1123  	NFSATTRBM_SIZE |						\
1124  	NFSATTRBM_FSID |						\
1125  	NFSATTRBM_FILEID |						\
1126  	NFSATTRBM_MAXREAD)
1127 
1128 /*
1129  * NFSATTRBIT_WRITEGETATTR1 - bits 32<->63
1130  */
1131 #define	NFSATTRBIT_WRITEGETATTR1					\
1132  	(NFSATTRBM_MODE |						\
1133  	NFSATTRBM_NUMLINKS |						\
1134  	NFSATTRBM_RAWDEV |						\
1135  	NFSATTRBM_SPACEUSED |						\
1136  	NFSATTRBM_TIMEACCESS |						\
1137  	NFSATTRBM_TIMEMETADATA |					\
1138  	NFSATTRBM_TIMEMODIFY)
1139 
1140 /*
1141  * NFSATTRBIT_WRITEGETATTR2 - bits 64<->95
1142  */
1143 #define	NFSATTRBIT_WRITEGETATTR2	0
1144 
1145 /*
1146  * Set of attributes that the wccattr operation op needs.
1147  * OR of the following bits.
1148  * NFSATTRBIT_WCCATTR0 - bits 0<->31
1149  */
1150 #define	NFSATTRBIT_WCCATTR0	0
1151 
1152 /*
1153  * NFSATTRBIT_WCCATTR1 - bits 32<->63
1154  */
1155 #define	NFSATTRBIT_WCCATTR1						\
1156  	(NFSATTRBM_TIMEMODIFY)
1157 
1158 /*
1159  * NFSATTRBIT_WCCATTR2 - bits 64<->95
1160  */
1161 #define	NFSATTRBIT_WCCATTR2		0
1162 
1163 /*
1164  * NFSATTRBIT_CBGETATTR0 - bits 0<->31
1165  */
1166 #define	NFSATTRBIT_CBGETATTR0	(NFSATTRBM_CHANGE | NFSATTRBM_SIZE)
1167 
1168 /*
1169  * NFSATTRBIT_CBGETATTR1 - bits 32<->63
1170  */
1171 #define	NFSATTRBIT_CBGETATTR1		0x0
1172 
1173 /*
1174  * NFSATTRBIT_CBGETATTR2 - bits 64<->95
1175  */
1176 #define	NFSATTRBIT_CBGETATTR2		0x0
1177 
1178 /*
1179  * Sets of attributes that require a VFS_STATFS() call to get the
1180  * values of.
1181  * NFSATTRBIT_STATFS0 - bits 0<->31
1182  */
1183 #define	NFSATTRBIT_STATFS0						\
1184 	(NFSATTRBM_LINKSUPPORT |					\
1185 	NFSATTRBM_SYMLINKSUPPORT |					\
1186 	NFSATTRBM_CANSETTIME |						\
1187  	NFSATTRBM_FILESAVAIL |						\
1188  	NFSATTRBM_FILESFREE |						\
1189  	NFSATTRBM_FILESTOTAL |						\
1190  	NFSATTRBM_HOMOGENEOUS |						\
1191  	NFSATTRBM_MAXFILESIZE |						\
1192 	NFSATTRBM_MAXNAME |						\
1193 	NFSATTRBM_MAXREAD |						\
1194 	NFSATTRBM_MAXWRITE)
1195 
1196 /*
1197  * NFSATTRBIT_STATFS1 - bits 32<->63
1198  */
1199 #define	NFSATTRBIT_STATFS1						\
1200  	(NFSATTRBM_QUOTAHARD |						\
1201  	NFSATTRBM_QUOTASOFT |						\
1202  	NFSATTRBM_QUOTAUSED |						\
1203  	NFSATTRBM_SPACEAVAIL |						\
1204  	NFSATTRBM_SPACEFREE |						\
1205  	NFSATTRBM_SPACETOTAL |						\
1206  	NFSATTRBM_SPACEUSED |						\
1207 	NFSATTRBM_TIMEDELTA)
1208 
1209 /*
1210  * NFSATTRBIT_STATFS2 - bits 64<->95
1211  */
1212 #define	NFSATTRBIT_STATFS2		0
1213 
1214 /*
1215  * These are the bits that are needed by the nfs_statfs() call.
1216  * (The regular getattr bits are or'd in so the vnode gets the correct
1217  *  type, etc.)
1218  * NFSGETATTRBIT_STATFS0 - bits 0<->31
1219  */
1220 #define	NFSGETATTRBIT_STATFS0	(NFSATTRBIT_GETATTR0 |			\
1221 				NFSATTRBM_LINKSUPPORT |			\
1222 				NFSATTRBM_SYMLINKSUPPORT |		\
1223 				NFSATTRBM_CANSETTIME |			\
1224 				NFSATTRBM_FILESFREE |			\
1225 				NFSATTRBM_FILESTOTAL |			\
1226 				NFSATTRBM_HOMOGENEOUS |			\
1227 				NFSATTRBM_MAXFILESIZE |			\
1228 				NFSATTRBM_MAXNAME |			\
1229 				NFSATTRBM_MAXREAD |			\
1230 				NFSATTRBM_MAXWRITE)
1231 
1232 /*
1233  * NFSGETATTRBIT_STATFS1 - bits 32<->63
1234  */
1235 #define	NFSGETATTRBIT_STATFS1	(NFSATTRBIT_GETATTR1 |			\
1236 				NFSATTRBM_SPACEAVAIL |			\
1237 				NFSATTRBM_SPACEFREE |			\
1238 				NFSATTRBM_SPACETOTAL |			\
1239 				NFSATTRBM_TIMEDELTA)
1240 
1241 /*
1242  * NFSGETATTRBIT_STATFS2 - bits 64<->95
1243  */
1244 #define	NFSGETATTRBIT_STATFS2		0
1245 
1246 /*
1247  * Set of attributes for the equivalent of an nfsv3 pathconf rpc.
1248  * NFSGETATTRBIT_PATHCONF0 - bits 0<->31
1249  */
1250 #define	NFSGETATTRBIT_PATHCONF0	(NFSATTRBIT_GETATTR0 |			\
1251 			 	NFSATTRBM_CASEINSENSITIVE |		\
1252 			 	NFSATTRBM_CASEPRESERVING |		\
1253 			 	NFSATTRBM_CHOWNRESTRICTED |		\
1254 			 	NFSATTRBM_MAXLINK |			\
1255 			 	NFSATTRBM_MAXNAME)
1256 
1257 /*
1258  * NFSGETATTRBIT_PATHCONF1 - bits 32<->63
1259  */
1260 #define	NFSGETATTRBIT_PATHCONF1	(NFSATTRBIT_GETATTR1 |			\
1261 				NFSATTRBM_NOTRUNC)
1262 
1263 /*
1264  * NFSGETATTRBIT_PATHCONF2 - bits 64<->95
1265  */
1266 #define	NFSGETATTRBIT_PATHCONF2		0
1267 
1268 /*
1269  * Sets of attributes required by readdir and readdirplus.
1270  * NFSATTRBIT_READDIRPLUS0	(NFSATTRBIT_GETATTR0 | NFSATTRBIT_FILEHANDLE |
1271  *				 NFSATTRBIT_RDATTRERROR)
1272  */
1273 #define	NFSATTRBIT_READDIRPLUS0	(NFSATTRBIT_GETATTR0 | NFSATTRBM_FILEHANDLE | \
1274 				NFSATTRBM_RDATTRERROR)
1275 #define	NFSATTRBIT_READDIRPLUS1	NFSATTRBIT_GETATTR1
1276 #define	NFSATTRBIT_READDIRPLUS2		0
1277 
1278 /*
1279  * Set of attributes supported by Referral vnodes.
1280  */
1281 #define	NFSATTRBIT_REFERRAL0	(NFSATTRBM_TYPE | NFSATTRBM_FSID |	\
1282 	NFSATTRBM_RDATTRERROR | NFSATTRBM_FSLOCATIONS)
1283 #define	NFSATTRBIT_REFERRAL1	NFSATTRBM_MOUNTEDONFILEID
1284 #define	NFSATTRBIT_REFERRAL2		0
1285 
1286 /*
1287  * Structure for data handled by the statfs rpc. Since some fields are
1288  * u_int64_t, this cannot be used for copying data on/off the wire, due
1289  * to alignment concerns.
1290  */
1291 struct nfsstatfs {
1292 	union {
1293 		struct {
1294 			u_int32_t nfsv2sf_tsize;
1295 			u_int32_t nfsv2sf_bsize;
1296 			u_int32_t nfsv2sf_blocks;
1297 			u_int32_t nfsv2sf_bfree;
1298 			u_int32_t nfsv2sf_bavail;
1299 		} sf_nfsv2;
1300 		struct {
1301 			u_int64_t nfsv3sf_tbytes;
1302 			u_int64_t nfsv3sf_fbytes;
1303 			u_int64_t nfsv3sf_abytes;
1304 			u_int64_t nfsv3sf_tfiles;
1305 			u_int64_t nfsv3sf_ffiles;
1306 			u_int64_t nfsv3sf_afiles;
1307 			u_int32_t nfsv3sf_invarsec;
1308 		} sf_nfsv3;
1309 	} sf_un;
1310 };
1311 
1312 #define	sf_tsize	sf_un.sf_nfsv2.nfsv2sf_tsize
1313 #define	sf_bsize	sf_un.sf_nfsv2.nfsv2sf_bsize
1314 #define	sf_blocks	sf_un.sf_nfsv2.nfsv2sf_blocks
1315 #define	sf_bfree	sf_un.sf_nfsv2.nfsv2sf_bfree
1316 #define	sf_bavail	sf_un.sf_nfsv2.nfsv2sf_bavail
1317 #define	sf_tbytes	sf_un.sf_nfsv3.nfsv3sf_tbytes
1318 #define	sf_fbytes	sf_un.sf_nfsv3.nfsv3sf_fbytes
1319 #define	sf_abytes	sf_un.sf_nfsv3.nfsv3sf_abytes
1320 #define	sf_tfiles	sf_un.sf_nfsv3.nfsv3sf_tfiles
1321 #define	sf_ffiles	sf_un.sf_nfsv3.nfsv3sf_ffiles
1322 #define	sf_afiles	sf_un.sf_nfsv3.nfsv3sf_afiles
1323 #define	sf_invarsec	sf_un.sf_nfsv3.nfsv3sf_invarsec
1324 
1325 /*
1326  * Now defined using u_int64_t for the 64 bit field(s).
1327  * (Cannot be used to move data on/off the wire, due to alignment concerns.)
1328  */
1329 struct nfsfsinfo {
1330 	u_int32_t fs_rtmax;
1331 	u_int32_t fs_rtpref;
1332 	u_int32_t fs_rtmult;
1333 	u_int32_t fs_wtmax;
1334 	u_int32_t fs_wtpref;
1335 	u_int32_t fs_wtmult;
1336 	u_int32_t fs_dtpref;
1337 	u_int64_t fs_maxfilesize;
1338 	struct timespec fs_timedelta;
1339 	u_int32_t fs_properties;
1340 };
1341 
1342 /*
1343  * Bits for fs_properties
1344  */
1345 #define	NFSV3_FSFLINK		0x1
1346 #define	NFSV3_FSFSYMLINK	0x2
1347 #define	NFSV3_FSFHOMOGENEOUS	0x4
1348 #define	NFSV3_FSFCANSETTIME	0x8
1349 
1350 /*
1351  * Yikes, overload fs_rtmult as fs_maxname for V4.
1352  */
1353 #define	fs_maxname	fs_rtmult
1354 
1355 struct nfsv3_pathconf {
1356 	u_int32_t pc_linkmax;
1357 	u_int32_t pc_namemax;
1358 	u_int32_t pc_notrunc;
1359 	u_int32_t pc_chownrestricted;
1360 	u_int32_t pc_caseinsensitive;
1361 	u_int32_t pc_casepreserving;
1362 };
1363 
1364 /*
1365  * NFS V4 data structures.
1366  */
1367 struct nfsv4stateid {
1368 	u_int32_t	seqid;
1369 	u_int32_t	other[NFSX_STATEIDOTHER / NFSX_UNSIGNED];
1370 };
1371 typedef struct nfsv4stateid nfsv4stateid_t;
1372 
1373 #endif	/* _NFS_NFSPROTO_H_ */
1374