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