Changeset 272050 in webkit

Timestamp:

Jan 29, 2021 12:47:58 AM (3 years ago)

Author:

youenn@apple.com

Message:

Recover audio and video capture from GPUProcess crash
​https://bugs.webkit.org/show_bug.cgi?id=221086

Reviewed by Eric Carlson.

Make RemoteRealtimeMediaSource observe GPU process crash.
If RemoteRealtimeMediaSource is live and capturing in GPUProcess, restart capture from WebProcess.
If GPU process crashes, make sure to send back the necessary entitlements and information to GPUProcess
of which processes are allowed to capture.

Covered by API test.

• UIProcess/WebPageProxy.cpp:

(WebKit::WebPageProxy::gpuProcessCrashed):

• WebProcess/cocoa/RemoteCaptureSampleManager.cpp:

(WebKit::RemoteCaptureSampleManager::didUpdateSourceConnection):

• WebProcess/cocoa/RemoteCaptureSampleManager.h:
• WebProcess/cocoa/RemoteRealtimeMediaSource.cpp:

(WebKit::RemoteRealtimeMediaSource::create):
(WebKit::RemoteRealtimeMediaSource::createRemoteMediaSource):
(WebKit::RemoteRealtimeMediaSource::~RemoteRealtimeMediaSource):
(WebKit::RemoteRealtimeMediaSource::gpuProcessConnectionDidClose):

• WebProcess/cocoa/RemoteRealtimeMediaSource.h:
• WebProcess/cocoa/UserMediaCaptureManager.cpp:

(WebKit::UserMediaCaptureManager::AudioFactory::createAudioCaptureSource):
(WebKit::UserMediaCaptureManager::VideoFactory::createVideoCaptureSource):
(WebKit::UserMediaCaptureManager::DisplayFactory::createDisplayCaptureSource):
(WebKit::UserMediaCaptureManager::didUpdateSourceConnection):

• WebProcess/cocoa/UserMediaCaptureManager.h:

Location:

trunk

Files:

• Source/WebKit/ChangeLog (modified) (1 diff)
• Source/WebKit/UIProcess/WebPageProxy.cpp (modified) (1 diff)
• Source/WebKit/WebProcess/cocoa/RemoteCaptureSampleManager.cpp (modified) (1 diff)
• Source/WebKit/WebProcess/cocoa/RemoteCaptureSampleManager.h (modified) (1 diff)
• Source/WebKit/WebProcess/cocoa/RemoteRealtimeMediaSource.cpp (modified) (3 diffs)
• Source/WebKit/WebProcess/cocoa/RemoteRealtimeMediaSource.h (modified) (4 diffs)
• Source/WebKit/WebProcess/cocoa/UserMediaCaptureManager.cpp (modified) (3 diffs)
• Source/WebKit/WebProcess/cocoa/UserMediaCaptureManager.h (modified) (1 diff)
• Tools/TestWebKitAPI/Tests/WebKit/GetUserMedia.mm (modified) (2 diffs)
• Tools/TestWebKitAPI/Tests/WebKit/getUserMedia.html (modified) (2 diffs)

trunk/Source/WebKit/ChangeLog

@@ +1 @@
+2021-01-29  Youenn Fablet  <youenn@apple.com>
+
+        Recover audio and video capture from GPUProcess crash
+        https://bugs.webkit.org/show_bug.cgi?id=221086
+
+        Reviewed by Eric Carlson.
+
+        Make RemoteRealtimeMediaSource observe GPU process crash.
+        If RemoteRealtimeMediaSource is live and capturing in GPUProcess, restart capture from WebProcess.
+        If GPU process crashes, make sure to send back the necessary entitlements and information to GPUProcess
+        of which processes are allowed to capture.
+
+        Covered by API test.
+
+        * UIProcess/WebPageProxy.cpp:
+        (WebKit::WebPageProxy::gpuProcessCrashed):
+        * WebProcess/cocoa/RemoteCaptureSampleManager.cpp:
+        (WebKit::RemoteCaptureSampleManager::didUpdateSourceConnection):
+        * WebProcess/cocoa/RemoteCaptureSampleManager.h:
+        * WebProcess/cocoa/RemoteRealtimeMediaSource.cpp:
+        (WebKit::RemoteRealtimeMediaSource::create):
+        (WebKit::RemoteRealtimeMediaSource::createRemoteMediaSource):
+        (WebKit::RemoteRealtimeMediaSource::~RemoteRealtimeMediaSource):
+        (WebKit::RemoteRealtimeMediaSource::gpuProcessConnectionDidClose):
+        * WebProcess/cocoa/RemoteRealtimeMediaSource.h:
+        * WebProcess/cocoa/UserMediaCaptureManager.cpp:
+        (WebKit::UserMediaCaptureManager::AudioFactory::createAudioCaptureSource):
+        (WebKit::UserMediaCaptureManager::VideoFactory::createVideoCaptureSource):
+        (WebKit::UserMediaCaptureManager::DisplayFactory::createDisplayCaptureSource):
+        (WebKit::UserMediaCaptureManager::didUpdateSourceConnection):
+        * WebProcess/cocoa/UserMediaCaptureManager.h:
+
 2021-01-28  Megan Gardner  <megan_gardner@apple.com>
 

