diff --git a/src/mongo/db/SConscript b/src/mongo/db/SConscript index 897d7df862cd8..9a294ece67858 100644 --- a/src/mongo/db/SConscript +++ b/src/mongo/db/SConscript @@ -637,6 +637,7 @@ serveronlyLibdeps = [ "auth/authmongod", "catalog/collection_options", "catalog/index_key_validate", + "commands/killcursors_common", "common", "concurrency/lock_manager", "concurrency/write_conflict_exception", diff --git a/src/mongo/db/commands/SConscript b/src/mongo/db/commands/SConscript index 52fd1f95b9ec2..bf394c42cff30 100644 --- a/src/mongo/db/commands/SConscript +++ b/src/mongo/db/commands/SConscript @@ -13,6 +13,13 @@ env.Library( ] ) +env.Library( + target='killcursors_common', + source=[ + 'killcursors_common.cpp', + ] +) + env.CppUnitTest( target="index_filter_commands_test", source=[ diff --git a/src/mongo/db/commands/killcursors_cmd.cpp b/src/mongo/db/commands/killcursors_cmd.cpp index 6ba42ddbeef41..ac43fa776805c 100644 --- a/src/mongo/db/commands/killcursors_cmd.cpp +++ b/src/mongo/db/commands/killcursors_cmd.cpp @@ -1,5 +1,5 @@ /** - * Copyright (C) 2014 MongoDB Inc. + * Copyright (C) 2015 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, @@ -26,148 +26,46 @@ * it in the license file. */ -#define MONGO_LOG_DEFAULT_COMPONENT ::mongo::logger::LogComponent::kQuery - #include "mongo/platform/basic.h" -#include - #include "mongo/base/disallow_copying.h" -#include "mongo/db/audit.h" -#include "mongo/db/auth/authorization_session.h" #include "mongo/db/catalog/collection.h" #include "mongo/db/catalog/cursor_manager.h" -#include "mongo/db/client.h" -#include "mongo/db/clientcursor.h" -#include "mongo/db/commands.h" +#include "mongo/db/commands/killcursors_common.h" #include "mongo/db/db_raii.h" #include "mongo/db/query/killcursors_request.h" -#include "mongo/db/query/killcursors_response.h" -#include "mongo/stdx/memory.h" namespace mongo { -/** - * Attempt to kill a list of cursor ids. The ClientCursors will be removed from the CursorManager - * and destroyed. - */ -class KillCursorsCmd : public Command { +class KillCursorsCmd final : public KillCursorsCmdBase { MONGO_DISALLOW_COPYING(KillCursorsCmd); public: - KillCursorsCmd() : Command("killCursors") {} - - bool isWriteCommandForConfigServer() const override { - return false; - } - - bool slaveOk() const override { - return false; - } - - bool slaveOverrideOk() const override { - return true; - } - - bool maintenanceOk() const override { - return false; - } - - bool adminOnly() const override { - return false; - } - - void help(std::stringstream& help) const override { - help << "kill a list of cursor ids"; - } - - bool shouldAffectCommandCounter() const override { - return true; - } - - Status checkAuthForCommand(ClientBasic* client, - const std::string& dbname, - const BSONObj& cmdObj) override { - auto statusWithRequest = KillCursorsRequest::parseFromBSON(dbname, cmdObj); - if (!statusWithRequest.isOK()) { - return statusWithRequest.getStatus(); - } - auto killCursorsRequest = std::move(statusWithRequest.getValue()); - - AuthorizationSession* as = AuthorizationSession::get(client); - - for (CursorId id : killCursorsRequest.cursorIds) { - Status authorizationStatus = as->checkAuthForKillCursors(killCursorsRequest.nss, id); - - if (!authorizationStatus.isOK()) { - audit::logKillCursorsAuthzCheck( - client, killCursorsRequest.nss, id, ErrorCodes::Unauthorized); - return authorizationStatus; - } - } - - return Status::OK(); - } - - bool run(OperationContext* txn, - const std::string& dbname, - BSONObj& cmdObj, - int options, - std::string& errmsg, - BSONObjBuilder& result) override { - auto statusWithRequest = KillCursorsRequest::parseFromBSON(dbname, cmdObj); - if (!statusWithRequest.isOK()) { - return appendCommandStatus(result, statusWithRequest.getStatus()); - } - auto killCursorsRequest = std::move(statusWithRequest.getValue()); + KillCursorsCmd() = default; +private: + Status _killCursor(OperationContext* txn, const NamespaceString& nss, CursorId cursorId) final { std::unique_ptr ctx; CursorManager* cursorManager; - if (killCursorsRequest.nss.isListIndexesCursorNS() || - killCursorsRequest.nss.isListCollectionsCursorNS()) { + if (nss.isListIndexesCursorNS() || nss.isListCollectionsCursorNS()) { // listCollections and listIndexes are special cursor-generating commands whose cursors // are managed globally, as they operate over catalog data rather than targeting the // data within a collection. cursorManager = CursorManager::getGlobalCursorManager(); } else { - ctx = stdx::make_unique(txn, killCursorsRequest.nss); + ctx = stdx::make_unique(txn, nss); Collection* collection = ctx->getCollection(); if (!collection) { - return appendCommandStatus(result, - {ErrorCodes::InvalidNamespace, - str::stream() << "collection does not exist: " - << killCursorsRequest.nss.ns()}); + return {ErrorCodes::CursorNotFound, + str::stream() << "collection does not exist: " << nss.ns()}; } cursorManager = collection->getCursorManager(); } invariant(cursorManager); - std::vector cursorsKilled; - std::vector cursorsNotFound; - std::vector cursorsAlive; - std::vector cursorsUnknown; - - for (CursorId id : killCursorsRequest.cursorIds) { - Status status = cursorManager->eraseCursor(txn, id, true /*shouldAudit*/); - if (status.isOK()) { - cursorsKilled.push_back(id); - } else if (status.code() == ErrorCodes::CursorNotFound) { - cursorsNotFound.push_back(id); - } else { - cursorsAlive.push_back(id); - } - - audit::logKillCursorsAuthzCheck( - txn->getClient(), killCursorsRequest.nss, id, status.code()); - } - - KillCursorsResponse killCursorsResponse( - cursorsKilled, cursorsNotFound, cursorsAlive, cursorsUnknown); - killCursorsResponse.addToBSON(&result); - return true; + return cursorManager->eraseCursor(txn, cursorId, true /*shouldAudit*/); } - } killCursorsCmd; } // namespace mongo diff --git a/src/mongo/db/commands/killcursors_common.cpp b/src/mongo/db/commands/killcursors_common.cpp new file mode 100644 index 0000000000000..879867e36907e --- /dev/null +++ b/src/mongo/db/commands/killcursors_common.cpp @@ -0,0 +1,103 @@ +/** + * Copyright (C) 2015 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. + */ + +#include "mongo/platform/basic.h" + +#include "mongo/db/commands/killcursors_common.h" + +#include "mongo/db/audit.h" +#include "mongo/db/auth/authorization_session.h" +#include "mongo/db/client.h" +#include "mongo/db/operation_context.h" +#include "mongo/db/query/killcursors_request.h" +#include "mongo/db/query/killcursors_response.h" + +namespace mongo { + +Status KillCursorsCmdBase::checkAuthForCommand(ClientBasic* client, + const std::string& dbname, + const BSONObj& cmdObj) { + auto statusWithRequest = KillCursorsRequest::parseFromBSON(dbname, cmdObj); + if (!statusWithRequest.isOK()) { + return statusWithRequest.getStatus(); + } + auto killCursorsRequest = std::move(statusWithRequest.getValue()); + + AuthorizationSession* as = AuthorizationSession::get(client); + + for (CursorId id : killCursorsRequest.cursorIds) { + Status authorizationStatus = as->checkAuthForKillCursors(killCursorsRequest.nss, id); + + if (!authorizationStatus.isOK()) { + audit::logKillCursorsAuthzCheck( + client, killCursorsRequest.nss, id, ErrorCodes::Unauthorized); + return authorizationStatus; + } + } + + return Status::OK(); +} + +bool KillCursorsCmdBase::run(OperationContext* txn, + const std::string& dbname, + BSONObj& cmdObj, + int options, + std::string& errmsg, + BSONObjBuilder& result) { + auto statusWithRequest = KillCursorsRequest::parseFromBSON(dbname, cmdObj); + if (!statusWithRequest.isOK()) { + return appendCommandStatus(result, statusWithRequest.getStatus()); + } + auto killCursorsRequest = std::move(statusWithRequest.getValue()); + + std::vector cursorsKilled; + std::vector cursorsNotFound; + std::vector cursorsAlive; + std::vector cursorsUnknown; + + for (CursorId id : killCursorsRequest.cursorIds) { + Status status = _killCursor(txn, killCursorsRequest.nss, id); + if (status.isOK()) { + cursorsKilled.push_back(id); + } else if (status.code() == ErrorCodes::CursorNotFound) { + cursorsNotFound.push_back(id); + } else { + cursorsAlive.push_back(id); + } + + audit::logKillCursorsAuthzCheck( + txn->getClient(), killCursorsRequest.nss, id, status.code()); + } + + KillCursorsResponse killCursorsResponse( + cursorsKilled, cursorsNotFound, cursorsAlive, cursorsUnknown); + killCursorsResponse.addToBSON(&result); + return true; +} + +} // namespace mongo diff --git a/src/mongo/db/commands/killcursors_common.h b/src/mongo/db/commands/killcursors_common.h new file mode 100644 index 0000000000000..f8d0ed4fd445f --- /dev/null +++ b/src/mongo/db/commands/killcursors_common.h @@ -0,0 +1,95 @@ +/** + * Copyright (C) 2015 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. + */ + +#define MONGO_LOG_DEFAULT_COMPONENT ::mongo::logger::LogComponent::kQuery + +#include "mongo/db/commands.h" +#include "mongo/db/cursor_id.h" + +namespace mongo { + +/** + * Base class for the killCursors command, which attempts to kill all given cursors. Contains code + * common to mongos and mongod implementations. + */ +class KillCursorsCmdBase : public Command { +public: + KillCursorsCmdBase() : Command("killCursors") {} + + bool isWriteCommandForConfigServer() const final { + return false; + } + + bool slaveOk() const final { + return false; + } + + bool slaveOverrideOk() const final { + return true; + } + + bool maintenanceOk() const final { + return false; + } + + bool adminOnly() const final { + return false; + } + + void help(std::stringstream& help) const final { + help << "kill a list of cursor ids"; + } + + bool shouldAffectCommandCounter() const final { + return true; + } + + Status checkAuthForCommand(ClientBasic* client, + const std::string& dbname, + const BSONObj& cmdObj) final; + + bool run(OperationContext* txn, + const std::string& dbname, + BSONObj& cmdObj, + int options, + std::string& errmsg, + BSONObjBuilder& result) final; + +private: + /** + * Kill the cursor with id 'cursorId' in namespace 'nss'. Use 'txn' if necessary. + * + * Returns Status::OK() if the cursor was killed, or ErrorCodes::CursorNotFound if there is no + * such cursor, or ErrorCodes::OperationFailed if the cursor cannot be killed. + */ + virtual Status _killCursor(OperationContext* txn, + const NamespaceString& nss, + CursorId cursorId) = 0; +}; + +} // namespace mongo diff --git a/src/mongo/s/commands/SConscript b/src/mongo/s/commands/SConscript index 05d61c66cd493..a245dcfa34aff 100644 --- a/src/mongo/s/commands/SConscript +++ b/src/mongo/s/commands/SConscript @@ -36,6 +36,7 @@ env.Library( 'cluster_index_filter_cmd.cpp', 'cluster_is_db_grid_cmd.cpp', 'cluster_is_master_cmd.cpp', + 'cluster_killcursors_cmd.cpp', 'cluster_kill_op.cpp', 'cluster_list_databases_cmd.cpp', 'cluster_list_shards_cmd.cpp', @@ -62,5 +63,6 @@ env.Library( ], LIBDEPS=[ '$BUILD_DIR/mongo/db/pipeline/pipeline', + '$BUILD_DIR/mongo/db/commands/killcursors_common' ] ) diff --git a/src/mongo/s/commands/cluster_killcursors_cmd.cpp b/src/mongo/s/commands/cluster_killcursors_cmd.cpp new file mode 100644 index 0000000000000..2ee0ef61afe2e --- /dev/null +++ b/src/mongo/s/commands/cluster_killcursors_cmd.cpp @@ -0,0 +1,48 @@ +/** + * Copyright (C) 2015 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. + */ + +#include "mongo/platform/basic.h" + +#include "mongo/db/commands/killcursors_common.h" +#include "mongo/s/grid.h" + +namespace mongo { +namespace { + +class ClusterKillCursorsCmd final : public KillCursorsCmdBase { +public: + ClusterKillCursorsCmd() = default; + +private: + Status _killCursor(OperationContext* txn, const NamespaceString& nss, CursorId cursorId) final { + return grid.getCursorManager()->killCursor(nss, cursorId); + } +} clusterKillCursorsCmd; + +} // namespace +} // namespace mongo