Merge lp:~raof/mir/require-egl-extensions into lp:mir

[Chris Halse Rogers]

Add mg::require_egl_extensions.

A helper function that takes a list of EGL extension strings and a display, checks whether or not they are all supported or throws an exception containing the list of unsupported extensions.

Add mg::require_egl_extensions.

A helper function that takes a list of EGL extension strings and a display, checks whether or not they are all supported or throws an exception containing the list of unsupported extensions.

[Mir CI Bot (mir-ci-bot)]

FAILED: Continuous integration, rev:3497
https://mir-jenkins.ubuntu.com/job/mir-ci/935/
Executed test runs:
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-mir/996/console
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-0-fetch/1042
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=vivid+overlay/1033
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=xenial/1033
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=vivid+overlay/1006/console
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial/1006/console
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=android,release=vivid+overlay/1006/console
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/1006/console
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial/1006/console

Click here to trigger a rebuild:
https://mir-jenkins.ubuntu.com/job/mir-ci/935/rebuild

review: Needs Fixing (continuous-integration)

[Daniel van Vugt (vanvugt)]

Wait, libepoxy is the helper function. Why do we need to wrap the helper functions in more helper functions?

[Chris Halse Rogers (raof)]

Because I got bored manually checking epoxy_has_extension() and accumulating the results in a couple of different places.

It's also nice if your exception message contains *all* the missing extensions, rather than the first one you hit.

[Chris Halse Rogers (raof)]

Oh, yeah. I probably need to make Mir depend on libepoxy-dev if I'm going to use it...

[Cemil Azizoglu (cemil-azizoglu)]

Ok

Nit :
A bit out of place here
+ ${PROJECT_SOURCE_DIR}/src/include/platform/mir/graphics/require_egl_extensions.h

review: Approve

[Chris Halse Rogers (raof)]

I'm no longer sure if I'll end up using this, so WIP for now.

Unmerged revisions

3497. By Chris Halse Rogers on 2016-05-04

Document what mg::require_egl_extensions does

3496. By Chris Halse Rogers on 2016-05-04

Add mg::require_egl_extensions.

This provides a convenient way of asserting that a list of extensions are supported.

3495. By Chris Halse Rogers on 2016-05-04

MockEGL: wrap dlopen() to hook libraries that grab libEGL themselves.

=== modified file 'CMakeLists.txt'
--- CMakeLists.txt	2016-05-03 04:36:33 +0000
+++ CMakeLists.txt	2016-05-04 04:43:00 +0000
@@ -194,6 +194,7 @@
 find_package(LTTngUST REQUIRED)
 pkg_check_modules(UDEV REQUIRED libudev)
 pkg_check_modules(GLIB REQUIRED glib-2.0)
+pkg_check_modules(EPOXY REQUIRED epoxy)
 
 include_directories (SYSTEM ${GLESv2_INCLUDE_DIRS})
 include_directories (SYSTEM ${EGL_INCLUDE_DIRS})

=== added file 'src/include/platform/mir/graphics/require_egl_extensions.h'
--- src/include/platform/mir/graphics/require_egl_extensions.h	1970-01-01 00:00:00 +0000
+++ src/include/platform/mir/graphics/require_egl_extensions.h	2016-05-04 04:43:00 +0000
@@ -0,0 +1,44 @@
+/*
+ * Copyright © 2016 Canonical Ltd.
+ *
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser 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 Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Authored by: Christopher James Halse Rogers <[e-mail]>
+ */
+#ifndef MIR_GRAPHICS_REQUIRE_EGL_EXTENSIONS_H_
+#define MIR_GRAPHICS_REQUIRE_EGL_EXTENSIONS_H_
+
+#include <initializer_list>
+
+// Manually define EGLDisplay to avoid needing to pull epoxy header in here
+#ifndef EGLDisplay
+typedef void* EGLDisplay;
+#endif
+
+namespace mir
+{
+namespace graphics
+{
+/**
+ * Check that dpy supports all of extensions.
+ *
+ * \param [in] dpy          The EGLDisplay to query (or EGL_NO_DISPLAY for EGL client extensions)
+ * \param [in] extensions   The list of EGL extensions to check for
+ * \throw   A std::runtime_error if any extension in extensions is not supported. The exception
+ *          description will include a list of all the unsupported extensions.
+ */
+void require_egl_extensions(EGLDisplay dpy, std::initializer_list<char const*> const& extensions);
+}
+}
+
+#endif //MIR_GRAPHICS_REQUIRE_EGL_EXTENSIONS_H_

