gfx/gl/GfxTexturesReporter.h
author Mozilla Releng Treescript <release+treescript@mozilla.org>
Tue, 09 Aug 2022 06:59:02 +0000
changeset 626480 5761a15f36078c1ff69499321706dfaad8da84c3
parent 516859 0194aff14e504c2d787f9084acdc162afc1a9688
permissions -rw-r--r--
no bug - Bumping Firefox l10n changesets r=release a=l10n-bump DONTBUILD gd -> fe6d5c417ddee1ef85d8c83ebea768facee14b5a nb-NO -> 0d47d560228111600cfcb93cad0ad45485f3638f

/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* 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/. */

#ifndef GFXTEXTURESREPORTER_H_
#define GFXTEXTURESREPORTER_H_

#include "mozilla/Atomics.h"
#include "nsIMemoryReporter.h"
#include "GLTypes.h"

namespace mozilla {
namespace gl {

class GfxTexturesReporter final : public nsIMemoryReporter {
  ~GfxTexturesReporter() = default;

 public:
  NS_DECL_ISUPPORTS

  GfxTexturesReporter() {
#ifdef DEBUG
    // There must be only one instance of this class, due to |sAmount|
    // being static.  Assert this.
    static bool hasRun = false;
    MOZ_ASSERT(!hasRun);
    hasRun = true;
#endif
  }

  enum MemoryUse {
    // when memory being allocated is reported to a memory reporter
    MemoryAllocated,
    // when memory being freed is reported to a memory reporter
    MemoryFreed
  };

  // When memory is used/freed for tile textures, call this method to update
  // the value reported by this memory reporter.
  static void UpdateAmount(MemoryUse action, size_t amount);

  static void UpdateWasteAmount(size_t delta) { sTileWasteAmount += delta; }

  NS_IMETHOD CollectReports(nsIHandleReportCallback* aHandleReport,
                            nsISupports* aData, bool aAnonymize) override {
    MOZ_COLLECT_REPORT(
        "gfx-tiles-waste", KIND_OTHER, UNITS_BYTES, int64_t(sTileWasteAmount),
        "Memory lost due to tiles extending past content boundaries");

    MOZ_COLLECT_REPORT("gfx-textures", KIND_OTHER, UNITS_BYTES,
                       int64_t(sAmount),
                       "Memory used for storing GL textures.");

    MOZ_COLLECT_REPORT("gfx-textures-peak", KIND_OTHER, UNITS_BYTES,
                       int64_t(sPeakAmount),
                       "Peak memory used for storing GL textures.");

    return NS_OK;
  }

 private:
  static Atomic<size_t> sAmount;
  static Atomic<size_t> sPeakAmount;
  // Count the amount of memory lost to tile waste
  static Atomic<size_t> sTileWasteAmount;
};

class GfxTextureWasteTracker {
 public:
  GfxTextureWasteTracker() : mBytes(0) {
    MOZ_COUNT_CTOR(GfxTextureWasteTracker);
  }

  void Update(int32_t aPixelArea, int32_t aBytesPerPixel) {
    GfxTexturesReporter::UpdateWasteAmount(-mBytes);
    mBytes = aPixelArea * aBytesPerPixel;
    GfxTexturesReporter::UpdateWasteAmount(mBytes);
  }

  ~GfxTextureWasteTracker() {
    GfxTexturesReporter::UpdateWasteAmount(-mBytes);
    MOZ_COUNT_DTOR(GfxTextureWasteTracker);
  }

 private:
  GfxTextureWasteTracker(const GfxTextureWasteTracker& aRef);

  int32_t mBytes;
};

}  // namespace gl
}  // namespace mozilla

#endif  // GFXTEXTURESREPORTER_H_