lib/System/DynamicLibrary.cpp

   1 //===-- DynamicLibrary.cpp - Runtime link/load libraries --------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 //  This header file implements the operating system DynamicLibrary concept.
  11 //
  12 // FIXME: This file leaks the ExplicitSymbols and OpenedHandles vector, and is
  13 // not thread safe!
  14 //
  15 //===----------------------------------------------------------------------===//
  16
  17 #include "llvm/System/DynamicLibrary.h"
  18 #include "llvm/Config/config.h"
  19 #include <cstdio>
  20 #include <cstring>
  21 #include <map>
  22 #include <vector>
  23
  24 // Collection of symbol name/value pairs to be searched prior to any libraries.
  25 static std::map<std::string, void*> *ExplicitSymbols = 0;
  26
  27 static struct ExplicitSymbolsDeleter {
  28   ~ExplicitSymbolsDeleter() {
  29     if (ExplicitSymbols)
  30       delete ExplicitSymbols;
  31   }
  32 } Dummy;
  33
  34 void llvm::sys::DynamicLibrary::AddSymbol(const char* symbolName,
  35                                           void *symbolValue) {
  36   if (ExplicitSymbols == 0)
  37     ExplicitSymbols = new std::map<std::string, void*>();
  38   (*ExplicitSymbols)[symbolName] = symbolValue;
  39 }
  40
  41 #ifdef LLVM_ON_WIN32
  42
  43 #include "Win32/DynamicLibrary.inc"
  44
  45 #else
  46
  47 #include <dlfcn.h>
  48 using namespace llvm;
  49 using namespace llvm::sys;
  50
  51 //===----------------------------------------------------------------------===//
  52 //=== WARNING: Implementation here must contain only TRULY operating system
  53 //===          independent code.
  54 //===----------------------------------------------------------------------===//
  55
  56 static std::vector<void *> *OpenedHandles = 0;
  57
  58
  59 bool DynamicLibrary::LoadLibraryPermanently(const char *Filename,
  60                                             std::string *ErrMsg) {
  61   void *H = dlopen(Filename, RTLD_LAZY|RTLD_GLOBAL);
  62   if (H == 0) {
  63     if (ErrMsg) *ErrMsg = dlerror();
  64     return true;
  65   }
  66   if (OpenedHandles == 0)
  67     OpenedHandles = new std::vector<void *>();
  68   OpenedHandles->push_back(H);
  69   return false;
  70 }
  71
  72 void* DynamicLibrary::SearchForAddressOfSymbol(const char* symbolName) {
  73   // First check symbols added via AddSymbol().
  74   if (ExplicitSymbols) {
  75     std::map<std::string, void *>::iterator I =
  76       ExplicitSymbols->find(symbolName);
  77     std::map<std::string, void *>::iterator E = ExplicitSymbols->end();
  78
  79     if (I != E)
  80       return I->second;
  81   }
  82
  83   // Now search the libraries.
  84   if (OpenedHandles) {
  85     for (std::vector<void *>::iterator I = OpenedHandles->begin(),
  86          E = OpenedHandles->end(); I != E; ++I) {
  87       //lt_ptr ptr = lt_dlsym(*I, symbolName);
  88       void *ptr = dlsym(*I, symbolName);
  89       if (ptr) {
  90         return ptr;
  91       }
  92     }
  93   }
  94
  95 #define EXPLICIT_SYMBOL(SYM) \
  96    extern void *SYM; if (!strcmp(symbolName, #SYM)) return &SYM
  97
  98   // If this is darwin, it has some funky issues, try to solve them here.  Some
  99   // important symbols are marked 'private external' which doesn't allow
 100   // SearchForAddressOfSymbol to find them.  As such, we special case them here,
 101   // there is only a small handful of them.
 102
 103 #ifdef __APPLE__
 104   {
 105     EXPLICIT_SYMBOL(__ashldi3);
 106     EXPLICIT_SYMBOL(__ashrdi3);
 107     EXPLICIT_SYMBOL(__cmpdi2);
 108     EXPLICIT_SYMBOL(__divdi3);
 109     EXPLICIT_SYMBOL(__eprintf);
 110     EXPLICIT_SYMBOL(__fixdfdi);
 111     EXPLICIT_SYMBOL(__fixsfdi);
 112     EXPLICIT_SYMBOL(__fixunsdfdi);
 113     EXPLICIT_SYMBOL(__fixunssfdi);
 114     EXPLICIT_SYMBOL(__floatdidf);
 115     EXPLICIT_SYMBOL(__floatdisf);
 116     EXPLICIT_SYMBOL(__lshrdi3);
 117     EXPLICIT_SYMBOL(__moddi3);
 118     EXPLICIT_SYMBOL(__udivdi3);
 119     EXPLICIT_SYMBOL(__umoddi3);
 120   }
 121 #endif
 122
 123 #ifdef __CYGWIN__
 124   {
 125     EXPLICIT_SYMBOL(_alloca);
 126     EXPLICIT_SYMBOL(__main);
 127   }
 128 #endif
 129
 130 #undef EXPLICIT_SYMBOL
 131
 132 // This macro returns the address of a well-known, explicit symbol
 133 #define EXPLICIT_SYMBOL(SYM) \
 134    if (!strcmp(symbolName, #SYM)) return &SYM
 135
 136 // On linux we have a weird situation. The stderr/out/in symbols are both
 137 // macros and global variables because of standards requirements. So, we
 138 // boldly use the EXPLICIT_SYMBOL macro without checking for a #define first.
 139 #if defined(__linux__)
 140   {
 141     EXPLICIT_SYMBOL(stderr);
 142     EXPLICIT_SYMBOL(stdout);
 143     EXPLICIT_SYMBOL(stdin);
 144   }
 145 #else
 146   // For everything else, we want to check to make sure the symbol isn't defined
 147   // as a macro before using EXPLICIT_SYMBOL.
 148   {
 149 #ifndef stdin
 150     EXPLICIT_SYMBOL(stdin);
 151 #endif
 152 #ifndef stdout
 153     EXPLICIT_SYMBOL(stdout);
 154 #endif
 155 #ifndef stderr
 156     EXPLICIT_SYMBOL(stderr);
 157 #endif
 158   }
 159 #endif
 160 #undef EXPLICIT_SYMBOL
 161
 162   return 0;
 163 }
 164
 165 #endif // LLVM_ON_WIN32