2 * SPDX-License-Identifier: BSD-2-Clause
4 * Copyright (c) 2019 The FreeBSD Foundation
6 * This software was developed by Konstantin Belousov <kib@FreeBSD.org>
7 * under sponsorship from the FreeBSD Foundation.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
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.
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
31 #include <sys/param.h>
32 #include <sys/kernel.h>
34 #include <sys/pctrie.h>
35 #include <sys/rangeset.h>
39 static void rangeset_check(struct rangeset *rs);
41 #define rangeset_check(rs)
44 static uma_zone_t rs_node_zone;
47 rs_rangeset_init(void *arg __unused)
50 rs_node_zone = uma_zcreate("rangeset pctrie nodes",
51 pctrie_node_size(), NULL, NULL, pctrie_zone_init, NULL,
54 SYSINIT(rs, SI_SUB_LOCK, SI_ORDER_ANY, rs_rangeset_init, NULL);
57 rs_node_alloc(struct pctrie *ptree)
61 rs = __containerof(ptree, struct rangeset, rs_trie);
62 return (uma_zalloc(rs_node_zone, rs->rs_alloc_flags));
66 rs_node_free(struct pctrie *ptree __unused, void *node)
69 uma_zfree(rs_node_zone, node);
72 PCTRIE_DEFINE(RANGESET, rs_el, re_start, rs_node_alloc, rs_node_free);
75 rangeset_init(struct rangeset *rs, rs_dup_data_t dup_data,
76 rs_free_data_t free_data, void *data_ctx, u_int alloc_flags)
79 pctrie_init(&rs->rs_trie);
80 rs->rs_dup_data = dup_data;
81 rs->rs_free_data = free_data;
82 rs->rs_data_ctx = data_ctx;
83 rs->rs_alloc_flags = alloc_flags;
87 rangeset_fini(struct rangeset *rs)
91 rangeset_remove_all(rs);
95 rangeset_check_empty(struct rangeset *rs, uint64_t start, uint64_t end)
100 r = RANGESET_PCTRIE_LOOKUP_LE(&rs->rs_trie, end);
101 return (r == NULL || r->re_end <= start);
105 rangeset_insert(struct rangeset *rs, uint64_t start, uint64_t end,
112 error = rangeset_remove(rs, start, end);
118 error = RANGESET_PCTRIE_INSERT(&rs->rs_trie, r);
124 rangeset_remove_pred(struct rangeset *rs, uint64_t start, uint64_t end,
127 struct rs_el *r, *rn;
132 for (; end > 0 && start < end;) {
133 r = RANGESET_PCTRIE_LOOKUP_LE(&rs->rs_trie, end - 1);
138 * ------============================--|-------|----
141 if (r->re_end <= start)
144 if (r->re_end <= end) {
145 if (r->re_start < start) {
147 * ------========|==============-------|----
150 if (pred(rs->rs_data_ctx, r))
156 * ------|--------===================----------|----
160 if (pred(rs->rs_data_ctx, r)) {
161 RANGESET_PCTRIE_REMOVE(&rs->rs_trie,
163 rs->rs_free_data(rs->rs_data_ctx, r);
169 * ------|--------====================|==========----
172 if (r->re_start >= start) {
173 if (pred(rs->rs_data_ctx, r)) {
174 RANGESET_PCTRIE_REMOVE(&rs->rs_trie,
177 error = RANGESET_PCTRIE_INSERT(&rs->rs_trie, r);
179 * The insert above must succeed
180 * because rs_node zone is marked
181 * nofree and we freed one element
192 * ------=========|===================|==========----
195 if (pred(rs->rs_data_ctx, r)) {
197 * Split. Can only happen once, and then if
198 * any allocation fails, the rangeset is kept
201 rn = rs->rs_dup_data(rs->rs_data_ctx, r);
207 rn->re_end = r->re_end;
208 error = RANGESET_PCTRIE_INSERT(&rs->rs_trie, rn);
210 rs->rs_free_data(rs->rs_data_ctx, rn);
222 rangeset_true_pred(void *ctx __unused, void *r __unused)
229 rangeset_remove(struct rangeset *rs, uint64_t start, uint64_t end)
232 return (rangeset_remove_pred(rs, start, end, rangeset_true_pred));
236 rangeset_remove_all(struct rangeset *rs)
241 r = RANGESET_PCTRIE_LOOKUP_GE(&rs->rs_trie, 0);
244 RANGESET_PCTRIE_REMOVE(&rs->rs_trie, r->re_start);
245 rs->rs_free_data(rs->rs_data_ctx, r);
250 rangeset_lookup(struct rangeset *rs, uint64_t place)
255 r = RANGESET_PCTRIE_LOOKUP_LE(&rs->rs_trie, place);
258 if (r->re_end <= place)
264 rangeset_copy(struct rangeset *dst_rs, struct rangeset *src_rs)
266 struct rs_el *src_r, *dst_r;
270 MPASS(pctrie_is_empty(&dst_rs->rs_trie));
271 rangeset_check(src_rs);
272 MPASS(dst_rs->rs_dup_data == src_rs->rs_dup_data);
275 for (cursor = 0;; cursor = src_r->re_start + 1) {
276 src_r = RANGESET_PCTRIE_LOOKUP_GE(&src_rs->rs_trie, cursor);
279 dst_r = dst_rs->rs_dup_data(dst_rs->rs_data_ctx, src_r);
284 error = RANGESET_PCTRIE_INSERT(&dst_rs->rs_trie, dst_r);
289 rangeset_remove_all(dst_rs);
295 rangeset_check(struct rangeset *rs)
297 struct rs_el *r, *rp;
300 for (cursor = 0, rp = NULL;; cursor = r->re_start + 1, rp = r) {
301 r = RANGESET_PCTRIE_LOOKUP_GE(&rs->rs_trie, cursor);
304 KASSERT(r->re_start < r->re_end,
305 ("invalid interval rs %p elem %p (%#jx, %#jx)",
306 rs, r, (uintmax_t)r->re_start, (uintmax_t)r->re_end));
308 KASSERT(rp->re_end <= r->re_start,
309 ("non-ascending neighbors rs %p "
310 "prev elem %p (%#jx, %#jx) elem %p (%#jx, %#jx)",
311 rs, rp, (uintmax_t)rp->re_start,
312 (uintmax_t)rp->re_end, r, (uintmax_t)r->re_start,
313 (uintmax_t)r->re_end));
321 #include <sys/kernel.h>
324 DB_SHOW_COMMAND(rangeset, rangeset_show_fn)
331 db_printf("show rangeset addr\n");
335 rs = (struct rangeset *)addr;
336 db_printf("rangeset %p\n", rs);
337 for (cursor = 0;; cursor = r->re_start + 1) {
338 r = RANGESET_PCTRIE_LOOKUP_GE(&rs->rs_trie, cursor);
341 db_printf(" el %p start %#jx end %#jx\n",
342 r, r->re_start, r->re_end);