gecko-dev/image/ImageWrapper.cpp
Cameron McCormack 18ffe7c642 Bug 1656114 - Part 4: Accumulate page use counters in the parent process. r=emilio,nika
This changes the way we deal with page use counters so that we can
handle out of process iframes.

Currently, when a parent document is being destroyed, we poke into all
of the sub-documents to merge their use counters into the parent's page
use counters, which we then report via Telemetry.  With Fission enabled,
the sub-documents may be out of process.  We can't simply turn these
into async IPC calls, since the parent document will be destroyed
shortly, as might the content processes holding the sub-documents.

So instead, each document during its initialization identifies which
ancestor document it will contribute its page use counters to, and
stores its WindowContext id to identify that ancestor.  A message is
sent to the parent process to notify it that page use counter data will
be sent at some later point.  That later point is when the document
loses its window.  It doesn't matter if the ancestor document has
already been destroyed at this point, since all we need is its
WindowContext id to uniquely identify it.  Once the parent process has
received all of the use counters it expects to accumulate to a given
WindowContext Id, it reports them via Telemetry.

Reporting of document use counters remains unchanged and is done by each
document in their content process.

While we're here, we also:

* Limit use counters to be reported for a pre-defined set of document
  URL schemes, rather than be based on the document principal.

* Add proper MOZ_LOG logging for use counters instead of printfs.

Differential Revision: https://phabricator.services.mozilla.com/D87188
2020-10-11 22:03:43 +00:00

