blob: 79d5f79afa9722c7215d155c265e9432e42afcba [file] [log] [blame]
Reid Spencer4befbf32004-12-24 06:03:31 +00001//===- Win32/DynamicLibrary.cpp - Win32 DL Implementation -------*- C++ -*-===//
Michael J. Spencer447762d2010-11-29 18:16:10 +00002//
Reid Spencer4befbf32004-12-24 06:03:31 +00003// The LLVM Compiler Infrastructure
4//
Chris Lattnerf3ebc3f2007-12-29 20:36:04 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Michael J. Spencer447762d2010-11-29 18:16:10 +00007//
Reid Spencer4befbf32004-12-24 06:03:31 +00008//===----------------------------------------------------------------------===//
9//
Jeff Cohenf365c332004-12-25 04:50:17 +000010// This file provides the Win32 specific implementation of DynamicLibrary.
Reid Spencer4befbf32004-12-24 06:03:31 +000011//
12//===----------------------------------------------------------------------===//
13
Reid Klecknerd59e2fa2014-02-12 21:26:20 +000014#include "WindowsSupport.h"
Jeff Cohenf365c332004-12-25 04:50:17 +000015
Jeff Cohen07e22ba2005-02-19 03:01:13 +000016#ifdef __MINGW32__
Reid Spencer187b4ad2006-06-01 19:03:21 +000017 #include <imagehlp.h>
Jeff Cohenf365c332004-12-25 04:50:17 +000018#else
Reid Spencer187b4ad2006-06-01 19:03:21 +000019 #include <dbghelp.h>
Jeff Cohenf365c332004-12-25 04:50:17 +000020#endif
Jeff Cohen039b4ab2004-12-24 07:57:09 +000021
Stefanus Du Toitd2b7be62009-04-28 16:37:58 +000022#ifdef _MSC_VER
23 #include <ntverp.h>
24#endif
25
Reid Spencer187b4ad2006-06-01 19:03:21 +000026#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
Reid Spencer4befbf32004-12-24 06:03:31 +000033
34namespace llvm {
35using namespace sys;
36
37//===----------------------------------------------------------------------===//
Michael J. Spencer447762d2010-11-29 18:16:10 +000038//=== WARNING: Implementation here must contain only Win32 specific code
Jeff Cohen039b4ab2004-12-24 07:57:09 +000039//=== and must not be UNIX code.
Reid Spencer4befbf32004-12-24 06:03:31 +000040//===----------------------------------------------------------------------===//
41
Jordy Rosea19917d2011-08-17 00:29:32 +000042static DenseSet<HMODULE> *OpenedHandles;
Jeff Cohen039b4ab2004-12-24 07:57:09 +000043
NAKAMURA Takumibbae11b2014-09-23 01:09:46 +000044static BOOL CALLBACK
Yaron Kerenfb069082014-09-22 21:40:15 +000045ELM_Callback(WIN32_ELMCB_PCSTR ModuleName, ULONG_PTR ModuleBase,
46 ULONG ModuleSize, PVOID UserContext) {
47 OpenedHandles->insert((HMODULE)ModuleBase);
48 return TRUE;
Jeff Cohen039b4ab2004-12-24 07:57:09 +000049}
50
Jordy Rosea19917d2011-08-17 00:29:32 +000051DynamicLibrary DynamicLibrary::getPermanentLibrary(const char *filename,
52 std::string *errMsg) {
Filip Pizlo57093e82013-09-18 16:40:14 +000053 SmartScopedLock<true> lock(*SymbolsMutex);
Jordy Rose5765f4c2011-08-22 19:01:52 +000054
Jordy Rosea19917d2011-08-17 00:29:32 +000055 if (!filename) {
56 // When no file is specified, enumerate all DLLs and EXEs in the process.
Jordy Rosea19917d2011-08-17 00:29:32 +000057 if (OpenedHandles == 0)
58 OpenedHandles = new DenseSet<HMODULE>();
Jeff Cohen039b4ab2004-12-24 07:57:09 +000059
Jeff Cohen039b4ab2004-12-24 07:57:09 +000060 EnumerateLoadedModules(GetCurrentProcess(), ELM_Callback, 0);
Jordy Rosea19917d2011-08-17 00:29:32 +000061 // Dummy library that represents "search all handles".
62 // This is mostly to ensure that the return value still shows up as "valid".
63 return DynamicLibrary(&OpenedHandles);
64 }
David Majnemer61eae2e2013-10-07 01:00:07 +000065
66 SmallVector<wchar_t, MAX_PATH> filenameUnicode;
Rafael Espindolaadccf862014-06-12 21:53:57 +000067 if (std::error_code ec = windows::UTF8ToUTF16(filename, filenameUnicode)) {
David Majnemer61eae2e2013-10-07 01:00:07 +000068 SetLastError(ec.value());
69 MakeErrMsg(errMsg, std::string(filename) + ": Can't convert to UTF-16: ");
70 return DynamicLibrary();
71 }
Jordy Rosea19917d2011-08-17 00:29:32 +000072
David Majnemer61eae2e2013-10-07 01:00:07 +000073 HMODULE a_handle = LoadLibraryW(filenameUnicode.data());
Jordy Rosea19917d2011-08-17 00:29:32 +000074
75 if (a_handle == 0) {
Jordy Rose1a3ca922011-08-17 00:59:50 +000076 MakeErrMsg(errMsg, std::string(filename) + ": Can't open : ");
Jordy Rosea19917d2011-08-17 00:29:32 +000077 return DynamicLibrary();
Jeff Cohen039b4ab2004-12-24 07:57:09 +000078 }
79
Jordy Rosea19917d2011-08-17 00:29:32 +000080 if (OpenedHandles == 0)
81 OpenedHandles = new DenseSet<HMODULE>();
82
83 // If we've already loaded this library, FreeLibrary() the handle in order to
84 // keep the internal refcount at +1.
85 if (!OpenedHandles->insert(a_handle).second)
86 FreeLibrary(a_handle);
87
88 return DynamicLibrary(a_handle);
Jeff Cohen039b4ab2004-12-24 07:57:09 +000089}
90
Anton Korobeynikov66362102008-02-22 10:08:31 +000091// Stack probing routines are in the support library (e.g. libgcc), but we don't
92// have dynamic linking on windows. Provide a hook.
NAKAMURA Takumi03a541f2011-02-05 15:11:53 +000093#define EXPLICIT_SYMBOL(SYM) \
94 extern "C" { extern void *SYM; }
95#define EXPLICIT_SYMBOL2(SYMFROM, SYMTO) EXPLICIT_SYMBOL(SYMTO)
Anton Korobeynikov66362102008-02-22 10:08:31 +000096
Reid Kleckner9aeb0472014-11-13 23:32:52 +000097#ifdef _M_IX86
98// Win32 on x86 implements certain single-precision math functions as macros.
99// These functions are not exported by the DLL, but will still be needed
100// for symbol-resolution by the JIT loader. Therefore, this Support libray
101// provides helper functions with the same implementation.
102
103#define INLINE_DEF_SYMBOL1(TYP, SYM) \
104 extern "C" TYP inline_##SYM(TYP _X) { return SYM(_X); }
105#define INLINE_DEF_SYMBOL2(TYP, SYM) \
106 extern "C" TYP inline_##SYM(TYP _X, TYP _Y) { return SYM(_X, _Y); }
107#endif
108
NAKAMURA Takumi03a541f2011-02-05 15:11:53 +0000109#include "explicit_symbols.inc"
110
111#undef EXPLICIT_SYMBOL
112#undef EXPLICIT_SYMBOL2
Reid Kleckner9aeb0472014-11-13 23:32:52 +0000113#undef INLINE_DEF_SYMBOL1
114#undef INLINE_DEF_SYMBOL2
Anton Korobeynikov66362102008-02-22 10:08:31 +0000115
Jeff Cohen039b4ab2004-12-24 07:57:09 +0000116void* DynamicLibrary::SearchForAddressOfSymbol(const char* symbolName) {
Filip Pizlo57093e82013-09-18 16:40:14 +0000117 SmartScopedLock<true> Lock(*SymbolsMutex);
Jordy Rosea19917d2011-08-17 00:29:32 +0000118
Jeff Cohenbaeb39c2006-01-30 04:33:51 +0000119 // First check symbols added via AddSymbol().
Filip Pizlo57093e82013-09-18 16:40:14 +0000120 if (ExplicitSymbols.isConstructed()) {
Jordy Rosea19917d2011-08-17 00:29:32 +0000121 StringMap<void *>::iterator i = ExplicitSymbols->find(symbolName);
122
123 if (i != ExplicitSymbols->end())
124 return i->second;
Chris Lattnere4807c52009-07-08 00:52:12 +0000125 }
Jeff Cohenbaeb39c2006-01-30 04:33:51 +0000126
127 // Now search the libraries.
Jordy Rosea19917d2011-08-17 00:29:32 +0000128 if (OpenedHandles) {
129 for (DenseSet<HMODULE>::iterator I = OpenedHandles->begin(),
130 E = OpenedHandles->end(); I != E; ++I) {
131 FARPROC ptr = GetProcAddress((HMODULE)*I, symbolName);
132 if (ptr) {
133 return (void *)(intptr_t)ptr;
134 }
Owen Anderson021c3b02009-06-25 18:12:44 +0000135 }
Jeff Cohen039b4ab2004-12-24 07:57:09 +0000136 }
137
Reid Kleckner9aeb0472014-11-13 23:32:52 +0000138#define EXPLICIT_SYMBOL(SYM) \
139 if (!strcmp(symbolName, #SYM)) \
140 return (void *)&SYM;
141#define EXPLICIT_SYMBOL2(SYMFROM, SYMTO) \
142 if (!strcmp(symbolName, #SYMFROM)) \
143 return (void *)&SYMTO;
144
145#ifdef _M_IX86
146#define INLINE_DEF_SYMBOL1(TYP, SYM) \
147 if (!strcmp(symbolName, #SYM)) \
148 return (void *)&inline_##SYM;
149#define INLINE_DEF_SYMBOL2(TYP, SYM) INLINE_DEF_SYMBOL1(TYP, SYM)
150#endif
Anton Korobeynikov66362102008-02-22 10:08:31 +0000151
Anton Korobeynikovec9038bc2007-06-25 07:12:14 +0000152 {
Reid Kleckner9aeb0472014-11-13 23:32:52 +0000153#include "explicit_symbols.inc"
Anton Korobeynikov105682d2010-01-14 20:19:51 +0000154 }
NAKAMURA Takumi03a541f2011-02-05 15:11:53 +0000155
Reid Kleckner9aeb0472014-11-13 23:32:52 +0000156#undef EXPLICIT_SYMBOL
157#undef EXPLICIT_SYMBOL2
158#undef INLINE_DEF_SYMBOL1
159#undef INLINE_DEF_SYMBOL2
Anton Korobeynikoveef04ba2006-12-19 15:24:18 +0000160
Jeff Cohen039b4ab2004-12-24 07:57:09 +0000161 return 0;
Reid Spencer4befbf32004-12-24 06:03:31 +0000162}
163
Jordy Rosea19917d2011-08-17 00:29:32 +0000164void *DynamicLibrary::getAddressOfSymbol(const char *symbolName) {
165 if (!isValid())
166 return NULL;
167 if (Data == &OpenedHandles)
168 return SearchForAddressOfSymbol(symbolName);
169 return (void *)(intptr_t)GetProcAddress((HMODULE)Data, symbolName);
170}
171
Reid Spencer4befbf32004-12-24 06:03:31 +0000172}