[PlayStation] Upstream playstation's remote inspector server

https://bugs.webkit.org/show_bug.cgi?id=193806

Reviewed by Joseph Pecoraro.

Upstreaming PlayStation's Remote Inspector implementation.
It is using a JSON RPC protocol over TCP sockets.
This inspector implementation is planned to also support running on a WinCairo Client and Server.

* PlatformPlayStation.cmake:
* SourcesGTK.txt:
* SourcesWPE.txt:
* inspector/remote/RemoteConnectionToTarget.cpp: Renamed from Source/JavaScriptCore/inspector/remote/glib/RemoteConnectionToTargetGlib.cpp.
* inspector/remote/RemoteInspector.h:
* inspector/remote/playstation/RemoteInspectorConnectionClient.h: Added.
* inspector/remote/playstation/RemoteInspectorConnectionClientPlayStation.cpp: Added.
* inspector/remote/playstation/RemoteInspectorMessageParser.h: Added.
* inspector/remote/playstation/RemoteInspectorMessageParserPlayStation.cpp: Added.
* inspector/remote/playstation/RemoteInspectorPlayStation.cpp: Added.
* inspector/remote/playstation/RemoteInspectorServer.h: Added.
* inspector/remote/playstation/RemoteInspectorServerPlayStation.cpp: Added.
* inspector/remote/playstation/RemoteInspectorSocket.h: Added.
* inspector/remote/playstation/RemoteInspectorSocketClient.h: Added.
* inspector/remote/playstation/RemoteInspectorSocketClientPlayStation.cpp: Added.
* inspector/remote/playstation/RemoteInspectorSocketPlayStation.cpp: Added.
* inspector/remote/playstation/RemoteInspectorSocketServer.h: Added.
* inspector/remote/playstation/RemoteInspectorSocketServerPlayStation.cpp: Added.


git-svn-id: http://svn.webkit.org/repository/webkit/trunk@242306 268f45cc-cd09-0410-ab3c-d52691b4dbfc

Author: [email protected]

Source/JavaScriptCore/ChangeLog

@@ -1,3 +1,33 @@
+2019-03-01  Christopher Reid  <[email protected]>
+
+        [PlayStation] Upstream playstation's remote inspector server
+        https://bugs.webkit.org/show_bug.cgi?id=193806
+
+        Reviewed by Joseph Pecoraro.
+
+        Upstreaming PlayStation's Remote Inspector implementation.
+        It is using a JSON RPC protocol over TCP sockets.
+        This inspector implementation is planned to also support running on a WinCairo Client and Server.
+
+        * PlatformPlayStation.cmake:
+        * SourcesGTK.txt:
+        * SourcesWPE.txt:
+        * inspector/remote/RemoteConnectionToTarget.cpp: Renamed from Source/JavaScriptCore/inspector/remote/glib/RemoteConnectionToTargetGlib.cpp.
+        * inspector/remote/RemoteInspector.h:
+        * inspector/remote/playstation/RemoteInspectorConnectionClient.h: Added.
+        * inspector/remote/playstation/RemoteInspectorConnectionClientPlayStation.cpp: Added.
+        * inspector/remote/playstation/RemoteInspectorMessageParser.h: Added.
+        * inspector/remote/playstation/RemoteInspectorMessageParserPlayStation.cpp: Added.
+        * inspector/remote/playstation/RemoteInspectorPlayStation.cpp: Added.
+        * inspector/remote/playstation/RemoteInspectorServer.h: Added.
+        * inspector/remote/playstation/RemoteInspectorServerPlayStation.cpp: Added.
+        * inspector/remote/playstation/RemoteInspectorSocket.h: Added.
+        * inspector/remote/playstation/RemoteInspectorSocketClient.h: Added.
+        * inspector/remote/playstation/RemoteInspectorSocketClientPlayStation.cpp: Added.
+        * inspector/remote/playstation/RemoteInspectorSocketPlayStation.cpp: Added.
+        * inspector/remote/playstation/RemoteInspectorSocketServer.h: Added.
+        * inspector/remote/playstation/RemoteInspectorSocketServerPlayStation.cpp: Added.
+
 2019-03-01  Saam Barati  <[email protected]>
 
         Create SPI to crash if a JSC VM is created

