[mirror_zfs.git] / include / sys / dmu_objset.h

/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License (the "License").
 * You may not use this file except in compliance with the License.
 *
 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
 * or http://www.opensolaris.org/os/licensing.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information: Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 */
/*
 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
 * Copyright (c) 2013 by Saso Kiselkov. All rights reserved.
 * Copyright (c) 2012, 2014 by Delphix. All rights reserved.
 * Copyright (c) 2014 Spectra Logic Corporation, All rights reserved.
 */

/* Portions Copyright 2010 Robert Milkowski */

#ifndef	_SYS_DMU_OBJSET_H
#define	_SYS_DMU_OBJSET_H

#include <sys/spa.h>
#include <sys/arc.h>
#include <sys/txg.h>
#include <sys/zfs_context.h>
#include <sys/dnode.h>
#include <sys/zio.h>
#include <sys/zil.h>
#include <sys/sa.h>

#ifdef	__cplusplus
extern "C" {
#endif

extern krwlock_t os_lock;

struct dsl_pool;
struct dsl_dataset;
struct dmu_tx;

#define	OBJSET_PHYS_SIZE 2048
#define	OBJSET_OLD_PHYS_SIZE 1024

#define	OBJSET_BUF_HAS_USERUSED(buf) \
	(arc_buf_size(buf) > OBJSET_OLD_PHYS_SIZE)

#define	OBJSET_FLAG_USERACCOUNTING_COMPLETE	(1ULL<<0)

typedef struct objset_phys {
	dnode_phys_t os_meta_dnode;
	zil_header_t os_zil_header;
	uint64_t os_type;
	uint64_t os_flags;
	char os_pad[OBJSET_PHYS_SIZE - sizeof (dnode_phys_t)*3 -
	    sizeof (zil_header_t) - sizeof (uint64_t)*2];
	dnode_phys_t os_userused_dnode;
	dnode_phys_t os_groupused_dnode;
} objset_phys_t;

struct objset {
	/* Immutable: */
	struct dsl_dataset *os_dsl_dataset;
	spa_t *os_spa;
	arc_buf_t *os_phys_buf;
	objset_phys_t *os_phys;
	/*
	 * The following "special" dnodes have no parent, are exempt
	 * from dnode_move(), and are not recorded in os_dnodes, but they
	 * root their descendents in this objset using handles anyway, so
	 * that all access to dnodes from dbufs consistently uses handles.
	 */
	dnode_handle_t os_meta_dnode;
	dnode_handle_t os_userused_dnode;
	dnode_handle_t os_groupused_dnode;
	zilog_t *os_zil;

	list_node_t os_evicting_node;

	/* can change, under dsl_dir's locks: */
	uint64_t os_dnodesize; /* default dnode size for new objects */
	enum zio_checksum os_checksum;
	enum zio_compress os_compress;
	uint8_t os_copies;
	enum zio_checksum os_dedup_checksum;
	boolean_t os_dedup_verify;
	zfs_logbias_op_t os_logbias;
	zfs_cache_type_t os_primary_cache;
	zfs_cache_type_t os_secondary_cache;
	zfs_sync_type_t os_sync;
	zfs_redundant_metadata_type_t os_redundant_metadata;
	int os_recordsize;

	/* no lock needed: */
	struct dmu_tx *os_synctx; /* XXX sketchy */
	blkptr_t *os_rootbp;
	zil_header_t os_zil_header;
	list_t os_synced_dnodes;
	uint64_t os_flags;
	uint64_t os_freed_dnodes;
	boolean_t os_rescan_dnodes;

	/* Protected by os_obj_lock */
	kmutex_t os_obj_lock;
	uint64_t os_obj_next;

	/* Protected by os_lock */
	kmutex_t os_lock;
	list_t os_dirty_dnodes[TXG_SIZE];
	list_t os_free_dnodes[TXG_SIZE];
	list_t os_dnodes;
	list_t os_downgraded_dbufs;

	/* stuff we store for the user */
	kmutex_t os_user_ptr_lock;
	void *os_user_ptr;
	sa_os_t *os_sa;
};

#define	DMU_META_OBJSET		0
#define	DMU_META_DNODE_OBJECT	0
#define	DMU_OBJECT_IS_SPECIAL(obj) ((int64_t)(obj) <= 0)
#define	DMU_META_DNODE(os)	((os)->os_meta_dnode.dnh_dnode)
#define	DMU_USERUSED_DNODE(os)	((os)->os_userused_dnode.dnh_dnode)
#define	DMU_GROUPUSED_DNODE(os)	((os)->os_groupused_dnode.dnh_dnode)

#define	DMU_OS_IS_L2CACHEABLE(os)				\
	((os)->os_secondary_cache == ZFS_CACHE_ALL ||		\
	(os)->os_secondary_cache == ZFS_CACHE_METADATA)

#define	DMU_OS_IS_L2COMPRESSIBLE(os)	(zfs_mdcomp_disable == B_FALSE)

/* called from zpl */
int dmu_objset_hold(const char *name, void *tag, objset_t **osp);
int dmu_objset_own(const char *name, dmu_objset_type_t type,
    boolean_t readonly, void *tag, objset_t **osp);
int dmu_objset_own_obj(struct dsl_pool *dp, uint64_t obj,
    dmu_objset_type_t type, boolean_t readonly, void *tag, objset_t **osp);
void dmu_objset_refresh_ownership(objset_t *os, void *tag);
void dmu_objset_rele(objset_t *os, void *tag);
void dmu_objset_disown(objset_t *os, void *tag);
int dmu_objset_from_ds(struct dsl_dataset *ds, objset_t **osp);

void dmu_objset_stats(objset_t *os, nvlist_t *nv);
void dmu_objset_fast_stat(objset_t *os, dmu_objset_stats_t *stat);
void dmu_objset_space(objset_t *os, uint64_t *refdbytesp, uint64_t *availbytesp,
    uint64_t *usedobjsp, uint64_t *availobjsp);
uint64_t dmu_objset_fsid_guid(objset_t *os);
int dmu_objset_find_dp(struct dsl_pool *dp, uint64_t ddobj,
    int func(struct dsl_pool *, struct dsl_dataset *, void *),
    void *arg, int flags);
void dmu_objset_evict_dbufs(objset_t *os);
timestruc_t dmu_objset_snap_cmtime(objset_t *os);

/* called from dsl */
void dmu_objset_sync(objset_t *os, zio_t *zio, dmu_tx_t *tx);
boolean_t dmu_objset_is_dirty(objset_t *os, uint64_t txg);
objset_t *dmu_objset_create_impl(spa_t *spa, struct dsl_dataset *ds,
    blkptr_t *bp, dmu_objset_type_t type, dmu_tx_t *tx);
int dmu_objset_open_impl(spa_t *spa, struct dsl_dataset *ds, blkptr_t *bp,
    objset_t **osp);
void dmu_objset_evict(objset_t *os);
void dmu_objset_do_userquota_updates(objset_t *os, dmu_tx_t *tx);
void dmu_objset_userquota_get_ids(dnode_t *dn, boolean_t before, dmu_tx_t *tx);
boolean_t dmu_objset_userused_enabled(objset_t *os);
int dmu_objset_userspace_upgrade(objset_t *os);
boolean_t dmu_objset_userspace_present(objset_t *os);
int dmu_fsname(const char *snapname, char *buf);

void dmu_objset_evict_done(objset_t *os);

void dmu_objset_init(void);
void dmu_objset_fini(void);

#ifdef	__cplusplus
}
#endif

