From 4da4c07b52ad19ef3727bc7fa5523b2e8416653e Mon Sep 17 00:00:00 2001 From: Mathias Agopian Date: Mon, 22 Apr 2019 19:02:45 -0700 Subject: [PATCH] fix FBO leak when using MSAA in some cases We would leak an FBO when using the same texture with multiple FBOs and MSAA, this is because we have to allocate a sidecar FBO in this case and we were doing so even if it was already existing. Also store the sidecar fbo with the texture instead of the RenderTarget, because it has nothing to do with the later. In fact we could have several textures (e.g. color + depth) who both need a sidecar fbo, so it can't be stored in the RenderTarget structure. Also clean-up bindTexture(). --- filament/backend/src/opengl/OpenGLDriver.cpp | 90 +++++++++++-------- filament/backend/src/opengl/OpenGLDriver.h | 23 +---- filament/backend/src/opengl/OpenGLProgram.cpp | 2 +- 3 files changed, 56 insertions(+), 59 deletions(-) diff --git a/filament/backend/src/opengl/OpenGLDriver.cpp b/filament/backend/src/opengl/OpenGLDriver.cpp index 5e23ee6d04..6a22a226a8 100644 --- a/filament/backend/src/opengl/OpenGLDriver.cpp +++ b/filament/backend/src/opengl/OpenGLDriver.cpp @@ -477,6 +477,11 @@ void OpenGLDriver::bindVertexArray(GLRenderPrimitive const* p) noexcept { }); } +void OpenGLDriver::bindTexture(GLuint unit, GLTexture const* t) noexcept { + assert(t != nullptr); + bindTexture(unit, t->gl.target, t->gl.texture_id, t->gl.targetIndex); +} + void OpenGLDriver::bindTexture(GLuint unit, GLuint target, GLuint texId, size_t targetIndex) noexcept { assert(targetIndex == getIndexForTextureTarget(target)); assert(targetIndex < TEXTURE_TARGET_COUNT); @@ -933,7 +938,7 @@ UTILS_NOINLINE void OpenGLDriver::textureStorage(OpenGLDriver::GLTexture* t, uint32_t width, uint32_t height, uint32_t depth) noexcept { - bindTexture(MAX_TEXTURE_UNIT_COUNT - 1, t->gl.target, t, t->gl.targetIndex); + bindTexture(MAX_TEXTURE_UNIT_COUNT - 1, t); activeTexture(MAX_TEXTURE_UNIT_COUNT - 1); switch (t->gl.target) { @@ -1090,12 +1095,22 @@ void OpenGLDriver::framebufferTexture(backend::TargetBufferInfo& binfo, { // here we emulate ext.EXT_multisampled_render_to_texture assert(rt->gl.samples > 1); - // We need a "draw" sidecar fbo, used later for the resolve, which takes place in - // endRenderPass(). - if (!rt->gl.fbo_draw) { - glGenFramebuffers(1, &rt->gl.fbo_draw); + // If the texture doesn't already have one, create a sidecar multi-sampled renderbuffer, + // which is where drawing will actually take place, make that our attachment. + bindFramebuffer(GL_FRAMEBUFFER, rt->gl.fbo); + if (t->gl.rb == 0) { + t->gl.rb = framebufferRenderbuffer(rt->width, rt->height, rt->gl.samples, + attachment, t->gl.internalFormat, rt->gl.fbo); + } else { + glFramebufferRenderbuffer(GL_FRAMEBUFFER, attachment, GL_RENDERBUFFER, t->gl.rb); } - bindFramebuffer(GL_FRAMEBUFFER, rt->gl.fbo_draw); + + // We also need a "read" sidecar fbo, used later for the resolve, which takes place in + // endRenderPass(). + if (!rt->gl.fbo_read) { + glGenFramebuffers(1, &rt->gl.fbo_read); + } + bindFramebuffer(GL_FRAMEBUFFER, rt->gl.fbo_read); switch (target) { case GL_TEXTURE_2D: glFramebufferTexture2D(GL_FRAMEBUFFER, attachment, @@ -1129,12 +1144,6 @@ void OpenGLDriver::framebufferTexture(backend::TargetBufferInfo& binfo, default: break; } - - // Create a multi-sampled renderbuffer, where the rendering will take place, and make that - // our attachment. - bindFramebuffer(GL_FRAMEBUFFER, rt->gl.fbo); - framebufferRenderbuffer(&rt->gl.color, attachment, t->gl.internalFormat, - rt->width, rt->height, rt->gl.samples, rt->gl.fbo); } CHECK_GL_FRAMEBUFFER_STATUS(utils::slog.e) @@ -1159,12 +1168,6 @@ void OpenGLDriver::renderBufferStorage(GLuint rbo, GLenum internalformat, uint32 } } -void OpenGLDriver::framebufferRenderbuffer(GLRenderTarget::GL::RenderBuffer* rb, GLenum attachment, - GLenum internalformat, uint32_t width, uint32_t height, uint8_t samples, GLuint fbo) noexcept { - rb->rb = framebufferRenderbuffer(width, height, samples, attachment, internalformat, fbo); - rb->internalFormat = internalformat; -} - GLuint OpenGLDriver::framebufferRenderbuffer(uint32_t width, uint32_t height, uint8_t samples, GLenum attachment, GLenum internalformat, GLuint fbo) noexcept { @@ -1254,8 +1257,9 @@ void OpenGLDriver::createRenderTargetR(Handle rth, framebufferTexture(color, rt, GL_COLOR_ATTACHMENT0); } else { GLenum internalFormat = getInternalFormat(format); - framebufferRenderbuffer(&rt->gl.color, GL_COLOR_ATTACHMENT0, internalFormat, - width, height, samples, rt->gl.fbo); + rt->gl.color.internalFormat = internalFormat; + rt->gl.color.rb = framebufferRenderbuffer(width, height, samples, + GL_COLOR_ATTACHMENT0, internalFormat, rt->gl.fbo); } #ifndef NDEBUG // clear the color buffer we just allocated to yellow @@ -1274,9 +1278,9 @@ void OpenGLDriver::createRenderTargetR(Handle rth, if (!depth.handle && !stencil.handle) { // special case: depth & stencil requested, but both not provided specialCased = true; - framebufferRenderbuffer(&rt->gl.depth, GL_DEPTH_STENCIL_ATTACHMENT, GL_DEPTH24_STENCIL8, - width, height, samples, rt->gl.fbo); - + rt->gl.depth.internalFormat = GL_DEPTH24_STENCIL8; + rt->gl.depth.rb = framebufferRenderbuffer(width, height, samples, + GL_DEPTH_STENCIL_ATTACHMENT, GL_DEPTH24_STENCIL8, rt->gl.fbo); } else if (depth.handle == stencil.handle) { // special case: depth & stencil requested, and both provided as the same texture rt->gl.depth.texture = handle_cast(depth.handle); @@ -1291,8 +1295,9 @@ void OpenGLDriver::createRenderTargetR(Handle rth, rt->gl.depth.texture = handle_cast(depth.handle); framebufferTexture(depth, rt, GL_DEPTH_ATTACHMENT); } else { - framebufferRenderbuffer(&rt->gl.depth, GL_DEPTH_ATTACHMENT, GL_DEPTH_COMPONENT24, - width, height, samples, rt->gl.fbo); + rt->gl.depth.internalFormat = GL_DEPTH_COMPONENT24; + rt->gl.depth.rb = framebufferRenderbuffer(width, height, samples, + GL_DEPTH_ATTACHMENT, GL_DEPTH_COMPONENT24, rt->gl.fbo); } } if (targets & TargetBufferFlags::STENCIL) { @@ -1300,8 +1305,9 @@ void OpenGLDriver::createRenderTargetR(Handle rth, rt->gl.stencil.texture = handle_cast(stencil.handle); framebufferTexture(stencil, rt, GL_STENCIL_ATTACHMENT); } else { - framebufferRenderbuffer(&rt->gl.stencil, GL_STENCIL_ATTACHMENT, GL_STENCIL_INDEX8, - width, height, samples, rt->gl.fbo); + rt->gl.stencil.internalFormat = GL_STENCIL_INDEX8; + rt->gl.stencil.rb = framebufferRenderbuffer(width, height, samples, + GL_STENCIL_ATTACHMENT, GL_STENCIL_INDEX8, rt->gl.fbo); } } } @@ -1451,6 +1457,9 @@ void OpenGLDriver::destroyTexture(Handle th) { if (UTILS_UNLIKELY(t->hwStream)) { detachStream(t); } + if (t->gl.rb) { + glDeleteRenderbuffers(1, &t->gl.rb); + } if (t->gl.fence) { glDeleteSync(t->gl.fence); } @@ -1484,9 +1493,9 @@ void OpenGLDriver::destroyRenderTarget(Handle rth) { // finally delete the framebuffer object glDeleteFramebuffers(1, &rt->gl.fbo); } - if (rt->gl.fbo_draw) { + if (rt->gl.fbo_read) { // finally delete the draw framebuffer object - glDeleteFramebuffers(1, &rt->gl.fbo_draw); + glDeleteFramebuffers(1, &rt->gl.fbo_read); } destruct(rth, rt); } @@ -1850,7 +1859,7 @@ void OpenGLDriver::generateMipmaps(Handle th) { assert(t->gl.target != GL_TEXTURE_2D_MULTISAMPLE); // Note: glGenerateMimap can also fail if the internal format is not both // color-renderable and filterable (i.e.: doesn't work for depth) - bindTexture(MAX_TEXTURE_UNIT_COUNT - 1, t->gl.target, t, t->gl.targetIndex); + bindTexture(MAX_TEXTURE_UNIT_COUNT - 1, t); activeTexture(MAX_TEXTURE_UNIT_COUNT - 1); t->gl.baseLevel = 0; @@ -1900,7 +1909,7 @@ void OpenGLDriver::setTextureData(GLTexture* t, // fallthrough... case SamplerType::SAMPLER_2D: // NOTE: GL_TEXTURE_2D_MULTISAMPLE is not allowed - bindTexture(MAX_TEXTURE_UNIT_COUNT - 1, t->gl.target, t); + bindTexture(MAX_TEXTURE_UNIT_COUNT - 1, t); activeTexture(MAX_TEXTURE_UNIT_COUNT - 1); switch (t->gl.target) { case GL_TEXTURE_2D: @@ -1920,7 +1929,7 @@ void OpenGLDriver::setTextureData(GLTexture* t, break; case SamplerType::SAMPLER_CUBEMAP: { assert(t->gl.target == GL_TEXTURE_CUBE_MAP); - bindTexture(MAX_TEXTURE_UNIT_COUNT - 1, GL_TEXTURE_CUBE_MAP, t); + bindTexture(MAX_TEXTURE_UNIT_COUNT - 1, t); activeTexture(MAX_TEXTURE_UNIT_COUNT - 1); FaceOffsets const& offsets = *faceOffsets; #pragma nounroll @@ -1981,7 +1990,7 @@ void OpenGLDriver::setCompressedTextureData(GLTexture* t, // fallthrough... case SamplerType::SAMPLER_2D: // NOTE: GL_TEXTURE_2D_MULTISAMPLE is not allowed - bindTexture(MAX_TEXTURE_UNIT_COUNT - 1, t->gl.target, t); + bindTexture(MAX_TEXTURE_UNIT_COUNT - 1, t); activeTexture(MAX_TEXTURE_UNIT_COUNT - 1); switch (t->gl.target) { case GL_TEXTURE_2D: @@ -2002,7 +2011,7 @@ void OpenGLDriver::setCompressedTextureData(GLTexture* t, case SamplerType::SAMPLER_CUBEMAP: { assert(faceOffsets); assert(t->gl.target == GL_TEXTURE_CUBE_MAP); - bindTexture(MAX_TEXTURE_UNIT_COUNT - 1, GL_TEXTURE_CUBE_MAP, t); + bindTexture(MAX_TEXTURE_UNIT_COUNT - 1, t); activeTexture(MAX_TEXTURE_UNIT_COUNT - 1); FaceOffsets const& offsets = *faceOffsets; #pragma nounroll @@ -2048,7 +2057,7 @@ void OpenGLDriver::setExternalImage(Handle th, void* image) { assert(t->target == SamplerType::SAMPLER_EXTERNAL); assert(t->gl.target == GL_TEXTURE_EXTERNAL_OES); - bindTexture(MAX_TEXTURE_UNIT_COUNT - 1, GL_TEXTURE_EXTERNAL_OES, t); + bindTexture(MAX_TEXTURE_UNIT_COUNT - 1, t); activeTexture(MAX_TEXTURE_UNIT_COUNT - 1); #ifdef GL_OES_EGL_image @@ -2229,7 +2238,7 @@ void OpenGLDriver::resolve(GLRenderTarget const* rt, TargetBufferFlags discardFl if (UTILS_UNLIKELY(mask)) { bindFramebuffer(GL_READ_FRAMEBUFFER, rt->gl.fbo); - bindFramebuffer(GL_DRAW_FRAMEBUFFER, rt->gl.fbo_draw); + bindFramebuffer(GL_DRAW_FRAMEBUFFER, rt->gl.fbo_read); disable(GL_SCISSOR_TEST); glBlitFramebuffer(0, 0, rt->width, rt->height, 0, 0, rt->width, rt->height, mask, GL_NEAREST); CHECK_GL_ERROR(utils::slog.e) @@ -2881,7 +2890,12 @@ void OpenGLDriver::blit(TargetBufferFlags buffers, GLRenderTarget const* s = handle_cast(src); GLRenderTarget const* d = handle_cast(dst); - bindFramebuffer(GL_READ_FRAMEBUFFER, s->gl.fbo_draw ? s->gl.fbo_draw : s->gl.fbo); + // FIXME: it's not correct to use fbo_read here, because this fbo only exists for + // performing the resolve -- in particular, if there were other attachments to this + // FBO, ther would not be part of fbo_read. e.g.: the case of a multi-sampled + // color renderbuffer + multi-sampled depth texture. fbo_read would only contain the + // later. + bindFramebuffer(GL_READ_FRAMEBUFFER, s->gl.fbo_read ? s->gl.fbo_read : s->gl.fbo); bindFramebuffer(GL_DRAW_FRAMEBUFFER, d->gl.fbo); disable(GL_SCISSOR_TEST); glBlitFramebuffer( @@ -2900,7 +2914,7 @@ void OpenGLDriver::blit(TargetBufferFlags buffers, int8_t targetLevel = d->gl.colorLevel; if (targetLevel < baseLevel || targetLevel > maxLevel) { GLenum target = dtexture->gl.target; - bindTexture(MAX_TEXTURE_UNIT_COUNT - 1, target, dtexture, dtexture->gl.targetIndex); + bindTexture(MAX_TEXTURE_UNIT_COUNT - 1, dtexture); activeTexture(MAX_TEXTURE_UNIT_COUNT - 1); if (targetLevel < baseLevel) { dtexture->gl.baseLevel = targetLevel; diff --git a/filament/backend/src/opengl/OpenGLDriver.h b/filament/backend/src/opengl/OpenGLDriver.h index 6d57a74f79..6642a7ca5a 100644 --- a/filament/backend/src/opengl/OpenGLDriver.h +++ b/filament/backend/src/opengl/OpenGLDriver.h @@ -104,6 +104,7 @@ public: using HwTexture::HwTexture; struct { GLuint texture_id; + mutable GLuint rb = 0; // multi-sample sidecar buffer GLenum target; GLenum internalFormat; mutable GLsync fence = nullptr; @@ -179,7 +180,7 @@ public: RenderBuffer depth; RenderBuffer stencil; GLuint fbo = 0; - GLuint fbo_draw = 0; + GLuint fbo_read = 0; backend::TargetBufferFlags resolve = backend::TargetBufferFlags::NONE; // attachments in fbo_draw to resolve uint8_t samples : 4; uint8_t colorLevel : 4; // Allows up to 15 levels (max texture size of 32768 x 32768) @@ -288,9 +289,6 @@ private: void framebufferTexture(backend::TargetBufferInfo& binfo, GLRenderTarget* rt, GLenum attachment) noexcept; - void framebufferRenderbuffer(GLRenderTarget::GL::RenderBuffer* rb, GLenum attachment, - GLenum internalformat, uint32_t width, uint32_t height, uint8_t samples, GLuint fbo) noexcept; - GLuint framebufferRenderbuffer(uint32_t width, uint32_t height, uint8_t samples, GLenum attachment, GLenum internalformat, GLuint fbo) noexcept; @@ -327,9 +325,7 @@ private: inline void pixelStore(GLenum, GLint) noexcept; inline void activeTexture(GLuint unit) noexcept; - inline void bindTexture(GLuint unit, GLuint target, GLTexture const* t) noexcept; - inline void bindTexture(GLuint unit, GLuint target, GLTexture const* t, size_t targetIndex) noexcept; - inline void UTILS_UNUSED bindTexture(GLuint unit, GLuint target, GLuint texId) noexcept; + void bindTexture(GLuint unit, GLTexture const* t) noexcept; void bindTexture(GLuint unit, GLuint target, GLuint texId, size_t targetIndex) noexcept; inline void unbindTexture(GLenum target, GLuint id) noexcept; @@ -640,19 +636,6 @@ void OpenGLDriver::activeTexture(GLuint unit) noexcept { }); } -void OpenGLDriver::bindTexture(GLuint unit, GLuint target, GLTexture const* t) noexcept { - bindTexture(unit, target, t, getIndexForTextureTarget(target)); -} - -void OpenGLDriver::bindTexture(GLuint unit, GLuint target, GLTexture const* t, size_t targetIndex) noexcept { - assert(t != nullptr); - bindTexture(unit, target, t->gl.texture_id, targetIndex); -} - -void UTILS_UNUSED OpenGLDriver::bindTexture(GLuint unit, GLuint target, GLuint texId) noexcept { - bindTexture(unit, target, texId, getIndexForTextureTarget(target)); -} - void OpenGLDriver::bindSampler(GLuint unit, GLuint sampler) noexcept { assert(unit < MAX_TEXTURE_UNIT_COUNT); update_state(state.textures.units[unit].sampler, sampler, [&]() { diff --git a/filament/backend/src/opengl/OpenGLProgram.cpp b/filament/backend/src/opengl/OpenGLProgram.cpp index 78ec2ff17e..ce35ff9fce 100644 --- a/filament/backend/src/opengl/OpenGLProgram.cpp +++ b/filament/backend/src/opengl/OpenGLProgram.cpp @@ -209,7 +209,7 @@ void OpenGLProgram::updateSamplers(OpenGLDriver* gl) noexcept { t->gl.fence = nullptr; } - gl->bindTexture(tmu, t->gl.target, t, t->gl.targetIndex); + gl->bindTexture(tmu, t); // FIXME: getSampler() is expensive because it's a hashmap lookup GLuint sampler = gl->getSampler(samplers[index].s);