Share logic to load dynamic libraries between SourceKit plugins and macro plugins

Author: ahoppen

include/swift/Basic/LoadDynamicLibrary.h

@@ -0,0 +1,23 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2014 - 2025 Apple Inc. and the Swift project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See https://swift.org/LICENSE.txt for license information
+// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef SWIFT_BASIC_LOADDYNAMICLIBRARY_H
+#define SWIFT_BASIC_LOADDYNAMICLIBRARY_H
+
+#include <string>
+
+namespace swift {
+void *loadLibrary(const char *path, std::string *err);
+void *getAddressOfSymbol(void *handle, const char *symbol);
+} // end namespace swift
+
+#endif // SWIFT_BASIC_LOADDYNAMICLIBRARY_H

lib/AST/PluginRegistry.cpp

@@ -14,6 +14,7 @@
 
 #include "swift/Basic/Assertions.h"
 #include "swift/Basic/Defer.h"
+#include "swift/Basic/LoadDynamicLibrary.h"
 #include "swift/Basic/LLVM.h"
 #include "swift/Basic/Program.h"
 #include "swift/Basic/Sandbox.h"
@@ -25,16 +26,6 @@
 
 #include <signal.h>
 
-#if defined(_WIN32)
-#define WIN32_LEAN_AND_MEAN
-#define NOMINMAX
-#include "llvm/Support/ConvertUTF.h"
-#include "llvm/Support/Windows/WindowsSupport.h"
-#include <windows.h>
-#else
-#include <dlfcn.h>
-#endif
-
 #if HAVE_UNISTD_H
 #include <unistd.h>
 #elif defined(_WIN32)
@@ -43,46 +34,6 @@
 
 using namespace swift;
 
-namespace {
-void *loadLibrary(const char *path, std::string *err);
-void *getAddressOfSymbol(void *handle, const char *symbol);
-
-#if defined(_WIN32)
-void *loadLibrary(const char *path, std::string *err) {
-  SmallVector<wchar_t, MAX_PATH> pathUnicode;
-  if (std::error_code ec = llvm::sys::windows::UTF8ToUTF16(path, pathUnicode)) {
-    SetLastError(ec.value());
-    llvm::MakeErrMsg(err, std::string(path) + ": Can't convert to UTF-16");
-    return nullptr;
-  }
-
-  HMODULE handle = LoadLibraryW(pathUnicode.data());
-  if (handle == NULL) {
-    llvm::MakeErrMsg(err, std::string(path) + ": Can't open");
-    return nullptr;
-  }
-  return (void *)handle;
-}
-
-void *getAddressOfSymbol(void *handle, const char *symbol) {
-  return (void *)uintptr_t(GetProcAddress((HMODULE)handle, symbol));
-}
-
-#else
-void *loadLibrary(const char *path, std::string *err) {
-  void *handle = ::dlopen(path, RTLD_LAZY | RTLD_LOCAL);
-  if (!handle)
-    *err = ::dlerror();
-  return handle;
-}
-
-void *getAddressOfSymbol(void *handle, const char *symbol) {
-  return ::dlsym(handle, symbol);
-}
-
-#endif
-} // namespace
-
 PluginRegistry::PluginRegistry() {
   dumpMessaging = ::getenv("SWIFT_DUMP_PLUGIN_MESSAGING") != nullptr;
 }

lib/Basic/CMakeLists.txt

@@ -58,6 +58,7 @@ add_swift_host_library(swiftBasic STATIC
   ParseableOutput.cpp
   JSONSerialization.cpp
   LangOptions.cpp
+  LoadDynamicLibrary.cpp
   Located.cpp
   Mangler.cpp
   OutputFileMap.cpp

lib/Basic/LoadDynamicLibrary.cpp

@@ -0,0 +1,57 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2014 - 2025 Apple Inc. and the Swift project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See https://swift.org/LICENSE.txt for license information
+// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+
+#include "swift/Basic/LoadDynamicLibrary.h"
+
+#if defined(_WIN32)
+#define WIN32_LEAN_AND_MEAN
+#define NOMINMAX
+#include "llvm/Support/ConvertUTF.h"
+#include "llvm/Support/Windows/WindowsSupport.h"
+#include <windows.h>
+#else
+#include <dlfcn.h>
+#endif
+
+#if defined(_WIN32)
+void *swift::loadLibrary(const char *path, std::string *err) {
+  SmallVector<wchar_t, MAX_PATH> pathUnicode;
+  if (std::error_code ec = llvm::sys::windows::UTF8ToUTF16(path, pathUnicode)) {
+    SetLastError(ec.value());
+    llvm::MakeErrMsg(err, std::string(path) + ": Can't convert to UTF-16");
+    return nullptr;
+  }
+
+  HMODULE handle = LoadLibraryW(pathUnicode.data());
+  if (handle == NULL) {
+    llvm::MakeErrMsg(err, std::string(path) + ": Can't open");
+    return nullptr;
+  }
+  return (void *)handle;
+}
+
+void *swift::getAddressOfSymbol(void *handle, const char *symbol) {
+  return (void *)uintptr_t(GetProcAddress((HMODULE)handle, symbol));
+}
+
+#else
+void *swift::loadLibrary(const char *path, std::string *err) {
+  void *handle = ::dlopen(path, RTLD_LAZY | RTLD_LOCAL);
+  if (!handle)
+    *err = ::dlerror();
+  return handle;
+}
+
+void *swift::getAddressOfSymbol(void *handle, const char *symbol) {
+  return ::dlsym(handle, symbol);
+}
+#endif

tools/SourceKit/tools/sourcekitd/lib/API/sourcekitdAPI-Common.cpp

@@ -16,6 +16,7 @@
 #include "sourcekitd/RequestResponsePrinterBase.h"
 #include "SourceKit/Support/Logging.h"
 #include "SourceKit/Support/UIdent.h"
+#include "swift/Basic/LoadDynamicLibrary.h"
 #include "swift/Basic/StringExtras.h"
 #include "llvm/ADT/ArrayRef.h"
 #include "llvm/ADT/SmallString.h"
@@ -27,8 +28,6 @@
 #include "llvm/Support/YAMLParser.h"
 #include <mutex>
 
-#include <dlfcn.h>
-
 using namespace SourceKit;
 using namespace sourcekitd;
 using llvm::ArrayRef;
@@ -270,15 +269,15 @@ bool sourcekitd::shutdownClient() {
 }
 
 static void loadPlugin(StringRef plugin, PluginInitParams &pluginParams) {
-
-  auto *handle = dlopen(plugin.str().c_str(), RTLD_FIRST | RTLD_LAZY);
+  std::string err;
+  auto *handle = swift::loadLibrary(plugin.str().c_str(), &err);
   if (!handle) {
     LOG_WARN("plugin-loading",
-             "failed to load plugin '" << plugin << "': " << dlerror());
+             "failed to load plugin '" << plugin << "': " << err);
     return;
   }
 
-  auto *plugin_init = (sourcekitd_plugin_initialize_t)dlsym(
+  auto *plugin_init = (sourcekitd_plugin_initialize_t)swift::getAddressOfSymbol(
       handle, "sourcekitd_plugin_initialize");
   if (!plugin_init) {
     LOG_WARN("plugin-loading",