Add wrapper functions to LTDL functions so other parts of the library can access the LTDL functionality.

Reviewed by jsquyres. 

This commit was SVN r28041.

opal/util/Makefile.am

@@ -10,6 +10,7 @@
 # Copyright (c) 2004-2005 The Regents of the University of California.
 #                         All rights reserved.
 # Copyright (c) 2007-2010 Cisco Systems, Inc.  All rights reserved.
+# Copyright (c) 2013      NVIDIA Corporation.  All rights reserved.
 # $COPYRIGHT$
 #
 # Additional copyrights may follow
@@ -43,6 +44,7 @@ headers = \
         fd.c \
         if.h \
         keyval_parse.h \
+        lt_interface.h \
         malloc.h \
         net.h \
         numtostr.h \
@@ -77,6 +79,7 @@ libopalutil_la_SOURCES = \
         if.c \
         keyval_parse.c \
         malloc.c \
+        lt_interface.c \
         net.c \
         numtostr.c \
         opal_environ.c \

opal/util/lt_interface.c

@@ -0,0 +1,246 @@
+/*
+ * Copyright (c) 2013      Cisco Systems, Inc.  All rights reserved.
+ * Copyright (c) 2013      NVIDIA Corporation.  All rights reserved.
+ * $COPYRIGHT$
+ * 
+ * Additional copyrights may follow
+ * 
+ * $HEADER$
+ */
+
+#include "opal_config.h"
+#include <assert.h>
+#include <stdio.h>
+#include "opal/constants.h"
+#include "opal/util/lt_interface.h"
+#include "opal/util/output.h"
+
+#if OPAL_WANT_LIBLTDL
+  #ifndef __WINDOWS__
+    #if OPAL_LIBLTDL_INTERNAL
+      #include "opal/libltdl/ltdl.h"
+    #else
+      #include "ltdl.h"
+    #endif
+  #else
+    #include "ltdl.h"
+  #endif
+#endif
+
+#if OPAL_WANT_LIBLTDL
+struct opal_lt_dlhandle_st {lt_dlhandle dlhandle;};
+struct opal_lt_dladvise_st {lt_dladvise dladvise;};
+#else
+struct opal_lt_dlhandle_st {void *dlhandle;};
+struct opal_lt_dladvise_st {void *dladvise;};
+#endif /* OPAL_WANT_LIBLTDL */
+
+OPAL_DECLSPEC int opal_lt_dlinit(void)
+{
+#if OPAL_WANT_LIBLTDL
+    return lt_dlinit();
+#else /* OPAL_WANT_LIBLTDL */
+    return OPAL_ERR_NOT_SUPPORTED;
+#endif /* OPAL_WANT_LIBLTDL */
+}
+
+OPAL_DECLSPEC int opal_lt_dlexit(void) {
+#if OPAL_WANT_LIBLTDL
+    return lt_dlexit();
+#else /* OPAL_WANT_LIBLTDL */
+    return OPAL_ERR_NOT_SUPPORTED;
+#endif /* OPAL_WANT_LIBLTDL */
+}
+
+/* Module search path manipulation.  */
+OPAL_DECLSPEC int opal_lt_dladdsearchdir(const char *search_dir) {
+#if OPAL_WANT_LIBLTDL
+    return lt_dladdsearchdir(search_dir);
+#else /* OPAL_WANT_LIBLTDL */
+    return OPAL_ERR_NOT_SUPPORTED;
+#endif /* OPAL_WANT_LIBLTDL */
+}
+
+OPAL_DECLSPEC int opal_lt_dlinsertsearchdir(const char *before,
+                                            const char *search_dir) {
+#if OPAL_WANT_LIBLTDL
+    return lt_dlinsertsearchdir(before, search_dir);
+#else /* OPAL_WANT_LIBLTDL */
+    return OPAL_ERR_NOT_SUPPORTED;
+#endif /* OPAL_WANT_LIBLTDL */
+}
+
+OPAL_DECLSPEC int opal_lt_dlsetsearchpath(const char *search_path) {
+#if OPAL_WANT_LIBLTDL
+    return lt_dlsetsearchpath(search_path);
+#else /* OPAL_WANT_LIBLTDL */
+    return OPAL_ERR_NOT_SUPPORTED;
+#endif /* OPAL_WANT_LIBLTDL */
+}
+
+OPAL_DECLSPEC const char *opal_lt_dlgetsearchpath(void) {
+#if OPAL_WANT_LIBLTDL
+    return lt_dlgetsearchpath();
+#else /* OPAL_WANT_LIBLTDL */
+    return NULL;
+#endif /* OPAL_WANT_LIBLTDL */
+}
+OPAL_DECLSPEC int opal_lt_dlforeachfile(const char *search_path,
+                                        int (*func) (const char *filename, void *data),
+                                        void *data) {
+#if OPAL_WANT_LIBLTDL
+    return lt_dlforeachfile(search_path, func, data);
+#else /* OPAL_WANT_LIBLTDL */
+    return OPAL_ERR_NOT_SUPPORTED;
+#endif /* OPAL_WANT_LIBLTDL */
+}
+
+/* User module loading advisors.  */
+OPAL_DECLSPEC int opal_lt_dladvise_init(opal_lt_dladvise *advise) {
+#if OPAL_WANT_LIBLTDL && OPAL_HAVE_LTDL_ADVISE
+    *advise = malloc(sizeof(struct opal_lt_dladvise_st));
+    if (NULL == *advise) {
+        return OPAL_ERR_OUT_OF_RESOURCE;
+    }
+    return lt_dladvise_init(&(*advise)->dladvise);
+#else /* OPAL_WANT_LIBLTDL */
+    return OPAL_ERR_NOT_SUPPORTED;
+#endif /* OPAL_WANT_LIBLTDL */
+}
+
+OPAL_DECLSPEC int opal_lt_dladvise_destroy(opal_lt_dladvise *advise) {
+#if OPAL_WANT_LIBLTDL && OPAL_HAVE_LTDL_ADVISE
+    int retval = lt_dladvise_destroy(&(*advise)->dladvise);
+    free(*advise);
+    return retval;
+#else /* OPAL_WANT_LIBLTDL && OPAL_HAVE_LTDL_ADVISE */
+    return OPAL_ERR_NOT_SUPPORTED;
+#endif /* OPAL_WANT_LIBLTDL && OPAL_HAVE_LTDL_ADVISE */
+}
+
+OPAL_DECLSPEC int opal_lt_dladvise_ext(opal_lt_dladvise *advise) {
+#if OPAL_WANT_LIBLTDL && OPAL_HAVE_LTDL_ADVISE
+    assert(advise);
+    return lt_dladvise_ext(&(*advise)->dladvise);
+#else /* OPAL_WANT_LIBLTDL && OPAL_HAVE_LTDL_ADVISE */
+    return OPAL_ERR_NOT_SUPPORTED;
+#endif /* OPAL_WANT_LIBLTDL && OPAL_HAVE_LTDL_ADVISE */
+}
+
+OPAL_DECLSPEC int opal_lt_dladvise_resident(opal_lt_dladvise *advise) {
+#if OPAL_WANT_LIBLTDL && OPAL_HAVE_LTDL_ADVISE
+    assert(advise);
+    return lt_dladvise_resident(&(*advise)->dladvise);
+#else /* OPAL_WANT_LIBLTDL && OPAL_HAVE_LTDL_ADVISE */
+    return OPAL_ERR_NOT_SUPPORTED;
+#endif /* OPAL_WANT_LIBLTDL && OPAL_HAVE_LTDL_ADVISE */
+}
+
+OPAL_DECLSPEC int opal_lt_dladvise_local(opal_lt_dladvise *advise) {
+#if OPAL_WANT_LIBLTDL && OPAL_HAVE_LTDL_ADVISE
+    assert(advise);
+    return lt_dladvise_local(&(*advise)->dladvise);
+#else /* OPAL_WANT_LIBLTDL && OPAL_HAVE_LTDL_ADVISE */
+    return OPAL_ERR_NOT_SUPPORTED;
+#endif /* OPAL_WANT_LIBLTDL && OPAL_HAVE_LTDL_ADVISE */
+}
+
+OPAL_DECLSPEC int opal_lt_dladvise_global(opal_lt_dladvise *advise) {
+#if OPAL_WANT_LIBLTDL && OPAL_HAVE_LTDL_ADVISE
+    assert(advise);
+    return lt_dladvise_global(&(*advise)->dladvise);
+#else /* OPAL_WANT_LIBLTDL && OPAL_HAVE_LTDL_ADVISE */
+    return OPAL_ERR_NOT_SUPPORTED;
+#endif /* OPAL_WANT_LIBLTDL && OPAL_HAVE_LTDL_ADVISE */
+}
+
+OPAL_DECLSPEC int opal_lt_dladvise_preload(opal_lt_dladvise *advise) {
+#if OPAL_WANT_LIBLTDL && OPAL_HAVE_LTDL_ADVISE
+    assert(advise);
+    return lt_dladvise_preload(&(*advise)->dladvise);
+#else /* OPAL_WANT_LIBLTDL && OPAL_HAVE_LTDL_ADVISE */
+    return OPAL_ERR_NOT_SUPPORTED;
+#endif /* OPAL_WANT_LIBLTDL && OPAL_HAVE_LTDL_ADVISE */
+}
+
+/* Portable libltdl versions of the system dlopen() API. */
+OPAL_DECLSPEC opal_lt_dlhandle opal_lt_dlopen(const char *filename) {
+#if OPAL_WANT_LIBLTDL
+    opal_lt_dlhandle handle;
+    handle = malloc(sizeof(struct opal_lt_dlhandle_st));
+    if (NULL == handle) {
+        return NULL;
+    }
+    handle->dlhandle = lt_dlopen(filename);
+    if (NULL == handle->dlhandle) {
+        free(handle);
+        return NULL;
+    }
+    return handle;
+#else /* OPAL_WANT_LIBLTDL */
+    return NULL;
+#endif /* OPAL_WANT_LIBLTDL */
+}
+
+OPAL_DECLSPEC opal_lt_dlhandle opal_lt_dlopenext(const char *filename) {
+#if OPAL_WANT_LIBLTDL
+    opal_lt_dlhandle handle;
+    handle = malloc(sizeof(struct opal_lt_dlhandle_st));
+    if (NULL == handle) {
+        return NULL;
+    }
+    handle->dlhandle = lt_dlopenext(filename);
+    if (NULL == handle->dlhandle) {
+        free(handle);
+        return NULL;
+    }
+    return handle;
+#else  /* OPAL_WANT_LIBLTDL */
+    return NULL;
+#endif  /* OPAL_WANT_LIBLTDL */
+}
+
+OPAL_DECLSPEC void *opal_lt_dlsym(opal_lt_dlhandle handle, const char *name) {
+#if OPAL_WANT_LIBLTDL
+    return lt_dlsym(handle->dlhandle, name);
+#else /* OPAL_WANT_LIBLTDL */
+    return NULL;
+#endif /* OPAL_WANT_LIBLTDL */
+}
+
+OPAL_DECLSPEC const char *opal_lt_dlerror(void) {
+#if OPAL_WANT_LIBLTDL
+    return lt_dlerror();
+#else /* OPAL_WANT_LIBLTDL */
+    return NULL;
+#endif /* OPAL_WANT_LIBLTDL */
+}
+
+OPAL_DECLSPEC int opal_lt_dlclose(opal_lt_dlhandle handle) {
+#if OPAL_WANT_LIBLTDL
+    int retval = lt_dlclose(handle->dlhandle);
+    free(handle);
+    return retval;  
+#else
+    return OPAL_ERR_NOT_SUPPORTED;
+#endif
+}
+
+OPAL_DECLSPEC opal_lt_dlhandle opal_lt_dlopenadvise(const char *filename,
+                                                    opal_lt_dladvise advise) {
+#if OPAL_WANT_LIBLTDL && OPAL_HAVE_LTDL_ADVISE
+    opal_lt_dlhandle handle;
+    handle = malloc(sizeof(struct opal_lt_dlhandle_st));
+    if (NULL == handle) {
+        return NULL;
+    }
+    handle->dlhandle = lt_dlopenadvise(filename, advise->dladvise);
+    if (NULL == handle->dlhandle) {
+        free(handle);
+        return NULL;
+    }
+    return handle;
+#else /* OPAL_WANT_LIBLTDL && OPAL_HAVE_LTDL_ADVISE */
+    return NULL;
+#endif /* OPAL_WANT_LIBLTDL && OPAL_HAVE_LTDL_ADVISE */
+}

