1 /* 2 * Copyright 2022 Google LLC 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 skgpu_graphite_GlobalCache_DEFINED 9 #define skgpu_graphite_GlobalCache_DEFINED 10 11 #include "include/core/SkRefCnt.h" 12 #include "include/private/base/SkTArray.h" 13 #include "src/base/SkSpinlock.h" 14 #include "src/core/SkLRUCache.h" 15 #include "src/gpu/ResourceKey.h" 16 #include "src/gpu/graphite/GraphicsPipeline.h" 17 18 19 #include <functional> 20 21 namespace skgpu::graphite { 22 23 class ComputePipeline; 24 class GraphicsPipeline; 25 class Resource; 26 class ShaderCodeDictionary; 27 28 /** 29 * GlobalCache holds GPU resources that should be shared by every Recorder. The common requirement 30 * of these resources are they are static/read-only, have long lifetimes, and are likely to be used 31 * by multiple Recorders. The canonical example of this are pipelines. 32 * 33 * GlobalCache is thread safe, but intentionally splits queries and storing operations so that they 34 * are not atomic. The pattern is to query for a resource, which has a high likelihood of a cache 35 * hit. If it's not found, the Recorder creates the resource on its own, without locking the 36 * GlobalCache. After the resource is created, it is added to the GlobalCache, atomically returning 37 * the winning Resource in the event of a race between Recorders for the same UniqueKey. 38 */ 39 class GlobalCache { 40 public: 41 GlobalCache(); 42 ~GlobalCache(); 43 44 void deleteResources(); 45 46 // Find a cached GraphicsPipeline that matches the associated key. 47 sk_sp<GraphicsPipeline> findGraphicsPipeline( 48 const UniqueKey&, 49 SkEnumBitMask<PipelineCreationFlags> = PipelineCreationFlags::kNone, 50 uint32_t* compilationID = nullptr) SK_EXCLUDES(fSpinLock); 51 52 // Associate the given pipeline with the key. If the key has already had a separate pipeline 53 // associated with the key, that pipeline is returned and the passed-in pipeline is discarded. 54 // Otherwise, the passed-in pipeline is held by the GlobalCache and also returned back. 55 sk_sp<GraphicsPipeline> addGraphicsPipeline(const UniqueKey&, 56 sk_sp<GraphicsPipeline>) SK_EXCLUDES(fSpinLock); 57 58 #if defined(GPU_TEST_UTILS) 59 int numGraphicsPipelines() const SK_EXCLUDES(fSpinLock); 60 void resetGraphicsPipelines() SK_EXCLUDES(fSpinLock); 61 void forEachGraphicsPipeline( 62 const std::function<void(const UniqueKey&, const GraphicsPipeline*)>& fn) 63 SK_EXCLUDES(fSpinLock); 64 65 struct PipelineStats { 66 int fGraphicsCacheHits = 0; 67 int fGraphicsCacheMisses = 0; 68 int fGraphicsCacheAdditions = 0; 69 int fGraphicsRaces = 0; 70 }; 71 72 PipelineStats getStats() const SK_EXCLUDES(fSpinLock); 73 #endif 74 75 // Find and add operations for ComputePipelines, with the same pattern as GraphicsPipelines. 76 sk_sp<ComputePipeline> findComputePipeline(const UniqueKey&) SK_EXCLUDES(fSpinLock); 77 sk_sp<ComputePipeline> addComputePipeline(const UniqueKey&, 78 sk_sp<ComputePipeline>) SK_EXCLUDES(fSpinLock); 79 80 // The GlobalCache holds a ref on the given Resource until the cache is destroyed, keeping it 81 // alive for the lifetime of the SharedContext. This should be used only for Resources that are 82 // immutable after initialization so that anyone can use the resource without synchronization 83 // or reference tracking. 84 void addStaticResource(sk_sp<Resource>) SK_EXCLUDES(fSpinLock); 85 86 private: 87 struct KeyHash { operatorKeyHash88 uint32_t operator()(const UniqueKey& key) const { return key.hash(); } 89 }; 90 91 static void LogPurge(const UniqueKey& key, sk_sp<GraphicsPipeline>* p); 92 struct PurgeCB { operatorPurgeCB93 void operator()(const UniqueKey& k, sk_sp<GraphicsPipeline>* p) const { LogPurge(k, p); } 94 }; 95 96 using GraphicsPipelineCache = SkLRUCache<UniqueKey, sk_sp<GraphicsPipeline>, KeyHash, PurgeCB>; 97 using ComputePipelineCache = SkLRUCache<UniqueKey, sk_sp<ComputePipeline>, KeyHash>; 98 99 // TODO: can we do something better given this should have write-seldom/read-often behavior? 100 mutable SkSpinlock fSpinLock; 101 102 // GraphicsPipelines and ComputePipelines are expensive to create, likely to be used by multiple 103 // Recorders, and are ideally pre-compiled on process startup so thread write-contention is 104 // expected to be low. For these reasons we store pipelines globally instead of per-Recorder. 105 GraphicsPipelineCache fGraphicsPipelineCache SK_GUARDED_BY(fSpinLock); 106 ComputePipelineCache fComputePipelineCache SK_GUARDED_BY(fSpinLock); 107 108 skia_private::TArray<sk_sp<Resource>> fStaticResource SK_GUARDED_BY(fSpinLock); 109 110 #if defined(GPU_TEST_UTILS) 111 PipelineStats fStats SK_GUARDED_BY(fSpinLock); 112 #endif 113 }; 114 115 } // namespace skgpu::graphite 116 117 #endif // skgpu_graphite_GlobalCache_DEFINED 118