/src/freeradius-server/src/lib/util/dl.c

Source
/*
 *   This program is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation; either version 2 of the License, or
 *   (at your option) any later version.
 *
 *   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, write to the Free Software
 *   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
 */

/**
 * $Id: 071aee3d39edff21590316e840419ad528015773 $
 *
 * @file src/lib/util/dl.c
 * @brief Wrappers around dlopen to manage loading shared objects at runtime.
 *
 * @copyright 2016-2019 The FreeRADIUS server project
 * @copyright 2016-2019 Arran Cudbard-Bell (a.cudbardb@freeradius.org)
 */
RCSID("$Id: 071aee3d39edff21590316e840419ad528015773 $")

#include <freeradius-devel/server/dl_module.h>
#include <freeradius-devel/server/log.h>
#include <freeradius-devel/util/atexit.h>
#include <freeradius-devel/util/debug.h>

#include <freeradius-devel/util/paths.h>
#include <freeradius-devel/util/syserror.h>


#ifdef HAVE_VALGRIND_VALGRIND_H
#  include <valgrind/valgrind.h>
#else
#  define RUNNING_ON_VALGRIND 0
#endif

#ifndef RTLD_NOW
#  define RTLD_NOW (0)
#endif
#ifndef RTLD_LOCAL
#  define RTLD_LOCAL (0)
#endif

/** Symbol dependent initialisation callback
 *
 * Call this function when the dl is loaded for the first time.
 */
typedef struct dl_symbol_init_s dl_symbol_init_t;
struct dl_symbol_init_s {
  fr_dlist_t    entry;    //!< Entry into the list of 'init' symbol callbacks.

  unsigned int    priority; //!< Call priority
  char const    *symbol;  //!< to search for.  May be NULL in which case func is always called.
  dl_onload_t   func;   //!< to call when symbol is found in a dl's symbol table.
  void      *uctx;    //!< User data to pass to func.
};

/** Symbol dependent free callback
 *
 * Call this function before the dl is unloaded.
 */
typedef struct dl_symbol_free_s dl_symbol_free_t;
struct dl_symbol_free_s {
  fr_dlist_t    entry;    //!< Entry into the list of 'free' symbol callbacks.

  unsigned int    priority; //!< Call priority
  char const    *symbol;  //!< to search for.  May be NULL in which case func is always called.
  dl_unload_t   func;   //!< to call when symbol is found in a dl's symbol table.
  void      *uctx;    //!< User data to pass to func.
};

/** A dynamic loader
 *
 */
struct dl_loader_s {
  char      *lib_dir; //!< Where the libraries live.

  /** Linked list of symbol init callbacks
   *
   * @note Is linked list to retain insertion order.  We don't expect huge numbers
   *  of callbacks so there shouldn't be efficiency issues.
   */
  fr_dlist_head_t   sym_init;

  /** Linked list of symbol free callbacks
   *
   * @note Is linked list to retain insertion order.  We don't expect huge numbers
   *  of callbacks so there shouldn't be efficiency issues.
   */
  fr_dlist_head_t   sym_free;

  bool      do_dlclose;   //!< dlclose modules when we're done with them.

  bool      do_static;    //!< Do all symbol resolution using the special
              ///< RTLD_DEFAULT handle, instead of attempting
              ///< to load modules using dlopen().  This is
              ///< useful when FreeRADIUS has been built as
              ///< a monolithic binary.

  fr_rb_tree_t    *tree;      //!< Tree of shared objects loaded.

  void      *uctx;      //!< dl private extension data.

  bool      uctx_free;    //!< Free uctx when dl_loader_t is freed.

  bool      defer_symbol_init;  //!< Do not call dl_symbol_init in dl_loader_init.
};

/** Global search path, prepended all dlopen paths
 */
static char *dl_global_libdir = NULL;

