Merge branch 'devel'

Author: rizsotto

CMakeLists.txt

@@ -1,16 +1,6 @@
 cmake_minimum_required(VERSION 3.12 FATAL_ERROR)
 cmake_policy(VERSION 3.12)
 
-set(default_build_type "Release")
-if (NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES)
-    message(STATUS "Setting build type to '${default_build_type}' as none was specified.")
-    set(CMAKE_BUILD_TYPE "${default_build_type}" CACHE
-            STRING "Choose the type of build." FORCE)
-    # Set the possible values of build type for cmake-gui
-    set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS
-            "Debug" "Release" "MinSizeRel" "RelWithDebInfo")
-endif ()
-
 project(Bear
         VERSION 3.0.0
         DESCRIPTION "Bear is a tool to generate compilation database for clang tooling."
@@ -24,6 +14,16 @@ set(CMAKE_CXX_STANDARD 17)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 set(CMAKE_CXX_EXTENSIONS OFF)
 
+set(default_build_type "Release")
+if (NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES)
+    message(STATUS "Setting build type to '${default_build_type}' as none was specified.")
+    set(CMAKE_BUILD_TYPE "${default_build_type}" CACHE
+            STRING "Choose the type of build." FORCE)
+    # Set the possible values of build type for cmake-gui
+    set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS
+            "Debug" "Release" "MinSizeRel" "RelWithDebInfo")
+endif ()
+
 # Superbuild variables for sub projects
 include(ExternalProject)
 set_property(DIRECTORY PROPERTY EP_BASE ${CMAKE_BINARY_DIR}/subprojects)
