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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
|
/**
* 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.
*/
#ifdef _WIN32
#include "named_pipe.h"
#include <fmt/format.h>
#include <string>
#include <system_error>
#include "mongo/db/storage/io_error_message.h"
#include "mongo/logv2/log.h"
#include "mongo/stdx/thread.h"
#include "mongo/util/errno_util.h"
namespace mongo {
using namespace fmt::literals;
#define MONGO_LOGV2_DEFAULT_COMPONENT ::mongo::logv2::LogComponent::kTest
// On Windows, 'externalPipeDir' parameter is not supported and so the first argument is ignored and
// instead, 'kDefultPipePath' is used.
NamedPipeOutput::NamedPipeOutput(const std::string&, const std::string& pipeRelativePath)
: _pipeAbsolutePath(kDefaultPipePath.toString() + pipeRelativePath),
_pipe(CreateNamedPipeA(_pipeAbsolutePath.c_str(),
PIPE_ACCESS_OUTBOUND,
(PIPE_TYPE_BYTE | PIPE_WAIT),
1, // nMaxInstances
0, // nOutBufferSize
0, // nInBufferSize
0, // nDefaultTimeOut
nullptr)), // lpSecurityAttributes
_isOpen(false) {
uassert(7005006,
"Failed to create a named pipe, error: {}"_format(
getErrorMessage("CreateNamedPipe", _pipeAbsolutePath)),
_pipe != INVALID_HANDLE_VALUE);
}
NamedPipeOutput::~NamedPipeOutput() {
close();
}
void NamedPipeOutput::open() {
if (_isOpen) {
return;
}
bool succeeded = ConnectNamedPipe(_pipe, nullptr);
if (!succeeded) {
// ERROR_PIPE_CONNECTED means that the client has arrived faster and the connection has been
// established. It does not count as an error.
if (auto ec = lastSystemError().value(); ec != ERROR_PIPE_CONNECTED) {
LOGV2_ERROR(7005007,
"Failed to connect a named pipe",
"error"_attr = getErrorMessage("ConnectNamedPipe", _pipeAbsolutePath));
return;
}
}
_isOpen = true;
}
int NamedPipeOutput::write(const char* data, int size) {
uassert(7005012, "Output must have been opened before writing", _isOpen);
DWORD nWritten = 0;
// Write the reply to the pipe.
bool succeeded = WriteFile(_pipe, // handle to pipe
data, // buffer to write from
size, // number of bytes to write
&nWritten, // number of bytes written
nullptr); // not overlapped I/O
if (!succeeded || size != nWritten) {
uasserted(7239301,
"Failed to write to a named pipe, error: {}"_format(
getErrorMessage("write", _pipeAbsolutePath)));
return -1;
}
return static_cast<int>(nWritten);
}
void NamedPipeOutput::close() {
if (_isOpen) {
// Flush the pipe to allow the client to read the pipe's contents
// before disconnecting. Then disconnect the pipe, and close the
// handle to this pipe instance.
FlushFileBuffers(_pipe);
DisconnectNamedPipe(_pipe);
CloseHandle(_pipe);
_isOpen = false;
}
}
#undef MONGO_LOGV2_DEFAULT_COMPONENT
#define MONGO_LOGV2_DEFAULT_COMPONENT ::mongo::logv2::LogComponent::kStorage
NamedPipeInput::NamedPipeInput(const std::string& pipeRelativePath)
: _pipeAbsolutePath(kDefaultPipePath + pipeRelativePath),
_pipe(INVALID_HANDLE_VALUE),
_isOpen(false),
_isGood(false),
_isEof(false) {
uassert(7001101,
"Pipe path must not include '..' but {} does"_format(_pipeAbsolutePath),
_pipeAbsolutePath.find("..") == std::string::npos);
}
NamedPipeInput::~NamedPipeInput() {
close();
}
void NamedPipeInput::doOpen() {
// Retry the open every {1, 2, 4, 8, 16} ms for 1,000 reps each (allowing up to 31 seconds of
// retry) in case the pipe writer has not finished creating the pipe yet.
int retries = 0;
int sleepMs = 1;
do {
_pipe = CreateFileA(
_pipeAbsolutePath.c_str(), GENERIC_READ, 0, nullptr, OPEN_EXISTING, 0, nullptr);
if (_pipe == INVALID_HANDLE_VALUE) {
stdx::this_thread::sleep_for(stdx::chrono::milliseconds(sleepMs));
++retries;
if (retries % 1000 == 0) {
sleepMs *= 2;
}
}
} while (_pipe == INVALID_HANDLE_VALUE && retries <= 5000);
if (retries > 1000) {
LOGV2_WARNING(7184901,
"NamedPipeInput::doOpen() waited for pipe longer than 1 sec",
"_pipeAbsolutePath"_attr = _pipeAbsolutePath);
}
if (_pipe != INVALID_HANDLE_VALUE) {
_isOpen = true;
_isGood = true;
}
}
int NamedPipeInput::doRead(char* data, int size) {
DWORD nRead = 0;
auto res = ReadFile(_pipe, data, size, &nRead, nullptr);
if (!res) {
_isGood = false;
// The pipe writer has already gone and we treat this as EOF and any data that has been read
// must be returned as is.
if (auto ec = lastSystemError().value(); ec == ERROR_PIPE_NOT_CONNECTED) {
_isEof = true;
}
} else if (nRead == 0) {
_isGood = false;
_isEof = true;
}
return static_cast<int>(nRead);
}
void NamedPipeInput::doClose() {
CloseHandle(_pipe);
_isOpen = false;
_isGood = false;
_isEof = false;
}
bool NamedPipeInput::isOpen() const {
return _isOpen;
}
bool NamedPipeInput::isGood() const {
return _isGood;
}
bool NamedPipeInput::isFailed() const {
return !_isGood;
}
bool NamedPipeInput::isEof() const {
return _isEof;
}
} // namespace mongo
#endif
|
