src/os/windows/vm/decoder_windows.cpp

Fri, 06 Sep 2013 08:42:42 -0700

author
iklam
date
Fri, 06 Sep 2013 08:42:42 -0700
changeset 5667
38f750491293
parent 4675
63e54c37ac64
child 6876
710a3c8b516e
permissions
-rw-r--r--

8022335: Native stack walk while generating hs_err does not work on Windows x64
Summary: Use WinDbg API StackWalk64()
Reviewed-by: zgu, dholmes

zgu@2364 1 /*
simonis@4675 2 * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
zgu@2364 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
zgu@2364 4 *
zgu@2364 5 * This code is free software; you can redistribute it and/or modify it
zgu@2364 6 * under the terms of the GNU General Public License version 2 only, as
zgu@2364 7 * published by the Free Software Foundation.
zgu@2364 8 *
zgu@2364 9 * This code is distributed in the hope that it will be useful, but WITHOUT
zgu@2364 10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
zgu@2364 11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
zgu@2364 12 * version 2 for more details (a copy is included in the LICENSE file that
zgu@2364 13 * accompanied this code).
zgu@2364 14 *
zgu@2364 15 * You should have received a copy of the GNU General Public License version
zgu@2364 16 * 2 along with this work; if not, write to the Free Software Foundation,
zgu@2364 17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
zgu@2364 18 *
zgu@2364 19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
zgu@2364 20 * or visit www.oracle.com if you need additional information or have any
zgu@2364 21 * questions.
zgu@2364 22 *
zgu@2364 23 */
zgu@2364 24
zgu@2364 25 #include "precompiled.hpp"
zgu@2364 26 #include "prims/jvm.h"
simonis@4675 27 #include "runtime/arguments.hpp"
zgu@3430 28 #include "decoder_windows.hpp"
zgu@2364 29
zgu@3430 30 WindowsDecoder::WindowsDecoder() {
zgu@3430 31 _dbghelp_handle = NULL;
zgu@3430 32 _can_decode_in_vm = false;
zgu@3430 33 _pfnSymGetSymFromAddr64 = NULL;
zgu@3430 34 _pfnUndecorateSymbolName = NULL;
iklam@5667 35 #ifdef AMD64
iklam@5667 36 _pfnStackWalk64 = NULL;
iklam@5667 37 _pfnSymFunctionTableAccess64 = NULL;
iklam@5667 38 _pfnSymGetModuleBase64 = NULL;
iklam@5667 39 #endif
zgu@3430 40 _decoder_status = no_error;
zgu@3430 41 initialize();
zgu@3430 42 }
zgu@2364 43
zgu@3430 44 void WindowsDecoder::initialize() {
zgu@3430 45 if (!has_error() && _dbghelp_handle == NULL) {
zgu@3430 46 HMODULE handle = ::LoadLibrary("dbghelp.dll");
zgu@2364 47 if (!handle) {
zgu@2364 48 _decoder_status = helper_not_found;
zgu@3430 49 return;
zgu@2364 50 }
zgu@2364 51
zgu@2364 52 _dbghelp_handle = handle;
zgu@2364 53
zgu@2364 54 pfn_SymSetOptions _pfnSymSetOptions = (pfn_SymSetOptions)::GetProcAddress(handle, "SymSetOptions");
zgu@2364 55 pfn_SymInitialize _pfnSymInitialize = (pfn_SymInitialize)::GetProcAddress(handle, "SymInitialize");
zgu@2364 56 _pfnSymGetSymFromAddr64 = (pfn_SymGetSymFromAddr64)::GetProcAddress(handle, "SymGetSymFromAddr64");
zgu@4423 57 _pfnUndecorateSymbolName = (pfn_UndecorateSymbolName)::GetProcAddress(handle, "UnDecorateSymbolName");
zgu@2364 58
zgu@2364 59 if (_pfnSymSetOptions == NULL || _pfnSymInitialize == NULL || _pfnSymGetSymFromAddr64 == NULL) {
iklam@5667 60 uninitialize();
zgu@2364 61 _decoder_status = helper_func_error;
zgu@2364 62 return;
zgu@2364 63 }
zgu@2364 64
iklam@5667 65 #ifdef AMD64
iklam@5667 66 _pfnStackWalk64 = (pfn_StackWalk64)::GetProcAddress(handle, "StackWalk64");
iklam@5667 67 _pfnSymFunctionTableAccess64 = (pfn_SymFunctionTableAccess64)::GetProcAddress(handle, "SymFunctionTableAccess64");
iklam@5667 68 _pfnSymGetModuleBase64 = (pfn_SymGetModuleBase64)::GetProcAddress(handle, "SymGetModuleBase64");
iklam@5667 69 if (_pfnStackWalk64 == NULL || _pfnSymFunctionTableAccess64 == NULL || _pfnSymGetModuleBase64 == NULL) {
iklam@5667 70 // We can't call StackWalk64 to walk the stack, but we are still
iklam@5667 71 // able to decode the symbols. Let's limp on.
iklam@5667 72 _pfnStackWalk64 = NULL;
iklam@5667 73 _pfnSymFunctionTableAccess64 = NULL;
iklam@5667 74 _pfnSymGetModuleBase64 = NULL;
iklam@5667 75 }
iklam@5667 76 #endif
iklam@5667 77
zgu@4423 78 HANDLE hProcess = ::GetCurrentProcess();
zgu@4423 79 _pfnSymSetOptions(SYMOPT_UNDNAME | SYMOPT_DEFERRED_LOADS | SYMOPT_EXACT_SYMBOLS);
zgu@4423 80 if (!_pfnSymInitialize(hProcess, NULL, TRUE)) {
zgu@2364 81 _pfnSymGetSymFromAddr64 = NULL;
zgu@2364 82 _pfnUndecorateSymbolName = NULL;
zgu@2364 83 ::FreeLibrary(handle);
zgu@2364 84 _dbghelp_handle = NULL;
zgu@2364 85 _decoder_status = helper_init_error;
zgu@2364 86 return;
zgu@2364 87 }
zgu@2364 88
zgu@4423 89 // set pdb search paths
zgu@4423 90 pfn_SymSetSearchPath _pfn_SymSetSearchPath =
zgu@4423 91 (pfn_SymSetSearchPath)::GetProcAddress(handle, "SymSetSearchPath");
zgu@4423 92 pfn_SymGetSearchPath _pfn_SymGetSearchPath =
zgu@4423 93 (pfn_SymGetSearchPath)::GetProcAddress(handle, "SymGetSearchPath");
zgu@4423 94 if (_pfn_SymSetSearchPath != NULL && _pfn_SymGetSearchPath != NULL) {
zgu@4423 95 char paths[MAX_PATH];
zgu@4423 96 int len = sizeof(paths);
zgu@4423 97 if (!_pfn_SymGetSearchPath(hProcess, paths, len)) {
zgu@4423 98 paths[0] = '\0';
zgu@4423 99 } else {
zgu@4423 100 // available spaces in path buffer
zgu@4423 101 len -= (int)strlen(paths);
zgu@4423 102 }
zgu@4423 103
zgu@4423 104 char tmp_path[MAX_PATH];
zgu@4423 105 DWORD dwSize;
zgu@4423 106 HMODULE hJVM = ::GetModuleHandle("jvm.dll");
zgu@4423 107 tmp_path[0] = '\0';
zgu@4423 108 // append the path where jvm.dll is located
zgu@4423 109 if (hJVM != NULL && (dwSize = ::GetModuleFileName(hJVM, tmp_path, sizeof(tmp_path))) > 0) {
zgu@4423 110 while (dwSize > 0 && tmp_path[dwSize] != '\\') {
zgu@4423 111 dwSize --;
zgu@4423 112 }
zgu@4423 113
zgu@4423 114 tmp_path[dwSize] = '\0';
zgu@4423 115
zgu@4423 116 if (dwSize > 0 && len > (int)dwSize + 1) {
zgu@4423 117 strncat(paths, os::path_separator(), 1);
zgu@4423 118 strncat(paths, tmp_path, dwSize);
zgu@4423 119 len -= dwSize + 1;
zgu@4423 120 }
zgu@4423 121 }
zgu@4423 122
zgu@4423 123 // append $JRE/bin. Arguments::get_java_home actually returns $JRE
zgu@4423 124 // path
zgu@4423 125 char *p = Arguments::get_java_home();
zgu@4423 126 assert(p != NULL, "empty java home");
zgu@4423 127 size_t java_home_len = strlen(p);
zgu@4423 128 if (len > (int)java_home_len + 5) {
zgu@4423 129 strncat(paths, os::path_separator(), 1);
zgu@4423 130 strncat(paths, p, java_home_len);
zgu@4423 131 strncat(paths, "\\bin", 4);
zgu@4423 132 len -= (int)(java_home_len + 5);
zgu@4423 133 }
zgu@4423 134
zgu@4423 135 // append $JDK/bin path if it exists
zgu@4423 136 assert(java_home_len < MAX_PATH, "Invalid path length");
zgu@4423 137 // assume $JRE is under $JDK, construct $JDK/bin path and
zgu@4423 138 // see if it exists or not
zgu@4423 139 if (strncmp(&p[java_home_len - 3], "jre", 3) == 0) {
zgu@4423 140 strncpy(tmp_path, p, java_home_len - 3);
zgu@4423 141 tmp_path[java_home_len - 3] = '\0';
zgu@4423 142 strncat(tmp_path, "bin", 3);
zgu@4423 143
zgu@4423 144 // if the directory exists
zgu@4423 145 DWORD dwAttrib = GetFileAttributes(tmp_path);
zgu@4423 146 if (dwAttrib != INVALID_FILE_ATTRIBUTES &&
zgu@4423 147 (dwAttrib & FILE_ATTRIBUTE_DIRECTORY)) {
zgu@4423 148 // tmp_path should have the same length as java_home_len, since we only
zgu@4423 149 // replaced 'jre' with 'bin'
zgu@4423 150 if (len > (int)java_home_len + 1) {
zgu@4423 151 strncat(paths, os::path_separator(), 1);
zgu@4423 152 strncat(paths, tmp_path, java_home_len);
zgu@4423 153 }
zgu@4423 154 }
zgu@4423 155 }
zgu@4423 156
zgu@4423 157 _pfn_SymSetSearchPath(hProcess, paths);
zgu@4423 158 }
zgu@4423 159
zgu@2364 160 // find out if jvm.dll contains private symbols, by decoding
zgu@2364 161 // current function and comparing the result
zgu@3961 162 address addr = (address)Decoder::demangle;
zgu@2364 163 char buf[MAX_PATH];
zgu@3430 164 if (decode(addr, buf, sizeof(buf), NULL)) {
zgu@3961 165 _can_decode_in_vm = !strcmp(buf, "Decoder::demangle");
zgu@2364 166 }
zgu@2364 167 }
zgu@2364 168 }
zgu@2364 169
zgu@3430 170 void WindowsDecoder::uninitialize() {
zgu@2364 171 _pfnSymGetSymFromAddr64 = NULL;
zgu@2364 172 _pfnUndecorateSymbolName = NULL;
iklam@5667 173 #ifdef AMD64
iklam@5667 174 _pfnStackWalk64 = NULL;
iklam@5667 175 _pfnSymFunctionTableAccess64 = NULL;
iklam@5667 176 _pfnSymGetModuleBase64 = NULL;
iklam@5667 177 #endif
zgu@2364 178 if (_dbghelp_handle != NULL) {
zgu@2364 179 ::FreeLibrary(_dbghelp_handle);
zgu@2364 180 }
zgu@3430 181 _dbghelp_handle = NULL;
zgu@2364 182 }
zgu@2364 183
zgu@3430 184 bool WindowsDecoder::can_decode_C_frame_in_vm() const {
zgu@3430 185 return (!has_error() && _can_decode_in_vm);
zgu@2364 186 }
zgu@2364 187
zgu@2364 188
zgu@3430 189 bool WindowsDecoder::decode(address addr, char *buf, int buflen, int* offset, const char* modulepath) {
zgu@2364 190 if (_pfnSymGetSymFromAddr64 != NULL) {
zgu@2364 191 PIMAGEHLP_SYMBOL64 pSymbol;
zgu@2364 192 char symbolInfo[MAX_PATH + sizeof(IMAGEHLP_SYMBOL64)];
zgu@2364 193 pSymbol = (PIMAGEHLP_SYMBOL64)symbolInfo;
zgu@2364 194 pSymbol->MaxNameLength = MAX_PATH;
zgu@2364 195 pSymbol->SizeOfStruct = sizeof(IMAGEHLP_SYMBOL64);
zgu@2364 196 DWORD64 displacement;
zgu@2364 197 if (_pfnSymGetSymFromAddr64(::GetCurrentProcess(), (DWORD64)addr, &displacement, pSymbol)) {
zgu@2364 198 if (buf != NULL) {
zgu@3430 199 if (demangle(pSymbol->Name, buf, buflen)) {
zgu@2364 200 jio_snprintf(buf, buflen, "%s", pSymbol->Name);
zgu@2364 201 }
zgu@2364 202 }
zgu@3430 203 if(offset != NULL) *offset = (int)displacement;
zgu@3430 204 return true;
zgu@2364 205 }
zgu@2364 206 }
zgu@3430 207 if (buf != NULL && buflen > 0) buf[0] = '\0';
zgu@3430 208 if (offset != NULL) *offset = -1;
zgu@3430 209 return false;
zgu@2364 210 }
zgu@2364 211
zgu@3430 212 bool WindowsDecoder::demangle(const char* symbol, char *buf, int buflen) {
zgu@2364 213 return _pfnUndecorateSymbolName != NULL &&
zgu@2364 214 _pfnUndecorateSymbolName(symbol, buf, buflen, UNDNAME_COMPLETE);
zgu@2364 215 }
zgu@2364 216
iklam@5667 217 #ifdef AMD64
iklam@5667 218 BOOL WindowsDbgHelp::StackWalk64(DWORD MachineType,
iklam@5667 219 HANDLE hProcess,
iklam@5667 220 HANDLE hThread,
iklam@5667 221 LPSTACKFRAME64 StackFrame,
iklam@5667 222 PVOID ContextRecord,
iklam@5667 223 PREAD_PROCESS_MEMORY_ROUTINE64 ReadMemoryRoutine,
iklam@5667 224 PFUNCTION_TABLE_ACCESS_ROUTINE64 FunctionTableAccessRoutine,
iklam@5667 225 PGET_MODULE_BASE_ROUTINE64 GetModuleBaseRoutine,
iklam@5667 226 PTRANSLATE_ADDRESS_ROUTINE64 TranslateAddress) {
iklam@5667 227 DecoderLocker locker;
iklam@5667 228 WindowsDecoder* wd = (WindowsDecoder*)locker.decoder();
iklam@5667 229
iklam@5667 230 if (!wd->has_error() && wd->_pfnStackWalk64) {
iklam@5667 231 return wd->_pfnStackWalk64(MachineType,
iklam@5667 232 hProcess,
iklam@5667 233 hThread,
iklam@5667 234 StackFrame,
iklam@5667 235 ContextRecord,
iklam@5667 236 ReadMemoryRoutine,
iklam@5667 237 FunctionTableAccessRoutine,
iklam@5667 238 GetModuleBaseRoutine,
iklam@5667 239 TranslateAddress);
iklam@5667 240 } else {
iklam@5667 241 return false;
iklam@5667 242 }
iklam@5667 243 }
iklam@5667 244
iklam@5667 245 PVOID WindowsDbgHelp::SymFunctionTableAccess64(HANDLE hProcess, DWORD64 AddrBase) {
iklam@5667 246 DecoderLocker locker;
iklam@5667 247 WindowsDecoder* wd = (WindowsDecoder*)locker.decoder();
iklam@5667 248
iklam@5667 249 if (!wd->has_error() && wd->_pfnSymFunctionTableAccess64) {
iklam@5667 250 return wd->_pfnSymFunctionTableAccess64(hProcess, AddrBase);
iklam@5667 251 } else {
iklam@5667 252 return NULL;
iklam@5667 253 }
iklam@5667 254 }
iklam@5667 255
iklam@5667 256 pfn_SymFunctionTableAccess64 WindowsDbgHelp::pfnSymFunctionTableAccess64() {
iklam@5667 257 DecoderLocker locker;
iklam@5667 258 WindowsDecoder* wd = (WindowsDecoder*)locker.decoder();
iklam@5667 259
iklam@5667 260 if (!wd->has_error()) {
iklam@5667 261 return wd->_pfnSymFunctionTableAccess64;
iklam@5667 262 } else {
iklam@5667 263 return NULL;
iklam@5667 264 }
iklam@5667 265 }
iklam@5667 266
iklam@5667 267 pfn_SymGetModuleBase64 WindowsDbgHelp::pfnSymGetModuleBase64() {
iklam@5667 268 DecoderLocker locker;
iklam@5667 269 WindowsDecoder* wd = (WindowsDecoder*)locker.decoder();
iklam@5667 270
iklam@5667 271 if (!wd->has_error()) {
iklam@5667 272 return wd->_pfnSymGetModuleBase64;
iklam@5667 273 } else {
iklam@5667 274 return NULL;
iklam@5667 275 }
iklam@5667 276 }
iklam@5667 277
iklam@5667 278 #endif // AMD64

mercurial