cc/raster/zero_copy_raster_buffer_provider.cc - chromium/src - Git at Google

 // Copyright 2013 The Chromium Authors
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.

 #include "cc/raster/zero_copy_raster_buffer_provider.h"

 #include <stdint.h>

 #include <algorithm>
 #include <utility>

 #include "base/memory/raw_ptr.h"
 #include "base/trace_event/process_memory_dump.h"
 #include "base/trace_event/trace_event.h"
 #include "base/trace_event/traced_value.h"
 #include "cc/resources/resource_pool.h"
 #include "components/viz/client/client_resource_provider.h"
 #include "components/viz/common/gpu/raster_context_provider.h"
 #include "components/viz/common/resources/platform_color.h"
 #include "components/viz/common/resources/shared_image_format_utils.h"
 #include "gpu/command_buffer/client/client_shared_image.h"
 #include "gpu/command_buffer/client/shared_image_interface.h"
 #include "gpu/command_buffer/common/shared_image_trace_utils.h"
 #include "gpu/command_buffer/common/shared_image_usage.h"
 #include "ui/gfx/buffer_format_util.h"

 namespace cc {
 namespace {

 constexpr static auto kBufferUsage = gfx::BufferUsage::GPU_READ_CPU_READ_WRITE;

 // Subclass for InUsePoolResource that holds ownership of a zero-copy backing
 // and does cleanup of the backing when destroyed.
 class ZeroCopyGpuBacking : public ResourcePool::GpuBacking {
  public:
   ~ZeroCopyGpuBacking() override {
     if (!shared_image) {
       return;
     }
     if (returned_sync_token.HasData())
       shared_image_interface->DestroySharedImage(returned_sync_token,
                                                  std::move(shared_image));
     else if (mailbox_sync_token.HasData())
       shared_image_interface->DestroySharedImage(mailbox_sync_token,
                                                  std::move(shared_image));
   }

   void OnMemoryDump(
       base::trace_event::ProcessMemoryDump* pmd,
       const base::trace_event::MemoryAllocatorDumpGuid& buffer_dump_guid,
       uint64_t tracing_process_id,
       int importance) const override {
     if (!shared_image) {
       return;
     }
     auto mapping = shared_image->Map();
     if (!mapping) {
       return;
     }
     mapping->OnMemoryDump(pmd, buffer_dump_guid, tracing_process_id,
                           importance);
   }

   // The SharedImageInterface used to clean up the shared image.
   raw_ptr<gpu::SharedImageInterface> shared_image_interface = nullptr;
 };

 // RasterBuffer for the zero copy upload, which is given to the raster worker
 // threads for raster/upload.
 class ZeroCopyRasterBufferImpl : public RasterBuffer {
  public:
   ZeroCopyRasterBufferImpl(
       base::WaitableEvent* shutdown_event,
       const ResourcePool::InUsePoolResource& in_use_resource,
       ZeroCopyGpuBacking* backing)
       : backing_(backing),
         shutdown_event_(shutdown_event),
         resource_size_(in_use_resource.size()),
         format_(in_use_resource.format()),
         resource_color_space_(in_use_resource.color_space()) {}
   ZeroCopyRasterBufferImpl(const ZeroCopyRasterBufferImpl&) = delete;

   ~ZeroCopyRasterBufferImpl() override {
     // If MappableSharedImage allocation failed (https://crbug.com/554541), then
     // we don't have anything to give to the display compositor, so we report a
     // zero mailbox that will result in checkerboarding.
     if (!backing_->shared_image) {
       return;
     }

     // This is destroyed on the compositor thread when raster is complete, but
     // before the backing is prepared for export to the display compositor. So
     // we can set up the texture and SyncToken here.
     // TODO(danakj): This could be done with the worker context in Playback. Do
     // we need to do things in IsResourceReadyToDraw() and OrderingBarrier then?
     gpu::SharedImageInterface* sii = backing_->shared_image_interface;
     sii->UpdateSharedImage(backing_->returned_sync_token,
                            backing_->shared_image->mailbox());

     backing_->mailbox_sync_token = sii->GenUnverifiedSyncToken();
   }

   ZeroCopyRasterBufferImpl& operator=(const ZeroCopyRasterBufferImpl&) = delete;

   // Overridden from RasterBuffer:
   void Playback(const RasterSource* raster_source,
                 const gfx::Rect& raster_full_rect,
                 const gfx::Rect& raster_dirty_rect,
                 uint64_t new_content_id,
                 const gfx::AxisTransform2d& transform,
                 const RasterSource::PlaybackSettings& playback_settings,
                 const GURL& url) override {
     TRACE_EVENT0("cc", "ZeroCopyRasterBuffer::Playback");

     gpu::SharedImageInterface* sii = backing_->shared_image_interface;

     // Create a MappableSI if necessary.
     if (!backing_->shared_image) {
       uint32_t usage = gpu::SHARED_IMAGE_USAGE_DISPLAY_READ |
                        gpu::SHARED_IMAGE_USAGE_SCANOUT;
       backing_->shared_image = sii->CreateSharedImage(
           format_, resource_size_, resource_color_space_,
           kTopLeft_GrSurfaceOrigin, kPremul_SkAlphaType, usage,
           "ZeroCopyRasterTile", gpu::kNullSurfaceHandle, kBufferUsage);
       if (!backing_->shared_image) {
         LOG(ERROR) << "Creation of MappableSharedImage failed.";
         return;
       }
     }

     std::unique_ptr<gpu::ClientSharedImage::ScopedMapping> mapping =
         backing_->shared_image->Map();
     if (!mapping) {
       LOG(ERROR) << "MapSharedImage Failed.";
       sii->DestroySharedImage(gpu::SyncToken(),
                               std::move(backing_->shared_image));
       return;
     }

     // TODO(danakj): Implement partial raster with raster_dirty_rect.
     RasterBufferProvider::PlaybackToMemory(
         mapping->Memory(0), format_, resource_size_, mapping->Stride(0),
         raster_source, raster_full_rect, raster_full_rect, transform,
         resource_color_space_,
         /*gpu_compositing=*/true, playback_settings);
   }

   bool SupportsBackgroundThreadPriority() const override { return true; }

  private:
   // This field may only be used on the compositor thread.
   raw_ptr<ZeroCopyGpuBacking> backing_;

   // These fields are for use on the worker thread.
   raw_ptr<base::WaitableEvent> shutdown_event_;
   gfx::Size resource_size_;
   viz::SharedImageFormat format_;
   gfx::ColorSpace resource_color_space_;
 };

 }  // namespace

 ZeroCopyRasterBufferProvider::ZeroCopyRasterBufferProvider(
     viz::RasterContextProvider* compositor_context_provider,
     const RasterCapabilities& raster_caps)
     : compositor_context_provider_(compositor_context_provider),
       tile_format_(raster_caps.tile_format),
       tile_texture_target_(raster_caps.tile_texture_target) {}

 ZeroCopyRasterBufferProvider::~ZeroCopyRasterBufferProvider() = default;

 std::unique_ptr<RasterBuffer>
 ZeroCopyRasterBufferProvider::AcquireBufferForRaster(
     const ResourcePool::InUsePoolResource& resource,
     uint64_t resource_content_id,
     uint64_t previous_content_id,
     bool depends_on_at_raster_decodes,
     bool depends_on_hardware_accelerated_jpeg_candidates,
     bool depends_on_hardware_accelerated_webp_candidates) {
   if (!resource.gpu_backing()) {
     auto backing = std::make_unique<ZeroCopyGpuBacking>();
     backing->overlay_candidate = true;
     backing->texture_target = tile_texture_target_;
     // This RasterBufferProvider will modify the resource outside of the
     // GL command stream. So resources should not become available for reuse
     // until they are not in use by the gpu anymore, which a fence is used
     // to determine.
     backing->wait_on_fence_required = true;
     backing->shared_image_interface =
         compositor_context_provider_->SharedImageInterface();
     resource.set_gpu_backing(std::move(backing));
   }
   ZeroCopyGpuBacking* backing =
       static_cast<ZeroCopyGpuBacking*>(resource.gpu_backing());

   return std::make_unique<ZeroCopyRasterBufferImpl>(shutdown_event_, resource,
                                                     backing);
 }

 void ZeroCopyRasterBufferProvider::Flush() {}

 viz::SharedImageFormat ZeroCopyRasterBufferProvider::GetFormat() const {
   return tile_format_;
 }

 bool ZeroCopyRasterBufferProvider::IsResourcePremultiplied() const {
   return true;
 }

 bool ZeroCopyRasterBufferProvider::CanPartialRasterIntoProvidedResource()
     const {
   return false;
 }

 bool ZeroCopyRasterBufferProvider::IsResourceReadyToDraw(
     const ResourcePool::InUsePoolResource& resource) {
   // Zero-copy resources are immediately ready to draw.
   return true;
 }

 uint64_t ZeroCopyRasterBufferProvider::SetReadyToDrawCallback(
     const std::vector<const ResourcePool::InUsePoolResource*>& resources,
     base::OnceClosure callback,
     uint64_t pending_callback_id) {
   // Zero-copy resources are immediately ready to draw.
   return 0;
 }

 void ZeroCopyRasterBufferProvider::SetShutdownEvent(
     base::WaitableEvent* shutdown_event) {
   shutdown_event_ = shutdown_event;
 }

 void ZeroCopyRasterBufferProvider::Shutdown() {}

 }  // namespace cc
	// Copyright 2013 The Chromium Authors
	// Use of this source code is governed by a BSD-style license that can be
	// found in the LICENSE file.

	#include "cc/raster/zero_copy_raster_buffer_provider.h"

	#include <stdint.h>

	#include <algorithm>
	#include <utility>

	#include "base/memory/raw_ptr.h"
	#include "base/trace_event/process_memory_dump.h"
	#include "base/trace_event/trace_event.h"
	#include "base/trace_event/traced_value.h"
	#include "cc/resources/resource_pool.h"
	#include "components/viz/client/client_resource_provider.h"
	#include "components/viz/common/gpu/raster_context_provider.h"
	#include "components/viz/common/resources/platform_color.h"
	#include "components/viz/common/resources/shared_image_format_utils.h"
	#include "gpu/command_buffer/client/client_shared_image.h"
	#include "gpu/command_buffer/client/shared_image_interface.h"
	#include "gpu/command_buffer/common/shared_image_trace_utils.h"
	#include "gpu/command_buffer/common/shared_image_usage.h"
	#include "ui/gfx/buffer_format_util.h"

	namespace cc {
	namespace {

	constexpr static auto kBufferUsage = gfx::BufferUsage::GPU_READ_CPU_READ_WRITE;

	// Subclass for InUsePoolResource that holds ownership of a zero-copy backing
	// and does cleanup of the backing when destroyed.
	class ZeroCopyGpuBacking : public ResourcePool::GpuBacking {
	public:
	~ZeroCopyGpuBacking() override {
	if (!shared_image) {
	return;
	}
	if (returned_sync_token.HasData())
	shared_image_interface->DestroySharedImage(returned_sync_token,
	std::move(shared_image));
	else if (mailbox_sync_token.HasData())
	shared_image_interface->DestroySharedImage(mailbox_sync_token,
	std::move(shared_image));
	}

	void OnMemoryDump(
	base::trace_event::ProcessMemoryDump* pmd,
	const base::trace_event::MemoryAllocatorDumpGuid& buffer_dump_guid,
	uint64_t tracing_process_id,
	int importance) const override {
	if (!shared_image) {
	return;
	}
	auto mapping = shared_image->Map();
	if (!mapping) {
	return;
	}
	mapping->OnMemoryDump(pmd, buffer_dump_guid, tracing_process_id,
	importance);
	}

	// The SharedImageInterface used to clean up the shared image.
	raw_ptr<gpu::SharedImageInterface> shared_image_interface = nullptr;
	};

	// RasterBuffer for the zero copy upload, which is given to the raster worker
	// threads for raster/upload.
	class ZeroCopyRasterBufferImpl : public RasterBuffer {
	public:
	ZeroCopyRasterBufferImpl(
	base::WaitableEvent* shutdown_event,
	const ResourcePool::InUsePoolResource& in_use_resource,
	ZeroCopyGpuBacking* backing)
	: backing_(backing),
	shutdown_event_(shutdown_event),
	resource_size_(in_use_resource.size()),
	format_(in_use_resource.format()),
	resource_color_space_(in_use_resource.color_space()) {}
	ZeroCopyRasterBufferImpl(const ZeroCopyRasterBufferImpl&) = delete;

	~ZeroCopyRasterBufferImpl() override {
	// If MappableSharedImage allocation failed (https://crbug.com/554541), then
	// we don't have anything to give to the display compositor, so we report a
	// zero mailbox that will result in checkerboarding.
	if (!backing_->shared_image) {
	return;
	}

	// This is destroyed on the compositor thread when raster is complete, but
	// before the backing is prepared for export to the display compositor. So
	// we can set up the texture and SyncToken here.
	// TODO(danakj): This could be done with the worker context in Playback. Do
	// we need to do things in IsResourceReadyToDraw() and OrderingBarrier then?
	gpu::SharedImageInterface* sii = backing_->shared_image_interface;
	sii->UpdateSharedImage(backing_->returned_sync_token,
	backing_->shared_image->mailbox());

	backing_->mailbox_sync_token = sii->GenUnverifiedSyncToken();
	}

	ZeroCopyRasterBufferImpl& operator=(const ZeroCopyRasterBufferImpl&) = delete;

	// Overridden from RasterBuffer:
	void Playback(const RasterSource* raster_source,
	const gfx::Rect& raster_full_rect,
	const gfx::Rect& raster_dirty_rect,
	uint64_t new_content_id,
	const gfx::AxisTransform2d& transform,
	const RasterSource::PlaybackSettings& playback_settings,
	const GURL& url) override {
	TRACE_EVENT0("cc", "ZeroCopyRasterBuffer::Playback");

	gpu::SharedImageInterface* sii = backing_->shared_image_interface;

	// Create a MappableSI if necessary.
	if (!backing_->shared_image) {
	uint32_t usage = gpu::SHARED_IMAGE_USAGE_DISPLAY_READ \|
	gpu::SHARED_IMAGE_USAGE_SCANOUT;
	backing_->shared_image = sii->CreateSharedImage(
	format_, resource_size_, resource_color_space_,
	kTopLeft_GrSurfaceOrigin, kPremul_SkAlphaType, usage,
	"ZeroCopyRasterTile", gpu::kNullSurfaceHandle, kBufferUsage);
	if (!backing_->shared_image) {
	LOG(ERROR) << "Creation of MappableSharedImage failed.";
	return;
	}
	}

	std::unique_ptr<gpu::ClientSharedImage::ScopedMapping> mapping =
	backing_->shared_image->Map();
	if (!mapping) {
	LOG(ERROR) << "MapSharedImage Failed.";
	sii->DestroySharedImage(gpu::SyncToken(),
	std::move(backing_->shared_image));
	return;
	}

	// TODO(danakj): Implement partial raster with raster_dirty_rect.
	RasterBufferProvider::PlaybackToMemory(
	mapping->Memory(0), format_, resource_size_, mapping->Stride(0),
	raster_source, raster_full_rect, raster_full_rect, transform,
	resource_color_space_,
	/gpu_compositing=/true, playback_settings);
	}

	bool SupportsBackgroundThreadPriority() const override { return true; }

	private:
	// This field may only be used on the compositor thread.
	raw_ptr<ZeroCopyGpuBacking> backing_;

	// These fields are for use on the worker thread.
	raw_ptr<base::WaitableEvent> shutdown_event_;
	gfx::Size resource_size_;
	viz::SharedImageFormat format_;
	gfx::ColorSpace resource_color_space_;
	};

	} // namespace

	ZeroCopyRasterBufferProvider::ZeroCopyRasterBufferProvider(
	viz::RasterContextProvider* compositor_context_provider,
	const RasterCapabilities& raster_caps)
	: compositor_context_provider_(compositor_context_provider),
	tile_format_(raster_caps.tile_format),
	tile_texture_target_(raster_caps.tile_texture_target) {}

	ZeroCopyRasterBufferProvider::~ZeroCopyRasterBufferProvider() = default;

	std::unique_ptr<RasterBuffer>
	ZeroCopyRasterBufferProvider::AcquireBufferForRaster(
	const ResourcePool::InUsePoolResource& resource,
	uint64_t resource_content_id,
	uint64_t previous_content_id,
	bool depends_on_at_raster_decodes,
	bool depends_on_hardware_accelerated_jpeg_candidates,
	bool depends_on_hardware_accelerated_webp_candidates) {
	if (!resource.gpu_backing()) {
	auto backing = std::make_unique<ZeroCopyGpuBacking>();
	backing->overlay_candidate = true;
	backing->texture_target = tile_texture_target_;
	// This RasterBufferProvider will modify the resource outside of the
	// GL command stream. So resources should not become available for reuse
	// until they are not in use by the gpu anymore, which a fence is used
	// to determine.
	backing->wait_on_fence_required = true;
	backing->shared_image_interface =
	compositor_context_provider_->SharedImageInterface();
	resource.set_gpu_backing(std::move(backing));
	}
	ZeroCopyGpuBacking* backing =
	static_cast<ZeroCopyGpuBacking*>(resource.gpu_backing());

	return std::make_unique<ZeroCopyRasterBufferImpl>(shutdown_event_, resource,
	backing);
	}

	void ZeroCopyRasterBufferProvider::Flush() {}

	viz::SharedImageFormat ZeroCopyRasterBufferProvider::GetFormat() const {
	return tile_format_;
	}

	bool ZeroCopyRasterBufferProvider::IsResourcePremultiplied() const {
	return true;
	}

	bool ZeroCopyRasterBufferProvider::CanPartialRasterIntoProvidedResource()
	const {
	return false;
	}

	bool ZeroCopyRasterBufferProvider::IsResourceReadyToDraw(
	const ResourcePool::InUsePoolResource& resource) {
	// Zero-copy resources are immediately ready to draw.
	return true;
	}

	uint64_t ZeroCopyRasterBufferProvider::SetReadyToDrawCallback(
	const std::vector<const ResourcePool::InUsePoolResource*>& resources,
	base::OnceClosure callback,
	uint64_t pending_callback_id) {
	// Zero-copy resources are immediately ready to draw.
	return 0;
	}

	void ZeroCopyRasterBufferProvider::SetShutdownEvent(
	base::WaitableEvent* shutdown_event) {
	shutdown_event_ = shutdown_event;
	}

	void ZeroCopyRasterBufferProvider::Shutdown() {}

	} // namespace cc