1 /*
2 ** Copyright 2011, The Android Open Source Project
3 **
4 ** Licensed under the Apache License, Version 2.0 (the "License");
5 ** you may not use this file except in compliance with the License.
6 ** You may obtain a copy of the License at
7 **
8 ** http://www.apache.org/licenses/LICENSE-2.0
9 **
10 ** Unless required by applicable law or agreed to in writing, software
11 ** distributed under the License is distributed on an "AS IS" BASIS,
12 ** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 ** See the License for the specific language governing permissions and
14 ** limitations under the License.
15 */
16
17 // #define LOG_NDEBUG 0
18
19 #include "egl_cache.h"
20
21 #include <android-base/properties.h>
22 #include <inttypes.h>
23 #include <log/log.h>
24 #include <private/EGL/cache.h>
25 #include <unistd.h>
26
27 #include <thread>
28
29 #include "../egl_impl.h"
30 #include "egl_display.h"
31
32 // Monolithic cache size limits.
33 static const size_t kMaxMonolithicKeySize = 12 * 1024;
34 static const size_t kMaxMonolithicValueSize = 64 * 1024;
35 static const size_t kMaxMonolithicTotalSize = 2 * 1024 * 1024;
36
37 // The time in seconds to wait before saving newly inserted monolithic cache entries.
38 static const unsigned int kDeferredMonolithicSaveDelay = 4;
39
40 // Multifile cache size limits
41 constexpr uint32_t kMaxMultifileKeySize = 1 * 1024 * 1024;
42 constexpr uint32_t kMaxMultifileValueSize = 8 * 1024 * 1024;
43 constexpr uint32_t kMaxMultifileTotalSize = 32 * 1024 * 1024;
44
45 namespace android {
46
47 #define BC_EXT_STR "EGL_ANDROID_blob_cache"
48
49 // called from android_view_ThreadedRenderer.cpp
egl_set_cache_filename(const char * filename)50 void egl_set_cache_filename(const char* filename) {
51 egl_cache_t::get()->setCacheFilename(filename);
52 }
53
54 //
55 // Callback functions passed to EGL.
56 //
setBlob(const void * key,EGLsizeiANDROID keySize,const void * value,EGLsizeiANDROID valueSize)57 static void setBlob(const void* key, EGLsizeiANDROID keySize, const void* value,
58 EGLsizeiANDROID valueSize) {
59 egl_cache_t::get()->setBlob(key, keySize, value, valueSize);
60 }
61
getBlob(const void * key,EGLsizeiANDROID keySize,void * value,EGLsizeiANDROID valueSize)62 static EGLsizeiANDROID getBlob(const void* key, EGLsizeiANDROID keySize, void* value,
63 EGLsizeiANDROID valueSize) {
64 return egl_cache_t::get()->getBlob(key, keySize, value, valueSize);
65 }
66
67 //
68 // egl_cache_t definition
69 //
egl_cache_t()70 egl_cache_t::egl_cache_t()
71 : mInitialized(false), mMultifileMode(false), mCacheByteLimit(kMaxMonolithicTotalSize) {}
72
~egl_cache_t()73 egl_cache_t::~egl_cache_t() {}
74
75 egl_cache_t egl_cache_t::sCache;
76
get()77 egl_cache_t* egl_cache_t::get() {
78 return &sCache;
79 }
80
initialize(egl_display_t * display)81 void egl_cache_t::initialize(egl_display_t* display) {
82 std::lock_guard<std::mutex> lock(mMutex);
83
84 egl_connection_t* const cnx = &gEGLImpl;
85 if (display && cnx->dso && cnx->major >= 0 && cnx->minor >= 0) {
86 const char* exts = display->disp.queryString.extensions;
87 size_t bcExtLen = strlen(BC_EXT_STR);
88 size_t extsLen = strlen(exts);
89 bool equal = !strcmp(BC_EXT_STR, exts);
90 bool atStart = !strncmp(BC_EXT_STR " ", exts, bcExtLen + 1);
91 bool atEnd = (bcExtLen + 1) < extsLen &&
92 !strcmp(" " BC_EXT_STR, exts + extsLen - (bcExtLen + 1));
93 bool inMiddle = strstr(exts, " " BC_EXT_STR " ") != nullptr;
94 if (equal || atStart || atEnd || inMiddle) {
95 PFNEGLSETBLOBCACHEFUNCSANDROIDPROC eglSetBlobCacheFuncsANDROID;
96 eglSetBlobCacheFuncsANDROID = reinterpret_cast<PFNEGLSETBLOBCACHEFUNCSANDROIDPROC>(
97 cnx->egl.eglGetProcAddress("eglSetBlobCacheFuncsANDROID"));
98 if (eglSetBlobCacheFuncsANDROID == nullptr) {
99 ALOGE("EGL_ANDROID_blob_cache advertised, "
100 "but unable to get eglSetBlobCacheFuncsANDROID");
101 return;
102 }
103
104 eglSetBlobCacheFuncsANDROID(display->disp.dpy, android::setBlob, android::getBlob);
105 EGLint err = cnx->egl.eglGetError();
106 if (err != EGL_SUCCESS) {
107 ALOGE("eglSetBlobCacheFuncsANDROID resulted in an error: "
108 "%#x",
109 err);
110 }
111 }
112 }
113
114 mInitialized = true;
115 }
116
terminate()117 void egl_cache_t::terminate() {
118 std::lock_guard<std::mutex> lock(mMutex);
119 if (mBlobCache) {
120 mBlobCache->writeToFile();
121 }
122 mBlobCache = nullptr;
123 if (mMultifileBlobCache) {
124 mMultifileBlobCache->finish();
125 }
126 mMultifileBlobCache = nullptr;
127 mInitialized = false;
128 }
129
setBlob(const void * key,EGLsizeiANDROID keySize,const void * value,EGLsizeiANDROID valueSize)130 void egl_cache_t::setBlob(const void* key, EGLsizeiANDROID keySize, const void* value,
131 EGLsizeiANDROID valueSize) {
132 std::lock_guard<std::mutex> lock(mMutex);
133
134 if (keySize < 0 || valueSize < 0) {
135 ALOGW("EGL_ANDROID_blob_cache set: negative sizes are not allowed");
136 return;
137 }
138
139 updateMode();
140
141 if (mInitialized) {
142 if (mMultifileMode) {
143 MultifileBlobCache* mbc = getMultifileBlobCacheLocked();
144 mbc->set(key, keySize, value, valueSize);
145 } else {
146 BlobCache* bc = getBlobCacheLocked();
147 bc->set(key, keySize, value, valueSize);
148
149 if (!mSavePending) {
150 mSavePending = true;
151 std::thread deferredSaveThread([this]() {
152 sleep(kDeferredMonolithicSaveDelay);
153 std::lock_guard<std::mutex> lock(mMutex);
154 if (mInitialized && mBlobCache) {
155 mBlobCache->writeToFile();
156 }
157 mSavePending = false;
158 });
159 deferredSaveThread.detach();
160 }
161 }
162 }
163 }
164
getBlob(const void * key,EGLsizeiANDROID keySize,void * value,EGLsizeiANDROID valueSize)165 EGLsizeiANDROID egl_cache_t::getBlob(const void* key, EGLsizeiANDROID keySize, void* value,
166 EGLsizeiANDROID valueSize) {
167 std::lock_guard<std::mutex> lock(mMutex);
168
169 if (keySize < 0 || valueSize < 0) {
170 ALOGW("EGL_ANDROID_blob_cache get: negative sizes are not allowed");
171 return 0;
172 }
173
174 updateMode();
175
176 if (mInitialized) {
177 if (mMultifileMode) {
178 MultifileBlobCache* mbc = getMultifileBlobCacheLocked();
179 return mbc->get(key, keySize, value, valueSize);
180 } else {
181 BlobCache* bc = getBlobCacheLocked();
182 return bc->get(key, keySize, value, valueSize);
183 }
184 }
185
186 return 0;
187 }
188
setCacheMode(EGLCacheMode cacheMode)189 void egl_cache_t::setCacheMode(EGLCacheMode cacheMode) {
190 mMultifileMode = (cacheMode == EGLCacheMode::Multifile);
191 }
192
setCacheFilename(const char * filename)193 void egl_cache_t::setCacheFilename(const char* filename) {
194 std::lock_guard<std::mutex> lock(mMutex);
195 mFilename = filename;
196 }
197
setCacheLimit(int64_t cacheByteLimit)198 void egl_cache_t::setCacheLimit(int64_t cacheByteLimit) {
199 std::lock_guard<std::mutex> lock(mMutex);
200
201 if (!mMultifileMode) {
202 // If we're not in multifile mode, ensure the cache limit is only being lowered,
203 // not increasing above the hard coded platform limit
204 if (cacheByteLimit > kMaxMonolithicTotalSize) {
205 return;
206 }
207 }
208
209 mCacheByteLimit = cacheByteLimit;
210 }
211
getCacheSize()212 size_t egl_cache_t::getCacheSize() {
213 std::lock_guard<std::mutex> lock(mMutex);
214 if (mMultifileBlobCache) {
215 return mMultifileBlobCache->getTotalSize();
216 }
217 if (mBlobCache) {
218 return mBlobCache->getSize();
219 }
220 return 0;
221 }
222
updateMode()223 void egl_cache_t::updateMode() {
224 // We don't set the mode in the constructor because these checks have
225 // a non-trivial cost, and not all processes that instantiate egl_cache_t
226 // will use it.
227
228 // If we've already set the mode, skip these checks
229 static bool checked = false;
230 if (checked) {
231 return;
232 }
233 checked = true;
234
235 // Check the device config to decide whether multifile should be used
236 if (base::GetBoolProperty("ro.egl.blobcache.multifile", false)) {
237 mMultifileMode = true;
238 ALOGV("Using multifile EGL blobcache");
239 }
240
241 // Allow forcing the mode for debug purposes
242 std::string mode = base::GetProperty("debug.egl.blobcache.multifile", "");
243 if (mode == "true") {
244 ALOGV("Forcing multifile cache due to debug.egl.blobcache.multifile == %s", mode.c_str());
245 mMultifileMode = true;
246 } else if (mode == "false") {
247 ALOGV("Forcing monolithic cache due to debug.egl.blobcache.multifile == %s", mode.c_str());
248 mMultifileMode = false;
249 }
250
251 if (mMultifileMode) {
252 mCacheByteLimit = static_cast<size_t>(
253 base::GetUintProperty<uint32_t>("ro.egl.blobcache.multifile_limit",
254 kMaxMultifileTotalSize));
255
256 // Check for a debug value
257 int debugCacheSize = base::GetIntProperty("debug.egl.blobcache.multifile_limit", -1);
258 if (debugCacheSize >= 0) {
259 ALOGV("Overriding cache limit %zu with %i from debug.egl.blobcache.multifile_limit",
260 mCacheByteLimit, debugCacheSize);
261 mCacheByteLimit = debugCacheSize;
262 }
263
264 ALOGV("Using multifile EGL blobcache limit of %zu bytes", mCacheByteLimit);
265 }
266 }
267
getBlobCacheLocked()268 BlobCache* egl_cache_t::getBlobCacheLocked() {
269 if (mBlobCache == nullptr) {
270 mBlobCache.reset(new FileBlobCache(kMaxMonolithicKeySize, kMaxMonolithicValueSize,
271 mCacheByteLimit, mFilename));
272 }
273 return mBlobCache.get();
274 }
275
getMultifileBlobCacheLocked()276 MultifileBlobCache* egl_cache_t::getMultifileBlobCacheLocked() {
277 if (mMultifileBlobCache == nullptr) {
278 mMultifileBlobCache.reset(new MultifileBlobCache(kMaxMultifileKeySize,
279 kMaxMultifileValueSize, mCacheByteLimit,
280 mFilename));
281 }
282 return mMultifileBlobCache.get();
283 }
284
285 }; // namespace android
286