948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync/** @file
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync * Symbols from dbghelp.dll, allowing us to select which one to load.
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync */
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync/*
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync * Copyright (C) 2013 Oracle Corporation
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync *
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync * available from http://www.virtualbox.org. This file is free software;
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync * you can redistribute it and/or modify it under the terms of the GNU
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync * General Public License (GPL) as published by the Free Software
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync *
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync * The contents of this file may alternatively be used under the terms
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync * of the Common Development and Distribution License Version 1.0
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync * VirtualBox OSE distribution, in which case the provisions of the
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync * CDDL are applicable instead of those of the GPL.
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync *
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync * You may elect to license modified versions of this file under the
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync * terms and conditions of either the GPL or the CDDL or both.
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync */
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync#ifndef ___iprt_win_lazy_dbghelp_h
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync#define ___iprt_win_lazy_dbghelp_h
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync#include <iprt/ldrlazy.h>
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync#include <iprt/path.h>
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync#include <iprt/env.h>
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync/**
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync * Custom loader callback.
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync * @returns Module handle or NIL_RTLDRMOD.
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync */
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsyncstatic int rtLdrLazyLoadDbgHelp(const char *pszFile, PRTLDRMOD phMod)
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync{
5871cd3129207c7b61f93b0e9ff644227172235evboxsync static const struct
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync {
5871cd3129207c7b61f93b0e9ff644227172235evboxsync const char *pszEnv;
5871cd3129207c7b61f93b0e9ff644227172235evboxsync const char *pszSubDir;
5871cd3129207c7b61f93b0e9ff644227172235evboxsync } s_aLocations[] =
5871cd3129207c7b61f93b0e9ff644227172235evboxsync {
5871cd3129207c7b61f93b0e9ff644227172235evboxsync#ifdef RT_ARCH_AMD64
5871cd3129207c7b61f93b0e9ff644227172235evboxsync { "ProgramFiles(x86)", "Windows Kits\\8.1\\Debuggers\\x64\\dbghelp.dll" },
5871cd3129207c7b61f93b0e9ff644227172235evboxsync { "ProgramFiles(x86)", "Windows Kits\\8.0\\Debuggers\\x64\\dbghelp.dll" },
5871cd3129207c7b61f93b0e9ff644227172235evboxsync { "ProgramFiles", "Debugging Tools for Windows (x64)\\dbghelp.dll" },
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync#else
5871cd3129207c7b61f93b0e9ff644227172235evboxsync { "ProgramFiles", "Windows Kits\\8.1\\Debuggers\\x86\\dbghelp.dll" },
5871cd3129207c7b61f93b0e9ff644227172235evboxsync { "ProgramFiles", "Windows Kits\\8.0\\Debuggers\\x86\\dbghelp.dll" },
5871cd3129207c7b61f93b0e9ff644227172235evboxsync { "ProgramFiles", "Debugging Tools for Windows (x86)\\dbghelp.dll" },
5871cd3129207c7b61f93b0e9ff644227172235evboxsync#endif /** @todo More places we should look? */
5871cd3129207c7b61f93b0e9ff644227172235evboxsync };
5871cd3129207c7b61f93b0e9ff644227172235evboxsync uint32_t i;
5871cd3129207c7b61f93b0e9ff644227172235evboxsync for (i = 0; i < RT_ELEMENTS(s_aLocations); i++)
5871cd3129207c7b61f93b0e9ff644227172235evboxsync {
5871cd3129207c7b61f93b0e9ff644227172235evboxsync char szPath[RTPATH_MAX];
5871cd3129207c7b61f93b0e9ff644227172235evboxsync size_t cchPath;
5871cd3129207c7b61f93b0e9ff644227172235evboxsync int rc = RTEnvGetEx(RTENV_DEFAULT, s_aLocations[i].pszEnv, szPath, sizeof(szPath), &cchPath);
5871cd3129207c7b61f93b0e9ff644227172235evboxsync if (RT_SUCCESS(rc))
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync {
5871cd3129207c7b61f93b0e9ff644227172235evboxsync rc = RTPathAppend(szPath, sizeof(szPath), s_aLocations[i].pszSubDir);
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync if (RT_SUCCESS(rc))
5871cd3129207c7b61f93b0e9ff644227172235evboxsync {
5871cd3129207c7b61f93b0e9ff644227172235evboxsync rc = RTLdrLoad(szPath, phMod);
5871cd3129207c7b61f93b0e9ff644227172235evboxsync if (RT_SUCCESS(rc))
5871cd3129207c7b61f93b0e9ff644227172235evboxsync return rc;
5871cd3129207c7b61f93b0e9ff644227172235evboxsync }
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync }
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync }
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync
5871cd3129207c7b61f93b0e9ff644227172235evboxsync /* Fall back on the system one, if present. */
5871cd3129207c7b61f93b0e9ff644227172235evboxsync return RTLdrLoadSystem(pszFile, true /*fNoUnload*/, phMod);
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync}
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync
0c3b158e1a6ce423f4499f472f3717050476897dvboxsyncRTLDRLAZY_MODULE_EX(dbghelp, "dbghelp.dll", rtLdrLazyLoadDbgHelp);
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsyncRTLDRLAZY_FUNC(dbghelp, BOOL, WINAPI, SymInitialize, (HANDLE a1, PCWSTR a2, BOOL a3), (a1, a2, a3), FALSE);
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync#undef SymInitialize
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync#define SymInitialize RTLDRLAZY_FUNC_NAME(dbghelp, SymInitialize)
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsyncRTLDRLAZY_FUNC(dbghelp, BOOL, WINAPI, SymCleanup, (HANDLE a1), (a1), FALSE);
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync#undef SymCleanup
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync#define SymCleanup RTLDRLAZY_FUNC_NAME(dbghelp, SymCleanup)
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsyncRTLDRLAZY_FUNC(dbghelp, DWORD, WINAPI, SymGetOptions, (VOID), (), 0);
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync#undef SymGetOptions
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync#define SymGetOptions RTLDRLAZY_FUNC_NAME(dbghelp, SymGetOptions)
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsyncRTLDRLAZY_FUNC(dbghelp, DWORD, WINAPI, SymSetOptions, (DWORD a1), (a1), 0);
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync#undef SymSetOptions
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync#define SymSetOptions RTLDRLAZY_FUNC_NAME(dbghelp, SymSetOptions)
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsyncRTLDRLAZY_FUNC(dbghelp, BOOL, WINAPI, SymRegisterCallback64, (HANDLE a1, PSYMBOL_REGISTERED_CALLBACK64 a2, ULONG64 a3),
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync (a1, a2, a3), FALSE);
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync#undef SymRegisterCallback64
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync#define SymRegisterCallback64 RTLDRLAZY_FUNC_NAME(dbghelp, SymRegisterCallback64)
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsyncRTLDRLAZY_FUNC(dbghelp, DWORD64, WINAPI, SymLoadModuleEx,
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync (HANDLE a1, HANDLE a2, PCSTR a3, PCSTR a4, DWORD64 a5, DWORD a6, PMODLOAD_DATA a7, DWORD a8),
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync (a1, a2, a3, a4, a5, a6, a7, a8), 0);
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync#undef SymLoadModuleEx
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync#define SymLoadModuleEx RTLDRLAZY_FUNC_NAME(dbghelp, SymLoadModuleEx)
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsyncRTLDRLAZY_FUNC(dbghelp, DWORD64, WINAPI, SymLoadModuleExW,
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync (HANDLE a1, HANDLE a2, PCWSTR a3, PCWSTR a4, DWORD64 a5, DWORD a6, PMODLOAD_DATA a7, DWORD a8),
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync (a1, a2, a3, a4, a5, a6, a7, a8), 0);
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync#undef SymLoadModuleExW
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync#define SymLoadModuleExW RTLDRLAZY_FUNC_NAME(dbghelp, SymLoadModuleExW)
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsyncRTLDRLAZY_FUNC(dbghelp, DWORD64, WINAPI, SymUnloadModule64, (HANDLE a1, DWORD64 a2), (a1, a2), 0);
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync#undef SymUnloadModule64
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync#define SymUnloadModule64 RTLDRLAZY_FUNC_NAME(dbghelp, SymUnloadModule64)
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsyncRTLDRLAZY_FUNC(dbghelp, BOOL, WINAPI, SymEnumSymbols,
5a812d3a64313a27d6ca9710af3109662c3d0886vboxsync (HANDLE a1, ULONG64 a2, PCSTR a3, PSYM_ENUMERATESYMBOLS_CALLBACK a4, PVOID a5),
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync (a1, a2, a3, a4, a5), FALSE);
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync#undef SymEnumSymbols
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync#define SymEnumSymbols RTLDRLAZY_FUNC_NAME(dbghelp, SymEnumSymbols)
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsyncRTLDRLAZY_FUNC(dbghelp, BOOL, WINAPI, SymEnumLinesW,
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync (HANDLE a1, ULONG64 a2, PCWSTR a3, PCWSTR a4, PSYM_ENUMLINES_CALLBACKW a5, PVOID a6),
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync (a1, a2, a3, a4, a5, a6), FALSE);
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync#undef SymEnumLinesW
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync#define SymEnumLinesW RTLDRLAZY_FUNC_NAME(dbghelp, SymEnumLinesW)
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsyncRTLDRLAZY_FUNC(dbghelp, BOOL, WINAPI, SymGetModuleInfo64, (HANDLE a1, DWORD64 a2, PIMAGEHLP_MODULE64 a3), (a1, a2, a3), FALSE);
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync#undef SymGetModuleInfo64
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync#define SymGetModuleInfo64 RTLDRLAZY_FUNC_NAME(dbghelp, SymGetModuleInfo64)
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync#endif
948e859a0f72976ea9b302a6b507dfb9409dc7e1vboxsync