src/ledger/bin/storage/impl/page_db_impl.h

// Copyright 2016 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef SRC_LEDGER_BIN_STORAGE_IMPL_PAGE_DB_IMPL_H_
#define SRC_LEDGER_BIN_STORAGE_IMPL_PAGE_DB_IMPL_H_

#include <memory>
#include <string>
#include <vector>

#include "src/ledger/bin/environment/environment.h"
#include "src/ledger/bin/storage/impl/object_identifier_factory_impl.h"
#include "src/ledger/bin/storage/impl/page_db.h"
#include "src/ledger/bin/storage/public/db.h"
#include "src/ledger/bin/storage/public/types.h"
#include "src/ledger/lib/coroutine/coroutine.h"
#include "src/ledger/lib/files/detached_path.h"
#include "third_party/abseil-cpp/absl/strings/string_view.h"

namespace storage {

class PageStorageImpl;

// TODO(qsr): LE-250 There must be a mechanism to clean the database from
// TRANSIENT objects.
class PageDbImpl : public PageDb {
 public:
  PageDbImpl(ledger::Environment* environment, ObjectIdentifierFactory* object_identifier_factory,
             std::unique_ptr<Db> db);
  ~PageDbImpl() override;

  // PageDb:
  Status StartBatch(coroutine::CoroutineHandler* handler,
                    std::unique_ptr<PageDb::Batch>* batch) override;
  Status GetHeads(coroutine::CoroutineHandler* handler,
                  std::vector<std::pair<zx::time_utc, CommitId>>* heads) override;
  Status GetMerges(coroutine::CoroutineHandler* handler, CommitIdView parent1_id,
                   CommitIdView parent2_id, std::vector<CommitId>* merges) override;
  Status GetCommitStorageBytes(coroutine::CoroutineHandler* handler, CommitIdView commit_id,
                               std::string* storage_bytes) override;
  Status ReadObject(coroutine::CoroutineHandler* handler, const ObjectIdentifier& object_identifier,
                    std::unique_ptr<const Piece>* piece) override;
  Status HasObject(coroutine::CoroutineHandler* handler,
                   const ObjectIdentifier& object_identifier) override;
  Status GetUnsyncedCommitIds(coroutine::CoroutineHandler* handler,
                              std::vector<CommitId>* commit_ids) override;
  Status IsCommitSynced(coroutine::CoroutineHandler* handler, const CommitId& commit_id,
                        bool* is_synced) override;
  Status GetUnsyncedPieces(coroutine::CoroutineHandler* handler,
                           std::vector<ObjectIdentifier>* object_identifiers) override;
  Status GetObjectStatus(coroutine::CoroutineHandler* handler,
                         const ObjectIdentifier& object_identifier,
                         PageDbObjectStatus* object_status) override;
  Status GetObjectStatusKeys(coroutine::CoroutineHandler* handler,
                             const ObjectDigest& object_digest,
                             std::map<std::string, PageDbObjectStatus>* keys) override;
  Status GetInboundObjectReferences(coroutine::CoroutineHandler* handler,
                                    const ObjectIdentifier& object_identifier,
                                    ObjectReferencesAndPriority* references) override;
  Status GetInboundCommitReferences(coroutine::CoroutineHandler* handler,
                                    const ObjectIdentifier& object_identifier,
                                    std::vector<CommitId>* references) override;
  Status EnsureObjectDeletable(coroutine::CoroutineHandler* handler,
                               const ObjectDigest& object_digest,
                               std::vector<std::string>* object_status_keys) override;
  Status GetSyncMetadata(coroutine::CoroutineHandler* handler, absl::string_view key,
                         std::string* value) override;
  Status IsPageOnline(coroutine::CoroutineHandler* handler, bool* page_is_online) override;

  Status AddHead(coroutine::CoroutineHandler* handler, CommitIdView head,
                 zx::time_utc timestamp) override;
  Status RemoveHead(coroutine::CoroutineHandler* handler, CommitIdView head) override;
  Status AddMerge(coroutine::CoroutineHandler* handler, CommitIdView parent1_id,
                  CommitIdView parent2_id, CommitIdView merge_commit_id) override;
  Status DeleteMerge(coroutine::CoroutineHandler* handler, CommitIdView parent1_id,
                     CommitIdView parent2_id, CommitIdView commit_id) override;
  Status AddCommitStorageBytes(coroutine::CoroutineHandler* handler, const CommitId& commit_id,
                               absl::string_view remote_commit_id,
                               const ObjectIdentifier& root_node,
                               absl::string_view storage_bytes) override;
  Status DeleteCommit(coroutine::CoroutineHandler* handler, CommitIdView commit_id,
                      absl::string_view remote_commit_id,
                      const ObjectIdentifier& root_node) override;
  Status WriteObject(coroutine::CoroutineHandler* handler, const Piece& piece,
                     PageDbObjectStatus object_status,
                     const ObjectReferencesAndPriority& references) override;
  Status DeleteObject(coroutine::CoroutineHandler* handler, const ObjectDigest& object_digest,
                      const ObjectReferencesAndPriority& references) override;
  Status MarkCommitIdSynced(coroutine::CoroutineHandler* handler,
                            const CommitId& commit_id) override;
  Status MarkCommitIdUnsynced(coroutine::CoroutineHandler* handler, const CommitId& commit_id,
                              uint64_t generation) override;
  Status SetObjectStatus(coroutine::CoroutineHandler* handler,
                         const ObjectIdentifier& object_identifier,
                         PageDbObjectStatus object_status) override;
  Status SetSyncMetadata(coroutine::CoroutineHandler* handler, absl::string_view key,
                         absl::string_view value) override;
  Status MarkPageOnline(coroutine::CoroutineHandler* handler) override;
  Status GetDeviceId(coroutine::CoroutineHandler* handler, clocks::DeviceId* device_id) override;
  Status GetClock(coroutine::CoroutineHandler* handler, Clock* clock) override;
  Status SetDeviceId(coroutine::CoroutineHandler* handler,
                     const clocks::DeviceId& device_id) override;
  Status SetClock(coroutine::CoroutineHandler* handler, const Clock& clock) override;
  Status GetCommitIdFromRemoteId(coroutine::CoroutineHandler* handler, absl::string_view remote_id,
                                 CommitId* commit_id) override;

 private:
  // DChecks that the DeviceId has not already been set. Returns |OK| on success, or |INTERRUPTED|
  // if the coroutine was interrupted.
  Status DCheckDeviceIdNotSet(coroutine::CoroutineHandler* handler);

  ledger::Environment* environment_;
  ObjectIdentifierFactory* const object_identifier_factory_;
  std::unique_ptr<Db> db_;
};

}  // namespace storage

#endif  // SRC_LEDGER_BIN_STORAGE_IMPL_PAGE_DB_IMPL_H_