static fr_cmp_ret_t dl_symbol_init_cmp(void const *one, void const *two)
{
  dl_symbol_init_t const *a = one, *b = two;
  int ret;

  fr_assert(a && b);

  ret = ((void *)a->func > (void *)b->func) - ((void *)a->func < (void *)b->func);
  if (ret != 0) return ret;

  ret = (a->symbol && !b->symbol) - (!a->symbol && b->symbol);
  if (ret != 0) return ret;

  if (!a->symbol && !b->symbol) return CMP_EQ;

#ifdef STATIC_ANALYZER
  if (!fr_cond_assert(a->symbol && b->symbol)) return CMP_EQ; /* Bug in clang scan ? */
#endif

  ret = strcmp(a->symbol, b->symbol);
  return CMP(ret, 0);
}

static fr_cmp_ret_t dl_symbol_free_cmp(void const *one, void const *two)
{
  dl_symbol_free_t const *a = one, *b = two;
  int ret;

  fr_assert(a && b);

  ret = ((void *)a->func > (void *)b->func) - ((void *)a->func < (void *)b->func);
  if (ret != 0) return ret;

  ret = (a->symbol && !b->symbol) - (!a->symbol && b->symbol);
  if (ret != 0) return ret;

  if (!a->symbol && !b->symbol) return CMP_EQ;

#ifdef STATIC_ANALYZER
  if (!fr_cond_assert(a->symbol && b->symbol)) return CMP_EQ; /* Bug in clang scan ? */
#endif

  ret = strcmp(a->symbol, b->symbol);
  return CMP(ret, 0);
}

/** Compare the name of two dl_t
 *
 */
static fr_cmp_ret_t dl_handle_cmp(void const *one, void const *two)
{
  int ret;

  ret = strcmp(((dl_t const *)one)->name, ((dl_t const *)two)->name);
  return CMP(ret, 0);
}

/** Utility function to dlopen the library containing a particular symbol
 *
 * @note Not really part of our 'dl' API, just a convenience function.
 *
 * @param[in] sym_name  to resolve.
 * @param[in] flags to pass to dlopen.
 * @return
 *  - NULL on error.
 *      - A new handle on success.
 */
void *dl_open_by_sym(char const *sym_name, int flags)
{
  Dl_info   info;
  void    *sym;
  void    *handle;

  /*
   *  Resolve the test symbol in our own symbol space by
   *  iterating through all the libraries.
   *  This might be slow.  Don't do this at runtime!
   */
  sym = dlsym(RTLD_DEFAULT, sym_name);
  if (!sym) {
    fr_strerror_printf("Can't resolve symbol %s", sym_name);
    return NULL;
  }

  /*
   *  Lookup the library the symbol belongs to
   */
  if (dladdr(sym, &info) == 0) {
    fr_strerror_printf("Failed retrieving info for \"%s\" (%p)", sym_name, sym);
    return NULL;
  }

  handle = dlopen(info.dli_fname, flags);
  if (!handle) {
    fr_strerror_printf("Failed loading \"%s\": %s", info.dli_fname, dlerror());
    return NULL;
  }

  return handle;
}

/** Walk over the registered init callbacks, searching for the symbols they depend on
 *
 * Allows code outside of the dl API to register initialisation functions that get
 * executed depending on whether the dl exports a particular symbol.
 *
 * This cuts down the amount of boilerplate code in 'mod_load' functions.
 *
 * @param[in] dl_loader Tree of dynamically loaded libraries, and callbacks.
 * @param[in] dl  to search for symbols in.
 * @return
 *  - 0 continue walking.
 *  - -1 error.
 */
int dl_symbol_init(dl_loader_t *dl_loader, dl_t const *dl)
{
  dl_symbol_init_t  *init = NULL;
  void      *sym = NULL;
  char      buffer[256] = "";

  while ((init = fr_dlist_next(&dl_loader->sym_init, init))) {
    if (init->symbol) {
      char *p;

      snprintf(buffer, sizeof(buffer), "%s_%s", dl->name, init->symbol);

      /*
       *  '-' is not a valid symbol character in
       *  C.  But "libfreeradius-radius" is a
       *  valid library name.  So we hash things together.
       */
      for (p = buffer; *p != '\0'; p++) {
        if (*p == '-') *p = '_';
      }

      sym = dlsym(dl->handle, buffer);
      if (!sym) {
        continue;
      }
    }

    if (init->func(dl, sym, init->uctx) < 0) {
      fr_strerror_printf("Initialiser failed for %s", dl->name);
      return -1;
    }
  }

  return 0;
}

