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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
|
/**
* Copyright (C) 2022-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 <boost/filesystem/path.hpp>
#include "mongo/bson/bsonobj.h"
#include "mongo/db/service_context.h"
#include "mongo/platform/process_id.h"
#include "mongo/stdx/thread.h"
namespace mongo::shell_utils {
class ProgramRunner;
/** Reads log lines from programs and optionally log them. All public members are thread safe, so
* a single instance can be used to record logs of many concurrently-running programs.
*/
class ProgramOutputMultiplexer {
public:
void appendLine(
int port, ProcessId pid, const std::string& name, const std::string& line, bool shouldLog);
std::string str() const;
void clear();
private:
std::stringstream _buffer;
mutable Mutex _mongoProgramOutputMutex =
MONGO_MAKE_LATCH("ProgramOutputMultiplexer::_mongoProgramOutputMutex");
};
/**
* A registry of spawned programs that are identified by a bound port or else a system pid.
* All public member functions are thread safe. It also owns the global ProgramOutputMultiplexer.
*/
class ProgramRegistry {
public:
static void create(ServiceContext* serviceContext);
static ProgramRegistry* get(ServiceContext* serviceContext);
ProgramOutputMultiplexer* getProgramOutputMultiplexer();
/** Create a ProgramRunner instance and return a handle to it. */
ProgramRunner createProgramRunner(BSONObj args, BSONObj env, bool isMongo);
bool isPortRegistered(int port) const;
/** @return pid for a registered port. */
ProcessId pidForPort(int port) const;
/** @return port (-1 if doesn't exist) for a registered pid. */
int portForPid(ProcessId pid) const;
/** Register an unregistered program. */
void registerProgram(ProcessId pid, int port = -1);
/** Registers the reader thread for the PID. Must be called before `joinReaderThread`. */
void registerReaderThread(ProcessId pid, stdx::thread reader);
/** Closes the registered program's write pipe and waits for all of the written output to be
* consumed by the reader thread, then removes the program from the registry */
void unregisterProgram(ProcessId pid);
bool isPidRegistered(ProcessId pid) const;
/** platform-agnostic wrapper around waitpid that automatically cleans up
* the program registry
* @param pid the processid
* @param block if true, block the thread until the child has exited
* @param exit_code[out] if set, and an exit code is available, the code will be stored here
* @return true if the process has exited, false otherwise */
bool waitForPid(ProcessId pid, bool block, int* exit_code = nullptr);
/** check if a child process is alive. Never blocks
* @param pid the processid
* @param exit_code[out] if set, and an exit code is available, the code will be stored here
* @return true if the process has exited, false otherwise */
bool isPidDead(ProcessId pids, int* exit_code = nullptr);
void getRegisteredPorts(std::vector<int>& ports);
void getRegisteredPids(std::vector<ProcessId>& pids);
private:
void updatePidExitCode(ProcessId pid, int exitCode);
private:
friend class ProgramRunner;
stdx::unordered_set<ProcessId> _registeredPids;
stdx::unordered_map<int, ProcessId> _portToPidMap;
stdx::unordered_map<ProcessId, int> _pidToExitCode;
stdx::unordered_map<ProcessId, stdx::thread> _outputReaderThreads;
ProgramOutputMultiplexer _programOutputMultiplexer;
mutable stdx::recursive_mutex _mutex;
mutable Mutex _createProcessMtx;
#ifdef _WIN32
private:
std::map<ProcessId, HANDLE> _handles;
public:
/** Will uassert with ErrorCodes::BadValue if the pid is unregistered. */
HANDLE getHandleForPid(ProcessId pid) const;
void eraseHandleForPid(ProcessId pid);
void insertHandleForPid(ProcessId pid, HANDLE handle);
#endif
};
/** Helper class for launching a program and logging its output. */
class ProgramRunner {
public:
/** Launch the program. */
void start();
/** Reads the program's output into the provided instance of ProgramOutputMultiplexer.
* Note that the passed-in multiplexer will typically be the global programOutputLogger so that
* all programs' outputs can be logged concurrently. If the multiplexer should not
* log this program's output to standard output, then set shouldLogOutput to false.
*/
void operator()(ProgramOutputMultiplexer* multiplexer, bool shouldLogOutput);
ProcessId pid() const {
return _pid;
}
int port() const {
return _port;
}
private:
friend class ProgramRegistry;
/** @param args The program's arguments, including the program name.
* @param env Environment to run the program with, which will override any set by the local
* environment
* @param isMongo Indicator variable, true if runs as a mongo process.
*/
ProgramRunner(BSONObj args, BSONObj env, bool isMongo, ProgramRegistry* registry);
boost::filesystem::path findProgram(const std::string& prog);
void launchProcess(int child_stdout);
void loadEnvironmentVariables(BSONObj env);
void parseName(bool isMongo,
bool isMongodProgram,
bool isMongosProgram,
bool isMongoqProgram,
bool isMongotMockProgram,
const boost::filesystem::path& programName);
void parseArgs(BSONObj args, bool isMongo, bool isMongodProgram);
std::vector<std::string> _argv;
std::map<std::string, std::string> _envp;
int _port;
int _pipe;
ProcessId _pid;
std::string _name;
ProgramRegistry* _parentRegistry;
};
} // namespace mongo::shell_utils
|
