Dynamic Library abstraction. This makes the abstraction of a single dynamic

library (shared library/shared object) whose symbols can be looked up
dynamically. Used for plug-ins.


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@17940 91177308-0d34-0410-b5e6-96231b3b80d8

include/llvm/System/DynamicLibrary.h

@@ -0,0 +1,80 @@
+//===-- llvm/System/DynamicLibrary.h - Portable Dynamic Library -*- C++ -*-===//
+// 
+//                     The LLVM Compiler Infrastructure
+//
+// This file was developed by Reid Spencer and is distributed under the 
+// University of Illinois Open Source License. See LICENSE.TXT for details.
+// 
+//===----------------------------------------------------------------------===//
+//
+// This file declares the sys::DynamicLibrary class.
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef LLVM_SYSTEM_DYNAMIC_LIBRARY_H
+#define LLVM_SYSTEM_DYNAMIC_LIBRARY_H
+
+#include "llvm/System/Path.h"
+#include <string>
+
+namespace llvm {
+namespace sys {
+
+  /// This class provides a portable interface to dynamic libraries which also
+  /// might be known as shared libraries, shared objects, dynamic shared 
+  /// objects, or dynamic link libraries. Regardless of the terminology or the
+  /// operating system interface, this class provides a portable interface that
+  /// allows dynamic libraries to be loaded and and searched for externally 
+  /// defined symbols. This is typically used to provide "plug-in" support.
+  /// @since 1.4
+  /// @brief Portable dynamic library abstraction.
+  class DynamicLibrary {
+    /// @name Constructors
+    /// @{
+    public:
+      /// This is the constructor for DynamicLibrary instances. It will open
+      /// the dynamic library specified by the \filename Path.
+      /// @throws std::string indicating why the library couldn't be opened.
+      /// @brief DynamicLibrary constructor
+      DynamicLibrary(const char* filename);
+
+      /// After destruction, the symbols of the library will no longer be
+      /// available to the program. It is important to make sure the lifespan
+      /// of a DynamicLibrary exceeds the lifetime of the pointers returned 
+      /// by the GetAddressOfSymbol otherwise the program may walk off into 
+      /// uncharted territory.
+      /// @see GetAddressOfSymbol.
+      /// @brief Closes the DynamicLibrary
+      ~DynamicLibrary();
+
+    /// @}
+    /// @name Accessors
+    /// @{
+    public:
+      /// Looks up a \p symbolName in the DynamicLibrary and returns its address
+      /// if it exists. If the symbol does not exist, returns (void*)0.
+      /// @returns the address of the symbol or 0.
+      /// @brief Get the address of a symbol in the DynamicLibrary.
+      void* GetAddressOfSymbol(const char* symbolName);
+
+      /// @brief Convenience function for C++ophiles.
+      void* GetAddressOfSymbol(const std::string& symbolName) {
+        return GetAddressOfSymbol(symbolName.c_str());
+      }
+
+    /// @}
+    /// @name Implementation
+    /// @{
+    protected:
+      void* handle;  // Opaque handle for information about the library
+
+      DynamicLibrary();  ///< Do not implement
+      DynamicLibrary(const DynamicLibrary&); ///< Do not implement
+      DynamicLibrary& operator=(const DynamicLibrary&); ///< Do not implement
+    /// @}
+  };
+
+} // End sys namespace
+} // End llvm namespace
+
+#endif // LLVM_SYSTEM_DYNAMIC_LIBRARY_H

lib/System/AIX/DynamicLibrary.cpp

@@ -0,0 +1,27 @@
+//===- AIX/DynamicLibrary.cpp - AIX Dynamic Library -------------*- C++ -*-===//
+// 
+//                     The LLVM Compiler Infrastructure
+//
+// This file was developed by Reid Spencer and is distributed under the 
+// University of Illinois Open Source License. See LICENSE.TXT for details.
+// 
+//===----------------------------------------------------------------------===//
+//
+// This file implements the AIX version of DynamicLibrary
+//
+//===----------------------------------------------------------------------===//
+
+// Include the generic unix implementation
+#include "../Unix/DynamicLibrary.cpp"
+
+namespace llvm {
+using namespace sys;
+
+//===----------------------------------------------------------------------===//
+//=== WARNING: Implementation here must contain only AIX specific code 
+//===          and must not be generic UNIX code (see ../Unix/Memory.cpp)
+//===----------------------------------------------------------------------===//
+
+}
+
+// vim: sw=2 smartindent smarttab tw=80 autoindent expandtab

lib/System/Cygwin/DynamicLibrary.cpp

