summaryrefslogtreecommitdiff
path: root/src/mongo/transport/service_executor_fixed.cpp
blob: ba8eca2bfaff3710f9c55d2f7c59c234b9338104 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
/**
 *    Copyright (C) 2020-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::kExecutor

#include "mongo/transport/service_executor_fixed.h"

#include "mongo/base/error_codes.h"
#include "mongo/logv2/log.h"
#include "mongo/transport/service_executor_gen.h"
#include "mongo/util/fail_point.h"

namespace mongo {

MONGO_FAIL_POINT_DEFINE(hangBeforeSchedulingServiceExecutorFixedTask);

namespace transport {
namespace {
constexpr auto kThreadsRunning = "threadsRunning"_sd;
constexpr auto kExecutorLabel = "executor"_sd;
constexpr auto kExecutorName = "fixed"_sd;
}  // namespace

ServiceExecutorFixed::ServiceExecutorFixed(ThreadPool::Options options)
    : _options(std::move(options)) {
    _options.onCreateThread =
        [this, onCreate = std::move(_options.onCreateThread)](const std::string& name) mutable {
            _executorContext = std::make_unique<ExecutorThreadContext>(this->weak_from_this());
            onCreate(name);
        };
    _threadPool = std::make_unique<ThreadPool>(_options);
}

ServiceExecutorFixed::~ServiceExecutorFixed() {
    invariant(!_canScheduleWork.load());
    if (_state == State::kNotStarted)
        return;

    // Ensures we always call "shutdown" after staring the service executor
    invariant(_state == State::kStopped);
    _threadPool->shutdown();
    _threadPool->join();
    invariant(_numRunningExecutorThreads.load() == 0);
}

Status ServiceExecutorFixed::start() {
    stdx::lock_guard<Latch> lk(_mutex);
    auto oldState = std::exchange(_state, State::kRunning);
    invariant(oldState == State::kNotStarted);
    _threadPool->startup();
    _canScheduleWork.store(true);
    LOGV2_DEBUG(
        4910501, 3, "Started fixed thread-pool service executor", "name"_attr = _options.poolName);
    return Status::OK();
}

Status ServiceExecutorFixed::shutdown(Milliseconds timeout) {
    auto waitForShutdown = [&]() mutable -> Status {
        stdx::unique_lock<Latch> lk(_mutex);
        bool success = _shutdownCondition.wait_for(lk, timeout.toSystemDuration(), [this] {
            return _numRunningExecutorThreads.load() == 0;
        });
        return success ? Status::OK()
                       : Status(ErrorCodes::ExceededTimeLimit,
                                "Failed to shutdown all executor threads within the time limit");
    };

    LOGV2_DEBUG(4910502,
                3,
                "Shutting down fixed thread-pool service executor",
                "name"_attr = _options.poolName);

    {
        stdx::lock_guard<Latch> lk(_mutex);
        _canScheduleWork.store(false);

        auto oldState = std::exchange(_state, State::kStopped);
        if (oldState != State::kStopped) {
            _threadPool->shutdown();
        }
    }

    return waitForShutdown();
}

Status ServiceExecutorFixed::schedule(Task task, ScheduleFlags flags) {
    if (!_canScheduleWork.load()) {
        return Status(ErrorCodes::ShutdownInProgress, "Executor is not running");
    }

    auto mayExecuteTaskInline = [&] {
        if (!(flags & ScheduleFlags::kMayRecurse))
            return false;
        if (!_executorContext)
            return false;
        return true;
    };


    if (mayExecuteTaskInline()) {
        invariant(_executorContext);
        if (_executorContext->getRecursionDepth() <
            fixedServiceExecutorRecursionLimit.loadRelaxed()) {
            // Recursively executing the task on the executor thread.
            _executorContext->run(std::move(task));
            return Status::OK();
        }
    }

    hangBeforeSchedulingServiceExecutorFixedTask.pauseWhileSet();

    // May throw if an attempt is made to schedule after the thread pool is shutdown.
    try {
        _threadPool->schedule([task = std::move(task)](Status status) mutable {
            internalAssert(status);
            invariant(_executorContext);
            _executorContext->run(std::move(task));
        });
    } catch (DBException& e) {
        return e.toStatus();
    }

    return Status::OK();
}

void ServiceExecutorFixed::appendStats(BSONObjBuilder* bob) const {
    *bob << kExecutorLabel << kExecutorName << kThreadsRunning
         << static_cast<int>(_numRunningExecutorThreads.load());
}

}  // namespace transport
}  // namespace mongo