Guard dynamic library loading.
[oota-llvm.git] / lib / System / Win32 / DynamicLibrary.inc
1 //===- Win32/DynamicLibrary.cpp - Win32 DL Implementation -------*- 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 file provides the Win32 specific implementation of DynamicLibrary.
11 //
12 //===----------------------------------------------------------------------===//
13
14 #include "Win32.h"
15
16 #ifdef __MINGW32__
17  #include <imagehlp.h>
18 #else
19  #include <dbghelp.h>
20 #endif
21
22 #ifdef _MSC_VER
23  #include <ntverp.h>
24 #endif
25
26 #ifdef __MINGW32__
27  #if (HAVE_LIBIMAGEHLP != 1)
28   #error "libimagehlp.a should be present"
29  #endif
30 #else
31  #pragma comment(lib, "dbghelp.lib")
32 #endif
33
34 namespace llvm {
35 using namespace sys;
36
37 //===----------------------------------------------------------------------===//
38 //=== WARNING: Implementation here must contain only Win32 specific code 
39 //===          and must not be UNIX code.
40 //===----------------------------------------------------------------------===//
41
42 static std::vector<HMODULE> OpenedHandles;
43
44 #ifdef _WIN64
45   typedef DWORD64 ModuleBaseType;
46 #else
47   typedef ULONG ModuleBaseType;
48 #endif
49
50 extern "C" {
51 // Use old callback if:
52 //  - Not using Visual Studio
53 //  - Visual Studio 2005 or earlier but only if we are not using the Windows SDK 
54 //    or Windows SDK version is older than 6.0
55 // Use new callback if:
56 //  - Newer Visual Studio (comes with newer SDK).
57 //  - Visual Studio 2005 with Windows SDK 6.0+
58 #if !defined(_MSC_VER) || _MSC_VER < 1500 && (!defined(VER_PRODUCTBUILD) || VER_PRODUCTBUILD < 6000)
59   static BOOL CALLBACK ELM_Callback(PSTR  ModuleName,
60                                     ModuleBaseType ModuleBase,
61                                     ULONG ModuleSize,
62                                     PVOID UserContext)
63 #else
64   static BOOL CALLBACK ELM_Callback(PCSTR  ModuleName,
65                                     ModuleBaseType ModuleBase,
66                                     ULONG ModuleSize,
67                                     PVOID UserContext)
68 #endif
69   {
70     llvm::sys::SmartScopedWriter<true> Writer(&SymbolsLock);
71     // Ignore VC++ runtimes prior to 7.1.  Somehow some of them get loaded
72     // into the process.
73     if (stricmp(ModuleName, "msvci70") != 0 &&
74         stricmp(ModuleName, "msvcirt") != 0 &&
75         stricmp(ModuleName, "msvcp50") != 0 &&
76         stricmp(ModuleName, "msvcp60") != 0 &&
77         stricmp(ModuleName, "msvcp70") != 0 &&
78         stricmp(ModuleName, "msvcr70") != 0 &&
79 #ifndef __MINGW32__
80         // Mingw32 uses msvcrt.dll by default. Don't ignore it.
81         // Otherwise, user should be aware, what he's doing :)
82         stricmp(ModuleName, "msvcrt") != 0 &&
83 #endif        
84         stricmp(ModuleName, "msvcrt20") != 0 &&
85         stricmp(ModuleName, "msvcrt40") != 0) {
86       OpenedHandles.push_back((HMODULE)ModuleBase);
87     }
88     return TRUE;
89   }
90 }
91
92 DynamicLibrary::DynamicLibrary() : handle(0) {
93   SmartScopedWriter<true> Writer(&SymbolsLock);
94   handle = GetModuleHandle(NULL);
95   OpenedHandles.push_back((HMODULE)handle);
96 }
97
98 DynamicLibrary::~DynamicLibrary() {
99   llvm::sys::SmartScopedWriter<true> Writer(&SymbolsLock);
100   if (handle == 0)
101     return;
102
103   // GetModuleHandle() does not increment the ref count, so we must not free
104   // the handle to the executable.
105   if (handle != GetModuleHandle(NULL))
106     FreeLibrary((HMODULE)handle);
107   handle = 0;
108
109   for (std::vector<HMODULE>::iterator I = OpenedHandles.begin(),
110        E = OpenedHandles.end(); I != E; ++I) {
111     if (*I == handle) {
112       // Note: don't use the swap/pop_back trick here. Order is important.
113       OpenedHandles.erase(I);
114     }
115   }
116 }
117  
118 bool DynamicLibrary::LoadLibraryPermanently(const char *filename,
119                                             std::string *ErrMsg) {                                            
120   if (filename) {
121     llvm::sys::SmartScopedWriter<true> Writer(&SymbolsLock);
122     HMODULE a_handle = LoadLibrary(filename);
123
124     if (a_handle == 0)
125       return MakeErrMsg(ErrMsg, std::string(filename) + ": Can't open : ");
126
127     OpenedHandles.push_back(a_handle);
128   } else {
129     // When no file is specified, enumerate all DLLs and EXEs in the
130     // process.
131     EnumerateLoadedModules(GetCurrentProcess(), ELM_Callback, 0);
132   }
133
134   // Because we don't remember the handle, we will never free it; hence,
135   // it is loaded permanently.
136   return false;
137 }
138
139 // Stack probing routines are in the support library (e.g. libgcc), but we don't
140 // have dynamic linking on windows. Provide a hook.
141 #if defined(__MINGW32__) || defined (_MSC_VER)
142   #define EXPLICIT_SYMBOL(SYM)                    \
143     if (!strcmp(symbolName, #SYM)) return (void*)&SYM
144   #define EXPLICIT_SYMBOL2(SYMFROM, SYMTO)        \
145     if (!strcmp(symbolName, #SYMFROM)) return (void*)&SYMTO
146   #define EXPLICIT_SYMBOL_DEF(SYM)                \
147     extern "C" { extern void *SYM; }
148
149   #if defined(__MINGW32__)
150     EXPLICIT_SYMBOL_DEF(_alloca);
151     EXPLICIT_SYMBOL_DEF(__main);
152     EXPLICIT_SYMBOL_DEF(__ashldi3);
153     EXPLICIT_SYMBOL_DEF(__ashrdi3);
154     EXPLICIT_SYMBOL_DEF(__cmpdi2);
155     EXPLICIT_SYMBOL_DEF(__divdi3);
156     EXPLICIT_SYMBOL_DEF(__fixdfdi);
157     EXPLICIT_SYMBOL_DEF(__fixsfdi);
158     EXPLICIT_SYMBOL_DEF(__fixunsdfdi);
159     EXPLICIT_SYMBOL_DEF(__fixunssfdi);
160     EXPLICIT_SYMBOL_DEF(__floatdidf);
161     EXPLICIT_SYMBOL_DEF(__floatdisf);
162     EXPLICIT_SYMBOL_DEF(__lshrdi3);
163     EXPLICIT_SYMBOL_DEF(__moddi3);
164     EXPLICIT_SYMBOL_DEF(__udivdi3);
165     EXPLICIT_SYMBOL_DEF(__umoddi3);
166   #elif defined(_MSC_VER)
167     EXPLICIT_SYMBOL_DEF(_alloca_probe);
168   #endif
169 #endif
170
171 void* DynamicLibrary::SearchForAddressOfSymbol(const char* symbolName) {
172   // First check symbols added via AddSymbol().
173   SymbolsLock.reader_acquire();
174   std::map<std::string, void *>::iterator I = symbols.find(symbolName);
175   std::map<std::string, void *>::iterator E = symbols.end();
176   SymbolsLock.reader_release();
177   if (I != E)
178     return I->second;
179
180   // Now search the libraries.
181   SymbolsLock.writer_acquire();
182   for (std::vector<HMODULE>::iterator I = OpenedHandles.begin(),
183        E = OpenedHandles.end(); I != E; ++I) {
184     FARPROC ptr = GetProcAddress((HMODULE)*I, symbolName);
185     if (ptr) {
186       SymbolsLock.writer_release();
187       return (void *) ptr;
188     }
189   }
190   SymbolsLock.writer_release();
191
192 #if defined(__MINGW32__)
193   {
194     EXPLICIT_SYMBOL(_alloca);
195     EXPLICIT_SYMBOL(__main);
196     EXPLICIT_SYMBOL(__ashldi3);
197     EXPLICIT_SYMBOL(__ashrdi3);
198     EXPLICIT_SYMBOL(__cmpdi2);
199     EXPLICIT_SYMBOL(__divdi3);
200     EXPLICIT_SYMBOL(__fixdfdi);
201     EXPLICIT_SYMBOL(__fixsfdi);
202     EXPLICIT_SYMBOL(__fixunsdfdi);
203     EXPLICIT_SYMBOL(__fixunssfdi);
204     EXPLICIT_SYMBOL(__floatdidf);
205     EXPLICIT_SYMBOL(__floatdisf);
206     EXPLICIT_SYMBOL(__lshrdi3);
207     EXPLICIT_SYMBOL(__moddi3);
208     EXPLICIT_SYMBOL(__udivdi3);
209     EXPLICIT_SYMBOL(__umoddi3);
210
211     EXPLICIT_SYMBOL2(alloca, _alloca);
212 #undef EXPLICIT_SYMBOL
213 #undef EXPLICIT_SYMBOL2
214 #undef EXPLICIT_SYMBOL_DEF    
215   }
216 #elif defined(_MSC_VER)
217   {
218     EXPLICIT_SYMBOL2(alloca, _alloca_probe);
219     EXPLICIT_SYMBOL2(_alloca, _alloca_probe);
220 #undef EXPLICIT_SYMBOL
221 #undef EXPLICIT_SYMBOL2
222 #undef EXPLICIT_SYMBOL_DEF    
223   }  
224 #endif
225
226   return 0;
227 }
228
229 }
230