trunk/Source/WebKit/UIProcess/WebPageProxy.cpp

@@ -10363 +10363 @@
 {
     pageClient().gpuProcessCrashed();
+
+#if ENABLE(MEDIA_STREAM)
+    bool shouldAllowAudioCapture = isCapturingAudio() && preferences().captureAudioInGPUProcessEnabled();
+    bool shouldAllowVideoCapture = isCapturingVideo() && preferences().captureVideoInGPUProcessEnabled();
+    bool shouldAllowDisplayCapture = false;
+    if (shouldAllowAudioCapture || shouldAllowVideoCapture) {
+        auto& gpuProcess = process().processPool().ensureGPUProcess();
+        gpuProcess.updateCaptureAccess(shouldAllowAudioCapture, shouldAllowVideoCapture, shouldAllowDisplayCapture, m_process->coreProcessIdentifier(), [] { });
+    }
+#endif
 }
 #endif

trunk/Source/WebKit/WebProcess/cocoa/RemoteCaptureSampleManager.cpp

@@ -83 +83 @@
 }
 
+void RemoteCaptureSampleManager::didUpdateSourceConnection(RemoteRealtimeMediaSource& source)
+{
+    ASSERT(WTF::isMainRunLoop());
+    setConnection(source.connection());
+}
+
 void RemoteCaptureSampleManager::dispatchToThread(Function<void()>&& callback)
 {

trunk/Source/WebKit/WebProcess/cocoa/RemoteCaptureSampleManager.h

@@ -49 +49 @@
     void removeSource(WebCore::RealtimeMediaSourceIdentifier);
 
+    void didUpdateSourceConnection(RemoteRealtimeMediaSource&);
+
     void didReceiveMessage(IPC::Connection&, IPC::Decoder&);
 

trunk/Source/WebKit/WebProcess/cocoa/RemoteRealtimeMediaSource.cpp

@@ -47 +47 @@
 using namespace WebCore;
 
-Ref<RealtimeMediaSource> RemoteRealtimeMediaSource::create(const WebCore::CaptureDevice& device, const WebCore::MediaConstraints& constraints, String&& name, String&& hashSalt, UserMediaCaptureManager& manager, bool shouldCaptureInGPUProcess)
+Ref<RealtimeMediaSource> RemoteRealtimeMediaSource::create(const CaptureDevice& device, const MediaConstraints& constraints, String&& name, String&& hashSalt, UserMediaCaptureManager& manager, bool shouldCaptureInGPUProcess)
 {
     auto source = adoptRef(*new RemoteRealtimeMediaSource(RealtimeMediaSourceIdentifier::generate(), device.type(), WTFMove(name), WTFMove(hashSalt), manager, shouldCaptureInGPUProcess));
     manager.addSource(source.copyRef());
-    source->connection()->sendWithAsyncReply(Messages::UserMediaCaptureManagerProxy::CreateMediaSourceForCaptureDeviceWithConstraints(source->identifier(), device, source->deviceIDHashSalt(), constraints), [source = source.copyRef()](bool succeeded, auto&& errorMessage, auto&& settings, auto&& capabilities) {
-        if (!succeeded) {
-            source->didFail(WTFMove(errorMessage));
-            return;
-        }
-        source->setName(String { settings.label().string() });
-        source->setSettings(WTFMove(settings));
-        source->setCapabilities(WTFMove(capabilities));
-        source->setAsReady();
-    });
+    source->createRemoteMediaSource(device, constraints);
     return source;
 }
@@ -107 +98 @@
 }
 
