/*

 * CDDL HEADER START

 *

 * The contents of this file are subject to the terms of the

 * Common Development and Distribution License, Version 1.0 only

 * (the "License").  You may not use this file except in compliance

 * with the License.

 *

 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE

 * or http://www.opensolaris.org/os/licensing.

 * See the License for the specific language governing permissions

 * and limitations under the License.

 *

 * When distributing Covered Code, include this CDDL HEADER in each

 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.

 * If applicable, add the following below this CDDL HEADER, with the

 * fields enclosed by brackets "[]" replaced with your own identifying

 * information: Portions Copyright [yyyy] [name of copyright owner]

 *

 * CDDL HEADER END

 */

/*

 * Use is subject to license terms.

 */

#ifndef _NFS4_KPROT_H

#define	_NFS4_KPROT_H

#pragma ident	"%Z%%M%	%I%	%E% SMI"

/*

 * Kernel specific version.

 * NFS Version 4 protocol definitions.  From nfs4_prot.x rev 1.119.

 */

#ifdef __cplusplus

extern "C" {

#endif

#include <rpc/rpc.h>

#include <sys/stream.h>

#define	NFS4_FHSIZE 128

#define	NFS4_VERIFIER_SIZE 8

/*

 * Reasonable upper bounds to catch badly behaving partners

 */

#define	NFS4_OPAQUE_LIMIT	1024

#define	NFS4_COMPOUND_LIMIT	2048

#define	NFS4_FS_LOCATIONS_LIMIT	65536

#define	NFS4_ACL_LIMIT		65536

#define	NFS4_SECINFO_LIMIT	65536

#define	NFS4_FATTR4_LIMIT	1048576

#define	NFS4_DATA_LIMIT		134217728

enum nfs_ftype4 {

	NF4REG = 1,

	NF4DIR = 2,

	NF4BLK = 3,

	NF4CHR = 4,

	NF4LNK = 5,

	NF4SOCK = 6,

	NF4FIFO = 7,

	NF4ATTRDIR = 8,

	NF4NAMEDATTR = 9

};

typedef enum nfs_ftype4 nfs_ftype4;

enum nfsstat4 {

	NFS4_OK = 0,

	NFS4ERR_PERM = 1,

	NFS4ERR_NOENT = 2,

	NFS4ERR_IO = 5,

	NFS4ERR_NXIO = 6,

	NFS4ERR_ACCESS = 13,

	NFS4ERR_EXIST = 17,

	NFS4ERR_XDEV = 18,

	NFS4ERR_NOTDIR = 20,

	NFS4ERR_ISDIR = 21,

	NFS4ERR_INVAL = 22,

	NFS4ERR_FBIG = 27,

	NFS4ERR_NOSPC = 28,

	NFS4ERR_ROFS = 30,

	NFS4ERR_MLINK = 31,

	NFS4ERR_NAMETOOLONG = 63,

	NFS4ERR_NOTEMPTY = 66,

	NFS4ERR_DQUOT = 69,

	NFS4ERR_STALE = 70,

	NFS4ERR_BADHANDLE = 10001,

	NFS4ERR_BAD_COOKIE = 10003,

	NFS4ERR_NOTSUPP = 10004,

	NFS4ERR_TOOSMALL = 10005,

	NFS4ERR_SERVERFAULT = 10006,

	NFS4ERR_BADTYPE = 10007,

	NFS4ERR_DELAY = 10008,

	NFS4ERR_SAME = 10009,

	NFS4ERR_DENIED = 10010,

	NFS4ERR_EXPIRED = 10011,

	NFS4ERR_LOCKED = 10012,

	NFS4ERR_GRACE = 10013,

	NFS4ERR_FHEXPIRED = 10014,

	NFS4ERR_SHARE_DENIED = 10015,

	NFS4ERR_WRONGSEC = 10016,

	NFS4ERR_CLID_INUSE = 10017,

	NFS4ERR_RESOURCE = 10018,

	NFS4ERR_MOVED = 10019,

	NFS4ERR_NOFILEHANDLE = 10020,

	NFS4ERR_MINOR_VERS_MISMATCH = 10021,

	NFS4ERR_STALE_CLIENTID = 10022,

	NFS4ERR_STALE_STATEID = 10023,

	NFS4ERR_OLD_STATEID = 10024,

	NFS4ERR_BAD_STATEID = 10025,

	NFS4ERR_BAD_SEQID = 10026,

	NFS4ERR_NOT_SAME = 10027,

	NFS4ERR_LOCK_RANGE = 10028,

	NFS4ERR_SYMLINK = 10029,

	NFS4ERR_RESTOREFH = 10030,

	NFS4ERR_LEASE_MOVED = 10031,

	NFS4ERR_ATTRNOTSUPP = 10032,

	NFS4ERR_NO_GRACE = 10033,

	NFS4ERR_RECLAIM_BAD = 10034,

	NFS4ERR_RECLAIM_CONFLICT = 10035,

	NFS4ERR_BADXDR = 10036,

	NFS4ERR_LOCKS_HELD = 10037,

	NFS4ERR_OPENMODE = 10038,

	NFS4ERR_BADOWNER = 10039,

	NFS4ERR_BADCHAR = 10040,

	NFS4ERR_BADNAME = 10041,

	NFS4ERR_BAD_RANGE = 10042,

	NFS4ERR_LOCK_NOTSUPP = 10043,

	NFS4ERR_OP_ILLEGAL = 10044,

	NFS4ERR_DEADLOCK = 10045,

	NFS4ERR_FILE_OPEN = 10046,

	NFS4ERR_ADMIN_REVOKED = 10047,

	NFS4ERR_CB_PATH_DOWN = 10048

};

typedef enum nfsstat4 nfsstat4;

/*

 * A bitmap can only be 56 bits, treat it as a uint64_t for now

 */

typedef uint64_t bitmap4;

typedef uint64_t offset4;

typedef uint32_t count4;

typedef uint64_t length4;

typedef uint64_t clientid4;

typedef uint32_t seqid4;

typedef struct {

	uint_t utf8string_len;

	char *utf8string_val;

} utf8string;

typedef utf8string component4;

typedef struct {

	uint_t pathname4_len;

	component4 *pathname4_val;

} pathname4;

typedef uint64_t nfs_lockid4;

typedef uint64_t nfs_cookie4;

typedef utf8string linktext4;

typedef struct {

	uint_t sec_oid4_len;

	char *sec_oid4_val;

} sec_oid4;

typedef uint32_t qop4;

typedef uint32_t mode4;

typedef uint64_t changeid4;

typedef uint64_t verifier4;

struct nfstime4 {

	int64_t seconds;

	uint32_t nseconds;

};

typedef struct nfstime4 nfstime4;

enum time_how4 {

	SET_TO_SERVER_TIME4 = 0,

	SET_TO_CLIENT_TIME4 = 1

};

typedef enum time_how4 time_how4;

struct settime4 {

	time_how4 set_it;

	nfstime4 time;

};

typedef struct settime4 settime4;

typedef struct {

	uint_t nfs_fh4_len;

	char *nfs_fh4_val;

} nfs_fh4;

struct fsid4 {

	uint64_t major;

	uint64_t minor;

};

typedef struct fsid4 fsid4;

struct fs_location4 {

	uint_t server_len;

	utf8string *server_val;

	pathname4 rootpath;

};

typedef struct fs_location4 fs_location4;

struct fs_locations4 {

	pathname4 fs_root;

	uint_t locations_len;

	fs_location4 *locations_val;

};

typedef struct fs_locations4 fs_locations4;

/*

 * ACL support

 */

#define	ACL4_SUPPORT_ALLOW_ACL 0x00000001

#define	ACL4_SUPPORT_DENY_ACL 0x00000002

#define	ACL4_SUPPORT_AUDIT_ACL 0x00000004

#define	ACL4_SUPPORT_ALARM_ACL 0x00000008

typedef uint32_t acetype4;

#define	ACE4_ACCESS_ALLOWED_ACE_TYPE 0x00000000

#define	ACE4_ACCESS_DENIED_ACE_TYPE 0x00000001

#define	ACE4_SYSTEM_AUDIT_ACE_TYPE 0x00000002

#define	ACE4_SYSTEM_ALARM_ACE_TYPE 0x00000003

typedef uint32_t aceflag4;

#define	ACE4_FILE_INHERIT_ACE 0x00000001

#define	ACE4_DIRECTORY_INHERIT_ACE 0x00000002

#define	ACE4_NO_PROPAGATE_INHERIT_ACE 0x00000004

#define	ACE4_INHERIT_ONLY_ACE 0x00000008

#define	ACE4_SUCCESSFUL_ACCESS_ACE_FLAG 0x00000010

#define	ACE4_FAILED_ACCESS_ACE_FLAG 0x00000020

#define	ACE4_IDENTIFIER_GROUP 0x00000040

/*

 * This defines all valid flag bits, as defined by RFC 3530.  If

 * any additional flag bits are deemed part of the NFSv4 spec,

 * you must also add them to the definition below.

 */

#define	ACE4_VALID_FLAG_BITS (\

    ACE4_FILE_INHERIT_ACE | \

    ACE4_DIRECTORY_INHERIT_ACE | \

    ACE4_NO_PROPAGATE_INHERIT_ACE | \

    ACE4_INHERIT_ONLY_ACE | \

    ACE4_SUCCESSFUL_ACCESS_ACE_FLAG | \

    ACE4_FAILED_ACCESS_ACE_FLAG | \

    ACE4_IDENTIFIER_GROUP)

