xref: /freebsd/sys/nfs/nfsproto.h (revision 69d94f4c7608e41505996559367450706e91fbb8)
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  *	@(#)nfsproto.h  8.2 (Berkeley) 3/30/95
35  * $FreeBSD$
36  */
37 
38 #ifndef _NFS_NFSPROTO_H_
39 #define _NFS_NFSPROTO_H_
40 
41 /*
42  * nfs definitions as per the Version 2 and 3 specs
43  */
44 
45 /*
46  * Constants as defined in the Sun NFS Version 2 and 3 specs.
47  * "NFS: Network File System Protocol Specification" RFC1094
48  * and in the "NFS: Network File System Version 3 Protocol
49  * Specification"
50  */
51 
52 #define NFS_PORT	2049
53 #define	NFS_PROG	100003
54 #define NFS_VER2	2
55 #define	NFS_VER3	3
56 #define NFS_VER4	4
57 
58 #define NFS_V2MAXDATA	8192
59 #define	NFS_MAXDGRAMDATA 16384
60 #define	NFS_MAXDATA	32768
61 #define	NFS_MAXPATHLEN	1024
62 #define	NFS_MAXNAMLEN	255
63 #define	NFS_MAXPKTHDR	404	/* XXXv4 this needs to be adjust for v4 */
64 #define NFS_MAXPACKET	(NFS_MAXPKTHDR + NFS_MAXDATA)
65 #define	NFS_MINPACKET	20
66 #define	NFS_FABLKSIZE	512	/* Size in bytes of a block wrt fa_blocks */
67 
68 /* Stat numbers for rpc returns (version 2, 3 and 4) */
69 #define	NFS_OK			0
70 #define	NFSERR_PERM		1
71 #define	NFSERR_NOENT		2
72 #define	NFSERR_IO		5
73 #define	NFSERR_NXIO		6
74 #define	NFSERR_ACCES		13
75 #define	NFSERR_EXIST		17
76 #define	NFSERR_XDEV		18	/* Version 3 only */
77 #define	NFSERR_NODEV		19
78 #define	NFSERR_NOTDIR		20
79 #define	NFSERR_ISDIR		21
80 #define	NFSERR_INVAL		22	/* Version 3 only */
81 #define	NFSERR_FBIG		27
82 #define	NFSERR_NOSPC		28
83 #define	NFSERR_ROFS		30
84 #define	NFSERR_MLINK		31	/* Version 3 only */
85 #define	NFSERR_NAMETOL		63
86 #define	NFSERR_NOTEMPTY		66
87 #define	NFSERR_DQUOT		69
88 #define	NFSERR_STALE		70
89 #define	NFSERR_REMOTE		71	/* Version 3 only */
90 #define	NFSERR_WFLUSH		99	/* Version 2 only */
91 #define	NFSERR_BADHANDLE	10001	/* The rest Version 3, 4 only */
92 #define	NFSERR_NOT_SYNC		10002
93 #define	NFSERR_BAD_COOKIE	10003
94 #define	NFSERR_NOTSUPP		10004
95 #define	NFSERR_TOOSMALL		10005
96 #define	NFSERR_SERVERFAULT	10006
97 #define	NFSERR_BADTYPE		10007
98 #define	NFSERR_JUKEBOX		10008
99 #define NFSERR_TRYLATER		NFSERR_JUKEBOX
100 #define	NFSERR_SAME		10009   /* The rest Version 4 only */
101 #define	NFSERR_DENIED		10010
102 #define	NFSERR_EXPIRED		10011
103 #define	NFSERR_LOCKED		10012
104 #define	NFSERR_GRACE		10013
105 #define	NFSERR_FHEXPIRED	10014
106 #define	NFSERR_SHARDE_DENIED	10015
107 #define	NFSERR_WRONGSEC		10016
108 #define	NFSERR_CLID_INUSE	10017
109 #define	NFSERR_RESOURCE		10018
110 #define	NFSERR_MOVED		10019
111 #define	NFSERR_NOFILEHANDLE	10020
112 #define	NFSERR_MINOR_VERS_MISMATCH 10021
113 #define	NFSERR_STALE_CLIENTID	10022
114 #define	NFSERR_STALE_STATEID	10023
115 #define	NFSERR_OLD_STATEID	10024
116 #define	NFSERR_BAD_STATEID	10025
117 #define	NFSERR_BAD_SEQID	10026
118 #define	NFSERR_NOT_SAME		10027
119 #define	NFSERR_LOCK_RANGE	10028
120 #define	NFSERR_SYMLINK		10029
121 #define	NFSERR_READDIR_NOSPC	10030
122 #define	NFSERR_LEASE_MOVED	10031
123 #define	NFSERR_ATTRNOTSUPP	10032
124 #define	NFSERR_NO_GRACE		10033
125 #define	NFSERR_RECLAIM_BAD	10034
126 #define	NFSERR_RECLAIM_CONFLICT	10035
127 #define	NFSERR_BADXDR		10036
128 #define	NFSERR_LOCKS_HELD	10037
129 #define	NFSERR_OPENMODE		10038
130 #define	NFSERR_BADOWNER		10039
131 #define	NFSERR_BADCHAR		10040
132 #define	NFSERR_BADNAME		10041
133 #define	NFSERR_BAD_RANGE	10042
134 #define	NFSERR_LOCK_NOTSUPP	10043
135 #define	NFSERR_OP_ILLEGAL	10044
136 #define	NFSERR_DEADLOCK		10045
137 #define	NFSERR_FILE_OPEN	10046
138 #define	NFSERR_STALEWRITEVERF	30001	/* Fake return for nfs_commit() */
139 
140 #define NFSERR_RETVOID		0x20000000 /* Return void, not error */
141 #define NFSERR_AUTHERR		0x40000000 /* Mark an authentication error */
142 #define NFSERR_RETERR		0x80000000 /* Mark an error return for V3 */
143 
144 /* Sizes in bytes of various nfs rpc components */
145 #define	NFSX_UNSIGNED	4
146 
147 /* specific to NFS Version 2 */
148 #define	NFSX_V2FH	32
149 #define	NFSX_V2FATTR	68
150 #define	NFSX_V2SATTR	32
151 #define	NFSX_V2COOKIE	4
152 #define NFSX_V2STATFS	20
153 
154 /* specific to NFS Version 3 */
155 #define NFSX_V3FH		(sizeof (fhandle_t)) /* size this server uses */
156 #define	NFSX_V3FHMAX		64	/* max. allowed by protocol */
157 #define NFSX_V3FATTR		84
158 #define NFSX_V3SATTR		60	/* max. all fields filled in */
159 #define NFSX_V3SRVSATTR		(sizeof (struct nfsv3_sattr))
160 #define NFSX_V3POSTOPATTR	(NFSX_V3FATTR + NFSX_UNSIGNED)
161 #define NFSX_V3WCCDATA		(NFSX_V3POSTOPATTR + 8 * NFSX_UNSIGNED)
162 #define NFSX_V3COOKIEVERF 	8
163 #define NFSX_V3WRITEVERF 	8
164 #define NFSX_V3CREATEVERF	8
165 #define NFSX_V3STATFS		52
166 #define NFSX_V3FSINFO		48
167 #define NFSX_V3PATHCONF		24
168 
169 /* specific to NFS Version 4 */
170 #define NFSX_V4VERF		8
171 #define NFSX_V4FH		128
172 #define NFSX_V4STATEID		16
173 
174 /* variants for both versions */
175 #define NFSX_FH(v3)		((v3) ? (NFSX_V3FHMAX + NFSX_UNSIGNED) : \
176 					NFSX_V2FH)
177 #define NFSX_SRVFH(v3)		((v3) ? NFSX_V3FH : NFSX_V2FH)
178 #define	NFSX_FATTR(v3)		((v3) ? NFSX_V3FATTR : NFSX_V2FATTR)
179 #define NFSX_PREOPATTR(v3)	((v3) ? (7 * NFSX_UNSIGNED) : 0)
180 #define NFSX_POSTOPATTR(v3)	((v3) ? (NFSX_V3FATTR + NFSX_UNSIGNED) : 0)
181 #define NFSX_POSTOPORFATTR(v3)	((v3) ? (NFSX_V3FATTR + NFSX_UNSIGNED) : \
182 					NFSX_V2FATTR)
183 #define NFSX_WCCDATA(v3)	((v3) ? NFSX_V3WCCDATA : 0)
184 #define NFSX_WCCORFATTR(v3)	((v3) ? NFSX_V3WCCDATA : NFSX_V2FATTR)
185 #define	NFSX_SATTR(v3)		((v3) ? NFSX_V3SATTR : NFSX_V2SATTR)
186 #define	NFSX_COOKIEVERF(v3)	((v3) ? NFSX_V3COOKIEVERF : 0)
187 #define	NFSX_WRITEVERF(v3)	((v3) ? NFSX_V3WRITEVERF : 0)
188 #define NFSX_READDIR(v3)	((v3) ? (5 * NFSX_UNSIGNED) : \
189 					(2 * NFSX_UNSIGNED))
190 #define	NFSX_STATFS(v3)		((v3) ? NFSX_V3STATFS : NFSX_V2STATFS)
191 
192 /* nfs rpc procedure numbers (before version mapping) */
193 #define	NFSPROC_NULL		0
194 #define	NFSPROC_GETATTR		1
195 #define	NFSPROC_SETATTR		2
196 #define	NFSPROC_LOOKUP		3
197 #define	NFSPROC_ACCESS		4
198 #define	NFSPROC_READLINK	5
199 #define	NFSPROC_READ		6
200 #define	NFSPROC_WRITE		7
201 #define	NFSPROC_CREATE		8
202 #define	NFSPROC_MKDIR		9
203 #define	NFSPROC_SYMLINK		10
204 #define	NFSPROC_MKNOD		11
205 #define	NFSPROC_REMOVE		12
206 #define	NFSPROC_RMDIR		13
207 #define	NFSPROC_RENAME		14
208 #define	NFSPROC_LINK		15
209 #define	NFSPROC_READDIR		16
210 #define	NFSPROC_READDIRPLUS	17
211 #define	NFSPROC_FSSTAT		18
212 #define	NFSPROC_FSINFO		19
213 #define	NFSPROC_PATHCONF	20
214 #define	NFSPROC_COMMIT		21
215 #define NFSPROC_NOOP		22
216 #define	NFS_NPROCS		23
217 
218 /* Actual Version 2 procedure numbers */
219 #define	NFSV2PROC_NULL		0
220 #define	NFSV2PROC_GETATTR	1
221 #define	NFSV2PROC_SETATTR	2
222 #define	NFSV2PROC_NOOP		3
223 #define	NFSV2PROC_ROOT		NFSV2PROC_NOOP	/* Obsolete */
224 #define	NFSV2PROC_LOOKUP	4
225 #define	NFSV2PROC_READLINK	5
226 #define	NFSV2PROC_READ		6
227 #define	NFSV2PROC_WRITECACHE	NFSV2PROC_NOOP	/* Obsolete */
228 #define	NFSV2PROC_WRITE		8
229 #define	NFSV2PROC_CREATE	9
230 #define	NFSV2PROC_REMOVE	10
231 #define	NFSV2PROC_RENAME	11
232 #define	NFSV2PROC_LINK		12
233 #define	NFSV2PROC_SYMLINK	13
234 #define	NFSV2PROC_MKDIR		14
235 #define	NFSV2PROC_RMDIR		15
236 #define	NFSV2PROC_READDIR	16
237 #define	NFSV2PROC_STATFS	17
238 
239 /* Version 4 procedure numbers */
240 #define NFSV4PROC_NULL         0
241 #define NFSV4PROC_COMPOUND     1
242 
243 /* Version 4 operation numbers */
244 #define NFSV4OP_ACCESS		3
245 #define NFSV4OP_CLOSE		4
246 #define NFSV4OP_COMMIT		5
247 #define NFSV4OP_CREATE		6
248 #define NFSV4OP_DELEGPURGE	7
249 #define NFSV4OP_DELEGRETURN	8
250 #define NFSV4OP_GETATTR		9
251 #define NFSV4OP_GETFH		10
252 #define NFSV4OP_LINK		11
253 #define NFSV4OP_LOCK		12
254 #define NFSV4OP_LOCKT		13
255 #define NFSV4OP_LOCKU		14
256 #define NFSV4OP_LOOKUP		15
257 #define NFSV4OP_LOOKUPP		16
258 #define NFSV4OP_NVERIFY		17
259 #define NFSV4OP_OPEN		18
260 #define NFSV4OP_OPENATTR	19
261 #define NFSV4OP_OPEN_CONFIRM	20
262 #define NFSV4OP_OPEN_DOWNGRADE	21
263 #define NFSV4OP_PUTFH		22
264 #define NFSV4OP_PUTPUBFH	23
265 #define NFSV4OP_PUTROOTFH	24
266 #define NFSV4OP_READ		25
267 #define NFSV4OP_READDIR		26
268 #define NFSV4OP_READLINK	27
269 #define NFSV4OP_REMOVE		28
270 #define NFSV4OP_RENAME		29
271 #define NFSV4OP_RENEW		30
272 #define NFSV4OP_RESTOREFH	31
273 #define NFSV4OP_SAVEFH		32
274 #define NFSV4OP_SECINFO		33
275 #define NFSV4OP_SETATTR		34
276 #define NFSV4OP_SETCLIENTID	35
277 #define NFSV4OP_SETCLIENTID_CONFIRM 36
278 #define NFSV4OP_VERIFY		37
279 #define NFSV4OP_WRITE		38
280 
281 /*
282  * Constants used by the Version 3 protocol for various RPCs
283  */
284 #define NFSV3SATTRTIME_DONTCHANGE	0
285 #define NFSV3SATTRTIME_TOSERVER		1
286 #define NFSV3SATTRTIME_TOCLIENT		2
287 
288 #define NFSV3ACCESS_READ		0x01
289 #define NFSV3ACCESS_LOOKUP		0x02
290 #define NFSV3ACCESS_MODIFY		0x04
291 #define NFSV3ACCESS_EXTEND		0x08
292 #define NFSV3ACCESS_DELETE		0x10
293 #define NFSV3ACCESS_EXECUTE		0x20
294 
295 #define NFSV3WRITE_UNSTABLE		0
296 #define NFSV3WRITE_DATASYNC		1
297 #define NFSV3WRITE_FILESYNC		2
298 
299 #define NFSV3CREATE_UNCHECKED		0
300 #define NFSV3CREATE_GUARDED		1
301 #define NFSV3CREATE_EXCLUSIVE		2
302 
303 #define NFSV3FSINFO_LINK		0x01
304 #define NFSV3FSINFO_SYMLINK		0x02
305 #define NFSV3FSINFO_HOMOGENEOUS		0x08
306 #define NFSV3FSINFO_CANSETTIME		0x10
307 
308 /*
309  * Constants used by the Version 4 protocol for various RPCs
310  */
311 
312 #define NFSV4ACCESS_READ		0x01
313 #define NFSV4ACCESS_LOOKUP		0x02
314 #define NFSV4ACCESS_MODIFY		0x04
315 #define NFSV4ACCESS_EXTEND		0x08
316 #define NFSV4ACCESS_DELETE		0x10
317 #define NFSV4ACCESS_EXECUTE		0x20
318 
319 #define NFSV4OPENRES_MLOCK		0x01
320 #define NFSV4OPENRES_CONFIRM		0x02
321 
322 #define NFSV4OPENSHARE_ACCESS_READ	0x01
323 #define NFSV4OPENSHARE_ACCESS_WRITE	0x02
324 #define NFSV4OPENSHARE_ACCESS_BOTH	0x03
325 #define NFSV4OPENSHARE_DENY_NONE	0x00
326 #define NFSV4OPENSHARE_DENY_READ	0x01
327 #define NFSV4OPENSHARE_DENY_WRITE	0x02
328 #define NFSV4OPENSHARE_DENY_BOTH	0x03
329 
330 /* File types */
331 typedef enum {
332 	NFNON=0,
333 	NFREG=1,
334 	NFDIR=2,
335 	NFBLK=3,
336 	NFCHR=4,
337 	NFLNK=5,
338 	NFSOCK=6,
339 	NFFIFO=7,
340 	NFATTRDIR = 8,
341 	NFNAMEDATTR = 9,
342 	NFBAD = 10,
343 } nfstype;
344 
345 /* NFSv4 claim type */
346 typedef enum {
347 	NCLNULL = 0,
348 	NCLPREV = 1,
349 	NCLDELEGCUR = 2,
350 	NCLDELEGPREV = 3,
351 } nfsv4cltype;
352 
353 /* Other NFSv4 types */
354 typedef enum {
355 	NSHUNSTABLE = 0,
356 	NSHDATASYNC = 1,
357 	NSHFILESYNC = 2,
358 } nfsv4stablehow;
359 
360 typedef enum { OTNOCREATE = 0, OTCREATE = 1 } nfsv4opentype;
361 typedef enum { CMUNCHECKED = 0, CMGUARDED = 1, CMEXCLUSIVE = 2 } nfsv4createmode;
362 typedef enum { THSERVERTIME = 0, THCLIENTTIME = 1 } nfsv4timehow;
363 typedef enum { ODNONE = 0, ODREAD = 1, ODWRITE = 2 } nfsv4opendelegtype;
364 
365 /* Structs for common parts of the rpc's */
366 
367 /*
368  * File Handle (32 bytes for version 2), variable up to 64 for version 3.
369  * File Handles of up to NFS_SMALLFH in size are stored directly in the
370  * nfs node, whereas larger ones are malloc'd. (This never happens when
371  * NFS_SMALLFH is set to 64.)
372  * NFS_SMALLFH should be in the range of 32 to 64 and be divisible by 4.
373  */
374 #ifndef NFS_SMALLFH
375 #define NFS_SMALLFH	128
376 #endif
377 union nfsfh {
378 	fhandle_t	fh_generic;
379 	u_char		fh_bytes[NFS_SMALLFH];
380 };
381 typedef union nfsfh nfsfh_t;
382 
383 struct nfsv2_time {
384 	u_int32_t	nfsv2_sec;
385 	u_int32_t	nfsv2_usec;
386 };
387 typedef struct nfsv2_time	nfstime2;
388 
389 struct nfsv3_time {
390 	u_int32_t	nfsv3_sec;
391 	u_int32_t	nfsv3_nsec;
392 };
393 typedef struct nfsv3_time	nfstime3;
394 
395 /*
396  * Quads are defined as arrays of 2 longs to ensure dense packing for the
397  * protocol and to facilitate xdr conversion.
398  */
399 struct nfs_uquad {
400 	u_int32_t	nfsuquad[2];
401 };
402 typedef	struct nfs_uquad	nfsuint64;
403 
404 /*
405  * Used to convert between two u_longs and a u_quad_t.
406  */
407 union nfs_quadconvert {
408 	u_int32_t	lval[2];
409 	u_quad_t	qval;
410 };
411 typedef union nfs_quadconvert	nfsquad_t;
412 
413 /*
414  * NFS Version 3 special file number.
415  */
416 struct nfsv3_spec {
417 	u_int32_t	specdata1;
418 	u_int32_t	specdata2;
419 };
420 typedef	struct nfsv3_spec	nfsv3spec;
421 
422 /*
423  * NFS Version 4 bitmap.
424  */
425 struct nfsv4_bitmap {
426 	uint32_t	bmlen;
427 	uint32_t	*bmval;
428 };
429 typedef struct nfsv4_bitmap nfsv4bitmap;
430 
431 struct nfsv4_changeinfo {
432 	u_int		ciatomic;
433 	uint64_t	cibefore;
434 	uint64_t	ciafter;
435 };
436 typedef struct nfsv4_changeinfo nfsv4changeinfo;
437 
438 /*
439  * File attributes and setable attributes. These structures cover both
440  * NFS version 2 and the version 3 protocol. Note that the union is only
441  * used so that one pointer can refer to both variants. These structures
442  * go out on the wire and must be densely packed, so no quad data types
443  * are used. (all fields are longs or u_longs or structures of same)
444  * NB: You can't do sizeof(struct nfs_fattr), you must use the
445  *     NFSX_FATTR(v3) macro.
446  */
447 struct nfs_fattr {
448 	u_int32_t	fa_type;
449 	u_int32_t	fa_mode;
450 	u_int32_t	fa_nlink;
451 	u_int32_t	fa_uid;
452 	u_int32_t	fa_gid;
453 	union {
454 		struct {
455 			u_int32_t	nfsv2fa_size;
456 			u_int32_t	nfsv2fa_blocksize;
457 			u_int32_t	nfsv2fa_rdev;
458 			u_int32_t	nfsv2fa_blocks;
459 			u_int32_t	nfsv2fa_fsid;
460 			u_int32_t	nfsv2fa_fileid;
461 			nfstime2	nfsv2fa_atime;
462 			nfstime2	nfsv2fa_mtime;
463 			nfstime2	nfsv2fa_ctime;
464 		} fa_nfsv2;
465 		struct {
466 			nfsuint64	nfsv3fa_size;
467 			nfsuint64	nfsv3fa_used;
468 			nfsv3spec	nfsv3fa_rdev;
469 			nfsuint64	nfsv3fa_fsid;
470 			nfsuint64	nfsv3fa_fileid;
471 			nfstime3	nfsv3fa_atime;
472 			nfstime3	nfsv3fa_mtime;
473 			nfstime3	nfsv3fa_ctime;
474 		} fa_nfsv3;
475 	} fa_un;
476 };
477 
478 /* and some ugly defines for accessing union components */
479 #define	fa2_size		fa_un.fa_nfsv2.nfsv2fa_size
480 #define	fa2_blocksize		fa_un.fa_nfsv2.nfsv2fa_blocksize
481 #define	fa2_rdev		fa_un.fa_nfsv2.nfsv2fa_rdev
482 #define	fa2_blocks		fa_un.fa_nfsv2.nfsv2fa_blocks
483 #define	fa2_fsid		fa_un.fa_nfsv2.nfsv2fa_fsid
484 #define	fa2_fileid		fa_un.fa_nfsv2.nfsv2fa_fileid
485 #define	fa2_atime		fa_un.fa_nfsv2.nfsv2fa_atime
486 #define	fa2_mtime		fa_un.fa_nfsv2.nfsv2fa_mtime
487 #define	fa2_ctime		fa_un.fa_nfsv2.nfsv2fa_ctime
488 #define	fa3_size		fa_un.fa_nfsv3.nfsv3fa_size
489 #define	fa3_used		fa_un.fa_nfsv3.nfsv3fa_used
490 #define	fa3_rdev		fa_un.fa_nfsv3.nfsv3fa_rdev
491 #define	fa3_fsid		fa_un.fa_nfsv3.nfsv3fa_fsid
492 #define	fa3_fileid		fa_un.fa_nfsv3.nfsv3fa_fileid
493 #define	fa3_atime		fa_un.fa_nfsv3.nfsv3fa_atime
494 #define	fa3_mtime		fa_un.fa_nfsv3.nfsv3fa_mtime
495 #define	fa3_ctime		fa_un.fa_nfsv3.nfsv3fa_ctime
496 
497 struct nfsv4_fattr {
498 	u_int		fa4_valid;
499 	nfstype		fa4_type;
500 	off_t		fa4_size;
501 	uint64_t	fa4_fsid_major;
502 	uint64_t	fa4_fsid_minor;
503 	uint64_t	fa4_fileid;
504 	mode_t		fa4_mode;
505 	nlink_t		fa4_nlink;
506 	uid_t		fa4_uid;
507 	gid_t		fa4_gid;
508 	uint32_t	fa4_rdev_major;
509 	uint32_t	fa4_rdev_minor;
510 	struct timespec	fa4_atime;
511 	struct timespec	fa4_btime;
512 	struct timespec	fa4_ctime;
513 	struct timespec	fa4_mtime;
514 	uint64_t	fa4_maxread;
515 	uint64_t	fa4_maxwrite;
516 	uint64_t	fa4_ffree;
517 	uint64_t	fa4_ftotal;
518 	uint32_t	fa4_maxname;
519 	uint64_t	fa4_savail;
520 	uint64_t	fa4_sfree;
521 	uint64_t	fa4_stotal;
522 	uint64_t	fa4_changeid;
523 	uint32_t	fa4_lease_time;
524 	uint64_t	fa4_maxfilesize;
525 };
526 
527 /* Flags for fa4_valid */
528 #define FA4V_SIZE	0x00000001
529 #define FA4V_FSID	0x00000002
530 #define FA4V_FILEID	0x00000004
531 #define FA4V_MODE	0x00000008
532 #define FA4V_NLINK	0x00000010
533 #define FA4V_UID	0x00000020
534 #define FA4V_GID	0x00000040
535 #define FA4V_RDEV	0x00000080
536 #define FA4V_ATIME	0x00000100
537 #define FA4V_BTIME	0x00000200
538 #define FA4V_CTIME	0x00000400
539 #define FA4V_MTIME	0x00000800
540 #define FA4V_MAXREAD	0x00001000
541 #define FA4V_MAXWRITE	0x00002000
542 #define FA4V_TYPE	0x00004000
543 #define FA4V_FFREE	0x00008000
544 #define FA4V_FTOTAL	0x00010000
545 #define FA4V_MAXNAME	0x00020000
546 #define FA4V_SAVAIL	0x00040000
547 #define FA4V_SFREE	0x00080000
548 #define FA4V_STOTAL	0x00100000
549 #define FA4V_CHANGEID	0x00200000
550 #define FA4V_LEASE_TIME	0x00400000
551 #define FA4V_MAXFILESIZE 0x00800000
552 #define FA4V_ACL	0x01000000
553 
554 /* Offsets into bitmask */
555 #define FA4_SUPPORTED_ATTRS	0
556 #define FA4_TYPE		1
557 #define FA4_FH_EXPIRE_TYPE	2
558 #define FA4_CHANGE		3
559 #define FA4_SIZE		4
560 #define FA4_LINK_SUPPORT	5
561 #define FA4_SYMLINK_SUPPORT	6
562 #define FA4_NAMED_ATTR		7
563 #define FA4_FSID		8
564 #define FA4_UNIQUE_HANDLES	9
565 #define FA4_LEASE_TIME		10
566 #define FA4_RDATTR_ERROR	11
567 #define FA4_ACL			12
568 #define FA4_ACLSUPPORT		13
569 #define FA4_ARCHIVE		14
570 #define FA4_CANSETTIME		15
571 #define FA4_CASE_INSENSITIVE	16
572 #define FA4_CASE_PRESERVING	17
573 #define FA4_CHOWN_RESTRICTED	18
574 #define FA4_FILEHANDLE		19
575 #define FA4_FILEID		20
576 #define FA4_FILES_AVAIL		21
577 #define FA4_FILES_FREE		22
578 #define FA4_FILES_TOTAL		23
579 #define FA4_FS_LOCATIONS	24
580 #define FA4_HIDDEN		25
581 #define FA4_HOMOGENEOUS		26
582 #define FA4_MAXFILESIZE		27
583 #define FA4_MAXLINK		28
584 #define FA4_MAXNAME		29
585 #define FA4_MAXREAD		30
586 #define FA4_MAXWRITE		31
587 #define FA4_MIMETYPE		32
588 #define FA4_MODE		33
589 #define FA4_NO_TRUNC		34
590 #define FA4_NUMLINKS		35
591 #define FA4_OWNER		36
592 #define FA4_OWNER_GROUP		37
593 #define FA4_QUOTA_HARD		38
594 #define FA4_QUOTA_SOFT		39
595 #define FA4_QUOTA_USED		40
596 #define FA4_RAWDEV		41
597 #define FA4_SPACE_AVAIL		42
598 #define FA4_SPACE_FREE		43
599 #define FA4_SPACE_TOTAL		44
600 #define FA4_SPACE_USED		45
601 #define FA4_SYSTEM		46
602 #define FA4_TIME_ACCESS		47
603 #define FA4_TIME_ACCESS_SET	48
604 #define FA4_TIME_BACKUP		49
605 #define FA4_TIME_CREATE		50
606 #define FA4_TIME_DELTA		51
607 #define FA4_TIME_METADATA	52
608 #define FA4_TIME_MODIFY		53
609 #define FA4_TIME_MODIFY_SET	54
610 #define FA4_ATTR_MAX		55
611 
612 /* Macros for v4 fattr manipulation */
613 #define FA4_SET(n, p)	((p)[(n)/32] |= (1 << ((n) % 32)))
614 #define FA4_CLR(n, p)	((p)[(n)/32] &= ~(1 << ((n) % 32)))
615 #define FA4_ISSET(n, p)	((p)[(n)/32] & (1 << ((n) % 32)))
616 #define FA4_ZERO(p)	bzero((p), 8)
617 #define FA4_SKIP(p)	((p) += 2)
618 
619 struct nfsv2_sattr {
620 	u_int32_t	sa_mode;
621 	u_int32_t	sa_uid;
622 	u_int32_t	sa_gid;
623 	u_int32_t	sa_size;
624 	nfstime2	sa_atime;
625 	nfstime2	sa_mtime;
626 };
627 
628 /*
629  * NFS Version 3 sattr structure for the new node creation case.
630  */
631 struct nfsv3_sattr {
632 	u_int32_t	sa_modetrue;
633 	u_int32_t	sa_mode;
634 	u_int32_t	sa_uidfalse;
635 	u_int32_t	sa_gidfalse;
636 	u_int32_t	sa_sizefalse;
637 	u_int32_t	sa_atimetype;
638 	nfstime3	sa_atime;
639 	u_int32_t	sa_mtimetype;
640 	nfstime3	sa_mtime;
641 };
642 
643 struct nfs_statfs {
644 	union {
645 		struct {
646 			u_int32_t	nfsv2sf_tsize;
647 			u_int32_t	nfsv2sf_bsize;
648 			u_int32_t	nfsv2sf_blocks;
649 			u_int32_t	nfsv2sf_bfree;
650 			u_int32_t	nfsv2sf_bavail;
651 		} sf_nfsv2;
652 		struct {
653 			nfsuint64	nfsv3sf_tbytes;
654 			nfsuint64	nfsv3sf_fbytes;
655 			nfsuint64	nfsv3sf_abytes;
656 			nfsuint64	nfsv3sf_tfiles;
657 			nfsuint64	nfsv3sf_ffiles;
658 			nfsuint64	nfsv3sf_afiles;
659 			u_int32_t	nfsv3sf_invarsec;
660 		} sf_nfsv3;
661 	} sf_un;
662 };
663 
664 #define sf_tsize	sf_un.sf_nfsv2.nfsv2sf_tsize
665 #define sf_bsize	sf_un.sf_nfsv2.nfsv2sf_bsize
666 #define sf_blocks	sf_un.sf_nfsv2.nfsv2sf_blocks
667 #define sf_bfree	sf_un.sf_nfsv2.nfsv2sf_bfree
668 #define sf_bavail	sf_un.sf_nfsv2.nfsv2sf_bavail
669 #define sf_tbytes	sf_un.sf_nfsv3.nfsv3sf_tbytes
670 #define sf_fbytes	sf_un.sf_nfsv3.nfsv3sf_fbytes
671 #define sf_abytes	sf_un.sf_nfsv3.nfsv3sf_abytes
672 #define sf_tfiles	sf_un.sf_nfsv3.nfsv3sf_tfiles
673 #define sf_ffiles	sf_un.sf_nfsv3.nfsv3sf_ffiles
674 #define sf_afiles	sf_un.sf_nfsv3.nfsv3sf_afiles
675 #define sf_invarsec	sf_un.sf_nfsv3.nfsv3sf_invarsec
676 
677 struct nfsv3_fsinfo {
678 	u_int32_t	fs_rtmax;
679 	u_int32_t	fs_rtpref;
680 	u_int32_t	fs_rtmult;
681 	u_int32_t	fs_wtmax;
682 	u_int32_t	fs_wtpref;
683 	u_int32_t	fs_wtmult;
684 	u_int32_t	fs_dtpref;
685 	nfsuint64	fs_maxfilesize;
686 	nfstime3	fs_timedelta;
687 	u_int32_t	fs_properties;
688 };
689 
690 struct nfsv3_pathconf {
691 	u_int32_t	pc_linkmax;
692 	u_int32_t	pc_namemax;
693 	u_int32_t	pc_notrunc;
694 	u_int32_t	pc_chownrestricted;
695 	u_int32_t	pc_caseinsensitive;
696 	u_int32_t	pc_casepreserving;
697 };
698 
699 #endif
700