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 <string> 20 21 #include <cutils/properties.h> 22 #include <log/log.h> 23 #include "utils/StringUtils.h" 24 25 #include "Caches.h" 26 #include "DeviceInfo.h" 27 #include "Frame.h" 28 #include "Properties.h" 29 #include "RenderThread.h" 30 #include "Texture.h" 31 #include "renderstate/RenderState.h" 32 33 #include <EGL/eglext.h> 34 #include <GrContextOptions.h> 35 #include <gl/GrGLInterface.h> 36 37 #ifdef HWUI_GLES_WRAP_ENABLED 38 #include "debug/GlesDriver.h" 39 #endif 40 41 #define GLES_VERSION 2 42 43 // Android-specific addition that is used to show when frames began in systrace 44 EGLAPI void EGLAPIENTRY eglBeginFrame(EGLDisplay dpy, EGLSurface surface); 45 46 namespace android { 47 namespace uirenderer { 48 namespace renderthread { 49 50 #define ERROR_CASE(x) \ 51 case x: \ 52 return #x; 53 static const char* egl_error_str(EGLint error) { 54 switch (error) { 55 ERROR_CASE(EGL_SUCCESS) 56 ERROR_CASE(EGL_NOT_INITIALIZED) 57 ERROR_CASE(EGL_BAD_ACCESS) 58 ERROR_CASE(EGL_BAD_ALLOC) 59 ERROR_CASE(EGL_BAD_ATTRIBUTE) 60 ERROR_CASE(EGL_BAD_CONFIG) 61 ERROR_CASE(EGL_BAD_CONTEXT) 62 ERROR_CASE(EGL_BAD_CURRENT_SURFACE) 63 ERROR_CASE(EGL_BAD_DISPLAY) 64 ERROR_CASE(EGL_BAD_MATCH) 65 ERROR_CASE(EGL_BAD_NATIVE_PIXMAP) 66 ERROR_CASE(EGL_BAD_NATIVE_WINDOW) 67 ERROR_CASE(EGL_BAD_PARAMETER) 68 ERROR_CASE(EGL_BAD_SURFACE) 69 ERROR_CASE(EGL_CONTEXT_LOST) 70 default: 71 return "Unknown error"; 72 } 73 } 74 const char* EglManager::eglErrorString() { 75 return egl_error_str(eglGetError()); 76 } 77 78 static struct { 79 bool bufferAge = false; 80 bool setDamage = false; 81 bool noConfigContext = false; 82 bool pixelFormatFloat = false; 83 bool glColorSpace = false; 84 bool scRGB = false; 85 bool contextPriority = false; 86 } EglExtensions; 87 88 EglManager::EglManager(RenderThread& thread) 89 : mRenderThread(thread) 90 , mEglDisplay(EGL_NO_DISPLAY) 91 , mEglConfig(nullptr) 92 , mEglConfigWideGamut(nullptr) 93 , mEglContext(EGL_NO_CONTEXT) 94 , mPBufferSurface(EGL_NO_SURFACE) 95 , mCurrentSurface(EGL_NO_SURFACE) {} 96 97 void EglManager::initialize() { 98 if (hasEglContext()) return; 99 100 ATRACE_NAME("Creating EGLContext"); 101 102 mEglDisplay = eglGetDisplay(EGL_DEFAULT_DISPLAY); 103 LOG_ALWAYS_FATAL_IF(mEglDisplay == EGL_NO_DISPLAY, "Failed to get EGL_DEFAULT_DISPLAY! err=%s", 104 eglErrorString()); 105 106 EGLint major, minor; 107 LOG_ALWAYS_FATAL_IF(eglInitialize(mEglDisplay, &major, &minor) == EGL_FALSE, 108 "Failed to initialize display %p! err=%s", mEglDisplay, eglErrorString()); 109 110 ALOGI("Initialized EGL, version %d.%d", (int)major, (int)minor); 111 112 initExtensions(); 113 114 // Now that extensions are loaded, pick a swap behavior 115 if (Properties::enablePartialUpdates) { 116 // An Adreno driver bug is causing rendering problems for SkiaGL with 117 // buffer age swap behavior (b/31957043). To temporarily workaround, 118 // we will use preserved swap behavior. 119 if (Properties::useBufferAge && EglExtensions.bufferAge) { 120 mSwapBehavior = SwapBehavior::BufferAge; 121 } else { 122 mSwapBehavior = SwapBehavior::Preserved; 123 } 124 } 125 126 loadConfigs(); 127 createContext(); 128 createPBufferSurface(); 129 makeCurrent(mPBufferSurface); 130 DeviceInfo::initialize(); 131 mRenderThread.renderState().onGLContextCreated(); 132 133 if (Properties::getRenderPipelineType() == RenderPipelineType::SkiaGL) { 134 #ifdef HWUI_GLES_WRAP_ENABLED 135 debug::GlesDriver* driver = debug::GlesDriver::get(); 136 sk_sp<const GrGLInterface> glInterface(driver->getSkiaInterface()); 137 #else 138 sk_sp<const GrGLInterface> glInterface(GrGLCreateNativeInterface()); 139 #endif 140 LOG_ALWAYS_FATAL_IF(!glInterface.get()); 141 142 GrContextOptions options; 143 options.fDisableDistanceFieldPaths = true; 144 mRenderThread.cacheManager().configureContext(&options); 145 sk_sp<GrContext> grContext(GrContext::MakeGL(std::move(glInterface), options)); 146 LOG_ALWAYS_FATAL_IF(!grContext.get()); 147 mRenderThread.setGrContext(grContext); 148 } 149 } 150 151 void EglManager::initExtensions() { 152 auto extensions = StringUtils::split(eglQueryString(mEglDisplay, EGL_EXTENSIONS)); 153 154 // For our purposes we don't care if EGL_BUFFER_AGE is a result of 155 // EGL_EXT_buffer_age or EGL_KHR_partial_update as our usage is covered 156 // under EGL_KHR_partial_update and we don't need the expanded scope 157 // that EGL_EXT_buffer_age provides. 158 EglExtensions.bufferAge = 159 extensions.has("EGL_EXT_buffer_age") || extensions.has("EGL_KHR_partial_update"); 160 EglExtensions.setDamage = extensions.has("EGL_KHR_partial_update"); 161 LOG_ALWAYS_FATAL_IF(!extensions.has("EGL_KHR_swap_buffers_with_damage"), 162 "Missing required extension EGL_KHR_swap_buffers_with_damage"); 163 164 EglExtensions.glColorSpace = extensions.has("EGL_KHR_gl_colorspace"); 165 EglExtensions.noConfigContext = extensions.has("EGL_KHR_no_config_context"); 166 EglExtensions.pixelFormatFloat = extensions.has("EGL_EXT_pixel_format_float"); 167 #ifdef ANDROID_ENABLE_LINEAR_BLENDING 168 EglExtensions.scRGB = extensions.has("EGL_EXT_gl_colorspace_scrgb_linear"); 169 #else 170 EglExtensions.scRGB = extensions.has("EGL_EXT_gl_colorspace_scrgb"); 171 #endif 172 EglExtensions.contextPriority = extensions.has("EGL_IMG_context_priority"); 173 } 174 175 bool EglManager::hasEglContext() { 176 return mEglDisplay != EGL_NO_DISPLAY; 177 } 178 179 void EglManager::loadConfigs() { 180 ALOGD("Swap behavior %d", static_cast<int>(mSwapBehavior)); 181 EGLint swapBehavior = 182 (mSwapBehavior == SwapBehavior::Preserved) ? EGL_SWAP_BEHAVIOR_PRESERVED_BIT : 0; 183 EGLint attribs[] = {EGL_RENDERABLE_TYPE, 184 EGL_OPENGL_ES2_BIT, 185 EGL_RED_SIZE, 186 8, 187 EGL_GREEN_SIZE, 188 8, 189 EGL_BLUE_SIZE, 190 8, 191 EGL_ALPHA_SIZE, 192 8, 193 EGL_DEPTH_SIZE, 194 0, 195 EGL_CONFIG_CAVEAT, 196 EGL_NONE, 197 EGL_STENCIL_SIZE, 198 Stencil::getStencilSize(), 199 EGL_SURFACE_TYPE, 200 EGL_WINDOW_BIT | swapBehavior, 201 EGL_NONE}; 202 203 EGLint numConfigs = 1; 204 if (!eglChooseConfig(mEglDisplay, attribs, &mEglConfig, numConfigs, &numConfigs) || 205 numConfigs != 1) { 206 if (mSwapBehavior == SwapBehavior::Preserved) { 207 // Try again without dirty regions enabled 208 ALOGW("Failed to choose config with EGL_SWAP_BEHAVIOR_PRESERVED, retrying without..."); 209 mSwapBehavior = SwapBehavior::Discard; 210 loadConfigs(); 211 return; // the call to loadConfigs() we just made picks the wide gamut config 212 } else { 213 // Failed to get a valid config 214 LOG_ALWAYS_FATAL("Failed to choose config, error = %s", eglErrorString()); 215 } 216 } 217 218 if (EglExtensions.pixelFormatFloat) { 219 // If we reached this point, we have a valid swap behavior 220 EGLint attribs16F[] = {EGL_RENDERABLE_TYPE, 221 EGL_OPENGL_ES2_BIT, 222 EGL_COLOR_COMPONENT_TYPE_EXT, 223 EGL_COLOR_COMPONENT_TYPE_FLOAT_EXT, 224 EGL_RED_SIZE, 225 16, 226 EGL_GREEN_SIZE, 227 16, 228 EGL_BLUE_SIZE, 229 16, 230 EGL_ALPHA_SIZE, 231 16, 232 EGL_DEPTH_SIZE, 233 0, 234 EGL_STENCIL_SIZE, 235 Stencil::getStencilSize(), 236 EGL_SURFACE_TYPE, 237 EGL_WINDOW_BIT | swapBehavior, 238 EGL_NONE}; 239 240 numConfigs = 1; 241 if (!eglChooseConfig(mEglDisplay, attribs16F, &mEglConfigWideGamut, numConfigs, 242 &numConfigs) || 243 numConfigs != 1) { 244 ALOGE("Device claims wide gamut support, cannot find matching config, error = %s", 245 eglErrorString()); 246 EglExtensions.pixelFormatFloat = false; 247 } 248 } 249 } 250 251 void EglManager::createContext() { 252 std::vector<EGLint> contextAttributes; 253 contextAttributes.reserve(5); 254 contextAttributes.push_back(EGL_CONTEXT_CLIENT_VERSION); 255 contextAttributes.push_back(GLES_VERSION); 256 if (Properties::contextPriority != 0 && EglExtensions.contextPriority) { 257 contextAttributes.push_back(EGL_CONTEXT_PRIORITY_LEVEL_IMG); 258 contextAttributes.push_back(Properties::contextPriority); 259 } 260 contextAttributes.push_back(EGL_NONE); 261 mEglContext = eglCreateContext( 262 mEglDisplay, EglExtensions.noConfigContext ? ((EGLConfig) nullptr) : mEglConfig, 263 EGL_NO_CONTEXT, contextAttributes.data()); 264 LOG_ALWAYS_FATAL_IF(mEglContext == EGL_NO_CONTEXT, "Failed to create context, error = %s", 265 eglErrorString()); 266 } 267 268 void EglManager::createPBufferSurface() { 269 LOG_ALWAYS_FATAL_IF(mEglDisplay == EGL_NO_DISPLAY, 270 "usePBufferSurface() called on uninitialized GlobalContext!"); 271 272 if (mPBufferSurface == EGL_NO_SURFACE) { 273 EGLint attribs[] = {EGL_WIDTH, 1, EGL_HEIGHT, 1, EGL_NONE}; 274 mPBufferSurface = eglCreatePbufferSurface(mEglDisplay, mEglConfig, attribs); 275 } 276 } 277 278 EGLSurface EglManager::createSurface(EGLNativeWindowType window, bool wideColorGamut) { 279 initialize(); 280 281 wideColorGamut = wideColorGamut && EglExtensions.glColorSpace && EglExtensions.scRGB && 282 EglExtensions.pixelFormatFloat && EglExtensions.noConfigContext; 283 284 // The color space we want to use depends on whether linear blending is turned 285 // on and whether the app has requested wide color gamut rendering. When wide 286 // color gamut rendering is off, the app simply renders in the display's native 287 // color gamut. 288 // 289 // When wide gamut rendering is off: 290 // - Blending is done by default in gamma space, which requires using a 291 // linear EGL color space (the GPU uses the color values as is) 292 // - If linear blending is on, we must use the sRGB EGL color space (the 293 // GPU will perform sRGB to linear and linear to SRGB conversions before 294 // and after blending) 295 // 296 // When wide gamut rendering is on we cannot rely on the GPU performing 297 // linear blending for us. We use two different color spaces to tag the 298 // surface appropriately for SurfaceFlinger: 299 // - Gamma blending (default) requires the use of the scRGB-nl color space 300 // - Linear blending requires the use of the scRGB color space 301 302 // Not all Android targets support the EGL_GL_COLOR_SPACE_KHR extension 303 // We insert to placeholders to set EGL_GL_COLORSPACE_KHR and its value. 304 // According to section 3.4.1 of the EGL specification, the attributes 305 // list is considered empty if the first entry is EGL_NONE 306 EGLint attribs[] = {EGL_NONE, EGL_NONE, EGL_NONE}; 307 308 if (EglExtensions.glColorSpace) { 309 attribs[0] = EGL_GL_COLORSPACE_KHR; 310 #ifdef ANDROID_ENABLE_LINEAR_BLENDING 311 if (wideColorGamut) { 312 attribs[1] = EGL_GL_COLORSPACE_SCRGB_LINEAR_EXT; 313 } else { 314 attribs[1] = EGL_GL_COLORSPACE_SRGB_KHR; 315 } 316 #else 317 if (wideColorGamut) { 318 attribs[1] = EGL_GL_COLORSPACE_SCRGB_EXT; 319 } else { 320 attribs[1] = EGL_GL_COLORSPACE_LINEAR_KHR; 321 } 322 #endif 323 } 324 325 EGLSurface surface = eglCreateWindowSurface( 326 mEglDisplay, wideColorGamut ? mEglConfigWideGamut : mEglConfig, window, attribs); 327 LOG_ALWAYS_FATAL_IF(surface == EGL_NO_SURFACE, 328 "Failed to create EGLSurface for window %p, eglErr = %s", (void*)window, 329 eglErrorString()); 330 331 if (mSwapBehavior != SwapBehavior::Preserved) { 332 LOG_ALWAYS_FATAL_IF(eglSurfaceAttrib(mEglDisplay, surface, EGL_SWAP_BEHAVIOR, 333 EGL_BUFFER_DESTROYED) == EGL_FALSE, 334 "Failed to set swap behavior to destroyed for window %p, eglErr = %s", 335 (void*)window, eglErrorString()); 336 } 337 338 return surface; 339 } 340 341 void EglManager::destroySurface(EGLSurface surface) { 342 if (isCurrent(surface)) { 343 makeCurrent(EGL_NO_SURFACE); 344 } 345 if (!eglDestroySurface(mEglDisplay, surface)) { 346 ALOGW("Failed to destroy surface %p, error=%s", (void*)surface, eglErrorString()); 347 } 348 } 349 350 void EglManager::destroy() { 351 if (mEglDisplay == EGL_NO_DISPLAY) return; 352 353 mRenderThread.setGrContext(nullptr); 354 mRenderThread.renderState().onGLContextDestroyed(); 355 eglDestroyContext(mEglDisplay, mEglContext); 356 eglDestroySurface(mEglDisplay, mPBufferSurface); 357 eglMakeCurrent(mEglDisplay, EGL_NO_SURFACE, EGL_NO_SURFACE, EGL_NO_CONTEXT); 358 eglTerminate(mEglDisplay); 359 eglReleaseThread(); 360 361 mEglDisplay = EGL_NO_DISPLAY; 362 mEglContext = EGL_NO_CONTEXT; 363 mPBufferSurface = EGL_NO_SURFACE; 364 mCurrentSurface = EGL_NO_SURFACE; 365 } 366 367 bool EglManager::makeCurrent(EGLSurface surface, EGLint* errOut) { 368 if (isCurrent(surface)) return false; 369 370 if (surface == EGL_NO_SURFACE) { 371 // Ensure we always have a valid surface & context 372 surface = mPBufferSurface; 373 } 374 if (!eglMakeCurrent(mEglDisplay, surface, surface, mEglContext)) { 375 if (errOut) { 376 *errOut = eglGetError(); 377 ALOGW("Failed to make current on surface %p, error=%s", (void*)surface, 378 egl_error_str(*errOut)); 379 } else { 380 LOG_ALWAYS_FATAL("Failed to make current on surface %p, error=%s", (void*)surface, 381 eglErrorString()); 382 } 383 } 384 mCurrentSurface = surface; 385 if (Properties::disableVsync) { 386 eglSwapInterval(mEglDisplay, 0); 387 } 388 return true; 389 } 390 391 EGLint EglManager::queryBufferAge(EGLSurface surface) { 392 switch (mSwapBehavior) { 393 case SwapBehavior::Discard: 394 return 0; 395 case SwapBehavior::Preserved: 396 return 1; 397 case SwapBehavior::BufferAge: 398 EGLint bufferAge; 399 eglQuerySurface(mEglDisplay, surface, EGL_BUFFER_AGE_EXT, &bufferAge); 400 return bufferAge; 401 } 402 return 0; 403 } 404 405 Frame EglManager::beginFrame(EGLSurface surface) { 406 LOG_ALWAYS_FATAL_IF(surface == EGL_NO_SURFACE, "Tried to beginFrame on EGL_NO_SURFACE!"); 407 makeCurrent(surface); 408 Frame frame; 409 frame.mSurface = surface; 410 eglQuerySurface(mEglDisplay, surface, EGL_WIDTH, &frame.mWidth); 411 eglQuerySurface(mEglDisplay, surface, EGL_HEIGHT, &frame.mHeight); 412 frame.mBufferAge = queryBufferAge(surface); 413 eglBeginFrame(mEglDisplay, surface); 414 return frame; 415 } 416 417 void EglManager::damageFrame(const Frame& frame, const SkRect& dirty) { 418 #ifdef EGL_KHR_partial_update 419 if (EglExtensions.setDamage && mSwapBehavior == SwapBehavior::BufferAge) { 420 EGLint rects[4]; 421 frame.map(dirty, rects); 422 if (!eglSetDamageRegionKHR(mEglDisplay, frame.mSurface, rects, 1)) { 423 LOG_ALWAYS_FATAL("Failed to set damage region on surface %p, error=%s", 424 (void*)frame.mSurface, eglErrorString()); 425 } 426 } 427 #endif 428 } 429 430 bool EglManager::damageRequiresSwap() { 431 return EglExtensions.setDamage && mSwapBehavior == SwapBehavior::BufferAge; 432 } 433 434 bool EglManager::swapBuffers(const Frame& frame, const SkRect& screenDirty) { 435 if (CC_UNLIKELY(Properties::waitForGpuCompletion)) { 436 ATRACE_NAME("Finishing GPU work"); 437 fence(); 438 } 439 440 EGLint rects[4]; 441 frame.map(screenDirty, rects); 442 eglSwapBuffersWithDamageKHR(mEglDisplay, frame.mSurface, rects, screenDirty.isEmpty() ? 0 : 1); 443 444 EGLint err = eglGetError(); 445 if (CC_LIKELY(err == EGL_SUCCESS)) { 446 return true; 447 } 448 if (err == EGL_BAD_SURFACE || err == EGL_BAD_NATIVE_WINDOW) { 449 // For some reason our surface was destroyed out from under us 450 // This really shouldn't happen, but if it does we can recover easily 451 // by just not trying to use the surface anymore 452 ALOGW("swapBuffers encountered EGL error %d on %p, halting rendering...", err, 453 frame.mSurface); 454 return false; 455 } 456 LOG_ALWAYS_FATAL("Encountered EGL error %d %s during rendering", err, egl_error_str(err)); 457 // Impossible to hit this, but the compiler doesn't know that 458 return false; 459 } 460 461 void EglManager::fence() { 462 EGLSyncKHR fence = eglCreateSyncKHR(mEglDisplay, EGL_SYNC_FENCE_KHR, NULL); 463 eglClientWaitSyncKHR(mEglDisplay, fence, EGL_SYNC_FLUSH_COMMANDS_BIT_KHR, EGL_FOREVER_KHR); 464 eglDestroySyncKHR(mEglDisplay, fence); 465 } 466 467 bool EglManager::setPreserveBuffer(EGLSurface surface, bool preserve) { 468 if (mSwapBehavior != SwapBehavior::Preserved) return false; 469 470 bool preserved = eglSurfaceAttrib(mEglDisplay, surface, EGL_SWAP_BEHAVIOR, 471 preserve ? EGL_BUFFER_PRESERVED : EGL_BUFFER_DESTROYED); 472 if (!preserved) { 473 ALOGW("Failed to set EGL_SWAP_BEHAVIOR on surface %p, error=%s", (void*)surface, 474 eglErrorString()); 475 // Maybe it's already set? 476 EGLint swapBehavior; 477 if (eglQuerySurface(mEglDisplay, surface, EGL_SWAP_BEHAVIOR, &swapBehavior)) { 478 preserved = (swapBehavior == EGL_BUFFER_PRESERVED); 479 } else { 480 ALOGW("Failed to query EGL_SWAP_BEHAVIOR on surface %p, error=%p", (void*)surface, 481 eglErrorString()); 482 } 483 } 484 485 return preserved; 486 } 487 488 } /* namespace renderthread */ 489 } /* namespace uirenderer */ 490 } /* namespace android */ 491
