module/zfs/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 2009 Sun Microsystems, Inc.  All rights reserved.
  23  * Use is subject to license terms.
  24  */
  25
  26 #ifndef _SYS_DSL_DIR_H
  27 #define _SYS_DSL_DIR_H
  28
  29 #include <sys/dmu.h>
  30 #include <sys/dsl_pool.h>
  31 #include <sys/dsl_synctask.h>
  32 #include <sys/refcount.h>
  33 #include <sys/zfs_context.h>
  34
  35 #ifdef  __cplusplus
  36 extern "C" {
  37 #endif
  38
  39 struct dsl_dataset;
  40
  41 typedef enum dd_used {
  42         DD_USED_HEAD,
  43         DD_USED_SNAP,
  44         DD_USED_CHILD,
  45         DD_USED_CHILD_RSRV,
  46         DD_USED_REFRSRV,
  47         DD_USED_NUM
  48 } dd_used_t;
  49
  50 #define DD_FLAG_USED_BREAKDOWN (1<<0)
  51
  52 typedef struct dsl_dir_phys {
  53         uint64_t dd_creation_time; /* not actually used */
  54         uint64_t dd_head_dataset_obj;
  55         uint64_t dd_parent_obj;
  56         uint64_t dd_origin_obj;
  57         uint64_t dd_child_dir_zapobj;
  58         /*
  59          * how much space our children are accounting for; for leaf
  60          * datasets, == physical space used by fs + snaps
  61          */
  62         uint64_t dd_used_bytes;
  63         uint64_t dd_compressed_bytes;
  64         uint64_t dd_uncompressed_bytes;
  65         /* Administrative quota setting */
  66         uint64_t dd_quota;
  67         /* Administrative reservation setting */
  68         uint64_t dd_reserved;
  69         uint64_t dd_props_zapobj;
  70         uint64_t dd_deleg_zapobj; /* dataset delegation permissions */
  71         uint64_t dd_flags;
  72         uint64_t dd_used_breakdown[DD_USED_NUM];
  73         uint64_t dd_pad[14]; /* pad out to 256 bytes for good measure */
  74 } dsl_dir_phys_t;
  75
  76 struct dsl_dir {
  77         /* These are immutable; no lock needed: */
  78         uint64_t dd_object;
  79         dsl_dir_phys_t *dd_phys;
  80         dmu_buf_t *dd_dbuf;
  81         dsl_pool_t *dd_pool;
  82
  83         /* protected by lock on pool's dp_dirty_dirs list */
  84         txg_node_t dd_dirty_link;
  85
  86         /* protected by dp_config_rwlock */
  87         dsl_dir_t *dd_parent;
  88
  89         /* Protected by dd_lock */
  90         kmutex_t dd_lock;
  91         list_t dd_prop_cbs; /* list of dsl_prop_cb_record_t's */
  92
  93         /* gross estimate of space used by in-flight tx's */
  94         uint64_t dd_tempreserved[TXG_SIZE];
  95         /* amount of space we expect to write; == amount of dirty data */
  96         int64_t dd_space_towrite[TXG_SIZE];
  97
  98         /* protected by dd_lock; keep at end of struct for better locality */
  99         char dd_myname[MAXNAMELEN];
 100 };
 101
 102 void dsl_dir_close(dsl_dir_t *dd, void *tag);
 103 int dsl_dir_open(const char *name, void *tag, dsl_dir_t **, const char **tail);
 104 int dsl_dir_open_spa(spa_t *spa, const char *name, void *tag, dsl_dir_t **,
 105     const char **tailp);
 106 int dsl_dir_open_obj(dsl_pool_t *dp, uint64_t ddobj,
 107     const char *tail, void *tag, dsl_dir_t **);
 108 void dsl_dir_name(dsl_dir_t *dd, char *buf);
 109 int dsl_dir_namelen(dsl_dir_t *dd);
 110 uint64_t dsl_dir_create_sync(dsl_pool_t *dp, dsl_dir_t *pds,
 111     const char *name, dmu_tx_t *tx);
 112 dsl_checkfunc_t dsl_dir_destroy_check;
 113 dsl_syncfunc_t dsl_dir_destroy_sync;
 114 void dsl_dir_stats(dsl_dir_t *dd, nvlist_t *nv);
 115 uint64_t dsl_dir_space_available(dsl_dir_t *dd,
 116     dsl_dir_t *ancestor, int64_t delta, int ondiskonly);
 117 void dsl_dir_dirty(dsl_dir_t *dd, dmu_tx_t *tx);
 118 void dsl_dir_sync(dsl_dir_t *dd, dmu_tx_t *tx);
 119 int dsl_dir_tempreserve_space(dsl_dir_t *dd, uint64_t mem,
 120     uint64_t asize, uint64_t fsize, uint64_t usize, void **tr_cookiep,
 121     dmu_tx_t *tx);
 122 void dsl_dir_tempreserve_clear(void *tr_cookie, dmu_tx_t *tx);
 123 void dsl_dir_willuse_space(dsl_dir_t *dd, int64_t space, dmu_tx_t *tx);
 124 void dsl_dir_diduse_space(dsl_dir_t *dd, dd_used_t type,
 125     int64_t used, int64_t compressed, int64_t uncompressed, dmu_tx_t *tx);
 126 void dsl_dir_transfer_space(dsl_dir_t *dd, int64_t delta,
 127     dd_used_t oldtype, dd_used_t newtype, dmu_tx_t *tx);
 128 int dsl_dir_set_quota(const char *ddname, uint64_t quota);
 129 int dsl_dir_set_reservation(const char *ddname, uint64_t reservation);
 130 int dsl_dir_rename(dsl_dir_t *dd, const char *newname);
 131 int dsl_dir_transfer_possible(dsl_dir_t *sdd, dsl_dir_t *tdd, uint64_t space);
 132 int dsl_dir_set_reservation_check(void *arg1, void *arg2, dmu_tx_t *tx);
 133 boolean_t dsl_dir_is_clone(dsl_dir_t *dd);
 134 void dsl_dir_new_refreservation(dsl_dir_t *dd, struct dsl_dataset *ds,
 135     uint64_t reservation, cred_t *cr, dmu_tx_t *tx);
 136
 137 /* internal reserved dir name */
 138 #define MOS_DIR_NAME "$MOS"
 139 #define ORIGIN_DIR_NAME "$ORIGIN"
 140
 141 #ifdef ZFS_DEBUG
 142 #define dprintf_dd(dd, fmt, ...) do { \
 143         if (zfs_flags & ZFS_DEBUG_DPRINTF) { \
 144         char *__ds_name = kmem_alloc(MAXNAMELEN + strlen(MOS_DIR_NAME) + 1, \
 145             KM_SLEEP); \
 146         dsl_dir_name(dd, __ds_name); \
 147         dprintf("dd=%s " fmt, __ds_name, __VA_ARGS__); \
 148         kmem_free(__ds_name, MAXNAMELEN + strlen(MOS_DIR_NAME) + 1); \
 149         } \
 150 _NOTE(CONSTCOND) } while (0)
 151 #else
 152 #define dprintf_dd(dd, fmt, ...)
 153 #endif
 154
 155 #ifdef  __cplusplus
 156 }
 157 #endif
 158
 159 #endif /* _SYS_DSL_DIR_H */