zfs/sys/dsl_dataset.h

	dsl_dataset.h revision fa9e4066f08beec538e775443c5be79dd423fcab
/*
 * 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
 */
/*
 * Copyright 2005 Sun Microsystems, Inc.  All rights reserved.
 * Use is subject to license terms.
 */

#ifndef _SYS_DSL_DATASET_H
#define _SYS_DSL_DATASET_H

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

#include <sys/dmu.h>
#include <sys/spa.h>
#include <sys/txg.h>
#include <sys/bplist.h>
#include <sys/zfs_context.h>

#ifdef  __cplusplus
extern "C" {
#endif

struct dsl_dataset;
struct dsl_dir;
struct dsl_pool;

typedef void dsl_dataset_evict_func_t(struct dsl_dataset *, void *);

typedef struct dsl_dataset_phys {
    uint64_t ds_dir_obj;
    uint64_t ds_prev_snap_obj;
    uint64_t ds_prev_snap_txg;
    uint64_t ds_next_snap_obj;
    uint64_t ds_snapnames_zapobj;   /* zap obj of snaps; ==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;
    uint64_t ds_used_bytes;
    uint64_t ds_compressed_bytes;
    uint64_t ds_uncompressed_bytes;
    uint64_t ds_unique_bytes;   /* only relavent 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_restoring; /* boolean */
    blkptr_t ds_bp;
    uint64_t ds_pad[8]; /* pad out to 256 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;

    /* only used in syncing context: */
    struct dsl_dataset *ds_prev; /* only valid for non-snapshots */

    /* has internal locking: */
    bplist_t ds_deadlist;

    /* 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;
    void *ds_user_ptr;
    dsl_dataset_evict_func_t *ds_user_evict_func;
    uint64_t ds_open_refcount;

    /* Protected by ds_lock; keep at end of struct for better locality */
    char ds_snapname[MAXNAMELEN];
} dsl_dataset_t;

#define dsl_dataset_is_snapshot(ds) \
    ((ds)->ds_phys->ds_num_children != 0)

int dsl_dataset_open_spa(spa_t *spa, const char *name, int mode,
    void *tag, dsl_dataset_t **dsp);
int dsl_dataset_open(const char *name, int mode, void *tag,
    dsl_dataset_t **dsp);
dsl_dataset_t *dsl_dataset_open_obj(struct dsl_pool *dp, uint64_t dsobj,
    const char *tail, int mode, void *tag);
void dsl_dataset_name(dsl_dataset_t *ds, char *name);
void dsl_dataset_close(dsl_dataset_t *ds, int mode, void *tag);
int dsl_dataset_create_sync(dsl_dir_t *pds, const char *fullname,
    const char *lastname, dsl_dataset_t *clone_parent, dmu_tx_t *tx);
int dsl_dataset_snapshot_sync(dsl_dir_t *dd, void *arg, dmu_tx_t *tx);
int dsl_dataset_destroy(const char *name);
int dsl_dataset_destroy_sync(dsl_dir_t *dd, void *arg, dmu_tx_t *tx);
int dsl_dataset_rollback(const char *name);
int dsl_dataset_rollback_sync(dsl_dir_t *dd, void *arg, dmu_tx_t *tx);
int dsl_dataset_rename(const char *name, const char *newname);

void *dsl_dataset_set_user_ptr(dsl_dataset_t *ds,
    void *p, dsl_dataset_evict_func_t func);
void *dsl_dataset_get_user_ptr(dsl_dataset_t *ds);

void dsl_dataset_get_blkptr(dsl_dataset_t *ds, blkptr_t *bp);
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);

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

void dsl_dataset_block_born(dsl_dataset_t *ds, blkptr_t *bp, dmu_tx_t *tx);
void dsl_dataset_block_kill(dsl_dataset_t *ds, blkptr_t *bp, dmu_tx_t *tx);
int dsl_dataset_block_freeable(dsl_dataset_t *ds, uint64_t blk_birth,
    dmu_tx_t *tx);

void dsl_dataset_dirty(dsl_dataset_t *ds, dmu_tx_t *tx);
void dsl_dataset_stats(dsl_dataset_t *os, dmu_objset_stats_t *dds);
struct dsl_pool *dsl_dataset_pool(dsl_dataset_t *ds);

void dsl_dataset_create_root(struct dsl_pool *dp, uint64_t *ddobjp,
    dmu_tx_t *tx);

#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 */