zgu@2364: /*
simonis@4675:  * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
zgu@2364:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
zgu@2364:  *
zgu@2364:  * This code is free software; you can redistribute it and/or modify it
zgu@2364:  * under the terms of the GNU General Public License version 2 only, as
zgu@2364:  * published by the Free Software Foundation.
zgu@2364:  *
zgu@2364:  * This code is distributed in the hope that it will be useful, but WITHOUT
zgu@2364:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
zgu@2364:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
zgu@2364:  * version 2 for more details (a copy is included in the LICENSE file that
zgu@2364:  * accompanied this code).
zgu@2364:  *
zgu@2364:  * You should have received a copy of the GNU General Public License version
zgu@2364:  * 2 along with this work; if not, write to the Free Software Foundation,
zgu@2364:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
zgu@2364:  *
zgu@2364:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
zgu@2364:  * or visit www.oracle.com if you need additional information or have any
zgu@2364:  * questions.
zgu@2364:  *
zgu@2364:  */
zgu@2364: 
zgu@2364: #include "precompiled.hpp"
zgu@2364: #include "prims/jvm.h"
simonis@4675: #include "runtime/arguments.hpp"
zgu@3430: #include "decoder_windows.hpp"
zgu@2364: 
zgu@3430: WindowsDecoder::WindowsDecoder() {
zgu@3430:   _dbghelp_handle = NULL;
zgu@3430:   _can_decode_in_vm = false;
zgu@3430:   _pfnSymGetSymFromAddr64 = NULL;
zgu@3430:   _pfnUndecorateSymbolName = NULL;
zgu@2364: 
zgu@3430:   _decoder_status = no_error;
zgu@3430:   initialize();
zgu@3430: }
zgu@2364: 
zgu@3430: void WindowsDecoder::initialize() {
zgu@3430:   if (!has_error() && _dbghelp_handle == NULL) {
zgu@3430:     HMODULE handle = ::LoadLibrary("dbghelp.dll");
zgu@2364:     if (!handle) {
zgu@2364:       _decoder_status = helper_not_found;
zgu@3430:       return;
zgu@2364:     }
zgu@2364: 
zgu@2364:     _dbghelp_handle = handle;
zgu@2364: 
zgu@2364:     pfn_SymSetOptions _pfnSymSetOptions = (pfn_SymSetOptions)::GetProcAddress(handle, "SymSetOptions");
zgu@2364:     pfn_SymInitialize _pfnSymInitialize = (pfn_SymInitialize)::GetProcAddress(handle, "SymInitialize");
zgu@2364:     _pfnSymGetSymFromAddr64 = (pfn_SymGetSymFromAddr64)::GetProcAddress(handle, "SymGetSymFromAddr64");
zgu@4423:     _pfnUndecorateSymbolName = (pfn_UndecorateSymbolName)::GetProcAddress(handle, "UnDecorateSymbolName");
zgu@2364: 
zgu@2364:     if (_pfnSymSetOptions == NULL || _pfnSymInitialize == NULL || _pfnSymGetSymFromAddr64 == NULL) {
zgu@2364:       _pfnSymGetSymFromAddr64 = NULL;
zgu@2364:       _pfnUndecorateSymbolName = NULL;
zgu@2364:       ::FreeLibrary(handle);
zgu@2364:       _dbghelp_handle = NULL;
zgu@2364:       _decoder_status = helper_func_error;
zgu@2364:       return;
zgu@2364:     }
zgu@2364: 
zgu@4423:     HANDLE hProcess = ::GetCurrentProcess();
zgu@4423:     _pfnSymSetOptions(SYMOPT_UNDNAME | SYMOPT_DEFERRED_LOADS | SYMOPT_EXACT_SYMBOLS);
zgu@4423:     if (!_pfnSymInitialize(hProcess, NULL, TRUE)) {
zgu@2364:       _pfnSymGetSymFromAddr64 = NULL;
zgu@2364:       _pfnUndecorateSymbolName = NULL;
zgu@2364:       ::FreeLibrary(handle);
zgu@2364:       _dbghelp_handle = NULL;
zgu@2364:       _decoder_status = helper_init_error;
zgu@2364:       return;
zgu@2364:     }
zgu@2364: 
zgu@4423:     // set pdb search paths
zgu@4423:     pfn_SymSetSearchPath  _pfn_SymSetSearchPath =
zgu@4423:       (pfn_SymSetSearchPath)::GetProcAddress(handle, "SymSetSearchPath");
zgu@4423:     pfn_SymGetSearchPath  _pfn_SymGetSearchPath =
zgu@4423:       (pfn_SymGetSearchPath)::GetProcAddress(handle, "SymGetSearchPath");
zgu@4423:     if (_pfn_SymSetSearchPath != NULL && _pfn_SymGetSearchPath != NULL) {
zgu@4423:       char paths[MAX_PATH];
zgu@4423:       int  len = sizeof(paths);
zgu@4423:       if (!_pfn_SymGetSearchPath(hProcess, paths, len)) {
zgu@4423:         paths[0] = '\0';
zgu@4423:       } else {
zgu@4423:         // available spaces in path buffer
zgu@4423:         len -= (int)strlen(paths);
zgu@4423:       }
zgu@4423: 
zgu@4423:       char tmp_path[MAX_PATH];
zgu@4423:       DWORD dwSize;
zgu@4423:       HMODULE hJVM = ::GetModuleHandle("jvm.dll");
zgu@4423:       tmp_path[0] = '\0';
zgu@4423:       // append the path where jvm.dll is located
zgu@4423:       if (hJVM != NULL && (dwSize = ::GetModuleFileName(hJVM, tmp_path, sizeof(tmp_path))) > 0) {
zgu@4423:         while (dwSize > 0 && tmp_path[dwSize] != '\\') {
zgu@4423:           dwSize --;
zgu@4423:         }
zgu@4423: 
zgu@4423:         tmp_path[dwSize] = '\0';
zgu@4423: 
zgu@4423:         if (dwSize > 0 && len > (int)dwSize + 1) {
zgu@4423:           strncat(paths, os::path_separator(), 1);
zgu@4423:           strncat(paths, tmp_path, dwSize);
zgu@4423:           len -= dwSize + 1;
zgu@4423:         }
zgu@4423:       }
zgu@4423: 
zgu@4423:       // append $JRE/bin. Arguments::get_java_home actually returns $JRE
zgu@4423:       // path
zgu@4423:       char *p = Arguments::get_java_home();
zgu@4423:       assert(p != NULL, "empty java home");
zgu@4423:       size_t java_home_len = strlen(p);
zgu@4423:       if (len > (int)java_home_len + 5) {
zgu@4423:         strncat(paths, os::path_separator(), 1);
zgu@4423:         strncat(paths, p, java_home_len);
zgu@4423:         strncat(paths, "\\bin", 4);
zgu@4423:         len -= (int)(java_home_len + 5);
zgu@4423:       }
zgu@4423: 
zgu@4423:       // append $JDK/bin path if it exists
zgu@4423:       assert(java_home_len < MAX_PATH, "Invalid path length");
zgu@4423:       // assume $JRE is under $JDK, construct $JDK/bin path and
zgu@4423:       // see if it exists or not
zgu@4423:       if (strncmp(&p[java_home_len - 3], "jre", 3) == 0) {
zgu@4423:         strncpy(tmp_path, p, java_home_len - 3);
zgu@4423:         tmp_path[java_home_len - 3] = '\0';
zgu@4423:         strncat(tmp_path, "bin", 3);
zgu@4423: 
zgu@4423:         // if the directory exists
zgu@4423:         DWORD dwAttrib = GetFileAttributes(tmp_path);
zgu@4423:         if (dwAttrib != INVALID_FILE_ATTRIBUTES &&
zgu@4423:             (dwAttrib & FILE_ATTRIBUTE_DIRECTORY)) {
zgu@4423:           // tmp_path should have the same length as java_home_len, since we only
zgu@4423:           // replaced 'jre' with 'bin'
zgu@4423:           if (len > (int)java_home_len + 1) {
zgu@4423:             strncat(paths, os::path_separator(), 1);
zgu@4423:             strncat(paths, tmp_path, java_home_len);
zgu@4423:           }
zgu@4423:         }
zgu@4423:       }
zgu@4423: 
zgu@4423:       _pfn_SymSetSearchPath(hProcess, paths);
zgu@4423:     }
zgu@4423: 
zgu@2364:      // find out if jvm.dll contains private symbols, by decoding
zgu@2364:      // current function and comparing the result
zgu@3961:      address addr = (address)Decoder::demangle;
zgu@2364:      char buf[MAX_PATH];
zgu@3430:      if (decode(addr, buf, sizeof(buf), NULL)) {
zgu@3961:        _can_decode_in_vm = !strcmp(buf, "Decoder::demangle");
zgu@2364:      }
zgu@2364:   }
zgu@2364: }
zgu@2364: 
zgu@3430: void WindowsDecoder::uninitialize() {
zgu@2364:   _pfnSymGetSymFromAddr64 = NULL;
zgu@2364:   _pfnUndecorateSymbolName = NULL;
zgu@2364:   if (_dbghelp_handle != NULL) {
zgu@2364:     ::FreeLibrary(_dbghelp_handle);
zgu@2364:   }
zgu@3430:   _dbghelp_handle = NULL;
zgu@2364: }
zgu@2364: 
zgu@3430: bool WindowsDecoder::can_decode_C_frame_in_vm() const {
zgu@3430:   return  (!has_error() && _can_decode_in_vm);
zgu@2364: }
zgu@2364: 
zgu@2364: 
zgu@3430: bool WindowsDecoder::decode(address addr, char *buf, int buflen, int* offset, const char* modulepath)  {
zgu@2364:   if (_pfnSymGetSymFromAddr64 != NULL) {
zgu@2364:     PIMAGEHLP_SYMBOL64 pSymbol;
zgu@2364:     char symbolInfo[MAX_PATH + sizeof(IMAGEHLP_SYMBOL64)];
zgu@2364:     pSymbol = (PIMAGEHLP_SYMBOL64)symbolInfo;
zgu@2364:     pSymbol->MaxNameLength = MAX_PATH;
zgu@2364:     pSymbol->SizeOfStruct = sizeof(IMAGEHLP_SYMBOL64);
zgu@2364:     DWORD64 displacement;
zgu@2364:     if (_pfnSymGetSymFromAddr64(::GetCurrentProcess(), (DWORD64)addr, &displacement, pSymbol)) {
zgu@2364:       if (buf != NULL) {
zgu@3430:         if (demangle(pSymbol->Name, buf, buflen)) {
zgu@2364:           jio_snprintf(buf, buflen, "%s", pSymbol->Name);
zgu@2364:         }
zgu@2364:       }
zgu@3430:       if(offset != NULL) *offset = (int)displacement;
zgu@3430:       return true;
zgu@2364:     }
zgu@2364:   }
zgu@3430:   if (buf != NULL && buflen > 0) buf[0] = '\0';
zgu@3430:   if (offset != NULL) *offset = -1;
zgu@3430:   return false;
zgu@2364: }
zgu@2364: 
zgu@3430: bool WindowsDecoder::demangle(const char* symbol, char *buf, int buflen) {
zgu@2364:   return _pfnUndecorateSymbolName != NULL &&
zgu@2364:          _pfnUndecorateSymbolName(symbol, buf, buflen, UNDNAME_COMPLETE);
zgu@2364: }
zgu@2364: