dmu_objset.h revision 503ad85c168c7992ccc310af845a581cff3c72b5
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 2009 Sun Microsystems, Inc.  All rights reserved.
23 * Use is subject to license terms.
24 */
25
26#ifndef	_SYS_DMU_OBJSET_H
27#define	_SYS_DMU_OBJSET_H
28
29#include <sys/spa.h>
30#include <sys/arc.h>
31#include <sys/txg.h>
32#include <sys/zfs_context.h>
33#include <sys/dnode.h>
34#include <sys/zio.h>
35#include <sys/zil.h>
36
37#ifdef	__cplusplus
38extern "C" {
39#endif
40
41struct dsl_dataset;
42struct dmu_tx;
43
44#define	OBJSET_PHYS_SIZE 2048
45#define	OBJSET_OLD_PHYS_SIZE 1024
46
47#define	OBJSET_FLAG_USERACCOUNTING_COMPLETE	(1ULL<<0)
48
49typedef struct objset_phys {
50	dnode_phys_t os_meta_dnode;
51	zil_header_t os_zil_header;
52	uint64_t os_type;
53	uint64_t os_flags;
54	char os_pad[OBJSET_PHYS_SIZE - sizeof (dnode_phys_t)*3 -
55	    sizeof (zil_header_t) - sizeof (uint64_t)*2];
56	dnode_phys_t os_userused_dnode;
57	dnode_phys_t os_groupused_dnode;
58} objset_phys_t;
59
60struct objset {
61	/* Immutable: */
62	struct dsl_dataset *os_dsl_dataset;
63	spa_t *os_spa;
64	arc_buf_t *os_phys_buf;
65	objset_phys_t *os_phys;
66	dnode_t *os_meta_dnode;
67	dnode_t *os_userused_dnode;
68	dnode_t *os_groupused_dnode;
69	zilog_t *os_zil;
70	uint8_t os_checksum;	/* can change, under dsl_dir's locks */
71	uint8_t os_compress;	/* can change, under dsl_dir's locks */
72	uint8_t os_copies;	/* can change, under dsl_dir's locks */
73	uint8_t os_primary_cache;	/* can change, under dsl_dir's locks */
74	uint8_t os_secondary_cache;	/* can change, under dsl_dir's locks */
75
76	/* no lock needed: */
77	struct dmu_tx *os_synctx; /* XXX sketchy */
78	blkptr_t *os_rootbp;
79	zil_header_t os_zil_header;
80	list_t os_synced_dnodes;
81	uint64_t os_flags;
82
83	/* Protected by os_obj_lock */
84	kmutex_t os_obj_lock;
85	uint64_t os_obj_next;
86
87	/* Protected by os_lock */
88	kmutex_t os_lock;
89	list_t os_dirty_dnodes[TXG_SIZE];
90	list_t os_free_dnodes[TXG_SIZE];
91	list_t os_dnodes;
92	list_t os_downgraded_dbufs;
93
94	/* stuff we store for the user */
95	kmutex_t os_user_ptr_lock;
96	void *os_user_ptr;
97};
98
99#define	DMU_META_DNODE_OBJECT	0
100#define	DMU_OBJECT_IS_SPECIAL(obj) ((int64_t)(obj) <= 0)
101
102#define	DMU_OS_IS_L2CACHEABLE(os)				\
103	((os)->os_secondary_cache == ZFS_CACHE_ALL ||		\
104	(os)->os_secondary_cache == ZFS_CACHE_METADATA)
105
106/* called from zpl */
107int dmu_objset_hold(const char *name, void *tag, objset_t **osp);
108int dmu_objset_own(const char *name, dmu_objset_type_t type,
109    boolean_t readonly, void *tag, objset_t **osp);
110void dmu_objset_rele(objset_t *os, void *tag);
111void dmu_objset_disown(objset_t *os, void *tag);
112int dmu_objset_from_ds(struct dsl_dataset *ds, objset_t **osp);
113
114int dmu_objset_create(const char *name, dmu_objset_type_t type, uint64_t flags,
115    void (*func)(objset_t *os, void *arg, cred_t *cr, dmu_tx_t *tx), void *arg);
116int dmu_objset_clone(const char *name, struct dsl_dataset *clone_origin,
117    uint64_t flags);
118int dmu_objset_destroy(const char *name, boolean_t defer);
119int dmu_objset_snapshot(char *fsname, char *snapname, nvlist_t *props,
120    boolean_t recursive);
121void dmu_objset_stats(objset_t *os, nvlist_t *nv);
122void dmu_objset_fast_stat(objset_t *os, dmu_objset_stats_t *stat);
123void dmu_objset_space(objset_t *os, uint64_t *refdbytesp, uint64_t *availbytesp,
124    uint64_t *usedobjsp, uint64_t *availobjsp);
125uint64_t dmu_objset_fsid_guid(objset_t *os);
126int dmu_objset_find(char *name, int func(char *, void *), void *arg,
127    int flags);
128int dmu_objset_find_spa(spa_t *spa, const char *name,
129    int func(spa_t *, uint64_t, const char *, void *), void *arg, int flags);
130int dmu_objset_prefetch(char *name, void *arg);
131void dmu_objset_byteswap(void *buf, size_t size);
132int dmu_objset_evict_dbufs(objset_t *os);
133
134/* called from dsl */
135void dmu_objset_sync(objset_t *os, zio_t *zio, dmu_tx_t *tx);
136objset_t *dmu_objset_create_impl(spa_t *spa, struct dsl_dataset *ds,
137    blkptr_t *bp, dmu_objset_type_t type, dmu_tx_t *tx);
138int dmu_objset_open_impl(spa_t *spa, struct dsl_dataset *ds, blkptr_t *bp,
139    objset_t **osp);
140void dmu_objset_evict(objset_t *os);
141void dmu_objset_do_userquota_callbacks(objset_t *os, dmu_tx_t *tx);
142boolean_t dmu_objset_userused_enabled(objset_t *os);
143int dmu_objset_userspace_upgrade(objset_t *os);
144boolean_t dmu_objset_userspace_present(objset_t *os);
145
146#ifdef	__cplusplus
147}
148#endif
149
150#endif /* _SYS_DMU_OBJSET_H */
151