libcfs/include/libcfs/bitmap.h

   1 /*
   2  * GPL HEADER START
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License version 2 only,
   8  * as published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License version 2 for more details (a copy is included
  14  * in the LICENSE file that accompanied this code).
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * version 2 along with this program; If not, see
  18  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  19  *
  20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  21  * CA 95054 USA or visit www.sun.com if you need additional information or
  22  * have any questions.
  23  *
  24  * GPL HEADER END
  25  */
  26 /*
  27  * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  *
  30  * Copyright (c) 2012, 2014, Intel Corporation.
  31  */
  32 /*
  33  * This file is part of Lustre, http://www.lustre.org/
  34  * Lustre is a trademark of Sun Microsystems, Inc.
  35  */
  36 #ifndef _LIBCFS_BITMAP_H_
  37 #define _LIBCFS_BITMAP_H_
  38
  39 struct cfs_bitmap {
  40         unsigned int size;
  41         unsigned long data[0];
  42 };
  43
  44 #define CFS_BITMAP_SIZE(nbits) \
  45         (((nbits / BITS_PER_LONG) + 1) * sizeof(long) + \
  46         sizeof(struct cfs_bitmap))
  47
  48 static inline
  49 struct cfs_bitmap *CFS_ALLOCATE_BITMAP(int size)
  50 {
  51         struct cfs_bitmap *ptr;
  52
  53         LIBCFS_ALLOC(ptr, CFS_BITMAP_SIZE(size));
  54         if (ptr == NULL)
  55                 RETURN(ptr);
  56
  57         ptr->size = size;
  58
  59         RETURN(ptr);
  60 }
  61
  62 static inline void CFS_RESET_BITMAP(struct cfs_bitmap *bitmap)
  63 {
  64         if (bitmap->size > 0) {
  65                 int nbits = bitmap->size;
  66
  67                 memset(bitmap, 0, CFS_BITMAP_SIZE(nbits));
  68                 bitmap->size = nbits;
  69         }
  70 }
  71
  72 #define CFS_FREE_BITMAP(ptr)    LIBCFS_FREE(ptr, CFS_BITMAP_SIZE(ptr->size))
  73
  74 static inline
  75 void cfs_bitmap_set(struct cfs_bitmap *bitmap, int nbit)
  76 {
  77         set_bit(nbit, bitmap->data);
  78 }
  79
  80 static inline
  81 void cfs_bitmap_clear(struct cfs_bitmap *bitmap, int nbit)
  82 {
  83         test_and_clear_bit(nbit, bitmap->data);
  84 }
  85
  86 static inline
  87 int cfs_bitmap_check(struct cfs_bitmap *bitmap, int nbit)
  88 {
  89         return test_bit(nbit, bitmap->data);
  90 }
  91
  92 static inline
  93 int cfs_bitmap_test_and_clear(struct cfs_bitmap *bitmap, int nbit)
  94 {
  95         return test_and_clear_bit(nbit, bitmap->data);
  96 }
  97
  98 /* return 0 is bitmap has none set bits */
  99 static inline
 100 int cfs_bitmap_check_empty(struct cfs_bitmap *bitmap)
 101 {
 102         return find_first_bit(bitmap->data, bitmap->size) == bitmap->size;
 103 }
 104
 105 static inline
 106 void cfs_bitmap_copy(struct cfs_bitmap *new, struct cfs_bitmap *old)
 107 {
 108         size_t newsize;
 109
 110         LASSERT(new->size >= old->size);
 111         newsize = new->size;
 112         memcpy(new, old, CFS_BITMAP_SIZE(old->size));
 113         new->size = newsize;
 114 }
 115
 116 #define cfs_foreach_bit(bitmap, pos)                                    \
 117         for ((pos) = find_first_bit((bitmap)->data, bitmap->size);      \
 118              (pos) < (bitmap)->size;                                    \
 119              (pos) = find_next_bit((bitmap)->data, (bitmap)->size, (pos) + 1))
 120
 121 #endif