src/gpu/GrResourceCache.h - platform/external/skia - Gitiles


 /*
  * Copyright 2014 Google Inc.
  *
  * Use of this source code is governed by a BSD-style license that can be
  * found in the LICENSE file.
  */

 #ifndef GrResourceCache_DEFINED
 #define GrResourceCache_DEFINED

 #include "GrGpuResource.h"
 #include "GrGpuResourceCacheAccess.h"
 #include "GrGpuResourcePriv.h"
 #include "GrResourceKey.h"
 #include "SkMessageBus.h"
 #include "SkRefCnt.h"
 #include "SkTArray.h"
 #include "SkTDPQueue.h"
 #include "SkTInternalLList.h"
 #include "SkTMultiMap.h"

 class SkString;

 /**
  * Manages the lifetime of all GrGpuResource instances.
  *
  * Resources may have optionally have two types of keys:
  *      1) A scratch key. This is for resources whose allocations are cached but not their contents.
  *         Multiple resources can share the same scratch key. This is so a caller can have two
  *         resource instances with the same properties (e.g. multipass rendering that ping-pongs
  *         between two temporary surfaces). The scratch key is set at resource creation time and
  *         should never change. Resources need not have a scratch key.
  *      2) A unique key. This key's meaning is specific to the domain that created the key. Only one
  *         resource may have a given unique key. The unique key can be set, cleared, or changed
  *         anytime after resource creation.
  *
  * A unique key always takes precedence over a scratch key when a resource has both types of keys.
  * If a resource has neither key type then it will be deleted as soon as the last reference to it
  * is dropped.
  */
 class GrResourceCache {
 public:
     GrResourceCache();
     ~GrResourceCache();

     /** Used to access functionality needed by GrGpuResource for lifetime management. */
     class ResourceAccess;
     ResourceAccess resourceAccess();

     /**
      * Sets the cache limits in terms of number of resources and max gpu memory byte size.
      */
     void setLimits(int count, size_t bytes);

     /**
      * Returns the number of resources.
      */
     int getResourceCount() const {
         return fPurgeableQueue.count() + fNonpurgeableResources.count();
     }

     /**
      * Returns the number of resources that count against the budget.
      */
     int getBudgetedResourceCount() const { return fBudgetedCount; }

     /**
      * Returns the number of bytes consumed by resources.
      */
     size_t getResourceBytes() const { return fBytes; }

     /**
      * Returns the number of bytes consumed by budgeted resources.
      */
     size_t getBudgetedResourceBytes() const { return fBudgetedBytes; }

     /**
      * Returns the cached resources count budget.
      */
     int getMaxResourceCount() const { return fMaxCount; }

     /**
      * Returns the number of bytes consumed by cached resources.
      */
     size_t getMaxResourceBytes() const { return fMaxBytes; }

     /**
      * Abandons the backend API resources owned by all GrGpuResource objects and removes them from
      * the cache.
      */
     void abandonAll();

     /**
      * Releases the backend API resources owned by all GrGpuResource objects and removes them from
      * the cache.
      */
     void releaseAll();

     enum {
         /** Preferentially returns scratch resources with no pending IO. */
         kPreferNoPendingIO_ScratchFlag = 0x1,
         /** Will not return any resources that match but have pending IO. */
         kRequireNoPendingIO_ScratchFlag = 0x2,
     };

     /**
      * Find a resource that matches a scratch key.
      */
     GrGpuResource* findAndRefScratchResource(const GrScratchKey& scratchKey, uint32_t flags = 0);

 #ifdef SK_DEBUG
     // This is not particularly fast and only used for validation, so debug only.
     int countScratchEntriesForKey(const GrScratchKey& scratchKey) const {
         return fScratchMap.countForKey(scratchKey);
     }
 #endif

     /**
      * Find a resource that matches a unique key.
      */
     GrGpuResource* findAndRefUniqueResource(const GrUniqueKey& key) {
         GrGpuResource* resource = fUniqueHash.find(key);
         if (resource) {
             this->refAndMakeResourceMRU(resource);
         }
         return resource;
     }

     /**
      * Query whether a unique key exists in the cache.
      */
     bool hasUniqueKey(const GrUniqueKey& key) const {
         return SkToBool(fUniqueHash.find(key));
     }

     /** Purges resources to become under budget and processes resources with invalidated unique
         keys. */
     void purgeAsNeeded() {
         SkTArray<GrUniqueKeyInvalidatedMessage> invalidKeyMsgs;
         fInvalidUniqueKeyInbox.poll(&invalidKeyMsgs);
         if (invalidKeyMsgs.count()) {
             this->processInvalidUniqueKeys(invalidKeyMsgs);
         }
         if (fBudgetedCount <= fMaxCount && fBudgetedBytes <= fMaxBytes) {
             return;
         }
         this->internalPurgeAsNeeded();
     }

     /** Purges all resources that don't have external owners. */
     void purgeAllUnlocked();

     /**
      * The callback function used by the cache when it is still over budget after a purge. The
      * passed in 'data' is the same 'data' handed to setOverbudgetCallback.
      */
     typedef void (*PFOverBudgetCB)(void* data);

     /**
      * Set the callback the cache should use when it is still over budget after a purge. The 'data'
      * provided here will be passed back to the callback. Note that the cache will attempt to purge
      * any resources newly freed by the callback.
      */
     void setOverBudgetCallback(PFOverBudgetCB overBudgetCB, void* data) {
         fOverBudgetCB = overBudgetCB;
         fOverBudgetData = data;
     }

 #if GR_GPU_STATS
     void dumpStats(SkString*) const;
 #endif

     // This function is for unit testing and is only defined in test tools.
     void changeTimestamp(uint32_t newTimestamp);

 private:
     ///////////////////////////////////////////////////////////////////////////
     /// @name Methods accessible via ResourceAccess
     ////
     void insertResource(GrGpuResource*);
     void removeResource(GrGpuResource*);
     void notifyPurgeable(GrGpuResource*);
     void didChangeGpuMemorySize(const GrGpuResource*, size_t oldSize);
     void changeUniqueKey(GrGpuResource*, const GrUniqueKey&);
     void removeUniqueKey(GrGpuResource*);
     void willRemoveScratchKey(const GrGpuResource*);
     void didChangeBudgetStatus(GrGpuResource*);
     void refAndMakeResourceMRU(GrGpuResource*);
     /// @}

     void internalPurgeAsNeeded();
     void processInvalidUniqueKeys(const SkTArray<GrUniqueKeyInvalidatedMessage>&);
     void addToNonpurgeableArray(GrGpuResource*);
     void removeFromNonpurgeableArray(GrGpuResource*);
     bool overBudget() const { return fBudgetedBytes > fMaxBytes || fBudgetedCount > fMaxCount; }

     uint32_t getNextTimestamp();

 #ifdef SK_DEBUG
     bool isInCache(const GrGpuResource* r) const;
     void validate() const;
 #else
     void validate() const {}
 #endif

     class AutoValidate;

     class AvailableForScratchUse;

     struct ScratchMapTraits {
         static const GrScratchKey& GetKey(const GrGpuResource& r) {
             return r.resourcePriv().getScratchKey();
         }

         static uint32_t Hash(const GrScratchKey& key) { return key.hash(); }
     };
     typedef SkTMultiMap<GrGpuResource, GrScratchKey, ScratchMapTraits> ScratchMap;

     struct UniqueHashTraits {
         static const GrUniqueKey& GetKey(const GrGpuResource& r) { return r.getUniqueKey(); }

         static uint32_t Hash(const GrUniqueKey& key) { return key.hash(); }
     };
     typedef SkTDynamicHash<GrGpuResource, GrUniqueKey, UniqueHashTraits> UniqueHash;

     static bool CompareTimestamp(GrGpuResource* const& a, GrGpuResource* const& b) {
         return a->cacheAccess().timestamp() < b->cacheAccess().timestamp();
     }

     static int* AccessResourceIndex(GrGpuResource* const& res) {
         return res->cacheAccess().accessCacheIndex();
     }

     typedef SkMessageBus<GrUniqueKeyInvalidatedMessage>::Inbox InvalidUniqueKeyInbox;
     typedef SkTDPQueue<GrGpuResource*, CompareTimestamp, AccessResourceIndex> PurgeableQueue;
     typedef SkTDArray<GrGpuResource*> ResourceArray;

     // Whenever a resource is added to the cache or the result of a cache lookup, fTimestamp is
     // assigned as the resource's timestamp and then incremented. fPurgeableQueue orders the
     // purgeable resources by this value, and thus is used to purge resources in LRU order.
     uint32_t                            fTimestamp;
     PurgeableQueue                      fPurgeableQueue;
     ResourceArray                       fNonpurgeableResources;

     // This map holds all resources that can be used as scratch resources.
     ScratchMap                          fScratchMap;
     // This holds all resources that have unique keys.
     UniqueHash                          fUniqueHash;

     // our budget, used in purgeAsNeeded()
     int                                 fMaxCount;
     size_t                              fMaxBytes;

 #if GR_CACHE_STATS
     int                                 fHighWaterCount;
     size_t                              fHighWaterBytes;
     int                                 fBudgetedHighWaterCount;
     size_t                              fBudgetedHighWaterBytes;
 #endif

     // our current stats for all resources
     SkDEBUGCODE(int                     fCount;)
     size_t                              fBytes;

     // our current stats for resources that count against the budget
     int                                 fBudgetedCount;
     size_t                              fBudgetedBytes;

     PFOverBudgetCB                      fOverBudgetCB;
     void*                               fOverBudgetData;

     InvalidUniqueKeyInbox               fInvalidUniqueKeyInbox;
 };

 class GrResourceCache::ResourceAccess {
 private:
     ResourceAccess(GrResourceCache* cache) : fCache(cache) { }
     ResourceAccess(const ResourceAccess& that) : fCache(that.fCache) { }
     ResourceAccess& operator=(const ResourceAccess&); // unimpl

     /**
      * Insert a resource into the cache.
      */
     void insertResource(GrGpuResource* resource) { fCache->insertResource(resource); }

     /**
      * Removes a resource from the cache.
      */
     void removeResource(GrGpuResource* resource) { fCache->removeResource(resource); }

     /**
      * Called by GrGpuResources when they detects that they are newly purgeable.
      */
     void notifyPurgeable(GrGpuResource* resource) { fCache->notifyPurgeable(resource); }

     /**
      * Called by GrGpuResources when their sizes change.
      */
     void didChangeGpuMemorySize(const GrGpuResource* resource, size_t oldSize) {
         fCache->didChangeGpuMemorySize(resource, oldSize);
     }

     /**
      * Called by GrGpuResources to change their unique keys.
      */
     void changeUniqueKey(GrGpuResource* resource, const GrUniqueKey& newKey) {
          fCache->changeUniqueKey(resource, newKey);
     }

     /**
      * Called by a GrGpuResource to remove its unique key.
      */
     void removeUniqueKey(GrGpuResource* resource) { fCache->removeUniqueKey(resource); }

     /**
      * Called by a GrGpuResource when it removes its scratch key.
      */
     void willRemoveScratchKey(const GrGpuResource* resource) {
         fCache->willRemoveScratchKey(resource);
     }

     /**
      * Called by GrGpuResources when they change from budgeted to unbudgeted or vice versa.
      */
     void didChangeBudgetStatus(GrGpuResource* resource) { fCache->didChangeBudgetStatus(resource); }

     // No taking addresses of this type.
     const ResourceAccess* operator&() const;
     ResourceAccess* operator&();

     GrResourceCache* fCache;

     friend class GrGpuResource; // To access all the proxy inline methods.
     friend class GrResourceCache; // To create this type.
 };

 inline GrResourceCache::ResourceAccess GrResourceCache::resourceAccess() {
     return ResourceAccess(this);
 }

 #endif

	/*
	* Copyright 2014 Google Inc.
	*
	* Use of this source code is governed by a BSD-style license that can be
	* found in the LICENSE file.
	*/

	#ifndef GrResourceCache_DEFINED
	#define GrResourceCache_DEFINED

	#include "GrGpuResource.h"
	#include "GrGpuResourceCacheAccess.h"
	#include "GrGpuResourcePriv.h"
	#include "GrResourceKey.h"
	#include "SkMessageBus.h"
	#include "SkRefCnt.h"
	#include "SkTArray.h"
	#include "SkTDPQueue.h"
	#include "SkTInternalLList.h"
	#include "SkTMultiMap.h"

	class SkString;

	/**
	* Manages the lifetime of all GrGpuResource instances.
	*
	* Resources may have optionally have two types of keys:
	* 1) A scratch key. This is for resources whose allocations are cached but not their contents.
	* Multiple resources can share the same scratch key. This is so a caller can have two
	* resource instances with the same properties (e.g. multipass rendering that ping-pongs
	* between two temporary surfaces). The scratch key is set at resource creation time and
	* should never change. Resources need not have a scratch key.
	* 2) A unique key. This key's meaning is specific to the domain that created the key. Only one
	* resource may have a given unique key. The unique key can be set, cleared, or changed
	* anytime after resource creation.
	*
	* A unique key always takes precedence over a scratch key when a resource has both types of keys.
	* If a resource has neither key type then it will be deleted as soon as the last reference to it
	* is dropped.
	*/
	class GrResourceCache {
	public:
	GrResourceCache();
	~GrResourceCache();

	/** Used to access functionality needed by GrGpuResource for lifetime management. */
	class ResourceAccess;
	ResourceAccess resourceAccess();

	/**
	* Sets the cache limits in terms of number of resources and max gpu memory byte size.
	*/
	void setLimits(int count, size_t bytes);

	/**
	* Returns the number of resources.
	*/
	int getResourceCount() const {
	return fPurgeableQueue.count() + fNonpurgeableResources.count();
	}

	/**
	* Returns the number of resources that count against the budget.
	*/
	int getBudgetedResourceCount() const { return fBudgetedCount; }

	/**
	* Returns the number of bytes consumed by resources.
	*/
	size_t getResourceBytes() const { return fBytes; }

	/**
	* Returns the number of bytes consumed by budgeted resources.
	*/
	size_t getBudgetedResourceBytes() const { return fBudgetedBytes; }

	/**
	* Returns the cached resources count budget.
	*/
	int getMaxResourceCount() const { return fMaxCount; }

	/**
	* Returns the number of bytes consumed by cached resources.
	*/
	size_t getMaxResourceBytes() const { return fMaxBytes; }

	/**
	* Abandons the backend API resources owned by all GrGpuResource objects and removes them from
	* the cache.
	*/
	void abandonAll();

	/**
	* Releases the backend API resources owned by all GrGpuResource objects and removes them from
	* the cache.
	*/
	void releaseAll();

	enum {
	/** Preferentially returns scratch resources with no pending IO. */
	kPreferNoPendingIO_ScratchFlag = 0x1,
	/** Will not return any resources that match but have pending IO. */
	kRequireNoPendingIO_ScratchFlag = 0x2,
	};

	/**
	* Find a resource that matches a scratch key.
	*/
	GrGpuResource* findAndRefScratchResource(const GrScratchKey& scratchKey, uint32_t flags = 0);

	#ifdef SK_DEBUG
	// This is not particularly fast and only used for validation, so debug only.
	int countScratchEntriesForKey(const GrScratchKey& scratchKey) const {
	return fScratchMap.countForKey(scratchKey);
	}
	#endif

	/**
	* Find a resource that matches a unique key.
	*/
	GrGpuResource* findAndRefUniqueResource(const GrUniqueKey& key) {
	GrGpuResource* resource = fUniqueHash.find(key);
	if (resource) {
	this->refAndMakeResourceMRU(resource);
	}
	return resource;
	}

	/**
	* Query whether a unique key exists in the cache.
	*/
	bool hasUniqueKey(const GrUniqueKey& key) const {
	return SkToBool(fUniqueHash.find(key));
	}

	/** Purges resources to become under budget and processes resources with invalidated unique
	keys. */
	void purgeAsNeeded() {
	SkTArray<GrUniqueKeyInvalidatedMessage> invalidKeyMsgs;
	fInvalidUniqueKeyInbox.poll(&invalidKeyMsgs);
	if (invalidKeyMsgs.count()) {
	this->processInvalidUniqueKeys(invalidKeyMsgs);
	}
	if (fBudgetedCount <= fMaxCount && fBudgetedBytes <= fMaxBytes) {
	return;
	}
	this->internalPurgeAsNeeded();
	}

	/** Purges all resources that don't have external owners. */
	void purgeAllUnlocked();

	/**
	* The callback function used by the cache when it is still over budget after a purge. The
	* passed in 'data' is the same 'data' handed to setOverbudgetCallback.
	*/
	typedef void (PFOverBudgetCB)(void data);

	/**
	* Set the callback the cache should use when it is still over budget after a purge. The 'data'
	* provided here will be passed back to the callback. Note that the cache will attempt to purge
	* any resources newly freed by the callback.
	*/
	void setOverBudgetCallback(PFOverBudgetCB overBudgetCB, void* data) {
	fOverBudgetCB = overBudgetCB;
	fOverBudgetData = data;
	}

	#if GR_GPU_STATS
	void dumpStats(SkString*) const;
	#endif

	// This function is for unit testing and is only defined in test tools.
	void changeTimestamp(uint32_t newTimestamp);

	private:
	///////////////////////////////////////////////////////////////////////////
	/// @name Methods accessible via ResourceAccess
	////
	void insertResource(GrGpuResource*);
	void removeResource(GrGpuResource*);
	void notifyPurgeable(GrGpuResource*);
	void didChangeGpuMemorySize(const GrGpuResource*, size_t oldSize);
	void changeUniqueKey(GrGpuResource*, const GrUniqueKey&);
	void removeUniqueKey(GrGpuResource*);
	void willRemoveScratchKey(const GrGpuResource*);
	void didChangeBudgetStatus(GrGpuResource*);
	void refAndMakeResourceMRU(GrGpuResource*);
	/// @}

	void internalPurgeAsNeeded();
	void processInvalidUniqueKeys(const SkTArray<GrUniqueKeyInvalidatedMessage>&);
	void addToNonpurgeableArray(GrGpuResource*);
	void removeFromNonpurgeableArray(GrGpuResource*);
	bool overBudget() const { return fBudgetedBytes > fMaxBytes \|\| fBudgetedCount > fMaxCount; }

	uint32_t getNextTimestamp();

	#ifdef SK_DEBUG
	bool isInCache(const GrGpuResource* r) const;
	void validate() const;
	#else
	void validate() const {}
	#endif

	class AutoValidate;

	class AvailableForScratchUse;

	struct ScratchMapTraits {
	static const GrScratchKey& GetKey(const GrGpuResource& r) {
	return r.resourcePriv().getScratchKey();
	}

	static uint32_t Hash(const GrScratchKey& key) { return key.hash(); }
	};
	typedef SkTMultiMap<GrGpuResource, GrScratchKey, ScratchMapTraits> ScratchMap;

	struct UniqueHashTraits {
	static const GrUniqueKey& GetKey(const GrGpuResource& r) { return r.getUniqueKey(); }

	static uint32_t Hash(const GrUniqueKey& key) { return key.hash(); }
	};
	typedef SkTDynamicHash<GrGpuResource, GrUniqueKey, UniqueHashTraits> UniqueHash;

	static bool CompareTimestamp(GrGpuResource* const& a, GrGpuResource* const& b) {
	return a->cacheAccess().timestamp() < b->cacheAccess().timestamp();
	}

	static int* AccessResourceIndex(GrGpuResource* const& res) {
	return res->cacheAccess().accessCacheIndex();
	}

	typedef SkMessageBus<GrUniqueKeyInvalidatedMessage>::Inbox InvalidUniqueKeyInbox;
	typedef SkTDPQueue<GrGpuResource*, CompareTimestamp, AccessResourceIndex> PurgeableQueue;
	typedef SkTDArray<GrGpuResource*> ResourceArray;

	// Whenever a resource is added to the cache or the result of a cache lookup, fTimestamp is
	// assigned as the resource's timestamp and then incremented. fPurgeableQueue orders the
	// purgeable resources by this value, and thus is used to purge resources in LRU order.
	uint32_t fTimestamp;
	PurgeableQueue fPurgeableQueue;
	ResourceArray fNonpurgeableResources;

	// This map holds all resources that can be used as scratch resources.
	ScratchMap fScratchMap;
	// This holds all resources that have unique keys.
	UniqueHash fUniqueHash;

	// our budget, used in purgeAsNeeded()
	int fMaxCount;
	size_t fMaxBytes;

	#if GR_CACHE_STATS
	int fHighWaterCount;
	size_t fHighWaterBytes;
	int fBudgetedHighWaterCount;
	size_t fBudgetedHighWaterBytes;
	#endif

	// our current stats for all resources
	SkDEBUGCODE(int fCount;)
	size_t fBytes;

	// our current stats for resources that count against the budget
	int fBudgetedCount;
	size_t fBudgetedBytes;

	PFOverBudgetCB fOverBudgetCB;
	void* fOverBudgetData;

	InvalidUniqueKeyInbox fInvalidUniqueKeyInbox;
	};

	class GrResourceCache::ResourceAccess {
	private:
	ResourceAccess(GrResourceCache* cache) : fCache(cache) { }
	ResourceAccess(const ResourceAccess& that) : fCache(that.fCache) { }
	ResourceAccess& operator=(const ResourceAccess&); // unimpl

	/**
	* Insert a resource into the cache.
	*/
	void insertResource(GrGpuResource* resource) { fCache->insertResource(resource); }

	/**
	* Removes a resource from the cache.
	*/
	void removeResource(GrGpuResource* resource) { fCache->removeResource(resource); }

	/**
	* Called by GrGpuResources when they detects that they are newly purgeable.
	*/
	void notifyPurgeable(GrGpuResource* resource) { fCache->notifyPurgeable(resource); }

	/**
	* Called by GrGpuResources when their sizes change.
	*/
	void didChangeGpuMemorySize(const GrGpuResource* resource, size_t oldSize) {
	fCache->didChangeGpuMemorySize(resource, oldSize);
	}

	/**
	* Called by GrGpuResources to change their unique keys.
	*/
	void changeUniqueKey(GrGpuResource* resource, const GrUniqueKey& newKey) {
	fCache->changeUniqueKey(resource, newKey);
	}

	/**
	* Called by a GrGpuResource to remove its unique key.
	*/
	void removeUniqueKey(GrGpuResource* resource) { fCache->removeUniqueKey(resource); }

	/**
	* Called by a GrGpuResource when it removes its scratch key.
	*/
	void willRemoveScratchKey(const GrGpuResource* resource) {
	fCache->willRemoveScratchKey(resource);
	}

	/**
	* Called by GrGpuResources when they change from budgeted to unbudgeted or vice versa.
	*/
	void didChangeBudgetStatus(GrGpuResource* resource) { fCache->didChangeBudgetStatus(resource); }

	// No taking addresses of this type.
	const ResourceAccess* operator&() const;
	ResourceAccess* operator&();

	GrResourceCache* fCache;

	friend class GrGpuResource; // To access all the proxy inline methods.
	friend class GrResourceCache; // To create this type.
	};

	inline GrResourceCache::ResourceAccess GrResourceCache::resourceAccess() {
	return ResourceAccess(this);
	}

	#endif