Readonly_Journal.cpp

Go to the documentation of this file.

#include "joedb/journal/Readonly_Journal.h"
#include "joedb/error/Exception.h"
 
#include <vector>
 
namespace joedb
{
 /////////////////////////////////////////////////////////////////////////////
 class Head_Shared_Lock
 /////////////////////////////////////////////////////////////////////////////
 {
  private:
   Abstract_File &file;
 
  public:
   Head_Shared_Lock(Abstract_File &file): file(file)
   {
    file.shared_lock_head();
   }
 
   Head_Shared_Lock(const Head_Shared_Lock &) = delete;
   Head_Shared_Lock &operator=(const Head_Shared_Lock &) = delete;
 
   ~Head_Shared_Lock()
   {
    file.unlock_head();
   }
 };
}
 
/////////////////////////////////////////////////////////////////////////////
#define TYPE_MACRO(cpp_type, return_type, type_id, read_method, W)\
void joedb::Readonly_Journal::perform_update_##type_id(Writable &writable)\
{\
 const cpp_type value = read_method();\
 writable.update_##type_id\
 (\
  table_of_last_operation,\
  record_of_last_operation,\
  field_of_last_update,\
  value\
 );\
}
#include "joedb/TYPE_MACRO.h"
 
/////////////////////////////////////////////////////////////////////////////
void joedb::Readonly_Journal::reset_context()
/////////////////////////////////////////////////////////////////////////////
{
 table_of_last_operation = Table_Id(0);
 record_of_last_operation = Record_Id(-1);
 field_of_last_update = Field_Id(0);
}
 
/////////////////////////////////////////////////////////////////////////////
joedb::Readonly_Journal::Readonly_Journal(Journal_Construction_Lock &lock):
/////////////////////////////////////////////////////////////////////////////
 file(lock.file),
 file_buffer(file),
 hard_index(0),
 soft_index(0),
 checkpoint_position(Header::size),
 hard_checkpoint_position(Header::size)
{
 if (lock.size != 0)
 {
  Header header;
  file.full_pread((char *)(&header), Header::size, 0);
 
  file_buffer.set_position(Header::size);
 
  if (lock.recovery == Recovery::ignore_header)
  {
   if (lock.size > checkpoint_position)
    checkpoint_position = lock.size;
  }
  else
  {
   if (header.signature != Header::joedb)
    throw Exception("missing joedb signature");
 
   if (header.version != format_version)
    throw Exception("unsupported file format version");
 
   read_checkpoint(header.checkpoint, lock.size);
 
   if (lock.size > 0 && lock.size < checkpoint_position)
    throw Exception("Checkpoint is bigger than file size");
  }
 }
 else if (!lock.is_for_writable_journal())
  throw Exception("file is empty");
 
 reset_context();
}
 
/////////////////////////////////////////////////////////////////////////////
void joedb::Readonly_Journal::read_checkpoint
/////////////////////////////////////////////////////////////////////////////
(
 const std::array<int64_t, 4> &pos,
 int64_t file_size
)
{
 for (int i = 0; i < 2; i++)
 {
  if (pos[2 * i] == pos[2 * i + 1] && pos[2 * i] >= hard_checkpoint_position)
  {
   hard_checkpoint_position = pos[2 * i];
   hard_index = i;
  }
 
  for (int j = 0; j < 2; j++)
  {
   const int64_t p = pos[2 * i + j];
   const int64_t neg = (p == INT64_MIN) ? INT64_MIN : -p; // avoid UB
   if (neg >= checkpoint_position && (file_size < 0 || neg <= file_size))
   {
    checkpoint_position = neg;
    hard_index = i ^ 1;
    soft_index = j;
   }
  }
 }
 
 if (hard_checkpoint_position > checkpoint_position)
  checkpoint_position = hard_checkpoint_position;
}
 
/////////////////////////////////////////////////////////////////////////////
void joedb::Readonly_Journal::pull_without_locking()
/////////////////////////////////////////////////////////////////////////////
{
 std::array<int64_t, 4> pos;
 file.full_pread((char *)&pos, sizeof(pos), 0);
 read_checkpoint(pos, -1);
}
 
/////////////////////////////////////////////////////////////////////////////
int64_t joedb::Readonly_Journal::pull()
/////////////////////////////////////////////////////////////////////////////
{
 Head_Shared_Lock lock(file);
 const int64_t old_checkpoint = checkpoint_position;
 pull_without_locking();
 return checkpoint_position - old_checkpoint;
}
 
/////////////////////////////////////////////////////////////////////////////
void joedb::Readonly_Journal::replay_log(Writable &writable)
/////////////////////////////////////////////////////////////////////////////
{
 rewind();
 play_until_checkpoint(writable);
}
 