/** Walk over the registered init callbacks, searching for the symbols they depend on
 *
 * Allows code outside of the dl API to register free functions that get
 * executed depending on whether the dl exports a particular symbol.
 *
 * This cuts down the amount of boilerplate code in 'mod_unload' functions.
 *
 * @param[in] dl_loader Tree of dynamically loaded libraries, and callbacks.
 * @param[in] dl  to search for symbols in.
 */
static int dl_symbol_free(dl_loader_t *dl_loader, dl_t const *dl)
{
  dl_symbol_free_t  *free = NULL;
  void      *sym = NULL;

  while ((free = fr_dlist_next(&dl_loader->sym_free, free))) {
    if (free->symbol) {
      char *sym_name = NULL;

      sym_name = talloc_typed_asprintf(NULL, "%s_%s", dl->name, free->symbol);
      if (!sym_name) return -1;

      sym = dlsym(dl->handle, sym_name);
      talloc_free(sym_name);

      if (!sym) continue;
    }

    free->func(dl, sym, free->uctx);
  }

  return 0;
}

/** Register a callback to execute when a dl with a particular symbol is first loaded
 *
 * @note Will replace ctx data for callbacks with the same symbol/func.
 *
 * @param[in] dl_loader Tree of dynamically loaded libraries, and callbacks.
 * @param[in] priority  Execution priority.  Callbacks with a higher priority get
 *      called first.
 * @param[in] symbol  that determines whether func should be called. "<modname>_" is
 *      added as a prefix to the symbol.  The prefix is added because
 *      some dls are loaded with RTLD_GLOBAL into the global symbol
 *      space, so the symbols they export must be unique.
 *      May be NULL to always call the function.
 * @param[in] func  to register.  Called when dl is loaded.
 * @param[in] uctx  to pass to func.
 * @return
 *  - 0 on success (or already registered).
 *  - -1 on failure.
 */
int dl_symbol_init_cb_register(dl_loader_t *dl_loader, unsigned int priority,
             char const *symbol, dl_onload_t func, void *uctx)
{
  dl_symbol_init_t  *n;

  dl_symbol_init_cb_unregister(dl_loader, symbol, func);

  n = talloc(dl_loader, dl_symbol_init_t);
  if (unlikely(!n)) return -1;
  *n = (dl_symbol_init_t){
    .priority = priority,
    .symbol = symbol,
    .func = func,
    .uctx = uctx
  };

  fr_dlist_foreach(&dl_loader->sym_init, dl_symbol_init_t, p) {
    if (p->priority < priority) {
      fr_dlist_insert_before(&dl_loader->sym_init, p, n);
      n = NULL;
      break;
    }
  }
  if (n) fr_dlist_insert_tail(&dl_loader->sym_init, n);

  return 0;
}

/** Unregister an callback that was to be executed when a dl was first loaded
 *
 * @param[in] dl_loader Tree of dynamically loaded libraries, and callbacks.
 * @param[in] symbol  the callback is attached to.
 * @param[in] func  the callback.
 */
void dl_symbol_init_cb_unregister(dl_loader_t *dl_loader, char const *symbol, dl_onload_t func)
{
  dl_symbol_init_t  *found = NULL, find = { .symbol = symbol, .func = func };

  while ((found = fr_dlist_next(&dl_loader->sym_init, found)) && (dl_symbol_init_cmp(&find, found) != 0));
  if (found) {
    fr_dlist_remove(&dl_loader->sym_init, found);
    talloc_free(found);
  }
}

