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 /*
  31  * This file is part of Lustre, http://www.lustre.org/
  32  * Lustre is a trademark of Sun Microsystems, Inc.
  33  */
  34 #ifndef _LIBCFS_BITMAP_H_
  35 #define _LIBCFS_BITMAP_H_
  36
  37
  38 typedef struct {
  39         int             size;
  40         unsigned long   data[0];
  41 } cfs_bitmap_t;
  42
  43 #define CFS_BITMAP_SIZE(nbits) \
  44      (((nbits/BITS_PER_LONG)+1)*sizeof(long)+sizeof(cfs_bitmap_t))
  45
  46 static inline
  47 cfs_bitmap_t *CFS_ALLOCATE_BITMAP(int size)
  48 {
  49         cfs_bitmap_t *ptr;
  50
  51         OBD_ALLOC(ptr, CFS_BITMAP_SIZE(size));
  52         if (ptr == NULL)
  53                 RETURN(ptr);
  54
  55         ptr->size = size;
  56
  57         RETURN (ptr);
  58 }
  59
  60 #define CFS_FREE_BITMAP(ptr)        OBD_FREE(ptr, CFS_BITMAP_SIZE(ptr->size))
  61
  62 static inline
  63 void cfs_bitmap_set(cfs_bitmap_t *bitmap, int nbit)
  64 {
  65         set_bit(nbit, bitmap->data);
  66 }
  67
  68 static inline
  69 void cfs_bitmap_clear(cfs_bitmap_t *bitmap, int nbit)
  70 {
  71         test_and_clear_bit(nbit, bitmap->data);
  72 }
  73
  74 static inline
  75 int cfs_bitmap_check(cfs_bitmap_t *bitmap, int nbit)
  76 {
  77         return test_bit(nbit, bitmap->data);
  78 }
  79
  80 static inline
  81 int cfs_bitmap_test_and_clear(cfs_bitmap_t *bitmap, int nbit)
  82 {
  83         return test_and_clear_bit(nbit, bitmap->data);
  84 }
  85
  86 /* return 0 is bitmap has none set bits */
  87 static inline
  88 int cfs_bitmap_check_empty(cfs_bitmap_t *bitmap)
  89 {
  90         return find_first_bit(bitmap->data, bitmap->size) == bitmap->size;
  91 }
  92
  93 static inline
  94 void cfs_bitmap_copy(cfs_bitmap_t *new, cfs_bitmap_t *old)
  95 {
  96         int newsize;
  97
  98         LASSERT(new->size >= old->size);
  99         newsize = new->size;
 100         memcpy(new, old, CFS_BITMAP_SIZE(old->size));
 101         new->size = newsize;
 102 }
 103
 104 #define cfs_foreach_bit(bitmap, pos)                                    \
 105         for ((pos) = find_first_bit((bitmap)->data, bitmap->size);      \
 106              (pos) < (bitmap)->size;                                    \
 107              (pos) = find_next_bit((bitmap)->data, (bitmap)->size, (pos) + 1))
 108
 109 #endif