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.
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.
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]
22 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
23 * Copyright (c) 2012, 2018 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 * Copyright (c) 2014 Integros [integros.com]
29 /* Portions Copyright 2010 Robert Milkowski */
31 #ifndef _SYS_DMU_OBJSET_H
32 #define _SYS_DMU_OBJSET_H
37 #include <sys/zfs_context.h>
38 #include <sys/dnode.h>
42 #include <sys/zfs_ioctl.h>
48 extern krwlock_t os_lock;
54 #define OBJSET_PHYS_SIZE 2048
55 #define OBJSET_OLD_PHYS_SIZE 1024
57 #define OBJSET_BUF_HAS_USERUSED(buf) \
58 (arc_buf_size(buf) > OBJSET_OLD_PHYS_SIZE)
60 #define OBJSET_FLAG_USERACCOUNTING_COMPLETE (1ULL<<0)
62 typedef struct objset_phys {
63 dnode_phys_t os_meta_dnode;
64 zil_header_t os_zil_header;
67 char os_pad[OBJSET_PHYS_SIZE - sizeof (dnode_phys_t)*3 -
68 sizeof (zil_header_t) - sizeof (uint64_t)*2];
69 dnode_phys_t os_userused_dnode;
70 dnode_phys_t os_groupused_dnode;
73 #define OBJSET_PROP_UNINITIALIZED ((uint64_t)-1)
76 struct dsl_dataset *os_dsl_dataset;
78 arc_buf_t *os_phys_buf;
79 objset_phys_t *os_phys;
81 * The following "special" dnodes have no parent, are exempt
82 * from dnode_move(), and are not recorded in os_dnodes, but they
83 * root their descendents in this objset using handles anyway, so
84 * that all access to dnodes from dbufs consistently uses handles.
86 dnode_handle_t os_meta_dnode;
87 dnode_handle_t os_userused_dnode;
88 dnode_handle_t os_groupused_dnode;
91 list_node_t os_evicting_node;
93 /* can change, under dsl_dir's locks: */
94 uint64_t os_dnodesize; /* default dnode size for new objects */
95 enum zio_checksum os_checksum;
96 enum zio_compress os_compress;
98 enum zio_checksum os_dedup_checksum;
99 boolean_t os_dedup_verify;
100 zfs_logbias_op_t os_logbias;
101 zfs_cache_type_t os_primary_cache;
102 zfs_cache_type_t os_secondary_cache;
103 zfs_sync_type_t os_sync;
104 zfs_redundant_metadata_type_t os_redundant_metadata;
107 * The next four values are used as a cache of whatever's on disk, and
108 * are initialized the first time these properties are queried. Before
109 * being initialized with their real values, their values are
110 * OBJSET_PROP_UNINITIALIZED.
113 uint64_t os_normalization;
114 uint64_t os_utf8only;
115 uint64_t os_casesensitivity;
117 * The largest zpl file block allowed in special class.
118 * cached here instead of zfsvfs for easier access.
120 int os_zpl_special_smallblock;
123 * Pointer is constant; the blkptr it points to is protected by
124 * os_dsl_dataset->ds_bp_rwlock
128 /* no lock needed: */
129 struct dmu_tx *os_synctx; /* XXX sketchy */
130 zil_header_t os_zil_header;
131 multilist_t *os_synced_dnodes;
133 uint64_t os_freed_dnodes;
134 boolean_t os_rescan_dnodes;
136 /* Protected by os_obj_lock */
137 kmutex_t os_obj_lock;
138 uint64_t os_obj_next_chunk;
140 /* Per-CPU next object to allocate, protected by atomic ops. */
141 uint64_t *os_obj_next_percpu;
142 int os_obj_next_percpu_len;
144 /* Protected by os_lock */
146 multilist_t *os_dirty_dnodes[TXG_SIZE];
148 list_t os_downgraded_dbufs;
150 /* Protects changes to DMU_{USER,GROUP}USED_OBJECT */
151 kmutex_t os_userused_lock;
153 /* stuff we store for the user */
154 kmutex_t os_user_ptr_lock;
159 #define DMU_META_OBJSET 0
160 #define DMU_META_DNODE_OBJECT 0
161 #define DMU_OBJECT_IS_SPECIAL(obj) ((int64_t)(obj) <= 0)
162 #define DMU_META_DNODE(os) ((os)->os_meta_dnode.dnh_dnode)
163 #define DMU_USERUSED_DNODE(os) ((os)->os_userused_dnode.dnh_dnode)
164 #define DMU_GROUPUSED_DNODE(os) ((os)->os_groupused_dnode.dnh_dnode)
166 #define DMU_OS_IS_L2CACHEABLE(os) \
167 ((os)->os_secondary_cache == ZFS_CACHE_ALL || \
168 (os)->os_secondary_cache == ZFS_CACHE_METADATA)
170 #define DMU_OS_IS_L2COMPRESSIBLE(os) (zfs_mdcomp_disable == B_FALSE)
172 /* called from zpl */
173 int dmu_objset_hold(const char *name, void *tag, objset_t **osp);
174 int dmu_objset_own(const char *name, dmu_objset_type_t type,
175 boolean_t readonly, void *tag, objset_t **osp);
176 int dmu_objset_own_obj(struct dsl_pool *dp, uint64_t obj,
177 dmu_objset_type_t type, boolean_t readonly, void *tag, objset_t **osp);
178 void dmu_objset_refresh_ownership(struct dsl_dataset *ds,
179 struct dsl_dataset **newds, void *tag);
180 void dmu_objset_rele(objset_t *os, void *tag);
181 void dmu_objset_disown(objset_t *os, void *tag);
182 int dmu_objset_from_ds(struct dsl_dataset *ds, objset_t **osp);
184 void dmu_objset_stats(objset_t *os, nvlist_t *nv);
185 void dmu_objset_fast_stat(objset_t *os, dmu_objset_stats_t *stat);
186 void dmu_objset_space(objset_t *os, uint64_t *refdbytesp, uint64_t *availbytesp,
187 uint64_t *usedobjsp, uint64_t *availobjsp);
188 uint64_t dmu_objset_fsid_guid(objset_t *os);
189 int dmu_objset_find_dp(struct dsl_pool *dp, uint64_t ddobj,
190 int func(struct dsl_pool *, struct dsl_dataset *, void *),
191 void *arg, int flags);
192 int dmu_objset_prefetch(const char *name, void *arg);
193 void dmu_objset_evict_dbufs(objset_t *os);
194 timestruc_t dmu_objset_snap_cmtime(objset_t *os);
196 /* called from dsl */
197 void dmu_objset_sync(objset_t *os, zio_t *zio, dmu_tx_t *tx);
198 boolean_t dmu_objset_is_dirty(objset_t *os, uint64_t txg);
199 objset_t *dmu_objset_create_impl(spa_t *spa, struct dsl_dataset *ds,
200 blkptr_t *bp, dmu_objset_type_t type, dmu_tx_t *tx);
201 int dmu_objset_open_impl(spa_t *spa, struct dsl_dataset *ds, blkptr_t *bp,
203 void dmu_objset_evict(objset_t *os);
204 void dmu_objset_do_userquota_updates(objset_t *os, dmu_tx_t *tx);
205 void dmu_objset_userquota_get_ids(dnode_t *dn, boolean_t before, dmu_tx_t *tx);
206 boolean_t dmu_objset_userused_enabled(objset_t *os);
207 int dmu_objset_userspace_upgrade(objset_t *os);
208 boolean_t dmu_objset_userspace_present(objset_t *os);
209 int dmu_fsname(const char *snapname, char *buf);
211 void dmu_objset_evict_done(objset_t *os);
212 void dmu_objset_willuse_space(objset_t *os, int64_t space, dmu_tx_t *tx);
214 void dmu_objset_init(void);
215 void dmu_objset_fini(void);
221 #endif /* _SYS_DMU_OBJSET_H */