[mirror_zfs-debian.git] / module / zfs / include / sys / dsl_pool.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.
 */

#ifndef	_SYS_DSL_POOL_H
#define	_SYS_DSL_POOL_H

#include <sys/spa.h>
#include <sys/txg.h>
#include <sys/txg_impl.h>
#include <sys/zfs_context.h>
#include <sys/zio.h>
#include <sys/dnode.h>
#include <sys/ddt.h>
#include <sys/arc.h>
#include <sys/bpobj.h>

#ifdef	__cplusplus
extern "C" {
#endif

struct objset;
struct dsl_dir;
struct dsl_dataset;
struct dsl_pool;
struct dmu_tx;
struct dsl_scan;

/* These macros are for indexing into the zfs_all_blkstats_t. */
#define	DMU_OT_DEFERRED	DMU_OT_NONE
#define	DMU_OT_TOTAL	DMU_OT_NUMTYPES

typedef struct zfs_blkstat {
	uint64_t	zb_count;
	uint64_t	zb_asize;
	uint64_t	zb_lsize;
	uint64_t	zb_psize;
	uint64_t	zb_gangs;
	uint64_t	zb_ditto_2_of_2_samevdev;
	uint64_t	zb_ditto_2_of_3_samevdev;
	uint64_t	zb_ditto_3_of_3_samevdev;
} zfs_blkstat_t;

typedef struct zfs_all_blkstats {
	zfs_blkstat_t	zab_type[DN_MAX_LEVELS + 1][DMU_OT_TOTAL + 1];
} zfs_all_blkstats_t;


typedef struct dsl_pool {
	/* Immutable */
	spa_t *dp_spa;
	struct objset *dp_meta_objset;
	struct dsl_dir *dp_root_dir;
	struct dsl_dir *dp_mos_dir;
	struct dsl_dir *dp_free_dir;
	struct dsl_dataset *dp_origin_snap;
	uint64_t dp_root_dir_obj;
	struct taskq *dp_vnrele_taskq;

	/* No lock needed - sync context only */
	blkptr_t dp_meta_rootbp;
	list_t dp_synced_datasets;
	hrtime_t dp_read_overhead;
	uint64_t dp_throughput; /* bytes per millisec */
	uint64_t dp_write_limit;
	uint64_t dp_tmp_userrefs_obj;
	bpobj_t dp_free_bpobj;

	struct dsl_scan *dp_scan;

	/* Uses dp_lock */
	kmutex_t dp_lock;
	uint64_t dp_space_towrite[TXG_SIZE];
	uint64_t dp_tempreserved[TXG_SIZE];

	/* Has its own locking */
	tx_state_t dp_tx;
	txg_list_t dp_dirty_datasets;
	txg_list_t dp_dirty_dirs;
	txg_list_t dp_sync_tasks;

	/*
	 * Protects administrative changes (properties, namespace)
	 * It is only held for write in syncing context.  Therefore
	 * syncing context does not need to ever have it for read, since
	 * nobody else could possibly have it for write.
	 */
	krwlock_t dp_config_rwlock;

	zfs_all_blkstats_t *dp_blkstats;
} dsl_pool_t;

int dsl_pool_open(spa_t *spa, uint64_t txg, dsl_pool_t **dpp);
void dsl_pool_close(dsl_pool_t *dp);
dsl_pool_t *dsl_pool_create(spa_t *spa, nvlist_t *zplprops, uint64_t txg);
void dsl_pool_sync(dsl_pool_t *dp, uint64_t txg);
void dsl_pool_sync_done(dsl_pool_t *dp, uint64_t txg);
int dsl_pool_sync_context(dsl_pool_t *dp);
uint64_t dsl_pool_adjustedsize(dsl_pool_t *dp, boolean_t netfree);
uint64_t dsl_pool_adjustedfree(dsl_pool_t *dp, boolean_t netfree);
int dsl_pool_tempreserve_space(dsl_pool_t *dp, uint64_t space, dmu_tx_t *tx);
void dsl_pool_tempreserve_clear(dsl_pool_t *dp, int64_t space, dmu_tx_t *tx);
void dsl_pool_memory_pressure(dsl_pool_t *dp);
void dsl_pool_willuse_space(dsl_pool_t *dp, int64_t space, dmu_tx_t *tx);
void dsl_free(dsl_pool_t *dp, uint64_t txg, const blkptr_t *bpp);
void dsl_free_sync(zio_t *pio, dsl_pool_t *dp, uint64_t txg,
    const blkptr_t *bpp);
int dsl_read(zio_t *pio, spa_t *spa, const blkptr_t *bpp, arc_buf_t *pbuf,
    arc_done_func_t *done, void *private, int priority, int zio_flags,
    uint32_t *arc_flags, const zbookmark_t *zb);
int dsl_read_nolock(zio_t *pio, spa_t *spa, const blkptr_t *bpp,
    arc_done_func_t *done, void *private, int priority, int zio_flags,
    uint32_t *arc_flags, const zbookmark_t *zb);
void dsl_pool_create_origin(dsl_pool_t *dp, dmu_tx_t *tx);
void dsl_pool_upgrade_clones(dsl_pool_t *dp, dmu_tx_t *tx);
void dsl_pool_upgrade_dir_clones(dsl_pool_t *dp, dmu_tx_t *tx);

taskq_t *dsl_pool_vnrele_taskq(dsl_pool_t *dp);

extern int dsl_pool_user_hold(dsl_pool_t *dp, uint64_t dsobj,
    const char *tag, uint64_t *now, dmu_tx_t *tx);
extern int dsl_pool_user_release(dsl_pool_t *dp, uint64_t dsobj,
    const char *tag, dmu_tx_t *tx);
extern void dsl_pool_clean_tmp_userrefs(dsl_pool_t *dp);
int dsl_pool_open_special_dir(dsl_pool_t *dp, const char *name, dsl_dir_t **);

#ifdef	__cplusplus
}
#endif