/////////////////////////////////////////////////////////////////////////////
void joedb::Readonly_Journal::replay_with_checkpoint_comments
/////////////////////////////////////////////////////////////////////////////
(
 Writable &writable
)
{
 rewind();
 writable.start_writing(get_position());
 while(get_position() < checkpoint_position)
 {
  one_step(writable);
  writable.comment(std::to_string(get_position()));
 }
 writable.end_writing(get_position());
 file_buffer.flush();
}
 
/////////////////////////////////////////////////////////////////////////////
void joedb::Readonly_Journal::rewind()
/////////////////////////////////////////////////////////////////////////////
{
 file_buffer.set_position(Header::size);
 reset_context();
}
 
/////////////////////////////////////////////////////////////////////////////
void joedb::Readonly_Journal::raw_play_until(Writable &writable, int64_t end)
/////////////////////////////////////////////////////////////////////////////
{
 while (get_position() < end)
  one_step(writable);
}
 
/////////////////////////////////////////////////////////////////////////////
void joedb::Readonly_Journal::play_until(Writable &writable, int64_t end)
/////////////////////////////////////////////////////////////////////////////
{
 if (get_position() < end)
 {
  const int64_t writable_position = writable.get_position();
  if (get_position() < writable_position)
  {
   Dummy_Writable dummy_writable;
   raw_play_until(dummy_writable, writable_position);
  }
  writable.start_writing(get_position());
  raw_play_until(writable, end);
  writable.end_writing(get_position());
  writable.soft_checkpoint();
 }
 
 file_buffer.flush();
}
 
/////////////////////////////////////////////////////////////////////////////
void joedb::Readonly_Journal::one_step(Writable &writable)
/////////////////////////////////////////////////////////////////////////////
{
 switch(file_buffer.read<operation_t>())
 {
  case operation_t::create_table:
  {
   const std::string name = safe_read_string();
   writable.create_table(name);
  }
  break;
 
  case operation_t::drop_table:
  {
   const Table_Id table_id = file_buffer.read_strong_type<Table_Id>();
   writable.drop_table(table_id);
  }
  break;
 
  case operation_t::rename_table:
  {
   const Table_Id table_id = file_buffer.read_strong_type<Table_Id>();
   const std::string name = safe_read_string();
   writable.rename_table(table_id, name);
  }
  break;
 
  case operation_t::add_field:
  {
   const Table_Id table_id = file_buffer.read_strong_type<Table_Id>();
   const std::string name = safe_read_string();
   const Type type = read_type();
   writable.add_field(table_id, name, type);
  }
  break;
 
  case operation_t::drop_field:
  {
   const Table_Id table_id = file_buffer.read_strong_type<Table_Id>();
   const Field_Id field_id = file_buffer.read_strong_type<Field_Id>();
   writable.drop_field(table_id, field_id);
  }
  break;
 
  case operation_t::rename_field:
  {
   const Table_Id table_id = file_buffer.read_strong_type<Table_Id>();
   const Field_Id field_id = file_buffer.read_strong_type<Field_Id>();
   const std::string name = safe_read_string();
   writable.rename_field(table_id, field_id, name);
  }
  break;
 
  case operation_t::insert_into:
  {
   const Table_Id table_id = file_buffer.read_strong_type<Table_Id>();
   const Record_Id record_id = file_buffer.read_reference();
   writable.insert_into(table_id, record_id);
   table_of_last_operation = table_id;
   record_of_last_operation = record_id;
  }
  break;
 
  case operation_t::delete_from:
  {
   const Table_Id table_id = file_buffer.read_strong_type<Table_Id>();
   const Record_Id record_id = file_buffer.read_reference();
   writable.delete_from(table_id, record_id);
  }
  break;
 
  case operation_t::insert_vector:
  {
   const Table_Id table_id = file_buffer.read_strong_type<Table_Id>();
   const Record_Id record_id = file_buffer.read_reference();
   const size_t size = file_buffer.compact_read<size_t>();
   writable.insert_vector(table_id, record_id, size);
   table_of_last_operation = table_id;
   record_of_last_operation = record_id;
  }
  break;
 
  case operation_t::delete_vector:
  {
   const Table_Id table_id = file_buffer.read_strong_type<Table_Id>();
   const Record_Id record_id = file_buffer.read_reference();
   const size_t size = file_buffer.compact_read<size_t>();
   writable.delete_vector(table_id, record_id, size);
  }
  break;
 
  case operation_t::append:
   writable.insert_into(table_of_last_operation, ++record_of_last_operation);
  break;
 
  #define TYPE_MACRO(cpp_type, return_type, type_id, read_method, W)\
  case operation_t::update_##type_id:\
   table_of_last_operation = file_buffer.read_strong_type<Table_Id>();\
   record_of_last_operation = file_buffer.read_reference();\
   field_of_last_update = file_buffer.read_strong_type<Field_Id>();\
   perform_update_##type_id(writable);\
  break;\
\
  case operation_t::update_last_##type_id:\
   field_of_last_update = file_buffer.read_strong_type<Field_Id>();\
   perform_update_##type_id(writable);\
  break;\
\
  case operation_t::update_next_##type_id:\
   ++record_of_last_operation;\
   perform_update_##type_id(writable);\
  break;
  #include "joedb/TYPE_MACRO.h"
 
  #define TYPE_MACRO(cpp_type, return_type, type_id, read_method, W)\
  case operation_t::update_vector_##type_id:\
  {\
   table_of_last_operation = file_buffer.read_strong_type<Table_Id>();\
   record_of_last_operation = file_buffer.read_reference();\
   field_of_last_update = file_buffer.read_strong_type<Field_Id>();\
   const size_t size = file_buffer.compact_read<size_t>();\
   if (size == 0)\
    break;\
   if (int64_t(size) > checkpoint_position)\
    throw Exception("update_vector too big");\
   size_t capacity;\
   cpp_type *data = writable.get_own_##type_id##_storage\
   (\
    table_of_last_operation,\
    record_of_last_operation,\
    field_of_last_update,\
    capacity\
   );\
   std::vector<cpp_type> buffer;\
   if (!data)\
   {\
    buffer.resize(size);\
    data = &buffer[0];\
   }\
   else if (to_underlying(record_of_last_operation) < 0 || to_underlying(record_of_last_operation) + size > capacity)\
    throw Exception("update_vector out of range");\
   read_vector_of_##type_id(data, size);\
   writable.update_vector_##type_id\
   (\
    table_of_last_operation,\
    record_of_last_operation,\
    field_of_last_update,\
    size,\
    data\
   );\
  }\
  break;
  #include "joedb/TYPE_MACRO.h"
 
  case operation_t::custom:
  {
   const std::string name = safe_read_string();
   writable.custom(name);
  }
  break;
 
  case operation_t::comment:
  {
   const std::string comment = safe_read_string();
   writable.comment(comment);
  }
  break;
 
  case operation_t::timestamp:
  {
   const int64_t timestamp = file_buffer.read<int64_t>();
   writable.timestamp(timestamp);
  }
  break;
 
  case operation_t::valid_data:
   writable.valid_data();
  break;
 
  case operation_t::blob:
  {
   const int64_t size = file_buffer.compact_read<int64_t>();
   writable.on_blob(Blob(get_position(), size));
 
   if (writable.wants_blob_data() && size < checkpoint_position)
   {
    std::string s;
    if (size > 0)
    {
     s.resize(size);
     file_buffer.read_data(s.data(), s.size());
    }
    writable.write_blob(s);
   }
   else
    file_buffer.ignore(size);
  }
  break;
 
  default:
  {
   throw Exception("Unexpected operation: get_position() = " + std::to_string(get_position()));
  }
 }
}
 
