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