eonc::dynlib Namespace Reference

Cross-platform dynamic library loading abstraction. More...

Typedefs
using	Handle = void *

Functions
Handle	open (const char *name) noexcept
void *	sym (Handle h, const char *name) noexcept
void	close (Handle h) noexcept
std::string	error ()
Handle	openFirst (const char *const names[]) noexcept
	Try a list of library names in order, return first successful handle.
template<typename Fn>
Fn	loadSym (Handle h, const char *name) noexcept
	Load a symbol and cast to a function pointer type.

Detailed Description

Cross-platform dynamic library loading abstraction.

Used by LammpsLoader, XtbLoader, and any other runtime-loaded potentials.

Typedef Documentation

Handle

using eonc::dynlib::Handle = void *

Definition at line 60 of file DynLib.h.

Function Documentation

close()

void eonc::dynlib::close ( Handle h )

inlinenoexcept

Definition at line 77 of file DynLib.h.

                                     {
  if (h)
    dlclose(h);
}

error()

std::string eonc::dynlib::error ( )

inline

Definition at line 82 of file DynLib.h.

                         {
  const char *msg = dlerror();
  return msg ? std::string(msg) : std::string{};
}

loadSym()

template<typename Fn>

Fn eonc::dynlib::loadSym ( Handle h, const char * name )

noexcept

Load a symbol and cast to a function pointer type.

Definition at line 99 of file DynLib.h.

                                                                       {
  return reinterpret_cast<Fn>(sym(h, name));
}

open()

Handle eonc::dynlib::open ( const char * name )

inlinenoexcept

Definition at line 62 of file DynLib.h.

                                              {
  // RTLD_DEEPBIND (Linux-only): make the library prefer its own symbols over
  // globally-visible ones.  Without this, Fortran helper symbols exported by
  // Fortran shared libraries (e.g. neighbours_ in libeon_sw.so) can be
  // hijacked by identically-named symbols in other loaded libraries (e.g.
  // libxtb.so.6 also exports neighbours_), causing mis-dispatch and SIGSEGV.
#if defined(__linux__)
  return dlopen(name, RTLD_NOW | RTLD_LOCAL | RTLD_DEEPBIND);
#else
  return dlopen(name, RTLD_NOW | RTLD_LOCAL);
#endif
}

openFirst()

Handle eonc::dynlib::openFirst ( const char *const names[] )

inlinenoexcept

Try a list of library names in order, return first successful handle.

Definition at line 89 of file DynLib.h.

                                                            {
  for (const char *const *name = names; *name; ++name) {
    Handle h = open(*name);
    if (h)
      return h;
  }
  return {};
}

sym()

void * eonc::dynlib::sym ( Handle h, const char * name )

inlinenoexcept

Definition at line 75 of file DynLib.h.

{ return dlsym(h, name); }