Merge lp:~alan-griffiths/mir/dlopen-graphicsplatform into lp:~mir-team/mir/trunk

[Alan Griffiths]

graphics, config: Dynamically load the graphics platform

graphics, config: Dynamically load the graphics platform

Will follow up with MP to make the library configurable

[Alexandros Frantzis (afrantzis)]

Looks good, and works just fine locally.

review: Approve

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:772
http://jenkins.qa.ubuntu.com/job/mir-ci/790/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-saucy-i386-build/993
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-clang-saucy-amd64-build/878
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-saucy-amd64-ci/28/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-vm-ci-build/./distribution=quantal,flavor=amd64/466

Click here to trigger a rebuild:
http://s-jenkins:8080/job/mir-ci/790/rebuild

review: Needs Fixing (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:773
http://jenkins.qa.ubuntu.com/job/mir-ci/791/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-saucy-i386-build/994
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-clang-saucy-amd64-build/879
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-saucy-amd64-ci/29/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-vm-ci-build/./distribution=quantal,flavor=amd64/467

Click here to trigger a rebuild:
http://s-jenkins:8080/job/mir-ci/791/rebuild

review: Needs Fixing (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:774
http://jenkins.qa.ubuntu.com/job/mir-ci/792/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-saucy-i386-build/995
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-clang-saucy-amd64-build/880
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-saucy-amd64-ci/30
        deb: http://jenkins.qa.ubuntu.com/job/mir-saucy-amd64-ci/30/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-vm-ci-build/./distribution=quantal,flavor=amd64/468

Click here to trigger a rebuild:
http://s-jenkins:8080/job/mir-ci/792/rebuild

review: Approve (continuous-integration)

[Kevin DuBois (kdub)]

looks good!

review: Approve

=== modified file 'CMakeLists.txt'
--- CMakeLists.txt	2013-06-19 09:57:32 +0000
+++ CMakeLists.txt	2013-06-21 15:26:27 +0000
@@ -42,7 +42,7 @@
 include (cmake/PrePush.cmake)
 
 set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -g -Werror -Wall -pedantic -Wextra -fPIC")
-set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -g -std=c++0x -Werror -Wall -fno-strict-aliasing -pedantic -Wnon-virtual-dtor -Wextra -fPIC")
+set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -g -std=c++0x -Werror -Wall -fno-strict-aliasing -pedantic -Wnon-virtual-dtor -Wextra -fPIC -Wno-return-type-c-linkage")
 set(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} -Wl,--no-undefined")
 
 #####################################################################

=== modified file 'debian/libmirserver0.install'
--- debian/libmirserver0.install	2013-05-22 10:24:51 +0000
+++ debian/libmirserver0.install	2013-06-21 15:26:27 +0000
@@ -1,2 +1,3 @@
 usr/lib/libmirserver.so.*
+usr/lib/libmirplatformgraphics.so*
 usr/lib/libmirserverlttng.so

=== modified file 'examples/render_to_fb.cpp'
--- examples/render_to_fb.cpp	2013-06-20 02:16:09 +0000
+++ examples/render_to_fb.cpp	2013-06-21 15:26:27 +0000
@@ -16,6 +16,7 @@
  * Authored by: Kevin DuBois <[e-mail]>
  */
 
+#include "mir/shared_library.h"
 #include "mir/graphics/platform.h"
 #include "mir/graphics/display.h"
 #include "mir/graphics/display_buffer.h"
@@ -56,8 +57,10 @@
     sigaction(SIGINT, &sa, NULL);
     sigaction(SIGTERM, &sa, NULL);
 
+    mir::SharedLibrary libmirplatformgraphics("libmirplatformgraphics.so");
     auto logger = std::make_shared<ml::DumbConsoleLogger>();
-    auto platform = mg::create_platform(std::make_shared<mo::ProgramOption>(), std::make_shared<ml::DisplayReport>(logger));
+    auto report = std::make_shared<ml::DisplayReport>(logger);
+    auto platform = libmirplatformgraphics.load_function<mg::CreatePlatform>("create_platform")(std::make_shared<mo::ProgramOption>(), report);
     auto display = platform->create_display();
 
     mir::draw::glAnimationBasic gl_animation;

=== modified file 'include/server/mir/graphics/platform.h'
--- include/server/mir/graphics/platform.h	2013-06-20 23:34:40 +0000
+++ include/server/mir/graphics/platform.h	2013-06-21 15:26:27 +0000
@@ -101,7 +101,7 @@
      */
     virtual void fill_ipc_package(std::shared_ptr<compositor::BufferIPCPacker> const& packer,
                                   std::shared_ptr<compositor::Buffer> const& buffer) const = 0;
-    
+
     /**
      * Creates the in-process client support object.
      */
@@ -109,7 +109,7 @@
 };
 
 /**
- * Creates and returns a new graphics platform.
+ * Function prototype used to return a new graphics platform.
  *
  * \param [in] options options to use for this platform
  * \param [in] report the object to use to report interesting events from the display subsystem
@@ -118,8 +118,8 @@
  *
  * \ingroup platform_enablement
  */
-std::shared_ptr<Platform> create_platform(std::shared_ptr<options::Option> const& options, std::shared_ptr<DisplayReport> const& report);
-
+extern "C" typedef std::shared_ptr<Platform>(*CreatePlatform)(std::shared_ptr<options::Option> const& options, std::shared_ptr<DisplayReport> const& report);
+extern "C" std::shared_ptr<Platform> create_platform (std::shared_ptr<options::Option> const& options, std::shared_ptr<DisplayReport> const& report);
 }
 }
 

