如何为Visual Studio 2012调试器编写自定义本机可视化工具DLL？
在C++ for Visual Studio2012调试器中编写自定义本机可视化工具DLL需要什么？我想显示一个只能从类/结构按需计算的值，因此需要一个本机可视化工具DLL。到目前为止，关于Natvis的正确信息很少，特别是关于使用Natvis调用可视化工具DLL的正确信息。
回答 3
Stack Overflow用户
发布于 2012-07-18 23:54:12
下面是组成AddIn动态链接库的C++代码。我将文件命名为NatvisAddIn.cpp，项目创建了NatvisAddIn.dll。
#include "stdafx.h"
#include <iostream>
#include <windows.h>
#define ADDIN_API __declspec(dllexport)
typedef struct tagDEBUGHELPER
{
DWORD dwVersion;
HRESULT (WINAPI *ReadDebuggeeMemory)( struct tagDEBUGHELPER *pThis, DWORD dwAddr, DWORD nWant, VOID* pWhere, DWORD *nGot );
// from here only when dwVersion >= 0x20000
DWORDLONG (WINAPI *GetRealAddress)( struct tagDEBUGHELPER *pThis );
HRESULT (WINAPI *ReadDebuggeeMemoryEx)( struct tagDEBUGHELPER *pThis, DWORDLONG qwAddr, DWORD nWant, VOID* pWhere, DWORD *nGot );
int (WINAPI *GetProcessorType)( struct tagDEBUGHELPER *pThis );
} DEBUGHELPER;
typedef HRESULT (WINAPI *CUSTOMVIEWER)( DWORD dwAddress, DEBUGHELPER *pHelper, int nBase, BOOL bUniStrings, char *pResult, size_t max, DWORD reserved );
extern "C" ADDIN_API HRESULT MyClassFormatter( DWORD dwAddress, DEBUGHELPER *pHelper, int nBase, BOOL bUniStrings, char *pResult, size_t max, DWORD reserved );
extern "C" ADDIN_API HRESULT MyStructFormatter( DWORD dwAddress, DEBUGHELPER *pHelper, int nBase, BOOL bUniStrings, char *pResult, size_t max, DWORD reserved );
class MyClass
{
public:
int publicInt;
};
struct MyStruct { int i; };
ADDIN_API HRESULT MyClassFormatter( DWORD dwAddress, DEBUGHELPER *pHelper, int nBase, BOOL bUniStrings, char *pResult, size_t max, DWORD reserved )
{
MyClass c;
DWORD nGot;
pHelper->ReadDebuggeeMemory(pHelper,dwAddress,sizeof(MyClass),&c,&nGot);
sprintf_s(pResult,max,"Dll MyClass: max=%d nGot=%d MyClass=%x publicInt=%d",max,nGot,dwAddress,c.publicInt);
return S_OK;
}
ADDIN_API HRESULT MyStructFormatter( DWORD dwAddress, DEBUGHELPER *pHelper, int nBase, BOOL bUniStrings, char *pResult, size_t max, DWORD reserved )
{
MyStruct s;
DWORD nGot;
pHelper->ReadDebuggeeMemory(pHelper,dwAddress,sizeof(MyStruct),&s,&nGot);
sprintf_s(pResult,max,"Dll MyStruct: max=%d nGot=%d MyStruct=%x i=%d",max,nGot,dwAddress,s.i);
return S_OK;
}下面是Visual Studio2012调试器用来显示值的.natvis文件。将其放入.natvis文件中。我把它命名为NatvisAddIn.natvis。该文件指示VS 2012调试器调用NatvisAddIn.dll。dll包含两个可视化工具方法调用:用于格式化MyClass的MyClassFormatter和用于格式化MyStruct的MyStructFormatter。调试器将在指定类型(MyClass、MyStruct)的每个实例的“自动”、“监视”或“工具提示”显示中显示方法的格式化值。
<?xml version="1.0" encoding="utf-8"?>
<AutoVisualizer xmlns="http://schemas.microsoft.com/vstudio/debugger/natvis/2010">
<Type Name="MyClass">
<DisplayString LegacyAddin="NatvisAddIn.dll" Export="MyClassFormatter"></DisplayString>
</Type>
<Type Name="MyStruct">
<DisplayString LegacyAddin="NatvisAddIn.dll" Export="MyStructFormatter"></DisplayString>
</Type>
</AutoVisualizer>将编译后的NatvisAddIn.dll文件和NatvisAddIn.natvis文件放入以下三个位置之一：
%VSINSTALLDIR%\Common7\Packages\Debugger\Visualizers (requires admin access)
%USERPROFILE%\My Documents\Visual Studio 2012\Visualizers\
VS extension folders您需要确保以下注册表项存在并且值为1：
HKEY_CURRENT_USER\Software\Microsoft\VisualStudio\11.0_Config\Debugger
“EnableNatvisDiagnostics”=双字:00000001
如果一切顺利，您将在Visual Studio的调试器输出窗口中看到natvis消息。这些消息将显示Natvis是否能够解析.natvis文件。分析每个.natvis文件的结果将显示在“输出”窗口中。如果出现错误，请使用"dumpbin/exports“命令仔细检查DLL方法的名称是否与.navis文件的Type=完全匹配。还要确保已将当前的.dll和.natvis文件复制到相应的目录中。
Natvis: Parsing natvis xml file: C:\Program Files (x86)\Microsoft Visual Studio 11.0\Common7\Packages\Debugger\Visualizers\atlmfc.natvis.
Natvis: Done parsing natvis xml file: C:\Program Files (x86)\Microsoft Visual Studio 11.0\Common7\Packages\Debugger\Visualizers\atlmfc.natvis.
Natvis: Parsing natvis xml file: C:\Program Files (x86)\Microsoft Visual Studio 11.0\Common7\Packages\Debugger\Visualizers\concurrency.natvis.
Natvis: Done parsing natvis xml file: C:\Program Files (x86)\Microsoft Visual Studio 11.0\Common7\Packages\Debugger\Visualizers\concurrency.natvis.
Natvis: Parsing natvis xml file: C:\Program Files (x86)\Microsoft Visual Studio 11.0\Common7\Packages\Debugger\Visualizers\NatvisAddIn.natvis.
Natvis: Done parsing natvis xml file: C:\Program Files (x86)\Microsoft Visual Studio 11.0\Common7\Packages\Debugger\Visualizers\NatvisAddIn.natvis.
Natvis: Parsing natvis xml file: C:\Program Files (x86)\Microsoft Visual Studio 11.0\Common7\Packages\Debugger\Visualizers\stl.natvis.
Natvis: Done parsing natvis xml file: C:\Program Files (x86)\Microsoft Visual Studio 11.0\Common7\Packages\Debugger\Visualizers\stl.natvis.
Natvis: Parsing natvis xml file: C:\Program Files (x86)\Microsoft Visual Studio 11.0\Common7\Packages\Debugger\Visualizers\windows.natvis.
Natvis: Done parsing natvis xml file: C:\Program Files (x86)\Microsoft Visual Studio 11.0\Common7\Packages\Debugger\Visualizers\windows.natvis.
Natvis: Parsing natvis xml file: C:\Program Files (x86)\Microsoft Visual Studio 11.0\Common7\Packages\Debugger\Visualizers\winrt.natvis.
Natvis: Done parsing natvis xml file: C:\Program Files (x86)\Microsoft Visual Studio 11.0\Common7\Packages\Debugger\Visualizers\winrt.natvis.测试程序：
#include "stdafx.h"
#include <iostream>
class MyClass
{
public:
int publicInt;
};
struct MyStruct { int i; };
int _tmain(int argc, _TCHAR* argv[])
{
struct MyStruct s = {1234};
std::cout << s.i << std::endl;
MyClass *c = new MyClass;
c->publicInt = 1234;
std::cout << c->publicInt << std::endl;
return 0;
}信息资源：
\Xml\Schemas\natvis.xsd
http://code.msdn.microsoft.com/windowsdesktop/Writing-type-visualizers-2eae77a2
http://blogs.msdn.com/b/mgoldin/archive/2012/06/06/visual-studio-2012-and-debugger-natvis-files-what-can-i-do-with-them.aspx
http://blogs.msdn.com/b/vcblog/archive/2012/07/12/10329460.aspx
Stack Overflow用户
发布于 2016-05-13 17:41:22
对于64位版本的调试，应该使用以下几行：
auto realAddress = pHelper->GetRealAddress(pHelper);
pHelper->ReadDebuggeeMemoryEx(pHelper, realAddress, sizeof(MyClass), &c, &nGot );对于前面的示例，64位版本可能如下所示：
#include "stdafx.h"
#include <iostream>
#include <windows.h>
#define ADDIN_API __declspec(dllexport)
typedef struct tagDEBUGHELPER
{
DWORD dwVersion;
HRESULT (WINAPI *ReadDebuggeeMemory)( struct tagDEBUGHELPER *pThis, DWORD dwAddr, DWORD nWant, VOID* pWhere, DWORD *nGot );
// from here only when dwVersion >= 0x20000
DWORDLONG (WINAPI *GetRealAddress)( struct tagDEBUGHELPER *pThis );
HRESULT (WINAPI *ReadDebuggeeMemoryEx)( struct tagDEBUGHELPER *pThis, DWORDLONG qwAddr, DWORD nWant, VOID* pWhere, DWORD *nGot );
int (WINAPI *GetProcessorType)( struct tagDEBUGHELPER *pThis );
} DEBUGHELPER;
typedef HRESULT (WINAPI *CUSTOMVIEWER)( DWORD dwAddress, DEBUGHELPER *pHelper, int nBase, BOOL bUniStrings, char *pResult, size_t max, DWORD reserved );
extern "C" ADDIN_API HRESULT MyClassFormatter( DWORD dwAddress, DEBUGHELPER *pHelper, int nBase, BOOL bUniStrings, char *pResult, size_t max, DWORD reserved );
class MyClass
{
public:
int publicInt;
};
ADDIN_API HRESULT MyClassFormatter( DWORD dwAddress, DEBUGHELPER *pHelper, int nBase, BOOL bUniStrings, char *pResult, size_t max, DWORD reserved )
{
MyClass c;
DWORD nGot;
auto realAddress = pHelper->GetRealAddress(pHelper);
pHelper->ReadDebuggeeMemoryEx(pHelper, realAddress, sizeof(MyClass), &c, &nGot );
sprintf_s(pResult,max,"Dll MyClass: max=%d nGot=%d MyClass=%llx publicInt=%d",max, nGot, realAddress, c.publicInt);
return S_OK;
}Stack Overflow用户
发布于 2019-03-17 18:43:38
我需要一个有关查找加载上述"NatvisAddIn.dll“的搜索路径的澄清。让我通过扩展上面的例子来解释一下。
为了可视化我的自定义C++类对象(假设MyCustomeType)，我需要在函数(假设MyClassFormatter)的实现中调用一些额外的API(计算MyCustomeType的显示字符串)，该函数在"DisplayString“XML的"Export”属性中提到。
调用这些额外的API会在上面提到的"NatvisAddIn.dll“上创建一个库/dll依赖。如果这个额外依赖项只是一个或两个库，我可以将这些库放在NatvisAddIn.dll所在的相同位置。然而，在我的例子中，依赖项包含一个很长的库链条。
有没有人可以建议我一些优雅的方法来解决依赖关系，而不是将整个库链放到%USERPROFILE%\My Documents\Visual Studio 2012\Visualizers文件夹中？
为了演示我的用例，让我们考虑下面的依赖树: NatvisAddIn.dll a.dll
a1.dll a2.dll a3.dll我在NatvisAddIn.dll所在的位置复制了a.dll。它的依赖dll (a1、a2和a3)存在于添加到PATH变量的位置。当我尝试在visual studio调试器中可视化MyCustomeType对象时，natvis诊断程序在输出窗口中显示以下错误
Natvis: C:\Users\myUser\Documents\Visual Studio 2017\Visualizers\mydata.natvis(9,6)：错误:无法从C:\Users\myuser\Documents\Visual Studio 2017\Visualizers\NatvisAddIn.dll加载MyCustomeType：：类型的外接程序。
根据我对上述错误的理解，visual studio调试器无法解析a.dll (a1、a2和a3)的依赖项，因此无法加载NatvisAddIn.dll
从属dll从窗口路径变量中解析/提取。，但对于visual studio调试器，不会从路径变量解析依赖的DLL。
正如依赖工具所确定的那样，调试器无法解析的一些dll是：
api-ms-win-core-errorhandling l1-1-0.dll api-ms-win-crt-time-l1-1-0.dll api-ms-win-crt-heap-l1-1-0.dll
其中一些dll存在于visual studio安装中，另一些存在于c:\windows\WinSxS中
我已经在visual studio 2012和visual studio 2017上试用了我的用例。我在两个视觉工作室都遇到了同样的问题。
https://stackoverflow.com/questions/11545418
复制相似问题
腾讯云开发者