=== modified file 'src/platform/CMakeLists.txt'
--- src/platform/CMakeLists.txt	2016-01-29 08:18:22 +0000
+++ src/platform/CMakeLists.txt	2016-05-04 04:43:00 +0000
@@ -19,6 +19,7 @@
 set(MIR_PLATFORM_REFERENCES
   ${EGL_LDFLAGS} ${EGL_LIBRARIES}
   ${GLESv2_LDFLAGS} ${GLESv2_LIBRARIES}
+  ${EPOXY_LDFLAGS} ${EPOXY_LIBRARIES}
 )
 
 add_subdirectory(graphics/)

=== modified file 'src/platform/graphics/CMakeLists.txt'
--- src/platform/graphics/CMakeLists.txt	2016-03-29 07:30:50 +0000
+++ src/platform/graphics/CMakeLists.txt	2016-05-04 04:43:00 +0000
@@ -1,4 +1,7 @@
-include_directories(${GLESv2_INCLUDE_DIRS})
+include_directories(
+  ${GLESv2_INCLUDE_DIRS}
+  ${EPOXY_INCLUDE_DIRS}
+)
 
 set(
   GRAPHICS_SOURCES
@@ -11,6 +14,8 @@
   pixel_format_utils.cpp
   overlapping_output_grouping.cpp
   platform_probe.cpp
+  ${PROJECT_SOURCE_DIR}/src/include/platform/mir/graphics/require_egl_extensions.h
+  require_egl_extensions.cpp
 )
 
 add_library(mirplatformgraphicscommon OBJECT

=== added file 'src/platform/graphics/require_egl_extensions.cpp'
--- src/platform/graphics/require_egl_extensions.cpp	1970-01-01 00:00:00 +0000
+++ src/platform/graphics/require_egl_extensions.cpp	2016-05-04 04:43:00 +0000
@@ -0,0 +1,53 @@
+/*
+ * Copyright © 2016 Canonical Ltd.
+ *
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser 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 Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Authored by: Christopher James Halse Rogers <[e-mail]>
+ */
+
+#include "mir/graphics/require_egl_extensions.h"
+
+#include <epoxy/egl.h>
+
+#include <stdexcept>
+#include <vector>
+#include <sstream>
+#include <boost/throw_exception.hpp>
+
+namespace mg = mir::graphics;
+
+void mg::require_egl_extensions(
+    EGLDisplay dpy,
+    std::initializer_list<char const*> const& extensions)
+{
+    using namespace std::string_literals;
+    std::vector<char const*> missing_extensions;
+    for (auto extension : extensions)
+    {
+        if (!epoxy_has_egl_extension(dpy, extension))
+        {
+            missing_extensions.push_back(extension);
+        }
+    }
+    if (!missing_extensions.empty())
+    {
+        std::stringstream exception_message;
+        exception_message << "Missing required extension" << (missing_extensions.size() > 1 ? "s:" : ":");
+        for (auto missing_extension : missing_extensions)
+        {
+            exception_message << " " << missing_extension;
+        }
+        BOOST_THROW_EXCEPTION(std::runtime_error{exception_message.str()});
+    }
+}

=== modified file 'src/platform/symbols.map'
--- src/platform/symbols.map	2016-03-29 07:30:50 +0000
+++ src/platform/symbols.map	2016-05-04 04:43:00 +0000
@@ -288,3 +288,10 @@
     mir::udev::Context::ctx*;
   };
 } MIRPLATFORM_11;
+
+MIR_PLATFORM_0.24 {
+ global:
+  extern "C++" {
+    mir::graphics::require_egl_extensions*;
+  };
+} MIR_PLATFORM_0.21;

=== modified file 'tests/mir_test_doubles/mock_egl.cpp'
--- tests/mir_test_doubles/mock_egl.cpp	2016-01-29 08:18:22 +0000
+++ tests/mir_test_doubles/mock_egl.cpp	2016-05-04 04:43:00 +0000
@@ -21,6 +21,7 @@
 #include "mir/egl_native_surface.h"
 
 #include "mir/test/doubles/mock_egl.h"
+#include <dlfcn.h>
 #include <gtest/gtest.h>
 
 namespace mtd = mir::test::doubles;
@@ -198,6 +199,30 @@
         return;                             \
     }
 
