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