=== added file 'include/server/mir/shared_library.h'
--- include/server/mir/shared_library.h	1970-01-01 00:00:00 +0000
+++ include/server/mir/shared_library.h	2013-06-21 15:26:27 +0000
@@ -0,0 +1,55 @@
+/*
+ * Copyright © 2013 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: Alan Griffiths <[e-mail]>
+ */
+
+#ifndef MIR_SHARED_LIBRARY_H_
+#define MIR_SHARED_LIBRARY_H_
+
+#include <string>
+
+namespace mir
+{
+class SharedLibrary
+{
+public:
+    explicit SharedLibrary(char const* library_name);
+    explicit SharedLibrary(std::string const& library_name);
+    ~SharedLibrary();
+
+    template<typename FunctionPtr>
+    FunctionPtr load_function(char const* function_name) const
+    {
+        FunctionPtr result{};
+        (void*&)result = load_symbol(function_name);
+        return result;
+    }
+
+    template<typename FunctionPtr>
+    FunctionPtr load_function(std::string const& function_name) const
+    {
+        return load_function<FunctionPtr>(function_name.c_str());
+    }
+private:
+    void* const so;
+    void* load_symbol(char const* function_name) const;
+    SharedLibrary(SharedLibrary const&) = delete;
+    SharedLibrary& operator=(SharedLibrary const&) = delete;
+};
+}
+
+
+#endif /* MIR_SHARED_LIBRARY_H_ */

=== modified file 'src/server/CMakeLists.txt'
--- src/server/CMakeLists.txt	2013-06-03 08:14:01 +0000
+++ src/server/CMakeLists.txt	2013-06-21 15:26:27 +0000
@@ -28,6 +28,7 @@
   display_server.cpp
   default_server_configuration.cpp
   asio_main_loop.cpp
+  shared_library.cpp
 )
 
 set(MIRSERVER_LINKAGE SHARED)
@@ -50,9 +51,10 @@
 )
 
 list(APPEND MIRSERVER_LINKS
-  mirplatformgraphics
   mirprotobuf
   3rd_party
+  ${EGL_LDFLAGS} ${EGL_LIBRARIES}
+  ${GLESv2_LDFLAGS} ${GLESv2_LIBRARIES}
 )
 
 if(${MIRSERVER_LINKAGE} STREQUAL SHARED)

