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