@@ -47,7 +47,7 @@ ExternalProject_Add(BearSource
             -DCMAKE_CXX_STANDARD_REQUIRED=${CMAKE_CXX_STANDARD_REQUIRED}
             -DCMAKE_CXX_EXTENSIONS=${CMAKE_CXX_EXTENSIONS}
             -DCMAKE_CXX_FLAGS:STRING=${CMAKE_CXX_FLAGS}
-	        -DCMAKE_CXX_COMPILER:STRING=${CMAKE_CXX_COMPILER}
+            -DCMAKE_CXX_COMPILER:STRING=${CMAKE_CXX_COMPILER}
         CMAKE_CACHE_ARGS
             -DCMAKE_PREFIX_PATH:PATH=${CMAKE_PREFIX_PATH}
             -DCMAKE_INSTALL_PREFIX:PATH=${STAGED_INSTALL_PREFIX}
@@ -81,16 +81,18 @@ if (ENABLE_FUNC_TESTS)
 endif ()
 
 # Install the project artifacts from the staged directory
-install(
-        DIRECTORY
+include(GNUInstallDirs)
+install(DIRECTORY
             ${STAGED_INSTALL_PREFIX}/
         DESTINATION
             .
         USE_SOURCE_PERMISSIONS
 )
-include(GNUInstallDirs)
-install(FILES COPYING README.md INSTALL.md CONTRIBUTING.md CODE_OF_CONDUCT.md
-        DESTINATION ${CMAKE_INSTALL_DOCDIR})
+install(FILES
+            COPYING README.md INSTALL.md CONTRIBUTING.md CODE_OF_CONDUCT.md
+        DESTINATION
+            ${CMAKE_INSTALL_DOCDIR}
+)
 
 # Set up package from this project
 set(CPACK_PACKAGE_NAME "bear")

source/intercept-library/library/CMakeLists.txt

@@ -9,7 +9,9 @@ add_library(exec_a OBJECT
         source/Buffer.cc
         source/Environment.cc
         source/Executor.cc
+        source/Linker.cc
         source/Logger.cc
+        source/Paths.cc
         source/Resolver.cc
         source/Session.cc
         )
@@ -49,6 +51,7 @@ if (ENABLE_UNIT_TESTS)
             test/ArrayTest.cc
             test/BufferTest.cc
             test/ExecutorTest.cc
+            test/PathsTest.cc
             test/SessionTest.cc
             )
 

source/intercept-library/library/lib.cc

@@ -19,13 +19,22 @@
 
 #include <atomic>
 #include <cerrno>
+#include <climits>
 #include <cstdarg>
 
 #include "Executor.h"
+#include "Linker.h"
 #include "Logger.h"
 #include "Resolver.h"
 #include "Session.h"
 
+#if defined HAVE_NSGETENVIRON
+#include <crt_externs.h>
+#else
+#include <unistd.h>
+
+#endif
+
 namespace {
 
     size_t va_length(va_list& args)
@@ -41,6 +50,24 @@ namespace {
         for (size_t idx = 0; idx < argc; ++idx)
             argv[idx] = va_arg(args, char*);
     }
+
+    /**
+     * Abstraction to get the current environment.
+     *
+     * When the dynamic linker loads the library the `environ` variable
+     * might not be available. (This is the case for OSX.) This method
+     * makes it uniform to access the current environment on all platform.
+     *
+     * @return the current environment.
+     */
+    const char** environment() noexcept
+    {
+#ifdef HAVE_NSGETENVIRON
+        return const_cast<const char**>(*_NSGetEnviron());
+#else
+        return const_cast<const char**>(environ);
+#endif
+    }
 }
 
 /**
@@ -50,13 +77,13 @@ namespace {
  */
 namespace {
     // This is the only non stack memory that this library is using.
-    constexpr size_t BUFFER_SIZE = 15 * 1024;
+    constexpr size_t BUFFER_SIZE = PATH_MAX * 2;
     char BUFFER[BUFFER_SIZE];
     // This is used for being multi thread safe (loading time only).
     std::atomic<bool> LOADED(false);
     // These are related to the functionality of this library.
     el::Session SESSION = el::session::init();
-    el::Resolver RESOLVER;
+    el::Linker LINKER;
 
     constexpr el::log::Logger LOGGER("lib.cc");
 }
@@ -73,7 +100,7 @@ extern "C" void on_load()
     if (LOADED.exchange(true))
         return;
 
-    el::session::from(SESSION, RESOLVER.environment());
+    el::session::from(SESSION, environment());
     el::session::persist(SESSION, BUFFER, BUFFER + BUFFER_SIZE);
 
     el::log::Level level = SESSION.verbose ? el::log::VERBOSE : el::log::SILENT;
@@ -101,7 +128,8 @@ extern "C" int execve(const char* path, char* const argv[], char* const envp[])
 {
     LOGGER.debug("execve path: ", path);
 
-    const el::Executor::Result result = el::Executor(RESOLVER, SESSION).execve(path, argv, envp);
+    el::Resolver resolver;
+    const el::Executor::Result result = el::Executor(LINKER, SESSION, resolver).execve(path, argv, envp);
     errno = result.error_code;
     return result.return_value;
 }
@@ -110,8 +138,9 @@ extern "C" int execv(const char* path, char* const argv[])
 {
     LOGGER.debug("execv path: ", path);
 
-    auto envp = const_cast<char* const*>(RESOLVER.environment());
-    const el::Executor::Result result = el::Executor(RESOLVER, SESSION).execve(path, argv, envp);
+    auto envp = const_cast<char* const*>(environment());
+    el::Resolver resolver;
+    const el::Executor::Result result = el::Executor(LINKER, SESSION, resolver).execve(path, argv, envp);
     errno = result.error_code;
     return result.return_value;
 }
@@ -120,7 +149,8 @@ extern "C" int execvpe(const char* file, char* const argv[], char* const envp[])
 {
     LOGGER.debug("execvpe file: ", file);
 
-    const el::Executor::Result result = el::Executor(RESOLVER, SESSION).execvpe(file, argv, envp);
+    el::Resolver resolver;
+    const el::Executor::Result result = el::Executor(LINKER, SESSION, resolver).execvpe(file, argv, envp);
     errno = result.error_code;
     return result.return_value;
 }
@@ -129,8 +159,9 @@ extern "C" int execvp(const char* file, char* const argv[])
 {
     LOGGER.debug("execvp file: ", file);
 
-    auto envp = const_cast<char* const*>(RESOLVER.environment());
-    const el::Executor::Result result = el::Executor(RESOLVER, SESSION).execvpe(file, argv, envp);
+    auto envp = const_cast<char* const*>(environment());
+    el::Resolver resolver;
+    const el::Executor::Result result = el::Executor(LINKER, SESSION, resolver).execvpe(file, argv, envp);
     errno = result.error_code;
     return result.return_value;
 }
@@ -139,8 +170,9 @@ extern "C" int execvP(const char* file, const char* search_path, char* const arg
 {
     LOGGER.debug("execvP file: ", file);
 
-    auto envp = const_cast<char* const*>(RESOLVER.environment());
-    const el::Executor::Result result = el::Executor(RESOLVER, SESSION).execvP(file, search_path, argv, envp);
+    auto envp = const_cast<char* const*>(environment());
+    el::Resolver resolver;
+    const el::Executor::Result result = el::Executor(LINKER, SESSION, resolver).execvP(file, search_path, argv, envp);
     errno = result.error_code;
     return result.return_value;
 }
@@ -149,7 +181,8 @@ extern "C" int exect(const char* path, char* const argv[], char* const envp[])
 {
     LOGGER.debug("exect path: ", path);
 
-    const el::Executor::Result result = el::Executor(RESOLVER, SESSION).execve(path, argv, envp);
+    el::Resolver resolver;
+    const el::Executor::Result result = el::Executor(LINKER, SESSION, resolver).execve(path, argv, envp);
     errno = result.error_code;
     return result.return_value;
 }
@@ -173,8 +206,9 @@ extern "C" int execl(const char* path, const char* arg, ...)
     va_copy_n(ap, &argv[1], argc + 1);
     va_end(ap);
 
-    auto envp = const_cast<char* const*>(RESOLVER.environment());
-    const el::Executor::Result result = el::Executor(RESOLVER, SESSION).execve(path, argv, envp);
+    auto envp = const_cast<char* const*>(environment());
+    el::Resolver resolver;
+    const el::Executor::Result result = el::Executor(LINKER, SESSION, resolver).execve(path, argv, envp);
     errno = result.error_code;
     return result.return_value;
 }
@@ -195,8 +229,9 @@ extern "C" int execlp(const char* file, const char* arg, ...)
     va_copy_n(ap, &argv[1], argc + 1);
     va_end(ap);
 
-    auto envp = const_cast<char* const*>(RESOLVER.environment());
-    const el::Executor::Result result = el::Executor(RESOLVER, SESSION).execvpe(file, argv, envp);
+    auto envp = const_cast<char* const*>(environment());
+    el::Resolver resolver;
+    const el::Executor::Result result = el::Executor(LINKER, SESSION, resolver).execvpe(file, argv, envp);
     errno = result.error_code;
     return result.return_value;
 }
