[fuchsia] implement SKP based shader warmup

Make Engine load all .skp files from persistent cache and draw them on
an offscreen surface to warm up shaders.

Author: freiling

fml/concurrent_message_loop.h

@@ -12,6 +12,7 @@
 
 #include "flutter/fml/closure.h"
 #include "flutter/fml/macros.h"
+#include "flutter/fml/task_runner.h"
 
 namespace fml {
 
@@ -58,13 +59,13 @@ class ConcurrentMessageLoop
   FML_DISALLOW_COPY_AND_ASSIGN(ConcurrentMessageLoop);
 };
 
-class ConcurrentTaskRunner {
+class ConcurrentTaskRunner : public BasicTaskRunner {
  public:
   ConcurrentTaskRunner(std::weak_ptr<ConcurrentMessageLoop> weak_loop);
 
-  ~ConcurrentTaskRunner();
+  virtual ~ConcurrentTaskRunner();
 
-  void PostTask(const fml::closure& task);
+  void PostTask(const fml::closure& task) override;
 
  private:
   friend ConcurrentMessageLoop;

fml/task_runner.h

@@ -16,11 +16,17 @@ namespace fml {
 
 class MessageLoopImpl;
 
-class TaskRunner : public fml::RefCountedThreadSafe<TaskRunner> {
+class BasicTaskRunner {
+ public:
+  virtual void PostTask(const fml::closure& task);
+};
+
+class TaskRunner : public fml::RefCountedThreadSafe<TaskRunner>,
+                   public BasicTaskRunner {
  public:
   virtual ~TaskRunner();
 
-  virtual void PostTask(const fml::closure& task);
+  virtual void PostTask(const fml::closure& task) override;
 
   virtual void PostTaskForTime(const fml::closure& task,
                                fml::TimePoint target_time);

shell/platform/fuchsia/flutter/BUILD.gn

@@ -449,6 +449,7 @@ executable("flutter_runner_unittests") {
     "runner_unittest.cc",
     "tests/flutter_runner_product_configuration_unittests.cc",
     "tests/vsync_recorder_unittests.cc",
+    "tests/engine_unittests.cc",
     "vsync_waiter_unittests.cc",
   ]
 
@@ -463,6 +464,7 @@ executable("flutter_runner_unittests") {
     "//flutter/shell/common",
     "//third_party/dart/runtime:libdart_jit",
     "//third_party/dart/runtime/platform:libdart_platform_jit",
+    "//flutter/assets:assets",
   ]
 
   deps = [

shell/platform/fuchsia/flutter/compositor_context.cc

@@ -145,7 +145,13 @@ CompositorContext::CompositorContext(
     std::shared_ptr<flutter::SceneUpdateContext> scene_update_context)
     : session_connection_(session_connection),
       surface_producer_(surface_producer),
-      scene_update_context_(scene_update_context) {}
+      scene_update_context_(scene_update_context) {
+  SkISize size = SkISize::Make(1024, 600);
+  skp_warmup_surface_ = surface_producer_.ProduceOffscreenSurface(size);
+  if (!skp_warmup_surface_) {
+    FML_LOG(ERROR) << "SkSurface::MakeRenderTarget returned null";
+  }
+}
 
 CompositorContext::~CompositorContext() = default;
 
@@ -164,4 +170,9 @@ CompositorContext::AcquireFrame(
       session_connection_, surface_producer_, scene_update_context_);
 }
 
+void CompositorContext::WarmupSkp(const sk_sp<SkPicture> picture) {
+  skp_warmup_surface_->getCanvas()->drawPicture(picture);
+  surface_producer_.gr_context()->flush();
+}
+
 }  // namespace flutter_runner

shell/platform/fuchsia/flutter/compositor_context.h

@@ -27,11 +27,13 @@ class CompositorContext final : public flutter::CompositorContext {
       std::shared_ptr<flutter::SceneUpdateContext> scene_update_context);
 
   ~CompositorContext() override;
+  void WarmupSkp(sk_sp<SkPicture> picture);
 
  private:
   SessionConnection& session_connection_;
   VulkanSurfaceProducer& surface_producer_;
   std::shared_ptr<flutter::SceneUpdateContext> scene_update_context_;
+  sk_sp<SkSurface> skp_warmup_surface_;
 
   // |flutter::CompositorContext|
   std::unique_ptr<ScopedFrame> AcquireFrame(

shell/platform/fuchsia/flutter/engine.cc

@@ -14,16 +14,19 @@
 #include "flutter/fml/synchronization/waitable_event.h"
 #include "flutter/fml/task_runner.h"
 #include "flutter/runtime/dart_vm_lifecycle.h"
+#include "flutter/shell/common/persistent_cache.h"
 #include "flutter/shell/common/rasterizer.h"
 #include "flutter/shell/common/run_configuration.h"
-#include "third_party/skia/include/ports/SkFontMgr_fuchsia.h"
-
+#include "flutter/shell/common/serialization_callbacks.h"
 #include "flutter_runner_product_configuration.h"
 #include "fuchsia_external_view_embedder.h"
 #include "fuchsia_intl.h"
+#include "include/core/SkPicture.h"
+#include "include/core/SkSerialProcs.h"
 #include "platform_view.h"
 #include "surface.h"
 #include "task_runner_adapter.h"
+#include "third_party/skia/include/ports/SkFontMgr_fuchsia.h"
 #include "thread.h"
 
 #if defined(LEGACY_FUCHSIA_EMBEDDER)
@@ -248,15 +251,23 @@ Engine::Engine(Delegate& delegate,
       auto compositor_context =
           std::make_unique<flutter_runner::CompositorContext>(
               session_connection_.value(), surface_producer_.value(),
-              legacy_external_view_embedder_);
+              legacy_external_view_embedder_.value());
+
       return std::make_unique<flutter::Rasterizer>(
           shell, std::move(compositor_context));
     } else {
       return std::make_unique<flutter::Rasterizer>(shell);
     }
   };
 #else
-  on_create_rasterizer = [](flutter::Shell& shell) {
+  on_create_rasterizer = [this](flutter::Shell& shell) {
+    FML_DCHECK(surface_producer_);
+
+    WarmupSkps(
+        shell.GetDartVM()->GetConcurrentMessageLoop()->GetTaskRunner().get(),
+        shell.GetTaskRunners().GetRasterTaskRunner().get(),
+        surface_producer_.value());
+
     return std::make_unique<flutter::Rasterizer>(shell);
   };
 #endif
@@ -623,4 +634,50 @@ void Engine::WriteProfileToTrace() const {
 }
 #endif  // !defined(DART_PRODUCT)
 
+void Engine::WarmupSkps(fml::BasicTaskRunner* concurrent_task_runner,
+                        fml::BasicTaskRunner* raster_task_runner,
+                        VulkanSurfaceProducer& surface_producer) {
+  SkISize size = SkISize::Make(1024, 600);
+  auto skp_warmup_surface = surface_producer.ProduceOffscreenSurface(size);
+  if (!skp_warmup_surface) {
+    FML_LOG(ERROR) << "SkSurface::MakeRenderTarget returned null";
+    return;
+  }
+
+  // tell concurrent task runner to deserialize all skps available from
+  // the asset manager
+  concurrent_task_runner->PostTask([&raster_task_runner, skp_warmup_surface,
+                                    &surface_producer]() {
+    TRACE_DURATION("flutter", "DeserializeSkps");
+    std::vector<std::unique_ptr<fml::Mapping>> skp_mappings =
+        flutter::PersistentCache::GetCacheForProcess()
+            ->GetSkpsFromAssetManager();
+    std::vector<sk_sp<SkPicture>> pictures;
+    int i = 0;
+    for (auto& mapping : skp_mappings) {
+      std::unique_ptr<SkMemoryStream> stream =
+          SkMemoryStream::MakeDirect(mapping->GetMapping(), mapping->GetSize());
+      SkDeserialProcs procs = {0};
+      procs.fImageProc = flutter::DeserializeImageWithoutData;
+      procs.fTypefaceProc = flutter::DeserializeTypefaceWithoutData;
+      sk_sp<SkPicture> picture =
+          SkPicture::MakeFromStream(stream.get(), &procs);
+      if (!picture) {
+        FML_LOG(ERROR) << "Failed to deserialize picture " << i;
+        continue;
+      }
+
+      // Tell raster task runner to warmup have the compositor
+      // context warm up the newly deserialized picture
+      raster_task_runner->PostTask(
+          [skp_warmup_surface, picture, &surface_producer] {
+            TRACE_DURATION("flutter", "WarmupSkp");
+            skp_warmup_surface->getCanvas()->drawPicture(picture);
+            surface_producer.gr_context()->flush();
+          });
+      i++;
+    }
+  });
+}
+
 }  // namespace flutter_runner

shell/platform/fuchsia/flutter/engine.h

@@ -34,6 +34,10 @@
 
 namespace flutter_runner {
 
+namespace testing {
+class EngineTest;
+}
+
 // Represents an instance of running Flutter engine along with the threads
 // that host the same.
 class Engine final {
@@ -90,6 +94,10 @@ class Engine final {
 
   fml::WeakPtrFactory<Engine> weak_factory_;
 
+  static void WarmupSkps(fml::BasicTaskRunner* concurrent_task_runner,
+                         fml::BasicTaskRunner* raster_task_runner,
+                         VulkanSurfaceProducer& surface_producer);
+
   void OnMainIsolateStart();
 
   void OnMainIsolateShutdown();
@@ -104,6 +112,8 @@ class Engine final {
 
   std::unique_ptr<flutter::Surface> CreateSurface();
 
+  friend class testing::EngineTest;
+
   FML_DISALLOW_COPY_AND_ASSIGN(Engine);
 };
 

shell/platform/fuchsia/flutter/meta/flutter_runner_tests.cmx

@@ -8,12 +8,17 @@
   "sandbox": {
     "features": [
       "deprecated-ambient-replace-as-executable",
-      "vulkan"
+      "vulkan",
+      "isolated-cache-storage",
+      "isolated-temp"
     ],
     "services": [
       "fuchsia.accessibility.semantics.SemanticsManager",
       "fuchsia.intl.PropertyProvider",
-      "fuchsia.process.Launcher"
+      "fuchsia.process.Launcher",
+      "fuchsia.vulkan.loader.Loader",
+      "fuchsia.logger.LogSink",
+      "fuchsia.sysmem.Allocator"
     ]
   }
 }

shell/platform/fuchsia/flutter/tests/engine_unittests.cc

@@ -0,0 +1,109 @@
+// Copyright 2020 The Flutter 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 <fuchsia/scenic/scheduling/cpp/fidl.h>
+#include <fuchsia/ui/policy/cpp/fidl.h>
+#include <fuchsia/ui/scenic/cpp/fidl.h>
+#include <lib/async-loop/default.h>
+#include <lib/sys/cpp/component_context.h>
+
+#include "assets/directory_asset_bundle.h"
+#include "flutter/fml/memory/ref_ptr.h"
+#include "flutter/fml/message_loop_impl.h"
+#include "flutter/fml/task_runner.h"
+#include "flutter/shell/common/persistent_cache.h"
+#include "flutter/shell/common/serialization_callbacks.h"
+#include "flutter/shell/platform/fuchsia/flutter/logging.h"
+#include "flutter/shell/platform/fuchsia/flutter/runner.h"
+#include "flutter/shell/platform/fuchsia/flutter/session_connection.h"
+#include "gtest/gtest.h"
+#include "include/core/SkPicture.h"
+#include "include/core/SkPictureRecorder.h"
+#include "include/core/SkSerialProcs.h"
+
+using namespace flutter_runner;
+using namespace flutter;
+
+namespace flutter_runner {
+namespace testing {
+
+class MockTaskRunner : public fml::BasicTaskRunner {
+ public:
+  MockTaskRunner() {}
+  virtual ~MockTaskRunner() {}
+
+  void PostTask(const fml::closure& task) override {
+    task_count_++;
+    task();
+  }
+
+  int GetTaskCount() { return task_count_; }
+
+ private:
+  int task_count_ = 0;
+};
+
+class EngineTest : public ::testing::Test {
+ public:
+  void WarmupSkps() {
+    // Have to create a message loop so default async dispatcher gets set,
+    // otherwise we segfault creating the VulkanSurfaceProducer
+    auto loop = fml::MessageLoopImpl::Create();
+
+    fuchsia::ui::scenic::SessionPtr session_ptr;
+    scenic::Session session(std::move(session_ptr));
+    VulkanSurfaceProducer surface_producer(&session);
+
+    Engine::WarmupSkps(&concurrent_task_runner_, &raster_task_runner_,
+                       surface_producer);
+  }
+
+ protected:
+  MockTaskRunner concurrent_task_runner_;
+  MockTaskRunner raster_task_runner_;
+};
+
+TEST_F(EngineTest, SkpWarmup) {
+  SkISize draw_size = SkISize::Make(100, 100);
+  SkPictureRecorder recorder;
+  auto canvas = recorder.beginRecording(draw_size.width(), draw_size.height());
+
+  // adapted from https://fiddle.skia.org/c/@Canvas_drawLine
+  SkPaint paint;
+  paint.setColor(0xFF9a67be);
+  paint.setStrokeWidth(20);
+  canvas->drawLine(0, 0, draw_size.width(), draw_size.height(), paint);
+  canvas->drawLine(0, draw_size.height(), draw_size.width(), 0, paint);
+
+  sk_sp<SkPicture> picture = recorder.finishRecordingAsPicture();
+  SkSerialProcs procs = {0};
+  procs.fImageProc = SerializeImageWithoutData;
+  procs.fTypefaceProc = SerializeTypefaceWithoutData;
+  sk_sp<SkData> data = picture->serialize(&procs);
+  ASSERT_TRUE(data);
+  ASSERT_GT(data->size(), 0u);
+
+  fml::NonOwnedMapping mapping(data->bytes(), data->size());
+
+  fml::ScopedTemporaryDirectory asset_dir;
+  fml::UniqueFD asset_dir_fd = fml::OpenDirectory(
+      asset_dir.path().c_str(), false, fml::FilePermission::kRead);
+
+  bool success = fml::WriteAtomically(asset_dir_fd, "test.skp", mapping);
+  ASSERT_TRUE(success);
+
+  auto asset_manager = std::make_shared<AssetManager>();
+  asset_manager->PushBack(
+      std::make_unique<DirectoryAssetBundle>(std::move(asset_dir_fd), false));
+
+  PersistentCache::GetCacheForProcess()->SetAssetManager(asset_manager);
+
+  WarmupSkps();
+
+  EXPECT_EQ(concurrent_task_runner_.GetTaskCount(), 1);
+  EXPECT_EQ(raster_task_runner_.GetTaskCount(), 1);
+}
+
+}  // namespace testing
+}  // namespace flutter_runner

shell/platform/fuchsia/flutter/vulkan_surface_pool.h

@@ -26,6 +26,7 @@ class VulkanSurfacePool final {
 
   ~VulkanSurfacePool();
 
+  std::unique_ptr<VulkanSurface> CreateSurface(const SkISize& size);
   std::unique_ptr<VulkanSurface> AcquireSurface(const SkISize& size);
 
   void SubmitSurface(std::unique_ptr<SurfaceProducerSurface> surface);
@@ -49,8 +50,6 @@ class VulkanSurfacePool final {
 
   std::unique_ptr<VulkanSurface> GetCachedOrCreateSurface(const SkISize& size);
 
-  std::unique_ptr<VulkanSurface> CreateSurface(const SkISize& size);
-
   void RecycleSurface(std::unique_ptr<VulkanSurface> surface);
 
   void RecyclePendingSurface(uintptr_t surface_key);