drm/ttm: Use Linux memory management functions
[dragonfly.git] / sys / libprop / prop_rb_impl.h
CommitLineData
349fb218
AH
1/* $NetBSD: prop_rb_impl.h,v 1.7 2008/06/30 20:14:09 matt Exp $ */
2
3/*-
4 * Copyright (c) 2001 The NetBSD Foundation, Inc.
5 * All rights reserved.
6 *
7 * This code is derived from software contributed to The NetBSD Foundation
8 * by Matt Thomas <matt@3am-software.com>.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 * POSSIBILITY OF SUCH DAMAGE.
30 */
31
32#ifndef _PROP_RB_IMPL_H_
33#define _PROP_RB_IMPL_H_
34
35#ifdef __NetBSD__
36#include <sys/rb.h>
37
38/*
39 * Define local names for common rb_tree functions.
40 */
41#define _prop_rb_tree_init rb_tree_init
42#define _prop_rb_tree_insert_node rb_tree_insert_node
43#define _prop_rb_tree_find rb_tree_find_node
44#define _prop_rb_tree_remove_node rb_tree_remove_node
45#define _prop_rb_tree_iterate rb_tree_iterate
46
47#else /* __NetBSD__ */
48
49#include <sys/types.h>
50#include <sys/queue.h>
51#include <machine/endian.h>
52
4b4863a7
AH
53
54typedef struct rb_node {
55 struct rb_node *rb_nodes[2];
56#define RB_DIR_LEFT 0
57#define RB_DIR_RIGHT 1
58#define RB_DIR_OTHER 1
59#define rb_left rb_nodes[RB_DIR_LEFT]
60#define rb_right rb_nodes[RB_DIR_RIGHT]
61
62 /*
63 * rb_info contains the two flags and the parent back pointer.
64 * We put the two flags in the low two bits since we know that
65 * rb_node will have an alignment of 4 or 8 bytes.
66 */
67 uintptr_t rb_info;
68#define RB_FLAG_POSITION 0x2
69#define RB_FLAG_RED 0x1
70#define RB_FLAG_MASK (RB_FLAG_POSITION|RB_FLAG_RED)
71#define RB_FATHER(rb) \
72 ((struct rb_node *)((rb)->rb_info & ~RB_FLAG_MASK))
73#define RB_SET_FATHER(rb, father) \
74 ((void)((rb)->rb_info = (uintptr_t)(father)|((rb)->rb_info & RB_FLAG_MASK)))
75
76#define RB_SENTINEL_P(rb) ((rb) == NULL)
77#define RB_LEFT_SENTINEL_P(rb) RB_SENTINEL_P((rb)->rb_left)
78#define RB_RIGHT_SENTINEL_P(rb) RB_SENTINEL_P((rb)->rb_right)
79#define RB_FATHER_SENTINEL_P(rb) RB_SENTINEL_P(RB_FATHER((rb)))
80#define RB_CHILDLESS_P(rb) \
81 (RB_SENTINEL_P(rb) || (RB_LEFT_SENTINEL_P(rb) && RB_RIGHT_SENTINEL_P(rb)))
82#define RB_TWOCHILDREN_P(rb) \
83 (!RB_SENTINEL_P(rb) && !RB_LEFT_SENTINEL_P(rb) && !RB_RIGHT_SENTINEL_P(rb))
84
85#define RB_POSITION(rb) \
86 (((rb)->rb_info & RB_FLAG_POSITION) ? RB_DIR_RIGHT : RB_DIR_LEFT)
87#define RB_RIGHT_P(rb) (RB_POSITION(rb) == RB_DIR_RIGHT)
88#define RB_LEFT_P(rb) (RB_POSITION(rb) == RB_DIR_LEFT)
89#define RB_RED_P(rb) (!RB_SENTINEL_P(rb) && ((rb)->rb_info & RB_FLAG_RED) != 0)
90#define RB_BLACK_P(rb) (RB_SENTINEL_P(rb) || ((rb)->rb_info & RB_FLAG_RED) == 0)
91#define RB_MARK_RED(rb) ((void)((rb)->rb_info |= RB_FLAG_RED))
92#define RB_MARK_BLACK(rb) ((void)((rb)->rb_info &= ~RB_FLAG_RED))
93#define RB_INVERT_COLOR(rb) ((void)((rb)->rb_info ^= RB_FLAG_RED))
94#define RB_ROOT_P(rbt, rb) ((rbt)->rbt_root == (rb))
95#define RB_SET_POSITION(rb, position) \
96 ((void)((position) ? ((rb)->rb_info |= RB_FLAG_POSITION) : \
97 ((rb)->rb_info &= ~RB_FLAG_POSITION)))
98#define RB_ZERO_PROPERTIES(rb) ((void)((rb)->rb_info &= ~RB_FLAG_MASK))
99#define RB_COPY_PROPERTIES(dst, src) \
100 ((void)((dst)->rb_info ^= ((dst)->rb_info ^ (src)->rb_info) & RB_FLAG_MASK))
101#define RB_SWAP_PROPERTIES(a, b) do { \
102 uintptr_t xorinfo = ((a)->rb_info ^ (b)->rb_info) & RB_FLAG_MASK; \
103 (a)->rb_info ^= xorinfo; \
104 (b)->rb_info ^= xorinfo; \
105 } while (/*CONSTCOND*/ 0)
349fb218
AH
106#ifdef RBDEBUG
107 TAILQ_ENTRY(rb_node) rb_link;
108#endif
4b4863a7
AH
109} rb_node_t;
110
111#define RB_TREE_MIN(T) rb_tree_iterate((T), NULL, RB_DIR_LEFT)
112#define RB_TREE_MAX(T) rb_tree_iterate((T), NULL, RB_DIR_RIGHT)
113#define RB_TREE_FOREACH(N, T) \
114 for ((N) = RB_TREE_MIN(T); (N); \
115 (N) = rb_tree_iterate((T), (N), RB_DIR_RIGHT))
116#define RB_TREE_FOREACH_REVERSE(N, T) \
117 for ((N) = RB_TREE_MAX(T); (N); \
118 (N) = rb_tree_iterate((T), (N), RB_DIR_LEFT))
349fb218
AH
119
120#ifdef RBDEBUG
121TAILQ_HEAD(rb_node_qh, rb_node);
122
4b4863a7
AH
123#define RB_TAILQ_REMOVE(a, b, c) TAILQ_REMOVE(a, b, c)
124#define RB_TAILQ_INIT(a) TAILQ_INIT(a)
125#define RB_TAILQ_INSERT_HEAD(a, b, c) TAILQ_INSERT_HEAD(a, b, c)
126#define RB_TAILQ_INSERT_BEFORE(a, b, c) TAILQ_INSERT_BEFORE(a, b, c)
127#define RB_TAILQ_INSERT_AFTER(a, b, c, d) TAILQ_INSERT_AFTER(a, b, c, d)
349fb218
AH
128#else
129#define RB_TAILQ_REMOVE(a, b, c) do { } while (/*CONSTCOND*/0)
130#define RB_TAILQ_INIT(a) do { } while (/*CONSTCOND*/0)
131#define RB_TAILQ_INSERT_HEAD(a, b, c) do { } while (/*CONSTCOND*/0)
132#define RB_TAILQ_INSERT_BEFORE(a, b, c) do { } while (/*CONSTCOND*/0)
133#define RB_TAILQ_INSERT_AFTER(a, b, c, d) do { } while (/*CONSTCOND*/0)
4b4863a7
AH
134#endif /* RBDEBUG */
135
136typedef int (*rb_compare_nodes_fn)(void *ctx, const void *, const void *);
137typedef int (*rb_compare_key_fn)(void *ctx, const void *, const void *);
349fb218 138
4b4863a7
AH
139typedef rb_compare_nodes_fn rbto_compare_nodes_fn;
140typedef rb_compare_key_fn rbto_compare_key_fn;
349fb218 141
4b4863a7 142typedef struct rb_tree_ops {
349fb218
AH
143 rb_compare_nodes_fn rbto_compare_nodes;
144 rb_compare_key_fn rbto_compare_key;
4b4863a7
AH
145 size_t rbto_node_offset;
146 void *rbto_context;
147} rb_tree_ops_t;
349fb218 148
4b4863a7 149typedef struct rb_tree {
349fb218 150 struct rb_node *rbt_root;
4b4863a7
AH
151 const rb_tree_ops_t *rbt_ops;
152 struct rb_node *rbt_minmax[2];
349fb218
AH
153#ifdef RBDEBUG
154 struct rb_node_qh rbt_nodes;
155#endif
4b4863a7 156#ifdef RBSTATS
349fb218 157 unsigned int rbt_count;
4b4863a7
AH
158 unsigned int rbt_insertions;
159 unsigned int rbt_removals;
160 unsigned int rbt_insertion_rebalance_calls;
161 unsigned int rbt_insertion_rebalance_passes;
162 unsigned int rbt_removal_rebalance_calls;
163 unsigned int rbt_removal_rebalance_passes;
164#endif
165} rb_tree_t;
166
167
168#ifdef RBSTATS
169#define RBSTAT_INC(v) ((void)((v)++))
170#define RBSTAT_DEC(v) ((void)((v)--))
171#else
172#define RBSTAT_INC(v) do { } while (/*CONSTCOND*/0)
173#define RBSTAT_DEC(v) do { } while (/*CONSTCOND*/0)
349fb218 174#endif
349fb218 175
4b4863a7
AH
176void _prop_rb_tree_init(struct rb_tree *, const rb_tree_ops_t *);
177void *
178 _prop_rb_tree_insert_node(struct rb_tree *, void *);
179void *
349fb218 180 _prop_rb_tree_find(struct rb_tree *, const void *);
4b4863a7 181void _prop_rb_tree_remove_node(struct rb_tree *, void *);
349fb218
AH
182#ifdef RBDEBUG
183void _prop_rb_tree_check(const struct rb_tree *, bool);
184#endif
4b4863a7
AH
185void *
186 _prop_rb_tree_iterate(struct rb_tree *, void *, const unsigned int);
349fb218
AH
187
188#endif /* __NetBSD__ */
189
190#endif /* _PROP_RB_IMPL_H_*/