dmu_objset.h revision 12380e1e701fda28c9e9f32d01cafb54af279eb5
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, 2014 by Delphix. All rights reserved.
24 * Copyright (c) 2013 by Saso Kiselkov. All rights reserved.
25 * Copyright (c) 2014 Spectra Logic Corporation, All rights reserved.
26 */
27
28/* Portions Copyright 2010 Robert Milkowski */
29
30#ifndef	_SYS_DMU_OBJSET_H
31#define	_SYS_DMU_OBJSET_H
32
33#include <sys/spa.h>
34#include <sys/arc.h>
35#include <sys/txg.h>
36#include <sys/zfs_context.h>
37#include <sys/dnode.h>
38#include <sys/zio.h>
39#include <sys/zil.h>
40#include <sys/sa.h>
41
42#ifdef	__cplusplus
43extern "C" {
44#endif
45
46extern krwlock_t os_lock;
47
48struct dsl_pool;
49struct dsl_dataset;
50struct dmu_tx;
51
52#define	OBJSET_PHYS_SIZE 2048
53#define	OBJSET_OLD_PHYS_SIZE 1024
54
55#define	OBJSET_BUF_HAS_USERUSED(buf) \
56	(arc_buf_size(buf) > OBJSET_OLD_PHYS_SIZE)
57
58#define	OBJSET_FLAG_USERACCOUNTING_COMPLETE	(1ULL<<0)
59
60typedef struct objset_phys {
61	dnode_phys_t os_meta_dnode;
62	zil_header_t os_zil_header;
63	uint64_t os_type;
64	uint64_t os_flags;
65	char os_pad[OBJSET_PHYS_SIZE - sizeof (dnode_phys_t)*3 -
66	    sizeof (zil_header_t) - sizeof (uint64_t)*2];
67	dnode_phys_t os_userused_dnode;
68	dnode_phys_t os_groupused_dnode;
69} objset_phys_t;
70
71struct objset {
72	/* Immutable: */
73	struct dsl_dataset *os_dsl_dataset;
74	spa_t *os_spa;
75	arc_buf_t *os_phys_buf;
76	objset_phys_t *os_phys;
77	/*
78	 * The following "special" dnodes have no parent, are exempt
79	 * from dnode_move(), and are not recorded in os_dnodes, but they
80	 * root their descendents in this objset using handles anyway, so
81	 * that all access to dnodes from dbufs consistently uses handles.
82	 */
83	dnode_handle_t os_meta_dnode;
84	dnode_handle_t os_userused_dnode;
85	dnode_handle_t os_groupused_dnode;
86	zilog_t *os_zil;
87
88	list_node_t os_evicting_node;
89
90	/* can change, under dsl_dir's locks: */
91	enum zio_checksum os_checksum;
92	enum zio_compress os_compress;
93	uint8_t os_copies;
94	enum zio_checksum os_dedup_checksum;
95	boolean_t os_dedup_verify;
96	boolean_t os_evicting;
97	zfs_logbias_op_t os_logbias;
98	zfs_cache_type_t os_primary_cache;
99	zfs_cache_type_t os_secondary_cache;
100	zfs_sync_type_t os_sync;
101	zfs_redundant_metadata_type_t os_redundant_metadata;
102	int os_recordsize;
103
104	/* no lock needed: */
105	struct dmu_tx *os_synctx; /* XXX sketchy */
106	blkptr_t *os_rootbp;
107	zil_header_t os_zil_header;
108	list_t os_synced_dnodes;
109	uint64_t os_flags;
110
111	/* Protected by os_obj_lock */
112	kmutex_t os_obj_lock;
113	uint64_t os_obj_next;
114
115	/* Protected by os_lock */
116	kmutex_t os_lock;
117	list_t os_dirty_dnodes[TXG_SIZE];
118	list_t os_free_dnodes[TXG_SIZE];
119	list_t os_dnodes;
120	list_t os_downgraded_dbufs;
121
122	/* stuff we store for the user */
123	kmutex_t os_user_ptr_lock;
124	void *os_user_ptr;
125	sa_os_t *os_sa;
126};
127
128#define	DMU_META_OBJSET		0
129#define	DMU_META_DNODE_OBJECT	0
130#define	DMU_OBJECT_IS_SPECIAL(obj) ((int64_t)(obj) <= 0)
131#define	DMU_META_DNODE(os)	((os)->os_meta_dnode.dnh_dnode)
132#define	DMU_USERUSED_DNODE(os)	((os)->os_userused_dnode.dnh_dnode)
133#define	DMU_GROUPUSED_DNODE(os)	((os)->os_groupused_dnode.dnh_dnode)
134
135#define	DMU_OS_IS_L2CACHEABLE(os)				\
136	((os)->os_secondary_cache == ZFS_CACHE_ALL ||		\
137	(os)->os_secondary_cache == ZFS_CACHE_METADATA)
138
139#define	DMU_OS_IS_L2COMPRESSIBLE(os)	(zfs_mdcomp_disable == B_FALSE)
140
141/* called from zpl */
142int dmu_objset_hold(const char *name, void *tag, objset_t **osp);
143int dmu_objset_own(const char *name, dmu_objset_type_t type,
144    boolean_t readonly, void *tag, objset_t **osp);
145int dmu_objset_own_obj(struct dsl_pool *dp, uint64_t obj,
146    dmu_objset_type_t type, boolean_t readonly, void *tag, objset_t **osp);
147void dmu_objset_refresh_ownership(objset_t *os, void *tag);
148void dmu_objset_rele(objset_t *os, void *tag);
149void dmu_objset_disown(objset_t *os, void *tag);
150int dmu_objset_from_ds(struct dsl_dataset *ds, objset_t **osp);
151
152void dmu_objset_stats(objset_t *os, nvlist_t *nv);
153void dmu_objset_fast_stat(objset_t *os, dmu_objset_stats_t *stat);
154void dmu_objset_space(objset_t *os, uint64_t *refdbytesp, uint64_t *availbytesp,
155    uint64_t *usedobjsp, uint64_t *availobjsp);
156uint64_t dmu_objset_fsid_guid(objset_t *os);
157int dmu_objset_find_dp(struct dsl_pool *dp, uint64_t ddobj,
158    int func(struct dsl_pool *, struct dsl_dataset *, void *),
159    void *arg, int flags);
160int dmu_objset_prefetch(const char *name, void *arg);
161void dmu_objset_evict_dbufs(objset_t *os);
162timestruc_t dmu_objset_snap_cmtime(objset_t *os);
163
164/* called from dsl */
165void dmu_objset_sync(objset_t *os, zio_t *zio, dmu_tx_t *tx);
166boolean_t dmu_objset_is_dirty(objset_t *os, uint64_t txg);
167objset_t *dmu_objset_create_impl(spa_t *spa, struct dsl_dataset *ds,
168    blkptr_t *bp, dmu_objset_type_t type, dmu_tx_t *tx);
169int dmu_objset_open_impl(spa_t *spa, struct dsl_dataset *ds, blkptr_t *bp,
170    objset_t **osp);
171void dmu_objset_evict(objset_t *os);
172void dmu_objset_do_userquota_updates(objset_t *os, dmu_tx_t *tx);
173void dmu_objset_userquota_get_ids(dnode_t *dn, boolean_t before, dmu_tx_t *tx);
174boolean_t dmu_objset_userused_enabled(objset_t *os);
175int dmu_objset_userspace_upgrade(objset_t *os);
176boolean_t dmu_objset_userspace_present(objset_t *os);
177int dmu_fsname(const char *snapname, char *buf);
178
179void dmu_objset_evict_done(objset_t *os);
180
181void dmu_objset_init(void);
182void dmu_objset_fini(void);
183
184#ifdef	__cplusplus
185}
186#endif
187
188#endif /* _SYS_DMU_OBJSET_H */
189