config_server_op_observer.cpp

/**
 *    Copyright (C) 2018-present MongoDB, Inc.
 *
 *    This program is free software: you can redistribute it and/or modify
 *    it under the terms of the Server Side Public License, version 1,
 *    as published by MongoDB, Inc.
 *
 *    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
 *    Server Side Public License for more details.
 *
 *    You should have received a copy of the Server Side Public License
 *    along with this program. If not, see
 *    <http://www.mongodb.com/licensing/server-side-public-license>.
 *
 *    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 Server Side 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.
 */

#define MONGO_LOGV2_DEFAULT_COMPONENT ::mongo::logv2::LogComponent::kSharding

#include "mongo/platform/basic.h"

#include "mongo/db/s/config_server_op_observer.h"

#include "mongo/db/s/config/sharding_catalog_manager.h"
#include "mongo/db/vector_clock_mutable.h"
#include "mongo/logv2/log.h"
#include "mongo/s/catalog/type_config_version.h"
#include "mongo/s/catalog/type_shard.h"
#include "mongo/s/cluster_identity_loader.h"

namespace mongo {

namespace {

// The number of pending topologyTime tick points (stored in the _topologyTimeTickPoints vector) is
// generally expected to be small (since shard topology operations should be infrequent, relative to
// any config server replication lag).  If the size of this vector exceeds this constant (when a
// tick point is added), then a warning (with id 4740600) will be logged.
constexpr size_t kPossiblyExcessiveNumTopologyTimeTickPoints = 3;

}  // namespace

ConfigServerOpObserver::ConfigServerOpObserver() = default;

ConfigServerOpObserver::~ConfigServerOpObserver() = default;

void ConfigServerOpObserver::onDelete(OperationContext* opCtx,
                                      const NamespaceString& nss,
                                      OptionalCollectionUUID uuid,
                                      StmtId stmtId,
                                      bool fromMigrate,
                                      const boost::optional<BSONObj>& deletedDoc) {
    if (nss == VersionType::ConfigNS) {
        if (!repl::ReplicationCoordinator::get(opCtx)->getMemberState().rollback()) {
            uasserted(40302, "cannot delete config.version document while in --configsvr mode");
        } else {
            // TODO (SERVER-34165): this is only used for rollback via refetch and can be removed
            // with it.
            // Throw out any cached information related to the cluster ID.
            ShardingCatalogManager::get(opCtx)->discardCachedConfigDatabaseInitializationState();
            ClusterIdentityLoader::get(opCtx)->discardCachedClusterId();
        }
    }
}

repl::OpTime ConfigServerOpObserver::onDropCollection(OperationContext* opCtx,
                                                      const NamespaceString& collectionName,
                                                      OptionalCollectionUUID uuid,
                                                      std::uint64_t numRecords,
                                                      const CollectionDropType dropType) {
    if (collectionName == VersionType::ConfigNS) {
        if (!repl::ReplicationCoordinator::get(opCtx)->getMemberState().rollback()) {
            uasserted(40303, "cannot drop config.version document while in --configsvr mode");
        } else {
            // TODO (SERVER-34165): this is only used for rollback via refetch and can be removed
            // with it.
            // Throw out any cached information related to the cluster ID.
            ShardingCatalogManager::get(opCtx)->discardCachedConfigDatabaseInitializationState();
            ClusterIdentityLoader::get(opCtx)->discardCachedClusterId();
        }
    }

    return {};
}

void ConfigServerOpObserver::onReplicationRollback(OperationContext* opCtx,
                                                   const RollbackObserverInfo& rbInfo) {
    if (rbInfo.configServerConfigVersionRolledBack) {
        // Throw out any cached information related to the cluster ID.
        ShardingCatalogManager::get(opCtx)->discardCachedConfigDatabaseInitializationState();
        ClusterIdentityLoader::get(opCtx)->discardCachedClusterId();
    }
}

void ConfigServerOpObserver::onInserts(OperationContext* opCtx,
                                       const NamespaceString& nss,
                                       OptionalCollectionUUID uuid,
                                       std::vector<InsertStatement>::const_iterator begin,
                                       std::vector<InsertStatement>::const_iterator end,
                                       bool fromMigrate) {
    if (nss != ShardType::ConfigNS) {
        return;
    }

    boost::optional<Timestamp> maxTopologyTime;
    for (auto it = begin; it != end; it++) {
        Timestamp newTopologyTime = it->doc[ShardType::topologyTime.name()].timestamp();
        if (newTopologyTime != Timestamp()) {
            if (!maxTopologyTime || newTopologyTime > *maxTopologyTime) {
                maxTopologyTime = newTopologyTime;
            }
        }
    }

    if (maxTopologyTime) {
        opCtx->recoveryUnit()->onCommit(
            [this, maxTopologyTime](boost::optional<Timestamp> unusedCommitTime) mutable {
                _registerTopologyTimeTickPoint(*maxTopologyTime);
            });
    }
}

void ConfigServerOpObserver::onApplyOps(OperationContext* opCtx,
                                        const std::string& dbName,
                                        const BSONObj& applyOpCmd) {
    if (dbName != ShardType::ConfigNS.db()) {
        return;
    }

    const auto& updatesElem = applyOpCmd["applyOps"];
    if (updatesElem.type() != Array) {
        return;
    }
    auto updates = updatesElem.Array();
    if (updates.size() != 2) {
        return;
    }

    if (updates[0].type() != Object) {
        return;
    }
    auto removeShard = updates[0].Obj();
    if (removeShard["op"].str() != "d") {
        return;
    }
    if (removeShard["ns"].str() != ShardType::ConfigNS.ns()) {
        return;
    }

    if (updates[1].type() != Object) {
        return;
    }
    auto updateShard = updates[1].Obj();
    if (updateShard["op"].str() != "u") {
        return;
    }
    if (updateShard["ns"].str() != ShardType::ConfigNS.ns()) {
        return;
    }
    auto updateElem = updateShard["o"];
    if (updateElem.type() != Object) {
        return;
    }
    auto updateObj = updateElem.Obj();
    auto setElem = updateObj["$set"];
    if (setElem.type() != Object) {
        return;
    }
    auto setObj = setElem.Obj();
    auto newTopologyTime = setObj[ShardType::topologyTime()].timestamp();
    if (newTopologyTime == Timestamp()) {
        return;
    }

    opCtx->recoveryUnit()->onCommit(
        [this, newTopologyTime](boost::optional<Timestamp> unusedCommitTime) mutable {
            _registerTopologyTimeTickPoint(newTopologyTime);
        });
}

void ConfigServerOpObserver::_registerTopologyTimeTickPoint(Timestamp newTopologyTime) {
    std::vector<Timestamp>::size_type numTickPoints = 0;
    {
        stdx::lock_guard lg(_mutex);
        _topologyTimeTickPoints.push_back(newTopologyTime);
        numTickPoints = _topologyTimeTickPoints.size();
    }
    if (numTickPoints >= kPossiblyExcessiveNumTopologyTimeTickPoints) {
        LOGV2_WARNING(4740600,
                      "possibly excessive number of topologyTime tick points",
                      "numTickPoints"_attr = numTickPoints,
                      "kPossiblyExcessiveNumTopologyTimeTickPoints"_attr =
                          kPossiblyExcessiveNumTopologyTimeTickPoints);
    }
}

void ConfigServerOpObserver::_tickTopologyTimeIfNecessary(ServiceContext* service,
                                                          Timestamp newCommitPointTime) {
    stdx::lock_guard lg(_mutex);

    if (_topologyTimeTickPoints.empty()) {
        return;
    }

    // Find and remove the topologyTime tick points that have been passed.
    boost::optional<Timestamp> maxPassedTime;
    auto it = _topologyTimeTickPoints.begin();
    while (it != _topologyTimeTickPoints.end()) {
        const auto& topologyTimeTickPoint = *it;
        if (newCommitPointTime >= topologyTimeTickPoint) {
            if (!maxPassedTime || topologyTimeTickPoint > *maxPassedTime) {
                maxPassedTime = topologyTimeTickPoint;
            }
            it = _topologyTimeTickPoints.erase(it);
        } else {
            it++;
        }
    }

    // If any tick points were passed, tick TopologyTime to the largest one.
    if (maxPassedTime) {
        VectorClockMutable::get(service)->tickTo(VectorClock::Component::TopologyTime,
                                                 LogicalTime(*maxPassedTime));
    }
}

void ConfigServerOpObserver::onMajorityCommitPointUpdate(ServiceContext* service,
                                                         const repl::OpTime& newCommitPoint) {
    Timestamp newCommitPointTime = newCommitPoint.getTimestamp();

    // TopologyTime must always be <= ConfigTime, so ticking them separately is fine as long as
    // ConfigTime is done first.
    VectorClockMutable::get(service)->tickTo(VectorClock::Component::ConfigTime,
                                             LogicalTime(newCommitPointTime));

    _tickTopologyTimeIfNecessary(service, newCommitPointTime);
}

}  // namespace mongo