include/sys/dmu_objset.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, 2017 by Delphix. All rights reserved.
  24  * Copyright (c) 2013 by Saso Kiselkov. All rights reserved.
  25  * Copyright (c) 2014 Spectra Logic Corporation, All rights reserved.
  26  */
  27
  28 /* Portions Copyright 2010 Robert Milkowski */
  29
  30 #ifndef _SYS_DMU_OBJSET_H
  31 #define _SYS_DMU_OBJSET_H
  32
  33 #include <sys/spa.h>
  34 #include <sys/arc.h>
  35 #include <sys/txg.h>
  36 #include <sys/zfs_context.h>
  37 #include <sys/dnode.h>
  38 #include <sys/zio.h>
  39 #include <sys/zil.h>
  40 #include <sys/sa.h>
  41
  42 #ifdef  __cplusplus
  43 extern "C" {
  44 #endif
  45
  46 extern krwlock_t os_lock;
  47
  48 struct dsl_pool;
  49 struct dsl_dataset;
  50 struct dmu_tx;
  51
  52 #define OBJSET_PHYS_SIZE_V1     1024
  53 #define OBJSET_PHYS_SIZE_V2     2048
  54 #define OBJSET_PHYS_SIZE_V3     4096
  55
  56 #define OBJSET_BUF_HAS_USERUSED(buf) \
  57         (arc_buf_size(buf) >= OBJSET_PHYS_SIZE_V2)
  58 #define OBJSET_BUF_HAS_PROJECTUSED(buf) \
  59         (arc_buf_size(buf) >= OBJSET_PHYS_SIZE_V3)
  60
  61 #define OBJSET_FLAG_USERACCOUNTING_COMPLETE     (1ULL << 0)
  62 #define OBJSET_FLAG_USEROBJACCOUNTING_COMPLETE  (1ULL << 1)
  63 #define OBJSET_FLAG_PROJECTQUOTA_COMPLETE       (1ULL << 2)
  64
  65 /* all flags are currently non-portable */
  66 #define OBJSET_CRYPT_PORTABLE_FLAGS_MASK        (0)
  67
  68 typedef struct objset_phys {
  69         dnode_phys_t os_meta_dnode;
  70         zil_header_t os_zil_header;
  71         uint64_t os_type;
  72         uint64_t os_flags;
  73         uint8_t os_portable_mac[ZIO_OBJSET_MAC_LEN];
  74         uint8_t os_local_mac[ZIO_OBJSET_MAC_LEN];
  75         char os_pad0[OBJSET_PHYS_SIZE_V2 - sizeof (dnode_phys_t)*3 -
  76             sizeof (zil_header_t) - sizeof (uint64_t)*2 -
  77             2*ZIO_OBJSET_MAC_LEN];
  78         dnode_phys_t os_userused_dnode;
  79         dnode_phys_t os_groupused_dnode;
  80         dnode_phys_t os_projectused_dnode;
  81         char os_pad1[OBJSET_PHYS_SIZE_V3 - OBJSET_PHYS_SIZE_V2 -
  82             sizeof (dnode_phys_t)];
  83 } objset_phys_t;
  84
  85 typedef int (*dmu_objset_upgrade_cb_t)(objset_t *);
  86
  87 struct objset {
  88         /* Immutable: */
  89         struct dsl_dataset *os_dsl_dataset;
  90         spa_t *os_spa;
  91         arc_buf_t *os_phys_buf;
  92         objset_phys_t *os_phys;
  93         boolean_t os_encrypted;
  94
  95         /*
  96          * The following "special" dnodes have no parent, are exempt
  97          * from dnode_move(), and are not recorded in os_dnodes, but they
  98          * root their descendents in this objset using handles anyway, so
  99          * that all access to dnodes from dbufs consistently uses handles.
 100          */
 101         dnode_handle_t os_meta_dnode;
 102         dnode_handle_t os_userused_dnode;
 103         dnode_handle_t os_groupused_dnode;
 104         dnode_handle_t os_projectused_dnode;
 105         zilog_t *os_zil;
 106
 107         list_node_t os_evicting_node;
 108
 109         /* can change, under dsl_dir's locks: */
 110         uint64_t os_dnodesize; /* default dnode size for new objects */
 111         enum zio_checksum os_checksum;
 112         enum zio_compress os_compress;
 113         uint8_t os_copies;
 114         enum zio_checksum os_dedup_checksum;
 115         boolean_t os_dedup_verify;
 116         zfs_logbias_op_t os_logbias;
 117         zfs_cache_type_t os_primary_cache;
 118         zfs_cache_type_t os_secondary_cache;
 119         zfs_sync_type_t os_sync;
 120         zfs_redundant_metadata_type_t os_redundant_metadata;
 121         int os_recordsize;
 122
 123         /*
 124          * Pointer is constant; the blkptr it points to is protected by
 125          * os_dsl_dataset->ds_bp_rwlock
 126          */
 127         blkptr_t *os_rootbp;
 128
 129         /* no lock needed: */
 130         struct dmu_tx *os_synctx; /* XXX sketchy */
 131         zil_header_t os_zil_header;
 132         multilist_t *os_synced_dnodes;
 133         uint64_t os_flags;
 134         uint64_t os_freed_dnodes;
 135         boolean_t os_rescan_dnodes;
 136
 137         /* os_phys_buf should be written raw next txg */
 138         boolean_t os_next_write_raw[TXG_SIZE];
 139
 140         /* Protected by os_obj_lock */
 141         kmutex_t os_obj_lock;
 142         uint64_t os_obj_next_chunk;
 143
 144         /* Per-CPU next object to allocate, protected by atomic ops. */
 145         uint64_t *os_obj_next_percpu;
 146         int os_obj_next_percpu_len;
 147
 148         /* Protected by os_lock */
 149         kmutex_t os_lock;
 150         multilist_t *os_dirty_dnodes[TXG_SIZE];
 151         list_t os_dnodes;
 152         list_t os_downgraded_dbufs;
 153
 154         /* Protects changes to DMU_{USER,GROUP,PROJECT}USED_OBJECT */
 155         kmutex_t os_userused_lock;
 156
 157         /* stuff we store for the user */
 158         kmutex_t os_user_ptr_lock;
 159         void *os_user_ptr;
 160         sa_os_t *os_sa;
 161
 162         /* kernel thread to upgrade this dataset */
 163         kmutex_t os_upgrade_lock;
 164         taskqid_t os_upgrade_id;
 165         dmu_objset_upgrade_cb_t os_upgrade_cb;
 166         boolean_t os_upgrade_exit;
 167         int os_upgrade_status;
 168 };
 169
 170 #define DMU_META_OBJSET         0
 171 #define DMU_META_DNODE_OBJECT   0
 172 #define DMU_OBJECT_IS_SPECIAL(obj) ((int64_t)(obj) <= 0)
 173 #define DMU_META_DNODE(os)      ((os)->os_meta_dnode.dnh_dnode)
 174 #define DMU_USERUSED_DNODE(os)  ((os)->os_userused_dnode.dnh_dnode)
 175 #define DMU_GROUPUSED_DNODE(os) ((os)->os_groupused_dnode.dnh_dnode)
 176 #define DMU_PROJECTUSED_DNODE(os) ((os)->os_projectused_dnode.dnh_dnode)
 177
 178 #define DMU_OS_IS_L2CACHEABLE(os)                               \
 179         ((os)->os_secondary_cache == ZFS_CACHE_ALL ||           \
 180         (os)->os_secondary_cache == ZFS_CACHE_METADATA)
 181
 182 /* called from zpl */
 183 int dmu_objset_hold(const char *name, void *tag, objset_t **osp);
 184 int dmu_objset_hold_flags(const char *name, boolean_t decrypt, void *tag,
 185     objset_t **osp);
 186 int dmu_objset_own(const char *name, dmu_objset_type_t type,
 187     boolean_t readonly, boolean_t decrypt, void *tag, objset_t **osp);
 188 int dmu_objset_own_obj(struct dsl_pool *dp, uint64_t obj,
 189     dmu_objset_type_t type, boolean_t readonly, boolean_t decrypt,
 190     void *tag, objset_t **osp);
 191 void dmu_objset_refresh_ownership(objset_t *os, boolean_t key_needed,
 192     void *tag);
 193 void dmu_objset_rele(objset_t *os, void *tag);
 194 void dmu_objset_rele_flags(objset_t *os, boolean_t decrypt, void *tag);
 195 void dmu_objset_disown(objset_t *os, boolean_t decrypt, void *tag);
 196 int dmu_objset_from_ds(struct dsl_dataset *ds, objset_t **osp);
 197
 198 void dmu_objset_stats(objset_t *os, nvlist_t *nv);
 199 void dmu_objset_fast_stat(objset_t *os, dmu_objset_stats_t *stat);
 200 void dmu_objset_space(objset_t *os, uint64_t *refdbytesp, uint64_t *availbytesp,
 201     uint64_t *usedobjsp, uint64_t *availobjsp);
 202 uint64_t dmu_objset_fsid_guid(objset_t *os);
 203 int dmu_objset_find_dp(struct dsl_pool *dp, uint64_t ddobj,
 204     int func(struct dsl_pool *, struct dsl_dataset *, void *),
 205     void *arg, int flags);
 206 void dmu_objset_evict_dbufs(objset_t *os);
 207 timestruc_t dmu_objset_snap_cmtime(objset_t *os);
 208
 209 /* called from dsl */
 210 void dmu_objset_sync(objset_t *os, zio_t *zio, dmu_tx_t *tx);
 211 boolean_t dmu_objset_is_dirty(objset_t *os, uint64_t txg);
 212 objset_t *dmu_objset_create_impl_dnstats(spa_t *spa, struct dsl_dataset *ds,
 213     blkptr_t *bp, dmu_objset_type_t type, int levels, int blksz, int ibs,
 214     dmu_tx_t *tx);
 215 objset_t *dmu_objset_create_impl(spa_t *spa, struct dsl_dataset *ds,
 216     blkptr_t *bp, dmu_objset_type_t type, dmu_tx_t *tx);
 217 int dmu_objset_open_impl(spa_t *spa, struct dsl_dataset *ds, blkptr_t *bp,
 218     objset_t **osp);
 219 void dmu_objset_evict(objset_t *os);
 220 void dmu_objset_do_userquota_updates(objset_t *os, dmu_tx_t *tx);
 221 void dmu_objset_userquota_get_ids(dnode_t *dn, boolean_t before, dmu_tx_t *tx);
 222 boolean_t dmu_objset_userused_enabled(objset_t *os);
 223 int dmu_objset_userspace_upgrade(objset_t *os);
 224 boolean_t dmu_objset_userspace_present(objset_t *os);
 225 boolean_t dmu_objset_userobjused_enabled(objset_t *os);
 226 boolean_t dmu_objset_userobjspace_upgradable(objset_t *os);
 227 boolean_t dmu_objset_userobjspace_present(objset_t *os);
 228 boolean_t dmu_objset_incompatible_encryption_version(objset_t *os);
 229 boolean_t dmu_objset_projectquota_enabled(objset_t *os);
 230 boolean_t dmu_objset_projectquota_present(objset_t *os);
 231 boolean_t dmu_objset_projectquota_upgradable(objset_t *os);
 232 void dmu_objset_id_quota_upgrade(objset_t *os);
 233
 234 int dmu_fsname(const char *snapname, char *buf);
 235
 236 void dmu_objset_evict_done(objset_t *os);
 237 void dmu_objset_willuse_space(objset_t *os, int64_t space, dmu_tx_t *tx);
 238
 239 void dmu_objset_init(void);
 240 void dmu_objset_fini(void);
 241
 242 #ifdef  __cplusplus
 243 }
 244 #endif
 245
 246 #endif /* _SYS_DMU_OBJSET_H */