blob: ea03667694847101fb9ad689b404551a8b066973 [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
Trond Myklebust8ae20ab2007-05-14 16:50:45 -040020#define NFS4_STATEID_SIZE 16
Linus Torvalds1da177e2005-04-16 15:20:36 -070021#define NFS4_FHSIZE 128
22#define NFS4_MAXPATHLEN PATH_MAX
23#define NFS4_MAXNAMLEN NAME_MAX
24
25#define NFS4_ACCESS_READ 0x0001
26#define NFS4_ACCESS_LOOKUP 0x0002
27#define NFS4_ACCESS_MODIFY 0x0004
28#define NFS4_ACCESS_EXTEND 0x0008
29#define NFS4_ACCESS_DELETE 0x0010
30#define NFS4_ACCESS_EXECUTE 0x0020
31
NeilBrown49640002005-06-23 22:02:58 -070032#define NFS4_FH_PERSISTENT 0x0000
Linus Torvalds1da177e2005-04-16 15:20:36 -070033#define NFS4_FH_NOEXPIRE_WITH_OPEN 0x0001
34#define NFS4_FH_VOLATILE_ANY 0x0002
35#define NFS4_FH_VOL_MIGRATION 0x0004
36#define NFS4_FH_VOL_RENAME 0x0008
37
38#define NFS4_OPEN_RESULT_CONFIRM 0x0002
39#define NFS4_OPEN_RESULT_LOCKTYPE_POSIX 0x0004
40
41#define NFS4_SHARE_ACCESS_READ 0x0001
42#define NFS4_SHARE_ACCESS_WRITE 0x0002
43#define NFS4_SHARE_ACCESS_BOTH 0x0003
44#define NFS4_SHARE_DENY_READ 0x0001
45#define NFS4_SHARE_DENY_WRITE 0x0002
46#define NFS4_SHARE_DENY_BOTH 0x0003
47
48#define NFS4_SET_TO_SERVER_TIME 0
49#define NFS4_SET_TO_CLIENT_TIME 1
50
51#define NFS4_ACE_ACCESS_ALLOWED_ACE_TYPE 0
52#define NFS4_ACE_ACCESS_DENIED_ACE_TYPE 1
53#define NFS4_ACE_SYSTEM_AUDIT_ACE_TYPE 2
54#define NFS4_ACE_SYSTEM_ALARM_ACE_TYPE 3
55
56#define ACL4_SUPPORT_ALLOW_ACL 0x01
57#define ACL4_SUPPORT_DENY_ACL 0x02
58#define ACL4_SUPPORT_AUDIT_ACL 0x04
59#define ACL4_SUPPORT_ALARM_ACL 0x08
60
61#define NFS4_ACE_FILE_INHERIT_ACE 0x00000001
62#define NFS4_ACE_DIRECTORY_INHERIT_ACE 0x00000002
63#define NFS4_ACE_NO_PROPAGATE_INHERIT_ACE 0x00000004
64#define NFS4_ACE_INHERIT_ONLY_ACE 0x00000008
65#define NFS4_ACE_SUCCESSFUL_ACCESS_ACE_FLAG 0x00000010
66#define NFS4_ACE_FAILED_ACCESS_ACE_FLAG 0x00000020
67#define NFS4_ACE_IDENTIFIER_GROUP 0x00000040
Linus Torvalds1da177e2005-04-16 15:20:36 -070068
69#define NFS4_ACE_READ_DATA 0x00000001
70#define NFS4_ACE_LIST_DIRECTORY 0x00000001
71#define NFS4_ACE_WRITE_DATA 0x00000002
72#define NFS4_ACE_ADD_FILE 0x00000002
73#define NFS4_ACE_APPEND_DATA 0x00000004
74#define NFS4_ACE_ADD_SUBDIRECTORY 0x00000004
75#define NFS4_ACE_READ_NAMED_ATTRS 0x00000008
76#define NFS4_ACE_WRITE_NAMED_ATTRS 0x00000010
77#define NFS4_ACE_EXECUTE 0x00000020
78#define NFS4_ACE_DELETE_CHILD 0x00000040
79#define NFS4_ACE_READ_ATTRIBUTES 0x00000080
80#define NFS4_ACE_WRITE_ATTRIBUTES 0x00000100
81#define NFS4_ACE_DELETE 0x00010000
82#define NFS4_ACE_READ_ACL 0x00020000
83#define NFS4_ACE_WRITE_ACL 0x00040000
84#define NFS4_ACE_WRITE_OWNER 0x00080000
85#define NFS4_ACE_SYNCHRONIZE 0x00100000
86#define NFS4_ACE_GENERIC_READ 0x00120081
87#define NFS4_ACE_GENERIC_WRITE 0x00160106
88#define NFS4_ACE_GENERIC_EXECUTE 0x001200A0
89#define NFS4_ACE_MASK_ALL 0x001F01FF
90
91enum nfs4_acl_whotype {
92 NFS4_ACL_WHO_NAMED = 0,
93 NFS4_ACL_WHO_OWNER,
94 NFS4_ACL_WHO_GROUP,
95 NFS4_ACL_WHO_EVERYONE,
96};
97
David Woodhouse997b7af2006-04-25 14:51:45 +010098#ifdef __KERNEL__
99#include <linux/list.h>
100
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101struct nfs4_ace {
102 uint32_t type;
103 uint32_t flag;
104 uint32_t access_mask;
105 int whotype;
106 uid_t who;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107};
108
109struct nfs4_acl {
110 uint32_t naces;
J. Bruce Fields28e05dd2007-02-16 01:28:30 -0800111 struct nfs4_ace aces[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112};
113
114typedef struct { char data[NFS4_VERIFIER_SIZE]; } nfs4_verifier;
Trond Myklebust8ae20ab2007-05-14 16:50:45 -0400115typedef struct { char data[NFS4_STATEID_SIZE]; } nfs4_stateid;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116
117enum nfs_opnum4 {
118 OP_ACCESS = 3,
119 OP_CLOSE = 4,
120 OP_COMMIT = 5,
121 OP_CREATE = 6,
122 OP_DELEGPURGE = 7,
123 OP_DELEGRETURN = 8,
124 OP_GETATTR = 9,
125 OP_GETFH = 10,
126 OP_LINK = 11,
127 OP_LOCK = 12,
128 OP_LOCKT = 13,
129 OP_LOCKU = 14,
130 OP_LOOKUP = 15,
131 OP_LOOKUPP = 16,
132 OP_NVERIFY = 17,
133 OP_OPEN = 18,
134 OP_OPENATTR = 19,
135 OP_OPEN_CONFIRM = 20,
136 OP_OPEN_DOWNGRADE = 21,
137 OP_PUTFH = 22,
138 OP_PUTPUBFH = 23,
139 OP_PUTROOTFH = 24,
140 OP_READ = 25,
141 OP_READDIR = 26,
142 OP_READLINK = 27,
143 OP_REMOVE = 28,
144 OP_RENAME = 29,
145 OP_RENEW = 30,
146 OP_RESTOREFH = 31,
147 OP_SAVEFH = 32,
148 OP_SECINFO = 33,
149 OP_SETATTR = 34,
150 OP_SETCLIENTID = 35,
151 OP_SETCLIENTID_CONFIRM = 36,
152 OP_VERIFY = 37,
153 OP_WRITE = 38,
154 OP_RELEASE_LOCKOWNER = 39,
155 OP_ILLEGAL = 10044,
156};
157
Shankar Anande2b20952006-07-10 04:45:44 -0700158/*Defining first and last NFS4 operations implemented.
159Needs to be updated if more operations are defined in future.*/
160
161#define FIRST_NFS4_OP OP_ACCESS
162#define LAST_NFS4_OP OP_RELEASE_LOCKOWNER
163
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164enum nfsstat4 {
165 NFS4_OK = 0,
166 NFS4ERR_PERM = 1,
167 NFS4ERR_NOENT = 2,
168 NFS4ERR_IO = 5,
169 NFS4ERR_NXIO = 6,
170 NFS4ERR_ACCESS = 13,
171 NFS4ERR_EXIST = 17,
172 NFS4ERR_XDEV = 18,
173 /* Unused/reserved 19 */
174 NFS4ERR_NOTDIR = 20,
175 NFS4ERR_ISDIR = 21,
176 NFS4ERR_INVAL = 22,
177 NFS4ERR_FBIG = 27,
178 NFS4ERR_NOSPC = 28,
179 NFS4ERR_ROFS = 30,
180 NFS4ERR_MLINK = 31,
181 NFS4ERR_NAMETOOLONG = 63,
182 NFS4ERR_NOTEMPTY = 66,
183 NFS4ERR_DQUOT = 69,
184 NFS4ERR_STALE = 70,
185 NFS4ERR_BADHANDLE = 10001,
186 NFS4ERR_BAD_COOKIE = 10003,
187 NFS4ERR_NOTSUPP = 10004,
188 NFS4ERR_TOOSMALL = 10005,
189 NFS4ERR_SERVERFAULT = 10006,
190 NFS4ERR_BADTYPE = 10007,
191 NFS4ERR_DELAY = 10008,
192 NFS4ERR_SAME = 10009,
193 NFS4ERR_DENIED = 10010,
194 NFS4ERR_EXPIRED = 10011,
195 NFS4ERR_LOCKED = 10012,
196 NFS4ERR_GRACE = 10013,
197 NFS4ERR_FHEXPIRED = 10014,
198 NFS4ERR_SHARE_DENIED = 10015,
199 NFS4ERR_WRONGSEC = 10016,
200 NFS4ERR_CLID_INUSE = 10017,
201 NFS4ERR_RESOURCE = 10018,
202 NFS4ERR_MOVED = 10019,
203 NFS4ERR_NOFILEHANDLE = 10020,
204 NFS4ERR_MINOR_VERS_MISMATCH = 10021,
205 NFS4ERR_STALE_CLIENTID = 10022,
206 NFS4ERR_STALE_STATEID = 10023,
207 NFS4ERR_OLD_STATEID = 10024,
208 NFS4ERR_BAD_STATEID = 10025,
209 NFS4ERR_BAD_SEQID = 10026,
210 NFS4ERR_NOT_SAME = 10027,
211 NFS4ERR_LOCK_RANGE = 10028,
212 NFS4ERR_SYMLINK = 10029,
213 NFS4ERR_RESTOREFH = 10030,
214 NFS4ERR_LEASE_MOVED = 10031,
215 NFS4ERR_ATTRNOTSUPP = 10032,
216 NFS4ERR_NO_GRACE = 10033,
217 NFS4ERR_RECLAIM_BAD = 10034,
218 NFS4ERR_RECLAIM_CONFLICT = 10035,
219 NFS4ERR_BADXDR = 10036,
220 NFS4ERR_LOCKS_HELD = 10037,
221 NFS4ERR_OPENMODE = 10038,
222 NFS4ERR_BADOWNER = 10039,
223 NFS4ERR_BADCHAR = 10040,
224 NFS4ERR_BADNAME = 10041,
225 NFS4ERR_BAD_RANGE = 10042,
226 NFS4ERR_LOCK_NOTSUPP = 10043,
227 NFS4ERR_OP_ILLEGAL = 10044,
228 NFS4ERR_DEADLOCK = 10045,
229 NFS4ERR_FILE_OPEN = 10046,
230 NFS4ERR_ADMIN_REVOKED = 10047,
231 NFS4ERR_CB_PATH_DOWN = 10048
232};
233
234/*
235 * Note: NF4BAD is not actually part of the protocol; it is just used
236 * internally by nfsd.
237 */
238enum nfs_ftype4 {
239 NF4BAD = 0,
240 NF4REG = 1, /* Regular File */
241 NF4DIR = 2, /* Directory */
242 NF4BLK = 3, /* Special File - block device */
243 NF4CHR = 4, /* Special File - character device */
244 NF4LNK = 5, /* Symbolic Link */
245 NF4SOCK = 6, /* Special File - socket */
246 NF4FIFO = 7, /* Special File - fifo */
247 NF4ATTRDIR = 8, /* Attribute Directory */
248 NF4NAMEDATTR = 9 /* Named Attribute */
249};
250
251enum open_claim_type4 {
252 NFS4_OPEN_CLAIM_NULL = 0,
253 NFS4_OPEN_CLAIM_PREVIOUS = 1,
254 NFS4_OPEN_CLAIM_DELEGATE_CUR = 2,
255 NFS4_OPEN_CLAIM_DELEGATE_PREV = 3
256};
257
258enum opentype4 {
259 NFS4_OPEN_NOCREATE = 0,
260 NFS4_OPEN_CREATE = 1
261};
262
263enum createmode4 {
264 NFS4_CREATE_UNCHECKED = 0,
265 NFS4_CREATE_GUARDED = 1,
266 NFS4_CREATE_EXCLUSIVE = 2
267};
268
269enum limit_by4 {
270 NFS4_LIMIT_SIZE = 1,
271 NFS4_LIMIT_BLOCKS = 2
272};
273
274enum open_delegation_type4 {
275 NFS4_OPEN_DELEGATE_NONE = 0,
276 NFS4_OPEN_DELEGATE_READ = 1,
277 NFS4_OPEN_DELEGATE_WRITE = 2
278};
279
280enum lock_type4 {
281 NFS4_UNLOCK_LT = 0,
282 NFS4_READ_LT = 1,
283 NFS4_WRITE_LT = 2,
284 NFS4_READW_LT = 3,
285 NFS4_WRITEW_LT = 4
286};
287
288
289/* Mandatory Attributes */
290#define FATTR4_WORD0_SUPPORTED_ATTRS (1UL << 0)
291#define FATTR4_WORD0_TYPE (1UL << 1)
292#define FATTR4_WORD0_FH_EXPIRE_TYPE (1UL << 2)
293#define FATTR4_WORD0_CHANGE (1UL << 3)
294#define FATTR4_WORD0_SIZE (1UL << 4)
295#define FATTR4_WORD0_LINK_SUPPORT (1UL << 5)
296#define FATTR4_WORD0_SYMLINK_SUPPORT (1UL << 6)
297#define FATTR4_WORD0_NAMED_ATTR (1UL << 7)
298#define FATTR4_WORD0_FSID (1UL << 8)
299#define FATTR4_WORD0_UNIQUE_HANDLES (1UL << 9)
300#define FATTR4_WORD0_LEASE_TIME (1UL << 10)
301#define FATTR4_WORD0_RDATTR_ERROR (1UL << 11)
302
303/* Recommended Attributes */
304#define FATTR4_WORD0_ACL (1UL << 12)
305#define FATTR4_WORD0_ACLSUPPORT (1UL << 13)
306#define FATTR4_WORD0_ARCHIVE (1UL << 14)
307#define FATTR4_WORD0_CANSETTIME (1UL << 15)
308#define FATTR4_WORD0_CASE_INSENSITIVE (1UL << 16)
309#define FATTR4_WORD0_CASE_PRESERVING (1UL << 17)
310#define FATTR4_WORD0_CHOWN_RESTRICTED (1UL << 18)
311#define FATTR4_WORD0_FILEHANDLE (1UL << 19)
312#define FATTR4_WORD0_FILEID (1UL << 20)
313#define FATTR4_WORD0_FILES_AVAIL (1UL << 21)
314#define FATTR4_WORD0_FILES_FREE (1UL << 22)
315#define FATTR4_WORD0_FILES_TOTAL (1UL << 23)
316#define FATTR4_WORD0_FS_LOCATIONS (1UL << 24)
317#define FATTR4_WORD0_HIDDEN (1UL << 25)
318#define FATTR4_WORD0_HOMOGENEOUS (1UL << 26)
319#define FATTR4_WORD0_MAXFILESIZE (1UL << 27)
320#define FATTR4_WORD0_MAXLINK (1UL << 28)
321#define FATTR4_WORD0_MAXNAME (1UL << 29)
322#define FATTR4_WORD0_MAXREAD (1UL << 30)
323#define FATTR4_WORD0_MAXWRITE (1UL << 31)
324#define FATTR4_WORD1_MIMETYPE (1UL << 0)
325#define FATTR4_WORD1_MODE (1UL << 1)
326#define FATTR4_WORD1_NO_TRUNC (1UL << 2)
327#define FATTR4_WORD1_NUMLINKS (1UL << 3)
328#define FATTR4_WORD1_OWNER (1UL << 4)
329#define FATTR4_WORD1_OWNER_GROUP (1UL << 5)
330#define FATTR4_WORD1_QUOTA_HARD (1UL << 6)
331#define FATTR4_WORD1_QUOTA_SOFT (1UL << 7)
332#define FATTR4_WORD1_QUOTA_USED (1UL << 8)
333#define FATTR4_WORD1_RAWDEV (1UL << 9)
334#define FATTR4_WORD1_SPACE_AVAIL (1UL << 10)
335#define FATTR4_WORD1_SPACE_FREE (1UL << 11)
336#define FATTR4_WORD1_SPACE_TOTAL (1UL << 12)
337#define FATTR4_WORD1_SPACE_USED (1UL << 13)
338#define FATTR4_WORD1_SYSTEM (1UL << 14)
339#define FATTR4_WORD1_TIME_ACCESS (1UL << 15)
340#define FATTR4_WORD1_TIME_ACCESS_SET (1UL << 16)
341#define FATTR4_WORD1_TIME_BACKUP (1UL << 17)
342#define FATTR4_WORD1_TIME_CREATE (1UL << 18)
343#define FATTR4_WORD1_TIME_DELTA (1UL << 19)
344#define FATTR4_WORD1_TIME_METADATA (1UL << 20)
345#define FATTR4_WORD1_TIME_MODIFY (1UL << 21)
346#define FATTR4_WORD1_TIME_MODIFY_SET (1UL << 22)
347#define FATTR4_WORD1_MOUNTED_ON_FILEID (1UL << 23)
348
349#define NFSPROC4_NULL 0
350#define NFSPROC4_COMPOUND 1
351#define NFS4_MINOR_VERSION 0
352#define NFS4_DEBUG 1
353
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354/* Index of predefined Linux client operations */
355
356enum {
357 NFSPROC4_CLNT_NULL = 0, /* Unused */
358 NFSPROC4_CLNT_READ,
359 NFSPROC4_CLNT_WRITE,
360 NFSPROC4_CLNT_COMMIT,
361 NFSPROC4_CLNT_OPEN,
362 NFSPROC4_CLNT_OPEN_CONFIRM,
363 NFSPROC4_CLNT_OPEN_NOATTR,
364 NFSPROC4_CLNT_OPEN_DOWNGRADE,
365 NFSPROC4_CLNT_CLOSE,
366 NFSPROC4_CLNT_SETATTR,
367 NFSPROC4_CLNT_FSINFO,
368 NFSPROC4_CLNT_RENEW,
369 NFSPROC4_CLNT_SETCLIENTID,
370 NFSPROC4_CLNT_SETCLIENTID_CONFIRM,
371 NFSPROC4_CLNT_LOCK,
372 NFSPROC4_CLNT_LOCKT,
373 NFSPROC4_CLNT_LOCKU,
374 NFSPROC4_CLNT_ACCESS,
375 NFSPROC4_CLNT_GETATTR,
376 NFSPROC4_CLNT_LOOKUP,
377 NFSPROC4_CLNT_LOOKUP_ROOT,
378 NFSPROC4_CLNT_REMOVE,
379 NFSPROC4_CLNT_RENAME,
380 NFSPROC4_CLNT_LINK,
381 NFSPROC4_CLNT_SYMLINK,
382 NFSPROC4_CLNT_CREATE,
383 NFSPROC4_CLNT_PATHCONF,
384 NFSPROC4_CLNT_STATFS,
385 NFSPROC4_CLNT_READLINK,
386 NFSPROC4_CLNT_READDIR,
387 NFSPROC4_CLNT_SERVER_CAPS,
388 NFSPROC4_CLNT_DELEGRETURN,
J. Bruce Fields029d1052005-06-22 17:16:22 +0000389 NFSPROC4_CLNT_GETACL,
J. Bruce Fields23ec6962005-06-22 17:16:22 +0000390 NFSPROC4_CLNT_SETACL,
Trond Myklebust683b57b2006-06-09 09:34:22 -0400391 NFSPROC4_CLNT_FS_LOCATIONS,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392};
393
394#endif
395#endif
396
397/*
398 * Local variables:
399 * c-basic-offset: 8
400 * End:
401 */