opal/util/lt_interface.h

@@ -0,0 +1,72 @@
+/*
+ * Copyright (c) 2013      Cisco Systems, Inc.  All rights reserved.
+ * Copyright (c) 2013      NVIDIA Corporation.  All rights reserved.
+ * $COPYRIGHT$
+ * 
+ * Additional copyrights may follow
+ * 
+ * $HEADER$
+ */
+
+/**
+* Wrappers to LTDL functions so that other parts of library can
+* access the LTDL functionality that is embedded/linked in to Open
+* MPI (vs. a LTDL library that was linked in by the application).
+* The OPAL-linked LTDL library is intentionally not DECLSPEC'ed so
+* that it is not visible to upper-layer applications; its functions
+* are provided to the rest of the OMPI code base via the following
+* OPAL wrappers.
+* For functions that return int, if there are any failures, these
+* functions can return both OPAL error codes and LTDL error codes.
+* If the return code is negative it is OPAL, and if positive it 
+* follows the LTDL convention where the number represents the number
+* of errors seen.  You can then call opal_lt_dlerror() to get more
+* information when you see a positive error code.
+*/
+
+/**
+ * Create opal_lt_dlhandle and opal_lt_dladvise types so that
+ * consumers of this code can use these opal types rather than the
+ * LTDL versions.  In this way, there is no need to include the
+ * underlying ltdl.h here (it is only needed in lt_interface.c) and we
+ * do not need to use the OPAL_WANT_LIBLTDL and OPAL_HAVE_LTDL_ADVISE
+ * macros anywhere else.  These types are effectively just pointers to
+ * the underlying LTDL types.
+ */
+struct opal_lt_dlhandle_st;
+typedef struct opal_lt_dlhandle_st* opal_lt_dlhandle;
+struct opal_lt_dladvise_st;
+typedef struct opal_lt_dladvise_st* opal_lt_dladvise;
+
+/**
+ * Wrappers for the ltdl library.
+ */
+OPAL_DECLSPEC int opal_lt_dlinit(void);
+OPAL_DECLSPEC int opal_lt_dlexit(void);
+
+/* Module search path manipulation.  */
+OPAL_DECLSPEC int opal_lt_dladdsearchdir(const char *search_dir);
+OPAL_DECLSPEC int opal_lt_dlinsertsearchdir(const char *before,
+                                            const char *search_dir);
+OPAL_DECLSPEC int opal_lt_dlsetsearchpath(const char *search_path);
+OPAL_DECLSPEC const char *opal_lt_dlgetsearchpath(void);
+OPAL_DECLSPEC int opal_lt_dlforeachfile(const char *search_path,
+                                        int (*func) (const char *filename, void *data),
+                                        void *data);
+/* User module loading advisors.  */
+OPAL_DECLSPEC int opal_lt_dladvise_init(opal_lt_dladvise *advise);
+OPAL_DECLSPEC int opal_lt_dladvise_destroy(opal_lt_dladvise *advise);
+OPAL_DECLSPEC int opal_lt_dladvise_ext(opal_lt_dladvise *advise);
+OPAL_DECLSPEC int opal_lt_dladvise_resident(opal_lt_dladvise *advise);
+OPAL_DECLSPEC int opal_lt_dladvise_local(opal_lt_dladvise *advise);
+OPAL_DECLSPEC int opal_lt_dladvise_global(opal_lt_dladvise *advise);
+OPAL_DECLSPEC int opal_lt_dladvise_preload(opal_lt_dladvise *advise);
+
+/* Portable libltdl versions of the system dlopen() API. */
+OPAL_DECLSPEC opal_lt_dlhandle opal_lt_dlopen(const char *filename);
+OPAL_DECLSPEC opal_lt_dlhandle opal_lt_dlopenext(const char *filename);
+OPAL_DECLSPEC void *opal_lt_dlsym(opal_lt_dlhandle handle, const char *name);
+OPAL_DECLSPEC const char *opal_lt_dlerror(void);
+OPAL_DECLSPEC int opal_lt_dlclose(opal_lt_dlhandle handle);
+OPAL_DECLSPEC opal_lt_dlhandle opal_lt_dlopenadvise(const char *filename,
+                                                    opal_lt_dladvise advise);