lazy-dbghelp.h revision e36f03470adaee73199dcdddd8eb9cf39bbdf7ad
5e768213e353675f7bb7deda92733ee25f27a20evboxsync/** @file
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync * Symbols from dbghelp.dll, allowing us to select which one to load.
5e768213e353675f7bb7deda92733ee25f27a20evboxsync */
5e768213e353675f7bb7deda92733ee25f27a20evboxsync
5e768213e353675f7bb7deda92733ee25f27a20evboxsync/*
5e768213e353675f7bb7deda92733ee25f27a20evboxsync * Copyright (C) 2013 Oracle Corporation
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync *
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync * available from http://www.virtualbox.org. This file is free software;
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync * you can redistribute it and/or modify it under the terms of the GNU
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync * General Public License (GPL) as published by the Free Software
5e768213e353675f7bb7deda92733ee25f27a20evboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
5e768213e353675f7bb7deda92733ee25f27a20evboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
5e768213e353675f7bb7deda92733ee25f27a20evboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
5e768213e353675f7bb7deda92733ee25f27a20evboxsync *
5e768213e353675f7bb7deda92733ee25f27a20evboxsync * The contents of this file may alternatively be used under the terms
5e768213e353675f7bb7deda92733ee25f27a20evboxsync * of the Common Development and Distribution License Version 1.0
5e768213e353675f7bb7deda92733ee25f27a20evboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
5e768213e353675f7bb7deda92733ee25f27a20evboxsync * VirtualBox OSE distribution, in which case the provisions of the
5e768213e353675f7bb7deda92733ee25f27a20evboxsync * CDDL are applicable instead of those of the GPL.
5e768213e353675f7bb7deda92733ee25f27a20evboxsync *
5e768213e353675f7bb7deda92733ee25f27a20evboxsync * You may elect to license modified versions of this file under the
5e768213e353675f7bb7deda92733ee25f27a20evboxsync * terms and conditions of either the GPL or the CDDL or both.
5e768213e353675f7bb7deda92733ee25f27a20evboxsync */
5e768213e353675f7bb7deda92733ee25f27a20evboxsync
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync#ifndef ___iprt_win_lazy_dbghelp_h
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync#define ___iprt_win_lazy_dbghelp_h
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync#include <iprt/ldrlazy.h>
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync#include <iprt/path.h>
5e768213e353675f7bb7deda92733ee25f27a20evboxsync#include <iprt/env.h>
2cb03d0d9990356717482846beac17c74939dc13vboxsync
5e768213e353675f7bb7deda92733ee25f27a20evboxsync
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync/**
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync * Custom loader callback.
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync * @returns Module handle or NIL_RTLDRMOD.
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync */
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsyncstatic int rtLdrLazyLoadDbgHelp(const char *pszFile, PRTLDRMOD phMod)
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync{
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync char szPath[RTPATH_MAX];
5e768213e353675f7bb7deda92733ee25f27a20evboxsync size_t cchPath;
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync int rc = RTEnvGetEx(RTENV_DEFAULT, "ProgramFiles", szPath, sizeof(szPath), &cchPath);
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync if (RT_SUCCESS(rc))
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync {
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync /** @todo try Windows SDK location. */
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync#ifdef RT_ARCH_X86
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync rc = RTPathAppend(szPath, sizeof(szPath), "Debugging Tools for Windows (x86)\\dbghelp.dll");
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync#else
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync rc = RTPathAppend(szPath, sizeof(szPath), "Debugging Tools for Windows (amd64)\\dbghelp.dll");
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync#endif
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync if (RTPathExists(szPath))
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync {
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync rc = RTLdrLoad(szPath, phMod);
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync if (RT_SUCCESS(rc))
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync return rc;
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync }
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync }
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync return RTLdrLoad(pszFile, phMod);
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync}
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsyncRTLDRLAZY_MODULE(dbghelp, "dbghelp.dll");
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsyncRTLDRLAZY_FUNC(dbghelp, BOOL, WINAPI, SymInitialize, (HANDLE a1, PCWSTR a2, BOOL a3), (a1, a2, a3), FALSE);
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync#undef SymInitialize
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync#define SymInitialize RTLDRLAZY_FUNC_NAME(dbghelp, SymInitialize)
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsyncRTLDRLAZY_FUNC(dbghelp, BOOL, WINAPI, SymCleanup, (HANDLE a1), (a1), FALSE);
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync#undef SymCleanup
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync#define SymCleanup RTLDRLAZY_FUNC_NAME(dbghelp, SymCleanup)
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsyncRTLDRLAZY_FUNC(dbghelp, DWORD, WINAPI, SymGetOptions, (VOID), (), 0);
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync#undef SymGetOptions
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync#define SymGetOptions RTLDRLAZY_FUNC_NAME(dbghelp, SymGetOptions)
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsyncRTLDRLAZY_FUNC(dbghelp, DWORD, WINAPI, SymSetOptions, (DWORD a1), (a1), 0);
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync#undef SymSetOptions
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync#define SymSetOptions RTLDRLAZY_FUNC_NAME(dbghelp, SymSetOptions)
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsyncRTLDRLAZY_FUNC(dbghelp, BOOL, WINAPI, SymRegisterCallback64, (HANDLE a1, PSYMBOL_REGISTERED_CALLBACK64 a2, ULONG64 a3),
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync (a1, a2, a3), FALSE);
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync#undef SymRegisterCallback64
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync#define SymRegisterCallback64 RTLDRLAZY_FUNC_NAME(dbghelp, SymRegisterCallback64)
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsyncRTLDRLAZY_FUNC(dbghelp, DWORD64, WINAPI, SymLoadModuleEx,
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync (HANDLE a1, HANDLE a2, PCSTR a3, PCSTR a4, DWORD64 a5, DWORD a6, PMODLOAD_DATA a7, DWORD a8),
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync (a1, a2, a3, a4, a5, a6, a7, a8), 0);
5e768213e353675f7bb7deda92733ee25f27a20evboxsync#undef SymLoadModuleEx
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync#define SymLoadModuleEx RTLDRLAZY_FUNC_NAME(dbghelp, SymLoadModuleEx)
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync
2cb03d0d9990356717482846beac17c74939dc13vboxsyncRTLDRLAZY_FUNC(dbghelp, DWORD64, WINAPI, SymLoadModuleExW,
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync (HANDLE a1, HANDLE a2, PCWSTR a3, PCWSTR a4, DWORD64 a5, DWORD a6, PMODLOAD_DATA a7, DWORD a8),
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync (a1, a2, a3, a4, a5, a6, a7, a8), 0);
5e768213e353675f7bb7deda92733ee25f27a20evboxsync#undef SymLoadModuleExW
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync#define SymLoadModuleExW RTLDRLAZY_FUNC_NAME(dbghelp, SymLoadModuleExW)
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync
5e768213e353675f7bb7deda92733ee25f27a20evboxsyncRTLDRLAZY_FUNC(dbghelp, DWORD64, WINAPI, SymUnloadModule64, (HANDLE a1, DWORD64 a2), (a1, a2), 0);
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync#undef SymUnloadModule64
5e768213e353675f7bb7deda92733ee25f27a20evboxsync#define SymUnloadModule64 RTLDRLAZY_FUNC_NAME(dbghelp, SymUnloadModule64)
5e768213e353675f7bb7deda92733ee25f27a20evboxsync
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsyncRTLDRLAZY_FUNC(dbghelp, BOOL, WINAPI, SymEnumSymbols,
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync (HANDLE a1, DWORD a2, PCSTR a3, PSYM_ENUMERATESYMBOLS_CALLBACK a4, PVOID a5),
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync (a1, a2, a3, a4, a5), FALSE);
5e768213e353675f7bb7deda92733ee25f27a20evboxsync#undef SymEnumSymbols
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync#define SymEnumSymbols RTLDRLAZY_FUNC_NAME(dbghelp, SymEnumSymbols)
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsyncRTLDRLAZY_FUNC(dbghelp, BOOL, WINAPI, SymEnumLinesW,
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync (HANDLE a1, ULONG64 a2, PCWSTR a3, PCWSTR a4, PSYM_ENUMLINES_CALLBACKW a5, PVOID a6),
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync (a1, a2, a3, a4, a5, a6), FALSE);
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync#undef SymEnumLinesW
5e768213e353675f7bb7deda92733ee25f27a20evboxsync#define SymEnumLinesW RTLDRLAZY_FUNC_NAME(dbghelp, SymEnumLinesW)
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsyncRTLDRLAZY_FUNC(dbghelp, BOOL, WINAPI, SymGetModuleInfo64, (HANDLE a1, DWORD64 a2, PIMAGEHLP_MODULE64 a3), (a1, a2, a3), FALSE);
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync#undef SymGetModuleInfo64
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync#define SymGetModuleInfo64 RTLDRLAZY_FUNC_NAME(dbghelp, SymGetModuleInfo64)
5e768213e353675f7bb7deda92733ee25f27a20evboxsync
5e768213e353675f7bb7deda92733ee25f27a20evboxsync
5e768213e353675f7bb7deda92733ee25f27a20evboxsync
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync#endif
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync
9b509d9e7070174b3bd5c80ce9ea52d42dd3de98vboxsync