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