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 typedef struct {
  40         unsigned int  size;
  41         unsigned long data[0];
  42 } cfs_bitmap_t;
  43
  44 #define CFS_BITMAP_SIZE(nbits) \
  45      (((nbits/BITS_PER_LONG)+1)*sizeof(long)+sizeof(cfs_bitmap_t))
  46
  47 static inline
  48 cfs_bitmap_t *CFS_ALLOCATE_BITMAP(int size)
  49 {
  50         cfs_bitmap_t *ptr;
  51
  52         LIBCFS_ALLOC(ptr, CFS_BITMAP_SIZE(size));
  53         if (ptr == NULL)
  54                 RETURN(ptr);
  55
  56         ptr->size = size;
  57
  58         RETURN(ptr);
  59 }
  60
  61 static inline void CFS_RESET_BITMAP(cfs_bitmap_t *bitmap)
  62 {
  63         if (bitmap->size > 0) {
  64                 int nbits = bitmap->size;
  65
  66                 memset(bitmap, 0, CFS_BITMAP_SIZE(nbits));
  67                 bitmap->size = nbits;
  68         }
  69 }
  70
  71 #define CFS_FREE_BITMAP(ptr)    LIBCFS_FREE(ptr, CFS_BITMAP_SIZE(ptr->size))
  72
  73 static inline
  74 void cfs_bitmap_set(cfs_bitmap_t *bitmap, int nbit)
  75 {
  76         set_bit(nbit, bitmap->data);
  77 }
  78
  79 static inline
  80 void cfs_bitmap_clear(cfs_bitmap_t *bitmap, int nbit)
  81 {
  82         test_and_clear_bit(nbit, bitmap->data);
  83 }
  84
  85 static inline
  86 int cfs_bitmap_check(cfs_bitmap_t *bitmap, int nbit)
  87 {
  88         return test_bit(nbit, bitmap->data);
  89 }
  90
  91 static inline
  92 int cfs_bitmap_test_and_clear(cfs_bitmap_t *bitmap, int nbit)
  93 {
  94         return test_and_clear_bit(nbit, bitmap->data);
  95 }
  96
  97 /* return 0 is bitmap has none set bits */
  98 static inline
  99 int cfs_bitmap_check_empty(cfs_bitmap_t *bitmap)
 100 {
 101         return find_first_bit(bitmap->data, bitmap->size) == bitmap->size;
 102 }
 103
 104 static inline
 105 void cfs_bitmap_copy(cfs_bitmap_t *new, cfs_bitmap_t *old)
 106 {
 107         size_t newsize;
 108
 109         LASSERT(new->size >= old->size);
 110         newsize = new->size;
 111         memcpy(new, old, CFS_BITMAP_SIZE(old->size));
 112         new->size = newsize;
 113 }
 114
 115 #define cfs_foreach_bit(bitmap, pos)                                    \
 116         for ((pos) = find_first_bit((bitmap)->data, bitmap->size);      \
 117              (pos) < (bitmap)->size;                                    \
 118              (pos) = find_next_bit((bitmap)->data, (bitmap)->size, (pos) + 1))
 119
 120 #endif