1 /*
2 * Copyright 2011 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 #include "include/core/SkTraceMemoryDump.h"
9 #include "include/gpu/GrDirectContext.h"
10 #include "src/gpu/GrDirectContextPriv.h"
11 #include "src/gpu/GrGpu.h"
12 #include "src/gpu/GrGpuResource.h"
13 #include "src/gpu/GrGpuResourcePriv.h"
14 #include "src/gpu/GrResourceCache.h"
15 #include <atomic>
16
get_resource_cache(GrGpu * gpu)17 static inline GrResourceCache* get_resource_cache(GrGpu* gpu) {
18 SkASSERT(gpu);
19 SkASSERT(gpu->getContext());
20 SkASSERT(gpu->getContext()->priv().getResourceCache());
21 return gpu->getContext()->priv().getResourceCache();
22 }
23
GrGpuResource(GrGpu * gpu)24 GrGpuResource::GrGpuResource(GrGpu* gpu) : fGpu(gpu), fUniqueID(CreateUniqueID()) {
25 SkDEBUGCODE(fCacheArrayIndex = -1);
26 }
27
registerWithCache(SkBudgeted budgeted)28 void GrGpuResource::registerWithCache(SkBudgeted budgeted) {
29 SkASSERT(fBudgetedType == GrBudgetedType::kUnbudgetedUncacheable);
30 fBudgetedType = budgeted == SkBudgeted::kYes ? GrBudgetedType::kBudgeted
31 : GrBudgetedType::kUnbudgetedUncacheable;
32 this->computeScratchKey(&fScratchKey);
33 get_resource_cache(fGpu)->resourceAccess().insertResource(this);
34 }
35
registerWithCacheWrapped(GrWrapCacheable wrapType)36 void GrGpuResource::registerWithCacheWrapped(GrWrapCacheable wrapType) {
37 SkASSERT(fBudgetedType == GrBudgetedType::kUnbudgetedUncacheable);
38 // Resources referencing wrapped objects are never budgeted. They may be cached or uncached.
39 fBudgetedType = wrapType == GrWrapCacheable::kNo ? GrBudgetedType::kUnbudgetedUncacheable
40 : GrBudgetedType::kUnbudgetedCacheable;
41 fRefsWrappedObjects = true;
42 get_resource_cache(fGpu)->resourceAccess().insertResource(this);
43 }
44
~GrGpuResource()45 GrGpuResource::~GrGpuResource() {
46 // The cache should have released or destroyed this resource.
47 SkASSERT(this->wasDestroyed());
48 }
49
release()50 void GrGpuResource::release() {
51 SkASSERT(fGpu);
52 this->onRelease();
53 get_resource_cache(fGpu)->resourceAccess().removeResource(this);
54 fGpu = nullptr;
55 fGpuMemorySize = 0;
56 }
57
abandon()58 void GrGpuResource::abandon() {
59 if (this->wasDestroyed()) {
60 return;
61 }
62 SkASSERT(fGpu);
63 this->onAbandon();
64 get_resource_cache(fGpu)->resourceAccess().removeResource(this);
65 fGpu = nullptr;
66 fGpuMemorySize = 0;
67 }
68
dumpMemoryStatistics(SkTraceMemoryDump * traceMemoryDump) const69 void GrGpuResource::dumpMemoryStatistics(SkTraceMemoryDump* traceMemoryDump) const {
70 if (this->fRefsWrappedObjects && !traceMemoryDump->shouldDumpWrappedObjects()) {
71 return;
72 }
73
74 this->dumpMemoryStatisticsPriv(traceMemoryDump, this->getResourceName(),
75 this->getResourceType(), this->gpuMemorySize());
76 }
77
dumpMemoryStatisticsPriv(SkTraceMemoryDump * traceMemoryDump,const SkString & resourceName,const char * type,size_t size) const78 void GrGpuResource::dumpMemoryStatisticsPriv(SkTraceMemoryDump* traceMemoryDump,
79 const SkString& resourceName,
80 const char* type, size_t size) const {
81 const char* tag = "Scratch";
82 if (fUniqueKey.isValid()) {
83 tag = (fUniqueKey.tag() != nullptr) ? fUniqueKey.tag() : "Other";
84 }
85
86 traceMemoryDump->dumpNumericValue(resourceName.c_str(), "size", "bytes", size);
87 traceMemoryDump->dumpStringValue(resourceName.c_str(), "type", type);
88 traceMemoryDump->dumpStringValue(resourceName.c_str(), "category", tag);
89 if (this->isPurgeable()) {
90 traceMemoryDump->dumpNumericValue(resourceName.c_str(), "purgeable_size", "bytes", size);
91 }
92
93 this->setMemoryBacking(traceMemoryDump, resourceName);
94 }
95
isPurgeable() const96 bool GrGpuResource::isPurgeable() const {
97 // Resources in the kUnbudgetedCacheable state are never purgeable when they have a unique
98 // key. The key must be removed/invalidated to make them purgeable.
99 return !this->hasRef() &&
100 this->hasNoCommandBufferUsages() &&
101 !(fBudgetedType == GrBudgetedType::kUnbudgetedCacheable && fUniqueKey.isValid());
102 }
103
hasRef() const104 bool GrGpuResource::hasRef() const { return this->internalHasRef(); }
105
hasNoCommandBufferUsages() const106 bool GrGpuResource::hasNoCommandBufferUsages() const {
107 return this->internalHasNoCommandBufferUsages();
108 }
109
getResourceName() const110 SkString GrGpuResource::getResourceName() const {
111 // Dump resource as "skia/gpu_resources/resource_#".
112 SkString resourceName("skia/gpu_resources/resource_");
113 resourceName.appendU32(this->uniqueID().asUInt());
114 return resourceName;
115 }
116
getContext() const117 const GrDirectContext* GrGpuResource::getContext() const {
118 if (fGpu) {
119 return fGpu->getContext();
120 } else {
121 return nullptr;
122 }
123 }
124
getContext()125 GrDirectContext* GrGpuResource::getContext() {
126 if (fGpu) {
127 return fGpu->getContext();
128 } else {
129 return nullptr;
130 }
131 }
132
removeUniqueKey()133 void GrGpuResource::removeUniqueKey() {
134 if (this->wasDestroyed()) {
135 return;
136 }
137 SkASSERT(fUniqueKey.isValid());
138 get_resource_cache(fGpu)->resourceAccess().removeUniqueKey(this);
139 }
140
setUniqueKey(const GrUniqueKey & key)141 void GrGpuResource::setUniqueKey(const GrUniqueKey& key) {
142 SkASSERT(this->internalHasRef());
143 SkASSERT(key.isValid());
144
145 // Uncached resources can never have a unique key, unless they're wrapped resources. Wrapped
146 // resources are a special case: the unique keys give us a weak ref so that we can reuse the
147 // same resource (rather than re-wrapping). When a wrapped resource is no longer referenced,
148 // it will always be released - it is never converted to a scratch resource.
149 if (this->resourcePriv().budgetedType() != GrBudgetedType::kBudgeted &&
150 !this->fRefsWrappedObjects) {
151 return;
152 }
153
154 if (this->wasDestroyed()) {
155 return;
156 }
157
158 get_resource_cache(fGpu)->resourceAccess().changeUniqueKey(this, key);
159 }
160
notifyRefCntWillBeZero() const161 void GrGpuResource::notifyRefCntWillBeZero() const {
162 GrGpuResource* mutableThis = const_cast<GrGpuResource*>(this);
163 mutableThis->willRemoveLastRef();
164 }
165
notifyRefCntIsZero() const166 void GrGpuResource::notifyRefCntIsZero() const {
167 if (this->wasDestroyed()) {
168 // We've already been removed from the cache. Goodbye cruel world!
169 delete this;
170 return;
171 }
172
173 GrGpuResource* mutableThis = const_cast<GrGpuResource*>(this);
174
175 get_resource_cache(fGpu)->resourceAccess().notifyRefCntReachedZero(mutableThis);
176 }
177
removeScratchKey()178 void GrGpuResource::removeScratchKey() {
179 if (!this->wasDestroyed() && fScratchKey.isValid()) {
180 get_resource_cache(fGpu)->resourceAccess().willRemoveScratchKey(this);
181 fScratchKey.reset();
182 }
183 }
184
makeBudgeted()185 void GrGpuResource::makeBudgeted() {
186 // We should never make a wrapped resource budgeted.
187 SkASSERT(!fRefsWrappedObjects);
188 // Only wrapped resources can be in the kUnbudgetedCacheable state.
189 SkASSERT(fBudgetedType != GrBudgetedType::kUnbudgetedCacheable);
190 if (!this->wasDestroyed() && fBudgetedType == GrBudgetedType::kUnbudgetedUncacheable) {
191 // Currently resources referencing wrapped objects are not budgeted.
192 fBudgetedType = GrBudgetedType::kBudgeted;
193 get_resource_cache(fGpu)->resourceAccess().didChangeBudgetStatus(this);
194 }
195 }
196
makeUnbudgeted()197 void GrGpuResource::makeUnbudgeted() {
198 if (!this->wasDestroyed() && fBudgetedType == GrBudgetedType::kBudgeted &&
199 !fUniqueKey.isValid()) {
200 fBudgetedType = GrBudgetedType::kUnbudgetedUncacheable;
201 get_resource_cache(fGpu)->resourceAccess().didChangeBudgetStatus(this);
202 }
203 }
204
CreateUniqueID()205 uint32_t GrGpuResource::CreateUniqueID() {
206 static std::atomic<uint32_t> nextID{1};
207 uint32_t id;
208 do {
209 id = nextID.fetch_add(1, std::memory_order_relaxed);
210 } while (id == SK_InvalidUniqueID);
211 return id;
212 }
213
214 //////////////////////////////////////////////////////////////////////////////
215
ref(GrResourceCache * cache)216 void GrGpuResource::ProxyAccess::ref(GrResourceCache* cache) {
217 SkASSERT(cache == fResource->getContext()->priv().getResourceCache());
218 cache->resourceAccess().refResource(fResource);
219 }
220