=== modified file 'src/server/default_server_configuration.cpp'
--- src/server/default_server_configuration.cpp	2013-06-20 23:34:12 +0000
+++ src/server/default_server_configuration.cpp	2013-06-21 15:26:27 +0000
@@ -19,6 +19,7 @@
 #include "mir/default_server_configuration.h"
 #include "mir/abnormal_exit.h"
 #include "mir/asio_main_loop.h"
+#include "mir/shared_library.h"
 
 #include "mir/options/program_option.h"
 #include "mir/compositor/buffer_allocation_strategy.h"
@@ -290,18 +291,15 @@
         });
 }
 
+
 std::shared_ptr<mg::Platform> mir::DefaultServerConfiguration::the_graphics_platform()
 {
     return graphics_platform(
         [this]()
         {
-            // TODO I doubt we need the extra level of indirection provided by
-            // mg::create_platform() - we just need to move the implementation
-            // of DefaultServerConfiguration::the_graphics_platform() to the
-            // graphics libraries.
-            // Alternatively, if we want to dynamically load the graphics library
-            // then this would be the place to do that.
-            return mg::create_platform(the_options(), the_display_report());
+            static SharedLibrary libmirplatformgraphics("libmirplatformgraphics.so");
+            static auto create_platform = libmirplatformgraphics.load_function<mg::CreatePlatform>("create_platform");
+            return create_platform(the_options(), the_display_report());
         });
 }
 

=== modified file 'src/server/graphics/CMakeLists.txt'
--- src/server/graphics/CMakeLists.txt	2013-06-14 18:24:09 +0000
+++ src/server/graphics/CMakeLists.txt	2013-06-21 15:26:27 +0000
@@ -32,5 +32,6 @@
   mirlogging
 
   ${MIR_COMMON_PLATFORM_LIBRARIES}
-  ${GLESv2_LIBRARIES}
+  ${EGL_LDFLAGS} ${EGL_LIBRARIES}
+  ${GLESv2_LDFLAGS} ${GLESv2_LIBRARIES}
 )

=== modified file 'src/server/graphics/android/CMakeLists.txt'
--- src/server/graphics/android/CMakeLists.txt	2013-05-21 21:43:25 +0000
+++ src/server/graphics/android/CMakeLists.txt	2013-06-21 15:26:27 +0000
@@ -5,7 +5,7 @@
 )
 
 add_library(
-  mirplatformgraphics STATIC
+  mirplatformgraphics SHARED
 
   android_platform.cpp
   android_buffer_allocator.cpp
@@ -33,9 +33,12 @@
 
 target_link_libraries(
   mirplatformgraphics
-  mircompositor
+  mirserver
+  mirsharedandroid
 
   ${LIBHARDWARE_LIBRARIES}
   ${EGL_LDFLAGS} ${EGL_LIBRARIES}
   ${GLESv2_LDFLAGS} ${GLESv2_LIBRARIES}
 )
+
+install(TARGETS mirplatformgraphics LIBRARY DESTINATION lib)

=== modified file 'src/server/graphics/android/android_platform.cpp'
--- src/server/graphics/android/android_platform.cpp	2013-06-20 23:34:40 +0000
+++ src/server/graphics/android/android_platform.cpp	2013-06-21 15:26:27 +0000
@@ -86,11 +86,11 @@
     for(auto i=0; i<buffer_handle->numFds; i++)
     {
         packer->pack_fd(buffer_handle->data[offset++]);
-    }    
+    }
     for(auto i=0; i<buffer_handle->numInts; i++)
     {
         packer->pack_data(buffer_handle->data[offset++]);
-    }    
+    }
 
     packer->pack_stride(buffer->stride());
 }
@@ -100,7 +100,7 @@
     return std::make_shared<mga::InternalClient>();
 }
 
-std::shared_ptr<mg::Platform> mg::create_platform(std::shared_ptr<mo::Option> const& /*options*/, std::shared_ptr<DisplayReport> const& display_report)
+extern "C" std::shared_ptr<mg::Platform> mg::create_platform(std::shared_ptr<mo::Option> const& /*options*/, std::shared_ptr<DisplayReport> const& display_report)
 {
     return std::make_shared<mga::AndroidPlatform>(display_report);
 }