+void RemoteRealtimeMediaSource::createRemoteMediaSource(const CaptureDevice& device, const MediaConstraints& constraints)
+{
+    if (m_shouldCaptureInGPUProcess) {
+        m_device = device;
+        m_constraints = constraints;
+    }
+
+    connection()->sendWithAsyncReply(Messages::UserMediaCaptureManagerProxy::CreateMediaSourceForCaptureDeviceWithConstraints(identifier(), device, deviceIDHashSalt(), constraints), [this, protectedThis = makeRef(*this)](bool succeeded, auto&& errorMessage, auto&& settings, auto&& capabilities) {
+        if (!succeeded) {
+            didFail(WTFMove(errorMessage));
+            return;
+        }
+        setName(String { settings.label().string() });
+        setSettings(WTFMove(settings));
+        setCapabilities(WTFMove(capabilities));
+        setAsReady();
+        if (m_shouldCaptureInGPUProcess)
+            WebProcess::singleton().ensureGPUProcessConnection().addClient(*this);
+    });
+}
+
 RemoteRealtimeMediaSource::~RemoteRealtimeMediaSource()
 {
+    if (m_shouldCaptureInGPUProcess)
+        WebProcess::singleton().ensureGPUProcessConnection().removeClient(*this);
+
     switch (m_deviceType) {
     case CaptureDevice::DeviceType::Microphone:
@@ -306 +321 @@
 }
 
-}
-
-#endif
+#if ENABLE(GPU_PROCESS)
+void RemoteRealtimeMediaSource::gpuProcessConnectionDidClose(GPUProcessConnection&)
+{
+    ASSERT(m_shouldCaptureInGPUProcess);
+    if (isEnded())
+        return;
+
+    m_manager.didUpdateSourceConnection(*this);
+    createRemoteMediaSource(m_device, m_constraints);
+    // FIXME: We should update the track according current settings.
+    if (isProducingData())
+        startProducingData();
+}
+#endif
+
+}
+
+#endif

trunk/Source/WebKit/WebProcess/cocoa/RemoteRealtimeMediaSource.h

@@ -28 +28 @@
 #if PLATFORM(COCOA) && ENABLE(MEDIA_STREAM)
 
+#include "GPUProcessConnection.h"
 #include <WebCore/CaptureDevice.h>
 #include <WebCore/RealtimeMediaSource.h>
@@ -48 +49 @@
 class UserMediaCaptureManager;
 
-class RemoteRealtimeMediaSource : public WebCore::RealtimeMediaSource {
+class RemoteRealtimeMediaSource : public WebCore::RealtimeMediaSource
+#if ENABLE(GPU_PROCESS)
+    , public GPUProcessConnection::Client
+#endif
+{
 public:
-    static Ref<WebCore::RealtimeMediaSource> create(const WebCore::CaptureDevice&, const WebCore::MediaConstraints&, String&& name, String&& hashSalt, UserMediaCaptureManager&, bool shouldCaptureInGPUProcess = false);
+    static Ref<WebCore::RealtimeMediaSource> create(const WebCore::CaptureDevice&, const WebCore::MediaConstraints&, String&& name, String&& hashSalt, UserMediaCaptureManager&, bool shouldCaptureInGPUProcess);
     ~RemoteRealtimeMediaSource();
 
@@ -87 +92 @@
     Ref<RealtimeMediaSource> clone() final;
 
+#if ENABLE(GPU_PROCESS)
+    // GPUProcessConnection::Client
+    void gpuProcessConnectionDidClose(GPUProcessConnection&) final;
+#endif
+
+    void createRemoteMediaSource(const WebCore::CaptureDevice&, const WebCore::MediaConstraints&);
     void didFail(String&& errorMessage);
     void setAsReady();
@@ -105 +116 @@
     String m_errorMessage;
     CompletionHandler<void(String)> m_callback;
+    WebCore::CaptureDevice m_device;
+    WebCore::MediaConstraints m_constraints;
 };
 

trunk/Source/WebKit/WebProcess/cocoa/UserMediaCaptureManager.cpp

@@ -159 +159 @@
 #endif
 
-    return RemoteRealtimeMediaSource::create(device, *constraints, { }, WTFMove(hashSalt), m_manager);
+    return RemoteRealtimeMediaSource::create(device, *constraints, { }, WTFMove(hashSalt), m_manager, m_shouldCaptureInGPUProcess);
 }
 
