xref: /freebsd/sys/fs/nfs/nfsproto.h (revision cce64f2e68511652a0edc3e3482d801115e91b43)
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 
35 #ifndef _NFS_NFSPROTO_H_
36 #define	_NFS_NFSPROTO_H_
37 
38 /*
39  * nfs definitions as per the Version 2, 3 and 4 specs
40  */
41 
42 /*
43  * Constants as defined in the NFS Version 2, 3 and 4 specs.
44  * "NFS: Network File System Protocol Specification" RFC1094
45  * and in the "NFS: Network File System Version 3 Protocol
46  * Specification"
47  */
48 
49 #define	NFS_PORT	2049
50 #define	NFS_PROG	100003
51 #define	NFS_CALLBCKPROG	0x40000000	/* V4 only */
52 #define	NFS_VER2	2
53 #define	NFS_VER3	3
54 #define	NFS_VER4	4
55 #define	NFS_V2MAXDATA	8192
56 #define	NFS_MAXDGRAMDATA 16384
57 #define	NFS_MAXPATHLEN	1024
58 #define	NFS_MAXNAMLEN	255
59 /*
60  * Calculating the maximum XDR overhead for an NFS RPC isn't easy.
61  * NFS_MAXPKTHDR is antiquated and assumes AUTH_SYS over UDP.
62  * NFS_MAXXDR should be sufficient for all NFS versions over TCP.
63  * It includes:
64  * - Maximum RPC message header. It can include 2 400byte authenticators plus
65  *   a machine name of unlimited length, although it is usually relatively
66  *   small.
67  * - XDR overheads for the NFSv4 compound. This can include Owner and
68  *   Owner_group strings, which are usually fairly small, but are allowed
69  *   to be up to 1024 bytes each.
70  * 4096 is overkill, but should always be sufficient.
71  */
72 #define	NFS_MAXPKTHDR	404
73 #define	NFS_MAXXDR	4096
74 #define	NFS_MINPACKET	20
75 #define	NFS_FABLKSIZE	512	/* Size in bytes of a block wrt fa_blocks */
76 #define	NFSV4_MINORVERSION	0	/* V4 Minor version */
77 #define	NFSV41_MINORVERSION	1	/* V4 Minor version */
78 #define	NFSV42_MINORVERSION	2	/* V4 Minor version */
79 #define	NFSV4_CBVERS		1	/* V4 CB Version */
80 #define	NFSV41_CBVERS		4	/* V4.1 CB Version */
81 #define	NFSV4_SMALLSTR	50		/* Strings small enough for stack */
82 
83 /*
84  * This value isn't a fixed value in the RFCs.
85  * It is the maximum data size supported by NFSv3 or NFSv4 over TCP for
86  * the server.  It should be set to the I/O size preferred by ZFS or
87  * MAXBSIZE, whichever is greater.
88  * ZFS currently prefers 128K.
89  * It used to be called NFS_MAXDATA, but has been renamed to clarify that
90  * it refers to server side only and doesn't conflict with the NFS_MAXDATA
91  * defined in rpcsvc/nfs_prot.h for userland.
92  */
93 #define	NFS_SRVMAXIO	(128 * 1024)
94 
95 /* Stat numbers for rpc returns (version 2, 3 and 4) */
96 /*
97  * These numbers are hard-wired in the RFCs, so they can't be changed.
98  * The code currently assumes that the ones < 10000 are the same as
99  * sys/errno.h and that sys/errno.h will never go as high as 10000.
100  * If the value in sys/errno.h of any entry listed below is changed,
101  * the NFS code must be modified to do the mapping between them.
102  * (You can ignore NFSERR_WFLUSH, since it is never actually used.)
103  */
104 #define	NFSERR_OK		0
105 #define	NFSERR_PERM		1
106 #define	NFSERR_NOENT		2
107 #define	NFSERR_IO		5
108 #define	NFSERR_NXIO		6
109 #define	NFSERR_ACCES		13
110 #define	NFSERR_EXIST		17
111 #define	NFSERR_XDEV		18	/* Version 3, 4 only */
112 #define	NFSERR_NODEV		19
113 #define	NFSERR_NOTDIR		20
114 #define	NFSERR_ISDIR		21
115 #define	NFSERR_INVAL		22	/* Version 3, 4 only */
116 #define	NFSERR_FBIG		27
117 #define	NFSERR_NOSPC		28
118 #define	NFSERR_ROFS		30
119 #define	NFSERR_MLINK		31	/* Version 3, 4 only */
120 #define	NFSERR_NAMETOL		63
121 #define	NFSERR_NOTEMPTY		66
122 #define	NFSERR_DQUOT		69
123 #define	NFSERR_STALE		70
124 #define	NFSERR_REMOTE		71	/* Version 3 only */
125 #define	NFSERR_WFLUSH		99	/* Version 2 only */
126 #define	NFSERR_BADHANDLE	10001	/* These are Version 3, 4 only */
127 #define	NFSERR_NOT_SYNC		10002	/* Version 3 Only */
128 #define	NFSERR_BAD_COOKIE	10003
129 #define	NFSERR_NOTSUPP		10004
130 #define	NFSERR_TOOSMALL		10005
131 #define	NFSERR_SERVERFAULT	10006
132 #define	NFSERR_BADTYPE		10007
133 #define	NFSERR_DELAY		10008	/* Called NFSERR_JUKEBOX for V3 */
134 #define	NFSERR_SAME		10009	/* These are Version 4 only */
135 #define	NFSERR_DENIED		10010
136 #define	NFSERR_EXPIRED		10011
137 #define	NFSERR_LOCKED		10012
138 #define	NFSERR_GRACE		10013
139 #define	NFSERR_FHEXPIRED	10014
140 #define	NFSERR_SHAREDENIED	10015
141 #define	NFSERR_WRONGSEC		10016
142 #define	NFSERR_CLIDINUSE	10017
143 #define	NFSERR_RESOURCE		10018
144 #define	NFSERR_MOVED		10019
145 #define	NFSERR_NOFILEHANDLE	10020
146 #define	NFSERR_MINORVERMISMATCH	10021
147 #define	NFSERR_STALECLIENTID	10022
148 #define	NFSERR_STALESTATEID	10023
149 #define	NFSERR_OLDSTATEID	10024
150 #define	NFSERR_BADSTATEID	10025
151 #define	NFSERR_BADSEQID		10026
152 #define	NFSERR_NOTSAME		10027
153 #define	NFSERR_LOCKRANGE	10028
154 #define	NFSERR_SYMLINK		10029
155 #define	NFSERR_RESTOREFH	10030
156 #define	NFSERR_LEASEMOVED	10031
157 #define	NFSERR_ATTRNOTSUPP	10032
158 #define	NFSERR_NOGRACE		10033
159 #define	NFSERR_RECLAIMBAD	10034
160 #define	NFSERR_RECLAIMCONFLICT	10035
161 #define	NFSERR_BADXDR		10036
162 #define	NFSERR_LOCKSHELD	10037
163 #define	NFSERR_OPENMODE		10038
164 #define	NFSERR_BADOWNER		10039
165 #define	NFSERR_BADCHAR		10040
166 #define	NFSERR_BADNAME		10041
167 #define	NFSERR_BADRANGE		10042
168 #define	NFSERR_LOCKNOTSUPP	10043
169 #define	NFSERR_OPILLEGAL	10044
170 #define	NFSERR_DEADLOCK		10045
171 #define	NFSERR_FILEOPEN		10046
172 #define	NFSERR_ADMINREVOKED	10047
173 #define	NFSERR_CBPATHDOWN	10048
174 
175 /* NFSv4.1 specific errors. */
176 #define	NFSERR_BADIOMODE	10049
177 #define	NFSERR_BADLAYOUT	10050
178 #define	NFSERR_BADSESSIONDIGEST	10051
179 #define	NFSERR_BADSESSION	10052
180 #define	NFSERR_BADSLOT		10053
181 #define	NFSERR_COMPLETEALREADY	10054
182 #define	NFSERR_NOTBNDTOSESS	10055
183 #define	NFSERR_DELEGALREADYWANT	10056
184 #define	NFSERR_BACKCHANBUSY	10057
185 #define	NFSERR_LAYOUTTRYLATER	10058
186 #define	NFSERR_LAYOUTUNAVAIL	10059
187 #define	NFSERR_NOMATCHLAYOUT	10060
188 #define	NFSERR_RECALLCONFLICT	10061
189 #define	NFSERR_UNKNLAYOUTTYPE	10062
190 #define	NFSERR_SEQMISORDERED	10063
191 #define	NFSERR_SEQUENCEPOS	10064
192 #define	NFSERR_REQTOOBIG	10065
193 #define	NFSERR_REPTOOBIG	10066
194 #define	NFSERR_REPTOOBIGTOCACHE	10067
195 #define	NFSERR_RETRYUNCACHEDREP	10068
196 #define	NFSERR_UNSAFECOMPOUND	10069
197 #define	NFSERR_TOOMANYOPS	10070
198 #define	NFSERR_OPNOTINSESS	10071
199 #define	NFSERR_HASHALGUNSUPP	10072
200 #define	NFSERR_CLIENTIDBUSY	10074
201 #define	NFSERR_PNFSIOHOLE	10075
202 #define	NFSERR_SEQFALSERETRY	10076
203 #define	NFSERR_BADHIGHSLOT	10077
204 #define	NFSERR_DEADSESSION	10078
205 #define	NFSERR_ENCRALGUNSUPP	10079
206 #define	NFSERR_PNFSNOLAYOUT	10080
207 #define	NFSERR_NOTONLYOP	10081
208 #define	NFSERR_WRONGCRED	10082
209 #define	NFSERR_WRONGTYPE	10083
210 #define	NFSERR_DIRDELEGUNAVAIL	10084
211 #define	NFSERR_REJECTDELEG	10085
212 #define	NFSERR_RETURNCONFLICT	10086
213 #define	NFSERR_DELEGREVOKED	10087
214 
215 /* NFSv4.2 specific errors. */
216 #define	NFSERR_PARTNERNOTSUPP	10088
217 #define	NFSERR_PARTNERNOAUTH	10089
218 #define	NFSERR_UNIONNOTSUPP	10090
219 #define	NFSERR_OFFLOADDENIED	10091
220 #define	NFSERR_WRONGLFS		10092
221 #define	NFSERR_BADLABEL		10093
222 #define	NFSERR_OFFLOADNOREQS	10094
223 
224 /* NFSv4.2 Extended Attribute errors. */
225 #define	NFSERR_NOXATTR		10095
226 #define	NFSERR_XATTR2BIG	10096
227 
228 /* Maximum value of all the NFS error values. */
229 #define	NFSERR_MAXERRVAL	NFSERR_XATTR2BIG
230 
231 #define	NFSERR_STALEWRITEVERF	30001	/* Fake return for nfs_commit() */
232 #define	NFSERR_DONTREPLY	30003	/* Don't process request */
233 #define	NFSERR_RETVOID		30004	/* Return void, not error */
234 #define	NFSERR_REPLYFROMCACHE	30005	/* Reply from recent request cache */
235 #define	NFSERR_STALEDONTRECOVER	30006	/* Don't initiate recovery */
236 
237 #define	NFSERR_RPCERR		0x40000000 /* Mark an RPC layer error */
238 #define	NFSERR_AUTHERR		0x80000000 /* Mark an authentication error */
239 
240 #define	NFSERR_RPCMISMATCH	(NFSERR_RPCERR | RPC_MISMATCH)
241 #define	NFSERR_PROGUNAVAIL	(NFSERR_RPCERR | RPC_PROGUNAVAIL)
242 #define	NFSERR_PROGMISMATCH	(NFSERR_RPCERR | RPC_PROGMISMATCH)
243 #define	NFSERR_PROGNOTV4	(NFSERR_RPCERR | 0xffff)
244 #define	NFSERR_PROCUNAVAIL	(NFSERR_RPCERR | RPC_PROCUNAVAIL)
245 #define	NFSERR_GARBAGE		(NFSERR_RPCERR | RPC_GARBAGE)
246 
247 /* Sizes in bytes of various nfs rpc components */
248 #define	NFSX_UNSIGNED	4
249 #define	NFSX_HYPER	(2 * NFSX_UNSIGNED)
250 
251 /* specific to NFS Version 2 */
252 #define	NFSX_V2FH	32
253 #define	NFSX_V2FATTR	68
254 #define	NFSX_V2SATTR	32
255 #define	NFSX_V2COOKIE	4
256 #define	NFSX_V2STATFS	20
257 
258 /* specific to NFS Version 3 */
259 #define	NFSX_V3FHMAX		64	/* max. allowed by protocol */
260 #define	NFSX_V3FATTR		84
261 #define	NFSX_V3SATTR		60	/* max. all fields filled in */
262 #define	NFSX_V3SRVSATTR		(sizeof (struct nfsv3_sattr))
263 #define	NFSX_V3POSTOPATTR	(NFSX_V3FATTR + NFSX_UNSIGNED)
264 #define	NFSX_V3WCCDATA		(NFSX_V3POSTOPATTR + 8 * NFSX_UNSIGNED)
265 #define	NFSX_V3STATFS		52
266 #define	NFSX_V3FSINFO		48
267 #define	NFSX_V3PATHCONF		24
268 
269 /* specific to NFS Version 4 */
270 #define	NFSX_V4FHMAX		128
271 #define	NFSX_V4FSID		(2 * NFSX_HYPER)
272 #define	NFSX_V4SPECDATA		(2 * NFSX_UNSIGNED)
273 #define	NFSX_V4TIME		(NFSX_HYPER + NFSX_UNSIGNED)
274 #define	NFSX_V4SETTIME		(NFSX_UNSIGNED + NFSX_V4TIME)
275 #define	NFSX_V4SESSIONID	16
276 #define	NFSX_V4DEVICEID		16
277 #define	NFSX_V4PNFSFH		(sizeof(fhandle_t) + 1)
278 #define	NFSX_V4NAMEDDIRFH	2
279 #define	NFSX_V4NAMEDATTRFH	3
280 #define	NFSX_V4FILELAYOUT	(4 * NFSX_UNSIGNED + NFSX_V4DEVICEID +	\
281 				 NFSX_HYPER + NFSM_RNDUP(NFSX_V4PNFSFH))
282 #define	NFSX_V4FLEXLAYOUT(m)	(NFSX_HYPER + 3 * NFSX_UNSIGNED +		\
283     ((m) * (NFSX_V4DEVICEID + NFSX_STATEID + NFSM_RNDUP(NFSX_V4PNFSFH) +	\
284     8 * NFSX_UNSIGNED)))
285 
286 /* sizes common to multiple NFS versions */
287 #define	NFSX_FHMAX		(NFSX_V4FHMAX)
288 #define	NFSX_MYFH		(sizeof (fhandle_t)) /* size this server uses */
289 #define	NFSX_VERF 		8
290 #define	NFSX_STATEIDOTHER	12
291 #define	NFSX_STATEID		(NFSX_UNSIGNED + NFSX_STATEIDOTHER)
292 #define	NFSX_GSSH		12
293 
294 /* variants for multiple versions */
295 #define	NFSX_STATFS(v3)		((v3) ? NFSX_V3STATFS : NFSX_V2STATFS)
296 
297 /*
298  * Beware.  NFSPROC_NULL and friends are defined in
299  * <rpcsvc/nfs_prot.h> as well and the numbers are different.
300  */
301 #ifndef	NFSPROC_NULL
302 /* nfs rpc procedure numbers (before version mapping) */
303 #define	NFSPROC_NULL		0
304 #define	NFSPROC_GETATTR		1
305 #define	NFSPROC_SETATTR		2
306 #define	NFSPROC_LOOKUP		3
307 #define	NFSPROC_ACCESS		4
308 #define	NFSPROC_READLINK	5
309 #define	NFSPROC_READ		6
310 #define	NFSPROC_WRITE		7
311 #define	NFSPROC_CREATE		8
312 #define	NFSPROC_MKDIR		9
313 #define	NFSPROC_SYMLINK		10
314 #define	NFSPROC_MKNOD		11
315 #define	NFSPROC_REMOVE		12
316 #define	NFSPROC_RMDIR		13
317 #define	NFSPROC_RENAME		14
318 #define	NFSPROC_LINK		15
319 #define	NFSPROC_READDIR		16
320 #define	NFSPROC_READDIRPLUS	17
321 #define	NFSPROC_FSSTAT		18
322 #define	NFSPROC_FSINFO		19
323 #define	NFSPROC_PATHCONF	20
324 #define	NFSPROC_COMMIT		21
325 #endif	/* NFSPROC_NULL */
326 
327 /*
328  * The lower numbers -> 21 are used by NFSv2 and v3. These define higher
329  * numbers used by NFSv4.
330  * NFS_V3NPROCS is one greater than the last V3 op and NFS_NPROCS is
331  * one greater than the last number.
332  */
333 #ifndef	NFS_V3NPROCS
334 #define	NFS_V3NPROCS		22
335 
336 #define	NFSPROC_LOOKUPP		22
337 #define	NFSPROC_SETCLIENTID	23
338 #define	NFSPROC_SETCLIENTIDCFRM	24
339 #define	NFSPROC_LOCK		25
340 #define	NFSPROC_LOCKU		26
341 #define	NFSPROC_OPEN		27
342 #define	NFSPROC_CLOSE		28
343 #define	NFSPROC_OPENCONFIRM	29
344 #define	NFSPROC_LOCKT		30
345 #define	NFSPROC_OPENDOWNGRADE	31
346 #define	NFSPROC_RENEW		32
347 #define	NFSPROC_PUTROOTFH	33
348 #define	NFSPROC_RELEASELCKOWN	34
349 #define	NFSPROC_DELEGRETURN	35
350 #define	NFSPROC_RETDELEGREMOVE	36
351 #define	NFSPROC_RETDELEGRENAME1	37
352 #define	NFSPROC_RETDELEGRENAME2	38
353 #define	NFSPROC_GETACL		39
354 #define	NFSPROC_SETACL		40
355 
356 /*
357  * Must be defined as one higher than the last Proc# above.
358  */
359 #define	NFSV4_NPROCS		41
360 
361 /* Additional procedures for NFSv4.1. */
362 #define	NFSPROC_EXCHANGEID	41
363 #define	NFSPROC_CREATESESSION	42
364 #define	NFSPROC_DESTROYSESSION	43
365 #define	NFSPROC_DESTROYCLIENT	44
366 #define	NFSPROC_FREESTATEID	45
367 #define	NFSPROC_LAYOUTGET	46
368 #define	NFSPROC_GETDEVICEINFO	47
369 #define	NFSPROC_LAYOUTCOMMIT	48
370 #define	NFSPROC_LAYOUTRETURN	49
371 #define	NFSPROC_RECLAIMCOMPL	50
372 #define	NFSPROC_WRITEDS		51
373 #define	NFSPROC_READDS		52
374 #define	NFSPROC_COMMITDS	53
375 #define	NFSPROC_OPENLAYGET	54
376 #define	NFSPROC_CREATELAYGET	55
377 
378 /*
379  * Must be defined as one higher than the last NFSv4.1 Proc# above.
380  */
381 #define	NFSV41_NPROCS		56
382 
383 /* Additional procedures for NFSv4.2. */
384 #define	NFSPROC_IOADVISE	56
385 #define	NFSPROC_ALLOCATE	57
386 #define	NFSPROC_COPY		58
387 #define	NFSPROC_SEEK		59
388 #define	NFSPROC_SEEKDS		60
389 
390 /* and the ones for the optional Extended attribute support (RFC-8276). */
391 #define	NFSPROC_GETEXTATTR	61
392 #define	NFSPROC_SETEXTATTR	62
393 #define	NFSPROC_RMEXTATTR	63
394 #define	NFSPROC_LISTEXTATTR	64
395 
396 /* BindConnectionToSession, done by the krpc for a new connection. */
397 #define	NFSPROC_BINDCONNTOSESS	65
398 
399 /* Do a Lookup+Open for "oneopenown". */
400 #define	NFSPROC_LOOKUPOPEN	66
401 
402 /* Do an NFSv4.2 Deallocate. */
403 #define	NFSPROC_DEALLOCATE	67
404 
405 /* Do an NFSv4.2 LayoutError. */
406 #define	NFSPROC_LAYOUTERROR	68
407 
408 /* Do an NFSv4 Verify+Write. */
409 #define	NFSPROC_APPENDWRITE	69
410 
411 /* Do a NFSv4 Openattr. */
412 #define	NFSPROC_OPENATTR	70
413 
414 /* Do a NFSv4.2 Clone. */
415 #define	NFSPROC_CLONE		71
416 
417 /*
418  * Must be defined as one higher than the last NFSv4.2 Proc# above.
419  */
420 #define	NFSV42_NPROCS		72
421 
422 /* Value of NFSV42_NPROCS for old nfsstats structure. (Always 69) */
423 #define	NFSV42_OLDNPROCS	69
424 
425 #endif	/* NFS_V3NPROCS */
426 
427 /*
428  * Define NFS_NPROCS as NFSV4_NPROCS for the experimental kernel code.
429  */
430 #ifndef	NFS_NPROCS
431 #define	NFS_NPROCS		NFSV4_NPROCS
432 #endif
433 
434 /*
435  * NFSPROC_NOOP is a fake op# that can't be the same as any V2/3/4 Procedure
436  * or Operation#. Since the NFS V4 Op #s go higher, use NFSV42_NOPS, which
437  * is one greater than the highest Op#.
438  */
439 #define	NFSPROC_NOOP		NFSV42_NOPS
440 
441 /* Actual Version 2 procedure numbers */
442 #define	NFSV2PROC_NULL		0
443 #define	NFSV2PROC_GETATTR	1
444 #define	NFSV2PROC_SETATTR	2
445 #define	NFSV2PROC_NOOP		3
446 #define	NFSV2PROC_ROOT		NFSV2PROC_NOOP	/* Obsolete */
447 #define	NFSV2PROC_LOOKUP	4
448 #define	NFSV2PROC_READLINK	5
449 #define	NFSV2PROC_READ		6
450 #define	NFSV2PROC_WRITECACHE	NFSV2PROC_NOOP	/* Obsolete */
451 #define	NFSV2PROC_WRITE		8
452 #define	NFSV2PROC_CREATE	9
453 #define	NFSV2PROC_REMOVE	10
454 #define	NFSV2PROC_RENAME	11
455 #define	NFSV2PROC_LINK		12
456 #define	NFSV2PROC_SYMLINK	13
457 #define	NFSV2PROC_MKDIR		14
458 #define	NFSV2PROC_RMDIR		15
459 #define	NFSV2PROC_READDIR	16
460 #define	NFSV2PROC_STATFS	17
461 
462 /*
463  * V4 Procedure numbers
464  */
465 #define	NFSV4PROC_COMPOUND	1
466 #define	NFSV4PROC_CBNULL	0
467 #define	NFSV4PROC_CBCOMPOUND	1
468 
469 /*
470  * Constants used by the Version 3 and 4 protocols for various RPCs
471  */
472 #define	NFSV3SATTRTIME_DONTCHANGE	0
473 #define	NFSV3SATTRTIME_TOSERVER		1
474 #define	NFSV3SATTRTIME_TOCLIENT		2
475 
476 #define	NFSV4SATTRTIME_TOSERVER		0
477 #define	NFSV4SATTRTIME_TOCLIENT		1
478 
479 #define	NFSV4LOCKT_READ			1
480 #define	NFSV4LOCKT_WRITE		2
481 #define	NFSV4LOCKT_READW		3
482 #define	NFSV4LOCKT_WRITEW		4
483 #define	NFSV4LOCKT_RELEASE		5
484 
485 #define	NFSV4OPEN_NOCREATE		0
486 #define	NFSV4OPEN_CREATE		1
487 #define	NFSV4OPEN_CLAIMNULL		0
488 #define	NFSV4OPEN_CLAIMPREVIOUS		1
489 #define	NFSV4OPEN_CLAIMDELEGATECUR	2
490 #define	NFSV4OPEN_CLAIMDELEGATEPREV	3
491 #define	NFSV4OPEN_CLAIMFH		4
492 #define	NFSV4OPEN_CLAIMDELEGATECURFH	5
493 #define	NFSV4OPEN_CLAIMDELEGATEPREVFH	6
494 #define	NFSV4OPEN_DELEGATENONE		0
495 #define	NFSV4OPEN_DELEGATEREAD		1
496 #define	NFSV4OPEN_DELEGATEWRITE		2
497 #define	NFSV4OPEN_DELEGATENONEEXT	3
498 #define	NFSV4OPEN_LIMITSIZE		1
499 #define	NFSV4OPEN_LIMITBLOCKS		2
500 
501 /*
502  * Nfs V4 ACE stuff
503  */
504 #define	NFSV4ACE_ALLOWEDTYPE		0x00000000
505 #define	NFSV4ACE_DENIEDTYPE		0x00000001
506 #define	NFSV4ACE_AUDITTYPE		0x00000002
507 #define	NFSV4ACE_ALARMTYPE		0x00000003
508 
509 #define	NFSV4ACE_SUPALLOWED		0x00000001
510 #define	NFSV4ACE_SUPDENIED		0x00000002
511 #define	NFSV4ACE_SUPAUDIT		0x00000004
512 #define	NFSV4ACE_SUPALARM		0x00000008
513 
514 #define	NFSV4ACE_SUPTYPES	(NFSV4ACE_SUPALLOWED | NFSV4ACE_SUPDENIED)
515 
516 #define	NFSV4ACE_FILEINHERIT		0x00000001
517 #define	NFSV4ACE_DIRECTORYINHERIT	0x00000002
518 #define	NFSV4ACE_NOPROPAGATEINHERIT	0x00000004
519 #define	NFSV4ACE_INHERITONLY		0x00000008
520 #define	NFSV4ACE_SUCCESSFULACCESS	0x00000010
521 #define	NFSV4ACE_FAILEDACCESS		0x00000020
522 #define	NFSV4ACE_IDENTIFIERGROUP	0x00000040
523 
524 #define	NFSV4ACE_READDATA		0x00000001
525 #define	NFSV4ACE_LISTDIRECTORY		0x00000001
526 #define	NFSV4ACE_WRITEDATA		0x00000002
527 #define	NFSV4ACE_ADDFILE		0x00000002
528 #define	NFSV4ACE_APPENDDATA		0x00000004
529 #define	NFSV4ACE_ADDSUBDIRECTORY	0x00000004
530 #define	NFSV4ACE_READNAMEDATTR		0x00000008
531 #define	NFSV4ACE_WRITENAMEDATTR		0x00000010
532 #define	NFSV4ACE_EXECUTE		0x00000020
533 #define	NFSV4ACE_SEARCH			0x00000020
534 #define	NFSV4ACE_DELETECHILD		0x00000040
535 #define	NFSV4ACE_READATTRIBUTES		0x00000080
536 #define	NFSV4ACE_WRITEATTRIBUTES	0x00000100
537 #define	NFSV4ACE_DELETE			0x00010000
538 #define	NFSV4ACE_READACL		0x00020000
539 #define	NFSV4ACE_WRITEACL		0x00040000
540 #define	NFSV4ACE_WRITEOWNER		0x00080000
541 #define	NFSV4ACE_SYNCHRONIZE		0x00100000
542 
543 /*
544  * Here are the mappings between mode bits and acl mask bits for
545  * directories and other files.
546  * (Named attributes have not been included, since named attributes are
547  *  not yet supported.)
548  * The mailing list seems to indicate that NFSV4ACE_EXECUTE refers to
549  * searching a directory, although I can't find a statement of that in
550  * the RFC.
551  */
552 #define	NFSV4ACE_ALLFILESMASK	(NFSV4ACE_READATTRIBUTES | NFSV4ACE_READACL)
553 #define	NFSV4ACE_OWNERMASK	(NFSV4ACE_WRITEATTRIBUTES | NFSV4ACE_WRITEACL)
554 #define	NFSV4ACE_DIRREADMASK	NFSV4ACE_LISTDIRECTORY
555 #define	NFSV4ACE_DIREXECUTEMASK	NFSV4ACE_EXECUTE
556 #define	NFSV4ACE_DIRWRITEMASK	(NFSV4ACE_ADDFILE | 			\
557 		NFSV4ACE_ADDSUBDIRECTORY | NFSV4ACE_DELETECHILD)
558 #define	NFSV4ACE_READMASK	NFSV4ACE_READDATA
559 #define	NFSV4ACE_WRITEMASK	(NFSV4ACE_WRITEDATA | NFSV4ACE_APPENDDATA)
560 #define	NFSV4ACE_EXECUTEMASK	NFSV4ACE_EXECUTE
561 #define	NFSV4ACE_ALLFILEBITS	(NFSV4ACE_READMASK | NFSV4ACE_WRITEMASK | \
562 	NFSV4ACE_EXECUTEMASK | NFSV4ACE_SYNCHRONIZE)
563 #define	NFSV4ACE_ALLDIRBITS	(NFSV4ACE_DIRREADMASK | 		\
564 	NFSV4ACE_DIRWRITEMASK | NFSV4ACE_DIREXECUTEMASK)
565 #define	NFSV4ACE_AUDITMASK	0x0
566 
567 /*
568  * These GENERIC masks are not used and are no longer believed to be useful.
569  */
570 #define	NFSV4ACE_GENERICREAD		0x00120081
571 #define	NFSV4ACE_GENERICWRITE		0x00160106
572 #define	NFSV4ACE_GENERICEXECUTE		0x001200a0
573 
574 #define	NFSSTATEID_PUTALLZERO		0
575 #define	NFSSTATEID_PUTALLONE		1
576 #define	NFSSTATEID_PUTSTATEID		2
577 #define	NFSSTATEID_PUTSEQIDZERO		3
578 
579 /*
580  * Bits for share access and deny.
581  */
582 #define	NFSV4OPEN_ACCESSREAD		0x00000001
583 #define	NFSV4OPEN_ACCESSWRITE		0x00000002
584 #define	NFSV4OPEN_ACCESSBOTH		0x00000003
585 #define	NFSV4OPEN_WANTDELEGMASK		0x0000ff00
586 #define	NFSV4OPEN_WANTREADDELEG		0x00000100
587 #define	NFSV4OPEN_WANTWRITEDELEG	0x00000200
588 #define	NFSV4OPEN_WANTANYDELEG		0x00000300
589 #define	NFSV4OPEN_WANTNODELEG		0x00000400
590 #define	NFSV4OPEN_WANTCANCEL		0x00000500
591 #define	NFSV4OPEN_WANTSIGNALDELEG	0x00010000
592 #define	NFSV4OPEN_WANTPUSHDELEG		0x00020000
593 
594 #define	NFSV4OPEN_DENYNONE		0x00000000
595 #define	NFSV4OPEN_DENYREAD		0x00000001
596 #define	NFSV4OPEN_DENYWRITE		0x00000002
597 #define	NFSV4OPEN_DENYBOTH		0x00000003
598 
599 /*
600  * Delegate_none_ext reply values.
601  */
602 #define	NFSV4OPEN_NOTWANTED		0
603 #define	NFSV4OPEN_CONTENTION		1
604 #define	NFSV4OPEN_RESOURCE		2
605 #define	NFSV4OPEN_NOTSUPPFTYPE		3
606 #define	NFSV4OPEN_NOTSUPPWRITEFTYPE	4
607 #define	NFSV4OPEN_NOTSUPPUPGRADE	5
608 #define	NFSV4OPEN_NOTSUPPDOWNGRADE	6
609 #define	NFSV4OPEN_CANCELLED		7
610 #define	NFSV4OPEN_ISDIR			8
611 
612 /*
613  * Open result flags
614  * (The first four are in the spec. The rest are used internally.)
615  */
616 #define	NFSV4OPEN_RESULTCONFIRM		0x00000002
617 #define	NFSV4OPEN_LOCKTYPEPOSIX		0x00000004
618 #define	NFSV4OPEN_PRESERVEUNLINKED	0x00000008
619 #define	NFSV4OPEN_MAYNOTIFYLOCK		0x00000020
620 #define	NFSV4OPEN_RFLAGS 						\
621     (NFSV4OPEN_RESULTCONFIRM | NFSV4OPEN_LOCKTYPEPOSIX |		\
622     NFSV4OPEN_PRESERVEUNLINKED | NFSV4OPEN_MAYNOTIFYLOCK)
623 #define	NFSV4OPEN_RECALL		0x00010000
624 #define	NFSV4OPEN_READDELEGATE		0x00020000
625 #define	NFSV4OPEN_WRITEDELEGATE		0x00040000
626 #define	NFSV4OPEN_WDRESOURCE		0x00080000
627 #define	NFSV4OPEN_WDCONTENTION		0x00100000
628 #define	NFSV4OPEN_WDNOTWANTED		0x00200000
629 #define	NFSV4OPEN_WDSUPPFTYPE		0x00400000
630 #define	NFSV4OPEN_WDNOTSUPPDOWNGRADE	0x00800000
631 #define	NFSV4OPEN_WDNOTSUPPUPGRADE	0x01000000
632 
633 /*
634  * NFS V4 File Handle types
635  */
636 #define	NFSV4FHTYPE_PERSISTENT		0x0
637 #define	NFSV4FHTYPE_NOEXPIREWITHOPEN	0x1
638 #define	NFSV4FHTYPE_VOLATILEANY		0x2
639 #define	NFSV4FHTYPE_VOLATILEMIGRATE	0x4
640 #define	NFSV4FHTYPE_VOLATILERENAME	0x8
641 
642 /*
643  * Maximum size of V4 opaque strings.
644  */
645 #define	NFSV4_OPAQUELIMIT	1024
646 
647 /*
648  * These are the same for V3 and V4.
649  */
650 #define	NFSACCESS_READ			0x01
651 #define	NFSACCESS_LOOKUP		0x02
652 #define	NFSACCESS_MODIFY		0x04
653 #define	NFSACCESS_EXTEND		0x08
654 #define	NFSACCESS_DELETE		0x10
655 #define	NFSACCESS_EXECUTE		0x20
656 
657 /* Additional Extended Attribute access bits RFC-8276. */
658 #define	NFSACCESS_XAREAD		0x40
659 #define	NFSACCESS_XAWRITE		0x80
660 #define	NFSACCESS_XALIST		0x100
661 
662 #define	NFSWRITE_UNSTABLE		0
663 #define	NFSWRITE_DATASYNC		1
664 #define	NFSWRITE_FILESYNC		2
665 
666 #define	NFSCREATE_UNCHECKED		0
667 #define	NFSCREATE_GUARDED		1
668 #define	NFSCREATE_EXCLUSIVE		2
669 #define	NFSCREATE_EXCLUSIVE41		3
670 
671 #define	NFSV3FSINFO_LINK		0x01
672 #define	NFSV3FSINFO_SYMLINK		0x02
673 #define	NFSV3FSINFO_HOMOGENEOUS		0x08
674 #define	NFSV3FSINFO_CANSETTIME		0x10
675 
676 /* Flags for Exchange ID */
677 #define	NFSV4EXCH_SUPPMOVEDREFER	0x00000001
678 #define	NFSV4EXCH_SUPPMOVEDMIGR	0x00000002
679 #define	NFSV4EXCH_BINDPRINCSTATEID	0x00000100
680 #define	NFSV4EXCH_USENONPNFS		0x00010000
681 #define	NFSV4EXCH_USEPNFSMDS		0x00020000
682 #define	NFSV4EXCH_USEPNFSDS		0x00040000
683 #define	NFSV4EXCH_MASKPNFS		0x00070000
684 #define	NFSV4EXCH_UPDCONFIRMEDRECA	0x40000000
685 #define	NFSV4EXCH_CONFIRMEDR		0x80000000
686 
687 /* State Protects */
688 #define	NFSV4EXCH_SP4NONE		0
689 #define	NFSV4EXCH_SP4MACHCRED		1
690 #define	NFSV4EXCH_SP4SSV		2
691 
692 /* Flags for Create Session */
693 #define	NFSV4CRSESS_PERSIST		0x00000001
694 #define	NFSV4CRSESS_CONNBACKCHAN	0x00000002
695 #define	NFSV4CRSESS_CONNRDMA		0x00000004
696 
697 /* Flags for Sequence */
698 #define	NFSV4SEQ_CBPATHDOWN		0x00000001
699 #define	NFSV4SEQ_CBGSSCONTEXPIRING	0x00000002
700 #define	NFSV4SEQ_CBGSSCONTEXPIRED	0x00000004
701 #define	NFSV4SEQ_EXPIREDALLSTATEREVOKED	0x00000008
702 #define	NFSV4SEQ_EXPIREDSOMESTATEREVOKED 0x00000010
703 #define	NFSV4SEQ_ADMINSTATEREVOKED	0x00000020
704 #define	NFSV4SEQ_RECALLABLESTATEREVOKED	0x00000040
705 #define	NFSV4SEQ_LEASEMOVED		0x00000080
706 #define	NFSV4SEQ_RESTARTRECLAIMNEEDED	0x00000100
707 #define	NFSV4SEQ_CBPATHDOWNSESSION	0x00000200
708 #define	NFSV4SEQ_BACKCHANNELFAULT	0x00000400
709 #define	NFSV4SEQ_DEVIDCHANGED		0x00000800
710 #define	NFSV4SEQ_DEVIDDELETED		0x00001000
711 
712 /* Flags for Layout. */
713 #define	NFSLAYOUTRETURN_FILE		1
714 #define	NFSLAYOUTRETURN_FSID		2
715 #define	NFSLAYOUTRETURN_ALL		3
716 
717 #define	NFSLAYOUT_NFSV4_1_FILES		0x1
718 #define	NFSLAYOUT_OSD2_OBJECTS		0x2
719 #define	NFSLAYOUT_BLOCK_VOLUME		0x3
720 #define	NFSLAYOUT_FLEXFILE		0x4
721 
722 #define	NFSLAYOUTIOMODE_READ		1
723 #define	NFSLAYOUTIOMODE_RW		2
724 #define	NFSLAYOUTIOMODE_ANY		3
725 
726 /* Flags for Get Device Info. */
727 #define	NFSDEVICEIDNOTIFY_CHANGEBIT	0x1
728 #define	NFSDEVICEIDNOTIFY_DELETEBIT	0x2
729 
730 /* Flags for File Layout. */
731 #define	NFSFLAYUTIL_DENSE		0x1
732 #define	NFSFLAYUTIL_COMMIT_THRU_MDS	0x2
733 #define	NFSFLAYUTIL_IOADVISE_THRU_MDS	0x4
734 #define	NFSFLAYUTIL_STRIPE_MASK		0xffffffc0
735 
736 /* Flags for Flex File Layout. */
737 #define	NFSFLEXFLAG_NO_LAYOUTCOMMIT	0x00000001
738 #define	NFSFLEXFLAG_NOIO_MDS		0x00000002
739 #define	NFSFLEXFLAG_NO_READIO		0x00000004
740 #define	NFSFLEXFLAG_WRITE_ONEMIRROR	0x00000008
741 
742 /* Enum values for Bind Connection to Session. */
743 #define	NFSCDFC4_FORE		0x1
744 #define	NFSCDFC4_BACK		0x2
745 #define	NFSCDFC4_FORE_OR_BOTH	0x3
746 #define	NFSCDFC4_BACK_OR_BOTH	0x7
747 #define	NFSCDFS4_FORE		0x1
748 #define	NFSCDFS4_BACK		0x2
749 #define	NFSCDFS4_BOTH		0x3
750 
751 /* Enum values for Secinfo_no_name. */
752 #define	NFSSECINFONONAME_CURFH	0
753 #define	NFSSECINFONONAME_PARENT	1
754 
755 /* Bits for CB_RECALL_ANY. */
756 #define	NFSRCA4_RDATA_DLG	0x00000001
757 #define	NFSRCA4_WDATA_DLG	0x00000002
758 #define	NFSRCA4_DIR_DLG		0x00000004
759 #define	NFSRCA4_FILE_LAYOUT	0x00000008
760 #define	NFSRCA4_BLK_LAYOUT	0x00000010
761 #define	NFSRCA4_OBJ_LAYOUT_MIN	0x00000100
762 #define	NFSRCA4_OBJ_LAYOUT_MAX	0x00000200
763 #define	NFSRCA4_FF_LAYOUT_READ	0x00010000
764 #define	NFSRCA4_FF_LAYOUT_RW	0x00020000
765 
766 #if defined(_KERNEL) || defined(KERNEL)
767 /* Conversion macros */
768 #define	vtonfsv2_mode(t,m) 						\
769 		txdr_unsigned(((t) == VFIFO) ? MAKEIMODE(VCHR, (m)) : 	\
770 				MAKEIMODE((t), (m)))
771 #define	vtonfsv34_mode(m)	txdr_unsigned((m) & 07777)
772 #define	nfstov_mode(a)		(fxdr_unsigned(u_int16_t, (a))&07777)
773 #define	vtonfsv2_type(a)  (((u_int32_t)(a)) >= 9 ? txdr_unsigned(NFNON) : \
774 		txdr_unsigned(newnfsv2_type[((u_int32_t)(a))]))
775 #define	vtonfsv34_type(a)  (((u_int32_t)(a)) >= 9 ? txdr_unsigned(NFNON) : \
776 		txdr_unsigned(nfsv34_type[((u_int32_t)(a))]))
777 #define	nfsv2tov_type(a)	newnv2tov_type[fxdr_unsigned(u_int32_t,(a))&0x7]
778 #define	nfsv34tov_type(a)	nv34tov_type[fxdr_unsigned(u_int32_t,(a))&0x7]
779 #define	vtonfs_dtype(a)	(((u_int32_t)(a)) >= 9 ? IFTODT(VTTOIF(VNON)) : \
780 			 IFTODT(VTTOIF(a)))
781 
782 /* File types */
783 typedef enum { NFNON=0, NFREG=1, NFDIR=2, NFBLK=3, NFCHR=4, NFLNK=5,
784 	NFSOCK=6, NFFIFO=7, NFATTRDIR=8, NFNAMEDATTR=9 } nfstype;
785 
786 /* Structs for common parts of the rpc's */
787 
788 struct nfsv2_time {
789 	u_int32_t nfsv2_sec;
790 	u_int32_t nfsv2_usec;
791 };
792 typedef struct nfsv2_time	nfstime2;
793 
794 struct nfsv3_time {
795 	u_int32_t nfsv3_sec;
796 	u_int32_t nfsv3_nsec;
797 };
798 typedef struct nfsv3_time	nfstime3;
799 
800 struct nfsv4_time {
801 	u_int32_t nfsv4_highsec;
802 	u_int32_t nfsv4_sec;
803 	u_int32_t nfsv4_nsec;
804 };
805 typedef struct nfsv4_time	nfstime4;
806 
807 /*
808  * Quads are defined as arrays of 2 longs to ensure dense packing for the
809  * protocol and to facilitate xdr conversion.
810  */
811 struct nfs_uquad {
812 	u_int32_t nfsuquad[2];
813 };
814 typedef	struct nfs_uquad	nfsuint64;
815 
816 /*
817  * Used to convert between two u_longs and a u_quad_t.
818  */
819 union nfs_quadconvert {
820 	u_int32_t lval[2];
821 	u_quad_t  qval;
822 };
823 typedef union nfs_quadconvert	nfsquad_t;
824 
825 /*
826  * NFS Version 3 special file number.
827  */
828 struct nfsv3_spec {
829 	u_int32_t specdata1;
830 	u_int32_t specdata2;
831 };
832 typedef	struct nfsv3_spec	nfsv3spec;
833 
834 /*
835  * File attributes and setable attributes. These structures cover both
836  * NFS version 2 and the version 3 protocol. Note that the union is only
837  * used so that one pointer can refer to both variants. These structures
838  * go out on the wire and must be densely packed, so no quad data types
839  * are used. (all fields are longs or u_longs or structures of same)
840  * NB: You can't do sizeof(struct nfs_fattr), you must use the
841  *     NFSX_FATTR(v3) macro.
842  */
843 struct nfs_fattr {
844 	u_int32_t fa_type;
845 	u_int32_t fa_mode;
846 	u_int32_t fa_nlink;
847 	u_int32_t fa_uid;
848 	u_int32_t fa_gid;
849 	union {
850 		struct {
851 			u_int32_t nfsv2fa_size;
852 			u_int32_t nfsv2fa_blocksize;
853 			u_int32_t nfsv2fa_rdev;
854 			u_int32_t nfsv2fa_blocks;
855 			u_int32_t nfsv2fa_fsid;
856 			u_int32_t nfsv2fa_fileid;
857 			nfstime2  nfsv2fa_atime;
858 			nfstime2  nfsv2fa_mtime;
859 			nfstime2  nfsv2fa_ctime;
860 		} fa_nfsv2;
861 		struct {
862 			nfsuint64 nfsv3fa_size;
863 			nfsuint64 nfsv3fa_used;
864 			nfsv3spec nfsv3fa_rdev;
865 			nfsuint64 nfsv3fa_fsid;
866 			nfsuint64 nfsv3fa_fileid;
867 			nfstime3  nfsv3fa_atime;
868 			nfstime3  nfsv3fa_mtime;
869 			nfstime3  nfsv3fa_ctime;
870 		} fa_nfsv3;
871 	} fa_un;
872 };
873 
874 /* and some ugly defines for accessing union components */
875 #define	fa2_size		fa_un.fa_nfsv2.nfsv2fa_size
876 #define	fa2_blocksize		fa_un.fa_nfsv2.nfsv2fa_blocksize
877 #define	fa2_rdev		fa_un.fa_nfsv2.nfsv2fa_rdev
878 #define	fa2_blocks		fa_un.fa_nfsv2.nfsv2fa_blocks
879 #define	fa2_fsid		fa_un.fa_nfsv2.nfsv2fa_fsid
880 #define	fa2_fileid		fa_un.fa_nfsv2.nfsv2fa_fileid
881 #define	fa2_atime		fa_un.fa_nfsv2.nfsv2fa_atime
882 #define	fa2_mtime		fa_un.fa_nfsv2.nfsv2fa_mtime
883 #define	fa2_ctime		fa_un.fa_nfsv2.nfsv2fa_ctime
884 #define	fa3_size		fa_un.fa_nfsv3.nfsv3fa_size
885 #define	fa3_used		fa_un.fa_nfsv3.nfsv3fa_used
886 #define	fa3_rdev		fa_un.fa_nfsv3.nfsv3fa_rdev
887 #define	fa3_fsid		fa_un.fa_nfsv3.nfsv3fa_fsid
888 #define	fa3_fileid		fa_un.fa_nfsv3.nfsv3fa_fileid
889 #define	fa3_atime		fa_un.fa_nfsv3.nfsv3fa_atime
890 #define	fa3_mtime		fa_un.fa_nfsv3.nfsv3fa_mtime
891 #define	fa3_ctime		fa_un.fa_nfsv3.nfsv3fa_ctime
892 
893 #define	NFS_LINK_MAX	UINT32_MAX
894 
895 struct nfsv2_sattr {
896 	u_int32_t sa_mode;
897 	u_int32_t sa_uid;
898 	u_int32_t sa_gid;
899 	u_int32_t sa_size;
900 	nfstime2  sa_atime;
901 	nfstime2  sa_mtime;
902 };
903 
904 /*
905  * NFS Version 3 sattr structure for the new node creation case.
906  */
907 struct nfsv3_sattr {
908 	u_int32_t sa_modetrue;
909 	u_int32_t sa_mode;
910 	u_int32_t sa_uidfalse;
911 	u_int32_t sa_gidfalse;
912 	u_int32_t sa_sizefalse;
913 	u_int32_t sa_atimetype;
914 	nfstime3  sa_atime;
915 	u_int32_t sa_mtimetype;
916 	nfstime3  sa_mtime;
917 };
918 
919 /*
920  * IO Advise hint bits for NFSv4.2.
921  * Since these go on the wire as a bitmap, the NFSATTRBIT macros are
922  * used to manipulate these bits.
923  */
924 #define	NFSV4IOHINT_NORMAL		0
925 #define	NFSV4IOHINT_SEQUENTIAL		1
926 #define	NFSV4IOHINT_SEQUENTIALBACK	2
927 #define	NFSV4IOHINT_RANDOM		3
928 #define	NFSV4IOHINT_WILLNEED		4
929 #define	NFSV4IOHINT_WILLNEEDOPTUN	5
930 #define	NFSV4IOHINT_DONTNEED		6
931 #define	NFSV4IOHINT_NOREUSE		7
932 #define	NFSV4IOHINT_READ		8
933 #define	NFSV4IOHINT_WRITE		9
934 #define	NFSV4IOHINT_INITPROXIMITY	10
935 
936 #endif	/* _KERNEL */
937 
938 /*
939  * The attribute bits used for V4.
940  * NFSATTRBIT_xxx defines the attribute# (and its bit position)
941  * NFSATTRBM_xxx is a 32bit mask with the correct bit set within the
942  *	appropriate 32bit word.
943  * NFSATTRBIT_MAX is one greater than the largest NFSATTRBIT_xxx
944  */
945 #define	NFSATTRBIT_SUPPORTEDATTRS	0
946 #define	NFSATTRBIT_TYPE			1
947 #define	NFSATTRBIT_FHEXPIRETYPE		2
948 #define	NFSATTRBIT_CHANGE		3
949 #define	NFSATTRBIT_SIZE			4
950 #define	NFSATTRBIT_LINKSUPPORT		5
951 #define	NFSATTRBIT_SYMLINKSUPPORT	6
952 #define	NFSATTRBIT_NAMEDATTR		7
953 #define	NFSATTRBIT_FSID			8
954 #define	NFSATTRBIT_UNIQUEHANDLES	9
955 #define	NFSATTRBIT_LEASETIME		10
956 #define	NFSATTRBIT_RDATTRERROR		11
957 #define	NFSATTRBIT_ACL			12
958 #define	NFSATTRBIT_ACLSUPPORT		13
959 #define	NFSATTRBIT_ARCHIVE		14
960 #define	NFSATTRBIT_CANSETTIME		15
961 #define	NFSATTRBIT_CASEINSENSITIVE	16
962 #define	NFSATTRBIT_CASEPRESERVING	17
963 #define	NFSATTRBIT_CHOWNRESTRICTED	18
964 #define	NFSATTRBIT_FILEHANDLE		19
965 #define	NFSATTRBIT_FILEID		20
966 #define	NFSATTRBIT_FILESAVAIL		21
967 #define	NFSATTRBIT_FILESFREE		22
968 #define	NFSATTRBIT_FILESTOTAL		23
969 #define	NFSATTRBIT_FSLOCATIONS		24
970 #define	NFSATTRBIT_HIDDEN		25
971 #define	NFSATTRBIT_HOMOGENEOUS		26
972 #define	NFSATTRBIT_MAXFILESIZE		27
973 #define	NFSATTRBIT_MAXLINK		28
974 #define	NFSATTRBIT_MAXNAME		29
975 #define	NFSATTRBIT_MAXREAD		30
976 #define	NFSATTRBIT_MAXWRITE		31
977 #define	NFSATTRBIT_MIMETYPE		32
978 #define	NFSATTRBIT_MODE			33
979 #define	NFSATTRBIT_NOTRUNC		34
980 #define	NFSATTRBIT_NUMLINKS		35
981 #define	NFSATTRBIT_OWNER		36
982 #define	NFSATTRBIT_OWNERGROUP		37
983 #define	NFSATTRBIT_QUOTAHARD		38
984 #define	NFSATTRBIT_QUOTASOFT		39
985 #define	NFSATTRBIT_QUOTAUSED		40
986 #define	NFSATTRBIT_RAWDEV		41
987 #define	NFSATTRBIT_SPACEAVAIL		42
988 #define	NFSATTRBIT_SPACEFREE		43
989 #define	NFSATTRBIT_SPACETOTAL		44
990 #define	NFSATTRBIT_SPACEUSED		45
991 #define	NFSATTRBIT_SYSTEM		46
992 #define	NFSATTRBIT_TIMEACCESS		47
993 #define	NFSATTRBIT_TIMEACCESSSET	48
994 #define	NFSATTRBIT_TIMEBACKUP		49
995 #define	NFSATTRBIT_TIMECREATE		50
996 #define	NFSATTRBIT_TIMEDELTA		51
997 #define	NFSATTRBIT_TIMEMETADATA		52
998 #define	NFSATTRBIT_TIMEMODIFY		53
999 #define	NFSATTRBIT_TIMEMODIFYSET	54
1000 #define	NFSATTRBIT_MOUNTEDONFILEID	55
1001 #define	NFSATTRBIT_DIRNOTIFDELAY	56
1002 #define	NFSATTRBIT_DIRENTNOTIFDELAY	57
1003 #define	NFSATTRBIT_DACL			58
1004 #define	NFSATTRBIT_SACL			59
1005 #define	NFSATTRBIT_CHANGEPOLICY		60
1006 #define	NFSATTRBIT_FSSTATUS		61
1007 #define	NFSATTRBIT_FSLAYOUTTYPE		62
1008 #define	NFSATTRBIT_LAYOUTHINT		63
1009 #define	NFSATTRBIT_LAYOUTTYPE		64
1010 #define	NFSATTRBIT_LAYOUTBLKSIZE	65
1011 #define	NFSATTRBIT_LAYOUTALIGNMENT	66
1012 #define	NFSATTRBIT_FSLOCATIONSINFO	67
1013 #define	NFSATTRBIT_MDSTHRESHOLD		68
1014 #define	NFSATTRBIT_RETENTIONGET		69
1015 #define	NFSATTRBIT_RETENTIONSET		70
1016 #define	NFSATTRBIT_RETENTEVTGET		71
1017 #define	NFSATTRBIT_RETENTEVTSET		72
1018 #define	NFSATTRBIT_RETENTIONHOLD	73
1019 #define	NFSATTRBIT_MODESETMASKED	74
1020 #define	NFSATTRBIT_SUPPATTREXCLCREAT	75
1021 #define	NFSATTRBIT_FSCHARSETCAP		76
1022 #define	NFSATTRBIT_CLONEBLKSIZE		77
1023 #define	NFSATTRBIT_SPACEFREED		78
1024 #define	NFSATTRBIT_CHANGEATTRTYPE	79
1025 #define	NFSATTRBIT_SECLABEL		80
1026 #define	NFSATTRBIT_MODEUMASK		81
1027 #define	NFSATTRBIT_XATTRSUPPORT		82
1028 
1029 #define	NFSATTRBM_SUPPORTEDATTRS	0x00000001
1030 #define	NFSATTRBM_TYPE			0x00000002
1031 #define	NFSATTRBM_FHEXPIRETYPE		0x00000004
1032 #define	NFSATTRBM_CHANGE		0x00000008
1033 #define	NFSATTRBM_SIZE			0x00000010
1034 #define	NFSATTRBM_LINKSUPPORT		0x00000020
1035 #define	NFSATTRBM_SYMLINKSUPPORT	0x00000040
1036 #define	NFSATTRBM_NAMEDATTR		0x00000080
1037 #define	NFSATTRBM_FSID			0x00000100
1038 #define	NFSATTRBM_UNIQUEHANDLES		0x00000200
1039 #define	NFSATTRBM_LEASETIME		0x00000400
1040 #define	NFSATTRBM_RDATTRERROR		0x00000800
1041 #define	NFSATTRBM_ACL			0x00001000
1042 #define	NFSATTRBM_ACLSUPPORT		0x00002000
1043 #define	NFSATTRBM_ARCHIVE		0x00004000
1044 #define	NFSATTRBM_CANSETTIME		0x00008000
1045 #define	NFSATTRBM_CASEINSENSITIVE	0x00010000
1046 #define	NFSATTRBM_CASEPRESERVING	0x00020000
1047 #define	NFSATTRBM_CHOWNRESTRICTED	0x00040000
1048 #define	NFSATTRBM_FILEHANDLE		0x00080000
1049 #define	NFSATTRBM_FILEID		0x00100000
1050 #define	NFSATTRBM_FILESAVAIL		0x00200000
1051 #define	NFSATTRBM_FILESFREE		0x00400000
1052 #define	NFSATTRBM_FILESTOTAL		0x00800000
1053 #define	NFSATTRBM_FSLOCATIONS		0x01000000
1054 #define	NFSATTRBM_HIDDEN		0x02000000
1055 #define	NFSATTRBM_HOMOGENEOUS		0x04000000
1056 #define	NFSATTRBM_MAXFILESIZE		0x08000000
1057 #define	NFSATTRBM_MAXLINK		0x10000000
1058 #define	NFSATTRBM_MAXNAME		0x20000000
1059 #define	NFSATTRBM_MAXREAD		0x40000000
1060 #define	NFSATTRBM_MAXWRITE		0x80000000
1061 #define	NFSATTRBM_MIMETYPE		0x00000001
1062 #define	NFSATTRBM_MODE			0x00000002
1063 #define	NFSATTRBM_NOTRUNC		0x00000004
1064 #define	NFSATTRBM_NUMLINKS		0x00000008
1065 #define	NFSATTRBM_OWNER			0x00000010
1066 #define	NFSATTRBM_OWNERGROUP		0x00000020
1067 #define	NFSATTRBM_QUOTAHARD		0x00000040
1068 #define	NFSATTRBM_QUOTASOFT		0x00000080
1069 #define	NFSATTRBM_QUOTAUSED		0x00000100
1070 #define	NFSATTRBM_RAWDEV		0x00000200
1071 #define	NFSATTRBM_SPACEAVAIL		0x00000400
1072 #define	NFSATTRBM_SPACEFREE		0x00000800
1073 #define	NFSATTRBM_SPACETOTAL		0x00001000
1074 #define	NFSATTRBM_SPACEUSED		0x00002000
1075 #define	NFSATTRBM_SYSTEM		0x00004000
1076 #define	NFSATTRBM_TIMEACCESS		0x00008000
1077 #define	NFSATTRBM_TIMEACCESSSET		0x00010000
1078 #define	NFSATTRBM_TIMEBACKUP		0x00020000
1079 #define	NFSATTRBM_TIMECREATE		0x00040000
1080 #define	NFSATTRBM_TIMEDELTA		0x00080000
1081 #define	NFSATTRBM_TIMEMETADATA		0x00100000
1082 #define	NFSATTRBM_TIMEMODIFY		0x00200000
1083 #define	NFSATTRBM_TIMEMODIFYSET		0x00400000
1084 #define	NFSATTRBM_MOUNTEDONFILEID	0x00800000
1085 #define	NFSATTRBM_DIRNOTIFDELAY		0x01000000
1086 #define	NFSATTRBM_DIRENTNOTIFDELAY	0x02000000
1087 #define	NFSATTRBM_DACL			0x04000000
1088 #define	NFSATTRBM_SACL			0x08000000
1089 #define	NFSATTRBM_CHANGEPOLICY		0x10000000
1090 #define	NFSATTRBM_FSSTATUS		0x20000000
1091 #define	NFSATTRBM_FSLAYOUTTYPE		0x40000000
1092 #define	NFSATTRBM_LAYOUTHINT		0x80000000
1093 #define	NFSATTRBM_LAYOUTTYPE		0x00000001
1094 #define	NFSATTRBM_LAYOUTBLKSIZE		0x00000002
1095 #define	NFSATTRBM_LAYOUTALIGNMENT	0x00000004
1096 #define	NFSATTRBM_FSLOCATIONSINFO	0x00000008
1097 #define	NFSATTRBM_MDSTHRESHOLD		0x00000010
1098 #define	NFSATTRBM_RETENTIONGET		0x00000020
1099 #define	NFSATTRBM_RETENTIONSET		0x00000040
1100 #define	NFSATTRBM_RETENTEVTGET		0x00000080
1101 #define	NFSATTRBM_RETENTEVTSET		0x00000100
1102 #define	NFSATTRBM_RETENTIONHOLD		0x00000200
1103 #define	NFSATTRBM_MODESETMASKED		0x00000400
1104 #define	NFSATTRBM_SUPPATTREXCLCREAT	0x00000800
1105 #define	NFSATTRBM_FSCHARSETCAP		0x00001000
1106 #define	NFSATTRBM_CLONEBLKSIZE		0x00002000
1107 #define	NFSATTRBM_SPACEFREED		0x00004000
1108 #define	NFSATTRBM_CHANGEATTRTYPE	0x00008000
1109 #define	NFSATTRBM_SECLABEL		0x00010000
1110 #define	NFSATTRBM_MODEUMASK		0x00020000
1111 #define	NFSATTRBM_XATTRSUPPORT		0x00040000
1112 
1113 #define	NFSATTRBIT_MAX			83
1114 
1115 /*
1116  * Sets of attributes that are supported, by words in the bitmap.
1117  */
1118 /*
1119  * NFSATTRBIT_SUPPORTED - SUPP0 - bits 0<->31
1120  *			  SUPP1 - bits 32<->63
1121  *			  SUPP2 - bits 64<->95
1122  */
1123 #define	NFSATTRBIT_SUPP0						\
1124  	(NFSATTRBM_SUPPORTEDATTRS |					\
1125  	NFSATTRBM_TYPE |						\
1126  	NFSATTRBM_FHEXPIRETYPE |					\
1127  	NFSATTRBM_CHANGE |						\
1128  	NFSATTRBM_SIZE |						\
1129  	NFSATTRBM_LINKSUPPORT |						\
1130  	NFSATTRBM_SYMLINKSUPPORT |					\
1131  	NFSATTRBM_NAMEDATTR |						\
1132  	NFSATTRBM_FSID |						\
1133  	NFSATTRBM_UNIQUEHANDLES |					\
1134  	NFSATTRBM_LEASETIME |						\
1135  	NFSATTRBM_RDATTRERROR |						\
1136  	NFSATTRBM_ACL |							\
1137  	NFSATTRBM_ACLSUPPORT |						\
1138  	NFSATTRBM_CANSETTIME |						\
1139  	NFSATTRBM_CASEINSENSITIVE |					\
1140  	NFSATTRBM_CASEPRESERVING |					\
1141  	NFSATTRBM_CHOWNRESTRICTED |					\
1142  	NFSATTRBM_FILEHANDLE |						\
1143  	NFSATTRBM_FILEID |						\
1144  	NFSATTRBM_FILESAVAIL |						\
1145  	NFSATTRBM_FILESFREE |						\
1146  	NFSATTRBM_FILESTOTAL |						\
1147 	NFSATTRBM_FSLOCATIONS |						\
1148 	NFSATTRBM_HIDDEN |						\
1149  	NFSATTRBM_HOMOGENEOUS |						\
1150  	NFSATTRBM_MAXFILESIZE |						\
1151  	NFSATTRBM_MAXLINK |						\
1152  	NFSATTRBM_MAXNAME |						\
1153  	NFSATTRBM_MAXREAD |						\
1154  	NFSATTRBM_MAXWRITE)
1155 
1156 /*
1157  * NFSATTRBIT_S1 - subset of SUPP1 - OR of the following bits:
1158  */
1159 #define	NFSATTRBIT_S1							\
1160  	(NFSATTRBM_MODE |						\
1161  	NFSATTRBM_NOTRUNC |						\
1162  	NFSATTRBM_NUMLINKS |						\
1163  	NFSATTRBM_OWNER |						\
1164  	NFSATTRBM_OWNERGROUP |						\
1165  	NFSATTRBM_RAWDEV |						\
1166  	NFSATTRBM_SPACEAVAIL |						\
1167  	NFSATTRBM_SPACEFREE |						\
1168  	NFSATTRBM_SPACETOTAL |						\
1169  	NFSATTRBM_SPACEUSED |						\
1170 	NFSATTRBM_SYSTEM |						\
1171  	NFSATTRBM_TIMEACCESS |						\
1172  	NFSATTRBM_TIMECREATE |						\
1173  	NFSATTRBM_TIMEDELTA |						\
1174  	NFSATTRBM_TIMEMETADATA |					\
1175  	NFSATTRBM_TIMEMODIFY |						\
1176  	NFSATTRBM_MOUNTEDONFILEID |					\
1177 	NFSATTRBM_QUOTAHARD |                        			\
1178     	NFSATTRBM_QUOTASOFT |                        			\
1179     	NFSATTRBM_QUOTAUSED |						\
1180 	NFSATTRBM_FSLAYOUTTYPE)
1181 
1182 #ifdef QUOTA
1183 /*
1184  * If QUOTA OR in NFSATTRBIT_QUOTAHARD, NFSATTRBIT_QUOTASOFT and
1185  * NFSATTRBIT_QUOTAUSED.
1186  */
1187 #define	NFSATTRBIT_SUPP1	(NFSATTRBIT_S1 |			\
1188 				NFSATTRBM_QUOTAHARD |			\
1189 				NFSATTRBM_QUOTASOFT |			\
1190 				NFSATTRBM_QUOTAUSED)
1191 #else
1192 #define	NFSATTRBIT_SUPP1	NFSATTRBIT_S1
1193 #endif
1194 
1195 #define	NFSATTRBIT_SUPP2						\
1196 	(NFSATTRBM_LAYOUTTYPE |						\
1197 	NFSATTRBM_LAYOUTBLKSIZE |					\
1198 	NFSATTRBM_LAYOUTALIGNMENT |					\
1199 	NFSATTRBM_SUPPATTREXCLCREAT |					\
1200 	NFSATTRBM_CLONEBLKSIZE |					\
1201 	NFSATTRBM_CHANGEATTRTYPE |					\
1202 	NFSATTRBM_XATTRSUPPORT)
1203 
1204 /*
1205  * These are the set only attributes.
1206  */
1207 #define	NFSATTRBIT_SUPPSETONLY1	 (NFSATTRBM_TIMEACCESSSET |		\
1208 				 NFSATTRBM_TIMEMODIFYSET)
1209 #define	NFSATTRBIT_SUPPSETONLY2	(NFSATTRBM_MODESETMASKED |		\
1210 				 NFSATTRBM_MODEUMASK)
1211 
1212 /*
1213  * NFSATTRBIT_SETABLE - SETABLE0 - bits 0<->31
1214  *			SETABLE1 - bits 32<->63
1215  *			SETABLE2 - bits 64<->95
1216  */
1217 #define	NFSATTRBIT_SETABLE0						\
1218 	(NFSATTRBM_SIZE |						\
1219 	NFSATTRBM_HIDDEN |						\
1220 	NFSATTRBM_ACL)
1221 #define	NFSATTRBIT_SETABLE1						\
1222  	(NFSATTRBM_MODE |						\
1223  	NFSATTRBM_OWNER |						\
1224  	NFSATTRBM_OWNERGROUP |						\
1225 	NFSATTRBM_SYSTEM |						\
1226  	NFSATTRBM_TIMECREATE |						\
1227  	NFSATTRBM_TIMEACCESSSET |					\
1228  	NFSATTRBM_TIMEMODIFYSET)
1229 #define	NFSATTRBIT_SETABLE2						\
1230 	(NFSATTRBM_MODESETMASKED |					\
1231 	NFSATTRBM_MODEUMASK)
1232 
1233 /*
1234  * NFSATTRBIT_NFSV41 - Attributes only supported by NFSv4.1.
1235  */
1236 #define	NFSATTRBIT_NFSV41_1						\
1237 	(NFSATTRBM_FSLAYOUTTYPE)
1238 #define	NFSATTRBIT_NFSV41_2						\
1239 	(NFSATTRBM_LAYOUTTYPE |						\
1240 	NFSATTRBM_LAYOUTBLKSIZE |					\
1241 	NFSATTRBM_LAYOUTALIGNMENT |					\
1242 	NFSATTRBM_MODESETMASKED |					\
1243 	NFSATTRBM_SUPPATTREXCLCREAT)
1244 
1245 /*
1246  * NFSATTRBIT_NFSV42 - Attributes only supported by NFSv4.2.
1247  */
1248 #define	NFSATTRBIT_NFSV42_2						\
1249 	(NFSATTRBM_CLONEBLKSIZE |					\
1250 	NFSATTRBM_CHANGEATTRTYPE |					\
1251 	NFSATTRBM_XATTRSUPPORT |					\
1252 	NFSATTRBM_MODEUMASK)
1253 
1254 /*
1255  * Set of attributes that the getattr vnode op needs.
1256  * OR of the following bits.
1257  * NFSATTRBIT_GETATTR0 - bits 0<->31
1258  */
1259 #define	NFSATTRBIT_GETATTR0						\
1260  	(NFSATTRBM_SUPPORTEDATTRS |					\
1261  	NFSATTRBM_TYPE |						\
1262  	NFSATTRBM_CHANGE |						\
1263  	NFSATTRBM_SIZE |						\
1264  	NFSATTRBM_FSID |						\
1265  	NFSATTRBM_FILEID |						\
1266 	NFSATTRBM_HIDDEN |						\
1267  	NFSATTRBM_MAXREAD)
1268 
1269 /*
1270  * NFSATTRBIT_GETATTR1 - bits 32<->63
1271  */
1272 #define	NFSATTRBIT_GETATTR1						\
1273  	(NFSATTRBM_MODE |						\
1274  	NFSATTRBM_NUMLINKS |						\
1275  	NFSATTRBM_OWNER |						\
1276  	NFSATTRBM_OWNERGROUP |						\
1277  	NFSATTRBM_RAWDEV |						\
1278  	NFSATTRBM_SPACEUSED |						\
1279 	NFSATTRBM_SYSTEM |						\
1280  	NFSATTRBM_TIMEACCESS |						\
1281 	NFSATTRBM_TIMECREATE |						\
1282  	NFSATTRBM_TIMEMETADATA |					\
1283  	NFSATTRBM_TIMEMODIFY)
1284 
1285 /*
1286  * NFSATTRBIT_GETATTR2 - bits 64<->95
1287  */
1288 #define	NFSATTRBIT_GETATTR2		0
1289 
1290 /*
1291  * Subset of the above that the Write RPC gets.
1292  * OR of the following bits.
1293  * NFSATTRBIT_WRITEGETATTR0 - bits 0<->31
1294  */
1295 #define	NFSATTRBIT_WRITEGETATTR0					\
1296  	(NFSATTRBM_SUPPORTEDATTRS |					\
1297  	NFSATTRBM_TYPE |						\
1298  	NFSATTRBM_CHANGE |						\
1299  	NFSATTRBM_SIZE |						\
1300  	NFSATTRBM_FSID |						\
1301  	NFSATTRBM_FILEID |						\
1302 	NFSATTRBM_HIDDEN |						\
1303  	NFSATTRBM_MAXREAD)
1304 
1305 /*
1306  * NFSATTRBIT_WRITEGETATTR1 - bits 32<->63
1307  */
1308 #define	NFSATTRBIT_WRITEGETATTR1					\
1309  	(NFSATTRBM_MODE |						\
1310  	NFSATTRBM_NUMLINKS |						\
1311  	NFSATTRBM_RAWDEV |						\
1312  	NFSATTRBM_SPACEUSED |						\
1313 	NFSATTRBM_SYSTEM |						\
1314  	NFSATTRBM_TIMEACCESS |						\
1315 	NFSATTRBM_TIMECREATE |						\
1316  	NFSATTRBM_TIMEMETADATA |					\
1317  	NFSATTRBM_TIMEMODIFY)
1318 
1319 /*
1320  * NFSATTRBIT_WRITEGETATTR2 - bits 64<->95
1321  */
1322 #define	NFSATTRBIT_WRITEGETATTR2	0
1323 
1324 /*
1325  * Set of attributes that the wccattr operation op needs.
1326  * OR of the following bits.
1327  * NFSATTRBIT_WCCATTR0 - bits 0<->31
1328  */
1329 #define	NFSATTRBIT_WCCATTR0	0
1330 
1331 /*
1332  * NFSATTRBIT_WCCATTR1 - bits 32<->63
1333  */
1334 #define	NFSATTRBIT_WCCATTR1						\
1335  	(NFSATTRBM_TIMEMODIFY)
1336 
1337 /*
1338  * NFSATTRBIT_WCCATTR2 - bits 64<->95
1339  */
1340 #define	NFSATTRBIT_WCCATTR2		0
1341 
1342 /*
1343  * NFSATTRBIT_CBGETATTR0 - bits 0<->31
1344  */
1345 #define	NFSATTRBIT_CBGETATTR0	(NFSATTRBM_CHANGE | NFSATTRBM_SIZE)
1346 
1347 /*
1348  * NFSATTRBIT_CBGETATTR1 - bits 32<->63
1349  */
1350 #define	NFSATTRBIT_CBGETATTR1		0x0
1351 
1352 /*
1353  * NFSATTRBIT_CBGETATTR2 - bits 64<->95
1354  */
1355 #define	NFSATTRBIT_CBGETATTR2		0x0
1356 
1357 /*
1358  * Sets of attributes that require a VFS_STATFS() call to get the
1359  * values of.
1360  * NFSATTRBIT_STATFS0 - bits 0<->31
1361  */
1362 #define	NFSATTRBIT_STATFS0						\
1363 	(NFSATTRBM_LINKSUPPORT |					\
1364 	NFSATTRBM_SYMLINKSUPPORT |					\
1365 	NFSATTRBM_CANSETTIME |						\
1366  	NFSATTRBM_FILESAVAIL |						\
1367  	NFSATTRBM_FILESFREE |						\
1368  	NFSATTRBM_FILESTOTAL |						\
1369  	NFSATTRBM_HOMOGENEOUS |						\
1370  	NFSATTRBM_MAXFILESIZE |						\
1371 	NFSATTRBM_MAXNAME |						\
1372 	NFSATTRBM_MAXREAD |						\
1373 	NFSATTRBM_MAXWRITE)
1374 
1375 /*
1376  * NFSATTRBIT_STATFS1 - bits 32<->63
1377  */
1378 #define	NFSATTRBIT_STATFS1						\
1379  	(NFSATTRBM_QUOTAHARD |						\
1380  	NFSATTRBM_QUOTASOFT |						\
1381  	NFSATTRBM_QUOTAUSED |						\
1382  	NFSATTRBM_SPACEAVAIL |						\
1383  	NFSATTRBM_SPACEFREE |						\
1384  	NFSATTRBM_SPACETOTAL |						\
1385  	NFSATTRBM_SPACEUSED |						\
1386 	NFSATTRBM_TIMEDELTA)
1387 
1388 /*
1389  * NFSATTRBIT_STATFS2 - bits 64<->95
1390  */
1391 #define	NFSATTRBIT_STATFS2		0
1392 
1393 /*
1394  * These are the bits that are needed by the nfs_statfs() call.
1395  * (The regular getattr bits are or'd in so the vnode gets the correct
1396  *  type, etc.)
1397  * NFSGETATTRBIT_STATFS0 - bits 0<->31
1398  */
1399 #define	NFSGETATTRBIT_STATFS0	(NFSATTRBIT_GETATTR0 |			\
1400 				NFSATTRBM_LINKSUPPORT |			\
1401 				NFSATTRBM_SYMLINKSUPPORT |		\
1402 				NFSATTRBM_CANSETTIME |			\
1403 				NFSATTRBM_FILESFREE |			\
1404 				NFSATTRBM_FILESTOTAL |			\
1405 				NFSATTRBM_HOMOGENEOUS |			\
1406 				NFSATTRBM_MAXFILESIZE |			\
1407 				NFSATTRBM_MAXNAME |			\
1408 				NFSATTRBM_MAXREAD |			\
1409 				NFSATTRBM_MAXWRITE)
1410 
1411 /*
1412  * NFSGETATTRBIT_STATFS1 - bits 32<->63
1413  */
1414 #define	NFSGETATTRBIT_STATFS1	(NFSATTRBIT_GETATTR1 |			\
1415 				NFSATTRBM_SPACEAVAIL |			\
1416 				NFSATTRBM_SPACEFREE |			\
1417 				NFSATTRBM_SPACETOTAL |			\
1418 				NFSATTRBM_TIMEDELTA)
1419 
1420 /*
1421  * NFSGETATTRBIT_STATFS2 - bits 64<->95
1422  */
1423 #define	NFSGETATTRBIT_STATFS2	(NFSATTRBM_CLONEBLKSIZE)
1424 
1425 /*
1426  * Set of attributes for the equivalent of an nfsv3 pathconf rpc.
1427  * NFSGETATTRBIT_PATHCONF0 - bits 0<->31
1428  */
1429 #define	NFSGETATTRBIT_PATHCONF0	(NFSATTRBIT_GETATTR0 |			\
1430 				NFSATTRBM_NAMEDATTR |			\
1431 			 	NFSATTRBM_CASEINSENSITIVE |		\
1432 			 	NFSATTRBM_CASEPRESERVING |		\
1433 			 	NFSATTRBM_CHOWNRESTRICTED |		\
1434 			 	NFSATTRBM_MAXLINK |			\
1435 			 	NFSATTRBM_MAXNAME)
1436 
1437 /*
1438  * NFSGETATTRBIT_PATHCONF1 - bits 32<->63
1439  */
1440 #define	NFSGETATTRBIT_PATHCONF1	(NFSATTRBIT_GETATTR1 |			\
1441 				NFSATTRBM_NOTRUNC)
1442 
1443 /*
1444  * NFSGETATTRBIT_PATHCONF2 - bits 64<->95
1445  */
1446 #define	NFSGETATTRBIT_PATHCONF2	(NFSATTRBM_CLONEBLKSIZE)
1447 
1448 /*
1449  * Sets of attributes required by readdir and readdirplus.
1450  * NFSATTRBIT_READDIRPLUS0	(NFSATTRBIT_GETATTR0 | NFSATTRBIT_FILEHANDLE |
1451  *				 NFSATTRBIT_RDATTRERROR)
1452  */
1453 #define	NFSATTRBIT_READDIRPLUS0	(NFSATTRBIT_GETATTR0 | NFSATTRBM_FILEHANDLE | \
1454 				NFSATTRBM_RDATTRERROR)
1455 #define	NFSATTRBIT_READDIRPLUS1	NFSATTRBIT_GETATTR1
1456 #define	NFSATTRBIT_READDIRPLUS2		0
1457 
1458 /*
1459  * Set of attributes supported by Referral vnodes.
1460  */
1461 #define	NFSATTRBIT_REFERRAL0	(NFSATTRBM_TYPE | NFSATTRBM_FSID |	\
1462 	NFSATTRBM_RDATTRERROR | NFSATTRBM_FSLOCATIONS)
1463 #define	NFSATTRBIT_REFERRAL1	NFSATTRBM_MOUNTEDONFILEID
1464 #define	NFSATTRBIT_REFERRAL2		0
1465 
1466 /* Bits for the operations bitmaps. */
1467 #define	NFSV4OPBM_ACCESS		0x00000008
1468 #define	NFSV4OPBM_CLOSE			0x00000010
1469 #define	NFSV4OPBM_COMMIT		0x00000020
1470 #define	NFSV4OPBM_CREATE		0x00000040
1471 #define	NFSV4OPBM_DELEGPURGE		0x00000080
1472 #define	NFSV4OPBM_DELEGRETURN		0x00000100
1473 #define	NFSV4OPBM_GETATTR		0x00000200
1474 #define	NFSV4OPBM_GETFH			0x00000400
1475 #define	NFSV4OPBM_LINK			0x00000800
1476 #define	NFSV4OPBM_LOCK			0x00001000
1477 #define	NFSV4OPBM_LOCKT			0x00002000
1478 #define	NFSV4OPBM_LOCKU			0x00004000
1479 #define	NFSV4OPBM_LOOKUP		0x00008000
1480 #define	NFSV4OPBM_LOOKUPP		0x00010000
1481 #define	NFSV4OPBM_NVERIFY		0x00020000
1482 #define	NFSV4OPBM_OPEN			0x00040000
1483 #define	NFSV4OPBM_OPENATTR		0x00080000
1484 #define	NFSV4OPBM_OPENCONFIRM		0x00100000
1485 #define	NFSV4OPBM_OPENDOWNGRADE		0x00200000
1486 #define	NFSV4OPBM_PUTFH			0x00400000
1487 #define	NFSV4OPBM_PUTPUBFH		0x00800000
1488 #define	NFSV4OPBM_PUTROOTFH		0x01000000
1489 #define	NFSV4OPBM_READ			0x02000000
1490 #define	NFSV4OPBM_READDIR		0x04000000
1491 #define	NFSV4OPBM_READLINK		0x08000000
1492 #define	NFSV4OPBM_REMOVE		0x10000000
1493 #define	NFSV4OPBM_RENAME		0x20000000
1494 #define	NFSV4OPBM_RENEW			0x40000000
1495 #define	NFSV4OPBM_RESTOREFH		0x80000000
1496 #define	NFSV4OPBM_SAVEFH		0x00000001
1497 #define	NFSV4OPBM_SECINFO		0x00000002
1498 #define	NFSV4OPBM_SETATTR		0x00000004
1499 #define	NFSV4OPBM_SETCLIENTID		0x00000008
1500 #define	NFSV4OPBM_SETCLIENTIDCFRM	0x00000010
1501 #define	NFSV4OPBM_VERIFY		0x00000020
1502 #define	NFSV4OPBM_WRITE			0x00000040
1503 #define	NFSV4OPBM_RELEASELCKOWN		0x00000080
1504 #define	NFSV4OPBM_BACKCHANNELCTL	0x00000100
1505 #define	NFSV4OPBM_BINDCONNTOSESS	0x00000200
1506 #define	NFSV4OPBM_EXCHANGEID		0x00000400
1507 #define	NFSV4OPBM_CREATESESSION		0x00000800
1508 #define	NFSV4OPBM_DESTROYSESSION	0x00001000
1509 #define	NFSV4OPBM_FREESTATEID		0x00002000
1510 #define	NFSV4OPBM_GETDIRDELEG		0x00004000
1511 #define	NFSV4OPBM_GETDEVINFO		0x00008000
1512 #define	NFSV4OPBM_GETDEVLIST		0x00010000
1513 #define	NFSV4OPBM_LAYOUTCOMMIT		0x00020000
1514 #define	NFSV4OPBM_LAYOUTGET		0x00040000
1515 #define	NFSV4OPBM_LAYOUTRETURN		0x00080000
1516 #define	NFSV4OPBM_SECINFONONAME		0x00100000
1517 #define	NFSV4OPBM_SEQUENCE		0x00200000
1518 #define	NFSV4OPBM_SETSSV		0x00400000
1519 #define	NFSV4OPBM_TESTSTATEID		0x00800000
1520 #define	NFSV4OPBM_WANTDELEG		0x01000000
1521 #define	NFSV4OPBM_DESTROYCLIENTID	0x02000000
1522 #define	NFSV4OPBM_RECLAIMCOMPL		0x04000000
1523 #define	NFSV4OPBM_ALLOCATE		0x08000000
1524 #define	NFSV4OPBM_COPY			0x10000000
1525 #define	NFSV4OPBM_COPYNOTIFY		0x20000000
1526 #define	NFSV4OPBM_DEALLOCATE		0x40000000
1527 #define	NFSV4OPBM_IOADVISE		0x80000000
1528 #define	NFSV4OPBM_LAYOUTERROR		0x00000001
1529 #define	NFSV4OPBM_LAYOUTSTATS		0x00000002
1530 #define	NFSV4OPBM_OFFLOADCANCEL		0x00000004
1531 #define	NFSV4OPBM_OFFLOADSTATUS		0x00000008
1532 #define	NFSV4OPBM_READPLUS		0x00000010
1533 #define	NFSV4OPBM_SEEK			0x00000020
1534 #define	NFSV4OPBM_WRITESAME		0x00000040
1535 #define	NFSV4OPBM_CLONE			0x00000080
1536 #define	NFSV4OPBM_GETXATTR		0x00000100
1537 #define	NFSV4OPBM_SETXATTR		0x00000200
1538 #define	NFSV4OPBM_LISTXATTRS		0x00000400
1539 #define	NFSV4OPBM_REMOVEXATTR		0x00000800
1540 
1541 /*
1542  * The set of must and allow operations for SP4_MACH_CRED.  These are
1543  * the operations requested by the Linux NFSv4.1/4.2 client.
1544  * The must list is also the same ones listed in the RFC.
1545  */
1546 #define	NFSOPBIT_MUST0	NFSV4OP_DELEGPURGE
1547 
1548 #define	NFSOPBIT_MUST1							\
1549 	(NFSV4OPBM_BINDCONNTOSESS |					\
1550 	NFSV4OPBM_EXCHANGEID |						\
1551 	NFSV4OPBM_CREATESESSION |					\
1552 	NFSV4OPBM_DESTROYSESSION |					\
1553 	NFSV4OPBM_DESTROYCLIENTID)
1554 
1555 #define	NFSOPBIT_MUST2		0x0
1556 
1557 #define	NFSOPBIT_CLRNOTMUST(b) do {					\
1558 	(b)->bits[0] &= NFSOPBIT_MUST0;					\
1559 	(b)->bits[1] &= NFSOPBIT_MUST1;					\
1560 	(b)->bits[2] &= NFSOPBIT_MUST2;					\
1561     } while (0)
1562 
1563 #define	NFSOPBIT_ALLOWED0						\
1564 	(NFSV4OPBM_CLOSE |						\
1565 	NFSV4OPBM_COMMIT |						\
1566 	NFSV4OPBM_DELEGRETURN |						\
1567 	NFSV4OPBM_LOCKU |						\
1568 	NFSV4OPBM_OPENDOWNGRADE)
1569 
1570 #define	NFSOPBIT_ALLOWED1						\
1571 	(NFSV4OPBM_SECINFO |						\
1572 	NFSV4OPBM_WRITE |						\
1573 	NFSV4OPBM_FREESTATEID |						\
1574 	NFSV4OPBM_LAYOUTRETURN |					\
1575 	NFSV4OPBM_SECINFONONAME |					\
1576 	NFSV4OPBM_TESTSTATEID)
1577 
1578 #define	NFSOPBIT_ALLOWED2	0x0
1579 
1580 #define	NFSOPBIT_CLRNOTALLOWED(b) do {					\
1581 	(b)->bits[0] &= NFSOPBIT_ALLOWED0;				\
1582 	(b)->bits[1] &= NFSOPBIT_ALLOWED1;				\
1583 	(b)->bits[2] &= NFSOPBIT_ALLOWED2;				\
1584     } while (0)
1585 
1586 /*
1587  * Structure for data handled by the statfs rpc. Since some fields are
1588  * u_int64_t, this cannot be used for copying data on/off the wire, due
1589  * to alignment concerns.
1590  */
1591 struct nfsstatfs {
1592 	union {
1593 		struct {
1594 			u_int32_t nfsv2sf_tsize;
1595 			u_int32_t nfsv2sf_bsize;
1596 			u_int32_t nfsv2sf_blocks;
1597 			u_int32_t nfsv2sf_bfree;
1598 			u_int32_t nfsv2sf_bavail;
1599 		} sf_nfsv2;
1600 		struct {
1601 			u_int64_t nfsv3sf_tbytes;
1602 			u_int64_t nfsv3sf_fbytes;
1603 			u_int64_t nfsv3sf_abytes;
1604 			u_int64_t nfsv3sf_tfiles;
1605 			u_int64_t nfsv3sf_ffiles;
1606 			u_int64_t nfsv3sf_afiles;
1607 			u_int32_t nfsv3sf_invarsec;
1608 		} sf_nfsv3;
1609 	} sf_un;
1610 };
1611 
1612 #define	sf_tsize	sf_un.sf_nfsv2.nfsv2sf_tsize
1613 #define	sf_bsize	sf_un.sf_nfsv2.nfsv2sf_bsize
1614 #define	sf_blocks	sf_un.sf_nfsv2.nfsv2sf_blocks
1615 #define	sf_bfree	sf_un.sf_nfsv2.nfsv2sf_bfree
1616 #define	sf_bavail	sf_un.sf_nfsv2.nfsv2sf_bavail
1617 #define	sf_tbytes	sf_un.sf_nfsv3.nfsv3sf_tbytes
1618 #define	sf_fbytes	sf_un.sf_nfsv3.nfsv3sf_fbytes
1619 #define	sf_abytes	sf_un.sf_nfsv3.nfsv3sf_abytes
1620 #define	sf_tfiles	sf_un.sf_nfsv3.nfsv3sf_tfiles
1621 #define	sf_ffiles	sf_un.sf_nfsv3.nfsv3sf_ffiles
1622 #define	sf_afiles	sf_un.sf_nfsv3.nfsv3sf_afiles
1623 #define	sf_invarsec	sf_un.sf_nfsv3.nfsv3sf_invarsec
1624 
1625 /*
1626  * Now defined using u_int64_t for the 64 bit field(s).
1627  * (Cannot be used to move data on/off the wire, due to alignment concerns.)
1628  */
1629 struct nfsfsinfo {
1630 	u_int32_t fs_rtmax;
1631 	u_int32_t fs_rtpref;
1632 	u_int32_t fs_rtmult;
1633 	u_int32_t fs_wtmax;
1634 	u_int32_t fs_wtpref;
1635 	u_int32_t fs_wtmult;
1636 	u_int32_t fs_dtpref;
1637 	u_int64_t fs_maxfilesize;
1638 	struct timespec fs_timedelta;
1639 	u_int32_t fs_properties;
1640 };
1641 
1642 /*
1643  * Bits for fs_properties
1644  */
1645 #define	NFSV3_FSFLINK		0x1
1646 #define	NFSV3_FSFSYMLINK	0x2
1647 #define	NFSV3_FSFHOMOGENEOUS	0x4
1648 #define	NFSV3_FSFCANSETTIME	0x8
1649 
1650 /*
1651  * Yikes, overload fs_rtmult as fs_maxname for V4.
1652  */
1653 #define	fs_maxname	fs_rtmult
1654 
1655 struct nfsv3_pathconf {
1656 	u_int32_t pc_linkmax;
1657 	u_int32_t pc_namemax;
1658 	u_int32_t pc_notrunc;
1659 	u_int32_t pc_chownrestricted;
1660 	u_int32_t pc_caseinsensitive;
1661 	u_int32_t pc_casepreserving;
1662 };
1663 
1664 /*
1665  * NFS V4 data structures.
1666  */
1667 struct nfsv4stateid {
1668 	u_int32_t	seqid;
1669 	u_int32_t	other[NFSX_STATEIDOTHER / NFSX_UNSIGNED];
1670 };
1671 typedef struct nfsv4stateid nfsv4stateid_t;
1672 
1673 /* Notify bits and notify bitmap size. */
1674 #define	NFSV4NOTIFY_CHANGE	1
1675 #define	NFSV4NOTIFY_DELETE	2
1676 #define	NFSV4_NOTIFYBITMAP	1	/* # of 32bit values needed for bits */
1677 
1678 /* Layoutreturn kinds. */
1679 #define	NFSV4LAYOUTRET_FILE	1
1680 #define	NFSV4LAYOUTRET_FSID	2
1681 #define	NFSV4LAYOUTRET_ALL	3
1682 
1683 /* Seek Contents. */
1684 #define	NFSV4CONTENT_DATA	0
1685 #define	NFSV4CONTENT_HOLE	1
1686 
1687 /* Options for Set Extended attribute (RFC-8276). */
1688 #define	NFSV4SXATTR_EITHER	0
1689 #define	NFSV4SXATTR_CREATE	1
1690 #define	NFSV4SXATTR_REPLACE	2
1691 
1692 /* Values for ChangeAttrType (RFC-7862). */
1693 #define	NFSV4CHANGETYPE_MONOTONIC_INCR		0
1694 #define	NFSV4CHANGETYPE_VERS_COUNTER		1
1695 #define	NFSV4CHANGETYPE_VERS_COUNTER_NOPNFS	2
1696 #define	NFSV4CHANGETYPE_TIME_METADATA		3
1697 #define	NFSV4CHANGETYPE_UNDEFINED		4
1698 
1699 #endif	/* _NFS_NFSPROTO_H_ */
1700