Changeset 9642 for ps

Timestamp:

06/20/11 22:06:51 (14 years ago)

Author:

Jan Wassenberg

Message:

add support for .dylib on OS X based on patch by Yves (thanks!)
c.f. ​http://www.wildfiregames.com/forum/index.php?showtopic=14173&pid=220828&st=0&#entry220828

Location:

ps/trunk/source

Files:

• lib/sysdep/os/win/wposix/wdlfcn.cpp (modified) (1 diff)
• ps/DllLoader.cpp (modified) (8 diffs)
• ps/DllLoader.h (modified) (1 diff)

ps/trunk/source/lib/sysdep/os/win/wposix/wdlfcn.cpp

@@ -47 +47 @@
 char* dlerror()
 {
-    return 0;
+    // the obvious implementation involves sys_StatusDescription, but we
+    // don't want to return a pointer to a static array because that's not
+    // thread-safe. we therefore check GetLastError directly.
+    switch(GetLastError())
+    {
+    case ERROR_MOD_NOT_FOUND:
+        return "module not found";
+    case ERROR_PROC_NOT_FOUND:
+        return "symbol not found";
+    default:
+        return "unknown";
+    }
 }
 

ps/trunk/source/ps/DllLoader.cpp

@@ -1 @@
-/* Copyright (C) 2010 Wildfire Games.
+/* Copyright (C) 2011 Wildfire Games.
  * This file is part of 0 A.D.
  *
@@ -26 +26 @@
 #include "ps/GameSetup/Config.h"
 
-void* const HANDLE_UNAVAILABLE = (void*)-1;
+static void* const HANDLE_UNAVAILABLE = (void*)-1;
 
 // directory to search for libraries (optionally set by --libdir at build-time,
@@ -40 +40 @@
 // note: on Linux, lib is prepended to the SO file name
 #if OS_UNIX
-static const char* prefix = "lib";
+static CStr prefix = "lib";
 #else
-static const char* prefix = "";
+static CStr prefix = "";
 #endif
-// our SOs export binary-compatible interfaces across debug and release builds,
-// but for debugging/performance we prefer to use the same version as the app.
-// note: on Windows, the extension is replaced with .dll by dlopen.
+
+// we usually want to use the same debug/release build type as the
+// main executable (the library should also be efficient in release builds and
+// allow easy symbol access in debug builds). however, that version of the
+// library might be missing, so we check for both.
+// this works because the interface is binary-compatible.
 #ifndef NDEBUG
-static const char* primarySuffix = "_dbg.so";
-static const char* secondarySuffix = ".so";
+static CStr suffixes[] = { "_dbg", "" };    // (order matters)
 #else
-static const char* primarySuffix = ".so";
-static const char* secondarySuffix = "_dbg.so";
+static CStr suffixes[] = { "", "_dbg" };
 #endif
+
+// NB: our Windows dlopen() function changes the extension to .dll
+static CStr extensions[] = {
+    ".so",
+#if OS_MACOSX
+    ".dylib"    // supported by OS X dlopen
+#endif
+};
 
 // (This class is currently only used by 'Collada' and 'AtlasUI' which follow
@@ -59 +68 @@
 // to support other DLLs.)
 
-static CStr GenerateFilename(const CStr& name, const CStr& suffix)
+static CStr GenerateFilename(const CStr& name, const CStr& suffix, const CStr& extension)
 {
     CStr n;
     if (!g_Libdir.empty())
         n = g_Libdir + "/";
-    n += prefix + name + suffix;
+    n += prefix + name + suffix + extension;
     return n;
 }
 
+
+
+// @param name base name of the library (excluding prefix/suffix/extension)
+// @param errors receives descriptions of any and all errors encountered
+// @return valid handle or 0
+static void* LoadAnyVariant(const CStr& name, std::stringstream& errors)
+{
+    for(size_t idxSuffix = 0; idxSuffix < ARRAY_SIZE(suffixes); idxSuffix++)
+    {
+        for(size_t idxExtension = 0; idxExtension < ARRAY_SIZE(extensions); idxExtension++)
+        {
+            CStr filename = GenerateFilename(name, suffixes[idxSuffix], extensions[idxExtension]);
+
+            // we don't really care when relocations take place, but one of
+            // {RTLD_NOW, RTLD_LAZY} must be specified. go with the former because
+            // it is safer and matches the Windows load behavior.
+            const int flags = RTLD_LOCAL|RTLD_NOW;
+            void* handle = dlopen(filename.c_str(), flags);
+            if(handle)
+                return handle;
+            else
+                errors << "dlopen(" << filename << ") failed: " << dlerror() << "; ";
+        }
+    }
+
+    return 0;   // none worked
+}
+
+
 DllLoader::DllLoader(const char* name)
-: m_Name(name), m_Handle(0)
+    : m_Name(name), m_Handle(0)
 {
 }
@@ -92 +130 @@
         TIMER(L"LoadDLL");
 
-        // we don't really care when relocations take place, but one of
-        // {RTLD_NOW, RTLD_LAZY} must be passed. go with the former because
-        // it is safer and matches the Windows load behavior.
-        const int flags = RTLD_LOCAL|RTLD_NOW;
-
-        CStr filename = GenerateFilename(m_Name, primarySuffix);
-        m_Handle = dlopen(filename.c_str(), flags);
-
-        char* primaryError = NULL;
-
-        // open failed (mostly likely SO not found)
-        if (! m_Handle)
+        std::stringstream errors;
+        m_Handle = LoadAnyVariant(m_Name, errors);
+        if(!m_Handle)   // (only report errors if nothing worked)
         {
-            primaryError = dlerror();
-            if (primaryError)
-                primaryError = strdup(primaryError); // don't get overwritten by next dlopen
-
-            // Try to open the other debug/release version
-            filename = GenerateFilename(m_Name, secondarySuffix);
-            m_Handle = dlopen(filename.c_str(), flags);
-        }
-
-        // open still failed; report the first error
-        if (! m_Handle)
-        {
-            if (primaryError)
-                LOGERROR(L"dlopen error: %hs", primaryError);
+            LOGERROR(L"DllLoader: %hs", errors.str().c_str());
             m_Handle = HANDLE_UNAVAILABLE;
         }
-
-        free(primaryError);
     }
 
@@ -130 +144 @@
 void DllLoader::Unload()
 {
-    if (! IsLoaded())
+    if(!IsLoaded())
         return;
 
@@ -139 +153 @@
 void DllLoader::LoadSymbolInternal(const char* name, void** fptr) const
 {
-    if (! IsLoaded())
+    if(!IsLoaded())
     {
         debug_warn(L"Loading symbol from invalid DLL");
@@ -147 +161 @@
 
     *fptr = dlsym(m_Handle, name);
-
-    if (*fptr == NULL)
+    if(*fptr == NULL)
         throw PSERROR_DllLoader_SymbolNotFound();
 }

ps/trunk/source/ps/DllLoader.h

@@ -1 @@
-/* Copyright (C) 2009 Wildfire Games.
+/* Copyright (C) 2011 Wildfire Games.
  * This file is part of 0 A.D.
  *