Changeset 295530 in webkit

Timestamp:

Jun 14, 2022 11:06:06 AM (2 years ago)

Author:

pvollan@apple.com

Message:

Create sandbox extension for Power logging service in the GPU process
​https://bugs.webkit.org/show_bug.cgi?id=241227
<rdar://82442196>

Reviewed by Geoffrey Garen.

When power logging is enabled, the GPU process on macOS should be granted access to the Power logging service.

• Source/WTF/wtf/PlatformHave.h:
• Source/WebCore/PAL/PAL.xcodeproj/project.pbxproj:
• Source/WebCore/PAL/pal/spi/mac/PowerLogSPI.h: Copied from Source/WebKit/UIProcess/Cocoa/GPUProcessProxyCocoa.mm.
• Source/WebCore/platform/graphics/cg/ImageDecoderCG.cpp:

(WebCore::createImageSourceOptions):

• Source/WebKit/Configurations/WebKit.xcconfig:
• Source/WebKit/GPUProcess/GPUProcess.h:
• Source/WebKit/GPUProcess/GPUProcess.messages.in:
• Source/WebKit/GPUProcess/mac/GPUProcessMac.mm:

(WebKit::GPUProcess::openDirectoryCacheInvalidated):
(WebKit::GPUProcess::enablePowerLogging):

• Source/WebKit/UIProcess/Cocoa/GPUProcessProxyCocoa.mm:

(WebKit::GPUProcessProxy::powerLoggingInTaskMode const):
(WebKit::GPUProcessProxy::enablePowerLogging):

• Source/WebKit/UIProcess/Cocoa/WebProcessPoolCocoa.mm:

(WebKit::WebProcessPool::registerNotificationObservers):
(WebKit::WebProcessPool::unregisterNotificationObservers):

• Source/WebKit/UIProcess/GPU/GPUProcessProxy.cpp:

(WebKit::GPUProcessProxy::didFinishLaunching):

• Source/WebKit/UIProcess/GPU/GPUProcessProxy.h:
• Source/WebKit/UIProcess/WebProcessPool.h:
• WebKit.xcworkspace/xcshareddata/xcschemes/All Source.xcscheme:

Canonical link: ​https://commits.webkit.org/251534@main

Location:

trunk/Source

Files:

• WTF/wtf/PlatformHave.h (modified) (1 diff)
• WebCore/PAL/PAL.xcodeproj/project.pbxproj (modified) (4 diffs)
• WebCore/PAL/pal/spi/mac/PowerLogSPI.h (copied) (copied from trunk/Source/WebKit/UIProcess/Cocoa/GPUProcessProxyCocoa.mm) (2 diffs)
• WebKit/Configurations/WebKit.xcconfig (modified) (1 diff)
• WebKit/GPUProcess/GPUProcess.h (modified) (1 diff)
• WebKit/GPUProcess/GPUProcess.messages.in (modified) (1 diff)
• WebKit/GPUProcess/mac/GPUProcessMac.mm (modified) (1 diff)
• WebKit/GPUProcess/mac/com.apple.WebKit.GPUProcess.sb.in (modified) (1 diff)
• WebKit/UIProcess/Cocoa/GPUProcessProxyCocoa.mm (modified) (2 diffs)
• WebKit/UIProcess/Cocoa/WebProcessPoolCocoa.mm (modified) (3 diffs)
• WebKit/UIProcess/GPU/GPUProcessProxy.cpp (modified) (2 diffs)
• WebKit/UIProcess/GPU/GPUProcessProxy.h (modified) (1 diff)
• WebKit/UIProcess/WebProcessPool.h (modified) (1 diff)

trunk/Source/WTF/wtf/PlatformHave.h

@@ -1257 +1257 @@
 #define HAVE_APPLE_PUSH_SERVICE_URL_TOKEN_SUPPORT 1
 #endif
+
+#if (PLATFORM(MAC) && __MAC_OS_X_VERSION_MIN_REQUIRED >= 130000)
+#define HAVE_POWERLOG_TASK_MODE_QUERY 1
+#endif

