xref: /linux-6.15/include/linux/nfs4.h (revision f0ada00a)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  *  include/linux/nfs4.h
4  *
5  *  NFSv4 protocol definitions.
6  *
7  *  Copyright (c) 2002 The Regents of the University of Michigan.
8  *  All rights reserved.
9  *
10  *  Kendrick Smith <[email protected]>
11  *  Andy Adamson   <[email protected]>
12  */
13 #ifndef _LINUX_NFS4_H
14 #define _LINUX_NFS4_H
15 
16 #include <linux/list.h>
17 #include <linux/uidgid.h>
18 #include <uapi/linux/nfs4.h>
19 #include <linux/sunrpc/msg_prot.h>
20 #include <linux/sunrpc/xdrgen/nfs4_1.h>
21 
22 enum nfs4_acl_whotype {
23 	NFS4_ACL_WHO_NAMED = 0,
24 	NFS4_ACL_WHO_OWNER,
25 	NFS4_ACL_WHO_GROUP,
26 	NFS4_ACL_WHO_EVERYONE,
27 };
28 
29 struct nfs4_ace {
30 	uint32_t	type;
31 	uint32_t	flag;
32 	uint32_t	access_mask;
33 	int		whotype;
34 	union {
35 		kuid_t	who_uid;
36 		kgid_t	who_gid;
37 	};
38 };
39 
40 struct nfs4_acl {
41 	uint32_t	naces;
42 	struct nfs4_ace	aces[];
43 };
44 
45 #define NFS4_MAXLABELLEN	2048
46 
47 struct nfs4_label {
48 	uint32_t	lfs;
49 	uint32_t	pi;
50 	u32		len;
51 	char	*label;
52 };
53 
54 typedef struct { char data[NFS4_VERIFIER_SIZE]; } nfs4_verifier;
55 
56 struct nfs4_stateid_struct {
57 	union {
58 		char data[NFS4_STATEID_SIZE];
59 		struct {
60 			__be32 seqid;
61 			char other[NFS4_STATEID_OTHER_SIZE];
62 		} __attribute__ ((packed));
63 	};
64 
65 	enum {
66 		NFS4_INVALID_STATEID_TYPE = 0,
67 		NFS4_SPECIAL_STATEID_TYPE,
68 		NFS4_OPEN_STATEID_TYPE,
69 		NFS4_LOCK_STATEID_TYPE,
70 		NFS4_DELEGATION_STATEID_TYPE,
71 		NFS4_LAYOUT_STATEID_TYPE,
72 		NFS4_PNFS_DS_STATEID_TYPE,
73 		NFS4_REVOKED_STATEID_TYPE,
74 	} type;
75 };
76 
77 typedef struct nfs4_stateid_struct nfs4_stateid;
78 
79 enum nfs_opnum4 {
80 	OP_ACCESS = 3,
81 	OP_CLOSE = 4,
82 	OP_COMMIT = 5,
83 	OP_CREATE = 6,
84 	OP_DELEGPURGE = 7,
85 	OP_DELEGRETURN = 8,
86 	OP_GETATTR = 9,
87 	OP_GETFH = 10,
88 	OP_LINK = 11,
89 	OP_LOCK = 12,
90 	OP_LOCKT = 13,
91 	OP_LOCKU = 14,
92 	OP_LOOKUP = 15,
93 	OP_LOOKUPP = 16,
94 	OP_NVERIFY = 17,
95 	OP_OPEN = 18,
96 	OP_OPENATTR = 19,
97 	OP_OPEN_CONFIRM = 20,
98 	OP_OPEN_DOWNGRADE = 21,
99 	OP_PUTFH = 22,
100 	OP_PUTPUBFH = 23,
101 	OP_PUTROOTFH = 24,
102 	OP_READ = 25,
103 	OP_READDIR = 26,
104 	OP_READLINK = 27,
105 	OP_REMOVE = 28,
106 	OP_RENAME = 29,
107 	OP_RENEW = 30,
108 	OP_RESTOREFH = 31,
109 	OP_SAVEFH = 32,
110 	OP_SECINFO = 33,
111 	OP_SETATTR = 34,
112 	OP_SETCLIENTID = 35,
113 	OP_SETCLIENTID_CONFIRM = 36,
114 	OP_VERIFY = 37,
115 	OP_WRITE = 38,
116 	OP_RELEASE_LOCKOWNER = 39,
117 
118 	/* nfs41 */
119 	OP_BACKCHANNEL_CTL = 40,
120 	OP_BIND_CONN_TO_SESSION = 41,
121 	OP_EXCHANGE_ID = 42,
122 	OP_CREATE_SESSION = 43,
123 	OP_DESTROY_SESSION = 44,
124 	OP_FREE_STATEID = 45,
125 	OP_GET_DIR_DELEGATION = 46,
126 	OP_GETDEVICEINFO = 47,
127 	OP_GETDEVICELIST = 48,
128 	OP_LAYOUTCOMMIT = 49,
129 	OP_LAYOUTGET = 50,
130 	OP_LAYOUTRETURN = 51,
131 	OP_SECINFO_NO_NAME = 52,
132 	OP_SEQUENCE = 53,
133 	OP_SET_SSV = 54,
134 	OP_TEST_STATEID = 55,
135 	OP_WANT_DELEGATION = 56,
136 	OP_DESTROY_CLIENTID = 57,
137 	OP_RECLAIM_COMPLETE = 58,
138 
139 	/* nfs42 */
140 	OP_ALLOCATE = 59,
141 	OP_COPY = 60,
142 	OP_COPY_NOTIFY = 61,
143 	OP_DEALLOCATE = 62,
144 	OP_IO_ADVISE = 63,
145 	OP_LAYOUTERROR = 64,
146 	OP_LAYOUTSTATS = 65,
147 	OP_OFFLOAD_CANCEL = 66,
148 	OP_OFFLOAD_STATUS = 67,
149 	OP_READ_PLUS = 68,
150 	OP_SEEK = 69,
151 	OP_WRITE_SAME = 70,
152 	OP_CLONE = 71,
153 
154 	/* xattr support (RFC8276) */
155 	OP_GETXATTR                = 72,
156 	OP_SETXATTR                = 73,
157 	OP_LISTXATTRS              = 74,
158 	OP_REMOVEXATTR             = 75,
159 
160 	OP_ILLEGAL = 10044,
161 };
162 
163 /*Defining first and last NFS4 operations implemented.
164 Needs to be updated if more operations are defined in future.*/
165 
166 #define FIRST_NFS4_OP	OP_ACCESS
167 #define LAST_NFS40_OP	OP_RELEASE_LOCKOWNER
168 #define LAST_NFS41_OP	OP_RECLAIM_COMPLETE
169 #define LAST_NFS42_OP	OP_REMOVEXATTR
170 #define LAST_NFS4_OP	LAST_NFS42_OP
171 
172 enum nfsstat4 {
173 	NFS4_OK = 0,
174 	NFS4ERR_PERM = 1,
175 	NFS4ERR_NOENT = 2,
176 	NFS4ERR_IO = 5,
177 	NFS4ERR_NXIO = 6,
178 	NFS4ERR_ACCESS = 13,
179 	NFS4ERR_EXIST = 17,
180 	NFS4ERR_XDEV = 18,
181 	/* Unused/reserved 19 */
182 	NFS4ERR_NOTDIR = 20,
183 	NFS4ERR_ISDIR = 21,
184 	NFS4ERR_INVAL = 22,
185 	NFS4ERR_FBIG = 27,
186 	NFS4ERR_NOSPC = 28,
187 	NFS4ERR_ROFS = 30,
188 	NFS4ERR_MLINK = 31,
189 	NFS4ERR_NAMETOOLONG = 63,
190 	NFS4ERR_NOTEMPTY = 66,
191 	NFS4ERR_DQUOT = 69,
192 	NFS4ERR_STALE = 70,
193 	NFS4ERR_BADHANDLE = 10001,
194 	NFS4ERR_BAD_COOKIE = 10003,
195 	NFS4ERR_NOTSUPP = 10004,
196 	NFS4ERR_TOOSMALL = 10005,
197 	NFS4ERR_SERVERFAULT = 10006,
198 	NFS4ERR_BADTYPE = 10007,
199 	NFS4ERR_DELAY = 10008,
200 	NFS4ERR_SAME = 10009,
201 	NFS4ERR_DENIED = 10010,
202 	NFS4ERR_EXPIRED = 10011,
203 	NFS4ERR_LOCKED = 10012,
204 	NFS4ERR_GRACE = 10013,
205 	NFS4ERR_FHEXPIRED = 10014,
206 	NFS4ERR_SHARE_DENIED = 10015,
207 	NFS4ERR_WRONGSEC = 10016,
208 	NFS4ERR_CLID_INUSE = 10017,
209 	NFS4ERR_RESOURCE = 10018,
210 	NFS4ERR_MOVED = 10019,
211 	NFS4ERR_NOFILEHANDLE = 10020,
212 	NFS4ERR_MINOR_VERS_MISMATCH = 10021,
213 	NFS4ERR_STALE_CLIENTID = 10022,
214 	NFS4ERR_STALE_STATEID = 10023,
215 	NFS4ERR_OLD_STATEID = 10024,
216 	NFS4ERR_BAD_STATEID = 10025,
217 	NFS4ERR_BAD_SEQID = 10026,
218 	NFS4ERR_NOT_SAME = 10027,
219 	NFS4ERR_LOCK_RANGE = 10028,
220 	NFS4ERR_SYMLINK = 10029,
221 	NFS4ERR_RESTOREFH = 10030,
222 	NFS4ERR_LEASE_MOVED = 10031,
223 	NFS4ERR_ATTRNOTSUPP = 10032,
224 	NFS4ERR_NO_GRACE = 10033,
225 	NFS4ERR_RECLAIM_BAD = 10034,
226 	NFS4ERR_RECLAIM_CONFLICT = 10035,
227 	NFS4ERR_BADXDR = 10036,
228 	NFS4ERR_LOCKS_HELD = 10037,
229 	NFS4ERR_OPENMODE = 10038,
230 	NFS4ERR_BADOWNER = 10039,
231 	NFS4ERR_BADCHAR = 10040,
232 	NFS4ERR_BADNAME = 10041,
233 	NFS4ERR_BAD_RANGE = 10042,
234 	NFS4ERR_LOCK_NOTSUPP = 10043,
235 	NFS4ERR_OP_ILLEGAL = 10044,
236 	NFS4ERR_DEADLOCK = 10045,
237 	NFS4ERR_FILE_OPEN = 10046,
238 	NFS4ERR_ADMIN_REVOKED = 10047,
239 	NFS4ERR_CB_PATH_DOWN = 10048,
240 
241 	/* nfs41 */
242 	NFS4ERR_BADIOMODE	= 10049,
243 	NFS4ERR_BADLAYOUT	= 10050,
244 	NFS4ERR_BAD_SESSION_DIGEST = 10051,
245 	NFS4ERR_BADSESSION	= 10052,
246 	NFS4ERR_BADSLOT		= 10053,
247 	NFS4ERR_COMPLETE_ALREADY = 10054,
248 	NFS4ERR_CONN_NOT_BOUND_TO_SESSION = 10055,
249 	NFS4ERR_DELEG_ALREADY_WANTED = 10056,
250 	NFS4ERR_BACK_CHAN_BUSY	= 10057,	/* backchan reqs outstanding */
251 	NFS4ERR_LAYOUTTRYLATER	= 10058,
252 	NFS4ERR_LAYOUTUNAVAILABLE = 10059,
253 	NFS4ERR_NOMATCHING_LAYOUT = 10060,
254 	NFS4ERR_RECALLCONFLICT	= 10061,
255 	NFS4ERR_UNKNOWN_LAYOUTTYPE = 10062,
256 	NFS4ERR_SEQ_MISORDERED = 10063, 	/* unexpected seq.id in req */
257 	NFS4ERR_SEQUENCE_POS	= 10064,	/* [CB_]SEQ. op not 1st op */
258 	NFS4ERR_REQ_TOO_BIG	= 10065,	/* request too big */
259 	NFS4ERR_REP_TOO_BIG	= 10066,	/* reply too big */
260 	NFS4ERR_REP_TOO_BIG_TO_CACHE = 10067,	/* rep. not all cached */
261 	NFS4ERR_RETRY_UNCACHED_REP = 10068,	/* retry & rep. uncached */
262 	NFS4ERR_UNSAFE_COMPOUND = 10069,	/* retry/recovery too hard */
263 	NFS4ERR_TOO_MANY_OPS	= 10070,	/* too many ops in [CB_]COMP */
264 	NFS4ERR_OP_NOT_IN_SESSION = 10071,	/* op needs [CB_]SEQ. op */
265 	NFS4ERR_HASH_ALG_UNSUPP = 10072,	/* hash alg. not supp. */
266 						/* Error 10073 is unused. */
267 	NFS4ERR_CLIENTID_BUSY	= 10074,	/* clientid has state */
268 	NFS4ERR_PNFS_IO_HOLE	= 10075,	/* IO to _SPARSE file hole */
269 	NFS4ERR_SEQ_FALSE_RETRY	= 10076,	/* retry not original */
270 	NFS4ERR_BAD_HIGH_SLOT	= 10077,	/* sequence arg bad */
271 	NFS4ERR_DEADSESSION	= 10078,	/* persistent session dead */
272 	NFS4ERR_ENCR_ALG_UNSUPP = 10079,	/* SSV alg mismatch */
273 	NFS4ERR_PNFS_NO_LAYOUT	= 10080,	/* direct I/O with no layout */
274 	NFS4ERR_NOT_ONLY_OP	= 10081,	/* bad compound */
275 	NFS4ERR_WRONG_CRED	= 10082,	/* permissions:state change */
276 	NFS4ERR_WRONG_TYPE	= 10083,	/* current operation mismatch */
277 	NFS4ERR_DIRDELEG_UNAVAIL = 10084,	/* no directory delegation */
278 	NFS4ERR_REJECT_DELEG	= 10085,	/* on callback */
279 	NFS4ERR_RETURNCONFLICT	= 10086,	/* outstanding layoutreturn */
280 	NFS4ERR_DELEG_REVOKED	= 10087,	/* deleg./layout revoked */
281 
282 	/* nfs42 */
283 	NFS4ERR_PARTNER_NOTSUPP	= 10088,
284 	NFS4ERR_PARTNER_NO_AUTH	= 10089,
285 	NFS4ERR_UNION_NOTSUPP	= 10090,
286 	NFS4ERR_OFFLOAD_DENIED	= 10091,
287 	NFS4ERR_WRONG_LFS	= 10092,
288 	NFS4ERR_BADLABEL	= 10093,
289 	NFS4ERR_OFFLOAD_NO_REQS	= 10094,
290 
291 	/* xattr (RFC8276) */
292 	NFS4ERR_NOXATTR		= 10095,
293 	NFS4ERR_XATTR2BIG	= 10096,
294 
295 	/* can be used for internal errors */
296 	NFS4ERR_FIRST_FREE
297 };
298 
299 /* error codes for internal client use */
300 #define NFS4ERR_RESET_TO_MDS   12001
301 #define NFS4ERR_RESET_TO_PNFS  12002
302 
303 static inline bool seqid_mutating_err(u32 err)
304 {
305 	/* See RFC 7530, section 9.1.7 */
306 	switch (err) {
307 	case NFS4ERR_STALE_CLIENTID:
308 	case NFS4ERR_STALE_STATEID:
309 	case NFS4ERR_BAD_STATEID:
310 	case NFS4ERR_BAD_SEQID:
311 	case NFS4ERR_BADXDR:
312 	case NFS4ERR_RESOURCE:
313 	case NFS4ERR_NOFILEHANDLE:
314 	case NFS4ERR_MOVED:
315 		return false;
316 	}
317 	return true;
318 }
319 
320 /*
321  * Note: NF4BAD is not actually part of the protocol; it is just used
322  * internally by nfsd.
323  */
324 enum nfs_ftype4 {
325 	NF4BAD		= 0,
326         NF4REG          = 1,    /* Regular File */
327         NF4DIR          = 2,    /* Directory */
328         NF4BLK          = 3,    /* Special File - block device */
329         NF4CHR          = 4,    /* Special File - character device */
330         NF4LNK          = 5,    /* Symbolic Link */
331         NF4SOCK         = 6,    /* Special File - socket */
332         NF4FIFO         = 7,    /* Special File - fifo */
333         NF4ATTRDIR      = 8,    /* Attribute Directory */
334         NF4NAMEDATTR    = 9     /* Named Attribute */
335 };
336 
337 enum open_claim_type4 {
338 	NFS4_OPEN_CLAIM_NULL = 0,
339 	NFS4_OPEN_CLAIM_PREVIOUS = 1,
340 	NFS4_OPEN_CLAIM_DELEGATE_CUR = 2,
341 	NFS4_OPEN_CLAIM_DELEGATE_PREV = 3,
342 	NFS4_OPEN_CLAIM_FH = 4, /* 4.1 */
343 	NFS4_OPEN_CLAIM_DELEG_CUR_FH = 5, /* 4.1 */
344 	NFS4_OPEN_CLAIM_DELEG_PREV_FH = 6, /* 4.1 */
345 };
346 
347 enum opentype4 {
348 	NFS4_OPEN_NOCREATE = 0,
349 	NFS4_OPEN_CREATE = 1
350 };
351 
352 enum createmode4 {
353 	NFS4_CREATE_UNCHECKED = 0,
354 	NFS4_CREATE_GUARDED = 1,
355 	NFS4_CREATE_EXCLUSIVE = 2,
356 	/*
357 	 * New to NFSv4.1. If session is persistent,
358 	 * GUARDED4 MUST be used. Otherwise, use
359 	 * EXCLUSIVE4_1 instead of EXCLUSIVE4.
360 	 */
361 	NFS4_CREATE_EXCLUSIVE4_1 = 3
362 };
363 
364 enum limit_by4 {
365 	NFS4_LIMIT_SIZE = 1,
366 	NFS4_LIMIT_BLOCKS = 2
367 };
368 
369 enum nfs4_open_delegation_type4 {
370 	NFS4_OPEN_DELEGATE_NONE = 0,
371 	NFS4_OPEN_DELEGATE_READ = 1,
372 	NFS4_OPEN_DELEGATE_WRITE = 2,
373 	NFS4_OPEN_DELEGATE_NONE_EXT = 3, /* 4.1 */
374 	NFS4_OPEN_DELEGATE_READ_ATTRS_DELEG = 4,
375 	NFS4_OPEN_DELEGATE_WRITE_ATTRS_DELEG = 5,
376 };
377 
378 enum why_no_delegation4 { /* new to v4.1 */
379 	WND4_NOT_WANTED = 0,
380 	WND4_CONTENTION = 1,
381 	WND4_RESOURCE = 2,
382 	WND4_NOT_SUPP_FTYPE = 3,
383 	WND4_WRITE_DELEG_NOT_SUPP_FTYPE = 4,
384 	WND4_NOT_SUPP_UPGRADE = 5,
385 	WND4_NOT_SUPP_DOWNGRADE = 6,
386 	WND4_CANCELLED = 7,
387 	WND4_IS_DIR = 8,
388 };
389 
390 enum lock_type4 {
391 	NFS4_UNLOCK_LT = 0,
392 	NFS4_READ_LT = 1,
393 	NFS4_WRITE_LT = 2,
394 	NFS4_READW_LT = 3,
395 	NFS4_WRITEW_LT = 4
396 };
397 
398 /*
399  * Symbol names and values are from RFC 7531 Section 2.
400  * "XDR Description of NFSv4.0"
401  */
402 enum {
403 	FATTR4_SUPPORTED_ATTRS		= 0,
404 	FATTR4_TYPE			= 1,
405 	FATTR4_FH_EXPIRE_TYPE		= 2,
406 	FATTR4_CHANGE			= 3,
407 	FATTR4_SIZE			= 4,
408 	FATTR4_LINK_SUPPORT		= 5,
409 	FATTR4_SYMLINK_SUPPORT		= 6,
410 	FATTR4_NAMED_ATTR		= 7,
411 	FATTR4_FSID			= 8,
412 	FATTR4_UNIQUE_HANDLES		= 9,
413 	FATTR4_LEASE_TIME		= 10,
414 	FATTR4_RDATTR_ERROR		= 11,
415 	FATTR4_ACL			= 12,
416 	FATTR4_ACLSUPPORT		= 13,
417 	FATTR4_ARCHIVE			= 14,
418 	FATTR4_CANSETTIME		= 15,
419 	FATTR4_CASE_INSENSITIVE		= 16,
420 	FATTR4_CASE_PRESERVING		= 17,
421 	FATTR4_CHOWN_RESTRICTED		= 18,
422 	FATTR4_FILEHANDLE		= 19,
423 	FATTR4_FILEID			= 20,
424 	FATTR4_FILES_AVAIL		= 21,
425 	FATTR4_FILES_FREE		= 22,
426 	FATTR4_FILES_TOTAL		= 23,
427 	FATTR4_FS_LOCATIONS		= 24,
428 	FATTR4_HIDDEN			= 25,
429 	FATTR4_HOMOGENEOUS		= 26,
430 	FATTR4_MAXFILESIZE		= 27,
431 	FATTR4_MAXLINK			= 28,
432 	FATTR4_MAXNAME			= 29,
433 	FATTR4_MAXREAD			= 30,
434 	FATTR4_MAXWRITE			= 31,
435 	FATTR4_MIMETYPE			= 32,
436 	FATTR4_MODE			= 33,
437 	FATTR4_NO_TRUNC			= 34,
438 	FATTR4_NUMLINKS			= 35,
439 	FATTR4_OWNER			= 36,
440 	FATTR4_OWNER_GROUP		= 37,
441 	FATTR4_QUOTA_AVAIL_HARD		= 38,
442 	FATTR4_QUOTA_AVAIL_SOFT		= 39,
443 	FATTR4_QUOTA_USED		= 40,
444 	FATTR4_RAWDEV			= 41,
445 	FATTR4_SPACE_AVAIL		= 42,
446 	FATTR4_SPACE_FREE		= 43,
447 	FATTR4_SPACE_TOTAL		= 44,
448 	FATTR4_SPACE_USED		= 45,
449 	FATTR4_SYSTEM			= 46,
450 	FATTR4_TIME_ACCESS		= 47,
451 	FATTR4_TIME_ACCESS_SET		= 48,
452 	FATTR4_TIME_BACKUP		= 49,
453 	FATTR4_TIME_CREATE		= 50,
454 	FATTR4_TIME_DELTA		= 51,
455 	FATTR4_TIME_METADATA		= 52,
456 	FATTR4_TIME_MODIFY		= 53,
457 	FATTR4_TIME_MODIFY_SET		= 54,
458 	FATTR4_MOUNTED_ON_FILEID	= 55,
459 };
460 
461 /*
462  * Symbol names and values are from RFC 5662 Section 2.
463  * "XDR Description of NFSv4.1"
464  */
465 enum {
466 	FATTR4_DIR_NOTIF_DELAY		= 56,
467 	FATTR4_DIRENT_NOTIF_DELAY	= 57,
468 	FATTR4_DACL			= 58,
469 	FATTR4_SACL			= 59,
470 	FATTR4_CHANGE_POLICY		= 60,
471 	FATTR4_FS_STATUS		= 61,
472 	FATTR4_FS_LAYOUT_TYPES		= 62,
473 	FATTR4_LAYOUT_HINT		= 63,
474 	FATTR4_LAYOUT_TYPES		= 64,
475 	FATTR4_LAYOUT_BLKSIZE		= 65,
476 	FATTR4_LAYOUT_ALIGNMENT		= 66,
477 	FATTR4_FS_LOCATIONS_INFO	= 67,
478 	FATTR4_MDSTHRESHOLD		= 68,
479 	FATTR4_RETENTION_GET		= 69,
480 	FATTR4_RETENTION_SET		= 70,
481 	FATTR4_RETENTEVT_GET		= 71,
482 	FATTR4_RETENTEVT_SET		= 72,
483 	FATTR4_RETENTION_HOLD		= 73,
484 	FATTR4_MODE_SET_MASKED		= 74,
485 	FATTR4_SUPPATTR_EXCLCREAT	= 75,
486 	FATTR4_FS_CHARSET_CAP		= 76,
487 };
488 
489 /*
490  * Symbol names and values are from RFC 7863 Section 2.
491  * "XDR Description of NFSv4.2"
492  */
493 enum {
494 	FATTR4_CLONE_BLKSIZE		= 77,
495 	FATTR4_SPACE_FREED		= 78,
496 	FATTR4_CHANGE_ATTR_TYPE		= 79,
497 	FATTR4_SEC_LABEL		= 80,
498 };
499 
500 /*
501  * Symbol names and values are from RFC 8275 Section 5.
502  * "The mode_umask Attribute"
503  */
504 enum {
505 	FATTR4_MODE_UMASK		= 81,
506 };
507 
508 /*
509  * Symbol names and values are from RFC 8276 Section 8.6.
510  * "Numeric Values Assigned to Protocol Extensions"
511  */
512 enum {
513 	FATTR4_XATTR_SUPPORT		= 82,
514 };
515 
516 /*
517  * The following internal definitions enable processing the above
518  * attribute bits within 32-bit word boundaries.
519  */
520 
521 /* Mandatory Attributes */
522 #define FATTR4_WORD0_SUPPORTED_ATTRS    BIT(FATTR4_SUPPORTED_ATTRS)
523 #define FATTR4_WORD0_TYPE               BIT(FATTR4_TYPE)
524 #define FATTR4_WORD0_FH_EXPIRE_TYPE     BIT(FATTR4_FH_EXPIRE_TYPE)
525 #define FATTR4_WORD0_CHANGE             BIT(FATTR4_CHANGE)
526 #define FATTR4_WORD0_SIZE               BIT(FATTR4_SIZE)
527 #define FATTR4_WORD0_LINK_SUPPORT       BIT(FATTR4_LINK_SUPPORT)
528 #define FATTR4_WORD0_SYMLINK_SUPPORT    BIT(FATTR4_SYMLINK_SUPPORT)
529 #define FATTR4_WORD0_NAMED_ATTR         BIT(FATTR4_NAMED_ATTR)
530 #define FATTR4_WORD0_FSID               BIT(FATTR4_FSID)
531 #define FATTR4_WORD0_UNIQUE_HANDLES     BIT(FATTR4_UNIQUE_HANDLES)
532 #define FATTR4_WORD0_LEASE_TIME         BIT(FATTR4_LEASE_TIME)
533 #define FATTR4_WORD0_RDATTR_ERROR       BIT(FATTR4_RDATTR_ERROR)
534 /* Mandatory in NFSv4.1 */
535 #define FATTR4_WORD2_SUPPATTR_EXCLCREAT BIT(FATTR4_SUPPATTR_EXCLCREAT - 64)
536 
537 /* Recommended Attributes */
538 #define FATTR4_WORD0_ACL                BIT(FATTR4_ACL)
539 #define FATTR4_WORD0_ACLSUPPORT         BIT(FATTR4_ACLSUPPORT)
540 #define FATTR4_WORD0_ARCHIVE            BIT(FATTR4_ARCHIVE)
541 #define FATTR4_WORD0_CANSETTIME         BIT(FATTR4_CANSETTIME)
542 #define FATTR4_WORD0_CASE_INSENSITIVE   BIT(FATTR4_CASE_INSENSITIVE)
543 #define FATTR4_WORD0_CASE_PRESERVING    BIT(FATTR4_CASE_PRESERVING)
544 #define FATTR4_WORD0_CHOWN_RESTRICTED   BIT(FATTR4_CHOWN_RESTRICTED)
545 #define FATTR4_WORD0_FILEHANDLE         BIT(FATTR4_FILEHANDLE)
546 #define FATTR4_WORD0_FILEID             BIT(FATTR4_FILEID)
547 #define FATTR4_WORD0_FILES_AVAIL        BIT(FATTR4_FILES_AVAIL)
548 #define FATTR4_WORD0_FILES_FREE         BIT(FATTR4_FILES_FREE)
549 #define FATTR4_WORD0_FILES_TOTAL        BIT(FATTR4_FILES_TOTAL)
550 #define FATTR4_WORD0_FS_LOCATIONS       BIT(FATTR4_FS_LOCATIONS)
551 #define FATTR4_WORD0_HIDDEN             BIT(FATTR4_HIDDEN)
552 #define FATTR4_WORD0_HOMOGENEOUS        BIT(FATTR4_HOMOGENEOUS)
553 #define FATTR4_WORD0_MAXFILESIZE        BIT(FATTR4_MAXFILESIZE)
554 #define FATTR4_WORD0_MAXLINK            BIT(FATTR4_MAXLINK)
555 #define FATTR4_WORD0_MAXNAME            BIT(FATTR4_MAXNAME)
556 #define FATTR4_WORD0_MAXREAD            BIT(FATTR4_MAXREAD)
557 #define FATTR4_WORD0_MAXWRITE           BIT(FATTR4_MAXWRITE)
558 
559 #define FATTR4_WORD1_MIMETYPE           BIT(FATTR4_MIMETYPE - 32)
560 #define FATTR4_WORD1_MODE               BIT(FATTR4_MODE	- 32)
561 #define FATTR4_WORD1_NO_TRUNC           BIT(FATTR4_NO_TRUNC - 32)
562 #define FATTR4_WORD1_NUMLINKS           BIT(FATTR4_NUMLINKS - 32)
563 #define FATTR4_WORD1_OWNER              BIT(FATTR4_OWNER - 32)
564 #define FATTR4_WORD1_OWNER_GROUP        BIT(FATTR4_OWNER_GROUP - 32)
565 #define FATTR4_WORD1_QUOTA_HARD         BIT(FATTR4_QUOTA_AVAIL_HARD - 32)
566 #define FATTR4_WORD1_QUOTA_SOFT         BIT(FATTR4_QUOTA_AVAIL_SOFT - 32)
567 #define FATTR4_WORD1_QUOTA_USED         BIT(FATTR4_QUOTA_USED - 32)
568 #define FATTR4_WORD1_RAWDEV             BIT(FATTR4_RAWDEV - 32)
569 #define FATTR4_WORD1_SPACE_AVAIL        BIT(FATTR4_SPACE_AVAIL - 32)
570 #define FATTR4_WORD1_SPACE_FREE         BIT(FATTR4_SPACE_FREE - 32)
571 #define FATTR4_WORD1_SPACE_TOTAL        BIT(FATTR4_SPACE_TOTAL - 32)
572 #define FATTR4_WORD1_SPACE_USED         BIT(FATTR4_SPACE_USED - 32)
573 #define FATTR4_WORD1_SYSTEM             BIT(FATTR4_SYSTEM - 32)
574 #define FATTR4_WORD1_TIME_ACCESS        BIT(FATTR4_TIME_ACCESS - 32)
575 #define FATTR4_WORD1_TIME_ACCESS_SET    BIT(FATTR4_TIME_ACCESS_SET - 32)
576 #define FATTR4_WORD1_TIME_BACKUP        BIT(FATTR4_TIME_BACKUP - 32)
577 #define FATTR4_WORD1_TIME_CREATE        BIT(FATTR4_TIME_CREATE - 32)
578 #define FATTR4_WORD1_TIME_DELTA         BIT(FATTR4_TIME_DELTA - 32)
579 #define FATTR4_WORD1_TIME_METADATA      BIT(FATTR4_TIME_METADATA - 32)
580 #define FATTR4_WORD1_TIME_MODIFY        BIT(FATTR4_TIME_MODIFY - 32)
581 #define FATTR4_WORD1_TIME_MODIFY_SET    BIT(FATTR4_TIME_MODIFY_SET - 32)
582 #define FATTR4_WORD1_MOUNTED_ON_FILEID  BIT(FATTR4_MOUNTED_ON_FILEID - 32)
583 #define FATTR4_WORD1_DACL               BIT(FATTR4_DACL	- 32)
584 #define FATTR4_WORD1_SACL               BIT(FATTR4_SACL	- 32)
585 #define FATTR4_WORD1_FS_LAYOUT_TYPES    BIT(FATTR4_FS_LAYOUT_TYPES - 32)
586 
587 #define FATTR4_WORD2_LAYOUT_TYPES       BIT(FATTR4_LAYOUT_TYPES - 64)
588 #define FATTR4_WORD2_LAYOUT_BLKSIZE     BIT(FATTR4_LAYOUT_BLKSIZE - 64)
589 #define FATTR4_WORD2_MDSTHRESHOLD       BIT(FATTR4_MDSTHRESHOLD	- 64)
590 #define FATTR4_WORD2_CLONE_BLKSIZE	BIT(FATTR4_CLONE_BLKSIZE - 64)
591 #define FATTR4_WORD2_CHANGE_ATTR_TYPE	BIT(FATTR4_CHANGE_ATTR_TYPE - 64)
592 #define FATTR4_WORD2_SECURITY_LABEL     BIT(FATTR4_SEC_LABEL - 64)
593 #define FATTR4_WORD2_MODE_UMASK		BIT(FATTR4_MODE_UMASK - 64)
594 #define FATTR4_WORD2_XATTR_SUPPORT	BIT(FATTR4_XATTR_SUPPORT - 64)
595 #define FATTR4_WORD2_TIME_DELEG_ACCESS	BIT(FATTR4_TIME_DELEG_ACCESS - 64)
596 #define FATTR4_WORD2_TIME_DELEG_MODIFY	BIT(FATTR4_TIME_DELEG_MODIFY - 64)
597 #define FATTR4_WORD2_OPEN_ARGUMENTS	BIT(FATTR4_OPEN_ARGUMENTS - 64)
598 
599 /* MDS threshold bitmap bits */
600 #define THRESHOLD_RD                    (1UL << 0)
601 #define THRESHOLD_WR                    (1UL << 1)
602 #define THRESHOLD_RD_IO                 (1UL << 2)
603 #define THRESHOLD_WR_IO                 (1UL << 3)
604 
605 #define NFSPROC4_NULL 0
606 #define NFSPROC4_COMPOUND 1
607 #define NFS4_VERSION 4
608 #define NFS4_MINOR_VERSION 0
609 
610 #define NFS4_DEBUG 1
611 
612 /*
613  * Index of predefined Linux client operations
614  *
615  * To ensure that /proc/net/rpc/nfs remains correctly ordered, please
616  * append only to this enum when adding new client operations.
617  */
618 
619 enum {
620 	NFSPROC4_CLNT_NULL = 0,		/* Unused */
621 	NFSPROC4_CLNT_READ,
622 	NFSPROC4_CLNT_WRITE,
623 	NFSPROC4_CLNT_COMMIT,
624 	NFSPROC4_CLNT_OPEN,
625 	NFSPROC4_CLNT_OPEN_CONFIRM,
626 	NFSPROC4_CLNT_OPEN_NOATTR,
627 	NFSPROC4_CLNT_OPEN_DOWNGRADE,
628 	NFSPROC4_CLNT_CLOSE,
629 	NFSPROC4_CLNT_SETATTR,
630 	NFSPROC4_CLNT_FSINFO,
631 	NFSPROC4_CLNT_RENEW,
632 	NFSPROC4_CLNT_SETCLIENTID,
633 	NFSPROC4_CLNT_SETCLIENTID_CONFIRM,
634 	NFSPROC4_CLNT_LOCK,
635 	NFSPROC4_CLNT_LOCKT,
636 	NFSPROC4_CLNT_LOCKU,
637 	NFSPROC4_CLNT_ACCESS,
638 	NFSPROC4_CLNT_GETATTR,
639 	NFSPROC4_CLNT_LOOKUP,
640 	NFSPROC4_CLNT_LOOKUP_ROOT,
641 	NFSPROC4_CLNT_REMOVE,
642 	NFSPROC4_CLNT_RENAME,
643 	NFSPROC4_CLNT_LINK,
644 	NFSPROC4_CLNT_SYMLINK,
645 	NFSPROC4_CLNT_CREATE,
646 	NFSPROC4_CLNT_PATHCONF,
647 	NFSPROC4_CLNT_STATFS,
648 	NFSPROC4_CLNT_READLINK,
649 	NFSPROC4_CLNT_READDIR,
650 	NFSPROC4_CLNT_SERVER_CAPS,
651 	NFSPROC4_CLNT_DELEGRETURN,
652 	NFSPROC4_CLNT_GETACL,
653 	NFSPROC4_CLNT_SETACL,
654 	NFSPROC4_CLNT_FS_LOCATIONS,
655 	NFSPROC4_CLNT_RELEASE_LOCKOWNER,
656 	NFSPROC4_CLNT_SECINFO,
657 	NFSPROC4_CLNT_FSID_PRESENT,
658 
659 	NFSPROC4_CLNT_EXCHANGE_ID,
660 	NFSPROC4_CLNT_CREATE_SESSION,
661 	NFSPROC4_CLNT_DESTROY_SESSION,
662 	NFSPROC4_CLNT_SEQUENCE,
663 	NFSPROC4_CLNT_GET_LEASE_TIME,
664 	NFSPROC4_CLNT_RECLAIM_COMPLETE,
665 	NFSPROC4_CLNT_LAYOUTGET,
666 	NFSPROC4_CLNT_GETDEVICEINFO,
667 	NFSPROC4_CLNT_LAYOUTCOMMIT,
668 	NFSPROC4_CLNT_LAYOUTRETURN,
669 	NFSPROC4_CLNT_SECINFO_NO_NAME,
670 	NFSPROC4_CLNT_TEST_STATEID,
671 	NFSPROC4_CLNT_FREE_STATEID,
672 	NFSPROC4_CLNT_GETDEVICELIST,
673 	NFSPROC4_CLNT_BIND_CONN_TO_SESSION,
674 	NFSPROC4_CLNT_DESTROY_CLIENTID,
675 
676 	NFSPROC4_CLNT_SEEK,
677 	NFSPROC4_CLNT_ALLOCATE,
678 	NFSPROC4_CLNT_DEALLOCATE,
679 	NFSPROC4_CLNT_LAYOUTSTATS,
680 	NFSPROC4_CLNT_CLONE,
681 	NFSPROC4_CLNT_COPY,
682 	NFSPROC4_CLNT_OFFLOAD_CANCEL,
683 
684 	NFSPROC4_CLNT_LOOKUPP,
685 	NFSPROC4_CLNT_LAYOUTERROR,
686 	NFSPROC4_CLNT_COPY_NOTIFY,
687 
688 	NFSPROC4_CLNT_GETXATTR,
689 	NFSPROC4_CLNT_SETXATTR,
690 	NFSPROC4_CLNT_LISTXATTRS,
691 	NFSPROC4_CLNT_REMOVEXATTR,
692 	NFSPROC4_CLNT_READ_PLUS,
693 };
694 
695 /* nfs41 types */
696 struct nfs4_sessionid {
697 	unsigned char data[NFS4_MAX_SESSIONID_LEN];
698 };
699 
700 /* Create Session Flags */
701 #define SESSION4_PERSIST	0x001
702 #define SESSION4_BACK_CHAN	0x002
703 #define SESSION4_RDMA		0x004
704 
705 #define SESSION4_FLAG_MASK_A	0x007
706 
707 enum state_protect_how4 {
708 	SP4_NONE	= 0,
709 	SP4_MACH_CRED	= 1,
710 	SP4_SSV		= 2
711 };
712 
713 /* GET_DIR_DELEGATION non-fatal status codes */
714 enum gddrnf4_status {
715 	GDD4_OK		= 0,
716 	GDD4_UNAVAIL	= 1
717 };
718 
719 enum pnfs_layouttype {
720 	LAYOUT_NFSV4_1_FILES  = 1,
721 	LAYOUT_OSD2_OBJECTS = 2,
722 	LAYOUT_BLOCK_VOLUME = 3,
723 	LAYOUT_FLEX_FILES = 4,
724 	LAYOUT_SCSI = 5,
725 	LAYOUT_TYPE_MAX
726 };
727 
728 /* used for both layout return and recall */
729 enum pnfs_layoutreturn_type {
730 	RETURN_FILE = 1,
731 	RETURN_FSID = 2,
732 	RETURN_ALL  = 3
733 };
734 
735 enum pnfs_iomode {
736 	IOMODE_READ = 1,
737 	IOMODE_RW = 2,
738 	IOMODE_ANY = 3,
739 };
740 
741 enum pnfs_notify_deviceid_type4 {
742 	NOTIFY_DEVICEID4_CHANGE = 1 << 1,
743 	NOTIFY_DEVICEID4_DELETE = 1 << 2,
744 };
745 
746 enum pnfs_block_volume_type {
747 	PNFS_BLOCK_VOLUME_SIMPLE	= 0,
748 	PNFS_BLOCK_VOLUME_SLICE		= 1,
749 	PNFS_BLOCK_VOLUME_CONCAT	= 2,
750 	PNFS_BLOCK_VOLUME_STRIPE	= 3,
751 	PNFS_BLOCK_VOLUME_SCSI		= 4,
752 };
753 
754 enum pnfs_block_extent_state {
755 	PNFS_BLOCK_READWRITE_DATA	= 0,
756 	PNFS_BLOCK_READ_DATA		= 1,
757 	PNFS_BLOCK_INVALID_DATA		= 2,
758 	PNFS_BLOCK_NONE_DATA		= 3,
759 };
760 
761 /* on the wire size of a block layout extent */
762 #define PNFS_BLOCK_EXTENT_SIZE \
763 	(7 * sizeof(__be32) + NFS4_DEVICEID4_SIZE)
764 
765 /* on the wire size of a scsi commit range */
766 #define PNFS_SCSI_RANGE_SIZE \
767 	(4 * sizeof(__be32))
768 
769 enum scsi_code_set {
770 	PS_CODE_SET_BINARY	= 1,
771 	PS_CODE_SET_ASCII	= 2,
772 	PS_CODE_SET_UTF8	= 3
773 };
774 
775 enum scsi_designator_type {
776 	PS_DESIGNATOR_T10	= 1,
777 	PS_DESIGNATOR_EUI64	= 2,
778 	PS_DESIGNATOR_NAA	= 3,
779 	PS_DESIGNATOR_NAME	= 8
780 };
781 
782 #define NFL4_UFLG_MASK			0x0000003F
783 #define NFL4_UFLG_DENSE			0x00000001
784 #define NFL4_UFLG_COMMIT_THRU_MDS	0x00000002
785 #define NFL4_UFLG_STRIPE_UNIT_SIZE_MASK	0xFFFFFFC0
786 
787 /* Encoded in the loh_body field of type layouthint4 */
788 enum filelayout_hint_care4 {
789 	NFLH4_CARE_DENSE		= NFL4_UFLG_DENSE,
790 	NFLH4_CARE_COMMIT_THRU_MDS	= NFL4_UFLG_COMMIT_THRU_MDS,
791 	NFLH4_CARE_STRIPE_UNIT_SIZE	= 0x00000040,
792 	NFLH4_CARE_STRIPE_COUNT		= 0x00000080
793 };
794 
795 #define NFS4_DEVICEID4_SIZE 16
796 
797 struct nfs4_deviceid {
798 	char data[NFS4_DEVICEID4_SIZE];
799 };
800 
801 enum data_content4 {
802 	NFS4_CONTENT_DATA		= 0,
803 	NFS4_CONTENT_HOLE		= 1,
804 };
805 
806 enum pnfs_update_layout_reason {
807 	PNFS_UPDATE_LAYOUT_UNKNOWN = 0,
808 	PNFS_UPDATE_LAYOUT_NO_PNFS,
809 	PNFS_UPDATE_LAYOUT_RD_ZEROLEN,
810 	PNFS_UPDATE_LAYOUT_MDSTHRESH,
811 	PNFS_UPDATE_LAYOUT_NOMEM,
812 	PNFS_UPDATE_LAYOUT_BULK_RECALL,
813 	PNFS_UPDATE_LAYOUT_IO_TEST_FAIL,
814 	PNFS_UPDATE_LAYOUT_FOUND_CACHED,
815 	PNFS_UPDATE_LAYOUT_RETURN,
816 	PNFS_UPDATE_LAYOUT_RETRY,
817 	PNFS_UPDATE_LAYOUT_BLOCKED,
818 	PNFS_UPDATE_LAYOUT_INVALID_OPEN,
819 	PNFS_UPDATE_LAYOUT_SEND_LAYOUTGET,
820 	PNFS_UPDATE_LAYOUT_EXIT,
821 };
822 
823 #define NFS4_OP_MAP_NUM_LONGS					\
824 	DIV_ROUND_UP(LAST_NFS4_OP, 8 * sizeof(unsigned long))
825 #define NFS4_OP_MAP_NUM_WORDS \
826 	(NFS4_OP_MAP_NUM_LONGS * sizeof(unsigned long) / sizeof(u32))
827 struct nfs4_op_map {
828 	union {
829 		unsigned long longs[NFS4_OP_MAP_NUM_LONGS];
830 		u32 words[NFS4_OP_MAP_NUM_WORDS];
831 	} u;
832 };
833 
834 struct nfs42_netaddr {
835 	char		netid[RPCBIND_MAXNETIDLEN];
836 	char		addr[RPCBIND_MAXUADDRLEN + 1];
837 	u32		netid_len;
838 	u32		addr_len;
839 };
840 
841 enum netloc_type4 {
842 	NL4_NAME		= 1,
843 	NL4_URL			= 2,
844 	NL4_NETADDR		= 3,
845 };
846 
847 struct nl4_server {
848 	enum netloc_type4	nl4_type;
849 	union {
850 		struct { /* NL4_NAME, NL4_URL */
851 			int	nl4_str_sz;
852 			char	nl4_str[NFS4_OPAQUE_LIMIT + 1];
853 		};
854 		struct nfs42_netaddr	nl4_addr; /* NL4_NETADDR */
855 	} u;
856 };
857 
858 enum nfs4_change_attr_type {
859 	NFS4_CHANGE_TYPE_IS_MONOTONIC_INCR = 0,
860 	NFS4_CHANGE_TYPE_IS_VERSION_COUNTER = 1,
861 	NFS4_CHANGE_TYPE_IS_VERSION_COUNTER_NOPNFS = 2,
862 	NFS4_CHANGE_TYPE_IS_TIME_METADATA = 3,
863 	NFS4_CHANGE_TYPE_IS_UNDEFINED = 4,
864 };
865 
866 /*
867  * Options for setxattr. These match the flags for setxattr(2).
868  */
869 enum nfs4_setxattr_options {
870 	SETXATTR4_EITHER	= 0,
871 	SETXATTR4_CREATE	= 1,
872 	SETXATTR4_REPLACE	= 2,
873 };
874 
875 enum {
876 	RCA4_TYPE_MASK_RDATA_DLG	= 0,
877 	RCA4_TYPE_MASK_WDATA_DLG	= 1,
878 	RCA4_TYPE_MASK_DIR_DLG		= 2,
879 	RCA4_TYPE_MASK_FILE_LAYOUT	= 3,
880 	RCA4_TYPE_MASK_BLK_LAYOUT	= 4,
881 	RCA4_TYPE_MASK_OBJ_LAYOUT_MIN	= 8,
882 	RCA4_TYPE_MASK_OBJ_LAYOUT_MAX	= 9,
883 	RCA4_TYPE_MASK_OTHER_LAYOUT_MIN	= 12,
884 	RCA4_TYPE_MASK_OTHER_LAYOUT_MAX	= 15,
885 };
886 
887 enum nfs_cb_opnum4 {
888 	OP_CB_GETATTR = 3,
889 	OP_CB_RECALL  = 4,
890 
891 	/* Callback operations new to NFSv4.1 */
892 	OP_CB_LAYOUTRECALL  = 5,
893 	OP_CB_NOTIFY        = 6,
894 	OP_CB_PUSH_DELEG    = 7,
895 	OP_CB_RECALL_ANY    = 8,
896 	OP_CB_RECALLABLE_OBJ_AVAIL = 9,
897 	OP_CB_RECALL_SLOT   = 10,
898 	OP_CB_SEQUENCE      = 11,
899 	OP_CB_WANTS_CANCELLED = 12,
900 	OP_CB_NOTIFY_LOCK   = 13,
901 	OP_CB_NOTIFY_DEVICEID = 14,
902 
903 	/* Callback operations new to NFSv4.2 */
904 	OP_CB_OFFLOAD = 15,
905 
906 	OP_CB_ILLEGAL = 10044,
907 };
908 
909 #endif
910