]> git.proxmox.com Git - mirror_zfs.git/blame - include/sys/dmu_objset.h
Project Quota on ZFS
[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
b5256303
TC
65/* all flags are currently non-portable */
66#define OBJSET_CRYPT_PORTABLE_FLAGS_MASK (0)
67
34dc7c2f
BB
68typedef struct objset_phys {
69 dnode_phys_t os_meta_dnode;
70 zil_header_t os_zil_header;
71 uint64_t os_type;
9babb374 72 uint64_t os_flags;
b5256303
TC
73 uint8_t os_portable_mac[ZIO_OBJSET_MAC_LEN];
74 uint8_t os_local_mac[ZIO_OBJSET_MAC_LEN];
9c5167d1 75 char os_pad0[OBJSET_PHYS_SIZE_V2 - sizeof (dnode_phys_t)*3 -
b5256303
TC
76 sizeof (zil_header_t) - sizeof (uint64_t)*2 -
77 2*ZIO_OBJSET_MAC_LEN];
9babb374
BB
78 dnode_phys_t os_userused_dnode;
79 dnode_phys_t os_groupused_dnode;
9c5167d1
NF
80 dnode_phys_t os_projectused_dnode;
81 char os_pad1[OBJSET_PHYS_SIZE_V3 - OBJSET_PHYS_SIZE_V2 -
82 sizeof (dnode_phys_t)];
34dc7c2f
BB
83} objset_phys_t;
84
1de321e6
JX
85typedef int (*dmu_objset_upgrade_cb_t)(objset_t *);
86
34dc7c2f 87struct objset {
34dc7c2f
BB
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;
b5256303
TC
93 boolean_t os_encrypted;
94
572e2857 95 /*
0c66c32d
JG
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.
572e2857
BB
100 */
101 dnode_handle_t os_meta_dnode;
102 dnode_handle_t os_userused_dnode;
103 dnode_handle_t os_groupused_dnode;
9c5167d1 104 dnode_handle_t os_projectused_dnode;
34dc7c2f 105 zilog_t *os_zil;
428870ff 106
0c66c32d
JG
107 list_node_t os_evicting_node;
108
428870ff 109 /* can change, under dsl_dir's locks: */
50c957f7 110 uint64_t os_dnodesize; /* default dnode size for new objects */
faf0f58c
MA
111 enum zio_checksum os_checksum;
112 enum zio_compress os_compress;
428870ff 113 uint8_t os_copies;
faf0f58c
MA
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;
f1512ee6 121 int os_recordsize;
34dc7c2f 122
cc9bb3e5
GM
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
34dc7c2f
BB
129 /* no lock needed: */
130 struct dmu_tx *os_synctx; /* XXX sketchy */
b128c09f 131 zil_header_t os_zil_header;
64fc7762 132 multilist_t *os_synced_dnodes;
9babb374 133 uint64_t os_flags;
68cbd56e
NB
134 uint64_t os_freed_dnodes;
135 boolean_t os_rescan_dnodes;
34dc7c2f 136
b5256303 137 /* os_phys_buf should be written raw next txg */
1b66810b 138 boolean_t os_next_write_raw[TXG_SIZE];
b5256303 139
34dc7c2f
BB
140 /* Protected by os_obj_lock */
141 kmutex_t os_obj_lock;
dbeb8796
MA
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;
34dc7c2f
BB
147
148 /* Protected by os_lock */
149 kmutex_t os_lock;
64fc7762 150 multilist_t *os_dirty_dnodes[TXG_SIZE];
34dc7c2f
BB
151 list_t os_dnodes;
152 list_t os_downgraded_dbufs;
153
9c5167d1 154 /* Protects changes to DMU_{USER,GROUP,PROJECT}USED_OBJECT */
64fc7762
MA
155 kmutex_t os_userused_lock;
156
34dc7c2f
BB
157 /* stuff we store for the user */
158 kmutex_t os_user_ptr_lock;
159 void *os_user_ptr;
428870ff 160 sa_os_t *os_sa;
1de321e6
JX
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;
428870ff
BB
168};
169
170#define DMU_META_OBJSET 0
34dc7c2f 171#define DMU_META_DNODE_OBJECT 0
9babb374 172#define DMU_OBJECT_IS_SPECIAL(obj) ((int64_t)(obj) <= 0)
572e2857
BB
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)
9c5167d1 176#define DMU_PROJECTUSED_DNODE(os) ((os)->os_projectused_dnode.dnh_dnode)
34dc7c2f 177
b128c09f
BB
178#define DMU_OS_IS_L2CACHEABLE(os) \
179 ((os)->os_secondary_cache == ZFS_CACHE_ALL || \
180 (os)->os_secondary_cache == ZFS_CACHE_METADATA)
181
34dc7c2f 182/* called from zpl */
428870ff 183int dmu_objset_hold(const char *name, void *tag, objset_t **osp);
b5256303
TC
184int dmu_objset_hold_flags(const char *name, boolean_t decrypt, void *tag,
185 objset_t **osp);
428870ff 186int dmu_objset_own(const char *name, dmu_objset_type_t type,
b5256303 187 boolean_t readonly, boolean_t decrypt, void *tag, objset_t **osp);
9c43027b 188int dmu_objset_own_obj(struct dsl_pool *dp, uint64_t obj,
b5256303
TC
189 dmu_objset_type_t type, boolean_t readonly, boolean_t decrypt,
190 void *tag, objset_t **osp);
191void dmu_objset_refresh_ownership(objset_t *os, boolean_t key_needed,
192 void *tag);
428870ff 193void dmu_objset_rele(objset_t *os, void *tag);
b5256303
TC
194void dmu_objset_rele_flags(objset_t *os, boolean_t decrypt, void *tag);
195void dmu_objset_disown(objset_t *os, boolean_t decrypt, void *tag);
428870ff
BB
196int dmu_objset_from_ds(struct dsl_dataset *ds, objset_t **osp);
197
34dc7c2f
BB
198void dmu_objset_stats(objset_t *os, nvlist_t *nv);
199void dmu_objset_fast_stat(objset_t *os, dmu_objset_stats_t *stat);
200void dmu_objset_space(objset_t *os, uint64_t *refdbytesp, uint64_t *availbytesp,
201 uint64_t *usedobjsp, uint64_t *availobjsp);
202uint64_t dmu_objset_fsid_guid(objset_t *os);
13fe0198
MA
203int 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);
206void dmu_objset_evict_dbufs(objset_t *os);
428870ff 207timestruc_t dmu_objset_snap_cmtime(objset_t *os);
34dc7c2f
BB
208
209/* called from dsl */
428870ff
BB
210void dmu_objset_sync(objset_t *os, zio_t *zio, dmu_tx_t *tx);
211boolean_t dmu_objset_is_dirty(objset_t *os, uint64_t txg);
b5256303
TC
212objset_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);
428870ff 215objset_t *dmu_objset_create_impl(spa_t *spa, struct dsl_dataset *ds,
34dc7c2f
BB
216 blkptr_t *bp, dmu_objset_type_t type, dmu_tx_t *tx);
217int dmu_objset_open_impl(spa_t *spa, struct dsl_dataset *ds, blkptr_t *bp,
428870ff
BB
218 objset_t **osp);
219void dmu_objset_evict(objset_t *os);
220void dmu_objset_do_userquota_updates(objset_t *os, dmu_tx_t *tx);
221void dmu_objset_userquota_get_ids(dnode_t *dn, boolean_t before, dmu_tx_t *tx);
222boolean_t dmu_objset_userused_enabled(objset_t *os);
9babb374
BB
223int dmu_objset_userspace_upgrade(objset_t *os);
224boolean_t dmu_objset_userspace_present(objset_t *os);
1de321e6 225boolean_t dmu_objset_userobjused_enabled(objset_t *os);
126ae9f4 226boolean_t dmu_objset_userobjspace_upgradable(objset_t *os);
1de321e6 227boolean_t dmu_objset_userobjspace_present(objset_t *os);
ae76f45c 228boolean_t dmu_objset_incompatible_encryption_version(objset_t *os);
9c5167d1
NF
229boolean_t dmu_objset_projectquota_enabled(objset_t *os);
230boolean_t dmu_objset_projectquota_present(objset_t *os);
231boolean_t dmu_objset_projectquota_upgradable(objset_t *os);
232void dmu_objset_id_quota_upgrade(objset_t *os);
1de321e6 233
13fe0198 234int dmu_fsname(const char *snapname, char *buf);
34dc7c2f 235
0c66c32d 236void dmu_objset_evict_done(objset_t *os);
3ec3bc21 237void dmu_objset_willuse_space(objset_t *os, int64_t space, dmu_tx_t *tx);
0c66c32d 238
572e2857
BB
239void dmu_objset_init(void);
240void dmu_objset_fini(void);
241
34dc7c2f
BB
242#ifdef __cplusplus
243}
244#endif
245
246#endif /* _SYS_DMU_OBJSET_H */