[mirror_zfs.git] / include / sys / dsl_dir.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 Delphix. All rights reserved.
 * Copyright (c) 2014, Joyent, Inc. All rights reserved.
 * Copyright (c) 2014 Spectra Logic Corporation, All rights reserved.
 */

#ifndef	_SYS_DSL_DIR_H
#define	_SYS_DSL_DIR_H

#include <sys/dmu.h>
#include <sys/dsl_pool.h>
#include <sys/dsl_synctask.h>
#include <sys/refcount.h>
#include <sys/zfs_context.h>

#ifdef	__cplusplus
extern "C" {
#endif

struct dsl_dataset;

/*
 * DD_FIELD_* are strings that are used in the "extensified" dsl_dir zap object.
 * They should be of the format <reverse-dns>:<field>.
 */

#define	DD_FIELD_FILESYSTEM_COUNT	"com.joyent:filesystem_count"
#define	DD_FIELD_SNAPSHOT_COUNT		"com.joyent:snapshot_count"

typedef enum dd_used {
	DD_USED_HEAD,
	DD_USED_SNAP,
	DD_USED_CHILD,
	DD_USED_CHILD_RSRV,
	DD_USED_REFRSRV,
	DD_USED_NUM
} dd_used_t;

#define	DD_FLAG_USED_BREAKDOWN (1<<0)

typedef struct dsl_dir_phys {
	uint64_t dd_creation_time; /* not actually used */
	uint64_t dd_head_dataset_obj;
	uint64_t dd_parent_obj;
	uint64_t dd_origin_obj;
	uint64_t dd_child_dir_zapobj;
	/*
	 * how much space our children are accounting for; for leaf
	 * datasets, == physical space used by fs + snaps
	 */
	uint64_t dd_used_bytes;
	uint64_t dd_compressed_bytes;
	uint64_t dd_uncompressed_bytes;
	/* Administrative quota setting */
	uint64_t dd_quota;
	/* Administrative reservation setting */
	uint64_t dd_reserved;
	uint64_t dd_props_zapobj;
	uint64_t dd_deleg_zapobj; /* dataset delegation permissions */
	uint64_t dd_flags;
	uint64_t dd_used_breakdown[DD_USED_NUM];
	uint64_t dd_clones; /* dsl_dir objects */
	uint64_t dd_pad[13]; /* pad out to 256 bytes for good measure */
} dsl_dir_phys_t;

struct dsl_dir {
	dmu_buf_user_t dd_dbu;

	/* These are immutable; no lock needed: */
	uint64_t dd_object;
	dsl_pool_t *dd_pool;

	/* Stable until user eviction; no lock needed: */
	dmu_buf_t *dd_dbuf;

	/* protected by lock on pool's dp_dirty_dirs list */
	txg_node_t dd_dirty_link;

	/* protected by dp_config_rwlock */
	dsl_dir_t *dd_parent;

	/* Protected by dd_lock */
	kmutex_t dd_lock;
	list_t dd_props; /* list of dsl_prop_record_t's */
	timestruc_t dd_snap_cmtime; /* last time snapshot namespace changed */
	uint64_t dd_origin_txg;

	/* gross estimate of space used by in-flight tx's */
	uint64_t dd_tempreserved[TXG_SIZE];
	/* amount of space we expect to write; == amount of dirty data */
	int64_t dd_space_towrite[TXG_SIZE];

	/* protected by dd_lock; keep at end of struct for better locality */
	char dd_myname[MAXNAMELEN];
};

static inline dsl_dir_phys_t *
dsl_dir_phys(dsl_dir_t *dd)
{
	return (dd->dd_dbuf->db_data);
}

void dsl_dir_rele(dsl_dir_t *dd, void *tag);
void dsl_dir_async_rele(dsl_dir_t *dd, void *tag);
int dsl_dir_hold(dsl_pool_t *dp, const char *name, void *tag,
    dsl_dir_t **, const char **tail);
int dsl_dir_hold_obj(dsl_pool_t *dp, uint64_t ddobj,
    const char *tail, void *tag, dsl_dir_t **);
void dsl_dir_name(dsl_dir_t *dd, char *buf);
int dsl_dir_namelen(dsl_dir_t *dd);
uint64_t dsl_dir_create_sync(dsl_pool_t *dp, dsl_dir_t *pds,
    const char *name, dmu_tx_t *tx);
void dsl_dir_stats(dsl_dir_t *dd, nvlist_t *nv);
uint64_t dsl_dir_space_available(dsl_dir_t *dd,
    dsl_dir_t *ancestor, int64_t delta, int ondiskonly);
void dsl_dir_dirty(dsl_dir_t *dd, dmu_tx_t *tx);
void dsl_dir_sync(dsl_dir_t *dd, dmu_tx_t *tx);
int dsl_dir_tempreserve_space(dsl_dir_t *dd, uint64_t mem,
    uint64_t asize, uint64_t fsize, uint64_t usize, void **tr_cookiep,
    dmu_tx_t *tx);
void dsl_dir_tempreserve_clear(void *tr_cookie, dmu_tx_t *tx);
void dsl_dir_willuse_space(dsl_dir_t *dd, int64_t space, dmu_tx_t *tx);
void dsl_dir_diduse_space(dsl_dir_t *dd, dd_used_t type,
    int64_t used, int64_t compressed, int64_t uncompressed, dmu_tx_t *tx);
void dsl_dir_transfer_space(dsl_dir_t *dd, int64_t delta,
    dd_used_t oldtype, dd_used_t newtype, dmu_tx_t *tx);
int dsl_dir_set_quota(const char *ddname, zprop_source_t source,
    uint64_t quota);
int dsl_dir_set_reservation(const char *ddname, zprop_source_t source,
    uint64_t reservation);
int dsl_dir_activate_fs_ss_limit(const char *);
int dsl_fs_ss_limit_check(dsl_dir_t *, uint64_t, zfs_prop_t, dsl_dir_t *,
    cred_t *);
void dsl_fs_ss_count_adjust(dsl_dir_t *, int64_t, const char *, dmu_tx_t *);
int dsl_dir_rename(const char *oldname, const char *newname);
int dsl_dir_transfer_possible(dsl_dir_t *sdd, dsl_dir_t *tdd,
    uint64_t fs_cnt, uint64_t ss_cnt, uint64_t space, cred_t *);
boolean_t dsl_dir_is_clone(dsl_dir_t *dd);
void dsl_dir_new_refreservation(dsl_dir_t *dd, struct dsl_dataset *ds,
    uint64_t reservation, cred_t *cr, dmu_tx_t *tx);
void dsl_dir_snap_cmtime_update(dsl_dir_t *dd);
timestruc_t dsl_dir_snap_cmtime(dsl_dir_t *dd);
void dsl_dir_set_reservation_sync_impl(dsl_dir_t *dd, uint64_t value,
    dmu_tx_t *tx);
void dsl_dir_zapify(dsl_dir_t *dd, dmu_tx_t *tx);
boolean_t dsl_dir_is_zapified(dsl_dir_t *dd);

/* internal reserved dir name */
#define	MOS_DIR_NAME "$MOS"
#define	ORIGIN_DIR_NAME "$ORIGIN"
#define	XLATION_DIR_NAME "$XLATION"
#define	FREE_DIR_NAME "$FREE"
#define	LEAK_DIR_NAME "$LEAK"

#ifdef ZFS_DEBUG
#define	dprintf_dd(dd, fmt, ...) do { \
	if (zfs_flags & ZFS_DEBUG_DPRINTF) { \
	char *__ds_name = kmem_alloc(MAXNAMELEN + strlen(MOS_DIR_NAME) + 1, \
	    KM_SLEEP); \
	dsl_dir_name(dd, __ds_name); \
	dprintf("dd=%s " fmt, __ds_name, __VA_ARGS__); \
	kmem_free(__ds_name, MAXNAMELEN + strlen(MOS_DIR_NAME) + 1); \
	} \
_NOTE(CONSTCOND) } while (0)
#else
#define	dprintf_dd(dd, fmt, ...)
#endif

