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
|
/**
* 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.
*/
#pragma once
#include <cstdint>
#include <vector>
#include "mongo/platform/random.h"
#include "mongo/stdx/functional.h"
#include "mongo/stdx/mutex.h"
#include "mongo/stdx/thread.h"
#include "mongo/util/concurrency/thread_pool_interface.h"
namespace mongo {
namespace executor {
class NetworkInterfaceMock;
/**
* Implementation of a thread pool that is tightly integrated with NetworkInterfaceMock to allow for
* deterministic unit testing of ThreadPoolTaskExecutor. This pool has a single thread, which only
* executes jobs when the NetworkInterfaceMock allows it to (i.e., not when the NetworkInterfaceMock
* is in the "enterNetwork" mode.
*/
class ThreadPoolMock final : public ThreadPoolInterface {
public:
/**
* Structure used to configure an instance of ThreadPoolMock.
*/
struct Options {
// This function is run before the worker thread begins consuming tasks.
using OnCreateThreadFn = stdx::function<void()>;
OnCreateThreadFn onCreateThread = []() {};
};
/**
* Create an instance that interlocks with "net". "prngSeed" seeds the pseudorandom number
* generator that is used to determine which schedulable task runs next.
*/
ThreadPoolMock(NetworkInterfaceMock* net, int32_t prngSeed, Options options);
~ThreadPoolMock();
void startup() override;
void shutdown() override;
void join() override;
void schedule(Task task) override;
private:
void _consumeOneTask(stdx::unique_lock<stdx::mutex>& lk);
void _shutdown(stdx::unique_lock<stdx::mutex>& lk);
void _join(stdx::unique_lock<stdx::mutex>& lk);
// These are the options with which the pool was configured at construction time.
const Options _options;
stdx::mutex _mutex;
stdx::thread _worker;
std::vector<Task> _tasks;
PseudoRandom _prng;
NetworkInterfaceMock* const _net;
bool _started = false;
bool _inShutdown = false;
bool _joining = false;
};
} // namespace executor
} // namespace mongo
|