/** Register a callback to execute when a dl with a particular symbol is unloaded
 *
 * @note Will replace ctx data for callbacks with the same symbol/func.
 *
 * @param[in] dl_loader Tree of dynamically loaded libraries, and callbacks.
 * @param[in] priority  Execution priority.  Callbacks with a higher priority get
 *      called first.
 * @param[in] symbol  that determines whether func should be called. "<modname>_" is
 *      added as a prefix to the symbol.  The prefix is added because
 *      some dls are loaded with RTLD_GLOBAL into the global symbol
 *      space, so the symbols they export must be unique.
 *      May be NULL to always call the function.
 * @param[in] func  to register.  Called then dl is unloaded.
 * @param[in] uctx  to pass to func.
 * @return
 *  - 0 on success (or already registered).
 *  - -1 on failure.
 */
int dl_symbol_free_cb_register(dl_loader_t *dl_loader, unsigned int priority,
             char const *symbol, dl_unload_t func, void *uctx)
{
  dl_symbol_free_t  *n;

  dl_symbol_free_cb_unregister(dl_loader, symbol, func);

  n = talloc(dl_loader, dl_symbol_free_t);
  if (!n) return -1;

  *n = (dl_symbol_free_t){
    .priority = priority,
    .symbol = symbol,
    .func = func,
    .uctx = uctx
  };

  fr_dlist_foreach(&dl_loader->sym_free, dl_symbol_free_t, p) {
    if (p->priority < priority) {
      fr_dlist_insert_before(&dl_loader->sym_free, p, n);
      n = NULL;
      break;
    }
  }
  if (n) fr_dlist_insert_tail(&dl_loader->sym_free, n);

  return 0;
}

/** Unregister an callback that was to be executed when a dl was unloaded
 *
 * @param[in] dl_loader Tree of dynamically loaded libraries, and callbacks.
 * @param[in] symbol  the callback is attached to.
 * @param[in] func  the callback.
 */
void dl_symbol_free_cb_unregister(dl_loader_t *dl_loader, char const *symbol, dl_unload_t func)
{
  dl_symbol_free_t  *found = NULL, find = { .symbol = symbol, .func = func };

  while ((found = fr_dlist_next(&dl_loader->sym_free, found)) && (dl_symbol_free_cmp(&find, found) != 0));
  if (found) {
    fr_dlist_remove(&dl_loader->sym_free, found);
    talloc_free(found);
  }
}

/** Free a dl
 *
 * Close dl's dlhandle, unloading it.
 *
 * @param[in] dl to close.
 * @return 0.
 */
static int _dl_free(dl_t *dl)
{
  dl = talloc_get_type_abort(dl, dl_t);

  dl_symbol_free(dl->loader, dl);

  /*
   *  Only dlclose() handle if we're *NOT* running under valgrind
   *  as it unloads the symbols valgrind needs.
   */
  if (dl->loader->do_dlclose) dlclose(dl->handle);        /* ignore any errors */

  dl->handle = NULL;

  if (dl->in_tree) fr_rb_delete(dl->loader->tree, dl);

  return 0;
}

/** Search for a dl's shared object in various locations
 *
 * @note You must call dl_symbol_init when ready to call autoloader callbacks.
 *
 * @param[in] dl_loader   Tree of dynamically loaded libraries, and callbacks.
 * @param[in] name    of library to load.  May be a relative path.
 * @param[in] uctx    Data to store within the dl_t.
 * @param[in] uctx_free   talloc_free the passed in uctx data if this
 *        dl_t is freed.
 * @return
 *  - A new dl_t on success, or a pointer to an existing
 *    one with the reference count increased.
 *  - NULL on error.
 */
