[mirror_ubuntu-bionic-kernel.git] / include / uapi / linux / nfs4.h

/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
/*
 *  include/linux/nfs4.h
 *
 *  NFSv4 protocol definitions.
 *
 *  Copyright (c) 2002 The Regents of the University of Michigan.
 *  All rights reserved.
 *
 *  Kendrick Smith <kmsmith@umich.edu>
 *  Andy Adamson   <andros@umich.edu>
 */

#ifndef _UAPI_LINUX_NFS4_H
#define _UAPI_LINUX_NFS4_H

#include <linux/types.h>

#define NFS4_BITMAP_SIZE	3
#define NFS4_VERIFIER_SIZE	8
#define NFS4_STATEID_SEQID_SIZE 4
#define NFS4_STATEID_OTHER_SIZE 12
#define NFS4_STATEID_SIZE	(NFS4_STATEID_SEQID_SIZE + NFS4_STATEID_OTHER_SIZE)
#define NFS4_FHSIZE		128
#define NFS4_MAXPATHLEN		PATH_MAX
#define NFS4_MAXNAMLEN		NAME_MAX
#define NFS4_OPAQUE_LIMIT	1024
#define NFS4_MAX_SESSIONID_LEN	16

#define NFS4_ACCESS_READ        0x0001
#define NFS4_ACCESS_LOOKUP      0x0002
#define NFS4_ACCESS_MODIFY      0x0004
#define NFS4_ACCESS_EXTEND      0x0008
#define NFS4_ACCESS_DELETE      0x0010
#define NFS4_ACCESS_EXECUTE     0x0020

#define NFS4_FH_PERSISTENT		0x0000
#define NFS4_FH_NOEXPIRE_WITH_OPEN	0x0001
#define NFS4_FH_VOLATILE_ANY		0x0002
#define NFS4_FH_VOL_MIGRATION		0x0004
#define NFS4_FH_VOL_RENAME		0x0008

#define NFS4_OPEN_RESULT_CONFIRM		0x0002
#define NFS4_OPEN_RESULT_LOCKTYPE_POSIX		0x0004
#define NFS4_OPEN_RESULT_MAY_NOTIFY_LOCK	0x0020

#define NFS4_SHARE_ACCESS_MASK	0x000F
#define NFS4_SHARE_ACCESS_READ	0x0001
#define NFS4_SHARE_ACCESS_WRITE	0x0002
#define NFS4_SHARE_ACCESS_BOTH	0x0003
#define NFS4_SHARE_DENY_READ	0x0001
#define NFS4_SHARE_DENY_WRITE	0x0002
#define NFS4_SHARE_DENY_BOTH	0x0003

/* nfs41 */
#define NFS4_SHARE_WANT_MASK		0xFF00
#define NFS4_SHARE_WANT_NO_PREFERENCE	0x0000
#define NFS4_SHARE_WANT_READ_DELEG	0x0100
#define NFS4_SHARE_WANT_WRITE_DELEG	0x0200
#define NFS4_SHARE_WANT_ANY_DELEG	0x0300
#define NFS4_SHARE_WANT_NO_DELEG	0x0400
#define NFS4_SHARE_WANT_CANCEL		0x0500

#define NFS4_SHARE_WHEN_MASK		0xF0000
#define NFS4_SHARE_SIGNAL_DELEG_WHEN_RESRC_AVAIL	0x10000
#define NFS4_SHARE_PUSH_DELEG_WHEN_UNCONTENDED		0x20000

#define NFS4_CDFC4_FORE	0x1
#define NFS4_CDFC4_BACK 0x2
#define NFS4_CDFC4_BOTH 0x3
#define NFS4_CDFC4_FORE_OR_BOTH 0x3
#define NFS4_CDFC4_BACK_OR_BOTH 0x7

#define NFS4_CDFS4_FORE 0x1
#define NFS4_CDFS4_BACK 0x2
#define NFS4_CDFS4_BOTH 0x3

#define NFS4_SET_TO_SERVER_TIME	0
#define NFS4_SET_TO_CLIENT_TIME	1

#define NFS4_ACE_ACCESS_ALLOWED_ACE_TYPE 0
#define NFS4_ACE_ACCESS_DENIED_ACE_TYPE  1
#define NFS4_ACE_SYSTEM_AUDIT_ACE_TYPE   2
#define NFS4_ACE_SYSTEM_ALARM_ACE_TYPE   3

#define ACL4_SUPPORT_ALLOW_ACL 0x01
#define ACL4_SUPPORT_DENY_ACL  0x02
#define ACL4_SUPPORT_AUDIT_ACL 0x04
#define ACL4_SUPPORT_ALARM_ACL 0x08

#define NFS4_ACL_AUTO_INHERIT 0x00000001
#define NFS4_ACL_PROTECTED    0x00000002
#define NFS4_ACL_DEFAULTED    0x00000004

