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