@@ -177 +177 @@
 #endif
 
-    return RemoteRealtimeMediaSource::create(device, *constraints, { }, WTFMove(hashSalt), m_manager);
+    return RemoteRealtimeMediaSource::create(device, *constraints, { }, WTFMove(hashSalt), m_manager, m_shouldCaptureInGPUProcess);
 }
 
@@ -192 +192 @@
         return { };
 
-    return RemoteRealtimeMediaSource::create(device, *constraints, { }, { }, m_manager);
-}
-
-}
-
-#endif
+    return RemoteRealtimeMediaSource::create(device, *constraints, { }, { }, m_manager, false);
+}
+
+void UserMediaCaptureManager::didUpdateSourceConnection(RemoteRealtimeMediaSource& source)
+{
+    m_remoteCaptureSampleManager.didUpdateSourceConnection(source);
+}
+
+}
+
+#endif

trunk/Source/WebKit/WebProcess/cocoa/UserMediaCaptureManager.h

@@ -60 +60 @@
     void addSource(Ref<RemoteRealtimeMediaSource>&&);
     void removeSource(WebCore::RealtimeMediaSourceIdentifier);
+    void didUpdateSourceConnection(RemoteRealtimeMediaSource&);
 
 private:

trunk/Tools/TestWebKitAPI/Tests/WebKit/GetUserMedia.mm

@@ -39 +39 @@
 #import <WebKit/WKWebViewConfigurationPrivate.h>
 #import <WebKit/WKWebViewPrivateForTesting.h>
+#import <WebKit/_WKInternalDebugFeature.h>
 #import <WebKit/_WKProcessPoolConfiguration.h>
 #import <wtf/text/StringBuilder.h>
@@ -373 +374 @@
 #endif
 
+#if ENABLE(GPU_PROCESS)
+TEST(WebKit2, CrashGPUProcessWhileCapturing)
+{
+    auto configuration = adoptNS([[WKWebViewConfiguration alloc] init]);
+    auto preferences = [configuration preferences];
+
+    for (_WKInternalDebugFeature *feature in [WKPreferences _internalDebugFeatures]) {
+        if ([feature.key isEqualToString:@"CaptureAudioInGPUProcessEnabled"])
+            [preferences _setEnabled:YES forInternalDebugFeature:feature];
+        if ([feature.key isEqualToString:@"CaptureAudioInUIProcessEnabled"])
+            [preferences _setEnabled:NO forInternalDebugFeature:feature];
+        if ([feature.key isEqualToString:@"CaptureVideoInGPUProcessEnabled"])
+            [preferences _setEnabled:YES forInternalDebugFeature:feature];
+    }
+
+    preferences._mediaCaptureRequiresSecureConnection = NO;
+    configuration.get()._mediaCaptureEnabled = YES;
+    preferences._mockCaptureDevicesEnabled = YES;
+
+    auto messageHandler = adoptNS([[GUMMessageHandler alloc] init]);
+    [[configuration userContentController] addScriptMessageHandler:messageHandler.get() name:@"gum"];
+
+    auto webView = adoptNS([[TestWKWebView alloc] initWithFrame:CGRectMake(0, 0, 400, 400) configuration:configuration.get()]);
+
+    auto delegate = adoptNS([[GetUserMediaCaptureUIDelegate alloc] init]);
+    webView.get().UIDelegate = delegate.get();
+
+    [webView loadTestPageNamed:@"getUserMedia"];
+    EXPECT_TRUE(waitUntilCaptureState(webView.get(), _WKMediaCaptureStateActiveCamera));
+
+    done = false;
+    [webView stringByEvaluatingJavaScript:@"captureAudioAndVideo(true)"];
+    TestWebKitAPI::Util::run(&done);
+
+    auto webViewPID = [webView _webProcessIdentifier];
+
+    // The GPU process should get launched.
+    auto* processPool = configuration.get().processPool;
+    unsigned timeout = 0;
+    while (![processPool _gpuProcessIdentifier] && timeout++ < 100)
+        TestWebKitAPI::Util::sleep(0.1);
+
+    EXPECT_NE([processPool _gpuProcessIdentifier], 0);
+    if (![processPool _gpuProcessIdentifier])
+        return;
+    auto gpuProcessPID = [processPool _gpuProcessIdentifier];
+
+    // Kill the GPU Process.
+    kill(gpuProcessPID, 9);
+
+    // GPU Process should get relaunched.
+    timeout = 0;
+    while ((![processPool _gpuProcessIdentifier] || [processPool _gpuProcessIdentifier] == gpuProcessPID) && timeout++ < 100)
+        TestWebKitAPI::Util::sleep(0.1);
+    EXPECT_NE([processPool _gpuProcessIdentifier], 0);
+    EXPECT_NE([processPool _gpuProcessIdentifier], gpuProcessPID);
+    gpuProcessPID = [processPool _gpuProcessIdentifier];
+
+    // Make sure the WebProcess did not crash.
+    EXPECT_EQ(webViewPID, [webView _webProcessIdentifier]);
+
+    done = false;
+    [webView stringByEvaluatingJavaScript:@"createConnection()"];
+    TestWebKitAPI::Util::run(&done);
+
+    done = false;
+    [webView stringByEvaluatingJavaScript:@"checkVideoStatus()"];
+    TestWebKitAPI::Util::run(&done);
+
+    done = false;
+    [webView stringByEvaluatingJavaScript:@"checkAudioStatus()"];
+    TestWebKitAPI::Util::run(&done);
+
+    EXPECT_EQ(gpuProcessPID, [processPool _gpuProcessIdentifier]);
+    EXPECT_EQ(webViewPID, [webView _webProcessIdentifier]);
+}
+#endif
+
 } // namespace TestWebKitAPI
 