Source/JavaScriptCore/PlatformPlayStation.cmake

@@ -1,3 +1,40 @@
+list(APPEND JavaScriptCore_PRIVATE_INCLUDE_DIRECTORIES
+    "${JAVASCRIPTCORE_DIR}/inspector/remote/playstation"
+)
+
+list(APPEND JavaScriptCore_PRIVATE_FRAMEWORK_HEADERS
+    inspector/remote/RemoteAutomationTarget.h
+    inspector/remote/RemoteConnectionToTarget.h
+    inspector/remote/RemoteControllableTarget.h
+    inspector/remote/RemoteInspectionTarget.h
+    inspector/remote/RemoteInspector.h
+
+    inspector/remote/playstation/RemoteInspectorConnectionClient.h
+    inspector/remote/playstation/RemoteInspectorMessageParser.h
+    inspector/remote/playstation/RemoteInspectorServer.h
+    inspector/remote/playstation/RemoteInspectorSocket.h
+    inspector/remote/playstation/RemoteInspectorSocketClient.h
+    inspector/remote/playstation/RemoteInspectorSocketServer.h
+)
+
+list(APPEND JavaScriptCore_SOURCES
+    API/JSRemoteInspector.cpp
+
+    inspector/remote/RemoteAutomationTarget.cpp
+    inspector/remote/RemoteConnectionToTarget.cpp
+    inspector/remote/RemoteControllableTarget.cpp
+    inspector/remote/RemoteInspectionTarget.cpp
+    inspector/remote/RemoteInspector.cpp
+
+    inspector/remote/playstation/RemoteInspectorConnectionClientPlayStation.cpp
+    inspector/remote/playstation/RemoteInspectorMessageParserPlayStation.cpp
+    inspector/remote/playstation/RemoteInspectorPlayStation.cpp
+    inspector/remote/playstation/RemoteInspectorServerPlayStation.cpp
+    inspector/remote/playstation/RemoteInspectorSocketClientPlayStation.cpp
+    inspector/remote/playstation/RemoteInspectorSocketPlayStation.cpp
+    inspector/remote/playstation/RemoteInspectorSocketServerPlayStation.cpp
+)
+
 if (${WTF_LIBRARY_TYPE} STREQUAL "STATIC")
     add_definitions(-DSTATICALLY_LINKED_WITH_WTF)
 endif ()

Source/JavaScriptCore/SourcesGTK.txt

@@ -24,11 +24,11 @@
 API/JSRemoteInspector.cpp
 
 inspector/remote/RemoteAutomationTarget.cpp
+inspector/remote/RemoteConnectionToTarget.cpp
 inspector/remote/RemoteControllableTarget.cpp
 inspector/remote/RemoteInspectionTarget.cpp
 inspector/remote/RemoteInspector.cpp
 
-inspector/remote/glib/RemoteConnectionToTargetGlib.cpp
 inspector/remote/glib/RemoteInspectorGlib.cpp
 inspector/remote/glib/RemoteInspectorServer.cpp
 inspector/remote/glib/RemoteInspectorUtils.cpp

Source/JavaScriptCore/SourcesWPE.txt

@@ -24,11 +24,11 @@
 API/JSRemoteInspector.cpp
 
 inspector/remote/RemoteAutomationTarget.cpp
+inspector/remote/RemoteConnectionToTarget.cpp
 inspector/remote/RemoteControllableTarget.cpp
 inspector/remote/RemoteInspectionTarget.cpp
 inspector/remote/RemoteInspector.cpp
 
-inspector/remote/glib/RemoteConnectionToTargetGlib.cpp
 inspector/remote/glib/RemoteInspectorGlib.cpp
 inspector/remote/glib/RemoteInspectorServer.cpp
 inspector/remote/glib/RemoteInspectorUtils.cpp

