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