/**
* Copyright (C) 2016 MongoDB Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see .
*
* As a special exception, the copyright holders give permission to link the
* code of portions of this program with the OpenSSL library under certain
* conditions as described in each individual source file and distribute
* linked combinations including the program with the OpenSSL library. You
* must comply with the GNU Affero General Public License in all respects for
* all of the code used other than as permitted herein. If you modify file(s)
* with this exception, you may extend this exception to your version of the
* file(s), but you are not obligated to do so. If you do not wish to do so,
* delete this exception statement from your version. If you delete this
* exception statement from all source files in the program, then also delete
* it in the license file.
*/
#pragma once
#include "mongo/base/disallow_copying.h"
#include "mongo/base/status_with.h"
#include "mongo/db/repl/multiapplier.h"
#include "mongo/db/repl/oplog_buffer.h"
#include "mongo/db/repl/optime.h"
#include "mongo/db/repl/optime_with.h"
#include "mongo/db/repl/repl_set_config.h"
#include "mongo/rpc/metadata/oplog_query_metadata.h"
#include "mongo/rpc/metadata/repl_set_metadata.h"
#include "mongo/util/concurrency/thread_pool.h"
#include "mongo/util/net/hostandport.h"
#include "mongo/util/time_support.h"
namespace mongo {
namespace executor {
class TaskExecutor;
} // namespace executor
namespace repl {
class InitialSyncer;
/**
* Holds current term and last committed optime necessary to populate find/getMore command requests.
*/
using OpTimeWithTerm = OpTimeWith;
/**
* This class represents the interface the InitialSyncer uses to interact with the
* rest of the system. All functionality of the InitialSyncer that would introduce
* dependencies on large sections of the server code and thus break the unit testability of
* InitialSyncer should be moved here.
*/
class DataReplicatorExternalState {
MONGO_DISALLOW_COPYING(DataReplicatorExternalState);
public:
DataReplicatorExternalState() = default;
virtual ~DataReplicatorExternalState() = default;
/**
* Returns task executor for scheduling tasks to be run asynchronously.
*/
virtual executor::TaskExecutor* getTaskExecutor() const = 0;
/**
* Returns shared db worker thread pool for collection cloning.
*/
virtual ThreadPool* getDbWorkThreadPool() const = 0;
/**
* Returns the current term and last committed optime.
* Returns (OpTime::kUninitializedTerm, OpTime()) if not available.
*/
virtual OpTimeWithTerm getCurrentTermAndLastCommittedOpTime() = 0;
/**
* Forwards the parsed metadata in the query results to the replication system.
*
* TODO (SERVER-27668): Make OplogQueryMetadata non-optional in mongodb 3.8.
*/
virtual void processMetadata(const rpc::ReplSetMetadata& replMetadata,
boost::optional oqMetadata) = 0;
/**
* Evaluates quality of sync source. Accepts the current sync source; the last optime on this
* sync source (from metadata); and whether this sync source has a sync source (also from
* metadata).
*
* TODO (SERVER-27668): Make OplogQueryMetadata non-optional in mongodb 3.8.
*/
virtual bool shouldStopFetching(const HostAndPort& source,
const rpc::ReplSetMetadata& replMetadata,
boost::optional oqMetadata) = 0;
/**
* This function creates an oplog buffer of the type specified at server startup.
*/
virtual std::unique_ptr makeInitialSyncOplogBuffer(
OperationContext* opCtx) const = 0;
/**
* Creates an oplog buffer suitable for steady state replication.
*/
virtual std::unique_ptr makeSteadyStateOplogBuffer(
OperationContext* opCtx) const = 0;
/**
* Returns the current replica set config if there is one, or an error why there isn't.
*/
virtual StatusWith getCurrentConfig() const = 0;
private:
/**
* Applies the operations described in the oplog entries contained in "ops" using the
* "applyOperation" function.
*
* Used exclusively by the InitialSyncer to construct a MultiApplier.
*/
virtual StatusWith _multiApply(OperationContext* opCtx,
MultiApplier::Operations ops,
MultiApplier::ApplyOperationFn applyOperation) = 0;
/**
* Used by _multiApply() to write operations to database during initial sync. `fetchCount` is a
* pointer to a counter that is incremented every time we fetch a missing document.
* `workerMultikeyPathInfo` is a pointer to a list of objects tracking which indexes to set as
* multikey at the end of the batch. It should never be null.
*
* Used exclusively by the InitialSyncer to construct a MultiApplier.
*/
virtual Status _multiInitialSyncApply(MultiApplier::OperationPtrs* ops,
const HostAndPort& source,
AtomicUInt32* fetchCount,
WorkerMultikeyPathInfo* workerMultikeyPathInfo) = 0;
// Provides InitialSyncer with access to _multiApply, _multiSyncApply and
// _multiInitialSyncApply.
friend class InitialSyncer;
};
} // namespace repl
} // namespace mongo