usr/src/uts/common/sys/bitset.h

   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  * Copyright 2017 RackTop Systems.
  24  */
  25
  26 #ifndef _BITSET_H
  27 #define _BITSET_H
  28
  29 #ifdef  __cplusplus
  30 extern "C" {
  31 #endif
  32
  33 #if defined(_KERNEL) || defined(_FAKE_KERNEL) || defined(_KMEMUSER)
  34 #include <sys/bitmap.h>
  35 #include <sys/types.h>
  36
  37 typedef struct bitset {
  38         ulong_t *bs_set;
  39         uint_t  bs_words;
  40         uint_t  bs_fanout;
  41 } bitset_t;
  42
  43 /*
  44  * Bitset initialiation / teardown
  45  */
  46 void            bitset_init(bitset_t *);
  47 void            bitset_init_fanout(bitset_t *, uint_t);
  48 void            bitset_fini(bitset_t *);
  49
  50 /*
  51  * Resize / query a bitset's holding capacity
  52  */
  53 void            bitset_resize(bitset_t *, uint_t);
  54 uint_t          bitset_capacity(bitset_t *);
  55
  56 /*
  57  * Set / clear a bit in the set
  58  */
  59 void            bitset_add(bitset_t *, uint_t);
  60 void            bitset_del(bitset_t *, uint_t);
  61
  62 /*
  63  * Atomic operations
  64  */
  65 void            bitset_atomic_add(bitset_t *, uint_t);
  66 void            bitset_atomic_del(bitset_t *, uint_t);
  67 int             bitset_atomic_test_and_add(bitset_t *, uint_t);
  68 int             bitset_atomic_test_and_del(bitset_t *, uint_t);
  69
  70 /*
  71  * Bitset queries
  72  */
  73 int             bitset_in_set(bitset_t *, uint_t);
  74 int             bitset_is_null(bitset_t *);
  75 uint_t          bitset_find(bitset_t *);
  76
  77 /*
  78  * Bitset computations
  79  */
  80 int             bitset_and(bitset_t *, bitset_t *, bitset_t *);
  81 int             bitset_or(bitset_t *, bitset_t *, bitset_t *);
  82 int             bitset_xor(bitset_t *, bitset_t *, bitset_t *);
  83
  84 /*
  85  * Miscellaneous bitset operations
  86  */
  87 void            bitset_zero(bitset_t *);
  88 void            bitset_copy(bitset_t *, bitset_t *);
  89 int             bitset_match(bitset_t *, bitset_t *);
  90
  91 #endif  /* _KERNEL || _FAKE_KERNEL || _KMEMUSER */
  92
  93 #ifdef  __cplusplus
  94 }
  95 #endif
  96
  97 #endif /* _BITSET_H */