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) 2013 by Saso Kiselkov. All rights reserved.
  24  */
  25
  26 /* Portions Copyright 2010 Robert Milkowski */
  27
  28 #ifndef _SYS_DMU_OBJSET_H
  29 #define _SYS_DMU_OBJSET_H
  30
  31 #include <sys/spa.h>
  32 #include <sys/arc.h>
  33 #include <sys/txg.h>
  34 #include <sys/zfs_context.h>
  35 #include <sys/dnode.h>
  36 #include <sys/zio.h>
  37 #include <sys/zil.h>
  38 #include <sys/sa.h>
  39
  40 #ifdef  __cplusplus
  41 extern "C" {
  42 #endif
  43
  44 extern krwlock_t os_lock;
  45
  46 struct dsl_dataset;
  47 struct dmu_tx;
  48
  49 #define OBJSET_PHYS_SIZE 2048
  50 #define OBJSET_OLD_PHYS_SIZE 1024
  51
  52 #define OBJSET_BUF_HAS_USERUSED(buf) \
  53         (arc_buf_size(buf) > OBJSET_OLD_PHYS_SIZE)
  54
  55 #define OBJSET_FLAG_USERACCOUNTING_COMPLETE     (1ULL<<0)
  56
  57 typedef struct objset_phys {
  58         dnode_phys_t os_meta_dnode;
  59         zil_header_t os_zil_header;
  60         uint64_t os_type;
  61         uint64_t os_flags;
  62         char os_pad[OBJSET_PHYS_SIZE - sizeof (dnode_phys_t)*3 -
  63             sizeof (zil_header_t) - sizeof (uint64_t)*2];
  64         dnode_phys_t os_userused_dnode;
  65         dnode_phys_t os_groupused_dnode;
  66 } objset_phys_t;
  67
  68 struct objset {
  69         /* Immutable: */
  70         struct dsl_dataset *os_dsl_dataset;
  71         spa_t *os_spa;
  72         arc_buf_t *os_phys_buf;
  73         objset_phys_t *os_phys;
  74         /*
  75          * The following "special" dnodes have no parent and are exempt from
  76          * dnode_move(), but they root their descendents in this objset using
  77          * handles anyway, so that all access to dnodes from dbufs consistently
  78          * uses handles.
  79          */
  80         dnode_handle_t os_meta_dnode;
  81         dnode_handle_t os_userused_dnode;
  82         dnode_handle_t os_groupused_dnode;
  83         zilog_t *os_zil;
  84
  85         /* can change, under dsl_dir's locks: */
  86         uint8_t os_checksum;
  87         uint8_t os_compress;
  88         uint8_t os_copies;
  89         uint8_t os_dedup_checksum;
  90         uint8_t os_dedup_verify;
  91         uint8_t os_logbias;
  92         uint8_t os_primary_cache;
  93         uint8_t os_secondary_cache;
  94         uint8_t os_sync;
  95
  96         /* no lock needed: */
  97         struct dmu_tx *os_synctx; /* XXX sketchy */
  98         blkptr_t *os_rootbp;
  99         zil_header_t os_zil_header;
 100         list_t os_synced_dnodes;
 101         uint64_t os_flags;
 102
 103         /* Protected by os_obj_lock */
 104         kmutex_t os_obj_lock;
 105         uint64_t os_obj_next;
 106
 107         /* Protected by os_lock */
 108         kmutex_t os_lock;
 109         list_t os_dirty_dnodes[TXG_SIZE];
 110         list_t os_free_dnodes[TXG_SIZE];
 111         list_t os_dnodes;
 112         list_t os_downgraded_dbufs;
 113
 114         /* stuff we store for the user */
 115         kmutex_t os_user_ptr_lock;
 116         void *os_user_ptr;
 117
 118         /* SA layout/attribute registration */
 119         sa_os_t *os_sa;
 120 };
 121
 122 #define DMU_META_OBJSET         0
 123 #define DMU_META_DNODE_OBJECT   0
 124 #define DMU_OBJECT_IS_SPECIAL(obj) ((int64_t)(obj) <= 0)
 125 #define DMU_META_DNODE(os)      ((os)->os_meta_dnode.dnh_dnode)
 126 #define DMU_USERUSED_DNODE(os)  ((os)->os_userused_dnode.dnh_dnode)
 127 #define DMU_GROUPUSED_DNODE(os) ((os)->os_groupused_dnode.dnh_dnode)
 128
 129 #define DMU_OS_IS_L2CACHEABLE(os)                               \
 130         ((os)->os_secondary_cache == ZFS_CACHE_ALL ||           \
 131         (os)->os_secondary_cache == ZFS_CACHE_METADATA)
 132
 133 #define DMU_OS_IS_L2COMPRESSIBLE(os)    ((os)->os_compress != ZIO_COMPRESS_OFF)
 134
 135 /* called from zpl */
 136 int dmu_objset_hold(const char *name, void *tag, objset_t **osp);
 137 int dmu_objset_own(const char *name, dmu_objset_type_t type,
 138     boolean_t readonly, void *tag, objset_t **osp);
 139 void dmu_objset_rele(objset_t *os, void *tag);
 140 void dmu_objset_disown(objset_t *os, void *tag);
 141 int dmu_objset_from_ds(struct dsl_dataset *ds, objset_t **osp);
 142
 143 int dmu_objset_create(const char *name, dmu_objset_type_t type, uint64_t flags,
 144     void (*func)(objset_t *os, void *arg, cred_t *cr, dmu_tx_t *tx), void *arg);
 145 int dmu_objset_clone(const char *name, struct dsl_dataset *clone_origin,
 146     uint64_t flags);
 147 int dmu_objset_destroy(const char *name, boolean_t defer);
 148 int dmu_objset_snapshot(char *fsname, char *snapname, char *tag,
 149     struct nvlist *props, boolean_t recursive, boolean_t temporary, int fd);
 150 void dmu_objset_stats(objset_t *os, nvlist_t *nv);
 151 void dmu_objset_fast_stat(objset_t *os, dmu_objset_stats_t *stat);
 152 void dmu_objset_space(objset_t *os, uint64_t *refdbytesp, uint64_t *availbytesp,
 153     uint64_t *usedobjsp, uint64_t *availobjsp);
 154 uint64_t dmu_objset_fsid_guid(objset_t *os);
 155 int dmu_objset_find(char *name, int func(const char *, void *), void *arg,
 156     int flags);
 157 int dmu_objset_find_spa(spa_t *spa, const char *name,
 158     int func(spa_t *, uint64_t, const char *, void *), void *arg, int flags);
 159 int dmu_objset_prefetch(const char *name, void *arg);
 160 void dmu_objset_byteswap(void *buf, size_t size);
 161 int dmu_objset_evict_dbufs(objset_t *os);
 162 timestruc_t dmu_objset_snap_cmtime(objset_t *os);
 163
 164 /* called from dsl */
 165 void dmu_objset_sync(objset_t *os, zio_t *zio, dmu_tx_t *tx);
 166 boolean_t dmu_objset_is_dirty(objset_t *os, uint64_t txg);
 167 objset_t *dmu_objset_create_impl(spa_t *spa, struct dsl_dataset *ds,
 168     blkptr_t *bp, dmu_objset_type_t type, dmu_tx_t *tx);
 169 int dmu_objset_open_impl(spa_t *spa, struct dsl_dataset *ds, blkptr_t *bp,
 170     objset_t **osp);
 171 void dmu_objset_evict(objset_t *os);
 172 void dmu_objset_do_userquota_updates(objset_t *os, dmu_tx_t *tx);
 173 void dmu_objset_userquota_get_ids(dnode_t *dn, boolean_t before, dmu_tx_t *tx);
 174 boolean_t dmu_objset_userused_enabled(objset_t *os);
 175 int dmu_objset_userspace_upgrade(objset_t *os);
 176 boolean_t dmu_objset_userspace_present(objset_t *os);
 177
 178 void dmu_objset_init(void);
 179 void dmu_objset_fini(void);
 180
 181 #ifdef  __cplusplus
 182 }
 183 #endif
 184
 185 #endif /* _SYS_DMU_OBJSET_H */