xref: /freebsd/sys/vm/vm_radix.h (revision 734e82fe33aa764367791a7d603b383996c6b40b)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2013 EMC Corp.
5  * Copyright (c) 2011 Jeffrey Roberson <jeff@freebsd.org>
6  * Copyright (c) 2008 Mayur Shardul <mayur.shardul@gmail.com>
7  * All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28  * SUCH DAMAGE.
29  */
30 
31 #ifndef _VM_RADIX_H_
32 #define _VM_RADIX_H_
33 
34 #include <vm/_vm_radix.h>
35 
36 #ifdef _KERNEL
37 
38 int		vm_radix_insert(struct vm_radix *rtree, vm_page_t page);
39 void		vm_radix_wait(void);
40 vm_page_t	vm_radix_lookup(struct vm_radix *rtree, vm_pindex_t index);
41 vm_page_t	vm_radix_lookup_ge(struct vm_radix *rtree, vm_pindex_t index);
42 vm_page_t	vm_radix_lookup_le(struct vm_radix *rtree, vm_pindex_t index);
43 vm_page_t	vm_radix_lookup_unlocked(struct vm_radix *rtree, vm_pindex_t index);
44 void		vm_radix_reclaim_allnodes(struct vm_radix *rtree);
45 vm_page_t	vm_radix_remove(struct vm_radix *rtree, vm_pindex_t index);
46 vm_page_t	vm_radix_replace(struct vm_radix *rtree, vm_page_t newpage);
47 void		vm_radix_zinit(void);
48 
49 /*
50  * Each search path in the trie terminates at a leaf, which is a pointer to a
51  * page marked with a set 1-bit.  A leaf may be associated with a null pointer
52  * to indicate no page there.
53  */
54 #define	VM_RADIX_ISLEAF	0x1
55 #define VM_RADIX_NULL (struct vm_radix_node *)VM_RADIX_ISLEAF
56 
57 static __inline void
58 vm_radix_init(struct vm_radix *rtree)
59 {
60 	rtree->rt_root = VM_RADIX_NULL;
61 }
62 
63 static __inline bool
64 vm_radix_is_empty(struct vm_radix *rtree)
65 {
66 	return (rtree->rt_root == VM_RADIX_NULL);
67 }
68 
69 #endif /* _KERNEL */
70 #endif /* !_VM_RADIX_H_ */
71