Source/JavaScriptCore/inspector/remote/glib/RemoteConnectionToTargetGlib.cpp renamed to Source/JavaScriptCore/inspector/remote/RemoteConnectionToTarget.cpp

@@ -51,6 +51,19 @@ typedef struct _GDBusConnection GDBusConnection;
 typedef struct _GDBusInterfaceVTable GDBusInterfaceVTable;
 #endif
 
+#if PLATFORM(PLAYSTATION)
+#include "RemoteConnectionToTarget.h"
+#include "RemoteInspectorConnectionClient.h"
+#include "RemoteInspectorSocketClient.h"
+#include <wtf/JSONValues.h>
+#include <wtf/RefCounted.h>
+#include <wtf/RefPtr.h>
+
+namespace Inspector {
+using TargetListing = RefPtr<JSON::Object>;
+}
+#endif
+
 namespace Inspector {
 
 class RemoteAutomationTarget;
@@ -62,6 +75,8 @@ class RemoteInspectorClient;
 class JS_EXPORT_PRIVATE RemoteInspector final
 #if PLATFORM(COCOA)
     : public RemoteInspectorXPCConnection::Client
+#elif PLATFORM(PLAYSTATION)
+    : public RemoteInspectorConnectionClient
 #endif
 {
 public:
@@ -128,9 +143,14 @@ class JS_EXPORT_PRIVATE RemoteInspector final
 
 #if USE(GLIB)
     void requestAutomationSession(const char* sessionID, const Client::SessionCapabilities&);
+#endif
+#if USE(GLIB) || PLATFORM(PLAYSTATION)
     void setup(unsigned targetIdentifier);
     void sendMessageToTarget(unsigned targetIdentifier, const char* message);
 #endif
+#if PLATFORM(PLAYSTATION)
+    static void setConnectionIdentifier(PlatformSocketType);
+#endif
 
 private:
     RemoteInspector();
@@ -184,7 +204,17 @@ class JS_EXPORT_PRIVATE RemoteInspector final
     void receivedAutomaticInspectionRejectMessage(NSDictionary *userInfo);
     void receivedAutomationSessionRequestMessage(NSDictionary *userInfo);
 #endif
+#if PLATFORM(PLAYSTATION)
+    HashMap<String, CallHandler>& dispatchMap() override;
+    void didClose(ClientID) override;
+
+    void sendWebInspectorEvent(const String&);
 
+    void receivedGetTargetListMessage(const struct Event&);
+    void receivedSetupMessage(const struct Event&);
+    void receivedDataMessage(const struct Event&);
+    void receivedCloseMessage(const struct Event&);
+#endif
     static bool startEnabled;
 
     // Targets can be registered from any thread at any time.
@@ -205,6 +235,12 @@ class JS_EXPORT_PRIVATE RemoteInspector final
     GRefPtr<GCancellable> m_cancellable;
 #endif
 
+#if PLATFORM(PLAYSTATION)
+    std::unique_ptr<RemoteInspectorSocketClient> m_socketConnection;
+    static PlatformSocketType s_connectionIdentifier;
+    Optional<ClientID> m_clientID;
+#endif
+
     RemoteInspector::Client* m_client { nullptr };
     Optional<RemoteInspector::Client::Capabilities> m_clientCapabilities;
 

Source/JavaScriptCore/inspector/remote/RemoteInspector.h

@@ -0,0 +1,55 @@
+/*
+ * Copyright (C) 2019 Sony Interactive Entertainment Inc.
+ *
+ * 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. AND ITS CONTRIBUTORS ``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 ITS 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(REMOTE_INSPECTOR)
+
+#include "RemoteInspectorSocket.h"
+#include <wtf/WeakPtr.h>
+#include <wtf/text/WTFString.h>
+
+namespace Inspector {
+
+class RemoteInspectorConnectionClient : public CanMakeWeakPtr<RemoteInspectorConnectionClient> {
+public:
+    void didReceiveWebInspectorEvent(ClientID, Vector<uint8_t>&&);
+    virtual void didAccept(ClientID, RemoteInspectorSocket::DomainType) { };
+    virtual void didClose(ClientID) = 0;
+
+    struct Event {
+        ClientID clientID;
+        Optional<uint64_t> connectionID;
+        Optional<uint64_t> targetID;
+        Optional<String> message;
+    };
+
+    using CallHandler = void (RemoteInspectorConnectionClient::*)(const struct Event&);
+    virtual HashMap<String, CallHandler>& dispatchMap() = 0;
+};
+
+} // namespace Inspector
+
+#endif // ENABLE(REMOTE_INSPECTOR)

Source/JavaScriptCore/inspector/remote/playstation/RemoteInspectorConnectionClient.h

@@ -0,0 +1,85 @@
+/*
+ * Copyright (C) 2019 Sony Interactive Entertainment Inc.
+ *
+ * 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. AND ITS CONTRIBUTORS ``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 ITS 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.
+ */
+
+#include "config.h"
+#include "RemoteInspectorConnectionClient.h"
+
+#if ENABLE(REMOTE_INSPECTOR)
+
+#include "RemoteInspectorSocket.h"
+#include <wtf/JSONValues.h>
+#include <wtf/RunLoop.h>
+
+namespace Inspector {
+
+void RemoteInspectorConnectionClient::didReceiveWebInspectorEvent(ClientID clientID, Vector<uint8_t>&& data)
+{
+    ASSERT(!isMainThread());
+
+    if (data.isEmpty())
+        return;
+
+    String jsonData = String::fromUTF8(data);
+
+    RefPtr<JSON::Value> messageValue;
+    if (!JSON::Value::parseJSON(jsonData, messageValue))
+        return;
+
+    RefPtr<JSON::Object> messageObject;
+    if (!messageValue->asObject(messageObject))
+        return;
+
+    String methodName;
+    if (!messageObject->getString("event"_s, methodName))
+        return;
+
+    struct Event event;
+    event.clientID = clientID;
+
+    uint64_t connectionID;
+    if (messageObject->getInteger("connectionID"_s, connectionID))
+        event.connectionID = connectionID;
+
+    uint64_t targetID;
+    if (messageObject->getInteger("targetID"_s, targetID))
+        event.targetID = targetID;
+
+    String message;
+    if (messageObject->getString("message"_s, message))
+        event.message = message;
+
+    RunLoop::main().dispatch([this, methodName, event = WTFMove(event)] {
+        auto& methods = dispatchMap();
+        if (methods.contains(methodName)) {
+            auto call = methods.get(methodName);
+            (this->*call)(event);
+        } else
+            LOG_ERROR("Unknown event: %s", methodName.utf8().data());
+    });
+}
+
+} // namespace Inspector
+
+#endif // ENABLE(REMOTE_INSPECTOR)

Source/JavaScriptCore/inspector/remote/playstation/RemoteInspectorConnectionClientPlayStation.cpp

@@ -0,0 +1,55 @@
+/*
+ * Copyright (C) 2019 Sony Interactive Entertainment Inc.
+ *
+ * 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. AND ITS CONTRIBUTORS ``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 ITS 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(REMOTE_INSPECTOR)
+
+#include "RemoteInspectorSocket.h"
+#include <wtf/Vector.h>
+
+namespace Inspector {
+
+class MessageParser {
+public:
+    static Vector<uint8_t> createMessage(const uint8_t*, size_t);
+
+    MessageParser(ClientID, size_t);
+    void pushReceivedData(const uint8_t*, size_t);
+    void setDidParseMessageListener(Function<void(ClientID, Vector<uint8_t>)>&& listener) { m_didParseMessageListener = WTFMove(listener); }
+
+    void clearReceivedData();
+
+private:
+    bool parse();
+
+    Function<void(ClientID, Vector<uint8_t>&&)> m_didParseMessageListener;
+    Vector<uint8_t> m_buffer;
+    ClientID m_clientID;
+};
+
+} // namespace Inspector
+
+#endif // ENABLE(REMOTE_INSPECTOR)