=== modified file 'src/server/graphics/gbm/CMakeLists.txt'
--- src/server/graphics/gbm/CMakeLists.txt	2013-06-05 20:36:34 +0000
+++ src/server/graphics/gbm/CMakeLists.txt	2013-06-21 15:26:27 +0000
@@ -11,7 +11,7 @@
 
 
 add_library(
-  mirplatformgraphics STATIC
+  mirplatformgraphics SHARED
 
   gbm_platform.cpp
   gbm_buffer_allocator.cpp
@@ -34,11 +34,12 @@
 
 target_link_libraries(
   mirplatformgraphics
-  mircompositor
-  mirlogging
+  mirserver
 
   ${DRM_LDFLAGS} ${DRM_LIBRARIES}
   ${GBM_LDFLAGS} ${GBM_LIBRARIES}
   ${EGL_LDFLAGS} ${EGL_LIBRARIES}
   ${GLESv2_LDFLAGS} ${GLESv2_LIBRARIES}
 )
+
+install(TARGETS mirplatformgraphics LIBRARY DESTINATION lib)

=== modified file 'src/server/graphics/gbm/gbm_platform.cpp'
--- src/server/graphics/gbm/gbm_platform.cpp	2013-06-20 23:34:40 +0000
+++ src/server/graphics/gbm/gbm_platform.cpp	2013-06-21 15:26:27 +0000
@@ -144,7 +144,7 @@
     return std::make_shared<mgg::InternalClient>(internal_native_display);
 }
 
-std::shared_ptr<mg::Platform> mg::create_platform(std::shared_ptr<mo::Option> const& options, std::shared_ptr<DisplayReport> const& report)
+extern "C" std::shared_ptr<mg::Platform> mg::create_platform(std::shared_ptr<mo::Option> const& options, std::shared_ptr<DisplayReport> const& report)
 {
     auto real_fops = std::make_shared<RealVTFileOperations>();
     auto vt = std::make_shared<mgg::LinuxVirtualTerminal>(real_fops, options->get("vt", 0), report);

=== added file 'src/server/shared_library.cpp'
--- src/server/shared_library.cpp	1970-01-01 00:00:00 +0000
+++ src/server/shared_library.cpp	2013-06-21 15:26:27 +0000
@@ -0,0 +1,55 @@
+/*
+ * Copyright © 2013 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: Alan Griffiths <[e-mail]>
+ */
+
+#include "mir/shared_library.h"
+
+#include <boost/throw_exception.hpp>
+#include <boost/exception/info.hpp>
+
+#include <dlfcn.h>
+
+#include <stdexcept>
+
+mir::SharedLibrary::SharedLibrary(char const* library_name) :
+    so(dlopen(library_name, RTLD_NOW))
+{
+    if (!so)
+    {
+        BOOST_THROW_EXCEPTION(std::runtime_error(dlerror()));
+    }
+}
+
+mir::SharedLibrary::SharedLibrary(std::string const& library_name) :
+    SharedLibrary(library_name.c_str()) {}
+
+mir::SharedLibrary::~SharedLibrary()
+{
+    dlclose(so);
+}
+
+void* mir::SharedLibrary::load_symbol(char const* function_name) const
+{
+    if (void* result = dlsym(so, function_name))
+    {
+        return result;
+    }
+    else
+    {
+        BOOST_THROW_EXCEPTION(std::runtime_error(dlerror()));
+    }
+}

=== modified file 'tests/integration-tests/CMakeLists.txt'
--- tests/integration-tests/CMakeLists.txt	2013-05-30 03:50:54 +0000
+++ tests/integration-tests/CMakeLists.txt	2013-06-21 15:26:27 +0000
@@ -47,6 +47,7 @@
   mir-test-cucumber
 
   mirserver
+  mirplatformgraphics
   mirclient
   mirdraw
   mirtestdraw

=== modified file 'tests/unit-tests/CMakeLists.txt'
--- tests/unit-tests/CMakeLists.txt	2013-05-20 15:55:48 +0000
+++ tests/unit-tests/CMakeLists.txt	2013-06-21 15:26:27 +0000
@@ -6,6 +6,7 @@
 
   test_gmock_fixes.cpp
   test_asio_main_loop.cpp
+  shared_library_test.cpp
 )
 
 add_subdirectory(options/)