typedef uint32_t acemask4;

#define	ACE4_READ_DATA 0x00000001

#define	ACE4_LIST_DIRECTORY 0x00000001

#define	ACE4_WRITE_DATA 0x00000002

#define	ACE4_ADD_FILE 0x00000002

#define	ACE4_APPEND_DATA 0x00000004

#define	ACE4_ADD_SUBDIRECTORY 0x00000004

#define	ACE4_READ_NAMED_ATTRS 0x00000008

#define	ACE4_WRITE_NAMED_ATTRS 0x00000010

#define	ACE4_EXECUTE 0x00000020

#define	ACE4_DELETE_CHILD 0x00000040

#define	ACE4_READ_ATTRIBUTES 0x00000080

#define	ACE4_WRITE_ATTRIBUTES 0x00000100

#define	ACE4_DELETE 0x00010000

#define	ACE4_READ_ACL 0x00020000

#define	ACE4_WRITE_ACL 0x00040000

#define	ACE4_WRITE_OWNER 0x00080000

#define	ACE4_SYNCHRONIZE 0x00100000

#define	ACE4_GENERIC_READ 0x00120081

#define	ACE4_GENERIC_WRITE 0x00160106

#define	ACE4_GENERIC_EXECUTE 0x001200A0

/*

 * This defines all valid access mask bits, as defined by RFC 3530.  If

 * any additional access mask bits are deemed part of the NFSv4 spec,

 * you must also add them to the definition below.

 */

