RuntimeLibManager Class Reference

#include <RuntimeLibManager.h>

Static Public Member Functions
static void	loadRuntimeLibs (const std::string &torch_lib_path=std::string())
static void	loadTestRuntimeLibs ()
static bool	is_libtorch_loaded ()

Static Private Attributes
static bool	is_libtorch_loaded_

Detailed Description

Definition at line 4 of file RuntimeLibManager.h.

Member Function Documentation

bool RuntimeLibManager::is_libtorch_loaded ( )

static

Definition at line 146 of file RuntimeLibManager.cpp.

References is_libtorch_loaded_.

                                           {
  return is_libtorch_loaded_;
}

void RuntimeLibManager::loadRuntimeLibs ( const std::string &  torch_lib_path = std::string() )

static

Definition at line 52 of file RuntimeLibManager.cpp.

References logger::FATAL, get_torch_table_functions_path(), is_libtorch_loaded_, libtorch, libTorchTFs, LOG, and logger::WARNING.

Referenced by DBHandler::initialize(), and QueryRunner::QueryRunner::QueryRunner().

                                                                       {
  is_libtorch_loaded_ = false;
#ifdef HAVE_TORCH_TFS
  // Third party libraries must be loaded with the RTLD_GLOBAL flag set, so their symbols
  // can be available for resolution by further dynamic loads
  // They must also be loaded using RTLD_DEEPBIND, in case they have statically linked
  // symbols from common libraries that conflict with symbols also statically linked with
  // heavydb. For instance, LibTorch also statically links with LLVM, so not using
  // RTLD_DEEPBIND will cause issues with LibTorch referring to heavy's LLVM symbols or
  // vice-versa.
  if (!torch_lib_path.empty()) {
    boost::dll::fs::path lib_path(torch_lib_path);
    libtorch = boost::dll::shared_library(
        lib_path,
        boost::dll::load_mode::rtld_global | boost::dll::load_mode::rtld_deepbind);
  } else {
    libtorch = boost::dll::shared_library("libtorch",
                                          boost::dll::load_mode::search_system_folders |
                                              boost::dll::load_mode::append_decorations |
                                              boost::dll::load_mode::rtld_global |
                                              boost::dll::load_mode::rtld_deepbind);
  }

  if (!libtorch.is_loaded()) {
    throw(std::runtime_error(
        "Failed to load runtime library LibTorch. Support for library is disabled!"));
  }

  LOG(WARNING) << "This HeavyDB was built against LibTorch version " << TORCH_VERSION
               << ". Using a different version of LibTorch may cause breaking behavior!";

  // Shared libraries containing table function implementations must also be loaded
  // using RTLD_GLOBAL, as the JIT-ed LLVM code needs to resolve the symbols at runtime.
  // They must also be loaded using RTLD_DEEPBIND, which makes sure name binding favors
  // symbols local to the library before considering global ones. This makes sure the
  // TableFunctionsFactory::init() calls within the library call its own init() function
  // rather than the server's main one.
  // TODO: This behavior may not be supported in Windows, we should test symbol
  // resolution in Windows platforms to make sure this works.
  boost::dll::fs::path torch_tfs_lib_path(get_torch_table_functions_path());
  libTorchTFs = boost::dll::shared_library(
      torch_tfs_lib_path,
      boost::dll::load_mode::rtld_lazy | boost::dll::load_mode::search_system_folders |
          boost::dll::load_mode::rtld_global | boost::dll::load_mode::append_decorations |
          boost::dll::load_mode::rtld_deepbind);
  if (!libTorchTFs.is_loaded()) {
    throw(
        std::runtime_error("Failed to load LibTorch table function module. LibTorch "
                           "table function support is disabled!"));
  }

  if (!libTorchTFs.has("init_table_functions")) {
    LOG(FATAL) << "Load-time table function module does not contain "
                  "'init_table_functions' symbol!";
  }

  // calls the module's TableFunctionsFactory::init() to register table functions
  auto initFunction = libTorchTFs.get<void(void)>("init_table_functions");
  initFunction();
  is_libtorch_loaded_ = true;
#endif
}

Here is the call graph for this function:

Here is the caller graph for this function:

void RuntimeLibManager::loadTestRuntimeLibs ( )

static

Definition at line 118 of file RuntimeLibManager.cpp.

References logger::FATAL, get_runtime_test_lib_path(), get_runtime_test_lib_tfs_path(), LOG, testLib, and testLibTFs.

Referenced by QueryRunner::QueryRunner::QueryRunner().

                                            {
  testLib = boost::dll::shared_library(get_runtime_test_lib_path(),
                                       boost::dll::load_mode::append_decorations |
                                           boost::dll::load_mode::rtld_global |
                                           boost::dll::load_mode::search_system_folders |
                                           boost::dll::load_mode::rtld_deepbind);

  if (!testLib.is_loaded()) {
    throw(std::runtime_error("Failed to load test runtime library!"));
  }

  testLibTFs = boost::dll::shared_library(
      get_runtime_test_lib_tfs_path(),
      boost::dll::load_mode::rtld_lazy | boost::dll::load_mode::search_system_folders |
          boost::dll::load_mode::rtld_global | boost::dll::load_mode::append_decorations |
          boost::dll::load_mode::rtld_deepbind);
  if (!testLibTFs.is_loaded()) {
    throw(std::runtime_error("Failed to load test runtime library table functions!!"));
  }

  if (!testLibTFs.has("init_table_functions")) {
    LOG(FATAL)
        << "Test runtime table function library has no init_table_functions symbol!";
  }
  auto initFunction = testLibTFs.get<void(void)>("init_table_functions");
  initFunction();
}

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

bool RuntimeLibManager::is_libtorch_loaded_

staticprivate

Definition at line 11 of file RuntimeLibManager.h.

Referenced by is_libtorch_loaded(), and loadRuntimeLibs().

---

The documentation for this class was generated from the following files:

• /home/jenkins-slave/workspace/core-os-doxygen/RuntimeLibManager/RuntimeLibManager.h
• /home/jenkins-slave/workspace/core-os-doxygen/RuntimeLibManager/RuntimeLibManager.cpp