Allow libremote-processor to be compiled without networking support

In such a case, libremote-processor becomes useless but still acts as if it was working correctly. This is an easy way to have a version of libparameter that does not embed any networking code, which is required in some case for security compliance reasons. This can be achieved by turning the NETWORKING option OFF when configuring the CMake project. Signed-off-by: David Wagner <[email protected]>
intel · Feb 16, 2016 · 472927e · 472927e
1 parent 25bd503
commit 472927e
Show file tree

Hide file tree

Showing 6 changed files with 207 additions and 23 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -1,4 +1,4 @@
-# Copyright (c) 2014-2015, Intel Corporation
+# Copyright (c) 2014-2016, Intel Corporation
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without modification,
@@ -47,6 +47,8 @@ option(REQUIREMENTS "Generate the html version of the 'requirements' documentati
 option(PYTHON_BINDINGS "Python library to use the Parameter Framework from python" ON)
 option(C_BINDINGS "Library to use the Parameter Framework using a C API" ON)
 option(FATAL_WARNINGS "Turn warnings into errors (-Werror flag)" ON)
+option(NETWORKING "Set to OFF in order to stub networking code" ON)
+mark_as_advanced(FORCE NETWORKING)
 
 include(SetVersion.cmake)
 
@@ -102,6 +104,7 @@ endif()
 add_subdirectory(xmlserializer)
 add_subdirectory(parameter)
 add_subdirectory(utility)
+add_subdirectory(asio)
 add_subdirectory(remote-processor)
 
 add_subdirectory(remote-process)

diff --git a/asio/CMakeLists.txt b/asio/CMakeLists.txt
@@ -0,0 +1,55 @@
+# Copyright (c) 2016, Intel Corporation
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without modification,
+# are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice, this
+# list of conditions and the following disclaimer.
+#
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation and/or
+# other materials provided with the distribution.
+#
+# 3. Neither the name of the copyright holder nor the names of its contributors
+# may be used to endorse or promote products derived from this software without
+# specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+# ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+# ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+# Find ASIO (the standalone version, not Boost)
+# If asio isn't installed in a standard directory, add the correct directory to
+# CMAKE_PREFIX_PATH (see the main README for more information).
+find_path(ASIO_DIR NAMES asio.hpp)
+# Hide this variable from CMake GUIs and `cmake -L`
+set_property(CACHE ASIO_DIR PROPERTY ADVANCED TRUE)
+if (NOT ASIO_DIR)
+    message(SEND_ERROR
+" ASIO header (asio.hpp) could not be found.
+ASIO is used for networking. On Linux, you should install it using your
+package manager. On Windows, please refer to the main README.")
+endif()
+
+add_library(asio STATIC)
+# Ubuntu 14.04 packages asio 1.10.1 and clang 3.4.1.
+# In this environment, asio stand alone (set ASIO_STANDALONE)
+# does not correcly detect that the stl has CHRONO support (c++11).
+# Force the use of std::chrono by setting ASIO_HAS_STD_CHRONO
+set_target_properties(asio PROPERTIES LINKER_LANGUAGE "CXX")
+target_include_directories(asio INTERFACE "${ASIO_DIR}")
+target_link_libraries(asio INTERFACE "${CMAKE_THREAD_LIBS_INIT}")
+target_compile_definitions(asio INTERFACE ASIO_STANDALONE ASIO_HAS_STD_CHRONO)
+
+# Stubbed version
+add_library(asio-stub STATIC stub/asio.cpp)
+set_target_properties(asio-stub PROPERTIES POSITION_INDEPENDENT_CODE TRUE)
+target_include_directories(asio-stub PUBLIC "${CMAKE_CURRENT_SOURCE_DIR}/stub")
diff --git a/asio/stub/asio.cpp b/asio/stub/asio.cpp
@@ -0,0 +1,42 @@
+/*
+ * Copyright (c) 2016, Intel Corporation
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without modification,
+ * are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following disclaimer in the documentation and/or
+ * other materials provided with the distribution.
+ *
+ * 3. Neither the name of the copyright holder nor the names of its contributors
+ * may be used to endorse or promote products derived from this software without
+ * specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+#include "asio.hpp"
+
+namespace asio
+{
+bool write(const dummy_base &, const dummy_base &, const dummy_base &)
+{
+    return true;
+}
+bool read(const dummy_base &, const dummy_base &, const dummy_base &)
+{
+    return true;
+}
+}
diff --git a/asio/stub/asio.hpp b/asio/stub/asio.hpp
@@ -0,0 +1,97 @@
+/*
+ * Copyright (c) 2016, Intel Corporation
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without modification,
+ * are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following disclaimer in the documentation and/or
+ * other materials provided with the distribution.
+ *
+ * 3. Neither the name of the copyright holder nor the names of its contributors
+ * may be used to endorse or promote products derived from this software without
+ * specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+#pragma once
+
+#include <system_error>
+
+namespace asio
+{
+struct dummy_base
+{
+    template <class... Args>
+    dummy_base(Args &&...)
+    {
+    }
+    void set_option(const dummy_base &) const {};
+};
+using buffer = dummy_base;
+struct io_service : dummy_base
+{
+    using dummy_base::dummy_base;
+
+    void run(const dummy_base &) const {};
+    void stop() const {};
+};
+struct socket_base : dummy_base
+{
+    using dummy_base::dummy_base;
+
+    using linger = dummy_base;
+    using enable_connection_aborted = dummy_base;
+    void close() const {};
+};
+
+bool write(const dummy_base &, const dummy_base &, const dummy_base &);
+bool read(const dummy_base &, const dummy_base &, const dummy_base &);
+
+struct error_code : dummy_base, std::error_code
+{
+};
+namespace error
+{
+static const error_code eof{};
+}
+
+namespace ip
+{
+namespace tcp
+{
+using v6 = dummy_base;
+using no_delay = dummy_base;
+using socket = socket_base;
+struct endpoint : dummy_base
+{
+    using dummy_base::dummy_base;
+
+    dummy_base protocol() const { return {}; };
+};
+struct acceptor : dummy_base
+{
+    using dummy_base::dummy_base;
+
+    using reuse_address = dummy_base;
+    void open(const dummy_base &) const {};
+    void bind(const dummy_base &) const {};
+    void listen() const {};
+    void async_accept(const dummy_base &, const dummy_base &) const {};
+};
+}
+}
+}
diff --git a/remote-process/CMakeLists.txt b/remote-process/CMakeLists.txt
@@ -1,4 +1,4 @@
-# Copyright (c) 2014, Intel Corporation
+# Copyright (c) 2014-2016, Intel Corporation
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without modification,
@@ -32,11 +32,6 @@ set(CMAKE_THREAD_PREFER_PTHREAD 1)
 find_package(Threads REQUIRED)
 
 target_link_libraries(remote-process
-    PRIVATE remote-processor pfw_utility
-    # Remote-process does not use thread,
-    # nevertheless it uses asio resolver wich may use a thread (for async resolve).
-    # As a result remote-process must link with a thread library although not
-    # using the corresponding symbols.
-    PRIVATE "${CMAKE_THREAD_LIBS_INIT}")
+                      PRIVATE remote-processor pfw_utility asio ${CMAKE_THREAD_LIBS_INIT})
 
 install(TARGETS remote-process RUNTIME DESTINATION bin)
diff --git a/remote-processor/CMakeLists.txt b/remote-processor/CMakeLists.txt
@@ -1,4 +1,4 @@
-# Copyright (c) 2014-2015, Intel Corporation
+# Copyright (c) 2014-2016, Intel Corporation
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without modification,
@@ -40,20 +40,6 @@ generate_export_header(remote-processor
 set(CMAKE_THREAD_PREFER_PTHREAD 1)
 find_package(Threads REQUIRED)
 
-# Find ASIO (the standalone version, not Boost)
-# If asio isn't installed in a standard directory, add the correct directory to
-# CMAKE_PREFIX_PATH (see the main README for more information).
-find_path(ASIO_DIR NAMES asio.hpp)
-# Hide this variable from CMake GUIs and `cmake -L`
-set_property(CACHE ASIO_DIR PROPERTY ADVANCED TRUE)
-target_include_directories(remote-processor SYSTEM PRIVATE "${ASIO_DIR}")
-
-# Ubuntu 14.04 packages asio 1.10.1 and clang 3.4.1.
-# In this environment, asio stand alone (set ASIO_STANDALONE)
-# does not correcly detect that the stl has CHRONO support (c++11).
-# Force the use of std::chrono by setting ASIO_HAS_STD_CHRONO
-target_compile_definitions(remote-processor PRIVATE ASIO_STANDALONE ASIO_HAS_STD_CHRONO)
-
 target_include_directories(remote-processor
     # Symbol export macro header
     PUBLIC "${CMAKE_CURRENT_BINARY_DIR}"
@@ -62,4 +48,10 @@ target_include_directories(remote-processor
 
 target_link_libraries(remote-processor PRIVATE pfw_utility ${CMAKE_THREAD_LIBS_INIT})
 
+if(NETWORKING)
+    target_link_libraries(remote-processor PRIVATE asio)
+else()
+    target_link_libraries(remote-processor PRIVATE asio-stub)
+endif()
+
 install(TARGETS remote-processor LIBRARY DESTINATION lib RUNTIME DESTINATION bin)