@@ -0,0 +1,27 @@
+//===- Cygwin/DynamicLibrary.cpp - Cygwin Dynamic Library -------*- C++ -*-===//
+// 
+//                     The LLVM Compiler Infrastructure
+//
+// This file was developed by Reid Spencer and is distributed under the 
+// University of Illinois Open Source License. See LICENSE.TXT for details.
+// 
+//===----------------------------------------------------------------------===//
+//
+// This file implements the Cygwin version of DynamicLibrary
+//
+//===----------------------------------------------------------------------===//
+
+// Include the generic unix implementation
+#include "../Unix/DynamicLibrary.cpp"
+
+namespace llvm {
+using namespace sys;
+
+//===----------------------------------------------------------------------===//
+//=== WARNING: Implementation here must contain only Cygwin specific code 
+//===          and must not be generic UNIX code (see ../Unix/Memory.cpp)
+//===----------------------------------------------------------------------===//
+
+}
+
+// vim: sw=2 smartindent smarttab tw=80 autoindent expandtab

lib/System/Darwin/DynamicLibrary.cpp

@@ -0,0 +1,27 @@
+//===- Darwin/DynamicLibrary.cpp - Darwin Dynamic Library -------*- C++ -*-===//
+// 
+//                     The LLVM Compiler Infrastructure
+//
+// This file was developed by Reid Spencer and is distributed under the 
+// University of Illinois Open Source License. See LICENSE.TXT for details.
+// 
+//===----------------------------------------------------------------------===//
+//
+// This file implements the Darwin version of DynamicLibrary
+//
+//===----------------------------------------------------------------------===//
+
+// Include the generic unix implementation
+#include "../Unix/DynamicLibrary.cpp"
+
+namespace llvm {
+using namespace sys;
+
+//===----------------------------------------------------------------------===//
+//=== WARNING: Implementation here must contain only Darwin specific code 
+//===          and must not be generic UNIX code (see ../Unix/Memory.cpp)
+//===----------------------------------------------------------------------===//
+
+}
+
+// vim: sw=2 smartindent smarttab tw=80 autoindent expandtab

lib/System/DynamicLibrary.cpp

@@ -0,0 +1,78 @@
+//===-- DynamicLibrary.cpp - Runtime link/load libraries --------*- C++ -*-===//
+// 
+//                     The LLVM Compiler Infrastructure
+//
+// This file was developed by Reid Spencer and is distributed under the 
+// University of Illinois Open Source License. See LICENSE.TXT for details.
+// 
+//===----------------------------------------------------------------------===//
+//
+//  This header file implements the operating system DynamicLibrary concept.
+//
+//===----------------------------------------------------------------------===//
+
+#include "llvm/System/DynamicLibrary.h"
+#include "llvm/Config/dlfcn.h"
+#include <cassert>
+
+//===----------------------------------------------------------------------===//
+//=== WARNING: Implementation here must contain only TRULY operating system
+//===          independent code. 
+//===----------------------------------------------------------------------===//
+
+#ifdef HAVE_LTDL_H
+
+namespace llvm {
+
+using namespace sys;
+
+#ifdef HAVE_LT_DLOPEN
+
+DynamicLibrary::DynamicLibrary(const char*filename) : handle(0) {
+  if (0 != lt_dlinit())
+    throw std::string(lt_dlerror());
+
+  handle = lt_dlopen(filename);
+
+  if (handle == 0)
+    handle = lt_dlopenext(filename);
+
+  if (handle == 0)
+    throw std::string("Can't open dynamic library:") + filename;
+}
+
+DynamicLibrary::~DynamicLibrary() {
+  if (handle)
+    lt_dlclose((lt_dlhandle)handle);
+
+  lt_dlexit();
+}
+
+void *DynamicLibrary::GetAddressOfSymbol(const char *symbolName) {
+  assert(handle != 0 && "Invalid DynamicLibrary handle");
+  return lt_dlsym((lt_dlhandle) handle,symbolName);
+}
+
+#else
+DynamicLibrary::DynamicLibrary(const char*filename) : handle(0) {
+  assert(!"Have ltdl.h but not libltdl.a!");
+}
+
+DynamicLibrary::~DynamicLibrary() {
+  assert(!"Have ltdl.h but not libltdl.a!");
+}
+
+void *DynamicLibrary::GetAddressOfSymbol(const char *symbolName) {
+  assert(!"Have ltdl.h but not libltdl.a!");
+  return 0;
+}
+
+#endif // HAVE_DLOPEN
+
+} // namespace llvm
+
+#else // HAVE_LTDL_H
+
+#include "platform/DynamicLibrary.cpp"
+
+#endif

lib/System/FreeBSD/DynamicLibrary.cpp

