Add a shared memory variant of CefProcessMessage (fixes issue #3126)

CefSharedProcessMessageBuilder supports creation of a CefProcessMessage backed by a CefSharedMemoryRegion. Performance tests comparing the existing ArgumentList approach and the new SharedMemoryRegion approach have been added to cefclient at http://tests/ipc_performance. CefMessageRouter has been updated to use SharedMemoryRegion as transport for larger message payloads. The threshold is configurable via |CefMessageRouterConfig.message_size_threshold|. To test: run `ceftests --gtest_filter=SendSharedProcessMessageTest.*:SharedProcessMessageTest.*:MessageRouterTest.Threshold*`
2025-06-05 21:39:12 +02:00 · 2022-07-04 09:49:15 +00:00
parent a931d49f3e
commit 81e892d19e
55 changed files with 4025 additions and 1132 deletions
--- a/tests/ceftests/send_shared_process_message_unittest.cc
+++ b/tests/ceftests/send_shared_process_message_unittest.cc
@@ -0,0 +1,172 @@
+// Copyright (c) 2022 The Chromium Embedded Framework Authors. All rights
+// reserved. Use of this source code is governed by a BSD-style license that
+// can be found in the LICENSE file.
+
+#include "include/base/cef_callback.h"
+#include "include/cef_shared_process_message_builder.h"
+#include "include/cef_task.h"
+#include "include/wrapper/cef_closure_task.h"
+#include "tests/ceftests/test_handler.h"
+#include "tests/gtest/include/gtest/gtest.h"
+#include "tests/shared/renderer/client_app_renderer.h"
+
+#include <array>
+
+using client::ClientAppRenderer;
+
+namespace {
+
+struct TestData {
+  bool flag = true;
+  int value = 1;
+  double d_value = 77.77;
+  std::array<size_t, 50> buffer{};
+};
+
+const char kSharedMessageUrl[] = "http://tests/SendSharedProcessMessageTest";
+const char kSharedMessageName[] = "SendSharedProcessMessageTest";
+
+CefRefPtr<CefProcessMessage> CreateTestMessage(const TestData& data) {
+  auto builder = CefSharedProcessMessageBuilder::Create(kSharedMessageName, sizeof(data));
+  std::memcpy(builder->Memory(), reinterpret_cast<const void*>(&data), sizeof(data));
+  return builder->Build();
+}
+
+// Renderer side.
+class SharedMessageRendererTest final : public ClientAppRenderer::Delegate {
+ public:
+  bool OnProcessMessageReceived(CefRefPtr<ClientAppRenderer> app,
+                                CefRefPtr<CefBrowser> browser,
+                                CefRefPtr<CefFrame> frame,
+                                CefProcessId source_process,
+                                CefRefPtr<CefProcessMessage> message) override {
+    if (message->GetName() == kSharedMessageName) {
+      EXPECT_TRUE(browser.get());
+      EXPECT_TRUE(frame.get());
+      EXPECT_EQ(PID_BROWSER, source_process);
+      EXPECT_TRUE(message.get());
+      EXPECT_TRUE(message->IsValid());
+      EXPECT_TRUE(message->IsReadOnly());
+      EXPECT_EQ(message->GetArgumentList(), nullptr);
+
+      const std::string& url = frame->GetURL();
+      if (url == kSharedMessageUrl) {
+        // Echo the message back to the sender natively.
+        frame->SendProcessMessage(PID_BROWSER, message);
+        EXPECT_FALSE(message->IsValid());
+        return true;
+      }
+    }
+
+    return false;
+  }
+
+  IMPLEMENT_REFCOUNTING(SharedMessageRendererTest);
+};
+
+// Browser side.
+class SharedMessageTestHandler final : public TestHandler {
+ public:
+  explicit SharedMessageTestHandler(cef_thread_id_t send_thread)
+      : send_thread_(send_thread) {}
+
+  void RunTest() override {
+    AddResource(kSharedMessageUrl, "<html><body>TEST</body></html>",
+                "text/html");
+    CreateBrowser(kSharedMessageUrl);
+
+    // Time out the test after a reasonable period of time.
+    SetTestTimeout();
+  }
+
+  void OnLoadEnd(CefRefPtr<CefBrowser> browser,
+                 CefRefPtr<CefFrame> frame,
+                 int httpStatusCode) override {
+    EXPECT_TRUE(CefCurrentlyOn(TID_UI));
+
+    // Send the message to the renderer process.
+    if (!CefCurrentlyOn(send_thread_)) {
+      CefPostTask(send_thread_,
+                  base::BindOnce(&SharedMessageTestHandler::SendProcessMessage,
+                                 this, browser, frame));
+    } else {
+      SendProcessMessage(browser, frame);
+    }
+  }
+
+  bool OnProcessMessageReceived(CefRefPtr<CefBrowser> browser,
+                                CefRefPtr<CefFrame> frame,
+                                CefProcessId source_process,
+                                CefRefPtr<CefProcessMessage> message) override {
+    EXPECT_TRUE(CefCurrentlyOn(TID_UI));
+    EXPECT_TRUE(browser.get());
+    EXPECT_TRUE(frame.get());
+    EXPECT_EQ(PID_RENDERER, source_process);
+    EXPECT_TRUE(message.get());
+    EXPECT_TRUE(message->IsValid());
+    EXPECT_TRUE(message->IsReadOnly());
+    EXPECT_EQ(message->GetArgumentList(), nullptr);
+
+    // Verify that the recieved message is the same as the sent message.
+    auto region = message->GetSharedMemoryRegion();
+    const TestData* received = static_cast<const TestData*>(region->Memory());
+    EXPECT_EQ(data_.flag, received->flag);
+    EXPECT_EQ(data_.value, received->value);
+    EXPECT_EQ(data_.d_value, received->d_value);
+
+    got_message_.yes();
+
+    // Test is complete.
+    DestroyTest();
+
+    return true;
+  }
+
+ protected:
+  void DestroyTest() override {
+    EXPECT_TRUE(got_message_);
+    TestHandler::DestroyTest();
+  }
+
+ private:
+  void SendProcessMessage(const CefRefPtr<CefBrowser>& browser,
+                          const CefRefPtr<CefFrame>& frame) {
+    EXPECT_TRUE(CefCurrentlyOn(send_thread_));
+
+    auto message = CreateTestMessage(data_);
+    frame->SendProcessMessage(PID_RENDERER, message);
+
+    // The message is invalidated immediately
+    EXPECT_FALSE(message->IsValid());
+  }
+
+  cef_thread_id_t send_thread_;
+  TrackCallback got_message_;
+  const TestData data_;
+
+  IMPLEMENT_REFCOUNTING(SharedMessageTestHandler);
+};
+
+}  // namespace
+
+TEST(SendSharedProcessMessageTest, CanSendAndReceiveFromUiThread) {
+  CefRefPtr<SharedMessageTestHandler> handler =
+      new SharedMessageTestHandler(TID_UI);
+  handler->ExecuteTest();
+  ReleaseAndWaitForDestructor(handler);
+}
+
+TEST(SendSharedProcessMessageTest, CanSendAndReceiveFromIoThread) {
+  CefRefPtr<SharedMessageTestHandler> handler =
+      new SharedMessageTestHandler(TID_IO);
+  handler->ExecuteTest();
+  ReleaseAndWaitForDestructor(handler);
+}
+
+
+// Entry point for creating shared process message renderer test objects.
+// Called from client_app_delegates.cc.
+void CreateSharedProcessMessageTests(
+    ClientAppRenderer::DelegateSet& delegates) {
+  delegates.insert(new SharedMessageRendererTest());
+}