#define	ACE4_VALID_MASK_BITS (\

    ACE4_READ_DATA | \

    ACE4_LIST_DIRECTORY | \

    ACE4_WRITE_DATA | \

    ACE4_ADD_FILE | \

    ACE4_APPEND_DATA | \

    ACE4_ADD_SUBDIRECTORY | \

    ACE4_READ_NAMED_ATTRS | \

    ACE4_WRITE_NAMED_ATTRS | \

    ACE4_EXECUTE | \

    ACE4_DELETE_CHILD | \

    ACE4_READ_ATTRIBUTES | \

    ACE4_WRITE_ATTRIBUTES | \

    ACE4_DELETE | \

    ACE4_READ_ACL | \

    ACE4_WRITE_ACL | \

    ACE4_WRITE_OWNER | \

    ACE4_SYNCHRONIZE)

/* Used to signify an undefined value for an acemask4 */

#define	ACE4_MASK_UNDEFINED 0x80000000

#define	ACE4_WHO_OWNER		"OWNER@"

#define	ACE4_WHO_GROUP		"GROUP@"

#define	ACE4_WHO_EVERYONE	"EVERYONE@"

struct nfsace4 {

	acetype4 type;

	aceflag4 flag;

	acemask4 access_mask;

	utf8string who;

};

typedef struct nfsace4 nfsace4;

#define	MODE4_SUID 0x800

#define	MODE4_SGID 0x400

#define	MODE4_SVTX 0x200

#define	MODE4_RUSR 0x100

#define	MODE4_WUSR 0x080

#define	MODE4_XUSR 0x040

#define	MODE4_RGRP 0x020

#define	MODE4_WGRP 0x010

#define	MODE4_XGRP 0x008

#define	MODE4_ROTH 0x004

#define	MODE4_WOTH 0x002

#define	MODE4_XOTH 0x001

/*

 * ACL conversion helpers

 */

typedef enum {

	ace4_unused,

	ace4_user_obj,

	ace4_user,

	ace4_group, /* includes GROUP and GROUP_OBJ */

	ace4_other_obj

} ace4_to_aent_state_t;

typedef struct ace4vals {

	utf8string *key; /* NB: not allocated here; points to existing utf8 */

	avl_node_t avl;

	acemask4 mask;

	acemask4 allowed;

	acemask4 denied;

	int aent_type;

} ace4vals_t;

typedef struct ace4_list {

	ace4vals_t user_obj;

	avl_tree_t user;

	int numusers;

	ace4vals_t group_obj;

	avl_tree_t group;

	int numgroups;

	ace4vals_t other_obj;

	acemask4 acl_mask;

	int hasmask;

	int dfacl_flag;

	ace4_to_aent_state_t state;

	int seen; /* bitmask of all aclent_t a_type values seen */

} ace4_list_t;

struct specdata4 {

	uint32_t specdata1;

