path: root/src/mongo/db/repl/drop_pending_collection_reaper.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.
 */


#include "mongo/platform/basic.h"

#include "mongo/db/repl/drop_pending_collection_reaper.h"

#include <algorithm>
#include <utility>

#include "mongo/db/client.h"
#include "mongo/db/operation_context.h"
#include "mongo/db/repl/storage_interface.h"
#include "mongo/db/service_context.h"
#include "mongo/logv2/log.h"

#define MONGO_LOGV2_DEFAULT_COMPONENT ::mongo::logv2::LogComponent::kReplication


namespace mongo {
namespace repl {


namespace {

const auto getDropPendingCollectionReaper =
    ServiceContext::declareDecoration<std::unique_ptr<DropPendingCollectionReaper>>();

}  // namespace

DropPendingCollectionReaper* DropPendingCollectionReaper::get(ServiceContext* service) {
    return getDropPendingCollectionReaper(service).get();
}

DropPendingCollectionReaper* DropPendingCollectionReaper::get(ServiceContext& service) {
    return getDropPendingCollectionReaper(service).get();
}

DropPendingCollectionReaper* DropPendingCollectionReaper::get(OperationContext* opCtx) {
    return get(opCtx->getClient()->getServiceContext());
}


void DropPendingCollectionReaper::set(ServiceContext* service,
                                      std::unique_ptr<DropPendingCollectionReaper> newReaper) {
    auto& reaper = getDropPendingCollectionReaper(service);
    reaper = std::move(newReaper);
}

DropPendingCollectionReaper::DropPendingCollectionReaper(StorageInterface* storageInterface)
    : _storageInterface(storageInterface) {}

void DropPendingCollectionReaper::addDropPendingNamespace(
    OperationContext* opCtx,
    const OpTime& dropOpTime,
    const NamespaceString& dropPendingNamespace) {
    invariant(dropPendingNamespace.isDropPendingNamespace());
    stdx::lock_guard<Latch> lock(_mutex);
    const auto equalRange = _dropPendingNamespaces.equal_range(dropOpTime);
    const auto& lowerBound = equalRange.first;
    const auto& upperBound = equalRange.second;
    auto matcher = [&dropPendingNamespace](const auto& pair) {
        return pair.second == dropPendingNamespace;
    };

    if (std::find_if(lowerBound, upperBound, matcher) != upperBound) {
        LOGV2_FATAL_NOTRACE(
            40448,
            "Failed to add drop-pending collection {dropPendingNamespace} with drop optime "
            "{dropOpTime}: duplicate optime and namespace pair.",
            "Failed to add drop-pending collection: duplicate optime and namespace pair",
            "dropPendingNamespace"_attr = dropPendingNamespace,
            "dropOpTime"_attr = dropOpTime);
    }

    _dropPendingNamespaces.insert(std::make_pair(dropOpTime, dropPendingNamespace));
    if (opCtx->lockState()->inAWriteUnitOfWork()) {
        opCtx->recoveryUnit()->onRollback(
            [this, dropPendingNamespace, dropOpTime](OperationContext*) {
                stdx::lock_guard<Latch> lock(_mutex);

                const auto equalRange = _dropPendingNamespaces.equal_range(dropOpTime);
                const auto& lowerBound = equalRange.first;
                const auto& upperBound = equalRange.second;
                auto matcher = [&dropPendingNamespace](const auto& pair) {
                    return pair.second == dropPendingNamespace;
                };

                auto it = std::find_if(lowerBound, upperBound, matcher);
                invariant(it != upperBound);
                _dropPendingNamespaces.erase(it);
            });
    }
}

boost::optional<OpTime> DropPendingCollectionReaper::getEarliestDropOpTime() {
    stdx::lock_guard<Latch> lock(_mutex);
    auto it = _dropPendingNamespaces.cbegin();
    if (it == _dropPendingNamespaces.cend()) {
        return boost::none;
    }
    return it->first;
}

bool DropPendingCollectionReaper::rollBackDropPendingCollection(
    OperationContext* opCtx, const OpTime& opTime, const NamespaceString& collectionNamespace) {
    // renames because these are internal operations.
    UnreplicatedWritesBlock uwb(opCtx);

    const auto pendingNss = collectionNamespace.makeDropPendingNamespace(opTime);
    {
        stdx::lock_guard<Latch> lock(_mutex);
        const auto equalRange = _dropPendingNamespaces.equal_range(opTime);
        const auto& lowerBound = equalRange.first;
        const auto& upperBound = equalRange.second;
        auto matcher = [&pendingNss](const auto& pair) {
            return pair.second == pendingNss;
        };
        auto it = std::find_if(lowerBound, upperBound, matcher);
        if (it == upperBound) {
            LOGV2_WARNING(21154,
                          "Cannot find drop-pending namespace at OpTime {opTime} for collection "
                          "{namespace} to roll back.",
                          "Cannot find drop-pending namespace to roll back",
                          "opTime"_attr = opTime,
                          "namespace"_attr = collectionNamespace);
            return false;
        }

        _dropPendingNamespaces.erase(it);
    }

    LOGV2(21152,
          "Rolling back collection drop for {pendingNamespace} with drop OpTime {dropOpTime} to "
          "namespace "
          "{namespace}",
          "Rolling back collection drop",
          "pendingNamespace"_attr = pendingNss,
          "dropOpTime"_attr = opTime,
          "namespace"_attr = collectionNamespace);

    return true;
}

void DropPendingCollectionReaper::dropCollectionsOlderThan(OperationContext* opCtx,
                                                           const OpTime& opTime) {
    DropPendingNamespaces toDrop;
    {
        stdx::lock_guard<Latch> lock(_mutex);
        for (auto it = _dropPendingNamespaces.cbegin();
             it != _dropPendingNamespaces.cend() && it->first <= opTime;
             ++it) {
            toDrop.insert(*it);
        }
    }

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

    {
        // Every node cleans up its own drop-pending collections. We should never replicate these
        // drops because these are internal operations.
        UnreplicatedWritesBlock uwb(opCtx);

        for (const auto& opTimeAndNamespace : toDrop) {
            const auto& dropOpTime = opTimeAndNamespace.first;
            const auto& nss = opTimeAndNamespace.second;
            LOGV2(21153,
                  "Completing collection drop for {namespace} with drop optime {dropOpTime} "
                  "(notification optime: {notificationOpTime})",
                  "Completing collection drop",
                  "namespace"_attr = nss,
                  "dropOpTime"_attr = dropOpTime,
                  "notificationOpTime"_attr = opTime);
            Status status = Status::OK();
            try {
                // dropCollection could throw an interrupt exception, since it acquires db locks.
                status = _storageInterface->dropCollection(opCtx, nss);
            } catch (...) {
                status = exceptionToStatus();
            }
            if (!status.isOK()) {
                LOGV2_WARNING(
                    21155,
                    "Failed to remove drop-pending collection {namespace} with drop optime "
                    "{dropOpTime} (notification optime: {notificationOpTime}): {error}",
                    "Failed to remove drop-pending collection ",
                    "namespace"_attr = nss,
                    "dropOpTime"_attr = dropOpTime,
                    "notificationOpTime"_attr = opTime,
                    "error"_attr = status);
            }
        }
    }

    {
        // Entries must be removed AFTER drops are completed, so that getEarliestDropOpTime()
        // returns appropriate results.
        stdx::lock_guard<Latch> lock(_mutex);
        auto it = _dropPendingNamespaces.cbegin();
        while (it != _dropPendingNamespaces.cend() && it->first <= opTime) {
            if (toDrop.find(it->first) != toDrop.cend()) {
                it = _dropPendingNamespaces.erase(it);
            } else {
                ++it;
            }
        }
    }
}

}  // namespace repl
}  // namespace mongo