@@ -29,6 +30,7 @@
 
   mirclient
   mirserver
+  mirplatformgraphics
   mirdraw
   mirtestdraw
   mirlogging

=== added file 'tests/unit-tests/shared_library_test.cpp'
--- tests/unit-tests/shared_library_test.cpp	1970-01-01 00:00:00 +0000
+++ tests/unit-tests/shared_library_test.cpp	2013-06-21 15:26:27 +0000
@@ -0,0 +1,114 @@
+/*
+ * Copyright © 2013 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: Alan Griffiths <[e-mail]>
+ */
+
+#include "mir/shared_library.h"
+
+#include <gtest/gtest.h>
+
+#include <boost/exception/diagnostic_information.hpp>
+
+#include <stdexcept>
+
+namespace
+{
+class HasSubstring
+{
+public:
+    HasSubstring(char const* substring) : substring(substring) {}
+
+    friend::testing::AssertionResult operator,(std::string const& target, HasSubstring const& match)
+    {
+      if (std::string::npos != target.find(match.substring))
+        return ::testing::AssertionSuccess();
+      else
+        return ::testing::AssertionFailure() <<
+            "The target:\n\"" << target << "\"\n"
+            "Does not contain:\n\"" << match.substring << "\"";
+    }
+
+private:
+    char const* const substring;
+
+    HasSubstring(HasSubstring const&) = delete;
+    HasSubstring& operator=(HasSubstring const&) = delete;
+};
+
+#define EXPECT_THAT(target, condition) EXPECT_TRUE((target, condition))
+
+char const* const nonexistent_library  = "nonexistent_library";
+char const* const existing_library     = "libmirplatformgraphics.so";
+char const* const nonexistent_function = "nonexistent_library";
+char const* const existing_function    = "create_platform";
+}
+
+TEST(SharedLibrary, load_nonexistent_library_fails)
+{
+    EXPECT_THROW({ mir::SharedLibrary nonexistent(nonexistent_library); }, std::runtime_error);
+}
+
+TEST(SharedLibrary, load_nonexistent_library_fails_with_useful_info)
+{
+    try
+    {
+        mir::SharedLibrary nonexistent(nonexistent_library);
+    }
+    catch (std::exception const& error)
+    {
+        auto info = boost::diagnostic_information(error);
+
+        EXPECT_THAT(info, HasSubstring("cannot open shared object")) << "What went wrong";
+        EXPECT_THAT(info, HasSubstring(nonexistent_library)) << "Name of library";
+    }
+}
+
+TEST(SharedLibrary, load_valid_library_works)
+{
+    mir::SharedLibrary existing(existing_library);
+}
+
+TEST(SharedLibrary, load_nonexistent_function_fails)
+{
+    mir::SharedLibrary existing(existing_library);
+
+    EXPECT_THROW({ existing.load_function<void(*)()>(nonexistent_function); }, std::runtime_error);
+}
+
+TEST(SharedLibrary, load_nonexistent_function_fails_with_useful_info)
+{
+    mir::SharedLibrary existing(existing_library);
+
+    try
+    {
+        existing.load_function<void(*)()>(nonexistent_function);
+    }
+    catch (std::exception const& error)
+    {
+        auto info = boost::diagnostic_information(error);
+
+        EXPECT_THAT(info, HasSubstring("undefined symbol")) << "What went wrong";
+        EXPECT_THAT(info, HasSubstring(existing_library)) << "Name of library";
+        EXPECT_THAT(info, HasSubstring(nonexistent_function)) << "Name of function";
+    }
+}
+
+TEST(SharedLibrary, load_valid_function_works)
+{
+    mir::SharedLibrary existing(existing_library);
+    existing.load_function<void(*)()>(existing_function);
+}
+