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
|
/*
* Copyright (C) 2025 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#pragma once
#if ENABLE(WEBASSEMBLY)
WTF_ALLOW_UNSAFE_BUFFER_USAGE_BEGIN
#include <JavaScriptCore/WasmDebugServerUtilities.h>
#include <JavaScriptCore/WasmVirtualAddress.h>
#include <atomic>
#include <memory>
#include <wtf/HashMap.h>
#include <wtf/Vector.h>
#include <wtf/text/WTFString.h>
#if OS(WINDOWS)
#include <winsock2.h>
#endif
namespace JSC {
class CalleeBits;
class VM;
class CallFrame;
class JSWebAssemblyInstance;
class JSWebAssemblyModule;
namespace IPInt {
struct IPIntLocal;
struct IPIntStackEntry;
}
namespace Wasm {
class QueryHandler;
class MemoryHandler;
class RegisterHandler;
class ExecutionHandler;
class IPIntCallee;
class Module;
class ModuleManager;
class BreakpointManager;
class DebugServer {
WTF_MAKE_TZONE_ALLOCATED(DebugServer);
public:
enum class State : uint8_t {
Stopped, // Initial state, server is not running
Starting, // Transitional state during startup
Running, // Server is fully operational and accepting connections
Stopping, // Transitional state during shutdown
};
JS_EXPORT_PRIVATE static DebugServer& singleton();
#if OS(WINDOWS)
using SocketType = SOCKET;
static constexpr SocketType invalidSocketValue = INVALID_SOCKET;
#else
using SocketType = int;
static constexpr SocketType invalidSocketValue = -1;
#endif
static constexpr uint16_t defaultPort = 1234;
DebugServer();
~DebugServer() = default;
VM* vm() const { return m_vm; }
uint64_t mutatorThreadId() const
{
// Dynamically get the owner thread from the VM instead of caching it
// since the VM's owner can change over time.
RELEASE_ASSERT(m_vm);
auto ownerThread = m_vm->ownerThread();
RELEASE_ASSERT(ownerThread && *ownerThread);
return (*ownerThread)->uid();
}
uint64_t debugServerThreadId() const
{
RELEASE_ASSERT(m_debugServerThreadId.has_value());
return *m_debugServerThreadId;
}
JS_EXPORT_PRIVATE bool start(VM*);
JS_EXPORT_PRIVATE void stop();
#if ENABLE(REMOTE_INSPECTOR)
// DebugServer supports two modes:
// 1. Direct TCP socket mode (JSC shell debugging)
// 2. Remote Web Inspector integration mode (WebKit debugging)
bool isRWIMode() const { return !!m_rwiResponseHandler; }
JS_EXPORT_PRIVATE bool startRWI(VM*, Function<bool(const String&)>&& rwiResponseHandler);
#endif
void trackInstance(JSWebAssemblyInstance*);
void trackModule(Module&);
void untrackModule(Module&);
void setInterruptBreakpoint(JSWebAssemblyInstance*, IPIntCallee*);
void setStepIntoBreakpointForCall(VM&, CalleeBits, JSWebAssemblyInstance*);
void setStepIntoBreakpointForThrow(VM&, JSWebAssemblyInstance*);
bool stopCode(CallFrame*, JSWebAssemblyInstance*, IPIntCallee*, uint8_t* pc, uint8_t* mc, IPInt::IPIntLocal*, IPInt::IPIntStackEntry*);
void setPort(uint64_t port) { m_port = port; }
bool needToHandleBreakpoints() const;
JS_EXPORT_PRIVATE bool isConnected() const;
JS_EXPORT_PRIVATE void handleRawPacket(StringView rawPacket);
private:
void reset();
void setState(State);
JS_EXPORT_PRIVATE bool isState(State) const;
bool createAndBindServerSocket();
void startAcceptThread();
void acceptClientConnections();
void resetAll();
void closeSocket(SocketType&);
void handleClient();
void handlePacket(StringView packet);
void handleThreadManagement(StringView packet);
void sendAck();
void sendReplyOK();
void sendReplyNotSupported(StringView packet);
void sendReply(StringView reply);
void sendErrorReply(ProtocolError);
bool isSocketValid(SocketType clientSocket) const
{
#if OS(WINDOWS)
return clientSocket != invalidSocketValue;
#else
return clientSocket >= 0;
#endif
}
friend class QueryHandler;
friend class MemoryHandler;
friend class RegisterHandler;
friend class ExecutionHandler;
std::atomic<State> m_state { State::Stopped };
uint16_t m_port { defaultPort };
SocketType m_serverSocket { invalidSocketValue };
SocketType m_clientSocket { invalidSocketValue };
RefPtr<Thread> m_acceptThread;
VM* m_vm { nullptr };
std::optional<uint64_t> m_debugServerThreadId;
bool m_noAckMode { false };
std::unique_ptr<QueryHandler> m_queryHandler;
std::unique_ptr<MemoryHandler> m_memoryHandler;
std::unique_ptr<ExecutionHandler> m_executionHandler;
std::unique_ptr<ModuleManager> m_moduleManager;
std::unique_ptr<BreakpointManager> m_breakpointManager;
#if ENABLE(REMOTE_INSPECTOR)
Function<bool(const String&)> m_rwiResponseHandler;
#endif
};
} // namespace JSC
} // namespace Wasm
WTF_ALLOW_UNSAFE_BUFFER_USAGE_END
#endif // ENABLE(WEBASSEMBLY)
|