+/*
+ * libepoxy will try and dlopen libEGL.so.1, so we have to
+ * wrap dlopen() and return the main executable for EGL
+ */
+void* dlopen(char const* filename, int flags) __THROWNL
+{
+    static void* (*real_dlopen)(char const*, int) = nullptr;
+
+    if (real_dlopen == nullptr)
+    {
+        real_dlopen =
+            reinterpret_cast<void*(*)(char const*, int)>(dlsym(RTLD_NEXT, "dlopen"));
+    }
+
+    if (strcmp(filename, "libEGL.so.1") == 0)
+    {
+        return real_dlopen(NULL, flags);
+    }
+    else
+    {
+        return real_dlopen(filename, flags);
+    }
+}
+
 EGLint eglGetError (void)
 {
     CHECK_GLOBAL_MOCK(EGLint)

=== modified file 'tests/unit-tests/graphics/CMakeLists.txt'
--- tests/unit-tests/graphics/CMakeLists.txt	2016-05-03 04:36:33 +0000
+++ tests/unit-tests/graphics/CMakeLists.txt	2016-05-04 04:43:00 +0000
@@ -10,6 +10,7 @@
     ${CMAKE_CURRENT_SOURCE_DIR}/test_overlapping_output_grouping.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/test_software_cursor.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/test_anonymous_shm_file.cpp
+    ${CMAKE_CURRENT_SOURCE_DIR}/test_require_egl_extensions.cpp
 )
 
 

=== added file 'tests/unit-tests/graphics/test_require_egl_extensions.cpp'
--- tests/unit-tests/graphics/test_require_egl_extensions.cpp	1970-01-01 00:00:00 +0000
+++ tests/unit-tests/graphics/test_require_egl_extensions.cpp	2016-05-04 04:43:00 +0000
@@ -0,0 +1,102 @@
+/*
+ * Copyright © 2016 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:
+ *   Christopher James Halse Rogers <[e-mail]>
+ */
+
+#include "mir/graphics/require_egl_extensions.h"
+#include "mir/test/doubles/mock_egl.h"
+#include <stdexcept>
+
+#include <gtest/gtest.h>
+#include <gmock/gmock.h>
+
+namespace mg = mir::graphics;
+namespace mtd = mir::test::doubles;
+using namespace testing;
+
+typedef mtd::MockEGL::generic_function_pointer_t func_ptr_t;
+class RequireEglExtensions  : public ::testing::Test
+{
+protected:
+    virtual void SetUp()
+    {
+    }
+
+    testing::NiceMock<mtd::MockEGL> mock_egl;
+};
+
+TEST_F(RequireEglExtensions, succeeds_if_all_extensions_are_found)
+{
+    ON_CALL(mock_egl, eglQueryString(EGL_NO_DISPLAY, EGL_EXTENSIONS))
+        .WillByDefault(
+            Return("EGL_EXT_platform_base EGL_EXT_platform_device EGL_EXT_device_base"));
+
+    mg::require_egl_extensions(EGL_NO_DISPLAY, {
+        "EGL_EXT_platform_base",
+        "EGL_EXT_platform_device",
+        "EGL_EXT_device_base"
+    });
+}
+
+TEST_F(RequireEglExtensions, succeeds_if_all_client_extensions_are_found)
+{
+    ON_CALL(mock_egl, eglQueryString(EGL_NO_DISPLAY, EGL_EXTENSIONS))
+        .WillByDefault(
+            Return("EGL_EXT_platform_base EGL_EXT_platform_device EGL_EXT_device_base"));
+
+    mg::require_egl_extensions(EGL_NO_DISPLAY, {
+        "EGL_EXT_platform_base",
+        "EGL_EXT_platform_device",
+        "EGL_EXT_device_base"
+    });
+}
+
+TEST_F(RequireEglExtensions, succeeds_if_all_display_extensions_are_found)
+{
+    EGLDisplay dummy = reinterpret_cast<EGLDisplay>(0xdeadbeef);
+    ON_CALL(mock_egl, eglQueryString(dummy, EGL_EXTENSIONS))
+        .WillByDefault(
+            Return("EGL_KHR_image EGL_KHR_image_base EGL_KHR_reusable_sync EGL_KHR_stream"));
+
+    mg::require_egl_extensions(dummy, {
+        "EGL_KHR_image",
+        "EGL_KHR_image_base",
+    });
+}
+
+TEST_F(RequireEglExtensions, fails_with_list_of_unsupported_extensions)
+{
+    ON_CALL(mock_egl, eglQueryString(EGL_NO_DISPLAY, EGL_EXTENSIONS))
+        .WillByDefault(Return("EGL_EXT_device_base"));
+
+    auto required_extensions = {
+        "EGL_EXT_platform_base",
+        "EGL_EXT_device_base",
+        "EGL_EXT_platform_device",
+    };
+    try
+    {
+        mg::require_egl_extensions(EGL_NO_DISPLAY, required_extensions);
+    }
+    catch (std::runtime_error const& err)
+    {
+        EXPECT_THAT(err.what(), AllOf(HasSubstr("EGL_EXT_platform_base"), HasSubstr("EGL_EXT_platform_device")));
+        return;
+    }
+
+    FAIL() << "require_egl_extensions unexpectedly succeeded";
+}