YugabyteDB (2.13.0.0-b42, bfc6a6643e7399ac8a0e81d06a3ee6d6571b33ab)

// Copyright (c) YugaByte, Inc.

//

// Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except

// in compliance with the License.  You may obtain a copy of the License at

//

// http://www.apache.org/licenses/LICENSE-2.0

//

// Unless required by applicable law or agreed to in writing, software distributed under the License

// is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express

// or implied.  See the License for the specific language governing permissions and limitations

// under the License.

//

#ifndef YB_TABLET_TABLET_SNAPSHOTS_H

#define YB_TABLET_TABLET_SNAPSHOTS_H

#include "yb/common/hybrid_time.h"

#include "yb/common/snapshot.h"

#include "yb/tablet/tablet_fwd.h"

#include "yb/tablet/tablet_component.h"

#include "yb/docdb/docdb_fwd.h"

#include "yb/util/opid.h"

#include "yb/util/status_fwd.h"

namespace rocksdb {

class DB;

}

namespace yb {

class Env;

class FsManager;

class RWOperationCounter;

class rw_semaphore;

namespace tablet {

YB_DEFINE_ENUM(CreateIntentsCheckpointIn, (kSubDir)(kUseIntentsDbSuffix));

struct CreateSnapshotData {

  HybridTime snapshot_hybrid_time;

  HybridTime hybrid_time;

  OpId op_id;

  std::string snapshot_dir;

  SnapshotScheduleId schedule_id;

};

class TabletSnapshots : public TabletComponent {

 public:

  explicit TabletSnapshots(Tablet* tablet);

  // Create snapshot for this tablet.

  CHECKED_STATUS Create(SnapshotOperation* operation);

  CHECKED_STATUS Create(const CreateSnapshotData& data);

  // Restore snapshot for this tablet. In addition to backup/restore, this is used for initial

  // syscatalog RocksDB creation without the initdb overhead.

  CHECKED_STATUS Restore(SnapshotOperation* operation);

  // Delete snapshot for this tablet.

  CHECKED_STATUS Delete(const SnapshotOperation& operation);

  CHECKED_STATUS RestoreFinished(SnapshotOperation* operation);

  // Prepares the operation context for a snapshot operation.

  CHECKED_STATUS Prepare(SnapshotOperation* operation);

  Result<std::string> RestoreToTemporary(const TxnSnapshotId& snapshot_id, HybridTime restore_at);

  //------------------------------------------------------------------------------------------------

  // Create a RocksDB checkpoint in the provided directory. Only used when table_type_ ==

  // YQL_TABLE_TYPE.

  // use_subdir_for_intents specifies whether to create intents DB checkpoint inside

  // <dir>/<kIntentsSubdir> or <dir>.<kIntentsDBSuffix>

  CHECKED_STATUS CreateCheckpoint(

      const std::string& dir,

      CreateIntentsCheckpointIn create_intents_checkpoint_in =

          CreateIntentsCheckpointIn::kUseIntentsDbSuffix);

  // Returns the location of the last rocksdb checkpoint. Used for tests only.

  std::string TEST_LastRocksDBCheckpointDir() { return TEST_last_rocksdb_checkpoint_dir_; }

  CHECKED_STATUS CreateDirectories(const std::string& rocksdb_dir, FsManager* fs);

  static std::string SnapshotsDirName(const std::string& rocksdb_dir);

  static bool IsTempSnapshotDir(const std::string& dir);

 private:

  struct RestoreMetadata;

  // Restore the RocksDB checkpoint from the provided directory.

  // Only used when table_type_ == YQL_TABLE_TYPE.

  CHECKED_STATUS RestoreCheckpoint(

      const std::string& dir, HybridTime restore_at, const RestoreMetadata& metadata,

      const docdb::ConsensusFrontier& frontier);

  // Applies specified snapshot operation.

  CHECKED_STATUS Apply(SnapshotOperation* operation);

  CHECKED_STATUS CleanupSnapshotDir(const std::string& dir);

  Env& env();

  std::string TEST_last_rocksdb_checkpoint_dir_;

};

} // namespace tablet

} // namespace yb

#endif // YB_TABLET_TABLET_SNAPSHOTS_H