blob: 8cdde4d1fad86a9a3446bdf73e59550f5f87d251 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * include/linux/nfs4.h
3 *
4 * NFSv4 protocol definitions.
5 *
6 * Copyright (c) 2002 The Regents of the University of Michigan.
7 * All rights reserved.
8 *
9 * Kendrick Smith <kmsmith@umich.edu>
10 * Andy Adamson <andros@umich.edu>
11 */
12
13#ifndef _LINUX_NFS4_H
14#define _LINUX_NFS4_H
15
16#include <linux/types.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070017
Jeff Laytonaa53ed52007-06-05 14:49:03 -040018#define NFS4_BITMAP_SIZE 2
Linus Torvalds1da177e2005-04-16 15:20:36 -070019#define NFS4_VERIFIER_SIZE 8
Alexandros Batsakis94499252010-10-20 00:17:56 -040020#define NFS4_STATEID_SEQID_SIZE 4
21#define NFS4_STATEID_OTHER_SIZE 12
22#define NFS4_STATEID_SIZE (NFS4_STATEID_SEQID_SIZE + NFS4_STATEID_OTHER_SIZE)
Linus Torvalds1da177e2005-04-16 15:20:36 -070023#define NFS4_FHSIZE 128
24#define NFS4_MAXPATHLEN PATH_MAX
25#define NFS4_MAXNAMLEN NAME_MAX
Benny Halevy99fe60d2009-04-01 09:22:29 -040026#define NFS4_OPAQUE_LIMIT 1024
Benny Halevy18df1882009-04-03 08:27:36 +030027#define NFS4_MAX_SESSIONID_LEN 16
Linus Torvalds1da177e2005-04-16 15:20:36 -070028
29#define NFS4_ACCESS_READ 0x0001
30#define NFS4_ACCESS_LOOKUP 0x0002
31#define NFS4_ACCESS_MODIFY 0x0004
32#define NFS4_ACCESS_EXTEND 0x0008
33#define NFS4_ACCESS_DELETE 0x0010
34#define NFS4_ACCESS_EXECUTE 0x0020
35
NeilBrown49640002005-06-23 22:02:58 -070036#define NFS4_FH_PERSISTENT 0x0000
Linus Torvalds1da177e2005-04-16 15:20:36 -070037#define NFS4_FH_NOEXPIRE_WITH_OPEN 0x0001
38#define NFS4_FH_VOLATILE_ANY 0x0002
39#define NFS4_FH_VOL_MIGRATION 0x0004
40#define NFS4_FH_VOL_RENAME 0x0008
41
42#define NFS4_OPEN_RESULT_CONFIRM 0x0002
43#define NFS4_OPEN_RESULT_LOCKTYPE_POSIX 0x0004
44
Benny Halevy18df1882009-04-03 08:27:36 +030045#define NFS4_SHARE_ACCESS_MASK 0x000F
Linus Torvalds1da177e2005-04-16 15:20:36 -070046#define NFS4_SHARE_ACCESS_READ 0x0001
47#define NFS4_SHARE_ACCESS_WRITE 0x0002
48#define NFS4_SHARE_ACCESS_BOTH 0x0003
49#define NFS4_SHARE_DENY_READ 0x0001
50#define NFS4_SHARE_DENY_WRITE 0x0002
51#define NFS4_SHARE_DENY_BOTH 0x0003
52
Benny Halevy18df1882009-04-03 08:27:36 +030053/* nfs41 */
54#define NFS4_SHARE_WANT_MASK 0xFF00
55#define NFS4_SHARE_WANT_NO_PREFERENCE 0x0000
56#define NFS4_SHARE_WANT_READ_DELEG 0x0100
57#define NFS4_SHARE_WANT_WRITE_DELEG 0x0200
58#define NFS4_SHARE_WANT_ANY_DELEG 0x0300
59#define NFS4_SHARE_WANT_NO_DELEG 0x0400
60#define NFS4_SHARE_WANT_CANCEL 0x0500
61
62#define NFS4_SHARE_WHEN_MASK 0xF0000
63#define NFS4_SHARE_SIGNAL_DELEG_WHEN_RESRC_AVAIL 0x10000
64#define NFS4_SHARE_PUSH_DELEG_WHEN_UNCONTENDED 0x20000
65
J. Bruce Fieldsc7662512010-06-06 18:12:14 -040066#define NFS4_CDFC4_FORE 0x1
67#define NFS4_CDFC4_BACK 0x2
J. Bruce Fields1d1bc8f2010-10-04 23:12:59 -040068#define NFS4_CDFC4_BOTH 0x3
69#define NFS4_CDFC4_FORE_OR_BOTH 0x3
70#define NFS4_CDFC4_BACK_OR_BOTH 0x7
J. Bruce Fieldsc7662512010-06-06 18:12:14 -040071
Linus Torvalds1da177e2005-04-16 15:20:36 -070072#define NFS4_SET_TO_SERVER_TIME 0
73#define NFS4_SET_TO_CLIENT_TIME 1
74
75#define NFS4_ACE_ACCESS_ALLOWED_ACE_TYPE 0
76#define NFS4_ACE_ACCESS_DENIED_ACE_TYPE 1
77#define NFS4_ACE_SYSTEM_AUDIT_ACE_TYPE 2
78#define NFS4_ACE_SYSTEM_ALARM_ACE_TYPE 3
79
80#define ACL4_SUPPORT_ALLOW_ACL 0x01
81#define ACL4_SUPPORT_DENY_ACL 0x02
82#define ACL4_SUPPORT_AUDIT_ACL 0x04
83#define ACL4_SUPPORT_ALARM_ACL 0x08
84
85#define NFS4_ACE_FILE_INHERIT_ACE 0x00000001
86#define NFS4_ACE_DIRECTORY_INHERIT_ACE 0x00000002
87#define NFS4_ACE_NO_PROPAGATE_INHERIT_ACE 0x00000004
88#define NFS4_ACE_INHERIT_ONLY_ACE 0x00000008
89#define NFS4_ACE_SUCCESSFUL_ACCESS_ACE_FLAG 0x00000010
90#define NFS4_ACE_FAILED_ACCESS_ACE_FLAG 0x00000020
91#define NFS4_ACE_IDENTIFIER_GROUP 0x00000040
Linus Torvalds1da177e2005-04-16 15:20:36 -070092
93#define NFS4_ACE_READ_DATA 0x00000001
94#define NFS4_ACE_LIST_DIRECTORY 0x00000001
95#define NFS4_ACE_WRITE_DATA 0x00000002
96#define NFS4_ACE_ADD_FILE 0x00000002
97#define NFS4_ACE_APPEND_DATA 0x00000004
98#define NFS4_ACE_ADD_SUBDIRECTORY 0x00000004
99#define NFS4_ACE_READ_NAMED_ATTRS 0x00000008
100#define NFS4_ACE_WRITE_NAMED_ATTRS 0x00000010
101#define NFS4_ACE_EXECUTE 0x00000020
102#define NFS4_ACE_DELETE_CHILD 0x00000040
103#define NFS4_ACE_READ_ATTRIBUTES 0x00000080
104#define NFS4_ACE_WRITE_ATTRIBUTES 0x00000100
105#define NFS4_ACE_DELETE 0x00010000
106#define NFS4_ACE_READ_ACL 0x00020000
107#define NFS4_ACE_WRITE_ACL 0x00040000
108#define NFS4_ACE_WRITE_OWNER 0x00080000
109#define NFS4_ACE_SYNCHRONIZE 0x00100000
110#define NFS4_ACE_GENERIC_READ 0x00120081
111#define NFS4_ACE_GENERIC_WRITE 0x00160106
112#define NFS4_ACE_GENERIC_EXECUTE 0x001200A0
113#define NFS4_ACE_MASK_ALL 0x001F01FF
114
Benny Halevy18df1882009-04-03 08:27:36 +0300115#define EXCHGID4_FLAG_SUPP_MOVED_REFER 0x00000001
116#define EXCHGID4_FLAG_SUPP_MOVED_MIGR 0x00000002
Andy Adamson357f54d2010-12-14 10:11:57 -0500117#define EXCHGID4_FLAG_BIND_PRINC_STATEID 0x00000100
118
Benny Halevy18df1882009-04-03 08:27:36 +0300119#define EXCHGID4_FLAG_USE_NON_PNFS 0x00010000
120#define EXCHGID4_FLAG_USE_PNFS_MDS 0x00020000
121#define EXCHGID4_FLAG_USE_PNFS_DS 0x00040000
Andy Adamson357f54d2010-12-14 10:11:57 -0500122#define EXCHGID4_FLAG_MASK_PNFS 0x00070000
123
Benny Halevy18df1882009-04-03 08:27:36 +0300124#define EXCHGID4_FLAG_UPD_CONFIRMED_REC_A 0x40000000
125#define EXCHGID4_FLAG_CONFIRMED_R 0x80000000
126/*
127 * Since the validity of these bits depends on whether
128 * they're set in the argument or response, have separate
129 * invalid flag masks for arg (_A) and resp (_R).
130 */
Andy Adamson357f54d2010-12-14 10:11:57 -0500131#define EXCHGID4_FLAG_MASK_A 0x40070103
132#define EXCHGID4_FLAG_MASK_R 0x80070103
Benny Halevy18df1882009-04-03 08:27:36 +0300133
134#define SEQ4_STATUS_CB_PATH_DOWN 0x00000001
135#define SEQ4_STATUS_CB_GSS_CONTEXTS_EXPIRING 0x00000002
136#define SEQ4_STATUS_CB_GSS_CONTEXTS_EXPIRED 0x00000004
137#define SEQ4_STATUS_EXPIRED_ALL_STATE_REVOKED 0x00000008
138#define SEQ4_STATUS_EXPIRED_SOME_STATE_REVOKED 0x00000010
139#define SEQ4_STATUS_ADMIN_STATE_REVOKED 0x00000020
140#define SEQ4_STATUS_RECALLABLE_STATE_REVOKED 0x00000040
141#define SEQ4_STATUS_LEASE_MOVED 0x00000080
142#define SEQ4_STATUS_RESTART_RECLAIM_NEEDED 0x00000100
Alexandros Batsakis0629e372009-12-05 13:46:14 -0500143#define SEQ4_STATUS_CB_PATH_DOWN_SESSION 0x00000200
144#define SEQ4_STATUS_BACKCHANNEL_FAULT 0x00000400
Benny Halevy18df1882009-04-03 08:27:36 +0300145
J. Bruce Fields04f4ad12010-12-16 09:51:13 -0500146#define NFS4_SECINFO_STYLE4_CURRENT_FH 0
147#define NFS4_SECINFO_STYLE4_PARENT 1
148
Benny Halevy87df4de2008-12-15 19:42:03 +0200149#define NFS4_MAX_UINT64 (~(u64)0)
150
Andy Adamsonfc931582009-04-01 09:22:31 -0400151/* An NFS4 sessions server must support at least NFS4_MAX_OPS operations.
152 * If a compound requires more operations, adjust NFS4_MAX_OPS accordingly.
153 */
154#define NFS4_MAX_OPS 8
155
156/* Our NFS4 client back channel server only wants the cb_sequene and the
157 * actual operation per compound
158 */
159#define NFS4_MAX_BACK_CHANNEL_OPS 2
160
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161enum nfs4_acl_whotype {
162 NFS4_ACL_WHO_NAMED = 0,
163 NFS4_ACL_WHO_OWNER,
164 NFS4_ACL_WHO_GROUP,
165 NFS4_ACL_WHO_EVERYONE,
166};
167
David Woodhouse997b7af2006-04-25 14:51:45 +0100168#ifdef __KERNEL__
169#include <linux/list.h>
170
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171struct nfs4_ace {
172 uint32_t type;
173 uint32_t flag;
174 uint32_t access_mask;
175 int whotype;
176 uid_t who;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177};
178
179struct nfs4_acl {
180 uint32_t naces;
J. Bruce Fields28e05dd2007-02-16 01:28:30 -0800181 struct nfs4_ace aces[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182};
183
184typedef struct { char data[NFS4_VERIFIER_SIZE]; } nfs4_verifier;
Alexandros Batsakis94499252010-10-20 00:17:56 -0400185
186struct nfs41_stateid {
187 __be32 seqid;
188 char other[NFS4_STATEID_OTHER_SIZE];
189} __attribute__ ((packed));
190
191typedef union {
192 char data[NFS4_STATEID_SIZE];
193 struct nfs41_stateid stateid;
194} nfs4_stateid;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195
196enum nfs_opnum4 {
197 OP_ACCESS = 3,
198 OP_CLOSE = 4,
199 OP_COMMIT = 5,
200 OP_CREATE = 6,
201 OP_DELEGPURGE = 7,
202 OP_DELEGRETURN = 8,
203 OP_GETATTR = 9,
204 OP_GETFH = 10,
205 OP_LINK = 11,
206 OP_LOCK = 12,
207 OP_LOCKT = 13,
208 OP_LOCKU = 14,
209 OP_LOOKUP = 15,
210 OP_LOOKUPP = 16,
211 OP_NVERIFY = 17,
212 OP_OPEN = 18,
213 OP_OPENATTR = 19,
214 OP_OPEN_CONFIRM = 20,
215 OP_OPEN_DOWNGRADE = 21,
216 OP_PUTFH = 22,
217 OP_PUTPUBFH = 23,
218 OP_PUTROOTFH = 24,
219 OP_READ = 25,
220 OP_READDIR = 26,
221 OP_READLINK = 27,
222 OP_REMOVE = 28,
223 OP_RENAME = 29,
224 OP_RENEW = 30,
225 OP_RESTOREFH = 31,
226 OP_SAVEFH = 32,
227 OP_SECINFO = 33,
228 OP_SETATTR = 34,
229 OP_SETCLIENTID = 35,
230 OP_SETCLIENTID_CONFIRM = 36,
231 OP_VERIFY = 37,
232 OP_WRITE = 38,
233 OP_RELEASE_LOCKOWNER = 39,
Benny Halevy18df1882009-04-03 08:27:36 +0300234
235 /* nfs41 */
236 OP_BACKCHANNEL_CTL = 40,
237 OP_BIND_CONN_TO_SESSION = 41,
238 OP_EXCHANGE_ID = 42,
239 OP_CREATE_SESSION = 43,
240 OP_DESTROY_SESSION = 44,
241 OP_FREE_STATEID = 45,
242 OP_GET_DIR_DELEGATION = 46,
243 OP_GETDEVICEINFO = 47,
244 OP_GETDEVICELIST = 48,
245 OP_LAYOUTCOMMIT = 49,
246 OP_LAYOUTGET = 50,
247 OP_LAYOUTRETURN = 51,
248 OP_SECINFO_NO_NAME = 52,
249 OP_SEQUENCE = 53,
250 OP_SET_SSV = 54,
251 OP_TEST_STATEID = 55,
252 OP_WANT_DELEGATION = 56,
253 OP_DESTROY_CLIENTID = 57,
254 OP_RECLAIM_COMPLETE = 58,
255
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256 OP_ILLEGAL = 10044,
257};
258
Shankar Anande2b20952006-07-10 04:45:44 -0700259/*Defining first and last NFS4 operations implemented.
260Needs to be updated if more operations are defined in future.*/
261
262#define FIRST_NFS4_OP OP_ACCESS
Benny Halevy5a421ce2009-07-10 12:37:40 +0300263#define LAST_NFS4_OP OP_RECLAIM_COMPLETE
Shankar Anande2b20952006-07-10 04:45:44 -0700264
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265enum nfsstat4 {
266 NFS4_OK = 0,
267 NFS4ERR_PERM = 1,
268 NFS4ERR_NOENT = 2,
269 NFS4ERR_IO = 5,
270 NFS4ERR_NXIO = 6,
271 NFS4ERR_ACCESS = 13,
272 NFS4ERR_EXIST = 17,
273 NFS4ERR_XDEV = 18,
274 /* Unused/reserved 19 */
275 NFS4ERR_NOTDIR = 20,
276 NFS4ERR_ISDIR = 21,
277 NFS4ERR_INVAL = 22,
278 NFS4ERR_FBIG = 27,
279 NFS4ERR_NOSPC = 28,
280 NFS4ERR_ROFS = 30,
281 NFS4ERR_MLINK = 31,
282 NFS4ERR_NAMETOOLONG = 63,
283 NFS4ERR_NOTEMPTY = 66,
284 NFS4ERR_DQUOT = 69,
285 NFS4ERR_STALE = 70,
286 NFS4ERR_BADHANDLE = 10001,
287 NFS4ERR_BAD_COOKIE = 10003,
288 NFS4ERR_NOTSUPP = 10004,
289 NFS4ERR_TOOSMALL = 10005,
290 NFS4ERR_SERVERFAULT = 10006,
291 NFS4ERR_BADTYPE = 10007,
292 NFS4ERR_DELAY = 10008,
293 NFS4ERR_SAME = 10009,
294 NFS4ERR_DENIED = 10010,
295 NFS4ERR_EXPIRED = 10011,
296 NFS4ERR_LOCKED = 10012,
297 NFS4ERR_GRACE = 10013,
298 NFS4ERR_FHEXPIRED = 10014,
299 NFS4ERR_SHARE_DENIED = 10015,
300 NFS4ERR_WRONGSEC = 10016,
301 NFS4ERR_CLID_INUSE = 10017,
302 NFS4ERR_RESOURCE = 10018,
303 NFS4ERR_MOVED = 10019,
304 NFS4ERR_NOFILEHANDLE = 10020,
305 NFS4ERR_MINOR_VERS_MISMATCH = 10021,
306 NFS4ERR_STALE_CLIENTID = 10022,
307 NFS4ERR_STALE_STATEID = 10023,
308 NFS4ERR_OLD_STATEID = 10024,
309 NFS4ERR_BAD_STATEID = 10025,
310 NFS4ERR_BAD_SEQID = 10026,
311 NFS4ERR_NOT_SAME = 10027,
312 NFS4ERR_LOCK_RANGE = 10028,
313 NFS4ERR_SYMLINK = 10029,
314 NFS4ERR_RESTOREFH = 10030,
315 NFS4ERR_LEASE_MOVED = 10031,
316 NFS4ERR_ATTRNOTSUPP = 10032,
317 NFS4ERR_NO_GRACE = 10033,
318 NFS4ERR_RECLAIM_BAD = 10034,
319 NFS4ERR_RECLAIM_CONFLICT = 10035,
320 NFS4ERR_BADXDR = 10036,
321 NFS4ERR_LOCKS_HELD = 10037,
322 NFS4ERR_OPENMODE = 10038,
323 NFS4ERR_BADOWNER = 10039,
324 NFS4ERR_BADCHAR = 10040,
325 NFS4ERR_BADNAME = 10041,
326 NFS4ERR_BAD_RANGE = 10042,
327 NFS4ERR_LOCK_NOTSUPP = 10043,
328 NFS4ERR_OP_ILLEGAL = 10044,
329 NFS4ERR_DEADLOCK = 10045,
330 NFS4ERR_FILE_OPEN = 10046,
331 NFS4ERR_ADMIN_REVOKED = 10047,
Benny Halevy18df1882009-04-03 08:27:36 +0300332 NFS4ERR_CB_PATH_DOWN = 10048,
333
334 /* nfs41 */
335 NFS4ERR_BADIOMODE = 10049,
336 NFS4ERR_BADLAYOUT = 10050,
337 NFS4ERR_BAD_SESSION_DIGEST = 10051,
338 NFS4ERR_BADSESSION = 10052,
339 NFS4ERR_BADSLOT = 10053,
340 NFS4ERR_COMPLETE_ALREADY = 10054,
341 NFS4ERR_CONN_NOT_BOUND_TO_SESSION = 10055,
342 NFS4ERR_DELEG_ALREADY_WANTED = 10056,
343 NFS4ERR_BACK_CHAN_BUSY = 10057, /* backchan reqs outstanding */
344 NFS4ERR_LAYOUTTRYLATER = 10058,
345 NFS4ERR_LAYOUTUNAVAILABLE = 10059,
346 NFS4ERR_NOMATCHING_LAYOUT = 10060,
347 NFS4ERR_RECALLCONFLICT = 10061,
348 NFS4ERR_UNKNOWN_LAYOUTTYPE = 10062,
349 NFS4ERR_SEQ_MISORDERED = 10063, /* unexpected seq.id in req */
350 NFS4ERR_SEQUENCE_POS = 10064, /* [CB_]SEQ. op not 1st op */
351 NFS4ERR_REQ_TOO_BIG = 10065, /* request too big */
352 NFS4ERR_REP_TOO_BIG = 10066, /* reply too big */
353 NFS4ERR_REP_TOO_BIG_TO_CACHE = 10067, /* rep. not all cached */
354 NFS4ERR_RETRY_UNCACHED_REP = 10068, /* retry & rep. uncached */
355 NFS4ERR_UNSAFE_COMPOUND = 10069, /* retry/recovery too hard */
356 NFS4ERR_TOO_MANY_OPS = 10070, /* too many ops in [CB_]COMP */
357 NFS4ERR_OP_NOT_IN_SESSION = 10071, /* op needs [CB_]SEQ. op */
358 NFS4ERR_HASH_ALG_UNSUPP = 10072, /* hash alg. not supp. */
359 /* Error 10073 is unused. */
360 NFS4ERR_CLIENTID_BUSY = 10074, /* clientid has state */
361 NFS4ERR_PNFS_IO_HOLE = 10075, /* IO to _SPARSE file hole */
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300362 NFS4ERR_SEQ_FALSE_RETRY = 10076, /* retry not original */
Benny Halevy18df1882009-04-03 08:27:36 +0300363 NFS4ERR_BAD_HIGH_SLOT = 10077, /* sequence arg bad */
364 NFS4ERR_DEADSESSION = 10078, /* persistent session dead */
365 NFS4ERR_ENCR_ALG_UNSUPP = 10079, /* SSV alg mismatch */
366 NFS4ERR_PNFS_NO_LAYOUT = 10080, /* direct I/O with no layout */
367 NFS4ERR_NOT_ONLY_OP = 10081, /* bad compound */
368 NFS4ERR_WRONG_CRED = 10082, /* permissions:state change */
369 NFS4ERR_WRONG_TYPE = 10083, /* current operation mismatch */
370 NFS4ERR_DIRDELEG_UNAVAIL = 10084, /* no directory delegation */
371 NFS4ERR_REJECT_DELEG = 10085, /* on callback */
372 NFS4ERR_RETURNCONFLICT = 10086, /* outstanding layoutreturn */
373 NFS4ERR_DELEG_REVOKED = 10087, /* deleg./layout revoked */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374};
375
J. Bruce Fieldsa9004ab2011-08-23 15:43:04 -0400376static inline bool seqid_mutating_err(u32 err)
377{
378 /* rfc 3530 section 8.1.5: */
379 switch (err) {
380 case NFS4ERR_STALE_CLIENTID:
381 case NFS4ERR_STALE_STATEID:
382 case NFS4ERR_BAD_STATEID:
383 case NFS4ERR_BAD_SEQID:
384 case NFS4ERR_BADXDR:
385 case NFS4ERR_RESOURCE:
386 case NFS4ERR_NOFILEHANDLE:
387 return false;
388 };
389 return true;
390}
391
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392/*
393 * Note: NF4BAD is not actually part of the protocol; it is just used
394 * internally by nfsd.
395 */
396enum nfs_ftype4 {
397 NF4BAD = 0,
398 NF4REG = 1, /* Regular File */
399 NF4DIR = 2, /* Directory */
400 NF4BLK = 3, /* Special File - block device */
401 NF4CHR = 4, /* Special File - character device */
402 NF4LNK = 5, /* Symbolic Link */
403 NF4SOCK = 6, /* Special File - socket */
404 NF4FIFO = 7, /* Special File - fifo */
405 NF4ATTRDIR = 8, /* Attribute Directory */
406 NF4NAMEDATTR = 9 /* Named Attribute */
407};
408
409enum open_claim_type4 {
410 NFS4_OPEN_CLAIM_NULL = 0,
411 NFS4_OPEN_CLAIM_PREVIOUS = 1,
412 NFS4_OPEN_CLAIM_DELEGATE_CUR = 2,
J. Bruce Fields8b289b22011-10-19 11:52:12 -0400413 NFS4_OPEN_CLAIM_DELEGATE_PREV = 3,
414 NFS4_OPEN_CLAIM_FH = 4, /* 4.1 */
415 NFS4_OPEN_CLAIM_DELEG_CUR_FH = 5, /* 4.1 */
416 NFS4_OPEN_CLAIM_DELEG_PREV_FH = 6, /* 4.1 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417};
418
419enum opentype4 {
420 NFS4_OPEN_NOCREATE = 0,
421 NFS4_OPEN_CREATE = 1
422};
423
424enum createmode4 {
425 NFS4_CREATE_UNCHECKED = 0,
426 NFS4_CREATE_GUARDED = 1,
Benny Halevy79fb54a2009-04-03 08:29:17 +0300427 NFS4_CREATE_EXCLUSIVE = 2,
428 /*
429 * New to NFSv4.1. If session is persistent,
430 * GUARDED4 MUST be used. Otherwise, use
431 * EXCLUSIVE4_1 instead of EXCLUSIVE4.
432 */
433 NFS4_CREATE_EXCLUSIVE4_1 = 3
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434};
435
436enum limit_by4 {
437 NFS4_LIMIT_SIZE = 1,
438 NFS4_LIMIT_BLOCKS = 2
439};
440
441enum open_delegation_type4 {
442 NFS4_OPEN_DELEGATE_NONE = 0,
443 NFS4_OPEN_DELEGATE_READ = 1,
Benny Halevyd24433c2012-02-16 20:57:17 +0200444 NFS4_OPEN_DELEGATE_WRITE = 2,
445 NFS4_OPEN_DELEGATE_NONE_EXT = 3, /* 4.1 */
446};
447
448enum why_no_delegation4 { /* new to v4.1 */
449 WND4_NOT_WANTED = 0,
450 WND4_CONTENTION = 1,
451 WND4_RESOURCE = 2,
452 WND4_NOT_SUPP_FTYPE = 3,
453 WND4_WRITE_DELEG_NOT_SUPP_FTYPE = 4,
454 WND4_NOT_SUPP_UPGRADE = 5,
455 WND4_NOT_SUPP_DOWNGRADE = 6,
456 WND4_CANCELLED = 7,
457 WND4_IS_DIR = 8,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458};
459
460enum lock_type4 {
461 NFS4_UNLOCK_LT = 0,
462 NFS4_READ_LT = 1,
463 NFS4_WRITE_LT = 2,
464 NFS4_READW_LT = 3,
465 NFS4_WRITEW_LT = 4
466};
467
468
469/* Mandatory Attributes */
470#define FATTR4_WORD0_SUPPORTED_ATTRS (1UL << 0)
471#define FATTR4_WORD0_TYPE (1UL << 1)
472#define FATTR4_WORD0_FH_EXPIRE_TYPE (1UL << 2)
473#define FATTR4_WORD0_CHANGE (1UL << 3)
474#define FATTR4_WORD0_SIZE (1UL << 4)
475#define FATTR4_WORD0_LINK_SUPPORT (1UL << 5)
476#define FATTR4_WORD0_SYMLINK_SUPPORT (1UL << 6)
477#define FATTR4_WORD0_NAMED_ATTR (1UL << 7)
478#define FATTR4_WORD0_FSID (1UL << 8)
479#define FATTR4_WORD0_UNIQUE_HANDLES (1UL << 9)
480#define FATTR4_WORD0_LEASE_TIME (1UL << 10)
481#define FATTR4_WORD0_RDATTR_ERROR (1UL << 11)
Benny Halevy8c18f202009-04-03 08:29:14 +0300482/* Mandatory in NFSv4.1 */
483#define FATTR4_WORD2_SUPPATTR_EXCLCREAT (1UL << 11)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484
485/* Recommended Attributes */
486#define FATTR4_WORD0_ACL (1UL << 12)
487#define FATTR4_WORD0_ACLSUPPORT (1UL << 13)
488#define FATTR4_WORD0_ARCHIVE (1UL << 14)
489#define FATTR4_WORD0_CANSETTIME (1UL << 15)
490#define FATTR4_WORD0_CASE_INSENSITIVE (1UL << 16)
491#define FATTR4_WORD0_CASE_PRESERVING (1UL << 17)
492#define FATTR4_WORD0_CHOWN_RESTRICTED (1UL << 18)
493#define FATTR4_WORD0_FILEHANDLE (1UL << 19)
494#define FATTR4_WORD0_FILEID (1UL << 20)
495#define FATTR4_WORD0_FILES_AVAIL (1UL << 21)
496#define FATTR4_WORD0_FILES_FREE (1UL << 22)
497#define FATTR4_WORD0_FILES_TOTAL (1UL << 23)
498#define FATTR4_WORD0_FS_LOCATIONS (1UL << 24)
499#define FATTR4_WORD0_HIDDEN (1UL << 25)
500#define FATTR4_WORD0_HOMOGENEOUS (1UL << 26)
501#define FATTR4_WORD0_MAXFILESIZE (1UL << 27)
502#define FATTR4_WORD0_MAXLINK (1UL << 28)
503#define FATTR4_WORD0_MAXNAME (1UL << 29)
504#define FATTR4_WORD0_MAXREAD (1UL << 30)
505#define FATTR4_WORD0_MAXWRITE (1UL << 31)
506#define FATTR4_WORD1_MIMETYPE (1UL << 0)
507#define FATTR4_WORD1_MODE (1UL << 1)
508#define FATTR4_WORD1_NO_TRUNC (1UL << 2)
509#define FATTR4_WORD1_NUMLINKS (1UL << 3)
510#define FATTR4_WORD1_OWNER (1UL << 4)
511#define FATTR4_WORD1_OWNER_GROUP (1UL << 5)
512#define FATTR4_WORD1_QUOTA_HARD (1UL << 6)
513#define FATTR4_WORD1_QUOTA_SOFT (1UL << 7)
514#define FATTR4_WORD1_QUOTA_USED (1UL << 8)
515#define FATTR4_WORD1_RAWDEV (1UL << 9)
516#define FATTR4_WORD1_SPACE_AVAIL (1UL << 10)
517#define FATTR4_WORD1_SPACE_FREE (1UL << 11)
518#define FATTR4_WORD1_SPACE_TOTAL (1UL << 12)
519#define FATTR4_WORD1_SPACE_USED (1UL << 13)
520#define FATTR4_WORD1_SYSTEM (1UL << 14)
521#define FATTR4_WORD1_TIME_ACCESS (1UL << 15)
522#define FATTR4_WORD1_TIME_ACCESS_SET (1UL << 16)
523#define FATTR4_WORD1_TIME_BACKUP (1UL << 17)
524#define FATTR4_WORD1_TIME_CREATE (1UL << 18)
525#define FATTR4_WORD1_TIME_DELTA (1UL << 19)
526#define FATTR4_WORD1_TIME_METADATA (1UL << 20)
527#define FATTR4_WORD1_TIME_MODIFY (1UL << 21)
528#define FATTR4_WORD1_TIME_MODIFY_SET (1UL << 22)
529#define FATTR4_WORD1_MOUNTED_ON_FILEID (1UL << 23)
Dean Hildebrandc772567d2010-10-20 00:17:55 -0400530#define FATTR4_WORD1_FS_LAYOUT_TYPES (1UL << 30)
531#define FATTR4_WORD2_LAYOUT_BLKSIZE (1UL << 1)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532
533#define NFSPROC4_NULL 0
534#define NFSPROC4_COMPOUND 1
Chuck Lever764302c2009-09-08 19:50:03 -0400535#define NFS4_VERSION 4
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536#define NFS4_MINOR_VERSION 0
Mike Sager44549df2009-04-01 09:21:47 -0400537
538#if defined(CONFIG_NFS_V4_1)
539#define NFS4_MAX_MINOR_VERSION 1
540#else
541#define NFS4_MAX_MINOR_VERSION 0
542#endif /* CONFIG_NFS_V4_1 */
543
Linus Torvalds1da177e2005-04-16 15:20:36 -0700544#define NFS4_DEBUG 1
545
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546/* Index of predefined Linux client operations */
547
548enum {
549 NFSPROC4_CLNT_NULL = 0, /* Unused */
550 NFSPROC4_CLNT_READ,
551 NFSPROC4_CLNT_WRITE,
552 NFSPROC4_CLNT_COMMIT,
553 NFSPROC4_CLNT_OPEN,
554 NFSPROC4_CLNT_OPEN_CONFIRM,
555 NFSPROC4_CLNT_OPEN_NOATTR,
556 NFSPROC4_CLNT_OPEN_DOWNGRADE,
557 NFSPROC4_CLNT_CLOSE,
558 NFSPROC4_CLNT_SETATTR,
559 NFSPROC4_CLNT_FSINFO,
560 NFSPROC4_CLNT_RENEW,
561 NFSPROC4_CLNT_SETCLIENTID,
562 NFSPROC4_CLNT_SETCLIENTID_CONFIRM,
563 NFSPROC4_CLNT_LOCK,
564 NFSPROC4_CLNT_LOCKT,
565 NFSPROC4_CLNT_LOCKU,
566 NFSPROC4_CLNT_ACCESS,
567 NFSPROC4_CLNT_GETATTR,
568 NFSPROC4_CLNT_LOOKUP,
569 NFSPROC4_CLNT_LOOKUP_ROOT,
570 NFSPROC4_CLNT_REMOVE,
571 NFSPROC4_CLNT_RENAME,
572 NFSPROC4_CLNT_LINK,
573 NFSPROC4_CLNT_SYMLINK,
574 NFSPROC4_CLNT_CREATE,
575 NFSPROC4_CLNT_PATHCONF,
576 NFSPROC4_CLNT_STATFS,
577 NFSPROC4_CLNT_READLINK,
578 NFSPROC4_CLNT_READDIR,
579 NFSPROC4_CLNT_SERVER_CAPS,
580 NFSPROC4_CLNT_DELEGRETURN,
J. Bruce Fields029d1052005-06-22 17:16:22 +0000581 NFSPROC4_CLNT_GETACL,
J. Bruce Fields23ec6962005-06-22 17:16:22 +0000582 NFSPROC4_CLNT_SETACL,
Trond Myklebust683b57b2006-06-09 09:34:22 -0400583 NFSPROC4_CLNT_FS_LOCATIONS,
Trond Myklebustd3c7b7c2010-07-01 12:49:01 -0400584 NFSPROC4_CLNT_RELEASE_LOCKOWNER,
Bryan Schumaker5a5ea0d2011-03-24 17:12:29 +0000585 NFSPROC4_CLNT_SECINFO,
Benny Halevy18df1882009-04-03 08:27:36 +0300586
587 /* nfs41 */
588 NFSPROC4_CLNT_EXCHANGE_ID,
589 NFSPROC4_CLNT_CREATE_SESSION,
590 NFSPROC4_CLNT_DESTROY_SESSION,
591 NFSPROC4_CLNT_SEQUENCE,
592 NFSPROC4_CLNT_GET_LEASE_TIME,
Ricardo Labiaga180197532009-12-05 16:08:40 -0500593 NFSPROC4_CLNT_RECLAIM_COMPLETE,
Andy Adamsonb1f69b72010-10-20 00:18:03 -0400594 NFSPROC4_CLNT_LAYOUTGET,
595 NFSPROC4_CLNT_GETDEVICEINFO,
Andy Adamson863a3c62011-03-23 13:27:54 +0000596 NFSPROC4_CLNT_LAYOUTCOMMIT,
Benny Halevycbe82602011-05-22 19:52:37 +0300597 NFSPROC4_CLNT_LAYOUTRETURN,
Bryan Schumakerfca78d62011-06-02 14:59:07 -0400598 NFSPROC4_CLNT_SECINFO_NO_NAME,
Bryan Schumaker7d974792011-06-02 14:59:08 -0400599 NFSPROC4_CLNT_TEST_STATEID,
Bryan Schumaker9aeda352011-06-02 14:59:09 -0400600 NFSPROC4_CLNT_FREE_STATEID,
Andy Adamson7f11d8d2011-07-30 20:52:35 -0400601 NFSPROC4_CLNT_GETDEVICELIST,
Benny Halevy18df1882009-04-03 08:27:36 +0300602};
603
604/* nfs41 types */
605struct nfs4_sessionid {
606 unsigned char data[NFS4_MAX_SESSIONID_LEN];
607};
608
609/* Create Session Flags */
Mi Jinlonga62573d2011-03-23 17:57:07 +0800610#define SESSION4_PERSIST 0x001
611#define SESSION4_BACK_CHAN 0x002
612#define SESSION4_RDMA 0x004
613
614#define SESSION4_FLAG_MASK_A 0x007
Benny Halevy18df1882009-04-03 08:27:36 +0300615
616enum state_protect_how4 {
617 SP4_NONE = 0,
618 SP4_MACH_CRED = 1,
619 SP4_SSV = 2
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620};
621
Dean Hildebrandc772567d2010-10-20 00:17:55 -0400622enum pnfs_layouttype {
623 LAYOUT_NFSV4_1_FILES = 1,
624 LAYOUT_OSD2_OBJECTS = 2,
625 LAYOUT_BLOCK_VOLUME = 3,
626};
627
628/* used for both layout return and recall */
629enum pnfs_layoutreturn_type {
630 RETURN_FILE = 1,
631 RETURN_FSID = 2,
632 RETURN_ALL = 3
633};
634
635enum pnfs_iomode {
636 IOMODE_READ = 1,
637 IOMODE_RW = 2,
638 IOMODE_ANY = 3,
639};
640
641enum pnfs_notify_deviceid_type4 {
642 NOTIFY_DEVICEID4_CHANGE = 1 << 1,
643 NOTIFY_DEVICEID4_DELETE = 1 << 2,
644};
645
646#define NFL4_UFLG_MASK 0x0000003F
647#define NFL4_UFLG_DENSE 0x00000001
648#define NFL4_UFLG_COMMIT_THRU_MDS 0x00000002
649#define NFL4_UFLG_STRIPE_UNIT_SIZE_MASK 0xFFFFFFC0
650
651/* Encoded in the loh_body field of type layouthint4 */
652enum filelayout_hint_care4 {
653 NFLH4_CARE_DENSE = NFL4_UFLG_DENSE,
654 NFLH4_CARE_COMMIT_THRU_MDS = NFL4_UFLG_COMMIT_THRU_MDS,
655 NFLH4_CARE_STRIPE_UNIT_SIZE = 0x00000040,
656 NFLH4_CARE_STRIPE_COUNT = 0x00000080
657};
658
659#define NFS4_DEVICEID4_SIZE 16
660
661struct nfs4_deviceid {
662 char data[NFS4_DEVICEID4_SIZE];
663};
664
Linus Torvalds1da177e2005-04-16 15:20:36 -0700665#endif
666#endif
667
668/*
669 * Local variables:
670 * c-basic-offset: 8
671 * End:
672 */