dl_t *dl_by_name(dl_loader_t *dl_loader, char const *name, void *uctx, bool uctx_free)
{
  int   flags = RTLD_NOW;
  void    *handle = NULL;
  char const  *search_path;
  dl_t    *dl;

  /*
   *  There's already something in the tree,
   *  just return that instead.
   */
  fr_rb_find((void **)&dl, dl_loader->tree, &(dl_t){ .name = name });
  if (dl) {
    talloc_increase_ref_count(dl);
    return dl;
  }

  /*
   *  Get a reference to the internal RTLD_HANDLE,
   *  which is used to search through all current loaded
   *  modules.
   *
   *  This is useful for static builds which don't actually
   *  want to dlopen anything, and just want to look at the
   *  current global symbol table to load everything
   *  from there.
   */
  if (dl_loader->do_static) {
    handle = dlopen(NULL, 0);
    if (!handle) {
      fr_strerror_printf("Failed opening RTLD_DEFAULT handle - %s", dlerror());
      return NULL;
    }
    goto do_symbol_check;
  }

  flags |= RTLD_LOCAL;

  /*
   *  Forces dlopened libraries to resolve symbols within
   *  their local symbol tables instead of the global symbol
   *  table.
   *
   *  May help resolve issues with symbol conflicts.
   */
#if defined(RTLD_DEEPBIND) && !defined(__SANITIZE_ADDRESS__)
  flags |= RTLD_DEEPBIND;
#endif

  fr_strerror_clear();  /* clear error buffer */

  /*
   *  Bind all the symbols *NOW* so we don't hit errors later
   */
  flags |= RTLD_NOW;

  search_path = dl_search_path(dl_loader);

  /*
   *  Prefer loading our libraries by absolute path.
   */
  if (search_path) {
    char *ctx, *paths, *path;
    char *p;
    char *dlerror_txt = NULL;

    fr_strerror_clear();

    ctx = paths = talloc_strdup(NULL, search_path);
    while ((path = strsep(&paths, ":")) != NULL) {
      char *fullpath;

      /*
       *  Trim the trailing slash
       */
      p = strrchr(path, '/');
      if (p && ((p[1] == '\0') || (p[1] == ':'))) *p = '\0';

      fullpath = talloc_typed_asprintf(ctx, "%s/%s%s", path, name, DL_EXTENSION);
      handle = dlopen(fullpath, flags);
      talloc_free(fullpath);
      if (handle) break;

      /*
       *  There's no dlopenat(), so one can't use it and later
       *  check acessatat() to avoid toctou.
       *
       *  The only indication of why dlopen() failed is thus the
       *  contents of the string dlerror() returns, but all the
       *  man page says about that is that it's "human readable",
       *  NUL-terminated, and doesn't end with a newline.
       *
       *  The following attempts to use the dlerror() output to
       *  determine whether dlopen() failed because path doesn't
       *  exist. This goes beyond what the API specifies (Hyrum's
       *  Law strikes again!), but the alternatives are
       *
       *  1. looking into the data structure dlerror() uses
       *  2. let the toctou remain
       *
       *  both of which seem worse.
       */

      /*
       *  If the file doesn't exist, continue with the next element
       *  of  "path". Otherwise, stop looking for more libraries
       *  and instead complain about access permissions.
       */
      dlerror_txt = dlerror();
      if (!dlerror_txt) {
        fr_strerror_printf_push("Unknown error when trying directory %s", path);
        continue;
      }

      /*
       *  Yes, this really is the only way of getting the errno
       *  from the dlopen API.
       */
      if (strstr(dlerror_txt, fr_syserror_simple(ENOENT)) != NULL) {
#ifndef __linux__
        int access_mode = R_OK | X_OK;

#  ifdef AT_ACCESS
        access_mode |= AT_ACCESS;
#  endif
        if ((access(path, access_mode) < 0) && (errno == ENOENT)) continue;
#endif
        fr_strerror_printf_push("Access check failed: %s", dlerror_txt);
        break;
      }

      /*
       *  We're reliant on dlerror_txt from the loop,
       *  because once dlerror() is called the error
       *  is cleared.
       *
       *  We need to push every error because we
       *  don't know which one would be useful
       *  in diagnosing the underlying cause of the
       *  load failure.
       *
       *  However, OSX doesn't clear the error,
       *  it simply appends to it.  We don't
       *  want endless amounts of duplication,
       *  so we tidy it up here.
       *
       *  The message must be copied (printf, not
       *  const): dlerror() hands back a buffer
       *  which is reused by the next dl call,
       *  including this loop's next dlopen(),
       *  and the const variants store only the
       *  pointer.
       */
#ifndef __APPLE__
      fr_strerror_printf_push("%s", dlerror_txt);
#else
      fr_strerror_printf("%s", dlerror_txt);
#endif
    }

    /*
     *  No element of "path" had the library.  Return
     *  the error from the last dlopen().
     */
    if (!handle) {
      talloc_free(ctx);
      return NULL;
    }

    fr_strerror_clear();  /* Don't leave spurious errors in the buffer */

    talloc_free(ctx);
  } else {
    char  buffer[2048];

    strlcpy(buffer, name, sizeof(buffer));
    /*
     *  FIXME: Make this configurable...
     */
    strlcat(buffer, DL_EXTENSION, sizeof(buffer));

    handle = dlopen(buffer, flags);
    if (!handle) {
      char *error = dlerror();

      /*
       *  Append the error
       */
      fr_strerror_printf_push("%s", error);
      return NULL;
    }
  }

do_symbol_check:
  dl = talloc(dl_loader, dl_t);
  if (unlikely(!dl)) {
    dlclose(handle);
    return NULL;
  }
  *dl = (dl_t){
    .name = talloc_strdup(dl, name),
    .handle = handle,
    .loader = dl_loader,
    .uctx = uctx,
    .uctx_free = uctx_free
  };
  talloc_set_destructor(dl, _dl_free);

  dl->in_tree = (fr_rb_insert(dl_loader->tree, dl) == 0);
  if (!dl->in_tree) {
    talloc_free(dl);
    return NULL;
  }

  if (!dl_loader->defer_symbol_init) dl_symbol_init(dl_loader, dl);

  return dl;
}