@@ -0,0 +1,27 @@
+//===- FreeBSD/DynamicLibrary.cpp - FreeBSD Dynamic Library -----*- C++ -*-===//
+// 
+//                     The LLVM Compiler Infrastructure
+//
+// This file was developed by Reid Spencer and is distributed under the 
+// University of Illinois Open Source License. See LICENSE.TXT for details.
+// 
+//===----------------------------------------------------------------------===//
+//
+// This file implements the FreeBSD version of DynamicLibrary
+//
+//===----------------------------------------------------------------------===//
+
+// Include the generic unix implementation
+#include "../Unix/DynamicLibrary.cpp"
+
+namespace llvm {
+using namespace sys;
+
+//===----------------------------------------------------------------------===//
+//=== WARNING: Implementation here must contain only FreeBSD specific code 
+//===          and must not be generic UNIX code (see ../Unix/Memory.cpp)
+//===----------------------------------------------------------------------===//
+
+}
+
+// vim: sw=2 smartindent smarttab tw=80 autoindent expandtab

lib/System/Interix/DynamicLibrary.cpp

@@ -0,0 +1,27 @@
+//===- Interix/DynamicLibrary.cpp - Interix Dynamic Library -----*- C++ -*-===//
+// 
+//                     The LLVM Compiler Infrastructure
+//
+// This file was developed by Reid Spencer and is distributed under the 
+// University of Illinois Open Source License. See LICENSE.TXT for details.
+// 
+//===----------------------------------------------------------------------===//
+//
+// This file implements the Interix version of DynamicLibrary
+//
+//===----------------------------------------------------------------------===//
+
+// Include the generic unix implementation
+#include "../Unix/DynamicLibrary.cpp"
+
+namespace llvm {
+using namespace sys;
+
+//===----------------------------------------------------------------------===//
+//=== WARNING: Implementation here must contain only Interix specific code 
+//===          and must not be generic UNIX code (see ../Unix/Memory.cpp)
+//===----------------------------------------------------------------------===//
+
+}
+
+// vim: sw=2 smartindent smarttab tw=80 autoindent expandtab

lib/System/Linux/DynamicLibrary.cpp

@@ -0,0 +1,27 @@
+//===- Linux/DynamicLibrary.cpp - Linux Dynamic Library ---------*- C++ -*-===//
+// 
+//                     The LLVM Compiler Infrastructure
+//
+// This file was developed by Reid Spencer and is distributed under the 
+// University of Illinois Open Source License. See LICENSE.TXT for details.
+// 
+//===----------------------------------------------------------------------===//
+//
+// This file implements the Linux version of DynamicLibrary
+//
+//===----------------------------------------------------------------------===//
+
+// Include the generic unix implementation
+#include "../Unix/DynamicLibrary.cpp"
+
+namespace llvm {
+using namespace sys;
+
+//===----------------------------------------------------------------------===//
+//=== WARNING: Implementation here must contain only Linux specific code 
+//===          and must not be generic UNIX code (see ../Unix/Memory.cpp)
+//===----------------------------------------------------------------------===//
+
+}
+
+// vim: sw=2 smartindent smarttab tw=80 autoindent expandtab

lib/System/SunOS/DynamicLibrary.cpp

@@ -0,0 +1,27 @@
+//===- SunOS/DynamicLibrary.cpp - SunOS Dynamic Library ---------*- C++ -*-===//
+// 
+//                     The LLVM Compiler Infrastructure
+//
+// This file was developed by Reid Spencer and is distributed under the 
+// University of Illinois Open Source License. See LICENSE.TXT for details.
+// 
+//===----------------------------------------------------------------------===//
+//
+// This file implements the SunOS version of DynamicLibrary
+//
+//===----------------------------------------------------------------------===//
+
+// Include the generic unix implementation
+#include "../Unix/DynamicLibrary.cpp"
+
+namespace llvm {
+using namespace sys;
+
+//===----------------------------------------------------------------------===//
+//=== WARNING: Implementation here must contain only SunOS specific code 
+//===          and must not be generic UNIX code (see ../Unix/Memory.cpp)
+//===----------------------------------------------------------------------===//
+
+}
+
+// vim: sw=2 smartindent smarttab tw=80 autoindent expandtab

lib/System/Unix/DynamicLibrary.cpp

