]>
Commit | Line | Data |
---|---|---|
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. |
d2734cce | 23 | * Copyright (c) 2012, 2017 by Delphix. All rights reserved. |
788eb90c | 24 | * Copyright (c) 2014, Joyent, Inc. All rights reserved. |
0c66c32d | 25 | * Copyright (c) 2014 Spectra Logic Corporation, All rights reserved. |
34dc7c2f BB |
26 | */ |
27 | ||
28 | #ifndef _SYS_DSL_DIR_H | |
29 | #define _SYS_DSL_DIR_H | |
30 | ||
34dc7c2f BB |
31 | #include <sys/dmu.h> |
32 | #include <sys/dsl_pool.h> | |
33 | #include <sys/dsl_synctask.h> | |
34 | #include <sys/refcount.h> | |
35 | #include <sys/zfs_context.h> | |
b5256303 | 36 | #include <sys/dsl_crypt.h> |
34dc7c2f BB |
37 | |
38 | #ifdef __cplusplus | |
39 | extern "C" { | |
40 | #endif | |
41 | ||
42 | struct dsl_dataset; | |
43 | ||
788eb90c JJ |
44 | /* |
45 | * DD_FIELD_* are strings that are used in the "extensified" dsl_dir zap object. | |
46 | * They should be of the format <reverse-dns>:<field>. | |
47 | */ | |
48 | ||
49 | #define DD_FIELD_FILESYSTEM_COUNT "com.joyent:filesystem_count" | |
50 | #define DD_FIELD_SNAPSHOT_COUNT "com.joyent:snapshot_count" | |
b5256303 | 51 | #define DD_FIELD_CRYPTO_KEY_OBJ "com.datto:crypto_key_obj" |
788eb90c | 52 | |
b128c09f BB |
53 | typedef enum dd_used { |
54 | DD_USED_HEAD, | |
55 | DD_USED_SNAP, | |
56 | DD_USED_CHILD, | |
57 | DD_USED_CHILD_RSRV, | |
58 | DD_USED_REFRSRV, | |
59 | DD_USED_NUM | |
60 | } dd_used_t; | |
61 | ||
62 | #define DD_FLAG_USED_BREAKDOWN (1<<0) | |
63 | ||
34dc7c2f BB |
64 | typedef struct dsl_dir_phys { |
65 | uint64_t dd_creation_time; /* not actually used */ | |
66 | uint64_t dd_head_dataset_obj; | |
67 | uint64_t dd_parent_obj; | |
68 | uint64_t dd_origin_obj; | |
69 | uint64_t dd_child_dir_zapobj; | |
70 | /* | |
71 | * how much space our children are accounting for; for leaf | |
72 | * datasets, == physical space used by fs + snaps | |
73 | */ | |
74 | uint64_t dd_used_bytes; | |
75 | uint64_t dd_compressed_bytes; | |
76 | uint64_t dd_uncompressed_bytes; | |
77 | /* Administrative quota setting */ | |
78 | uint64_t dd_quota; | |
79 | /* Administrative reservation setting */ | |
80 | uint64_t dd_reserved; | |
81 | uint64_t dd_props_zapobj; | |
82 | uint64_t dd_deleg_zapobj; /* dataset delegation permissions */ | |
b128c09f BB |
83 | uint64_t dd_flags; |
84 | uint64_t dd_used_breakdown[DD_USED_NUM]; | |
428870ff BB |
85 | uint64_t dd_clones; /* dsl_dir objects */ |
86 | uint64_t dd_pad[13]; /* pad out to 256 bytes for good measure */ | |
34dc7c2f BB |
87 | } dsl_dir_phys_t; |
88 | ||
89 | struct dsl_dir { | |
0c66c32d JG |
90 | dmu_buf_user_t dd_dbu; |
91 | ||
34dc7c2f BB |
92 | /* These are immutable; no lock needed: */ |
93 | uint64_t dd_object; | |
b5256303 | 94 | uint64_t dd_crypto_obj; |
34dc7c2f BB |
95 | dsl_pool_t *dd_pool; |
96 | ||
d683ddbb JG |
97 | /* Stable until user eviction; no lock needed: */ |
98 | dmu_buf_t *dd_dbuf; | |
99 | ||
34dc7c2f BB |
100 | /* protected by lock on pool's dp_dirty_dirs list */ |
101 | txg_node_t dd_dirty_link; | |
102 | ||
103 | /* protected by dp_config_rwlock */ | |
104 | dsl_dir_t *dd_parent; | |
105 | ||
106 | /* Protected by dd_lock */ | |
107 | kmutex_t dd_lock; | |
0eb21616 | 108 | list_t dd_props; /* list of dsl_prop_record_t's */ |
6413c95f | 109 | inode_timespec_t dd_snap_cmtime; /* last snapshot namespace change */ |
428870ff | 110 | uint64_t dd_origin_txg; |
34dc7c2f | 111 | |
34dc7c2f BB |
112 | /* gross estimate of space used by in-flight tx's */ |
113 | uint64_t dd_tempreserved[TXG_SIZE]; | |
114 | /* amount of space we expect to write; == amount of dirty data */ | |
115 | int64_t dd_space_towrite[TXG_SIZE]; | |
116 | ||
117 | /* protected by dd_lock; keep at end of struct for better locality */ | |
eca7b760 | 118 | char dd_myname[ZFS_MAX_DATASET_NAME_LEN]; |
34dc7c2f BB |
119 | }; |
120 | ||
d683ddbb JG |
121 | static inline dsl_dir_phys_t * |
122 | dsl_dir_phys(dsl_dir_t *dd) | |
123 | { | |
124 | return (dd->dd_dbuf->db_data); | |
125 | } | |
126 | ||
13fe0198 | 127 | void dsl_dir_rele(dsl_dir_t *dd, void *tag); |
0c66c32d | 128 | void dsl_dir_async_rele(dsl_dir_t *dd, void *tag); |
13fe0198 MA |
129 | int dsl_dir_hold(dsl_pool_t *dp, const char *name, void *tag, |
130 | dsl_dir_t **, const char **tail); | |
131 | int dsl_dir_hold_obj(dsl_pool_t *dp, uint64_t ddobj, | |
34dc7c2f BB |
132 | const char *tail, void *tag, dsl_dir_t **); |
133 | void dsl_dir_name(dsl_dir_t *dd, char *buf); | |
134 | int dsl_dir_namelen(dsl_dir_t *dd); | |
b128c09f BB |
135 | uint64_t dsl_dir_create_sync(dsl_pool_t *dp, dsl_dir_t *pds, |
136 | const char *name, dmu_tx_t *tx); | |
d99a0153 CW |
137 | |
138 | uint64_t dsl_dir_get_used(dsl_dir_t *dd); | |
d2734cce | 139 | uint64_t dsl_dir_get_compressed(dsl_dir_t *dd); |
d99a0153 CW |
140 | uint64_t dsl_dir_get_quota(dsl_dir_t *dd); |
141 | uint64_t dsl_dir_get_reservation(dsl_dir_t *dd); | |
142 | uint64_t dsl_dir_get_compressratio(dsl_dir_t *dd); | |
143 | uint64_t dsl_dir_get_logicalused(dsl_dir_t *dd); | |
144 | uint64_t dsl_dir_get_usedsnap(dsl_dir_t *dd); | |
145 | uint64_t dsl_dir_get_usedds(dsl_dir_t *dd); | |
146 | uint64_t dsl_dir_get_usedrefreserv(dsl_dir_t *dd); | |
147 | uint64_t dsl_dir_get_usedchild(dsl_dir_t *dd); | |
148 | void dsl_dir_get_origin(dsl_dir_t *dd, char *buf); | |
149 | int dsl_dir_get_filesystem_count(dsl_dir_t *dd, uint64_t *count); | |
150 | int dsl_dir_get_snapshot_count(dsl_dir_t *dd, uint64_t *count); | |
151 | ||
34dc7c2f BB |
152 | void dsl_dir_stats(dsl_dir_t *dd, nvlist_t *nv); |
153 | uint64_t dsl_dir_space_available(dsl_dir_t *dd, | |
154 | dsl_dir_t *ancestor, int64_t delta, int ondiskonly); | |
155 | void dsl_dir_dirty(dsl_dir_t *dd, dmu_tx_t *tx); | |
156 | void dsl_dir_sync(dsl_dir_t *dd, dmu_tx_t *tx); | |
157 | int dsl_dir_tempreserve_space(dsl_dir_t *dd, uint64_t mem, | |
3ec3bc21 | 158 | uint64_t asize, boolean_t netfree, void **tr_cookiep, dmu_tx_t *tx); |
34dc7c2f BB |
159 | void dsl_dir_tempreserve_clear(void *tr_cookie, dmu_tx_t *tx); |
160 | void dsl_dir_willuse_space(dsl_dir_t *dd, int64_t space, dmu_tx_t *tx); | |
b128c09f | 161 | void dsl_dir_diduse_space(dsl_dir_t *dd, dd_used_t type, |
34dc7c2f | 162 | int64_t used, int64_t compressed, int64_t uncompressed, dmu_tx_t *tx); |
b128c09f BB |
163 | void dsl_dir_transfer_space(dsl_dir_t *dd, int64_t delta, |
164 | dd_used_t oldtype, dd_used_t newtype, dmu_tx_t *tx); | |
428870ff BB |
165 | int dsl_dir_set_quota(const char *ddname, zprop_source_t source, |
166 | uint64_t quota); | |
167 | int dsl_dir_set_reservation(const char *ddname, zprop_source_t source, | |
168 | uint64_t reservation); | |
788eb90c JJ |
169 | int dsl_dir_activate_fs_ss_limit(const char *); |
170 | int dsl_fs_ss_limit_check(dsl_dir_t *, uint64_t, zfs_prop_t, dsl_dir_t *, | |
171 | cred_t *); | |
172 | void dsl_fs_ss_count_adjust(dsl_dir_t *, int64_t, const char *, dmu_tx_t *); | |
13fe0198 | 173 | int dsl_dir_rename(const char *oldname, const char *newname); |
788eb90c JJ |
174 | int dsl_dir_transfer_possible(dsl_dir_t *sdd, dsl_dir_t *tdd, |
175 | uint64_t fs_cnt, uint64_t ss_cnt, uint64_t space, cred_t *); | |
b128c09f BB |
176 | boolean_t dsl_dir_is_clone(dsl_dir_t *dd); |
177 | void dsl_dir_new_refreservation(dsl_dir_t *dd, struct dsl_dataset *ds, | |
178 | uint64_t reservation, cred_t *cr, dmu_tx_t *tx); | |
428870ff | 179 | void dsl_dir_snap_cmtime_update(dsl_dir_t *dd); |
6413c95f | 180 | inode_timespec_t dsl_dir_snap_cmtime(dsl_dir_t *dd); |
13fe0198 MA |
181 | void dsl_dir_set_reservation_sync_impl(dsl_dir_t *dd, uint64_t value, |
182 | dmu_tx_t *tx); | |
788eb90c JJ |
183 | void dsl_dir_zapify(dsl_dir_t *dd, dmu_tx_t *tx); |
184 | boolean_t dsl_dir_is_zapified(dsl_dir_t *dd); | |
34dc7c2f BB |
185 | |
186 | /* internal reserved dir name */ | |
187 | #define MOS_DIR_NAME "$MOS" | |
b128c09f | 188 | #define ORIGIN_DIR_NAME "$ORIGIN" |
428870ff | 189 | #define FREE_DIR_NAME "$FREE" |
fbeddd60 | 190 | #define LEAK_DIR_NAME "$LEAK" |
34dc7c2f BB |
191 | |
192 | #ifdef ZFS_DEBUG | |
193 | #define dprintf_dd(dd, fmt, ...) do { \ | |
194 | if (zfs_flags & ZFS_DEBUG_DPRINTF) { \ | |
eca7b760 | 195 | char *__ds_name = kmem_alloc(ZFS_MAX_DATASET_NAME_LEN, KM_SLEEP); \ |
34dc7c2f BB |
196 | dsl_dir_name(dd, __ds_name); \ |
197 | dprintf("dd=%s " fmt, __ds_name, __VA_ARGS__); \ | |
eca7b760 | 198 | kmem_free(__ds_name, ZFS_MAX_DATASET_NAME_LEN); \ |
34dc7c2f BB |
199 | } \ |
200 | _NOTE(CONSTCOND) } while (0) | |
201 | #else | |
202 | #define dprintf_dd(dd, fmt, ...) | |
203 | #endif | |
204 | ||
205 | #ifdef __cplusplus | |
206 | } | |
207 | #endif | |
208 | ||
209 | #endif /* _SYS_DSL_DIR_H */ |