1 /*
2 * Copyright (C) 2014 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 #include "EglManager.h"
18
19 #include <EGL/eglext.h>
20 #include <GLES/gl.h>
21 #include <cutils/properties.h>
22 #include <log/log.h>
23 #include <sync/sync.h>
24 #include <utils/Trace.h>
25
26 #include <string>
27 #include <vector>
28
29 #include "Frame.h"
30 #include "Properties.h"
31 #include "RenderEffectCapabilityQuery.h"
32 #include "utils/Color.h"
33 #include "utils/StringUtils.h"
34
35 #define GLES_VERSION 2
36
37 // Android-specific addition that is used to show when frames began in systrace
38 EGLAPI void EGLAPIENTRY eglBeginFrame(EGLDisplay dpy, EGLSurface surface);
39
40 namespace android {
41 namespace uirenderer {
42 namespace renderthread {
43
44 #define ERROR_CASE(x) \
45 case x: \
46 return #x;
egl_error_str(EGLint error)47 static const char* egl_error_str(EGLint error) {
48 switch (error) {
49 ERROR_CASE(EGL_SUCCESS)
50 ERROR_CASE(EGL_NOT_INITIALIZED)
51 ERROR_CASE(EGL_BAD_ACCESS)
52 ERROR_CASE(EGL_BAD_ALLOC)
53 ERROR_CASE(EGL_BAD_ATTRIBUTE)
54 ERROR_CASE(EGL_BAD_CONFIG)
55 ERROR_CASE(EGL_BAD_CONTEXT)
56 ERROR_CASE(EGL_BAD_CURRENT_SURFACE)
57 ERROR_CASE(EGL_BAD_DISPLAY)
58 ERROR_CASE(EGL_BAD_MATCH)
59 ERROR_CASE(EGL_BAD_NATIVE_PIXMAP)
60 ERROR_CASE(EGL_BAD_NATIVE_WINDOW)
61 ERROR_CASE(EGL_BAD_PARAMETER)
62 ERROR_CASE(EGL_BAD_SURFACE)
63 ERROR_CASE(EGL_CONTEXT_LOST)
64 default:
65 return "Unknown error";
66 }
67 }
eglErrorString()68 const char* EglManager::eglErrorString() {
69 return egl_error_str(eglGetError());
70 }
71
72 static struct {
73 bool bufferAge = false;
74 bool setDamage = false;
75 bool noConfigContext = false;
76 bool pixelFormatFloat = false;
77 bool glColorSpace = false;
78 bool scRGB = false;
79 bool displayP3 = false;
80 bool hdr = false;
81 bool contextPriority = false;
82 bool surfacelessContext = false;
83 bool nativeFenceSync = false;
84 bool fenceSync = false;
85 bool waitSync = false;
86 } EglExtensions;
87
EglManager()88 EglManager::EglManager()
89 : mEglDisplay(EGL_NO_DISPLAY)
90 , mEglConfig(nullptr)
91 , mEglConfigF16(nullptr)
92 , mEglConfig1010102(nullptr)
93 , mEglContext(EGL_NO_CONTEXT)
94 , mPBufferSurface(EGL_NO_SURFACE)
95 , mCurrentSurface(EGL_NO_SURFACE)
96 , mHasWideColorGamutSupport(false) {}
97
~EglManager()98 EglManager::~EglManager() {
99 if (hasEglContext()) {
100 ALOGW("~EglManager() leaked an EGL context");
101 }
102 }
103
initialize()104 void EglManager::initialize() {
105 if (hasEglContext()) return;
106
107 ATRACE_NAME("Creating EGLContext");
108
109 mEglDisplay = eglGetDisplay(EGL_DEFAULT_DISPLAY);
110 LOG_ALWAYS_FATAL_IF(mEglDisplay == EGL_NO_DISPLAY, "Failed to get EGL_DEFAULT_DISPLAY! err=%s",
111 eglErrorString());
112
113 EGLint major, minor;
114 LOG_ALWAYS_FATAL_IF(eglInitialize(mEglDisplay, &major, &minor) == EGL_FALSE,
115 "Failed to initialize display %p! err=%s", mEglDisplay, eglErrorString());
116
117 ALOGV("Initialized EGL, version %d.%d", (int)major, (int)minor);
118
119 initExtensions();
120
121 // Now that extensions are loaded, pick a swap behavior
122 if (Properties::enablePartialUpdates) {
123 // An Adreno driver bug is causing rendering problems for SkiaGL with
124 // buffer age swap behavior (b/31957043). To temporarily workaround,
125 // we will use preserved swap behavior.
126 if (Properties::useBufferAge && EglExtensions.bufferAge) {
127 mSwapBehavior = SwapBehavior::BufferAge;
128 } else {
129 mSwapBehavior = SwapBehavior::Preserved;
130 }
131 }
132
133 loadConfigs();
134 createContext();
135 createPBufferSurface();
136 makeCurrent(mPBufferSurface, nullptr, /* force */ true);
137
138 skcms_Matrix3x3 wideColorGamut;
139 LOG_ALWAYS_FATAL_IF(!DeviceInfo::get()->getWideColorSpace()->toXYZD50(&wideColorGamut),
140 "Could not get gamut matrix from wideColorSpace");
141 bool hasWideColorSpaceExtension = false;
142 if (memcmp(&wideColorGamut, &SkNamedGamut::kDisplayP3, sizeof(wideColorGamut)) == 0) {
143 hasWideColorSpaceExtension = EglExtensions.displayP3;
144 } else if (memcmp(&wideColorGamut, &SkNamedGamut::kSRGB, sizeof(wideColorGamut)) == 0) {
145 hasWideColorSpaceExtension = EglExtensions.scRGB;
146 } else {
147 LOG_ALWAYS_FATAL("Unsupported wide color space.");
148 }
149 mHasWideColorGamutSupport = EglExtensions.glColorSpace && hasWideColorSpaceExtension;
150
151 auto* vendor = reinterpret_cast<const char*>(glGetString(GL_VENDOR));
152 auto* version = reinterpret_cast<const char*>(glGetString(GL_VERSION));
153 Properties::enableRenderEffectCache = supportsRenderEffectCache(
154 vendor, version);
155 ALOGV("RenderEffectCache supported %d on driver version %s",
156 Properties::enableRenderEffectCache, version);
157 }
158
load8BitsConfig(EGLDisplay display,EglManager::SwapBehavior swapBehavior)159 EGLConfig EglManager::load8BitsConfig(EGLDisplay display, EglManager::SwapBehavior swapBehavior) {
160 EGLint eglSwapBehavior =
161 (swapBehavior == SwapBehavior::Preserved) ? EGL_SWAP_BEHAVIOR_PRESERVED_BIT : 0;
162 EGLint attribs[] = {EGL_RENDERABLE_TYPE,
163 EGL_OPENGL_ES2_BIT,
164 EGL_RED_SIZE,
165 8,
166 EGL_GREEN_SIZE,
167 8,
168 EGL_BLUE_SIZE,
169 8,
170 EGL_ALPHA_SIZE,
171 8,
172 EGL_DEPTH_SIZE,
173 0,
174 EGL_CONFIG_CAVEAT,
175 EGL_NONE,
176 EGL_STENCIL_SIZE,
177 STENCIL_BUFFER_SIZE,
178 EGL_SURFACE_TYPE,
179 EGL_WINDOW_BIT | eglSwapBehavior,
180 EGL_NONE};
181 EGLConfig config = EGL_NO_CONFIG_KHR;
182 EGLint numConfigs = 1;
183 if (!eglChooseConfig(display, attribs, &config, numConfigs, &numConfigs) || numConfigs != 1) {
184 return EGL_NO_CONFIG_KHR;
185 }
186 return config;
187 }
188
load1010102Config(EGLDisplay display,SwapBehavior swapBehavior)189 EGLConfig EglManager::load1010102Config(EGLDisplay display, SwapBehavior swapBehavior) {
190 EGLint eglSwapBehavior =
191 (swapBehavior == SwapBehavior::Preserved) ? EGL_SWAP_BEHAVIOR_PRESERVED_BIT : 0;
192 // If we reached this point, we have a valid swap behavior
193 EGLint attribs[] = {EGL_RENDERABLE_TYPE,
194 EGL_OPENGL_ES2_BIT,
195 EGL_RED_SIZE,
196 10,
197 EGL_GREEN_SIZE,
198 10,
199 EGL_BLUE_SIZE,
200 10,
201 EGL_ALPHA_SIZE,
202 2,
203 EGL_DEPTH_SIZE,
204 0,
205 EGL_STENCIL_SIZE,
206 STENCIL_BUFFER_SIZE,
207 EGL_SURFACE_TYPE,
208 EGL_WINDOW_BIT | eglSwapBehavior,
209 EGL_NONE};
210 EGLConfig config = EGL_NO_CONFIG_KHR;
211 EGLint numConfigs = 1;
212 if (!eglChooseConfig(display, attribs, &config, numConfigs, &numConfigs) || numConfigs != 1) {
213 return EGL_NO_CONFIG_KHR;
214 }
215 return config;
216 }
217
loadFP16Config(EGLDisplay display,SwapBehavior swapBehavior)218 EGLConfig EglManager::loadFP16Config(EGLDisplay display, SwapBehavior swapBehavior) {
219 EGLint eglSwapBehavior =
220 (swapBehavior == SwapBehavior::Preserved) ? EGL_SWAP_BEHAVIOR_PRESERVED_BIT : 0;
221 // If we reached this point, we have a valid swap behavior
222 EGLint attribs[] = {EGL_RENDERABLE_TYPE,
223 EGL_OPENGL_ES2_BIT,
224 EGL_COLOR_COMPONENT_TYPE_EXT,
225 EGL_COLOR_COMPONENT_TYPE_FLOAT_EXT,
226 EGL_RED_SIZE,
227 16,
228 EGL_GREEN_SIZE,
229 16,
230 EGL_BLUE_SIZE,
231 16,
232 EGL_ALPHA_SIZE,
233 16,
234 EGL_DEPTH_SIZE,
235 0,
236 EGL_STENCIL_SIZE,
237 STENCIL_BUFFER_SIZE,
238 EGL_SURFACE_TYPE,
239 EGL_WINDOW_BIT | eglSwapBehavior,
240 EGL_NONE};
241 EGLConfig config = EGL_NO_CONFIG_KHR;
242 EGLint numConfigs = 1;
243 if (!eglChooseConfig(display, attribs, &config, numConfigs, &numConfigs) || numConfigs != 1) {
244 return EGL_NO_CONFIG_KHR;
245 }
246 return config;
247 }
248
initExtensions()249 void EglManager::initExtensions() {
250 auto extensions = StringUtils::split(eglQueryString(mEglDisplay, EGL_EXTENSIONS));
251
252 // For our purposes we don't care if EGL_BUFFER_AGE is a result of
253 // EGL_EXT_buffer_age or EGL_KHR_partial_update as our usage is covered
254 // under EGL_KHR_partial_update and we don't need the expanded scope
255 // that EGL_EXT_buffer_age provides.
256 EglExtensions.bufferAge =
257 extensions.has("EGL_EXT_buffer_age") || extensions.has("EGL_KHR_partial_update");
258 EglExtensions.setDamage = extensions.has("EGL_KHR_partial_update");
259 LOG_ALWAYS_FATAL_IF(!extensions.has("EGL_KHR_swap_buffers_with_damage"),
260 "Missing required extension EGL_KHR_swap_buffers_with_damage");
261
262 EglExtensions.glColorSpace = extensions.has("EGL_KHR_gl_colorspace");
263 EglExtensions.noConfigContext = extensions.has("EGL_KHR_no_config_context");
264 EglExtensions.pixelFormatFloat = extensions.has("EGL_EXT_pixel_format_float");
265 EglExtensions.scRGB = extensions.has("EGL_EXT_gl_colorspace_scrgb");
266 EglExtensions.displayP3 = extensions.has("EGL_EXT_gl_colorspace_display_p3_passthrough");
267 EglExtensions.hdr = extensions.has("EGL_EXT_gl_colorspace_bt2020_pq");
268 EglExtensions.contextPriority = extensions.has("EGL_IMG_context_priority");
269 EglExtensions.surfacelessContext = extensions.has("EGL_KHR_surfaceless_context");
270 EglExtensions.fenceSync = extensions.has("EGL_KHR_fence_sync");
271 EglExtensions.waitSync = extensions.has("EGL_KHR_wait_sync");
272 EglExtensions.nativeFenceSync = extensions.has("EGL_ANDROID_native_fence_sync");
273 }
274
hasEglContext()275 bool EglManager::hasEglContext() {
276 return mEglDisplay != EGL_NO_DISPLAY;
277 }
278
loadConfigs()279 void EglManager::loadConfigs() {
280 // Note: The default pixel format is RGBA_8888, when other formats are
281 // available, we should check the target pixel format and configure the
282 // attributes list properly.
283 mEglConfig = load8BitsConfig(mEglDisplay, mSwapBehavior);
284 if (mEglConfig == EGL_NO_CONFIG_KHR) {
285 if (mSwapBehavior == SwapBehavior::Preserved) {
286 // Try again without dirty regions enabled
287 ALOGW("Failed to choose config with EGL_SWAP_BEHAVIOR_PRESERVED, retrying without...");
288 mSwapBehavior = SwapBehavior::Discard;
289 mEglConfig = load8BitsConfig(mEglDisplay, mSwapBehavior);
290 } else {
291 // Failed to get a valid config
292 LOG_ALWAYS_FATAL("Failed to choose config, error = %s", eglErrorString());
293 }
294 }
295
296 // When we reach this point, we have a valid swap behavior
297 if (EglExtensions.pixelFormatFloat) {
298 mEglConfigF16 = loadFP16Config(mEglDisplay, mSwapBehavior);
299 if (mEglConfigF16 == EGL_NO_CONFIG_KHR) {
300 ALOGE("Device claims wide gamut support, cannot find matching config, error = %s",
301 eglErrorString());
302 EglExtensions.pixelFormatFloat = false;
303 }
304 }
305 mEglConfig1010102 = load1010102Config(mEglDisplay, mSwapBehavior);
306 if (mEglConfig1010102 == EGL_NO_CONFIG_KHR) {
307 ALOGW("Failed to initialize 101010-2 format, error = %s",
308 eglErrorString());
309 }
310 }
311
createContext()312 void EglManager::createContext() {
313 std::vector<EGLint> contextAttributes;
314 contextAttributes.reserve(5);
315 contextAttributes.push_back(EGL_CONTEXT_CLIENT_VERSION);
316 contextAttributes.push_back(GLES_VERSION);
317 if (Properties::contextPriority != 0 && EglExtensions.contextPriority) {
318 contextAttributes.push_back(EGL_CONTEXT_PRIORITY_LEVEL_IMG);
319 contextAttributes.push_back(Properties::contextPriority);
320 }
321 contextAttributes.push_back(EGL_NONE);
322 mEglContext = eglCreateContext(
323 mEglDisplay, EglExtensions.noConfigContext ? ((EGLConfig) nullptr) : mEglConfig,
324 EGL_NO_CONTEXT, contextAttributes.data());
325 LOG_ALWAYS_FATAL_IF(mEglContext == EGL_NO_CONTEXT, "Failed to create context, error = %s",
326 eglErrorString());
327 }
328
createPBufferSurface()329 void EglManager::createPBufferSurface() {
330 LOG_ALWAYS_FATAL_IF(mEglDisplay == EGL_NO_DISPLAY,
331 "usePBufferSurface() called on uninitialized GlobalContext!");
332
333 if (mPBufferSurface == EGL_NO_SURFACE && !EglExtensions.surfacelessContext) {
334 EGLint attribs[] = {EGL_WIDTH, 1, EGL_HEIGHT, 1, EGL_NONE};
335 mPBufferSurface = eglCreatePbufferSurface(mEglDisplay, mEglConfig, attribs);
336 LOG_ALWAYS_FATAL_IF(mPBufferSurface == EGL_NO_SURFACE,
337 "Failed to create a pixel buffer display=%p, "
338 "mEglConfig=%p, error=%s",
339 mEglDisplay, mEglConfig, eglErrorString());
340 }
341 }
342
createSurface(EGLNativeWindowType window,ColorMode colorMode,sk_sp<SkColorSpace> colorSpace)343 Result<EGLSurface, EGLint> EglManager::createSurface(EGLNativeWindowType window,
344 ColorMode colorMode,
345 sk_sp<SkColorSpace> colorSpace) {
346 LOG_ALWAYS_FATAL_IF(!hasEglContext(), "Not initialized");
347
348 if (!mHasWideColorGamutSupport || !EglExtensions.noConfigContext) {
349 colorMode = ColorMode::Default;
350 }
351
352 // The color space we want to use depends on whether linear blending is turned
353 // on and whether the app has requested wide color gamut rendering. When wide
354 // color gamut rendering is off, the app simply renders in the display's native
355 // color gamut.
356 //
357 // When wide gamut rendering is off:
358 // - Blending is done by default in gamma space, which requires using a
359 // linear EGL color space (the GPU uses the color values as is)
360 // - If linear blending is on, we must use the non-linear EGL color space
361 // (the GPU will perform sRGB to linear and linear to SRGB conversions
362 // before and after blending)
363 //
364 // When wide gamut rendering is on we cannot rely on the GPU performing
365 // linear blending for us. We use two different color spaces to tag the
366 // surface appropriately for SurfaceFlinger:
367 // - Gamma blending (default) requires the use of the non-linear color space
368 // - Linear blending requires the use of the linear color space
369
370 // Not all Android targets support the EGL_GL_COLORSPACE_KHR extension
371 // We insert to placeholders to set EGL_GL_COLORSPACE_KHR and its value.
372 // According to section 3.4.1 of the EGL specification, the attributes
373 // list is considered empty if the first entry is EGL_NONE
374 EGLint attribs[] = {EGL_NONE, EGL_NONE, EGL_NONE};
375
376 EGLConfig config = mEglConfig;
377 if (DeviceInfo::get()->getWideColorType() == kRGBA_F16_SkColorType) {
378 if (mEglConfigF16 == EGL_NO_CONFIG_KHR) {
379 colorMode = ColorMode::Default;
380 } else {
381 config = mEglConfigF16;
382 }
383 }
384 if (EglExtensions.glColorSpace) {
385 attribs[0] = EGL_GL_COLORSPACE_KHR;
386 switch (colorMode) {
387 case ColorMode::Default:
388 attribs[1] = EGL_GL_COLORSPACE_LINEAR_KHR;
389 break;
390 case ColorMode::WideColorGamut: {
391 skcms_Matrix3x3 colorGamut;
392 LOG_ALWAYS_FATAL_IF(!colorSpace->toXYZD50(&colorGamut),
393 "Could not get gamut matrix from color space");
394 if (memcmp(&colorGamut, &SkNamedGamut::kDisplayP3, sizeof(colorGamut)) == 0) {
395 attribs[1] = EGL_GL_COLORSPACE_DISPLAY_P3_PASSTHROUGH_EXT;
396 } else if (memcmp(&colorGamut, &SkNamedGamut::kSRGB, sizeof(colorGamut)) == 0) {
397 attribs[1] = EGL_GL_COLORSPACE_SCRGB_EXT;
398 } else if (memcmp(&colorGamut, &SkNamedGamut::kRec2020, sizeof(colorGamut)) == 0) {
399 attribs[1] = EGL_GL_COLORSPACE_BT2020_PQ_EXT;
400 } else {
401 LOG_ALWAYS_FATAL("Unreachable: unsupported wide color space.");
402 }
403 break;
404 }
405 case ColorMode::Hdr:
406 config = mEglConfigF16;
407 attribs[1] = EGL_GL_COLORSPACE_BT2020_PQ_EXT;
408 break;
409 case ColorMode::Hdr10:
410 config = mEglConfig1010102;
411 attribs[1] = EGL_GL_COLORSPACE_BT2020_PQ_EXT;
412 break;
413 }
414 }
415
416 EGLSurface surface = eglCreateWindowSurface(mEglDisplay, config, window, attribs);
417 if (surface == EGL_NO_SURFACE) {
418 return Error<EGLint>{eglGetError()};
419 }
420
421 if (mSwapBehavior != SwapBehavior::Preserved) {
422 LOG_ALWAYS_FATAL_IF(eglSurfaceAttrib(mEglDisplay, surface, EGL_SWAP_BEHAVIOR,
423 EGL_BUFFER_DESTROYED) == EGL_FALSE,
424 "Failed to set swap behavior to destroyed for window %p, eglErr = %s",
425 (void*)window, eglErrorString());
426 }
427
428 return surface;
429 }
430
destroySurface(EGLSurface surface)431 void EglManager::destroySurface(EGLSurface surface) {
432 if (isCurrent(surface)) {
433 makeCurrent(EGL_NO_SURFACE);
434 }
435 if (!eglDestroySurface(mEglDisplay, surface)) {
436 ALOGW("Failed to destroy surface %p, error=%s", (void*)surface, eglErrorString());
437 }
438 }
439
destroy()440 void EglManager::destroy() {
441 if (mEglDisplay == EGL_NO_DISPLAY) return;
442
443 eglDestroyContext(mEglDisplay, mEglContext);
444 if (mPBufferSurface != EGL_NO_SURFACE) {
445 eglDestroySurface(mEglDisplay, mPBufferSurface);
446 }
447 eglMakeCurrent(mEglDisplay, EGL_NO_SURFACE, EGL_NO_SURFACE, EGL_NO_CONTEXT);
448 eglTerminate(mEglDisplay);
449 eglReleaseThread();
450
451 mEglDisplay = EGL_NO_DISPLAY;
452 mEglContext = EGL_NO_CONTEXT;
453 mPBufferSurface = EGL_NO_SURFACE;
454 mCurrentSurface = EGL_NO_SURFACE;
455 }
456
makeCurrent(EGLSurface surface,EGLint * errOut,bool force)457 bool EglManager::makeCurrent(EGLSurface surface, EGLint* errOut, bool force) {
458 if (!force && isCurrent(surface)) return false;
459
460 if (surface == EGL_NO_SURFACE) {
461 // Ensure we always have a valid surface & context
462 surface = mPBufferSurface;
463 }
464 if (!eglMakeCurrent(mEglDisplay, surface, surface, mEglContext)) {
465 if (errOut) {
466 *errOut = eglGetError();
467 ALOGW("Failed to make current on surface %p, error=%s", (void*)surface,
468 egl_error_str(*errOut));
469 } else {
470 LOG_ALWAYS_FATAL("Failed to make current on surface %p, error=%s", (void*)surface,
471 eglErrorString());
472 }
473 }
474 mCurrentSurface = surface;
475 if (Properties::disableVsync) {
476 eglSwapInterval(mEglDisplay, 0);
477 }
478 return true;
479 }
480
queryBufferAge(EGLSurface surface)481 EGLint EglManager::queryBufferAge(EGLSurface surface) {
482 switch (mSwapBehavior) {
483 case SwapBehavior::Discard:
484 return 0;
485 case SwapBehavior::Preserved:
486 return 1;
487 case SwapBehavior::BufferAge:
488 EGLint bufferAge;
489 eglQuerySurface(mEglDisplay, surface, EGL_BUFFER_AGE_EXT, &bufferAge);
490 return bufferAge;
491 }
492 return 0;
493 }
494
beginFrame(EGLSurface surface)495 Frame EglManager::beginFrame(EGLSurface surface) {
496 LOG_ALWAYS_FATAL_IF(surface == EGL_NO_SURFACE, "Tried to beginFrame on EGL_NO_SURFACE!");
497 makeCurrent(surface);
498 Frame frame;
499 frame.mSurface = surface;
500 eglQuerySurface(mEglDisplay, surface, EGL_WIDTH, &frame.mWidth);
501 eglQuerySurface(mEglDisplay, surface, EGL_HEIGHT, &frame.mHeight);
502 frame.mBufferAge = queryBufferAge(surface);
503 eglBeginFrame(mEglDisplay, surface);
504 return frame;
505 }
506
damageFrame(const Frame & frame,const SkRect & dirty)507 void EglManager::damageFrame(const Frame& frame, const SkRect& dirty) {
508 #ifdef EGL_KHR_partial_update
509 if (EglExtensions.setDamage && mSwapBehavior == SwapBehavior::BufferAge) {
510 EGLint rects[4];
511 frame.map(dirty, rects);
512 if (!eglSetDamageRegionKHR(mEglDisplay, frame.mSurface, rects, 1)) {
513 LOG_ALWAYS_FATAL("Failed to set damage region on surface %p, error=%s",
514 (void*)frame.mSurface, eglErrorString());
515 }
516 }
517 #endif
518 }
519
damageRequiresSwap()520 bool EglManager::damageRequiresSwap() {
521 return EglExtensions.setDamage && mSwapBehavior == SwapBehavior::BufferAge;
522 }
523
swapBuffers(const Frame & frame,const SkRect & screenDirty)524 bool EglManager::swapBuffers(const Frame& frame, const SkRect& screenDirty) {
525 if (CC_UNLIKELY(Properties::waitForGpuCompletion)) {
526 ATRACE_NAME("Finishing GPU work");
527 fence();
528 }
529
530 EGLint rects[4];
531 frame.map(screenDirty, rects);
532 eglSwapBuffersWithDamageKHR(mEglDisplay, frame.mSurface, rects, screenDirty.isEmpty() ? 0 : 1);
533
534 EGLint err = eglGetError();
535 if (CC_LIKELY(err == EGL_SUCCESS)) {
536 return true;
537 }
538 if (err == EGL_BAD_SURFACE || err == EGL_BAD_NATIVE_WINDOW) {
539 // For some reason our surface was destroyed out from under us
540 // This really shouldn't happen, but if it does we can recover easily
541 // by just not trying to use the surface anymore
542 ALOGW("swapBuffers encountered EGL error %d on %p, halting rendering...", err,
543 frame.mSurface);
544 return false;
545 }
546 LOG_ALWAYS_FATAL("Encountered EGL error %d %s during rendering", err, egl_error_str(err));
547 // Impossible to hit this, but the compiler doesn't know that
548 return false;
549 }
550
fence()551 void EglManager::fence() {
552 EGLSyncKHR fence = eglCreateSyncKHR(mEglDisplay, EGL_SYNC_FENCE_KHR, NULL);
553 eglClientWaitSyncKHR(mEglDisplay, fence, EGL_SYNC_FLUSH_COMMANDS_BIT_KHR, EGL_FOREVER_KHR);
554 eglDestroySyncKHR(mEglDisplay, fence);
555 }
556
setPreserveBuffer(EGLSurface surface,bool preserve)557 bool EglManager::setPreserveBuffer(EGLSurface surface, bool preserve) {
558 if (mSwapBehavior != SwapBehavior::Preserved) return false;
559
560 bool preserved = eglSurfaceAttrib(mEglDisplay, surface, EGL_SWAP_BEHAVIOR,
561 preserve ? EGL_BUFFER_PRESERVED : EGL_BUFFER_DESTROYED);
562 if (!preserved) {
563 ALOGW("Failed to set EGL_SWAP_BEHAVIOR on surface %p, error=%s", (void*)surface,
564 eglErrorString());
565 // Maybe it's already set?
566 EGLint swapBehavior;
567 if (eglQuerySurface(mEglDisplay, surface, EGL_SWAP_BEHAVIOR, &swapBehavior)) {
568 preserved = (swapBehavior == EGL_BUFFER_PRESERVED);
569 } else {
570 ALOGW("Failed to query EGL_SWAP_BEHAVIOR on surface %p, error=%p", (void*)surface,
571 eglErrorString());
572 }
573 }
574
575 return preserved;
576 }
577
waitForeverOnFence(int fence,const char * logname)578 static status_t waitForeverOnFence(int fence, const char* logname) {
579 ATRACE_CALL();
580 if (fence == -1) {
581 return NO_ERROR;
582 }
583 constexpr int warningTimeout = 3000;
584 int err = sync_wait(fence, warningTimeout);
585 if (err < 0 && errno == ETIME) {
586 ALOGE("%s: fence %d didn't signal in %d ms", logname, fence, warningTimeout);
587 err = sync_wait(fence, -1);
588 }
589 return err < 0 ? -errno : status_t(NO_ERROR);
590 }
591
fenceWait(int fence)592 status_t EglManager::fenceWait(int fence) {
593 if (!hasEglContext()) {
594 ALOGE("EglManager::fenceWait: EGLDisplay not initialized");
595 return INVALID_OPERATION;
596 }
597
598 if (EglExtensions.waitSync && EglExtensions.nativeFenceSync) {
599 // Block GPU on the fence.
600 // Create an EGLSyncKHR from the current fence.
601 int fenceFd = ::dup(fence);
602 if (fenceFd == -1) {
603 ALOGE("EglManager::fenceWait: error dup'ing fence fd: %d", errno);
604 return -errno;
605 }
606 EGLint attribs[] = {EGL_SYNC_NATIVE_FENCE_FD_ANDROID, fenceFd, EGL_NONE};
607 EGLSyncKHR sync = eglCreateSyncKHR(mEglDisplay, EGL_SYNC_NATIVE_FENCE_ANDROID, attribs);
608 if (sync == EGL_NO_SYNC_KHR) {
609 close(fenceFd);
610 ALOGE("EglManager::fenceWait: error creating EGL fence: %#x", eglGetError());
611 return UNKNOWN_ERROR;
612 }
613
614 // XXX: The spec draft is inconsistent as to whether this should
615 // return an EGLint or void. Ignore the return value for now, as
616 // it's not strictly needed.
617 eglWaitSyncKHR(mEglDisplay, sync, 0);
618 EGLint eglErr = eglGetError();
619 eglDestroySyncKHR(mEglDisplay, sync);
620 if (eglErr != EGL_SUCCESS) {
621 ALOGE("EglManager::fenceWait: error waiting for EGL fence: %#x", eglErr);
622 return UNKNOWN_ERROR;
623 }
624 } else {
625 // Block CPU on the fence.
626 status_t err = waitForeverOnFence(fence, "EglManager::fenceWait");
627 if (err != NO_ERROR) {
628 ALOGE("EglManager::fenceWait: error waiting for fence: %d", err);
629 return err;
630 }
631 }
632 return OK;
633 }
634
createReleaseFence(bool useFenceSync,EGLSyncKHR * eglFence,int * nativeFence)635 status_t EglManager::createReleaseFence(bool useFenceSync, EGLSyncKHR* eglFence, int* nativeFence) {
636 *nativeFence = -1;
637 if (!hasEglContext()) {
638 ALOGE("EglManager::createReleaseFence: EGLDisplay not initialized");
639 return INVALID_OPERATION;
640 }
641
642 if (EglExtensions.nativeFenceSync) {
643 EGLSyncKHR sync = eglCreateSyncKHR(mEglDisplay, EGL_SYNC_NATIVE_FENCE_ANDROID, nullptr);
644 if (sync == EGL_NO_SYNC_KHR) {
645 ALOGE("EglManager::createReleaseFence: error creating EGL fence: %#x", eglGetError());
646 return UNKNOWN_ERROR;
647 }
648 glFlush();
649 int fenceFd = eglDupNativeFenceFDANDROID(mEglDisplay, sync);
650 eglDestroySyncKHR(mEglDisplay, sync);
651 if (fenceFd == EGL_NO_NATIVE_FENCE_FD_ANDROID) {
652 ALOGE("EglManager::createReleaseFence: error dup'ing native fence "
653 "fd: %#x",
654 eglGetError());
655 return UNKNOWN_ERROR;
656 }
657 *nativeFence = fenceFd;
658 *eglFence = EGL_NO_SYNC_KHR;
659 } else if (useFenceSync && EglExtensions.fenceSync) {
660 if (*eglFence != EGL_NO_SYNC_KHR) {
661 // There is already a fence for the current slot. We need to
662 // wait on that before replacing it with another fence to
663 // ensure that all outstanding buffer accesses have completed
664 // before the producer accesses it.
665 EGLint result = eglClientWaitSyncKHR(mEglDisplay, *eglFence, 0, 1000000000);
666 if (result == EGL_FALSE) {
667 ALOGE("EglManager::createReleaseFence: error waiting for previous fence: %#x",
668 eglGetError());
669 return UNKNOWN_ERROR;
670 } else if (result == EGL_TIMEOUT_EXPIRED_KHR) {
671 ALOGE("EglManager::createReleaseFence: timeout waiting for previous fence");
672 return TIMED_OUT;
673 }
674 eglDestroySyncKHR(mEglDisplay, *eglFence);
675 }
676
677 // Create a fence for the outstanding accesses in the current
678 // OpenGL ES context.
679 *eglFence = eglCreateSyncKHR(mEglDisplay, EGL_SYNC_FENCE_KHR, nullptr);
680 if (*eglFence == EGL_NO_SYNC_KHR) {
681 ALOGE("EglManager::createReleaseFence: error creating fence: %#x", eglGetError());
682 return UNKNOWN_ERROR;
683 }
684 glFlush();
685 }
686 return OK;
687 }
688
689 } /* namespace renderthread */
690 } /* namespace uirenderer */
691 } /* namespace android */
692