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