YugabyteDB (2.13.0.0-b42, bfc6a6643e7399ac8a0e81d06a3ee6d6571b33ab)

// Licensed to the Apache Software Foundation (ASF) under one

// or more contributor license agreements.  See the NOTICE file

// distributed with this work for additional information

// regarding copyright ownership.  The ASF licenses this file

// to you 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.

//

// The following only applies to changes made to this file as part of YugaByte development.

//

// Portions 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_BOOTSTRAP_IF_H

#define YB_TABLET_TABLET_BOOTSTRAP_IF_H

#include <memory>

#include <shared_mutex>

#include <string>

#include <vector>

#include <boost/optional.hpp>

#include "yb/client/client_fwd.h"

#include "yb/consensus/log_fwd.h"

#include "yb/consensus/consensus_fwd.h"

#include "yb/gutil/ref_counted.h"

#include "yb/tablet/tablet_fwd.h"

#include "yb/tablet/tablet_options.h"

#include "yb/util/status_fwd.h"

#include "yb/util/opid.h"

#include "yb/util/shared_lock.h"

namespace yb {

class MetricRegistry;

class Partition;

class PartitionSchema;

class ThreadPool;

namespace consensus {

struct ConsensusBootstrapInfo;

} // namespace consensus

namespace server {

class Clock;

}

namespace tablet {

class Tablet;

class RaftGroupMetadata;

class TransactionCoordinatorContext;

class TransactionParticipantContext;

struct TabletOptions;

// A listener for logging the tablet related statuses as well as

// piping it into the web UI.

class TabletStatusListener {

 public:

  explicit TabletStatusListener(const RaftGroupMetadataPtr& meta);

  ~TabletStatusListener();

  void StatusMessage(const std::string& status);

  const std::string tablet_id() const;

  const std::string namespace_name() const;

  const std::string table_name() const;

  const std::string table_id() const;

  std::shared_ptr<Partition> partition() const;

  SchemaPtr schema() const;

  std::string last_status() const {

    SharedLock<std::shared_timed_mutex> l(lock_);

    return last_status_;

  }

 private:

  mutable std::shared_timed_mutex lock_;

  RaftGroupMetadataPtr meta_;

  std::string last_status_;

  DISALLOW_COPY_AND_ASSIGN(TabletStatusListener);

};

struct DocDbOpIds {

  OpId regular;

  OpId intents;

  std::string ToString() const;

};

// This is used for tests to interact with the tablet bootstrap procedure.

class TabletBootstrapTestHooksIf {

 public:

  virtual ~TabletBootstrapTestHooksIf() {}

  // This is called during TabletBootstrap initialization so that the test can pretend certain

  // OpIds have been flushed in to regular and intents RocksDBs.

  virtual boost::optional<DocDbOpIds> GetFlushedOpIdsOverride() const = 0;

  // TabletBootstrap calls this when an operation is replayed.

  // replay_decision is true for transaction update operations that have already been applied to the

  // regular RocksDB but not to the intents RocksDB.

  virtual void Replayed(

      OpId op_id,

      AlreadyAppliedToRegularDB already_applied_to_regular_db) = 0;

  // TabletBootstrap calls this when an operation is overwritten after a leader change.

  virtual void Overwritten(OpId op_id) = 0;

  virtual void RetryableRequest(OpId op_id) = 0;

  // Skip replaying transaction update requests, either on transaction coordinator or participant.

  // This is useful to avoid instatiating the entire transactional subsystem in a test tablet.

  virtual bool ShouldSkipTransactionUpdates() const = 0;

  // Will skip writing to the intents RocksDB if this returns true.

  virtual bool ShouldSkipWritingIntents() const = 0;

  // Tablet bootstrap will pretend that the intents RocksDB exists even if it does not if this

  // returns true.

  virtual bool HasIntentsDB() const = 0;

  // Tablet bootstrap calls this in the "bootstrap optimizer" code (--skip_wal_rewrite) every time

  // it discovers the first OpId of a log segment. OpId will be invalid if we could not read the

  // first OpId. This is called in the order from newer to older segments;

  virtual void FirstOpIdOfSegment(const std::string& path, OpId first_op_id) = 0;

};

struct BootstrapTabletData {

  TabletInitData tablet_init_data;

  TabletStatusListener* listener = nullptr;

  ThreadPool* append_pool = nullptr;

  ThreadPool* allocation_pool = nullptr;

  consensus::RetryableRequests* retryable_requests = nullptr;

  std::shared_ptr<TabletBootstrapTestHooksIf> test_hooks = nullptr;

};

// Bootstraps a tablet, initializing it with the provided metadata. If the tablet

// has blocks and log segments, this method rebuilds the soft state by replaying

// the Log.

//

// This is a synchronous method, but is typically called within a thread pool by

// TSTabletManager.

CHECKED_STATUS BootstrapTablet(

    const BootstrapTabletData& data,

    TabletPtr* rebuilt_tablet,

    log::LogPtr* rebuilt_log,

    consensus::ConsensusBootstrapInfo* consensus_info);

}  // namespace tablet

}  // namespace yb

#endif // YB_TABLET_TABLET_BOOTSTRAP_IF_H