1 /*
2 * Copyright (c) 2011, 2015, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.
8 *
9 * This code is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12 * version 2 for more details (a copy is included in the LICENSE file that
13 * accompanied this code).
14 *
15 * You should have received a copy of the GNU General Public License version
16 * 2 along with this work; if not, write to the Free Software Foundation,
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18 *
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20 * or visit www.oracle.com if you need additional information or have any
21 * questions.
22 *
23 */
24
25 #ifndef OS_WINDOWS_VM_DECODER_WINDOWS_HPP
26 #define OS_WINDOWS_VM_DECIDER_WINDOWS_HPP
27
28 #include <windows.h>
29 #if _MSC_VER >= 1900
30 #pragma warning( disable : 4091 ) // typedef ignored on left when no variable is declared
31 #endif
32 #include <imagehlp.h>
33
34 #include "utilities/decoder.hpp"
35
36 // functions needed for decoding symbols
37 typedef DWORD (WINAPI *pfn_SymSetOptions)(DWORD);
38 typedef BOOL (WINAPI *pfn_SymInitialize)(HANDLE, PCTSTR, BOOL);
39 typedef BOOL (WINAPI *pfn_SymGetSymFromAddr64)(HANDLE, DWORD64, PDWORD64, PIMAGEHLP_SYMBOL64);
40 typedef DWORD (WINAPI *pfn_UndecorateSymbolName)(const char*, char*, DWORD, DWORD);
41 typedef BOOL (WINAPI *pfn_SymSetSearchPath)(HANDLE, PCTSTR);
42 typedef BOOL (WINAPI *pfn_SymGetSearchPath)(HANDLE, PTSTR, int);
43
44 #ifdef AMD64
45 typedef BOOL (WINAPI *pfn_StackWalk64)(DWORD MachineType,
46 HANDLE hProcess,
47 HANDLE hThread,
48 LPSTACKFRAME64 StackFrame,
49 PVOID ContextRecord,
50 PREAD_PROCESS_MEMORY_ROUTINE64 ReadMemoryRoutine,
51 PFUNCTION_TABLE_ACCESS_ROUTINE64 FunctionTableAccessRoutine,
52 PGET_MODULE_BASE_ROUTINE64 GetModuleBaseRoutine,
53 PTRANSLATE_ADDRESS_ROUTINE64 TranslateAddress);
54 typedef PVOID (WINAPI *pfn_SymFunctionTableAccess64)(HANDLE hProcess, DWORD64 AddrBase);
55 typedef DWORD64 (WINAPI *pfn_SymGetModuleBase64)(HANDLE hProcess, DWORD64 dwAddr);
56 #endif
57
58 class WindowsDecoder : public AbstractDecoder {
59
60 public:
61 WindowsDecoder();
62 ~WindowsDecoder() { uninitialize(); };
63
64 bool can_decode_C_frame_in_vm() const;
65 bool demangle(const char* symbol, char *buf, int buflen);
66 bool decode(address addr, char *buf, int buflen, int* offset, const char* modulepath, bool demangle);
67 bool decode(address addr, char *buf, int buflen, int* offset, const void* base) {
68 ShouldNotReachHere();
69 return false;
70 }
71
72 private:
73 void initialize();
74 void uninitialize();
75
76 private:
77 HMODULE _dbghelp_handle;
78 bool _can_decode_in_vm;
79 pfn_SymGetSymFromAddr64 _pfnSymGetSymFromAddr64;
80 pfn_UndecorateSymbolName _pfnUndecorateSymbolName;
81 #ifdef AMD64
82 pfn_StackWalk64 _pfnStackWalk64;
83 pfn_SymFunctionTableAccess64 _pfnSymFunctionTableAccess64;
84 pfn_SymGetModuleBase64 _pfnSymGetModuleBase64;
85
86 friend class WindowsDbgHelp;
87 #endif
88 };
89
90 #ifdef AMD64
91 // TODO: refactor and move the handling of dbghelp.dll outside of Decoder
92 class WindowsDbgHelp : public Decoder {
93 public:
94 static BOOL StackWalk64(DWORD MachineType,
95 HANDLE hProcess,
96 HANDLE hThread,
97 LPSTACKFRAME64 StackFrame,
98 PVOID ContextRecord,
99 PREAD_PROCESS_MEMORY_ROUTINE64 ReadMemoryRoutine,
100 PFUNCTION_TABLE_ACCESS_ROUTINE64 FunctionTableAccessRoutine,
101 PGET_MODULE_BASE_ROUTINE64 GetModuleBaseRoutine,
102 PTRANSLATE_ADDRESS_ROUTINE64 TranslateAddress);
103 static PVOID SymFunctionTableAccess64(HANDLE hProcess, DWORD64 AddrBase);
104
105 static pfn_SymFunctionTableAccess64 pfnSymFunctionTableAccess64();
106 static pfn_SymGetModuleBase64 pfnSymGetModuleBase64();
107 };
108 #endif
109
110 #endif // OS_WINDOWS_VM_DECODER_WINDOWS_HPP
111