/*

 * CDDL HEADER START

 *

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

 * Common Development and Distribution License (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

 */

/*

 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.

 */

#ifndef	_SYS_FS_ZFS_VFSOPS_H

#define	_SYS_FS_ZFS_VFSOPS_H

#include <sys/isa_defs.h>

#include <sys/types32.h>

#include <sys/list.h>

#include <sys/vfs.h>

#include <sys/zil.h>

#include <sys/sa.h>

#include <sys/rrwlock.h>

#include <sys/zfs_ioctl.h>

#ifdef	__cplusplus

extern "C" {

#endif

typedef struct zfsvfs zfsvfs_t;

struct znode;

struct zfsvfs {

	vfs_t		*z_vfs;		/* generic fs struct */

	zfsvfs_t	*z_parent;	/* parent fs */

	objset_t	*z_os;		/* objset reference */

	uint64_t	z_root;		/* id of root znode */

	uint64_t	z_unlinkedobj;	/* id of unlinked zapobj */

	uint64_t	z_max_blksz;	/* maximum block size for files */

	uint64_t	z_fuid_obj;	/* fuid table object number */

	uint64_t	z_fuid_size;	/* fuid table size */

	avl_tree_t	z_fuid_idx;	/* fuid tree keyed by index */

	avl_tree_t	z_fuid_domain;	/* fuid tree keyed by domain */

	krwlock_t	z_fuid_lock;	/* fuid lock */

	boolean_t	z_fuid_loaded;	/* fuid tables are loaded */

	boolean_t	z_fuid_dirty;   /* need to sync fuid table ? */

	struct zfs_fuid_info	*z_fuid_replay; /* fuid info for replay */

	zilog_t		*z_log;		/* intent log pointer */

	uint_t		z_acl_inherit;	/* acl inheritance behavior */

	zfs_case_t	z_case;		/* case-sense */

	boolean_t	z_utf8;		/* utf8-only */

	int		z_norm;		/* normalization flags */

	boolean_t	z_atime;	/* enable atimes mount option */

	boolean_t	z_unmounted;	/* unmounted */

	rrwlock_t	z_teardown_lock;

	krwlock_t	z_teardown_inactive_lock;

	list_t		z_all_znodes;	/* all vnodes in the fs */

	kmutex_t	z_znodes_lock;	/* lock for z_all_znodes */

	vnode_t		*z_ctldir;	/* .zfs directory pointer */

	boolean_t	z_show_ctldir;	/* expose .zfs in the root dir */

	boolean_t	z_issnap;	/* true if this is a snapshot */

	boolean_t	z_vscan;	/* virus scan on/off */

	boolean_t	z_use_fuids;	/* version allows fuids */

	boolean_t	z_replay;	/* set during ZIL replay */

	boolean_t	z_use_sa;	/* version allow system attributes */

	uint64_t	z_version;	/* ZPL version */

	uint64_t	z_shares_dir;	/* hidden shares dir */

	kmutex_t	z_lock;

	uint64_t	z_userquota_obj;

	uint64_t	z_groupquota_obj;

	uint64_t	z_replay_eof;	/* New end of file - replay only */

	sa_attr_type_t	*z_attr_table;	/* SA attr mapping->id */

#define	ZFS_OBJ_MTX_SZ	64

	kmutex_t	z_hold_mtx[ZFS_OBJ_MTX_SZ];	/* znode hold locks */

};

/*

 * Normal filesystems (those not under .zfs/snapshot) have a total

 * file ID size limited to 12 bytes (including the length field) due to

 * NFSv2 protocol's limitation of 32 bytes for a filehandle.  For historical

 * reasons, this same limit is being imposed by the Solaris NFSv3 implementation

 * (although the NFSv3 protocol actually permits a maximum of 64 bytes).  It

 * is not possible to expand beyond 12 bytes without abandoning support

 * of NFSv2.

 *

 * For normal filesystems, we partition up the available space as follows:

 *	2 bytes		fid length (required)

 *	6 bytes		object number (48 bits)

 *	4 bytes		generation number (32 bits)

 *

 * We reserve only 48 bits for the object number, as this is the limit

 * currently defined and imposed by the DMU.

 */

typedef struct zfid_short {

	uint16_t	zf_len;

	uint8_t		zf_object[6];		/* obj[i] = obj >> (8 * i) */

	uint8_t		zf_gen[4];		/* gen[i] = gen >> (8 * i) */

} zfid_short_t;

/*

 * Filesystems under .zfs/snapshot have a total file ID size of 22 bytes

 * (including the length field).  This makes files under .zfs/snapshot

 * accessible by NFSv3 and NFSv4, but not NFSv2.

 *

 * For files under .zfs/snapshot, we partition up the available space

 * as follows:

 *	2 bytes		fid length (required)

 *	6 bytes		object number (48 bits)

 *	4 bytes		generation number (32 bits)

 *	6 bytes		objset id (48 bits)

 *	4 bytes		currently just zero (32 bits)

 *

 * We reserve only 48 bits for the object number and objset id, as these are

 * the limits currently defined and imposed by the DMU.

 */

typedef struct zfid_long {

	zfid_short_t	z_fid;

	uint8_t		zf_setid[6];		/* obj[i] = obj >> (8 * i) */

	uint8_t		zf_setgen[4];		/* gen[i] = gen >> (8 * i) */

} zfid_long_t;

#define	SHORT_FID_LEN	(sizeof (zfid_short_t) - sizeof (uint16_t))

#define	LONG_FID_LEN	(sizeof (zfid_long_t) - sizeof (uint16_t))

extern uint_t zfs_fsyncer_key;

extern int zfs_suspend_fs(zfsvfs_t *zfsvfs);

extern int zfs_resume_fs(zfsvfs_t *zfsvfs, const char *osname);

extern int zfs_userspace_one(zfsvfs_t *zfsvfs, zfs_userquota_prop_t type,

    const char *domain, uint64_t rid, uint64_t *valuep);

extern int zfs_userspace_many(zfsvfs_t *zfsvfs, zfs_userquota_prop_t type,

    uint64_t *cookiep, void *vbuf, uint64_t *bufsizep);

extern int zfs_set_userquota(zfsvfs_t *zfsvfs, zfs_userquota_prop_t type,

    const char *domain, uint64_t rid, uint64_t quota);

extern boolean_t zfs_owner_overquota(zfsvfs_t *zfsvfs, struct znode *,

    boolean_t isgroup);

extern boolean_t zfs_fuid_overquota(zfsvfs_t *zfsvfs, boolean_t isgroup,

    uint64_t fuid);

extern int zfs_set_version(zfsvfs_t *zfsvfs, uint64_t newvers);

extern int zfsvfs_create(const char *name, zfsvfs_t **zfvp);

extern void zfsvfs_free(zfsvfs_t *zfsvfs);

extern int zfs_check_global_label(const char *dsname, const char *hexsl);

#ifdef	__cplusplus

}

#endif

#endif	/* _SYS_FS_ZFS_VFSOPS_H */