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