trunk/Source/WebCore/PAL/PAL.xcodeproj/project.pbxproj

@@ -438 +438 @@
                 DD20DE6527BC90F90093D175 /* config.h in Headers */ = {isa = PBXBuildFile; fileRef = 1C09D0571E31C57E00725F18 /* config.h */; };
                 DDB04F32278E4F1B008D3678 /* libWebKitAdditions.a in Product Dependencies */ = {isa = PBXBuildFile; fileRef = DDE99300278D07B800F60D26 /* libWebKitAdditions.a */; };
+                E34F26F62846D0D90076E549 /* PowerLogSPI.h in Headers */ = {isa = PBXBuildFile; fileRef = E34F26F52846B7550076E549 /* PowerLogSPI.h */; settings = {ATTRIBUTES = (Private, ); }; };
                 F44291641FA52670002CC93E /* FileSizeFormatter.cpp in Sources */ = {isa = PBXBuildFile; fileRef = F44291621FA52670002CC93E /* FileSizeFormatter.cpp */; };
                 F44291681FA52705002CC93E /* FileSizeFormatterCocoa.mm in Sources */ = {isa = PBXBuildFile; fileRef = F44291661FA52705002CC93E /* FileSizeFormatterCocoa.mm */; };
@@ -949 +950 @@
                 DF83E208263734F1000825EF /* CryptoKitPrivateSPI.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = CryptoKitPrivateSPI.h; sourceTree = "<group>"; };
                 E327C0DE260BDC90002281C5 /* NotifySPI.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = NotifySPI.h; sourceTree = "<group>"; };
+                E34F26F52846B7550076E549 /* PowerLogSPI.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = PowerLogSPI.h; sourceTree = "<group>"; };
                 E5D45D112106A07400D2B738 /* NSColorWellSPI.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = NSColorWellSPI.h; sourceTree = "<group>"; };
                 E5D45D132106A18700D2B738 /* NSPopoverColorWellSPI.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = NSPopoverColorWellSPI.h; sourceTree = "<group>"; };
@@ -1164 +1166 @@
                                 71B1141F26823ACD004D6701 /* SystemPreviewSPI.h */,
                                 0C7785881F45130F00F4EBB6 /* TelephonyUtilitiesSPI.h */,
+                                E34F26F52846B7550076E549 /* PowerLogSPI.h */,
                         );
                         path = mac;
@@ -1801 +1804 @@
                                 DD20DE3F27BC90D80093D175 /* QuickLookMacSPI.h in Headers */,
                                 DD20DDC127BC90D70093D175 /* QuickLookSoftLink.h in Headers */,
+                                E34F26F62846D0D90076E549 /* PowerLogSPI.h in Headers */,
                                 DD20DE1827BC90D80093D175 /* QuickLookSPI.h in Headers */,
                                 DD20DDC727BC90D70093D175 /* QuickLookUISoftLink.h in Headers */,

trunk/Source/WebCore/PAL/pal/spi/mac/PowerLogSPI.h

@@ -1 +1 @@
 /*
- * Copyright (C) 2021 Apple Inc. All rights reserved.
+ * Copyright (C) 2022 Apple Inc. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -24 +24 @@
  */
 
-#include "config.h"
-#include "GPUProcessProxy.h"
+#pragma once
 
-#if ENABLE(GPU_PROCESS)
+#if USE(APPLE_INTERNAL_SDK)
 
-#include "GPUProcessCreationParameters.h"
-#include "MediaPermissionUtilities.h"
+#include <PowerLog/PLClientLogging.h>
+#include <PowerLog/PLXPCClientHeader.h>
 
-namespace WebKit {
+#else // USE(APPLE_INTERNAL_SDK)
 
-void GPUProcessProxy::platformInitializeGPUProcessParameters(GPUProcessCreationParameters& parameters)
+typedef CF_ENUM(short, PLClientID)
 {
-    parameters.mobileGestaltExtensionHandle = createMobileGestaltSandboxExtensionIfNeeded();
-    parameters.applicationVisibleName = applicationVisibleName();
-}
+    PLClientIDWebKit = 132
+};
 
