[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) 2012, 2016 by Delphix. All rights reserved.
 * Copyright (c) 2013 by Saso Kiselkov. 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)
#define	OBJSET_FLAG_USEROBJACCOUNTING_COMPLETE	(1ULL<<1)

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;

typedef int (*dmu_objset_upgrade_cb_t)(objset_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;

	/*
	 * Pointer is constant; the blkptr it points to is protected by
	 * os_dsl_dataset->ds_bp_rwlock
	 */
	blkptr_t *os_rootbp;

	/* no lock needed: */
	struct dmu_tx *os_synctx; /* XXX sketchy */
	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;

	/* kernel thread to upgrade this dataset */
	kmutex_t os_upgrade_lock;
	taskqid_t os_upgrade_id;
	dmu_objset_upgrade_cb_t os_upgrade_cb;
	boolean_t os_upgrade_exit;
	int os_upgrade_status;
};

#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)

/* 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);
boolean_t dmu_objset_userobjused_enabled(objset_t *os);
boolean_t dmu_objset_userobjspace_upgradable(objset_t *os);
void dmu_objset_userobjspace_upgrade(objset_t *os);
boolean_t dmu_objset_userobjspace_present(objset_t *os);

int dmu_fsname(const char *snapname, char *buf);

void dmu_objset_evict_done(objset_t *os);
void dmu_objset_willuse_space(objset_t *os, int64_t space, dmu_tx_t *tx);

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.
3ec3bc21	23	* Copyright (c) 2012, 2016 by Delphix. All rights reserved.
3a17a7a9	24	* Copyright (c) 2013 by Saso Kiselkov. 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	58	#define OBJSET_FLAG_USERACCOUNTING_COMPLETE (1ULL<<0)
1de321e6	59	#define OBJSET_FLAG_USEROBJACCOUNTING_COMPLETE (1ULL<<1)
9babb374	60
34dc7c2f BB	61	typedef struct objset_phys {
	62	dnode_phys_t os_meta_dnode;
	63	zil_header_t os_zil_header;
	64	uint64_t os_type;
9babb374 BB	65	uint64_t os_flags;
	66	char os_pad[OBJSET_PHYS_SIZE - sizeof (dnode_phys_t)*3 -
	67	sizeof (zil_header_t) - sizeof (uint64_t)*2];
	68	dnode_phys_t os_userused_dnode;
	69	dnode_phys_t os_groupused_dnode;
34dc7c2f BB	70	} objset_phys_t;
34dc7c2f BB	71
1de321e6 JX	72	typedef int (dmu_objset_upgrade_cb_t)(objset_t );
1de321e6 JX	73
34dc7c2f	74	struct objset {
34dc7c2f BB	75	/* Immutable: */
	76	struct dsl_dataset *os_dsl_dataset;
	77	spa_t *os_spa;
	78	arc_buf_t *os_phys_buf;
	79	objset_phys_t *os_phys;
572e2857	80	/*
0c66c32d JG	81	* The following "special" dnodes have no parent, are exempt
	82	* from dnode_move(), and are not recorded in os_dnodes, but they
	83	* root their descendents in this objset using handles anyway, so
	84	* that all access to dnodes from dbufs consistently uses handles.
572e2857 BB	85	*/
	86	dnode_handle_t os_meta_dnode;
	87	dnode_handle_t os_userused_dnode;
	88	dnode_handle_t os_groupused_dnode;
34dc7c2f	89	zilog_t *os_zil;
428870ff	90
0c66c32d JG	91	list_node_t os_evicting_node;
0c66c32d JG	92
428870ff	93	/* can change, under dsl_dir's locks: */
50c957f7	94	uint64_t os_dnodesize; /* default dnode size for new objects */
faf0f58c MA	95	enum zio_checksum os_checksum;
faf0f58c MA	96	enum zio_compress os_compress;
428870ff	97	uint8_t os_copies;
faf0f58c MA	98	enum zio_checksum os_dedup_checksum;
	99	boolean_t os_dedup_verify;
	100	zfs_logbias_op_t os_logbias;
	101	zfs_cache_type_t os_primary_cache;
	102	zfs_cache_type_t os_secondary_cache;
	103	zfs_sync_type_t os_sync;
	104	zfs_redundant_metadata_type_t os_redundant_metadata;
f1512ee6	105	int os_recordsize;
34dc7c2f	106
cc9bb3e5 GM	107	/*
	108	* Pointer is constant; the blkptr it points to is protected by
	109	* os_dsl_dataset->ds_bp_rwlock
	110	*/
	111	blkptr_t *os_rootbp;
	112
34dc7c2f BB	113	/* no lock needed: */
34dc7c2f BB	114	struct dmu_tx os_synctx; / XXX sketchy */
b128c09f	115	zil_header_t os_zil_header;
9babb374 BB	116	list_t os_synced_dnodes;
9babb374 BB	117	uint64_t os_flags;
68cbd56e NB	118	uint64_t os_freed_dnodes;
68cbd56e NB	119	boolean_t os_rescan_dnodes;
34dc7c2f BB	120
	121	/* Protected by os_obj_lock */
	122	kmutex_t os_obj_lock;
	123	uint64_t os_obj_next;
	124
	125	/* Protected by os_lock */
	126	kmutex_t os_lock;
	127	list_t os_dirty_dnodes[TXG_SIZE];
	128	list_t os_free_dnodes[TXG_SIZE];
	129	list_t os_dnodes;
	130	list_t os_downgraded_dbufs;
	131
	132	/* stuff we store for the user */
	133	kmutex_t os_user_ptr_lock;
	134	void *os_user_ptr;
