src/gpu/GrResourceCache.h - platform/external/skia - Git at Google


 /*
  * Copyright 2011 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 "GrConfig.h"
 #include "GrTypes.h"
 #include "GrTHashCache.h"
 #include "SkTInternalLList.h"

 class GrResource;

 // return true if a<b, or false if b<a
 //
 #define RET_IF_LT_OR_GT(a, b)   \
     do {                        \
         if ((a) < (b)) {        \
             return true;        \
         }                       \
         if ((b) < (a)) {        \
             return false;       \
         }                       \
     } while (0)

 /**
  *  Helper class for GrResourceCache, the Key is used to identify src data for
  *  a resource. It is identified by 2 32bit data fields which can hold any
  *  data (uninterpreted by the cache) and a width/height.
  */
 class GrResourceKey {
 public:
     enum {
         kHashBits   = 7,
         kHashCount  = 1 << kHashBits,
         kHashMask   = kHashCount - 1
     };

     GrResourceKey(uint32_t p0, uint32_t p1, uint32_t p2, uint32_t p3) {
         fP[0] = p0;
         fP[1] = p1;
         fP[2] = p2;
         fP[3] = p3;
         this->computeHashIndex();
     }

     GrResourceKey(uint32_t v[4]) {
         memcpy(fP, v, 4 * sizeof(uint32_t));
         this->computeHashIndex();
     }

     GrResourceKey(const GrResourceKey& src) {
         memcpy(fP, src.fP, 4 * sizeof(uint32_t));
 #if GR_DEBUG
         this->computeHashIndex();
         GrAssert(fHashIndex == src.fHashIndex);
 #endif
         fHashIndex = src.fHashIndex;
     }

     //!< returns hash value [0..kHashMask] for the key
     int hashIndex() const { return fHashIndex; }

     friend bool operator==(const GrResourceKey& a, const GrResourceKey& b) {
         GR_DEBUGASSERT(-1 != a.fHashIndex && -1 != b.fHashIndex);
         return 0 == memcmp(a.fP, b.fP, 4 * sizeof(uint32_t));
     }

     friend bool operator!=(const GrResourceKey& a, const GrResourceKey& b) {
         GR_DEBUGASSERT(-1 != a.fHashIndex && -1 != b.fHashIndex);
         return !(a == b);
     }

     friend bool operator<(const GrResourceKey& a, const GrResourceKey& b) {
         RET_IF_LT_OR_GT(a.fP[0], b.fP[0]);
         RET_IF_LT_OR_GT(a.fP[1], b.fP[1]);
         RET_IF_LT_OR_GT(a.fP[2], b.fP[2]);
         return a.fP[3] < b.fP[3];
     }

     uint32_t getValue32(int i) const {
         GrAssert(i >=0 && i < 4);
         return fP[i];
     }
 private:

     static uint32_t rol(uint32_t x) {
         return (x >> 24) | (x << 8);
     }
     static uint32_t ror(uint32_t x) {
         return (x >> 8) | (x << 24);
     }
     static uint32_t rohalf(uint32_t x) {
         return (x >> 16) | (x << 16);
     }

     void computeHashIndex() {
         uint32_t hash = fP[0] ^ rol(fP[1]) ^ ror(fP[2]) ^ rohalf(fP[3]);
         // this way to mix and reduce hash to its index may have to change
         // depending on how many bits we allocate to the index
         hash ^= hash >> 16;
         hash ^= hash >> 8;
         fHashIndex = hash & kHashMask;
     }

     uint32_t    fP[4];

     // this is computed from the fP... fields
     int         fHashIndex;

     friend class GrContext;
 };


 ///////////////////////////////////////////////////////////////////////////////

 class GrResourceEntry {
 public:
     GrResource* resource() const { return fResource; }
     const GrResourceKey& key() const { return fKey; }

 #if GR_DEBUG
     void validate() const;
 #else
     void validate() const {}
 #endif

 private:
     GrResourceEntry(const GrResourceKey& key, GrResource* resource);
     ~GrResourceEntry();

     GrResourceKey    fKey;
     GrResource*      fResource;

     // we're a linked list
     SK_DECLARE_INTERNAL_LLIST_INTERFACE(GrResourceEntry);

     friend class GrResourceCache;
     friend class GrDLinkedList;
 };

 ///////////////////////////////////////////////////////////////////////////////

 #include "GrTHashCache.h"

 /**
  *  Cache of GrResource objects.
  *
  *  These have a corresponding GrResourceKey, built from 128bits identifying the
  *  resource.
  *
  *  The cache stores the entries in a double-linked list, which is its LRU.
  *  When an entry is "locked" (i.e. given to the caller), it is moved to the
  *  head of the list. If/when we must purge some of the entries, we walk the
  *  list backwards from the tail, since those are the least recently used.
  *
  *  For fast searches, we maintain a sorted array (based on the GrResourceKey)
  *  which we can bsearch. When a new entry is added, it is inserted into this
  *  array.
  *
  *  For even faster searches, a hash is computed from the Key. If there is
  *  a collision between two keys with the same hash, we fall back on the
  *  bsearch, and update the hash to reflect the most recent Key requested.
  */
 class GrResourceCache {
 public:
     GrResourceCache(int maxCount, size_t maxBytes);
     ~GrResourceCache();

     /**
      *  Return the current resource cache limits.
      *
      *  @param maxResource If non-null, returns maximum number of resources
      *                     that can be held in the cache.
      *  @param maxBytes    If non-null, returns maximum number of bytes of
      *                         gpu memory that can be held in the cache.
      */
     void getLimits(int* maxResources, size_t* maxBytes) const;

     /**
      *  Specify the resource cache limits. If the current cache exceeds either
      *  of these, it will be purged (LRU) to keep the cache within these limits.
      *
      *  @param maxResources The maximum number of resources that can be held in
      *                      the cache.
      *  @param maxBytes     The maximum number of bytes of resource memory that
      *                      can be held in the cache.
      */
     void setLimits(int maxResource, size_t maxResourceBytes);

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

     // For a found or added resource to be completely exclusive to the caller
     // both the kNoOtherOwners and kHide flags need to be specified
     enum OwnershipFlags {
         kNoOtherOwners_OwnershipFlag = 0x1, // found/added resource has no other owners
         kHide_OwnershipFlag = 0x2  // found/added resource is hidden from future 'find's
     };

     /**
      *  Search for an entry with the same Key. If found, return it.
      *  If not found, return null.
      *  If ownershipFlags includes kNoOtherOwners and a resource is returned
      *  then that resource has no other refs to it.
      *  If ownershipFlags includes kHide and a resource is returned then that
      *  resource will not be returned from future 'find' calls until it is
      *  'freed' (and recycled) or makeNonExclusive is called.
      *  For a resource to be completely exclusive to a caller both kNoOtherOwners
      *  and kHide must be specified.
      */
     GrResource* find(const GrResourceKey& key,
                      uint32_t ownershipFlags = 0);

     /**
      *  Add the new resource to the cache (by creating a new cache entry based
      *  on the provided key and resource).
      *
      *  Ownership of the resource is transferred to the resource cache,
      *  which will unref() it when it is purged or deleted.
      *
      *  If ownershipFlags includes kHide, subsequent calls to 'find' will not
      *  return 'resource' until it is 'freed' (and recycled) or makeNonExclusive
      *  is called.
      */
     void addResource(const GrResourceKey& key,
                      GrResource* resource,
                      uint32_t ownershipFlags = 0);

     /**
      * Determines if the cache contains an entry matching a key. If a matching
      * entry exists but was detached then it will not be found.
      */
     bool hasKey(const GrResourceKey& key) const;

     /**
      * Hide 'entry' so that future searches will not find it. Such
      * hidden entries will not be purged. The entry still counts against
      * the cache's budget and should be made non-exclusive when exclusive access
      * is no longer needed.
      */
     void makeExclusive(GrResourceEntry* entry);

     /**
      * Restore 'entry' so that it can be found by future searches. 'entry'
      * will also be purgeable (provided its lock count is now 0.)
      */
     void makeNonExclusive(GrResourceEntry* entry);

     /**
      * Removes every resource in the cache that isn't locked.
      */
     void purgeAllUnlocked();

     /**
      * Allow cache to purge unused resources to obey resource limitations
      * Note: this entry point will be hidden (again) once totally ref-driven
      * cache maintenance is implemented
      */
     void purgeAsNeeded();

 #if GR_DEBUG
     void validate() const;
 #else
     void validate() const {}
 #endif

 #if GR_CACHE_STATS
     void printStats();
 #endif

 private:
     enum BudgetBehaviors {
         kAccountFor_BudgetBehavior,
         kIgnore_BudgetBehavior
     };

     void internalDetach(GrResourceEntry*, BudgetBehaviors behavior = kAccountFor_BudgetBehavior);
     void attachToHead(GrResourceEntry*, BudgetBehaviors behavior = kAccountFor_BudgetBehavior);

     void removeInvalidResource(GrResourceEntry* entry);

     class Key;
     GrTHashTable<GrResourceEntry, Key, 8> fCache;

     // We're an internal doubly linked list
     typedef SkTInternalLList<GrResourceEntry> EntryList;
     EntryList    fList;

 #if GR_DEBUG
     // These objects cannot be returned by a search
     EntryList    fExclusiveList;
 #endif

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

     // our current stats, related to our budget
 #if GR_CACHE_STATS
     int fHighWaterEntryCount;
     size_t fHighWaterEntryBytes;
     int fHighWaterClientDetachedCount;
     size_t fHighWaterClientDetachedBytes;
 #endif

     int fEntryCount;
     size_t fEntryBytes;
     int fClientDetachedCount;
     size_t fClientDetachedBytes;

     // prevents recursive purging
     bool fPurging;

 #if GR_DEBUG
     static size_t countBytes(const SkTInternalLList<GrResourceEntry>& list);
 #endif
 };

 ///////////////////////////////////////////////////////////////////////////////

 #if GR_DEBUG
     class GrAutoResourceCacheValidate {
     public:
         GrAutoResourceCacheValidate(GrResourceCache* cache) : fCache(cache) {
             cache->validate();
         }
         ~GrAutoResourceCacheValidate() {
             fCache->validate();
         }
     private:
         GrResourceCache* fCache;
     };
 #else
     class GrAutoResourceCacheValidate {
     public:
         GrAutoResourceCacheValidate(GrResourceCache*) {}
     };
 #endif

 #endif

	/*
	* Copyright 2011 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 "GrConfig.h"
	#include "GrTypes.h"
	#include "GrTHashCache.h"
	#include "SkTInternalLList.h"

	class GrResource;

	// return true if a<b, or false if b<a
	//
	#define RET_IF_LT_OR_GT(a, b) \
	do { \
	if ((a) < (b)) { \
	return true; \
	} \
	if ((b) < (a)) { \
	return false; \
	} \
	} while (0)

	/**
	* Helper class for GrResourceCache, the Key is used to identify src data for
	* a resource. It is identified by 2 32bit data fields which can hold any
	* data (uninterpreted by the cache) and a width/height.
	*/
	class GrResourceKey {
	public:
	enum {
	kHashBits = 7,
	kHashCount = 1 << kHashBits,
	kHashMask = kHashCount - 1
	};

	GrResourceKey(uint32_t p0, uint32_t p1, uint32_t p2, uint32_t p3) {
	fP[0] = p0;
	fP[1] = p1;
	fP[2] = p2;
	fP[3] = p3;
	this->computeHashIndex();
	}

	GrResourceKey(uint32_t v[4]) {
	memcpy(fP, v, 4 * sizeof(uint32_t));
	this->computeHashIndex();
	}

	GrResourceKey(const GrResourceKey& src) {
	memcpy(fP, src.fP, 4 * sizeof(uint32_t));
	#if GR_DEBUG
	this->computeHashIndex();
	GrAssert(fHashIndex == src.fHashIndex);
	#endif
	fHashIndex = src.fHashIndex;
	}

	//!< returns hash value [0..kHashMask] for the key
	int hashIndex() const { return fHashIndex; }

	friend bool operator==(const GrResourceKey& a, const GrResourceKey& b) {
	GR_DEBUGASSERT(-1 != a.fHashIndex && -1 != b.fHashIndex);
	return 0 == memcmp(a.fP, b.fP, 4 * sizeof(uint32_t));
	}

	friend bool operator!=(const GrResourceKey& a, const GrResourceKey& b) {
	GR_DEBUGASSERT(-1 != a.fHashIndex && -1 != b.fHashIndex);
	return !(a == b);
	}

	friend bool operator<(const GrResourceKey& a, const GrResourceKey& b) {
	RET_IF_LT_OR_GT(a.fP[0], b.fP[0]);
	RET_IF_LT_OR_GT(a.fP[1], b.fP[1]);
	RET_IF_LT_OR_GT(a.fP[2], b.fP[2]);
	return a.fP[3] < b.fP[3];
	}

	uint32_t getValue32(int i) const {
	GrAssert(i >=0 && i < 4);
	return fP[i];
	}
	private:

	static uint32_t rol(uint32_t x) {
	return (x >> 24) \| (x << 8);
	}
	static uint32_t ror(uint32_t x) {
	return (x >> 8) \| (x << 24);
	}
	static uint32_t rohalf(uint32_t x) {
	return (x >> 16) \| (x << 16);
	}

	void computeHashIndex() {
	uint32_t hash = fP[0] ^ rol(fP[1]) ^ ror(fP[2]) ^ rohalf(fP[3]);
	// this way to mix and reduce hash to its index may have to change
	// depending on how many bits we allocate to the index
	hash ^= hash >> 16;
	hash ^= hash >> 8;
	fHashIndex = hash & kHashMask;
	}

	uint32_t fP[4];

	// this is computed from the fP... fields
	int fHashIndex;

	friend class GrContext;
	};


	///////////////////////////////////////////////////////////////////////////////

	class GrResourceEntry {
	public:
	GrResource* resource() const { return fResource; }
	const GrResourceKey& key() const { return fKey; }

	#if GR_DEBUG
	void validate() const;
	#else
	void validate() const {}
	#endif

	private:
	GrResourceEntry(const GrResourceKey& key, GrResource* resource);
	~GrResourceEntry();

	GrResourceKey fKey;
	GrResource* fResource;

	// we're a linked list
	SK_DECLARE_INTERNAL_LLIST_INTERFACE(GrResourceEntry);

	friend class GrResourceCache;
	friend class GrDLinkedList;
	};

	///////////////////////////////////////////////////////////////////////////////

	#include "GrTHashCache.h"

	/**
	* Cache of GrResource objects.
	*
	* These have a corresponding GrResourceKey, built from 128bits identifying the
	* resource.
	*
	* The cache stores the entries in a double-linked list, which is its LRU.
	* When an entry is "locked" (i.e. given to the caller), it is moved to the
	* head of the list. If/when we must purge some of the entries, we walk the
	* list backwards from the tail, since those are the least recently used.
	*
	* For fast searches, we maintain a sorted array (based on the GrResourceKey)
	* which we can bsearch. When a new entry is added, it is inserted into this
	* array.
	*
	* For even faster searches, a hash is computed from the Key. If there is
	* a collision between two keys with the same hash, we fall back on the
	* bsearch, and update the hash to reflect the most recent Key requested.
	*/
	class GrResourceCache {
	public:
	GrResourceCache(int maxCount, size_t maxBytes);
	~GrResourceCache();

	/**
	* Return the current resource cache limits.
	*
	* @param maxResource If non-null, returns maximum number of resources
	* that can be held in the cache.
	* @param maxBytes If non-null, returns maximum number of bytes of
	* gpu memory that can be held in the cache.
	*/
	void getLimits(int* maxResources, size_t* maxBytes) const;

	/**
	* Specify the resource cache limits. If the current cache exceeds either
	* of these, it will be purged (LRU) to keep the cache within these limits.
	*
	* @param maxResources The maximum number of resources that can be held in
	* the cache.
	* @param maxBytes The maximum number of bytes of resource memory that
	* can be held in the cache.
	*/
	void setLimits(int maxResource, size_t maxResourceBytes);

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

	// For a found or added resource to be completely exclusive to the caller
	// both the kNoOtherOwners and kHide flags need to be specified
	enum OwnershipFlags {
	kNoOtherOwners_OwnershipFlag = 0x1, // found/added resource has no other owners
	kHide_OwnershipFlag = 0x2 // found/added resource is hidden from future 'find's
	};

	/**
	* Search for an entry with the same Key. If found, return it.
	* If not found, return null.
	* If ownershipFlags includes kNoOtherOwners and a resource is returned
	* then that resource has no other refs to it.
	* If ownershipFlags includes kHide and a resource is returned then that
	* resource will not be returned from future 'find' calls until it is
	* 'freed' (and recycled) or makeNonExclusive is called.
	* For a resource to be completely exclusive to a caller both kNoOtherOwners
	* and kHide must be specified.
	*/
	GrResource* find(const GrResourceKey& key,
	uint32_t ownershipFlags = 0);

	/**
	* Add the new resource to the cache (by creating a new cache entry based
	* on the provided key and resource).
	*
	* Ownership of the resource is transferred to the resource cache,
	* which will unref() it when it is purged or deleted.
	*
	* If ownershipFlags includes kHide, subsequent calls to 'find' will not
	* return 'resource' until it is 'freed' (and recycled) or makeNonExclusive
	* is called.
	*/
	void addResource(const GrResourceKey& key,
	GrResource* resource,
	uint32_t ownershipFlags = 0);

	/**
	* Determines if the cache contains an entry matching a key. If a matching
	* entry exists but was detached then it will not be found.
	*/
	bool hasKey(const GrResourceKey& key) const;

	/**
	* Hide 'entry' so that future searches will not find it. Such
	* hidden entries will not be purged. The entry still counts against
	* the cache's budget and should be made non-exclusive when exclusive access
	* is no longer needed.
	*/
	void makeExclusive(GrResourceEntry* entry);

	/**
	* Restore 'entry' so that it can be found by future searches. 'entry'
	* will also be purgeable (provided its lock count is now 0.)
	*/
	void makeNonExclusive(GrResourceEntry* entry);

	/**
	* Removes every resource in the cache that isn't locked.
	*/
	void purgeAllUnlocked();

	/**
	* Allow cache to purge unused resources to obey resource limitations
	* Note: this entry point will be hidden (again) once totally ref-driven
	* cache maintenance is implemented
	*/
	void purgeAsNeeded();

	#if GR_DEBUG
	void validate() const;
	#else
	void validate() const {}
	#endif

	#if GR_CACHE_STATS
	void printStats();
	#endif

	private:
	enum BudgetBehaviors {
	kAccountFor_BudgetBehavior,
	kIgnore_BudgetBehavior
	};

	void internalDetach(GrResourceEntry*, BudgetBehaviors behavior = kAccountFor_BudgetBehavior);
	void attachToHead(GrResourceEntry*, BudgetBehaviors behavior = kAccountFor_BudgetBehavior);

	void removeInvalidResource(GrResourceEntry* entry);

	class Key;
	GrTHashTable<GrResourceEntry, Key, 8> fCache;

	// We're an internal doubly linked list
	typedef SkTInternalLList<GrResourceEntry> EntryList;
	EntryList fList;

	#if GR_DEBUG
	// These objects cannot be returned by a search
	EntryList fExclusiveList;
	#endif

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

	// our current stats, related to our budget
	#if GR_CACHE_STATS
	int fHighWaterEntryCount;
	size_t fHighWaterEntryBytes;
	int fHighWaterClientDetachedCount;
	size_t fHighWaterClientDetachedBytes;
	#endif

	int fEntryCount;
	size_t fEntryBytes;
	int fClientDetachedCount;
	size_t fClientDetachedBytes;

	// prevents recursive purging
	bool fPurging;

	#if GR_DEBUG
	static size_t countBytes(const SkTInternalLList<GrResourceEntry>& list);
	#endif
	};

	///////////////////////////////////////////////////////////////////////////////

	#if GR_DEBUG
	class GrAutoResourceCacheValidate {
	public:
	GrAutoResourceCacheValidate(GrResourceCache* cache) : fCache(cache) {
	cache->validate();
	}
	~GrAutoResourceCacheValidate() {
	fCache->validate();
	}
	private:
	GrResourceCache* fCache;
	};
	#else
	class GrAutoResourceCacheValidate {
	public:
	GrAutoResourceCacheValidate(GrResourceCache*) {}
	};
	#endif

	#endif