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