-}
+WTF_EXTERN_C_BEGIN
+
+CFDictionaryRef PLQueryRegistered(PLClientID, CFStringRef queryName, CFDictionaryRef parameters);
+
+WTF_EXTERN_C_END
 
 #endif
+
+extern NSString *const kPLTaskingStartNotification;

trunk/Source/WebKit/Configurations/WebKit.xcconfig

@@ -174 +174 @@
 WK_INSTALL_COORDINATION_LDFLAGS_iphonesimulator = $(WK_INSTALL_COORDINATION_LDFLAGS_iphoneos)
 
-FRAMEWORK_AND_LIBRARY_LDFLAGS = -lobjc -framework CFNetwork -framework CoreAudio -framework CoreFoundation -framework CoreGraphics -framework CoreText -framework Foundation -framework ImageIO -framework IOKit -framework IOSurface -framework WebKitLegacy -lnetwork -framework Metal $(WK_ACCESSIBILITY_LDFLAGS) $(WK_APPKIT_LDFLAGS) $(WK_APPLE_PUSH_SERVICE_LDFLAGS) $(WK_BACKBOARD_SERVICES_LDFLAGS) $(WK_RUNNINGBOARD_SERVICES_LDFLAGS) $(WK_AUTHKIT_LDFLAGS) $(WK_CARBON_LDFLAGS) $(WK_CONTACTS_LDFLAGS) $(WK_CORE_PREDICTION_LDFLAGS) $(WK_CORE_SERVICES_LDFLAGS) $(WK_GRAPHICS_SERVICES_LDFLAGS) $(WK_LIBNETWORKEXTENSION_LDFLAGS) $(WK_LIBSANDBOX_LDFLAGS) $(WK_LIBWEBRTC_LDFLAGS) $(WK_MOBILE_CORE_SERVICES_LDFLAGS) $(WK_MOBILE_GESTALT_LDFLAGS) $(WK_PDFKIT_LDFLAGS) $(WK_PROTOTYPE_TOOLS_LDFLAGS) $(WK_SAFE_BROWSING_LDFLAGS) $(WK_SECURITY_INTERFACE_LDFLAGS) $(WK_UIKIT_LDFLAGS) $(WK_UNIFORM_TYPE_IDENTIFIERS_LDFLAGS) $(WK_URL_FORMATTING_LDFLAGS) $(WK_WEBINSPECTORUI_LDFLAGS) $(WK_COORDINATOR_LDFLAGS) $(WK_INSTALL_COORDINATION_LDFLAGS) $(WK_APP_STORE_DAEMON_LDFLAGS);
+WK_POWERLOG_LDFLAGS = $(WK_POWERLOG_LDFLAGS_$(WK_PLATFORM_NAME));
+WK_POWERLOG_LDFLAGS_macosx = -weak_framework PowerLog -weak_framework PowerlogCore;
+
+FRAMEWORK_AND_LIBRARY_LDFLAGS = -lobjc -framework CFNetwork -framework CoreAudio -framework CoreFoundation -framework CoreGraphics -framework CoreText -framework Foundation -framework ImageIO -framework IOKit -framework IOSurface -framework WebKitLegacy -lnetwork -framework Metal $(WK_ACCESSIBILITY_LDFLAGS) $(WK_APPKIT_LDFLAGS) $(WK_APPLE_PUSH_SERVICE_LDFLAGS) $(WK_BACKBOARD_SERVICES_LDFLAGS) $(WK_RUNNINGBOARD_SERVICES_LDFLAGS) $(WK_AUTHKIT_LDFLAGS) $(WK_CARBON_LDFLAGS) $(WK_CONTACTS_LDFLAGS) $(WK_CORE_PREDICTION_LDFLAGS) $(WK_CORE_SERVICES_LDFLAGS) $(WK_GRAPHICS_SERVICES_LDFLAGS) $(WK_LIBNETWORKEXTENSION_LDFLAGS) $(WK_LIBSANDBOX_LDFLAGS) $(WK_LIBWEBRTC_LDFLAGS) $(WK_MOBILE_CORE_SERVICES_LDFLAGS) $(WK_MOBILE_GESTALT_LDFLAGS) $(WK_PDFKIT_LDFLAGS) $(WK_PROTOTYPE_TOOLS_LDFLAGS) $(WK_SAFE_BROWSING_LDFLAGS) $(WK_SECURITY_INTERFACE_LDFLAGS) $(WK_UIKIT_LDFLAGS) $(WK_UNIFORM_TYPE_IDENTIFIERS_LDFLAGS) $(WK_URL_FORMATTING_LDFLAGS) $(WK_WEBINSPECTORUI_LDFLAGS) $(WK_COORDINATOR_LDFLAGS) $(WK_INSTALL_COORDINATION_LDFLAGS) $(WK_APP_STORE_DAEMON_LDFLAGS) $(WK_POWERLOG_LDFLAGS);
 
 // Prevent C++ standard library basic_stringstream, operator new, delete and their related exception types from being exported as weak symbols.

