include/sys/dsl_dir.h

   1 /*
   2  * CDDL HEADER START
   3  *
   4  * The contents of this file are subject to the terms of the
   5  * Common Development and Distribution License (the "License").
   6  * You may not use this file except in compliance with the License.
   7  *
   8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
   9  * or http://www.opensolaris.org/os/licensing.
  10  * See the License for the specific language governing permissions
  11  * and limitations under the License.
  12  *
  13  * When distributing Covered Code, include this CDDL HEADER in each
  14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  15  * If applicable, add the following below this CDDL HEADER, with the
  16  * fields enclosed by brackets "[]" replaced with your own identifying
  17  * information: Portions Copyright [yyyy] [name of copyright owner]
  18  *
  19  * CDDL HEADER END
  20  */
  21 /*
  22  * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
  23  * Copyright (c) 2012, 2016 by Delphix. All rights reserved.
  24  * Copyright (c) 2014, Joyent, Inc. All rights reserved.
  25  * Copyright (c) 2014 Spectra Logic Corporation, All rights reserved.
  26  */
  27
  28 #ifndef _SYS_DSL_DIR_H
  29 #define _SYS_DSL_DIR_H
  30
  31 #include <sys/dmu.h>
  32 #include <sys/dsl_pool.h>
  33 #include <sys/dsl_synctask.h>
  34 #include <sys/refcount.h>
  35 #include <sys/zfs_context.h>
  36 #include <sys/dsl_crypt.h>
  37
  38 #ifdef  __cplusplus
  39 extern "C" {
  40 #endif
  41
  42 struct dsl_dataset;
  43
  44 /*
  45  * DD_FIELD_* are strings that are used in the "extensified" dsl_dir zap object.
  46  * They should be of the format <reverse-dns>:<field>.
  47  */
  48
  49 #define DD_FIELD_FILESYSTEM_COUNT       "com.joyent:filesystem_count"
  50 #define DD_FIELD_SNAPSHOT_COUNT         "com.joyent:snapshot_count"
  51 #define DD_FIELD_LAST_REMAP_TXG         "com.delphix:last_remap_txg"
  52 #define DD_FIELD_CRYPTO_KEY_OBJ         "com.datto:crypto_key_obj"
  53 #define DD_FIELD_LAST_REMAP_TXG         "com.delphix:last_remap_txg"
  54
  55 typedef enum dd_used {
  56         DD_USED_HEAD,
  57         DD_USED_SNAP,
  58         DD_USED_CHILD,
  59         DD_USED_CHILD_RSRV,
  60         DD_USED_REFRSRV,
  61         DD_USED_NUM
  62 } dd_used_t;
  63
  64 #define DD_FLAG_USED_BREAKDOWN (1<<0)
  65
  66 typedef struct dsl_dir_phys {
  67         uint64_t dd_creation_time; /* not actually used */
  68         uint64_t dd_head_dataset_obj;
  69         uint64_t dd_parent_obj;
  70         uint64_t dd_origin_obj;
  71         uint64_t dd_child_dir_zapobj;
  72         /*
  73          * how much space our children are accounting for; for leaf
  74          * datasets, == physical space used by fs + snaps
  75          */
  76         uint64_t dd_used_bytes;
  77         uint64_t dd_compressed_bytes;
  78         uint64_t dd_uncompressed_bytes;
  79         /* Administrative quota setting */
  80         uint64_t dd_quota;
  81         /* Administrative reservation setting */
  82         uint64_t dd_reserved;
  83         uint64_t dd_props_zapobj;
  84         uint64_t dd_deleg_zapobj; /* dataset delegation permissions */
  85         uint64_t dd_flags;
  86         uint64_t dd_used_breakdown[DD_USED_NUM];
  87         uint64_t dd_clones; /* dsl_dir objects */
  88         uint64_t dd_pad[13]; /* pad out to 256 bytes for good measure */
  89 } dsl_dir_phys_t;
  90
  91 struct dsl_dir {
  92         dmu_buf_user_t dd_dbu;
  93
  94         /* These are immutable; no lock needed: */
  95         uint64_t dd_object;
  96         uint64_t dd_crypto_obj;
  97         dsl_pool_t *dd_pool;
  98
  99         /* Stable until user eviction; no lock needed: */
 100         dmu_buf_t *dd_dbuf;
 101
 102         /* protected by lock on pool's dp_dirty_dirs list */
 103         txg_node_t dd_dirty_link;
 104
 105         /* protected by dp_config_rwlock */
 106         dsl_dir_t *dd_parent;
 107
 108         /* Protected by dd_lock */
 109         kmutex_t dd_lock;
 110         list_t dd_props; /* list of dsl_prop_record_t's */
 111         timestruc_t dd_snap_cmtime; /* last time snapshot namespace changed */
 112         uint64_t dd_origin_txg;
 113
 114         /* gross estimate of space used by in-flight tx's */
 115         uint64_t dd_tempreserved[TXG_SIZE];
 116         /* amount of space we expect to write; == amount of dirty data */
 117         int64_t dd_space_towrite[TXG_SIZE];
 118
 119         /* protected by dd_lock; keep at end of struct for better locality */
 120         char dd_myname[ZFS_MAX_DATASET_NAME_LEN];
 121 };
 122
 123 static inline dsl_dir_phys_t *
 124 dsl_dir_phys(dsl_dir_t *dd)
 125 {
 126         return (dd->dd_dbuf->db_data);
 127 }
 128
 129 void dsl_dir_rele(dsl_dir_t *dd, void *tag);
 130 void dsl_dir_async_rele(dsl_dir_t *dd, void *tag);
 131 int dsl_dir_hold(dsl_pool_t *dp, const char *name, void *tag,
 132     dsl_dir_t **, const char **tail);
 133 int dsl_dir_hold_obj(dsl_pool_t *dp, uint64_t ddobj,
 134     const char *tail, void *tag, dsl_dir_t **);
 135 void dsl_dir_name(dsl_dir_t *dd, char *buf);
 136 int dsl_dir_namelen(dsl_dir_t *dd);
 137 uint64_t dsl_dir_create_sync(dsl_pool_t *dp, dsl_dir_t *pds,
 138     const char *name, dmu_tx_t *tx);
 139
 140 uint64_t dsl_dir_get_used(dsl_dir_t *dd);
 141 uint64_t dsl_dir_get_quota(dsl_dir_t *dd);
 142 uint64_t dsl_dir_get_reservation(dsl_dir_t *dd);
 143 uint64_t dsl_dir_get_compressratio(dsl_dir_t *dd);
 144 uint64_t dsl_dir_get_logicalused(dsl_dir_t *dd);
 145 uint64_t dsl_dir_get_usedsnap(dsl_dir_t *dd);
 146 uint64_t dsl_dir_get_usedds(dsl_dir_t *dd);
 147 uint64_t dsl_dir_get_usedrefreserv(dsl_dir_t *dd);
 148 uint64_t dsl_dir_get_usedchild(dsl_dir_t *dd);
 149 void dsl_dir_get_origin(dsl_dir_t *dd, char *buf);
 150 int dsl_dir_get_filesystem_count(dsl_dir_t *dd, uint64_t *count);
 151 int dsl_dir_get_snapshot_count(dsl_dir_t *dd, uint64_t *count);
 152
 153 void dsl_dir_stats(dsl_dir_t *dd, nvlist_t *nv);
 154 uint64_t dsl_dir_space_available(dsl_dir_t *dd,
 155     dsl_dir_t *ancestor, int64_t delta, int ondiskonly);
 156 void dsl_dir_dirty(dsl_dir_t *dd, dmu_tx_t *tx);
 157 int dsl_dir_get_remaptxg(dsl_dir_t *dd, uint64_t *count);
 158 void dsl_dir_sync(dsl_dir_t *dd, dmu_tx_t *tx);
 159 int dsl_dir_tempreserve_space(dsl_dir_t *dd, uint64_t mem,
 160     uint64_t asize, boolean_t netfree, void **tr_cookiep, dmu_tx_t *tx);
 161 void dsl_dir_tempreserve_clear(void *tr_cookie, dmu_tx_t *tx);
 162 void dsl_dir_willuse_space(dsl_dir_t *dd, int64_t space, dmu_tx_t *tx);
 163 void dsl_dir_diduse_space(dsl_dir_t *dd, dd_used_t type,
 164     int64_t used, int64_t compressed, int64_t uncompressed, dmu_tx_t *tx);
 165 void dsl_dir_transfer_space(dsl_dir_t *dd, int64_t delta,
 166     dd_used_t oldtype, dd_used_t newtype, dmu_tx_t *tx);
 167 int dsl_dir_set_quota(const char *ddname, zprop_source_t source,
 168     uint64_t quota);
 169 int dsl_dir_set_reservation(const char *ddname, zprop_source_t source,
 170     uint64_t reservation);
 171 int dsl_dir_activate_fs_ss_limit(const char *);
 172 int dsl_fs_ss_limit_check(dsl_dir_t *, uint64_t, zfs_prop_t, dsl_dir_t *,
 173     cred_t *);
 174 void dsl_fs_ss_count_adjust(dsl_dir_t *, int64_t, const char *, dmu_tx_t *);
 175 int dsl_dir_update_last_remap_txg(dsl_dir_t *, uint64_t);
 176 int dsl_dir_rename(const char *oldname, const char *newname);
 177 int dsl_dir_transfer_possible(dsl_dir_t *sdd, dsl_dir_t *tdd,
 178     uint64_t fs_cnt, uint64_t ss_cnt, uint64_t space, cred_t *);
 179 boolean_t dsl_dir_is_clone(dsl_dir_t *dd);
 180 void dsl_dir_new_refreservation(dsl_dir_t *dd, struct dsl_dataset *ds,
 181     uint64_t reservation, cred_t *cr, dmu_tx_t *tx);
 182 void dsl_dir_snap_cmtime_update(dsl_dir_t *dd);
 183 timestruc_t dsl_dir_snap_cmtime(dsl_dir_t *dd);
 184 void dsl_dir_set_reservation_sync_impl(dsl_dir_t *dd, uint64_t value,
 185     dmu_tx_t *tx);
 186 void dsl_dir_zapify(dsl_dir_t *dd, dmu_tx_t *tx);
 187 boolean_t dsl_dir_is_zapified(dsl_dir_t *dd);
 188
 189 /* internal reserved dir name */
 190 #define MOS_DIR_NAME "$MOS"
 191 #define ORIGIN_DIR_NAME "$ORIGIN"
 192 #define FREE_DIR_NAME "$FREE"
 193 #define LEAK_DIR_NAME "$LEAK"
 194
 195 #ifdef ZFS_DEBUG
 196 #define dprintf_dd(dd, fmt, ...) do { \
 197         if (zfs_flags & ZFS_DEBUG_DPRINTF) { \
 198         char *__ds_name = kmem_alloc(ZFS_MAX_DATASET_NAME_LEN, KM_SLEEP); \
 199         dsl_dir_name(dd, __ds_name); \
 200         dprintf("dd=%s " fmt, __ds_name, __VA_ARGS__); \
 201         kmem_free(__ds_name, ZFS_MAX_DATASET_NAME_LEN); \
 202         } \
 203 _NOTE(CONSTCOND) } while (0)
 204 #else
 205 #define dprintf_dd(dd, fmt, ...)
 206 #endif
 207
 208 #ifdef  __cplusplus
 209 }
 210 #endif
 211
 212 #endif /* _SYS_DSL_DIR_H */