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
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
|
#include "inspector_io.h"
#include "inspector_socket_server.h"
#include "inspector/main_thread_interface.h"
#include "inspector/node_string.h"
#include "base_object-inl.h"
#include "env-inl.h"
#include "debug_utils.h"
#include "node.h"
#include "node_crypto.h"
#include "node_internals.h"
#include "node_mutex.h"
#include "v8-inspector.h"
#include "util.h"
#include "zlib.h"
#include <deque>
#include <cstring>
#include <vector>
namespace node {
namespace inspector {
namespace {
using v8_inspector::StringBuffer;
using v8_inspector::StringView;
std::string ScriptPath(uv_loop_t* loop, const std::string& script_name) {
std::string script_path;
if (!script_name.empty()) {
uv_fs_t req;
req.ptr = nullptr;
if (0 == uv_fs_realpath(loop, &req, script_name.c_str(), nullptr)) {
CHECK_NOT_NULL(req.ptr);
script_path = std::string(static_cast<char*>(req.ptr));
}
uv_fs_req_cleanup(&req);
}
return script_path;
}
// UUID RFC: https://www.ietf.org/rfc/rfc4122.txt
// Used ver 4 - with numbers
std::string GenerateID() {
uint16_t buffer[8];
CHECK(crypto::EntropySource(reinterpret_cast<unsigned char*>(buffer),
sizeof(buffer)));
char uuid[256];
snprintf(uuid, sizeof(uuid), "%04x%04x-%04x-%04x-%04x-%04x%04x%04x",
buffer[0], // time_low
buffer[1], // time_mid
buffer[2], // time_low
(buffer[3] & 0x0fff) | 0x4000, // time_hi_and_version
(buffer[4] & 0x3fff) | 0x8000, // clk_seq_hi clk_seq_low
buffer[5], // node
buffer[6],
buffer[7]);
return uuid;
}
class RequestToServer {
public:
RequestToServer(TransportAction action,
int session_id,
std::unique_ptr<v8_inspector::StringBuffer> message)
: action_(action),
session_id_(session_id),
message_(std::move(message)) {}
void Dispatch(InspectorSocketServer* server) const {
switch (action_) {
case TransportAction::kKill:
server->TerminateConnections();
// Fallthrough
case TransportAction::kStop:
server->Stop();
break;
case TransportAction::kSendMessage:
server->Send(
session_id_,
protocol::StringUtil::StringViewToUtf8(message_->string()));
break;
}
}
private:
TransportAction action_;
int session_id_;
std::unique_ptr<v8_inspector::StringBuffer> message_;
};
class RequestQueueData {
public:
using MessageQueue = std::deque<RequestToServer>;
explicit RequestQueueData(uv_loop_t* loop)
: handle_(std::make_shared<RequestQueue>(this)) {
int err = uv_async_init(loop, &async_, [](uv_async_t* async) {
RequestQueueData* wrapper =
node::ContainerOf(&RequestQueueData::async_, async);
wrapper->DoDispatch();
});
CHECK_EQ(0, err);
}
static void CloseAndFree(RequestQueueData* queue);
void Post(int session_id,
TransportAction action,
std::unique_ptr<StringBuffer> message) {
Mutex::ScopedLock scoped_lock(state_lock_);
bool notify = messages_.empty();
messages_.emplace_back(action, session_id, std::move(message));
if (notify) {
CHECK_EQ(0, uv_async_send(&async_));
incoming_message_cond_.Broadcast(scoped_lock);
}
}
void Wait() {
Mutex::ScopedLock scoped_lock(state_lock_);
if (messages_.empty()) {
incoming_message_cond_.Wait(scoped_lock);
}
}
void SetServer(InspectorSocketServer* server) {
server_ = server;
}
std::shared_ptr<RequestQueue> handle() {
return handle_;
}
private:
~RequestQueueData() = default;
MessageQueue GetMessages() {
Mutex::ScopedLock scoped_lock(state_lock_);
MessageQueue messages;
messages_.swap(messages);
return messages;
}
void DoDispatch() {
if (server_ == nullptr)
return;
for (const auto& request : GetMessages()) {
request.Dispatch(server_);
}
}
std::shared_ptr<RequestQueue> handle_;
uv_async_t async_;
InspectorSocketServer* server_ = nullptr;
MessageQueue messages_;
Mutex state_lock_; // Locked before mutating the queue.
ConditionVariable incoming_message_cond_;
};
} // namespace
class RequestQueue {
public:
explicit RequestQueue(RequestQueueData* data) : data_(data) {}
void Reset() {
Mutex::ScopedLock scoped_lock(lock_);
data_ = nullptr;
}
void Post(int session_id,
TransportAction action,
std::unique_ptr<StringBuffer> message) {
Mutex::ScopedLock scoped_lock(lock_);
if (data_ != nullptr)
data_->Post(session_id, action, std::move(message));
}
void SetServer(InspectorSocketServer* server) {
Mutex::ScopedLock scoped_lock(lock_);
if (data_ != nullptr)
data_->SetServer(server);
}
bool Expired() {
Mutex::ScopedLock scoped_lock(lock_);
return data_ == nullptr;
}
private:
RequestQueueData* data_;
Mutex lock_;
};
class IoSessionDelegate : public InspectorSessionDelegate {
public:
explicit IoSessionDelegate(std::shared_ptr<RequestQueue> queue, int id)
: request_queue_(queue), id_(id) { }
void SendMessageToFrontend(const v8_inspector::StringView& message) override {
request_queue_->Post(id_, TransportAction::kSendMessage,
StringBuffer::create(message));
}
private:
std::shared_ptr<RequestQueue> request_queue_;
int id_;
};
// Passed to InspectorSocketServer to handle WS inspector protocol events,
// mostly session start, message received, and session end.
class InspectorIoDelegate: public node::inspector::SocketServerDelegate {
public:
InspectorIoDelegate(std::shared_ptr<RequestQueueData> queue,
std::shared_ptr<MainThreadHandle> main_threade,
const std::string& target_id,
const std::string& script_path,
const std::string& script_name);
~InspectorIoDelegate() override = default;
void StartSession(int session_id, const std::string& target_id) override;
void MessageReceived(int session_id, const std::string& message) override;
void EndSession(int session_id) override;
std::vector<std::string> GetTargetIds() override;
std::string GetTargetTitle(const std::string& id) override;
std::string GetTargetUrl(const std::string& id) override;
void AssignServer(InspectorSocketServer* server) override {
request_queue_->SetServer(server);
}
private:
std::shared_ptr<RequestQueueData> request_queue_;
std::shared_ptr<MainThreadHandle> main_thread_;
std::unordered_map<int, std::unique_ptr<InspectorSession>> sessions_;
const std::string script_name_;
const std::string script_path_;
const std::string target_id_;
};
// static
std::unique_ptr<InspectorIo> InspectorIo::Start(
std::shared_ptr<MainThreadHandle> main_thread,
const std::string& path,
std::shared_ptr<HostPort> host_port) {
auto io = std::unique_ptr<InspectorIo>(
new InspectorIo(main_thread, path, host_port));
if (io->request_queue_->Expired()) { // Thread is not running
return nullptr;
}
return io;
}
InspectorIo::InspectorIo(std::shared_ptr<MainThreadHandle> main_thread,
const std::string& path,
std::shared_ptr<HostPort> host_port)
: main_thread_(main_thread),
host_port_(host_port),
thread_(),
script_name_(path),
id_(GenerateID()) {
Mutex::ScopedLock scoped_lock(thread_start_lock_);
CHECK_EQ(uv_thread_create(&thread_, InspectorIo::ThreadMain, this), 0);
thread_start_condition_.Wait(scoped_lock);
}
InspectorIo::~InspectorIo() {
request_queue_->Post(0, TransportAction::kKill, nullptr);
int err = uv_thread_join(&thread_);
CHECK_EQ(err, 0);
}
void InspectorIo::StopAcceptingNewConnections() {
request_queue_->Post(0, TransportAction::kStop, nullptr);
}
// static
void InspectorIo::ThreadMain(void* io) {
static_cast<InspectorIo*>(io)->ThreadMain();
}
void InspectorIo::ThreadMain() {
uv_loop_t loop;
loop.data = nullptr;
int err = uv_loop_init(&loop);
CHECK_EQ(err, 0);
std::shared_ptr<RequestQueueData> queue(new RequestQueueData(&loop),
RequestQueueData::CloseAndFree);
std::string script_path = ScriptPath(&loop, script_name_);
std::unique_ptr<InspectorIoDelegate> delegate(
new InspectorIoDelegate(queue, main_thread_, id_,
script_path, script_name_));
InspectorSocketServer server(std::move(delegate),
&loop,
host_port_->host(),
host_port_->port());
request_queue_ = queue->handle();
// Its lifetime is now that of the server delegate
queue.reset();
{
Mutex::ScopedLock scoped_lock(thread_start_lock_);
if (server.Start()) {
host_port_->set_port(server.Port());
}
thread_start_condition_.Broadcast(scoped_lock);
}
uv_run(&loop, UV_RUN_DEFAULT);
CheckedUvLoopClose(&loop);
}
std::vector<std::string> InspectorIo::GetTargetIds() const {
return { id_ };
}
InspectorIoDelegate::InspectorIoDelegate(
std::shared_ptr<RequestQueueData> queue,
std::shared_ptr<MainThreadHandle> main_thread,
const std::string& target_id,
const std::string& script_path,
const std::string& script_name)
: request_queue_(queue), main_thread_(main_thread),
script_name_(script_name), script_path_(script_path),
target_id_(target_id) {}
void InspectorIoDelegate::StartSession(int session_id,
const std::string& target_id) {
auto session = main_thread_->Connect(
std::unique_ptr<InspectorSessionDelegate>(
new IoSessionDelegate(request_queue_->handle(), session_id)), true);
if (session) {
sessions_[session_id] = std::move(session);
fprintf(stderr, "Debugger attached.\n");
}
}
void InspectorIoDelegate::MessageReceived(int session_id,
const std::string& message) {
auto session = sessions_.find(session_id);
if (session != sessions_.end())
session->second->Dispatch(Utf8ToStringView(message)->string());
}
void InspectorIoDelegate::EndSession(int session_id) {
sessions_.erase(session_id);
}
std::vector<std::string> InspectorIoDelegate::GetTargetIds() {
return { target_id_ };
}
std::string InspectorIoDelegate::GetTargetTitle(const std::string& id) {
return script_name_.empty() ? GetHumanReadableProcessName() : script_name_;
}
std::string InspectorIoDelegate::GetTargetUrl(const std::string& id) {
return "file://" + script_path_;
}
// static
void RequestQueueData::CloseAndFree(RequestQueueData* queue) {
queue->handle_->Reset();
queue->handle_.reset();
uv_close(reinterpret_cast<uv_handle_t*>(&queue->async_),
[](uv_handle_t* handle) {
uv_async_t* async = reinterpret_cast<uv_async_t*>(handle);
RequestQueueData* wrapper =
node::ContainerOf(&RequestQueueData::async_, async);
delete wrapper;
});
}
} // namespace inspector
} // namespace node
|