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