1/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
2/*
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 <kmsmith@umich.edu>
11 *  Andy Adamson   <andros@umich.edu>
12 */
13
14#ifndef _UAPI_LINUX_NFS4_H
15#define _UAPI_LINUX_NFS4_H
16
17#include <linux/types.h>
18
19#define NFS4_BITMAP_SIZE	3
20#define NFS4_VERIFIER_SIZE	8
21#define NFS4_STATEID_SEQID_SIZE 4
22#define NFS4_STATEID_OTHER_SIZE 12
23#define NFS4_STATEID_SIZE	(NFS4_STATEID_SEQID_SIZE + NFS4_STATEID_OTHER_SIZE)
24#define NFS4_FHSIZE		128
25#define NFS4_MAXPATHLEN		PATH_MAX
26#define NFS4_MAXNAMLEN		NAME_MAX
27#define NFS4_OPAQUE_LIMIT	1024
28#define NFS4_MAX_SESSIONID_LEN	16
29
30#define NFS4_ACCESS_READ        0x0001
31#define NFS4_ACCESS_LOOKUP      0x0002
32#define NFS4_ACCESS_MODIFY      0x0004
33#define NFS4_ACCESS_EXTEND      0x0008
34#define NFS4_ACCESS_DELETE      0x0010
35#define NFS4_ACCESS_EXECUTE     0x0020
36#define NFS4_ACCESS_XAREAD      0x0040
37#define NFS4_ACCESS_XAWRITE     0x0080
38#define NFS4_ACCESS_XALIST      0x0100
39
40#define NFS4_FH_PERSISTENT		0x0000
41#define NFS4_FH_NOEXPIRE_WITH_OPEN	0x0001
42#define NFS4_FH_VOLATILE_ANY		0x0002
43#define NFS4_FH_VOL_MIGRATION		0x0004
44#define NFS4_FH_VOL_RENAME		0x0008
45
46#define NFS4_OPEN_RESULT_CONFIRM		0x0002
47#define NFS4_OPEN_RESULT_LOCKTYPE_POSIX		0x0004
48#define NFS4_OPEN_RESULT_PRESERVE_UNLINKED	0x0008
49#define NFS4_OPEN_RESULT_MAY_NOTIFY_LOCK	0x0020
50
51#define NFS4_SHARE_ACCESS_MASK	0x000F
52#define NFS4_SHARE_ACCESS_READ	0x0001
53#define NFS4_SHARE_ACCESS_WRITE	0x0002
54#define NFS4_SHARE_ACCESS_BOTH	0x0003
55#define NFS4_SHARE_DENY_READ	0x0001
56#define NFS4_SHARE_DENY_WRITE	0x0002
57#define NFS4_SHARE_DENY_BOTH	0x0003
58
59/* nfs41 */
60#define NFS4_SHARE_WANT_MASK		0xFF00
61#define NFS4_SHARE_WANT_NO_PREFERENCE	0x0000
62#define NFS4_SHARE_WANT_READ_DELEG	0x0100
63#define NFS4_SHARE_WANT_WRITE_DELEG	0x0200
64#define NFS4_SHARE_WANT_ANY_DELEG	0x0300
65#define NFS4_SHARE_WANT_NO_DELEG	0x0400
66#define NFS4_SHARE_WANT_CANCEL		0x0500
67
68#define NFS4_SHARE_WHEN_MASK		0xF0000
69#define NFS4_SHARE_SIGNAL_DELEG_WHEN_RESRC_AVAIL	0x10000
70#define NFS4_SHARE_PUSH_DELEG_WHEN_UNCONTENDED		0x20000
71
72#define NFS4_CDFC4_FORE	0x1
73#define NFS4_CDFC4_BACK 0x2
74#define NFS4_CDFC4_BOTH 0x3
75#define NFS4_CDFC4_FORE_OR_BOTH 0x3
76#define NFS4_CDFC4_BACK_OR_BOTH 0x7
77
78#define NFS4_CDFS4_FORE 0x1
79#define NFS4_CDFS4_BACK 0x2
80#define NFS4_CDFS4_BOTH 0x3
81
82#define NFS4_SET_TO_SERVER_TIME	0
83#define NFS4_SET_TO_CLIENT_TIME	1
84
85#define NFS4_ACE_ACCESS_ALLOWED_ACE_TYPE 0
86#define NFS4_ACE_ACCESS_DENIED_ACE_TYPE  1
87#define NFS4_ACE_SYSTEM_AUDIT_ACE_TYPE   2
88#define NFS4_ACE_SYSTEM_ALARM_ACE_TYPE   3
89
90#define ACL4_SUPPORT_ALLOW_ACL 0x01
91#define ACL4_SUPPORT_DENY_ACL  0x02
92#define ACL4_SUPPORT_AUDIT_ACL 0x04
93#define ACL4_SUPPORT_ALARM_ACL 0x08
94
95#define NFS4_ACL_AUTO_INHERIT 0x00000001
96#define NFS4_ACL_PROTECTED    0x00000002
97#define NFS4_ACL_DEFAULTED    0x00000004
98
99#define NFS4_ACE_FILE_INHERIT_ACE             0x00000001
100#define NFS4_ACE_DIRECTORY_INHERIT_ACE        0x00000002
101#define NFS4_ACE_NO_PROPAGATE_INHERIT_ACE     0x00000004
102#define NFS4_ACE_INHERIT_ONLY_ACE             0x00000008
103#define NFS4_ACE_SUCCESSFUL_ACCESS_ACE_FLAG   0x00000010
104#define NFS4_ACE_FAILED_ACCESS_ACE_FLAG       0x00000020
105#define NFS4_ACE_IDENTIFIER_GROUP             0x00000040
106#define NFS4_ACE_INHERITED_ACE                0x00000080
107
108#define NFS4_ACE_READ_DATA                    0x00000001
109#define NFS4_ACE_LIST_DIRECTORY               0x00000001
110#define NFS4_ACE_WRITE_DATA                   0x00000002
111#define NFS4_ACE_ADD_FILE                     0x00000002
112#define NFS4_ACE_APPEND_DATA                  0x00000004
113#define NFS4_ACE_ADD_SUBDIRECTORY             0x00000004
114#define NFS4_ACE_READ_NAMED_ATTRS             0x00000008
115#define NFS4_ACE_WRITE_NAMED_ATTRS            0x00000010
116#define NFS4_ACE_EXECUTE                      0x00000020
117#define NFS4_ACE_DELETE_CHILD                 0x00000040
118#define NFS4_ACE_READ_ATTRIBUTES              0x00000080
119#define NFS4_ACE_WRITE_ATTRIBUTES             0x00000100
120#define NFS4_ACE_WRITE_RETENTION              0x00000200
121#define NFS4_ACE_WRITE_RETENTION_HOLD         0x00000400
122#define NFS4_ACE_DELETE                       0x00010000
123#define NFS4_ACE_READ_ACL                     0x00020000
124#define NFS4_ACE_WRITE_ACL                    0x00040000
125#define NFS4_ACE_WRITE_OWNER                  0x00080000
126#define NFS4_ACE_SYNCHRONIZE                  0x00100000
127#define NFS4_ACE_GENERIC_READ                 0x00120081
128#define NFS4_ACE_GENERIC_WRITE                0x00160106
129#define NFS4_ACE_GENERIC_EXECUTE              0x001200A0
130#define NFS4_ACE_MASK_ALL                     0x001F01FF
131
132#define EXCHGID4_FLAG_SUPP_MOVED_REFER		0x00000001
133#define EXCHGID4_FLAG_SUPP_MOVED_MIGR		0x00000002
134#define EXCHGID4_FLAG_BIND_PRINC_STATEID	0x00000100
135
136#define EXCHGID4_FLAG_USE_NON_PNFS		0x00010000
137#define EXCHGID4_FLAG_USE_PNFS_MDS		0x00020000
138#define EXCHGID4_FLAG_USE_PNFS_DS		0x00040000
139#define EXCHGID4_FLAG_MASK_PNFS			0x00070000
140
141#define EXCHGID4_FLAG_UPD_CONFIRMED_REC_A	0x40000000
142#define EXCHGID4_FLAG_CONFIRMED_R		0x80000000
143
144#define EXCHGID4_FLAG_SUPP_FENCE_OPS		0x00000004
145/*
146 * Since the validity of these bits depends on whether
147 * they're set in the argument or response, have separate
148 * invalid flag masks for arg (_A) and resp (_R).
149 */
150#define EXCHGID4_FLAG_MASK_A			0x40070103
151#define EXCHGID4_FLAG_MASK_R			0x80070103
152#define EXCHGID4_2_FLAG_MASK_R			0x80070107
153
154#define SEQ4_STATUS_CB_PATH_DOWN		0x00000001
155#define SEQ4_STATUS_CB_GSS_CONTEXTS_EXPIRING	0x00000002
156#define SEQ4_STATUS_CB_GSS_CONTEXTS_EXPIRED	0x00000004
157#define SEQ4_STATUS_EXPIRED_ALL_STATE_REVOKED	0x00000008
158#define SEQ4_STATUS_EXPIRED_SOME_STATE_REVOKED	0x00000010
159#define SEQ4_STATUS_ADMIN_STATE_REVOKED		0x00000020
160#define SEQ4_STATUS_RECALLABLE_STATE_REVOKED	0x00000040
161#define SEQ4_STATUS_LEASE_MOVED			0x00000080
162#define SEQ4_STATUS_RESTART_RECLAIM_NEEDED	0x00000100
163#define SEQ4_STATUS_CB_PATH_DOWN_SESSION	0x00000200
164#define SEQ4_STATUS_BACKCHANNEL_FAULT		0x00000400
165
166#define NFS4_SECINFO_STYLE4_CURRENT_FH	0
167#define NFS4_SECINFO_STYLE4_PARENT	1
168
169#define NFS4_MAX_UINT64	(~(__u64)0)
170
171/* An NFS4 sessions server must support at least NFS4_MAX_OPS operations.
172 * If a compound requires more operations, adjust NFS4_MAX_OPS accordingly.
173 */
174#define NFS4_MAX_OPS   8
175
176/* Our NFS4 client back channel server only wants the cb_sequene and the
177 * actual operation per compound
178 */
179#define NFS4_MAX_BACK_CHANNEL_OPS 2
180
181#endif /* _UAPI_LINUX_NFS4_H */
182