/** "free" a dl handle, possibly actually freeing it, and unloading the library
 *
 * This function should be used to explicitly free a dl.
 *
 * Because dls are reference counted, it may not actually free the memory
 * or unload the library, but it will reduce the reference count.
 *
 * @return
 *  - 0 if the dl was actually freed.
 *  - >0  the number of remaining references.
 */
int dl_free(dl_t const *dl)
{
  if (!dl) return 0;

  return talloc_decrease_ref_count(talloc_get_type_abort_const(dl, dl_t));
}

static int _dl_loader_free(dl_loader_t *dl_loader)
{
  int ret = 0;

  if (dl_loader->uctx_free) {
    ret = talloc_free(dl_loader->uctx);
    if (ret != 0) goto finish;
  }

  /*
   *  Prevent freeing if we still have dls loaded
   *  We do reference counting, we know exactly what
   *  should still be active.
   */
  if (fr_rb_num_elements(dl_loader->tree) > 0) {
#ifndef NDEBUG
    fr_rb_iter_inorder_t  iter;
    void        *data;

    /*
     *  Yes, this is the correct call order
     */
    for (data = fr_rb_iter_init_inorder(dl_loader->tree, &iter);
         data;
         data = fr_rb_iter_next_inorder(dl_loader->tree, &iter)) {
      dl_t *dl = talloc_get_type_abort(data, dl_t);

      fr_strerror_printf_push("  %s (%zu)", dl->name, talloc_reference_count(dl));
    }

    fr_strerror_printf_push("Refusing to cleanup dl loader, the following dynamically loaded "
          "libraries are still in use:");
#endif
    ret = -1;
    goto finish;
  }

finish:
  return ret;
}

/** Return current library path
 *
 */
char const *dl_search_path(dl_loader_t *dl_loader)
{
  char    *env;
  fr_sbuff_t  *search_path = NULL;

  /*
   * The search path in this order [env:][global:]dl_loader->lib_dir
   */

  /*
   *  Create a thread-local extensible buffer to
   *  store library search_path data.
   *
   *  This is created once per-thread (the first time
   *  this function is called), and freed when the
   *  thread exits.
   */
  FR_SBUFF_TALLOC_THREAD_LOCAL(&search_path, 16, PATH_MAX);

  /*
   * Apple removed support for DYLD_LIBRARY_PATH in rootless mode.
   */
  env = getenv("FR_LIBRARY_PATH");
  if (env && fr_sbuff_in_sprintf(search_path, "%s:", env) < 0) return NULL;

  if (dl_global_libdir && fr_sbuff_in_sprintf(search_path, "%s:", dl_global_libdir) < 0) return NULL;

  if (fr_sbuff_in_strcpy(search_path, dl_loader->lib_dir) < 0) return NULL;

  return fr_sbuff_start(search_path);
}

