Cytore.hpp

   1 // Copyright Notice (GNU Affero GPL) {{{
   2 /* Cyndir - (Awesome) Memory Mapped Dictionary
   3  * Copyright (C) 2010  Jay Freeman (saurik)
   4 */
   5
   6 /*
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU Affero General Public License as
   9  * published by the Free Software Foundation, either version 3 of the
  10  * License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU Affero General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Affero General Public License
  18  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19 */
  20 // }}}
  21
  22 #ifndef CYTORE_HPP
  23 #define CYTORE_HPP
  24
  25 #include <fcntl.h>
  26
  27 #include <sys/mman.h>
  28 #include <sys/stat.h>
  29
  30 #include <cstdio>
  31 #include <cstdlib>
  32
  33 #include <errno.h>
  34 #include <stdint.h>
  35 #include <unistd.h>
  36
  37 #define _assert(test) do \
  38     if (!(test)) { \
  39         fprintf(stderr, "_assert(%d:%s)@%s:%u[%s]\n", errno, #test, __FILE__, __LINE__, __FUNCTION__); \
  40         exit(-1); \
  41     } \
  42 while (false)
  43
  44 namespace Cytore {
  45
  46 static const uint32_t Magic = 'cynd';
  47
  48 struct Header {
  49     uint32_t magic_;
  50     uint32_t version_;
  51     uint32_t size_;
  52     uint32_t reserved_;
  53 };
  54
  55 template <typename Target_>
  56 class Offset {
  57   private:
  58     uint32_t offset_;
  59
  60   public:
  61     Offset() :
  62         offset_(0)
  63     {
  64     }
  65
  66     Offset(uint32_t offset) :
  67         offset_(offset)
  68     {
  69     }
  70
  71     Offset &operator =(uint32_t offset) {
  72         offset_ = offset;
  73         return *this;
  74     }
  75
  76     uint32_t GetOffset() const {
  77         return offset_;
  78     }
  79
  80     bool IsNull() const {
  81         return offset_ == 0;
  82     }
  83 };
  84
  85 struct Block {
  86     Cytore::Offset<void> reserved_;
  87 };
  88
  89 template <typename Type_>
  90 static _finline Type_ Round(Type_ value, Type_ size) {
  91     Type_ mask(size - 1);
  92     return value + mask & ~mask;
  93 }
  94
  95 template <typename Base_>
  96 class File {
  97   private:
  98     static const unsigned Shift_ = 17;
  99     static const size_t Block_ = 1 << Shift_;
 100     static const size_t Mask_ = Block_ - 1;
 101
 102   private:
 103     int file_;
 104
 105     typedef std::vector<uint8_t *> BlockVector_;
 106     BlockVector_ blocks_;
 107
 108     struct Mapping_ {
 109         uint8_t *data_;
 110         size_t size_;
 111
 112         Mapping_(uint8_t *data, size_t size) :
 113             data_(data),
 114             size_(size)
 115         {
 116         }
 117     };
 118
 119     typedef std::vector<Mapping_> MappingVector_;
 120     MappingVector_ maps_;
 121
 122     Header &Header_() {
 123         return *reinterpret_cast<Header *>(blocks_[0]);
 124     }
 125
 126     uint32_t &Size_() {
 127         return Header_().size_;
 128     }
 129
 130     void Map_(size_t size) {
 131         size_t before(blocks_.size() * Block_);
 132         size_t extend(size - before);
 133
 134         void *data(mmap(NULL, extend, PROT_READ | PROT_WRITE, MAP_FILE | MAP_SHARED, file_, before));
 135         _assert(data != MAP_FAILED);
 136         uint8_t *bytes(reinterpret_cast<uint8_t *>(data));
 137
 138         maps_.push_back(Mapping_(bytes, extend));
 139         for (size_t i(0); i != extend >> Shift_; ++i)
 140             blocks_.push_back(bytes + Block_ * i);
 141     }
 142
 143     bool Truncate_(size_t capacity) {
 144         capacity = Round(capacity, Block_);
 145
 146         int error(ftruncate(file_, capacity));
 147         if (error != 0)
 148             return false;
 149
 150         Map_(capacity);
 151         return true;
 152     }
 153
 154   public:
 155     File() :
 156         file_(-1)
 157     {
 158     }
 159
 160     File(const char *path) :
 161         file_(-1)
 162     {
 163         Open(path);
 164     }
 165
 166     ~File() {
 167         for (typename MappingVector_::const_iterator map(maps_.begin()); map != maps_.end(); ++map)
 168             munmap(map->data_, map->size_);
 169         close(file_);
 170     }
 171
 172     void Sync() {
 173         for (typename MappingVector_::const_iterator map(maps_.begin()); map != maps_.end(); ++map)
 174             msync(map->data_, map->size_, MS_SYNC);
 175     }
 176
 177     size_t Capacity() const {
 178         return blocks_.size() * Block_;
 179     }
 180
 181     void Open(const char *path) {
 182         _assert(file_ == -1);
 183         file_ = open(path, O_RDWR | O_CREAT | O_EXLOCK, S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH);
 184         _assert(file_ != -1);
 185
 186         struct stat stat;
 187         _assert(fstat(file_, &stat) == 0);
 188
 189         size_t core(sizeof(Header) + sizeof(Base_));
 190
 191         size_t size(stat.st_size);
 192         if (size == 0) {
 193             _assert(Truncate_(core));
 194             Header_().magic_ = Magic;
 195             Size_() = core;
 196         } else {
 197             _assert(size >= core);
 198             // XXX: this involves an unneccessary call to ftruncate()
 199             _assert(Truncate_(size));
 200             _assert(Header_().magic_ == Magic);
 201             _assert(Header_().version_ == 0);
 202         }
 203     }
 204
 205     bool Reserve(size_t capacity) {
 206         if (capacity <= Capacity())
 207             return true;
 208
 209         uint8_t *block(blocks_.back());
 210         blocks_.pop_back();
 211
 212         if (Truncate_(capacity))
 213             return true;
 214         else {
 215             blocks_.push_back(block);
 216             return false;
 217         }
 218     }
 219
 220     template <typename Target_>
 221     Target_ &Get(uint32_t offset) {
 222         return *reinterpret_cast<Target_ *>(offset == 0 ? NULL : blocks_[offset >> Shift_] + (offset & Mask_));
 223     }
 224
 225     template <typename Target_>
 226     Target_ &Get(Offset<Target_> &ref) {
 227         return Get<Target_>(ref.GetOffset());
 228     }
 229
 230     Base_ *operator ->() {
 231         return &Get<Base_>(sizeof(Header));
 232     }
 233
 234     template <typename Target_>
 235     Offset<Target_> New(size_t extra = 0) {
 236         size_t size(sizeof(Target_) + extra);
 237         size = Round(size, sizeof(uintptr_t));
 238
 239         uint32_t offset;
 240         if (!Reserve(Size_() + size))
 241             offset = 0;
 242         else {
 243             offset = Size_();
 244             Size_() += size;
 245         }
 246
 247         return Offset<Target_>(offset);
 248     }
 249 };
 250
 251 }
 252
 253 #endif//CYTORE_HPP