trunk/Source/WebKit/GPUProcess/GPUProcess.h

@@ -202 +202 @@
 #endif
 
+#if HAVE(POWERLOG_TASK_MODE_QUERY)
+    void enablePowerLogging(SandboxExtension::Handle&&);
+#endif
+
     // Connections to WebProcesses.
     HashMap<WebCore::ProcessIdentifier, Ref<GPUConnectionToWebProcess>> m_webProcessConnections;

trunk/Source/WebKit/GPUProcess/GPUProcess.messages.in

@@ -92 +92 @@
 #endif
 
+#if HAVE(POWERLOG_TASK_MODE_QUERY)
+    EnablePowerLogging(WebKit::SandboxExtension::Handle handle)
+#endif
+
     WebProcessConnectionCountForTesting() -> (uint64_t count)
 }

trunk/Source/WebKit/GPUProcess/mac/GPUProcessMac.mm

@@ -106 +106 @@
 #endif
 
+#if HAVE(POWERLOG_TASK_MODE_QUERY)
+void GPUProcess::enablePowerLogging(SandboxExtension::Handle&& handle)
+{
+    SandboxExtension::consumePermanently(WTFMove(handle));
+}
+#endif // HAVE(POWERLOG_TASK_MODE_QUERY)
+
 } // namespace WebKit
 

trunk/Source/WebKit/GPUProcess/mac/com.apple.WebKit.GPUProcess.sb.in

@@ -653 +653 @@
 
 (allow mach-lookup
-    (global-name "com.apple.powerlog.plxpclogger.xpc"))
+    (require-all
+        (extension "com.apple.webkit.extension.mach")
+        (global-name "com.apple.powerlog.plxpclogger.xpc")))
 
 (with-filter (uid 0)

trunk/Source/WebKit/UIProcess/Cocoa/GPUProcessProxyCocoa.mm

@@ -30 +30 @@
 
 #include "GPUProcessCreationParameters.h"
+#include "GPUProcessMessages.h"
 #include "MediaPermissionUtilities.h"
+
+#if HAVE(POWERLOG_TASK_MODE_QUERY)
+#include <pal/spi/mac/PowerLogSPI.h>
+#endif
 
 namespace WebKit {
@@ -40 +45 @@
 }
 
+#if HAVE(POWERLOG_TASK_MODE_QUERY)
+bool GPUProcessProxy::isPowerLoggingInTaskMode()
+{
+    PLClientID clientIDWebKit = static_cast<PLClientID>(132); // FIXME: Replace with PLClientIDWebKit when available in SDK
+    auto dictionary = adoptCF(PLQueryRegistered(clientIDWebKit, CFSTR("TaskModeQuery"), nullptr));
+    if (!dictionary)
+        return false;
+    CFNumberRef taskModeRef = static_cast<CFNumberRef>(CFDictionaryGetValue(dictionary.get(), CFSTR("Task Mode")));
+    if (!taskModeRef)
+        return false;
+    int taskMode = 0;
+    if (!CFNumberGetValue(taskModeRef, kCFNumberIntType, &taskMode))
+        return false;
+    return !!taskMode;
+}
+
+void GPUProcessProxy::enablePowerLogging()
+{
+    auto handle = SandboxExtension::createHandleForMachLookup("com.apple.powerlog.plxpclogger.xpc"_s, std::nullopt);
+    if (!handle)
+        return;
+    send(Messages::GPUProcess::EnablePowerLogging(*handle), 0);
+}
+#endif // HAVE(POWERLOG_TASK_MODE_QUERY)
+
 }
 