@@ -0,0 +1,47 @@
+//===- Unix/DynamicLibrary.cpp - Generic UNIX Dynamic Library ---*- C++ -*-===//
+// 
+//                     The LLVM Compiler Infrastructure
+//
+// This file was developed by Reid Spencer and is distributed under the 
+// University of Illinois Open Source License. See LICENSE.TXT for details.
+// 
+//===----------------------------------------------------------------------===//
+//
+// This file implements the generic UNIX variant of DynamicLibrary
+//
+//===----------------------------------------------------------------------===//
+
+#include "Unix.h"
+
+namespace llvm {
+using namespace sys;
+
+
+DynamicLibrary::DynamicLibrary(const char *filename) {
+#if defined (HAVE_DLOPEN)
+  if ((handle = dlopen (filename, RTLD_NOW | RTLD_GLOBAL)) == 0)
+    throw std::string( dlerror() );
+#else
+  assert (!"Dynamic object linking not implemented for this platform");
+#endif
+}
+
+DynamicLibrary::~DynamicLibrary() {
+  assert(handle != 0 && "Invalid DynamicLibrary handle");
+#if defined (HAVE_DLOPEN)
+  dlclose(handle);
+#else
+  assert (!"Dynamic object linking not implemented for this platform");
+#endif
+}
+
+void *DynamicLibrary::GetAddressOfSymbol(const char *symbolName) {
+  assert(handle != 0 && "Invalid DynamicLibrary handle");
+#if defined(HAVE_DLOPEN)
+    return dlsym (handle, symbolName);
+#else
+  assert (0 && "Dynamic symbol lookup not implemented for this platform");
+#endif
+}
+
+}

lib/System/Win32/DynamicLibrary.cpp

@@ -0,0 +1,47 @@
+//===- Win32/DynamicLibrary.cpp - Win32 DL Implementation -------*- C++ -*-===//
+// 
+//                     The LLVM Compiler Infrastructure
+//
+// This file was developed by Reid Spencer and is distributed under the 
+// University of Illinois Open Source License. See LICENSE.TXT for details.
+// 
+//===----------------------------------------------------------------------===//
+//
+// This file provides the Win32 specific implementation of the DynamicLibrary
+//
+//===----------------------------------------------------------------------===//
+
+#include "Win32.h"
+
+namespace llvm {
+using namespace sys;
+
+//===----------------------------------------------------------------------===//
+//=== WARNING: Implementation here must contain only Win32 specific code 
+//===          and must not be UNIX code
+//===----------------------------------------------------------------------===//
+
+DynamicLibrary::DynamicLibrary(const char*filename) : handle(0) {
+  handle = LoadLibrary(filename);
+
+  if (handle == 0) {
+    char Buffer[100];
+    // FIXME: This should use FormatMessage
+    sprintf(Buffer, "Windows error code %d\n", GetLastError());
+    throw std::string(Buffer);
+  }
+}
+
+DynamicLibrary::~DynamicLibrary() {
+  if (handle)
+    FreeLibrary(handle);
+}
+
+void *DynamicLibrary::GetAddressOfSymbol(const char *symbolName) {
+  assert(handle !=0 && "Invalid DynamicLibrary handle");
+  return GetProcAddress(handle, symbolName);
+}
+
+}
+
+// vim: sw=2 smartindent smarttab tw=80 autoindent expandtab

lib/System/Win32/DynamicLibrary.inc

@@ -0,0 +1,47 @@
+//===- Win32/DynamicLibrary.cpp - Win32 DL Implementation -------*- C++ -*-===//
+// 
+//                     The LLVM Compiler Infrastructure
+//
+// This file was developed by Reid Spencer and is distributed under the 
+// University of Illinois Open Source License. See LICENSE.TXT for details.
+// 
+//===----------------------------------------------------------------------===//
+//
+// This file provides the Win32 specific implementation of the DynamicLibrary
+//
+//===----------------------------------------------------------------------===//
+
+#include "Win32.h"
+
+namespace llvm {
+using namespace sys;
+
+//===----------------------------------------------------------------------===//
+//=== WARNING: Implementation here must contain only Win32 specific code 
+//===          and must not be UNIX code
+//===----------------------------------------------------------------------===//
+
+DynamicLibrary::DynamicLibrary(const char*filename) : handle(0) {
+  handle = LoadLibrary(filename);
+
+  if (handle == 0) {
+    char Buffer[100];
+    // FIXME: This should use FormatMessage
+    sprintf(Buffer, "Windows error code %d\n", GetLastError());
+    throw std::string(Buffer);
+  }
+}
+
+DynamicLibrary::~DynamicLibrary() {
+  if (handle)
+    FreeLibrary(handle);
+}
+
+void *DynamicLibrary::GetAddressOfSymbol(const char *symbolName) {
+  assert(handle !=0 && "Invalid DynamicLibrary handle");
+  return GetProcAddress(handle, symbolName);
+}
+
+}
+
+// vim: sw=2 smartindent smarttab tw=80 autoindent expandtab