gpu/command_buffer/service/memory_tracking.h

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

#ifndef GPU_COMMAND_BUFFER_SERVICE_MEMORY_TRACKING_H_
#define GPU_COMMAND_BUFFER_SERVICE_MEMORY_TRACKING_H_

#include <stdint.h>

#include "base/memory/ref_counted.h"
#include "base/memory/scoped_refptr.h"
#include "base/synchronization/lock.h"
#include "gpu/command_buffer/common/command_buffer_id.h"
#include "gpu/command_buffer/service/gpu_command_buffer_service_export.h"
#include "gpu/ipc/common/gpu_peak_memory.h"
#include "third_party/perfetto/include/perfetto/tracing/track.h"

namespace gpu {
class MockMemoryTracker;

// A MemoryTracker is used to propagate per-ContextGroup memory usage
// statistics to the global GpuMemoryManager.
// MemoryTracker is thread safe.
class GPU_COMMAND_BUFFER_SERVICE_EXPORT MemoryTracker
    : public base::RefCountedThreadSafe<MemoryTracker> {
 public:
  // Observe all changes in memory notified to this MemoryTracker.
  // Used by GpuChannelManager::GpuPeakMemoryMonitor only.
  class Observer : public base::RefCountedThreadSafe<Observer> {
   public:
    Observer() = default;

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

    virtual void OnMemoryAllocatedChange(
        CommandBufferId id,
        uint64_t old_size,
        uint64_t new_size,
        GpuPeakMemoryAllocationSource source) = 0;

   protected:
    friend class base::RefCountedThreadSafe<Observer>;
    virtual ~Observer() = default;
  };


  MemoryTracker(CommandBufferId command_buffer_id,
                uint64_t client_tracing_id,
                scoped_refptr<gpu::MemoryTracker::Observer> peak_memory_monitor,
                GpuPeakMemoryAllocationSource source);

  // For testing only.
  MemoryTracker();

  virtual void TrackMemoryAllocatedChange(int64_t delta);

  virtual uint64_t GetSize() const;

  // Raw ID identifying the GPU client for whom memory is being allocated.
  virtual int ClientId() const;

  // Tracing id which identifies the GPU client for whom memory is being
  // allocated.
  virtual uint64_t ClientTracingId() const;

  // Returns an ID that uniquely identifies the context group.
  virtual uint64_t ContextGroupTracingId() const;

 protected:
  friend class base::RefCountedThreadSafe<MemoryTracker>;
  friend class MemoryTypeTracker;
  friend class MockMemoryTracker;
  virtual ~MemoryTracker();

 private:
  const CommandBufferId command_buffer_id_;
  const uint64_t client_tracing_id_;
  const scoped_refptr<gpu::MemoryTracker::Observer> peak_memory_monitor_;
  const GpuPeakMemoryAllocationSource allocation_source_;

  const std::string tracing_track_name_;
  const perfetto::CounterTrack tracing_track_;

  uint64_t mem_traker_size_ GUARDED_BY(memory_tracker_lock_) = 0;
  mutable base::Lock memory_tracker_lock_;

  static std::string GetTracingTrackName(uint64_t client_tracing_id,
                                         CommandBufferId command_buffer_id,
                                         GpuPeakMemoryAllocationSource source);
};

// A MemoryTypeTracker tracks the use of a particular type of memory (buffer,
// texture, or renderbuffer) and forward the result to a specified
// MemoryTracker. MemoryTypeTracker is thread-safe, but it must not outlive the
// MemoryTracker which will be notified on the sequence the MemoryTypeTracker
// was created on.
class GPU_COMMAND_BUFFER_SERVICE_EXPORT MemoryTypeTracker {
 public:
  explicit MemoryTypeTracker(scoped_refptr<MemoryTracker> memory_tracker);

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

  ~MemoryTypeTracker();

  const MemoryTracker* memory_tracker() const { return memory_tracker_.get(); }

  void TrackMemAlloc(size_t bytes);
  void TrackMemFree(size_t bytes);
  size_t GetMemRepresented() const;

 private:
  const scoped_refptr<MemoryTracker> memory_tracker_;

  size_t mem_represented_ GUARDED_BY(lock_) = 0;
  mutable base::Lock lock_;
};

}  // namespace gpu

#endif  // GPU_COMMAND_BUFFER_SERVICE_MEMORY_TRACKING_H_