/** Set the global library path
 *
 * @param[in] lib_dir   ":" separated list of paths to search for libraries in.
 * @return
 *  - 0 on success.
 *  - -1 on failure.
 */
int dl_search_global_path_set(char const *lib_dir)
{
  if (dl_global_libdir) TALLOC_FREE(dl_global_libdir);

  dl_global_libdir = talloc_strdup(NULL, lib_dir);
  if (!dl_global_libdir) {
    fr_strerror_const("Failed allocating memory for global dl search path");
    return -1;
  }

  fr_atexit_global_once(NULL, fr_atexit_talloc_free, dl_global_libdir);

  return 0;
}

/** Set the current library path
 *
 * @param[in] dl_loader   to add search path component for.
 * @param[in] lib_dir   A ":" separated list of paths to search for libraries in.
 */
int dl_search_path_set(dl_loader_t *dl_loader, char const *lib_dir)
{
  char const *old;

  old = dl_loader->lib_dir;

  dl_loader->lib_dir = talloc_strdup(dl_loader, lib_dir);
  if (!dl_loader->lib_dir) {
    fr_strerror_const("Failed allocating memory for dl search path");
    return -1;
  }

  talloc_const_free(old);

  return 0;
}

/** Append a new search path component to the library search path
 *
 * @param[in] dl_loader   to add search path component for.
 * @param[in] lib_dir   to add.  Does not require a ":" prefix.
 * @return
 *  - 0 on success.
 *  - -1 on failure.
 */
int dl_search_path_prepend(dl_loader_t *dl_loader, char const *lib_dir)
{
  char *new;

  if (!dl_loader->lib_dir) {
    dl_loader->lib_dir = talloc_strdup(dl_loader, lib_dir);
    if (!dl_loader->lib_dir) {
    oom:
      fr_strerror_const("Failed allocating memory for dl search path");
      return -1;
    }
    return 0;
  }

  new = talloc_asprintf(dl_loader->lib_dir, "%s:%s", lib_dir, dl_loader->lib_dir);
  if (!new) goto oom;

  dl_loader->lib_dir = new;

  return 0;
}

/** Append a new search path component to the library search path
 *
 * @param[in] dl_loader   to add search path component for.
 * @param[in] lib_dir   to add.  Does not require a ":" prefix.
 * @return
 *  - 0 on success.
 *  - -1 on failure.
 */
int dl_search_path_append(dl_loader_t *dl_loader, char const *lib_dir)
{
  char *new;

  if (!dl_loader->lib_dir) {
    dl_loader->lib_dir = talloc_strdup(dl_loader, lib_dir);
    if (!dl_loader->lib_dir) {
    oom:
      fr_strerror_const("Failed allocating memory for dl search path");
      return -1;
    }
    return 0;
  }

  new = talloc_asprintf_append_buffer(dl_loader->lib_dir, ":%s", lib_dir);
  if (!new) goto oom;

  dl_loader->lib_dir = new;

  return 0;
}

/** Retrieve the uctx from a dl_loader
 *
 */
void *dl_loader_uctx(dl_loader_t *dl_loader)
{
  return dl_loader->uctx;
}

/** Initialise structures needed by the dynamic linker
 *
 * @param[in] ctx   To bind lifetime of dl_loader_t too.
 * @param[in] uctx    API client opaque data to store in dl_loader_t.
 * @param[in] uctx_free   Call talloc_free() on uctx when the dl_loader_t
 *        is freed.
 * @param[in] defer_symbol_init If true, it is up to the caller to call
 *        #dl_symbol_init after calling #dl_by_name.
 *        This prevents any of the registered callbacks
 *        from executing until #dl_symbol_init is
 *        called explicitly.
 */
