xref: /titanic_41/usr/src/uts/common/sys/bitset.h (revision b6805bf78d2bbbeeaea8909a05623587b42d58b3)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 /*
22  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
23  */
24 
25 #ifndef	_BITSET_H
26 #define	_BITSET_H
27 
28 #ifdef	__cplusplus
29 extern "C" {
30 #endif
31 
32 #if (defined(_KERNEL) || defined(_KMEMUSER))
33 #include <sys/bitmap.h>
34 #include <sys/types.h>
35 
36 typedef struct bitset {
37 	ulong_t	*bs_set;
38 	uint_t	bs_words;
39 	uint_t	bs_fanout;
40 } bitset_t;
41 
42 /*
43  * Bitset initialiation / teardown
44  */
45 void		bitset_init(bitset_t *);
46 void		bitset_init_fanout(bitset_t *, uint_t);
47 void		bitset_fini(bitset_t *);
48 
49 /*
50  * Resize / query a bitset's holding capacity
51  */
52 void		bitset_resize(bitset_t *, uint_t);
53 uint_t		bitset_capacity(bitset_t *);
54 
55 /*
56  * Set / clear a bit in the set
57  */
58 void		bitset_add(bitset_t *, uint_t);
59 void		bitset_del(bitset_t *, uint_t);
60 
61 /*
62  * Atomic operations
63  */
64 void		bitset_atomic_add(bitset_t *, uint_t);
65 void		bitset_atomic_del(bitset_t *, uint_t);
66 int		bitset_atomic_test_and_add(bitset_t *, uint_t);
67 int		bitset_atomic_test_and_del(bitset_t *, uint_t);
68 
69 /*
70  * Bitset queries
71  */
72 int		bitset_in_set(bitset_t *, uint_t);
73 int		bitset_is_null(bitset_t *);
74 uint_t		bitset_find(bitset_t *);
75 
76 /*
77  * Bitset computations
78  */
79 int		bitset_and(bitset_t *, bitset_t *, bitset_t *);
80 int		bitset_or(bitset_t *, bitset_t *, bitset_t *);
81 int		bitset_xor(bitset_t *, bitset_t *, bitset_t *);
82 
83 /*
84  * Miscellaneous bitset operations
85  */
86 void		bitset_zero(bitset_t *);
87 void		bitset_copy(bitset_t *, bitset_t *);
88 int		bitset_match(bitset_t *, bitset_t *);
89 
90 #endif	/* !_KERNEL && !_KMEMUSER */
91 
92 #ifdef	__cplusplus
93 }
94 #endif
95 
96 #endif /* _BITSET_H */
97