4 * NFSv4 protocol definitions.
6 * Copyright (c) 2002 The Regents of the University of Michigan.
9 * Kendrick Smith <kmsmith@umich.edu>
10 * Andy Adamson <andros@umich.edu>
15 #include <linux/list.h>
16 #include <linux/uidgid.h>
17 #include <uapi/linux/nfs4.h>
19 enum nfs4_acl_whotype {
20 NFS4_ACL_WHO_NAMED = 0,
23 NFS4_ACL_WHO_EVERYONE,
39 struct nfs4_ace aces[0];
42 #define NFS4_MAXLABELLEN 2048
51 typedef struct { char data[NFS4_VERIFIER_SIZE]; } nfs4_verifier;
55 char other[NFS4_STATEID_OTHER_SIZE];
56 } __attribute__ ((packed));
58 typedef struct nfs_stateid4 nfs4_stateid;
79 OP_OPEN_DOWNGRADE = 21,
94 OP_SETCLIENTID_CONFIRM = 36,
97 OP_RELEASE_LOCKOWNER = 39,
100 OP_BACKCHANNEL_CTL = 40,
101 OP_BIND_CONN_TO_SESSION = 41,
103 OP_CREATE_SESSION = 43,
104 OP_DESTROY_SESSION = 44,
105 OP_FREE_STATEID = 45,
106 OP_GET_DIR_DELEGATION = 46,
107 OP_GETDEVICEINFO = 47,
108 OP_GETDEVICELIST = 48,
109 OP_LAYOUTCOMMIT = 49,
111 OP_LAYOUTRETURN = 51,
112 OP_SECINFO_NO_NAME = 52,
115 OP_TEST_STATEID = 55,
116 OP_WANT_DELEGATION = 56,
117 OP_DESTROY_CLIENTID = 57,
118 OP_RECLAIM_COMPLETE = 58,
128 OP_OFFLOAD_CANCEL = 66,
129 OP_OFFLOAD_STATUS = 67,
138 /*Defining first and last NFS4 operations implemented.
139 Needs to be updated if more operations are defined in future.*/
141 #define FIRST_NFS4_OP OP_ACCESS
142 #define LAST_NFS4_OP OP_WRITE_SAME
143 #define LAST_NFS40_OP OP_RELEASE_LOCKOWNER
144 #define LAST_NFS41_OP OP_RECLAIM_COMPLETE
145 #define LAST_NFS42_OP OP_WRITE_SAME
156 /* Unused/reserved 19 */
164 NFS4ERR_NAMETOOLONG = 63,
165 NFS4ERR_NOTEMPTY = 66,
168 NFS4ERR_BADHANDLE = 10001,
169 NFS4ERR_BAD_COOKIE = 10003,
170 NFS4ERR_NOTSUPP = 10004,
171 NFS4ERR_TOOSMALL = 10005,
172 NFS4ERR_SERVERFAULT = 10006,
173 NFS4ERR_BADTYPE = 10007,
174 NFS4ERR_DELAY = 10008,
175 NFS4ERR_SAME = 10009,
176 NFS4ERR_DENIED = 10010,
177 NFS4ERR_EXPIRED = 10011,
178 NFS4ERR_LOCKED = 10012,
179 NFS4ERR_GRACE = 10013,
180 NFS4ERR_FHEXPIRED = 10014,
181 NFS4ERR_SHARE_DENIED = 10015,
182 NFS4ERR_WRONGSEC = 10016,
183 NFS4ERR_CLID_INUSE = 10017,
184 NFS4ERR_RESOURCE = 10018,
185 NFS4ERR_MOVED = 10019,
186 NFS4ERR_NOFILEHANDLE = 10020,
187 NFS4ERR_MINOR_VERS_MISMATCH = 10021,
188 NFS4ERR_STALE_CLIENTID = 10022,
189 NFS4ERR_STALE_STATEID = 10023,
190 NFS4ERR_OLD_STATEID = 10024,
191 NFS4ERR_BAD_STATEID = 10025,
192 NFS4ERR_BAD_SEQID = 10026,
193 NFS4ERR_NOT_SAME = 10027,
194 NFS4ERR_LOCK_RANGE = 10028,
195 NFS4ERR_SYMLINK = 10029,
196 NFS4ERR_RESTOREFH = 10030,
197 NFS4ERR_LEASE_MOVED = 10031,
198 NFS4ERR_ATTRNOTSUPP = 10032,
199 NFS4ERR_NO_GRACE = 10033,
200 NFS4ERR_RECLAIM_BAD = 10034,
201 NFS4ERR_RECLAIM_CONFLICT = 10035,
202 NFS4ERR_BADXDR = 10036,
203 NFS4ERR_LOCKS_HELD = 10037,
204 NFS4ERR_OPENMODE = 10038,
205 NFS4ERR_BADOWNER = 10039,
206 NFS4ERR_BADCHAR = 10040,
207 NFS4ERR_BADNAME = 10041,
208 NFS4ERR_BAD_RANGE = 10042,
209 NFS4ERR_LOCK_NOTSUPP = 10043,
210 NFS4ERR_OP_ILLEGAL = 10044,
211 NFS4ERR_DEADLOCK = 10045,
212 NFS4ERR_FILE_OPEN = 10046,
213 NFS4ERR_ADMIN_REVOKED = 10047,
214 NFS4ERR_CB_PATH_DOWN = 10048,
217 NFS4ERR_BADIOMODE = 10049,
218 NFS4ERR_BADLAYOUT = 10050,
219 NFS4ERR_BAD_SESSION_DIGEST = 10051,
220 NFS4ERR_BADSESSION = 10052,
221 NFS4ERR_BADSLOT = 10053,
222 NFS4ERR_COMPLETE_ALREADY = 10054,
223 NFS4ERR_CONN_NOT_BOUND_TO_SESSION = 10055,
224 NFS4ERR_DELEG_ALREADY_WANTED = 10056,
225 NFS4ERR_BACK_CHAN_BUSY = 10057, /* backchan reqs outstanding */
226 NFS4ERR_LAYOUTTRYLATER = 10058,
227 NFS4ERR_LAYOUTUNAVAILABLE = 10059,
228 NFS4ERR_NOMATCHING_LAYOUT = 10060,
229 NFS4ERR_RECALLCONFLICT = 10061,
230 NFS4ERR_UNKNOWN_LAYOUTTYPE = 10062,
231 NFS4ERR_SEQ_MISORDERED = 10063, /* unexpected seq.id in req */
232 NFS4ERR_SEQUENCE_POS = 10064, /* [CB_]SEQ. op not 1st op */
233 NFS4ERR_REQ_TOO_BIG = 10065, /* request too big */
234 NFS4ERR_REP_TOO_BIG = 10066, /* reply too big */
235 NFS4ERR_REP_TOO_BIG_TO_CACHE = 10067, /* rep. not all cached */
236 NFS4ERR_RETRY_UNCACHED_REP = 10068, /* retry & rep. uncached */
237 NFS4ERR_UNSAFE_COMPOUND = 10069, /* retry/recovery too hard */
238 NFS4ERR_TOO_MANY_OPS = 10070, /* too many ops in [CB_]COMP */
239 NFS4ERR_OP_NOT_IN_SESSION = 10071, /* op needs [CB_]SEQ. op */
240 NFS4ERR_HASH_ALG_UNSUPP = 10072, /* hash alg. not supp. */
241 /* Error 10073 is unused. */
242 NFS4ERR_CLIENTID_BUSY = 10074, /* clientid has state */
243 NFS4ERR_PNFS_IO_HOLE = 10075, /* IO to _SPARSE file hole */
244 NFS4ERR_SEQ_FALSE_RETRY = 10076, /* retry not original */
245 NFS4ERR_BAD_HIGH_SLOT = 10077, /* sequence arg bad */
246 NFS4ERR_DEADSESSION = 10078, /* persistent session dead */
247 NFS4ERR_ENCR_ALG_UNSUPP = 10079, /* SSV alg mismatch */
248 NFS4ERR_PNFS_NO_LAYOUT = 10080, /* direct I/O with no layout */
249 NFS4ERR_NOT_ONLY_OP = 10081, /* bad compound */
250 NFS4ERR_WRONG_CRED = 10082, /* permissions:state change */
251 NFS4ERR_WRONG_TYPE = 10083, /* current operation mismatch */
252 NFS4ERR_DIRDELEG_UNAVAIL = 10084, /* no directory delegation */
253 NFS4ERR_REJECT_DELEG = 10085, /* on callback */
254 NFS4ERR_RETURNCONFLICT = 10086, /* outstanding layoutreturn */
255 NFS4ERR_DELEG_REVOKED = 10087, /* deleg./layout revoked */
258 NFS4ERR_PARTNER_NOTSUPP = 10088,
259 NFS4ERR_PARTNER_NO_AUTH = 10089,
260 NFS4ERR_UNION_NOTSUPP = 10090,
261 NFS4ERR_OFFLOAD_DENIED = 10091,
262 NFS4ERR_WRONG_LFS = 10092,
263 NFS4ERR_BADLABEL = 10093,
264 NFS4ERR_OFFLOAD_NO_REQS = 10094,
267 static inline bool seqid_mutating_err(u32 err)
269 /* rfc 3530 section 8.1.5: */
271 case NFS4ERR_STALE_CLIENTID:
272 case NFS4ERR_STALE_STATEID:
273 case NFS4ERR_BAD_STATEID:
274 case NFS4ERR_BAD_SEQID:
276 case NFS4ERR_RESOURCE:
277 case NFS4ERR_NOFILEHANDLE:
284 * Note: NF4BAD is not actually part of the protocol; it is just used
285 * internally by nfsd.
289 NF4REG = 1, /* Regular File */
290 NF4DIR = 2, /* Directory */
291 NF4BLK = 3, /* Special File - block device */
292 NF4CHR = 4, /* Special File - character device */
293 NF4LNK = 5, /* Symbolic Link */
294 NF4SOCK = 6, /* Special File - socket */
295 NF4FIFO = 7, /* Special File - fifo */
296 NF4ATTRDIR = 8, /* Attribute Directory */
297 NF4NAMEDATTR = 9 /* Named Attribute */
300 enum open_claim_type4 {
301 NFS4_OPEN_CLAIM_NULL = 0,
302 NFS4_OPEN_CLAIM_PREVIOUS = 1,
303 NFS4_OPEN_CLAIM_DELEGATE_CUR = 2,
304 NFS4_OPEN_CLAIM_DELEGATE_PREV = 3,
305 NFS4_OPEN_CLAIM_FH = 4, /* 4.1 */
306 NFS4_OPEN_CLAIM_DELEG_CUR_FH = 5, /* 4.1 */
307 NFS4_OPEN_CLAIM_DELEG_PREV_FH = 6, /* 4.1 */
311 NFS4_OPEN_NOCREATE = 0,
316 NFS4_CREATE_UNCHECKED = 0,
317 NFS4_CREATE_GUARDED = 1,
318 NFS4_CREATE_EXCLUSIVE = 2,
320 * New to NFSv4.1. If session is persistent,
321 * GUARDED4 MUST be used. Otherwise, use
322 * EXCLUSIVE4_1 instead of EXCLUSIVE4.
324 NFS4_CREATE_EXCLUSIVE4_1 = 3
329 NFS4_LIMIT_BLOCKS = 2
332 enum open_delegation_type4 {
333 NFS4_OPEN_DELEGATE_NONE = 0,
334 NFS4_OPEN_DELEGATE_READ = 1,
335 NFS4_OPEN_DELEGATE_WRITE = 2,
336 NFS4_OPEN_DELEGATE_NONE_EXT = 3, /* 4.1 */
339 enum why_no_delegation4 { /* new to v4.1 */
343 WND4_NOT_SUPP_FTYPE = 3,
344 WND4_WRITE_DELEG_NOT_SUPP_FTYPE = 4,
345 WND4_NOT_SUPP_UPGRADE = 5,
346 WND4_NOT_SUPP_DOWNGRADE = 6,
360 /* Mandatory Attributes */
361 #define FATTR4_WORD0_SUPPORTED_ATTRS (1UL << 0)
362 #define FATTR4_WORD0_TYPE (1UL << 1)
363 #define FATTR4_WORD0_FH_EXPIRE_TYPE (1UL << 2)
364 #define FATTR4_WORD0_CHANGE (1UL << 3)
365 #define FATTR4_WORD0_SIZE (1UL << 4)
366 #define FATTR4_WORD0_LINK_SUPPORT (1UL << 5)
367 #define FATTR4_WORD0_SYMLINK_SUPPORT (1UL << 6)
368 #define FATTR4_WORD0_NAMED_ATTR (1UL << 7)
369 #define FATTR4_WORD0_FSID (1UL << 8)
370 #define FATTR4_WORD0_UNIQUE_HANDLES (1UL << 9)
371 #define FATTR4_WORD0_LEASE_TIME (1UL << 10)
372 #define FATTR4_WORD0_RDATTR_ERROR (1UL << 11)
373 /* Mandatory in NFSv4.1 */
374 #define FATTR4_WORD2_SUPPATTR_EXCLCREAT (1UL << 11)
376 /* Recommended Attributes */
377 #define FATTR4_WORD0_ACL (1UL << 12)
378 #define FATTR4_WORD0_ACLSUPPORT (1UL << 13)
379 #define FATTR4_WORD0_ARCHIVE (1UL << 14)
380 #define FATTR4_WORD0_CANSETTIME (1UL << 15)
381 #define FATTR4_WORD0_CASE_INSENSITIVE (1UL << 16)
382 #define FATTR4_WORD0_CASE_PRESERVING (1UL << 17)
383 #define FATTR4_WORD0_CHOWN_RESTRICTED (1UL << 18)
384 #define FATTR4_WORD0_FILEHANDLE (1UL << 19)
385 #define FATTR4_WORD0_FILEID (1UL << 20)
386 #define FATTR4_WORD0_FILES_AVAIL (1UL << 21)
387 #define FATTR4_WORD0_FILES_FREE (1UL << 22)
388 #define FATTR4_WORD0_FILES_TOTAL (1UL << 23)
389 #define FATTR4_WORD0_FS_LOCATIONS (1UL << 24)
390 #define FATTR4_WORD0_HIDDEN (1UL << 25)
391 #define FATTR4_WORD0_HOMOGENEOUS (1UL << 26)
392 #define FATTR4_WORD0_MAXFILESIZE (1UL << 27)
393 #define FATTR4_WORD0_MAXLINK (1UL << 28)
394 #define FATTR4_WORD0_MAXNAME (1UL << 29)
395 #define FATTR4_WORD0_MAXREAD (1UL << 30)
396 #define FATTR4_WORD0_MAXWRITE (1UL << 31)
397 #define FATTR4_WORD1_MIMETYPE (1UL << 0)
398 #define FATTR4_WORD1_MODE (1UL << 1)
399 #define FATTR4_WORD1_NO_TRUNC (1UL << 2)
400 #define FATTR4_WORD1_NUMLINKS (1UL << 3)
401 #define FATTR4_WORD1_OWNER (1UL << 4)
402 #define FATTR4_WORD1_OWNER_GROUP (1UL << 5)
403 #define FATTR4_WORD1_QUOTA_HARD (1UL << 6)
404 #define FATTR4_WORD1_QUOTA_SOFT (1UL << 7)
405 #define FATTR4_WORD1_QUOTA_USED (1UL << 8)
406 #define FATTR4_WORD1_RAWDEV (1UL << 9)
407 #define FATTR4_WORD1_SPACE_AVAIL (1UL << 10)
408 #define FATTR4_WORD1_SPACE_FREE (1UL << 11)
409 #define FATTR4_WORD1_SPACE_TOTAL (1UL << 12)
410 #define FATTR4_WORD1_SPACE_USED (1UL << 13)
411 #define FATTR4_WORD1_SYSTEM (1UL << 14)
412 #define FATTR4_WORD1_TIME_ACCESS (1UL << 15)
413 #define FATTR4_WORD1_TIME_ACCESS_SET (1UL << 16)
414 #define FATTR4_WORD1_TIME_BACKUP (1UL << 17)
415 #define FATTR4_WORD1_TIME_CREATE (1UL << 18)
416 #define FATTR4_WORD1_TIME_DELTA (1UL << 19)
417 #define FATTR4_WORD1_TIME_METADATA (1UL << 20)
418 #define FATTR4_WORD1_TIME_MODIFY (1UL << 21)
419 #define FATTR4_WORD1_TIME_MODIFY_SET (1UL << 22)
420 #define FATTR4_WORD1_MOUNTED_ON_FILEID (1UL << 23)
421 #define FATTR4_WORD1_FS_LAYOUT_TYPES (1UL << 30)
422 #define FATTR4_WORD2_LAYOUT_TYPES (1UL << 0)
423 #define FATTR4_WORD2_LAYOUT_BLKSIZE (1UL << 1)
424 #define FATTR4_WORD2_MDSTHRESHOLD (1UL << 4)
425 #define FATTR4_WORD2_CLONE_BLKSIZE (1UL << 13)
426 #define FATTR4_WORD2_SECURITY_LABEL (1UL << 16)
428 /* MDS threshold bitmap bits */
429 #define THRESHOLD_RD (1UL << 0)
430 #define THRESHOLD_WR (1UL << 1)
431 #define THRESHOLD_RD_IO (1UL << 2)
432 #define THRESHOLD_WR_IO (1UL << 3)
434 #define NFSPROC4_NULL 0
435 #define NFSPROC4_COMPOUND 1
436 #define NFS4_VERSION 4
437 #define NFS4_MINOR_VERSION 0
441 /* Index of predefined Linux client operations */
444 NFSPROC4_CLNT_NULL = 0, /* Unused */
447 NFSPROC4_CLNT_COMMIT,
449 NFSPROC4_CLNT_OPEN_CONFIRM,
450 NFSPROC4_CLNT_OPEN_NOATTR,
451 NFSPROC4_CLNT_OPEN_DOWNGRADE,
453 NFSPROC4_CLNT_SETATTR,
454 NFSPROC4_CLNT_FSINFO,
456 NFSPROC4_CLNT_SETCLIENTID,
457 NFSPROC4_CLNT_SETCLIENTID_CONFIRM,
461 NFSPROC4_CLNT_ACCESS,
462 NFSPROC4_CLNT_GETATTR,
463 NFSPROC4_CLNT_LOOKUP,
464 NFSPROC4_CLNT_LOOKUP_ROOT,
465 NFSPROC4_CLNT_REMOVE,
466 NFSPROC4_CLNT_RENAME,
468 NFSPROC4_CLNT_SYMLINK,
469 NFSPROC4_CLNT_CREATE,
470 NFSPROC4_CLNT_PATHCONF,
471 NFSPROC4_CLNT_STATFS,
472 NFSPROC4_CLNT_READLINK,
473 NFSPROC4_CLNT_READDIR,
474 NFSPROC4_CLNT_SERVER_CAPS,
475 NFSPROC4_CLNT_DELEGRETURN,
476 NFSPROC4_CLNT_GETACL,
477 NFSPROC4_CLNT_SETACL,
478 NFSPROC4_CLNT_FS_LOCATIONS,
479 NFSPROC4_CLNT_RELEASE_LOCKOWNER,
480 NFSPROC4_CLNT_SECINFO,
481 NFSPROC4_CLNT_FSID_PRESENT,
484 NFSPROC4_CLNT_EXCHANGE_ID,
485 NFSPROC4_CLNT_CREATE_SESSION,
486 NFSPROC4_CLNT_DESTROY_SESSION,
487 NFSPROC4_CLNT_SEQUENCE,
488 NFSPROC4_CLNT_GET_LEASE_TIME,
489 NFSPROC4_CLNT_RECLAIM_COMPLETE,
490 NFSPROC4_CLNT_LAYOUTGET,
491 NFSPROC4_CLNT_GETDEVICEINFO,
492 NFSPROC4_CLNT_LAYOUTCOMMIT,
493 NFSPROC4_CLNT_LAYOUTRETURN,
494 NFSPROC4_CLNT_SECINFO_NO_NAME,
495 NFSPROC4_CLNT_TEST_STATEID,
496 NFSPROC4_CLNT_FREE_STATEID,
497 NFSPROC4_CLNT_GETDEVICELIST,
498 NFSPROC4_CLNT_BIND_CONN_TO_SESSION,
499 NFSPROC4_CLNT_DESTROY_CLIENTID,
503 NFSPROC4_CLNT_ALLOCATE,
504 NFSPROC4_CLNT_DEALLOCATE,
505 NFSPROC4_CLNT_LAYOUTSTATS,
510 struct nfs4_sessionid {
511 unsigned char data[NFS4_MAX_SESSIONID_LEN];
514 /* Create Session Flags */
515 #define SESSION4_PERSIST 0x001
516 #define SESSION4_BACK_CHAN 0x002
517 #define SESSION4_RDMA 0x004
519 #define SESSION4_FLAG_MASK_A 0x007
521 enum state_protect_how4 {
527 enum pnfs_layouttype {
528 LAYOUT_NFSV4_1_FILES = 1,
529 LAYOUT_OSD2_OBJECTS = 2,
530 LAYOUT_BLOCK_VOLUME = 3,
531 LAYOUT_FLEX_FILES = 4,
535 /* used for both layout return and recall */
536 enum pnfs_layoutreturn_type {
548 enum pnfs_notify_deviceid_type4 {
549 NOTIFY_DEVICEID4_CHANGE = 1 << 1,
550 NOTIFY_DEVICEID4_DELETE = 1 << 2,
553 enum pnfs_block_volume_type {
554 PNFS_BLOCK_VOLUME_SIMPLE = 0,
555 PNFS_BLOCK_VOLUME_SLICE = 1,
556 PNFS_BLOCK_VOLUME_CONCAT = 2,
557 PNFS_BLOCK_VOLUME_STRIPE = 3,
560 enum pnfs_block_extent_state {
561 PNFS_BLOCK_READWRITE_DATA = 0,
562 PNFS_BLOCK_READ_DATA = 1,
563 PNFS_BLOCK_INVALID_DATA = 2,
564 PNFS_BLOCK_NONE_DATA = 3,
567 /* on the wire size of a block layout extent */
568 #define PNFS_BLOCK_EXTENT_SIZE \
569 (7 * sizeof(__be32) + NFS4_DEVICEID4_SIZE)
571 #define NFL4_UFLG_MASK 0x0000003F
572 #define NFL4_UFLG_DENSE 0x00000001
573 #define NFL4_UFLG_COMMIT_THRU_MDS 0x00000002
574 #define NFL4_UFLG_STRIPE_UNIT_SIZE_MASK 0xFFFFFFC0
576 /* Encoded in the loh_body field of type layouthint4 */
577 enum filelayout_hint_care4 {
578 NFLH4_CARE_DENSE = NFL4_UFLG_DENSE,
579 NFLH4_CARE_COMMIT_THRU_MDS = NFL4_UFLG_COMMIT_THRU_MDS,
580 NFLH4_CARE_STRIPE_UNIT_SIZE = 0x00000040,
581 NFLH4_CARE_STRIPE_COUNT = 0x00000080
584 #define NFS4_DEVICEID4_SIZE 16
586 struct nfs4_deviceid {
587 char data[NFS4_DEVICEID4_SIZE];
591 NFS4_CONTENT_DATA = 0,
592 NFS4_CONTENT_HOLE = 1,