@@ -219,7 +254,8 @@ extern "C" int execle(const char* path, const char* arg, ...)
     char** envp = va_arg(ap, char**);
     va_end(ap);
 
-    const el::Executor::Result result = el::Executor(RESOLVER, SESSION).execve(path, argv, envp);
+    el::Resolver resolver;
+    const el::Executor::Result result = el::Executor(LINKER, SESSION, resolver).execve(path, argv, envp);
     errno = result.error_code;
     return result.return_value;
 }
@@ -233,7 +269,8 @@ extern "C" int posix_spawn(pid_t* pid, const char* path,
 {
     LOGGER.debug("posix_spawn path:", path);
 
-    const el::Executor::Result result = el::Executor(RESOLVER, SESSION).posix_spawn(pid, path, file_actions, attrp, argv, envp);
+    el::Resolver resolver;
+    const el::Executor::Result result = el::Executor(LINKER, SESSION, resolver).posix_spawn(pid, path, file_actions, attrp, argv, envp);
     errno = result.error_code;
     return result.return_value;
 }
@@ -245,7 +282,8 @@ extern "C" int posix_spawnp(pid_t* pid, const char* file,
 {
     LOGGER.debug("posix_spawnp file:", file);
 
-    const el::Executor::Result result = el::Executor(RESOLVER, SESSION).posix_spawnp(pid, file, file_actions, attrp, argv, envp);
+    el::Resolver resolver;
+    const el::Executor::Result result = el::Executor(LINKER, SESSION, resolver).posix_spawnp(pid, file, file_actions, attrp, argv, envp);
     errno = result.error_code;
     return result.return_value;
 }

source/intercept-library/library/source/Buffer.h

@@ -49,19 +49,18 @@ namespace el {
 
     public:
         Buffer(Buffer const&) = delete;
-
         Buffer(Buffer&&) noexcept = delete;
 
         Buffer& operator=(Buffer const&) = delete;
-
         Buffer& operator=(Buffer&&) noexcept = delete;
 
     private:
         char* top_;
         char* const end_;
     };
 
-    inline Buffer::Buffer(char* const begin, char* const end) noexcept
+    inline
+    Buffer::Buffer(char* const begin, char* const end) noexcept
             : top_(begin)
             , end_(end)
     {