diff options
Diffstat (limited to 'src/mongo/db/commands/kill_op_cmd_base.h')
-rw-r--r-- | src/mongo/db/commands/kill_op_cmd_base.h | 100 |
1 files changed, 100 insertions, 0 deletions
diff --git a/src/mongo/db/commands/kill_op_cmd_base.h b/src/mongo/db/commands/kill_op_cmd_base.h new file mode 100644 index 00000000000..ad4d2f8abfd --- /dev/null +++ b/src/mongo/db/commands/kill_op_cmd_base.h @@ -0,0 +1,100 @@ +/** + * Copyright (C) 2018 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 <http://www.gnu.org/licenses/>. + * + * 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/db/commands.h" +#include "mongo/db/operation_context.h" + +namespace mongo { + +/** + * Base class for the killOp command, which attempts to kill a given operation. Contains code + * common to mongos and mongod implementations. + */ +class KillOpCmdBase : public BasicCommand { +public: + KillOpCmdBase() : BasicCommand("killOp") {} + + virtual ~KillOpCmdBase() = default; + + bool supportsWriteConcern(const BSONObj& cmd) const override { + return false; + } + + AllowedOnSecondary secondaryAllowed(ServiceContext*) const override { + return AllowedOnSecondary::kAlways; + } + + bool adminOnly() const override { + return true; + } + + Status checkAuthForCommand(Client* client, + const std::string& dbname, + const BSONObj& cmdObj) const final; + +protected: + /** + * Given an operation ID, search for an OperationContext with that ID. Returns either + * boost::none if no operation with the given ID exists, or the OperationContext along with the + * (acquired) lock for the associated Client. + */ + static boost::optional<std::tuple<stdx::unique_lock<Client>, OperationContext*>> + findOperationContext(ServiceContext* serviceContext, unsigned int opId); + + /** + * Find the given operation, and check if we're authorized to kill it. If the operation is + * found, and we're allowed to kill it, this returns the OperationContext as well as the + * acquired lock for the associated Client. Otherwise boost::none is returned. + */ + static boost::optional<std::tuple<stdx::unique_lock<Client>, OperationContext*>> + findOpForKilling(Client* client, unsigned int opId); + + /** + * Kill an operation running on this instance of mongod or mongos. + */ + static void killLocalOperation(OperationContext* opCtx, unsigned int opToKill); + + /** + * Extract the "op" field from 'cmdObj' and convert the value to unsigned int. Since BSON only + * supports signed number types, and an opId is unsigned, the "op" field of 'cmdObj' may be + * negative, so that it can be stored in a signed type. The conversion back to unsigned is + * taken care of here. + */ + static unsigned int parseOpId(const BSONObj& cmdObj); + + /** + * Return whether the operation being killed is "local" or not. All operations on a mongod are + * local. On a mongos, killOp may may kill an operation on a shard, or an operation "local" to + * the mongos. + * + * Expects to be passed the "op" field of the command object. + */ + static bool isKillingLocalOp(const BSONElement& opElem); +}; + +} // namespace mongo |