	uint32_t specdata2;

};

typedef struct specdata4 specdata4;

#define	FH4_PERSISTENT 0x00000000

#define	FH4_NOEXPIRE_WITH_OPEN 0x00000001

#define	FH4_VOLATILE_ANY 0x00000002

#define	FH4_VOL_MIGRATION 0x00000004

#define	FH4_VOL_RENAME 0x00000008

typedef bitmap4 fattr4_supported_attrs;

typedef nfs_ftype4 fattr4_type;

typedef uint32_t fattr4_fh_expire_type;

typedef changeid4 fattr4_change;

typedef uint64_t fattr4_size;

typedef bool_t fattr4_link_support;

typedef bool_t fattr4_symlink_support;

typedef bool_t fattr4_named_attr;

typedef fsid4 fattr4_fsid;

typedef bool_t fattr4_unique_handles;

typedef uint32_t fattr4_lease_time;

typedef nfsstat4 fattr4_rdattr_error;

typedef struct {

	uint_t fattr4_acl_len;

	nfsace4 *fattr4_acl_val;

} fattr4_acl;

typedef uint32_t fattr4_aclsupport;

typedef bool_t fattr4_archive;

typedef bool_t fattr4_cansettime;

typedef bool_t fattr4_case_insensitive;

typedef bool_t fattr4_case_preserving;

typedef bool_t fattr4_chown_restricted;

typedef uint64_t fattr4_fileid;

typedef uint64_t fattr4_files_avail;

typedef nfs_fh4 fattr4_filehandle;

typedef uint64_t fattr4_files_free;

typedef uint64_t fattr4_files_total;

typedef fs_locations4 fattr4_fs_locations;

typedef bool_t fattr4_hidden;

typedef bool_t fattr4_homogeneous;

typedef uint64_t fattr4_maxfilesize;

typedef uint32_t fattr4_maxlink;

typedef uint32_t fattr4_maxname;

typedef uint64_t fattr4_maxread;

typedef uint64_t fattr4_maxwrite;

typedef utf8string fattr4_mimetype;

typedef mode4 fattr4_mode;

typedef uint64_t fattr4_mounted_on_fileid;

typedef bool_t fattr4_no_trunc;

typedef uint32_t fattr4_numlinks;

typedef utf8string fattr4_owner;

typedef utf8string fattr4_owner_group;

typedef uint64_t fattr4_quota_avail_hard;

typedef uint64_t fattr4_quota_avail_soft;

typedef uint64_t fattr4_quota_used;

typedef specdata4 fattr4_rawdev;

typedef uint64_t fattr4_space_avail;

typedef uint64_t fattr4_space_free;

typedef uint64_t fattr4_space_total;

typedef uint64_t fattr4_space_used;

typedef bool_t fattr4_system;

typedef nfstime4 fattr4_time_access;

typedef settime4 fattr4_time_access_set;

typedef nfstime4 fattr4_time_backup;

typedef nfstime4 fattr4_time_create;

typedef nfstime4 fattr4_time_delta;

typedef nfstime4 fattr4_time_metadata;

typedef nfstime4 fattr4_time_modify;

typedef settime4 fattr4_time_modify_set;

#define	FATTR4_SUPPORTED_ATTRS 0

#define	FATTR4_TYPE 1

#define	FATTR4_FH_EXPIRE_TYPE 2

#define	FATTR4_CHANGE 3

#define	FATTR4_SIZE 4

#define	FATTR4_LINK_SUPPORT 5

#define	FATTR4_SYMLINK_SUPPORT 6

#define	FATTR4_NAMED_ATTR 7

#define	FATTR4_FSID 8

#define	FATTR4_UNIQUE_HANDLES 9

#define	FATTR4_LEASE_TIME 10

#define	FATTR4_RDATTR_ERROR 11

#define	FATTR4_FILEHANDLE 19

#define	FATTR4_ACL 12

#define	FATTR4_ACLSUPPORT 13

#define	FATTR4_ARCHIVE 14

#define	FATTR4_CANSETTIME 15

#define	FATTR4_CASE_INSENSITIVE 16

#define	FATTR4_CASE_PRESERVING 17

#define	FATTR4_CHOWN_RESTRICTED 18

#define	FATTR4_FILEID 20

#define	FATTR4_FILES_AVAIL 21

#define	FATTR4_FILES_FREE 22

#define	FATTR4_FILES_TOTAL 23

#define	FATTR4_FS_LOCATIONS 24

#define	FATTR4_HIDDEN 25

#define	FATTR4_HOMOGENEOUS 26

#define	FATTR4_MAXFILESIZE 27

#define	FATTR4_MAXLINK 28