#endif /* _SYS_DSL_POOL_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.
34dc7c2f BB	23	*/
	24
	25	#ifndef _SYS_DSL_POOL_H
	26	#define _SYS_DSL_POOL_H
	27
34dc7c2f BB	28	#include <sys/spa.h>
	29	#include <sys/txg.h>
	30	#include <sys/txg_impl.h>
	31	#include <sys/zfs_context.h>
b128c09f BB	32	#include <sys/zio.h>
b128c09f BB	33	#include <sys/dnode.h>
428870ff BB	34	#include <sys/ddt.h>
	35	#include <sys/arc.h>
	36	#include <sys/bpobj.h>
34dc7c2f BB	37
	38	#ifdef __cplusplus
	39	extern "C" {
	40	#endif
	41
	42	struct objset;
	43	struct dsl_dir;
b128c09f BB	44	struct dsl_dataset;
	45	struct dsl_pool;
	46	struct dmu_tx;
428870ff	47	struct dsl_scan;
b128c09f BB	48
	49	/* These macros are for indexing into the zfs_all_blkstats_t. */
	50	#define DMU_OT_DEFERRED DMU_OT_NONE
	51	#define DMU_OT_TOTAL DMU_OT_NUMTYPES
	52
	53	typedef struct zfs_blkstat {
	54	uint64_t zb_count;
	55	uint64_t zb_asize;
	56	uint64_t zb_lsize;
	57	uint64_t zb_psize;
	58	uint64_t zb_gangs;
	59	uint64_t zb_ditto_2_of_2_samevdev;
	60	uint64_t zb_ditto_2_of_3_samevdev;
	61	uint64_t zb_ditto_3_of_3_samevdev;
	62	} zfs_blkstat_t;
	63
	64	typedef struct zfs_all_blkstats {
	65	zfs_blkstat_t zab_type[DN_MAX_LEVELS + 1][DMU_OT_TOTAL + 1];
	66	} zfs_all_blkstats_t;
	67
34dc7c2f BB	68
	69	typedef struct dsl_pool {
	70	/* Immutable */
	71	spa_t *dp_spa;
	72	struct objset *dp_meta_objset;
	73	struct dsl_dir *dp_root_dir;
	74	struct dsl_dir *dp_mos_dir;
428870ff	75	struct dsl_dir *dp_free_dir;
b128c09f	76	struct dsl_dataset *dp_origin_snap;
34dc7c2f	77	uint64_t dp_root_dir_obj;
9babb374	78	struct taskq *dp_vnrele_taskq;
34dc7c2f BB	79
	80	/* No lock needed - sync context only */
	81	blkptr_t dp_meta_rootbp;
	82	list_t dp_synced_datasets;
b128c09f	83	hrtime_t dp_read_overhead;
428870ff	84	uint64_t dp_throughput; /* bytes per millisec */
34dc7c2f	85	uint64_t dp_write_limit;
428870ff BB	86	uint64_t dp_tmp_userrefs_obj;
	87	bpobj_t dp_free_bpobj;
	88
	89	struct dsl_scan *dp_scan;
34dc7c2f BB	90
	91	/* Uses dp_lock */
	92	kmutex_t dp_lock;
	93	uint64_t dp_space_towrite[TXG_SIZE];
	94	uint64_t dp_tempreserved[TXG_SIZE];
	95
	96	/* Has its own locking */
	97	tx_state_t dp_tx;
	98	txg_list_t dp_dirty_datasets;
	99	txg_list_t dp_dirty_dirs;
	100	txg_list_t dp_sync_tasks;
	101
	102	/*
	103	* Protects administrative changes (properties, namespace)
	104	* It is only held for write in syncing context. Therefore
	105	* syncing context does not need to ever have it for read, since
	106	* nobody else could possibly have it for write.
	107	*/
	108	krwlock_t dp_config_rwlock;
b128c09f BB	109
b128c09f BB	110	zfs_all_blkstats_t *dp_blkstats;
34dc7c2f BB	111	} dsl_pool_t;
	112
	113	int dsl_pool_open(spa_t spa, uint64_t txg, dsl_pool_t *dpp);
	114	void dsl_pool_close(dsl_pool_t *dp);
b128c09f	115	dsl_pool_t dsl_pool_create(spa_t spa, nvlist_t *zplprops, uint64_t txg);
34dc7c2f	116	void dsl_pool_sync(dsl_pool_t *dp, uint64_t txg);
428870ff	117	void dsl_pool_sync_done(dsl_pool_t *dp, uint64_t txg);
34dc7c2f BB	118	int dsl_pool_sync_context(dsl_pool_t *dp);
34dc7c2f BB	119	uint64_t dsl_pool_adjustedsize(dsl_pool_t *dp, boolean_t netfree);
428870ff	120	uint64_t dsl_pool_adjustedfree(dsl_pool_t *dp, boolean_t netfree);
34dc7c2f BB	121	int dsl_pool_tempreserve_space(dsl_pool_t dp, uint64_t space, dmu_tx_t tx);
	122	void dsl_pool_tempreserve_clear(dsl_pool_t dp, int64_t space, dmu_tx_t tx);
	123	void dsl_pool_memory_pressure(dsl_pool_t *dp);
	124	void dsl_pool_willuse_space(dsl_pool_t dp, int64_t space, dmu_tx_t tx);
428870ff BB	125	void dsl_free(dsl_pool_t dp, uint64_t txg, const blkptr_t bpp);
	126	void dsl_free_sync(zio_t pio, dsl_pool_t dp, uint64_t txg,
	127	const blkptr_t *bpp);
	128	int dsl_read(zio_t pio, spa_t spa, const blkptr_t bpp, arc_buf_t pbuf,
	129	arc_done_func_t done, void private, int priority, int zio_flags,
	130	uint32_t arc_flags, const zbookmark_t zb);
	131	int dsl_read_nolock(zio_t pio, spa_t spa, const blkptr_t *bpp,
	132	arc_done_func_t done, void private, int priority, int zio_flags,
	133	uint32_t arc_flags, const zbookmark_t zb);
b128c09f BB	134	void dsl_pool_create_origin(dsl_pool_t dp, dmu_tx_t tx);
b128c09f BB	135	void dsl_pool_upgrade_clones(dsl_pool_t dp, dmu_tx_t tx);
428870ff	136	void dsl_pool_upgrade_dir_clones(dsl_pool_t dp, dmu_tx_t tx);
34dc7c2f	137
9babb374 BB	138	taskq_t dsl_pool_vnrele_taskq(dsl_pool_t dp);
9babb374 BB	139
428870ff BB	140	extern int dsl_pool_user_hold(dsl_pool_t *dp, uint64_t dsobj,
	141	const char tag, uint64_t now, dmu_tx_t *tx);
	142	extern int dsl_pool_user_release(dsl_pool_t *dp, uint64_t dsobj,
	143	const char tag, dmu_tx_t tx);
	144	extern void dsl_pool_clean_tmp_userrefs(dsl_pool_t *dp);
	145	int dsl_pool_open_special_dir(dsl_pool_t dp, const char name, dsl_dir_t **);
	146
34dc7c2f BB	147	#ifdef __cplusplus
	148	}
	149	#endif
	150
	151	#endif /* _SYS_DSL_POOL_H */