2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2019 The FreeBSD Foundation
7 * This software was developed by Konstantin Belousov <kib@FreeBSD.org>
8 * under sponsorship from the FreeBSD Foundation.
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
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.
19 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 #ifndef _SYS_RANGESET_H
35 #define _SYS_RANGESET_H
39 #include <sys/_rangeset.h>
41 typedef bool (*rs_pred_t)(void *ctx, void *r);
44 * This structure must be embedded at the start of the rangeset element.
47 uint64_t re_start; /* pctrie key */
51 void rangeset_init(struct rangeset *rs, rs_dup_data_t dup_data,
52 rs_free_data_t free_data, void *rs_data_ctx, u_int alloc_flags);
53 void rangeset_fini(struct rangeset *rs);
55 bool rangeset_check_empty(struct rangeset *rs, uint64_t start,
59 * r point to the app data with struct rs_el at the beginning.
61 int rangeset_insert(struct rangeset *rs, uint64_t start, uint64_t end,
65 * Guarantees that on error the rangeset is not modified. Remove
66 * might need to split element if its start/end completely cover the
67 * removed range, in which case ENOMEM might be returned.
69 void rangeset_remove_all(struct rangeset *rs);
70 int rangeset_remove(struct rangeset *rs, uint64_t start, uint64_t end);
71 int rangeset_remove_pred(struct rangeset *rs, uint64_t start,
72 uint64_t end, rs_pred_t pred);
75 * Really returns the pointer to the data with struct rs_el embedded
78 void *rangeset_lookup(struct rangeset *rs, uint64_t place);
81 * Copies src_rs entries into dst_rs. dst_rs must be empty.
82 * Leaves dst_rs empty on failure.
84 int rangeset_copy(struct rangeset *dst_rs, struct rangeset *src_rs);