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