/////////////////////////////////////////////////////////////////////////////
joedb::Type joedb::Readonly_Journal::read_type()
/////////////////////////////////////////////////////////////////////////////
{
 const Type::Type_Id type_id = Type::Type_Id(file_buffer.read<Type_Id_Storage>());
 if (type_id == Type::Type_Id::reference)
  return Type::reference(file_buffer.read_strong_type<Table_Id>());
 else
  return Type(type_id);
}
 
/////////////////////////////////////////////////////////////////////////////
std::string joedb::Readonly_Journal::safe_read_string()
/////////////////////////////////////////////////////////////////////////////
{
 return file_buffer.safe_read_string(checkpoint_position);
}
 
#define TYPE_MACRO(cpp_type, return_type, type_id, read_method, W)\
void joedb::Readonly_Journal::read_vector_of_##type_id(cpp_type *data, size_t size)\
{\
 for (size_t i = 0; i < size; i++)\
  data[i] = read_method();\
}
#define TYPE_MACRO_NO_INT
#define TYPE_MACRO_NO_FLOAT
#include "joedb/TYPE_MACRO.h"
 
#define TYPE_MACRO(cpp_type, return_type, type_id, read_method, W)\
void joedb::Readonly_Journal::read_vector_of_##type_id(cpp_type *data, size_t size)\
{\
 file_buffer.read_data((char *)data, size * sizeof(cpp_type));\
}
#define TYPE_MACRO_NO_STRING
#define TYPE_MACRO_NO_REFERENCE
#define TYPE_MACRO_NO_BLOB
#include "joedb/TYPE_MACRO.h"