ewah/ewok.h

   1 /**
   2  * Copyright 2013, GitHub, Inc
   3  * Copyright 2009-2013, Daniel Lemire, Cliff Moon,
   4  *      David McIntosh, Robert Becho, Google Inc. and Veronika Zenz
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU General Public License
   8  * as published by the Free Software Foundation; either version 2
   9  * of the License, or (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  19  */
  20 #ifndef __EWOK_BITMAP_H__
  21 #define __EWOK_BITMAP_H__
  22
  23 #ifndef ewah_malloc
  24 #       define ewah_malloc xmalloc
  25 #endif
  26 #ifndef ewah_realloc
  27 #       define ewah_realloc xrealloc
  28 #endif
  29 #ifndef ewah_calloc
  30 #       define ewah_calloc xcalloc
  31 #endif
  32
  33 typedef uint64_t eword_t;
  34 #define BITS_IN_WORD (sizeof(eword_t) * 8)
  35
  36 /**
  37  * Do not use __builtin_popcountll. The GCC implementation
  38  * is notoriously slow on all platforms.
  39  *
  40  * See: http://gcc.gnu.org/bugzilla/show_bug.cgi?id=36041
  41  */
  42 static inline uint32_t ewah_bit_popcount64(uint64_t x)
  43 {
  44         x = (x & 0x5555555555555555ULL) + ((x >>  1) & 0x5555555555555555ULL);
  45         x = (x & 0x3333333333333333ULL) + ((x >>  2) & 0x3333333333333333ULL);
  46         x = (x & 0x0F0F0F0F0F0F0F0FULL) + ((x >>  4) & 0x0F0F0F0F0F0F0F0FULL);
  47         return (x * 0x0101010101010101ULL) >> 56;
  48 }
  49
  50 /* __builtin_ctzll was not available until 3.4.0 */
  51 #if defined(__GNUC__) && (__GNUC__ > 3 || (__GNUC__ == 3  && __GNUC_MINOR > 3))
  52 #define ewah_bit_ctz64(x) __builtin_ctzll(x)
  53 #else
  54 static inline int ewah_bit_ctz64(uint64_t x)
  55 {
  56         int n = 0;
  57         if ((x & 0xffffffff) == 0) { x >>= 32; n += 32; }
  58         if ((x &     0xffff) == 0) { x >>= 16; n += 16; }
  59         if ((x &       0xff) == 0) { x >>=  8; n +=  8; }
  60         if ((x &        0xf) == 0) { x >>=  4; n +=  4; }
  61         if ((x &        0x3) == 0) { x >>=  2; n +=  2; }
  62         if ((x &        0x1) == 0) { x >>=  1; n +=  1; }
  63         return n + !x;
  64 }
  65 #endif
  66
  67 struct ewah_bitmap {
  68         eword_t *buffer;
  69         size_t buffer_size;
  70         size_t alloc_size;
  71         size_t bit_size;
  72         eword_t *rlw;
  73 };
  74
  75 typedef void (*ewah_callback)(size_t pos, void *);
  76
  77 struct ewah_bitmap *ewah_pool_new(void);
  78 void ewah_pool_free(struct ewah_bitmap *self);
  79
  80 /**
  81  * Allocate a new EWAH Compressed bitmap
  82  */
  83 struct ewah_bitmap *ewah_new(void);
  84
  85 /**
  86  * Clear all the bits in the bitmap. Does not free or resize
  87  * memory.
  88  */
  89 void ewah_clear(struct ewah_bitmap *self);
  90
  91 /**
  92  * Free all the memory of the bitmap
  93  */
  94 void ewah_free(struct ewah_bitmap *self);
  95
  96 int ewah_serialize_to(struct ewah_bitmap *self,
  97                       int (*write_fun)(void *out, const void *buf, size_t len),
  98                       void *out);
  99 int ewah_serialize(struct ewah_bitmap *self, int fd);
 100 int ewah_serialize_native(struct ewah_bitmap *self, int fd);
 101
 102 int ewah_deserialize(struct ewah_bitmap *self, int fd);
 103 int ewah_read_mmap(struct ewah_bitmap *self, void *map, size_t len);
 104 int ewah_read_mmap_native(struct ewah_bitmap *self, void *map, size_t len);
 105
 106 uint32_t ewah_checksum(struct ewah_bitmap *self);
 107
 108 /**
 109  * Logical not (bitwise negation) in-place on the bitmap
 110  *
 111  * This operation is linear time based on the size of the bitmap.
 112  */
 113 void ewah_not(struct ewah_bitmap *self);
 114
 115 /**
 116  * Call the given callback with the position of every single bit
 117  * that has been set on the bitmap.
 118  *
 119  * This is an efficient operation that does not fully decompress
 120  * the bitmap.
 121  */
 122 void ewah_each_bit(struct ewah_bitmap *self, ewah_callback callback, void *payload);
 123
 124 /**
 125  * Set a given bit on the bitmap.
 126  *
 127  * The bit at position `pos` will be set to true. Because of the
 128  * way that the bitmap is compressed, a set bit cannot be unset
 129  * later on.
 130  *
 131  * Furthermore, since the bitmap uses streaming compression, bits
 132  * can only set incrementally.
 133  *
 134  * E.g.
 135  *              ewah_set(bitmap, 1); // ok
 136  *              ewah_set(bitmap, 76); // ok
 137  *              ewah_set(bitmap, 77); // ok
 138  *              ewah_set(bitmap, 8712800127); // ok
 139  *              ewah_set(bitmap, 25); // failed, assert raised
 140  */
 141 void ewah_set(struct ewah_bitmap *self, size_t i);
 142
 143 struct ewah_iterator {
 144         const eword_t *buffer;
 145         size_t buffer_size;
 146
 147         size_t pointer;
 148         eword_t compressed, literals;
 149         eword_t rl, lw;
 150         int b;
 151 };
 152
 153 /**
 154  * Initialize a new iterator to run through the bitmap in uncompressed form.
 155  *
 156  * The iterator can be stack allocated. The underlying bitmap must not be freed
 157  * before the iteration is over.
 158  *
 159  * E.g.
 160  *
 161  *              struct ewah_bitmap *bitmap = ewah_new();
 162  *              struct ewah_iterator it;
 163  *
 164  *              ewah_iterator_init(&it, bitmap);
 165  */
 166 void ewah_iterator_init(struct ewah_iterator *it, struct ewah_bitmap *parent);
 167
 168 /**
 169  * Yield every single word in the bitmap in uncompressed form. This is:
 170  * yield single words (32-64 bits) where each bit represents an actual
 171  * bit from the bitmap.
 172  *
 173  * Return: true if a word was yield, false if there are no words left
 174  */
 175 int ewah_iterator_next(eword_t *next, struct ewah_iterator *it);
 176
 177 void ewah_or(
 178         struct ewah_bitmap *ewah_i,
 179         struct ewah_bitmap *ewah_j,
 180         struct ewah_bitmap *out);
 181
 182 void ewah_and_not(
 183         struct ewah_bitmap *ewah_i,
 184         struct ewah_bitmap *ewah_j,
 185         struct ewah_bitmap *out);
 186
 187 void ewah_xor(
 188         struct ewah_bitmap *ewah_i,
 189         struct ewah_bitmap *ewah_j,
 190         struct ewah_bitmap *out);
 191
 192 void ewah_and(
 193         struct ewah_bitmap *ewah_i,
 194         struct ewah_bitmap *ewah_j,
 195         struct ewah_bitmap *out);
 196
 197 /**
 198  * Direct word access
 199  */
 200 size_t ewah_add_empty_words(struct ewah_bitmap *self, int v, size_t number);
 201 void ewah_add_dirty_words(
 202         struct ewah_bitmap *self, const eword_t *buffer, size_t number, int negate);
 203 size_t ewah_add(struct ewah_bitmap *self, eword_t word);
 204
 205
 206 /**
 207  * Uncompressed, old-school bitmap that can be efficiently compressed
 208  * into an `ewah_bitmap`.
 209  */
 210 struct bitmap {
 211         eword_t *words;
 212         size_t word_alloc;
 213 };
 214
 215 struct bitmap *bitmap_new(void);
 216 void bitmap_set(struct bitmap *self, size_t pos);
 217 void bitmap_clear(struct bitmap *self, size_t pos);
 218 int bitmap_get(struct bitmap *self, size_t pos);
 219 void bitmap_reset(struct bitmap *self);
 220 void bitmap_free(struct bitmap *self);
 221 int bitmap_equals(struct bitmap *self, struct bitmap *other);
 222 int bitmap_is_subset(struct bitmap *self, struct bitmap *super);
 223
 224 struct ewah_bitmap * bitmap_to_ewah(struct bitmap *bitmap);
 225 struct bitmap *ewah_to_bitmap(struct ewah_bitmap *ewah);
 226
 227 void bitmap_and_not(struct bitmap *self, struct bitmap *other);
 228 void bitmap_or_ewah(struct bitmap *self, struct ewah_bitmap *other);
 229 void bitmap_or(struct bitmap *self, const struct bitmap *other);
 230
 231 void bitmap_each_bit(struct bitmap *self, ewah_callback callback, void *data);
 232 size_t bitmap_popcount(struct bitmap *self);
 233
 234 #endif