MMappedVector.hpp

Go to the documentation of this file.

/**
 * @file MMappedVector.hpp
 * @brief Template implementation of @c MMappedVector<T>.
 *
 * Provides the out-of-line definitions of all @c MMappedVector<T>
 * methods declared in @c MMappedVector.h.  This file must be included
 * by any translation unit that instantiates @c MMappedVector<T> for a
 * specific @c T.
 *
 * Implemented methods:
 * - @c MMappedVector(): open/create the backing file and map it.
 * - @c ~MMappedVector(): sync and unmap.
 * - @c operator[](k) const: read element @p k.
 * - @c operator[](k): write element @p k.
 * - @c add(): append one element, growing the file if necessary.
 * - @c sync(): flush dirty pages with @c msync().
 *
 * Internal helpers:
 * - @c mmap(): map (or remap) @p length bytes.
 * - @c grow(): double the capacity and remap.
 */
#ifndef MMAPPED_VECTOR_HPP
#define MMAPPED_VECTOR_HPP
 
#include "MMappedVector.h"
 
#include <cassert>
#include <cerrno>
#include <cstdint>
#include <cstring>
#include <new>
#include <stdexcept>
#include <string>
#include <vector>
 
#include <fcntl.h>
#include <unistd.h>
 
#include <sys/mman.h>
 
template <typename T>
MMappedVector<T>::MMappedVector(const char *filename, bool read_only, uint64_t magic_value)
{
  fd=open(filename, O_CREAT|(read_only?O_RDONLY:O_RDWR), 0600); // flawfinder: ignore
  if(fd==-1)
    throw std::runtime_error(strerror(errno));
 
  auto length = lseek(fd, 0, SEEK_END);
  lseek(fd, 0, SEEK_SET);
 
  bool empty=false;
 
  if(length==0) {
    empty=true;
    length=offsetof(data_t, d)+sizeof(T)*STARTING_CAPACITY;
    if(ftruncate(fd, length))
      throw std::runtime_error(strerror(errno));
  }
 
  mmap(length, read_only);
 
  if(empty) {
    data->magic     = magic_value;
    data->version   = 1;
    data->elem_size = static_cast<uint16_t>(sizeof(T));
    data->_reserved = 0;
    data->capacity    = STARTING_CAPACITY;
    data->nb_elements = 0;
  } else {
    if(data->magic != magic_value)
      throw std::runtime_error("ProvSQL mmap: wrong file type (magic mismatch)");
    if(data->version != 1)
      throw std::runtime_error("ProvSQL mmap: unsupported format version "
                               + std::to_string(data->version));
    if(data->elem_size != sizeof(T))
      throw std::runtime_error("ProvSQL mmap: element size mismatch (recompile required)");
  }
}
 
template <typename T>
void MMappedVector<T>::mmap(size_t length, bool read_only)
{
  data = reinterpret_cast<data_t *>(::mmap(
                                      NULL,
                                      length,
                                      PROT_READ|(read_only?0:PROT_WRITE),
                                      MAP_SHARED,
                                      fd,
                                      0));
  if(data == MAP_FAILED)
    throw std::runtime_error(strerror(errno));
}
 
template <typename T>
void MMappedVector<T>::grow()
{
  sync();
  auto new_capacity = data->capacity*2;
  munmap(data, offsetof(data_t,d)+sizeof(T)*data->capacity);
 
  auto new_length = offsetof(data_t,d)+sizeof(T)*new_capacity;
  if(ftruncate(fd, new_length))
    throw std::runtime_error(strerror(errno));
  mmap(new_length, false);
 
  data->capacity = new_capacity;
}
 
template <typename T>
MMappedVector<T>::~MMappedVector()
{
  munmap(data, offsetof(data_t,d)+sizeof(T)*data->capacity);
  close(fd);
}
 
template <typename T>
inline const T &MMappedVector<T>::operator[](unsigned long k) const
{
  return data->d[k];
}
 
template <typename T>
inline T &MMappedVector<T>::operator[](unsigned long k)
{
  return data->d[k];
}
 
template <typename T>
void MMappedVector<T>::add(const T &value)
{
  if(data->nb_elements == data->capacity)
    grow();
 
  data->d[data->nb_elements++] = value;
}
 
template <typename T>
void MMappedVector<T>::sync()
{
  msync(data, offsetof(data_t,d)+sizeof(T)*data->capacity, MS_SYNC);
}
 
#endif /* MMAPPED_VECTOR_HPP */