trunk/Tools/TestWebKitAPI/Tests/WebKit/getUserMedia.html

@@ -62 +62 @@
             }
 
-            function captureAudioAndVideo()
+            function captureAudioAndVideo(notifySuccess)
             {
-                navigator.mediaDevices.getUserMedia({audio: true, video: true}).then(s => stream = s);
+                navigator.mediaDevices.getUserMedia({audio: true, video: true}).then(s => {
+                    if (notifySuccess)
+                        window.webkit.messageHandlers.gum.postMessage("PASS");
+                    stream = s;
+                });
             }
 
@@ -93 +97 @@
             }
 
+            function getStats(connection, type, kind)
+            {
+                return connection.getStats().then((report) => {
+                    var stats;
+                    report.forEach((statItem) => {
+                        if (statItem.type === type && statItem.kind === kind) {
+                            stats = statItem;
+                        }
+                    });
+                    return stats;
+                });
+            }
+
+            var pc1, pc2;
+            function createConnection() {
+                pc1 = new RTCPeerConnection();
+                pc2 = new RTCPeerConnection();
+
+                pc1.onicecandidate = (e) => { if (e.candidate) pc2.addIceCandidate(e.candidate) }
+                pc2.onicecandidate = (e) => { if (e.candidate) pc1.addIceCandidate(e.candidate) }
+
+                stream.getTracks().forEach(track => pc1.addTrack(track, stream));
+
+                pc1.createOffer()
+                    .then((o) => pc1.setLocalDescription(o))
+                    .then(() => pc2.setRemoteDescription(pc1.localDescription))
+                    .then(() => pc2.createAnswer())
+                    .then((a) => pc2.setLocalDescription(a))
+                    .then((a) => pc1.setRemoteDescription(pc2.localDescription))
+                    .then(() => {
+                        window.webkit.messageHandlers.gum.postMessage("PASS");
+                    });
+            }
+
+            function checkVideoStatus(counter) {
+                if (!counter)
+                    counter = 0;
+                else if (counter > 100) {
+                    window.webkit.messageHandlers.gum.postMessage("FAIL");
+                    return;
+                }
+                getStats(pc1, "outbound-rtp", "video").then((stats) => {
+                    if (stats && stats.framesEncoded) {
+                        window.webkit.messageHandlers.gum.postMessage("PASS");
+                        return;
+                    }
+                    setTimeout(() => checkVideoStatus(++counter), 50);
+                });
+            }
+
+            function checkAudioStatus(counter) {
+                if (!counter)
+                    counter = 0;
+                else if (counter > 100) {
+                    window.webkit.messageHandlers.gum.postMessage("FAIL");
+                    return;
+                }
+                getStats(pc2, "inbound-rtp", "audio").then((stats) => {
+                    if (stats && stats.audioLevel > 0) {
+                        window.webkit.messageHandlers.gum.postMessage("PASS");
+                        return;
+                    }
+                    setTimeout(() => checkAudioStatus(++counter), 50);
+                });
+            }
         </script>
     <head>