#ifdef	__cplusplus
}
#endif

#endif /* _SYS_DSL_DIR_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.
e8b96c60	23	* Copyright (c) 2013 by Delphix. All rights reserved.
788eb90c	24	* Copyright (c) 2014, Joyent, Inc. All rights reserved.
0c66c32d	25	* Copyright (c) 2014 Spectra Logic Corporation, All rights reserved.
34dc7c2f BB	26	*/
	27
	28	#ifndef _SYS_DSL_DIR_H
	29	#define _SYS_DSL_DIR_H
	30
34dc7c2f BB	31	#include <sys/dmu.h>
	32	#include <sys/dsl_pool.h>
	33	#include <sys/dsl_synctask.h>
	34	#include <sys/refcount.h>
	35	#include <sys/zfs_context.h>
	36
	37	#ifdef __cplusplus
	38	extern "C" {
	39	#endif
	40
	41	struct dsl_dataset;
	42
788eb90c JJ	43	/*
	44	* DD_FIELD_* are strings that are used in the "extensified" dsl_dir zap object.
	45	* They should be of the format <reverse-dns>:<field>.
	46	*/
	47
	48	#define DD_FIELD_FILESYSTEM_COUNT "com.joyent:filesystem_count"
	49	#define DD_FIELD_SNAPSHOT_COUNT "com.joyent:snapshot_count"
	50
b128c09f BB	51	typedef enum dd_used {
	52	DD_USED_HEAD,
	53	DD_USED_SNAP,
	54	DD_USED_CHILD,
	55	DD_USED_CHILD_RSRV,
	56	DD_USED_REFRSRV,
	57	DD_USED_NUM
	58	} dd_used_t;
	59
	60	#define DD_FLAG_USED_BREAKDOWN (1<<0)
	61
34dc7c2f BB	62	typedef struct dsl_dir_phys {
	63	uint64_t dd_creation_time; /* not actually used */
	64	uint64_t dd_head_dataset_obj;
	65	uint64_t dd_parent_obj;
	66	uint64_t dd_origin_obj;
	67	uint64_t dd_child_dir_zapobj;
	68	/*
	69	* how much space our children are accounting for; for leaf
	70	* datasets, == physical space used by fs + snaps
	71	*/
	72	uint64_t dd_used_bytes;
	73	uint64_t dd_compressed_bytes;
	74	uint64_t dd_uncompressed_bytes;
	75	/* Administrative quota setting */
	76	uint64_t dd_quota;
	77	/* Administrative reservation setting */
	78	uint64_t dd_reserved;
	79	uint64_t dd_props_zapobj;
	80	uint64_t dd_deleg_zapobj; /* dataset delegation permissions */
b128c09f BB	81	uint64_t dd_flags;
b128c09f BB	82	uint64_t dd_used_breakdown[DD_USED_NUM];
428870ff BB	83	uint64_t dd_clones; /* dsl_dir objects */
428870ff BB	84	uint64_t dd_pad[13]; /* pad out to 256 bytes for good measure */
34dc7c2f BB	85	} dsl_dir_phys_t;
	86
	87	struct dsl_dir {
0c66c32d JG	88	dmu_buf_user_t dd_dbu;
0c66c32d JG	89
34dc7c2f BB	90	/* These are immutable; no lock needed: */
34dc7c2f BB	91	uint64_t dd_object;
34dc7c2f BB	92	dsl_pool_t *dd_pool;
34dc7c2f BB	93
d683ddbb JG	94	/* Stable until user eviction; no lock needed: */
	95	dmu_buf_t *dd_dbuf;
	96
34dc7c2f BB	97	/* protected by lock on pool's dp_dirty_dirs list */
	98	txg_node_t dd_dirty_link;
	99
	100	/* protected by dp_config_rwlock */
	101	dsl_dir_t *dd_parent;
	102
	103	/* Protected by dd_lock */
	104	kmutex_t dd_lock;
0eb21616	105	list_t dd_props; /* list of dsl_prop_record_t's */
428870ff BB	106	timestruc_t dd_snap_cmtime; /* last time snapshot namespace changed */
428870ff BB	107	uint64_t dd_origin_txg;
34dc7c2f	108
34dc7c2f BB	109	/* gross estimate of space used by in-flight tx's */
	110	uint64_t dd_tempreserved[TXG_SIZE];
	111	/* amount of space we expect to write; == amount of dirty data */
	112	int64_t dd_space_towrite[TXG_SIZE];
	113
	114	/* protected by dd_lock; keep at end of struct for better locality */
	115	char dd_myname[MAXNAMELEN];
	116	};
	117
d683ddbb JG	118	static inline dsl_dir_phys_t *
	119	dsl_dir_phys(dsl_dir_t *dd)
	120	{
	121	return (dd->dd_dbuf->db_data);
	122	}
	123
13fe0198	124	void dsl_dir_rele(dsl_dir_t dd, void tag);
0c66c32d	125	void dsl_dir_async_rele(dsl_dir_t dd, void tag);
13fe0198 MA	126	int dsl_dir_hold(dsl_pool_t dp, const char name, void *tag,
	127	dsl_dir_t , const char tail);
	128	int dsl_dir_hold_obj(dsl_pool_t *dp, uint64_t ddobj,
34dc7c2f BB	129	const char tail, void tag, dsl_dir_t **);
	130	void dsl_dir_name(dsl_dir_t dd, char buf);
	131	int dsl_dir_namelen(dsl_dir_t *dd);
b128c09f BB	132	uint64_t dsl_dir_create_sync(dsl_pool_t dp, dsl_dir_t pds,
b128c09f BB	133	const char name, dmu_tx_t tx);
34dc7c2f BB	134	void dsl_dir_stats(dsl_dir_t dd, nvlist_t nv);
	135	uint64_t dsl_dir_space_available(dsl_dir_t *dd,
	136	dsl_dir_t *ancestor, int64_t delta, int ondiskonly);
	137	void dsl_dir_dirty(dsl_dir_t dd, dmu_tx_t tx);
	138	void dsl_dir_sync(dsl_dir_t dd, dmu_tx_t tx);
	139	int dsl_dir_tempreserve_space(dsl_dir_t *dd, uint64_t mem,
	140	uint64_t asize, uint64_t fsize, uint64_t usize, void **tr_cookiep,
	141	dmu_tx_t *tx);
	142	void dsl_dir_tempreserve_clear(void tr_cookie, dmu_tx_t tx);
	143	void dsl_dir_willuse_space(dsl_dir_t dd, int64_t space, dmu_tx_t tx);
b128c09f	144	void dsl_dir_diduse_space(dsl_dir_t *dd, dd_used_t type,
34dc7c2f	145	int64_t used, int64_t compressed, int64_t uncompressed, dmu_tx_t *tx);
b128c09f BB	146	void dsl_dir_transfer_space(dsl_dir_t *dd, int64_t delta,
b128c09f BB	147	dd_used_t oldtype, dd_used_t newtype, dmu_tx_t *tx);
428870ff BB	148	int dsl_dir_set_quota(const char *ddname, zprop_source_t source,
	149	uint64_t quota);
	150	int dsl_dir_set_reservation(const char *ddname, zprop_source_t source,
	151	uint64_t reservation);
788eb90c JJ	152	int dsl_dir_activate_fs_ss_limit(const char *);
	153	int dsl_fs_ss_limit_check(dsl_dir_t , uint64_t, zfs_prop_t, dsl_dir_t ,
	154	cred_t *);
	155	void dsl_fs_ss_count_adjust(dsl_dir_t , int64_t, const char , dmu_tx_t *);
13fe0198	156	int dsl_dir_rename(const char oldname, const char newname);
788eb90c JJ	157	int dsl_dir_transfer_possible(dsl_dir_t sdd, dsl_dir_t tdd,
788eb90c JJ	158	uint64_t fs_cnt, uint64_t ss_cnt, uint64_t space, cred_t *);
b128c09f BB	159	boolean_t dsl_dir_is_clone(dsl_dir_t *dd);
	160	void dsl_dir_new_refreservation(dsl_dir_t dd, struct dsl_dataset ds,
	161	uint64_t reservation, cred_t cr, dmu_tx_t tx);
428870ff BB	162	void dsl_dir_snap_cmtime_update(dsl_dir_t *dd);
428870ff BB	163	timestruc_t dsl_dir_snap_cmtime(dsl_dir_t *dd);
13fe0198 MA	164	void dsl_dir_set_reservation_sync_impl(dsl_dir_t *dd, uint64_t value,
13fe0198 MA	165	dmu_tx_t *tx);
788eb90c JJ	166	void dsl_dir_zapify(dsl_dir_t dd, dmu_tx_t tx);
788eb90c JJ	167	boolean_t dsl_dir_is_zapified(dsl_dir_t *dd);
34dc7c2f BB	168
	169	/* internal reserved dir name */
	170	#define MOS_DIR_NAME "$MOS"
b128c09f	171	#define ORIGIN_DIR_NAME "$ORIGIN"
428870ff BB	172	#define XLATION_DIR_NAME "$XLATION"
428870ff BB	173	#define FREE_DIR_NAME "$FREE"
fbeddd60	174	#define LEAK_DIR_NAME "$LEAK"
34dc7c2f BB	175
	176	#ifdef ZFS_DEBUG
	177	#define dprintf_dd(dd, fmt, ...) do { \
	178	if (zfs_flags & ZFS_DEBUG_DPRINTF) { \
	179	char *__ds_name = kmem_alloc(MAXNAMELEN + strlen(MOS_DIR_NAME) + 1, \
79c76d5b	180	KM_SLEEP); \
34dc7c2f BB	181	dsl_dir_name(dd, __ds_name); \
	182	dprintf("dd=%s " fmt, __ds_name, __VA_ARGS__); \
	183	kmem_free(__ds_name, MAXNAMELEN + strlen(MOS_DIR_NAME) + 1); \
	184	} \
	185	_NOTE(CONSTCOND) } while (0)
	186	#else
	187	#define dprintf_dd(dd, fmt, ...)
	188	#endif
	189
	190	#ifdef __cplusplus
	191	}
	192	#endif
	193
	194	#endif /* _SYS_DSL_DIR_H */