| 1 |
/* Distributed under the OSI-approved BSD 3-Clause License. See accompanying |
| 2 |
file Copyright.txt or https://cmake.org/licensing#kwsys for details. */ |
| 3 |
#include "kwsysPrivate.h" |
| 4 |
|
| 5 |
#include KWSYS_HEADER(DynamicLoader.hxx) |
| 6 |
|
| 7 |
#if defined(__BEOS__) || defined(__HAIKU__) |
| 8 |
# include <be/kernel/OS.h> /* disable_debugger() API. */ |
| 9 |
#endif |
| 10 |
|
| 11 |
// Needed for __GLIBC__ test macro. |
| 12 |
#ifdef __linux__ |
| 13 |
# include <features.h> |
| 14 |
|
| 15 |
// Will define LIBDL_SO macro on systems with glibc. |
| 16 |
# ifdef __GLIBC__ |
| 17 |
# include <gnu/lib-names.h> |
| 18 |
// Define to LIBC_SO, if not defined by above header. |
| 19 |
# ifndef LIBDL_SO |
| 20 |
# define LIBDL_SO LIBC_SO |
| 21 |
# endif |
| 22 |
# endif |
| 23 |
|
| 24 |
// Define the LIBDL_SO macro, if not defined above. |
| 25 |
# ifndef LIBDL_SO |
| 26 |
# define LIBDL_SO "libdl.so" |
| 27 |
# endif |
| 28 |
#endif |
| 29 |
|
| 30 |
// Work-around CMake dependency scanning limitation. This must |
| 31 |
// duplicate the above list of headers. |
| 32 |
#if 0 |
| 33 |
# include "DynamicLoader.hxx.in" |
| 34 |
#endif |
| 35 |
|
| 36 |
#include <iostream> |
| 37 |
#include <string> |
| 38 |
|
| 39 |
// Include with <> instead of "" to avoid getting any in-source copy |
| 40 |
// left on disk. |
| 41 |
#include <testSystemTools.h> |
| 42 |
|
| 43 |
// For TestDynamicLoaderData, which, though not referenced literally, |
| 44 |
// is referenced semantically. |
| 45 |
#include "testDynload.h" |
| 46 |
|
| 47 |
static std::string GetLibName(const char* lname, const char* subdir = nullptr) |
| 48 |
{ |
| 49 |
// Construct proper name of lib |
| 50 |
std::string slname; |
| 51 |
slname = RUNTIME_OUTPUT_DIRECTORY; |
| 52 |
if (subdir) { |
| 53 |
slname += "/"; |
| 54 |
slname += subdir; |
| 55 |
} |
| 56 |
#ifdef BUILD_CONFIG |
| 57 |
slname += "/"; |
| 58 |
slname += BUILD_CONFIG; |
| 59 |
#endif |
| 60 |
slname += "/"; |
| 61 |
slname += kwsys::DynamicLoader::LibPrefix(); |
| 62 |
slname += lname; |
| 63 |
slname += kwsys::DynamicLoader::LibExtension(); |
| 64 |
|
| 65 |
return slname; |
| 66 |
} |
| 67 |
|
| 68 |
/* libname = Library name (proper prefix, proper extension) |
| 69 |
* System = symbol to lookup in libname |
| 70 |
* r1: should OpenLibrary succeed ? |
| 71 |
* r2: should GetSymbolAddress succeed ? |
| 72 |
* r3: should CloseLibrary succeed ? |
| 73 |
*/ |
| 74 |
static int TestDynamicLoader(const char* libname, const char* symbol, int r1, |
| 75 |
int r2, int r3, int flags = 0) |
| 76 |
{ |
| 77 |
std::cerr << "Testing: " << libname << std::endl; |
| 78 |
kwsys::DynamicLoader::LibraryHandle l = |
| 79 |
kwsys::DynamicLoader::OpenLibrary(libname, flags); |
| 80 |
// If result is incompatible with expectation just fails (xor): |
| 81 |
if ((r1 && !l) || (!r1 && l)) { |
| 82 |
std::cerr << "OpenLibrary: " << kwsys::DynamicLoader::LastError() |
| 83 |
<< std::endl; |
| 84 |
return 1; |
| 85 |
} |
| 86 |
kwsys::DynamicLoader::SymbolPointer f = |
| 87 |
kwsys::DynamicLoader::GetSymbolAddress(l, symbol); |
| 88 |
if ((r2 && !f) || (!r2 && f)) { |
| 89 |
std::cerr << "GetSymbolAddress: " << kwsys::DynamicLoader::LastError() |
| 90 |
<< std::endl; |
| 91 |
return 1; |
| 92 |
} |
| 93 |
#ifndef __APPLE__ |
| 94 |
int s = kwsys::DynamicLoader::CloseLibrary(l); |
| 95 |
if ((r3 && !s) || (!r3 && s)) { |
| 96 |
std::cerr << "CloseLibrary: " << kwsys::DynamicLoader::LastError() |
| 97 |
<< std::endl; |
| 98 |
return 1; |
| 99 |
} |
| 100 |
#else |
| 101 |
(void)r3; |
| 102 |
#endif |
| 103 |
return 0; |
| 104 |
} |
| 105 |
|
| 106 |
int testDynamicLoader(int argc, char* argv[]) |
| 107 |
{ |
| 108 |
#if defined(_WIN32) |
| 109 |
SetErrorMode(SEM_FAILCRITICALERRORS | SEM_NOGPFAULTERRORBOX); |
| 110 |
#elif defined(__BEOS__) || defined(__HAIKU__) |
| 111 |
disable_debugger(1); |
| 112 |
#endif |
| 113 |
int res = 0; |
| 114 |
if (argc == 3) { |
| 115 |
// User specify a libname and symbol to check. |
| 116 |
res = TestDynamicLoader(argv[1], argv[2], 1, 1, 1); |
| 117 |
return res; |
| 118 |
} |
| 119 |
|
| 120 |
// dlopen() on Syllable before 11/22/2007 doesn't return 0 on error |
| 121 |
#ifndef __SYLLABLE__ |
| 122 |
// Make sure that inexistent lib is giving correct result |
| 123 |
res += TestDynamicLoader("azerty_", "foo_bar", 0, 0, 0); |
| 124 |
// Make sure that random binary file cannot be assimilated as dylib |
| 125 |
res += TestDynamicLoader(TEST_SYSTEMTOOLS_SOURCE_DIR "/testSystemTools.bin", |
| 126 |
"wp", 0, 0, 0); |
| 127 |
#endif |
| 128 |
|
| 129 |
#ifdef __linux__ |
| 130 |
// This one is actually fun to test, since dlopen is by default |
| 131 |
// loaded...wonder why :) |
| 132 |
res += TestDynamicLoader("foobar.lib", "dlopen", 0, 1, 0); |
| 133 |
res += TestDynamicLoader(LIBDL_SO, "dlopen", 1, 1, 1); |
| 134 |
res += TestDynamicLoader(LIBDL_SO, "TestDynamicLoader", 1, 0, 1); |
| 135 |
#endif |
| 136 |
// Now try on the generated library |
| 137 |
std::string libname = GetLibName(KWSYS_NAMESPACE_STRING "TestDynload"); |
| 138 |
res += TestDynamicLoader(libname.c_str(), "dummy", 1, 0, 1); |
| 139 |
res += TestDynamicLoader(libname.c_str(), "TestDynamicLoaderSymbolPointer", |
| 140 |
1, 1, 1); |
| 141 |
res += TestDynamicLoader(libname.c_str(), "_TestDynamicLoaderSymbolPointer", |
| 142 |
1, 0, 1); |
| 143 |
res += TestDynamicLoader(libname.c_str(), "TestDynamicLoaderData", 1, 1, 1); |
| 144 |
res += TestDynamicLoader(libname.c_str(), "_TestDynamicLoaderData", 1, 0, 1); |
| 145 |
|
| 146 |
#ifdef _WIN32 |
| 147 |
libname = GetLibName(KWSYS_NAMESPACE_STRING "TestDynloadUse", "dynloaddir"); |
| 148 |
res += TestDynamicLoader(libname.c_str(), "dummy", 0, 0, 0); |
| 149 |
res += TestDynamicLoader(libname.c_str(), "TestLoad", 1, 1, 1, |
| 150 |
kwsys::DynamicLoader::SearchBesideLibrary); |
| 151 |
res += TestDynamicLoader(libname.c_str(), "_TestLoad", 1, 0, 1, |
| 152 |
kwsys::DynamicLoader::SearchBesideLibrary); |
| 153 |
#endif |
| 154 |
|
| 155 |
return res; |
| 156 |
} |