dl_loader_t *dl_loader_init(TALLOC_CTX *ctx, void *uctx, bool uctx_free, bool defer_symbol_init)
{
  dl_loader_t *dl_loader;

  dl_loader = talloc_zero(NULL, dl_loader_t);
  if (!dl_loader) {
    fr_strerror_const("Failed allocating dl_loader");
    return NULL;
  }

  dl_loader->tree = fr_rb_inline_talloc_alloc(dl_loader, dl_t, node, dl_handle_cmp, NULL);
  if (!dl_loader->tree) {
    fr_strerror_const("Failed initialising dl->tree");
  error:
    TALLOC_FREE(dl_loader);
    return NULL;
  }

  talloc_link_ctx(ctx, dl_loader);

  dl_loader->lib_dir = talloc_strdup(dl_loader, fr_path_default_lib_dir());
  if (!dl_loader->lib_dir) {
    fr_strerror_const("Failed allocating memory for dl search path");
    goto error;
  }

  talloc_set_destructor(dl_loader, _dl_loader_free);

  /*
   *  Run this now to avoid bizarre issues
   *  with the talloc atexit handlers firing
   *  in the child, and that causing issues.
   */
  dl_loader->do_dlclose = (!RUNNING_ON_VALGRIND && (fr_get_lsan_state() != 1));
  dl_loader->uctx = uctx;
  dl_loader->uctx_free = uctx_free;
  dl_loader->defer_symbol_init = defer_symbol_init;

  /*
   *  It's not clear yet whether we still want
   *  some dynamic loading capability in
   *  emscripten, so keep this as a potentially
   *  runtime toggle for now.
   */
#ifdef __EMSCRIPTEN__
  dl_loader->do_static = true;
#else
  dl_loader->do_static = false;
#endif
  fr_dlist_init(&dl_loader->sym_init, dl_symbol_init_t, entry);
  fr_dlist_init(&dl_loader->sym_free, dl_symbol_free_t, entry);

  return dl_loader;
}

/** Runtime override for doing static or dynamic module loading
 *
 * @param[in] dl_loader   to configure.
 * @param[in] do_static   If true, all dlopen calls result in a
 *        reference to RTLD_DEFAULT being returned
 *        which allows all the dynamic loading
 *        infrastructure to worth correctly with
 *        a monolithic binary.
 * @return The previous value of do_static
 */
bool dl_loader_set_static(dl_loader_t *dl_loader, bool do_static)
{
  bool old = dl_loader->do_static;

  dl_loader->do_static = do_static;

  return old;
}

/** Called from a debugger to print information about a dl_loader
 *
 */
void dl_loader_debug(FILE *fp, dl_loader_t *dl)
{
  fprintf(fp, "dl_loader %p\n", dl);
  fprintf(fp, "lib_dir           : %s\n", dl->lib_dir);
  fprintf(fp, "do_dlclose        : %s\n", dl->do_dlclose ? "yes" : "no");
  fprintf(fp, "uctx              : %p\n", dl->uctx);
  fprintf(fp, "uctx_free         : %s\n", dl->uctx_free ? "yes" : "no");
  fprintf(fp, "defer_symbol_init : %s\n", dl->defer_symbol_init ? "yes" : "no");

  fr_dlist_foreach(&dl->sym_init, dl_symbol_init_t, sym) {
    fprintf(fp, "symbol_init %s\n", sym->symbol ? sym->symbol : "<base>");
    fprintf(fp, "\tpriority : %u\n", sym->priority);
    fprintf(fp, "\tfunc     : %p\n", sym->func);
    fprintf(fp, "\tuctx     : %p\n", sym->uctx);
  }

  fr_dlist_foreach(&dl->sym_free, dl_symbol_free_t, sym) {
    fprintf(fp, "symbol_free %s\n", sym->symbol ? sym->symbol : "<base>");
    fprintf(fp, "\tpriority : %u\n", sym->priority);
    fprintf(fp, "\tfunc     : %p\n", sym->func);
    fprintf(fp, "\tuctx     : %p\n", sym->uctx);
  }
}

Coverage Report

Created: 2026-11-12 06:42