#define NFS4_ACE_FILE_INHERIT_ACE             0x00000001
#define NFS4_ACE_DIRECTORY_INHERIT_ACE        0x00000002
#define NFS4_ACE_NO_PROPAGATE_INHERIT_ACE     0x00000004
#define NFS4_ACE_INHERIT_ONLY_ACE             0x00000008
#define NFS4_ACE_SUCCESSFUL_ACCESS_ACE_FLAG   0x00000010
#define NFS4_ACE_FAILED_ACCESS_ACE_FLAG       0x00000020
#define NFS4_ACE_IDENTIFIER_GROUP             0x00000040
#define NFS4_ACE_INHERITED_ACE                0x00000080

#define NFS4_ACE_READ_DATA                    0x00000001
#define NFS4_ACE_LIST_DIRECTORY               0x00000001
#define NFS4_ACE_WRITE_DATA                   0x00000002
#define NFS4_ACE_ADD_FILE                     0x00000002
#define NFS4_ACE_APPEND_DATA                  0x00000004
#define NFS4_ACE_ADD_SUBDIRECTORY             0x00000004
#define NFS4_ACE_READ_NAMED_ATTRS             0x00000008
#define NFS4_ACE_WRITE_NAMED_ATTRS            0x00000010
#define NFS4_ACE_EXECUTE                      0x00000020
#define NFS4_ACE_DELETE_CHILD                 0x00000040
#define NFS4_ACE_READ_ATTRIBUTES              0x00000080
#define NFS4_ACE_WRITE_ATTRIBUTES             0x00000100
#define NFS4_ACE_WRITE_RETENTION              0x00000200
#define NFS4_ACE_WRITE_RETENTION_HOLD         0x00000400
#define NFS4_ACE_DELETE                       0x00010000
#define NFS4_ACE_READ_ACL                     0x00020000
#define NFS4_ACE_WRITE_ACL                    0x00040000
#define NFS4_ACE_WRITE_OWNER                  0x00080000
#define NFS4_ACE_SYNCHRONIZE                  0x00100000
#define NFS4_ACE_GENERIC_READ                 0x00120081
#define NFS4_ACE_GENERIC_WRITE                0x00160106
#define NFS4_ACE_GENERIC_EXECUTE              0x001200A0
#define NFS4_ACE_MASK_ALL                     0x001F01FF

#define EXCHGID4_FLAG_SUPP_MOVED_REFER		0x00000001
#define EXCHGID4_FLAG_SUPP_MOVED_MIGR		0x00000002
#define EXCHGID4_FLAG_BIND_PRINC_STATEID	0x00000100

#define EXCHGID4_FLAG_USE_NON_PNFS		0x00010000
#define EXCHGID4_FLAG_USE_PNFS_MDS		0x00020000
#define EXCHGID4_FLAG_USE_PNFS_DS		0x00040000
#define EXCHGID4_FLAG_MASK_PNFS			0x00070000

#define EXCHGID4_FLAG_UPD_CONFIRMED_REC_A	0x40000000
#define EXCHGID4_FLAG_CONFIRMED_R		0x80000000
/*
 * Since the validity of these bits depends on whether
 * they're set in the argument or response, have separate
 * invalid flag masks for arg (_A) and resp (_R).
 */
#define EXCHGID4_FLAG_MASK_A			0x40070103
#define EXCHGID4_FLAG_MASK_R			0x80070103

#define SEQ4_STATUS_CB_PATH_DOWN		0x00000001
#define SEQ4_STATUS_CB_GSS_CONTEXTS_EXPIRING	0x00000002
#define SEQ4_STATUS_CB_GSS_CONTEXTS_EXPIRED	0x00000004
#define SEQ4_STATUS_EXPIRED_ALL_STATE_REVOKED	0x00000008
#define SEQ4_STATUS_EXPIRED_SOME_STATE_REVOKED	0x00000010
#define SEQ4_STATUS_ADMIN_STATE_REVOKED		0x00000020
#define SEQ4_STATUS_RECALLABLE_STATE_REVOKED	0x00000040
#define SEQ4_STATUS_LEASE_MOVED			0x00000080
#define SEQ4_STATUS_RESTART_RECLAIM_NEEDED	0x00000100
#define SEQ4_STATUS_CB_PATH_DOWN_SESSION	0x00000200
#define SEQ4_STATUS_BACKCHANNEL_FAULT		0x00000400

#define NFS4_SECINFO_STYLE4_CURRENT_FH	0
#define NFS4_SECINFO_STYLE4_PARENT	1

#define NFS4_MAX_UINT64	(~(__u64)0)

/* An NFS4 sessions server must support at least NFS4_MAX_OPS operations.
 * If a compound requires more operations, adjust NFS4_MAX_OPS accordingly.
 */
#define NFS4_MAX_OPS   8

/* Our NFS4 client back channel server only wants the cb_sequene and the
 * actual operation per compound
 */
#define NFS4_MAX_BACK_CHANNEL_OPS 2

#endif /* _UAPI_LINUX_NFS4_H */

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