trunk/Source/WebKit/UIProcess/Cocoa/WebProcessPoolCocoa.mm

@@ -96 +96 @@
 #endif
 
+#if HAVE(POWERLOG_TASK_MODE_QUERY)
+#import <pal/spi/mac/PowerLogSPI.h>
+#endif
+
 #if PLATFORM(IOS_FAMILY)
 #import <pal/spi/ios/MobileGestaltSPI.h>
@@ -704 +708 @@
     addCFNotificationObserver(mediaAccessibilityPreferencesChangedCallback, kMAXCaptionAppearanceSettingsChangedNotification);
 #endif
+#if HAVE(POWERLOG_TASK_MODE_QUERY) && ENABLE(GPU_PROCESS)
+    m_powerLogObserver = [[NSNotificationCenter defaultCenter] addObserverForName:kPLTaskingStartNotification object:nil queue:[NSOperationQueue mainQueue] usingBlock:^(NSNotification *notification) {
+        if (auto* gpuProcess = GPUProcessProxy::singletonIfCreated())
+            gpuProcess->enablePowerLogging();
+    }];
+#endif // HAVE(POWERLOG_TASK_MODE_QUERY) && ENABLE(GPU_PROCESS)
 }
 
@@ -754 +764 @@
     removeCFNotificationObserver(kMAXCaptionAppearanceSettingsChangedNotification);
 #endif
-
+#if HAVE(POWERLOG_TASK_MODE_QUERY) && ENABLE(GPU_PROCESS)
+    [[NSNotificationCenter defaultCenter] removeObserver:m_powerLogObserver.get()];
+#endif
     m_weakObserver = nil;
 }

trunk/Source/WebKit/UIProcess/GPU/GPUProcessProxy.cpp

@@ -63 +63 @@
 #endif
 
+#if PLATFORM(COCOA)
+#include <wtf/BlockPtr.h>
+#endif
+
 #define MESSAGE_CHECK(assertion) MESSAGE_CHECK_BASE(assertion, this->connection())
 
@@ -471 +475 @@
     for (auto& processPool : WebProcessPool::allProcessPools())
         processPool->gpuProcessDidFinishLaunching(processIdentifier());
+
+#if HAVE(POWERLOG_TASK_MODE_QUERY)
+    dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), makeBlockPtr([weakThis = WeakPtr { *this }] () mutable {
+        if (!isPowerLoggingInTaskMode())
+            return;
+        RunLoop::main().dispatch([weakThis = WTFMove(weakThis)] () {
+            if (!weakThis)
+                return;
+            weakThis->enablePowerLogging();
+        });
+    }).get());
+#endif
 }
 

trunk/Source/WebKit/UIProcess/GPU/GPUProcessProxy.h

@@ -103 +103 @@
 #endif
 
+#if HAVE(POWERLOG_TASK_MODE_QUERY)
+    void enablePowerLogging();
+    static bool isPowerLoggingInTaskMode();
+#endif
+
     void updatePreferences(WebProcessProxy&);
     void updateScreenPropertiesIfNeeded();

trunk/Source/WebKit/UIProcess/WebProcessPool.h

@@ -690 +690 @@
 #endif
 
+#if HAVE(POWERLOG_TASK_MODE_QUERY) && ENABLE(GPU_PROCESS)
+    RetainPtr<NSObject> m_powerLogObserver;
+#endif
+
 #if PLATFORM(COCOA)
     std::unique_ptr<WebCore::PowerSourceNotifier> m_powerSourceNotifier;