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