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>
32 struct nfs4_ace aces
[0];
35 #define NFS4_MAXLABELLEN 2048
44 typedef struct { char data
[NFS4_VERIFIER_SIZE
]; } nfs4_verifier
;
48 char other
[NFS4_STATEID_OTHER_SIZE
];
49 } __attribute__ ((packed
));
51 typedef struct nfs_stateid4 nfs4_stateid
;
72 OP_OPEN_DOWNGRADE
= 21,
87 OP_SETCLIENTID_CONFIRM
= 36,
90 OP_RELEASE_LOCKOWNER
= 39,
93 OP_BACKCHANNEL_CTL
= 40,
94 OP_BIND_CONN_TO_SESSION
= 41,
96 OP_CREATE_SESSION
= 43,
97 OP_DESTROY_SESSION
= 44,
99 OP_GET_DIR_DELEGATION
= 46,
100 OP_GETDEVICEINFO
= 47,
101 OP_GETDEVICELIST
= 48,
102 OP_LAYOUTCOMMIT
= 49,
104 OP_LAYOUTRETURN
= 51,
105 OP_SECINFO_NO_NAME
= 52,
108 OP_TEST_STATEID
= 55,
109 OP_WANT_DELEGATION
= 56,
110 OP_DESTROY_CLIENTID
= 57,
111 OP_RECLAIM_COMPLETE
= 58,
116 /*Defining first and last NFS4 operations implemented.
117 Needs to be updated if more operations are defined in future.*/
119 #define FIRST_NFS4_OP OP_ACCESS
120 #define LAST_NFS4_OP OP_RECLAIM_COMPLETE
121 #define LAST_NFS40_OP OP_RELEASE_LOCKOWNER
122 #define LAST_NFS41_OP OP_RECLAIM_COMPLETE
123 #define LAST_NFS42_OP OP_RECLAIM_COMPLETE
134 /* Unused/reserved 19 */
142 NFS4ERR_NAMETOOLONG
= 63,
143 NFS4ERR_NOTEMPTY
= 66,
146 NFS4ERR_BADHANDLE
= 10001,
147 NFS4ERR_BAD_COOKIE
= 10003,
148 NFS4ERR_NOTSUPP
= 10004,
149 NFS4ERR_TOOSMALL
= 10005,
150 NFS4ERR_SERVERFAULT
= 10006,
151 NFS4ERR_BADTYPE
= 10007,
152 NFS4ERR_DELAY
= 10008,
153 NFS4ERR_SAME
= 10009,
154 NFS4ERR_DENIED
= 10010,
155 NFS4ERR_EXPIRED
= 10011,
156 NFS4ERR_LOCKED
= 10012,
157 NFS4ERR_GRACE
= 10013,
158 NFS4ERR_FHEXPIRED
= 10014,
159 NFS4ERR_SHARE_DENIED
= 10015,
160 NFS4ERR_WRONGSEC
= 10016,
161 NFS4ERR_CLID_INUSE
= 10017,
162 NFS4ERR_RESOURCE
= 10018,
163 NFS4ERR_MOVED
= 10019,
164 NFS4ERR_NOFILEHANDLE
= 10020,
165 NFS4ERR_MINOR_VERS_MISMATCH
= 10021,
166 NFS4ERR_STALE_CLIENTID
= 10022,
167 NFS4ERR_STALE_STATEID
= 10023,
168 NFS4ERR_OLD_STATEID
= 10024,
169 NFS4ERR_BAD_STATEID
= 10025,
170 NFS4ERR_BAD_SEQID
= 10026,
171 NFS4ERR_NOT_SAME
= 10027,
172 NFS4ERR_LOCK_RANGE
= 10028,
173 NFS4ERR_SYMLINK
= 10029,
174 NFS4ERR_RESTOREFH
= 10030,
175 NFS4ERR_LEASE_MOVED
= 10031,
176 NFS4ERR_ATTRNOTSUPP
= 10032,
177 NFS4ERR_NO_GRACE
= 10033,
178 NFS4ERR_RECLAIM_BAD
= 10034,
179 NFS4ERR_RECLAIM_CONFLICT
= 10035,
180 NFS4ERR_BADXDR
= 10036,
181 NFS4ERR_LOCKS_HELD
= 10037,
182 NFS4ERR_OPENMODE
= 10038,
183 NFS4ERR_BADOWNER
= 10039,
184 NFS4ERR_BADCHAR
= 10040,
185 NFS4ERR_BADNAME
= 10041,
186 NFS4ERR_BAD_RANGE
= 10042,
187 NFS4ERR_LOCK_NOTSUPP
= 10043,
188 NFS4ERR_OP_ILLEGAL
= 10044,
189 NFS4ERR_DEADLOCK
= 10045,
190 NFS4ERR_FILE_OPEN
= 10046,
191 NFS4ERR_ADMIN_REVOKED
= 10047,
192 NFS4ERR_CB_PATH_DOWN
= 10048,
195 NFS4ERR_BADIOMODE
= 10049,
196 NFS4ERR_BADLAYOUT
= 10050,
197 NFS4ERR_BAD_SESSION_DIGEST
= 10051,
198 NFS4ERR_BADSESSION
= 10052,
199 NFS4ERR_BADSLOT
= 10053,
200 NFS4ERR_COMPLETE_ALREADY
= 10054,
201 NFS4ERR_CONN_NOT_BOUND_TO_SESSION
= 10055,
202 NFS4ERR_DELEG_ALREADY_WANTED
= 10056,
203 NFS4ERR_BACK_CHAN_BUSY
= 10057, /* backchan reqs outstanding */
204 NFS4ERR_LAYOUTTRYLATER
= 10058,
205 NFS4ERR_LAYOUTUNAVAILABLE
= 10059,
206 NFS4ERR_NOMATCHING_LAYOUT
= 10060,
207 NFS4ERR_RECALLCONFLICT
= 10061,
208 NFS4ERR_UNKNOWN_LAYOUTTYPE
= 10062,
209 NFS4ERR_SEQ_MISORDERED
= 10063, /* unexpected seq.id in req */
210 NFS4ERR_SEQUENCE_POS
= 10064, /* [CB_]SEQ. op not 1st op */
211 NFS4ERR_REQ_TOO_BIG
= 10065, /* request too big */
212 NFS4ERR_REP_TOO_BIG
= 10066, /* reply too big */
213 NFS4ERR_REP_TOO_BIG_TO_CACHE
= 10067, /* rep. not all cached */
214 NFS4ERR_RETRY_UNCACHED_REP
= 10068, /* retry & rep. uncached */
215 NFS4ERR_UNSAFE_COMPOUND
= 10069, /* retry/recovery too hard */
216 NFS4ERR_TOO_MANY_OPS
= 10070, /* too many ops in [CB_]COMP */
217 NFS4ERR_OP_NOT_IN_SESSION
= 10071, /* op needs [CB_]SEQ. op */
218 NFS4ERR_HASH_ALG_UNSUPP
= 10072, /* hash alg. not supp. */
219 /* Error 10073 is unused. */
220 NFS4ERR_CLIENTID_BUSY
= 10074, /* clientid has state */
221 NFS4ERR_PNFS_IO_HOLE
= 10075, /* IO to _SPARSE file hole */
222 NFS4ERR_SEQ_FALSE_RETRY
= 10076, /* retry not original */
223 NFS4ERR_BAD_HIGH_SLOT
= 10077, /* sequence arg bad */
224 NFS4ERR_DEADSESSION
= 10078, /* persistent session dead */
225 NFS4ERR_ENCR_ALG_UNSUPP
= 10079, /* SSV alg mismatch */
226 NFS4ERR_PNFS_NO_LAYOUT
= 10080, /* direct I/O with no layout */
227 NFS4ERR_NOT_ONLY_OP
= 10081, /* bad compound */
228 NFS4ERR_WRONG_CRED
= 10082, /* permissions:state change */
229 NFS4ERR_WRONG_TYPE
= 10083, /* current operation mismatch */
230 NFS4ERR_DIRDELEG_UNAVAIL
= 10084, /* no directory delegation */
231 NFS4ERR_REJECT_DELEG
= 10085, /* on callback */
232 NFS4ERR_RETURNCONFLICT
= 10086, /* outstanding layoutreturn */
233 NFS4ERR_DELEG_REVOKED
= 10087, /* deleg./layout revoked */
236 NFS4ERR_PARTNER_NOTSUPP
= 10088,
237 NFS4ERR_PARTNER_NO_AUTH
= 10089,
238 NFS4ERR_METADATA_NOTSUPP
= 10090,
239 NFS4ERR_OFFLOAD_DENIED
= 10091,
240 NFS4ERR_WRONG_LFS
= 10092,
241 NFS4ERR_BADLABEL
= 10093,
244 static inline bool seqid_mutating_err(u32 err
)
246 /* rfc 3530 section 8.1.5: */
248 case NFS4ERR_STALE_CLIENTID
:
249 case NFS4ERR_STALE_STATEID
:
250 case NFS4ERR_BAD_STATEID
:
251 case NFS4ERR_BAD_SEQID
:
253 case NFS4ERR_RESOURCE
:
254 case NFS4ERR_NOFILEHANDLE
:
261 * Note: NF4BAD is not actually part of the protocol; it is just used
262 * internally by nfsd.
266 NF4REG
= 1, /* Regular File */
267 NF4DIR
= 2, /* Directory */
268 NF4BLK
= 3, /* Special File - block device */
269 NF4CHR
= 4, /* Special File - character device */
270 NF4LNK
= 5, /* Symbolic Link */
271 NF4SOCK
= 6, /* Special File - socket */
272 NF4FIFO
= 7, /* Special File - fifo */
273 NF4ATTRDIR
= 8, /* Attribute Directory */
274 NF4NAMEDATTR
= 9 /* Named Attribute */
277 enum open_claim_type4
{
278 NFS4_OPEN_CLAIM_NULL
= 0,
279 NFS4_OPEN_CLAIM_PREVIOUS
= 1,
280 NFS4_OPEN_CLAIM_DELEGATE_CUR
= 2,
281 NFS4_OPEN_CLAIM_DELEGATE_PREV
= 3,
282 NFS4_OPEN_CLAIM_FH
= 4, /* 4.1 */
283 NFS4_OPEN_CLAIM_DELEG_CUR_FH
= 5, /* 4.1 */
284 NFS4_OPEN_CLAIM_DELEG_PREV_FH
= 6, /* 4.1 */
288 NFS4_OPEN_NOCREATE
= 0,
293 NFS4_CREATE_UNCHECKED
= 0,
294 NFS4_CREATE_GUARDED
= 1,
295 NFS4_CREATE_EXCLUSIVE
= 2,
297 * New to NFSv4.1. If session is persistent,
298 * GUARDED4 MUST be used. Otherwise, use
299 * EXCLUSIVE4_1 instead of EXCLUSIVE4.
301 NFS4_CREATE_EXCLUSIVE4_1
= 3
306 NFS4_LIMIT_BLOCKS
= 2
309 enum open_delegation_type4
{
310 NFS4_OPEN_DELEGATE_NONE
= 0,
311 NFS4_OPEN_DELEGATE_READ
= 1,
312 NFS4_OPEN_DELEGATE_WRITE
= 2,
313 NFS4_OPEN_DELEGATE_NONE_EXT
= 3, /* 4.1 */
316 enum why_no_delegation4
{ /* new to v4.1 */
320 WND4_NOT_SUPP_FTYPE
= 3,
321 WND4_WRITE_DELEG_NOT_SUPP_FTYPE
= 4,
322 WND4_NOT_SUPP_UPGRADE
= 5,
323 WND4_NOT_SUPP_DOWNGRADE
= 6,
337 /* Mandatory Attributes */
338 #define FATTR4_WORD0_SUPPORTED_ATTRS (1UL << 0)
339 #define FATTR4_WORD0_TYPE (1UL << 1)
340 #define FATTR4_WORD0_FH_EXPIRE_TYPE (1UL << 2)
341 #define FATTR4_WORD0_CHANGE (1UL << 3)
342 #define FATTR4_WORD0_SIZE (1UL << 4)
343 #define FATTR4_WORD0_LINK_SUPPORT (1UL << 5)
344 #define FATTR4_WORD0_SYMLINK_SUPPORT (1UL << 6)
345 #define FATTR4_WORD0_NAMED_ATTR (1UL << 7)
346 #define FATTR4_WORD0_FSID (1UL << 8)
347 #define FATTR4_WORD0_UNIQUE_HANDLES (1UL << 9)
348 #define FATTR4_WORD0_LEASE_TIME (1UL << 10)
349 #define FATTR4_WORD0_RDATTR_ERROR (1UL << 11)
350 /* Mandatory in NFSv4.1 */
351 #define FATTR4_WORD2_SUPPATTR_EXCLCREAT (1UL << 11)
353 /* Recommended Attributes */
354 #define FATTR4_WORD0_ACL (1UL << 12)
355 #define FATTR4_WORD0_ACLSUPPORT (1UL << 13)
356 #define FATTR4_WORD0_ARCHIVE (1UL << 14)
357 #define FATTR4_WORD0_CANSETTIME (1UL << 15)
358 #define FATTR4_WORD0_CASE_INSENSITIVE (1UL << 16)
359 #define FATTR4_WORD0_CASE_PRESERVING (1UL << 17)
360 #define FATTR4_WORD0_CHOWN_RESTRICTED (1UL << 18)
361 #define FATTR4_WORD0_FILEHANDLE (1UL << 19)
362 #define FATTR4_WORD0_FILEID (1UL << 20)
363 #define FATTR4_WORD0_FILES_AVAIL (1UL << 21)
364 #define FATTR4_WORD0_FILES_FREE (1UL << 22)
365 #define FATTR4_WORD0_FILES_TOTAL (1UL << 23)
366 #define FATTR4_WORD0_FS_LOCATIONS (1UL << 24)
367 #define FATTR4_WORD0_HIDDEN (1UL << 25)
368 #define FATTR4_WORD0_HOMOGENEOUS (1UL << 26)
369 #define FATTR4_WORD0_MAXFILESIZE (1UL << 27)
370 #define FATTR4_WORD0_MAXLINK (1UL << 28)
371 #define FATTR4_WORD0_MAXNAME (1UL << 29)
372 #define FATTR4_WORD0_MAXREAD (1UL << 30)
373 #define FATTR4_WORD0_MAXWRITE (1UL << 31)
374 #define FATTR4_WORD1_MIMETYPE (1UL << 0)
375 #define FATTR4_WORD1_MODE (1UL << 1)
376 #define FATTR4_WORD1_NO_TRUNC (1UL << 2)
377 #define FATTR4_WORD1_NUMLINKS (1UL << 3)
378 #define FATTR4_WORD1_OWNER (1UL << 4)
379 #define FATTR4_WORD1_OWNER_GROUP (1UL << 5)
380 #define FATTR4_WORD1_QUOTA_HARD (1UL << 6)
381 #define FATTR4_WORD1_QUOTA_SOFT (1UL << 7)
382 #define FATTR4_WORD1_QUOTA_USED (1UL << 8)
383 #define FATTR4_WORD1_RAWDEV (1UL << 9)
384 #define FATTR4_WORD1_SPACE_AVAIL (1UL << 10)
385 #define FATTR4_WORD1_SPACE_FREE (1UL << 11)
386 #define FATTR4_WORD1_SPACE_TOTAL (1UL << 12)
387 #define FATTR4_WORD1_SPACE_USED (1UL << 13)
388 #define FATTR4_WORD1_SYSTEM (1UL << 14)
389 #define FATTR4_WORD1_TIME_ACCESS (1UL << 15)
390 #define FATTR4_WORD1_TIME_ACCESS_SET (1UL << 16)
391 #define FATTR4_WORD1_TIME_BACKUP (1UL << 17)
392 #define FATTR4_WORD1_TIME_CREATE (1UL << 18)
393 #define FATTR4_WORD1_TIME_DELTA (1UL << 19)
394 #define FATTR4_WORD1_TIME_METADATA (1UL << 20)
395 #define FATTR4_WORD1_TIME_MODIFY (1UL << 21)
396 #define FATTR4_WORD1_TIME_MODIFY_SET (1UL << 22)
397 #define FATTR4_WORD1_MOUNTED_ON_FILEID (1UL << 23)
398 #define FATTR4_WORD1_FS_LAYOUT_TYPES (1UL << 30)
399 #define FATTR4_WORD2_LAYOUT_BLKSIZE (1UL << 1)
400 #define FATTR4_WORD2_MDSTHRESHOLD (1UL << 4)
401 #define FATTR4_WORD2_SECURITY_LABEL (1UL << 16)
403 /* MDS threshold bitmap bits */
404 #define THRESHOLD_RD (1UL << 0)
405 #define THRESHOLD_WR (1UL << 1)
406 #define THRESHOLD_RD_IO (1UL << 2)
407 #define THRESHOLD_WR_IO (1UL << 3)
409 #define NFSPROC4_NULL 0
410 #define NFSPROC4_COMPOUND 1
411 #define NFS4_VERSION 4
412 #define NFS4_MINOR_VERSION 0
416 /* Index of predefined Linux client operations */
419 NFSPROC4_CLNT_NULL
= 0, /* Unused */
422 NFSPROC4_CLNT_COMMIT
,
424 NFSPROC4_CLNT_OPEN_CONFIRM
,
425 NFSPROC4_CLNT_OPEN_NOATTR
,
426 NFSPROC4_CLNT_OPEN_DOWNGRADE
,
428 NFSPROC4_CLNT_SETATTR
,
429 NFSPROC4_CLNT_FSINFO
,
431 NFSPROC4_CLNT_SETCLIENTID
,
432 NFSPROC4_CLNT_SETCLIENTID_CONFIRM
,
436 NFSPROC4_CLNT_ACCESS
,
437 NFSPROC4_CLNT_GETATTR
,
438 NFSPROC4_CLNT_LOOKUP
,
439 NFSPROC4_CLNT_LOOKUP_ROOT
,
440 NFSPROC4_CLNT_REMOVE
,
441 NFSPROC4_CLNT_RENAME
,
443 NFSPROC4_CLNT_SYMLINK
,
444 NFSPROC4_CLNT_CREATE
,
445 NFSPROC4_CLNT_PATHCONF
,
446 NFSPROC4_CLNT_STATFS
,
447 NFSPROC4_CLNT_READLINK
,
448 NFSPROC4_CLNT_READDIR
,
449 NFSPROC4_CLNT_SERVER_CAPS
,
450 NFSPROC4_CLNT_DELEGRETURN
,
451 NFSPROC4_CLNT_GETACL
,
452 NFSPROC4_CLNT_SETACL
,
453 NFSPROC4_CLNT_FS_LOCATIONS
,
454 NFSPROC4_CLNT_RELEASE_LOCKOWNER
,
455 NFSPROC4_CLNT_SECINFO
,
456 NFSPROC4_CLNT_FSID_PRESENT
,
459 NFSPROC4_CLNT_EXCHANGE_ID
,
460 NFSPROC4_CLNT_CREATE_SESSION
,
461 NFSPROC4_CLNT_DESTROY_SESSION
,
462 NFSPROC4_CLNT_SEQUENCE
,
463 NFSPROC4_CLNT_GET_LEASE_TIME
,
464 NFSPROC4_CLNT_RECLAIM_COMPLETE
,
465 NFSPROC4_CLNT_LAYOUTGET
,
466 NFSPROC4_CLNT_GETDEVICEINFO
,
467 NFSPROC4_CLNT_LAYOUTCOMMIT
,
468 NFSPROC4_CLNT_LAYOUTRETURN
,
469 NFSPROC4_CLNT_SECINFO_NO_NAME
,
470 NFSPROC4_CLNT_TEST_STATEID
,
471 NFSPROC4_CLNT_FREE_STATEID
,
472 NFSPROC4_CLNT_GETDEVICELIST
,
473 NFSPROC4_CLNT_BIND_CONN_TO_SESSION
,
474 NFSPROC4_CLNT_DESTROY_CLIENTID
,
478 struct nfs4_sessionid
{
479 unsigned char data
[NFS4_MAX_SESSIONID_LEN
];
482 /* Create Session Flags */
483 #define SESSION4_PERSIST 0x001
484 #define SESSION4_BACK_CHAN 0x002
485 #define SESSION4_RDMA 0x004
487 #define SESSION4_FLAG_MASK_A 0x007
489 enum state_protect_how4
{
495 enum pnfs_layouttype
{
496 LAYOUT_NFSV4_1_FILES
= 1,
497 LAYOUT_OSD2_OBJECTS
= 2,
498 LAYOUT_BLOCK_VOLUME
= 3,
501 /* used for both layout return and recall */
502 enum pnfs_layoutreturn_type
{
514 enum pnfs_notify_deviceid_type4
{
515 NOTIFY_DEVICEID4_CHANGE
= 1 << 1,
516 NOTIFY_DEVICEID4_DELETE
= 1 << 2,
519 #define NFL4_UFLG_MASK 0x0000003F
520 #define NFL4_UFLG_DENSE 0x00000001
521 #define NFL4_UFLG_COMMIT_THRU_MDS 0x00000002
522 #define NFL4_UFLG_STRIPE_UNIT_SIZE_MASK 0xFFFFFFC0
524 /* Encoded in the loh_body field of type layouthint4 */
525 enum filelayout_hint_care4
{
526 NFLH4_CARE_DENSE
= NFL4_UFLG_DENSE
,
527 NFLH4_CARE_COMMIT_THRU_MDS
= NFL4_UFLG_COMMIT_THRU_MDS
,
528 NFLH4_CARE_STRIPE_UNIT_SIZE
= 0x00000040,
529 NFLH4_CARE_STRIPE_COUNT
= 0x00000080
532 #define NFS4_DEVICEID4_SIZE 16
534 struct nfs4_deviceid
{
535 char data
[NFS4_DEVICEID4_SIZE
];