#endif /* _SYS_DMU_OBJSET_H */
Commit	Line	Data
34dc7c2f BB	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	/*
428870ff	22	* Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
3a17a7a9	23	* Copyright (c) 2013 by Saso Kiselkov. All rights reserved.
faf0f58c	24	* Copyright (c) 2012, 2014 by Delphix. All rights reserved.
0c66c32d	25	* Copyright (c) 2014 Spectra Logic Corporation, All rights reserved.
34dc7c2f BB	26	*/
34dc7c2f BB	27
428870ff BB	28	/* Portions Copyright 2010 Robert Milkowski */
428870ff BB	29
34dc7c2f BB	30	#ifndef _SYS_DMU_OBJSET_H
	31	#define _SYS_DMU_OBJSET_H
	32
34dc7c2f BB	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>
428870ff	40	#include <sys/sa.h>
34dc7c2f BB	41
	42	#ifdef __cplusplus
	43	extern "C" {
	44	#endif
	45
572e2857 BB	46	extern krwlock_t os_lock;
572e2857 BB	47
13fe0198	48	struct dsl_pool;
34dc7c2f BB	49	struct dsl_dataset;
34dc7c2f BB	50	struct dmu_tx;
34dc7c2f	51
9babb374 BB	52	#define OBJSET_PHYS_SIZE 2048
	53	#define OBJSET_OLD_PHYS_SIZE 1024
	54
428870ff BB	55	#define OBJSET_BUF_HAS_USERUSED(buf) \
	56	(arc_buf_size(buf) > OBJSET_OLD_PHYS_SIZE)
	57
9babb374 BB	58	#define OBJSET_FLAG_USERACCOUNTING_COMPLETE (1ULL<<0)
9babb374 BB	59
34dc7c2f BB	60	typedef struct objset_phys {
	61	dnode_phys_t os_meta_dnode;
	62	zil_header_t os_zil_header;
	63	uint64_t os_type;
9babb374 BB	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;
34dc7c2f BB	69	} objset_phys_t;
	70
	71	struct objset {
34dc7c2f BB	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;
572e2857	77	/*
0c66c32d JG	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.
572e2857 BB	82	*/
	83	dnode_handle_t os_meta_dnode;
	84	dnode_handle_t os_userused_dnode;
	85	dnode_handle_t os_groupused_dnode;
34dc7c2f	86	zilog_t *os_zil;
428870ff	87
0c66c32d JG	88	list_node_t os_evicting_node;
0c66c32d JG	89
428870ff	90	/* can change, under dsl_dir's locks: */
50c957f7	91	uint64_t os_dnodesize; /* default dnode size for new objects */
faf0f58c MA	92	enum zio_checksum os_checksum;
faf0f58c MA	93	enum zio_compress os_compress;
428870ff	94	uint8_t os_copies;
faf0f58c MA	95	enum zio_checksum os_dedup_checksum;
	96	boolean_t os_dedup_verify;
	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;
f1512ee6	102	int os_recordsize;
34dc7c2f BB	103
	104	/* no lock needed: */
	105	struct dmu_tx os_synctx; / XXX sketchy */
	106	blkptr_t *os_rootbp;
b128c09f	107	zil_header_t os_zil_header;
9babb374 BB	108	list_t os_synced_dnodes;
9babb374 BB	109	uint64_t os_flags;
68cbd56e NB	110	uint64_t os_freed_dnodes;
68cbd56e NB	111	boolean_t os_rescan_dnodes;
34dc7c2f BB	112
	113	/* Protected by os_obj_lock */
	114	kmutex_t os_obj_lock;
	115	uint64_t os_obj_next;
	116
	117	/* Protected by os_lock */
	118	kmutex_t os_lock;
	119	list_t os_dirty_dnodes[TXG_SIZE];
	120	list_t os_free_dnodes[TXG_SIZE];
	121	list_t os_dnodes;
	122	list_t os_downgraded_dbufs;
	123
	124	/* stuff we store for the user */
	125	kmutex_t os_user_ptr_lock;
	126	void *os_user_ptr;
428870ff BB	127	sa_os_t *os_sa;
	128	};
	129
	130	#define DMU_META_OBJSET 0
34dc7c2f	131	#define DMU_META_DNODE_OBJECT 0
9babb374	132	#define DMU_OBJECT_IS_SPECIAL(obj) ((int64_t)(obj) <= 0)
572e2857 BB	133	#define DMU_META_DNODE(os) ((os)->os_meta_dnode.dnh_dnode)
	134	#define DMU_USERUSED_DNODE(os) ((os)->os_userused_dnode.dnh_dnode)
	135	#define DMU_GROUPUSED_DNODE(os) ((os)->os_groupused_dnode.dnh_dnode)
34dc7c2f	136
b128c09f BB	137	#define DMU_OS_IS_L2CACHEABLE(os) \
	138	((os)->os_secondary_cache == ZFS_CACHE_ALL \|\| \
	139	(os)->os_secondary_cache == ZFS_CACHE_METADATA)
	140
4e59f475	141	#define DMU_OS_IS_L2COMPRESSIBLE(os) (zfs_mdcomp_disable == B_FALSE)
3a17a7a9	142
34dc7c2f	143	/* called from zpl */
428870ff BB	144	int dmu_objset_hold(const char name, void tag, objset_t **osp);
	145	int dmu_objset_own(const char *name, dmu_objset_type_t type,
	146	boolean_t readonly, void tag, objset_t *osp);
9c43027b AJ	147	int dmu_objset_own_obj(struct dsl_pool *dp, uint64_t obj,
9c43027b AJ	148	dmu_objset_type_t type, boolean_t readonly, void tag, objset_t *osp);
831baf06	149	void dmu_objset_refresh_ownership(objset_t os, void tag);
428870ff BB	150	void dmu_objset_rele(objset_t os, void tag);
	151	void dmu_objset_disown(objset_t os, void tag);
	152	int dmu_objset_from_ds(struct dsl_dataset ds, objset_t *osp);
	153
34dc7c2f BB	154	void dmu_objset_stats(objset_t os, nvlist_t nv);
	155	void dmu_objset_fast_stat(objset_t os, dmu_objset_stats_t stat);
	156	void dmu_objset_space(objset_t os, uint64_t refdbytesp, uint64_t *availbytesp,
	157	uint64_t usedobjsp, uint64_t availobjsp);
	158	uint64_t dmu_objset_fsid_guid(objset_t *os);
13fe0198 MA	159	int dmu_objset_find_dp(struct dsl_pool *dp, uint64_t ddobj,
	160	int func(struct dsl_pool , struct dsl_dataset , void *),
	161	void *arg, int flags);
	162	void dmu_objset_evict_dbufs(objset_t *os);
428870ff	163	timestruc_t dmu_objset_snap_cmtime(objset_t *os);
34dc7c2f BB	164
34dc7c2f BB	165	/* called from dsl */
428870ff BB	166	void dmu_objset_sync(objset_t os, zio_t zio, dmu_tx_t *tx);
	167	boolean_t dmu_objset_is_dirty(objset_t *os, uint64_t txg);
	168	objset_t dmu_objset_create_impl(spa_t spa, struct dsl_dataset *ds,
34dc7c2f BB	169	blkptr_t bp, dmu_objset_type_t type, dmu_tx_t tx);
34dc7c2f BB	170	int dmu_objset_open_impl(spa_t spa, struct dsl_dataset ds, blkptr_t *bp,
428870ff BB	171	objset_t **osp);
	172	void dmu_objset_evict(objset_t *os);
	173	void dmu_objset_do_userquota_updates(objset_t os, dmu_tx_t tx);
	174	void dmu_objset_userquota_get_ids(dnode_t dn, boolean_t before, dmu_tx_t tx);
	175	boolean_t dmu_objset_userused_enabled(objset_t *os);
9babb374 BB	176	int dmu_objset_userspace_upgrade(objset_t *os);
9babb374 BB	177	boolean_t dmu_objset_userspace_present(objset_t *os);
13fe0198	178	int dmu_fsname(const char snapname, char buf);
34dc7c2f	179
0c66c32d JG	180	void dmu_objset_evict_done(objset_t *os);
0c66c32d JG	181
572e2857 BB	182	void dmu_objset_init(void);
	183	void dmu_objset_fini(void);
	184
34dc7c2f BB	185	#ifdef __cplusplus
	186	}
	187	#endif
	188
	189	#endif /* _SYS_DMU_OBJSET_H */