summaryrefslogtreecommitdiff
path: root/src/mongo/transport/service_executor_fixed.h
blob: ae82a530d02f782abe7ff300dbbb3093c83f3914 (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
/**
 *    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.
 */

#pragma once

#include <memory>

#include "mongo/base/status.h"
#include "mongo/db/service_context.h"
#include "mongo/platform/atomic_word.h"
#include "mongo/platform/mutex.h"
#include "mongo/stdx/condition_variable.h"
#include "mongo/stdx/thread.h"
#include "mongo/transport/service_executor.h"
#include "mongo/util/concurrency/thread_pool.h"
#include "mongo/util/hierarchical_acquisition.h"

namespace mongo {
namespace transport {

/**
 * A service executor that uses a fixed (configurable) number of threads to execute tasks.
 * This executor always yields before executing scheduled tasks, and never yields before scheduling
 * new tasks (i.e., `ScheduleFlags::kMayYieldBeforeSchedule` is a no-op for this executor).
 */
class ServiceExecutorFixed : public ServiceExecutor,
                             public std::enable_shared_from_this<ServiceExecutorFixed> {
public:
    explicit ServiceExecutorFixed(ThreadPool::Options options);
    virtual ~ServiceExecutorFixed();

    static ServiceExecutorFixed* get(ServiceContext* ctx);

    Status start() override;
    Status shutdown(Milliseconds timeout) override;
    Status schedule(Task task, ScheduleFlags flags) override;

    Mode transportMode() const override {
        return Mode::kSynchronous;
    }

    void appendStats(BSONObjBuilder* bob) const override;

private:
    // Maintains the execution state (e.g., recursion depth) for executor threads
    class ExecutorThreadContext {
    public:
        ExecutorThreadContext(std::weak_ptr<ServiceExecutorFixed> serviceExecutor)
            : _executor(std::move(serviceExecutor)) {
            _adjustRunningExecutorThreads(1);
        }

        ExecutorThreadContext(ExecutorThreadContext&&) = delete;
        ExecutorThreadContext(const ExecutorThreadContext&) = delete;

        ~ExecutorThreadContext() {
            _adjustRunningExecutorThreads(-1);
        }

        void run(ServiceExecutor::Task task) {
            // Yield here to improve concurrency, especially when there are more executor threads
            // than CPU cores.
            stdx::this_thread::yield();
            _recursionDepth++;
            task();
            _recursionDepth--;
        }

        int getRecursionDepth() const {
            return _recursionDepth;
        }

    private:
        void _adjustRunningExecutorThreads(int adjustment) {
            if (auto executor = _executor.lock()) {
                executor->_numRunningExecutorThreads.fetchAndAdd(adjustment);
            }
        }

        int _recursionDepth = 0;
        std::weak_ptr<ServiceExecutorFixed> _executor;
    };

private:
    AtomicWord<size_t> _numRunningExecutorThreads{0};
    AtomicWord<bool> _canScheduleWork{false};

    mutable Mutex _mutex =
        MONGO_MAKE_LATCH(HierarchicalAcquisitionLevel(0), "ServiceExecutorFixed::_mutex");
    stdx::condition_variable _shutdownCondition;

    /**
     * State transition diagram: kNotStarted ---> kRunning ---> kStopped
     * The service executor cannot be in "kRunning" when its destructor is invoked.
     */
    enum State { kNotStarted, kRunning, kStopped } _state = kNotStarted;

    ThreadPool::Options _options;
    std::unique_ptr<ThreadPool> _threadPool;

    static inline thread_local std::unique_ptr<ExecutorThreadContext> _executorContext;
};

}  // namespace transport
}  // namespace mongo