[mirror_zfs-debian.git] / include / sys / dsl_synctask.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, 2014 by Delphix. All rights reserved.
 */

#ifndef	_SYS_DSL_SYNCTASK_H
#define	_SYS_DSL_SYNCTASK_H

#include <sys/txg.h>
#include <sys/zfs_context.h>

#ifdef	__cplusplus
extern "C" {
#endif

struct dsl_pool;

typedef int (dsl_checkfunc_t)(void *, dmu_tx_t *);
typedef void (dsl_syncfunc_t)(void *, dmu_tx_t *);

typedef enum zfs_space_check {
	/*
	 * Normal space check: if there is less than 3.2% free space,
	 * the operation will fail.  Operations which are logically
	 * creating things should use this (e.g. "zfs create", "zfs snapshot").
	 * User writes (via the ZPL / ZVOL) also fail at this point.
	 */
	ZFS_SPACE_CHECK_NORMAL,

	/*
	 * Space check allows use of half the slop space.  If there
	 * is less than 1.6% free space, the operation will fail.  Most
	 * operations should use this (e.g. "zfs set", "zfs rename"),
	 * because we want them to succeed even after user writes are failing,
	 * so that they can be used as part of the space recovery process.
	 */
	ZFS_SPACE_CHECK_RESERVED,

	/*
	 * No space check is performed.  Only operations which we expect to
	 * result in a net reduction in space should use this
	 * (e.g. "zfs destroy". Setting quotas & reservations also uses
	 * this because it needs to circumvent the quota/reservation checks).
	 *
	 * See also the comments above spa_slop_shift.
	 */
	ZFS_SPACE_CHECK_NONE,
} zfs_space_check_t;

typedef struct dsl_sync_task {
	txg_node_t dst_node;
	struct dsl_pool *dst_pool;
	uint64_t dst_txg;
	int dst_space;
	zfs_space_check_t dst_space_check;
	dsl_checkfunc_t *dst_checkfunc;
	dsl_syncfunc_t *dst_syncfunc;
	void *dst_arg;
	int dst_error;
	boolean_t dst_nowaiter;
} dsl_sync_task_t;

void dsl_sync_task_sync(dsl_sync_task_t *, dmu_tx_t *);
int dsl_sync_task(const char *, dsl_checkfunc_t *,
    dsl_syncfunc_t *, void *, int, zfs_space_check_t);
void dsl_sync_task_nowait(struct dsl_pool *, dsl_syncfunc_t *,
    void *, int, zfs_space_check_t, dmu_tx_t *);

#ifdef	__cplusplus
}
#endif

#endif /* _SYS_DSL_SYNCTASK_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.
e10b0808	23	* Copyright (c) 2012, 2014 by Delphix. All rights reserved.
34dc7c2f BB	24	*/
	25
	26	#ifndef _SYS_DSL_SYNCTASK_H
	27	#define _SYS_DSL_SYNCTASK_H
	28
34dc7c2f BB	29	#include <sys/txg.h>
	30	#include <sys/zfs_context.h>
	31
	32	#ifdef __cplusplus
	33	extern "C" {
	34	#endif
	35
	36	struct dsl_pool;
	37
a08ee875 LG	38	typedef int (dsl_checkfunc_t)(void , dmu_tx_t );
a08ee875 LG	39	typedef void (dsl_syncfunc_t)(void , dmu_tx_t );
34dc7c2f	40
e10b0808 AX	41	typedef enum zfs_space_check {
	42	/*
	43	* Normal space check: if there is less than 3.2% free space,
	44	* the operation will fail. Operations which are logically
	45	* creating things should use this (e.g. "zfs create", "zfs snapshot").
	46	* User writes (via the ZPL / ZVOL) also fail at this point.
	47	*/
	48	ZFS_SPACE_CHECK_NORMAL,
	49
	50	/*
	51	* Space check allows use of half the slop space. If there
	52	* is less than 1.6% free space, the operation will fail. Most
	53	* operations should use this (e.g. "zfs set", "zfs rename"),
	54	* because we want them to succeed even after user writes are failing,
	55	* so that they can be used as part of the space recovery process.
	56	*/
	57	ZFS_SPACE_CHECK_RESERVED,
	58
	59	/*
	60	* No space check is performed. Only operations which we expect to
	61	* result in a net reduction in space should use this
	62	* (e.g. "zfs destroy". Setting quotas & reservations also uses
	63	* this because it needs to circumvent the quota/reservation checks).
	64	*
	65	* See also the comments above spa_slop_shift.
	66	*/
	67	ZFS_SPACE_CHECK_NONE,
	68	} zfs_space_check_t;
	69
34dc7c2f	70	typedef struct dsl_sync_task {
a08ee875 LG	71	txg_node_t dst_node;
	72	struct dsl_pool *dst_pool;
	73	uint64_t dst_txg;
	74	int dst_space;
e10b0808	75	zfs_space_check_t dst_space_check;
34dc7c2f BB	76	dsl_checkfunc_t *dst_checkfunc;
34dc7c2f BB	77	dsl_syncfunc_t *dst_syncfunc;
a08ee875 LG	78	void *dst_arg;
	79	int dst_error;
	80	boolean_t dst_nowaiter;
34dc7c2f BB	81	} dsl_sync_task_t;
34dc7c2f BB	82
e10b0808 AX	83	void dsl_sync_task_sync(dsl_sync_task_t , dmu_tx_t );
	84	int dsl_sync_task(const char , dsl_checkfunc_t ,
	85	dsl_syncfunc_t , void , int, zfs_space_check_t);
	86	void dsl_sync_task_nowait(struct dsl_pool , dsl_syncfunc_t ,
	87	void , int, zfs_space_check_t, dmu_tx_t );
34dc7c2f BB	88
	89	#ifdef __cplusplus
	90	}
	91	#endif
	92
	93	#endif /* _SYS_DSL_SYNCTASK_H */