Robert Phillips | 26f3aeb | 2020-09-16 10:57:32 -0400 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2020 Google Inc. |
| 3 | * |
| 4 | * Use of this source code is governed by a BSD-style license that can be |
| 5 | * found in the LICENSE file. |
| 6 | */ |
| 7 | |
| 8 | #ifndef GrThreadSafeUniquelyKeyedProxyViewCache_DEFINED |
| 9 | #define GrThreadSafeUniquelyKeyedProxyViewCache_DEFINED |
| 10 | |
| 11 | #include "include/private/SkSpinlock.h" |
Robert Phillips | f3e2b3c | 2020-09-18 14:07:43 -0400 | [diff] [blame] | 12 | #include "src/core/SkArenaAlloc.h" |
Robert Phillips | 752f7e1 | 2020-09-18 12:28:59 -0400 | [diff] [blame] | 13 | #include "src/core/SkTDynamicHash.h" |
Robert Phillips | 4559368 | 2020-09-18 16:16:33 -0400 | [diff] [blame] | 14 | #include "src/core/SkTInternalLList.h" |
Robert Phillips | 26f3aeb | 2020-09-16 10:57:32 -0400 | [diff] [blame] | 15 | #include "src/gpu/GrSurfaceProxyView.h" |
| 16 | |
| 17 | // Ganesh creates a lot of utility textures (e.g., blurred-rrect masks) that need to be shared |
| 18 | // between the direct context and all the DDL recording contexts. This thread-safe cache |
| 19 | // allows this sharing. |
| 20 | // |
| 21 | // In operation, each thread will first check if the threaded cache possesses the required texture. |
| 22 | // |
| 23 | // If a DDL thread doesn't find a needed texture it will go off and create it on the cpu and then |
| 24 | // attempt to add it to the cache. If another thread had added it in the interim, the losing thread |
| 25 | // will discard its work and use the texture the winning thread had created. |
| 26 | // |
| 27 | // If the thread in possession of the direct context doesn't find the needed texture it should |
| 28 | // add a place holder view and then queue up the draw calls to complete it. In this way the |
| 29 | // gpu-thread has precedence over the recording threads. |
| 30 | // |
| 31 | // The invariants for this cache differ a bit from those of the proxy and resource caches. |
| 32 | // For this cache: |
| 33 | // |
| 34 | // only this cache knows the unique key - neither the proxy nor backing resource should |
| 35 | // be discoverable in any other cache by the unique key |
| 36 | // if a backing resource resides in the resource cache then there should be an entry in this |
| 37 | // cache |
| 38 | // an entry in this cache, however, doesn't guarantee that there is a corresponding entry in |
| 39 | // the resource cache - although the entry here should be able to generate that entry |
| 40 | // (i.e., be a lazy proxy) |
Robert Phillips | c61c895 | 2020-09-22 14:24:43 -0400 | [diff] [blame] | 41 | // |
| 42 | // Wrt interactions w/ GrContext/GrResourceCache purging, we have: |
| 43 | // |
| 44 | // Both GrContext::abandonContext and GrContext::releaseResourcesAndAbandonContext will cause |
| 45 | // all the refs held in this cache to be dropped prior to clearing out the resource cache. |
| 46 | // |
| 47 | // For the size_t-variant of GrContext::purgeUnlockedResources, after an initial attempt |
| 48 | // to purge the requested amount of resources fails, uniquely held resources in this cache |
| 49 | // will be dropped in LRU to MRU order until the cache is under budget. Note that this |
| 50 | // prioritizes the survival of resources in this cache over those just in the resource cache. |
Robert Phillips | 331699c | 2020-09-22 15:20:01 -0400 | [diff] [blame] | 51 | // |
| 52 | // For the 'scratchResourcesOnly' variant of GrContext::purgeUnlockedResources, this cache |
| 53 | // won't be modified in the scratch-only case unless the resource cache is over budget (in |
| 54 | // which case it will purge uniquely-held resources in LRU to MRU order to get |
| 55 | // back under budget). In the non-scratch-only case, all uniquely held resources in this cache |
| 56 | // will be released prior to the resource cache being cleared out. |
| 57 | // |
| 58 | // For GrContext::setResourceCacheLimit, if an initial pass through the resource cache doesn't |
| 59 | // reach the budget, uniquely held resources in this cache will be released in LRU to MRU order. |
Robert Phillips | c2fe164 | 2020-09-22 17:34:51 -0400 | [diff] [blame] | 60 | // |
| 61 | // For GrContext::performDeferredCleanup, any uniquely held resources that haven't been accessed |
| 62 | // w/in 'msNotUsed' will be released from this cache prior to the resource cache being cleaned. |
Robert Phillips | 26f3aeb | 2020-09-16 10:57:32 -0400 | [diff] [blame] | 63 | class GrThreadSafeUniquelyKeyedProxyViewCache { |
| 64 | public: |
| 65 | GrThreadSafeUniquelyKeyedProxyViewCache(); |
| 66 | ~GrThreadSafeUniquelyKeyedProxyViewCache(); |
| 67 | |
| 68 | #if GR_TEST_UTILS |
| 69 | int numEntries() const SK_EXCLUDES(fSpinLock); |
Robert Phillips | c61c895 | 2020-09-22 14:24:43 -0400 | [diff] [blame] | 70 | |
| 71 | size_t approxBytesUsedForHash() const SK_EXCLUDES(fSpinLock); |
Robert Phillips | 26f3aeb | 2020-09-16 10:57:32 -0400 | [diff] [blame] | 72 | #endif |
| 73 | |
Robert Phillips | 752f7e1 | 2020-09-18 12:28:59 -0400 | [diff] [blame] | 74 | void dropAllRefs() SK_EXCLUDES(fSpinLock); |
Robert Phillips | 331699c | 2020-09-22 15:20:01 -0400 | [diff] [blame] | 75 | |
Robert Phillips | c2fe164 | 2020-09-22 17:34:51 -0400 | [diff] [blame] | 76 | // Drop uniquely held refs until under the resource cache's budget. |
| 77 | // A null parameter means drop all uniquely held refs. |
Robert Phillips | 331699c | 2020-09-22 15:20:01 -0400 | [diff] [blame] | 78 | void dropUniqueRefs(GrResourceCache* resourceCache) SK_EXCLUDES(fSpinLock); |
Robert Phillips | 26f3aeb | 2020-09-16 10:57:32 -0400 | [diff] [blame] | 79 | |
Robert Phillips | c2fe164 | 2020-09-22 17:34:51 -0400 | [diff] [blame] | 80 | // Drop uniquely held refs that were last accessed before 'purgeTime' |
| 81 | void dropUniqueRefsOlderThan(GrStdSteadyClock::time_point purgeTime) SK_EXCLUDES(fSpinLock); |
| 82 | |
Robert Phillips | 26f3aeb | 2020-09-16 10:57:32 -0400 | [diff] [blame] | 83 | GrSurfaceProxyView find(const GrUniqueKey&) SK_EXCLUDES(fSpinLock); |
Robert Phillips | 6e17ffe | 2020-10-06 14:52:11 -0400 | [diff] [blame] | 84 | std::tuple<GrSurfaceProxyView, sk_sp<SkData>> findWithData( |
| 85 | const GrUniqueKey&) SK_EXCLUDES(fSpinLock); |
Robert Phillips | 26f3aeb | 2020-09-16 10:57:32 -0400 | [diff] [blame] | 86 | |
| 87 | GrSurfaceProxyView add(const GrUniqueKey&, const GrSurfaceProxyView&) SK_EXCLUDES(fSpinLock); |
Robert Phillips | 6e17ffe | 2020-10-06 14:52:11 -0400 | [diff] [blame] | 88 | std::tuple<GrSurfaceProxyView, sk_sp<SkData>> addWithData( |
| 89 | const GrUniqueKey&, const GrSurfaceProxyView&) SK_EXCLUDES(fSpinLock); |
Robert Phillips | 26f3aeb | 2020-09-16 10:57:32 -0400 | [diff] [blame] | 90 | |
Robert Phillips | 3380be9 | 2020-09-25 12:47:10 -0400 | [diff] [blame] | 91 | GrSurfaceProxyView findOrAdd(const GrUniqueKey&, |
| 92 | const GrSurfaceProxyView&) SK_EXCLUDES(fSpinLock); |
Robert Phillips | 6e17ffe | 2020-10-06 14:52:11 -0400 | [diff] [blame] | 93 | std::tuple<GrSurfaceProxyView, sk_sp<SkData>> findOrAddWithData( |
| 94 | const GrUniqueKey&, const GrSurfaceProxyView&) SK_EXCLUDES(fSpinLock); |
Robert Phillips | 3380be9 | 2020-09-25 12:47:10 -0400 | [diff] [blame] | 95 | |
| 96 | void remove(const GrUniqueKey&) SK_EXCLUDES(fSpinLock); |
| 97 | |
Robert Phillips | b180712 | 2020-10-06 16:44:18 -0400 | [diff] [blame^] | 98 | // To allow gpu-created resources to have priority, we pre-emptively place a lazy proxy |
| 99 | // in the thread-safe cache (with findOrAdd). The Trampoline object allows that lazy proxy to |
| 100 | // be instantiated with some later generated rendering result. |
| 101 | class Trampoline : public SkRefCnt { |
| 102 | public: |
| 103 | sk_sp<GrTextureProxy> fProxy; |
| 104 | }; |
| 105 | |
| 106 | static std::tuple<GrSurfaceProxyView, sk_sp<Trampoline>> CreateLazyView(GrDirectContext*, |
| 107 | SkISize dimensions, |
| 108 | GrColorType, |
| 109 | GrSurfaceOrigin); |
Robert Phillips | 26f3aeb | 2020-09-16 10:57:32 -0400 | [diff] [blame] | 110 | private: |
| 111 | struct Entry { |
| 112 | Entry(const GrUniqueKey& key, const GrSurfaceProxyView& view) : fKey(key), fView(view) {} |
| 113 | |
| 114 | // Note: the unique key is stored here bc it is never attached to a proxy or a GrTexture |
Robert Phillips | c2fe164 | 2020-09-22 17:34:51 -0400 | [diff] [blame] | 115 | GrUniqueKey fKey; |
| 116 | GrSurfaceProxyView fView; |
| 117 | GrStdSteadyClock::time_point fLastAccess; |
Robert Phillips | 4559368 | 2020-09-18 16:16:33 -0400 | [diff] [blame] | 118 | |
| 119 | SK_DECLARE_INTERNAL_LLIST_INTERFACE(Entry); |
Robert Phillips | 752f7e1 | 2020-09-18 12:28:59 -0400 | [diff] [blame] | 120 | |
| 121 | // for SkTDynamicHash |
| 122 | static const GrUniqueKey& GetKey(const Entry& e) { return e.fKey; } |
| 123 | static uint32_t Hash(const GrUniqueKey& key) { return key.hash(); } |
Robert Phillips | 26f3aeb | 2020-09-16 10:57:32 -0400 | [diff] [blame] | 124 | }; |
| 125 | |
Robert Phillips | 4559368 | 2020-09-18 16:16:33 -0400 | [diff] [blame] | 126 | Entry* getEntry(const GrUniqueKey&, const GrSurfaceProxyView&) SK_REQUIRES(fSpinLock); |
| 127 | void recycleEntry(Entry*) SK_REQUIRES(fSpinLock); |
Robert Phillips | f3e2b3c | 2020-09-18 14:07:43 -0400 | [diff] [blame] | 128 | |
Robert Phillips | 6e17ffe | 2020-10-06 14:52:11 -0400 | [diff] [blame] | 129 | std::tuple<GrSurfaceProxyView, sk_sp<SkData>> internalFind( |
| 130 | const GrUniqueKey&) SK_REQUIRES(fSpinLock); |
| 131 | std::tuple<GrSurfaceProxyView, sk_sp<SkData>> internalAdd( |
| 132 | const GrUniqueKey&, const GrSurfaceProxyView&) SK_REQUIRES(fSpinLock); |
Robert Phillips | 26f3aeb | 2020-09-16 10:57:32 -0400 | [diff] [blame] | 133 | |
| 134 | mutable SkSpinlock fSpinLock; |
| 135 | |
Robert Phillips | 4559368 | 2020-09-18 16:16:33 -0400 | [diff] [blame] | 136 | SkTDynamicHash<Entry, GrUniqueKey> fUniquelyKeyedProxyViewMap SK_GUARDED_BY(fSpinLock); |
| 137 | // The head of this list is the MRU |
| 138 | SkTInternalLList<Entry> fUniquelyKeyedProxyViewList SK_GUARDED_BY(fSpinLock); |
Robert Phillips | f3e2b3c | 2020-09-18 14:07:43 -0400 | [diff] [blame] | 139 | |
| 140 | // TODO: empirically determine this from the skps |
| 141 | static const int kInitialArenaSize = 64 * sizeof(Entry); |
| 142 | |
| 143 | char fStorage[kInitialArenaSize]; |
| 144 | SkArenaAlloc fEntryAllocator{fStorage, kInitialArenaSize, kInitialArenaSize}; |
Robert Phillips | 4559368 | 2020-09-18 16:16:33 -0400 | [diff] [blame] | 145 | Entry* fFreeEntryList SK_GUARDED_BY(fSpinLock); |
Robert Phillips | 26f3aeb | 2020-09-16 10:57:32 -0400 | [diff] [blame] | 146 | }; |
| 147 | |
| 148 | #endif // GrThreadSafeUniquelyKeyedProxyViewCache_DEFINED |