xref: /illumos-gate/usr/src/uts/common/fs/zfs/sys/range_tree.h (revision cfd63e1b1bcf7ba4bf72f55ddbd87ce008d2986d)
10713e232SGeorge Wilson /*
20713e232SGeorge Wilson  * CDDL HEADER START
30713e232SGeorge Wilson  *
40713e232SGeorge Wilson  * The contents of this file are subject to the terms of the
50713e232SGeorge Wilson  * Common Development and Distribution License (the "License").
60713e232SGeorge Wilson  * You may not use this file except in compliance with the License.
70713e232SGeorge Wilson  *
80713e232SGeorge Wilson  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
90713e232SGeorge Wilson  * or http://www.opensolaris.org/os/licensing.
100713e232SGeorge Wilson  * See the License for the specific language governing permissions
110713e232SGeorge Wilson  * and limitations under the License.
120713e232SGeorge Wilson  *
130713e232SGeorge Wilson  * When distributing Covered Code, include this CDDL HEADER in each
140713e232SGeorge Wilson  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
150713e232SGeorge Wilson  * If applicable, add the following below this CDDL HEADER, with the
160713e232SGeorge Wilson  * fields enclosed by brackets "[]" replaced with your own identifying
170713e232SGeorge Wilson  * information: Portions Copyright [yyyy] [name of copyright owner]
180713e232SGeorge Wilson  *
190713e232SGeorge Wilson  * CDDL HEADER END
200713e232SGeorge Wilson  */
210713e232SGeorge Wilson /*
220713e232SGeorge Wilson  * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
230713e232SGeorge Wilson  * Use is subject to license terms.
240713e232SGeorge Wilson  */
250713e232SGeorge Wilson 
260713e232SGeorge Wilson /*
2786714001SSerapheim Dimitropoulos  * Copyright (c) 2013, 2017 by Delphix. All rights reserved.
280713e232SGeorge Wilson  */
290713e232SGeorge Wilson 
300713e232SGeorge Wilson #ifndef _SYS_RANGE_TREE_H
310713e232SGeorge Wilson #define	_SYS_RANGE_TREE_H
320713e232SGeorge Wilson 
330713e232SGeorge Wilson #include <sys/avl.h>
340713e232SGeorge Wilson #include <sys/dmu.h>
350713e232SGeorge Wilson 
360713e232SGeorge Wilson #ifdef	__cplusplus
370713e232SGeorge Wilson extern "C" {
380713e232SGeorge Wilson #endif
390713e232SGeorge Wilson 
400713e232SGeorge Wilson #define	RANGE_TREE_HISTOGRAM_SIZE	64
410713e232SGeorge Wilson 
420713e232SGeorge Wilson typedef struct range_tree_ops range_tree_ops_t;
430713e232SGeorge Wilson 
445cabbc6bSPrashanth Sreenivasa /*
455cabbc6bSPrashanth Sreenivasa  * Note: the range_tree may not be accessed concurrently; consumers
465cabbc6bSPrashanth Sreenivasa  * must provide external locking if required.
475cabbc6bSPrashanth Sreenivasa  */
480713e232SGeorge Wilson typedef struct range_tree {
490713e232SGeorge Wilson 	avl_tree_t	rt_root;	/* offset-ordered segment AVL tree */
500713e232SGeorge Wilson 	uint64_t	rt_space;	/* sum of all segments in the map */
510713e232SGeorge Wilson 	range_tree_ops_t *rt_ops;
520713e232SGeorge Wilson 	void		*rt_arg;
530713e232SGeorge Wilson 
540713e232SGeorge Wilson 	/*
550713e232SGeorge Wilson 	 * The rt_histogram maintains a histogram of ranges. Each bucket,
560713e232SGeorge Wilson 	 * rt_histogram[i], contains the number of ranges whose size is:
570713e232SGeorge Wilson 	 * 2^i <= size of range in bytes < 2^(i+1)
580713e232SGeorge Wilson 	 */
590713e232SGeorge Wilson 	uint64_t	rt_histogram[RANGE_TREE_HISTOGRAM_SIZE];
600713e232SGeorge Wilson } range_tree_t;
610713e232SGeorge Wilson 
620713e232SGeorge Wilson typedef struct range_seg {
630713e232SGeorge Wilson 	avl_node_t	rs_node;	/* AVL node */
640713e232SGeorge Wilson 	avl_node_t	rs_pp_node;	/* AVL picker-private node */
650713e232SGeorge Wilson 	uint64_t	rs_start;	/* starting offset of this segment */
660713e232SGeorge Wilson 	uint64_t	rs_end;		/* ending offset (non-inclusive) */
670713e232SGeorge Wilson } range_seg_t;
680713e232SGeorge Wilson 
690713e232SGeorge Wilson struct range_tree_ops {
700713e232SGeorge Wilson 	void    (*rtop_create)(range_tree_t *rt, void *arg);
710713e232SGeorge Wilson 	void    (*rtop_destroy)(range_tree_t *rt, void *arg);
720713e232SGeorge Wilson 	void	(*rtop_add)(range_tree_t *rt, range_seg_t *rs, void *arg);
730713e232SGeorge Wilson 	void    (*rtop_remove)(range_tree_t *rt, range_seg_t *rs, void *arg);
740713e232SGeorge Wilson 	void	(*rtop_vacate)(range_tree_t *rt, void *arg);
750713e232SGeorge Wilson };
760713e232SGeorge Wilson 
770713e232SGeorge Wilson typedef void range_tree_func_t(void *arg, uint64_t start, uint64_t size);
780713e232SGeorge Wilson 
790713e232SGeorge Wilson void range_tree_init(void);
800713e232SGeorge Wilson void range_tree_fini(void);
815cabbc6bSPrashanth Sreenivasa range_tree_t *range_tree_create(range_tree_ops_t *ops, void *arg);
820713e232SGeorge Wilson void range_tree_destroy(range_tree_t *rt);
830713e232SGeorge Wilson boolean_t range_tree_contains(range_tree_t *rt, uint64_t start, uint64_t size);
840713e232SGeorge Wilson uint64_t range_tree_space(range_tree_t *rt);
8586714001SSerapheim Dimitropoulos boolean_t range_tree_is_empty(range_tree_t *rt);
860713e232SGeorge Wilson void range_tree_verify(range_tree_t *rt, uint64_t start, uint64_t size);
870713e232SGeorge Wilson void range_tree_swap(range_tree_t **rtsrc, range_tree_t **rtdst);
880713e232SGeorge Wilson void range_tree_stat_verify(range_tree_t *rt);
89*cfd63e1bSMatthew Ahrens uint64_t range_tree_min(range_tree_t *rt);
90*cfd63e1bSMatthew Ahrens uint64_t range_tree_max(range_tree_t *rt);
91*cfd63e1bSMatthew Ahrens uint64_t range_tree_span(range_tree_t *rt);
920713e232SGeorge Wilson 
930713e232SGeorge Wilson void range_tree_add(void *arg, uint64_t start, uint64_t size);
940713e232SGeorge Wilson void range_tree_remove(void *arg, uint64_t start, uint64_t size);
95bf16b11eSMatthew Ahrens void range_tree_clear(range_tree_t *rt, uint64_t start, uint64_t size);
960713e232SGeorge Wilson 
970713e232SGeorge Wilson void range_tree_vacate(range_tree_t *rt, range_tree_func_t *func, void *arg);
980713e232SGeorge Wilson void range_tree_walk(range_tree_t *rt, range_tree_func_t *func, void *arg);
990713e232SGeorge Wilson 
1000713e232SGeorge Wilson #ifdef	__cplusplus
1010713e232SGeorge Wilson }
1020713e232SGeorge Wilson #endif
1030713e232SGeorge Wilson 
1040713e232SGeorge Wilson #endif	/* _SYS_RANGE_TREE_H */
105