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 ENT_SRC_YB_MASTER_CATALOG_ENTITY_INFO_H

#define ENT_SRC_YB_MASTER_CATALOG_ENTITY_INFO_H

#include "../../../../src/yb/master/catalog_entity_info.h"

#include "yb/common/snapshot.h"

namespace yb {

namespace master {

struct TableDescription {

  scoped_refptr<NamespaceInfo> namespace_info;

  scoped_refptr<TableInfo> table_info;

  TabletInfos tablet_infos;

};

// This wraps around the proto containing CDC stream information. It will be used for

// CowObject managed access.

struct PersistentCDCStreamInfo : public Persistent<

    SysCDCStreamEntryPB, SysRowEntryType::CDC_STREAM> {

  const google::protobuf::RepeatedPtrField<std::string>& table_id() const {

    return pb.table_id();

  }

  const NamespaceId& namespace_id() const {

    return pb.namespace_id();

  }

  bool started_deleting() const {

    return pb.state() == SysCDCStreamEntryPB::DELETING ||

        pb.state() == SysCDCStreamEntryPB::DELETED;

  }

  bool is_deleting() const {

    return pb.state() == SysCDCStreamEntryPB::DELETING;

  }

  bool is_deleted() const {

    return pb.state() == SysCDCStreamEntryPB::DELETED;

  }

  const google::protobuf::RepeatedPtrField<CDCStreamOptionsPB> options() const {

    return pb.options();

  }

};

class CDCStreamInfo : public RefCountedThreadSafe<CDCStreamInfo>,

                      public MetadataCowWrapper<PersistentCDCStreamInfo> {

 public:

  explicit CDCStreamInfo(CDCStreamId stream_id) : stream_id_(std::move(stream_id)) {}

  const CDCStreamId& id() const override { return stream_id_; }

  const google::protobuf::RepeatedPtrField<std::string>& table_id() const;

  const NamespaceId& namespace_id() const;

  std::string ToString() const override;

 private:

  friend class RefCountedThreadSafe<CDCStreamInfo>;

  ~CDCStreamInfo() = default;

  const CDCStreamId stream_id_;

  DISALLOW_COPY_AND_ASSIGN(CDCStreamInfo);

};

// This wraps around the proto containing universe replication information. It will be used for

// CowObject managed access.

struct PersistentUniverseReplicationInfo :

    public Persistent<SysUniverseReplicationEntryPB, SysRowEntryType::UNIVERSE_REPLICATION> {

  bool is_deleted_or_failed() const {

    return pb.state() == SysUniverseReplicationEntryPB::DELETED

      || pb.state() == SysUniverseReplicationEntryPB::DELETED_ERROR

      || pb.state() == SysUniverseReplicationEntryPB::FAILED;

  }

  bool is_active() const {

    return pb.state() == SysUniverseReplicationEntryPB::ACTIVE;

  }

};

class UniverseReplicationInfo : public RefCountedThreadSafe<UniverseReplicationInfo>,

                                public MetadataCowWrapper<PersistentUniverseReplicationInfo> {

 public:

  explicit UniverseReplicationInfo(std::string producer_id)

      : producer_id_(std::move(producer_id)) {}

  const std::string& id() const override { return producer_id_; }

  std::string ToString() const override;

  Result<std::shared_ptr<CDCRpcTasks>> GetOrCreateCDCRpcTasks(

      google::protobuf::RepeatedPtrField<HostPortPB> producer_masters);

  // Set the Status related to errors on SetupUniverseReplication.

  void SetSetupUniverseReplicationErrorStatus(const Status& status);

  // Get the Status of the last error from the current SetupUniverseReplication.

  CHECKED_STATUS GetSetupUniverseReplicationErrorStatus() const;

 private:

  friend class RefCountedThreadSafe<UniverseReplicationInfo>;

  ~UniverseReplicationInfo() = default;

  const std::string producer_id_;

  std::shared_ptr<CDCRpcTasks> cdc_rpc_tasks_;

  std::string master_addrs_;

  // The last error Status of the currently running SetupUniverseReplication. Will be OK, if freshly

  // constructed object, or if the SetupUniverseReplication was successful.

  Status setup_universe_replication_error_ = Status::OK();

  // Protects cdc_rpc_tasks_.

  mutable rw_spinlock lock_;

  DISALLOW_COPY_AND_ASSIGN(UniverseReplicationInfo);

};

// The data related to a snapshot which is persisted on disk.

// This portion of SnapshotInfo is managed via CowObject.

// It wraps the underlying protobuf to add useful accessors.

struct PersistentSnapshotInfo : public Persistent<SysSnapshotEntryPB, SysRowEntryType::SNAPSHOT> {

  SysSnapshotEntryPB::State state() const {

    return pb.state();

  }

  const std::string& state_name() const {

    return SysSnapshotEntryPB::State_Name(state());

  }

  bool is_creating() const {

    return state() == SysSnapshotEntryPB::CREATING;

  }

  bool started_deleting() const {

    return state() == SysSnapshotEntryPB::DELETING ||

           state() == SysSnapshotEntryPB::DELETED;

  }

  bool is_failed() const {

    return state() == SysSnapshotEntryPB::FAILED;

  }

  bool is_cancelled() const {

    return state() == SysSnapshotEntryPB::CANCELLED;

  }

  bool is_complete() const {

    return state() == SysSnapshotEntryPB::COMPLETE;

  }

  bool is_restoring() const {

    return state() == SysSnapshotEntryPB::RESTORING;

  }

  bool is_deleting() const {

    return state() == SysSnapshotEntryPB::DELETING;

  }

};

// The information about a snapshot.

//

// This object uses copy-on-write techniques similarly to TabletInfo.

// Please see the TabletInfo class doc above for more information.

class SnapshotInfo : public RefCountedThreadSafe<SnapshotInfo>,

                     public MetadataCowWrapper<PersistentSnapshotInfo> {

 public:

  explicit SnapshotInfo(SnapshotId id);

  virtual const std::string& id() const override { return snapshot_id_; };

  SysSnapshotEntryPB::State state() const;

  const std::string& state_name() const;

  std::string ToString() const override;

  // Returns true if the snapshot creation is in-progress.

  bool IsCreateInProgress() const;

  // Returns true if the snapshot restoring is in-progress.

  bool IsRestoreInProgress() const;

  // Returns true if the snapshot deleting is in-progress.

  bool IsDeleteInProgress() const;

  void AddEntries(

      const TableDescription& table_description, std::unordered_set<NamespaceId>* added_namespaces);

  static void AddEntries(

      const TableDescription& table_description,

      google::protobuf::RepeatedPtrField<SysRowEntry>* out,

      google::protobuf::RepeatedPtrField<SysSnapshotEntryPB::TabletSnapshotPB>* tablet_infos,

      std::unordered_set<NamespaceId>* added_namespaces);

 private:

  friend class RefCountedThreadSafe<SnapshotInfo>;

  ~SnapshotInfo() = default;

  // The ID field is used in the sys_catalog table.

  const SnapshotId snapshot_id_;

  DISALLOW_COPY_AND_ASSIGN(SnapshotInfo);

};

} // namespace master

} // namespace yb

#endif // ENT_SRC_YB_MASTER_CATALOG_ENTITY_INFO_H