blob: 9dc7eeac924f08f715e21b3105897eef0977d238 [file] [log] [blame]
Greg Kroah-Hartmanb2441312017-11-01 15:07:57 +01001/* SPDX-License-Identifier: GPL-2.0 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
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 <[email protected]>
11 * Andy Adamson <[email protected]>
12 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070013#ifndef _LINUX_NFS4_H
14#define _LINUX_NFS4_H
15
David Woodhouse997b7af2006-04-25 14:51:45 +010016#include <linux/list.h>
Eric W. Biedermanab8e4ae2013-02-02 05:18:08 -080017#include <linux/uidgid.h>
David Howells607ca462012-10-13 10:46:48 +010018#include <uapi/linux/nfs4.h>
Olga Kornievskaiaf9bdad82018-10-29 13:23:40 -040019#include <linux/sunrpc/msg_prot.h>
David Woodhouse997b7af2006-04-25 14:51:45 +010020
Andreas Gruenbacherbff17522015-03-27 17:50:00 +010021enum 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
Linus Torvalds1da177e2005-04-16 15:20:36 -070028struct nfs4_ace {
29 uint32_t type;
30 uint32_t flag;
31 uint32_t access_mask;
32 int whotype;
Eric W. Biedermanab8e4ae2013-02-02 05:18:08 -080033 union {
34 kuid_t who_uid;
35 kgid_t who_gid;
36 };
Linus Torvalds1da177e2005-04-16 15:20:36 -070037};
38
39struct nfs4_acl {
40 uint32_t naces;
Gustavo A. R. Silva1ad8dd92020-05-07 14:02:23 -050041 struct nfs4_ace aces[];
Linus Torvalds1da177e2005-04-16 15:20:36 -070042};
43
Steve Dicksone058f702013-05-22 12:50:40 -040044#define NFS4_MAXLABELLEN 2048
45
46struct nfs4_label {
47 uint32_t lfs;
48 uint32_t pi;
49 u32 len;
50 char *label;
51};
52
Linus Torvalds1da177e2005-04-16 15:20:36 -070053typedef struct { char data[NFS4_VERIFIER_SIZE]; } nfs4_verifier;
Alexandros Batsakis94499252010-10-20 00:17:56 -040054
Trond Myklebust93b717f2016-05-16 17:42:43 -040055struct 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 };
Alexandros Batsakis94499252010-10-20 00:17:56 -040063
Trond Myklebust93b717f2016-05-16 17:42:43 -040064 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,
Trond Myklebustf7a62ad2016-09-22 13:39:02 -040072 NFS4_REVOKED_STATEID_TYPE,
Trond Myklebust93b717f2016-05-16 17:42:43 -040073 } type;
74};
75
76typedef struct nfs4_stateid_struct nfs4_stateid;
Linus Torvalds1da177e2005-04-16 15:20:36 -070077
78enum 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,
Benny Halevy18df1882009-04-03 08:27:36 +0300116
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
Anna Schumaker87a15a82014-09-26 13:58:26 -0400138 /* 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,
Peng Tao36022772015-09-26 02:24:34 +0800151 OP_CLONE = 71,
Anna Schumaker87a15a82014-09-26 13:58:26 -0400152
Frank van der Lindenc1326212020-06-23 22:39:20 +0000153 /* xattr support (RFC8726) */
154 OP_GETXATTR = 72,
155 OP_SETXATTR = 73,
156 OP_LISTXATTRS = 74,
157 OP_REMOVEXATTR = 75,
158
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159 OP_ILLEGAL = 10044,
160};
161
Shankar Anande2b20952006-07-10 04:45:44 -0700162/*Defining first and last NFS4 operations implemented.
163Needs to be updated if more operations are defined in future.*/
164
165#define FIRST_NFS4_OP OP_ACCESS
Anna Schumaker8217d142013-10-30 13:38:13 -0400166#define LAST_NFS40_OP OP_RELEASE_LOCKOWNER
167#define LAST_NFS41_OP OP_RECLAIM_COMPLETE
Frank van der Linden23e50fe32020-06-23 22:39:26 +0000168#define LAST_NFS42_OP OP_REMOVEXATTR
Christoph Hellwigffa01602015-12-03 12:59:52 +0100169#define LAST_NFS4_OP LAST_NFS42_OP
Shankar Anande2b20952006-07-10 04:45:44 -0700170
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171enum 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,
Benny Halevy18df1882009-04-03 08:27:36 +0300238 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 */
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300268 NFS4ERR_SEQ_FALSE_RETRY = 10076, /* retry not original */
Benny Halevy18df1882009-04-03 08:27:36 +0300269 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 */
Steve Dickson4488cc92013-05-02 13:18:55 -0400280
281 /* nfs42 */
282 NFS4ERR_PARTNER_NOTSUPP = 10088,
283 NFS4ERR_PARTNER_NO_AUTH = 10089,
Anna Schumaker2b8941b2014-08-27 11:17:56 -0400284 NFS4ERR_UNION_NOTSUPP = 10090,
Steve Dickson4488cc92013-05-02 13:18:55 -0400285 NFS4ERR_OFFLOAD_DENIED = 10091,
286 NFS4ERR_WRONG_LFS = 10092,
287 NFS4ERR_BADLABEL = 10093,
Anna Schumaker2b8941b2014-08-27 11:17:56 -0400288 NFS4ERR_OFFLOAD_NO_REQS = 10094,
Frank van der Lindenc1326212020-06-23 22:39:20 +0000289
290 /* xattr (RFC8276) */
291 NFS4ERR_NOXATTR = 10095,
292 NFS4ERR_XATTR2BIG = 10096,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293};
294
J. Bruce Fieldsa9004ab2011-08-23 15:43:04 -0400295static inline bool seqid_mutating_err(u32 err)
296{
Chuck Lever059aa7342017-01-22 14:04:29 -0500297 /* See RFC 7530, section 9.1.7 */
J. Bruce Fieldsa9004ab2011-08-23 15:43:04 -0400298 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:
Chuck Lever059aa7342017-01-22 14:04:29 -0500306 case NFS4ERR_MOVED:
J. Bruce Fieldsa9004ab2011-08-23 15:43:04 -0400307 return false;
Zheng Bind04659d2020-04-24 16:17:23 +0800308 }
J. Bruce Fieldsa9004ab2011-08-23 15:43:04 -0400309 return true;
310}
311
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312/*
313 * Note: NF4BAD is not actually part of the protocol; it is just used
314 * internally by nfsd.
315 */
316enum 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
329enum open_claim_type4 {
330 NFS4_OPEN_CLAIM_NULL = 0,
331 NFS4_OPEN_CLAIM_PREVIOUS = 1,
332 NFS4_OPEN_CLAIM_DELEGATE_CUR = 2,
J. Bruce Fields8b289b22011-10-19 11:52:12 -0400333 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 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337};
338
339enum opentype4 {
340 NFS4_OPEN_NOCREATE = 0,
341 NFS4_OPEN_CREATE = 1
342};
343
344enum createmode4 {
345 NFS4_CREATE_UNCHECKED = 0,
346 NFS4_CREATE_GUARDED = 1,
Benny Halevy79fb54a2009-04-03 08:29:17 +0300347 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
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354};
355
356enum limit_by4 {
357 NFS4_LIMIT_SIZE = 1,
358 NFS4_LIMIT_BLOCKS = 2
359};
360
361enum open_delegation_type4 {
362 NFS4_OPEN_DELEGATE_NONE = 0,
363 NFS4_OPEN_DELEGATE_READ = 1,
Benny Halevyd24433c2012-02-16 20:57:17 +0200364 NFS4_OPEN_DELEGATE_WRITE = 2,
365 NFS4_OPEN_DELEGATE_NONE_EXT = 3, /* 4.1 */
366};
367
368enum 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,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378};
379
380enum 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
J. Bruce Fieldsa8585762018-04-25 13:26:23 -0400388enum change_attr_type4 {
389 NFS4_CHANGE_TYPE_IS_MONOTONIC_INCR = 0,
390 NFS4_CHANGE_TYPE_IS_VERSION_COUNTER = 1,
391 NFS4_CHANGE_TYPE_IS_VERSION_COUNTER_NOPNFS = 2,
392 NFS4_CHANGE_TYPE_IS_TIME_METADATA = 3,
393 NFS4_CHANGE_TYPE_IS_UNDEFINED = 4
394};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395
396/* Mandatory Attributes */
397#define FATTR4_WORD0_SUPPORTED_ATTRS (1UL << 0)
398#define FATTR4_WORD0_TYPE (1UL << 1)
399#define FATTR4_WORD0_FH_EXPIRE_TYPE (1UL << 2)
400#define FATTR4_WORD0_CHANGE (1UL << 3)
401#define FATTR4_WORD0_SIZE (1UL << 4)
402#define FATTR4_WORD0_LINK_SUPPORT (1UL << 5)
403#define FATTR4_WORD0_SYMLINK_SUPPORT (1UL << 6)
404#define FATTR4_WORD0_NAMED_ATTR (1UL << 7)
405#define FATTR4_WORD0_FSID (1UL << 8)
406#define FATTR4_WORD0_UNIQUE_HANDLES (1UL << 9)
407#define FATTR4_WORD0_LEASE_TIME (1UL << 10)
408#define FATTR4_WORD0_RDATTR_ERROR (1UL << 11)
Benny Halevy8c18f202009-04-03 08:29:14 +0300409/* Mandatory in NFSv4.1 */
410#define FATTR4_WORD2_SUPPATTR_EXCLCREAT (1UL << 11)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411
412/* Recommended Attributes */
413#define FATTR4_WORD0_ACL (1UL << 12)
414#define FATTR4_WORD0_ACLSUPPORT (1UL << 13)
415#define FATTR4_WORD0_ARCHIVE (1UL << 14)
416#define FATTR4_WORD0_CANSETTIME (1UL << 15)
417#define FATTR4_WORD0_CASE_INSENSITIVE (1UL << 16)
418#define FATTR4_WORD0_CASE_PRESERVING (1UL << 17)
419#define FATTR4_WORD0_CHOWN_RESTRICTED (1UL << 18)
420#define FATTR4_WORD0_FILEHANDLE (1UL << 19)
421#define FATTR4_WORD0_FILEID (1UL << 20)
422#define FATTR4_WORD0_FILES_AVAIL (1UL << 21)
423#define FATTR4_WORD0_FILES_FREE (1UL << 22)
424#define FATTR4_WORD0_FILES_TOTAL (1UL << 23)
425#define FATTR4_WORD0_FS_LOCATIONS (1UL << 24)
426#define FATTR4_WORD0_HIDDEN (1UL << 25)
427#define FATTR4_WORD0_HOMOGENEOUS (1UL << 26)
428#define FATTR4_WORD0_MAXFILESIZE (1UL << 27)
429#define FATTR4_WORD0_MAXLINK (1UL << 28)
430#define FATTR4_WORD0_MAXNAME (1UL << 29)
431#define FATTR4_WORD0_MAXREAD (1UL << 30)
432#define FATTR4_WORD0_MAXWRITE (1UL << 31)
433#define FATTR4_WORD1_MIMETYPE (1UL << 0)
434#define FATTR4_WORD1_MODE (1UL << 1)
435#define FATTR4_WORD1_NO_TRUNC (1UL << 2)
436#define FATTR4_WORD1_NUMLINKS (1UL << 3)
437#define FATTR4_WORD1_OWNER (1UL << 4)
438#define FATTR4_WORD1_OWNER_GROUP (1UL << 5)
439#define FATTR4_WORD1_QUOTA_HARD (1UL << 6)
440#define FATTR4_WORD1_QUOTA_SOFT (1UL << 7)
441#define FATTR4_WORD1_QUOTA_USED (1UL << 8)
442#define FATTR4_WORD1_RAWDEV (1UL << 9)
443#define FATTR4_WORD1_SPACE_AVAIL (1UL << 10)
444#define FATTR4_WORD1_SPACE_FREE (1UL << 11)
445#define FATTR4_WORD1_SPACE_TOTAL (1UL << 12)
446#define FATTR4_WORD1_SPACE_USED (1UL << 13)
447#define FATTR4_WORD1_SYSTEM (1UL << 14)
448#define FATTR4_WORD1_TIME_ACCESS (1UL << 15)
449#define FATTR4_WORD1_TIME_ACCESS_SET (1UL << 16)
450#define FATTR4_WORD1_TIME_BACKUP (1UL << 17)
451#define FATTR4_WORD1_TIME_CREATE (1UL << 18)
452#define FATTR4_WORD1_TIME_DELTA (1UL << 19)
453#define FATTR4_WORD1_TIME_METADATA (1UL << 20)
454#define FATTR4_WORD1_TIME_MODIFY (1UL << 21)
455#define FATTR4_WORD1_TIME_MODIFY_SET (1UL << 22)
456#define FATTR4_WORD1_MOUNTED_ON_FILEID (1UL << 23)
Dean Hildebrandc772567d2010-10-20 00:17:55 -0400457#define FATTR4_WORD1_FS_LAYOUT_TYPES (1UL << 30)
Christoph Hellwig9cf514c2014-05-05 13:11:59 +0200458#define FATTR4_WORD2_LAYOUT_TYPES (1UL << 0)
Dean Hildebrandc772567d2010-10-20 00:17:55 -0400459#define FATTR4_WORD2_LAYOUT_BLKSIZE (1UL << 1)
Andy Adamson88034c32012-05-23 05:02:34 -0400460#define FATTR4_WORD2_MDSTHRESHOLD (1UL << 4)
Peng Tao2a92ee92015-09-26 02:24:37 +0800461#define FATTR4_WORD2_CLONE_BLKSIZE (1UL << 13)
J. Bruce Fieldsa8585762018-04-25 13:26:23 -0400462#define FATTR4_WORD2_CHANGE_ATTR_TYPE (1UL << 15)
Trond Myklebustf3f5a0f2013-11-04 14:38:05 -0500463#define FATTR4_WORD2_SECURITY_LABEL (1UL << 16)
Andreas Gruenbacherdff25dd2016-12-02 22:53:30 -0500464#define FATTR4_WORD2_MODE_UMASK (1UL << 17)
Frank van der Lindenc1326212020-06-23 22:39:20 +0000465#define FATTR4_WORD2_XATTR_SUPPORT (1UL << 18)
Andy Adamson88034c32012-05-23 05:02:34 -0400466
467/* MDS threshold bitmap bits */
468#define THRESHOLD_RD (1UL << 0)
469#define THRESHOLD_WR (1UL << 1)
470#define THRESHOLD_RD_IO (1UL << 2)
471#define THRESHOLD_WR_IO (1UL << 3)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472
473#define NFSPROC4_NULL 0
474#define NFSPROC4_COMPOUND 1
Chuck Lever764302c2009-09-08 19:50:03 -0400475#define NFS4_VERSION 4
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476#define NFS4_MINOR_VERSION 0
Mike Sager44549df2009-04-01 09:21:47 -0400477
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478#define NFS4_DEBUG 1
479
Trond Myklebust8634ef52018-01-06 09:53:49 -0500480/*
481 * Index of predefined Linux client operations
482 *
483 * To ensure that /proc/net/rpc/nfs remains correctly ordered, please
484 * append only to this enum when adding new client operations.
485 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486
487enum {
488 NFSPROC4_CLNT_NULL = 0, /* Unused */
489 NFSPROC4_CLNT_READ,
490 NFSPROC4_CLNT_WRITE,
491 NFSPROC4_CLNT_COMMIT,
492 NFSPROC4_CLNT_OPEN,
493 NFSPROC4_CLNT_OPEN_CONFIRM,
494 NFSPROC4_CLNT_OPEN_NOATTR,
495 NFSPROC4_CLNT_OPEN_DOWNGRADE,
496 NFSPROC4_CLNT_CLOSE,
497 NFSPROC4_CLNT_SETATTR,
498 NFSPROC4_CLNT_FSINFO,
499 NFSPROC4_CLNT_RENEW,
500 NFSPROC4_CLNT_SETCLIENTID,
501 NFSPROC4_CLNT_SETCLIENTID_CONFIRM,
502 NFSPROC4_CLNT_LOCK,
503 NFSPROC4_CLNT_LOCKT,
504 NFSPROC4_CLNT_LOCKU,
505 NFSPROC4_CLNT_ACCESS,
506 NFSPROC4_CLNT_GETATTR,
507 NFSPROC4_CLNT_LOOKUP,
508 NFSPROC4_CLNT_LOOKUP_ROOT,
509 NFSPROC4_CLNT_REMOVE,
510 NFSPROC4_CLNT_RENAME,
511 NFSPROC4_CLNT_LINK,
512 NFSPROC4_CLNT_SYMLINK,
513 NFSPROC4_CLNT_CREATE,
514 NFSPROC4_CLNT_PATHCONF,
515 NFSPROC4_CLNT_STATFS,
516 NFSPROC4_CLNT_READLINK,
517 NFSPROC4_CLNT_READDIR,
518 NFSPROC4_CLNT_SERVER_CAPS,
519 NFSPROC4_CLNT_DELEGRETURN,
J. Bruce Fields029d1052005-06-22 17:16:22 +0000520 NFSPROC4_CLNT_GETACL,
J. Bruce Fields23ec6962005-06-22 17:16:22 +0000521 NFSPROC4_CLNT_SETACL,
Trond Myklebust683b57b2006-06-09 09:34:22 -0400522 NFSPROC4_CLNT_FS_LOCATIONS,
Trond Myklebustd3c7b7c2010-07-01 12:49:01 -0400523 NFSPROC4_CLNT_RELEASE_LOCKOWNER,
Bryan Schumaker5a5ea0d2011-03-24 17:12:29 +0000524 NFSPROC4_CLNT_SECINFO,
Chuck Lever44c99932013-10-17 14:13:30 -0400525 NFSPROC4_CLNT_FSID_PRESENT,
Benny Halevy18df1882009-04-03 08:27:36 +0300526
Benny Halevy18df1882009-04-03 08:27:36 +0300527 NFSPROC4_CLNT_EXCHANGE_ID,
528 NFSPROC4_CLNT_CREATE_SESSION,
529 NFSPROC4_CLNT_DESTROY_SESSION,
530 NFSPROC4_CLNT_SEQUENCE,
531 NFSPROC4_CLNT_GET_LEASE_TIME,
Ricardo Labiaga180197532009-12-05 16:08:40 -0500532 NFSPROC4_CLNT_RECLAIM_COMPLETE,
Andy Adamsonb1f69b72010-10-20 00:18:03 -0400533 NFSPROC4_CLNT_LAYOUTGET,
534 NFSPROC4_CLNT_GETDEVICEINFO,
Andy Adamson863a3c62011-03-23 13:27:54 +0000535 NFSPROC4_CLNT_LAYOUTCOMMIT,
Benny Halevycbe82602011-05-22 19:52:37 +0300536 NFSPROC4_CLNT_LAYOUTRETURN,
Bryan Schumakerfca78d62011-06-02 14:59:07 -0400537 NFSPROC4_CLNT_SECINFO_NO_NAME,
Bryan Schumaker7d974792011-06-02 14:59:08 -0400538 NFSPROC4_CLNT_TEST_STATEID,
Bryan Schumaker9aeda352011-06-02 14:59:09 -0400539 NFSPROC4_CLNT_FREE_STATEID,
Andy Adamson7f11d8d2011-07-30 20:52:35 -0400540 NFSPROC4_CLNT_GETDEVICELIST,
Trond Myklebustad24ecf2012-05-25 17:11:42 -0400541 NFSPROC4_CLNT_BIND_CONN_TO_SESSION,
Trond Myklebust66245532012-05-25 17:18:09 -0400542 NFSPROC4_CLNT_DESTROY_CLIENTID,
Anna Schumaker1c6dcbe2014-09-26 13:58:48 -0400543
Anna Schumaker1c6dcbe2014-09-26 13:58:48 -0400544 NFSPROC4_CLNT_SEEK,
Anna Schumakerf4ac1672014-11-25 13:18:15 -0500545 NFSPROC4_CLNT_ALLOCATE,
Anna Schumaker624bd5b2014-11-25 13:18:16 -0500546 NFSPROC4_CLNT_DEALLOCATE,
Trond Myklebustbe3a5d22015-06-23 19:51:55 +0800547 NFSPROC4_CLNT_LAYOUTSTATS,
Peng Tao36022772015-09-26 02:24:34 +0800548 NFSPROC4_CLNT_CLONE,
Anna Schumaker2e724482013-05-21 16:53:03 -0400549 NFSPROC4_CLNT_COPY,
Olga Kornievskaiacb95dee2018-07-09 15:13:29 -0400550 NFSPROC4_CLNT_OFFLOAD_CANCEL,
Trond Myklebust8634ef52018-01-06 09:53:49 -0500551
552 NFSPROC4_CLNT_LOOKUPP,
Trond Myklebust3eb86092019-02-08 10:31:05 -0500553 NFSPROC4_CLNT_LAYOUTERROR,
Trond Myklebust634d8112019-11-05 14:59:02 -0500554 NFSPROC4_CLNT_COPY_NOTIFY,
Frank van der Linden9a67fcc2020-06-23 22:38:53 +0000555
556 NFSPROC4_CLNT_GETXATTR,
557 NFSPROC4_CLNT_SETXATTR,
558 NFSPROC4_CLNT_LISTXATTRS,
559 NFSPROC4_CLNT_REMOVEXATTR,
Anna Schumakerc5675522014-05-28 13:41:22 -0400560 NFSPROC4_CLNT_READ_PLUS,
Benny Halevy18df1882009-04-03 08:27:36 +0300561};
562
563/* nfs41 types */
564struct nfs4_sessionid {
565 unsigned char data[NFS4_MAX_SESSIONID_LEN];
566};
567
568/* Create Session Flags */
Mi Jinlonga62573d2011-03-23 17:57:07 +0800569#define SESSION4_PERSIST 0x001
570#define SESSION4_BACK_CHAN 0x002
571#define SESSION4_RDMA 0x004
572
573#define SESSION4_FLAG_MASK_A 0x007
Benny Halevy18df1882009-04-03 08:27:36 +0300574
575enum state_protect_how4 {
576 SP4_NONE = 0,
577 SP4_MACH_CRED = 1,
578 SP4_SSV = 2
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579};
580
Dean Hildebrandc772567d2010-10-20 00:17:55 -0400581enum pnfs_layouttype {
582 LAYOUT_NFSV4_1_FILES = 1,
583 LAYOUT_OSD2_OBJECTS = 2,
584 LAYOUT_BLOCK_VOLUME = 3,
Tom Haynesd67ae822014-12-11 17:02:04 -0500585 LAYOUT_FLEX_FILES = 4,
Christoph Hellwig40cf4462016-03-04 20:46:14 +0100586 LAYOUT_SCSI = 5,
Christoph Hellwig6cae0a42014-08-16 13:31:51 +0200587 LAYOUT_TYPE_MAX
Dean Hildebrandc772567d2010-10-20 00:17:55 -0400588};
589
590/* used for both layout return and recall */
591enum pnfs_layoutreturn_type {
592 RETURN_FILE = 1,
593 RETURN_FSID = 2,
594 RETURN_ALL = 3
595};
596
597enum pnfs_iomode {
598 IOMODE_READ = 1,
599 IOMODE_RW = 2,
600 IOMODE_ANY = 3,
601};
602
603enum pnfs_notify_deviceid_type4 {
604 NOTIFY_DEVICEID4_CHANGE = 1 << 1,
605 NOTIFY_DEVICEID4_DELETE = 1 << 2,
606};
607
Christoph Hellwig8bb28972015-08-17 18:41:01 +0200608enum pnfs_block_volume_type {
609 PNFS_BLOCK_VOLUME_SIMPLE = 0,
610 PNFS_BLOCK_VOLUME_SLICE = 1,
611 PNFS_BLOCK_VOLUME_CONCAT = 2,
612 PNFS_BLOCK_VOLUME_STRIPE = 3,
Christoph Hellwig40cf4462016-03-04 20:46:14 +0100613 PNFS_BLOCK_VOLUME_SCSI = 4,
Christoph Hellwig8bb28972015-08-17 18:41:01 +0200614};
615
616enum pnfs_block_extent_state {
617 PNFS_BLOCK_READWRITE_DATA = 0,
618 PNFS_BLOCK_READ_DATA = 1,
619 PNFS_BLOCK_INVALID_DATA = 2,
620 PNFS_BLOCK_NONE_DATA = 3,
621};
622
623/* on the wire size of a block layout extent */
624#define PNFS_BLOCK_EXTENT_SIZE \
625 (7 * sizeof(__be32) + NFS4_DEVICEID4_SIZE)
626
Christoph Hellwig40cf4462016-03-04 20:46:14 +0100627/* on the wire size of a scsi commit range */
628#define PNFS_SCSI_RANGE_SIZE \
629 (4 * sizeof(__be32))
630
631enum scsi_code_set {
632 PS_CODE_SET_BINARY = 1,
633 PS_CODE_SET_ASCII = 2,
634 PS_CODE_SET_UTF8 = 3
635};
636
637enum scsi_designator_type {
638 PS_DESIGNATOR_T10 = 1,
639 PS_DESIGNATOR_EUI64 = 2,
640 PS_DESIGNATOR_NAA = 3,
641 PS_DESIGNATOR_NAME = 8
642};
643
Dean Hildebrandc772567d2010-10-20 00:17:55 -0400644#define NFL4_UFLG_MASK 0x0000003F
645#define NFL4_UFLG_DENSE 0x00000001
646#define NFL4_UFLG_COMMIT_THRU_MDS 0x00000002
647#define NFL4_UFLG_STRIPE_UNIT_SIZE_MASK 0xFFFFFFC0
648
649/* Encoded in the loh_body field of type layouthint4 */
650enum filelayout_hint_care4 {
651 NFLH4_CARE_DENSE = NFL4_UFLG_DENSE,
652 NFLH4_CARE_COMMIT_THRU_MDS = NFL4_UFLG_COMMIT_THRU_MDS,
653 NFLH4_CARE_STRIPE_UNIT_SIZE = 0x00000040,
654 NFLH4_CARE_STRIPE_COUNT = 0x00000080
655};
656
657#define NFS4_DEVICEID4_SIZE 16
658
659struct nfs4_deviceid {
660 char data[NFS4_DEVICEID4_SIZE];
661};
662
Anna Schumaker24bab492014-09-26 13:58:27 -0400663enum data_content4 {
664 NFS4_CONTENT_DATA = 0,
665 NFS4_CONTENT_HOLE = 1,
666};
667
Jeff Layton9a4bf312015-12-10 10:41:58 -0500668enum pnfs_update_layout_reason {
669 PNFS_UPDATE_LAYOUT_UNKNOWN = 0,
670 PNFS_UPDATE_LAYOUT_NO_PNFS,
671 PNFS_UPDATE_LAYOUT_RD_ZEROLEN,
672 PNFS_UPDATE_LAYOUT_MDSTHRESH,
673 PNFS_UPDATE_LAYOUT_NOMEM,
674 PNFS_UPDATE_LAYOUT_BULK_RECALL,
675 PNFS_UPDATE_LAYOUT_IO_TEST_FAIL,
676 PNFS_UPDATE_LAYOUT_FOUND_CACHED,
677 PNFS_UPDATE_LAYOUT_RETURN,
Jeff Layton183d9e72016-05-17 12:28:47 -0400678 PNFS_UPDATE_LAYOUT_RETRY,
Jeff Layton9a4bf312015-12-10 10:41:58 -0500679 PNFS_UPDATE_LAYOUT_BLOCKED,
Jeff Layton183d9e72016-05-17 12:28:47 -0400680 PNFS_UPDATE_LAYOUT_INVALID_OPEN,
Jeff Layton9a4bf312015-12-10 10:41:58 -0500681 PNFS_UPDATE_LAYOUT_SEND_LAYOUTGET,
Trond Myklebustd5b9216f2019-07-18 09:32:17 -0400682 PNFS_UPDATE_LAYOUT_EXIT,
Jeff Layton9a4bf312015-12-10 10:41:58 -0500683};
684
Andrew Elble1adf0c52016-06-15 12:52:07 -0400685#define NFS4_OP_MAP_NUM_LONGS \
686 DIV_ROUND_UP(LAST_NFS4_OP, 8 * sizeof(unsigned long))
687#define NFS4_OP_MAP_NUM_WORDS \
688 (NFS4_OP_MAP_NUM_LONGS * sizeof(unsigned long) / sizeof(u32))
689struct nfs4_op_map {
690 union {
691 unsigned long longs[NFS4_OP_MAP_NUM_LONGS];
692 u32 words[NFS4_OP_MAP_NUM_WORDS];
693 } u;
694};
695
Olga Kornievskaiaf9bdad82018-10-29 13:23:40 -0400696struct nfs42_netaddr {
697 char netid[RPCBIND_MAXNETIDLEN];
698 char addr[RPCBIND_MAXUADDRLEN + 1];
699 u32 netid_len;
700 u32 addr_len;
701};
702
703enum netloc_type4 {
704 NL4_NAME = 1,
705 NL4_URL = 2,
706 NL4_NETADDR = 3,
707};
708
709struct nl4_server {
710 enum netloc_type4 nl4_type;
711 union {
712 struct { /* NL4_NAME, NL4_URL */
713 int nl4_str_sz;
714 char nl4_str[NFS4_OPAQUE_LIMIT + 1];
715 };
716 struct nfs42_netaddr nl4_addr; /* NL4_NETADDR */
717 } u;
718};
Frank van der Lindenc1326212020-06-23 22:39:20 +0000719
720/*
721 * Options for setxattr. These match the flags for setxattr(2).
722 */
723enum nfs4_setxattr_options {
724 SETXATTR4_EITHER = 0,
725 SETXATTR4_CREATE = 1,
726 SETXATTR4_REPLACE = 2,
727};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728#endif