298 lines
9.4 KiB
C++

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#include "ImageWrapper.h"
#include "mozilla/gfx/2D.h"
#include "mozilla/RefPtr.h"
#include "Orientation.h"
#include "mozilla/MemoryReporting.h"
namespace mozilla {
using dom::Document;
using gfx::DataSourceSurface;
using gfx::IntSize;
using gfx::SamplingFilter;
using gfx::SourceSurface;
using layers::ImageContainer;
using layers::LayerManager;
namespace image {
// Inherited methods from Image.
already_AddRefed<ProgressTracker> ImageWrapper::GetProgressTracker() {
return mInnerImage->GetProgressTracker();
}
size_t ImageWrapper::SizeOfSourceWithComputedFallback(
SizeOfState& aState) const {
return mInnerImage->SizeOfSourceWithComputedFallback(aState);
}
void ImageWrapper::CollectSizeOfSurfaces(
nsTArray<SurfaceMemoryCounter>& aCounters,
MallocSizeOf aMallocSizeOf) const {
mInnerImage->CollectSizeOfSurfaces(aCounters, aMallocSizeOf);
}
void ImageWrapper::IncrementAnimationConsumers() {
MOZ_ASSERT(NS_IsMainThread(),
"Main thread only to encourage serialization "
"with DecrementAnimationConsumers");
mInnerImage->IncrementAnimationConsumers();
}
void ImageWrapper::DecrementAnimationConsumers() {
MOZ_ASSERT(NS_IsMainThread(),
"Main thread only to encourage serialization "
"with IncrementAnimationConsumers");
mInnerImage->DecrementAnimationConsumers();
}
#ifdef DEBUG
uint32_t ImageWrapper::GetAnimationConsumers() {
return mInnerImage->GetAnimationConsumers();
}
#endif
nsresult ImageWrapper::OnImageDataAvailable(nsIRequest* aRequest,
nsISupports* aContext,
nsIInputStream* aInStr,
uint64_t aSourceOffset,
uint32_t aCount) {
return mInnerImage->OnImageDataAvailable(aRequest, aContext, aInStr,
aSourceOffset, aCount);
}
nsresult ImageWrapper::OnImageDataComplete(nsIRequest* aRequest,
nsISupports* aContext,
nsresult aStatus, bool aLastPart) {
return mInnerImage->OnImageDataComplete(aRequest, aContext, aStatus,
aLastPart);
}
void ImageWrapper::OnSurfaceDiscarded(const SurfaceKey& aSurfaceKey) {
return mInnerImage->OnSurfaceDiscarded(aSurfaceKey);
}
void ImageWrapper::SetInnerWindowID(uint64_t aInnerWindowId) {
mInnerImage->SetInnerWindowID(aInnerWindowId);
}
uint64_t ImageWrapper::InnerWindowID() const {
return mInnerImage->InnerWindowID();
}
bool ImageWrapper::HasError() { return mInnerImage->HasError(); }
void ImageWrapper::SetHasError() { mInnerImage->SetHasError(); }
nsIURI* ImageWrapper::GetURI() const { return mInnerImage->GetURI(); }
// Methods inherited from XPCOM interfaces.
NS_IMPL_ISUPPORTS(ImageWrapper, imgIContainer)
NS_IMETHODIMP
ImageWrapper::GetWidth(int32_t* aWidth) {
return mInnerImage->GetWidth(aWidth);
}
NS_IMETHODIMP
ImageWrapper::GetHeight(int32_t* aHeight) {
return mInnerImage->GetHeight(aHeight);
}
nsresult ImageWrapper::GetNativeSizes(nsTArray<IntSize>& aNativeSizes) const {
return mInnerImage->GetNativeSizes(aNativeSizes);
}
size_t ImageWrapper::GetNativeSizesLength() const {
return mInnerImage->GetNativeSizesLength();
}
NS_IMETHODIMP
ImageWrapper::GetIntrinsicSize(nsSize* aSize) {
return mInnerImage->GetIntrinsicSize(aSize);
}
Maybe<AspectRatio> ImageWrapper::GetIntrinsicRatio() {
return mInnerImage->GetIntrinsicRatio();
}
nsresult ImageWrapper::GetHotspotX(int32_t* aX) {
return Image::GetHotspotX(aX);
}
nsresult ImageWrapper::GetHotspotY(int32_t* aY) {
return Image::GetHotspotY(aY);
}
NS_IMETHODIMP_(Orientation)
ImageWrapper::GetOrientation() { return mInnerImage->GetOrientation(); }
NS_IMETHODIMP_(bool)
ImageWrapper::HandledOrientation() { return mInnerImage->HandledOrientation(); }
NS_IMETHODIMP
ImageWrapper::GetType(uint16_t* aType) { return mInnerImage->GetType(aType); }
NS_IMETHODIMP
ImageWrapper::GetProducerId(uint32_t* aId) {
return mInnerImage->GetProducerId(aId);
}
NS_IMETHODIMP
ImageWrapper::GetAnimated(bool* aAnimated) {
return mInnerImage->GetAnimated(aAnimated);
}
NS_IMETHODIMP_(already_AddRefed<SourceSurface>)
ImageWrapper::GetFrame(uint32_t aWhichFrame, uint32_t aFlags) {
return mInnerImage->GetFrame(aWhichFrame, aFlags);
}
NS_IMETHODIMP_(already_AddRefed<SourceSurface>)
ImageWrapper::GetFrameAtSize(const IntSize& aSize, uint32_t aWhichFrame,
uint32_t aFlags) {
return mInnerImage->GetFrameAtSize(aSize, aWhichFrame, aFlags);
}
NS_IMETHODIMP_(bool)
ImageWrapper::WillDrawOpaqueNow() { return mInnerImage->WillDrawOpaqueNow(); }
NS_IMETHODIMP_(bool)
ImageWrapper::IsImageContainerAvailable(LayerManager* aManager,
uint32_t aFlags) {
return mInnerImage->IsImageContainerAvailable(aManager, aFlags);
}
NS_IMETHODIMP_(already_AddRefed<ImageContainer>)
ImageWrapper::GetImageContainer(LayerManager* aManager, uint32_t aFlags) {
return mInnerImage->GetImageContainer(aManager, aFlags);
}
NS_IMETHODIMP_(bool)
ImageWrapper::IsImageContainerAvailableAtSize(LayerManager* aManager,
const IntSize& aSize,
uint32_t aFlags) {
return mInnerImage->IsImageContainerAvailableAtSize(aManager, aSize, aFlags);
}
NS_IMETHODIMP_(ImgDrawResult)
ImageWrapper::GetImageContainerAtSize(layers::LayerManager* aManager,
const gfx::IntSize& aSize,
const Maybe<SVGImageContext>& aSVGContext,
uint32_t aFlags,
layers::ImageContainer** aOutContainer) {
return mInnerImage->GetImageContainerAtSize(aManager, aSize, aSVGContext,
aFlags, aOutContainer);
}
NS_IMETHODIMP_(ImgDrawResult)
ImageWrapper::Draw(gfxContext* aContext, const nsIntSize& aSize,
const ImageRegion& aRegion, uint32_t aWhichFrame,
SamplingFilter aSamplingFilter,
const Maybe<SVGImageContext>& aSVGContext, uint32_t aFlags,
float aOpacity) {
return mInnerImage->Draw(aContext, aSize, aRegion, aWhichFrame,
aSamplingFilter, aSVGContext, aFlags, aOpacity);
}
NS_IMETHODIMP
ImageWrapper::StartDecoding(uint32_t aFlags, uint32_t aWhichFrame) {
return mInnerImage->StartDecoding(aFlags, aWhichFrame);
}
bool ImageWrapper::StartDecodingWithResult(uint32_t aFlags,
uint32_t aWhichFrame) {
return mInnerImage->StartDecodingWithResult(aFlags, aWhichFrame);
}
imgIContainer::DecodeResult ImageWrapper::RequestDecodeWithResult(
uint32_t aFlags, uint32_t aWhichFrame) {
return mInnerImage->RequestDecodeWithResult(aFlags, aWhichFrame);
}
NS_IMETHODIMP
ImageWrapper::RequestDecodeForSize(const nsIntSize& aSize, uint32_t aFlags,
uint32_t aWhichFrame) {
return mInnerImage->RequestDecodeForSize(aSize, aFlags, aWhichFrame);
}
NS_IMETHODIMP
ImageWrapper::LockImage() {
MOZ_ASSERT(NS_IsMainThread(),
"Main thread to encourage serialization with UnlockImage");
return mInnerImage->LockImage();
}
NS_IMETHODIMP
ImageWrapper::UnlockImage() {
MOZ_ASSERT(NS_IsMainThread(),
"Main thread to encourage serialization with LockImage");
return mInnerImage->UnlockImage();
}
NS_IMETHODIMP
ImageWrapper::RequestDiscard() { return mInnerImage->RequestDiscard(); }
NS_IMETHODIMP_(void)
ImageWrapper::RequestRefresh(const TimeStamp& aTime) {
return mInnerImage->RequestRefresh(aTime);
}
NS_IMETHODIMP
ImageWrapper::GetAnimationMode(uint16_t* aAnimationMode) {
return mInnerImage->GetAnimationMode(aAnimationMode);
}
NS_IMETHODIMP
ImageWrapper::SetAnimationMode(uint16_t aAnimationMode) {
return mInnerImage->SetAnimationMode(aAnimationMode);
}
NS_IMETHODIMP
ImageWrapper::ResetAnimation() { return mInnerImage->ResetAnimation(); }
NS_IMETHODIMP_(float)
ImageWrapper::GetFrameIndex(uint32_t aWhichFrame) {
return mInnerImage->GetFrameIndex(aWhichFrame);
}
NS_IMETHODIMP_(int32_t)
ImageWrapper::GetFirstFrameDelay() { return mInnerImage->GetFirstFrameDelay(); }
NS_IMETHODIMP_(void)
ImageWrapper::SetAnimationStartTime(const TimeStamp& aTime) {
mInnerImage->SetAnimationStartTime(aTime);
}
void ImageWrapper::PropagateUseCounters(Document* aReferencingDocument) {
mInnerImage->PropagateUseCounters(aReferencingDocument);
}
nsIntSize ImageWrapper::OptimalImageSizeForDest(const gfxSize& aDest,
uint32_t aWhichFrame,
SamplingFilter aSamplingFilter,
uint32_t aFlags) {
return mInnerImage->OptimalImageSizeForDest(aDest, aWhichFrame,
aSamplingFilter, aFlags);
}
NS_IMETHODIMP_(nsIntRect)
ImageWrapper::GetImageSpaceInvalidationRect(const nsIntRect& aRect) {
return mInnerImage->GetImageSpaceInvalidationRect(aRect);
}
already_AddRefed<imgIContainer> ImageWrapper::Unwrap() {
return mInnerImage->Unwrap();
}
} // namespace image
} // namespace mozilla