Merge lp:~afrantzis/mir/fix-1454201-usc-crash-for-0.13 into lp:mir/0.13

[Alexandros Frantzis]

compositor: Release current GL context before deleting shader objects to avoid crash (LP: #1454201)

compositor: Release current GL context before deleting shader objects to avoid crash (LP: #1454201)

[Alan Griffiths (alan-griffiths)]

Seems to work, but I'm not sure why.

Unfortunately...

$ bin/mir_unit_tests --gtest_filter=GLRenderer.*:DemoRenderer.*
...
[ FAILED ] 5 tests, listed below:
[ FAILED ] GLRenderer.disables_blending_for_rgbx_surfaces
[ FAILED ] GLRenderer.binds_for_every_primitive_when_tessellate_is_overridden
[ FAILED ] GLRenderer.opaque_alpha_channel
[ FAILED ] GLRenderer.generates_alpha_channel_content
[ FAILED ] DemoRenderer.detects_embellishments_on_renderables

[lp:~afrantzis/mir/fix-1454201-usc-crash-for-0.13]

2540. By Alexandros Frantzis on 2015-05-12

tests: Update tests for workaround

=== modified file 'src/server/compositor/gl_program_family.cpp'
--- src/server/compositor/gl_program_family.cpp	2015-02-02 14:04:10 +0000
+++ src/server/compositor/gl_program_family.cpp	2015-05-12 12:27:37 +0000
@@ -19,6 +19,7 @@
 #include "mir/compositor/gl_program_family.h"
 
 #include <mutex>
+#include <EGL/egl.h>
 
 namespace mir { namespace compositor {
 
@@ -53,6 +54,10 @@
     // need any reference counting or to worry about how many copy constructions
     // might have been followed by destructor calls during container resizes.
 
+    // Workaround for lp:1454201. Release any current GL context to avoid crashes
+    // in the glDelete* functions that follow.
+    eglMakeCurrent(eglGetCurrentDisplay(), EGL_NO_SURFACE, EGL_NO_SURFACE, EGL_NO_CONTEXT);
+
     for (auto& p : program)
     {
         if (p.second.id)

=== modified file 'tests/unit-tests/compositor/CMakeLists.txt'
--- tests/unit-tests/compositor/CMakeLists.txt	2015-03-31 02:35:42 +0000
+++ tests/unit-tests/compositor/CMakeLists.txt	2015-05-12 12:27:37 +0000
@@ -4,6 +4,7 @@
   ${CMAKE_CURRENT_SOURCE_DIR}/test_temporary_buffers.cpp
   ${CMAKE_CURRENT_SOURCE_DIR}/test_multi_threaded_compositor.cpp
   ${CMAKE_CURRENT_SOURCE_DIR}/test_buffer_queue.cpp
+  ${CMAKE_CURRENT_SOURCE_DIR}/test_gl_program_family.cpp
   ${CMAKE_CURRENT_SOURCE_DIR}/test_gl_renderer.cpp
   ${CMAKE_CURRENT_SOURCE_DIR}/test_gl_texture_cache.cpp
   ${CMAKE_CURRENT_SOURCE_DIR}/test_occlusion.cpp

=== added file 'tests/unit-tests/compositor/test_gl_program_family.cpp'
--- tests/unit-tests/compositor/test_gl_program_family.cpp	1970-01-01 00:00:00 +0000
+++ tests/unit-tests/compositor/test_gl_program_family.cpp	2015-05-12 12:27:37 +0000
@@ -0,0 +1,49 @@
+/*
+ * Copyright © 2015 Canonical Ltd.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 3 as
+ * published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Authored by: Alexandros Frantzis <[e-mail]>
+ */
+
+#include "mir/compositor/gl_program_family.h"
+#include "mir_test_doubles/mock_gl.h"
+#include "mir_test_doubles/mock_egl.h"
+
+#include <gtest/gtest.h>
+#include <gmock/gmock.h>
+
+namespace mtd = mir::test::doubles;
+namespace mc = mir::compositor;
+
+// Regression test for LP: #1454201
+TEST(GLProgramFamily, releases_gl_context_before_deleting_shader_objects)
+{
+    using namespace testing;
+
+    NiceMock<mtd::MockGL> mock_gl;
+    NiceMock<mtd::MockEGL> mock_egl;
+
+    ON_CALL(mock_gl, glCreateShader(_)).WillByDefault(Return(1));
+    ON_CALL(mock_gl, glCreateProgram()).WillByDefault(Return(1));
+
+    {
+        mc::GLProgramFamily family;
+        family.add_program("vertex shader", "fragment shader");
+
+        InSequence seq;
+        EXPECT_CALL(mock_egl, eglMakeCurrent(_,EGL_NO_SURFACE,EGL_NO_SURFACE,EGL_NO_CONTEXT));
+        EXPECT_CALL(mock_gl, glDeleteProgram(_)).Times(1);
+        EXPECT_CALL(mock_gl, glDeleteShader(_)).Times(2);
+    }
+}

=== modified file 'tests/unit-tests/compositor/test_gl_renderer.cpp'
--- tests/unit-tests/compositor/test_gl_renderer.cpp	2015-04-08 07:22:41 +0000
+++ tests/unit-tests/compositor/test_gl_renderer.cpp	2015-05-12 12:27:37 +0000
@@ -30,6 +30,7 @@
 #include <mir_test_doubles/mock_buffer_stream.h>
 #include <mir/compositor/buffer_stream.h>
 #include <mir_test_doubles/mock_gl.h>
+#include <mir_test_doubles/mock_egl.h>
 
 using testing::SetArgPointee;
 using testing::InSequence;
@@ -143,6 +144,7 @@
     }
 
     testing::NiceMock<mtd::MockGL> mock_gl;
+    testing::NiceMock<mtd::MockEGL> mock_egl;
     std::shared_ptr<mtd::MockBuffer> mock_buffer;
     mir::geometry::Rectangle display_area;
     std::shared_ptr<testing::NiceMock<mtd::MockRenderable>> renderable;

=== modified file 'tests/unit-tests/examples/test_demo_renderer.cpp'
--- tests/unit-tests/examples/test_demo_renderer.cpp	2015-01-21 07:34:50 +0000
+++ tests/unit-tests/examples/test_demo_renderer.cpp	2015-05-12 12:27:37 +0000
@@ -20,6 +20,7 @@
 #include "mir/compositor/destination_alpha.h"
 #include "mir_test_doubles/fake_renderable.h"
 #include "mir_test_doubles/mock_gl.h"
+#include "mir_test_doubles/mock_egl.h"
 #include "playground/demo-shell/demo_renderer.h"
 #include <gtest/gtest.h>
 
@@ -31,6 +32,7 @@
 struct DemoRenderer : public testing::Test
 {
     testing::NiceMock<mtd::MockGL> mock_gl;
+    testing::NiceMock<mtd::MockEGL> mock_egl;
     geom::Rectangle region{{0, 0}, {100, 100}};
     mc::DestinationAlpha dest_alpha{mc::DestinationAlpha::opaque};
     int const shadow_radius{20};