fa9e4066f08beec538e775443c5be79dd423fcabahrens/*
fa9e4066f08beec538e775443c5be79dd423fcabahrens * CDDL HEADER START
fa9e4066f08beec538e775443c5be79dd423fcabahrens *
fa9e4066f08beec538e775443c5be79dd423fcabahrens * The contents of this file are subject to the terms of the
ea8dc4b6d2251b437950c0056bc626b311c73c27eschrock * Common Development and Distribution License (the "License").
ea8dc4b6d2251b437950c0056bc626b311c73c27eschrock * You may not use this file except in compliance with the License.
fa9e4066f08beec538e775443c5be79dd423fcabahrens *
fa9e4066f08beec538e775443c5be79dd423fcabahrens * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
fa9e4066f08beec538e775443c5be79dd423fcabahrens * or http://www.opensolaris.org/os/licensing.
fa9e4066f08beec538e775443c5be79dd423fcabahrens * See the License for the specific language governing permissions
fa9e4066f08beec538e775443c5be79dd423fcabahrens * and limitations under the License.
fa9e4066f08beec538e775443c5be79dd423fcabahrens *
fa9e4066f08beec538e775443c5be79dd423fcabahrens * When distributing Covered Code, include this CDDL HEADER in each
fa9e4066f08beec538e775443c5be79dd423fcabahrens * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
fa9e4066f08beec538e775443c5be79dd423fcabahrens * If applicable, add the following below this CDDL HEADER, with the
fa9e4066f08beec538e775443c5be79dd423fcabahrens * fields enclosed by brackets "[]" replaced with your own identifying
fa9e4066f08beec538e775443c5be79dd423fcabahrens * information: Portions Copyright [yyyy] [name of copyright owner]
fa9e4066f08beec538e775443c5be79dd423fcabahrens *
fa9e4066f08beec538e775443c5be79dd423fcabahrens * CDDL HEADER END
fa9e4066f08beec538e775443c5be79dd423fcabahrens */
fa9e4066f08beec538e775443c5be79dd423fcabahrens/*
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
69962b5647e4a8b9b14998733b765925381b727eMatthew Ahrens * Copyright (c) 2013 by Delphix. All rights reserved.
a2afb611b30628fb74ad9eade4ae465f9031e262Jerry Jelinek * Copyright (c) 2014, Joyent, Inc. All rights reserved.
bc9014e6a81272073b9854d9f65dd59e18d18c35Justin Gibbs * Copyright (c) 2014 Spectra Logic Corporation, All rights reserved.
fa9e4066f08beec538e775443c5be79dd423fcabahrens */
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens#ifndef _SYS_DSL_DIR_H
fa9e4066f08beec538e775443c5be79dd423fcabahrens#define _SYS_DSL_DIR_H
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens#include <sys/dmu.h>
fa9e4066f08beec538e775443c5be79dd423fcabahrens#include <sys/dsl_pool.h>
1d452cf5123cb6ac0a013a4dbd4dcceeb0da314dahrens#include <sys/dsl_synctask.h>
fa9e4066f08beec538e775443c5be79dd423fcabahrens#include <sys/refcount.h>
fa9e4066f08beec538e775443c5be79dd423fcabahrens#include <sys/zfs_context.h>
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens#ifdef __cplusplus
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern "C" {
fa9e4066f08beec538e775443c5be79dd423fcabahrens#endif
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrensstruct dsl_dataset;
fa9e4066f08beec538e775443c5be79dd423fcabahrens
a2afb611b30628fb74ad9eade4ae465f9031e262Jerry Jelinek/*
a2afb611b30628fb74ad9eade4ae465f9031e262Jerry Jelinek * DD_FIELD_* are strings that are used in the "extensified" dsl_dir zap object.
a2afb611b30628fb74ad9eade4ae465f9031e262Jerry Jelinek * They should be of the format <reverse-dns>:<field>.
a2afb611b30628fb74ad9eade4ae465f9031e262Jerry Jelinek */
a2afb611b30628fb74ad9eade4ae465f9031e262Jerry Jelinek
a2afb611b30628fb74ad9eade4ae465f9031e262Jerry Jelinek#define DD_FIELD_FILESYSTEM_COUNT "com.joyent:filesystem_count"
a2afb611b30628fb74ad9eade4ae465f9031e262Jerry Jelinek#define DD_FIELD_SNAPSHOT_COUNT "com.joyent:snapshot_count"
a2afb611b30628fb74ad9eade4ae465f9031e262Jerry Jelinek
74e7dc986c89efca1f2e4451c7a572e05e4a6e4fMatthew Ahrenstypedef enum dd_used {
74e7dc986c89efca1f2e4451c7a572e05e4a6e4fMatthew Ahrens DD_USED_HEAD,
74e7dc986c89efca1f2e4451c7a572e05e4a6e4fMatthew Ahrens DD_USED_SNAP,
74e7dc986c89efca1f2e4451c7a572e05e4a6e4fMatthew Ahrens DD_USED_CHILD,
74e7dc986c89efca1f2e4451c7a572e05e4a6e4fMatthew Ahrens DD_USED_CHILD_RSRV,
74e7dc986c89efca1f2e4451c7a572e05e4a6e4fMatthew Ahrens DD_USED_REFRSRV,
74e7dc986c89efca1f2e4451c7a572e05e4a6e4fMatthew Ahrens DD_USED_NUM
74e7dc986c89efca1f2e4451c7a572e05e4a6e4fMatthew Ahrens} dd_used_t;
74e7dc986c89efca1f2e4451c7a572e05e4a6e4fMatthew Ahrens
74e7dc986c89efca1f2e4451c7a572e05e4a6e4fMatthew Ahrens#define DD_FLAG_USED_BREAKDOWN (1<<0)
74e7dc986c89efca1f2e4451c7a572e05e4a6e4fMatthew Ahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrenstypedef struct dsl_dir_phys {
a2eea2e101e6a163a537dcc6d4e3c4da2a0ea5b2ahrens uint64_t dd_creation_time; /* not actually used */
fa9e4066f08beec538e775443c5be79dd423fcabahrens uint64_t dd_head_dataset_obj;
fa9e4066f08beec538e775443c5be79dd423fcabahrens uint64_t dd_parent_obj;
3cb34c601f3ef3016f638574f5982e80c3735c71ahrens uint64_t dd_origin_obj;
fa9e4066f08beec538e775443c5be79dd423fcabahrens uint64_t dd_child_dir_zapobj;
fa9e4066f08beec538e775443c5be79dd423fcabahrens /*
fa9e4066f08beec538e775443c5be79dd423fcabahrens * how much space our children are accounting for; for leaf
fa9e4066f08beec538e775443c5be79dd423fcabahrens * datasets, == physical space used by fs + snaps
fa9e4066f08beec538e775443c5be79dd423fcabahrens */
fa9e4066f08beec538e775443c5be79dd423fcabahrens uint64_t dd_used_bytes;
fa9e4066f08beec538e775443c5be79dd423fcabahrens uint64_t dd_compressed_bytes;
fa9e4066f08beec538e775443c5be79dd423fcabahrens uint64_t dd_uncompressed_bytes;
fa9e4066f08beec538e775443c5be79dd423fcabahrens /* Administrative quota setting */
fa9e4066f08beec538e775443c5be79dd423fcabahrens uint64_t dd_quota;
fa9e4066f08beec538e775443c5be79dd423fcabahrens /* Administrative reservation setting */
fa9e4066f08beec538e775443c5be79dd423fcabahrens uint64_t dd_reserved;
fa9e4066f08beec538e775443c5be79dd423fcabahrens uint64_t dd_props_zapobj;
ecd6cf800b63704be73fb264c3f5b6e0dafc068dmarks uint64_t dd_deleg_zapobj; /* dataset delegation permissions */
74e7dc986c89efca1f2e4451c7a572e05e4a6e4fMatthew Ahrens uint64_t dd_flags;
74e7dc986c89efca1f2e4451c7a572e05e4a6e4fMatthew Ahrens uint64_t dd_used_breakdown[DD_USED_NUM];
cde58dbc6a23d4d38db7c8866312be83221c765fMatthew Ahrens uint64_t dd_clones; /* dsl_dir objects */
cde58dbc6a23d4d38db7c8866312be83221c765fMatthew Ahrens uint64_t dd_pad[13]; /* pad out to 256 bytes for good measure */
fa9e4066f08beec538e775443c5be79dd423fcabahrens} dsl_dir_phys_t;
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrensstruct dsl_dir {
bc9014e6a81272073b9854d9f65dd59e18d18c35Justin Gibbs dmu_buf_user_t dd_dbu;
bc9014e6a81272073b9854d9f65dd59e18d18c35Justin Gibbs
fa9e4066f08beec538e775443c5be79dd423fcabahrens /* These are immutable; no lock needed: */
fa9e4066f08beec538e775443c5be79dd423fcabahrens uint64_t dd_object;
fa9e4066f08beec538e775443c5be79dd423fcabahrens dsl_pool_t *dd_pool;
fa9e4066f08beec538e775443c5be79dd423fcabahrens
c1379625401dfbe1c39b79136dd384a571d47fdeJustin T. Gibbs /* Stable until user eviction; no lock needed: */
c1379625401dfbe1c39b79136dd384a571d47fdeJustin T. Gibbs dmu_buf_t *dd_dbuf;
c1379625401dfbe1c39b79136dd384a571d47fdeJustin T. Gibbs
fa9e4066f08beec538e775443c5be79dd423fcabahrens /* protected by lock on pool's dp_dirty_dirs list */
fa9e4066f08beec538e775443c5be79dd423fcabahrens txg_node_t dd_dirty_link;
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens /* protected by dp_config_rwlock */
fa9e4066f08beec538e775443c5be79dd423fcabahrens dsl_dir_t *dd_parent;
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens /* Protected by dd_lock */
fa9e4066f08beec538e775443c5be79dd423fcabahrens kmutex_t dd_lock;
03bad06fbb261fd4a7151a70dfeff2f5041cce1fJustin Gibbs list_t dd_props; /* list of dsl_prop_record_t's */
71eb05381846ad14a2087631474e832d0f316654Chris Kirby timestruc_t dd_snap_cmtime; /* last time snapshot namespace changed */
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling uint64_t dd_origin_txg;
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens /* gross estimate of space used by in-flight tx's */
fa9e4066f08beec538e775443c5be79dd423fcabahrens uint64_t dd_tempreserved[TXG_SIZE];
fa9e4066f08beec538e775443c5be79dd423fcabahrens /* amount of space we expect to write; == amount of dirty data */
fa9e4066f08beec538e775443c5be79dd423fcabahrens int64_t dd_space_towrite[TXG_SIZE];
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens /* protected by dd_lock; keep at end of struct for better locality */
9adfa60d484ce2435f5af77cc99dcd4e692b6660Matthew Ahrens char dd_myname[ZFS_MAX_DATASET_NAME_LEN];
fa9e4066f08beec538e775443c5be79dd423fcabahrens};
fa9e4066f08beec538e775443c5be79dd423fcabahrens
c1379625401dfbe1c39b79136dd384a571d47fdeJustin T. Gibbsinline dsl_dir_phys_t *
c1379625401dfbe1c39b79136dd384a571d47fdeJustin T. Gibbsdsl_dir_phys(dsl_dir_t *dd)
c1379625401dfbe1c39b79136dd384a571d47fdeJustin T. Gibbs{
c1379625401dfbe1c39b79136dd384a571d47fdeJustin T. Gibbs return (dd->dd_dbuf->db_data);
c1379625401dfbe1c39b79136dd384a571d47fdeJustin T. Gibbs}
c1379625401dfbe1c39b79136dd384a571d47fdeJustin T. Gibbs
3b2aab18808792cbd248a12f1edf139b89833c13Matthew Ahrensvoid dsl_dir_rele(dsl_dir_t *dd, void *tag);
bc9014e6a81272073b9854d9f65dd59e18d18c35Justin Gibbsvoid dsl_dir_async_rele(dsl_dir_t *dd, void *tag);
3b2aab18808792cbd248a12f1edf139b89833c13Matthew Ahrensint dsl_dir_hold(dsl_pool_t *dp, const char *name, void *tag,
3b2aab18808792cbd248a12f1edf139b89833c13Matthew Ahrens dsl_dir_t **, const char **tail);
3b2aab18808792cbd248a12f1edf139b89833c13Matthew Ahrensint dsl_dir_hold_obj(dsl_pool_t *dp, uint64_t ddobj,
ea8dc4b6d2251b437950c0056bc626b311c73c27eschrock const char *tail, void *tag, dsl_dir_t **);
fa9e4066f08beec538e775443c5be79dd423fcabahrensvoid dsl_dir_name(dsl_dir_t *dd, char *buf);
b7661ccca92e6bf5160f4d5d2601efaeaa1f5161mmusanteint dsl_dir_namelen(dsl_dir_t *dd);
088f389458728c464569a5506b58070254fa4f7dahrensuint64_t dsl_dir_create_sync(dsl_pool_t *dp, dsl_dir_t *pds,
088f389458728c464569a5506b58070254fa4f7dahrens const char *name, dmu_tx_t *tx);
a2eea2e101e6a163a537dcc6d4e3c4da2a0ea5b2ahrensvoid dsl_dir_stats(dsl_dir_t *dd, nvlist_t *nv);
a2eea2e101e6a163a537dcc6d4e3c4da2a0ea5b2ahrensuint64_t dsl_dir_space_available(dsl_dir_t *dd,
a2eea2e101e6a163a537dcc6d4e3c4da2a0ea5b2ahrens dsl_dir_t *ancestor, int64_t delta, int ondiskonly);
fa9e4066f08beec538e775443c5be79dd423fcabahrensvoid dsl_dir_dirty(dsl_dir_t *dd, dmu_tx_t *tx);
fa9e4066f08beec538e775443c5be79dd423fcabahrensvoid dsl_dir_sync(dsl_dir_t *dd, dmu_tx_t *tx);
fa9e4066f08beec538e775443c5be79dd423fcabahrensint dsl_dir_tempreserve_space(dsl_dir_t *dd, uint64_t mem,
a9799022bd90b13722204e80112efaa5bf573099ck uint64_t asize, uint64_t fsize, uint64_t usize, void **tr_cookiep,
a9799022bd90b13722204e80112efaa5bf573099ck dmu_tx_t *tx);
fa9e4066f08beec538e775443c5be79dd423fcabahrensvoid dsl_dir_tempreserve_clear(void *tr_cookie, dmu_tx_t *tx);
fa9e4066f08beec538e775443c5be79dd423fcabahrensvoid dsl_dir_willuse_space(dsl_dir_t *dd, int64_t space, dmu_tx_t *tx);
74e7dc986c89efca1f2e4451c7a572e05e4a6e4fMatthew Ahrensvoid dsl_dir_diduse_space(dsl_dir_t *dd, dd_used_t type,
fa9e4066f08beec538e775443c5be79dd423fcabahrens int64_t used, int64_t compressed, int64_t uncompressed, dmu_tx_t *tx);
74e7dc986c89efca1f2e4451c7a572e05e4a6e4fMatthew Ahrensvoid dsl_dir_transfer_space(dsl_dir_t *dd, int64_t delta,
74e7dc986c89efca1f2e4451c7a572e05e4a6e4fMatthew Ahrens dd_used_t oldtype, dd_used_t newtype, dmu_tx_t *tx);
92241e0b80813d0b83c08e730a29b9d1831794fcTom Ericksonint dsl_dir_set_quota(const char *ddname, zprop_source_t source,
92241e0b80813d0b83c08e730a29b9d1831794fcTom Erickson uint64_t quota);
92241e0b80813d0b83c08e730a29b9d1831794fcTom Ericksonint dsl_dir_set_reservation(const char *ddname, zprop_source_t source,
92241e0b80813d0b83c08e730a29b9d1831794fcTom Erickson uint64_t reservation);
a2afb611b30628fb74ad9eade4ae465f9031e262Jerry Jelinekint dsl_dir_activate_fs_ss_limit(const char *);
a2afb611b30628fb74ad9eade4ae465f9031e262Jerry Jelinekint dsl_fs_ss_limit_check(dsl_dir_t *, uint64_t, zfs_prop_t, dsl_dir_t *,
a2afb611b30628fb74ad9eade4ae465f9031e262Jerry Jelinek cred_t *);
a2afb611b30628fb74ad9eade4ae465f9031e262Jerry Jelinekvoid dsl_fs_ss_count_adjust(dsl_dir_t *, int64_t, const char *, dmu_tx_t *);
3b2aab18808792cbd248a12f1edf139b89833c13Matthew Ahrensint dsl_dir_rename(const char *oldname, const char *newname);
a2afb611b30628fb74ad9eade4ae465f9031e262Jerry Jelinekint dsl_dir_transfer_possible(dsl_dir_t *sdd, dsl_dir_t *tdd,
a2afb611b30628fb74ad9eade4ae465f9031e262Jerry Jelinek uint64_t fs_cnt, uint64_t ss_cnt, uint64_t space, cred_t *);
088f389458728c464569a5506b58070254fa4f7dahrensboolean_t dsl_dir_is_clone(dsl_dir_t *dd);
0b383af75dbdbe45ccf120c8dcf38acb3b24ae03Chris Kirbyvoid dsl_dir_new_refreservation(dsl_dir_t *dd, struct dsl_dataset *ds,
0b383af75dbdbe45ccf120c8dcf38acb3b24ae03Chris Kirby uint64_t reservation, cred_t *cr, dmu_tx_t *tx);
71eb05381846ad14a2087631474e832d0f316654Chris Kirbyvoid dsl_dir_snap_cmtime_update(dsl_dir_t *dd);
71eb05381846ad14a2087631474e832d0f316654Chris Kirbytimestruc_t dsl_dir_snap_cmtime(dsl_dir_t *dd);
3b2aab18808792cbd248a12f1edf139b89833c13Matthew Ahrensvoid dsl_dir_set_reservation_sync_impl(dsl_dir_t *dd, uint64_t value,
3b2aab18808792cbd248a12f1edf139b89833c13Matthew Ahrens dmu_tx_t *tx);
a2afb611b30628fb74ad9eade4ae465f9031e262Jerry Jelinekvoid dsl_dir_zapify(dsl_dir_t *dd, dmu_tx_t *tx);
a2afb611b30628fb74ad9eade4ae465f9031e262Jerry Jelinekboolean_t dsl_dir_is_zapified(dsl_dir_t *dd);
fa9e4066f08beec538e775443c5be79dd423fcabahrens
15f66a7f2650f57ff45e30a01a5324ad3e96aaa8ek/* internal reserved dir name */
15f66a7f2650f57ff45e30a01a5324ad3e96aaa8ek#define MOS_DIR_NAME "$MOS"
088f389458728c464569a5506b58070254fa4f7dahrens#define ORIGIN_DIR_NAME "$ORIGIN"
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling#define XLATION_DIR_NAME "$XLATION"
cde58dbc6a23d4d38db7c8866312be83221c765fMatthew Ahrens#define FREE_DIR_NAME "$FREE"
7fd05ac4dec0c343d2f68f310d3718b715ecfbafMatthew Ahrens#define LEAK_DIR_NAME "$LEAK"
15f66a7f2650f57ff45e30a01a5324ad3e96aaa8ek
fa9e4066f08beec538e775443c5be79dd423fcabahrens#ifdef ZFS_DEBUG
fa9e4066f08beec538e775443c5be79dd423fcabahrens#define dprintf_dd(dd, fmt, ...) do { \
fa9e4066f08beec538e775443c5be79dd423fcabahrens if (zfs_flags & ZFS_DEBUG_DPRINTF) { \
9adfa60d484ce2435f5af77cc99dcd4e692b6660Matthew Ahrens char *__ds_name = kmem_alloc(ZFS_MAX_DATASET_NAME_LEN, KM_SLEEP); \
fa9e4066f08beec538e775443c5be79dd423fcabahrens dsl_dir_name(dd, __ds_name); \
fa9e4066f08beec538e775443c5be79dd423fcabahrens dprintf("dd=%s " fmt, __ds_name, __VA_ARGS__); \
9adfa60d484ce2435f5af77cc99dcd4e692b6660Matthew Ahrens kmem_free(__ds_name, ZFS_MAX_DATASET_NAME_LEN); \
fa9e4066f08beec538e775443c5be79dd423fcabahrens } \
fa9e4066f08beec538e775443c5be79dd423fcabahrens_NOTE(CONSTCOND) } while (0)
fa9e4066f08beec538e775443c5be79dd423fcabahrens#else
fa9e4066f08beec538e775443c5be79dd423fcabahrens#define dprintf_dd(dd, fmt, ...)
fa9e4066f08beec538e775443c5be79dd423fcabahrens#endif
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens#ifdef __cplusplus
fa9e4066f08beec538e775443c5be79dd423fcabahrens}
fa9e4066f08beec538e775443c5be79dd423fcabahrens#endif
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens#endif /* _SYS_DSL_DIR_H */