git.sesse.net Git - fjl/blob - bitsource.h

   1 #ifndef _BITSOURCE_H
   2 #define _BITSOURCE_H 1
   3
   4 #include <assert.h>
   5 #include <stdbool.h>
   6 #include <stddef.h>
   7 #include <stdint.h>
   8 #include <sys/types.h>
   9 #include <arpa/inet.h>
  10
  11 #include "input.h"
  12
  13 // Optimize for 64 bits. We might want to replace this for 32-bit machines
  14 // (benchmark later).
  15 typedef uint64_t bitreservoir_t;
  16 typedef uint32_t bitreservoir_fill_t;
  17
  18 // Note: We return bitreservoir_t here, so we can get implicit zero extension on amd64.
  19 static inline bitreservoir_t read_bitreservoir_fill(uint8_t* source)
  20 {
  21 #if defined(__GNUC__) && (defined(__i386__) || defined(__x86_64__))
  22         bitreservoir_t ret;
  23         asm("bswapl %1" : "=r" (ret) : "0" (*(bitreservoir_fill_t*)(source)));
  24         return ret;
  25 #else
  26         return ntohl(*(bitreservoir_fill_t*)(source));
  27 #endif
  28 }
  29
  30 static const unsigned BITRESERVOIR_SIZE = 8 * sizeof(bitreservoir_t);
  31 static const unsigned BITRESERVOIR_FILL_SIZE = 8 * sizeof(bitreservoir_fill_t);
  32 static const unsigned BYTERESERVOIR_SIZE = 4096;
  33
  34 // A data source for efficient reading of bit-level data.
  35 struct bit_source {
  36         // Short-term bit reservoir; holds up to 64 bits. When it's empty,
  37         // it needs to get refilled from the medium-term bit reservoir.
  38         bitreservoir_t bits;
  39         unsigned bits_available;
  40
  41         // Medium-term bit reservoir; holds a few kilobytes of spare data.
  42         // When this is empty, it needs to be refilled from the input
  43         // stream.
  44         uint8_t* bytes;
  45         uint8_t* byte_read_ptr;
  46         unsigned bytes_available;
  47
  48         // Some clients will purposedly read a bit ahead of the stream, causing
  49         // problems at EOF. Thus, the client is allowed to request that we pad
  50         // the end stream with a few bytes after the source reports EOF.
  51         int padding_bytes_available;
  52
  53         // Data source.
  54         input_func_t* input_func;
  55         void* userdata;
  56         bool source_eof;
  57 };
  58
  59 void init_bit_source(struct bit_source* source, input_func_t* input_func,
  60                      unsigned padding_bytes, void* userdata);
  61
  62 // Internal function. Do not use.
  63 void possibly_refill_slow_path(struct bit_source* source, unsigned num_bits);
  64
  65 // Make sure there's at least NUM_BITS available in the short-term bit reservoir.
  66 // You usually want to call this before read_bits(). The reason it's separate
  67 // is that if you want two reads and you know the size of both, it's faster to
  68 // refill A+B, read A, read B than refill A, read A, refill B, read B.
  69 static inline void possibly_refill(struct bit_source* source, unsigned num_bits)
  70 {
  71         assert(num_bits <= BITRESERVOIR_FILL_SIZE + 1);
  72
  73         if (source->bits_available >= num_bits) {
  74                 // Fast path (~90% of invocations?)
  75                 return;
  76         }
  77
  78         // Slower path (~99% of remaining invocations?)
  79         assert(source->bits_available + BITRESERVOIR_FILL_SIZE < BITRESERVOIR_SIZE);
  80         if (source->bytes_available >= sizeof(bitreservoir_fill_t)) {
  81                 bitreservoir_t fill = read_bitreservoir_fill(source->byte_read_ptr);
  82                 source->byte_read_ptr += sizeof(bitreservoir_fill_t);
  83                 source->bytes_available -= sizeof(bitreservoir_fill_t);
  84                 source->bits |= (bitreservoir_t)fill << (BITRESERVOIR_SIZE - BITRESERVOIR_FILL_SIZE - source->bits_available);
  85                 source->bits_available += BITRESERVOIR_FILL_SIZE;
  86                 return;
  87         }
  88
  89         // Slow path: Refill from data source.
  90         // Should not be inlined, so split into a separate function.
  91         possibly_refill_slow_path(source, num_bits);
  92 }
  93
  94 static inline unsigned read_bits(struct bit_source* source, unsigned num_bits)
  95 {
  96         assert(source->bits_available >= num_bits);
  97         unsigned ret = (source->bits >> (BITRESERVOIR_SIZE - num_bits));
  98         source->bits <<= num_bits;
  99         source->bits_available -= num_bits;
 100         return ret;
 101 }
 102
 103 static inline unsigned peek_bits(struct bit_source* source, unsigned num_bits)
 104 {
 105         assert(source->bits_available >= num_bits);
 106         return (source->bits >> (BITRESERVOIR_SIZE - num_bits));
 107 }
 108
 109 #endif /* !defined(_BITSOURCE_H) */