428870ff	135	sa_os_t *os_sa;
1de321e6 JX	136
	137	/* kernel thread to upgrade this dataset */
	138	kmutex_t os_upgrade_lock;
	139	taskqid_t os_upgrade_id;
	140	dmu_objset_upgrade_cb_t os_upgrade_cb;
	141	boolean_t os_upgrade_exit;
	142	int os_upgrade_status;
428870ff BB	143	};
	144
	145	#define DMU_META_OBJSET 0
34dc7c2f	146	#define DMU_META_DNODE_OBJECT 0
9babb374	147	#define DMU_OBJECT_IS_SPECIAL(obj) ((int64_t)(obj) <= 0)
572e2857 BB	148	#define DMU_META_DNODE(os) ((os)->os_meta_dnode.dnh_dnode)
	149	#define DMU_USERUSED_DNODE(os) ((os)->os_userused_dnode.dnh_dnode)
	150	#define DMU_GROUPUSED_DNODE(os) ((os)->os_groupused_dnode.dnh_dnode)
34dc7c2f	151
b128c09f BB	152	#define DMU_OS_IS_L2CACHEABLE(os) \
	153	((os)->os_secondary_cache == ZFS_CACHE_ALL \|\| \
	154	(os)->os_secondary_cache == ZFS_CACHE_METADATA)
	155
34dc7c2f	156	/* called from zpl */
428870ff BB	157	int dmu_objset_hold(const char name, void tag, objset_t **osp);
	158	int dmu_objset_own(const char *name, dmu_objset_type_t type,
	159	boolean_t readonly, void tag, objset_t *osp);
9c43027b AJ	160	int dmu_objset_own_obj(struct dsl_pool *dp, uint64_t obj,
9c43027b AJ	161	dmu_objset_type_t type, boolean_t readonly, void tag, objset_t *osp);
831baf06	162	void dmu_objset_refresh_ownership(objset_t os, void tag);
428870ff BB	163	void dmu_objset_rele(objset_t os, void tag);
	164	void dmu_objset_disown(objset_t os, void tag);
	165	int dmu_objset_from_ds(struct dsl_dataset ds, objset_t *osp);
	166
34dc7c2f BB	167	void dmu_objset_stats(objset_t os, nvlist_t nv);
	168	void dmu_objset_fast_stat(objset_t os, dmu_objset_stats_t stat);
	169	void dmu_objset_space(objset_t os, uint64_t refdbytesp, uint64_t *availbytesp,
	170	uint64_t usedobjsp, uint64_t availobjsp);
	171	uint64_t dmu_objset_fsid_guid(objset_t *os);
13fe0198 MA	172	int dmu_objset_find_dp(struct dsl_pool *dp, uint64_t ddobj,
	173	int func(struct dsl_pool , struct dsl_dataset , void *),
	174	void *arg, int flags);
	175	void dmu_objset_evict_dbufs(objset_t *os);
428870ff	176	timestruc_t dmu_objset_snap_cmtime(objset_t *os);
34dc7c2f BB	177
34dc7c2f BB	178	/* called from dsl */
428870ff BB	179	void dmu_objset_sync(objset_t os, zio_t zio, dmu_tx_t *tx);
	180	boolean_t dmu_objset_is_dirty(objset_t *os, uint64_t txg);
	181	objset_t dmu_objset_create_impl(spa_t spa, struct dsl_dataset *ds,
34dc7c2f BB	182	blkptr_t bp, dmu_objset_type_t type, dmu_tx_t tx);
34dc7c2f BB	183	int dmu_objset_open_impl(spa_t spa, struct dsl_dataset ds, blkptr_t *bp,
428870ff BB	184	objset_t **osp);
	185	void dmu_objset_evict(objset_t *os);
	186	void dmu_objset_do_userquota_updates(objset_t os, dmu_tx_t tx);
	187	void dmu_objset_userquota_get_ids(dnode_t dn, boolean_t before, dmu_tx_t tx);
	188	boolean_t dmu_objset_userused_enabled(objset_t *os);
9babb374 BB	189	int dmu_objset_userspace_upgrade(objset_t *os);
9babb374 BB	190	boolean_t dmu_objset_userspace_present(objset_t *os);
1de321e6	191	boolean_t dmu_objset_userobjused_enabled(objset_t *os);
126ae9f4	192	boolean_t dmu_objset_userobjspace_upgradable(objset_t *os);
1de321e6 JX	193	void dmu_objset_userobjspace_upgrade(objset_t *os);
	194	boolean_t dmu_objset_userobjspace_present(objset_t *os);
	195
13fe0198	196	int dmu_fsname(const char snapname, char buf);
34dc7c2f	197
0c66c32d	198	void dmu_objset_evict_done(objset_t *os);
3ec3bc21	199	void dmu_objset_willuse_space(objset_t os, int64_t space, dmu_tx_t tx);
0c66c32d	200
572e2857 BB	201	void dmu_objset_init(void);
	202	void dmu_objset_fini(void);
	203
34dc7c2f BB	204	#ifdef __cplusplus
	205	}
	206	#endif
	207
	208	#endif /* _SYS_DMU_OBJSET_H */