/*

 * 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.

 * Copyright (c) 2012, Joyent, Inc. All rights reserved.

 */

#ifndef	_SYS_DSL_DATASET_H

#define	_SYS_DSL_DATASET_H

#include <sys/dmu.h>

#include <sys/spa.h>

#include <sys/txg.h>

#include <sys/zio.h>

#include <sys/bplist.h>

#include <sys/dsl_synctask.h>

#include <sys/zfs_context.h>

#include <sys/dsl_deadlist.h>

#ifdef	__cplusplus

extern "C" {

#endif

struct dsl_dataset;

struct dsl_dir;

struct dsl_pool;

#define	DS_FLAG_INCONSISTENT	(1ULL<<0)

#define	DS_IS_INCONSISTENT(ds)	\

	((ds)->ds_phys->ds_flags & DS_FLAG_INCONSISTENT)

/*

 * NB: nopromote can not yet be set, but we want support for it in this

 * on-disk version, so that we don't need to upgrade for it later.  It

 * will be needed when we implement 'zfs split' (where the split off

 * clone should not be promoted).

 */

#define	DS_FLAG_NOPROMOTE	(1ULL<<1)

/*

 * DS_FLAG_UNIQUE_ACCURATE is set if ds_unique_bytes has been correctly

 * calculated for head datasets (starting with SPA_VERSION_UNIQUE_ACCURATE,

 * refquota/refreservations).

 */

#define	DS_FLAG_UNIQUE_ACCURATE	(1ULL<<2)

/*

 * DS_FLAG_DEFER_DESTROY is set after 'zfs destroy -d' has been called

 * on a dataset. This allows the dataset to be destroyed using 'zfs release'.

 */

#define	DS_FLAG_DEFER_DESTROY	(1ULL<<3)

#define	DS_IS_DEFER_DESTROY(ds)	\

	((ds)->ds_phys->ds_flags & DS_FLAG_DEFER_DESTROY)

/*

 * DS_FLAG_CI_DATASET is set if the dataset contains a file system whose

 * name lookups should be performed case-insensitively.

 */

#define	DS_FLAG_CI_DATASET	(1ULL<<16)

typedef struct dsl_dataset_phys {

	uint64_t ds_dir_obj;		/* DMU_OT_DSL_DIR */

	uint64_t ds_prev_snap_obj;	/* DMU_OT_DSL_DATASET */

	uint64_t ds_prev_snap_txg;

	uint64_t ds_next_snap_obj;	/* DMU_OT_DSL_DATASET */

	uint64_t ds_snapnames_zapobj;	/* DMU_OT_DSL_DS_SNAP_MAP 0 for snaps */

	uint64_t ds_num_children;	/* clone/snap children; ==0 for head */

	uint64_t ds_creation_time;	/* seconds since 1970 */

	uint64_t ds_creation_txg;

	uint64_t ds_deadlist_obj;	/* DMU_OT_DEADLIST */

	uint64_t ds_compressed_bytes;

	uint64_t ds_uncompressed_bytes;

	uint64_t ds_unique_bytes;	/* only relevant to snapshots */

	/*

	 * The ds_fsid_guid is a 56-bit ID that can change to avoid

	 * collisions.  The ds_guid is a 64-bit ID that will never

	 * change, so there is a small probability that it will collide.

	 */

	uint64_t ds_fsid_guid;

	uint64_t ds_guid;

	uint64_t ds_flags;		/* DS_FLAG_* */

	blkptr_t ds_bp;

	uint64_t ds_next_clones_obj;	/* DMU_OT_DSL_CLONES */

	uint64_t ds_props_obj;		/* DMU_OT_DSL_PROPS for snaps */

	uint64_t ds_userrefs_obj;	/* DMU_OT_USERREFS */

	uint64_t ds_pad[5]; /* pad out to 320 bytes for good measure */

} dsl_dataset_phys_t;

typedef struct dsl_dataset {

	/* Immutable: */

	struct dsl_dir *ds_dir;

	dsl_dataset_phys_t *ds_phys;

	dmu_buf_t *ds_dbuf;

	uint64_t ds_object;

	uint64_t ds_fsid_guid;

	/* only used in syncing context, only valid for non-snapshots: */

	struct dsl_dataset *ds_prev;

	/* has internal locking: */

	dsl_deadlist_t ds_deadlist;

	bplist_t ds_pending_deadlist;

	/* to protect against multiple concurrent incremental recv */

	kmutex_t ds_recvlock;

	/* protected by lock on pool's dp_dirty_datasets list */

	txg_node_t ds_dirty_link;

	list_node_t ds_synced_link;

	/*

	 * ds_phys->ds_<accounting> is also protected by ds_lock.

	 * Protected by ds_lock:

	 */

	kmutex_t ds_lock;

	objset_t *ds_objset;

	uint64_t ds_userrefs;

	/*

	 * ds_owner is protected by the ds_rwlock and the ds_lock

	 */

	krwlock_t ds_rwlock;

	kcondvar_t ds_exclusive_cv;

	void *ds_owner;

	/* no locking; only for making guesses */

	uint64_t ds_trysnap_txg;

	/* for objset_open() */

	kmutex_t ds_opening_lock;

	uint64_t ds_reserved;	/* cached refreservation */

	uint64_t ds_quota;	/* cached refquota */

	kmutex_t ds_sendstream_lock;

	list_t ds_sendstreams;

	/* Protected by ds_lock; keep at end of struct for better locality */

	char ds_snapname[MAXNAMELEN];

} dsl_dataset_t;

struct dsl_ds_destroyarg {

	dsl_dataset_t *ds;		/* ds to destroy */

	dsl_dataset_t *rm_origin;	/* also remove our origin? */

	boolean_t is_origin_rm;		/* set if removing origin snap */

	boolean_t defer;		/* destroy -d requested? */

	boolean_t releasing;		/* destroying due to release? */

	boolean_t need_prep;		/* do we need to retry due to EBUSY? */

};

/*

 * The max length of a temporary tag prefix is the number of hex digits

 * required to express UINT64_MAX plus one for the hyphen.

 */

#define	MAX_TAG_PREFIX_LEN	17

struct dsl_ds_holdarg {

	dsl_sync_task_group_t *dstg;

	char *htag;

	char *snapname;

	boolean_t recursive;

	boolean_t gotone;

	boolean_t temphold;

	char failed[MAXPATHLEN];

};

#define	dsl_dataset_is_snapshot(ds) \

	((ds)->ds_phys->ds_num_children != 0)

#define	DS_UNIQUE_IS_ACCURATE(ds)	\

	(((ds)->ds_phys->ds_flags & DS_FLAG_UNIQUE_ACCURATE) != 0)

int dsl_dataset_hold(const char *name, void *tag, dsl_dataset_t **dsp);

int dsl_dataset_hold_obj(struct dsl_pool *dp, uint64_t dsobj,

    void *tag, dsl_dataset_t **);

int dsl_dataset_own(const char *name, boolean_t inconsistentok,

    void *tag, dsl_dataset_t **dsp);

int dsl_dataset_own_obj(struct dsl_pool *dp, uint64_t dsobj,

    boolean_t inconsistentok, void *tag, dsl_dataset_t **dsp);

void dsl_dataset_name(dsl_dataset_t *ds, char *name);

void dsl_dataset_rele(dsl_dataset_t *ds, void *tag);

void dsl_dataset_disown(dsl_dataset_t *ds, void *tag);

void dsl_dataset_drop_ref(dsl_dataset_t *ds, void *tag);

boolean_t dsl_dataset_tryown(dsl_dataset_t *ds, boolean_t inconsistentok,

    void *tag);

void dsl_dataset_make_exclusive(dsl_dataset_t *ds, void *tag);

void dsl_register_onexit_hold_cleanup(dsl_dataset_t *ds, const char *htag,

    minor_t minor);

uint64_t dsl_dataset_create_sync(dsl_dir_t *pds, const char *lastname,

    dsl_dataset_t *origin, uint64_t flags, cred_t *, dmu_tx_t *);

uint64_t dsl_dataset_create_sync_dd(dsl_dir_t *dd, dsl_dataset_t *origin,

    uint64_t flags, dmu_tx_t *tx);

int dsl_dataset_destroy(dsl_dataset_t *ds, void *tag, boolean_t defer);

int dsl_snapshots_destroy(char *fsname, char *snapname, boolean_t defer);

dsl_checkfunc_t dsl_dataset_destroy_check;

dsl_syncfunc_t dsl_dataset_destroy_sync;

dsl_checkfunc_t dsl_dataset_snapshot_check;

dsl_syncfunc_t dsl_dataset_snapshot_sync;

dsl_syncfunc_t dsl_dataset_user_hold_sync;

int dsl_dataset_rename(char *name, const char *newname, boolean_t recursive);

int dsl_dataset_promote(const char *name, char *conflsnap);

int dsl_dataset_clone_swap(dsl_dataset_t *clone, dsl_dataset_t *origin_head,

    boolean_t force);

int dsl_dataset_user_hold(char *dsname, char *snapname, char *htag,

    boolean_t recursive, boolean_t temphold, int cleanup_fd);

int dsl_dataset_user_hold_for_send(dsl_dataset_t *ds, char *htag,

    boolean_t temphold);

int dsl_dataset_user_release(char *dsname, char *snapname, char *htag,

    boolean_t recursive);

int dsl_dataset_user_release_tmp(struct dsl_pool *dp, uint64_t dsobj,

    char *htag, boolean_t retry);

int dsl_dataset_get_holds(const char *dsname, nvlist_t **nvp);

blkptr_t *dsl_dataset_get_blkptr(dsl_dataset_t *ds);

void dsl_dataset_set_blkptr(dsl_dataset_t *ds, blkptr_t *bp, dmu_tx_t *tx);

spa_t *dsl_dataset_get_spa(dsl_dataset_t *ds);

boolean_t dsl_dataset_modified_since_lastsnap(dsl_dataset_t *ds);

void dsl_dataset_sync(dsl_dataset_t *os, zio_t *zio, dmu_tx_t *tx);

void dsl_dataset_block_born(dsl_dataset_t *ds, const blkptr_t *bp,

    dmu_tx_t *tx);

int dsl_dataset_block_kill(dsl_dataset_t *ds, const blkptr_t *bp,

    dmu_tx_t *tx, boolean_t async);

boolean_t dsl_dataset_block_freeable(dsl_dataset_t *ds, const blkptr_t *bp,

    uint64_t blk_birth);

uint64_t dsl_dataset_prev_snap_txg(dsl_dataset_t *ds);

void dsl_dataset_dirty(dsl_dataset_t *ds, dmu_tx_t *tx);

void dsl_dataset_stats(dsl_dataset_t *os, nvlist_t *nv);

void dsl_dataset_fast_stat(dsl_dataset_t *ds, dmu_objset_stats_t *stat);

void dsl_dataset_space(dsl_dataset_t *ds,

    uint64_t *refdbytesp, uint64_t *availbytesp,

    uint64_t *usedobjsp, uint64_t *availobjsp);

uint64_t dsl_dataset_fsid_guid(dsl_dataset_t *ds);

int dsl_dataset_space_written(dsl_dataset_t *oldsnap, dsl_dataset_t *new,

    uint64_t *usedp, uint64_t *compp, uint64_t *uncompp);

int dsl_dataset_space_wouldfree(dsl_dataset_t *firstsnap, dsl_dataset_t *last,

    uint64_t *usedp, uint64_t *compp, uint64_t *uncompp);

int dsl_dsobj_to_dsname(char *pname, uint64_t obj, char *buf);

int dsl_dataset_check_quota(dsl_dataset_t *ds, boolean_t check_quota,

    uint64_t asize, uint64_t inflight, uint64_t *used,

    uint64_t *ref_rsrv);

int dsl_dataset_set_quota(const char *dsname, zprop_source_t source,

    uint64_t quota);

dsl_syncfunc_t dsl_dataset_set_quota_sync;

int dsl_dataset_set_reservation(const char *dsname, zprop_source_t source,

    uint64_t reservation);

int dsl_destroy_inconsistent(const char *dsname, void *arg);

#ifdef ZFS_DEBUG

#define	dprintf_ds(ds, fmt, ...) do { \

	if (zfs_flags & ZFS_DEBUG_DPRINTF) { \

	char *__ds_name = kmem_alloc(MAXNAMELEN, KM_SLEEP); \

	dsl_dataset_name(ds, __ds_name); \

	dprintf("ds=%s " fmt, __ds_name, __VA_ARGS__); \

	kmem_free(__ds_name, MAXNAMELEN); \

	} \

_NOTE(CONSTCOND) } while (0)

#else

#define	dprintf_ds(dd, fmt, ...)

#endif

#ifdef	__cplusplus

}

#endif

#endif /* _SYS_DSL_DATASET_H */