ledger_enclave.h

Go to the documentation of this file.

// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the Apache 2.0 License.
#pragma once
 
#include "consensus/ledger_enclave_types.h"
#include "ds/ccf_assert.h"
#include "ds/serialized.h"
#include "kv/kv_types.h"
#include "kv/serialised_entry_format.h"
 
namespace consensus
{
  class LedgerEnclave
  {
  public:
    static constexpr size_t FRAME_SIZE = sizeof(uint32_t);
 
    static std::vector<uint8_t> get_entry(const uint8_t*& data, size_t& size)
    {
      auto header =
        serialized::peek<ccf::kv::SerialisedEntryHeader>(data, size);
      size_t entry_size = ccf::kv::serialised_entry_header_size + header.size;
      std::vector<uint8_t> entry(data, data + entry_size);
      serialized::skip(data, size, entry_size);
      return entry;
    }
 
  private:
    ringbuffer::WriterPtr to_host;
 
  public:
    LedgerEnclave(ringbuffer::AbstractWriterFactory& writer_factory_) :
      to_host(writer_factory_.create_writer_to_outside())
    {}
 
    void put_entry(
      const std::vector<uint8_t>& entry,
      bool globally_committable,
      ccf::kv::Term term,
      ccf::kv::Version index)
    {
      put_entry(entry.data(), entry.size(), globally_committable, term, index);
    }
 
    void put_entry(
      const uint8_t* data,
      size_t size,
      bool globally_committable,
      ccf::kv::Term term,
      ccf::kv::Version index)
    {
      serializer::ByteRange byte_range = {data, size};
      RINGBUFFER_WRITE_MESSAGE(
        ::consensus::ledger_append, to_host, globally_committable, byte_range);
    }
 
    static void skip_entry(const uint8_t*& data, size_t& size)
    {
      auto header =
        serialized::read<ccf::kv::SerialisedEntryHeader>(data, size);
      serialized::skip(data, size, header.size);
    }
 
    void truncate(Index idx)
    {
      RINGBUFFER_WRITE_MESSAGE(
        ::consensus::ledger_truncate, to_host, idx, false /* no recovery */);
    }
 
    void commit(Index idx)
    {
      RINGBUFFER_WRITE_MESSAGE(::consensus::ledger_commit, to_host, idx);
    }
 
    void init(Index idx = 0, Index recovery_start_idx = 0)
    {
      RINGBUFFER_WRITE_MESSAGE(
        ::consensus::ledger_init, to_host, idx, recovery_start_idx);
    }
  };
}